Test reorg + various improvements

.github/workflows/ci.yml

@@ -5,7 +5,9 @@ concurrency:
   cancel-in-progress: true
 
 env:
-  INFURA_API_KEY: "${{ secrets.INFURA_API_KEY }}"
+  ALCHEMY_API_KEY: ${{ secrets.ALCHEMY_API_KEY }}
+  ETHERSCAN_API_KEY: ${{ secrets.ETHERSCAN_API_KEY }}
+  INFURA_API_KEY: ${{ secrets.INFURA_API_KEY }}
 
 on:
   pull_request:
@@ -36,10 +38,10 @@ jobs:
 
       - name: "Add lint summary"
         run: |
-          echo "## Lint results" >> $GITHUB_STEP_SUMMARY
+          echo "## Lint result" >> $GITHUB_STEP_SUMMARY
           echo "✅ Passed" >> $GITHUB_STEP_SUMMARY
 
-  test:
+  build:
     runs-on: "ubuntu-latest"
     steps:
       - name: "Check out the repo"
@@ -53,18 +55,9 @@ jobs:
       - name: "Show the Foundry config"
         run: "forge config"
 
-      - name: "Generate fuzz seed that changes weekly to avoid burning through RPC allowance"
-        run: >
-          echo "FOUNDRY_FUZZ_SEED=$(
-            echo $(($EPOCHSECONDS - $EPOCHSECONDS % 604800))
-          )" >> $GITHUB_ENV
-
       - name: "Produce an optimized build with --via-ir"
         run: "FOUNDRY_PROFILE=optimized forge build"
 
-      - name: "Run the unit and the integration tests against the optimized build"
-        run: "FOUNDRY_PROFILE=test-optimized forge test"
-
       - name: "Store contract ABIs as artifacts in GitHub Actions"
         uses: "actions/upload-artifact@v3"
         with:
@@ -88,12 +81,94 @@ jobs:
             optimized-out/SablierV2LockupLinear.sol/SablierV2LockupLinear.json
             optimized-out/SablierV2LockupPro.sol/SablierV2LockupPro.json
 
+      - name: "Add build summary"
+        run: |
+          echo "## Build result" >> $GITHUB_STEP_SUMMARY
+          echo "✅ Passed" >> $GITHUB_STEP_SUMMARY
+
+  test-unit:
+    needs: ["lint", "build"]
+    runs-on: "ubuntu-latest"
+    steps:
+      - name: "Check out the repo"
+        uses: "actions/checkout@v3"
+        with:
+          submodules: "recursive"
+
+      - name: "Install Foundry"
+        uses: "foundry-rs/foundry-toolchain@v1"
+
+      - name: "Produce an optimized build with --via-ir"
+        run: "FOUNDRY_PROFILE=optimized forge build"
+
+      - name: "Run the unit tests against the optimized build"
+        run: "FOUNDRY_PROFILE=test-optimized forge test --match-path \"test/unit/**/*.sol\""
+
       - name: "Add test summary"
         run: |
-          echo "## Test results" >> $GITHUB_STEP_SUMMARY
+          echo "## Unit tests result" >> $GITHUB_STEP_SUMMARY
           echo "✅ Passed" >> $GITHUB_STEP_SUMMARY
 
