@hyperlane-xyz/registry 1.1.1 → 1.1.2

package/dist/registry/BaseRegistry.d.ts

@@ -9,7 +9,9 @@ export declare abstract class BaseRegistry implements IRegistry {
     protected readonly logger: Logger;
     protected listContentCache?: RegistryContent;
     protected metadataCache?: ChainMap<ChainMetadata>;
+    protected isMetadataCacheFull: boolean;
     protected addressCache?: ChainMap<ChainAddresses>;
+    protected isAddressCacheFull: boolean;
     constructor({ uri, logger }: {
         uri: string;
         logger?: Logger;
@@ -25,6 +27,7 @@ export declare abstract class BaseRegistry implements IRegistry {
     abstract getChainMetadata(chainName: ChainName): MaybePromise<ChainMetadata | null>;
     abstract getAddresses(): MaybePromise<ChainMap<ChainAddresses>>;
     abstract getChainAddresses(chainName: ChainName): MaybePromise<ChainAddresses | null>;
+    getChainLogoUri(chainName: ChainName): Promise<string | null>;
     abstract addChain(chain: {
         chainName: ChainName;
         metadata?: ChainMetadata;

package/dist/registry/BaseRegistry.js

@@ -1,11 +1,13 @@
-export const CHAIN_FILE_REGEX = /chains\/([a-z0-9]+)\/([a-z]+)\.yaml/;
+export const CHAIN_FILE_REGEX = /chains\/([a-z0-9]+)\/([a-z]+)\.(yaml|svg)/;
 export class BaseRegistry {
     uri;
     logger;
     // Caches
     listContentCache;
     metadataCache;
+    isMetadataCacheFull = false;
     addressCache;
+    isAddressCacheFull = false;
     constructor({ uri, logger }) {
         this.uri = uri;
         // @ts-ignore forcing in to avoid a @hyperlane-xyz/utils
@@ -30,4 +32,9 @@ export class BaseRegistry {
         const basePath = `deployments/warp_routes/${symbol}/${chains}`;
         return { configPath: `${basePath}-config.yaml`, addressesPath: `${basePath}-addresses.yaml` };
     }
+    async getChainLogoUri(chainName) {
+        const registryContent = await this.listRegistryContent();
+        const chain = registryContent.chains[chainName];
+        return chain?.logo ?? null;
+    }
 }

package/dist/registry/GithubRegistry.d.ts

@@ -19,9 +19,9 @@ export declare class GithubRegistry extends BaseRegistry implements IRegistry {
     listRegistryContent(): Promise<RegistryContent>;
     getChains(): Promise<Array<ChainName>>;
     getMetadata(): Promise<ChainMap<ChainMetadata>>;
-    getChainMetadata(chainName: ChainName): Promise<ChainMetadata>;
+    getChainMetadata(chainName: ChainName): Promise<ChainMetadata | null>;
     getAddresses(): Promise<ChainMap<ChainAddresses>>;
-    getChainAddresses(chainName: ChainName): Promise<ChainAddresses>;
+    getChainAddresses(chainName: ChainName): Promise<ChainAddresses | null>;
     addChain(_chains: {
         chainName: ChainName;
         metadata?: ChainMetadata;
@@ -35,6 +35,7 @@ export declare class GithubRegistry extends BaseRegistry implements IRegistry {
     removeChain(_chains: ChainName): Promise<void>;
     addWarpRoute(_config: WarpCoreConfig): Promise<void>;
     protected getRawContentUrl(path: string): string;
-    protected fetchChainFiles<T>(fileName: keyof ChainFiles): Promise<ChainMap<T>>;
+    protected fetchChainFiles<T>(fileName: keyof ChainFiles, chainNames?: ChainName[]): Promise<ChainMap<T>>;
+    protected fetchSingleChainFile<T>(fileName: keyof ChainFiles, chainName: ChainName): Promise<T | null>;
     protected fetch(url: string): Promise<Response>;
 }

package/dist/registry/GithubRegistry.js

@@ -1,6 +1,5 @@
 import { parse as yamlParse } from 'yaml';
 import { DEFAULT_GITHUB_REGISTRY, GITHUB_FETCH_CONCURRENCY_LIMIT } from '../consts.js';
-import { ChainAddressesSchema } from '../types.js';
 import { concurrentMap } from '../utils.js';
 import { BaseRegistry, CHAIN_FILE_REGEX } from './BaseRegistry.js';
 import { RegistryType, } from './IRegistry.js';
@@ -33,10 +32,10 @@ export class GithubRegistry extends BaseRegistry {
         const chains = {};
         for (const node of tree) {
             if (CHAIN_FILE_REGEX.test(node.path)) {
-                const [_, chainName, fileName] = node.path.match(CHAIN_FILE_REGEX);
+                const [_, chainName, fileName, extension] = node.path.match(CHAIN_FILE_REGEX);
                 chains[chainName] ??= {};
                 // @ts-ignore allow dynamic key assignment
-                chains[chainName][fileName] = this.getRawContentUrl(`${chainPath}/${chainName}/${fileName}.yaml`);
+                chains[chainName][fileName] = this.getRawContentUrl(`${chainPath}/${chainName}/${fileName}.${extension}`);
             }
             // TODO add handling for deployment artifact files here too
         }
@@ -47,32 +46,36 @@ export class GithubRegistry extends BaseRegistry {
         return Object.keys(repoContents.chains);
     }
     async getMetadata() {
-        if (this.metadataCache)
+        if (this.metadataCache && this.isMetadataCacheFull)
             return this.metadataCache;
         const chainMetadata = await this.fetchChainFiles('metadata');
+        this.isMetadataCacheFull = true;
         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);
-        const data = await response.text();
-        return yamlParse(data);
+        const data = await this.fetchSingleChainFile('metadata', chainName);
+        if (!data)
+            return null;
+        this.metadataCache = { ...this.metadataCache, [chainName]: data };
+        return data;
     }
     async getAddresses() {
-        if (this.addressCache)
+        if (this.addressCache && this.isAddressCacheFull)
             return this.addressCache;
         const chainAddresses = await this.fetchChainFiles('addresses');
+        this.isAddressCacheFull = true;
         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);
-        const data = await response.text();
-        return ChainAddressesSchema.parse(yamlParse(data));
+        const data = await this.fetchSingleChainFile('addresses', chainName);
+        if (!data)
+            return null;
+        this.addressCache = { ...this.addressCache, [chainName]: data };
+        return data;
     }
     async addChain(_chains) {
         throw new Error('TODO: Implement');
@@ -89,9 +92,11 @@ export class GithubRegistry extends BaseRegistry {
     getRawContentUrl(path) {
         return `https://raw.githubusercontent.com/${this.repoOwner}/${this.repoName}/${this.branch}/${path}`;
     }
-    async fetchChainFiles(fileName) {
+    // Fetches all files of a particular type in parallel
+    // Defaults to all known chains if chainNames is not provided
+    async fetchChainFiles(fileName, chainNames) {
         const repoContents = await this.listRegistryContent();
-        const chainNames = Object.keys(repoContents.chains);
+        chainNames ||= Object.keys(repoContents.chains);
         const fileUrls = chainNames.reduce((acc, chainName) => {
             const fileUrl = repoContents.chains[chainName][fileName];
             if (fileUrl)
@@ -105,6 +110,10 @@ export class GithubRegistry extends BaseRegistry {
         });
         return Object.fromEntries(results);
     }
+    async fetchSingleChainFile(fileName, chainName) {
+        const results = await this.fetchChainFiles(fileName, [chainName]);
+        return results[chainName] ?? null;
+    }
     async fetch(url) {
         this.logger.debug(`Fetching from github: ${url}`);
         const response = await fetch(url);

package/dist/registry/IRegistry.d.ts

@@ -3,6 +3,7 @@ import type { ChainAddresses, MaybePromise } from '../types.js';
 export interface ChainFiles {
     metadata?: string;
     addresses?: string;
+    logo?: string;
 }
 export interface RegistryContent {
     chains: ChainMap<ChainFiles>;
@@ -21,6 +22,7 @@ export interface IRegistry {
     getChainMetadata(chainName: ChainName): MaybePromise<ChainMetadata | null>;
     getAddresses(): MaybePromise<ChainMap<ChainAddresses>>;
     getChainAddresses(chainName: ChainName): MaybePromise<ChainAddresses | null>;
+    getChainLogoUri(chainName: ChainName): Promise<string | null>;
     addChain(chain: {
         chainName: ChainName;
         metadata?: ChainMetadata;

package/dist/registry/LocalRegistry.d.ts

@@ -13,9 +13,9 @@ export declare class LocalRegistry extends BaseRegistry implements IRegistry {
     listRegistryContent(): RegistryContent;
     getChains(): Array<ChainName>;
     getMetadata(): ChainMap<ChainMetadata>;
-    getChainMetadata(chainName: ChainName): ChainMetadata;
+    getChainMetadata(chainName: ChainName): ChainMetadata | null;
     getAddresses(): ChainMap<ChainAddresses>;
-    getChainAddresses(chainName: ChainName): ChainAddresses;
+    getChainAddresses(chainName: ChainName): ChainAddresses | null;
     addChain(chain: {
         chainName: ChainName;
         metadata?: ChainMetadata;

package/dist/registry/LocalRegistry.js

@@ -47,9 +47,7 @@ export class LocalRegistry extends BaseRegistry {
     }
     getChainMetadata(chainName) {
         const metadata = this.getMetadata();
-        if (!metadata[chainName])
-            throw new Error(`Metadata not found in registry for chain: ${chainName}`);
-        return metadata[chainName];
+        return metadata[chainName] ?? null;
     }
     getAddresses() {
         if (this.addressCache)
@@ -66,9 +64,7 @@ export class LocalRegistry extends BaseRegistry {
     }
     getChainAddresses(chainName) {
         const addresses = this.getAddresses();
-        if (!addresses[chainName])
-            throw new Error(`Addresses not found in registry for chain: ${chainName}`);
-        return addresses[chainName];
+        return addresses[chainName] ?? null;
     }
     addChain(chain) {
         const currentChains = this.listRegistryContent().chains;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@hyperlane-xyz/registry",
   "description": "A collection of configs, artifacts, and schemas for Hyperlane",
-  "version": "1.1.1",
+  "version": "1.1.2",
   "dependencies": {
     "yaml": "^2",
     "zod": "^3.21.2"