forked from cosmos/cosmos-sdk
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: Add Tips middleware (cosmos#10208)
<!-- The default pull request template is for types feat, fix, or refactor. For other templates, add one of the following parameters to the url: - template=docs.md - template=other.md --> ## Description R4R Closes: cosmos#9912 This PR introduces 1 new middleware: - `TipsMiddleware`: transfer tip from tipper to feePayer when relevant. It also makes sure in the DIRECT_AUX sign mode handler that the fee payer cannot use that sign mode. Depends on: - [x] cosmos#10028 - [x] cosmos#10268 - [x] cosmos#10322 - [x] cosmos#10346 <!-- Add a description of the changes that this PR introduces and the files that are the most critical to review. --> --- ### 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/master/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/master/docs/building-modules) - [ ] included the necessary unit and integration [tests](https://github.com/cosmos/cosmos-sdk/blob/master/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)
- Loading branch information
1 parent
3f988c4
commit b73fbc0
Showing
15 changed files
with
402 additions
and
32 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,94 @@ | ||
| package middleware | ||
|
|
||
| import ( | ||
| "context" | ||
|
|
||
| abci "github.com/tendermint/tendermint/abci/types" | ||
|
|
||
| sdk "github.com/cosmos/cosmos-sdk/types" | ||
| "github.com/cosmos/cosmos-sdk/types/tx" | ||
| "github.com/cosmos/cosmos-sdk/x/auth/types" | ||
| ) | ||
|
|
||
| type tipsTxHandler struct { | ||
| next tx.Handler | ||
| bankKeeper types.BankKeeper | ||
| } | ||
|
|
||
| // NewTipMiddleware returns a new middleware for handling transactions with | ||
| // tips. | ||
| func NewTipMiddleware(bankKeeper types.BankKeeper) tx.Middleware { | ||
| return func(txh tx.Handler) tx.Handler { | ||
| return tipsTxHandler{txh, bankKeeper} | ||
| } | ||
| } | ||
|
|
||
| var _ tx.Handler = tipsTxHandler{} | ||
|
|
||
| // CheckTx implements tx.Handler.CheckTx. | ||
| func (txh tipsTxHandler) CheckTx(ctx context.Context, sdkTx sdk.Tx, req abci.RequestCheckTx) (abci.ResponseCheckTx, error) { | ||
| res, err := txh.next.CheckTx(ctx, sdkTx, req) | ||
| if err != nil { | ||
| return abci.ResponseCheckTx{}, err | ||
| } | ||
|
|
||
| tipTx, ok := sdkTx.(tx.TipTx) | ||
| if !ok || tipTx.GetTip() == nil { | ||
| return res, err | ||
| } | ||
|
|
||
| if err := txh.transferTip(ctx, tipTx); err != nil { | ||
| return abci.ResponseCheckTx{}, err | ||
| } | ||
|
|
||
| return res, err | ||
| } | ||
|
|
||
| // DeliverTx implements tx.Handler.DeliverTx. | ||
| func (txh tipsTxHandler) DeliverTx(ctx context.Context, sdkTx sdk.Tx, req abci.RequestDeliverTx) (abci.ResponseDeliverTx, error) { | ||
| res, err := txh.next.DeliverTx(ctx, sdkTx, req) | ||
| if err != nil { | ||
| return abci.ResponseDeliverTx{}, err | ||
| } | ||
|
|
||
| tipTx, ok := sdkTx.(tx.TipTx) | ||
| if !ok || tipTx.GetTip() == nil { | ||
| return res, err | ||
| } | ||
|
|
||
| if err := txh.transferTip(ctx, tipTx); err != nil { | ||
| return abci.ResponseDeliverTx{}, err | ||
| } | ||
|
|
||
| return res, err | ||
| } | ||
|
|
||
| // SimulateTx implements tx.Handler.SimulateTx method. | ||
| func (txh tipsTxHandler) SimulateTx(ctx context.Context, sdkTx sdk.Tx, req tx.RequestSimulateTx) (tx.ResponseSimulateTx, error) { | ||
| res, err := txh.next.SimulateTx(ctx, sdkTx, req) | ||
| if err != nil { | ||
| return tx.ResponseSimulateTx{}, err | ||
| } | ||
|
|
||
| tipTx, ok := sdkTx.(tx.TipTx) | ||
| if !ok || tipTx.GetTip() == nil { | ||
| return res, err | ||
| } | ||
|
|
||
| if err := txh.transferTip(ctx, tipTx); err != nil { | ||
| return tx.ResponseSimulateTx{}, err | ||
| } | ||
|
|
||
| return res, err | ||
| } | ||
|
|
||
| // transferTip transfers the tip from the tipper to the fee payer. | ||
| func (txh tipsTxHandler) transferTip(ctx context.Context, tipTx tx.TipTx) error { | ||
| sdkCtx := sdk.UnwrapSDKContext(ctx) | ||
| tipper, err := sdk.AccAddressFromBech32(tipTx.GetTip().Tipper) | ||
| if err != nil { | ||
| return err | ||
| } | ||
|
|
||
| return txh.bankKeeper.SendCoins(sdkCtx, tipper, tipTx.FeePayer(), tipTx.GetTip().Amount) | ||
| } |
Oops, something went wrong.