Monorepo: Set "type": "module" in package.json files (default ESM internally) (#3494)

* Do a simple test and see what happens (Util) (npm i works, test:node works, lint works, docs do not work (maybe unrelated), examples work)

* Switch all other libraries over

* Move view specialized debug functionality out of trie src since debug module causes too much problem in this intense usage setup (not ESM ready)

* Trie import fixes

* VM example file extension renaming

* Fix VM examples

* Import fix

* Make the switch-over in tsconfig files

* Fix some new lint failures

* Bugfix (wrong import extension)

* Import file extension fixes

* Fix benchmarks

* Fix various import issues

* Remove duplicative node types and clean up references

---------

Co-authored-by: acolytec3 <[email protected]>

Author: holgerd77

config/tsconfig.json

@@ -3,8 +3,8 @@
     "sourceMap": true,
     "declaration": true,
     "declarationMap": true,
-    "module": "Node16",
-    "moduleResolution": "node",
+    "module": "NodeNext",
+    "moduleResolution": "NodeNext",
     "emitDecoratorMetadata": true,
     "experimentalDecorators": true,
     "esModuleInterop": false,

config/tsconfig.prod.cjs.json

@@ -1,3 +1,7 @@
 {
-  "extends": "./tsconfig.json"
+  "extends": "./tsconfig.json",
+  "compilerOptions": {
+    "module": "Node16",
+    "moduleResolution": "node"
+  }
 }

config/tsconfig.prod.esm.json

@@ -1,6 +1,3 @@
 {
-  "extends": "./tsconfig.json",
-  "compilerOptions": {
-    "module": "esnext"
-  }
+  "extends": "./tsconfig.json"
 }

packages/block/package.json

@@ -16,7 +16,7 @@
   },
   "license": "MPL-2.0",
   "author": "mjbecze ([email protected])",
-  "type": "commonjs",
+  "type": "module",
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.js",
   "exports": {

packages/blockchain/package.json

@@ -16,7 +16,7 @@
   },
   "license": "MPL-2.0",
   "author": "mjbecze <[email protected]>",
-  "type": "commonjs",
+  "type": "module",
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.js",
   "exports": {

packages/blockchain/src/consensus/clique.ts

@@ -18,9 +18,8 @@ import type { Blockchain } from '../index.js'
 import type { Consensus, ConsensusOptions } from '../types.js'
 import type { Block, BlockHeader } from '@ethereumjs/block'
 import type { CliqueConfig } from '@ethereumjs/common'
-const { debug: createDebugLogger } = debugDefault
 
-const debug = createDebugLogger('blockchain:clique')
+const debug = debugDefault('blockchain:clique')
 
 // Magic nonce number to vote on adding a new signer
 export const CLIQUE_NONCE_AUTH = hexToBytes('0xffffffffffffffff')

packages/blockchain/src/consensus/ethash.ts

@@ -44,7 +44,7 @@ export class EthashConsensus implements Consensus {
   public async genesisInit(): Promise<void> {}
   public async setup({ blockchain }: ConsensusOptions): Promise<void> {
     this.blockchain = blockchain
-    this._ethash = new Ethash(this.blockchain.db as any)
+    this._ethash = new Ethash(this.blockchain!.db as any)
   }
   public async newBlock(): Promise<void> {}
 }

packages/blockchain/src/types.ts

@@ -1,4 +1,4 @@
-import type { Blockchain } from '.'
+import type { Blockchain } from './index.js'
 import type { Block, BlockHeader } from '@ethereumjs/block'
 import type { Common, ConsensusAlgorithm } from '@ethereumjs/common'
 import type { AsyncEventEmitter, DB, DBObject, GenesisState } from '@ethereumjs/util'

packages/blockchain/tsconfig.json

@@ -2,7 +2,6 @@
   "extends": "../../config/tsconfig.json",
   "include": ["src/**/*.ts", "src/**/*.json", "test/**/*.ts"],
   "compilerOptions": {
-    "types": ["node"],
     "typeRoots": ["node_modules/@types"]
   }
 }

packages/client/package.json

@@ -20,9 +20,9 @@
   },
   "license": "MPL-2.0",
   "author": "Vinay Pulim ([email protected])",
+  "type": "module",
   "main": "dist/esm/bin/cli.js",
   "types": "dist/esm/src/index.d.ts",
-  "type": "module",
   "bin": {
     "ethereumjs": "dist/esm/bin/cli.js"
   },

packages/client/src/sync/fetcher/accountfetcher.ts

@@ -34,7 +34,6 @@ import type { FetcherOptions } from './fetcher.js'
 import type { StorageRequest } from './storagefetcher.js'
 import type { Job, SnapFetcherDoneFlags } from './types.js'
 import type { Debugger } from 'debug'
