cmd

package
v1.13.3 Latest Latest
Warning

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

 Go to latest Published: Jun 6, 2023 License: MIT Imports: 96 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

View Source 
const (
	PristineDBName   = "chainlink_test_pristine"
	TestDBNamePrefix = "chainlink_test_"
)

PristineDBName is a clean copy of test DB with migrations. Used by heavyweight.FullTestDB* functions.

View Source 
const BootstrapTemplate = `` /* 330-byte string literal not displayed */
View Source 
const DKGTemplate = `` /* 451-byte string literal not displayed */
View Source 
const OCR2VRFTemplate = `` /* 556-byte string literal not displayed */

Variables

View Source 
var ErrNoCredentialFile = errors.New("no API user credential file was passed")
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(orm sessions.ORM, lggr logger.Logger) (sessions.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 AdminUsersPresenter added in v1.7.0 

type AdminUsersPresenter struct {
	JAID
	presenters.UserResource
}

func (*AdminUsersPresenter) RenderTable added in v1.7.0 

func (p *AdminUsersPresenter) RenderTable(rt RendererTable) error

RenderTable implements TableRenderer

func (*AdminUsersPresenter) ToRow added in v1.7.0 

func (p *AdminUsersPresenter) ToRow() []string

type AdminUsersPresenters added in v1.7.0 

type AdminUsersPresenters []AdminUsersPresenter

func (AdminUsersPresenters) RenderTable added in v1.7.0 

func (ps AdminUsersPresenters) RenderTable(rt RendererTable) error

RenderTable implements TableRenderer

type AppFactory 

type AppFactory interface {
	NewApplication(ctx context.Context, cfg config.GeneralConfig, appLggr logger.Logger, db *sqlx.DB) (chainlink.Application, error)
}

AppFactory implements the NewApplication method.

type BridgePresenter added in v0.10.6 

type BridgePresenter struct {
	presenters.BridgeResource
}

func (*BridgePresenter) FriendlyConfirmations added in v0.10.6 

func (p *BridgePresenter) FriendlyConfirmations() string

FriendlyConfirmations converts the confirmations to a string

func (*BridgePresenter) RenderTable added in v0.10.6 

func (p *BridgePresenter) RenderTable(rt RendererTable) error

RenderTable implements TableRenderer

type BridgePresenters added in v0.10.6 

type BridgePresenters []BridgePresenter

func (BridgePresenters) RenderTable added in v0.10.6 

func (ps BridgePresenters) RenderTable(rt RendererTable) error

RenderTable implements TableRenderer

type CSAKeyPresenter added in v0.10.8 

type CSAKeyPresenter struct {
	JAID
	presenters.CSAKeyResource
}

func (*CSAKeyPresenter) RenderTable added in v0.10.8 

func (p *CSAKeyPresenter) RenderTable(rt RendererTable) error

RenderTable implements TableRenderer

func (*CSAKeyPresenter) ToRow added in v0.10.8 

func (p *CSAKeyPresenter) ToRow() []string

type CSAKeyPresenters added in v0.10.8 

type CSAKeyPresenters []CSAKeyPresenter

func (CSAKeyPresenters) RenderTable added in v0.10.8 

func (ps CSAKeyPresenters) RenderTable(rt RendererTable) error

RenderTable implements TableRenderer

type ChainClient added in v1.5.0 

type ChainClient interface {
	IndexChains(c *cli.Context) error
	CreateChain(c *cli.Context) error
	RemoveChain(c *cli.Context) error
	ConfigureChain(c *cli.Context) error
}

ChainClient is a generic client interface for any type of chain.

func EVMChainClient added in v1.5.0 

func EVMChainClient(client *Client) ChainClient

func SolanaChainClient added in v1.5.0 

func SolanaChainClient(client *Client) ChainClient

func StarkNetChainClient added in v1.7.0 

func StarkNetChainClient(client *Client) ChainClient

type ChainlinkAppFactory 

type ChainlinkAppFactory struct{}

ChainlinkAppFactory is used to create a new Application.

func (ChainlinkAppFactory) NewApplication 

func (n ChainlinkAppFactory) NewApplication(ctx context.Context, cfg config.GeneralConfig, appLggr logger.Logger, db *sqlx.DB) (app chainlink.Application, err error)

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(ctx context.Context, 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() (web.UpdatePasswordRequest, 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                         config.GeneralConfig // initialized in Before
	Logger                         logger.Logger        // initialized in Before
	CloseLogger                    func() error         // called in After
	AppFactory                     AppFactory
	KeyStoreAuthenticator          TerminalKeyStoreAuthenticator
	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) 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) ChangeRole added in v1.8.0 

func (cli *Client) ChangeRole(c *cli.Context) (err error)

ChangeRole can change a user's role

func (*Client) ConfigDump added in v1.6.0 

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

func (*Client) ConfigFileValidate added in v1.9.0 

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

func (*Client) ConfigV2 added in v1.10.0 

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

func (*Client) ConfigureOCR2VRFNode added in v1.7.0 

func (cli *Client) ConfigureOCR2VRFNode(c *clipkg.Context, owner *bind.TransactOpts, ec *ethclient.Client) (*SetupOCR2VRFNodePayload, error)

func (*Client) CreateBridge added in v0.6.6 

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

CreateBridge adds a new bridge to the chainlink node

func (*Client) CreateCSAKey added in v0.10.8 

func (cli *Client) CreateCSAKey(c *cli.Context) (err error)

CreateCSAKey creates a new CSA key

func (*Client) CreateETHKey added in v0.9.9 

func (cli *Client) CreateETHKey(c *cli.Context) (err error)

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

func (*Client) CreateExternalInitiator 

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

CreateExternalInitiator adds an external initiator

func (*Client) CreateJob added in v1.1.0 

func (cli *Client) CreateJob(c *cli.Context) (err error)

CreateJob creates a job Valid input is a TOML string or a path to TOML file

func (*Client) CreateMigration added in v1.0.0 

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

CreateMigration displays the database migration status

func (*Client) CreateOCR2KeyBundle added in v1.2.0 

func (cli *Client) CreateOCR2KeyBundle(c *cli.Context) error

CreateOCR2KeyBundle creates an OCR2 key bundle and saves it to the keystore

func (*Client) CreateOCRKeyBundle added in v0.8.17 

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

CreateOCR2KeyBundle creates an OCR key bundle and saves it to the keystore

func (*Client) CreateP2PKey added in v0.8.12 

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

CreateP2PKey creates a new P2P key

func (*Client) CreateUser added in v1.7.0 

func (cli *Client) CreateUser(c *cli.Context) (err error)

CreateUser creates a new user by prompting for email, password, and role

func (*Client) CreateVRFKey added in v0.8.2 

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

CreateVRFKey creates a key in the VRF keystore, protected by the password in the vrf password file provided when starting the chainlink node.

func (*Client) DeleteETHKey added in v0.9.9 

func (cli *Client) DeleteETHKey(c *cli.Context) (err error)

DeleteETHKey hard deletes an Ethereum key, address of key must be passed

func (*Client) DeleteExternalInitiator 

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

DeleteExternalInitiator removes an external initiator

func (*Client) DeleteForwarder added in v1.3.0 

func (cli *Client) DeleteForwarder(c *cli.Context) (err error)

DeleteForwarder deletes forwarder address from node db by id.

func (*Client) DeleteJob added in v1.0.0 

func (cli *Client) DeleteJob(c *cli.Context) error

DeleteJob deletes a job

func (*Client) DeleteOCR2KeyBundle added in v1.2.0 

func (cli *Client) DeleteOCR2KeyBundle(c *cli.Context) error

DeleteOCR2KeyBundle deletes an OCR2 key bundle

func (*Client) DeleteOCRKeyBundle added in v0.8.17 

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

DeleteOCR2KeyBundle deletes an OCR key bundle

func (*Client) DeleteP2PKey added in v0.9.0 

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

DeleteP2PKey deletes a P2P key, key ID must be passed

func (*Client) DeleteUser 

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

DeleteUser deletes an API user by email

func (*Client) DeleteVRFKey added in v0.8.2 

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

DeleteVRFKey deletes (hard or soft) the VRF key with given public key from the db and memory. V2 jobs referencing the VRF key will be removed if the key is deleted (no such protection for the V1 jobs exists).

func (*Client) ExportCSAKey added in v1.1.0 

func (cli *Client) ExportCSAKey(c *cli.Context) (err error)

ExportCSAKey exports a CSA key. Key ID must be passed.

func (*Client) ExportETHKey added in v0.9.9 

func (cli *Client) ExportETHKey(c *cli.Context) (err error)

ExportETHKey exports an ETH key, address must be passed

func (*Client) ExportOCR2Key added in v1.2.0 

func (cli *Client) ExportOCR2Key(c *cli.Context) (err error)

ExportOCR2Key exports an OCR2 key bundle by ID

func (*Client) ExportOCRKey added in v0.9.9 

func (cli *Client) ExportOCRKey(c *cli.Context) (err error)

ExportOCR2Key exports an OCR key bundle by ID

func (*Client) ExportP2PKey added in v0.9.9 

func (cli *Client) ExportP2PKey(c *cli.Context) (err error)

ExportP2PKey exports a P2P key, key ID must be passed

func (*Client) ExportVRFKey added in v0.8.2 

func (cli *Client) ExportVRFKey(c *cli.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) ImportCSAKey added in v1.1.0 

func (cli *Client) ImportCSAKey(c *cli.Context) (err error)

ImportCSAKey imports and stores a CSA key. Path to key must be passed.

func (*Client) ImportETHKey added in v0.9.9 

func (cli *Client) ImportETHKey(c *cli.Context) (err error)

ImportETHKey imports an Ethereum key, file path must be passed

func (*Client) ImportOCR2Key added in v1.2.0 

func (cli *Client) ImportOCR2Key(c *cli.Context) (err error)

ImportOCR2Key imports OCR2 key bundle

func (*Client) ImportOCRKey added in v0.9.9 

func (cli *Client) ImportOCRKey(c *cli.Context) (err error)

ImportOCR2Key imports OCR key bundle

func (*Client) ImportP2PKey added in v0.9.9 

func (cli *Client) ImportP2PKey(c *cli.Context) (err error)

ImportP2PKey imports and stores a P2P key, path to key must be passed

func (*Client) ImportVRFKey added in v0.8.2 

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

IndexBridges returns all bridges.

func (*Client) IndexExternalInitiators added in v0.10.11 

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

IndexExternalInitiators lists external initiators

func (*Client) IndexTransactions added in v0.6.6 

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

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

func (*Client) ListCSAKeys added in v0.10.8 

func (cli *Client) ListCSAKeys(c *cli.Context) (err error)

ListCSAKeys retrieves a list of all CSA keys

func (*Client) ListETHKeys added in v0.9.3 

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

ListETHKeys renders the active account address with its ETH & LINK balance

func (*Client) ListForwarders added in v1.3.0 

func (cli *Client) ListForwarders(c *cli.Context) (err error)

ListForwarders list all forwarder addresses tracked by node

func (*Client) ListJobs added in v1.1.0 

func (cli *Client) ListJobs(c *cli.Context) (err error)

ListJobs lists all jobs

func (*Client) ListOCR2KeyBundles added in v1.2.0 

func (cli *Client) ListOCR2KeyBundles(c *cli.Context) error

ListOCR2KeyBundles lists the available OCR2 Key Bundles

func (*Client) ListOCRKeyBundles added in v0.8.17 

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

ListOCRKeyBundles lists the available OCR Key Bundles

func (*Client) ListP2PKeys added in v0.9.0 

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

ListP2PKeys retrieves a list of all P2P keys

func (*Client) ListUsers added in v1.7.0 

func (cli *Client) ListUsers(c *cli.Context) (err error)

ListUsers renders all API users and their roles

func (*Client) ListVRFKeys added in v0.10.5 

func (cli *Client) ListVRFKeys(c *cli.Context) error

ListKeys Lists the keys in the db

func (*Client) Logout added in v1.7.0 

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

Logout removes local and remote session.

func (*Client) MigrateDatabase added in v0.10.8 

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

MigrateDatabase migrates the database

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) PrepareTestDatabaseUserOnly added in v1.1.0 

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

