@metamask/transaction-controller 13.0.0 → 15.0.0

package/dist/TransactionController.js

@@ -30,9 +30,12 @@ const EtherscanRemoteTransactionSource_1 = require("./EtherscanRemoteTransaction
 const external_transactions_1 = require("./external-transactions");
 const history_1 = require("./history");
 const IncomingTransactionHelper_1 = require("./IncomingTransactionHelper");
+const logger_1 = require("./logger");
+const PendingTransactionTracker_1 = require("./PendingTransactionTracker");
 const transaction_type_1 = require("./transaction-type");
 const types_1 = require("./types");
 const utils_1 = require("./utils");
+const validation_1 = require("./validation");
 exports.HARDFORK = common_1.Hardfork.London;
 /**
  * Multiplier used to determine a transaction's increased gas fee during cancellation
@@ -60,6 +63,7 @@ class TransactionController extends base_controller_1.BaseController {
      * @param options.getCurrentAccountEIP1559Compatibility - Whether or not the account supports EIP-1559.
      * @param options.getCurrentNetworkEIP1559Compatibility - Whether or not the network supports EIP-1559.
      * @param options.getNetworkState - Gets the state of the network controller.
+     * @param options.getPermittedAccounts - Get accounts that a given origin has permissions for.
      * @param options.getSelectedAddress - Gets the address of the currently selected account.
      * @param options.incomingTransactions - Configuration options for incoming transaction support.
      * @param options.incomingTransactions.includeTokenTransfers - Whether or not to include ERC20 token transfers.
@@ -69,10 +73,11 @@ class TransactionController extends base_controller_1.BaseController {
      * @param options.messenger - The controller messenger.
      * @param options.onNetworkStateChange - Allows subscribing to network controller state changes.
      * @param options.provider - The provider used to create the underlying EthQuery instance.
+     * @param options.securityProviderRequest - A function for verifying a transaction, whether it is malicious or not.
      * @param config - Initial options used to configure this controller.
      * @param state - Initial state to set on this controller.
      */
-    constructor({ blockTracker, disableHistory, disableSendFlowHistory, getCurrentAccountEIP1559Compatibility, getCurrentNetworkEIP1559Compatibility, getNetworkState, getSelectedAddress, incomingTransactions = {}, messenger, onNetworkStateChange, provider, }, config, state) {
+    constructor({ blockTracker, disableHistory, disableSendFlowHistory, getCurrentAccountEIP1559Compatibility, getCurrentNetworkEIP1559Compatibility, getNetworkState, getPermittedAccounts, getSelectedAddress, incomingTransactions = {}, messenger, onNetworkStateChange, provider, securityProviderRequest, }, config, state) {
         super(config, state);
         this.mutex = new async_mutex_1.Mutex();
         /**
@@ -84,7 +89,6 @@ class TransactionController extends base_controller_1.BaseController {
          */
         this.name = 'TransactionController';
         this.defaultConfig = {
-            interval: 15000,
             txHistoryLimit: 40,
         };
         this.defaultState = {
@@ -96,6 +100,7 @@ class TransactionController extends base_controller_1.BaseController {
         this.provider = provider;
         this.messagingSystem = messenger;
         this.getNetworkState = getNetworkState;
+        // @ts-expect-error TODO: Provider type alignment
         this.ethQuery = new eth_query_1.default(provider);
         this.isSendFlowHistoryDisabled = disableSendFlowHistory !== null && disableSendFlowHistory !== void 0 ? disableSendFlowHistory : false;
         this.isHistoryDisabled = disableHistory !== null && disableHistory !== void 0 ? disableHistory : false;
@@ -104,6 +109,9 @@ class TransactionController extends base_controller_1.BaseController {
             getCurrentAccountEIP1559Compatibility;
         this.getCurrentNetworkEIP1559Compatibility =
             getCurrentNetworkEIP1559Compatibility;
+        this.getPermittedAccounts = getPermittedAccounts;
+        this.getSelectedAddress = getSelectedAddress;
+        this.securityProviderRequest = securityProviderRequest;
         this.nonceTracker = new nonce_tracker_1.default({
             provider,
             blockTracker,
@@ -125,11 +133,21 @@ class TransactionController extends base_controller_1.BaseController {
         });
         this.incomingTransactionHelper.hub.on('transactions', this.onIncomingTransactions.bind(this));
         this.incomingTransactionHelper.hub.on('updatedLastFetchedBlockNumbers', this.onUpdatedLastFetchedBlockNumbers.bind(this));
+        this.pendingTransactionTracker = new PendingTransactionTracker_1.PendingTransactionTracker({
+            blockTracker,
+            failTransaction: this.failTransaction.bind(this),
+            getChainId: this.getChainId.bind(this),
+            getEthQuery: () => this.ethQuery,
+            getTransactions: () => this.state.transactions,
+        });
+        this.pendingTransactionTracker.hub.on('transactions', this.onPendingTransactionsUpdate.bind(this));
+        this.pendingTransactionTracker.hub.on('transaction-confirmed', (transactionMeta) => this.hub.emit(`${transactionMeta.id}:confirmed`, transactionMeta));
         onNetworkStateChange(() => {
+            // @ts-expect-error TODO: Provider type alignment
             this.ethQuery = new eth_query_1.default(this.provider);
             this.registry = new eth_method_registry_1.default({ provider: this.provider });
         });
-        this.poll();
+        this.pendingTransactionTracker.start();
     }
     failTransaction(transactionMeta, error) {
         const newTransactionMeta = Object.assign(Object.assign({}, transactionMeta), { error, status: types_1.TransactionStatus.failed });
@@ -143,21 +161,6 @@ class TransactionController extends base_controller_1.BaseController {
             return { registryMethod, parsedRegistryMethod };
         });
     }
-    /**
-     * Starts a new polling interval.
-     *
-     * @param interval - The polling interval used to fetch new transaction statuses.
-     */
-    poll(interval) {
-        return __awaiter(this, void 0, void 0, function* () {
-            interval && this.configure({ interval }, false, false);
-            this.handle && clearTimeout(this.handle);
-            yield (0, controller_utils_1.safelyExecute)(() => this.queryTransactionStatuses());
-            this.handle = setTimeout(() => {
-                this.poll(this.config.interval);
-            }, this.config.interval);
-        });
-    }
     /**
      * Handle new method data request.
      *
@@ -193,6 +196,7 @@ class TransactionController extends base_controller_1.BaseController {
      * @param opts - Additional options to control how the transaction is added.
      * @param opts.actionId - Unique ID to prevent duplicate requests.
      * @param opts.deviceConfirmedOn - An enum to indicate what device confirmed the transaction.
+     * @param opts.method - RPC method that requested the transaction.
      * @param opts.origin - The origin of the transaction request, such as a dApp hostname.
      * @param opts.requireApproval - Whether the transaction requires approval by the user, defaults to true unless explicitly disabled.
      * @param opts.securityAlertResponse - Response from security validator.
@@ -200,13 +204,16 @@ class TransactionController extends base_controller_1.BaseController {
      * @param opts.type - Type of transaction to add, such as 'cancel' or 'swap'.
      * @returns Object containing a promise resolving to the transaction hash if approved.
      */
-    addTransaction(txParams, { actionId, deviceConfirmedOn, origin, requireApproval, securityAlertResponse, sendFlowHistory, type, } = {}) {
+    addTransaction(txParams, { actionId, deviceConfirmedOn, method, origin, requireApproval, securityAlertResponse, sendFlowHistory, type, } = {}) {
         return __awaiter(this, void 0, void 0, function* () {
             const chainId = this.getChainId();
             const { transactions } = this.state;
             txParams = (0, utils_1.normalizeTxParams)(txParams);
             const isEIP1559Compatible = yield this.getEIP1559Compatibility();
-            (0, utils_1.validateTxParams)(txParams, isEIP1559Compatible);
+            (0, validation_1.validateTxParams)(txParams, isEIP1559Compatible);
+            if (origin) {
+                yield (0, validation_1.validateTransactionOrigin)(yield this.getPermittedAccounts(origin), this.getSelectedAddress(), txParams.from, origin);
+            }
             const dappSuggestedGasFees = this.generateDappSuggestedGasFees(txParams, origin);
             const transactionType = type !== null && type !== void 0 ? type : (yield (0, transaction_type_1.determineTransactionType)(txParams, this.ethQuery)).type;
             const existingTransactionMeta = this.getTransactionWithActionId(actionId);
@@ -239,6 +246,11 @@ class TransactionController extends base_controller_1.BaseController {
             }
             // Checks if a transaction already exists with a given actionId
             if (!existingTransactionMeta) {
+                // Set security provider response
+                if (method && this.securityProviderRequest) {
+                    const securityProviderResponse = yield this.securityProviderRequest(transactionMeta, method);
+                    transactionMeta.securityProviderResponse = securityProviderResponse;
+                }
                 if (!this.isSendFlowHistoryDisabled) {
                     transactionMeta.sendFlowHistory = sendFlowHistory !== null && sendFlowHistory !== void 0 ? sendFlowHistory : [];
                 }
@@ -495,32 +507,6 @@ class TransactionController extends base_controller_1.BaseController {
             return { gas: (0, ethereumjs_util_1.addHexPrefix)((0, controller_utils_1.BNToHex)(maxGasBN)), gasPrice, estimateGasError };
         });
     }
-    /**
-     * Check the status of submitted transactions on the network to determine whether they have
-     * been included in a block. Any that have been included in a block are marked as confirmed.
-     */
-    queryTransactionStatuses() {
-        return __awaiter(this, void 0, void 0, function* () {
-            const { transactions } = this.state;
-            const currentChainId = this.getChainId();
-            let gotUpdates = false;
-            yield (0, controller_utils_1.safelyExecute)(() => Promise.all(transactions.map((meta, index) => __awaiter(this, void 0, void 0, function* () {
-                if (!meta.verifiedOnBlockchain && meta.chainId === currentChainId) {
-                    const [reconciledTx, updateRequired] = yield this.blockchainTransactionStateReconciler(meta);
-                    if (updateRequired) {
-                        transactions[index] = reconciledTx;
-                        gotUpdates = updateRequired;
-                    }
-                }
-            }))));
-            /* istanbul ignore else */
-            if (gotUpdates) {
-                this.update({
-                    transactions: this.trimTransactionsForState(transactions),
-                });
-            }
-        });
-    }
     /**
      * Updates an existing transaction in state.
      *
@@ -530,7 +516,7 @@ class TransactionController extends base_controller_1.BaseController {
     updateTransaction(transactionMeta, note) {
         const { transactions } = this.state;
         transactionMeta.txParams = (0, utils_1.normalizeTxParams)(transactionMeta.txParams);
-        (0, utils_1.validateTxParams)(transactionMeta.txParams);
+        (0, validation_1.validateTxParams)(transactionMeta.txParams);
         if (!this.isHistoryDisabled) {
             (0, history_1.updateTransactionHistory)(transactionMeta, note);
         }
@@ -884,85 +870,6 @@ class TransactionController extends base_controller_1.BaseController {
             types_1.TransactionStatus.submitted,
         ].includes(status);
     }
-    /**
-     * Method to verify the state of a transaction using the Blockchain as a source of truth.
-     *
-     * @param meta - The local transaction to verify on the blockchain.
-     * @returns A tuple containing the updated transaction, and whether or not an update was required.
-     */
-    blockchainTransactionStateReconciler(meta) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const { status, hash } = meta;
-            switch (status) {
-                case types_1.TransactionStatus.confirmed:
-                    const txReceipt = yield (0, controller_utils_1.query)(this.ethQuery, 'getTransactionReceipt', [
-                        hash,
-                    ]);
-                    if (!txReceipt) {
-                        return [meta, false];
-                    }
-                    const txBlock = yield (0, controller_utils_1.query)(this.ethQuery, 'getBlockByHash', [
-                        txReceipt.blockHash,
-                    ]);
-                    meta.verifiedOnBlockchain = true;
-                    meta.txParams.gasUsed = txReceipt.gasUsed;
-                    meta.txReceipt = txReceipt;
-                    meta.baseFeePerGas = txBlock === null || txBlock === void 0 ? void 0 : txBlock.baseFeePerGas;
-                    meta.blockTimestamp = txBlock === null || txBlock === void 0 ? void 0 : txBlock.timestamp;
-                    // According to the Web3 docs:
-                    // TRUE if the transaction was successful, FALSE if the EVM reverted the transaction.
-                    if (Number(txReceipt.status) === 0) {
-                        const error = new Error('Transaction failed. The transaction was reversed');
-                        this.failTransaction(meta, error);
-                        return [meta, false];
-                    }
-                    return [meta, true];
-                case types_1.TransactionStatus.submitted:
-                    const txObj = yield (0, controller_utils_1.query)(this.ethQuery, 'getTransactionByHash', [
-                        hash,
-                    ]);
-                    if (!txObj) {
-                        const receiptShowsFailedStatus = yield this.checkTxReceiptStatusIsFailed(hash);
-                        // Case the txObj is evaluated as false, a second check will
-                        // determine if the tx failed or it is pending or confirmed
-                        if (receiptShowsFailedStatus) {
-                            const error = new Error('Transaction failed. The transaction was dropped or replaced by a new one');
-                            this.failTransaction(meta, error);
-                        }
-                    }
-                    /* istanbul ignore next */
-                    if (txObj === null || txObj === void 0 ? void 0 : txObj.blockNumber) {
-                        meta.status = types_1.TransactionStatus.confirmed;
-                        this.hub.emit(`${meta.id}:confirmed`, meta);
-                        return [meta, true];
-                    }
-                    return [meta, false];
-                default:
-                    return [meta, false];
-            }
-        });
-    }
-    /**
-     * Method to check if a tx has failed according to their receipt
-     * According to the Web3 docs:
-     * TRUE if the transaction was successful, FALSE if the EVM reverted the transaction.
-     * The receipt is not available for pending transactions and returns null.
-     *
-     * @param txHash - The transaction hash.
-     * @returns Whether the transaction has failed.
-     */
-    checkTxReceiptStatusIsFailed(txHash) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const txReceipt = yield (0, controller_utils_1.query)(this.ethQuery, 'getTransactionReceipt', [
-                txHash,
-            ]);
-            if (!txReceipt) {
-                // Transaction is pending
-                return false;
-            }
-            return Number(txReceipt.status) === 0;
-        });
-    }
     requestApproval(txMeta, { shouldShowRequest }) {
         return __awaiter(this, void 0, void 0, function* () {
             const id = this.getApprovalId(txMeta);
@@ -1043,6 +950,10 @@ class TransactionController extends base_controller_1.BaseController {
         this.update({ lastFetchedBlockNumbers });
         this.hub.emit('incomingTransactionBlock', blockNumber);
     }
+    onPendingTransactionsUpdate(transactions) {
+        (0, logger_1.pendingTransactionsLogger)('Updated pending transactions');
+        this.update({ transactions: this.trimTransactionsForState(transactions) });
+    }
     generateDappSuggestedGasFees(txParams, origin) {
         if (!origin || origin === controller_utils_1.ORIGIN_METAMASK) {
             return undefined;