refactor: params.ChainConfigExtra & RulesExtra -> params/extras (#702)

* refactor: params.ChainConfigExtra -> params/extras * remove type alias AvalancheConfig * remove type alias for PrecompileConfig * remove type alias UpgradeConfig * remove type alias network upgrade * seems ok to import ethparams.ChainConfig * remove type aliases * refactor: use `ChainConfig.Hooks().(*ChainConfigExtra)` * move RulesExtra (only struct, keep behavior) * refactor: return extras.RulesExtra from GetRulesExtra * rename extras.RulesExtra -> extras.Rules * rename file * refactor: rename extras.ChainConfigExtra -> extras.ChainConfig * return error if chain config type does not match * nit * comment and style improvements * nit * nit --------- Co-authored-by: Arran Schlosberg <[email protected]>
ava-labs · Dec 18, 2024 · a7f7061 · a7f7061
1 parent 826f074
commit a7f7061
Show file tree

Hide file tree

Showing 26 changed files with 420 additions and 377 deletions.
diff --git a/core/blockchain_test.go b/core/blockchain_test.go
@@ -16,6 +16,7 @@ import (
 	"github.com/ava-labs/coreth/core/state/pruner"
 	"github.com/ava-labs/coreth/core/types"
 	"github.com/ava-labs/coreth/params"
+	"github.com/ava-labs/coreth/params/extras"
 	"github.com/ava-labs/libevm/common"
 	"github.com/ava-labs/libevm/core/vm"
 	"github.com/ava-labs/libevm/crypto"
@@ -425,7 +426,7 @@ func TestUngracefulAsyncShutdown(t *testing.T) {
 	gspec := &Genesis{
 		Config: params.WithExtra(
 			&params.ChainConfig{HomesteadBlock: new(big.Int)},
-			&params.ChainConfigExtra{},
+			&extras.ChainConfig{},
 		),
 		Alloc: types.GenesisAlloc{addr1: {Balance: genesisBalance}},
 	}

diff --git a/core/genesis_extra_test.go b/core/genesis_extra_test.go
@@ -34,6 +34,7 @@ import (
 	"github.com/ava-labs/coreth/core/rawdb"
 	"github.com/ava-labs/coreth/core/types"
 	"github.com/ava-labs/coreth/params"
+	"github.com/ava-labs/coreth/params/extras"
 	"github.com/ava-labs/coreth/utils"
 	"github.com/ava-labs/libevm/common"
 	"github.com/ava-labs/libevm/triedb"
@@ -57,8 +58,8 @@ func TestGenesisEthUpgrades(t *testing.T) {
 			IstanbulBlock:       big.NewInt(0),
 			MuirGlacierBlock:    big.NewInt(0),
 		},
-		&params.ChainConfigExtra{
-			NetworkUpgrades: params.NetworkUpgrades{
+		&extras.ChainConfig{
+			NetworkUpgrades: extras.NetworkUpgrades{
 				ApricotPhase1BlockTimestamp: utils.NewUint64(0),
 				ApricotPhase2BlockTimestamp: utils.NewUint64(0),
 			},

diff --git a/core/genesis_test.go b/core/genesis_test.go
@@ -37,6 +37,7 @@ import (
 	"github.com/ava-labs/coreth/core/rawdb"
 	"github.com/ava-labs/coreth/core/types"
 	"github.com/ava-labs/coreth/params"
+	"github.com/ava-labs/coreth/params/extras"
 	"github.com/ava-labs/coreth/precompile/contracts/warp"
 	"github.com/ava-labs/coreth/triedb/pathdb"
 	"github.com/ava-labs/coreth/utils"
@@ -257,7 +258,7 @@ func TestGenesisWriteUpgradesRegression(t *testing.T) {
 	_, _, err := SetupGenesisBlock(db, trieDB, genesis, genesisBlock.Hash(), false)
 	require.NoError(err)
 
-	params.GetExtra(genesis.Config).UpgradeConfig.PrecompileUpgrades = []params.PrecompileUpgrade{
+	params.GetExtra(genesis.Config).UpgradeConfig.PrecompileUpgrades = []extras.PrecompileUpgrade{
 		{
 			Config: warp.NewConfig(utils.NewUint64(51), 0, false),
 		},

diff --git a/core/state_processor_test.go b/core/state_processor_test.go
@@ -38,6 +38,7 @@ import (
 	"github.com/ava-labs/coreth/core/rawdb"
 	"github.com/ava-labs/coreth/core/types"
 	"github.com/ava-labs/coreth/params"
+	"github.com/ava-labs/coreth/params/extras"
 	"github.com/ava-labs/coreth/utils"
 	"github.com/ava-labs/libevm/common"
 	"github.com/ava-labs/libevm/core/vm"
@@ -270,8 +271,8 @@ func TestStateProcessorErrors(t *testing.T) {
 						IstanbulBlock:       big.NewInt(0),
 						MuirGlacierBlock:    big.NewInt(0),
 					},
-					&params.ChainConfigExtra{
-						NetworkUpgrades: params.NetworkUpgrades{
+					&extras.ChainConfig{
+						NetworkUpgrades: extras.NetworkUpgrades{
 							ApricotPhase1BlockTimestamp: utils.NewUint64(0),
 							ApricotPhase2BlockTimestamp: utils.NewUint64(0),
 						},

diff --git a/core/vm/runtime/runtime.go b/core/vm/runtime/runtime.go
@@ -34,6 +34,7 @@ import (
 	"github.com/ava-labs/coreth/core/state"
 	"github.com/ava-labs/coreth/core/types"
 	"github.com/ava-labs/coreth/params"
+	"github.com/ava-labs/coreth/params/extras"
 	"github.com/ava-labs/libevm/common"
 	"github.com/ava-labs/libevm/core/vm"
 	"github.com/ava-labs/libevm/crypto"
@@ -84,8 +85,8 @@ func setDefaults(cfg *Config) {
 				LondonBlock:         new(big.Int),
 				BerlinBlock:         new(big.Int),
 			},
-			&params.ChainConfigExtra{
-				NetworkUpgrades: params.NetworkUpgrades{
+			&extras.ChainConfig{
+				NetworkUpgrades: extras.NetworkUpgrades{
 					ApricotPhase1BlockTimestamp: new(uint64),
 					ApricotPhase2BlockTimestamp: new(uint64),
 					ApricotPhase3BlockTimestamp: new(uint64),

diff --git a/params/config.go b/params/config.go
@@ -31,6 +31,7 @@ import (
 
 	"github.com/ava-labs/avalanchego/upgrade"
 	"github.com/ava-labs/avalanchego/utils/constants"
+	"github.com/ava-labs/coreth/params/extras"
 	"github.com/ava-labs/coreth/utils"
 	ethparams "github.com/ava-labs/libevm/params"
 )
@@ -68,9 +69,9 @@ var (
 			ShanghaiTime:        utils.TimeToNewUint64(upgrade.GetConfig(constants.UnitTestID).DurangoTime),
 			CancunTime:          utils.TimeToNewUint64(upgrade.GetConfig(constants.UnitTestID).EtnaTime),
 		},
-		&ChainConfigExtra{
-			AvalancheContext: AvalancheContext{utils.TestSnowContext()},
-			NetworkUpgrades: NetworkUpgrades{
+		&extras.ChainConfig{
+			AvalancheContext: extras.AvalancheContext{SnowCtx: utils.TestSnowContext()},
+			NetworkUpgrades: extras.NetworkUpgrades{
 				ApricotPhase1BlockTimestamp:     utils.NewUint64(0),
 				ApricotPhase2BlockTimestamp:     utils.NewUint64(0),
 				ApricotPhase3BlockTimestamp:     utils.NewUint64(0),
@@ -101,9 +102,9 @@ var (
 			IstanbulBlock:       big.NewInt(0),
 			MuirGlacierBlock:    big.NewInt(0),
 		},
-		&ChainConfigExtra{
-			AvalancheContext: AvalancheContext{utils.TestSnowContext()},
-			NetworkUpgrades: NetworkUpgrades{
+		&extras.ChainConfig{
+			AvalancheContext: extras.AvalancheContext{SnowCtx: utils.TestSnowContext()},
+			NetworkUpgrades: extras.NetworkUpgrades{
 				ApricotPhase1BlockTimestamp:     nil,
 				ApricotPhase2BlockTimestamp:     nil,
 				ApricotPhase3BlockTimestamp:     nil,
@@ -134,9 +135,9 @@ var (
 			IstanbulBlock:       big.NewInt(0),
 			MuirGlacierBlock:    big.NewInt(0),
 		},
-		&ChainConfigExtra{
-			AvalancheContext: AvalancheContext{utils.TestSnowContext()},
-			NetworkUpgrades: NetworkUpgrades{
+		&extras.ChainConfig{
+			AvalancheContext: extras.AvalancheContext{SnowCtx: utils.TestSnowContext()},
+			NetworkUpgrades: extras.NetworkUpgrades{
 				ApricotPhase1BlockTimestamp:     utils.NewUint64(0),
 				ApricotPhase2BlockTimestamp:     nil,
 				ApricotPhase3BlockTimestamp:     nil,
@@ -168,9 +169,9 @@ var (
 			MuirGlacierBlock:    big.NewInt(0),
 			BerlinBlock:         big.NewInt(0),
 		},
-		&ChainConfigExtra{
-			AvalancheContext: AvalancheContext{utils.TestSnowContext()},
-			NetworkUpgrades: NetworkUpgrades{
+		&extras.ChainConfig{
+			AvalancheContext: extras.AvalancheContext{SnowCtx: utils.TestSnowContext()},
+			NetworkUpgrades: extras.NetworkUpgrades{
 				ApricotPhase1BlockTimestamp:     utils.NewUint64(0),
 				ApricotPhase2BlockTimestamp:     utils.NewUint64(0),
 				ApricotPhase3BlockTimestamp:     nil,
@@ -203,9 +204,9 @@ var (
 			BerlinBlock:         big.NewInt(0),
 			LondonBlock:         big.NewInt(0),
 		},
-		&ChainConfigExtra{
-			AvalancheContext: AvalancheContext{utils.TestSnowContext()},
-			NetworkUpgrades: NetworkUpgrades{
+		&extras.ChainConfig{
+			AvalancheContext: extras.AvalancheContext{SnowCtx: utils.TestSnowContext()},
+			NetworkUpgrades: extras.NetworkUpgrades{
 				ApricotPhase1BlockTimestamp:     utils.NewUint64(0),
 				ApricotPhase2BlockTimestamp:     utils.NewUint64(0),
 				ApricotPhase3BlockTimestamp:     utils.NewUint64(0),
@@ -238,9 +239,9 @@ var (
 			BerlinBlock:         big.NewInt(0),
 			LondonBlock:         big.NewInt(0),
 		},
-		&ChainConfigExtra{
-			AvalancheContext: AvalancheContext{utils.TestSnowContext()},
-			NetworkUpgrades: NetworkUpgrades{
+		&extras.ChainConfig{
+			AvalancheContext: extras.AvalancheContext{SnowCtx: utils.TestSnowContext()},
+			NetworkUpgrades: extras.NetworkUpgrades{
 				ApricotPhase1BlockTimestamp:     utils.NewUint64(0),
 				ApricotPhase2BlockTimestamp:     utils.NewUint64(0),
 				ApricotPhase3BlockTimestamp:     utils.NewUint64(0),
@@ -273,9 +274,9 @@ var (
 			BerlinBlock:         big.NewInt(0),
 			LondonBlock:         big.NewInt(0),
 		},
-		&ChainConfigExtra{
-			AvalancheContext: AvalancheContext{utils.TestSnowContext()},
-			NetworkUpgrades: NetworkUpgrades{
+		&extras.ChainConfig{
+			AvalancheContext: extras.AvalancheContext{SnowCtx: utils.TestSnowContext()},
+			NetworkUpgrades: extras.NetworkUpgrades{
 				ApricotPhase1BlockTimestamp:     utils.NewUint64(0),
 				ApricotPhase2BlockTimestamp:     utils.NewUint64(0),
 				ApricotPhase3BlockTimestamp:     utils.NewUint64(0),
@@ -308,9 +309,9 @@ var (
 			BerlinBlock:         big.NewInt(0),
 			LondonBlock:         big.NewInt(0),
 		},
-		&ChainConfigExtra{
-			AvalancheContext: AvalancheContext{utils.TestSnowContext()},
-			NetworkUpgrades: NetworkUpgrades{
+		&extras.ChainConfig{
+			AvalancheContext: extras.AvalancheContext{SnowCtx: utils.TestSnowContext()},
+			NetworkUpgrades: extras.NetworkUpgrades{
 				ApricotPhase1BlockTimestamp:     utils.NewUint64(0),
 				ApricotPhase2BlockTimestamp:     utils.NewUint64(0),
 				ApricotPhase3BlockTimestamp:     utils.NewUint64(0),
@@ -343,9 +344,9 @@ var (
 			BerlinBlock:         big.NewInt(0),
 			LondonBlock:         big.NewInt(0),
 		},
-		&ChainConfigExtra{
-			AvalancheContext: AvalancheContext{utils.TestSnowContext()},
-			NetworkUpgrades: NetworkUpgrades{
+		&extras.ChainConfig{
+			AvalancheContext: extras.AvalancheContext{SnowCtx: utils.TestSnowContext()},
+			NetworkUpgrades: extras.NetworkUpgrades{
 				ApricotPhase1BlockTimestamp:     utils.NewUint64(0),
 				ApricotPhase2BlockTimestamp:     utils.NewUint64(0),
 				ApricotPhase3BlockTimestamp:     utils.NewUint64(0),
@@ -378,9 +379,9 @@ var (
 			BerlinBlock:         big.NewInt(0),
 			LondonBlock:         big.NewInt(0),
 		},
-		&ChainConfigExtra{
-			AvalancheContext: AvalancheContext{utils.TestSnowContext()},
-			NetworkUpgrades: NetworkUpgrades{
+		&extras.ChainConfig{
+			AvalancheContext: extras.AvalancheContext{SnowCtx: utils.TestSnowContext()},
+			NetworkUpgrades: extras.NetworkUpgrades{
 				ApricotPhase1BlockTimestamp:     utils.NewUint64(0),
 				ApricotPhase2BlockTimestamp:     utils.NewUint64(0),
 				ApricotPhase3BlockTimestamp:     utils.NewUint64(0),
@@ -413,9 +414,9 @@ var (
 			BerlinBlock:         big.NewInt(0),
 			LondonBlock:         big.NewInt(0),
 		},
-		&ChainConfigExtra{
-			AvalancheContext: AvalancheContext{utils.TestSnowContext()},
-			NetworkUpgrades: NetworkUpgrades{
+		&extras.ChainConfig{
+			AvalancheContext: extras.AvalancheContext{SnowCtx: utils.TestSnowContext()},
+			NetworkUpgrades: extras.NetworkUpgrades{
 				ApricotPhase1BlockTimestamp:     utils.NewUint64(0),
 				ApricotPhase2BlockTimestamp:     utils.NewUint64(0),
 				ApricotPhase3BlockTimestamp:     utils.NewUint64(0),
@@ -448,9 +449,9 @@ var (
 			BerlinBlock:         big.NewInt(0),
 			LondonBlock:         big.NewInt(0),
 		},
-		&ChainConfigExtra{
-			AvalancheContext: AvalancheContext{utils.TestSnowContext()},
-			NetworkUpgrades: NetworkUpgrades{
+		&extras.ChainConfig{
+			AvalancheContext: extras.AvalancheContext{SnowCtx: utils.TestSnowContext()},
+			NetworkUpgrades: extras.NetworkUpgrades{
 				ApricotPhase1BlockTimestamp:     utils.NewUint64(0),
 				ApricotPhase2BlockTimestamp:     utils.NewUint64(0),
 				ApricotPhase3BlockTimestamp:     utils.NewUint64(0),
@@ -484,9 +485,9 @@ var (
 			LondonBlock:         big.NewInt(0),
 			ShanghaiTime:        utils.NewUint64(0),
 		},
-		&ChainConfigExtra{
-			AvalancheContext: AvalancheContext{utils.TestSnowContext()},
-			NetworkUpgrades: NetworkUpgrades{
+		&extras.ChainConfig{
+			AvalancheContext: extras.AvalancheContext{SnowCtx: utils.TestSnowContext()},
+			NetworkUpgrades: extras.NetworkUpgrades{
 				ApricotPhase1BlockTimestamp:     utils.NewUint64(0),
 				ApricotPhase2BlockTimestamp:     utils.NewUint64(0),
 				ApricotPhase3BlockTimestamp:     utils.NewUint64(0),
@@ -521,9 +522,9 @@ var (
 			ShanghaiTime:        utils.NewUint64(0),
 			CancunTime:          utils.NewUint64(0),
 		},
-		&ChainConfigExtra{
-			AvalancheContext: AvalancheContext{utils.TestSnowContext()},
-			NetworkUpgrades: NetworkUpgrades{
+		&extras.ChainConfig{
+			AvalancheContext: extras.AvalancheContext{SnowCtx: utils.TestSnowContext()},
+			NetworkUpgrades: extras.NetworkUpgrades{
 				ApricotPhase1BlockTimestamp:     utils.NewUint64(0),
 				ApricotPhase2BlockTimestamp:     utils.NewUint64(0),
 				ApricotPhase3BlockTimestamp:     utils.NewUint64(0),