Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
View Source
var ErrCSAKeyExists = errors.New("can only have 1 CSA key")
ErrCSAKeyExists describes the error when the CSA key already exists
View Source
var ErrLocked = errors.New("Keystore is locked")
View Source
var (
ErrMissingVRFKey = errors.New("unable to find VRF key")
)
View Source
var (
ErrNoP2PKey = errors.New("no p2p keys exist")
)
View Source
var (
ErrNoSolanaKey = errors.New("no solana keys exist")
)
View Source
var (
ErrNoTerraKey = errors.New("no terra keys exist")
)
Functions ¶
Types ¶
type CSA ¶
type CSA interface {
Get(id string) (csakey.KeyV2, error)
GetAll() ([]csakey.KeyV2, error)
Create() (csakey.KeyV2, error)
Add(key csakey.KeyV2) error
Delete(id string) (csakey.KeyV2, error)
Import(keyJSON []byte, password string) (csakey.KeyV2, error)
Export(id string, password string) ([]byte, error)
EnsureKey() error
GetV1KeysAsV2() ([]csakey.KeyV2, error)
}
type CSAKeystoreInterface interface {
type DefaultEVMChainIDFunc ¶ added in v1.2.0
DefaultEVMChainIDFunc is a func for getting a default evm chain ID - necessary because it is lazily evaluated
type Eth ¶
type Eth interface {
Get(id string) (ethkey.KeyV2, error)
GetAll() ([]ethkey.KeyV2, error)
Create(chainID *big.Int) (ethkey.KeyV2, error)
Add(key ethkey.KeyV2, chainID *big.Int) error
Delete(id string) (ethkey.KeyV2, error)
Import(keyJSON []byte, password string, chainID *big.Int) (ethkey.KeyV2, error)
Export(id string, password string) ([]byte, error)
EnsureKeys(chainID *big.Int) error
SubscribeToKeyChanges() (ch chan struct{}, unsub func())
SignTx(fromAddress common.Address, tx *types.Transaction, chainID *big.Int) (*types.Transaction, error)
SendingKeys() (keys []ethkey.KeyV2, err error)
FundingKeys() (keys []ethkey.KeyV2, err error)
GetRoundRobinAddress(addresses ...common.Address) (address common.Address, err error)
GetState(id string) (ethkey.State, error)
SetState(ethkey.State) error
GetStatesForKeys([]ethkey.KeyV2) ([]ethkey.State, error)
GetStatesForChain(chainID *big.Int) ([]ethkey.State, error)
GetV1KeysAsV2(f DefaultEVMChainIDFunc) ([]ethkey.KeyV2, []ethkey.State, error)
}
Eth is the external interface for EthKeyStore
type KeyNotFoundError ¶ added in v1.1.0
KeyNotFoundError is returned when we don't find a requested key
func (KeyNotFoundError) Error ¶ added in v1.1.0
func (e KeyNotFoundError) Error() string
type Master ¶
type OCR ¶
type OCR interface {
Get(id string) (ocrkey.KeyV2, error)
GetAll() ([]ocrkey.KeyV2, error)
Create() (ocrkey.KeyV2, error)
Add(key ocrkey.KeyV2) error
Delete(id string) (ocrkey.KeyV2, error)
Import(keyJSON []byte, password string) (ocrkey.KeyV2, error)
Export(id string, password string) ([]byte, error)
EnsureKey() error
GetV1KeysAsV2() ([]ocrkey.KeyV2, error)
}
type OCR2 ¶ added in v1.2.0
type OCR2 interface {
Get(id string) (ocr2key.KeyBundle, error)
GetAll() ([]ocr2key.KeyBundle, error)
GetAllOfType(chaintype.ChainType) ([]ocr2key.KeyBundle, error)
Create(chaintype.ChainType) (ocr2key.KeyBundle, error)
Add(key ocr2key.KeyBundle) error
Delete(id string) error
Import(keyJSON []byte, password string) (ocr2key.KeyBundle, error)
Export(id string, password string) ([]byte, error)
EnsureKeys() error
}
type P2P ¶ added in v1.0.0
type P2P interface {
Get(id p2pkey.PeerID) (p2pkey.KeyV2, error)
GetAll() ([]p2pkey.KeyV2, error)
Create() (p2pkey.KeyV2, error)
Add(key p2pkey.KeyV2) error
Delete(id p2pkey.PeerID) (p2pkey.KeyV2, error)
Import(keyJSON []byte, password string) (p2pkey.KeyV2, error)
Export(id p2pkey.PeerID, password string) ([]byte, error)
EnsureKey() error
GetV1KeysAsV2() ([]p2pkey.KeyV2, error)
GetOrFirst(id p2pkey.PeerID) (p2pkey.KeyV2, error)
}
type Solana ¶ added in v1.2.0
type Solana interface {
Get(id string) (solkey.Key, error)
GetAll() ([]solkey.Key, error)
Create() (solkey.Key, error)
Add(key solkey.Key) error
Delete(id string) (solkey.Key, error)
Import(keyJSON []byte, password string) (solkey.Key, error)
Export(id string, password string) ([]byte, error)
EnsureKey() error
}
type Terra ¶ added in v1.2.0
type Terra interface {
Get(id string) (terrakey.Key, error)
GetAll() ([]terrakey.Key, error)
Create() (terrakey.Key, error)
Add(key terrakey.Key) error
Delete(id string) (terrakey.Key, error)
Import(keyJSON []byte, password string) (terrakey.Key, error)
Export(id string, password string) ([]byte, error)
EnsureKey() error
}
type VRF ¶
type VRF interface {
Get(id string) (vrfkey.KeyV2, error)
GetAll() ([]vrfkey.KeyV2, error)
Create() (vrfkey.KeyV2, error)
Add(key vrfkey.KeyV2) error
Delete(id string) (vrfkey.KeyV2, error)
Import(keyJSON []byte, password string) (vrfkey.KeyV2, error)
Export(id string, password string) ([]byte, error)
GenerateProof(id string, seed *big.Int) (vrfkey.Proof, error)
GetV1KeysAsV2(password string) ([]vrfkey.KeyV2, error)
}
Source Files
¶
Click to show internal directories.
Click to hide internal directories.