@hyperlane-xyz/registry 1.0.2 → 1.0.3

package/dist/core/chains.d.ts

@@ -0,0 +1,42 @@
+/**
+ * A list of chains managed by the Hyperlane core team.
+ * Hyperlane can be deployed permissionlessly to any chain but for
+ * convenience the core team maintains some deployments.
+ */
+export declare enum CoreChain {
+    alfajores = "alfajores",
+    ancient8 = "ancient8",
+    arbitrum = "arbitrum",
+    avalanche = "avalanche",
+    base = "base",
+    bsc = "bsc",
+    bsctestnet = "bsctestnet",
+    celo = "celo",
+    chiado = "chiado",
+    ethereum = "ethereum",
+    fuji = "fuji",
+    gnosis = "gnosis",
+    inevm = "inevm",
+    injective = "injective",
+    mantapacific = "mantapacific",
+    moonbeam = "moonbeam",
+    nautilus = "nautilus",
+    neutron = "neutron",
+    optimism = "optimism",
+    plumetestnet = "plumetestnet",
+    polygon = "polygon",
+    polygonzkevm = "polygonzkevm",
+    proteustestnet = "proteustestnet",
+    scroll = "scroll",
+    scrollsepolia = "scrollsepolia",
+    sepolia = "sepolia",
+    solana = "solana",
+    solanadevnet = "solanadevnet",
+    solanatestnet = "solanatestnet",
+    eclipsetestnet = "eclipsetestnet",
+    viction = "viction"
+}
+export type CoreChainName = keyof typeof CoreChain;
+export declare const CoreMainnets: Array<CoreChainName>;
+export declare const CoreTestnets: Array<CoreChainName>;
+export declare const CoreChains: Array<CoreChainName>;

package/dist/core/chains.js

@@ -0,0 +1,73 @@
+/**
+ * A list of chains managed by the Hyperlane core team.
+ * Hyperlane can be deployed permissionlessly to any chain but for
+ * convenience the core team maintains some deployments.
+ */
+export var CoreChain;
+(function (CoreChain) {
+    CoreChain["alfajores"] = "alfajores";
+    CoreChain["ancient8"] = "ancient8";
+    CoreChain["arbitrum"] = "arbitrum";
+    CoreChain["avalanche"] = "avalanche";
+    CoreChain["base"] = "base";
+    CoreChain["bsc"] = "bsc";
+    CoreChain["bsctestnet"] = "bsctestnet";
+    CoreChain["celo"] = "celo";
+    CoreChain["chiado"] = "chiado";
+    CoreChain["ethereum"] = "ethereum";
+    CoreChain["fuji"] = "fuji";
+    CoreChain["gnosis"] = "gnosis";
+    CoreChain["inevm"] = "inevm";
+    CoreChain["injective"] = "injective";
+    CoreChain["mantapacific"] = "mantapacific";
+    CoreChain["moonbeam"] = "moonbeam";
+    CoreChain["nautilus"] = "nautilus";
+    CoreChain["neutron"] = "neutron";
+    CoreChain["optimism"] = "optimism";
+    CoreChain["plumetestnet"] = "plumetestnet";
+    CoreChain["polygon"] = "polygon";
+    CoreChain["polygonzkevm"] = "polygonzkevm";
+    CoreChain["proteustestnet"] = "proteustestnet";
+    CoreChain["scroll"] = "scroll";
+    CoreChain["scrollsepolia"] = "scrollsepolia";
+    CoreChain["sepolia"] = "sepolia";
+    CoreChain["solana"] = "solana";
+    CoreChain["solanadevnet"] = "solanadevnet";
+    CoreChain["solanatestnet"] = "solanatestnet";
+    CoreChain["eclipsetestnet"] = "eclipsetestnet";
+    CoreChain["viction"] = "viction";
+})(CoreChain || (CoreChain = {}));
+export const CoreMainnets = [
+    CoreChain.arbitrum,
+    CoreChain.ancient8,
+    CoreChain.avalanche,
+    CoreChain.bsc,
+    CoreChain.celo,
+    CoreChain.ethereum,
+    CoreChain.neutron,
+    CoreChain.mantapacific,
+    CoreChain.moonbeam,
+    CoreChain.optimism,
+    CoreChain.polygon,
+    CoreChain.gnosis,
+    CoreChain.base,
+    CoreChain.scroll,
+    CoreChain.polygonzkevm,
+    CoreChain.injective,
+    CoreChain.inevm,
+    CoreChain.viction,
+    // CoreChains.solana,
+];
+export const CoreTestnets = [
+    CoreChain.alfajores,
+    CoreChain.bsctestnet,
+    CoreChain.chiado,
+    CoreChain.fuji,
+    CoreChain.plumetestnet,
+    CoreChain.scrollsepolia,
+    CoreChain.sepolia,
+    CoreChain.solanadevnet,
+    CoreChain.solanatestnet,
+    CoreChain.eclipsetestnet,
+];
+export const CoreChains = [...CoreMainnets, ...CoreTestnets];

