@hyperlane-xyz/sdk 1.3.8 → 1.4.0

package/dist/metadata/agentConfig.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"agentConfig.js","sourceRoot":"","sources":["../../src/metadata/agentConfig.ts"],"names":[],"mappings":";;;AAAA,6BAAwB;AAMxB,+DAG+B;AAE/B;;GAEG;AAEH,IAAY,mBAKX;AALD,WAAY,mBAAmB;IAC7B,oCAAa,CAAA;IACb,gCAAS,CAAA;IACT,gDAAyB,CAAA;IACzB,oDAA6B,CAAA;AAC/B,CAAC,EALW,mBAAmB,GAAnB,2BAAmB,KAAnB,2BAAmB,QAK9B;AAEY,QAAA,sBAAsB,GAAG,OAAC,CAAC,MAAM,CAAC;IAC7C,gBAAgB,EAAE,OAAC;SAChB,UAAU,CAAC,mBAAmB,CAAC;SAC/B,OAAO,CAAC,mBAAmB,CAAC,YAAY,CAAC;SACzC,QAAQ,CACP,iWAAiW,CAClW;IACH,eAAe,EAAE,OAAC;SACf,MAAM,EAAE;SACR,QAAQ,EAAE;SACV,QAAQ,CACP,gSAAgS,CACjS;IACH,KAAK,EAAE,OAAC,CAAC,MAAM,CAAC;QACd,IAAI,EAAE,OAAC;aACJ,MAAM,EAAE;aACR,OAAO,CAAC,IAAI,CAAC;aACb,QAAQ,EAAE;aACV,QAAQ,CAAC,gDAAgD,CAAC;QAC7D,KAAK,EAAE,OAAC;aACL,MAAM,EAAE;aACR,OAAO,CAAC,IAAI,CAAC;aACb,QAAQ,EAAE;aACV,QAAQ,CAAC,0CAA0C,CAAC;KACxD,CAAC;CACH,CAAC,CAAC;AAIU,QAAA,2BAA2B,GACtC,sDAAgC,CAAC,KAAK,CAAC,8BAAsB,CAAC,CAAC;AAIjE,SAAgB,gBAAgB,CAC9B,MAAmB,EACnB,aAA4B,EAC5B,SAAiD,EACjD,WAA6B;IAE7B,MAAM,OAAO,GAAoC,EAAE,CAAC;IACpD,KAAK,MAAM,KAAK,IAAI,CAAC,GAAG,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE;QACtC,MAAM,QAAQ,GAAG,aAAa,CAAC,gBAAgB,CAAC,KAAK,CAAC,CAAC;QACvD,MAAM,MAAM,mCACP,QAAQ,KACX,gBAAgB,EAAE,mBAAmB,CAAC,YAAY,EAClD,OAAO,EAAE,SAAS,CAAC,KAAK,CAAC,CAAC,OAAO,EACjC,sBAAsB,EAAE,SAAS,CAAC,KAAK,CAAC,CAAC,sBAAsB,EAC/D,iBAAiB,EAAE,SAAS,CAAC,KAAK,CAAC,CAAC,iBAAiB,EACrD,KAAK,EAAE;gBACL,IAAI,EAAE,WAAW,CAAC,KAAK,CAAC;aACzB,GACF,CAAC;QACF,OAAO,CAAC,KAAK,CAAC,GAAG,MAAM,CAAC;KACzB;IACD,OAAO,OAAO,CAAC;AACjB,CAAC;AAtBD,4CAsBC;AA0CD,SAAgB,0BAA0B,CACxC,MAAmB,EACnB,aAA4B,EAC5B,SAAiD,EACjD,WAA6B;;IAE7B,MAAM,WAAW,GAAgB;QAC/B,MAAM,EAAE,EAAE;KACX,CAAC;IAEF,KAAK,MAAM,KAAK,IAAI,CAAC,GAAG,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE;QACtC,MAAM,QAAQ,GAAG,aAAa,CAAC,gBAAgB,CAAC,KAAK,CAAC,CAAC;QACvD,MAAM,WAAW,GAAwB;YACvC,IAAI,EAAE,KAAK;YACX,MAAM,EAAE,QAAQ,CAAC,OAAO;YACxB,SAAS,EAAE;gBACT,OAAO,EAAE,SAAS,CAAC,KAAK,CAAC,CAAC,OAAO;gBACjC,sBAAsB,EAAE,SAAS,CAAC,KAAK,CAAC,CAAC,sBAAsB;gBAC/D,iBAAiB,EAAE,SAAS,CAAC,KAAK,CAAC,CAAC,iBAAiB;aACtD;YACD,QAAQ,EAAE,QAAQ,CAAC,QAAQ;YAC3B,cAAc,EAAE,MAAA,MAAA,QAAQ,CAAC,MAAM,0CAAE,WAAW,mCAAI,CAAC;SAClD,CAAC;QAEF,WAAW,CAAC,KAAK,GAAG;YAClB,IAAI,EAAE,WAAW,CAAC,KAAK,CAAC;SACzB,CAAC;QAEF,WAAW,CAAC,MAAM,CAAC,KAAK,CAAC,GAAG,WAAW,CAAC;KACzC;IACD,OAAO,WAAW,CAAC;AACrB,CAAC;AA/BD,gEA+BC"}

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

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

