@metamask/assets-controllers 1.0.0

package/dist/assetsUtil.d.ts

@@ -0,0 +1,106 @@
+/// <reference types="bn.js" />
+import { BigNumber } from '@ethersproject/bignumber';
+import { BN } from 'ethereumjs-util';
+import { Nft, NftMetadata } from './NftController';
+import { Token } from './TokenRatesController';
+/**
+ * Compares nft metadata entries to any nft entry.
+ * We need this method when comparing a new fetched nft metadata, in case a entry changed to a defined value,
+ * there's a need to update the nft in state.
+ *
+ * @param newNftMetadata - Nft metadata object.
+ * @param nft - Nft object to compare with.
+ * @returns Whether there are differences.
+ */
+export declare function compareNftMetadata(newNftMetadata: NftMetadata, nft: Nft): boolean;
+/**
+ * Formats aggregator names to presentable format.
+ *
+ * @param aggregators - List of token list names in camelcase.
+ * @returns Formatted aggregator names.
+ */
+export declare const formatAggregatorNames: (aggregators: string[]) => string[];
+/**
+ * Format token list assets to use image proxy from Codefi.
+ *
+ * @param params - Object that contains chainID and tokenAddress.
+ * @param params.chainId - ChainID of network in decimal or hexadecimal format.
+ * @param params.tokenAddress - Address of token in mixed or lowercase.
+ * @returns Formatted image url
+ */
+export declare const formatIconUrlWithProxy: ({ chainId, tokenAddress, }: {
+    chainId: string;
+    tokenAddress: string;
+}) => string;
+/**
+ * Validates a ERC20 token to be added with EIP747.
+ *
+ * @param token - Token object to validate.
+ */
+export declare function validateTokenToWatch(token: Token): void;
+/**
+ * Networks where token detection is supported - Values are in decimal format
+ */
+export declare enum SupportedTokenDetectionNetworks {
+    mainnet = "1",
+    bsc = "56",
+    polygon = "137",
+    avax = "43114"
+}
+/**
+ * Check if token detection is enabled for certain networks.
+ *
+ * @param chainId - ChainID of network
+ * @returns Whether the current network supports token detection
+ */
+export declare function isTokenDetectionSupportedForNetwork(chainId: string): boolean;
+/**
+ * Check if token list polling is enabled for a given network.
+ * Currently this method is used to support e2e testing for consumers of this package.
+ *
+ * @param chainId - ChainID of network
+ * @returns Whether the current network supports tokenlists
+ */
+export declare function isTokenListSupportedForNetwork(chainId: string): boolean;
+/**
+ * Removes IPFS protocol prefix from input string.
+ *
+ * @param ipfsUrl - An IPFS url (e.g. ipfs://{content id})
+ * @returns IPFS content identifier and (possibly) path in a string
+ * @throws Will throw if the url passed is not IPFS.
+ */
+export declare function removeIpfsProtocolPrefix(ipfsUrl: string): string;
+/**
+ * Extracts content identifier and path from an input string.
+ *
+ * @param ipfsUrl - An IPFS URL minus the IPFS protocol prefix
+ * @returns IFPS content identifier (cid) and sub path as string.
+ * @throws Will throw if the url passed is not ipfs.
+ */
+export declare function getIpfsCIDv1AndPath(ipfsUrl: string): {
+    cid: string;
+    path?: string;
+};
+/**
+ * Formats URL correctly for use retrieving assets hosted on IPFS.
+ *
+ * @param ipfsGateway - The users preferred IPFS gateway (full URL or just host).
+ * @param ipfsUrl - The IFPS URL pointed at the asset.
+ * @param subdomainSupported - Boolean indicating whether the URL should be formatted with subdomains or not.
+ * @returns A formatted URL, with the user's preferred IPFS gateway and format (subdomain or not), pointing to an asset hosted on IPFS.
+ */
+export declare function getFormattedIpfsUrl(ipfsGateway: string, ipfsUrl: string, subdomainSupported: boolean): string;
+/**
+ * Adds URL protocol prefix to input URL string if missing.
+ *
+ * @param urlString - An IPFS URL.
+ * @returns A URL with a https:// prepended.
+ */
+export declare function addUrlProtocolPrefix(urlString: string): string;
+/**
+ * Converts an Ethers BigNumber to a BN.
+ *
+ * @param bigNumber - An Ethers BigNumber instance.
+ * @returns A BN object.
+ */
+export declare function ethersBigNumberToBN(bigNumber: BigNumber): BN;

package/dist/assetsUtil.js