package/dist/index.d.ts

@@ -1,45 +1,7 @@
-/**
- * A list of chains managed by the Hyperlane core team.
- * Hyperlane can be deployed permissionlessly to any chain but for
- * convenience the core team maintains some deployments.
- */
-export declare enum CoreChain {
-    alfajores = "alfajores",
-    ancient8 = "ancient8",
-    arbitrum = "arbitrum",
-    avalanche = "avalanche",
-    base = "base",
-    bsc = "bsc",
-    bsctestnet = "bsctestnet",
-    celo = "celo",
-    chiado = "chiado",
-    ethereum = "ethereum",
-    fuji = "fuji",
-    gnosis = "gnosis",
-    inevm = "inevm",
-    injective = "injective",
-    mantapacific = "mantapacific",
-    moonbeam = "moonbeam",
-    nautilus = "nautilus",
-    neutron = "neutron",
-    optimism = "optimism",
-    plumetestnet = "plumetestnet",
-    polygon = "polygon",
-    polygonzkevm = "polygonzkevm",
-    proteustestnet = "proteustestnet",
-    scroll = "scroll",
-    scrollsepolia = "scrollsepolia",
-    sepolia = "sepolia",
-    solana = "solana",
-    solanadevnet = "solanadevnet",
-    solanatestnet = "solanatestnet",
-    eclipsetestnet = "eclipsetestnet",
-    viction = "viction"
-}
-export type CoreChainName = keyof typeof CoreChain;
-export declare const CoreMainnets: Array<CoreChainName>;
-export declare const CoreTestnets: Array<CoreChainName>;
-export declare const CoreChains: Array<CoreChainName>;
+export { CoreChain, CoreChainName, CoreChains, CoreMainnets, CoreTestnets } from './core/chains.js';
+export { BaseRegistry } from './registry/BaseRegistry.js';
+export { GithubRegistry, GithubRegistryOptions } from './registry/GithubRegistry.js';
+export { ChainAddresses, ChainFiles, IRegistry, RegistryContent } from './registry/IRegistry.js';
 export { chainMetadata } from './chainMetadata.js';
 export { coreChainMetadata } from './coreChainMetadata.js';
 export { chainAddresses } from './chainAddresses.js';

package/dist/index.js

