Monorepo: Switch to hybrid ESM/CJS Build

config/cli/ts-build.sh

@@ -33,17 +33,58 @@ dim() {
 
 build_node() {
     blue "[Node build] "
-    echo "Using tsconfig.prod.json"
+    echo "Using tsconfig.prod.cjs.json"
 
-    echo "> tsc --build ./tsconfig.prod.json"
+    echo "> tsc --build ./tsconfig.prod.cjs.json"
     printf "${BLUE}[Node build] Working... "
 
-    tsc --build ./tsconfig.prod.json
+    tsc --build ./tsconfig.prod.cjs.json
     green "DONE"
 
     echo "\n";
 }
 
+build_esm() {
+    if [ -f ./tsconfig.prod.esm.json ];
+    then
+        blue "[ESM build] "
+        echo "Using tsconfig.prod.esm.json"
+
+        echo "> tsc --build ./tsconfig.prod.esm.json"
+        printf "${BLUE}[ESM build] Working... "
+
+        tsc --build ./tsconfig.prod.esm.json
+        green "DONE"
+    else
+        echo "Skipping ESM build (no config available)."
+    fi
+    echo "\n";
+}
+
+post_build_fixes() {
+    blue "[Post Build Fixes]"
+    if [ -f ./dist/esm/index.js ];
+    then
+        echo "Adding ./dist/cjs/package.json"
+        rm -f ./dist/cjs/package.json
+        cat <<EOT >> ./dist/cjs/package.json
+{
+    "type": "commonjs"
+}
+EOT
+        echo "Adding ./dist/esm/package.json"
+        rm -f ./dist/esm/package.json
+        cat <<EOT >> ./dist/esm/package.json
+{
+    "type": "module"
+}
+EOT
+    else
+        echo "Skipping post build fixes (no ESM setup yet)."
+    fi
+    echo "\n";
+}
+
 build_browser() {
     if [ -f ./tsconfig.browser.json ];
     then
@@ -77,4 +118,6 @@ then
     build_browser
 else
     build_node
+    build_esm
+    post_build_fixes
 fi

config/tsconfig.prod.esm.json

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

packages/block/karma.conf.js

@@ -13,6 +13,11 @@ module.exports = function (config) {
         acornOptions: {
           ecmaVersion: 12,
         },
+        resolve: {
+          alias: {
+            '@ethereumjs/util/provider': '../util/dist/cjs/provider.js',
+          },
+        },
         ignore: ['c-kzg'],
       },
     },

packages/block/package.json

@@ -16,8 +16,14 @@
   },
   "license": "MPL-2.0",
   "author": "mjbecze (mb@ethdev.com)",
