@metamask-previews/transaction-controller 9.2.0-preview.f71e42f → 10.0.0-preview.2f7e793

package/dist/TransactionController.js

@@ -58,7 +58,8 @@ class TransactionController extends base_controller_1.BaseController {
      * @param options.incomingTransactions.apiKey - An optional API key to use when fetching remote transaction data.
      * @param options.incomingTransactions.includeTokenTransfers - Whether or not to include ERC20 token transfers.
      * @param options.incomingTransactions.isEnabled - Whether or not incoming transaction retrieval is enabled.
-     * @param options.incomingTransactions.updateTransactions - Whether or not to update local transactions using remote transaction data.
+     * @param options.incomingTransactions.queryEntireHistory - Whether to initially query the entire transaction history or only recent blocks.
+     * @param options.incomingTransactions.updateTransactions - Whether to update local transactions using remote transaction data.
      * @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.
@@ -100,8 +101,10 @@ class TransactionController extends base_controller_1.BaseController {
         this.incomingTransactionHelper = new IncomingTransactionHelper_1.IncomingTransactionHelper({
             blockTracker,
             getCurrentAccount: getSelectedAddress,
+            getLastFetchedBlockNumbers: () => this.state.lastFetchedBlockNumbers,
             getNetworkState,
             isEnabled: incomingTransactions.isEnabled,
+            queryEntireHistory: incomingTransactions.queryEntireHistory,
             remoteTransactionSource: new EtherscanRemoteTransactionSource_1.EtherscanRemoteTransactionSource({
                 apiKey: incomingTransactions.apiKey,
                 includeTokenTransfers: incomingTransactions.includeTokenTransfers,
@@ -186,7 +189,7 @@ class TransactionController extends base_controller_1.BaseController {
      */
     addTransaction(transaction, { actionId, deviceConfirmedOn, origin, requireApproval, securityAlertResponse, } = {}) {
         return __awaiter(this, void 0, void 0, function* () {
-            const chainId = this.getChainId();
+            const { chainId, networkId } = this.getChainAndNetworkId();
             const { transactions } = this.state;
             transaction = (0, utils_1.normalizeTransaction)(transaction);
             (0, utils_1.validateTransaction)(transaction);
@@ -195,6 +198,7 @@ class TransactionController extends base_controller_1.BaseController {
             // 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 || {
                 id: (0, uuid_1.v1)(),
+                networkID: networkId !== null && networkId !== void 0 ? networkId : undefined,
                 chainId,
                 origin,
                 status: types_1.TransactionStatus.unapproved,
@@ -211,6 +215,7 @@ class TransactionController extends base_controller_1.BaseController {
                 const { gas, estimateGasError } = yield this.estimateGas(transaction);
                 transaction.gas = gas;
                 transaction.estimateGasError = estimateGasError;
+                transactionMeta.originalGasEstimate = gas;
             }
             catch (error) {
                 this.failTransaction(transactionMeta, error);
@@ -248,9 +253,9 @@ class TransactionController extends base_controller_1.BaseController {
      * Creates approvals for all unapproved transactions persisted.
      */
     initApprovals() {
-        const chainId = this.getChainId();
+        const { networkId, chainId } = this.getChainAndNetworkId();
         const unapprovedTxs = this.state.transactions.filter((transaction) => transaction.status === types_1.TransactionStatus.unapproved &&
-            (0, utils_1.transactionMatchesChainId)(transaction, chainId));
+            (0, utils_1.transactionMatchesNetwork)(transaction, chainId, networkId));
         for (const txMeta of unapprovedTxs) {
             this.processApproval(txMeta, {
                 shouldShowRequest: false,
@@ -384,11 +389,9 @@ class TransactionController extends base_controller_1.BaseController {
             const unsignedEthTx = this.prepareUnsignedEthTx(txParams);
             const signedTx = yield this.sign(unsignedEthTx, transactionMeta.transaction.from);
             const rawTx = (0, ethereumjs_util_1.bufferToHex)(signedTx.serialize());
-            const transactionHash = 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(), transactionHash,
-                actionId });
+            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.transaction.gas });
             const newTransactionMeta = newMaxFeePerGas && newMaxPriorityFeePerGas
                 ? Object.assign(Object.assign({}, baseTransactionMeta), { transaction: Object.assign(Object.assign({}, transactionMeta.transaction), { maxFeePerGas: newMaxFeePerGas, maxPriorityFeePerGas: newMaxPriorityFeePerGas }) }) : Object.assign(Object.assign({}, baseTransactionMeta), { transaction: Object.assign(Object.assign({}, transactionMeta.transaction), { gasPrice: newGasPrice }) });
             transactions.push(newTransactionMeta);
@@ -420,7 +423,7 @@ class TransactionController extends base_controller_1.BaseController {
                 false,
             ]);
             // 2. If to is not defined or this is not a contract address, and there is no data use 0x5208 / 21000.
-            // If the newtwork is a custom network then bypass this check and fetch 'estimateGas'.
+            // If the network is a custom network then bypass this check and fetch 'estimateGas'.
             /* istanbul ignore next */
             const code = to ? yield (0, controller_utils_1.query)(this.ethQuery, 'getCode', [to]) : undefined;
             /* istanbul ignore next */
@@ -474,11 +477,14 @@ class TransactionController extends base_controller_1.BaseController {
     queryTransactionStatuses() {
         return __awaiter(this, void 0, void 0, function* () {
             const { transactions } = this.state;
-            const currentChainId = this.getChainId();
+            const { chainId: currentChainId, networkId: currentNetworkID } = this.getChainAndNetworkId();
             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 &&
-                    (0, utils_1.transactionMatchesChainId)(meta, currentChainId)) {
+                // 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) {
                     const [reconciledTx, updateRequired] = yield this.blockchainTransactionStateReconciler(meta);
                     if (updateRequired) {
                         transactions[index] = reconciledTx;
@@ -521,10 +527,13 @@ class TransactionController extends base_controller_1.BaseController {
             this.update({ transactions: [] });
             return;
         }
-        const currentChainId = this.getChainId();
-        const newTransactions = this.state.transactions.filter(({ chainId, transaction }) => {
+        const { chainId: currentChainId, networkId: currentNetworkID } = this.getChainAndNetworkId();
+        const newTransactions = this.state.transactions.filter(({ networkID, chainId, transaction }) => {
             var _a;
-            const isMatchingNetwork = ignoreNetwork || chainId === currentChainId;
+            // 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);
             if (!isMatchingNetwork) {
                 return true;
             }
@@ -615,7 +624,7 @@ class TransactionController extends base_controller_1.BaseController {
                     throw cancelError;
                 case types_1.TransactionStatus.submitted:
                     resultCallbacks === null || resultCallbacks === void 0 ? void 0 : resultCallbacks.success();
-                    return finalMeta.transactionHash;
+                    return finalMeta.hash;
                 default:
                     const internalError = eth_rpc_errors_1.ethErrors.rpc.internal(`MetaMask Tx Signature: Unknown problem: ${JSON.stringify(finalMeta || transactionId)}`);
                     resultCallbacks === null || resultCallbacks === void 0 ? void 0 : resultCallbacks.error(internalError);
@@ -635,7 +644,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.getChainId();
+            const { chainId } = this.getChainAndNetworkId();
             const index = transactions.findIndex(({ id }) => transactionID === id);
             const transactionMeta = transactions[index];
             const { transaction: { nonce, from }, } = transactionMeta;
@@ -679,10 +688,8 @@ class TransactionController extends base_controller_1.BaseController {
                 const rawTx = (0, ethereumjs_util_1.bufferToHex)(signedTx.serialize());
                 transactionMeta.rawTx = rawTx;
                 this.updateTransaction(transactionMeta);
-                const transactionHash = yield (0, controller_utils_1.query)(this.ethQuery, 'sendRawTransaction', [
-                    rawTx,
-                ]);
-                transactionMeta.transactionHash = transactionHash;
+                const hash = yield (0, controller_utils_1.query)(this.ethQuery, 'sendRawTransaction', [rawTx]);
+                transactionMeta.hash = hash;
                 transactionMeta.status = types_1.TransactionStatus.submitted;
                 transactionMeta.submittedTime = new Date().getTime();
                 this.updateTransaction(transactionMeta);
@@ -732,10 +739,12 @@ class TransactionController extends base_controller_1.BaseController {
      */
     trimTransactionsForState(transactions) {
         const nonceNetworkSet = new Set();
-        const txsToKeep = transactions.reverse().filter((tx) => {
-            const { chainId, status, transaction, time } = tx;
+        const txsToKeep = transactions
+            .sort((a, b) => (a.time > b.time ? -1 : 1)) // Descending time order
+            .filter((tx) => {
+            const { chainId, networkID, status, transaction, time } = tx;
             if (transaction) {
-                const key = `${transaction.nonce}-${chainId}-${new Date(time).toDateString()}`;
+                const key = `${transaction.nonce}-${chainId ? (0, controller_utils_1.convertHexToDecimal)(chainId) : networkID}-${new Date(time).toDateString()}`;
                 if (nonceNetworkSet.has(key)) {
                     return true;
                 }
@@ -747,7 +756,7 @@ class TransactionController extends base_controller_1.BaseController {
             }
             return false;
         });
-        txsToKeep.reverse();
+        txsToKeep.reverse(); // Ascending time order
         return txsToKeep;
     }
     /**
@@ -785,11 +794,11 @@ class TransactionController extends base_controller_1.BaseController {
      */
     blockchainTransactionStateReconciler(meta) {
         return __awaiter(this, void 0, void 0, function* () {
-            const { status, transactionHash } = meta;
+            const { status, hash } = meta;
             switch (status) {
                 case types_1.TransactionStatus.confirmed:
                     const txReceipt = yield (0, controller_utils_1.query)(this.ethQuery, 'getTransactionReceipt', [
-                        transactionHash,
+                        hash,
                     ]);
                     if (!txReceipt) {
                         return [meta, false];
@@ -812,10 +821,10 @@ class TransactionController extends base_controller_1.BaseController {
                     return [meta, true];
                 case types_1.TransactionStatus.submitted:
                     const txObj = yield (0, controller_utils_1.query)(this.ethQuery, 'getTransactionByHash', [
-                        transactionHash,
+                        hash,
                     ]);
                     if (!txObj) {
-                        const receiptShowsFailedStatus = yield this.checkTxReceiptStatusIsFailed(transactionHash);
+                        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) {
@@ -886,9 +895,10 @@ class TransactionController extends base_controller_1.BaseController {
         const isCompleted = this.isLocalFinalState(transaction.status);
         return { meta: transaction, isCompleted };
     }
-    getChainId() {
-        const { providerConfig } = this.getNetworkState();
-        return providerConfig.chainId;
+    getChainAndNetworkId() {
+        const { networkId, providerConfig } = this.getNetworkState();
+        const chainId = providerConfig === null || providerConfig === void 0 ? void 0 : providerConfig.chainId;
+        return { networkId, chainId };
     }
     prepareUnsignedEthTx(txParams) {
         return tx_1.TransactionFactory.fromTxData(txParams, {
@@ -906,7 +916,7 @@ class TransactionController extends base_controller_1.BaseController {
      * @returns common configuration object
      */
     getCommonConfiguration() {
-        const { providerConfig: { type: chain, chainId, nickname: name }, } = this.getNetworkState();
+        const { networkId, 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']) {
@@ -915,6 +925,7 @@ 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);
@@ -924,7 +935,7 @@ class TransactionController extends base_controller_1.BaseController {
         const updatedTransactions = [
             ...added,
             ...currentTransactions.map((originalTransaction) => {
-                const updatedTransaction = updated.find(({ transactionHash }) => transactionHash === originalTransaction.transactionHash);
+                const updatedTransaction = updated.find(({ hash }) => hash === originalTransaction.hash);
                 return updatedTransaction !== null && updatedTransaction !== void 0 ? updatedTransaction : originalTransaction;
             }),
         ];
@@ -969,11 +980,11 @@ class TransactionController extends base_controller_1.BaseController {
     addExternalTransaction(transactionMeta) {
         var _a;
         return __awaiter(this, void 0, void 0, function* () {
-            const chainId = this.getChainId();
+            const { networkId, chainId } = this.getChainAndNetworkId();
             const { transactions } = this.state;
             const fromAddress = (_a = transactionMeta === null || transactionMeta === void 0 ? void 0 : transactionMeta.transaction) === null || _a === void 0 ? void 0 : _a.from;
             const sameFromAndNetworkTransactions = transactions.filter((transaction) => transaction.transaction.from === fromAddress &&
-                (0, utils_1.transactionMatchesChainId)(transaction, chainId));
+                (0, utils_1.transactionMatchesNetwork)(transaction, chainId, networkId));
             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);
@@ -991,13 +1002,13 @@ class TransactionController extends base_controller_1.BaseController {
      */
     markNonceDuplicatesDropped(transactionId) {
         var _a, _b;
-        const chainId = this.getChainId();
+        const { networkId, chainId } = this.getChainAndNetworkId();
         const transactionMeta = this.getTransaction(transactionId);
         const nonce = (_a = transactionMeta === null || transactionMeta === void 0 ? void 0 : transactionMeta.transaction) === null || _a === void 0 ? void 0 : _a.nonce;
         const from = (_b = transactionMeta === null || transactionMeta === void 0 ? void 0 : transactionMeta.transaction) === null || _b === void 0 ? void 0 : _b.from;
         const sameNonceTxs = this.state.transactions.filter((transaction) => transaction.transaction.from === from &&
             transaction.transaction.nonce === nonce &&
-            (0, utils_1.transactionMatchesChainId)(transaction, chainId));
+            (0, utils_1.transactionMatchesNetwork)(transaction, chainId, networkId));
         if (!sameNonceTxs.length) {
             return;
         }