refactor: Revert middlewares to antehandlers (part 1/2: baseapp) (#11979)
## Description We decided to remove middlewares, and revert to antehandlers (exactly like in v045) for this release. A better middleware solution will be implemented after v046. ref: #11955 Because this refactor is big, so I decided to cut it into two. This PR is part 1 of 2: - part 1: Revert baseapp and middlewares to v0.45.4 - part 2: Add posthandler, tips, priority --- Suggestion for reviewers: This PR might still be hard to review though. I think it's easier to actually review the diff between v0.45.4 and this PR: - `git difftool -d v0.45.4..am/revert-045-baseapp baseapp` - most important parts to review: runTx, runMsgs - `git difftool -d v0.45.4..am/revert-045-baseapp x/auth/ante` - only cosmetic changes - `git difftool -d v0.45.4..am/revert-045-baseapp simapp` --- ### Author Checklist *All items are required. Please add a note to the item if the item is not applicable and please add links to any relevant follow up issues.* I have... - [ ] included the correct [type prefix](https://github.com/commitizen/conventional-commit-types/blob/v3.0.0/index.json) in the PR title - [ ] added `!` to the type prefix if API or client breaking change - [ ] targeted the correct branch (see [PR Targeting](https://github.com/cosmos/cosmos-sdk/blob/main/CONTRIBUTING.md#pr-targeting)) - [ ] provided a link to the relevant issue or specification - [ ] followed the guidelines for [building modules](https://github.com/cosmos/cosmos-sdk/blob/main/docs/building-modules) - [ ] included the necessary unit and integration [tests](https://github.com/cosmos/cosmos-sdk/blob/main/CONTRIBUTING.md#testing) - [ ] added a changelog entry to `CHANGELOG.md` - [ ] included comments for [documenting Go code](https://blog.golang.org/godoc) - [ ] updated the relevant documentation or specification - [ ] reviewed "Files changed" and left comments if necessary - [ ] confirmed all CI checks have passed ### Reviewers Checklist *All items are required. Please add a note if the item is not applicable and please add your handle next to the items reviewed if you only reviewed selected items.* I have... - [ ] confirmed the correct [type prefix](https://github.com/commitizen/conventional-commit-types/blob/v3.0.0/index.json) in the PR title - [ ] confirmed `!` in the type prefix if API or client breaking change - [ ] confirmed all author checklist items have been addressed - [ ] reviewed state machine logic - [ ] reviewed API design and naming - [ ] reviewed documentation is accurate - [ ] reviewed tests and test coverage - [ ] manually tested (if applicable)
This commit is contained in:
@@ -17,6 +17,20 @@ func ResponseCheckTx(err error, gw, gu uint64, debug bool) abci.ResponseCheckTx
|
||||
}
|
||||
}
|
||||
|
||||
// ResponseCheckTxWithEvents returns an ABCI ResponseCheckTx object with fields filled in
|
||||
// from the given error, gas values and events.
|
||||
func ResponseCheckTxWithEvents(err error, gw, gu uint64, events []abci.Event, debug bool) abci.ResponseCheckTx {
|
||||
space, code, log := ABCIInfo(err, debug)
|
||||
return abci.ResponseCheckTx{
|
||||
Codespace: space,
|
||||
Code: code,
|
||||
Log: log,
|
||||
GasWanted: int64(gw),
|
||||
GasUsed: int64(gu),
|
||||
Events: events,
|
||||
}
|
||||
}
|
||||
|
||||
// ResponseDeliverTx returns an ABCI ResponseDeliverTx object with fields filled in
|
||||
// from the given error and gas values.
|
||||
func ResponseDeliverTx(err error, gw, gu uint64, debug bool) abci.ResponseDeliverTx {
|
||||
@@ -30,6 +44,20 @@ func ResponseDeliverTx(err error, gw, gu uint64, debug bool) abci.ResponseDelive
|
||||
}
|
||||
}
|
||||
|
||||
// ResponseDeliverTxWithEvents returns an ABCI ResponseDeliverTx object with fields filled in
|
||||
// from the given error, gas values and events.
|
||||
func ResponseDeliverTxWithEvents(err error, gw, gu uint64, events []abci.Event, debug bool) abci.ResponseDeliverTx {
|
||||
space, code, log := ABCIInfo(err, debug)
|
||||
return abci.ResponseDeliverTx{
|
||||
Codespace: space,
|
||||
Code: code,
|
||||
Log: log,
|
||||
GasWanted: int64(gw),
|
||||
GasUsed: int64(gu),
|
||||
Events: events,
|
||||
}
|
||||
}
|
||||
|
||||
// QueryResult returns a ResponseQuery from an error. It will try to parse ABCI
|
||||
// info from the error.
|
||||
func QueryResult(err error, debug bool) abci.ResponseQuery {
|
||||
|
||||
@@ -5,11 +5,9 @@ type Handler func(ctx Context, msg Msg) (*Result, error)
|
||||
|
||||
// AnteHandler authenticates transactions, before their internal messages are handled.
|
||||
// If newCtx.IsZero(), ctx is used instead.
|
||||
// DEPRECATED: use middleware instead
|
||||
type AnteHandler func(ctx Context, tx Tx, simulate bool) (newCtx Context, err error)
|
||||
|
||||
// AnteDecorator wraps the next AnteHandler to perform custom pre- and post-processing.
|
||||
// DEPRECATED: use middleware instead
|
||||
type AnteDecorator interface {
|
||||
AnteHandle(ctx Context, tx Tx, simulate bool, next AnteHandler) (newCtx Context, err error)
|
||||
}
|
||||
@@ -28,7 +26,6 @@ type AnteDecorator interface {
|
||||
// transactions to be processed with an infinite gasmeter and open a DOS attack vector.
|
||||
// Use `ante.SetUpContextDecorator` or a custom Decorator with similar functionality.
|
||||
// Returns nil when no AnteDecorator are supplied.
|
||||
// DEPRECATED: use middleware instead
|
||||
func ChainAnteDecorators(chain ...AnteDecorator) AnteHandler {
|
||||
if len(chain) == 0 {
|
||||
return nil
|
||||
|
||||
@@ -1,71 +0,0 @@
|
||||
package tx
|
||||
|
||||
import (
|
||||
context "context"
|
||||
|
||||
codectypes "github.com/cosmos/cosmos-sdk/codec/types"
|
||||
abci "github.com/tendermint/tendermint/abci/types"
|
||||
|
||||
sdk "github.com/cosmos/cosmos-sdk/types"
|
||||
)
|
||||
|
||||
// RequestSimulateTx is the request type for the tx.Handler.RequestSimulateTx
|
||||
// method.
|
||||
type RequestSimulateTx struct {
|
||||
TxBytes []byte
|
||||
}
|
||||
|
||||
// ResponseSimulateTx is the response type for the tx.Handler.RequestSimulateTx
|
||||
// method.
|
||||
type ResponseSimulateTx struct {
|
||||
GasInfo sdk.GasInfo
|
||||
Result *sdk.Result
|
||||
}
|
||||
|
||||
// Request is the tx request type used in middlewares.
|
||||
// At least one of Tx or TxBytes must be set. If only TxBytes is set, then
|
||||
// Tx will be populated by the TxDecoderMiddleware. If only Tx is set, then
|
||||
// some middlewares (such as signature verification) will fail.
|
||||
//
|
||||
// In practice, the middleware stack is called from {Check,Deliver}Tx, which
|
||||
// only passes the TxBytes. Then, the TxDecoderMiddleware decodes the bytes
|
||||
// into the Tx field.
|
||||
type Request struct {
|
||||
Tx sdk.Tx
|
||||
TxBytes []byte
|
||||
}
|
||||
|
||||
// Response is the tx response type used in middlewares.
|
||||
type Response struct {
|
||||
GasWanted uint64
|
||||
GasUsed uint64
|
||||
// MsgResponses is an array containing each Msg service handler's response
|
||||
// type, packed in an Any. This will get proto-serialized into the `Data` field
|
||||
// in the ABCI Check/DeliverTx responses.
|
||||
MsgResponses []*codectypes.Any
|
||||
Log string
|
||||
Events []abci.Event
|
||||
}
|
||||
|
||||
// RequestCheckTx is the additional request type used in middlewares CheckTx
|
||||
// method.
|
||||
type RequestCheckTx struct {
|
||||
Type abci.CheckTxType
|
||||
}
|
||||
|
||||
// RequestCheckTx is the additional response type used in middlewares CheckTx
|
||||
// method.
|
||||
type ResponseCheckTx struct {
|
||||
Priority int64
|
||||
}
|
||||
|
||||
// TxHandler defines the baseapp's CheckTx, DeliverTx and Simulate respective
|
||||
// handlers. It is designed as a middleware stack.
|
||||
type Handler interface {
|
||||
CheckTx(ctx context.Context, req Request, checkReq RequestCheckTx) (Response, ResponseCheckTx, error)
|
||||
DeliverTx(ctx context.Context, req Request) (Response, error)
|
||||
SimulateTx(ctx context.Context, req Request) (Response, error)
|
||||
}
|
||||
|
||||
// TxMiddleware defines one layer of the TxHandler middleware stack.
|
||||
type Middleware func(Handler) Handler
|
||||
Reference in New Issue
Block a user