Merge branch 'develop' into ngyp-macos-troubleshooting

.github/actions/docker-publish/action.yml

@@ -34,34 +34,34 @@ runs:
       shell: bash
 
     - name: Log in to Docker Hub
-      uses: docker/login-action@f054a8b539a109f9f41c372932f1ae047eff08c9
+      uses: docker/login-action@f75d088332b07a08afadf6ac53c74509b9453f12
       with:
         username: ${{ inputs.DOCKER_USERNAME }}
         password: ${{ inputs.DOCKER_ACCESS_TOKEN }}
 
     - name: Log in to the Container registry
-      uses: docker/login-action@f054a8b539a109f9f41c372932f1ae047eff08c9
+      uses: docker/login-action@f75d088332b07a08afadf6ac53c74509b9453f12
       with:
         registry: ghcr.io
         username: ${{ github.actor }}
         password: ${{ inputs.GITHUB_TOKEN }}
 
     - name: Extract metadata (tags, labels) for Docker
       id: meta
-      uses: docker/metadata-action@98669ae865ea3cffbcbaa878cf57c20bbf1c6c38
+      uses: docker/metadata-action@314ddf6d4a82333bf1bc7630399df41bf68eba09
       with:
         images: |
           trufflesuite/ganache
           ghcr.io/${{ github.repository}}
 
     - name: Set up QEMU
-      uses: docker/setup-qemu-action@0522dcd2bf084920c411162fde334a308be75015
+      uses: docker/setup-qemu-action@38836d31bd1e0f8f29b8c7ad0412da32020f15b3
 
     - name: Set up Docker Buildx
-      uses: docker/setup-buildx-action@91cb32d715c128e5f0ede915cd7e196ab7799b83
+      uses: docker/setup-buildx-action@39a1a82492fd1ad19af19d61b5f748e4cb6cd1af
 
     - name: Build and push Docker image
-      uses: docker/build-push-action@ad44023a93711e3deb337508980b4b5e9bcdc5dc
+      uses: docker/build-push-action@175d02bffea74695e96b351069ac938b338802f9
       with:
         context: .
         file: ./src/packages/ganache/Dockerfile

.github/workflows/pr.yml

@@ -11,11 +11,7 @@ jobs:
       fail-fast: false
       matrix:
         node: [14.0.0, 14.x, 16.x, 18.x]
-        os: [windows-2019, ubuntu-18.04, ubuntu-20.04, macos-11]
-        exclude:
-          # Node v18 does not run on ubuntu-18.04: https://github.com/nodejs/node/issues/42351#issuecomment-1068424442
-          - os: ubuntu-18.04
-            node: 18.x
+        os: [windows-2019, ubuntu-20.04, ubuntu-22.04, macos-12]
 
     runs-on: ${{ matrix.os }}
 
@@ -47,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-20.04') && startsWith(matrix.node, '14.')
+        if: startsWith(matrix.os, 'ubuntu-22.04') && startsWith(matrix.node, '14.') && matrix.node != '14.0.0'
         # 1. build ganache
         # 2. pack it into a tarball
         # 3. measure the _unpacked_ tarball's size
@@ -56,6 +52,7 @@ jobs:
         # 5. exit with non-zero exit code if the test fails.
         run: |
           npm run build &&
+          npm run prepublishOnly &&
           cd ./src/packages/ganache &&
           npm pack &&
           size="$(zcat ganache-*.tgz | wc -c)" &&
@@ -66,3 +63,10 @@ jobs:
           # use a fake infura key for the bundle size check so this test will
           # run successfully on external contributor Pull Requests
           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'
+        uses: actions/upload-artifact@v3
+        with:
+          name: Candidate
+          path: ./src/packages/ganache/ganache-*.tgz

.github/workflows/push.yml

@@ -11,7 +11,7 @@ jobs:
       fail-fast: false
       matrix:
         node: [14.0.0, 14.x, 16.x, 18.x]
-        os: [ubuntu-20.04]
+        os: [ubuntu-22.04]
 
     runs-on: ${{ matrix.os }}
 
@@ -35,11 +35,7 @@ jobs:
       fail-fast: false
       matrix:
         node: [14.0.0, 14.x, 16.x, 18.x]
-        os: [windows-2019, ubuntu-18.04, ubuntu-20.04, macos-11]
-        exclude:
-          # Node v18 does not run on ubuntu-18.04: https://github.com/nodejs/node/issues/42351#issuecomment-1068424442
-          - os: ubuntu-18.04
-            node: 18.x
+        os: [windows-2019, ubuntu-20.04, ubuntu-22.04, macos-12]
 
     runs-on: ${{ matrix.os }}
 
@@ -59,29 +55,6 @@ jobs:
         if: startsWith(matrix.os, 'windows-')
         uses: microsoft/[email protected]
 
-      - name: install node tools
-        # we don't need to install the windows-build-tools package, as we
-        # already have almost everything we need. We only need to install
-        # python 2.7. Also windows-build-tools@4 fails to install because some
-        # resources it downloads no longer exist, and windows-build-tools@5
-        # fails to install Python (it will wait on the python installer forever)
-        if: startsWith(matrix.os, 'windows-')
-        uses: actions/setup-python@v2
-        with:
-          python-version: "2.7"
-
-      - name: install node-gyp
-        if: startsWith(matrix.os, 'windows-')
-        run: npm install --global [email protected]
-
-      - name: Set node config to use python2.7
-        if: startsWith(matrix.os, 'windows-')
-        run: npm config set python python2.7
-
-      - name: Set node config to set msvs_version to 2019
-        if: startsWith(matrix.os, 'windows-')
-        run: npm config set msvs_version 2019 --global
-
       - run: npm ci
       - run: npm run tsc
       - run: npm test

