| order | synopsis |
|---|---|
2 |
`Transactions` are objects created by end-users to trigger state changes in the application. |
- Anatomy of an SDK Application {prereq}
Transactions are comprised of metadata held in contexts and messages that trigger state changes within a module through the module's Handler.
When users want to interact with an application and make state changes (e.g. sending coins), they create transactions. Each of a transaction's messages must be signed using the private key associated with the appropriate account(s), before the transaction is broadcasted to the network. A transaction must then be included in a block, validated, and approved by the network through the consensus process. To read more about the lifecycle of a transaction, click here.
Transaction objects are SDK types that implement the Tx interface
It contains the following methods:
- GetMsgs: unwraps the transaction and returns a list of its message(s) - one transaction may have one or multiple messages, which are defined by module developers.
- ValidateBasic: includes lightweight, stateless checks used by ABCI messages
CheckTxandDeliverTxto make sure transactions are not invalid. For example, theauthmodule'sStdTxValidateBasicfunction checks that its transactions are signed by the correct number of signers and that the fees do not exceed what the user's maximum. Note that this function is to be distinct from theValidateBasicfunctions formessages, which perform basic validity checks on messages only. For example, whenrunTxis checking a transaction created from theauthmodule, it first runsValidateBasicon each message, then runs theauthmodule AnteHandler which callsValidateBasicfor the transaction itself. - TxEncoder: Nodes running the consensus engine (e.g. Tendermint Core) are responsible for gossiping transactions and ordering them into blocks, but only handle them in the generic
[]byteform. Transactions are always marshaled (encoded) before they are relayed to nodes, which compacts them to facilitate gossiping and helps maintain the consensus engine's separation from from application logic. The Cosmos SDK allows developers to specify any deterministic encoding format for their applications; the default is Amino. - TxDecoder: ABCI calls from the consensus engine to the application, such as
CheckTxandDeliverTx, are used to process transaction data to determine validity and state changes. Since transactions are passed in astxBytes []byte, they need to first be unmarshaled (decoded) usingTxDecoderbefore any logic is applied.
The most used implementation of the Tx interface is StdTx from the auth module. As a developer, using StdTx as your transaction format is as simple as importing the auth module in your application (which can be done in the constructor of the application)
A transaction is created by an end-user through one of the possible interfaces. In the process, two contexts and an array of messages are created, which are then used to generate the transaction itself. The actual state changes triggered by transactions are enabled by the handlers. The rest of the document will describe each of these components, in this order.
Application developers create entrypoints to the application by creating a command-line interface and/or REST interface, typically found in the application's ./cmd folder. These interfaces allow users to interact with the application through command-line or through HTTP requests.
For the command-line interface, module developers create subcommands to add as children to the application top-level transaction command TxCmd. For HTTP requests, module developers specify acceptable request types, register REST routes, and create HTTP Request Handlers.
When users interact with the application's interfaces, they invoke the underlying modules' handlers or command functions, directly creating messages.
Messages are module-specific objects that trigger state transitions within the scope of the module they belong to. Module developers define the messages for their module by implementing the Msg interface, and also define a Handler to process them.
Messages in a module are typically defined in a msgs.go file (though not always), and one handler with multiple functions to handle each of the module's messages is defined in a handler.go file.
Note: module messages are not to be confused with ABCI Messages which define interactions between the Tendermint and application layers.
To learn more about messages, click here.
While messages contain the information for state transition logic, a transaction's other metadata and relevant information are stored in the TxBuilder and CLIContext.
Transactions are first created by end-users through an appcli tx command through the command-line or a POST request to an HTTPS server. For details about transaction creation, click here.
Contexts are immutable objects that contain all the information needed to process a request. In the process of creating a transaction through the auth module (though it is not mandatory to create transactions this way), two contexts are created: the CLIContext and TxBuilder. Both are automatically generated and do not need to be defined by application developers, but do require input from the transaction creator (e.g. using flags through the CLI).
The TxBuilder contains data closely related with the processing of transactions.
TxEncoderdefined by the developer for this type of transaction. Used to encode messages before being processed by nodes running Tendermint.Keybasethat manages the user's keys and is used to perform signing operations.AccountNumberfrom which this transaction originated.Sequence, the number of transactions that the user has sent out, used to prevent replay attacks.Gasoption chosen by the users for how to calculate how much gas they will need to pay. A common option is "auto" which generates an automatic estimate.GasAdjustmentto adjust the estimate of gas by a scalar value, used to avoid underestimating the amount of gas required.SimulateAndExecuteoption to simply simulate the transaction execution without broadcasting.ChainIDrepresenting which blockchain this transaction pertains to.Memoto send with the transaction.Fees, the maximum amount the user is willing to pay in fees. Alternative to specifying gas prices.GasPrices, the amount per unit of gas the user is willing to pay in fees. Alternative to specifying fees.
The CLIContext is initialized using the application's codec and data more closely related to the user interaction with the interface, holding data such as the output to the user and the broadcast mode. Read more about CLIContext here.
Every message in a transaction must be signed by the addresses specified by GetSigners. The signing process must be handled by a module, and the most widely used one is the auth module. Signing is automatically performed when the transaction is created, unless the user choses to generate and sign separately. The TxBuilder (namely, the KeyBase) is used to perform the signing operations, and the CLIContext is used to broadcast transactions.
Since messages are module-specific types, each module needs a handler to process all of its message types and trigger state changes within the module's scope. This design puts more responsibility on module developers, allowing application developers to reuse common functionalities without having to implement state transition logic repetitively. To read more about handlers, click here.
Learn about the context {hide}