@hyperlane-xyz/registry 10.11.1 → 10.12.0

package/dist/registry/GithubRegistry.js

@@ -1,9 +1,9 @@
 import { parse as yamlParse } from 'yaml';
 import { CHAIN_FILE_REGEX, DEFAULT_GITHUB_REGISTRY, GITHUB_FETCH_CONCURRENCY_LIMIT, WARP_ROUTE_CONFIG_FILE_REGEX, WARP_ROUTE_DEPLOY_FILE_REGEX, } from '../consts.js';
-import { concurrentMap, stripLeadingSlash } from '../utils.js';
+import { concurrentMap, parseGitHubPath, stripLeadingSlash } from '../utils.js';
 import { BaseRegistry } from './BaseRegistry.js';
 import { RegistryType, } from './IRegistry.js';
-import { filterWarpRoutesIds, warpRouteConfigPathToId, warpRouteDeployConfigPathToId } from './warp-utils.js';
+import { filterWarpRoutesIds, warpRouteConfigPathToId, warpRouteDeployConfigPathToId, } from './warp-utils.js';
 export const GITHUB_API_URL = 'https://api.github.com';
 /**
  * A registry that uses a github repository as its data source.
@@ -20,12 +20,12 @@ export class GithubRegistry extends BaseRegistry {
     constructor(options = {}) {
         super({ uri: options.uri ?? DEFAULT_GITHUB_REGISTRY, logger: options.logger });
         this.url = new URL(this.uri);
-        this.branch = options.branch ?? 'main';
-        const pathSegments = this.url.pathname.split('/');
-        if (pathSegments.length < 2)
-            throw new Error('Invalid github url');
-        this.repoOwner = pathSegments.at(-2);
-        this.repoName = pathSegments.at(-1);
+        const { repoOwner, repoName, repoBranch } = parseGitHubPath(this.uri);
+        this.repoOwner = repoOwner;
+        this.repoName = repoName;
+        if (options.branch && repoBranch)
+            throw new Error('Branch is set in both options and url.');
+        this.branch = options.branch ?? repoBranch ?? 'main';
         this.proxyUrl = options.proxyUrl;
     }
     getUri(itemPath) {

package/dist/registry/registry-utils.d.ts

@@ -1,3 +1,20 @@
 import type { Logger } from 'pino';
 import { IRegistry } from './IRegistry.js';
-export declare function getRegistry(registryUris: string[], enableProxy: boolean, branch?: string, logger?: Logger): IRegistry;
+/**
+ * Retrieves a registry instance based on the provided registry URIs.
+ * The registry can be either a GitHub registry or a file system registry,
+ * and the returned instance is a `MergedRegistry` that combines all the
+ * specified registries.
+ *
+ * @param registryUris - An array of registry URIs to use for creating the registry.
+ * @param enableProxy - If enabled, forwards all requests to Hyperlane Registry, with higher read limits.
+ * @param branch - An optional branch name to use for the GitHub registry.
+ * @param logger - An optional logger instance to use for logging.
+ * @returns An `IRegistry` instance that combines the specified registries.
+ */
+export declare function getRegistry({ registryUris, enableProxy, branch, logger, }: {
+    registryUris: string[];
+    enableProxy: boolean;
+    branch?: string;
+    logger?: Logger;
+}): IRegistry;

package/dist/registry/registry-utils.js

@@ -1,6 +1,6 @@
 import { GithubRegistry } from './GithubRegistry.js';
 import { FileSystemRegistry } from './FileSystemRegistry.js';
