@metamask/bridge-status-controller 63.0.0 → 63.1.0

package/CHANGELOG.md

@@ -7,6 +7,28 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [63.1.0]
+
+### Changed
+
+- Bump `@metamask/bridge-controller` from `^63.1.0` to `^63.2.0` ([#7245](https://github.com/MetaMask/core/pull/7245))
+- Move peer dependencies for controller and service packages to direct dependencies ([#7209](https://github.com/MetaMask/core/pull/7209), [#7220](https://github.com/MetaMask/core/pull/7220), [#7236](https://github.com/MetaMask/core/pull/7236))
+  - The dependencies moved are:
+    - `@metamask/accounts-controller` (^35.0.0)
+    - `@metamask/bridge-controller` (^63.0.0)
+    - `@metamask/gas-fee-controller` (^26.0.0)
+    - `@metamask/network-controller` (^26.0.0)
+    - `@metamask/snaps-controllers` (^14.0.1)
+    - `@metamask/transaction-controller` (^62.3.0)
+  - In clients, it is now possible for multiple versions of these packages to exist in the dependency tree.
+    - For example, this scenario would be valid: a client relies on `@metamask/controller-a` 1.0.0 and `@metamask/controller-b` 1.0.0, and `@metamask/controller-b` depends on `@metamask/controller-a` 1.1.0.
+  - Note, however, that the versions specified in the client's `package.json` always "win", and you are expected to keep them up to date so as not to break controller and service intercommunication.
+- Bump `@metamask/bridge-controller` from `^63.0.0` to `^63.1.0` ([#7238](https://github.com/MetaMask/core/pull/7238))
+
+### Removed
+
+- Remove direct QuotesReceived event publishing to avoid race conditions that can happen when clients navigate and reset state. Update `submitTx` to accept quotesReceivedContext (replace isLoading/warnings) and propagate context to the BridgeController through the `stopPollingForQuotes call ([#7242](https://github.com/MetaMask/core/pull/7242))
+
 ## [63.0.0]
 
 ### Changed
@@ -777,7 +799,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@63.0.0...HEAD
+[Unreleased]: https://github.com/MetaMask/core/compare/@metamask/bridge-status-controller@63.1.0...HEAD
+[63.1.0]: https://github.com/MetaMask/core/compare/@metamask/bridge-status-controller@63.0.0...@metamask/bridge-status-controller@63.1.0
 [63.0.0]: https://github.com/MetaMask/core/compare/@metamask/bridge-status-controller@62.0.0...@metamask/bridge-status-controller@63.0.0
 [62.0.0]: https://github.com/MetaMask/core/compare/@metamask/bridge-status-controller@61.0.0...@metamask/bridge-status-controller@62.0.0
 [61.0.0]: https://github.com/MetaMask/core/compare/@metamask/bridge-status-controller@60.1.0...@metamask/bridge-status-controller@61.0.0

package/dist/bridge-status-controller.cjs

@@ -14,7 +14,6 @@ var _BridgeStatusController_instances, _BridgeStatusController_pollingTokensByTx
 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 controller_utils_1 = require("@metamask/controller-utils");
 const polling_controller_1 = require("@metamask/polling-controller");
 const transaction_controller_1 = require("@metamask/transaction-controller");
@@ -66,7 +65,7 @@ class BridgeStatusController extends (0, polling_controller_1.StaticIntervalPoll
                 return;
             }
             this.update((statusState) => {
-                statusState.txHistory[txHistoryKey].status.status = bridge_controller_2.StatusTypes.FAILED;
+                statusState.txHistory[txHistoryKey].status.status = bridge_controller_1.StatusTypes.FAILED;
             });
         });
         this.resetState = () => {
@@ -124,7 +123,7 @@ class BridgeStatusController extends (0, polling_controller_1.StaticIntervalPoll
                 }
             });
             // Restart polling if it was stopped and this is a bridge transaction
-            const isBridgeTx = (0, bridge_controller_2.isCrossChain)(historyItem.quote.srcChainId, historyItem.quote.destChainId);
+            const isBridgeTx = (0, bridge_controller_1.isCrossChain)(historyItem.quote.srcChainId, historyItem.quote.destChainId);
             if (isBridgeTx) {
                 // Check if polling was stopped (no active polling token)
                 const existingPollingToken = __classPrivateFieldGet(this, _BridgeStatusController_pollingTokensByTxMetaId, "f")[targetTxMetaId];
@@ -152,8 +151,8 @@ class BridgeStatusController extends (0, polling_controller_1.StaticIntervalPoll
             const { txHistory } = this.state;
             const historyItems = Object.values(txHistory);
             const incompleteHistoryItems = historyItems
-                .filter((historyItem) => historyItem.status.status === bridge_controller_2.StatusTypes.PENDING ||
-                historyItem.status.status === bridge_controller_2.StatusTypes.UNKNOWN)
+                .filter((historyItem) => historyItem.status.status === bridge_controller_1.StatusTypes.PENDING ||
+                historyItem.status.status === bridge_controller_1.StatusTypes.UNKNOWN)
                 .filter((historyItem) => {
                 // Check if we are already polling this tx, if so, skip restarting polling for that
                 const pollingToken = __classPrivateFieldGet(this, _BridgeStatusController_pollingTokensByTxMetaId, "f")[historyItem.txMetaId];
@@ -161,7 +160,7 @@ class BridgeStatusController extends (0, polling_controller_1.StaticIntervalPoll
             })
                 // Swap txs don't need to have their statuses polled
                 .filter((historyItem) => {
-                const isBridgeTx = (0, bridge_controller_2.isCrossChain)(historyItem.quote.srcChainId, historyItem.quote.destChainId);
+                const isBridgeTx = (0, bridge_controller_1.isCrossChain)(historyItem.quote.srcChainId, historyItem.quote.destChainId);
                 return isBridgeTx;
             });
             incompleteHistoryItems.forEach((historyItem) => {
@@ -199,7 +198,7 @@ class BridgeStatusController extends (0, polling_controller_1.StaticIntervalPoll
                 status: {
                     // We always have a PENDING status when we start polling for a tx, don't need the Bridge API for that
                     // Also we know the bare minimum fields for status at this point in time
-                    status: bridge_controller_2.StatusTypes.PENDING,
+                    status: bridge_controller_1.StatusTypes.PENDING,
                     srcChain: {
                         chainId: statusRequest.srcChainId,
                         txHash: statusRequest.srcTxHash,
@@ -226,7 +225,7 @@ class BridgeStatusController extends (0, polling_controller_1.StaticIntervalPoll
                 return;
             }
             const { quote } = txHistoryItem;
-            const isBridgeTx = (0, bridge_controller_2.isCrossChain)(quote.srcChainId, quote.destChainId);
+            const isBridgeTx = (0, bridge_controller_1.isCrossChain)(quote.srcChainId, quote.destChainId);
             if (isBridgeTx) {
                 __classPrivateFieldGet(this, _BridgeStatusController_pollingTokensByTxMetaId, "f")[txId] = this.startPolling({
                     bridgeTxMetaId: txId,
@@ -302,7 +301,7 @@ class BridgeStatusController extends (0, polling_controller_1.StaticIntervalPoll
                 const statusRequest = (0, bridge_status_1.getStatusRequestWithSrcTxHash)(historyItem.quote, srcTxHash);
                 const { status, validationFailures } = await (0, bridge_status_1.fetchBridgeTxStatus)(statusRequest, __classPrivateFieldGet(this, _BridgeStatusController_clientId, "f"), __classPrivateFieldGet(this, _BridgeStatusController_fetchFn, "f"), __classPrivateFieldGet(this, _BridgeStatusController_config, "f").customBridgeApiBaseUrl);
                 if (validationFailures.length > 0) {
-                    __classPrivateFieldGet(this, _BridgeStatusController_trackUnifiedSwapBridgeEvent, "f").call(this, bridge_controller_2.UnifiedSwapBridgeEventName.StatusValidationFailed, bridgeTxMetaId, {
+                    __classPrivateFieldGet(this, _BridgeStatusController_trackUnifiedSwapBridgeEvent, "f").call(this, bridge_controller_1.UnifiedSwapBridgeEventName.StatusValidationFailed, bridgeTxMetaId, {
                         failures: validationFailures,
                     });
                     throw new Error(`Bridge status validation failed: ${validationFailures.join(', ')}`);
@@ -310,8 +309,8 @@ class BridgeStatusController extends (0, polling_controller_1.StaticIntervalPoll
                 const newBridgeHistoryItem = {
                     ...historyItem,
                     status,
-                    completionTime: status.status === bridge_controller_2.StatusTypes.COMPLETE ||
-                        status.status === bridge_controller_2.StatusTypes.FAILED
+                    completionTime: status.status === bridge_controller_1.StatusTypes.COMPLETE ||
+                        status.status === bridge_controller_1.StatusTypes.FAILED
                         ? Date.now()
                         : undefined, // TODO make this more accurate by looking up dest txHash block time
                     attempts: undefined,
@@ -324,8 +323,8 @@ class BridgeStatusController extends (0, polling_controller_1.StaticIntervalPoll
                     state.txHistory[bridgeTxMetaId] = newBridgeHistoryItem;
                 });
                 const pollingToken = __classPrivateFieldGet(this, _BridgeStatusController_pollingTokensByTxMetaId, "f")[bridgeTxMetaId];
-                const isFinalStatus = status.status === bridge_controller_2.StatusTypes.COMPLETE ||
-                    status.status === bridge_controller_2.StatusTypes.FAILED;
+                const isFinalStatus = status.status === bridge_controller_1.StatusTypes.COMPLETE ||
+                    status.status === bridge_controller_1.StatusTypes.FAILED;
                 if (isFinalStatus && pollingToken) {
                     this.stopPollingByPollingToken(pollingToken);
                     delete __classPrivateFieldGet(this, _BridgeStatusController_pollingTokensByTxMetaId, "f")[bridgeTxMetaId];
@@ -333,12 +332,12 @@ class BridgeStatusController extends (0, polling_controller_1.StaticIntervalPoll
                     if (historyItem.featureId) {
                         return;
                     }
-                    if (status.status === bridge_controller_2.StatusTypes.COMPLETE) {
-                        __classPrivateFieldGet(this, _BridgeStatusController_trackUnifiedSwapBridgeEvent, "f").call(this, bridge_controller_2.UnifiedSwapBridgeEventName.Completed, bridgeTxMetaId);
+                    if (status.status === bridge_controller_1.StatusTypes.COMPLETE) {
+                        __classPrivateFieldGet(this, _BridgeStatusController_trackUnifiedSwapBridgeEvent, "f").call(this, bridge_controller_1.UnifiedSwapBridgeEventName.Completed, bridgeTxMetaId);
                         this.messenger.publish('BridgeStatusController:destinationTransactionCompleted', historyItem.quote.destAsset.assetId);
                     }
-                    if (status.status === bridge_controller_2.StatusTypes.FAILED) {
-                        __classPrivateFieldGet(this, _BridgeStatusController_trackUnifiedSwapBridgeEvent, "f").call(this, bridge_controller_2.UnifiedSwapBridgeEventName.Failed, bridgeTxMetaId);
+                    if (status.status === bridge_controller_1.StatusTypes.FAILED) {
+                        __classPrivateFieldGet(this, _BridgeStatusController_trackUnifiedSwapBridgeEvent, "f").call(this, bridge_controller_1.UnifiedSwapBridgeEventName.Failed, bridgeTxMetaId);
                     }
                 }
             }
@@ -454,7 +453,7 @@ class BridgeStatusController extends (0, polling_controller_1.StaticIntervalPoll
                         ? constants_1.TraceName.BridgeTransactionApprovalCompleted
                         : constants_1.TraceName.SwapTransactionApprovalCompleted,
                     data: {
-                        srcChainId: (0, bridge_controller_2.formatChainIdToCaip)(quoteResponse.quote.srcChainId),
+                        srcChainId: (0, bridge_controller_1.formatChainIdToCaip)(quoteResponse.quote.srcChainId),
                         stxEnabled: false,
                     },
                 }, approveTx);
@@ -476,7 +475,7 @@ class BridgeStatusController extends (0, polling_controller_1.StaticIntervalPoll
             if (!selectedAccount) {
                 throw new Error('Failed to submit cross-chain swap transaction: unknown account in trade data');
             }
-            const hexChainId = (0, bridge_controller_2.formatChainIdToHex)(trade.chainId);
+            const hexChainId = (0, bridge_controller_1.formatChainIdToHex)(trade.chainId);
             const networkClientId = this.messenger.call('NetworkController:findNetworkClientIdByChainId', hexChainId);
             const requestOptions = {
                 actionId,
@@ -567,34 +566,32 @@ class BridgeStatusController extends (0, polling_controller_1.StaticIntervalPoll
          * @param accountAddress - The address of the account to submit the transaction for
          * @param quoteResponse - The quote response
          * @param isStxEnabledOnClient - Whether smart transactions are enabled on the client, for example the getSmartTransactionsEnabled selector value from the extension
-         * @param isLoading - Whether the trade is submitted before all quotes are loaded, publish QuotesReceived event if true
-         * @param warnings - The warnings to publish with the QuotesReceived event
+         * @param quotesReceivedContext - The context for the QuotesReceived event
          * @returns The transaction meta
          */
-        this.submitTx = async (accountAddress, quoteResponse, isStxEnabledOnClient, isLoading = false, warnings = []) => {
-            // If trade is submitted before all quotes are loaded, publish QuotesReceived event
-            if (isLoading) {
-                __classPrivateFieldGet(this, _BridgeStatusController_trackUnifiedSwapBridgeEvent, "f").call(this, bridge_controller_2.UnifiedSwapBridgeEventName.QuotesReceived, undefined, (0, bridge_controller_1.getQuotesReceivedProperties)(quoteResponse, warnings));
-            }
-            this.messenger.call('BridgeController:stopPollingForQuotes');
+        this.submitTx = async (accountAddress, quoteResponse, isStxEnabledOnClient, quotesReceivedContext) => {
+            this.messenger.call('BridgeController:stopPollingForQuotes', bridge_controller_1.AbortReason.TransactionSubmitted, 
+            // If trade is submitted before all quotes are loaded, the QuotesReceived event is published
+            // If the trade has a featureId, it means it was submitted outside of the Unified Swap and Bridge experience, so no QuotesReceived event is published
+            quoteResponse.featureId ? undefined : quotesReceivedContext);
             const selectedAccount = __classPrivateFieldGet(this, _BridgeStatusController_instances, "m", _BridgeStatusController_getMultichainSelectedAccount).call(this, accountAddress);
             if (!selectedAccount) {
                 throw new Error('Failed to submit cross-chain swap transaction: undefined multichain account');
             }
-            const isHardwareAccount = (0, bridge_controller_2.isHardwareWallet)(selectedAccount);
+            const isHardwareAccount = (0, bridge_controller_1.isHardwareWallet)(selectedAccount);
             const preConfirmationProperties = (0, metrics_1.getPreConfirmationPropertiesFromQuote)(quoteResponse, isStxEnabledOnClient, isHardwareAccount);
             // Emit Submitted event after submit button is clicked
             !quoteResponse.featureId &&
-                __classPrivateFieldGet(this, _BridgeStatusController_trackUnifiedSwapBridgeEvent, "f").call(this, bridge_controller_2.UnifiedSwapBridgeEventName.Submitted, undefined, preConfirmationProperties);
+                __classPrivateFieldGet(this, _BridgeStatusController_trackUnifiedSwapBridgeEvent, "f").call(this, bridge_controller_1.UnifiedSwapBridgeEventName.Submitted, undefined, preConfirmationProperties);
             let txMeta;
             let approvalTxId;
             const startTime = Date.now();
-            const isBridgeTx = (0, bridge_controller_2.isCrossChain)(quoteResponse.quote.srcChainId, quoteResponse.quote.destChainId);
+            const isBridgeTx = (0, bridge_controller_1.isCrossChain)(quoteResponse.quote.srcChainId, quoteResponse.quote.destChainId);
             // Submit non-EVM tx (Solana, BTC, Tron)
-            const isNonEvmTrade = (0, bridge_controller_2.isNonEvmChainId)(quoteResponse.quote.srcChainId) &&
+            const isNonEvmTrade = (0, bridge_controller_1.isNonEvmChainId)(quoteResponse.quote.srcChainId) &&
                 (typeof quoteResponse.trade === 'string' ||
-                    (0, bridge_controller_2.isBitcoinTrade)(quoteResponse.trade) ||
-                    (0, bridge_controller_2.isTronTrade)(quoteResponse.trade));
+                    (0, bridge_controller_1.isBitcoinTrade)(quoteResponse.trade) ||
+                    (0, bridge_controller_1.isTronTrade)(quoteResponse.trade));
             if (isNonEvmTrade) {
                 // Handle non-EVM approval if present (e.g., Tron token approvals)
                 if (quoteResponse.approval) {
@@ -603,7 +600,7 @@ class BridgeStatusController extends (0, polling_controller_1.StaticIntervalPoll
                             ? constants_1.TraceName.BridgeTransactionApprovalCompleted
                             : constants_1.TraceName.SwapTransactionApprovalCompleted,
                         data: {
-                            srcChainId: (0, bridge_controller_2.formatChainIdToCaip)(quoteResponse.quote.srcChainId),
+                            srcChainId: (0, bridge_controller_1.formatChainIdToCaip)(quoteResponse.quote.srcChainId),
                             stxEnabled: false,
                         },
                     }, async () => {
@@ -612,7 +609,7 @@ class BridgeStatusController extends (0, polling_controller_1.StaticIntervalPoll
                         }
                         catch (error) {
                             !quoteResponse.featureId &&
-                                __classPrivateFieldGet(this, _BridgeStatusController_trackUnifiedSwapBridgeEvent, "f").call(this, bridge_controller_2.UnifiedSwapBridgeEventName.Failed, undefined, {
+                                __classPrivateFieldGet(this, _BridgeStatusController_trackUnifiedSwapBridgeEvent, "f").call(this, bridge_controller_1.UnifiedSwapBridgeEventName.Failed, undefined, {
                                     error_message: error?.message,
                                     ...preConfirmationProperties,
                                 });
@@ -628,7 +625,7 @@ class BridgeStatusController extends (0, polling_controller_1.StaticIntervalPoll
                         ? constants_1.TraceName.BridgeTransactionCompleted
                         : constants_1.TraceName.SwapTransactionCompleted,
                     data: {
-                        srcChainId: (0, bridge_controller_2.formatChainIdToCaip)(quoteResponse.quote.srcChainId),
+                        srcChainId: (0, bridge_controller_1.formatChainIdToCaip)(quoteResponse.quote.srcChainId),
                         stxEnabled: false,
                     },
                 }, async () => {
@@ -637,7 +634,7 @@ class BridgeStatusController extends (0, polling_controller_1.StaticIntervalPoll
                     }
                     catch (error) {
                         !quoteResponse.featureId &&
-                            __classPrivateFieldGet(this, _BridgeStatusController_trackUnifiedSwapBridgeEvent, "f").call(this, bridge_controller_2.UnifiedSwapBridgeEventName.Failed, txMeta?.id, {
+                            __classPrivateFieldGet(this, _BridgeStatusController_trackUnifiedSwapBridgeEvent, "f").call(this, bridge_controller_1.UnifiedSwapBridgeEventName.Failed, txMeta?.id, {
                                 error_message: error?.message,
                                 ...preConfirmationProperties,
                             });
@@ -656,7 +653,7 @@ class BridgeStatusController extends (0, polling_controller_1.StaticIntervalPoll
                         ? constants_1.TraceName.BridgeTransactionCompleted
                         : constants_1.TraceName.SwapTransactionCompleted,
                     data: {
-                        srcChainId: (0, bridge_controller_2.formatChainIdToCaip)(quoteResponse.quote.srcChainId),
+                        srcChainId: (0, bridge_controller_1.formatChainIdToCaip)(quoteResponse.quote.srcChainId),
                         stxEnabled: isStxEnabledOnClient,
                     },
                 }, async () => {
@@ -700,12 +697,12 @@ class BridgeStatusController extends (0, polling_controller_1.StaticIntervalPoll
                     startTime,
                     approvalTxId,
                 });
-                if ((0, bridge_controller_2.isNonEvmChainId)(quoteResponse.quote.srcChainId)) {
+                if ((0, bridge_controller_1.isNonEvmChainId)(quoteResponse.quote.srcChainId)) {
                     // Start polling for bridge tx status
                     __classPrivateFieldGet(this, _BridgeStatusController_startPollingForTxId, "f").call(this, txMeta.id);
                     // Track non-EVM Swap completed event
                     if (!isBridgeTx) {
-                        __classPrivateFieldGet(this, _BridgeStatusController_trackUnifiedSwapBridgeEvent, "f").call(this, bridge_controller_2.UnifiedSwapBridgeEventName.Completed, txMeta.id);
+                        __classPrivateFieldGet(this, _BridgeStatusController_trackUnifiedSwapBridgeEvent, "f").call(this, bridge_controller_1.UnifiedSwapBridgeEventName.Completed, txMeta.id);
                     }
                 }
             }
@@ -723,7 +720,7 @@ class BridgeStatusController extends (0, polling_controller_1.StaticIntervalPoll
          */
         _BridgeStatusController_trackUnifiedSwapBridgeEvent.set(this, (eventName, txMetaId, eventProperties) => {
             const baseProperties = {
-                action_type: bridge_controller_2.MetricsActionType.SWAPBRIDGE_V1,
+                action_type: bridge_controller_1.MetricsActionType.SWAPBRIDGE_V1,
                 ...(eventProperties ?? {}),
             };
             // This will publish events for PERPS dropped tx failures as well
@@ -738,7 +735,7 @@ class BridgeStatusController extends (0, polling_controller_1.StaticIntervalPoll
             }
             const requestParamProperties = (0, metrics_1.getRequestParamFromHistory)(historyItem);
             // Always publish StatusValidationFailed event, regardless of featureId
-            if (eventName === bridge_controller_2.UnifiedSwapBridgeEventName.StatusValidationFailed) {
+            if (eventName === bridge_controller_1.UnifiedSwapBridgeEventName.StatusValidationFailed) {
                 const { chain_id_source, chain_id_destination, token_address_source, token_address_destination, } = requestParamProperties;
                 this.messenger.call('BridgeController:trackUnifiedSwapBridgeEvent', eventName, {
                     ...baseProperties,
@@ -806,16 +803,16 @@ class BridgeStatusController extends (0, polling_controller_1.StaticIntervalPoll
                 __classPrivateFieldGet(this, _BridgeStatusController_markTxAsFailed, "f").call(this, transactionMeta);
                 // Track failed event
                 if (status !== transaction_controller_1.TransactionStatus.rejected) {
-                    __classPrivateFieldGet(this, _BridgeStatusController_trackUnifiedSwapBridgeEvent, "f").call(this, bridge_controller_2.UnifiedSwapBridgeEventName.Failed, id, (0, metrics_1.getEVMTxPropertiesFromTransactionMeta)(transactionMeta));
+                    __classPrivateFieldGet(this, _BridgeStatusController_trackUnifiedSwapBridgeEvent, "f").call(this, bridge_controller_1.UnifiedSwapBridgeEventName.Failed, id, (0, metrics_1.getEVMTxPropertiesFromTransactionMeta)(transactionMeta));
                 }
             }
         });
         this.messenger.subscribe('TransactionController:transactionConfirmed', (transactionMeta) => {
             const { type, id, chainId } = transactionMeta;
             if (type === transaction_controller_1.TransactionType.swap) {
-                __classPrivateFieldGet(this, _BridgeStatusController_trackUnifiedSwapBridgeEvent, "f").call(this, bridge_controller_2.UnifiedSwapBridgeEventName.Completed, id);
+                __classPrivateFieldGet(this, _BridgeStatusController_trackUnifiedSwapBridgeEvent, "f").call(this, bridge_controller_1.UnifiedSwapBridgeEventName.Completed, id);
             }
-            if (type === transaction_controller_1.TransactionType.bridge && !(0, bridge_controller_2.isNonEvmChainId)(chainId)) {
+            if (type === transaction_controller_1.TransactionType.bridge && !(0, bridge_controller_1.isNonEvmChainId)(chainId)) {
                 __classPrivateFieldGet(this, _BridgeStatusController_startPollingForTxId, "f").call(this, id);
             }
         });