hd

Documentation

Index

• Constants
• Variables
• type Wallet
  • func NewWallet(context *core.WalletContext) *Wallet
  • func (wallet *Wallet) AccountByID(id uuid.UUID) (core.ValidatorAccount, error)
  • func (wallet *Wallet) AccountByPublicKey(pubKey string) (core.ValidatorAccount, error)
  • func (wallet *Wallet) Accounts() []core.ValidatorAccount
  • func (wallet *Wallet) AddValidatorAccount(account core.ValidatorAccount) error
  • func (wallet *Wallet) BuildValidatorAccount(indexPointer *int, key *core.MasterDerivableKey) (*wallets.HDAccount, error)
  • func (wallet *Wallet) CreateValidatorAccount(seed []byte, indexPointer *int) (core.ValidatorAccount, error)
  • func (wallet *Wallet) CreateValidatorAccountFromPrivateKey(privateKey []byte, indexPointer *int) (core.ValidatorAccount, error)
  • func (wallet *Wallet) DeleteAccountByPublicKey(pubKey string) error
  • func (wallet *Wallet) GetNextAccountIndex() int
  • func (wallet *Wallet) ID() uuid.UUID
  • func (wallet *Wallet) MarshalJSON() ([]byte, error)
  • func (wallet *Wallet) SetContext(ctx *core.WalletContext)
  • func (wallet *Wallet) Type() core.WalletType
  • func (wallet *Wallet) UnmarshalJSON(data []byte) error

Constants

const (
	BaseAccountPath   = "/%d"
	WithdrawalKeyPath = BaseAccountPath + "/0"
	ValidatorKeyPath  = WithdrawalKeyPath + "/0"
)

Default values according to https://github.com/ethereum/EIPs/blob/master/EIPS/eip-2334.md

Variables

var ErrAccountNotFound = errors.New("account not found")

ErrAccountNotFound is the error when account not found

Types

type Wallet

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

Wallet represents hierarchical deterministic wallet

func NewWallet

func NewWallet(context *core.WalletContext) *Wallet

NewWallet is the constructor of Wallet

func (*Wallet) AccountByID

func (wallet *Wallet) AccountByID(id uuid.UUID) (core.ValidatorAccount, error)

AccountByID provides a nd account from the wallet given its ID. This will error if the account is not found.

func (*Wallet) AccountByPublicKey

func (wallet *Wallet) AccountByPublicKey(pubKey string) (core.ValidatorAccount, error)

AccountByPublicKey provides a nd account from the wallet given its public key. This will error if the account is not found.

func (*Wallet) Accounts

func (wallet *Wallet) Accounts() []core.ValidatorAccount

Accounts provides all accounts in the wallet.

func (*Wallet) AddValidatorAccount

func (wallet *Wallet) AddValidatorAccount(account core.ValidatorAccount) error

AddValidatorAccount returns error

func (*Wallet) BuildValidatorAccount

func (wallet *Wallet) BuildValidatorAccount(indexPointer *int, key *core.MasterDerivableKey) (*wallets.HDAccount, error)

BuildValidatorAccount using pointer and constructed key, using seedless or seed modes

func (*Wallet) CreateValidatorAccount

func (wallet *Wallet) CreateValidatorAccount(seed []byte, indexPointer *int) (core.ValidatorAccount, error)

CreateValidatorAccount creates a new validation (validator) key pair in the wallet.

func (*Wallet) CreateValidatorAccountFromPrivateKey

func (wallet *Wallet) CreateValidatorAccountFromPrivateKey(privateKey []byte, indexPointer *int) (core.ValidatorAccount, error)

CreateValidatorAccountFromPrivateKey creates account having only private key

func (*Wallet) DeleteAccountByPublicKey

func (wallet *Wallet) DeleteAccountByPublicKey(pubKey string) error

DeleteAccountByPublicKey deletes account by the given public key

func (*Wallet) GetNextAccountIndex

func (wallet *Wallet) GetNextAccountIndex() int

GetNextAccountIndex provides next index to create account at.

func (*Wallet) ID

func (wallet *Wallet) ID() uuid.UUID

ID provides the ID for the wallet.

func (*Wallet) MarshalJSON

func (wallet *Wallet) MarshalJSON() ([]byte, error)

MarshalJSON is the custom JSON marshaler

func (*Wallet) SetContext

func (wallet *Wallet) SetContext(ctx *core.WalletContext)

SetContext is the context setter

func (*Wallet) Type

func (wallet *Wallet) Type() core.WalletType

Type provides the type of the wallet.

func (*Wallet) UnmarshalJSON

func (wallet *Wallet) UnmarshalJSON(data []byte) error

UnmarshalJSON is the custom JSON unmarshaler