@@ -1,76 +1,6 @@
-/**
- * A list of chains managed by the Hyperlane core team.
- * Hyperlane can be deployed permissionlessly to any chain but for
- * convenience the core team maintains some deployments.
- */
-export var CoreChain;
-(function (CoreChain) {
-    CoreChain["alfajores"] = "alfajores";
-    CoreChain["ancient8"] = "ancient8";
-    CoreChain["arbitrum"] = "arbitrum";
-    CoreChain["avalanche"] = "avalanche";
-    CoreChain["base"] = "base";
-    CoreChain["bsc"] = "bsc";
-    CoreChain["bsctestnet"] = "bsctestnet";
-    CoreChain["celo"] = "celo";
-    CoreChain["chiado"] = "chiado";
-    CoreChain["ethereum"] = "ethereum";
-    CoreChain["fuji"] = "fuji";
-    CoreChain["gnosis"] = "gnosis";
-    CoreChain["inevm"] = "inevm";
-    CoreChain["injective"] = "injective";
-    CoreChain["mantapacific"] = "mantapacific";
-    CoreChain["moonbeam"] = "moonbeam";
-    CoreChain["nautilus"] = "nautilus";
-    CoreChain["neutron"] = "neutron";
-    CoreChain["optimism"] = "optimism";
-    CoreChain["plumetestnet"] = "plumetestnet";
-    CoreChain["polygon"] = "polygon";
-    CoreChain["polygonzkevm"] = "polygonzkevm";
-    CoreChain["proteustestnet"] = "proteustestnet";
-    CoreChain["scroll"] = "scroll";
-    CoreChain["scrollsepolia"] = "scrollsepolia";
-    CoreChain["sepolia"] = "sepolia";
-    CoreChain["solana"] = "solana";
-    CoreChain["solanadevnet"] = "solanadevnet";
-    CoreChain["solanatestnet"] = "solanatestnet";
-    CoreChain["eclipsetestnet"] = "eclipsetestnet";
-    CoreChain["viction"] = "viction";
-})(CoreChain || (CoreChain = {}));
-export const CoreMainnets = [
-    CoreChain.arbitrum,
-    CoreChain.ancient8,
-    CoreChain.avalanche,
-    CoreChain.bsc,
-    CoreChain.celo,
-    CoreChain.ethereum,
-    CoreChain.neutron,
-    CoreChain.mantapacific,
-    CoreChain.moonbeam,
-    CoreChain.optimism,
-    CoreChain.polygon,
-    CoreChain.gnosis,
-    CoreChain.base,
-    CoreChain.scroll,
-    CoreChain.polygonzkevm,
-    CoreChain.injective,
-    CoreChain.inevm,
-    CoreChain.viction,
-    // CoreChains.solana,
-];
-export const CoreTestnets = [
-    CoreChain.alfajores,
-    CoreChain.bsctestnet,
-    CoreChain.chiado,
-    CoreChain.fuji,
-    CoreChain.plumetestnet,
-    CoreChain.scrollsepolia,
-    CoreChain.sepolia,
-    CoreChain.solanadevnet,
-    CoreChain.solanatestnet,
-    CoreChain.eclipsetestnet,
-];
-export const CoreChains = [...CoreMainnets, ...CoreTestnets];
+export { CoreChain, CoreChains, CoreMainnets, CoreTestnets } from './core/chains.js';
+export { BaseRegistry } from './registry/BaseRegistry.js';
+export { GithubRegistry } from './registry/GithubRegistry.js';
 export { chainMetadata } from './chainMetadata.js';
 export { coreChainMetadata } from './coreChainMetadata.js';
 export { chainAddresses } from './chainAddresses.js';

package/dist/registry/BaseRegistry.d.ts

@@ -0,0 +1,20 @@
+import type { Logger } from 'pino';
+import type { ChainMap, ChainMetadata, ChainName } from '@hyperlane-xyz/sdk';
+import type { ChainAddresses, IRegistry, RegistryContent } from './IRegistry.js';
+export declare abstract class BaseRegistry implements IRegistry {
+    protected readonly logger: Logger;
+    protected listContentCache?: RegistryContent;
+    protected metadataCache?: ChainMap<ChainMetadata>;
+    protected addressCache?: ChainMap<ChainAddresses>;
+    constructor({ logger }: {
+        logger?: Logger;
+    });
+    protected getChainsPath(): string;
+    protected getWarpArtifactsPath(): string;
+    abstract listRegistryContent(): Promise<RegistryContent>;
+    abstract getChains(): Promise<Array<ChainName>>;
+    abstract getMetadata(): Promise<ChainMap<ChainMetadata>>;
+    abstract getChainMetadata(chainName: ChainName): Promise<ChainMetadata | null>;
+    abstract getAddresses(): Promise<ChainMap<ChainAddresses>>;
+    abstract getChainAddresses(chainName: ChainName): Promise<ChainAddresses | null>;
+}

