[evm] Refactor evm statedb adapter (#4550)

Co-authored-by: CoderZhi <[email protected]>
Co-authored-by: dustinxie <[email protected]>

Author: 3 people

action/protocol/execution/evm/evm.go

@@ -95,13 +95,22 @@ type (
 		actionCtx   protocol.ActionCtx
 		helperCtx   HelperContext
 	}
+
+	stateDB interface {
+		vm.StateDB
+
+		CommitContracts() error
+		Logs() []*action.Log
+		TransactionLogs() []*action.TransactionLog
+		clear()
+		Error() error
+	}
 )
 
 // newParams creates a new context for use in the EVM.
 func newParams(
 	ctx context.Context,
 	execution action.TxData,
-	stateDB *StateDBAdapter,
 ) (*Params, error) {
 	var (
 		actionCtx    = protocol.MustGetActionCtx(ctx)
@@ -134,15 +143,15 @@ func newParams(
 		}
 	case featureCtx.FixGetHashFnHeight:
 		getHashFn = func(n uint64) common.Hash {
-			hash, err := getBlockHash(stateDB.blockHeight - (n + 1))
+			hash, err := getBlockHash(blkCtx.BlockHeight - (n + 1))
 			if err == nil {
 				return common.BytesToHash(hash[:])
 			}
 			return common.Hash{}
 		}
 	default:
 		getHashFn = func(n uint64) common.Hash {
-			hash, err := getBlockHash(stateDB.blockHeight - n)
+			hash, err := getBlockHash(blkCtx.BlockHeight - n)
 			if err != nil {
 				// initial implementation did wrong, should return common.Hash{} in case of error
 				return common.BytesToHash(hash[:])
@@ -241,7 +250,7 @@ func ExecuteContract(
 	if err != nil {
 		return nil, nil, err
 	}
-	ps, err := newParams(ctx, execution, stateDB)
+	ps, err := newParams(ctx, execution)
 	if err != nil {
 		return nil, nil, err
 	}
@@ -428,7 +437,7 @@ func getChainConfig(g genesis.Blockchain, height uint64, id uint32, getBlockTime
 }
 
 // Error in executeInEVM is a consensus issue
-func executeInEVM(ctx context.Context, evmParams *Params, stateDB *StateDBAdapter) ([]byte, uint64, uint64, string, iotextypes.ReceiptStatus, error) {
+func executeInEVM(ctx context.Context, evmParams *Params, stateDB stateDB) ([]byte, uint64, uint64, string, iotextypes.ReceiptStatus, error) {
 	var (
 		gasLimit     = evmParams.blkCtx.GasLimit
 		blockHeight  = evmParams.blkCtx.BlockHeight

action/protocol/execution/evm/evm_test.go

@@ -297,7 +297,7 @@ func TestConstantinople(t *testing.T) {
 		})
 		stateDB, err := prepareStateDB(fCtx, sm)
 		require.NoError(err)
-		ps, err := newParams(fCtx, elp, stateDB)
+		ps, err := newParams(fCtx, elp)
 		require.NoError(err)
 
 		evm := vm.NewEVM(ps.context, ps.txCtx, stateDB, ps.chainConfig, ps.evmConfig)

action/protocol/execution/evm/evmstatedbadapter.go

@@ -72,6 +72,7 @@ type (
 		createdAccountSnapshot     map[int]createdAccount
 		logsSnapshot               map[int]int // logs is an array, save len(logs) at time of snapshot suffices
 		txLogsSnapshot             map[int]int
+		newContract                func(addr hash.Hash160, account *state.Account) (Contract, error)
 		notFixTopicCopyBug         bool
 		asyncContractTrie          bool
 		disableSortCachedContracts bool
@@ -247,6 +248,9 @@ func NewStateDBAdapter(
 		s.createdAccount = make(createdAccount)
 		s.createdAccountSnapshot = make(map[int]createdAccount)
 	}
+	s.newContract = func(addr hash.Hash160, account *state.Account) (Contract, error) {
+		return newContract(addr, account, s.sm, s.asyncContractTrie)
+	}
 	return s, nil
 }
 
@@ -1129,7 +1133,7 @@ func (stateDB *StateDBAdapter) getNewContract(evmAddr common.Address) (Contract,
 	if err != nil {
 		return nil, errors.Wrapf(err, "failed to load account state for address %x", addr)
 	}
-	contract, err := newContract(addr, account, stateDB.sm, stateDB.asyncContractTrie)
+	contract, err := stateDB.newContract(addr, account)
 	if err != nil {
 		return nil, errors.Wrapf(err, "failed to create storage trie for new contract %x", addr)
 	}