You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
64 lines
2.4 KiB
64 lines
2.4 KiB
import { useSelector } from 'react-redux';
|
|
import { GAS_ESTIMATE_TYPES } from '../../shared/constants/gas';
|
|
import {
|
|
getEstimatedGasFeeTimeBounds,
|
|
getGasEstimateType,
|
|
getGasFeeEstimates,
|
|
} from '../ducks/metamask/metamask';
|
|
import { checkNetworkAndAccountSupports1559 } from '../selectors';
|
|
import { useSafeGasEstimatePolling } from './useSafeGasEstimatePolling';
|
|
|
|
/**
|
|
* @typedef {keyof typeof GAS_ESTIMATE_TYPES} GasEstimateTypes
|
|
*/
|
|
|
|
/**
|
|
* @typedef {object} GasEstimates
|
|
* @property {GasEstimateTypes} gasEstimateType - The type of estimate provided
|
|
* @property {import(
|
|
* '@metamask/controllers'
|
|
* ).GasFeeState['gasFeeEstimates']} gasFeeEstimates - The estimate object
|
|
* @property {import(
|
|
* '@metamask/controllers'
|
|
* ).GasFeeState['estimatedGasFeeTimeBounds']} [estimatedGasFeeTimeBounds] -
|
|
* estimated time boundaries for fee-market type estimates
|
|
* @property {boolean} isGasEstimateLoading - indicates whether the gas
|
|
* estimates are currently loading.
|
|
*/
|
|
|
|
/**
|
|
* Gets the current gasFeeEstimates from state and begins polling for new
|
|
* estimates. When this hook is removed from the tree it will signal to the
|
|
* GasFeeController that it is done requiring new gas estimates. Also checks
|
|
* the returned gas estimate for validity on the current network.
|
|
*
|
|
* @returns {GasFeeEstimates} - GasFeeEstimates object
|
|
*/
|
|
export function useGasFeeEstimates() {
|
|
const networkAndAccountSupports1559 = useSelector(
|
|
checkNetworkAndAccountSupports1559,
|
|
);
|
|
const gasEstimateType = useSelector(getGasEstimateType);
|
|
const gasFeeEstimates = useSelector(getGasFeeEstimates);
|
|
const estimatedGasFeeTimeBounds = useSelector(getEstimatedGasFeeTimeBounds);
|
|
useSafeGasEstimatePolling();
|
|
|
|
// We consider the gas estimate to be loading if the gasEstimateType is
|
|
// 'NONE' or if the current gasEstimateType cannot be supported by the current
|
|
// network
|
|
const isEIP1559TolerableEstimateType =
|
|
gasEstimateType === GAS_ESTIMATE_TYPES.FEE_MARKET ||
|
|
gasEstimateType === GAS_ESTIMATE_TYPES.ETH_GASPRICE;
|
|
const isGasEstimatesLoading =
|
|
gasEstimateType === GAS_ESTIMATE_TYPES.NONE ||
|
|
(networkAndAccountSupports1559 && !isEIP1559TolerableEstimateType) ||
|
|
(!networkAndAccountSupports1559 &&
|
|
gasEstimateType === GAS_ESTIMATE_TYPES.FEE_MARKET);
|
|
|
|
return {
|
|
gasFeeEstimates,
|
|
gasEstimateType,
|
|
estimatedGasFeeTimeBounds,
|
|
isGasEstimatesLoading,
|
|
};
|
|
}
|
|
|