@@ -0,0 +1,228 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ethersBigNumberToBN = exports.addUrlProtocolPrefix = exports.getFormattedIpfsUrl = exports.getIpfsCIDv1AndPath = exports.removeIpfsProtocolPrefix = exports.isTokenListSupportedForNetwork = exports.isTokenDetectionSupportedForNetwork = exports.SupportedTokenDetectionNetworks = exports.validateTokenToWatch = exports.formatIconUrlWithProxy = exports.formatAggregatorNames = exports.compareNftMetadata = void 0;
+const eth_rpc_errors_1 = require("eth-rpc-errors");
+const cid_1 = require("multiformats/cid");
+const controller_utils_1 = require("@metamask/controller-utils");
+const ethereumjs_util_1 = require("ethereumjs-util");
+/**
+ * Compares nft metadata entries to any nft entry.
+ * We need this method when comparing a new fetched nft metadata, in case a entry changed to a defined value,
+ * there's a need to update the nft in state.
+ *
+ * @param newNftMetadata - Nft metadata object.
+ * @param nft - Nft object to compare with.
+ * @returns Whether there are differences.
+ */
+function compareNftMetadata(newNftMetadata, nft) {
+    const keys = [
+        'image',
+        'backgroundColor',
+        'imagePreview',
+        'imageThumbnail',
+        'imageOriginal',
+        'animation',
+        'animationOriginal',
+        'externalLink',
+    ];
+    const differentValues = keys.reduce((value, key) => {
+        if (newNftMetadata[key] && newNftMetadata[key] !== nft[key]) {
+            return value + 1;
+        }
+        return value;
+    }, 0);
+    return differentValues > 0;
+}
+exports.compareNftMetadata = compareNftMetadata;
+const aggregatorNameByKey = {
+    aave: 'Aave',
+    bancor: 'Bancor',
+    cmc: 'CMC',
+    cryptocom: 'Crypto.com',
+    coinGecko: 'CoinGecko',
+    oneInch: '1inch',
+    paraswap: 'Paraswap',
+    pmm: 'PMM',
+    zapper: 'Zapper',
+    zerion: 'Zerion',
+    zeroEx: '0x',
+    synthetix: 'Synthetix',
+    yearn: 'Yearn',
+    apeswap: 'ApeSwap',
+    binanceDex: 'BinanceDex',
+    pancakeTop100: 'PancakeTop100',
+    pancakeExtended: 'PancakeExtended',
+    balancer: 'Balancer',
+    quickswap: 'QuickSwap',
+    matcha: 'Matcha',
+    pangolinDex: 'PangolinDex',
+    pangolinDexStableCoin: 'PangolinDexStableCoin',
+    pangolinDexAvaxBridge: 'PangolinDexAvaxBridge',
+    traderJoe: 'TraderJoe',
+    airswapLight: 'AirswapLight',
+    kleros: 'Kleros',
+};
+/**
+ * Formats aggregator names to presentable format.
+ *
+ * @param aggregators - List of token list names in camelcase.
+ * @returns Formatted aggregator names.
+ */
+const formatAggregatorNames = (aggregators) => {
+    return aggregators.map((key) => aggregatorNameByKey[key] ||
+        `${key[0].toUpperCase()}${key.substring(1, key.length)}`);
+};
+exports.formatAggregatorNames = formatAggregatorNames;
+/**
+ * Format token list assets to use image proxy from Codefi.
+ *
+ * @param params - Object that contains chainID and tokenAddress.
+ * @param params.chainId - ChainID of network in decimal or hexadecimal format.
+ * @param params.tokenAddress - Address of token in mixed or lowercase.
+ * @returns Formatted image url
+ */
+const formatIconUrlWithProxy = ({ chainId, tokenAddress, }) => {
+    const chainIdDecimal = (0, controller_utils_1.convertHexToDecimal)(chainId).toString();
+    return `https://static.metaswap.codefi.network/api/v1/tokenIcons/${chainIdDecimal}/${tokenAddress.toLowerCase()}.png`;
+};
+exports.formatIconUrlWithProxy = formatIconUrlWithProxy;
+/**
+ * Validates a ERC20 token to be added with EIP747.
+ *
+ * @param token - Token object to validate.
+ */
+function validateTokenToWatch(token) {
+    const { address, symbol, decimals } = token;
+    if (!address || !symbol || typeof decimals === 'undefined') {
+        throw eth_rpc_errors_1.ethErrors.rpc.invalidParams(`Must specify address, symbol, and decimals.`);
+    }
+    if (typeof symbol !== 'string') {
+        throw eth_rpc_errors_1.ethErrors.rpc.invalidParams(`Invalid symbol: not a string.`);
+    }
+    if (symbol.length > 11) {
+        throw eth_rpc_errors_1.ethErrors.rpc.invalidParams(`Invalid symbol "${symbol}": longer than 11 characters.`);
+    }
+    const numDecimals = parseInt(decimals, 10);
+    if (isNaN(numDecimals) || numDecimals > 36 || numDecimals < 0) {
+        throw eth_rpc_errors_1.ethErrors.rpc.invalidParams(`Invalid decimals "${decimals}": must be 0 <= 36.`);
+    }
+    if (!(0, controller_utils_1.isValidHexAddress)(address)) {
+        throw eth_rpc_errors_1.ethErrors.rpc.invalidParams(`Invalid address "${address}".`);
+    }
+}
+exports.validateTokenToWatch = validateTokenToWatch;
+/**
+ * Networks where token detection is supported - Values are in decimal format
+ */
+var SupportedTokenDetectionNetworks;
+(function (SupportedTokenDetectionNetworks) {
+    SupportedTokenDetectionNetworks["mainnet"] = "1";
+    SupportedTokenDetectionNetworks["bsc"] = "56";
+    SupportedTokenDetectionNetworks["polygon"] = "137";
+    SupportedTokenDetectionNetworks["avax"] = "43114";
+})(SupportedTokenDetectionNetworks = exports.SupportedTokenDetectionNetworks || (exports.SupportedTokenDetectionNetworks = {}));
+/**
+ * Check if token detection is enabled for certain networks.
+ *
+ * @param chainId - ChainID of network
+ * @returns Whether the current network supports token detection
+ */
+function isTokenDetectionSupportedForNetwork(chainId) {
+    return Object.values(SupportedTokenDetectionNetworks).includes(chainId);
+}
+exports.isTokenDetectionSupportedForNetwork = isTokenDetectionSupportedForNetwork;
+/**
+ * Check if token list polling is enabled for a given network.
+ * Currently this method is used to support e2e testing for consumers of this package.
+ *
+ * @param chainId - ChainID of network
+ * @returns Whether the current network supports tokenlists
+ */
+function isTokenListSupportedForNetwork(chainId) {
+    const chainIdDecimal = (0, controller_utils_1.convertHexToDecimal)(chainId).toString();
+    return (isTokenDetectionSupportedForNetwork(chainIdDecimal) ||
+        chainIdDecimal === controller_utils_1.GANACHE_CHAIN_ID);
+}
+exports.isTokenListSupportedForNetwork = isTokenListSupportedForNetwork;
+/**
+ * Removes IPFS protocol prefix from input string.
+ *
+ * @param ipfsUrl - An IPFS url (e.g. ipfs://{content id})
+ * @returns IPFS content identifier and (possibly) path in a string
+ * @throws Will throw if the url passed is not IPFS.
+ */
+function removeIpfsProtocolPrefix(ipfsUrl) {
+    if (ipfsUrl.startsWith('ipfs://ipfs/')) {
+        return ipfsUrl.replace('ipfs://ipfs/', '');
+    }
+    else if (ipfsUrl.startsWith('ipfs://')) {
+        return ipfsUrl.replace('ipfs://', '');
+    }
+    // this method should not be used with non-ipfs urls (i.e. startsWith('ipfs://') === true)
+    throw new Error('this method should not be used with non ipfs urls');
+}
+exports.removeIpfsProtocolPrefix = removeIpfsProtocolPrefix;
+/**
+ * Extracts content identifier and path from an input string.
+ *
+ * @param ipfsUrl - An IPFS URL minus the IPFS protocol prefix
+ * @returns IFPS content identifier (cid) and sub path as string.
+ * @throws Will throw if the url passed is not ipfs.
+ */
+function getIpfsCIDv1AndPath(ipfsUrl) {
+    const url = removeIpfsProtocolPrefix(ipfsUrl);
+    // check if there is a path
+    // (CID is everything preceding first forward slash, path is everything after)
+    const index = url.indexOf('/');
+    const cid = index !== -1 ? url.substring(0, index) : url;
+    const path = index !== -1 ? url.substring(index) : undefined;
+    // We want to ensure that the CID is v1 (https://docs.ipfs.io/concepts/content-addressing/#identifier-formats)
+    // because most cid v0s appear to be incompatible with IPFS subdomains
+    return {
+        cid: cid_1.CID.parse(cid).toV1().toString(),
+        path,
+    };
+}
+exports.getIpfsCIDv1AndPath = getIpfsCIDv1AndPath;
+/**
+ * Formats URL correctly for use retrieving assets hosted on IPFS.
+ *
+ * @param ipfsGateway - The users preferred IPFS gateway (full URL or just host).
+ * @param ipfsUrl - The IFPS URL pointed at the asset.
+ * @param subdomainSupported - Boolean indicating whether the URL should be formatted with subdomains or not.
+ * @returns A formatted URL, with the user's preferred IPFS gateway and format (subdomain or not), pointing to an asset hosted on IPFS.
+ */
+function getFormattedIpfsUrl(ipfsGateway, ipfsUrl, subdomainSupported) {
+    const { host, protocol, origin } = new URL(addUrlProtocolPrefix(ipfsGateway));
+    if (subdomainSupported) {
+        const { cid, path } = getIpfsCIDv1AndPath(ipfsUrl);
+        return `${protocol}//${cid}.ipfs.${host}${path !== null && path !== void 0 ? path : ''}`;
+    }
+    const cidAndPath = removeIpfsProtocolPrefix(ipfsUrl);
+    return `${origin}/ipfs/${cidAndPath}`;
+}
+exports.getFormattedIpfsUrl = getFormattedIpfsUrl;
+/**
+ * Adds URL protocol prefix to input URL string if missing.
+ *
+ * @param urlString - An IPFS URL.
+ * @returns A URL with a https:// prepended.
+ */
+function addUrlProtocolPrefix(urlString) {
+    if (!urlString.match(/(^http:\/\/)|(^https:\/\/)/u)) {
+        return `https://${urlString}`;
+    }
+    return urlString;
+}
+exports.addUrlProtocolPrefix = addUrlProtocolPrefix;
+/**
+ * Converts an Ethers BigNumber to a BN.
+ *
+ * @param bigNumber - An Ethers BigNumber instance.
+ * @returns A BN object.
+ */
+function ethersBigNumberToBN(bigNumber) {
+    return new ethereumjs_util_1.BN((0, ethereumjs_util_1.stripHexPrefix)(bigNumber.toHexString()), 'hex');
+}
+exports.ethersBigNumberToBN = ethersBigNumberToBN;
+//# sourceMappingURL=assetsUtil.js.map

