cmd

package
v0.9.6 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Nov 23, 2020 License: MIT Imports: 56 Imported by: 2

Documentation

Overview

Package cmd is the front-end interface for the application as a command-line utility.

KeyStoreAuthenticator

KeyStoreAuthenticator prompts the user for their password, which is used to unlock their keystore file to interact with the Ethereum blockchain. Since multiple keystore files can exist at the configured directory, the KeyStoreAuthenticator will try the password on all keystore files present.

Client

Client is how the application is invoked from the command line. When you run the binary, for example `./chainlink n`, client.RunNode is called to start the Chainlink core. Similarly, running `./chainlink j` returns information on all jobs in the node, and `./chainlink s` with another argument as a JobID gives information specific to that job.

Renderer

Renderer helps format and display data (based on the kind of data it is) to the command line.

Index

Constants

This section is empty.

Variables

View Source 
var (
	// ErrorNoAPICredentialsAvailable is returned when not run from a terminal
	// and no API credentials have been provided
	ErrorNoAPICredentialsAvailable = errors.New("API credentials must be supplied")
)

Functions

func NewApp 

func NewApp(client *Client) *cli.App

NewApp returns the command-line parser/function-router for the given client

Types

type APIInitializer 

type APIInitializer interface {
	// Initialize creates a new user for API access, or does nothing if one exists.
	Initialize(store *store.Store) (models.User, error)
}

APIInitializer is the interface used to create the API User credentials needed to access the API. Does nothing if API user already exists.

func NewFileAPIInitializer 

func NewFileAPIInitializer(file string) APIInitializer

NewFileAPIInitializer creates a concrete instance of APIInitializer that pulls API user credentials from the passed file path.

func NewPromptingAPIInitializer 

func NewPromptingAPIInitializer(prompter Prompter) APIInitializer

NewPromptingAPIInitializer creates a concrete instance of APIInitializer that uses the terminal to solicit credentials from the user.

type AppFactory 

type AppFactory interface {
	NewApplication(*orm.Config, ...func(chainlink.Application)) chainlink.Application
}

AppFactory implements the NewApplication method.

type ChainlinkAppFactory 

type ChainlinkAppFactory struct{}

ChainlinkAppFactory is used to create a new Application.

func (ChainlinkAppFactory) NewApplication 

func (n ChainlinkAppFactory) NewApplication(config *orm.Config, onConnectCallbacks ...func(chainlink.Application)) chainlink.Application

NewApplication returns a new instance of the node with the given config.

type ChainlinkRunner 

type ChainlinkRunner struct{}

ChainlinkRunner is used to run the node application.

func (ChainlinkRunner) Run 

func (n ChainlinkRunner) Run(app chainlink.Application) error

Run sets the log level based on config and starts the web router to listen for input and return data.

type ChangePasswordPrompter 

type ChangePasswordPrompter interface {
	Prompt() (models.ChangePasswordRequest, error)
}

ChangePasswordPrompter is an interface primarily used for DI to obtain a password change request from the User.

func NewChangePasswordPrompter 

func NewChangePasswordPrompter() ChangePasswordPrompter

NewChangePasswordPrompter returns the production password change request prompter

type Client 

type Client struct {
	Renderer
	Config                         *orm.Config
	AppFactory                     AppFactory
	KeyStoreAuthenticator          KeyStoreAuthenticator
	FallbackAPIInitializer         APIInitializer
	Runner                         Runner
	HTTP                           HTTPClient
	CookieAuthenticator            CookieAuthenticator
	FileSessionRequestBuilder      SessionRequestBuilder
	PromptingSessionRequestBuilder SessionRequestBuilder
	ChangePasswordPrompter         ChangePasswordPrompter
	PasswordPrompter               PasswordPrompter
}

Client is the shell for the node, local commands and remote commands.

func (*Client) ArchiveJobSpec 

func (cli *Client) ArchiveJobSpec(c *clipkg.Context) error

ArchiveJobSpec soft deletes a job and its associated runs.

