voucherHubUtils.ts

// SPDX-FileCopyrightText: 2024-2025 IEXEC BLOCKCHAIN TECH <contact@iex.ec>
// SPDX-License-Identifier: Apache-2.0

import { ContractFactory } from 'ethers';
import hre, { ethers, upgrades } from 'hardhat';
import { getDeploymentConfig } from '../deploy/deploy';
import { VoucherHub, VoucherProxy__factory } from '../typechain-types';

export async function deployHub(
    admin: string,
    manager: string,
    minter: string,
    iexecPoco: string,
    beacon: string,
): Promise<VoucherHub> {
    const VoucherHubFactory = await ethers.getContractFactory('VoucherHub');
    // @dev Type declaration produces a warning until feature is supported by
    // openzeppelin plugin. See "Support TypeChain in deployProxy function":
    // https://github.com/OpenZeppelin/openzeppelin-upgrades/pull/535
    const contract: unknown = await upgrades.deployProxy(VoucherHubFactory, [
        admin,
        manager,
        minter,
        iexecPoco,
        beacon,
    ]);
    // Workaround openzeppelin-upgrades/pull/535;
    const voucherHub = contract as VoucherHub;
    return await voucherHub.waitForDeployment();
}

export async function upgradeProxy(
    voucherHubAddress: string,
    newVoucherHubImplementationFactory: ContractFactory,
): Promise<VoucherHub> {
    const contractUpgrade: unknown = await upgrades
        .upgradeProxy(voucherHubAddress, newVoucherHubImplementationFactory)
        .then((contract) => contract.waitForDeployment());
    return contractUpgrade as VoucherHub;
}

/**
 * Get the expected VoucherProxy creationCode hash to prevent botched upgrades.
 * @returns value of the hash
 */
export async function getExpectedVoucherProxyCodeHash(voucherBeaconAddress: string) {
    const chainId = (await ethers.provider.getNetwork()).chainId.toString();
    const config = await getDeploymentConfig(Number(chainId));
    if (chainId == '134') {
        // See https://blockscout.bellecour.iex.ec/token/0x3137B6DF4f36D338b82260eDBB2E7bab034AFEda?tab=read_proxy
        // `getVoucherProxyCodeHash` >
        return '0x2a2da9e75edfb4be8fa6cf0e9bd092957dd28ffa588d8528ca66a5cd3712ffa2';
    }
    if (!config.factory || (hre as any).__SOLIDITY_COVERAGE_RUNNING) {
        /**
         * @dev Voucher proxy code hash is different from the production one:
         * - when running "test" without generic factory since voucher beacon address
         *   becomes not-deterministic (the EOA deployer nonce is involved).
         * - when running "coverage" since the later re-compiles contracts already
         *   compiled with standard "compile", which  might come from Solidity-coverage:
         *      - injecting statements into our Solidity code [1]
         *      - or eventually tampering our solc options (optimizer, ..) [2]
         * [1]: https://github.com/sc-forks/solidity-coverage/blob/v0.8.10/docs/faq.md#notes-on-gas-distortion
         * [2]: https://github.com/sc-forks/solidity-coverage/blob/v0.8.10/docs/faq.md#running-out-of-stack
         *
         * The expected returned value below mimics the following Solidity piece of code:
         * ```
         * abi.encodePacked(
         *     type(VoucherProxy).creationCode, // bytecode
         *     abi.encode($._voucherBeacon) // constructor args
         * )
         * ```
         */
        return ethers.solidityPackedKeccak256(
            ['bytes', 'bytes32'],
            [
                VoucherProxy__factory.bytecode, // bytecode
                ethers.zeroPadValue(voucherBeaconAddress, 32), // constructor args
            ],
        );
    } else {
        /**
         * @dev This is the voucher proxy code hash value expected in production,
         * where contracts are deployed through a generic factory, hence having
         * deterministic addresses.
         *
         * Note: Look very carefully before updating this value to avoid messing with
         * existing vouchers already deployed in production.
         *
         * Also see test/NextVersionUpgrade.test.ts to double check behavior.
         */
        return '0xe0f74e59778f75b77efb2064c8358a84106c7a95517a2c8503e38996071e6522';
    }
}