client

Documentation

Index

• Constants
• Variables
• func BufferStdin() *bufio.Reader
• func ConfigCmd() *cobra.Command
• func GetCheckPassword(prompt, prompt2 string, buf *bufio.Reader) (string, error)
• func GetCommands(cmds ...*cobra.Command) []*cobra.Command
• func GetConfirmation(prompt string, buf *bufio.Reader) (bool, error)
• func GetKeyBase(db dbm.DB) keys.Keybase
• func GetPassword(prompt string, buf *bufio.Reader) (pass string, err error)
• func GetSeed(prompt string, buf *bufio.Reader) (string, error)
• func GetString(prompt string, buf *bufio.Reader) (string, error)
• func MockKeyBase() keys.Keybase
• func PostCommands(cmds ...*cobra.Command) []*cobra.Command
• func PrintPrefixed(msg string)
• func ReadGasFlag(s string) (simulate bool, gas uint64, err error)
• type GasSetting
  • func (v *GasSetting) Set(s string) (err error)
  • func (v *GasSetting) String() string
  • func (v *GasSetting) Type() string
• type StdSignMsg
  • func (msg StdSignMsg) Bytes() []byte

Constants

const (
	// DefaultGasAdjustment is applied to gas estimates to avoid tx
	// execution failures due to state changes that might
	// occur between the tx simulation and the actual run.
	DefaultGasAdjustment = 1.0
	DefaultGasLimit      = 200000
	GasFlagSimulate      = "simulate"

	FlagUseLedger      = "ledger"
	FlagChainID        = "chain-id"
	FlagNode           = "node"
	FlagHeight         = "height"
	FlagGas            = "gas"
	FlagTrustNode      = "trust-node"
	FlagFrom           = "from"
	FlagFromAddr       = "from-addr"
	FlagAccountNumber  = "account-number"
	FlagSequence       = "sequence"
	FlagMemo           = "memo"
	FlagFee            = "fee"
	FlagAsync          = "async"
	FlagCommit         = "commit"
	FlagJson           = "json"
	FlagPrintResponse  = "print-response"
	FlagGenerateOnly   = "generate-only"
	FlagName           = "name"
	FlagIndentResponse = "indent"
	FlagDryRun         = "dry-run"
	FlagGasAdjustment  = "gas-adjustment"
)

nolint

const MinPassLength = 8

MinPassLength is the minimum acceptable password length

Variables

var (
	LineBreak  = &cobra.Command{Run: func(*cobra.Command, []string) {}}
	GasFlagVar = GasSetting{Gas: DefaultGasLimit}
)

LineBreak can be included in a command list to provide a blank line to help with readability

Functions

func BufferStdin

func BufferStdin() *bufio.Reader

BufferStdin is used to allow reading prompts for stdin multiple times, when we read from non-tty

func ConfigCmd

func ConfigCmd() *cobra.Command

ConfigCmd returns a CLI command to interactively create a IRISCLI config file.

func GetCheckPassword

func GetCheckPassword(prompt, prompt2 string, buf *bufio.Reader) (string, error)

GetCheckPassword will prompt for a password twice to verify they match (for creating a new password). It enforces the password length. Only parses password once if input is piped in.

func GetCommands

func GetCommands(cmds ...*cobra.Command) []*cobra.Command

GetCommands adds common flags to query commands

func GetConfirmation

func GetConfirmation(prompt string, buf *bufio.Reader) (bool, error)

GetConfirmation will request user give the confirmation from stdin. "y", "Y", "yes", "YES", and "Yes" all count as confirmations. If the input is not recognized, it will ask again.

func GetKeyBase

func GetKeyBase(db dbm.DB) keys.Keybase

GetKeyBase initializes a keybase based on the given db. The KeyBase manages all activity requiring access to a key.

func GetPassword

func GetPassword(prompt string, buf *bufio.Reader) (pass string, err error)

GetPassword will prompt for a password one-time (to sign a tx) It enforces the password length

func GetSeed

func GetSeed(prompt string, buf *bufio.Reader) (string, error)

GetSeed will request a seed phrase from stdin and trims off leading/trailing spaces

func GetString

func GetString(prompt string, buf *bufio.Reader) (string, error)

GetString simply returns the trimmed string output of a given reader.

func MockKeyBase

func MockKeyBase() keys.Keybase

MockKeyBase generates an in-memory keybase that will be discarded useful for --dry-run to generate a seed phrase without storing the key

func PostCommands

func PostCommands(cmds ...*cobra.Command) []*cobra.Command

PostCommands adds common flags for commands to post tx

func PrintPrefixed

func PrintPrefixed(msg string)

PrintPrefixed prints a string with > prefixed for use in prompts.

func ReadGasFlag

func ReadGasFlag(s string) (simulate bool, gas uint64, err error)

ParseGasFlag parses the value of the --gas flag.

Types

type GasSetting

type GasSetting struct {
	Simulate bool
	Gas      uint64
}

GasSetting encapsulates the possible values passed through the --gas flag.

func (*GasSetting) Set

func (v *GasSetting) Set(s string) (err error)

Set parses and sets the value of the --gas flag.

func (*GasSetting) String

func (v *GasSetting) String() string

func (*GasSetting) Type

func (v *GasSetting) Type() string

Type returns the flag's value type.

type StdSignMsg

type StdSignMsg struct {
	ChainID       string      `json:"chain_id"`
	AccountNumber uint64      `json:"account_number"`
	Sequence      uint64      `json:"sequence"`
	Fee           auth.StdFee `json:"fee"`
	Msgs          []sdk.Msg   `json:"msgs"`
	Memo          string      `json:"memo"`
}

StdSignMsg is a convenience structure for passing along a Msg with the other requirements for a StdSignDoc before it is signed. For use in the CLI.

func (StdSignMsg) Bytes

func (msg StdSignMsg) Bytes() []byte

get message bytes