feat(swaps): track input primary denomination

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@metamask/core-monorepo",
-  "version": "1057.0.0",
+  "version": "1058.0.0",
   "private": true,
   "description": "Monorepo for packages shared between MetaMask clients",
   "repository": {

packages/bridge-controller/CHANGELOG.md

@@ -9,6 +9,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Added
 
+- Add persisted input primary denomination state and `Unified SwapBridge Fiat Crypto Toggle Clicked` analytics event support ([#9147](https://github.com/MetaMask/core/pull/9147))
 - Add optional `environment_type` property to the `ButtonClicked` unified swap/bridge event context ([#9121](https://github.com/MetaMask/core/pull/9121))
 
 ### Changed
@@ -21,6 +22,12 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Bump `@metamask/transaction-controller` from `^67.1.0` to `^68.1.0` ([#9089](https://github.com/MetaMask/core/pull/9089), [#9177](https://github.com/MetaMask/core/pull/9177), [#9203](https://github.com/MetaMask/core/pull/9203))
 - Bump `@metamask/profile-sync-controller` from `^28.1.1` to `^28.2.0` ([#9119](https://github.com/MetaMask/core/pull/9119))
 
+## [75.2.0]
+
+### Added
+
+- Add persisted input primary denomination state and `Unified SwapBridge Fiat Crypto Toggle Clicked` analytics event support ([#9147](https://github.com/MetaMask/core/pull/9147))
+
 ## [75.1.1]
 
 ### Changed
@@ -1612,7 +1619,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 - Initial release ([#5317](https://github.com/MetaMask/core/pull/5317))
 
-[Unreleased]: https://github.com/MetaMask/core/compare/@metamask/bridge-controller@75.1.1...HEAD
+[Unreleased]: https://github.com/MetaMask/core/compare/@metamask/bridge-controller@75.2.0...HEAD
+[75.2.0]: https://github.com/MetaMask/core/compare/@metamask/bridge-controller@75.1.1...@metamask/bridge-controller@75.2.0
 [75.1.1]: https://github.com/MetaMask/core/compare/@metamask/bridge-controller@75.1.0...@metamask/bridge-controller@75.1.1
 [75.1.0]: https://github.com/MetaMask/core/compare/@metamask/bridge-controller@75.0.0...@metamask/bridge-controller@75.1.0
 [75.0.0]: https://github.com/MetaMask/core/compare/@metamask/bridge-controller@74.0.0...@metamask/bridge-controller@75.0.0

packages/bridge-controller/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@metamask/bridge-controller",
-  "version": "75.1.1",
+  "version": "75.2.0",
   "description": "Manages bridge-related quote fetching functionality for MetaMask",
   "keywords": [
     "Ethereum",

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

@@ -10,6 +10,7 @@ exports[`BridgeController BatchSell (multiple quote requests) SSE fetch quotes s
   },
   "batchSellTrades": null,
   "batchSellTradesLoadingStatus": 0,
+  "inputPrimaryDenomination": "token_amount",
   "minimumBalanceForRentExemptionInLamports": "0",
   "quoteFetchError": null,
   "quoteRequest": [
@@ -112,6 +113,7 @@ exports[`BridgeController BatchSell (multiple quote requests) SSE fetch quotes s
       "custom_slippage": true,
       "feature_id": "batch_sell",
       "has_sufficient_funds": true,
+      "input_primary_denomination": "token_amount",
       "is_hardware_wallet": false,
       "location": "Main View",
       "security_warnings": [],

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

@@ -76,6 +76,7 @@ exports[`BridgeController SSE should replace all stale quotes after a refresh an
     "custom_slippage": true,
     "feature_id": "unified_swap_bridge",
     "has_sufficient_funds": true,
+    "input_primary_denomination": "token_amount",
     "is_hardware_wallet": false,
     "location": "Main View",
     "security_warnings": [],
@@ -105,6 +106,7 @@ exports[`BridgeController SSE should reset and refetch quotes after quote reques
       "custom_slippage": true,
       "feature_id": "unified_swap_bridge",
       "has_sufficient_funds": false,
+      "input_primary_denomination": "token_amount",
       "is_hardware_wallet": false,
       "location": "Main View",
       "security_warnings": [],
@@ -134,6 +136,7 @@ exports[`BridgeController SSE should reset quotes list if quote refresh fails 2`
       "custom_slippage": true,
       "feature_id": "unified_swap_bridge",
       "has_sufficient_funds": true,
+      "input_primary_denomination": "token_amount",
       "is_hardware_wallet": false,
       "location": "Main View",
       "security_warnings": [],
@@ -188,6 +191,7 @@ exports[`BridgeController SSE should rethrow error from server 1`] = `
   },
   "batchSellTrades": null,
   "batchSellTradesLoadingStatus": null,
+  "inputPrimaryDenomination": "token_amount",
   "minimumBalanceForRentExemptionInLamports": "0",
   "quoteFetchError": null,
   "quoteRequest": [
@@ -266,6 +270,7 @@ exports[`BridgeController SSE should rethrow error from server 3`] = `
       "custom_slippage": true,
       "feature_id": "unified_swap_bridge",
       "has_sufficient_funds": true,
+      "input_primary_denomination": "token_amount",
       "is_hardware_wallet": false,
       "location": "Main View",
       "security_warnings": [],
@@ -320,6 +325,7 @@ exports[`BridgeController SSE should trigger quote polling if request is valid 1
   },
   "batchSellTrades": null,
   "batchSellTradesLoadingStatus": null,
+  "inputPrimaryDenomination": "token_amount",
   "minimumBalanceForRentExemptionInLamports": "0",
   "quoteFetchError": null,
   "quoteRequest": [
@@ -398,6 +404,7 @@ exports[`BridgeController SSE should trigger quote polling if request is valid 2
       "custom_slippage": true,
       "feature_id": "unified_swap_bridge",
       "has_sufficient_funds": true,
+      "input_primary_denomination": "token_amount",
       "is_hardware_wallet": false,
       "location": "Main View",
       "security_warnings": [],

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

@@ -10,6 +10,7 @@ exports[`BridgeController should handle errors from fetchBridgeQuotes 1`] = `
   },
   "batchSellTrades": null,
   "batchSellTradesLoadingStatus": null,
+  "inputPrimaryDenomination": "token_amount",
   "minimumBalanceForRentExemptionInLamports": "0",
   "quoteFetchError": null,
   "quoteRequest": [
@@ -43,6 +44,7 @@ exports[`BridgeController should handle errors from fetchBridgeQuotes 2`] = `
   },
   "batchSellTrades": null,
   "batchSellTradesLoadingStatus": null,
+  "inputPrimaryDenomination": "token_amount",
   "minimumBalanceForRentExemptionInLamports": "0",
   "quoteFetchError": null,
   "quoteRequest": [
@@ -345,6 +347,29 @@ exports[`BridgeController trackUnifiedSwapBridgeEvent client-side calls should t
 ]
 `;
 
+exports[`BridgeController trackUnifiedSwapBridgeEvent client-side calls should track the FiatCryptoToggleClicked event 1`] = `
+[
+  [
+    "Unified SwapBridge Fiat Crypto Toggle Clicked",
+    {
+      "action_type": "swapbridge-v1",
+      "chain_id_destination": "eip155:1",
+      "chain_id_source": "eip155:1",
+      "feature_id": "quick_buy_follow_trading",
+      "location": "Main View",
+      "new_primary_denomination": "fiat_value",
+      "previous_primary_denomination": "token_amount",
+      "swap_type": "single_chain",
+      "token_address_destination": "eip155:1/erc20:0xdAC17F958D2ee523a2206206994597C13D831ec7",
+      "token_address_source": "eip155:1/slip44:60",
+      "token_security_type_destination": null,
+      "token_symbol_destination": "USDC",
+      "token_symbol_source": "ETH",
+    },
+  ],
+]
+`;
+
 exports[`BridgeController trackUnifiedSwapBridgeEvent client-side calls should track the InputSourceDestinationFlipped event 1`] = `
 [
   [
@@ -379,6 +404,7 @@ exports[`BridgeController trackUnifiedSwapBridgeEvent client-side calls should t
       "chain_id_source": "eip155:1",
       "custom_slippage": false,
       "feature_id": "quick_buy_token_details",
+      "input_primary_denomination": "token_amount",
       "is_hardware_wallet": false,
       "location": "Main View",
       "slippage_limit": undefined,
@@ -454,6 +480,7 @@ exports[`BridgeController trackUnifiedSwapBridgeEvent client-side calls should t
       "gas_included_7702": false,
       "has_gas_included_quote": false,
       "initial_load_time_all_quotes": 0,
+      "input_primary_denomination": "token_amount",
       "is_hardware_wallet": false,
       "location": "Main View",
       "price_impact": 0,
@@ -530,6 +557,7 @@ exports[`BridgeController updateBridgeQuoteRequestParams should only poll once i
       "custom_slippage": true,
       "feature_id": "unified_swap_bridge",
       "has_sufficient_funds": false,
+      "input_primary_denomination": "token_amount",
       "is_hardware_wallet": false,
       "location": "Main View",
       "security_warnings": [],
@@ -560,6 +588,7 @@ exports[`BridgeController updateBridgeQuoteRequestParams should only poll once i
       "gas_included_7702": false,
       "has_gas_included_quote": false,
       "initial_load_time_all_quotes": 11000,
+      "input_primary_denomination": "token_amount",
       "is_hardware_wallet": false,
       "location": "Main View",
       "price_impact": 0,
@@ -854,6 +883,7 @@ exports[`BridgeController updateBridgeQuoteRequestParams should trigger quote po
   "assetExchangeRates": {},
   "batchSellTrades": null,
   "batchSellTradesLoadingStatus": null,
+  "inputPrimaryDenomination": "token_amount",
   "minimumBalanceForRentExemptionInLamports": "0",
   "quoteFetchError": null,
   "quoteRequest": [
@@ -891,6 +921,7 @@ exports[`BridgeController updateBridgeQuoteRequestParams should trigger quote po
   },
   "batchSellTrades": null,
   "batchSellTradesLoadingStatus": null,
+  "inputPrimaryDenomination": "token_amount",
   "minimumBalanceForRentExemptionInLamports": "0",
   "quoteFetchError": null,
   "quoteRequest": [
@@ -968,6 +999,7 @@ exports[`BridgeController updateBridgeQuoteRequestParams should trigger quote po
       "custom_slippage": true,
       "feature_id": "unified_swap_bridge",
       "has_sufficient_funds": true,
+      "input_primary_denomination": "token_amount",
       "is_hardware_wallet": false,
       "location": "Main View",
       "security_warnings": [],
@@ -993,6 +1025,7 @@ exports[`BridgeController updateBridgeQuoteRequestParams should trigger quote po
       "custom_slippage": true,
       "feature_id": "unified_swap_bridge",
       "has_sufficient_funds": true,
+      "input_primary_denomination": "token_amount",
       "is_hardware_wallet": false,
       "location": "Main View",
       "security_warnings": [],
@@ -1018,6 +1051,7 @@ exports[`BridgeController updateBridgeQuoteRequestParams should trigger quote po
       "custom_slippage": true,
       "feature_id": "unified_swap_bridge",
       "has_sufficient_funds": true,
+      "input_primary_denomination": "token_amount",
       "is_hardware_wallet": false,
       "location": "Main View",
       "security_warnings": [],
@@ -1069,6 +1103,7 @@ exports[`BridgeController updateBridgeQuoteRequestParams should trigger quote po
       "custom_slippage": true,
       "feature_id": "unified_swap_bridge",
       "has_sufficient_funds": true,
+      "input_primary_denomination": "token_amount",
       "is_hardware_wallet": false,
       "location": "Main View",
       "security_warnings": [],

packages/bridge-controller/src/bridge-controller-method-action-types.ts

@@ -25,6 +25,11 @@ export type BridgeControllerSetLocationAction = {
   handler: BridgeController['setLocation'];
 };
 
+export type BridgeControllerSetInputPrimaryDenominationAction = {
+  type: `BridgeController:setInputPrimaryDenomination`;
+  handler: BridgeController['setInputPrimaryDenomination'];
+};
+
 export type BridgeControllerResetStateAction = {
   type: `BridgeController:resetState`;
   handler: BridgeController['resetState'];
@@ -53,6 +58,7 @@ export type BridgeControllerMethodActions =
   | BridgeControllerFetchQuotesAction
   | BridgeControllerStopPollingForQuotesAction
   | BridgeControllerSetLocationAction
+  | BridgeControllerSetInputPrimaryDenominationAction
   | BridgeControllerResetStateAction
   | BridgeControllerSetChainIntervalLengthAction
   | BridgeControllerTrackUnifiedSwapBridgeEventAction

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

@@ -3013,6 +3013,56 @@ describe('BridgeController', function () {
       });
     });
 
+    it('should track the FiatCryptoToggleClicked event', async () => {
+      await withController(async ({ rootMessenger, controller }) => {
+        jest.spyOn(console, 'warn').mockImplementationOnce(jest.fn());
+        await rootMessenger.call(
+          'BridgeController:updateBridgeQuoteRequestParams',
+          {
+            walletAddress: '0x123',
+          },
+          {
+            stx_enabled: false,
+            security_warnings: [],
+            token_symbol_source: 'ETH',
+            token_symbol_destination: 'USDC',
+            usd_amount_source: 100,
+            token_security_type_destination: null,
+            feature_id: FeatureId.QUICK_BUY_FOLLOW_TRADING,
+          },
+        );
+        rootMessenger.call(
+          'BridgeController:setInputPrimaryDenomination',
+          'fiat_value',
+        );
+        expect(controller.state.inputPrimaryDenomination).toBe('fiat_value');
+        jest.clearAllMocks();
+        rootMessenger.call(
+          'BridgeController:trackUnifiedSwapBridgeEvent',
+          UnifiedSwapBridgeEventName.FiatCryptoToggleClicked,
+          {
+            location: MetaMetricsSwapsEventSource.MainView,
+            previous_primary_denomination: 'token_amount',
+            new_primary_denomination: 'fiat_value',
+            token_symbol_source: 'ETH',
+            token_symbol_destination: 'USDC',
+            chain_id_source: formatChainIdToCaip(ChainId.ETH),
+            chain_id_destination: formatChainIdToCaip(ChainId.ETH),
+            token_address_source: formatAddressToAssetId('', ChainId.ETH),
+            token_address_destination: formatAddressToAssetId(
+              ETH_USDT_ADDRESS,
+              ChainId.ETH,
+            ),
+            token_security_type_destination: null,
+            swap_type: MetricsSwapType.SINGLE,
+            feature_id: FeatureId.QUICK_BUY_FOLLOW_TRADING,
+          },
+        );
+        expect(trackMetaMetricsFn).toHaveBeenCalledTimes(1);
+        expect(trackMetaMetricsFn.mock.calls).toMatchSnapshot();
+      });
+    });
+
     it('should track InputChanged with an enum quick amount preset label', async () => {
       await withController(async ({ rootMessenger }) => {
         // Ignore console.warn for this test bc there will be expected asset rate fetching warnings
@@ -4342,6 +4392,7 @@ describe('BridgeController', function () {
             "assetExchangeRates": {},
             "batchSellTrades": null,
             "batchSellTradesLoadingStatus": null,
+            "inputPrimaryDenomination": "token_amount",
             "minimumBalanceForRentExemptionInLamports": "0",
             "quoteFetchError": null,
             "quoteRequest": [
@@ -4370,7 +4421,11 @@ describe('BridgeController', function () {
             bridgeController.metadata,
             'persist',
           ),
-        ).toMatchInlineSnapshot(`{}`);
+        ).toMatchInlineSnapshot(`
+          {
+            "inputPrimaryDenomination": "token_amount",
+          }
+        `);
       });
     });
 
@@ -4387,6 +4442,7 @@ describe('BridgeController', function () {
             "assetExchangeRates": {},
             "batchSellTrades": null,
             "batchSellTradesLoadingStatus": null,
+            "inputPrimaryDenomination": "token_amount",
             "minimumBalanceForRentExemptionInLamports": "0",
             "quoteFetchError": null,
             "quoteRequest": [