chore: Update upgrade report and clean upgrade script (#296)

zguesmi · gfournieriExec · web-flow · commit 50b772f7ba55 · 2025-10-20T16:36:57.000+02:00
Co-authored-by: gfournieriExec &lt;gabriel.fournier@iex.ec&gt;
diff --git a/.github/workflows/deploy.yml b/.github/workflows/deploy.yml
@@ -48,6 +48,7 @@ jobs:
         run: npm run build
 
       # TODO activate later.
+      # Checks of initial state fails (e.g., balanceOf(proxyAddress) !== 0).
       # - name: Run fork tests
       #   run: |
       #     if [ "${{ inputs.network }}" == "arbitrumSepolia" ]; then
diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml
@@ -3,7 +3,7 @@ name: PoCo Contracts CI
 on:
   push:
     branches:
-      - main
+      - main # To trigger coverage updates of `main` on Codecov
   pull_request:
   workflow_call:
 
diff --git a/contracts/IexecInterfaceToken.sol b/contracts/IexecInterfaceToken.sol
@@ -19,6 +19,9 @@ import {IexecRelay} from "./interfaces/IexecRelay.sol";
 import {IexecTokenSpender} from "./interfaces/IexecTokenSpender.sol";
 import {IOwnable} from "./interfaces/IOwnable.sol";
 
+// TODO see if Diamond interfaces should be added here ??
+// IDiamond, IDiamondLoupe, IDiamondCut, IERC165, IERC173 (ownership)
+
 /**
  * A global interface that aggregates all the interfaces needed to interact with
  * the PoCo contracts in token mode.
diff --git a/scripts/boost/1_add-modules-to-proxy.ts b/scripts/boost/1_add-modules-to-proxy.ts
@@ -12,11 +12,8 @@ import {
 import { Ownable__factory } from '../../typechain/factories/rlc-faucet-contract/contracts';
 import config from '../../utils/config';
 import { getDeployerAndOwnerSigners } from '../../utils/deploy-tools';
-import {
-    encodeModuleProxyUpdate,
-    printBlockTime,
-    printFunctions,
-} from '../upgrades/upgrade-helper';
+import { encodeModuleProxyUpdate, printBlockTime } from '../upgrades/upgrade-helper';
+import { printOnchainProxyFunctions } from '../../utils/proxy-tools';
 
 (async () => {
     const chainId = (await ethers.provider.getNetwork()).chainId;
@@ -78,7 +75,7 @@ import {
     await time.increase(delay);
     console.log('Time traveling..');
     await printBlockTime();
-    await printFunctions(diamondProxyAddress);
+    await printOnchainProxyFunctions(diamondProxyAddress);
     console.log('Executing proxy update..');
     await timelockInstance
         .connect(timelockAdminSigner)
@@ -87,5 +84,5 @@ import {
             console.log(tx);
             tx.wait();
         });
-    await printFunctions(diamondProxyAddress);
+    await printOnchainProxyFunctions(diamondProxyAddress);
 })();
diff --git a/scripts/sponsoring/1_add-modules-to-proxy.ts b/scripts/sponsoring/1_add-modules-to-proxy.ts
@@ -13,11 +13,8 @@ import {
     TimelockController__factory,
 } from '../../typechain';
 import config from '../../utils/config';
-import {
-    encodeModuleProxyUpdate,
-    printBlockTime,
-    printFunctions,
-} from '../upgrades/upgrade-helper';
+import { encodeModuleProxyUpdate, printBlockTime } from '../upgrades/upgrade-helper';
+import { printOnchainProxyFunctions } from '../../utils/proxy-tools';
 
 if (process.env.HANDLE_SPONSORING_UPGRADE_INTERNALLY != 'true') {
     (async () => {
@@ -42,7 +39,7 @@ export async function addModulesToProxy() {
     const iexecPoco2FacetAddress = (await hre.deployments.get('IexecPoco2Facet')).address;
     const iexecPocoAccessorsFacetAddress = (await hre.deployments.get('IexecPocoAccessorsFacet'))
         .address;
-    await printFunctions(diamondProxyAddress);
+    await printOnchainProxyFunctions(diamondProxyAddress);
 
     console.log('Functions about to be added to proxy:');
     const timelockAddress = await Ownable__factory.connect(
@@ -126,7 +123,7 @@ export async function addModulesToProxy() {
 
     async function executeUpgrade() {
         await printBlockTime();
-        await printFunctions(diamondProxyAddress);
+        await printOnchainProxyFunctions(diamondProxyAddress);
         console.log('Executing proxy update..');
         await timelockInstance
             .connect(timelockAdminSigner)
@@ -135,6 +132,6 @@ export async function addModulesToProxy() {
                 console.log(x);
                 return x.wait();
             });
-        await printFunctions(diamondProxyAddress);
+        await printOnchainProxyFunctions(diamondProxyAddress);
     }
 }
diff --git a/scripts/upgrades/upgrade-helper.ts b/scripts/upgrades/upgrade-helper.ts
@@ -1,29 +1,10 @@
 // SPDX-FileCopyrightText: 2024-2025 IEXEC BLOCKCHAIN TECH <contact@iex.ec>
 // SPDX-License-Identifier: Apache-2.0
 
-import { ContractFactory, Interface, ZeroAddress } from 'ethers';
+import { ContractFactory, ZeroAddress } from 'ethers';
 import { ethers } from 'hardhat';
 import { FacetCutAction } from 'hardhat-deploy/dist/types';
-import {
-    DiamondCutFacet__factory,
-    DiamondLoupeFacet__factory,
-    IexecAccessorsABILegacyFacet__factory,
-    IexecCategoryManagerFacet__factory,
-    IexecConfigurationExtraFacet__factory,
-    IexecConfigurationFacet__factory,
-    IexecERC20Facet__factory,
-    IexecEscrowNativeFacet__factory,
-    IexecEscrowTokenFacet__factory,
-    IexecEscrowTokenSwapFacet__factory,
-    IexecOrderManagementFacet__factory,
-    IexecPoco1Facet__factory,
-    IexecPoco2Facet__factory,
-    IexecPocoAccessorsFacet__factory,
-    IexecPocoBoostAccessorsFacet__factory,
-    IexecPocoBoostFacet__factory,
-    IexecRelayFacet__factory,
-    OwnershipFacet__factory,
-} from '../../typechain';
+import { DiamondCutFacet__factory } from '../../typechain';
 import { getFunctionSelectors } from '../../utils/proxy-tools';
 
 function encodeModuleProxyUpdate(contractFactory: ContractFactory, moduleAddress: string) {
@@ -55,72 +36,4 @@ async function printBlockTime() {
     }
 }
 
-async function printFunctions(diamondProxyAddress: string) {
-    const diamondLoupeInstance = DiamondLoupeFacet__factory.connect(
-        diamondProxyAddress,
-        ethers.provider,
-    );
-    const facets = await diamondLoupeInstance.facets();
-
-    const allInterfaces: Interface[] = [
-        OwnershipFacet__factory.createInterface(),
-        DiamondCutFacet__factory.createInterface(),
-        DiamondLoupeFacet__factory.createInterface(),
-        IexecAccessorsABILegacyFacet__factory.createInterface(),
-        IexecCategoryManagerFacet__factory.createInterface(),
-        IexecConfigurationExtraFacet__factory.createInterface(),
-        IexecConfigurationFacet__factory.createInterface(),
-        IexecERC20Facet__factory.createInterface(),
-        IexecEscrowNativeFacet__factory.createInterface(),
-        IexecEscrowTokenFacet__factory.createInterface(),
-        IexecEscrowTokenSwapFacet__factory.createInterface(),
-        IexecOrderManagementFacet__factory.createInterface(),
-        IexecPoco1Facet__factory.createInterface(),
-        IexecPoco2Facet__factory.createInterface(),
-        IexecPocoAccessorsFacet__factory.createInterface(),
-        IexecPocoBoostAccessorsFacet__factory.createInterface(),
-        IexecPocoBoostFacet__factory.createInterface(),
-        IexecRelayFacet__factory.createInterface(),
-    ];
-    const selectorToName = new Map<string, string>();
-    for (const iface of allInterfaces) {
-        for (const fragment of iface.fragments) {
-            if (fragment.type === 'function') {
-                const signature = fragment.format();
-                const funcFragment = iface.getFunction(signature);
-                if (funcFragment) {
-                    selectorToName.set(funcFragment.selector, funcFragment.name);
-                }
-            }
-        }
-    }
-
-    let totalFunctions = 0;
-    facets.forEach((facet) => {
-        totalFunctions += facet.functionSelectors.length;
-    });
-
-    console.log(`DiamondProxy supports ${totalFunctions} functions:`);
-
-    let functionIndex = 0;
-    for (const facet of facets) {
-        for (const selector of facet.functionSelectors) {
-            let functionName = selector; // Default to selector if we can't decode
-            // Special cases for special functions
-            if (selector === '0x00000000') {
-                functionName = 'receive()';
-            } else if (selector === '0xffffffff') {
-                functionName = 'fallback()';
-            } else {
-                const name = selectorToName.get(selector);
-                if (name) {
-                    functionName = name;
-                }
-            }
-            console.log(`[${functionIndex}] ${facet.facetAddress} ${functionName}`);
-            functionIndex++;
-        }
-    }
-}
-
-export { encodeModuleProxyUpdate, printBlockTime, printFunctions };
+export { encodeModuleProxyUpdate, printBlockTime };
diff --git a/scripts/upgrades/v6.1.0-bulk-processing.md b/scripts/upgrades/v6.1.0-bulk-processing.md
@@ -12,6 +12,17 @@
 
 ## Summary of changes
 
+- Removes unintentionally added constants getters by changing constants visibility to `internal`.
+These functions were introduced as a side-effect of the migration to the Diamond proxy but they are
+used nowhere. They are duplicate of other existing functions:
+    - `CONTRIBUTION_DEADLINE_RATIO()`
+    - `FINAL_DEADLINE_RATIO()`
+    - `GROUPMEMBER_PURPOSE()`
+    - `KITTY_ADDRESS()`
+    - `KITTY_MIN()`
+    - `KITTY_RATIO()`
+    - `REVEAL_DEADLINE_RATIO()`
+    - `WORKERPOOL_STAKE_RATIO()`
 - Add functions `viewApp`, `viewDataset`, and `viewWorkerpool` to read asset's details in a single transaction.
 - Add function `assertDatasetDealCompatibility` to allow the SMS to check compatibility of Bulk orders with a given deal.
 
diff --git a/scripts/upgrades/v6.1.0-bulk-processing.ts b/scripts/upgrades/v6.1.0-bulk-processing.ts
@@ -16,9 +16,8 @@ import { Ownable__factory } from '../../typechain/factories/rlc-faucet-contract/
 import { FactoryDeployer } from '../../utils/FactoryDeployer';
 import config from '../../utils/config';
 import { getDeployerAndOwnerSigners } from '../../utils/deploy-tools';
-import { linkContractToProxy } from '../../utils/proxy-tools';
+import { linkContractToProxy, printOnchainProxyFunctions } from '../../utils/proxy-tools';
 import { tryVerify } from '../verify';
-import { printFunctions } from './upgrade-helper';
 
 async function main() {
     console.log('Deploying and updating IexecPocoAccessorsFacet & IexecPoco1Facet...');
@@ -122,7 +121,7 @@ async function removeOldFacetsFromDiamond(diamondProxyAsOwner: DiamondCutFacet,
     });
 
     console.log('Diamond functions before upgrade:');
-    await printFunctions(diamondProxyAddress);
+    await printOnchainProxyFunctions(diamondProxyAddress);
 
     const removalCuts: IDiamond.FacetCutStruct[] = [];
 
@@ -182,7 +181,7 @@ async function removeOldFacetsFromDiamond(diamondProxyAsOwner: DiamondCutFacet,
         await removeTx.wait();
         console.log(`Transaction hash: ${removeTx.hash}`);
         console.log('Diamond functions after removing old facets:');
-        await printFunctions(diamondProxyAddress);
+        await printOnchainProxyFunctions(diamondProxyAddress);
     }
 }
 
@@ -208,7 +207,7 @@ async function linkNewFacetsToDiamond(
     console.log('New IexecPoco1Facet with assertDatasetDealCompatibility added successfully');
 
     console.log('Diamond functions after adding new facets:');
-    await printFunctions(diamondProxyAddress);
+    await printOnchainProxyFunctions(diamondProxyAddress);
 
     console.log('\nUpgrade completed successfully!');
     console.log(`New IexecPocoAccessorsFacet deployed at: ${iexecPocoAccessorsFacet}`);
diff --git a/utils/FactoryDeployer.ts b/utils/FactoryDeployer.ts
@@ -33,6 +33,7 @@ export class FactoryDeployer {
         call?: string,
     ): Promise<string> {
         await this.initFactory();
+        // TODO merge common parts of both deployment methods.
         if (this.factoryType === 'createx') {
             return await this.deployWithCreateX(contractFactory, constructorArgs, call);
         }
diff --git a/utils/proxy-tools.ts b/utils/proxy-tools.ts
@@ -1,10 +1,30 @@
 // SPDX-FileCopyrightText: 2024-2025 IEXEC BLOCKCHAIN TECH <contact@iex.ec>
 // SPDX-License-Identifier: Apache-2.0
 
-import { ContractFactory, ZeroAddress } from 'ethers';
+import { ContractFactory, FunctionFragment, Interface, ZeroAddress } from 'ethers';
 import { ethers } from 'hardhat';
 import { FacetCut, FacetCutAction } from 'hardhat-deploy/dist/types';
-import { DiamondCutFacet, DiamondLoupeFacet__factory } from '../typechain';
+import {
+    DiamondCutFacet,
+    DiamondCutFacet__factory,
+    DiamondLoupeFacet__factory,
+    OwnershipFacet__factory,
+    IexecAccessorsABILegacyFacet__factory,
+    IexecCategoryManagerFacet__factory,
+    IexecConfigurationExtraFacet__factory,
+    IexecConfigurationFacet__factory,
+    IexecERC20Facet__factory,
+    IexecEscrowNativeFacet__factory,
+    IexecEscrowTokenFacet__factory,
+    IexecEscrowTokenSwapFacet__factory,
+    IexecOrderManagementFacet__factory,
+    IexecPoco1Facet__factory,
+    IexecPoco2Facet__factory,
+    IexecPocoAccessorsFacet__factory,
+    IexecPocoBoostAccessorsFacet__factory,
+    IexecPocoBoostFacet__factory,
+    IexecRelayFacet__factory,
+} from '../typechain';
 import { getBaseNameFromContractFactory } from '../utils/deploy-tools';
 
 const POCO_STORAGE_LOCATION = '0x5862653c6982c162832160cf30593645e8487b257e44d77cdd6b51eee2651b00';
@@ -29,6 +49,8 @@ export async function linkContractToProxy(
     contractAddress: string,
     contractFactory: ContractFactory,
 ) {
+    const contractName = getBaseNameFromContractFactory(contractFactory);
+    console.log(`Linking ${contractName} to proxy`);
     // Fetch existing selectors from the proxy.
     const existingSelectors = await DiamondLoupeFacet__factory.connect(
         await proxy.getAddress(),
@@ -39,7 +61,7 @@ export async function linkContractToProxy(
     // Get the contract selectors from its ABI.
     const contractSelectors = getFunctionSelectors(contractFactory);
     // Exclude existing selectors to avoid the error `CannotAddFunctionToDiamondThatAlreadyExists`.
-    // This appears for `owner()` function.
+    // This appears for `owner()` function for example.
     const selectors = contractSelectors.filter((selector) => !existingSelectors.includes(selector));
     const facetCut: FacetCut = {
         facetAddress: contractAddress,
@@ -50,7 +72,6 @@ export async function linkContractToProxy(
         .diamondCut([facetCut], ZeroAddress, '0x')
         .then((tx) => tx.wait())
         .catch((err) => {
-            const contractName = getBaseNameFromContractFactory(contractFactory);
             console.log(`Failed to link ${contractName} to proxy:`);
             throw err;
         });
@@ -87,3 +108,64 @@ export function getFunctionSelectors(contractFactory: ContractFactory): string[]
             })
     );
 }
+
+export function getAllLocalFacetFunctions(): Map<string, string> {
+    // TODO update this when new facets are added.
+    // TODO read `contracts/facets` folder to avoid manual updates.
+    const allInterfaces: Interface[] = [
+        DiamondCutFacet__factory.createInterface(),
+        DiamondLoupeFacet__factory.createInterface(),
+        OwnershipFacet__factory.createInterface(),
+        IexecAccessorsABILegacyFacet__factory.createInterface(),
+        IexecCategoryManagerFacet__factory.createInterface(),
+        IexecConfigurationExtraFacet__factory.createInterface(),
+        IexecConfigurationFacet__factory.createInterface(),
+        IexecERC20Facet__factory.createInterface(),
+        IexecEscrowNativeFacet__factory.createInterface(),
+        IexecEscrowTokenFacet__factory.createInterface(),
+        IexecEscrowTokenSwapFacet__factory.createInterface(),
+        IexecOrderManagementFacet__factory.createInterface(),
+        IexecPoco1Facet__factory.createInterface(),
+        IexecPoco2Facet__factory.createInterface(),
+        IexecPocoAccessorsFacet__factory.createInterface(),
+        IexecPocoBoostAccessorsFacet__factory.createInterface(),
+        IexecPocoBoostFacet__factory.createInterface(),
+        IexecRelayFacet__factory.createInterface(),
+    ];
+    // TODO update `getFunctionSelectors` and use it here to avoid duplication.
+    const fragments: [string, string][] = allInterfaces
+        .flatMap((iface) => iface.fragments)
+        .filter((fragment) => fragment.type === 'function')
+        .map((fragment) => fragment as FunctionFragment)
+        .map((fragment) => [fragment.selector, fragment.name] as [string, string])
+        .concat([
+            ['receive', '0x00000000'], // fragment.type is 'fallback'
+            ['fallback', '0xffffffff'], // fragment.type is 'fallback'
+        ]);
+    const selectorToName = new Map<string, string>(fragments);
+    return selectorToName;
+}
+
+export async function printOnchainProxyFunctions(diamondProxyAddress: string) {
+    const selectorToName = getAllLocalFacetFunctions();
+    const facetsOnchain = await DiamondLoupeFacet__factory.connect(
+        diamondProxyAddress,
+        ethers.provider,
+    ).facets();
+    let totalFunctions = 0;
+    facetsOnchain.forEach((facet) => {
+        totalFunctions += facet.functionSelectors.length;
+    });
+    console.log(
+        `Onchain diamond proxy has ${facetsOnchain.length} facets and ${totalFunctions} total functions:`,
+    );
+    let i = 0;
+    for (const facet of facetsOnchain) {
+        for (const selector of facet.functionSelectors) {
+            // Fallback to the selector if the name is not found.
+            const functionName = selectorToName.get(selector) ?? selector;
+            console.log(`[${i}] ${facet.facetAddress} ${functionName}`);
+            i++;
+        }
+    }
+}

Original file line number	Diff line number	Diff line change
`@@ -33,6 +33,7 @@ export class FactoryDeployer {`
`33`	`33`	`call?: string,`
`34`	`34`	`): Promise<string> {`
`35`	`35`	`await this.initFactory();`
	`36`	`+ // TODO merge common parts of both deployment methods.`
`36`	`37`	`if (this.factoryType === 'createx') {`
`37`	`38`	`return await this.deployWithCreateX(contractFactory, constructorArgs, call);`
`38`	`39`	`}`