refactor: simplify ChainConfig.UnmarshalJSON() branches

Author: ARR4N

params/config.go

@@ -478,7 +478,7 @@ func (c *ChainConfig) Description() string {
 	if c.VerkleTime != nil {
 		banner += fmt.Sprintf(" - Verkle:                      @%-10v\n", *c.VerkleTime)
 	}
-	return banner
+	return banner + c.extraDescription()
 }
 
 // IsHomestead returns whether num is either equal to the homestead block or greater.
@@ -671,7 +671,7 @@ func (c *ChainConfig) CheckConfigForkOrder() error {
 			lastFork = cur
 		}
 	}
-	return nil
+	return c.extraCheckConfigForkOrder()
 }
 
 func (c *ChainConfig) checkCompatible(newcfg *ChainConfig, headNumber *big.Int, headTimestamp uint64) *ConfigCompatError {
@@ -742,7 +742,7 @@ func (c *ChainConfig) checkCompatible(newcfg *ChainConfig, headNumber *big.Int,
 	if isForkTimestampIncompatible(c.VerkleTime, newcfg.VerkleTime, headTimestamp) {
 		return newTimestampCompatError("Verkle fork timestamp", c.VerkleTime, newcfg.VerkleTime)
 	}
-	return nil
+	return c.extraCheckCompatible(newcfg, headNumber, headTimestamp)
 }
 
 // BaseFeeChangeDenominator bounds the amount the base fee can change between blocks.

params/config.libevm.go

@@ -205,3 +205,48 @@ func (r *Rules) extraPayload() *pseudo.Type {
 	}
 	return r.extra
 }
+
+func (c *ChainConfig) extraDescription() string {
+	if registeredExtras == nil || c.extra == nil {
+		return ""
+	}
+
+	type Descriptioner interface {
+		Description() string
+	}
+	d, ok := c.extra.Interface().(Descriptioner)
+	if !ok {
+		return ""
+	}
+	return d.Description()
+}
+
+func (c *ChainConfig) extraCheckCompatible(newcfg *ChainConfig, headNumber *big.Int, headTimestamp uint64) *ConfigCompatError {
+	if registeredExtras == nil || c.extra == nil {
+		return nil
+	}
+
+	type CompatibleChecker interface {
+		CheckCompatible(*ChainConfig, *big.Int, uint64) *ConfigCompatError
+	}
+	cc, ok := c.extra.Interface().(CompatibleChecker)
+	if !ok {
+		return nil
+	}
+	return cc.CheckCompatible(newcfg, headNumber, headTimestamp)
+}
+
+func (c *ChainConfig) extraCheckConfigForkOrder() error {
+	if registeredExtras == nil || c.extra == nil {
+		return nil
+	}
+
+	type ForkOrderChecker interface {
+		CheckConfigForkOrder() error
+	}
+	cc, ok := c.extra.Interface().(ForkOrderChecker)
+	if !ok {
+		return nil
+	}
+	return cc.CheckConfigForkOrder()
+}

params/json.libevm.go

@@ -25,29 +25,20 @@ type chainConfigWithExportedExtra struct {
 
 // UnmarshalJSON implements the [json.Unmarshaler] interface.
 func (c *ChainConfig) UnmarshalJSON(data []byte) error {
-	extras := registeredExtras
-
-	if extras != nil && !extras.reuseJSONRoot {
+	switch reg := registeredExtras; {
+	case reg != nil && !reg.reuseJSONRoot:
 		return c.unmarshalJSONWithExtra(data)
-	}
-
-	if err := json.Unmarshal(data, (*chainConfigWithoutMethods)(c)); err != nil {
-		return err
-	}
-	if extras == nil {
-		return nil
-	}
-
-	// Invariants if here:
-	// - reg.reuseJSONRoot == true
-	// - Non-extra ChainConfig fields already unmarshalled
 
-	c.extra = extras.chainConfig.NilPointer()
-	if err := json.Unmarshal(data, c.extra); err != nil {
-		c.extra = nil
-		return err
+	case reg != nil && reg.reuseJSONRoot: // although the latter is redundant, it's clearer
+		c.extra = reg.chainConfig.NilPointer()
+		if err := json.Unmarshal(data, c.extra); err != nil {
+			c.extra = nil
+			return err
+		}
+		fallthrough // Important! We've only unmarshalled the extra field.
+	default: // reg == nil
+		return json.Unmarshal(data, (*chainConfigWithoutMethods)(c))
 	}
-	return nil
 }
 
 // unmarshalJSONWithExtra unmarshals JSON under the assumption that the
@@ -67,14 +58,14 @@ func (c *ChainConfig) unmarshalJSONWithExtra(data []byte) error {
 
 // MarshalJSON implements the [json.Marshaler] interface.
 func (c *ChainConfig) MarshalJSON() ([]byte, error) {
-	switch extras := registeredExtras; {
-	case extras == nil:
+	switch reg := registeredExtras; {
+	case reg == nil:
 		return json.Marshal((*chainConfigWithoutMethods)(c))
 
-	case !extras.reuseJSONRoot:
+	case !reg.reuseJSONRoot:
 		return c.marshalJSONWithExtra()
 
-	default:
+	default: // reg.reuseJSONRoot == true
 		// The inverse of reusing the JSON root is merging two JSON buffers,
 		// which isn't supported by the native package. So we use
 		// map[string]json.RawMessage intermediates.