package cosmos.tx.v1beta1

Get desktop application:
View/edit binary Protocol Buffers messages

Service defines a gRPC service for interacting with transactions.

• rpc Simulate (SimulateRequest, SimulateResponse)

  service.proto:16

  Simulate simulates executing a transaction for estimating gas usage.

  message SimulateRequest

  service.proto:154

  SimulateRequest is the request type for the Service.Simulate RPC method.

  • optional Tx tx = 1

    tx is the transaction to simulate. Deprecated. Send raw tx bytes instead.

  • bytes tx_bytes = 2

    tx_bytes is the raw transaction. Since: cosmos-sdk 0.43

  message SimulateResponse

  service.proto:166

  SimulateResponse is the response type for the Service.SimulateRPC method.

  • optional base.abci.v1beta1.GasInfo gas_info = 1

    gas_info is the information about gas used in the simulation.

  • optional base.abci.v1beta1.Result result = 2

    result is the result of the simulation.

• rpc GetTx (GetTxRequest, GetTxResponse)

  service.proto:23

  GetTx fetches a tx by hash.

  message GetTxRequest

  service.proto:175

  GetTxRequest is the request type for the Service.GetTx RPC method.

  • string hash = 1

    hash is the tx hash to query, encoded as a hex string.

  message GetTxResponse

  service.proto:181

  GetTxResponse is the response type for the Service.GetTx method.

  • optional Tx tx = 1

    tx is the queried transaction.

  • optional base.abci.v1beta1.TxResponse tx_response = 2

    tx_response is the queried TxResponses.

• rpc BroadcastTx (BroadcastTxRequest, BroadcastTxResponse)

  service.proto:27

  BroadcastTx broadcast transaction.

  message BroadcastTxRequest

  service.proto:124

  BroadcastTxRequest is the request type for the Service.BroadcastTxRequest RPC method.

  • bytes tx_bytes = 1

    tx_bytes is the raw transaction.

  • BroadcastMode mode = 2

  message BroadcastTxResponse

  service.proto:147

  BroadcastTxResponse is the response type for the Service.BroadcastTx method.

  • optional base.abci.v1beta1.TxResponse tx_response = 1

    tx_response is the queried TxResponses.

• rpc GetTxsEvent (GetTxsEventRequest, GetTxsEventResponse)

  service.proto:34

  GetTxsEvent fetches txs by event.

  message GetTxsEventRequest

  service.proto:83

  GetTxsEventRequest is the request type for the Service.TxsByEvents RPC method.

  • repeated string events = 1

    events is the list of transaction event type.

  • optional base.query.v1beta1.PageRequest pagination = 2

    pagination defines a pagination for the request. Deprecated post v0.46.x: use page and limit instead.

  • OrderBy order_by = 3

  • uint64 page = 4

    page is the page number to query, starts at 1. If not provided, will default to first page.

  • uint64 limit = 5

    limit is the total number of results to be returned in the result page. If left empty it will default to a value to be set by each app.

  message GetTxsEventResponse

  service.proto:110

  GetTxsEventResponse is the response type for the Service.TxsByEvents RPC method.

  • repeated Tx txs = 1

    txs is the list of queried transactions.

  • repeated base.abci.v1beta1.TxResponse tx_responses = 2

    tx_responses is the list of queried TxResponses.

  • optional base.query.v1beta1.PageResponse pagination = 3

    pagination defines a pagination for the response. Deprecated post v0.46.x: use total instead.

  • uint64 total = 4

    total is total number of results available

• rpc GetBlockWithTxs (GetBlockWithTxsRequest, GetBlockWithTxsResponse)

  service.proto:40

  GetBlockWithTxs fetches a block with decoded txs. Since: cosmos-sdk 0.45.2

  message GetBlockWithTxsRequest

  service.proto:192

  GetBlockWithTxsRequest is the request type for the Service.GetBlockWithTxs RPC method. Since: cosmos-sdk 0.45.2

  • int64 height = 1

    height is the height of the block to query.

  • optional base.query.v1beta1.PageRequest pagination = 2

    pagination defines a pagination for the request.

  message GetBlockWithTxsResponse

  service.proto:202

  GetBlockWithTxsResponse is the response type for the Service.GetBlockWithTxs method. Since: cosmos-sdk 0.45.2

  • repeated Tx txs = 1

    txs are the transactions in the block.

  • optional tendermint.types.BlockID block_id = 2

  • optional tendermint.types.Block block = 3

  • optional base.query.v1beta1.PageResponse pagination = 4

    pagination defines a pagination for the response.

