feat: Migrate proxy to Diamond pattern (ERC-2535)

.env.template

@@ -0,0 +1,2 @@
+PRIVATE_KEY=
+ARBISCAN_API_KEY=

.github/workflows/deploy-smart-contracts.yml

@@ -89,7 +89,7 @@ jobs:
           echo "Deploying to: ${{ inputs.network }} with ${{ inputs.environment }} environment"
           npm run deploy -- --network ${{ inputs.network }}
 
-      - name: Update config.json with ERC1538Proxy address
+      - name: Update config.json with Diamond proxy address
         if: inputs.network != 'hardhat'
         run: npx hardhat run scripts/tools/update-config.ts --network ${{ inputs.network }}
 

.github/workflows/main.yml

@@ -1,13 +1,5 @@
 on:
-  push:
-    branches:
-      - feature/*
-      - bugfix/*
-      - develop
-      - release/*
-      - hotfix/*
-      - main
-      - v5
+  pull_request:
 
 jobs:
   # Note: changing the name of the job disables Slither checks with the error:
@@ -48,7 +40,7 @@ jobs:
       - name: Run static analysis with Slither
         uses: crytic/slither-action@v0.4.0
         with:
-          target: "contracts/tools/testing/slither/"
+          target: 'contracts/tools/testing/slither/'
           solc-version: '0.8.21'
           slither-args: --checklist --markdown-root ${{ github.server_url }}/${{ github.repository }}/blob/${{ github.sha }}/
           fail-on: none # TODO set this to high or other

.prettierignore

@@ -0,0 +1,10 @@
+
+artifacts/
+audit/
+build/
+cache/
+coverage/
+coverage.json
+deployments/
+node_modules/
+typechain/

.solcover.js

@@ -21,7 +21,7 @@ module.exports = {
         'tools/testing/ERC1271Mock.sol',
         'tools/testing/TestClient.sol',
         'tools/testing/TestReceiver.sol',
-        'modules/delegates/SignatureVerifier.sol',
+        'facets/SignatureVerifier.sol',
     ],
     istanbulFolder: BASE_FOLDER,
 };

CHANGELOG.md

@@ -2,19 +2,33 @@
 
 ## vNEXT
 
+- Migrate proxy to Diamond pattern (ERC-2535):
+  - Restore compatibility with iExec SDK. (#240)
+  - Target latest EVM version (#239)
+  - Adapt contracts file tree (#238)
+  - Use namespaced storage (#236, #237)
+  - Fix script folder (#235)
+  - Format all solidity files (#233)
+  - Rename ERC1538 architure to diamond Proxy architecture(#226, #229, #230, #234)
+  - Remove ENS module (#225)
+  - Add Diamond contract unit tests (#224)
+  - Fix `fallback` and `receive` (#223)
+  - Migrate contracts (#222)
+
 - Add Github Action CI in order to publish NPM package
 
 ### Updated contracts
 
 - [x] `IexecPoco2Delegate.sol`
 
 ### Features
+<!-- TODO update this with v5.5.1 release notes -->
 - Add gitub action workflow for deployment (#218)
 - Fix new testnets chain name (#217)
 - Deploy on new testnet chains using CreateX factory (#216)
 - Add CreateX factory for new chain deployment (#215)
 - Support Arbitrum & Avalanche Fuji testnets (#215)
-- Housekeeping (#207, )
+- Housekeeping (#208)
 - Add Halborn "Poco v5.5 & Voucher v1.0" audit report (#205)
 - Refactor Factory deployer (#206)
 - Enable native tests on CI (#204)

config/config.json

@@ -175,7 +175,7 @@
       "v5": {
         "factory": "0xba5Ed099633D3B313e4D5F7bdc1305d3c28ba5Ed",
         "factoryType": "createx",
-        "ERC1538Proxy": "0x14B465079537655E1662F012e99EBa3863c8B9E0",
+        "DiamondProxy": "0x14B465079537655E1662F012e99EBa3863c8B9E0",
         "salt": "0x0000000000000000000000000000000000000000000000000000000000000000"
       }
     },

contracts/Diamond.sol

@@ -0,0 +1,94 @@
+// SPDX-FileCopyrightText: 2025 IEXEC BLOCKCHAIN TECH <contact@iex.ec>
+// SPDX-License-Identifier: Apache-2.0
+
+pragma solidity ^0.8.0;
+
+//*************************************************************************************\
+//* Adapted from Nick Mudge <nick@perfectabstractions.com> (https://twitter.com/mudgen)
+//* EIP-2535 Diamonds: https://eips.ethereum.org/EIPS/eip-2535
+//*
+//* Implementation of a diamond.
+//*************************************************************************************/
+
+// Diamond proxy implementation adapted from Mudgen's to redirect
+// `receive` and `fallback` calls to the implementations in facets.
+// See diff at: https://github.com/iExecBlockchainComputing/PoCo/pull/223/commits/0562f982
+
+import {LibDiamond} from "@mudgen/diamond-1/contracts/libraries/LibDiamond.sol";
+import {IDiamondCut} from "@mudgen/diamond-1/contracts/interfaces/IDiamondCut.sol";
+import {IDiamondLoupe} from "@mudgen/diamond-1/contracts/interfaces/IDiamondLoupe.sol";
+import {IERC173} from "@mudgen/diamond-1/contracts/interfaces/IERC173.sol";
+import {IERC165} from "@mudgen/diamond-1/contracts/interfaces/IERC165.sol";
+
+// When no function exists for function called
+error FunctionNotFound(bytes4 _functionSelector);
+
+// This is used in diamond constructor
+// more arguments are added to this struct
+// this avoids stack too deep errors
+struct DiamondArgs {
+    address owner;
+    address init;
+    bytes initCalldata;
+}
+
+contract Diamond {
+    constructor(IDiamondCut.FacetCut[] memory _diamondCut, DiamondArgs memory _args) payable {
+        LibDiamond.setContractOwner(_args.owner);
+        LibDiamond.diamondCut(_diamondCut, _args.init, _args.initCalldata);
+
+        // Code can be added here to perform actions and set state variables.
+    }
+
+    /**
+     * `fallback` function must be added to the diamond with selector `0xffffffff`.
+     * The function is defined in IexecEscrow(Native/Token) facet.
+     */
+    fallback() external payable {
+        _fallback();
+    }
+
+    /**
+     * `receive` function must be added to the diamond with selector `0x00000000`.
+     * The function is defined in IexecEscrow(Native/Token) facet.
+     */
+    receive() external payable {
+        _fallback();
+    }
+
+    // Find facet for function that is called and execute the
+    // function if a facet is found and return any value.
+    function _fallback() internal {
+        LibDiamond.DiamondStorage storage ds;
+        bytes32 position = LibDiamond.DIAMOND_STORAGE_POSITION;
+        // get diamond storage
+        assembly {
+            ds.slot := position
+        }
+        // get facet from function selector
+        address facet = ds.facetAddressAndSelectorPosition[msg.sig].facetAddress;
+        if (facet == address(0)) {
+            facet = ds.facetAddressAndSelectorPosition[0xffffffff].facetAddress;
+        }
+        if (facet == address(0)) {
+            revert FunctionNotFound(msg.sig);
+        }
+        // Execute external function from facet using delegatecall and return any value.
+        assembly {
+            // copy function selector and any arguments
+            calldatacopy(0, 0, calldatasize())
+            // execute function call using the facet
+            let result := delegatecall(gas(), facet, 0, calldatasize(), 0, 0)
+            // get any return value
+            returndatacopy(0, 0, returndatasize())
+            // return any return value or error back to the caller
+            switch result
+            case 0 {
+                revert(0, returndatasize())
+            }
+            default {
+                return(0, returndatasize())
+            }
+        }
+    }
+}

