@lifi/data-types 4.10.5 → 5.0.0-beta.2

package/src/coins/index.ts

@@ -0,0 +1 @@
+export * from './coins'

package/src/index.ts

@@ -0,0 +1,3 @@
+export * from './chains'
+export * from './coins'
+export * from './multicall'

package/src/multicall.ts

@@ -0,0 +1,66 @@
+import { ChainId } from '@lifi/types'
+
+// based on:
+// new nice tool to search for addresses: https://www.multicall3.com/deployments
+// - https://github.com/mds1/multicall#deployments
+// - https://github.com/sushiswap/sushiswap-sdk/blob/canary/src/constants/addresses.ts#L323
+// - https://github.com/joshstevens19/ethereum-multicall#multicall-contracts
+// '0xcA11bde05977b3631167028862bE2a173976CA11' is a Multicall3 contract
+// export const multicallAddresses: Record<ChainId, string> = {
+export const multicallAddresses: { [ChainId: number]: string } = {
+  // Mainnet
+  [ChainId.ETH]: '0xcA11bde05977b3631167028862bE2a173976CA11', // '0x5BA1e12693Dc8F9c48aAD8770482f4739bEeD696',
+  [ChainId.POL]: '0xcA11bde05977b3631167028862bE2a173976CA11', // '0x02817C1e3543c2d908a590F5dB6bc97f933dB4BD',
+  [ChainId.BSC]: '0xcA11bde05977b3631167028862bE2a173976CA11', // '0xa9193376D09C7f31283C54e56D013fCF370Cd9D9',
+  [ChainId.DAI]: '0xcA11bde05977b3631167028862bE2a173976CA11', // '0x67dA5f2FfaDDfF067AB9d5F025F8810634d84287',
+  [ChainId.FTM]: '0xcA11bde05977b3631167028862bE2a173976CA11', // '0x22D4cF72C45F8198CfbF4B568dBdB5A85e8DC0B5',
+  [ChainId.AVA]: '0xcA11bde05977b3631167028862bE2a173976CA11', // '0xdDCbf776dF3dE60163066A5ddDF2277cB445E0F3',
+  [ChainId.ARB]: '0xcA11bde05977b3631167028862bE2a173976CA11', // '0x80C7DD17B01855a6D2347444a0FCC36136a314de',
+  [ChainId.HEC]: '0xcA11bde05977b3631167028862bE2a173976CA11', // '0xdDCbf776dF3dE60163066A5ddDF2277cB445E0F3',
+  [ChainId.OPT]: '0xcA11bde05977b3631167028862bE2a173976CA11', // '0x2DC0E2aa608532Da689e89e237dF582B783E552C',
+  [ChainId.ONE]: '0xcA11bde05977b3631167028862bE2a173976CA11', // '0xdDCbf776dF3dE60163066A5ddDF2277cB445E0F3',
+  [ChainId.FSN]: '0x0769fd68dFb93167989C6f7254cd0D766Fb2841F',
+  [ChainId.MOR]: '0xcA11bde05977b3631167028862bE2a173976CA11', // '0x270f2F35bED92B7A59eA5F08F6B3fd34c8D9D9b5',
+  [ChainId.CEL]: '0xcA11bde05977b3631167028862bE2a173976CA11', // '0x9aac9048fC8139667D6a2597B902865bfdc225d3',
+  [ChainId.FUS]: '0xcA11bde05977b3631167028862bE2a173976CA11', // '0x0769fd68dFb93167989C6f7254cd0D766Fb2841F',
+  [ChainId.CRO]: '0xcA11bde05977b3631167028862bE2a173976CA11', // '0x5e954f5972EC6BFc7dECd75779F10d848230345F',
+  [ChainId.BOB]: '0xcA11bde05977b3631167028862bE2a173976CA11', // '0xfb91c019D9F12A0f9c23B4762fa64A34F8daDb4A',
+  [ChainId.MOO]: '0xcA11bde05977b3631167028862bE2a173976CA11', // '0x6477204E12A7236b9619385ea453F370aD897bb2',
+  [ChainId.MAM]: '0xcA11bde05977b3631167028862bE2a173976CA11',
+  [ChainId.AUR]: '0xcA11bde05977b3631167028862bE2a173976CA11',
+  [ChainId.EVM]: '0xcA11bde05977b3631167028862bE2a173976CA11',
+  [ChainId.MET]: '0xcA11bde05977b3631167028862bE2a173976CA11',
+  [ChainId.RSK]: '0xcA11bde05977b3631167028862bE2a173976CA11',
+  [ChainId.VEL]: '0x6ede559F2Bd951777470595761672091CCD21Ac6',
+  [ChainId.PZE]: '0xcA11bde05977b3631167028862bE2a173976CA11',
+  [ChainId.ERA]: '0xF9cda624FBC7e059355ce98a31693d299FACd963',
+  [ChainId.LNA]: '0xcA11bde05977b3631167028862bE2a173976CA11',
+  [ChainId.ARN]: '0xcA11bde05977b3631167028862bE2a173976CA11',
+  [ChainId.BAS]: '0xcA11bde05977b3631167028862bE2a173976CA11',
+  [ChainId.SCL]: '0xcA11bde05977b3631167028862bE2a173976CA11',
+  [ChainId.MOD]: '0xcA11bde05977b3631167028862bE2a173976CA11',
+  [ChainId.MNT]: '0xcA11bde05977b3631167028862bE2a173976CA11',
+  [ChainId.BLS]: '0xcA11bde05977b3631167028862bE2a173976CA11',
+  [ChainId.SEI]: '0xcA11bde05977b3631167028862bE2a173976CA11',
+  [ChainId.FRA]: '0xcA11bde05977b3631167028862bE2a173976CA11',
+
+  // TODO
+  // [ChainId.EXP]: '', // TODO
+  // [ChainId.TCH]: '', // TODO
+  // [ChainId.UBQ]: '', // TODO
+  // [ChainId.DIO]: '', // TODO
+  // [ChainId.TLO]: '', // TODO
+  // [ChainId.SHI]: '', // TODO
+  // [ChainId.GL1]: '', // TODO
+  // [ChainId.TBW]: '', // TODO
+  // [ChainId.PALM]: '0x0769fd68dFb93167989C6f7254cd0D766Fb2841F',
+  // [ChainId.TELOS]: '0xdDCbf776dF3dE60163066A5ddDF2277cB445E0F3',
+
+  // none EVM
+  // [ChainId.SOL]: '', // NOT NEEDED
+  // [ChainId.TER]: '', // NOT NEEDED
+  // [ChainId.OAS]: '', // NOT NEEDED
+  // [ChainId.SOLT]: '', // NOT NEEDED
+  // [ChainId.TERT]: '', // NOT NEEDED
+  // [ChainId.OAST]: '', // NOT NEEDED
+}

