trufflesuite · davidmurdoch · Aug 22, 2023 · Aug 4, 2023 · Aug 4, 2023 · Aug 5, 2023
@@ -2,5 +2,5 @@ docs/assets/launch.json linguist-language=JSON5
 tsconfig-base.json linguist-language=JSON5
 .nycrc linguist-language=JSON
 .prettierrc linguist-language=JSON
-src/packages/ganache/api-extractor.json linguist-language=JSON5
-src/packages/ganache/tsdoc.json linguist-language=JSON5
+packages/ganache/api-extractor.json linguist-language=JSON5
+packages/ganache/tsdoc.json linguist-language=JSON5
@@ -1,21 +1,3 @@
 # global code owner:
 
 * @davidmurdoch
-
-# typed transactions:
-
-src/chains/ethereum/transaction/src/access-lists.ts @MicaiahReid
-src/chains/ethereum/transaction/src/base-transaction.ts @MicaiahReid
-src/chains/ethereum/transaction/src/eip1559-fee-market-transaction.ts @MicaiahReid
-src/chains/ethereum/transaction/src/eip2930-access-list-transaction.ts @MicaiahReid
-src/chains/ethereum/transaction/src/legacy-transaction.ts @MicaiahReid
-src/chains/ethereum/transaction/src/transaction-factory.ts @MicaiahReid
-src/chains/ethereum/transaction/src/transaction-types.ts @MicaiahReid
-
-# transaction pool:
-
-src/chains/ethereum/ethereum/src/transaction-pool.ts @MicaiahReid
-
-# miner:
-
-src/chains/ethereum/ethereum/src/miner @MicaiahReid
@@ -24,10 +24,10 @@ runs:
  # https://docs.github.com/en/actions/creating-actions/creating-a-composite-action
  using: "composite"
  steps:
- - name: Use npm 14
+ - name: Use node 16
  uses: actions/setup-node@v3
  with:
- node-version: 14
+ node-version: 16
 
  - name: Run installation
  run: npm ci
@@ -64,7 +64,7 @@ runs:
  uses: docker/build-push-action@175d02bffea74695e96b351069ac938b338802f9
  with:
  context: .
- file: ./src/packages/ganache/Dockerfile
+ file: ./packages/ganache/Dockerfile
  push: true
  tags: ${{ format('trufflesuite/ganache:{0}, trufflesuite/ganache:v{1}', inputs.TAG, inputs.VERSION) }}
  labels: ${{ steps.meta.outputs.labels }}

@@ -10,7 +10,7 @@ jobs:
  strategy:
  fail-fast: false
  matrix:
- node: [14.0.0, 14.x, 16.x, 18.x]
+ node: [16.0.0, 16.x, 18.x, 20.x]
  os: [windows-2019, ubuntu-20.04, ubuntu-22.04, macos-12]
 
  runs-on: ${{ matrix.os }}
@@ -43,7 +43,7 @@ jobs:
 
  - name: Check bundle size
  # this should match the os and version used in the release.yml
- if: startsWith(matrix.os, 'ubuntu-22.04') && startsWith(matrix.node, '14.') && matrix.node != '14.0.0'
+ if: startsWith(matrix.os, 'ubuntu-22.04') && startsWith(matrix.node, '20.') && matrix.node != '20.0.0'
  # 1. build ganache
  # 2. pack it into a tarball
  # 3. measure the _unpacked_ tarball's size
@@ -53,7 +53,7 @@ jobs:
  run: |
  npm run build &&
  npm run prepublishOnly &&
- cd ./src/packages/ganache &&
+ cd ./packages/ganache &&
  npm pack &&
  size="$(zcat ganache-*.tgz | wc -c)" &&
  echo "Bundle size: $size" &&
@@ -65,8 +65,8 @@ jobs:
  INFURA_KEY: "badc0de0deadc0debadc0de0deadc0de"
  - name: Upload artifact
  # this should match the os and version used in the release.yml
- if: startsWith(matrix.os, 'ubuntu-22.04') && startsWith(matrix.node, '14.') && matrix.node != '14.0.0'
+ if: startsWith(matrix.os, 'ubuntu-22.04') && startsWith(matrix.node, '20.') && matrix.node != '20.0.0'
  uses: actions/upload-artifact@v3
  with:
  name: Candidate
- path: ./src/packages/ganache/ganache-*.tgz
+ path: ./packages/ganache/ganache-*.tgz
@@ -10,7 +10,7 @@ jobs:
  strategy:
  fail-fast: false
  matrix:
- node: [14.0.0, 14.x, 16.x, 18.x]
+ node: [16.0.0, 16.x, 18.x, 20.x]
  os: [ubuntu-22.04]
 
  runs-on: ${{ matrix.os }}
@@ -34,7 +34,7 @@ jobs:
  strategy:
  fail-fast: false
  matrix:
