refactor: warp config loading (hyperlane-xyz#6173)

### Description

This PR refactors the warp route configuration functions to use object
parameters instead of positional parameters, improving API clarity and
flexibility. The main changes include:

- Modified `readWarpRouteDeployConfig` to accept an object parameter
with named properties
- Updated `readWarpCoreConfig` with similar parameter style changes
- Added utility functions for handling warp route configuration in
various scenarios
- Enhanced context types with warp configuration properties

### Drive-by changes

- Added new `getWarpRouteDeployConfig` utility function
- Added `useProvidedWarpRouteIdOrPrompt` helper function
- Improved error messaging and assertions

Diff with last PR:

hyperlane-xyz/hyperlane-monorepo@upgrade/registry-14.0.0...refactor/warp-config-loading

### Related issues

hyperlane-xyz#5244
hyperlane-xyz#5922

### Backward compatibility

Yes - Internal refactoring only, existing CLI commands work the same way

### Testing

Manual testing of CLI commands

Author: mshojaei-txfusion

.changeset/little-houses-crash.md

@@ -0,0 +1,5 @@
+---
+'@hyperlane-xyz/cli': minor
+---
+
+Refactored warp route configuration functions to use object parameters instead of positional parameters for improved clarity and flexibility.

typescript/cli/src/commands/config.ts

@@ -98,7 +98,7 @@ const validateWarpCommand: CommandModuleWithContext<{ path: string }> = {
     path: inputFileCommandOption(),
   },
   handler: async ({ path, context }) => {
-    await readWarpRouteDeployConfig(path, context);
+    await readWarpRouteDeployConfig({ context, filePath: path });
     logGreen('Config is valid');
     process.exit(0);
   },

typescript/cli/src/commands/warp.ts

@@ -120,7 +120,10 @@ export const apply: CommandModuleWithWriteContext<{
 
     if (strategyUrl)
       ChainSubmissionStrategySchema.parse(readYamlOrJson(strategyUrl));
-    const warpDeployConfig = await readWarpRouteDeployConfig(config, context);
+    const warpDeployConfig = await readWarpRouteDeployConfig({
+      filePath: config,
+      context,
+    });
 
     await runWarpRouteApply({
       context,

typescript/cli/src/config/warp.ts

@@ -4,6 +4,7 @@ import { stringify as yamlStringify } from 'yaml';
 import {
   ChainMap,
   DeployedOwnableConfig,
+  HypERC20Deployer,
   IsmConfig,
   IsmType,
   MailboxClientConfig,
@@ -22,13 +23,15 @@ import { errorRed, log, logBlue, logGreen } from '../logger.js';
 import { runMultiChainSelectionStep } from '../utils/chains.js';
 import {
   indentYamlOrJson,
+  isFile,
   readYamlOrJson,
   writeYamlOrJson,
 } from '../utils/files.js';
 import {
   detectAndConfirmOrPrompt,
   setProxyAdminConfig,
 } from '../utils/input.js';
+import { useProvidedWarpRouteIdOrPrompt } from '../utils/warp.js';
 
 import { createAdvancedIsmConfig } from './ism.js';
 
@@ -88,13 +91,24 @@ export async function fillDefaults(
   );
 }
 
-export async function readWarpRouteDeployConfig(
-  filePath: string,
-  context: CommandContext,
-): Promise<WarpRouteDeployConfigMailboxRequired> {
-  let config = readYamlOrJson(filePath);
-  if (!config)
-    throw new Error(`No warp route deploy config found at ${filePath}`);
+export async function readWarpRouteDeployConfig({
+  context,
+  ...args
+}:
+  | {
+      context: CommandContext;
+      warpRouteId: string;
+    }
+  | {
+      context: CommandContext;
+      filePath: string;
+    }): Promise<WarpRouteDeployConfigMailboxRequired> {
+  let config =
+    'filePath' in args
+      ? readYamlOrJson(args.filePath)
+      : await context.registry.getWarpDeployConfig(args.warpRouteId);
+
+  assert(config, `No warp route deploy config found!`);
 
   config = await fillDefaults(context, config as any);
 
@@ -112,7 +126,7 @@ export async function createWarpRouteDeployConfig({
   advanced = false,
 }: {
   context: CommandContext;
-  outPath: string;
+  outPath?: string;
   advanced: boolean;
 }) {
   logBlue('Creating a new warp route deployment config...');
@@ -253,7 +267,21 @@ export async function createWarpRouteDeployConfig({
     const warpRouteDeployConfig = WarpRouteDeployConfigSchema.parse(result);
     logBlue(`Warp Route config is valid, writing to file ${outPath}:\n`);
     log(indentYamlOrJson(yamlStringify(warpRouteDeployConfig, null, 2), 4));
-    writeYamlOrJson(outPath, warpRouteDeployConfig, 'yaml');
+    if (outPath) {
+      writeYamlOrJson(outPath, warpRouteDeployConfig, 'yaml');
+    } else {
+      const tokenMetadata = await HypERC20Deployer.deriveTokenMetadata(
+        context.multiProvider,
+        warpRouteDeployConfig,
+      );
+      assert(
+        tokenMetadata?.symbol,
+        'Error deriving token metadata, please check the provided token addresses',
+      );
+      await context.registry.addWarpRouteConfig(warpRouteDeployConfig, {
+        symbol: tokenMetadata.symbol,
+      });
+    }
     logGreen('✅ Successfully created new warp route deployment config.');
   } catch (e) {
     errorRed(
@@ -269,9 +297,29 @@ function restrictChoices(typeChoices: TokenType[]) {
 
 // Note, this is different than the function above which reads a config
 // for a DEPLOYMENT. This gets a config for using a warp route (aka WarpCoreConfig)
-export function readWarpCoreConfig(filePath: string): WarpCoreConfig {
-  const config = readYamlOrJson(filePath);
-  if (!config) throw new Error(`No warp route config found at ${filePath}`);
+export async function readWarpCoreConfig(
+  args:
+    | {
+        context: CommandContext;
+        warpRouteId: string;
+      }
+    | {
+        filePath: string;
+      },
+): Promise<WarpCoreConfig> {
+  let config: WarpCoreConfig | null = null;
+  const readWithFilePath = 'filePath' in args;
+  if (readWithFilePath) {
+    config = readYamlOrJson(args.filePath);
+  } else {
+    config = await args.context.registry.getWarpRoute(args.warpRouteId);
+  }
+  assert(
+    config,
+    `No warp route config found for warp route ${
+      readWithFilePath ? args.filePath : args.warpRouteId
+    }`,
+  );
   return WarpCoreConfigSchema.parse(config);
 }
 
@@ -310,3 +358,43 @@ function createFallbackRoutingConfig(owner: Address): IsmConfig {
     owner,
   };
 }
+
+export async function getWarpRouteDeployConfig({
+  context,
+  warpRouteDeployConfigPath,
+  warpRouteId: providedWarpRouteId,
+  symbol,
+}: {
+  context: CommandContext;
+  warpRouteDeployConfigPath?: string;
+  warpRouteId?: string;
+  symbol?: string;
+}): Promise<WarpRouteDeployConfigMailboxRequired> {
+  let warpDeployConfig: WarpRouteDeployConfigMailboxRequired;
+
+  if (warpRouteDeployConfigPath) {
+    assert(
+      isFile(warpRouteDeployConfigPath),
+      `Warp route deployment config file not found at ${warpRouteDeployConfigPath}`,
+    );
+    log(`Using warp route deployment config at ${warpRouteDeployConfigPath}`);
+
+    warpDeployConfig = await readWarpRouteDeployConfig({
+      context,
+      filePath: warpRouteDeployConfigPath,
+    });
+  } else {
+    const warpRouteId = await useProvidedWarpRouteIdOrPrompt({
+      warpRouteId: providedWarpRouteId,
+      context,
+      symbol,
+    });
+
+    warpDeployConfig = await readWarpRouteDeployConfig({
+      context,
+      warpRouteId,
+    });
+  }
+
+  return warpDeployConfig;
+}

typescript/cli/src/context/types.ts

@@ -6,6 +6,8 @@ import type {
   ChainMap,
   ChainMetadata,
   MultiProvider,
+  WarpCoreConfig,
+  WarpRouteDeployConfigMailboxRequired,
 } from '@hyperlane-xyz/sdk';
 
 export interface ContextSettings {
@@ -35,6 +37,8 @@ export interface WriteCommandContext extends CommandContext {
   signer: ethers.Signer;
   isDryRun?: boolean;
   dryRunChain?: string;
+  warpDeployConfig?: WarpRouteDeployConfigMailboxRequired;
+  warpCoreConfig?: WarpCoreConfig;
 }
 
 export type CommandModuleWithContext<Args> = CommandModule<

typescript/cli/src/deploy/warp.ts

@@ -120,10 +120,10 @@ export async function runWarpRouteDeploy({
       `Using warp route deployment config at ${warpRouteDeploymentConfigPath}`,
     );
   }
-  const warpRouteConfig = await readWarpRouteDeployConfig(
-    warpRouteDeploymentConfigPath,
+  const warpRouteConfig = await readWarpRouteDeployConfig({
+    filePath: warpRouteDeploymentConfigPath,
     context,
-  );
+  });
 
   const chains = Object.keys(warpRouteConfig);