Merge pull request #26 from sablier-labs/build/bump-forge-std

Bump forge-std and remove prb-test
sablier-labs · Apr 4, 2024 · 839203b · 839203b
2 parents 6fa28ca + f2c0bed
commit 839203b
Show file tree

Hide file tree

Showing 15 changed files with 36 additions and 40 deletions.
diff --git a/bun.lockb b/bun.lockb
diff --git a/package.json b/package.json
@@ -8,11 +8,10 @@
   },
   "dependencies": {
     "@openzeppelin/contracts": "5.0.1",
-    "@prb/math": "4.0.2"
+    "@prb/math": "github:PaulRBerg/prb-math#a111d11"
   },
   "devDependencies": {
-    "@prb/test": "0.6.4",
-    "forge-std": "github:foundry-rs/forge-std#v1.5.6",
+    "forge-std": "github:foundry-rs/forge-std#v1.8.1",
     "prettier": "3.0.0",
     "solhint": "^4.0.0"
   },

diff --git a/remappings.txt b/remappings.txt
@@ -1,4 +1,3 @@
 @forge-std/=node_modules/forge-std/
 @openzeppelin/contracts/=node_modules/@openzeppelin/contracts/
-@prb/math/=node_modules/@prb/math/
-@prb/test/=node_modules/@prb/test/
+@prb/math/=node_modules/@prb/math/
diff --git a/test/Base.t.sol b/test/Base.t.sol
@@ -1,7 +1,7 @@
 // SPDX-License-Identifier: UNLICENSED
 pragma solidity >=0.8.22;
 
-import { StdCheats } from "@forge-std/src/StdCheats.sol";
+import { Test } from "@forge-std/src/Test.sol";
 import { IERC20 } from "@openzeppelin/contracts/token/ERC20/IERC20.sol";
 import { SafeCast } from "@openzeppelin/contracts/utils/math/SafeCast.sol";
 
@@ -18,7 +18,7 @@ struct Users {
     address recipient;
 }
 