package/dist/chains/supportedChains.d.ts

@@ -1,4 +0,0 @@
-import { Chain, ChainKey } from '@lifi/types';
-export declare const supportedChains: import("@lifi/types").UTXOChain[];
-export declare const getChainByKey: (chainKey: ChainKey) => Chain;
-export declare const getChainById: (chainId: number) => Chain;

package/dist/chains/supportedChains.evm.d.ts

@@ -1,2 +0,0 @@
-import { EVMChain } from '@lifi/types';
-export declare const supportedEVMChains: EVMChain[];

package/dist/chains/supportedChains.svm.d.ts

@@ -1,2 +0,0 @@
-import { SolanaChain } from '@lifi/types';
-export declare const supportedSolanaChains: SolanaChain[];

package/dist/chains/supportedChains.unit.spec.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/chains/supportedChains.utxo.d.ts

@@ -1,2 +0,0 @@
-import { UTXOChain } from '@lifi/types';
-export declare const supportedUXTOChains: UTXOChain[];

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

@@ -1,5 +0,0 @@
-export { supportedEVMChains } from './supportedChains.evm';
-export { supportedSolanaChains } from './supportedChains.svm';
-export { supportedUXTOChains } from './supportedChains.utxo';
-export * from './supportedChains';
-export * from './utils';

package/dist/cjs/chains/supportedChains.evm.d.ts

@@ -1,2 +0,0 @@
-import { EVMChain } from '@lifi/types';
-export declare const supportedEVMChains: EVMChain[];

package/dist/cjs/chains/supportedChains.svm.d.ts

@@ -1,2 +0,0 @@
-import { SolanaChain } from '@lifi/types';
-export declare const supportedSolanaChains: SolanaChain[];

