@hyperlane-xyz/sdk 1.0.0-beta1 → 1.0.0-beta2

package/README.md

@@ -1,5 +1,32 @@
-# Hyperlane Application SDK
+# Hyperlane SDK
 
-The Hyperlane Application SDK help developers manage multichain Hyperlane applications. This requires a higher level API than dApp developers are familiar with which is namespaced by target chain.
+The Hyperlane SDK helps developers create and manage interchain applications.
 
-You can find the docs at https://docs.hyperlane.xyz/hyperlane-docs/developers/application-sdk
+For details on how to use the various abstractions and utilities, [see the documentation](https://docs.hyperlane.xyz/hyperlane-docs-1/developers/building-applications)
+
+## Install
+
+`yarn install @hyperlane-xyz/sdk`
+
+## Contents
+
+### Constants
+
+The names and relevant metadata for all Hyperlane-supported chains are included in this SDK, including public RPC and Explorer urls. It also includes the addresses for all Hyperlane core contracts and middleware.
+
+### Deployment, testing, and development classes
+
+Classes for deploying, testing, and building applications using Hyperlane are included in the SDK. See [the docs](https://docs.hyperlane.xyz/hyperlane-docs-1/developers/building-applications/nodejs-sdk) for details.
+
+### Chain Logos
+
+The SDK contains SVG files for all Hyperlane-supported chains. They can be imported from the `/logos` folder.
+
+```js
+import ArbitrumBlack from '@hyperlane-xyz/sdk/logos/black/arbitrum.svg';
+import ArbitrumColor from '@hyperlane-xyz/sdk/logos/color/arbitrum.svg';
+```
+
+## License
+
+Apache 2.0

package/dist/consts/chainConnectionConfigs.d.ts

@@ -1,27 +1,18 @@
+import { ethers } from 'ethers';
 import { ChainMap, ChainName, IChainConnection } from '../types';
-export declare const ethereum: IChainConnection;
-export declare const celo: IChainConnection;
-export declare const polygon: IChainConnection;
-export declare const avalanche: IChainConnection;
-export declare const arbitrum: IChainConnection;
-export declare const optimism: IChainConnection;
-export declare const bsc: IChainConnection;
-export declare const alfajores: IChainConnection;
-export declare const fuji: IChainConnection;
-export declare const goerli: IChainConnection;
-export declare const optimismgoerli: IChainConnection;
-export declare const arbitrumgoerli: IChainConnection;
-export declare const mumbai: IChainConnection;
-export declare const bsctestnet: IChainConnection;
-export declare const moonbasealpha: IChainConnection;
-export declare const moonbeam: IChainConnection;
-export declare const test1: IChainConnection;
-export declare const test2: IChainConnection;
-export declare const test3: IChainConnection;
 export declare const chainConnectionConfigs: ChainMap<ChainName, IChainConnection>;
 export declare const testChainConnectionConfigs: {
-    test1: IChainConnection;
-    test2: IChainConnection;
-    test3: IChainConnection;
+    test1: {
+        provider: ethers.providers.JsonRpcProvider;
+        confirmations: number;
+    };
+    test2: {
+        provider: ethers.providers.JsonRpcProvider;
+        confirmations: number;
+    };
+    test3: {
+        provider: ethers.providers.JsonRpcProvider;
+        confirmations: number;
+    };
 };
 //# sourceMappingURL=chainConnectionConfigs.d.ts.map

package/dist/consts/chainConnectionConfigs.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"chainConnectionConfigs.d.ts","sourceRoot":"","sources":["../../src/consts/chainConnectionConfigs.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,QAAQ,EAAE,SAAS,EAAE,gBAAgB,EAAE,MAAM,UAAU,CAAC;AAEjE,eAAO,MAAM,QAAQ,EAAE,gBAOtB,CAAC;AAEF,eAAO,MAAM,IAAI,EAAE,gBAIlB,CAAC;AAEF,eAAO,MAAM,OAAO,EAAE,gBAOrB,CAAC;AAEF,eAAO,MAAM,SAAS,EAAE,gBAOvB,CAAC;AAEF,eAAO,MAAM,QAAQ,EAAE,gBAOtB,CAAC;AAEF,eAAO,MAAM,QAAQ,EAAE,gBAQtB,CAAC;AAEF,eAAO,MAAM,GAAG,EAAE,gBAOjB,CAAC;AAEF,eAAO,MAAM,SAAS,EAAE,gBAQvB,CAAC;AAEF,eAAO,MAAM,IAAI,EAAE,gBAQlB,CAAC;AAEF,eAAO,MAAM,MAAM,EAAE,gBAQpB,CAAC;AAEF,eAAO,MAAM,cAAc,EAAE,gBAQ5B,CAAC;AAEF,eAAO,MAAM,cAAc,EAAE,gBAQ5B,CAAC;AAEF,eAAO,MAAM,MAAM,EAAE,gBAQpB,CAAC;AAEF,eAAO,MAAM,UAAU,EAAE,gBAQxB,CAAC;AAEF,eAAO,MAAM,aAAa,EAAE,gBAQ3B,CAAC;AAEF,eAAO,MAAM,QAAQ,EAAE,gBAQtB,CAAC;AAEF,eAAO,MAAM,KAAK,EAAE,gBAMnB,CAAC;AAEF,eAAO,MAAM,KAAK,EAAE,gBAMnB,CAAC;AAEF,eAAO,MAAM,KAAK,EAAE,gBAMnB,CAAC;AAEF,eAAO,MAAM,sBAAsB,EAAE,QAAQ,CAAC,SAAS,EAAE,gBAAgB,CAoBxE,CAAC;AAEF,eAAO,MAAM,0BAA0B;;;;CAItC,CAAC"}
+{"version":3,"file":"chainConnectionConfigs.d.ts","sourceRoot":"","sources":["../../src/consts/chainConnectionConfigs.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AAIhC,OAAO,EAAE,QAAQ,EAAE,SAAS,EAAE,gBAAgB,EAAE,MAAM,UAAU,CAAC;AAgBjE,eAAO,MAAM,sBAAsB,EAAE,QAAQ,CAAC,SAAS,EAAE,gBAAgB,CAerE,CAAC;AAEL,eAAO,MAAM,0BAA0B;;;;;;;;;;;;;CAItC,CAAC"}

package/dist/consts/chainConnectionConfigs.js

@@ -1,134 +1,33 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.testChainConnectionConfigs = exports.chainConnectionConfigs = exports.test3 = exports.test2 = exports.test1 = exports.moonbeam = exports.moonbasealpha = exports.bsctestnet = exports.mumbai = exports.arbitrumgoerli = exports.optimismgoerli = exports.goerli = exports.fuji = exports.alfajores = exports.bsc = exports.optimism = exports.arbitrum = exports.avalanche = exports.polygon = exports.celo = exports.ethereum = void 0;
+exports.testChainConnectionConfigs = exports.chainConnectionConfigs = void 0;
 const ethers_1 = require("ethers");
 const celo_ethers_provider_1 = require("@hyperlane-xyz/celo-ethers-provider");
-exports.ethereum = {
-    provider: new ethers_1.ethers.providers.JsonRpcProvider('https://cloudflare-eth.com', 1),
-    confirmations: 7,
-    blockExplorerUrl: 'https://etherscan.io',
-};
-exports.celo = {
-    provider: new celo_ethers_provider_1.StaticCeloJsonRpcProvider('https://forno.celo.org', 42220),
-    confirmations: 1,
-    blockExplorerUrl: 'https://celoscan.io',
-};
-exports.polygon = {
-    provider: new ethers_1.ethers.providers.JsonRpcProvider('https://rpc-mainnet.matic.quiknode.pro', 137),
-    confirmations: 200,
-    blockExplorerUrl: 'https://polygonscan.com',
-};
-exports.avalanche = {
-    provider: new ethers_1.ethers.providers.JsonRpcProvider('https://api.avax.network/ext/bc/C/rpc', 43114),
-    confirmations: 3,
-    blockExplorerUrl: 'https://snowtrace.io',
-};
-exports.arbitrum = {
-    provider: new ethers_1.ethers.providers.JsonRpcProvider('https://arb1.arbitrum.io/rpc', 42161),
-    confirmations: 1,
-    blockExplorerUrl: 'https://arbiscan.io',
-};
-exports.optimism = {
-    provider: new ethers_1.ethers.providers.JsonRpcProvider('https://mainnet.optimism.io', 10),
-    confirmations: 1,
-    blockExplorerUrl: 'https://optimistic.etherscan.io',
-    apiPrefix: 'api-',
-};
-exports.bsc = {
-    provider: new ethers_1.ethers.providers.JsonRpcProvider('https://rpc.ankr.com/bsc', 56),
-    confirmations: 1,
-    blockExplorerUrl: 'https://bscscan.com',
-};
-exports.alfajores = {
-    provider: new celo_ethers_provider_1.StaticCeloJsonRpcProvider('https://alfajores-forno.celo-testnet.org', 44787),
-    confirmations: 1,
-    blockExplorerUrl: 'https://alfajores.celoscan.io',
-    apiPrefix: 'api-',
-};
-exports.fuji = {
-    provider: new ethers_1.ethers.providers.JsonRpcProvider('https://api.avax-test.network/ext/bc/C/rpc', 43113),
-    confirmations: 3,
-    blockExplorerUrl: 'https://testnet.snowtrace.io',
-    apiPrefix: 'api-',
-};
-exports.goerli = {
-    provider: new ethers_1.ethers.providers.JsonRpcProvider('https://rpc.ankr.com/eth_goerli', 5),
-    confirmations: 1,
-    blockExplorerUrl: 'https://goerli.etherscan.io/',
-    apiPrefix: 'api-',
-};
-exports.optimismgoerli = {
-    provider: new ethers_1.ethers.providers.JsonRpcProvider('https://goerli.optimism.io', 420),
-    confirmations: 1,
-    blockExplorerUrl: 'https://goerli-optimism.etherscan.io/',
-    apiPrefix: 'api-',
-};
-exports.arbitrumgoerli = {
-    provider: new ethers_1.ethers.providers.JsonRpcProvider('https://goerli-rollup.arbitrum.io/rpc	', 421613),
-    confirmations: 1,
-    blockExplorerUrl: 'https://goerli.arbiscan.io',
-    apiPrefix: 'api-',
-};
-exports.mumbai = {
-    provider: new ethers_1.ethers.providers.JsonRpcProvider('https://rpc-mumbai.maticvigil.com', 80001),
-    confirmations: 30,
-    blockExplorerUrl: 'https://mumbai.polygonscan.com',
-    apiPrefix: 'api-',
-};
-exports.bsctestnet = {
-    provider: new ethers_1.ethers.providers.JsonRpcProvider('https://data-seed-prebsc-1-s3.binance.org:8545', 97),
-    confirmations: 1,
-    blockExplorerUrl: 'https://testnet.bscscan.com',
-    apiPrefix: 'api-',
-};
-exports.moonbasealpha = {
-    provider: new ethers_1.ethers.providers.JsonRpcProvider('https://rpc.api.moonbase.moonbeam.network', 1287),
-    confirmations: 1,
-    blockExplorerUrl: 'https://moonbase.moonscan.io',
-    apiPrefix: 'api-',
-};
-exports.moonbeam = {
-    provider: new ethers_1.ethers.providers.JsonRpcProvider('https://rpc.api.moonbeam.network', 1284),
-    confirmations: 1,
-    blockExplorerUrl: 'https://moonscan.io',
-    apiPrefix: 'api-moonbeam.',
-};
-exports.test1 = {
-    provider: new ethers_1.ethers.providers.JsonRpcProvider('http://localhost:8545', 31337),
-    confirmations: 1,
-};
-exports.test2 = {
-    provider: new ethers_1.ethers.providers.JsonRpcProvider('http://localhost:8545', 31337),
-    confirmations: 1,
-};
-exports.test3 = {
-    provider: new ethers_1.ethers.providers.JsonRpcProvider('http://localhost:8545', 31337),
-    confirmations: 1,
-};
-exports.chainConnectionConfigs = {
-    arbitrum: exports.arbitrum,
-    bsc: exports.bsc,
-    ethereum: exports.ethereum,
-    celo: exports.celo,
-    polygon: exports.polygon,
-    avalanche: exports.avalanche,
-    alfajores: exports.alfajores,
-    fuji: exports.fuji,
-    goerli: exports.goerli,
-    mumbai: exports.mumbai,
-    bsctestnet: exports.bsctestnet,
-    optimism: exports.optimism,
-    moonbasealpha: exports.moonbasealpha,
-    moonbeam: exports.moonbeam,
-    optimismgoerli: exports.optimismgoerli,
-    arbitrumgoerli: exports.arbitrumgoerli,
-    test1: exports.test1,
-    test2: exports.test2,
-    test3: exports.test3,
-};
+const objects_1 = require("../utils/objects");
+const chainMetadata_1 = require("./chainMetadata");
+const chains_1 = require("./chains");
+function testChainConnection() {
+    return {
+        provider: new ethers_1.ethers.providers.JsonRpcProvider('http://localhost:8545', 31337),
+        confirmations: 1,
+    };
+}
+exports.chainConnectionConfigs = (0, objects_1.objMap)(chainMetadata_1.chainMetadata, (chainName, metadata) => {
+    if (chains_1.TestChains.includes(chainName))
+        return testChainConnection();
+    const providerClass = chainName === chains_1.Chains.alfajores || chainName === chains_1.Chains.celo
+        ? celo_ethers_provider_1.StaticCeloJsonRpcProvider
+        : ethers_1.ethers.providers.JsonRpcProvider;
+    return {
+        provider: new providerClass(metadata.publicRpcUrls[0].http, metadata.id),
+        confirmations: metadata.blocks.confirmations,
+        blockExplorerUrl: metadata.blockExplorers[0].url,
+        blockExplorerApiUrl: metadata.blockExplorers[0].apiUrl,
+    };
+});
 exports.testChainConnectionConfigs = {
-    test1: exports.test1,
-    test2: exports.test2,
-    test3: exports.test3,
+    test1: testChainConnection(),
+    test2: testChainConnection(),
+    test3: testChainConnection(),
 };
 //# sourceMappingURL=chainConnectionConfigs.js.map

package/dist/consts/chainConnectionConfigs.js.map

@@ -1 +1 @@
-{"version":3,"file":"chainConnectionConfigs.js","sourceRoot":"","sources":["../../src/consts/chainConnectionConfigs.ts"],"names":[],"mappings":";;;AAAA,mCAAgC;AAEhC,8EAAgF;AAInE,QAAA,QAAQ,GAAqB;IACxC,QAAQ,EAAE,IAAI,eAAM,CAAC,SAAS,CAAC,eAAe,CAC5C,4BAA4B,EAC5B,CAAC,CACF;IACD,aAAa,EAAE,CAAC;IAChB,gBAAgB,EAAE,sBAAsB;CACzC,CAAC;AAEW,QAAA,IAAI,GAAqB;IACpC,QAAQ,EAAE,IAAI,gDAAyB,CAAC,wBAAwB,EAAE,KAAK,CAAC;IACxE,aAAa,EAAE,CAAC;IAChB,gBAAgB,EAAE,qBAAqB;CACxC,CAAC;AAEW,QAAA,OAAO,GAAqB;IACvC,QAAQ,EAAE,IAAI,eAAM,CAAC,SAAS,CAAC,eAAe,CAC5C,wCAAwC,EACxC,GAAG,CACJ;IACD,aAAa,EAAE,GAAG;IAClB,gBAAgB,EAAE,yBAAyB;CAC5C,CAAC;AAEW,QAAA,SAAS,GAAqB;IACzC,QAAQ,EAAE,IAAI,eAAM,CAAC,SAAS,CAAC,eAAe,CAC5C,uCAAuC,EACvC,KAAK,CACN;IACD,aAAa,EAAE,CAAC;IAChB,gBAAgB,EAAE,sBAAsB;CACzC,CAAC;AAEW,QAAA,QAAQ,GAAqB;IACxC,QAAQ,EAAE,IAAI,eAAM,CAAC,SAAS,CAAC,eAAe,CAC5C,8BAA8B,EAC9B,KAAK,CACN;IACD,aAAa,EAAE,CAAC;IAChB,gBAAgB,EAAE,qBAAqB;CACxC,CAAC;AAEW,QAAA,QAAQ,GAAqB;IACxC,QAAQ,EAAE,IAAI,eAAM,CAAC,SAAS,CAAC,eAAe,CAC5C,6BAA6B,EAC7B,EAAE,CACH;IACD,aAAa,EAAE,CAAC;IAChB,gBAAgB,EAAE,iCAAiC;IACnD,SAAS,EAAE,MAAM;CAClB,CAAC;AAEW,QAAA,GAAG,GAAqB;IACnC,QAAQ,EAAE,IAAI,eAAM,CAAC,SAAS,CAAC,eAAe,CAC5C,0BAA0B,EAC1B,EAAE,CACH;IACD,aAAa,EAAE,CAAC;IAChB,gBAAgB,EAAE,qBAAqB;CACxC,CAAC;AAEW,QAAA,SAAS,GAAqB;IACzC,QAAQ,EAAE,IAAI,gDAAyB,CACrC,0CAA0C,EAC1C,KAAK,CACN;IACD,aAAa,EAAE,CAAC;IAChB,gBAAgB,EAAE,+BAA+B;IACjD,SAAS,EAAE,MAAM;CAClB,CAAC;AAEW,QAAA,IAAI,GAAqB;IACpC,QAAQ,EAAE,IAAI,eAAM,CAAC,SAAS,CAAC,eAAe,CAC5C,4CAA4C,EAC5C,KAAK,CACN;IACD,aAAa,EAAE,CAAC;IAChB,gBAAgB,EAAE,8BAA8B;IAChD,SAAS,EAAE,MAAM;CAClB,CAAC;AAEW,QAAA,MAAM,GAAqB;IACtC,QAAQ,EAAE,IAAI,eAAM,CAAC,SAAS,CAAC,eAAe,CAC5C,iCAAiC,EACjC,CAAC,CACF;IACD,aAAa,EAAE,CAAC;IAChB,gBAAgB,EAAE,8BAA8B;IAChD,SAAS,EAAE,MAAM;CAClB,CAAC;AAEW,QAAA,cAAc,GAAqB;IAC9C,QAAQ,EAAE,IAAI,eAAM,CAAC,SAAS,CAAC,eAAe,CAC5C,4BAA4B,EAC5B,GAAG,CACJ;IACD,aAAa,EAAE,CAAC;IAChB,gBAAgB,EAAE,uCAAuC;IACzD,SAAS,EAAE,MAAM;CAClB,CAAC;AAEW,QAAA,cAAc,GAAqB;IAC9C,QAAQ,EAAE,IAAI,eAAM,CAAC,SAAS,CAAC,eAAe,CAC5C,wCAAwC,EACxC,MAAM,CACP;IACD,aAAa,EAAE,CAAC;IAChB,gBAAgB,EAAE,4BAA4B;IAC9C,SAAS,EAAE,MAAM;CAClB,CAAC;AAEW,QAAA,MAAM,GAAqB;IACtC,QAAQ,EAAE,IAAI,eAAM,CAAC,SAAS,CAAC,eAAe,CAC5C,mCAAmC,EACnC,KAAK,CACN;IACD,aAAa,EAAE,EAAE;IACjB,gBAAgB,EAAE,gCAAgC;IAClD,SAAS,EAAE,MAAM;CAClB,CAAC;AAEW,QAAA,UAAU,GAAqB;IAC1C,QAAQ,EAAE,IAAI,eAAM,CAAC,SAAS,CAAC,eAAe,CAC5C,gDAAgD,EAChD,EAAE,CACH;IACD,aAAa,EAAE,CAAC;IAChB,gBAAgB,EAAE,6BAA6B;IAC/C,SAAS,EAAE,MAAM;CAClB,CAAC;AAEW,QAAA,aAAa,GAAqB;IAC7C,QAAQ,EAAE,IAAI,eAAM,CAAC,SAAS,CAAC,eAAe,CAC5C,2CAA2C,EAC3C,IAAI,CACL;IACD,aAAa,EAAE,CAAC;IAChB,gBAAgB,EAAE,8BAA8B;IAChD,SAAS,EAAE,MAAM;CAClB,CAAC;AAEW,QAAA,QAAQ,GAAqB;IACxC,QAAQ,EAAE,IAAI,eAAM,CAAC,SAAS,CAAC,eAAe,CAC5C,kCAAkC,EAClC,IAAI,CACL;IACD,aAAa,EAAE,CAAC;IAChB,gBAAgB,EAAE,qBAAqB;IACvC,SAAS,EAAE,eAAe;CAC3B,CAAC;AAEW,QAAA,KAAK,GAAqB;IACrC,QAAQ,EAAE,IAAI,eAAM,CAAC,SAAS,CAAC,eAAe,CAC5C,uBAAuB,EACvB,KAAK,CACN;IACD,aAAa,EAAE,CAAC;CACjB,CAAC;AAEW,QAAA,KAAK,GAAqB;IACrC,QAAQ,EAAE,IAAI,eAAM,CAAC,SAAS,CAAC,eAAe,CAC5C,uBAAuB,EACvB,KAAK,CACN;IACD,aAAa,EAAE,CAAC;CACjB,CAAC;AAEW,QAAA,KAAK,GAAqB;IACrC,QAAQ,EAAE,IAAI,eAAM,CAAC,SAAS,CAAC,eAAe,CAC5C,uBAAuB,EACvB,KAAK,CACN;IACD,aAAa,EAAE,CAAC;CACjB,CAAC;AAEW,QAAA,sBAAsB,GAA0C;IAC3E,QAAQ,EAAR,gBAAQ;IACR,GAAG,EAAH,WAAG;IACH,QAAQ,EAAR,gBAAQ;IACR,IAAI,EAAJ,YAAI;IACJ,OAAO,EAAP,eAAO;IACP,SAAS,EAAT,iBAAS;IACT,SAAS,EAAT,iBAAS;IACT,IAAI,EAAJ,YAAI;IACJ,MAAM,EAAN,cAAM;IACN,MAAM,EAAN,cAAM;IACN,UAAU,EAAV,kBAAU;IACV,QAAQ,EAAR,gBAAQ;IACR,aAAa,EAAb,qBAAa;IACb,QAAQ,EAAR,gBAAQ;IACR,cAAc,EAAd,sBAAc;IACd,cAAc,EAAd,sBAAc;IACd,KAAK,EAAL,aAAK;IACL,KAAK,EAAL,aAAK;IACL,KAAK,EAAL,aAAK;CACN,CAAC;AAEW,QAAA,0BAA0B,GAAG;IACxC,KAAK,EAAL,aAAK;IACL,KAAK,EAAL,aAAK;IACL,KAAK,EAAL,aAAK;CACN,CAAC"}
+{"version":3,"file":"chainConnectionConfigs.js","sourceRoot":"","sources":["../../src/consts/chainConnectionConfigs.ts"],"names":[],"mappings":";;;AAAA,mCAAgC;AAEhC,8EAAgF;AAGhF,8CAA0C;AAE1C,mDAAgD;AAChD,qCAA8C;AAE9C,SAAS,mBAAmB;IAC1B,OAAO;QACL,QAAQ,EAAE,IAAI,eAAM,CAAC,SAAS,CAAC,eAAe,CAC5C,uBAAuB,EACvB,KAAK,CACN;QACD,aAAa,EAAE,CAAC;KACjB,CAAC;AACJ,CAAC;AAEY,QAAA,sBAAsB,GACjC,IAAA,gBAAM,EAAC,6BAAa,EAAE,CAAC,SAAS,EAAE,QAAQ,EAAE,EAAE;IAC5C,IAAI,mBAAU,CAAC,QAAQ,CAAC,SAAS,CAAC;QAAE,OAAO,mBAAmB,EAAE,CAAC;IAEjE,MAAM,aAAa,GACjB,SAAS,KAAK,eAAM,CAAC,SAAS,IAAI,SAAS,KAAK,eAAM,CAAC,IAAI;QACzD,CAAC,CAAC,gDAAyB;QAC3B,CAAC,CAAC,eAAM,CAAC,SAAS,CAAC,eAAe,CAAC;IAEvC,OAAO;QACL,QAAQ,EAAE,IAAI,aAAa,CAAC,QAAQ,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,QAAQ,CAAC,EAAE,CAAC;QACxE,aAAa,EAAE,QAAQ,CAAC,MAAM,CAAC,aAAa;QAC5C,gBAAgB,EAAE,QAAQ,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC,GAAG;QAChD,mBAAmB,EAAE,QAAQ,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC,MAAM;KACvD,CAAC;AACJ,CAAC,CAAC,CAAC;AAEQ,QAAA,0BAA0B,GAAG;IACxC,KAAK,EAAE,mBAAmB,EAAE;IAC5B,KAAK,EAAE,mBAAmB,EAAE;IAC5B,KAAK,EAAE,mBAAmB,EAAE;CAC7B,CAAC"}

package/dist/consts/chainMetadata.d.ts

@@ -1,43 +1,98 @@
+import type { Chain as WagmiChain } from '@wagmi/chains';
+import { ChainName } from './chains';
+export declare enum ExplorerFamily {
+    Etherscan = "etherscan",
+    Blockscout = "blockscout",
+    Other = "other"
+}
 /**
- * A Chain and its characteristics
+ * Collection of useful properties and settings
+ * for Hyperlane-supported chains
  */
-export declare type ChainMetadata = {
+export interface ChainMetadata {
     id: number;
-    finalityBlocks: number;
-    nativeTokenDecimals?: number;
-    paginate?: RpcPagination;
+    name: ChainName;
+    /** Human-readable name */
+    displayName: string;
+    /** Shorter human-readable name */
+    displayNameShort?: string;
+    /** Default currency/token used by chain */
+    nativeToken: {
+        name: string;
+        symbol: string;
+        decimals: number;
+    };
+    /** Collection of RPC endpoints */
+    publicRpcUrls: Array<{
+        http: string;
+        webSocket?: string;
+        pagination?: RpcPagination;
+    }>;
+    /** Collection of block explorers */
+    blockExplorers: Array<{
+        name: string;
+        url: string;
+        family: ExplorerFamily;
+        apiUrl?: string;
+    }>;
+    blocks: {
+        confirmations: number;
+        reorgPeriod: number;
+        estimateBlockTime: number;
+    };
     gasCurrencyCoinGeckoId?: string;
     gnosisSafeTransactionServiceUrl?: string;
-};
-/**
- * RPC Pagination information
- */
+}
 export interface RpcPagination {
     blocks: number;
     from: number;
 }
 /**
- * Mainnets
+ * Chain metadata
  */
-export declare const celo: ChainMetadata;
-export declare const ethereum: ChainMetadata;
+export declare const alfajores: ChainMetadata;
 export declare const arbitrum: ChainMetadata;
-export declare const optimism: ChainMetadata;
-export declare const bsc: ChainMetadata;
+export declare const arbitrumgoerli: ChainMetadata;
 export declare const avalanche: ChainMetadata;
-export declare const polygon: ChainMetadata;
-/**
- * Testnets
- */
-export declare const alfajores: ChainMetadata;
+export declare const bsc: ChainMetadata;
+export declare const bsctestnet: ChainMetadata;
+export declare const celo: ChainMetadata;
+export declare const ethereum: ChainMetadata;
 export declare const fuji: ChainMetadata;
 export declare const goerli: ChainMetadata;
-export declare const optimismgoerli: ChainMetadata;
-export declare const arbitrumgoerli: ChainMetadata;
-export declare const zksync2testnet: ChainMetadata;
-export declare const mumbai: ChainMetadata;
-export declare const bsctestnet: ChainMetadata;
 export declare const moonbasealpha: ChainMetadata;
 export declare const moonbeam: ChainMetadata;
-export declare const chainMetadata: Record<"polygon" | "arbitrum" | "alfajores" | "bsc" | "mumbai" | "goerli" | "fuji" | "celo" | "ethereum" | "avalanche" | "optimism" | "bsctestnet" | "moonbasealpha" | "moonbeam" | "optimismgoerli" | "arbitrumgoerli" | "test1" | "test2" | "test3", ChainMetadata>;
+export declare const mumbai: ChainMetadata;
+export declare const optimism: ChainMetadata;
+export declare const optimismgoerli: ChainMetadata;
+export declare const polygon: ChainMetadata;
+export declare const test1: ChainMetadata;
+export declare const test2: ChainMetadata;
+export declare const test3: ChainMetadata;
+/**
+ * Collection maps
+ *
+ * NOTE: When adding chains here, consider also adding the
+ * corresponding chain logo images in the /sdk/logos/* folders
+ */
+export declare const chainMetadata: Record<"polygon" | "alfajores" | "arbitrum" | "arbitrumgoerli" | "avalanche" | "bsc" | "bsctestnet" | "celo" | "ethereum" | "fuji" | "goerli" | "moonbasealpha" | "moonbeam" | "mumbai" | "optimism" | "optimismgoerli" | "test1" | "test2" | "test3", ChainMetadata>;
+export declare const wagmiChainMetadata: Record<ChainName, WagmiChain>;
+export declare const chainIdToMetadata: Record<number, ChainMetadata>;
+export declare const mainnetChainsMetadata: Array<ChainMetadata>;
+export declare const testnetChainsMetadata: Array<ChainMetadata>;
+/**
+ * @deprecated use ChainMetadata
+ */
+export declare type PartialChainMetadata = {
+    id: number;
+    finalityBlocks: number;
+    nativeTokenDecimals?: number;
+    paginate?: RpcPagination;
+    gasCurrencyCoinGeckoId?: string;
+    gnosisSafeTransactionServiceUrl?: string;
+};
+/**
+ * @deprecated use chainMetadata
+ */
+export declare const partialChainMetadata: Record<ChainName, PartialChainMetadata>;
 //# sourceMappingURL=chainMetadata.d.ts.map

package/dist/consts/chainMetadata.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"chainMetadata.d.ts","sourceRoot":"","sources":["../../src/consts/chainMetadata.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,oBAAY,aAAa,GAAG;IAC1B,EAAE,EAAE,MAAM,CAAC;IACX,cAAc,EAAE,MAAM,CAAC;IACvB,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAC7B,QAAQ,CAAC,EAAE,aAAa,CAAC;IAGzB,sBAAsB,CAAC,EAAE,MAAM,CAAC;IAEhC,+BAA+B,CAAC,EAAE,MAAM,CAAC;CAC1C,CAAC;AAEF;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,MAAM,CAAC;CACd;AAMD;;GAEG;AACH,eAAO,MAAM,IAAI,EAAE,aAKlB,CAAC;AAEF,eAAO,MAAM,QAAQ,EAAE,aAItB,CAAC;AAEF,eAAO,MAAM,QAAQ,EAAE,aAMtB,CAAC;AAEF,eAAO,MAAM,QAAQ,EAAE,aAMtB,CAAC;AAEF,eAAO,MAAM,GAAG,EAAE,aAKjB,CAAC;AAEF,eAAO,MAAM,SAAS,EAAE,aAWvB,CAAC;AAEF,eAAO,MAAM,OAAO,EAAE,aAWrB,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,SAAS,EAAE,aAGvB,CAAC;AAEF,eAAO,MAAM,IAAI,EAAE,aAGlB,CAAC;AAEF,eAAO,MAAM,MAAM,EAAE,aAGpB,CAAC;AAEF,eAAO,MAAM,cAAc,EAAE,aAG5B,CAAC;AAEF,eAAO,MAAM,cAAc,EAAE,aAG5B,CAAC;AAEF,eAAO,MAAM,cAAc,EAAE,aAG5B,CAAC;AAEF,eAAO,MAAM,MAAM,EAAE,aAQpB,CAAC;AAiBF,eAAO,MAAM,UAAU,EAAE,aAGxB,CAAC;AAEF,eAAO,MAAM,aAAa,EAAE,aAG3B,CAAC;AAEF,eAAO,MAAM,QAAQ,EAAE,aAGtB,CAAC;AAEF,eAAO,MAAM,aAAa,uQAmBW,CAAC"}
+{"version":3,"file":"chainMetadata.d.ts","sourceRoot":"","sources":["../../src/consts/chainMetadata.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,KAAK,IAAI,UAAU,EAAE,MAAM,eAAe,CAAC;AAIzD,OAAO,EAAE,SAAS,EAA8B,MAAM,UAAU,CAAC;AAEjE,oBAAY,cAAc;IACxB,SAAS,cAAc;IACvB,UAAU,eAAe;IACzB,KAAK,UAAU;CAChB;AAED;;;GAGG;AACH,MAAM,WAAW,aAAa;IAC5B,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,SAAS,CAAC;IAChB,0BAA0B;IAC1B,WAAW,EAAE,MAAM,CAAC;IACpB,kCAAkC;IAClC,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,2CAA2C;IAC3C,WAAW,EAAE;QACX,IAAI,EAAE,MAAM,CAAC;QACb,MAAM,EAAE,MAAM,CAAC;QACf,QAAQ,EAAE,MAAM,CAAC;KAClB,CAAC;IACF,kCAAkC;IAClC,aAAa,EAAE,KAAK,CAAC;QACnB,IAAI,EAAE,MAAM,CAAC;QACb,SAAS,CAAC,EAAE,MAAM,CAAC;QACnB,UAAU,CAAC,EAAE,aAAa,CAAC;KAC5B,CAAC,CAAC;IACH,oCAAoC;IACpC,cAAc,EAAE,KAAK,CAAC;QACpB,IAAI,EAAE,MAAM,CAAC;QACb,GAAG,EAAE,MAAM,CAAC;QACZ,MAAM,EAAE,cAAc,CAAC;QACvB,MAAM,CAAC,EAAE,MAAM,CAAC;KACjB,CAAC,CAAC;IACH,MAAM,EAAE;QAEN,aAAa,EAAE,MAAM,CAAC;QAGtB,WAAW,EAAE,MAAM,CAAC;QAEpB,iBAAiB,EAAE,MAAM,CAAC;KAC3B,CAAC;IAEF,sBAAsB,CAAC,EAAE,MAAM,CAAC;IAEhC,+BAA+B,CAAC,EAAE,MAAM,CAAC;CAC1C;AAED,MAAM,WAAW,aAAa;IAC5B,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,MAAM,CAAC;CACd;AAuBD;;GAEG;AAEH,eAAO,MAAM,SAAS,EAAE,aAuBvB,CAAC;AAEF,eAAO,MAAM,QAAQ,EAAE,aAsBtB,CAAC;AAEF,eAAO,MAAM,cAAc,EAAE,aAoB5B,CAAC;AAEF,eAAO,MAAM,SAAS,EAAE,aA8BvB,CAAC;AAEF,eAAO,MAAM,GAAG,EAAE,aAyBjB,CAAC;AAEF,eAAO,MAAM,UAAU,EAAE,aAmBxB,CAAC;AAEF,eAAO,MAAM,IAAI,EAAE,aA0BlB,CAAC;AAEF,eAAO,MAAM,QAAQ,EAAE,aAyBtB,CAAC;AAEF,eAAO,MAAM,IAAI,EAAE,aAmBlB,CAAC;AAEF,eAAO,MAAM,MAAM,EAAE,aAmBpB,CAAC;AAEF,eAAO,MAAM,aAAa,EAAE,aAwB3B,CAAC;AAEF,eAAO,MAAM,QAAQ,EAAE,aAuBtB,CAAC;AAEF,eAAO,MAAM,MAAM,EAAE,aA+BpB,CAAC;AAEF,eAAO,MAAM,QAAQ,EAAE,aAsBtB,CAAC;AAEF,eAAO,MAAM,cAAc,EAAE,aAoB5B,CAAC;AAEF,eAAO,MAAM,OAAO,EAAE,aAgCrB,CAAC;AAEF,eAAO,MAAM,KAAK,EAAE,aAYnB,CAAC;AAEF,eAAO,MAAM,KAAK,EAAE,aAYnB,CAAC;AAEF,eAAO,MAAM,KAAK,EAAE,aAYnB,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,aAAa,uQAoBW,CAAC;AAGtC,eAAO,MAAM,kBAAkB,EAAE,MAAM,CAAC,SAAS,EAAE,UAAU,CAkB5D,CAAC;AAEF,eAAO,MAAM,iBAAiB,+BAKxB,CAAC;AAEP,eAAO,MAAM,qBAAqB,EAAE,KAAK,CAAC,aAAa,CAEtD,CAAC;AACF,eAAO,MAAM,qBAAqB,EAAE,KAAK,CAAC,aAAa,CAEtD,CAAC;AAEF;;GAEG;AACH,oBAAY,oBAAoB,GAAG;IACjC,EAAE,EAAE,MAAM,CAAC;IACX,cAAc,EAAE,MAAM,CAAC;IACvB,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAC7B,QAAQ,CAAC,EAAE,aAAa,CAAC;IAGzB,sBAAsB,CAAC,EAAE,MAAM,CAAC;IAEhC,+BAA+B,CAAC,EAAE,MAAM,CAAC;CAC1C,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,oBAAoB,EAAE,MAAM,CAAC,SAAS,EAAE,oBAAoB,CAQpE,CAAC"}