Merge branch feature/abci++vef into main

cometbft · Mar 23, 2023 · 4790ea3 · 4790ea3
2 parents 01c0188 + 20179ec
commit 4790ea3
Show file tree

Hide file tree

Showing 219 changed files with 16,252 additions and 10,631 deletions.
diff --git a/.changelog/unreleased/breaking-changes/8664-move-app-hash-to-commit.md b/.changelog/unreleased/breaking-changes/8664-move-app-hash-to-commit.md
@@ -0,0 +1,2 @@
+- `[abci]` Move `app_hash` parameter from `Commit` to `FinalizeBlock` (@sergio-mena)
+  ([\#8664](https://github.com/tendermint/tendermint/pull/8664))
diff --git a/.changelog/unreleased/breaking-changes/9468-finalize-block.md b/.changelog/unreleased/breaking-changes/9468-finalize-block.md
@@ -0,0 +1,2 @@
+- `[abci]` Introduce `FinalizeBlock` which condenses `BeginBlock`, `DeliverTx` and `EndBlock` into a single method call (@cmwaters)
+  ([\#9468](https://github.com/tendermint/tendermint/pull/9468))
diff --git a/UPGRADING.md b/UPGRADING.md
@@ -38,29 +38,19 @@ now changed to `github.com/cometbft/cometbft`.
 
 ### ABCI Changes
 
-* The `ABCIVersion` is now `1.0.0`.
-* Added new ABCI methods `PrepareProposal` and `ProcessProposal`. For details,
-  please see the [spec](spec/abci/README.md). Applications upgrading to
-  v0.37.0 must implement these methods, at the very minimum, as described
+* The `ABCIVersion` is now `2.0.0`.
+* Added new ABCI methods `ExtendVote`, and `VerifyVoteExtension`.
+  Applications upgrading to v0.38.0 must implement these methods as described
   [here](./spec/abci/abci%2B%2B_comet_expected_behavior.md#adapting-existing-applications-that-use-abci)
-* Deduplicated `ConsensusParams` and `BlockParams`.
-  In the v0.34 branch they are defined both in `abci/types.proto` and `types/params.proto`.
-  The definitions in `abci/types.proto` have been removed.
-  In-process applications should make sure they are not using the deleted
-  version of those structures.
-* In v0.34, messages on the wire used to be length-delimited with `int64` varint
-  values, which was inconsistent with the `uint64` varint length delimiters used
-  in the P2P layer. Both now consistently use `uint64` varint length delimiters.
-* Added `AbciVersion` to `RequestInfo`.
-  Applications should check that CometBFT's ABCI version matches the one they expect
-  in order to ensure compatibility.
-* The `SetOption` method has been removed from the ABCI `Client` interface.
-  The corresponding Protobuf types have been deprecated.
-* The `key` and `value` fields in the `EventAttribute` type have been changed
-  from type `bytes` to `string`. As per the [Protocol Buffers updating
-  guidelines](https://developers.google.com/protocol-buffers/docs/proto3#updating),
-  this should have no effect on the wire-level encoding for UTF8-encoded
-  strings.
+* Removed methods `BeginBlock`, `DeliverTx`, `EndBlock`, and replaced them by
+  method `FinalizeBlock`. Applications upgrading to v0.38.0 must refactor
+  the logic handling the methods removed to handle `FinalizeBlock`.
+* The Application's hash (or any data representing the Application's current state)
+  is known by the time `FinalizeBlock` finishes its execution.
+  Accordingly, the `app_hash` parameter has been moved from `ResponseCommit`
+  to `ResponseFinalizeBlock`.
+* For details, please see the updated [specification](spec/abci/README.md)
+
 
 ### RPC
 

diff --git a/abci/client/client.go b/abci/client/client.go
@@ -1,6 +1,7 @@
 package abcicli
 
 import (
+	"context"
 	"fmt"
 	"sync"
 
@@ -16,50 +17,28 @@ const (
 
 //go:generate ../../scripts/mockery_generate.sh Client
 
-// Client defines an interface for an ABCI client.
-// All `Async` methods return a `ReqRes` object.
-// All `Sync` methods return the appropriate protobuf ResponseXxx struct and an error.
-// Note these are client errors, eg. ABCI socket connectivity issues.
-// Application-related errors are reflected in response via ABCI error codes and logs.
+// Client defines the interface for an ABCI client.
+//
+// NOTE these are client errors, eg. ABCI socket connectivity issues.
+// Application-related errors are reflected in response via ABCI error codes
+// and (potentially) error response.
 type Client interface {
 	service.Service
+	types.Application
 
-	SetResponseCallback(Callback)
+	// TODO: remove as each method now returns an error
 	Error() error
-
-	FlushAsync() *ReqRes
-	EchoAsync(msg string) *ReqRes
-	InfoAsync(types.RequestInfo) *ReqRes
-	DeliverTxAsync(types.RequestDeliverTx) *ReqRes
-	CheckTxAsync(types.RequestCheckTx) *ReqRes
-	QueryAsync(types.RequestQuery) *ReqRes
-	CommitAsync() *ReqRes
-	InitChainAsync(types.RequestInitChain) *ReqRes
-	PrepareProposalAsync(types.RequestPrepareProposal) *ReqRes
-	BeginBlockAsync(types.RequestBeginBlock) *ReqRes
-	EndBlockAsync(types.RequestEndBlock) *ReqRes
-	ListSnapshotsAsync(types.RequestListSnapshots) *ReqRes
-	OfferSnapshotAsync(types.RequestOfferSnapshot) *ReqRes
-	LoadSnapshotChunkAsync(types.RequestLoadSnapshotChunk) *ReqRes
-	ApplySnapshotChunkAsync(types.RequestApplySnapshotChunk) *ReqRes
-	ProcessProposalAsync(types.RequestProcessProposal) *ReqRes
-
-	FlushSync() error
-	EchoSync(msg string) (*types.ResponseEcho, error)
-	InfoSync(types.RequestInfo) (*types.ResponseInfo, error)
-	DeliverTxSync(types.RequestDeliverTx) (*types.ResponseDeliverTx, error)
-	CheckTxSync(types.RequestCheckTx) (*types.ResponseCheckTx, error)
-	QuerySync(types.RequestQuery) (*types.ResponseQuery, error)
-	CommitSync() (*types.ResponseCommit, error)
-	InitChainSync(types.RequestInitChain) (*types.ResponseInitChain, error)
-	PrepareProposalSync(types.RequestPrepareProposal) (*types.ResponsePrepareProposal, error)
-	BeginBlockSync(types.RequestBeginBlock) (*types.ResponseBeginBlock, error)
-	EndBlockSync(types.RequestEndBlock) (*types.ResponseEndBlock, error)
-	ListSnapshotsSync(types.RequestListSnapshots) (*types.ResponseListSnapshots, error)
-	OfferSnapshotSync(types.RequestOfferSnapshot) (*types.ResponseOfferSnapshot, error)
-	LoadSnapshotChunkSync(types.RequestLoadSnapshotChunk) (*types.ResponseLoadSnapshotChunk, error)
-	ApplySnapshotChunkSync(types.RequestApplySnapshotChunk) (*types.ResponseApplySnapshotChunk, error)
-	ProcessProposalSync(types.RequestProcessProposal) (*types.ResponseProcessProposal, error)
+	// TODO: remove as this is not implemented
+	Flush(context.Context) error
+	Echo(context.Context, string) (*types.ResponseEcho, error)
+
+	// FIXME: All other operations are run synchronously and rely
+	// on the caller to dictate concurrency (i.e. run a go routine),
+	// with the exception of `CheckTxAsync` which we maintain
+	// for the v0 mempool. We should explore refactoring the
+	// mempool to remove this vestige behavior.
+	SetResponseCallback(Callback)
+	CheckTxAsync(context.Context, *types.RequestCheckTx) (*ReqRes, error)
 }
 
 //----------------------------------------
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,2 @@
		- `[abci]` Move `app_hash` parameter from `Commit` to `FinalizeBlock` (@sergio-mena)
		([\#8664](https://github.com/tendermint/tendermint/pull/8664))
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,2 @@
		- `[abci]` Introduce `FinalizeBlock` which condenses `BeginBlock`, `DeliverTx` and `EndBlock` into a single method call (@cmwaters)
		([\#9468](https://github.com/tendermint/tendermint/pull/9468))