superfluid-org · d10r · Mar 11, 2025 · Mar 11, 2025 · Mar 11, 2025 · Mar 11, 2025
diff --git a/packages/automation-contracts/autowrap/foundry.toml b/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/contracts/=node_modules/@openzeppelin/contracts-v4/',
+    '@openzeppelin/contracts-v4/=node_modules/@openzeppelin/contracts-v4/',
     'ds-test/=lib/forge-std/lib/ds-test/src/',
     'forge-std/=lib/forge-std/src/']
 out = 'packages/automation-contracts/autowrap/out/default'

diff --git a/packages/automation-contracts/scheduler/foundry.toml b/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/contracts/=node_modules/@openzeppelin/contracts-v4/',
+    '@openzeppelin/contracts-v4/=node_modules/@openzeppelin/contracts-v4/',
     'ds-test/=lib/forge-std/lib/ds-test/src/',
     'forge-std/=lib/forge-std/src/']
 out = 'packages/automation-contracts/scheduler/out/default'

@@ -3,6 +3,23 @@ All notable changes to the ethereum-contracts will be documented in this file.
 
 This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [v1.13.0]
+
+### Breaking
+
+The npm dependency @openzeppelin/contracts is now mapped to the path `@openzeppelin/contracts-v4`.
+This frees up the default path `@openzeppelin/contracts` for v5 which most new Solidity projects use.
+
+In an existing foundry project, you will need to add this remapping:
+```
+@openzeppelin/contracts-v4/=lib/openzeppelin-contracts-v4/contracts/
+```
+
+In an existing hardhat project, just update the package.
+In this case, if you are using openzeppelin v4 in your own contracts too, you may want to also change the import paths to `@openzeppelin/contracts-v4/`.
+
+For more details, consult the updated `README.md` (section _Installation_).^
+
 ## [v1.12.1]
 
 ### Added

@@ -28,40 +28,58 @@
 
 ## Usage
 