PrepareTestDatabase calls ResetDatabase then loads fixtures required for local testing against testnets. Does not include fake chain fixtures.

func (*Client) Profile added in v1.2.0 

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

Profile will collect pprof metrics and store them in a folder.

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 *cli.Context) (err error)

RemoveBridge removes a specific Bridge by name.

func (*Client) ReplayFromBlock added in v0.10.11 

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

ReplayFromBlock replays chain data from the given block number until the most recent

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) RollbackDatabase added in v1.0.0 

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

VersionDatabase displays the current database version.

func (*Client) RunNode 

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

RunNode starts the Chainlink core.

func (*Client) SendEther 

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

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

func (*Client) SetEvmGasPriceDefault added in v1.1.0 

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

SetEvmGasPriceDefault specifies the minimum gas price to use for outgoing transactions

func (*Client) SetLogLevel added in v0.10.4 

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

SetLogLevel sets the log level on the node

func (*Client) SetLogSQL added in v0.10.4 

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

SetLogSQL enables or disables the log sql statements

func (*Client) ShowBridge 

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

ShowBridge returns the info for the given Bridge name.

func (*Client) ShowJob added in v1.1.0 

func (cli *Client) ShowJob(c *cli.Context) (err error)

ShowJob displays the details of a job

func (*Client) ShowTransaction added in v0.6.6 

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

