@metamask/assets-controllers 1.0.0

package/dist/TokenListController.js

@@ -0,0 +1,256 @@
+"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());
+    });
+};
+var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
+    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
+    return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
+};
+var _TokenListController_instances, _TokenListController_onNetworkStateChangeCallback;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TokenListController = void 0;
+const async_mutex_1 = require("async-mutex");
+const abort_controller_1 = require("abort-controller");
+const base_controller_1 = require("@metamask/base-controller");
+const controller_utils_1 = require("@metamask/controller-utils");
+const assetsUtil_1 = require("./assetsUtil");
+const token_service_1 = require("./token-service");
+const DEFAULT_INTERVAL = 24 * 60 * 60 * 1000;
+const DEFAULT_THRESHOLD = 24 * 60 * 60 * 1000;
+const name = 'TokenListController';
+const metadata = {
+    tokenList: { persist: true, anonymous: true },
+    tokensChainsCache: { persist: true, anonymous: true },
+    preventPollingOnNetworkRestart: { persist: true, anonymous: true },
+};
+const defaultState = {
+    tokenList: {},
+    tokensChainsCache: {},
+    preventPollingOnNetworkRestart: false,
+};
+/**
+ * Controller that passively polls on a set interval for the list of tokens from metaswaps api
+ */
+class TokenListController extends base_controller_1.BaseControllerV2 {
+    /**
+     * Creates a TokenListController instance.
+     *
+     * @param options - The controller options.
+     * @param options.chainId - The chain ID of the current network.
+     * @param options.onNetworkStateChange - A function for registering an event handler for network state changes.
+     * @param options.interval - The polling interval, in milliseconds.
+     * @param options.cacheRefreshThreshold - The token cache expiry time, in milliseconds.
+     * @param options.messenger - A restricted controller messenger.
+     * @param options.state - Initial state to set on this controller.
+     * @param options.preventPollingOnNetworkRestart - Determines whether to prevent poilling on network restart in extension.
+     */
+    constructor({ chainId, preventPollingOnNetworkRestart = false, onNetworkStateChange, interval = DEFAULT_INTERVAL, cacheRefreshThreshold = DEFAULT_THRESHOLD, messenger, state, }) {
+        super({
+            name,
+            metadata,
+            messenger,
+            state: Object.assign(Object.assign({}, defaultState), state),
+        });
+        _TokenListController_instances.add(this);
+        this.mutex = new async_mutex_1.Mutex();
+        this.intervalDelay = interval;
+        this.cacheRefreshThreshold = cacheRefreshThreshold;
+        this.chainId = chainId;
+        this.updatePreventPollingOnNetworkRestart(preventPollingOnNetworkRestart);
+        this.abortController = new abort_controller_1.AbortController();
+        if (onNetworkStateChange) {
+            onNetworkStateChange((networkStateOrProviderConfig) => __awaiter(this, void 0, void 0, function* () {
+                // this check for "provider" is for testing purposes, since in the extension this callback will receive
+                // an object typed as NetworkState but within repo we can only simulate as if the callback receives an
+                // object typed as ProviderConfig
+                if ('provider' in networkStateOrProviderConfig) {
+                    yield __classPrivateFieldGet(this, _TokenListController_instances, "m", _TokenListController_onNetworkStateChangeCallback).call(this, networkStateOrProviderConfig.provider);
+                }
+                else {
+                    yield __classPrivateFieldGet(this, _TokenListController_instances, "m", _TokenListController_onNetworkStateChangeCallback).call(this, networkStateOrProviderConfig);
+                }
+            }));
+        }
+        else {
+            this.messagingSystem.subscribe('NetworkController:providerChange', (providerConfig) => __awaiter(this, void 0, void 0, function* () {
+                yield __classPrivateFieldGet(this, _TokenListController_instances, "m", _TokenListController_onNetworkStateChangeCallback).call(this, providerConfig);
+            }));
+        }
+    }
+    /**
+     * Start polling for the token list.
+     */
+    start() {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (!(0, assetsUtil_1.isTokenListSupportedForNetwork)(this.chainId)) {
+                return;
+            }
+            yield this.startPolling();
+        });
+    }
+    /**
+     * Restart polling for the token list.
+     */
+    restart() {
+        return __awaiter(this, void 0, void 0, function* () {
+            this.stopPolling();
+            yield this.startPolling();
+        });
+    }
+    /**
+     * Stop polling for the token list.
+     */
+    stop() {
+        this.stopPolling();
+    }
+    /**
+     * Prepare to discard this controller.
+     *
+     * This stops any active polling.
+     */
+    destroy() {
+        super.destroy();
+        this.stopPolling();
+    }
+    stopPolling() {
+        if (this.intervalId) {
+            clearInterval(this.intervalId);
+        }
+    }
+    /**
+     * Starts a new polling interval.
+     */
+    startPolling() {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield (0, controller_utils_1.safelyExecute)(() => this.fetchTokenList());
+            this.intervalId = setInterval(() => __awaiter(this, void 0, void 0, function* () {
+                yield (0, controller_utils_1.safelyExecute)(() => this.fetchTokenList());
+            }), this.intervalDelay);
+        });
+    }
+    /**
+     * Fetching token list from the Token Service API.
+     */
+    fetchTokenList() {
+        var _a;
+        return __awaiter(this, void 0, void 0, function* () {
+            const releaseLock = yield this.mutex.acquire();
+            try {
+                const { tokensChainsCache } = this.state;
+                let tokenList = {};
+                const cachedTokens = yield (0, controller_utils_1.safelyExecute)(() => this.fetchFromCache());
+                if (cachedTokens) {
+                    // Use non-expired cached tokens
+                    tokenList = Object.assign({}, cachedTokens);
+                }
+                else {
+                    // Fetch fresh token list
+                    const tokensFromAPI = yield (0, controller_utils_1.safelyExecute)(() => (0, token_service_1.fetchTokenList)(this.chainId, this.abortController.signal));
+                    if (!tokensFromAPI) {
+                        // Fallback to expired cached tokens
+                        tokenList = Object.assign({}, (((_a = tokensChainsCache[this.chainId]) === null || _a === void 0 ? void 0 : _a.data) || {}));
+                        this.update(() => {
+                            return Object.assign(Object.assign({}, this.state), { tokenList,
+                                tokensChainsCache });
+                        });
+                        return;
+                    }
+                    // Filtering out tokens with less than 3 occurrences and native tokens
+                    const filteredTokenList = tokensFromAPI.filter((token) => token.occurrences &&
+                        token.occurrences >= 3 &&
+                        token.address !== '0x0000000000000000000000000000000000000000');
+                    // Removing the tokens with symbol conflicts
+                    const symbolsList = filteredTokenList.map((token) => token.symbol);
+                    const duplicateSymbols = [
+                        ...new Set(symbolsList.filter((symbol, index) => symbolsList.indexOf(symbol) !== index)),
+                    ];
+                    const uniqueTokenList = filteredTokenList.filter((token) => !duplicateSymbols.includes(token.symbol));
+                    for (const token of uniqueTokenList) {
+                        const formattedToken = Object.assign(Object.assign({}, token), { aggregators: (0, assetsUtil_1.formatAggregatorNames)(token.aggregators), iconUrl: (0, assetsUtil_1.formatIconUrlWithProxy)({
+                                chainId: this.chainId,
+                                tokenAddress: token.address,
+                            }) });
+                        tokenList[token.address] = formattedToken;
+                    }
+                }
+                const updatedTokensChainsCache = Object.assign(Object.assign({}, tokensChainsCache), { [this.chainId]: {
+                        timestamp: Date.now(),
+                        data: tokenList,
+                    } });
+                this.update(() => {
+                    return Object.assign(Object.assign({}, this.state), { tokenList, tokensChainsCache: updatedTokensChainsCache });
+                });
+            }
+            finally {
+                releaseLock();
+            }
+        });
+    }
+    /**
+     * Checks if the Cache timestamp is valid,
+     * if yes data in cache will be returned
+     * otherwise null will be returned.
+     *
+     * @returns The cached data, or `null` if the cache was expired.
+     */
+    fetchFromCache() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const { tokensChainsCache } = this.state;
+            const dataCache = tokensChainsCache[this.chainId];
+            const now = Date.now();
+            if ((dataCache === null || dataCache === void 0 ? void 0 : dataCache.data) &&
+                now - (dataCache === null || dataCache === void 0 ? void 0 : dataCache.timestamp) < this.cacheRefreshThreshold) {
+                return dataCache.data;
+            }
+            return null;
+        });
+    }
+    /**
+     * Clearing tokenList and tokensChainsCache explicitly.
+     */
+    clearingTokenListData() {
+        this.update(() => {
+            return Object.assign(Object.assign({}, this.state), { tokenList: {}, tokensChainsCache: {} });
+        });
+    }
+    /**
+     * Updates preventPollingOnNetworkRestart from extension.
+     *
+     * @param shouldPreventPolling - Determine whether to prevent polling on network change
+     */
+    updatePreventPollingOnNetworkRestart(shouldPreventPolling) {
+        this.update(() => {
+            return Object.assign(Object.assign({}, this.state), { preventPollingOnNetworkRestart: shouldPreventPolling });
+        });
+    }
+}
+exports.TokenListController = TokenListController;
+_TokenListController_instances = new WeakSet(), _TokenListController_onNetworkStateChangeCallback = function _TokenListController_onNetworkStateChangeCallback(providerConfig) {
+    return __awaiter(this, void 0, void 0, function* () {
+        if (this.chainId !== providerConfig.chainId) {
+            this.abortController.abort();
+            this.abortController = new abort_controller_1.AbortController();
+            this.chainId = providerConfig.chainId;
+            if (this.state.preventPollingOnNetworkRestart) {
+                this.clearingTokenListData();
+            }
+            else {
+                // Ensure tokenList is referencing data from correct network
+                this.update(() => {
+                    var _a;
+                    return Object.assign(Object.assign({}, this.state), { tokenList: ((_a = this.state.tokensChainsCache[this.chainId]) === null || _a === void 0 ? void 0 : _a.data) || {} });
+                });
+                yield this.restart();
+            }
+        }
+    });
+};
+exports.default = TokenListController;
+//# sourceMappingURL=TokenListController.js.map

