feat: authenticated Github registry

.changeset/calm-hounds-hammer.md

@@ -0,0 +1,5 @@
+---
+'@hyperlane-xyz/cli': patch
+---
+
+feat: support github auth token for authenticated registries

typescript/cli/cli.ts

@@ -13,6 +13,7 @@ import { hookCommand } from './src/commands/hook.js';
 import { ismCommand } from './src/commands/ism.js';
 import {
   disableProxyCommandOption,
+  githubAuthTokenOption,
   keyCommandOption,
   logFormatCommandOption,
   logLevelCommandOption,
@@ -44,6 +45,7 @@ try {
     .option('log', logFormatCommandOption)
     .option('verbosity', logLevelCommandOption)
     .option('registry', registryUriCommandOption)
+    .option('authToken', githubAuthTokenOption)
     .option('overrides', overrideRegistryUriCommandOption)
     .option('key', keyCommandOption)
     .option('disableProxy', disableProxyCommandOption)

typescript/cli/src/commands/options.ts

@@ -32,6 +32,13 @@ export const registryUriCommandOption: Options = {
   default: DEFAULT_GITHUB_REGISTRY,
 };
 
+export const githubAuthTokenOption: Options = {
+  type: 'string',
+  description: 'Github auth token for accessing registry repository',
+  default: ENV.GH_AUTH_TOKEN,
+  defaultDescription: 'process.env.GH_AUTH_TOKEN',
+};
+
 export const overrideRegistryUriCommandOption: Options = {
   type: 'string',
   description: 'Path to a local registry to override the default registry',

typescript/cli/src/context/context.ts

@@ -45,6 +45,7 @@ export async function contextMiddleware(argv: Record<string, any>) {
     disableProxy: argv.disableProxy,
     skipConfirmation: argv.yes,
     strategyPath: argv.strategy,
+    authToken: argv.authToken,
   };
   if (!isDryRun && settings.fromAddress)
     throw new Error(
@@ -106,8 +107,14 @@ export async function getContext({
   skipConfirmation,
   disableProxy = false,
   strategyPath,
+  authToken,
 }: ContextSettings): Promise<CommandContext> {
-  const registry = getRegistry(registryUri, registryOverrideUri, !disableProxy);
+  const registry = getRegistry(
+    registryUri,
+    registryOverrideUri,
+    !disableProxy,
+    authToken,
+  );
 
   //Just for backward compatibility
   let signerAddress: string | undefined = undefined;
@@ -143,10 +150,16 @@ export async function getDryRunContext(
     fromAddress,
     skipConfirmation,
     disableProxy = false,
+    authToken,
   }: ContextSettings,
   chain?: ChainName,
 ): Promise<CommandContext> {
-  const registry = getRegistry(registryUri, registryOverrideUri, !disableProxy);
+  const registry = getRegistry(
+    registryUri,
+    registryOverrideUri,
+    !disableProxy,
+    authToken,
+  );
   const chainMetadata = await registry.getMetadata();
 
   if (!chain) {
@@ -192,6 +205,7 @@ function getRegistry(
   primaryRegistryUri: string,
   overrideRegistryUri: string,
   enableProxy: boolean,
+  authToken?: string,
 ): IRegistry {
   const logger = rootLogger.child({ module: 'MergedRegistry' });
   const registries = [primaryRegistryUri, overrideRegistryUri]
@@ -203,6 +217,7 @@ function getRegistry(
         return new GithubRegistry({
           uri,
           logger: childLogger,
+          authToken,
           proxyUrl:
             enableProxy && isCanonicalRepoUrl(uri)
               ? PROXY_DEPLOYED_URL

typescript/cli/src/context/types.ts

@@ -18,6 +18,7 @@ export interface ContextSettings {
   disableProxy?: boolean;
   skipConfirmation?: boolean;
   strategyPath?: string;
+  authToken?: string;
 }
 
 export interface CommandContext {

typescript/cli/src/utils/env.ts

@@ -7,6 +7,7 @@ const envScheme = z.object({
   AWS_ACCESS_KEY_ID: z.string().optional(),
   AWS_SECRET_ACCESS_KEY: z.string().optional(),
   AWS_REGION: z.string().optional(),
+  GH_AUTH_TOKEN: z.string().optional(),
 });
 
 const parsedEnv = envScheme.safeParse(process.env);