bb-workflow

.env.example

@@ -1,5 +1,4 @@
-export EOA="YOUR_EOA_ADDRESS"
+export ETH_FROM="YOUR_DEPLOYER_ADDRESS"
 export FOUNDRY_PROFILE="lite"
 export MNEMONIC="YOUR_MNEMONIC"
 export MAINNET_RPC_URL="YOUR_MAINNET_RPC_URL"
-

.github/workflows/bb-ci-utils.yml

@@ -0,0 +1,26 @@
+name: "BB-CI: Build and Test"
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+  workflow_dispatch:
+
+jobs:
+  lint:
+    name: Forge Lint
+    uses: sablier-labs/gha-utils/.github/workflows/evm-lint.yml@main
+    secrets: inherit
+
+  build:
+    name: Forge Build
+    uses: sablier-labs/gha-utils/.github/workflows/forge-build.yml@main
+    secrets: inherit
+
+  test-utils:
+    needs: ["lint", "build"]
+    uses: "sablier-labs/gha-utils/.github/workflows/bb-forge-test.yml@main"
+    with:
+      foundry-profile: "test-optimized"
+      match-path: "tests/utils/**/*.sol"
+      name: "Utils tests"

.github/workflows/ci-deep.yml

@@ -9,54 +9,54 @@ on:
   workflow_dispatch:
     inputs:
       unitFuzzRuns:
-        default: '50000'
+        default: "50000"
         description: "Unit: number of fuzz runs."
         required: false
       integrationFuzzRuns:
-        default: '50000'
+        default: "50000"
         description: "Integration: number of fuzz runs."
         required: false
       invariantRuns:
-        default: '100'
+        default: "100"
         description: "Invariant runs: number of sequences of function calls generated and run."
         required: false
       invariantDepth:
-        default: '100'
+        default: "100"
         description: "Invariant depth: number of function calls made in a given run."
         required: false
       forkFuzzRuns:
-        default: '1000'
+        default: "1000"
         description: "Fork: number of fuzz runs."
         required: false
 
 jobs:
-  lint:
-    uses: "sablier-labs/reusable-workflows/.github/workflows/forge-lint.yml@main"
+  check:
+    uses: "sablier-labs/gha-utils/.github/workflows/full-check.yml@main"
 
   build:
-    uses: "sablier-labs/reusable-workflows/.github/workflows/forge-build.yml@main"
+    uses: "sablier-labs/gha-utils/.github/workflows/forge-build.yml@main"
 
   test-unit:
-    needs: ["lint", "build"]
-    uses: "sablier-labs/reusable-workflows/.github/workflows/forge-test.yml@main"
+    needs: ["check", "build"]
+    uses: "sablier-labs/gha-utils/.github/workflows/forge-test.yml@main"
     with:
       foundry-fuzz-runs: ${{ fromJSON(inputs.unitFuzzRuns || '50000') }}
       foundry-profile: "test-optimized"
       match-path: "tests/unit/**/*.sol"
       name: "Unit tests"
 
   test-integration:
-    needs: ["lint", "build"]
-    uses: "sablier-labs/reusable-workflows/.github/workflows/forge-test.yml@main"
+    needs: ["check", "build"]
+    uses: "sablier-labs/gha-utils/.github/workflows/forge-test.yml@main"
     with:
       foundry-fuzz-runs: ${{ fromJSON(inputs.integrationFuzzRuns || '50000') }}
       foundry-profile: "test-optimized"
       match-path: "tests/integration/**/*.sol"
       name: "Integration tests"
 
   test-invariant:
-    needs: ["lint", "build"]
-    uses: "sablier-labs/reusable-workflows/.github/workflows/forge-test.yml@main"
+    needs: ["check", "build"]
+    uses: "sablier-labs/gha-utils/.github/workflows/forge-test.yml@main"
     with:
       foundry-invariant-depth: ${{ fromJSON(inputs.invariantDepth || '100') }}
       foundry-invariant-runs: ${{ fromJSON(inputs.invariantRuns || '100') }}
@@ -65,10 +65,10 @@ jobs:
       name: "Invariant tests"
 
   test-fork:
-    needs: ["lint", "build"]
+    needs: ["check", "build"]
     secrets:
       MAINNET_RPC_URL: ${{ secrets.MAINNET_RPC_URL }}
-    uses: "sablier-labs/reusable-workflows/.github/workflows/forge-test.yml@main"
+    uses: "sablier-labs/gha-utils/.github/workflows/forge-test.yml@main"
     with:
       foundry-fuzz-runs: ${{ fromJSON(inputs.forkFuzzRuns || '1000') }}
       foundry-profile: "test-optimized"
@@ -77,7 +77,7 @@ jobs:
 
   notify-on-failure:
     if: failure()
