chore: upgrade assets controllers v33.0.0 (#11800)

## **Description** PR to upgrade assets-controllers to v33.0.0 ## **Related issues** Fixes: ## **Manual testing steps** 1. Go to this page... 2. 3. ## **Screenshots/Recordings**  ### **Before**  ### **After** https://github.com/user-attachments/assets/e396e0c9-64a8-48bc-9f6a-ca793c7aa9fa  ## **Pre-merge author checklist** - [ ] I’ve followed [MetaMask Contributor Docs](https://github.com/MetaMask/contributor-docs) and [MetaMask Mobile Coding Standards](https://github.com/MetaMask/metamask-mobile/blob/main/.github/guidelines/CODING_GUIDELINES.md). - [ ] I've completed the PR template to the best of my ability - [ ] I’ve included tests if applicable - [ ] I’ve documented my code using [JSDoc](https://jsdoc.app/) format if applicable - [ ] I’ve applied the right labels on the PR (see [labeling guidelines](https://github.com/MetaMask/metamask-mobile/blob/main/.github/guidelines/LABELING_GUIDELINES.md)). Not required for external contributors. ## **Pre-merge reviewer checklist** - [ ] I've manually tested the PR (e.g. pull and build branch, run the app, test code being changed). - [ ] I confirm that this PR addresses all acceptance criteria described in the ticket it closes and includes the necessary testing evidence such as recordings and or screenshots.
MetaMask · Oct 18, 2024 · d663101 · d663101
1 parent 2ffb4aa
commit d663101
Show file tree

Hide file tree

Showing 13 changed files with 843 additions and 1,110 deletions.
diff --git a/app/components/UI/CollectibleContracts/index.test.tsx b/app/components/UI/CollectibleContracts/index.test.tsx
@@ -99,7 +99,7 @@ describe('CollectibleContracts', () => {
           AccountsController: MOCK_ACCOUNTS_CONTROLLER_STATE,
           NftController: {
             allNfts: {
-              [MOCK_ADDRESS]: {
+              [MOCK_ADDRESS.toLowerCase()]: {
                 '0x1': [
                   {
                     address: '0x72b1FDb6443338A158DeC2FbF411B71aeB157A42',
@@ -131,7 +131,7 @@ describe('CollectibleContracts', () => {
               },
             },
             allNftContracts: {
-              [MOCK_ADDRESS]: {
+              [MOCK_ADDRESS.toLowerCase()]: {
                 '0x1': [
                   {
                     address: '0x72b1FDb6443338A158DeC2FbF411B71aeB157A42',

diff --git a/app/core/Engine.ts b/app/core/Engine.ts
@@ -19,7 +19,7 @@ import {
   TokenListState,
   TokenListStateChange,
   TokenRatesController,
-  TokenRatesState,
+  TokenRatesControllerState,
   TokensController,
   TokensControllerState,
   CodefiTokenPricesServiceV2,
@@ -345,7 +345,7 @@ export interface EngineState {
   PreferencesController: PreferencesState;
   PhishingController: PhishingControllerState;
   TokenBalancesController: TokenBalancesControllerState;
-  TokenRatesController: TokenRatesState;
+  TokenRatesController: TokenRatesControllerState;
   TransactionController: TransactionControllerState;
   SmartTransactionsController: SmartTransactionsControllerState;
   SwapsController: SwapsState;
@@ -569,6 +569,33 @@ class Engine {
       getNetworkClientById:
         networkController.getNetworkClientById.bind(networkController),
     });
+    const accountsControllerMessenger: AccountsControllerMessenger =
+      this.controllerMessenger.getRestricted({
+        name: 'AccountsController',
+        allowedEvents: [
+          'SnapController:stateChange',
+          'KeyringController:accountRemoved',
+          'KeyringController:stateChange',
+        ],
+        allowedActions: [
+          'KeyringController:getAccounts',
+          'KeyringController:getKeyringsByType',
+          'KeyringController:getKeyringForAccount',
+        ],
+      });
+
+    const defaultAccountsControllerState: AccountsControllerState = {
+      internalAccounts: {
+        accounts: {},
+        selectedAccount: '',
+      },
+    };
+
+    const accountsController = new AccountsController({
+      messenger: accountsControllerMessenger,
+      state: initialState.AccountsController ?? defaultAccountsControllerState,
+    });
+
     const nftController = new NftController({
       chainId: networkController.getNetworkClientById(
         networkController?.state.selectedNetworkClientId,
@@ -580,10 +607,13 @@ class Engine {
         allowedActions: [
           `${approvalController.name}:addRequest`,
           `${networkController.name}:getNetworkClientById`,
+          'AccountsController:getAccount',
+          'AccountsController:getSelectedAccount',
         ],
         allowedEvents: [
           'PreferencesController:stateChange',
           'NetworkController:networkDidChange',
+          'AccountsController:selectedEvmAccountChange',
         ],
       }),
 
@@ -619,32 +649,6 @@ class Engine {
       }),
       state: initialState.LoggingController,
     });
-    const accountsControllerMessenger: AccountsControllerMessenger =
-      this.controllerMessenger.getRestricted({
-        name: 'AccountsController',
-        allowedEvents: [
-          'SnapController:stateChange',
-          'KeyringController:accountRemoved',
-          'KeyringController:stateChange',
-        ],
-        allowedActions: [
-          'KeyringController:getAccounts',
-          'KeyringController:getKeyringsByType',
-          'KeyringController:getKeyringForAccount',
-        ],
-      });
-
-    const defaultAccountsControllerState: AccountsControllerState = {
-      internalAccounts: {
-        accounts: {},
-        selectedAccount: '',
-      },
-    };
-
-    const accountsController = new AccountsController({
-      messenger: accountsControllerMessenger,
-      state: initialState.AccountsController ?? defaultAccountsControllerState,
-    });
     const tokensController = new TokensController({
       chainId: networkController.getNetworkClientById(
         networkController?.state.selectedNetworkClientId,
@@ -936,21 +940,34 @@ class Engine {
       ),
     });
 
-    const accountTrackerController = new AccountTrackerController({
-      onPreferencesStateChange,
-      getIdentities: () => preferencesController.state.identities,
-      getSelectedAddress: () => accountsController.getSelectedAccount().address,
-      getMultiAccountBalancesEnabled: () =>
-        preferencesController.state.isMultiAccountBalancesEnabled,
-      getCurrentChainId: () =>
-        toHexadecimal(
-          networkController.getNetworkClientById(
-            networkController?.state.selectedNetworkClientId,
-          ).configuration.chainId,
-        ),
-      getNetworkClientById:
-        networkController.getNetworkClientById.bind(networkController),
-    });
+    const accountTrackerController = new AccountTrackerController(
+      {
+        // @ts-expect-error TODO: Resolve mismatch between base-controller versions
+        messenger: this.controllerMessenger.getRestricted({
+          name: 'AccountTrackerController',
+          allowedActions: [
+            `AccountsController:getSelectedAccount`,
+            `AccountsController:listAccounts`,
+          ],
+          allowedEvents: [
+            'AccountsController:selectedEvmAccountChange',
+            'AccountsController:selectedAccountChange',
+          ],
+        }),
+        getMultiAccountBalancesEnabled: () =>
+          preferencesController.state.isMultiAccountBalancesEnabled,
+        getCurrentChainId: () =>
+          toHexadecimal(
+            networkController.getNetworkClientById(
+              networkController?.state.selectedNetworkClientId,
+            ).configuration.chainId,
+          ),
+        getNetworkClientById:
+          networkController.getNetworkClientById.bind(networkController),
+      },
+      undefined,
+      { accounts: {} },
+    );
     const permissionController = new PermissionController({
       // @ts-expect-error TODO: Resolve mismatch between base-controller versions.
       messenger: this.controllerMessenger.getRestricted({
@@ -1480,6 +1497,7 @@ class Engine {
             'NetworkController:getState',
             'NetworkController:getNetworkClientById',
             'PreferencesController:getState',
+            'AccountsController:getSelectedAccount',
           ],
         }),
         disabled: false,
@@ -1503,28 +1521,24 @@ class Engine {
         interval: 180000,
       }),
       new TokenRatesController({
-        onTokensStateChange: (listener) =>
-          this.controllerMessenger.subscribe(
-            `${tokensController.name}:stateChange`,
-            listener,
-          ),
-        onNetworkStateChange: (listener) =>
-          this.controllerMessenger.subscribe(
-            AppConstants.NETWORK_STATE_CHANGE_EVENT,
-            listener,
-          ),
-        onPreferencesStateChange,
-        chainId: networkController.getNetworkClientById(
-          networkController?.state.selectedNetworkClientId,
-        ).configuration.chainId,
-        ticker: networkController.getNetworkClientById(
-          networkController?.state.selectedNetworkClientId,
-        ).configuration.ticker,
-        selectedAddress: preferencesController.state.selectedAddress,
+        // @ts-expect-error TODO: Resolve mismatch between base-controller versions.
+        messenger: this.controllerMessenger.getRestricted({
+          name: 'TokenRatesController',
+          allowedActions: [
+            'TokensController:getState',
+            'NetworkController:getNetworkClientById',
+            'NetworkController:getState',
+            'PreferencesController:getState',
+          ],
+          allowedEvents: [
+            'PreferencesController:stateChange',
+            'TokensController:stateChange',
+            'NetworkController:stateChange',
+          ],
+        }),
         tokenPricesService: codefiTokenApiV2,
         interval: 30 * 60 * 1000,
-        getNetworkClientById:
-          networkController.getNetworkClientById.bind(networkController),
+        state: initialState.TokenRatesController || { marketData: {} },
       }),
       this.transactionController,
       this.smartTransactionsController,
@@ -1990,7 +2004,7 @@ class Engine {
     NftController.reset();
 
     TokenBalancesController.reset();
-    TokenRatesController.update({ marketData: {} });
+    TokenRatesController.reset();
 
     // eslint-disable-next-line @typescript-eslint/no-explicit-any
     (TransactionController as any).update(() => ({

diff --git a/app/core/EngineService/EngineService.ts b/app/core/EngineService/EngineService.ts
@@ -92,7 +92,7 @@ class EngineService {
         name: 'TokenBalancesController',
         key: `${engine.context.TokenBalancesController.name}:stateChange`,
       },
-      { name: 'TokenRatesController' },
+      { name: 'TokenRatesController', key: 'TokenRatesController:stateChange' },
       {
         name: 'TransactionController',
         key: `${engine.context.TransactionController.name}:stateChange`,

diff --git a/app/reducers/collectibles/index.js b/app/reducers/collectibles/index.js
@@ -4,7 +4,7 @@ import {
   selectAllNftContracts,
   selectAllNfts,
 } from '../../selectors/nftController';
-import { selectSelectedInternalAccountChecksummedAddress } from '../../selectors/accountsController';
+import { selectSelectedInternalAccountAddress } from '../../selectors/accountsController';
 import { compareTokenIds } from '../../util/tokens';
 import { createDeepEqualSelector } from '../../selectors/util';
 
@@ -14,22 +14,22 @@ export const isNftFetchingProgressSelector = (state) =>
   state.collectibles.isNftFetchingProgress;
 
 export const collectibleContractsSelector = createSelector(
-  selectSelectedInternalAccountChecksummedAddress,
+  selectSelectedInternalAccountAddress,
   selectChainId,
   selectAllNftContracts,
   (address, chainId, allNftContracts) =>
     allNftContracts[address]?.[chainId] || [],
 );
 
 export const collectiblesSelector = createDeepEqualSelector(
-  selectSelectedInternalAccountChecksummedAddress,
+  selectSelectedInternalAccountAddress,
   selectChainId,
   selectAllNfts,
   (address, chainId, allNfts) => allNfts[address]?.[chainId] || [],
 );
 
 export const favoritesCollectiblesSelector = createSelector(
-  selectSelectedInternalAccountChecksummedAddress,
+  selectSelectedInternalAccountAddress,
   selectChainId,
   favoritesSelector,
   (address, chainId, favorites) => favorites[address]?.[chainId] || [],

diff --git a/app/selectors/accountsController.ts b/app/selectors/accountsController.ts
@@ -69,3 +69,14 @@ export const selectSelectedInternalAccountChecksummedAddress = createSelector(
     return selectedAddress ? toChecksumHexAddress(selectedAddress) : undefined;
   },
 );
+
+/**
+ * A memoized selector that returns the selected internal account address
+ */
+export const selectSelectedInternalAccountAddress = createSelector(
+  selectSelectedInternalAccount,
+  (account) => {
+    const selectedAddress = account?.address;
+    return selectedAddress || undefined;
+  },
+);
diff --git a/app/selectors/tokenRatesController.ts b/app/selectors/tokenRatesController.ts
@@ -1,6 +1,6 @@
 /* eslint-disable import/prefer-default-export */
 import { createSelector } from 'reselect';
-import { TokenRatesState } from '@metamask/assets-controllers';
+import { TokenRatesControllerState } from '@metamask/assets-controllers';
 import { RootState } from '../reducers';
 import { selectChainId } from './networkController';
 import { Hex } from '@metamask/utils';
@@ -11,6 +11,6 @@ const selectTokenRatesControllerState = (state: RootState) =>
 export const selectContractExchangeRates = createSelector(
   selectChainId,
   selectTokenRatesControllerState,
-  (chainId: Hex, tokenRatesControllerState: TokenRatesState) =>
+  (chainId: Hex, tokenRatesControllerState: TokenRatesControllerState) =>
     tokenRatesControllerState.marketData[chainId],
 );
diff --git a/app/selectors/types.ts b/app/selectors/types.ts
@@ -5,7 +5,7 @@ import {
   NftControllerState,
   TokenDetectionController,
   TokenListState,
-  TokenRatesState,
+  TokenRatesControllerState,
   TokensControllerState,
   TokenBalancesControllerState,
 } from '@metamask/assets-controllers';
@@ -39,7 +39,7 @@ export interface EngineState {
       PhishingController: PhishingControllerState;
       PPOMController: PPOMState;
       TokenBalancesController: TokenBalancesControllerState;
-      TokenRatesController: TokenRatesState;
+      TokenRatesController: TokenRatesControllerState;
       TransactionController: TransactionControllerState;
       SwapsController: SwapsController;
       ///: BEGIN:ONLY_INCLUDE_IF(preinstalled-snaps,external-snaps)

diff --git a/app/store/migrations/029.ts b/app/store/migrations/029.ts
@@ -15,7 +15,7 @@ import {
   NftContract,
   NftControllerState,
   TokenListState,
-  TokenRatesState,
+  TokenRatesControllerState,
   TokensControllerState,
 } from '@metamask/assets-controllers';
 
@@ -530,7 +530,7 @@ export default async function migrate(stateAsync: unknown) {
   const tokenRatesControllerState =
     state?.engine?.backgroundState?.TokenRatesController;
   const newTokenRatesControllerState = state?.engine?.backgroundState
-    ?.TokenRatesController as TokenRatesState;
+    ?.TokenRatesController as TokenRatesControllerState;
 
   if (!isObject(tokenRatesControllerState)) {
     captureException(

diff --git a/app/store/migrations/031.ts b/app/store/migrations/031.ts
@@ -2,7 +2,7 @@ import { hasProperty, isObject } from '@metamask/utils';
 import { captureException } from '@sentry/react-native';
 import {
   TokenListState,
-  TokenRatesState,
+  TokenRatesControllerState,
   TokensControllerState,
 } from '@metamask/assets-controllers';
 import { toHex } from '@metamask/controller-utils';
@@ -105,7 +105,7 @@ export default async function migrate(stateAsync: unknown) {
   const tokenRatesControllerState =
     state?.engine?.backgroundState?.TokenRatesController;
   const newTokenRatesControllerState = state?.engine?.backgroundState
-    ?.TokenRatesController as TokenRatesState;
+    ?.TokenRatesController as TokenRatesControllerState;
 
   if (!isObject(tokenRatesControllerState)) {
     captureException(

diff --git a/package.json b/package.json
@@ -141,7 +141,7 @@
     "@metamask/accounts-controller": "^18.2.1",
     "@metamask/address-book-controller": "^6.0.1",
     "@metamask/approval-controller": "^7.0.1",
-    "@metamask/assets-controllers": "^32.0.0",
+    "@metamask/assets-controllers": "^33.0.0",
     "@metamask/base-controller": "^7.0.1",
     "@metamask/composable-controller": "^3.0.0",
     "@metamask/contract-metadata": "^2.1.0",