chore: point community link at our discord channel (#874)

.gitattributes

@@ -2,3 +2,5 @@ docs/assets/launch.json linguist-language=JSON5
 tsconfig-base.json linguist-language=JSON5
 .nycrc linguist-language=JSON
 .prettierrc linguist-language=JSON
+packages/ganache/api-extractor.json linguist-language=JSON5
+packages/ganache/tsdoc.json linguist-language=JSON5

.github/CODEOWNERS

@@ -0,0 +1,3 @@
+# global code owner:
+
+*       @davidmurdoch

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

@@ -0,0 +1,73 @@
+name: "Docker Publish"
+description: "Builds and publishes a Docker image for the Ganache repo."
+inputs:
+  VERSION:
+    description: "The release version to be tagged to the Docker image, e.g., 4.0.1"
+    required: true
+  TAG:
+    description: "The tag to be tagged to the Docker image, e.g., latest."
+    required: true
+  DOCKER_USERNAME:
+    description: "Username to log in to Docker hub."
+    required: true
+  DOCKER_ACCESS_TOKEN:
+    description: "Access token to log in to Docker hub."
+    required: true
+  GITHUB_TOKEN:
+    description: "Github token used to log in to the container registry."
+    required: true
+  INFURA_KEY:
+    description: "Infura key used to build Ganache within the Docker image."
+    required: true
+runs:
+  # "composite" means we are using yml (rather than js or docker) for our action
+  # https://docs.github.com/en/actions/creating-actions/creating-a-composite-action
+  using: "composite"
+  steps:
+    - name: Use node 16
+      uses: actions/setup-node@v3
+      with:
+        node-version: 16
+
+    - name: Run installation
+      run: npm ci
+      shell: bash
+
+    - name: Log in to Docker Hub
+      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@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@314ddf6d4a82333bf1bc7630399df41bf68eba09
+      with:
+        images: |
+          trufflesuite/ganache
+          ghcr.io/${{ github.repository}}
+
+    - name: Set up QEMU
+      uses: docker/setup-qemu-action@38836d31bd1e0f8f29b8c7ad0412da32020f15b3
+
+    - name: Set up Docker Buildx
+      uses: docker/setup-buildx-action@39a1a82492fd1ad19af19d61b5f748e4cb6cd1af
+
+    - name: Build and push Docker image
+      uses: docker/build-push-action@175d02bffea74695e96b351069ac938b338802f9
+      with:
+        context: .
+        file: ./packages/ganache/Dockerfile
+        push: true
+        tags: ${{ format('trufflesuite/ganache:{0}, trufflesuite/ganache:v{1}', inputs.TAG, inputs.VERSION) }}
+        labels: ${{ steps.meta.outputs.labels }}
+        platforms: linux/arm64/v8,linux/amd64
+        build-args: |
+          INFURA_KEY=${{ inputs.INFURA_KEY }}

.github/semantic.yml

@@ -0,0 +1,5 @@
+# validates that the PR title has a semantic commit message; ignores commits
+titleOnly: true
+# custom URL for the "Details" link (which appears next to the success/failure
+# message from the app) to be specified
+targetUrl: "https://github.com/trufflesuite/ganache/blob/develop/CONTRIBUTING.md#pull-requests"

.github/workflows/cancel-pr.yml

@@ -10,7 +10,7 @@ jobs:
     runs-on: ubuntu-20.04
     timeout-minutes: 3
     steps:
-      - uses: styfle/cancel-workflow-action@0.7.0
+      - uses: styfle/cancel-workflow-action@0.11.0
         with:
           workflow_id: 5127767
           access_token: ${{ github.token }}

.github/workflows/pr.yml

@@ -10,44 +10,63 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        node: [10.7.0, 10.x, 11.x, 12.x, 13.x, 14.x]
-        os: [windows-2019, ubuntu-16.04, ubuntu-18.04, ubuntu-20.04, macos-11.0]
+        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 }}
 
     steps:
       - name: Cancel Previous Runs
-        uses: styfle/cancel-workflow-action@0.7.0
+        uses: styfle/cancel-workflow-action@0.11.0
         with:
           access_token: ${{ github.token }}
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+
       - name: Use Node.js ${{ matrix.node }}
-        uses: actions/setup-node@v1
+        uses: actions/setup-node@v3
         with:
           node-version: ${{ matrix.node }}
-      # we need build tools for the `bigint-buffer` module
+
       - name: Add msbuild to PATH
+        # we need msbuild tools for the `bcrypto` module
         if: startsWith(matrix.os, 'windows-')
