feat: integrate multichain assets rates controller to extension UI

Author: salimtb

app/scripts/constants/sentry-state.ts

@@ -105,6 +105,9 @@ export const SENTRY_BACKGROUND_STATE = {
     accountsAssets: false,
     assetsMetadata: false,
   },
+  MultichainAssetsRatesController: {
+    assetsRates: false,
+},
   BridgeController: {
     bridgeState: {
       bridgeFeatureFlags: {

app/scripts/metamask-controller.js

@@ -1075,6 +1075,32 @@ export default class MetamaskController extends EventEmitter {
       disabled: !this.preferencesController.state.useCurrencyRateCheck,
     });
 
+    ///: BEGIN:ONLY_INCLUDE_IF(build-flask)
+    const multichainAssetsRatesControllerMessenger =
+      this.controllerMessenger.getRestricted({
+        name: 'MultiChainAssetsRatesController',
+        allowedActions: [
+          'AccountsController:listMultichainAccounts',
+          'SnapController:handleRequest',
+          'CurrencyRateController:getState',
+          'MultichainAssetsController:getState',
+          'MultichainBalancesController:getState',
+        ],
+        allowedEvents: [
+          'AccountsController:accountAdded',
+          'KeyringController:lock',
+          'KeyringController:unlock',
+          'CurrencyRateController:stateChange',
+          'MultichainAssetsController:stateChange',
+        ],
+      });
+
+    this.multichainAssetsRatesController = new MultiChainAssetsRatesController({
+      messenger: multichainAssetsRatesControllerMessenger,
+      state: initState.MultiChainAssetsRatesController,
+    });
+    ///: END:ONLY_INCLUDE_IF
+
     this.controllerMessenger.subscribe(
       'PreferencesController:stateChange',
       previousValueComparator((prevState, currState) => {
@@ -2265,6 +2291,7 @@ export default class MetamaskController extends EventEmitter {
       MultichainAssetsController: this.multichainAssetsController,
       ///: BEGIN:ONLY_INCLUDE_IF(build-flask)
       MultichainTransactionsController: this.multichainTransactionsController,
+      MultiChainAssetsRatesController: this.multichainAssetsRatesController,
       ///: END:ONLY_INCLUDE_IF
       KeyringController: this.keyringController,
       PreferencesController: this.preferencesController,
@@ -2319,6 +2346,7 @@ export default class MetamaskController extends EventEmitter {
         MultichainAssetsController: this.multichainAssetsController,
         ///: BEGIN:ONLY_INCLUDE_IF(build-flask)
         MultichainTransactionsController: this.multichainTransactionsController,
+        MultiChainAssetsRatesController: this.multichainAssetsRatesController,
         ///: END:ONLY_INCLUDE_IF
         NetworkController: this.networkController,
         KeyringController: this.keyringController,
@@ -3009,6 +3037,9 @@ export default class MetamaskController extends EventEmitter {
       )
     ) {
       this.multichainRatesController.start();
+      ///: BEGIN:ONLY_INCLUDE_IF(build-flask)
+      this.multichainAssetsRatesController.startPolling();
+      ///: END:ONLY_INCLUDE_IF
     }
 
     this.controllerMessenger.subscribe(
@@ -4122,6 +4153,12 @@ export default class MetamaskController extends EventEmitter {
       multichainUpdateBalance: (accountId) =>
         this.multichainBalancesController.updateBalance(accountId),
 
+      ///: BEGIN:ONLY_INCLUDE_IF(build-flask)
+      // MultichainAssetsRatesController
+      multichainUpdateRates: () =>
+        this.multichainAssetsRatesController.updateAssetsRates(),
+      ///: END:ONLY_INCLUDE_IF
+
       // Transaction Decode
       decodeTransactionData: (request) =>
         decodeTransactionData({

test/e2e/tests/metrics/state-snapshots/errors-after-init-opt-in-background-state.json

@@ -147,6 +147,9 @@
     "accountsAssets": "object",
     "assetsMetadata": "object"
   },
+  "MultichainAssetsRatesController": {
+    "assetsRates": "object"
+  },
   "MultichainBalancesController": { "balances": "object" },
   "MultichainRatesController": {
     "fiatCurrency": "usd",

test/e2e/tests/metrics/state-snapshots/errors-after-init-opt-in-ui-state.json

@@ -294,6 +294,7 @@
     "accountsByChainId": "object",
     "accountsAssets": "object",
     "assetsMetadata": "object",
+    "assetsRates": "object",
     "marketData": "object",
     "unapprovedDecryptMsgs": "object",
     "unapprovedDecryptMsgCount": 0,

ui/selectors/multichain-assets-rates.test.ts

@@ -0,0 +1,32 @@
+import { getAssetsRates, AssetsState } from './multichain-assets-rates';
+
+// Mock state for testing
+const mockState = {
+  metamask: {
+    assetsRates: {
+      'token-1': { rate: 1.5, currency: 'USD' },
+      'token-2': { rate: 0.8, currency: 'EUR' },
+    },
+  },
+};
+describe('getAssetsRates', () => {
+  it('should return the assetsRates from the state', () => {
+    const result = getAssetsRates(mockState);
+    expect(result).toEqual(mockState.metamask.assetsRates);
+  });
+
+  it('should return an empty object if assetsRates is empty', () => {
+    const emptyState: AssetsState = {
+      metamask: {
+        assetsRates: {},
+      },
+    };
+    const result = getAssetsRates(emptyState);
+    expect(result).toEqual({});
+  });
+
+  it('should return undefined if state does not have metamask property', () => {
+    const invalidState = {} as AssetsState;
+    expect(() => getAssetsRates(invalidState)).toThrow();
+  });
+});

ui/selectors/multichain-assets-rates.ts

@@ -0,0 +1,15 @@
+import { MultichainAssetsRatesControllerState } from '@metamask/assets-controllers';
+
+export type AssetsState = {
+  metamask: MultichainAssetsRatesControllerState;
+};
+
+/**
+ * Gets non-EVM accounts assets.
+ *
+ * @param state - Redux state object.
+ * @returns An object containing non-EVM assets per accounts.
+ */
+export function getAssetsRates(state: AssetsState) {
+  return state.metamask.assetsRates;
+}