package/dist/cjs/chains/supportedChains.unit.spec.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/cjs/chains/supportedChains.unit.spec.js

@@ -1,87 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const types_1 = require("@lifi/types");
-const coins_1 = require("../coins");
-const supportedChains_1 = require("./supportedChains");
-const utils_1 = require("./utils");
-const supportedChains_evm_1 = require("./supportedChains.evm");
-test('getChainById', () => {
-    expect((0, supportedChains_1.getChainById)(types_1.ChainId.ETH)).toBeDefined();
-});
-test('getChainByKey', () => {
-    expect((0, supportedChains_1.getChainByKey)(types_1.ChainKey.ETH)).toBeDefined();
-});
-test('native token defined for all chains', () => {
-    // currently unused chains
-    const ignoredChainsForNativeToken = [
-        types_1.ChainId.FSN,
-        types_1.ChainId.EXP,
-        types_1.ChainId.TCH,
-        types_1.ChainId.UBQ,
-        types_1.ChainId.MET,
-        types_1.ChainId.DIO,
-        types_1.ChainId.TLO,
-        types_1.ChainId.SHI,
-        types_1.ChainId.GL1,
-        types_1.ChainId.RSK,
-        types_1.ChainId.TBW,
-    ];
-    const ignoredChainsForWrappedToken = [
-        ...ignoredChainsForNativeToken,
-        types_1.ChainId.BTC,
-        types_1.ChainId.BCH,
-        types_1.ChainId.LTC,
-        types_1.ChainId.DGE,
-    ];
-    for (const chain of supportedChains_1.supportedChains) {
-        if (ignoredChainsForNativeToken.includes(chain.id))
-            continue;
-        try {
-            const gasToken = (0, coins_1.findDefaultToken)(chain.coin, chain.id);
-            expect(gasToken).toBeDefined();
-        }
-        catch (e) {
-            throw new Error(`Failed to load gas token for ${chain.name}(${chain.id})`);
-        }
-    }
-    for (const chain of supportedChains_1.supportedChains) {
-        if (ignoredChainsForWrappedToken.includes(chain.id))
-            continue;
-        try {
-            const wrappedGasToken = (0, coins_1.findWrappedGasOnChain)(chain.id);
-            expect(wrappedGasToken).toBeDefined();
-        }
-        catch (e) {
-            throw new Error(`Failed to load wrapped gas token for ${chain.name}(${chain.id})`);
-        }
-    }
-});
-describe('findTokenByChainIdAndAddress', () => {
-    describe('token has no name override', () => {
-        it('returns a token with the coin name', () => {
-            expect((0, coins_1.findTokenByChainIdAndAddress)(types_1.ChainId.LNA, '0xa219439258ca9da29e9cc4ce5596924745e12b93').name).toEqual(types_1.CoinKey.USDT);
-        });
-    });
-    describe('token has a name override', () => {
-        it('returns a token with the overrode name', () => {
-            expect((0, coins_1.findTokenByChainIdAndAddress)(types_1.ChainId.SOL, '33fsBLA8djQm82RpHmE3SuVrPGtZBWNYExsEUeKX1HXX').name).toEqual('Binance USD (Wormhole from Ethereum)');
-        });
-    });
-});
-describe('validate chains', () => {
-    supportedChains_evm_1.supportedEVMChains.forEach((chain) => {
-        it(`validate chain ${chain.name}`, () => {
-            // blockExplorerUrls
-            expect(chain.metamask.blockExplorerUrls.length).toBeGreaterThan(0);
-            chain.metamask.blockExplorerUrls.forEach((blockExplorerUrl) => {
-                expect(blockExplorerUrl.startsWith('https://')).toBeTruthy();
-                expect(blockExplorerUrl.endsWith('/')).toBeTruthy();
-            });
-            const chainId = (0, utils_1.prefixChainId)(chain.id);
-            // chain ids match
-            expect(chainId).toEqual(chain.metamask.chainId);
-            // rpcs defined
-            expect(chain.metamask.rpcUrls.length).toBeGreaterThan(0);
-        });
-    });
-});

package/dist/cjs/chains/supportedChains.utxo.d.ts

@@ -1,2 +0,0 @@
-import { UTXOChain } from '@lifi/types';
-export declare const supportedUXTOChains: UTXOChain[];

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

