feat: calculate bridge quote metadata in @metamask/bridge-controller (#5614)

Author: micaelae

packages/bridge-controller/CHANGELOG.md

@@ -7,8 +7,21 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+### Added
+
+- **BREAKING:** Add `@metamask/assets-controllers` as a required peer dependency at `^56.0.0` ([#5614](https://github.com/MetaMask/core/pull/5614))
+- Add `reselect` as a dependency at `^5.1.1` ([#5614](https://github.com/MetaMask/core/pull/5614))
+- **BREAKING:** assetExchangeRates added to BridgeController state to support tokens which are not supported by assets controllers ([#5614](https://github.com/MetaMask/core/pull/5614))
+- selectExchangeRateByChainIdAndAddress selector added, which looks up exchange rates from assets and bridge controller states ([#5614](https://github.com/MetaMask/core/pull/5614))
+- selectBridgeQuotes selector added, which returns sorted quotes including their metadata ([#5614](https://github.com/MetaMask/core/pull/5614))
+- selectIsQuoteExpired selector added, which returns whether quotes are expired or stale ([#5614](https://github.com/MetaMask/core/pull/5614))
+
 ### Changed
 
+- **BREAKING:** Change TokenAmountValues key types from BigNumber to string ([#5614](https://github.com/MetaMask/core/pull/5614))
+- **BREAKING:** Assets controller getState actions have been added to `AllowedActions` so clients will need to include `TokenRatesController:getState`,`MultichainAssetsRatesController:getState` and `CurrencyRateController:getState` in controller initializations ([#5614](https://github.com/MetaMask/core/pull/5614))
+- Make srcAsset and destAsset optional in Step type to be optional ([#5614](https://github.com/MetaMask/core/pull/5614))
+- Make QuoteResponse trade generic to support Solana quotes which have string trade data ([#5614](https://github.com/MetaMask/core/pull/5614))
 - Bump `@metamask/multichain-network-controller` peer dependency to `^0.4.0` ([#5649](https://github.com/MetaMask/core/pull/5649))
 
 ## [13.0.0]

packages/bridge-controller/package.json

@@ -54,15 +54,18 @@
     "@ethersproject/providers": "^5.7.0",
     "@metamask/base-controller": "^8.0.0",
     "@metamask/controller-utils": "^11.7.0",
+    "@metamask/gas-fee-controller": "^23.0.0",
     "@metamask/keyring-api": "^17.4.0",
     "@metamask/metamask-eth-abis": "^3.1.1",
     "@metamask/multichain-network-controller": "^0.4.0",
     "@metamask/polling-controller": "^13.0.0",
-    "@metamask/snaps-utils": "^8.10.0",
-    "@metamask/utils": "^11.2.0"
+    "@metamask/utils": "^11.2.0",
+    "bignumber.js": "^9.1.2",
+    "reselect": "^5.1.1"
   },
   "devDependencies": {
     "@metamask/accounts-controller": "^27.0.0",
+    "@metamask/assets-controllers": "^56.0.0",
     "@metamask/auto-changelog": "^3.4.4",
     "@metamask/eth-json-rpc-provider": "^4.1.8",
     "@metamask/network-controller": "^23.2.0",
@@ -82,6 +85,7 @@
   },
   "peerDependencies": {
     "@metamask/accounts-controller": "^27.0.0",
+    "@metamask/assets-controllers": "^56.0.0",
     "@metamask/network-controller": "^23.0.0",
     "@metamask/snaps-controllers": "^9.19.0",
     "@metamask/transaction-controller": "^54.0.0"

packages/bridge-controller/src/bridge-controller.test.ts

@@ -1,6 +1,5 @@
 import { Contract } from '@ethersproject/contracts';
 import { SolScope } from '@metamask/keyring-api';
-import { HandlerType } from '@metamask/snaps-utils';
 import type { Hex } from '@metamask/utils';
 import { bigIntToHex } from '@metamask/utils';
 import nock from 'nock';
@@ -12,6 +11,7 @@ import {
   DEFAULT_BRIDGE_CONTROLLER_STATE,
 } from './constants/bridge';
 import { SWAPS_API_V2_BASE_URL } from './constants/swaps';
+import * as selectors from './selectors';
 import {
   ChainId,
   type BridgeControllerMessenger,
@@ -44,6 +44,7 @@ jest.mock('@ethersproject/contracts', () => {
 
 const getLayer1GasFeeMock = jest.fn();
 const mockFetchFn = handleFetch;
+let fetchAssetPricesSpy: jest.SpyInstance;
 
 describe('BridgeController', function () {
   let bridgeController: BridgeController;
@@ -154,6 +155,14 @@ describe('BridgeController', function () {
           symbol: 'ABC',
         },
       ]);
+
+    fetchAssetPricesSpy = jest
+      .spyOn(fetchUtils, 'fetchAssetPrices')
+      .mockResolvedValue({
+        'eip155:10/erc20:0x1f9840a85d5af5bf1d1762f925bdaddc4201f984': {
+          usd: '100',
+        },
+      });
     bridgeController.resetState();
   });
 
@@ -273,6 +282,9 @@ describe('BridgeController', function () {
       address: '0x123',
       provider: jest.fn(),
       selectedNetworkClientId: 'selectedNetworkClientId',
+      currencyRates: {},
+      marketData: {},
+      conversionRates: {},
     } as never);
 
     const fetchBridgeQuotesSpy = jest
@@ -328,6 +340,7 @@ describe('BridgeController', function () {
         insufficientBal: false,
       },
     });
+    expect(fetchAssetPricesSpy).toHaveBeenCalledTimes(1);
 
     expect(bridgeController.state).toStrictEqual(
       expect.objectContaining({
@@ -429,7 +442,14 @@ describe('BridgeController', function () {
       address: '0x123',
       provider: jest.fn(),
       selectedNetworkClientId: 'selectedNetworkClientId',
+      currentCurrency: 'usd',
+      currencyRates: {},
+      marketData: {},
+      conversionRates: {},
     } as never);
+    jest
+      .spyOn(selectors, 'selectIsAssetExchangeRateInState')
+      .mockReturnValue(true);
 
     const fetchBridgeQuotesSpy = jest
       .spyOn(fetchUtils, 'fetchBridgeQuotes')
@@ -454,7 +474,7 @@ describe('BridgeController', function () {
 
     const quoteParams = {
       srcChainId: '0x1',
-      destChainId: '0x10',
+      destChainId: '0xa',
       srcTokenAddress: '0x0000000000000000000000000000000000000000',
       destTokenAddress: '0x123',
       srcTokenAmount: '1000000000000000000',
@@ -476,6 +496,7 @@ describe('BridgeController', function () {
         insufficientBal: true,
       },
     });
+    expect(fetchAssetPricesSpy).not.toHaveBeenCalled();
 
     expect(bridgeController.state).toStrictEqual(
       expect.objectContaining({
@@ -611,7 +632,7 @@ describe('BridgeController', function () {
 
     const quoteParams = {
       srcChainId: '0x1',
-      destChainId: '0x10',
+      destChainId: '0xa',
       srcTokenAddress: '0x0000000000000000000000000000000000000000',
       destTokenAddress: '0x123',
       srcTokenAmount: '1000000000000000000',
@@ -793,7 +814,7 @@ describe('BridgeController', function () {
         });
 
       const quoteParams = {
-        srcChainId: '0x10',
+        srcChainId: '0xa',
         destChainId: '0x1',
         srcTokenAddress: '0x4200000000000000000000000000000000000006',
         destTokenAddress: '0x0000000000000000000000000000000000000000',
@@ -895,7 +916,7 @@ describe('BridgeController', function () {
     });
 
     const quoteParams = {
-      srcChainId: '0x10',
+      srcChainId: '0xa',
       destChainId: '0x1',
       srcTokenAddress: '0x4200000000000000000000000000000000000006',
       destTokenAddress: '0x0000000000000000000000000000000000000000',
@@ -933,7 +954,7 @@ describe('BridgeController', function () {
     {
       snapId: 'npm:@metamask/solana-snap',
       origin: 'metamask',
-      handler: HandlerType.OnRpcRequest,
+      handler: 'onRpcRequest',
       request: {
         method: 'getFeeForTransaction',
         params: {

packages/bridge-controller/src/bridge-controller.ts

@@ -6,11 +6,9 @@ import type { ChainId } from '@metamask/controller-utils';
 import { abiERC20 } from '@metamask/metamask-eth-abis';
 import type { NetworkClientId } from '@metamask/network-controller';
 import { StaticIntervalPollingController } from '@metamask/polling-controller';
-import { type SnapId } from '@metamask/snaps-sdk';
-import { HandlerType } from '@metamask/snaps-utils';
 import type { TransactionParams } from '@metamask/transaction-controller';
-import { numberToHex } from '@metamask/utils';
-import type { Hex } from '@metamask/utils';
+import type { CaipAssetType } from '@metamask/utils';
+import { numberToHex, type Hex } from '@metamask/utils';
 
 import {
   type BridgeClientId,
@@ -21,9 +19,11 @@ import {
   REFRESH_INTERVAL_MS,
 } from './constants/bridge';
 import { CHAIN_IDS } from './constants/chains';
-import type { GenericQuoteRequest, SolanaFees } from './types';
+import { selectIsAssetExchangeRateInState } from './selectors';
 import {
   type L1GasFees,
+  type GenericQuoteRequest,
+  type SolanaFees,
   type QuoteResponse,
   type TxData,
   type BridgeControllerState,
@@ -32,6 +32,7 @@ import {
   BridgeFeatureFlagsKey,
   RequestStatus,
 } from './types';
+import { getAssetIdsForToken, toExchangeRates } from './utils/assets';
 import { hasSufficientBalance } from './utils/balance';
 import {
   getDefaultBridgeControllerState,
@@ -43,7 +44,11 @@ import {
   formatChainIdToCaip,
   formatChainIdToHex,
 } from './utils/caip-formatters';
-import { fetchBridgeFeatureFlags, fetchBridgeQuotes } from './utils/fetch';
+import {
+  fetchAssetPrices,
+  fetchBridgeFeatureFlags,
+  fetchBridgeQuotes,
+} from './utils/fetch';
 import { isValidQuoteRequest } from './utils/quote';
 
 const metadata: StateMetadata<BridgeControllerState> = {
@@ -79,6 +84,10 @@ const metadata: StateMetadata<BridgeControllerState> = {
     persist: false,
     anonymous: false,
   },
+  assetExchangeRates: {
+    persist: false,
+    anonymous: false,
+  },
 };
 
 const RESET_STATE_ABORT_MESSAGE = 'Reset controller state';
@@ -197,6 +206,10 @@ export class BridgeController extends StaticIntervalPollingController<BridgePoll
         DEFAULT_BRIDGE_CONTROLLER_STATE.quotesInitialLoadTime;
     });
 
+    await this.#fetchAssetExchangeRates(updatedQuoteRequest).catch((error) =>
+      console.warn('Failed to fetch asset exchange rates', error),
+    );
+
     if (isValidQuoteRequest(updatedQuoteRequest)) {
       this.#quotesFirstFetched = Date.now();
       const providerConfig = this.#getSelectedNetworkClient()?.configuration;
@@ -229,6 +242,81 @@ export class BridgeController extends StaticIntervalPollingController<BridgePoll
     }
   };
 
+  /**
+   * Fetches the exchange rates for the assets in the quote request if they are not already in the state
+   * In addition to the selected tokens, this also fetches the native asset for the source and destination chains
+   *
+   * @param quoteRequest - The quote request
+   * @param quoteRequest.srcChainId - The source chain ID
+   * @param quoteRequest.srcTokenAddress - The source token address
+   * @param quoteRequest.destChainId - The destination chain ID
+   * @param quoteRequest.destTokenAddress - The destination token address
+   */
+  readonly #fetchAssetExchangeRates = async ({
+    srcChainId,
+    srcTokenAddress,
+    destChainId,
+    destTokenAddress,
+  }: Partial<GenericQuoteRequest>) => {
+    const assetIds: Set<CaipAssetType> = new Set([]);
+
+    const exchangeRateSources = {
+      ...this.messagingSystem.call('MultichainAssetsRatesController:getState'),
+      ...this.messagingSystem.call('CurrencyRateController:getState'),
+      ...this.messagingSystem.call('TokenRatesController:getState'),
+      ...this.state,
+    };
+
+    if (
+      srcTokenAddress &&
+      srcChainId &&
+      !selectIsAssetExchangeRateInState(
+        exchangeRateSources,
+        srcChainId,
+        srcTokenAddress,
+      )
+    ) {
+      getAssetIdsForToken(srcTokenAddress, srcChainId).forEach((assetId) =>
+        assetIds.add(assetId),
+      );
+    }
+    if (
+      destTokenAddress &&
+      destChainId &&
+      !selectIsAssetExchangeRateInState(
+        exchangeRateSources,
+        destChainId,
+        destTokenAddress,
+      )
+    ) {
+      getAssetIdsForToken(destTokenAddress, destChainId).forEach((assetId) =>
+        assetIds.add(assetId),
+      );
+    }
+
+    const currency = this.messagingSystem.call(
+      'CurrencyRateController:getState',
+    ).currentCurrency;
+
+    if (assetIds.size === 0) {
+      return;
+    }
+
+    const pricesByAssetId = await fetchAssetPrices({
+      assetIds,
+      currencies: new Set([currency]),
+      clientId: this.#clientId,
+      fetchFn: this.#fetchFn,
+    });
+    const exchangeRates = toExchangeRates(currency, pricesByAssetId);
+    this.update((state) => {
+      state.assetExchangeRates = {
+        ...state.assetExchangeRates,
+        ...exchangeRates,
+      };
+    });
+  };
+
   readonly #hasSufficientBalance = async (
     quoteRequest: GenericQuoteRequest,
   ) => {
@@ -272,6 +360,8 @@ export class BridgeController extends StaticIntervalPollingController<BridgePoll
       state.quoteFetchError = DEFAULT_BRIDGE_CONTROLLER_STATE.quoteFetchError;
       state.quotesRefreshCount =
         DEFAULT_BRIDGE_CONTROLLER_STATE.quotesRefreshCount;
+      state.assetExchangeRates =
+        DEFAULT_BRIDGE_CONTROLLER_STATE.assetExchangeRates;
 
       // Keep feature flags
       const originalFeatureFlags = state.bridgeFeatureFlags;
@@ -449,9 +539,10 @@ export class BridgeController extends StaticIntervalPollingController<BridgePoll
           const { value: fees } = (await this.messagingSystem.call(
             'SnapController:handleRequest',
             {
-              snapId: selectedAccount.metadata.snap.id as SnapId,
+              // TODO fix these types
+              snapId: selectedAccount.metadata.snap.id as never,
               origin: 'metamask',
-              handler: HandlerType.OnRpcRequest,
+              handler: 'onRpcRequest' as never,
               request: {
                 method: 'getFeeForTransaction',
                 params: {

packages/bridge-controller/src/constants/bridge.ts

@@ -65,6 +65,7 @@ export const DEFAULT_BRIDGE_CONTROLLER_STATE: BridgeControllerState = {
   quotesLoadingStatus: null,
   quoteFetchError: null,
   quotesRefreshCount: 0,
+  assetExchangeRates: {},
 };
 
 export const METABRIDGE_CHAIN_TO_ADDRESS_MAP: Record<Hex, string> = {

packages/bridge-controller/src/index.ts

@@ -80,7 +80,7 @@ export {
   getDefaultBridgeControllerState,
 } from './utils/bridge';
 
-export { isValidQuoteRequest } from './utils/quote';
+export { isValidQuoteRequest, formatEtaInMinutes } from './utils/quote';
 
 export { calcLatestSrcBalance } from './utils/balance';
 
@@ -91,3 +91,17 @@ export {
   formatChainIdToHex,
   formatAddressToCaipReference,
 } from './utils/caip-formatters';
+
+export {
+  selectBridgeQuotes,
+  type BridgeAppState,
+  selectExchangeRateByChainIdAndAddress,
+  /**
+   * Returns whether a quote is expired
+   *
+   * @param state The state of the bridge controller and its dependency controllers
+   * @param currentTimeInMs The current timestamp in milliseconds (e.g. `Date.now()`)
+   * @returns Whether the quote is expired
+   */
+  selectIsQuoteExpired,
+} from './selectors';