keys

Documentation

Index

• Constants
• func AddNewKeyRequestHandler(indent bool) http.HandlerFunc
• func CheckAndWriteErrorResponse(w http.ResponseWriter, httpErr int, err error) bool
• func Commands() *cobra.Command
• func DeleteKeyRequestHandler(w http.ResponseWriter, r *http.Request)
• func GetKeyInfo(name string) (keys.Info, error)
• func GetKeyRequestHandler(indent bool) http.HandlerFunc
• func GetPassphrase(name string) (string, error)
• func MarshalJSON(o interface{}) ([]byte, error)
• func NewInMemoryKeyBase() keys.Keybase
• func NewKeyBaseFromDir(rootDir string) (keys.Keybase, error)
• func NewKeyBaseFromHomeFlag() (keys.Keybase, error)
• func PostProcessResponse(w http.ResponseWriter, cdc *codec.Codec, response interface{}, indent bool)
• func QueryKeysRequestHandler(indent bool) http.HandlerFunc
• func ReadPassphraseFromStdin(name string) (string, error)
• func RecoverRequestHandler(indent bool) http.HandlerFunc
• func RegisterRoutes(r *mux.Router, indent bool)
• func SeedRequestHandler(w http.ResponseWriter, r *http.Request)
• func UnmarshalJSON(bz []byte, ptr interface{}) error
• func UpdateKeyRequestHandler(w http.ResponseWriter, r *http.Request)
• type AddNewKey
• type DeleteKeyBody
• type DeleteKeyReq
• type KeyOutput
  • func Bech32ConsKeyOutput(keyInfo keys.Info) (KeyOutput, error)
  • func Bech32KeyOutput(info keys.Info) (KeyOutput, error)
  • func Bech32KeysOutput(infos []keys.Info) ([]KeyOutput, error)
  • func Bech32ValKeyOutput(keyInfo keys.Info) (KeyOutput, error)
• type RecoverKey
• type UpdateKeyBody
• type 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"
)

const (
	OutputFormatText = "text"
	OutputFormatJSON = "json"
)

available output formats.

Functions

func AddNewKeyRequestHandler

func AddNewKeyRequestHandler(indent bool) http.HandlerFunc

add new key REST handler

func CheckAndWriteErrorResponse

func CheckAndWriteErrorResponse(w http.ResponseWriter, httpErr int, err error) bool

CheckAndWriteErrorResponse will check for errors and return a given error message when corresponding TODO: Move to utils/rest or similar

func Commands

func Commands() *cobra.Command

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

func DeleteKeyRequestHandler

func DeleteKeyRequestHandler(w http.ResponseWriter, r *http.Request)

delete key REST handler

func GetKeyInfo

func GetKeyInfo(name string) (keys.Info, error)

GetKeyInfo returns key info for a given name. An error is returned if the keybase cannot be retrieved or getting the info fails.

func GetKeyRequestHandler

func GetKeyRequestHandler(indent bool) http.HandlerFunc

get key REST handler

func GetPassphrase

func GetPassphrase(name string) (string, error)

GetPassphrase returns a passphrase for a given name. It will first retrieve the key info for that name if the type is local, it'll fetch input from STDIN. Otherwise, an empty passphrase is returned. An error is returned if the key info cannot be fetched or reading from STDIN fails.

func MarshalJSON

func MarshalJSON(o interface{}) ([]byte, error)

marshal keys

func NewInMemoryKeyBase

func NewInMemoryKeyBase() keys.Keybase

NewInMemoryKeyBase returns a storage-less keybase.

func NewKeyBaseFromDir

func NewKeyBaseFromDir(rootDir string) (keys.Keybase, error)

NewKeyBaseFromDir initializes a keybase at a particular dir.

func NewKeyBaseFromHomeFlag

func NewKeyBaseFromHomeFlag() (keys.Keybase, error)

NewKeyBaseFromHomeFlag initializes a Keybase based on the configuration.

func PostProcessResponse

func PostProcessResponse(w http.ResponseWriter, cdc *codec.Codec, response interface{}, indent bool)

PostProcessResponse performs post process for rest response

func QueryKeysRequestHandler

func QueryKeysRequestHandler(indent bool) http.HandlerFunc

query key list REST handler

func ReadPassphraseFromStdin

func ReadPassphraseFromStdin(name string) (string, error)

ReadPassphraseFromStdin attempts to read a passphrase from STDIN return an error upon failure.

func RecoverRequestHandler

func RecoverRequestHandler(indent bool) http.HandlerFunc

RecoverRequestHandler performs key recover request

func RegisterRoutes

func RegisterRoutes(r *mux.Router, indent bool)

resgister REST routes

func SeedRequestHandler

func SeedRequestHandler(w http.ResponseWriter, r *http.Request)

Seed REST request handler

func UnmarshalJSON

func UnmarshalJSON(bz []byte, ptr interface{}) error

unmarshal json

func UpdateKeyRequestHandler

func UpdateKeyRequestHandler(w http.ResponseWriter, r *http.Request)

update key REST handler

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

type DeleteKeyBody

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

delete key request REST body

type DeleteKeyReq

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

DeleteKeyReq requests deleting a key

type KeyOutput

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

used for outputting keys.Info over REST

func Bech32ConsKeyOutput

func Bech32ConsKeyOutput(keyInfo keys.Info) (KeyOutput, error)

Bech32ConsKeyOutput returns key output for a consensus node's key information.

func Bech32KeyOutput

func Bech32KeyOutput(info keys.Info) (KeyOutput, error)

create a KeyOutput in bech32 format

func Bech32KeysOutput

func Bech32KeysOutput(infos []keys.Info) ([]KeyOutput, error)

create a list of KeyOutput in bech32 format

func Bech32ValKeyOutput

func Bech32ValKeyOutput(keyInfo keys.Info) (KeyOutput, error)

Bech32ValKeyOutput returns key output for a validator's key information.

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"`
}

RecoverKeyBody recovers a key

type UpdateKeyBody

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

update key request REST body

type UpdateKeyReq

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

UpdateKeyReq requests updating a key