accounts

Documentation

Overview

Package accounts is a generated GoMock package.

Index

• Variables
• func LoadKeys(keystore, passphrase string) (*ecdsa.PrivateKey, error)
• type EthConfig
  • func (c *EthConfig) LoadKey() (*ecdsa.PrivateKey, error)
• type Identity
  • func NewIdentity(keydir string) Identity
• type KeyOpener
  • func DefaultKeyOpener(p Printer, keyDir, passPhrase string) (KeyOpener, error)
  • func NewKeyOpener(keyDir string, pf PassPhraser) KeyOpener
• type KeyStorager
• type MockKeyOpener
  • func NewMockKeyOpener(ctrl *gomock.Controller) *MockKeyOpener
  • func (m *MockKeyOpener) EXPECT() *MockKeyOpenerMockRecorder
  • func (m *MockKeyOpener) GetKey() (*ecdsa.PrivateKey, error)
  • func (m *MockKeyOpener) GetPassPhraser() PassPhraser
  • func (m *MockKeyOpener) OpenKeystore() (bool, error)
• type MockKeyOpenerMockRecorder
  • func (mr *MockKeyOpenerMockRecorder) GetKey() *gomock.Call
  • func (mr *MockKeyOpenerMockRecorder) GetPassPhraser() *gomock.Call
  • func (mr *MockKeyOpenerMockRecorder) OpenKeystore() *gomock.Call
• type MockKeyStorager
  • func NewMockKeyStorager(ctrl *gomock.Controller) *MockKeyStorager
  • func (m *MockKeyStorager) EXPECT() *MockKeyStoragerMockRecorder
  • func (m *MockKeyStorager) KeyStore() string
  • func (m *MockKeyStorager) PassPhrase() string
• type MockKeyStoragerMockRecorder
  • func (mr *MockKeyStoragerMockRecorder) KeyStore() *gomock.Call
  • func (mr *MockKeyStoragerMockRecorder) PassPhrase() *gomock.Call
• type MockPassPhraser
  • func NewMockPassPhraser(ctrl *gomock.Controller) *MockPassPhraser
  • func (m *MockPassPhraser) EXPECT() *MockPassPhraserMockRecorder
  • func (m *MockPassPhraser) GetPassPhrase() (string, error)
• type MockPassPhraserMockRecorder
  • func (mr *MockPassPhraserMockRecorder) GetPassPhrase() *gomock.Call
• type MockPrinter
  • func NewMockPrinter(ctrl *gomock.Controller) *MockPrinter
  • func (m *MockPrinter) EXPECT() *MockPrinterMockRecorder
  • func (m *MockPrinter) Printf(format string, i ...interface{})
• type MockPrinterMockRecorder
  • func (mr *MockPrinterMockRecorder) Printf(format interface{}, i ...interface{}) *gomock.Call
• type PassPhraser
  • func NewInteractivePassPhraser() PassPhraser
  • func NewStaticPassPhraser(p string) PassPhraser
• type Printer
  • func NewFmtPrinter() Printer
  • func NewSilentPrinter() Printer

Variables

var (
	ErrWalletNoAccount = errors.New("Wallet does not have any account")
	ErrWalletNotOpen   = errors.New("Wallet is not open")
	ErrWalletIsEmpty   = errors.New("Keystore does not have any wallets")
)

Functions

func LoadKeys

