import { createSelector } from 'reselect'; import { PRIORITY_STATUS_HASH, PENDING_STATUS_HASH, } from '../helpers/constants/transactions'; import { hexToDecimal } from '../helpers/utils/conversions.util'; import txHelper from '../../lib/tx-helper'; import { TRANSACTION_CATEGORIES, TRANSACTION_STATUSES, TRANSACTION_TYPES, } from '../../../shared/constants/transaction'; import { transactionMatchesNetwork } from '../../../shared/modules/transaction.utils'; import { getCurrentChainId, getCurrentNetworkId } from './selectors'; import { getSelectedAddress } from '.'; export const incomingTxListSelector = (state) => { const { showIncomingTransactions } = state.metamask.featureFlags; if (!showIncomingTransactions) { return []; } const { network, provider: { chainId }, } = state.metamask; const selectedAddress = getSelectedAddress(state); return Object.values(state.metamask.incomingTransactions).filter( (tx) => tx.txParams.to === selectedAddress && transactionMatchesNetwork(tx, chainId, network), ); }; export const unapprovedMsgsSelector = (state) => state.metamask.unapprovedMsgs; export const currentNetworkTxListSelector = (state) => state.metamask.currentNetworkTxList; export const unapprovedPersonalMsgsSelector = (state) => state.metamask.unapprovedPersonalMsgs; export const unapprovedDecryptMsgsSelector = (state) => state.metamask.unapprovedDecryptMsgs; export const unapprovedEncryptionPublicKeyMsgsSelector = (state) => state.metamask.unapprovedEncryptionPublicKeyMsgs; export const unapprovedTypedMessagesSelector = (state) => state.metamask.unapprovedTypedMessages; export const selectedAddressTxListSelector = createSelector( getSelectedAddress, currentNetworkTxListSelector, (selectedAddress, transactions = []) => { return transactions.filter( ({ txParams }) => txParams.from === selectedAddress, ); }, ); export const unapprovedMessagesSelector = createSelector( unapprovedMsgsSelector, unapprovedPersonalMsgsSelector, unapprovedDecryptMsgsSelector, unapprovedEncryptionPublicKeyMsgsSelector, unapprovedTypedMessagesSelector, getCurrentNetworkId, getCurrentChainId, ( unapprovedMsgs = {}, unapprovedPersonalMsgs = {}, unapprovedDecryptMsgs = {}, unapprovedEncryptionPublicKeyMsgs = {}, unapprovedTypedMessages = {}, network, chainId, ) => txHelper( {}, unapprovedMsgs, unapprovedPersonalMsgs, unapprovedDecryptMsgs, unapprovedEncryptionPublicKeyMsgs, unapprovedTypedMessages, network, chainId, ) || [], ); export const transactionSubSelector = createSelector( unapprovedMessagesSelector, incomingTxListSelector, (unapprovedMessages = [], incomingTxList = []) => { return unapprovedMessages.concat(incomingTxList); }, ); export const transactionsSelector = createSelector( transactionSubSelector, selectedAddressTxListSelector, (subSelectorTxList = [], selectedAddressTxList = []) => { const txsToRender = selectedAddressTxList.concat(subSelectorTxList); return txsToRender.sort((a, b) => b.time - a.time); }, ); /** * @name insertOrderedNonce * @private * @description Inserts (mutates) a nonce into an array of ordered nonces, sorted in ascending * order. * @param {string[]} nonces - Array of nonce strings in hex * @param {string} nonceToInsert - Nonce string in hex to be inserted into the array of nonces. * @returns {string[]} */ const insertOrderedNonce = (nonces, nonceToInsert) => { let insertIndex = nonces.length; for (let i = 0; i < nonces.length; i++) { const nonce = nonces[i]; if (Number(hexToDecimal(nonce)) > Number(hexToDecimal(nonceToInsert))) { insertIndex = i; break; } } nonces.splice(insertIndex, 0, nonceToInsert); }; /** * @name insertTransactionByTime * @private * @description Inserts (mutates) a transaction object into an array of ordered transactions, sorted * in ascending order by time. * @param {Object[]} transactions - Array of transaction objects. * @param {Object} transaction - Transaction object to be inserted into the array of transactions. * @returns {Object[]} */ const insertTransactionByTime = (transactions, transaction) => { const { time } = transaction; let insertIndex = transactions.length; for (let i = 0; i < transactions.length; i++) { const tx = transactions[i]; if (tx.time > time) { insertIndex = i; break; } } transactions.splice(insertIndex, 0, transaction); }; /** * Contains transactions and properties associated with those transactions of the same nonce. * @typedef {Object} transactionGroup * @property {string} nonce - The nonce that the transactions within this transactionGroup share. * @property {Object[]} transactions - An array of transaction (txMeta) objects. * @property {Object} initialTransaction - The transaction (txMeta) with the lowest "time". * @property {Object} primaryTransaction - Either the latest transaction or the confirmed * transaction. * @property {boolean} hasRetried - True if a transaction in the group was a retry transaction. * @property {boolean} hasCancelled - True if a transaction in the group was a cancel transaction. */ /** * @name insertTransactionGroupByTime * @private * @description Inserts (mutates) a transactionGroup object into an array of ordered * transactionGroups, sorted in ascending order by nonce. * @param {transactionGroup[]} transactionGroups - Array of transactionGroup objects. * @param {transactionGroup} transactionGroup - transactionGroup object to be inserted into the * array of transactionGroups. */ const insertTransactionGroupByTime = (transactionGroups, transactionGroup) => { const { primaryTransaction: { time: groupToInsertTime } = {}, } = transactionGroup; let insertIndex = transactionGroups.length; for (let i = 0; i < transactionGroups.length; i++) { const txGroup = transactionGroups[i]; const { primaryTransaction: { time } = {} } = txGroup; if (time > groupToInsertTime) { insertIndex = i; break; } } transactionGroups.splice(insertIndex, 0, transactionGroup); }; /** * @name mergeNonNonceTransactionGroups * @private * @description Inserts (mutates) transactionGroups that are not to be ordered by nonce into an array * of nonce-ordered transactionGroups by time. * @param {transactionGroup[]} orderedTransactionGroups - Array of transactionGroups ordered by * nonce. * @param {transactionGroup[]} nonNonceTransactionGroups - Array of transactionGroups not intended to be ordered by nonce, * but intended to be ordered by timestamp */ const mergeNonNonceTransactionGroups = ( orderedTransactionGroups, nonNonceTransactionGroups, ) => { nonNonceTransactionGroups.forEach((transactionGroup) => { insertTransactionGroupByTime(orderedTransactionGroups, transactionGroup); }); }; /** * @name nonceSortedTransactionsSelector * @description Returns an array of transactionGroups sorted by nonce in ascending order. * @returns {transactionGroup[]} */ export const nonceSortedTransactionsSelector = createSelector( transactionsSelector, (transactions = []) => { const unapprovedTransactionGroups = []; const incomingTransactionGroups = []; const orderedNonces = []; const nonceToTransactionsMap = {}; transactions.forEach((transaction) => { const { txParams: { nonce } = {}, status, type, time: txTime, transactionCategory, } = transaction; if ( typeof nonce === 'undefined' || transactionCategory === TRANSACTION_CATEGORIES.INCOMING ) { const transactionGroup = { transactions: [transaction], initialTransaction: transaction, primaryTransaction: transaction, hasRetried: false, hasCancelled: false, }; if (transactionCategory === TRANSACTION_CATEGORIES.INCOMING) { incomingTransactionGroups.push(transactionGroup); } else { insertTransactionGroupByTime( unapprovedTransactionGroups, transactionGroup, ); } } else if (nonce in nonceToTransactionsMap) { const nonceProps = nonceToTransactionsMap[nonce]; insertTransactionByTime(nonceProps.transactions, transaction); const { primaryTransaction: { time: primaryTxTime = 0 } = {}, } = nonceProps; const previousPrimaryIsNetworkFailure = nonceProps.primaryTransaction.status === TRANSACTION_STATUSES.FAILED && nonceProps.primaryTransaction?.txReceipt?.status !== '0x0'; const currentTransactionIsOnChainFailure = transaction?.txReceipt?.status === '0x0'; if ( status === TRANSACTION_STATUSES.CONFIRMED || currentTransactionIsOnChainFailure || previousPrimaryIsNetworkFailure || (txTime > primaryTxTime && status in PRIORITY_STATUS_HASH) ) { nonceProps.primaryTransaction = transaction; } const { initialTransaction: { time: initialTxTime = 0 } = {}, } = nonceProps; // Used to display the transaction action, since we don't want to overwrite the action if // it was replaced with a cancel attempt transaction. if (txTime < initialTxTime) { nonceProps.initialTransaction = transaction; } if (type === TRANSACTION_TYPES.RETRY) { nonceProps.hasRetried = true; } if (type === TRANSACTION_TYPES.CANCEL) { nonceProps.hasCancelled = true; } } else { nonceToTransactionsMap[nonce] = { nonce, transactions: [transaction], initialTransaction: transaction, primaryTransaction: transaction, hasRetried: transaction.type === TRANSACTION_TYPES.RETRY, hasCancelled: transaction.type === TRANSACTION_TYPES.CANCEL, }; insertOrderedNonce(orderedNonces, nonce); } }); const orderedTransactionGroups = orderedNonces.map( (nonce) => nonceToTransactionsMap[nonce], ); mergeNonNonceTransactionGroups( orderedTransactionGroups, incomingTransactionGroups, ); return unapprovedTransactionGroups.concat(orderedTransactionGroups); }, ); /** * @name nonceSortedPendingTransactionsSelector * @description Returns an array of transactionGroups where transactions are still pending sorted by * nonce in descending order. * @returns {transactionGroup[]} */ export const nonceSortedPendingTransactionsSelector = createSelector( nonceSortedTransactionsSelector, (transactions = []) => transactions.filter( ({ primaryTransaction }) => primaryTransaction.status in PENDING_STATUS_HASH, ), ); /** * @name nonceSortedCompletedTransactionsSelector * @description Returns an array of transactionGroups where transactions are confirmed sorted by * nonce in descending order. * @returns {transactionGroup[]} */ export const nonceSortedCompletedTransactionsSelector = createSelector( nonceSortedTransactionsSelector, (transactions = []) => transactions .filter( ({ primaryTransaction }) => !(primaryTransaction.status in PENDING_STATUS_HASH), ) .reverse(), ); export const submittedPendingTransactionsSelector = createSelector( transactionsSelector, (transactions = []) => transactions.filter( (transaction) => transaction.status === TRANSACTION_STATUSES.SUBMITTED, ), );