-import { DEFAULT_GITHUB_REGISTRY, PROXY_DEPLOYED_URL } from '../consts.js';
+import { PROXY_DEPLOYED_URL } from '../consts.js';
 import { MergedRegistry } from './MergedRegistry.js';
 const isHttpsUrl = (value) => {
     try {
@@ -13,9 +13,6 @@ const isHttpsUrl = (value) => {
         return false;
     }
 };
-const isCanonicalRepoUrl = (url) => {
-    return url === DEFAULT_GITHUB_REGISTRY;
-};
 const isValidFilePath = (path) => {
     try {
         // Check for control characters (0-31) and DEL (127) without using regex
@@ -41,7 +38,19 @@ const isValidFilePath = (path) => {
         return false;
     }
 };
-export function getRegistry(registryUris, enableProxy, branch, logger) {
+/**
+ * Retrieves a registry instance based on the provided registry URIs.
+ * The registry can be either a GitHub registry or a file system registry,
+ * and the returned instance is a `MergedRegistry` that combines all the
+ * specified registries.
+ *
+ * @param registryUris - An array of registry URIs to use for creating the registry.
+ * @param enableProxy - If enabled, forwards all requests to Hyperlane Registry, with higher read limits.
+ * @param branch - An optional branch name to use for the GitHub registry.
+ * @param logger - An optional logger instance to use for logging.
+ * @returns An `IRegistry` instance that combines the specified registries.
+ */
+export function getRegistry({ registryUris, enableProxy, branch, logger, }) {
     const registryLogger = logger?.child({ module: 'MergedRegistry' });
     const registries = registryUris
         .map((uri) => uri.trim())
@@ -53,7 +62,7 @@ export function getRegistry(registryUris, enableProxy, branch, logger) {
                 uri,
                 branch,
                 logger: childLogger,
-                proxyUrl: enableProxy && isCanonicalRepoUrl(uri) ? PROXY_DEPLOYED_URL : undefined,
+                proxyUrl: enableProxy ? PROXY_DEPLOYED_URL : undefined,
             });
         }
         else {

package/dist/utils.d.ts

@@ -5,3 +5,8 @@ export declare function concurrentMap<A, B>(concurrency: number, xs: A[], mapFn:
 export declare function isObject(item: any): any;
 export declare function objMerge(a: Record<string, any>, b: Record<string, any>, max_depth?: number): any;
 export declare function isAbacusWorksChain(metadata: ChainMetadata): boolean;
+export declare function parseGitHubPath(uri: string): {
+    repoOwner: string;
+    repoName: string;
+    repoBranch: string | undefined;
+};

package/dist/utils.js

@@ -1,7 +1,11 @@
 import { stringify } from 'yaml';
 import { ABACUS_WORKS_DEPLOYER_NAME } from './consts.js';
 export function toYamlString(data, prefix) {
-    const yamlString = stringify(data, { indent: 2, sortMapEntries: true, aliasDuplicateObjects: false });
+    const yamlString = stringify(data, {
+        indent: 2,
+        sortMapEntries: true,
+        aliasDuplicateObjects: false,
+    });
     return prefix ? `${prefix}\n${yamlString}` : yamlString;
 }
 export function stripLeadingSlash(path) {
@@ -51,3 +55,14 @@ export function objMerge(a, b, max_depth = 10) {
 export function isAbacusWorksChain(metadata) {
     return metadata.deployer?.name?.toLowerCase() === ABACUS_WORKS_DEPLOYER_NAME.toLowerCase();
 }
+export function parseGitHubPath(uri) {
+    const { pathname } = new URL(uri);
+    // Intended pattern: /{user}/{repo}/tree/{branch}
+    const regex = /\/([^/]+)\/([^/]+)(?:\/tree\/(.*))?/;
+    const match = pathname.match(regex);
+    if (!match) {
+        throw new Error('Invalid github url');
+    }
+    const [, repoOwner, repoName, repoBranch] = match;
+    return { repoOwner, repoName, repoBranch };
+}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@hyperlane-xyz/registry",
   "description": "A collection of configs, artifacts, and schemas for Hyperlane",
-  "version": "10.11.1",
+  "version": "10.12.0",
   "dependencies": {
     "yaml": "2.4.5",
     "zod": "^3.21.2"
@@ -9,6 +9,7 @@
   "devDependencies": {
     "@changesets/cli": "^2.26.2",
     "@eslint/js": "^9.1.1",
+    "@faker-js/faker": "^9.6.0",
     "@hyperlane-xyz/sdk": "8.8.1",
     "@types/mocha": "^10.0.1",
     "@types/node": "^16.9.1",