mirror of
https://github.com/kremalicious/metamask-extension.git
synced 2024-11-22 18:00:18 +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.
75 lines
2.3 KiB
JavaScript
75 lines
2.3 KiB
JavaScript
import { useState } from 'react';
|
|
import { isEqual } from 'lodash';
|
|
|
|
import {
|
|
GAS_ESTIMATE_TYPES,
|
|
CUSTOM_GAS_ESTIMATE,
|
|
} from '../../../shared/constants/gas';
|
|
import { hexWEIToDecGWEI } from '../../helpers/utils/conversions.util';
|
|
import { isLegacyTransaction } from '../../helpers/utils/transactions.util';
|
|
|
|
import { feeParamsAreCustom } from './utils';
|
|
|
|
function getGasPriceEstimate(gasFeeEstimates, gasEstimateType, estimateToUse) {
|
|
if (gasEstimateType === GAS_ESTIMATE_TYPES.LEGACY) {
|
|
return gasFeeEstimates?.[estimateToUse] ?? '0';
|
|
} else if (gasEstimateType === GAS_ESTIMATE_TYPES.ETH_GASPRICE) {
|
|
return gasFeeEstimates?.gasPrice ?? '0';
|
|
}
|
|
return '0';
|
|
}
|
|
|
|
/**
|
|
* @typedef {Object} GasPriceInputsReturnType
|
|
* @property {DecGweiString} [gasPrice] - the gasPrice input value.
|
|
* @property {(DecGweiString) => void} setGasPrice - state setter method to update the gasPrice.
|
|
* @property {(boolean) => true} setGasPriceHasBeenManuallySet - state setter method to update gasPriceHasBeenManuallySet
|
|
* field gasPriceHasBeenManuallySet is used in gasPrice calculations.
|
|
*/
|
|
|
|
/**
|
|
* @param options
|
|
* @param options.estimateToUse
|
|
* @param options.gasEstimateType
|
|
* @param options.gasFeeEstimates
|
|
* @param options.transaction
|
|
* @returns {GasPriceInputsReturnType}
|
|
*/
|
|
export function useGasPriceInput({
|
|
estimateToUse,
|
|
gasEstimateType,
|
|
gasFeeEstimates,
|
|
transaction,
|
|
}) {
|
|
const [gasPriceHasBeenManuallySet, setGasPriceHasBeenManuallySet] = useState(
|
|
transaction?.userFeeLevel === CUSTOM_GAS_ESTIMATE,
|
|
);
|
|
|
|
const [gasPrice, setGasPrice] = useState(() => {
|
|
const { gasPrice: txGasPrice } = transaction?.txParams || {};
|
|
return txGasPrice && feeParamsAreCustom(transaction)
|
|
? Number(hexWEIToDecGWEI(txGasPrice))
|
|
: null;
|
|
});
|
|
|
|
const [initialGasPriceEstimates] = useState(gasFeeEstimates);
|
|
const gasPriceEstimatesHaveNotChanged = isEqual(
|
|
initialGasPriceEstimates,
|
|
gasFeeEstimates,
|
|
);
|
|
|
|
const gasPriceToUse =
|
|
gasPrice !== null &&
|
|
(gasPriceHasBeenManuallySet ||
|
|
gasPriceEstimatesHaveNotChanged ||
|
|
isLegacyTransaction(transaction?.txParams))
|
|
? gasPrice
|
|
: getGasPriceEstimate(gasFeeEstimates, gasEstimateType, estimateToUse);
|
|
|
|
return {
|
|
gasPrice: gasPriceToUse,
|
|
setGasPrice,
|
|
setGasPriceHasBeenManuallySet,
|
|
};
|
|
}
|