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
- 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 ( KeyDBName = "keys" OutputFormatText = "text" OutputFormatJSON = "json" )
KeyDBName is the directory under root where we store the keys
Variables ¶
This section is empty.
Functions ¶
func AddNewKeyRequestHandler ¶
func AddNewKeyRequestHandler(indent bool) http.HandlerFunc
add new key REST handler
func CheckAndWriteErrorResponse ¶ added in v0.31.0
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 ¶
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 ¶ added in v0.24.0
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 ¶ added in v0.24.0
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 NewInMemoryKeyBase ¶ added in v0.31.0
NewInMemoryKeyBase returns a storage-less keybase.
func NewKeyBaseFromDir ¶ added in v0.31.0
NewKeyBaseFromDir initializes a keybase at a particular dir.
func NewKeyBaseFromHomeFlag ¶ added in v0.31.0
NewKeyBaseFromHomeFlag initializes a Keybase based on the configuration.
func PostProcessResponse ¶ added in v0.25.0
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 ¶ added in v0.24.0
ReadPassphraseFromStdin attempts to read a passphrase from STDIN return an error upon failure.
func RecoverRequestHandler ¶ added in v0.25.0
func RecoverRequestHandler(indent bool) http.HandlerFunc
RecoverRequestHandler performs key recover request
func SeedRequestHandler ¶
func SeedRequestHandler(w http.ResponseWriter, r *http.Request)
Seed REST request handler
func UnmarshalJSON ¶ added in v0.16.0
unmarshal json
func UpdateKeyRequestHandler ¶
func UpdateKeyRequestHandler(w http.ResponseWriter, r *http.Request)
update key REST handler
Types ¶
type AddNewKey ¶ added in v0.31.0
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 ¶ added in v0.31.0
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 ¶ added in v0.25.0
Bech32ConsKeyOutput returns key output for a consensus node's key information.
func Bech32KeyOutput ¶ added in v0.19.0
create a KeyOutput in bech32 format
func Bech32KeysOutput ¶ added in v0.19.0
create a list of KeyOutput in bech32 format
type RecoverKey ¶ added in v0.31.0
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 ¶ added in v0.31.0
type UpdateKeyReq struct { OldPassword string `json:"old_password"` NewPassword string `json:"new_password"` }
UpdateKeyReq requests updating a key