@hyperlane-xyz/sdk/dist/token/configUtils.js

The official SDK for the Hyperlane Network

import { zeroAddress } from 'viem';
import { objMap, transformObj, } from '@hyperlane-xyz/utils';
import { sortArraysInConfig } from '../utils/ism.js';
import { gasOverhead } from './config.js';
import { HypERC20Deployer } from './deploy.js';
/**
 * Gets gas configuration for a chain
 */
const getGasConfig = (warpDeployConfig, chain) => warpDeployConfig[chain].gas?.toString() ||
    gasOverhead(warpDeployConfig[chain].type).toString();
/**
 * Returns default router addresses and gas values for cross-chain communication.
 * For each remote chain:
 * - Sets up router addresses for message routing
 * - Configures gas values for message processing
 */
export function getDefaultRemoteRouterAndDestinationGasConfig(multiProvider, chain, deployedRoutersAddresses, warpDeployConfig) {
    const remoteRouters = {};
    const destinationGas = {};
    const otherChains = multiProvider
        .getRemoteChains(chain)
        .filter((c) => Object.keys(deployedRoutersAddresses).includes(c));
    for (const otherChain of otherChains) {
        const domainId = multiProvider.getDomainId(otherChain);
        remoteRouters[domainId] = {
            address: deployedRoutersAddresses[otherChain],
        };
        destinationGas[domainId] = getGasConfig(warpDeployConfig, otherChain);
    }
    return [remoteRouters, destinationGas];
}
export function getRouterAddressesFromWarpCoreConfig(warpCoreConfig) {
    return Object.fromEntries(warpCoreConfig.tokens.map((token) => [
        token.chainName,
        token.addressOrDenom,
    ]));
}
export async function expandWarpDeployConfig(multiProvider, warpDeployConfig, deployedRoutersAddresses) {
    const derivedTokenMetadata = await HypERC20Deployer.deriveTokenMetadata(multiProvider, warpDeployConfig);
    return objMap(warpDeployConfig, (chain, config) => {
        const [remoteRouters, destinationGas] = getDefaultRemoteRouterAndDestinationGasConfig(multiProvider, chain, deployedRoutersAddresses, warpDeployConfig);
        return {
            // Default Expansion
            ...derivedTokenMetadata,
            remoteRouters,
            destinationGas,
            hook: zeroAddress,
            interchainSecurityModule: zeroAddress,
            proxyAdmin: { owner: config.owner },
            // User-specified config takes precedence
            ...config,
        };
    });
}
const transformWarpDeployConfigToCheck = (obj, propPath) => {
    // Needed to check if we are currently inside the remoteRouters object
    const maybeRemoteRoutersKey = propPath[propPath.length - 3];
    const parentKey = propPath[propPath.length - 1];
    // Remove the address and ownerOverrides fields if we are not inside the
    // remoteRouters property
    if ((parentKey === 'address' && maybeRemoteRoutersKey !== 'remoteRouters') ||
        parentKey === 'ownerOverrides') {
        return undefined;
    }
    if (typeof obj === 'string' && parentKey !== 'type') {
        return obj.toLowerCase();
    }
    return obj;
};
/**
 * transforms the provided {@link HypTokenRouterConfig}, removing the address, totalSupply and ownerOverrides
 * field where they are not required for the config comparison
 */
export function transformConfigToCheck(obj) {
    return sortArraysInConfig(transformObj(obj, transformWarpDeployConfigToCheck));
}
/**
 * Splits warp deploy config into existing and extended configurations based on warp core chains
 * for the warp apply process.
 */
export function splitWarpCoreAndExtendedConfigs(warpDeployConfig, warpCoreChains) {
    return Object.entries(warpDeployConfig).reduce(([existing, extended], [chain, config]) => {
        if (warpCoreChains.includes(chain)) {
            existing[chain] = config;
        }
        else {
            extended[chain] = config;
        }
        return [existing, extended];
    }, [{}, {}]);
}
//# sourceMappingURL=configUtils.js.map