• rpc TxDecode (TxDecodeRequest, TxDecodeResponse)

  service.proto:46

  TxDecode decodes the transaction. Since: cosmos-sdk 0.47

  message TxDecodeRequest

  service.proto:215

  TxDecodeRequest is the request type for the Service.TxDecode RPC method. Since: cosmos-sdk 0.47

  • bytes tx_bytes = 1

    tx_bytes is the raw transaction.

  message TxDecodeResponse

  service.proto:224

  TxDecodeResponse is the response type for the Service.TxDecode method. Since: cosmos-sdk 0.47

  • optional Tx tx = 1

    tx is the decoded transaction.

• rpc TxEncode (TxEncodeRequest, TxEncodeResponse)

  service.proto:55

  TxEncode encodes the transaction. Since: cosmos-sdk 0.47

  message TxEncodeRequest

  service.proto:233

  TxEncodeRequest is the request type for the Service.TxEncode RPC method. Since: cosmos-sdk 0.47

  • optional Tx tx = 1

    tx is the transaction to encode.

  message TxEncodeResponse

  service.proto:242

  TxEncodeResponse is the response type for the Service.TxEncode method. Since: cosmos-sdk 0.47

  • bytes tx_bytes = 1

    tx_bytes is the encoded transaction bytes.

• rpc TxEncodeAmino (TxEncodeAminoRequest, TxEncodeAminoResponse)

  service.proto:64

  TxEncodeAmino encodes an Amino transaction from JSON to encoded bytes. Since: cosmos-sdk 0.47

  message TxEncodeAminoRequest

  service.proto:251

  TxEncodeAminoRequest is the request type for the Service.TxEncodeAmino RPC method. Since: cosmos-sdk 0.47

  • string amino_json = 1

  message TxEncodeAminoResponse

  service.proto:259

  TxEncodeAminoResponse is the response type for the Service.TxEncodeAmino RPC method. Since: cosmos-sdk 0.47

  • bytes amino_binary = 1

• rpc TxDecodeAmino (TxDecodeAminoRequest, TxDecodeAminoResponse)

  service.proto:73

  TxDecodeAmino decodes an Amino transaction from encoded bytes to JSON. Since: cosmos-sdk 0.47

  message TxDecodeAminoRequest

  service.proto:267

  TxDecodeAminoRequest is the request type for the Service.TxDecodeAmino RPC method. Since: cosmos-sdk 0.47

  • bytes amino_binary = 1

  message TxDecodeAminoResponse

  service.proto:275

  TxDecodeAminoResponse is the response type for the Service.TxDecodeAmino RPC method. Since: cosmos-sdk 0.47

  • string amino_json = 1

AuthInfo describes the fee and signer modes that are used to sign a transaction.

Used in: Tx

• repeated SignerInfo signer_infos = 1

  signer_infos defines the signing modes for the required signers. The number and order of elements must match the required signers from TxBody's messages. The first element is the primary signer and the one which pays the fee.

• optional Fee fee = 2

  Fee is the fee and gas limit for the transaction. The first signer is the primary signer and the one which pays the fee. The fee can be calculated based on the cost of evaluating the body and doing signature verification of the signers. This can be estimated via simulation.

• optional Tip tip = 3

  Tip is the optional tip used for transactions fees paid in another denom. This field is ignored if the chain didn't enable tips, i.e. didn't add the `TipDecorator` in its posthandler. Since: cosmos-sdk 0.46

AuxSignerData is the intermediary format that an auxiliary signer (e.g. a tipper) builds and sends to the fee payer (who will build and broadcast the actual tx). AuxSignerData is not a valid tx in itself, and will be rejected by the node if sent directly as-is. Since: cosmos-sdk 0.46

