build: update configuration files (#44)

* build: update configuration files * ci: use reusable workflows * build: add prepare-artifacts shell script * build: set optimizer runs to 10,000 in optimized profile build: increase the number of runs and the depth in invariant default profile chore: remove deployments from .gitignore --------- Co-authored-by: andreivladbrg <[email protected]>
sablier-labs · Apr 18, 2024 · 629a864 · 629a864
1 parent 9e2af6c
commit 629a864
Show file tree

Hide file tree

Showing 13 changed files with 160 additions and 174 deletions.
diff --git a/.gitattributes b/.gitattributes
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -4,10 +4,6 @@ concurrency:
   cancel-in-progress: true
   group: ${{github.workflow}}-${{github.ref}}
 
-env:
-  MAINNET_RPC_URL: ${{ secrets.MAINNET_RPC_URL }}
-  API_KEY_INFURA: ${{ secrets.API_KEY_INFURA }}
-
 on:
   workflow_dispatch:
   pull_request:
@@ -17,150 +13,32 @@ on:
 
 jobs:
   lint:
-    runs-on: "ubuntu-latest"
-    steps:
-      - name: "Check out the repo"
-        uses: "actions/checkout@v3"
-
-      - name: "Install Foundry"
-        uses: "foundry-rs/foundry-toolchain@v1"
-
-      - name: "Install Bun"
-        uses: "oven-sh/setup-bun@v1"
-
-      - name: "Install the Node.js dependencies"
-        run: "bun install"
-
-      - name: "Lint the code"
-        run: "bun run lint"
-
-      - name: "Add lint summary"
-        run: |
-          echo "## Lint result" >> $GITHUB_STEP_SUMMARY
-          echo "✅ Passed" >> $GITHUB_STEP_SUMMARY
+    uses: "sablier-labs/reusable-workflows/.github/workflows/forge-lint.yml@main"
 
   build:
-    runs-on: "ubuntu-latest"
-    steps:
-      - name: "Check out the repo"
-        uses: "actions/checkout@v3"
-
-      - name: "Install Foundry"
-        uses: "foundry-rs/foundry-toolchain@v1"
-
-      - name: "Install Bun"
-        uses: "oven-sh/setup-bun@v1"
-
-      - name: "Install the Node.js dependencies"
-        run: "bun install"
-
-      - name: "Show the Foundry config"
-        run: "forge config"
-
-      - name: "Build the contracts"
-        run: "forge build"
-
-      - name: "Cache the build and the node modules so that they can be re-used by the other jobs"
-        uses: "actions/cache/save@v3"
-        with:
-          key: "build-and-modules-${{ github.sha }}"
-          path: |
-            cache
-            node_modules
-            out
-
-      - name: "Add build summary"
-        run: |
-          echo "## Build result" >> $GITHUB_STEP_SUMMARY
-          echo "✅ Passed" >> $GITHUB_STEP_SUMMARY
+    uses: "sablier-labs/reusable-workflows/.github/workflows/forge-build.yml@main"
 
   test-integration:
     needs: ["lint", "build"]
-    env:
-      FOUNDRY_FUZZ_RUNS: "5000"
-    runs-on: "ubuntu-latest"
-    steps:
-      - name: "Check out the repo"
-        uses: "actions/checkout@v3"
-
-      - name: "Install Foundry"
-        uses: "foundry-rs/foundry-toolchain@v1"
-
-      - name: "Restore the cached build and the node modules"
-        uses: "actions/cache/restore@v3"
-        with:
-          fail-on-cache-miss: true
-          key: "build-and-modules-${{ github.sha }}"
-          path: |
-            cache
-            node_modules
-            out
-
-      - name: "Run the integration tests"
-        run: "forge test --match-path \"test/integration/**/*.sol\""
-
-      - name: "Add test summary"
-        run: |
-          echo "## Integration tests result" >> $GITHUB_STEP_SUMMARY
-          echo "✅ Passed" >> $GITHUB_STEP_SUMMARY
+    uses: "sablier-labs/reusable-workflows/.github/workflows/forge-test.yml@main"
+    with:
+      foundry-fuzz-runs: 5000
+      foundry-profile: "test-optimized"
+      match-path: "test/integration/**/*.sol"
+      name: "Integration tests"
 
   test-invariant:
     needs: ["lint", "build"]
-    runs-on: "ubuntu-latest"
-    steps:
-      - name: "Check out the repo"
-        uses: "actions/checkout@v3"
-
-      - name: "Install Foundry"
-        uses: "foundry-rs/foundry-toolchain@v1"
-
-      - name: "Restore the cached build and the node modules"
-        uses: "actions/cache/restore@v3"
-        with:
-          fail-on-cache-miss: true
-          key: "build-and-modules-${{ github.sha }}"
-          path: |
-            cache
-            node_modules
-            out
-
-      - name: "Run the invariant tests"
-        run: "forge test --match-path \"test/invariant/**/*.sol\""
-
-      - name: "Add test summary"
-        run: |
-          echo "## Invariant tests result" >> $GITHUB_STEP_SUMMARY
-          echo "✅ Passed" >> $GITHUB_STEP_SUMMARY
+    uses: "sablier-labs/reusable-workflows/.github/workflows/forge-test.yml@main"
+    with:
+      foundry-profile: "test-optimized"
+      match-path: "test/invariant/**/*.sol"
+      name: "Invariant tests"
 
   coverage:
     needs: ["lint", "build"]
-    runs-on: "ubuntu-latest"
-    steps:
-      - name: "Check out the repo"
-        uses: "actions/checkout@v3"
-
-      - name: "Install Foundry"
-        uses: "foundry-rs/foundry-toolchain@v1"
-
-      - name: "Restore the cached build and the node modules"
-        uses: "actions/cache/restore@v3"
-        with:
-          fail-on-cache-miss: true
-          key: "build-and-modules-${{ github.sha }}"
-          path: |
-            cache
-            node_modules
-            out
-
-      - name: "Generate the coverage report using the unit and the integration tests"
-        run: "forge coverage --match-path \"test/{unit,integration}/**/*.sol\" --report lcov"
-
-      - name: "Upload coverage report to Codecov"
-        uses: "codecov/codecov-action@v3"
-        with:
-          files: "./lcov.info"
-
-      - name: "Add coverage summary"
-        run: |
-          echo "## Coverage result" >> $GITHUB_STEP_SUMMARY
-          echo "✅ Uploaded to Codecov" >> $GITHUB_STEP_SUMMARY
+    secrets:
+      CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
+    uses: "sablier-labs/reusable-workflows/.github/workflows/forge-coverage.yml@main"
+    with:
+      match-path: "test/{integration,unit}/**/*.sol"
diff --git a/.gitignore b/.gitignore
@@ -1,8 +1,13 @@
 # directories
+artifacts
+broadcast
 cache
 coverage
+docs
 node_modules
 out
+out-optimized
+out-svg
 
 # files
 *.env
@@ -13,8 +18,3 @@ lcov.info
 package-lock.json
 pnpm-lock.yaml
 yarn.lock
-
-# broadcasts
-!broadcast
-broadcast/*
-broadcast/*/31337/
diff --git a/.prettierignore b/.prettierignore
@@ -4,7 +4,6 @@ broadcast
 cache
 coverage
 docs
-lib
 node_modules
 out
 out-optimized

diff --git a/.solhint.json b/.solhint.json
@@ -2,15 +2,18 @@
   "extends": "solhint:recommended",
   "rules": {
     "avoid-low-level-calls": "off",
-    "code-complexity": ["error", 8],
+    "code-complexity": ["error", 9],
     "compiler-version": ["error", ">=0.8.22"],
     "contract-name-camelcase": "off",
+    "const-name-snakecase": "off",
     "func-name-mixedcase": "off",
     "func-visibility": ["error", { "ignoreConstructors": true }],
-    "max-line-length": ["error", 123],
+    "gas-custom-errors": "off",
+    "max-line-length": ["error", 124],
     "named-parameters-mapping": "warn",
-    "no-console": "off",
+    "no-empty-blocks": "off",
     "not-rely-on-time": "off",
-    "one-contract-per-file": "off"
+    "one-contract-per-file": "off",
+    "var-name-mixedcase": "off"
   }
 }
diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -9,11 +9,9 @@
     ".gas-snapshot": "julia"
   },
   "editor.formatOnSave": true,
-  "npm.exclude": "**/lib/**",
   "prettier.documentSelectors": ["**/*.svg"],
   "search.exclude": {
-    "**/node_modules": true,
-    "lib": true
+    "**/node_modules": true
   },
   "solidity.formatter": "forge"
 }
diff --git a/bun.lockb b/bun.lockb
diff --git a/codecov.yml b/codecov.yml
@@ -0,0 +1,10 @@
+codecov:
+  require_ci_to_pass: false
+comment: false
+coverage:
+  status:
+    patch: off
+ignore:
+  - "precompiles"
+  - "script"
+  - "test"
diff --git a/foundry.toml b/foundry.toml
@@ -1,29 +1,46 @@
-# Full reference https://github.com/foundry-rs/foundry/tree/master/crates/config
-
 [profile.default]
   auto_detect_solc = false
-  block_timestamp = 1_698_796_800 # November 1, 2023 at 00:00 GMT
   bytecode_hash = "none"
-  evm_version = "paris"           # See https://www.evmdiff.com/features?name=PUSH0&kind=opcode
-  fuzz = { runs = 10_000 }
+  evm_version = "paris"
   gas_reports = ["*"]
   optimizer = true
-  optimizer_runs = 10_000
+  optimizer_runs = 1000
   out = "out"
   script = "script"
   solc = "0.8.23"
   src = "src"
   test = "test"
 
+[profile.default.fuzz]
+  max_test_rejects = 1_000_000 # Number of times `vm.assume` can fail
+  runs = 50
+
 [profile.default.invariant]
   call_override = false # Override unsafe external calls to perform reentrancy checks