ShowTransaction returns the info for the given transaction hash

func (*Client) SolanaSendSol added in v1.4.0 

func (cli *Client) SolanaSendSol(c *cli.Context) (err error)

SolanaSendSol transfers sol from the node's account to a specified address.

func (*Client) Status added in v0.10.8 

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

Status will display the health of various services

func (*Client) StatusDatabase added in v1.0.0 

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

StatusDatabase displays the database migration status

func (*Client) TrackForwarder added in v1.8.0 

func (cli *Client) TrackForwarder(c *cli.Context) (err error)

TrackForwarder tracks forwarder address in db.

func (*Client) TriggerPipelineRun added in v0.9.7 

func (cli *Client) TriggerPipelineRun(c *cli.Context) error

TriggerPipelineRun triggers a job run based on a job ID

func (*Client) UpdateChainEVMKey added in v1.8.0 

func (cli *Client) UpdateChainEVMKey(c *cli.Context) (err error)

UpdateChainEVMKey updates settings for the given key on the given chain

func (*Client) UpdateETHKey added in v1.1.0 

func (cli *Client) UpdateETHKey(c *cli.Context) (err error)

UpdateETHKey updates an Ethereum key's parameters, address of key must be passed as well as at least one parameter to update

func (*Client) VersionDatabase added in v0.10.8 

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