package/dist/assetsUtil.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"assetsUtil.js","sourceRoot":"","sources":["../src/assetsUtil.ts"],"names":[],"mappings":";;;AAAA,mDAA2C;AAC3C,0CAAuC;AACvC,iEAIoC;AAEpC,qDAAqD;AAIrD;;;;;;;;GAQG;AACH,SAAgB,kBAAkB,CAAC,cAA2B,EAAE,GAAQ;IACtE,MAAM,IAAI,GAA0B;QAClC,OAAO;QACP,iBAAiB;QACjB,cAAc;QACd,gBAAgB;QAChB,eAAe;QACf,WAAW;QACX,mBAAmB;QACnB,cAAc;KACf,CAAC;IACF,MAAM,eAAe,GAAG,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,GAAG,EAAE,EAAE;QACjD,IAAI,cAAc,CAAC,GAAG,CAAC,IAAI,cAAc,CAAC,GAAG,CAAC,KAAK,GAAG,CAAC,GAAG,CAAC,EAAE;YAC3D,OAAO,KAAK,GAAG,CAAC,CAAC;SAClB;QACD,OAAO,KAAK,CAAC;IACf,CAAC,EAAE,CAAC,CAAC,CAAC;IACN,OAAO,eAAe,GAAG,CAAC,CAAC;AAC7B,CAAC;AAlBD,gDAkBC;AAED,MAAM,mBAAmB,GAA2B;IAClD,IAAI,EAAE,MAAM;IACZ,MAAM,EAAE,QAAQ;IAChB,GAAG,EAAE,KAAK;IACV,SAAS,EAAE,YAAY;IACvB,SAAS,EAAE,WAAW;IACtB,OAAO,EAAE,OAAO;IAChB,QAAQ,EAAE,UAAU;IACpB,GAAG,EAAE,KAAK;IACV,MAAM,EAAE,QAAQ;IAChB,MAAM,EAAE,QAAQ;IAChB,MAAM,EAAE,IAAI;IACZ,SAAS,EAAE,WAAW;IACtB,KAAK,EAAE,OAAO;IACd,OAAO,EAAE,SAAS;IAClB,UAAU,EAAE,YAAY;IACxB,aAAa,EAAE,eAAe;IAC9B,eAAe,EAAE,iBAAiB;IAClC,QAAQ,EAAE,UAAU;IACpB,SAAS,EAAE,WAAW;IACtB,MAAM,EAAE,QAAQ;IAChB,WAAW,EAAE,aAAa;IAC1B,qBAAqB,EAAE,uBAAuB;IAC9C,qBAAqB,EAAE,uBAAuB;IAC9C,SAAS,EAAE,WAAW;IACtB,YAAY,EAAE,cAAc;IAC5B,MAAM,EAAE,QAAQ;CACjB,CAAC;AAEF;;;;;GAKG;AACI,MAAM,qBAAqB,GAAG,CAAC,WAAqB,EAAE,EAAE;IAC7D,OAAO,WAAW,CAAC,GAAG,CACpB,CAAC,GAAG,EAAE,EAAE,CACN,mBAAmB,CAAC,GAAG,CAAC;QACxB,GAAG,GAAG,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,GAAG,GAAG,CAAC,SAAS,CAAC,CAAC,EAAE,GAAG,CAAC,MAAM,CAAC,EAAE,CAC3D,CAAC;AACJ,CAAC,CAAC;AANW,QAAA,qBAAqB,yBAMhC;AAEF;;;;;;;GAOG;AACI,MAAM,sBAAsB,GAAG,CAAC,EACrC,OAAO,EACP,YAAY,GAIb,EAAE,EAAE;IACH,MAAM,cAAc,GAAG,IAAA,sCAAmB,EAAC,OAAO,CAAC,CAAC,QAAQ,EAAE,CAAC;IAC/D,OAAO,4DAA4D,cAAc,IAAI,YAAY,CAAC,WAAW,EAAE,MAAM,CAAC;AACxH,CAAC,CAAC;AATW,QAAA,sBAAsB,0BASjC;AAEF;;;;GAIG;AACH,SAAgB,oBAAoB,CAAC,KAAY;IAC/C,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,GAAG,KAAK,CAAC;IAC5C,IAAI,CAAC,OAAO,IAAI,CAAC,MAAM,IAAI,OAAO,QAAQ,KAAK,WAAW,EAAE;QAC1D,MAAM,0BAAS,CAAC,GAAG,CAAC,aAAa,CAC/B,6CAA6C,CAC9C,CAAC;KACH;IAED,IAAI,OAAO,MAAM,KAAK,QAAQ,EAAE;QAC9B,MAAM,0BAAS,CAAC,GAAG,CAAC,aAAa,CAAC,+BAA+B,CAAC,CAAC;KACpE;IAED,IAAI,MAAM,CAAC,MAAM,GAAG,EAAE,EAAE;QACtB,MAAM,0BAAS,CAAC,GAAG,CAAC,aAAa,CAC/B,mBAAmB,MAAM,+BAA+B,CACzD,CAAC;KACH;IACD,MAAM,WAAW,GAAG,QAAQ,CAAC,QAA6B,EAAE,EAAE,CAAC,CAAC;IAChE,IAAI,KAAK,CAAC,WAAW,CAAC,IAAI,WAAW,GAAG,EAAE,IAAI,WAAW,GAAG,CAAC,EAAE;QAC7D,MAAM,0BAAS,CAAC,GAAG,CAAC,aAAa,CAC/B,qBAAqB,QAAQ,qBAAqB,CACnD,CAAC;KACH;IAED,IAAI,CAAC,IAAA,oCAAiB,EAAC,OAAO,CAAC,EAAE;QAC/B,MAAM,0BAAS,CAAC,GAAG,CAAC,aAAa,CAAC,oBAAoB,OAAO,IAAI,CAAC,CAAC;KACpE;AACH,CAAC;AA3BD,oDA2BC;AAED;;GAEG;AACH,IAAY,+BAKX;AALD,WAAY,+BAA+B;IACzC,gDAAa,CAAA;IACb,6CAAU,CAAA;IACV,kDAAe,CAAA;IACf,iDAAc,CAAA;AAChB,CAAC,EALW,+BAA+B,GAA/B,uCAA+B,KAA/B,uCAA+B,QAK1C;AAED;;;;;GAKG;AACH,SAAgB,mCAAmC,CAAC,OAAe;IACjE,OAAO,MAAM,CAAC,MAAM,CAAS,+BAA+B,CAAC,CAAC,QAAQ,CACpE,OAAO,CACR,CAAC;AACJ,CAAC;AAJD,kFAIC;AAED;;;;;;GAMG;AACH,SAAgB,8BAA8B,CAAC,OAAe;IAC5D,MAAM,cAAc,GAAG,IAAA,sCAAmB,EAAC,OAAO,CAAC,CAAC,QAAQ,EAAE,CAAC;IAC/D,OAAO,CACL,mCAAmC,CAAC,cAAc,CAAC;QACnD,cAAc,KAAK,mCAAgB,CACpC,CAAC;AACJ,CAAC;AAND,wEAMC;AAED;;;;;;GAMG;AACH,SAAgB,wBAAwB,CAAC,OAAe;IACtD,IAAI,OAAO,CAAC,UAAU,CAAC,cAAc,CAAC,EAAE;QACtC,OAAO,OAAO,CAAC,OAAO,CAAC,cAAc,EAAE,EAAE,CAAC,CAAC;KAC5C;SAAM,IAAI,OAAO,CAAC,UAAU,CAAC,SAAS,CAAC,EAAE;QACxC,OAAO,OAAO,CAAC,OAAO,CAAC,SAAS,EAAE,EAAE,CAAC,CAAC;KACvC;IACD,0FAA0F;IAC1F,MAAM,IAAI,KAAK,CAAC,mDAAmD,CAAC,CAAC;AACvE,CAAC;AARD,4DAQC;AAED;;;;;;GAMG;AACH,SAAgB,mBAAmB,CAAC,OAAe;IAIjD,MAAM,GAAG,GAAG,wBAAwB,CAAC,OAAO,CAAC,CAAC;IAE9C,2BAA2B;IAC3B,8EAA8E;IAC9E,MAAM,KAAK,GAAG,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;IAC/B,MAAM,GAAG,GAAG,KAAK,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC;IACzD,MAAM,IAAI,GAAG,KAAK,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;IAE7D,8GAA8G;IAC9G,sEAAsE;IACtE,OAAO;QACL,GAAG,EAAE,SAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,CAAC,QAAQ,EAAE;QACrC,IAAI;KACL,CAAC;AACJ,CAAC;AAlBD,kDAkBC;AAED;;;;;;;GAOG;AACH,SAAgB,mBAAmB,CACjC,WAAmB,EACnB,OAAe,EACf,kBAA2B;IAE3B,MAAM,EAAE,IAAI,EAAE,QAAQ,EAAE,MAAM,EAAE,GAAG,IAAI,GAAG,CAAC,oBAAoB,CAAC,WAAW,CAAC,CAAC,CAAC;IAC9E,IAAI,kBAAkB,EAAE;QACtB,MAAM,EAAE,GAAG,EAAE,IAAI,EAAE,GAAG,mBAAmB,CAAC,OAAO,CAAC,CAAC;QACnD,OAAO,GAAG,QAAQ,KAAK,GAAG,SAAS,IAAI,GAAG,IAAI,aAAJ,IAAI,cAAJ,IAAI,GAAI,EAAE,EAAE,CAAC;KACxD;IACD,MAAM,UAAU,GAAG,wBAAwB,CAAC,OAAO,CAAC,CAAC;IACrD,OAAO,GAAG,MAAM,SAAS,UAAU,EAAE,CAAC;AACxC,CAAC;AAZD,kDAYC;AAED;;;;;GAKG;AACH,SAAgB,oBAAoB,CAAC,SAAiB;IACpD,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,6BAA6B,CAAC,EAAE;QACnD,OAAO,WAAW,SAAS,EAAE,CAAC;KAC/B;IACD,OAAO,SAAS,CAAC;AACnB,CAAC;AALD,oDAKC;AAED;;;;;GAKG;AACH,SAAgB,mBAAmB,CAAC,SAAoB;IACtD,OAAO,IAAI,oBAAE,CAAC,IAAA,gCAAc,EAAC,SAAS,CAAC,WAAW,EAAE,CAAC,EAAE,KAAK,CAAC,CAAC;AAChE,CAAC;AAFD,kDAEC","sourcesContent":["import { ethErrors } from 'eth-rpc-errors';\nimport { CID } from 'multiformats/cid';\nimport {\n  convertHexToDecimal,\n  isValidHexAddress,\n  GANACHE_CHAIN_ID,\n} from '@metamask/controller-utils';\nimport { BigNumber } from '@ethersproject/bignumber';\nimport { BN, stripHexPrefix } from 'ethereumjs-util';\nimport { Nft, NftMetadata } from './NftController';\nimport { Token } from './TokenRatesController';\n\n/**\n * Compares nft metadata entries to any nft entry.\n * We need this method when comparing a new fetched nft metadata, in case a entry changed to a defined value,\n * there's a need to update the nft in state.\n *\n * @param newNftMetadata - Nft metadata object.\n * @param nft - Nft object to compare with.\n * @returns Whether there are differences.\n */\nexport function compareNftMetadata(newNftMetadata: NftMetadata, nft: Nft) {\n  const keys: (keyof NftMetadata)[] = [\n    'image',\n    'backgroundColor',\n    'imagePreview',\n    'imageThumbnail',\n    'imageOriginal',\n    'animation',\n    'animationOriginal',\n    'externalLink',\n  ];\n  const differentValues = keys.reduce((value, key) => {\n    if (newNftMetadata[key] && newNftMetadata[key] !== nft[key]) {\n      return value + 1;\n    }\n    return value;\n  }, 0);\n  return differentValues > 0;\n}\n\nconst aggregatorNameByKey: Record<string, string> = {\n  aave: 'Aave',\n  bancor: 'Bancor',\n  cmc: 'CMC',\n  cryptocom: 'Crypto.com',\n  coinGecko: 'CoinGecko',\n  oneInch: '1inch',\n  paraswap: 'Paraswap',\n  pmm: 'PMM',\n  zapper: 'Zapper',\n  zerion: 'Zerion',\n  zeroEx: '0x',\n  synthetix: 'Synthetix',\n  yearn: 'Yearn',\n  apeswap: 'ApeSwap',\n  binanceDex: 'BinanceDex',\n  pancakeTop100: 'PancakeTop100',\n  pancakeExtended: 'PancakeExtended',\n  balancer: 'Balancer',\n  quickswap: 'QuickSwap',\n  matcha: 'Matcha',\n  pangolinDex: 'PangolinDex',\n  pangolinDexStableCoin: 'PangolinDexStableCoin',\n  pangolinDexAvaxBridge: 'PangolinDexAvaxBridge',\n  traderJoe: 'TraderJoe',\n  airswapLight: 'AirswapLight',\n  kleros: 'Kleros',\n};\n\n/**\n * Formats aggregator names to presentable format.\n *\n * @param aggregators - List of token list names in camelcase.\n * @returns Formatted aggregator names.\n */\nexport const formatAggregatorNames = (aggregators: string[]) => {\n  return aggregators.map(\n    (key) =>\n      aggregatorNameByKey[key] ||\n      `${key[0].toUpperCase()}${key.substring(1, key.length)}`,\n  );\n};\n\n/**\n * Format token list assets to use image proxy from Codefi.\n *\n * @param params - Object that contains chainID and tokenAddress.\n * @param params.chainId - ChainID of network in decimal or hexadecimal format.\n * @param params.tokenAddress - Address of token in mixed or lowercase.\n * @returns Formatted image url\n */\nexport const formatIconUrlWithProxy = ({\n  chainId,\n  tokenAddress,\n}: {\n  chainId: string;\n  tokenAddress: string;\n}) => {\n  const chainIdDecimal = convertHexToDecimal(chainId).toString();\n  return `https://static.metaswap.codefi.network/api/v1/tokenIcons/${chainIdDecimal}/${tokenAddress.toLowerCase()}.png`;\n};\n\n/**\n * Validates a ERC20 token to be added with EIP747.\n *\n * @param token - Token object to validate.\n */\nexport function validateTokenToWatch(token: Token) {\n  const { address, symbol, decimals } = token;\n  if (!address || !symbol || typeof decimals === 'undefined') {\n    throw ethErrors.rpc.invalidParams(\n      `Must specify address, symbol, and decimals.`,\n    );\n  }\n\n  if (typeof symbol !== 'string') {\n    throw ethErrors.rpc.invalidParams(`Invalid symbol: not a string.`);\n  }\n\n  if (symbol.length > 11) {\n    throw ethErrors.rpc.invalidParams(\n      `Invalid symbol \"${symbol}\": longer than 11 characters.`,\n    );\n  }\n  const numDecimals = parseInt(decimals as unknown as string, 10);\n  if (isNaN(numDecimals) || numDecimals > 36 || numDecimals < 0) {\n    throw ethErrors.rpc.invalidParams(\n      `Invalid decimals \"${decimals}\": must be 0 <= 36.`,\n    );\n  }\n\n  if (!isValidHexAddress(address)) {\n    throw ethErrors.rpc.invalidParams(`Invalid address \"${address}\".`);\n  }\n}\n\n/**\n * Networks where token detection is supported - Values are in decimal format\n */\nexport enum SupportedTokenDetectionNetworks {\n  mainnet = '1',\n  bsc = '56',\n  polygon = '137',\n  avax = '43114',\n}\n\n/**\n * Check if token detection is enabled for certain networks.\n *\n * @param chainId - ChainID of network\n * @returns Whether the current network supports token detection\n */\nexport function isTokenDetectionSupportedForNetwork(chainId: string): boolean {\n  return Object.values<string>(SupportedTokenDetectionNetworks).includes(\n    chainId,\n  );\n}\n\n/**\n * Check if token list polling is enabled for a given network.\n * Currently this method is used to support e2e testing for consumers of this package.\n *\n * @param chainId - ChainID of network\n * @returns Whether the current network supports tokenlists\n */\nexport function isTokenListSupportedForNetwork(chainId: string): boolean {\n  const chainIdDecimal = convertHexToDecimal(chainId).toString();\n  return (\n    isTokenDetectionSupportedForNetwork(chainIdDecimal) ||\n    chainIdDecimal === GANACHE_CHAIN_ID\n  );\n}\n\n/**\n * Removes IPFS protocol prefix from input string.\n *\n * @param ipfsUrl - An IPFS url (e.g. ipfs://{content id})\n * @returns IPFS content identifier and (possibly) path in a string\n * @throws Will throw if the url passed is not IPFS.\n */\nexport function removeIpfsProtocolPrefix(ipfsUrl: string) {\n  if (ipfsUrl.startsWith('ipfs://ipfs/')) {\n    return ipfsUrl.replace('ipfs://ipfs/', '');\n  } else if (ipfsUrl.startsWith('ipfs://')) {\n    return ipfsUrl.replace('ipfs://', '');\n  }\n  // this method should not be used with non-ipfs urls (i.e. startsWith('ipfs://') === true)\n  throw new Error('this method should not be used with non ipfs urls');\n}\n\n/**\n * Extracts content identifier and path from an input string.\n *\n * @param ipfsUrl - An IPFS URL minus the IPFS protocol prefix\n * @returns IFPS content identifier (cid) and sub path as string.\n * @throws Will throw if the url passed is not ipfs.\n */\nexport function getIpfsCIDv1AndPath(ipfsUrl: string): {\n  cid: string;\n  path?: string;\n} {\n  const url = removeIpfsProtocolPrefix(ipfsUrl);\n\n  // check if there is a path\n  // (CID is everything preceding first forward slash, path is everything after)\n  const index = url.indexOf('/');\n  const cid = index !== -1 ? url.substring(0, index) : url;\n  const path = index !== -1 ? url.substring(index) : undefined;\n\n  // We want to ensure that the CID is v1 (https://docs.ipfs.io/concepts/content-addressing/#identifier-formats)\n  // because most cid v0s appear to be incompatible with IPFS subdomains\n  return {\n    cid: CID.parse(cid).toV1().toString(),\n    path,\n  };\n}\n\n/**\n * Formats URL correctly for use retrieving assets hosted on IPFS.\n *\n * @param ipfsGateway - The users preferred IPFS gateway (full URL or just host).\n * @param ipfsUrl - The IFPS URL pointed at the asset.\n * @param subdomainSupported - Boolean indicating whether the URL should be formatted with subdomains or not.\n * @returns A formatted URL, with the user's preferred IPFS gateway and format (subdomain or not), pointing to an asset hosted on IPFS.\n */\nexport function getFormattedIpfsUrl(\n  ipfsGateway: string,\n  ipfsUrl: string,\n  subdomainSupported: boolean,\n): string {\n  const { host, protocol, origin } = new URL(addUrlProtocolPrefix(ipfsGateway));\n  if (subdomainSupported) {\n    const { cid, path } = getIpfsCIDv1AndPath(ipfsUrl);\n    return `${protocol}//${cid}.ipfs.${host}${path ?? ''}`;\n  }\n  const cidAndPath = removeIpfsProtocolPrefix(ipfsUrl);\n  return `${origin}/ipfs/${cidAndPath}`;\n}\n\n/**\n * Adds URL protocol prefix to input URL string if missing.\n *\n * @param urlString - An IPFS URL.\n * @returns A URL with a https:// prepended.\n */\nexport function addUrlProtocolPrefix(urlString: string): string {\n  if (!urlString.match(/(^http:\\/\\/)|(^https:\\/\\/)/u)) {\n    return `https://${urlString}`;\n  }\n  return urlString;\n}\n\n/**\n * Converts an Ethers BigNumber to a BN.\n *\n * @param bigNumber - An Ethers BigNumber instance.\n * @returns A BN object.\n */\nexport function ethersBigNumberToBN(bigNumber: BigNumber): BN {\n  return new BN(stripHexPrefix(bigNumber.toHexString()), 'hex');\n}\n"]}

