feat: resolve swap quote metadata by migration phase

packages/bridge-controller/CHANGELOG.md

@@ -17,6 +17,17 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Changed
 
+- **BREAKING:** Add `migrationPhase` to selector params, which determines how metadata is resolved ([#9744](https://github.com/MetaMask/core/pull/9744))
+  - Phase 1 omits V2 quoteMetadata derived from the quotes response. Legacy metadata is served to the clients
+  - Phase 1.5 includes V2 quoteMetadata but falls back to legacy metadata
+  - Phase 2 omits legacy metadata from the quotes and enables removal of deprecated metadata utils
+- **BREAKING:** Use QuoteResponse V2 within the BridgeController; this affects the batch-sell, unified swap/bridge and quickBuy experiences ([#9726](https://github.com/MetaMask/core/pull/9726))
+  - convert quotes to QuoteResponse v2 in `fetchBridgeQuoteStream`
+  - store quotes as QuoteResponse v2 in the BridgeController
+  - `QuoteResponse` export now means v2; v1 is still exported as `QuoteResponseV1`
+  - `fetchBridgeQuoteStream` and `fetchBatchSellTrades` now return `QuoteResponse` v2
+  - `fetchBatchSellTrades` expects V2 quotes, then transforms them to V1 for backend compatibility
+- **BREAKING:** `appendFeesToQuotes` interface now requires a chainId parameter, but still accepts both V1 and V2 quotes ([#9726](https://github.com/MetaMask/core/pull/9726))
 - Update `calcQuoteMetadata` util to handle both V1 and V2 quotes. Legacy metadata calculators continue to use the V1 schema ([#9727](https://github.com/MetaMask/core/pull/9727))
 - Bump `@metamask/transaction-controller` from `^69.4.0` to `^69.5.0` ([#9780](https://github.com/MetaMask/core/pull/9780))
 

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

@@ -9,18 +9,15 @@ exports[`BridgeController SSE should publish validation failures 4`] = `
       "chain_id_destination": "solana:5eykt4UsFv8P8NJdTREpY1vzqKqZKvdp",
       "chain_id_source": "eip155:1",
       "failures": [
-        "lifi|trade",
-        "lifi|trade.chainId",
-        "lifi|trade.to",
-        "lifi|trade.from",
-        "lifi|trade.value",
-        "lifi|trade.data",
-        "lifi|trade.gasLimit",
-        "lifi|trade.unsignedPsbtBase64",
-        "lifi|trade.inputsToSign",
-        "lifi|trade.raw_data_hex",
-        "lifi|trade.xdrBase64",
-        "lifi|trade.xdr",
+        "lifi|quote.src",
+        "lifi|quote.dest",
+        "lifi|quote.feeData.metabridge",
+        "lifi|quote.aggregator",
+        "lifi|quote.protocols",
+        "lifi|quote.steps.0.src",
+        "lifi|quote.steps.0.dest",
+        "lifi|quote.steps.1.src",
+        "lifi|quote.steps.1.dest",
       ],
       "feature_id": "unified_swap_bridge",
       "location": "Unknown",

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

@@ -7,8 +7,14 @@ import type {
 } from '@metamask/messenger';
 
 import { flushPromises } from '../../../tests/helpers.js';
-import { mockBridgeQuotesErc20Erc20V1 } from '../tests/mock-quotes-erc20-erc20.js';
-import { mockBridgeQuotesNativeErc20V1 } from '../tests/mock-quotes-native-erc20.js';
+import {
+  getMockBridgeQuotesErc20Erc20V2,
+  mockBridgeQuotesErc20Erc20V1,
+} from '../tests/mock-quotes-erc20-erc20.js';
+import {
+  getMockBridgeQuotesNativeErc20V2,
+  mockBridgeQuotesNativeErc20V1,
+} from '../tests/mock-quotes-native-erc20.js';
 import {
   advanceToNthTimerThenFlush,
   mockSseBatchSellEventSource,
@@ -419,7 +425,7 @@ describe('BridgeController BatchSell (multiple quote requests) SSE', function ()
                 resetApproval: false,
               },
             ],
-            quotes: mockBridgeQuotesNativeErc20V1
+            quotes: getMockBridgeQuotesNativeErc20V2()
               .map((quote) => ({
                 ...quote,
                 l1GasFeesInHexWei: '0x1',
@@ -428,13 +434,15 @@ describe('BridgeController BatchSell (multiple quote requests) SSE', function ()
                 featureId: FeatureId.BATCH_SELL,
               }))
               .concat(
-                mockBridgeQuotesErc20Erc20V1.map((quote) => ({
-                  ...quote,
-                  l1GasFeesInHexWei: '0x2',
-                  resetApproval: undefined,
-                  quoteRequestIndex: 1,
-                  featureId: FeatureId.BATCH_SELL,
-                })),
+                getMockBridgeQuotesErc20Erc20V2({ quoteRequestIndex: 1 }).map(
+                  (quote) => ({
+                    ...quote,
+                    l1GasFeesInHexWei: '0x2',
+                    resetApproval: undefined,
+                    quoteRequestIndex: 1,
+                    featureId: FeatureId.BATCH_SELL,
+                  }),
+                ),
               ),
             quotesRefreshCount: 1,
             quotesLoadingStatus: 1,
@@ -642,7 +650,7 @@ describe('BridgeController BatchSell (multiple quote requests) SSE', function ()
           );
           await rootMessenger.call(
             'BridgeController:updateBatchSellTrades',
-            mockBridgeQuotesErc20Erc20V1,
+            getMockBridgeQuotesErc20Erc20V2(),
             false,
           );
 
@@ -682,7 +690,7 @@ describe('BridgeController BatchSell (multiple quote requests) SSE', function ()
             '13.8.0',
           ]);
           expect(fetchBatchSellTradesSpy.mock.calls[1]).toStrictEqual([
-            mockBridgeQuotesErc20Erc20V1,
+            getMockBridgeQuotesErc20Erc20V2(),
             false,
             expect.any(AbortSignal),
             'extension',
@@ -879,7 +887,7 @@ describe('BridgeController BatchSell (multiple quote requests) SSE', function ()
           // 2nd fetch
           await rootMessenger.call(
             'BridgeController:updateBatchSellTrades',
-            mockBridgeQuotesErc20Erc20V1,
+            getMockBridgeQuotesErc20Erc20V2(),
             false,
           );
 
@@ -889,7 +897,7 @@ describe('BridgeController BatchSell (multiple quote requests) SSE', function ()
           expect(stopAllPollingSpy).toHaveBeenCalledTimes(0);
           expect(abortControllerSpy).toHaveBeenCalledTimes(1);
           expect(fetchBatchSellTradesSpy.mock.calls[1][0]).toStrictEqual(
-            mockBridgeQuotesErc20Erc20V1,
+            getMockBridgeQuotesErc20Erc20V2(),
           );
           expect(startPollingSpy).not.toHaveBeenCalled();
           expect(bridgeController.state.batchSellTrades).toBeNull();