keychain

Documentation

Index

• Constants
• Variables
• func New(opts ...Option) *keychain
• type GenerateKeyFromMnemonicOpts
  • func WithMnemonic(mnemonic string) GenerateKeyFromMnemonicOpts
  • func WithOverride() GenerateKeyFromMnemonicOpts
  • func WithPassword(password string) GenerateKeyFromMnemonicOpts
• type Keychain
• type Option
  • func WithKeyring(ring ri.Keyring) Option
  • func WithPath(path string) Option
  • func WithStore(st store.Store) Option

Constants

const PrivateKeyStoreKey = "key"

const PublicKeyStoreKey = "pub"

Variables

var (
	ErrKeyPairNotFound = errors.New("No key pair found in the local db.")
)

Functions

func New

func New(opts ...Option) *keychain

Types

type GenerateKeyFromMnemonicOpts

type GenerateKeyFromMnemonicOpts func(o *generateKeyFromMnemonicOpts)

func WithMnemonic

func WithMnemonic(mnemonic string) GenerateKeyFromMnemonicOpts

func WithOverride

func WithOverride() GenerateKeyFromMnemonicOpts

func WithPassword

func WithPassword(password string) GenerateKeyFromMnemonicOpts

type Keychain

type Keychain interface {
	GenerateKeyPair() (pub []byte, priv []byte, err error)
	GenerateKeyFromMnemonic(...GenerateKeyFromMnemonicOpts) (mnemonic string, err error)
	GetStoredKeyPairInLibP2PFormat() (crypto.PrivKey, crypto.PubKey, error)
	GetStoredPublicKey() (crypto.PubKey, error)
	GetStoredMnemonic() (string, error)
	GetManagedThreadKey(threadKeyName string) (thread.Key, error)
	GenerateKeyPairWithForce() (pub []byte, priv []byte, err error)
	Sign([]byte) ([]byte, error)
	ImportExistingKeyPair(priv crypto.PrivKey, mnemonic string) error
	DeleteKeypair() error
}

type Option

type Option func(o *keychainOptions)

func WithKeyring

func WithKeyring(ring ri.Keyring) Option

Used to inject a mock keyring in tests or in case you want to use a custom keyring implementation

func WithPath

func WithPath(path string) Option

Helper function for setting keychain file path for Windows/Linux

func WithStore

func WithStore(st store.Store) Option