hdwallet

Documentation

Index

• Variables
• func MustParseDerivationPath(path string) accounts.DerivationPath
• func NewEntropy(bits int) ([]byte, error)
• func NewMnemonic(bits int) (string, error)
• func NewMnemonicFromEntropy(entropy []byte) (string, error)
• func NewSeed() ([]byte, error)
• func NewSeedFromMnemonic(mnemonic string) ([]byte, error)
• func ParseDerivationPath(path string) (accounts.DerivationPath, error)
• type Wallet
  • func NewFromMnemonic(mnemonic string) (*Wallet, error)
  • func NewFromSeed(seed []byte) (*Wallet, error)
  • func (w *Wallet) Accounts() []accounts.Account
  • func (w *Wallet) Address(account accounts.Account) (common.Address, error)
  • func (w *Wallet) AddressBytes(account accounts.Account) ([]byte, error)
  • func (w *Wallet) AddressHex(account accounts.Account) (string, error)
  • func (w *Wallet) Close() error
  • func (w *Wallet) Contains(account accounts.Account) bool
  • func (w *Wallet) Derive(path accounts.DerivationPath, pin bool) (accounts.Account, error)
  • func (w *Wallet) Open(passphrase string) error
  • func (w *Wallet) Path(account accounts.Account) (string, error)
  • func (w *Wallet) PrivateKey(account accounts.Account) (*ecdsa.PrivateKey, error)
  • func (w *Wallet) PrivateKeyBytes(account accounts.Account) ([]byte, error)
  • func (w *Wallet) PrivateKeyHex(account accounts.Account) (string, error)
  • func (w *Wallet) PublicKey(account accounts.Account) (*ecdsa.PublicKey, error)
  • func (w *Wallet) PublicKeyBytes(account accounts.Account) ([]byte, error)
  • func (w *Wallet) PublicKeyHex(account accounts.Account) (string, error)
  • func (w *Wallet) SelfDerive(base []accounts.DerivationPath, chain ethereum.ChainStateReader)
  • func (w *Wallet) SetFixIssue172(fixIssue172 bool)
  • func (w *Wallet) SignData(account accounts.Account, mimeType string, data []byte) ([]byte, error)
  • func (w *Wallet) SignDataWithPassphrase(account accounts.Account, passphrase, mimeType string, data []byte) ([]byte, error)
  • func (w *Wallet) SignHash(account accounts.Account, hash []byte) ([]byte, error)
  • func (w *Wallet) SignHashWithPassphrase(account accounts.Account, passphrase string, hash []byte) ([]byte, error)
  • func (w *Wallet) SignText(account accounts.Account, text []byte) ([]byte, error)
  • func (w *Wallet) SignTextWithPassphrase(account accounts.Account, passphrase string, text []byte) ([]byte, error)
  • func (w *Wallet) SignTx(account accounts.Account, tx *types.Transaction, chainID *big.Int) (*types.Transaction, error)
  • func (w *Wallet) SignTxEIP155(account accounts.Account, tx *types.Transaction, chainID *big.Int) (*types.Transaction, error)
  • func (w *Wallet) SignTxWithPassphrase(account accounts.Account, passphrase string, tx *types.Transaction, ...) (*types.Transaction, error)
  • func (w *Wallet) Status() (string, error)
  • func (w *Wallet) URL() accounts.URL
  • func (w *Wallet) Unpin(account accounts.Account) error

Variables

var DefaultBaseDerivationPath = accounts.DefaultBaseDerivationPath

DefaultBaseDerivationPath is the base path from which custom derivation endpoints are incremented. As such, the first account will be at m/44'/60'/0'/0, the second at m/44'/60'/0'/1, etc

var DefaultRootDerivationPath = accounts.DefaultRootDerivationPath

DefaultRootDerivationPath is the root path to which custom derivation endpoints are appended. As such, the first account will be at m/44'/60'/0'/0, the second at m/44'/60'/0'/1, etc.

Functions

func MustParseDerivationPath