- node: [14.0.0, 14.x, 16.x, 18.x]
+ node: [16.0.0, 16.x, 18.x, 20.x]
  os: [windows-2019, ubuntu-20.04, ubuntu-22.04, macos-12]
 
  runs-on: ${{ matrix.os }}

@@ -23,10 +23,9 @@ jobs:
  fetch-depth: 0
  - uses: actions/setup-node@v3
  with:
- # use node 14 until we can evaluate using npm 7+ and lock file version 2
  # this should match the node version used by the "check bundle size"
  # step in pr.yml
- node-version: 14
+ node-version: 20
 
  - name: Import Robot GPG key
  uses: crazy-max/ghaction-import-gpg@v4
@@ -103,11 +102,11 @@ jobs:
 
  - name: Update package versions for latest release (master)
  if: ${{ env.TAG == 'latest' }}
- run: $(npm bin)/lerna version "$RELEASE_KIND" --no-git-tag-version --no-push --yes --exact
+ run: npx -y lerna@4.0.0 version "$RELEASE_KIND" --no-git-tag-version --no-push --yes --exact
 
  - name: Update package versions for pre-releases
  if: ${{ env.TAG != 'latest' }}
- run: $(npm bin)/lerna version prerelease --no-git-tag-version --no-push --yes --exact --preid "$TAG"
+ run: npx -y lerna@4.0.0 version prerelease --no-git-tag-version --no-push --yes --exact --preid "$TAG"
 
  - name: Add updated versions to git
  run: git add .
@@ -124,7 +123,7 @@ jobs:
 
  - name: Set VERSION
  run: |
- echo "VERSION=$(node -e 'console.log(require("./src/packages/ganache/package.json").version)')" >> $GITHUB_ENV
+ echo "VERSION=$(node -e 'console.log(require("./packages/ganache/package.json").version)')" >> $GITHUB_ENV
 
  - name: Set VERSION as job output variable
  id: set_version_output
@@ -155,7 +154,7 @@ jobs:
  # this needs `--no-verify-access` until https:/lerna/lerna/issues/2788 is fixed
  - name: Release to npm
  run: |
- $(npm bin)/lerna publish from-package --yes --dist-tag ${TAG} --pre-dist-tag ${TAG} --no-verify-access
+ npx -y lerna@4.0.0 publish from-package --yes --dist-tag ${TAG} --pre-dist-tag ${TAG} --no-verify-access
  env:
  NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
  GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}

@@ -4,7 +4,7 @@ node_modules
 .nyc_output
 lerna-debug.log
 npm-debug.log
-src/**/*/lib
+packages/**/*/lib
 coverage
 dist/
 typings/
@@ -1 +1 @@
-v14.0.0
+v16.0.0
@@ -3,7 +3,7 @@
 .nyc_output
 lerna-debug.log
 npm-debug.log
-src/**/*/lib
+packages/**/*/lib
 coverage
 npm-shrinkwrap.json
 docs/assets/js/ganache/*

@@ -2,15 +2,14 @@
 
 ## Getting set up
 
-- Use Node.js v14.0.0.
- - Why v14.0.0? Because this is the first LTS release of Node.js v14 and is the earliest version Ganache supports.
+- Use Node.js v16.0.0.
+ - Why v16.0.0? Because this is the first LTS release of Node.js v16 and is the earliest version Ganache supports.
  - recommendation: use [nvm](https:/nvm-sh/nvm) on Linux and macOS, and [nvm-windows](https:/coreybutler/nvm-windows) on
  Windows, to configure your node version.
- - On Linux and macOS, if you have `nvm` installed, just run `nvm use` to switch to Node.js v14.0.0.
+ - On Linux and macOS, if you have `nvm` installed, just run `nvm use` to switch to Node.js v16.0.0.
 - `git clone [email protected]:trufflesuite/ganache.git`
 - `cd ganache`
-- `npm install` (use npm v6)
-- On Linux and macOS: run `source completions.sh` to enable autocomplete for npm scripts.
+- `npm install` (use npm v7)
 
 ## Solving node-gyp issues
 
@@ -97,20 +96,13 @@ To pass options to the cli you must separate the args with `--`, e.g.:
 
 - `npm start -- --chain.chainId 1 --wallet.totalAccounts 5`
 
-## To create a new chain/flavor
-
-- `npm run create <name> --location chains`
-
-This will create a new folder at `src/chains/<name>` where `<name>` should be the flavor name (e.g. `ethereum`), which
-you then can [create packages under](#to-create-a-new-package).
-
 ## To create a new package
 
 - `npm run create <name> --location <location> [--folder <folder>]`
 
-This will create a new package with Ganache defaults at `src/<location>/<name>`.
+This will create a new package with Ganache defaults at `<location>/<name>`.
 
-If you provide the optional `--folder` option, the package will be created at `src/<location>/<folder>`.
+If you provide the optional `--folder` option, the package will be created at `<location>/<folder>`.
 
 ## To add a module to a package:
 
@@ -122,10 +114,10 @@ Where `<module>` is the npm-module you want to add and `<package>` is where you
 Example:
 
 ```bash
-npx lerna add @ganache/options -E --scope=@ganache/filecoin
+npx lerna add @ganache/options -E --scope=@ganache/ethereum
 ```
 
-will add our local `@ganache/options` package to the `@ganache/filecoin` package.
+will add our local `@ganache/options` package to the `@ganache/ethereum` package.
 
 ## To remove a module from another package:
 
@@ -160,8 +152,8 @@ index 2a2aa9e..57cbf21 100644
  "--colors",
  "--require",
  "ts-node/register",
-- "${workspaceFolder}/src/**/tests/**/*.test.ts"
-+ "${workspaceFolder}/src/chains/ethereum/ethereum/tests/**/*.test.ts"
+- "${workspaceFolder}/packages/**/tests/**/*.test.ts"
++ "${workspaceFolder}/packages/ethereum/ethereum/tests/**/*.test.ts"
  ],
  "skipFiles": ["<node_internals>/**"],
  "console": "integratedTerminal",
