cmd

package
v0.6.4 Latest Latest
Warning

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

 Go to latest Published: Jul 24, 2019 License: MIT Imports: 37 Imported by: 0

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 InitEnclave 

func InitEnclave() error

InitEnclave is a stub in non SGX enabled builds.

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(store.Config, ...func(services.Application)) services.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 store.Config, onConnectCallbacks ...func(services.Application)) services.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 services.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                         store.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) AddBridge 

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

AddBridge adds a new bridge to the chainlink node

func (*Client) ArchiveJobSpec 

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

ArchiveJobSpec soft deletes a job and its associated runs.

func (*Client) ChangePassword 

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

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

func (*Client) CreateExternalInitiator 

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

CreateExternalInitiator adds an external initiator

func (*Client) CreateExtraKey 

func (cli *Client) CreateExtraKey(c *clipkg.Context) 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) error

CreateJobRun creates job run based on SpecID and optional JSON

func (*Client) CreateJobSpec 

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

CreateJobSpec creates a JobSpec based on JSON input

func (*Client) CreateServiceAgreement 

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

CreateServiceAgreement creates a ServiceAgreement based on JSON input

func (*Client) DeleteExternalInitiator 

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

DeleteExternalInitiator removes an external initiator

func (*Client) DeleteUser 

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

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

func (*Client) DisplayAccountBalance 

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

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

func (*Client) GetBridges 

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

GetBridges returns all bridges.

func (*Client) GetJobRuns 

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

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

func (*Client) GetJobSpecs 

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

GetJobSpecs returns all job specs.

func (*Client) GetTransactions 

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

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

func (*Client) GetTxAttempts 

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

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

func (*Client) ImportKey 

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

ImportKey imports a key to be used with the chainlink node

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) error

RemoveBridge removes a specific Bridge by name.

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) error

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

func (*Client) ShowBridge 

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

ShowBridge returns the info for the given Bridge name.

func (*Client) ShowJobRun 

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

ShowJobRun returns the status of the given Jobrun.

func (*Client) ShowJobSpec 

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

ShowJobSpec returns the status of the given JobID.

func (*Client) Withdraw 

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

Withdraw will withdraw LINK to an address authorized by the node

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 store.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 store.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)
	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(cfg store.Config, 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)
}

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(services.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.

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.