release: v4.0.0

.editorconfig

@@ -15,6 +15,3 @@ end_of_line = lf
 charset = utf-8
 trim_trailing_whitespace = true
 insert_final_newline = true
-
-[*.md]
-trim_trailing_whitespace = false

.env.sample

@@ -0,0 +1,14 @@
+export API_KEY_INFURA=
+
+export API_KEY_ETHERSCAN=
+export API_KEY_POLYGONSCAN=
+export API_KEY_ARBISCAN=
+export API_KEY_OPTIMISTIC_ETHERSCAN=
+
+export FOUNDRY_PROFILE="default"
+
+export DEPLOYER_ADDRESS=
+
+# Salts are 11 bytes
+export SALT_DOCUMENT_STORE=
+export SALT_TRANSFERABLE_DOCUMENT_STORE=

.github/pull_request_template.md

@@ -1,12 +1,12 @@
 ## Summary
+
 What is the background of this pull request?
 
 ## Changes
-* What are the changes made in this pull request?
-* Change this and that, etc...
+
+- What are the changes made in this pull request?
+- Change this and that, etc...
 
 ## Issues
-What are the related issues or stories?
 
-## Releases
-Channels: latest
+What are the related issues or stories?

.github/workflows/linters.yml

@@ -1,9 +1,6 @@
 on:
   workflow_call:
 
-env:
-  NODE_ENV: ci
-
 name: "Linters"
 
 jobs:
@@ -14,15 +11,13 @@ jobs:
       - uses: actions/checkout@v3
       - uses: actions/setup-node@v3
         with:
-          node-version: 18.x
-      - run: npm ci --ignore-scripts
+          node-version: 20.x
+      - run: npm ci --no-fund --no-audit --ignore-scripts
       - run: npm run lint
 
   commit-lint:
     name: Commit Lint
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v3
-      - name: Install Commit Lint Dependencies
-        run: npm install @commitlint/config-conventional
-      - uses: JulienKode/[email protected]
+      - uses: wagoid/commitlint-github-action@v5

.github/workflows/publish.yml

@@ -0,0 +1,114 @@
+on:
+  workflow_call:
+
+name: "Publish"
+
+jobs:
+  prepare-build:
+    name: Prepare Build
+    runs-on: ubuntu-latest
+    outputs:
+      matrix: ${{ steps.check-targets.outputs.MATRIX }}
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-node@v3
+        with:
+          node-version: 20.x
+
+      - name: Install Dependencies
+        run: npm ci --no-fund --no-audit --ignore-scripts
+
+      - name: Compile contracts
+        run: npm run build:hh
+
+      - name: Upload contract artefacts
+        uses: actions/upload-artifact@v4
+        with:
+          name: contract-artefacts
+          path: |
+            artifacts/src
+
+      - name: Check targets
+        id: check-targets
+        run: |
+          echo "Checking targets..."
+          TARGETS_JSON=$(echo "${{ vars.TYPE_TARGETS }}" | jq -c --raw-input 'split(",")')
+          echo "MATRIX=$TARGETS_JSON" >> $GITHUB_OUTPUT
+          echo "Generated matrix: $TARGETS_JSON"
+
+  build-targets:
+    name: Build Targets
+    needs: prepare-build
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        targets: ${{fromJson(needs.prepare-build.outputs.matrix)}}
+    env:
+      MATRIX_TARGET: ${{ matrix.targets }}
+    steps:
+      - name: Print the matrix output from prepare-matrix
+        run: |
+          echo "Matrix JSON: $MATRIX_JSON"
+        env:
+          MATRIX_JSON: ${{ needs.prepare-build.outputs.matrix }}
+      - uses: actions/checkout@v3
+      - uses: actions/setup-node@v3
+        with:
+          node-version: 20.x
+
+      - name: Download artefacts
+        uses: actions/download-artifact@v4
+        with:
+          name: contract-artefacts
+          path: artifacts/src
+
+      - name: Check contract artefacts
+        run: |
+          if [ ! -d "artifacts/src" ]; then
+            echo "Contract artefacts not found." && exit 1
+          fi
+
+      - name: Build types for ${{ env.MATRIX_TARGET }}
+        run: |
+          echo "Generating types for ${{ env.MATRIX_TARGET }}"
+          ./bin/build.sh typechain ${{ env.MATRIX_TARGET }}
+
+      - name: Upload type targets
+        uses: actions/upload-artifact@v4
+        with:
+          name: types-${{ env.MATRIX_TARGET }}
+          path: |
+            .build/types-${{ env.MATRIX_TARGET }}
+            !.build/types-${{ env.MATRIX_TARGET }}/node_modules
+
+  publish:
+    name: Publish to NPM
+    needs: build-targets
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+      issues: write
+      pull-requests: write
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-node@v3
+        with:
+          node-version: 20.x
+          registry-url: "https://registry.npmjs.org/"
+
+      - name: Install Dependencies
+        run: npm ci --no-fund --no-audit --ignore-scripts
+
+      - name: Download type targets
+        uses: actions/download-artifact@v4
+        with:
+          path: .build
+          pattern: types-*
+
+      - name: Publish to NPM
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
+        run: |
+          echo "Publishing packages to NPM"
+          npm run semantic-release

