common/blockchain genesis refactor (#1916)

Author: ryanio

.github/workflows/e2e-hardhat.yml

@@ -4,6 +4,7 @@ on:
     branches: [master]
     tags: ['*']
   pull_request:
+    branches: [master]
     types: [opened, reopened, synchronize]
 
 env:

README.md

@@ -48,6 +48,7 @@ Detailed version can be seen on [Codecov.io][coverage-link]
    trie --> client
    trie --> vm
    trie --> block
+   trie --> blockchain
    common --> block
    common --> blockchain
    common --> tx

packages/block/src/block.ts

@@ -128,14 +128,6 @@ export class Block {
     return new Block(header, transactions, uncleHeaders, opts)
   }
 
-  /**
-   * Alias for {@link Block.fromBlockData} with {@link BlockOptions.initWithGenesisHeader} set to true.
-   */
-  public static genesis(blockData: BlockData = {}, opts?: BlockOptions) {
-    opts = { ...opts, initWithGenesisHeader: true }
-    return Block.fromBlockData(blockData, opts)
-  }
-
   /**
    * This constructor takes the values, validates them, assigns them and freezes the object.
    * Use the static factory methods to assist in creating a Block object from varying data types and options.
@@ -185,7 +177,7 @@ export class Block {
   }
 
   /**
-   * Produces a hash the RLP of the block.
+   * Returns the hash of the block.
    */
   hash(): Buffer {
     return this.header.hash()

packages/block/src/header.ts

@@ -19,7 +19,6 @@ import {
   intToBuffer,
   KECCAK256_RLP_ARRAY,
   KECCAK256_RLP,
-  toBuffer,
   toType,
   TypeOutput,
   zeros,
@@ -163,15 +162,6 @@ export class BlockHeader {
       opts
     )
   }
-
-  /**
-   * Alias for {@link BlockHeader.fromHeaderData} with {@link BlockOptions.initWithGenesisHeader} set to true.
-   */
-  public static genesis(headerData: HeaderData = {}, opts?: BlockOptions) {
-    opts = { ...opts, initWithGenesisHeader: true }
-    return BlockHeader.fromHeaderData(headerData, opts)
-  }
-
   /**
    * This constructor takes the values, validates them, assigns them and freezes the object.
    *
@@ -186,9 +176,6 @@ export class BlockHeader {
       this._common = new Common({
         chain: Chain.Mainnet, // default
       })
-      if (options.initWithGenesisHeader) {
-        this._common.setHardforkByBlockNumber(0)
-      }
     }
 
     if (options.hardforkByBlockNumber !== undefined && options.hardforkByTD !== undefined) {
@@ -221,19 +208,19 @@ export class BlockHeader {
     const coinbase = headerData.coinbase
       ? new Address(toType(headerData.coinbase, TypeOutput.Buffer))
       : defaults.coinbase
-    let stateRoot = toType(headerData.stateRoot, TypeOutput.Buffer) ?? defaults.stateRoot
+    const stateRoot = toType(headerData.stateRoot, TypeOutput.Buffer) ?? defaults.stateRoot
     const transactionsTrie =
       toType(headerData.transactionsTrie, TypeOutput.Buffer) ?? defaults.transactionsTrie
     const receiptTrie = toType(headerData.receiptTrie, TypeOutput.Buffer) ?? defaults.receiptTrie
     const logsBloom = toType(headerData.logsBloom, TypeOutput.Buffer) ?? defaults.logsBloom
-    let difficulty = toType(headerData.difficulty, TypeOutput.BigInt) ?? defaults.difficulty
-    let number = toType(headerData.number, TypeOutput.BigInt) ?? defaults.number
-    let gasLimit = toType(headerData.gasLimit, TypeOutput.BigInt) ?? defaults.gasLimit
+    const difficulty = toType(headerData.difficulty, TypeOutput.BigInt) ?? defaults.difficulty
+    const number = toType(headerData.number, TypeOutput.BigInt) ?? defaults.number
+    const gasLimit = toType(headerData.gasLimit, TypeOutput.BigInt) ?? defaults.gasLimit
     const gasUsed = toType(headerData.gasUsed, TypeOutput.BigInt) ?? defaults.gasUsed
-    let timestamp = toType(headerData.timestamp, TypeOutput.BigInt) ?? defaults.timestamp
-    let extraData = toType(headerData.extraData, TypeOutput.Buffer) ?? defaults.extraData
+    const timestamp = toType(headerData.timestamp, TypeOutput.BigInt) ?? defaults.timestamp
+    const extraData = toType(headerData.extraData, TypeOutput.Buffer) ?? defaults.extraData
     const mixHash = toType(headerData.mixHash, TypeOutput.Buffer) ?? defaults.mixHash
-    let nonce = toType(headerData.nonce, TypeOutput.Buffer) ?? defaults.nonce
+    const nonce = toType(headerData.nonce, TypeOutput.Buffer) ?? defaults.nonce
     let baseFeePerGas =
       toType(headerData.baseFeePerGas, TypeOutput.BigInt) ?? defaults.baseFeePerGas
 
@@ -260,34 +247,6 @@ export class BlockHeader {
       }
     }
 
-    if (options.initWithGenesisHeader) {
-      number = BigInt(0)
-      if (gasLimit === DEFAULT_GAS_LIMIT) {
-        gasLimit = BigInt(this._common.genesis().gasLimit)
-      }
-      if (timestamp === BigInt(0)) {
-        timestamp = BigInt(this._common.genesis().timestamp ?? 0)
-      }
-      if (difficulty === BigInt(0)) {
-        difficulty = BigInt(this._common.genesis().difficulty)
-      }
-      if (extraData.length === 0) {
-        extraData = toBuffer(this._common.genesis().extraData)
-      }
-      if (nonce.equals(zeros(8))) {
-        nonce = toBuffer(this._common.genesis().nonce)
-      }
-      if (stateRoot.equals(zeros(32))) {
-        stateRoot = toBuffer(this._common.genesis().stateRoot)
-      }
-      if (
-        this._common.gteHardfork(Hardfork.London) &&
-        this._common.genesis().baseFeePerGas !== undefined
-      ) {
-        baseFeePerGas = BigInt(this._common.genesis().baseFeePerGas!)
-      }
-    }
-
     this.parentHash = parentHash
     this.uncleHash = uncleHash
     this.coinbase = coinbase

packages/block/src/types.ts

@@ -39,18 +39,6 @@ export interface BlockOptions {
    * pointing to a Shanghai block: this will lead to set the HF as Shanghai and not the Merge).
    */
   hardforkByTD?: BigIntLike
-  /**
-   * Turns the block header into the canonical genesis block header
-   *
-   * If set to `true` all other header data is ignored.
-   *
-   * If a {@link Common} instance is passed the instance need to be set to `chainstart` as a HF,
-   * otherwise usage of this option will throw
-   *
-   * Default: `false`
-   */
-  initWithGenesisHeader?: boolean
-
   /**
    * If a preceding {@link BlockHeader} (usually the parent header) is given the preceding
    * header will be used to calculate the difficulty for this block and the calculated

packages/block/test/block.spec.ts

@@ -21,7 +21,7 @@ import util from 'util'
 tape('[Block]: block functions', function (t) {
   t.test('should test block initialization', function (st) {
     const common = new Common({ chain: Chain.Mainnet, hardfork: Hardfork.Chainstart })
-    const genesis = Block.genesis({}, { common })
+    const genesis = Block.fromBlockData({}, { common })
     st.ok(genesis.hash().toString('hex'), 'block should initialize')
 
     // test default freeze values
@@ -181,7 +181,7 @@ tape('[Block]: block functions', function (t) {
     const blockchain = new Mockchain()
     const block = blockFromRpc(testDataFromRpcGoerli, [], { common })
 
-    const genesis = Block.genesis({}, { common })
+    const genesis = Block.fromBlockData({}, { common })
     await blockchain.putBlock(genesis)
 
     const parentBlock = Block.fromBlockData(
@@ -262,7 +262,7 @@ tape('[Block]: block functions', function (t) {
     const common = new Common({ chain: Chain.Mainnet, hardfork: Hardfork.Chainstart })
     const blockchain = new Mockchain()
 
-    const genesis = Block.genesis({})
+    const genesis = Block.fromBlockData({})
     await blockchain.putBlock(genesis)
 
     const uncleBlock1 = createBlock(genesis, 'uncle', [], common)
@@ -286,7 +286,7 @@ tape('[Block]: block functions', function (t) {
     const common = new Common({ chain: Chain.Mainnet, hardfork: Hardfork.Chainstart })
     const blockchain = new Mockchain()
 
-    const genesis = Block.genesis({})
+    const genesis = Block.fromBlockData({})
     await blockchain.putBlock(genesis)
 
     const uncleBlock = createBlock(genesis, 'uncle', [], common)
@@ -319,7 +319,7 @@ tape('[Block]: block functions', function (t) {
       const common = new Common({ chain: Chain.Mainnet, hardfork: Hardfork.Chainstart })
       const blockchain = new Mockchain()
 
-      const genesis = Block.genesis({})
+      const genesis = Block.fromBlockData({})
       await blockchain.putBlock(genesis)
 
       const emptyBlock = Block.fromBlockData({ header: { number: BigInt(1) } }, { common })
@@ -354,7 +354,7 @@ tape('[Block]: block functions', function (t) {
     const common = new Common({ chain: Chain.Mainnet, hardfork: Hardfork.Chainstart })
     const blockchain = new Mockchain()
 
-    const genesis = Block.genesis({})
+    const genesis = Block.fromBlockData({})
     await blockchain.putBlock(genesis)
 
     const uncleBlock = createBlock(genesis, 'uncle', [], common)
@@ -385,7 +385,7 @@ tape('[Block]: block functions', function (t) {
     const common = new Common({ chain: Chain.Mainnet, hardfork: Hardfork.Chainstart })
     const blockchain = new Mockchain()
 
-    const genesis = Block.genesis({})
+    const genesis = Block.fromBlockData({})
     await blockchain.putBlock(genesis)
 
     const uncleBlock = createBlock(genesis, 'uncle', [], common)
@@ -406,7 +406,7 @@ tape('[Block]: block functions', function (t) {
     const common = new Common({ chain: Chain.Mainnet, hardfork: Hardfork.Chainstart })
     const blockchain = new Mockchain()
 
-    const genesis = Block.genesis({})
+    const genesis = Block.fromBlockData({})
     await blockchain.putBlock(genesis)
 
     const uncleBlock = Block.fromBlockData(
@@ -441,7 +441,7 @@ tape('[Block]: block functions', function (t) {
     const common = new Common({ chain: Chain.Mainnet, hardfork: Hardfork.Chainstart })
     const blockchain = new Mockchain()
 
-    const genesis = Block.genesis({})
+    const genesis = Block.fromBlockData({})
     await blockchain.putBlock(genesis)
 
     const uncleBlock1 = createBlock(genesis, 'uncle1', [], common)
@@ -482,7 +482,7 @@ tape('[Block]: block functions', function (t) {
     const common = new Common({ chain: Chain.Mainnet, hardfork: Hardfork.Chainstart })
     const blockchain = new Mockchain()
 
-    const genesis = Block.genesis({})
+    const genesis = Block.fromBlockData({})
     await blockchain.putBlock(genesis)
 
     const block1 = createBlock(genesis, 'block1', [], common)
@@ -503,7 +503,7 @@ tape('[Block]: block functions', function (t) {
     const common = new Common({ chain: Chain.Mainnet, hardfork: Hardfork.Chainstart })
     const blockchain = new Mockchain()
 
-    const genesis = Block.genesis({})
+    const genesis = Block.fromBlockData({})
     await blockchain.putBlock(genesis)
 
     const uncleBlock = createBlock(genesis, 'uncle', [], common)
@@ -658,41 +658,11 @@ tape('[Block]: block functions', function (t) {
   })
 
   t.test('should test genesis hashes (mainnet default)', function (st) {
-    const genesis = Block.genesis()
-    const genesisRlp = genesis.serialize()
-    st.ok(
-      genesisRlp.equals(Buffer.from(testDataGenesis.test.genesis_rlp_hex, 'hex')),
-      'rlp hex match'
-    )
-    st.ok(
-      genesis.hash().equals(Buffer.from(testDataGenesis.test.genesis_hash, 'hex')),
-      'genesis hash match'
-    )
-    st.end()
-  })
-
-  t.test('should test genesis hashes (ropsten)', function (st) {
     const common = new Common({ chain: Chain.Ropsten, hardfork: Hardfork.Chainstart })
-    const genesis = Block.genesis({}, { common })
-    st.ok(genesis.hash().equals(toBuffer(common.genesis().hash)), 'genesis hash match')
-    st.end()
-  })
-
-  t.test('should test genesis hashes (rinkeby)', function (st) {
-    const common = new Common({ chain: Chain.Rinkeby, hardfork: Hardfork.Chainstart })
-    const genesis = Block.genesis({}, { common })
-    st.ok(genesis.hash().equals(toBuffer(common.genesis().hash)), 'genesis hash match')
-    st.end()
-  })
-
-  t.test('should test genesis parameters (ropsten)', function (st) {
-    const common = new Common({ chain: Chain.Ropsten, hardfork: Hardfork.Chainstart })
-    const genesis = Block.genesis({}, { common })
-    const ropstenStateRoot = Buffer.from(
-      '217b0bbcfb72e2d57e28f33cb361b9983513177755dc3f33ce3e7022ed62b77b',
-      'hex'
-    )
-    st.ok(genesis.header.stateRoot.equals(ropstenStateRoot), 'genesis stateRoot match')
+    const rlp = Buffer.from(testDataGenesis.test.genesis_rlp_hex, 'hex')
+    const hash = Buffer.from(testDataGenesis.test.genesis_hash, 'hex')
+    const block = Block.fromRLPSerializedBlock(rlp, { common })
+    st.ok(block.hash().equals(hash), 'genesis hash match')
     st.end()
   })
 
@@ -746,7 +716,7 @@ tape('[Block]: block functions', function (t) {
     'should set canonical difficulty if I provide a calcDifficultyFromHeader header',
     function (st) {
       const common = new Common({ chain: Chain.Mainnet, hardfork: Hardfork.Chainstart })
-      const genesis = Block.genesis({}, { common })
+      const genesis = Block.fromBlockData({}, { common })
 
       const nextBlockHeaderData = {
         number: genesis.header.number + BigInt(1),

packages/block/test/clique.spec.ts

@@ -12,7 +12,7 @@ tape('[Header]: Clique PoA Functionality', function (t) {
       header.cliqueIsEpochTransition()
     }, 'cliqueIsEpochTransition() -> should throw on PoW networks')
 
-    header = BlockHeader.genesis({}, { common })
+    header = BlockHeader.fromHeaderData({}, { common })
     st.ok(
       header.cliqueIsEpochTransition(),
       'cliqueIsEpochTransition() -> should indicate an epoch transition for the genesis block'