func MustParseDerivationPath(path string) accounts.DerivationPath

MustParseDerivationPath parses the derivation path in string format into []uint32 but will panic if it can't parse it.

func NewEntropy

func NewEntropy(bits int) ([]byte, error)

NewEntropy returns a randomly generated entropy.

func NewMnemonic

func NewMnemonic(bits int) (string, error)

NewMnemonic returns a randomly generated BIP-39 mnemonic using 128-256 bits of entropy.

func NewMnemonicFromEntropy

func NewMnemonicFromEntropy(entropy []byte) (string, error)

NewMnemonicFromEntropy returns a BIP-39 mnemonic from entropy.

func NewSeed

func NewSeed() ([]byte, error)

NewSeed returns a randomly generated BIP-39 seed.

func NewSeedFromMnemonic

func NewSeedFromMnemonic(mnemonic string) ([]byte, error)

NewSeedFromMnemonic returns a BIP-39 seed based on a BIP-39 mnemonic.

func ParseDerivationPath

func ParseDerivationPath(path string) (accounts.DerivationPath, error)

ParseDerivationPath parses the derivation path in string format into []uint32

Types

type Wallet

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

Wallet is the underlying wallet struct.

func NewFromMnemonic

func NewFromMnemonic(mnemonic string) (*Wallet, error)

NewFromMnemonic returns a new wallet from a BIP-39 mnemonic.

func NewFromSeed

func NewFromSeed(seed []byte) (*Wallet, error)

NewFromSeed returns a new wallet from a BIP-39 seed.

func (*Wallet) Accounts

func (w *Wallet) Accounts() []accounts.Account

Accounts implements accounts.Wallet, returning the list of accounts pinned to the wallet. If self-derivation was enabled, the account list is periodically expanded based on current chain state.

func (*Wallet) Address

func (w *Wallet) Address(account accounts.Account) (common.Address, error)

Address returns the address of the account.

func (*Wallet) AddressBytes

func (w *Wallet) AddressBytes(account accounts.Account) ([]byte, error)

AddressBytes returns the address in bytes format of the account.

func (*Wallet) AddressHex

func (w *Wallet) AddressHex(account accounts.Account) (string, error)

AddressHex returns the address in hex string format of the account.

func (*Wallet) Close

func (w *Wallet) Close() error

Close implements accounts.Wallet, however this does nothing since this is not a hardware device.

func (*Wallet) Contains

func (w *Wallet) Contains(account accounts.Account) bool

Contains implements accounts.Wallet, returning whether a particular account is or is not pinned into this wallet instance.

func (*Wallet) Derive

func (w *Wallet) Derive(path accounts.DerivationPath, pin bool) (accounts.Account, error)

Derive implements accounts.Wallet, deriving a new account at the specific derivation path. If pin is set to true, the account will be added to the list of tracked accounts.

func (*Wallet) Open

func (w *Wallet) Open(passphrase string) error

Open implements accounts.Wallet, however this does nothing since this is not a hardware device.

func (*Wallet) Path

func (w *Wallet) Path(account accounts.Account) (string, error)

Path return the derivation path of the account.

func (*Wallet) PrivateKey

func (w *Wallet) PrivateKey(account accounts.Account) (*ecdsa.PrivateKey, error)

PrivateKey returns the ECDSA private key of the account.

func (*Wallet) PrivateKeyBytes

func (w *Wallet) PrivateKeyBytes(account accounts.Account) ([]byte, error)

PrivateKeyBytes returns the ECDSA private key in bytes format of the account.

func (*Wallet) PrivateKeyHex

func (w *Wallet) PrivateKeyHex(account accounts.Account) (string, error)

PrivateKeyHex return the ECDSA private key in hex string format of the account.

func (*Wallet) PublicKey

func (w *Wallet) PublicKey(account accounts.Account) (*ecdsa.PublicKey, error)

PublicKey returns the ECDSA public key of the account.

func (*Wallet) PublicKeyBytes

func (w *Wallet) PublicKeyBytes(account accounts.Account) ([]byte, error)