VersionDatabase displays the current database version.

type ClientOpts added in v1.5.0 

type ClientOpts struct {
	RemoteNodeURL      url.URL
	InsecureSkipVerify bool
}

type CookieAuthenticator 

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

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

func NewSessionCookieAuthenticator 

func NewSessionCookieAuthenticator(config ClientOpts, store CookieStore, lggr logger.Logger) 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)
	Reset() error
}

CookieStore is a place to store and retrieve cookies.

type DKGEncryptKeyPresenter added in v1.7.0 

type DKGEncryptKeyPresenter struct {
	JAID
	presenters.DKGEncryptKeyResource
}

func (DKGEncryptKeyPresenter) RenderTable added in v1.7.0 

func (p DKGEncryptKeyPresenter) RenderTable(rt RendererTable) error

RenderTable implements TableRenderer

func (*DKGEncryptKeyPresenter) ToRow added in v1.7.0 

func (p *DKGEncryptKeyPresenter) ToRow() []string

type DKGEncryptKeyPresenters added in v1.7.0 

type DKGEncryptKeyPresenters []DKGEncryptKeyPresenter

func (DKGEncryptKeyPresenters) RenderTable added in v1.7.0 

func (ps DKGEncryptKeyPresenters) RenderTable(rt RendererTable) error

RenderTable implements TableRenderer

type DKGSignKeyPresenter added in v1.6.0 

type DKGSignKeyPresenter struct {
	JAID
	presenters.DKGSignKeyResource
}

func (DKGSignKeyPresenter) RenderTable added in v1.6.0 

func (p DKGSignKeyPresenter) RenderTable(rt RendererTable) error

RenderTable implements TableRenderer

func (*DKGSignKeyPresenter) ToRow added in v1.6.0 

func (p *DKGSignKeyPresenter) ToRow() []string

type DKGSignKeyPresenters added in v1.6.0 

type DKGSignKeyPresenters []DKGSignKeyPresenter

func (DKGSignKeyPresenters) RenderTable added in v1.6.0 

func (ps DKGSignKeyPresenters) RenderTable(rt RendererTable) error

RenderTable implements TableRenderer

type DiskCookieConfig added in v1.0.0 

type DiskCookieConfig interface {
	RootDir() string
}

type DiskCookieStore 

type DiskCookieStore struct {
	Config DiskCookieConfig
}

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

func (DiskCookieStore) Reset added in v1.3.0 

func (d DiskCookieStore) Reset() error

Removes any stored cookie.

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 EVMChainPresenter added in v1.2.0 

type EVMChainPresenter struct {
	presenters.EVMChainResource
}

EVMChainPresenter implements TableRenderer for an EVMChainResource.

func (EVMChainPresenter) RenderTable added in v1.2.0 

func (p EVMChainPresenter) RenderTable(rt RendererTable) error

RenderTable implements TableRenderer Just renders a single row

func (*EVMChainPresenter) ToRow added in v1.2.0 

func (p *EVMChainPresenter) ToRow() []string

ToRow presents the EVMChainResource as a slice of strings.

type EVMChainPresenters added in v1.2.0 

type EVMChainPresenters []EVMChainPresenter

EVMChainPresenters implements TableRenderer for a slice of EVMChainPresenters.

func (EVMChainPresenters) RenderTable added in v1.2.0 

func (ps EVMChainPresenters) RenderTable(rt RendererTable) error

RenderTable implements TableRenderer

type EVMForwarderPresenter added in v1.3.0 

type EVMForwarderPresenter struct {
	JAID // This is needed to render the id for a JSONAPI Resource as normal JSON
	presenters.EVMForwarderResource
}

func (*EVMForwarderPresenter) RenderTable added in v1.3.0 

func (p *EVMForwarderPresenter) RenderTable(rt RendererTable) error

RenderTable implements TableRenderer

func (*EVMForwarderPresenter) ToRow added in v1.3.0 

