common: Fix hardfork changes (#2331)

g11tech · web-flow · commit a7bb5ba82848 · 2022-10-06T11:27:56.000+02:00
* common: Fix hardfork changes

* fix the spec hfs
diff --git a/packages/client/test/integration/merge.spec.ts b/packages/client/test/integration/merge.spec.ts
@@ -32,6 +32,7 @@ tape('[Integration:Merge]', async (t) => {
         },
       },
       hardforks: [
+        { name: 'chainstart', block: 0 },
         { name: 'london', block: 0 },
         {
           name: 'merge',
@@ -52,6 +53,7 @@ tape('[Integration:Merge]', async (t) => {
         extraData: '0x3535353535353535353535353535353535353535353535353535353535353535',
       },
       hardforks: [
+        { name: 'chainstart', block: 0 },
         { name: 'london', block: 0 },
         {
           name: 'merge',
diff --git a/packages/common/src/common.ts b/packages/common/src/common.ts
@@ -9,7 +9,7 @@ import * as ropsten from './chains/ropsten.json'
 import * as sepolia from './chains/sepolia.json'
 import { EIPs } from './eips'
 import { Chain, CustomChain, Hardfork } from './enums'
-import { hardforks as HARDFORK_CHANGES } from './hardforks'
+import { hardforks as HARDFORK_SPECS } from './hardforks'
 import { parseGethGenesis } from './utils'
 
 import type { ConsensusAlgorithm, ConsensusType } from './enums'
@@ -29,6 +29,8 @@ import type {
 } from './types'
 import type { BigIntLike } from '@ethereumjs/util'
 
+type HardforkSpecKeys = keyof typeof HARDFORK_SPECS
+type HardforkSpecValues = typeof HARDFORK_SPECS[HardforkSpecKeys]
 /**
  * Common class to access chain and hardfork parameters and to provide
  * a unified and shared view on the network and hardfork state.
@@ -45,6 +47,8 @@ export class Common extends EventEmitter {
   private _eips: number[] = []
   private _customChains: ChainConfig[]
 
+  private HARDFORK_CHANGES: [HardforkSpecKeys, HardforkSpecValues][]
+
   /**
    * Creates a {@link Common} object for a custom chain, based on a standard one.
    *
@@ -214,6 +218,11 @@ export class Common extends EventEmitter {
     this._customChains = opts.customChains ?? []
     this._chainParams = this.setChain(opts.chain)
     this.DEFAULT_HARDFORK = this._chainParams.defaultHardfork ?? Hardfork.Merge
+    // Assign hardfork changes in the sequence of the applied hardforks
+    this.HARDFORK_CHANGES = this.hardforks().map((hf) => [
+      hf.name as HardforkSpecKeys,
+      HARDFORK_SPECS[hf.name as HardforkSpecKeys],
+    ])
     this._hardfork = this.DEFAULT_HARDFORK
     if (opts.hardfork !== undefined) {
       this.setHardfork(opts.hardfork)
@@ -262,7 +271,7 @@ export class Common extends EventEmitter {
    */
   setHardfork(hardfork: string | Hardfork): void {
     let existing = false
-    for (const hfChanges of HARDFORK_CHANGES) {
+    for (const hfChanges of this.HARDFORK_CHANGES) {
       if (hfChanges[0] === hardfork) {
         if (this._hardfork !== hardfork) {
           this._hardfork = hardfork
@@ -432,7 +441,7 @@ export class Common extends EventEmitter {
    */
   paramByHardfork(topic: string, name: string, hardfork: string | Hardfork): bigint {
     let value = null
-    for (const hfChanges of HARDFORK_CHANGES) {
+    for (const hfChanges of this.HARDFORK_CHANGES) {
       // EIP-referencing HF file (e.g. berlin.json)
       if ('eips' in hfChanges[1]) {
         const hfEIPs = hfChanges[1]['eips']
@@ -504,7 +513,7 @@ export class Common extends EventEmitter {
     if (this.eips().includes(eip)) {
       return true
     }
-    for (const hfChanges of HARDFORK_CHANGES) {
+    for (const hfChanges of this.HARDFORK_CHANGES) {
       const hf = hfChanges[1]
       if (this.gteHardfork(hf['name']) && 'eips' in hf) {
         if ((hf['eips'] as number[]).includes(eip)) {
@@ -591,7 +600,7 @@ export class Common extends EventEmitter {
    * @returns Block number or null if unscheduled
    */
   eipBlock(eip: number): bigint | null {
-    for (const hfChanges of HARDFORK_CHANGES) {
+    for (const hfChanges of this.HARDFORK_CHANGES) {
       const hf = hfChanges[1]
       if ('eips' in hf) {
         // eslint-disable-next-line @typescript-eslint/strict-boolean-expressions
@@ -834,7 +843,7 @@ export class Common extends EventEmitter {
     const hardfork = this.hardfork()
 
     let value
-    for (const hfChanges of HARDFORK_CHANGES) {
+    for (const hfChanges of this.HARDFORK_CHANGES) {
       if ('consensus' in hfChanges[1]) {
         value = hfChanges[1]['consensus']['type']
       }
@@ -856,7 +865,7 @@ export class Common extends EventEmitter {
     const hardfork = this.hardfork()
 
     let value
-    for (const hfChanges of HARDFORK_CHANGES) {
+    for (const hfChanges of this.HARDFORK_CHANGES) {
       if ('consensus' in hfChanges[1]) {
         value = hfChanges[1]['consensus']['algorithm']
       }
@@ -883,7 +892,7 @@ export class Common extends EventEmitter {
     const hardfork = this.hardfork()
 
     let value
-    for (const hfChanges of HARDFORK_CHANGES) {
+    for (const hfChanges of this.HARDFORK_CHANGES) {
       if ('consensus' in hfChanges[1]) {
         // The config parameter is named after the respective consensus algorithm
         value = hfChanges[1]['consensus'][hfChanges[1]['consensus']['algorithm']]
diff --git a/packages/common/src/hardforks/index.ts b/packages/common/src/hardforks/index.ts
@@ -1,19 +1,19 @@
-export const hardforks = [
-  ['chainstart', require('./chainstart.json')],
-  ['homestead', require('./homestead.json')],
-  ['dao', require('./dao.json')],
-  ['tangerineWhistle', require('./tangerineWhistle.json')],
-  ['spuriousDragon', require('./spuriousDragon.json')],
-  ['byzantium', require('./byzantium.json')],
-  ['constantinople', require('./constantinople.json')],
-  ['petersburg', require('./petersburg.json')],
-  ['istanbul', require('./istanbul.json')],
-  ['muirGlacier', require('./muirGlacier.json')],
-  ['berlin', require('./berlin.json')],
-  ['london', require('./london.json')],
-  ['shanghai', require('./shanghai.json')],
-  ['arrowGlacier', require('./arrowGlacier.json')],
-  ['grayGlacier', require('./grayGlacier.json')],
-  ['mergeForkIdTransition', require('./mergeForkIdTransition.json')],
-  ['merge', require('./merge.json')],
-]
+export const hardforks = {
+  chainstart: require('./chainstart.json'),
+  homestead: require('./homestead.json'),
+  dao: require('./dao.json'),
+  tangerineWhistle: require('./tangerineWhistle.json'),
+  spuriousDragon: require('./spuriousDragon.json'),
+  byzantium: require('./byzantium.json'),
+  constantinople: require('./constantinople.json'),
+  petersburg: require('./petersburg.json'),
+  istanbul: require('./istanbul.json'),
+  muirGlacier: require('./muirGlacier.json'),
+  berlin: require('./berlin.json'),
+  london: require('./london.json'),
+  shanghai: require('./shanghai.json'),
+  arrowGlacier: require('./arrowGlacier.json'),
+  grayGlacier: require('./grayGlacier.json'),
+  mergeForkIdTransition: require('./mergeForkIdTransition.json'),
+  merge: require('./merge.json'),
+}
diff --git a/packages/common/tests/hardforks.spec.ts b/packages/common/tests/hardforks.spec.ts
@@ -395,4 +395,78 @@ tape('[Common]: Hardfork logic', function (t: tape.Test) {
 
     st.end()
   })
+
+  t.test('Should correctly apply hardfork changes', function (st: tape.Test) {
+    // For sepolia MergeForkIdTransition happens AFTER merge
+    let c = new Common({ chain: Chain.Sepolia, hardfork: Hardfork.London })
+    st.equal(
+      c['HARDFORK_CHANGES'][11][0],
+      Hardfork.Merge,
+      'should correctly apply hardfork changes'
+    )
+    st.equal(
+      c['HARDFORK_CHANGES'][12][0],
+      Hardfork.MergeForkIdTransition,
+      'should correctly apply hardfork changes'
+    )
+
+    // Should give correct ConsensusType pre and post merge
+    st.equal(
+      c.consensusType(),
+      ConsensusType.ProofOfWork,
+      'should provide the correct initial chain consensus type'
+    )
+    c.setHardfork(Hardfork.Merge)
+    st.equal(
+      c.consensusType(),
+      ConsensusType.ProofOfStake,
+      `should switch to ProofOfStake consensus on merge`
+    )
+    c.setHardfork(Hardfork.MergeForkIdTransition)
+    st.equal(
+      c.consensusType(),
+      ConsensusType.ProofOfStake,
+      `should stay on ProofOfStake consensus post merge`
+    )
+
+    // For kiln MergeForkIdTransition happens BEFORE Merge
+    const json = require(`../../blockchain/test/testdata/geth-genesis-kiln.json`)
+    c = Common.fromGethGenesis(json, {
+      chain: 'kiln',
+    })
+
+    // MergeForkIdTransition change should be before Merge
+    st.equal(
+      c['HARDFORK_CHANGES'][10][0],
+      Hardfork.MergeForkIdTransition,
+      'should correctly apply hardfork changes'
+    )
+    st.equal(
+      c['HARDFORK_CHANGES'][11][0],
+      Hardfork.Merge,
+      'should correctly apply hardfork changes'
+    )
+
+    // Should give correct ConsensusType pre and post merge
+    c.setHardfork(Hardfork.London)
+    st.equal(
+      c.consensusType(),
+      ConsensusType.ProofOfWork,
+      'should provide the correct initial chain consensus type'
+    )
+    c.setHardfork(Hardfork.Merge)
+    st.equal(
+      c.consensusType(),
+      ConsensusType.ProofOfStake,
+      `should switch to ProofOfStake consensus on merge`
+    )
+    c.setHardfork(Hardfork.MergeForkIdTransition)
+    st.equal(
+      c.consensusType(),
+      ConsensusType.ProofOfWork,
+      `should give pow consensus as MergeForkIdTransition is pre-merge`
+    )
+
+    st.end()
+  })
 })
diff --git a/packages/common/tests/mergePOS.spec.ts b/packages/common/tests/mergePOS.spec.ts
@@ -181,7 +181,7 @@ tape('[Common]: Merge/POS specific logic', function (t: tape.Test) {
 
   t.test('Pure POS testnet', function (st: tape.Test) {
     const customChains = [testnetPOS]
-    const c = new Common({ chain: 'testnetPOS', hardfork: Hardfork.Istanbul, customChains })
+    const c = new Common({ chain: 'testnetPOS', hardfork: Hardfork.Chainstart, customChains })
 
     st.equal(c.hardforkTTD(Hardfork.Chainstart), BigInt(0), 'should get the HF total difficulty')
 
@@ -190,6 +190,17 @@ tape('[Common]: Merge/POS specific logic', function (t: tape.Test) {
     st.end()
   })
 
+  t.test('Should fail setting invalid hardfork', function (st: tape.Test) {
+    const customChains = [testnetPOS]
+    try {
+      new Common({ chain: 'testnetPOS', hardfork: Hardfork.Istanbul, customChains })
+      st.fail(`should have failed setting absent hardfork instanbul`)
+    } catch (e) {
+      st.pass(`failed setting absent hardfork instanbul`)
+    }
+    st.end()
+  })
+
   t.test('should get the correct merge hardfork at genesis', async (st) => {
     const json = require(`../../client/test/testdata/geth-genesis/post-merge.json`)
     const c = Common.fromGethGenesis(json, { chain: 'post-merge' })
