utils

Documentation

Index

• func CalculateGas(queryFunc func(string, common.HexBytes) ([]byte, error), cdc *amino.Codec, ...) (estimate, adjusted uint64, err error)
• func CompleteAndBroadcastTxCLI(txBldr authtxb.TxBuilder, cliCtx context.CLIContext, msgs []sdk.Msg) error
• func EnrichWithGas(txBldr authtxb.TxBuilder, cliCtx context.CLIContext, msgs []sdk.Msg) (authtxb.TxBuilder, error)
• func GenerateOrBroadcastMsgs(cliCtx context.CLIContext, txBldr authtxb.TxBuilder, msgs []sdk.Msg, ...) error
• func GetTxEncoder(cdc *codec.Codec) (encoder sdk.TxEncoder)
• func PrepareTxBuilder(txBldr authtxb.TxBuilder, cliCtx context.CLIContext) (authtxb.TxBuilder, error)
• func PrintUnsignedStdTx(txBldr authtxb.TxBuilder, cliCtx context.CLIContext, msgs []sdk.Msg, ...) (err error)
• func ReadStdTxFromFile(cdc *amino.Codec, filename string) (stdTx auth.StdTx, err error)
• func SignStdTx(txBldr authtxb.TxBuilder, cliCtx context.CLIContext, name string, ...) (auth.StdTx, error)
• func SignStdTxWithSignerAddress(txBldr authtxb.TxBuilder, cliCtx context.CLIContext, addr sdk.AccAddress, ...) (signedStdTx auth.StdTx, err error)
• type GasEstimateResponse
  • func (gr GasEstimateResponse) String() string

Functions

func CalculateGas

func CalculateGas(queryFunc func(string, common.HexBytes) ([]byte, error),
	cdc *amino.Codec, txBytes []byte, adjustment float64) (estimate, adjusted uint64, err error)

CalculateGas simulates the execution of a transaction and returns both the estimate obtained by the query and the adjusted amount.

func CompleteAndBroadcastTxCLI

func CompleteAndBroadcastTxCLI(txBldr authtxb.TxBuilder, cliCtx context.CLIContext, msgs []sdk.Msg) error

CompleteAndBroadcastTxCLI implements a utility function that facilitates sending a series of messages in a signed transaction given a TxBuilder and a QueryContext. It ensures that the account exists, has a proper number and sequence set. In addition, it builds and signs a transaction with the supplied messages. Finally, it broadcasts the signed transaction to a node.

func EnrichWithGas

func EnrichWithGas(txBldr authtxb.TxBuilder, cliCtx context.CLIContext, msgs []sdk.Msg) (authtxb.TxBuilder, error)

EnrichWithGas calculates the gas estimate that would be consumed by the transaction and set the transaction's respective value accordingly.

func GenerateOrBroadcastMsgs

func GenerateOrBroadcastMsgs(cliCtx context.CLIContext, txBldr authtxb.TxBuilder, msgs []sdk.Msg, offline bool) error

GenerateOrBroadcastMsgs respects CLI flags and outputs a message

func GetTxEncoder

func GetTxEncoder(cdc *codec.Codec) (encoder sdk.TxEncoder)

GetTxEncoder return tx encoder from global sdk configuration if ones is defined. Otherwise returns encoder with default logic.

func PrepareTxBuilder

func PrepareTxBuilder(txBldr authtxb.TxBuilder, cliCtx context.CLIContext) (authtxb.TxBuilder, error)

PrepareTxBuilder populates a TxBuilder in preparation for the build of a Tx.

func PrintUnsignedStdTx

func PrintUnsignedStdTx(
	txBldr authtxb.TxBuilder, cliCtx context.CLIContext, msgs []sdk.Msg, offline bool,
) (err error)

PrintUnsignedStdTx builds an unsigned StdTx and prints it to os.Stdout. Don't perform online validation or lookups if offline is true.

func ReadStdTxFromFile

func ReadStdTxFromFile(cdc *amino.Codec, filename string) (stdTx auth.StdTx, err error)

Read and decode a StdTx from the given filename. Can pass "-" to read from stdin.

func SignStdTx

func SignStdTx(
	txBldr authtxb.TxBuilder, cliCtx context.CLIContext, name string,
	stdTx auth.StdTx, appendSig bool, offline bool,
) (auth.StdTx, error)

SignStdTx appends a signature to a StdTx and returns a copy of it. If appendSig is false, it replaces the signatures already attached with the new signature. Don't perform online validation or lookups if offline is true.

func SignStdTxWithSignerAddress

func SignStdTxWithSignerAddress(txBldr authtxb.TxBuilder, cliCtx context.CLIContext,
	addr sdk.AccAddress, name string, stdTx auth.StdTx,
	offline bool) (signedStdTx auth.StdTx, err error)

SignStdTxWithSignerAddress attaches a signature to a StdTx and returns a copy of a it. Don't perform online validation or lookups if offline is true, else populate account and sequence numbers from a foreign account.

Types

type GasEstimateResponse

type GasEstimateResponse struct {
	GasEstimate uint64 `json:"gas_estimate"`
}

GasEstimateResponse defines a response definition for tx gas estimation.

func (GasEstimateResponse) String

func (gr GasEstimateResponse) String() string