@metamask/assets-controllers 1.0.0

package/dist/TokenRatesController.js

@@ -0,0 +1,284 @@
+"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.TokenRatesController = void 0;
+const base_controller_1 = require("@metamask/base-controller");
+const controller_utils_1 = require("@metamask/controller-utils");
+const crypto_compare_1 = require("./crypto-compare");
+const CoinGeckoApi = {
+    BASE_URL: 'https://api.coingecko.com/api/v3',
+    getTokenPriceURL(chainSlug, query) {
+        return `${this.BASE_URL}/simple/token_price/${chainSlug}?${query}`;
+    },
+    getPlatformsURL() {
+        return `${this.BASE_URL}/asset_platforms`;
+    },
+    getSupportedVsCurrencies() {
+        return `${this.BASE_URL}/simple/supported_vs_currencies`;
+    },
+};
+/**
+ * Finds the chain slug in the data array given a chainId.
+ *
+ * @param chainId - The current chain ID.
+ * @param data - A list platforms supported by the CoinGecko API.
+ * @returns The CoinGecko slug for the given chain ID, or `null` if the slug was not found.
+ */
+function findChainSlug(chainId, data) {
+    var _a;
+    if (!data) {
+        return null;
+    }
+    const chain = (_a = data.find(({ chain_identifier }) => chain_identifier !== null && String(chain_identifier) === chainId)) !== null && _a !== void 0 ? _a : null;
+    return (chain === null || chain === void 0 ? void 0 : chain.id) || null;
+}
+/**
+ * Controller that passively polls on a set interval for token-to-fiat exchange rates
+ * for tokens stored in the TokensController
+ */
+class TokenRatesController extends base_controller_1.BaseController {
+    /**
+     * Creates a TokenRatesController instance.
+     *
+     * @param options - The controller options.
+     * @param options.onTokensStateChange - Allows subscribing to token controller state changes.
+     * @param options.onCurrencyRateStateChange - Allows subscribing to currency rate controller state changes.
+     * @param options.onNetworkStateChange - Allows subscribing to network state changes.
+     * @param config - Initial options used to configure this controller.
+     * @param state - Initial state to set on this controller.
+     */
+    constructor({ onTokensStateChange, onCurrencyRateStateChange, onNetworkStateChange, }, config, state) {
+        super(config, state);
+        this.tokenList = [];
+        this.supportedChains = {
+            timestamp: 0,
+            data: null,
+        };
+        this.supportedVsCurrencies = {
+            timestamp: 0,
+            data: [],
+        };
+        /**
+         * Name of this controller used during composition
+         */
+        this.name = 'TokenRatesController';
+        this.defaultConfig = {
+            disabled: true,
+            interval: 3 * 60 * 1000,
+            nativeCurrency: 'eth',
+            chainId: '',
+            tokens: [],
+            threshold: 6 * 60 * 60 * 1000,
+        };
+        this.defaultState = {
+            contractExchangeRates: {},
+        };
+        this.initialize();
+        this.configure({ disabled: false }, false, false);
+        onTokensStateChange(({ tokens, detectedTokens }) => {
+            this.configure({ tokens: [...tokens, ...detectedTokens] });
+        });
+        onCurrencyRateStateChange((currencyRateState) => {
+            this.configure({ nativeCurrency: currencyRateState.nativeCurrency });
+        });
+        onNetworkStateChange(({ provider }) => {
+            const { chainId } = provider;
+            this.update({ contractExchangeRates: {} });
+            this.configure({ chainId });
+        });
+        this.poll();
+    }
+    /**
+     * Sets a new polling interval.
+     *
+     * @param interval - Polling interval used to fetch new token rates.
+     */
+    poll(interval) {
+        return __awaiter(this, void 0, void 0, function* () {
+            interval && this.configure({ interval }, false, false);
+            this.handle && clearTimeout(this.handle);
+            yield (0, controller_utils_1.safelyExecute)(() => this.updateExchangeRates());
+            this.handle = setTimeout(() => {
+                this.poll(this.config.interval);
+            }, this.config.interval);
+        });
+    }
+    /**
+     * Sets a new chainId.
+     *
+     * TODO: Replace this with a method.
+     *
+     * @param _chainId - The current chain ID.
+     */
+    set chainId(_chainId) {
+        !this.disabled && (0, controller_utils_1.safelyExecute)(() => this.updateExchangeRates());
+    }
+    get chainId() {
+        throw new Error('Property only used for setting');
+    }
+    /**
+     * Sets a new token list to track prices.
+     *
+     * TODO: Replace this with a method.
+     *
+     * @param tokens - List of tokens to track exchange rates for.
+     */
+    set tokens(tokens) {
+        this.tokenList = tokens;
+        !this.disabled && (0, controller_utils_1.safelyExecute)(() => this.updateExchangeRates());
+    }
+    get tokens() {
+        throw new Error('Property only used for setting');
+    }
+    /**
+     * Fetches a pairs of token address and native currency.
+     *
+     * @param chainSlug - Chain string identifier.
+     * @param vsCurrency - Query according to tokens in tokenList and native currency.
+     * @returns The exchange rates for the given pairs.
+     */
+    fetchExchangeRate(chainSlug, vsCurrency) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const tokenPairs = this.tokenList.map((token) => token.address).join(',');
+            const query = `contract_addresses=${tokenPairs}&vs_currencies=${vsCurrency.toLowerCase()}`;
+            return (0, controller_utils_1.handleFetch)(CoinGeckoApi.getTokenPriceURL(chainSlug, query));
+        });
+    }
+    /**
+     * Checks if the current native currency is a supported vs currency to use
+     * to query for token exchange rates.
+     *
+     * @param nativeCurrency - The native currency of the currently active network.
+     * @returns A boolean indicating whether it's a supported vsCurrency.
+     */
+    checkIsSupportedVsCurrency(nativeCurrency) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const { threshold } = this.config;
+            const { timestamp, data } = this.supportedVsCurrencies;
+            const now = Date.now();
+            if (now - timestamp > threshold) {
+                const currencies = yield (0, controller_utils_1.handleFetch)(CoinGeckoApi.getSupportedVsCurrencies());
+                this.supportedVsCurrencies = {
+                    data: currencies,
+                    timestamp: Date.now(),
+                };
+                return currencies.includes(nativeCurrency.toLowerCase());
+            }
+            return data.includes(nativeCurrency.toLowerCase());
+        });
+    }
+    /**
+     * Gets current chain ID slug from cached supported platforms CoinGecko API response.
+     * If cached supported platforms response is stale, fetches and updates it.
+     *
+     * @returns The CoinGecko slug for the current chain ID.
+     */
+    getChainSlug() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const { threshold, chainId } = this.config;
+            const { data, timestamp } = this.supportedChains;
+            const now = Date.now();
+            if (now - timestamp > threshold) {
+                const platforms = yield (0, controller_utils_1.handleFetch)(CoinGeckoApi.getPlatformsURL());
+                this.supportedChains = {
+                    data: platforms,
+                    timestamp: Date.now(),
+                };
+                return findChainSlug(chainId, platforms);
+            }
+            return findChainSlug(chainId, data);
+        });
+    }
+    /**
+     * Updates exchange rates for all tokens.
+     */
+    updateExchangeRates() {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (this.tokenList.length === 0 || this.disabled) {
+                return;
+            }
+            const slug = yield this.getChainSlug();
+            let newContractExchangeRates = {};
+            if (!slug) {
+                this.tokenList.forEach((token) => {
+                    const address = (0, controller_utils_1.toChecksumHexAddress)(token.address);
+                    newContractExchangeRates[address] = undefined;
+                });
+            }
+            else {
+                const { nativeCurrency } = this.config;
+                newContractExchangeRates = yield this.fetchAndMapExchangeRates(nativeCurrency, slug);
+            }
+            this.update({ contractExchangeRates: newContractExchangeRates });
+        });
+    }
+    /**
+     * Checks if the active network's native currency is supported by the coingecko API.
+     * If supported, it fetches and maps contractExchange rates to a format to be consumed by the UI.
+     * If not supported, it fetches contractExchange rates and maps them from token/fallback-currency
+     * to token/nativeCurrency.
+     *
+     * @param nativeCurrency - The native currency of the currently active network.
+     * @param slug - The unique slug used to id the chain by the coingecko api
+     * should be used to query token exchange rates.
+     * @returns An object with conversion rates for each token
+     * related to the network's native currency.
+     */
+    fetchAndMapExchangeRates(nativeCurrency, slug) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const contractExchangeRates = {};
+            // check if native currency is supported as a vs_currency by the API
+            const nativeCurrencySupported = yield this.checkIsSupportedVsCurrency(nativeCurrency);
+            if (nativeCurrencySupported) {
+                // If it is we can do a simple fetch against the CoinGecko API
+                const prices = yield this.fetchExchangeRate(slug, nativeCurrency);
+                this.tokenList.forEach((token) => {
+                    const price = prices[token.address.toLowerCase()];
+                    contractExchangeRates[(0, controller_utils_1.toChecksumHexAddress)(token.address)] = price
+                        ? price[nativeCurrency.toLowerCase()]
+                        : 0;
+                });
+            }
+            else {
+                // if native currency is not supported we need to use a fallback vsCurrency, get the exchange rates
+                // in token/fallback-currency format and convert them to expected token/nativeCurrency format.
+                let tokenExchangeRates;
+                let vsCurrencyToNativeCurrencyConversionRate = 0;
+                try {
+                    [
+                        tokenExchangeRates,
+                        { conversionRate: vsCurrencyToNativeCurrencyConversionRate },
+                    ] = yield Promise.all([
+                        this.fetchExchangeRate(slug, controller_utils_1.FALL_BACK_VS_CURRENCY),
+                        (0, crypto_compare_1.fetchExchangeRate)(nativeCurrency, controller_utils_1.FALL_BACK_VS_CURRENCY, false),
+                    ]);
+                }
+                catch (error) {
+                    if (error instanceof Error &&
+                        error.message.includes('market does not exist for this coin pair')) {
+                        return {};
+                    }
+                    throw error;
+                }
+                for (const [tokenAddress, conversion] of Object.entries(tokenExchangeRates)) {
+                    const tokenToVsCurrencyConversionRate = conversion[controller_utils_1.FALL_BACK_VS_CURRENCY.toLowerCase()];
+                    contractExchangeRates[(0, controller_utils_1.toChecksumHexAddress)(tokenAddress)] =
+                        tokenToVsCurrencyConversionRate *
+                            vsCurrencyToNativeCurrencyConversionRate;
+                }
+            }
+            return contractExchangeRates;
+        });
+    }
+}
+exports.TokenRatesController = TokenRatesController;
+exports.default = TokenRatesController;
+//# sourceMappingURL=TokenRatesController.js.map

