Documentation
¶
Index ¶
- Variables
- func GetFieldNameForKey(unknownKey Key) (string, error)
- func NewORM(db *sqlx.DB, lggr logger.Logger, cfg pg.QConfig) ksORM
- type CSA
- type DKGEncrypt
- type DKGSign
- type DefaultEVMChainIDFunc
- type Eth
- type Key
- type KeyNotFoundError
- type LegacyKeyStorage
- type Master
- type OCR
- type OCR2
- type P2P
- type Solana
- type StarkNet
- type VRF
Constants ¶
This section is empty.
Variables ¶
var ErrCSAKeyExists = errors.New("can only have 1 CSA key")
ErrCSAKeyExists describes the error when the CSA key already exists
var ErrLocked = errors.New("Keystore is locked")
var (
ErrMissingVRFKey = errors.New("unable to find VRF key")
)
var (
ErrNoP2PKey = errors.New("no p2p keys exist")
)
var (
ErrNoSolanaKey = errors.New("no solana keys exist")
)
var (
ErrNoStarkNetKey = errors.New("no starknet keys exist")
)
Functions ¶
func GetFieldNameForKey ¶ added in v1.10.0
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 DKGEncrypt ¶ added in v1.7.0
type DKGEncrypt interface { Get(id string) (dkgencryptkey.Key, error) GetAll() ([]dkgencryptkey.Key, error) Create() (dkgencryptkey.Key, error) Add(key dkgencryptkey.Key) error Delete(id string) (dkgencryptkey.Key, error) Import(keyJSON []byte, password string) (dkgencryptkey.Key, error) Export(id string, password string) ([]byte, error) EnsureKey() error }
DKGEncrypt provides encryption keys for the DKG.
type DKGSign ¶ added in v1.6.0
type DKGSign interface { Get(id string) (dkgsignkey.Key, error) GetAll() ([]dkgsignkey.Key, error) Create() (dkgsignkey.Key, error) Add(key dkgsignkey.Key) error Delete(id string) (dkgsignkey.Key, error) Import(keyJSON []byte, password string) (dkgsignkey.Key, error) Export(id string, password string) ([]byte, error) EnsureKey() error }
DKGSign provides signing keys for the DKG.
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(chainIDs ...*big.Int) (ethkey.KeyV2, error) Delete(id string) (ethkey.KeyV2, error) Import(keyJSON []byte, password string, chainIDs ...*big.Int) (ethkey.KeyV2, error) Export(id string, password string) ([]byte, error) Enable(address common.Address, chainID *big.Int, qopts ...pg.QOpt) error Disable(address common.Address, chainID *big.Int, qopts ...pg.QOpt) error Reset(address common.Address, chainID *big.Int, nonce int64, qopts ...pg.QOpt) error GetNextNonce(address common.Address, chainID *big.Int, qopts ...pg.QOpt) (int64, error) IncrementNextNonce(address common.Address, chainID *big.Int, currentNonce int64, qopts ...pg.QOpt) error EnsureKeys(chainIDs ...*big.Int) error SubscribeToKeyChanges() (ch chan struct{}, unsub func()) SignTx(fromAddress common.Address, tx *types.Transaction, chainID *big.Int) (*types.Transaction, error) EnabledKeysForChain(chainID *big.Int) (keys []ethkey.KeyV2, err error) GetRoundRobinAddress(chainID *big.Int, addresses ...common.Address) (address common.Address, err error) CheckEnabled(address common.Address, chainID *big.Int) error GetState(id string, chainID *big.Int) (ethkey.State, error) GetStatesForKeys([]ethkey.KeyV2) ([]ethkey.State, error) GetStatesForChain(chainID *big.Int) ([]ethkey.State, error) XXXTestingOnlySetState(ethkey.State) XXXTestingOnlyAdd(key ethkey.KeyV2) }
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 LegacyKeyStorage ¶ added in v1.13.0
type LegacyKeyStorage struct {
// contains filtered or unexported fields
}
func (*LegacyKeyStorage) StoreUnsupported ¶ added in v1.13.0
func (k *LegacyKeyStorage) StoreUnsupported(allRawKeysJson []byte, keyRing *keyRing) error
StoreUnsupported will store the raw keys that no longer have support in the node it will check if raw json contains keys that have not been added to the key ring and stores them internally
func (*LegacyKeyStorage) UnloadUnsupported ¶ added in v1.13.0
func (k *LegacyKeyStorage) UnloadUnsupported(supportedRawKeyRingJson []byte) ([]byte, error)
UnloadUnsupported will inject the unsupported keys into the raw key ring json
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 Sign(ctx context.Context, id string, msg []byte) (signature []byte, err error) }
type StarkNet ¶ added in v1.6.0
type StarkNet interface { Get(id string) (stark.Key, error) GetAll() ([]stark.Key, error) Create() (stark.Key, error) Add(key stark.Key) error Delete(id string) (stark.Key, error) Import(keyJSON []byte, password string) (stark.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) }