-    needs: ["lint", "build", "test-unit", "test-integration", "test-invariant", "test-fork"]
+    needs: ["check", "build", "test-unit", "test-integration", "test-invariant", "test-fork"]
     runs-on: "ubuntu-latest"
     steps:
       - name: "Send Slack notification"

.github/workflows/ci-fork.yml

@@ -5,35 +5,35 @@ on:
     - cron: "0 3 * * 1,3,5" # at 3:00 AM UTC on Monday, Wednesday and Friday
 
 jobs:
-  lint:
-    uses: "sablier-labs/reusable-workflows/.github/workflows/forge-lint.yml@main"
+  check:
+    uses: "sablier-labs/gha-utils/.github/workflows/full-check.yml@main"
 
   build:
-    uses: "sablier-labs/reusable-workflows/.github/workflows/forge-build.yml@main"
+    uses: "sablier-labs/gha-utils/.github/workflows/forge-build.yml@main"
 
   test-fork:
-      needs: ["lint", "build"]
-      secrets:
-        MAINNET_RPC_URL: ${{ secrets.MAINNET_RPC_URL }}
-      uses: "sablier-labs/reusable-workflows/.github/workflows/forge-test.yml@main"
-      with:
-        foundry-fuzz-runs: 100
-        foundry-profile: "test-optimized"
-        fuzz-seed: true
-        match-path: "tests/fork/**/*.sol"
-        name: "Fork tests"
+    needs: ["check", "build"]
+    secrets:
+      MAINNET_RPC_URL: ${{ secrets.MAINNET_RPC_URL }}
+    uses: "sablier-labs/gha-utils/.github/workflows/forge-test.yml@main"
+    with:
+      foundry-fuzz-runs: 100
+      foundry-profile: "test-optimized"
+      fuzz-seed: true
+      match-path: "tests/fork/**/*.sol"
+      name: "Fork tests"
 
   test-utils:
-    needs: ["lint", "build"]
-    uses: "sablier-labs/reusable-workflows/.github/workflows/forge-test.yml@main"
+    needs: ["check", "build"]
+    uses: "sablier-labs/gha-utils/.github/workflows/forge-test.yml@main"
     with:
       foundry-profile: "test-optimized"
       match-path: "tests/utils/**/*.sol"
       name: "Utils tests"
 
   notify-on-failure:
     if: failure()
-    needs: ["lint", "build", "test-fork", "test-utils"]
+    needs: ["check", "build", "test-fork", "test-utils"]
     runs-on: "ubuntu-latest"
     steps:
       - name: "Send Slack notification"

.github/workflows/multibuild.yml → .github/workflows/ci-multibuild.yml

@@ -13,7 +13,9 @@ jobs:
         uses: "actions/checkout@v4"
 
       - name: "Install Bun"
-        uses: "oven-sh/setup-bun@v1"
+        uses: "oven-sh/setup-bun@v2"
+        with:
+          bun-version: "latest"
 
       - name: "Install the Node.js dependencies"
         run: "bun install --frozen-lockfile"
@@ -22,5 +24,5 @@ jobs:
         uses: "PaulRBerg/foundry-multibuild@v1"
         with:
           min: "0.8.22"
-          max: "0.8.26"
+          max: "0.8.29"
           skip-test: "true"

.github/workflows/ci-slither.yml

@@ -5,8 +5,9 @@ on:
     - cron: "0 3 * * 0" # at 3:00am UTC every Sunday
 
 jobs:
-  lint:
-    uses: "sablier-labs/reusable-workflows/.github/workflows/forge-lint.yml@main"
+  check:
+    uses: "sablier-labs/gha-utils/.github/workflows/full-check.yml@main"
 
   slither-analyze:
-    uses: "sablier-labs/reusable-workflows/.github/workflows/slither-analyze.yml@main"
+    needs: "check"
+    uses: "sablier-labs/gha-utils/.github/workflows/slither-analyze.yml@main"

.github/workflows/ci.yml

@@ -14,61 +14,67 @@ on:
       - "staging-blast"
 
 jobs:
-  lint:
-    uses: "sablier-labs/reusable-workflows/.github/workflows/forge-lint.yml@main"
+  check:
+    uses: "sablier-labs/gha-utils/.github/workflows/full-check.yml@main"
 
-  bulloak:
-    needs: ["lint"]
-    uses: "sablier-labs/reusable-workflows/.github/workflows/bulloak-check.yml@main"
+  build:
+    uses: "sablier-labs/gha-utils/.github/workflows/forge-build.yml@main"
+
+  test-bulloak:
+    needs: ["check", "build"]
+    if: needs.build.outputs.cache-status != 'primary'
+    uses: "sablier-labs/gha-utils/.github/workflows/bulloak-check.yml@main"
     with:
       skip-modifiers: true
       tree-path: "tests"
 
-  build:
-    uses: "sablier-labs/reusable-workflows/.github/workflows/forge-build.yml@main"
-
   test-unit:
