@hyperlane-xyz/sdk 1.4.2-beta69 → 1.4.2-beta70

package/dist/contracts/contracts.js

@@ -0,0 +1,80 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.appFromAddressesMapHelper = exports.filterOwnableContracts = exports.connectContractsMap = exports.connectContracts = exports.attachContractsMap = exports.attachContracts = exports.filterAddressesMap = exports.serializeContracts = exports.serializeContractsMap = void 0;
+const utils_1 = require("@hyperlane-xyz/utils");
+function serializeContractsMap(contractsMap) {
+    return (0, utils_1.objMap)(contractsMap, (_, contracts) => {
+        return serializeContracts(contracts);
+    });
+}
+exports.serializeContractsMap = serializeContractsMap;
+function serializeContracts(contracts) {
+    return (0, utils_1.objMap)(contracts, (_, contract) => contract.address);
+}
+exports.serializeContracts = serializeContracts;
+function getFactory(key, factories) {
+    if (!(key in factories)) {
+        throw new Error(`Factories entry missing for ${key.toString()}`);
+    }
+    return factories[key];
+}
+function filterAddressesMap(addressesMap, factories) {
+    const factoryKeys = Object.keys(factories);
+    // Filter out addresses that we do not have factories for
+    const pickedAddressesMap = (0, utils_1.objMap)(addressesMap, (_, addresses) => (0, utils_1.pick)(addresses, factoryKeys));
+    // Filter out chains for which we do not have a complete set of addresses
+    return (0, utils_1.objFilter)(pickedAddressesMap, (_, addresses) => {
+        return Object.keys(addresses).every((a) => factoryKeys.includes(a));
+    });
+}
+exports.filterAddressesMap = filterAddressesMap;
+function attachContracts(addresses, factories) {
+    return (0, utils_1.objMap)(addresses, (key, address) => {
+        const factory = getFactory(key, factories);
+        return factory.attach(address);
+    });
+}
+exports.attachContracts = attachContracts;
+function attachContractsMap(addressesMap, factories) {
+    const filteredAddressesMap = filterAddressesMap(addressesMap, factories);
+    return (0, utils_1.objMap)(filteredAddressesMap, (_, addresses) => attachContracts(addresses, factories));
+}
+exports.attachContractsMap = attachContractsMap;
+function connectContracts(contracts, connection) {
+    return (0, utils_1.objMap)(contracts, (_, contract) => contract.connect(connection));
+}
+exports.connectContracts = connectContracts;
+function connectContractsMap(contractsMap, multiProvider) {
+    return (0, utils_1.objMap)(contractsMap, (chain, contracts) => connectContracts(contracts, multiProvider.getSignerOrProvider(chain)));
+}
+exports.connectContractsMap = connectContractsMap;
+async function filterOwnableContracts(contracts) {
+    const isOwnable = async (_, contract) => {
+        try {
+            await contract.owner();
+            return true;
+        }
+        catch (_) {
+            return false;
+        }
+    };
+    const isOwnableContracts = await (0, utils_1.promiseObjAll)((0, utils_1.objMap)(contracts, isOwnable));
+    return (0, utils_1.objFilter)(contracts, (name, contract) => isOwnableContracts[name]);
+}
+exports.filterOwnableContracts = filterOwnableContracts;
+function appFromAddressesMapHelper(addressesMap, factories, multiProvider) {
+    // Attaches contracts for each chain for which we have a complete set of
+    // addresses
+    const contractsMap = attachContractsMap(addressesMap, factories);
+    // Filters out providers for chains for which we don't have a complete set
+    // of addresses
+    const intersection = multiProvider.intersect(Object.keys(contractsMap));
+    // Filters out contracts for chains for which we don't have a provider
+    const filteredContractsMap = (0, utils_1.pick)(contractsMap, intersection.intersection);
+    return {
+        contractsMap: filteredContractsMap,
+        multiProvider: intersection.multiProvider,
+    };
+}
+exports.appFromAddressesMapHelper = appFromAddressesMapHelper;
+//# sourceMappingURL=contracts.js.map

