fix: resolve import cycle warnings (#7980)

Author: paulbalaji

.changeset/fix-import-cycles.md

@@ -0,0 +1,8 @@
+---
+'@hyperlane-xyz/cli': patch
+'@hyperlane-xyz/infra': patch
+'@hyperlane-xyz/relayer': patch
+'@hyperlane-xyz/sdk': patch
+---
+
+Import cycles flagged by oxlint were resolved by extracting shared code into dedicated leaf modules, performing a hard cutover (no backcompat re-exports), and using dependency injection for submitter factories and aggregation metadata decoding. The `import/no-cycle` lint rule is now enforced as an error.

.changeset/provider-sdk-remove-protocol-subpath-reexports.md

@@ -0,0 +1,5 @@
+---
+'@hyperlane-xyz/provider-sdk': major
+---
+
+Breaking: the `./protocol` subpath no longer re-exports `ProtocolType`, `ProtocolTypeValue`, or `ProtocolSmallestUnit`. These were moved to the new `./protocolType` module to break an import cycle. Import them from the main `@hyperlane-xyz/provider-sdk` entry instead.

oxlint.json

@@ -38,7 +38,7 @@
     "import/no-named-as-default": "warn",
     "import/no-duplicates": "warn",
     "@typescript-eslint/no-require-imports": "warn",
-    "import/no-cycle": "off",
+    "import/no-cycle": "error",
     "guard-for-in": "error",
     "import/no-self-import": "error",
     "no-console": "error",

typescript/cli/src/config/warp.ts

@@ -41,8 +41,6 @@ import {
   getWarpRouteIdFromWarpDeployConfig,
   setProxyAdminConfig,
 } from '../utils/input.js';
-import { resolveWarpRouteId } from '../utils/warp.js';
-
 import { createAdvancedIsmConfig } from './ism.js';
 
 const TYPE_DESCRIPTIONS: Record<DeployableTokenType, string> = {
@@ -465,27 +463,3 @@ function createFallbackRoutingConfig(owner: Address): IsmConfig {
     owner,
   };
 }
-
-export async function getWarpRouteDeployConfig({
-  context,
-  warpRouteId,
-}: {
-  context: CommandContext;
-  warpRouteId?: string;
-}): Promise<{
-  config: WarpRouteDeployConfigMailboxRequired;
-  resolvedWarpRouteId: string;
-}> {
-  const resolvedWarpRouteId = await resolveWarpRouteId({
-    warpRouteId,
-    context,
-    promptByDeploymentConfigs: true,
-  });
-
-  const config = await readWarpRouteDeployConfig({
-    context,
-    warpRouteId: resolvedWarpRouteId,
-  });
-
-  return { config, resolvedWarpRouteId };
-}

typescript/cli/src/context/apiKeys.ts

@@ -0,0 +1,57 @@
+import { confirm } from '@inquirer/prompts';
+
+import { type IRegistry } from '@hyperlane-xyz/registry';
+import {
+  type ChainMap,
+  type ChainMetadata,
+  type ChainName,
+  ExplorerFamily,
+} from '@hyperlane-xyz/sdk';
+
+import { detectAndConfirmOrPrompt } from '../utils/input.js';
+
+export async function requestAndSaveApiKeys(
+  chains: ChainName[],
+  chainMetadata: ChainMap<ChainMetadata>,
+  registry: IRegistry,
+): Promise<ChainMap<string>> {
+  const apiKeys: ChainMap<string> = {};
+
+  for (const chain of chains) {
+    const blockExplorer = chainMetadata[chain]?.blockExplorers?.[0];
+    if (blockExplorer?.family !== ExplorerFamily.Etherscan) {
+      continue;
+    }
+    if (blockExplorer?.apiKey) {
+      apiKeys[chain] = blockExplorer.apiKey;
+      continue;
+    }
+    const wantApiKey = await confirm({
+      default: false,
+      message: `Do you want to use an API key to verify on this (${chain}) chain's block explorer`,
+    });
+    if (wantApiKey) {
+      apiKeys[chain] = await detectAndConfirmOrPrompt(
+        async () => {
+          const blockExplorers = chainMetadata[chain].blockExplorers;
+          if (!(blockExplorers && blockExplorers.length > 0)) return;
+          for (const blockExplorer of blockExplorers) {
+            /* The current apiKeys mapping only accepts one key, even if there are multiple explorer options present. */
+            if (blockExplorer.apiKey) return blockExplorer.apiKey;
+          }
+          return undefined;
+        },
+        `Enter an API key for the ${chain} explorer`,
+        `${chain} api key`,
+        `${chain} metadata blockExplorers config`,
+      );
+      chainMetadata[chain].blockExplorers![0].apiKey = apiKeys[chain];
+      await registry.updateChain({
+        chainName: chain,
+        metadata: chainMetadata[chain],
+      });
+    }
+  }
+
+  return apiKeys;
+}

typescript/cli/src/context/context.ts

@@ -1,4 +1,3 @@
-import { confirm } from '@inquirer/prompts';
 import { type ethers } from 'ethers';
 
 import { loadProtocolProviders } from '@hyperlane-xyz/deploy-sdk';
@@ -11,9 +10,7 @@ import { type IRegistry } from '@hyperlane-xyz/registry';
 import { getRegistry } from '@hyperlane-xyz/registry/fs';
 import {
   type ChainMap,
-  type ChainMetadata,
   type ChainName,
-  ExplorerFamily,
   MultiProtocolProvider,
   MultiProvider,
 } from '@hyperlane-xyz/sdk';
@@ -27,7 +24,6 @@ import {
 
 import { isSignCommand } from '../commands/signCommands.js';
 import { readChainSubmissionStrategyConfig } from '../config/strategy.js';
-import { detectAndConfirmOrPrompt } from '../utils/input.js';
 import { getSigner } from '../utils/keys.js';
 
 import { createAltVMSigners } from './altvm.js';
@@ -315,60 +311,6 @@ async function getMultiProtocolProvider(registry: IRegistry) {
   return new MultiProtocolProvider(chainMetadata);
 }
 
-/**
- * Requests and saves Block Explorer API keys for the specified chains, prompting the user if necessary.
- *
- * @param chains - The list of chain names to request API keys for.
- * @param chainMetadata - The chain metadata, used to determine if an API key is already configured.
- * @param registry - The registry used to update the chain metadata with the new API key.
- * @returns A mapping of chain names to their API keys.
- */
-export async function requestAndSaveApiKeys(
-  chains: ChainName[],
-  chainMetadata: ChainMap<ChainMetadata>,
-  registry: IRegistry,
-): Promise<ChainMap<string>> {
-  const apiKeys: ChainMap<string> = {};
-
-  for (const chain of chains) {
-    const blockExplorer = chainMetadata[chain]?.blockExplorers?.[0];
-    if (blockExplorer?.family !== ExplorerFamily.Etherscan) {
-      continue;
-    }
-    if (blockExplorer?.apiKey) {
-      apiKeys[chain] = blockExplorer.apiKey;
-      continue;
-    }
-    const wantApiKey = await confirm({
-      default: false,
-      message: `Do you want to use an API key to verify on this (${chain}) chain's block explorer`,
-    });
-    if (wantApiKey) {
-      apiKeys[chain] = await detectAndConfirmOrPrompt(
-        async () => {
-          const blockExplorers = chainMetadata[chain].blockExplorers;
-          if (!(blockExplorers && blockExplorers.length > 0)) return;
-          for (const blockExplorer of blockExplorers) {
-            /* The current apiKeys mapping only accepts one key, even if there are multiple explorer options present. */
-            if (blockExplorer.apiKey) return blockExplorer.apiKey;
-          }
-          return undefined;
-        },
-        `Enter an API key for the ${chain} explorer`,
-        `${chain} api key`,
-        `${chain} metadata blockExplorers config`,
-      );
-      chainMetadata[chain].blockExplorers![0].apiKey = apiKeys[chain];
-      await registry.updateChain({
-        chainName: chain,
-        metadata: chainMetadata[chain],
-      });
-    }
-  }
-
-  return apiKeys;
-}
-
 /**
  * Ensures EVM signers are attached to multiProvider for the specified chains.
  * This is useful for commands that do interactive chain selection after the

typescript/cli/src/context/strategies/chain/chainResolver.ts

@@ -14,7 +14,6 @@ import { ProtocolType, assert, isEVMLike } from '@hyperlane-xyz/utils';
 import { CommandType } from '../../../commands/signCommands.js';
 import { readCoreDeployConfigs } from '../../../config/core.js';
 import { getTransactions } from '../../../config/submit.js';
-import { getWarpRouteDeployConfig } from '../../../config/warp.js';
 import { readChainSubmissionStrategy } from '../../../deploy/warp.js';
 import { type ExtendedSubmissionStrategy } from '../../../submitters/types.js';
 import {
@@ -24,9 +23,10 @@ import {
 import { getOrderedWarpSendChains } from '../../../utils/warp-send.js';
 import {
   getWarpConfigs,
+  getWarpRouteDeployConfig,
   getWarpCoreConfigOrExit,
 } from '../../../utils/warp.js';
-import { requestAndSaveApiKeys } from '../../context.js';
+import { requestAndSaveApiKeys } from '../../apiKeys.js';
 
 /**
  * Resolves chains based on command type.

typescript/cli/src/deploy/warp.ts

@@ -69,7 +69,7 @@ import {
   rootLogger,
 } from '@hyperlane-xyz/utils';
 
-import { requestAndSaveApiKeys } from '../context/context.js';
+import { requestAndSaveApiKeys } from '../context/apiKeys.js';
 import { type WriteCommandContext } from '../context/types.js';
 import {
   errorRed,

typescript/cli/src/ism/deploy.ts

@@ -17,7 +17,7 @@ import {
 } from '@hyperlane-xyz/sdk';
 import { type Address, assert, isEVMLike, mustGet } from '@hyperlane-xyz/utils';
 
-import { requestAndSaveApiKeys } from '../context/context.js';
+import { requestAndSaveApiKeys } from '../context/apiKeys.js';
 import { type WriteCommandContext } from '../context/types.js';
 import {
   completeDeploy,

typescript/cli/src/utils/warp.ts

@@ -145,14 +145,14 @@ export async function resolveWarpRouteId(args: {
       );
     }
 
-    return (await search({
+    return search<string>({
       message: `Multiple routes found for "${symbol}". Select one:`,
       source: (term) =>
         matchingIds.filter((id) =>
           id.toLowerCase().includes(term?.toLowerCase() || ''),
         ),
       pageSize: 20,
-    })) as string;
+    });
   }
 
   assert(
@@ -178,14 +178,14 @@ export async function resolveWarpRouteId(args: {
     return routeIds[0];
   }
 
-  return (await search({
+  return search<string>({
     message: 'Select a warp route:',
     source: (term) =>
       routeIds.filter((id) =>
         id.toLowerCase().includes(term?.toLowerCase() || ''),
       ),
     pageSize: 20,
-  })) as string;
+  });
 }
 
 export async function getWarpConfigs({
@@ -219,6 +219,30 @@ export async function getWarpConfigs({
   return { warpDeployConfig, warpCoreConfig, resolvedWarpRouteId };
 }
 
+export async function getWarpRouteDeployConfig({
+  context,
+  warpRouteId,
+}: {
+  context: CommandContext;
+  warpRouteId?: string;
+}): Promise<{
+  config: WarpRouteDeployConfigMailboxRequired;
+  resolvedWarpRouteId: string;
+}> {
+  const resolvedWarpRouteId = await resolveWarpRouteId({
+    warpRouteId,
+    context,
+    promptByDeploymentConfigs: true,
+  });
+
+  const config = await readWarpRouteDeployConfig({
+    context,
+    warpRouteId: resolvedWarpRouteId,
+  });
+
+  return { config, resolvedWarpRouteId };
+}
+
 export function filterWarpConfigsToMatchingChains(
   warpDeployConfig: WarpRouteDeployConfigMailboxRequired,
   warpCoreConfig: WarpCoreConfig,