keys

Documentation

Index

• Constants
• func AddKeyCommand() *cobra.Command
• func Commands() *cobra.Command
• func DeleteKeyCommand() *cobra.Command
• func ExportKeyCommand() *cobra.Command
• func ImportKeyCommand() *cobra.Command
• func ImportKeyHexCommand() *cobra.Command
• func ListKeyTypesCmd() *cobra.Command
• func ListKeysCmd() *cobra.Command
• func MigrateCommand() *cobra.Command
• func MnemonicKeyCommand() *cobra.Command
• func ParseKeyStringCommand() *cobra.Command
• func RenameKeyCommand() *cobra.Command
• func ShowKeysCmd() *cobra.Command
• type AddNewKey
  • func NewAddNewKey(name, password, mnemonic string, account, index int) AddNewKey
• type DeleteKeyReq
  • func NewDeleteKeyReq(password string) DeleteKeyReq
• type KeyOutput
  • func MkAccKeyOutput(k *keyring.Record, addressCodec address.Codec) (KeyOutput, error)
  • func MkAccKeysOutput(records []*keyring.Record, addressCodec address.Codec) ([]KeyOutput, error)
  • func MkConsKeyOutput(k *keyring.Record, consensusAddressCodec address.Codec) (KeyOutput, error)
  • func MkValKeyOutput(k *keyring.Record, validatorAddressCodec address.Codec) (KeyOutput, error)
  • func NewKeyOutput(name string, keyType keyring.KeyType, addr []byte, pk cryptotypes.PubKey, ...) (KeyOutput, error)
• type RecoverKey
  • func NewRecoverKey(password, mnemonic string, account, index int) RecoverKey
• type UpdateKeyReq
  • func NewUpdateKeyReq(old, new string) UpdateKeyReq

Constants

const (
	// FlagAddress is the flag for the user's address on the command line.
	FlagAddress = "address"
	// FlagPublicKey represents the user's public key on the command line.
	FlagPublicKey = "pubkey"
	// FlagBechPrefix defines a desired Bech32 prefix encoding for a key.
	FlagBechPrefix = "bech"
	// FlagDevice indicates that the information should be shown in the device
	FlagDevice = "device"
)

const (

	// DefaultKeyPass contains the default key password for genesis transactions
	DefaultKeyPass = "12345678"
)

Functions

func AddKeyCommand

func AddKeyCommand() *cobra.Command

AddKeyCommand defines a keys command to add a generated or recovered private key to keybase.

func Commands

func Commands() *cobra.Command

Commands registers a sub-tree of commands to interact with local private key storage.

func DeleteKeyCommand

func DeleteKeyCommand() *cobra.Command

DeleteKeyCommand deletes a key from the key store.

func ExportKeyCommand

func ExportKeyCommand() *cobra.Command

ExportKeyCommand exports private keys from the key store.

func ImportKeyCommand

func ImportKeyCommand() *cobra.Command

ImportKeyCommand imports private keys from a keyfile.

func ImportKeyHexCommand

func ImportKeyHexCommand() *cobra.Command

func ListKeyTypesCmd

func ListKeyTypesCmd() *cobra.Command

ListKeyTypesCmd lists all key types.

func ListKeysCmd

func ListKeysCmd() *cobra.Command

ListKeysCmd lists all keys in the key store.

func MigrateCommand

func MigrateCommand() *cobra.Command

MigrateCommand migrates key information from legacy keybase to OS secret store.

func MnemonicKeyCommand

func MnemonicKeyCommand() *cobra.Command

MnemonicKeyCommand computes the bip39 memonic for input entropy.

func ParseKeyStringCommand

func ParseKeyStringCommand() *cobra.Command

ParseKeyStringCommand parses an address from hex to bech32 and vice versa.

func RenameKeyCommand

func RenameKeyCommand() *cobra.Command

RenameKeyCommand renames a key from the key store.

func ShowKeysCmd

func ShowKeysCmd() *cobra.Command

ShowKeysCmd shows key information for a given key name.

Types

type AddNewKey

type AddNewKey struct {
	Name     string `json:"name"`
	Password string `json:"password"`
	Mnemonic string `json:"mnemonic"`
	Account  int    `json:"account,string,omitempty"`
	Index    int    `json:"index,string,omitempty"`
}

AddNewKey request a new key

func NewAddNewKey

func NewAddNewKey(name, password, mnemonic string, account, index int) AddNewKey

NewAddNewKey constructs a new AddNewKey request structure.

type DeleteKeyReq

type DeleteKeyReq struct {
	Password string `json:"password"`
}

DeleteKeyReq requests deleting a key

func NewDeleteKeyReq

func NewDeleteKeyReq(password string) DeleteKeyReq

NewDeleteKeyReq constructs a new DeleteKeyReq structure.

type KeyOutput

type KeyOutput struct {
	Name     string `json:"name" yaml:"name"`
	Type     string `json:"type" yaml:"type"`
	Address  string `json:"address" yaml:"address"`
	PubKey   string `json:"pubkey" yaml:"pubkey"`
	Mnemonic string `json:"mnemonic,omitempty" yaml:"mnemonic"`
}

KeyOutput defines a structure wrapping around an Info object used for output functionality.

func MkAccKeyOutput

func MkAccKeyOutput(k *keyring.Record, addressCodec address.Codec) (KeyOutput, error)

MkAccKeyOutput create a KeyOutput in with "acc" Bech32 prefixes. If the public key is a multisig public key, then the threshold and constituent public keys will be added.

func MkAccKeysOutput

func MkAccKeysOutput(records []*keyring.Record, addressCodec address.Codec) ([]KeyOutput, error)

MkAccKeysOutput returns a slice of KeyOutput objects, each with the "acc" Bech32 prefixes, given a slice of Record objects. It returns an error if any call to MkKeyOutput fails.

func MkConsKeyOutput

func MkConsKeyOutput(k *keyring.Record, consensusAddressCodec address.Codec) (KeyOutput, error)

MkConsKeyOutput create a KeyOutput for consensus addresses.

func MkValKeyOutput

func MkValKeyOutput(k *keyring.Record, validatorAddressCodec address.Codec) (KeyOutput, error)

MkValKeyOutput create a KeyOutput for validator addresses.

func NewKeyOutput

func NewKeyOutput(name string, keyType keyring.KeyType, addr []byte, pk cryptotypes.PubKey, addressCodec address.Codec) (KeyOutput, error)

NewKeyOutput creates a default KeyOutput instance without Mnemonic, Threshold and PubKeys

type RecoverKey

type RecoverKey struct {
	Password string `json:"password"`
	Mnemonic string `json:"mnemonic"`
	Account  int    `json:"account,string,omitempty"`
	Index    int    `json:"index,string,omitempty"`
}

RecoverKey recovers a key

func NewRecoverKey

func NewRecoverKey(password, mnemonic string, account, index int) RecoverKey

NewRecoverKey constructs a new RecoverKey request structure.

type UpdateKeyReq

type UpdateKeyReq struct {
	OldPassword string `json:"old_password"`
	NewPassword string `json:"new_password"`
}

UpdateKeyReq requests updating a key

func NewUpdateKeyReq

func NewUpdateKeyReq(old, new string) UpdateKeyReq

NewUpdateKeyReq constructs a new UpdateKeyReq structure.