ci-deep.yml

name: "CI Deep"

env:
  FOUNDRY_PROFILE: "ci"

on:
  schedule:
    - cron: "0 3 * * 0" # at 3:00am UTC every Sunday
  workflow_dispatch:
    inputs:
      fuzzRuns:
        default: "10000"
        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: Setup repo
        uses: ./.github/actions/setup-repo
        with:
          registry-token: ${{ secrets.GH_REGISTRY_ACCESS_TOKEN }}

      - 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

      - name: Setup repo
        uses: ./.github/actions/setup-repo
        with:
          registry-token: ${{ secrets.GH_REGISTRY_ACCESS_TOKEN }}

      - 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
            node_modules

      - 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
            node_modules
          key: "build-${{ github.sha }}"

      - name: Install Foundry
        uses: foundry-rs/foundry-toolchain@v1
        with:
          version: nightly

      - uses: actions/setup-python@v5
        with:
          python-version: '3.8'

      - name: Install vyper
        run: pip install vyper==0.2.16

      - name: Run Foundry tests
        run: yarn test:unit
        env:
          ETH_NODE_URI_POLYGON: ${{ secrets.ETH_NODE_URI_POLYGON }}
          ETH_NODE_URI_ARBITRUM: ${{ secrets.ETH_NODE_URI_ARBITRUM }}
          ETH_NODE_URI_OPTIMISM: ${{ secrets.ETH_NODE_URI_OPTIMISM }}
          ETH_NODE_URI_MAINNET: ${{ secrets.ETH_NODE_URI_MAINNET }}

      - 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
            node_modules
          key: "build-${{ github.sha }}"

      - name: Install Foundry
        uses: foundry-rs/foundry-toolchain@v1
        with:
          version: nightly

      - uses: actions/setup-python@v5
        with:
          python-version: '3.8'

      - name: Install vyper
        run: pip install vyper==0.2.16

      - name: Run Foundry tests
        run: yarn test:invariant
        env:
          FOUNDRY_INVARIANT_RUNS: ${{ inputs.invariantRuns || '300' }}
          FOUNDRY_INVARIANT_DEPTH: ${{ inputs.invariantDepth || '50' }}
          ETH_NODE_URI_POLYGON: ${{ secrets.ETH_NODE_URI_POLYGON }}
          ETH_NODE_URI_ARBITRUM: ${{ secrets.ETH_NODE_URI_ARBITRUM }}
          ETH_NODE_URI_OPTIMISM: ${{ secrets.ETH_NODE_URI_OPTIMISM }}
          ETH_NODE_URI_MAINNET: ${{ secrets.ETH_NODE_URI_MAINNET }}

      - 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
            node_modules
          key: "build-${{ github.sha }}"

      - name: Install Foundry
        uses: foundry-rs/foundry-toolchain@v1
        with:
          version: nightly

      - uses: actions/setup-python@v5
        with:
          python-version: '3.8'

      - name: Install vyper
        run: pip install vyper==0.2.16

      - name: Run Foundry tests
        run: yarn test:fuzz
        env:
          FOUNDRY_FUZZ_RUNS: ${{ inputs.fuzzRuns || '10000' }}
          ETH_NODE_URI_POLYGON: ${{ secrets.ETH_NODE_URI_POLYGON }}
          ETH_NODE_URI_ARBITRUM: ${{ secrets.ETH_NODE_URI_ARBITRUM }}
          ETH_NODE_URI_OPTIMISM: ${{ secrets.ETH_NODE_URI_OPTIMISM }}
          ETH_NODE_URI_MAINNET: ${{ secrets.ETH_NODE_URI_MAINNET }}

      - name: "Add Fuzz Test Summary"
        run: |
          echo "## Fuzz test result" >> $GITHUB_STEP_SUMMARY
          echo "✅ Passed" >> $GITHUB_STEP_SUMMARY