func (*Client) CancelJobRun added in v0.8.2 

func (cli *Client) CancelJobRun(c *clipkg.Context) error

CancelJob cancels a running job

func (*Client) ChangePassword 

func (cli *Client) ChangePassword(c *clipkg.Context) (err error)

ChangePassword prompts the user for the old password and a new one, then posts it to Chainlink to change the password.

func (*Client) CreateAndExportWeakVRFKey added in v0.8.2 

func (cli *Client) CreateAndExportWeakVRFKey(c *clipkg.Context) error

CreateAndExportWeakVRFKey creates a key in the VRF keystore, protected by the password in the password file, but with weak key-derivation-function parameters, which makes it cheaper for testing, but also more vulnerable to bruteforcing of the encrypted key material. For testing purposes only!

The key is only stored at the specified file location, not stored in the DB.

func (*Client) CreateBridge added in v0.6.6 

func (cli *Client) CreateBridge(c *clipkg.Context) (err error)

CreateBridge adds a new bridge to the chainlink node

func (*Client) CreateExternalInitiator 

func (cli *Client) CreateExternalInitiator(c *clipkg.Context) (err error)

CreateExternalInitiator adds an external initiator

func (*Client) CreateExtraKey 

func (cli *Client) CreateExtraKey(c *clipkg.Context) (err error)

CreateExtraKey creates a new ethereum key with the same password as the one used to unlock the existing key.

func (*Client) CreateJobRun 

func (cli *Client) CreateJobRun(c *clipkg.Context) (err error)

CreateJobRun creates job run based on SpecID and optional JSON

func (*Client) CreateJobSpec 

func (cli *Client) CreateJobSpec(c *clipkg.Context) (err error)

CreateJobSpec creates a JobSpec based on JSON input

func (*Client) CreateOCRJobSpec added in v0.9.3 

func (cli *Client) CreateOCRJobSpec(c *clipkg.Context) (err error)

CreateOCRJobSpec creates an OCR job spec Valid input is a TOML string or a path to TOML file

func (*Client) CreateOCRKeyBundle added in v0.8.17 

func (cli *Client) CreateOCRKeyBundle(c *clipkg.Context) error

CreateOCRKeyBundle creates a key and inserts it into encrypted_ocr_key_bundles, protected by the password in the password file

func (*Client) CreateP2PKey added in v0.8.12 

func (cli *Client) CreateP2PKey(c *clipkg.Context) (err error)

func (*Client) CreateServiceAgreement 

func (cli *Client) CreateServiceAgreement(c *clipkg.Context) (err error)

CreateServiceAgreement creates a ServiceAgreement based on JSON input

func (*Client) CreateVRFKey added in v0.8.2 

func (cli *Client) CreateVRFKey(c *clipkg.Context) error

CreateVRFKey creates a key in the VRF keystore, protected by the password in the password file

func (*Client) DeleteExternalInitiator 

func (cli *Client) DeleteExternalInitiator(c *clipkg.Context) (err error)

DeleteExternalInitiator removes an external initiator

func (*Client) DeleteJobV2 added in v0.9.3 

func (cli *Client) DeleteJobV2(c *clipkg.Context) error

func (*Client) DeleteOCRKeyBundle added in v0.8.17 

func (cli *Client) DeleteOCRKeyBundle(c *clipkg.Context) error

DeleteOCRKeyBundle creates a key and inserts it into encrypted_ocr_keys, protected by the password in the password file

func (*Client) DeleteP2PKey added in v0.9.0 

func (cli *Client) DeleteP2PKey(c *clipkg.Context) (err error)

func (*Client) DeleteUser 

func (cli *Client) DeleteUser(c *clipkg.Context) (err error)

DeleteUser is run locally to remove the User row from the node's database.

func (*Client) DeleteVRFKey added in v0.8.2 

func (cli *Client) DeleteVRFKey(c *clipkg.Context) error

DeleteVRFKey soft-deletes the VRF key with given public key from the db

Since this runs in an independent process from any chainlink node, it cannot cause running nodes to forget the key, if they already have it unlocked.