.github/workflows/pull_requests.yml

@@ -1,9 +1,9 @@
 on:
   pull_request:
-    types: [ opened, reopened, synchronize ]
+    types: [opened, reopened, synchronize]
 
 env:
-  NODE_ENV: ci
+  RELEASE_DRY_RUN: 1
 
 name: "Pull Requests"
 
@@ -16,14 +16,6 @@ jobs:
     name: Linters
     uses: ./.github/workflows/linters.yml
 
-  eslint-review:
-    name: ESLint Review
-    runs-on: ubuntu-latest
-    permissions:
-      contents: read
-      pull-requests: write
-    steps:
-      - uses: actions/checkout@v3
-      - uses: reviewdog/action-eslint@v1
-        with:
-          github_token: ${{ secrets.GITHUB_TOKEN }}
+  release-check:
+    name: Release Check
+    uses: ./.github/workflows/publish.yml

.github/workflows/release.yml

@@ -5,9 +5,6 @@ on:
       - beta
       - +([0-9])?(.{+([0-9]),x}).x
 
-env:
-  NODE_ENV: ci
-
 name: Release
 
 jobs:
@@ -21,21 +18,10 @@ jobs:
 
   release:
     name: Publish Release
-    runs-on: ubuntu-latest
     needs: [tests, linters]
-    steps:
-      - uses: actions/checkout@v3
-      - uses: actions/setup-node@v3
-        with:
-          node-version: 18.x
-      - run: npm ci
-      - run: npm run build
-      - uses: codfish/semantic-release-action@v2
-        id: semantic
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-          NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
-      - name: Output new release version
-        if: steps.semantic.outputs.new-release-published == 'true'
-        run: |
-          echo "🎉New Release Published: ${{ steps.semantic.outputs.release-version }}"
+    uses: ./.github/workflows/publish.yml
+    secrets: inherit
+    permissions:
+      contents: write
+      issues: write
+      pull-requests: write

.github/workflows/tests.yml

@@ -1,22 +1,27 @@
 on:
   workflow_call:
 
-env:
-  NODE_ENV: ci
-
 name: "Tests"
 
 jobs:
   run-tests:
     name: Run Tests
     runs-on: ubuntu-latest
+    env:
+      FOUNDRY_PROFILE: ci
     steps:
       - uses: actions/checkout@v3
       - uses: actions/setup-node@v3
         with:
-          node-version: 18.x
-      - run: npm ci
-      - run: npm run test
+          node-version: 20.x
+      - uses: foundry-rs/foundry-toolchain@v1
+      - run: sudo apt-get install -y lcov
+      - run: npm ci --no-fund --no-audit
+      - run: npm run test:coverage
+      - uses: actions/upload-artifact@v3
+        with:
+          name: test-coverage
+          path: ./coverage/lcov.info
 
   test-build:
     name: Test Build
@@ -25,6 +30,22 @@ jobs:
       - uses: actions/checkout@v3
       - uses: actions/setup-node@v3
         with:
-          node-version: 18.x
-      - run: npm ci --ignore-scripts
+          node-version: 20.x
+      - uses: foundry-rs/foundry-toolchain@v1
+      - run: npm ci --no-fund --no-audit --ignore-scripts
       - run: npm run build
+
+  coverage:
+    name: Test Coverage
+    needs: [run-tests]
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - name: Download coverage
+        uses: actions/download-artifact@v3
+        with:
+          name: test-coverage
+      - uses: codecov/codecov-action@v3
+        with:
+          fail_ci_if_error: true
+          verbose: true