fix: swap tx status events

packages/bridge-controller/CHANGELOG.md

@@ -7,6 +7,11 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+### Fixed
+
+- Set correct `can_submit` property on Unified SwapBridge events ([#5993](https://github.com/MetaMask/core/pull/5993))
+- Use activeQuote to populate default properties for Submitted and Failed events, if tx fails before being confirmed on chain ([#5993](https://github.com/MetaMask/core/pull/5993))
+
 ## [33.0.0]
 
 ### Added

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

@@ -96,17 +96,22 @@ Array [
       "actual_time_minutes": 10,
       "allowance_reset_transaction": "PENDING",
       "approval_transaction": "PENDING",
+      "can_submit": true,
       "chain_id_destination": "solana:5eykt4UsFv8P8NJdTREpY1vzqKqZKvdp",
       "chain_id_source": "eip155:1",
       "custom_slippage": true,
       "destination_transaction": "PENDING",
       "error_message": "error_message",
       "gas_included": false,
+      "initial_load_time_all_quotes": 0,
       "is_hardware_wallet": false,
       "price_impact": 0,
       "provider": "provider_bridge",
       "quoted_time_minutes": 0,
+      "quotes_count": 0,
+      "quotes_list": Array [],
       "security_warnings": Array [],
+      "slippage_limit": undefined,
       "source_transaction": "PENDING",
       "stx_enabled": false,
       "swap_type": "crosschain",
@@ -122,6 +127,43 @@ Array [
 ]
 `;
 
+exports[`BridgeController trackUnifiedSwapBridgeEvent bridge-status-controller calls should track the Failed event before tx is submitted 1`] = `
+Array [
+  Array [
+    "Unified SwapBridge Failed",
+    Object {
+      "action_type": "crosschain-v1",
+      "can_submit": true,
+      "chain_id_destination": "eip155:1",
+      "chain_id_source": "solana:5eykt4UsFv8P8NJdTREpY1vzqKqZKvdp",
+      "custom_slippage": true,
+      "error_message": "Failed to submit tx",
+      "gas_included": false,
+      "initial_load_time_all_quotes": 0,
+      "is_hardware_wallet": false,
+      "price_impact": 12,
+      "provider": "provider_bridge",
+      "quoted_time_minutes": 2,
+      "quotes_count": 2,
+      "quotes_list": Array [
+        "lifi_mayan",
+        "lifi_mayanMCTP",
+      ],
+      "slippage_limit": 0.5,
+      "stx_enabled": false,
+      "swap_type": "crosschain",
+      "token_address_destination": "eip155:1/erc20:0x1234",
+      "token_address_source": "solana:5eykt4UsFv8P8NJdTREpY1vzqKqZKvdp/token:NATIVE",
+      "token_symbol_destination": "USDC",
+      "token_symbol_source": "ETH",
+      "usd_amount_source": 100,
+      "usd_quoted_gas": 1,
+      "usd_quoted_return": 113,
+    },
+  ],
+]
+`;
+
 exports[`BridgeController trackUnifiedSwapBridgeEvent bridge-status-controller calls should track the SnapConfirmationViewed event 1`] = `
 Array [
   Array [
@@ -153,24 +195,31 @@ Array [
     "Unified SwapBridge Submitted",
     Object {
       "action_type": "crosschain-v1",
+      "can_submit": true,
       "chain_id_destination": "eip155:10",
-      "chain_id_source": "eip155:1",
+      "chain_id_source": "solana:5eykt4UsFv8P8NJdTREpY1vzqKqZKvdp",
       "custom_slippage": true,
       "gas_included": false,
+      "initial_load_time_all_quotes": 0,
       "is_hardware_wallet": false,
-      "price_impact": 0,
+      "price_impact": 12,
       "provider": "provider_bridge",
-      "quoted_time_minutes": 0,
-      "security_warnings": Array [],
+      "quoted_time_minutes": 2,
+      "quotes_count": 2,
+      "quotes_list": Array [
+        "lifi_mayan",
+        "lifi_mayanMCTP",
+      ],
+      "slippage_limit": 0.5,
       "stx_enabled": false,
       "swap_type": "crosschain",
-      "token_address_destination": "eip155:10/slip44:60",
-      "token_address_source": "eip155:1/slip44:60",
+      "token_address_destination": "eip155:10/erc20:0x1234",
+      "token_address_source": "solana:5eykt4UsFv8P8NJdTREpY1vzqKqZKvdp/token:NATIVE",
       "token_symbol_destination": "USDC",
       "token_symbol_source": "ETH",
       "usd_amount_source": 100,
-      "usd_quoted_gas": 0,
-      "usd_quoted_return": 0,
+      "usd_quoted_gas": 1,
+      "usd_quoted_return": 113,
     },
   ],
 ]
@@ -182,7 +231,7 @@ Array [
     "Unified SwapBridge All Quotes Opened",
     Object {
       "action_type": "crosschain-v1",
-      "can_submit": false,
+      "can_submit": true,
       "chain_id_destination": null,
       "chain_id_source": "eip155:1",
       "custom_slippage": false,
@@ -211,7 +260,7 @@ Array [
     Object {
       "action_type": "crosschain-v1",
       "best_quote_provider": "provider_bridge2",
-      "can_submit": false,
+      "can_submit": true,
       "chain_id_destination": null,
       "chain_id_source": "eip155:1",
       "custom_slippage": false,
@@ -295,7 +344,7 @@ Array [
     Object {
       "action_type": "crosschain-v1",
       "best_quote_provider": "provider_bridge2",
-      "can_submit": false,
+      "can_submit": true,
       "chain_id_destination": null,
       "chain_id_source": "eip155:1",
       "custom_slippage": false,
@@ -326,7 +375,7 @@ Array [
     Object {
       "action_type": "crosschain-v1",
       "best_quote_provider": "provider_bridge2",
-      "can_submit": false,
+      "can_submit": true,
       "chain_id_destination": null,
       "chain_id_source": "eip155:1",
       "custom_slippage": false,
@@ -413,7 +462,7 @@ Array [
     Object {
       "action_type": "crosschain-v1",
       "best_quote_provider": "provider_bridge2",
-      "can_submit": true,
+      "can_submit": false,
       "chain_id_destination": "eip155:10",
       "chain_id_source": "eip155:1",
       "custom_slippage": true,

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

@@ -1761,28 +1761,38 @@ describe('BridgeController', function () {
     });
 
     it('should track the Submitted event', () => {
-      bridgeController.trackUnifiedSwapBridgeEvent(
+      const controller = new BridgeController({
+        messenger: messengerMock,
+        getLayer1GasFee: getLayer1GasFeeMock,
+        clientId: BridgeClientId.EXTENSION,
+        fetchFn: mockFetchFn,
+        trackMetaMetricsFn,
+        state: {
+          quoteRequest: {
+            srcChainId: SolScope.Mainnet,
+            destChainId: '0xa',
+            srcTokenAddress: 'NATIVE',
+            destTokenAddress: '0x1234',
+            srcTokenAmount: '1000000',
+            walletAddress: '0x123',
+            slippage: 0.5,
+          },
+          quotes: mockBridgeQuotesSolErc20 as never,
+        },
+      });
+      controller.trackUnifiedSwapBridgeEvent(
         UnifiedSwapBridgeEventName.Submitted,
         {
-          provider: 'provider_bridge',
-          usd_quoted_gas: 0,
+          usd_quoted_gas: 1,
           gas_included: false,
-          quoted_time_minutes: 0,
-          usd_quoted_return: 0,
-          price_impact: 0,
-          chain_id_source: formatChainIdToCaip(1),
+          quoted_time_minutes: 2,
+          usd_quoted_return: 113,
+          provider: 'provider_bridge',
+          price_impact: 12,
           token_symbol_source: 'ETH',
-          token_address_source: getNativeAssetForChainId(1).assetId,
-          custom_slippage: true,
-          usd_amount_source: 100,
-          stx_enabled: false,
-          is_hardware_wallet: false,
-          swap_type: MetricsSwapType.CROSSCHAIN,
-          action_type: MetricsActionType.CROSSCHAIN_V1,
-          chain_id_destination: formatChainIdToCaip(10),
           token_symbol_destination: 'USDC',
-          token_address_destination: getNativeAssetForChainId(10).assetId,
-          security_warnings: [],
+          stx_enabled: false,
+          usd_amount_source: 100,
         },
       );
       expect(trackMetaMetricsFn).toHaveBeenCalledTimes(1);
@@ -1864,6 +1874,47 @@ describe('BridgeController', function () {
 
       expect(trackMetaMetricsFn.mock.calls).toMatchSnapshot();
     });
+
+    it('should track the Failed event before tx is submitted', () => {
+      const controller = new BridgeController({
+        messenger: messengerMock,
+        getLayer1GasFee: getLayer1GasFeeMock,
+        clientId: BridgeClientId.EXTENSION,
+        fetchFn: mockFetchFn,
+        trackMetaMetricsFn,
+        state: {
+          quoteRequest: {
+            srcChainId: SolScope.Mainnet,
+            destChainId: '1',
+            srcTokenAddress: 'NATIVE',
+            destTokenAddress: '0x1234',
+            srcTokenAmount: '1000000',
+            walletAddress: '0x123',
+            slippage: 0.5,
+          },
+          quotes: mockBridgeQuotesSolErc20 as never,
+        },
+      });
+      controller.trackUnifiedSwapBridgeEvent(
+        UnifiedSwapBridgeEventName.Failed,
+        {
+          error_message: 'Failed to submit tx',
+          usd_quoted_gas: 1,
+          gas_included: false,
+          quoted_time_minutes: 2,
+          usd_quoted_return: 113,
+          provider: 'provider_bridge',
+          price_impact: 12,
+          token_symbol_source: 'ETH',
+          token_symbol_destination: 'USDC',
+          stx_enabled: false,
+          usd_amount_source: 100,
+        },
+      );
+      expect(trackMetaMetricsFn).toHaveBeenCalledTimes(1);
+
+      expect(trackMetaMetricsFn.mock.calls).toMatchSnapshot();
+    });
   });
 
   describe('trackUnifiedSwapBridgeEvent client-side call exceptions', () => {

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

@@ -760,7 +760,7 @@ export class BridgeController extends StaticIntervalPollingController<BridgePoll
     'best_quote_provider' | 'price_impact'
   > => {
     return {
-      can_submit: Boolean(this.state.quoteRequest.insufficientBal), // TODO check if balance is sufficient for network fees
+      can_submit: !this.state.quoteRequest.insufficientBal, // TODO check if balance is sufficient for network fees
       quotes_count: this.state.quotes.length,
       quotes_list: this.state.quotes.map(({ quote }) =>
         formatProviderLabel(quote),
@@ -825,10 +825,19 @@ export class BridgeController extends StaticIntervalPollingController<BridgePoll
           ...this.#getRequestParams(),
           ...this.#getRequestMetadata(),
         };
-      // These are populated by BridgeStatusController
       case UnifiedSwapBridgeEventName.Submitted:
+      case UnifiedSwapBridgeEventName.Failed: {
+        // Populate the properties that the error occurred before the tx was submitted
+        return {
+          ...baseProperties,
+          ...this.#getRequestParams(),
+          ...this.#getRequestMetadata(),
+          ...this.#getQuoteFetchData(),
+          ...propertiesFromClient,
+        };
+      }
+      // These are populated by BridgeStatusController
       case UnifiedSwapBridgeEventName.Completed:
-      case UnifiedSwapBridgeEventName.Failed:
         return propertiesFromClient;
       case UnifiedSwapBridgeEventName.InputChanged:
       default:

packages/bridge-controller/src/index.ts

@@ -93,6 +93,8 @@ export {
 
 export { SWAPS_API_V2_BASE_URL } from './constants/swaps';
 
+export { MetricsActionType, MetricsSwapType } from './utils/metrics/constants';
+
 export {
   getEthUsdtResetData,
   isEthUsdt,
@@ -117,6 +119,7 @@ export {
   formatChainIdToCaip,
   formatChainIdToHex,
   formatAddressToCaipReference,
+  formatAddressToAssetId,
 } from './utils/caip-formatters';
 
 export {

packages/bridge-controller/src/utils/feature-flags.test.ts

@@ -40,6 +40,7 @@ describe('feature-flags', () => {
           '1151111081099710': {
             isActiveSrc: true,
             isActiveDest: true,
+            isSnapConfirmationEnabled: false,
           },
         },
       };
@@ -79,6 +80,7 @@ describe('feature-flags', () => {
           'solana:5eykt4UsFv8P8NJdTREpY1vzqKqZKvdp': {
             isActiveSrc: true,
             isActiveDest: true,
+            isSnapConfirmationEnabled: false,
           },
         },
       });