[ETHEREUM-CONTRACTS] Migrate to OpenZeppelin v5

.gitmodules

@@ -1,3 +1,7 @@
 [submodule "lib/forge-std"]
 	path = lib/forge-std
 	url = https://github.com/foundry-rs/forge-std
+[submodule "lib/openzeppelin-contracts"]
+	path = lib/openzeppelin-contracts
+	url = https://github.com/OpenZeppelin/openzeppelin-contracts.git
+	branch = release-v5.4

README.md

@@ -2,7 +2,7 @@
 <h1>Welcome to superfluid protocol-monorepo 👋</h1>
 
 <p>
-  <a href="#superfluid-finance/ethereum-contracts" target="_blank">
+  <a href="https://www.npmjs.com/package/@superfluid-finance/ethereum-contracts" target="_blank">
     <img alt="npm" src="https://img.shields.io/npm/v/@superfluid-finance/ethereum-contracts?label=ethereum-contracts">
   </a>
   <a href="#superfluid-finance/subgraph" target="_blank">

package.json

@@ -52,6 +52,7 @@
     },
     "scripts": {
         "prepare": "husky && npm run git-submodule:init",
+        "postinstall": "ln -fs ../lib/openzeppelin-contracts node_modules/@openzeppelin-v5",
         "lint": "run-s -l lint:*",
         "lint:syncpack": "syncpack lint",
         "lint:shellcheck": "tasks/shellcheck-all-tasks.sh",

packages/automation-contracts/autowrap/contracts/Manager.sol

@@ -31,7 +31,7 @@ contract Manager is IManager, Ownable {
         address _cfa,
         uint64 _minLower,
         uint64 _minUpper
-    ) {
+    ) Ownable(_msgSender()) {
         if (_cfa == address(0)) revert ZeroAddress();
         if (_minLower >= _minUpper) revert WrongLimits(_minLower, _minUpper);
 

packages/automation-contracts/autowrap/contracts/strategies/StrategyBase.sol

@@ -14,6 +14,8 @@ abstract contract StrategyBase is IStrategy, Ownable {
     /// @dev IStrategy.manager implementation.
     address public override manager;
 
+    constructor() Ownable(_msgSender()) { }
+
     /// @dev IStrategy.changeManager implementation.
     function changeManager(address newManager)
         external

packages/automation-contracts/autowrap/foundry.toml

@@ -9,7 +9,8 @@ optimizer_runs = 200
 remappings = [
     '@superfluid-finance/solidity-semantic-money/src/=packages/solidity-semantic-money/src/',
     '@superfluid-finance/ethereum-contracts/=packages/ethereum-contracts/',
-    '@openzeppelin/=node_modules/@openzeppelin/',
+    '@openzeppelin-v5/=lib/openzeppelin-contracts/',
+    '@openzeppelin/=lib/openzeppelin-contracts/',
     'ds-test/=lib/forge-std/lib/ds-test/src/',
     'forge-std/=lib/forge-std/src/']
 out = 'packages/automation-contracts/autowrap/out/default'

packages/automation-contracts/autowrap/hardhat.config.js

@@ -3,10 +3,22 @@ require("@nomiclabs/hardhat-ethers");
 require("@nomicfoundation/hardhat-verify");
 require("hardhat-deploy");
 require("hardhat/config");
+const {TASK_COMPILE_GET_REMAPPINGS} = require("hardhat/builtin-tasks/task-names");
 
 // You need to export an object to set up your config
 // Go to https://hardhat.org/config/ to learn more
 
+// Remapping for OpenZeppelin contracts
+subtask(TASK_COMPILE_GET_REMAPPINGS).setAction(
+    async (_, __, runSuper) => {
+        const remappings = await runSuper();
+        return {
+            ...remappings,
+            "@openzeppelin/contracts/": "@openzeppelin-v5/contracts/",
+        };
+    }
+);
+
 /**
  * @type import('hardhat/config').HardhatUserConfig
  */

packages/automation-contracts/autowrap/package.json

@@ -3,7 +3,6 @@
     "description": "Open contracts that allow upgrading underlying token to supertokens based on running stream",
     "version": "0.3.0",
     "devDependencies": {
-        "@openzeppelin/contracts": "^4.9.6",
         "@superfluid-finance/ethereum-contracts": "^1.13.0",
         "@superfluid-finance/metadata": "^1.6.2"
     },

packages/automation-contracts/autowrap/test/Manager.t.sol

@@ -1,5 +1,6 @@
 // SPDX-License-Identifier: UNLICENSED
 pragma solidity ^0.8.0;
+import { Ownable } from "@openzeppelin/contracts/access/Ownable.sol";
 import { ISuperToken } from "@superfluid-finance/ethereum-contracts/contracts/superfluid/SuperToken.sol";
 import { SuperTokenV1Library } from "@superfluid-finance/ethereum-contracts/contracts/apps/SuperTokenV1Library.sol";
 import { FoundrySuperfluidTester } from "@superfluid-finance/ethereum-contracts/test/foundry/FoundrySuperfluidTester.t.sol";
@@ -108,7 +109,7 @@ contract ManagerTests is FoundrySuperfluidTester {
         vm.prank(admin);
         manager.setLimits(newMinLower, newMinUpper);
         // non owner can't set new limits
-        vm.expectRevert(bytes("Ownable: caller is not the owner"));
+        vm.expectRevert(abi.encodeWithSelector(Ownable.OwnableUnauthorizedAccount.selector, address(this)));
         manager.setLimits(newMinLower, newMinUpper);
     }
 
@@ -124,7 +125,7 @@ contract ManagerTests is FoundrySuperfluidTester {
         manager.addApprovedStrategy(address(wrapStrategy));
         vm.stopPrank();
         // non owner can't add new strategy
-        vm.expectRevert(bytes("Ownable: caller is not the owner"));
+        vm.expectRevert(abi.encodeWithSelector(Ownable.OwnableUnauthorizedAccount.selector, address(this)));
         manager.addApprovedStrategy(address(wrapStrategy));
         bool isStrategyApproved = manager.approvedStrategies(address(wrapStrategy));
         assertTrue(isStrategyApproved, "strategy should be register");
@@ -135,7 +136,7 @@ contract ManagerTests is FoundrySuperfluidTester {
         //add strategy to be removed
         manager.addApprovedStrategy(address(wrapStrategy));
         // non owner can't add new strategy
-        vm.expectRevert(bytes("Ownable: caller is not the owner"));
+        vm.expectRevert(abi.encodeWithSelector(Ownable.OwnableUnauthorizedAccount.selector, address(this)));
         manager.removeApprovedStrategy(address(wrapStrategy));
         vm.startPrank(admin);
         vm.expectEmit(true, true, true, true);

packages/automation-contracts/autowrap/test/WrapStrategy.t.sol

@@ -1,6 +1,7 @@
 // SPDX-License-Identifier: UNLICENSED
 pragma solidity ^0.8.0;
 
+import { Ownable } from "@openzeppelin/contracts/access/Ownable.sol";
 import { ISuperToken } from "@superfluid-finance/ethereum-contracts/contracts/superfluid/SuperToken.sol";
 import { SuperTokenV1Library } from "@superfluid-finance/ethereum-contracts/contracts/apps/SuperTokenV1Library.sol";
 import { FoundrySuperfluidTester } from "@superfluid-finance/ethereum-contracts/test/foundry/FoundrySuperfluidTester.t.sol";
@@ -75,7 +76,7 @@ contract WrapStrategyTests is FoundrySuperfluidTester {
     function testCannotChangeManagerContractIfNotOwner() public {
         Manager newManager = new Manager(address(sf.cfa), MIN_LOWER, MIN_UPPER);
         vm.prank(admin);
-        vm.expectRevert(bytes("Ownable: caller is not the owner"));
+        vm.expectRevert(abi.encodeWithSelector(Ownable.OwnableUnauthorizedAccount.selector, admin));
         wrapStrategy.changeManager(address(newManager));
     }
 

packages/automation-contracts/scheduler/contracts/VestingSchedulerV2.sol

@@ -7,7 +7,6 @@ import {
 import { SuperAppBase } from "@superfluid-finance/ethereum-contracts/contracts/apps/SuperAppBase.sol";
 import { SuperTokenV1Library } from "@superfluid-finance/ethereum-contracts/contracts/apps/SuperTokenV1Library.sol";
 import { IVestingSchedulerV2 } from "./interface/IVestingSchedulerV2.sol";
-import { SafeMath } from "@openzeppelin/contracts/utils/math/SafeMath.sol";
 import { SafeCast } from "@openzeppelin/contracts/utils/math/SafeCast.sol";
 
 contract VestingSchedulerV2 is IVestingSchedulerV2, SuperAppBase {
@@ -221,10 +220,7 @@ contract VestingSchedulerV2 is IVestingSchedulerV2, SuperAppBase {
                 remainderAmount: remainderAmount
             });
         } else {
-            uint256 cliffAmount = SafeMath.mul(
-                cliffPeriod,
-                SafeCast.toUint256(flowRate)
-            );
+            uint256 cliffAmount = cliffPeriod * SafeCast.toUint256(flowRate);
             params = ScheduleCreationParams({
                 superToken: superToken,
                 sender: sender,

packages/automation-contracts/scheduler/contracts/VestingSchedulerV3.sol

@@ -3,7 +3,6 @@
 pragma solidity ^0.8.0;
 
 /// @dev OpenZeppelin Imports
-import {SafeMath} from "@openzeppelin/contracts/utils/math/SafeMath.sol";
 import {SafeCast} from "@openzeppelin/contracts/utils/math/SafeCast.sol";
 
 /// @dev Superfluid Protocol Imports
@@ -532,7 +531,7 @@ contract VestingSchedulerV3 is IVestingSchedulerV3, IRelayRecipient {
                 });
             } else {
                 // Linear Default Cliff (calculated based on the overall vesting flow rate)
-                cliffAmount = SafeMath.mul(cliffPeriod, SafeCast.toUint256(flowRate));
+                cliffAmount = cliffPeriod * SafeCast.toUint256(flowRate);
                 params = ScheduleCreationParams({
                     superToken: superToken,
                     sender: sender,

packages/automation-contracts/scheduler/foundry.toml

@@ -9,7 +9,8 @@ optimizer_runs = 200
 remappings = [
     '@superfluid-finance/solidity-semantic-money/src/=packages/solidity-semantic-money/src/',
     '@superfluid-finance/ethereum-contracts/=packages/ethereum-contracts/',
-    '@openzeppelin/=node_modules/@openzeppelin/',
+    '@openzeppelin-v5/=lib/openzeppelin-contracts/',
+    '@openzeppelin/=lib/openzeppelin-contracts/',
     'ds-test/=lib/forge-std/lib/ds-test/src/',
     'forge-std/=lib/forge-std/src/']
 out = 'packages/automation-contracts/scheduler/out/default'

packages/automation-contracts/scheduler/hardhat.config.js

@@ -3,10 +3,22 @@ require("@nomiclabs/hardhat-ethers");
 require("@nomicfoundation/hardhat-verify");
 require("hardhat-deploy");
 require("hardhat/config");
+const {TASK_COMPILE_GET_REMAPPINGS} = require("hardhat/builtin-tasks/task-names");
 
 // You need to export an object to set up your config
 // Go to https://hardhat.org/config/ to learn more
 
+// Remapping for OpenZeppelin contracts
+subtask(TASK_COMPILE_GET_REMAPPINGS).setAction(
+    async (_, __, runSuper) => {
+        const remappings = await runSuper();
+        return {
+            ...remappings,
+            "@openzeppelin/contracts/": "@openzeppelin-v5/contracts/",
+        };
+    }
+);
+
 /**
  * @type import('hardhat/config').HardhatUserConfig
  */

packages/automation-contracts/scheduler/package.json

@@ -3,7 +3,6 @@
     "description": "Open contracts that allow scheduling streams and vestings onchain",
     "version": "1.3.0",
     "devDependencies": {
-        "@openzeppelin/contracts": "^4.9.6",
         "@superfluid-finance/ethereum-contracts": "^1.13.0",
         "@superfluid-finance/metadata": "^1.6.2"
     },

packages/automation-contracts/scheduler/test/VestingSchedulerV2.t.sol

@@ -7,7 +7,6 @@ import { IVestingSchedulerV2 } from "./../contracts/interface/IVestingSchedulerV
 import { VestingSchedulerV2 } from "./../contracts/VestingSchedulerV2.sol";
 import { FoundrySuperfluidTester } from "@superfluid-finance/ethereum-contracts/test/foundry/FoundrySuperfluidTester.t.sol";
 import { SuperTokenV1Library } from "@superfluid-finance/ethereum-contracts/contracts/apps/SuperTokenV1Library.sol";
-import { SafeMath } from "@openzeppelin/contracts/utils/math/SafeMath.sol";
 import { SafeCast } from "@openzeppelin/contracts/utils/math/SafeCast.sol";
 import "forge-std/console.sol";
 
@@ -899,7 +898,7 @@ contract VestingSchedulerV2Tests is FoundrySuperfluidTester {
         );
 
         console.log("Revert with overflow.");
-        vm.expectRevert("SafeCast: value doesn't fit in 96 bits");
+        vm.expectRevert(); // SafeCastOverflowedIntDowncast
         vestingScheduler.createVestingScheduleFromAmountAndDuration(
             superToken,
             bob,
@@ -1961,7 +1960,7 @@ contract VestingSchedulerV2Tests is FoundrySuperfluidTester {
         );
 
         console.log("Revert with overflow.");
-        vm.expectRevert("SafeCast: value doesn't fit in 96 bits"); 
+        vm.expectRevert(); // SafeCastOverflowedIntDowncast
         vestingScheduler.createVestingScheduleFromAmountAndDuration(
             superToken,
             bob,

packages/automation-contracts/scheduler/test/VestingSchedulerV3.t.sol

@@ -1105,7 +1105,7 @@ contract VestingSchedulerV3Tests is FoundrySuperfluidTester {
         );
 
         console.log("Revert with overflow.");
-        vm.expectRevert("SafeCast: value doesn't fit in 96 bits");
+        vm.expectRevert(); // SafeCastOverflowedIntDowncast
         vestingScheduler.createVestingScheduleFromAmountAndDuration(
             superToken,
             bob,
@@ -2189,7 +2189,7 @@ contract VestingSchedulerV3Tests is FoundrySuperfluidTester {
         );
 
         console.log("Revert with overflow.");
-        vm.expectRevert("SafeCast: value doesn't fit in 96 bits");
+        vm.expectRevert(); // SafeCastOverflowedIntDowncast
         vestingScheduler.createVestingScheduleFromAmountAndDuration(
             superToken,
             bob,

packages/ethereum-contracts/CHANGELOG.md

@@ -20,6 +20,24 @@ This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.htm
 - `ISuperfluidPool`: `getClaimable` and `getClaimableNow` could previously return non-zero values for connected pools, which was inconsistent with what `claimAll` would actually do in this situation (claim nothing).
 
 ### Breaking
+- Updated OpenZeppelin library from v.4.9.6 to v5.4.0.
+The import path now includes the major version, making it easier for contracts integrating with this protocol to use a different major version of OpenZeppelin.
+Projects using Superfluid contracts as a dependency need to configure a mapping:
+  - Foundry: add this to remappings: `'@openzeppelin-v5/=lib/openzeppelin-contracts/',`
+  - Hardhat (>=v2.17.2): add `@openzeppelin/contracts` as a project dependency and a subtask in your hardhat config:
+```
+import { TASK_COMPILE_GET_REMAPPINGS } from "hardhat/builtin-tasks/task-names";
+
+subtask(TASK_COMPILE_GET_REMAPPINGS).setAction(
+    async (_, __, runSuper) => {
+        const remappings = await runSuper();
+        return {
+            ...remappings,
+            "@openzeppelin-v5/contracts/": "@openzeppelin/contracts/",
+        };
+    }
+);
+```
 - PoolMemberNFT pruning: `IPoolMemberNFT` and `PoolMemberNFT` removed, `POOL_MEMBER_NFT()` removed from `ISuperToken`.
 
 ## [v1.13.0]

packages/ethereum-contracts/README.md

@@ -39,21 +39,76 @@ Prerequisites:
 - [yarn](https://classic.yarnpkg.com/en/docs/install)
 - [forge](https://book.getfoundry.sh/getting-started/installation)
 
-Once you have set up your project, cd into its base directory and add the npm package:
+Once you have set up your project, cd into its base directory and add the package:
 
-##### hardhat
+#### hardhat
 ```sh
 $ yarn add @superfluid-finance/ethereum-contracts
 ```
 
-##### foundry
+#### foundry
 
 ```sh
 $ forge install superfluid-protocol-monorepo=superfluid-finance/protocol-monorepo@dev
 $ # or using ethereum-contracts@v1.6.0
 $ forge install superfluid-protocol-monorepo=superfluid-finance/protocol-monorepo@$(git ls-remote https://github.com/superfluid-finance/protocol-monorepo.git ethereum-contracts@v1.6.0 | awk '{print $1}')
 ```
 
+### Dependencies
+
+Next you need to satisfy the OpenZeppelin contracts dependency v5 of the Superfluid contracts.
+How to do that depends on your project's setup.
+
+#### foundry
+
+**Your project uses OZ v5**
+
+If your project already uses OZ v5, just add a remapping in your `foundry.toml` or `remappings.txt` file:
+```
+@openzeppelin-v5/=lib/openzeppelin-contracts/
+```
+(adjust the path to the openzeppelin-contracts directory in your project)
+
+**Your project doesn't use OZ v5**
+
+Install the v5 package:
+```
+forge install openzeppelin-contracts-v5=https://github.com/OpenZeppelin/openzeppelin-contracts@release-v5.5
+```
+and add a remapping in your `foundry.toml` or `remappings.txt` file:
+```
+@openzeppelin-v5/=lib/openzeppelin-contracts-v5/
+```
+
+#### hardhat
+
+**Your project uses OZ v5**
+
+If you have the npm package `@openzeppelin/contracts` v5 installed, instruct hardhat to use it via a remapping, by adding this to your `hardhat.config.[js|ts]` file:
+```
+const {TASK_COMPILE_GET_REMAPPINGS} = require("hardhat/builtin-tasks/task-names");
+
+subtask(TASK_COMPILE_GET_REMAPPINGS).setAction(
+    async (_, __, runSuper) => {
+        const remappings = await runSuper();
+        return {
+            ...remappings,
+            "@openzeppelin-v5/contracts/": "@openzeppelin/contracts/",
+        };
+    }
+);
+```
+Note: this requires hardat v2.17.2 or higher.
+
+**Your project doesn't use OZ v5**
+
+If your project doesn't use `@openzeppelin/contracts` v5, or uses another version you want to stick to, you can install the v5 package in a custom path, by adding this to the section `dependencies` in your `package.json` file:
+```
+"@openzeppelin-v5/contracts": "npm:@openzeppelin/contracts@5"
+```
+
+In this case you don't need to add a remapping to your hardhat config.
+
 ### Smart Contract
 
 You can then import Superfluid interfaces or contracts into your contracts like this:

packages/ethereum-contracts/contracts/agreements/AgreementLibrary.sol

@@ -9,7 +9,7 @@ import {
 } from "../interfaces/superfluid/ISuperfluid.sol";
 import { ISuperfluidToken } from "../interfaces/superfluid/ISuperfluidToken.sol";
 
-import { SafeCast } from "@openzeppelin/contracts/utils/math/SafeCast.sol";
+import { SafeCast } from "@openzeppelin-v5/contracts/utils/math/SafeCast.sol";
 
 
 /**

packages/ethereum-contracts/contracts/agreements/ConstantFlowAgreementV1.sol

@@ -13,7 +13,7 @@ import {
     SuperfluidGovernanceConfigs
 } from "../interfaces/superfluid/ISuperfluid.sol";
 import { AgreementBase } from "./AgreementBase.sol";
-import { SafeCast } from "@openzeppelin/contracts/utils/math/SafeCast.sol";
+import { SafeCast } from "@openzeppelin-v5/contracts/utils/math/SafeCast.sol";
 import { AgreementLibrary } from "./AgreementLibrary.sol";
 import { SolvencyHelperLibrary } from "../libs/SolvencyHelperLibrary.sol";
 

packages/ethereum-contracts/contracts/agreements/InstantDistributionAgreementV1.sol

@@ -1,7 +1,7 @@
 // SPDX-License-Identifier: AGPLv3
 pragma solidity ^0.8.23;
 
-import { SafeCast } from "@openzeppelin/contracts/utils/math/SafeCast.sol";
+import { SafeCast } from "@openzeppelin-v5/contracts/utils/math/SafeCast.sol";
 
 import {
     IInstantDistributionAgreementV1, ISuperfluidToken

packages/ethereum-contracts/contracts/agreements/gdav1/GDAv1StorageLayout.sol

@@ -1,7 +1,7 @@
 // SPDX-License-Identifier: AGPLv3
 pragma solidity ^0.8.23;
 // open-zeppelin
-import { SafeCast } from "@openzeppelin/contracts/utils/math/SafeCast.sol";
+import { SafeCast } from "@openzeppelin-v5/contracts/utils/math/SafeCast.sol";
 // semantic-money
 import {
     BasicParticle,