func (p *EVMForwarderPresenter) ToRow() []string

ToRow presents the EVMForwarderResource as a slice of strings.

type EVMForwarderPresenters added in v1.3.0 

type EVMForwarderPresenters []EVMForwarderPresenter

EVMForwarderPresenters implements TableRenderer for a slice of EVMForwarderPresenter.

func (EVMForwarderPresenters) RenderTable added in v1.3.0 

func (ps EVMForwarderPresenters) RenderTable(rt RendererTable) error

RenderTable implements TableRenderer

type EVMNodePresenter added in v1.2.0 

type EVMNodePresenter struct {
	presenters.EVMNodeResource
}

EVMNodePresenter implements TableRenderer for an EVMNodeResource.

func (EVMNodePresenter) RenderTable added in v1.2.0 

func (p EVMNodePresenter) RenderTable(rt RendererTable) error

RenderTable implements TableRenderer

func (*EVMNodePresenter) ToRow added in v1.2.0 

func (p *EVMNodePresenter) ToRow() []string

ToRow presents the EVMNodeResource as a slice of strings.

type EVMNodePresenters added in v1.2.0 

type EVMNodePresenters []EVMNodePresenter

EVMNodePresenters implements TableRenderer for a slice of EVMNodePresenter.

func (EVMNodePresenters) RenderTable added in v1.2.0 

func (ps EVMNodePresenters) RenderTable(rt RendererTable) error

RenderTable implements TableRenderer

type ErrIncompatible added in v1.3.0 

type ErrIncompatible struct {
	CLIVersion, CLISha       string
	RemoteVersion, RemoteSha string
}

ErrIncompatible is returned when the cli and remote versions are not compatible.

func (ErrIncompatible) Error added in v1.3.0 

func (e ErrIncompatible) Error() string

type EthKeyPresenter added in v0.10.6 

type EthKeyPresenter struct {
	presenters.ETHKeyResource
}

func (*EthKeyPresenter) RenderTable added in v0.10.6 

func (p *EthKeyPresenter) RenderTable(rt RendererTable) error

RenderTable implements TableRenderer

func (*EthKeyPresenter) ToRow added in v0.10.6 

func (p *EthKeyPresenter) ToRow() []string

type EthKeyPresenters added in v0.10.6 

type EthKeyPresenters []EthKeyPresenter

func (EthKeyPresenters) RenderTable added in v0.10.6 

func (ps EthKeyPresenters) RenderTable(rt RendererTable) error

RenderTable implements TableRenderer

type EthTxPresenter added in v0.10.6 

type EthTxPresenter struct {
	JAID
	presenters.EthTxResource
}

func (*EthTxPresenter) RenderTable added in v0.10.6 

func (p *EthTxPresenter) RenderTable(rt RendererTable) error

RenderTable implements TableRenderer

type EthTxPresenters added in v0.10.6 

type EthTxPresenters []EthTxPresenter

func (EthTxPresenters) RenderTable added in v0.10.6 

func (ps EthTxPresenters) RenderTable(rt RendererTable) error

RenderTable implements TableRenderer

type ExternalInitiatorPresenter added in v0.10.11 

type ExternalInitiatorPresenter struct {
	JAID
	presenters.ExternalInitiatorResource
}

func (*ExternalInitiatorPresenter) RenderTable added in v0.10.11 

func (eip *ExternalInitiatorPresenter) RenderTable(rt RendererTable) error

func (*ExternalInitiatorPresenter) ToRow added in v0.10.11 

func (eip *ExternalInitiatorPresenter) ToRow() []string

type ExternalInitiatorPresenters added in v0.10.11 

type ExternalInitiatorPresenters []ExternalInitiatorPresenter

func (*ExternalInitiatorPresenters) RenderTable added in v0.10.11 

func (eips *ExternalInitiatorPresenters) RenderTable(rt RendererTable) error

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(lggr logger.Logger, clientOpts ClientOpts, cookieAuth CookieAuthenticator, sessionRequest sessions.SessionRequest) HTTPClient

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

type HealthCheckPresenter added in v0.10.8 

type HealthCheckPresenter struct {
	webPresenters.Check
}

func (*HealthCheckPresenter) ToRow added in v0.10.8 

func (p *HealthCheckPresenter) ToRow() []string

type HealthCheckPresenters added in v0.10.8 

type HealthCheckPresenters []HealthCheckPresenter

func (HealthCheckPresenters) RenderTable added in v0.10.8 

func (ps HealthCheckPresenters) RenderTable(rt RendererTable) error

RenderTable implements TableRenderer

type JAID added in v0.10.3 

type JAID struct {
	ID string `json:"id"`
}

JAID represents a JSON API ID.

It implements the api2go MarshalIdentifier and UnmarshalIdentitier interface.

