_sanity-check-universal.js

// We require the Hardhat Runtime Environment explicitly here. This is optional
// but useful for running the script in a standalone fashion through `node <script>`.
//
// You can also run a script with `npx hardhat run <script>`. If you do that, Hardhat
// will compile your contracts, add the Hardhat Runtime Environment's members to the
// global scope, and execute the script.
const hre = require("hardhat");
const path = require('path');
const configRelativePath = process.env.CONFIG_PATH || 'config.json';
const configPath = path.join(__dirname, '..' , configRelativePath);
const { areAddressesEqual } = require('./_helpers.js');
const { getIbcApp, getUcHandler } = require("./_vibc-helpers.js");

async function main() {
    const config = require(configPath);


    const accounts = await hre.ethers.getSigners();
    const networkName = hre.network.name;

    // Get the Universal Channel Mw from your IBC enabled contract and comare it with the values in the .env file

    // 1. Get the contract type from the config and get the contract
    const ibcApp = await getIbcApp(networkName, true);

    // 2. Query your app for the Universal Channel Mw address stored
    const ucHandlerAddr = await ibcApp.mw();

    // 3. Compare with the value expected in the .env config file
    let sanityCheck = false;
    let envUcHandlerAddr;

    if (networkName === "optimism") {
        envUcHandlerAddr = config.proofsEnabled === true ? process.env.OP_UC_MW : process.env.OP_UC_MW_SIM;
        sanityCheck = areAddressesEqual(ucHandlerAddr, envUcHandlerAddr);
    } else if (networkName === "base") {
        envUcHandlerAddr = config.proofsEnabled === true ? process.env.BASE_UC_MW : process.env.BASE_UC_MW_SIM;
        sanityCheck = areAddressesEqual(ucHandlerAddr, envUcHandlerAddr);
    }

    // 4. If true, we continue to check the dispatcher stored in the Universal Channel Mw
    let envDispatcherAddr;
    let dispatcherAddr;
    
    if (sanityCheck) {
        const ucHandler = await getUcHandler(networkName);
        dispatcherAddr = await ucHandler.dispatcher();
        if (networkName === "optimism") {
            envDispatcherAddr = config.proofsEnabled === true ? process.env.OP_DISPATCHER : process.env.OP_DISPATCHER_SIM;
            sanityCheck = areAddressesEqual(dispatcherAddr, envDispatcherAddr);
        } else if (networkName === "base") {
            envDispatcherAddr = config.proofsEnabled === true ? process.env.BASE_DISPATCHER : process.env.BASE_DISPATCHER_SIM;
            sanityCheck = areAddressesEqual(dispatcherAddr, envDispatcherAddr);
        } else {
            sanityCheck = false;
        }
    } else {
        console.log(`
⛔ Sanity check failed for network ${networkName}, 
check if the values provided in the .env file for the Universal Channel Mw and the dispatcher are correct.
--------------------------------------------------
🔮 Expected Universal Channel Handler (in IBC contract): ${ucHandlerAddr}...
🗃️ Found Universal Channel Handler (in .env file): ${envUcHandlerAddr}...
--------------------------------------------------
        `);
        return;
    }

    // 5. Print the result of the sanity check
    // If true, it means all values in the contracts check out with those in the .env file and we can continue with the script.
    if (sanityCheck) {
        console.log(`✅ Sanity check passed for network ${networkName}`);
    } else {    
        console.log(`
⛔ Sanity check failed for network ${networkName}, 
check if the values provided in the .env file for the Universal Channel Mw and the dispatcher are correct.
--------------------------------------------------
🔮 Expected Dispatcher (in Universal Channel Handler contract): ${dispatcherAddr}...
🗃️ Found Dispatcher (in .env file): ${envDispatcherAddr}...
--------------------------------------------------
`);
    }
}

// We recommend this pattern to be able to use async/await everywhere
// and properly handle errors.
main().catch((error) => {
    console.error(error);
    process.exitCode = 1;
  });