feat: fetch batched swap quotes (#8711)

## Explanation

This PR implements quote polling for batched swap requests

#### Changes
- `updateBridgeQuoteRequest` now takes 2 extra params: the quote
request’s index and the total quoteRequestCount within the batch. no
changes in how we are using this handler for regular swaps
- the new `selectBatchSellQuotes` selector returns the recommended quote
for each quoteRequest, and aggregated amounts for display purposes
- `isValidBatchSellQuoteRequest`


#### Usage
- the clients will need to maintain a list of requests, each one
identified by an index. the index identifies the quoteRequest and its
related side effects (quotes, metrics, submission etc) once it’s passed
to updateBridgeQuoteRequest
- to access quotes for a single quoteRequest, use the same index used
during quoteRequest update


#### Minimal client examples
- extension: MetaMask/metamask-extension#42434.
Checkout this branch and resolve the package locally to test
- mobile: MetaMask/metamask-mobile#29831

<!--
Thanks for your contribution! Take a moment to answer these questions so
that reviewers have the information they need to properly understand
your changes:

* What is the current state of things and why does it need to change?
* What is the solution your changes offer and how does it work?
* Are there any changes whose purpose might not obvious to those
unfamiliar with the domain?
* If your primary goal was to update one package but you found you had
to update another one along the way, why did you do so?
* If you had to upgrade a dependency, why did you do so?
-->

## References

<!--
Are there any issues that this pull request is tied to?
Are there other links that reviewers should consult to understand these
changes better?
Are there client or consumer pull requests to adopt any breaking
changes?

For example:

* Fixes #12345
* Related to #67890
-->
Fixes https://consensyssoftware.atlassian.net/browse/SWAPS-4443

## Checklist

- [ ] I've updated the test suite for new or updated code as appropriate
- [ ] I've updated documentation (JSDoc, Markdown, etc.) for new or
updated code as appropriate
- [ ] I've communicated my changes to consumers by [updating changelogs
for packages I've
changed](https://github.com/MetaMask/core/tree/main/docs/processes/updating-changelogs.md)
- [ ] I've introduced [breaking
changes](https://github.com/MetaMask/core/tree/main/docs/processes/breaking-changes.md)
in this PR and have prepared draft pull requests for clients and
consumer packages to resolve them

<!-- CURSOR_SUMMARY -->
---

> [!NOTE]
> **Medium Risk**
> This is a breaking API/state-shape change (`quoteRequest` becomes an
array) that touches quote polling/streaming, analytics properties, and
exchange-rate lookup logic; regressions could affect quote fetching and
refresh behavior across swaps/bridges.
> 
> **Overview**
> **Adds BatchSell (batched swap) quote support** by changing
`quoteRequest` state and polling inputs from a single request to an
array, allowing callers to update a specific request via new
`updateBridgeQuoteRequestParams(…, quoteRequestIndex,
quoteRequestCount)` parameters.
> 
> Quote fetching/streaming is updated to accept multiple requests: SSE
uses a new `POST /getBatchQuoteStream` path when batching, tags incoming
quotes with `quoteRequestIndex`, traces via new Sentry trace name `Batch
Sell Quotes Fetched`, and adjusts polling stop/refresh logic to continue
as long as *any* request is sufficiently funded.
> 
> Selectors and rate lookup are extended for batching: adds
`selectBatchSellQuotes` (per-request recommended quotes plus aggregated
received/fee totals), switches exchange-rate selection to
`selectExchangeRateByAssetId`, and exports
`isValidBatchSellQuoteRequest`; tests/snapshots are updated and a new
SSE batch test is added.
> 
> <sup>Reviewed by [Cursor Bugbot](https://cursor.com/bugbot) for commit
9e2a7fa. Bugbot is set up for automated
code reviews on this repo. Configure
[here](https://www.cursor.com/dashboard/bugbot).</sup>
<!-- /CURSOR_SUMMARY -->

Author: micaelae

packages/bridge-controller/CHANGELOG.md

@@ -7,6 +7,16 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+### Added
+
+- **BREAKING:** Add support for BatchSell quotes ([#8711](https://github.com/MetaMask/core/pull/8711))
+  - change `quoteRequest`'s type from `QuoteRequest` to `QuoteRequest[]`
+  - allow callers to update specific quote requests within a batch by adding 2 optional parameters to `updateBridgeQuoteRequest`: quoteRequestIndex and quoteRequestCount
+  - export `isValidBatchSellQuoteRequest` request validator
+  - fetch multiple swap quotes through a single SSE stream and append `quoteRequestIndex` to link each one to its originating quoteRequest
+  - implement `selectBatchSellQuotes` selector which returns the recommended quote for each batched quote, and their aggregated fees and received amounts
+  - trace BatchSell quote fetch operations in Sentry using label `Batch Sell Quotes Fetched`
+
 ### Changed
 
 - Bump `@metamask/gas-fee-controller` from `^26.1.1` to `^26.2.0` ([#8722](https://github.com/MetaMask/core/pull/8722))

packages/bridge-controller/src/__snapshots__/bridge-controller.sse.batch.test.ts.snap

@@ -0,0 +1,124 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`BridgeController BatchSell (multiple quote requests) SSE should trigger quote polling if request is valid 1`] = `
+{
+  "assetExchangeRates": {
+    "eip155:10/erc20:0x1f9840a85d5af5bf1d1762f925bdaddc4201f984": {
+      "exchangeRate": undefined,
+      "usdExchangeRate": "100",
+    },
+  },
+  "minimumBalanceForRentExemptionInLamports": "0",
+  "quoteFetchError": null,
+  "quoteRequest": [
+    {
+      "destChainId": "137",
+      "destTokenAddress": "0x3c499c542cef5e3811e1192ce70d8cc03d5c3359",
+      "destWalletAddress": "SolanaWalletAddres1234",
+      "insufficientBal": false,
+      "resetApproval": false,
+      "slippage": 0.5,
+      "srcChainId": "10",
+      "srcTokenAddress": "0x0000000000000000000000000000000000000000",
+      "srcTokenAmount": "100000000000000000",
+      "walletAddress": "0x30E8ccaD5A980BDF30447f8c2C48e70989D9d294",
+    },
+    {
+      "destChainId": "137",
+      "destTokenAddress": "0x3c499c542cef5e3811e1192ce70d8cc03d5c3359",
+      "destWalletAddress": "SolanaWalletAddres1234",
+      "insufficientBal": false,
+      "resetApproval": false,
+      "slippage": 0.5,
+      "srcChainId": "10",
+      "srcTokenAddress": "0x0b2C639c533813f4Aa9D7837CAf62653d097Ff85",
+      "srcTokenAmount": "1000000000000000000",
+      "walletAddress": "0x30E8ccaD5A980BDF30447f8c2C48e70989D9d294",
+    },
+    {
+      "destChainId": "137",
+      "destTokenAddress": "0x3c499c542cef5e3811e1192ce70d8cc03d5c3359",
+      "destWalletAddress": "SolanaWalletAddres1234",
+      "insufficientBal": false,
+      "resetApproval": false,
+      "slippage": 0.5,
+      "srcChainId": "10",
+      "srcTokenAddress": "0x0000000000000000000000000000000000000000",
+      "srcTokenAmount": "1000000000000000000",
+      "walletAddress": "0x30E8ccaD5A980BDF30447f8c2C48e70989D9d294",
+    },
+  ],
+  "quoteStreamComplete": null,
+  "quotes": [],
+  "quotesInitialLoadTime": null,
+  "quotesLoadingStatus": 0,
+  "quotesRefreshCount": 0,
+  "tokenSecurityTypeDestination": null,
+  "tokenWarnings": [],
+}
+`;
+
+exports[`BridgeController BatchSell (multiple quote requests) SSE should trigger quote polling if request is valid 2`] = `
+[
+  [
+    "Unified SwapBridge Input Changed",
+    {
+      "action_type": "swapbridge-v1",
+      "input": "chain_source",
+      "input_value": "eip155:10",
+      "location": "Main View",
+    },
+  ],
+  [
+    "Unified SwapBridge Input Changed",
+    {
+      "action_type": "swapbridge-v1",
+      "input": "chain_destination",
+      "input_value": "eip155:137",
+      "location": "Main View",
+    },
+  ],
+  [
+    "Unified SwapBridge Input Changed",
+    {
+      "action_type": "swapbridge-v1",
+      "input": "token_destination",
+      "input_value": "eip155:137/erc20:0x3c499c542cEF5E3811e1192ce70d8cC03d5c3359",
+      "location": "Main View",
+    },
+  ],
+  [
+    "Unified SwapBridge Input Changed",
+    {
+      "action_type": "swapbridge-v1",
+      "input": "slippage",
+      "input_value": 0.5,
+      "location": "Main View",
+    },
+  ],
+  [
+    "Unified SwapBridge Quotes Requested",
+    {
+      "account_hardware_type": null,
+      "action_type": "swapbridge-v1",
+      "chain_id_destination": "eip155:137",
+      "chain_id_source": "eip155:10",
+      "custom_slippage": true,
+      "has_sufficient_funds": true,
+      "is_hardware_wallet": false,
+      "location": "Main View",
+      "security_warnings": [],
+      "slippage_limit": 0.5,
+      "stx_enabled": true,
+      "swap_type": "crosschain",
+      "token_address_destination": "eip155:137/erc20:0x3c499c542cEF5E3811e1192ce70d8cC03d5c3359",
+      "token_address_source": "eip155:10/slip44:60",
+      "token_security_type_destination": null,
+      "token_symbol_destination": "USDC",
+      "token_symbol_source": "ETH",
+      "usd_amount_source": 100,
+      "warnings": [],
+    },
+  ],
+]
+`;

packages/bridge-controller/src/__snapshots__/bridge-controller.sse.test.ts.snap

@@ -24,7 +24,7 @@ exports[`BridgeController SSE should publish validation failures 4`] = `
       "refresh_count": 1,
       "token_address_destination": "solana:5eykt4UsFv8P8NJdTREpY1vzqKqZKvdp/token:123d1",
       "token_address_source": "eip155:1/slip44:60",
-      "token_security_type_destination": null,
+      "token_security_type_destination": "test",
     },
   ],
   [
@@ -40,7 +40,7 @@ exports[`BridgeController SSE should publish validation failures 4`] = `
       "refresh_count": 1,
       "token_address_destination": "solana:5eykt4UsFv8P8NJdTREpY1vzqKqZKvdp/token:123d1",
       "token_address_source": "eip155:1/slip44:60",
-      "token_security_type_destination": null,
+      "token_security_type_destination": "test",
     },
   ],
   [
@@ -56,7 +56,7 @@ exports[`BridgeController SSE should publish validation failures 4`] = `
       "refresh_count": 1,
       "token_address_destination": "solana:5eykt4UsFv8P8NJdTREpY1vzqKqZKvdp/token:123d1",
       "token_address_source": "eip155:1/slip44:60",
-      "token_security_type_destination": null,
+      "token_security_type_destination": "test",
     },
   ],
 ]
@@ -99,7 +99,7 @@ exports[`BridgeController SSE should reset and refetch quotes after quote reques
       "chain_id_destination": "solana:5eykt4UsFv8P8NJdTREpY1vzqKqZKvdp",
       "chain_id_source": "eip155:1",
       "custom_slippage": true,
-      "has_sufficient_funds": true,
+      "has_sufficient_funds": false,
       "is_hardware_wallet": false,
       "location": "Main View",
       "security_warnings": [],
@@ -181,18 +181,20 @@ exports[`BridgeController SSE should rethrow error from server 1`] = `
   },
   "minimumBalanceForRentExemptionInLamports": "0",
   "quoteFetchError": null,
-  "quoteRequest": {
-    "destChainId": "solana:5eykt4UsFv8P8NJdTREpY1vzqKqZKvdp",
-    "destTokenAddress": "123d1",
-    "destWalletAddress": "SolanaWalletAddres1234",
-    "insufficientBal": false,
-    "resetApproval": false,
-    "slippage": 0.5,
-    "srcChainId": "0x1",
-    "srcTokenAddress": "0x0000000000000000000000000000000000000000",
-    "srcTokenAmount": "1000000000000000000",
-    "walletAddress": "0x30E8ccaD5A980BDF30447f8c2C48e70989D9d294",
-  },
+  "quoteRequest": [
+    {
+      "destChainId": "solana:5eykt4UsFv8P8NJdTREpY1vzqKqZKvdp",
+      "destTokenAddress": "123d1",
+      "destWalletAddress": "SolanaWalletAddres1234",
+      "insufficientBal": false,
+      "resetApproval": false,
+      "slippage": 0.5,
+      "srcChainId": "0x1",
+      "srcTokenAddress": "0x0000000000000000000000000000000000000000",
+      "srcTokenAmount": "1000000000000000000",
+      "walletAddress": "0x30E8ccaD5A980BDF30447f8c2C48e70989D9d294",
+    },
+  ],
   "quoteStreamComplete": null,
   "quotes": [],
   "quotesInitialLoadTime": null,
@@ -303,18 +305,20 @@ exports[`BridgeController SSE should trigger quote polling if request is valid 1
   },
   "minimumBalanceForRentExemptionInLamports": "0",
   "quoteFetchError": null,
-  "quoteRequest": {
-    "destChainId": "solana:5eykt4UsFv8P8NJdTREpY1vzqKqZKvdp",
-    "destTokenAddress": "123d1",
-    "destWalletAddress": "SolanaWalletAddres1234",
-    "insufficientBal": false,
-    "resetApproval": false,
-    "slippage": 0.5,
-    "srcChainId": "0x1",
-    "srcTokenAddress": "0x0000000000000000000000000000000000000000",
-    "srcTokenAmount": "1000000000000000000",
-    "walletAddress": "0x30E8ccaD5A980BDF30447f8c2C48e70989D9d294",
-  },
+  "quoteRequest": [
+    {
+      "destChainId": "solana:5eykt4UsFv8P8NJdTREpY1vzqKqZKvdp",
+      "destTokenAddress": "123d1",
+      "destWalletAddress": "SolanaWalletAddres1234",
+      "insufficientBal": false,
+      "resetApproval": false,
+      "slippage": 0.5,
+      "srcChainId": "0x1",
+      "srcTokenAddress": "0x0000000000000000000000000000000000000000",
+      "srcTokenAmount": "1000000000000000000",
+      "walletAddress": "0x30E8ccaD5A980BDF30447f8c2C48e70989D9d294",
+    },
+  ],
   "quoteStreamComplete": null,
   "quotes": [],
   "quotesInitialLoadTime": null,

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

@@ -10,16 +10,18 @@ exports[`BridgeController should handle errors from fetchBridgeQuotes 1`] = `
   },
   "minimumBalanceForRentExemptionInLamports": "0",
   "quoteFetchError": null,
-  "quoteRequest": {
-    "destChainId": "0x1",
-    "destTokenAddress": "0x0000000000000000000000000000000000000000",
-    "insufficientBal": false,
-    "resetApproval": false,
-    "srcChainId": "0xa",
-    "srcTokenAddress": "0x4200000000000000000000000000000000000006",
-    "srcTokenAmount": "991250000000000000",
-    "walletAddress": "eip:id/id:id/0x123",
-  },
+  "quoteRequest": [
+    {
+      "destChainId": "0x1",
+      "destTokenAddress": "0x0000000000000000000000000000000000000000",
+      "insufficientBal": false,
+      "resetApproval": false,
+      "srcChainId": "0xa",
+      "srcTokenAddress": "0x4200000000000000000000000000000000000006",
+      "srcTokenAmount": "991250000000000000",
+      "walletAddress": "eip:id/id:id/0x123",
+    },
+  ],
   "quoteStreamComplete": null,
   "quotesInitialLoadTime": 10000,
   "quotesLoadingStatus": 1,
@@ -39,16 +41,18 @@ exports[`BridgeController should handle errors from fetchBridgeQuotes 2`] = `
   },
   "minimumBalanceForRentExemptionInLamports": "0",
   "quoteFetchError": null,
-  "quoteRequest": {
-    "destChainId": "0x1",
-    "destTokenAddress": "0x0000000000000000000000000000000000000000",
-    "insufficientBal": false,
-    "resetApproval": false,
-    "srcChainId": "0xa",
-    "srcTokenAddress": "0x4200000000000000000000000000000000000006",
-    "srcTokenAmount": "991250000000000000",
-    "walletAddress": "eip:id/id:id/0x123",
-  },
+  "quoteRequest": [
+    {
+      "destChainId": "0x1",
+      "destTokenAddress": "0x0000000000000000000000000000000000000000",
+      "insufficientBal": false,
+      "resetApproval": false,
+      "srcChainId": "0xa",
+      "srcTokenAddress": "0x4200000000000000000000000000000000000006",
+      "srcTokenAmount": "991250000000000000",
+      "walletAddress": "eip:id/id:id/0x123",
+    },
+  ],
   "quoteStreamComplete": null,
   "quotesInitialLoadTime": 10000,
   "quotesLoadingStatus": 1,
@@ -503,7 +507,7 @@ exports[`BridgeController updateBridgeQuoteRequestParams should only poll once i
       "chain_id_destination": "eip155:10",
       "chain_id_source": "eip155:1",
       "custom_slippage": true,
-      "has_sufficient_funds": true,
+      "has_sufficient_funds": false,
       "is_hardware_wallet": false,
       "location": "Main View",
       "security_warnings": [],
@@ -827,17 +831,20 @@ exports[`BridgeController updateBridgeQuoteRequestParams should trigger quote po
   "assetExchangeRates": {},
   "minimumBalanceForRentExemptionInLamports": "0",
   "quoteFetchError": null,
-  "quoteRequest": {
-    "destChainId": "solana:5eykt4UsFv8P8NJdTREpY1vzqKqZKvdp",
-    "destTokenAddress": "123d1",
-    "destWalletAddress": "SolanaWalletAddres1234",
-    "insufficientBal": false,
-    "slippage": 0.5,
-    "srcChainId": "0x1",
-    "srcTokenAddress": "0x0000000000000000000000000000000000000000",
-    "srcTokenAmount": "10",
-    "walletAddress": "0x123",
-  },
+  "quoteRequest": [
+    {
+      "destChainId": "solana:5eykt4UsFv8P8NJdTREpY1vzqKqZKvdp",
+      "destTokenAddress": "123d1",
+      "destWalletAddress": "SolanaWalletAddres1234",
+      "insufficientBal": false,
+      "resetApproval": false,
+      "slippage": 0.5,
+      "srcChainId": "0x1",
+      "srcTokenAddress": "0x0000000000000000000000000000000000000000",
+      "srcTokenAmount": "10",
+      "walletAddress": "0x123",
+    },
+  ],
   "quoteStreamComplete": null,
   "quotes": [],
   "quotesInitialLoadTime": null,
@@ -859,18 +866,20 @@ exports[`BridgeController updateBridgeQuoteRequestParams should trigger quote po
   },
   "minimumBalanceForRentExemptionInLamports": "0",
   "quoteFetchError": null,
-  "quoteRequest": {
-    "destChainId": "solana:5eykt4UsFv8P8NJdTREpY1vzqKqZKvdp",
-    "destTokenAddress": "123d1",
-    "destWalletAddress": "SolanaWalletAddres1234",
-    "insufficientBal": false,
-    "resetApproval": false,
-    "slippage": 0.5,
-    "srcChainId": "0x1",
-    "srcTokenAddress": "0x0000000000000000000000000000000000000000",
-    "srcTokenAmount": "10",
-    "walletAddress": "0x123",
-  },
+  "quoteRequest": [
+    {
+      "destChainId": "solana:5eykt4UsFv8P8NJdTREpY1vzqKqZKvdp",
+      "destTokenAddress": "123d1",
+      "destWalletAddress": "SolanaWalletAddres1234",
+      "insufficientBal": false,
+      "resetApproval": false,
+      "slippage": 0.5,
+      "srcChainId": "0x1",
+      "srcTokenAddress": "0x0000000000000000000000000000000000000000",
+      "srcTokenAmount": "10",
+      "walletAddress": "0x123",
+    },
+  ],
   "quoteStreamComplete": null,
   "quotesInitialLoadTime": 10000,
   "quotesLoadingStatus": 1,