import "github.com/cosmos/cosmos-sdk/client"
account_retriever.go broadcast.go cmd.go context.go grpc_query.go query.go test_helpers.go tx_config.go utils.go
const ClientContextKey = sdk.ContextKey("client.context")
ClientContextKey defines the context key used to retrieve a client.Context from a command's Context.
func CheckTendermintError(err error, txBytes []byte) *sdk.TxResponse
CheckTendermintError checks if the error returned from BroadcastTx is a Tendermint error that is returned before the tx is submitted due to precondition checks that failed. If an Tendermint error is detected, this function returns the correct code back in TxResponse.
TODO: Avoid brittle string matching in favor of error matching. This requires a change to Tendermint's RPCError type to allow retrieval or matching against a concrete error type.
func GetFromFields(kr keyring.Keyring, from string, genOnly bool) (sdk.AccAddress, string, keyring.KeyType, error)
GetFromFields returns a from account address, account name and keyring type, given either an address or key name. If genOnly is true, only a valid Bech32 cosmos address is returned.
Paginate returns the correct starting and ending index for a paginated query, given that client provides a desired page and limit of objects and the handler provides the total number of objects. The start page is assumed to be 1-indexed. If the start page is invalid, non-positive values are returned signaling the request is invalid; it returns non-positive values if limit is non-positive and defLimit is negative.
ReadPageRequest reads and builds the necessary page request flags for pagination.
SetCmdClientContext sets a command's Context value to the provided argument.
SetCmdClientContextHandler is to be used in a command pre-hook execution to read flags that populate a Context and sets that to the command's Context.
func TxServiceBroadcast(grpcCtx context.Context, clientCtx Context, req *tx.BroadcastTxRequest) (*tx.BroadcastTxResponse, error)
TxServiceBroadcast is a helper function to broadcast a Tx with the correct gRPC types from the tx service. Calls `clientCtx.BroadcastTx` under the hood.
ValidateCmd returns unknown command error or Help display if help flag set
type Account interface {
GetAddress() sdk.AccAddress
GetPubKey() cryptotypes.PubKey // can return nil.
GetAccountNumber() uint64
GetSequence() uint64
}Account defines a read-only version of the auth module's AccountI.
type AccountRetriever interface {
GetAccount(clientCtx Context, addr sdk.AccAddress) (Account, error)
GetAccountWithHeight(clientCtx Context, addr sdk.AccAddress) (Account, int64, error)
EnsureExists(clientCtx Context, addr sdk.AccAddress) error
GetAccountNumberSequence(clientCtx Context, addr sdk.AccAddress) (accNum uint64, accSeq uint64, err error)
}AccountRetriever defines the interfaces required by transactions to ensure an account exists and to be able to query for account fields necessary for signing.
type Context struct {
FromAddress sdk.AccAddress
Client rpcclient.Client
ChainID string
JSONMarshaler codec.JSONMarshaler
InterfaceRegistry codectypes.InterfaceRegistry
Input io.Reader
Keyring keyring.Keyring
Output io.Writer
OutputFormat string
Height int64
HomeDir string
KeyringDir string
From string
BroadcastMode string
FromName string
SignModeStr string
UseLedger bool
Simulate bool
GenerateOnly bool
Offline bool
SkipConfirm bool
TxConfig TxConfig
AccountRetriever AccountRetriever
NodeURI string
// TODO: Deprecated (remove).
LegacyAmino *codec.LegacyAmino
}Context implements a typical context created in SDK modules for transaction handling and queries.
GetClientContextFromCmd returns a Context from a command or an empty Context if it has not been set.
GetClientQueryContext returns a Context from a command with fields set based on flags defined in AddQueryFlagsToCmd. An error is returned if any flag query fails.
- client.Context field not pre-populated & flag not set: uses default flag value - client.Context field not pre-populated & flag set: uses set flag value - client.Context field pre-populated & flag not set: uses pre-populated value - client.Context field pre-populated & flag set: uses set flag value
GetClientTxContext returns a Context from a command with fields set based on flags defined in AddTxFlagsToCmd. An error is returned if any flag query fails.
- client.Context field not pre-populated & flag not set: uses default flag value - client.Context field not pre-populated & flag set: uses set flag value - client.Context field pre-populated & flag not set: uses pre-populated value - client.Context field pre-populated & flag set: uses set flag value
ReadPersistentCommandFlags returns a Context with fields set for "persistent" or common flags that do not necessarily change with context.
Note, the provided clientCtx may have field pre-populated. The following order of precedence occurs:
- client.Context field not pre-populated & flag not set: uses default flag value - client.Context field not pre-populated & flag set: uses set flag value - client.Context field pre-populated & flag not set: uses pre-populated value - client.Context field pre-populated & flag set: uses set flag value
BroadcastTx broadcasts a transactions either synchronously or asynchronously based on the context parameters. The result of the broadcast is parsed into an intermediate structure which is logged if the context has a logger defined.
BroadcastTxAsync broadcasts transaction bytes to a Tendermint node asynchronously (i.e. returns immediately).
BroadcastTxCommit broadcasts transaction bytes to a Tendermint node and waits for a commit. An error is only returned if there is no RPC node connection or if broadcasting fails.
NOTE: This should ideally not be used as the request may timeout but the tx may still be included in a block. Use BroadcastTxAsync or BroadcastTxSync instead.
BroadcastTxSync broadcasts transaction bytes to a Tendermint node synchronously (i.e. returns after CheckTx execution).
func (ctx Context) GetFromAddress() sdk.AccAddress
GetFromAddress returns the from address from the context's name.
GetFromName returns the key name for the current context.
GetNode returns an RPC client. If the context's client is not defined, an error is returned.
func (ctx Context) Invoke(grpcCtx gocontext.Context, method string, args, reply interface{}, opts ...grpc.CallOption) (err error)
Invoke implements the grpc ClientConn.Invoke method
func (Context) NewStream(gocontext.Context, *grpc.StreamDesc, string, ...grpc.CallOption) (grpc.ClientStream, error)
NewStream implements the grpc ClientConn.NewStream method
PrintBytes prints the raw bytes to ctx.Output if it's defined, otherwise to os.Stdout. NOTE: for printing a complex state object, you should use ctx.PrintOutput
PrintObjectLegacy is a variant of PrintProto that doesn't require a proto.Message type and uses amino JSON encoding. Deprecated: It will be removed in the near future!
PrintProto outputs toPrint to the ctx.Output based on ctx.OutputFormat which is either text or json. If text, toPrint will be YAML encoded. Otherwise, toPrint will be JSON encoded using ctx.JSONMarshaler. An error is returned upon failure.
PrintString prints the raw string to ctx.Output if it's defined, otherwise to os.Stdout
Query performs a query to a Tendermint node with the provided path. It returns the result and height of the query upon success or an error if the query fails.
func (ctx Context) QueryABCI(req abci.RequestQuery) (abci.ResponseQuery, error)
QueryABCI performs a query to a Tendermint node with the provide RequestQuery. It returns the ResultQuery obtained from the query.
QueryStore performs a query to a Tendermint node with the provided key and store name. It returns the result and height of the query upon success or an error if the query fails.
QueryWithData performs a query to a Tendermint node with the provided path and a data payload. It returns the result and height of the query upon success or an error if the query fails.
func (ctx Context) WithAccountRetriever(retriever AccountRetriever) Context
WithAccountRetriever returns the context with an updated AccountRetriever
WithBroadcastMode returns a copy of the context with an updated broadcast mode.
WithChainID returns a copy of the context with an updated chain ID.
WithClient returns a copy of the context with an updated RPC client instance.
WithFrom returns a copy of the context with an updated from address or name.
func (ctx Context) WithFromAddress(addr sdk.AccAddress) Context
WithFromAddress returns a copy of the context with an updated from account address.
WithFromName returns a copy of the context with an updated from account name.
WithGenerateOnly returns a copy of the context with updated GenerateOnly value
WithHeight returns a copy of the context with an updated height.
WithHomeDir returns a copy of the Context with HomeDir set.
WithInput returns a copy of the context with an updated input.
func (ctx Context) WithInterfaceRegistry(interfaceRegistry codectypes.InterfaceRegistry) Context
WithInterfaceRegistry returns the context with an updated InterfaceRegistry
func (ctx Context) WithJSONMarshaler(m codec.JSONMarshaler) Context
WithJSONMarshaler returns a copy of the Context with an updated JSONMarshaler.
WithKeyring returns a copy of the context with an updated keyring.
WithKeyringDir returns a copy of the Context with KeyringDir set.
func (ctx Context) WithLegacyAmino(cdc *codec.LegacyAmino) Context
WithLegacyAmino returns a copy of the context with an updated LegacyAmino codec. TODO: Deprecated (remove).
WithNodeURI returns a copy of the context with an updated node URI.
WithOffline returns a copy of the context with updated Offline value.
WithOutput returns a copy of the context with an updated output writer (e.g. stdout).
WithOutputFormat returns a copy of the context with an updated OutputFormat field.
WithSignModeStr returns a copy of the context with an updated SignMode value.
WithSimulation returns a copy of the context with updated Simulate value
WithSkipConfirmation returns a copy of the context with an updated SkipConfirm value.
WithTxConfig returns the context with an updated TxConfig
WithUseLedger returns a copy of the context with an updated UseLedger flag.
type TestAccount struct {
Address sdk.AccAddress
Num uint64
Seq uint64
}TestAccount represents a client Account that can be used in unit tests
func (t TestAccount) GetAccountNumber() uint64
GetAccountNumber implements client Account.GetAccountNumber
func (t TestAccount) GetAddress() sdk.AccAddress
GetAddress implements client Account.GetAddress
func (t TestAccount) GetPubKey() cryptotypes.PubKey
GetPubKey implements client Account.GetPubKey
func (t TestAccount) GetSequence() uint64
GetSequence implements client Account.GetSequence
type TestAccountRetriever struct {
Accounts map[string]TestAccount
}TestAccountRetriever is an AccountRetriever that can be used in unit tests
func (t TestAccountRetriever) EnsureExists(_ Context, addr sdk.AccAddress) error
EnsureExists implements AccountRetriever.EnsureExists
func (t TestAccountRetriever) GetAccount(_ Context, addr sdk.AccAddress) (Account, error)
GetAccount implements AccountRetriever.GetAccount
func (t TestAccountRetriever) GetAccountNumberSequence(_ Context, addr sdk.AccAddress) (accNum uint64, accSeq uint64, err error)
GetAccountNumberSequence implements AccountRetriever.GetAccountNumberSequence
func (t TestAccountRetriever) GetAccountWithHeight(clientCtx Context, addr sdk.AccAddress) (Account, int64, error)
GetAccountWithHeight implements AccountRetriever.GetAccountWithHeight
type TxBuilder interface {
GetTx() signing.Tx
SetMsgs(msgs ...sdk.Msg) error
SetSignatures(signatures ...signingtypes.SignatureV2) error
SetMemo(memo string)
SetFeeAmount(amount sdk.Coins)
SetGasLimit(limit uint64)
SetTimeoutHeight(height uint64)
}TxBuilder defines an interface which an application-defined concrete transaction type must implement. Namely, it must be able to set messages, generate signatures, and provide canonical bytes to sign over. The transaction must also know how to encode itself.
type TxConfig interface {
TxEncodingConfig
NewTxBuilder() TxBuilder
WrapTxBuilder(sdk.Tx) (TxBuilder, error)
SignModeHandler() signing.SignModeHandler
}TxConfig defines an interface a client can utilize to generate an application-defined concrete transaction type. The type returned must implement TxBuilder.
type TxEncodingConfig interface {
TxEncoder() sdk.TxEncoder
TxDecoder() sdk.TxDecoder
TxJSONEncoder() sdk.TxEncoder
TxJSONDecoder() sdk.TxDecoder
MarshalSignatureJSON([]signingtypes.SignatureV2) ([]byte, error)
UnmarshalSignatureJSON([]byte) ([]signingtypes.SignatureV2, error)
}TxEncodingConfig defines an interface that contains transaction encoders and decoders
| Path | Synopsis |
|---|---|
| debug | |
| docs/statik | |
| flags | |
| grpc/reflection | Package reflection is a reverse proxy. |
| grpc/tmservice | Package tmservice is a reverse proxy. |
| input | |
| keys | |
| rest | |
| rpc | |
| tx |
Package client imports 40 packages (graph) and is imported by 457 packages. Updated 2021-01-18. Refresh now. Tools for package owners.