package/dist/contracts/contracts.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"contracts.js","sourceRoot":"","sources":["../../src/contracts/contracts.ts"],"names":[],"mappings":";;;AAGA,gDAO8B;AAa9B,SAAgB,qBAAqB,CACnC,YAAsC;IAEtC,OAAO,IAAA,cAAM,EAAC,YAAY,EAAE,CAAC,CAAC,EAAE,SAAS,EAAE,EAAE;QAC3C,OAAO,kBAAkB,CAAC,SAAS,CAAC,CAAC;IACvC,CAAC,CAAC,CAAC;AACL,CAAC;AAND,sDAMC;AAED,SAAgB,kBAAkB,CAChC,SAAgC;IAEhC,OAAO,IAAA,cAAM,EAAC,SAAS,EAAE,CAAC,CAAC,EAAE,QAAQ,EAAE,EAAE,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;AAC9D,CAAC;AAJD,gDAIC;AAED,SAAS,UAAU,CACjB,GAAY,EACZ,SAAY;IAEZ,IAAI,CAAC,CAAC,GAAG,IAAI,SAAS,CAAC,EAAE;QACvB,MAAM,IAAI,KAAK,CAAC,+BAA+B,GAAG,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC;KAClE;IACD,OAAO,SAAS,CAAC,GAAG,CAAC,CAAC;AACxB,CAAC;AAED,SAAgB,kBAAkB,CAChC,YAAwC,EACxC,SAAY;IAEZ,MAAM,WAAW,GAAG,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;IAC3C,yDAAyD;IACzD,MAAM,kBAAkB,GAAG,IAAA,cAAM,EAAC,YAAY,EAAE,CAAC,CAAC,EAAE,SAAS,EAAE,EAAE,CAC/D,IAAA,YAAI,EAAC,SAAS,EAAE,WAAW,CAAC,CAC7B,CAAC;IACF,yEAAyE;IACzE,OAAO,IAAA,iBAAS,EACd,kBAAkB,EAClB,CAAC,CAAC,EAAE,SAAS,EAAsC,EAAE;QACnD,OAAO,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC;IACtE,CAAC,CACF,CAAC;AACJ,CAAC;AAhBD,gDAgBC;AAED,SAAgB,eAAe,CAC7B,SAAgC,EAChC,SAAY;IAEZ,OAAO,IAAA,cAAM,EAAC,SAAS,EAAE,CAAC,GAAG,EAAE,OAAgB,EAAE,EAAE;QACjD,MAAM,OAAO,GAAG,UAAU,CAAC,GAAG,EAAE,SAAS,CAAC,CAAC;QAC3C,OAAO,OAAO,CAAC,MAAM,CAAC,OAAO,CAA8C,CAAC;IAC9E,CAAC,CAAC,CAAC;AACL,CAAC;AARD,0CAQC;AAED,SAAgB,kBAAkB,CAChC,YAAwC,EACxC,SAAY;IAEZ,MAAM,oBAAoB,GAAG,kBAAkB,CAAC,YAAY,EAAE,SAAS,CAAC,CAAC;IACzE,OAAO,IAAA,cAAM,EAAC,oBAAoB,EAAE,CAAC,CAAC,EAAE,SAAS,EAAE,EAAE,CACnD,eAAe,CAAC,SAAS,EAAE,SAAS,CAAC,CACV,CAAC;AAChC,CAAC;AARD,gDAQC;AAED,SAAgB,gBAAgB,CAC9B,SAAgC,EAChC,UAAsB;IAEtB,OAAO,IAAA,cAAM,EACX,SAAS,EACT,CAAC,CAAC,EAAE,QAAQ,EAAE,EAAE,CAAC,QAAQ,CAAC,OAAO,CAAC,UAAU,CAAoB,CACjE,CAAC;AACJ,CAAC;AARD,4CAQC;AAED,SAAgB,mBAAmB,CACjC,YAA6C,EAC7C,aAA4B;IAE5B,OAAO,IAAA,cAAM,EAAC,YAAY,EAAE,CAAC,KAAK,EAAE,SAAS,EAAE,EAAE,CAC/C,gBAAgB,CAAC,SAAS,EAAE,aAAa,CAAC,mBAAmB,CAAC,KAAK,CAAC,CAAC,CACtE,CAAC;AACJ,CAAC;AAPD,kDAOC;AAEM,KAAK,UAAU,sBAAsB,CAC1C,SAAkC;IAElC,MAAM,SAAS,GAAG,KAAK,EAAE,CAAS,EAAE,QAAkB,EAAoB,EAAE;QAC1E,IAAI;YACF,MAAM,QAAQ,CAAC,KAAK,EAAE,CAAC;YACvB,OAAO,IAAI,CAAC;SACb;QAAC,OAAO,CAAC,EAAE;YACV,OAAO,KAAK,CAAC;SACd;IACH,CAAC,CAAC;IACF,MAAM,kBAAkB,GAAG,MAAM,IAAA,qBAAa,EAAC,IAAA,cAAM,EAAC,SAAS,EAAE,SAAS,CAAC,CAAC,CAAC;IAC7E,OAAO,IAAA,iBAAS,EACd,SAAS,EACT,CAAC,IAAI,EAAE,QAAQ,EAAuB,EAAE,CAAC,kBAAkB,CAAC,IAAI,CAAC,CAClE,CAAC;AACJ,CAAC;AAhBD,wDAgBC;AAED,SAAgB,yBAAyB,CACvC,YAAwC,EACxC,SAAY,EACZ,aAA4B;IAK5B,wEAAwE;IACxE,YAAY;IACZ,MAAM,YAAY,GAAG,kBAAkB,CAAC,YAAY,EAAE,SAAS,CAAC,CAAC;IAEjE,0EAA0E;IAC1E,eAAe;IACf,MAAM,YAAY,GAAG,aAAa,CAAC,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC;IAExE,sEAAsE;IACtE,MAAM,oBAAoB,GAAG,IAAA,YAAI,EAAC,YAAY,EAAE,YAAY,CAAC,YAAY,CAAC,CAAC;IAE3E,OAAO;QACL,YAAY,EAAE,oBAAoB;QAClC,aAAa,EAAE,YAAY,CAAC,aAAa;KAC1C,CAAC;AACJ,CAAC;AAvBD,8DAuBC"}

package/dist/contracts/types.d.ts

@@ -0,0 +1,18 @@
+import type { ethers } from 'ethers';
+import type { Address } from '@hyperlane-xyz/utils';
+import type { ChainMap } from '../types';
+export type AddressesMap = {
+    [key: string]: Address;
+};
+export type HyperlaneFactories = {
+    [key: string]: ethers.ContractFactory;
+};
+export type HyperlaneContracts<F extends HyperlaneFactories> = {
+    [P in keyof F]: Awaited<ReturnType<F[P]['deploy']>>;
+};
+export type HyperlaneContractsMap<F extends HyperlaneFactories> = ChainMap<HyperlaneContracts<F>>;
+export type HyperlaneAddresses<F extends HyperlaneFactories> = {
+    [P in keyof F]: Address;
+};
+export type HyperlaneAddressesMap<F extends HyperlaneFactories> = ChainMap<HyperlaneAddresses<F>>;
+//# sourceMappingURL=types.d.ts.map

package/dist/contracts/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/contracts/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AAErC,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,sBAAsB,CAAC;AAEpD,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,UAAU,CAAC;AAEzC,MAAM,MAAM,YAAY,GAAG;IACzB,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;CACxB,CAAC;AAEF,MAAM,MAAM,kBAAkB,GAAG;IAC/B,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAC,eAAe,CAAC;CACvC,CAAC;AAEF,MAAM,MAAM,kBAAkB,CAAC,CAAC,SAAS,kBAAkB,IAAI;KAC5D,CAAC,IAAI,MAAM,CAAC,GAAG,OAAO,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC;CACpD,CAAC;AAEF,MAAM,MAAM,qBAAqB,CAAC,CAAC,SAAS,kBAAkB,IAAI,QAAQ,CACxE,kBAAkB,CAAC,CAAC,CAAC,CACtB,CAAC;AAEF,MAAM,MAAM,kBAAkB,CAAC,CAAC,SAAS,kBAAkB,IAAI;KAC5D,CAAC,IAAI,MAAM,CAAC,GAAG,OAAO;CACxB,CAAC;AAEF,MAAM,MAAM,qBAAqB,CAAC,CAAC,SAAS,kBAAkB,IAAI,QAAQ,CACxE,kBAAkB,CAAC,CAAC,CAAC,CACtB,CAAC"}

package/dist/contracts/types.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=types.js.map

package/dist/contracts/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/contracts/types.ts"],"names":[],"mappings":""}

package/dist/metadata/ChainMetadataManager.d.ts