package/dist/crypto-compare.d.ts

@@ -0,0 +1,12 @@
+/**
+ * Fetches the exchange rate for a given currency.
+ *
+ * @param currency - ISO 4217 currency code.
+ * @param nativeCurrency - Symbol for base asset.
+ * @param includeUSDRate - Whether to add the USD rate to the fetch.
+ * @returns Promise resolving to exchange rate for given currency.
+ */
+export declare function fetchExchangeRate(currency: string, nativeCurrency: string, includeUSDRate?: boolean): Promise<{
+    conversionRate: number;
+    usdConversionRate: number;
+}>;

package/dist/crypto-compare.js

@@ -0,0 +1,67 @@
+"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 });
+exports.fetchExchangeRate = void 0;
+const controller_utils_1 = require("@metamask/controller-utils");
+/**
+ * Get the CryptoCompare API URL for getting the conversion rate from the given native currency to
+ * the given currency. Optionally, the conversion rate from the native currency to USD can also be
+ * included in the response.
+ *
+ * @param currentCurrency - The currency to get a conversion rate for.
+ * @param nativeCurrency - The native currency to convert from.
+ * @param includeUSDRate - Whether or not the native currency to USD conversion rate should be
+ * included in the response as well.
+ * @returns The API URL for getting the conversion rate.
+ */
+function getPricingURL(currentCurrency, nativeCurrency, includeUSDRate) {
+    return (`https://min-api.cryptocompare.com/data/price?fsym=` +
+        `${nativeCurrency.toUpperCase()}&tsyms=${currentCurrency.toUpperCase()}` +
+        `${includeUSDRate && currentCurrency.toUpperCase() !== 'USD' ? ',USD' : ''}`);
+}
+/**
+ * Fetches the exchange rate for a given currency.
+ *
+ * @param currency - ISO 4217 currency code.
+ * @param nativeCurrency - Symbol for base asset.
+ * @param includeUSDRate - Whether to add the USD rate to the fetch.
+ * @returns Promise resolving to exchange rate for given currency.
+ */
+function fetchExchangeRate(currency, nativeCurrency, includeUSDRate) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const json = yield (0, controller_utils_1.handleFetch)(getPricingURL(currency, nativeCurrency, includeUSDRate));
+        /*
+        Example expected error response (if pair is not found)
+        {
+          Response: "Error",
+          Message: "cccagg_or_exchange market does not exist for this coin pair (ETH-<NON_EXISTENT_TOKEN>)",
+          HasWarning: false,
+        }
+        */
+        if (json.Response === 'Error') {
+            throw new Error(json.Message);
+        }
+        const conversionRate = Number(json[currency.toUpperCase()]);
+        const usdConversionRate = Number(json.USD);
+        if (!Number.isFinite(conversionRate)) {
+            throw new Error(`Invalid response for ${currency.toUpperCase()}: ${json[currency.toUpperCase()]}`);
+        }
+        if (includeUSDRate && !Number.isFinite(usdConversionRate)) {
+            throw new Error(`Invalid response for usdConversionRate: ${json.USD}`);
+        }
+        return {
+            conversionRate,
+            usdConversionRate,
+        };
+    });
+}
+exports.fetchExchangeRate = fetchExchangeRate;
+//# sourceMappingURL=crypto-compare.js.map

