Merge develop 1.1.0 into main

.solcover.js

@@ -4,6 +4,9 @@ module.exports = {
     "diamond",
     "external",
     "protocol/clients/FermionFractionsERC20Base.sol",
+    "protocol/clients/oracle/ChainlinkPriceOracle.sol",
+    "test/upgrade",
+    "fork-tests",
   ],
   modifierWhitelist: ["nonReentrant"],
   istanbulReporter: ["html", "json-summary", "lcov", "text"],

README.md

@@ -89,6 +89,16 @@ yarn coverage
 
 Coverage report formats are "html", "json-summary", "lcov", "text" and the reports get written in `./coverage/`.
 
+#### Check Allowlisted Functions
+
+Check which functions are allowlisted for meta-transactions:
+
+```shell
+ENV=<environment> npx hardhat run scripts/check-allowlisted-functions.ts --network <network>
+```
+
+The script shows which functions from deployed contracts are allowlisted for meta-transactions, grouped by contract. It also provides a summary of total, allowlisted, and non-allowlisted functions.
+
 #### Integration test
 
 In addition to unit tests, we provide integration tests, found in `./test/integration`. We use the integration tests to ensure compatibility with already deployed contracts.
@@ -121,6 +131,120 @@ For example, to run seaport integration test on ethereum, call `npx hardhat test
 
 NB: Normal tests and coverage reports skip integration reports.
 
+### Upgrades
+
+The protocol can be upgraded using the upgrade suite. The upgrade process includes two main steps:
+
+1. Generating an upgrade configuration by comparing contract changes between versions
+2. Executing the required upgrades based on your needs:
+   - Protocol facets upgrade
+   - Client contracts upgrade
+
+#### Step 1: Generate Upgrade Configuration
+
+First, generate an upgrade config by comparing contract changes between versions:
+
+```shell
+npx hardhat generate-upgrade-config --current-version <current-version> [--new-version <new-version>] --target-version <version>
+```
+
+- `current-version`: branch/tag/commit of the current version (e.g., v1.0.0)
+- `new-version`: optional branch/tag/commit of the new version (e.g., v1.1.0). If not provided, current branch will be used
+- `version`: version number for the upgrade config (e.g., 1.1.0)
+
+The script will:
+
+- Compare contract bytecodes between versions
+- Detect constructor arguments for facets
+- Generate a configuration file with:
+  - Facets to add, replace, or remove
+  - Constructor arguments for new facets
+  - Initialization data for facets
+
+Example:
+
+```shell
+# Compare two specific versions
+npx hardhat generate-upgrade-config --current-version v1.0.0 --new-version v1.1.0 --target-version 1.1.0
+
+# Compare current branch with a specific version
+npx hardhat generate-upgrade-config --current-version v1.0.0 --target-version 1.1.0
+```
+
+#### Step 2: Execute Required Upgrades
+
+After generating and reviewing the upgrade configuration, you should execute the upgrades based on your needs:
+
+##### Protocol Facets Upgrade
+
+Use this command when you need to upgrade the protocol facets (add, remove, replace) and execute pre/post-upgrade hooks:
+
+```shell
+npx hardhat upgrade-facets --env <environment> --target-version <version> [--dry-run] [--network <network>]
+```
+
+- `environment`: name of the environment to upgrade (e.g., test, staging, production)
+- `version`: target version to upgrade to (e.g., 1.1.0)
+- `dry-run`: optional flag to simulate the upgrade without actually executing it
+- `network`: network to run the upgrade on (must be defined in `hardhat.config.ts`)
+
+The upgrade process will:
+
+1. Execute pre-upgrade hooks if available
+2. Deploy new facets with their constructor arguments
+3. Execute diamond cuts to add/replace/remove facets
+4. Execute initialization data if configured
+5. Execute post-upgrade hooks if available
+6. Update the protocol version
+7. Save the new contract addresses
+
+##### Client Contracts Upgrade
+
+Use this command when you need to upgrade the FermionFNFT contract and its dependencies:
+
+```shell
+npx hardhat upgrade-clients --env <environment> --target-version <version> [--dry-run] [--network <network>]
+```
+
+- `environment`: name of the environment to upgrade (e.g., test, staging, production)
+- `version`: target version to upgrade to (e.g., 1.1.0)
+- `dry-run`: optional flag to simulate the upgrade without actually executing it
+- `network`: network to run the upgrade on (must be defined in `hardhat.config.ts`)
+
+The upgrade process will:
+
+1. Deploy new FermionFNFT contract and its dependencies
+2. Update the FermionFNFT implementation in the diamond through `ConfigFacet.setFNFTImplementationAddress`
+3. Save the new contract addresses
+
+Example:
+
+```shell
+# Upgrade only protocol facets on test environment
+npx hardhat upgrade-facets --env test --target-version 1.1.0 --dry-run --network sepolia
+
+# Upgrade only clients on test environment
+npx hardhat upgrade-clients --env test --target-version 1.1.0 --dry-run --network sepolia
+```
+
+### Fork Tests
+
+Fork tests are used to simulate upgrades and other operations on a forked version of a network. They are located in the `fork-tests` directory.
+
+To run a fork test:
+
+```shell
+npx hardhat test <testFile> --network <network>
+```
+
+Example:
+
+```shell
+npx hardhat test fork-tests/upgrade/1.0.0-1.1.0.ts --network sepolia
+```
+
+The fork tests use the same configuration and hooks as the actual upgrade process, making them perfect for testing upgrades before executing them on the mainnet.
+
 ## Deployment
 
 To deploy the Fermion protocol on a public blockchain:

addresses/1-ethereum-prod.json

@@ -2,15 +2,20 @@
   "chainId": 1,
   "network": "ethereum",
   "env": "prod",
-  "protocolVersion": "1.0.1",
+  "protocolVersion": "1.1.0",
   "contracts": [
     {
       "name": "FermionFNFT",
-      "address": "0xeE5EAD6302e2a621f3Bb2FAB6Fab1cb64FbfE9e5",
+      "address": "0xbe892d93455CF958C4453F15b25bB62E2c573B95",
       "args": [
         "0xb60cf39Fb18e5111174f346d0f39521ef6531fD4",
-        "0xa6916ced80247Ba8752d859CCc4176965bdBEE6A",
-        "0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2"
+        "0x93b330001bcaad603e21e2639fb041cdea472449",
+        "0x8369433f08dbE24553dCAfAB39e4E727fe9dcE8E",
+        "0xA000027A9B2802E1ddf7000061001e5c005A0000",
+        "0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2",
+        "0xff28e641A39BCc3088B75E6A7ED2D739329DBed9",
+        "0x18AcBBF4C30a5D56B9cf696799a1A94a6e011C89",
+        "0x6577B3522C8528D60146D67B62180c4C4584548f"
       ]
     },
     {
@@ -80,37 +85,40 @@
     },
     {
       "name": "ConfigFacet",
-      "address": "0x464F11D47665F3C3e13C41ead62F233faAe3cB96",
+      "address": "0xef0118dfC9b5f152c89E448293238A045C52E50B",
       "args": []
     },
     {
       "name": "EntityFacet",
-      "address": "0xE642d17272f1F080120Fd578b3655727eeC9Ef1D",
+      "address": "0xDF574AB9b7c0bc19E5bAceAFa74f83604a6d1F98",
       "args": []
     },
     {
       "name": "MetaTransactionFacet",
-      "address": "0x86692530B2e66b7166fAE481479A8474B0acdfD4",
+      "address": "0x0Bfb0BFffB4Fd23E61f5eeAfb6E48FcB9f79F6A1",
       "args": ["0x93b330001bcaad603e21e2639fb041cdea472449"]
     },
     {
       "name": "OfferFacet",
-      "address": "0xdFE29dfdaCCA5952dc147BCB6376ED2F15d00Bb3",
+      "address": "0x5eaCFbAe319231F6E43b27F96ad7Af210d176CF2",
       "args": ["0x59A4C19b55193D5a2EAD0065c54af4d516E18Cb5"]
     },
     {
       "name": "VerificationFacet",
-      "address": "0x16Df2455b34f4A33A2575c1B0F33C1cF1486a4C0",
-      "args": ["0x59A4C19b55193D5a2EAD0065c54af4d516E18Cb5"]
+      "address": "0xa023CB2B3270D5DA1bf927F7ba7D0E53F71Ce399",
+      "args": [
+        "0x59A4C19b55193D5a2EAD0065c54af4d516E18Cb5",
+        "0x93b330001bcaad603e21e2639fb041cdea472449"
+      ]
     },
     {
       "name": "CustodyFacet",
-      "address": "0x65B0E33fA96ac3D34Ee3c2aFdF773fe751ca7cFc",
+      "address": "0x43A51A055c6AdcC09Dd0A1d2314f79a1Df49FeAa",
       "args": []
     },
     {
       "name": "FundsFacet",
-      "address": "0x721812fc5a76425d665F0C7DfE6F14c6db8CE592",
+      "address": "0xD79750FEFaD2C1C12c58C96F3890ec75a26124fe",
       "args": []
     },
     {
@@ -120,8 +128,61 @@
     },
     {
       "name": "CustodyVaultFacet",
-      "address": "0x4f5bdfad001F8E1E69e98eFbd2045Bbb0925b011",
+      "address": "0x1913D8039670b9305e27b0d6E922c988a42e1931",
+      "args": []
+    },
+    {
+      "name": "PriceOracleRegistryFacet",
+      "address": "0xc5Ec46B1B5782E502D76B44ba74e7136ff8040E1",
+      "args": []
+    },
+    {
+      "name": "RoyaltiesFacet",
+      "address": "0x26A2eA5d6d21649AD163829c69c23bf0a84c967a",
       "args": []
+    },
+    {
+      "name": "SeaportWrapper",
+      "address": "0x8369433f08dbE24553dCAfAB39e4E727fe9dcE8E",
+      "args": [
+        "0xb60cf39Fb18e5111174f346d0f39521ef6531fD4",
+        "0x93b330001bcaad603e21e2639fb041cdea472449",
+        {
+          "seaport": "0x0000000000000068F116a894984e2DB1123eB395",
+          "openSeaConduit": "0x1E0049783F008A0085193E00003D00cd54003c71",
+          "openSeaConduitKey": "0x0000007b02230091a7ed01230072f7006a004d60a8d4e71d599b8104250f0000",
+          "openSeaSignedZone": "0x000056F7000000EcE9003ca63978907a00FFD100",
+          "openSeaZoneHash": "0x0000000000000000000000000000000000000000000000000000000000000000",
+          "openSeaRecipient": "0x0000a26b00c1F0DF003000390027140000fAa719"
+        }
+      ]
+    },
+    {
+      "name": "FermionFractionsERC20",
+      "address": "0x1A79eDCbED29Fa8A91F49cF092bdb7E9Ba8884b2",
+      "args": ["0x93b330001bcaad603e21e2639fb041cdea472449"]
+    },
+    {
+      "name": "FermionFractionsMint",
+      "address": "0xff28e641A39BCc3088B75E6A7ED2D739329DBed9",
+      "args": [
+        "0xb60cf39Fb18e5111174f346d0f39521ef6531fD4",
+        "0x93b330001bcaad603e21e2639fb041cdea472449",
+        "0x1A79eDCbED29Fa8A91F49cF092bdb7E9Ba8884b2"
+      ]
+    },
+    {
+      "name": "FermionFNFTPriceManager",
+      "address": "0x18AcBBF4C30a5D56B9cf696799a1A94a6e011C89",
+      "args": ["0x93b330001bcaad603e21e2639fb041cdea472449"]
+    },
+    {
+      "name": "FermionBuyoutAuction",
+      "address": "0x6577B3522C8528D60146D67B62180c4C4584548f",
+      "args": [
+        "0xb60cf39Fb18e5111174f346d0f39521ef6531fD4",
+        "0x93b330001bcaad603e21e2639fb041cdea472449"
+      ]
     }
   ],
   "externalAddresses": {