package/dist/TokenListController.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"TokenListController.js","sourceRoot":"","sources":["../src/TokenListController.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;AACA,6CAAoC;AACpC,uDAA4E;AAC5E,+DAGmC;AACnC,iEAA2D;AAM3D,6CAIsB;AACtB,mDAAiD;AAEjD,MAAM,gBAAgB,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,IAAI,CAAC;AAC7C,MAAM,iBAAiB,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,IAAI,CAAC;AAE9C,MAAM,IAAI,GAAG,qBAAqB,CAAC;AA8CnC,MAAM,QAAQ,GAAG;IACf,SAAS,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,IAAI,EAAE;IAC7C,iBAAiB,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,IAAI,EAAE;IACrD,8BAA8B,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,IAAI,EAAE;CACnE,CAAC;AAEF,MAAM,YAAY,GAAmB;IACnC,SAAS,EAAE,EAAE;IACb,iBAAiB,EAAE,EAAE;IACrB,8BAA8B,EAAE,KAAK;CACtC,CAAC;AAEF;;GAEG;AACH,MAAa,mBAAoB,SAAQ,kCAIxC;IAaC;;;;;;;;;;;OAWG;IACH,YAAY,EACV,OAAO,EACP,8BAA8B,GAAG,KAAK,EACtC,oBAAoB,EACpB,QAAQ,GAAG,gBAAgB,EAC3B,qBAAqB,GAAG,iBAAiB,EACzC,SAAS,EACT,KAAK,GAWN;QACC,KAAK,CAAC;YACJ,IAAI;YACJ,QAAQ;YACR,SAAS;YACT,KAAK,kCAAO,YAAY,GAAK,KAAK,CAAE;SACrC,CAAC,CAAC;;QAhDG,UAAK,GAAG,IAAI,mBAAK,EAAE,CAAC;QAiD1B,IAAI,CAAC,aAAa,GAAG,QAAQ,CAAC;QAC9B,IAAI,CAAC,qBAAqB,GAAG,qBAAqB,CAAC;QACnD,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QACvB,IAAI,CAAC,oCAAoC,CAAC,8BAA8B,CAAC,CAAC;QAC1E,IAAI,CAAC,eAAe,GAAG,IAAI,kCAAqB,EAAE,CAAC;QACnD,IAAI,oBAAoB,EAAE;YACxB,oBAAoB,CAAC,CAAO,4BAA4B,EAAE,EAAE;gBAC1D,uGAAuG;gBACvG,sGAAsG;gBACtG,iCAAiC;gBACjC,IAAI,UAAU,IAAI,4BAA4B,EAAE;oBAC9C,MAAM,uBAAA,IAAI,yFAA8B,MAAlC,IAAI,EACR,4BAA4B,CAAC,QAAQ,CACtC,CAAC;iBACH;qBAAM;oBACL,MAAM,uBAAA,IAAI,yFAA8B,MAAlC,IAAI,EACR,4BAA4B,CAC7B,CAAC;iBACH;YACH,CAAC,CAAA,CAAC,CAAC;SACJ;aAAM;YACL,IAAI,CAAC,eAAe,CAAC,SAAS,CAC5B,kCAAkC,EAClC,CAAO,cAAc,EAAE,EAAE;gBACvB,MAAM,uBAAA,IAAI,yFAA8B,MAAlC,IAAI,EAA+B,cAAc,CAAC,CAAC;YAC3D,CAAC,CAAA,CACF,CAAC;SACH;IACH,CAAC;IA2BD;;OAEG;IACG,KAAK;;YACT,IAAI,CAAC,IAAA,2CAA8B,EAAC,IAAI,CAAC,OAAO,CAAC,EAAE;gBACjD,OAAO;aACR;YACD,MAAM,IAAI,CAAC,YAAY,EAAE,CAAC;QAC5B,CAAC;KAAA;IAED;;OAEG;IACG,OAAO;;YACX,IAAI,CAAC,WAAW,EAAE,CAAC;YACnB,MAAM,IAAI,CAAC,YAAY,EAAE,CAAC;QAC5B,CAAC;KAAA;IAED;;OAEG;IACH,IAAI;QACF,IAAI,CAAC,WAAW,EAAE,CAAC;IACrB,CAAC;IAED;;;;OAIG;IACM,OAAO;QACd,KAAK,CAAC,OAAO,EAAE,CAAC;QAChB,IAAI,CAAC,WAAW,EAAE,CAAC;IACrB,CAAC;IAEO,WAAW;QACjB,IAAI,IAAI,CAAC,UAAU,EAAE;YACnB,aAAa,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;SAChC;IACH,CAAC;IAED;;OAEG;IACW,YAAY;;YACxB,MAAM,IAAA,gCAAa,EAAC,GAAG,EAAE,CAAC,IAAI,CAAC,cAAc,EAAE,CAAC,CAAC;YACjD,IAAI,CAAC,UAAU,GAAG,WAAW,CAAC,GAAS,EAAE;gBACvC,MAAM,IAAA,gCAAa,EAAC,GAAG,EAAE,CAAC,IAAI,CAAC,cAAc,EAAE,CAAC,CAAC;YACnD,CAAC,CAAA,EAAE,IAAI,CAAC,aAAa,CAAC,CAAC;QACzB,CAAC;KAAA;IAED;;OAEG;IACG,cAAc;;;YAClB,MAAM,WAAW,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,OAAO,EAAE,CAAC;YAC/C,IAAI;gBACF,MAAM,EAAE,iBAAiB,EAAE,GAAG,IAAI,CAAC,KAAK,CAAC;gBACzC,IAAI,SAAS,GAAiB,EAAE,CAAC;gBACjC,MAAM,YAAY,GAAiB,MAAM,IAAA,gCAAa,EAAC,GAAG,EAAE,CAC1D,IAAI,CAAC,cAAc,EAAE,CACtB,CAAC;gBACF,IAAI,YAAY,EAAE;oBAChB,gCAAgC;oBAChC,SAAS,qBAAQ,YAAY,CAAE,CAAC;iBACjC;qBAAM;oBACL,yBAAyB;oBACzB,MAAM,aAAa,GAAqB,MAAM,IAAA,gCAAa,EAAC,GAAG,EAAE,CAC/D,IAAA,8BAAc,EAAC,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,eAAe,CAAC,MAAM,CAAC,CAC1D,CAAC;oBAEF,IAAI,CAAC,aAAa,EAAE;wBAClB,oCAAoC;wBACpC,SAAS,qBAAQ,CAAC,CAAA,MAAA,iBAAiB,CAAC,IAAI,CAAC,OAAO,CAAC,0CAAE,IAAI,KAAI,EAAE,CAAC,CAAE,CAAC;wBAEjE,IAAI,CAAC,MAAM,CAAC,GAAG,EAAE;4BACf,uCACK,IAAI,CAAC,KAAK,KACb,SAAS;gCACT,iBAAiB,IACjB;wBACJ,CAAC,CAAC,CAAC;wBACH,OAAO;qBACR;oBACD,sEAAsE;oBACtE,MAAM,iBAAiB,GAAG,aAAa,CAAC,MAAM,CAC5C,CAAC,KAAK,EAAE,EAAE,CACR,KAAK,CAAC,WAAW;wBACjB,KAAK,CAAC,WAAW,IAAI,CAAC;wBACtB,KAAK,CAAC,OAAO,KAAK,4CAA4C,CACjE,CAAC;oBACF,4CAA4C;oBAC5C,MAAM,WAAW,GAAG,iBAAiB,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;oBACnE,MAAM,gBAAgB,GAAG;wBACvB,GAAG,IAAI,GAAG,CACR,WAAW,CAAC,MAAM,CAChB,CAAC,MAAM,EAAE,KAAK,EAAE,EAAE,CAAC,WAAW,CAAC,OAAO,CAAC,MAAM,CAAC,KAAK,KAAK,CACzD,CACF;qBACF,CAAC;oBACF,MAAM,eAAe,GAAG,iBAAiB,CAAC,MAAM,CAC9C,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,gBAAgB,CAAC,QAAQ,CAAC,KAAK,CAAC,MAAM,CAAC,CACpD,CAAC;oBACF,KAAK,MAAM,KAAK,IAAI,eAAe,EAAE;wBACnC,MAAM,cAAc,mCACf,KAAK,KACR,WAAW,EAAE,IAAA,kCAAqB,EAAC,KAAK,CAAC,WAAW,CAAC,EACrD,OAAO,EAAE,IAAA,mCAAsB,EAAC;gCAC9B,OAAO,EAAE,IAAI,CAAC,OAAO;gCACrB,YAAY,EAAE,KAAK,CAAC,OAAO;6BAC5B,CAAC,GACH,CAAC;wBACF,SAAS,CAAC,KAAK,CAAC,OAAO,CAAC,GAAG,cAAc,CAAC;qBAC3C;iBACF;gBACD,MAAM,wBAAwB,mCACzB,iBAAiB,KACpB,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE;wBACd,SAAS,EAAE,IAAI,CAAC,GAAG,EAAE;wBACrB,IAAI,EAAE,SAAS;qBAChB,GACF,CAAC;gBACF,IAAI,CAAC,MAAM,CAAC,GAAG,EAAE;oBACf,uCACK,IAAI,CAAC,KAAK,KACb,SAAS,EACT,iBAAiB,EAAE,wBAAwB,IAC3C;gBACJ,CAAC,CAAC,CAAC;aACJ;oBAAS;gBACR,WAAW,EAAE,CAAC;aACf;;KACF;IAED;;;;;;OAMG;IACG,cAAc;;YAClB,MAAM,EAAE,iBAAiB,EAAE,GAAmB,IAAI,CAAC,KAAK,CAAC;YACzD,MAAM,SAAS,GAAG,iBAAiB,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;YAClD,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;YACvB,IACE,CAAA,SAAS,aAAT,SAAS,uBAAT,SAAS,CAAE,IAAI;gBACf,GAAG,IAAG,SAAS,aAAT,SAAS,uBAAT,SAAS,CAAE,SAAS,CAAA,GAAG,IAAI,CAAC,qBAAqB,EACvD;gBACA,OAAO,SAAS,CAAC,IAAI,CAAC;aACvB;YACD,OAAO,IAAI,CAAC;QACd,CAAC;KAAA;IAED;;OAEG;IACH,qBAAqB;QACnB,IAAI,CAAC,MAAM,CAAC,GAAG,EAAE;YACf,uCACK,IAAI,CAAC,KAAK,KACb,SAAS,EAAE,EAAE,EACb,iBAAiB,EAAE,EAAE,IACrB;QACJ,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;;;OAIG;IACH,oCAAoC,CAAC,oBAA6B;QAChE,IAAI,CAAC,MAAM,CAAC,GAAG,EAAE;YACf,uCACK,IAAI,CAAC,KAAK,KACb,8BAA8B,EAAE,oBAAoB,IACpD;QACJ,CAAC,CAAC,CAAC;IACL,CAAC;CACF;AAjSD,kDAiSC;+JAxMqC,cAA8B;;QAChE,IAAI,IAAI,CAAC,OAAO,KAAK,cAAc,CAAC,OAAO,EAAE;YAC3C,IAAI,CAAC,eAAe,CAAC,KAAK,EAAE,CAAC;YAC7B,IAAI,CAAC,eAAe,GAAG,IAAI,kCAAqB,EAAE,CAAC;YACnD,IAAI,CAAC,OAAO,GAAG,cAAc,CAAC,OAAO,CAAC;YACtC,IAAI,IAAI,CAAC,KAAK,CAAC,8BAA8B,EAAE;gBAC7C,IAAI,CAAC,qBAAqB,EAAE,CAAC;aAC9B;iBAAM;gBACL,4DAA4D;gBAC5D,IAAI,CAAC,MAAM,CAAC,GAAG,EAAE;;oBACf,uCACK,IAAI,CAAC,KAAK,KACb,SAAS,EAAE,CAAA,MAAA,IAAI,CAAC,KAAK,CAAC,iBAAiB,CAAC,IAAI,CAAC,OAAO,CAAC,0CAAE,IAAI,KAAI,EAAE,IACjE;gBACJ,CAAC,CAAC,CAAC;gBACH,MAAM,IAAI,CAAC,OAAO,EAAE,CAAC;aACtB;SACF;IACH,CAAC;;AAwLH,kBAAe,mBAAmB,CAAC","sourcesContent":["import type { Patch } from 'immer';\nimport { Mutex } from 'async-mutex';\nimport { AbortController as WhatwgAbortController } from 'abort-controller';\nimport {\n  BaseControllerV2,\n  RestrictedControllerMessenger,\n} from '@metamask/base-controller';\nimport { safelyExecute } from '@metamask/controller-utils';\nimport {\n  NetworkControllerProviderChangeEvent,\n  NetworkState,\n  ProviderConfig,\n} from '@metamask/network-controller';\nimport {\n  isTokenListSupportedForNetwork,\n  formatAggregatorNames,\n  formatIconUrlWithProxy,\n} from './assetsUtil';\nimport { fetchTokenList } from './token-service';\n\nconst DEFAULT_INTERVAL = 24 * 60 * 60 * 1000;\nconst DEFAULT_THRESHOLD = 24 * 60 * 60 * 1000;\n\nconst name = 'TokenListController';\n\nexport type TokenListToken = {\n  name: string;\n  symbol: string;\n  decimals: number;\n  address: string;\n  occurrences: number;\n  aggregators: string[];\n  iconUrl: string;\n};\n\nexport type TokenListMap = Record<string, TokenListToken>;\n\ntype DataCache = {\n  timestamp: number;\n  data: TokenListMap;\n};\ntype TokensChainsCache = {\n  [chainSlug: string]: DataCache;\n};\n\nexport type TokenListState = {\n  tokenList: TokenListMap;\n  tokensChainsCache: TokensChainsCache;\n  preventPollingOnNetworkRestart: boolean;\n};\n\nexport type TokenListStateChange = {\n  type: `${typeof name}:stateChange`;\n  payload: [TokenListState, Patch[]];\n};\n\nexport type GetTokenListState = {\n  type: `${typeof name}:getState`;\n  handler: () => TokenListState;\n};\n\ntype TokenListMessenger = RestrictedControllerMessenger<\n  typeof name,\n  GetTokenListState,\n  TokenListStateChange | NetworkControllerProviderChangeEvent,\n  never,\n  TokenListStateChange['type'] | NetworkControllerProviderChangeEvent['type']\n>;\n\nconst metadata = {\n  tokenList: { persist: true, anonymous: true },\n  tokensChainsCache: { persist: true, anonymous: true },\n  preventPollingOnNetworkRestart: { persist: true, anonymous: true },\n};\n\nconst defaultState: TokenListState = {\n  tokenList: {},\n  tokensChainsCache: {},\n  preventPollingOnNetworkRestart: false,\n};\n\n/**\n * Controller that passively polls on a set interval for the list of tokens from metaswaps api\n */\nexport class TokenListController extends BaseControllerV2<\n  typeof name,\n  TokenListState,\n  TokenListMessenger\n> {\n  private mutex = new Mutex();\n\n  private intervalId?: ReturnType<typeof setTimeout>;\n\n  private intervalDelay: number;\n\n  private cacheRefreshThreshold: number;\n\n  private chainId: string;\n\n  private abortController: WhatwgAbortController;\n\n  /**\n   * Creates a TokenListController instance.\n   *\n   * @param options - The controller options.\n   * @param options.chainId - The chain ID of the current network.\n   * @param options.onNetworkStateChange - A function for registering an event handler for network state changes.\n   * @param options.interval - The polling interval, in milliseconds.\n   * @param options.cacheRefreshThreshold - The token cache expiry time, in milliseconds.\n   * @param options.messenger - A restricted controller messenger.\n   * @param options.state - Initial state to set on this controller.\n   * @param options.preventPollingOnNetworkRestart - Determines whether to prevent poilling on network restart in extension.\n   */\n  constructor({\n    chainId,\n    preventPollingOnNetworkRestart = false,\n    onNetworkStateChange,\n    interval = DEFAULT_INTERVAL,\n    cacheRefreshThreshold = DEFAULT_THRESHOLD,\n    messenger,\n    state,\n  }: {\n    chainId: string;\n    preventPollingOnNetworkRestart?: boolean;\n    onNetworkStateChange?: (\n      listener: (networkState: NetworkState | ProviderConfig) => void,\n    ) => void;\n    interval?: number;\n    cacheRefreshThreshold?: number;\n    messenger: TokenListMessenger;\n    state?: Partial<TokenListState>;\n  }) {\n    super({\n      name,\n      metadata,\n      messenger,\n      state: { ...defaultState, ...state },\n    });\n    this.intervalDelay = interval;\n    this.cacheRefreshThreshold = cacheRefreshThreshold;\n    this.chainId = chainId;\n    this.updatePreventPollingOnNetworkRestart(preventPollingOnNetworkRestart);\n    this.abortController = new WhatwgAbortController();\n    if (onNetworkStateChange) {\n      onNetworkStateChange(async (networkStateOrProviderConfig) => {\n        // this check for \"provider\" is for testing purposes, since in the extension this callback will receive\n        // an object typed as NetworkState but within repo we can only simulate as if the callback receives an\n        // object typed as ProviderConfig\n        if ('provider' in networkStateOrProviderConfig) {\n          await this.#onNetworkStateChangeCallback(\n            networkStateOrProviderConfig.provider,\n          );\n        } else {\n          await this.#onNetworkStateChangeCallback(\n            networkStateOrProviderConfig,\n          );\n        }\n      });\n    } else {\n      this.messagingSystem.subscribe(\n        'NetworkController:providerChange',\n        async (providerConfig) => {\n          await this.#onNetworkStateChangeCallback(providerConfig);\n        },\n      );\n    }\n  }\n\n  /**\n   * Updates state and restart polling when updates are received through NetworkController subscription.\n   *\n   * @param providerConfig - the configuration for a provider containing critical network info.\n   */\n  async #onNetworkStateChangeCallback(providerConfig: ProviderConfig) {\n    if (this.chainId !== providerConfig.chainId) {\n      this.abortController.abort();\n      this.abortController = new WhatwgAbortController();\n      this.chainId = providerConfig.chainId;\n      if (this.state.preventPollingOnNetworkRestart) {\n        this.clearingTokenListData();\n      } else {\n        // Ensure tokenList is referencing data from correct network\n        this.update(() => {\n          return {\n            ...this.state,\n            tokenList: this.state.tokensChainsCache[this.chainId]?.data || {},\n          };\n        });\n        await this.restart();\n      }\n    }\n  }\n\n  /**\n   * Start polling for the token list.\n   */\n  async start() {\n    if (!isTokenListSupportedForNetwork(this.chainId)) {\n      return;\n    }\n    await this.startPolling();\n  }\n\n  /**\n   * Restart polling for the token list.\n   */\n  async restart() {\n    this.stopPolling();\n    await this.startPolling();\n  }\n\n  /**\n   * Stop polling for the token list.\n   */\n  stop() {\n    this.stopPolling();\n  }\n\n  /**\n   * Prepare to discard this controller.\n   *\n   * This stops any active polling.\n   */\n  override destroy() {\n    super.destroy();\n    this.stopPolling();\n  }\n\n  private stopPolling() {\n    if (this.intervalId) {\n      clearInterval(this.intervalId);\n    }\n  }\n\n  /**\n   * Starts a new polling interval.\n   */\n  private async startPolling(): Promise<void> {\n    await safelyExecute(() => this.fetchTokenList());\n    this.intervalId = setInterval(async () => {\n      await safelyExecute(() => this.fetchTokenList());\n    }, this.intervalDelay);\n  }\n\n  /**\n   * Fetching token list from the Token Service API.\n   */\n  async fetchTokenList(): Promise<void> {\n    const releaseLock = await this.mutex.acquire();\n    try {\n      const { tokensChainsCache } = this.state;\n      let tokenList: TokenListMap = {};\n      const cachedTokens: TokenListMap = await safelyExecute(() =>\n        this.fetchFromCache(),\n      );\n      if (cachedTokens) {\n        // Use non-expired cached tokens\n        tokenList = { ...cachedTokens };\n      } else {\n        // Fetch fresh token list\n        const tokensFromAPI: TokenListToken[] = await safelyExecute(() =>\n          fetchTokenList(this.chainId, this.abortController.signal),\n        );\n\n        if (!tokensFromAPI) {\n          // Fallback to expired cached tokens\n          tokenList = { ...(tokensChainsCache[this.chainId]?.data || {}) };\n\n          this.update(() => {\n            return {\n              ...this.state,\n              tokenList,\n              tokensChainsCache,\n            };\n          });\n          return;\n        }\n        // Filtering out tokens with less than 3 occurrences and native tokens\n        const filteredTokenList = tokensFromAPI.filter(\n          (token) =>\n            token.occurrences &&\n            token.occurrences >= 3 &&\n            token.address !== '0x0000000000000000000000000000000000000000',\n        );\n        // Removing the tokens with symbol conflicts\n        const symbolsList = filteredTokenList.map((token) => token.symbol);\n        const duplicateSymbols = [\n          ...new Set(\n            symbolsList.filter(\n              (symbol, index) => symbolsList.indexOf(symbol) !== index,\n            ),\n          ),\n        ];\n        const uniqueTokenList = filteredTokenList.filter(\n          (token) => !duplicateSymbols.includes(token.symbol),\n        );\n        for (const token of uniqueTokenList) {\n          const formattedToken: TokenListToken = {\n            ...token,\n            aggregators: formatAggregatorNames(token.aggregators),\n            iconUrl: formatIconUrlWithProxy({\n              chainId: this.chainId,\n              tokenAddress: token.address,\n            }),\n          };\n          tokenList[token.address] = formattedToken;\n        }\n      }\n      const updatedTokensChainsCache: TokensChainsCache = {\n        ...tokensChainsCache,\n        [this.chainId]: {\n          timestamp: Date.now(),\n          data: tokenList,\n        },\n      };\n      this.update(() => {\n        return {\n          ...this.state,\n          tokenList,\n          tokensChainsCache: updatedTokensChainsCache,\n        };\n      });\n    } finally {\n      releaseLock();\n    }\n  }\n\n  /**\n   * Checks if the Cache timestamp is valid,\n   * if yes data in cache will be returned\n   * otherwise null will be returned.\n   *\n   * @returns The cached data, or `null` if the cache was expired.\n   */\n  async fetchFromCache(): Promise<TokenListMap | null> {\n    const { tokensChainsCache }: TokenListState = this.state;\n    const dataCache = tokensChainsCache[this.chainId];\n    const now = Date.now();\n    if (\n      dataCache?.data &&\n      now - dataCache?.timestamp < this.cacheRefreshThreshold\n    ) {\n      return dataCache.data;\n    }\n    return null;\n  }\n\n  /**\n   * Clearing tokenList and tokensChainsCache explicitly.\n   */\n  clearingTokenListData(): void {\n    this.update(() => {\n      return {\n        ...this.state,\n        tokenList: {},\n        tokensChainsCache: {},\n      };\n    });\n  }\n\n  /**\n   * Updates preventPollingOnNetworkRestart from extension.\n   *\n   * @param shouldPreventPolling - Determine whether to prevent polling on network change\n   */\n  updatePreventPollingOnNetworkRestart(shouldPreventPolling: boolean): void {\n    this.update(() => {\n      return {\n        ...this.state,\n        preventPollingOnNetworkRestart: shouldPreventPolling,\n      };\n    });\n  }\n}\n\nexport default TokenListController;\n"]}

