Generalize logger for MerklePatriciaTrie

packages/mpt/src/mpt.ts

@@ -17,7 +17,6 @@
   concatBytes,
   equalsBytes,
 } from '@ethereumjs/util'
-import debug from 'debug'
 import { keccak256 } from 'ethereum-cryptography/keccak.js'
 
 import { CheckpointDB } from './db/checkpointDB.ts'
@@ -29,14 +28,15 @@
   decodeRawMPTNode,
   isRawMPTNode,
 } from './node/index.ts'
-import { ROOT_DB_KEY } from './types.ts'
+import { ConsoleLogger, ROOT_DB_KEY } from './types.ts'
 import { _walkTrie } from './util/asyncWalk.ts'
 import { bytesToNibbles, matchingNibbleLength, nibblesTypeToPackedBytes } from './util/nibbles.ts'
 import { WalkController } from './util/walkController.ts'
 
 import type {
   BranchMPTNodeBranchValue,
   FoundNodeFunction,
+  Logger,
   MPTNode,
   MPTOpts,
   MPTOptsWithDefaults,
@@ -47,7 +47,6 @@
 } from './types.ts'
 import type { OnFound } from './util/asyncWalk.ts'
 import type { BatchDBOp, DB } from '@ethereumjs/util'
-import type { Debugger } from 'debug'
 
 /**
  * The basic trie interface, use with `import { MerklePatriciaTrie } from '@ethereumjs/mpt'`.
@@ -74,8 +73,8 @@
 
   /** Debug logging */
   protected DEBUG: boolean
-  protected _debug: Debugger = debug('mpt:#')
   protected debug: (...args: any) => void
+  logger: Logger
 
   /**
    * Creates a new trie.
@@ -103,15 +102,20 @@
       valueEncoding = ValueEncoding.Bytes
     }
 
+    if (opts?.logger) {
+      // console.log('dbg100')
+      this.logger = opts.logger
+    } else {
+      // console.log('dbg101')
+      this.logger = new ConsoleLogger()
+    }
+
     this.DEBUG =
       typeof window === 'undefined' ? (process?.env?.DEBUG?.includes('ethjs') ?? false) : false
     this.debug = this.DEBUG
       ? (message: string, namespaces: string[] = []) => {
-          let log = this._debug
-          for (const name of namespaces) {
-            log = log.extend(name)
-          }
-          log(message)
+          //@ts-ignore
+          this.logger.debug(message + namespaces) // not sure what's wrong with typing here
         }
       : (..._: any) => {}
 

packages/mpt/src/types.ts

@@ -44,7 +44,42 @@
 
 export type HashKeysFunction = (msg: Uint8Array) => Uint8Array
 
+export interface Logger {
+  info(message: string, ...meta: any[]): void
+  warn(message: string, ...meta: any[]): void
+  error(message: string, ...meta: any[]): void
+  debug?(message: string, ...meta: any[]): void // Optional for production
+  trace?(message: string, ...meta: any[]): void // Optional deep debugging
+}
+
+export class ConsoleLogger implements Logger {
+  info(message: string, ...meta: any[]) {
+    console.info(`[INFO] ${message}`, ...meta)
+  }
+
+  warn(message: string, ...meta: any[]) {
+    console.warn(`[WARN] ${message}`, ...meta)
+  }
+
+  error(message: string, ...meta: any[]) {
+    console.error(`[ERROR] ${message}`, ...meta)
+  }
+
+  debug?(message: string, ...meta: any[]) {
+    if (process.env.DEBUG !== undefined) console.debug(`[DEBUG] ${message}`, ...meta)
+  }
+
+  trace?(message: string, ...meta: any[]) {
+    if (process.env.TRACE !== undefined) console.trace(`[TRACE] ${message}`, ...meta)
+  }
+}
+
 export interface MPTOpts {
+  /**
+   *
+   */
+  logger?: Logger
+
   /**
    * A database instance.
    */