develop: small fixes (#1924)

* simplify setting blockchan genesis parameters for future extensibility, make timestamp optional instead of `| null`

* move EOF one folder up, export default rather than wildcard import

* remove `assert` usage from vm/precompiles, devp2p

* eof: reinstate individual imports

* make genesisBlock a property and add a separate createGenesisBlock method

* fix mock, remove commented out code (double checked, geth does not return the eth protocol versions in admin_nodeInfo, so this is safely removable)

* remove old chain/hardfork check

* simplify errors, use increment operator, use for..of rather than forEach

Author: ryanio

packages/block/test/testdata/testnetMerge.json

@@ -14,7 +14,6 @@
   "comment": "Private test network",
   "url": "[TESTNET_URL]",
   "genesis": {
-    "timestamp": null,
     "gasLimit": 1000000,
     "difficulty": 1,
     "nonce": "0xbb00000000000000",

packages/blockchain/src/consensus/clique.ts

@@ -136,12 +136,8 @@ export class CliqueConsensus implements Consensus {
     const { header } = block
     const commonAncestorNumber = commonAncestor?.number
     if (commonAncestorNumber !== undefined) {
-      await this._cliqueDeleteSnapshots(commonAncestorNumber! + BigInt(1))
-      for (
-        let number = commonAncestorNumber! + BigInt(1);
-        number <= header.number;
-        number += BigInt(1)
-      ) {
+      await this._cliqueDeleteSnapshots(commonAncestorNumber + BigInt(1))
+      for (let number = commonAncestorNumber + BigInt(1); number <= header.number; number++) {
         const canonicalHeader = await this.blockchain.getCanonicalHeader(number)
         await this._cliqueBuildSnapshots(canonicalHeader)
       }

packages/blockchain/src/db/manager.ts

@@ -47,9 +47,9 @@ export class DBManager {
    */
   async getHeads(): Promise<{ [key: string]: Buffer }> {
     const heads = await this.get(DBTarget.Heads)
-    Object.keys(heads).forEach((key) => {
+    for (const key of Object.keys(heads)) {
       heads[key] = Buffer.from(heads[key])
-    })
+    }
     return heads
   }
 

packages/blockchain/src/index.ts

@@ -1,7 +1,6 @@
 import Semaphore from 'semaphore-async-await'
 import { Block, BlockData, BlockHeader } from '@ethereumjs/block'
 import Common, { Chain, ConsensusAlgorithm, ConsensusType, Hardfork } from '@ethereumjs/common'
-import { toBuffer } from 'ethereumjs-util'
 import { DBManager } from './db/manager'
 import { DBOp, DBSetBlockOrHeader, DBSetTD, DBSetHashToNumber, DBSaveLookups } from './db/helpers'
 import { DBTarget } from './db/operation'
@@ -215,12 +214,6 @@ export default class Blockchain implements BlockchainInterface {
    * {@link BlockchainOptions}.
    */
   protected constructor(opts: BlockchainOptions = {}) {
-    // Throw on chain or hardfork options removed in latest major release to
-    // prevent implicit chain setup on a wrong chain
-    if ('chain' in opts || 'hardfork' in opts) {
-      throw new Error('Chain/hardfork options are not allowed any more on initialization')
-    }
-
     if (opts.common) {
       this._common = opts.common
     } else {
@@ -328,7 +321,7 @@ export default class Blockchain implements BlockchainInterface {
       } else {
         stateRoot = await genesisStateRoot(this.genesisState())
       }
-      genesisBlock = this.genesisBlock(stateRoot)
+      genesisBlock = this.createGenesisBlock(stateRoot)
     }
 
     // If the DB has a genesis block, then verify that the genesis block in the
@@ -726,11 +719,7 @@ export default class Blockchain implements BlockchainInterface {
   async getIteratorHead(name = 'vm'): Promise<Block> {
     return await this.runWithLock<Block>(async () => {
       // if the head is not found return the genesis hash
-      const hash = this._heads[name] ?? this._genesisBlock?.hash()
-      if (!hash) {
-        throw new Error('No head found.')
-      }
-
+      const hash = this._heads[name] ?? this.genesisBlock.hash()
       const block = await this._getBlock(hash)
       return block
     })
@@ -750,11 +739,8 @@ export default class Blockchain implements BlockchainInterface {
   async getHead(name = 'vm'): Promise<Block> {
     return await this.runWithLock<Block>(async () => {
       // if the head is not found return the headHeader
-      const hash = this._heads[name] || this._headBlockHash
-      if (!hash) {
-        throw new Error('No head found.')
-      }
-
+      const hash = this._heads[name] ?? this._headBlockHash
+      if (!hash) throw new Error('No head found.')
       const block = await this._getBlock(hash)
       return block
     })
@@ -765,9 +751,7 @@ export default class Blockchain implements BlockchainInterface {
    */
   async getCanonicalHeadHeader(): Promise<BlockHeader> {
     return await this.runWithLock<BlockHeader>(async () => {
-      if (!this._headHeaderHash) {
-        throw new Error('No head header set')
-      }
+      if (!this._headHeaderHash) throw new Error('No head header set')
       const block = await this._getBlock(this._headHeaderHash)
       return block.header
     })
@@ -778,10 +762,7 @@ export default class Blockchain implements BlockchainInterface {
    */
   async getCanonicalHeadBlock(): Promise<Block> {
     return this.runWithLock<Block>(async () => {
-      if (!this._headBlockHash) {
-        throw new Error('No head block set')
-      }
-
+      if (!this._headBlockHash) throw new Error('No head block set')
       const block = this._getBlock(this._headBlockHash)
       return block
     })
@@ -1183,12 +1164,7 @@ export default class Blockchain implements BlockchainInterface {
    */
   private async _iterator(name: string, onBlock: OnBlock, maxBlocks?: number): Promise<number> {
     return await this.runWithLock<number>(async (): Promise<number> => {
-      const headHash = this._heads[name] ?? this._genesisBlock?.hash()
-      let lastBlock: Block | undefined
-
-      if (!headHash) {
-        return 0
-      }
+      const headHash = this._heads[name] ?? this.genesisBlock.hash()
 
       if (maxBlocks && maxBlocks < 0) {
         throw 'If maxBlocks is provided, it has to be a non-negative number'
@@ -1197,6 +1173,7 @@ export default class Blockchain implements BlockchainInterface {
       const headBlockNumber = await this.dbManager.hashToNumber(headHash)
       let nextBlockNumber = headBlockNumber + BigInt(1)
       let blocksRanCounter = 0
+      let lastBlock: Block | undefined
 
       while (maxBlocks !== blocksRanCounter) {
         try {
@@ -1205,7 +1182,7 @@ export default class Blockchain implements BlockchainInterface {
           const reorg = lastBlock ? lastBlock.hash().equals(nextBlock.header.parentHash) : false
           lastBlock = nextBlock
           await onBlock(nextBlock, reorg)
-          nextBlockNumber += BigInt(1)
+          nextBlockNumber++
           blocksRanCounter++
         } catch (error: any) {
           if (error.type === 'NotFoundError') {
@@ -1241,10 +1218,7 @@ export default class Blockchain implements BlockchainInterface {
    * @param newHeader - the new block header
    */
   private async findCommonAncestor(newHeader: BlockHeader) {
-    if (!this._headHeaderHash) {
-      throw new Error('No head header set')
-    }
-
+    if (!this._headHeaderHash) throw new Error('No head header set')
     const ancestorHeaders = new Set<BlockHeader>()
 
     let { header } = await this._getBlock(this._headHeaderHash)
@@ -1303,20 +1277,20 @@ export default class Blockchain implements BlockchainInterface {
       // instance, make the VM run "older" (i.e. lower number blocks than last
       // executed block) blocks to verify the chain up to the current, actual,
       // head.
-      Object.keys(this._heads).forEach((name) => {
+      for (const name of Object.keys(this._heads)) {
         if (this._heads[name].equals(<Buffer>hash)) {
           // explicitly cast as Buffer: it is not possible that `hash` is false
           // here, but TypeScript does not understand this.
           this._heads[name] = headHash
         }
-      })
+      }
 
       // reset stale headBlock to current canonical
       if (this._headBlockHash?.equals(hash)) {
         this._headBlockHash = headHash
       }
 
-      blockNumber += BigInt(1)
+      blockNumber++
 
       hash = await this.safeNumberToHash(blockNumber)
     }
@@ -1368,11 +1342,11 @@ export default class Blockchain implements BlockchainInterface {
 
       // mark each key `_heads` which is currently set to the hash in the DB as
       // stale to overwrite this later.
-      Object.keys(this._heads).forEach((name) => {
+      for (const name of Object.keys(this._heads)) {
         if (staleHash && this._heads[name].equals(staleHash)) {
           staleHeads.push(name)
         }
-      })
+      }
       // flag stale headBlock for reset
       if (staleHash && this._headBlockHash?.equals(staleHash)) {
         staleHeadBlock = true
@@ -1390,9 +1364,9 @@ export default class Blockchain implements BlockchainInterface {
     }
     // the stale hash is equal to the blockHash set stale heads to last
     // previously valid canonical block
-    staleHeads.forEach((name: string) => {
+    for (const name of staleHeads) {
       this._heads[name] = currentCanonicalHash
-    })
+    }
     // set stale headBlock to last previously valid canonical block
     if (staleHeadBlock) {
       this._headBlockHash = currentCanonicalHash
@@ -1463,37 +1437,27 @@ export default class Blockchain implements BlockchainInterface {
   }
 
   /**
-   * Returns the genesis {@link Block} for the blockchain.
-   * @param stateRoot When initializing the block, pass the genesis stateRoot.
-   *                  After the blockchain is initialized, this parameter is not used
-   *                  as the cached genesis block is returned.
+   * The genesis {@link Block} for the blockchain.
    */
-  genesisBlock(stateRoot?: Buffer): Block {
-    if (this._genesisBlock) {
-      return this._genesisBlock
-    }
-
-    if (!stateRoot) throw new Error('stateRoot required for genesis block creation')
+  get genesisBlock(): Block {
+    if (!this._genesisBlock) throw new Error('genesis block not set (init may not be finished)')
+    return this._genesisBlock
+  }
 
+  /**
+   * Creates a genesis {@link Block} for the blockchain with params from {@link Common.genesis}
+   * @param stateRoot The genesis stateRoot
+   */
+  createGenesisBlock(stateRoot: Buffer): Block {
     const common = this._common.copy()
     common.setHardforkByBlockNumber(0)
 
-    const { gasLimit, timestamp, difficulty, extraData, nonce, baseFeePerGas } = common.genesis()
-
     const header: BlockData['header'] = {
+      ...common.genesis(),
       number: 0,
-      gasLimit: BigInt(gasLimit),
-      timestamp: BigInt(timestamp ?? 0),
-      difficulty: BigInt(difficulty),
-      extraData: toBuffer(extraData),
-      nonce: toBuffer(nonce),
       stateRoot,
     }
 
-    if (baseFeePerGas !== undefined && common.gteHardfork(Hardfork.London)) {
-      header.baseFeePerGas = BigInt(baseFeePerGas)
-    }
-
     return Block.fromBlockData({ header }, { common })
   }
 

packages/blockchain/test/clique.spec.ts

@@ -17,7 +17,7 @@ tape('Clique: Initialization', (t) => {
     const blockchain = await Blockchain.create({ common })
 
     const head = await blockchain.getIteratorHead()
-    st.ok(head.hash().equals(blockchain.genesisBlock().hash()), 'correct genesis hash')
+    st.ok(head.hash().equals(blockchain.genesisBlock.hash()), 'correct genesis hash')
 
     st.deepEquals(
       (blockchain.consensus as CliqueConsensus).cliqueActiveSigners(),

packages/blockchain/test/index.spec.ts

@@ -25,7 +25,7 @@ tape('blockchain test', (t) => {
     const iteratorHead = await blockchain.getIteratorHead()
 
     st.ok(
-      iteratorHead.hash().equals(blockchain.genesisBlock().hash()),
+      iteratorHead.hash().equals(blockchain.genesisBlock.hash()),
       'correct genesis hash (getIteratorHead())'
     )
 
@@ -843,7 +843,7 @@ tape('initialization tests', (t) => {
       hardfork: Hardfork.Chainstart,
     })
     const blockchain = await Blockchain.create({ common })
-    const genesisHash = blockchain.genesisBlock().hash()
+    const genesisHash = blockchain.genesisBlock.hash()
 
     st.ok(
       (await blockchain.getIteratorHead()).hash().equals(genesisHash),
@@ -946,8 +946,8 @@ tape('initialization tests', (t) => {
       '217b0bbcfb72e2d57e28f33cb361b9983513177755dc3f33ce3e7022ed62b77b',
       'hex'
     )
-    st.ok(blockchain.genesisBlock().hash().equals(ropstenGenesisBlockHash))
-    st.ok(blockchain.genesisBlock().header.stateRoot.equals(ropstenGenesisStateRoot))
+    st.ok(blockchain.genesisBlock.hash().equals(ropstenGenesisBlockHash))
+    st.ok(blockchain.genesisBlock.header.stateRoot.equals(ropstenGenesisStateRoot))
     st.end()
   })
 })

packages/blockchain/test/pos.spec.ts

@@ -7,7 +7,7 @@ import testnet from './testdata/testnet.json'
 const buildChain = async (blockchain: Blockchain, common: Common, height: number) => {
   const blocks: Block[] = []
   const londonBlockNumber = Number(common.hardforkBlock('london')!)
-  const genesis = blockchain.genesisBlock()
+  const genesis = blockchain.genesisBlock
   blocks.push(genesis)
 
   for (let number = 1; number <= height; number++) {

packages/blockchain/test/testdata/testnet.json

@@ -10,7 +10,6 @@
   "comment": "Private test network",
   "url": "[TESTNET_URL]",
   "genesis": {
-    "timestamp": null,
     "gasLimit": 5000,
     "difficulty": 1,
     "nonce": "0xbb00000000000000",

packages/client/bin/cli.ts

@@ -373,7 +373,7 @@ async function startClient(config: Config, customGenesisState?: GenesisState) {
       validateBlocks: true,
       validateConsensus,
     })
-    setCommonForkHashes(config.chainCommon, blockchain.genesisBlock().hash())
+    setCommonForkHashes(config.chainCommon, blockchain.genesisBlock.hash())
   }
 
   const client = new EthereumClient({

packages/client/lib/blockchain/chain.ts

@@ -140,7 +140,7 @@ export class Chain {
    * Genesis block for the chain
    */
   get genesis() {
-    return this.blockchain.genesisBlock()
+    return this.blockchain.genesisBlock
   }
 
   /**