keys

Documentation

Index

• type Info
  • func (i *Info) Format() Info
• type Infos
  • func (k Infos) Len() int
  • func (k Infos) Less(i, j int) bool
  • func (k Infos) Sort()
  • func (k Infos) Swap(i, j int)
• type Manager
• type Signable
• type Signer
• type Storage

Types

type Info

type Info struct {
	Name    string         `json:"name"`
	Address data.Bytes     `json:"address"`
	PubKey  crypto.PubKeyS `json:"pubkey"`
}

Info is the public information about a key

func (*Info) Format

func (i *Info) Format() Info

type Infos

type Infos []Info

Infos is a wrapper to allows alphabetical sorting of the keys

func (Infos) Len

func (k Infos) Len() int

func (Infos) Less

func (k Infos) Less(i, j int) bool

func (Infos) Sort

func (k Infos) Sort()

func (Infos) Swap

func (k Infos) Swap(i, j int)

type Manager

type Manager interface {
	Create(name, passphrase, algo string) (Info, error)
	List() (Infos, error)
	Get(name string) (Info, error)
	Update(name, oldpass, newpass string) error
	Delete(name, passphrase string) error
}

Manager allows simple CRUD on a keystore, as an aid to signing

type Signable

type Signable interface {
	// SignBytes is the immutable data, which needs to be signed
	SignBytes() []byte

	// Sign will add a signature and pubkey.
	//
	// Depending on the Signable, one may be able to call this multiple times for multisig
	// Returns error if called with invalid data or too many times
	Sign(pubkey crypto.PubKey, sig crypto.Signature) error

	// Signers will return the public key(s) that signed if the signature
	// is valid, or an error if there is any issue with the signature,
	// including if there are no signatures
	Signers() ([]crypto.PubKey, error)

	// TxBytes returns the transaction data as well as all signatures
	// It should return an error if Sign was never called
	TxBytes() ([]byte, error)
}

Signable represents any transaction we wish to send to tendermint core These methods allow us to sign arbitrary Tx with the KeyStore

type Signer

type Signer interface {
	Sign(name, passphrase string, tx Signable) error
}

Signer allows one to use a keystore to sign transactions

type Storage

type Storage interface {
	Put(name string, key []byte, info Info) error
	Get(name string) ([]byte, Info, error)
	List() (Infos, error)
	Delete(name string) error
}

Storage has many implementation, based on security and sharing requirements like disk-backed, mem-backed, vault, db, etc.