feat: add override registry URI option for backward compatibility

hyperlane-xyz · Feb 9, 2025 · 301a475 · 301a475
1 parent 24e66dc
commit 301a475
Show file tree

Hide file tree

Showing 6 changed files with 20 additions and 7 deletions.
diff --git a/typescript/cli/cli.ts b/typescript/cli/cli.ts
@@ -16,6 +16,7 @@ import {
   keyCommandOption,
   logFormatCommandOption,
   logLevelCommandOption,
+  overrideRegistryUriCommandOption,
   registryUrisCommandOption,
   skipConfirmationOption,
   strategyCommandOption,
@@ -43,6 +44,7 @@ try {
     .option('log', logFormatCommandOption)
     .option('verbosity', logLevelCommandOption)
     .option('registry', registryUrisCommandOption)
+    .option('overrides', overrideRegistryUriCommandOption)
     .option('key', keyCommandOption)
     .option('disableProxy', disableProxyCommandOption)
     .option('yes', skipConfirmationOption)

diff --git a/typescript/cli/src/commands/options.ts b/typescript/cli/src/commands/options.ts
@@ -36,6 +36,13 @@ export const registryUrisCommandOption: Options = {
   default: [DEFAULT_GITHUB_REGISTRY, DEFAULT_LOCAL_REGISTRY],
 };
 
+export const overrideRegistryUriCommandOption: Options = {
+  type: 'string',
+  description: 'Path to a local registry to override the default registry',
+  default: '',
+  hidden: true,
+};
+
 export const skipConfirmationOption: Options = {
   type: 'boolean',
   description: 'Skip confirmation prompts',

diff --git a/typescript/cli/src/context/context.ts b/typescript/cli/src/context/context.ts
@@ -37,7 +37,10 @@ export async function contextMiddleware(argv: Record<string, any>) {
   const isDryRun = !isNullish(argv.dryRun);
   const requiresKey = isSignCommand(argv);
   const settings: ContextSettings = {
-    registryUris: argv.registry,
+    registryUris: [
+      ...argv.registry,
+      ...(argv.overrides ? [argv.overrides] : []),
+    ],
     key: argv.key,
     fromAddress: argv.fromAddress,
     requiresKey,
@@ -185,7 +188,10 @@ export async function getDryRunContext(
  * and an override one (such as a local directory)
  * @returns a new MergedRegistry
  */
-function getRegistry(registryUris: string[], enableProxy: boolean): IRegistry {
+export function getRegistry(
+  registryUris: string[],
+  enableProxy: boolean,
+): IRegistry {
   const logger = rootLogger.child({ module: 'MergedRegistry' });
   const registries = registryUris
     .map((uri) => uri.trim())

diff --git a/typescript/infra/config/warp.ts b/typescript/infra/config/warp.ts
@@ -114,8 +114,7 @@ async function getConfigFromMergedRegistry(
   warpRouteId: string,
 ): Promise<ChainMap<HypTokenRouterConfig>> {
   const warpRoute = await getRegistry(
-    DEFAULT_REGISTRY_URI,
-    '',
+    [DEFAULT_REGISTRY_URI],
     true,
   ).getWarpDeployConfig(warpRouteId);
   assert(warpRoute, `Warp route Config not found for ${warpRouteId}`);

diff --git a/typescript/infra/test/warp-configs.test.ts b/typescript/infra/test/warp-configs.test.ts
@@ -27,8 +27,7 @@ describe('Warp Configs', async function () {
   before(async function () {
     multiProvider = (await getHyperlaneCore(ENV)).multiProvider;
     configsFromGithub = await getRegistry(
-      DEFAULT_GITHUB_REGISTRY,
-      '',
+      [DEFAULT_GITHUB_REGISTRY],
       true,
     ).getWarpDeployConfigs();
   });

diff --git a/typescript/infra/test/warpIds.test.ts b/typescript/infra/test/warpIds.test.ts
@@ -7,7 +7,7 @@ import { WarpRouteIds } from '../config/environments/mainnet3/warp/warpIds.js';
 
 describe('Warp IDs', () => {
   it('Has all warp IDs in the registry', () => {
-    const registry = getRegistry(DEFAULT_GITHUB_REGISTRY, '', true);
+    const registry = getRegistry([DEFAULT_GITHUB_REGISTRY], true);
     for (const warpId of Object.values(WarpRouteIds)) {
       // That's a long sentence!
       expect(