package/dist/TokenRatesController.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"TokenRatesController.js","sourceRoot":"","sources":["../src/TokenRatesController.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,+DAImC;AACnC,iEAKoC;AAEpC,qDAAgF;AAwFhF,MAAM,YAAY,GAAG;IACnB,QAAQ,EAAE,kCAAkC;IAC5C,gBAAgB,CAAC,SAAiB,EAAE,KAAa;QAC/C,OAAO,GAAG,IAAI,CAAC,QAAQ,uBAAuB,SAAS,IAAI,KAAK,EAAE,CAAC;IACrE,CAAC;IACD,eAAe;QACb,OAAO,GAAG,IAAI,CAAC,QAAQ,kBAAkB,CAAC;IAC5C,CAAC;IACD,wBAAwB;QACtB,OAAO,GAAG,IAAI,CAAC,QAAQ,iCAAiC,CAAC;IAC3D,CAAC;CACF,CAAC;AAEF;;;;;;GAMG;AACH,SAAS,aAAa,CACpB,OAAe,EACf,IAAgC;;IAEhC,IAAI,CAAC,IAAI,EAAE;QACT,OAAO,IAAI,CAAC;KACb;IACD,MAAM,KAAK,GACT,MAAA,IAAI,CAAC,IAAI,CACP,CAAC,EAAE,gBAAgB,EAAE,EAAE,EAAE,CACvB,gBAAgB,KAAK,IAAI,IAAI,MAAM,CAAC,gBAAgB,CAAC,KAAK,OAAO,CACpE,mCAAI,IAAI,CAAC;IACZ,OAAO,CAAA,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,EAAE,KAAI,IAAI,CAAC;AAC3B,CAAC;AAED;;;GAGG;AACH,MAAa,oBAAqB,SAAQ,gCAGzC;IAoBC;;;;;;;;;OASG;IACH,YACE,EACE,mBAAmB,EACnB,yBAAyB,EACzB,oBAAoB,GAWrB,EACD,MAAkC,EAClC,KAAgC;QAEhC,KAAK,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;QA9Cf,cAAS,GAAY,EAAE,CAAC;QAExB,oBAAe,GAAyB;YAC9C,SAAS,EAAE,CAAC;YACZ,IAAI,EAAE,IAAI;SACX,CAAC;QAEM,0BAAqB,GAA+B;YAC1D,SAAS,EAAE,CAAC;YACZ,IAAI,EAAE,EAAE;SACT,CAAC;QAEF;;WAEG;QACM,SAAI,GAAG,sBAAsB,CAAC;QAgCrC,IAAI,CAAC,aAAa,GAAG;YACnB,QAAQ,EAAE,IAAI;YACd,QAAQ,EAAE,CAAC,GAAG,EAAE,GAAG,IAAI;YACvB,cAAc,EAAE,KAAK;YACrB,OAAO,EAAE,EAAE;YACX,MAAM,EAAE,EAAE;YACV,SAAS,EAAE,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,IAAI;SAC9B,CAAC;QAEF,IAAI,CAAC,YAAY,GAAG;YAClB,qBAAqB,EAAE,EAAE;SAC1B,CAAC;QACF,IAAI,CAAC,UAAU,EAAE,CAAC;QAClB,IAAI,CAAC,SAAS,CAAC,EAAE,QAAQ,EAAE,KAAK,EAAE,EAAE,KAAK,EAAE,KAAK,CAAC,CAAC;QAClD,mBAAmB,CAAC,CAAC,EAAE,MAAM,EAAE,cAAc,EAAE,EAAE,EAAE;YACjD,IAAI,CAAC,SAAS,CAAC,EAAE,MAAM,EAAE,CAAC,GAAG,MAAM,EAAE,GAAG,cAAc,CAAC,EAAE,CAAC,CAAC;QAC7D,CAAC,CAAC,CAAC;QAEH,yBAAyB,CAAC,CAAC,iBAAiB,EAAE,EAAE;YAC9C,IAAI,CAAC,SAAS,CAAC,EAAE,cAAc,EAAE,iBAAiB,CAAC,cAAc,EAAE,CAAC,CAAC;QACvE,CAAC,CAAC,CAAC;QAEH,oBAAoB,CAAC,CAAC,EAAE,QAAQ,EAAE,EAAE,EAAE;YACpC,MAAM,EAAE,OAAO,EAAE,GAAG,QAAQ,CAAC;YAC7B,IAAI,CAAC,MAAM,CAAC,EAAE,qBAAqB,EAAE,EAAE,EAAE,CAAC,CAAC;YAC3C,IAAI,CAAC,SAAS,CAAC,EAAE,OAAO,EAAE,CAAC,CAAC;QAC9B,CAAC,CAAC,CAAC;QACH,IAAI,CAAC,IAAI,EAAE,CAAC;IACd,CAAC;IAED;;;;OAIG;IACG,IAAI,CAAC,QAAiB;;YAC1B,QAAQ,IAAI,IAAI,CAAC,SAAS,CAAC,EAAE,QAAQ,EAAE,EAAE,KAAK,EAAE,KAAK,CAAC,CAAC;YACvD,IAAI,CAAC,MAAM,IAAI,YAAY,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;YACzC,MAAM,IAAA,gCAAa,EAAC,GAAG,EAAE,CAAC,IAAI,CAAC,mBAAmB,EAAE,CAAC,CAAC;YACtD,IAAI,CAAC,MAAM,GAAG,UAAU,CAAC,GAAG,EAAE;gBAC5B,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;YAClC,CAAC,EAAE,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;QAC3B,CAAC;KAAA;IAED;;;;;;OAMG;IACH,IAAI,OAAO,CAAC,QAAgB;QAC1B,CAAC,IAAI,CAAC,QAAQ,IAAI,IAAA,gCAAa,EAAC,GAAG,EAAE,CAAC,IAAI,CAAC,mBAAmB,EAAE,CAAC,CAAC;IACpE,CAAC;IAED,IAAI,OAAO;QACT,MAAM,IAAI,KAAK,CAAC,gCAAgC,CAAC,CAAC;IACpD,CAAC;IAED;;;;;;OAMG;IACH,IAAI,MAAM,CAAC,MAAe;QACxB,IAAI,CAAC,SAAS,GAAG,MAAM,CAAC;QACxB,CAAC,IAAI,CAAC,QAAQ,IAAI,IAAA,gCAAa,EAAC,GAAG,EAAE,CAAC,IAAI,CAAC,mBAAmB,EAAE,CAAC,CAAC;IACpE,CAAC;IAED,IAAI,MAAM;QACR,MAAM,IAAI,KAAK,CAAC,gCAAgC,CAAC,CAAC;IACpD,CAAC;IAED;;;;;;OAMG;IACG,iBAAiB,CACrB,SAAiB,EACjB,UAAkB;;YAElB,MAAM,UAAU,GAAG,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;YAC1E,MAAM,KAAK,GAAG,sBAAsB,UAAU,kBAAkB,UAAU,CAAC,WAAW,EAAE,EAAE,CAAC;YAC3F,OAAO,IAAA,8BAAW,EAAC,YAAY,CAAC,gBAAgB,CAAC,SAAS,EAAE,KAAK,CAAC,CAAC,CAAC;QACtE,CAAC;KAAA;IAED;;;;;;OAMG;IACW,0BAA0B,CAAC,cAAsB;;YAC7D,MAAM,EAAE,SAAS,EAAE,GAAG,IAAI,CAAC,MAAM,CAAC;YAClC,MAAM,EAAE,SAAS,EAAE,IAAI,EAAE,GAAG,IAAI,CAAC,qBAAqB,CAAC;YAEvD,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;YAEvB,IAAI,GAAG,GAAG,SAAS,GAAG,SAAS,EAAE;gBAC/B,MAAM,UAAU,GAAG,MAAM,IAAA,8BAAW,EAClC,YAAY,CAAC,wBAAwB,EAAE,CACxC,CAAC;gBACF,IAAI,CAAC,qBAAqB,GAAG;oBAC3B,IAAI,EAAE,UAAU;oBAChB,SAAS,EAAE,IAAI,CAAC,GAAG,EAAE;iBACtB,CAAC;gBACF,OAAO,UAAU,CAAC,QAAQ,CAAC,cAAc,CAAC,WAAW,EAAE,CAAC,CAAC;aAC1D;YAED,OAAO,IAAI,CAAC,QAAQ,CAAC,cAAc,CAAC,WAAW,EAAE,CAAC,CAAC;QACrD,CAAC;KAAA;IAED;;;;;OAKG;IACG,YAAY;;YAChB,MAAM,EAAE,SAAS,EAAE,OAAO,EAAE,GAAG,IAAI,CAAC,MAAM,CAAC;YAC3C,MAAM,EAAE,IAAI,EAAE,SAAS,EAAE,GAAG,IAAI,CAAC,eAAe,CAAC;YAEjD,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;YAEvB,IAAI,GAAG,GAAG,SAAS,GAAG,SAAS,EAAE;gBAC/B,MAAM,SAAS,GAAG,MAAM,IAAA,8BAAW,EAAC,YAAY,CAAC,eAAe,EAAE,CAAC,CAAC;gBACpE,IAAI,CAAC,eAAe,GAAG;oBACrB,IAAI,EAAE,SAAS;oBACf,SAAS,EAAE,IAAI,CAAC,GAAG,EAAE;iBACtB,CAAC;gBACF,OAAO,aAAa,CAAC,OAAO,EAAE,SAAS,CAAC,CAAC;aAC1C;YAED,OAAO,aAAa,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC;QACtC,CAAC;KAAA;IAED;;OAEG;IACG,mBAAmB;;YACvB,IAAI,IAAI,CAAC,SAAS,CAAC,MAAM,KAAK,CAAC,IAAI,IAAI,CAAC,QAAQ,EAAE;gBAChD,OAAO;aACR;YACD,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,YAAY,EAAE,CAAC;YAEvC,IAAI,wBAAwB,GAA0B,EAAE,CAAC;YACzD,IAAI,CAAC,IAAI,EAAE;gBACT,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,EAAE;oBAC/B,MAAM,OAAO,GAAG,IAAA,uCAAoB,EAAC,KAAK,CAAC,OAAO,CAAC,CAAC;oBACpD,wBAAwB,CAAC,OAAO,CAAC,GAAG,SAAS,CAAC;gBAChD,CAAC,CAAC,CAAC;aACJ;iBAAM;gBACL,MAAM,EAAE,cAAc,EAAE,GAAG,IAAI,CAAC,MAAM,CAAC;gBACvC,wBAAwB,GAAG,MAAM,IAAI,CAAC,wBAAwB,CAC5D,cAAc,EACd,IAAI,CACL,CAAC;aACH;YACD,IAAI,CAAC,MAAM,CAAC,EAAE,qBAAqB,EAAE,wBAAwB,EAAE,CAAC,CAAC;QACnE,CAAC;KAAA;IAED;;;;;;;;;;;OAWG;IACG,wBAAwB,CAC5B,cAAsB,EACtB,IAAY;;YAEZ,MAAM,qBAAqB,GAA0B,EAAE,CAAC;YAExD,oEAAoE;YACpE,MAAM,uBAAuB,GAAG,MAAM,IAAI,CAAC,0BAA0B,CACnE,cAAc,CACf,CAAC;YAEF,IAAI,uBAAuB,EAAE;gBAC3B,8DAA8D;gBAC9D,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,iBAAiB,CAAC,IAAI,EAAE,cAAc,CAAC,CAAC;gBAClE,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,EAAE;oBAC/B,MAAM,KAAK,GAAG,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,WAAW,EAAE,CAAC,CAAC;oBAClD,qBAAqB,CAAC,IAAA,uCAAoB,EAAC,KAAK,CAAC,OAAO,CAAC,CAAC,GAAG,KAAK;wBAChE,CAAC,CAAC,KAAK,CAAC,cAAc,CAAC,WAAW,EAAE,CAAC;wBACrC,CAAC,CAAC,CAAC,CAAC;gBACR,CAAC,CAAC,CAAC;aACJ;iBAAM;gBACL,mGAAmG;gBACnG,8FAA8F;gBAC9F,IAAI,kBAAkB,CAAC;gBACvB,IAAI,wCAAwC,GAAG,CAAC,CAAC;gBACjD,IAAI;oBACF;wBACE,kBAAkB;wBAClB,EAAE,cAAc,EAAE,wCAAwC,EAAE;qBAC7D,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC;wBACpB,IAAI,CAAC,iBAAiB,CAAC,IAAI,EAAE,wCAAqB,CAAC;wBACnD,IAAA,kCAAuB,EAAC,cAAc,EAAE,wCAAqB,EAAE,KAAK,CAAC;qBACtE,CAAC,CAAC;iBACJ;gBAAC,OAAO,KAAK,EAAE;oBACd,IACE,KAAK,YAAY,KAAK;wBACtB,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,0CAA0C,CAAC,EAClE;wBACA,OAAO,EAAE,CAAC;qBACX;oBACD,MAAM,KAAK,CAAC;iBACb;gBAED,KAAK,MAAM,CAAC,YAAY,EAAE,UAAU,CAAC,IAAI,MAAM,CAAC,OAAO,CACrD,kBAAkB,CACnB,EAAE;oBACD,MAAM,+BAA+B,GACnC,UAAU,CAAC,wCAAqB,CAAC,WAAW,EAAE,CAAC,CAAC;oBAClD,qBAAqB,CAAC,IAAA,uCAAoB,EAAC,YAAY,CAAC,CAAC;wBACvD,+BAA+B;4BAC/B,wCAAwC,CAAC;iBAC5C;aACF;YAED,OAAO,qBAAqB,CAAC;QAC/B,CAAC;KAAA;CACF;AAhSD,oDAgSC;AAED,kBAAe,oBAAoB,CAAC","sourcesContent":["import {\n  BaseController,\n  BaseConfig,\n  BaseState,\n} from '@metamask/base-controller';\nimport {\n  safelyExecute,\n  handleFetch,\n  toChecksumHexAddress,\n  FALL_BACK_VS_CURRENCY,\n} from '@metamask/controller-utils';\nimport type { NetworkState } from '@metamask/network-controller';\nimport { fetchExchangeRate as fetchNativeExchangeRate } from './crypto-compare';\nimport type { TokensState } from './TokensController';\nimport type { CurrencyRateState } from './CurrencyRateController';\n\n/**\n * @type CoinGeckoResponse\n *\n * CoinGecko API response representation\n */\nexport interface CoinGeckoResponse {\n  [address: string]: {\n    [currency: string]: number;\n  };\n}\n/**\n * @type CoinGeckoPlatform\n *\n * CoinGecko supported platform API representation\n */\nexport interface CoinGeckoPlatform {\n  id: string;\n  chain_identifier: null | number;\n  name: string;\n  shortname: string;\n}\n\n/**\n * @type Token\n *\n * Token representation\n * @property address - Hex address of the token contract\n * @property decimals - Number of decimals the token uses\n * @property symbol - Symbol of the token\n * @property image - Image of the token, url or bit32 image\n */\nexport interface Token {\n  address: string;\n  decimals: number;\n  symbol: string;\n  aggregators?: string[];\n  image?: string;\n  balanceError?: unknown;\n  isERC721?: boolean;\n}\n\n/**\n * @type TokenRatesConfig\n *\n * Token rates controller configuration\n * @property interval - Polling interval used to fetch new token rates\n * @property nativeCurrency - Current native currency selected to use base of rates\n * @property chainId - Current network chainId\n * @property tokens - List of tokens to track exchange rates for\n * @property threshold - Threshold to invalidate the supportedChains\n */\nexport interface TokenRatesConfig extends BaseConfig {\n  interval: number;\n  nativeCurrency: string;\n  chainId: string;\n  tokens: Token[];\n  threshold: number;\n}\n\ninterface ContractExchangeRates {\n  [address: string]: number | undefined;\n}\n\ninterface SupportedChainsCache {\n  timestamp: number;\n  data: CoinGeckoPlatform[] | null;\n}\n\ninterface SupportedVsCurrenciesCache {\n  timestamp: number;\n  data: string[];\n}\n\n/**\n * @type TokenRatesState\n *\n * Token rates controller state\n * @property contractExchangeRates - Hash of token contract addresses to exchange rates\n * @property supportedChains - Cached chain data\n */\nexport interface TokenRatesState extends BaseState {\n  contractExchangeRates: ContractExchangeRates;\n}\n\nconst CoinGeckoApi = {\n  BASE_URL: 'https://api.coingecko.com/api/v3',\n  getTokenPriceURL(chainSlug: string, query: string) {\n    return `${this.BASE_URL}/simple/token_price/${chainSlug}?${query}`;\n  },\n  getPlatformsURL() {\n    return `${this.BASE_URL}/asset_platforms`;\n  },\n  getSupportedVsCurrencies() {\n    return `${this.BASE_URL}/simple/supported_vs_currencies`;\n  },\n};\n\n/**\n * Finds the chain slug in the data array given a chainId.\n *\n * @param chainId - The current chain ID.\n * @param data - A list platforms supported by the CoinGecko API.\n * @returns The CoinGecko slug for the given chain ID, or `null` if the slug was not found.\n */\nfunction findChainSlug(\n  chainId: string,\n  data: CoinGeckoPlatform[] | null,\n): string | null {\n  if (!data) {\n    return null;\n  }\n  const chain =\n    data.find(\n      ({ chain_identifier }) =>\n        chain_identifier !== null && String(chain_identifier) === chainId,\n    ) ?? null;\n  return chain?.id || null;\n}\n\n/**\n * Controller that passively polls on a set interval for token-to-fiat exchange rates\n * for tokens stored in the TokensController\n */\nexport class TokenRatesController extends BaseController<\n  TokenRatesConfig,\n  TokenRatesState\n> {\n  private handle?: ReturnType<typeof setTimeout>;\n\n  private tokenList: Token[] = [];\n\n  private supportedChains: SupportedChainsCache = {\n    timestamp: 0,\n    data: null,\n  };\n\n  private supportedVsCurrencies: SupportedVsCurrenciesCache = {\n    timestamp: 0,\n    data: [],\n  };\n\n  /**\n   * Name of this controller used during composition\n   */\n  override name = 'TokenRatesController';\n\n  /**\n   * Creates a TokenRatesController instance.\n   *\n   * @param options - The controller options.\n   * @param options.onTokensStateChange - Allows subscribing to token controller state changes.\n   * @param options.onCurrencyRateStateChange - Allows subscribing to currency rate controller state changes.\n   * @param options.onNetworkStateChange - Allows subscribing to network state changes.\n   * @param config - Initial options used to configure this controller.\n   * @param state - Initial state to set on this controller.\n   */\n  constructor(\n    {\n      onTokensStateChange,\n      onCurrencyRateStateChange,\n      onNetworkStateChange,\n    }: {\n      onTokensStateChange: (\n        listener: (tokensState: TokensState) => void,\n      ) => void;\n      onCurrencyRateStateChange: (\n        listener: (currencyRateState: CurrencyRateState) => void,\n      ) => void;\n      onNetworkStateChange: (\n        listener: (networkState: NetworkState) => void,\n      ) => void;\n    },\n    config?: Partial<TokenRatesConfig>,\n    state?: Partial<TokenRatesState>,\n  ) {\n    super(config, state);\n    this.defaultConfig = {\n      disabled: true,\n      interval: 3 * 60 * 1000,\n      nativeCurrency: 'eth',\n      chainId: '',\n      tokens: [],\n      threshold: 6 * 60 * 60 * 1000,\n    };\n\n    this.defaultState = {\n      contractExchangeRates: {},\n    };\n    this.initialize();\n    this.configure({ disabled: false }, false, false);\n    onTokensStateChange(({ tokens, detectedTokens }) => {\n      this.configure({ tokens: [...tokens, ...detectedTokens] });\n    });\n\n    onCurrencyRateStateChange((currencyRateState) => {\n      this.configure({ nativeCurrency: currencyRateState.nativeCurrency });\n    });\n\n    onNetworkStateChange(({ provider }) => {\n      const { chainId } = provider;\n      this.update({ contractExchangeRates: {} });\n      this.configure({ chainId });\n    });\n    this.poll();\n  }\n\n  /**\n   * Sets a new polling interval.\n   *\n   * @param interval - Polling interval used to fetch new token rates.\n   */\n  async poll(interval?: number): Promise<void> {\n    interval && this.configure({ interval }, false, false);\n    this.handle && clearTimeout(this.handle);\n    await safelyExecute(() => this.updateExchangeRates());\n    this.handle = setTimeout(() => {\n      this.poll(this.config.interval);\n    }, this.config.interval);\n  }\n\n  /**\n   * Sets a new chainId.\n   *\n   * TODO: Replace this with a method.\n   *\n   * @param _chainId - The current chain ID.\n   */\n  set chainId(_chainId: string) {\n    !this.disabled && safelyExecute(() => this.updateExchangeRates());\n  }\n\n  get chainId() {\n    throw new Error('Property only used for setting');\n  }\n\n  /**\n   * Sets a new token list to track prices.\n   *\n   * TODO: Replace this with a method.\n   *\n   * @param tokens - List of tokens to track exchange rates for.\n   */\n  set tokens(tokens: Token[]) {\n    this.tokenList = tokens;\n    !this.disabled && safelyExecute(() => this.updateExchangeRates());\n  }\n\n  get tokens() {\n    throw new Error('Property only used for setting');\n  }\n\n  /**\n   * Fetches a pairs of token address and native currency.\n   *\n   * @param chainSlug - Chain string identifier.\n   * @param vsCurrency - Query according to tokens in tokenList and native currency.\n   * @returns The exchange rates for the given pairs.\n   */\n  async fetchExchangeRate(\n    chainSlug: string,\n    vsCurrency: string,\n  ): Promise<CoinGeckoResponse> {\n    const tokenPairs = this.tokenList.map((token) => token.address).join(',');\n    const query = `contract_addresses=${tokenPairs}&vs_currencies=${vsCurrency.toLowerCase()}`;\n    return handleFetch(CoinGeckoApi.getTokenPriceURL(chainSlug, query));\n  }\n\n  /**\n   * Checks if the current native currency is a supported vs currency to use\n   * to query for token exchange rates.\n   *\n   * @param nativeCurrency - The native currency of the currently active network.\n   * @returns A boolean indicating whether it's a supported vsCurrency.\n   */\n  private async checkIsSupportedVsCurrency(nativeCurrency: string) {\n    const { threshold } = this.config;\n    const { timestamp, data } = this.supportedVsCurrencies;\n\n    const now = Date.now();\n\n    if (now - timestamp > threshold) {\n      const currencies = await handleFetch(\n        CoinGeckoApi.getSupportedVsCurrencies(),\n      );\n      this.supportedVsCurrencies = {\n        data: currencies,\n        timestamp: Date.now(),\n      };\n      return currencies.includes(nativeCurrency.toLowerCase());\n    }\n\n    return data.includes(nativeCurrency.toLowerCase());\n  }\n\n  /**\n   * Gets current chain ID slug from cached supported platforms CoinGecko API response.\n   * If cached supported platforms response is stale, fetches and updates it.\n   *\n   * @returns The CoinGecko slug for the current chain ID.\n   */\n  async getChainSlug(): Promise<string | null> {\n    const { threshold, chainId } = this.config;\n    const { data, timestamp } = this.supportedChains;\n\n    const now = Date.now();\n\n    if (now - timestamp > threshold) {\n      const platforms = await handleFetch(CoinGeckoApi.getPlatformsURL());\n      this.supportedChains = {\n        data: platforms,\n        timestamp: Date.now(),\n      };\n      return findChainSlug(chainId, platforms);\n    }\n\n    return findChainSlug(chainId, data);\n  }\n\n  /**\n   * Updates exchange rates for all tokens.\n   */\n  async updateExchangeRates() {\n    if (this.tokenList.length === 0 || this.disabled) {\n      return;\n    }\n    const slug = await this.getChainSlug();\n\n    let newContractExchangeRates: ContractExchangeRates = {};\n    if (!slug) {\n      this.tokenList.forEach((token) => {\n        const address = toChecksumHexAddress(token.address);\n        newContractExchangeRates[address] = undefined;\n      });\n    } else {\n      const { nativeCurrency } = this.config;\n      newContractExchangeRates = await this.fetchAndMapExchangeRates(\n        nativeCurrency,\n        slug,\n      );\n    }\n    this.update({ contractExchangeRates: newContractExchangeRates });\n  }\n\n  /**\n   * Checks if the active network's native currency is supported by the coingecko API.\n   * If supported, it fetches and maps contractExchange rates to a format to be consumed by the UI.\n   * If not supported, it fetches contractExchange rates and maps them from token/fallback-currency\n   * to token/nativeCurrency.\n   *\n   * @param nativeCurrency - The native currency of the currently active network.\n   * @param slug - The unique slug used to id the chain by the coingecko api\n   * should be used to query token exchange rates.\n   * @returns An object with conversion rates for each token\n   * related to the network's native currency.\n   */\n  async fetchAndMapExchangeRates(\n    nativeCurrency: string,\n    slug: string,\n  ): Promise<ContractExchangeRates> {\n    const contractExchangeRates: ContractExchangeRates = {};\n\n    // check if native currency is supported as a vs_currency by the API\n    const nativeCurrencySupported = await this.checkIsSupportedVsCurrency(\n      nativeCurrency,\n    );\n\n    if (nativeCurrencySupported) {\n      // If it is we can do a simple fetch against the CoinGecko API\n      const prices = await this.fetchExchangeRate(slug, nativeCurrency);\n      this.tokenList.forEach((token) => {\n        const price = prices[token.address.toLowerCase()];\n        contractExchangeRates[toChecksumHexAddress(token.address)] = price\n          ? price[nativeCurrency.toLowerCase()]\n          : 0;\n      });\n    } else {\n      // if native currency is not supported we need to use a fallback vsCurrency, get the exchange rates\n      // in token/fallback-currency format and convert them to expected token/nativeCurrency format.\n      let tokenExchangeRates;\n      let vsCurrencyToNativeCurrencyConversionRate = 0;\n      try {\n        [\n          tokenExchangeRates,\n          { conversionRate: vsCurrencyToNativeCurrencyConversionRate },\n        ] = await Promise.all([\n          this.fetchExchangeRate(slug, FALL_BACK_VS_CURRENCY),\n          fetchNativeExchangeRate(nativeCurrency, FALL_BACK_VS_CURRENCY, false),\n        ]);\n      } catch (error) {\n        if (\n          error instanceof Error &&\n          error.message.includes('market does not exist for this coin pair')\n        ) {\n          return {};\n        }\n        throw error;\n      }\n\n      for (const [tokenAddress, conversion] of Object.entries(\n        tokenExchangeRates,\n      )) {\n        const tokenToVsCurrencyConversionRate =\n          conversion[FALL_BACK_VS_CURRENCY.toLowerCase()];\n        contractExchangeRates[toChecksumHexAddress(tokenAddress)] =\n          tokenToVsCurrencyConversionRate *\n          vsCurrencyToNativeCurrencyConversionRate;\n      }\n    }\n\n    return contractExchangeRates;\n  }\n}\n\nexport default TokenRatesController;\n"]}

