@hyperlane-xyz/registry 1.0.3 → 1.0.5

package/dist/chains/solanadevnet/metadata.json

@@ -1,10 +1,10 @@
 {
   "blockExplorers": [
     {
-      "apiUrl": "https://explorer.solana.com",
+      "apiUrl": "https://explorer.solana.com?cluster=devnet",
       "family": "other",
       "name": "Solana Explorer",
-      "url": "https://explorer.solana.com"
+      "url": "https://explorer.solana.com?cluster=devnet"
     }
   ],
   "blocks": {

package/dist/chains/solanadevnet/metadata.yaml

@@ -1,9 +1,9 @@
-# yaml-language-server: $schema=../schema
+# yaml-language-server: $schema=../schema.json
 blockExplorers:
-  - apiUrl: https://explorer.solana.com
+  - apiUrl: https://explorer.solana.com?cluster=devnet
     family: other
     name: Solana Explorer
-    url: https://explorer.solana.com
+    url: https://explorer.solana.com?cluster=devnet
 blocks:
   confirmations: 1
   estimateBlockTime: 0.4

package/dist/chains/solanatestnet/metadata.js

@@ -1,10 +1,10 @@
 export const metadata = {
     "blockExplorers": [
         {
-            "apiUrl": "https://explorer.solana.com",
+            "apiUrl": "https://explorer.solana.com?cluster=testnet",
             "family": "other",
             "name": "Solana Explorer",
-            "url": "https://explorer.solana.com"
+            "url": "https://explorer.solana.com?cluster=testnet"
         }
     ],
     "blocks": {

package/dist/chains/solanatestnet/metadata.json

@@ -1,10 +1,10 @@
 {
   "blockExplorers": [
     {
-      "apiUrl": "https://explorer.solana.com",
+      "apiUrl": "https://explorer.solana.com?cluster=testnet",
       "family": "other",
       "name": "Solana Explorer",
-      "url": "https://explorer.solana.com"
+      "url": "https://explorer.solana.com?cluster=testnet"
     }
   ],
   "blocks": {

package/dist/chains/solanatestnet/metadata.yaml

@@ -1,9 +1,9 @@
-# yaml-language-server: $schema=../schema
+# yaml-language-server: $schema=../schema.json
 blockExplorers:
-  - apiUrl: https://explorer.solana.com
+  - apiUrl: https://explorer.solana.com?cluster=testnet
     family: other
     name: Solana Explorer
-    url: https://explorer.solana.com
+    url: https://explorer.solana.com?cluster=testnet
 blocks:
   confirmations: 1
   estimateBlockTime: 0.4

package/dist/chains/viction/metadata.yaml

@@ -1,4 +1,4 @@
-# yaml-language-server: $schema=../schema
+# yaml-language-server: $schema=../schema.json
 blockExplorers:
   - apiUrl: https://www.vicscan.xyz/api
     family: other

package/dist/consts.d.ts

@@ -0,0 +1 @@
+export declare const CHAIN_SCHEMA_REF = "# yaml-language-server: $schema=../schema.json";

package/dist/consts.js

@@ -0,0 +1 @@
+export const CHAIN_SCHEMA_REF = '# yaml-language-server: $schema=../schema.json';

package/dist/coreChainAddresses.d.ts

@@ -22,6 +22,24 @@ export declare const coreChainAddresses: {
         timelockController: string;
         validatorAnnounce: string;
     };
+    ancient8: {
+        staticAggregationHookFactory: string;
+        staticAggregationIsmFactory: string;
+        fallbackRoutingHook: string;
+        interchainGasPaymaster: string;
+        interchainSecurityModule: string;
+        mailbox: string;
+        staticMerkleRootMultisigIsmFactory: string;
+        merkleTreeHook: string;
+        staticMessageIdMultisigIsmFactory: string;
+        pausableHook: string;
+        protocolFee: string;
+        proxyAdmin: string;
+        domainRoutingIsmFactory: string;
+        storageGasOracle: string;
+        testRecipient: string;
+        validatorAnnounce: string;
+    };
     avalanche: {
         aggregationHook: string;
         domainRoutingIsmFactory: string;

package/dist/coreChainAddresses.js

@@ -22,6 +22,24 @@ export const coreChainAddresses = {
         "timelockController": "0x0000000000000000000000000000000000000000",
         "validatorAnnounce": "0x1df063280C4166AF9a725e3828b4dAC6c7113B08"
     },
+    "ancient8": {
+        "staticAggregationHookFactory": "0xEb9FcFDC9EfDC17c1EC5E1dc085B98485da213D6",
+        "staticAggregationIsmFactory": "0x8F7454AC98228f3504Bb91eA3D8Adafe6406110A",
+        "fallbackRoutingHook": "0x5E01d8F34b629E3f92d69546bbc4142A7Adee7e9",
+        "interchainGasPaymaster": "0x8F1E22d309baa69D398a03cc88E9b46037e988AA",
+        "interchainSecurityModule": "0x6E3387e12C6e181BF8e712eCa9c60ccEEaBD1c67",
+        "mailbox": "0x2f2aFaE1139Ce54feFC03593FeE8AB2aDF4a85A7",
+        "staticMerkleRootMultisigIsmFactory": "0x2C1FAbEcd7bFBdEBF27CcdB67baADB38b6Df90fC",
+        "merkleTreeHook": "0x811808Dd29ba8B0FC6C0ec0b5537035E59745162",
+        "staticMessageIdMultisigIsmFactory": "0x8b83fefd896fAa52057798f6426E9f0B080FCCcE",
+        "pausableHook": "0x66DC49405Ae2956f7E87FEAa9fE8f506C8987462",
+        "protocolFee": "0xE0C452DDA7506f0F4dE5C8C1d383F7aD866eA4F0",
+        "proxyAdmin": "0x0761b0827849abbf7b0cC09CE14e1C93D87f5004",
+        "domainRoutingIsmFactory": "0x1052eF3419f26Bec74Ed7CEf4a4FA6812Bc09908",
+        "storageGasOracle": "0x59Bf7c7b458375b1A7c453aE70EaCb376E65CDAF",
+        "testRecipient": "0x2Fa570E83009eaEef3a1cbd496a9a30F05266634",
+        "validatorAnnounce": "0x931dFCc8c1141D6F532FD023bd87DAe0080c835d"
+    },
     "avalanche": {
         "aggregationHook": "0x0165a22BA489F7DA37DAf6397781777D9FCB5708",
         "domainRoutingIsmFactory": "0x28F7907911C7E321c596686AE6D1F20516450037",

package/dist/coreChainMetadata.js

@@ -18,6 +18,9 @@ export const coreChainMetadata = {
         "domainId": 42161,
         "gasCurrencyCoinGeckoId": "ethereum",
         "gnosisSafeTransactionServiceUrl": "https://safe-transaction-arbitrum.safe.global/",
+        "index": {
+            "from": 143649797
+        },
         "name": "arbitrum",
         "nativeToken": {
             "decimals": 18,
@@ -32,6 +35,39 @@ export const coreChainMetadata = {
         ],
         "technicalStack": "arbitrumnitro"
     },
+    "ancient8": {
+        "blockExplorers": [
+            {
+                "apiUrl": "https://scan.ancient8.gg/api",
+                "family": "blockscout",
+                "name": "Ancient8 Explorer",
+                "url": "https://scan.ancient8.gg"
+            }
+        ],
+        "blocks": {
+            "confirmations": 1,
+            "estimateBlockTime": 2,
+            "reorgPeriod": 0
+        },
+        "chainId": 888888888,
+        "displayName": "Ancient8",
+        "domainId": 888888888,
+        "gasCurrencyCoinGeckoId": "ethereum",
+        "isTestnet": false,
+        "name": "ancient8",
+        "nativeToken": {
+            "decimals": 18,
+            "name": "Ether",
+            "symbol": "ETH"
+        },
+        "protocol": "ethereum",
+        "rpcUrls": [
+            {
+                "http": "https://rpc.ancient8.gg"
+            }
+        ],
+        "technicalStack": "other"
+    },
     "avalanche": {
         "blockExplorers": [
             {
@@ -847,10 +883,10 @@ export const coreChainMetadata = {
     "solanadevnet": {
         "blockExplorers": [
             {
-                "apiUrl": "https://explorer.solana.com",
+                "apiUrl": "https://explorer.solana.com?cluster=devnet",
                 "family": "other",
                 "name": "Solana Explorer",
-                "url": "https://explorer.solana.com"
+                "url": "https://explorer.solana.com?cluster=devnet"
             }
         ],
         "blocks": {
@@ -879,10 +915,10 @@ export const coreChainMetadata = {
     "solanatestnet": {
         "blockExplorers": [
             {
-                "apiUrl": "https://explorer.solana.com",
+                "apiUrl": "https://explorer.solana.com?cluster=testnet",
                 "family": "other",
                 "name": "Solana Explorer",
-                "url": "https://explorer.solana.com"
+                "url": "https://explorer.solana.com?cluster=testnet"
             }
         ],
         "blocks": {

package/dist/index-local.d.ts

@@ -0,0 +1 @@
+export { LocalRegistry } from './registry/LocalRegistry.js';

package/dist/index-local.js

@@ -0,0 +1,2 @@
+// Exports for utilities that require fs access and are not suitable for browser use
+export { LocalRegistry } from './registry/LocalRegistry.js';

package/dist/index.d.ts

@@ -1,13 +1,16 @@
 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 { ChainFiles, IRegistry, RegistryContent, RegistryType } from './registry/IRegistry.js';
+export { ChainAddresses, ChainAddressesSchema } from './types.js';
 export { chainMetadata } from './chainMetadata.js';
 export { coreChainMetadata } from './coreChainMetadata.js';
 export { chainAddresses } from './chainAddresses.js';
 export { coreChainAddresses } from './coreChainAddresses.js';
 export { metadata as alfajores } from './chains/alfajores/metadata.js';
 export { addresses as alfajoresAddresses } from './chains/alfajores/addresses.js';
+export { metadata as ancient8 } from './chains/ancient8/metadata.js';
+export { addresses as ancient8Addresses } from './chains/ancient8/addresses.js';
 export { metadata as arbitrum } from './chains/arbitrum/metadata.js';
 export { addresses as arbitrumAddresses } from './chains/arbitrum/addresses.js';
 export { metadata as avalanche } from './chains/avalanche/metadata.js';

package/dist/index.js

@@ -1,12 +1,16 @@
 export { CoreChain, CoreChains, CoreMainnets, CoreTestnets } from './core/chains.js';
 export { BaseRegistry } from './registry/BaseRegistry.js';
 export { GithubRegistry } from './registry/GithubRegistry.js';
+export { RegistryType } from './registry/IRegistry.js';
+export { ChainAddressesSchema } from './types.js';
 export { chainMetadata } from './chainMetadata.js';
 export { coreChainMetadata } from './coreChainMetadata.js';
 export { chainAddresses } from './chainAddresses.js';
 export { coreChainAddresses } from './coreChainAddresses.js';
 export { metadata as alfajores } from './chains/alfajores/metadata.js';
 export { addresses as alfajoresAddresses } from './chains/alfajores/addresses.js';
+export { metadata as ancient8 } from './chains/ancient8/metadata.js';
+export { addresses as ancient8Addresses } from './chains/ancient8/addresses.js';
 export { metadata as arbitrum } from './chains/arbitrum/metadata.js';
 export { addresses as arbitrumAddresses } from './chains/arbitrum/addresses.js';
 export { metadata as avalanche } from './chains/avalanche/metadata.js';

package/dist/registry/BaseRegistry.d.ts

@@ -1,7 +1,10 @@
 import type { Logger } from 'pino';
 import type { ChainMap, ChainMetadata, ChainName } from '@hyperlane-xyz/sdk';
-import type { ChainAddresses, IRegistry, RegistryContent } from './IRegistry.js';
+import type { ChainAddresses, MaybePromise } from '../types.js';
+import type { IRegistry, RegistryContent, RegistryType } from './IRegistry.js';
+export declare const CHAIN_FILE_REGEX: RegExp;
 export declare abstract class BaseRegistry implements IRegistry {
+    abstract type: RegistryType;
     protected readonly logger: Logger;
     protected listContentCache?: RegistryContent;
     protected metadataCache?: ChainMap<ChainMetadata>;
@@ -11,10 +14,21 @@ export declare abstract class BaseRegistry implements IRegistry {
     });
     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>;
+    abstract listRegistryContent(): MaybePromise<RegistryContent>;
+    abstract getChains(): MaybePromise<Array<ChainName>>;
+    abstract getMetadata(): MaybePromise<ChainMap<ChainMetadata>>;
+    abstract getChainMetadata(chainName: ChainName): MaybePromise<ChainMetadata | null>;
+    abstract getAddresses(): MaybePromise<ChainMap<ChainAddresses>>;
+    abstract getChainAddresses(chainName: ChainName): MaybePromise<ChainAddresses | null>;
+    abstract addChain(chains: {
+        chainName: ChainName;
+        metadata?: ChainMetadata;
+        addresses?: ChainAddresses;
+    }): MaybePromise<void>;
+    abstract updateChain(chains: {
+        chainName: ChainName;
+        metadata?: ChainMetadata;
+        addresses?: ChainAddresses;
+    }): MaybePromise<void>;
+    abstract removeChain(chains: ChainName): MaybePromise<void>;
 }

package/dist/registry/BaseRegistry.js

@@ -1,3 +1,4 @@
+export const CHAIN_FILE_REGEX = /chains\/([a-z]+)\/([a-z0-9]+)\.yaml/;
 export class BaseRegistry {
     logger;
     // Caches

package/dist/registry/GithubRegistry.d.ts

@@ -1,14 +1,16 @@
 import type { Logger } from 'pino';
-import type { ChainMap, ChainMetadata, ChainName } from '@hyperlane-xyz/sdk';
+import { type ChainMap, type ChainMetadata, type ChainName } from '@hyperlane-xyz/sdk';
+import { ChainAddresses } from '../types.js';
 import { BaseRegistry } from './BaseRegistry.js';
-import type { ChainAddresses, IRegistry, RegistryContent } from './IRegistry.js';
+import { RegistryType, type IRegistry, type RegistryContent } from './IRegistry.js';
 export interface GithubRegistryOptions {
-    url?: string;
+    uri?: string;
     branch?: string;
     authToken?: string;
     logger?: Logger;
 }
 export declare class GithubRegistry extends BaseRegistry implements IRegistry {
+    readonly type = RegistryType.Github;
     readonly url: URL;
     readonly branch: string;
     readonly repoOwner: string;
@@ -20,6 +22,17 @@ export declare class GithubRegistry extends BaseRegistry implements IRegistry {
     getChainMetadata(chainName: ChainName): Promise<ChainMetadata>;
     getAddresses(): Promise<ChainMap<ChainAddresses>>;
     getChainAddresses(chainName: ChainName): Promise<ChainAddresses>;
+    addChain(_chains: {
+        chainName: ChainName;
+        metadata?: ChainMetadata;
+        addresses?: ChainAddresses;
+    }): Promise<void>;
+    updateChain(_chains: {
+        chainName: ChainName;
+        metadata?: ChainMetadata;
+        addresses?: ChainAddresses;
+    }): Promise<void>;
+    removeChain(_chains: ChainName): Promise<void>;
     protected getRawContentUrl(path: string): string;
     protected fetch(url: string): Promise<Response>;
 }

package/dist/registry/GithubRegistry.js

@@ -1,15 +1,17 @@
-import { parse } from 'yaml';
-import { BaseRegistry } from './BaseRegistry.js';
+import { parse as yamlParse } from 'yaml';
+import { ChainAddressesSchema } from '../types.js';
+import { BaseRegistry, CHAIN_FILE_REGEX } from './BaseRegistry.js';
+import { RegistryType, } from './IRegistry.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 {
+    type = RegistryType.Github;
     url;
     branch;
     repoOwner;
     repoName;
     constructor(options = {}) {
         super({ logger: options.logger });
-        this.url = new URL(options.url ?? DEFAULT_REGISTRY);
+        this.url = new URL(options.uri ?? DEFAULT_REGISTRY);
         this.branch = options.branch ?? 'main';
         const pathSegments = this.url.pathname.split('/');
         if (pathSegments.length < 2)
@@ -48,12 +50,13 @@ export class GithubRegistry extends BaseRegistry {
             return this.metadataCache;
         const chainMetadata = {};
         const repoContents = await this.listRegistryContent();
+        // TODO use concurrentMap here when utils package is updated
         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;
+            const data = await response.text();
+            chainMetadata[chainName] = yamlParse(data);
         }
         return (this.metadataCache = chainMetadata);
     }
@@ -62,19 +65,21 @@ export class GithubRegistry extends BaseRegistry {
             return this.metadataCache[chainName];
         const url = this.getRawContentUrl(`${this.getChainsPath()}/${chainName}/metadata.yaml`);
         const response = await this.fetch(url);
-        return parse(await response.text());
+        const data = await response.text();
+        return yamlParse(data);
     }
     async getAddresses() {
         if (this.addressCache)
             return this.addressCache;
         const chainAddresses = {};
         const repoContents = await this.listRegistryContent();
+        // TODO use concurrentMap here when utils package is updated
         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;
+            const data = await response.text();
+            chainAddresses[chainName] = ChainAddressesSchema.parse(yamlParse(data));
         }
         return (this.addressCache = chainAddresses);
     }
@@ -83,7 +88,17 @@ export class GithubRegistry extends BaseRegistry {
             return this.addressCache[chainName];
         const url = this.getRawContentUrl(`${this.getChainsPath()}/${chainName}/addresses.yaml`);
         const response = await this.fetch(url);
-        return parse(await response.text());
+        const data = await response.text();
+        return ChainAddressesSchema.parse(yamlParse(data));
+    }
+    async addChain(_chains) {
+        throw new Error('TODO: Implement');
+    }
+    async updateChain(_chains) {
+        throw new Error('TODO: Implement');
+    }
+    async removeChain(_chains) {
+        throw new Error('TODO: Implement');
     }
     getRawContentUrl(path) {
         return `https://raw.githubusercontent.com/${this.repoOwner}/${this.repoName}/${this.branch}/${path}`;

package/dist/registry/IRegistry.d.ts

@@ -1,5 +1,5 @@
-import type { Address } from '@hyperlane-xyz/utils';
 import type { ChainMap, ChainMetadata, ChainName } from '@hyperlane-xyz/sdk';
+import type { ChainAddresses, MaybePromise } from '../types.js';
 export interface ChainFiles {
     metadata?: string;
     addresses?: string;
@@ -8,12 +8,27 @@ export interface RegistryContent {
     chains: ChainMap<ChainFiles>;
     deployments: {};
 }
-export type ChainAddresses = Record<string, Address>;
+export declare enum RegistryType {
+    Github = "github",
+    Local = "local"
+}
 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>;
+    type: RegistryType;
+    listRegistryContent(): MaybePromise<RegistryContent>;
+    getChains(): MaybePromise<Array<ChainName>>;
+    getMetadata(): MaybePromise<ChainMap<ChainMetadata>>;
+    getChainMetadata(chainName: ChainName): MaybePromise<ChainMetadata | null>;
+    getAddresses(): MaybePromise<ChainMap<ChainAddresses>>;
+    getChainAddresses(chainName: ChainName): MaybePromise<ChainAddresses | null>;
+    addChain(chains: {
+        chainName: ChainName;
+        metadata?: ChainMetadata;
+        addresses?: ChainAddresses;
+    }): MaybePromise<void>;
+    updateChain(chains: {
+        chainName: ChainName;
+        metadata?: ChainMetadata;
+        addresses?: ChainAddresses;
+    }): MaybePromise<void>;
+    removeChain(chains: ChainName): MaybePromise<void>;
 }

package/dist/registry/IRegistry.js

@@ -1 +1,5 @@
-export {};
+export var RegistryType;
+(function (RegistryType) {
+    RegistryType["Github"] = "github";
+    RegistryType["Local"] = "local";
+})(RegistryType || (RegistryType = {}));

package/dist/registry/LocalRegistry.d.ts

@@ -0,0 +1,43 @@
+import type { Logger } from 'pino';
+import type { ChainMap, ChainMetadata, ChainName } from '@hyperlane-xyz/sdk';
+import { ChainAddresses } from '../types.js';
+import { BaseRegistry } from './BaseRegistry.js';
+import { RegistryType, type ChainFiles, type IRegistry, type RegistryContent } from './IRegistry.js';
+export interface LocalRegistryOptions {
+    uri: string;
+    logger?: Logger;
+}
+export declare class LocalRegistry extends BaseRegistry implements IRegistry {
+    readonly type = RegistryType.Local;
+    readonly uri: string;
+    constructor(options: LocalRegistryOptions);
+    listRegistryContent(): RegistryContent;
+    getChains(): Array<ChainName>;
+    getMetadata(): ChainMap<ChainMetadata>;
+    getChainMetadata(chainName: ChainName): ChainMetadata;
+    getAddresses(): ChainMap<ChainAddresses>;
+    getChainAddresses(chainName: ChainName): ChainAddresses;
+    addChain(chain: {
+        chainName: ChainName;
+        metadata?: ChainMetadata;
+        addresses?: ChainAddresses;
+    }): void;
+    updateChain(chain: {
+        chainName: ChainName;
+        metadata?: ChainMetadata;
+        addresses?: ChainAddresses;
+    }): void;
+    removeChain(chainName: ChainName): void;
+    protected listFiles(dirPath: string): string[];
+    protected createOrUpdateChain(chain: {
+        chainName: ChainName;
+        metadata?: ChainMetadata;
+        addresses?: ChainAddresses;
+    }): void;
+    protected createChainFile(chainName: ChainName, fileName: keyof ChainFiles, data: any, cache: ChainMap<any>, prefix?: string): void;
+    protected createFile(file: {
+        filePath: string;
+        data: string;
+    }): void;
+    protected removeFiles(filePaths: string[]): void;
+}