-abstract contract Base_Test is Assertions, Events, Modifiers, StdCheats {
+abstract contract Base_Test is Assertions, Events, Modifiers, Test {
     using SafeCast for uint256;
 
     /*//////////////////////////////////////////////////////////////////////////

diff --git a/test/integration/adjust-rate-per-second/adjustRatePerSecond.t.sol b/test/integration/adjust-rate-per-second/adjustRatePerSecond.t.sol
@@ -94,7 +94,7 @@ contract adjustRatePerSecond_Integration_Test is Integration_Test {
         whenratePerSecondNonZero
         whenratePerSecondNotDifferent
     {
-        vm.warp({ timestamp: WARP_ONE_MONTH });
+        vm.warp({ newTimestamp: WARP_ONE_MONTH });
 
         uint128 actualratePerSecond = openEnded.getRatePerSecond(defaultStreamId);
         uint128 expectedratePerSecond = RATE_PER_SECOND;
@@ -149,7 +149,7 @@ contract adjustRatePerSecond_Integration_Test is Integration_Test {
 
     function test_adjustRatePerSecond(uint256 streamId, IERC20 asset) internal {
         openEnded.deposit(streamId, DEPOSIT_AMOUNT);
-        vm.warp({ timestamp: WARP_ONE_MONTH });
+        vm.warp({ newTimestamp: WARP_ONE_MONTH });
 
         uint128 actualratePerSecond = openEnded.getRatePerSecond(streamId);
         uint128 expectedratePerSecond = RATE_PER_SECOND;

diff --git a/test/integration/cancel/cancel.t.sol b/test/integration/cancel/cancel.t.sol
@@ -12,7 +12,7 @@ contract Cancel_Integration_Test is Integration_Test {
     function setUp() public override {
         Integration_Test.setUp();
 
-        vm.warp({ timestamp: WARP_ONE_MONTH });
+        vm.warp({ newTimestamp: WARP_ONE_MONTH });
     }
 
     function test_RevertWhen_DelegateCall() external {
@@ -89,10 +89,10 @@ contract Cancel_Integration_Test is Integration_Test {
         whenNoOverrefund
     {
         // Set the timestamp to 1 month ago to create the stream with the same `lastTimeUpdate` as `defaultStreamId`.
-        vm.warp({ timestamp: WARP_ONE_MONTH - ONE_MONTH });
+        vm.warp({ newTimestamp: WARP_ONE_MONTH - ONE_MONTH });
         uint256 streamId = createDefaultStreamWithAsset(IERC20(address(usdt)));
         openEnded.deposit(streamId, DEPOSIT_AMOUNT);
-        vm.warp({ timestamp: WARP_ONE_MONTH });
+        vm.warp({ newTimestamp: WARP_ONE_MONTH });
 
         test_Cancel(streamId, IERC20(address(usdt)));
     }

diff --git a/test/integration/refund-from-stream/refundFromStream.t.sol b/test/integration/refund-from-stream/refundFromStream.t.sol
@@ -14,7 +14,7 @@ contract RefundFromStream_Integration_Test is Integration_Test {
 
         defaultDeposit();
 
-        vm.warp({ timestamp: WARP_ONE_MONTH });
+        vm.warp({ newTimestamp: WARP_ONE_MONTH });
     }
 
     function test_RevertWhen_DelegateCall() external {
@@ -103,10 +103,10 @@ contract RefundFromStream_Integration_Test is Integration_Test {
         whenNoOverrefund
     {
         // Set the timestamp to 1 month ago to create the stream with the same `lastTimeUpdate` as `defaultStreamId`.
-        vm.warp({ timestamp: WARP_ONE_MONTH - ONE_MONTH });
+        vm.warp({ newTimestamp: WARP_ONE_MONTH - ONE_MONTH });
         uint256 streamId = createDefaultStreamWithAsset(IERC20(address(usdt)));
         openEnded.deposit(streamId, DEPOSIT_AMOUNT);
-        vm.warp({ timestamp: WARP_ONE_MONTH });
+        vm.warp({ newTimestamp: WARP_ONE_MONTH });
 
         test_RefundFromStream(streamId, IERC20(address(usdt)));
     }

diff --git a/test/integration/refundable-amount-of/refundableAmountOf.t.sol b/test/integration/refundable-amount-of/refundableAmountOf.t.sol
@@ -18,7 +18,7 @@ contract RefundableAmountOf_Integration_Test is Integration_Test {
         openEnded.refundableAmountOf(defaultStreamId);
     }
 
-    function test_RefundableAmountOf_BalanceZero() external givenNotNull givenNotCanceled {
+    function test_RefundableAmountOf_BalanceZero() external view givenNotNull givenNotCanceled {
         uint128 refundableAmount = openEnded.refundableAmountOf(defaultStreamId);
         assertEq(refundableAmount, 0, "refundable amount");
     }
@@ -27,15 +27,15 @@ contract RefundableAmountOf_Integration_Test is Integration_Test {
         uint128 depositAmount = 1e18;
         openEnded.deposit(defaultStreamId, depositAmount);
 
-        vm.warp({ timestamp: WARP_ONE_MONTH });
+        vm.warp({ newTimestamp: WARP_ONE_MONTH });
         uint128 refundableAmount = openEnded.refundableAmountOf(defaultStreamId);
         assertEq(refundableAmount, 0, "refundable amount");
     }
 
     function test_RefundableAmountOf() external givenNotNull givenNotCanceled {
         defaultDeposit();
 
-        vm.warp({ timestamp: WARP_ONE_MONTH });
+        vm.warp({ newTimestamp: WARP_ONE_MONTH });
         uint128 refundableAmount = openEnded.refundableAmountOf(defaultStreamId);
         assertEq(refundableAmount, ONE_MONTH_REFUNDABLE_AMOUNT, "refundable amount");
     }

diff --git a/test/integration/stream-debt/streamDebt.t.sol b/test/integration/stream-debt/streamDebt.t.sol
@@ -25,7 +25,7 @@ contract StreamDebt_Integration_Test is Integration_Test {
     }
 
     function test_StreamDebt() external givenNotNull givenNotCanceled {
-        vm.warp({ timestamp: WARP_ONE_MONTH });
+        vm.warp({ newTimestamp: WARP_ONE_MONTH });
         uint128 streamDebt = openEnded.streamDebt(defaultStreamId);
         assertEq(streamDebt, ONE_MONTH_STREAMED_AMOUNT, "stream debt");
     }

diff --git a/test/integration/streamed-amount-of/streamedAmountOf.t.sol b/test/integration/streamed-amount-of/streamedAmountOf.t.sol
@@ -18,13 +18,13 @@ contract StreamedAmountOf_Integration_Test is Integration_Test {
         openEnded.streamedAmountOf(defaultStreamId);
     }
 
-    function test_StreamedAmountOf_LastTimeUpdateInThePresent() external givenNotNull givenNotCanceled {
+    function test_StreamedAmountOf_LastTimeUpdateInThePresent() external view givenNotNull givenNotCanceled {
         uint128 streamedAmount = openEnded.streamedAmountOf(defaultStreamId);
         assertEq(streamedAmount, 0, "streamed amount");
     }
 
     function test_StreamedAmountOf() external givenNotNull givenNotCanceled {
-        vm.warp({ timestamp: WARP_ONE_MONTH });
+        vm.warp({ newTimestamp: WARP_ONE_MONTH });
         uint128 streamedAmount = openEnded.streamedAmountOf(defaultStreamId);
         assertEq(streamedAmount, ONE_MONTH_STREAMED_AMOUNT, "streamed amount");
     }

diff --git a/test/integration/withdraw/withdraw.t.sol b/test/integration/withdraw/withdraw.t.sol
@@ -14,7 +14,7 @@ contract Withdraw_Integration_Test is Integration_Test {
 
         defaultDeposit();
 
-        vm.warp({ timestamp: WARP_ONE_MONTH });
+        vm.warp({ newTimestamp: WARP_ONE_MONTH });
     }
 
     function test_RevertWhen_DelegateCall() external {
@@ -136,10 +136,10 @@ contract Withdraw_Integration_Test is Integration_Test {
         whenTimeNotGreaterThanCurrentTime
     {
         // Set the timestamp to 1 month ago to create the stream with the same `lastTimeUpdate` as `defaultStreamId`.
-        vm.warp({ timestamp: WARP_ONE_MONTH - ONE_MONTH });
+        vm.warp({ newTimestamp: WARP_ONE_MONTH - ONE_MONTH });
         uint256 streamId = createDefaultStreamWithAsset(IERC20(address(usdt)));
         openEnded.deposit(streamId, DEPOSIT_AMOUNT);
-        vm.warp({ timestamp: WARP_ONE_MONTH });
+        vm.warp({ newTimestamp: WARP_ONE_MONTH });
 
         test_Withdraw(streamId, IERC20(address(usdt)));
     }

diff --git a/test/integration/withdrawable-amount-of/withdrawableAmountOf.t.sol b/test/integration/withdrawable-amount-of/withdrawableAmountOf.t.sol
@@ -27,15 +27,15 @@ contract WithdrawableAmountOf_Integration_Test is Integration_Test {
         uint128 depositAmount = 1e18;
         openEnded.deposit(defaultStreamId, depositAmount);
 
-        vm.warp({ timestamp: WARP_ONE_MONTH });
+        vm.warp({ newTimestamp: WARP_ONE_MONTH });
         uint128 withdrawableAmount = openEnded.withdrawableAmountOf(defaultStreamId);
         assertEq(withdrawableAmount, depositAmount, "withdrawable amount");
     }
 
     function test_WithdrawableAmountOf() external givenNotNull givenNotCanceled {
         defaultDeposit();
 
-        vm.warp({ timestamp: WARP_ONE_MONTH });
+        vm.warp({ newTimestamp: WARP_ONE_MONTH });
         uint128 withdrawableAmount = openEnded.withdrawableAmountOf(defaultStreamId);
         assertEq(withdrawableAmount, ONE_MONTH_STREAMED_AMOUNT, "withdrawable amount");
     }

diff --git a/test/invariant/Invariant.t.sol b/test/invariant/Invariant.t.sol
@@ -1,13 +1,11 @@
 // SPDX-License-Identifier: UNLICENSED
 pragma solidity >=0.8.22 <0.9.0;
 
-import { StdInvariant } from "@forge-std/src/StdInvariant.sol";
-
 import { Base_Test } from "../Base.t.sol";
 import { TimestampStore } from "./stores/TimestampStore.sol";
 
 /// @notice Common logic needed by all invariant tests.
-abstract contract Invariant_Test is Base_Test, StdInvariant {
+abstract contract Invariant_Test is Base_Test {
     /*//////////////////////////////////////////////////////////////////////////
                                    TEST CONTRACTS
     //////////////////////////////////////////////////////////////////////////*/

diff --git a/test/invariant/OpenEnded.t.sol b/test/invariant/OpenEnded.t.sol
@@ -63,7 +63,7 @@ contract OpenEnded_Invariant_Test is Invariant_Test {
         uint256 lastStreamId = openEndedStore.lastStreamId();
         for (uint256 i = 0; i < lastStreamId; ++i) {
             uint256 streamId = openEndedStore.streamIds(i);
-            assertGte(
+            assertGe(
                 uint40(block.timestamp),
                 openEnded.getLastTimeUpdate(streamId),
                 "Invariant violation: block timestamp < last time update"
@@ -81,7 +81,7 @@ contract OpenEnded_Invariant_Test is Invariant_Test {
             streamBalancesSumNormalized += uint256(normalizeBalance(streamId));
         }
 
-        assertGte(
+        assertGe(
             contractBalance,
             streamBalancesSumNormalized,
             unicode"Invariant violation: contract balances < Σ stream balances normalized"
@@ -92,7 +92,7 @@ contract OpenEnded_Invariant_Test is Invariant_Test {
         uint256 streamDepositedAmountsSum = openEndedStore.streamDepositedAmountsSum();
         uint256 streamExtractedAmountsSum = openEndedStore.streamExtractedAmountsSum();
 
-        assertGte(
+        assertGe(
             streamDepositedAmountsSum,
             streamExtractedAmountsSum,
             "Invariant violation: stream deposited amounts sum < stream extracted amounts sum"
@@ -126,7 +126,7 @@ contract OpenEnded_Invariant_Test is Invariant_Test {
         for (uint256 i = 0; i < lastStreamId; ++i) {
             uint256 streamId = openEndedStore.streamIds(i);
             if (!openEnded.isCanceled(streamId)) {
-                assertGte(
+                assertGe(
                     openEnded.getBalance(streamId),
                     openEnded.withdrawableAmountOf(streamId),
                     "Invariant violation: stream balance < withdrawable amount"
@@ -140,7 +140,7 @@ contract OpenEnded_Invariant_Test is Invariant_Test {
         for (uint256 i = 0; i < lastStreamId; ++i) {
             uint256 streamId = openEndedStore.streamIds(i);
             if (!openEnded.isCanceled(streamId)) {
-                assertGte(
+                assertGe(
                     openEnded.getBalance(streamId),
                     openEnded.refundableAmountOf(streamId),
                     "Invariant violation: stream balance < refundable amount"
@@ -154,7 +154,7 @@ contract OpenEnded_Invariant_Test is Invariant_Test {
         for (uint256 i = 0; i < lastStreamId; ++i) {
             uint256 streamId = openEndedStore.streamIds(i);
             if (!openEnded.isCanceled(streamId)) {
-                assertGte(
+                assertGe(
                     openEnded.streamedAmountOf(streamId),
                     openEnded.withdrawableAmountOf(streamId),
                     "Invariant violation: streamed amount < withdrawable amount"

diff --git a/test/utils/Assertions.sol b/test/utils/Assertions.sol
@@ -1,28 +1,28 @@
 // SPDX-License-Identifier: GPL-3.0-or-later
 pragma solidity >=0.8.22;
 
-import { PRBTest } from "@prb/test/src/PRBTest.sol";
+import { StdAssertions } from "forge-std/src/StdAssertions.sol";
 
 import { IERC20 } from "@openzeppelin/contracts/token/ERC20/IERC20.sol";
 import { OpenEnded } from "src/types/DataTypes.sol";
 
-abstract contract Assertions is PRBTest {
+abstract contract Assertions is StdAssertions {
     /*//////////////////////////////////////////////////////////////////////////
                                      ASSERTIONS
     //////////////////////////////////////////////////////////////////////////*/
 
     /// @dev Compares two {IERC20} values.
-    function assertEq(IERC20 a, IERC20 b) internal {
+    function assertEq(IERC20 a, IERC20 b) internal pure {
         assertEq(address(a), address(b));
     }
 
     /// @dev Compares two {IERC20} values.
-    function assertEq(IERC20 a, IERC20 b, string memory err) internal {
+    function assertEq(IERC20 a, IERC20 b, string memory err) internal pure {
         assertEq(address(a), address(b), err);
     }
 
     /// @dev Compares two {OpenEnded.Stream} struct entities.
-    function assertEq(OpenEnded.Stream memory a, OpenEnded.Stream memory b) internal {
+    function assertEq(OpenEnded.Stream memory a, OpenEnded.Stream memory b) internal pure {
         assertEq(a.ratePerSecond, b.ratePerSecond, "ratePerSecond");
         assertEq(a.asset, b.asset, "asset");
         assertEq(a.assetDecimals, b.assetDecimals, "assetDecimals");