contracts/IexecInterfaceNative.sol

@@ -1,50 +1,37 @@
+// SPDX-FileCopyrightText: 2020-2025 IEXEC BLOCKCHAIN TECH <contact@iex.ec>
 // SPDX-License-Identifier: Apache-2.0
 
-/******************************************************************************
- * Copyright 2020 IEXEC BLOCKCHAIN TECH                                       *
- *                                                                            *
- * Licensed under the Apache License, Version 2.0 (the "License");            *
- * you may not use this file except in compliance with the License.           *
- * You may obtain a copy of the License at                                    *
- *                                                                            *
- *     http://www.apache.org/licenses/LICENSE-2.0                             *
- *                                                                            *
- * Unless required by applicable law or agreed to in writing, software        *
- * distributed under the License is distributed on an "AS IS" BASIS,          *
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.   *
- * See the License for the specific language governing permissions and        *
- * limitations under the License.                                             *
- ******************************************************************************/
-
 pragma solidity ^0.6.0;
 pragma experimental ABIEncoderV2;
 
-import "./modules/interfaces/IOwnable.sol";
-import "./modules/interfaces/IexecAccessors.sol";
-import "./modules/interfaces/IexecCategoryManager.sol";
-import "./modules/interfaces/IexecERC20.sol";
-import "./modules/interfaces/IexecEscrowNative.sol";
-import "./modules/interfaces/IexecMaintenance.sol";
-import "./modules/interfaces/IexecOrderManagement.sol";
-import "./modules/interfaces/IexecPoco1.sol";
-import "./modules/interfaces/IexecPoco2.sol";
-import "./modules/interfaces/IexecRelay.sol";
-import "./modules/interfaces/IexecTokenSpender.sol";
-import "./modules/interfaces/ENSIntegration.sol";
-
+import "./interfaces/IOwnable.sol";
+import "./interfaces/IexecAccessors.sol";
+import "./interfaces/IexecCategoryManager.sol";
+import "./interfaces/IexecERC20.sol";
+import "./interfaces/IexecEscrowNative.sol";
+import "./interfaces/IexecConfiguration.sol";
+import "./interfaces/IexecOrderManagement.sol";
+import "./interfaces/IexecPoco1.sol";
+import "./interfaces/IexecPoco2.sol";
+import "./interfaces/IexecRelay.sol";
+import "./interfaces/IexecTokenSpender.sol";
 