package/dist/metadata/chainMetadata.test.js

@@ -0,0 +1,43 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const chai_1 = require("chai");
+const chainMetadataTypes_1 = require("./chainMetadataTypes");
+const minimalSchema = {
+    chainId: 5,
+    domainId: 5,
+    name: 'goerli',
+    protocol: chainMetadataTypes_1.ProtocolType.Ethereum,
+    rpcUrls: [{ http: 'https://foobar.com' }],
+};
+const blockExplorers = [
+    {
+        name: 'scan',
+        url: 'https://foobar.com',
+        apiUrl: 'https://api.foobar.com',
+    },
+];
+const blocks = {
+    confirmations: 1,
+    estimateBlockTime: 10,
+};
+describe('ChainMetadataSchema', () => {
+    it('Accepts valid schemas', () => {
+        (0, chai_1.expect)((0, chainMetadataTypes_1.isValidChainMetadata)(minimalSchema)).to.eq(true);
+        (0, chai_1.expect)((0, chainMetadataTypes_1.isValidChainMetadata)(Object.assign(Object.assign({}, minimalSchema), { blockExplorers }))).to.eq(true);
+        (0, chai_1.expect)((0, chainMetadataTypes_1.isValidChainMetadata)(Object.assign(Object.assign({}, minimalSchema), { blockExplorers }))).to.eq(true);
+        (0, chai_1.expect)((0, chainMetadataTypes_1.isValidChainMetadata)(Object.assign(Object.assign({}, minimalSchema), { blockExplorers,
+            blocks }))).to.eq(true);
+    });
+    it('Rejects invalid schemas', () => {
+        (0, chai_1.expect)(
+        //@ts-ignore
+        (0, chainMetadataTypes_1.isValidChainMetadata)({})).to.eq(false);
+        //@ts-ignore
+        (0, chai_1.expect)((0, chainMetadataTypes_1.isValidChainMetadata)(Object.assign(Object.assign({}, minimalSchema), { chainId: 'id' }))).to.eq(false);
+        (0, chai_1.expect)((0, chainMetadataTypes_1.isValidChainMetadata)(Object.assign(Object.assign({}, minimalSchema), { blockExplorers: [
+                Object.assign(Object.assign({}, blockExplorers[0]), { apiUrl: 'not-a-url' }),
+            ] }))).to.eq(false);
+        (0, chai_1.expect)((0, chainMetadataTypes_1.isValidChainMetadata)(Object.assign(Object.assign({}, minimalSchema), { name: 'Invalid name' }))).to.eq(false);
+    });
+});
+//# sourceMappingURL=chainMetadata.test.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"chainMetadata.test.js","sourceRoot":"","sources":["../../src/metadata/chainMetadata.test.ts"],"names":[],"mappings":";;AAAA,+BAA8B;AAE9B,6DAI8B;AAE9B,MAAM,aAAa,GAAkB;IACnC,OAAO,EAAE,CAAC;IACV,QAAQ,EAAE,CAAC;IACX,IAAI,EAAE,QAAQ;IACd,QAAQ,EAAE,iCAAY,CAAC,QAAQ;IAC/B,OAAO,EAAE,CAAC,EAAE,IAAI,EAAE,oBAAoB,EAAE,CAAC;CAC1C,CAAC;AAEF,MAAM,cAAc,GAAG;IACrB;QACE,IAAI,EAAE,MAAM;QACZ,GAAG,EAAE,oBAAoB;QACzB,MAAM,EAAE,wBAAwB;KACjC;CACF,CAAC;AAEF,MAAM,MAAM,GAAG;IACb,aAAa,EAAE,CAAC;IAChB,iBAAiB,EAAE,EAAE;CACtB,CAAC;AAEF,QAAQ,CAAC,qBAAqB,EAAE,GAAG,EAAE;IACnC,EAAE,CAAC,uBAAuB,EAAE,GAAG,EAAE;QAC/B,IAAA,aAAM,EAAC,IAAA,yCAAoB,EAAC,aAAa,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC;QAExD,IAAA,aAAM,EACJ,IAAA,yCAAoB,kCACf,aAAa,KAChB,cAAc,IACd,CACH,CAAC,EAAE,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC;QAEd,IAAA,aAAM,EACJ,IAAA,yCAAoB,kCACf,aAAa,KAChB,cAAc,IACd,CACH,CAAC,EAAE,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC;QAEd,IAAA,aAAM,EACJ,IAAA,yCAAoB,kCACf,aAAa,KAChB,cAAc;YACd,MAAM,IACN,CACH,CAAC,EAAE,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC;IAChB,CAAC,CAAC,CAAC;IACH,EAAE,CAAC,yBAAyB,EAAE,GAAG,EAAE;QACjC,IAAA,aAAM;QACJ,YAAY;QACZ,IAAA,yCAAoB,EAAC,EAAE,CAAC,CACzB,CAAC,EAAE,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC;QAEf,YAAY;QACZ,IAAA,aAAM,EAAC,IAAA,yCAAoB,kCAAM,aAAa,KAAE,OAAO,EAAE,IAAI,IAAG,CAAC,CAAC,EAAE,CAAC,EAAE,CACrE,KAAK,CACN,CAAC;QAEF,IAAA,aAAM,EACJ,IAAA,yCAAoB,kCACf,aAAa,KAChB,cAAc,EAAE;gDAET,cAAc,CAAC,CAAC,CAAC,KACpB,MAAM,EAAE,WAAW;aAEtB,IACD,CACH,CAAC,EAAE,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC;QAEf,IAAA,aAAM,EACJ,IAAA,yCAAoB,kCACf,aAAa,KAChB,IAAI,EAAE,cAAc,IACpB,CACH,CAAC,EAAE,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC;IACjB,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}