@@ -0,0 +1,130 @@
+import { Debugger } from 'debug';
+import { ChainMap, ChainName } from '../types';
+import { ChainMetadata } from './chainMetadataTypes';
+export interface ChainMetadataManagerOptions {
+    loggerName?: string;
+}
+/**
+ * A set of utilities to manage chain metadata
+ * Validates metadata on construction and provides useful methods
+ * for interacting with the data
+ */
+export declare class ChainMetadataManager<MetaExt = {}> {
+    readonly metadata: ChainMap<ChainMetadata<MetaExt>>;
+    protected readonly logger: Debugger;
+    /**
+     * Create a new ChainMetadataManager with the given chainMetadata,
+     * or the SDK's default metadata if not provided
+     */
+    constructor(chainMetadata?: ChainMap<ChainMetadata<MetaExt>>, options?: ChainMetadataManagerOptions);
+    /**
+     * Add a chain to the MultiProvider
+     * @throws if chain's name or domain/chain ID collide
+     */
+    addChain(metadata: ChainMetadata<MetaExt>): void;
+    /**
+     * Get the metadata for a given chain name, chain id, or domain id
+     * @throws if chain's metadata has not been set
+     */
+    tryGetChainMetadata(chainNameOrId: ChainName | number): ChainMetadata<MetaExt> | null;
+    /**
+     * Get the metadata for a given chain name, chain id, or domain id
+     * @throws if chain's metadata has not been set
+     */
+    getChainMetadata(chainNameOrId: ChainName | number): ChainMetadata<MetaExt>;
+    /**
+     * Get the name for a given chain name, chain id, or domain id
+     */
+    tryGetChainName(chainNameOrId: ChainName | number): string | null;
+    /**
+     * Get the name for a given chain name, chain id, or domain id
+     * @throws if chain's metadata has not been set
+     */
+    getChainName(chainNameOrId: ChainName | number): string;
+    /**
+     * Get the names for all chains known to this MultiProvider
+     */
+    getKnownChainNames(): string[];
+    /**
+     * Get the id for a given chain name, chain id, or domain id
+     */
+    tryGetChainId(chainNameOrId: ChainName | number): number | null;
+    /**
+     * Get the id for a given chain name, chain id, or domain id
+     * @throws if chain's metadata has not been set
+     */
+    getChainId(chainNameOrId: ChainName | number): number;
+    /**
+     * Get the ids for all chains known to this MultiProvider
+     */
+    getKnownChainIds(): number[];
+    /**
+     * Get the domain id for a given chain name, chain id, or domain id
+     */
+    tryGetDomainId(chainNameOrId: ChainName | number): number | null;
+    /**
+     * Get the domain id for a given chain name, chain id, or domain id
+     * @throws if chain's metadata has not been set
+     */
+    getDomainId(chainNameOrId: ChainName | number): number;
+    /**
+     * Get the domain ids for a list of chain names, chain ids, or domain ids
+     * @throws if any chain's metadata has not been set
+     */
+    getDomainIds(chainNamesOrIds: Array<ChainName | number>): number[];
+    /**
+     * Get the ids for all chains known to this MultiProvider
+     */
+    getKnownDomainIds(): number[];
+    /**
+     * Get chain names excluding given chain name
+     */
+    getRemoteChains(name: ChainName): ChainName[];
+    /**
+     * Run given function on all known chains
+     */
+    mapKnownChains<Output>(fn: (n: ChainName) => Output): ChainMap<Output>;
+    /**
+     * Get an RPC URL for a given chain name, chain id, or domain id
+     * @throws if chain's metadata has not been set
+     */
+    getRpcUrl(chainNameOrId: ChainName | number): string;
+    /**
+     * Get a block explorer URL for a given chain name, chain id, or domain id
+     */
+    tryGetExplorerUrl(chainNameOrId: ChainName | number): string | null;
+    /**
+     * Get a block explorer URL for a given chain name, chain id, or domain id
+     * @throws if chain's metadata or block explorer data has no been set
+     */
+    getExplorerUrl(chainNameOrId: ChainName | number): string;
+    /**
+     * Get a block explorer's API URL for a given chain name, chain id, or domain id
+     */
+    tryGetExplorerApiUrl(chainNameOrId: ChainName | number): string | null;
+    /**
+     * Get a block explorer API URL for a given chain name, chain id, or domain id
+     * @throws if chain's metadata or block explorer data has no been set
+     */
+    getExplorerApiUrl(chainNameOrId: ChainName | number): string;
+    /**
+     * Get a block explorer URL for given chain's tx
+     */
+    tryGetExplorerTxUrl(chainNameOrId: ChainName | number, response: {
+        hash: string;
+    }): string | null;
+    /**
+     * Get a block explorer URL for given chain's tx
+     * @throws if chain's metadata or block explorer data has no been set
+     */
+    getExplorerTxUrl(chainNameOrId: ChainName | number, response: {
+        hash: string;
+    }): string;
+    /**
+     * Creates a new ChainMetadataManager with the extended metadata
+     * @param additionalMetadata extra fields to add to the metadata for each chain
+     * @returns a new ChainMetadataManager
+     */
+    extendChainMetadata<NewExt = {}>(additionalMetadata: ChainMap<NewExt>): ChainMetadataManager<MetaExt & NewExt>;
+}
+//# sourceMappingURL=ChainMetadataManager.d.ts.map