+/**
+ * A global interface that aggregates all the interfaces needed to interact with
+ * the PoCo contracts in native mode.
+ * @dev Referenced in the SDK with the current path `contracts/IexecInterfaceNative.sol`.
+ * Changing the name or the path would cause a breaking change in the SDK.
+ */
 interface IexecInterfaceNative is
-	IOwnable,
-	IexecAccessors,
-	IexecCategoryManager,
-	IexecERC20,
-	IexecEscrowNative,
-	IexecMaintenance,
-	IexecOrderManagement,
-	IexecPoco1,
-	IexecPoco2,
-	IexecRelay,
-	IexecTokenSpender,
-	ENSIntegration
-{
-}
+    IOwnable,
+    IexecAccessors,
+    IexecCategoryManager,
+    IexecERC20,
+    IexecEscrowNative,
+    IexecConfiguration,
+    IexecOrderManagement,
+    IexecPoco1,
+    IexecPoco2,
+    IexecRelay,
+    IexecTokenSpender
+{}

contracts/IexecInterfaceNativeABILegacy.sol

@@ -1,52 +1,36 @@
+// SPDX-FileCopyrightText: 2020-2025 IEXEC BLOCKCHAIN TECH <contact@iex.ec>
 // SPDX-License-Identifier: Apache-2.0
 
-/******************************************************************************
- * Copyright 2020 IEXEC BLOCKCHAIN TECH                                       *
- *                                                                            *
- * Licensed under the Apache License, Version 2.0 (the "License");            *
- * you may not use this file except in compliance with the License.           *
- * You may obtain a copy of the License at                                    *
- *                                                                            *
- *     http://www.apache.org/licenses/LICENSE-2.0                             *
- *                                                                            *
- * Unless required by applicable law or agreed to in writing, software        *
- * distributed under the License is distributed on an "AS IS" BASIS,          *
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.   *
- * See the License for the specific language governing permissions and        *
- * limitations under the License.                                             *
- ******************************************************************************/
-
 pragma solidity ^0.6.0;
 pragma experimental ABIEncoderV2;
 
-import "./modules/interfaces/IOwnable.sol";
-import "./modules/interfaces/IexecAccessors.sol";
-import "./modules/interfaces/IexecAccessorsABILegacy.sol";
-import "./modules/interfaces/IexecCategoryManager.sol";
-import "./modules/interfaces/IexecERC20.sol";
-import "./modules/interfaces/IexecEscrowNative.sol";
-import "./modules/interfaces/IexecMaintenance.sol";
-import "./modules/interfaces/IexecOrderManagement.sol";
-import "./modules/interfaces/IexecPoco1.sol";
-import "./modules/interfaces/IexecPoco2.sol";
-import "./modules/interfaces/IexecRelay.sol";
-import "./modules/interfaces/IexecTokenSpender.sol";
-import "./modules/interfaces/ENSIntegration.sol";
-
+import "./interfaces/IOwnable.sol";
+import "./interfaces/IexecAccessors.sol";
+import "./interfaces/IexecAccessorsABILegacy.sol";
+import "./interfaces/IexecCategoryManager.sol";
+import "./interfaces/IexecERC20.sol";
+import "./interfaces/IexecEscrowNative.sol";
+import "./interfaces/IexecConfiguration.sol";
+import "./interfaces/IexecOrderManagement.sol";
+import "./interfaces/IexecPoco1.sol";
+import "./interfaces/IexecPoco2.sol";
+import "./interfaces/IexecRelay.sol";
+import "./interfaces/IexecTokenSpender.sol";
 
+/**
+ * TODO: Remove this interface in the future when IexecInterfaceTokenABILegacy is removed.
+ */
 interface IexecInterfaceNativeABILegacy is
-	IOwnable,
-	IexecAccessors,
-	IexecAccessorsABILegacy,
-	IexecCategoryManager,
-	IexecERC20,
-	IexecEscrowNative,
-	IexecMaintenance,
-	IexecOrderManagement,
-	IexecPoco1,
-	IexecPoco2,
-	IexecRelay,
-	IexecTokenSpender,
-	ENSIntegration
-{
-}
+    IOwnable,
+    IexecAccessors,
+    IexecAccessorsABILegacy,
+    IexecCategoryManager,
+    IexecERC20,
+    IexecEscrowNative,
+    IexecConfiguration,
+    IexecOrderManagement,
+    IexecPoco1,
+    IexecPoco2,
+    IexecRelay,
+    IexecTokenSpender
+{}