-        uses: microsoft/setup-msbuild@v1.0.2
-      - name: Update npm for node 10.7.0
-        # lerna bootstrap was failing on node 10.7.0 with npm 6.1.0, updating
-        # to npm 6.4.1 seems to fix the problem
-        if: ${{ startsWith(matrix.os, 'windows-') && matrix.node == '10.7.0' }}
-        run: npm install npm@6.4.1 --global
-      - name: install node tools
-        if: startsWith(matrix.os, 'windows-')
-        # windows-build-tools@5.2.2 failed to install, so we use 4.0.0
-        run: npm install --global --production windows-build-tools@4.0.0
-      - name: install node-gyp
-        if: startsWith(matrix.os, 'windows-')
-        run: npm install --global node-gyp@latest
-      - 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 2015
-        if: startsWith(matrix.os, 'windows-')
-        run: npm config set msvs_version 2015
+        uses: microsoft/setup-msbuild@v1.1
+
       - run: npm ci
+      - run: npm run tsc
       - run: npm test
         env:
           FORCE_COLOR: 1
+          INFURA_KEY: ${{ secrets.TEST_INFURA_KEY }}
+
+      - 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, '20.') && matrix.node != '20.0.0'
+        # 1. build ganache
+        # 2. pack it into a tarball
+        # 3. measure the _unpacked_ tarball's size
+        # 4. test to make sure the tarball is less than 99MB because jsDelivr
+        #    CDN doesn't allow bundles greater than 100MB.
+        # 5. exit with non-zero exit code if the test fails.
+        run: |
+          npm run build &&
+          npm run prepublishOnly &&
+          cd ./packages/ganache &&
+          npm pack &&
+          size="$(zcat ganache-*.tgz | wc -c)" &&
+          echo "Bundle size: $size" &&
+          echo "Bundle size is $([[ "$size" -lt 99000000 ]] && echo "ok" || echo "not ok")" &&
+          test "$size" -lt 99000000
+        env:
+          # 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, '20.') && matrix.node != '20.0.0'
+        uses: actions/upload-artifact@v3
+        with:
+          name: Candidate
+          path: ./packages/ganache/ganache-*.tgz

.github/workflows/push.yml

@@ -10,62 +10,54 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        node: [10.7.0, 10.x, 11.x, 12.x, 13.x, 14.x]
-        os: [ubuntu-20.04]
+        node: [16.0.0, 16.x, 18.x, 20.x]
+        os: [ubuntu-22.04]
 
     runs-on: ${{ matrix.os }}
 
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
       - name: Use Node.js ${{ matrix.node }}
-        uses: actions/setup-node@v1
+        uses: actions/setup-node@v3
         with:
           node-version: ${{ matrix.node }}
       - run: npm ci
+      - run: npm run tsc
       - run: npm test
         env:
           FORCE_COLOR: 1
+          INFURA_KEY: ${{ secrets.TEST_INFURA_KEY }}
 
   build-all:
     strategy:
       fail-fast: false
       matrix:
-        node: [10.7.0, 10.x, 11.x, 12.x, 13.x, 14.x]
-        os: [windows-2019, ubuntu-16.04, ubuntu-18.04]
+        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 }}
 
     if: github.ref == 'refs/heads/develop'
 
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
       - name: Use Node.js ${{ matrix.node }}
-        uses: actions/setup-node@v1
+        uses: actions/setup-node@v3
         with:
           node-version: ${{ matrix.node }}
-      # we need build tools for the `bigint-buffer` module
+
       - name: Add msbuild to PATH
+        # we need msbuild tools for the `bigint-buffer` module
         if: startsWith(matrix.os, 'windows-')
-        uses: microsoft/setup-msbuild@v1.0.2
-      - name: Update npm for node 10.7.0
-        # lerna bootstrap was failing on node 10.7.0 with npm 6.1.0, updating
-        # to npm 6.4.1 seems to fix the problem
-        if: ${{ startsWith(matrix.os, 'windows-') && matrix.node == '10.7.0' }}
-        run: npm install npm@6.4.1 --global
-      - name: install node tools
-        if: startsWith(matrix.os, 'windows-')
-        # windows-build-tools@5.2.2 failed to install, so we use 4.0.0
-        run: npm install --global --production windows-build-tools@4.0.0
-      - name: install node-gyp
-        if: startsWith(matrix.os, 'windows-')
-        run: npm install --global node-gyp@latest
-      - 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 2015
-        if: startsWith(matrix.os, 'windows-')
-        run: npm config set msvs_version 2015
+        uses: microsoft/setup-msbuild@v1.1
+
       - run: npm ci
+      - run: npm run tsc
       - run: npm test
         env:
           FORCE_COLOR: 1
+          INFURA_KEY: ${{ secrets.TEST_INFURA_KEY }}