feat: check-deploy with --registry (#5621)

### Description
This PR 
- allows check-deploy to run with a `--registry` instead of having to
check out the Registry branch. This is similar to how CLI's parameter.
- Update getConfigFromMergedRegistry() to fetch from the array in
`--registry`
- Adds new functions getWarpCoreConfigFromMergedRegistry() and
getWarpAddressesFromMergedRegistry() to fetch from the array in
`--registry`
- requires `--warpRouteId` to be filled in and no longer depend on the
warpRouteIds mapping

### Related issues
- Fixes #5240 

### Backward compatibility
Yes - We now fetch from the FileSystem and Github Registry instead of
just FileSystem

### Testing
Manual

Author: ltyu

typescript/infra/config/registry.ts

@@ -7,7 +7,10 @@ import {
   PartialRegistry,
   warpConfigToWarpAddresses,
 } from '@hyperlane-xyz/registry';
-import { FileSystemRegistry } from '@hyperlane-xyz/registry/fs';
+import {
+  FileSystemRegistry,
+  getRegistry as getMergedRegistry,
+} from '@hyperlane-xyz/registry/fs';
 import {
   ChainMap,
   ChainMetadata,
@@ -112,6 +115,32 @@ export function getWarpAddresses(
   return warpConfigToWarpAddresses(warpCoreConfig);
 }
 
+export async function getWarpCoreConfigFromMergedRegistry(
+  warpRouteId: string,
+  registryUris: string[],
+): Promise<WarpCoreConfig> {
+  const registry = getMergedRegistry({ registryUris, enableProxy: true });
+  const warpRouteConfig = await registry.getWarpRoute(warpRouteId);
+
+  if (!warpRouteConfig) {
+    throw new Error(
+      `Warp route config for ${warpRouteId} not found in registry`,
+    );
+  }
+  return warpRouteConfig;
+}
+
+export async function getWarpAddressesFromMergedRegistry(
+  warpRouteId: string,
+  registryUris: string[],
+): Promise<ChainMap<ChainAddresses>> {
+  const warpCoreConfig = await getWarpCoreConfigFromMergedRegistry(
+    warpRouteId,
+    registryUris,
+  );
+  return warpConfigToWarpAddresses(warpCoreConfig);
+}
+
 export function getEnvChains(env: DeployEnvironment): ChainName[] {
   if (env === 'mainnet3') return mainnet3Chains;
   if (env === 'testnet4') return testnet4Chains;

typescript/infra/config/warp.ts

@@ -136,9 +136,10 @@ async function getConfigFromMergedRegistry(
   _routerConfig: ChainMap<RouterConfigWithoutOwner>,
   _abacusWorksEnvOwnerConfig: ChainMap<OwnableConfig>,
   warpRouteId: string,
+  registryUris: string[],
 ): Promise<ChainMap<HypTokenRouterConfig>> {
   const registry = getRegistry({
-    registryUris: [DEFAULT_REGISTRY_URI],
+    registryUris,
     enableProxy: true,
   });
   const warpRoute = await registry.getWarpDeployConfig(warpRouteId);
@@ -176,6 +177,7 @@ export async function getWarpConfig(
   multiProvider: MultiProvider,
   envConfig: EnvironmentConfig,
   warpRouteId: string,
+  registryUris = [DEFAULT_REGISTRY_URI],
 ): Promise<ChainMap<HypTokenRouterConfig>> {
   const routerConfig = await getRouterConfigsForAllVms(
     envConfig,
@@ -212,5 +214,6 @@ export async function getWarpConfig(
     routerConfigWithoutOwner,
     abacusWorksEnvOwnerConfig,
     warpRouteId,
+    registryUris,
   );
 }

typescript/infra/scripts/agent-utils.ts

@@ -201,22 +201,26 @@ export function withOutputFile<T>(args: Argv<T>) {
     .alias('o', 'outFile');
 }
 
-export function withWarpRouteId<T>(args: Argv<T>) {
+export function withKnownWarpRouteId<T>(args: Argv<T>) {
   return args
     .describe('warpRouteId', 'warp route id')
     .string('warpRouteId')
     .choices('warpRouteId', Object.values(WarpRouteIds));
 }
 
+export function withWarpRouteId<T>(args: Argv<T>) {
+  return args.describe('warpRouteId', 'warp route id').string('warpRouteId');
+}
+
 export function withDryRun<T>(args: Argv<T>) {
   return args
     .describe('dryRun', 'Dry run')
     .boolean('dryRun')
     .default('dryRun', false);
 }
 
-export function withWarpRouteIdRequired<T>(args: Argv<T>) {
-  return withWarpRouteId(args).demandOption('warpRouteId');
+export function withKnownWarpRouteIdRequired<T>(args: Argv<T>) {
+  return withKnownWarpRouteId(args).demandOption('warpRouteId');
 }
 
 export function withProtocol<T>(args: Argv<T>) {

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

@@ -14,6 +14,7 @@ async function main() {
     fork,
     govern,
     warpRouteId,
+    registry,
   } = await getCheckDeployArgs().argv;
 
   const governor = await getGovernor(
@@ -25,6 +26,8 @@ async function main() {
     chains,
     fork,
     govern,
+    undefined,
+    registry,
   );
 
   if (fork) {

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

@@ -23,7 +23,10 @@ import { eqAddress, objFilter } from '@hyperlane-xyz/utils';
 
 import { Contexts } from '../../config/contexts.js';
 import { DEPLOYER } from '../../config/environments/mainnet3/owners.js';
-import { getWarpAddresses } from '../../config/registry.js';
+import {
+  getWarpAddresses,
+  getWarpAddressesFromMergedRegistry,
+} from '../../config/registry.js';
 import { getWarpConfig } from '../../config/warp.js';
 import { chainsToSkip } from '../../src/config/chain.js';
 import { DeployEnvironment } from '../../src/config/environment.js';
@@ -45,11 +48,12 @@ import {
   withContext,
   withFork,
   withGovern,
+  withKnownWarpRouteId,
   withModule,
   withPushMetrics,
-  withWarpRouteId,
 } from '../agent-utils.js';
 import { getEnvironmentConfig, getHyperlaneCore } from '../core-utils.js';
+import { withRegistryUris } from '../github-utils.js';
 import { getHelloWorldApp } from '../helloworld/utils.js';
 
 export function getCheckBaseArgs() {
@@ -63,7 +67,7 @@ export function getCheckWarpDeployArgs() {
 }
 
 export function getCheckDeployArgs() {
-  return withWarpRouteId(withModule(getCheckBaseArgs()));
+  return withRegistryUris(withKnownWarpRouteId(withModule(getCheckBaseArgs())));
 }
 
 export async function getGovernor(
@@ -76,6 +80,7 @@ export async function getGovernor(
   fork?: string,
   govern?: boolean,
   multiProvider: MultiProvider | undefined = undefined,
+  registryUris?: string[],
 ) {
   const envConfig = getEnvironmentConfig(environment);
   // If the multiProvider is not passed in, get it from the environment
@@ -196,8 +201,15 @@ export async function getGovernor(
     if (!warpRouteId) {
       warpRouteId = await getWarpRouteIdInteractive();
     }
-    const config = await getWarpConfig(multiProvider, envConfig, warpRouteId);
-    const warpAddresses = getWarpAddresses(warpRouteId);
+    const config = await getWarpConfig(
+      multiProvider,
+      envConfig,
+      warpRouteId,
+      registryUris,
+    );
+    const warpAddresses = registryUris
+      ? await getWarpAddressesFromMergedRegistry(warpRouteId, registryUris)
+      : getWarpAddresses(warpRouteId);
     const filteredAddresses = Object.keys(warpAddresses) // filter out changes not in config
       .filter((key) => key in config)
       .reduce((obj, key) => {

typescript/infra/scripts/deploy.ts

@@ -49,8 +49,8 @@ import {
   withConcurrentDeploy,
   withContext,
   withFork,
+  withKnownWarpRouteId,
   withModule,
-  withWarpRouteId,
 } from './agent-utils.js';
 import { getEnvironmentConfig, getHyperlaneCore } from './core-utils.js';
 
@@ -67,7 +67,9 @@ async function main() {
   } = await withContext(
     withConcurrentDeploy(
       withChains(
-        withModule(withFork(withWarpRouteId(withBuildArtifactPath(getArgs())))),
+        withModule(
+          withFork(withKnownWarpRouteId(withBuildArtifactPath(getArgs()))),
+        ),
       ),
     ),
   ).argv;

typescript/infra/scripts/github-utils.ts

@@ -0,0 +1,8 @@
+import { Argv } from 'yargs';
+
+export function withRegistryUris<T>(args: Argv<T>) {
+  return args
+    .describe('registry', 'Github registry urls (comma separated)')
+    .string('registry')
+    .array('registry');
+}

typescript/infra/scripts/warp-routes/deploy-warp-monitor.ts

@@ -18,7 +18,7 @@ import {
   getAgentConfig,
   getArgs,
   getWarpRouteIdsInteractive,
-  withWarpRouteId,
+  withKnownWarpRouteId,
 } from '../agent-utils.js';
 import { getEnvironmentConfig } from '../core-utils.js';
 
@@ -42,7 +42,8 @@ async function validateRegistryCommit(commit: string) {
 
 async function main() {
   configureRootLogger(LogFormat.Pretty, LogLevel.Info);
-  const { environment, warpRouteId } = await withWarpRouteId(getArgs()).argv;
+  const { environment, warpRouteId } = await withKnownWarpRouteId(getArgs())
+    .argv;
   const envConfig = getEnvironmentConfig(environment);
   const multiProtocolProvider = await envConfig.getMultiProtocolProvider();
 

typescript/infra/scripts/warp-routes/generate-strategy-config.ts

@@ -9,13 +9,17 @@ import {
 
 import { strategyConfigGetterMap } from '../../config/warp.js';
 import { writeYamlAtPath } from '../../src/utils/utils.js';
-import { getArgs, withOutputFile, withWarpRouteId } from '../agent-utils.js';
+import {
+  getArgs,
+  withKnownWarpRouteId,
+  withOutputFile,
+} from '../agent-utils.js';
 
 // Writes the strategy config to disk
 async function main() {
   const logger = configureRootLogger(LogFormat.Pretty, LogLevel.Info);
   const { warpRouteId, outFile } = await withOutputFile(
-    withWarpRouteId(getArgs()),
+    withKnownWarpRouteId(getArgs()),
   ).argv;
   assert(warpRouteId, 'warpRouteId not provided');
 

typescript/infra/scripts/warp-routes/generate-warp-config.ts

@@ -7,14 +7,14 @@ import { getWarpConfig } from '../../config/warp.js';
 import { writeYamlAtPath } from '../../src/utils/utils.js';
 import {
   getArgs,
+  withKnownWarpRouteIdRequired,
   withOutputFile,
-  withWarpRouteIdRequired,
 } from '../agent-utils.js';
 import { getEnvironmentConfig, getHyperlaneCore } from '../core-utils.js';
 
 async function main() {
   const { warpRouteId, environment, outFile } = await withOutputFile(
-    withWarpRouteIdRequired(getArgs()),
+    withKnownWarpRouteIdRequired(getArgs()),
   ).argv;
 
   const { multiProvider } = await getHyperlaneCore(environment);