Merge pull request #220 from sablierhq/prb/fees

Segment[] array, comptroller, protocol and operator fees, structified parameters, via IR, PRBMath types, major tests refactor

Author: PaulRBerg

.github/workflows/ci.yml

@@ -1,8 +1,11 @@
 name: "CI"
 
+concurrency:
+  group: ${{github.workflow}}-${{github.ref}}
+  cancel-in-progress: true
+
 env:
   ETH_RPC_URL: "${{ secrets.ETH_RPC_URL }}"
-  FOUNDRY_PROFILE: "ci"
 
 on:
   pull_request:
@@ -13,7 +16,30 @@ on:
       - "main"
 
 jobs:
-  ci:
+  lint:
+    runs-on: "ubuntu-latest"
+    steps:
+      - name: "Check out the repo"
+        uses: "actions/checkout@v3"
+
+      - name: "Install Node.js"
+        uses: "actions/setup-node@v3"
+        with:
+          cache: "yarn"
+          node-version: "lts/*"
+
+      - name: "Install the Node.js dependencies"
+        run: "yarn install --immutable"
+
+      - name: "Lint the contracts"
+        run: "yarn lint"
+
+      - name: "Add lint summary"
+        run: |
+          echo "## Lint results" >> $GITHUB_STEP_SUMMARY
+          echo "✅ Passed" >> $GITHUB_STEP_SUMMARY
+
+  test:
     runs-on: "ubuntu-latest"
     steps:
       - name: "Check out the repo"
@@ -36,30 +62,43 @@ jobs:
           restore-keys: |
             "${{ runner.os }}-foundry-chain-fork-"
 
-      - name: "Install Node.js"
-        uses: "actions/setup-node@v3"
-        with:
-          cache: "yarn"
-          node-version: "lts/*"
+      - name: "Show the Foundry config"
+        run: "forge config"
 
-      - name: "Install the Node.js dependencies"
-        run: "yarn install --immutable"
+      - name: "Build the production code with --via-ir"
+        run: "FOUNDRY_PROFILE=optimized forge build"
 
-      - name: "Lint the contracts"
-        run: "yarn lint"
+      - name: "Test the optimized code"
+        run: "FOUNDRY_PROFILE=test-optimized forge test"
 
-      - name: "Add lint summary"
+      - name: "Add test summary"
         run: |
-          echo "## Lint results" >> $GITHUB_STEP_SUMMARY
+          echo "## Test results" >> $GITHUB_STEP_SUMMARY
           echo "✅ Passed" >> $GITHUB_STEP_SUMMARY
 
-      - name: "Show the Foundry config"
-        run: "forge config"
+  coverage:
+    runs-on: "ubuntu-latest"
+    steps:
+      - name: "Check out the repo"
+        uses: "actions/checkout@v3"
+        with:
+          submodules: "recursive"
 
-      - name: "Run the tests"
-        run: "forge test"
+      - name: "Install Foundry"
+        uses: "foundry-rs/foundry-toolchain@v1"
+        with:
+          version: "nightly"
 
-      - name: "Add test summary"
+      - name: "Generate the coverage report"
+        run: "forge coverage --report lcov"
+
+      - name: "Upload coverage report to Coveralls"
+        uses: "coverallsapp/github-action@master"
+        with:
+          github-token: "${{ secrets.GITHUB_TOKEN }}"
+          path-to-lcov: "./lcov.info"
+
+      - name: "Add coverage summary"
         run: |
-          echo "## Test results" >> $GITHUB_STEP_SUMMARY
+          echo "## Coverage results" >> $GITHUB_STEP_SUMMARY
           echo "✅ Passed" >> $GITHUB_STEP_SUMMARY

.gitignore

@@ -7,13 +7,16 @@
 !.yarn/versions
 **/cache
 **/node_modules
+**/optimized-out
 **/out
 
 # files
 *.env
+*.html
 *.log
 .DS_Store
 .pnp.*
+lcov.info
 npm-debug.log*
 yarn-debug.log*
 yarn-error.log*

.gitmodules

@@ -11,10 +11,14 @@
   path = "lib/prb-contracts"
   url = "https://github.com/paulrberg/prb-contracts"
 [submodule "lib/prb-math"]
-  branch = "v3"
+  branch = "main"
   path = "lib/prb-math"
   url = "https://github.com/paulrberg/prb-math"
 [submodule "lib/prb-test"]
-	branch = "0.3.1"
-	path = "lib/prb-test"
-	url = "https://github.com/paulrberg/prb-test"
+  branch = "main"
+  path = "lib/prb-test"
+  url = "https://github.com/paulrberg/prb-test"
+[submodule "lib/solarray"]
+  branch = "master"
+  path = "lib/solarray"
+  url = "https://github.com/paulrberg/solarray"

README.md

@@ -79,7 +79,8 @@ You will need the following VSCode extensions:
 Tests are organized in two 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.
+2. Integration - complex tests that run against a fork of Ethereum Mainnet to check that Sablier V2 works with deployed
+   ERC-20 tokens.
 
 You can run all the tests by using this command:
 