package/dist/crypto-compare.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"crypto-compare.js","sourceRoot":"","sources":["../src/crypto-compare.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,iEAAyD;AAEzD;;;;;;;;;;GAUG;AACH,SAAS,aAAa,CACpB,eAAuB,EACvB,cAAsB,EACtB,cAAwB;IAExB,OAAO,CACL,oDAAoD;QACpD,GAAG,cAAc,CAAC,WAAW,EAAE,UAAU,eAAe,CAAC,WAAW,EAAE,EAAE;QACxE,GAAG,cAAc,IAAI,eAAe,CAAC,WAAW,EAAE,KAAK,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAC7E,CAAC;AACJ,CAAC;AAED;;;;;;;GAOG;AACH,SAAsB,iBAAiB,CACrC,QAAgB,EAChB,cAAsB,EACtB,cAAwB;;QAKxB,MAAM,IAAI,GAAG,MAAM,IAAA,8BAAW,EAC5B,aAAa,CAAC,QAAQ,EAAE,cAAc,EAAE,cAAc,CAAC,CACxD,CAAC;QAEF;;;;;;;UAOE;QACF,IAAI,IAAI,CAAC,QAAQ,KAAK,OAAO,EAAE;YAC7B,MAAM,IAAI,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;SAC/B;QAED,MAAM,cAAc,GAAG,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC;QAE5D,MAAM,iBAAiB,GAAG,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QAC3C,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,cAAc,CAAC,EAAE;YACpC,MAAM,IAAI,KAAK,CACb,wBAAwB,QAAQ,CAAC,WAAW,EAAE,KAC5C,IAAI,CAAC,QAAQ,CAAC,WAAW,EAAE,CAC7B,EAAE,CACH,CAAC;SACH;QAED,IAAI,cAAc,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,iBAAiB,CAAC,EAAE;YACzD,MAAM,IAAI,KAAK,CAAC,2CAA2C,IAAI,CAAC,GAAG,EAAE,CAAC,CAAC;SACxE;QAED,OAAO;YACL,cAAc;YACd,iBAAiB;SAClB,CAAC;IACJ,CAAC;CAAA;AA3CD,8CA2CC","sourcesContent":["import { handleFetch } from '@metamask/controller-utils';\n\n/**\n * Get the CryptoCompare API URL for getting the conversion rate from the given native currency to\n * the given currency. Optionally, the conversion rate from the native currency to USD can also be\n * included in the response.\n *\n * @param currentCurrency - The currency to get a conversion rate for.\n * @param nativeCurrency - The native currency to convert from.\n * @param includeUSDRate - Whether or not the native currency to USD conversion rate should be\n * included in the response as well.\n * @returns The API URL for getting the conversion rate.\n */\nfunction getPricingURL(\n  currentCurrency: string,\n  nativeCurrency: string,\n  includeUSDRate?: boolean,\n) {\n  return (\n    `https://min-api.cryptocompare.com/data/price?fsym=` +\n    `${nativeCurrency.toUpperCase()}&tsyms=${currentCurrency.toUpperCase()}` +\n    `${includeUSDRate && currentCurrency.toUpperCase() !== 'USD' ? ',USD' : ''}`\n  );\n}\n\n/**\n * Fetches the exchange rate for a given currency.\n *\n * @param currency - ISO 4217 currency code.\n * @param nativeCurrency - Symbol for base asset.\n * @param includeUSDRate - Whether to add the USD rate to the fetch.\n * @returns Promise resolving to exchange rate for given currency.\n */\nexport async function fetchExchangeRate(\n  currency: string,\n  nativeCurrency: string,\n  includeUSDRate?: boolean,\n): Promise<{\n  conversionRate: number;\n  usdConversionRate: number;\n}> {\n  const json = await handleFetch(\n    getPricingURL(currency, nativeCurrency, includeUSDRate),\n  );\n\n  /*\n  Example expected error response (if pair is not found)\n  {\n    Response: \"Error\",\n    Message: \"cccagg_or_exchange market does not exist for this coin pair (ETH-<NON_EXISTENT_TOKEN>)\",\n    HasWarning: false,\n  }\n  */\n  if (json.Response === 'Error') {\n    throw new Error(json.Message);\n  }\n\n  const conversionRate = Number(json[currency.toUpperCase()]);\n\n  const usdConversionRate = Number(json.USD);\n  if (!Number.isFinite(conversionRate)) {\n    throw new Error(\n      `Invalid response for ${currency.toUpperCase()}: ${\n        json[currency.toUpperCase()]\n      }`,\n    );\n  }\n\n  if (includeUSDRate && !Number.isFinite(usdConversionRate)) {\n    throw new Error(`Invalid response for usdConversionRate: ${json.USD}`);\n  }\n\n  return {\n    conversionRate,\n    usdConversionRate,\n  };\n}\n"]}

