feat: unify warp route checks onto shared logic (#8554)

Author: paulbalaji

.changeset/real-bugs-dance.md

@@ -0,0 +1,6 @@
+---
+'@hyperlane-xyz/cli': patch
+'@hyperlane-xyz/sdk': major
+---
+
+Warp route checks were unified onto the shared CLI comparison flow, including explicit proxyAdmin address checks and owner override ownership checks. The legacy `HypERC20App` and `HypERC20Checker` SDK exports were removed.

typescript/cli/cli.ts

@@ -49,7 +49,9 @@ ignoreBrokenPipe(process.stderr);
 
 console.log(chalk.blue('Hyperlane'), chalk.magentaBright('CLI'));
 
-await checkVersion();
+if (!process.env.CI && process.env.HYPERLANE_SKIP_VERSION_CHECK !== '1') {
+  await checkVersion();
+}
 
 try {
   await yargs(process.argv.slice(2))

typescript/cli/src/check/warp.ts

@@ -2,19 +2,13 @@ import { stringify as yamlStringify } from 'yaml';
 
 import {
   type AccountConfig,
-  type DerivedWarpRouteDeployConfig,
-  type HypTokenRouterVirtualConfig,
   InterchainAccount,
+  type WarpRouteCheckResult,
   type WarpRouteDeployConfigMailboxRequired,
-  derivedHookAddress,
-  derivedIsmAddress,
-  transformConfigToCheck,
-  verifyScale,
 } from '@hyperlane-xyz/sdk';
 import {
   type ObjectDiff,
   assert,
-  diffObjMerge,
   eqAddress,
   isEVMLike,
   keepOnlyDiffObjects,
@@ -26,81 +20,23 @@ import { log, logGreen, logRed, warnYellow } from '../logger.js';
 import { formatYamlViolationsOutput } from '../utils/output.js';
 
 export async function runWarpRouteCheck({
-  warpRouteConfig,
-  onChainWarpConfig,
+  result,
 }: {
-  warpRouteConfig: WarpRouteDeployConfigMailboxRequired &
-    Record<string, Partial<HypTokenRouterVirtualConfig>>;
-  onChainWarpConfig: DerivedWarpRouteDeployConfig &
-    Record<string, Partial<HypTokenRouterVirtualConfig>>;
+  result: WarpRouteCheckResult;
 }): Promise<void> {
-  // Check whether the decimals are consistent. If not, ensure that the scale is correct.
-  const decimalsAreValid = verifyDecimalsAndScale(warpRouteConfig);
-
-  // Go through each chain and only add to the output the chains that have mismatches
-  const [violations, isInvalid] = Object.keys(warpRouteConfig).reduce(
-    (acc, chain) => {
-      const expectedDeployedConfig = warpRouteConfig[chain];
-      const currentDeployedConfig = onChainWarpConfig[chain];
-
-      // If the expected config specifies the hook or the ism as an address instead of the full config
-      // compare just the addresses
-      if (typeof expectedDeployedConfig.hook === 'string') {
-        currentDeployedConfig.hook = derivedHookAddress(currentDeployedConfig);
-      }
-
-      if (typeof expectedDeployedConfig.interchainSecurityModule === 'string') {
-        currentDeployedConfig.interchainSecurityModule = derivedIsmAddress(
-          currentDeployedConfig,
-        );
-      }
-
-      // if the input config does not specify the expected contractVersion we skip to
-      // avoid triggering a false positive
-      if (!expectedDeployedConfig.contractVersion) {
-        currentDeployedConfig.contractVersion = undefined;
-      }
-
-      const { mergedObject, isInvalid } = diffObjMerge(
-        transformConfigToCheck(currentDeployedConfig),
-        transformConfigToCheck(expectedDeployedConfig),
-      );
-
-      if (isInvalid) {
-        acc[0][chain] = mergedObject;
-        acc[1] ||= isInvalid;
-      }
-
-      return acc;
-    },
-    [{}, false] as [{ [index: string]: ObjectDiff }, boolean],
-  );
+  if (Object.keys(result.diff).length > 0) {
+    log(formatYamlViolationsOutput(yamlStringify(result.diff, null, 2)));
+  }
 
-  if (isInvalid) {
-    log(
-      formatYamlViolationsOutput(
-        yamlStringify(keepOnlyDiffObjects(violations), null, 2),
-      ),
-    );
-    process.exit(1);
+  if (result.scaleViolations.length > 0) {
+    logRed(`Found invalid or missing scale for inconsistent decimals`);
   }
 
-  if (!decimalsAreValid) {
+  if (!result.isValid) {
     process.exit(1);
   }
-  logGreen(`No violations found`);
-}
 
-function verifyDecimalsAndScale(
-  warpRouteConfig: WarpRouteDeployConfigMailboxRequired &
-    Record<string, Partial<HypTokenRouterVirtualConfig>>,
-): boolean {
-  let valid = true;
-  if (!verifyScale(warpRouteConfig)) {
-    logRed(`Found invalid or missing scale for inconsistent decimals`);
-    valid = false;
-  }
-  return valid;
+  logGreen(`No violations found`);
 }
 
 /**

typescript/cli/src/commands/warp.ts

@@ -6,16 +6,13 @@ import { RebalancerConfig, RebalancerService } from '@hyperlane-xyz/rebalancer';
 import {
   type RawForkedChainConfigByChain,
   RawForkedChainConfigByChainSchema,
-  expandVirtualWarpDeployConfig,
-  expandWarpDeployConfig,
-  getRouterAddressesFromWarpCoreConfig,
+  checkWarpRouteDeployConfig,
 } from '@hyperlane-xyz/sdk';
 import {
   assert,
   difference,
   intersection,
   isEVMLike,
-  objFilter,
   rootLogger,
 } from '@hyperlane-xyz/utils';
 
@@ -42,7 +39,7 @@ import {
   logCommandHeader,
   logGreen,
 } from '../logger.js';
-import { getWarpRouteConfigsByCore, runWarpRouteRead } from '../read/warp.js';
+import { runWarpRouteRead } from '../read/warp.js';
 import { sendTestTransfer } from '../send/transfer.js';
 import { ExtendedChainSubmissionStrategySchema } from '../submitters/types.js';
 import {
@@ -584,44 +581,14 @@ export const check: CommandModuleWithContext<
       warpCoreConfig,
     ));
 
-    const deployedRoutersAddresses =
-      getRouterAddressesFromWarpCoreConfig(warpCoreConfig);
-
-    // Remove any non EVM chain configs to avoid the checker crashing
-    warpCoreConfig.tokens = warpCoreConfig.tokens.filter((config) =>
-      isEVMLike(
-        context.multiProvider.getChainMetadata(config.chainName).protocol,
-      ),
-    );
-
-    // Get on-chain config
-    const onChainWarpConfig = await getWarpRouteConfigsByCore({
-      context,
-      warpCoreConfig,
-    });
-
-    // get virtual on-chain config
-    const expandedOnChainWarpConfig = await expandVirtualWarpDeployConfig({
-      multiProvider: context.multiProvider,
-      onChainWarpConfig,
-      deployedRoutersAddresses,
-    });
-
-    let expandedWarpDeployConfig = await expandWarpDeployConfig({
+    const result = await checkWarpRouteDeployConfig({
       multiProvider: context.multiProvider,
+      warpCoreConfig,
       warpDeployConfig,
-      deployedRoutersAddresses,
-      expandedOnChainWarpConfig,
     });
-    expandedWarpDeployConfig = objFilter(
-      expandedWarpDeployConfig,
-      (chain, _config): _config is any =>
-        isEVMLike(context.multiProvider.getChainMetadata(chain).protocol),
-    );
 
     await runWarpRouteCheck({
-      onChainWarpConfig: expandedOnChainWarpConfig,
-      warpRouteConfig: expandedWarpDeployConfig,
+      result,
     });
 
     process.exit(0);

typescript/infra/config/warp.ts

@@ -7,6 +7,7 @@ import {
   MultiProvider,
   OwnableConfig,
   WarpRouteDeployConfig,
+  WarpRouteDeployConfigMailboxRequired,
 } from '@hyperlane-xyz/sdk';
 import { assert, objMap, promiseObjAll } from '@hyperlane-xyz/utils';
 
@@ -266,12 +267,10 @@ export const sandboxStrategyConfigGetterMap: Record<
 /**
  * Retrieves the Warp configuration for the specified Warp route ID by fetching it from the FileSystemRegistry and GithubRegistry
  */
-async function getConfigFromMergedRegistry(
-  _routerConfig: ChainMap<RouterConfigWithoutOwner>,
-  _abacusWorksEnvOwnerConfig: ChainMap<OwnableConfig>,
+export async function getWarpDeployConfigFromMergedRegistry(
   warpRouteId: string,
   registryUris: string[],
-): Promise<ChainMap<HypTokenRouterConfig>> {
+): Promise<WarpRouteDeployConfigMailboxRequired> {
   const registry = getRegistry({
     registryUris,
     enableProxy: true,
@@ -289,7 +288,7 @@ async function getConfigFromMergedRegistry(
  */
 export async function getWarpConfigMapFromMergedRegistry(
   registryUris: string[],
-): Promise<Record<string, ChainMap<HypTokenRouterConfig>>> {
+): Promise<Record<string, WarpRouteDeployConfigMailboxRequired>> {
   const registry = getRegistry({
     registryUris,
     enableProxy: true,
@@ -317,7 +316,7 @@ export async function getWarpConfigMapFromMergedRegistry(
 async function populateWarpRouteMailboxAddresses(
   warpRoute: WarpRouteDeployConfig,
   registry: IRegistry,
-): Promise<ChainMap<HypTokenRouterConfig>> {
+): Promise<WarpRouteDeployConfigMailboxRequired> {
   const mailboxPromises = objMap(warpRoute, async (chainName, config) => {
     const mailbox =
       config.mailbox || (await registry.getChainAddresses(chainName))?.mailbox;
@@ -339,7 +338,28 @@ export async function getWarpConfig(
   warpRouteId: string,
   registryUris = [DEFAULT_REGISTRY_URI],
   forceRegistryConfig = false,
+  getterInputs?: WarpConfigGetterInputs,
 ): Promise<ChainMap<HypTokenRouterConfig>> {
+  const { abacusWorksEnvOwnerConfig, routerConfigWithoutOwner } =
+    getterInputs ?? (await getWarpConfigGetterInputs(multiProvider, envConfig));
+  return getWarpConfigWithGetterInputs(
+    warpRouteId,
+    routerConfigWithoutOwner,
+    abacusWorksEnvOwnerConfig,
+    registryUris,
+    forceRegistryConfig,
+  );
+}
+
+export interface WarpConfigGetterInputs {
+  abacusWorksEnvOwnerConfig: ChainMap<OwnableConfig>;
+  routerConfigWithoutOwner: ChainMap<RouterConfigWithoutOwner>;
+}
+
+export async function getWarpConfigGetterInputs(
+  multiProvider: MultiProvider,
+  envConfig: EnvironmentConfig,
+): Promise<WarpConfigGetterInputs> {
   const routerConfig = await getRouterConfigsForAllVms(
     envConfig,
     multiProvider,
@@ -362,6 +382,19 @@ export async function getWarpConfig(
     };
   });
 
+  return {
+    abacusWorksEnvOwnerConfig,
+    routerConfigWithoutOwner,
+  };
+}
+
+async function getWarpConfigWithGetterInputs(
+  warpRouteId: string,
+  routerConfigWithoutOwner: ChainMap<RouterConfigWithoutOwner>,
+  abacusWorksEnvOwnerConfig: ChainMap<OwnableConfig>,
+  registryUris = [DEFAULT_REGISTRY_URI],
+  forceRegistryConfig = false,
+): Promise<ChainMap<HypTokenRouterConfig>> {
   const warpConfigGetter = warpConfigGetterMap[warpRouteId];
   if (warpConfigGetter && !forceRegistryConfig) {
     return warpConfigGetter(
@@ -371,10 +404,5 @@ export async function getWarpConfig(
     );
   }
 
-  return getConfigFromMergedRegistry(
-    routerConfigWithoutOwner,
-    abacusWorksEnvOwnerConfig,
-    warpRouteId,
-    registryUris,
-  );
+  return getWarpDeployConfigFromMergedRegistry(warpRouteId, registryUris);
 }

typescript/infra/scripts/agent-utils.ts

@@ -71,7 +71,6 @@ export enum Modules {
   INTERCHAIN_QUERY_SYSTEM = 'iqs',
   TEST_QUERY_SENDER = 'testquerysender',
   TEST_RECIPIENT = 'testrecipient',
-  WARP = 'warp',
   HAAS = 'haas',
   CCIP = 'ccip',
 }

typescript/infra/scripts/check/check-deploy.ts

@@ -1,35 +1,24 @@
+import { assert } from '@hyperlane-xyz/utils';
+
 import {
   getCheckDeployArgs,
   getGovernor,
   logViolations,
 } from './check-utils.js';
 
 async function main() {
-  const {
-    module,
-    context,
-    environment,
-    asDeployer,
-    chains,
-    fork,
-    govern,
-    warpRouteId,
-    registry,
-    forceRegistryConfig,
-  } = await getCheckDeployArgs().argv;
+  const { module, context, environment, asDeployer, chains, fork, govern } =
+    await getCheckDeployArgs().argv;
+  assert(module, 'Module is required');
 
   const governor = await getGovernor(
     module,
     context,
     environment,
     asDeployer,
-    warpRouteId,
     chains,
     fork,
     govern,
-    undefined,
-    registry,
-    forceRegistryConfig,
   );
 
   if (fork) {