PublicKeyBytes returns the ECDSA public key in bytes format of the account.

func (*Wallet) PublicKeyHex

func (w *Wallet) PublicKeyHex(account accounts.Account) (string, error)

PublicKeyHex return the ECDSA public key in hex string format of the account.

func (*Wallet) SelfDerive

func (w *Wallet) SelfDerive(base []accounts.DerivationPath, chain ethereum.ChainStateReader)

SelfDerive implements accounts.Wallet, trying to discover accounts that the user used previously (based on the chain state), but ones that he/she did not explicitly pin to the wallet manually. To avoid chain head monitoring, self derivation only runs during account listing (and even then throttled).

func (*Wallet) SetFixIssue172

func (w *Wallet) SetFixIssue172(fixIssue172 bool)

SetFixIssue172 determines whether the standard (correct) bip39 derivation path was used, or if derivation should be affected by Issue172 [0] which was how this library was originally implemented. [0] https://github.com/btcsuite/btcutil/pull/182/files

func (*Wallet) SignData

func (w *Wallet) SignData(account accounts.Account, mimeType string, data []byte) ([]byte, error)

SignData signs keccak256(data). The mimetype parameter describes the type of data being signed

func (*Wallet) SignDataWithPassphrase

func (w *Wallet) SignDataWithPassphrase(account accounts.Account, passphrase, mimeType string, data []byte) ([]byte, error)

SignDataWithPassphrase signs keccak256(data). The mimetype parameter describes the type of data being signed

func (*Wallet) SignHash

func (w *Wallet) SignHash(account accounts.Account, hash []byte) ([]byte, error)

SignHash implements accounts.Wallet, which allows signing arbitrary data.

func (*Wallet) SignHashWithPassphrase

func (w *Wallet) SignHashWithPassphrase(account accounts.Account, passphrase string, hash []byte) ([]byte, error)

SignHashWithPassphrase implements accounts.Wallet, attempting to sign the given hash with the given account using the passphrase as extra authentication.

func (*Wallet) SignText

func (w *Wallet) SignText(account accounts.Account, text []byte) ([]byte, error)

SignText requests the wallet to sign the hash of a given piece of data, prefixed the needed details via SignHashWithPassphrase, or by other means (e.g. unlock the account in a keystore).

func (*Wallet) SignTextWithPassphrase

func (w *Wallet) SignTextWithPassphrase(account accounts.Account, passphrase string, text []byte) ([]byte, error)

SignTextWithPassphrase implements accounts.Wallet, attempting to sign the given text (which is hashed) with the given account using passphrase as extra authentication.

func (*Wallet) SignTx

func (w *Wallet) SignTx(account accounts.Account, tx *types.Transaction, chainID *big.Int) (*types.Transaction, error)

SignTx implements accounts.Wallet, which allows the account to sign an Ethereum transaction.

func (*Wallet) SignTxEIP155

func (w *Wallet) SignTxEIP155(account accounts.Account, tx *types.Transaction, chainID *big.Int) (*types.Transaction, error)

SignTxEIP155 implements accounts.Wallet, which allows the account to sign an ERC-20 transaction.

func (*Wallet) SignTxWithPassphrase

func (w *Wallet) SignTxWithPassphrase(account accounts.Account, passphrase string, tx *types.Transaction, chainID *big.Int) (*types.Transaction, error)

SignTxWithPassphrase implements accounts.Wallet, attempting to sign the given transaction with the given account using passphrase as extra authentication.

func (*Wallet) Status

func (w *Wallet) Status() (string, error)

Status implements accounts.Wallet, returning a custom status message from the underlying vendor-specific hardware wallet implementation, however this does nothing since this is not a hardware device.

func (*Wallet) URL

func (w *Wallet) URL() accounts.URL

URL implements accounts.Wallet, returning the URL of the device that the wallet is on, however this does nothing since this is not a hardware device.

func (*Wallet) Unpin

func (w *Wallet) Unpin(account accounts.Account) error

Unpin unpins account from list of pinned accounts.