Blockchain/Ethash/Trie: remove level dependency from blockchain

packages/blockchain/package.json

@@ -45,12 +45,10 @@
     "@ethereumjs/trie": "^5.0.4",
     "@ethereumjs/tx": "^4.1.1",
     "@ethereumjs/util": "^8.0.5",
-    "abstract-level": "^1.0.3",
     "debug": "^4.3.3",
     "ethereum-cryptography": "^1.1.2",
     "level": "^8.0.0",
-    "lru-cache": "^7.18.3",
-    "memory-level": "^1.0.0"
+    "lru-cache": "^7.18.3"
   },
   "devDependencies": {
     "@types/async": "^2.4.1",

packages/blockchain/src/blockchain.ts

@@ -1,8 +1,13 @@
 import { Block, BlockHeader } from '@ethereumjs/block'
 import { Chain, Common, ConsensusAlgorithm, ConsensusType, Hardfork } from '@ethereumjs/common'
-import { KECCAK256_RLP, Lock, concatBytesNoTypeCheck } from '@ethereumjs/util'
+import {
+  KECCAK256_RLP,
+  Lock,
+  MapDB,
+  bytesToPrefixedHexString,
+  concatBytesNoTypeCheck,
+} from '@ethereumjs/util'
 import { bytesToHex, equalsBytes, hexToBytes } from 'ethereum-cryptography/utils'
-import { MemoryLevel } from 'memory-level'
 
 import { CasperConsensus, CliqueConsensus, EthashConsensus } from './consensus'
 import { DBOp, DBSaveLookups, DBSetBlockOrHeader, DBSetHashToNumber, DBSetTD } from './db/helpers'
@@ -16,15 +21,14 @@ import type { GenesisState } from './genesisStates'
 import type { BlockchainInterface, BlockchainOptions, OnBlock } from './types'
 import type { BlockData } from '@ethereumjs/block'
 import type { CliqueConfig } from '@ethereumjs/common'
-import type { BigIntLike } from '@ethereumjs/util'
-import type { AbstractLevel } from 'abstract-level'
+import type { BigIntLike, DB, DBObject } from '@ethereumjs/util'
 
 /**
  * This class stores and interacts with blocks.
  */
 export class Blockchain implements BlockchainInterface {
   consensus: Consensus
-  db: AbstractLevel<string | Uint8Array | Uint8Array, string | Uint8Array, string | Uint8Array>
+  db: DB<Uint8Array | string, Uint8Array | string | DBObject>
   dbManager: DBManager
 
   private _genesisBlock?: Block /** The genesis block of this blockchain */
@@ -115,7 +119,8 @@ export class Blockchain implements BlockchainInterface {
     this._validateBlocks = opts.validateBlocks ?? true
     this._customGenesisState = opts.genesisState
 
-    this.db = opts.db ? opts.db : new MemoryLevel()
+    this.db = opts.db !== undefined ? opts.db : new MapDB()
+
     this.dbManager = new DBManager(this.db, this._common)
 
     if (opts.consensus) {
@@ -191,17 +196,13 @@ export class Blockchain implements BlockchainInterface {
     await this.consensus.setup({ blockchain: this })
 
     if (this._isInitialized) return
-    let dbGenesisBlock
-    try {
-      const genesisHash = await this.dbManager.numberToHash(BigInt(0))
-      dbGenesisBlock = await this.dbManager.getBlock(genesisHash)
-    } catch (error: any) {
-      if (error.code !== 'LEVEL_NOT_FOUND') {
-        throw error
-      }
-    }
 
-    if (!genesisBlock) {
+    let genesisHash = await this.dbManager.numberToHash(BigInt(0))
+
+    const dbGenesisBlock =
+      genesisHash !== undefined ? await this.dbManager.getBlock(genesisHash) : undefined
+
+    if (genesisBlock === undefined) {
       let stateRoot
       if (this._common.chainId() === BigInt(1) && this._customGenesisState === undefined) {
         // For mainnet use the known genesis stateRoot to quicken setup
@@ -214,13 +215,13 @@ export class Blockchain implements BlockchainInterface {
 
     // If the DB has a genesis block, then verify that the genesis block in the
     // DB is indeed the Genesis block generated or assigned.
-    if (dbGenesisBlock && !equalsBytes(genesisBlock.hash(), dbGenesisBlock.hash())) {
+    if (dbGenesisBlock !== undefined && !equalsBytes(genesisBlock.hash(), dbGenesisBlock.hash())) {
       throw new Error(
         'The genesis block in the DB has a different hash than the provided genesis block.'
       )
     }
 
-    const genesisHash = genesisBlock.hash()
+    genesisHash = genesisBlock.hash()
 
     if (!dbGenesisBlock) {
       // If there is no genesis block put the genesis block in the DB.
@@ -239,37 +240,16 @@ export class Blockchain implements BlockchainInterface {
     this._genesisBlock = genesisBlock
 
     // load verified iterator heads
-    try {
-      const heads = await this.dbManager.getHeads()
-      this._heads = heads
-    } catch (error: any) {
-      if (error.code !== 'LEVEL_NOT_FOUND') {
-        throw error
-      }
-      this._heads = {}
-    }
+    const heads = await this.dbManager.getHeads()
+    this._heads = heads !== undefined ? heads : {}
 
     // load headerchain head
-    try {
-      const hash = await this.dbManager.getHeadHeader()
-      this._headHeaderHash = hash
-    } catch (error: any) {
-      if (error.code !== 'LEVEL_NOT_FOUND') {
-        throw error
-      }
-      this._headHeaderHash = genesisHash
-    }
+    let hash = await this.dbManager.getHeadHeader()
+    this._headHeaderHash = hash !== undefined ? hash : genesisHash
 
     // load blockchain head
-    try {
-      const hash = await this.dbManager.getHeadBlock()
-      this._headBlockHash = hash
-    } catch (error: any) {
-      if (error.code !== 'LEVEL_NOT_FOUND') {
-        throw error
-      }
-      this._headBlockHash = genesisHash
-    }
+    hash = await this.dbManager.getHeadBlock()
+    this._headBlockHash = hash !== undefined ? hash : genesisHash
 
     if (this._hardforkByHeadBlockNumber) {
       const latestHeader = await this._getHeader(this._headHeaderHash)
@@ -423,6 +403,9 @@ export class Blockchain implements BlockchainInterface {
   async resetCanonicalHead(canonicalHead: bigint) {
     await this.runWithLock<void>(async () => {
       const hash = await this.dbManager.numberToHash(canonicalHead)
+      if (hash === undefined) {
+        throw new Error(`no block for ${canonicalHead} found in DB`)
+      }
       const header = await this._getHeader(hash, canonicalHead)
       const td = await this.getParentTD(header)
 
@@ -738,18 +721,16 @@ export class Blockchain implements BlockchainInterface {
     // in the `VM` if we encounter a `BLOCKHASH` opcode: then a bigint is used we
     // need to then read the block from the canonical chain Q: is this safe? We
     // know it is OK if we call it from the iterator... (runBlock)
-    try {
-      return await this.dbManager.getBlock(blockId)
-    } catch (error: any) {
-      if (error.code === 'LEVEL_NOT_FOUND') {
-        if (typeof blockId === 'object') {
-          error.message = `Block with hash ${bytesToHex(blockId)} not found in DB (NotFound)`
-        } else {
-          error.message = `Block number ${blockId} not found in DB (NotFound)`
-        }
+    const block = await this.dbManager.getBlock(blockId)
+
+    if (block === undefined) {
+      if (typeof blockId === 'object') {
+        throw new Error(`Block with hash ${bytesToHex(blockId)} not found in DB`)
+      } else {
+        throw new Error(`Block number ${blockId} not found in DB`)
       }
-      throw error
     }
+    return block
   }
 
   /**
@@ -758,6 +739,9 @@ export class Blockchain implements BlockchainInterface {
   public async getTotalDifficulty(hash: Uint8Array, number?: bigint): Promise<bigint> {
     if (number === undefined) {
       number = await this.dbManager.hashToNumber(hash)
+      if (number === undefined) {
+        throw new Error(`Block with hash ${bytesToPrefixedHexString(hash)} not found in DB`)
+      }
     }
     return this.dbManager.getTotalDifficulty(hash, number)
   }
@@ -794,12 +778,12 @@ export class Blockchain implements BlockchainInterface {
         let block
         try {
           block = await this.getBlock(blockId)
-        } catch (error: any) {
-          if (error.code !== 'LEVEL_NOT_FOUND') {
-            throw error
-          }
-          return
+        } catch (err: any) {
+          if (err.message.includes('not found in DB') === true) {
+            return
+          } else throw err
         }
+
         i++
         const nextBlockNumber = block.header.number + BigInt(reverse ? -1 : 1)
         if (i !== 0 && skip && i % (skip + 1) !== 0) {
@@ -835,11 +819,12 @@ export class Blockchain implements BlockchainInterface {
         let number
         try {
           number = await this.dbManager.hashToNumber(hashes[mid])
-        } catch (error: any) {
-          if (error.code !== 'LEVEL_NOT_FOUND') {
-            throw error
-          }
+        } catch (err: any) {
+          if (err.message.includes('not found in DB') === true) {
+            number = undefined
+          } else throw err
         }
+
         if (number !== undefined) {
           min = mid + 1
         } else {
@@ -945,9 +930,9 @@ export class Blockchain implements BlockchainInterface {
     try {
       const childHeader = await this.getCanonicalHeader(blockNumber + BigInt(1))
       await this._delChild(childHeader.hash(), childHeader.number, headHash, ops)
-    } catch (error: any) {
-      if (error.code !== 'LEVEL_NOT_FOUND') {
-        throw error
+    } catch (err: any) {
+      if (err.message.includes('not found in canonical chain') !== true) {
+        throw err
       }
     }
   }
@@ -977,7 +962,8 @@ export class Blockchain implements BlockchainInterface {
       }
 
       let headBlockNumber = await this.dbManager.hashToNumber(headHash)
-      let nextBlockNumber = headBlockNumber + BigInt(1)
+      // `headBlockNumber` should always exist since it defaults to the genesis block
+      let nextBlockNumber = headBlockNumber! + BigInt(1)
       let blocksRanCounter = 0
       let lastBlock: Block | undefined
 
@@ -992,7 +978,7 @@ export class Blockchain implements BlockchainInterface {
               // If reorg has happened, the _heads must have been updated so lets reload the counters
               headHash = this._heads[name] ?? this.genesisBlock.hash()
               headBlockNumber = await this.dbManager.hashToNumber(headHash)
-              nextBlockNumber = headBlockNumber + BigInt(1)
+              nextBlockNumber = headBlockNumber! + BigInt(1)
               nextBlock = await this.getBlock(nextBlockNumber)
             }
 
@@ -1025,7 +1011,7 @@ export class Blockchain implements BlockchainInterface {
             // Successful execution of onBlock, move the head pointer
             blocksRanCounter++
           } catch (error: any) {
-            if (error.code === 'LEVEL_NOT_FOUND') {
+            if ((error.message as string).includes('not found in DB')) {
               break
             } else {
               throw error
@@ -1199,13 +1185,9 @@ export class Blockchain implements BlockchainInterface {
         staleHeadBlock = true
       }
 
-      try {
-        header = await this._getHeader(header.parentHash, --currentNumber)
-      } catch (error: any) {
+      header = await this._getHeader(header.parentHash, --currentNumber)
+      if (header === undefined) {
         staleHeads = []
-        if (error.code !== 'LEVEL_NOT_FOUND') {
-          throw error
-        }
         break
       }
     }
@@ -1259,6 +1241,8 @@ export class Blockchain implements BlockchainInterface {
   private async _getHeader(hash: Uint8Array, number?: bigint) {
     if (number === undefined) {
       number = await this.dbManager.hashToNumber(hash)
+      if (number === undefined)
+        throw new Error(`no header for ${bytesToPrefixedHexString(hash)} found in DB`)
     }
     return this.dbManager.getHeader(hash, number)
   }
@@ -1302,25 +1286,21 @@ export class Blockchain implements BlockchainInterface {
    */
   async getCanonicalHeader(number: bigint) {
     const hash = await this.dbManager.numberToHash(number)
+    if (hash === undefined) {
+      throw new Error(`header with number ${number} not found in canonical chain`)
+    }
     return this._getHeader(hash, number)
   }
 
   /**
    * This method either returns a Uint8Array if there exists one in the DB or if it
-   * does not exist (DB throws a `NotFoundError`) then return false If DB throws
+   * does not exist then return false If DB throws
    * any other error, this function throws.
    * @param number
    */
   async safeNumberToHash(number: bigint): Promise<Uint8Array | false> {
-    try {
-      const hash = await this.dbManager.numberToHash(number)
-      return hash
-    } catch (error: any) {
-      if (error.code !== 'LEVEL_NOT_FOUND') {
-        throw error
-      }
-      return false
-    }
+    const hash = await this.dbManager.numberToHash(number)
+    return hash !== undefined ? hash : false
   }
 
   /**