package/dist/registry/BaseRegistry.js

@@ -0,0 +1,19 @@
+export class BaseRegistry {
+    logger;
+    // Caches
+    listContentCache;
+    metadataCache;
+    addressCache;
+    constructor({ logger }) {
+        // @ts-ignore forcing in to avoid a @hyperlane-xyz/utils
+        // dependency here, which could bloat consumer bundles
+        // unnecessarily (e.g. they just want metadata)
+        this.logger = logger || console;
+    }
+    getChainsPath() {
+        return 'chains';
+    }
+    getWarpArtifactsPath() {
+        return 'deployments/warp_routes';
+    }
+}

package/dist/registry/GithubRegistry.d.ts

@@ -0,0 +1,25 @@
+import type { Logger } from 'pino';
+import type { ChainMap, ChainMetadata, ChainName } from '@hyperlane-xyz/sdk';
+import { BaseRegistry } from './BaseRegistry.js';
+import type { ChainAddresses, IRegistry, RegistryContent } from './IRegistry.js';
+export interface GithubRegistryOptions {
+    url?: string;
+    branch?: string;
+    authToken?: string;
+    logger?: Logger;
+}
+export declare class GithubRegistry extends BaseRegistry implements IRegistry {
+    readonly url: URL;
+    readonly branch: string;
+    readonly repoOwner: string;
+    readonly repoName: string;
+    constructor(options?: GithubRegistryOptions);
+    listRegistryContent(): Promise<RegistryContent>;
+    getChains(): Promise<Array<ChainName>>;
+    getMetadata(): Promise<ChainMap<ChainMetadata>>;
+    getChainMetadata(chainName: ChainName): Promise<ChainMetadata>;
+    getAddresses(): Promise<ChainMap<ChainAddresses>>;
+    getChainAddresses(chainName: ChainName): Promise<ChainAddresses>;
+    protected getRawContentUrl(path: string): string;
+    protected fetch(url: string): Promise<Response>;
+}

package/dist/registry/GithubRegistry.js