.github/workflows/release.yml

@@ -11,7 +11,7 @@ jobs:
   release:
     # this should match the os version used by the "check bundle size" step in
     # pr.yml
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-22.04
     outputs:
       TAG: ${{ steps.set_tag_output.outputs.TAG }}
       VERSION: ${{ steps.set_version_output.outputs.VERSION }}
@@ -169,14 +169,18 @@ jobs:
 
   publish-docker:
     needs: release
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-22.04
     steps:
       # because the docker publish action is an action we made, we have to
       # check out the repo
       - name: Checkout repository
         uses: actions/checkout@v3
         with:
           token: ${{ secrets.GITHUB_TOKEN }}
+          # by specifying the tag of this version as the ref to checkout, we're
+          # making sure the version we just released to npm is being released to
+          # Docker.
+          ref: v${{ needs.release.outputs.VERSION }}
       - name: Run Ganache's docker publish action
         # we are running our local action, so point directly to a folder
         # containing an `action.yml` file

CONTRIBUTING.md

@@ -16,9 +16,7 @@
 
 If installation fails due to a `node-gyp` issue you may need to perform some additional system configuration.
 
-Ganache uses [node-gyp v7.1.2](https://github.com/nodejs/node-gyp/tree/v7.1.2) as part of its build system, which requires Python v2.7, v3.5, v3.6, v3.7, or v3.8 to be installed on the system.
-
-In order to debug issues with Python, follow the instructions for your operating system below:
+note: Ganache uses [node-gyp v7.1.2](https://github.com/nodejs/node-gyp/tree/v7.1.2) as part of its build system, which requires Python v2.7, v3.5, v3.6, v3.7, or v3.8 to be installed on the system.
 
 ### on Windows
 
@@ -27,6 +25,9 @@ In order to debug issues with Python, follow the instructions for your operating
 
 ### on Linux (Ubuntu-based)
 
+- Make sure `npm` commands are not run as `root`.
+- If you get an error that `make` isn't installed you might need to also install the `build-essential` package
+ - example `sudo apt update && sudo apt install build-essential`
 - Determine whether you have a compatible version of Python installed:
   - example: `python --version` (and `python3 --version` if `python3` is installed)
 - If you do not have a compatible version installed: (v2.7, v3.5, v3.6, v3.7, or v3.8), you will need to install it:

docs/404.html

@@ -0,0 +1,12 @@
+<!DOCTYPE html>
+<html lang="en">
+
+<head>
+  <title>404 Page Not Found · Ganache</title>
+</head>
+
+<body>
+  <h1>404 Page Not Found</h1>
+</body>
+
+</html>

docs/assets/css/highlight-truffle.css

@@ -40,7 +40,7 @@
   top: 0;
   border-radius: 10%/40%;
   font-size: 0.8em;
-  background: var(--dark-porsche);
+  background: var(--editor-text-8);
   font-family: "Open sans";
   transform: translate(-3vw, calc(-100% + 3.05vw));
   padding: 0.5vw 1vw 3vw;
@@ -55,7 +55,7 @@
 .code pre {
   overflow: hidden;
   border-radius: 5%/50%;
-  border: solid var(--dark-porsche);
+  border: solid var(--editor-text-8);
   border-width: 0 0.5vw;
 
   box-shadow: 0 5px 50px rgba(0, 0, 0, 0.2), 0 -1px 1px rgba(224, 191, 168, 1),
@@ -76,7 +76,7 @@
   background: var(--dark-chocolate);
   color: var(--very-light-porsche);
   border-radius: 50%/5%;
-  border: solid var(--dark-porsche);
+  border: solid var(--editor-text-8);
   border-width: 0.5vw 0;
   position: relative;
   transition: box-shadow 3s ease-in-out;
@@ -91,64 +91,60 @@
 .hljs-comment,
 .hljs-quote,
 .hljs-meta {
-  color: var(--light-pink);
+  color: var(--editor-text-9);
 }
 
 .hljs-keyword,
 .hljs-selector-tag,
 .hljs-tag,
 .hljs-name {
-  color: var(--porsche);
+  color: var(--editor-text-6);
 }
 
 .hljs-attr,
 .hljs-attribute,
 .hljs-selector-id {
-  color: var(--light-turquoise);
+  color: var(--body-text);
 }
 
 .hljs-string,
 .hljs-selector-attr,
 .hljs-selector-pseudo,
 .hljs-addition {
-  color: var(--dark-turquoise);
+  color: var(--editor-text-4);
 }
 
 .hljs-subst {
-  color: var(--turquoise);
+  color: var(--editor-text-2);
 }
 
 .hljs-regexp,
 .hljs-link {
-  color: var(--medium-dark-porsche);
+  color: var(--editor-text-7);
 }
 
 .hljs-title,
 .hljs-section,
 .hljs-type,
 .hljs-doctag {
-  color: var(--light-turquoise);
-}
-
-.hljs-built_in {
-  color: var(--medium-dark-turquoise);
+  color: var(--editor-text-1);
 }
 
 .hljs-symbol,
 .hljs-bullet,
 .hljs-variable,
 .hljs-template-variable,
 .hljs-literal {
-  color: var(--light-pink);
+  color: var(--editor-text-9);
 }
 
 .hljs-params {
-  color: var(--light-porsche);
+  color: var(--editor-text-5);
 }
 
 .hljs-number,
 .hljs-deletion {
-  color: var(--pink);
+  color: var(--editor-text-10);
 }
 
 .hljs-emphasis {