@@ -1 +0,0 @@
-export declare const prefixChainId: (chainId: number) => string;

package/dist/cjs/coins/coins.d.ts

@@ -1,26 +0,0 @@
-import { ChainId, Coin, CoinKey, StaticToken } from '@lifi/types';
-type BasicToken = {
-    address: string;
-    decimals: number;
-    name?: string;
-    symbol?: string;
-};
-type BasicCoin = {
-    key: CoinKey;
-    name: string;
-    logoURI: string;
-    verified: boolean;
-    chains: {
-        [key: number]: BasicToken;
-    };
-};
-export declare const basicCoins: BasicCoin[];
-export declare const defaultCoins: Array<Coin>;
-export declare const wrappedTokens: {
-    [ChainId: string]: StaticToken;
-};
-export declare const findDefaultCoin: (coinKey: CoinKey) => Coin;
-export declare const findDefaultToken: (coinKey: CoinKey, chainId: ChainId) => StaticToken;
-export declare const findWrappedGasOnChain: (chainId: ChainId) => StaticToken;
-export declare const findTokenByChainIdAndAddress: (chainId: number, tokenAddress: string) => StaticToken | null;
-export {};

package/dist/cjs/coins/coins.int.spec.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/cjs/coins/coins.int.spec.js

@@ -1,31 +0,0 @@
-"use strict";
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const coins_1 = require("./coins");
-jest.setTimeout(20000);
-describe('Coin logo test', () => {
-    const allImages = [];
-    // default coins
-    allImages.push(...coins_1.defaultCoins
-        .map((coin) => {
-        const baseURL = coin.logoURI;
-        const tokenSpecificURLs = Object.values(coin.chains).flatMap(({ logoURI }) => (logoURI ? [logoURI] : []));
-        return [baseURL, ...tokenSpecificURLs];
-    })
-        .flat());
-    // wrapped tokens
-    allImages.push(...Object.values(coins_1.wrappedTokens).map((token) => token.logoURI));
-    test.each([...new Set(allImages)])('check that logoURI %s is valid', (image) => __awaiter(void 0, void 0, void 0, function* () {
-        expect(image.startsWith('https://')).toBeTruthy();
-        const response = yield fetch(image);
-        expect(response.status).toEqual(200);
-    }), 2000);
-});

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

@@ -1 +0,0 @@
-export * from './coins';

package/dist/cjs/coins/index.js

@@ -1,17 +0,0 @@
-"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("./coins"), exports);

package/dist/cjs/index.d.ts

@@ -1,3 +0,0 @@
-export * from './chains';
-export * from './coins';
-export * from './multicall';

package/dist/cjs/index.js

@@ -1,19 +0,0 @@
-"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("./chains"), exports);
-__exportStar(require("./coins"), exports);
-__exportStar(require("./multicall"), exports);

package/dist/coins/coins.int.spec.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/coins/coins.int.spec.js

@@ -1,29 +0,0 @@
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-import { defaultCoins, wrappedTokens } from './coins';
-jest.setTimeout(20000);
-describe('Coin logo test', () => {
-    const allImages = [];
-    // default coins
-    allImages.push(...defaultCoins
-        .map((coin) => {
-        const baseURL = coin.logoURI;
-        const tokenSpecificURLs = Object.values(coin.chains).flatMap(({ logoURI }) => (logoURI ? [logoURI] : []));
-        return [baseURL, ...tokenSpecificURLs];
-    })
-        .flat());
-    // wrapped tokens
-    allImages.push(...Object.values(wrappedTokens).map((token) => token.logoURI));
-    test.each([...new Set(allImages)])('check that logoURI %s is valid', (image) => __awaiter(void 0, void 0, void 0, function* () {
-        expect(image.startsWith('https://')).toBeTruthy();
-        const response = yield fetch(image);
-        expect(response.status).toEqual(200);
-    }), 2000);
-});

package/dist/coins/index.d.ts

@@ -1 +0,0 @@
-export * from './coins';

package/dist/coins/index.js

@@ -1 +0,0 @@
-export * from './coins';

package/dist/multicall.d.ts

@@ -1,3 +0,0 @@
-export declare const multicallAddresses: {
-    [ChainId: number]: string;
-};