external

Documentation

Index

• type ExternalBackend
  • func NewExternalBackend(endpoint string) (*ExternalBackend, error)
  • func (eb *ExternalBackend) Subscribe(sink chan<- accounts.WalletEvent) event.Subscription
  • func (eb *ExternalBackend) Wallets() []accounts.Wallet
• type ExternalSigner
  • func NewExternalSigner(endpoint string) (*ExternalSigner, error)
  • func (api *ExternalSigner) Accounts() []accounts.Account
  • func (api *ExternalSigner) Close() error
  • func (api *ExternalSigner) Contains(account accounts.Account) bool
  • func (api *ExternalSigner) Derive(path accounts.DerivationPath, pin bool) (accounts.Account, error)
  • func (api *ExternalSigner) Open(passphrase string) error
  • func (api *ExternalSigner) SelfDerive(bases []accounts.DerivationPath, chain metrachain.ChainStateReader)
  • func (api *ExternalSigner) SignData(account accounts.Account, mimeType string, data []byte) ([]byte, error)
  • func (api *ExternalSigner) SignDataWithPassphrase(account accounts.Account, passphrase, mimeType string, data []byte) ([]byte, error)
  • func (api *ExternalSigner) SignText(account accounts.Account, text []byte) ([]byte, error)
  • func (api *ExternalSigner) SignTextWithPassphrase(account accounts.Account, passphrase string, text []byte) ([]byte, error)
  • func (api *ExternalSigner) SignTx(account accounts.Account, tx *types.Transaction, chainID *big.Int) (*types.Transaction, error)
  • func (api *ExternalSigner) SignTxWithPassphrase(account accounts.Account, passphrase string, tx *types.Transaction, ...) (*types.Transaction, error)
  • func (api *ExternalSigner) Status() (string, error)
  • func (api *ExternalSigner) URL() accounts.URL

Types

type ExternalBackend

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

func NewExternalBackend

func NewExternalBackend(endpoint string) (*ExternalBackend, error)

func (*ExternalBackend) Subscribe

func (eb *ExternalBackend) Subscribe(sink chan<- accounts.WalletEvent) event.Subscription

func (*ExternalBackend) Wallets

func (eb *ExternalBackend) Wallets() []accounts.Wallet

type ExternalSigner

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

ExternalSigner provides an API to interact with an external signer (clef) It proxies request to the external signer while forwarding relevant request headers

func NewExternalSigner

func NewExternalSigner(endpoint string) (*ExternalSigner, error)

func (*ExternalSigner) Accounts

func (api *ExternalSigner) Accounts() []accounts.Account

func (*ExternalSigner) Close

func (api *ExternalSigner) Close() error

func (*ExternalSigner) Contains

func (api *ExternalSigner) Contains(account accounts.Account) bool

func (*ExternalSigner) Derive

func (api *ExternalSigner) Derive(path accounts.DerivationPath, pin bool) (accounts.Account, error)

func (*ExternalSigner) Open

func (api *ExternalSigner) Open(passphrase string) error

func (*ExternalSigner) SelfDerive

func (api *ExternalSigner) SelfDerive(bases []accounts.DerivationPath, chain metrachain.ChainStateReader)

func (*ExternalSigner) SignData

func (api *ExternalSigner) SignData(account accounts.Account, mimeType string, data []byte) ([]byte, error)

SignData signs keccak256(data). The mimetype parameter describes the type of data being signed

func (*ExternalSigner) SignDataWithPassphrase

func (api *ExternalSigner) SignDataWithPassphrase(account accounts.Account, passphrase, mimeType string, data []byte) ([]byte, error)

func (*ExternalSigner) SignText

func (api *ExternalSigner) SignText(account accounts.Account, text []byte) ([]byte, error)

func (*ExternalSigner) SignTextWithPassphrase

func (api *ExternalSigner) SignTextWithPassphrase(account accounts.Account, passphrase string, text []byte) ([]byte, error)

func (*ExternalSigner) SignTx

func (api *ExternalSigner) SignTx(account accounts.Account, tx *types.Transaction, chainID *big.Int) (*types.Transaction, error)

SignTx sends the transaction to the external signer. If chainID is nil, or tx.ChainID is zero, the chain ID will be assigned by the external signer. For non-legacy transactions, the chain ID of the transaction overrides the chainID parameter.

func (*ExternalSigner) SignTxWithPassphrase

func (api *ExternalSigner) SignTxWithPassphrase(account accounts.Account, passphrase string, tx *types.Transaction, chainID *big.Int) (*types.Transaction, error)

func (*ExternalSigner) Status

func (api *ExternalSigner) Status() (string, error)

func (*ExternalSigner) URL

func (api *ExternalSigner) URL() accounts.URL