Feat/get registry from uris

.changeset/red-dancers-pump.md

@@ -0,0 +1,5 @@
+---
+'@hyperlane-xyz/registry': minor
+---
+
+Add getRegistry and getMergedRegistry functions

src/consts.ts

@@ -9,3 +9,4 @@ export const WARP_ROUTE_CONFIG_FILE_REGEX = /warp_routes\/([a-zA-Z0-9]+)\/([a-z0
 export const WARP_ROUTE_DEPLOY_FILE_REGEX = /warp_routes\/([a-zA-Z0-9]+)\/([a-z0-9-]+)-deploy.yaml/;
 
 export const ABACUS_WORKS_DEPLOYER_NAME = 'Abacus Works';
+export const PROXY_DEPLOYED_URL = 'https://proxy.hyperlane.xyz';

src/index.ts

@@ -23,3 +23,4 @@ export {
 } from './registry/warp-utils.js';
 export { ChainAddresses, ChainAddressesSchema } from './types.js';
 export { isAbacusWorksChain } from './utils.js';
+export { getRegistry } from './registry/registry-utils.js';

src/registry/registry-utils.ts

@@ -0,0 +1,50 @@
+import type { Logger } from 'pino';
+import { GithubRegistry } from './GithubRegistry.js';
+import { FileSystemRegistry } from './FileSystemRegistry.js';
+import { IRegistry } from './IRegistry.js';
+import { DEFAULT_GITHUB_REGISTRY, PROXY_DEPLOYED_URL } from '../consts.js';
+import { MergedRegistry } from './MergedRegistry.js';
+
+const isHttpsUrl = (value: string): boolean => {
+  try {
+    if (!value) return false;
+    const url = new URL(value);
+    return url.protocol === 'https:';
+  } catch {
+    return false;
+  }
+};
+
+const isCanonicalRepoUrl = (url: string): boolean => {
+  return url === DEFAULT_GITHUB_REGISTRY;
+};
+
+export function getRegistry(
+  registryUris: string[],
+  enableProxy: boolean,
+  logger?: Logger,
+): IRegistry {
+  const registryLogger = logger?.child({ module: 'MergedRegistry' });
+  const registries = registryUris
+    .map((uri) => uri.trim())
+    .filter((uri) => !!uri)
+    .map((uri, index) => {
+      const childLogger = registryLogger?.child({ uri, index });
+      if (isHttpsUrl(uri)) {
+        return new GithubRegistry({
+          uri,
+          logger: childLogger,
+          proxyUrl: enableProxy && isCanonicalRepoUrl(uri) ? PROXY_DEPLOYED_URL : undefined,
+        });
+      } else {
+        return new FileSystemRegistry({
+          uri,
+          logger: childLogger,
+        });
+      }
+    });
+  return new MergedRegistry({
+    registries,
+    logger,
+  });
+}

test/unit/registry.test.ts

@@ -3,6 +3,7 @@ import { expect } from 'chai';
 import sinon from 'sinon';
 
 import type { ChainMetadata } from '@hyperlane-xyz/sdk';
+import type { Logger } from 'pino';
 import fs from 'fs';
 import { CHAIN_FILE_REGEX } from '../../src/consts.js';
 import { FileSystemRegistry } from '../../src/registry/FileSystemRegistry.js';
@@ -11,6 +12,8 @@ import { RegistryType } from '../../src/registry/IRegistry.js';
 import { MergedRegistry } from '../../src/registry/MergedRegistry.js';
 import { PartialRegistry } from '../../src/registry/PartialRegistry.js';
 import { ChainAddresses } from '../../src/types.js';
+import { getRegistry } from '../../src/registry/registry-utils.js';
+import { DEFAULT_GITHUB_REGISTRY, PROXY_DEPLOYED_URL } from '../../src/consts.js';
 
 const GITHUB_REGISTRY_BRANCH = 'main';
 
@@ -262,3 +265,99 @@ describe('Warp routes file structure', () => {
     expect(foundPath, foundPath ? `Found addresses.yaml at: ${foundPath}` : '').to.be.null;
   });
 });