package/dist/metadata/chainMetadataTypes.d.ts

@@ -0,0 +1,242 @@
+import { z } from 'zod';
+export declare enum ProtocolType {
+    Ethereum = "ethereum",
+    Sealevel = "sealevel",
+    Fuel = "fuel"
+}
+export declare type ProtocolTypeValue = `${ProtocolType}`;
+export declare const ProtocolSmallestUnit: {
+    ethereum: string;
+    sealevel: string;
+};
+export declare enum ExplorerFamily {
+    Etherscan = "etherscan",
+    Blockscout = "blockscout",
+    Other = "other"
+}
+export declare type ExplorerFamilyValue = `${ExplorerFamily}`;
+/**
+ * A collection of useful properties and settings for chains using Hyperlane
+ * Specified as a Zod schema
+ */
+export declare const ChainMetadataSchema: z.ZodObject<{
+    protocol: z.ZodNativeEnum<typeof ProtocolType>;
+    chainId: z.ZodNumber;
+    domainId: z.ZodOptional<z.ZodNumber>;
+    name: z.ZodString;
+    displayName: z.ZodOptional<z.ZodString>;
+    displayNameShort: z.ZodOptional<z.ZodString>;
+    logoURI: z.ZodOptional<z.ZodString>;
+    nativeToken: z.ZodOptional<z.ZodObject<{
+        name: z.ZodString;
+        symbol: z.ZodString;
+        decimals: z.ZodNumber;
+    }, "strip", z.ZodTypeAny, {
+        symbol: string;
+        name: string;
+        decimals: number;
+    }, {
+        symbol: string;
+        name: string;
+        decimals: number;
+    }>>;
+    rpcUrls: z.ZodArray<z.ZodObject<{
+        http: z.ZodString;
+        webSocket: z.ZodOptional<z.ZodString>;
+        pagination: z.ZodOptional<z.ZodObject<{
+            maxBlockRange: z.ZodOptional<z.ZodNumber>;
+            minBlockNumber: z.ZodOptional<z.ZodNumber>;
+            maxBlockAge: z.ZodOptional<z.ZodNumber>;
+        }, "strip", z.ZodTypeAny, {
+            maxBlockRange?: number | undefined;
+            minBlockNumber?: number | undefined;
+            maxBlockAge?: number | undefined;
+        }, {
+            maxBlockRange?: number | undefined;
+            minBlockNumber?: number | undefined;
+            maxBlockAge?: number | undefined;
+        }>>;
+        retry: z.ZodOptional<z.ZodObject<{
+            maxRequests: z.ZodNumber;
+            baseRetryMs: z.ZodNumber;
+        }, "strip", z.ZodTypeAny, {
+            maxRequests: number;
+            baseRetryMs: number;
+        }, {
+            maxRequests: number;
+            baseRetryMs: number;
+        }>>;
+    }, "strip", z.ZodTypeAny, {
+        http: string;
+        webSocket?: string | undefined;
+        pagination?: {
+            maxBlockRange?: number | undefined;
+            minBlockNumber?: number | undefined;
+            maxBlockAge?: number | undefined;
+        } | undefined;
+        retry?: {
+            maxRequests: number;
+            baseRetryMs: number;
+        } | undefined;
+    }, {
+        http: string;
+        webSocket?: string | undefined;
+        pagination?: {
+            maxBlockRange?: number | undefined;
+            minBlockNumber?: number | undefined;
+            maxBlockAge?: number | undefined;
+        } | undefined;
+        retry?: {
+            maxRequests: number;
+            baseRetryMs: number;
+        } | undefined;
+    }>, "atleastone">;
+    blockExplorers: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        name: z.ZodString;
+        url: z.ZodString;
+        apiUrl: z.ZodString;
+        apiKey: z.ZodOptional<z.ZodString>;
+        family: z.ZodOptional<z.ZodNativeEnum<typeof ExplorerFamily>>;
+    }, "strip", z.ZodTypeAny, {
+        url: string;
+        name: string;
+        apiUrl: string;
+        apiKey?: string | undefined;
+        family?: ExplorerFamily | undefined;
+    }, {
+        url: string;
+        name: string;
+        apiUrl: string;
+        apiKey?: string | undefined;
+        family?: ExplorerFamily | undefined;
+    }>, "many">>;
+    blocks: z.ZodOptional<z.ZodObject<{
+        confirmations: z.ZodNumber;
+        reorgPeriod: z.ZodOptional<z.ZodNumber>;
+        estimateBlockTime: z.ZodOptional<z.ZodNumber>;
+    }, "strip", z.ZodTypeAny, {
+        confirmations: number;
+        reorgPeriod?: number | undefined;
+        estimateBlockTime?: number | undefined;
+    }, {
+        confirmations: number;
+        reorgPeriod?: number | undefined;
+        estimateBlockTime?: number | undefined;
+    }>>;
+    transactionOverrides: z.ZodOptional<z.ZodObject<{}, "strip", z.ZodTypeAny, {}, {}>>;
+    gasCurrencyCoinGeckoId: z.ZodOptional<z.ZodString>;
+    gnosisSafeTransactionServiceUrl: z.ZodOptional<z.ZodString>;
+    isTestnet: z.ZodOptional<z.ZodBoolean>;
+}, "strip", z.ZodTypeAny, {
+    name: string;
+    chainId: number;
+    protocol: ProtocolType;
+    rpcUrls: [{
+        http: string;
+        webSocket?: string | undefined;
+        pagination?: {
+            maxBlockRange?: number | undefined;
+            minBlockNumber?: number | undefined;
+            maxBlockAge?: number | undefined;
+        } | undefined;
+        retry?: {
+            maxRequests: number;
+            baseRetryMs: number;
+        } | undefined;
+    }, ...{
+        http: string;
+        webSocket?: string | undefined;
+        pagination?: {
+            maxBlockRange?: number | undefined;
+            minBlockNumber?: number | undefined;
+            maxBlockAge?: number | undefined;
+        } | undefined;
+        retry?: {
+            maxRequests: number;
+            baseRetryMs: number;
+        } | undefined;
+    }[]];
+    domainId?: number | undefined;
+    displayName?: string | undefined;
+    displayNameShort?: string | undefined;
+    logoURI?: string | undefined;
+    nativeToken?: {
+        symbol: string;
+        name: string;
+        decimals: number;
+    } | undefined;
+    blockExplorers?: {
+        url: string;
+        name: string;
+        apiUrl: string;
+        apiKey?: string | undefined;
+        family?: ExplorerFamily | undefined;
+    }[] | undefined;
+    blocks?: {
+        confirmations: number;
+        reorgPeriod?: number | undefined;
+        estimateBlockTime?: number | undefined;
+    } | undefined;
+    transactionOverrides?: {} | undefined;
+    gasCurrencyCoinGeckoId?: string | undefined;
+    gnosisSafeTransactionServiceUrl?: string | undefined;
+    isTestnet?: boolean | undefined;
+}, {
+    name: string;
+    chainId: number;
+    protocol: ProtocolType;
+    rpcUrls: [{
+        http: string;
+        webSocket?: string | undefined;
+        pagination?: {
+            maxBlockRange?: number | undefined;
+            minBlockNumber?: number | undefined;
+            maxBlockAge?: number | undefined;
+        } | undefined;
+        retry?: {
+            maxRequests: number;
+            baseRetryMs: number;
+        } | undefined;
+    }, ...{
+        http: string;
+        webSocket?: string | undefined;
+        pagination?: {
+            maxBlockRange?: number | undefined;
+            minBlockNumber?: number | undefined;
+            maxBlockAge?: number | undefined;
+        } | undefined;
+        retry?: {
+            maxRequests: number;
+            baseRetryMs: number;
+        } | undefined;
+    }[]];
+    domainId?: number | undefined;
+    displayName?: string | undefined;
+    displayNameShort?: string | undefined;
+    logoURI?: string | undefined;
+    nativeToken?: {
+        symbol: string;
+        name: string;
+        decimals: number;
+    } | undefined;
+    blockExplorers?: {
+        url: string;
+        name: string;
+        apiUrl: string;
+        apiKey?: string | undefined;
+        family?: ExplorerFamily | undefined;
+    }[] | undefined;
+    blocks?: {
+        confirmations: number;
+        reorgPeriod?: number | undefined;
+        estimateBlockTime?: number | undefined;
+    } | undefined;
+    transactionOverrides?: {} | undefined;
+    gasCurrencyCoinGeckoId?: string | undefined;
+    gnosisSafeTransactionServiceUrl?: string | undefined;
+    isTestnet?: boolean | undefined;
+}>;
+export declare type ChainMetadata = z.infer<typeof ChainMetadataSchema>;
+export declare function isValidChainMetadata(c: ChainMetadata): boolean;
+export declare function getDomainId(chainMetadata: ChainMetadata): number;
+//# sourceMappingURL=chainMetadataTypes.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"chainMetadataTypes.d.ts","sourceRoot":"","sources":["../../src/metadata/chainMetadataTypes.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,oBAAY,YAAY;IACtB,QAAQ,aAAa;IACrB,QAAQ,aAAa;IACrB,IAAI,SAAS;CACd;AAED,oBAAY,iBAAiB,GAAG,GAAG,YAAY,EAAE,CAAC;AAElD,eAAO,MAAM,oBAAoB;;;CAGhC,CAAC;AAEF,oBAAY,cAAc;IACxB,SAAS,cAAc;IACvB,UAAU,eAAe;IACzB,KAAK,UAAU;CAChB;AAED,oBAAY,mBAAmB,GAAG,GAAG,cAAc,EAAE,CAAC;AAEtD;;;GAGG;AACH,eAAO,MAAM,mBAAmB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAyK9B,CAAC;AAEH,oBAAY,aAAa,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,mBAAmB,CAAC,CAAC;AAEhE,wBAAgB,oBAAoB,CAAC,CAAC,EAAE,aAAa,GAAG,OAAO,CAE9D;AAED,wBAAgB,WAAW,CAAC,aAAa,EAAE,aAAa,GAAG,MAAM,CAEhE"}