func (*Client) ExportVRFKey added in v0.8.2 

func (cli *Client) ExportVRFKey(c *clipkg.Context) error

ExportVRFKey saves encrypted copy of VRF key with given public key to requested file path.

func (*Client) GetConfiguration added in v0.6.10 

func (cli *Client) GetConfiguration(c *clipkg.Context) (err error)

GetConfiguration gets the nodes environment variables

func (*Client) HardReset added in v0.9.3 

func (cli *Client) HardReset(c *clipkg.Context) error

HardReset will remove all non-started transactions if any are found.

func (*Client) ImportKey 

func (cli *Client) ImportKey(c *clipkg.Context) error

ImportKey imports a key to be used with the chainlink node

func (*Client) ImportVRFKey added in v0.8.2 

func (cli *Client) ImportVRFKey(c *clipkg.Context) error

ImportVRFKey reads a file into an EncryptedVRFKey in the db

func (*Client) IndexBridges added in v0.6.6 

func (cli *Client) IndexBridges(c *clipkg.Context) (err error)

IndexBridges returns all bridges.

func (*Client) IndexJobRuns added in v0.6.6 

func (cli *Client) IndexJobRuns(c *clipkg.Context) error

IndexJobRuns returns the list of all job runs for a specific job if no jobid is passed, defaults to returning all jobruns

func (*Client) IndexJobSpecs added in v0.6.6 

func (cli *Client) IndexJobSpecs(c *clipkg.Context) error

IndexJobSpecs returns all job specs.

func (*Client) IndexTransactions added in v0.6.6 

func (cli *Client) IndexTransactions(c *clipkg.Context) error

IndexTransactions returns the list of transactions in descending order, taking an optional page parameter

func (*Client) IndexTxAttempts added in v0.6.6 

func (cli *Client) IndexTxAttempts(c *clipkg.Context) error

IndexTxAttempts returns the list of transactions in descending order, taking an optional page parameter

func (*Client) ListETHKeys added in v0.9.3 

func (cli *Client) ListETHKeys(c *clipkg.Context) (err error)

ListETHKeys renders a table containing the active account address with it's ETH & LINK balance

func (*Client) ListKeys added in v0.8.2 

func (cli *Client) ListKeys(c *clipkg.Context) error

ListKeys Lists the keys in the db

func (*Client) ListOCRKeyBundles added in v0.8.17 

func (cli *Client) ListOCRKeyBundles(c *clipkg.Context) error

ListOCRKeyBundles lists the available OCR Key Bundles

func (*Client) ListP2PKeys added in v0.9.0 

func (cli *Client) ListP2PKeys(c *clipkg.Context) (err error)

func (*Client) PrepareTestDatabase added in v0.8.4 

func (cli *Client) PrepareTestDatabase(c *clipkg.Context) error

PrepareTestDatabase calls ResetDatabase then loads fixtures required for tests

func (*Client) RebroadcastTransactions added in v0.8.2 

func (cli *Client) RebroadcastTransactions(c *clipkg.Context) (err error)

RebroadcastTransactions run locally to force manual rebroadcasting of transactions in a given nonce range.

func (*Client) RemoteLogin 

func (cli *Client) RemoteLogin(c *clipkg.Context) error

RemoteLogin creates a cookie session to run remote commands.

func (*Client) RemoveBridge 

func (cli *Client) RemoveBridge(c *clipkg.Context) (err error)

RemoveBridge removes a specific Bridge by name.

func (*Client) ResetDatabase added in v0.8.4 

func (cli *Client) ResetDatabase(c *clipkg.Context) error

ResetDatabase drops, creates and migrates the database specified by DATABASE_URL This is useful to setup the database for testing

func (*Client) RunNode 

func (cli *Client) RunNode(c *clipkg.Context) error

RunNode starts the Chainlink core.

func (*Client) SendEther 

func (cli *Client) SendEther(c *clipkg.Context) (err error)

SendEther transfers ETH from the node's account to a specified address.

