Before looking at
BaseApp, make sure to read the previous sections:
In this section you will discover how to define an application state machine and service router, how to create custom transaction processing, and how to create periodic processes that execute at the beginning or end of each block.
BaseApp is a boilerplate implementation of a Cosmos SDK application. This abstraction implements functionalities that every Cosmos application needs, starting with an implementation of the Tendermint Application Blockchain Interface (ABCI).
The Tendermint consensus is application agnostic. It establishes the canonical transaction list and sends confirmed transactions to Cosmos SDK applications for interpretation, and in turn receives transactions from Cosmos SDK applications and submits them to the validators for confirmation.
Applications that rely on the Tendermint consensus must implement concrete functions that support the ABCI interface.
BaseApp includes an implementation of ABCI so developers are not required to construct one.
ABCI itself includes methods such as
DeliverTx, which delivers a transaction. The interpretation of the transaction is an application-level responsibility. Since a typical application supports more than one type of transaction, interpretation implies the need for a service router that will send the transaction to different interpreters based on the transaction type.
BaseApp includes a service router implementation.
As well as an ABCI implementation,
BaseApp also provides a state machine implementation. The implementation of a state machine is an application-level concern because the Tendermint consensus is application-agnostic. The Cosmos SDK state machine implementation contains an overall state that is subdivided into various substates. Subdivisions include module states, persistent states, and transient states. These are all implemented in
BaseApp provides a secure interface between the application, the blockchain, and the state machine while defining as little as possible about the state machine.
Watch Julien Robert, Developer Relations Engineer for the Cosmos SDK, introduce BaseApp:
# Defining an application
Developers usually create a custom type for their application by referencing
BaseApp and declaring store keys, keepers, and a module manager, like this:
Extending the application with
BaseApp gives the former access to all the methods of
BaseApp. Developers compose their custom application with the modules they want, while not having to concern themselves with the hard work of implementing the ABCI, the service routers, and the state management logic.
# Type definition
BaseApp type holds many important parameters (opens new window) for any Cosmos SDK-based application.
Important parameters that are initialized during the bootstrapping of the application are:
CommitMultiStore: this is the main store of the application, which holds the canonical state that is committed at the end of each block. This store is not cached, meaning it is not used to update the application's volatile (un-committed) states.
CommitMultiStoreis a store of stores. Each module of the application uses one or multiple
KVStoresin the multistore to persist their subset of the state.
Database: the database is used by the
CommitMultiStoreto handle data persistence.
Msgservice router: the
msgServiceRouterfacilitates the routing of
sdk.Msgrequests to the appropriate module
Msgservice for processing.
sdk.Msghere refers to the transaction component that needs to be processed by a service to update the application state, and not to the ABCI message, which implements the interface between the application and the underlying consensus engine.
gRPC Query Router: the
grpcQueryRouterfacilitates the routing of gRPC queries to the appropriate module that will process them. These queries are not ABCI messages themselves. They are relayed to the relevant module's gRPC query service.
TxDecoder: this is used to decode raw transaction bytes relayed by the underlying Tendermint engine.
ParamStore: this is the parameter store used to get and set application consensus parameters.
AnteHandler: this is used to handle signature verification, fee payment, and other pre-message execution checks when a transaction is received. It is executed during
EndBlocker: these are the functions executed when the application receives the
EndBlockABCI messages from the underlying Tendermint engine.
# Volatile state
Parameters that define volatile states, cached states, include:
- checkState: this state is updated during
CheckTxand resets on
- deliverState: this state is updated during
DeliverTxand set to nil on
Commit. It gets re-initialized on
# Consensus parameters
Consensus parameters define the overall consensus state:
voteInfos: this parameter carries the list of validators whose pre-commit is missing, either because they did not vote or because the proposer did not include their vote. This information is carried by the context and can be used by the application for various things, like punishing absent validators.
minGasPrices: this parameter defines the minimum gas prices accepted by the node. This is a local parameter, meaning each full-node can set a different
minGasPrices. It is used in the
CheckTxmainly as a spam protection mechanism. The transaction enters the mempool only if the gas prices of the transaction are greater than one of the minimum gas prices in
minGasPrices == 1uatom,1photon, the gas price of the transaction must be greater than
1uatom OR 1photon.
appVersion: version of the application set in the application's constructor function.
Consider the following simple constructor:
BaseApp constructor function is pretty straightforward. Notice the possibility of providing additional
options to the
BaseApp, which executes them in order. These options are generally setter functions for important parameters, like
SetPruning() to set pruning options, or
SetMinGasPrices() to set the node's min-gas-prices.
Developers can add additional options based on their application's needs.
BaseApp provides three primary states. Two are volatile and one is persistent:
- The persistent main state is the canonical state of the application.
- The volatile states
deliverStateare used to handle transitions between main states during commits.
There is one single
CommitMultiStore, referred to as the main state or root state.
BaseApp derives the two volatile states using a mechanism called branching from this main state which is performed by the
InitChain state updates
The two volatile states
deliverState are set by branching the root
InitChain. Any subsequent reads and writes happen on branched versions of the
CommitMultiStore. All reads to the branched store are cached to avoid unnecessary roundtrips to the main state.
CheckTx state updates
checkState, which is based on the last committed state from the root store, is used for any reads and writes during
CheckTx. Here, you only execute the
AnteHandler and verify a service router exists for every message in the transaction.
Note that you branch the already branched
checkState when you execute the
AnteHandler. This has the side effect that if the
AnteHandler fails, the state transitions will not be reflected in the
checkState is only updated on success.
BeginBlock state updates
deliverState is set for use in subsequent
DeliverTx ABCI messages during
deliverState is based on the last committed state from the root store, and is branched.
deliverState is set to nil on
DeliverTx state updates
The state flow for
DeliverTx is nearly identical to
CheckTx, except state transitions occur on the
deliverState and messages in a transaction are executed. Similarly to
CheckTx, state transitions occur on a doubly branched state,
deliverState. Successful message execution results in writes being committed to
If message execution fails, state transitions from the
AnteHandler are persisted.
Commit state updates
All the state transitions that occurred in
deliverState are finally written during
Commit to the root
CommitMultiStore, which in turn is committed to disk and results in a new application root hash. These state transitions are now considered final. The
checkState is finally set to the newly committed state and
deliverState is set to nil to be reset on
ConsensusParams, which contains parameters related to block execution such as maximum gas and size in addition to evidence parameters. If these parameters are non-nil, they are set in the
ParamStore is managed behind the scenes by an
x/params module subspace. This allows the parameters to be tweaked via on-chain governance.
# Service routers
When messages and queries are received by the application, they must be routed as is appropriate to be processed. Routing is done via
BaseApp, which holds a
msgServiceRouter for messages and a
grpcQueryRouter for queries.
Msg service router
Are you looking for more information on
BaseApp? See the Cosmos SDK documentation (opens new window).
The main ABCI messages that
BaseApp implements are
CheckTx (opens new window) and
DeliverTx (opens new window).
Other ABCI message handlers being implemented are:
To summarize, this section has explored:
BaseApp, a boilerplate implementation of a Cosmos SDK application which provides core functionalities (such as ABCI) and a state machine implementation.
BaseAppdelivers a secure interface between application, blockchain, and state machine while defining the state machine as little as possible.
- How to begin defining an application by declaring store keys, keepers, and a module manager.
- The three primary states of
BaseApp(the persistent canonical main state of the application, and the two volatile states used to handle transitions during commits,
deliverState), as well as a variety of state updates used by applications.
- The use of service routers for handling messages and queries.