Merge remote-tracking branch 'origin/main' into e2e

Author: mmsqe

docs/migrations/v0.4.0_to_v0.5.0.md

@@ -77,9 +77,35 @@ following list includes references within `evmd` that have been moved.
 
 ### Mempool
 
-#### Minimal setups: nothing to change
+#### Custom initializer
 
-If you use the default mempool wiring (no custom pools), your existing code continues to work. If `BlockGasLimit` is 0, it defaults to `100_000_000`. If `BroadCastTxFn` is not set, it's also set to a default value.
+The mempool configuration can now be handled by a helper function. If you prefer to use the configuration from `app.toml` and CLI flags, you can refactor your mempool setup:
+
+- **Before**: Manual configuration in app.go
+```go
+mempoolConfig := &evmmempool.EVMMempoolConfig{
+    AnteHandler:   app.GetAnteHandler(),
+    BlockGasLimit: blockGasLimit,
+    MinTip:        minTip,
+}
+evmMempool := evmmempool.NewExperimentalEVMMempool(
+    app.CreateQueryContext, logger, app.EVMKeeper, app.FeeMarketKeeper,
+    app.txConfig, app.clientCtx, mempoolConfig,
+)
+```
+- **After**: Using helper function (optional). See https://github.com/cosmos/evm/blob/42e1141c9b00432020e69945e565f60f80ab501d/evmd/mempool.go for the reference implementation
+```go
+if err := app.configureEVMMempool(appOpts, logger); err != nil {
+    panic(fmt.Sprintf("failed to configure EVM mempool: %s", err.Error()))
+}
+```
+
+The helper function reads configuration from `appOpts` or applies defaults if omitted. Note that `NewExperimentalEVMMempool` now takes an additional `cosmosPoolMaxTx` parameter, with a recommended default value being `4096` or `0` (uncapped).
+
+
+#### Simple config migration
+
+If `BlockGasLimit` is 0, it defaults to `100_000_000`. If `BroadCastTxFn` is not set, it's also set to a default value.
 
 ```go
 mempoolConfig := &evmmempool.EVMMempoolConfig{
@@ -183,40 +209,35 @@ These options can also be set via CLI flags:
 
 A new flag `--mempool.max-txs` allows limiting the maximum number of transactions in the Cosmos mempool. Set to 0 or -1 for unbounded (default: 0).
 
-##### Simplified Mempool Setup
-
-The mempool configuration can now be handled by a helper function. If you prefer to use the configuration from `app.toml` and CLI flags, you can refactor your mempool setup:
+The function signature for `NewExperimentalEVMMempool` also changed to add a cosmosPoolMaxTx field:
 
-```go
-// Before: Manual configuration in app.go
-mempoolConfig := &evmmempool.EVMMempoolConfig{
-    AnteHandler:   app.GetAnteHandler(),
-    BlockGasLimit: blockGasLimit,
-    MinTip:        minTip,
-}
-evmMempool := evmmempool.NewExperimentalEVMMempool(
-    app.CreateQueryContext, logger, app.EVMKeeper, app.FeeMarketKeeper,
-    app.txConfig, app.clientCtx, mempoolConfig,
+```diff
+func NewExperimentalEVMMempool(
+	getCtxCallback func(height int64, prove bool) (sdk.Context, error),
+	logger log.Logger,
+	vmKeeper VMKeeperI,
+	feeMarketKeeper FeeMarketKeeperI,
+	txConfig client.TxConfig,
+	clientCtx client.Context,
+	config *EVMMempoolConfig,
++	cosmosPoolMaxTx int,
 )
-
-// After: Using helper function (optional)
-// See evmd/mempool.go for reference implementation
-if err := app.configureEVMMempool(appOpts, logger); err != nil {
-    panic(fmt.Sprintf("failed to configure EVM mempool: %s", err.Error()))
-}
 ```
 
-The helper function reads configuration from `appOpts` and applies defaults where needed. Note that `NewExperimentalEVMMempool` now takes an additional `cosmosPoolMaxTx` parameter.
-
-### Default Precompiles
+#### EVM Chain ID
 
-Default precompiles have been moved to `/evm/precompiles/types/defaults.go` and the function name was
-changed to `DefaultStaticPrecompiles`. The function signature has also changed, and now takes pointers
-as inputs for the `Erc20Keeper` and `TransferKeeper`. Finally, the `WithStaticPrecompiles` builder
-function can now happen *alongside the keeper instantiation*, and not after. The new wiring is shown below:
+The EVM chain ID is now retrieved directly from `appOpts` instead of being passed as a parameter. In `app.go`, the chain ID is obtained using:
 
 ```go
-	app.EVMKeeper = evmkeeper.NewKeeper(
+evmChainID := cast.ToUint64(appOpts.Get(srvflags.EVMChainID))
+```
+
+See `evmd/app.go:216` for the reference implementation.
+
+The EVM Keeper now also takes in evmChainID as a parameter:
+
+```diff
+app.EVMKeeper = evmkeeper.NewKeeper(
 		appCodec, keys[evmtypes.StoreKey], tkeys[evmtypes.TransientKey], keys,
 		authtypes.NewModuleAddress(govtypes.ModuleName),
 		app.AccountKeeper,
@@ -225,39 +246,11 @@ function can now happen *alongside the keeper instantiation*, and not after. The
 		app.FeeMarketKeeper,
 		&app.ConsensusParamsKeeper,
 		&app.Erc20Keeper,
++		evmChainID,
 		tracer,
-	).WithStaticPrecompiles(
-		precompiletypes.DefaultStaticPrecompiles(
-			*app.StakingKeeper,
-			app.DistrKeeper,
-			app.PreciseBankKeeper,
-			&app.Erc20Keeper, // UPDATED
-			&app.TransferKeeper, // UPDATED
-			app.IBCKeeper.ChannelKeeper,
-			app.GovKeeper,
-			app.SlashingKeeper,
-			appCodec,
-		),
 	)
 ```
 
-### Denom Configs
-
-[#661](https://github.com/cosmos/evm/pull/661) removes the instantiation of chain configs via app.go
-and moves them to state or genesis.
-It is critical to remove any use of EvmAppOptions as calling the configurator will panic the chain
-at runtime during startup.
-
-#### EVM Chain ID
-
-The EVM chain ID is now retrieved directly from `appOpts` instead of being passed as a parameter. In `app.go`, the chain ID is obtained using:
-
-```go
-evmChainID := cast.ToUint64(appOpts.Get(srvflags.EVMChainID))
-```
-
-See `evmd/app.go:216` for the reference implementation.
-
 #### Function Signature Changes
 
 In `app.go`, remove evmChainID and evmAppOptions from the NewApp signature.
@@ -304,6 +297,47 @@ Then, remove any reference of evmAppOptions being called:
 `evmd_config.go`, `chain_id.go`, `config.go`, `constants.go` have been moved to
 `github.com/cosmos/evm/config` and may be removed to your repo.
 
+### Denom Configs
+
+[#661](https://github.com/cosmos/evm/pull/661) removes the instantiation of chain configs via app.go
+and moves them to state or genesis.
+It is critical to remove any use of EvmAppOptions as calling the configurator will panic the chain
+at runtime during startup.
+
+### Default Precompiles
+
+Default precompiles have been moved to `/evm/precompiles/types/defaults.go` and the function name was
+changed to `DefaultStaticPrecompiles`. The function signature has also changed, and now takes pointers
+as inputs for the `Erc20Keeper` and `TransferKeeper`. Finally, the `WithStaticPrecompiles` builder
+function can now happen *alongside the keeper instantiation*, and not after. The new wiring is shown below:
+
+```go
+	app.EVMKeeper = evmkeeper.NewKeeper(
+		appCodec, keys[evmtypes.StoreKey], tkeys[evmtypes.TransientKey], keys,
+		authtypes.NewModuleAddress(govtypes.ModuleName),
+		app.AccountKeeper,
+		app.PreciseBankKeeper,
+		app.StakingKeeper,
+		app.FeeMarketKeeper,
+		&app.ConsensusParamsKeeper,
+		&app.Erc20Keeper,
+		evmChainID,
+		tracer,
+	).WithStaticPrecompiles(
+		precompiletypes.DefaultStaticPrecompiles(
+			*app.StakingKeeper,
+			app.DistrKeeper,
+			app.PreciseBankKeeper,
+			&app.Erc20Keeper, // UPDATED
+			&app.TransferKeeper, // UPDATED
+			app.IBCKeeper.ChannelKeeper,
+			app.GovKeeper,
+			app.SlashingKeeper,
+			appCodec,
+		),
+	)
+```
+
 #### UpgradeHandler
 
 As the configs have been moved to state and genesis, you must include an UpgradeHandler if your chain does
@@ -323,7 +357,7 @@ Please refer to the [upgrade example](https://github.com/cosmos/evm/blob/0995962
 
 ---
 
-## 3) Build & quick tests
+## 4) Build & quick tests
 
 ```bash
 go build ./...