feat: stream swap quotes using server-sent events

packages/bridge-controller/CHANGELOG.md

@@ -7,6 +7,26 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+### Added
+
+- Introduce server‑sent events quote streaming and integrates incremental quote updates into the bridge controller polling flow ([#6760](https://github.com/MetaMask/core/pull/6760))
+  - Add private `getQuoteStreaming` handler that calls `getQuoteStream` when the `sseEnabled` flag is enabled in LaunchDarkly
+  - Reuse existing polling, metrics and validation utilities when processing server-sent quotes
+- Add dependency on `@microsoft/fetch-event-source` at `^2.0.1` ([#6760](https://github.com/MetaMask/core/pull/6760))
+  - Note that clients need to patch this library such that it rejects instead of resolving when the quote request is cancelled. This preserves the controller's expected request cancellation behavior
+
+### Changed
+
+- Extract some logic from bridge-controller and move them to utility files for better readability ([#6760](https://github.com/MetaMask/core/pull/6760))
+
+### Removed
+
+- Remove cache options from spot-prices and getQuote api calls since they are only required by the extension client ([#6760](https://github.com/MetaMask/core/pull/6760))
+
+### Fixed
+
+- Pass abortSignal to fetchAssetPricesForCurrency in order to cancel exchange rate fetching when quote parameters change ([#6760](https://github.com/MetaMask/core/pull/6760))
+
 ## [50.0.0]
 
 ### Changed

packages/bridge-controller/package.json

@@ -60,6 +60,7 @@
     "@metamask/multichain-network-controller": "^1.0.1",
     "@metamask/polling-controller": "^14.0.1",
     "@metamask/utils": "^11.8.1",
+    "@microsoft/fetch-event-source": "^2.0.1",
     "bignumber.js": "^9.1.2",
     "reselect": "^5.1.1",
     "uuid": "^8.3.2"

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

@@ -0,0 +1,224 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`BridgeController SSE should publish validation failures 3`] = `
+Array [
+  Array [
+    "Unified SwapBridge Quotes Failed Validation",
+    Object {
+      "action_type": "swapbridge-v1",
+      "chain_id_destination": "solana:5eykt4UsFv8P8NJdTREpY1vzqKqZKvdp",
+      "chain_id_source": "eip155:1",
+      "failures": Array [
+        "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",
+      ],
+      "refresh_count": 1,
+      "token_address_destination": "solana:5eykt4UsFv8P8NJdTREpY1vzqKqZKvdp/token:123d1",
+      "token_address_source": "eip155:1/slip44:60",
+    },
+  ],
+  Array [
+    "Unified SwapBridge Quotes Failed Validation",
+    Object {
+      "action_type": "swapbridge-v1",
+      "chain_id_destination": "solana:5eykt4UsFv8P8NJdTREpY1vzqKqZKvdp",
+      "chain_id_source": "eip155:1",
+      "failures": Array [
+        "unknown|quote",
+      ],
+      "refresh_count": 2,
+      "token_address_destination": "solana:5eykt4UsFv8P8NJdTREpY1vzqKqZKvdp/token:123d1",
+      "token_address_source": "eip155:1/slip44:60",
+    },
+  ],
+]
+`;
+
+exports[`BridgeController SSE should replace all stale quotes after a refresh and first quote is received 1`] = `
+Array [
+  "Unified SwapBridge Quotes Requested",
+  Object {
+    "action_type": "swapbridge-v1",
+    "chain_id_destination": "solana:5eykt4UsFv8P8NJdTREpY1vzqKqZKvdp",
+    "chain_id_source": "eip155:1",
+    "custom_slippage": true,
+    "has_sufficient_funds": true,
+    "is_hardware_wallet": false,
+    "security_warnings": Array [],
+    "slippage_limit": 0.5,
+    "stx_enabled": true,
+    "swap_type": "crosschain",
+    "token_address_destination": "solana:5eykt4UsFv8P8NJdTREpY1vzqKqZKvdp/token:123d1",
+    "token_address_source": "eip155:1/slip44:60",
+    "token_symbol_destination": "USDC",
+    "token_symbol_source": "ETH",
+    "usd_amount_source": 100,
+    "warnings": Array [],
+  },
+]
+`;
+
+exports[`BridgeController SSE should reset and refetch quotes after quote request is changed 1`] = `
+Array [
+  Array [
+    "Unified SwapBridge Quotes Requested",
+    Object {
+      "action_type": "swapbridge-v1",
+      "chain_id_destination": "solana:5eykt4UsFv8P8NJdTREpY1vzqKqZKvdp",
+      "chain_id_source": "eip155:1",
+      "custom_slippage": true,
+      "has_sufficient_funds": true,
+      "is_hardware_wallet": false,
+      "security_warnings": Array [],
+      "slippage_limit": 0.5,
+      "stx_enabled": true,
+      "swap_type": "crosschain",
+      "token_address_destination": "solana:5eykt4UsFv8P8NJdTREpY1vzqKqZKvdp/token:123d1",
+      "token_address_source": "eip155:1/slip44:60",
+      "token_symbol_destination": "USDC",
+      "token_symbol_source": "ETH",
+    },
+  ],
+]
+`;
+
+exports[`BridgeController SSE should reset quotes list if quote refresh fails 2`] = `
+Array [
+  Array [
+    "Unified SwapBridge Quotes Requested",
+    Object {
+      "action_type": "swapbridge-v1",
+      "chain_id_destination": "solana:5eykt4UsFv8P8NJdTREpY1vzqKqZKvdp",
+      "chain_id_source": "eip155:1",
+      "custom_slippage": true,
+      "has_sufficient_funds": true,
+      "is_hardware_wallet": false,
+      "security_warnings": Array [],
+      "slippage_limit": 0.5,
+      "stx_enabled": true,
+      "swap_type": "crosschain",
+      "token_address_destination": "solana:5eykt4UsFv8P8NJdTREpY1vzqKqZKvdp/token:123d1",
+      "token_address_source": "eip155:1/slip44:60",
+      "token_symbol_destination": "USDC",
+      "token_symbol_source": "ETH",
+      "usd_amount_source": 100,
+      "warnings": Array [],
+    },
+  ],
+  Array [
+    "Unified SwapBridge Quotes Error",
+    Object {
+      "action_type": "swapbridge-v1",
+      "chain_id_destination": "solana:5eykt4UsFv8P8NJdTREpY1vzqKqZKvdp",
+      "chain_id_source": "eip155:1",
+      "custom_slippage": true,
+      "error_message": "Network error",
+      "has_sufficient_funds": true,
+      "is_hardware_wallet": false,
+      "security_warnings": Array [],
+      "slippage_limit": 0.5,
+      "stx_enabled": true,
+      "swap_type": "crosschain",
+      "token_address_destination": "solana:5eykt4UsFv8P8NJdTREpY1vzqKqZKvdp/token:123d1",
+      "token_address_source": "eip155:1/slip44:60",
+      "token_symbol_destination": "USDC",
+      "token_symbol_source": "ETH",
+      "usd_amount_source": 100,
+      "warnings": Array [],
+    },
+  ],
+]
+`;
+
+exports[`BridgeController SSE should trigger quote polling if request is valid 1`] = `
+Object {
+  "assetExchangeRates": Object {
+    "eip155:10/erc20:0x1f9840a85d5af5bf1d1762f925bdaddc4201f984": Object {
+      "exchangeRate": undefined,
+      "usdExchangeRate": "100",
+    },
+  },
+  "minimumBalanceForRentExemptionInLamports": "0",
+  "quoteFetchError": null,
+  "quoteRequest": Object {
+    "destChainId": "solana:5eykt4UsFv8P8NJdTREpY1vzqKqZKvdp",
+    "destTokenAddress": "123d1",
+    "destWalletAddress": "SolanaWalletAddres1234",
+    "insufficientBal": false,
+    "slippage": 0.5,
+    "srcChainId": "0x1",
+    "srcTokenAddress": "0x0000000000000000000000000000000000000000",
+    "srcTokenAmount": "1000000000000000000",
+    "walletAddress": "0x30E8ccaD5A980BDF30447f8c2C48e70989D9d294",
+  },
+  "quotes": Array [],
+  "quotesInitialLoadTime": null,
+  "quotesLoadingStatus": 0,
+  "quotesRefreshCount": 0,
+}
+`;
+
+exports[`BridgeController SSE should trigger quote polling if request is valid 2`] = `
+Array [
+  Array [
+    "Unified SwapBridge Input Changed",
+    Object {
+      "action_type": "swapbridge-v1",
+      "input": "chain_source",
+      "input_value": "eip155:1",
+    },
+  ],
+  Array [
+    "Unified SwapBridge Input Changed",
+    Object {
+      "action_type": "swapbridge-v1",
+      "input": "chain_destination",
+      "input_value": "solana:5eykt4UsFv8P8NJdTREpY1vzqKqZKvdp",
+    },
+  ],
+  Array [
+    "Unified SwapBridge Input Changed",
+    Object {
+      "action_type": "swapbridge-v1",
+      "input": "token_destination",
+      "input_value": "solana:5eykt4UsFv8P8NJdTREpY1vzqKqZKvdp/token:123d1",
+    },
+  ],
+  Array [
+    "Unified SwapBridge Input Changed",
+    Object {
+      "action_type": "swapbridge-v1",
+      "input": "slippage",
+      "input_value": 0.5,
+    },
+  ],
+  Array [
+    "Unified SwapBridge Quotes Requested",
+    Object {
+      "action_type": "swapbridge-v1",
+      "chain_id_destination": "solana:5eykt4UsFv8P8NJdTREpY1vzqKqZKvdp",
+      "chain_id_source": "eip155:1",
+      "custom_slippage": true,
+      "has_sufficient_funds": true,
+      "is_hardware_wallet": false,
+      "security_warnings": Array [],
+      "slippage_limit": 0.5,
+      "stx_enabled": true,
+      "swap_type": "crosschain",
+      "token_address_destination": "solana:5eykt4UsFv8P8NJdTREpY1vzqKqZKvdp/token:123d1",
+      "token_address_source": "eip155:1/slip44:60",
+      "token_symbol_destination": "USDC",
+      "token_symbol_source": "ETH",
+      "usd_amount_source": 100,
+      "warnings": Array [],
+    },
+  ],
+]
+`;