+  test-fuzz:
+    env:
+      FOUNDRY_FUZZ_RUNS: "20000"
+    needs: ["lint", "build"]
+    runs-on: "ubuntu-latest"
+    steps:
+      - name: "Check out the repo"
+        uses: "actions/checkout@v3"
+        with:
+          submodules: "recursive"
+
+      - name: "Install Foundry"
+        uses: "foundry-rs/foundry-toolchain@v1"
+
+      - name: "Produce an optimized build with --via-ir"
+        run: "FOUNDRY_PROFILE=optimized forge build"
+
+      - name: "Run the fuzz tests against the optimized build"
+        run: "FOUNDRY_PROFILE=test-optimized forge test --match-path \"test/fuzz/**/*.sol\""
+
+      - name: "Add test summary"
+        run: |
+          echo "## Fuzz tests result" >> $GITHUB_STEP_SUMMARY
+          echo "✅ Passed" >> $GITHUB_STEP_SUMMARY
+
+
+  test-e2e:
+    env:
+      FOUNDRY_FUZZ_RUNS: "2000"
+    needs: ["lint", "build"]
+    runs-on: "ubuntu-latest"
+    steps:
+      - name: "Check out the repo"
+        uses: "actions/checkout@v3"
+        with:
+          submodules: "recursive"
+
+      - name: "Install Foundry"
+        uses: "foundry-rs/foundry-toolchain@v1"
+
+      - name: "Produce an optimized build with --via-ir"
+        run: "FOUNDRY_PROFILE=optimized forge build"
+
+      - name: "Generate fuzz seed that changes weekly to avoid burning through RPC allowance"
+        run: >
+          echo "FOUNDRY_FUZZ_SEED=$(
+            echo $(($EPOCHSECONDS - $EPOCHSECONDS % 604800))
+          )" >> $GITHUB_ENV
+
+      - name: "Run the end-to-end tests against the optimized build"
+        run: "FOUNDRY_PROFILE=test-optimized forge test --match-path \"test/e2e/**/*.sol\""
+
+      - name: "Add test summary"
+        run: |
+          echo "## End-to-end tests result" >> $GITHUB_STEP_SUMMARY
+          echo "✅ Passed" >> $GITHUB_STEP_SUMMARY
+
+
   coverage:
+    needs: ["lint", "build"]
     runs-on: "ubuntu-latest"
     steps:
       - name: "Check out the repo"
@@ -115,5 +190,5 @@ jobs:
 
       - name: "Add coverage summary"
         run: |
-          echo "## Coverage results" >> $GITHUB_STEP_SUMMARY
-          echo "✅ Passed" >> $GITHUB_STEP_SUMMARY
+          echo "## Coverage result" >> $GITHUB_STEP_SUMMARY
+          echo "✅ Uploaded to Codecov" >> $GITHUB_STEP_SUMMARY

.github/workflows/deploy-linear.yml → .github/workflows/deploy-lockup-linear.yml

@@ -42,7 +42,7 @@ jobs:
 
       - name: "Deploy the SablierV2LockupLinear contract"
         run: >-
-          forge script script/DeployLinear.s.sol
+          forge script script/DeployLockupLinear.s.sol
           --broadcast
           --rpc-url ${{ github.event.inputs.chain }}
           --sig "run(address,address,uint256)"

.github/workflows/deploy-pro.yml → .github/workflows/deploy-lockup-pro.yml

@@ -47,9 +47,9 @@ jobs:
       - name: "Install Foundry"
         uses: "foundry-rs/foundry-toolchain@v1"
 
-      - name: "Deploy the SablierV2Pro contract"
+      - name: "Deploy the SablierV2LockupPro contract"
         run: >-
-          forge script script/DeployPro.s.sol
+          forge script script/DeployLockupPro.s.sol
           --broadcast
           --rpc-url "${{ github.event.inputs.chain }}"
           --sig "run(address,address,uint256,uint256)"

.vscode/settings.json

@@ -0,0 +1,11 @@
+{
+  "[toml]": {
+    "editor.defaultFormatter": "tamasfe.even-better-toml"
+  },
+  "[solidity]": {
+    "editor.defaultFormatter": "esbenp.prettier-vscode"
+  },
+  "solidity.formatter": "prettier",
+  "solidity.packageDefaultDependenciesContractsDirectory": "src",
+  "solidity.packageDefaultDependenciesDirectory": "lib"
+}

README.md

@@ -160,11 +160,11 @@ Note: write access to the repository is required to deploy using the GitHub UI.
 
 ## Via IR
 
