more detailled changelog, specify OZ as peer dependency

Author: d10r

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

@@ -4,10 +4,22 @@ require("@nomiclabs/hardhat-etherscan");
 require("hardhat-deploy");
 require("hardhat/config");
 require("./script/addStrategy");
+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/hardhat.config.js

@@ -3,10 +3,22 @@ require("@nomiclabs/hardhat-ethers");
 require("@nomiclabs/hardhat-etherscan");
 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/ethereum-contracts/CHANGELOG.md

@@ -20,7 +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.
+- 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/hardhat.config.ts

@@ -7,7 +7,6 @@ import "@nomiclabs/hardhat-ethers";
 import {
     TASK_COMPILE_SOLIDITY_GET_SOURCE_PATHS,
     TASK_COMPILE_SOLIDITY_GET_SOLC_BUILD,
-    TASK_COMPILE_GET_REMAPPINGS,
 } from "hardhat/builtin-tasks/task-names";
 import "solidity-coverage";
 import {config as dotenvConfig} from "dotenv";

packages/ethereum-contracts/package.json

@@ -49,7 +49,8 @@
     "license": "AGPL-3.0-or-later OR MIT",
     "main": "./dev-scripts/index.js",
     "peerDependencies": {
-        "ethers": "^5.7.2"
+        "ethers": "^5.7.2",
+        "@openzeppelin/contracts": "^5.0.0"
     },
     "repository": {
         "type": "git",