fix: multichainToken rate for non evm

packages/assets-controllers/src/MultichainAssetsRatesController/MultichainAssetsRatesController.test.ts

@@ -0,0 +1,378 @@
+import { Messenger } from '@metamask/base-controller';
+import type { InternalAccount } from '@metamask/keyring-internal-api';
+import { KeyringClient } from '@metamask/keyring-snap-client';
+import { useFakeTimers } from 'sinon';
+
+import { MultiChainAssetsRatesController } from '.';
+import {
+  type AllowedActions,
+  type AllowedEvents,
+} from './MultichainAssetsRatesController';
+
+// A fake non‑EVM account (with Snap metadata) that meets the controller’s criteria.
+const fakeNonEvmAccount: InternalAccount = {
+  id: 'account1',
+  type: 'solana:data-account',
+  address: '0x123',
+  metadata: {
+    name: 'Test Account',
+    // @ts-expect-error-next-line
+    snap: { id: 'test-snap', enabled: true },
+  },
+  scopes: ['solana:5eykt4UsFv8P8NJdTREpY1vzqKqZKvdp'],
+  options: {},
+  methods: [],
+};
+
+// A fake EVM account (which should be filtered out).
+const fakeEvmAccount: InternalAccount = {
+  id: 'account2',
+  type: 'eip155:eoa',
+  address: '0x456',
+  // @ts-expect-error-next-line
+  metadata: { name: 'EVM Account' },
+  scopes: [],
+  options: {},
+  methods: [],
+};
+
+const fakeEvmAccount2: InternalAccount = {
+  id: 'account3',
+  type: 'bip122:p2wpkh',
+  address: '0x789',
+  metadata: {
+    name: 'EVM Account',
+    // @ts-expect-error-next-line
+    snap: { id: 'test-snap', enabled: true },
+  },
+  scopes: [],
+  options: {},
+  methods: [],
+};
+
+const fakeEvmAccountWithoutMetadata: InternalAccount = {
+  id: 'account4',
+  type: 'bip122:p2wpkh',
+  address: '0x789',
+  metadata: {
+    name: 'EVM Account',
+    importTime: 0,
+    keyring: { type: 'bip122' },
+  },
+  scopes: [],
+  options: {},
+  methods: [],
+};
+
+// A fake conversion rates response returned by the SnapController.
+const fakeAccountRates = {
+  conversionRates: {
+    'solana:5eykt4UsFv8P8NJdTREpY1vzqKqZKvdp/slip44:501': {
+      'swift:0/iso4217:USD': {
+        rate: '202.11',
+        conversionTime: 1738539923277,
+      },
+    },
+  },
+};
+
+const setupController = ({
+  config,
+  accountsAssets = [fakeNonEvmAccount, fakeEvmAccount, fakeEvmAccount2],
+}: {
+  config?: Partial<
+    ConstructorParameters<typeof MultiChainAssetsRatesController>[0]
+  >;
+  accountsAssets?: InternalAccount[];
+} = {}) => {
+  const messenger = new Messenger<AllowedActions, AllowedEvents>();
+
+  messenger.registerActionHandler(
+    'MultichainAssetsController:getState',
+    () => ({
+      accountsAssets: {
+        account1: ['solana:5eykt4UsFv8P8NJdTREpY1vzqKqZKvdp/slip44:501'],
+        account2: ['solana:5eykt4UsFv8P8NJdTREpY1vzqKqZKvdp/slip44:501'],
+        account3: ['solana:5eykt4UsFv8P8NJdTREpY1vzqKqZKvdp/slip44:501'],
+      },
+      assetsMetadata: {
+        'solana:5eykt4UsFv8P8NJdTREpY1vzqKqZKvdp/slip44:501': {
+          name: 'Solana',
+          symbol: 'SOL',
+          fungible: true,
+          iconUrl: 'https://example.com/solana.png',
+          units: [{ symbol: 'SOL', name: 'Solana', decimals: 9 }],
+        },
+      },
+    }),
+  );
+
+  messenger.registerActionHandler(
+    'AccountsController:listMultichainAccounts',
+    () => accountsAssets,
+  );
+
+  messenger.registerActionHandler('CurrencyRateController:getState', () => ({
+    currencyRates: {},
+    currentCurrency: 'USD',
+  }));
+
+  const multiChainAssetsRatesControllerMessenger = messenger.getRestricted({
+    name: 'MultiChainAssetsRatesController',
+    allowedActions: [
+      'AccountsController:listMultichainAccounts',
+      'SnapController:handleRequest',
+      'CurrencyRateController:getState',
+      'MultichainAssetsController:getState',
+    ],
+    allowedEvents: [
+      'AccountsController:accountAdded',
+      'KeyringController:lock',
+      'KeyringController:unlock',
+      'CurrencyRateController:stateChange',
+      'MultichainAssetsController:stateChange',
+    ],
+  });
+
+  return {
+    controller: new MultiChainAssetsRatesController({
+      messenger: multiChainAssetsRatesControllerMessenger,
+      ...config,
+    }),
+    messenger,
+  };
+};
+
+describe('MultiChainAssetsRatesController', () => {
+  let clock: sinon.SinonFakeTimers;
+
+  const mockedDate = 1705760550000;
+
+  beforeEach(() => {
+    clock = useFakeTimers();
+    jest.spyOn(Date, 'now').mockReturnValue(mockedDate);
+  });
+
+  afterEach(() => {
+    clock.restore();
+    jest.restoreAllMocks();
+  });
+
+  it('initializes with an empty conversionRates state', () => {
+    const { controller } = setupController();
+    expect(controller.state).toStrictEqual({ conversionRates: {} });
+  });
+
+  it('updates conversion rates for a valid non-EVM account', async () => {
+    const { controller, messenger } = setupController();
+
+    // Stub KeyringClient.listAccountAssets so that the controller “discovers” one asset.
+    jest
+      .spyOn(KeyringClient.prototype, 'listAccountAssets')
+      .mockResolvedValue([
+        'solana:5eykt4UsFv8P8NJdTREpY1vzqKqZKvdp/slip44:501',
+      ]);
+
+    // Override the SnapController:handleRequest handler to return our fake conversion rates.
+    const snapHandler = jest.fn().mockResolvedValue(fakeAccountRates);
+    messenger.registerActionHandler(
+      'SnapController:handleRequest',
+      snapHandler,
+    );
+
+    // Call updateAssetsRates for the valid non-EVM account.
+    await controller.updateAssetsRates();
+
+    // Check that the Snap request was made with the expected parameters.
+    expect(snapHandler).toHaveBeenCalledWith(
+      expect.objectContaining({
+        handler: 'onAssetsConversion',
+        origin: 'metamask',
+        request: {
+          jsonrpc: '2.0',
+          method: 'onAssetsConversion',
+          params: {
+            conversions: [
+              {
+                from: 'solana:5eykt4UsFv8P8NJdTREpY1vzqKqZKvdp/slip44:501',
+                to: 'swift:0/iso4217:USD',
+              },
+            ],
+          },
+        },
+        snapId: 'test-snap',
+      }),
+    );
+
+    // The controller state should now contain the conversion rates returned.
+    expect(controller.state.conversionRates).toStrictEqual(
+      // fakeAccountRates.conversionRates,
+      {
+        'solana:5eykt4UsFv8P8NJdTREpY1vzqKqZKvdp/slip44:501': {
+          rate: '202.11',
+          conversionTime: 1738539923277,
+          currency: 'swift:0/iso4217:USD',
+        },
+      },
+    );
+  });
+
+  it('does not update conversion rates if the controller is not active', async () => {
+    const { controller, messenger } = setupController();
+
+    // Simulate a keyring lock event to set the controller as inactive.
+    messenger.publish('KeyringController:lock');
+    // Override SnapController:handleRequest and stub listAccountAssets.
+    const snapHandler = jest.fn().mockResolvedValue(fakeAccountRates);
+    messenger.registerActionHandler(
+      'SnapController:handleRequest',
+      snapHandler,
+    );
+    jest
+      .spyOn(KeyringClient.prototype, 'listAccountAssets')
+      .mockResolvedValue([
+        'solana:5eykt4UsFv8P8NJdTREpY1vzqKqZKvdp/slip44:501',
+      ]);
+
+    await controller.updateAssetsRates();
+    // Since the controller is locked, no update should occur.
+    expect(controller.state.conversionRates).toStrictEqual({});
+    expect(snapHandler).not.toHaveBeenCalled();
+  });
+
+  it('resumes update tokens rates when the keyring is unlocked', async () => {
+    const { controller, messenger } = setupController();
+    messenger.publish('KeyringController:lock');
+    // Override SnapController:handleRequest and stub listAccountAssets.
+    const snapHandler = jest.fn().mockResolvedValue(fakeAccountRates);
+    messenger.registerActionHandler(
+      'SnapController:handleRequest',
+      snapHandler,
+    );
+    jest
+      .spyOn(KeyringClient.prototype, 'listAccountAssets')
+      .mockResolvedValue([
+        'solana:5eykt4UsFv8P8NJdTREpY1vzqKqZKvdp/slip44:501',
+      ]);
+    await controller.updateAssetsRates();
+    expect(controller.isActive).toBe(false);
+
+    messenger.publish('KeyringController:unlock');
+    await controller.updateAssetsRates();
+
+    expect(controller.isActive).toBe(true);
+  });
+
+  it('calls updateTokensRates when _executePoll is invoked', async () => {
+    const { controller, messenger } = setupController();
+
+    jest
+      .spyOn(KeyringClient.prototype, 'listAccountAssets')
+      .mockResolvedValue([
+        'solana:5eykt4UsFv8P8NJdTREpY1vzqKqZKvdp/slip44:501',
+      ]);
+
+    messenger.registerActionHandler(
+      'SnapController:handleRequest',
+      async () => ({
+        conversionRates: {
+          'solana:5eykt4UsFv8P8NJdTREpY1vzqKqZKvdp/slip44:501': {
+            'swift:0/iso4217:USD': {
+              rate: '202.11',
+              conversionTime: 1738539923277,
+            },
+          },
+        },
+      }),
+    );
+
+    // Spy on updateAssetsRates.
+    const updateSpy = jest.spyOn(controller, 'updateAssetsRates');
+    await controller._executePoll();
+    expect(updateSpy).toHaveBeenCalled();
+  });
+
+  it('calls updateTokensRates when an multichain assets state is updated', async () => {
+    const { controller, messenger } = setupController();
+
+    // Spy on updateTokensRates.
+    const updateSpy = jest
+      .spyOn(controller, 'updateAssetsRates')
+      .mockResolvedValue();
+
+    // Publish a selectedAccountChange event.
+    // @ts-expect-error-next-line
+    messenger.publish('MultichainAssetsController:stateChange', {
+      accountsAssets: {
+        account3: ['solana:5eykt4UsFv8P8NJdTREpY1vzqKqZKvdp/slip44:501'],
+      },
+    });
+    // Wait for the asynchronous subscriber to run.
+    await Promise.resolve();
+    expect(updateSpy).toHaveBeenCalled();
+  });
+
+  it('handles partial or empty Snap responses gracefully', async () => {
+    const { controller, messenger } = setupController();
+
+    messenger.registerActionHandler('SnapController:handleRequest', () => {
+      return Promise.resolve({
+        conversionRates: {
+          // Only returning a rate for one asset
+          'solana:5eykt4UsFv8P8NJdTREpY1vzqKqZKvdp/slip44:501': {
+            'swift:0/iso4217:USD': {
+              rate: '250.50',
+              conversionTime: 1738539923277,
+            },
+          },
+        },
+      });
+    });
+
+    await controller.updateAssetsRates();
+
+    expect(controller.state.conversionRates).toMatchObject({
+      'solana:5eykt4UsFv8P8NJdTREpY1vzqKqZKvdp/slip44:501': {
+        rate: '250.50',
+        conversionTime: 1738539923277,
+      },
+    });
+  });
+
+  it('skips all accounts that lack Snap metadata or are EVM', async () => {
+    const { controller, messenger } = setupController({
+      accountsAssets: [fakeEvmAccountWithoutMetadata],
+    });
+
+    const snapSpy = jest.fn().mockResolvedValue({ conversionRates: {} });
+    messenger.registerActionHandler('SnapController:handleRequest', snapSpy);
+
+    await controller.updateAssetsRates();
+
+    expect(snapSpy).not.toHaveBeenCalled();
+    expect(controller.state.conversionRates).toStrictEqual({});
+  });
+
+  it('updates state when currency is updated', async () => {
+    const { controller, messenger } = setupController();
+
+    const snapHandler = jest.fn().mockResolvedValue(fakeAccountRates);
+    messenger.registerActionHandler(
+      'SnapController:handleRequest',
+      snapHandler,
+    );
+
+    const updateSpy = jest.spyOn(controller, 'updateAssetsRates');
+
+    messenger.publish(
+      'CurrencyRateController:stateChange',
+      {
+        currentCurrency: 'EUR',
+        currencyRates: {},
+      },
+      [],
+    );
+
+    expect(updateSpy).toHaveBeenCalled();
+  });
+});