refactor!: BaseApp {Check,Deliver}Tx with middleware design

[amaury1093]

Description

ref: #9585

This PR if the 1st step (out of 2) in the #9585 refactor. It transforms baseapp's ABCI {Check,Deliver}Tx into middleware stacks. A middleware is defined by the following interfaces:

// types/tx package

type Handler interface {
	CheckTx(ctx context.Context, tx sdk.Tx, req abci.RequestCheckTx) (abci.ResponseCheckTx, error)
	DeliverTx(ctx context.Context, tx sdk.Tx, req abci.RequestDeliverTx) (abci.ResponseDeliverTx, error)
	SimulateTx(ctx context.Context, tx sdk.Tx, req RequestSimulateTx) (ResponseSimulateTx, error)
}

type Middleware func(Handler) Handler

This Pr doesn't migrate antehandlers, but only baseapp's runTx and runMsgs as middlewares. It bundles antehandlers into one single middleware (for now).

More specifically, it introduces the 5 following middlewares:

Middleware	Description
RunMsgsTxMiddleware	This middleware replaces the old baseapp's runMsgs.
LegacyAnteMiddleware	This middleware is temporary, it bundles all antehandlers into one middleware. It's only created for the purpose of breaking the refactor into 2 pieces. It will be removed in Part 2, and each antehandler will be replaced by its own middleware.
IndexEventsTxMiddleware	This is a simple middleware that chooses which events to index in Tendermint. Replaces baseapp.indexEvents (which unfortunately still exists in baseapp too, because it's used to index Begin/EndBlock events)
RecoveryTxMiddleware	This index recovers from panics. It replaces baseapp.runTx's panic recovery.
GasTxMiddleware	This replaces the Setup Antehandler. It sets a GasMeter on sdk.Context. Note that before, GasMeter was set on sdk.Context inside the antehandlers, and there was some mess around the fact that antehandlers had their own panic recovery system so that the GasMeter could be read by baseapp's recovery system. Now, this mess is all removed: one middleware sets GasMeter, another one handles recovery.

---

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 in the PR title
• added ! to the type prefix if API or client breaking change
• targeted the correct branch (see PR Targeting)
• provided a link to the relevant issue or specification
• followed the guidelines for building modules
• included the necessary unit and integration tests
• added a changelog entry to CHANGELOG.md
• included comments for documenting Go code
• 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 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)

[orijbot]

Visit https://dashboard.github.orijtech.com?pr=9920&remote=false&repo=cosmos%2Fcosmos-sdk to see benchmark details.

[codecov]

Codecov Report

Merging #9920 (0bb9c48) into master (147d798) will decrease coverage by 0.13%.
The diff coverage is 61.38%.

❗ Current head 0bb9c48 differs from pull request most recent head 880ff6b. Consider uploading reports for the commit 880ff6b to get more accurate results

@@            Coverage Diff             @@
##           master    #9920      +/-   ##
==========================================
- Coverage   63.75%   63.62%   -0.14%     
==========================================
  Files         566      571       +5     
  Lines       53402    53498      +96     
==========================================
- Hits        34048    34039       -9     
- Misses      17435    17525      +90     
- Partials     1919     1934      +15     

Impacted Files	Coverage Δ
simapp/test_helpers.go	0.69% <0.00%> (ø)
x/auth/ante/ante.go	60.00% <ø> (-1.30%)	⬇️
x/simulation/util.go	0.00% <0.00%> (ø)
x/auth/middleware/legacy_ante.go	28.16% <28.16%> (ø)
x/auth/middleware/index_events.go	39.28% <39.28%> (ø)
x/auth/middleware/run_msgs.go	58.03% <58.03%> (ø)
x/auth/middleware/recovery.go	58.82% <58.82%> (ø)
x/auth/middleware/gas.go	64.70% <64.70%> (ø)
baseapp/test_helpers.go	63.26% <70.00%> (-2.12%)	⬇️
baseapp/abci.go	60.76% <78.57%> (-1.26%)	⬇️
... and 22 more

[robert-zaremba]

Preapproving - let's resolve the expected order in CombineMiddleware function.

Also, let's create followup tasks (checkbox items in an issue) or issues for followups.

[amaury1093]

@alexanderbez regarding #9920 (review), your bullet points are totally on point. I'll try to point them where in the PR they happen, but would appreciate another pair of eyes on the logic, given that it's one of the most crucial bits of the SDK

Events are propogated not only from tx execution, but also from the ante-handler

Antehandlers and tx execution both call ctx.EventManager().EmitEvents, and at the end the runMsgsTxHandler populates the Check/DeliverTx response field. I believe #9920 (comment) tests this.

Tx simulation works as expected

Multiple functions have a simulate bool flag, I tried to be careful to set to false for Check/DeliverTx and true for SimulateTx. #9920 (comment) should test both gas and result for the gprc simulation endpoint.

Tx cache/store writes work as expected, i.e. writes are reverted on failure, etc...

Yeah I tried to keep the old design's exact same logic, but would like someone double-check it. It happens mainly in the antehandlers branching and then runMsgs branching.

[amaury1093]

@marbar3778 @alexanderbez any further comments on this PR? I'm going on vacation Friday, would like to get it merged before that.

I also started #9996, will make it R4R soon, and we can discuss more in details there?

[alexanderbez]

Nice! Guess we fixed it...somehow :p