evm: remove CommitStateDB, journal and stateObject (#84)

* evm: remove CommitStateDB and stateObject

* imported build fixes

* lint

* rm set nonce

* update account response

* changelog

Author: fedekunze

CHANGELOG.md

@@ -39,6 +39,7 @@ Ref: https://keepachangelog.com/en/1.0.0/
 
 ### State Machine Breaking
 
+* (evm) [tharsis#84](https://github.com/tharsis/ethermint/pull/84) Remove `journal`, `CommitStateDB` and `stateObjects`.
 * (rpc, evm) [tharsis#81](https://github.com/tharsis/ethermint/pull/81) Remove tx `Receipt` from store and replace it with fields obtained from the Tendermint RPC client.
 * (evm) [tharsis#72](https://github.com/tharsis/ethermint/issues/72) Update `AccessList` to use `TransientStore` instead of map.
 * (evm) [tharsis#68](https://github.com/tharsis/ethermint/issues/68) Replace block hash storage map to use staking `HistoricalInfo`.

app/app.go

@@ -385,7 +385,7 @@ func NewEthermintApp(
 		params.NewAppModule(app.ParamsKeeper),
 		transferModule,
 		// Ethermint app modules
-		evm.NewAppModule(app.EvmKeeper, app.AccountKeeper, app.BankKeeper),
+		evm.NewAppModule(app.EvmKeeper, app.AccountKeeper),
 	)
 
 	// During begin block slashing happens after distr.BeginBlocker so that

docs/core/proto-docs.md

@@ -427,7 +427,7 @@ QueryAccountResponse is the response type for the Query/Account RPC method.
 | Field | Type | Label | Description |
 | ----- | ---- | ----- | ----------- |
 | `balance` | [string](#string) |  | balance is the balance of the EVM denomination. |
-| `code_hash` | [bytes](#bytes) |  | code_hash is the code bytes from the EOA. |
+| `code_hash` | [string](#string) |  | code hash is the hex-formatted code bytes from the EOA. |
 | `nonce` | [uint64](#uint64) |  | nonce is the account's sequence number. |
 
 

go.mod

@@ -45,7 +45,7 @@ require (
 	github.com/tyler-smith/go-bip39 v1.1.0
 	github.com/xlab/closer v0.0.0-20190328110542-03326addb7c2
 	github.com/xlab/suplog v1.3.0
-	golang.org/x/crypto v0.0.0-20210513164829-c07d793c2f9a
+	golang.org/x/crypto v0.0.0-20210513164829-c07d793c2f9a // indirect
 	google.golang.org/genproto v0.0.0-20210607140030-00d4fb20b1ae
 	google.golang.org/grpc v1.38.0
 	gopkg.in/yaml.v2 v2.4.0

proto/ethermint/evm/v1alpha1/query.proto

@@ -75,8 +75,8 @@ message QueryAccountRequest {
 message QueryAccountResponse {
   // balance is the balance of the EVM denomination.
   string balance = 1;
-  // code_hash is the code bytes from the EOA.
-  bytes code_hash = 2;
+  // code hash is the hex-formatted code bytes from the EOA.
+  string code_hash = 2;
   // nonce is the account's sequence number.
   uint64 nonce = 3;
 }

tests/importer/importer_test.go

@@ -107,7 +107,7 @@ func createAndTestGenesis(t *testing.T, cms sdk.CommitMultiStore, ak authkeeper.
 	genBlock := ethcore.DefaultGenesisBlock()
 	ms := cms.CacheMultiStore()
 	ctx := sdk.NewContext(ms, tmproto.Header{}, false, logger)
-	evmKeeper.CommitStateDB.WithContext(ctx)
+	evmKeeper.WithContext(ctx)
 
 	// Set the default Ethermint parameters to the parameter keeper store
 	evmKeeper.SetParams(ctx, evmtypes.DefaultParams())
@@ -126,25 +126,19 @@ func createAndTestGenesis(t *testing.T, cms sdk.CommitMultiStore, ak authkeeper.
 		addr := ethcmn.HexToAddress(addrStr)
 		acc := genBlock.Alloc[addr]
 
-		evmKeeper.CommitStateDB.AddBalance(addr, acc.Balance)
-		evmKeeper.CommitStateDB.SetCode(addr, acc.Code)
-		evmKeeper.CommitStateDB.SetNonce(addr, acc.Nonce)
+		evmKeeper.AddBalance(addr, acc.Balance)
+		evmKeeper.SetCode(addr, acc.Code)
+		evmKeeper.SetNonce(addr, acc.Nonce)
 
 		for key, value := range acc.Storage {
-			evmKeeper.CommitStateDB.SetState(addr, key, value)
+			evmKeeper.SetState(addr, key, value)
 		}
 	}
 
 	// get balance of one of the genesis account having 400 ETH
-	b := evmKeeper.CommitStateDB.GetBalance(genInvestor)
+	b := evmKeeper.GetBalance(genInvestor)
 	require.Equal(t, "200000000000000000000", b.String())
 
-	// commit the stateDB with 'false' to delete empty objects
-	//
-	// NOTE: Commit does not yet return the intra merkle root (version)
-	_, err := evmKeeper.CommitStateDB.Commit(false)
-	require.NoError(t, err)
-
 	// persist multi-store cache state
 	ms.Write()
 
@@ -267,15 +261,13 @@ func TestImportBlocks(t *testing.T) {
 		ms := cms.CacheMultiStore()
 		ctx := sdk.NewContext(ms, tmproto.Header{}, false, logger)
 		ctx = ctx.WithBlockHeight(int64(block.NumberU64()))
-		evmKeeper.CommitStateDB.WithContext(ctx)
+		evmKeeper.WithContext(ctx)
 
 		if chainConfig.DAOForkSupport && chainConfig.DAOForkBlock != nil && chainConfig.DAOForkBlock.Cmp(block.Number()) == 0 {
 			applyDAOHardFork(evmKeeper)
 		}
 
-		for i, tx := range block.Transactions() {
-			evmKeeper.CommitStateDB.Prepare(tx.Hash(), block.Hash(), i)
-			// evmKeeper.CommitStateDB.Set(block.Hash())
+		for _, tx := range block.Transactions() {
 
 			receipt, gas, err := applyTransaction(
 				chainConfig, chainContext, nil, gp, evmKeeper, header, tx, usedGas, vmConfig,
@@ -287,10 +279,6 @@ func TestImportBlocks(t *testing.T) {
 		// apply mining rewards
 		accumulateRewards(chainConfig, evmKeeper, header, block.Uncles())
 
-		// commit stateDB
-		_, err := evmKeeper.CommitStateDB.Commit(chainConfig.IsEIP158(block.Number()))
-		require.NoError(t, err, "failed to commit StateDB")
-
 		// simulate BaseApp EndBlocker commitment
 		ms.Write()
 		cms.Commit()
@@ -325,12 +313,12 @@ func accumulateRewards(
 		r.Sub(r, header.Number)
 		r.Mul(r, blockReward)
 		r.Div(r, rewardBig8)
-		evmKeeper.CommitStateDB.AddBalance(uncle.Coinbase, r)
+		evmKeeper.AddBalance(uncle.Coinbase, r)
 		r.Div(blockReward, rewardBig32)
 		reward.Add(reward, r)
 	}
 
-	evmKeeper.CommitStateDB.AddBalance(header.Coinbase, reward)
+	evmKeeper.AddBalance(header.Coinbase, reward)
 }
 
 // ApplyDAOHardFork modifies the state database according to the DAO hard-fork
@@ -341,14 +329,13 @@ func accumulateRewards(
 // Ref: https://github.com/ethereum/go-ethereum/blob/52f2461774bcb8cdd310f86b4bc501df5b783852/consensus/misc/dao.go#L74
 func applyDAOHardFork(evmKeeper *evmkeeper.Keeper) {
 	// Retrieve the contract to refund balances into
-	if !evmKeeper.CommitStateDB.Exist(ethparams.DAORefundContract) {
-		evmKeeper.CommitStateDB.CreateAccount(ethparams.DAORefundContract)
+	if !evmKeeper.Exist(ethparams.DAORefundContract) {
+		evmKeeper.CreateAccount(ethparams.DAORefundContract)
 	}
 
 	// Move every DAO account and extra-balance account funds into the refund contract
 	for _, addr := range ethparams.DAODrainList() {
-		evmKeeper.CommitStateDB.AddBalance(ethparams.DAORefundContract, evmKeeper.CommitStateDB.GetBalance(addr))
-		evmKeeper.CommitStateDB.SetBalance(addr, new(big.Int))
+		evmKeeper.AddBalance(ethparams.DAORefundContract, evmKeeper.GetBalance(addr))
 	}
 }
 
@@ -374,7 +361,7 @@ func applyTransaction(
 
 	// Create a new environment which holds all relevant information
 	// about the transaction and calling mechanisms.
-	vmenv := ethvm.NewEVM(blockCtx, txCtx, evmKeeper.CommitStateDB, config, cfg)
+	vmenv := ethvm.NewEVM(blockCtx, txCtx, evmKeeper, config, cfg)
 
 	// Apply the transaction to the current state (included in the env)
 	execResult, err := ethcore.ApplyMessage(vmenv, msg, gp)
@@ -383,19 +370,11 @@ func applyTransaction(
 		return &ethtypes.Receipt{}, 0, nil
 	}
 
-	// Update the state with pending changes
-	var intRoot ethcmn.Hash
-	if config.IsByzantium(header.Number) {
-		err = evmKeeper.CommitStateDB.Finalise(true)
-	} else {
-		intRoot, err = evmKeeper.CommitStateDB.IntermediateRoot(config.IsEIP158(header.Number))
-	}
-
 	if err != nil {
 		return nil, execResult.UsedGas, err
 	}
 
-	root := intRoot.Bytes()
+	root := ethcmn.Hash{}.Bytes()
 	*usedGas += execResult.UsedGas
 
 	// Create a new receipt for the transaction, storing the intermediate root and gas used by the tx
@@ -410,11 +389,11 @@ func applyTransaction(
 	}
 
 	// Set the receipt logs and create a bloom for filtering
-	receipt.Logs, err = evmKeeper.CommitStateDB.GetLogs(tx.Hash())
+	receipt.Logs = evmKeeper.GetTxLogs(tx.Hash())
 	receipt.Bloom = ethtypes.CreateBloom(ethtypes.Receipts{receipt})
-	receipt.BlockHash = evmKeeper.CommitStateDB.BlockHash()
+	receipt.BlockHash = header.Hash()
 	receipt.BlockNumber = header.Number
-	receipt.TransactionIndex = uint(evmKeeper.CommitStateDB.TxIndex())
+	receipt.TransactionIndex = uint(evmKeeper.GetTxIndexTransient())
 
 	return receipt, execResult.UsedGas, err
 }

x/evm/genesis.go

@@ -18,16 +18,12 @@ func InitGenesis(
 	ctx sdk.Context,
 	k *keeper.Keeper,
 	accountKeeper types.AccountKeeper, // nolint: interfacer
-	bankKeeper types.BankKeeper,
 	data types.GenesisState,
 ) []abci.ValidatorUpdate {
 	k.WithContext(ctx)
 	k.WithChainID(ctx)
 
-	k.CommitStateDB.WithContext(ctx)
-
 	k.SetParams(ctx, data.Params)
-	evmDenom := data.Params.EvmDenom
 
 	for _, account := range data.Accounts {
 		address := ethcmn.HexToAddress(account.Address)
@@ -47,46 +43,25 @@ func InitGenesis(
 			)
 		}
 
-		evmBalance := bankKeeper.GetBalance(ctx, accAddress, evmDenom)
-		k.CommitStateDB.SetBalance(address, evmBalance.Amount.BigInt())
-		k.CommitStateDB.SetNonce(address, acc.GetSequence())
-		k.CommitStateDB.SetCode(address, ethcmn.Hex2Bytes(account.Code))
+		k.SetCode(address, ethcmn.Hex2Bytes(account.Code))
 
 		for _, storage := range account.Storage {
 			k.SetState(address, ethcmn.HexToHash(storage.Key), ethcmn.HexToHash(storage.Value))
 		}
 	}
 
-	var err error
 	for _, txLog := range data.TxsLogs {
-		err = k.CommitStateDB.SetLogs(ethcmn.HexToHash(txLog.Hash), txLog.EthLogs())
-		if err != nil {
-			panic(err)
-		}
+		k.SetLogs(ethcmn.HexToHash(txLog.Hash), txLog.EthLogs())
 	}
 
 	k.SetChainConfig(ctx, data.ChainConfig)
 
-	// set state objects and code to store
-	_, err = k.CommitStateDB.Commit(false)
-	if err != nil {
-		panic(err)
-	}
-
-	// set storage to store
-	// NOTE: don't delete empty object to prevent import-export simulation failure
-	err = k.CommitStateDB.Finalise(false)
-	if err != nil {
-		panic(err)
-	}
-
 	return []abci.ValidatorUpdate{}
 }
 
 // ExportGenesis exports genesis state of the EVM module
 func ExportGenesis(ctx sdk.Context, k *keeper.Keeper, ak types.AccountKeeper) *types.GenesisState {
 	k.WithContext(ctx)
-	k.CommitStateDB.WithContext(ctx)
 
 	// nolint: prealloc
 	var ethGenAccounts []types.GenesisAccount
@@ -106,7 +81,7 @@ func ExportGenesis(ctx sdk.Context, k *keeper.Keeper, ak types.AccountKeeper) *t
 
 		genAccount := types.GenesisAccount{
 			Address: addr.String(),
-			Code:    ethcmn.Bytes2Hex(k.CommitStateDB.GetCode(addr)),
+			Code:    ethcmn.Bytes2Hex(k.GetCode(addr)),
 			Storage: storage,
 		}
 

x/evm/genesis_test.go

@@ -91,13 +91,13 @@ func (suite *EvmTestSuite) TestInitGenesis() {
 			if tc.expPanic {
 				suite.Require().Panics(
 					func() {
-						_ = evm.InitGenesis(suite.ctx, suite.app.EvmKeeper, suite.app.AccountKeeper, suite.app.BankKeeper, *tc.genState)
+						_ = evm.InitGenesis(suite.ctx, suite.app.EvmKeeper, suite.app.AccountKeeper, *tc.genState)
 					},
 				)
 			} else {
 				suite.Require().NotPanics(
 					func() {
-						_ = evm.InitGenesis(suite.ctx, suite.app.EvmKeeper, suite.app.AccountKeeper, suite.app.BankKeeper, *tc.genState)
+						_ = evm.InitGenesis(suite.ctx, suite.app.EvmKeeper, suite.app.AccountKeeper, *tc.genState)
 					},
 				)
 			}

x/evm/handler.go

@@ -8,12 +8,11 @@ import (
 	sdk "github.com/cosmos/cosmos-sdk/types"
 	sdkerrors "github.com/cosmos/cosmos-sdk/types/errors"
 
-	"github.com/cosmos/ethermint/x/evm/keeper"
 	"github.com/cosmos/ethermint/x/evm/types"
 )
 
 // NewHandler returns a handler for Ethermint type messages.
-func NewHandler(k *keeper.Keeper) sdk.Handler {
+func NewHandler(server types.MsgServer) sdk.Handler {
 	return func(ctx sdk.Context, msg sdk.Msg) (result *sdk.Result, err error) {
 		defer Recover(&err)
 
@@ -22,7 +21,7 @@ func NewHandler(k *keeper.Keeper) sdk.Handler {
 		switch msg := msg.(type) {
 		case *types.MsgEthereumTx:
 			// execute state transition
-			res, err := k.EthereumTx(sdk.WrapSDKContext(ctx), msg)
+			res, err := server.EthereumTx(sdk.WrapSDKContext(ctx), msg)
 			return sdk.WrapServiceResult(ctx, res, err)
 
 		default:

x/evm/handler_test.go

@@ -49,7 +49,7 @@ func (suite *EvmTestSuite) SetupTest() {
 
 	suite.app = app.Setup(checkTx)
 	suite.ctx = suite.app.BaseApp.NewContext(checkTx, tmproto.Header{Height: 1, ChainID: "ethermint-1", Time: time.Now().UTC()})
-	suite.app.EvmKeeper.CommitStateDB.WithContext(suite.ctx)
+	suite.app.EvmKeeper.WithContext(suite.ctx)
 	suite.handler = evm.NewHandler(suite.app.EvmKeeper)
 	suite.codec = suite.app.AppCodec()
 	suite.chainID = suite.app.EvmKeeper.ChainID()
@@ -84,7 +84,6 @@ func (suite *EvmTestSuite) TestHandleMsgEthereumTx() {
 		{
 			"passed",
 			func() {
-				suite.app.EvmKeeper.CommitStateDB.SetBalance(suite.from, big.NewInt(100))
 				to := ethcmn.BytesToAddress(suite.to)
 				tx = types.NewMsgEthereumTx(suite.chainID, 0, &to, big.NewInt(100), 0, big.NewInt(10000), nil, nil)
 				tx.From = suite.from.String()
@@ -189,11 +188,10 @@ func (suite *EvmTestSuite) TestHandlerLogs() {
 	suite.Require().Equal(len(txResponse.Logs[0].Topics), 2)
 
 	hash := []byte{1}
-	err = suite.app.EvmKeeper.CommitStateDB.SetLogs(ethcmn.BytesToHash(hash), types.LogsToEthereum(txResponse.Logs))
+	suite.app.EvmKeeper.SetLogs(ethcmn.BytesToHash(hash), types.LogsToEthereum(txResponse.Logs))
 	suite.Require().NoError(err)
 
-	logs, err := suite.app.EvmKeeper.CommitStateDB.GetLogs(ethcmn.BytesToHash(hash))
-	suite.Require().NoError(err, "failed to get logs")
+	logs := suite.app.EvmKeeper.GetTxLogs(ethcmn.BytesToHash(hash))
 
 	suite.Require().Equal(logs, txResponse.Logs)
 }
@@ -310,8 +308,6 @@ func (suite *EvmTestSuite) TestSendTransaction() {
 	gasLimit := uint64(21000)
 	gasPrice := big.NewInt(0x55ae82600)
 
-	suite.app.EvmKeeper.CommitStateDB.SetBalance(suite.from, big.NewInt(100))
-
 	// send simple value transfer with gasLimit=21000
 	tx := types.NewMsgEthereumTx(suite.chainID, 1, &ethcmn.Address{0x1}, big.NewInt(1), gasLimit, gasPrice, nil, nil)
 	tx.From = suite.from.String()
@@ -390,12 +386,12 @@ func (suite *EvmTestSuite) TestOutOfGasWhenDeployContract() {
 	err := tx.Sign(suite.ethSigner, suite.signer)
 	suite.Require().NoError(err)
 
-	snapshotCommitStateDBJson, err := json.Marshal(suite.app.EvmKeeper.CommitStateDB)
+	snapshotCommitStateDBJson, err := json.Marshal(suite.app.EvmKeeper)
 	suite.Require().Nil(err)
 
 	defer func() {
 		if r := recover(); r != nil {
-			currentCommitStateDBJson, err := json.Marshal(suite.app.EvmKeeper.CommitStateDB)
+			currentCommitStateDBJson, err := json.Marshal(suite.app.EvmKeeper)
 			suite.Require().Nil(err)
 			suite.Require().Equal(snapshotCommitStateDBJson, currentCommitStateDBJson)
 		} else {
@@ -419,13 +415,13 @@ func (suite *EvmTestSuite) TestErrorWhenDeployContract() {
 	err := tx.Sign(suite.ethSigner, suite.signer)
 	suite.Require().NoError(err)
 
-	snapshotCommitStateDBJson, err := json.Marshal(suite.app.EvmKeeper.CommitStateDB)
+	snapshotCommitStateDBJson, err := json.Marshal(suite.app.EvmKeeper)
 	suite.Require().Nil(err)
 
 	_, sdkErr := suite.handler(suite.ctx, tx)
 	suite.Require().NotNil(sdkErr)
 
-	currentCommitStateDBJson, err := json.Marshal(suite.app.EvmKeeper.CommitStateDB)
+	currentCommitStateDBJson, err := json.Marshal(suite.app.EvmKeeper)
 	suite.Require().Nil(err)
 	suite.Require().Equal(snapshotCommitStateDBJson, currentCommitStateDBJson)
 }