accounts

Documentation

Index

• func OpenSingleKeystore(path, pass string, pf PassPhraser) (*ecdsa.PrivateKey, error)
• type EthConfig
  • func (c *EthConfig) LoadKey() (*ecdsa.PrivateKey, error)
• type KeystoreConfig
• type MultiKeystore
  • func NewMultiKeystore(cfg *KeystoreConfig, pf PassPhraser) (*MultiKeystore, error)
  • func (m *MultiKeystore) Generate() (*ecdsa.PrivateKey, error)
  • func (m *MultiKeystore) GenerateWithPassword(pass string) (*ecdsa.PrivateKey, error)
  • func (m *MultiKeystore) GetDefault() (*ecdsa.PrivateKey, error)
  • func (m *MultiKeystore) GetDefaultAddress() (common.Address, error)
  • func (m *MultiKeystore) GetKeyByAddress(addr common.Address) (*ecdsa.PrivateKey, error)
  • func (m *MultiKeystore) GetKeyWithPass(addr common.Address, pass string) (*ecdsa.PrivateKey, error)
  • func (m *MultiKeystore) List() []accounts.Account
  • func (m *MultiKeystore) SetDefault(addr common.Address) error
• type PassPhraser
  • func NewInteractivePassPhraser() PassPhraser
  • func NewStaticPassPhraser(p string) PassPhraser

Functions

func OpenSingleKeystore

func OpenSingleKeystore(path, pass string, pf PassPhraser) (*ecdsa.PrivateKey, error)

Types

type EthConfig

type EthConfig struct {
	Passphrase string `required:"false" default:"" yaml:"pass_phrase"`
	Keystore   string `required:"false" default:"" yaml:"key_store"`
}

func (*EthConfig) LoadKey

func (c *EthConfig) LoadKey() (*ecdsa.PrivateKey, error)

type KeystoreConfig

type KeystoreConfig struct {
	KeyDir      string            `yaml:"key_store" required:"true"`
	PassPhrases map[string]string `yaml:"pass_phrases"`
}

type MultiKeystore

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

func NewMultiKeystore

func NewMultiKeystore(cfg *KeystoreConfig, pf PassPhraser) (*MultiKeystore, error)

func (*MultiKeystore) Generate

func (m *MultiKeystore) Generate() (*ecdsa.PrivateKey, error)

Generate creates new key into keystore

func (*MultiKeystore) GenerateWithPassword

func (m *MultiKeystore) GenerateWithPassword(pass string) (*ecdsa.PrivateKey, error)

GenerateWithPassword generates new key with given pass-phrase

func (*MultiKeystore) GetDefault

func (m *MultiKeystore) GetDefault() (*ecdsa.PrivateKey, error)

GetDefault returns default key for the keystore

func (*MultiKeystore) GetDefaultAddress

func (m *MultiKeystore) GetDefaultAddress() (common.Address, error)

func (*MultiKeystore) GetKeyByAddress

func (m *MultiKeystore) GetKeyByAddress(addr common.Address) (*ecdsa.PrivateKey, error)

GetKeyByAddress loads and decrypts key form keystore (if present)

func (*MultiKeystore) GetKeyWithPass

func (m *MultiKeystore) GetKeyWithPass(addr common.Address, pass string) (*ecdsa.PrivateKey, error)

func (*MultiKeystore) List

func (m *MultiKeystore) List() []accounts.Account

List returns list of accounts addresses into keystore

func (*MultiKeystore) SetDefault

func (m *MultiKeystore) SetDefault(addr common.Address) error

SetDefault marks key as default for keystore

type PassPhraser

type PassPhraser interface {
	GetPassPhrase() (string, error)
}

PassPhraser is interface for retrieving pass phrase for Eth keys

If you want to retrieve pass phrases reader different ways (e.g: from file, from env variables, interactively from terminal) you must implement PassPhraser reader a different way and pass it to KeyOpener instance

func NewInteractivePassPhraser

func NewInteractivePassPhraser() PassPhraser

NewInteractivePassPhraser implements PassPhraser that prompts user for pass-phrase and read it from terminal's Stdin

func NewStaticPassPhraser

func NewStaticPassPhraser(p string) PassPhraser

NewStaticPassPhraser inits pass phrase reader with pre-defined pass.