fix: Managed removed property from MultichainAssetsController:accountAssetListUpdated event body

eslint-suppressions.json

@@ -305,9 +305,6 @@
   },
   "packages/assets-controllers/src/MultichainBalancesController/MultichainBalancesController.ts": {
     "@typescript-eslint/no-misused-promises": {
-      "count": 2
-    },
-    "@typescript-eslint/prefer-nullish-coalescing": {
       "count": 1
     },
     "no-restricted-syntax": {
@@ -2248,11 +2245,6 @@
       "count": 1
     }
   },
-  "packages/transaction-pay-controller/src/utils/source-amounts.ts": {
-    "import-x/no-relative-packages": {
-      "count": 1
-    }
-  },
   "packages/transaction-pay-controller/src/utils/transaction.ts": {
     "no-restricted-syntax": {
       "count": 2

packages/assets-controllers/CHANGELOG.md

@@ -21,6 +21,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Fixed
 
+- Used the `removed` property coming from `MultichainAssetsController:accountAssetListUpdated` event body to manage stale balances ([#8461](https://github.com/MetaMask/core/pull/8461))
 - `MultichainAssetsController`: fungible `token:` assets from automatic detection are no longer added when Blockaid bulk scan fails, returns empty, or omits that address (previously fail open); an explicit non-malicious per-token result from `PhishingController:bulkScanTokens` is now required before add. ([#8400](https://github.com/MetaMask/core/pull/8400))
 - Fix `AccountTrackerController` wiping existing balances on other chains when syncing accounts for a chain that has no state entry yet ([#8505](https://github.com/MetaMask/core/pull/8505))
 

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

@@ -150,41 +150,43 @@ const setupController = ({
   controller: MultichainAssetsRatesController;
   messenger: RootMessenger;
   updateSpy: jest.SpyInstance;
+  mockGetAssetsState: jest.Mock;
 } => {
   const messenger: RootMessenger = new Messenger({
     namespace: MOCK_ANY_NAMESPACE,
   });
 
-  messenger.registerActionHandler(
-    'MultichainAssetsController:getState',
-    () => ({
-      accountsAssets: {
-        account1: ['solana:5eykt4UsFv8P8NJdTREpY1vzqKqZKvdp/slip44:501'],
-        account2: ['solana:5eykt4UsFv8P8NJdTREpY1vzqKqZKvdp/slip44:501'],
-        account3: ['solana:5eykt4UsFv8P8NJdTREpY1vzqKqZKvdp/slip44:501'],
-        account5: [
-          'solana:5eykt4UsFv8P8NJdTREpY1vzqKqZKvdp/token:EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v',
-        ],
+  const mockGetAssetsState = jest.fn().mockImplementation(() => ({
+    accountsAssets: {
+      account1: ['solana:5eykt4UsFv8P8NJdTREpY1vzqKqZKvdp/slip44:501'],
+      account2: ['solana:5eykt4UsFv8P8NJdTREpY1vzqKqZKvdp/slip44:501'],
+      account3: ['solana:5eykt4UsFv8P8NJdTREpY1vzqKqZKvdp/slip44:501'],
+      account5: [
+        'solana:5eykt4UsFv8P8NJdTREpY1vzqKqZKvdp/token:EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v',
+      ],
+    },
+    assetsMetadata: {
+      'solana:5eykt4UsFv8P8NJdTREpY1vzqKqZKvdp/slip44:501': {
+        name: 'Solana',
+        symbol: 'SOL',
+        fungible: true,
+        iconUrl: 'https://example.com/solana.png',
+        units: [{ symbol: 'SOL', name: 'Solana', decimals: 9 }],
       },
-      assetsMetadata: {
-        'solana:5eykt4UsFv8P8NJdTREpY1vzqKqZKvdp/slip44:501': {
-          name: 'Solana',
-          symbol: 'SOL',
+      'solana:5eykt4UsFv8P8NJdTREpY1vzqKqZKvdp/token:EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v':
+        {
+          name: 'USDC',
+          symbol: 'USDC',
           fungible: true,
-          iconUrl: 'https://example.com/solana.png',
-          units: [{ symbol: 'SOL', name: 'Solana', decimals: 9 }],
+          iconUrl: 'https://example.com/usdc.png',
+          units: [{ symbol: 'USDC', name: 'USDC', decimals: 2 }],
         },
-        'solana:5eykt4UsFv8P8NJdTREpY1vzqKqZKvdp/token:EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v':
-          {
-            name: 'USDC',
-            symbol: 'USDC',
-            fungible: true,
-            iconUrl: 'https://example.com/usdc.png',
-            units: [{ symbol: 'USDC', name: 'USDC', decimals: 2 }],
-          },
-      },
-      allIgnoredAssets: {},
-    }),
+    },
+    allIgnoredAssets: {},
+  }));
+  messenger.registerActionHandler(
+    'MultichainAssetsController:getState',
+    mockGetAssetsState,
   );
 
   messenger.registerActionHandler(
@@ -240,6 +242,7 @@ const setupController = ({
     controller,
     messenger,
     updateSpy,
+    mockGetAssetsState,
   };
 };
 
@@ -524,6 +527,149 @@ describe('MultichainAssetsRatesController', () => {
     });
   });
 
+  it('removes stale rates and historical prices for assets no longer tracked by any account', async () => {
+    const removedAsset =
+      'solana:5eykt4UsFv8P8NJdTREpY1vzqKqZKvdp/token:removed-token' as CaipAssetType;
+    const keptAsset =
+      'solana:5eykt4UsFv8P8NJdTREpY1vzqKqZKvdp/slip44:501' as CaipAssetType;
+    const { controller, messenger, mockGetAssetsState } = setupController({
+      config: {
+        state: {
+          conversionRates: {
+            [removedAsset]: {
+              rate: '10',
+              conversionTime: 1738539923277,
+              currency: 'swift:0/iso4217:USD',
+            },
+            [keptAsset]: {
+              rate: '202.11',
+              conversionTime: 1738539923277,
+              currency: 'swift:0/iso4217:USD',
+            },
+          },
+          historicalPrices: {
+            [removedAsset]: {
+              USD: {
+                intervals: fakeHistoricalPrices.historicalPrice.intervals,
+                updateTime: 1737542312,
+                expirationTime: 1737542312,
+              },
+            },
+            [keptAsset]: {
+              USD: {
+                intervals: fakeHistoricalPrices.historicalPrice.intervals,
+                updateTime: 1737542312,
+                expirationTime: 1737542312,
+              },
+            },
+          },
+        },
+      },
+    });
+
+    mockGetAssetsState.mockReturnValue({
+      accountsAssets: {
+        account1: [keptAsset],
+      },
+      assetsMetadata: {},
+      allIgnoredAssets: {},
+    });
+
+    messenger.publish('MultichainAssetsController:accountAssetListUpdated', {
+      assets: {
+        account1: {
+          added: [],
+          removed: [removedAsset],
+        },
+      },
+    });
+
+    await Promise.resolve();
+    await jestAdvanceTime({ duration: 10 });
+
+    expect(controller.state.conversionRates).toStrictEqual({
+      [keptAsset]: {
+        rate: '202.11',
+        conversionTime: 1738539923277,
+        currency: 'swift:0/iso4217:USD',
+      },
+    });
+    expect(controller.state.historicalPrices).toStrictEqual({
+      [keptAsset]: {
+        USD: {
+          intervals: fakeHistoricalPrices.historicalPrice.intervals,
+          updateTime: 1737542312,
+          expirationTime: 1737542312,
+        },
+      },
+    });
+  });
+
+  it('keeps rates for removed assets that are still tracked by another account', async () => {
+    const sharedAsset =
+      'solana:5eykt4UsFv8P8NJdTREpY1vzqKqZKvdp/token:shared-token' as CaipAssetType;
+    const { controller, messenger, mockGetAssetsState } = setupController({
+      config: {
+        state: {
+          conversionRates: {
+            [sharedAsset]: {
+              rate: '77',
+              conversionTime: 1738539923277,
+              currency: 'swift:0/iso4217:USD',
+            },
+          },
+          historicalPrices: {
+            [sharedAsset]: {
+              USD: {
+                intervals: fakeHistoricalPrices.historicalPrice.intervals,
+                updateTime: 1737542312,
+                expirationTime: 1737542312,
+              },
+            },
+          },
+        },
+      },
+    });
+
+    mockGetAssetsState.mockReturnValue({
+      accountsAssets: {
+        account1: [],
+        account2: [sharedAsset],
+      },
+      assetsMetadata: {},
+      allIgnoredAssets: {},
+    });
+
+    messenger.publish('MultichainAssetsController:accountAssetListUpdated', {
+      assets: {
+        account1: {
+          added: [],
+          removed: [sharedAsset],
+        },
+      },
+    });
+
+    await Promise.resolve();
+    await jestAdvanceTime({ duration: 10 });
+
+    expect(controller.state.conversionRates).toStrictEqual({
+      [sharedAsset]: {
+        rate: '77',
+        conversionTime: 1738539923277,
+        currency: 'swift:0/iso4217:USD',
+      },
+    });
+    expect(controller.state.historicalPrices).toStrictEqual({
+      [sharedAsset]: {
+        USD: {
+          intervals: fakeHistoricalPrices.historicalPrice.intervals,
+          updateTime: 1737542312,
+          expirationTime: 1737542312,
+        },
+      },
+    });
+  });
+
   it('handles partial or empty Snap responses gracefully', async () => {
     const { controller, messenger } = setupController();