package/dist/metadata/chainMetadataTypes.js

@@ -0,0 +1,170 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getDomainId = exports.isValidChainMetadata = exports.ChainMetadataSchema = exports.ExplorerFamily = exports.ProtocolSmallestUnit = exports.ProtocolType = void 0;
+const zod_1 = require("zod");
+var ProtocolType;
+(function (ProtocolType) {
+    ProtocolType["Ethereum"] = "ethereum";
+    ProtocolType["Sealevel"] = "sealevel";
+    ProtocolType["Fuel"] = "fuel";
+})(ProtocolType = exports.ProtocolType || (exports.ProtocolType = {}));
+exports.ProtocolSmallestUnit = {
+    [ProtocolType.Ethereum]: 'wei',
+    [ProtocolType.Sealevel]: 'lamports',
+};
+var ExplorerFamily;
+(function (ExplorerFamily) {
+    ExplorerFamily["Etherscan"] = "etherscan";
+    ExplorerFamily["Blockscout"] = "blockscout";
+    ExplorerFamily["Other"] = "other";
+})(ExplorerFamily = exports.ExplorerFamily || (exports.ExplorerFamily = {}));
+/**
+ * A collection of useful properties and settings for chains using Hyperlane
+ * Specified as a Zod schema
+ */
+exports.ChainMetadataSchema = zod_1.z.object({
+    protocol: zod_1.z
+        .nativeEnum(ProtocolType)
+        .describe('The type of protocol used by this chain. See ProtocolType for valid values.'),
+    chainId: zod_1.z
+        .number()
+        .positive()
+        .describe(`The chainId of the chain. Uses EIP-155 for EVM chains`),
+    domainId: zod_1.z
+        .number()
+        .positive()
+        .optional()
+        .describe('The domainId of the chain, should generally default to `chainId`. Consumer of `ChainMetadata` should use this value if present, but otherwise fallback to `chainId`.'),
+    name: zod_1.z
+        .string()
+        .regex(/^[a-z]+[a-z0-9]*$/)
+        .describe('The unique string identifier of the chain, used as the key in ChainMap dictionaries.'),
+    displayName: zod_1.z
+        .string()
+        .optional()
+        .describe('Human-readable name of the chain.'),
+    displayNameShort: zod_1.z
+        .string()
+        .optional()
+        .describe('A shorter human-readable name of the chain for use in user interfaces.'),
+    logoURI: zod_1.z
+        .string()
+        .optional()
+        .describe('A URI to a logo image for this chain for use in user interfaces.'),
+    nativeToken: zod_1.z
+        .object({
+        name: zod_1.z.string(),
+        symbol: zod_1.z.string(),
+        decimals: zod_1.z.number().nonnegative(),
+    })
+        .optional()
+        .describe('The metadata of the native token of the chain (e.g. ETH for Ethereum).'),
+    rpcUrls: zod_1.z
+        .array(zod_1.z.object({
+        http: zod_1.z
+            .string()
+            .url()
+            .describe('The HTTP URL of the RPC endpoint (preferably HTTPS).'),
+        webSocket: zod_1.z
+            .string()
+            .optional()
+            .describe('The WSS URL if the endpoint also supports websockets.'),
+        pagination: zod_1.z
+            .object({
+            maxBlockRange: zod_1.z
+                .number()
+                .positive()
+                .optional()
+                .describe('The maximum range between block numbers for which the RPC can query data'),
+            minBlockNumber: zod_1.z
+                .number()
+                .positive()
+                .optional()
+                .describe('The absolute minimum block number that this RPC supports.'),
+            maxBlockAge: zod_1.z
+                .number()
+                .positive()
+                .optional()
+                .describe('The relative different from latest block that this RPC supports.'),
+        })
+            .optional()
+            .describe('Limitations on the block range/age that can be queried.'),
+        retry: zod_1.z
+            .object({
+            maxRequests: zod_1.z
+                .number()
+                .positive()
+                .describe('The maximum number of requests to attempt before failing.'),
+            baseRetryMs: zod_1.z
+                .number()
+                .positive()
+                .describe('The base retry delay in milliseconds.'),
+        })
+            .optional()
+            .describe('Default retry settings to be used by a provider such as MultiProvider.'),
+    }))
+        .nonempty()
+        .describe('The list of RPC endpoints for interacting with the chain.'),
+    blockExplorers: zod_1.z
+        .array(zod_1.z.object({
+        name: zod_1.z.string().describe('A human readable name for the explorer.'),
+        url: zod_1.z.string().url().describe('The base URL for the explorer.'),
+        apiUrl: zod_1.z
+            .string()
+            .url()
+            .describe('The base URL for requests to the explorer API.'),
+        apiKey: zod_1.z
+            .string()
+            .optional()
+            .describe('An API key for the explorer (recommended for better reliability).'),
+        family: zod_1.z
+            .nativeEnum(ExplorerFamily)
+            .optional()
+            .describe('The type of the block explorer. See ExplorerFamily for valid values.'),
+    }))
+        .optional()
+        .describe('A list of block explorers with data for this chain'),
+    blocks: zod_1.z
+        .object({
+        confirmations: zod_1.z
+            .number()
+            .describe('Number of blocks to wait before considering a transaction confirmed.'),
+        reorgPeriod: zod_1.z
+            .number()
+            .optional()
+            .describe('Number of blocks before a transaction has a near-zero chance of reverting.'),
+        estimateBlockTime: zod_1.z
+            .number()
+            .positive()
+            .optional()
+            .describe('Rough estimate of time per block in seconds.'),
+    })
+        .optional()
+        .describe('Block settings for the chain/deployment.'),
+    transactionOverrides: zod_1.z
+        .object({})
+        .optional()
+        .describe('Properties to include when forming transaction requests.'),
+    gasCurrencyCoinGeckoId: zod_1.z
+        .string()
+        .optional()
+        .describe('The ID on CoinGecko of the token used for gas payments.'),
+    gnosisSafeTransactionServiceUrl: zod_1.z
+        .string()
+        .optional()
+        .describe('The URL of the gnosis safe transaction service.'),
+    isTestnet: zod_1.z
+        .boolean()
+        .optional()
+        .describe('Whether the chain is considered a testnet or a mainnet.'),
+});
+function isValidChainMetadata(c) {
+    return exports.ChainMetadataSchema.safeParse(c).success;
+}
+exports.isValidChainMetadata = isValidChainMetadata;
+function getDomainId(chainMetadata) {
+    var _a;
+    return (_a = chainMetadata.domainId) !== null && _a !== void 0 ? _a : chainMetadata.chainId;
+}
+exports.getDomainId = getDomainId;
+//# sourceMappingURL=chainMetadataTypes.js.map

