feat: Migrate to Hardhat 3

.nvmrc

@@ -1 +1 @@
-20
+22.10.0

hardhat.config.old.ts

@@ -0,0 +1,329 @@
+import '@nomicfoundation/hardhat-toolbox';
+import 'dotenv/config';
+import * as fs from 'fs';
+import 'hardhat-abi-exporter';
+import 'hardhat-dependency-compiler';
+import 'hardhat-deploy';
+import { HardhatUserConfig, task } from 'hardhat/config';
+import {
+    HARDHAT_NETWORK_MNEMONIC,
+    defaultHardhatNetworkParams,
+    defaultLocalhostNetworkParams,
+} from 'hardhat/internal/core/config/default-config';
+import 'solidity-docgen';
+import { cleanupDeployments, copyDeployments } from './scripts/tools/copy-deployments';
+import chainConfig from './utils/config';
+
+const isNativeChainType = chainConfig.isNativeChain();
+const isLocalFork = chainConfig.isLocalFork();
+const isArbitrumSepoliaFork = chainConfig.isArbitrumSepoliaFork();
+const isArbitrumFork = chainConfig.isArbitrumFork();
+const bellecourBlockscoutUrl = 'https://blockscout.bellecour.iex.ec';
+
+/**
+ * @dev Native mode. As close as possible to the iExec Bellecour blockchain.
+ * @note Any fresh version of Hardhat uses for its default
+ * hardhat network a configuration from a recent Ethereum
+ * fork. EIPs brought by such recent fork are not necessarily
+ * supported by the iExec Bellecour blockchain.
+ */
+const bellecourBaseConfig = {
+    hardfork: 'berlin', // No EIP-1559 before London fork
+    gasPrice: 0,
+    blockGasLimit: 6_700_000,
+};
+
+// Arbitrum Sepolia specific configuration
+const arbitrumSepoliaBaseConfig = {
+    chainId: 421614,
+    blockGasLimit: 32_000_000,
+};
+
+// Arbitrum specific configuration
+const arbitrumBaseConfig = {
+    chainId: 42161,
+    // https://docs.arbitrum.io/build-decentralized-apps/arbitrum-vs-ethereum/block-numbers-and-time#block-gas-limit
+    blockGasLimit: 32_000_000,
+};
+
+const settings = {
+    optimizer: {
+        enabled: true,
+        runs: 200,
+    },
+    outputSelection: { '*': { '*': ['storageLayout'] } },
+};
+
+const v8Settings = {
+    ...settings,
+    /**
+     * Enable Intermediate Representation (IR) to reduce `Stack too deep` occurrences
+     * at compile time (e.g.: too many local variables in `matchOrdersBoost`).
+     * https://hardhat.org/hardhat-runner/docs/reference/solidity-support#support-for-ir-based-codegen
+     */
+    viaIR: true,
+    optimizer: {
+        ...settings.optimizer,
+        details: {
+            yul: true,
+            yulDetails: {
+                optimizerSteps: 'u',
+            },
+        },
+    },
+};
+
+const config: HardhatUserConfig = {
+    solidity: {
+        compilers: [
+            { version: '0.8.21', settings: v8Settings }, // PoCo Boost
+            { version: '0.6.12', settings }, // PoCo contracts
+            { version: '0.4.11', settings }, // RLC contracts
+        ],
+    },
+    namedAccounts: {
+        deployer: {
+            default: 0,
+            bellecour: chainConfig.chains['134'].deployer,
+            arbitrum: chainConfig.chains['42161'].deployer,
+            arbitrumSepolia: chainConfig.chains['421614'].deployer,
+        },
+        owner: {
+            default: 0, // TODO change this to 1 and update admin tests.
+            bellecour: chainConfig.chains['134'].owner,
+            arbitrum: chainConfig.chains['42161'].owner,
+            arbitrumSepolia: chainConfig.chains['421614'].owner,
+        },
+    },
+    networks: {
+        hardhat: {
+            accounts: {
+                mnemonic: process.env.MNEMONIC || HARDHAT_NETWORK_MNEMONIC,
+            },
+            ...((isNativeChainType || isLocalFork) && bellecourBaseConfig),
+            ...(isLocalFork && {
+                forking: {
+                    url: 'https://bellecour.iex.ec',
+                },
+                chainId: 134,
+            }),
+            ...(isArbitrumSepoliaFork && {
+                forking: {
+                    url:
+                        process.env.ARBITRUM_SEPOLIA_RPC_URL ||
+                        'https://sepolia-rollup.arbitrum.io/rpc',
+                    blockNumber: process.env.ARBITRUM_SEPOLIA_BLOCK_NUMBER
+                        ? parseInt(process.env.ARBITRUM_SEPOLIA_BLOCK_NUMBER)
+                        : undefined,
+                },
+                ...arbitrumSepoliaBaseConfig,
+                gasPrice: 100_000_000, // 0.1 Gwei
+            }),
+
+            ...(isArbitrumFork && {
+                forking: {
+                    url: process.env.ARBITRUM_RPC_URL || 'https://arbitrum.gateway.tenderly.co',
+                },
+                ...arbitrumBaseConfig,
+                gasPrice: 100_000_000, // 0.1 Gwei
+            }),
+        },
+        'external-hardhat': {
+            ...defaultHardhatNetworkParams,
+            ...defaultLocalhostNetworkParams,
+            accounts: {
+                mnemonic: process.env.MNEMONIC || HARDHAT_NETWORK_MNEMONIC,
+            },
+            ...((isNativeChainType || isLocalFork) && bellecourBaseConfig),
+            ...(isLocalFork && {
+                accounts: 'remote', // Override defaults accounts for impersonation
+                chainId: 134,
+            }),
+            ...(isArbitrumSepoliaFork && {
+                accounts: 'remote', // Override defaults accounts for impersonation
+                ...arbitrumSepoliaBaseConfig,
+            }),
+            ...(isArbitrumFork && {
+                accounts: 'remote', // Override defaults accounts for impersonation
+                ...arbitrumBaseConfig,
+            }),
+        },
+        'dev-native': {
+            chainId: 65535,
+            url: process.env.DEV_NODE || 'http://localhost:8545',
+            accounts: {
+                mnemonic: process.env.MNEMONIC || '',
+            },
+            gasPrice: bellecourBaseConfig.gasPrice, // Get closer to Bellecour network
+        },
+        'dev-token': {
+            chainId: 65535,
+            url: process.env.DEV_NODE || 'http://localhost:8545',
+            accounts: {
+                mnemonic: process.env.MNEMONIC || '',
+            },
+            // When deploying on a blockchain with EIP-1559 enabled and
+            // force-sealing disabled, deployment gets stuck if gasPrice is
+            // not manually set. Other approaches might be considered here.
+            gasPrice: 8_000_000_000, // 8 Gwei
+        },
+        arbitrum: {
+            url:
+                process.env.ARBITRUM_RPC_URL || // Used in local development
+                process.env.RPC_URL || // Defined in Github Actions environments
+                'https://arbitrum.gateway.tenderly.co',
+            accounts: _getPrivateKeys(),
+            ...arbitrumBaseConfig,
+        },
+        arbitrumSepolia: {
+            url:
+                process.env.ARBITRUM_SEPOLIA_RPC_URL || // Used in local development
+                process.env.RPC_URL || // Defined in Github Actions environments
+                'https://sepolia-rollup.arbitrum.io/rpc',
+            accounts: _getPrivateKeys(),
+            ...arbitrumSepoliaBaseConfig,
+        },
+        bellecour: {
+            chainId: 134,
+            url: 'https://bellecour.iex.ec',
+            accounts: _getPrivateKeys(),
+            ...bellecourBaseConfig,
+            verify: {
+                etherscan: {
+                    apiUrl: bellecourBlockscoutUrl,
+                    apiKey: '<>',
+                },
+            },
+        },
+    },
+    etherscan: {
+        // Using Etherscan V2 API for unified multichain support
+        apiKey: process.env.EXPLORER_API_KEY || '',
+        customChains: [
+            {
+                network: 'bellecour',
+                chainId: 134,
+                urls: {
+                    apiURL: `${bellecourBlockscoutUrl}/api`,
+                    browserURL: bellecourBlockscoutUrl,
+                },
+            },
+        ],
+    },
+    sourcify: {
+        enabled: true,
+    },
+    typechain: {
+        outDir: 'typechain',
+    },
+    dependencyCompiler: {
+        paths: [
+            'rlc-faucet-contract/contracts/RLC.sol',
+            // ERC-2535 Diamond
+            '@mudgen/diamond-1/contracts/facets/DiamondCutFacet.sol',
+            '@mudgen/diamond-1/contracts/facets/DiamondLoupeFacet.sol',
+            '@mudgen/diamond-1/contracts/facets/OwnershipFacet.sol',
+            '@mudgen/diamond-1/contracts/libraries/LibDiamond.sol',
+            '@mudgen/diamond-1/contracts/upgradeInitializers/DiamondInit.sol',
+            // Used as mock or fake in UTs
+            '@openzeppelin/contracts/interfaces/IERC1271.sol',
+            // Used in deployment
+            '@amxx/factory/contracts/v6/GenericFactory.sol',
+            'createx/src/ICreateX.sol',
+        ],
+        keep: true, // Slither requires compiled dependencies
+    },
+    docgen: {
+        outputDir: 'docs/solidity',
+        templates: 'docs/solidity/templates',
+        exclude: [
+            'external',
+            'facets/FacetBase.sol', // duplicated in FacetBase.v8.sol
+            'facets/IexecAccessorsABILegacyFacet.sol', // not relevant
+            // kept for events 'facets/IexecERC20Core.sol', // contains only internal/private
+            // kept for events 'facets/IexecEscrow.v8.sol', // contains only internal/private
+            'facets/IexecPocoCommon.sol', // contains only internal/private
+            'facets/SignatureVerifier.sol', // contains only internal/private
+            'facets/SignatureVerifier.v8.sol',
+            'interfaces', // interesting for events but too much doc duplication if enabled
+            'tools',
+            'Diamond.sol', // not relevant
+        ],
+    },
+    mocha: { timeout: 300000 },
+    abiExporter: [
+        // ABIs of PoCo contracts for integration with other tools.
+        {
+            path: './abis/contracts',
+            format: 'json',
+            runOnCompile: true,
+            clear: true,
+            only: ['^contracts/'],
+            except: [
+                // !!! Update package.json#files if this is modified.
+                // TODO reorganize utility contracts.
+                '^contracts/tools/testing/',
+                '^contracts/tools/diagrams/',
+                '^contracts/tools/TimelockController',
+            ],
+            rename: (sourceName, contractName) =>
+                `${sourceName.replace('contracts/', '').replace('.sol', '')}`,
+        },
+        // ABIs of all contracts in a human readable format for easier upgrade debugging.
+        {
+            path: './abis/human-readable-abis',
+            format: 'minimal',
+            runOnCompile: true,
+            clear: true,
+        },
+    ],
+};
+
+/**
+ * Ignore doc generation of contracts compiled with [email protected] (unsupported by docgen).
+ */
+task('docgen').setAction(async (taskArgs, hre, runSuper) => {
+    const ignoredSuffix = '.docgen-ignored';
+    const ignoredPaths: string[] = [];
+    for (const path of await hre.artifacts.getBuildInfoPaths()) {
+        const solcVersion: string = JSON.parse(fs.readFileSync(path, 'utf8')).solcVersion;
+        if (solcVersion.startsWith('0.4')) {
+            fs.renameSync(path, path + ignoredSuffix); // mark as docgen ignored
+            ignoredPaths.push(path);
+        }
+    }
+    await runSuper(taskArgs).finally(() => {
+        for (const path of ignoredPaths) {
+            fs.renameSync(path + ignoredSuffix, path); // restore build info as before
+        }
+    });
+});
+
+/**
+ * Override `test` task to copy deployments of Arbitrum Sepolia if running tests on
+ * a forked Arbitrum Sepolia network and clean them up afterwards.
+ */
+task('test').setAction(async (taskArgs: any, hre, runSuper) => {
+    let deploymentsCopied = false;
+    let networkName = '';
+    try {
+        if (isArbitrumSepoliaFork) {
+            networkName = 'arbitrumSepolia';
+            deploymentsCopied = await copyDeployments(networkName);
+        }
+        await runSuper(taskArgs);
+    } finally {
+        if (deploymentsCopied && networkName) {
+            await cleanupDeployments(networkName);
+        }
+    }
+});
+
+function _getPrivateKeys() {
+    const ZERO_PRIVATE_KEY = '0x0000000000000000000000000000000000000000000000000000000000000000';
+    const deployerKey = process.env.DEPLOYER_PRIVATE_KEY || ZERO_PRIVATE_KEY;
+    const adminKey = process.env.ADMIN_PRIVATE_KEY || ZERO_PRIVATE_KEY;
+    return [deployerKey, adminKey];
+}
+
+export default config;