package/dist/index.d.ts

@@ -0,0 +1,11 @@
+export * from './AccountTrackerController';
+export * from './AssetsContractController';
+export * from './CurrencyRateController';
+export * from './NftController';
+export * from './NftDetectionController';
+export * from './TokenBalancesController';
+export * from './TokenDetectionController';
+export * from './TokenListController';
+export * from './TokenRatesController';
+export * from './TokensController';
+export { formatIconUrlWithProxy, getFormattedIpfsUrl } from './assetsUtil';

package/dist/index.js

@@ -0,0 +1,31 @@
+"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 });
+exports.getFormattedIpfsUrl = exports.formatIconUrlWithProxy = void 0;
+__exportStar(require("./AccountTrackerController"), exports);
+__exportStar(require("./AssetsContractController"), exports);
+__exportStar(require("./CurrencyRateController"), exports);
+__exportStar(require("./NftController"), exports);
+__exportStar(require("./NftDetectionController"), exports);
+__exportStar(require("./TokenBalancesController"), exports);
+__exportStar(require("./TokenDetectionController"), exports);
+__exportStar(require("./TokenListController"), exports);
+__exportStar(require("./TokenRatesController"), exports);
+__exportStar(require("./TokensController"), exports);
+var assetsUtil_1 = require("./assetsUtil");
+Object.defineProperty(exports, "formatIconUrlWithProxy", { enumerable: true, get: function () { return assetsUtil_1.formatIconUrlWithProxy; } });
+Object.defineProperty(exports, "getFormattedIpfsUrl", { enumerable: true, get: function () { return assetsUtil_1.getFormattedIpfsUrl; } });
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;AAAA,6DAA2C;AAC3C,6DAA2C;AAC3C,2DAAyC;AACzC,kDAAgC;AAChC,2DAAyC;AACzC,4DAA0C;AAC1C,6DAA2C;AAC3C,wDAAsC;AACtC,yDAAuC;AACvC,qDAAmC;AACnC,2CAA2E;AAAlE,oHAAA,sBAAsB,OAAA;AAAE,iHAAA,mBAAmB,OAAA","sourcesContent":["export * from './AccountTrackerController';\nexport * from './AssetsContractController';\nexport * from './CurrencyRateController';\nexport * from './NftController';\nexport * from './NftDetectionController';\nexport * from './TokenBalancesController';\nexport * from './TokenDetectionController';\nexport * from './TokenListController';\nexport * from './TokenRatesController';\nexport * from './TokensController';\nexport { formatIconUrlWithProxy, getFormattedIpfsUrl } from './assetsUtil';\n"]}