package/dist/metadata/ChainMetadataManager.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ChainMetadataManager.d.ts","sourceRoot":"","sources":["../../src/metadata/ChainMetadataManager.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAS,MAAM,OAAO,CAAC;AAKxC,OAAO,EAAE,QAAQ,EAAE,SAAS,EAAE,MAAM,UAAU,CAAC;AAE/C,OAAO,EACL,aAAa,EAGd,MAAM,sBAAsB,CAAC;AAE9B,MAAM,WAAW,2BAA2B;IAC1C,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED;;;;GAIG;AACH,qBAAa,oBAAoB,CAAC,OAAO,GAAG,EAAE;IAC5C,SAAgB,QAAQ,EAAE,QAAQ,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC,CAAM;IAChE,SAAS,CAAC,QAAQ,CAAC,MAAM,EAAE,QAAQ,CAAC;IAEpC;;;OAGG;gBAED,aAAa,GAAE,QAAQ,CACrB,aAAa,CAAC,OAAO,CAAC,CACoC,EAC5D,OAAO,GAAE,2BAAgC;IAY3C;;;OAGG;IACH,QAAQ,CAAC,QAAQ,EAAE,aAAa,CAAC,OAAO,CAAC,GAAG,IAAI;IAsBhD;;;OAGG;IACH,mBAAmB,CACjB,aAAa,EAAE,SAAS,GAAG,MAAM,GAChC,aAAa,CAAC,OAAO,CAAC,GAAG,IAAI;IAchC;;;OAGG;IACH,gBAAgB,CAAC,aAAa,EAAE,SAAS,GAAG,MAAM,GAAG,aAAa,CAAC,OAAO,CAAC;IAO3E;;OAEG;IACH,eAAe,CAAC,aAAa,EAAE,SAAS,GAAG,MAAM,GAAG,MAAM,GAAG,IAAI;IAIjE;;;OAGG;IACH,YAAY,CAAC,aAAa,EAAE,SAAS,GAAG,MAAM,GAAG,MAAM;IAIvD;;OAEG;IACH,kBAAkB,IAAI,MAAM,EAAE;IAI9B;;OAEG;IACH,aAAa,CAAC,aAAa,EAAE,SAAS,GAAG,MAAM,GAAG,MAAM,GAAG,IAAI;IAI/D;;;OAGG;IACH,UAAU,CAAC,aAAa,EAAE,SAAS,GAAG,MAAM,GAAG,MAAM;IAIrD;;OAEG;IACH,gBAAgB,IAAI,MAAM,EAAE;IAI5B;;OAEG;IACH,cAAc,CAAC,aAAa,EAAE,SAAS,GAAG,MAAM,GAAG,MAAM,GAAG,IAAI;IAKhE;;;OAGG;IACH,WAAW,CAAC,aAAa,EAAE,SAAS,GAAG,MAAM,GAAG,MAAM;IAKtD;;;OAGG;IACH,YAAY,CAAC,eAAe,EAAE,KAAK,CAAC,SAAS,GAAG,MAAM,CAAC,GAAG,MAAM,EAAE;IAIlE;;OAEG;IACH,iBAAiB,IAAI,MAAM,EAAE;IAI7B;;OAEG;IACH,eAAe,CAAC,IAAI,EAAE,SAAS,GAAG,SAAS,EAAE;IAI7C;;OAEG;IACH,cAAc,CAAC,MAAM,EAAE,EAAE,EAAE,CAAC,CAAC,EAAE,SAAS,KAAK,MAAM,GAAG,QAAQ,CAAC,MAAM,CAAC;IAQtE;;;OAGG;IACH,SAAS,CAAC,aAAa,EAAE,SAAS,GAAG,MAAM,GAAG,MAAM;IAOpD;;OAEG;IACH,iBAAiB,CAAC,aAAa,EAAE,SAAS,GAAG,MAAM,GAAG,MAAM,GAAG,IAAI;IAMnE;;;OAGG;IACH,cAAc,CAAC,aAAa,EAAE,SAAS,GAAG,MAAM,GAAG,MAAM;IAMzD;;OAEG;IACH,oBAAoB,CAAC,aAAa,EAAE,SAAS,GAAG,MAAM,GAAG,MAAM,GAAG,IAAI;IAUtE;;;OAGG;IACH,iBAAiB,CAAC,aAAa,EAAE,SAAS,GAAG,MAAM,GAAG,MAAM;IAM5D;;OAEG;IACH,mBAAmB,CACjB,aAAa,EAAE,SAAS,GAAG,MAAM,EACjC,QAAQ,EAAE;QAAE,IAAI,EAAE,MAAM,CAAA;KAAE,GACzB,MAAM,GAAG,IAAI;IAKhB;;;OAGG;IACH,gBAAgB,CACd,aAAa,EAAE,SAAS,GAAG,MAAM,EACjC,QAAQ,EAAE;QAAE,IAAI,EAAE,MAAM,CAAA;KAAE,GACzB,MAAM;IAIT;;;;OAIG;IACH,mBAAmB,CAAC,MAAM,GAAG,EAAE,EAC7B,kBAAkB,EAAE,QAAQ,CAAC,MAAM,CAAC,GACnC,oBAAoB,CAAC,OAAO,GAAG,MAAM,CAAC;CAS1C"}

package/dist/metadata/ChainMetadataManager.js