func (*Client) SetMinimumGasPrice added in v0.6.6 

func (cli *Client) SetMinimumGasPrice(c *clipkg.Context) (err error)

SetMinimumGasPrice specifies the minimum gas price to use for outgoing transactions

func (*Client) SetNextNonce added in v0.8.7 

func (cli *Client) SetNextNonce(c *clipkg.Context) error

SetNextNonce manually updates the keys.next_nonce field for the given key with the given nonce value

func (*Client) ShowBridge 

func (cli *Client) ShowBridge(c *clipkg.Context) (err error)

ShowBridge returns the info for the given Bridge name.

func (*Client) ShowJobRun 

func (cli *Client) ShowJobRun(c *clipkg.Context) (err error)

ShowJobRun returns the status of the given Jobrun.

func (*Client) ShowJobSpec 

func (cli *Client) ShowJobSpec(c *clipkg.Context) (err error)

ShowJobSpec returns the status of the given JobID.

func (*Client) ShowTransaction added in v0.6.6 

func (cli *Client) ShowTransaction(c *clipkg.Context) (err error)

ShowTransaction returns the info for the given transaction hash

func (*Client) TriggerOCRJobRun added in v0.9.6 

func (cli *Client) TriggerOCRJobRun(c *clipkg.Context) error

TriggerOCRJobRun triggers an off-chain reporting job run based on a job ID

type CookieAuthenticator 

type CookieAuthenticator interface {
	Cookie() (*http.Cookie, error)
	Authenticate(models.SessionRequest) (*http.Cookie, error)
}

CookieAuthenticator is the interface to generating a cookie to authenticate future HTTP requests.

func NewSessionCookieAuthenticator 

func NewSessionCookieAuthenticator(config *orm.Config, store CookieStore) CookieAuthenticator

NewSessionCookieAuthenticator creates a SessionCookieAuthenticator using the passed config and builder.

type CookieStore 

type CookieStore interface {
	Save(cookie *http.Cookie) error
	Retrieve() (*http.Cookie, error)
}

CookieStore is a place to store and retrieve cookies.

type DiskCookieStore 

type DiskCookieStore struct {
	Config *orm.Config
}

DiskCookieStore saves a single cookie in the local cli working directory.

func (DiskCookieStore) Retrieve 

func (d DiskCookieStore) Retrieve() (*http.Cookie, error)

Retrieve returns any Saved cookies.

func (DiskCookieStore) Save 

func (d DiskCookieStore) Save(cookie *http.Cookie) error

Save stores a cookie.

type HTTPClient 

type HTTPClient interface {
	Get(string, ...map[string]string) (*http.Response, error)
	Post(string, io.Reader) (*http.Response, error)
	Put(string, io.Reader) (*http.Response, error)
	Patch(string, io.Reader, ...map[string]string) (*http.Response, error)
	Delete(string) (*http.Response, error)
}

HTTPClient encapsulates all methods used to interact with a chainlink node API.

func NewAuthenticatedHTTPClient 

func NewAuthenticatedHTTPClient(config orm.ConfigReader, cookieAuth CookieAuthenticator) HTTPClient

NewAuthenticatedHTTPClient uses the CookieAuthenticator to generate a sessionID which is then used for all subsequent HTTP API requests.

type KeyStoreAuthenticator 

type KeyStoreAuthenticator interface {
	Authenticate(*store.Store, string) (string, error)
	AuthenticateVRFKey(*store.Store, string) error
	AuthenticateOCRKey(store *store.Store, password string) error
}

KeyStoreAuthenticator implements the Authenticate method for the store and a password string.

type MemoryCookieStore 

type MemoryCookieStore struct {
	Cookie *http.Cookie
}

MemoryCookieStore keeps a single cookie in memory

func (*MemoryCookieStore) Retrieve 

func (m *MemoryCookieStore) Retrieve() (*http.Cookie, error)

Retrieve returns any Saved cookies.

func (*MemoryCookieStore) Save 

func (m *MemoryCookieStore) Save(cookie *http.Cookie) error