-  "main": "dist/index.js",
-  "types": "dist/index.d.ts",
+  "main": "dist/cjs/index.js",
+  "module": "dist/esm/index.js",
+  "exports": {
+    ".": {
+      "import": "./dist/esm/index.js",
+      "require": "./dist/cjs/index.js"
+    }
+  },
   "files": [
     "dist",
     "src"
@@ -46,8 +52,7 @@
     "ethereum-cryptography": "^2.0.0"
   },
   "devDependencies": {
-    "c-kzg": "^2.0.4",
-    "testdouble": "^3.17.2"
+    "c-kzg": "^2.0.4"
   },
   "engines": {
     "node": ">=16"

packages/block/test/from-rpc.spec.ts

@@ -2,7 +2,6 @@ import { Chain, Common, Hardfork } from '@ethereumjs/common'
 import { bytesToPrefixedHexString, hexStringToBytes, randomBytes } from '@ethereumjs/util'
 import { bytesToHex, equalsBytes } from 'ethereum-cryptography/utils'
 import * as tape from 'tape'
-import * as td from 'testdouble'
 
 import { blockFromRpc } from '../src/from-rpc'
 import { blockHeaderFromRpc } from '../src/header-from-rpc'
@@ -189,21 +188,30 @@ tape('[fromJsonRpcProvider]', async (t) => {
   const common = new Common({ chain: Chain.Mainnet, hardfork: Hardfork.London })
   const provider = 'https://my.json.rpc.provider.com:8545'
 
-  const fakeFetch = async (_url: string, req: any) => {
-    if (
-      req.method === 'eth_getBlockByHash' &&
-      req.params[0] === '0x1850b014065b23d804ecf71a8a4691d076ca87c2e6fb8fe81ee20a4d8e884c24'
-    ) {
-      const block = await import(`./testdata/infura15571241wtxns.json`)
-      return block
+  const realFetch = global.fetch
+  //@ts-expect-error -- Typescript doesn't like us to replace global values
+  global.fetch = async (_url: string, req: any) => {
+    const json = JSON.parse(req.body)
+    if (json.params[0] === '0x1850b014065b23d804ecf71a8a4691d076ca87c2e6fb8fe81ee20a4d8e884c24') {
+      const txData = await import(`./testdata/infura15571241wtxns.json`)
+      return {
+        json: () => {
+          return {
+            result: txData,
+          }
+        },
+      }
     } else {
-      return null // Infura returns null if no block is found
+      return {
+        json: () => {
+          return {
+            result: null, // This is the value Infura returns if no transaction is found matching the provided hash
+          }
+        },
+      }
     }
   }
 
-  const providerUtils = require('@ethereumjs/util/dist/provider')
-  td.replace<any>(providerUtils, 'fetchFromProvider', fakeFetch)
-
   const blockHash = '0x1850b014065b23d804ecf71a8a4691d076ca87c2e6fb8fe81ee20a4d8e884c24'
   const block = await Block.fromJsonRpcProvider(provider, blockHash, { common })
   t.equal(
@@ -220,6 +228,6 @@ tape('[fromJsonRpcProvider]', async (t) => {
       'returned correct error message'
     )
   }
-  td.reset()
+  global.fetch = realFetch
   t.end()
 })

packages/block/tsconfig.prod.cjs.json

@@ -0,0 +1,16 @@
+{
+  "extends": "../../config/tsconfig.prod.cjs.json",
+  "compilerOptions": {
+    "lib": ["dom"],
+    "rootDir": "src",
+    "outDir": "dist/cjs",
+    "composite": true
+  },
+  "include": ["src/**/*.ts"],
+  "references": [
+    { "path": "../rlp/tsconfig.prod.cjs.json" },
+    { "path": "../trie/tsconfig.prod.cjs.json" },
+    { "path": "../tx/tsconfig.prod.cjs.json" },
+    { "path": "../util/tsconfig.prod.cjs.json" }
+  ]
+}

packages/block/tsconfig.prod.esm.json

@@ -0,0 +1,16 @@
+{
+  "extends": "../../config/tsconfig.prod.esm.json",
+  "compilerOptions": {
+    "lib": ["dom"],
+    "rootDir": "src",
+    "outDir": "dist/esm",
+    "composite": true
+  },
+  "include": ["src/**/*.ts"],
+  "references": [
+    { "path": "../rlp/tsconfig.prod.cjs.json" },
+    { "path": "../trie/tsconfig.prod.cjs.json" },
+    { "path": "../tx/tsconfig.prod.cjs.json" },
+    { "path": "../util/tsconfig.prod.cjs.json" }
+  ]
+}

packages/blockchain/package.json

@@ -16,8 +16,14 @@
   },
   "license": "MPL-2.0",
   "author": "mjbecze <mjbecze@gmail.com>",
-  "main": "dist/index.js",
-  "types": "dist/index.d.ts",
+  "main": "dist/cjs/index.js",
+  "module": "dist/esm/index.js",
+  "exports": {
+    ".": {
+      "import": "./dist/esm/index.js",
+      "require": "./dist/cjs/index.js"
+    }
+  },
   "files": [
     "dist",
     "src"

packages/blockchain/src/blockchain.ts

@@ -17,8 +17,7 @@ import { genesisStateRoot } from './genesisStates'
 import {} from './utils'
 
 import type { Consensus } from './consensus'
-import type { GenesisState } from './genesisStates'
-import type { BlockchainInterface, BlockchainOptions, OnBlock } from './types'
+import type { BlockchainInterface, BlockchainOptions, GenesisState, OnBlock } from './types'
 import type { BlockData } from '@ethereumjs/block'
 import type { CliqueConfig } from '@ethereumjs/common'
 import type { BigIntLike, DB, DBObject } from '@ethereumjs/util'

packages/blockchain/src/genesisStates/index.ts

@@ -4,20 +4,7 @@ import { Account, isHexPrefixed, toBytes, unpadBytes } from '@ethereumjs/util'
 import { keccak256 } from 'ethereum-cryptography/keccak'
 import { hexToBytes } from 'ethereum-cryptography/utils'
 
-import type { PrefixedHexString } from '@ethereumjs/util'
-
-export type StoragePair = [key: PrefixedHexString, value: PrefixedHexString]
-
-export type AccountState = [
-  balance: PrefixedHexString,
-  code: PrefixedHexString,
-  storage: Array<StoragePair>,
-  nonce: PrefixedHexString
-]
-
-export interface GenesisState {
-  [key: PrefixedHexString]: PrefixedHexString | AccountState
-}
+import type { AccountState, GenesisState } from '../types'
 
 /**
  * Derives the stateRoot of the genesis block based on genesis allocations

packages/blockchain/src/index.ts

@@ -1,4 +1,5 @@
 export { Blockchain } from './blockchain'
 export { CasperConsensus, CliqueConsensus, Consensus, EthashConsensus } from './consensus'
-export { BlockchainInterface, BlockchainOptions } from './types'
+export { DBOp, DBSaveLookups, DBSetBlockOrHeader, DBSetHashToNumber, DBSetTD } from './db/helpers'
+export * from './types'
 export * from './utils'

packages/blockchain/src/types.ts

@@ -1,8 +1,7 @@
 import type { Consensus } from './consensus'
-import type { GenesisState } from './genesisStates'
 import type { Block, BlockHeader } from '@ethereumjs/block'
 import type { Common } from '@ethereumjs/common'
-import type { DB, DBObject } from '@ethereumjs/util'
+import type { DB, DBObject, PrefixedHexString } from '@ethereumjs/util'
 
 export type OnBlock = (block: Block, reorg: boolean) => Promise<void> | void
 
@@ -80,6 +79,19 @@ export interface BlockchainInterface {
   getCanonicalHeadBlock?(): Promise<Block>
 }
 
+export type StoragePair = [key: PrefixedHexString, value: PrefixedHexString]
+
+export type AccountState = [
+  balance: PrefixedHexString,
+  code: PrefixedHexString,
+  storage: Array<StoragePair>,
+  nonce: PrefixedHexString
+]
+
+export interface GenesisState {
+  [key: PrefixedHexString]: PrefixedHexString | AccountState
+}
+
 /**
  * This are the options that the Blockchain constructor can receive.
  */

packages/blockchain/src/utils.ts

@@ -1,6 +1,6 @@
 import { addHexPrefix, bigIntToHex, isHexPrefixed } from '@ethereumjs/util'
 
-import type { GenesisState } from './genesisStates'
+import type { GenesisState } from './types'
 
 /**
  * Parses the geth genesis state into Blockchain {@link GenesisState}

packages/blockchain/tsconfig.prod.cjs.json

@@ -0,0 +1,17 @@
+{
+  "extends": "../../config/tsconfig.prod.cjs.json",
+  "compilerOptions": {
+    "rootDir": "src",
+    "outDir": "dist/cjs",
+    "types": ["node"],
+    "typeRoots": ["node_modules/@types"],
+    "composite": true
+  },
+  "include": ["src/**/*.ts", "src/**/*.json"],
+  "references": [
+    { "path": "../common/tsconfig.prod.cjs.json" },
+    { "path": "../ethash/tsconfig.prod.cjs.json" },
+    { "path": "../rlp/tsconfig.prod.cjs.json" },
+    { "path": "../util/tsconfig.prod.cjs.json" }
+  ]
+}