Review of params package in #662

params/config.go

@@ -45,9 +45,10 @@ var (
  AvalancheLocalChainID = big.NewInt(43112)
 )
 
-var (
- _ = do_init() // XXX: is (temporarily) here because type registration must proceed the call to .Rules()
+// Guarantees extras initialisation before a call to [ChainConfig.Rules].
+var _ = libevmInit()
 
+var (
  TestChainConfig = WithExtra(
  &ChainConfig{
  ChainID: big.NewInt(1),

params/config_extra.go

@@ -56,27 +56,29 @@ func SetEthUpgrades(c *ChainConfig) {
  // number of 0 as well.
  initiallyActive := uint64(upgrade.InitiallyActiveTime.Unix())
  extra := GetExtra(c)
- if extra != nil && extra.ApricotPhase2BlockTimestamp != nil && *extra.ApricotPhase2BlockTimestamp <= initiallyActive && c.BerlinBlock == nil {
+ if extra.ApricotPhase2BlockTimestamp != nil && *extra.ApricotPhase2BlockTimestamp <= initiallyActive && c.BerlinBlock == nil {
  c.BerlinBlock = big.NewInt(0)
  }
- if extra != nil && extra.ApricotPhase3BlockTimestamp != nil && *extra.ApricotPhase3BlockTimestamp <= initiallyActive && c.LondonBlock == nil {
+ if extra.ApricotPhase3BlockTimestamp != nil && *extra.ApricotPhase3BlockTimestamp <= initiallyActive && c.LondonBlock == nil {
  c.LondonBlock = big.NewInt(0)
  }
  }
  extra := GetExtra(c)
- if extra != nil && extra.DurangoBlockTimestamp != nil {
+ if extra.DurangoBlockTimestamp != nil {
  c.ShanghaiTime = utils.NewUint64(*extra.DurangoBlockTimestamp)
  }
- if extra != nil && extra.EtnaTimestamp != nil {
+ if extra.EtnaTimestamp != nil {
  c.CancunTime = utils.NewUint64(*extra.EtnaTimestamp)
  }
 }
 
 func GetExtra(c *ChainConfig) *ChainConfigExtra {
- if extra := FromChainConfig(c); extra != nil {
- return extra
+ ex := extras.FromChainConfig(c)
+ if ex == nil {
+ ex = &ChainConfigExtra{}
+ extras.SetOnChainConfig(c, ex)
  }
- return &ChainConfigExtra{}
+ return ex
 }
 
 func Copy(c *ChainConfig) ChainConfig {
@@ -85,6 +87,7 @@ func Copy(c *ChainConfig) ChainConfig {
  return *WithExtra(&cpy, &extraCpy)
 }
 
+// WithExtra sets the extra payload on `c` and returns the modified argument.
 func WithExtra(c *ChainConfig, extra *ChainConfigExtra) *ChainConfig {
  extras.SetOnChainConfig(c, extra)
  return c
@@ -370,7 +373,7 @@ func ToWithUpgradesJSON(c *ChainConfig) *ChainConfigWithUpgradesJSON {
 }
 
 func GetChainConfig(agoUpgrade upgrade.Config, chainID *big.Int) *ChainConfig {
- c := WithExtra(
+ return WithExtra(
  &ChainConfig{
  ChainID: chainID,
  HomesteadBlock: big.NewInt(0),
@@ -389,7 +392,6 @@ func GetChainConfig(agoUpgrade upgrade.Config, chainID *big.Int) *ChainConfig {
  NetworkUpgrades: getNetworkUpgrades(agoUpgrade),
  },
  )
- return c
 }
 
 func ptrToString(val *uint64) string {

params/config_libevm.go

@@ -12,7 +12,9 @@ import (
  gethparams "github.com/ethereum/go-ethereum/params"
 )
 
-func do_init() any {
+// libevmInit would ideally be a regular init() function, but it MUST be run
+// before any calls to [ChainConfig.Rules]. See `config.go` for its call site.
+func libevmInit() any {
  extras = gethparams.RegisterExtras(gethparams.Extras[*ChainConfigExtra, RulesExtra]{
  ReuseJSONRoot: true, // Reuse the root JSON input when unmarshalling the extra payload.
  NewRules: constructRulesExtra,
@@ -31,8 +33,6 @@ func constructRulesExtra(c *gethparams.ChainConfig, r *gethparams.Rules, cEx *Ch
  return rules
  }
  rules.AvalancheRules = cEx.GetAvalancheRules(timestamp)
- rules.chainConfig = c
- rules.gethrules = *r
 
  // Initialize the stateful precompiles that should be enabled at [blockTimestamp].
  rules.Precompiles = make(map[common.Address]precompileconfig.Config)
@@ -52,13 +52,3 @@ func constructRulesExtra(c *gethparams.ChainConfig, r *gethparams.Rules, cEx *Ch
 
  return rules
 }
-
-// FromChainConfig returns the extra payload carried by the ChainConfig.
-func FromChainConfig(c *gethparams.ChainConfig) *ChainConfigExtra {
- return extras.FromChainConfig(c)
-}
-
-// FromRules returns the extra payload carried by the Rules.
-func FromRules(r *gethparams.Rules) RulesExtra {
- return extras.FromRules(r)
-}

params/hooks_libevm.go

@@ -16,7 +16,6 @@ import (
  "github.com/ethereum/go-ethereum/common"
  "github.com/ethereum/go-ethereum/core/vm"
  "github.com/ethereum/go-ethereum/libevm"
- gethparams "github.com/ethereum/go-ethereum/params"
  "github.com/holiman/uint256"
  "golang.org/x/exp/maps"
 )
@@ -112,8 +111,7 @@ func makePrecompile(contract contract.StatefulPrecompiledContract) libevm.Precom
  predicateResultsBytes = header.Extra[DynamicFeeExtraDataSize:]
  }
  accessableState := accessableState{
- env: env,
- chainConfig: GetRulesExtra(env.Rules()).chainConfig,
+ env: env,
  blockContext: &BlockContext{
  number: env.BlockNumber(),
  time: env.BlockTime(),
@@ -142,7 +140,6 @@ func (r RulesExtra) PrecompileOverride(addr common.Address) (libevm.PrecompiledC
 
 type accessableState struct {
  env vm.PrecompileEnvironment
- chainConfig *gethparams.ChainConfig
  blockContext *BlockContext
 }
 
@@ -162,12 +159,11 @@ func (a accessableState) GetBlockContext() contract.BlockContext {
 }
 
 func (a accessableState) GetChainConfig() precompileconfig.ChainConfig {
- extra := GetExtra(a.chainConfig)
- return extra
+ return GetExtra(a.env.ChainConfig())
 }
 
 func (a accessableState) GetSnowContext() *snow.Context {
- return GetExtra(a.chainConfig).SnowCtx
+ return GetExtra(a.env.ChainConfig()).SnowCtx
 }
 
 func (a accessableState) NativeAssetCall(caller common.Address, input []byte, suppliedGas uint64, gasCost uint64, readOnly bool) (ret []byte, remainingGas uint64, err error) {

params/rules_extra.go

@@ -6,18 +6,13 @@ package params
 import (
  "github.com/ava-labs/coreth/precompile/precompileconfig"
  "github.com/ethereum/go-ethereum/common"
- gethparams "github.com/ethereum/go-ethereum/params"
 )
 
 func GetRulesExtra(r Rules) *RulesExtra {
- extra := FromRules(&r)
- return &extra
+ return extras.PointerFromRules(&r)
 }
 
 type RulesExtra struct {
- chainConfig *ChainConfig
- gethrules gethparams.Rules
-
  // Rules for Avalanche releases
  AvalancheRules
 
@@ -39,8 +34,8 @@ func (r *RulesExtra) PredicatersExist() bool {
 }
 
 func (r *RulesExtra) PredicaterExists(addr common.Address) bool {
- _, PredicaterExists := r.Predicaters[addr]
- return PredicaterExists
+ _, ok := r.Predicaters[addr]
+ return ok
 }
 
 // IsPrecompileEnabled returns true if the precompile at [addr] is enabled for this rule set.