mirror of
https://github.com/kremalicious/metamask-extension.git
synced 2024-12-05 23:44:56 +01:00
6e13524bcd
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>
125 lines
3.8 KiB
JavaScript
125 lines
3.8 KiB
JavaScript
import { constant, times, uniq, zip } from 'lodash';
|
|
import BigNumber from 'bignumber.js';
|
|
import { addHexPrefix } from 'ethereumjs-util';
|
|
import {
|
|
GAS_RECOMMENDATIONS,
|
|
EDIT_GAS_MODES,
|
|
} from '../../../shared/constants/gas';
|
|
import { multiplyCurrencies } from '../../../shared/modules/conversion.utils';
|
|
import { hexWEIToDecGWEI } from '../../../shared/lib/transactions-controller-utils';
|
|
import {
|
|
bnGreaterThan,
|
|
isNullish,
|
|
roundToDecimalPlacesRemovingExtraZeroes,
|
|
} from './util';
|
|
|
|
export const gasEstimateGreaterThanGasUsedPlusTenPercent = (
|
|
gasUsed,
|
|
gasFeeEstimates,
|
|
estimate,
|
|
) => {
|
|
let { maxFeePerGas: maxFeePerGasInTransaction } = gasUsed;
|
|
maxFeePerGasInTransaction = new BigNumber(
|
|
hexWEIToDecGWEI(addTenPercentAndRound(maxFeePerGasInTransaction)),
|
|
);
|
|
|
|
const maxFeePerGasFromEstimate =
|
|
gasFeeEstimates[estimate]?.suggestedMaxFeePerGas;
|
|
return bnGreaterThan(maxFeePerGasFromEstimate, maxFeePerGasInTransaction);
|
|
};
|
|
|
|
/**
|
|
* Simple helper to save on duplication to multiply the supplied wei hex string
|
|
* by 1.10 to get bare minimum new gas fee.
|
|
*
|
|
* @param {string | undefined} hexStringValue - hex value in wei to be incremented
|
|
* @param conversionOptions
|
|
* @returns {string | undefined} hex value in WEI 10% higher than the param.
|
|
*/
|
|
export function addTenPercent(hexStringValue, conversionOptions = {}) {
|
|
if (hexStringValue === undefined) {
|
|
return undefined;
|
|
}
|
|
return addHexPrefix(
|
|
multiplyCurrencies(hexStringValue, 1.1, {
|
|
toNumericBase: 'hex',
|
|
multiplicandBase: 16,
|
|
multiplierBase: 10,
|
|
numberOfDecimals: 0,
|
|
...conversionOptions,
|
|
}),
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Simple helper to save on duplication to multiply the supplied wei hex string
|
|
* by 1.10 to get bare minimum new gas fee.
|
|
*
|
|
* @param {string | undefined} hexStringValue - hex value in wei to be incremented
|
|
* @returns {string | undefined} hex value in WEI 10% higher than the param.
|
|
*/
|
|
export function addTenPercentAndRound(hexStringValue) {
|
|
return addTenPercent(hexStringValue, { numberOfDecimals: 0 });
|
|
}
|
|
|
|
export function isMetamaskSuggestedGasEstimate(estimate) {
|
|
return [
|
|
GAS_RECOMMENDATIONS.HIGH,
|
|
GAS_RECOMMENDATIONS.MEDIUM,
|
|
GAS_RECOMMENDATIONS.LOW,
|
|
].includes(estimate);
|
|
}
|
|
|
|
/**
|
|
* Formats a singular gas fee or a range of gas fees by rounding them to the
|
|
* given precisions and then arranging them as a string.
|
|
*
|
|
* @param {string | [string, string] | null | undefined} feeOrFeeRange - The fee
|
|
* in GWEI or range of fees in GWEI.
|
|
* @param {object} options - The options.
|
|
* @param {number | [number, number]} options.precision - The precision(s) to
|
|
* use when formatting the fee(s).
|
|
* @returns A string which represents the formatted version of the fee or fee
|
|
* range.
|
|
*/
|
|
export function formatGasFeeOrFeeRange(
|
|
feeOrFeeRange,
|
|
{ precision: precisionOrPrecisions = 2 } = {},
|
|
) {
|
|
if (
|
|
isNullish(feeOrFeeRange) ||
|
|
(Array.isArray(feeOrFeeRange) && feeOrFeeRange.length === 0)
|
|
) {
|
|
return null;
|
|
}
|
|
|
|
const range = Array.isArray(feeOrFeeRange)
|
|
? feeOrFeeRange.slice(0, 2)
|
|
: [feeOrFeeRange];
|
|
const precisions = Array.isArray(precisionOrPrecisions)
|
|
? precisionOrPrecisions.slice(0, 2)
|
|
: times(range.length, constant(precisionOrPrecisions));
|
|
const formattedRange = uniq(
|
|
zip(range, precisions).map(([fee, precision]) => {
|
|
return precision === undefined
|
|
? fee
|
|
: roundToDecimalPlacesRemovingExtraZeroes(fee, precision);
|
|
}),
|
|
).join(' - ');
|
|
|
|
return `${formattedRange} GWEI`;
|
|
}
|
|
|
|
/**
|
|
* Helper method for determining whether an edit gas mode is either a speed up or cancel transaction
|
|
*
|
|
* @param {string | undefined} editGasMode - One of 'speed-up', 'cancel', 'modify-in-place', or 'swaps'
|
|
* @returns boolean
|
|
*/
|
|
export function editGasModeIsSpeedUpOrCancel(editGasMode) {
|
|
return (
|
|
editGasMode === EDIT_GAS_MODES.CANCEL ||
|
|
editGasMode === EDIT_GAS_MODES.SPEED_UP
|
|
);
|
|
}
|