1
0
mirror of https://github.com/kremalicious/metamask-extension.git synced 2024-12-23 09:52:26 +01:00

Convert confirm-tx.utils.js to typescript (#17349)

This commit is contained in:
Brad Decker 2023-02-02 12:35:05 -06:00 committed by GitHub
parent b123458a26
commit aededb1c71
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 71 additions and 19 deletions

View File

@ -392,6 +392,7 @@
"@tsconfig/node16": "^1.0.3", "@tsconfig/node16": "^1.0.3",
"@types/babelify": "^7.3.7", "@types/babelify": "^7.3.7",
"@types/browserify": "^12.0.37", "@types/browserify": "^12.0.37",
"@types/currency-formatter": "^1.5.1",
"@types/end-of-stream": "^1.4.1", "@types/end-of-stream": "^1.4.1",
"@types/fs-extra": "^9.0.13", "@types/fs-extra": "^9.0.13",
"@types/gulp": "^4.0.9", "@types/gulp": "^4.0.9",

View File

@ -289,6 +289,21 @@ export interface TxError {
stack?: string; stack?: string;
} }
/**
* We attach an object to transactions proposed by dapps to show the values
* that the dapp suggested for gas fees. This is used to compare to what our
* internal gas price logic would have the transaction priced at for metrics
* with the aim of improving our suggestions as well as giving the user the
* option to return to the defaults suggested by the dapp if they have edited
* the gas fees on the confirmation screen.
*/
interface DappSuggestedGasFees {
gasPrice?: string;
maxFeePerGas?: string;
maxPriorityFeePerGas?: string;
gas?: string;
}
/** /**
* An object representing a transaction, in whatever state it is in. * An object representing a transaction, in whatever state it is in.
*/ */
@ -308,6 +323,8 @@ export interface TransactionMeta {
customTokenAmount: string; customTokenAmount: string;
/** The dapp proposed token amount */ /** The dapp proposed token amount */
dappProposedTokenAmount: string; dappProposedTokenAmount: string;
/** The original gas fees suggested by the dapp that proposed this transaction */
dappSuggestedGasFees?: DappSuggestedGasFees;
/** The balance of the token that is being sent */ /** The balance of the token that is being sent */
currentTokenBalance: string; currentTokenBalance: string;
/** The original dapp proposed token approval amount before edit by user */ /** The original dapp proposed token approval amount before edit by user */

View File

@ -1,18 +1,19 @@
import currencyFormatter from 'currency-formatter'; import currencyFormatter from 'currency-formatter';
import currencies from 'currency-formatter/currencies'; import currencies from 'currency-formatter/currencies';
import BigNumber from 'bignumber.js'; import { BigNumber } from 'bignumber.js';
import { unconfirmedTransactionsCountSelector } from '../../selectors'; import { unconfirmedTransactionsCountSelector } from '../../selectors';
import { Numeric } from '../../../shared/modules/Numeric'; import { Numeric } from '../../../shared/modules/Numeric';
import { EtherDenomination } from '../../../shared/constants/common'; import { EtherDenomination } from '../../../shared/constants/common';
import { TransactionMeta } from '../../../shared/constants/transaction';
export function getHexGasTotal({ gasLimit = '0x0', gasPrice = '0x0' }) { export function getHexGasTotal({ gasLimit = '0x0', gasPrice = '0x0' }): string {
return new Numeric(gasLimit, 16) return new Numeric(gasLimit, 16)
.times(new Numeric(gasPrice, 16)) .times(new Numeric(gasPrice, 16))
.toPrefixedHexString(); .toPrefixedHexString();
} }
export function addEth(firstValue, ...otherValues) { export function addEth(firstValue: string, ...otherValues: string[]): string {
return otherValues return otherValues
.reduce((numericAcc, ethAmount) => { .reduce((numericAcc, ethAmount) => {
return numericAcc.add(new Numeric(ethAmount, 10)).round(6); return numericAcc.add(new Numeric(ethAmount, 10)).round(6);
@ -20,7 +21,7 @@ export function addEth(firstValue, ...otherValues) {
.toString(); .toString();
} }
export function addFiat(firstValue, ...otherValues) { export function addFiat(firstValue: string, ...otherValues: string[]): string {
return otherValues return otherValues
.reduce((numericAcc, fiatAmount) => { .reduce((numericAcc, fiatAmount) => {
return numericAcc.add(new Numeric(fiatAmount, 10)).round(2); return numericAcc.add(new Numeric(fiatAmount, 10)).round(2);
@ -30,11 +31,17 @@ export function addFiat(firstValue, ...otherValues) {
export function getTransactionFee({ export function getTransactionFee({
value, value,
fromCurrency = 'ETH', fromCurrency = EtherDenomination.ETH,
toCurrency, toCurrency,
conversionRate, conversionRate,
numberOfDecimals, numberOfDecimals,
}) { }: {
value: string;
fromCurrency: EtherDenomination;
toCurrency: string;
conversionRate: number;
numberOfDecimals: number;
}): string {
let fee = new Numeric(value, 16, EtherDenomination.WEI) let fee = new Numeric(value, 16, EtherDenomination.WEI)
.toDenomination(EtherDenomination.ETH) .toDenomination(EtherDenomination.ETH)
.toBase(10); .toBase(10);
@ -45,24 +52,29 @@ export function getTransactionFee({
return fee.round(numberOfDecimals).toString(); return fee.round(numberOfDecimals).toString();
} }
export function formatCurrency(value, currencyCode) { export function formatCurrency(value: string, currencyCode: string): string {
const upperCaseCurrencyCode = currencyCode.toUpperCase(); const upperCaseCurrencyCode = currencyCode.toUpperCase();
return currencies.find((currency) => currency.code === upperCaseCurrencyCode) return currencies.find((currency) => currency.code === upperCaseCurrencyCode)
? currencyFormatter.format(Number(value), { ? currencyFormatter.format(Number(value), {
code: upperCaseCurrencyCode, code: upperCaseCurrencyCode,
style: 'currency',
}) })
: value; : value;
} }
export function convertTokenToFiat({ export function convertTokenToFiat({
value, value,
fromCurrency = 'ETH', fromCurrency = EtherDenomination.ETH,
toCurrency, toCurrency,
conversionRate, conversionRate,
contractExchangeRate, contractExchangeRate,
}) { }: {
value: string;
fromCurrency: EtherDenomination;
toCurrency: string;
conversionRate: number;
contractExchangeRate: number;
}): string {
const totalExchangeRate = conversionRate * contractExchangeRate; const totalExchangeRate = conversionRate * contractExchangeRate;
let tokenInFiat = new Numeric(value, 10); let tokenInFiat = new Numeric(value, 10);
@ -74,18 +86,30 @@ export function convertTokenToFiat({
return tokenInFiat.round(2).toString(); return tokenInFiat.round(2).toString();
} }
export function hasUnconfirmedTransactions(state) { /**
* This is a selector and probably doesn't belong here but its staying for now
* Note: I did not go so far as to type the entirety of the MetaMask state tree
* which definitely needs to be done for the full conversion of TypeScript to
* be successful and as useful as possible.
* TODO: Type the MetaMask state tree and use that type here.
*
* @param state - MetaMask state
* @returns true if there are unconfirmed transactions in state
*/
export function hasUnconfirmedTransactions(
state: Record<string, any>,
): boolean {
return unconfirmedTransactionsCountSelector(state) > 0; return unconfirmedTransactionsCountSelector(state) > 0;
} }
/** /**
* Rounds the given decimal string to 4 significant digits. * Rounds the given decimal string to 4 significant digits.
* *
* @param {string} decimalString - The base-ten number to round. * @param decimalString - The base-ten number to round.
* @returns {string} The rounded number, or the original number if no * @returns The rounded number, or the original number if no
* rounding was necessary. * rounding was necessary.
*/ */
export function roundExponential(decimalString) { export function roundExponential(decimalString: string): string {
const PRECISION = 4; const PRECISION = 4;
const bigNumberValue = new BigNumber(decimalString); const bigNumberValue = new BigNumber(decimalString);
@ -95,8 +119,10 @@ export function roundExponential(decimalString) {
: decimalString; : decimalString;
} }
export function areDappSuggestedAndTxParamGasFeesTheSame(txData = {}) { export function areDappSuggestedAndTxParamGasFeesTheSame(
const { txParams, dappSuggestedGasFees } = txData; txData: TransactionMeta,
): boolean {
const { txParams, dappSuggestedGasFees } = txData ?? {};
const { const {
gasPrice: txParamsGasPrice, gasPrice: txParamsGasPrice,
maxFeePerGas: txParamsMaxFeePerGas, maxFeePerGas: txParamsMaxFeePerGas,
@ -127,9 +153,9 @@ export function areDappSuggestedAndTxParamGasFeesTheSame(txData = {}) {
txParamsMaxFeePerGas === dappMaxFeePerGas && txParamsMaxFeePerGas === dappMaxFeePerGas &&
txParamsMaxPriorityFeePerGas === dappMaxPriorityFeePerGas; txParamsMaxPriorityFeePerGas === dappMaxPriorityFeePerGas;
return ( return Boolean(
txParamsGasPriceMatchesDappSuggestedGasPrice || txParamsGasPriceMatchesDappSuggestedGasPrice ||
txParamsEIP1559FeesMatchDappSuggestedGasPrice || txParamsEIP1559FeesMatchDappSuggestedGasPrice ||
txParamsEIP1559FeesMatchDappSuggestedEIP1559Fees txParamsEIP1559FeesMatchDappSuggestedEIP1559Fees,
); );
} }

View File

@ -6902,6 +6902,13 @@ __metadata:
languageName: node languageName: node
linkType: hard linkType: hard
"@types/currency-formatter@npm:^1.5.1":
version: 1.5.1
resolution: "@types/currency-formatter@npm:1.5.1"
checksum: dcbe69289bb1493092842f9d4cb97e54b1a0801769506ffb4e35c417863f0e35e8bf7f09445d91f9487cf31af3d4a9e65db1435c2987dd37da4e20d47a52dd63
languageName: node
linkType: hard
"@types/debug@npm:^4.1.7": "@types/debug@npm:^4.1.7":
version: 4.1.7 version: 4.1.7
resolution: "@types/debug@npm:4.1.7" resolution: "@types/debug@npm:4.1.7"
@ -24113,6 +24120,7 @@ __metadata:
"@tsconfig/node16": ^1.0.3 "@tsconfig/node16": ^1.0.3
"@types/babelify": ^7.3.7 "@types/babelify": ^7.3.7
"@types/browserify": ^12.0.37 "@types/browserify": ^12.0.37
"@types/currency-formatter": ^1.5.1
"@types/end-of-stream": ^1.4.1 "@types/end-of-stream": ^1.4.1
"@types/fs-extra": ^9.0.13 "@types/fs-extra": ^9.0.13
"@types/gulp": ^4.0.9 "@types/gulp": ^4.0.9