fix: integrate multichainAssetsRatesController

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/controller-init/messengers/index.ts

@@ -21,6 +21,7 @@ import {
   getMultichainBalancesControllerMessenger,
   getMultichainTransactionsControllerMessenger,
   getMultichainAssetsControllerMessenger,
+  getMultichainAssetsRatesControllerMessenger,
 } from './multichain';
 
 export const CONTROLLER_MESSENGERS = {
@@ -64,4 +65,7 @@ export const CONTROLLER_MESSENGERS = {
     getMessenger: getTransactionControllerMessenger,
     getInitMessenger: getTransactionControllerInitMessenger,
   },
+  MultichainAssetsRatesController: {
+    getMessenger: getMultichainAssetsRatesControllerMessenger,
+  },
 } as const;

app/scripts/controller-init/messengers/multichain/index.ts

@@ -5,3 +5,4 @@ export { getMultichainTransactionsControllerMessenger } from './multichain-trans
 export type { MultichainAssetsControllerMessenger } from './multichain-assets-controller-messenger';
 export type { MultichainBalancesControllerMessenger } from './multichain-balances-controller-messenger';
 export type { MultichainTransactionsControllerMessenger } from './multichain-transactions-controller-messenger';
+export type { MultichainAssetsRatesControllerMessenger } from './multichain-assets-rates-controller-messenger';

app/scripts/controller-init/messengers/multichain/multichain-assets-rates-controller-messenger.test.ts

@@ -0,0 +1,14 @@
+import { Messenger, RestrictedMessenger } from '@metamask/base-controller';
+import { getMultichainAssetsRatesControllerMessenger } from './multichain-assets-rates-controller-messenger';
+
+describe('getMultichainAssetsRatesControllerMessenger', () => {
+  it('returns a restricted messenger', () => {
+    const messenger = new Messenger<never, never>();
+    const multichainAssetsRatesControllerMessenger =
+      getMultichainAssetsRatesControllerMessenger(messenger);
+
+    expect(multichainAssetsRatesControllerMessenger).toBeInstanceOf(
+      RestrictedMessenger,
+    );
+  });
+});

app/scripts/controller-init/messengers/multichain/multichain-assets-rates-controller-messenger.ts

@@ -0,0 +1,59 @@
+import { Messenger } from '@metamask/base-controller';
+import {
+  AccountsControllerAccountAddedEvent,
+  AccountsControllerListMultichainAccountsAction,
+} from '@metamask/accounts-controller';
+import {
+  CurrencyRateStateChange,
+  GetCurrencyRateState,
+  MultichainAssetsControllerStateChangeEvent,
+} from '@metamask/assets-controllers';
+import { MultichainAssetsControllerGetStateAction } from '@metamask/assets-controllers';
+import { KeyringControllerLockEvent } from '@metamask/keyring-controller';
+import { KeyringControllerUnlockEvent } from '@metamask/keyring-controller';
+import { HandleSnapRequest } from '@metamask/snaps-controllers';
+
+type Actions =
+  | HandleSnapRequest
+  | AccountsControllerListMultichainAccountsAction
+  | GetCurrencyRateState
+  | MultichainAssetsControllerGetStateAction;
+
+type Events =
+  | KeyringControllerLockEvent
+  | KeyringControllerUnlockEvent
+  | AccountsControllerAccountAddedEvent
+  | CurrencyRateStateChange
+  | MultichainAssetsControllerStateChangeEvent;
+
+export type MultichainAssetsRatesControllerMessenger = ReturnType<
+  typeof getMultichainAssetsRatesControllerMessenger
+>;
+
+/**
+ * Get a restricted messenger for the Multichain Assets controller. This is scoped to the
+ * actions and events that the multichain Assets controller is allowed to handle.
+ *
+ * @param messenger - The controller messenger to restrict.
+ * @returns The restricted controller messenger.
+ */
+export function getMultichainAssetsRatesControllerMessenger(
+  messenger: Messenger<Actions, Events>,
+) {
+  return messenger.getRestricted({
+    name: 'MultiChainAssetsRatesController',
+    allowedEvents: [
+      'AccountsController:accountAdded',
+      'KeyringController:lock',
+      'KeyringController:unlock',
+      'CurrencyRateController:stateChange',
+      'MultichainAssetsController:stateChange',
+    ],
+    allowedActions: [
+      'AccountsController:listMultichainAccounts',
+      'SnapController:handleRequest',
+      'CurrencyRateController:getState',
+      'MultichainAssetsController:getState',
+    ],
+  });
+}

app/scripts/controller-init/multichain/index.ts

@@ -1,3 +1,4 @@
 export { MultichainAssetsControllerInit } from './multichain-assets-controller-init';
 export { MultichainBalancesControllerInit } from './multichain-balances-controller-init';
 export { MultichainTransactionsControllerInit } from './multichain-transactions-controller-init';
+export { MultichainAssetsRatesControllerInit } from './multichain-assets-rates-controller-init';

app/scripts/controller-init/multichain/multichain-rates-assets-controller-init.ts

@@ -0,0 +1,26 @@
+import { MultichainAssetsRatesController } from '@metamask/assets-controllers';
+import { ControllerInitFunction } from '../types';
+import { MultichainAssetsRatesControllerMessenger } from '../messengers/multichain';
+
+/**
+ * Initialize the Multichain Assets controller.
+ *
+ * @param request - The request object.
+ * @param request.controllerMessenger - The messenger to use for the controller.
+ * @param request.persistedState - The persisted state of the extension.
+ * @returns The initialized controller.
+ */
+export const MultichainAssetsRatesControllerInit: ControllerInitFunction<
+  MultichainAssetsRatesController,
+  MultichainAssetsRatesControllerMessenger
+> = ({ controllerMessenger, persistedState }) => {
+  const controller = new MultichainAssetsRatesController({
+    // @ts-expect-error TODO: Resolve mismatch between base-controller versions.
+    messenger: controllerMessenger,
+    state: persistedState.MultichainAssetsRatesController,
+  });
+
+  return {
+    controller,
+  };
+};

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;
+}