-If you're building a dapp using existing protocol or Super Token contracts, then you should use [`@superfluid-finance/sdk-core`](/packages/sdk-core). [Here](https://docs.superfluid.finance/superfluid/networks/networks) you can find a list of networks where the Superfluid protocol is already deployed.
-
-If you're building a smart contract that uses Superfluid protocol, or even your own [SuperApp](https://docs.superfluid.finance/), then great! This is definitely the place to be.
+[Here](https://explorer.superfluid.org/protocol) you can find a list of networks where the Superfluid protocol is already deployed.
 
 ### Installation
 
+Once you have set up your project, cd into its base directory and add the npm package:
+
+#### foundry
+
 Prerequisites:
-- [node.js v18+](https://nodejs.org/en/download). The project recommends 22, and is tested with node 18,20,22.
-- [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:
+Install dependencies:
+```sh
+forge install superfluid-protocol-monorepo=superfluid-finance/protocol-monorepo@dev --no-commit
+forge install openzeppelin-contracts-v4=https://github.com/OpenZeppelin/[email protected] --no-commit
+```
 
-##### hardhat
+Set up remappings:
 ```sh
-$ yarn add @superfluid-finance/ethereum-contracts
+echo -e "@superfluid-finance/=lib/superfluid-protocol-monorepo/packages/\n@openzeppelin/contracts-v4/=lib/openzeppelin-contracts-v4/contracts/" >> remappings.txt
 ```
 
-##### foundry
+If you want to use **openzeppelin v4** in your project's contracts, you should either:
+- use the custom import path `@openzeppelin/contracts-v4` in your contracts
+or
+- add a remapping for the default import path: `@openzeppelin/contracts/=lib/openzeppelin-contracts-v4/contracts/`
 
+If you want to use **openzeppelin v5** in your project's contracts, you can use it alongside the v4 needed by Superfluid.
+
+#### hardhat
+
+Prerequisites:
+- [node.js v18+](https://nodejs.org/en/download). The project recommends v22, and is tested with versions 18,20,22.
+- [yarn](https://classic.yarnpkg.com/en/docs/install) or any other node package manager of your choice.
+
+Install dependencies:
 ```sh
-$ forge install superfluid-protocol-monorepo=superfluid-finance/protocol-monorepo@dev
-$ # or using [email protected]
-$ forge install superfluid-protocol-monorepo=superfluid-finance/protocol-monorepo@$(git ls-remote https://github.com/superfluid-finance/protocol-monorepo.git [email protected] | awk '{print $1}')
+yarn add @superfluid-finance/ethereum-contracts
 ```
 
+If you want to use **openzeppelin v4** in your project's contracts, we recommend using the package installed as a nested dependency of this package, using the import path `@openzeppelin/contracts-v4/`.
+
+If you want to use **openzeppelin v5** in your project's contracts, you need to add the dependency yourself and can use it at the default import path `@openzeppelin/contracts/`.
+
 ### Smart Contract
 
 You can then import Superfluid interfaces or contracts into your contracts like this:
 
 ```js
-import { IConstantFlowAgreementV1 } from "@superfluid-finance/ethereum-contracts/contracts/interfaces/agreements/IConstantFlowAgreementV1.sol";
+import { IConstantFlowAgreementV1 } from "@superfluid-finance/ethereum-contracts/contracts/interfaces/superfluid/ISuperfluid.sol";
 ```
-The paths in the npm package are the same as in this repository.
+(Most interfaces belonging to the Superfluid protocol can be imported from `ISuperfluid.sol`)
 
 ### Writing Tests
 

@@ -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/contracts-v4/utils/math/SafeCast.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/contracts-v4/utils/math/SafeCast.sol";
 import { AgreementLibrary } from "./AgreementLibrary.sol";
 import { SolvencyHelperLibrary } from "../libs/SolvencyHelperLibrary.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/contracts-v4/utils/math/SafeCast.sol";
 
 import {
     IInstantDistributionAgreementV1, ISuperfluidToken

@@ -2,7 +2,7 @@
 // solhint-disable not-rely-on-time
 pragma solidity ^0.8.23;
 
-import { SafeCast } from "@openzeppelin/contracts/utils/math/SafeCast.sol";
+import { SafeCast } from "@openzeppelin/contracts-v4/utils/math/SafeCast.sol";
 
 import { ISuperfluid, ISuperfluidGovernance } from "../../interfaces/superfluid/ISuperfluid.sol";
 import {

@@ -1,7 +1,7 @@
 // SPDX-License-Identifier: AGPLv3
 pragma solidity ^0.8.23;
 
-import { IERC721Metadata } from "@openzeppelin/contracts/token/ERC721/extensions/IERC721Metadata.sol";
+import { IERC721Metadata } from "@openzeppelin/contracts-v4/token/ERC721/extensions/IERC721Metadata.sol";
 import { IPoolAdminNFT } from "../../interfaces/agreements/gdav1/IPoolAdminNFT.sol";
 import { PoolNFTBase } from "./PoolNFTBase.sol";
 import { IGeneralDistributionAgreementV1, ISuperfluid } from "../../interfaces/superfluid/ISuperfluid.sol";

@@ -1,7 +1,7 @@
 // SPDX-License-Identifier: AGPLv3
 pragma solidity ^0.8.23;
 
-import { IERC721Metadata } from "@openzeppelin/contracts/token/ERC721/extensions/IERC721Metadata.sol";
+import { IERC721Metadata } from "@openzeppelin/contracts-v4/token/ERC721/extensions/IERC721Metadata.sol";
 import { IPoolMemberNFT } from "../../interfaces/agreements/gdav1/IPoolMemberNFT.sol";
 import { PoolNFTBase } from "./PoolNFTBase.sol";
 import { IGeneralDistributionAgreementV1, ISuperfluid } from "../../interfaces/superfluid/ISuperfluid.sol";

@@ -6,7 +6,10 @@ pragma solidity ^0.8.23;
 
 // Notes: We use these interfaces in natspec documentation below, grep @inheritdoc
 // solhint-disable-next-line no-unused-import
-import { IERC165, IERC721, IERC721Metadata } from "@openzeppelin/contracts/token/ERC721/extensions/IERC721Metadata.sol";
+import {
+    IERC165,
+    IERC721
+} from "@openzeppelin/contracts-v4/token/ERC721/extensions/IERC721Metadata.sol";
 import { UUPSProxiable } from "../../upgradability/UUPSProxiable.sol";
 import { IGeneralDistributionAgreementV1, ISuperfluid } from "../../interfaces/superfluid/ISuperfluid.sol";
 import { ISuperTokenFactory } from "../../interfaces/superfluid/ISuperTokenFactory.sol";

@@ -4,8 +4,8 @@ pragma solidity ^0.8.23;
 
 // Notes: We use these interfaces in natspec documentation below, grep @inheritdoc
 // solhint-disable-next-line no-unused-import
-import { IERC20, IERC20Metadata } from "@openzeppelin/contracts/token/ERC20/extensions/IERC20Metadata.sol";
-import { SafeCast } from "@openzeppelin/contracts/utils/math/SafeCast.sol";
+import { IERC20, IERC20Metadata } from "@openzeppelin/contracts-v4/token/ERC20/extensions/IERC20Metadata.sol";
+import { SafeCast } from "@openzeppelin/contracts-v4/utils/math/SafeCast.sol";
 import {
     BasicParticle,
     SemanticMoney,

@@ -1,7 +1,7 @@
 // SPDX-License-Identifier: AGPLv3
 pragma solidity ^0.8.23;
 
-import { BeaconProxy } from "@openzeppelin/contracts/proxy/beacon/BeaconProxy.sol";
+import { BeaconProxy } from "@openzeppelin/contracts-v4/proxy/beacon/BeaconProxy.sol";
 import { ISuperfluidToken } from "../../interfaces/superfluid/ISuperfluidToken.sol";
 import { SuperfluidPool } from "./SuperfluidPool.sol";
 import { PoolConfig, PoolERC20Metadata } from "../../interfaces/agreements/gdav1/IGeneralDistributionAgreementV1.sol";

@@ -2,7 +2,7 @@
 pragma solidity ^0.8.23;
 
 import { UUPSProxy } from "../upgradability/UUPSProxy.sol";
-import { Ownable } from "@openzeppelin/contracts/access/Ownable.sol";
+import { Ownable } from "@openzeppelin/contracts-v4/access/Ownable.sol";
 import { UUPSProxiable } from "../upgradability/UUPSProxiable.sol";
 import { SuperfluidGovernanceBase } from "./SuperfluidGovernanceBase.sol";
 import { ISuperfluid } from "../interfaces/superfluid/ISuperfluid.sol";

@@ -1,7 +1,7 @@
 // SPDX-License-Identifier: AGPLv3
 pragma solidity >=0.8.4;
 
-import { IERC721Metadata } from "@openzeppelin/contracts/token/ERC721/extensions/IERC721Metadata.sol";
+import { IERC721Metadata } from "@openzeppelin/contracts-v4/token/ERC721/extensions/IERC721Metadata.sol";
 
 interface IPoolNFTBase is IERC721Metadata {
     error POOL_NFT_APPROVE_TO_CALLER();                             // 0x9212b333

@@ -1,7 +1,7 @@
 // SPDX-License-Identifier: AGPLv3
 pragma solidity >=0.8.4;
 
-import { IERC20, IERC20Metadata } from "@openzeppelin/contracts/token/ERC20/extensions/IERC20Metadata.sol";
+import { IERC20, IERC20Metadata } from "@openzeppelin/contracts-v4/token/ERC20/extensions/IERC20Metadata.sol";
 import { ISuperfluidToken } from "../../superfluid/ISuperfluidToken.sol";
 
 /**

@@ -2,8 +2,8 @@
 pragma solidity >= 0.8.11;
 
 import { ISuperfluidToken } from "./ISuperfluidToken.sol";
-import { IERC20, IERC20Metadata } from "@openzeppelin/contracts/token/ERC20/extensions/IERC20Metadata.sol";
-import { IERC777 } from "@openzeppelin/contracts/token/ERC777/IERC777.sol";
+import { IERC20, IERC20Metadata } from "@openzeppelin/contracts-v4/token/ERC20/extensions/IERC20Metadata.sol";
+import { IERC777 } from "@openzeppelin/contracts-v4/token/ERC777/IERC777.sol";
 import { IPoolAdminNFT } from "../agreements/gdav1/IPoolAdminNFT.sol";
 import { IPoolMemberNFT } from "../agreements/gdav1/IPoolMemberNFT.sol";
 

@@ -1,7 +1,7 @@
 // SPDX-License-Identifier: MIT
 pragma solidity >= 0.8.11;
 
-import { IERC20Metadata } from "@openzeppelin/contracts/token/ERC20/extensions/IERC20Metadata.sol";
+import { IERC20Metadata } from "@openzeppelin/contracts-v4/token/ERC20/extensions/IERC20Metadata.sol";
 import { ISuperToken } from "./ISuperToken.sol";
 /**
  * @title Super token factory interface

@@ -16,8 +16,8 @@ import {
 } from "./Definitions.sol";
 /// Super token related interfaces:
 /// Note: CustomSuperTokenBase is not included for people building CustomSuperToken.
-import { IERC20, IERC20Metadata } from "@openzeppelin/contracts/token/ERC20/extensions/IERC20Metadata.sol";
-import { IERC777 } from "@openzeppelin/contracts/token/ERC777/IERC777.sol";
+import { IERC20, IERC20Metadata } from "@openzeppelin/contracts-v4/token/ERC20/extensions/IERC20Metadata.sol";
+import { IERC777 } from "@openzeppelin/contracts-v4/token/ERC777/IERC777.sol";
 import { ISuperfluidToken } from "./ISuperfluidToken.sol";
 import { ISuperToken } from "./ISuperToken.sol";
 import { ISuperTokenFactory } from "./ISuperTokenFactory.sol";

@@ -1,7 +1,7 @@
 // SPDX-License-Identifier: AGPLv3
 pragma solidity ^0.8.23;
 
-import { IERC1820Registry } from "@openzeppelin/contracts/utils/introspection/IERC1820Registry.sol";
+import { IERC1820Registry } from "@openzeppelin/contracts-v4/utils/introspection/IERC1820Registry.sol";
 
 /**
  * @title ERC777 helper library

@@ -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/contracts-v4/utils/math/SafeCast.sol";
 
 import {
     ISuperfluid,

@@ -1,15 +1,15 @@
 // SPDX-License-Identifier: AGPLv3
 pragma solidity ^0.8.23;
 
-import { Context } from "@openzeppelin/contracts/utils/Context.sol";
-import { IERC20 } from "@openzeppelin/contracts/token/ERC20/IERC20.sol";
-import { IERC777 } from "@openzeppelin/contracts/token/ERC777/IERC777.sol";
-import { IERC777Sender } from "@openzeppelin/contracts/token/ERC777/IERC777Sender.sol";
-import { IERC777Recipient } from "@openzeppelin/contracts/token/ERC777/IERC777Recipient.sol";
-import { IERC1820Registry } from "@openzeppelin/contracts/utils/introspection/IERC1820Registry.sol";
+import { Context } from "@openzeppelin/contracts-v4/utils/Context.sol";
+import { IERC20 } from "@openzeppelin/contracts-v4/token/ERC20/IERC20.sol";
+import { IERC777 } from "@openzeppelin/contracts-v4/token/ERC777/IERC777.sol";
+import { IERC777Sender } from "@openzeppelin/contracts-v4/token/ERC777/IERC777Sender.sol";
+import { IERC777Recipient } from "@openzeppelin/contracts-v4/token/ERC777/IERC777Recipient.sol";
+import { IERC1820Registry } from "@openzeppelin/contracts-v4/utils/introspection/IERC1820Registry.sol";
 import {
     ERC1820Implementer, IERC1820Implementer
-} from "@openzeppelin/contracts/utils/introspection/ERC1820Implementer.sol";
+} from "@openzeppelin/contracts-v4/utils/introspection/ERC1820Implementer.sol";
 
 import { ISuperToken } from "../superfluid/SuperToken.sol";
 

@@ -1,7 +1,7 @@
 // SPDX-License-Identifier: AGPLv3
 pragma solidity ^0.8.23;
 
-import { SafeERC20 } from "@openzeppelin/contracts/token/ERC20/utils/SafeERC20.sol";
+import { SafeERC20 } from "@openzeppelin/contracts-v4/token/ERC20/utils/SafeERC20.sol";
 
 import {
     ISuperfluid, IERC20, IPoolAdminNFT, IPoolMemberNFT

@@ -2,7 +2,7 @@
 pragma solidity ^0.8.23;
 
 import { ISuperTokenFactory } from "../interfaces/superfluid/ISuperTokenFactory.sol";
-import { Proxy } from "@openzeppelin/contracts/proxy/Proxy.sol";
+import { Proxy } from "@openzeppelin/contracts-v4/proxy/Proxy.sol";
 
 
 /**

@@ -14,12 +14,12 @@ import {
 } from "../interfaces/superfluid/ISuperfluid.sol";
 import { SuperfluidToken } from "./SuperfluidToken.sol";
 import { ERC777Helper } from "../libs/ERC777Helper.sol";
-import { SafeERC20 } from "@openzeppelin/contracts/token/ERC20/utils/SafeERC20.sol";
-import { SafeMath } from "@openzeppelin/contracts/utils/math/SafeMath.sol";
-import { SafeCast } from "@openzeppelin/contracts/utils/math/SafeCast.sol";
-import { IERC777Recipient } from "@openzeppelin/contracts/token/ERC777/IERC777Recipient.sol";
-import { IERC777Sender } from "@openzeppelin/contracts/token/ERC777/IERC777Sender.sol";
-import { Address } from "@openzeppelin/contracts/utils/Address.sol";
+import { SafeERC20 } from "@openzeppelin/contracts-v4/token/ERC20/utils/SafeERC20.sol";
+import { SafeMath } from "@openzeppelin/contracts-v4/utils/math/SafeMath.sol";
+import { SafeCast } from "@openzeppelin/contracts-v4/utils/math/SafeCast.sol";
+import { IERC777Recipient } from "@openzeppelin/contracts-v4/token/ERC777/IERC777Recipient.sol";
+import { IERC777Sender } from "@openzeppelin/contracts-v4/token/ERC777/IERC777Sender.sol";
+import { Address } from "@openzeppelin/contracts-v4/utils/Address.sol";
 
 // placeholder types needed as an intermediate step before complete removal of FlowNFTs
 // solhint-disable-next-line no-empty-blocks

@@ -1,8 +1,8 @@
 // SPDX-License-Identifier: AGPLv3
 pragma solidity ^0.8.23;
 
-import { IERC20Metadata } from "@openzeppelin/contracts/token/ERC20/extensions/IERC20Metadata.sol";
-import { Ownable } from "@openzeppelin/contracts/access/Ownable.sol";
+import { IERC20Metadata } from "@openzeppelin/contracts-v4/token/ERC20/extensions/IERC20Metadata.sol";
+import { Ownable } from "@openzeppelin/contracts-v4/access/Ownable.sol";
 import {
     ISuperTokenFactory,
     ISuperToken

@@ -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/contracts-v4/utils/math/SafeCast.sol";
 import { UUPSProxiable } from "../upgradability/UUPSProxiable.sol";
 import { UUPSProxy } from "../upgradability/UUPSProxy.sol";
 

@@ -1,8 +1,8 @@
 // SPDX-License-Identifier: AGPLv3
 pragma solidity ^0.8.23;
 
-import { IERC20 } from "@openzeppelin/contracts/token/ERC20/IERC20.sol";
-import { SafeCast } from "@openzeppelin/contracts/utils/math/SafeCast.sol";
+import { IERC20 } from "@openzeppelin/contracts-v4/token/ERC20/IERC20.sol";
+import { SafeCast } from "@openzeppelin/contracts-v4/utils/math/SafeCast.sol";
 import {
     ISuperfluid,
     ISuperAgreement,

@@ -8,7 +8,7 @@ import {
 from "../interfaces/superfluid/CustomSuperTokenBase.sol";
 import { IPureSuperTokenCustom } from "../interfaces/tokens/IPureSuperToken.sol";
 import { UUPSProxy } from "../upgradability/UUPSProxy.sol";
-import { IERC20 } from "@openzeppelin/contracts/token/ERC20/IERC20.sol";
+import { IERC20 } from "@openzeppelin/contracts-v4/token/ERC20/IERC20.sol";
 
 
 /**

@@ -1,7 +1,7 @@
 // SPDX-License-Identifier: AGPLv3
 pragma solidity ^0.8.23;
 
-import { Initializable } from "@openzeppelin/contracts/proxy/utils/Initializable.sol";
+import { Initializable } from "@openzeppelin/contracts-v4/proxy/utils/Initializable.sol";
 
 abstract contract BeaconProxiable is Initializable {
 

@@ -3,7 +3,7 @@ pragma solidity ^0.8.23;
 
 import {
     UpgradeableBeacon
-} from "@openzeppelin/contracts/proxy/beacon/UpgradeableBeacon.sol";
+} from "@openzeppelin/contracts-v4/proxy/beacon/UpgradeableBeacon.sol";
 import { BeaconProxiable } from "./BeaconProxiable.sol";
 
 contract SuperfluidUpgradeableBeacon is UpgradeableBeacon {