package/dist/TokensController.d.ts

@@ -0,0 +1,238 @@
+/// <reference types="node" />
+import { EventEmitter } from 'events';
+import { Contract } from '@ethersproject/contracts';
+import { BaseController, BaseConfig, BaseState } from '@metamask/base-controller';
+import type { PreferencesState } from '@metamask/preferences-controller';
+import type { NetworkState } from '@metamask/network-controller';
+import { NetworkType } from '@metamask/controller-utils';
+import type { Token } from './TokenRatesController';
+/**
+ * @type TokensConfig
+ *
+ * Tokens controller configuration
+ * @property networkType - Network ID as per net_version
+ * @property selectedAddress - Vault selected address
+ */
+export interface TokensConfig extends BaseConfig {
+    networkType: NetworkType;
+    selectedAddress: string;
+    chainId: string;
+    provider: any;
+}
+/**
+ * @type AssetSuggestionResult
+ * @property result - Promise resolving to a new suggested asset address
+ * @property suggestedAssetMeta - Meta information about this new suggested asset
+ */
+interface AssetSuggestionResult {
+    result: Promise<string>;
+    suggestedAssetMeta: SuggestedAssetMeta;
+}
+declare enum SuggestedAssetStatus {
+    accepted = "accepted",
+    failed = "failed",
+    pending = "pending",
+    rejected = "rejected"
+}
+export declare type SuggestedAssetMetaBase = {
+    id: string;
+    time: number;
+    type: string;
+    asset: Token;
+};
+/**
+ * @type SuggestedAssetMeta
+ *
+ * Suggested asset by EIP747 meta data
+ * @property error - Synthesized error information for failed asset suggestions
+ * @property id - Generated UUID associated with this suggested asset
+ * @property status - String status of this this suggested asset
+ * @property time - Timestamp associated with this this suggested asset
+ * @property type - Type type this suggested asset
+ * @property asset - Asset suggested object
+ */
+export declare type SuggestedAssetMeta = (SuggestedAssetMetaBase & {
+    status: SuggestedAssetStatus.failed;
+    error: Error;
+}) | (SuggestedAssetMetaBase & {
+    status: SuggestedAssetStatus.accepted | SuggestedAssetStatus.rejected | SuggestedAssetStatus.pending;
+});
+/**
+ * @type TokensState
+ *
+ * Assets controller state
+ * @property tokens - List of tokens associated with the active network and address pair
+ * @property ignoredTokens - List of ignoredTokens associated with the active network and address pair
+ * @property detectedTokens - List of detected tokens associated with the active network and address pair
+ * @property allTokens - Object containing tokens by network and account
+ * @property allIgnoredTokens - Object containing hidden/ignored tokens by network and account
+ * @property allDetectedTokens - Object containing tokens detected with non-zero balances
+ * @property suggestedAssets - List of pending suggested assets to be added or canceled
+ */
+export interface TokensState extends BaseState {
+    tokens: Token[];
+    ignoredTokens: string[];
+    detectedTokens: Token[];
+    allTokens: {
+        [key: string]: {
+            [key: string]: Token[];
+        };
+    };
+    allIgnoredTokens: {
+        [key: string]: {
+            [key: string]: string[];
+        };
+    };
+    allDetectedTokens: {
+        [key: string]: {
+            [key: string]: Token[];
+        };
+    };
+    suggestedAssets: SuggestedAssetMeta[];
+}
+/**
+ * Controller that stores assets and exposes convenience methods
+ */
+export declare class TokensController extends BaseController<TokensConfig, TokensState> {
+    private mutex;
+    private ethersProvider;
+    private abortController;
+    private failSuggestedAsset;
+    /**
+     * Fetch metadata for a token.
+     *
+     * @param tokenAddress - The address of the token.
+     * @returns The token metadata.
+     */
+    private fetchTokenMetadata;
+    /**
+     * EventEmitter instance used to listen to specific EIP747 events
+     */
+    hub: EventEmitter;
+    /**
+     * Name of this controller used during composition
+     */
+    name: string;
+    /**
+     * Creates a TokensController instance.
+     *
+     * @param options - The controller options.
+     * @param options.onPreferencesStateChange - Allows subscribing to preference controller state changes.
+     * @param options.onNetworkStateChange - Allows subscribing to network controller state changes.
+     * @param options.config - Initial options used to configure this controller.
+     * @param options.state - Initial state to set on this controller.
+     */
+    constructor({ onPreferencesStateChange, onNetworkStateChange, config, state, }: {
+        onPreferencesStateChange: (listener: (preferencesState: PreferencesState) => void) => void;
+        onNetworkStateChange: (listener: (networkState: NetworkState) => void) => void;
+        config?: Partial<TokensConfig>;
+        state?: Partial<TokensState>;
+    });
+    _instantiateNewEthersProvider(): any;
+    /**
+     * Adds a token to the stored token list.
+     *
+     * @param address - Hex address of the token contract.
+     * @param symbol - Symbol of the token.
+     * @param decimals - Number of decimals the token uses.
+     * @param image - Image of the token.
+     * @returns Current token list.
+     */
+    addToken(address: string, symbol: string, decimals: number, image?: string): Promise<Token[]>;
+    /**
+     * Add a batch of tokens.
+     *
+     * @param tokensToImport - Array of tokens to import.
+     */
+    addTokens(tokensToImport: Token[]): Promise<void>;
+    /**
+     * Ignore a batch of tokens.
+     *
+     * @param tokenAddressesToIgnore - Array of token addresses to ignore.
+     */
+    ignoreTokens(tokenAddressesToIgnore: string[]): void;
+    /**
+     * Adds a batch of detected tokens to the stored token list.
+     *
+     * @param incomingDetectedTokens - Array of detected tokens to be added or updated.
+     */
+    addDetectedTokens(incomingDetectedTokens: Token[]): Promise<void>;
+    /**
+     * Adds isERC721 field to token object. This is called when a user attempts to add tokens that
+     * were previously added which do not yet had isERC721 field.
+     *
+     * @param tokenAddress - The contract address of the token requiring the isERC721 field added.
+     * @returns The new token object with the added isERC721 field.
+     */
+    updateTokenType(tokenAddress: string): Promise<Token>;
+    /**
+     * Detects whether or not a token is ERC-721 compatible.
+     *
+     * @param tokenAddress - The token contract address.
+     * @returns A boolean indicating whether the token address passed in supports the EIP-721
+     * interface.
+     */
+    _detectIsERC721(tokenAddress: string): Promise<any>;
+    _createEthersContract(tokenAddress: string, abi: string, ethersProvider: any): Contract;
+    _generateRandomId(): string;
+    /**
+     * Adds a new suggestedAsset to state. Parameters will be validated according to
+     * asset type being watched. A `<suggestedAssetMeta.id>:pending` hub event will be emitted once added.
+     *
+     * @param asset - The asset to be watched. For now only ERC20 tokens are accepted.
+     * @param type - The asset type.
+     * @returns Object containing a Promise resolving to the suggestedAsset address if accepted.
+     */
+    watchAsset(asset: Token, type: string): Promise<AssetSuggestionResult>;
+    /**
+     * Accepts to watch an asset and updates it's status and deletes the suggestedAsset from state,
+     * adding the asset to corresponding asset state. In this case ERC20 tokens.
+     * A `<suggestedAssetMeta.id>:finished` hub event is fired after accepted or failure.
+     *
+     * @param suggestedAssetID - The ID of the suggestedAsset to accept.
+     */
+    acceptWatchAsset(suggestedAssetID: string): Promise<void>;
+    /**
+     * Rejects a watchAsset request based on its ID by setting its status to "rejected"
+     * and emitting a `<suggestedAssetMeta.id>:finished` hub event.
+     *
+     * @param suggestedAssetID - The ID of the suggestedAsset to accept.
+     */
+    rejectWatchAsset(suggestedAssetID: string): void;
+    /**
+     * Takes a new tokens and ignoredTokens array for the current network/account combination
+     * and returns new allTokens and allIgnoredTokens state to update to.
+     *
+     * @param params - Object that holds token params.
+     * @param params.newTokens - The new tokens to set for the current network and selected account.
+     * @param params.newIgnoredTokens - The new ignored tokens to set for the current network and selected account.
+     * @param params.newDetectedTokens - The new detected tokens to set for the current network and selected account.
+     * @returns The updated `allTokens` and `allIgnoredTokens` state.
+     */
+    _getNewAllTokensState(params: {
+        newTokens?: Token[];
+        newIgnoredTokens?: string[];
+        newDetectedTokens?: Token[];
+    }): {
+        newAllTokens: {
+            [key: string]: {
+                [key: string]: Token[];
+            };
+        };
+        newAllIgnoredTokens: {
+            [key: string]: {
+                [key: string]: string[];
+            };
+        };
+        newAllDetectedTokens: {
+            [key: string]: {
+                [key: string]: Token[];
+            };
+        };
+    };
+    /**
+     * Removes all tokens from the ignored list.
+     */
+    clearIgnoredTokens(): void;
+}
+export default TokensController;