• string address = 1

  address is the bech32-encoded address of the auxiliary signer. If using AuxSignerData across different chains, the bech32 prefix of the target chain (where the final transaction is broadcasted) should be used.

• optional SignDocDirectAux sign_doc = 2

  sign_doc is the SIGN_MODE_DIRECT_AUX sign doc that the auxiliary signer signs. Note: we use the same sign doc even if we're signing with LEGACY_AMINO_JSON.

• signing.v1beta1.SignMode mode = 3

  mode is the signing mode of the single signer.

• bytes sig = 4

  sig is the signature of the sign doc.

BroadcastMode specifies the broadcast mode for the TxService.Broadcast RPC method.

Used in: BroadcastTxRequest

• BROADCAST_MODE_UNSPECIFIED = 0

  zero-value for mode ordering

• BROADCAST_MODE_BLOCK = 1

  DEPRECATED: use BROADCAST_MODE_SYNC instead, BROADCAST_MODE_BLOCK is not supported by the SDK from v0.47.x onwards.

• BROADCAST_MODE_SYNC = 2

  BROADCAST_MODE_SYNC defines a tx broadcasting mode where the client waits for a CheckTx execution response only.

• BROADCAST_MODE_ASYNC = 3

  BROADCAST_MODE_ASYNC defines a tx broadcasting mode where the client returns immediately.

Fee includes the amount of coins paid in fees and the maximum gas to be used by the transaction. The ratio yields an effective "gasprice", which must be above some miminum to be accepted into the mempool.

Used in: AuthInfo

• repeated base.v1beta1.Coin amount = 1

  amount is the amount of coins to be paid as a fee

• uint64 gas_limit = 2

  gas_limit is the maximum gas that can be used in transaction processing before an out of gas error occurs

• string payer = 3

  if unset, the first signer is responsible for paying the fees. If set, the specified account must pay the fees. the payer must be a tx signer (and thus have signed this field in AuthInfo). setting this field does *not* change the ordering of required signers for the transaction.

• string granter = 4

  if set, the fee payer (either the first signer or the value of the payer field) requests that a fee grant be used to pay fees instead of the fee payer's own balance. If an appropriate fee grant does not exist or the chain does not support fee grants, this will fail

ModeInfo describes the signing mode of a single or nested multisig signer.

Used in: ModeInfo.Multi, SignerInfo

• oneof sum

  sum is the oneof that specifies whether this represents a single or nested multisig signer

  • ModeInfo.Single single = 1

    single represents a single signer

  • ModeInfo.Multi multi = 2

    multi represents a nested multisig signer

Multi is the mode info for a multisig public key

Used in: ModeInfo

• optional crypto.multisig.v1beta1.CompactBitArray bitarray = 1

  bitarray specifies which keys within the multisig are signing

• repeated ModeInfo mode_infos = 2

  mode_infos is the corresponding modes of the signers of the multisig which could include nested multisig public keys

Single is the mode info for a single signer. It is structured as a message to allow for additional fields such as locale for SIGN_MODE_TEXTUAL in the future

Used in: ModeInfo

• signing.v1beta1.SignMode mode = 1

  mode is the signing mode of the single signer

OrderBy defines the sorting order

Used in: GetTxsEventRequest

• ORDER_BY_UNSPECIFIED = 0

  ORDER_BY_UNSPECIFIED specifies an unknown sorting order. OrderBy defaults to ASC in this case.

• ORDER_BY_ASC = 1

  ORDER_BY_ASC defines ascending order

• ORDER_BY_DESC = 2

  ORDER_BY_DESC defines descending order

SignDoc is the type used for generating sign bytes for SIGN_MODE_DIRECT.

• bytes body_bytes = 1

  body_bytes is protobuf serialization of a TxBody that matches the representation in TxRaw.

• bytes auth_info_bytes = 2

  auth_info_bytes is a protobuf serialization of an AuthInfo that matches the representation in TxRaw.

• string chain_id = 3

  chain_id is the unique identifier of the chain this transaction targets. It prevents signed transactions from being used on another chain by an attacker

• uint64 account_number = 4

  account_number is the account number of the account in state

