packages/instant/src/util/gas_price_estimator.ts


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65

import { BigNumber, fetchAsync } from '@0x/utils';

import {
    DEFAULT_ESTIMATED_TRANSACTION_TIME_MS,
    DEFAULT_GAS_PRICE,
    ETH_GAS_STATION_API_BASE_URL,
    GWEI_IN_WEI,
} from '../constants';

import { errorReporter } from './error_reporter';

interface EthGasStationResult {
    average: number;
    fastestWait: number;
    fastWait: number;
    fast: number;
    safeLowWait: number;
    blockNum: number;
    avgWait: number;
    block_time: number;
    speed: number;
    fastest: number;
    safeLow: number;
}

interface GasInfo {
    gasPriceInWei: BigNumber;
    estimatedTimeMs: number;
}

const fetchFastAmountInWeiAsync = async (): Promise<GasInfo> => {
    const res = await fetchAsync(`${ETH_GAS_STATION_API_BASE_URL}/json/ethgasAPI.json`);
    const gasInfo = (await res.json()) as EthGasStationResult;
    // Eth Gas Station result is gwei * 10
    const gasPriceInGwei = new BigNumber(gasInfo.fast / 10);
    // Time is in minutes
    const estimatedTimeMs = gasInfo.fastWait * 60 * 1000; // Minutes to MS
    return { gasPriceInWei: gasPriceInGwei.multipliedBy(GWEI_IN_WEI), estimatedTimeMs };
};

export class GasPriceEstimator {
    private _lastFetched?: GasInfo;
    public async getGasInfoAsync(): Promise<GasInfo> {
        let fetchedAmount: GasInfo | undefined;
        try {
            fetchedAmount = await fetchFastAmountInWeiAsync();
        } catch (e) {
            fetchedAmount = undefined;
            errorReporter.report(e);
        }

        if (fetchedAmount) {
            this._lastFetched = fetchedAmount;
        }

        return (
            fetchedAmount ||
            this._lastFetched || {
                gasPriceInWei: DEFAULT_GAS_PRICE,
                estimatedTimeMs: DEFAULT_ESTIMATED_TRANSACTION_TIME_MS,
            }
        );
    }
}
export const gasPriceEstimator = new GasPriceEstimator();