@@ -171,7 +163,7 @@ index 2a2aa9e..57cbf21 100644
 
 These are guidelines, not rules. :-)
 
-- Use Node.js v14.0.0 for most local development.
+- Use Node.js v16.0.0 for most local development.
 - Use `bigint` literals, e.g., `123n`; if the number is externally configurable and/or could exceed
  `Number.MAX_SAFE_INTEGER`.
 - Write tests.

@@ -1 +1 @@
-./src/packages/ganache/README.md
+./packages/ganache/README.md
@@ -33,7 +33,7 @@ depending on how you originally installed ganache-cli or ganache-core._
 
 #### Locally installed
 
-A local installation makes it possible to `import` or `require` Ganache 
+A local installation makes it possible to `import` or `require` Ganache
 programmatically from JavaScript or TypeScript. Additionally, you can run the
 command line version of Ganache from your [package.json scripts](https://docs.npmjs.com/cli/v8/using-npm/scripts) or directly
 from the command line using `npx ganache` ([what is npx?](https://www.npmjs.com/package/npx)).
@@ -113,7 +113,7 @@ and it defaulted to `true`.
 
 Ganache now _disables_ the `vmErrorsOnRPCResponse` functionality by default.
 
-If your code relies on these non-standard errors on transaction failure, you'll 
+If your code relies on these non-standard errors on transaction failure, you'll
 need to _enable_ the `vmErrorsOnRpcResponse` flag to restore this behavior:
 
 ```console
@@ -140,6 +140,10 @@ As of v7.0.0 we no longer support Node v8-v10. You'll need to update to Node v12
 
 We no longer support Node v12. You'll need to update to Node v14.0.0 or later. NOTE: Support for Node.js v14.x.x will be dropped shortly after the Node.js Foundation stops supporting it in April 2023.
 
+#### v7.8.0+, Dropped support for Node v14
+
+We no longer support Node v14. You'll need to update to Node v16.0.0 or later. NOTE: Support for Node.js v16.x.x will be dropped shortly after the Node.js Foundation stops supporting it in April 2024.
+
 #### DockerHub repo has been moved to trufflesuite/ganache
 
 You may want to remove your old Docker images and containers and then pull
@@ -288,7 +292,7 @@ likely enable this in the future.
 
 Ganache's old database format is incompatible with this version. We've decided
 to hold off on building migration tools for this. If you will need a migration
-tool (you use the `db` flag or the `db_path` option and are unable to recreate 
+tool (you use the `db` flag or the `db_path` option and are unable to recreate
 your initial DB state) please
 [open an issue](https:/trufflesuite/ganache/issues/new)
 to let us know.
@@ -343,7 +347,7 @@ If you send a transaction with `eth_sendTransaction` and that transaction doesn'
 
 ```typescript
 // send a "legacy" transaction
-const hash = await provider.request("eth_sendTransaction", [{ from }]); 
+const hash = await provider.request("eth_sendTransaction", [{ from }]);
 const tx = await provider.request("eth_getTransactionByHash", [hash]);
 // The returned `type` field indicates it was updated to a type 2 transaction
 assert.strictEqual(tx.type, "0x2");

@@ -40,13 +40,6 @@
  * @license MIT
  */
 
-/*!
- * @ganache/filecoin-options
- *
- * @author Tim Coulter
- * @license MIT
- */
-
 /*!
  * @ganache/secp256k1
  *

@@ -24,7 +24,7 @@
  "--colors",
  "--require",
  "ts-node/register",
- "${workspaceFolder}/src/**/tests/**/*.test.ts"
+ "${workspaceFolder}/packages/**/tests/**/*.test.ts"
  ],
  "skipFiles": [
  "<node_internals>/**"