Documentation
¶
Index ¶
Constants ¶
const IncorrectPasswordErrMsg = "checksum mismatch"
@NOTE(rgeraldes24): QRL Version - https://github.com/theQRL/go-zond-wallet-encryptor-keystore/blob/main/decrypt.go#L87 Eth Version - https://github.com/wealdtech/go-eth2-wallet-encryptor-keystorev4/blob/master/decrypt.go#L168 IncorrectPasswordErrMsg defines a common error string representing an EIP-2335 keystore password was incorrect. const IncorrectPasswordErrMsg = "invalid checksum"
const KeysReloaded = "Reloaded validator keys into keymanager"
KeysReloaded is a "key reloaded" message.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type AccountLister ¶
type AccountLister interface {
ListKeymanagerAccounts(ctx context.Context, cfg ListKeymanagerAccountConfig) error
}
type Deleter ¶
type Deleter interface {
DeleteKeystores(ctx context.Context, publicKeys [][]byte) ([]*zondpbservice.DeletedKeystoreStatus, error)
}
Deleter can delete keystores from the keymanager.
type IKeymanager ¶
type IKeymanager interface {
PublicKeysFetcher
Signer
KeyChangeSubscriber
KeyStoreExtractor
AccountLister
Deleter
}
IKeymanager defines a general keymanager interface for Qrysm wallets.
type Importer ¶
type Importer interface {
ImportKeystores(
ctx context.Context, keystores []*Keystore, passwords []string,
) ([]*zondpbservice.ImportedKeystoreStatus, error)
}
Importer can import new keystores into the keymanager.
type KeyChangeSubscriber ¶
type KeyChangeSubscriber interface {
SubscribeAccountChanges(pubKeysChan chan [][field_params.DilithiumPubkeyLength]byte) event.Subscription
}
KeyChangeSubscriber allows subscribing to changes made to the underlying keys.
type KeyStoreExtractor ¶
type KeyStoreExtractor interface {
ExtractKeystores(ctx context.Context, publicKeys []dilithium.PublicKey, password string) ([]*Keystore, error)
}
KeyStoreExtractor allows keys to be extracted from the keymanager.
type KeysFetcher ¶
type KeysFetcher interface {
FetchValidatingSeeds(ctx context.Context) ([][field_params.DilithiumSeedLength]byte, error)
PublicKeysFetcher
}
KeysFetcher for validating private and public keys.
type Keystore ¶
type Keystore struct {
Crypto map[string]interface{} `json:"crypto"`
ID string `json:"uuid"`
Pubkey string `json:"pubkey"`
Version uint `json:"version"`
Description string `json:"description"`
Path string `json:"path"`
}
Keystore json file representation as a Go struct.
type Kind ¶
type Kind int
Kind defines an enum for either local, derived, or remote-signing keystores for Qrysm wallets.
type PublicKeysFetcher ¶
type PublicKeysFetcher interface {
FetchValidatingPublicKeys(ctx context.Context) ([][field_params.DilithiumPubkeyLength]byte, error)
}
PublicKeysFetcher for validating public keys.
type Signer ¶
type Signer interface {
Sign(context.Context, *validatorpb.SignRequest) (dilithium.Signature, error)
}
Signer allows signing messages using a validator private key.
Directories
¶
| Path | Synopsis |
|---|---|
|
Package local defines an implementation of an on-disk, EIP-2335 keystore.json approach towards defining validator accounts in Qrysm.
|
Package local defines an implementation of an on-disk, EIP-2335 keystore.json approach towards defining validator accounts in Qrysm. |
|
v1
Package v1 defines mappings of types as defined by the web3signer official specification for its v1 version i.e.
|
Package v1 defines mappings of types as defined by the web3signer official specification for its v1 version i.e. |