@@ -0,0 +1,240 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ChainMetadataManager = void 0;
+const debug_1 = require("debug");
+const utils_1 = require("@hyperlane-xyz/utils");
+const chainMetadata_1 = require("../consts/chainMetadata");
+const chainMetadataTypes_1 = require("./chainMetadataTypes");
+/**
+ * A set of utilities to manage chain metadata
+ * Validates metadata on construction and provides useful methods
+ * for interacting with the data
+ */
+class ChainMetadataManager {
+    /**
+     * Create a new ChainMetadataManager with the given chainMetadata,
+     * or the SDK's default metadata if not provided
+     */
+    constructor(chainMetadata = chainMetadata_1.chainMetadata, options = {}) {
+        this.metadata = {};
+        Object.entries(chainMetadata).forEach(([key, cm]) => {
+            if (key !== cm.name)
+                throw new Error(`Chain name mismatch: Key was ${key}, but name is ${cm.name}`);
+            this.addChain(cm);
+        });
+        this.logger = (0, debug_1.debug)(options?.loggerName || 'hyperlane:MetadataManager');
+    }
+    /**
+     * Add a chain to the MultiProvider
+     * @throws if chain's name or domain/chain ID collide
+     */
+    addChain(metadata) {
+        if (!(0, chainMetadataTypes_1.isValidChainMetadata)(metadata))
+            throw new Error(`Invalid chain metadata for ${metadata.name}`);
+        // Ensure no two chains have overlapping names/domainIds/chainIds
+        for (const chainMetadata of Object.values(this.metadata)) {
+            const { name, chainId, domainId } = chainMetadata;
+            if (name == metadata.name)
+                throw new Error(`Duplicate chain name: ${name}`);
+            // Chain and Domain Ids should be globally unique
+            const idCollision = chainId == metadata.chainId ||
+                domainId == metadata.chainId ||
+                (metadata.domainId &&
+                    (chainId == metadata.domainId || domainId === metadata.domainId));
+            if (idCollision)
+                throw new Error(`Chain/Domain id collision: ${name} and ${metadata.name}`);
+        }
+        this.metadata[metadata.name] = metadata;
+    }
+    /**
+     * Get the metadata for a given chain name, chain id, or domain id
+     * @throws if chain's metadata has not been set
+     */
+    tryGetChainMetadata(chainNameOrId) {
+        let chainMetadata;
+        if ((0, utils_1.isNumeric)(chainNameOrId)) {
+            // Should be chain id or domain id
+            chainMetadata = Object.values(this.metadata).find((m) => m.chainId == chainNameOrId || m.domainId == chainNameOrId);
+        }
+        else if (typeof chainNameOrId === 'string') {
+            // Should be chain name
+            chainMetadata = this.metadata[chainNameOrId];
+        }
+        return chainMetadata || null;
+    }
+    /**
+     * Get the metadata for a given chain name, chain id, or domain id
+     * @throws if chain's metadata has not been set
+     */
+    getChainMetadata(chainNameOrId) {
+        const chainMetadata = this.tryGetChainMetadata(chainNameOrId);
+        if (!chainMetadata)
+            throw new Error(`No chain metadata set for ${chainNameOrId}`);
+        return chainMetadata;
+    }
+    /**
+     * Get the name for a given chain name, chain id, or domain id
+     */
+    tryGetChainName(chainNameOrId) {
+        return this.tryGetChainMetadata(chainNameOrId)?.name ?? null;
+    }
+    /**
+     * Get the name for a given chain name, chain id, or domain id
+     * @throws if chain's metadata has not been set
+     */
+    getChainName(chainNameOrId) {
+        return this.getChainMetadata(chainNameOrId).name;
+    }
+    /**
+     * Get the names for all chains known to this MultiProvider
+     */
+    getKnownChainNames() {
+        return Object.keys(this.metadata);
+    }
+    /**
+     * Get the id for a given chain name, chain id, or domain id
+     */
+    tryGetChainId(chainNameOrId) {
+        return this.tryGetChainMetadata(chainNameOrId)?.chainId ?? null;
+    }
+    /**
+     * Get the id for a given chain name, chain id, or domain id
+     * @throws if chain's metadata has not been set
+     */
+    getChainId(chainNameOrId) {
+        return this.getChainMetadata(chainNameOrId).chainId;
+    }
+    /**
+     * Get the ids for all chains known to this MultiProvider
+     */
+    getKnownChainIds() {
+        return Object.values(this.metadata).map((c) => c.chainId);
+    }
+    /**
+     * Get the domain id for a given chain name, chain id, or domain id
+     */
+    tryGetDomainId(chainNameOrId) {
+        const metadata = this.tryGetChainMetadata(chainNameOrId);
+        return metadata?.domainId ?? metadata?.chainId ?? null;
+    }
+    /**
+     * Get the domain id for a given chain name, chain id, or domain id
+     * @throws if chain's metadata has not been set
+     */
+    getDomainId(chainNameOrId) {
+        const metadata = this.getChainMetadata(chainNameOrId);
+        return (0, chainMetadataTypes_1.getDomainId)(metadata);
+    }
+    /**
+     * Get the domain ids for a list of chain names, chain ids, or domain ids
+     * @throws if any chain's metadata has not been set
+     */
+    getDomainIds(chainNamesOrIds) {
+        return chainNamesOrIds.map((c) => this.getDomainId(c));
+    }
+    /**
+     * Get the ids for all chains known to this MultiProvider
+     */
+    getKnownDomainIds() {
+        return this.getKnownChainNames().map(this.getDomainId);
+    }
+    /**
+     * Get chain names excluding given chain name
+     */
+    getRemoteChains(name) {
+        return (0, utils_1.exclude)(name, this.getKnownChainNames());
+    }
+    /**
+     * Run given function on all known chains
+     */
+    mapKnownChains(fn) {
+        const result = {};
+        for (const chain of this.getKnownChainNames()) {
+            result[chain] = fn(chain);
+        }
+        return result;
+    }
+    /**
+     * Get an RPC URL for a given chain name, chain id, or domain id
+     * @throws if chain's metadata has not been set
+     */
+    getRpcUrl(chainNameOrId) {
+        const { rpcUrls } = this.getChainMetadata(chainNameOrId);
+        if (!rpcUrls?.length || !rpcUrls[0].http)
+            throw new Error(`No RPC URl configured for ${chainNameOrId}`);
+        return rpcUrls[0].http;
+    }
+    /**
+     * Get a block explorer URL for a given chain name, chain id, or domain id
+     */
+    tryGetExplorerUrl(chainNameOrId) {
+        const explorers = this.tryGetChainMetadata(chainNameOrId)?.blockExplorers;
+        if (!explorers?.length)
+            return null;
+        return explorers[0].url;
+    }
+    /**
+     * Get a block explorer URL for a given chain name, chain id, or domain id
+     * @throws if chain's metadata or block explorer data has no been set
+     */
+    getExplorerUrl(chainNameOrId) {
+        const url = this.tryGetExplorerUrl(chainNameOrId);
+        if (!url)
+            throw new Error(`No explorer url set for ${chainNameOrId}`);
+        return url;
+    }
+    /**
+     * Get a block explorer's API URL for a given chain name, chain id, or domain id
+     */
+    tryGetExplorerApiUrl(chainNameOrId) {
+        const explorers = this.tryGetChainMetadata(chainNameOrId)?.blockExplorers;
+        if (!explorers?.length || !explorers[0].apiUrl)
+            return null;
+        const { apiUrl, apiKey } = explorers[0];
+        if (!apiKey)
+            return apiUrl;
+        const url = new URL(apiUrl);
+        url.searchParams.set('apikey', apiKey);
+        return url.toString();
+    }
+    /**
+     * Get a block explorer API URL for a given chain name, chain id, or domain id
+     * @throws if chain's metadata or block explorer data has no been set
+     */
+    getExplorerApiUrl(chainNameOrId) {
+        const url = this.tryGetExplorerApiUrl(chainNameOrId);
+        if (!url)
+            throw new Error(`No explorer api url set for ${chainNameOrId}`);
+        return url;
+    }
+    /**
+     * Get a block explorer URL for given chain's tx
+     */
+    tryGetExplorerTxUrl(chainNameOrId, response) {
+        const baseUrl = this.tryGetExplorerUrl(chainNameOrId);
+        return baseUrl ? `${baseUrl}/tx/${response.hash}` : null;
+    }
+    /**
+     * Get a block explorer URL for given chain's tx
+     * @throws if chain's metadata or block explorer data has no been set
+     */
+    getExplorerTxUrl(chainNameOrId, response) {
+        return `${this.getExplorerUrl(chainNameOrId)}/tx/${response.hash}`;
+    }
+    /**
+     * Creates a new ChainMetadataManager with the extended metadata
+     * @param additionalMetadata extra fields to add to the metadata for each chain
+     * @returns a new ChainMetadataManager
+     */
+    extendChainMetadata(additionalMetadata) {
+        const newMetadata = {};
+        for (const [name, meta] of Object.entries(this.metadata)) {
+            if (!additionalMetadata[name])
+                throw new Error(`No additional data provided for chain ${name}`);
+            newMetadata[name] = { ...meta, ...additionalMetadata[name] };
+        }
+        return new ChainMetadataManager(newMetadata);
+    }
+}
+exports.ChainMetadataManager = ChainMetadataManager;
+//# sourceMappingURL=ChainMetadataManager.js.map