+
+describe('Registry Utils', () => {
+  // Mock logger
+  const logger: Logger = {
+    child: () => ({ info: () => {}, child: () => ({ info: () => {} }) }),
+  } as any;
+
+  const localPath = './';
+  const githubUrl = 'https://github.com/hyperlane-xyz/hyperlane-registry';
+
+  describe('getRegistry', () => {
+    it('creates MergedRegistry with FileSystemRegistry for local path', () => {
+      const registry = getRegistry([localPath], false, logger) as MergedRegistry;
+      expect(registry).to.be.instanceOf(MergedRegistry);
+      expect(registry.registries.length).to.equal(1);
+      expect(registry.registries[0]).to.be.instanceOf(FileSystemRegistry);
+      expect(registry.registries[0].uri).to.equal(localPath);
+    });
+
+    it('creates MergedRegistry with GithubRegistry for HTTPS URLs', () => {
+      const registry = getRegistry([githubUrl], false, logger) as MergedRegistry;
+      expect(registry).to.be.instanceOf(MergedRegistry);
+      expect(registry.registries.length).to.equal(1);
+      expect(registry.registries[0]).to.be.instanceOf(GithubRegistry);
+      expect(registry.registries[0].uri).to.equal(githubUrl);
+    });
+
+    it('creates MergedRegistry with proxied GithubRegistry for canonical repo', () => {
+      const registry = getRegistry([DEFAULT_GITHUB_REGISTRY], true, logger) as MergedRegistry;
+      expect(registry).to.be.instanceOf(MergedRegistry);
+      expect(registry.registries.length).to.equal(1);
+      expect(registry.registries[0]).to.be.instanceOf(GithubRegistry);
+      expect(registry.registries[0].uri).to.equal(DEFAULT_GITHUB_REGISTRY);
+      expect((registry.registries[0] as GithubRegistry).proxyUrl).to.equal(PROXY_DEPLOYED_URL);
+    });
+
+    it('creates MergedRegistry with non-proxied GithubRegistry for non-canonical repos', () => {
+      const registry = getRegistry(['https://github.com/test'], true, logger) as MergedRegistry;
+      expect(registry).to.be.instanceOf(MergedRegistry);
+      expect(registry.registries.length).to.equal(1);
+      expect(registry.registries[0]).to.be.instanceOf(GithubRegistry);
+      expect(registry.registries[0].uri).to.equal('https://github.com/test');
+      expect((registry.registries[0] as GithubRegistry).proxyUrl).to.be.undefined;
+    });
+
+    it('throws error for empty URIs array', () => {
+      expect(() => getRegistry([], true, logger)).to.throw('At least one registry URI is required');
+      expect(() => getRegistry([''], true, logger)).to.throw(
+        'At least one registry URI is required',
+      );
+      expect(() => getRegistry(['   '], true, logger)).to.throw(
+        'At least one registry URI is required',
+      );
+    });
+
+    it('creates MergedRegistry with FileSystemRegistry for non-HTTPS URLs', () => {
+      const nonHttpsUrl = 'http://example.com';
+      const registry = getRegistry([nonHttpsUrl], false, logger) as MergedRegistry;
+      expect(registry).to.be.instanceOf(MergedRegistry);
+      expect(registry.registries.length).to.equal(1);
+      expect(registry.registries[0]).to.be.instanceOf(FileSystemRegistry);
+      expect(registry.registries[0].uri).to.equal(nonHttpsUrl);
+    });
+
+    it('creates MergedRegistry with multiple URIs', () => {
+      const uris = [githubUrl, localPath];
+      const registry = getRegistry(uris, false, logger) as MergedRegistry;
+      expect(registry).to.be.instanceOf(MergedRegistry);
+      expect(registry.registries.length).to.equal(2);
+      expect(registry.registries[0]).to.be.instanceOf(GithubRegistry);
+      expect(registry.registries[1]).to.be.instanceOf(FileSystemRegistry);
+    });
+
+    it('creates MergedRegistry with mixed registry types and proxy settings', () => {
+      const uris = [DEFAULT_GITHUB_REGISTRY, localPath, 'https://github.com/test'];
+      const registry = getRegistry(uris, true, logger) as MergedRegistry;
+      expect(registry).to.be.instanceOf(MergedRegistry);
+      expect(registry.registries.length).to.equal(3);
+      expect(registry.registries[0]).to.be.instanceOf(GithubRegistry);
+      expect((registry.registries[0] as GithubRegistry).proxyUrl).to.equal(PROXY_DEPLOYED_URL);
+      expect(registry.registries[1]).to.be.instanceOf(FileSystemRegistry);
+      expect(registry.registries[2]).to.be.instanceOf(GithubRegistry);
+      expect((registry.registries[2] as GithubRegistry).proxyUrl).to.be.undefined;
+    });
+
+    it('properly initializes all registries with logger', () => {
+      const uris = [githubUrl, localPath];
+      const registry = getRegistry(uris, false, logger) as MergedRegistry;
+      expect(registry).to.be.instanceOf(MergedRegistry);
+      expect(registry.registries.length).to.equal(2);
+      expect(registry).to.have.property('logger');
+      expect(registry.registries[0]).to.have.property('logger');
+      expect(registry.registries[1]).to.have.property('logger');
+    });
+  });
+});