client

Documentation

Index

• Variables
• func GetTxEncoder(cdc *codec.LegacyAmino) (encoder sdk.TxEncoder)
• func ParseQueryResponse(bz []byte) (sdk.SimulationResponse, error)
• func PrintUnsignedStdTx(txBldr tx.Factory, clientCtx client.Context, msgs []sdk.Msg) error
• func QueryTx(clientCtx client.Context, hashHexStr string) (*sdk.TxResponse, error)
• func QueryTxsByEvents(clientCtx client.Context, events []string, page, limit int, orderBy string) (*sdk.SearchTxsResult, error)
• func ReadTxFromFile(ctx client.Context, filename string) (tx sdk.Tx, err error)
• func SignTx(txFactory tx.Factory, clientCtx client.Context, name string, ...) error
• func SignTxWithSignerAddress(txFactory tx.Factory, clientCtx client.Context, addr sdk.AccAddress, ...) (err error)
• type BatchScanner
  • func NewBatchScanner(cfg client.TxConfig, r io.Reader) *BatchScanner
  • func (bs *BatchScanner) Scan() bool
  • func (bs BatchScanner) Tx() sdk.Tx
  • func (bs BatchScanner) UnmarshalErr() error
• type GasEstimateResponse
  • func (gr GasEstimateResponse) String() string

Variables

var Codec codec.Marshaler

Codec defines the x/auth account codec to be used for use with the AccountRetriever. The application must be sure to set this to their respective codec that implements the Codec interface and must be the same codec that passed to the x/auth module.

TODO:/XXX: Using a package-level global isn't ideal and we should consider refactoring the module manager to allow passing in the correct module codec.

Functions

func GetTxEncoder

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

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

func ParseQueryResponse

func ParseQueryResponse(bz []byte) (sdk.SimulationResponse, error)

func PrintUnsignedStdTx

func PrintUnsignedStdTx(txBldr tx.Factory, clientCtx client.Context, msgs []sdk.Msg) error

PrintUnsignedStdTx builds an unsigned StdTx and prints it to os.Stdout.

func QueryTx

func QueryTx(clientCtx client.Context, hashHexStr string) (*sdk.TxResponse, error)

QueryTx queries for a single transaction by a hash string in hex format. An error is returned if the transaction does not exist or cannot be queried.

func QueryTxsByEvents

func QueryTxsByEvents(clientCtx client.Context, events []string, page, limit int, orderBy string) (*sdk.SearchTxsResult, error)

QueryTxsByEvents performs a search for transactions for a given set of events via the Tendermint RPC. An event takes the form of: "{eventAttribute}.{attributeKey} = '{attributeValue}'". Each event is concatenated with an 'AND' operand. It returns a slice of Info object containing txs and metadata. An error is returned if the query fails. If an empty string is provided it will order txs by asc

func ReadTxFromFile

func ReadTxFromFile(ctx client.Context, filename string) (tx sdk.Tx, err error)

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

func SignTx

func SignTx(txFactory tx.Factory, clientCtx client.Context, name string, txBuilder client.TxBuilder, offline, overwriteSig bool) error

SignTx signs a transaction managed by the TxBuilder using a `name` key stored in Keybase. The new signature is appended to the TxBuilder when overwrite=false or overwritten otherwise. Don't perform online validation or lookups if offline is true.

func SignTxWithSignerAddress

func SignTxWithSignerAddress(txFactory tx.Factory, clientCtx client.Context, addr sdk.AccAddress,
	name string, txBuilder client.TxBuilder, offline, overwrite bool) (err error)

SignTxWithSignerAddress attaches a signature to a transaction. Don't perform online validation or lookups if offline is true, else populate account and sequence numbers from a foreign account. This function should only be used when signing with a multisig. For normal keys, please use SignTx directly.

Types

type BatchScanner

type BatchScanner struct {
	*bufio.Scanner
	// contains filtered or unexported fields
}

BatchScanner provides a convenient interface for reading batch data such as a file of newline-delimited JSON encoded StdTx.

func NewBatchScanner

func NewBatchScanner(cfg client.TxConfig, r io.Reader) *BatchScanner

NewBatchScanner returns a new BatchScanner to read newline-delimited StdTx transactions from r.

func (*BatchScanner) Scan

func (bs *BatchScanner) Scan() bool

Scan advances the Scanner to the next line.

func (BatchScanner) Tx

func (bs BatchScanner) Tx() sdk.Tx

Tx returns the most recent Tx unmarshalled by a call to Scan.

func (BatchScanner) UnmarshalErr

func (bs BatchScanner) UnmarshalErr() error

UnmarshalErr returns the first unmarshalling error that was encountered by the scanner.

type GasEstimateResponse

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

GasEstimateResponse defines a response definition for tx gas estimation.

func (GasEstimateResponse) String

func (gr GasEstimateResponse) String() string