When you embed a JSONAPI resource into a presenter, it will not render the ID into the JSON object when you perform a json.Marshal. Instead we use this to override the ID field of the resource with a JSON tag that will render.

Embed this into a Presenter to render the ID. For example 

type JobPresenter struct {
	JAID
	presenters.JobResource
}

func NewJAID added in v0.10.5 

func NewJAID(id string) JAID

func (JAID) GetID added in v0.10.3 

func (jaid JAID) GetID() string

GetID implements the api2go MarshalIdentifier interface.

func (*JAID) SetID added in v0.10.3 

func (jaid *JAID) SetID(value string) error

SetID implements the api2go UnmarshalIdentitier interface.

type JobPresenter added in v0.10.5 

type JobPresenter struct {
	JAID // This is needed to render the id for a JSONAPI Resource as normal JSON
	presenters.JobResource
}

JobRenderer wraps the JSONAPI Job Resource and adds rendering functionality

func (JobPresenter) FriendlyCreatedAt added in v0.10.5 

func (p JobPresenter) FriendlyCreatedAt() string

FriendlyCreatedAt returns the created at timestamp of the spec which matches the type in RFC3339 format.

func (JobPresenter) FriendlyTasks added in v0.10.5 

func (p JobPresenter) FriendlyTasks() []string

FriendlyTasks returns the tasks

func (JobPresenter) GetTasks added in v0.10.5 

func (p JobPresenter) GetTasks() ([]string, error)

GetTasks extracts the tasks from the dependency graph

func (*JobPresenter) RenderTable added in v0.10.6 

func (p *JobPresenter) RenderTable(rt RendererTable) error

RenderTable implements TableRenderer

func (JobPresenter) ToRows added in v0.10.5 

func (p JobPresenter) ToRows() [][]string

ToRows returns the job as a multiple rows per task

type JobPresenters added in v0.10.6 

type JobPresenters []JobPresenter

func (JobPresenters) RenderTable added in v0.10.6 

func (ps JobPresenters) RenderTable(rt RendererTable) error

RenderTable implements TableRenderer

type KeysClient added in v1.5.0 

type KeysClient interface {
	CreateKey(*cli.Context) error
	ImportKey(*cli.Context) error
	ExportKey(*cli.Context) error
	DeleteKey(*cli.Context) error
	ListKeys(*cli.Context) error
}

KeysClient is a generic client interface for any type of key.

func NewDKGEncryptKeysClient added in v1.7.0 

func NewDKGEncryptKeysClient(c *Client) KeysClient

func NewDKGSignKeysClient added in v1.6.0 

func NewDKGSignKeysClient(c *Client) KeysClient

func NewSolanaKeysClient added in v1.5.0 

func NewSolanaKeysClient(c *Client) KeysClient

func NewStarkNetKeysClient added in v1.6.0 

func NewStarkNetKeysClient(c *Client) KeysClient

type MemoryCookieStore 

type MemoryCookieStore struct {
	Cookie *http.Cookie
}

MemoryCookieStore keeps a single cookie in memory

func (*MemoryCookieStore) Reset added in v1.3.0 

func (m *MemoryCookieStore) Reset() error

Removes any stored cookie.

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 NodeClient added in v1.5.0 

type NodeClient interface {
	IndexNodes(c *cli.Context) error
	CreateNode(c *cli.Context) error
	RemoveNode(c *cli.Context) error
}

NodeClient is a generic client interface for any of node.

func NewEVMNodeClient added in v1.5.0 

func NewEVMNodeClient(c *Client) NodeClient

func NewSolanaNodeClient added in v1.5.0 

func NewSolanaNodeClient(c *Client) NodeClient

func NewStarkNetNodeClient added in v1.7.0 

func NewStarkNetNodeClient(c *Client) NodeClient

type OCR2KeyBundlePresenter added in v1.2.0 

type OCR2KeyBundlePresenter struct {
	JAID // Include this to overwrite the presenter JAID so it can correctly render the ID in JSON
	presenters.OCR2KeysBundleResource
}

func (*OCR2KeyBundlePresenter) RenderTable added in v1.2.0 

func (p *OCR2KeyBundlePresenter) RenderTable(rt RendererTable) error

RenderTable implements TableRenderer

func (*OCR2KeyBundlePresenter) ToRow added in v1.2.0 

func (p *OCR2KeyBundlePresenter) ToRow() []string

type OCR2KeyBundlePresenters added in v1.2.0 

type OCR2KeyBundlePresenters []OCR2KeyBundlePresenter

func (OCR2KeyBundlePresenters) RenderTable added in v1.2.0 

func (ps OCR2KeyBundlePresenters) RenderTable(rt RendererTable) error

RenderTable implements TableRenderer

