util

Documentation

Index

• Variables
• func AcceptablePassphrase(passphrase string) bool
• func BLSID(id uint64) *bls.ID
• func ConnectToBeaconNode(ctx context.Context, address string, timeout time.Duration, allowInsecure bool) (eth2client.Service, error)
• func GetBaseDir() string
• func GetOptionalPassphrase() (string, error)
• func GetPassphrase() (string, error)
• func GetPassphrases() []string
• func GetStorePassphrase() string
• func GetWalletPassphrase() string
• func InitLogging() error
• func LockAccount(ctx context.Context, account e2wtypes.Account) error
• func Network(ctx context.Context, eth2Client eth2client.Service) (string, error)
• func UnlockAccount(ctx context.Context, account e2wtypes.Account, passphrases []string) (bool, error)
• type DepositInfo
  • func DepositInfoFromJSON(input []byte) ([]*DepositInfo, error)
• type ScratchAccount
  • func NewScratchAccount(privKey []byte, pubKey []byte) (*ScratchAccount, error)
  • func (a *ScratchAccount) ID() uuid.UUID
  • func (a *ScratchAccount) IsUnlocked(ctx context.Context) (bool, error)
  • func (a *ScratchAccount) Lock(ctx context.Context) error
  • func (a *ScratchAccount) Name() string
  • func (a *ScratchAccount) Path() string
  • func (a *ScratchAccount) PublicKey() e2types.PublicKey
  • func (a *ScratchAccount) Sign(ctx context.Context, data []byte) (e2types.Signature, error)
  • func (a *ScratchAccount) Unlock(ctx context.Context, passphrase []byte) error
• type ValidatorExitData
  • func (d *ValidatorExitData) MarshalJSON() ([]byte, error)
  • func (d *ValidatorExitData) UnmarshalJSON(data []byte) error

Variables

var Log zerolog.Logger

Log is the ethdo global logger.

Functions

func AcceptablePassphrase

func AcceptablePassphrase(passphrase string) bool

AcceptablePassphrase returns true if the passphrase is acceptable.

func BLSID

func BLSID(id uint64) *bls.ID

BLSID turns a uint64 in to a BLS identifier.

func ConnectToBeaconNode

func ConnectToBeaconNode(ctx context.Context, address string, timeout time.Duration, allowInsecure bool) (eth2client.Service, error)

ConnectToBeaconNode connects to a beacon node at the given address.

func GetBaseDir

func GetBaseDir() string

GetBaseDir fetches the base directory for wallets.

func GetOptionalPassphrase

func GetOptionalPassphrase() (string, error)

GetOptionalPassphrase fetches the passphrase if supplied by the user.

func GetPassphrase

func GetPassphrase() (string, error)

GetPassphrase fetches the passphrase supplied by the user.

func GetPassphrases

func GetPassphrases() []string

GetPassphrases fetches the passphrases supplied by the user.

func GetStorePassphrase

func GetStorePassphrase() string

GetStorePassphrase fetches the store passphrase supplied by the user.

func GetWalletPassphrase

func GetWalletPassphrase() string

GetWalletPassphrase fetches the wallet passphrase supplied by the user.

func InitLogging

func InitLogging() error

InitLogging initialises logging.

func LockAccount

func LockAccount(ctx context.Context, account e2wtypes.Account) error

LockAccount attempts to lock an account.

func Network

func Network(ctx context.Context, eth2Client eth2client.Service) (string, error)

Network returns the name of the network., calculated from the deposit contract information. If not known, returns "Unknown".

func UnlockAccount

func UnlockAccount(ctx context.Context, account e2wtypes.Account, passphrases []string) (bool, error)

UnlockAccount attempts to unlock an account. It returns true if the account was already unlocked.

Types

type DepositInfo

type DepositInfo struct {
	Name                  string
	Account               string
	PublicKey             []byte
	WithdrawalCredentials []byte
	Signature             []byte
	DepositDataRoot       []byte
	DepositMessageRoot    []byte
	ForkVersion           []byte
	Amount                uint64
	Version               uint64
}

DepositInfo is a generic deposit structure.

func DepositInfoFromJSON

func DepositInfoFromJSON(input []byte) ([]*DepositInfo, error)

DepositInfoFromJSON obtains deposit info from various possibly formx of JSON.

type ScratchAccount

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

ScratchAccount is an account that exists temporarily.

func NewScratchAccount

func NewScratchAccount(privKey []byte, pubKey []byte) (*ScratchAccount, error)

NewScratchAccount creates a new local account.

func (*ScratchAccount) ID

func (a *ScratchAccount) ID() uuid.UUID

ID returns the account ID.

func (*ScratchAccount) IsUnlocked

func (a *ScratchAccount) IsUnlocked(ctx context.Context) (bool, error)

IsUnlocked returns true if the account is unlocked.

func (*ScratchAccount) Lock

func (a *ScratchAccount) Lock(ctx context.Context) error

Lock locks the account.

func (*ScratchAccount) Name

func (a *ScratchAccount) Name() string

Name returns the account name.

func (*ScratchAccount) Path

func (a *ScratchAccount) Path() string

Path returns the account path.

func (*ScratchAccount) PublicKey

func (a *ScratchAccount) PublicKey() e2types.PublicKey

PublicKey returns the account public key.

func (*ScratchAccount) Sign

func (a *ScratchAccount) Sign(ctx context.Context, data []byte) (e2types.Signature, error)

Sign signs data with the account's private key.

func (*ScratchAccount) Unlock

func (a *ScratchAccount) Unlock(ctx context.Context, passphrase []byte) error

Unlock unlocks the account.

type ValidatorExitData

type ValidatorExitData struct {
	Data        *spec.SignedVoluntaryExit
	ForkVersion spec.Version
}

ValidatorExitData contains data for a validator exit.

func (*ValidatorExitData) MarshalJSON

func (d *ValidatorExitData) MarshalJSON() ([]byte, error)

MarshalJSON implements custom JSON marshaller.

func (*ValidatorExitData) UnmarshalJSON

func (d *ValidatorExitData) UnmarshalJSON(data []byte) error

UnmarshalJSON implements custom JSON unmarshaller.