@metamask-previews/bridge-status-controller 75.2.1-preview-264a60683 → 75.3.0-preview-56ae4c857

package/CHANGELOG.md

@@ -7,9 +7,12 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
-### Added
+## [75.3.0]
+
+### Changed
 
-- Emit `failure_phase`, `error_code`, `source_hash_present`, and `destination_hash_present` on SwapBridge Submitted, Completed, and Failed events ([#9949](https://github.com/MetaMask/core/pull/9949))
+- Add optional `migrationPhase` to `submitTx`, `submitIntent`, and `submitBatchSell`, used by `toQuoteMetadataV1` to convert V2 quotes. Defaults to `V1Data` (`'1'`) if omitted ([#9744](https://github.com/MetaMask/core/pull/9744))
+- Bump `@metamask/bridge-controller` from `^79.3.1` to `^80.0.0` ([#9978](https://github.com/MetaMask/core/pull/9978))
 
 ## [75.2.1]
 
@@ -1520,7 +1523,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-status-controller@75.2.1...HEAD
+[Unreleased]: https://github.com/MetaMask/core/compare/@metamask/bridge-status-controller@75.3.0...HEAD
+[75.3.0]: https://github.com/MetaMask/core/compare/@metamask/bridge-status-controller@75.2.1...@metamask/bridge-status-controller@75.3.0
 [75.2.1]: https://github.com/MetaMask/core/compare/@metamask/bridge-status-controller@75.2.0...@metamask/bridge-status-controller@75.2.1
 [75.2.0]: https://github.com/MetaMask/core/compare/@metamask/bridge-status-controller@75.1.0...@metamask/bridge-status-controller@75.2.0
 [75.1.0]: https://github.com/MetaMask/core/compare/@metamask/bridge-status-controller@75.0.0...@metamask/bridge-status-controller@75.1.0

package/dist/bridge-status-controller.cjs

@@ -18,9 +18,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.BridgeStatusController = void 0;
 const bridge_controller_1 = require("@metamask/bridge-controller");
 const bridge_controller_2 = require("@metamask/bridge-controller");
-const bridge_controller_3 = require("@metamask/bridge-controller");
 const polling_controller_1 = require("@metamask/polling-controller");
-const superstruct_1 = require("@metamask/superstruct");
 const transaction_controller_1 = require("@metamask/transaction-controller");
 const utils_1 = require("@metamask/utils");
 const bridge_status_controller_intent_1 = require("./bridge-status-controller.intent.cjs");
@@ -811,10 +809,11 @@ class BridgeStatusController extends (0, polling_controller_1.StaticIntervalPoll
          * @param tokenSecurityTypeDestination - The security classification of the destination token, supplied by the client (e.g. from token security/scanning data). Pass `null` when no security data is available.
          * @param batchSellTrades - Contains transaction data for the quotes, provided by the obtainGaslessBatch API
          * @param inputPrimaryDenomination - The denomination shown as the primary source amount input at submission time.
+         * @param migrationPhase - The active migration phase for the quote response
          * @returns The transaction meta
          * @throws An error if transaction submission fails before it gets published
          */
-        this.submitTx = async (accountAddress, maybeQuoteResponses, isStxEnabled, quotesReceivedContext, location = bridge_controller_2.MetaMetricsSwapsEventSource.Unknown, abTests, activeAbTests, tokenSecurityTypeDestination, batchSellTrades, inputPrimaryDenomination) => {
+        this.submitTx = async (accountAddress, maybeQuoteResponses, isStxEnabled, quotesReceivedContext, location = bridge_controller_2.MetaMetricsSwapsEventSource.Unknown, abTests, activeAbTests, tokenSecurityTypeDestination, batchSellTrades, inputPrimaryDenomination, migrationPhase) => {
             /**
              * If there are multiple quote responses, we assume that they all originate from the same src chain
              * and the same account. In this case its safe to use the first quote response's properties for
@@ -825,11 +824,14 @@ class BridgeStatusController extends (0, polling_controller_1.StaticIntervalPoll
                 : [maybeQuoteResponses];
             // Convert quote responses to V1 format and preserve metadata for consistency
             const quoteResponses = quoteResponsesV1orV2.map((quote) => {
-                if ((0, superstruct_1.is)(quote, bridge_controller_3.QuoteResponseSchemaV1)) {
+                if (!(0, bridge_controller_1.isQuoteResponseV2)(quote)) {
                     return quote;
                 }
-                const quoteMetadata = (0, bridge_controller_1.toQuoteMetadataV1)(quote);
-                return (0, bridge_controller_1.mergeQuoteMetadata)((0, bridge_controller_1.toQuoteResponseV1)(quote), quoteMetadata);
+                const quoteMetadataV1 = (0, bridge_controller_1.toQuoteMetadataV1)(quote, migrationPhase);
+                // This coercion omits legacy metadata from the resulting V1 quote
+                const quoteResponseV1 = (0, bridge_controller_1.toQuoteResponseV1)(quote);
+                // Merge legacy-shaped metadata to V1-shaped quote response
+                return { ...quoteResponseV1, ...quoteMetadataV1 };
             });
             const quoteResponse = quoteResponses[0];
             const { quote } = quoteResponse;
@@ -854,8 +856,6 @@ class BridgeStatusController extends (0, polling_controller_1.StaticIntervalPoll
                 // Emit Submitted event after submit button is clicked
                 __classPrivateFieldGet(this, _BridgeStatusController_trackUnifiedSwapBridgeEvent, "f").call(this, bridge_controller_2.UnifiedSwapBridgeEventName.Submitted, undefined, {
                     ...preConfirmationProperties,
-                    source_hash_present: false,
-                    destination_hash_present: false,
                     ...(inputPrimaryDenomination && {
                         input_primary_denomination: inputPrimaryDenomination,
                     }),
@@ -897,7 +897,6 @@ class BridgeStatusController extends (0, polling_controller_1.StaticIntervalPoll
                 __classPrivateFieldGet(this, _BridgeStatusController_trackUnifiedSwapBridgeEvent, "f").call(this, bridge_controller_2.UnifiedSwapBridgeEventName.Failed, undefined, {
                     error_message: error?.message,
                     ...preConfirmationProperties,
-                    ...(0, bridge_controller_1.getSubmitFailureTelemetry)(error),
                 });
                 throw error;
             }
@@ -916,13 +915,14 @@ class BridgeStatusController extends (0, polling_controller_1.StaticIntervalPoll
          * @param params.inputPrimaryDenomination - The denomination shown as the primary source amount input at submission time.
          * @param params.isStxEnabled - Whether smart transactions are enabled on the client, for example the getSmartTransactionsEnabled selector value from the extension
          * @param params.quotesReceivedContext - The context for the QuotesReceived event
+         * @param params.migrationPhase - The active migration phase for the quote response
          * @returns A lightweight TransactionMeta-like object for history linking
          * @throws An error if intent or transaction submission fails before they get published
          */
         this.submitIntent = async (params) => {
-            const { quoteResponse, accountAddress, location, abTests, activeAbTests, tokenSecurityTypeDestination, inputPrimaryDenomination, isStxEnabled = false, quotesReceivedContext, } = params;
+            const { quoteResponse, accountAddress, location, abTests, migrationPhase, activeAbTests, tokenSecurityTypeDestination, inputPrimaryDenomination, isStxEnabled = false, quotesReceivedContext, } = params;
             // TODO add metrics context
-            return await this.submitTx(accountAddress, quoteResponse, isStxEnabled, quotesReceivedContext, location, abTests, activeAbTests, tokenSecurityTypeDestination, undefined, inputPrimaryDenomination);
+            return await this.submitTx(accountAddress, quoteResponse, isStxEnabled, quotesReceivedContext, location, abTests, activeAbTests, tokenSecurityTypeDestination, undefined, inputPrimaryDenomination, migrationPhase);
         };
         this.submitBatchSell = async (params) => {
             /**
@@ -930,7 +930,7 @@ class BridgeStatusController extends (0, polling_controller_1.StaticIntervalPoll
              * the original response data from the bridge-api
              */
             const batchSellTrades = (0, bridge_js_1.getBatchSellTrades)(this.messenger);
-            return await this.submitTx(params.accountAddress, params.quoteResponses.filter((quoteResponse) => quoteResponse !== null), params.isStxEnabled ?? false, params.quotesReceivedContext, params.location, params.abTests, params.activeAbTests, params.tokenSecurityTypeDestination, batchSellTrades);
+            return await this.submitTx(params.accountAddress, params.quoteResponses.filter((quoteResponse) => quoteResponse !== null), params.isStxEnabled ?? false, params.quotesReceivedContext, params.location, params.abTests, params.activeAbTests, params.tokenSecurityTypeDestination, batchSellTrades, undefined, params.migrationPhase);
         };
         _BridgeStatusController_trackPollingStatusUpdatedEvent.set(this, (historyKey, pollingStatus) => {
             // Track polling status updated event
@@ -1016,19 +1016,6 @@ class BridgeStatusController extends (0, polling_controller_1.StaticIntervalPoll
             const transactions = (0, transaction_js_1.getTransactions)(this.messenger);
             const txMeta = transactions.find((tx) => tx.id === txHistoryKey);
             const approvalTxMeta = transactions.find((tx) => tx.id === approvalTxId);
-            const failedProperties = eventProperties;
-            const historyHashPresence = (0, bridge_controller_1.getHashPresenceProperties)(historyItem.status.srcChain.txHash, historyItem.status.destChain?.txHash);
-            const statusFailureTelemetry = (0, bridge_controller_1.getStatusFailureTelemetry)(historyItem.status.srcChain.txHash, historyItem.status.destChain?.txHash);
-            const failedHashPresence = {
-                source_hash_present: historyHashPresence.source_hash_present ||
-                    Boolean(failedProperties?.source_hash_present),
-                destination_hash_present: historyHashPresence.destination_hash_present ||
-                    Boolean(failedProperties?.destination_hash_present),
-            };
-            const failedPhase = (0, bridge_controller_1.promoteFailurePhase)(failedProperties?.failure_phase ?? statusFailureTelemetry.failure_phase, failedHashPresence);
-            const failedErrorCode = failedProperties?.failure_phase === undefined
-                ? statusFailureTelemetry.error_code
-                : (failedProperties.error_code ?? bridge_controller_1.SwapBridgeErrorCode.Unknown);
             const requiredEventProperties = {
                 ...baseProperties,
                 ...requestParamProperties,
@@ -1038,7 +1025,6 @@ class BridgeStatusController extends (0, polling_controller_1.StaticIntervalPoll
                 ...(0, metrics_js_1.getFinalizedTxProperties)(historyItem, txMeta, approvalTxMeta),
                 ...(0, metrics_js_1.getPriceImpactFromQuote)(quote),
                 ...(eventName === bridge_controller_2.UnifiedSwapBridgeEventName.Completed && {
-                    ...historyHashPresence,
                     ...(!(0, bridge_controller_2.isNonEvmChainId)(historyItem.quote.srcChainId) &&
                         historyItem.txMetaId && {
                         transaction_internal_id: historyItem.txMetaId,
@@ -1047,12 +1033,6 @@ class BridgeStatusController extends (0, polling_controller_1.StaticIntervalPoll
                         input_primary_denomination: historyItem.inputPrimaryDenomination,
                     }),
                 }),
-                ...(eventName === bridge_controller_2.UnifiedSwapBridgeEventName.Failed && {
-                    ...statusFailureTelemetry,
-                    ...failedHashPresence,
-                    failure_phase: failedPhase,
-                    error_code: failedErrorCode,
-                }),
             };
             (0, bridge_js_1.trackMetricsEvent)({
                 messenger: this.messenger,