develop: esm support

.github/workflows/e2e-hardhat.yml

@@ -1,9 +1,10 @@
 name: E2E Hardhat Tests
 on:
   push:
-    branches: [master, develop]
+    branches: [master]
     tags: ['*']
   pull_request:
+    branches: [master]
     types: [opened, reopened, synchronize]
 
 env:

.github/workflows/node-versions.yml

@@ -89,6 +89,10 @@ jobs:
         run: npm run test
         working-directory: packages/util
 
+      - name: Test StateManager
+        run: npm run test
+        working-directory: packages/statemanager
+
       - name: Test VM
         run: npm run test:API
         working-directory: packages/vm

.github/workflows/statemanager-build.yml

@@ -0,0 +1,47 @@
+name: StateManager
+on:
+  push:
+    branches: [master, develop]
+    tags: ['*']
+  pull_request:
+    types: [opened, reopened, synchronize]
+
+env:
+  cwd: ${{github.workspace}}/packages/statemanager
+
+defaults:
+  run:
+    working-directory: packages/statemanager
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.head_ref || github.run_id }}
+  cancel-in-progress: true
+
+jobs:
+  test-statemanager:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        node-version: [16]
+    steps:
+      - uses: actions/checkout@v2
+        with:
+          submodules: recursive
+
+      - name: Use Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v2
+        with:
+          node-version: ${{ matrix.node-version }}
+          cache: 'npm'
+
+      - run: npm i
+        working-directory: ${{github.workspace}}
+
+      - run: npm run lint
+      - run: npm run coverage
+
+      - uses: codecov/codecov-action@v2
+        with:
+          files: ${{ env.cwd }}/coverage/lcov.info
+          flags: statemanager
+        if: ${{ matrix.node-version == 16 }}

.gitignore

@@ -65,9 +65,8 @@ jspm_packages/
 # parcel-bundler cache (https://parceljs.org/)
 .cache
 
-# generate output
-dist
-dist.browser
+# generated output
+dist*
 
 # Gatsby files
 .cache/

README.md

