Foundry Migration (#10)

* refactor: basic of foundry repository based on transmuter * fix: the boilerplate now compile with latest version of oz * chore: update package.json scripts to fit the boilerplate * chore: update .env.example to foundry * chore: update slither to build in ga * chore: add .gitkeep in external folder * refactor: split unit and fuzz tests * chore: set default shell to bash in ci * chore: compile before running slither in ga * chore: clean before build in ci * chore: try to put explicit compilation in slither ci * chore: try to remove id in slither ci * chore: revert back id change * chore: update slither config * chore: add needs on for slither job * chore: add a bash script to fork * chore: add Optimism uri in fork script
AngleProtocol · Nov 3, 2023 · a77fe58 · a77fe58
1 parent 1031fe7
commit a77fe58
Show file tree

Hide file tree

Showing 48 changed files with 1,012 additions and 15,617 deletions.
diff --git a/.env.example b/.env.example
@@ -1,5 +1,5 @@
 ## Add URI and BIP39 mnemonic, and etherscan API key for every network that you plan to use
-## These are used in `hardhat.config.ts` (see `nodeUrl` and `accounts` calls in network definitions)
+## These are used in `foundry.toml` (see `nodeUrl` and `accounts` calls in network definitions)
 
 #ETH_NODE_URI_MAINNET=""
 #MNEMONIC_MAINNET=""

diff --git a/.eslintrc.js b/.eslintrc.js
diff --git a/logo.svg → .github/assets/logo.svg b/logo.svg → .github/assets/logo.svg
diff --git a/.github/workflows/ci-deep.yml b/.github/workflows/ci-deep.yml
@@ -0,0 +1,164 @@
+name: "CI Deep"
+
+env:
+  FOUNDRY_PROFILE: "ci"
+
+on:
+  schedule:
+    - cron: "0 3 * * 0" # at 3:00am UTC every Sunday
+  workflow_dispatch:
+    inputs:
+      fuzzRuns:
+        default: "100000"
+        description: "Unit: number of fuzz runs."
+        required: false
+      invariantRuns:
+        default: "300"
+        description: "Unit: number of invariant runs."
+        required: false
+      invariantDepth:
+        default: "50"
+        description: "Unit: invariant depth."
+        required: false
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+
+      - uses: actions/setup-node@v3
+        with:
+          node-version: 18
+          cache: "yarn"
+
+      - name: Install dependencies
+        run: yarn install
+
+      - name: Run solhint
+        run: yarn lint:check
+
+      - name: "Add lint summary"
+        run: |
+          echo "## Lint result" >> $GITHUB_STEP_SUMMARY
+          echo "✅ Passed" >> $GITHUB_STEP_SUMMARY
+
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          submodules: "recursive"
+
+      - name: Install Foundry
+        uses: foundry-rs/foundry-toolchain@v1
+        with:
+          version: nightly
+
+      - name: Compile foundry
+        run: yarn compile --sizes
+
+      - name: "Cache the build so that it can be re-used by the other jobs"
+        uses: "actions/cache/save@v3"
+        with:
+          key: "build-${{ github.sha }}"
+          path: |
+            cache-forge
+            out
+
+      - name: "Add build summary"
+        run: |
+          echo "## Build result" >> $GITHUB_STEP_SUMMARY
+          echo "✅ Passed" >> $GITHUB_STEP_SUMMARY
+
+  test-unit:
+    needs: ["build", "lint"]
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          submodules: "recursive"
+
+      - uses: actions/cache/restore@v3
+        with:
+          fail-on-cache-miss: true
+          path: |
+            cache-forge
+            out
+          key: "build-${{ github.sha }}"
+
+      - name: Install Foundry
+        uses: foundry-rs/foundry-toolchain@v1
+        with:
+          version: nightly
+
+      - name: Run Foundry tests
+        run: yarn test:unit
+
+      - name: "Add Unit Test Summary"
+        run: |
+          echo "## Unit test result" >> $GITHUB_STEP_SUMMARY
+          echo "✅ Passed" >> $GITHUB_STEP_SUMMARY
+
+  test-invariant:
+    needs: ["build", "lint"]
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          submodules: "recursive"
+
+      - uses: actions/cache/restore@v3
+        with:
+          fail-on-cache-miss: true
+          path: |
+            cache-forge
+            out
+          key: "build-${{ github.sha }}"
+
+      - name: Install Foundry
+        uses: foundry-rs/foundry-toolchain@v1
+        with:
+          version: nightly
+
+      - name: Run Foundry tests
+        run: yarn test:invariant
+        env:
+          FOUNDRY_INVARIANT_RUNS: ${{ github.event.inputs.invariantRuns }}
+          FOUNDRY_INVARIANT_DEPTH: ${{ github.event.inputs.invariantDepth }}
+
+      - name: "Add Invariant Test Summary"
+        run: |
+          echo "## Invariant test result" >> $GITHUB_STEP_SUMMARY
+          echo "✅ Passed" >> $GITHUB_STEP_SUMMARY
+
+  test-fuzz:
+    needs: ["build", "lint"]
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          submodules: "recursive"
+
+      - uses: actions/cache/restore@v3
+        with:
+          fail-on-cache-miss: true
+          path: |
+            cache-forge
+            out
+          key: "build-${{ github.sha }}"
+
+      - name: Install Foundry
+        uses: foundry-rs/foundry-toolchain@v1
+        with:
+          version: nightly
+
+      - name: Run Foundry tests
+        run: yarn test:fuzz
+        env:
+          FOUNDRY_FUZZ_RUNS: ${{ github.event.inputs.fuzzRuns }}
+
+      - name: "Add Fuzz Test Summary"
+        run: |
+          echo "## Fuzz test result" >> $GITHUB_STEP_SUMMARY
+          echo "✅ Passed" >> $GITHUB_STEP_SUMMARY