foundry.toml

@@ -2,19 +2,27 @@
 
 [profile.default]
 auto_detect_solc = false
-fuzz = { runs = 256 }
+fs_permissions = [
+    { access = "read", path = "./optimized-out" },
+]
+fuzz = { max_test_rejects = 100_000, runs = 1_000 }
 libs = ["lib"]
 gas_reports = ["*"]
 optimizer = true
 optimizer_runs = 10_000
 out = "out"
-sender = "0x9aF2E2B7e57c1CD7C68C5C3796d8ea67e0018dB7"
 solc = "0.8.17"
 src = "src"
 test = "test/unit"
-tx_origin = "0x9aF2E2B7e57c1CD7C68C5C3796d8ea67e0018dB7"
 
 [profile.ci]
-fuzz = { runs = 1_000 }
-test = "test"
-verbosity = 4
+fuzz = { runs = 5_000 }
+
+[profile.optimized]
+out = "optimized-out"
+test = "src" # compile only the production code with IR
+via_ir = true
+
+[profile.test-optimized]
+fuzz = { runs = 5_000 }
+src = "test/unit" # do not re-compile the production code

lib/prb-contracts

@@ -24,7 +24,6 @@
     "ethereum",
     "foundry",
     "money-streaming",
-    "real-time-finance",
     "sablier",
     "smart-contracts",
     "solidity"
@@ -34,11 +33,11 @@
   "private": true,
   "scripts": {
     "clean": "rimraf cache out",
-    "lint": "yarn solhint && yarn prettier:check",
-    "lint:check": "yarn prettier:check && yarn solhint:check",
+    "lint": "yarn prettier:check && yarn solhint \"{src,test}/**/*.sol\"",
     "postinstall": "husky install",
     "prettier:write": "prettier --write \"**/*.{json,md,sol,yml}\"",
     "prettier:check": "prettier --check \"**/*.{json,md,sol,yml}\"",
-    "solhint": "solhint --config ./.solhint.json \"{src,test}/**/*.sol\""
+    "test": "forge test",
+    "test:optimized": "FOUNDRY_PROFILE=optimized forge build && FOUNDRY_PROFILE=test-optimized forge test"
   }
 }

lib/prb-math

@@ -3,4 +3,6 @@
 @prb/math/=lib/prb-math/src/
 @prb/test/=lib/prb-test/src/
 forge-std/=lib/forge-std/src/
+solarray=lib/solarray/src
 src/=src/
+test/=test/

lib/prb-test

@@ -1,35 +1,64 @@
 // SPDX-License-Identifier: LGPL-3.0
 pragma solidity >=0.8.13;
 
+import { IERC20 } from "@prb/contracts/token/erc20/IERC20.sol";
+import { Ownable } from "@prb/contracts/access/Ownable.sol";
+import { SafeERC20 } from "@prb/contracts/token/erc20/SafeERC20.sol";
+import { UD60x18 } from "@prb/math/UD60x18.sol";
+
 import { Errors } from "./libraries/Errors.sol";
+import { Events } from "./libraries/Events.sol";
 
 import { ISablierV2 } from "./interfaces/ISablierV2.sol";
+import { ISablierV2Comptroller } from "./interfaces/ISablierV2Comptroller.sol";
 
 /// @title SablierV2
 /// @dev Abstract contract implementing common logic. Implements the ISablierV2 interface.
