refactor!: consolidate and clean up chain config #436

almk-dev · 2025-08-12T20:15:15Z

Description

Remove static chain configs from EVM

Currently we have the configuration for chains held in .go files that are compiled into the binary. This logic and struct is duplicated throughout the codebase, making it very complicated to think about testing and spinning up nodes.

Cosmos apps already come with an app.toml which is already used for some of our EVM configuration. We should just move all of this logic to a config file so that it is simple to work with in testing and for users

STACK-1409
EVM-176

Please review that all chain config redundancy has been removed and that all tests and functionality is working exactly the same as before.

Author Checklist

I have...

tackled an existing issue or discussed with a team member
left instructions on how to review the changes
targeted the main branch

linear · 2025-08-12T20:15:19Z

STACK-1409 Remove static chain configs from EVM

config/chain_config.go

evmd/cmd/evmd/config/chain_config.go

testutil/config/chain_config.go

aljo242 · 2025-08-25T15:56:46Z

evmd/cmd/evmd/config/evmd_config.go

@@ -92,6 +93,7 @@ type EVMAppConfig struct {
 	EVM     cosmosevmserverconfig.EVMConfig
 	JSONRPC cosmosevmserverconfig.JSONRPCConfig
 	TLS     cosmosevmserverconfig.TLSConfig
+	Chain   evmtypes.EvmCoinInfo


This feels confusing that all of the other configs are defined in cosmosevmserverconfig but this one comes from another package (evmtypes). Then below, the DefaultEvmCoinInfo function actually does come from the cosmosevmserverconfig package

evmd/cmd/evmd/config/evmd_config.go

aljo242 · 2025-08-25T16:03:56Z

server/config/toml.go

+###############################################################################
+###                            Chain Configuration                          ###
+###############################################################################


Folks generate this toml when they run appd init so this would be run at whatever initial version they are using. So if i was on v0.4 when i ran appd init i would not have this section in my config. What would happen in that scenario?

aljo242 · 2025-08-25T16:06:21Z

evmd/cmd/evmd/config/config.go

-		Decimals:      evmtypes.EighteenDecimals,
-	},
+// GetEvmCoinInfo returns appropriate EvmCoinInfo for evmd based on chainID.
+func GetEvmCoinInfo(chainID uint64) evmtypes.EvmCoinInfo {


Could we just export something like this once from the library instead of here and how it is duplicated in testutil?

aljo242 · 2025-08-25T16:07:44Z

server/config/migration/v0.50-app.toml

@@ -328,6 +328,24 @@ certificate-path = ""
 # Key path defines the key.pem file path for the TLS configuration.
 key-path = ""

+###############################################################################


What is this file?

aljo242 · 2025-08-25T16:10:51Z

testutil/config/example_migration.md

@@ -0,0 +1,119 @@
+# Chain Configuration Migration Guide


The title of this file is pretty generic. How are we pointing people to this file?

Feels like it needs to be linked in the changelog or in an overall "migration guide"

we have stuff here for previous releases

we should definitely put what versions this is relevant for here

aljo242 · 2025-08-25T16:12:26Z

testutil/constants/constants.go

+// Deprecated: Use testutil/config.CreateEvmCoinInfoFromDynamicConfig() instead.
+// This function is kept for backward compatibility but should be replaced
+// with dynamic configuration generation.


if we are deprecating this and keeping it for compatibility, then why not just keep the global map type?

Folks will be broken because we've changed the API

would also make the diff much smaller

agree here, it seems counter intuitive to break something and immediately deprecate it. its also still used extensively throughout the code. should that be updated to the non-deprecated version?

aljo242 · 2025-08-25T16:13:44Z

x/vm/types/config.go

@@ -11,6 +11,7 @@ import (
 	"fmt"

 	"github.com/ethereum/go-ethereum/core/vm"
+	"github.com/ethereum/go-ethereum/log"


why does this file need to be behind test build flags?

technicallyty · 2025-08-25T18:00:02Z

i think the PR title should be "refactor!" since it is a breaking change and a restructure of how users will interact with the software

technicallyty

mostly questions on stuff. am a little confused about the map -> function changes. it kinda blew up the diff and its unclear to me if it was necessary for this refactor

technicallyty · 2025-08-25T19:04:53Z

CHANGELOG.md

@@ -14,6 +14,7 @@
 - [\#467](https://github.com/cosmos/evm/pull/467) Replace GlobalEVMMempool by passing to JSONRPC on initiate.
 - [\#352](https://github.com/cosmos/evm/pull/352) Remove the creation of a Geth EVM instance, stateDB during the AnteHandler balance check.
 - [\#496](https://github.com/cosmos/evm/pull/496) Simplify mempool instantiation by using configs instead of objects.
+- [\#436](https://github.com/cosmos/evm/pull/436) Consolidate and clean up chain config


this feels a bit too ambiguous for the change being made. if i was an evm user, i wouldn't really know what needs to be actionized from this.

technicallyty · 2025-08-25T19:11:23Z

evmd/cmd/evmd/config/config.go

+	default:
+		// Default fallback - return the default configuration
+		return *config.DefaultEvmCoinInfo()
+	}


this seems like it could be a potential footgun. what types of issues could cascade from this?

evmd/cmd/evmd/config/evmd_config.go

technicallyty · 2025-08-25T19:24:07Z

server/config/toml.go

+###############################################################################
+###                            Chain Configuration                          ###
+###############################################################################


if we can automate the updating of their app.toml in an upgrade handler, we should definitely do that. im still going through the PR as i write this comment so i'm not sure what is possible yet.

technicallyty · 2025-08-25T19:32:21Z

testutil/config/example_migration.md

@@ -0,0 +1,119 @@
+# Chain Configuration Migration Guide


we should definitely put what versions this is relevant for here

technicallyty · 2025-08-25T19:35:42Z

testutil/config/example_migration.md

+}
+```
+
+## Dynamic Configuration for Tests


this seems a bit confusing to me. is there a reason we have all this dynamic stuff -- it seems like you could just skirt all this and directly construct an EvmCoinInfo type, no?

technicallyty · 2025-08-25T19:36:54Z

testutil/constants/constants.go

+// Deprecated: Use testutil/config.CreateEvmCoinInfoFromDynamicConfig() instead.
+// This function is kept for backward compatibility but should be replaced
+// with dynamic configuration generation.


agree here, it seems counter intuitive to break something and immediately deprecate it. its also still used extensively throughout the code. should that be updated to the non-deprecated version?

technicallyty · 2025-08-25T19:42:18Z

testutil/integration/evm/network/config.go

@@ -118,14 +118,7 @@ type ConfigOption func(*Config)
 // WithChainID sets a custom chainID for the network. Changing the chainID
 // change automatically also the EVM coin used. It panics if the chainID is invalid.
 func WithChainID(chainID testconstants.ChainID) ConfigOption {
-	evmCoinInfo, found := testconstants.ExampleChainCoinInfo[chainID]


regarding the change of maps to functions for the coin info, the map version did have the benefit of giving the user a presence check for free. with the function as is, it doesnt seem like there is a way for the user to check that the thing they were looking for is actually there. but, im not too sure how important that is.

x/vm/types/config.go

tests/integration/x/precisebank/test_burn_integration.go

tests/integration/x/precisebank/test_mint_integration.go

tests/integration/x/precisebank/test_send_integration.go

tests/integration/ante/test_evm_unit_04_validate.go

 				// Call the configurator to set the EVM coin required for the
 				// function to be tested.
 				configurator := evmtypes.NewEVMConfigurator()
 				configurator.ResetTestConfig()
-				s.Require().NoError(configurator.WithEVMCoinInfo(testconstants.ExampleChainCoinInfo[chainID]).Configure())
+				s.Require().NoError(configurator.WithEVMCoinInfo(chainConfig.CoinInfo).Configure())


tests/integration/x/precisebank/test_burn_integration.go

@@ -500,8 +500,8 @@
 func FuzzBurnCoins(f *testing.F) {
 	configurator := evmtypes.NewEVMConfigurator()
 	configurator.ResetTestConfig()
-	configurator.WithEVMCoinInfo(testconstants.ExampleChainCoinInfo[testconstants.SixDecimalsChainID])
-	err := configurator.Configure()
+	coinInfo := testconfig.SixDecimalsChainConfig.CoinInfo


tests/integration/x/precisebank/test_mint_integration.go

@@ -417,8 +417,7 @@
 func FuzzMintCoins(f *testing.F) {
 	configurator := evmtypes.NewEVMConfigurator()
 	configurator.ResetTestConfig()
-	configurator.WithEVMCoinInfo(testconstants.ExampleChainCoinInfo[testconstants.SixDecimalsChainID])
-	err := configurator.Configure()
+	err := configurator.WithEVMCoinInfo(testconfig.SixDecimalsChainConfig.CoinInfo).Configure()


tests/integration/x/precisebank/test_send_integration.go

@@ -798,8 +798,7 @@
 func FuzzSendCoins(f *testing.F) {
 	configurator := evmtypes.NewEVMConfigurator()
 	configurator.ResetTestConfig()
-	configurator.WithEVMCoinInfo(testconstants.ExampleChainCoinInfo[testconstants.SixDecimalsChainID])
-	err := configurator.Configure()
+	err := configurator.WithEVMCoinInfo(testconfig.SixDecimalsChainConfig.CoinInfo).Configure()


tests/integration/x/vm/keeper_test_suite.go

@@ -105,17 +105,18 @@
 	extendedDenom := evmtypes.GetEVMCoinExtendedDenom()
 	displayDenom := evmtypes.GetEVMCoinDisplayDenom()
 	decimals := evmtypes.GetEVMCoinDecimals()
+	coinInfo := evmtypes.EvmCoinInfo{


tests/integration/x/vm/test_grpc_query.go

@@ -1605,9 +1605,10 @@

 				configurator := types.NewEVMConfigurator()
 				configurator.ResetTestConfig()
+				coinInfo := testconfig.DefaultChainConfig.CoinInfo


evmd/cmd/evmd/config/loader.go

+
+	// If the base denom has different decimals, we need to create it properly
+	denom := evmtypes.CreateDenomStr(defaultDecimals, defaultDisplayDenom)
+	if defaultDecimals == evmtypes.EighteenDecimals {


To fix the issue, we need to remove the unnecessary comparison between two identical values. Since defaultDecimals is set unconditionally to evmtypes.Decimals(18), which is in all likelihood equal to evmtypes.EighteenDecimals, the conditional on line 160 will always execute. The ramifications are that the nominal else block (base and extended denom creation) is never used, and the denom/extendedDenom are both simply set to the default string. The fix should be either to use the default values unconditionally, or (if conditional behaviour is needed) to ensure the comparison actually checks for something meaningful. If the intent was to allow variable decimal configurations, defaultDecimals should be set from configuration rather than hardcoded. For now, the best minimal fix is to remove the condition and set denom and extendedDenom to the default values unconditionally, and remove the dead code.

evmd/test_helpers.go

+// testEvmAppOptions creates an EvmAppOptions function for testing
+func testEvmAppOptions(evmChainID uint64) error {
+	// Use default chain configuration for testing
+	chainConfig := testconfig.DefaultChainConfig


The best way to fix the problem is to remove the unnecessary assignment to the local variable chainConfig in the function testEvmAppOptions. Instead, access testconfig.DefaultChainConfig.CoinInfo directly when calling WithEVMCoinInfo. No other changes are needed as the rest of the code already works with this direct access. Edits should be made in evmd/test_helpers.go, lines 55–58.

evmd/tests/integration/create_app.go

+// testEvmAppOptionsWithReset creates an EvmAppOptions function for testing with reset
+func testEvmAppOptionsWithReset(evmChainID uint64) error {
+	// Use default chain configuration for testing
+	chainConfig := testconfig.DefaultChainConfig


The best fix is to remove the definition of the local variable chainConfig, and replace its usage with a direct reference to testconfig.DefaultChainConfig.CoinInfo. Specifically, in testEvmAppOptionsWithReset (lines 26 and 29), delete the assignment to chainConfig and change the argument passed to WithEVMCoinInfo from chainConfig.CoinInfo to testconfig.DefaultChainConfig.CoinInfo. No imports or definitions are required beyond this local change. This removes the useless assignment, improving clarity without altering functionality.

evmd/tests/network/network.go

+// testEvmAppOptions creates an EvmAppOptions function for testing
+func testEvmAppOptions(evmChainID uint64) error {
+	// Use default chain configuration for testing
+	chainConfig := testconfig.DefaultChainConfig


To fix this problem, we should remove the unnecessary assignment of chainConfig to testconfig.DefaultChainConfig on line 106, since it is only used to access its CoinInfo field. Instead, we should directly use testconfig.DefaultChainConfig.CoinInfo in the call to configurator.WithEVMCoinInfo. This applies only to the region inside testEvmAppOptions. No other code or functionality will be affected, as the assignment is not used elsewhere.

github-advanced-security bot found potential problems Aug 12, 2025

View reviewed changes

github-advanced-security bot found potential problems Aug 13, 2025

View reviewed changes

testutil/config/chain_config.go Fixed Show fixed Hide fixed

aljo242 added the v0.5.x targeting v0.5.x label Aug 14, 2025

aljo242 self-requested a review August 14, 2025 21:26

fix tests and remove unnecessary setup

cda76f9

almk-dev force-pushed the stack-1409-clean-up-chain-config branch from 1f0d4d4 to cda76f9 Compare August 15, 2025 15:28

almk-dev added 3 commits August 15, 2025 11:29

Merge branch 'main' into stack-1409-clean-up-chain-config

bcd494d

fix build complaints

517d783

Merge branch 'main' into stack-1409-clean-up-chain-config

30cf3c6

almk-dev changed the title ~~Stack 1409 clean up chain config~~ fix: consolidate and clean up chain config Aug 18, 2025

almk-dev added 7 commits August 18, 2025 13:07

Merge branch 'main' into stack-1409-clean-up-chain-config

f7183ee

Merge branch 'main' into stack-1409-clean-up-chain-config

fddffea

fix systemtest

95b6b98

fix solidity

9ae30ee

revert default config denom

89cacfd

align default config

d3dfc7f

fast runners

21b5766

almk-dev marked this pull request as ready for review August 19, 2025 16:13

almk-dev requested review from a team as code owners August 19, 2025 16:13

almk-dev added 3 commits August 19, 2025 12:14

Merge branch 'main' into stack-1409-clean-up-chain-config

7c83c76

solidity still doesnt work on depot

0ce0239

no meaningful speedup

9dda87b

almk-dev mentioned this pull request Aug 19, 2025

add comments clarifying TokenPair meaning #489

Merged

3 tasks

Merge branch 'main' into stack-1409-clean-up-chain-config

f74b4c1

aljo242 self-assigned this Aug 19, 2025

Alex | Interchain Labs and others added 3 commits August 19, 2025 16:17

Merge branch 'main' into stack-1409-clean-up-chain-config

5132d13

Merge branch 'main' into stack-1409-clean-up-chain-config

f122ab4

Merge branch 'main' into stack-1409-clean-up-chain-config

3ed2826

almk-dev added 7 commits August 25, 2025 09:47

remove infinite loop debug logic

1fda943

replace panic with no-op warning

608c530

fix variable name alignment

2e7e401

cleanup toml usage for new test pattern

3df3bd0

clean up doc strings

c2aaef8

remove unused appOptions config

8d10e73

update doc strings that are no longer relevant

43e86fd

aljo242 requested a review from technicallyty August 25, 2025 15:58

aljo242 reviewed Aug 25, 2025

View reviewed changes

technicallyty requested changes Aug 25, 2025

View reviewed changes

almk-dev added 2 commits August 26, 2025 10:00

Merge branch 'main' into stack-1409-clean-up-chain-config

05fa144

change app config chain info to coin

cc8ccac

almk-dev changed the title ~~fix: consolidate and clean up chain config~~ refactor: consolidate and clean up chain config Aug 26, 2025

technicallyty changed the title ~~refactor: consolidate and clean up chain config~~ refactor!: consolidate and clean up chain config Aug 26, 2025

almk-dev added 2 commits August 27, 2025 12:13

Merge branch 'main' into stack-1409-clean-up-chain-config

676ef59

revert panic for ResetTestConfig

e7d1d28

github-advanced-security bot found potential problems Aug 27, 2025

View reviewed changes

tests/integration/x/precisebank/test_burn_integration.go Fixed Show fixed Hide fixed

tests/integration/x/precisebank/test_mint_integration.go Fixed Show fixed Hide fixed

tests/integration/x/precisebank/test_send_integration.go Fixed Show fixed Hide fixed

add testutil refactor

9c85141

github-advanced-security bot found potential problems Aug 28, 2025

View reviewed changes

almk-dev added 7 commits August 28, 2025 14:16

rev root

d4c5dd1

remove unused func

c1b1f6f

clean up staged

3a6d73c

remove unused client func

8319f7b

fix merge conflicts

6df3721

clear duplicate constants

e391692

fix burn test setup

f885ee4

github-advanced-security bot found potential problems Sep 2, 2025

View reviewed changes

almk-dev added 2 commits September 3, 2025 11:06

fix merge conflicts

92674b9

clean up fractional test

a542c04

@@ -152,17 +152,10 @@
             	defaultDisplayDenom := "test"
             	defaultDecimals := evmtypes.Decimals(18)
-            	// Create extended denom (atto version for 18-decimal representation)
-            	extendedDenom := evmtypes.CreateDenomStr(defaultDecimals, defaultDisplayDenom)
+            	// For 18 decimals, base and extended are the same
+            	denom := defaultDenom
+            	extendedDenom := defaultDenom
-            	// If the base denom has different decimals, we need to create it properly
-            	denom := evmtypes.CreateDenomStr(defaultDecimals, defaultDisplayDenom)
-            	if defaultDecimals == evmtypes.EighteenDecimals {
-            		// For 18 decimals, base and extended are the same
-            		denom = defaultDenom
-            		extendedDenom = defaultDenom
-            	}
             	coinInfo = evmtypes.EvmCoinInfo{
             		Denom:         denom,
             		ExtendedDenom: extendedDenom,

refactor!: consolidate and clean up chain config #436

Are you sure you want to change the base?

refactor!: consolidate and clean up chain config #436

Uh oh!

Conversation

almk-dev commented Aug 12, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Author Checklist

Uh oh!

linear bot commented Aug 12, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

technicallyty commented Aug 25, 2025

Uh oh!

technicallyty left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Check warning

Copilot Autofix

Check warning

Copilot Autofix

Check warning

Copilot Autofix

Check warning

Copilot Autofix

Check warning

Check warning

Copilot Autofix

Check warning

almk-dev commented Aug 12, 2025 •

edited

Loading