wallet

Documentation

Index

• Constants
• Variables
• func ClearAccounts(t *testing.T, walletPath string)
• func Filename(nickname string) string
• func GetWorkDir() (string, error)
• func Path() (string, error)
• type Wallet
  • func New(walletPath string) (*Wallet, error)
  • func (w *Wallet) AccountPath(nickname string) (string, error)
  • func (w *Wallet) AddAccount(acc *account.Account, persist bool, force bool) error
  • func (w *Wallet) AddressIsUnique(address *types.Address) error
  • func (w *Wallet) AllAccounts() []*account.Account
  • func (w *Wallet) DeleteAccount(nickname string) error
  • func (w *Wallet) Discover() error
  • func (w *Wallet) GenerateAccount(password *memguard.LockedBuffer, nickname string) (*account.Account, error)
  • func (w *Wallet) GetAccount(nickname string) (*account.Account, error)
  • func (w *Wallet) GetAccountCount() int
  • func (w *Wallet) GetAccountFromAddress(needle string) (*account.Account, error)
  • func (w *Wallet) Load(filePath string) (*account.Account, error)
  • func (w *Wallet) MigrateWallet() error
  • func (w *Wallet) NicknameIsUnique(nickname string) error
  • func (w *Wallet) Persist(acc account.Account) error

Constants

const (
	FileModeUserReadWriteOnly = 0o600
)

Variables

var (
	ErrAddressNotUnique  = errors.New("this account address already exists")
	ErrNicknameNotUnique = errors.New("this account nickname already exists")
)

var (
	ErrPersistingAccount = errors.New("error persisting account")
	AccountNotFoundError = errors.New("account not found")
)

var ErrUnmarshalAccount = errors.New("unmarshaling account")

Functions

func ClearAccounts

func ClearAccounts(t *testing.T, walletPath string)

func Filename

func Filename(nickname string) string

filename returns the wallet filename based on the given nickname.

func GetWorkDir

func GetWorkDir() (string, error)

func Path

func Path() (string, error)

Path returns the path where the account yaml file are stored.

Types

type Wallet

type Wallet struct {
	InvalidAccountNicknames []string // List of invalid account nicknames
	WalletPath              string
	// contains filtered or unexported fields
}

func New

func New(walletPath string) (*Wallet, error)

New creates a new wallet instance. If walletPath is empty, it will use the default wallet path.

func (*Wallet) AccountPath

func (w *Wallet) AccountPath(nickname string) (string, error)

func (*Wallet) AddAccount

func (w *Wallet) AddAccount(acc *account.Account, persist bool, force bool) error

Add an account into the wallet

func (*Wallet) AddressIsUnique

func (w *Wallet) AddressIsUnique(address *types.Address) error

func (*Wallet) AllAccounts

func (w *Wallet) AllAccounts() []*account.Account

func (*Wallet) DeleteAccount

func (w *Wallet) DeleteAccount(nickname string) error

Delete an account from the wallet

func (*Wallet) Discover

func (w *Wallet) Discover() error

func (*Wallet) GenerateAccount

func (w *Wallet) GenerateAccount(password *memguard.LockedBuffer, nickname string) (*account.Account, error)

GenerateAccount generates a new account and adds it to the wallet. It returns the generated account. It destroys the password.

func (*Wallet) GetAccount

func (w *Wallet) GetAccount(nickname string) (*account.Account, error)

Get an account from the wallet by nickname

func (*Wallet) GetAccountCount

func (w *Wallet) GetAccountCount() int

Get the number of accounts in the wallet

func (*Wallet) GetAccountFromAddress

func (w *Wallet) GetAccountFromAddress(needle string) (*account.Account, error)

func (*Wallet) Load

func (w *Wallet) Load(filePath string) (*account.Account, error)

func (*Wallet) MigrateWallet

func (w *Wallet) MigrateWallet() error

MigrateWallet moves the wallet from the old location (executable file) to the new one (user config).

func (*Wallet) NicknameIsUnique

func (w *Wallet) NicknameIsUnique(nickname string) error

func (*Wallet) Persist

func (w *Wallet) Persist(acc account.Account) error