-    needs: ["lint", "build"]
-    uses: "sablier-labs/reusable-workflows/.github/workflows/forge-test.yml@main"
+    needs: ["check", "build"]
+    if: needs.build.outputs.cache-status != 'primary'
+    uses: "sablier-labs/gha-utils/.github/workflows/forge-test.yml@main"
     with:
       foundry-fuzz-runs: 2000
       foundry-profile: "test-optimized"
       match-path: "tests/unit/**/*.sol"
       name: "Unit tests"
 
   test-integration:
-    needs: ["lint", "build"]
-    uses: "sablier-labs/reusable-workflows/.github/workflows/forge-test.yml@main"
+    needs: ["check", "build"]
+    if: needs.build.outputs.cache-status != 'primary'
+    uses: "sablier-labs/gha-utils/.github/workflows/forge-test.yml@main"
     with:
       foundry-fuzz-runs: 2000
       foundry-profile: "test-optimized"
       match-path: "tests/integration/**/*.sol"
       name: "Integration tests"
 
   test-invariant:
-    needs: ["lint", "build"]
-    uses: "sablier-labs/reusable-workflows/.github/workflows/forge-test.yml@main"
+    needs: ["check", "build"]
+    if: needs.build.outputs.cache-status != 'primary'
+    uses: "sablier-labs/gha-utils/.github/workflows/forge-test.yml@main"
     with:
       foundry-profile: "test-optimized"
       match-path: "tests/invariant/**/*.sol"
       name: "Invariant tests"
 
   test-fork:
-    needs: ["lint", "build"]
+    needs: ["check", "build"]
+    if: needs.build.outputs.cache-status != 'primary'
     secrets:
       MAINNET_RPC_URL: ${{ secrets.MAINNET_RPC_URL }}
-    uses: "sablier-labs/reusable-workflows/.github/workflows/forge-test.yml@main"
+    uses: "sablier-labs/gha-utils/.github/workflows/forge-test.yml@main"
     with:
       foundry-fuzz-runs: 20
       foundry-profile: "test-optimized"
       match-path: "tests/fork/**/*.sol"
       name: "Fork tests"
 
   coverage:
-    needs: ["lint", "build"]
+    needs: ["check", "build"]
+    if: needs.build.outputs.cache-status != 'primary'
     secrets:
       CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
       MAINNET_RPC_URL: ${{ secrets.MAINNET_RPC_URL }}
-    uses: "sablier-labs/reusable-workflows/.github/workflows/forge-coverage.yml@main"
+    uses: "sablier-labs/gha-utils/.github/workflows/forge-coverage.yml@main"
     with:
       match-path: "tests/{fork,integration,unit}/**/*.sol"

.github/workflows/cron-stale.yml

@@ -0,0 +1,10 @@
+name: "Cron: Close Stale Issues and PRs"
+
+on:
+  workflow_dispatch:
+  schedule:
+    - cron: "0 3 * * 0" # at 3:00am UTC every Sunday
+
+jobs:
+  cron-stale:
+    uses: "sablier-labs/gha-utils/.github/workflows/cron-stale.yml@main"

.github/workflows/generate-svg.yml

@@ -28,7 +28,7 @@ jobs:
 
       - name: "Generate an NFT SVG using the user-provided parameters"
         run: >-
-          forge script script/GenerateSVG.s.sol
+          forge script scripts/solidity/GenerateSVG.s.sol
           --sig "run(uint256,string,string,uint256)"
           "${{ fromJSON(inputs.progress || true) }}",
           "${{ fromJSON(inputs.status || true) }}"

.gitignore

@@ -1,17 +1,16 @@
 # directories
 artifacts
-artifacts-zk
+artifacts-*
 broadcast
 cache
 cache_hardhat-zk
 coverage
 deployments
-deployments-zk
+deployments-*
 docs
 node_modules
 out
-out-optimized
-out-svg
+out-*
 typechain-types
 
 # files
@@ -20,6 +19,7 @@ typechain-types
 *.log
 .DS_Store
 .pnp.*
+bun.lockb
 deployments.md
 lcov.info
 package-lock.json

.lintstagedrc.js

@@ -0,0 +1,10 @@
+/**
+ * @type {import("lint-staged").Configuration}
+ */
+module.exports = {
+  "*.{json,md,svg,yml}": "bun prettier --cache --write",
+  "*.sol": [
+    "bun solhint --fix --noPrompt",
+    "forge fmt",
+  ],
+};

.prettierignore

@@ -1,22 +1,15 @@
 # directories
-.github/workflows
 broadcast
 cache
+cache_hardhat-zk
 coverage
 docs
 node_modules
 out
-out-optimized
-out-svg
+out-*
 
 # files
-*.env
-*.log
 *.sol
-.DS_Store
 .pnp.*
-bun.lockb
-lcov.info
 package-lock.json
 pnpm-lock.yaml
-yarn.lock