Problem: contract call which does lots of message calls is slow to execute

CHANGELOG.md

@@ -52,6 +52,7 @@ Ref: https://keepachangelog.com/en/1.0.0/
 * (evm) Reject invalid `MsgEthereumTx` wrapping tx
 * (evm) Fix `SelfDestruct` opcode by deleting account code and state.
 * (feemarket) [tharsis#855](https://github.com/tharsis/ethermint/pull/855) consistent `BaseFee` check logic.
+* (evm) [tharsis#729](https://github.com/tharsis/ethermint/pull/729) Refactor EVM StateDB implementation.
 
 ### Improvements
 

app/ante/ante_test.go

@@ -23,7 +23,7 @@ func (suite AnteTestSuite) TestAnteHandler() {
  suite.Require().NoError(acc.SetSequence(1))
  suite.app.AccountKeeper.SetAccount(suite.ctx, acc)
 
- suite.app.EvmKeeper.AddBalance(addr, big.NewInt(10000000000))
+ suite.app.EvmKeeper.SetBalance(suite.ctx, addr, big.NewInt(10000000000))
 
  suite.app.FeeMarketKeeper.SetBaseFee(suite.ctx, big.NewInt(100))
 
@@ -577,7 +577,7 @@ func (suite AnteTestSuite) TestAnteHandlerWithDynamicTxFee() {
  suite.app.AccountKeeper.SetAccount(suite.ctx, acc)
 
  suite.ctx = suite.ctx.WithIsCheckTx(tc.checkTx).WithIsReCheckTx(tc.reCheckTx)
- suite.app.EvmKeeper.AddBalance(addr, big.NewInt((ethparams.InitialBaseFee+10)*100000))
+ suite.app.EvmKeeper.SetBalance(suite.ctx, addr, big.NewInt((ethparams.InitialBaseFee+10)*100000))
  _, err := suite.anteHandler(suite.ctx, tc.txFn(), false)
  if tc.expPass {
  suite.Require().NoError(err)

app/ante/eth.go

@@ -10,6 +10,7 @@ import (
 
  ethermint "github.com/tharsis/ethermint/types"
  evmkeeper "github.com/tharsis/ethermint/x/evm/keeper"
+ "github.com/tharsis/ethermint/x/evm/statedb"
  evmtypes "github.com/tharsis/ethermint/x/evm/types"
 
  "github.com/ethereum/go-ethereum/common"
@@ -95,9 +96,6 @@ func (avd EthAccountVerificationDecorator) AnteHandle(ctx sdk.Context, tx sdk.Tx
  return next(ctx, tx, simulate)
  }
 
- avd.evmKeeper.WithContext(ctx)
- evmDenom := avd.evmKeeper.GetParams(ctx).EvmDenom
-
  for i, msg := range tx.GetMsgs() {
  msgEthTx, ok := msg.(*evmtypes.MsgEthereumTx)
  if !ok {
@@ -117,25 +115,25 @@ func (avd EthAccountVerificationDecorator) AnteHandle(ctx sdk.Context, tx sdk.Tx
 
  // check whether the sender address is EOA
  fromAddr := common.BytesToAddress(from)
- codeHash := avd.evmKeeper.GetCodeHash(fromAddr)
- if codeHash != common.BytesToHash(evmtypes.EmptyCodeHash) {
+ acct, err := avd.evmKeeper.GetAccount(ctx, fromAddr)
+ if err != nil {
  return ctx, sdkerrors.Wrapf(sdkerrors.ErrInvalidType,
- "the sender is not EOA: address <%v>, codeHash <%s>", fromAddr, codeHash)
+ "the sender is not EthAccount: address %s", fromAddr)
  }
-
- acc := avd.ak.GetAccount(ctx, from)
- if acc == nil {
- acc = avd.ak.NewAccountWithAddress(ctx, from)
+ if acct == nil {
+ acc := avd.ak.NewAccountWithAddress(ctx, from)
  avd.ak.SetAccount(ctx, acc)
+ acct = statedb.NewEmptyAccount()
+ } else if acct.IsContract() {
+ return ctx, sdkerrors.Wrapf(sdkerrors.ErrInvalidType,
+ "the sender is not EOA: address %s, codeHash <%s>", fromAddr, acct.CodeHash)
  }
 
- if err := evmkeeper.CheckSenderBalance(ctx, avd.bankKeeper, from, txData, evmDenom); err != nil {
+ if err := evmkeeper.CheckSenderBalance(sdk.NewIntFromBigInt(acct.Balance), txData); err != nil {
  return ctx, sdkerrors.Wrap(err, "failed to check sender balance")
  }
 
  }
- // recover the original gas meter
- avd.evmKeeper.WithContext(ctx)
  return next(ctx, tx, simulate)
 }
 
@@ -221,9 +219,6 @@ func NewEthGasConsumeDecorator(
 // - user doesn't have enough balance to deduct the transaction fees (gas_limit * gas_price)
 // - transaction or block gas meter runs out of gas
 func (egcd EthGasConsumeDecorator) AnteHandle(ctx sdk.Context, tx sdk.Tx, simulate bool, next sdk.AnteHandler) (newCtx sdk.Context, err error) {
- // reset the refund gas value in the keeper for the current transaction
- egcd.evmKeeper.ResetRefundTransient(ctx)
-
  params := egcd.evmKeeper.GetParams(ctx)
 
  ethCfg := params.ChainConfig.EthereumConfig(egcd.evmKeeper.ChainID())
@@ -278,8 +273,6 @@ func (egcd EthGasConsumeDecorator) AnteHandle(ctx sdk.Context, tx sdk.Tx, simula
  }
 
  // we know that we have enough gas on the pool to cover the intrinsic gas
- // set up the updated context to the evm Keeper
- egcd.evmKeeper.WithContext(ctx)
  return next(ctx, tx, simulate)
 }
 
@@ -301,8 +294,6 @@ func NewCanTransferDecorator(evmKeeper EVMKeeper, fmk evmtypes.FeeMarketKeeper)
 // AnteHandle creates an EVM from the message and calls the BlockContext CanTransfer function to
 // see if the address can execute the transaction.
 func (ctd CanTransferDecorator) AnteHandle(ctx sdk.Context, tx sdk.Tx, simulate bool, next sdk.AnteHandler) (sdk.Context, error) {
- ctd.evmKeeper.WithContext(ctx)
-
  params := ctd.evmKeeper.GetParams(ctx)
  ethCfg := params.ChainConfig.EthereumConfig(ctd.evmKeeper.ChainID())
  signer := ethtypes.MakeSigner(ethCfg, big.NewInt(ctx.BlockHeight()))
@@ -330,11 +321,12 @@ func (ctd CanTransferDecorator) AnteHandle(ctx sdk.Context, tx sdk.Tx, simulate
  CoinBase: common.Address{},
  BaseFee: baseFee,
  }
- evm := ctd.evmKeeper.NewEVM(coreMsg, cfg, evmtypes.NewNoOpTracer())
+ stateDB := statedb.New(ctx, ctd.evmKeeper, statedb.NewEmptyTxConfig(common.BytesToHash(ctx.HeaderHash().Bytes())))
+ evm := ctd.evmKeeper.NewEVM(ctx, coreMsg, cfg, evmtypes.NewNoOpTracer(), stateDB)
 
  // check that caller has enough balance to cover asset transfer for **topmost** call
  // NOTE: here the gas consumed is from the context with the infinite gas meter
- if coreMsg.Value().Sign() > 0 && !evm.Context.CanTransfer(ctd.evmKeeper, coreMsg.From(), coreMsg.Value()) {
+ if coreMsg.Value().Sign() > 0 && !evm.Context.CanTransfer(stateDB, coreMsg.From(), coreMsg.Value()) {
  return ctx, sdkerrors.Wrapf(
  sdkerrors.ErrInsufficientFunds,
  "failed to transfer %s from address %s using the EVM block context transfer function",
@@ -360,7 +352,6 @@ func (ctd CanTransferDecorator) AnteHandle(ctx sdk.Context, tx sdk.Tx, simulate
  }
  }
 
- // set the original gas meter
  return next(ctx, tx, simulate)
 }
 
@@ -422,8 +413,6 @@ func (vbd EthValidateBasicDecorator) AnteHandle(ctx sdk.Context, tx sdk.Tx, simu
  return next(ctx, tx, simulate)
  }
 
- vbd.evmKeeper.WithContext(ctx)
-
  err := tx.ValidateBasic()
  // ErrNoSignatures is fine with eth tx
  if err != nil && !errors.Is(err, sdkerrors.ErrNoSignatures) {

app/ante/eth_test.go

@@ -7,6 +7,7 @@ import (
 
  "github.com/tharsis/ethermint/app/ante"
  "github.com/tharsis/ethermint/tests"
+ "github.com/tharsis/ethermint/x/evm/statedb"
  evmtypes "github.com/tharsis/ethermint/x/evm/types"
 
  ethtypes "github.com/ethereum/go-ethereum/core/types"
@@ -65,6 +66,8 @@ func (suite AnteTestSuite) TestNewEthAccountVerificationDecorator() {
  tx := evmtypes.NewTxContract(suite.app.EvmKeeper.ChainID(), 1, big.NewInt(10), 1000, big.NewInt(1), nil, nil, nil, nil)
  tx.From = addr.Hex()
 
+ var vmdb *statedb.StateDB
+
  testCases := []struct {
  name string
  tx sdk.Tx
@@ -86,7 +89,7 @@ func (suite AnteTestSuite) TestNewEthAccountVerificationDecorator() {
  tx,
  func() {
  // set not as an EOA
- suite.app.EvmKeeper.SetCode(addr, []byte("1"))
+ vmdb.SetCode(addr, []byte("1"))
  },
  true,
  false,
@@ -96,7 +99,7 @@ func (suite AnteTestSuite) TestNewEthAccountVerificationDecorator() {
  tx,
  func() {
  // reset back to EOA
- suite.app.EvmKeeper.SetCode(addr, nil)
+ vmdb.SetCode(addr, nil)
  },
  true,
  false,
@@ -105,7 +108,7 @@ func (suite AnteTestSuite) TestNewEthAccountVerificationDecorator() {
  "success new account",
  tx,
  func() {
- suite.app.EvmKeeper.AddBalance(addr, big.NewInt(1000000))
+ vmdb.AddBalance(addr, big.NewInt(1000000))
  },
  true,
  true,
@@ -117,7 +120,7 @@ func (suite AnteTestSuite) TestNewEthAccountVerificationDecorator() {
  acc := suite.app.AccountKeeper.NewAccountWithAddress(suite.ctx, addr.Bytes())
  suite.app.AccountKeeper.SetAccount(suite.ctx, acc)
 
- suite.app.EvmKeeper.AddBalance(addr, big.NewInt(1000000))
+ vmdb.AddBalance(addr, big.NewInt(1000000))
  },
  true,
  true,
@@ -126,7 +129,10 @@ func (suite AnteTestSuite) TestNewEthAccountVerificationDecorator() {
 
  for _, tc := range testCases {
  suite.Run(tc.name, func() {
+ vmdb = suite.StateDB()
  tc.malleate()
+ suite.Require().NoError(vmdb.Commit())
+
  _, err := dec.AnteHandle(suite.ctx.WithIsCheckTx(tc.checkTx), tc.tx, false, nextFn)
 
  if tc.expPass {
@@ -204,6 +210,8 @@ func (suite AnteTestSuite) TestEthGasConsumeDecorator() {
  tx2 := evmtypes.NewTxContract(suite.app.EvmKeeper.ChainID(), 1, big.NewInt(10), 1000000, big.NewInt(1), nil, nil, nil, &ethtypes.AccessList{{Address: addr, StorageKeys: nil}})
  tx2.From = addr.Hex()
 
+ var vmdb *statedb.StateDB
+
  testCases := []struct {
  name string
  tx sdk.Tx
@@ -221,40 +229,28 @@ func (suite AnteTestSuite) TestEthGasConsumeDecorator() {
  {
  "gas limit too low",
  tx,
- func() {
- acc := suite.app.AccountKeeper.NewAccountWithAddress(suite.ctx, addr.Bytes())
- suite.app.AccountKeeper.SetAccount(suite.ctx, acc)
- },
+ func() {},
  false, false,
  },
  {
  "not enough balance for fees",
  tx2,
- func() {
- acc := suite.app.AccountKeeper.NewAccountWithAddress(suite.ctx, addr.Bytes())
- suite.app.AccountKeeper.SetAccount(suite.ctx, acc)
- },
+ func() {},
  false, false,
  },
  {
  "not enough tx gas",
  tx2,
  func() {
- acc := suite.app.AccountKeeper.NewAccountWithAddress(suite.ctx, addr.Bytes())
- suite.app.AccountKeeper.SetAccount(suite.ctx, acc)
-
- suite.app.EvmKeeper.AddBalance(addr, big.NewInt(1000000))
+ vmdb.AddBalance(addr, big.NewInt(1000000))
  },
  false, true,
  },
  {
  "not enough block gas",
  tx2,
  func() {
- acc := suite.app.AccountKeeper.NewAccountWithAddress(suite.ctx, addr.Bytes())
- suite.app.AccountKeeper.SetAccount(suite.ctx, acc)
-
- suite.app.EvmKeeper.AddBalance(addr, big.NewInt(1000000))
+ vmdb.AddBalance(addr, big.NewInt(1000000))
 
  suite.ctx = suite.ctx.WithBlockGasMeter(sdk.NewGasMeter(1))
  },
@@ -264,10 +260,7 @@ func (suite AnteTestSuite) TestEthGasConsumeDecorator() {
  "success",
  tx2,
  func() {
- acc := suite.app.AccountKeeper.NewAccountWithAddress(suite.ctx, addr.Bytes())
- suite.app.AccountKeeper.SetAccount(suite.ctx, acc)
-
- suite.app.EvmKeeper.AddBalance(addr, big.NewInt(1000000))
+ vmdb.AddBalance(addr, big.NewInt(1000000))
 
  suite.ctx = suite.ctx.WithBlockGasMeter(sdk.NewGasMeter(10000000000000000000))
  },
@@ -277,7 +270,9 @@ func (suite AnteTestSuite) TestEthGasConsumeDecorator() {
 
  for _, tc := range testCases {
  suite.Run(tc.name, func() {
+ vmdb = suite.StateDB()
  tc.malleate()
+ suite.Require().NoError(vmdb.Commit())
 
  if tc.expPanic {
  suite.Require().Panics(func() {
@@ -331,6 +326,8 @@ func (suite AnteTestSuite) TestCanTransferDecorator() {
  err := tx.Sign(suite.ethSigner, tests.NewSigner(privKey))
  suite.Require().NoError(err)
 
+ var vmdb *statedb.StateDB
+
  testCases := []struct {
  name string
  tx sdk.Tx
@@ -355,15 +352,17 @@ func (suite AnteTestSuite) TestCanTransferDecorator() {
  acc := suite.app.AccountKeeper.NewAccountWithAddress(suite.ctx, addr.Bytes())
  suite.app.AccountKeeper.SetAccount(suite.ctx, acc)
 
- suite.app.EvmKeeper.AddBalance(addr, big.NewInt(1000000))
+ vmdb.AddBalance(addr, big.NewInt(1000000))
  },
  true,
  },
  }
 
  for _, tc := range testCases {
  suite.Run(tc.name, func() {
+ vmdb = suite.StateDB()
  tc.malleate()
+ suite.Require().NoError(vmdb.Commit())
 
  _, err := dec.AnteHandle(suite.ctx.WithIsCheckTx(true), tc.tx, false, nextFn)
 
@@ -458,7 +457,7 @@ func (suite AnteTestSuite) TestEthIncrementSenderSequenceDecorator() {
  txData, err := evmtypes.UnpackTxData(msg.Data)
  suite.Require().NoError(err)
 
- nonce := suite.app.EvmKeeper.GetNonce(addr)
+ nonce := suite.app.EvmKeeper.GetNonce(suite.ctx, addr)
  suite.Require().Equal(txData.GetNonce()+1, nonce)
  } else {
  suite.Require().Error(err)

app/ante/interfaces.go

@@ -5,23 +5,20 @@ import (
 
  sdk "github.com/cosmos/cosmos-sdk/types"
  tx "github.com/cosmos/cosmos-sdk/types/tx"
- "github.com/ethereum/go-ethereum/common"
  "github.com/ethereum/go-ethereum/core"
  "github.com/ethereum/go-ethereum/core/vm"
  "github.com/ethereum/go-ethereum/params"
+ "github.com/tharsis/ethermint/x/evm/statedb"
  evmtypes "github.com/tharsis/ethermint/x/evm/types"
 )
 
 // EVMKeeper defines the expected keeper interface used on the Eth AnteHandler
 type EVMKeeper interface {
- vm.StateDB
+ statedb.Keeper
 
  ChainID() *big.Int
  GetParams(ctx sdk.Context) evmtypes.Params
- WithContext(ctx sdk.Context)
- ResetRefundTransient(ctx sdk.Context)
- NewEVM(msg core.Message, cfg *evmtypes.EVMConfig, tracer vm.Tracer) *vm.EVM
- GetCodeHash(addr common.Address) common.Hash
+ NewEVM(ctx sdk.Context, msg core.Message, cfg *evmtypes.EVMConfig, tracer vm.Tracer, stateDB vm.StateDB) *vm.EVM
  DeductTxCostsFromUserBalance(
  ctx sdk.Context, msgEthTx evmtypes.MsgEthereumTx, txData evmtypes.TxData, denom string, homestead, istanbul, london bool,
  ) (sdk.Coins, error)

app/ante/sigs_test.go

@@ -4,6 +4,7 @@ import (
  "math/big"
 
  "github.com/tharsis/ethermint/tests"
+ "github.com/tharsis/ethermint/x/evm/statedb"
  evmtypes "github.com/tharsis/ethermint/x/evm/types"
 )
 
@@ -14,11 +15,11 @@ func (suite AnteTestSuite) TestSignatures() {
  addr, privKey := tests.NewAddrKey()
  to := tests.GenerateAddress()
 
- acc := suite.app.AccountKeeper.NewAccountWithAddress(suite.ctx, addr.Bytes())
- suite.Require().NoError(acc.SetSequence(1))
- suite.app.AccountKeeper.SetAccount(suite.ctx, acc)
+ acc := statedb.NewEmptyAccount()
+ acc.Nonce = 1
+ acc.Balance = big.NewInt(10000000000)
 
- suite.app.EvmKeeper.AddBalance(addr, big.NewInt(10000000000))
+ suite.app.EvmKeeper.SetAccount(suite.ctx, addr, *acc)
  msgEthereumTx := evmtypes.NewTx(suite.app.EvmKeeper.ChainID(), 1, &to, big.NewInt(10), 100000, big.NewInt(1), nil, nil, nil, nil)
  msgEthereumTx.From = addr.Hex()
 

app/ante/utils_test.go

@@ -5,6 +5,7 @@ import (
  "testing"
  "time"
 
+ "github.com/ethereum/go-ethereum/common"
  ethtypes "github.com/ethereum/go-ethereum/core/types"
 
  "github.com/stretchr/testify/suite"
@@ -25,6 +26,7 @@ import (
  ante "github.com/tharsis/ethermint/app/ante"
  "github.com/tharsis/ethermint/encoding"
  "github.com/tharsis/ethermint/tests"
+ "github.com/tharsis/ethermint/x/evm/statedb"
  evmtypes "github.com/tharsis/ethermint/x/evm/types"
  feemarkettypes "github.com/tharsis/ethermint/x/feemarket/types"
 
@@ -43,6 +45,10 @@ type AnteTestSuite struct {
  enableLondonHF bool
 }
 
+func (suite *AnteTestSuite) StateDB() *statedb.StateDB {
+ return statedb.New(suite.ctx, suite.app.EvmKeeper, statedb.NewEmptyTxConfig(common.BytesToHash(suite.ctx.HeaderHash().Bytes())))
+}
+
 func (suite *AnteTestSuite) SetupTest() {
  checkTx := false