package/dist/TokenRatesController.d.ts

@@ -0,0 +1,167 @@
+import { BaseController, BaseConfig, BaseState } from '@metamask/base-controller';
+import type { NetworkState } from '@metamask/network-controller';
+import type { TokensState } from './TokensController';
+import type { CurrencyRateState } from './CurrencyRateController';
+/**
+ * @type CoinGeckoResponse
+ *
+ * CoinGecko API response representation
+ */
+export interface CoinGeckoResponse {
+    [address: string]: {
+        [currency: string]: number;
+    };
+}
+/**
+ * @type CoinGeckoPlatform
+ *
+ * CoinGecko supported platform API representation
+ */
+export interface CoinGeckoPlatform {
+    id: string;
+    chain_identifier: null | number;
+    name: string;
+    shortname: string;
+}
+/**
+ * @type Token
+ *
+ * Token representation
+ * @property address - Hex address of the token contract
+ * @property decimals - Number of decimals the token uses
+ * @property symbol - Symbol of the token
+ * @property image - Image of the token, url or bit32 image
+ */
+export interface Token {
+    address: string;
+    decimals: number;
+    symbol: string;
+    aggregators?: string[];
+    image?: string;
+    balanceError?: unknown;
+    isERC721?: boolean;
+}
+/**
+ * @type TokenRatesConfig
+ *
+ * Token rates controller configuration
+ * @property interval - Polling interval used to fetch new token rates
+ * @property nativeCurrency - Current native currency selected to use base of rates
+ * @property chainId - Current network chainId
+ * @property tokens - List of tokens to track exchange rates for
+ * @property threshold - Threshold to invalidate the supportedChains
+ */
+export interface TokenRatesConfig extends BaseConfig {
+    interval: number;
+    nativeCurrency: string;
+    chainId: string;
+    tokens: Token[];
+    threshold: number;
+}
+interface ContractExchangeRates {
+    [address: string]: number | undefined;
+}
+/**
+ * @type TokenRatesState
+ *
+ * Token rates controller state
+ * @property contractExchangeRates - Hash of token contract addresses to exchange rates
+ * @property supportedChains - Cached chain data
+ */
+export interface TokenRatesState extends BaseState {
+    contractExchangeRates: ContractExchangeRates;
+}
+/**
+ * Controller that passively polls on a set interval for token-to-fiat exchange rates
+ * for tokens stored in the TokensController
+ */
+export declare class TokenRatesController extends BaseController<TokenRatesConfig, TokenRatesState> {
+    private handle?;
+    private tokenList;
+    private supportedChains;
+    private supportedVsCurrencies;
+    /**
+     * Name of this controller used during composition
+     */
+    name: string;
+    /**
+     * 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, }: {
+        onTokensStateChange: (listener: (tokensState: TokensState) => void) => void;
+        onCurrencyRateStateChange: (listener: (currencyRateState: CurrencyRateState) => void) => void;
+        onNetworkStateChange: (listener: (networkState: NetworkState) => void) => void;
+    }, config?: Partial<TokenRatesConfig>, state?: Partial<TokenRatesState>);
+    /**
+     * Sets a new polling interval.
+     *
+     * @param interval - Polling interval used to fetch new token rates.
+     */
+    poll(interval?: number): Promise<void>;
+    /**
+     * Sets a new chainId.
+     *
+     * TODO: Replace this with a method.
+     *
+     * @param _chainId - The current chain ID.
+     */
+    set chainId(_chainId: string);
+    get chainId(): string;
+    /**
+     * 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: Token[]);
+    get tokens(): Token[];
+    /**
+     * 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: string, vsCurrency: string): Promise<CoinGeckoResponse>;
+    /**
+     * 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.
+     */
+    private checkIsSupportedVsCurrency;
+    /**
+     * 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(): Promise<string | null>;
+    /**
+     * Updates exchange rates for all tokens.
+     */
+    updateExchangeRates(): Promise<void>;
+    /**
+     * 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: string, slug: string): Promise<ContractExchangeRates>;
+}
+export default TokenRatesController;