1
0
mirror of https://github.com/kremalicious/metamask-extension.git synced 2024-12-05 15:35:46 +01:00
metamask-extension/ui/selectors/transactions.js

531 lines
20 KiB
JavaScript
Raw Normal View History

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 '../helpers/utils/tx-helper';
import {
TRANSACTION_STATUSES,
TRANSACTION_TYPES,
SMART_TRANSACTION_STATUSES,
} from '../../shared/constants/transaction';
import { transactionMatchesNetwork } from '../../shared/modules/transaction.utils';
import {
getCurrentChainId,
deprecatedGetCurrentNetworkId,
getSelectedAddress,
} from './selectors';
const INVALID_INITIAL_TRANSACTION_TYPES = [
TRANSACTION_TYPES.CANCEL,
TRANSACTION_TYPES.RETRY,
];
2020-02-15 21:34:12 +01:00
export const incomingTxListSelector = (state) => {
const { showIncomingTransactions } = state.metamask.featureFlags;
if (!showIncomingTransactions) {
return [];
}
const {
network,
provider: { chainId },
} = state.metamask;
const selectedAddress = getSelectedAddress(state);
2020-11-03 00:41:28 +01:00
return Object.values(state.metamask.incomingTransactions).filter(
(tx) =>
tx.txParams.to === selectedAddress &&
transactionMatchesNetwork(tx, chainId, network),
);
};
export const unapprovedMsgsSelector = (state) => state.metamask.unapprovedMsgs;
2020-11-03 00:41:28 +01:00
export const currentNetworkTxListSelector = (state) =>
state.metamask.currentNetworkTxList;
2020-11-03 00:41:28 +01:00
export const unapprovedPersonalMsgsSelector = (state) =>
state.metamask.unapprovedPersonalMsgs;
2020-11-03 00:41:28 +01:00
export const unapprovedDecryptMsgsSelector = (state) =>
state.metamask.unapprovedDecryptMsgs;
2020-11-03 00:41:28 +01:00
export const unapprovedEncryptionPublicKeyMsgsSelector = (state) =>
state.metamask.unapprovedEncryptionPublicKeyMsgs;
2020-11-03 00:41:28 +01:00
export const unapprovedTypedMessagesSelector = (state) =>
state.metamask.unapprovedTypedMessages;
2018-12-09 21:48:06 +01:00
export const smartTransactionsListSelector = (state) =>
state.metamask.smartTransactionsState?.smartTransactions?.[
getCurrentChainId(state)
]
?.filter((stx) => !stx.confirmed)
.map((stx) => ({
...stx,
transactionType: TRANSACTION_TYPES.SMART,
status: stx.status?.startsWith('cancelled')
? SMART_TRANSACTION_STATUSES.CANCELLED
: stx.status,
}));
export const selectedAddressTxListSelector = createSelector(
getSelectedAddress,
currentNetworkTxListSelector,
smartTransactionsListSelector,
(selectedAddress, transactions = [], smTransactions = []) => {
return transactions
.filter(({ txParams }) => txParams.from === selectedAddress)
.concat(smTransactions);
},
);
2018-12-09 21:48:06 +01:00
export const unapprovedMessagesSelector = createSelector(
unapprovedMsgsSelector,
unapprovedPersonalMsgsSelector,
unapprovedDecryptMsgsSelector,
unapprovedEncryptionPublicKeyMsgsSelector,
2018-12-09 21:48:06 +01:00
unapprovedTypedMessagesSelector,
deprecatedGetCurrentNetworkId,
getCurrentChainId,
2018-12-09 21:48:06 +01:00
(
unapprovedMsgs = {},
unapprovedPersonalMsgs = {},
unapprovedDecryptMsgs = {},
unapprovedEncryptionPublicKeyMsgs = {},
2018-12-09 21:48:06 +01:00
unapprovedTypedMessages = {},
network,
chainId,
2020-11-03 00:41:28 +01:00
) =>
txHelper(
{},
unapprovedMsgs,
unapprovedPersonalMsgs,
unapprovedDecryptMsgs,
unapprovedEncryptionPublicKeyMsgs,
unapprovedTypedMessages,
network,
chainId,
2020-11-03 00:41:28 +01:00
) || [],
);
export const transactionSubSelector = createSelector(
2018-12-09 21:48:06 +01:00
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);
},
);
2018-12-09 21:48:06 +01:00
/**
* @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.
*/
const insertOrderedNonce = (nonces, nonceToInsert) => {
let insertIndex = nonces.length;
2018-12-09 21:48:06 +01:00
for (let i = 0; i < nonces.length; i++) {
const nonce = nonces[i];
2018-12-09 21:48:06 +01:00
if (Number(hexToDecimal(nonce)) > Number(hexToDecimal(nonceToInsert))) {
insertIndex = i;
break;
2018-12-09 21:48:06 +01:00
}
}
nonces.splice(insertIndex, 0, nonceToInsert);
};
2018-12-09 21:48:06 +01:00
/**
* @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.
*/
const insertTransactionByTime = (transactions, transaction) => {
const { time } = transaction;
2018-12-09 21:48:06 +01:00
let insertIndex = transactions.length;
2018-12-09 21:48:06 +01:00
for (let i = 0; i < transactions.length; i++) {
const tx = transactions[i];
2018-12-09 21:48:06 +01:00
if (tx.time > time) {
insertIndex = i;
break;
2018-12-09 21:48:06 +01:00
}
}
transactions.splice(insertIndex, 0, transaction);
};
2018-12-09 21:48:06 +01:00
/**
* Contains transactions and properties associated with those transactions of the same nonce.
*
2018-12-09 21:48:06 +01:00
* @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) => {
2020-11-03 00:41:28 +01:00
const {
primaryTransaction: { time: groupToInsertTime } = {},
} = transactionGroup;
2018-12-09 21:48:06 +01:00
let insertIndex = transactionGroups.length;
2018-12-09 21:48:06 +01:00
for (let i = 0; i < transactionGroups.length; i++) {
const txGroup = transactionGroups[i];
const { primaryTransaction: { time } = {} } = txGroup;
2018-12-09 21:48:06 +01:00
if (time > groupToInsertTime) {
insertIndex = i;
break;
2018-12-09 21:48:06 +01:00
}
}
transactionGroups.splice(insertIndex, 0, transactionGroup);
};
2018-12-09 21:48:06 +01:00
/**
* @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
*/
2020-11-03 00:41:28 +01:00
const mergeNonNonceTransactionGroups = (
orderedTransactionGroups,
nonNonceTransactionGroups,
) => {
nonNonceTransactionGroups.forEach((transactionGroup) => {
insertTransactionGroupByTime(orderedTransactionGroups, transactionGroup);
});
};
2018-12-09 21:48:06 +01:00
/**
* @name nonceSortedTransactionsSelector
* @description Returns an array of transactionGroups sorted by nonce in ascending order.
* @returns {transactionGroup[]}
*/
export const nonceSortedTransactionsSelector = createSelector(
transactionsSelector,
2018-12-09 21:48:06 +01:00
(transactions = []) => {
const unapprovedTransactionGroups = [];
const incomingTransactionGroups = [];
const orderedNonces = [];
const nonceToTransactionsMap = {};
2018-12-09 21:48:06 +01:00
2020-02-15 21:34:12 +01:00
transactions.forEach((transaction) => {
2020-11-03 00:41:28 +01:00
const {
txParams: { nonce } = {},
status,
type,
time: txTime,
txReceipt,
} = transaction;
2018-12-09 21:48:06 +01:00
if (typeof nonce === 'undefined' || type === TRANSACTION_TYPES.INCOMING) {
2018-12-09 21:48:06 +01:00
const transactionGroup = {
transactions: [transaction],
initialTransaction: transaction,
primaryTransaction: transaction,
hasRetried: false,
hasCancelled: false,
nonce,
};
2018-12-09 21:48:06 +01:00
if (type === TRANSACTION_TYPES.INCOMING) {
incomingTransactionGroups.push(transactionGroup);
} else {
2020-11-03 00:41:28 +01:00
insertTransactionGroupByTime(
unapprovedTransactionGroups,
transactionGroup,
);
}
2018-12-09 21:48:06 +01:00
} else if (nonce in nonceToTransactionsMap) {
const nonceProps = nonceToTransactionsMap[nonce];
insertTransactionByTime(nonceProps.transactions, transaction);
2018-12-09 21:48:06 +01:00
2020-11-03 00:41:28 +01:00
const {
primaryTransaction: { time: primaryTxTime = 0 } = {},
initialTransaction: { time: initialTxTime = 0 } = {},
} = nonceProps;
2020-11-03 00:41:28 +01:00
// Current Transaction Logic Cases
// --------------------------------------------------------------------
// Current transaction: The transaction we are examining in this loop.
// Each iteration should be in time order, but that is not guaranteed.
// --------------------------------------------------------------------
const currentTransaction = {
// A on chain failure means the current transaction was submitted and
// considered for inclusion in a block but something prevented it
// from being included, such as slippage on gas prices and conversion
// when doing a swap. These transactions will have a '0x0' value in
// the txReceipt.status field.
isOnChainFailure: txReceipt?.status === '0x0',
// Another type of failure is a "off chain" or "network" failure,
// where the error occurs on the JSON RPC call to the network client
// (Like Infura). These transactions are never broadcast for
// inclusion and the nonce associated with them is not consumed. When
// this occurs the next transaction will have the same nonce as the
// current, failed transaction. A failed on chain transaction will
// not have the FAILED status although it should (future TODO: add a
// new FAILED_ON_CHAIN) status. I use the word "Ephemeral" here
// because a failed transaction that does not get broadcast is not
// known outside of the user's local MetaMask and the nonce
// associated will be applied to the next.
isEphemeral:
status === TRANSACTION_STATUSES.FAILED &&
txReceipt?.status !== '0x0',
// We never want to use a speed up (retry) or cancel as the initial
// transaction in a group, regardless of time order. This is because
// useTransactionDisplayData cannot parse a retry or cancel because
// it lacks information on whether its a simple send, token transfer,
// etc.
isRetryOrCancel: INVALID_INITIAL_TRANSACTION_TYPES.includes(type),
// Primary transactions usually are the latest transaction by time,
// but not always. This value shows whether this transaction occurred
// after the current primary.
occurredAfterPrimary: txTime > primaryTxTime,
// Priority Statuses are those that are ones either already confirmed
// on chain, submitted to the network, or waiting for user approval.
// These statuses typically indicate a transaction that needs to have
// its status reflected in the UI.
hasPriorityStatus: status in PRIORITY_STATUS_HASH,
// A confirmed transaction is the most valid transaction status to
// display because no other transaction of the same nonce can have a
// more valid status.
isConfirmed: status === TRANSACTION_STATUSES.CONFIRMED,
// Initial transactions usually are the earliest transaction by time,
// but not always. THis value shows whether this transaction occurred
// before the current initial.
occurredBeforeInitial: txTime < initialTxTime,
// We only allow users to retry the transaction in certain scenarios
// to help shield from expensive operations and other unwanted side
// effects. This value is used to determine if the entire transaction
// group should be marked as having had a retry.
isValidRetry:
type === TRANSACTION_TYPES.RETRY &&
(status in PRIORITY_STATUS_HASH ||
status === TRANSACTION_STATUSES.DROPPED),
// We only allow users to cancel the transaction in certain scenarios
// to help shield from expensive operations and other unwanted side
// effects. This value is used to determine if the entire transaction
// group should be marked as having had a cancel.
isValidCancel:
type === TRANSACTION_TYPES.CANCEL &&
(status in PRIORITY_STATUS_HASH ||
status === TRANSACTION_STATUSES.DROPPED),
};
// We should never assign a retry or cancel transaction as the initial,
// likewise an ephemeral transaction should not be initial.
currentTransaction.eligibleForInitial =
!currentTransaction.isRetryOrCancel &&
!currentTransaction.isEphemeral;
// If a transaction failed on chain or was confirmed then it should
// always be the primary because no other transaction is more valid.
currentTransaction.shouldBePrimary =
currentTransaction.isConfirmed || currentTransaction.isOnChainFailure;
// Primary Transaction Logic Cases
// --------------------------------------------------------------------
// Primary transaction: The transaction for any given nonce which has
// the most valid status on the network.
// Example:
// 1. Submit transaction A
// 2. Speed up Transaction A.
// 3. This creates a new Transaction (B) with higher gas params.
// 4. Transaction A and Transaction B are both submitted.
// 5. We expect Transaction B to be the most valid transaction to use
// for the status of the transaction group because it has higher
// gas params and should be included first.
// The following logic variables are used for edge cases that protect
// against UI bugs when this breaks down.
const previousPrimaryTransaction = {
// As we loop through the transactions in state we may temporarily
// assign a primaryTransaction that is an "Ephemeral" transaction,
// which is one that failed before being broadcast for inclusion in a
// block. When this happens, and we have another transaction to
// consider in a nonce group, we should use the new transaction.
isEphemeral:
nonceProps.primaryTransaction.status ===
TRANSACTION_STATUSES.FAILED &&
nonceProps.primaryTransaction?.txReceipt?.status !== '0x0',
};
2020-11-03 00:41:28 +01:00
// Initial Transaction Logic Cases
// --------------------------------------------------------------------
// Initial Transaction: The transaciton that most likely represents the
// user's intent when creating/approving the transaction. In most cases
// this is the first transaction of a nonce group, by time, but this
// breaks down in the case of users with the advanced setting enabled
// to set their own nonces manually. In that case a user may submit two
// completely different transactions of the same nonce and they will be
// bundled together by this selector as the same activity entry.
const previousInitialTransaction = {
// As we loop through the transactions in state we may temporarily
// assign a initialTransaction that is an "Ephemeral" transaction,
// which is one that failed before being broadcast for inclusion in a
// block. When this happens, and we have another transaction to
// consider in a nonce group, we should use the new transaction.
isEphemeral:
nonceProps.initialTransaction.status ===
TRANSACTION_STATUSES.FAILED &&
nonceProps.initialTransaction.txReceipt?.status !== '0x0',
};
// Check the above logic cases and assign a new primaryTransaction if
// appropriate
2020-11-03 00:41:28 +01:00
if (
currentTransaction.shouldBePrimary ||
previousPrimaryTransaction.isEphemeral ||
(currentTransaction.occurredAfterPrimary &&
currentTransaction.hasPriorityStatus)
2020-11-03 00:41:28 +01:00
) {
nonceProps.primaryTransaction = transaction;
2018-12-09 21:48:06 +01:00
}
// Check the above logic cases and assign a new initialTransaction if
// appropriate
if (
(currentTransaction.occurredBeforeInitial &&
currentTransaction.eligibleForInitial) ||
(previousInitialTransaction.isEphemeral &&
currentTransaction.eligibleForInitial)
) {
nonceProps.initialTransaction = transaction;
2018-12-09 21:48:06 +01:00
}
if (currentTransaction.isValidRetry) {
nonceProps.hasRetried = true;
2018-12-09 21:48:06 +01:00
}
if (currentTransaction.isValidCancel) {
nonceProps.hasCancelled = true;
2018-12-09 21:48:06 +01:00
}
} else {
nonceToTransactionsMap[nonce] = {
nonce,
transactions: [transaction],
initialTransaction: transaction,
primaryTransaction: transaction,
2021-09-15 23:42:06 +02:00
hasRetried:
transaction.type === TRANSACTION_TYPES.RETRY &&
(transaction.status in PRIORITY_STATUS_HASH ||
transaction.status === TRANSACTION_STATUSES.DROPPED),
2021-09-15 23:42:06 +02:00
hasCancelled:
transaction.type === TRANSACTION_TYPES.CANCEL &&
(transaction.status in PRIORITY_STATUS_HASH ||
transaction.status === TRANSACTION_STATUSES.DROPPED),
};
2018-12-09 21:48:06 +01:00
insertOrderedNonce(orderedNonces, nonce);
2018-12-09 21:48:06 +01:00
}
});
2018-12-09 21:48:06 +01:00
2020-11-03 00:41:28 +01:00
const orderedTransactionGroups = orderedNonces.map(
(nonce) => nonceToTransactionsMap[nonce],
);
2020-11-03 00:41:28 +01:00
mergeNonNonceTransactionGroups(
orderedTransactionGroups,
incomingTransactionGroups,
);
return unapprovedTransactionGroups
.concat(orderedTransactionGroups)
.map((txGroup) => {
// In the case that we have a cancel or retry as initial transaction
// and there is a valid transaction in the group, we should reassign
// the other valid transaction as initial. In this case validity of the
// transaction is expanded to include off-chain failures because it is
// valid to retry those with higher gas prices.
if (
INVALID_INITIAL_TRANSACTION_TYPES.includes(
txGroup.initialTransaction?.type,
)
) {
const nonRetryOrCancel = txGroup.transactions.find(
(tx) => !INVALID_INITIAL_TRANSACTION_TYPES.includes(tx.type),
);
if (nonRetryOrCancel) {
return {
...txGroup,
initialTransaction: nonRetryOrCancel,
};
}
}
return txGroup;
});
},
);
2018-12-09 21:48:06 +01:00
/**
* @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,
2020-11-03 00:41:28 +01:00
(transactions = []) =>
transactions.filter(
({ primaryTransaction }) =>
primaryTransaction.status in PENDING_STATUS_HASH,
),
);
2018-12-09 21:48:06 +01:00
/**
* @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,
2020-11-03 00:41:28 +01:00
(transactions = []) =>
transactions
2020-11-03 00:41:28 +01:00
.filter(
({ primaryTransaction }) =>
!(primaryTransaction.status in PENDING_STATUS_HASH),
)
.reverse(),
);
2018-08-07 07:39:54 +02:00
2018-12-09 21:48:06 +01:00
export const submittedPendingTransactionsSelector = createSelector(
transactionsSelector,
2020-11-03 00:41:28 +01:00
(transactions = []) =>
transactions.filter(
(transaction) => transaction.status === TRANSACTION_STATUSES.SUBMITTED,
2020-11-03 00:41:28 +01:00
),
);