@hyperlane-xyz/sdk/dist/utils/fork.js

The official SDK for the Hyperlane Network

import { providers } from 'ethers';
import { isValidAddressEvm, rootLogger } from '@hyperlane-xyz/utils';
const ENDPOINT_PREFIX = 'http';
const DEFAULT_ANVIL_ENDPOINT = 'http://127.0.0.1:8545';
export var ANVIL_RPC_METHODS;
(function (ANVIL_RPC_METHODS) {
    ANVIL_RPC_METHODS["RESET"] = "anvil_reset";
    ANVIL_RPC_METHODS["IMPERSONATE_ACCOUNT"] = "anvil_impersonateAccount";
    ANVIL_RPC_METHODS["STOP_IMPERSONATING_ACCOUNT"] = "anvil_stopImpersonatingAccount";
    ANVIL_RPC_METHODS["NODE_INFO"] = "anvil_nodeInfo";
    ANVIL_RPC_METHODS["SET_BALANCE"] = "anvil_setBalance";
    ANVIL_RPC_METHODS["SET_STORAGE_AT"] = "anvil_setStorageAt";
    ANVIL_RPC_METHODS["MINE"] = "anvil_mine";
    ANVIL_RPC_METHODS["SNAPSHOT"] = "evm_snapshot";
    ANVIL_RPC_METHODS["REVERT"] = "evm_revert";
    ANVIL_RPC_METHODS["INCREASE_TIME"] = "evm_increaseTime";
})(ANVIL_RPC_METHODS || (ANVIL_RPC_METHODS = {}));
/**
 * Resets the local node to it's original state (anvil [31337] at block zero).
 */
export const resetFork = async (anvilIPAddr, anvilPort) => {
    rootLogger.info(`Resetting forked network...`);
    const provider = getLocalProvider({ anvilIPAddr, anvilPort });
    await provider.send(ANVIL_RPC_METHODS.RESET, [
        {
            forking: {
                jsonRpcUrl: DEFAULT_ANVIL_ENDPOINT,
            },
        },
    ]);
    rootLogger.info(`✅ Successfully reset forked network`);
};
/**
 * Forks a chain onto the local node at the latest block of the forked network.
 * @param multiProvider the multiProvider with which to fork the network
 * @param chain the network to fork
 */
export const setFork = async (multiProvider, chain, anvilIPAddr, anvilPort) => {
    rootLogger.info(`Forking ${chain} for dry-run...`);
    const provider = getLocalProvider({ anvilIPAddr, anvilPort });
    const currentChainMetadata = multiProvider.metadata[chain];
    await provider.send(ANVIL_RPC_METHODS.RESET, [
        {
            forking: {
                jsonRpcUrl: currentChainMetadata.rpcUrls[0].http,
            },
        },
    ]);
    multiProvider.setProvider(chain, provider);
    rootLogger.info(`✅ Successfully forked ${chain} for dry-run`);
};
/**
 * Impersonates an EOA for a provided address.
 * @param address the address to impersonate
 * @returns the impersonated signer
 */
export const impersonateAccount = async (address, anvilEndPoint) => {
    rootLogger.info(`Impersonating account (${address})...`);
    const provider = getLocalProvider({ urlOverride: anvilEndPoint });
    await provider.send(ANVIL_RPC_METHODS.IMPERSONATE_ACCOUNT, [address]);
    rootLogger.info(`✅ Successfully impersonated account (${address})`);
    return provider.getSigner(address);
};
/**
 * Stops account impersonation.
 * @param address the address to stop impersonating
 */
export const stopImpersonatingAccount = async (address, anvilEndPoint) => {
    rootLogger.info(`Stopping account impersonation for address (${address})...`);
    if (!isValidAddressEvm(address))
        throw new Error(`Cannot stop account impersonation: invalid address format: ${address}`);
    const provider = getLocalProvider({ urlOverride: anvilEndPoint });
    await provider.send(ANVIL_RPC_METHODS.STOP_IMPERSONATING_ACCOUNT, [
        address.substring(2),
    ]);
    rootLogger.info(`✅ Successfully stopped account impersonation for address (${address})`);
};
/**
 * Retrieves a local provider. Defaults to DEFAULT_ANVIL_ENDPOINT.
 * @param urlOverride custom URL to overried the default endpoint
 * @returns a local JSON-RPC provider
 */
export const getLocalProvider = ({ anvilIPAddr, anvilPort, urlOverride, } = {}) => {
    let envUrl;
    if (anvilIPAddr && anvilPort)
        envUrl = `${ENDPOINT_PREFIX}${anvilIPAddr}:${anvilPort}`;
    if (urlOverride && !urlOverride.startsWith(ENDPOINT_PREFIX)) {
        rootLogger.warn(`⚠️ Provided URL override (${urlOverride}) does not begin with ${ENDPOINT_PREFIX}. Defaulting to ${envUrl ?? DEFAULT_ANVIL_ENDPOINT}`);
        urlOverride = undefined;
    }
    const url = urlOverride ?? envUrl ?? DEFAULT_ANVIL_ENDPOINT;
    return new providers.JsonRpcProvider(url);
};
export async function setBalance(provider, address, balanceWei) {
    await provider.send(ANVIL_RPC_METHODS.SET_BALANCE, [address, balanceWei]);
}
export async function setStorageAt(provider, contractAddress, slot, value) {
    await provider.send(ANVIL_RPC_METHODS.SET_STORAGE_AT, [
        contractAddress,
        slot,
        value,
    ]);
}
export async function mine(provider, blocks = 1) {
    await provider.send(ANVIL_RPC_METHODS.MINE, [blocks]);
}
export async function increaseTime(provider, seconds) {
    await provider.send(ANVIL_RPC_METHODS.INCREASE_TIME, [seconds]);
}
export async function snapshot(provider) {
    return provider.send(ANVIL_RPC_METHODS.SNAPSHOT, []);
}
export async function revertToSnapshot(provider, snapshotId) {
    return provider.send(ANVIL_RPC_METHODS.REVERT, [snapshotId]);
}
export async function impersonateAccounts(provider, accounts) {
    await Promise.all(accounts.map((address) => provider.send(ANVIL_RPC_METHODS.IMPERSONATE_ACCOUNT, [address])));
}
//# sourceMappingURL=fork.js.map