[ETHEREUM-CONTRACTS] Migrate to OpenZeppelin v5 (#2097)

Author: d10r

.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">

lib/openzeppelin-contracts

@@ -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",

package.json

@@ -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/Manager.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/contracts/strategies/StrategyBase.sol

@@ -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/foundry.toml

@@ -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/hardhat.config.js

@@ -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/package.json

@@ -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);