feat: Add Tips middleware

CHANGELOG.md

@@ -52,6 +52,7 @@ Ref: https://keepachangelog.com/en/1.0.0/
 * [\#10326](https://github.com/cosmos/cosmos-sdk/pull/10326) `x/authz` add query all grants by granter query.
 * [\#10024](https://github.com/cosmos/cosmos-sdk/pull/10024) `store/cachekv` performance improvement by reduced growth factor for iterator ranging by using binary searches to find dirty items when unsorted key count >= 1024
 * [\#10348](https://github.com/cosmos/cosmos-sdk/pull/10348) Add `fee.{payer,granter}` and `tip` fields to StdSignDoc for signing tipped transactions.
+* [\#10208](https://github.com/cosmos/cosmos-sdk/pull/10208) Add `TipsTxMiddleware` for transferring tips.
 
 ### API Breaking Changes
 
@@ -103,7 +104,7 @@ Ref: https://keepachangelog.com/en/1.0.0/
   * Rename simulation helper methods `baseapp.{Check,Deliver}` to `baseapp.Sim{Check,Deliver}**`.
 * (x/gov) [\#10373](https://github.com/cosmos/cosmos-sdk/pull/10373) Removed gov `keeper.{MustMarshal, MustUnmarshal}`.
 * [\#10348](https://github.com/cosmos/cosmos-sdk/pull/10348) StdSignBytes takes a new argument of type `*tx.Tip` for signing over tips using LEGACY_AMINO_JSON.
-
+* [\#10208](https://github.com/cosmos/cosmos-sdk/pull/10208) The `x/auth/signing.Tx` interface now also includes a new `GetTip() *tx.Tip` method for verifying tipped transactions. The `x/auth/types` expected BankKeeper interface now expects the `SendCoins` method too.
 
 ### Client Breaking Changes
 

client/tx_config.go

@@ -44,6 +44,7 @@ type (
 		SetGasLimit(limit uint64)
 		SetTip(tip *tx.Tip)
 		SetTimeoutHeight(height uint64)
+		SetFeePayer(feePayer sdk.AccAddress)
 		SetFeeGranter(feeGranter sdk.AccAddress)
 	}
 )

types/tx/types.go

@@ -112,14 +112,14 @@ func (t *Tx) GetSigners() []sdk.AccAddress {
 	}
 
 	// ensure any specified fee payer is included in the required signers (at the end)
-	feePayer := t.AuthInfo.Fee.Payer
-	if feePayer != "" && !seen[feePayer] {
-		payerAddr, err := sdk.AccAddressFromBech32(feePayer)
+	fee := t.AuthInfo.Fee
+	if fee != nil && fee.Payer != "" && !seen[fee.Payer] {
+		payerAddr, err := sdk.AccAddressFromBech32(fee.Payer)
 		if err != nil {
 			panic(err)
 		}
 		signers = append(signers, payerAddr)
-		seen[feePayer] = true
+		seen[fee.Payer] = true
 	}
 
 	return signers

x/auth/middleware/middleware.go

@@ -93,6 +93,7 @@ func NewDefaultTxHandler(options TxHandlerOptions) (tx.Handler, error) {
 		ValidateSigCountMiddleware(options.AccountKeeper),
 		SigGasConsumeMiddleware(options.AccountKeeper, sigGasConsumer),
 		SigVerificationMiddleware(options.AccountKeeper, options.SignModeHandler),
+		NewTipsTxMiddleware(options.BankKeeper),
 		IncrementSequenceMiddleware(options.AccountKeeper),
 	), nil
 }

x/auth/middleware/middleware_test.go

@@ -23,13 +23,15 @@ import (
 	abci "github.com/tendermint/tendermint/abci/types"
 )
 
+var testCoins = sdk.Coins{sdk.NewInt64Coin("atom", 10000000)}
+
 // Test that simulate transaction accurately estimates gas cost
 func (s *MWTestSuite) TestSimulateGasCost() {
 	ctx := s.SetupTest(false) // reset
 	txBuilder := s.clientCtx.TxConfig.NewTxBuilder()
 
 	// Same data for every test cases
-	accounts := s.createTestAccounts(ctx, 3)
+	accounts := s.createTestAccounts(ctx, 3, testCoins)
 	msgs := []sdk.Msg{
 		testdata.NewTestMsg(accounts[0].acc.GetAddress(), accounts[1].acc.GetAddress()),
 		testdata.NewTestMsg(accounts[2].acc.GetAddress(), accounts[0].acc.GetAddress()),
@@ -166,7 +168,7 @@ func (s *MWTestSuite) TestTxHandlerAccountNumbers() {
 	txBuilder := s.clientCtx.TxConfig.NewTxBuilder()
 
 	// Same data for every test cases
-	accounts := s.createTestAccounts(ctx, 2)
+	accounts := s.createTestAccounts(ctx, 2, testCoins)
 	feeAmount := testdata.NewTestFeeAmount()
 	gasLimit := testdata.NewTestGasLimit()
 
@@ -248,7 +250,7 @@ func (s *MWTestSuite) TestTxHandlerAccountNumbersAtBlockHeightZero() {
 	txBuilder := s.clientCtx.TxConfig.NewTxBuilder()
 
 	// Same data for every test cases
-	accounts := s.createTestAccounts(ctx, 2)
+	accounts := s.createTestAccounts(ctx, 2, testCoins)
 	feeAmount := testdata.NewTestFeeAmount()
 	gasLimit := testdata.NewTestGasLimit()
 
@@ -331,7 +333,7 @@ func (s *MWTestSuite) TestTxHandlerSequences() {
 	txBuilder := s.clientCtx.TxConfig.NewTxBuilder()
 
 	// Same data for every test cases
-	accounts := s.createTestAccounts(ctx, 3)
+	accounts := s.createTestAccounts(ctx, 3, testCoins)
 	feeAmount := testdata.NewTestFeeAmount()
 	gasLimit := testdata.NewTestGasLimit()
 
@@ -524,7 +526,7 @@ func (s *MWTestSuite) TestTxHandlerMemoGas() {
 	txBuilder := s.clientCtx.TxConfig.NewTxBuilder()
 
 	// Same data for every test cases
-	accounts := s.createTestAccounts(ctx, 1)
+	accounts := s.createTestAccounts(ctx, 1, testCoins)
 	msgs := []sdk.Msg{testdata.NewTestMsg(accounts[0].acc.GetAddress())}
 	privs, accNums, accSeqs := []cryptotypes.PrivKey{accounts[0].priv}, []uint64{0}, []uint64{0}
 
@@ -594,7 +596,7 @@ func (s *MWTestSuite) TestTxHandlerMultiSigner() {
 	txBuilder := s.clientCtx.TxConfig.NewTxBuilder()
 
 	// Same data for every test cases
-	accounts := s.createTestAccounts(ctx, 3)
+	accounts := s.createTestAccounts(ctx, 3, testCoins)
 	msg1 := testdata.NewTestMsg(accounts[0].acc.GetAddress(), accounts[1].acc.GetAddress())
 	msg2 := testdata.NewTestMsg(accounts[2].acc.GetAddress(), accounts[0].acc.GetAddress())
 	msg3 := testdata.NewTestMsg(accounts[1].acc.GetAddress(), accounts[2].acc.GetAddress())
@@ -667,7 +669,7 @@ func (s *MWTestSuite) TestTxHandlerBadSignBytes() {
 	txBuilder := s.clientCtx.TxConfig.NewTxBuilder()
 
 	// Same data for every test cases
-	accounts := s.createTestAccounts(ctx, 2)
+	accounts := s.createTestAccounts(ctx, 2, testCoins)
 	msg0 := testdata.NewTestMsg(accounts[0].acc.GetAddress())
 
 	// Variable data per test case
@@ -793,7 +795,7 @@ func (s *MWTestSuite) TestTxHandlerSetPubKey() {
 	txBuilder := s.clientCtx.TxConfig.NewTxBuilder()
 
 	// Same data for every test cases
-	accounts := s.createTestAccounts(ctx, 2)
+	accounts := s.createTestAccounts(ctx, 2, testCoins)
 	feeAmount := testdata.NewTestFeeAmount()
 	gasLimit := testdata.NewTestGasLimit()
 
@@ -971,7 +973,7 @@ func (s *MWTestSuite) TestTxHandlerSigLimitExceeded() {
 	txBuilder := s.clientCtx.TxConfig.NewTxBuilder()
 
 	// Same data for every test cases
-	accounts := s.createTestAccounts(ctx, 8)
+	accounts := s.createTestAccounts(ctx, 8, testCoins)
 	var addrs []sdk.AccAddress
 	var privs []cryptotypes.PrivKey
 	for i := 0; i < 8; i++ {
@@ -1029,7 +1031,7 @@ func (s *MWTestSuite) TestCustomSignatureVerificationGasConsumer() {
 	s.Require().NoError(err)
 
 	// Same data for every test cases
-	accounts := s.createTestAccounts(ctx, 1)
+	accounts := s.createTestAccounts(ctx, 1, testCoins)
 	txBuilder.SetFeeAmount(testdata.NewTestFeeAmount())
 	txBuilder.SetGasLimit(testdata.NewTestGasLimit())
 	txBuilder.SetMsgs(testdata.NewTestMsg(accounts[0].acc.GetAddress()))
@@ -1073,7 +1075,7 @@ func (s *MWTestSuite) TestTxHandlerReCheck() {
 	txBuilder := s.clientCtx.TxConfig.NewTxBuilder()
 
 	// Same data for every test cases
-	accounts := s.createTestAccounts(ctx, 1)
+	accounts := s.createTestAccounts(ctx, 1, testCoins)
 
 	feeAmount := testdata.NewTestFeeAmount()
 	gasLimit := testdata.NewTestGasLimit()

x/auth/middleware/testutil_test.go

@@ -26,8 +26,9 @@ import (
 
 // testAccount represents an account used in the tests in x/auth/middleware.
 type testAccount struct {
-	acc  authtypes.AccountI
-	priv cryptotypes.PrivKey
+	acc    authtypes.AccountI
+	priv   cryptotypes.PrivKey
+	accNum uint64
 }
 
 // MWTestSuite is a test suite to be used with middleware tests.
@@ -42,7 +43,7 @@ type MWTestSuite struct {
 // returns context and app with params set on account keeper
 func createTestApp(t *testing.T, isCheckTx bool) (*simapp.SimApp, sdk.Context) {
 	app := simapp.Setup(t, isCheckTx)
-	ctx := app.BaseApp.NewContext(isCheckTx, tmproto.Header{}).WithBlockGasMeter(sdk.NewInfiniteGasMeter())
+	ctx := app.BaseApp.NewContext(isCheckTx, tmproto.Header{Height: app.LastBlockHeight() + 1}).WithBlockGasMeter(sdk.NewInfiniteGasMeter())
 	app.AccountKeeper.SetParams(ctx, authtypes.DefaultParams())
 
 	return app, ctx
@@ -52,7 +53,6 @@ func createTestApp(t *testing.T, isCheckTx bool) (*simapp.SimApp, sdk.Context) {
 func (s *MWTestSuite) SetupTest(isCheckTx bool) sdk.Context {
 	var ctx sdk.Context
 	s.app, ctx = createTestApp(s.T(), isCheckTx)
-	ctx = ctx.WithBlockHeight(1)
 
 	// Set up TxConfig.
 	encodingConfig := simapp.MakeTestEncodingConfig()
@@ -89,25 +89,23 @@ func (s *MWTestSuite) SetupTest(isCheckTx bool) sdk.Context {
 
 // createTestAccounts creates `numAccs` accounts, and return all relevant
 // information about them including their private keys.
-func (s *MWTestSuite) createTestAccounts(ctx sdk.Context, numAccs int) []testAccount {
+func (s *MWTestSuite) createTestAccounts(ctx sdk.Context, numAccs int, coins sdk.Coins) []testAccount {
 	var accounts []testAccount
 
 	for i := 0; i < numAccs; i++ {
 		priv, _, addr := testdata.KeyTestPubAddr()
 		acc := s.app.AccountKeeper.NewAccountWithAddress(ctx, addr)
-		err := acc.SetAccountNumber(uint64(i))
+		accNum := uint64(i)
+		err := acc.SetAccountNumber(accNum)
 		s.Require().NoError(err)
 		s.app.AccountKeeper.SetAccount(ctx, acc)
-		someCoins := sdk.Coins{
-			sdk.NewInt64Coin("atom", 10000000),
-		}
-		err = s.app.BankKeeper.MintCoins(ctx, minttypes.ModuleName, someCoins)
+		err = s.app.BankKeeper.MintCoins(ctx, minttypes.ModuleName, coins)
 		s.Require().NoError(err)
 
-		err = s.app.BankKeeper.SendCoinsFromModuleToAccount(ctx, minttypes.ModuleName, addr, someCoins)
+		err = s.app.BankKeeper.SendCoinsFromModuleToAccount(ctx, minttypes.ModuleName, addr, coins)
 		s.Require().NoError(err)
 
-		accounts = append(accounts, testAccount{acc, priv})
+		accounts = append(accounts, testAccount{acc, priv, accNum})
 	}
 
 	return accounts

x/auth/middleware/tips.go

@@ -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
+}
+
+// NewTipsTxMiddleware returns a new middleware for handling transactions with
+// tips.
+func NewTipsTxMiddleware(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)
+}