func LoadKeys(keystore, passphrase string) (*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 Identity

type Identity interface {
	// GetPrivateKey return *ecdsa.PrivateKey, it include PublicKey and ethereum Address shortly
	GetPrivateKey() (*ecdsa.PrivateKey, error)

	// New creates new account in keystore.
	// Do not open created account.
	New(passphrase string) error

	// Open opens loaded account
	Open(passphrase string) error

	// Import imports existing account from given json and pass-phrase
	Import(json []byte, passphrase string) error

	// ImportECDSA imports existing account from given private key and pass-phrase
	ImportECDSA(key *ecdsa.PrivateKey, passphrase string) error
}

Identity interface uses for auth and detect all objects in network source implementation going to go-ethereum accounting its need to be storing wallets in one dir and opened it by passphrase

func NewIdentity

func NewIdentity(keydir string) Identity

NewIdentity creates new identity instance which operates given key storage dir

type KeyOpener

type KeyOpener interface {
	// GetPassPhraser return PassPhraser interface
	// that provides pass phrase for loaded keys
	GetPassPhraser() PassPhraser
	// OpenKeystore opens key storage.
	// bool param is true if keystore was not existed and was created
	OpenKeystore() (bool, error)
	// GetKey returns private key from opened storage
	GetKey() (*ecdsa.PrivateKey, error)
}

KeyOpener is interface for loading Eth keys

func DefaultKeyOpener

func DefaultKeyOpener(p Printer, keyDir, passPhrase string) (KeyOpener, error)

DefaultKeyOpener return KeyOpener configured for using with pre-defined pass-phrase or retrieve pass-phrase interactively

func NewKeyOpener

func NewKeyOpener(keyDir string, pf PassPhraser) KeyOpener

NewKeyOpener returns KeyOpener that able to open keys

type KeyStorager

type KeyStorager interface {
	// KeyStore returns path to key store
	KeyStore() string
	// PassPhrase returns passphrase for keystore
	PassPhrase() string
}

KeyStorager interface describe an item that must know something about a path to the keystore and a passphrase

type MockKeyOpener

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

MockKeyOpener is a mock of KeyOpener interface

func NewMockKeyOpener

func NewMockKeyOpener(ctrl *gomock.Controller) *MockKeyOpener

NewMockKeyOpener creates a new mock instance

func (*MockKeyOpener) EXPECT

func (m *MockKeyOpener) EXPECT() *MockKeyOpenerMockRecorder

EXPECT returns an object that allows the caller to indicate expected use

func (*MockKeyOpener) GetKey

func (m *MockKeyOpener) GetKey() (*ecdsa.PrivateKey, error)

GetKey mocks base method

func (*MockKeyOpener) GetPassPhraser

func (m *MockKeyOpener) GetPassPhraser() PassPhraser

GetPassPhraser mocks base method

func (*MockKeyOpener) OpenKeystore

func (m *MockKeyOpener) OpenKeystore() (bool, error)

OpenKeystore mocks base method

type MockKeyOpenerMockRecorder

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

MockKeyOpenerMockRecorder is the mock recorder for MockKeyOpener

func (*MockKeyOpenerMockRecorder) GetKey

func (mr *MockKeyOpenerMockRecorder) GetKey() *gomock.Call

GetKey indicates an expected call of GetKey

func (*MockKeyOpenerMockRecorder) GetPassPhraser

func (mr *MockKeyOpenerMockRecorder) GetPassPhraser() *gomock.Call

GetPassPhraser indicates an expected call of GetPassPhraser

func (*MockKeyOpenerMockRecorder) OpenKeystore

func (mr *MockKeyOpenerMockRecorder) OpenKeystore() *gomock.Call

OpenKeystore indicates an expected call of OpenKeystore

type MockKeyStorager

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

MockKeyStorager is a mock of KeyStorager interface

func NewMockKeyStorager

func NewMockKeyStorager(ctrl *gomock.Controller) *MockKeyStorager

NewMockKeyStorager creates a new mock instance

func (*MockKeyStorager) EXPECT

func (m *MockKeyStorager) EXPECT() *MockKeyStoragerMockRecorder

EXPECT returns an object that allows the caller to indicate expected use

func (*MockKeyStorager) KeyStore

func (m *MockKeyStorager) KeyStore() string

KeyStore mocks base method

func (*MockKeyStorager) PassPhrase

func (m *MockKeyStorager) PassPhrase() string

PassPhrase mocks base method

type MockKeyStoragerMockRecorder

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

MockKeyStoragerMockRecorder is the mock recorder for MockKeyStorager

func (*MockKeyStoragerMockRecorder) KeyStore

func (mr *MockKeyStoragerMockRecorder) KeyStore() *gomock.Call

KeyStore indicates an expected call of KeyStore

func (*MockKeyStoragerMockRecorder) PassPhrase

func (mr *MockKeyStoragerMockRecorder) PassPhrase() *gomock.Call

PassPhrase indicates an expected call of PassPhrase

type MockPassPhraser

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

MockPassPhraser is a mock of PassPhraser interface

func NewMockPassPhraser

func NewMockPassPhraser(ctrl *gomock.Controller) *MockPassPhraser

NewMockPassPhraser creates a new mock instance

func (*MockPassPhraser) EXPECT

func (m *MockPassPhraser) EXPECT() *MockPassPhraserMockRecorder

EXPECT returns an object that allows the caller to indicate expected use

func (*MockPassPhraser) GetPassPhrase

func (m *MockPassPhraser) GetPassPhrase() (string, error)

GetPassPhrase mocks base method

type MockPassPhraserMockRecorder

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

MockPassPhraserMockRecorder is the mock recorder for MockPassPhraser

func (*MockPassPhraserMockRecorder) GetPassPhrase

func (mr *MockPassPhraserMockRecorder) GetPassPhrase() *gomock.Call

GetPassPhrase indicates an expected call of GetPassPhrase

type MockPrinter

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

MockPrinter is a mock of Printer interface

func NewMockPrinter

func NewMockPrinter(ctrl *gomock.Controller) *MockPrinter

NewMockPrinter creates a new mock instance

func (*MockPrinter) EXPECT

func (m *MockPrinter) EXPECT() *MockPrinterMockRecorder

EXPECT returns an object that allows the caller to indicate expected use

func (*MockPrinter) Printf

func (m *MockPrinter) Printf(format string, i ...interface{})

Printf mocks base method

type MockPrinterMockRecorder

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

MockPrinterMockRecorder is the mock recorder for MockPrinter

func (*MockPrinterMockRecorder) Printf

func (mr *MockPrinterMockRecorder) Printf(format interface{}, i ...interface{}) *gomock.Call

Printf indicates an expected call of Printf

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

type Printer

type Printer interface {
	Printf(format string, i ...interface{})
}

Printer interface describe anything that can print something somehow on a something.

func NewFmtPrinter

func NewFmtPrinter() Printer

func NewSilentPrinter

func NewSilentPrinter() Printer

NewSilentPrinter returns new printer which can prints nothing