-const { debug: createDebugLogger } = debugDefault
 
 type AccountDataResponse = AccountData[] & { completed?: boolean }
 
@@ -99,7 +98,7 @@ export class AccountFetcher extends Fetcher<JobTask, AccountData[], AccountData>
     this.stateManager = options.stateManager ?? new DefaultStateManager()
     this.accountTrie = this.stateManager['_getAccountTrie']()
 
-    this.debug = createDebugLogger('client:AccountFetcher')
+    this.debug = debugDefault('client:AccountFetcher')
 
     this.storageFetcher = new StorageFetcher({
       config: this.config,

packages/client/src/sync/fetcher/bytecodefetcher.ts

@@ -6,7 +6,7 @@ import {
   concatBytes,
   equalsBytes,
 } from '@ethereumjs/util'
-import debugDefault from 'debug'
+import debug from 'debug'
 import { keccak256 } from 'ethereum-cryptography/keccak'
 
 import { Fetcher } from './fetcher.js'
@@ -17,7 +17,6 @@ import type { FetcherOptions } from './fetcher.js'
 import type { Job, SnapFetcherDoneFlags } from './types.js'
 import type { BatchDBOp, DB } from '@ethereumjs/util'
 import type { Debugger } from 'debug'
-const { debug: createDebugLogger } = debugDefault
 
 type ByteCodeDataResponse = Uint8Array[] & { completed?: boolean }
 
@@ -62,7 +61,7 @@ export class ByteCodeFetcher extends Fetcher<JobTask, Uint8Array[], Uint8Array>
 
     this.keccakFunction = this.config.chainCommon.customCrypto.keccak256 ?? keccak256
 
-    this.debug = createDebugLogger('client:ByteCodeFetcher')
+    this.debug = debug('client:ByteCodeFetcher')
     if (this.hashes.length > 0) {
       const fullJob = { task: { hashes: this.hashes } } as Job<JobTask, Uint8Array[], Uint8Array>
       this.debug(

packages/client/src/sync/fetcher/fetcher.ts

@@ -1,4 +1,4 @@
-import debugDefault from 'debug'
+import debug from 'debug'
 import { Readable, Writable } from 'stream'
 
 import { Heap } from '../../ext/qheap.js'
@@ -12,8 +12,6 @@ import type { JobTask as BlockFetcherJobTask } from './blockfetcherbase.js'
 import type { Job } from './types.js'
 import type { Debugger } from 'debug'
 
-const { debug: createDebugLogger } = debugDefault
-
 export interface FetcherOptions {
   /* Common chain config*/
   config: Config
@@ -80,7 +78,7 @@ export abstract class Fetcher<JobTask, JobResult, StorageItem> extends Readable
     super({ ...options, objectMode: true })
 
     this.config = options.config
-    this.debug = createDebugLogger('client:fetcher')
+    this.debug = debug('client:fetcher')
 
     this.pool = options.pool
     this.timeout = options.timeout ?? 8000

packages/client/src/sync/fetcher/storagefetcher.ts

@@ -24,7 +24,6 @@ import type { StorageData } from '../../net/protocol/snapprotocol.js'
 import type { FetcherOptions } from './fetcher.js'
 import type { Job, SnapFetcherDoneFlags } from './types.js'
 import type { Debugger } from 'debug'
-const { debug: createDebugLogger } = debugDefault
 
 const TOTAL_RANGE_END = BIGINT_2 ** BIGINT_256 - BIGINT_1
 
@@ -95,7 +94,7 @@ export class StorageFetcher extends Fetcher<JobTask, StorageData[][], StorageDat
     this.fetcherDoneFlags.storageFetcher.count = BigInt(this.storageRequests.length)
 
     this.accountToHighestKnownHash = new Map<String, Uint8Array>()
-    this.debug = createDebugLogger('client:StorageFetcher')
+    this.debug = debugDefault('client:StorageFetcher')
     if (this.storageRequests.length > 0) {
       const fullJob = {
         task: { storageRequests: this.storageRequests },

packages/client/src/sync/fetcher/trienodefetcher.ts

@@ -15,7 +15,7 @@ import {
   KECCAK256_RLP,
   unprefixedHexToBytes,
 } from '@ethereumjs/util'
-import debugPkg from 'debug'
+import debug from 'debug'
 import { keccak256 } from 'ethereum-cryptography/keccak.js'
 import { bytesToHex, equalsBytes, hexToBytes } from 'ethereum-cryptography/utils'
 import { OrderedMap } from 'js-sdsl'
@@ -28,7 +28,6 @@ import type { FetcherOptions } from './fetcher.js'
 import type { Job, SnapFetcherDoneFlags } from './types.js'
 import type { BatchDBOp, DB } from '@ethereumjs/util'
 import type { Debugger } from 'debug'
-const { debug: createDebugLogger } = debugPkg
 
 type TrieNodesResponse = Uint8Array[] & { completed?: boolean }
 
@@ -111,7 +110,7 @@ export class TrieNodeFetcher extends Fetcher<JobTask, Uint8Array[], Uint8Array>
     this.codeDB = this.stateManager['_getCodeDB']()
 
     this.nodeCount = 0
-    this.debug = createDebugLogger('client:TrieNodeFetcher')
+    this.debug = debug('client:TrieNodeFetcher')
 
     this.keccakFunction = this.config.chainCommon.customCrypto.keccak256 ?? keccak256
 

packages/client/tsconfig.json

@@ -3,6 +3,6 @@
   "include": ["bin", "src", "test", "package.json"],
   "compilerOptions": {
     "typeRoots": ["node_modules/@types", "src/@types"],
-    "moduleResolution": "Node16"
+    "allowSyntheticDefaultImports": true
   }
 }

packages/client/tsconfig.prod.esm.json

@@ -4,17 +4,18 @@
   "compilerOptions": {
     "outDir": "dist/esm",
     "typeRoots": ["node_modules/@types", "src/@types"],
-    "composite": true
+    "composite": true,
+    "allowSyntheticDefaultImports": true
   },
   "references": [
-    { "path": "../block/tsconfig.prod.cjs.json" },
-    { "path": "../blockchain/tsconfig.prod.cjs.json" },
-    { "path": "../common/tsconfig.prod.cjs.json" },
-    { "path": "../devp2p/tsconfig.prod.cjs.json" },
-    { "path": "../rlp/tsconfig.prod.cjs.json" },
-    { "path": "../trie/tsconfig.prod.cjs.json" },
-    { "path": "../tx/tsconfig.prod.cjs.json" },
-    { "path": "../util/tsconfig.prod.cjs.json" },
-    { "path": "../vm/tsconfig.prod.cjs.json" }
+    { "path": "../block/tsconfig.prod.esm.json" },
+    { "path": "../blockchain/tsconfig.prod.esm.json" },
+    { "path": "../common/tsconfig.prod.esm.json" },
+    { "path": "../devp2p/tsconfig.prod.esm.json" },
+    { "path": "../rlp/tsconfig.prod.esm.json" },
+    { "path": "../trie/tsconfig.prod.esm.json" },
+    { "path": "../tx/tsconfig.prod.esm.json" },
+    { "path": "../util/tsconfig.prod.esm.json" },
+    { "path": "../vm/tsconfig.prod.esm.json" }
   ]
 }

packages/common/package.json

@@ -26,7 +26,7 @@
       "email": "[email protected]"
     }
   ],
-  "type": "commonjs",
+  "type": "module",
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.js",
   "exports": {

packages/devp2p/package.json

@@ -29,8 +29,8 @@
     "Martin Becze <[email protected]>",
     "Holger Drewes <[email protected]>"
   ],
-  "main": "dist/cjs/index.js",
   "type": "module",
+  "main": "dist/cjs/index.js",
   "module": "dist/esm/index.js",
   "exports": {
     ".": {

packages/devp2p/src/dns/dns.ts

@@ -5,9 +5,8 @@ import { ENR } from './enr.js'
 
 import type { DNSOptions, PeerInfo } from '../types.js'
 import type { Common } from '@ethereumjs/common'
-const { debug: createDebugLogger } = debugDefault
 
-const debug = createDebugLogger('devp2p:dns:dns')
+const debug = debugDefault('devp2p:dns:dns')
 
 type SearchContext = {
   domain: string

packages/devp2p/src/dpt/ban-list.ts

@@ -6,10 +6,9 @@ import { formatLogId } from '../util.js'
 import { KBucket } from './kbucket.js'
 
 import type { PeerInfo } from '../types.js'
-const { debug: createDebugLogger } = debugDefault
 
-const debug = createDebugLogger('devp2p:dpt:ban-list')
-const verbose = createDebugLogger('verbose').enabled
+const debug = debugDefault('devp2p:dpt:ban-list')
+const verbose = debugDefault('verbose').enabled
 
 export class BanList {
   private _lru: LRUCache<string, boolean>

packages/devp2p/src/dpt/message.ts

@@ -8,9 +8,8 @@ import { assertEq, ipToBytes, ipToString, isV4Format, isV6Format, unstrictDecode
 
 import type { PeerInfo } from '../types.js'
 import type { Common } from '@ethereumjs/common'
-const { debug: createDebugLogger } = debugDefault
 
-const debug = createDebugLogger('devp2p:dpt:server')
+const debug = debugDefault('devp2p:dpt:server')
 
 function getTimestamp() {
   return (Date.now() / 1000) | 0

packages/devp2p/src/dpt/server.ts

@@ -13,10 +13,9 @@ import type { DPT } from './dpt.js'
 import type { Common } from '@ethereumjs/common'
 import type { Debugger } from 'debug'
 import type { Socket as DgramSocket, RemoteInfo } from 'dgram'
-const { debug: createDebugLogger } = debugDefault
 
 const DEBUG_BASE_NAME = 'dpt:server'
-const verbose = createDebugLogger('verbose').enabled
+const verbose = debugDefault('verbose').enabled
 
 const VERSION = 0x04
 

packages/devp2p/src/protocol/protocol.ts

@@ -7,7 +7,6 @@ import { devp2pDebug } from '../util.js'
 import type { Peer } from '../rlpx/peer.js'
 import type { SendMethod } from '../types.js'
 import type { Debugger } from 'debug'
-const { debug: createDebugLogger } = debugDefault
 
 type MessageCodes = { [key: number | string]: number | string }
 
@@ -50,7 +49,7 @@ export abstract class Protocol {
         : undefined
 
     this._debug = devp2pDebug.extend(protocol)
-    this._verbose = createDebugLogger('verbose').enabled
+    this._verbose = debugDefault('verbose').enabled
     this.initMsgDebuggers(protocol)
   }
 

packages/devp2p/src/rlpx/ecies.ts

@@ -12,10 +12,9 @@ import { assertEq, genPrivateKey, id2pk, pk2id, unstrictDecode, xor, zfill } fro
 import { MAC } from './mac.js'
 
 import type { Common } from '@ethereumjs/common'
-const { debug: createDebugLogger } = debugDefault
 type Decipher = crypto.Decipher
 
-const debug = createDebugLogger('devp2p:rlpx:peer')
+const debug = debugDefault('devp2p:rlpx:peer')
 
 function ecdhX(publicKey: Uint8Array, privateKey: Uint8Array) {
   // return (publicKey * privateKey).x

packages/devp2p/src/rlpx/peer.ts

@@ -23,10 +23,9 @@ import type { Capabilities, PeerOptions } from '../types.js'
 import type { Common } from '@ethereumjs/common'
 import type { Debugger } from 'debug'
 import type { Socket } from 'net'
-const { debug: createDebugLogger } = debugDefault
 
 const DEBUG_BASE_NAME = 'rlpx:peer'
-const verbose = createDebugLogger('verbose').enabled
+const verbose = debugDefault('verbose').enabled
 
 const BASE_PROTOCOL_VERSION = 5
 const BASE_PROTOCOL_LENGTH = 16

packages/devp2p/src/rlpx/rlpx.ts

@@ -22,12 +22,11 @@ import type { DPT } from '../dpt/index.js'
 import type { Capabilities, PeerInfo, RLPxOptions } from '../types.js'
 import type { Common } from '@ethereumjs/common'
 import type { Debugger } from 'debug'
-const { debug: createDebugLogger } = debugDefault
 
 // note: relative path only valid in .js file in dist
 
 const DEBUG_BASE_NAME = 'rlpx'
-const verbose = createDebugLogger('verbose').enabled
+const verbose = debugDefault('verbose').enabled
 
 export class RLPx {
   public events: EventEmitter

packages/devp2p/src/types.ts

@@ -1,5 +1,5 @@
-import type { DPT } from './dpt'
-import type { Protocol } from './protocol/protocol'
+import type { DPT } from './dpt/index.js'
+import type { Protocol } from './protocol/protocol.js'
 import type { Common } from '@ethereumjs/common'
 import type { Socket } from 'net'
 

packages/devp2p/src/util.ts

@@ -1,14 +1,13 @@
 import { RLP } from '@ethereumjs/rlp'
 import { bytesToHex, bytesToUnprefixedHex, concatBytes, equalsBytes } from '@ethereumjs/util'
-import debugDefault from 'debug'
+import debug from 'debug'
 import { publicKeyConvert } from 'ethereum-cryptography/secp256k1-compat.js'
 import { secp256k1 } from 'ethereum-cryptography/secp256k1.js'
 
 import type { ETH } from './protocol/eth.js'
 import type { LES } from './protocol/les.js'
-const { debug: createDebugLogger } = debugDefault
 
-export const devp2pDebug = createDebugLogger('devp2p')
+export const devp2pDebug = debug('devp2p')
 
 export function genPrivateKey(): Uint8Array {
   const privateKey = secp256k1.utils.randomPrivateKey()

packages/evm/package.json

@@ -21,6 +21,7 @@
   "contributors": [
     "Alex Beregszaszi <[email protected]>"
   ],
+  "type": "module",
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.js",
   "exports": {