package/dist/metadata/chainMetadataTypes.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"chainMetadataTypes.js","sourceRoot":"","sources":["../../src/metadata/chainMetadataTypes.ts"],"names":[],"mappings":";;;AAAA,6BAAwB;AAExB,IAAY,YAIX;AAJD,WAAY,YAAY;IACtB,qCAAqB,CAAA;IACrB,qCAAqB,CAAA;IACrB,6BAAa,CAAA;AACf,CAAC,EAJW,YAAY,GAAZ,oBAAY,KAAZ,oBAAY,QAIvB;AAIY,QAAA,oBAAoB,GAAG;IAClC,CAAC,YAAY,CAAC,QAAQ,CAAC,EAAE,KAAK;IAC9B,CAAC,YAAY,CAAC,QAAQ,CAAC,EAAE,UAAU;CACpC,CAAC;AAEF,IAAY,cAIX;AAJD,WAAY,cAAc;IACxB,yCAAuB,CAAA;IACvB,2CAAyB,CAAA;IACzB,iCAAe,CAAA;AACjB,CAAC,EAJW,cAAc,GAAd,sBAAc,KAAd,sBAAc,QAIzB;AAID;;;GAGG;AACU,QAAA,mBAAmB,GAAG,OAAC,CAAC,MAAM,CAAC;IAC1C,QAAQ,EAAE,OAAC;SACR,UAAU,CAAC,YAAY,CAAC;SACxB,QAAQ,CACP,6EAA6E,CAC9E;IACH,OAAO,EAAE,OAAC;SACP,MAAM,EAAE;SACR,QAAQ,EAAE;SACV,QAAQ,CAAC,uDAAuD,CAAC;IACpE,QAAQ,EAAE,OAAC;SACR,MAAM,EAAE;SACR,QAAQ,EAAE;SACV,QAAQ,EAAE;SACV,QAAQ,CACP,sKAAsK,CACvK;IACH,IAAI,EAAE,OAAC;SACJ,MAAM,EAAE;SACR,KAAK,CAAC,mBAAmB,CAAC;SAC1B,QAAQ,CACP,sFAAsF,CACvF;IACH,WAAW,EAAE,OAAC;SACX,MAAM,EAAE;SACR,QAAQ,EAAE;SACV,QAAQ,CAAC,mCAAmC,CAAC;IAChD,gBAAgB,EAAE,OAAC;SAChB,MAAM,EAAE;SACR,QAAQ,EAAE;SACV,QAAQ,CACP,wEAAwE,CACzE;IACH,OAAO,EAAE,OAAC;SACP,MAAM,EAAE;SACR,QAAQ,EAAE;SACV,QAAQ,CACP,kEAAkE,CACnE;IACH,WAAW,EAAE,OAAC;SACX,MAAM,CAAC;QACN,IAAI,EAAE,OAAC,CAAC,MAAM,EAAE;QAChB,MAAM,EAAE,OAAC,CAAC,MAAM,EAAE;QAClB,QAAQ,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,WAAW,EAAE;KACnC,CAAC;SACD,QAAQ,EAAE;SACV,QAAQ,CACP,wEAAwE,CACzE;IACH,OAAO,EAAE,OAAC;SACP,KAAK,CACJ,OAAC,CAAC,MAAM,CAAC;QACP,IAAI,EAAE,OAAC;aACJ,MAAM,EAAE;aACR,GAAG,EAAE;aACL,QAAQ,CAAC,sDAAsD,CAAC;QACnE,SAAS,EAAE,OAAC;aACT,MAAM,EAAE;aACR,QAAQ,EAAE;aACV,QAAQ,CAAC,uDAAuD,CAAC;QACpE,UAAU,EAAE,OAAC;aACV,MAAM,CAAC;YACN,aAAa,EAAE,OAAC;iBACb,MAAM,EAAE;iBACR,QAAQ,EAAE;iBACV,QAAQ,EAAE;iBACV,QAAQ,CACP,0EAA0E,CAC3E;YACH,cAAc,EAAE,OAAC;iBACd,MAAM,EAAE;iBACR,QAAQ,EAAE;iBACV,QAAQ,EAAE;iBACV,QAAQ,CACP,2DAA2D,CAC5D;YACH,WAAW,EAAE,OAAC;iBACX,MAAM,EAAE;iBACR,QAAQ,EAAE;iBACV,QAAQ,EAAE;iBACV,QAAQ,CACP,kEAAkE,CACnE;SACJ,CAAC;aACD,QAAQ,EAAE;aACV,QAAQ,CAAC,yDAAyD,CAAC;QACtE,KAAK,EAAE,OAAC;aACL,MAAM,CAAC;YACN,WAAW,EAAE,OAAC;iBACX,MAAM,EAAE;iBACR,QAAQ,EAAE;iBACV,QAAQ,CACP,2DAA2D,CAC5D;YACH,WAAW,EAAE,OAAC;iBACX,MAAM,EAAE;iBACR,QAAQ,EAAE;iBACV,QAAQ,CAAC,uCAAuC,CAAC;SACrD,CAAC;aACD,QAAQ,EAAE;aACV,QAAQ,CACP,wEAAwE,CACzE;KACJ,CAAC,CACH;SACA,QAAQ,EAAE;SACV,QAAQ,CAAC,2DAA2D,CAAC;IACxE,cAAc,EAAE,OAAC;SACd,KAAK,CACJ,OAAC,CAAC,MAAM,CAAC;QACP,IAAI,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,yCAAyC,CAAC;QACpE,GAAG,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,QAAQ,CAAC,gCAAgC,CAAC;QAChE,MAAM,EAAE,OAAC;aACN,MAAM,EAAE;aACR,GAAG,EAAE;aACL,QAAQ,CAAC,gDAAgD,CAAC;QAC7D,MAAM,EAAE,OAAC;aACN,MAAM,EAAE;aACR,QAAQ,EAAE;aACV,QAAQ,CACP,mEAAmE,CACpE;QACH,MAAM,EAAE,OAAC;aACN,UAAU,CAAC,cAAc,CAAC;aAC1B,QAAQ,EAAE;aACV,QAAQ,CACP,sEAAsE,CACvE;KACJ,CAAC,CACH;SACA,QAAQ,EAAE;SACV,QAAQ,CAAC,oDAAoD,CAAC;IACjE,MAAM,EAAE,OAAC;SACN,MAAM,CAAC;QACN,aAAa,EAAE,OAAC;aACb,MAAM,EAAE;aACR,QAAQ,CACP,sEAAsE,CACvE;QACH,WAAW,EAAE,OAAC;aACX,MAAM,EAAE;aACR,QAAQ,EAAE;aACV,QAAQ,CACP,4EAA4E,CAC7E;QACH,iBAAiB,EAAE,OAAC;aACjB,MAAM,EAAE;aACR,QAAQ,EAAE;aACV,QAAQ,EAAE;aACV,QAAQ,CAAC,8CAA8C,CAAC;KAC5D,CAAC;SACD,QAAQ,EAAE;SACV,QAAQ,CAAC,0CAA0C,CAAC;IACvD,oBAAoB,EAAE,OAAC;SACpB,MAAM,CAAC,EAAE,CAAC;SACV,QAAQ,EAAE;SACV,QAAQ,CAAC,0DAA0D,CAAC;IACvE,sBAAsB,EAAE,OAAC;SACtB,MAAM,EAAE;SACR,QAAQ,EAAE;SACV,QAAQ,CAAC,yDAAyD,CAAC;IACtE,+BAA+B,EAAE,OAAC;SAC/B,MAAM,EAAE;SACR,QAAQ,EAAE;SACV,QAAQ,CAAC,iDAAiD,CAAC;IAC9D,SAAS,EAAE,OAAC;SACT,OAAO,EAAE;SACT,QAAQ,EAAE;SACV,QAAQ,CAAC,yDAAyD,CAAC;CACvE,CAAC,CAAC;AAIH,SAAgB,oBAAoB,CAAC,CAAgB;IACnD,OAAO,2BAAmB,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC;AAClD,CAAC;AAFD,oDAEC;AAED,SAAgB,WAAW,CAAC,aAA4B;;IACtD,OAAO,MAAA,aAAa,CAAC,QAAQ,mCAAI,aAAa,CAAC,OAAO,CAAC;AACzD,CAAC;AAFD,kCAEC"}