Save stores a cookie.

type PasswordPrompter 

type PasswordPrompter interface {
	Prompt() string
}

PasswordPrompter is an interface primarily used for DI to obtain a password from the User.

func NewPasswordPrompter 

func NewPasswordPrompter() PasswordPrompter

NewPasswordPrompter returns the production password change request prompter

type Prompter 

type Prompter interface {
	Prompt(string) string
	PasswordPrompt(string) string
	IsTerminal() bool
}

Prompter implements the Prompt function to be used to display at the console.

func NewTerminalPrompter 

func NewTerminalPrompter() Prompter

NewTerminalPrompter prompts the user via terminal.

type Renderer 

type Renderer interface {
	Render(interface{}) error
}

Renderer implements the Render method.

type RendererJSON 

type RendererJSON struct {
	io.Writer
}

RendererJSON is used to render JSON data.

func (RendererJSON) Render 

func (rj RendererJSON) Render(v interface{}) error

Render writes the given input as a JSON string.

type RendererTable 

type RendererTable struct {
	io.Writer
}

RendererTable is used for data to be rendered as a table.

func (RendererTable) Render 

func (rt RendererTable) Render(v interface{}) error

Render returns a formatted table of text for a given Job or presenter and relevant information.

type Runner 

type Runner interface {
	Run(chainlink.Application) error
}

Runner implements the Run method.

type SessionCookieAuthenticator 

type SessionCookieAuthenticator struct {
	// contains filtered or unexported fields
}

SessionCookieAuthenticator is a concrete implementation of CookieAuthenticator that retrieves a session id for the user with credentials from the session request.

func (*SessionCookieAuthenticator) Authenticate 

func (t *SessionCookieAuthenticator) Authenticate(sessionRequest models.SessionRequest) (*http.Cookie, error)

Authenticate retrieves a session ID via a cookie and saves it to disk.

func (*SessionCookieAuthenticator) Cookie 

func (t *SessionCookieAuthenticator) Cookie() (*http.Cookie, error)

Cookie Returns the previously saved authentication cookie.

type SessionRequestBuilder 

type SessionRequestBuilder interface {
	Build(flag string) (models.SessionRequest, error)
}

SessionRequestBuilder is an interface that returns a SessionRequest, abstracting how session requests are generated, whether they be from the prompt or from a file.

func NewFileSessionRequestBuilder 

func NewFileSessionRequestBuilder() SessionRequestBuilder

NewFileSessionRequestBuilder pulls credentials from a file to generate a SessionRequest.

func NewPromptingSessionRequestBuilder 

func NewPromptingSessionRequestBuilder(prompter Prompter) SessionRequestBuilder

NewPromptingSessionRequestBuilder uses a prompter, often via terminal, to solicit information from a user to generate the SessionRequest.

type TerminalKeyStoreAuthenticator 

type TerminalKeyStoreAuthenticator struct {
	Prompter Prompter
}

TerminalKeyStoreAuthenticator contains fields for prompting the user and an exit code.

func (TerminalKeyStoreAuthenticator) Authenticate 

func (auth TerminalKeyStoreAuthenticator) Authenticate(store *store.Store, pwd string) (string, error)

Authenticate checks to see if there are accounts present in the KeyStore, and if there are none, a new account will be created by prompting for a password. If there are accounts present, the account which is unlocked by the given password will be used.

func (TerminalKeyStoreAuthenticator) AuthenticateOCRKey added in v0.9.3 

func (auth TerminalKeyStoreAuthenticator) AuthenticateOCRKey(store *store.Store, password string) error

func (TerminalKeyStoreAuthenticator) AuthenticateVRFKey added in v0.8.2 

func (auth TerminalKeyStoreAuthenticator) AuthenticateVRFKey(store *store.Store, password string) error

AuthenticateVRFKey creates an encrypted VRF key protected by password in store's db if db store has no extant keys. It unlocks at least one VRF key with given password, or returns an error. password must be non-trivial, as an empty password signifies that the VRF oracle functionality is disabled.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.