SignDocDirectAux is the type used for generating sign bytes for SIGN_MODE_DIRECT_AUX. Since: cosmos-sdk 0.46

Used in: AuxSignerData

• bytes body_bytes = 1

  body_bytes is protobuf serialization of a TxBody that matches the representation in TxRaw.

• optional google.protobuf.Any public_key = 2

  public_key is the public key of the signing account.

• string chain_id = 3

  chain_id is the identifier of the chain this transaction targets. It prevents signed transactions from being used on another chain by an attacker.

• uint64 account_number = 4

  account_number is the account number of the account in state.

• uint64 sequence = 5

  sequence is the sequence number of the signing account.

• optional Tip tip = 6

  Tip is the optional tip used for transactions fees paid in another denom. It should be left empty if the signer is not the tipper for this transaction. This field is ignored if the chain didn't enable tips, i.e. didn't add the `TipDecorator` in its posthandler.

SignerInfo describes the public key and signing mode of a single top-level signer.

Used in: AuthInfo

• optional google.protobuf.Any public_key = 1

  public_key is the public key of the signer. It is optional for accounts that already exist in state. If unset, the verifier can use the required \ signer address for this position and lookup the public key.

• optional ModeInfo mode_info = 2

  mode_info describes the signing mode of the signer and is a nested structure to support nested multisig pubkey's

• uint64 sequence = 3

  sequence is the sequence of the account, which describes the number of committed transactions signed by a given address. It is used to prevent replay attacks.

Tip is the tip used for meta-transactions. Since: cosmos-sdk 0.46

Used in: AuthInfo, SignDocDirectAux

• repeated base.v1beta1.Coin amount = 1

  amount is the amount of the tip

• string tipper = 2

  tipper is the address of the account paying for the tip

Tx is the standard type used for broadcasting transactions.

Used in: GetBlockWithTxsResponse, GetTxResponse, GetTxsEventResponse, SimulateRequest, TxDecodeResponse, TxEncodeRequest

• optional TxBody body = 1

  body is the processable content of the transaction

• optional AuthInfo auth_info = 2

  auth_info is the authorization related content of the transaction, specifically signers, signer modes and fee

• repeated bytes signatures = 3

  signatures is a list of signatures that matches the length and order of AuthInfo's signer_infos to allow connecting signature meta information like public key and signing mode by position.

TxBody is the body of a transaction that all signers sign over.

Used in: Tx

• repeated google.protobuf.Any messages = 1

  messages is a list of messages to be executed. The required signers of those messages define the number and order of elements in AuthInfo's signer_infos and Tx's signatures. Each required signer address is added to the list only the first time it occurs. By convention, the first required signer (usually from the first message) is referred to as the primary signer and pays the fee for the whole transaction.

• string memo = 2

  memo is any arbitrary note/comment to be added to the transaction. WARNING: in clients, any publicly exposed text should not be called memo, but should be called `note` instead (see https://github.com/cosmos/cosmos-sdk/issues/9122).

• uint64 timeout_height = 3

  timeout is the block height after which this transaction will not be processed by the chain

• repeated google.protobuf.Any extension_options = 1023

  extension_options are arbitrary options that can be added by chains when the default options are not sufficient. If any of these are present and can't be handled, the transaction will be rejected

• repeated google.protobuf.Any non_critical_extension_options = 2047

  extension_options are arbitrary options that can be added by chains when the default options are not sufficient. If any of these are present and can't be handled, they will be ignored

TxRaw is a variant of Tx that pins the signer's exact binary representation of body and auth_info. This is used for signing, broadcasting and verification. The binary `serialize(tx: TxRaw)` is stored in Tendermint and the hash `sha256(serialize(tx: TxRaw))` becomes the "txhash", commonly used as the transaction ID.

• bytes body_bytes = 1

  body_bytes is a protobuf serialization of a TxBody that matches the representation in SignDoc.

• bytes auth_info_bytes = 2

  auth_info_bytes is a protobuf serialization of an AuthInfo that matches the representation in SignDoc.

• repeated bytes signatures = 3

  signatures is a list of signatures that matches the length and order of AuthInfo's signer_infos to allow connecting signature meta information like public key and signing mode by position.