package/dist/metadata/ChainMetadataManager.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ChainMetadataManager.js","sourceRoot":"","sources":["../../src/metadata/ChainMetadataManager.ts"],"names":[],"mappings":";;;AAAA,iCAAwC;AAExC,gDAA0D;AAE1D,2DAAgF;AAGhF,6DAI8B;AAM9B;;;;GAIG;AACH,MAAa,oBAAoB;IAI/B;;;OAGG;IACH,YACE,gBAEI,6BAAwD,EAC5D,UAAuC,EAAE;QAX3B,aAAQ,GAAqC,EAAE,CAAC;QAa9D,MAAM,CAAC,OAAO,CAAC,aAAa,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,EAAE,EAAE;YAClD,IAAI,GAAG,KAAK,EAAE,CAAC,IAAI;gBACjB,MAAM,IAAI,KAAK,CACb,gCAAgC,GAAG,iBAAiB,EAAE,CAAC,IAAI,EAAE,CAC9D,CAAC;YACJ,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC;QACpB,CAAC,CAAC,CAAC;QACH,IAAI,CAAC,MAAM,GAAG,IAAA,aAAK,EAAC,OAAO,EAAE,UAAU,IAAI,2BAA2B,CAAC,CAAC;IAC1E,CAAC;IAED;;;OAGG;IACH,QAAQ,CAAC,QAAgC;QACvC,IAAI,CAAC,IAAA,yCAAoB,EAAC,QAAQ,CAAC;YACjC,MAAM,IAAI,KAAK,CAAC,8BAA8B,QAAQ,CAAC,IAAI,EAAE,CAAC,CAAC;QACjE,iEAAiE;QACjE,KAAK,MAAM,aAAa,IAAI,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAE;YACxD,MAAM,EAAE,IAAI,EAAE,OAAO,EAAE,QAAQ,EAAE,GAAG,aAAa,CAAC;YAClD,IAAI,IAAI,IAAI,QAAQ,CAAC,IAAI;gBACvB,MAAM,IAAI,KAAK,CAAC,yBAAyB,IAAI,EAAE,CAAC,CAAC;YACnD,iDAAiD;YACjD,MAAM,WAAW,GACf,OAAO,IAAI,QAAQ,CAAC,OAAO;gBAC3B,QAAQ,IAAI,QAAQ,CAAC,OAAO;gBAC5B,CAAC,QAAQ,CAAC,QAAQ;oBAChB,CAAC,OAAO,IAAI,QAAQ,CAAC,QAAQ,IAAI,QAAQ,KAAK,QAAQ,CAAC,QAAQ,CAAC,CAAC,CAAC;YACtE,IAAI,WAAW;gBACb,MAAM,IAAI,KAAK,CACb,8BAA8B,IAAI,QAAQ,QAAQ,CAAC,IAAI,EAAE,CAC1D,CAAC;SACL;QACD,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,IAAI,CAAC,GAAG,QAAQ,CAAC;IAC1C,CAAC;IAED;;;OAGG;IACH,mBAAmB,CACjB,aAAiC;QAEjC,IAAI,aAAiD,CAAC;QACtD,IAAI,IAAA,iBAAS,EAAC,aAAa,CAAC,EAAE;YAC5B,kCAAkC;YAClC,aAAa,GAAG,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,IAAI,CAC/C,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,OAAO,IAAI,aAAa,IAAI,CAAC,CAAC,QAAQ,IAAI,aAAa,CACjE,CAAC;SACH;aAAM,IAAI,OAAO,aAAa,KAAK,QAAQ,EAAE;YAC5C,uBAAuB;YACvB,aAAa,GAAG,IAAI,CAAC,QAAQ,CAAC,aAAa,CAAC,CAAC;SAC9C;QACD,OAAO,aAAa,IAAI,IAAI,CAAC;IAC/B,CAAC;IAED;;;OAGG;IACH,gBAAgB,CAAC,aAAiC;QAChD,MAAM,aAAa,GAAG,IAAI,CAAC,mBAAmB,CAAC,aAAa,CAAC,CAAC;QAC9D,IAAI,CAAC,aAAa;YAChB,MAAM,IAAI,KAAK,CAAC,6BAA6B,aAAa,EAAE,CAAC,CAAC;QAChE,OAAO,aAAa,CAAC;IACvB,CAAC;IAED;;OAEG;IACH,eAAe,CAAC,aAAiC;QAC/C,OAAO,IAAI,CAAC,mBAAmB,CAAC,aAAa,CAAC,EAAE,IAAI,IAAI,IAAI,CAAC;IAC/D,CAAC;IAED;;;OAGG;IACH,YAAY,CAAC,aAAiC;QAC5C,OAAO,IAAI,CAAC,gBAAgB,CAAC,aAAa,CAAC,CAAC,IAAI,CAAC;IACnD,CAAC;IAED;;OAEG;IACH,kBAAkB;QAChB,OAAO,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;IACpC,CAAC;IAED;;OAEG;IACH,aAAa,CAAC,aAAiC;QAC7C,OAAO,IAAI,CAAC,mBAAmB,CAAC,aAAa,CAAC,EAAE,OAAO,IAAI,IAAI,CAAC;IAClE,CAAC;IAED;;;OAGG;IACH,UAAU,CAAC,aAAiC;QAC1C,OAAO,IAAI,CAAC,gBAAgB,CAAC,aAAa,CAAC,CAAC,OAAO,CAAC;IACtD,CAAC;IAED;;OAEG;IACH,gBAAgB;QACd,OAAO,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC;IAC5D,CAAC;IAED;;OAEG;IACH,cAAc,CAAC,aAAiC;QAC9C,MAAM,QAAQ,GAAG,IAAI,CAAC,mBAAmB,CAAC,aAAa,CAAC,CAAC;QACzD,OAAO,QAAQ,EAAE,QAAQ,IAAI,QAAQ,EAAE,OAAO,IAAI,IAAI,CAAC;IACzD,CAAC;IAED;;;OAGG;IACH,WAAW,CAAC,aAAiC;QAC3C,MAAM,QAAQ,GAAG,IAAI,CAAC,gBAAgB,CAAC,aAAa,CAAC,CAAC;QACtD,OAAO,IAAA,gCAAW,EAAC,QAAQ,CAAC,CAAC;IAC/B,CAAC;IAED;;;OAGG;IACH,YAAY,CAAC,eAA0C;QACrD,OAAO,eAAe,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,CAAC;IACzD,CAAC;IAED;;OAEG;IACH,iBAAiB;QACf,OAAO,IAAI,CAAC,kBAAkB,EAAE,CAAC,GAAG,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;IACzD,CAAC;IAED;;OAEG;IACH,eAAe,CAAC,IAAe;QAC7B,OAAO,IAAA,eAAO,EAAC,IAAI,EAAE,IAAI,CAAC,kBAAkB,EAAE,CAAC,CAAC;IAClD,CAAC;IAED;;OAEG;IACH,cAAc,CAAS,EAA4B;QACjD,MAAM,MAAM,GAAqB,EAAE,CAAC;QACpC,KAAK,MAAM,KAAK,IAAI,IAAI,CAAC,kBAAkB,EAAE,EAAE;YAC7C,MAAM,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC,KAAK,CAAC,CAAC;SAC3B;QACD,OAAO,MAAM,CAAC;IAChB,CAAC;IAED;;;OAGG;IACH,SAAS,CAAC,aAAiC;QACzC,MAAM,EAAE,OAAO,EAAE,GAAG,IAAI,CAAC,gBAAgB,CAAC,aAAa,CAAC,CAAC;QACzD,IAAI,CAAC,OAAO,EAAE,MAAM,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,IAAI;YACtC,MAAM,IAAI,KAAK,CAAC,6BAA6B,aAAa,EAAE,CAAC,CAAC;QAChE,OAAO,OAAO,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;IACzB,CAAC;IAED;;OAEG;IACH,iBAAiB,CAAC,aAAiC;QACjD,MAAM,SAAS,GAAG,IAAI,CAAC,mBAAmB,CAAC,aAAa,CAAC,EAAE,cAAc,CAAC;QAC1E,IAAI,CAAC,SAAS,EAAE,MAAM;YAAE,OAAO,IAAI,CAAC;QACpC,OAAO,SAAS,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC;IAC1B,CAAC;IAED;;;OAGG;IACH,cAAc,CAAC,aAAiC;QAC9C,MAAM,GAAG,GAAG,IAAI,CAAC,iBAAiB,CAAC,aAAa,CAAC,CAAC;QAClD,IAAI,CAAC,GAAG;YAAE,MAAM,IAAI,KAAK,CAAC,2BAA2B,aAAa,EAAE,CAAC,CAAC;QACtE,OAAO,GAAG,CAAC;IACb,CAAC;IAED;;OAEG;IACH,oBAAoB,CAAC,aAAiC;QACpD,MAAM,SAAS,GAAG,IAAI,CAAC,mBAAmB,CAAC,aAAa,CAAC,EAAE,cAAc,CAAC;QAC1E,IAAI,CAAC,SAAS,EAAE,MAAM,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,MAAM;YAAE,OAAO,IAAI,CAAC;QAC5D,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,GAAG,SAAS,CAAC,CAAC,CAAC,CAAC;QACxC,IAAI,CAAC,MAAM;YAAE,OAAO,MAAM,CAAC;QAC3B,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,MAAM,CAAC,CAAC;QAC5B,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;QACvC,OAAO,GAAG,CAAC,QAAQ,EAAE,CAAC;IACxB,CAAC;IAED;;;OAGG;IACH,iBAAiB,CAAC,aAAiC;QACjD,MAAM,GAAG,GAAG,IAAI,CAAC,oBAAoB,CAAC,aAAa,CAAC,CAAC;QACrD,IAAI,CAAC,GAAG;YAAE,MAAM,IAAI,KAAK,CAAC,+BAA+B,aAAa,EAAE,CAAC,CAAC;QAC1E,OAAO,GAAG,CAAC;IACb,CAAC;IAED;;OAEG;IACH,mBAAmB,CACjB,aAAiC,EACjC,QAA0B;QAE1B,MAAM,OAAO,GAAG,IAAI,CAAC,iBAAiB,CAAC,aAAa,CAAC,CAAC;QACtD,OAAO,OAAO,CAAC,CAAC,CAAC,GAAG,OAAO,OAAO,QAAQ,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC;IAC3D,CAAC;IAED;;;OAGG;IACH,gBAAgB,CACd,aAAiC,EACjC,QAA0B;QAE1B,OAAO,GAAG,IAAI,CAAC,cAAc,CAAC,aAAa,CAAC,OAAO,QAAQ,CAAC,IAAI,EAAE,CAAC;IACrE,CAAC;IAED;;;;OAIG;IACH,mBAAmB,CACjB,kBAAoC;QAEpC,MAAM,WAAW,GAA8C,EAAE,CAAC;QAClE,KAAK,MAAM,CAAC,IAAI,EAAE,IAAI,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAE;YACxD,IAAI,CAAC,kBAAkB,CAAC,IAAI,CAAC;gBAC3B,MAAM,IAAI,KAAK,CAAC,yCAAyC,IAAI,EAAE,CAAC,CAAC;YACnE,WAAW,CAAC,IAAI,CAAC,GAAG,EAAE,GAAG,IAAI,EAAE,GAAG,kBAAkB,CAAC,IAAI,CAAC,EAAE,CAAC;SAC9D;QACD,OAAO,IAAI,oBAAoB,CAAC,WAAW,CAAC,CAAC;IAC/C,CAAC;CACF;AA1QD,oDA0QC"}

