fix: non-deterministic evm pre-blocker (#729)

* fix: non-deterministic evm pre-blocker

Closes: #728

Solution:
- remove the state mutation out from the pre-blocker.
- production chains should put the state mutation part in their upgrade handler.

* Update CHANGELOG.md

---------

Co-authored-by: Vlad J <[email protected]>

Author: yihuang

CHANGELOG.md

@@ -22,6 +22,7 @@
 - [\#687](https://github.com/cosmos/evm/pull/687) Avoid blocking node shutdown when evm indexer is enabled, log startup failures instead of using errgroup.
 - [\#689](https://github.com/cosmos/evm/pull/689) Align debug addr for hex address.
 - [\#668](https://github.com/cosmos/evm/pull/668) Fix panic in legacy mempool when Reset() was called with a skipped header between old and new block.
+- [\#729](https://github.com/cosmos/evm/pull/729) Remove non-deterministic state mutation from EVM pre-blocker.
 - [\#725](https://github.com/cosmos/evm/pull/725) Fix inconsistent block hash in json-rpc.
 - [\#727](https://github.com/cosmos/evm/pull/727) Avoid nil pointer for `tx evm raw` due to uninitialized EVM coin info.
 - [\#730](https://github.com/cosmos/evm/pull/730) Fix panic if evm mempool not used.

x/vm/genesis.go

@@ -60,8 +60,13 @@ func InitGenesis(
 		}
 	}
 
+	if err := k.InitEvmCoinInfo(ctx); err != nil {
+		panic(fmt.Errorf("error initializing evm coin info: %s", err))
+	}
+
+	coinInfo := k.GetEvmCoinInfo(ctx)
 	initializer.Do(func() {
-		SetGlobalConfigVariables(ctx, k, bankKeeper, data.Params)
+		SetGlobalConfigVariables(coinInfo)
 	})
 
 	if err := k.AddPreinstalls(ctx, data.Preinstalls); err != nil {

x/vm/keeper/coin_info.go

@@ -1,11 +1,56 @@
 package keeper
 
 import (
+	"fmt"
+
 	"github.com/cosmos/evm/x/vm/types"
 
 	sdk "github.com/cosmos/cosmos-sdk/types"
 )
 
+// LoadEvmCoinInfo load EvmCoinInfo from bank denom metadata
+func (k Keeper) LoadEvmCoinInfo(ctx sdk.Context) (types.EvmCoinInfo, error) {
+	var decimals types.Decimals
+
+	params := k.GetParams(ctx)
+	evmDenomMetadata, found := k.bankWrapper.GetDenomMetaData(ctx, params.EvmDenom)
+	if !found {
+		return types.EvmCoinInfo{}, fmt.Errorf("denom metadata %s could not be found", params.EvmDenom)
+	}
+
+	for _, denomUnit := range evmDenomMetadata.DenomUnits {
+		if denomUnit.Denom == evmDenomMetadata.Display {
+			decimals = types.Decimals(denomUnit.Exponent)
+		}
+	}
+
+	var extendedDenom string
+	if decimals == 18 {
+		extendedDenom = params.EvmDenom
+	} else {
+		if params.ExtendedDenomOptions == nil {
+			return types.EvmCoinInfo{}, fmt.Errorf("extended denom options cannot be nil for non-18-decimal chains")
+		}
+		extendedDenom = params.ExtendedDenomOptions.ExtendedDenom
+	}
+
+	return types.EvmCoinInfo{
+		Denom:         params.EvmDenom,
+		ExtendedDenom: extendedDenom,
+		DisplayDenom:  evmDenomMetadata.Display,
+		Decimals:      decimals.Uint32(),
+	}, nil
+}
+
+// InitEvmCoinInfo load EvmCoinInfo from bank denom metadata and store it in the module
+func (k Keeper) InitEvmCoinInfo(ctx sdk.Context) error {
+	coinInfo, err := k.LoadEvmCoinInfo(ctx)
+	if err != nil {
+		return err
+	}
+	return k.SetEvmCoinInfo(ctx, coinInfo)
+}
+
 // GetEvmCoinInfo returns the EVM Coin Info stored in the module
 func (k Keeper) GetEvmCoinInfo(ctx sdk.Context) (coinInfo types.EvmCoinInfo) {
 	store := ctx.KVStore(k.storeKey)

x/vm/module.go

@@ -138,9 +138,9 @@ func (am AppModule) RegisterServices(cfg module.Configurator) {
 
 func (am AppModule) PreBlock(goCtx context.Context) (appmodule.ResponsePreBlock, error) {
 	ctx := sdk.UnwrapSDKContext(goCtx)
-	params := am.keeper.GetParams(ctx)
+	coinInfo := am.keeper.GetEvmCoinInfo(ctx)
 	am.initializer.Do(func() {
-		SetGlobalConfigVariables(ctx, am.keeper, am.bankKeeper, params)
+		SetGlobalConfigVariables(coinInfo)
 	})
 	return &sdk.ResponsePreBlock{ConsensusParamsChanged: false}, nil
 }
@@ -212,46 +212,12 @@ func setBaseDenom(ci types.EvmCoinInfo) (err error) {
 	return sdk.RegisterDenom(ci.Denom, math.LegacyNewDecWithPrec(1, int64(ci.Decimals)))
 }
 
-func SetGlobalConfigVariables(ctx sdk.Context, vmKeeper *keeper.Keeper, bankKeeper types.BankKeeper, params types.Params) {
-	var decimals types.Decimals
-
-	evmDenomMetadata, found := bankKeeper.GetDenomMetaData(ctx, params.EvmDenom)
-	if !found {
-		panic(fmt.Sprintf("denom metadata %s could not be found", params.EvmDenom))
-	}
-
-	for _, denomUnit := range evmDenomMetadata.DenomUnits {
-		if denomUnit.Denom == evmDenomMetadata.Display {
-			decimals = types.Decimals(denomUnit.Exponent)
-		}
-	}
-
-	var extendedDenom string
-	if decimals == 18 {
-		extendedDenom = params.EvmDenom
-	} else {
-		if params.ExtendedDenomOptions == nil {
-			panic(fmt.Errorf("extended denom options cannot be nil for non-18-decimal chains"))
-		}
-		extendedDenom = params.ExtendedDenomOptions.ExtendedDenom
-	}
-
-	coinInfo := types.EvmCoinInfo{
-		Denom:         params.EvmDenom,
-		ExtendedDenom: extendedDenom,
-		DisplayDenom:  evmDenomMetadata.Display,
-		Decimals:      decimals.Uint32(),
-	}
-
+func SetGlobalConfigVariables(coinInfo types.EvmCoinInfo) {
 	// set the denom info for the chain
 	if err := setBaseDenom(coinInfo); err != nil {
 		panic(err)
 	}
 
-	if err := vmKeeper.SetEvmCoinInfo(ctx, coinInfo); err != nil {
-		panic(err)
-	}
-
 	configurator := types.NewEVMConfigurator()
 	err := configurator.
 		WithExtendedEips(types.DefaultCosmosEVMActivators).