@recoillink/sdk 0.0.0-stage → 45.0.1

package/dist/metadata/ChainMetadataManager.js

@@ -0,0 +1,424 @@
+import { assert, exclude, isEVMLike, pick, rootLogger, } from '@recoillink/utils';
+import { isEtherscanApiCompatibleFamily } from '../block-explorer/utils.js';
+import { getExplorerAddressUrl, getExplorerApi, getExplorerApiUrl, getExplorerBaseUrl, getExplorerTxUrl, } from './blockExplorer.js';
+import { ChainMetadataSchema, ExplorerFamily, getDomainId, } from './chainMetadataTypes.js';
+/**
+ * A set of utilities to manage chain metadata
+ * Validates metadata on construction and provides useful methods
+ * for interacting with the data
+ */
+export class ChainMetadataManager {
+    metadata = {};
+    logger;
+    static DEFAULT_MAX_BLOCK_RANGE = 1000;
+    /**
+     * Create a new ChainMetadataManager with the given chainMetadata,
+     * or the SDK's default metadata if not provided
+     */
+    constructor(chainMetadata, options = {}) {
+        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 =
+            options?.logger ||
+                rootLogger.child({
+                    module: 'MetadataManager',
+                });
+    }
+    /**
+     * Add a chain to the MultiProvider
+     * @throws if chain's name or domain ID collide
+     */
+    addChain(metadata) {
+        ChainMetadataSchema.parse(metadata);
+        // Ensure no two chains have overlapping names/domainIds
+        for (const chainMetadata of Object.values(this.metadata)) {
+            const { name, domainId } = chainMetadata;
+            if (name == metadata.name)
+                throw new Error(`Duplicate chain name: ${name}`);
+            // Domain Ids should be globally unique
+            const idCollision = metadata.domainId && domainId == metadata.domainId;
+            if (idCollision)
+                throw new Error(`Domain id collision: ${name} and ${metadata.name}`);
+        }
+        this.metadata[metadata.name] = metadata;
+    }
+    /**
+     * Get the metadata for a given chain name or domain id
+     * @throws if chain's metadata has not been set
+     */
+    tryGetChainMetadata(chainNameOrId) {
+        // First check if it's a chain name
+        if (this.metadata[chainNameOrId])
+            return this.metadata[chainNameOrId];
+        // Otherwise search by domain id
+        const chainMetadata = Object.values(this.metadata).find((m) => m.domainId == chainNameOrId);
+        return chainMetadata || null;
+    }
+    /**
+     * Get the metadata for a given chain name 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;
+    }
+    getMaxBlockRange(chainNameOrId) {
+        const metadata = this.getChainMetadata(chainNameOrId);
+        return Math.max(...metadata.rpcUrls.map(({ pagination }) => pagination?.maxBlockRange ??
+            ChainMetadataManager.DEFAULT_MAX_BLOCK_RANGE));
+    }
+    /**
+     * Returns true if the given chain name or domain id is
+     * included in this manager's metadata, false otherwise
+     */
+    hasChain(chainNameOrId) {
+        return !!this.tryGetChainMetadata(chainNameOrId);
+    }
+    /**
+     * Get the name for a given chain name or domain id
+     */
+    tryGetChainName(chainNameOrId) {
+        return this.tryGetChainMetadata(chainNameOrId)?.name ?? null;
+    }
+    /**
+     * Get the name for a given chain name 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 or domain id
+     */
+    tryGetChainId(chainNameOrId) {
+        return this.tryGetChainMetadata(chainNameOrId)?.chainId ?? null;
+    }
+    /**
+     * Get the id for a given chain name or domain id
+     * @throws if chain's metadata has not been set
+     */
+    getChainId(chainNameOrId) {
+        return this.getChainMetadata(chainNameOrId).chainId;
+    }
+    /**
+     * Get the id for a given EVM chain name or domain id
+     * Returns null if chain's metadata has not been set or is not an EVM chain
+     */
+    tryGetEvmChainId(chainNameOrId) {
+        const metadata = this.tryGetChainMetadata(chainNameOrId);
+        if (!metadata)
+            return null;
+        if (!isEVMLike(metadata.protocol))
+            return null;
+        if (typeof metadata.chainId !== 'number')
+            return null;
+        return metadata.chainId;
+    }
+    /**
+     * Get the id for a given EVM chain name or domain id
+     * @throws if chain's metadata has not been set
+     */
+    getEvmChainId(chainNameOrId) {
+        const { protocol, chainId } = this.getChainMetadata(chainNameOrId);
+        if (!isEVMLike(protocol)) {
+            throw new Error(`Chain is not an EVM chain: ${chainNameOrId}`);
+        }
+        if (typeof chainId !== 'number') {
+            throw new Error(`Chain ID is not a number: ${chainId}`);
+        }
+        return chainId;
+    }
+    /**
+     * Get the domain id for a given chain name or domain id
+     */
+    tryGetDomainId(chainNameOrId) {
+        const metadata = this.tryGetChainMetadata(chainNameOrId);
+        if (!metadata)
+            return null;
+        return getDomainId(metadata) ?? null;
+    }
+    /**
+     * Get the domain id for a given chain name or domain id
+     * @throws if chain's metadata has not been set
+     */
+    getDomainId(chainNameOrId) {
+        const domainId = this.tryGetDomainId(chainNameOrId);
+        if (!domainId)
+            throw new Error(`No domain id set for ${chainNameOrId}`);
+        return domainId;
+    }
+    /**
+     * Get the protocol type for a given chain name or domain id
+     */
+    tryGetProtocol(chainNameOrId) {
+        return this.tryGetChainMetadata(chainNameOrId)?.protocol ?? null;
+    }
+    /**
+     * Get the protocol type for a given chain name or domain id
+     * @throws if chain's metadata or protocol has not been set
+     */
+    getProtocol(chainNameOrId) {
+        return this.getChainMetadata(chainNameOrId).protocol;
+    }
+    /**
+     * Get the domain ids for a list of chain names 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((chainName) => this.getDomainId(chainName));
+    }
+    /**
+     * Get chain names excluding given chain name
+     */
+    getRemoteChains(name) {
+        return 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 the RPC details for a given chain name or domain id.
+     * Optional index for metadata containing more than one RPC.
+     * @throws if chain's metadata has not been set
+     */
+    getRpc(chainNameOrId, index = 0) {
+        const { rpcUrls } = this.getChainMetadata(chainNameOrId);
+        if (!rpcUrls?.length || !rpcUrls[index])
+            throw new Error(`No RPC configured at index ${index} for ${chainNameOrId}`);
+        return rpcUrls[index];
+    }
+    /**
+     * Get an RPC URL for a given chain name or domain id
+     * @throws if chain's metadata has not been set
+     */
+    getRpcUrl(chainNameOrId, index = 0) {
+        const { http } = this.getRpc(chainNameOrId, index);
+        if (!http)
+            throw new Error(`No RPC URL configured for ${chainNameOrId}`);
+        return http;
+    }
+    /**
+     * Get an RPC concurrency level for a given chain name or domain id
+     */
+    tryGetRpcConcurrency(chainNameOrId, index = 0) {
+        const { concurrency } = this.getRpc(chainNameOrId, index);
+        return concurrency ?? null;
+    }
+    /**
+     * Get a block explorer URL for a given chain name or domain id
+     */
+    tryGetExplorerUrl(chainNameOrId) {
+        const metadata = this.tryGetChainMetadata(chainNameOrId);
+        if (!metadata)
+            return null;
+        return getExplorerBaseUrl(metadata);
+    }
+    /**
+     * Get a block explorer URL for a given chain name 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 for a given chain name or domain id
+     */
+    tryGetExplorerApi(chainNameOrId) {
+        const metadata = this.tryGetChainMetadata(chainNameOrId);
+        if (!metadata)
+            return null;
+        return getExplorerApi(metadata);
+    }
+    /**
+     * Get a block explorer API for a given chain name or domain id
+     * @throws if chain's metadata or block explorer data has no been set
+     */
+    getExplorerApi(chainNameOrId) {
+        const explorerApi = this.tryGetExplorerApi(chainNameOrId);
+        if (!explorerApi)
+            throw new Error(`No supported explorer api set for ${chainNameOrId}`);
+        return explorerApi;
+    }
+    /**
+     * Get a block explorer's API URL for a given chain name or domain id
+     */
+    tryGetExplorerApiUrl(chainNameOrId) {
+        const metadata = this.tryGetChainMetadata(chainNameOrId);
+        if (!metadata)
+            return null;
+        return getExplorerApiUrl(metadata);
+    }
+    /**
+     * Get a block explorer API URL for a given chain name 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 metadata = this.tryGetChainMetadata(chainNameOrId);
+        if (!metadata)
+            return null;
+        return getExplorerTxUrl(metadata, response.hash);
+    }
+    /**
+     * 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}`;
+    }
+    /**
+     * Get a block explorer URL for given chain's address
+     */
+    async tryGetExplorerAddressUrl(chainNameOrId, address) {
+        const metadata = this.tryGetChainMetadata(chainNameOrId);
+        if (!metadata || !address)
+            return null;
+        return getExplorerAddressUrl(metadata, address);
+    }
+    /**
+     * Get a block explorer URL for given chain's address
+     * @throws if address or the chain's block explorer data has no been set
+     */
+    async getExplorerAddressUrl(chainNameOrId, address) {
+        const url = await this.tryGetExplorerAddressUrl(chainNameOrId, address);
+        if (!url)
+            throw new Error(`Missing data for address url for ${chainNameOrId}`);
+        return url;
+    }
+    /**
+     * Get a block explorer metadata for given chain
+     * @returns null if there isn't an explorer configured correctly for using the API (missing api key...)
+     */
+    tryGetEvmExplorerMetadata(chainNameOrId) {
+        return this.tryGetEvmExplorerMetadataList(chainNameOrId)[0] ?? null;
+    }
+    /**
+     * Get every configured Etherscan-compatible explorer API in registry order.
+     * Etherscan APIs require a key; compatible alternatives do not necessarily.
+     */
+    tryGetEvmExplorerMetadataList(chainNameOrId) {
+        const chainMetadata = this.tryGetChainMetadata(chainNameOrId);
+        if (!chainMetadata)
+            return [];
+        return (chainMetadata.blockExplorers ?? []).flatMap((_, index) => {
+            const explorer = getExplorerApi(chainMetadata, index);
+            if (!explorer)
+                return [];
+            const hasRequiredApiKey = explorer.family !== ExplorerFamily.Etherscan || !!explorer.apiKey;
+            return isEtherscanApiCompatibleFamily(explorer.family) &&
+                hasRequiredApiKey
+                ? [explorer]
+                : [];
+        });
+    }
+    /**
+     * Get a block explorer metadata for given chain
+     * @throws if there isn't an explorer configured correctly for using the API (missing api key...)
+     */
+    getEvmExplorerMetadata(chainNameOrId) {
+        const explorer = this.tryGetEvmExplorerMetadata(chainNameOrId);
+        assert(explorer, `No explorer was configured correctly to make requests to the API for chain "${chainNameOrId}". Set an API key or configure an explorer API that does not require one`);
+        return explorer;
+    }
+    /**
+     * Get native token for given chain
+     * @throws if native token has not been set
+     */
+    async getNativeToken(chainNameOrId) {
+        const metadata = this.tryGetChainMetadata(chainNameOrId);
+        if (!metadata || !metadata.nativeToken) {
+            throw new Error(`Missing data for native token for ${chainNameOrId}`);
+        }
+        return metadata.nativeToken;
+    }
+    /**
+     * 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)) {
+            newMetadata[name] = { ...meta, ...additionalMetadata[name] };
+        }
+        return new ChainMetadataManager(newMetadata);
+    }
+    /**
+     * Create a new instance from the intersection
+     * of current's chains and the provided chain list
+     */
+    intersect(chains, throwIfNotSubset = false) {
+        const knownChains = this.getKnownChainNames();
+        const intersection = [];
+        for (const chain of chains) {
+            if (knownChains.includes(chain))
+                intersection.push(chain);
+            else if (throwIfNotSubset)
+                throw new Error(`Known chains does not include ${chain}`);
+        }
+        if (!intersection.length) {
+            throw new Error(`No chains shared between known chains and list (${knownChains} and ${chains})`);
+        }
+        const intersectionMetadata = pick(this.metadata, intersection);
+        const result = new ChainMetadataManager(intersectionMetadata);
+        return { intersection, result };
+    }
+    isLocalRpc(chain) {
+        const metadata = this.tryGetChainMetadata(chain);
+        const rpcUrl = metadata?.rpcUrls[0]?.http;
+        return rpcUrl?.includes('localhost') || rpcUrl?.includes('127.0.0.1');
+    }
+}
+/**
+ * Creates a ChainLookup object from a ChainMetadataManager instance
+ * for use with AltVM modules.
+ *
+ * @param chainMetadataManager - The ChainMetadataManager instance
+ * @returns A ChainLookup object containing chain metadata lookup functions
+ */
+export function altVmChainLookup(chainMetadataManager) {
+    return {
+        getChainMetadata: (chain) => chainMetadataManager.getChainMetadata(chain),
+        getChainName: (domainId) => chainMetadataManager.tryGetChainName(domainId),
+        getDomainId: (chain) => chainMetadataManager.tryGetDomainId(chain),
+        getKnownChainNames: () => chainMetadataManager.getKnownChainNames(),
+        getKnownDomainIds: () => new Set(chainMetadataManager.getKnownDomainIds()),
+    };
+}
+//# 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":"AAEA,OAAO,EAGL,MAAM,EACN,OAAO,EACP,SAAS,EACT,IAAI,EACJ,UAAU,GACX,MAAM,mBAAmB,CAAC;AAE3B,OAAO,EAAE,8BAA8B,EAAE,MAAM,4BAA4B,CAAC;AAG5E,OAAO,EACL,qBAAqB,EACrB,cAAc,EACd,iBAAiB,EACjB,kBAAkB,EAClB,gBAAgB,GACjB,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EAEL,mBAAmB,EACnB,cAAc,EACd,WAAW,GACZ,MAAM,yBAAyB,CAAC;AAMjC;;;;GAIG;AACH,MAAM,OAAO,oBAAoB;IACf,QAAQ,GAAqC,EAAE,CAAC;IAChD,MAAM,CAAS;IAC/B,MAAM,CAAU,uBAAuB,GAAG,IAAI,CAAC;IAE/C;;;OAGG;IACH,YACE,aAA+C,EAC/C,OAAO,GAAgC,EAAE;QAEzC,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;YACT,OAAO,EAAE,MAAM;gBACf,UAAU,CAAC,KAAK,CAAC;oBACf,MAAM,EAAE,iBAAiB;iBAC1B,CAAC,CAAC;IACP,CAAC;IAED;;;OAGG;IACH,QAAQ,CAAC,QAAgC;QACvC,mBAAmB,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;QACpC,wDAAwD;QACxD,KAAK,MAAM,aAAa,IAAI,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC;YACzD,MAAM,EAAE,IAAI,EAAE,QAAQ,EAAE,GAAG,aAAa,CAAC;YACzC,IAAI,IAAI,IAAI,QAAQ,CAAC,IAAI;gBACvB,MAAM,IAAI,KAAK,CAAC,yBAAyB,IAAI,EAAE,CAAC,CAAC;YACnD,uCAAuC;YACvC,MAAM,WAAW,GAAG,QAAQ,CAAC,QAAQ,IAAI,QAAQ,IAAI,QAAQ,CAAC,QAAQ,CAAC;YACvE,IAAI,WAAW;gBACb,MAAM,IAAI,KAAK,CAAC,wBAAwB,IAAI,QAAQ,QAAQ,CAAC,IAAI,EAAE,CAAC,CAAC;QACzE,CAAC;QACD,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,IAAI,CAAC,GAAG,QAAQ,CAAC;IAC1C,CAAC;IAED;;;OAGG;IACH,mBAAmB,CACjB,aAA4B;QAE5B,mCAAmC;QACnC,IAAI,IAAI,CAAC,QAAQ,CAAC,aAAa,CAAC;YAAE,OAAO,IAAI,CAAC,QAAQ,CAAC,aAAa,CAAC,CAAC;QACtE,gCAAgC;QAChC,MAAM,aAAa,GAAG,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,IAAI,CACrD,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,QAAQ,IAAI,aAAa,CACnC,CAAC;QACF,OAAO,aAAa,IAAI,IAAI,CAAC;IAC/B,CAAC;IAED;;;OAGG;IACH,gBAAgB,CAAC,aAA4B;QAC3C,MAAM,aAAa,GAAG,IAAI,CAAC,mBAAmB,CAAC,aAAa,CAAC,CAAC;QAC9D,IAAI,CAAC,aAAa,EAAE,CAAC;YACnB,MAAM,IAAI,KAAK,CAAC,6BAA6B,aAAa,EAAE,CAAC,CAAC;QAChE,CAAC;QACD,OAAO,aAAa,CAAC;IACvB,CAAC;IAED,gBAAgB,CAAC,aAA4B;QAC3C,MAAM,QAAQ,GAAG,IAAI,CAAC,gBAAgB,CAAC,aAAa,CAAC,CAAC;QACtD,OAAO,IAAI,CAAC,GAAG,CACb,GAAG,QAAQ,CAAC,OAAO,CAAC,GAAG,CACrB,CAAC,EAAE,UAAU,EAAE,EAAE,EAAE,CACjB,UAAU,EAAE,aAAa;YACzB,oBAAoB,CAAC,uBAAuB,CAC/C,CACF,CAAC;IACJ,CAAC;IAED;;;OAGG;IACH,QAAQ,CAAC,aAA4B;QACnC,OAAO,CAAC,CAAC,IAAI,CAAC,mBAAmB,CAAC,aAAa,CAAC,CAAC;IACnD,CAAC;IAED;;OAEG;IACH,eAAe,CAAC,aAA4B;QAC1C,OAAO,IAAI,CAAC,mBAAmB,CAAC,aAAa,CAAC,EAAE,IAAI,IAAI,IAAI,CAAC;IAC/D,CAAC;IAED;;;OAGG;IACH,YAAY,CAAC,aAA4B;QACvC,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,aAA4B;QACxC,OAAO,IAAI,CAAC,mBAAmB,CAAC,aAAa,CAAC,EAAE,OAAO,IAAI,IAAI,CAAC;IAClE,CAAC;IAED;;;OAGG;IACH,UAAU,CAAC,aAA4B;QACrC,OAAO,IAAI,CAAC,gBAAgB,CAAC,aAAa,CAAC,CAAC,OAAO,CAAC;IACtD,CAAC;IAED;;;OAGG;IACH,gBAAgB,CAAC,aAA4B;QAC3C,MAAM,QAAQ,GAAG,IAAI,CAAC,mBAAmB,CAAC,aAAa,CAAC,CAAC;QACzD,IAAI,CAAC,QAAQ;YAAE,OAAO,IAAI,CAAC;QAC3B,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,QAAQ,CAAC;YAAE,OAAO,IAAI,CAAC;QAC/C,IAAI,OAAO,QAAQ,CAAC,OAAO,KAAK,QAAQ;YAAE,OAAO,IAAI,CAAC;QACtD,OAAO,QAAQ,CAAC,OAAO,CAAC;IAC1B,CAAC;IAED;;;OAGG;IACH,aAAa,CAAC,aAA4B;QACxC,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,IAAI,CAAC,gBAAgB,CAAC,aAAa,CAAC,CAAC;QACnE,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,EAAE,CAAC;YACzB,MAAM,IAAI,KAAK,CAAC,8BAA8B,aAAa,EAAE,CAAC,CAAC;QACjE,CAAC;QACD,IAAI,OAAO,OAAO,KAAK,QAAQ,EAAE,CAAC;YAChC,MAAM,IAAI,KAAK,CAAC,6BAA6B,OAAO,EAAE,CAAC,CAAC;QAC1D,CAAC;QACD,OAAO,OAAO,CAAC;IACjB,CAAC;IAED;;OAEG;IACH,cAAc,CAAC,aAA4B;QACzC,MAAM,QAAQ,GAAG,IAAI,CAAC,mBAAmB,CAAC,aAAa,CAAC,CAAC;QACzD,IAAI,CAAC,QAAQ;YAAE,OAAO,IAAI,CAAC;QAC3B,OAAO,WAAW,CAAC,QAAQ,CAAC,IAAI,IAAI,CAAC;IACvC,CAAC;IAED;;;OAGG;IACH,WAAW,CAAC,aAA4B;QACtC,MAAM,QAAQ,GAAG,IAAI,CAAC,cAAc,CAAC,aAAa,CAAC,CAAC;QACpD,IAAI,CAAC,QAAQ;YAAE,MAAM,IAAI,KAAK,CAAC,wBAAwB,aAAa,EAAE,CAAC,CAAC;QACxE,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED;;OAEG;IACH,cAAc,CAAC,aAA4B;QACzC,OAAO,IAAI,CAAC,mBAAmB,CAAC,aAAa,CAAC,EAAE,QAAQ,IAAI,IAAI,CAAC;IACnE,CAAC;IAED;;;OAGG;IACH,WAAW,CAAC,aAA4B;QACtC,OAAO,IAAI,CAAC,gBAAgB,CAAC,aAAa,CAAC,CAAC,QAAQ,CAAC;IACvD,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,CAAC,SAAS,EAAE,EAAE,CACjD,IAAI,CAAC,WAAW,CAAC,SAAS,CAAC,CAC5B,CAAC;IACJ,CAAC;IAED;;OAEG;IACH,eAAe,CAAC,IAAe;QAC7B,OAAO,OAAO,CAAC,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,CAAC;YAC9C,MAAM,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC,KAAK,CAAC,CAAC;QAC5B,CAAC;QACD,OAAO,MAAM,CAAC;IAChB,CAAC;IAED;;;;OAIG;IACH,MAAM,CACJ,aAA4B,EAC5B,KAAK,GAAG,CAAC;QAET,MAAM,EAAE,OAAO,EAAE,GAAG,IAAI,CAAC,gBAAgB,CAAC,aAAa,CAAC,CAAC;QACzD,IAAI,CAAC,OAAO,EAAE,MAAM,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC;YACrC,MAAM,IAAI,KAAK,CACb,8BAA8B,KAAK,QAAQ,aAAa,EAAE,CAC3D,CAAC;QACJ,OAAO,OAAO,CAAC,KAAK,CAAC,CAAC;IACxB,CAAC;IAED;;;OAGG;IACH,SAAS,CAAC,aAA4B,EAAE,KAAK,GAAG,CAAC;QAC/C,MAAM,EAAE,IAAI,EAAE,GAAG,IAAI,CAAC,MAAM,CAAC,aAAa,EAAE,KAAK,CAAC,CAAC;QACnD,IAAI,CAAC,IAAI;YAAE,MAAM,IAAI,KAAK,CAAC,6BAA6B,aAAa,EAAE,CAAC,CAAC;QACzE,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;OAEG;IACH,oBAAoB,CAAC,aAA4B,EAAE,KAAK,GAAG,CAAC;QAC1D,MAAM,EAAE,WAAW,EAAE,GAAG,IAAI,CAAC,MAAM,CAAC,aAAa,EAAE,KAAK,CAAC,CAAC;QAC1D,OAAO,WAAW,IAAI,IAAI,CAAC;IAC7B,CAAC;IAED;;OAEG;IACH,iBAAiB,CAAC,aAA4B;QAC5C,MAAM,QAAQ,GAAG,IAAI,CAAC,mBAAmB,CAAC,aAAa,CAAC,CAAC;QACzD,IAAI,CAAC,QAAQ;YAAE,OAAO,IAAI,CAAC;QAC3B,OAAO,kBAAkB,CAAC,QAAQ,CAAC,CAAC;IACtC,CAAC;IAED;;;OAGG;IACH,cAAc,CAAC,aAA4B;QACzC,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,iBAAiB,CAAC,aAAiC;QAKjD,MAAM,QAAQ,GAAG,IAAI,CAAC,mBAAmB,CAAC,aAAa,CAAC,CAAC;QACzD,IAAI,CAAC,QAAQ;YAAE,OAAO,IAAI,CAAC;QAC3B,OAAO,cAAc,CAAC,QAAQ,CAAC,CAAC;IAClC,CAAC;IAED;;;OAGG;IACH,cAAc,CAAC,aAAiC;QAK9C,MAAM,WAAW,GAAG,IAAI,CAAC,iBAAiB,CAAC,aAAa,CAAC,CAAC;QAC1D,IAAI,CAAC,WAAW;YACd,MAAM,IAAI,KAAK,CAAC,qCAAqC,aAAa,EAAE,CAAC,CAAC;QACxE,OAAO,WAAW,CAAC;IACrB,CAAC;IAED;;OAEG;IACH,oBAAoB,CAAC,aAA4B;QAC/C,MAAM,QAAQ,GAAG,IAAI,CAAC,mBAAmB,CAAC,aAAa,CAAC,CAAC;QACzD,IAAI,CAAC,QAAQ;YAAE,OAAO,IAAI,CAAC;QAC3B,OAAO,iBAAiB,CAAC,QAAQ,CAAC,CAAC;IACrC,CAAC;IAED;;;OAGG;IACH,iBAAiB,CAAC,aAA4B;QAC5C,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,aAA4B,EAC5B,QAA0B;QAE1B,MAAM,QAAQ,GAAG,IAAI,CAAC,mBAAmB,CAAC,aAAa,CAAC,CAAC;QACzD,IAAI,CAAC,QAAQ;YAAE,OAAO,IAAI,CAAC;QAC3B,OAAO,gBAAgB,CAAC,QAAQ,EAAE,QAAQ,CAAC,IAAI,CAAC,CAAC;IACnD,CAAC;IAED;;;OAGG;IACH,gBAAgB,CACd,aAA4B,EAC5B,QAA0B;QAE1B,OAAO,GAAG,IAAI,CAAC,cAAc,CAAC,aAAa,CAAC,OAAO,QAAQ,CAAC,IAAI,EAAE,CAAC;IACrE,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,wBAAwB,CAC5B,aAA4B,EAC5B,OAAgB;QAEhB,MAAM,QAAQ,GAAG,IAAI,CAAC,mBAAmB,CAAC,aAAa,CAAC,CAAC;QACzD,IAAI,CAAC,QAAQ,IAAI,CAAC,OAAO;YAAE,OAAO,IAAI,CAAC;QACvC,OAAO,qBAAqB,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;IAClD,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,qBAAqB,CACzB,aAA4B,EAC5B,OAAgB;QAEhB,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,wBAAwB,CAAC,aAAa,EAAE,OAAO,CAAC,CAAC;QACxE,IAAI,CAAC,GAAG;YACN,MAAM,IAAI,KAAK,CAAC,oCAAoC,aAAa,EAAE,CAAC,CAAC;QACvE,OAAO,GAAG,CAAC;IACb,CAAC;IAED;;;OAGG;IACH,yBAAyB,CACvB,aAA4B;QAE5B,OAAO,IAAI,CAAC,6BAA6B,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,IAAI,IAAI,CAAC;IACtE,CAAC;IAED;;;OAGG;IACH,6BAA6B,CAC3B,aAA4B;QAE5B,MAAM,aAAa,GAAG,IAAI,CAAC,mBAAmB,CAAC,aAAa,CAAC,CAAC;QAC9D,IAAI,CAAC,aAAa;YAAE,OAAO,EAAE,CAAC;QAE9B,OAAO,CAAC,aAAa,CAAC,cAAc,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,EAAE;YAC/D,MAAM,QAAQ,GAAG,cAAc,CAAC,aAAa,EAAE,KAAK,CAAC,CAAC;YACtD,IAAI,CAAC,QAAQ;gBAAE,OAAO,EAAE,CAAC;YAEzB,MAAM,iBAAiB,GACrB,QAAQ,CAAC,MAAM,KAAK,cAAc,CAAC,SAAS,IAAI,CAAC,CAAC,QAAQ,CAAC,MAAM,CAAC;YACpE,OAAO,8BAA8B,CAAC,QAAQ,CAAC,MAAM,CAAC;gBACpD,iBAAiB;gBACjB,CAAC,CAAC,CAAC,QAAQ,CAAC;gBACZ,CAAC,CAAC,EAAE,CAAC;QACT,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;;OAGG;IACH,sBAAsB,CACpB,aAA4B;QAE5B,MAAM,QAAQ,GAAG,IAAI,CAAC,yBAAyB,CAAC,aAAa,CAAC,CAAC;QAC/D,MAAM,CACJ,QAAQ,EACR,+EAA+E,aAAa,0EAA0E,CACvK,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IACD;;;OAGG;IACH,KAAK,CAAC,cAAc,CAClB,aAA4B;QAE5B,MAAM,QAAQ,GAAG,IAAI,CAAC,mBAAmB,CAAC,aAAa,CAAC,CAAC;QACzD,IAAI,CAAC,QAAQ,IAAI,CAAC,QAAQ,CAAC,WAAW,EAAE,CAAC;YACvC,MAAM,IAAI,KAAK,CAAC,qCAAqC,aAAa,EAAE,CAAC,CAAC;QACxE,CAAC;QACD,OAAO,QAAQ,CAAC,WAAW,CAAC;IAC9B,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,CAAC;YACzD,WAAW,CAAC,IAAI,CAAC,GAAG,EAAE,GAAG,IAAI,EAAE,GAAG,kBAAkB,CAAC,IAAI,CAAC,EAAE,CAAC;QAC/D,CAAC;QACD,OAAO,IAAI,oBAAoB,CAAC,WAAW,CAAC,CAAC;IAC/C,CAAC;IAED;;;OAGG;IACH,SAAS,CACP,MAAmB,EACnB,gBAAgB,GAAG,KAAK;QAKxB,MAAM,WAAW,GAAG,IAAI,CAAC,kBAAkB,EAAE,CAAC;QAC9C,MAAM,YAAY,GAAgB,EAAE,CAAC;QAErC,KAAK,MAAM,KAAK,IAAI,MAAM,EAAE,CAAC;YAC3B,IAAI,WAAW,CAAC,QAAQ,CAAC,KAAK,CAAC;gBAAE,YAAY,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;iBACrD,IAAI,gBAAgB;gBACvB,MAAM,IAAI,KAAK,CAAC,iCAAiC,KAAK,EAAE,CAAC,CAAC;QAC9D,CAAC;QAED,IAAI,CAAC,YAAY,CAAC,MAAM,EAAE,CAAC;YACzB,MAAM,IAAI,KAAK,CACb,mDAAmD,WAAW,QAAQ,MAAM,GAAG,CAChF,CAAC;QACJ,CAAC;QAED,MAAM,oBAAoB,GAAG,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,YAAY,CAAC,CAAC;QAC/D,MAAM,MAAM,GAAG,IAAI,oBAAoB,CAAC,oBAAoB,CAAC,CAAC;QAE9D,OAAO,EAAE,YAAY,EAAE,MAAM,EAAE,CAAC;IAClC,CAAC;IAED,UAAU,CAAC,KAAgB;QACzB,MAAM,QAAQ,GAAG,IAAI,CAAC,mBAAmB,CAAC,KAAK,CAAC,CAAC;QACjD,MAAM,MAAM,GAAG,QAAQ,EAAE,OAAO,CAAC,CAAC,CAAC,EAAE,IAAI,CAAC;QAC1C,OAAO,MAAM,EAAE,QAAQ,CAAC,WAAW,CAAC,IAAI,MAAM,EAAE,QAAQ,CAAC,WAAW,CAAC,CAAC;IACxE,CAAC;CACF;AAED;;;;;;GAMG;AACH,MAAM,UAAU,gBAAgB,CAC9B,oBAAmD;IAEnD,OAAO;QACL,gBAAgB,EAAE,CAAC,KAAoB,EAAE,EAAE,CACzC,oBAAoB,CAAC,gBAAgB,CAAC,KAAK,CAAC;QAC9C,YAAY,EAAE,CAAC,QAAgB,EAAE,EAAE,CACjC,oBAAoB,CAAC,eAAe,CAAC,QAAQ,CAAC;QAChD,WAAW,EAAE,CAAC,KAAoB,EAAE,EAAE,CACpC,oBAAoB,CAAC,cAAc,CAAC,KAAK,CAAC;QAC5C,kBAAkB,EAAE,GAAG,EAAE,CAAC,oBAAoB,CAAC,kBAAkB,EAAE;QACnE,iBAAiB,EAAE,GAAG,EAAE,CAAC,IAAI,GAAG,CAAC,oBAAoB,CAAC,iBAAiB,EAAE,CAAC;KAC3E,CAAC;AACJ,CAAC"}

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

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

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

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

package/dist/metadata/ChainMetadataManager.test.js

@@ -0,0 +1,233 @@
+import { expect } from 'chai';
+import { ProtocolType } from '@recoillink/utils';
+import { ChainMetadataManager, altVmChainLookup, } from './ChainMetadataManager.js';
+import { ExplorerFamily, } from './chainMetadataTypes.js';
+describe(ChainMetadataManager.name, () => {
+    let manager;
+    const ethereumMetadata = {
+        chainId: 1,
+        domainId: 1,
+        name: 'ethereum',
+        protocol: ProtocolType.Ethereum,
+        rpcUrls: [{ http: 'https://ethereum.example.com' }],
+    };
+    const polygonMetadata = {
+        chainId: 137,
+        domainId: 137,
+        name: 'polygon',
+        protocol: ProtocolType.Ethereum,
+        rpcUrls: [{ http: 'https://polygon.example.com' }],
+    };
+    const cosmosMetadata = {
+        chainId: 'cosmoshub-4',
+        domainId: 118,
+        name: 'cosmos',
+        protocol: ProtocolType.Cosmos,
+        rpcUrls: [{ http: 'https://cosmos.example.com' }],
+        bech32Prefix: 'cosmos',
+        slip44: 118,
+        restUrls: [],
+        grpcUrls: [],
+    };
+    const solanaMetadata = {
+        chainId: 101,
+        domainId: 1399811149,
+        name: 'solana',
+        protocol: ProtocolType.Sealevel,
+        rpcUrls: [{ http: 'https://solana.example.com' }],
+    };
+    beforeEach(() => {
+        manager = new ChainMetadataManager({
+            ethereum: ethereumMetadata,
+            polygon: polygonMetadata,
+            cosmos: cosmosMetadata,
+            solana: solanaMetadata,
+        });
+    });
+    describe(ChainMetadataManager.prototype.tryGetChainMetadata.name, () => {
+        describe('basic functionality', () => {
+            const testCases = [
+                {
+                    description: 'valid chain name',
+                    input: 'ethereum',
+                    expected: ethereumMetadata,
+                },
+                {
+                    description: 'another valid chain name',
+                    input: 'polygon',
+                    expected: polygonMetadata,
+                },
+                {
+                    description: 'non-existent chain name',
+                    input: 'nonexistent',
+                    expected: null,
+                },
+                {
+                    description: 'valid domain ID',
+                    input: 1,
+                    expected: ethereumMetadata,
+                },
+                {
+                    description: 'another valid domain ID',
+                    input: 137,
+                    expected: polygonMetadata,
+                },
+                {
+                    description: 'non-existent domain ID',
+                    input: 99999,
+                    expected: null,
+                },
+            ];
+            testCases.forEach(({ description, input, expected }) => {
+                it(`should return correct result for ${description}`, () => {
+                    const result = manager.tryGetChainMetadata(input);
+                    expect(result).to.deep.equal(expected);
+                });
+            });
+        });
+        describe('different protocol types', () => {
+            const testCases = [
+                {
+                    description: 'Cosmos chain by name',
+                    input: 'cosmos',
+                    expected: cosmosMetadata,
+                },
+                {
+                    description: 'Cosmos chain by domain ID',
+                    input: 118,
+                    expected: cosmosMetadata,
+                },
+                {
+                    description: 'Sealevel chain by name',
+                    input: 'solana',
+                    expected: solanaMetadata,
+                },
+                {
+                    description: 'Sealevel chain by domain ID',
+                    input: 1399811149,
+                    expected: solanaMetadata,
+                },
+            ];
+            testCases.forEach(({ description, input, expected }) => {
+                it(`should handle ${description}`, () => {
+                    const result = manager.tryGetChainMetadata(input);
+                    expect(result).to.deep.equal(expected);
+                });
+            });
+        });
+    });
+    describe(ChainMetadataManager.prototype.tryGetEvmExplorerMetadata.name, () => {
+        const etherscanExplorer = {
+            name: 'Etherscan',
+            url: 'https://etherscan.example.com',
+            apiUrl: 'https://api.etherscan.example.com/api',
+            apiKey: 'test-key',
+            family: ExplorerFamily.Etherscan,
+        };
+        const etherscanNoKeyExplorer = {
+            name: 'Etherscan',
+            url: 'https://etherscan.example.com',
+            apiUrl: 'https://api.etherscan.example.com/api',
+            family: ExplorerFamily.Etherscan,
+        };
+        const blockscoutExplorer = {
+            name: 'Blockscout',
+            url: 'https://blockscout.example.com',
+            apiUrl: 'https://blockscout.example.com/api',
+            family: ExplorerFamily.Blockscout,
+        };
+        const tronScanExplorer = {
+            name: 'TronScan',
+            url: 'https://tronscan.example.com',
+            apiUrl: 'https://tronscan.example.com/#/api',
+            family: ExplorerFamily.TronScan,
+        };
+        const routescanExplorer = {
+            name: 'Routescan',
+            url: 'https://routescan.example.com',
+            apiUrl: 'https://routescan.example.com/api',
+            family: ExplorerFamily.Routescan,
+        };
+        const cases = [
+            {
+                description: 'TronScan default with no compatible fallback returns null',
+                blockExplorers: [tronScanExplorer],
+                expectedFamily: null,
+            },
+            {
+                description: 'Etherscan with an api key returns the explorer',
+                blockExplorers: [etherscanExplorer],
+                expectedFamily: ExplorerFamily.Etherscan,
+            },
+            {
+                description: 'Blockscout returns the explorer',
+                blockExplorers: [blockscoutExplorer],
+                expectedFamily: ExplorerFamily.Blockscout,
+            },
+            {
+                description: 'Etherscan without an api key falls back to Blockscout when present',
+                blockExplorers: [etherscanNoKeyExplorer, blockscoutExplorer],
+                expectedFamily: ExplorerFamily.Blockscout,
+            },
+        ];
+        for (const c of cases) {
+            it(c.description, () => {
+                const chainManager = new ChainMetadataManager({
+                    testchain: {
+                        chainId: 12345,
+                        domainId: 12345,
+                        name: 'testchain',
+                        protocol: ProtocolType.Ethereum,
+                        rpcUrls: [{ http: 'https://testchain.example.com' }],
+                        blockExplorers: c.blockExplorers,
+                    },
+                });
+                const result = chainManager.tryGetEvmExplorerMetadata('testchain');
+                if (c.expectedFamily === null) {
+                    expect(result).to.equal(null);
+                }
+                else {
+                    expect(result?.family).to.equal(c.expectedFamily);
+                }
+            });
+        }
+        it('returns all compatible explorers in registry order', () => {
+            const chainManager = new ChainMetadataManager({
+                testchain: {
+                    chainId: 12345,
+                    domainId: 12345,
+                    name: 'testchain',
+                    protocol: ProtocolType.Ethereum,
+                    rpcUrls: [{ http: 'https://testchain.example.com' }],
+                    blockExplorers: [
+                        tronScanExplorer,
+                        etherscanNoKeyExplorer,
+                        routescanExplorer,
+                        etherscanExplorer,
+                        blockscoutExplorer,
+                    ],
+                },
+            });
+            const result = chainManager.tryGetEvmExplorerMetadataList('testchain');
+            expect(result.map(({ family }) => family)).to.deep.equal([
+                ExplorerFamily.Routescan,
+                ExplorerFamily.Etherscan,
+                ExplorerFamily.Blockscout,
+            ]);
+        });
+    });
+    describe(altVmChainLookup.name, () => {
+        it('lists the domain id of every known chain', () => {
+            const lookup = altVmChainLookup(new ChainMetadataManager({
+                ethereum: ethereumMetadata,
+                solana: solanaMetadata,
+            }));
+            expect(lookup.getKnownChainNames()).to.have.members([
+                'ethereum',
+                'solana',
+            ]);
+            expect(lookup.getKnownDomainIds()).to.deep.equal(new Set([1, 1399811149]));
+        });
+    });
+});
+//# sourceMappingURL=ChainMetadataManager.test.js.map