type OCRKeyBundlePresenter added in v0.10.6 

type OCRKeyBundlePresenter struct {
	JAID // Include this to overwrite the presenter JAID so it can correctly render the ID in JSON
	presenters.OCRKeysBundleResource
}

func (*OCRKeyBundlePresenter) RenderTable added in v0.10.6 

func (p *OCRKeyBundlePresenter) RenderTable(rt RendererTable) error

RenderTable implements TableRenderer

func (*OCRKeyBundlePresenter) ToRow added in v0.10.6 

func (p *OCRKeyBundlePresenter) ToRow() []string

type OCRKeyBundlePresenters added in v0.10.6 

type OCRKeyBundlePresenters []OCRKeyBundlePresenter

func (OCRKeyBundlePresenters) RenderTable added in v0.10.6 

func (ps OCRKeyBundlePresenters) RenderTable(rt RendererTable) error

RenderTable implements TableRenderer

type P2PKeyPresenter added in v0.10.5 

type P2PKeyPresenter struct {
	JAID
	presenters.P2PKeyResource
}

func (*P2PKeyPresenter) RenderTable added in v0.10.6 

func (p *P2PKeyPresenter) RenderTable(rt RendererTable) error

RenderTable implements TableRenderer

func (*P2PKeyPresenter) ToRow added in v0.10.6 

func (p *P2PKeyPresenter) ToRow() []string

type P2PKeyPresenters added in v0.10.6 

type P2PKeyPresenters []P2PKeyPresenter

func (P2PKeyPresenters) RenderTable added in v0.10.6 

func (ps P2PKeyPresenters) RenderTable(rt RendererTable) error

RenderTable implements TableRenderer

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{}, ...string) 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{}, _ ...string) 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{}, headers ...string) error

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

type Runner 