-  depth = 20            # Number of calls executed in one run
+  depth = 50            # Number of calls executed in one run
   fail_on_revert = true
-  runs = 20
-
-[profile.ci]
-  fuzz = { runs = 10_000 }
-  verbosity = 4
+  runs = 50
+
+# Speed up compilation and tests during development
+[profile.lite]
+  optimizer = false
+
+# Compile only the production code and the test mocks with via IR and 10,000 optimizer runs
+[profile.optimized]
+  optimizer = true
+  optimizer_runs = 10_000
+  out = "out-optimized"
+  test = "test/mocks"
+  via_ir = true
+
+# Test the optimized contracts without re-compiling them
+[profile.test-optimized]
+  src = "test"
+
+[doc]
+  ignore = ["**/*.t.sol"]
+  out = "docs"
+  repository = "https://github.com/sablier-labs/v2-open-ended"
 
 [fmt]
   bracket_spacing = true

diff --git a/package.json b/package.json
@@ -1,39 +1,71 @@
 {
   "name": "@sablier/v2-open-ended",
   "description": "Open ended smart contracts of the Sablier V2 token streaming protocol",
+  "license": "BUSL-1.1",
   "version": "1.0.0",
   "author": {
     "name": "Sablier Labs Ltd",
     "url": "https://sablier.com"
   },
+  "bugs": {
+    "url": "https://github.com/sablier-labs/v2-open-ended/issues"
+  },
   "dependencies": {
     "@openzeppelin/contracts": "5.0.2",
-    "@prb/math": "github:PaulRBerg/prb-math#a111d11"
+    "@prb/math": "github:PaulRBerg/prb-math#16419e5"
   },
   "devDependencies": {
     "forge-std": "github:foundry-rs/forge-std#v1.8.1",
     "prettier": "3.0.0",
     "solhint": "^4.0.0"
   },
+  "files": [
+    "artifacts",
+    "precompiles",
+    "src",
+    "LICENSE-GPL.md"
+  ],
   "keywords": [
+    "asset-distribution",
+    "asset-streaming",
     "blockchain",
+    "cryptoasset-streaming",
     "ethereum",
     "forge",
     "foundry",
+    "money-streaming",
+    "real-time-finance",
+    "payroll",
+    "sablier",
     "smart-contracts",
     "solidity",
-    "template"
+    "token-distribution",
+    "token-streaming",
+    "web3"
   ],
+  "peerDependencies": {
+    "@prb/math": "4.0.x"
+  },
   "private": true,
+  "publishConfig": {
+    "access": "restricted"
+  },
   "scripts": {
-    "clean": "rm -rf cache out",
     "build": "forge build",
+    "build:optimized": "FOUNDRY_PROFILE=optimized forge build",
+    "clean": "rm -rf artifacts broadcast cache docs out out-optimized out-svg",
+    "gas:report": "forge test --gas-report --mp \"./test/integration/**/*.sol\" --nmt \"test(Fuzz)?_RevertWhen_\\w{1,}?\"",
+    "gas:snapshot": "forge snapshot --mp \"./test/integration/**/*.sol\" --nmt \"test(Fuzz)?_RevertWhen_\\w{1,}?\"",
+    "gas:snapshot:optimized": "bun run build:optimized && FOUNDRY_PROFILE=test-optimized forge snapshot --mp \"./test/integration/**/*.sol\" --nmt \"test(Fork)?(Fuzz)?_RevertWhen_\\w{1,}?\"",
     "lint": "bun run lint:sol && bun run prettier:check",
-    "lint:sol": "forge fmt --check && bun solhint {script,src,test}/**/*.sol",
-    "prettier:check": "prettier --check **/*.{json,md,yml} --ignore-path=.prettierignore",
-    "prettier:write": "prettier --write **/*.{json,md,yml} --ignore-path=.prettierignore",
+    "lint:sol": "forge fmt --check && bun solhint \"{precompiles,script,src,test}/**/*.sol\"",
+    "prepack": "bun install && bash ./shell/prepare-artifacts.sh",
+    "prettier:check": "prettier --check \"**/*.{json,md,svg,yml}\"",
+    "prettier:write": "prettier --write \"**/*.{json,md,svg,yml}\"",
     "test": "forge test",
     "test:coverage": "forge coverage",
-    "test:coverage:report": "forge coverage --report lcov && genhtml lcov.info --branch-coverage --output-dir coverage"
+    "test:coverage:report": "forge coverage --report lcov && genhtml lcov.info --branch-coverage --output-dir coverage",
+    "test:lite": "FOUNDRY_PROFILE=lite forge test",
+    "test:optimized": "bun run build:optimized && FOUNDRY_PROFILE=test-optimized forge test"
   }
 }
-Original file line number
+Diff line change
@@ Expand Up / @@ -4,7 +4,6 @@ broadcast @@
     cache
     coverage
     docs
-    lib
     node_modules
     out
     out-optimized
@@ Expand Down @@