package/dist/token-service.d.ts

@@ -0,0 +1,29 @@
+export declare const TOKEN_END_POINT_API = "https://token-api.metaswap.codefi.network";
+export declare const TOKEN_METADATA_NO_SUPPORT_ERROR = "TokenService Error: Network does not support fetchTokenMetadata";
+/**
+ * Fetch the list of token metadata for a given network. This request is cancellable using the
+ * abort signal passed in.
+ *
+ * @param chainId - The chain ID of the network the requested tokens are on.
+ * @param abortSignal - The abort signal used to cancel the request if necessary.
+ * @param options - Additional fetch options.
+ * @param options.timeout - The fetch timeout.
+ * @returns The token list, or `undefined` if the request was cancelled.
+ */
+export declare function fetchTokenList(chainId: string, abortSignal: AbortSignal, { timeout }?: {
+    timeout?: number | undefined;
+}): Promise<unknown>;
+/**
+ * Fetch metadata for the token address provided for a given network. This request is cancellable
+ * using the abort signal passed in.
+ *
+ * @param chainId - The chain ID of the network the token is on.
+ * @param tokenAddress - The address of the token to fetch metadata for.
+ * @param abortSignal - The abort signal used to cancel the request if necessary.
+ * @param options - Additional fetch options.
+ * @param options.timeout - The fetch timeout.
+ * @returns The token metadata, or `undefined` if the request was either aborted or failed.
+ */
+export declare function fetchTokenMetadata<T>(chainId: string, tokenAddress: string, abortSignal: AbortSignal, { timeout }?: {
+    timeout?: number | undefined;
+}): Promise<T | undefined>;