updated readme, automation-contracts mappings

Author: d10r

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'

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'

packages/ethereum-contracts/CHANGELOG.md

@@ -7,32 +7,18 @@ This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.htm
 
 ### Breaking
 
-The npm dependency @openzeppelin/contracts is now mapped to the local path `@openzeppelin/contracts-v4`.
+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 order to use this package in a **foundry project (new or existing) with dependencies installed as git submodules**, this steps are recommended:
-
-1. Add openzeppelin-contracts v4 as a submodule:
-```
-git submodule add -b release-v4.9 https://github.com/OpenZeppelin/openzeppelin-contracts lib/openzeppelin-contracts-v4
+In an existing foundry project, you will need to add this remapping:
 ```
-Note the explicit local path with v4 postfix.
-
-2. Add this mapping to `foundry.toml` or `remappings.txt` (depending on where they are located in your project):
+@openzeppelin/contracts-v4/=lib/openzeppelin-contracts-v4/contracts/
 ```
-"@openzeppelin/contracts-v4/=lib/openzeppelin-contracts-v4/contracts/"
-```
-
-That way, projects can use the import path `@openzeppelin/contracts` for openzeppelin v5. This is the default when using npm for installing the openzeppelin dependency.
 
-**Note:**  
-foundry by default auto-detects mappings based on the contents of the lib directory and nested foundry configuration files.
-Because of this, it may automatically add a mapping `openzeppelin/=lib/openzeppelin-contracts-v4/contracts/` .
-In case you're using the import path `openzeppelin/...` in your project, that may not be what you want.
-In this case you can either change the import path to something else, or you can disable mapping auto-detection with `auto_detect_remappings = false` (see [docs](https://book.getfoundry.sh/reference/config/solidity-compiler#auto_detect_remappings)). If you disable it, you may need to explicitly add some mappings, e.g. for forge-std.
+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/`.
 
-In order to use this package in a **project with dependencies managed by npm packages**, you don't need to do anything.
-Except: if you relied on the openzeppelin-contracts v4 dependency installed by this package, you now need to either also adjust the import path, or explicity add the dependency with the default path to your project.
+For more details, consult the updated `README.md` (section _Installation_).^
 
 ## [v1.12.1]
 

packages/ethereum-contracts/README.md

@@ -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
 
-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)
+Once you have set up your project, cd into its base directory and add the npm package:
+
+##### foundry
+
+**Prerequisites:**
 - [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/openzeppelin-contracts@release-v4.9 --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 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}')
+$ 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