imp(feemarket): update BaseFee based on GasWanted (#1105)

* add gasWanted transient store keys * add gasWanted transient store keeper functions * add gasWanted transient store tracker * add comment * remove unncesary comment * remove unnecesary function * fix tests * fix bad comment * remove unnecesary comment * update comment * update changelog * Update CHANGELOG.md Co-authored-by: Federico Kunze Küllmer <31522760+fedekunze@users.noreply.github.com> * add GasWantedDecorator * remove unnecesary comments * gasWanted decorator test * fix tests * fix tests and build * fix lint * updated end block event * Update app/ante/fee_market.go Co-authored-by: Federico Kunze Küllmer <31522760+fedekunze@users.noreply.github.com> * fix undeclared variable * Update app/ante/fee_market_test.go * remove unnecesary line * migrate MinGasMultiplier to FeeMarket module * set limited gas wanted * remove old newKeeper param * update proto comment * fix test * update comments * Update x/feemarket/keeper/abci.go Co-authored-by: Federico Kunze Küllmer <31522760+fedekunze@users.noreply.github.com> * address comments from review * tidy * tests Co-authored-by: Federico Kunze Küllmer <31522760+fedekunze@users.noreply.github.com>
2022-06-05 09:22:33 +00:00
parent 8155e1f319
commit 620f6a6770
46 changed files with 570 additions and 521 deletions
@@ -14,10 +14,6 @@ import (
 	ethtypes "github.com/ethereum/go-ethereum/core/types"
 )

-func nextFn(ctx sdk.Context, _ sdk.Tx, _ bool) (sdk.Context, error) {
-	return ctx, nil
-}
-
 func (suite AnteTestSuite) TestEthSigVerificationDecorator() {
 	dec := ante.NewEthSigVerificationDecorator(suite.app.EvmKeeper)
 	addr, privKey := tests.NewAddrKey()
@@ -46,7 +42,7 @@ func (suite AnteTestSuite) TestEthSigVerificationDecorator() {

 	for _, tc := range testCases {
 		suite.Run(tc.name, func() {
-			_, err := dec.AnteHandle(suite.ctx.WithIsReCheckTx(tc.reCheckTx), tc.tx, false, nextFn)
+			_, err := dec.AnteHandle(suite.ctx.WithIsReCheckTx(tc.reCheckTx), tc.tx, false, NextFn)

 			if tc.expPass {
 				suite.Require().NoError(err)
@@ -134,7 +130,7 @@ func (suite AnteTestSuite) TestNewEthAccountVerificationDecorator() {
 			tc.malleate()
 			suite.Require().NoError(vmdb.Commit())

-			_, err := dec.AnteHandle(suite.ctx.WithIsCheckTx(tc.checkTx), tc.tx, false, nextFn)
+			_, err := dec.AnteHandle(suite.ctx.WithIsCheckTx(tc.checkTx), tc.tx, false, NextFn)

 			if tc.expPass {
 				suite.Require().NoError(err)
@@ -190,7 +186,7 @@ func (suite AnteTestSuite) TestEthNonceVerificationDecorator() {
 	for _, tc := range testCases {
 		suite.Run(tc.name, func() {
 			tc.malleate()
-			_, err := dec.AnteHandle(suite.ctx.WithIsReCheckTx(tc.reCheckTx), tc.tx, false, nextFn)
+			_, err := dec.AnteHandle(suite.ctx.WithIsReCheckTx(tc.reCheckTx), tc.tx, false, NextFn)

 			if tc.expPass {
 				suite.Require().NoError(err)
@@ -287,12 +283,12 @@ func (suite AnteTestSuite) TestEthGasConsumeDecorator() {

 			if tc.expPanic {
 				suite.Require().Panics(func() {
-					_, _ = dec.AnteHandle(suite.ctx.WithIsCheckTx(true).WithGasMeter(sdk.NewGasMeter(1)), tc.tx, false, nextFn)
+					_, _ = dec.AnteHandle(suite.ctx.WithIsCheckTx(true).WithGasMeter(sdk.NewGasMeter(1)), tc.tx, false, NextFn)
 				})
 				return
 			}

-			ctx, err := dec.AnteHandle(suite.ctx.WithIsCheckTx(true).WithGasMeter(sdk.NewInfiniteGasMeter()), tc.tx, false, nextFn)
+			ctx, err := dec.AnteHandle(suite.ctx.WithIsCheckTx(true).WithGasMeter(sdk.NewInfiniteGasMeter()), tc.tx, false, NextFn)
 			if tc.expPass {
 				suite.Require().NoError(err)
 			} else {
@@ -376,7 +372,7 @@ func (suite AnteTestSuite) TestCanTransferDecorator() {
 			tc.malleate()
 			suite.Require().NoError(vmdb.Commit())

-			_, err := dec.AnteHandle(suite.ctx.WithIsCheckTx(true), tc.tx, false, nextFn)
+			_, err := dec.AnteHandle(suite.ctx.WithIsCheckTx(true), tc.tx, false, NextFn)

 			if tc.expPass {
 				suite.Require().NoError(err)
@@ -455,12 +451,12 @@ func (suite AnteTestSuite) TestEthIncrementSenderSequenceDecorator() {

 			if tc.expPanic {
 				suite.Require().Panics(func() {
-					_, _ = dec.AnteHandle(suite.ctx, tc.tx, false, nextFn)
+					_, _ = dec.AnteHandle(suite.ctx, tc.tx, false, NextFn)
 				})
 				return
 			}

-			_, err := dec.AnteHandle(suite.ctx, tc.tx, false, nextFn)
+			_, err := dec.AnteHandle(suite.ctx, tc.tx, false, NextFn)

 			if tc.expPass {
 				suite.Require().NoError(err)
@@ -497,7 +493,7 @@ func (suite AnteTestSuite) TestEthSetupContextDecorator() {

 	for _, tc := range testCases {
 		suite.Run(tc.name, func() {
-			_, err := dec.AnteHandle(suite.ctx, tc.tx, false, nextFn)
+			_, err := dec.AnteHandle(suite.ctx, tc.tx, false, NextFn)

 			if tc.expPass {
 				suite.Require().NoError(err)
@@ -0,0 +1,49 @@
+package ante
+
+import (
+	"math/big"
+
+	sdk "github.com/cosmos/cosmos-sdk/types"
+	sdkerrors "github.com/cosmos/cosmos-sdk/types/errors"
+)
+
+// GasWantedDecorator keeps track of the gasWanted amount on the current block in transient store
+// for BaseFee calculation.
+// NOTE: This decorator does not perform any validation
+type GasWantedDecorator struct {
+	evmKeeper       EVMKeeper
+	feeMarketKeeper FeeMarketKeeper
+}
+
+// NewGasWantedDecorator creates a new NewGasWantedDecorator
+func NewGasWantedDecorator(
+	evmKeeper EVMKeeper,
+	feeMarketKeeper FeeMarketKeeper,
+) GasWantedDecorator {
+	return GasWantedDecorator{
+		evmKeeper,
+		feeMarketKeeper,
+	}
+}
+
+func (gwd GasWantedDecorator) AnteHandle(ctx sdk.Context, tx sdk.Tx, simulate bool, next sdk.AnteHandler) (newCtx sdk.Context, err error) {
+	params := gwd.evmKeeper.GetParams(ctx)
+	ethCfg := params.ChainConfig.EthereumConfig(gwd.evmKeeper.ChainID())
+
+	blockHeight := big.NewInt(ctx.BlockHeight())
+	london := ethCfg.IsLondon(blockHeight)
+
+	feeTx, ok := tx.(sdk.FeeTx)
+	if ok && london {
+		gasWanted := feeTx.GetGas()
+		feeMktParams := gwd.feeMarketKeeper.GetParams(ctx)
+		// Add total gasWanted to cumulative in block transientStore in FeeMarket module
+		if feeMktParams.IsBaseFeeEnabled(ctx.BlockHeight()) {
+			if _, err := gwd.feeMarketKeeper.AddTransientGasWanted(ctx, gasWanted); err != nil {
+				return ctx, sdkerrors.Wrapf(err, "failed to add gas wanted to transient store")
+			}
+		}
+	}
+
+	return next(ctx, tx, simulate)
+}
@@ -0,0 +1,94 @@
+package ante_test
+
+import (
+	"math/big"
+
+	sdk "github.com/cosmos/cosmos-sdk/types"
+	banktypes "github.com/cosmos/cosmos-sdk/x/bank/types"
+	ethtypes "github.com/ethereum/go-ethereum/core/types"
+	"github.com/tharsis/ethermint/app/ante"
+	"github.com/tharsis/ethermint/tests"
+	evmtypes "github.com/tharsis/ethermint/x/evm/types"
+)
+
+func (suite AnteTestSuite) TestGasWantedDecorator() {
+	suite.enableFeemarket = true
+	suite.SetupTest()
+	dec := ante.NewGasWantedDecorator(suite.app.EvmKeeper, suite.app.FeeMarketKeeper)
+	from, fromPrivKey := tests.NewAddrKey()
+	to := tests.GenerateAddress()
+
+	testCases := []struct {
+		name              string
+		expectedGasWanted uint64
+		malleate          func() sdk.Tx
+	}{
+		{
+			"Cosmos Tx",
+			TestGasLimit,
+			func() sdk.Tx {
+				denom := evmtypes.DefaultEVMDenom
+				testMsg := banktypes.MsgSend{
+					FromAddress: "evmos1x8fhpj9nmhqk8z9kpgjt95ck2xwyue0ptzkucp",
+					ToAddress:   "evmos1dx67l23hz9l0k9hcher8xz04uj7wf3yu26l2yn",
+					Amount:      sdk.Coins{sdk.Coin{Amount: sdk.NewInt(10), Denom: denom}},
+				}
+				txBuilder := suite.CreateTestCosmosTxBuilder(sdk.NewInt(10), "stake", &testMsg)
+				return txBuilder.GetTx()
+			},
+		},
+		{
+			"Ethereum Legacy Tx",
+			TestGasLimit,
+			func() sdk.Tx {
+				msg := suite.BuildTestEthTx(from, to, nil, make([]byte, 0), big.NewInt(0), nil, nil, nil)
+				return suite.CreateTestTx(msg, fromPrivKey, 1, false)
+			},
+		},
+		{
+			"Ethereum Access List Tx",
+			TestGasLimit,
+			func() sdk.Tx {
+				emptyAccessList := ethtypes.AccessList{}
+				msg := suite.BuildTestEthTx(from, to, nil, make([]byte, 0), big.NewInt(0), nil, nil, &emptyAccessList)
+				return suite.CreateTestTx(msg, fromPrivKey, 1, false)
+			},
+		},
+		{
+			"Ethereum Dynamic Fee Tx (EIP1559)",
+			TestGasLimit,
+			func() sdk.Tx {
+				emptyAccessList := ethtypes.AccessList{}
+				msg := suite.BuildTestEthTx(from, to, nil, make([]byte, 0), big.NewInt(0), big.NewInt(100), big.NewInt(50), &emptyAccessList)
+				return suite.CreateTestTx(msg, fromPrivKey, 1, false)
+			},
+		},
+		{
+			"EIP712 message",
+			200000,
+			func() sdk.Tx {
+				amount := sdk.NewCoins(sdk.NewCoin(evmtypes.DefaultEVMDenom, sdk.NewInt(20)))
+				gas := uint64(200000)
+				acc := suite.app.AccountKeeper.NewAccountWithAddress(suite.ctx, from.Bytes())
+				suite.Require().NoError(acc.SetSequence(1))
+				suite.app.AccountKeeper.SetAccount(suite.ctx, acc)
+				tx := suite.CreateTestEIP712TxBuilderMsgSend(acc.GetAddress(), fromPrivKey, suite.ctx.ChainID(), gas, amount)
+				return tx.GetTx()
+			},
+		},
+	}
+
+	// cumulative gas wanted from all test transactions in the same block
+	var expectedGasWanted uint64
+
+	for _, tc := range testCases {
+		suite.Run(tc.name, func() {
+			_, err := dec.AnteHandle(suite.ctx, tc.malleate(), false, NextFn)
+			suite.Require().NoError(err)
+
+			gasWanted := suite.app.FeeMarketKeeper.GetTransientGasWanted(suite.ctx)
+			expectedGasWanted += tc.expectedGasWanted
+			suite.Require().Equal(expectedGasWanted, gasWanted)
+		})
+	}
+}
@@ -115,7 +115,7 @@ func (s AnteTestSuite) TestMinGasPriceDecorator() {
 				// s.SetupTest(et.isCheckTx)
 				ctx := s.ctx.WithIsReCheckTx(et.isCheckTx)
 				dec := ante.NewMinGasPriceDecorator(s.app.FeeMarketKeeper, s.app.EvmKeeper)
-				_, err := dec.AnteHandle(ctx, tc.malleate(), et.simulate, nextFn)
+				_, err := dec.AnteHandle(ctx, tc.malleate(), et.simulate, NextFn)

 				if tc.expPass {
 					s.Require().NoError(err, tc.name)
@@ -325,7 +325,7 @@ func (s AnteTestSuite) TestEthMinGasPriceDecorator() {
 				// s.SetupTest(et.isCheckTx)
 				s.SetupTest()
 				dec := ante.NewEthMinGasPriceDecorator(s.app.FeeMarketKeeper, s.app.EvmKeeper)
-				_, err := dec.AnteHandle(s.ctx, tc.malleate(), et.simulate, nextFn)
+				_, err := dec.AnteHandle(s.ctx, tc.malleate(), et.simulate, NextFn)

 				if tc.expPass {
 					s.Require().NoError(err, tc.name)
@@ -59,6 +59,7 @@ func newEthAnteHandler(options HandlerOptions) sdk.AnteHandler {
 		NewEthGasConsumeDecorator(options.EvmKeeper, options.MaxTxGasWanted),
 		NewEthIncrementSenderSequenceDecorator(options.AccountKeeper), // innermost AnteDecorator.
 		NewEthEmitEventDecorator(options.EvmKeeper),                   // emit eth tx hash and index at the very last ante handler.
+		NewGasWantedDecorator(options.EvmKeeper, options.FeeMarketKeeper),
 	)
 }

@@ -81,6 +82,7 @@ func newCosmosAnteHandler(options HandlerOptions) sdk.AnteHandler {
 		ante.NewSigVerificationDecorator(options.AccountKeeper, options.SignModeHandler),
 		ante.NewIncrementSequenceDecorator(options.AccountKeeper),
 		ibcante.NewAnteDecorator(options.IBCKeeper),
+		NewGasWantedDecorator(options.EvmKeeper, options.FeeMarketKeeper),
 	)
 }

@@ -105,5 +107,6 @@ func newCosmosAnteHandlerEip712(options HandlerOptions) sdk.AnteHandler {
 		NewEip712SigVerificationDecorator(options.AccountKeeper, options.SignModeHandler),
 		ante.NewIncrementSequenceDecorator(options.AccountKeeper),
 		ibcante.NewAnteDecorator(options.IBCKeeper),
+		NewGasWantedDecorator(options.EvmKeeper, options.FeeMarketKeeper),
 	)
 }
@@ -37,4 +37,5 @@ type protoTxProvider interface {
 // FeeMarketKeeper defines the expected keeper interface used on the AnteHandler
 type FeeMarketKeeper interface {
 	GetParams(ctx sdk.Context) (params feemarkettypes.Params)
+	AddTransientGasWanted(ctx sdk.Context, gasWanted uint64) (uint64, error)
 }
@@ -55,6 +55,8 @@ type AnteTestSuite struct {
 	evmParamsOption func(*evmtypes.Params)
 }

+const TestGasLimit uint64 = 100000
+
 func (suite *AnteTestSuite) StateDB() *statedb.StateDB {
 	return statedb.New(suite.ctx, suite.app.EvmKeeper, statedb.NewEmptyTxConfig(common.BytesToHash(suite.ctx.HeaderHash().Bytes())))
 }
@@ -139,13 +141,13 @@ func (s *AnteTestSuite) BuildTestEthTx(
 		s.ctx,
 		common.BytesToAddress(from.Bytes()),
 	)
-	gasLimit := uint64(100000)
+
 	msgEthereumTx := evmtypes.NewTx(
 		chainID,
 		nonce,
 		&to,
 		amount,
-		gasLimit,
+		TestGasLimit,
 		gasPrice,
 		gasFeeCap,
 		gasTipCap,
@@ -237,11 +239,10 @@ func (suite *AnteTestSuite) CreateTestTxBuilder(
 }

 func (suite *AnteTestSuite) CreateTestCosmosTxBuilder(gasPrice sdk.Int, denom string, msgs ...sdk.Msg) client.TxBuilder {
-	gasLimit := uint64(1000000)
 	txBuilder := suite.clientCtx.TxConfig.NewTxBuilder()

-	txBuilder.SetGasLimit(gasLimit)
-	fees := &sdk.Coins{{Denom: denom, Amount: gasPrice.MulRaw(int64(gasLimit))}}
+	txBuilder.SetGasLimit(TestGasLimit)
+	fees := &sdk.Coins{{Denom: denom, Amount: gasPrice.MulRaw(int64(TestGasLimit))}}
 	txBuilder.SetFeeAmount(*fees)
 	err := txBuilder.SetMsgs(msgs...)
 	suite.Require().NoError(err)
@@ -330,6 +331,10 @@ func (suite *AnteTestSuite) CreateTestEIP712CosmosTxBuilder(
 	return builder
 }

+func NextFn(ctx sdk.Context, _ sdk.Tx, _ bool) (sdk.Context, error) {
+	return ctx, nil
+}
+
 var _ sdk.Tx = &invalidTx{}

 type invalidTx struct{}
@@ -276,7 +276,7 @@ func NewEthermintApp(
 	)

 	// Add the EVM transient store key
-	tkeys := sdk.NewTransientStoreKeys(paramstypes.TStoreKey, evmtypes.TransientKey)
+	tkeys := sdk.NewTransientStoreKeys(paramstypes.TStoreKey, evmtypes.TransientKey, feemarkettypes.TransientKey)
 	memKeys := sdk.NewMemoryStoreKeys(capabilitytypes.MemStoreKey)

 	app := &EthermintApp{
@@ -344,7 +344,7 @@ func NewEthermintApp(

 	// Create Ethermint keepers
 	app.FeeMarketKeeper = feemarketkeeper.NewKeeper(
-		appCodec, keys[feemarkettypes.StoreKey], app.GetSubspace(feemarkettypes.ModuleName),
+		appCodec, app.GetSubspace(feemarkettypes.ModuleName), keys[feemarkettypes.StoreKey], tkeys[feemarkettypes.TransientKey],
 	)

 	app.EvmKeeper = evmkeeper.NewKeeper(