@@ -11,19 +11,20 @@ This was originally the EthereumJS VM repository. In Q1 2020 we brought some of
 
 🚧 Please note that the `master` branch is updated on a daily basis, and to inspect code related to a specific package version, refer to the [tags](https://github.com/ethereumjs/ethereumjs-monorepo/tags).
 
-| package                                      | npm                                                         | issues                                                                  | tests                                                                  | coverage                                                                |
-| -------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------------------- | ---------------------------------------------------------------------- | ----------------------------------------------------------------------- |
-| [@ethereumjs/block][block-package]           | [![NPM Package][block-npm-badge]][block-npm-link]           | [![Block Issues][block-issues-badge]][block-issues-link]                | [![Actions Status][block-actions-badge]][block-actions-link]           | [![Code Coverage][block-coverage-badge]][block-coverage-link]           |
-| [@ethereumjs/blockchain][blockchain-package] | [![NPM Package][blockchain-npm-badge]][blockchain-npm-link] | [![Blockchain Issues][blockchain-issues-badge]][blockchain-issues-link] | [![Actions Status][blockchain-actions-badge]][blockchain-actions-link] | [![Code Coverage][blockchain-coverage-badge]][blockchain-coverage-link] |
-| [@ethereumjs/client][client-package]         | [![NPM Package][client-npm-badge]][client-npm-link]         | [![Client Issues][client-issues-badge]][client-issues-link]             | [![Actions Status][client-actions-badge]][client-actions-link]         | [![Code Coverage][client-coverage-badge]][client-coverage-link]         |
-| [@ethereumjs/common][common-package]         | [![NPM Package][common-npm-badge]][common-npm-link]         | [![Common Issues][common-issues-badge]][common-issues-link]             | [![Actions Status][common-actions-badge]][common-actions-link]         | [![Code Coverage][common-coverage-badge]][common-coverage-link]         |
-| [@ethereumjs/devp2p][devp2p-package]         | [![NPM Package][devp2p-npm-badge]][devp2p-npm-link]         | [![Devp2p Issues][devp2p-issues-badge]][devp2p-issues-link]             | [![Actions Status][devp2p-actions-badge]][devp2p-actions-link]         | [![Code Coverage][devp2p-coverage-badge]][devp2p-coverage-link]         |
-| [@ethereumjs/ethash][ethash-package]         | [![NPM Package][ethash-npm-badge]][ethash-npm-link]         | [![Ethash Issues][ethash-issues-badge]][ethash-issues-link]             | [![Actions Status][ethash-actions-badge]][ethash-actions-link]         | [![Code Coverage][ethash-coverage-badge]][ethash-coverage-link]         |
-| [merkle-patricia-tree][trie-package]         | [![NPM Package][trie-npm-badge]][trie-npm-link]             | [![Trie Issues][trie-issues-badge]][trie-issues-link]                   | [![Actions Status][trie-actions-badge]][trie-actions-link]             | [![Code Coverage][trie-coverage-badge]][trie-coverage-link]             |
-| [rlp][rlp-package]                           | [![NPM Package][rlp-npm-badge]][rlp-npm-link]               | [![rlp Issues][rlp-issues-badge]][rlp-issues-link]                      | [![Actions Status][rlp-actions-badge]][rlp-actions-link]               | [![Code Coverage][rlp-coverage-badge]][rlp-coverage-link]               |
-| [@ethereumjs/tx][tx-package]                 | [![NPM Package][tx-npm-badge]][tx-npm-link]                 | [![Tx Issues][tx-issues-badge]][tx-issues-link]                         | [![Actions Status][tx-actions-badge]][tx-actions-link]                 | [![Code Coverage][tx-coverage-badge]][tx-coverage-link]                 |
-| [ethereumjs-util][util-package]              | [![NPM Package][util-npm-badge]][util-npm-link]             | [![Util Issues][util-issues-badge]][util-issues-link]                   | [![Actions Status][util-actions-badge]][util-actions-link]             | [![Code Coverage][util-coverage-badge]][util-coverage-link]             |
-| [@ethereumjs/vm][vm-package]                 | [![NPM Package][vm-npm-badge]][vm-npm-link]                 | [![VM Issues][vm-issues-badge]][vm-issues-link]                         | [![Actions Status][vm-actions-badge]][vm-actions-link]                 | [![Code Coverage][vm-coverage-badge]][vm-coverage-link]                 |
+| package                                          | npm                                                             | issues                                                                        | tests                                                                      | coverage                                                                    |
+| ------------------------------------------------ | --------------------------------------------------------------- | ----------------------------------------------------------------------------- | -------------------------------------------------------------------------- | --------------------------------------------------------------------------- |
+| [@ethereumjs/block][block-package]               | [![NPM Package][block-npm-badge]][block-npm-link]               | [![Block Issues][block-issues-badge]][block-issues-link]                      | [![Actions Status][block-actions-badge]][block-actions-link]               | [![Code Coverage][block-coverage-badge]][block-coverage-link]               |
+| [@ethereumjs/blockchain][blockchain-package]     | [![NPM Package][blockchain-npm-badge]][blockchain-npm-link]     | [![Blockchain Issues][blockchain-issues-badge]][blockchain-issues-link]       | [![Actions Status][blockchain-actions-badge]][blockchain-actions-link]     | [![Code Coverage][blockchain-coverage-badge]][blockchain-coverage-link]     |
+| [@ethereumjs/client][client-package]             | [![NPM Package][client-npm-badge]][client-npm-link]             | [![Client Issues][client-issues-badge]][client-issues-link]                   | [![Actions Status][client-actions-badge]][client-actions-link]             | [![Code Coverage][client-coverage-badge]][client-coverage-link]             |
+| [@ethereumjs/common][common-package]             | [![NPM Package][common-npm-badge]][common-npm-link]             | [![Common Issues][common-issues-badge]][common-issues-link]                   | [![Actions Status][common-actions-badge]][common-actions-link]             | [![Code Coverage][common-coverage-badge]][common-coverage-link]             |
+| [@ethereumjs/devp2p][devp2p-package]             | [![NPM Package][devp2p-npm-badge]][devp2p-npm-link]             | [![Devp2p Issues][devp2p-issues-badge]][devp2p-issues-link]                   | [![Actions Status][devp2p-actions-badge]][devp2p-actions-link]             | [![Code Coverage][devp2p-coverage-badge]][devp2p-coverage-link]             |
+| [@ethereumjs/ethash][ethash-package]             | [![NPM Package][ethash-npm-badge]][ethash-npm-link]             | [![Ethash Issues][ethash-issues-badge]][ethash-issues-link]                   | [![Actions Status][ethash-actions-badge]][ethash-actions-link]             | [![Code Coverage][ethash-coverage-badge]][ethash-coverage-link]             |
+| [merkle-patricia-tree][trie-package]             | [![NPM Package][trie-npm-badge]][trie-npm-link]                 | [![Trie Issues][trie-issues-badge]][trie-issues-link]                         | [![Actions Status][trie-actions-badge]][trie-actions-link]                 | [![Code Coverage][trie-coverage-badge]][trie-coverage-link]                 |
+| [rlp][rlp-package]                               | [![NPM Package][rlp-npm-badge]][rlp-npm-link]                   | [![rlp Issues][rlp-issues-badge]][rlp-issues-link]                            | [![Actions Status][rlp-actions-badge]][rlp-actions-link]                   | [![Code Coverage][rlp-coverage-badge]][rlp-coverage-link]                   |
+| [@ethereumjs/statemanager][statemanager-package] | [![NPM Package][statemanager-npm-badge]][statemanager-npm-link] | [![StateManager Issues][statemanager-issues-badge]][statemanager-issues-link] | [![Actions Status][statemanager-actions-badge]][statemanager-actions-link] | [![Code Coverage][statemanager-coverage-badge]][statemanager-coverage-link] |
+| [@ethereumjs/tx][tx-package]                     | [![NPM Package][tx-npm-badge]][tx-npm-link]                     | [![Tx Issues][tx-issues-badge]][tx-issues-link]                               | [![Actions Status][tx-actions-badge]][tx-actions-link]                     | [![Code Coverage][tx-coverage-badge]][tx-coverage-link]                     |
+| [ethereumjs-util][util-package]                  | [![NPM Package][util-npm-badge]][util-npm-link]                 | [![Util Issues][util-issues-badge]][util-issues-link]                         | [![Actions Status][util-actions-badge]][util-actions-link]                 | [![Code Coverage][util-coverage-badge]][util-coverage-link]                 |
+| [@ethereumjs/vm][vm-package]                     | [![NPM Package][vm-npm-badge]][vm-npm-link]                     | [![VM Issues][vm-issues-badge]][vm-issues-link]                               | [![Actions Status][vm-actions-badge]][vm-actions-link]                     | [![Code Coverage][vm-coverage-badge]][vm-coverage-link]                     |
 
 ## Coverage report
 
@@ -47,6 +48,7 @@ Detailed version can be seen on [Codecov.io][coverage-link]
    trie --> client
    trie --> vm
    trie --> block
+   trie --> blockchain
    common --> block
    common --> blockchain
    common --> tx
@@ -56,9 +58,12 @@ Detailed version can be seen on [Codecov.io][coverage-link]
    tx --> block
    tx --> vm
    vm --> client
- ```
+   statemanager --> vm
+   common --> statemanager
+   trie --> statemanager
+```
 
- To update the diagram above edit the README file and open a new PR with the changes.
+To update the diagram above edit the README file and open a new PR with the changes.
 
 ## Getting Started
 
@@ -170,6 +175,15 @@ Most packages are [MPL-2.0](<https://tldrlegal.com/license/mozilla-public-licens
 [util-actions-link]: https://github.com/ethereumjs/ethereumjs-monorepo/actions?query=workflow%3A%22Util%22
 [util-coverage-badge]: https://codecov.io/gh/ethereumjs/ethereumjs-monorepo/branch/master/graph/badge.svg?flag=util
 [util-coverage-link]: https://codecov.io/gh/ethereumjs/ethereumjs-monorepo/tree/master/packages/util
+[statemanager-package]: ./packages/statemanager
+[statemanager-npm-badge]: https://img.shields.io/npm/v/@ethereumjs/statemanager.svg
+[statemanager-npm-link]: https://www.npmjs.com/package/@ethereumjs/statemanager
+[statemanager-issues-badge]: https://img.shields.io/github/issues/ethereumjs/ethereumjs-monorepo/package:%20statemanager?label=issues
+[statemanager-issues-link]: https://github.com/ethereumjs/ethereumjs-monorepo/issues?q=is%3Aopen+is%3Aissue+label%3A"package%3A+statemanager"
+[statemanager-actions-badge]: https://github.com/ethereumjs/ethereumjs-monorepo/workflows/StateManager/badge.svg
+[statemanager-actions-link]: https://github.com/ethereumjs/ethereumjs-monorepo/actions?query=workflow%3A%22StateManager%22
+[statemanager-coverage-badge]: https://codecov.io/gh/ethereumjs/ethereumjs-monorepo/branch/master/graph/badge.svg?flag=statemanager
+[statemanager-coverage-link]: https://codecov.io/gh/ethereumjs/ethereumjs-monorepo/tree/master/packages/statemanager
 [vm-package]: ./packages/vm
 [vm-npm-badge]: https://img.shields.io/npm/v/@ethereumjs/vm.svg
 [vm-npm-link]: https://www.npmjs.com/package/@ethereumjs/vm

config/README.md

@@ -33,17 +33,15 @@ Exposed CLI commands:
 
 ### Usage
 
-Add `.eslintrc.js`:
+Add `.eslintrc.cjs`:
 
 ```js
-module.exports = {
-  extends: '../../config/eslint.js',
-}
+module.exports = { extends: '../../config/eslint.cjs' }
 ```
 
 In this file you can add rule adjustments or overrides for the specific package.
 
-Add `prettier.config.js`:
+Add `prettier.config.cjs`:
 
 ```js
 module.exports = require('../../config/prettier.config')
@@ -110,26 +108,28 @@ Add `tsconfig.json`:
 }
 ```
 
-Add `tsconfig.prod.json`:
+Add `tsconfig.esm.json`:
 
 ```json
 {
-  "extends": "../../config/tsconfig.prod.json",
+  "extends": "../../config/tsconfig.esm.json",
   "include": ["src/**/*.ts"],
   "compilerOptions": {
-    "outDir": "./dist"
+    "outDir": "./dist/esm"
   }
 }
 ```
 
-Add `tsconfig.browser.json`:
+Add `tsconfig.cjs.json`:
 
 ```json
 {
-  "extends": "../../config/tsconfig.browser.json",
+  "extends": "./tsconfig.esm.json",
   "include": ["src/**/*.ts"],
   "compilerOptions": {
-    "outDir": "./dist.browser"
+    "module": "commonjs",
+    "moduleResolution": "node",
+    "outDir": "./dist/cjs"
   }
 }
 ```
@@ -145,25 +145,35 @@ Use CLI commands above in your `package.json`:
   }
 ```
 
-The default production target is ES2017. To support shipping the ES5 target for browsers, add to your `package.json`:
+Add to your `package.json`:
 
 ```json
-  "main": "dist/index.js",
-  "types": "dist/index.d.ts",
-  "browser": "dist.browser/index.js",
-  "files": [
-    "dist",
-    "dist.browser"
-  ]
+  "main": "./dist/cjs/index.js",
+  "types": "./dist/types/index.d.ts",
+  "browser": "./dist/esm/index.js",
+  "exports": {
+    ".": {
+      "import": "./dist/esm/index.js",
+      "require": "./dist/cjs/index.js",
+      "types": "./dist/types/index.d.ts",
+      "browser": "./dist/esm/index.js"
+    },
+    "./dist/*": {
+      "import": "./dist/esm/*",
+      "require": "./dist/cjs/*",
+      "types": "./dist/types/*",
+      "browser": "./dist/esm/*"
+    }
+  },
 ```
 
 ## Documentation
 
-Add `typedoc.js` to a package that extends the generic TypeDoc configuration:
+Add `typedoc.cjs` to a package that extends the generic TypeDoc configuration:
 
 ```js
-module.exports = {
-  extends: '../../config/typedoc.js',
+export default {
+  extends: '../../config/typedoc.cjs',
   // Additional directives
 }
 ```

config/cli/lint-fix.sh

@@ -17,12 +17,12 @@ dim() {
     echo "${DIM}$1${NOCOLOR}"
 }
 
-dim "> eslint --fix --config ./.eslintrc.js . \\ "
+dim "> eslint --fix --config ./.eslintrc.cjs . \\ "
 dim "\t --ext .js,.jsx,.ts,.tsx \\ "
 
 blue "[Lint]${NOCOLOR} fixing..."
 
-eslint --fix --config ./.eslintrc.js . --ext .js,.jsx,.ts,.tsx
+eslint --fix --config ./.eslintrc.cjs . --ext .js,.jsx,.ts,.tsx
 
 RETURN_CODE=$?
 

config/cli/lint.sh

@@ -17,12 +17,12 @@ dim() {
     echo "${DIM}$1${NOCOLOR}"
 }
 
-dim "> eslint --format codeframe --config ./.eslintrc.js . \\ "
+dim "> eslint --format codeframe --config ./.eslintrc.cjs . \\ "
 dim "\t --ext .js,.jsx,.ts,.tsx \\ "
 
 blue "[Lint]${NOCOLOR} checking..."
 
-eslint --format codeframe --config ./.eslintrc.js . --ext .js,.jsx,.ts,.tsx
+eslint --format codeframe --config ./.eslintrc.cjs . --ext .js,.jsx,.ts,.tsx
 
 RETURN_CODE=$?
 

config/cli/ts-build.sh

@@ -2,7 +2,6 @@
 set -e
 # Purposefully not using `set -o xtrace`, for friendlier output.
 
-
 # Presentational variables and functions declaration.
 
 BLUE="\033[0;34m"
@@ -28,57 +27,35 @@ dim() {
     printf "${DIM}$1${NOCOLOR}"
 }
 
+# Build functions declaration.
 
-# Build function declaration.
-
-build_node() {
-    blue "[Node build] "
-    echo "Using tsconfig.prod.json"
+build_esm() {
+    blue "[ESM build] "
+    echo "Using tsconfig.esm.json"
 
-    echo "> tsc --build ./tsconfig.prod.json"
-    printf "${BLUE}[Node build] Working... "
+    echo "> tsc --build ./tsconfig.esm.json"
+    printf "${BLUE}[ESM build] Working... "
 
-    tsc --build ./tsconfig.prod.json
+    tsc --build ./tsconfig.esm.json
     green "DONE"
 
     echo "\n";
 }
 
-build_browser() {
-    if [ -f ./tsconfig.browser.json ];
-    then
-        blue "[Browser build] "
-        echo "Using tsconfig.browser.json"
-        echo "> tsc -p ./tsconfig.browser.json"
-
-        blue "[Browser build] "
-        printf "Working... "
+build_cjs() {
+    blue "[CJS build] "
+    echo "Using tsconfig.cjs.json"
 
-        tsc -p ./tsconfig.browser.json
-        RETURN_CODE=$?
+    echo "> tsc --build ./tsconfig.cjs.json"
+    printf "${BLUE}[CJS build] Working... "
 
-        if [ $RETURN_CODE -eq 0 ]; then
-            green "DONE"
-        else
-            exit $RETURN_CODE
-        fi
-    else
-        dim "Skipping browser build, because no tsconfig.browser.json file is present."
-    fi
+    tsc -p ./tsconfig.cjs.json
+    green "DONE"
 
     echo "\n";
 }
 
-
 # Begin build process.
 
-if [ "$1" = "node" ];
-then
-    build_node
-elif [ "$1" = "browser" ];
-then
-    build_browser
-else
-    build_node
-    build_browser
-fi
+build_esm
+#build_cjs