type Runner interface {
	Run(context.Context, 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 sessions.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.

func (*SessionCookieAuthenticator) Logout added in v1.3.0 

func (t *SessionCookieAuthenticator) Logout() error

Deletes any stored session

type SessionRequestBuilder 

type SessionRequestBuilder interface {
	Build(flag string) (sessions.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(lggr logger.Logger) 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 SetupOCR2VRFNodePayload added in v1.7.0 

type SetupOCR2VRFNodePayload struct {
	OnChainPublicKey  string
	OffChainPublicKey string
	ConfigPublicKey   string
	PeerID            string
	Transmitter       string
	DkgEncrypt        string
	DkgSign           string
	SendingKeys       []string
}

type SolanaChainPresenter added in v1.4.0 

type SolanaChainPresenter struct {
	presenters.SolanaChainResource
}

SolanaChainPresenter implements TableRenderer for a SolanaChainResource

func (SolanaChainPresenter) RenderTable added in v1.4.0 

func (p SolanaChainPresenter) RenderTable(rt RendererTable) error

RenderTable implements TableRenderer Just renders a single row

func (*SolanaChainPresenter) ToRow added in v1.4.0 

func (p *SolanaChainPresenter) ToRow() []string

ToRow presents the SolanaChainResource as a slice of strings.

type SolanaChainPresenters added in v1.4.0 

type SolanaChainPresenters []SolanaChainPresenter

SolanaChainPresenters implements TableRenderer for a slice of SolanaChainPresenters.

func (SolanaChainPresenters) RenderTable added in v1.4.0 

func (ps SolanaChainPresenters) RenderTable(rt RendererTable) error

RenderTable implements TableRenderer

type SolanaKeyPresenter added in v1.2.0 

type SolanaKeyPresenter struct {
	JAID
	presenters.SolanaKeyResource
}

func (SolanaKeyPresenter) RenderTable added in v1.2.0 

func (p SolanaKeyPresenter) RenderTable(rt RendererTable) error

RenderTable implements TableRenderer

func (*SolanaKeyPresenter) ToRow added in v1.2.0 

func (p *SolanaKeyPresenter) ToRow() []string

type SolanaKeyPresenters added in v1.2.0 

type SolanaKeyPresenters []SolanaKeyPresenter

func (SolanaKeyPresenters) RenderTable added in v1.2.0 

func (ps SolanaKeyPresenters) RenderTable(rt RendererTable) error

RenderTable implements TableRenderer

type SolanaMsgPresenter added in v1.4.0 

type SolanaMsgPresenter struct {
	JAID
	presenters.SolanaMsgResource
}

func (*SolanaMsgPresenter) RenderTable added in v1.4.0 

func (p *SolanaMsgPresenter) RenderTable(rt RendererTable) error

RenderTable implements TableRenderer

type SolanaNodePresenter added in v1.4.0 

type SolanaNodePresenter struct {
	presenters.SolanaNodeResource
}

SolanaNodePresenter implements TableRenderer for a SolanaNodeResource.

func (SolanaNodePresenter) RenderTable added in v1.4.0 

func (p SolanaNodePresenter) RenderTable(rt RendererTable) error

RenderTable implements TableRenderer

func (*SolanaNodePresenter) ToRow added in v1.4.0 

func (p *SolanaNodePresenter) ToRow() []string

ToRow presents the SolanaNodeResource as a slice of strings.

type SolanaNodePresenters added in v1.4.0 

type SolanaNodePresenters []SolanaNodePresenter

SolanaNodePresenters implements TableRenderer for a slice of SolanaNodePresenter.

func (SolanaNodePresenters) RenderTable added in v1.4.0 

func (ps SolanaNodePresenters) RenderTable(rt RendererTable) error

RenderTable implements TableRenderer

type StarkNetChainPresenter added in v1.7.0 

type StarkNetChainPresenter struct {
	presenters.StarkNetChainResource
}

StarkNetChainPresenter implements TableRenderer for a StarkNetChainResource

func (StarkNetChainPresenter) RenderTable added in v1.7.0 

func (p StarkNetChainPresenter) RenderTable(rt RendererTable) error

RenderTable implements TableRenderer Just renders a single row

func (*StarkNetChainPresenter) ToRow added in v1.7.0 

func (p *StarkNetChainPresenter) ToRow() []string

ToRow presents the StarkNetChainResource as a slice of strings.

type StarkNetChainPresenters added in v1.7.0 

type StarkNetChainPresenters []StarkNetChainPresenter

StarkNetChainPresenters implements TableRenderer for a slice of StarkNetChainPresenters.

func (StarkNetChainPresenters) RenderTable added in v1.7.0 

func (ps StarkNetChainPresenters) RenderTable(rt RendererTable) error

RenderTable implements TableRenderer

type StarkNetKeyPresenter added in v1.6.0 

type StarkNetKeyPresenter struct {
	JAID
	presenters.StarkNetKeyResource
}

func (StarkNetKeyPresenter) RenderTable added in v1.6.0 

func (p StarkNetKeyPresenter) RenderTable(rt RendererTable) error

RenderTable implements TableRenderer

func (*StarkNetKeyPresenter) ToRow added in v1.6.0 

func (p *StarkNetKeyPresenter) ToRow() []string

type StarkNetKeyPresenters added in v1.6.0 

type StarkNetKeyPresenters []StarkNetKeyPresenter

func (StarkNetKeyPresenters) RenderTable added in v1.6.0 

func (ps StarkNetKeyPresenters) RenderTable(rt RendererTable) error

RenderTable implements TableRenderer

type StarkNetNodePresenter added in v1.7.0 

type StarkNetNodePresenter struct {
	presenters.StarkNetNodeResource
}

StarkNetNodePresenter implements TableRenderer for a StarkNetNodeResource.

func (StarkNetNodePresenter) RenderTable added in v1.7.0 

func (p StarkNetNodePresenter) RenderTable(rt RendererTable) error

RenderTable implements TableRenderer

func (*StarkNetNodePresenter) ToRow added in v1.7.0 

func (p *StarkNetNodePresenter) ToRow() []string

ToRow presents the StarkNetNodeResource as a slice of strings.

type StarkNetNodePresenters added in v1.7.0 

type StarkNetNodePresenters []StarkNetNodePresenter

StarkNetNodePresenters implements TableRenderer for a slice of StarkNetNodePresenter.

func (StarkNetNodePresenters) RenderTable added in v1.7.0 

func (ps StarkNetNodePresenters) RenderTable(rt RendererTable) error

RenderTable implements TableRenderer

type TableRenderer added in v0.10.6 

type TableRenderer interface {
	RenderTable(rt RendererTable) error
}

type TerminalKeyStoreAuthenticator 

type TerminalKeyStoreAuthenticator struct {
	Prompter Prompter
}

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

type VRFKeyPresenter added in v0.10.5 

type VRFKeyPresenter struct {
	JAID // Include this to overwrite the presenter JAID so it can correctly render the ID in JSON
	presenters.VRFKeyResource
}

func (*VRFKeyPresenter) RenderTable added in v0.10.6 

func (p *VRFKeyPresenter) RenderTable(rt RendererTable) error

RenderTable implements TableRenderer

func (*VRFKeyPresenter) ToRow added in v0.10.6 

func (p *VRFKeyPresenter) ToRow() []string

type VRFKeyPresenters added in v0.10.6 

type VRFKeyPresenters []VRFKeyPresenter

func (VRFKeyPresenters) RenderTable added in v0.10.6 

func (ps VRFKeyPresenters) RenderTable(rt RendererTable) error

RenderTable implements TableRenderer

Source Files

View all Source files

Directories

Path Synopsis

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.