@metamask-previews/assets-controllers 60.0.0-preview-47d1bd5 → 60.0.0-preview-5aa4d0a9

package/CHANGELOG.md

@@ -7,8 +7,13 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+### Added
+
+- **BREAKING:** Add event listener for `AccountsController:accountRemoved` to remove token balances for the removed account ([#5726](https://github.com/MetaMask/core/pull/5726))
+
 ### Changed
 
+- TokenBalancesController will now check if balances has changed before updating the state ([#5726](https://github.com/MetaMask/core/pull/5726))
 - Bump `@metamask/base-controller` from ^8.0.0 to ^8.0.1 ([#5722](https://github.com/MetaMask/core/pull/5722))
 
 ## [60.0.0]

package/dist/TokenBalancesController.cjs

@@ -10,7 +10,7 @@ var __classPrivateFieldSet = (this && this.__classPrivateFieldSet) || function (
     if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot write private member to an object whose class did not declare it");
     return (kind === "a" ? f.call(receiver, value) : f ? f.value = value : state.set(receiver, value)), value;
 };
-var _TokenBalancesController_instances, _TokenBalancesController_queryMultipleAccounts, _TokenBalancesController_allTokens, _TokenBalancesController_allDetectedTokens, _TokenBalancesController_calculateQueryMultipleAccounts, _TokenBalancesController_onPreferencesStateChange, _TokenBalancesController_onTokensStateChange, _TokenBalancesController_onNetworkStateChange, _TokenBalancesController_getChainIds, _TokenBalancesController_getNetworkClient;
+var _TokenBalancesController_instances, _TokenBalancesController_queryMultipleAccounts, _TokenBalancesController_allTokens, _TokenBalancesController_allDetectedTokens, _TokenBalancesController_calculateQueryMultipleAccounts, _TokenBalancesController_onPreferencesStateChange, _TokenBalancesController_onTokensStateChange, _TokenBalancesController_onNetworkStateChange, _TokenBalancesController_handleOnAccountRemoved, _TokenBalancesController_getChainIds, _TokenBalancesController_cleanupCurrentTokenBalances, _TokenBalancesController_getNetworkClient;
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.TokenBalancesController = exports.getDefaultTokenBalancesState = void 0;
 const contracts_1 = require("@ethersproject/contracts");
@@ -129,6 +129,8 @@ class TokenBalancesController extends (0, polling_controller_1.StaticIntervalPol
         this.messagingSystem.subscribe('TokensController:stateChange', __classPrivateFieldGet(this, _TokenBalancesController_onTokensStateChange, "f").bind(this));
         // Subscribe to network state changes
         this.messagingSystem.subscribe('NetworkController:stateChange', __classPrivateFieldGet(this, _TokenBalancesController_instances, "m", _TokenBalancesController_onNetworkStateChange).bind(this));
+        // subscribe to account removed event to cleanup stale balances
+        this.messagingSystem.subscribe('AccountsController:accountRemoved', (accountAddress) => __classPrivateFieldGet(this, _TokenBalancesController_instances, "m", _TokenBalancesController_handleOnAccountRemoved).call(this, accountAddress));
     }
     /**
      * Polls for erc20 token balances.
@@ -168,6 +170,9 @@ class TokenBalancesController extends (0, polling_controller_1.StaticIntervalPol
         Object.entries(__classPrivateFieldGet(this, _TokenBalancesController_allTokens, "f")[chainId] ?? {}).forEach(addTokens);
         Object.entries(__classPrivateFieldGet(this, _TokenBalancesController_allDetectedTokens, "f")[chainId] ?? {}).forEach(addTokens);
         let results = [];
+        // in case currentTokenBalances has a token that is not in accountTokenPairs, we will remove it from currentTokenBalances
+        __classPrivateFieldGet(this, _TokenBalancesController_instances, "m", _TokenBalancesController_cleanupCurrentTokenBalances).call(this, accountTokenPairs, chainId);
+        const currentTokenBalances = this.messagingSystem.call('TokenBalancesController:getState');
         if (accountTokenPairs.length > 0) {
             const provider = new providers_1.Web3Provider(__classPrivateFieldGet(this, _TokenBalancesController_instances, "m", _TokenBalancesController_getNetworkClient).call(this, chainId).provider);
             const calls = accountTokenPairs.map(({ accountAddress, tokenAddress }) => ({
@@ -177,17 +182,27 @@ class TokenBalancesController extends (0, polling_controller_1.StaticIntervalPol
             }));
             results = await (0, multicall_1.multicallOrFallback)(calls, chainId, provider);
         }
+        const updatedResults = [...results];
+        for (let i = 0; i < results.length; i++) {
+            const { value } = results[i];
+            const { accountAddress, tokenAddress } = accountTokenPairs[i];
+            const currentTokenBalanceValueForAccount = currentTokenBalances.tokenBalances?.[accountAddress]?.[chainId]?.[tokenAddress];
+            const isTokenBalanceValueChanged = currentTokenBalanceValueForAccount !== (0, controller_utils_1.toHex)(value);
+            updatedResults[i] = {
+                ...results[i],
+                isTokenBalanceValueChanged,
+            };
+        }
+        // if all values of isTokenBalanceValueChanged are false, return
+        if (updatedResults.every((result) => !result.isTokenBalanceValueChanged)) {
+            return;
+        }
         this.update((state) => {
             var _a, _b;
-            // Reset so that when accounts or tokens are removed,
-            // their balances are removed rather than left stale.
-            for (const accountAddress of Object.keys(state.tokenBalances)) {
-                state.tokenBalances[accountAddress][chainId] = {};
-            }
-            for (let i = 0; i < results.length; i++) {
-                const { success, value } = results[i];
+            for (let i = 0; i < updatedResults.length; i++) {
+                const { success, value, isTokenBalanceValueChanged } = updatedResults[i];
                 const { accountAddress, tokenAddress } = accountTokenPairs[i];
-                if (success) {
+                if (success && isTokenBalanceValueChanged) {
                     ((_b = ((_a = state.tokenBalances)[accountAddress] ?? (_a[accountAddress] = {})))[chainId] ?? (_b[chainId] = {}))[tokenAddress] = (0, controller_utils_1.toHex)(value);
                 }
             }
@@ -216,6 +231,25 @@ _TokenBalancesController_queryMultipleAccounts = new WeakMap(), _TokenBalancesCo
             });
         }
     }
+}, _TokenBalancesController_handleOnAccountRemoved = function _TokenBalancesController_handleOnAccountRemoved(accountAddress) {
+    this.update((state) => {
+        delete state.tokenBalances[accountAddress];
+    });
+}, _TokenBalancesController_cleanupCurrentTokenBalances = function _TokenBalancesController_cleanupCurrentTokenBalances(accountTokenPairs, chainId) {
+    // TODO move this to a private fct
+    const currentTokenBalances = this.messagingSystem.call('TokenBalancesController:getState');
+    // in case currentTokenBalances has a token that is not in accountTokenPairs, we will remove it from currentTokenBalances
+    // loop through currentTokenBalances.tokenBalances, for each account loop though the account[chainId] array of tokens and check if the token is in accountTokenPairs
+    // if not, remove it from currentTokenBalances
+    for (const accountAddress of Object.keys(currentTokenBalances.tokenBalances)) {
+        for (const tokenAddress of Object.keys(currentTokenBalances.tokenBalances[accountAddress][chainId])) {
+            if (!accountTokenPairs.some((pair) => pair.tokenAddress === tokenAddress)) {
+                this.update((state) => {
+                    delete state.tokenBalances[accountAddress][chainId][tokenAddress];
+                });
+            }
+        }
+    }
 }, _TokenBalancesController_getNetworkClient = function _TokenBalancesController_getNetworkClient(chainId) {
     const { networkConfigurationsByChainId } = this.messagingSystem.call('NetworkController:getState');
     const networkConfiguration = networkConfigurationsByChainId[chainId];

package/dist/TokenBalancesController.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"TokenBalancesController.cjs","sourceRoot":"","sources":["../src/TokenBalancesController.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAAA,wDAAoD;AACpD,wDAAwD;AAOxD,iEAAyE;AACzE,mEAAuD;AAOvD,qEAA+E;AAS/E,mCAAiC;AAGjC,+CAAkD;AAQlD,MAAM,gBAAgB,GAAG,MAAM,CAAC;AAEhC,MAAM,cAAc,GAAG,yBAAyB,CAAC;AAEjD,MAAM,QAAQ,GAAG;IACf,aAAa,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,KAAK,EAAE;CACnD,CAAC;AAgEF;;;;GAIG;AACH,SAAgB,4BAA4B;IAC1C,OAAO;QACL,aAAa,EAAE,EAAE;KAClB,CAAC;AACJ,CAAC;AAJD,oEAIC;AAOD;;;GAGG;AACH,MAAa,uBAAwB,SAAQ,IAAA,oDAA+B,GAI3E;IAOC;;;;;;;OAOG;IACH,YAAY,EACV,QAAQ,GAAG,gBAAgB,EAC3B,SAAS,EACT,KAAK,GAAG,EAAE,GACqB;;QAC/B,KAAK,CAAC;YACJ,IAAI,EAAE,cAAc;YACpB,QAAQ;YACR,SAAS;YACT,KAAK,EAAE;gBACL,GAAG,4BAA4B,EAAE;gBACjC,GAAG,KAAK;aACT;SACF,CAAC,CAAC;;QA3BL,iEAAgC;QAEhC,qDAA+C;QAE/C,6DAA+D;QAsD/D;;;;;;WAMG;QACH,kEAAkC,CAAC,EACjC,6BAA6B,EAC7B,6BAA6B,GACkC,EAAE,EAAE;YACnE,OAAO,OAAO;YACZ,mEAAmE;YACnE,6BAA6B,IAAI,6BAA6B,CAC/D,CAAC;QACJ,CAAC,EAAC;QAEF;;;WAGG;QACH,4DAA4B,CAAC,WAA6B,EAAE,EAAE;YAC5D,qEAAqE;YACrE,MAAM,qBAAqB,GACzB,uBAAA,IAAI,+DAAgC,MAApC,IAAI,EAAiC,WAAW,CAAC,CAAC;YAEpD,iCAAiC;YACjC,MAAM,OAAO,GAAG,qBAAqB,IAAI,CAAC,uBAAA,IAAI,sDAAuB,CAAC;YACtE,uBAAA,IAAI,kDAA0B,qBAAqB,MAAA,CAAC;YAEpD,IAAI,OAAO,EAAE;gBACX,IAAI,CAAC,cAAc,EAAE,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;aAC5C;QACH,CAAC,EAAC;QAEF;;;;;WAKG;QACH,uDAAuB,CAAC,EACtB,SAAS,EACT,iBAAiB,GACK,EAAE,EAAE;YAC1B,8DAA8D;YAC9D,MAAM,QAAQ,GAAG,uBAAA,IAAI,4CAAa,MAAjB,IAAI,EAAc,SAAS,EAAE,iBAAiB,CAAC,CAAC;YACjE,MAAM,gBAAgB,GAAG,QAAQ,CAAC,MAAM,CACtC,CAAC,OAAO,EAAE,EAAE,CACV,CAAC,IAAA,gBAAO,EAAC,uBAAA,IAAI,0CAAW,CAAC,OAAO,CAAC,EAAE,SAAS,CAAC,OAAO,CAAC,CAAC;gBACtD,CAAC,IAAA,gBAAO,EAAC,uBAAA,IAAI,kDAAmB,CAAC,OAAO,CAAC,EAAE,iBAAiB,CAAC,OAAO,CAAC,CAAC,CACzE,CAAC;YAEF,uBAAA,IAAI,sCAAc,SAAS,MAAA,CAAC;YAC5B,uBAAA,IAAI,8CAAsB,iBAAiB,MAAA,CAAC;YAE5C,IAAI,CAAC,cAAc,CAAC,EAAE,QAAQ,EAAE,gBAAgB,EAAE,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;QAC3E,CAAC,EAAC;QAyBF;;;;;WAKG;QACH,+CAAe,CACb,SAA6C,EAC7C,iBAA6D,EAC7D,EAAE,CACF;YACE,GAAG,IAAI,GAAG,CAAC;gBACT,GAAG,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC;gBACzB,GAAG,MAAM,CAAC,IAAI,CAAC,iBAAiB,CAAC;aAClC,CAAC;SACM,EAAC;QA9HX,IAAI,CAAC,iBAAiB,CAAC,QAAQ,CAAC,CAAC;QAEjC,kFAAkF;QAClF,uBAAA,IAAI,kDAA0B,uBAAA,IAAI,+DAAgC,MAApC,IAAI,EAChC,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,gCAAgC,CAAC,CAC5D,MAAA,CAAC;QACF,IAAI,CAAC,eAAe,CAAC,SAAS,CAC5B,mCAAmC,EACnC,uBAAA,IAAI,yDAA0B,CAAC,IAAI,CAAC,IAAI,CAAC,CAC1C,CAAC;QAEF,+CAA+C;QAC/C,MACa,IAAI,OACI,IAAI,EAFxB;YACC,SAAS,wGAAiB;YAC1B,iBAAiB,gHAAyB;SAC3C,GAAG,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,2BAA2B,CAAC,CAAC,CAAC;QAE5D,IAAI,CAAC,eAAe,CAAC,SAAS,CAC5B,8BAA8B,EAC9B,uBAAA,IAAI,oDAAqB,CAAC,IAAI,CAAC,IAAI,CAAC,CACrC,CAAC;QAEF,qCAAqC;QACrC,IAAI,CAAC,eAAe,CAAC,SAAS,CAC5B,+BAA+B,EAC/B,uBAAA,IAAI,yFAAsB,CAAC,IAAI,CAAC,IAAI,CAAC,CACtC,CAAC;IACJ,CAAC;IAqGD;;;;OAIG;IACH,KAAK,CAAC,YAAY,CAAC,EAAE,OAAO,EAA6B;QACvD,MAAM,IAAI,CAAC,uBAAuB,CAAC,EAAE,OAAO,EAAE,CAAC,CAAC;IAClD,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,cAAc,CAAC,EAAE,QAAQ,KAA2B,EAAE;QAC1D,QAAQ,KAAR,QAAQ,GAAK,uBAAA,IAAI,4CAAa,MAAjB,IAAI,EAAc,uBAAA,IAAI,0CAAW,EAAE,uBAAA,IAAI,kDAAmB,CAAC,EAAC;QAEzE,MAAM,OAAO,CAAC,UAAU,CACtB,QAAQ,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,IAAI,CAAC,uBAAuB,CAAC,EAAE,OAAO,EAAE,CAAC,CAAC,CACrE,CAAC;IACJ,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,uBAAuB,CAAC,EAAE,OAAO,EAAoB;QACzD,MAAM,EAAE,OAAO,EAAE,sBAAsB,EAAE,GAAG,IAAI,CAAC,eAAe,CAAC,IAAI,CACnE,uCAAuC,CACxC,CAAC;QAEF,MAAM,iBAAiB,GAAG,CAAC,cAAsB,EAAE,EAAE,CACnD,IAAA,uCAAoB,EAAC,cAAc,CAAC;YACpC,IAAA,uCAAoB,EAAC,sBAAsB,CAAC,CAAC;QAE/C,MAAM,iBAAiB,GAAiD,EAAE,CAAC;QAE3E,MAAM,SAAS,GAAG,CAAC,CAAC,cAAc,EAAE,MAAM,CAAoB,EAAE,EAAE,CAChE,uBAAA,IAAI,sDAAuB,IAAI,iBAAiB,CAAC,cAAc,CAAC;YAC9D,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE,CACnB,iBAAiB,CAAC,IAAI,CAAC;gBACrB,cAAc,EAAE,cAAqB;gBACrC,YAAY,EAAE,CAAC,CAAC,OAAc;aAC/B,CAAC,CACH;YACH,CAAC,CAAC,SAAS,CAAC;QAEhB,iEAAiE;QACjE,MAAM,CAAC,OAAO,CAAC,uBAAA,IAAI,0CAAW,CAAC,OAAO,CAAC,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;QAClE,MAAM,CAAC,OAAO,CAAC,uBAAA,IAAI,kDAAmB,CAAC,OAAO,CAAC,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;QAE1E,IAAI,OAAO,GAAsB,EAAE,CAAC;QAEpC,IAAI,iBAAiB,CAAC,MAAM,GAAG,CAAC,EAAE;YAChC,MAAM,QAAQ,GAAG,IAAI,wBAAY,CAC/B,uBAAA,IAAI,qFAAkB,MAAtB,IAAI,EAAmB,OAAO,CAAC,CAAC,QAAQ,CACzC,CAAC;YAEF,MAAM,KAAK,GAAG,iBAAiB,CAAC,GAAG,CACjC,CAAC,EAAE,cAAc,EAAE,YAAY,EAAE,EAAE,EAAE,CAAC,CAAC;gBACrC,QAAQ,EAAE,IAAI,oBAAQ,CAAC,YAAY,EAAE,4BAAQ,EAAE,QAAQ,CAAC;gBACxD,iBAAiB,EAAE,oBAAoB;gBACvC,SAAS,EAAE,CAAC,cAAc,CAAC;aAC5B,CAAC,CACH,CAAC;YAEF,OAAO,GAAG,MAAM,IAAA,+BAAmB,EAAC,KAAK,EAAE,OAAO,EAAE,QAAQ,CAAC,CAAC;SAC/D;QAED,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;;YACpB,qDAAqD;YACrD,qDAAqD;YACrD,KAAK,MAAM,cAAc,IAAI,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,aAAa,CAAC,EAAE;gBAC7D,KAAK,CAAC,aAAa,CAAC,cAAqB,CAAC,CAAC,OAAO,CAAC,GAAG,EAAE,CAAC;aAC1D;YAED,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE;gBACvC,MAAM,EAAE,OAAO,EAAE,KAAK,EAAE,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC;gBACtC,MAAM,EAAE,cAAc,EAAE,YAAY,EAAE,GAAG,iBAAiB,CAAC,CAAC,CAAC,CAAC;gBAE9D,IAAI,OAAO,EAAE;oBACX,OAAC,OAAC,KAAK,CAAC,aAAa,EAAC,cAAc,SAAd,cAAc,IAAM,EAAE,EAAC,EAAC,OAAO,SAAP,OAAO,IAAM,EAAE,EAAC,CAC5D,YAAY,CACb,GAAG,IAAA,wBAAK,EAAC,KAAW,CAAC,CAAC;iBACxB;aACF;QACH,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACH,UAAU;QACR,IAAI,CAAC,MAAM,CAAC,GAAG,EAAE;YACf,OAAO,4BAA4B,EAAE,CAAC;QACxC,CAAC,CAAC,CAAC;IACL,CAAC;CA6BF;AAjSD,0DAiSC;2kBAlKuB,CAAe,EAAE,OAAgB;IACrD,oCAAoC;IACpC,KAAK,MAAM,KAAK,IAAI,OAAO,EAAE;QAC3B,IACE,KAAK,CAAC,EAAE,KAAK,QAAQ;YACrB,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,gCAAgC,EAClD;YACA,MAAM,cAAc,GAAG,KAAK,CAAC,IAAI,CAAC,CAAC,CAAQ,CAAC;YAE5C,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;gBACpB,KAAK,MAAM,cAAc,IAAI,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,aAAa,CAAC,EAAE;oBAC7D,OAAO,KAAK,CAAC,aAAa,CAAC,cAAqB,CAAC,CAAC,cAAc,CAAC,CAAC;iBACnE;YACH,CAAC,CAAC,CAAC;SACJ;KACF;AACH,CAAC,iGA4HiB,OAAY;IAC5B,MAAM,EAAE,8BAA8B,EAAE,GAAG,IAAI,CAAC,eAAe,CAAC,IAAI,CAClE,4BAA4B,CAC7B,CAAC;IAEF,MAAM,oBAAoB,GAAG,8BAA8B,CAAC,OAAO,CAAC,CAAC;IACrE,IAAI,CAAC,oBAAoB,EAAE;QACzB,MAAM,IAAI,KAAK,CACb,uEAAuE,OAAO,EAAE,CACjF,CAAC;KACH;IAED,MAAM,EAAE,eAAe,EAAE,GACvB,oBAAoB,CAAC,YAAY,CAC/B,oBAAoB,CAAC,uBAAuB,CAC7C,CAAC;IAEJ,OAAO,IAAI,CAAC,eAAe,CAAC,IAAI,CAC9B,wCAAwC,EACxC,eAAe,CAChB,CAAC;AACJ,CAAC;AAGH,kBAAe,uBAAuB,CAAC","sourcesContent":["import { Contract } from '@ethersproject/contracts';\nimport { Web3Provider } from '@ethersproject/providers';\nimport type { AccountsControllerGetSelectedAccountAction } from '@metamask/accounts-controller';\nimport type {\n  RestrictedMessenger,\n  ControllerGetStateAction,\n  ControllerStateChangeEvent,\n} from '@metamask/base-controller';\nimport { toChecksumHexAddress, toHex } from '@metamask/controller-utils';\nimport { abiERC20 } from '@metamask/metamask-eth-abis';\nimport type {\n  NetworkControllerGetNetworkClientByIdAction,\n  NetworkControllerGetStateAction,\n  NetworkControllerStateChangeEvent,\n  NetworkState,\n} from '@metamask/network-controller';\nimport { StaticIntervalPollingController } from '@metamask/polling-controller';\nimport type {\n  PreferencesControllerGetStateAction,\n  PreferencesControllerStateChangeEvent,\n  PreferencesState,\n} from '@metamask/preferences-controller';\nimport type { Hex } from '@metamask/utils';\nimport type BN from 'bn.js';\nimport type { Patch } from 'immer';\nimport { isEqual } from 'lodash';\n\nimport type { MulticallResult } from './multicall';\nimport { multicallOrFallback } from './multicall';\nimport type { Token } from './TokenRatesController';\nimport type {\n  TokensControllerGetStateAction,\n  TokensControllerState,\n  TokensControllerStateChangeEvent,\n} from './TokensController';\n\nconst DEFAULT_INTERVAL = 180000;\n\nconst controllerName = 'TokenBalancesController';\n\nconst metadata = {\n  tokenBalances: { persist: true, anonymous: false },\n};\n\n/**\n * Token balances controller options\n * @property interval - Polling interval used to fetch new token balances.\n * @property messenger - A messenger.\n * @property state - Initial state for the controller.\n */\ntype TokenBalancesControllerOptions = {\n  interval?: number;\n  messenger: TokenBalancesControllerMessenger;\n  state?: Partial<TokenBalancesControllerState>;\n};\n\n/**\n * A mapping from account address to chain id to token address to balance.\n */\ntype TokenBalances = Record<Hex, Record<Hex, Record<Hex, Hex>>>;\n\n/**\n * Token balances controller state\n * @property tokenBalances - A mapping from account address to chain id to token address to balance.\n */\nexport type TokenBalancesControllerState = {\n  tokenBalances: TokenBalances;\n};\n\nexport type TokenBalancesControllerGetStateAction = ControllerGetStateAction<\n  typeof controllerName,\n  TokenBalancesControllerState\n>;\n\nexport type TokenBalancesControllerActions =\n  TokenBalancesControllerGetStateAction;\n\nexport type AllowedActions =\n  | NetworkControllerGetNetworkClientByIdAction\n  | NetworkControllerGetStateAction\n  | TokensControllerGetStateAction\n  | PreferencesControllerGetStateAction\n  | AccountsControllerGetSelectedAccountAction;\n\nexport type TokenBalancesControllerStateChangeEvent =\n  ControllerStateChangeEvent<\n    typeof controllerName,\n    TokenBalancesControllerState\n  >;\n\nexport type TokenBalancesControllerEvents =\n  TokenBalancesControllerStateChangeEvent;\n\nexport type AllowedEvents =\n  | TokensControllerStateChangeEvent\n  | PreferencesControllerStateChangeEvent\n  | NetworkControllerStateChangeEvent;\n\nexport type TokenBalancesControllerMessenger = RestrictedMessenger<\n  typeof controllerName,\n  TokenBalancesControllerActions | AllowedActions,\n  TokenBalancesControllerEvents | AllowedEvents,\n  AllowedActions['type'],\n  AllowedEvents['type']\n>;\n\n/**\n * Get the default TokenBalancesController state.\n *\n * @returns The default TokenBalancesController state.\n */\nexport function getDefaultTokenBalancesState(): TokenBalancesControllerState {\n  return {\n    tokenBalances: {},\n  };\n}\n\n/** The input to start polling for the {@link TokenBalancesController} */\nexport type TokenBalancesPollingInput = {\n  chainId: Hex;\n};\n\n/**\n * Controller that passively polls on a set interval token balances\n * for tokens stored in the TokensController\n */\nexport class TokenBalancesController extends StaticIntervalPollingController<TokenBalancesPollingInput>()<\n  typeof controllerName,\n  TokenBalancesControllerState,\n  TokenBalancesControllerMessenger\n> {\n  #queryMultipleAccounts: boolean;\n\n  #allTokens: TokensControllerState['allTokens'];\n\n  #allDetectedTokens: TokensControllerState['allDetectedTokens'];\n\n  /**\n   * Construct a Token Balances Controller.\n   *\n   * @param options - The controller options.\n   * @param options.interval - Polling interval used to fetch new token balances.\n   * @param options.state - Initial state to set on this controller.\n   * @param options.messenger - The controller restricted messenger.\n   */\n  constructor({\n    interval = DEFAULT_INTERVAL,\n    messenger,\n    state = {},\n  }: TokenBalancesControllerOptions) {\n    super({\n      name: controllerName,\n      metadata,\n      messenger,\n      state: {\n        ...getDefaultTokenBalancesState(),\n        ...state,\n      },\n    });\n\n    this.setIntervalLength(interval);\n\n    // Set initial preference for querying multiple accounts, and subscribe to changes\n    this.#queryMultipleAccounts = this.#calculateQueryMultipleAccounts(\n      this.messagingSystem.call('PreferencesController:getState'),\n    );\n    this.messagingSystem.subscribe(\n      'PreferencesController:stateChange',\n      this.#onPreferencesStateChange.bind(this),\n    );\n\n    // Set initial tokens, and subscribe to changes\n    ({\n      allTokens: this.#allTokens,\n      allDetectedTokens: this.#allDetectedTokens,\n    } = this.messagingSystem.call('TokensController:getState'));\n\n    this.messagingSystem.subscribe(\n      'TokensController:stateChange',\n      this.#onTokensStateChange.bind(this),\n    );\n\n    // Subscribe to network state changes\n    this.messagingSystem.subscribe(\n      'NetworkController:stateChange',\n      this.#onNetworkStateChange.bind(this),\n    );\n  }\n\n  /**\n   * Determines whether to query all accounts, or just the selected account.\n   * @param preferences - The preferences state.\n   * @param preferences.isMultiAccountBalancesEnabled - whether to query all accounts (mobile).\n   * @param preferences.useMultiAccountBalanceChecker - whether to query all accounts (extension).\n   * @returns true if all accounts should be queried.\n   */\n  #calculateQueryMultipleAccounts = ({\n    isMultiAccountBalancesEnabled,\n    useMultiAccountBalanceChecker,\n  }: PreferencesState & { useMultiAccountBalanceChecker?: boolean }) => {\n    return Boolean(\n      // Note: These settings have different names on extension vs mobile\n      isMultiAccountBalancesEnabled || useMultiAccountBalanceChecker,\n    );\n  };\n\n  /**\n   * Handles the event for preferences state changes.\n   * @param preferences - The preferences state.\n   */\n  #onPreferencesStateChange = (preferences: PreferencesState) => {\n    // Update the user preference for whether to query multiple accounts.\n    const queryMultipleAccounts =\n      this.#calculateQueryMultipleAccounts(preferences);\n\n    // Refresh when flipped off -> on\n    const refresh = queryMultipleAccounts && !this.#queryMultipleAccounts;\n    this.#queryMultipleAccounts = queryMultipleAccounts;\n\n    if (refresh) {\n      this.updateBalances().catch(console.error);\n    }\n  };\n\n  /**\n   * Handles the event for tokens state changes.\n   * @param state - The token state.\n   * @param state.allTokens - The state for imported tokens across all chains.\n   * @param state.allDetectedTokens - The state for detected tokens across all chains.\n   */\n  #onTokensStateChange = ({\n    allTokens,\n    allDetectedTokens,\n  }: TokensControllerState) => {\n    // Refresh token balances on chains whose tokens have changed.\n    const chainIds = this.#getChainIds(allTokens, allDetectedTokens);\n    const chainIdsToUpdate = chainIds.filter(\n      (chainId) =>\n        !isEqual(this.#allTokens[chainId], allTokens[chainId]) ||\n        !isEqual(this.#allDetectedTokens[chainId], allDetectedTokens[chainId]),\n    );\n\n    this.#allTokens = allTokens;\n    this.#allDetectedTokens = allDetectedTokens;\n\n    this.updateBalances({ chainIds: chainIdsToUpdate }).catch(console.error);\n  };\n\n  /**\n   * Handles the event for network state changes.\n   * @param _ - The network state.\n   * @param patches - An array of patch operations performed on the network state.\n   */\n  #onNetworkStateChange(_: NetworkState, patches: Patch[]) {\n    // Remove state for deleted networks\n    for (const patch of patches) {\n      if (\n        patch.op === 'remove' &&\n        patch.path[0] === 'networkConfigurationsByChainId'\n      ) {\n        const removedChainId = patch.path[1] as Hex;\n\n        this.update((state) => {\n          for (const accountAddress of Object.keys(state.tokenBalances)) {\n            delete state.tokenBalances[accountAddress as Hex][removedChainId];\n          }\n        });\n      }\n    }\n  }\n\n  /**\n   * Returns an array of chain ids that have tokens.\n   * @param allTokens - The state for imported tokens across all chains.\n   * @param allDetectedTokens - The state for detected tokens across all chains.\n   * @returns An array of chain ids that have tokens.\n   */\n  #getChainIds = (\n    allTokens: TokensControllerState['allTokens'],\n    allDetectedTokens: TokensControllerState['allDetectedTokens'],\n  ) =>\n    [\n      ...new Set([\n        ...Object.keys(allTokens),\n        ...Object.keys(allDetectedTokens),\n      ]),\n    ] as Hex[];\n\n  /**\n   * Polls for erc20 token balances.\n   * @param input - The input for the poll.\n   * @param input.chainId - The chain id to poll token balances on.\n   */\n  async _executePoll({ chainId }: TokenBalancesPollingInput) {\n    await this.updateBalancesByChainId({ chainId });\n  }\n\n  /**\n   * Updates the token balances for the given chain ids.\n   * @param input - The input for the update.\n   * @param input.chainIds - The chain ids to update token balances for.\n   * Or omitted to update all chains that contain tokens.\n   */\n  async updateBalances({ chainIds }: { chainIds?: Hex[] } = {}) {\n    chainIds ??= this.#getChainIds(this.#allTokens, this.#allDetectedTokens);\n\n    await Promise.allSettled(\n      chainIds.map((chainId) => this.updateBalancesByChainId({ chainId })),\n    );\n  }\n\n  /**\n   * Updates token balances for the given chain id.\n   * @param input - The input for the update.\n   * @param input.chainId - The chain id to update token balances on.\n   */\n  async updateBalancesByChainId({ chainId }: { chainId: Hex }) {\n    const { address: selectedAccountAddress } = this.messagingSystem.call(\n      'AccountsController:getSelectedAccount',\n    );\n\n    const isSelectedAccount = (accountAddress: string) =>\n      toChecksumHexAddress(accountAddress) ===\n      toChecksumHexAddress(selectedAccountAddress);\n\n    const accountTokenPairs: { accountAddress: Hex; tokenAddress: Hex }[] = [];\n\n    const addTokens = ([accountAddress, tokens]: [string, Token[]]) =>\n      this.#queryMultipleAccounts || isSelectedAccount(accountAddress)\n        ? tokens.forEach((t) =>\n            accountTokenPairs.push({\n              accountAddress: accountAddress as Hex,\n              tokenAddress: t.address as Hex,\n            }),\n          )\n        : undefined;\n\n    // Balances will be updated for both imported and detected tokens\n    Object.entries(this.#allTokens[chainId] ?? {}).forEach(addTokens);\n    Object.entries(this.#allDetectedTokens[chainId] ?? {}).forEach(addTokens);\n\n    let results: MulticallResult[] = [];\n\n    if (accountTokenPairs.length > 0) {\n      const provider = new Web3Provider(\n        this.#getNetworkClient(chainId).provider,\n      );\n\n      const calls = accountTokenPairs.map(\n        ({ accountAddress, tokenAddress }) => ({\n          contract: new Contract(tokenAddress, abiERC20, provider),\n          functionSignature: 'balanceOf(address)',\n          arguments: [accountAddress],\n        }),\n      );\n\n      results = await multicallOrFallback(calls, chainId, provider);\n    }\n\n    this.update((state) => {\n      // Reset so that when accounts or tokens are removed,\n      // their balances are removed rather than left stale.\n      for (const accountAddress of Object.keys(state.tokenBalances)) {\n        state.tokenBalances[accountAddress as Hex][chainId] = {};\n      }\n\n      for (let i = 0; i < results.length; i++) {\n        const { success, value } = results[i];\n        const { accountAddress, tokenAddress } = accountTokenPairs[i];\n\n        if (success) {\n          ((state.tokenBalances[accountAddress] ??= {})[chainId] ??= {})[\n            tokenAddress\n          ] = toHex(value as BN);\n        }\n      }\n    });\n  }\n\n  /**\n   * Reset the controller state to the default state.\n   */\n  resetState() {\n    this.update(() => {\n      return getDefaultTokenBalancesState();\n    });\n  }\n\n  /**\n   * Returns the network client for a given chain id\n   * @param chainId - The chain id to get the network client for.\n   * @returns The network client for the given chain id.\n   */\n  #getNetworkClient(chainId: Hex) {\n    const { networkConfigurationsByChainId } = this.messagingSystem.call(\n      'NetworkController:getState',\n    );\n\n    const networkConfiguration = networkConfigurationsByChainId[chainId];\n    if (!networkConfiguration) {\n      throw new Error(\n        `TokenBalancesController: No network configuration found for chainId ${chainId}`,\n      );\n    }\n\n    const { networkClientId } =\n      networkConfiguration.rpcEndpoints[\n        networkConfiguration.defaultRpcEndpointIndex\n      ];\n\n    return this.messagingSystem.call(\n      `NetworkController:getNetworkClientById`,\n      networkClientId,\n    );\n  }\n}\n\nexport default TokenBalancesController;\n"]}
+{"version":3,"file":"TokenBalancesController.cjs","sourceRoot":"","sources":["../src/TokenBalancesController.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAAA,wDAAoD;AACpD,wDAAwD;AAUxD,iEAAyE;AACzE,mEAAuD;AAOvD,qEAA+E;AAS/E,mCAAiC;AAGjC,+CAAkD;AAQlD,MAAM,gBAAgB,GAAG,MAAM,CAAC;AAEhC,MAAM,cAAc,GAAG,yBAAyB,CAAC;AAEjD,MAAM,QAAQ,GAAG;IACf,aAAa,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,KAAK,EAAE;CACnD,CAAC;AAiEF;;;;GAIG;AACH,SAAgB,4BAA4B;IAC1C,OAAO;QACL,aAAa,EAAE,EAAE;KAClB,CAAC;AACJ,CAAC;AAJD,oEAIC;AAOD;;;GAGG;AACH,MAAa,uBAAwB,SAAQ,IAAA,oDAA+B,GAI3E;IAOC;;;;;;;OAOG;IACH,YAAY,EACV,QAAQ,GAAG,gBAAgB,EAC3B,SAAS,EACT,KAAK,GAAG,EAAE,GACqB;;QAC/B,KAAK,CAAC;YACJ,IAAI,EAAE,cAAc;YACpB,QAAQ;YACR,SAAS;YACT,KAAK,EAAE;gBACL,GAAG,4BAA4B,EAAE;gBACjC,GAAG,KAAK;aACT;SACF,CAAC,CAAC;;QA3BL,iEAAgC;QAEhC,qDAA+C;QAE/C,6DAA+D;QA8D/D;;;;;;WAMG;QACH,kEAAkC,CAAC,EACjC,6BAA6B,EAC7B,6BAA6B,GACkC,EAAE,EAAE;YACnE,OAAO,OAAO;YACZ,mEAAmE;YACnE,6BAA6B,IAAI,6BAA6B,CAC/D,CAAC;QACJ,CAAC,EAAC;QAEF;;;WAGG;QACH,4DAA4B,CAAC,WAA6B,EAAE,EAAE;YAC5D,qEAAqE;YACrE,MAAM,qBAAqB,GACzB,uBAAA,IAAI,+DAAgC,MAApC,IAAI,EAAiC,WAAW,CAAC,CAAC;YAEpD,iCAAiC;YACjC,MAAM,OAAO,GAAG,qBAAqB,IAAI,CAAC,uBAAA,IAAI,sDAAuB,CAAC;YACtE,uBAAA,IAAI,kDAA0B,qBAAqB,MAAA,CAAC;YAEpD,IAAI,OAAO,EAAE;gBACX,IAAI,CAAC,cAAc,EAAE,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;aAC5C;QACH,CAAC,EAAC;QAEF;;;;;WAKG;QACH,uDAAuB,CAAC,EACtB,SAAS,EACT,iBAAiB,GACK,EAAE,EAAE;YAC1B,8DAA8D;YAC9D,MAAM,QAAQ,GAAG,uBAAA,IAAI,4CAAa,MAAjB,IAAI,EAAc,SAAS,EAAE,iBAAiB,CAAC,CAAC;YACjE,MAAM,gBAAgB,GAAG,QAAQ,CAAC,MAAM,CACtC,CAAC,OAAO,EAAE,EAAE,CACV,CAAC,IAAA,gBAAO,EAAC,uBAAA,IAAI,0CAAW,CAAC,OAAO,CAAC,EAAE,SAAS,CAAC,OAAO,CAAC,CAAC;gBACtD,CAAC,IAAA,gBAAO,EAAC,uBAAA,IAAI,kDAAmB,CAAC,OAAO,CAAC,EAAE,iBAAiB,CAAC,OAAO,CAAC,CAAC,CACzE,CAAC;YAEF,uBAAA,IAAI,sCAAc,SAAS,MAAA,CAAC;YAC5B,uBAAA,IAAI,8CAAsB,iBAAiB,MAAA,CAAC;YAC5C,IAAI,CAAC,cAAc,CAAC,EAAE,QAAQ,EAAE,gBAAgB,EAAE,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;QAC3E,CAAC,EAAC;QAoCF;;;;;WAKG;QACH,+CAAe,CACb,SAA6C,EAC7C,iBAA6D,EAC7D,EAAE,CACF;YACE,GAAG,IAAI,GAAG,CAAC;gBACT,GAAG,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC;gBACzB,GAAG,MAAM,CAAC,IAAI,CAAC,iBAAiB,CAAC;aAClC,CAAC;SACM,EAAC;QAhJX,IAAI,CAAC,iBAAiB,CAAC,QAAQ,CAAC,CAAC;QAEjC,kFAAkF;QAClF,uBAAA,IAAI,kDAA0B,uBAAA,IAAI,+DAAgC,MAApC,IAAI,EAChC,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,gCAAgC,CAAC,CAC5D,MAAA,CAAC;QACF,IAAI,CAAC,eAAe,CAAC,SAAS,CAC5B,mCAAmC,EACnC,uBAAA,IAAI,yDAA0B,CAAC,IAAI,CAAC,IAAI,CAAC,CAC1C,CAAC;QAEF,+CAA+C;QAC/C,MACa,IAAI,OACI,IAAI,EAFxB;YACC,SAAS,wGAAiB;YAC1B,iBAAiB,gHAAyB;SAC3C,GAAG,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,2BAA2B,CAAC,CAAC,CAAC;QAE5D,IAAI,CAAC,eAAe,CAAC,SAAS,CAC5B,8BAA8B,EAC9B,uBAAA,IAAI,oDAAqB,CAAC,IAAI,CAAC,IAAI,CAAC,CACrC,CAAC;QAEF,qCAAqC;QACrC,IAAI,CAAC,eAAe,CAAC,SAAS,CAC5B,+BAA+B,EAC/B,uBAAA,IAAI,yFAAsB,CAAC,IAAI,CAAC,IAAI,CAAC,CACtC,CAAC;QAEF,+DAA+D;QAE/D,IAAI,CAAC,eAAe,CAAC,SAAS,CAC5B,mCAAmC,EACnC,CAAC,cAAsB,EAAE,EAAE,CACzB,uBAAA,IAAI,2FAAwB,MAA5B,IAAI,EAAyB,cAAqB,CAAC,CACtD,CAAC;IACJ,CAAC;IA+GD;;;;OAIG;IACH,KAAK,CAAC,YAAY,CAAC,EAAE,OAAO,EAA6B;QACvD,MAAM,IAAI,CAAC,uBAAuB,CAAC,EAAE,OAAO,EAAE,CAAC,CAAC;IAClD,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,cAAc,CAAC,EAAE,QAAQ,KAA2B,EAAE;QAC1D,QAAQ,KAAR,QAAQ,GAAK,uBAAA,IAAI,4CAAa,MAAjB,IAAI,EAAc,uBAAA,IAAI,0CAAW,EAAE,uBAAA,IAAI,kDAAmB,CAAC,EAAC;QAEzE,MAAM,OAAO,CAAC,UAAU,CACtB,QAAQ,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,IAAI,CAAC,uBAAuB,CAAC,EAAE,OAAO,EAAE,CAAC,CAAC,CACrE,CAAC;IACJ,CAAC;IAmCD;;;;OAIG;IACH,KAAK,CAAC,uBAAuB,CAAC,EAAE,OAAO,EAAoB;QACzD,MAAM,EAAE,OAAO,EAAE,sBAAsB,EAAE,GAAG,IAAI,CAAC,eAAe,CAAC,IAAI,CACnE,uCAAuC,CACxC,CAAC;QAEF,MAAM,iBAAiB,GAAG,CAAC,cAAsB,EAAE,EAAE,CACnD,IAAA,uCAAoB,EAAC,cAAc,CAAC;YACpC,IAAA,uCAAoB,EAAC,sBAAsB,CAAC,CAAC;QAE/C,MAAM,iBAAiB,GAAiD,EAAE,CAAC;QAE3E,MAAM,SAAS,GAAG,CAAC,CAAC,cAAc,EAAE,MAAM,CAAoB,EAAE,EAAE,CAChE,uBAAA,IAAI,sDAAuB,IAAI,iBAAiB,CAAC,cAAc,CAAC;YAC9D,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE,CACnB,iBAAiB,CAAC,IAAI,CAAC;gBACrB,cAAc,EAAE,cAAqB;gBACrC,YAAY,EAAE,CAAC,CAAC,OAAc;aAC/B,CAAC,CACH;YACH,CAAC,CAAC,SAAS,CAAC;QAEhB,iEAAiE;QACjE,MAAM,CAAC,OAAO,CAAC,uBAAA,IAAI,0CAAW,CAAC,OAAO,CAAC,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;QAClE,MAAM,CAAC,OAAO,CAAC,uBAAA,IAAI,kDAAmB,CAAC,OAAO,CAAC,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;QAE1E,IAAI,OAAO,GAAsB,EAAE,CAAC;QAEpC,yHAAyH;QACzH,uBAAA,IAAI,gGAA6B,MAAjC,IAAI,EAA8B,iBAAiB,EAAE,OAAO,CAAC,CAAC;QAC9D,MAAM,oBAAoB,GAAG,IAAI,CAAC,eAAe,CAAC,IAAI,CACpD,kCAAkC,CACnC,CAAC;QAEF,IAAI,iBAAiB,CAAC,MAAM,GAAG,CAAC,EAAE;YAChC,MAAM,QAAQ,GAAG,IAAI,wBAAY,CAC/B,uBAAA,IAAI,qFAAkB,MAAtB,IAAI,EAAmB,OAAO,CAAC,CAAC,QAAQ,CACzC,CAAC;YAEF,MAAM,KAAK,GAAG,iBAAiB,CAAC,GAAG,CACjC,CAAC,EAAE,cAAc,EAAE,YAAY,EAAE,EAAE,EAAE,CAAC,CAAC;gBACrC,QAAQ,EAAE,IAAI,oBAAQ,CAAC,YAAY,EAAE,4BAAQ,EAAE,QAAQ,CAAC;gBACxD,iBAAiB,EAAE,oBAAoB;gBACvC,SAAS,EAAE,CAAC,cAAc,CAAC;aAC5B,CAAC,CACH,CAAC;YAEF,OAAO,GAAG,MAAM,IAAA,+BAAmB,EAAC,KAAK,EAAE,OAAO,EAAE,QAAQ,CAAC,CAAC;SAC/D;QAED,MAAM,cAAc,GAEb,CAAC,GAAG,OAAO,CAAC,CAAC;QAEpB,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE;YACvC,MAAM,EAAE,KAAK,EAAE,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC;YAC7B,MAAM,EAAE,cAAc,EAAE,YAAY,EAAE,GAAG,iBAAiB,CAAC,CAAC,CAAC,CAAC;YAC9D,MAAM,kCAAkC,GACtC,oBAAoB,CAAC,aAAa,EAAE,CAAC,cAAc,CAAC,EAAE,CAAC,OAAO,CAAC,EAAE,CAC/D,YAAY,CACb,CAAC;YACJ,MAAM,0BAA0B,GAC9B,kCAAkC,KAAK,IAAA,wBAAK,EAAC,KAAW,CAAC,CAAC;YAC5D,cAAc,CAAC,CAAC,CAAC,GAAG;gBAClB,GAAG,OAAO,CAAC,CAAC,CAAC;gBACb,0BAA0B;aAC3B,CAAC;SACH;QAED,gEAAgE;QAChE,IAAI,cAAc,CAAC,KAAK,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,MAAM,CAAC,0BAA0B,CAAC,EAAE;YACxE,OAAO;SACR;QAED,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;;YACpB,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,cAAc,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE;gBAC9C,MAAM,EAAE,OAAO,EAAE,KAAK,EAAE,0BAA0B,EAAE,GAClD,cAAc,CAAC,CAAC,CAAC,CAAC;gBACpB,MAAM,EAAE,cAAc,EAAE,YAAY,EAAE,GAAG,iBAAiB,CAAC,CAAC,CAAC,CAAC;gBAC9D,IAAI,OAAO,IAAI,0BAA0B,EAAE;oBACzC,OAAC,OAAC,KAAK,CAAC,aAAa,EAAC,cAAc,SAAd,cAAc,IAAM,EAAE,EAAC,EAAC,OAAO,SAAP,OAAO,IAAM,EAAE,EAAC,CAC5D,YAAY,CACb,GAAG,IAAA,wBAAK,EAAC,KAAW,CAAC,CAAC;iBACxB;aACF;QACH,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACH,UAAU;QACR,IAAI,CAAC,MAAM,CAAC,GAAG,EAAE;YACf,OAAO,4BAA4B,EAAE,CAAC;QACxC,CAAC,CAAC,CAAC;IACL,CAAC;CA6BF;AA5WD,0DA4WC;2kBAtOuB,CAAe,EAAE,OAAgB;IACrD,oCAAoC;IACpC,KAAK,MAAM,KAAK,IAAI,OAAO,EAAE;QAC3B,IACE,KAAK,CAAC,EAAE,KAAK,QAAQ;YACrB,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,gCAAgC,EAClD;YACA,MAAM,cAAc,GAAG,KAAK,CAAC,IAAI,CAAC,CAAC,CAAQ,CAAC;YAE5C,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;gBACpB,KAAK,MAAM,cAAc,IAAI,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,aAAa,CAAC,EAAE;oBAC7D,OAAO,KAAK,CAAC,aAAa,CAAC,cAAqB,CAAC,CAAC,cAAc,CAAC,CAAC;iBACnE;YACH,CAAC,CAAC,CAAC;SACJ;KACF;AACH,CAAC,6GAOuB,cAAmB;IACzC,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;QACpB,OAAO,KAAK,CAAC,aAAa,CAAC,cAAc,CAAC,CAAC;IAC7C,CAAC,CAAC,CAAC;AACL,CAAC,uHA2CC,iBAA+D,EAC/D,OAAY;IAEZ,kCAAkC;IAClC,MAAM,oBAAoB,GAAG,IAAI,CAAC,eAAe,CAAC,IAAI,CACpD,kCAAkC,CACnC,CAAC;IAEF,yHAAyH;IACzH,oKAAoK;IACpK,8CAA8C;IAC9C,KAAK,MAAM,cAAc,IAAI,MAAM,CAAC,IAAI,CACtC,oBAAoB,CAAC,aAAa,CACnC,EAAE;QACD,KAAK,MAAM,YAAY,IAAI,MAAM,CAAC,IAAI,CACpC,oBAAoB,CAAC,aAAa,CAAC,cAA+B,CAAC,CACjE,OAAO,CACR,CACF,EAAE;YACD,IACE,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,YAAY,KAAK,YAAY,CAAC,EACrE;gBACA,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;oBACpB,OAAO,KAAK,CAAC,aAAa,CAAC,cAAqB,CAAC,CAAC,OAAc,CAAC,CAC/D,YAA6B,CAC9B,CAAC;gBACJ,CAAC,CAAC,CAAC;aACJ;SACF;KACF;AACH,CAAC,iGA4GiB,OAAY;IAC5B,MAAM,EAAE,8BAA8B,EAAE,GAAG,IAAI,CAAC,eAAe,CAAC,IAAI,CAClE,4BAA4B,CAC7B,CAAC;IAEF,MAAM,oBAAoB,GAAG,8BAA8B,CAAC,OAAO,CAAC,CAAC;IACrE,IAAI,CAAC,oBAAoB,EAAE;QACzB,MAAM,IAAI,KAAK,CACb,uEAAuE,OAAO,EAAE,CACjF,CAAC;KACH;IAED,MAAM,EAAE,eAAe,EAAE,GACvB,oBAAoB,CAAC,YAAY,CAC/B,oBAAoB,CAAC,uBAAuB,CAC7C,CAAC;IAEJ,OAAO,IAAI,CAAC,eAAe,CAAC,IAAI,CAC9B,wCAAwC,EACxC,eAAe,CAChB,CAAC;AACJ,CAAC;AAGH,kBAAe,uBAAuB,CAAC","sourcesContent":["import { Contract } from '@ethersproject/contracts';\nimport { Web3Provider } from '@ethersproject/providers';\nimport type {\n  AccountsControllerAccountRemovedEvent,\n  AccountsControllerGetSelectedAccountAction,\n} from '@metamask/accounts-controller';\nimport type {\n  RestrictedMessenger,\n  ControllerGetStateAction,\n  ControllerStateChangeEvent,\n} from '@metamask/base-controller';\nimport { toChecksumHexAddress, toHex } from '@metamask/controller-utils';\nimport { abiERC20 } from '@metamask/metamask-eth-abis';\nimport type {\n  NetworkControllerGetNetworkClientByIdAction,\n  NetworkControllerGetStateAction,\n  NetworkControllerStateChangeEvent,\n  NetworkState,\n} from '@metamask/network-controller';\nimport { StaticIntervalPollingController } from '@metamask/polling-controller';\nimport type {\n  PreferencesControllerGetStateAction,\n  PreferencesControllerStateChangeEvent,\n  PreferencesState,\n} from '@metamask/preferences-controller';\nimport type { Hex } from '@metamask/utils';\nimport type BN from 'bn.js';\nimport type { Patch } from 'immer';\nimport { isEqual } from 'lodash';\n\nimport type { MulticallResult } from './multicall';\nimport { multicallOrFallback } from './multicall';\nimport type { Token } from './TokenRatesController';\nimport type {\n  TokensControllerGetStateAction,\n  TokensControllerState,\n  TokensControllerStateChangeEvent,\n} from './TokensController';\n\nconst DEFAULT_INTERVAL = 180000;\n\nconst controllerName = 'TokenBalancesController';\n\nconst metadata = {\n  tokenBalances: { persist: true, anonymous: false },\n};\n\n/**\n * Token balances controller options\n * @property interval - Polling interval used to fetch new token balances.\n * @property messenger - A messenger.\n * @property state - Initial state for the controller.\n */\ntype TokenBalancesControllerOptions = {\n  interval?: number;\n  messenger: TokenBalancesControllerMessenger;\n  state?: Partial<TokenBalancesControllerState>;\n};\n\n/**\n * A mapping from account address to chain id to token address to balance.\n */\ntype TokenBalances = Record<Hex, Record<Hex, Record<Hex, Hex>>>;\n\n/**\n * Token balances controller state\n * @property tokenBalances - A mapping from account address to chain id to token address to balance.\n */\nexport type TokenBalancesControllerState = {\n  tokenBalances: TokenBalances;\n};\n\nexport type TokenBalancesControllerGetStateAction = ControllerGetStateAction<\n  typeof controllerName,\n  TokenBalancesControllerState\n>;\n\nexport type TokenBalancesControllerActions =\n  TokenBalancesControllerGetStateAction;\n\nexport type AllowedActions =\n  | NetworkControllerGetNetworkClientByIdAction\n  | NetworkControllerGetStateAction\n  | TokensControllerGetStateAction\n  | PreferencesControllerGetStateAction\n  | AccountsControllerGetSelectedAccountAction;\n\nexport type TokenBalancesControllerStateChangeEvent =\n  ControllerStateChangeEvent<\n    typeof controllerName,\n    TokenBalancesControllerState\n  >;\n\nexport type TokenBalancesControllerEvents =\n  TokenBalancesControllerStateChangeEvent;\n\nexport type AllowedEvents =\n  | TokensControllerStateChangeEvent\n  | PreferencesControllerStateChangeEvent\n  | NetworkControllerStateChangeEvent\n  | AccountsControllerAccountRemovedEvent;\n\nexport type TokenBalancesControllerMessenger = RestrictedMessenger<\n  typeof controllerName,\n  TokenBalancesControllerActions | AllowedActions,\n  TokenBalancesControllerEvents | AllowedEvents,\n  AllowedActions['type'],\n  AllowedEvents['type']\n>;\n\n/**\n * Get the default TokenBalancesController state.\n *\n * @returns The default TokenBalancesController state.\n */\nexport function getDefaultTokenBalancesState(): TokenBalancesControllerState {\n  return {\n    tokenBalances: {},\n  };\n}\n\n/** The input to start polling for the {@link TokenBalancesController} */\nexport type TokenBalancesPollingInput = {\n  chainId: Hex;\n};\n\n/**\n * Controller that passively polls on a set interval token balances\n * for tokens stored in the TokensController\n */\nexport class TokenBalancesController extends StaticIntervalPollingController<TokenBalancesPollingInput>()<\n  typeof controllerName,\n  TokenBalancesControllerState,\n  TokenBalancesControllerMessenger\n> {\n  #queryMultipleAccounts: boolean;\n\n  #allTokens: TokensControllerState['allTokens'];\n\n  #allDetectedTokens: TokensControllerState['allDetectedTokens'];\n\n  /**\n   * Construct a Token Balances Controller.\n   *\n   * @param options - The controller options.\n   * @param options.interval - Polling interval used to fetch new token balances.\n   * @param options.state - Initial state to set on this controller.\n   * @param options.messenger - The controller restricted messenger.\n   */\n  constructor({\n    interval = DEFAULT_INTERVAL,\n    messenger,\n    state = {},\n  }: TokenBalancesControllerOptions) {\n    super({\n      name: controllerName,\n      metadata,\n      messenger,\n      state: {\n        ...getDefaultTokenBalancesState(),\n        ...state,\n      },\n    });\n\n    this.setIntervalLength(interval);\n\n    // Set initial preference for querying multiple accounts, and subscribe to changes\n    this.#queryMultipleAccounts = this.#calculateQueryMultipleAccounts(\n      this.messagingSystem.call('PreferencesController:getState'),\n    );\n    this.messagingSystem.subscribe(\n      'PreferencesController:stateChange',\n      this.#onPreferencesStateChange.bind(this),\n    );\n\n    // Set initial tokens, and subscribe to changes\n    ({\n      allTokens: this.#allTokens,\n      allDetectedTokens: this.#allDetectedTokens,\n    } = this.messagingSystem.call('TokensController:getState'));\n\n    this.messagingSystem.subscribe(\n      'TokensController:stateChange',\n      this.#onTokensStateChange.bind(this),\n    );\n\n    // Subscribe to network state changes\n    this.messagingSystem.subscribe(\n      'NetworkController:stateChange',\n      this.#onNetworkStateChange.bind(this),\n    );\n\n    // subscribe to account removed event to cleanup stale balances\n\n    this.messagingSystem.subscribe(\n      'AccountsController:accountRemoved',\n      (accountAddress: string) =>\n        this.#handleOnAccountRemoved(accountAddress as Hex),\n    );\n  }\n\n  /**\n   * Determines whether to query all accounts, or just the selected account.\n   * @param preferences - The preferences state.\n   * @param preferences.isMultiAccountBalancesEnabled - whether to query all accounts (mobile).\n   * @param preferences.useMultiAccountBalanceChecker - whether to query all accounts (extension).\n   * @returns true if all accounts should be queried.\n   */\n  #calculateQueryMultipleAccounts = ({\n    isMultiAccountBalancesEnabled,\n    useMultiAccountBalanceChecker,\n  }: PreferencesState & { useMultiAccountBalanceChecker?: boolean }) => {\n    return Boolean(\n      // Note: These settings have different names on extension vs mobile\n      isMultiAccountBalancesEnabled || useMultiAccountBalanceChecker,\n    );\n  };\n\n  /**\n   * Handles the event for preferences state changes.\n   * @param preferences - The preferences state.\n   */\n  #onPreferencesStateChange = (preferences: PreferencesState) => {\n    // Update the user preference for whether to query multiple accounts.\n    const queryMultipleAccounts =\n      this.#calculateQueryMultipleAccounts(preferences);\n\n    // Refresh when flipped off -> on\n    const refresh = queryMultipleAccounts && !this.#queryMultipleAccounts;\n    this.#queryMultipleAccounts = queryMultipleAccounts;\n\n    if (refresh) {\n      this.updateBalances().catch(console.error);\n    }\n  };\n\n  /**\n   * Handles the event for tokens state changes.\n   * @param state - The token state.\n   * @param state.allTokens - The state for imported tokens across all chains.\n   * @param state.allDetectedTokens - The state for detected tokens across all chains.\n   */\n  #onTokensStateChange = ({\n    allTokens,\n    allDetectedTokens,\n  }: TokensControllerState) => {\n    // Refresh token balances on chains whose tokens have changed.\n    const chainIds = this.#getChainIds(allTokens, allDetectedTokens);\n    const chainIdsToUpdate = chainIds.filter(\n      (chainId) =>\n        !isEqual(this.#allTokens[chainId], allTokens[chainId]) ||\n        !isEqual(this.#allDetectedTokens[chainId], allDetectedTokens[chainId]),\n    );\n\n    this.#allTokens = allTokens;\n    this.#allDetectedTokens = allDetectedTokens;\n    this.updateBalances({ chainIds: chainIdsToUpdate }).catch(console.error);\n  };\n\n  /**\n   * Handles the event for network state changes.\n   * @param _ - The network state.\n   * @param patches - An array of patch operations performed on the network state.\n   */\n  #onNetworkStateChange(_: NetworkState, patches: Patch[]) {\n    // Remove state for deleted networks\n    for (const patch of patches) {\n      if (\n        patch.op === 'remove' &&\n        patch.path[0] === 'networkConfigurationsByChainId'\n      ) {\n        const removedChainId = patch.path[1] as Hex;\n\n        this.update((state) => {\n          for (const accountAddress of Object.keys(state.tokenBalances)) {\n            delete state.tokenBalances[accountAddress as Hex][removedChainId];\n          }\n        });\n      }\n    }\n  }\n\n  /**\n   * Handles changes when an account has been removed.\n   *\n   * @param accountAddress - The account address being removed.\n   */\n  #handleOnAccountRemoved(accountAddress: Hex) {\n    this.update((state) => {\n      delete state.tokenBalances[accountAddress];\n    });\n  }\n\n  /**\n   * Returns an array of chain ids that have tokens.\n   * @param allTokens - The state for imported tokens across all chains.\n   * @param allDetectedTokens - The state for detected tokens across all chains.\n   * @returns An array of chain ids that have tokens.\n   */\n  #getChainIds = (\n    allTokens: TokensControllerState['allTokens'],\n    allDetectedTokens: TokensControllerState['allDetectedTokens'],\n  ) =>\n    [\n      ...new Set([\n        ...Object.keys(allTokens),\n        ...Object.keys(allDetectedTokens),\n      ]),\n    ] as Hex[];\n\n  /**\n   * Polls for erc20 token balances.\n   * @param input - The input for the poll.\n   * @param input.chainId - The chain id to poll token balances on.\n   */\n  async _executePoll({ chainId }: TokenBalancesPollingInput) {\n    await this.updateBalancesByChainId({ chainId });\n  }\n\n  /**\n   * Updates the token balances for the given chain ids.\n   * @param input - The input for the update.\n   * @param input.chainIds - The chain ids to update token balances for.\n   * Or omitted to update all chains that contain tokens.\n   */\n  async updateBalances({ chainIds }: { chainIds?: Hex[] } = {}) {\n    chainIds ??= this.#getChainIds(this.#allTokens, this.#allDetectedTokens);\n\n    await Promise.allSettled(\n      chainIds.map((chainId) => this.updateBalancesByChainId({ chainId })),\n    );\n  }\n\n  #cleanupCurrentTokenBalances(\n    accountTokenPairs: { accountAddress: Hex; tokenAddress: Hex }[],\n    chainId: Hex,\n  ) {\n    // TODO move this to a private fct\n    const currentTokenBalances = this.messagingSystem.call(\n      'TokenBalancesController:getState',\n    );\n\n    // in case currentTokenBalances has a token that is not in accountTokenPairs, we will remove it from currentTokenBalances\n    // loop through currentTokenBalances.tokenBalances, for each account loop though the account[chainId] array of tokens and check if the token is in accountTokenPairs\n    // if not, remove it from currentTokenBalances\n    for (const accountAddress of Object.keys(\n      currentTokenBalances.tokenBalances,\n    )) {\n      for (const tokenAddress of Object.keys(\n        currentTokenBalances.tokenBalances[accountAddress as `0x${string}`][\n          chainId\n        ],\n      )) {\n        if (\n          !accountTokenPairs.some((pair) => pair.tokenAddress === tokenAddress)\n        ) {\n          this.update((state) => {\n            delete state.tokenBalances[accountAddress as Hex][chainId as Hex][\n              tokenAddress as `0x${string}`\n            ];\n          });\n        }\n      }\n    }\n  }\n\n  /**\n   * Updates token balances for the given chain id.\n   * @param input - The input for the update.\n   * @param input.chainId - The chain id to update token balances on.\n   */\n  async updateBalancesByChainId({ chainId }: { chainId: Hex }) {\n    const { address: selectedAccountAddress } = this.messagingSystem.call(\n      'AccountsController:getSelectedAccount',\n    );\n\n    const isSelectedAccount = (accountAddress: string) =>\n      toChecksumHexAddress(accountAddress) ===\n      toChecksumHexAddress(selectedAccountAddress);\n\n    const accountTokenPairs: { accountAddress: Hex; tokenAddress: Hex }[] = [];\n\n    const addTokens = ([accountAddress, tokens]: [string, Token[]]) =>\n      this.#queryMultipleAccounts || isSelectedAccount(accountAddress)\n        ? tokens.forEach((t) =>\n            accountTokenPairs.push({\n              accountAddress: accountAddress as Hex,\n              tokenAddress: t.address as Hex,\n            }),\n          )\n        : undefined;\n\n    // Balances will be updated for both imported and detected tokens\n    Object.entries(this.#allTokens[chainId] ?? {}).forEach(addTokens);\n    Object.entries(this.#allDetectedTokens[chainId] ?? {}).forEach(addTokens);\n\n    let results: MulticallResult[] = [];\n\n    // in case currentTokenBalances has a token that is not in accountTokenPairs, we will remove it from currentTokenBalances\n    this.#cleanupCurrentTokenBalances(accountTokenPairs, chainId);\n    const currentTokenBalances = this.messagingSystem.call(\n      'TokenBalancesController:getState',\n    );\n\n    if (accountTokenPairs.length > 0) {\n      const provider = new Web3Provider(\n        this.#getNetworkClient(chainId).provider,\n      );\n\n      const calls = accountTokenPairs.map(\n        ({ accountAddress, tokenAddress }) => ({\n          contract: new Contract(tokenAddress, abiERC20, provider),\n          functionSignature: 'balanceOf(address)',\n          arguments: [accountAddress],\n        }),\n      );\n\n      results = await multicallOrFallback(calls, chainId, provider);\n    }\n\n    const updatedResults: (MulticallResult & {\n      isTokenBalanceValueChanged?: boolean;\n    })[] = [...results];\n\n    for (let i = 0; i < results.length; i++) {\n      const { value } = results[i];\n      const { accountAddress, tokenAddress } = accountTokenPairs[i];\n      const currentTokenBalanceValueForAccount =\n        currentTokenBalances.tokenBalances?.[accountAddress]?.[chainId]?.[\n          tokenAddress\n        ];\n      const isTokenBalanceValueChanged =\n        currentTokenBalanceValueForAccount !== toHex(value as BN);\n      updatedResults[i] = {\n        ...results[i],\n        isTokenBalanceValueChanged,\n      };\n    }\n\n    // if all values of isTokenBalanceValueChanged are false, return\n    if (updatedResults.every((result) => !result.isTokenBalanceValueChanged)) {\n      return;\n    }\n\n    this.update((state) => {\n      for (let i = 0; i < updatedResults.length; i++) {\n        const { success, value, isTokenBalanceValueChanged } =\n          updatedResults[i];\n        const { accountAddress, tokenAddress } = accountTokenPairs[i];\n        if (success && isTokenBalanceValueChanged) {\n          ((state.tokenBalances[accountAddress] ??= {})[chainId] ??= {})[\n            tokenAddress\n          ] = toHex(value as BN);\n        }\n      }\n    });\n  }\n\n  /**\n   * Reset the controller state to the default state.\n   */\n  resetState() {\n    this.update(() => {\n      return getDefaultTokenBalancesState();\n    });\n  }\n\n  /**\n   * Returns the network client for a given chain id\n   * @param chainId - The chain id to get the network client for.\n   * @returns The network client for the given chain id.\n   */\n  #getNetworkClient(chainId: Hex) {\n    const { networkConfigurationsByChainId } = this.messagingSystem.call(\n      'NetworkController:getState',\n    );\n\n    const networkConfiguration = networkConfigurationsByChainId[chainId];\n    if (!networkConfiguration) {\n      throw new Error(\n        `TokenBalancesController: No network configuration found for chainId ${chainId}`,\n      );\n    }\n\n    const { networkClientId } =\n      networkConfiguration.rpcEndpoints[\n        networkConfiguration.defaultRpcEndpointIndex\n      ];\n\n    return this.messagingSystem.call(\n      `NetworkController:getNetworkClientById`,\n      networkClientId,\n    );\n  }\n}\n\nexport default TokenBalancesController;\n"]}

package/dist/TokenBalancesController.d.cts

@@ -1,4 +1,4 @@
-import type { AccountsControllerGetSelectedAccountAction } from "@metamask/accounts-controller";
+import type { AccountsControllerAccountRemovedEvent, AccountsControllerGetSelectedAccountAction } from "@metamask/accounts-controller";
 import type { RestrictedMessenger, ControllerGetStateAction, ControllerStateChangeEvent } from "@metamask/base-controller";
 import type { NetworkControllerGetNetworkClientByIdAction, NetworkControllerGetStateAction, NetworkControllerStateChangeEvent } from "@metamask/network-controller";
 import type { PreferencesControllerGetStateAction, PreferencesControllerStateChangeEvent } from "@metamask/preferences-controller";
@@ -32,7 +32,7 @@ export type TokenBalancesControllerActions = TokenBalancesControllerGetStateActi
 export type AllowedActions = NetworkControllerGetNetworkClientByIdAction | NetworkControllerGetStateAction | TokensControllerGetStateAction | PreferencesControllerGetStateAction | AccountsControllerGetSelectedAccountAction;
 export type TokenBalancesControllerStateChangeEvent = ControllerStateChangeEvent<typeof controllerName, TokenBalancesControllerState>;
 export type TokenBalancesControllerEvents = TokenBalancesControllerStateChangeEvent;
-export type AllowedEvents = TokensControllerStateChangeEvent | PreferencesControllerStateChangeEvent | NetworkControllerStateChangeEvent;
+export type AllowedEvents = TokensControllerStateChangeEvent | PreferencesControllerStateChangeEvent | NetworkControllerStateChangeEvent | AccountsControllerAccountRemovedEvent;
 export type TokenBalancesControllerMessenger = RestrictedMessenger<typeof controllerName, TokenBalancesControllerActions | AllowedActions, TokenBalancesControllerEvents | AllowedEvents, AllowedActions['type'], AllowedEvents['type']>;
 /**
  * Get the default TokenBalancesController state.
@@ -56,9 +56,7 @@ declare const TokenBalancesController_base: (abstract new (...args: any[]) => {
     _executePoll(input: TokenBalancesPollingInput): Promise<void>;
     startPolling(input: TokenBalancesPollingInput): string;
     stopAllPolling(): void;
-    stopPollingByPollingToken(pollingToken: string): void; /**
-     * A mapping from account address to chain id to token address to balance.
-     */
+    stopPollingByPollingToken(pollingToken: string): void;
     onPollingComplete(input: TokenBalancesPollingInput, callback: (input: TokenBalancesPollingInput) => void): void;
 }) & typeof import("@metamask/base-controller").BaseController;
 /**

package/dist/TokenBalancesController.d.cts.map

@@ -1 +1 @@
-{"version":3,"file":"TokenBalancesController.d.cts","sourceRoot":"","sources":["../src/TokenBalancesController.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,0CAA0C,EAAE,sCAAsC;AAChG,OAAO,KAAK,EACV,mBAAmB,EACnB,wBAAwB,EACxB,0BAA0B,EAC3B,kCAAkC;AAGnC,OAAO,KAAK,EACV,2CAA2C,EAC3C,+BAA+B,EAC/B,iCAAiC,EAElC,qCAAqC;AAEtC,OAAO,KAAK,EACV,mCAAmC,EACnC,qCAAqC,EAEtC,yCAAyC;AAC1C,OAAO,KAAK,EAAE,GAAG,EAAE,wBAAwB;AAQ3C,OAAO,KAAK,EACV,8BAA8B,EAE9B,gCAAgC,EACjC,+BAA2B;AAI5B,QAAA,MAAM,cAAc,4BAA4B,CAAC;AAMjD;;;;;GAKG;AACH,KAAK,8BAA8B,GAAG;IACpC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,gCAAgC,CAAC;IAC5C,KAAK,CAAC,EAAE,OAAO,CAAC,4BAA4B,CAAC,CAAC;CAC/C,CAAC;AAEF;;GAEG;AACH,KAAK,aAAa,GAAG,MAAM,CAAC,GAAG,EAAE,MAAM,CAAC,GAAG,EAAE,MAAM,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC,CAAC,CAAC;AAEhE;;;GAGG;AACH,MAAM,MAAM,4BAA4B,GAAG;IACzC,aAAa,EAAE,aAAa,CAAC;CAC9B,CAAC;AAEF,MAAM,MAAM,qCAAqC,GAAG,wBAAwB,CAC1E,OAAO,cAAc,EACrB,4BAA4B,CAC7B,CAAC;AAEF,MAAM,MAAM,8BAA8B,GACxC,qCAAqC,CAAC;AAExC,MAAM,MAAM,cAAc,GACtB,2CAA2C,GAC3C,+BAA+B,GAC/B,8BAA8B,GAC9B,mCAAmC,GACnC,0CAA0C,CAAC;AAE/C,MAAM,MAAM,uCAAuC,GACjD,0BAA0B,CACxB,OAAO,cAAc,EACrB,4BAA4B,CAC7B,CAAC;AAEJ,MAAM,MAAM,6BAA6B,GACvC,uCAAuC,CAAC;AAE1C,MAAM,MAAM,aAAa,GACrB,gCAAgC,GAChC,qCAAqC,GACrC,iCAAiC,CAAC;AAEtC,MAAM,MAAM,gCAAgC,GAAG,mBAAmB,CAChE,OAAO,cAAc,EACrB,8BAA8B,GAAG,cAAc,EAC/C,6BAA6B,GAAG,aAAa,EAC7C,cAAc,CAAC,MAAM,CAAC,EACtB,aAAa,CAAC,MAAM,CAAC,CACtB,CAAC;AAEF;;;;GAIG;AACH,wBAAgB,4BAA4B,IAAI,4BAA4B,CAI3E;AAED,yEAAyE;AACzE,MAAM,MAAM,yBAAyB,GAAG;IACtC,OAAO,EAAE,GAAG,CAAC;CACd,CAAC;;;;;;;;;;;;;2DAhEF;;OAEG;;;AAgEH;;;GAGG;AACH,qBAAa,uBAAwB,SAAQ,6BAC3C,OAAO,cAAc,EACrB,4BAA4B,EAC5B,gCAAgC,CACjC;;IAOC;;;;;;;OAOG;gBACS,EACV,QAA2B,EAC3B,SAAS,EACT,KAAU,GACX,EAAE,8BAA8B;IA2IjC;;;;OAIG;IACG,YAAY,CAAC,EAAE,OAAO,EAAE,EAAE,yBAAyB;IAIzD;;;;;OAKG;IACG,cAAc,CAAC,EAAE,QAAQ,EAAE,GAAE;QAAE,QAAQ,CAAC,EAAE,GAAG,EAAE,CAAA;KAAO;IAQ5D;;;;OAIG;IACG,uBAAuB,CAAC,EAAE,OAAO,EAAE,EAAE;QAAE,OAAO,EAAE,GAAG,CAAA;KAAE;IA+D3D;;OAEG;IACH,UAAU;CAiCX;AAED,eAAe,uBAAuB,CAAC"}
+{"version":3,"file":"TokenBalancesController.d.cts","sourceRoot":"","sources":["../src/TokenBalancesController.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EACV,qCAAqC,EACrC,0CAA0C,EAC3C,sCAAsC;AACvC,OAAO,KAAK,EACV,mBAAmB,EACnB,wBAAwB,EACxB,0BAA0B,EAC3B,kCAAkC;AAGnC,OAAO,KAAK,EACV,2CAA2C,EAC3C,+BAA+B,EAC/B,iCAAiC,EAElC,qCAAqC;AAEtC,OAAO,KAAK,EACV,mCAAmC,EACnC,qCAAqC,EAEtC,yCAAyC;AAC1C,OAAO,KAAK,EAAE,GAAG,EAAE,wBAAwB;AAQ3C,OAAO,KAAK,EACV,8BAA8B,EAE9B,gCAAgC,EACjC,+BAA2B;AAI5B,QAAA,MAAM,cAAc,4BAA4B,CAAC;AAMjD;;;;;GAKG;AACH,KAAK,8BAA8B,GAAG;IACpC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,gCAAgC,CAAC;IAC5C,KAAK,CAAC,EAAE,OAAO,CAAC,4BAA4B,CAAC,CAAC;CAC/C,CAAC;AAEF;;GAEG;AACH,KAAK,aAAa,GAAG,MAAM,CAAC,GAAG,EAAE,MAAM,CAAC,GAAG,EAAE,MAAM,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC,CAAC,CAAC;AAEhE;;;GAGG;AACH,MAAM,MAAM,4BAA4B,GAAG;IACzC,aAAa,EAAE,aAAa,CAAC;CAC9B,CAAC;AAEF,MAAM,MAAM,qCAAqC,GAAG,wBAAwB,CAC1E,OAAO,cAAc,EACrB,4BAA4B,CAC7B,CAAC;AAEF,MAAM,MAAM,8BAA8B,GACxC,qCAAqC,CAAC;AAExC,MAAM,MAAM,cAAc,GACtB,2CAA2C,GAC3C,+BAA+B,GAC/B,8BAA8B,GAC9B,mCAAmC,GACnC,0CAA0C,CAAC;AAE/C,MAAM,MAAM,uCAAuC,GACjD,0BAA0B,CACxB,OAAO,cAAc,EACrB,4BAA4B,CAC7B,CAAC;AAEJ,MAAM,MAAM,6BAA6B,GACvC,uCAAuC,CAAC;AAE1C,MAAM,MAAM,aAAa,GACrB,gCAAgC,GAChC,qCAAqC,GACrC,iCAAiC,GACjC,qCAAqC,CAAC;AAE1C,MAAM,MAAM,gCAAgC,GAAG,mBAAmB,CAChE,OAAO,cAAc,EACrB,8BAA8B,GAAG,cAAc,EAC/C,6BAA6B,GAAG,aAAa,EAC7C,cAAc,CAAC,MAAM,CAAC,EACtB,aAAa,CAAC,MAAM,CAAC,CACtB,CAAC;AAEF;;;;GAIG;AACH,wBAAgB,4BAA4B,IAAI,4BAA4B,CAI3E;AAED,yEAAyE;AACzE,MAAM,MAAM,yBAAyB,GAAG;IACtC,OAAO,EAAE,GAAG,CAAC;CACd,CAAC;;;;;;;;;;;;;;;;AAEF;;;GAGG;AACH,qBAAa,uBAAwB,SAAQ,6BAC3C,OAAO,cAAc,EACrB,4BAA4B,EAC5B,gCAAgC,CACjC;;IAOC;;;;;;;OAOG;gBACS,EACV,QAA2B,EAC3B,SAAS,EACT,KAAU,GACX,EAAE,8BAA8B;IA6JjC;;;;OAIG;IACG,YAAY,CAAC,EAAE,OAAO,EAAE,EAAE,yBAAyB;IAIzD;;;;;OAKG;IACG,cAAc,CAAC,EAAE,QAAQ,EAAE,GAAE;QAAE,QAAQ,CAAC,EAAE,GAAG,EAAE,CAAA;KAAO;IAyC5D;;;;OAIG;IACG,uBAAuB,CAAC,EAAE,OAAO,EAAE,EAAE;QAAE,OAAO,EAAE,GAAG,CAAA;KAAE;IAuF3D;;OAEG;IACH,UAAU;CAiCX;AAED,eAAe,uBAAuB,CAAC"}

package/dist/TokenBalancesController.d.mts

@@ -1,4 +1,4 @@
-import type { AccountsControllerGetSelectedAccountAction } from "@metamask/accounts-controller";
+import type { AccountsControllerAccountRemovedEvent, AccountsControllerGetSelectedAccountAction } from "@metamask/accounts-controller";
 import type { RestrictedMessenger, ControllerGetStateAction, ControllerStateChangeEvent } from "@metamask/base-controller";
 import type { NetworkControllerGetNetworkClientByIdAction, NetworkControllerGetStateAction, NetworkControllerStateChangeEvent } from "@metamask/network-controller";
 import type { PreferencesControllerGetStateAction, PreferencesControllerStateChangeEvent } from "@metamask/preferences-controller";
@@ -32,7 +32,7 @@ export type TokenBalancesControllerActions = TokenBalancesControllerGetStateActi
 export type AllowedActions = NetworkControllerGetNetworkClientByIdAction | NetworkControllerGetStateAction | TokensControllerGetStateAction | PreferencesControllerGetStateAction | AccountsControllerGetSelectedAccountAction;
 export type TokenBalancesControllerStateChangeEvent = ControllerStateChangeEvent<typeof controllerName, TokenBalancesControllerState>;
 export type TokenBalancesControllerEvents = TokenBalancesControllerStateChangeEvent;
-export type AllowedEvents = TokensControllerStateChangeEvent | PreferencesControllerStateChangeEvent | NetworkControllerStateChangeEvent;
+export type AllowedEvents = TokensControllerStateChangeEvent | PreferencesControllerStateChangeEvent | NetworkControllerStateChangeEvent | AccountsControllerAccountRemovedEvent;
 export type TokenBalancesControllerMessenger = RestrictedMessenger<typeof controllerName, TokenBalancesControllerActions | AllowedActions, TokenBalancesControllerEvents | AllowedEvents, AllowedActions['type'], AllowedEvents['type']>;
 /**
  * Get the default TokenBalancesController state.
@@ -56,9 +56,7 @@ declare const TokenBalancesController_base: (abstract new (...args: any[]) => {
     _executePoll(input: TokenBalancesPollingInput): Promise<void>;
     startPolling(input: TokenBalancesPollingInput): string;
     stopAllPolling(): void;
-    stopPollingByPollingToken(pollingToken: string): void; /**
-     * A mapping from account address to chain id to token address to balance.
-     */
+    stopPollingByPollingToken(pollingToken: string): void;
     onPollingComplete(input: TokenBalancesPollingInput, callback: (input: TokenBalancesPollingInput) => void): void;
 }) & typeof import("@metamask/base-controller").BaseController;
 /**

package/dist/TokenBalancesController.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"TokenBalancesController.d.mts","sourceRoot":"","sources":["../src/TokenBalancesController.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,0CAA0C,EAAE,sCAAsC;AAChG,OAAO,KAAK,EACV,mBAAmB,EACnB,wBAAwB,EACxB,0BAA0B,EAC3B,kCAAkC;AAGnC,OAAO,KAAK,EACV,2CAA2C,EAC3C,+BAA+B,EAC/B,iCAAiC,EAElC,qCAAqC;AAEtC,OAAO,KAAK,EACV,mCAAmC,EACnC,qCAAqC,EAEtC,yCAAyC;AAC1C,OAAO,KAAK,EAAE,GAAG,EAAE,wBAAwB;AAQ3C,OAAO,KAAK,EACV,8BAA8B,EAE9B,gCAAgC,EACjC,+BAA2B;AAI5B,QAAA,MAAM,cAAc,4BAA4B,CAAC;AAMjD;;;;;GAKG;AACH,KAAK,8BAA8B,GAAG;IACpC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,gCAAgC,CAAC;IAC5C,KAAK,CAAC,EAAE,OAAO,CAAC,4BAA4B,CAAC,CAAC;CAC/C,CAAC;AAEF;;GAEG;AACH,KAAK,aAAa,GAAG,MAAM,CAAC,GAAG,EAAE,MAAM,CAAC,GAAG,EAAE,MAAM,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC,CAAC,CAAC;AAEhE;;;GAGG;AACH,MAAM,MAAM,4BAA4B,GAAG;IACzC,aAAa,EAAE,aAAa,CAAC;CAC9B,CAAC;AAEF,MAAM,MAAM,qCAAqC,GAAG,wBAAwB,CAC1E,OAAO,cAAc,EACrB,4BAA4B,CAC7B,CAAC;AAEF,MAAM,MAAM,8BAA8B,GACxC,qCAAqC,CAAC;AAExC,MAAM,MAAM,cAAc,GACtB,2CAA2C,GAC3C,+BAA+B,GAC/B,8BAA8B,GAC9B,mCAAmC,GACnC,0CAA0C,CAAC;AAE/C,MAAM,MAAM,uCAAuC,GACjD,0BAA0B,CACxB,OAAO,cAAc,EACrB,4BAA4B,CAC7B,CAAC;AAEJ,MAAM,MAAM,6BAA6B,GACvC,uCAAuC,CAAC;AAE1C,MAAM,MAAM,aAAa,GACrB,gCAAgC,GAChC,qCAAqC,GACrC,iCAAiC,CAAC;AAEtC,MAAM,MAAM,gCAAgC,GAAG,mBAAmB,CAChE,OAAO,cAAc,EACrB,8BAA8B,GAAG,cAAc,EAC/C,6BAA6B,GAAG,aAAa,EAC7C,cAAc,CAAC,MAAM,CAAC,EACtB,aAAa,CAAC,MAAM,CAAC,CACtB,CAAC;AAEF;;;;GAIG;AACH,wBAAgB,4BAA4B,IAAI,4BAA4B,CAI3E;AAED,yEAAyE;AACzE,MAAM,MAAM,yBAAyB,GAAG;IACtC,OAAO,EAAE,GAAG,CAAC;CACd,CAAC;;;;;;;;;;;;;2DAhEF;;OAEG;;;AAgEH;;;GAGG;AACH,qBAAa,uBAAwB,SAAQ,6BAC3C,OAAO,cAAc,EACrB,4BAA4B,EAC5B,gCAAgC,CACjC;;IAOC;;;;;;;OAOG;gBACS,EACV,QAA2B,EAC3B,SAAS,EACT,KAAU,GACX,EAAE,8BAA8B;IA2IjC;;;;OAIG;IACG,YAAY,CAAC,EAAE,OAAO,EAAE,EAAE,yBAAyB;IAIzD;;;;;OAKG;IACG,cAAc,CAAC,EAAE,QAAQ,EAAE,GAAE;QAAE,QAAQ,CAAC,EAAE,GAAG,EAAE,CAAA;KAAO;IAQ5D;;;;OAIG;IACG,uBAAuB,CAAC,EAAE,OAAO,EAAE,EAAE;QAAE,OAAO,EAAE,GAAG,CAAA;KAAE;IA+D3D;;OAEG;IACH,UAAU;CAiCX;AAED,eAAe,uBAAuB,CAAC"}
+{"version":3,"file":"TokenBalancesController.d.mts","sourceRoot":"","sources":["../src/TokenBalancesController.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EACV,qCAAqC,EACrC,0CAA0C,EAC3C,sCAAsC;AACvC,OAAO,KAAK,EACV,mBAAmB,EACnB,wBAAwB,EACxB,0BAA0B,EAC3B,kCAAkC;AAGnC,OAAO,KAAK,EACV,2CAA2C,EAC3C,+BAA+B,EAC/B,iCAAiC,EAElC,qCAAqC;AAEtC,OAAO,KAAK,EACV,mCAAmC,EACnC,qCAAqC,EAEtC,yCAAyC;AAC1C,OAAO,KAAK,EAAE,GAAG,EAAE,wBAAwB;AAQ3C,OAAO,KAAK,EACV,8BAA8B,EAE9B,gCAAgC,EACjC,+BAA2B;AAI5B,QAAA,MAAM,cAAc,4BAA4B,CAAC;AAMjD;;;;;GAKG;AACH,KAAK,8BAA8B,GAAG;IACpC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,gCAAgC,CAAC;IAC5C,KAAK,CAAC,EAAE,OAAO,CAAC,4BAA4B,CAAC,CAAC;CAC/C,CAAC;AAEF;;GAEG;AACH,KAAK,aAAa,GAAG,MAAM,CAAC,GAAG,EAAE,MAAM,CAAC,GAAG,EAAE,MAAM,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC,CAAC,CAAC;AAEhE;;;GAGG;AACH,MAAM,MAAM,4BAA4B,GAAG;IACzC,aAAa,EAAE,aAAa,CAAC;CAC9B,CAAC;AAEF,MAAM,MAAM,qCAAqC,GAAG,wBAAwB,CAC1E,OAAO,cAAc,EACrB,4BAA4B,CAC7B,CAAC;AAEF,MAAM,MAAM,8BAA8B,GACxC,qCAAqC,CAAC;AAExC,MAAM,MAAM,cAAc,GACtB,2CAA2C,GAC3C,+BAA+B,GAC/B,8BAA8B,GAC9B,mCAAmC,GACnC,0CAA0C,CAAC;AAE/C,MAAM,MAAM,uCAAuC,GACjD,0BAA0B,CACxB,OAAO,cAAc,EACrB,4BAA4B,CAC7B,CAAC;AAEJ,MAAM,MAAM,6BAA6B,GACvC,uCAAuC,CAAC;AAE1C,MAAM,MAAM,aAAa,GACrB,gCAAgC,GAChC,qCAAqC,GACrC,iCAAiC,GACjC,qCAAqC,CAAC;AAE1C,MAAM,MAAM,gCAAgC,GAAG,mBAAmB,CAChE,OAAO,cAAc,EACrB,8BAA8B,GAAG,cAAc,EAC/C,6BAA6B,GAAG,aAAa,EAC7C,cAAc,CAAC,MAAM,CAAC,EACtB,aAAa,CAAC,MAAM,CAAC,CACtB,CAAC;AAEF;;;;GAIG;AACH,wBAAgB,4BAA4B,IAAI,4BAA4B,CAI3E;AAED,yEAAyE;AACzE,MAAM,MAAM,yBAAyB,GAAG;IACtC,OAAO,EAAE,GAAG,CAAC;CACd,CAAC;;;;;;;;;;;;;;;;AAEF;;;GAGG;AACH,qBAAa,uBAAwB,SAAQ,6BAC3C,OAAO,cAAc,EACrB,4BAA4B,EAC5B,gCAAgC,CACjC;;IAOC;;;;;;;OAOG;gBACS,EACV,QAA2B,EAC3B,SAAS,EACT,KAAU,GACX,EAAE,8BAA8B;IA6JjC;;;;OAIG;IACG,YAAY,CAAC,EAAE,OAAO,EAAE,EAAE,yBAAyB;IAIzD;;;;;OAKG;IACG,cAAc,CAAC,EAAE,QAAQ,EAAE,GAAE;QAAE,QAAQ,CAAC,EAAE,GAAG,EAAE,CAAA;KAAO;IAyC5D;;;;OAIG;IACG,uBAAuB,CAAC,EAAE,OAAO,EAAE,EAAE;QAAE,OAAO,EAAE,GAAG,CAAA;KAAE;IAuF3D;;OAEG;IACH,UAAU;CAiCX;AAED,eAAe,uBAAuB,CAAC"}

package/dist/TokenBalancesController.mjs

@@ -9,7 +9,7 @@ var __classPrivateFieldSet = (this && this.__classPrivateFieldSet) || function (
     if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot write private member to an object whose class did not declare it");
     return (kind === "a" ? f.call(receiver, value) : f ? f.value = value : state.set(receiver, value)), value;
 };
-var _TokenBalancesController_instances, _TokenBalancesController_queryMultipleAccounts, _TokenBalancesController_allTokens, _TokenBalancesController_allDetectedTokens, _TokenBalancesController_calculateQueryMultipleAccounts, _TokenBalancesController_onPreferencesStateChange, _TokenBalancesController_onTokensStateChange, _TokenBalancesController_onNetworkStateChange, _TokenBalancesController_getChainIds, _TokenBalancesController_getNetworkClient;
+var _TokenBalancesController_instances, _TokenBalancesController_queryMultipleAccounts, _TokenBalancesController_allTokens, _TokenBalancesController_allDetectedTokens, _TokenBalancesController_calculateQueryMultipleAccounts, _TokenBalancesController_onPreferencesStateChange, _TokenBalancesController_onTokensStateChange, _TokenBalancesController_onNetworkStateChange, _TokenBalancesController_handleOnAccountRemoved, _TokenBalancesController_getChainIds, _TokenBalancesController_cleanupCurrentTokenBalances, _TokenBalancesController_getNetworkClient;
 import { Contract } from "@ethersproject/contracts";
 import { Web3Provider } from "@ethersproject/providers";
 import { toChecksumHexAddress, toHex } from "@metamask/controller-utils";
@@ -126,6 +126,8 @@ export class TokenBalancesController extends StaticIntervalPollingController() {
         this.messagingSystem.subscribe('TokensController:stateChange', __classPrivateFieldGet(this, _TokenBalancesController_onTokensStateChange, "f").bind(this));
         // Subscribe to network state changes
         this.messagingSystem.subscribe('NetworkController:stateChange', __classPrivateFieldGet(this, _TokenBalancesController_instances, "m", _TokenBalancesController_onNetworkStateChange).bind(this));
+        // subscribe to account removed event to cleanup stale balances
+        this.messagingSystem.subscribe('AccountsController:accountRemoved', (accountAddress) => __classPrivateFieldGet(this, _TokenBalancesController_instances, "m", _TokenBalancesController_handleOnAccountRemoved).call(this, accountAddress));
     }
     /**
      * Polls for erc20 token balances.
@@ -165,6 +167,9 @@ export class TokenBalancesController extends StaticIntervalPollingController() {
         Object.entries(__classPrivateFieldGet(this, _TokenBalancesController_allTokens, "f")[chainId] ?? {}).forEach(addTokens);
         Object.entries(__classPrivateFieldGet(this, _TokenBalancesController_allDetectedTokens, "f")[chainId] ?? {}).forEach(addTokens);
         let results = [];
+        // in case currentTokenBalances has a token that is not in accountTokenPairs, we will remove it from currentTokenBalances
+        __classPrivateFieldGet(this, _TokenBalancesController_instances, "m", _TokenBalancesController_cleanupCurrentTokenBalances).call(this, accountTokenPairs, chainId);
+        const currentTokenBalances = this.messagingSystem.call('TokenBalancesController:getState');
         if (accountTokenPairs.length > 0) {
             const provider = new Web3Provider(__classPrivateFieldGet(this, _TokenBalancesController_instances, "m", _TokenBalancesController_getNetworkClient).call(this, chainId).provider);
             const calls = accountTokenPairs.map(({ accountAddress, tokenAddress }) => ({
@@ -174,17 +179,27 @@ export class TokenBalancesController extends StaticIntervalPollingController() {
             }));
             results = await multicallOrFallback(calls, chainId, provider);
         }
+        const updatedResults = [...results];
+        for (let i = 0; i < results.length; i++) {
+            const { value } = results[i];
+            const { accountAddress, tokenAddress } = accountTokenPairs[i];
+            const currentTokenBalanceValueForAccount = currentTokenBalances.tokenBalances?.[accountAddress]?.[chainId]?.[tokenAddress];
+            const isTokenBalanceValueChanged = currentTokenBalanceValueForAccount !== toHex(value);
+            updatedResults[i] = {
+                ...results[i],
+                isTokenBalanceValueChanged,
+            };
+        }
+        // if all values of isTokenBalanceValueChanged are false, return
+        if (updatedResults.every((result) => !result.isTokenBalanceValueChanged)) {
+            return;
+        }
         this.update((state) => {
             var _a, _b;
-            // Reset so that when accounts or tokens are removed,
-            // their balances are removed rather than left stale.
-            for (const accountAddress of Object.keys(state.tokenBalances)) {
-                state.tokenBalances[accountAddress][chainId] = {};
-            }
-            for (let i = 0; i < results.length; i++) {
-                const { success, value } = results[i];
+            for (let i = 0; i < updatedResults.length; i++) {
+                const { success, value, isTokenBalanceValueChanged } = updatedResults[i];
                 const { accountAddress, tokenAddress } = accountTokenPairs[i];
-                if (success) {
+                if (success && isTokenBalanceValueChanged) {
                     ((_b = ((_a = state.tokenBalances)[accountAddress] ?? (_a[accountAddress] = {})))[chainId] ?? (_b[chainId] = {}))[tokenAddress] = toHex(value);
                 }
             }
@@ -212,6 +227,25 @@ _TokenBalancesController_queryMultipleAccounts = new WeakMap(), _TokenBalancesCo
             });
         }
     }
+}, _TokenBalancesController_handleOnAccountRemoved = function _TokenBalancesController_handleOnAccountRemoved(accountAddress) {
+    this.update((state) => {
+        delete state.tokenBalances[accountAddress];
+    });
+}, _TokenBalancesController_cleanupCurrentTokenBalances = function _TokenBalancesController_cleanupCurrentTokenBalances(accountTokenPairs, chainId) {
+    // TODO move this to a private fct
+    const currentTokenBalances = this.messagingSystem.call('TokenBalancesController:getState');
+    // in case currentTokenBalances has a token that is not in accountTokenPairs, we will remove it from currentTokenBalances
+    // loop through currentTokenBalances.tokenBalances, for each account loop though the account[chainId] array of tokens and check if the token is in accountTokenPairs
+    // if not, remove it from currentTokenBalances
+    for (const accountAddress of Object.keys(currentTokenBalances.tokenBalances)) {
+        for (const tokenAddress of Object.keys(currentTokenBalances.tokenBalances[accountAddress][chainId])) {
+            if (!accountTokenPairs.some((pair) => pair.tokenAddress === tokenAddress)) {
+                this.update((state) => {
+                    delete state.tokenBalances[accountAddress][chainId][tokenAddress];
+                });
+            }
+        }
+    }
 }, _TokenBalancesController_getNetworkClient = function _TokenBalancesController_getNetworkClient(chainId) {
     const { networkConfigurationsByChainId } = this.messagingSystem.call('NetworkController:getState');
     const networkConfiguration = networkConfigurationsByChainId[chainId];

package/dist/TokenBalancesController.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"TokenBalancesController.mjs","sourceRoot":"","sources":["../src/TokenBalancesController.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,OAAO,EAAE,QAAQ,EAAE,iCAAiC;AACpD,OAAO,EAAE,YAAY,EAAE,iCAAiC;AAOxD,OAAO,EAAE,oBAAoB,EAAE,KAAK,EAAE,mCAAmC;AACzE,OAAO,EAAE,QAAQ,EAAE,oCAAoC;AAOvD,OAAO,EAAE,+BAA+B,EAAE,qCAAqC;;;AAY/E,OAAO,EAAE,mBAAmB,EAAE,wBAAoB;AAQlD,MAAM,gBAAgB,GAAG,MAAM,CAAC;AAEhC,MAAM,cAAc,GAAG,yBAAyB,CAAC;AAEjD,MAAM,QAAQ,GAAG;IACf,aAAa,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,KAAK,EAAE;CACnD,CAAC;AAgEF;;;;GAIG;AACH,MAAM,UAAU,4BAA4B;IAC1C,OAAO;QACL,aAAa,EAAE,EAAE;KAClB,CAAC;AACJ,CAAC;AAOD;;;GAGG;AACH,MAAM,OAAO,uBAAwB,SAAQ,+BAA+B,EAI3E;IAOC;;;;;;;OAOG;IACH,YAAY,EACV,QAAQ,GAAG,gBAAgB,EAC3B,SAAS,EACT,KAAK,GAAG,EAAE,GACqB;;QAC/B,KAAK,CAAC;YACJ,IAAI,EAAE,cAAc;YACpB,QAAQ;YACR,SAAS;YACT,KAAK,EAAE;gBACL,GAAG,4BAA4B,EAAE;gBACjC,GAAG,KAAK;aACT;SACF,CAAC,CAAC;;QA3BL,iEAAgC;QAEhC,qDAA+C;QAE/C,6DAA+D;QAsD/D;;;;;;WAMG;QACH,kEAAkC,CAAC,EACjC,6BAA6B,EAC7B,6BAA6B,GACkC,EAAE,EAAE;YACnE,OAAO,OAAO;YACZ,mEAAmE;YACnE,6BAA6B,IAAI,6BAA6B,CAC/D,CAAC;QACJ,CAAC,EAAC;QAEF;;;WAGG;QACH,4DAA4B,CAAC,WAA6B,EAAE,EAAE;YAC5D,qEAAqE;YACrE,MAAM,qBAAqB,GACzB,uBAAA,IAAI,+DAAgC,MAApC,IAAI,EAAiC,WAAW,CAAC,CAAC;YAEpD,iCAAiC;YACjC,MAAM,OAAO,GAAG,qBAAqB,IAAI,CAAC,uBAAA,IAAI,sDAAuB,CAAC;YACtE,uBAAA,IAAI,kDAA0B,qBAAqB,MAAA,CAAC;YAEpD,IAAI,OAAO,EAAE;gBACX,IAAI,CAAC,cAAc,EAAE,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;aAC5C;QACH,CAAC,EAAC;QAEF;;;;;WAKG;QACH,uDAAuB,CAAC,EACtB,SAAS,EACT,iBAAiB,GACK,EAAE,EAAE;YAC1B,8DAA8D;YAC9D,MAAM,QAAQ,GAAG,uBAAA,IAAI,4CAAa,MAAjB,IAAI,EAAc,SAAS,EAAE,iBAAiB,CAAC,CAAC;YACjE,MAAM,gBAAgB,GAAG,QAAQ,CAAC,MAAM,CACtC,CAAC,OAAO,EAAE,EAAE,CACV,CAAC,OAAO,CAAC,uBAAA,IAAI,0CAAW,CAAC,OAAO,CAAC,EAAE,SAAS,CAAC,OAAO,CAAC,CAAC;gBACtD,CAAC,OAAO,CAAC,uBAAA,IAAI,kDAAmB,CAAC,OAAO,CAAC,EAAE,iBAAiB,CAAC,OAAO,CAAC,CAAC,CACzE,CAAC;YAEF,uBAAA,IAAI,sCAAc,SAAS,MAAA,CAAC;YAC5B,uBAAA,IAAI,8CAAsB,iBAAiB,MAAA,CAAC;YAE5C,IAAI,CAAC,cAAc,CAAC,EAAE,QAAQ,EAAE,gBAAgB,EAAE,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;QAC3E,CAAC,EAAC;QAyBF;;;;;WAKG;QACH,+CAAe,CACb,SAA6C,EAC7C,iBAA6D,EAC7D,EAAE,CACF;YACE,GAAG,IAAI,GAAG,CAAC;gBACT,GAAG,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC;gBACzB,GAAG,MAAM,CAAC,IAAI,CAAC,iBAAiB,CAAC;aAClC,CAAC;SACM,EAAC;QA9HX,IAAI,CAAC,iBAAiB,CAAC,QAAQ,CAAC,CAAC;QAEjC,kFAAkF;QAClF,uBAAA,IAAI,kDAA0B,uBAAA,IAAI,+DAAgC,MAApC,IAAI,EAChC,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,gCAAgC,CAAC,CAC5D,MAAA,CAAC;QACF,IAAI,CAAC,eAAe,CAAC,SAAS,CAC5B,mCAAmC,EACnC,uBAAA,IAAI,yDAA0B,CAAC,IAAI,CAAC,IAAI,CAAC,CAC1C,CAAC;QAEF,+CAA+C;QAC/C,MACa,IAAI,OACI,IAAI,EAFxB;YACC,SAAS,wGAAiB;YAC1B,iBAAiB,gHAAyB;SAC3C,GAAG,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,2BAA2B,CAAC,CAAC,CAAC;QAE5D,IAAI,CAAC,eAAe,CAAC,SAAS,CAC5B,8BAA8B,EAC9B,uBAAA,IAAI,oDAAqB,CAAC,IAAI,CAAC,IAAI,CAAC,CACrC,CAAC;QAEF,qCAAqC;QACrC,IAAI,CAAC,eAAe,CAAC,SAAS,CAC5B,+BAA+B,EAC/B,uBAAA,IAAI,yFAAsB,CAAC,IAAI,CAAC,IAAI,CAAC,CACtC,CAAC;IACJ,CAAC;IAqGD;;;;OAIG;IACH,KAAK,CAAC,YAAY,CAAC,EAAE,OAAO,EAA6B;QACvD,MAAM,IAAI,CAAC,uBAAuB,CAAC,EAAE,OAAO,EAAE,CAAC,CAAC;IAClD,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,cAAc,CAAC,EAAE,QAAQ,KAA2B,EAAE;QAC1D,QAAQ,KAAR,QAAQ,GAAK,uBAAA,IAAI,4CAAa,MAAjB,IAAI,EAAc,uBAAA,IAAI,0CAAW,EAAE,uBAAA,IAAI,kDAAmB,CAAC,EAAC;QAEzE,MAAM,OAAO,CAAC,UAAU,CACtB,QAAQ,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,IAAI,CAAC,uBAAuB,CAAC,EAAE,OAAO,EAAE,CAAC,CAAC,CACrE,CAAC;IACJ,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,uBAAuB,CAAC,EAAE,OAAO,EAAoB;QACzD,MAAM,EAAE,OAAO,EAAE,sBAAsB,EAAE,GAAG,IAAI,CAAC,eAAe,CAAC,IAAI,CACnE,uCAAuC,CACxC,CAAC;QAEF,MAAM,iBAAiB,GAAG,CAAC,cAAsB,EAAE,EAAE,CACnD,oBAAoB,CAAC,cAAc,CAAC;YACpC,oBAAoB,CAAC,sBAAsB,CAAC,CAAC;QAE/C,MAAM,iBAAiB,GAAiD,EAAE,CAAC;QAE3E,MAAM,SAAS,GAAG,CAAC,CAAC,cAAc,EAAE,MAAM,CAAoB,EAAE,EAAE,CAChE,uBAAA,IAAI,sDAAuB,IAAI,iBAAiB,CAAC,cAAc,CAAC;YAC9D,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE,CACnB,iBAAiB,CAAC,IAAI,CAAC;gBACrB,cAAc,EAAE,cAAqB;gBACrC,YAAY,EAAE,CAAC,CAAC,OAAc;aAC/B,CAAC,CACH;YACH,CAAC,CAAC,SAAS,CAAC;QAEhB,iEAAiE;QACjE,MAAM,CAAC,OAAO,CAAC,uBAAA,IAAI,0CAAW,CAAC,OAAO,CAAC,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;QAClE,MAAM,CAAC,OAAO,CAAC,uBAAA,IAAI,kDAAmB,CAAC,OAAO,CAAC,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;QAE1E,IAAI,OAAO,GAAsB,EAAE,CAAC;QAEpC,IAAI,iBAAiB,CAAC,MAAM,GAAG,CAAC,EAAE;YAChC,MAAM,QAAQ,GAAG,IAAI,YAAY,CAC/B,uBAAA,IAAI,qFAAkB,MAAtB,IAAI,EAAmB,OAAO,CAAC,CAAC,QAAQ,CACzC,CAAC;YAEF,MAAM,KAAK,GAAG,iBAAiB,CAAC,GAAG,CACjC,CAAC,EAAE,cAAc,EAAE,YAAY,EAAE,EAAE,EAAE,CAAC,CAAC;gBACrC,QAAQ,EAAE,IAAI,QAAQ,CAAC,YAAY,EAAE,QAAQ,EAAE,QAAQ,CAAC;gBACxD,iBAAiB,EAAE,oBAAoB;gBACvC,SAAS,EAAE,CAAC,cAAc,CAAC;aAC5B,CAAC,CACH,CAAC;YAEF,OAAO,GAAG,MAAM,mBAAmB,CAAC,KAAK,EAAE,OAAO,EAAE,QAAQ,CAAC,CAAC;SAC/D;QAED,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;;YACpB,qDAAqD;YACrD,qDAAqD;YACrD,KAAK,MAAM,cAAc,IAAI,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,aAAa,CAAC,EAAE;gBAC7D,KAAK,CAAC,aAAa,CAAC,cAAqB,CAAC,CAAC,OAAO,CAAC,GAAG,EAAE,CAAC;aAC1D;YAED,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE;gBACvC,MAAM,EAAE,OAAO,EAAE,KAAK,EAAE,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC;gBACtC,MAAM,EAAE,cAAc,EAAE,YAAY,EAAE,GAAG,iBAAiB,CAAC,CAAC,CAAC,CAAC;gBAE9D,IAAI,OAAO,EAAE;oBACX,OAAC,OAAC,KAAK,CAAC,aAAa,EAAC,cAAc,SAAd,cAAc,IAAM,EAAE,EAAC,EAAC,OAAO,SAAP,OAAO,IAAM,EAAE,EAAC,CAC5D,YAAY,CACb,GAAG,KAAK,CAAC,KAAW,CAAC,CAAC;iBACxB;aACF;QACH,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACH,UAAU;QACR,IAAI,CAAC,MAAM,CAAC,GAAG,EAAE;YACf,OAAO,4BAA4B,EAAE,CAAC;QACxC,CAAC,CAAC,CAAC;IACL,CAAC;CA6BF;2kBAlKuB,CAAe,EAAE,OAAgB;IACrD,oCAAoC;IACpC,KAAK,MAAM,KAAK,IAAI,OAAO,EAAE;QAC3B,IACE,KAAK,CAAC,EAAE,KAAK,QAAQ;YACrB,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,gCAAgC,EAClD;YACA,MAAM,cAAc,GAAG,KAAK,CAAC,IAAI,CAAC,CAAC,CAAQ,CAAC;YAE5C,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;gBACpB,KAAK,MAAM,cAAc,IAAI,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,aAAa,CAAC,EAAE;oBAC7D,OAAO,KAAK,CAAC,aAAa,CAAC,cAAqB,CAAC,CAAC,cAAc,CAAC,CAAC;iBACnE;YACH,CAAC,CAAC,CAAC;SACJ;KACF;AACH,CAAC,iGA4HiB,OAAY;IAC5B,MAAM,EAAE,8BAA8B,EAAE,GAAG,IAAI,CAAC,eAAe,CAAC,IAAI,CAClE,4BAA4B,CAC7B,CAAC;IAEF,MAAM,oBAAoB,GAAG,8BAA8B,CAAC,OAAO,CAAC,CAAC;IACrE,IAAI,CAAC,oBAAoB,EAAE;QACzB,MAAM,IAAI,KAAK,CACb,uEAAuE,OAAO,EAAE,CACjF,CAAC;KACH;IAED,MAAM,EAAE,eAAe,EAAE,GACvB,oBAAoB,CAAC,YAAY,CAC/B,oBAAoB,CAAC,uBAAuB,CAC7C,CAAC;IAEJ,OAAO,IAAI,CAAC,eAAe,CAAC,IAAI,CAC9B,wCAAwC,EACxC,eAAe,CAChB,CAAC;AACJ,CAAC;AAGH,eAAe,uBAAuB,CAAC","sourcesContent":["import { Contract } from '@ethersproject/contracts';\nimport { Web3Provider } from '@ethersproject/providers';\nimport type { AccountsControllerGetSelectedAccountAction } from '@metamask/accounts-controller';\nimport type {\n  RestrictedMessenger,\n  ControllerGetStateAction,\n  ControllerStateChangeEvent,\n} from '@metamask/base-controller';\nimport { toChecksumHexAddress, toHex } from '@metamask/controller-utils';\nimport { abiERC20 } from '@metamask/metamask-eth-abis';\nimport type {\n  NetworkControllerGetNetworkClientByIdAction,\n  NetworkControllerGetStateAction,\n  NetworkControllerStateChangeEvent,\n  NetworkState,\n} from '@metamask/network-controller';\nimport { StaticIntervalPollingController } from '@metamask/polling-controller';\nimport type {\n  PreferencesControllerGetStateAction,\n  PreferencesControllerStateChangeEvent,\n  PreferencesState,\n} from '@metamask/preferences-controller';\nimport type { Hex } from '@metamask/utils';\nimport type BN from 'bn.js';\nimport type { Patch } from 'immer';\nimport { isEqual } from 'lodash';\n\nimport type { MulticallResult } from './multicall';\nimport { multicallOrFallback } from './multicall';\nimport type { Token } from './TokenRatesController';\nimport type {\n  TokensControllerGetStateAction,\n  TokensControllerState,\n  TokensControllerStateChangeEvent,\n} from './TokensController';\n\nconst DEFAULT_INTERVAL = 180000;\n\nconst controllerName = 'TokenBalancesController';\n\nconst metadata = {\n  tokenBalances: { persist: true, anonymous: false },\n};\n\n/**\n * Token balances controller options\n * @property interval - Polling interval used to fetch new token balances.\n * @property messenger - A messenger.\n * @property state - Initial state for the controller.\n */\ntype TokenBalancesControllerOptions = {\n  interval?: number;\n  messenger: TokenBalancesControllerMessenger;\n  state?: Partial<TokenBalancesControllerState>;\n};\n\n/**\n * A mapping from account address to chain id to token address to balance.\n */\ntype TokenBalances = Record<Hex, Record<Hex, Record<Hex, Hex>>>;\n\n/**\n * Token balances controller state\n * @property tokenBalances - A mapping from account address to chain id to token address to balance.\n */\nexport type TokenBalancesControllerState = {\n  tokenBalances: TokenBalances;\n};\n\nexport type TokenBalancesControllerGetStateAction = ControllerGetStateAction<\n  typeof controllerName,\n  TokenBalancesControllerState\n>;\n\nexport type TokenBalancesControllerActions =\n  TokenBalancesControllerGetStateAction;\n\nexport type AllowedActions =\n  | NetworkControllerGetNetworkClientByIdAction\n  | NetworkControllerGetStateAction\n  | TokensControllerGetStateAction\n  | PreferencesControllerGetStateAction\n  | AccountsControllerGetSelectedAccountAction;\n\nexport type TokenBalancesControllerStateChangeEvent =\n  ControllerStateChangeEvent<\n    typeof controllerName,\n    TokenBalancesControllerState\n  >;\n\nexport type TokenBalancesControllerEvents =\n  TokenBalancesControllerStateChangeEvent;\n\nexport type AllowedEvents =\n  | TokensControllerStateChangeEvent\n  | PreferencesControllerStateChangeEvent\n  | NetworkControllerStateChangeEvent;\n\nexport type TokenBalancesControllerMessenger = RestrictedMessenger<\n  typeof controllerName,\n  TokenBalancesControllerActions | AllowedActions,\n  TokenBalancesControllerEvents | AllowedEvents,\n  AllowedActions['type'],\n  AllowedEvents['type']\n>;\n\n/**\n * Get the default TokenBalancesController state.\n *\n * @returns The default TokenBalancesController state.\n */\nexport function getDefaultTokenBalancesState(): TokenBalancesControllerState {\n  return {\n    tokenBalances: {},\n  };\n}\n\n/** The input to start polling for the {@link TokenBalancesController} */\nexport type TokenBalancesPollingInput = {\n  chainId: Hex;\n};\n\n/**\n * Controller that passively polls on a set interval token balances\n * for tokens stored in the TokensController\n */\nexport class TokenBalancesController extends StaticIntervalPollingController<TokenBalancesPollingInput>()<\n  typeof controllerName,\n  TokenBalancesControllerState,\n  TokenBalancesControllerMessenger\n> {\n  #queryMultipleAccounts: boolean;\n\n  #allTokens: TokensControllerState['allTokens'];\n\n  #allDetectedTokens: TokensControllerState['allDetectedTokens'];\n\n  /**\n   * Construct a Token Balances Controller.\n   *\n   * @param options - The controller options.\n   * @param options.interval - Polling interval used to fetch new token balances.\n   * @param options.state - Initial state to set on this controller.\n   * @param options.messenger - The controller restricted messenger.\n   */\n  constructor({\n    interval = DEFAULT_INTERVAL,\n    messenger,\n    state = {},\n  }: TokenBalancesControllerOptions) {\n    super({\n      name: controllerName,\n      metadata,\n      messenger,\n      state: {\n        ...getDefaultTokenBalancesState(),\n        ...state,\n      },\n    });\n\n    this.setIntervalLength(interval);\n\n    // Set initial preference for querying multiple accounts, and subscribe to changes\n    this.#queryMultipleAccounts = this.#calculateQueryMultipleAccounts(\n      this.messagingSystem.call('PreferencesController:getState'),\n    );\n    this.messagingSystem.subscribe(\n      'PreferencesController:stateChange',\n      this.#onPreferencesStateChange.bind(this),\n    );\n\n    // Set initial tokens, and subscribe to changes\n    ({\n      allTokens: this.#allTokens,\n      allDetectedTokens: this.#allDetectedTokens,\n    } = this.messagingSystem.call('TokensController:getState'));\n\n    this.messagingSystem.subscribe(\n      'TokensController:stateChange',\n      this.#onTokensStateChange.bind(this),\n    );\n\n    // Subscribe to network state changes\n    this.messagingSystem.subscribe(\n      'NetworkController:stateChange',\n      this.#onNetworkStateChange.bind(this),\n    );\n  }\n\n  /**\n   * Determines whether to query all accounts, or just the selected account.\n   * @param preferences - The preferences state.\n   * @param preferences.isMultiAccountBalancesEnabled - whether to query all accounts (mobile).\n   * @param preferences.useMultiAccountBalanceChecker - whether to query all accounts (extension).\n   * @returns true if all accounts should be queried.\n   */\n  #calculateQueryMultipleAccounts = ({\n    isMultiAccountBalancesEnabled,\n    useMultiAccountBalanceChecker,\n  }: PreferencesState & { useMultiAccountBalanceChecker?: boolean }) => {\n    return Boolean(\n      // Note: These settings have different names on extension vs mobile\n      isMultiAccountBalancesEnabled || useMultiAccountBalanceChecker,\n    );\n  };\n\n  /**\n   * Handles the event for preferences state changes.\n   * @param preferences - The preferences state.\n   */\n  #onPreferencesStateChange = (preferences: PreferencesState) => {\n    // Update the user preference for whether to query multiple accounts.\n    const queryMultipleAccounts =\n      this.#calculateQueryMultipleAccounts(preferences);\n\n    // Refresh when flipped off -> on\n    const refresh = queryMultipleAccounts && !this.#queryMultipleAccounts;\n    this.#queryMultipleAccounts = queryMultipleAccounts;\n\n    if (refresh) {\n      this.updateBalances().catch(console.error);\n    }\n  };\n\n  /**\n   * Handles the event for tokens state changes.\n   * @param state - The token state.\n   * @param state.allTokens - The state for imported tokens across all chains.\n   * @param state.allDetectedTokens - The state for detected tokens across all chains.\n   */\n  #onTokensStateChange = ({\n    allTokens,\n    allDetectedTokens,\n  }: TokensControllerState) => {\n    // Refresh token balances on chains whose tokens have changed.\n    const chainIds = this.#getChainIds(allTokens, allDetectedTokens);\n    const chainIdsToUpdate = chainIds.filter(\n      (chainId) =>\n        !isEqual(this.#allTokens[chainId], allTokens[chainId]) ||\n        !isEqual(this.#allDetectedTokens[chainId], allDetectedTokens[chainId]),\n    );\n\n    this.#allTokens = allTokens;\n    this.#allDetectedTokens = allDetectedTokens;\n\n    this.updateBalances({ chainIds: chainIdsToUpdate }).catch(console.error);\n  };\n\n  /**\n   * Handles the event for network state changes.\n   * @param _ - The network state.\n   * @param patches - An array of patch operations performed on the network state.\n   */\n  #onNetworkStateChange(_: NetworkState, patches: Patch[]) {\n    // Remove state for deleted networks\n    for (const patch of patches) {\n      if (\n        patch.op === 'remove' &&\n        patch.path[0] === 'networkConfigurationsByChainId'\n      ) {\n        const removedChainId = patch.path[1] as Hex;\n\n        this.update((state) => {\n          for (const accountAddress of Object.keys(state.tokenBalances)) {\n            delete state.tokenBalances[accountAddress as Hex][removedChainId];\n          }\n        });\n      }\n    }\n  }\n\n  /**\n   * Returns an array of chain ids that have tokens.\n   * @param allTokens - The state for imported tokens across all chains.\n   * @param allDetectedTokens - The state for detected tokens across all chains.\n   * @returns An array of chain ids that have tokens.\n   */\n  #getChainIds = (\n    allTokens: TokensControllerState['allTokens'],\n    allDetectedTokens: TokensControllerState['allDetectedTokens'],\n  ) =>\n    [\n      ...new Set([\n        ...Object.keys(allTokens),\n        ...Object.keys(allDetectedTokens),\n      ]),\n    ] as Hex[];\n\n  /**\n   * Polls for erc20 token balances.\n   * @param input - The input for the poll.\n   * @param input.chainId - The chain id to poll token balances on.\n   */\n  async _executePoll({ chainId }: TokenBalancesPollingInput) {\n    await this.updateBalancesByChainId({ chainId });\n  }\n\n  /**\n   * Updates the token balances for the given chain ids.\n   * @param input - The input for the update.\n   * @param input.chainIds - The chain ids to update token balances for.\n   * Or omitted to update all chains that contain tokens.\n   */\n  async updateBalances({ chainIds }: { chainIds?: Hex[] } = {}) {\n    chainIds ??= this.#getChainIds(this.#allTokens, this.#allDetectedTokens);\n\n    await Promise.allSettled(\n      chainIds.map((chainId) => this.updateBalancesByChainId({ chainId })),\n    );\n  }\n\n  /**\n   * Updates token balances for the given chain id.\n   * @param input - The input for the update.\n   * @param input.chainId - The chain id to update token balances on.\n   */\n  async updateBalancesByChainId({ chainId }: { chainId: Hex }) {\n    const { address: selectedAccountAddress } = this.messagingSystem.call(\n      'AccountsController:getSelectedAccount',\n    );\n\n    const isSelectedAccount = (accountAddress: string) =>\n      toChecksumHexAddress(accountAddress) ===\n      toChecksumHexAddress(selectedAccountAddress);\n\n    const accountTokenPairs: { accountAddress: Hex; tokenAddress: Hex }[] = [];\n\n    const addTokens = ([accountAddress, tokens]: [string, Token[]]) =>\n      this.#queryMultipleAccounts || isSelectedAccount(accountAddress)\n        ? tokens.forEach((t) =>\n            accountTokenPairs.push({\n              accountAddress: accountAddress as Hex,\n              tokenAddress: t.address as Hex,\n            }),\n          )\n        : undefined;\n\n    // Balances will be updated for both imported and detected tokens\n    Object.entries(this.#allTokens[chainId] ?? {}).forEach(addTokens);\n    Object.entries(this.#allDetectedTokens[chainId] ?? {}).forEach(addTokens);\n\n    let results: MulticallResult[] = [];\n\n    if (accountTokenPairs.length > 0) {\n      const provider = new Web3Provider(\n        this.#getNetworkClient(chainId).provider,\n      );\n\n      const calls = accountTokenPairs.map(\n        ({ accountAddress, tokenAddress }) => ({\n          contract: new Contract(tokenAddress, abiERC20, provider),\n          functionSignature: 'balanceOf(address)',\n          arguments: [accountAddress],\n        }),\n      );\n\n      results = await multicallOrFallback(calls, chainId, provider);\n    }\n\n    this.update((state) => {\n      // Reset so that when accounts or tokens are removed,\n      // their balances are removed rather than left stale.\n      for (const accountAddress of Object.keys(state.tokenBalances)) {\n        state.tokenBalances[accountAddress as Hex][chainId] = {};\n      }\n\n      for (let i = 0; i < results.length; i++) {\n        const { success, value } = results[i];\n        const { accountAddress, tokenAddress } = accountTokenPairs[i];\n\n        if (success) {\n          ((state.tokenBalances[accountAddress] ??= {})[chainId] ??= {})[\n            tokenAddress\n          ] = toHex(value as BN);\n        }\n      }\n    });\n  }\n\n  /**\n   * Reset the controller state to the default state.\n   */\n  resetState() {\n    this.update(() => {\n      return getDefaultTokenBalancesState();\n    });\n  }\n\n  /**\n   * Returns the network client for a given chain id\n   * @param chainId - The chain id to get the network client for.\n   * @returns The network client for the given chain id.\n   */\n  #getNetworkClient(chainId: Hex) {\n    const { networkConfigurationsByChainId } = this.messagingSystem.call(\n      'NetworkController:getState',\n    );\n\n    const networkConfiguration = networkConfigurationsByChainId[chainId];\n    if (!networkConfiguration) {\n      throw new Error(\n        `TokenBalancesController: No network configuration found for chainId ${chainId}`,\n      );\n    }\n\n    const { networkClientId } =\n      networkConfiguration.rpcEndpoints[\n        networkConfiguration.defaultRpcEndpointIndex\n      ];\n\n    return this.messagingSystem.call(\n      `NetworkController:getNetworkClientById`,\n      networkClientId,\n    );\n  }\n}\n\nexport default TokenBalancesController;\n"]}
+{"version":3,"file":"TokenBalancesController.mjs","sourceRoot":"","sources":["../src/TokenBalancesController.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,OAAO,EAAE,QAAQ,EAAE,iCAAiC;AACpD,OAAO,EAAE,YAAY,EAAE,iCAAiC;AAUxD,OAAO,EAAE,oBAAoB,EAAE,KAAK,EAAE,mCAAmC;AACzE,OAAO,EAAE,QAAQ,EAAE,oCAAoC;AAOvD,OAAO,EAAE,+BAA+B,EAAE,qCAAqC;;;AAY/E,OAAO,EAAE,mBAAmB,EAAE,wBAAoB;AAQlD,MAAM,gBAAgB,GAAG,MAAM,CAAC;AAEhC,MAAM,cAAc,GAAG,yBAAyB,CAAC;AAEjD,MAAM,QAAQ,GAAG;IACf,aAAa,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,KAAK,EAAE;CACnD,CAAC;AAiEF;;;;GAIG;AACH,MAAM,UAAU,4BAA4B;IAC1C,OAAO;QACL,aAAa,EAAE,EAAE;KAClB,CAAC;AACJ,CAAC;AAOD;;;GAGG;AACH,MAAM,OAAO,uBAAwB,SAAQ,+BAA+B,EAI3E;IAOC;;;;;;;OAOG;IACH,YAAY,EACV,QAAQ,GAAG,gBAAgB,EAC3B,SAAS,EACT,KAAK,GAAG,EAAE,GACqB;;QAC/B,KAAK,CAAC;YACJ,IAAI,EAAE,cAAc;YACpB,QAAQ;YACR,SAAS;YACT,KAAK,EAAE;gBACL,GAAG,4BAA4B,EAAE;gBACjC,GAAG,KAAK;aACT;SACF,CAAC,CAAC;;QA3BL,iEAAgC;QAEhC,qDAA+C;QAE/C,6DAA+D;QA8D/D;;;;;;WAMG;QACH,kEAAkC,CAAC,EACjC,6BAA6B,EAC7B,6BAA6B,GACkC,EAAE,EAAE;YACnE,OAAO,OAAO;YACZ,mEAAmE;YACnE,6BAA6B,IAAI,6BAA6B,CAC/D,CAAC;QACJ,CAAC,EAAC;QAEF;;;WAGG;QACH,4DAA4B,CAAC,WAA6B,EAAE,EAAE;YAC5D,qEAAqE;YACrE,MAAM,qBAAqB,GACzB,uBAAA,IAAI,+DAAgC,MAApC,IAAI,EAAiC,WAAW,CAAC,CAAC;YAEpD,iCAAiC;YACjC,MAAM,OAAO,GAAG,qBAAqB,IAAI,CAAC,uBAAA,IAAI,sDAAuB,CAAC;YACtE,uBAAA,IAAI,kDAA0B,qBAAqB,MAAA,CAAC;YAEpD,IAAI,OAAO,EAAE;gBACX,IAAI,CAAC,cAAc,EAAE,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;aAC5C;QACH,CAAC,EAAC;QAEF;;;;;WAKG;QACH,uDAAuB,CAAC,EACtB,SAAS,EACT,iBAAiB,GACK,EAAE,EAAE;YAC1B,8DAA8D;YAC9D,MAAM,QAAQ,GAAG,uBAAA,IAAI,4CAAa,MAAjB,IAAI,EAAc,SAAS,EAAE,iBAAiB,CAAC,CAAC;YACjE,MAAM,gBAAgB,GAAG,QAAQ,CAAC,MAAM,CACtC,CAAC,OAAO,EAAE,EAAE,CACV,CAAC,OAAO,CAAC,uBAAA,IAAI,0CAAW,CAAC,OAAO,CAAC,EAAE,SAAS,CAAC,OAAO,CAAC,CAAC;gBACtD,CAAC,OAAO,CAAC,uBAAA,IAAI,kDAAmB,CAAC,OAAO,CAAC,EAAE,iBAAiB,CAAC,OAAO,CAAC,CAAC,CACzE,CAAC;YAEF,uBAAA,IAAI,sCAAc,SAAS,MAAA,CAAC;YAC5B,uBAAA,IAAI,8CAAsB,iBAAiB,MAAA,CAAC;YAC5C,IAAI,CAAC,cAAc,CAAC,EAAE,QAAQ,EAAE,gBAAgB,EAAE,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;QAC3E,CAAC,EAAC;QAoCF;;;;;WAKG;QACH,+CAAe,CACb,SAA6C,EAC7C,iBAA6D,EAC7D,EAAE,CACF;YACE,GAAG,IAAI,GAAG,CAAC;gBACT,GAAG,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC;gBACzB,GAAG,MAAM,CAAC,IAAI,CAAC,iBAAiB,CAAC;aAClC,CAAC;SACM,EAAC;QAhJX,IAAI,CAAC,iBAAiB,CAAC,QAAQ,CAAC,CAAC;QAEjC,kFAAkF;QAClF,uBAAA,IAAI,kDAA0B,uBAAA,IAAI,+DAAgC,MAApC,IAAI,EAChC,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,gCAAgC,CAAC,CAC5D,MAAA,CAAC;QACF,IAAI,CAAC,eAAe,CAAC,SAAS,CAC5B,mCAAmC,EACnC,uBAAA,IAAI,yDAA0B,CAAC,IAAI,CAAC,IAAI,CAAC,CAC1C,CAAC;QAEF,+CAA+C;QAC/C,MACa,IAAI,OACI,IAAI,EAFxB;YACC,SAAS,wGAAiB;YAC1B,iBAAiB,gHAAyB;SAC3C,GAAG,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,2BAA2B,CAAC,CAAC,CAAC;QAE5D,IAAI,CAAC,eAAe,CAAC,SAAS,CAC5B,8BAA8B,EAC9B,uBAAA,IAAI,oDAAqB,CAAC,IAAI,CAAC,IAAI,CAAC,CACrC,CAAC;QAEF,qCAAqC;QACrC,IAAI,CAAC,eAAe,CAAC,SAAS,CAC5B,+BAA+B,EAC/B,uBAAA,IAAI,yFAAsB,CAAC,IAAI,CAAC,IAAI,CAAC,CACtC,CAAC;QAEF,+DAA+D;QAE/D,IAAI,CAAC,eAAe,CAAC,SAAS,CAC5B,mCAAmC,EACnC,CAAC,cAAsB,EAAE,EAAE,CACzB,uBAAA,IAAI,2FAAwB,MAA5B,IAAI,EAAyB,cAAqB,CAAC,CACtD,CAAC;IACJ,CAAC;IA+GD;;;;OAIG;IACH,KAAK,CAAC,YAAY,CAAC,EAAE,OAAO,EAA6B;QACvD,MAAM,IAAI,CAAC,uBAAuB,CAAC,EAAE,OAAO,EAAE,CAAC,CAAC;IAClD,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,cAAc,CAAC,EAAE,QAAQ,KAA2B,EAAE;QAC1D,QAAQ,KAAR,QAAQ,GAAK,uBAAA,IAAI,4CAAa,MAAjB,IAAI,EAAc,uBAAA,IAAI,0CAAW,EAAE,uBAAA,IAAI,kDAAmB,CAAC,EAAC;QAEzE,MAAM,OAAO,CAAC,UAAU,CACtB,QAAQ,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,IAAI,CAAC,uBAAuB,CAAC,EAAE,OAAO,EAAE,CAAC,CAAC,CACrE,CAAC;IACJ,CAAC;IAmCD;;;;OAIG;IACH,KAAK,CAAC,uBAAuB,CAAC,EAAE,OAAO,EAAoB;QACzD,MAAM,EAAE,OAAO,EAAE,sBAAsB,EAAE,GAAG,IAAI,CAAC,eAAe,CAAC,IAAI,CACnE,uCAAuC,CACxC,CAAC;QAEF,MAAM,iBAAiB,GAAG,CAAC,cAAsB,EAAE,EAAE,CACnD,oBAAoB,CAAC,cAAc,CAAC;YACpC,oBAAoB,CAAC,sBAAsB,CAAC,CAAC;QAE/C,MAAM,iBAAiB,GAAiD,EAAE,CAAC;QAE3E,MAAM,SAAS,GAAG,CAAC,CAAC,cAAc,EAAE,MAAM,CAAoB,EAAE,EAAE,CAChE,uBAAA,IAAI,sDAAuB,IAAI,iBAAiB,CAAC,cAAc,CAAC;YAC9D,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE,CACnB,iBAAiB,CAAC,IAAI,CAAC;gBACrB,cAAc,EAAE,cAAqB;gBACrC,YAAY,EAAE,CAAC,CAAC,OAAc;aAC/B,CAAC,CACH;YACH,CAAC,CAAC,SAAS,CAAC;QAEhB,iEAAiE;QACjE,MAAM,CAAC,OAAO,CAAC,uBAAA,IAAI,0CAAW,CAAC,OAAO,CAAC,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;QAClE,MAAM,CAAC,OAAO,CAAC,uBAAA,IAAI,kDAAmB,CAAC,OAAO,CAAC,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;QAE1E,IAAI,OAAO,GAAsB,EAAE,CAAC;QAEpC,yHAAyH;QACzH,uBAAA,IAAI,gGAA6B,MAAjC,IAAI,EAA8B,iBAAiB,EAAE,OAAO,CAAC,CAAC;QAC9D,MAAM,oBAAoB,GAAG,IAAI,CAAC,eAAe,CAAC,IAAI,CACpD,kCAAkC,CACnC,CAAC;QAEF,IAAI,iBAAiB,CAAC,MAAM,GAAG,CAAC,EAAE;YAChC,MAAM,QAAQ,GAAG,IAAI,YAAY,CAC/B,uBAAA,IAAI,qFAAkB,MAAtB,IAAI,EAAmB,OAAO,CAAC,CAAC,QAAQ,CACzC,CAAC;YAEF,MAAM,KAAK,GAAG,iBAAiB,CAAC,GAAG,CACjC,CAAC,EAAE,cAAc,EAAE,YAAY,EAAE,EAAE,EAAE,CAAC,CAAC;gBACrC,QAAQ,EAAE,IAAI,QAAQ,CAAC,YAAY,EAAE,QAAQ,EAAE,QAAQ,CAAC;gBACxD,iBAAiB,EAAE,oBAAoB;gBACvC,SAAS,EAAE,CAAC,cAAc,CAAC;aAC5B,CAAC,CACH,CAAC;YAEF,OAAO,GAAG,MAAM,mBAAmB,CAAC,KAAK,EAAE,OAAO,EAAE,QAAQ,CAAC,CAAC;SAC/D;QAED,MAAM,cAAc,GAEb,CAAC,GAAG,OAAO,CAAC,CAAC;QAEpB,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE;YACvC,MAAM,EAAE,KAAK,EAAE,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC;YAC7B,MAAM,EAAE,cAAc,EAAE,YAAY,EAAE,GAAG,iBAAiB,CAAC,CAAC,CAAC,CAAC;YAC9D,MAAM,kCAAkC,GACtC,oBAAoB,CAAC,aAAa,EAAE,CAAC,cAAc,CAAC,EAAE,CAAC,OAAO,CAAC,EAAE,CAC/D,YAAY,CACb,CAAC;YACJ,MAAM,0BAA0B,GAC9B,kCAAkC,KAAK,KAAK,CAAC,KAAW,CAAC,CAAC;YAC5D,cAAc,CAAC,CAAC,CAAC,GAAG;gBAClB,GAAG,OAAO,CAAC,CAAC,CAAC;gBACb,0BAA0B;aAC3B,CAAC;SACH;QAED,gEAAgE;QAChE,IAAI,cAAc,CAAC,KAAK,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,MAAM,CAAC,0BAA0B,CAAC,EAAE;YACxE,OAAO;SACR;QAED,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;;YACpB,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,cAAc,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE;gBAC9C,MAAM,EAAE,OAAO,EAAE,KAAK,EAAE,0BAA0B,EAAE,GAClD,cAAc,CAAC,CAAC,CAAC,CAAC;gBACpB,MAAM,EAAE,cAAc,EAAE,YAAY,EAAE,GAAG,iBAAiB,CAAC,CAAC,CAAC,CAAC;gBAC9D,IAAI,OAAO,IAAI,0BAA0B,EAAE;oBACzC,OAAC,OAAC,KAAK,CAAC,aAAa,EAAC,cAAc,SAAd,cAAc,IAAM,EAAE,EAAC,EAAC,OAAO,SAAP,OAAO,IAAM,EAAE,EAAC,CAC5D,YAAY,CACb,GAAG,KAAK,CAAC,KAAW,CAAC,CAAC;iBACxB;aACF;QACH,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACH,UAAU;QACR,IAAI,CAAC,MAAM,CAAC,GAAG,EAAE;YACf,OAAO,4BAA4B,EAAE,CAAC;QACxC,CAAC,CAAC,CAAC;IACL,CAAC;CA6BF;2kBAtOuB,CAAe,EAAE,OAAgB;IACrD,oCAAoC;IACpC,KAAK,MAAM,KAAK,IAAI,OAAO,EAAE;QAC3B,IACE,KAAK,CAAC,EAAE,KAAK,QAAQ;YACrB,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,gCAAgC,EAClD;YACA,MAAM,cAAc,GAAG,KAAK,CAAC,IAAI,CAAC,CAAC,CAAQ,CAAC;YAE5C,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;gBACpB,KAAK,MAAM,cAAc,IAAI,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,aAAa,CAAC,EAAE;oBAC7D,OAAO,KAAK,CAAC,aAAa,CAAC,cAAqB,CAAC,CAAC,cAAc,CAAC,CAAC;iBACnE;YACH,CAAC,CAAC,CAAC;SACJ;KACF;AACH,CAAC,6GAOuB,cAAmB;IACzC,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;QACpB,OAAO,KAAK,CAAC,aAAa,CAAC,cAAc,CAAC,CAAC;IAC7C,CAAC,CAAC,CAAC;AACL,CAAC,uHA2CC,iBAA+D,EAC/D,OAAY;IAEZ,kCAAkC;IAClC,MAAM,oBAAoB,GAAG,IAAI,CAAC,eAAe,CAAC,IAAI,CACpD,kCAAkC,CACnC,CAAC;IAEF,yHAAyH;IACzH,oKAAoK;IACpK,8CAA8C;IAC9C,KAAK,MAAM,cAAc,IAAI,MAAM,CAAC,IAAI,CACtC,oBAAoB,CAAC,aAAa,CACnC,EAAE;QACD,KAAK,MAAM,YAAY,IAAI,MAAM,CAAC,IAAI,CACpC,oBAAoB,CAAC,aAAa,CAAC,cAA+B,CAAC,CACjE,OAAO,CACR,CACF,EAAE;YACD,IACE,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,YAAY,KAAK,YAAY,CAAC,EACrE;gBACA,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;oBACpB,OAAO,KAAK,CAAC,aAAa,CAAC,cAAqB,CAAC,CAAC,OAAc,CAAC,CAC/D,YAA6B,CAC9B,CAAC;gBACJ,CAAC,CAAC,CAAC;aACJ;SACF;KACF;AACH,CAAC,iGA4GiB,OAAY;IAC5B,MAAM,EAAE,8BAA8B,EAAE,GAAG,IAAI,CAAC,eAAe,CAAC,IAAI,CAClE,4BAA4B,CAC7B,CAAC;IAEF,MAAM,oBAAoB,GAAG,8BAA8B,CAAC,OAAO,CAAC,CAAC;IACrE,IAAI,CAAC,oBAAoB,EAAE;QACzB,MAAM,IAAI,KAAK,CACb,uEAAuE,OAAO,EAAE,CACjF,CAAC;KACH;IAED,MAAM,EAAE,eAAe,EAAE,GACvB,oBAAoB,CAAC,YAAY,CAC/B,oBAAoB,CAAC,uBAAuB,CAC7C,CAAC;IAEJ,OAAO,IAAI,CAAC,eAAe,CAAC,IAAI,CAC9B,wCAAwC,EACxC,eAAe,CAChB,CAAC;AACJ,CAAC;AAGH,eAAe,uBAAuB,CAAC","sourcesContent":["import { Contract } from '@ethersproject/contracts';\nimport { Web3Provider } from '@ethersproject/providers';\nimport type {\n  AccountsControllerAccountRemovedEvent,\n  AccountsControllerGetSelectedAccountAction,\n} from '@metamask/accounts-controller';\nimport type {\n  RestrictedMessenger,\n  ControllerGetStateAction,\n  ControllerStateChangeEvent,\n} from '@metamask/base-controller';\nimport { toChecksumHexAddress, toHex } from '@metamask/controller-utils';\nimport { abiERC20 } from '@metamask/metamask-eth-abis';\nimport type {\n  NetworkControllerGetNetworkClientByIdAction,\n  NetworkControllerGetStateAction,\n  NetworkControllerStateChangeEvent,\n  NetworkState,\n} from '@metamask/network-controller';\nimport { StaticIntervalPollingController } from '@metamask/polling-controller';\nimport type {\n  PreferencesControllerGetStateAction,\n  PreferencesControllerStateChangeEvent,\n  PreferencesState,\n} from '@metamask/preferences-controller';\nimport type { Hex } from '@metamask/utils';\nimport type BN from 'bn.js';\nimport type { Patch } from 'immer';\nimport { isEqual } from 'lodash';\n\nimport type { MulticallResult } from './multicall';\nimport { multicallOrFallback } from './multicall';\nimport type { Token } from './TokenRatesController';\nimport type {\n  TokensControllerGetStateAction,\n  TokensControllerState,\n  TokensControllerStateChangeEvent,\n} from './TokensController';\n\nconst DEFAULT_INTERVAL = 180000;\n\nconst controllerName = 'TokenBalancesController';\n\nconst metadata = {\n  tokenBalances: { persist: true, anonymous: false },\n};\n\n/**\n * Token balances controller options\n * @property interval - Polling interval used to fetch new token balances.\n * @property messenger - A messenger.\n * @property state - Initial state for the controller.\n */\ntype TokenBalancesControllerOptions = {\n  interval?: number;\n  messenger: TokenBalancesControllerMessenger;\n  state?: Partial<TokenBalancesControllerState>;\n};\n\n/**\n * A mapping from account address to chain id to token address to balance.\n */\ntype TokenBalances = Record<Hex, Record<Hex, Record<Hex, Hex>>>;\n\n/**\n * Token balances controller state\n * @property tokenBalances - A mapping from account address to chain id to token address to balance.\n */\nexport type TokenBalancesControllerState = {\n  tokenBalances: TokenBalances;\n};\n\nexport type TokenBalancesControllerGetStateAction = ControllerGetStateAction<\n  typeof controllerName,\n  TokenBalancesControllerState\n>;\n\nexport type TokenBalancesControllerActions =\n  TokenBalancesControllerGetStateAction;\n\nexport type AllowedActions =\n  | NetworkControllerGetNetworkClientByIdAction\n  | NetworkControllerGetStateAction\n  | TokensControllerGetStateAction\n  | PreferencesControllerGetStateAction\n  | AccountsControllerGetSelectedAccountAction;\n\nexport type TokenBalancesControllerStateChangeEvent =\n  ControllerStateChangeEvent<\n    typeof controllerName,\n    TokenBalancesControllerState\n  >;\n\nexport type TokenBalancesControllerEvents =\n  TokenBalancesControllerStateChangeEvent;\n\nexport type AllowedEvents =\n  | TokensControllerStateChangeEvent\n  | PreferencesControllerStateChangeEvent\n  | NetworkControllerStateChangeEvent\n  | AccountsControllerAccountRemovedEvent;\n\nexport type TokenBalancesControllerMessenger = RestrictedMessenger<\n  typeof controllerName,\n  TokenBalancesControllerActions | AllowedActions,\n  TokenBalancesControllerEvents | AllowedEvents,\n  AllowedActions['type'],\n  AllowedEvents['type']\n>;\n\n/**\n * Get the default TokenBalancesController state.\n *\n * @returns The default TokenBalancesController state.\n */\nexport function getDefaultTokenBalancesState(): TokenBalancesControllerState {\n  return {\n    tokenBalances: {},\n  };\n}\n\n/** The input to start polling for the {@link TokenBalancesController} */\nexport type TokenBalancesPollingInput = {\n  chainId: Hex;\n};\n\n/**\n * Controller that passively polls on a set interval token balances\n * for tokens stored in the TokensController\n */\nexport class TokenBalancesController extends StaticIntervalPollingController<TokenBalancesPollingInput>()<\n  typeof controllerName,\n  TokenBalancesControllerState,\n  TokenBalancesControllerMessenger\n> {\n  #queryMultipleAccounts: boolean;\n\n  #allTokens: TokensControllerState['allTokens'];\n\n  #allDetectedTokens: TokensControllerState['allDetectedTokens'];\n\n  /**\n   * Construct a Token Balances Controller.\n   *\n   * @param options - The controller options.\n   * @param options.interval - Polling interval used to fetch new token balances.\n   * @param options.state - Initial state to set on this controller.\n   * @param options.messenger - The controller restricted messenger.\n   */\n  constructor({\n    interval = DEFAULT_INTERVAL,\n    messenger,\n    state = {},\n  }: TokenBalancesControllerOptions) {\n    super({\n      name: controllerName,\n      metadata,\n      messenger,\n      state: {\n        ...getDefaultTokenBalancesState(),\n        ...state,\n      },\n    });\n\n    this.setIntervalLength(interval);\n\n    // Set initial preference for querying multiple accounts, and subscribe to changes\n    this.#queryMultipleAccounts = this.#calculateQueryMultipleAccounts(\n      this.messagingSystem.call('PreferencesController:getState'),\n    );\n    this.messagingSystem.subscribe(\n      'PreferencesController:stateChange',\n      this.#onPreferencesStateChange.bind(this),\n    );\n\n    // Set initial tokens, and subscribe to changes\n    ({\n      allTokens: this.#allTokens,\n      allDetectedTokens: this.#allDetectedTokens,\n    } = this.messagingSystem.call('TokensController:getState'));\n\n    this.messagingSystem.subscribe(\n      'TokensController:stateChange',\n      this.#onTokensStateChange.bind(this),\n    );\n\n    // Subscribe to network state changes\n    this.messagingSystem.subscribe(\n      'NetworkController:stateChange',\n      this.#onNetworkStateChange.bind(this),\n    );\n\n    // subscribe to account removed event to cleanup stale balances\n\n    this.messagingSystem.subscribe(\n      'AccountsController:accountRemoved',\n      (accountAddress: string) =>\n        this.#handleOnAccountRemoved(accountAddress as Hex),\n    );\n  }\n\n  /**\n   * Determines whether to query all accounts, or just the selected account.\n   * @param preferences - The preferences state.\n   * @param preferences.isMultiAccountBalancesEnabled - whether to query all accounts (mobile).\n   * @param preferences.useMultiAccountBalanceChecker - whether to query all accounts (extension).\n   * @returns true if all accounts should be queried.\n   */\n  #calculateQueryMultipleAccounts = ({\n    isMultiAccountBalancesEnabled,\n    useMultiAccountBalanceChecker,\n  }: PreferencesState & { useMultiAccountBalanceChecker?: boolean }) => {\n    return Boolean(\n      // Note: These settings have different names on extension vs mobile\n      isMultiAccountBalancesEnabled || useMultiAccountBalanceChecker,\n    );\n  };\n\n  /**\n   * Handles the event for preferences state changes.\n   * @param preferences - The preferences state.\n   */\n  #onPreferencesStateChange = (preferences: PreferencesState) => {\n    // Update the user preference for whether to query multiple accounts.\n    const queryMultipleAccounts =\n      this.#calculateQueryMultipleAccounts(preferences);\n\n    // Refresh when flipped off -> on\n    const refresh = queryMultipleAccounts && !this.#queryMultipleAccounts;\n    this.#queryMultipleAccounts = queryMultipleAccounts;\n\n    if (refresh) {\n      this.updateBalances().catch(console.error);\n    }\n  };\n\n  /**\n   * Handles the event for tokens state changes.\n   * @param state - The token state.\n   * @param state.allTokens - The state for imported tokens across all chains.\n   * @param state.allDetectedTokens - The state for detected tokens across all chains.\n   */\n  #onTokensStateChange = ({\n    allTokens,\n    allDetectedTokens,\n  }: TokensControllerState) => {\n    // Refresh token balances on chains whose tokens have changed.\n    const chainIds = this.#getChainIds(allTokens, allDetectedTokens);\n    const chainIdsToUpdate = chainIds.filter(\n      (chainId) =>\n        !isEqual(this.#allTokens[chainId], allTokens[chainId]) ||\n        !isEqual(this.#allDetectedTokens[chainId], allDetectedTokens[chainId]),\n    );\n\n    this.#allTokens = allTokens;\n    this.#allDetectedTokens = allDetectedTokens;\n    this.updateBalances({ chainIds: chainIdsToUpdate }).catch(console.error);\n  };\n\n  /**\n   * Handles the event for network state changes.\n   * @param _ - The network state.\n   * @param patches - An array of patch operations performed on the network state.\n   */\n  #onNetworkStateChange(_: NetworkState, patches: Patch[]) {\n    // Remove state for deleted networks\n    for (const patch of patches) {\n      if (\n        patch.op === 'remove' &&\n        patch.path[0] === 'networkConfigurationsByChainId'\n      ) {\n        const removedChainId = patch.path[1] as Hex;\n\n        this.update((state) => {\n          for (const accountAddress of Object.keys(state.tokenBalances)) {\n            delete state.tokenBalances[accountAddress as Hex][removedChainId];\n          }\n        });\n      }\n    }\n  }\n\n  /**\n   * Handles changes when an account has been removed.\n   *\n   * @param accountAddress - The account address being removed.\n   */\n  #handleOnAccountRemoved(accountAddress: Hex) {\n    this.update((state) => {\n      delete state.tokenBalances[accountAddress];\n    });\n  }\n\n  /**\n   * Returns an array of chain ids that have tokens.\n   * @param allTokens - The state for imported tokens across all chains.\n   * @param allDetectedTokens - The state for detected tokens across all chains.\n   * @returns An array of chain ids that have tokens.\n   */\n  #getChainIds = (\n    allTokens: TokensControllerState['allTokens'],\n    allDetectedTokens: TokensControllerState['allDetectedTokens'],\n  ) =>\n    [\n      ...new Set([\n        ...Object.keys(allTokens),\n        ...Object.keys(allDetectedTokens),\n      ]),\n    ] as Hex[];\n\n  /**\n   * Polls for erc20 token balances.\n   * @param input - The input for the poll.\n   * @param input.chainId - The chain id to poll token balances on.\n   */\n  async _executePoll({ chainId }: TokenBalancesPollingInput) {\n    await this.updateBalancesByChainId({ chainId });\n  }\n\n  /**\n   * Updates the token balances for the given chain ids.\n   * @param input - The input for the update.\n   * @param input.chainIds - The chain ids to update token balances for.\n   * Or omitted to update all chains that contain tokens.\n   */\n  async updateBalances({ chainIds }: { chainIds?: Hex[] } = {}) {\n    chainIds ??= this.#getChainIds(this.#allTokens, this.#allDetectedTokens);\n\n    await Promise.allSettled(\n      chainIds.map((chainId) => this.updateBalancesByChainId({ chainId })),\n    );\n  }\n\n  #cleanupCurrentTokenBalances(\n    accountTokenPairs: { accountAddress: Hex; tokenAddress: Hex }[],\n    chainId: Hex,\n  ) {\n    // TODO move this to a private fct\n    const currentTokenBalances = this.messagingSystem.call(\n      'TokenBalancesController:getState',\n    );\n\n    // in case currentTokenBalances has a token that is not in accountTokenPairs, we will remove it from currentTokenBalances\n    // loop through currentTokenBalances.tokenBalances, for each account loop though the account[chainId] array of tokens and check if the token is in accountTokenPairs\n    // if not, remove it from currentTokenBalances\n    for (const accountAddress of Object.keys(\n      currentTokenBalances.tokenBalances,\n    )) {\n      for (const tokenAddress of Object.keys(\n        currentTokenBalances.tokenBalances[accountAddress as `0x${string}`][\n          chainId\n        ],\n      )) {\n        if (\n          !accountTokenPairs.some((pair) => pair.tokenAddress === tokenAddress)\n        ) {\n          this.update((state) => {\n            delete state.tokenBalances[accountAddress as Hex][chainId as Hex][\n              tokenAddress as `0x${string}`\n            ];\n          });\n        }\n      }\n    }\n  }\n\n  /**\n   * Updates token balances for the given chain id.\n   * @param input - The input for the update.\n   * @param input.chainId - The chain id to update token balances on.\n   */\n  async updateBalancesByChainId({ chainId }: { chainId: Hex }) {\n    const { address: selectedAccountAddress } = this.messagingSystem.call(\n      'AccountsController:getSelectedAccount',\n    );\n\n    const isSelectedAccount = (accountAddress: string) =>\n      toChecksumHexAddress(accountAddress) ===\n      toChecksumHexAddress(selectedAccountAddress);\n\n    const accountTokenPairs: { accountAddress: Hex; tokenAddress: Hex }[] = [];\n\n    const addTokens = ([accountAddress, tokens]: [string, Token[]]) =>\n      this.#queryMultipleAccounts || isSelectedAccount(accountAddress)\n        ? tokens.forEach((t) =>\n            accountTokenPairs.push({\n              accountAddress: accountAddress as Hex,\n              tokenAddress: t.address as Hex,\n            }),\n          )\n        : undefined;\n\n    // Balances will be updated for both imported and detected tokens\n    Object.entries(this.#allTokens[chainId] ?? {}).forEach(addTokens);\n    Object.entries(this.#allDetectedTokens[chainId] ?? {}).forEach(addTokens);\n\n    let results: MulticallResult[] = [];\n\n    // in case currentTokenBalances has a token that is not in accountTokenPairs, we will remove it from currentTokenBalances\n    this.#cleanupCurrentTokenBalances(accountTokenPairs, chainId);\n    const currentTokenBalances = this.messagingSystem.call(\n      'TokenBalancesController:getState',\n    );\n\n    if (accountTokenPairs.length > 0) {\n      const provider = new Web3Provider(\n        this.#getNetworkClient(chainId).provider,\n      );\n\n      const calls = accountTokenPairs.map(\n        ({ accountAddress, tokenAddress }) => ({\n          contract: new Contract(tokenAddress, abiERC20, provider),\n          functionSignature: 'balanceOf(address)',\n          arguments: [accountAddress],\n        }),\n      );\n\n      results = await multicallOrFallback(calls, chainId, provider);\n    }\n\n    const updatedResults: (MulticallResult & {\n      isTokenBalanceValueChanged?: boolean;\n    })[] = [...results];\n\n    for (let i = 0; i < results.length; i++) {\n      const { value } = results[i];\n      const { accountAddress, tokenAddress } = accountTokenPairs[i];\n      const currentTokenBalanceValueForAccount =\n        currentTokenBalances.tokenBalances?.[accountAddress]?.[chainId]?.[\n          tokenAddress\n        ];\n      const isTokenBalanceValueChanged =\n        currentTokenBalanceValueForAccount !== toHex(value as BN);\n      updatedResults[i] = {\n        ...results[i],\n        isTokenBalanceValueChanged,\n      };\n    }\n\n    // if all values of isTokenBalanceValueChanged are false, return\n    if (updatedResults.every((result) => !result.isTokenBalanceValueChanged)) {\n      return;\n    }\n\n    this.update((state) => {\n      for (let i = 0; i < updatedResults.length; i++) {\n        const { success, value, isTokenBalanceValueChanged } =\n          updatedResults[i];\n        const { accountAddress, tokenAddress } = accountTokenPairs[i];\n        if (success && isTokenBalanceValueChanged) {\n          ((state.tokenBalances[accountAddress] ??= {})[chainId] ??= {})[\n            tokenAddress\n          ] = toHex(value as BN);\n        }\n      }\n    });\n  }\n\n  /**\n   * Reset the controller state to the default state.\n   */\n  resetState() {\n    this.update(() => {\n      return getDefaultTokenBalancesState();\n    });\n  }\n\n  /**\n   * Returns the network client for a given chain id\n   * @param chainId - The chain id to get the network client for.\n   * @returns The network client for the given chain id.\n   */\n  #getNetworkClient(chainId: Hex) {\n    const { networkConfigurationsByChainId } = this.messagingSystem.call(\n      'NetworkController:getState',\n    );\n\n    const networkConfiguration = networkConfigurationsByChainId[chainId];\n    if (!networkConfiguration) {\n      throw new Error(\n        `TokenBalancesController: No network configuration found for chainId ${chainId}`,\n      );\n    }\n\n    const { networkClientId } =\n      networkConfiguration.rpcEndpoints[\n        networkConfiguration.defaultRpcEndpointIndex\n      ];\n\n    return this.messagingSystem.call(\n      `NetworkController:getNetworkClientById`,\n      networkClientId,\n    );\n  }\n}\n\nexport default TokenBalancesController;\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@metamask-previews/assets-controllers",
-  "version": "60.0.0-preview-47d1bd5",
+  "version": "60.0.0-preview-5aa4d0a9",
   "description": "Controllers which manage interactions involving ERC-20, ERC-721, and ERC-1155 tokens (including NFTs)",
   "keywords": [
     "MetaMask",