test(ante): Ensure USDT fees are supported in MinGasPrices (#2024)

Confirms the behavior of any coins, e.g. usdt in the min-gas-prices option can be properly used as fee coins in a list of multiple coins

app/ante/fee_checker_test.go

@@ -0,0 +1,334 @@
+package ante_test
+
+import (
+	"testing"
+
+	"github.com/cosmos/cosmos-sdk/client"
+	cryptotypes "github.com/cosmos/cosmos-sdk/crypto/types"
+	"github.com/cosmos/cosmos-sdk/testutil"
+	"github.com/cosmos/cosmos-sdk/testutil/testdata"
+	sdk "github.com/cosmos/cosmos-sdk/types"
+	sdkerrors "github.com/cosmos/cosmos-sdk/types/errors"
+	moduletestutil "github.com/cosmos/cosmos-sdk/types/module/testutil"
+	"github.com/cosmos/cosmos-sdk/x/auth"
+	"github.com/cosmos/cosmos-sdk/x/auth/ante"
+	antetestutil "github.com/cosmos/cosmos-sdk/x/auth/ante/testutil"
+	"github.com/cosmos/cosmos-sdk/x/auth/keeper"
+	"github.com/cosmos/cosmos-sdk/x/auth/migrations/legacytx"
+	authtestutil "github.com/cosmos/cosmos-sdk/x/auth/testutil"
+	"github.com/cosmos/cosmos-sdk/x/auth/types"
+	gomock "github.com/golang/mock/gomock"
+	"github.com/stretchr/testify/require"
+)
+
+// TestAccount represents a testing account for the AnteTestSuite
+type TestAccount struct {
+	acc  types.AccountI
+	priv cryptotypes.PrivKey
+}
+
+// AnteTestSuite is based on cosmos SDK's x/auth/ante/testutil_test.go
+type AnteTestSuite struct {
+	anteHandler sdk.AnteHandler
+	ctx         sdk.Context
+	clientCtx   client.Context
+
+	accountKeeper  keeper.AccountKeeper
+	bankKeeper     *authtestutil.MockBankKeeper
+	feeGrantKeeper *antetestutil.MockFeegrantKeeper
+	encCfg         moduletestutil.TestEncodingConfig
+}
+
+func SetupTestSuite(t *testing.T, isCheckTx bool) *AnteTestSuite {
+	t.Helper()
+	suite := &AnteTestSuite{}
+
+	ctrl := gomock.NewController(t)
+	suite.bankKeeper = authtestutil.NewMockBankKeeper(ctrl)
+
+	key := sdk.NewKVStoreKey(types.StoreKey)
+	testCtx := testutil.DefaultContextWithDB(t, key, sdk.NewTransientStoreKey("transient_test"))
+	suite.ctx = testCtx.Ctx.
+		WithIsCheckTx(isCheckTx).
+		WithBlockHeight(1)
+	suite.encCfg = moduletestutil.MakeTestEncodingConfig(auth.AppModuleBasic{})
+
+	maccPerms := map[string][]string{
+		"fee_collector":          nil,
+		"mint":                   {"minter"},
+		"bonded_tokens_pool":     {"burner", "staking"},
+		"not_bonded_tokens_pool": {"burner", "staking"},
+		"multiPerm":              {"burner", "minter", "staking"},
+		"random":                 {"random"},
+	}
+
+	suite.accountKeeper = keeper.NewAccountKeeper(
+		suite.encCfg.Codec,
+		key,
+		types.ProtoBaseAccount,
+		maccPerms,
+		sdk.Bech32MainPrefix,
+		types.NewModuleAddress("gov").String(),
+	)
+	suite.accountKeeper.GetModuleAccount(suite.ctx, types.FeeCollectorName)
+	err := suite.accountKeeper.SetParams(suite.ctx, types.DefaultParams())
+	require.NoError(t, err)
+
+	suite.clientCtx = client.Context{}.
+		WithTxConfig(suite.encCfg.TxConfig)
+
+	anteHandler, err := ante.NewAnteHandler(
+		ante.HandlerOptions{
+			AccountKeeper:   suite.accountKeeper,
+			BankKeeper:      suite.bankKeeper,
+			FeegrantKeeper:  suite.feeGrantKeeper,
+			SignModeHandler: suite.encCfg.TxConfig.SignModeHandler(),
+			SigGasConsumer:  ante.DefaultSigVerificationGasConsumer,
+		},
+	)
+
+	require.NoError(t, err)
+	suite.anteHandler = anteHandler
+
+	return suite
+}
+
+func (suite *AnteTestSuite) CreateTestAccounts(
+	t *testing.T,
+	numAccs uint64,
+) []TestAccount {
+	t.Helper()
+
+	var accounts []TestAccount
+
+	for i := uint64(0); i < numAccs; i++ {
+		priv, _, addr := testdata.KeyTestPubAddr()
+		acc := suite.accountKeeper.NewAccountWithAddress(suite.ctx, addr)
+		require.NoError(t, acc.SetAccountNumber(i))
+		suite.accountKeeper.SetAccount(suite.ctx, acc)
+		accounts = append(accounts, TestAccount{acc, priv})
+	}
+
+	return accounts
+}
+
+// TestDeductFees tests the full AnteHandler flow with the DeductFeeDecorator
+// using the default TxFeeChecker
+func TestDeductFees(t *testing.T) {
+	tests := []struct {
+		name             string
+		setupMocks       func(s *AnteTestSuite)
+		giveMinGasPrices sdk.DecCoins
+		giveFee          legacytx.StdFee
+		wantErr          string
+	}{
+		{
+			"insufficient funds for fee",
+			func(s *AnteTestSuite) {
+				s.bankKeeper.EXPECT().
+					SendCoinsFromAccountToModule(
+						gomock.Any(),
+						gomock.Any(),
+						gomock.Any(),
+						gomock.Any(),
+					).
+					Return(sdkerrors.ErrInsufficientFunds)
+			},
+			sdk.NewDecCoins(sdk.NewDecCoinFromDec("ukava", sdk.MustNewDecFromStr("0.001"))),
+			legacytx.NewStdFee( //nolint:staticcheck // deprecated StdFee still in use
+				100000,
+				sdk.NewCoins(sdk.NewInt64Coin("ukava", 100)),
+			),
+			"insufficient funds: insufficient funds",
+		},
+		{
+			"valid fees",
+			func(s *AnteTestSuite) {
+				s.bankKeeper.EXPECT().
+					SendCoinsFromAccountToModule(
+						gomock.Any(),
+						gomock.Any(),
+						gomock.Any(),
+						gomock.Any(),
+					).
+					Return(nil)
+			},
+			sdk.NewDecCoins(sdk.NewDecCoinFromDec("ukava", sdk.MustNewDecFromStr("0.001"))),
+			legacytx.NewStdFee( //nolint:staticcheck // deprecated StdFee still in use
+				100000,
+				sdk.NewCoins(sdk.NewInt64Coin("ukava", 100)), // gasPrice * gas
+			),
+			"",
+		},
+		{
+			// Existing gas coin unaffected
+			"valid single ukava fee, multiple min gas prices",
+			func(s *AnteTestSuite) {
+				s.bankKeeper.EXPECT().
+					SendCoinsFromAccountToModule(
+						gomock.Any(),
+						gomock.Any(),
+						gomock.Any(),
+						gomock.Any(),
+					).
+					Return(nil)
+			},
+			sdk.NewDecCoins(
+				sdk.NewDecCoinFromDec("ukava", sdk.MustNewDecFromStr("0.001")),
+				// akava is removed from the min gas prices in `EvmMinGasFilter`
+				// but only to support 0ukava gas prices. Ensuring that the fee
+				// still works as expected even if it is present in case
+				// `EvmMinGasFilter` is removed.
+				sdk.NewDecCoinFromDec("akava", sdk.MustNewDecFromStr("10000000000")),
+				sdk.NewDecCoinFromDec("usdt", sdk.MustNewDecFromStr("0.003")),
+			),
+			legacytx.NewStdFee( //nolint:staticcheck // deprecated StdFee still in use
+				100000,
+				sdk.NewCoins(sdk.NewInt64Coin("ukava", 100)),
+			),
+			"",
+		},
+		{
+			"valid single usdt fee, multiple min gas prices",
+			func(s *AnteTestSuite) {
+				s.bankKeeper.EXPECT().
+					SendCoinsFromAccountToModule(
+						gomock.Any(),
+						gomock.Any(),
+						gomock.Any(),
+						gomock.Any(),
+					).
+					Return(nil)
+			},
+			sdk.NewDecCoins(
+				sdk.NewDecCoinFromDec("ukava", sdk.MustNewDecFromStr("0.001")),
+				sdk.NewDecCoinFromDec("akava", sdk.MustNewDecFromStr("10000000000")),
+				sdk.NewDecCoinFromDec("usdt", sdk.MustNewDecFromStr("0.003")),
+			),
+			legacytx.NewStdFee( //nolint:staticcheck // deprecated StdFee still in use
+				100000,
+				sdk.NewCoins(sdk.NewInt64Coin("usdt", 300)),
+			),
+			"",
+		},
+		{
+			"insufficient single fee, multiple min gas prices",
+			func(_ *AnteTestSuite) {},
+			sdk.NewDecCoins(
+				sdk.NewDecCoinFromDec("ukava", sdk.MustNewDecFromStr("0.001")),
+				sdk.NewDecCoinFromDec("usdt", sdk.MustNewDecFromStr("0.003")),
+			),
+			legacytx.NewStdFee( //nolint:staticcheck // deprecated StdFee still in use
+				100000,
+				sdk.NewCoins(sdk.NewInt64Coin("ukava", 99)), // gasPrice * gas - 1
+			),
+			"insufficient fees; got: 99ukava required: 100ukava,300usdt: insufficient fee",
+		},
+		{
+			"insufficient multiple fee, multiple min gas prices",
+			func(_ *AnteTestSuite) {},
+			sdk.NewDecCoins(
+				sdk.NewDecCoinFromDec("ukava", sdk.MustNewDecFromStr("0.001")),
+				sdk.NewDecCoinFromDec("usdt", sdk.MustNewDecFromStr("0.003")),
+			),
+			legacytx.NewStdFee( //nolint:staticcheck // deprecated StdFee still in use
+				100000,
+				sdk.NewCoins(
+					// Both fee coins are -1 from the required amount
+					sdk.NewInt64Coin("ukava", 99), // gasPrice * gas - 1
+					sdk.NewInt64Coin("usdt", 299), // gasPrice * gas - 1
+				),
+			),
+			"insufficient fees; got: 99ukava,299usdt required: 100ukava,300usdt: insufficient fee",
+		},
+		{
+			"valid multiple fee, multiple min gas prices",
+			func(s *AnteTestSuite) {
+				s.bankKeeper.EXPECT().
+					SendCoinsFromAccountToModule(
+						gomock.Any(),
+						gomock.Any(),
+						gomock.Any(),
+						gomock.Any(),
+					).
+					Return(nil)
+			},
+			sdk.NewDecCoins(
+				sdk.NewDecCoinFromDec("ukava", sdk.MustNewDecFromStr("0.001")),
+				sdk.NewDecCoinFromDec("usdt", sdk.MustNewDecFromStr("0.003")),
+			),
+			legacytx.NewStdFee( //nolint:staticcheck // deprecated StdFee still in use
+				100000,
+				sdk.NewCoins(
+					sdk.NewInt64Coin("ukava", 100),
+					// insufficient usdt is fine if ukava is sufficient
+					sdk.NewInt64Coin("usdt", 1),
+				),
+			),
+			"",
+		},
+		{
+			"wrong fees coin, multiple min gas prices",
+			func(_ *AnteTestSuite) {},
+			sdk.NewDecCoins(
+				sdk.NewDecCoinFromDec("ukava", sdk.MustNewDecFromStr("0.001")),
+				sdk.NewDecCoinFromDec("usdt", sdk.MustNewDecFromStr("0.003")),
+			),
+			legacytx.NewStdFee( //nolint:staticcheck // deprecated StdFee still in use
+				100000,
+				sdk.NewCoins(sdk.NewInt64Coin("cats", 1000)),
+			),
+			"insufficient fees; got: 1000cats required: 100ukava,300usdt: insufficient fee",
+		},
+	}
+
+	for _, tc := range tests {
+		t.Run(tc.name, func(t *testing.T) {
+			// true for isCheckTx
+			s := SetupTestSuite(t, true)
+
+			// keys and addresses
+			accs := s.CreateTestAccounts(t, 1)
+
+			// msg and signatures
+			msg := testdata.NewTestMsg(accs[0].acc.GetAddress())
+
+			// Setup expectations for mocks
+			tc.setupMocks(s)
+
+			// Set the minimum gas prices for test & verify it was set
+			s.ctx = s.ctx.WithMinGasPrices(tc.giveMinGasPrices)
+
+			require.Equal(t, tc.giveMinGasPrices, s.ctx.MinGasPrices())
+			require.True(t, s.ctx.IsCheckTx(), "expected IsCheckTx to be true to test minimum gas prices")
+
+			// Create transaction with given fee
+			txBuilder := s.clientCtx.TxConfig.NewTxBuilder()
+			require.NoError(t, txBuilder.SetMsgs(msg))
+
+			txBuilder.SetFeeAmount(tc.giveFee.Amount)
+			txBuilder.SetGasLimit(tc.giveFee.Gas)
+
+			// NOTE: Transaction is not signed, as it is not checked for this test.
+			tx := txBuilder.GetTx()
+
+			dfd := ante.NewDeductFeeDecorator(
+				s.accountKeeper,
+				s.bankKeeper,
+				nil, // feegrant keeper - unused
+				nil, // TxFeeChecker func - nil for default
+			)
+			antehandler := sdk.ChainAnteDecorators(dfd)
+
+			_, err := antehandler(s.ctx, tx, false)
+			if tc.wantErr != "" {
+				require.Error(t, err)
+				require.Contains(t, err.Error(), tc.wantErr)
+
+				return
+			}
+
+			require.NoError(t, err)
+		})
+	}
+}

go.mod

@@ -23,6 +23,7 @@ require (
 	github.com/evmos/ethermint v0.21.0
 	github.com/go-kit/kit v0.13.0
 	github.com/gogo/protobuf v1.3.2
+	github.com/golang/mock v1.6.0
 	github.com/golang/protobuf v1.5.4
 	github.com/gorilla/mux v1.8.0
 	github.com/grpc-ecosystem/grpc-gateway v1.16.0
@@ -115,7 +116,6 @@ require (
 	github.com/gogo/googleapis v1.4.1 // indirect
 	github.com/golang/glog v1.2.0 // indirect
 	github.com/golang/groupcache v0.0.0-20210331224755-41bb18bfe9da // indirect
-	github.com/golang/mock v1.6.0 // indirect
 	github.com/golang/snappy v0.0.4 // indirect
 	github.com/google/btree v1.1.2 // indirect
 	github.com/google/go-cmp v0.6.0 // indirect