mirror of
https://github.com/kremalicious/metamask-extension.git
synced 2024-11-29 23:58:06 +01:00
3732c5f71e
ESLint rules have been added to enforce our JSDoc conventions. These rules were introduced by updating `@metamask/eslint-config` to v9. Some of the rules have been disabled because the effort to fix all lint errors was too high. It might be easiest to enable these rules one directory at a time, or one rule at a time. Most of the changes in this PR were a result of running `yarn lint:fix`. There were a handful of manual changes that seemed obvious and simple to make. Anything beyond that and the rule was left disabled.
97 lines
3.8 KiB
JavaScript
97 lines
3.8 KiB
JavaScript
import BigNumber from 'bignumber.js';
|
|
import { useMemo } from 'react';
|
|
import { isEIP1559Transaction } from '../../shared/modules/transaction.utils';
|
|
import { decGWEIToHexWEI } from '../helpers/utils/conversions.util';
|
|
import { addTenPercent } from '../helpers/utils/gas';
|
|
import { useGasFeeEstimates } from './useGasFeeEstimates';
|
|
|
|
/**
|
|
* Helper that returns the higher of two options for a new gas fee:
|
|
* The original fee + 10% or
|
|
* the current medium suggested fee from our gas estimation api
|
|
*
|
|
* @param {string} originalFee - hexWei vale of the original fee (maxFee or maxPriority)
|
|
* @param {string} currentEstimate - decGwei value of the current medium gasFee estimate (maxFee or maxPriorityfee)
|
|
* @returns {string} hexWei value of the higher of the two inputs.
|
|
*/
|
|
function getHighestIncrementedFee(originalFee, currentEstimate) {
|
|
const buffedOriginalHexWei = addTenPercent(originalFee);
|
|
const currentEstimateHexWei = decGWEIToHexWEI(currentEstimate);
|
|
|
|
return new BigNumber(buffedOriginalHexWei, 16).greaterThan(
|
|
new BigNumber(currentEstimateHexWei, 16),
|
|
)
|
|
? buffedOriginalHexWei
|
|
: currentEstimateHexWei;
|
|
}
|
|
|
|
/**
|
|
* When initializing cancellations or speed ups we need to set the baseline
|
|
* gas fees to be 10% higher, which is the bare minimum that the network will
|
|
* accept for transactions of the same nonce. Anything lower than this will be
|
|
* discarded by the network to avoid DoS attacks. This hook returns an object
|
|
* that either has gasPrice or maxFeePerGas/maxPriorityFeePerGas specified. In
|
|
* addition the gasLimit will also be included.
|
|
*
|
|
* @param {} transaction
|
|
* @returns {import(
|
|
* '../../app/scripts/controllers/transactions'
|
|
* ).CustomGasSettings} Gas settings for cancellations/speed ups
|
|
*/
|
|
export function useIncrementedGasFees(transaction) {
|
|
const { gasFeeEstimates = {} } = useGasFeeEstimates();
|
|
|
|
// We memoize this value so that it can be relied upon in other hooks.
|
|
const customGasSettings = useMemo(() => {
|
|
// This hook is called indiscriminantly on all transactions appearing in
|
|
// the activity list. This includes transitional items such as signature
|
|
// requests. These types of "transactions" are not really transactions and
|
|
// do not have txParams. This is why we use optional chaining on the
|
|
// txParams object in this hook.
|
|
const temporaryGasSettings = {
|
|
gasLimit: transaction.txParams?.gas,
|
|
gas: transaction.txParams?.gas,
|
|
};
|
|
|
|
const suggestedMaxFeePerGas =
|
|
gasFeeEstimates?.medium?.suggestedMaxFeePerGas ?? '0';
|
|
const suggestedMaxPriorityFeePerGas =
|
|
gasFeeEstimates?.medium?.suggestedMaxPriorityFeePerGas ?? '0';
|
|
|
|
if (isEIP1559Transaction(transaction)) {
|
|
const transactionMaxFeePerGas = transaction.txParams?.maxFeePerGas;
|
|
const transactionMaxPriorityFeePerGas =
|
|
transaction.txParams?.maxPriorityFeePerGas;
|
|
|
|
temporaryGasSettings.maxFeePerGas =
|
|
transactionMaxFeePerGas === undefined ||
|
|
transactionMaxFeePerGas.startsWith('-')
|
|
? '0x0'
|
|
: getHighestIncrementedFee(
|
|
transactionMaxFeePerGas,
|
|
suggestedMaxFeePerGas,
|
|
);
|
|
temporaryGasSettings.maxPriorityFeePerGas =
|
|
transactionMaxPriorityFeePerGas === undefined ||
|
|
transactionMaxPriorityFeePerGas.startsWith('-')
|
|
? '0x0'
|
|
: getHighestIncrementedFee(
|
|
transactionMaxPriorityFeePerGas,
|
|
suggestedMaxPriorityFeePerGas,
|
|
);
|
|
} else {
|
|
const transactionGasPrice = transaction.txParams?.gasPrice;
|
|
temporaryGasSettings.gasPrice =
|
|
transactionGasPrice === undefined || transactionGasPrice.startsWith('-')
|
|
? '0x0'
|
|
: getHighestIncrementedFee(
|
|
transactionGasPrice,
|
|
suggestedMaxFeePerGas,
|
|
);
|
|
}
|
|
return temporaryGasSettings;
|
|
}, [transaction, gasFeeEstimates]);
|
|
|
|
return customGasSettings;
|
|
}
|