package/dist/metadata/agentConfig.d.ts

@@ -45,9 +45,9 @@ export declare const ChainMetadataForAgentSchema: z.ZodObject<{
     name: z.ZodString;
     chainId: z.ZodNumber;
     protocol: z.ZodNativeEnum<typeof ProtocolType>;
+    mailbox: z.ZodString;
     interchainSecurityModule: z.ZodOptional<z.ZodString>;
     interchainGasPaymaster: z.ZodString;
-    mailbox: z.ZodString;
     domainId: z.ZodOptional<z.ZodNumber>;
     displayName: z.ZodOptional<z.ZodString>;
     displayNameShort: z.ZodOptional<z.ZodString>;
@@ -173,8 +173,8 @@ export declare const ChainMetadataForAgentSchema: z.ZodObject<{
     name: string;
     chainId: number;
     protocol: ProtocolType;
-    interchainGasPaymaster: string;
     mailbox: string;
+    interchainGasPaymaster: string;
     rpcUrls: [{
         http: string;
         webSocket?: string | undefined;
@@ -237,8 +237,8 @@ export declare const ChainMetadataForAgentSchema: z.ZodObject<{
     name: string;
     chainId: number;
     protocol: ProtocolType;
-    interchainGasPaymaster: string;
     mailbox: string;
+    interchainGasPaymaster: string;
     rpcUrls: [{
         http: string;
         webSocket?: string | undefined;

package/dist/metadata/agentConfig.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=agentConfig.test.d.ts.map

package/dist/metadata/agentConfig.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"agentConfig.test.d.ts","sourceRoot":"","sources":["../../src/metadata/agentConfig.test.ts"],"names":[],"mappings":""}

package/dist/metadata/agentConfig.test.js

@@ -0,0 +1,33 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const chai_1 = require("chai");
+const chains_1 = require("../consts/chains");
+const MultiProvider_1 = require("../providers/MultiProvider");
+const agentConfig_1 = require("./agentConfig");
+describe('Agent config', () => {
+    const args = [
+        [chains_1.Chains.ethereum],
+        new MultiProvider_1.MultiProvider(),
+        {
+            ethereum: {
+                mailbox: '0xmailbox',
+                interchainGasPaymaster: '0xgas',
+                validatorAnnounce: '0xannounce',
+            },
+        },
+        { ethereum: 0 },
+    ];
+    it('Should generate a deprecated agent config', () => {
+        const result = (0, agentConfig_1.buildAgentConfigDeprecated)(...args);
+        (0, chai_1.expect)(Object.keys(result)).to.deep.equal(['chains']);
+    });
+    it('Should generate a new agent config', () => {
+        const result = (0, agentConfig_1.buildAgentConfigNew)(...args);
+        (0, chai_1.expect)(Object.keys(result)).to.deep.equal([chains_1.Chains.ethereum]);
+    });
+    it('Should generate a combined agent config', () => {
+        const result = (0, agentConfig_1.buildAgentConfig)(...args);
+        (0, chai_1.expect)(Object.keys(result)).to.deep.equal([chains_1.Chains.ethereum, 'chains']);
+    });
+});
+//# sourceMappingURL=agentConfig.test.js.map

package/dist/metadata/agentConfig.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"agentConfig.test.js","sourceRoot":"","sources":["../../src/metadata/agentConfig.test.ts"],"names":[],"mappings":";;AAAA,+BAA8B;AAE9B,6CAA0C;AAC1C,8DAA2D;AAE3D,+CAIuB;AAEvB,QAAQ,CAAC,cAAc,EAAE,GAAG,EAAE;IAC5B,MAAM,IAAI,GAAwC;QAChD,CAAC,eAAM,CAAC,QAAQ,CAAC;QACjB,IAAI,6BAAa,EAAE;QACnB;YACE,QAAQ,EAAE;gBACR,OAAO,EAAE,WAAW;gBACpB,sBAAsB,EAAE,OAAO;gBAC/B,iBAAiB,EAAE,YAAY;aAChC;SACF;QACD,EAAE,QAAQ,EAAE,CAAC,EAAE;KAChB,CAAC;IAEF,EAAE,CAAC,2CAA2C,EAAE,GAAG,EAAE;QACnD,MAAM,MAAM,GAAG,IAAA,wCAA0B,EAAC,GAAG,IAAI,CAAC,CAAC;QACnD,IAAA,aAAM,EAAC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC;IACxD,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,oCAAoC,EAAE,GAAG,EAAE;QAC5C,MAAM,MAAM,GAAG,IAAA,iCAAmB,EAAC,GAAG,IAAI,CAAC,CAAC;QAC5C,IAAA,aAAM,EAAC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,eAAM,CAAC,QAAQ,CAAC,CAAC,CAAC;IAC/D,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,yCAAyC,EAAE,GAAG,EAAE;QACjD,MAAM,MAAM,GAAG,IAAA,8BAAgB,EAAC,GAAG,IAAI,CAAC,CAAC;QACzC,IAAA,aAAM,EAAC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,eAAM,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC,CAAC;IACzE,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}

package/dist/metadata/deploymentArtifacts.d.ts

@@ -5,13 +5,13 @@ export declare const HyperlaneDeploymentArtifactsSchema: z.ZodObject<{
     validatorAnnounce: z.ZodString;
     interchainSecurityModule: z.ZodOptional<z.ZodString>;
 }, "strip", z.ZodTypeAny, {
-    interchainGasPaymaster: string;
     mailbox: string;
+    interchainGasPaymaster: string;
     validatorAnnounce: string;
     interchainSecurityModule?: string | undefined;
 }, {
-    interchainGasPaymaster: string;
     mailbox: string;
+    interchainGasPaymaster: string;
     validatorAnnounce: string;
     interchainSecurityModule?: string | undefined;
 }>;
@@ -132,8 +132,8 @@ export declare const ChainMetadataWithArtifactsSchema: z.ZodObject<{
     name: string;
     chainId: number;
     protocol: import("./chainMetadataTypes").ProtocolType;
-    interchainGasPaymaster: string;
     mailbox: string;
+    interchainGasPaymaster: string;
     rpcUrls: [{
         http: string;
         webSocket?: string | undefined;
@@ -190,8 +190,8 @@ export declare const ChainMetadataWithArtifactsSchema: z.ZodObject<{
     name: string;
     chainId: number;
     protocol: import("./chainMetadataTypes").ProtocolType;
-    interchainGasPaymaster: string;
     mailbox: string;
+    interchainGasPaymaster: string;
     rpcUrls: [{
         http: string;
         webSocket?: string | undefined;

package/dist/providers/MultiProtocolProvider.d.ts

@@ -0,0 +1,39 @@
+import { Debugger } from 'debug';
+import { ChainMetadataManager } from '../metadata/ChainMetadataManager';
+import type { ChainMetadata } from '../metadata/chainMetadataTypes';
+import type { ChainMap, ChainName } from '../types';
+import type { MultiProvider } from './MultiProvider';
+import { EthersV5Provider, ProviderMap, ProviderType, SolanaWeb3Provider, TypedProvider, ViemProvider } from './ProviderType';
+import { ProviderBuilderMap } from './providerBuilders';
+export interface MultiProtocolProviderOptions {
+    loggerName?: string;
+    providerBuilders?: Partial<ProviderBuilderMap>;
+}
+/**
+ * A version of MultiProvider that can support different
+ * provider types across different protocol types.
+ *
+ * This uses a different interface for provider/signer related methods
+ * so it isn't strictly backwards compatible with MultiProvider.
+ *
+ * Unlike MultiProvider, this class does not support signer/signing methods (yet).
+ * @typeParam MetaExt - Extra metadata fields for chains (such as contract addresses)
+ */
+export declare class MultiProtocolProvider<MetaExt = {}> extends ChainMetadataManager<MetaExt> {
+    protected readonly options: MultiProtocolProviderOptions;
+    protected readonly providers: ChainMap<ProviderMap<TypedProvider>>;
+    protected signers: ChainMap<ProviderMap<never>>;
+    protected readonly logger: Debugger;
+    protected readonly providerBuilders: Partial<ProviderBuilderMap>;
+    constructor(chainMetadata?: ChainMap<ChainMetadata<MetaExt>>, options?: MultiProtocolProviderOptions);
+    static fromMultiProvider<MetaExt = {}>(mp: MultiProvider<MetaExt>, options?: MultiProtocolProviderOptions): MultiProtocolProvider<MetaExt>;
+    extendChainMetadata<NewExt = {}>(additionalMetadata: ChainMap<NewExt>): MultiProtocolProvider<MetaExt & NewExt>;
+    tryGetProvider(chainNameOrId: ChainName | number, type: ProviderType): TypedProvider | null;
+    getProvider(chainNameOrId: ChainName | number, type: ProviderType): TypedProvider;
+    getEthersV5Provider(chainNameOrId: ChainName | number): EthersV5Provider['provider'];
+    getViemProvider(chainNameOrId: ChainName | number): ViemProvider['provider'];
+    getSolanaWeb3Provider(chainNameOrId: ChainName | number): SolanaWeb3Provider['provider'];
+    setProvider(chainNameOrId: ChainName | number, provider: TypedProvider): TypedProvider;
+    setProviders(providers: ChainMap<TypedProvider>): void;
+}
+//# sourceMappingURL=MultiProtocolProvider.d.ts.map