update foundry to 2023-10-04 (#1715)

* update foundry to 2023-10-04 * check-changeset.sh to detect nix flake changes * remove old remapping files * update lib/forge-std * fix broken build - new foundry updates led to stricter requirements - deal() doesn't work with SuperToken's because of dynamic balanceOf function - FlowNFTBase.t.sol included a vm.prank which was unused - use vm.startPrank over vm.prank in ConstantOutflow/ConstantInflow tests where there was a small issue --------- Co-authored-by: 0xdavinchee <[email protected]>
superfluid-finance · Oct 10, 2023 · eab7af4 · eab7af4
1 parent 7a4f969
commit eab7af4
Show file tree

Hide file tree

Showing 10 changed files with 56 additions and 41 deletions.
diff --git a/flake.lock b/flake.lock
diff --git a/lib/forge-std b/lib/forge-std
diff --git a/packages/automation-contracts/autowrap/remappings.txt b/packages/automation-contracts/autowrap/remappings.txt
diff --git a/packages/automation-contracts/scheduler/remappings.txt b/packages/automation-contracts/scheduler/remappings.txt
diff --git a/packages/ethereum-contracts/test/foundry/apps/SuperAppTester/SuperAppTest.t.sol b/packages/ethereum-contracts/test/foundry/apps/SuperAppTester/SuperAppTest.t.sol
@@ -11,7 +11,7 @@ import { Handler } from "./handlers/Handler.sol";
 // app to be tested
 import { FlowSplitter } from "./FlowSplitter.sol";
 
-contract SuperAppInvariants is Test {
+abstract contract SuperAppInvariants is Test {
     ISuperfluid public host;
     ISuperApp public superApp;
     Handler public handler; // Focus test to a set of operations

diff --git a/packages/ethereum-contracts/test/foundry/superfluid/ConstantInflowNFT.t.sol b/packages/ethereum-contracts/test/foundry/superfluid/ConstantInflowNFT.t.sol
@@ -232,10 +232,10 @@ contract ConstantInflowNFTTest is FlowNFTBaseTest {
         vm.assume(_tokenOwner != address(0));
         vm.assume(_tokenOwner != _operator);
 
+        vm.startPrank(_tokenOwner);
         _assertEventApprovalForAll(address(constantInflowNFTProxy), _tokenOwner, _operator, _approved);
-
-        vm.prank(_tokenOwner);
         constantInflowNFTProxy.setApprovalForAll(_operator, _approved);
+        vm.stopPrank();
 
         _assertOperatorApprovalIsExpected(constantInflowNFTProxy, _tokenOwner, _operator, _approved);
     }

diff --git a/packages/ethereum-contracts/test/foundry/superfluid/ConstantOutflowNFT.t.sol b/packages/ethereum-contracts/test/foundry/superfluid/ConstantOutflowNFT.t.sol
@@ -272,10 +272,11 @@ contract ConstantOutflowNFTTest is FlowNFTBaseTest {
         vm.assume(_tokenOwner != address(0));
         vm.assume(_tokenOwner != _operator);
 
-        _assertEventApprovalForAll(address(constantOutflowNFTProxy), _tokenOwner, _operator, _approved);
 
-        vm.prank(_tokenOwner);
+        vm.startPrank(_tokenOwner);
+        _assertEventApprovalForAll(address(constantOutflowNFTProxy), _tokenOwner, _operator, _approved);
         constantOutflowNFTProxy.setApprovalForAll(_operator, _approved);
+        vm.stopPrank();
 
         _assertOperatorApprovalIsExpected(constantOutflowNFTProxy, _tokenOwner, _operator, _approved);
     }

diff --git a/packages/ethereum-contracts/test/foundry/superfluid/FlowNFTBase.t.sol b/packages/ethereum-contracts/test/foundry/superfluid/FlowNFTBase.t.sol
@@ -110,8 +110,6 @@ abstract contract FlowNFTBaseTest is FoundrySuperfluidTester {
         for (uint256 i = 0; i < N_TESTERS; i++) {
             superTokenMock.mintInternal(TEST_ACCOUNTS[i], INIT_SUPER_TOKEN_BALANCE, "0x", "0x");
         }
-
-        vm.prank(sf.governance.owner());
     }
 
     /*//////////////////////////////////////////////////////////////////////////

diff --git a/packages/ethereum-contracts/test/foundry/utils/TOGA.t.sol b/packages/ethereum-contracts/test/foundry/utils/TOGA.t.sol
@@ -7,6 +7,7 @@ import { ISuperToken } from "../../../contracts/superfluid/SuperToken.sol";
 import { TOGA } from "../../../contracts/utils/TOGA.sol";
 import { IERC1820Registry } from "@openzeppelin/contracts/interfaces/IERC1820Registry.sol";
 import { IERC20 } from "@openzeppelin/contracts/token/ERC20/IERC20.sol";
+import { TestToken } from "../../../contracts/utils/TestToken.sol";
 
 /**
  * @title TOGAIntegrationTest
@@ -18,7 +19,7 @@ contract TOGAIntegrationTest is FoundrySuperfluidTester {
     TOGA internal toga;
 
     uint256 internal immutable MIN_BOND_DURATION;
-    uint256 internal constant DEFAULT_BOND_AMOUNT = 1E18;
+    uint256 internal constant DEFAULT_BOND_AMOUNT = 1e18;
     IERC1820Registry internal constant _ERC1820_REG = IERC1820Registry(0x1820a4B7618BdE71Dce8cdc73aAB6C95905faD24);
 
     constructor() FoundrySuperfluidTester(5) {
@@ -53,6 +54,24 @@ contract TOGAIntegrationTest is FoundrySuperfluidTester {
         assertEq(flowRate, expectedNetFlow, "_assertNetFlow: net flow not equal");
     }
 
+    /**
+     * @dev Admin sends `amount` `superToken_` to the `target` address.
+     * @param superToken_ The Super Token representing the asset.
+     * @param target The address of the target.
+     * @param amount The amount to send.
+     */
+    function _helperDeal(ISuperToken superToken_, address target, uint256 amount) internal {
+        TestToken underlyingToken = TestToken(superToken_.getUnderlyingToken());
+        uint256 maxAmount = uint256(type(int256).max);
+        vm.startPrank(admin);
+        underlyingToken.mint(admin, maxAmount);
+        underlyingToken.approve(address(superToken_), maxAmount);
+        superToken_.transferAll(address(1));
+        superToken_.upgrade(maxAmount);
+        superToken_.transfer(target, amount);
+        vm.stopPrank();
+    }
+
     /**
      * @dev Sends a PIC bid.
      * @param sender The address of the sender.
@@ -131,7 +150,7 @@ contract TOGAIntegrationTest is FoundrySuperfluidTester {
         // setting the lower bound > 1 in order to avoid
         // failures due to the exit stream not having enough min deposit
         // (clipping related)
-        bond = bound(bond_, 1E12, INIT_SUPER_TOKEN_BALANCE);
+        bond = bound(bond_, 1e12, INIT_SUPER_TOKEN_BALANCE);
         // before allowing higher limits, also consider that
         // the values returned by toga.getMaxExitRateFor() may not be achievable in practice
         // because of the flowrate data type restriction
@@ -260,7 +279,7 @@ contract TOGAIntegrationTest is FoundrySuperfluidTester {
         prevReward = bound(prevReward, 1, bond - 1); // make sure the bond exceeds it
 
         // simulate pre-existing accumulation of rewards
-        deal(address(superToken), address(toga), prevReward);
+        _helperDeal(superToken, address(toga), prevReward);
 
         _helperSendPICBid(alice, superToken, bond, 0);
         (, uint256 aliceBond,) = toga.getCurrentPICInfo(superToken);
@@ -309,7 +328,7 @@ contract TOGAIntegrationTest is FoundrySuperfluidTester {
     function testPICClosesStream(uint256 bond) public {
         bond = _boundBondValue(bond);
 
-        _helperSendPICBid(alice, superToken, bond, 1E3);
+        _helperSendPICBid(alice, superToken, bond, 1e3);
 
         vm.warp(block.timestamp + 1000);
         _helperDeleteFlow(superToken, alice, address(toga), alice);
@@ -324,7 +343,7 @@ contract TOGAIntegrationTest is FoundrySuperfluidTester {
         _assertNetFlow(superToken, alice, 0);
 
         // bob sends a bid too
-        _helperSendPICBid(bob, superToken, bond, 1E3);
+        _helperSendPICBid(bob, superToken, bond, 1e3);
         _assertNetFlow(superToken, alice, 0);
     }
 
@@ -364,7 +383,7 @@ contract TOGAIntegrationTest is FoundrySuperfluidTester {
         assertEq(bond, 0);
 
         // accumulate some new rewards...
-        deal(address(superToken), address(toga), 1e15);
+        _helperDeal(superToken, address(toga), 1e15);
 
         (, uint256 bond2,) = toga.getCurrentPICInfo(superToken);
         assertGe(bond2, 1e12);
@@ -386,7 +405,8 @@ contract TOGAIntegrationTest is FoundrySuperfluidTester {
     function testBondAndExitRateLimits(uint256 bond, int96 exitRate) public {
         bond = bound(
             bond,
-            exitRate == 0 ? 1 : 1 << 32, // with small bonds, opening the stream can fail due to CFA deposit having a flow of 1<<32 due to clipping
+            exitRate == 0 ? 1 : 1 << 32, // with small bonds, opening the stream can fail due to CFA deposit having a
+                // flow of 1<<32 due to clipping
             uint256(type(int256).max) // SuperToken doesn't support the full uint256 range
         );
 
@@ -399,7 +419,11 @@ contract TOGAIntegrationTest is FoundrySuperfluidTester {
 
         exitRate = int96(bound(exitRate, 0, maxExitRate));
 
-        deal(address(superToken), alice, uint256(type(int256).max));
+        vm.startPrank(alice);
+        superToken.transferAll(address(1));
+        vm.stopPrank();
+
+        _helperDeal(superToken, alice, uint256(type(int256).max));
 
         _helperSendPICBid(alice, superToken, bond, exitRate);
     }
@@ -409,8 +433,8 @@ contract TOGAIntegrationTest is FoundrySuperfluidTester {
 
         (, ISuperToken superToken2) = sfDeployer.deployWrapperSuperToken("TEST2", "TEST2", 18, type(uint256).max);
 
-        deal(address(superToken2), alice, INIT_SUPER_TOKEN_BALANCE);
-        deal(address(superToken2), bob, INIT_SUPER_TOKEN_BALANCE);
+        _helperDeal(superToken2, alice, INIT_SUPER_TOKEN_BALANCE);
+        _helperDeal(superToken2, bob, INIT_SUPER_TOKEN_BALANCE);
 
         _helperSendPICBid(alice, superToken, bond, toga.getDefaultExitRateFor(superToken, bond));
         _helperSendPICBid(bob, superToken2, bond, toga.getDefaultExitRateFor(superToken, bond));

diff --git a/tasks/check-changeset.sh b/tasks/check-changeset.sh
@@ -34,67 +34,67 @@ function setBuildAll() {
 # (dependency graph implied below)
 if [ -n "$GITHUB_ENV" ];then
     # if ci workflows changed
-    if grep -E "^.github/workflows/ci.*.yml$" changed-files.list;then
+    if grep -E "^.github/workflows/ci\..*\.yml$" changed-files.list;then
         echo "CI workflows changed."
         setBuildAll
     fi
     # if call (reusable) workflows changed
-    if grep -E "^.github/workflows/call.*.yml$" changed-files.list;then
+    if grep -E "^.github/workflows/call\..*\.yml$" changed-files.list;then
         echo "Call workflows changed."
         setBuildAll
     fi
     # if root package.json changed, rebuild everything
-    if grep -E "^(package.json|yarn.lock)$" changed-files.list;then
+    if grep -E "^(flake\.nix|flake\.lock|package\.json|yarn\.lock)$" changed-files.list;then
         echo "Root package.json changed."
         setBuildAll
     fi
     # if specified ethereum-contracts folders and files changed
-    if grep -E "^packages/ethereum-contracts/(contracts/|scripts/|test/|truffle-config.js|package.json)" changed-files.list;then
+    if grep -E "^packages/ethereum-contracts/(contracts/|scripts/|test/|truffle-config\.js|package\.json)" changed-files.list;then
         BUILD_ETHEREUM_CONTRACTS=1
         BUILD_SUBGRAPH=1
         BUILD_HOT_FUZZ=1
         BUILD_AUTOMATION_CONTRACTS=1
         echo Ethereum contracts, HotFuzz and Subgraph will be tested.
     fi
     # if specified hot-fuzz folders and files changed
-    if grep -E "^packages/hot-fuzz/(contracts/|scripts/|.+.js|.+.yaml|hot-fuzz|package.json)" changed-files.list;then
+    if grep -E "^packages/hot-fuzz/(contracts/|scripts/|.+\.js|.+\.yaml|hot-fuzz|package\.json)" changed-files.list;then
         BUILD_HOT_FUZZ=1
         echo HotFuzz will be tested.
     fi
     # if specified sdk-core folders and files changed
-    if grep -E "^packages/sdk-core/(src/|test/|package.json|tsconfig.*)" changed-files.list;then
+    if grep -E "^packages/sdk-core/(src/|test/|package\.json|tsconfig\.*)" changed-files.list;then
         BUILD_SDK_CORE=1
         BUILD_SDK_REDUX=1
         BUILD_SUBGRAPH=1
         echo SDK-CORE, SDK-REDUX and SUBGRAPH will be tested.
     fi
     # if specified sdk-redux folders and files changed
-    if grep -E "^packages/sdk-redux/(src/|test/|package.json)" changed-files.list;then
+    if grep -E "^packages/sdk-redux/(src/|test/|package\.json)" changed-files.list;then
         BUILD_SDK_REDUX=1
         echo SDK-REDUX will be tested.
     fi
     # if specified subgraph folders and files changed
-    if grep -E "^packages/subgraph/(subgraph.template.yaml|schema.graphql|config|scripts|src|tasks|test|hardhat.config.ts|package.json|docker-compose.yml)" changed-files.list;then
+    if grep -E "^packages/subgraph/(subgraph\.template\.yaml|schema\.graphql|config|scripts|src|tasks|test|hardhat\.config\.ts|package\.json|docker-compose\.yml)" changed-files.list;then
         BUILD_SUBGRAPH=1
         echo Subgraph will be tested.
     fi
     # if specified haskell folders and files changed
-    if grep -E "^packages/spec-haskell/(packages/|cabal.project)" changed-files.list;then
+    if grep -E "^packages/spec-haskell/(packages/|cabal\.project)" changed-files.list;then
         BUILD_SPEC_HASKELL=1
         echo SPEC-HASKELL will be tested.
     fi
     # if specified automation-contracts/scheduler folders and files changed
-    if grep -E "^packages/automation-contracts/scheduler/(contracts/|scripts/|test/|truffle-config.js|package.json)" changed-files.list;then
+    if grep -E "^packages/automation-contracts/scheduler/(contracts/|scripts/|test/|truffle-config\.js|package\.json)" changed-files.list;then
         BUILD_AUTOMATION_CONTRACTS=1
         echo Automation Contracts will be tested.
     fi
     # if specified automation-contracts/autowrap folders and files changed
-    if grep -E "^packages/automation-contracts/autowrap/(contracts/|scripts/|test/|truffle-config.js|package.json)" changed-files.list;then
+    if grep -E "^packages/automation-contracts/autowrap/(contracts/|scripts/|test/|truffle-config\.js|package\.json)" changed-files.list;then
         BUILD_AUTOMATION_CONTRACTS=1
         echo Automation Contracts will be tested.
     fi
     # if specified solidity-semantic-money folders and files changed
-    if grep -E "^packages/solidity-semantic-money/(src/|test/|foundry.toml|Makefile|package.json)" changed-files.list;then
+    if grep -E "^packages/solidity-semantic-money/(src/|test/|foundry\.toml|Makefile|package\.json)" changed-files.list;then
         BUILD_SOLIDITY_SEMANTIC_MONEY=1
         echo Solidity semantic money will be tested.
     fi
+48 −6		.github/workflows/ci.yml
+29 −0		.github/workflows/sync.yml
+1 −1		foundry.toml
+1 −1		package.json
+5 −3		src/Base.sol
+4 −3		src/Script.sol
+10 −5		src/StdChains.sol
+195 −17		src/StdCheats.sol
+16 −1		src/StdInvariant.sol
+18 −14		src/StdJson.sol
+54 −3		src/StdStorage.sol
+2 −2		src/StdStyle.sol
+6 −0		src/StdUtils.sol
+4 −3		src/Test.sol
+497 −187		src/Vm.sol
+394 −382		src/console2.sol
+13,248 −0		src/safeconsole.sol
+93 −77		test/StdAssertions.t.sol
+112 −52		test/StdChains.t.sol
+236 −44		test/StdCheats.t.sol
+10 −10		test/StdError.t.sol
+27 −12		test/StdMath.t.sol
+66 −34		test/StdStorage.t.sol
+4 −4		test/StdStyle.t.sol
+80 −35		test/StdUtils.t.sol
+15 −0		test/Vm.t.sol