feat: Save IexecLibOrders_v5 in config file (#242)

Author: zguesmi

.github/workflows/deploy.yml

@@ -1,4 +1,5 @@
 name: Deploy PoCo Contracts
+
 on:
   workflow_dispatch:
     inputs:
@@ -63,7 +64,7 @@ jobs:
       - name: Update config.json with ERC1538Proxy address
         if: inputs.network != 'hardhat'
         env:
-          DEPLOYER_PRIVATE_KEY: ${{ secrets.DEPLOYER_PRIVATE_KEY }}
+          DEPLOYER_PRIVATE_KEY: ${{ secrets.DEPLOYER_PRIVATE_KEY }} # Fixes hardhat issue.
         run: npx hardhat run scripts/tools/update-config.ts --network ${{ inputs.network }}
 
       - name: Save deployment artifacts and updated config

.github/workflows/main.yml

@@ -1,3 +1,5 @@
+name: PoCo Contracts CI
+
 on:
   pull_request:
   workflow_call:

CHANGELOG.md

@@ -2,6 +2,7 @@
 
 ## vNEXT
 
+- Save IexecLibOrders_v5 in config file (#242)
 - Migrate proxy to Diamond pattern (ERC-2535):
   - Restore compatibility with iExec SDK. (#240)
   - Target latest EVM version (#239)
@@ -14,7 +15,6 @@
   - 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

config/config.json

@@ -175,8 +175,9 @@
       "v5": {
         "factory": "0xba5Ed099633D3B313e4D5F7bdc1305d3c28ba5Ed",
         "factoryType": "createx",
-        "DiamondProxy": "0x14B465079537655E1662F012e99EBa3863c8B9E0",
-        "salt": "0x00000000244df0848122154315af71fe140f3db0fe014031783b094600000000"
+        "DiamondProxy": "0x83AB1D51195894E402D0dE895e0141b2a1E4f9E8",
+        "salt": "0x00000000244df0848122154315af71fe140f3db0fe014031783b094600000000",
+        "IexecLibOrders_v5": "0x9f492eD91b14b01033dE156ddCce59Fe112e3D46"
       }
     },
     "default": {

scripts/tools/update-config.ts

@@ -1,37 +1,33 @@
 import * as fs from 'fs';
 import { deployments, ethers } from 'hardhat';
 import * as path from 'path';
-import config from '../../utils/config';
-
-// Get the absolute path to the config file
-const configPath = path.resolve('config/config.json');
+import localConfig from '../../utils/config';
 
 async function main(): Promise<void> {
+    // Get the absolute path to the config file
+    const configPath = path.resolve('config/config.json');
     // Get network info from ethers
     const network = await ethers.provider.getNetwork();
     const networkName = network.name;
     const chainId = network.chainId.toString();
 
     console.log(`Working with network: ${networkName} (Chain ID: ${chainId})`);
-    const deployment = await deployments.get('DiamondProxy');
+    const deployment = await deployments.get('Diamond');
     const contractAddress = deployment.address;
 
     if (!contractAddress || contractAddress === 'null') {
-        console.error(`Failed to extract a valid DiamondProxy address from deployment file`);
+        console.error(`Failed to extract a valid Diamond proxy address from Hardhat deployment`);
         process.exit(1);
     }
-
-    console.log(`Found DiamondProxy address: ${contractAddress}`);
-    const localConfig = config;
+    console.log(`Diamond proxy address to save: ${contractAddress}`);
 
     // Ensure the chain structure exists
     if (!localConfig.chains) {
         localConfig.chains = {};
     }
-
     if (!localConfig.chains[chainId]) {
         localConfig.chains[chainId] = {
-            _comment: `Chain ${chainId} (${networkName})`,
+            _comment: `Chain ${networkName} (${chainId})`,
             asset: 'Token', // Default value, update as needed
             v3: {
                 Hub: null,
@@ -42,21 +38,29 @@ async function main(): Promise<void> {
             v5: {},
         };
     }
-
     if (!localConfig.chains[chainId].v5) {
         localConfig.chains[chainId].v5 = {};
     }
-
-    const contractKey = 'DiamondProxy';
-    const previousValue = localConfig.chains[chainId].v5[contractKey] || 'null';
-    localConfig.chains[chainId].v5[contractKey] = contractAddress;
-
+    // Save the Diamond proxy address.
+    const diamondProxyName = 'DiamondProxy';
+    const previousDiamondAddress = localConfig.chains[chainId].v5[diamondProxyName] || 'null';
+    localConfig.chains[chainId].v5[diamondProxyName] = contractAddress;
+    console.log(
+        `Updated ${chainId}.v5.${diamondProxyName} from ${previousDiamondAddress} to ${contractAddress}`,
+    );
+    // Save `IexecLibOrders_v5` address if it exists
+    const iexecLibOrdersName = 'IexecLibOrders_v5';
+    const iexecLibOrdersDeployment = await deployments.get(iexecLibOrdersName);
+    if (iexecLibOrdersDeployment && iexecLibOrdersDeployment.address) {
+        const previousLibAddress = localConfig.chains[chainId].v5[iexecLibOrdersName] || 'null';
+        localConfig.chains[chainId].v5[iexecLibOrdersName] = iexecLibOrdersDeployment.address;
+        console.log(
+            `Updated ${chainId}.v5.${iexecLibOrdersName} from ${previousLibAddress} to ${iexecLibOrdersDeployment.address}`,
+        );
+    }
     // Write the updated config back to file
     fs.writeFileSync(configPath, JSON.stringify(localConfig, null, 2));
-
-    console.log(`Updated ${chainId}.v5.${contractKey}:`);
-    console.log(`Previous: ${previousValue}`);
-    console.log(`New: ${contractAddress}`);
+    console.log(`Configuration updated successfully in ${configPath}`);
 }
 
 // Execute the main function and handle any errors

utils/config.ts

@@ -56,7 +56,9 @@ type ChainConfig = {
         DatasetRegistry?: string;
         WorkerpoolRegistry?: string;
         ERC1538Proxy?: string; // Deprecated, use DiamondProxy instead TODO: to remove
+        // TODO: check if this is still needed or if hre.deployments.get('Diamond') is enough.
         DiamondProxy?: string;
+        // TODO: check if this is still needed or if hre.deployments.get('IexecLibOrders_v5') is enough.
         IexecLibOrders_v5?: string;
     };
 };

utils/createOrders.ts

@@ -275,7 +275,7 @@ export async function signOrder(
     domain: TypedDataDomain,
     order: Record<string, any>,
     signer: SignerWithAddress,
-): Promise<void> {
+) {
     return signStruct(getTypeOf(order), order, domain, signer);
 }
 
@@ -287,7 +287,7 @@ export async function signOrderOperation(
     domain: TypedDataDomain,
     orderOperation: OrderOperation,
     signer: SignerWithAddress,
-): Promise<void> {
+) {
     return signStruct(
         getTypeOf(orderOperation.order) + 'Operation',
         orderOperation,