@metamask/transaction-controller 39.1.0 → 40.1.0

package/CHANGELOG.md

@@ -7,6 +7,21 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [40.1.0]
+
+### Added
+
+- Add `firstTimeInteraction` to transaction meta ([#4895](https://github.com/MetaMask/core/pull/4895))
+  - This is a boolean value that indicates whether the transaction is the first time the user has interacted with it.
+- Add `isFirstTimeInteractionEnabled` callback constructor option ([#4895](https://github.com/MetaMask/core/pull/4895))
+  - This is a function that returns a boolean value indicating whether the first time interaction check should be enabled.
+
+## [40.0.0]
+
+### Changed
+
+- **BREAKING:** Bump `@metamask/accounts-controller` peer dependency from `^19.0.0` to `^20.0.0` ([#4195](https://github.com/MetaMask/core/pull/4956))
+
 ## [39.1.0]
 
 ### Changed
@@ -1127,7 +1142,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
     All changes listed after this point were applied to this package following the monorepo conversion.
 
-[Unreleased]: https://github.com/MetaMask/core/compare/@metamask/transaction-controller@39.1.0...HEAD
+[Unreleased]: https://github.com/MetaMask/core/compare/@metamask/transaction-controller@40.1.0...HEAD
+[40.1.0]: https://github.com/MetaMask/core/compare/@metamask/transaction-controller@40.0.0...@metamask/transaction-controller@40.1.0
+[40.0.0]: https://github.com/MetaMask/core/compare/@metamask/transaction-controller@39.1.0...@metamask/transaction-controller@40.0.0
 [39.1.0]: https://github.com/MetaMask/core/compare/@metamask/transaction-controller@39.0.0...@metamask/transaction-controller@39.1.0
 [39.0.0]: https://github.com/MetaMask/core/compare/@metamask/transaction-controller@38.3.0...@metamask/transaction-controller@39.0.0
 [38.3.0]: https://github.com/MetaMask/core/compare/@metamask/transaction-controller@38.2.0...@metamask/transaction-controller@38.3.0

package/dist/TransactionController.cjs

@@ -13,7 +13,7 @@ var __classPrivateFieldSet = (this && this.__classPrivateFieldSet) || function (
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
-var _TransactionController_instances, _TransactionController_internalEvents, _TransactionController_incomingTransactionOptions, _TransactionController_pendingTransactionOptions, _TransactionController_trace, _TransactionController_transactionHistoryLimit, _TransactionController_isSimulationEnabled, _TransactionController_testGasFeeFlows, _TransactionController_multichainTrackingHelper, _TransactionController_retryTransaction, _TransactionController_createNonceTracker, _TransactionController_createIncomingTransactionHelper, _TransactionController_createPendingTransactionTracker, _TransactionController_checkForPendingTransactionAndStartPolling, _TransactionController_stopAllTracking, _TransactionController_removeIncomingTransactionHelperListeners, _TransactionController_addIncomingTransactionHelperListeners, _TransactionController_removePendingTransactionTrackerListeners, _TransactionController_addPendingTransactionTrackerListeners, _TransactionController_getNonceTrackerPendingTransactions, _TransactionController_getGasFeeFlows, _TransactionController_getLayer1GasFeeFlows, _TransactionController_updateTransactionInternal, _TransactionController_updateSimulationData, _TransactionController_onGasFeePollerTransactionUpdate, _TransactionController_getNetworkClientId, _TransactionController_getGlobalNetworkClientId, _TransactionController_getGlobalChainId, _TransactionController_isCustomNetwork, _TransactionController_getSelectedAccount, _TransactionController_updateSubmitHistory;
+var _TransactionController_instances, _TransactionController_internalEvents, _TransactionController_incomingTransactionOptions, _TransactionController_pendingTransactionOptions, _TransactionController_trace, _TransactionController_transactionHistoryLimit, _TransactionController_isFirstTimeInteractionEnabled, _TransactionController_isSimulationEnabled, _TransactionController_testGasFeeFlows, _TransactionController_multichainTrackingHelper, _TransactionController_retryTransaction, _TransactionController_createNonceTracker, _TransactionController_createIncomingTransactionHelper, _TransactionController_createPendingTransactionTracker, _TransactionController_checkForPendingTransactionAndStartPolling, _TransactionController_stopAllTracking, _TransactionController_removeIncomingTransactionHelperListeners, _TransactionController_addIncomingTransactionHelperListeners, _TransactionController_removePendingTransactionTrackerListeners, _TransactionController_addPendingTransactionTrackerListeners, _TransactionController_getNonceTrackerPendingTransactions, _TransactionController_getGasFeeFlows, _TransactionController_getLayer1GasFeeFlows, _TransactionController_updateTransactionInternal, _TransactionController_updateFirstTimeInteraction, _TransactionController_updateSimulationData, _TransactionController_onGasFeePollerTransactionUpdate, _TransactionController_getNetworkClientId, _TransactionController_getGlobalNetworkClientId, _TransactionController_getGlobalChainId, _TransactionController_isCustomNetwork, _TransactionController_getSelectedAccount, _TransactionController_updateSubmitHistory;
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.TransactionController = exports.ApprovalState = exports.SPEED_UP_RATE = exports.CANCEL_RATE = exports.HARDFORK = void 0;
 const common_1 = require("@ethereumjs/common");
@@ -31,6 +31,7 @@ const eth_method_registry_1 = require("eth-method-registry");
 const events_1 = require("events");
 const lodash_1 = require("lodash");
 const uuid_1 = require("uuid");
+const accounts_api_1 = require("./api/accounts-api.cjs");
 const DefaultGasFeeFlow_1 = require("./gas-flows/DefaultGasFeeFlow.cjs");
 const LineaGasFeeFlow_1 = require("./gas-flows/LineaGasFeeFlow.cjs");
 const OptimismLayer1GasFeeFlow_1 = require("./gas-flows/OptimismLayer1GasFeeFlow.cjs");
@@ -177,6 +178,7 @@ class TransactionController extends base_controller_1.BaseController {
      * @param options.getSavedGasFees - Gets the saved gas fee config.
      * @param options.incomingTransactions - Configuration options for incoming transaction support.
      * @param options.isMultichainEnabled - Enable multichain support.
+     * @param options.isFirstTimeInteractionEnabled - Whether first time interaction checks are enabled.
      * @param options.isSimulationEnabled - Whether new transactions will be automatically simulated.
      * @param options.messenger - The controller messenger.
      * @param options.onNetworkStateChange - Allows subscribing to network controller state changes.
@@ -190,7 +192,7 @@ class TransactionController extends base_controller_1.BaseController {
      * @param options.transactionHistoryLimit - Transaction history limit.
      * @param options.hooks - The controller hooks.
      */
-    constructor({ blockTracker, disableHistory, disableSendFlowHistory, disableSwaps, getCurrentAccountEIP1559Compatibility, getCurrentNetworkEIP1559Compatibility, getExternalPendingTransactions, getGasFeeEstimates, getNetworkClientRegistry, getNetworkState, getPermittedAccounts, getSavedGasFees, incomingTransactions = {}, isMultichainEnabled = false, isSimulationEnabled, messenger, onNetworkStateChange, pendingTransactions = {}, provider, securityProviderRequest, sign, state, testGasFeeFlows, trace, transactionHistoryLimit = 40, hooks, }) {
+    constructor({ blockTracker, disableHistory, disableSendFlowHistory, disableSwaps, getCurrentAccountEIP1559Compatibility, getCurrentNetworkEIP1559Compatibility, getExternalPendingTransactions, getGasFeeEstimates, getNetworkClientRegistry, getNetworkState, getPermittedAccounts, getSavedGasFees, incomingTransactions = {}, isMultichainEnabled = false, isFirstTimeInteractionEnabled, isSimulationEnabled, messenger, onNetworkStateChange, pendingTransactions = {}, provider, securityProviderRequest, sign, state, testGasFeeFlows, trace, transactionHistoryLimit = 40, hooks, }) {
         super({
             name: controllerName,
             metadata,
@@ -209,6 +211,7 @@ class TransactionController extends base_controller_1.BaseController {
         this.signAbortCallbacks = new Map();
         _TransactionController_trace.set(this, void 0);
         _TransactionController_transactionHistoryLimit.set(this, void 0);
+        _TransactionController_isFirstTimeInteractionEnabled.set(this, void 0);
         _TransactionController_isSimulationEnabled.set(this, void 0);
         _TransactionController_testGasFeeFlows.set(this, void 0);
         _TransactionController_multichainTrackingHelper.set(this, void 0);
@@ -222,6 +225,7 @@ class TransactionController extends base_controller_1.BaseController {
         this.isSendFlowHistoryDisabled = disableSendFlowHistory ?? false;
         this.isHistoryDisabled = disableHistory ?? false;
         this.isSwapsDisabled = disableSwaps ?? false;
+        __classPrivateFieldSet(this, _TransactionController_isFirstTimeInteractionEnabled, isFirstTimeInteractionEnabled ?? (() => true), "f");
         __classPrivateFieldSet(this, _TransactionController_isSimulationEnabled, isSimulationEnabled ?? (() => true), "f");
         // @ts-expect-error the type in eth-method-registry is inappropriate and should be changed
         this.registry = new eth_method_registry_1.MethodRegistry({ provider });
@@ -403,15 +407,16 @@ class TransactionController extends base_controller_1.BaseController {
                 dappSuggestedGasFees,
                 deviceConfirmedOn,
                 id: (0, uuid_1.v1)(),
+                isFirstTimeInteraction: undefined,
+                networkClientId,
                 origin,
                 securityAlertResponse,
                 status: types_1.TransactionStatus.unapproved,
                 time: Date.now(),
                 txParams,
+                type: transactionType,
                 userEditedGasLimit: false,
                 verifiedOnBlockchain: false,
-                type: transactionType,
-                networkClientId,
             };
         await __classPrivateFieldGet(this, _TransactionController_trace, "f").call(this, { name: 'Estimate Gas Properties', parentContext: traceContext }, (context) => this.updateGasProperties(addedTransactionMeta, {
             traceContext: context,
@@ -444,9 +449,14 @@ class TransactionController extends base_controller_1.BaseController {
                     (0, logger_1.projectLogger)('Error while updating simulation data', error);
                     throw error;
                 });
+                __classPrivateFieldGet(this, _TransactionController_instances, "m", _TransactionController_updateFirstTimeInteraction).call(this, addedTransactionMeta, {
+                    traceContext,
+                }).catch((error) => {
+                    (0, logger_1.projectLogger)('Error while updating first interaction properties', error);
+                });
             }
             else {
-                (0, logger_1.projectLogger)('Skipping simulation as approval not required');
+                (0, logger_1.projectLogger)('Skipping simulation & first interaction update as approval not required');
             }
             this.messagingSystem.publish(`${controllerName}:unapprovedTransactionAdded`, addedTransactionMeta);
         }
@@ -1785,7 +1795,7 @@ class TransactionController extends base_controller_1.BaseController {
     }
 }
 exports.TransactionController = TransactionController;
-_TransactionController_internalEvents = new WeakMap(), _TransactionController_incomingTransactionOptions = new WeakMap(), _TransactionController_pendingTransactionOptions = new WeakMap(), _TransactionController_trace = new WeakMap(), _TransactionController_transactionHistoryLimit = new WeakMap(), _TransactionController_isSimulationEnabled = new WeakMap(), _TransactionController_testGasFeeFlows = new WeakMap(), _TransactionController_multichainTrackingHelper = new WeakMap(), _TransactionController_checkForPendingTransactionAndStartPolling = new WeakMap(), _TransactionController_instances = new WeakSet(), _TransactionController_retryTransaction = async function _TransactionController_retryTransaction({ actionId, afterSubmit, estimatedBaseFee, gasValues, label, prepareTransactionParams, rate, transactionId, transactionType, }) {
+_TransactionController_internalEvents = new WeakMap(), _TransactionController_incomingTransactionOptions = new WeakMap(), _TransactionController_pendingTransactionOptions = new WeakMap(), _TransactionController_trace = new WeakMap(), _TransactionController_transactionHistoryLimit = new WeakMap(), _TransactionController_isFirstTimeInteractionEnabled = new WeakMap(), _TransactionController_isSimulationEnabled = new WeakMap(), _TransactionController_testGasFeeFlows = new WeakMap(), _TransactionController_multichainTrackingHelper = new WeakMap(), _TransactionController_checkForPendingTransactionAndStartPolling = new WeakMap(), _TransactionController_instances = new WeakSet(), _TransactionController_retryTransaction = async function _TransactionController_retryTransaction({ actionId, afterSubmit, estimatedBaseFee, gasValues, label, prepareTransactionParams, rate, transactionId, transactionType, }) {
     // If transaction is found for same action id, do not create a new transaction.
     if (this.getTransactionWithActionId(actionId)) {
         return;
@@ -1963,6 +1973,48 @@ _TransactionController_internalEvents = new WeakMap(), _TransactionController_in
         });
     }
     return transactionMeta;
+}, _TransactionController_updateFirstTimeInteraction = async function _TransactionController_updateFirstTimeInteraction(transactionMeta, { traceContext, } = {}) {
+    if (!__classPrivateFieldGet(this, _TransactionController_isFirstTimeInteractionEnabled, "f").call(this)) {
+        return;
+    }
+    const { chainId, id: transactionId, txParams: { to, from }, } = transactionMeta;
+    const request = {
+        chainId: (0, utils_1.hexToNumber)(chainId),
+        to: to,
+        from,
+    };
+    (0, validation_1.validateParamTo)(to);
+    const existingTransaction = this.state.transactions.find((tx) => tx.chainId === chainId &&
+        tx.txParams.from === from &&
+        tx.txParams.to === to &&
+        tx.id !== transactionId);
+    // Check if there is an existing transaction with the same from, to, and chainId
+    // else we continue to check the account address relationship from API
+    if (existingTransaction) {
+        return;
+    }
+    try {
+        const { count } = await __classPrivateFieldGet(this, _TransactionController_trace, "f").call(this, { name: 'Account Address Relationship', parentContext: traceContext }, () => (0, accounts_api_1.getAccountAddressRelationship)(request));
+        const isFirstTimeInteraction = count === undefined ? undefined : count === 0;
+        const finalTransactionMeta = this.getTransaction(transactionId);
+        /* istanbul ignore if */
+        if (!finalTransactionMeta) {
+            (0, logger_1.projectLogger)('Cannot update first time interaction as transaction not found', transactionId);
+            return;
+        }
+        __classPrivateFieldGet(this, _TransactionController_instances, "m", _TransactionController_updateTransactionInternal).call(this, {
+            transactionId,
+            note: 'TransactionController#updateFirstInteraction - Update first time interaction',
+        }, (txMeta) => {
+            txMeta.isFirstTimeInteraction = isFirstTimeInteraction;
+        });
+        (0, logger_1.projectLogger)('Updated first time interaction', transactionId, {
+            isFirstTimeInteraction,
+        });
+    }
+    catch (error) {
+        (0, logger_1.projectLogger)('Error fetching account address relationship, skipping first time interaction update', error);
+    }
 }, _TransactionController_updateSimulationData = async function _TransactionController_updateSimulationData(transactionMeta, { blockTime, traceContext, } = {}) {
     const { id: transactionId, chainId, txParams, simulationData: prevSimulationData, } = transactionMeta;
     const { from, to, value, data } = txParams;