@metamask/transaction-controller 11.0.0 → 13.0.0

package/dist/TransactionController.js

@@ -18,9 +18,9 @@ const tx_1 = require("@ethereumjs/tx");
 const base_controller_1 = require("@metamask/base-controller");
 const controller_utils_1 = require("@metamask/controller-utils");
 const eth_query_1 = __importDefault(require("@metamask/eth-query"));
+const rpc_errors_1 = require("@metamask/rpc-errors");
 const async_mutex_1 = require("async-mutex");
 const eth_method_registry_1 = __importDefault(require("eth-method-registry"));
-const eth_rpc_errors_1 = require("eth-rpc-errors");
 const ethereumjs_util_1 = require("ethereumjs-util");
 const events_1 = require("events");
 const lodash_1 = require("lodash");
@@ -30,6 +30,7 @@ const EtherscanRemoteTransactionSource_1 = require("./EtherscanRemoteTransaction
 const external_transactions_1 = require("./external-transactions");
 const history_1 = require("./history");
 const IncomingTransactionHelper_1 = require("./IncomingTransactionHelper");
+const transaction_type_1 = require("./transaction-type");
 const types_1 = require("./types");
 const utils_1 = require("./utils");
 exports.HARDFORK = common_1.Hardfork.London;
@@ -56,6 +57,8 @@ class TransactionController extends base_controller_1.BaseController {
      * @param options.blockTracker - The block tracker used to poll for new blocks data.
      * @param options.disableHistory - Whether to disable storing history in transaction metadata.
      * @param options.disableSendFlowHistory - Explicitly disable transaction metadata history.
+     * @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.getSelectedAddress - Gets the address of the currently selected account.
      * @param options.incomingTransactions - Configuration options for incoming transaction support.
@@ -69,7 +72,7 @@ class TransactionController extends base_controller_1.BaseController {
      * @param config - Initial options used to configure this controller.
      * @param state - Initial state to set on this controller.
      */
-    constructor({ blockTracker, disableHistory, disableSendFlowHistory, getNetworkState, getSelectedAddress, incomingTransactions = {}, messenger, onNetworkStateChange, provider, }, config, state) {
+    constructor({ blockTracker, disableHistory, disableSendFlowHistory, getCurrentAccountEIP1559Compatibility, getCurrentNetworkEIP1559Compatibility, getNetworkState, getSelectedAddress, incomingTransactions = {}, messenger, onNetworkStateChange, provider, }, config, state) {
         super(config, state);
         this.mutex = new async_mutex_1.Mutex();
         /**
@@ -97,6 +100,10 @@ class TransactionController extends base_controller_1.BaseController {
         this.isSendFlowHistoryDisabled = disableSendFlowHistory !== null && disableSendFlowHistory !== void 0 ? disableSendFlowHistory : false;
         this.isHistoryDisabled = disableHistory !== null && disableHistory !== void 0 ? disableHistory : false;
         this.registry = new eth_method_registry_1.default({ provider });
+        this.getCurrentAccountEIP1559Compatibility =
+            getCurrentAccountEIP1559Compatibility;
+        this.getCurrentNetworkEIP1559Compatibility =
+            getCurrentNetworkEIP1559Compatibility;
         this.nonceTracker = new nonce_tracker_1.default({
             provider,
             blockTracker,
@@ -190,15 +197,18 @@ class TransactionController extends base_controller_1.BaseController {
      * @param opts.requireApproval - Whether the transaction requires approval by the user, defaults to true unless explicitly disabled.
      * @param opts.securityAlertResponse - Response from security validator.
      * @param opts.sendFlowHistory - The sendFlowHistory entries to add.
+     * @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, } = {}) {
+    addTransaction(txParams, { actionId, deviceConfirmedOn, origin, requireApproval, securityAlertResponse, sendFlowHistory, type, } = {}) {
         return __awaiter(this, void 0, void 0, function* () {
-            const { chainId, networkId } = this.getChainAndNetworkId();
+            const chainId = this.getChainId();
             const { transactions } = this.state;
             txParams = (0, utils_1.normalizeTxParams)(txParams);
-            (0, utils_1.validateTxParams)(txParams);
+            const isEIP1559Compatible = yield this.getEIP1559Compatibility();
+            (0, utils_1.validateTxParams)(txParams, isEIP1559Compatible);
             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);
             // If a request to add a transaction with the same actionId is submitted again, a new transaction will not be created for it.
             const transactionMeta = existingTransactionMeta || {
@@ -208,7 +218,6 @@ class TransactionController extends base_controller_1.BaseController {
                 dappSuggestedGasFees,
                 deviceConfirmedOn,
                 id: (0, uuid_1.v1)(),
-                networkID: networkId !== null && networkId !== void 0 ? networkId : undefined,
                 origin,
                 securityAlertResponse,
                 status: types_1.TransactionStatus.unapproved,
@@ -216,6 +225,7 @@ class TransactionController extends base_controller_1.BaseController {
                 txParams,
                 userEditedGasLimit: false,
                 verifiedOnBlockchain: false,
+                type: transactionType,
             };
             try {
                 const { gas, estimateGasError } = yield this.estimateGas(txParams);
@@ -266,9 +276,9 @@ class TransactionController extends base_controller_1.BaseController {
      * Creates approvals for all unapproved transactions persisted.
      */
     initApprovals() {
-        const { networkId, chainId } = this.getChainAndNetworkId();
+        const chainId = this.getChainId();
         const unapprovedTxs = this.state.transactions.filter((transaction) => transaction.status === types_1.TransactionStatus.unapproved &&
-            (0, utils_1.transactionMatchesNetwork)(transaction, chainId, networkId));
+            transaction.chainId === chainId);
         for (const txMeta of unapprovedTxs) {
             this.processApproval(txMeta, {
                 shouldShowRequest: false,
@@ -406,7 +416,7 @@ class TransactionController extends base_controller_1.BaseController {
             const rawTx = (0, ethereumjs_util_1.bufferToHex)(signedTx.serialize());
             const hash = yield (0, controller_utils_1.query)(this.ethQuery, 'sendRawTransaction', [rawTx]);
             const baseTransactionMeta = Object.assign(Object.assign({}, transactionMeta), { estimatedBaseFee, id: (0, uuid_1.v1)(), time: Date.now(), hash,
-                actionId, originalGasEstimate: transactionMeta.txParams.gas });
+                actionId, originalGasEstimate: transactionMeta.txParams.gas, type: types_1.TransactionType.retry });
             const newTransactionMeta = newMaxFeePerGas && newMaxPriorityFeePerGas
                 ? Object.assign(Object.assign({}, baseTransactionMeta), { txParams: Object.assign(Object.assign({}, transactionMeta.txParams), { maxFeePerGas: newMaxFeePerGas, maxPriorityFeePerGas: newMaxPriorityFeePerGas }) }) : Object.assign(Object.assign({}, baseTransactionMeta), { txParams: Object.assign(Object.assign({}, transactionMeta.txParams), { gasPrice: newGasPrice }) });
             transactions.push(newTransactionMeta);
@@ -492,14 +502,10 @@ class TransactionController extends base_controller_1.BaseController {
     queryTransactionStatuses() {
         return __awaiter(this, void 0, void 0, function* () {
             const { transactions } = this.state;
-            const { chainId: currentChainId, networkId: currentNetworkID } = this.getChainAndNetworkId();
+            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* () {
-                // Using fallback to networkID only when there is no chainId present.
-                // Should be removed when networkID is completely removed.
-                const txBelongsToCurrentChain = meta.chainId === currentChainId ||
-                    (!meta.chainId && meta.networkID === currentNetworkID);
-                if (!meta.verifiedOnBlockchain && txBelongsToCurrentChain) {
+                if (!meta.verifiedOnBlockchain && meta.chainId === currentChainId) {
                     const [reconciledTx, updateRequired] = yield this.blockchainTransactionStateReconciler(meta);
                     if (updateRequired) {
                         transactions[index] = reconciledTx;
@@ -546,13 +552,10 @@ class TransactionController extends base_controller_1.BaseController {
             this.update({ transactions: [] });
             return;
         }
-        const { chainId: currentChainId, networkId: currentNetworkID } = this.getChainAndNetworkId();
-        const newTransactions = this.state.transactions.filter(({ networkID, chainId, txParams }) => {
+        const currentChainId = this.getChainId();
+        const newTransactions = this.state.transactions.filter(({ chainId, txParams }) => {
             var _a;
-            // Using fallback to networkID only when there is no chainId present. Should be removed when networkID is completely removed.
-            const isMatchingNetwork = ignoreNetwork ||
-                chainId === currentChainId ||
-                (!chainId && networkID === currentNetworkID);
+            const isMatchingNetwork = ignoreNetwork || chainId === currentChainId;
             if (!isMatchingNetwork) {
                 return true;
             }
@@ -697,9 +700,9 @@ class TransactionController extends base_controller_1.BaseController {
                 catch (error) {
                     const { isCompleted: isTxCompleted } = this.isTransactionCompleted(transactionId);
                     if (!isTxCompleted) {
-                        if (error.code === eth_rpc_errors_1.errorCodes.provider.userRejectedRequest) {
+                        if (error.code === rpc_errors_1.errorCodes.provider.userRejectedRequest) {
                             this.cancelTransaction(transactionId);
-                            throw eth_rpc_errors_1.ethErrors.provider.userRejectedRequest('User rejected the transaction');
+                            throw rpc_errors_1.providerErrors.userRejectedRequest('User rejected the transaction');
                         }
                         else {
                             this.failTransaction(meta, error);
@@ -711,16 +714,16 @@ class TransactionController extends base_controller_1.BaseController {
             switch (finalMeta === null || finalMeta === void 0 ? void 0 : finalMeta.status) {
                 case types_1.TransactionStatus.failed:
                     resultCallbacks === null || resultCallbacks === void 0 ? void 0 : resultCallbacks.error(finalMeta.error);
-                    throw eth_rpc_errors_1.ethErrors.rpc.internal(finalMeta.error.message);
+                    throw rpc_errors_1.rpcErrors.internal(finalMeta.error.message);
                 case types_1.TransactionStatus.cancelled:
-                    const cancelError = eth_rpc_errors_1.ethErrors.rpc.internal('User cancelled the transaction');
+                    const cancelError = rpc_errors_1.rpcErrors.internal('User cancelled the transaction');
                     resultCallbacks === null || resultCallbacks === void 0 ? void 0 : resultCallbacks.error(cancelError);
                     throw cancelError;
                 case types_1.TransactionStatus.submitted:
                     resultCallbacks === null || resultCallbacks === void 0 ? void 0 : resultCallbacks.success();
                     return finalMeta.hash;
                 default:
-                    const internalError = eth_rpc_errors_1.ethErrors.rpc.internal(`MetaMask Tx Signature: Unknown problem: ${JSON.stringify(finalMeta || transactionId)}`);
+                    const internalError = rpc_errors_1.rpcErrors.internal(`MetaMask Tx Signature: Unknown problem: ${JSON.stringify(finalMeta || transactionId)}`);
                     resultCallbacks === null || resultCallbacks === void 0 ? void 0 : resultCallbacks.error(internalError);
                     throw internalError;
             }
@@ -738,7 +741,7 @@ class TransactionController extends base_controller_1.BaseController {
         return __awaiter(this, void 0, void 0, function* () {
             const { transactions } = this.state;
             const releaseLock = yield this.mutex.acquire();
-            const { chainId } = this.getChainAndNetworkId();
+            const chainId = this.getChainId();
             const index = transactions.findIndex(({ id }) => transactionId === id);
             const transactionMeta = transactions[index];
             const { txParams: { nonce, from }, } = transactionMeta;
@@ -837,9 +840,9 @@ class TransactionController extends base_controller_1.BaseController {
         const txsToKeep = transactions
             .sort((a, b) => (a.time > b.time ? -1 : 1)) // Descending time order
             .filter((tx) => {
-            const { chainId, networkID, status, txParams, time } = tx;
+            const { chainId, status, txParams, time } = tx;
             if (txParams) {
-                const key = `${txParams.nonce}-${chainId ? (0, controller_utils_1.convertHexToDecimal)(chainId) : networkID}-${new Date(time).toDateString()}`;
+                const key = `${txParams.nonce}-${(0, controller_utils_1.convertHexToDecimal)(chainId)}-${new Date(time).toDateString()}`;
                 if (nonceNetworkSet.has(key)) {
                     return true;
                 }
@@ -990,10 +993,9 @@ class TransactionController extends base_controller_1.BaseController {
         const isCompleted = this.isLocalFinalState(transaction.status);
         return { meta: transaction, isCompleted };
     }
-    getChainAndNetworkId() {
-        const { networkId, providerConfig } = this.getNetworkState();
-        const chainId = providerConfig === null || providerConfig === void 0 ? void 0 : providerConfig.chainId;
-        return { networkId, chainId };
+    getChainId() {
+        const { providerConfig } = this.getNetworkState();
+        return providerConfig.chainId;
     }
     prepareUnsignedEthTx(txParams) {
         return tx_1.TransactionFactory.fromTxData(txParams, {
@@ -1011,7 +1013,7 @@ class TransactionController extends base_controller_1.BaseController {
      * @returns common configuration object
      */
     getCommonConfiguration() {
-        const { networkId, providerConfig: { type: chain, chainId, nickname: name }, } = this.getNetworkState();
+        const { providerConfig: { type: chain, chainId, nickname: name }, } = this.getNetworkState();
         if (chain !== controller_utils_1.RPC &&
             chain !== controller_utils_1.NetworkType['linea-goerli'] &&
             chain !== controller_utils_1.NetworkType['linea-mainnet']) {
@@ -1020,7 +1022,6 @@ class TransactionController extends base_controller_1.BaseController {
         const customChainParams = {
             name,
             chainId: parseInt(chainId, 16),
-            networkId: networkId === null ? NaN : parseInt(networkId, undefined),
             defaultHardfork: exports.HARDFORK,
         };
         return common_1.Common.custom(customChainParams);
@@ -1075,11 +1076,11 @@ class TransactionController extends base_controller_1.BaseController {
     addExternalTransaction(transactionMeta) {
         var _a, _b;
         return __awaiter(this, void 0, void 0, function* () {
-            const { networkId, chainId } = this.getChainAndNetworkId();
+            const chainId = this.getChainId();
             const { transactions } = this.state;
             const fromAddress = (_a = transactionMeta === null || transactionMeta === void 0 ? void 0 : transactionMeta.txParams) === null || _a === void 0 ? void 0 : _a.from;
             const sameFromAndNetworkTransactions = transactions.filter((transaction) => transaction.txParams.from === fromAddress &&
-                (0, utils_1.transactionMatchesNetwork)(transaction, chainId, networkId));
+                transaction.chainId === chainId);
             const confirmedTxs = sameFromAndNetworkTransactions.filter((transaction) => transaction.status === types_1.TransactionStatus.confirmed);
             const pendingTxs = sameFromAndNetworkTransactions.filter((transaction) => transaction.status === types_1.TransactionStatus.submitted);
             (0, external_transactions_1.validateConfirmedExternalTransaction)(transactionMeta, confirmedTxs, pendingTxs);
@@ -1103,13 +1104,13 @@ class TransactionController extends base_controller_1.BaseController {
      */
     markNonceDuplicatesDropped(transactionId) {
         var _a, _b;
-        const { networkId, chainId } = this.getChainAndNetworkId();
+        const chainId = this.getChainId();
         const transactionMeta = this.getTransaction(transactionId);
         const nonce = (_a = transactionMeta === null || transactionMeta === void 0 ? void 0 : transactionMeta.txParams) === null || _a === void 0 ? void 0 : _a.nonce;
         const from = (_b = transactionMeta === null || transactionMeta === void 0 ? void 0 : transactionMeta.txParams) === null || _b === void 0 ? void 0 : _b.from;
         const sameNonceTxs = this.state.transactions.filter((transaction) => transaction.txParams.from === from &&
             transaction.txParams.nonce === nonce &&
-            (0, utils_1.transactionMatchesNetwork)(transaction, chainId, networkId));
+            transaction.chainId === chainId);
         if (!sameNonceTxs.length) {
             return;
         }
@@ -1173,6 +1174,14 @@ class TransactionController extends base_controller_1.BaseController {
             }
         });
     }
+    getEIP1559Compatibility() {
+        var _a, _b;
+        return __awaiter(this, void 0, void 0, function* () {
+            const currentNetworkIsEIP1559Compatible = yield this.getCurrentNetworkEIP1559Compatibility();
+            const currentAccountIsEIP1559Compatible = (_b = (_a = this.getCurrentAccountEIP1559Compatibility) === null || _a === void 0 ? void 0 : _a.call(this)) !== null && _b !== void 0 ? _b : true;
+            return (currentNetworkIsEIP1559Compatible && currentAccountIsEIP1559Compatible);
+        });
+    }
 }
 exports.TransactionController = TransactionController;
 exports.default = TransactionController;