accounts

package

v0.0.0-...-404ccd1 Latest Latest Go to latest Published: Jun 30, 2020 License: Apache-2.0 Imports: 13 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/libonomy/wallet-cli

Documentation ¶

Overview ¶

Package accounts provides types for working with libonomy blockchain accounts

Index ¶

func LoadAllAccounts() error
type Account
- func NewAccount(passphrase string) (*Account, error)
- func NewAccountFromStore(accountID string, accountsDataPath string) (*Account, error)
type AccountData
type CryptoData
type Registry

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func LoadAllAccounts ¶

func LoadAllAccounts() error

LoadAllAccounts loads all account persisted to store

Types ¶

type Account ¶

type Account struct {
	PrivKey crypto.PrivateKey
	PubKey  crypto.PublicKey

	NetworkID int8
	// contains filtered or unexported fields
}

Account is an end user blockchain account

func NewAccount ¶

func NewAccount(passphrase string) (*Account, error)

NewAccount Creates a new account using the provided passphrase. Clients should persist newly created accounts - without this the account only lasts for one app session.

func NewAccountFromStore ¶

func NewAccountFromStore(accountID string, accountsDataPath string) (*Account, error)

NewAccountFromStore creates a new account by id and stored data. Account will be locked after creation as there's no persisted passphrase. accountsDataPath: os-specific full path to accounts data folder.

func (*Account) IsAccountLocked ¶

func (a *Account) IsAccountLocked() bool

IsAccountLocked returns true iff account is locked.

func (*Account) IsAccountUnlocked ¶

func (a *Account) IsAccountUnlocked() bool

IsAccountUnlocked returns true iff account is unlocked.

func (*Account) LockAccount ¶

func (a *Account) LockAccount(passphrase string)

LockAccount locks an account with user provided passphrase.

func (*Account) Log ¶

func (a *Account) Log()

Log account info

func (*Account) Persist ¶

func (a *Account) Persist(accountsDataPath string) (string, error)

Persist all account data to store Passphrases are never persisted to store accountsDataPath: os-specific full path to accounts data folder Returns full path of persisted file (useful for testing)

func (*Account) Pretty ¶

func (a *Account) Pretty() string

Pretty returns an account logging string

func (*Account) String ¶

func (a *Account) String() string

func (*Account) UnlockAccount ¶

func (a *Account) UnlockAccount(passphrase string) error

UnlockAccount unlocks an account using the user provided passphrase

type AccountData ¶

type AccountData struct {
	PublicKey  string          `json:"publicKey"`
	CryptoData CryptoData      `json:"crypto"`
	KDParams   crypto.KDParams `json:"kd"`
	NetworkID  int8            `json:"networkId"`
}

AccountData is used to persist an account.

type CryptoData ¶

type CryptoData struct {
	Cipher     string `json:"cipher"`
	CipherText string `json:"cipherText"` // encrypted private key
	CipherIv   string `json:"cipherIv"`
	Mac        string `json:"mac"`
}

CryptoData is the data use to encrypt/decrypt locally stored account data.

type Registry ¶

type Registry struct {
	All      map[string]*Account
	Unlocked map[string]*Account
}

Registry maintains a list of known locked and unlocked accounts.

var (
	// Accounts Registry app singleton
	Accounts *Registry
)

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL