@lifi/types 1.4.0 → 1.5.1

package/dist/cjs/bridges.js

@@ -0,0 +1,170 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.supportedBridges = exports.BridgeTool = void 0;
+/**
+ * @deprecated
+ * These values are now obtainable from the LI.FI API
+ */
+var BridgeTool;
+(function (BridgeTool) {
+    BridgeTool["connext"] = "connext";
+    BridgeTool["hop"] = "hop";
+    BridgeTool["multichain"] = "multichain";
+    BridgeTool["cbridge"] = "cbridge";
+    BridgeTool["hyphen"] = "hyphen";
+    BridgeTool["polygon"] = "polygon";
+    BridgeTool["arbitrum"] = "arbitrum";
+    BridgeTool["avalanche"] = "avalanche";
+    BridgeTool["optimism"] = "optimism";
+    BridgeTool["across"] = "across";
+    BridgeTool["portal"] = "portal";
+    BridgeTool["stargate"] = "stargate";
+})(BridgeTool = exports.BridgeTool || (exports.BridgeTool = {}));
+/**
+ * @deprecated
+ * These values are now obtainable from the LI.FI API
+ */
+exports.supportedBridges = [
+    {
+        key: BridgeTool.connext,
+        name: 'Connext',
+        logoURI: 'https://raw.githubusercontent.com/lifinance/types/main/src/assets/icons/bridges/connext.png',
+        bridgeUrl: 'https://xpollinate.io/',
+        discordUrl: 'https://chat.connext.network/',
+        supportUrl: 'https://www.notion.so/connext/Connext-NXTP-Support-19a357ebabdd4e888cfcd138fe3e4644',
+        docsUrl: 'https://docs.connext.network/',
+        explorerUrl: 'https://connextscan.io/',
+        analyticsUrl: 'https://connextscan.io/',
+    },
+    {
+        key: BridgeTool.hop,
+        name: 'Hop',
+        logoURI: 'https://raw.githubusercontent.com/lifinance/types/main/src/assets/icons/bridges/hop.png',
+        bridgeUrl: 'https://app.hop.exchange/',
+        discordUrl: 'https://discord.gg/PwCF88emV4',
+        supportUrl: 'https://help.hop.exchange/hc/en-us',
+        docsUrl: 'https://docs.hop.exchange/',
+        explorerUrl: 'https://explorer.hop.exchange/mainnet/',
+        analyticsUrl: 'https://explorer.hop.exchange/mainnet/',
+    },
+    {
+        key: BridgeTool.multichain,
+        name: 'Multichain',
+        logoURI: 'https://raw.githubusercontent.com/lifinance/types/main/src/assets/icons/bridges/anyswap.png',
+        bridgeUrl: 'https://app.multichain.org/',
+        // discordUrl: '',
+        supportUrl: 'https://multichain.zendesk.com/hc/en-us',
+        docsUrl: 'https://docs.multichain.org/',
+        explorerUrl: 'https://anyswap.net/',
+    },
+    {
+        key: BridgeTool.cbridge,
+        name: 'cBridge',
+        logoURI: 'https://raw.githubusercontent.com/lifinance/types/main/src/assets/icons/bridges/cbridge.png',
+        bridgeUrl: 'https://cbridge.celer.network/',
+        discordUrl: 'https://discord.com/invite/uGx4fjQ',
+        supportUrl: 'https://form.typeform.com/to/Q4LMjUaK',
+        docsUrl: 'https://cbridge-docs.celer.network/',
+        // explorerUrl: '',
+        analyticsUrl: 'https://cbridge-analytics.celer.network/',
+    },
+    {
+        key: BridgeTool.hyphen,
+        name: 'Hyphen',
+        logoURI: 'https://raw.githubusercontent.com/lifinance/types/main/src/assets/icons/bridges/hyphen.png',
+        bridgeUrl: 'https://hyphen.biconomy.io/',
+        discordUrl: 'https://discord.com/invite/HKHxgyEExQ',
+        supportUrl: 'https://discord.com/invite/HKHxgyEExQ',
+        docsUrl: 'https://docs.biconomy.io/products/hyphen-instant-cross-chain-transfers',
+        // explorerUrl: '',
+        analyticsUrl: 'https://hyphen-info.biconomy.io/',
+    },
+    {
+        key: BridgeTool.polygon,
+        name: 'Polygon Bridge (PoS)',
+        logoURI: 'https://raw.githubusercontent.com/lifinance/types/main/src/assets/icons/bridges/polygon.png',
+        bridgeUrl: 'https://wallet.polygon.technology/bridge',
+        // discordUrl: '',
+        supportUrl: 'https://forum.matic.network/',
+        docsUrl: 'https://docs.polygon.technology/docs/develop/ethereum-polygon/pos/getting-started',
+        // explorerUrl: '',
+        // analyticsUrl: '',
+    },
+    {
+        key: BridgeTool.arbitrum,
+        name: 'Arbitrum One Bridge',
+        logoURI: 'https://raw.githubusercontent.com/lifinance/types/main/src/assets/icons/bridges/arbitrum.png',
+        bridgeUrl: 'https://bridge.arbitrum.io/',
+        discordUrl: 'https://discord.gg/ZpZuw7p',
+        supportUrl: 'https://discord.gg/ZpZuw7p',
+        docsUrl: 'https://developer.offchainlabs.com/docs/bridging_assets',
+        // explorerUrl: '',
+    },
+    {
+        key: BridgeTool.avalanche,
+        name: 'AVAX Bridge',
+        logoURI: 'https://raw.githubusercontent.com/lifinance/types/main/src/assets/icons/bridges/avalanche.png',
+        bridgeUrl: 'https://bridge.avax.network/',
+        discordUrl: 'https://chat.avalabs.org/',
+        supportUrl: 'https://docs.avax.network/learn/avalanche-bridge-faq/',
+        docsUrl: 'https://docs.avax.network/learn/avalanche-bridge-faq/',
+        // explorerUrl: '',
+        // analyticsUrl: '',
+    },
+    {
+        key: BridgeTool.optimism,
+        name: 'Optimism Gateway',
+        logoURI: 'https://raw.githubusercontent.com/lifinance/types/main/src/assets/icons/bridges/optimism.png',
+        bridgeUrl: 'https://gateway.optimism.io/',
+        discordUrl: 'https://discord.com/invite/jrnFEvq',
+        supportUrl: 'https://discord.com/invite/jrnFEvq',
+        docsUrl: 'https://community.optimism.io/docs/developers/bridge/basics/',
+        // explorerUrl: '',
+        // analyticsUrl: '',
+    },
+    {
+        key: BridgeTool.across,
+        name: 'Across',
+        logoURI: 'https://raw.githubusercontent.com/lifinance/types/main/src/assets/icons/bridges/acrossv2.png',
+        bridgeUrl: 'https://across.to/',
+        discordUrl: 'https://discord.gg/t4SZySkn',
+        supportUrl: 'https://discord.gg/t4SZySkn',
+        docsUrl: 'https://docs.across.to/',
+    },
+    {
+        key: BridgeTool.portal,
+        name: 'Wormhole Portal',
+        logoURI: 'https://raw.githubusercontent.com/lifinance/types/main/src/assets/icons/bridges/wormhole_portal.png',
+        bridgeUrl: 'https://portalbridge.com/',
+        discordUrl: 'https://discord.com/invite/wormholecrypto',
+        supportUrl: 'https://discord.com/invite/wormholecrypto',
+        docsUrl: 'https://docs.wormholenetwork.com/wormhole/',
+    },
+    {
+        key: BridgeTool.stargate,
+        name: 'Stargate',
+        logoURI: 'https://raw.githubusercontent.com/lifinance/types/5685c638772f533edad80fcb210b4bb89e30a50f/src/assets/icons/bridges/stargate.png',
+        bridgeUrl: 'https://stargate.finance/',
+        discordUrl: 'https://discord.com/invite/TyjeQ45',
+        supportUrl: 'https://discord.com/invite/TyjeQ45',
+        docsUrl: 'https://stargateprotocol.gitbook.io/stargate/',
+    },
+    // {
+    //   key: BridgeTool.,
+    //   name: '',
+    //   logoURI:
+    //     'https://raw.githubusercontent.com/lifinance/types/main/src/assets/icons/bridges/.png',
+    //   bridgeUrl: '',
+    //   discordUrl: '',
+    //   supportUrl: '',
+    //   docsUrl: '',
+    //   explorerUrl: '',
+    //   analyticsUrl: '',
+    // },
+    // for cronos chain, we should confirm if these bridges are available to integrate
+    // https://bridge.evodefi.com/
+    // https://app.relaychain.com/#/
+    // for metis network, we should confirm these bridges as well
+    // https://bridge.metis.io/home
+    // https://apps.standard.tech/bridge
+];

package/dist/cjs/chains/Chain.d.ts

@@ -0,0 +1,15 @@
+import { ChainKey, CoinKey } from '../base';
+export declare enum ChainType {
+    EVM = "EVM",
+    Solana = "SOLANA"
+}
+export interface _Chain {
+    key: ChainKey;
+    chainType: ChainType;
+    name: string;
+    coin: CoinKey;
+    id: number;
+    mainnet: boolean;
+    logoURI?: string;
+    faucetUrls?: string[];
+}

package/dist/cjs/chains/Chain.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ChainType = void 0;
+var ChainType;
+(function (ChainType) {
+    ChainType["EVM"] = "EVM";
+    ChainType["Solana"] = "SOLANA";
+})(ChainType = exports.ChainType || (exports.ChainType = {}));

package/dist/cjs/chains/EVMChain.d.ts

@@ -0,0 +1,19 @@
+import { _Chain } from './Chain';
+export interface EVMChain extends _Chain {
+    tokenlistUrl?: string;
+    metamask: AddEthereumChainParameter;
+    multicallAddress?: string;
+}
+export interface AddEthereumChainParameter {
+    chainId: string;
+    blockExplorerUrls: string[];
+    chainName: string;
+    nativeCurrency: {
+        name: string;
+        symbol: string;
+        decimals: number;
+    };
+    rpcUrls: string[];
+}
+export declare const prefixChainId: (chainId: number) => string;
+export declare type Chain = EVMChain;

package/dist/cjs/chains/EVMChain.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.prefixChainId = void 0;
+const ethers_1 = require("ethers");
+const prefixChainId = (chainId) => {
+    return '0x' + ethers_1.BigNumber.from(chainId)._hex.split('0x')[1].replace(/\b0+/g, '');
+};
+exports.prefixChainId = prefixChainId;

package/dist/cjs/chains/SolanaChain.d.ts

@@ -0,0 +1,2 @@
+import { _Chain } from './Chain';
+export declare type SolanaChain = _Chain;

package/dist/cjs/chains/SolanaChain.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/chains/chain.utils.d.ts

@@ -0,0 +1,4 @@
+import { ChainKey } from '../base';
+import { Chain } from './EVMChain';
+export declare const getChainByKey: (chainKey: ChainKey) => Chain;
+export declare const getChainById: (chainId: number) => Chain;

package/dist/cjs/chains/chain.utils.js

@@ -0,0 +1,25 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getChainById = exports.getChainByKey = void 0;
+const supported_chains_1 = require("./supported.chains");
+const supportedChains = [
+    // This will be added in the future
+    // ...supportedSolanaChains,
+    ...supported_chains_1.supportedEVMChains,
+];
+const getChainByKey = (chainKey) => {
+    const chain = supportedChains.find((c) => c.key === chainKey);
+    if (!chain) {
+        throw new Error('Invalid chainKey');
+    }
+    return chain;
+};
+exports.getChainByKey = getChainByKey;
+const getChainById = (chainId) => {
+    const chain = supportedChains.find((c) => c.id === chainId);
+    if (!chain) {
+        throw new Error('Invalid chainId');
+    }
+    return chain;
+};
+exports.getChainById = getChainById;

package/dist/cjs/chains/index.d.ts

@@ -0,0 +1,5 @@
+export * from './Chain';
+export * from './EVMChain';
+export * from './SolanaChain';
+export * from './supported.chains';
+export * from './chain.utils';

package/dist/cjs/chains/index.js

@@ -0,0 +1,21 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./Chain"), exports);
+__exportStar(require("./EVMChain"), exports);
+__exportStar(require("./SolanaChain"), exports);
+__exportStar(require("./supported.chains"), exports);
+__exportStar(require("./chain.utils"), exports);

package/dist/cjs/chains/supported.chains.d.ts

@@ -0,0 +1,5 @@
+import { EVMChain } from './EVMChain';
+import { SolanaChain } from './SolanaChain';
+export declare const supportedEVMChains: EVMChain[];
+export declare const supportedSolanaChains: SolanaChain[];
+export declare const supportedChains: EVMChain[];