@@ -0,0 +1,98 @@
+import { parse } from 'yaml';
+import { BaseRegistry } from './BaseRegistry.js';
+const DEFAULT_REGISTRY = 'https://github.com/hyperlane-xyz/hyperlane-registry';
+const CHAIN_FILE_REGEX = /chains\/([a-z]+)\/([a-z]+)\.yaml/;
+export class GithubRegistry extends BaseRegistry {
+    url;
+    branch;
+    repoOwner;
+    repoName;
+    constructor(options = {}) {
+        super({ logger: options.logger });
+        this.url = new URL(options.url ?? DEFAULT_REGISTRY);
+        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);
+    }
+    async listRegistryContent() {
+        if (this.listContentCache)
+            return this.listContentCache;
+        // This uses the tree API instead of the simpler directory list API because it
+        // allows us to get a full view of all files in one request.
+        const apiUrl = `https://api.github.com/repos/${this.repoOwner}/${this.repoName}/git/trees/${this.branch}?recursive=true`;
+        const response = await this.fetch(apiUrl);
+        const result = await response.json();
+        const tree = result.tree;
+        const chainPath = this.getChainsPath();
+        const chains = {};
+        for (const node of tree) {
+            if (CHAIN_FILE_REGEX.test(node.path)) {
+                const [_, chainName, fileName] = node.path.match(CHAIN_FILE_REGEX);
+                chains[chainName] ??= {};
+                // @ts-ignore allow dynamic key assignment
+                chains[chainName][fileName] = this.getRawContentUrl(`${chainPath}/${chainName}/${fileName}.yaml`);
+            }
+            // TODO add handling for deployment artifact files here too
+        }
+        return (this.listContentCache = { chains, deployments: {} });
+    }
+    async getChains() {
+        const repoContents = await this.listRegistryContent();
+        return Object.keys(repoContents.chains);
+    }
+    async getMetadata() {
+        if (this.metadataCache)
+            return this.metadataCache;
+        const chainMetadata = {};
+        const repoContents = await this.listRegistryContent();
+        for (const [chainName, chainFiles] of Object.entries(repoContents.chains)) {
+            if (!chainFiles.metadata)
+                continue;
+            const response = await this.fetch(chainFiles.metadata);
+            const metadata = parse(await response.text());
+            chainMetadata[chainName] = metadata;
+        }
+        return (this.metadataCache = chainMetadata);
+    }
+    async getChainMetadata(chainName) {
+        if (this.metadataCache?.[chainName])
+            return this.metadataCache[chainName];
+        const url = this.getRawContentUrl(`${this.getChainsPath()}/${chainName}/metadata.yaml`);
+        const response = await this.fetch(url);
+        return parse(await response.text());
+    }
+    async getAddresses() {
+        if (this.addressCache)
+            return this.addressCache;
+        const chainAddresses = {};
+        const repoContents = await this.listRegistryContent();
+        for (const [chainName, chainFiles] of Object.entries(repoContents.chains)) {
+            if (!chainFiles.addresses)
+                continue;
+            const response = await this.fetch(chainFiles.addresses);
+            const addresses = parse(await response.text());
+            chainAddresses[chainName] = addresses;
+        }
+        return (this.addressCache = chainAddresses);
+    }
+    async getChainAddresses(chainName) {
+        if (this.addressCache?.[chainName])
+            return this.addressCache[chainName];
+        const url = this.getRawContentUrl(`${this.getChainsPath()}/${chainName}/addresses.yaml`);
+        const response = await this.fetch(url);
+        return parse(await response.text());
+    }
+    getRawContentUrl(path) {
+        return `https://raw.githubusercontent.com/${this.repoOwner}/${this.repoName}/${this.branch}/${path}`;
+    }
+    async fetch(url) {
+        this.logger.debug(`Fetching from github: ${url}`);
+        const response = await fetch(url);
+        if (!response.ok)
+            throw new Error(`Failed to fetch from github: ${response.status} ${response.statusText}`);
+        return response;
+    }
+}

package/dist/registry/IRegistry.d.ts

@@ -0,0 +1,19 @@
+import type { Address } from '@hyperlane-xyz/utils';
+import type { ChainMap, ChainMetadata, ChainName } from '@hyperlane-xyz/sdk';
+export interface ChainFiles {
+    metadata?: string;
+    addresses?: string;
+}
+export interface RegistryContent {
+    chains: ChainMap<ChainFiles>;
+    deployments: {};
+}
+export type ChainAddresses = Record<string, Address>;
+export interface IRegistry {
+    listRegistryContent(): Promise<RegistryContent>;
+    getChains(): Promise<Array<ChainName>>;
+    getMetadata(): Promise<ChainMap<ChainMetadata>>;
+    getChainMetadata(chainName: ChainName): Promise<ChainMetadata | null>;
+    getAddresses(): Promise<ChainMap<ChainAddresses>>;
+    getChainAddresses(chainName: ChainName): Promise<ChainAddresses | null>;
+}

package/dist/registry/IRegistry.js

@@ -0,0 +1 @@
+export {};

package/package.json

@@ -1,7 +1,10 @@
 {
   "name": "@hyperlane-xyz/registry",
   "description": "A collection of configs, artifacts, and schemas for Hyperlane",
-  "version": "1.0.2",
+  "version": "1.0.3",
+  "dependencies": {
+    "yaml": "^2"
+  },
   "devDependencies": {
     "@changesets/cli": "^2.26.2",
     "@hyperlane-xyz/sdk": "3.10.0",
@@ -14,7 +17,6 @@
     "prettier": "^2.8.8",
     "tsx": "^4.7.1",
     "typescript": "5.3.3",
-    "yaml": "^2.3.1",
     "zod": "^3.21.2",
     "zod-to-json-schema": "^3.22.5"
   },