1
0
mirror of https://github.com/kremalicious/metamask-extension.git synced 2024-12-05 15:35:46 +01:00
metamask-extension/ui/helpers/utils/transactions.util.js
Filip Sekulic 6e13524bcd
Remove related UI code from the app dir (#15384)
Co-authored-by: metamaskbot <metamaskbot@users.noreply.github.com>
Co-authored-by: Brad Decker <bhdecker84@gmail.com>
Co-authored-by: Akintayo A. Olusegun <akintayo.segun@gmail.com>
2022-09-16 14:05:21 -05:00

231 lines
6.6 KiB
JavaScript

import { MethodRegistry } from 'eth-method-registry';
import log from 'loglevel';
import { addHexPrefix } from '../../../app/scripts/lib/util';
import {
TRANSACTION_TYPES,
TRANSACTION_GROUP_STATUSES,
TRANSACTION_STATUSES,
TRANSACTION_ENVELOPE_TYPES,
} from '../../../shared/constants/transaction';
import { addCurrencies } from '../../../shared/modules/conversion.utils';
import { readAddressAsContract } from '../../../shared/modules/contract-utils';
import fetchWithCache from '../../../shared/lib/fetch-with-cache';
/**
* @typedef EthersContractCall
* @type object
* @property {any[]} args - The args/params to the function call.
* An array-like object with numerical and string indices.
* @property {string} name - The name of the function.
* @property {string} signature - The function signature.
* @property {string} sighash - The function signature hash.
* @property {EthersBigNumber} value - The ETH value associated with the call.
* @property {FunctionFragment} functionFragment - The Ethers function fragment
* representation of the function.
*/
async function getMethodFrom4Byte(fourBytePrefix) {
const fourByteResponse = await fetchWithCache(
`https://www.4byte.directory/api/v1/signatures/?hex_signature=${fourBytePrefix}`,
{
referrerPolicy: 'no-referrer-when-downgrade',
body: null,
method: 'GET',
mode: 'cors',
},
);
fourByteResponse.results.sort((a, b) => {
return new Date(a.created_at).getTime() < new Date(b.created_at).getTime()
? -1
: 1;
});
return fourByteResponse.results[0].text_signature;
}
let registry;
/**
* Attempts to return the method data from the MethodRegistry library, the message registry library and the token abi, in that order of preference
*
* @param {string} fourBytePrefix - The prefix from the method code associated with the data
* @returns {object}
*/
export async function getMethodDataAsync(fourBytePrefix) {
try {
const fourByteSig = await getMethodFrom4Byte(fourBytePrefix).catch((e) => {
log.error(e);
return null;
});
if (!registry) {
registry = new MethodRegistry({ provider: global.ethereumProvider });
}
if (!fourByteSig) {
return {};
}
const parsedResult = registry.parse(fourByteSig);
return {
name: parsedResult.name,
params: parsedResult.args,
};
} catch (error) {
log.error(error);
return {};
}
}
/**
* Returns four-byte method signature from data
*
* @param {string} data - The hex data (@code txParams.data) of a transaction
* @returns {string} The four-byte method signature
*/
export function getFourBytePrefix(data = '') {
const prefixedData = addHexPrefix(data);
const fourBytePrefix = prefixedData.slice(0, 10);
return fourBytePrefix;
}
/**
* Given an transaction category, returns a boolean which indicates whether the transaction is calling an erc20 token method
*
* @param {TRANSACTION_TYPES[keyof TRANSACTION_TYPES]} type - The type of transaction being evaluated
* @returns {boolean} whether the transaction is calling an erc20 token method
*/
export function isTokenMethodAction(type) {
return [
TRANSACTION_TYPES.TOKEN_METHOD_TRANSFER,
TRANSACTION_TYPES.TOKEN_METHOD_APPROVE,
TRANSACTION_TYPES.TOKEN_METHOD_SET_APPROVAL_FOR_ALL,
TRANSACTION_TYPES.TOKEN_METHOD_TRANSFER_FROM,
TRANSACTION_TYPES.TOKEN_METHOD_SAFE_TRANSFER_FROM,
].includes(type);
}
export function getLatestSubmittedTxWithNonce(
transactions = [],
nonce = '0x0',
) {
if (!transactions.length) {
return {};
}
return transactions.reduce((acc, current) => {
const { submittedTime, txParams: { nonce: currentNonce } = {} } = current;
if (currentNonce === nonce) {
if (!acc.submittedTime) {
return current;
}
return submittedTime > acc.submittedTime ? current : acc;
}
return acc;
}, {});
}
export async function isSmartContractAddress(address) {
const { isContractAddress } = await readAddressAsContract(
global.eth,
address,
);
return isContractAddress;
}
export function sumHexes(...args) {
const total = args.reduce((acc, hexAmount) => {
return addCurrencies(acc, hexAmount, {
toNumericBase: 'hex',
aBase: 16,
bBase: 16,
});
});
return addHexPrefix(total);
}
export function isLegacyTransaction(txParams) {
return txParams?.type === TRANSACTION_ENVELOPE_TYPES.LEGACY;
}
/**
* Returns a status key for a transaction. Requires parsing the txMeta.txReceipt on top of
* txMeta.status because txMeta.status does not reflect on-chain errors.
*
* @param {object} transaction - The txMeta object of a transaction.
* @param {object} transaction.txReceipt - The transaction receipt.
* @returns {string}
*/
export function getStatusKey(transaction) {
const {
txReceipt: { status: receiptStatus } = {},
type,
status,
} = transaction;
// There was an on-chain failure
if (receiptStatus === '0x0') {
return TRANSACTION_STATUSES.FAILED;
}
if (
status === TRANSACTION_STATUSES.CONFIRMED &&
type === TRANSACTION_TYPES.CANCEL
) {
return TRANSACTION_GROUP_STATUSES.CANCELLED;
}
return transaction.status;
}
/**
* Returns a title for the given transaction category.
*
* This will throw an error if the transaction category is unrecognized and no default is provided.
*
* @param {Function} t - The translation function
* @param {TRANSACTION_TYPES[keyof TRANSACTION_TYPES]} type - The transaction type constant
* @param {string} nativeCurrency - The native currency of the currently selected network
* @returns {string} The transaction category title
*/
export function getTransactionTypeTitle(t, type, nativeCurrency = 'ETH') {
switch (type) {
case TRANSACTION_TYPES.TOKEN_METHOD_TRANSFER: {
return t('transfer');
}
case TRANSACTION_TYPES.TOKEN_METHOD_TRANSFER_FROM: {
return t('transferFrom');
}
case TRANSACTION_TYPES.TOKEN_METHOD_SAFE_TRANSFER_FROM: {
return t('safeTransferFrom');
}
case TRANSACTION_TYPES.TOKEN_METHOD_APPROVE: {
return t('approve');
}
case TRANSACTION_TYPES.TOKEN_METHOD_SET_APPROVAL_FOR_ALL: {
return t('setApprovalForAll');
}
case TRANSACTION_TYPES.SIMPLE_SEND: {
return t('sendingNativeAsset', [nativeCurrency]);
}
case TRANSACTION_TYPES.CONTRACT_INTERACTION: {
return t('contractInteraction');
}
case TRANSACTION_TYPES.DEPLOY_CONTRACT: {
return t('contractDeployment');
}
case TRANSACTION_TYPES.SWAP: {
return t('swap');
}
case TRANSACTION_TYPES.SWAP_APPROVAL: {
return t('swapApproval');
}
default: {
throw new Error(`Unrecognized transaction type: ${type}`);
}
}
}