-abstract contract SablierV2 is ISablierV2 {
+abstract contract SablierV2 is
+    Ownable, // one dependency
+    ISablierV2 // three dependencies
+{
+    using SafeERC20 for IERC20;
+
+    /*//////////////////////////////////////////////////////////////////////////
+                                     CONSTANTS
+    //////////////////////////////////////////////////////////////////////////*/
+
+    /// @inheritdoc ISablierV2
+    UD60x18 public immutable override MAX_FEE;
+
     /*//////////////////////////////////////////////////////////////////////////
                                    PUBLIC STORAGE
     //////////////////////////////////////////////////////////////////////////*/
 
+    /// @inheritdoc ISablierV2
+    ISablierV2Comptroller public override comptroller;
+
     /// @inheritdoc ISablierV2
     uint256 public override nextStreamId;
 
+    /*//////////////////////////////////////////////////////////////////////////
+                                  INTERNAL STORAGE
+    //////////////////////////////////////////////////////////////////////////*/
+
+    /// @dev Protocol revenues mapped by token addresses.
+    mapping(IERC20 => uint128) internal _protocolRevenues;
+
     /*//////////////////////////////////////////////////////////////////////////
                                       MODIFIERS
     //////////////////////////////////////////////////////////////////////////*/
 
-    /// @notice Checks that `msg.sender` is the sender of the stream, an approved operator, or the owner of the
-    /// NFT (also known as the recipient of the stream).
+    /// @notice Checks that `msg.sender` is the sender of the stream, the recipient of the stream (also known as
+    /// the owner of the NFT), or an approved operator.
     modifier isAuthorizedForStream(uint256 streamId) {
         if (!_isCallerStreamSender(streamId) && !_isApprovedOrOwner(streamId, msg.sender)) {
             revert Errors.SablierV2__Unauthorized(streamId, msg.sender);
         }
         _;
     }
 
-    /// @notice Checks that `msg.sender` is either the sender of the stream or the owner of the NFT (also known as
-    /// the recipient of the stream).
+    /// @notice Checks that `msg.sender` is either the sender of the stream or the recipient of the stream (also known
+    /// as the owner of the NFT).
     modifier onlySenderOrRecipient(uint256 streamId) {
         if (!_isCallerStreamSender(streamId) && msg.sender != getRecipient(streamId)) {
             revert Errors.SablierV2__Unauthorized(streamId, msg.sender);
@@ -49,14 +78,21 @@ abstract contract SablierV2 is ISablierV2 {
                                      CONSTRUCTOR
     //////////////////////////////////////////////////////////////////////////*/
 
-    constructor() {
+    constructor(ISablierV2Comptroller initialComptroller, UD60x18 maxFee) {
+        comptroller = initialComptroller;
+        MAX_FEE = maxFee;
         nextStreamId = 1;
     }
 
     /*//////////////////////////////////////////////////////////////////////////
                               PUBLIC CONSTANT FUNCTIONS
     //////////////////////////////////////////////////////////////////////////*/
 
+    /// @inheritdoc ISablierV2
+    function getProtocolRevenues(IERC20 token) external view override returns (uint128 protocolRevenues) {
+        protocolRevenues = _protocolRevenues[token];
+    }
+
     /// @inheritdoc ISablierV2
     function getRecipient(uint256 streamId) public view virtual override returns (address recipient);
 
@@ -99,7 +135,7 @@ abstract contract SablierV2 is ISablierV2 {
     }
 
     /// @inheritdoc ISablierV2
-    function cancelAll(uint256[] calldata streamIds) external override {
+    function cancelMultiple(uint256[] calldata streamIds) external override {
         // Iterate over the provided array of stream ids and cancel each stream that exists and is cancelable.
         uint256 count = streamIds.length;
         uint256 streamId;
@@ -118,6 +154,24 @@ abstract contract SablierV2 is ISablierV2 {
         }
     }
 
+    /// @inheritdoc ISablierV2
+    function claimProtocolRevenues(IERC20 token) external override onlyOwner {
+        // Checks: the protocol revenues are not zero.
+        uint128 protocolRevenues = _protocolRevenues[token];
+        if (protocolRevenues == 0) {
+            revert Errors.SablierV2__ClaimZeroProtocolRevenues(token);
+        }
+
+        // Effects: set the protocol revenues to zero.
+        _protocolRevenues[token] = 0;
+
+        // Interactions: perform the ERC-20 transfer to pay the protocol revenues.
+        token.safeTransfer(msg.sender, protocolRevenues);
+
+        // Emit an event.
+        emit Events.ClaimProtocolRevenues(msg.sender, token, protocolRevenues);
+    }
+
     /// @inheritdoc ISablierV2
     function renounce(uint256 streamId) external override streamExists(streamId) {
         // Checks: the `msg.sender` is the sender of the stream.
@@ -133,6 +187,20 @@ abstract contract SablierV2 is ISablierV2 {
         _renounce(streamId);
     }
 
+    /// @inheritdoc ISablierV2
+    function setComptroller(ISablierV2Comptroller newComptroller) external override onlyOwner {
+        // Effects: set the comptroller.
+        ISablierV2Comptroller oldComptroller = comptroller;
+        comptroller = newComptroller;
+
+        // Emit an event.
+        emit Events.SetComptroller({
+            owner: msg.sender,
+            oldComptroller: oldComptroller,
+            newComptroller: newComptroller
+        });
+    }
+
     /// @inheritdoc ISablierV2
     function withdraw(
         uint256 streamId,
@@ -154,7 +222,7 @@ abstract contract SablierV2 is ISablierV2 {
     }
 
     /// @inheritdoc ISablierV2
-    function withdrawAll(uint256[] calldata streamIds, address to, uint128[] calldata amounts) external override {
+    function withdrawMultiple(uint256[] calldata streamIds, address to, uint128[] calldata amounts) external override {
         // Checks: the provided address to withdraw to is not zero.
         if (to == address(0)) {
             revert Errors.SablierV2__WithdrawToZeroAddress();
@@ -164,7 +232,7 @@ abstract contract SablierV2 is ISablierV2 {
         uint256 streamIdsCount = streamIds.length;
         uint256 amountsCount = amounts.length;
         if (streamIdsCount != amountsCount) {
-            revert Errors.SablierV2__WithdrawAllArraysNotEqual(streamIdsCount, amountsCount);
+            revert Errors.SablierV2__WithdrawArraysNotEqual(streamIdsCount, amountsCount);
         }
 
         // Iterate over the provided array of stream ids and withdraw from each stream.