feat: Upgrade to CometBFT v1.x series (#24114)
Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com> Co-authored-by: Julián Toledano <JulianToledano@users.noreply.github.com> Co-authored-by: Julien Robert <julien@rbrt.fr> Co-authored-by: Tyler <48813565+technicallyty@users.noreply.github.com> Co-authored-by: Alex | Interchain Labs <alex@interchainlabs.io> Co-authored-by: Zachary Becker <zachary@interchainlabs.io>
This commit is contained in:
Fabiana Cecin
co-authored by
mergify[bot]
Julián Toledano
Julien Robert
Tyler
Alex | Interchain Labs
Zachary Becker
mergify[bot]
Julián Toledano
Julien Robert
Tyler
Alex | Interchain Labs
Zachary Becker
parent
b65dd23bad
commit
b71d0894f0
@@ -224,9 +224,9 @@ so that the service can group the state changes with the ABCI requests.
|
||||
// ABCIListener is the interface that we're exposing as a streaming service.
|
||||
type ABCIListener interface {
|
||||
// ListenFinalizeBlock updates the streaming service with the latest FinalizeBlock messages
|
||||
ListenFinalizeBlock(ctx context.Context, req abci.RequestFinalizeBlock, res abci.ResponseFinalizeBlock) error
|
||||
ListenFinalizeBlock(ctx context.Context, req abci.FinalizeBlockRequest, res abci.FinalizeBlockResponse) error
|
||||
// ListenCommit updates the steaming service with the latest Commit messages and state changes
|
||||
ListenCommit(ctx context.Context, res abci.ResponseCommit, changeSet []*StoreKVPair) error
|
||||
ListenCommit(ctx context.Context, res abci.CommitResponse, changeSet []*StoreKVPair) error
|
||||
}
|
||||
```
|
||||
|
||||
@@ -267,16 +267,16 @@ We will modify the `FinalizeBlock` and `Commit` methods to pass ABCI requests an
|
||||
to any streaming service hooks registered with the `BaseApp`.
|
||||
|
||||
```go
|
||||
func (app *BaseApp) FinalizeBlock(req abci.RequestFinalizeBlock) abci.ResponseFinalizeBlock {
|
||||
func (app *BaseApp) FinalizeBlock(req abci.FinalizeBlockRequest) abci.FinalizeBlockResponse {
|
||||
|
||||
var abciRes abci.ResponseFinalizeBlock
|
||||
var abciRes abci.FinalizeBlockResponse
|
||||
defer func() {
|
||||
// call the streaming service hook with the FinalizeBlock messages
|
||||
for _, abciListener := range app.abciListeners {
|
||||
ctx := app.finalizeState.ctx
|
||||
blockHeight := ctx.BlockHeight()
|
||||
if app.abciListenersAsync {
|
||||
go func(req abci.RequestFinalizeBlock, res abci.ResponseFinalizeBlock) {
|
||||
go func(req abci.FinalizeBlockRequest, res abci.FinalizeBlockResponse) {
|
||||
if err := app.abciListener.FinalizeBlock(blockHeight, req, res); err != nil {
|
||||
app.logger.Error("FinalizeBlock listening hook failed", "height", blockHeight, "err", err)
|
||||
}
|
||||
@@ -299,11 +299,11 @@ func (app *BaseApp) FinalizeBlock(req abci.RequestFinalizeBlock) abci.ResponseFi
|
||||
```
|
||||
|
||||
```go
|
||||
func (app *BaseApp) Commit() abci.ResponseCommit {
|
||||
func (app *BaseApp) Commit() abci.CommitResponse {
|
||||
|
||||
...
|
||||
|
||||
res := abci.ResponseCommit{
|
||||
res := abci.CommitResponse{
|
||||
Data: commitID.Hash,
|
||||
RetainHeight: retainHeight,
|
||||
}
|
||||
@@ -314,7 +314,7 @@ func (app *BaseApp) Commit() abci.ResponseCommit {
|
||||
blockHeight := ctx.BlockHeight()
|
||||
changeSet := app.cms.PopStateCache()
|
||||
if app.abciListenersAsync {
|
||||
go func(res abci.ResponseCommit, changeSet []store.StoreKVPair) {
|
||||
go func(res abci.CommitResponse, changeSet []store.StoreKVPair) {
|
||||
if err := app.abciListener.ListenCommit(ctx, res, changeSet); err != nil {
|
||||
app.logger.Error("ListenCommit listening hook failed", "height", blockHeight, "err", err)
|
||||
}
|
||||
@@ -433,13 +433,13 @@ type GRPCClient struct {
|
||||
client ABCIListenerServiceClient
|
||||
}
|
||||
|
||||
func (m *GRPCClient) ListenFinalizeBlock(goCtx context.Context, req abci.RequestFinalizeBlock, res abci.ResponseFinalizeBlock) error {
|
||||
func (m *GRPCClient) ListenFinalizeBlock(goCtx context.Context, req abci.FinalizeBlockRequest, res abci.FinalizeBlockResponse) error {
|
||||
ctx := sdk.UnwrapSDKContext(goCtx)
|
||||
_, err := m.client.ListenDeliverTx(ctx, &ListenDeliverTxRequest{BlockHeight: ctx.BlockHeight(), Req: req, Res: res})
|
||||
return err
|
||||
}
|
||||
|
||||
func (m *GRPCClient) ListenCommit(goCtx context.Context, res abci.ResponseCommit, changeSet []store.StoreKVPair) error {
|
||||
func (m *GRPCClient) ListenCommit(goCtx context.Context, res abci.CommitResponse, changeSet []store.StoreKVPair) error {
|
||||
ctx := sdk.UnwrapSDKContext(goCtx)
|
||||
_, err := m.client.ListenCommit(ctx, &ListenCommitRequest{BlockHeight: ctx.BlockHeight(), Res: res, ChangeSet: changeSet})
|
||||
return err
|
||||
@@ -471,11 +471,11 @@ And the pre-compiled Go plugin `Impl`(*this is only used for plugins that are wr
|
||||
// ABCIListener is the implementation of the baseapp.ABCIListener interface
|
||||
type ABCIListener struct{}
|
||||
|
||||
func (m *ABCIListenerPlugin) ListenFinalizeBlock(ctx context.Context, req abci.RequestFinalizeBlock, res abci.ResponseFinalizeBlock) error {
|
||||
func (m *ABCIListenerPlugin) ListenFinalizeBlock(ctx context.Context, req abci.FinalizeBlockRequest, res abci.FinalizeBlockResponse) error {
|
||||
// send data to external system
|
||||
}
|
||||
|
||||
func (m *ABCIListenerPlugin) ListenCommit(ctx context.Context, res abci.ResponseCommit, changeSet []store.StoreKVPair) error {
|
||||
func (m *ABCIListenerPlugin) ListenCommit(ctx context.Context, res abci.CommitResponse, changeSet []store.StoreKVPair) error {
|
||||
// send data to external system
|
||||
}
|
||||
|
||||
|
||||
@@ -92,7 +92,7 @@ A new database snapshot will be created in every `EndBlocker` and identified by
|
||||
NOTE: `Commit` must be called exactly once per block. Otherwise we risk going out of sync for the version number and block height.
|
||||
NOTE: For the Cosmos SDK storage, we may consider splitting that interface into `Committer` and `PruningCommitter` - only the multiroot should implement `PruningCommitter` (cache and prefix store don't need pruning).
|
||||
|
||||
Number of historical versions for `abci.RequestQuery` and state sync snapshots is part of a node configuration, not a chain configuration (configuration implied by the blockchain consensus). A configuration should allow to specify number of past blocks and number of past blocks modulo some number (eg: 100 past blocks and one snapshot every 100 blocks for past 2000 blocks). Archival nodes can keep all past versions.
|
||||
Number of historical versions for `abci.QueryRequest` and state sync snapshots is part of a node configuration, not a chain configuration (configuration implied by the blockchain consensus). A configuration should allow to specify number of past blocks and number of past blocks modulo some number (eg: 100 past blocks and one snapshot every 100 blocks for past 2000 blocks). Archival nodes can keep all past versions.
|
||||
|
||||
Pruning old snapshots is effectively done by a database. Whenever we update a record in `SC`, SMT won't update nodes - instead it creates new nodes on the update path, without removing the old one. Since we are snapshotting each block, we need to change that mechanism to immediately remove orphaned nodes from the database. This is a safe operation - snapshots will keep track of the records and make it available when accessing past versions.
|
||||
|
||||
@@ -100,8 +100,8 @@ To manage the active snapshots we will either use a DB _max number of snapshots_
|
||||
|
||||
#### Accessing old state versions
|
||||
|
||||
One of the functional requirements is to access old state. This is done through `abci.RequestQuery` structure. The version is specified by a block height (so we query for an object by a key `K` at block height `H`). The number of old versions supported for `abci.RequestQuery` is configurable. Accessing an old state is done by using available snapshots.
|
||||
`abci.RequestQuery` doesn't need old state of `SC` unless the `prove=true` parameter is set. The SMT merkle proof must be included in the `abci.ResponseQuery` only if both `SC` and `SS` have a snapshot for requested version.
|
||||
One of the functional requirements is to access old state. This is done through `abci.QueryRequest` structure. The version is specified by a block height (so we query for an object by a key `K` at block height `H`). The number of old versions supported for `abci.QueryRequest` is configurable. Accessing an old state is done by using available snapshots.
|
||||
`abci.QueryRequest` doesn't need old state of `SC` unless the `prove=true` parameter is set. The SMT merkle proof must be included in the `abci.QueryResponse` only if both `SC` and `SS` have a snapshot for requested version.
|
||||
|
||||
Moreover, Cosmos SDK could provide a way to directly access a historical state. However, a state machine shouldn't do that - since the number of snapshots is configurable, it would lead to nondeterministic execution.
|
||||
|
||||
|
||||
@@ -169,7 +169,7 @@ Instead, we will define an additional ABCI interface method on the existing
|
||||
or `EndBlock`. This new interface method will be defined as follows:
|
||||
|
||||
```go
|
||||
ProcessProposal(sdk.Context, abci.RequestProcessProposal) error {}
|
||||
ProcessProposal(sdk.Context, abci.ProcessProposalRequest) error {}
|
||||
```
|
||||
|
||||
Note, we must call `ProcessProposal` with a new internal branched state on the
|
||||
|
||||
@@ -103,8 +103,8 @@ vote extensions.
|
||||
We propose the following new handlers for applications to implement:
|
||||
|
||||
```go
|
||||
type ExtendVoteHandler func(sdk.Context, abci.RequestExtendVote) abci.ResponseExtendVote
|
||||
type VerifyVoteExtensionHandler func(sdk.Context, abci.RequestVerifyVoteExtension) abci.ResponseVerifyVoteExtension
|
||||
type ExtendVoteHandler func(sdk.Context, abci.ExtendVoteRequest) abci.ExtendVoteResponse
|
||||
type VerifyVoteExtensionHandler func(sdk.Context, abci.VerifyVoteExtensionRequest) abci.VerifyVoteExtensionResponse
|
||||
```
|
||||
|
||||
An ephemeral context and state will be supplied to both handlers. The
|
||||
@@ -144,7 +144,7 @@ type VoteExtensionHandler struct {
|
||||
|
||||
// ExtendVoteHandler can do something with h.mk and possibly h.state to create
|
||||
// a vote extension, such as fetching a series of prices for supported assets.
|
||||
func (h VoteExtensionHandler) ExtendVoteHandler(ctx sdk.Context, req abci.RequestExtendVote) abci.ResponseExtendVote {
|
||||
func (h VoteExtensionHandler) ExtendVoteHandler(ctx sdk.Context, req abci.ExtendVoteRequest) abci.ExtendVoteResponse {
|
||||
prices := GetPrices(ctx, h.mk.Assets())
|
||||
bz, err := EncodePrices(h.cdc, prices)
|
||||
if err != nil {
|
||||
@@ -156,22 +156,22 @@ func (h VoteExtensionHandler) ExtendVoteHandler(ctx sdk.Context, req abci.Reques
|
||||
// NOTE: Vote extensions can be overridden since we can timeout in a round.
|
||||
SetPrices(h.state, req, bz)
|
||||
|
||||
return abci.ResponseExtendVote{VoteExtension: bz}
|
||||
return abci.ExtendVoteResponse{VoteExtension: bz}
|
||||
}
|
||||
|
||||
// VerifyVoteExtensionHandler can do something with h.state and req to verify
|
||||
// the req.VoteExtension field, such as ensuring the provided oracle prices are
|
||||
// within some valid range of our prices.
|
||||
func (h VoteExtensionHandler) VerifyVoteExtensionHandler(ctx sdk.Context, req abci.RequestVerifyVoteExtension) abci.ResponseVerifyVoteExtension {
|
||||
func (h VoteExtensionHandler) VerifyVoteExtensionHandler(ctx sdk.Context, req abci.VerifyVoteExtensionRequest) abci.VerifyVoteExtensionResponse {
|
||||
prices, err := DecodePrices(h.cdc, req.VoteExtension)
|
||||
if err != nil {
|
||||
log("failed to decode vote extension", "err", err)
|
||||
return abci.ResponseVerifyVoteExtension{Status: REJECT}
|
||||
return abci.VerifyVoteExtensionResponse{Status: REJECT}
|
||||
}
|
||||
|
||||
if err := ValidatePrices(h.state, req, prices); err != nil {
|
||||
log("failed to validate vote extension", "prices", prices, "err", err)
|
||||
return abci.ResponseVerifyVoteExtension{Status: REJECT}
|
||||
return abci.VerifyVoteExtensionResponse{Status: REJECT}
|
||||
}
|
||||
|
||||
// store updated vote extensions at the given height
|
||||
@@ -179,7 +179,7 @@ func (h VoteExtensionHandler) VerifyVoteExtensionHandler(ctx sdk.Context, req ab
|
||||
// NOTE: Vote extensions can be overridden since we can timeout in a round.
|
||||
SetPrices(h.state, req, req.VoteExtension)
|
||||
|
||||
return abci.ResponseVerifyVoteExtension{Status: ACCEPT}
|
||||
return abci.VerifyVoteExtensionResponse{Status: ACCEPT}
|
||||
}
|
||||
```
|
||||
|
||||
@@ -301,7 +301,7 @@ during `ProcessProposal` because during replay, CometBFT will NOT call `ProcessP
|
||||
which would result in an incomplete state view.
|
||||
|
||||
```go
|
||||
func (a MyApp) PreBlocker(ctx sdk.Context, req *abci.RequestFinalizeBlock) error {
|
||||
func (a MyApp) PreBlocker(ctx sdk.Context, req *abci.FinalizeBlockRequest) error {
|
||||
voteExts := GetVoteExtensions(ctx, req.Txs)
|
||||
|
||||
// Process and perform some compute on vote extensions, storing any resulting
|
||||
@@ -350,7 +350,7 @@ legacy ABCI types, e.g. `LegacyBeginBlockRequest` and `LegacyEndBlockRequest`. O
|
||||
we can come up with new types and names altogether.
|
||||
|
||||
```go
|
||||
func (app *BaseApp) FinalizeBlock(req abci.RequestFinalizeBlock) (*abci.ResponseFinalizeBlock, error) {
|
||||
func (app *BaseApp) FinalizeBlock(req abci.FinalizeBlockRequest) (*abci.FinalizeBlockResponse, error) {
|
||||
ctx := ...
|
||||
|
||||
if app.preBlocker != nil {
|
||||
@@ -375,7 +375,7 @@ func (app *BaseApp) FinalizeBlock(req abci.RequestFinalizeBlock) (*abci.Response
|
||||
endBlockResp, err := app.endBlock(app.finalizeBlockState.ctx)
|
||||
appendBlockEventAttr(beginBlockResp.Events, "end_block")
|
||||
|
||||
return abci.ResponseFinalizeBlock{
|
||||
return abci.FinalizeBlockResponse{
|
||||
TxResults: txExecResults,
|
||||
Events: joinEvents(beginBlockResp.Events, endBlockResp.Events),
|
||||
ValidatorUpdates: endBlockResp.ValidatorUpdates,
|
||||
|
||||
+3
-3
@@ -11,7 +11,7 @@ ABCI 2.0 (colloquially called ABCI++) allows an application to extend a pre-comm
|
||||
validator process. The Cosmos SDK defines [`baseapp.ExtendVoteHandler`](https://github.com/cosmos/cosmos-sdk/blob/v0.53.0/types/abci.go#L32):
|
||||
|
||||
```go
|
||||
type ExtendVoteHandler func(Context, *abci.RequestExtendVote) (*abci.ResponseExtendVote, error)
|
||||
type ExtendVoteHandler func(Context, *abci.ExtendVoteRequest) (*abci.ExtendVoteResponse, error)
|
||||
```
|
||||
|
||||
An application can set this handler in `app.go` via the `baseapp.SetExtendVoteHandler`
|
||||
@@ -38,7 +38,7 @@ other validators when validating their pre-commits. For a given vote extension,
|
||||
this process MUST be deterministic. The Cosmos SDK defines [`sdk.VerifyVoteExtensionHandler`](https://github.com/cosmos/cosmos-sdk/blob/v0.50.1/types/abci.go#L29-L31):
|
||||
|
||||
```go
|
||||
type VerifyVoteExtensionHandler func(Context, *abci.RequestVerifyVoteExtension) (*abci.ResponseVerifyVoteExtension, error)
|
||||
type VerifyVoteExtensionHandler func(Context, *abci.VerifyVoteExtensionRequest) (*abci.VerifyVoteExtensionResponse, error)
|
||||
```
|
||||
|
||||
An application can set this handler in `app.go` via the `baseapp.SetVerifyVoteExtensionHandler`
|
||||
@@ -78,7 +78,7 @@ will be available to the application during the subsequent `FinalizeBlock` call.
|
||||
An example of how a pre-FinalizeBlock hook could look like is shown below:
|
||||
|
||||
```go
|
||||
app.SetPreBlocker(func(ctx sdk.Context, req *abci.RequestFinalizeBlock) error {
|
||||
app.SetPreBlocker(func(ctx sdk.Context, req *abci.FinalizeBlockRequest) error {
|
||||
allVEs := []VE{} // store all parsed vote extensions here
|
||||
for _, tx := range req.Txs {
|
||||
// define a custom function that tries to parse the tx as a vote extension
|
||||
|
||||
+2
-2
@@ -16,7 +16,7 @@ process does NOT have to be deterministic, and the data returned can be unique t
|
||||
validator process. The Cosmos SDK defines `baseapp.ExtendVoteHandler`:
|
||||
|
||||
```go
|
||||
type ExtendVoteHandler func(Context, *abci.RequestExtendVote) (*abci.ResponseExtendVote, error)
|
||||
type ExtendVoteHandler func(Context, *abci.ExtendVoteRequest) (*abci.ExtendVoteResponse, error)
|
||||
```
|
||||
|
||||
An application can set this handler in `app.go` via the `baseapp.SetExtendVoteHandler`
|
||||
@@ -77,7 +77,7 @@ will be available to the application during the subsequent `FinalizeBlock` call.
|
||||
An example of how a pre-FinalizeBlock hook could look like is shown below:
|
||||
|
||||
```go
|
||||
app.SetPreBlocker(func(ctx sdk.Context, req *abci.RequestFinalizeBlock) error {
|
||||
app.SetPreBlocker(func(ctx sdk.Context, req *abci.FinalizeBlockRequest) error {
|
||||
allVEs := []VE{} // store all parsed vote extensions here
|
||||
for _, tx := range req.Txs {
|
||||
// define a custom function that tries to parse the tx as a vote extension
|
||||
|
||||
+1
-1
@@ -302,7 +302,7 @@ The module manager is used throughout the application whenever an action on a co
|
||||
* `SetOrderMigrations(moduleNames ...string)`: Sets the order of migrations to be run. If not set then migrations will be run with an order defined in `DefaultMigrationsOrder`.
|
||||
* `RegisterInvariants(ir sdk.InvariantRegistry)`: Registers the [invariants](./07-invariants.md) of module implementing the `HasInvariants` interface.
|
||||
* `RegisterServices(cfg Configurator)`: Registers the services of modules implementing the `HasServices` interface.
|
||||
* `InitGenesis(ctx context.Context, cdc codec.JSONCodec, genesisData map[string]json.RawMessage)`: Calls the [`InitGenesis`](./08-genesis.md#initgenesis) function of each module when the application is first started, in the order defined in `OrderInitGenesis`. Returns an `abci.ResponseInitChain` to the underlying consensus engine, which can contain validator updates.
|
||||
* `InitGenesis(ctx context.Context, cdc codec.JSONCodec, genesisData map[string]json.RawMessage)`: Calls the [`InitGenesis`](./08-genesis.md#initgenesis) function of each module when the application is first started, in the order defined in `OrderInitGenesis`. Returns an `abci.InitChainResponse` to the underlying consensus engine, which can contain validator updates.
|
||||
* `ExportGenesis(ctx context.Context, cdc codec.JSONCodec)`: Calls the [`ExportGenesis`](./08-genesis.md#exportgenesis) function of each module, in the order defined in `OrderExportGenesis`. The export constructs a genesis file from a previously existing state, and is mainly used when a hard-fork upgrade of the chain is required.
|
||||
* `ExportGenesisForModules(ctx context.Context, cdc codec.JSONCodec, modulesToExport []string)`: Behaves the same as `ExportGenesis`, except takes a list of modules to export.
|
||||
* `BeginBlock(ctx context.Context) error`: At the beginning of each block, this function is called from [`BaseApp`](../../learn/advanced/00-baseapp.md#beginblock) and, in turn, calls the [`BeginBlock`](./06-beginblock-endblock.md) function of each modules implementing the `appmodule.HasBeginBlocker` interface, in the order defined in `OrderBeginBlockers`. It creates a child [context](../../learn/advanced/02-context.md) with an event manager to aggregate [events](../../learn/advanced/08-events.md) emitted from each modules.
|
||||
|
||||
@@ -128,7 +128,7 @@ The `path` for each `query` must be defined by the module developer in the modul
|
||||
|
||||
### Store Queries
|
||||
|
||||
Store queries query directly for store keys. They use `clientCtx.QueryABCI(req abci.RequestQuery)` to return the full `abci.ResponseQuery` with inclusion Merkle proofs.
|
||||
Store queries query directly for store keys. They use `clientCtx.QueryABCI(req abci.QueryRequest)` to return the full `abci.QueryResponse` with inclusion Merkle proofs.
|
||||
|
||||
See following examples:
|
||||
|
||||
|
||||
@@ -264,7 +264,7 @@ Note that, unlike `CheckTx()`, `PrepareProposal` process `sdk.Msg`s, so it can d
|
||||
|
||||
It's important to note that `PrepareProposal` complements the `ProcessProposal` method which is executed after this method. The combination of these two methods means that it is possible to guarantee that no invalid transactions are ever committed. Furthermore, such a setup can give rise to other interesting use cases such as Oracles, threshold decryption and more.
|
||||
|
||||
`PrepareProposal` returns a response to the underlying consensus engine of type [`abci.ResponseCheckTx`](https://github.com/cometbft/cometbft/blob/v0.37.x/spec/abci/abci++_methods.md#processproposal). The response contains:
|
||||
`PrepareProposal` returns a response to the underlying consensus engine of type [`abci.CheckTxResponse`](https://github.com/cometbft/cometbft/blob/v0.37.x/spec/abci/abci++_methods.md#processproposal). The response contains:
|
||||
|
||||
* `Code (uint32)`: Response Code. `0` if successful.
|
||||
* `Data ([]byte)`: Result bytes, if any.
|
||||
@@ -291,7 +291,7 @@ CometBFT calls it when it receives a proposal and the CometBFT algorithm has not
|
||||
|
||||
However, developers must exercise greater caution when using these methods. Incorrectly coding these methods could affect liveness as CometBFT is unable to receive 2/3 valid precommits to finalize a block.
|
||||
|
||||
`ProcessProposal` returns a response to the underlying consensus engine of type [`abci.ResponseCheckTx`](https://github.com/cometbft/cometbft/blob/v0.37.x/spec/abci/abci++_methods.md#processproposal). The response contains:
|
||||
`ProcessProposal` returns a response to the underlying consensus engine of type [`abci.CheckTxResponse`](https://github.com/cometbft/cometbft/blob/v0.37.x/spec/abci/abci++_methods.md#processproposal). The response contains:
|
||||
|
||||
* `Code (uint32)`: Response Code. `0` if successful.
|
||||
* `Data ([]byte)`: Result bytes, if any.
|
||||
@@ -338,7 +338,7 @@ be rejected. In any case, the sender's account will not actually pay the fees un
|
||||
is actually included in a block, because `checkState` never gets committed to the main state. The
|
||||
`checkState` is reset to the latest state of the main state each time a blocks gets [committed](#commit).
|
||||
|
||||
`CheckTx` returns a response to the underlying consensus engine of type [`abci.ResponseCheckTx`](https://github.com/cometbft/cometbft/blob/v0.37.x/spec/abci/abci++_methods.md#checktx).
|
||||
`CheckTx` returns a response to the underlying consensus engine of type [`abci.CheckTxResponse`](https://github.com/cometbft/cometbft/blob/v0.37.x/spec/abci/abci++_methods.md#checktx).
|
||||
The response contains:
|
||||
|
||||
* `Code (uint32)`: Response Code. `0` if successful.
|
||||
@@ -432,7 +432,7 @@ The [`InitChain` ABCI message](https://github.com/cometbft/cometbft/blob/v0.37.x
|
||||
* [`checkState` and `finalizeBlockState`](#state-updates) via `setState`.
|
||||
* The [block gas meter](../beginner/04-gas-fees.md#block-gas-meter), with infinite gas to process genesis transactions.
|
||||
|
||||
Finally, the `InitChain(req abci.RequestInitChain)` method of `BaseApp` calls the [`initChainer()`](../beginner/00-app-anatomy.md#initchainer) of the application in order to initialize the main state of the application from the `genesis file` and, if defined, call the [`InitGenesis`](../../build/building-modules/08-genesis.md#initgenesis) function of each of the application's modules.
|
||||
Finally, the `InitChain(req abci.InitChainRequest)` method of `BaseApp` calls the [`initChainer()`](../beginner/00-app-anatomy.md#initchainer) of the application in order to initialize the main state of the application from the `genesis file` and, if defined, call the [`InitGenesis`](../../build/building-modules/08-genesis.md#initgenesis) function of each of the application's modules.
|
||||
|
||||
|
||||
### FinalizeBlock
|
||||
@@ -450,7 +450,7 @@ https://github.com/cosmos/cosmos-sdk/blob/v0.53.0/baseapp/abci.go#L869
|
||||
|
||||
#### BeginBlock
|
||||
|
||||
* Initialize [`finalizeBlockState`](#state-updates) with the latest header using the `req abci.RequestFinalizeBlock` passed as parameter via the `setState` function.
|
||||
* Initialize [`finalizeBlockState`](#state-updates) with the latest header using the `req abci.FinalizeBlockRequest` passed as parameter via the `setState` function.
|
||||
|
||||
```go reference
|
||||
https://github.com/cosmos/cosmos-sdk/blob/v0.53.0/baseapp/baseapp.go#L746-L770
|
||||
@@ -506,7 +506,7 @@ https://github.com/cosmos/cosmos-sdk/blob/v0.53.0/baseapp/baseapp.go#L811-L833
|
||||
|
||||
### Commit
|
||||
|
||||
The [`Commit` ABCI message](https://github.com/cometbft/cometbft/blob/v0.37.x/spec/abci/abci++_basic_concepts.md#method-overview) is sent from the underlying CometBFT engine after the full-node has received _precommits_ from 2/3+ of validators (weighted by voting power). On the `BaseApp` end, the `Commit(res abci.ResponseCommit)` function is implemented to commit all the valid state transitions that occurred during `FinalizeBlock` and to reset state for the next block.
|
||||
The [`Commit` ABCI message](https://github.com/cometbft/cometbft/blob/v0.37.x/spec/abci/abci++_basic_concepts.md#method-overview) is sent from the underlying CometBFT engine after the full-node has received _precommits_ from 2/3+ of validators (weighted by voting power). On the `BaseApp` end, the `Commit(res abci.CommitResponse)` function is implemented to commit all the valid state transitions that occurred during `FinalizeBlock` and to reset state for the next block.
|
||||
|
||||
To commit state-transitions, the `Commit` function calls the `Write()` function on `finalizeBlockState.ms`, where `finalizeBlockState.ms` is a branched multistore of the main store `app.cms`. Then, the `Commit` function sets `checkState` to the latest header (obtained from `finalizeBlockState.ctx.BlockHeader`) and `finalizeBlockState` to `nil`.
|
||||
|
||||
@@ -514,13 +514,13 @@ Finally, `Commit` returns the hash of the commitment of `app.cms` back to the un
|
||||
|
||||
### Info
|
||||
|
||||
The [`Info` ABCI message](https://github.com/cometbft/cometbft/blob/v0.37.x/spec/abci/abci++_basic_concepts.md#info-methods) is a simple query from the underlying consensus engine, notably used to sync the latter with the application during a handshake that happens on startup. When called, the `Info(res abci.ResponseInfo)` function from `BaseApp` will return the application's name, version and the hash of the last commit of `app.cms`.
|
||||
The [`Info` ABCI message](https://github.com/cometbft/cometbft/blob/v0.37.x/spec/abci/abci++_basic_concepts.md#info-methods) is a simple query from the underlying consensus engine, notably used to sync the latter with the application during a handshake that happens on startup. When called, the `Info(res abci.InfoResponse)` function from `BaseApp` will return the application's name, version and the hash of the last commit of `app.cms`.
|
||||
|
||||
### Query
|
||||
|
||||
The [`Query` ABCI message](https://github.com/cometbft/cometbft/blob/v0.37.x/spec/abci/abci++_basic_concepts.md#info-methods) is used to serve queries received from the underlying consensus engine, including queries received via RPC like CometBFT RPC. It used to be the main entrypoint to build interfaces with the application, but with the introduction of [gRPC queries](../../build/building-modules/04-query-services.md) in Cosmos SDK v0.40, its usage is more limited. The application must respect a few rules when implementing the `Query` method, which are outlined [here](https://github.com/cometbft/cometbft/blob/v0.37.x/spec/abci/abci++_app_requirements.md#query).
|
||||
|
||||
Each CometBFT `query` comes with a `path`, which is a `string` which denotes what to query. If the `path` matches a gRPC fully-qualified service method, then `BaseApp` will defer the query to the `grpcQueryRouter` and let it handle it like explained [above](#grpc-query-router). Otherwise, the `path` represents a query that is not (yet) handled by the gRPC router. `BaseApp` splits the `path` string with the `/` delimiter. By convention, the first element of the split string (`split[0]`) contains the category of `query` (`app`, `p2p`, `store` or `custom` ). The `BaseApp` implementation of the `Query(req abci.RequestQuery)` method is a simple dispatcher serving these 4 main categories of queries:
|
||||
Each CometBFT `query` comes with a `path`, which is a `string` which denotes what to query. If the `path` matches a gRPC fully-qualified service method, then `BaseApp` will defer the query to the `grpcQueryRouter` and let it handle it like explained [above](#grpc-query-router). Otherwise, the `path` represents a query that is not (yet) handled by the gRPC router. `BaseApp` splits the `path` string with the `/` delimiter. By convention, the first element of the split string (`split[0]`) contains the category of `query` (`app`, `p2p`, `store` or `custom` ). The `BaseApp` implementation of the `Query(req abci.QueryRequest)` method is a simple dispatcher serving these 4 main categories of queries:
|
||||
|
||||
* Application-related queries like querying the application's version, which are served via the `handleQueryApp` method.
|
||||
* Direct queries to the multistore, which are served by the `handlerQueryStore` method. These direct queries are different from custom queries which go through `app.queryRouter`, and are mainly used by third-party service provider like block explorers.
|
||||
|
||||
@@ -103,7 +103,7 @@ if upgradeInfo.Name == "my-plan" && !app.UpgradeKeeper.IsSkipHeight(upgradeInfo.
|
||||
When starting a new chain, the consensus version of each module MUST be saved to state during the application's genesis. To save the consensus version, add the following line to the `InitChainer` method in `app.go`:
|
||||
|
||||
```diff
|
||||
func (app *MyApp) InitChainer(ctx sdk.Context, req abci.RequestInitChain) abci.ResponseInitChain {
|
||||
func (app *MyApp) InitChainer(ctx sdk.Context, req abci.InitChainRequest) abci.InitChainResponse {
|
||||
...
|
||||
+ app.UpgradeKeeper.SetModuleVersionMap(ctx, app.mm.GetVersionMap())
|
||||
...
|
||||
|
||||
@@ -72,7 +72,7 @@ The command-line is an easy way to interact with an application, but `Tx` can al
|
||||
## Addition to Mempool
|
||||
|
||||
Each full-node (running CometBFT) that receives a `Tx` sends an [ABCI message](https://docs.cometbft.com/v0.37/spec/p2p/messages/),
|
||||
`CheckTx`, to the application layer to check for validity, and receives an `abci.ResponseCheckTx`. If the `Tx` passes the checks, it is held in the node's
|
||||
`CheckTx`, to the application layer to check for validity, and receives an `abci.CheckTxResponse`. If the `Tx` passes the checks, it is held in the node's
|
||||
[**Mempool**](https://docs.cometbft.com/v0.37/spec/p2p/messages/mempool/), an in-memory pool of transactions unique to each node, pending inclusion in a block - honest nodes discard a `Tx` if it is found to be invalid. Prior to consensus, nodes continuously check incoming transactions and gossip them to their peers.
|
||||
|
||||
### Types of Checks
|
||||
|
||||
@@ -134,7 +134,7 @@ Once a result is received from the querier, `baseapp` begins the process of retu
|
||||
|
||||
## Response
|
||||
|
||||
Since `Query()` is an ABCI function, `baseapp` returns the response as an [`abci.ResponseQuery`](https://docs.cometbft.com/master/spec/abci/abci.html#query-2) type. The `client.Context` `Query()` routine receives the response and.
|
||||
Since `Query()` is an ABCI function, `baseapp` returns the response as an [`abci.QueryResponse`](https://docs.cometbft.com/master/spec/abci/abci.html#query-2) type. The `client.Context` `Query()` routine receives the response and.
|
||||
|
||||
### CLI Response
|
||||
|
||||
|
||||
@@ -156,7 +156,7 @@ state from each `KVStore` to disk and returning an application state Merkle root
|
||||
Queries can be performed to return state data along with associated state
|
||||
commitment proofs for both previous heights/versions and the current state root.
|
||||
Queries are routed based on store name, i.e. a module, along with other parameters
|
||||
which are defined in `abci.RequestQuery`.
|
||||
which are defined in `abci.QueryRequest`.
|
||||
|
||||
The `rootmulti.Store` also provides primitives for pruning data at a given
|
||||
height/version from state storage. When a height is committed, the `rootmulti.Store`
|
||||
|
||||
Reference in New Issue
Block a user