-We deploy our contracts with the [`--via-ir`](https://docs.soliditylang.org/en/v0.8.17/ir-breaking-changes.html) flag
-enabled.
+The contracts have been deployed to mainnet with the
+[`--via-ir`](https://docs.soliditylang.org/en/v0.8.17/ir-breaking-changes.html) flag enabled.
 
-This means that the contracts are compiled with a lot of powerful optimizations, but the cost is very slow compile
-times. Nonetheless, we have to run our tests against this optimized version of the contracts, since this is what end
+Via IR means that the contracts are compiled with a lot of powerful optimizations, but the cost is very slow compile
+times. Nonetheless, we want to run our tests against this optimized version of the contracts, since this is what end
 users will ultimately interact with.
 
 To get the best of both worlds, we have come up with a set-up where on our local machines we build and test the
@@ -174,53 +174,62 @@ without IR enabled).
 
 ## Tests
 
-Tests are organized in two categories:
+Tests are organized in three categories:
 
 1. Unit - simple tests that check the behavior of a single function on a local development EMV.
-2. Integration - complex tests that run against a fork of Ethereum Mainnet to check that Sablier V2 works with deployed
-   ERC-20 assets.
+2. Fuzz - similar to the unit tests, but with randomized inputs.
+3. End-to-end - complex tests that run against a fork of Ethereum Mainnet, which ensure that the protocol works with
+   deployed ERC-20 assets.
 
 You can run all tests by using this command:
 
 ```sh
-forge test
+yarn test
 ```
 
-By default, only unit tests run. To run all tests, including integration tests, you can use this command:
+By default, the contracts are compiled using the default compiler settings, which do not contain optimizations. To run
+the tests against the optimized version of the contracts, you can use this command:
 
 ```sh
 yarn test:optimized
 ```
 
-Alternatively, you could change the value of the `test` configuration option in the [`foundry.toml`](./foundry.toml)
-file to `test/integration`.
-
-To filter tests by name, you can use the `--match-test` flag. Here's an example for the `createWithRange` function
-tests:
+To filter tests by name, you can use the `--match-test` flag (shorthand `--mt`). Here's an example for how to run the
+tests only for the `createWithRange` function:
 
 ```sh
-forge test --match-test testCreateWithRange
+yarn test --match-test test_CreateWithRange
 ```
 
-You can also filter the tests by test contract name with the `--match-contract` flag. Here's an example for the
-`createWithRange` function test contracts:
+You can also filter the tests by test contract name with the `--match-contract` flag (shorthand `--mc`). Here's an
+example for the test contract that contains all the tests for the `createWithRange` function:
 
 ```sh
-forge test --match-contract CreateWithRange
+yarn test --match-contract CreateWithRange
 ```
 
 ## Commands
 
-Here's a list of the most frequently needed commands.
+Here's a list of the most frequently needed commands, which are run either with Forge or with Yarn.
 
 ### Build
 
-Build the contracts:
+Build the contracts using the default profile:
 
 ```sh
 $ forge build
 ```
 
+### Build Optimized
+
+Build the contracts using the optimized profile:
+
+```sh
+$ yarn build:optimized
+```
+
+This will compile the contracts with the `--via-ir` flag enabled.
+
 ### Clean
 
 Delete the build artifacts and cache directories:
@@ -245,12 +254,36 @@ Format the contracts with Prettier:
 $ yarn prettier
 ```
 
-### Gas Usage
+### Gas Report
 
 Get a gas report:
 
 ```sh
-$ forge test --gas-report
+$ yarn gas:report
+```
+
+### Gas Report Optimized
+
+Get a gas report for the optimized version of the contracts:
+
+```sh
+$ yarn gas:report:optimized
+```
+
+### Gas Snapshot
+
+Take a gas snapshot:
+
+```sh
+$ yarn gas:snapshot
+```
+
+### Gas Snapshot Optimized
+
+Take a gas snapshot for the optimized version of the contracts:
+
+```sh
+$ yarn gas:snapshot:optimized
 ```
 
 ### Lint
@@ -266,7 +299,15 @@ $ yarn lint
 Run the tests:
 
 ```sh
-$ forge test
+$ yarn test
+```
+
+### Test Optimized
+
+Run the tests against the optimized version of the contracts:
+
+```sh
+$ yarn test:optimized
 ```
 
 ### Other