@metamask/gas-fee-controller 1.0.0

package/CHANGELOG.md

@@ -0,0 +1,18 @@
+# Changelog
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [1.0.0]
+### Added
+- Initial release
+  - As a result of converting our shared controllers repo into a monorepo ([#831](https://github.com/MetaMask/controllers/pull/831)), we've created this package from select parts of [`@metamask/controllers` v33.0.0](https://github.com/MetaMask/controllers/tree/v33.0.0), namely:
+    - Everything in `src/gas`
+
+    All changes listed after this point were applied to this package following the monorepo conversion.
+
+[Unreleased]: https://github.com/MetaMask/controllers/compare/@metamask/gas-fee-controller@1.0.0...HEAD
+[1.0.0]: https://github.com/MetaMask/controllers/releases/tag/@metamask/gas-fee-controller@1.0.0

package/LICENSE

@@ -0,0 +1,20 @@
+MIT License
+
+Copyright (c) 2018 MetaMask
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE

package/README.md

@@ -0,0 +1,15 @@
+# `@metamask/gas-fee-controller`
+
+Periodically calculates gas fee estimates based on various gas limits as well as other data displayed on transaction confirm screens.
+
+## Installation
+
+`yarn add @metamask/gas-fee-controller`
+
+or
+
+`npm install @metamask/gas-fee-controller`
+
+## Contributing
+
+This package is part of a monorepo. Instructions for contributing can be found in the [monorepo README](https://github.com/MetaMask/controllers#readme).

package/dist/GasFeeController.d.ts

@@ -0,0 +1,229 @@
+import type { Patch } from 'immer';
+import { BaseControllerV2, RestrictedControllerMessenger } from '@metamask/base-controller';
+import type { NetworkControllerGetEthQueryAction, NetworkControllerGetProviderConfigAction, NetworkControllerProviderChangeEvent, NetworkController, NetworkState } from '@metamask/network-controller';
+export declare const LEGACY_GAS_PRICES_API_URL = "https://api.metaswap.codefi.network/gasPrices";
+export declare type unknownString = 'unknown';
+export declare type FeeMarketEstimateType = 'fee-market';
+export declare type LegacyEstimateType = 'legacy';
+export declare type EthGasPriceEstimateType = 'eth_gasPrice';
+export declare type NoEstimateType = 'none';
+/**
+ * Indicates which type of gasEstimate the controller is currently returning.
+ * This is useful as a way of asserting that the shape of gasEstimates matches
+ * expectations. NONE is a special case indicating that no previous gasEstimate
+ * has been fetched.
+ */
+export declare const GAS_ESTIMATE_TYPES: {
+    FEE_MARKET: "fee-market";
+    LEGACY: "legacy";
+    ETH_GASPRICE: "eth_gasPrice";
+    NONE: "none";
+};
+export declare type GasEstimateType = FeeMarketEstimateType | EthGasPriceEstimateType | LegacyEstimateType | NoEstimateType;
+export declare type EstimatedGasFeeTimeBounds = {
+    lowerTimeBound: number | null;
+    upperTimeBound: number | unknownString;
+};
+/**
+ * @type EthGasPriceEstimate
+ *
+ * A single gas price estimate for networks and accounts that don't support EIP-1559
+ * This estimate comes from eth_gasPrice but is converted to dec gwei to match other
+ * return values
+ * @property gasPrice - A GWEI dec string
+ */
+export declare type EthGasPriceEstimate = {
+    gasPrice: string;
+};
+/**
+ * @type LegacyGasPriceEstimate
+ *
+ * A set of gas price estimates for networks and accounts that don't support EIP-1559
+ * These estimates include low, medium and high all as strings representing gwei in
+ * decimal format.
+ * @property high - gasPrice, in decimal gwei string format, suggested for fast inclusion
+ * @property medium - gasPrice, in decimal gwei string format, suggested for avg inclusion
+ * @property low - gasPrice, in decimal gwei string format, suggested for slow inclusion
+ */
+export declare type LegacyGasPriceEstimate = {
+    high: string;
+    medium: string;
+    low: string;
+};
+/**
+ * @type Eip1559GasFee
+ *
+ * Data necessary to provide an estimate of a gas fee with a specific tip
+ * @property minWaitTimeEstimate - The fastest the transaction will take, in milliseconds
+ * @property maxWaitTimeEstimate - The slowest the transaction will take, in milliseconds
+ * @property suggestedMaxPriorityFeePerGas - A suggested "tip", a GWEI hex number
+ * @property suggestedMaxFeePerGas - A suggested max fee, the most a user will pay. a GWEI hex number
+ */
+export declare type Eip1559GasFee = {
+    minWaitTimeEstimate: number;
+    maxWaitTimeEstimate: number;
+    suggestedMaxPriorityFeePerGas: string;
+    suggestedMaxFeePerGas: string;
+};
+/**
+ * @type GasFeeEstimates
+ *
+ * Data necessary to provide multiple GasFee estimates, and supporting information, to the user
+ * @property low - A GasFee for a minimum necessary combination of tip and maxFee
+ * @property medium - A GasFee for a recommended combination of tip and maxFee
+ * @property high - A GasFee for a high combination of tip and maxFee
+ * @property estimatedBaseFee - An estimate of what the base fee will be for the pending/next block. A GWEI dec number
+ * @property networkCongestion - A normalized number that can be used to gauge the congestion
+ * level of the network, with 0 meaning not congested and 1 meaning extremely congested
+ */
+export declare type GasFeeEstimates = SourcedGasFeeEstimates | FallbackGasFeeEstimates;
+declare type SourcedGasFeeEstimates = {
+    low: Eip1559GasFee;
+    medium: Eip1559GasFee;
+    high: Eip1559GasFee;
+    estimatedBaseFee: string;
+    historicalBaseFeeRange: [string, string];
+    baseFeeTrend: 'up' | 'down' | 'level';
+    latestPriorityFeeRange: [string, string];
+    historicalPriorityFeeRange: [string, string];
+    priorityFeeTrend: 'up' | 'down' | 'level';
+    networkCongestion: number;
+};
+declare type FallbackGasFeeEstimates = {
+    low: Eip1559GasFee;
+    medium: Eip1559GasFee;
+    high: Eip1559GasFee;
+    estimatedBaseFee: string;
+    historicalBaseFeeRange: null;
+    baseFeeTrend: null;
+    latestPriorityFeeRange: null;
+    historicalPriorityFeeRange: null;
+    priorityFeeTrend: null;
+    networkCongestion: null;
+};
+export declare type GasFeeStateEthGasPrice = {
+    gasFeeEstimates: EthGasPriceEstimate;
+    estimatedGasFeeTimeBounds: Record<string, never>;
+    gasEstimateType: EthGasPriceEstimateType;
+};
+export declare type GasFeeStateFeeMarket = {
+    gasFeeEstimates: GasFeeEstimates;
+    estimatedGasFeeTimeBounds: EstimatedGasFeeTimeBounds | Record<string, never>;
+    gasEstimateType: FeeMarketEstimateType;
+};
+export declare type GasFeeStateLegacy = {
+    gasFeeEstimates: LegacyGasPriceEstimate;
+    estimatedGasFeeTimeBounds: Record<string, never>;
+    gasEstimateType: LegacyEstimateType;
+};
+export declare type GasFeeStateNoEstimates = {
+    gasFeeEstimates: Record<string, never>;
+    estimatedGasFeeTimeBounds: Record<string, never>;
+    gasEstimateType: NoEstimateType;
+};
+export declare type FetchGasFeeEstimateOptions = {
+    shouldUpdateState?: boolean;
+};
+/**
+ * @type GasFeeState
+ *
+ * Gas Fee controller state
+ * @property gasFeeEstimates - Gas fee estimate data based on new EIP-1559 properties
+ * @property estimatedGasFeeTimeBounds - Estimates representing the minimum and maximum
+ */
+export declare type GasFeeState = GasFeeStateEthGasPrice | GasFeeStateFeeMarket | GasFeeStateLegacy | GasFeeStateNoEstimates;
+declare const name = "GasFeeController";
+export declare type GasFeeStateChange = {
+    type: `${typeof name}:stateChange`;
+    payload: [GasFeeState, Patch[]];
+};
+export declare type GetGasFeeState = {
+    type: `${typeof name}:getState`;
+    handler: () => GasFeeState;
+};
+declare type GasFeeMessenger = RestrictedControllerMessenger<typeof name, GetGasFeeState | NetworkControllerGetProviderConfigAction | NetworkControllerGetEthQueryAction, GasFeeStateChange | NetworkControllerProviderChangeEvent, NetworkControllerGetProviderConfigAction['type'] | NetworkControllerGetEthQueryAction['type'], NetworkControllerProviderChangeEvent['type']>;
+export declare type ChainID = `0x${string}` | `${number}` | number;
+/**
+ * Controller that retrieves gas fee estimate data and polls for updated data on a set interval
+ */
+export declare class GasFeeController extends BaseControllerV2<typeof name, GasFeeState, GasFeeMessenger> {
+    private intervalId?;
+    private intervalDelay;
+    private pollTokens;
+    private legacyAPIEndpoint;
+    private EIP1559APIEndpoint;
+    private getCurrentNetworkEIP1559Compatibility;
+    private getCurrentNetworkLegacyGasAPICompatibility;
+    private getCurrentAccountEIP1559Compatibility;
+    private currentChainId;
+    private ethQuery;
+    private clientId?;
+    /**
+     * Creates a GasFeeController instance.
+     *
+     * @param options - The controller options.
+     * @param options.interval - The time in milliseconds to wait between polls.
+     * @param options.messenger - The controller messenger.
+     * @param options.state - The initial state.
+     * @param options.getCurrentNetworkEIP1559Compatibility - Determines whether or not the current
+     * network is EIP-1559 compatible.
+     * @param options.getCurrentNetworkLegacyGasAPICompatibility - Determines whether or not the
+     * current network is compatible with the legacy gas price API.
+     * @param options.getCurrentAccountEIP1559Compatibility - Determines whether or not the current
+     * account is EIP-1559 compatible.
+     * @param options.getChainId - Returns the current chain ID.
+     * @param options.getProvider - Returns a network provider for the current network.
+     * @param options.onNetworkStateChange - A function for registering an event handler for the
+     * network state change event.
+     * @param options.legacyAPIEndpoint - The legacy gas price API URL. This option is primarily for
+     * testing purposes.
+     * @param options.EIP1559APIEndpoint - The EIP-1559 gas price API URL. This option is primarily
+     * for testing purposes.
+     * @param options.clientId - The client ID used to identify to the gas estimation API who is
+     * asking for estimates.
+     */
+    constructor({ interval, messenger, state, getCurrentNetworkEIP1559Compatibility, getCurrentAccountEIP1559Compatibility, getChainId, getCurrentNetworkLegacyGasAPICompatibility, getProvider, onNetworkStateChange, legacyAPIEndpoint, EIP1559APIEndpoint, clientId, }: {
+        interval?: number;
+        messenger: GasFeeMessenger;
+        state?: GasFeeState;
+        getCurrentNetworkEIP1559Compatibility: () => Promise<boolean>;
+        getCurrentNetworkLegacyGasAPICompatibility: () => boolean;
+        getCurrentAccountEIP1559Compatibility?: () => boolean;
+        getChainId?: () => `0x${string}` | `${number}` | number;
+        getProvider: () => NetworkController['provider'];
+        onNetworkStateChange?: (listener: (state: NetworkState) => void) => void;
+        legacyAPIEndpoint?: string;
+        EIP1559APIEndpoint?: string;
+        clientId?: string;
+    });
+    resetPolling(): Promise<void>;
+    fetchGasFeeEstimates(options?: FetchGasFeeEstimateOptions): Promise<GasFeeState>;
+    getGasFeeEstimatesAndStartPolling(pollToken: string | undefined): Promise<string>;
+    /**
+     * Gets and sets gasFeeEstimates in state.
+     *
+     * @param options - The gas fee estimate options.
+     * @param options.shouldUpdateState - Determines whether the state should be updated with the
+     * updated gas estimates.
+     * @returns The gas fee estimates.
+     */
+    _fetchGasFeeEstimateData(options?: FetchGasFeeEstimateOptions): Promise<GasFeeState>;
+    /**
+     * Remove the poll token, and stop polling if the set of poll tokens is empty.
+     *
+     * @param pollToken - The poll token to disconnect.
+     */
+    disconnectPoller(pollToken: string): void;
+    stopPolling(): void;
+    /**
+     * Prepare to discard this controller.
+     *
+     * This stops any active polling.
+     */
+    destroy(): void;
+    private _poll;
+    private resetState;
+    private getEIP1559Compatibility;
+    getTimeEstimate(maxPriorityFeePerGas: string, maxFeePerGas: string): EstimatedGasFeeTimeBounds | Record<string, never>;
+}
+export default GasFeeController;

package/dist/GasFeeController.js

@@ -0,0 +1,264 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.GasFeeController = exports.GAS_ESTIMATE_TYPES = exports.LEGACY_GAS_PRICES_API_URL = void 0;
+const eth_query_1 = __importDefault(require("eth-query"));
+const uuid_1 = require("uuid");
+const ethereumjs_util_1 = require("ethereumjs-util");
+const base_controller_1 = require("@metamask/base-controller");
+const controller_utils_1 = require("@metamask/controller-utils");
+const gas_util_1 = require("./gas-util");
+const determineGasFeeCalculations_1 = __importDefault(require("./determineGasFeeCalculations"));
+const fetchGasEstimatesViaEthFeeHistory_1 = __importDefault(require("./fetchGasEstimatesViaEthFeeHistory"));
+const GAS_FEE_API = 'https://mock-gas-server.herokuapp.com/';
+exports.LEGACY_GAS_PRICES_API_URL = `https://api.metaswap.codefi.network/gasPrices`;
+/**
+ * Indicates which type of gasEstimate the controller is currently returning.
+ * This is useful as a way of asserting that the shape of gasEstimates matches
+ * expectations. NONE is a special case indicating that no previous gasEstimate
+ * has been fetched.
+ */
+exports.GAS_ESTIMATE_TYPES = {
+    FEE_MARKET: 'fee-market',
+    LEGACY: 'legacy',
+    ETH_GASPRICE: 'eth_gasPrice',
+    NONE: 'none',
+};
+const metadata = {
+    gasFeeEstimates: { persist: true, anonymous: false },
+    estimatedGasFeeTimeBounds: { persist: true, anonymous: false },
+    gasEstimateType: { persist: true, anonymous: false },
+};
+const name = 'GasFeeController';
+const defaultState = {
+    gasFeeEstimates: {},
+    estimatedGasFeeTimeBounds: {},
+    gasEstimateType: exports.GAS_ESTIMATE_TYPES.NONE,
+};
+/**
+ * Controller that retrieves gas fee estimate data and polls for updated data on a set interval
+ */
+class GasFeeController extends base_controller_1.BaseControllerV2 {
+    /**
+     * Creates a GasFeeController instance.
+     *
+     * @param options - The controller options.
+     * @param options.interval - The time in milliseconds to wait between polls.
+     * @param options.messenger - The controller messenger.
+     * @param options.state - The initial state.
+     * @param options.getCurrentNetworkEIP1559Compatibility - Determines whether or not the current
+     * network is EIP-1559 compatible.
+     * @param options.getCurrentNetworkLegacyGasAPICompatibility - Determines whether or not the
+     * current network is compatible with the legacy gas price API.
+     * @param options.getCurrentAccountEIP1559Compatibility - Determines whether or not the current
+     * account is EIP-1559 compatible.
+     * @param options.getChainId - Returns the current chain ID.
+     * @param options.getProvider - Returns a network provider for the current network.
+     * @param options.onNetworkStateChange - A function for registering an event handler for the
+     * network state change event.
+     * @param options.legacyAPIEndpoint - The legacy gas price API URL. This option is primarily for
+     * testing purposes.
+     * @param options.EIP1559APIEndpoint - The EIP-1559 gas price API URL. This option is primarily
+     * for testing purposes.
+     * @param options.clientId - The client ID used to identify to the gas estimation API who is
+     * asking for estimates.
+     */
+    constructor({ interval = 15000, messenger, state, getCurrentNetworkEIP1559Compatibility, getCurrentAccountEIP1559Compatibility, getChainId, getCurrentNetworkLegacyGasAPICompatibility, getProvider, onNetworkStateChange, legacyAPIEndpoint = exports.LEGACY_GAS_PRICES_API_URL, EIP1559APIEndpoint = GAS_FEE_API, clientId, }) {
+        super({
+            name,
+            metadata,
+            messenger,
+            state: Object.assign(Object.assign({}, defaultState), state),
+        });
+        this.intervalDelay = interval;
+        this.pollTokens = new Set();
+        this.getCurrentNetworkEIP1559Compatibility =
+            getCurrentNetworkEIP1559Compatibility;
+        this.getCurrentNetworkLegacyGasAPICompatibility =
+            getCurrentNetworkLegacyGasAPICompatibility;
+        this.getCurrentAccountEIP1559Compatibility =
+            getCurrentAccountEIP1559Compatibility;
+        this.EIP1559APIEndpoint = EIP1559APIEndpoint;
+        this.legacyAPIEndpoint = legacyAPIEndpoint;
+        this.clientId = clientId;
+        if (onNetworkStateChange && getChainId) {
+            const initialProvider = getProvider();
+            this.ethQuery = new eth_query_1.default(initialProvider);
+            this.currentChainId = getChainId();
+            onNetworkStateChange(() => __awaiter(this, void 0, void 0, function* () {
+                const newProvider = getProvider();
+                const newChainId = getChainId();
+                this.ethQuery = new eth_query_1.default(newProvider);
+                if (this.currentChainId !== newChainId) {
+                    this.currentChainId = newChainId;
+                    yield this.resetPolling();
+                }
+            }));
+        }
+        else {
+            const providerConfig = this.messagingSystem.call('NetworkController:getProviderConfig');
+            this.currentChainId = providerConfig.chainId;
+            this.ethQuery = this.messagingSystem.call('NetworkController:getEthQuery');
+            this.messagingSystem.subscribe('NetworkController:providerChange', (provider) => __awaiter(this, void 0, void 0, function* () {
+                this.ethQuery = this.messagingSystem.call('NetworkController:getEthQuery');
+                if (this.currentChainId !== provider.chainId) {
+                    this.currentChainId = provider.chainId;
+                    yield this.resetPolling();
+                }
+            }));
+        }
+    }
+    resetPolling() {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (this.pollTokens.size !== 0) {
+                const tokens = Array.from(this.pollTokens);
+                this.stopPolling();
+                yield this.getGasFeeEstimatesAndStartPolling(tokens[0]);
+                tokens.slice(1).forEach((token) => {
+                    this.pollTokens.add(token);
+                });
+            }
+        });
+    }
+    fetchGasFeeEstimates(options) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return yield this._fetchGasFeeEstimateData(options);
+        });
+    }
+    getGasFeeEstimatesAndStartPolling(pollToken) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const _pollToken = pollToken || (0, uuid_1.v1)();
+            this.pollTokens.add(_pollToken);
+            if (this.pollTokens.size === 1) {
+                yield this._fetchGasFeeEstimateData();
+                this._poll();
+            }
+            return _pollToken;
+        });
+    }
+    /**
+     * Gets and sets gasFeeEstimates in state.
+     *
+     * @param options - The gas fee estimate options.
+     * @param options.shouldUpdateState - Determines whether the state should be updated with the
+     * updated gas estimates.
+     * @returns The gas fee estimates.
+     */
+    _fetchGasFeeEstimateData(options = {}) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const { shouldUpdateState = true } = options;
+            let isEIP1559Compatible;
+            const isLegacyGasAPICompatible = this.getCurrentNetworkLegacyGasAPICompatibility();
+            let chainId;
+            if (typeof this.currentChainId === 'string') {
+                if ((0, ethereumjs_util_1.isHexString)(this.currentChainId)) {
+                    chainId = parseInt(this.currentChainId, 16);
+                }
+                else {
+                    chainId = parseInt(this.currentChainId, 10);
+                }
+            }
+            else {
+                chainId = this.currentChainId;
+            }
+            try {
+                isEIP1559Compatible = yield this.getEIP1559Compatibility();
+            }
+            catch (e) {
+                console.error(e);
+                isEIP1559Compatible = false;
+            }
+            const gasFeeCalculations = yield (0, determineGasFeeCalculations_1.default)({
+                isEIP1559Compatible,
+                isLegacyGasAPICompatible,
+                fetchGasEstimates: gas_util_1.fetchGasEstimates,
+                fetchGasEstimatesUrl: this.EIP1559APIEndpoint.replace('<chain_id>', `${chainId}`),
+                fetchGasEstimatesViaEthFeeHistory: fetchGasEstimatesViaEthFeeHistory_1.default,
+                fetchLegacyGasPriceEstimates: gas_util_1.fetchLegacyGasPriceEstimates,
+                fetchLegacyGasPriceEstimatesUrl: this.legacyAPIEndpoint.replace('<chain_id>', `${chainId}`),
+                fetchEthGasPriceEstimate: gas_util_1.fetchEthGasPriceEstimate,
+                calculateTimeEstimate: gas_util_1.calculateTimeEstimate,
+                clientId: this.clientId,
+                ethQuery: this.ethQuery,
+            });
+            if (shouldUpdateState) {
+                this.update((state) => {
+                    state.gasFeeEstimates = gasFeeCalculations.gasFeeEstimates;
+                    state.estimatedGasFeeTimeBounds =
+                        gasFeeCalculations.estimatedGasFeeTimeBounds;
+                    state.gasEstimateType = gasFeeCalculations.gasEstimateType;
+                });
+            }
+            return gasFeeCalculations;
+        });
+    }
+    /**
+     * Remove the poll token, and stop polling if the set of poll tokens is empty.
+     *
+     * @param pollToken - The poll token to disconnect.
+     */
+    disconnectPoller(pollToken) {
+        this.pollTokens.delete(pollToken);
+        if (this.pollTokens.size === 0) {
+            this.stopPolling();
+        }
+    }
+    stopPolling() {
+        if (this.intervalId) {
+            clearInterval(this.intervalId);
+        }
+        this.pollTokens.clear();
+        this.resetState();
+    }
+    /**
+     * Prepare to discard this controller.
+     *
+     * This stops any active polling.
+     */
+    destroy() {
+        super.destroy();
+        this.stopPolling();
+    }
+    _poll() {
+        if (this.intervalId) {
+            clearInterval(this.intervalId);
+        }
+        this.intervalId = setInterval(() => __awaiter(this, void 0, void 0, function* () {
+            yield (0, controller_utils_1.safelyExecute)(() => this._fetchGasFeeEstimateData());
+        }), this.intervalDelay);
+    }
+    resetState() {
+        this.update(() => {
+            return defaultState;
+        });
+    }
+    getEIP1559Compatibility() {
+        var _a, _b;
+        return __awaiter(this, void 0, void 0, function* () {
+            const currentNetworkIsEIP1559Compatible = yield this.getCurrentNetworkEIP1559Compatibility();
+            const currentAccountIsEIP1559Compatible = (_b = (_a = this.getCurrentAccountEIP1559Compatibility) === null || _a === void 0 ? void 0 : _a.call(this)) !== null && _b !== void 0 ? _b : true;
+            return (currentNetworkIsEIP1559Compatible && currentAccountIsEIP1559Compatible);
+        });
+    }
+    getTimeEstimate(maxPriorityFeePerGas, maxFeePerGas) {
+        if (!this.state.gasFeeEstimates ||
+            this.state.gasEstimateType !== exports.GAS_ESTIMATE_TYPES.FEE_MARKET) {
+            return {};
+        }
+        return (0, gas_util_1.calculateTimeEstimate)(maxPriorityFeePerGas, maxFeePerGas, this.state.gasFeeEstimates);
+    }
+}
+exports.GasFeeController = GasFeeController;
+exports.default = GasFeeController;
+//# sourceMappingURL=GasFeeController.js.map

package/dist/GasFeeController.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"GasFeeController.js","sourceRoot":"","sources":["../src/GasFeeController.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AACA,0DAAiC;AACjC,+BAAoC;AACpC,qDAA8C;AAC9C,+DAGmC;AACnC,iEAA2D;AAQ3D,yCAKoB;AACpB,gGAAwE;AACxE,4GAAoF;AAEpF,MAAM,WAAW,GAAG,wCAAwC,CAAC;AAChD,QAAA,yBAAyB,GAAG,+CAA+C,CAAC;AAoBzF;;;;;GAKG;AACU,QAAA,kBAAkB,GAAG;IAChC,UAAU,EAAE,YAAqC;IACjD,MAAM,EAAE,QAA8B;IACtC,YAAY,EAAE,cAAyC;IACvD,IAAI,EAAE,MAAwB;CAC/B,CAAC;AAiGF,MAAM,QAAQ,GAAG;IACf,eAAe,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,KAAK,EAAE;IACpD,yBAAyB,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,KAAK,EAAE;IAC9D,eAAe,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,KAAK,EAAE;CACrD,CAAC;AA2CF,MAAM,IAAI,GAAG,kBAAkB,CAAC;AAuBhC,MAAM,YAAY,GAAgB;IAChC,eAAe,EAAE,EAAE;IACnB,yBAAyB,EAAE,EAAE;IAC7B,eAAe,EAAE,0BAAkB,CAAC,IAAI;CACzC,CAAC;AAIF;;GAEG;AACH,MAAa,gBAAiB,SAAQ,kCAIrC;IAuBC;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACH,YAAY,EACV,QAAQ,GAAG,KAAK,EAChB,SAAS,EACT,KAAK,EACL,qCAAqC,EACrC,qCAAqC,EACrC,UAAU,EACV,0CAA0C,EAC1C,WAAW,EACX,oBAAoB,EACpB,iBAAiB,GAAG,iCAAyB,EAC7C,kBAAkB,GAAG,WAAW,EAChC,QAAQ,GAcT;QACC,KAAK,CAAC;YACJ,IAAI;YACJ,QAAQ;YACR,SAAS;YACT,KAAK,kCAAO,YAAY,GAAK,KAAK,CAAE;SACrC,CAAC,CAAC;QACH,IAAI,CAAC,aAAa,GAAG,QAAQ,CAAC;QAC9B,IAAI,CAAC,UAAU,GAAG,IAAI,GAAG,EAAE,CAAC;QAC5B,IAAI,CAAC,qCAAqC;YACxC,qCAAqC,CAAC;QAExC,IAAI,CAAC,0CAA0C;YAC7C,0CAA0C,CAAC;QAE7C,IAAI,CAAC,qCAAqC;YACxC,qCAAqC,CAAC;QACxC,IAAI,CAAC,kBAAkB,GAAG,kBAAkB,CAAC;QAC7C,IAAI,CAAC,iBAAiB,GAAG,iBAAiB,CAAC;QAC3C,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;QACzB,IAAI,oBAAoB,IAAI,UAAU,EAAE;YACtC,MAAM,eAAe,GAAG,WAAW,EAAE,CAAC;YACtC,IAAI,CAAC,QAAQ,GAAG,IAAI,mBAAQ,CAAC,eAAe,CAAC,CAAC;YAC9C,IAAI,CAAC,cAAc,GAAG,UAAU,EAAE,CAAC;YACnC,oBAAoB,CAAC,GAAS,EAAE;gBAC9B,MAAM,WAAW,GAAG,WAAW,EAAE,CAAC;gBAClC,MAAM,UAAU,GAAG,UAAU,EAAE,CAAC;gBAChC,IAAI,CAAC,QAAQ,GAAG,IAAI,mBAAQ,CAAC,WAAW,CAAC,CAAC;gBAC1C,IAAI,IAAI,CAAC,cAAc,KAAK,UAAU,EAAE;oBACtC,IAAI,CAAC,cAAc,GAAG,UAAU,CAAC;oBACjC,MAAM,IAAI,CAAC,YAAY,EAAE,CAAC;iBAC3B;YACH,CAAC,CAAA,CAAC,CAAC;SACJ;aAAM;YACL,MAAM,cAAc,GAAG,IAAI,CAAC,eAAe,CAAC,IAAI,CAC9C,qCAAqC,CACtC,CAAC;YACF,IAAI,CAAC,cAAc,GAAG,cAAc,CAAC,OAAO,CAAC;YAC7C,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,eAAe,CAAC,IAAI,CACvC,+BAA+B,CAChC,CAAC;YAEF,IAAI,CAAC,eAAe,CAAC,SAAS,CAC5B,kCAAkC,EAClC,CAAO,QAAQ,EAAE,EAAE;gBACjB,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,eAAe,CAAC,IAAI,CACvC,+BAA+B,CAChC,CAAC;gBAEF,IAAI,IAAI,CAAC,cAAc,KAAK,QAAQ,CAAC,OAAO,EAAE;oBAC5C,IAAI,CAAC,cAAc,GAAG,QAAQ,CAAC,OAAO,CAAC;oBACvC,MAAM,IAAI,CAAC,YAAY,EAAE,CAAC;iBAC3B;YACH,CAAC,CAAA,CACF,CAAC;SACH;IACH,CAAC;IAEK,YAAY;;YAChB,IAAI,IAAI,CAAC,UAAU,CAAC,IAAI,KAAK,CAAC,EAAE;gBAC9B,MAAM,MAAM,GAAG,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;gBAC3C,IAAI,CAAC,WAAW,EAAE,CAAC;gBACnB,MAAM,IAAI,CAAC,iCAAiC,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC;gBACxD,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,EAAE;oBAChC,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;gBAC7B,CAAC,CAAC,CAAC;aACJ;QACH,CAAC;KAAA;IAEK,oBAAoB,CAAC,OAAoC;;YAC7D,OAAO,MAAM,IAAI,CAAC,wBAAwB,CAAC,OAAO,CAAC,CAAC;QACtD,CAAC;KAAA;IAEK,iCAAiC,CACrC,SAA6B;;YAE7B,MAAM,UAAU,GAAG,SAAS,IAAI,IAAA,SAAM,GAAE,CAAC;YAEzC,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;YAEhC,IAAI,IAAI,CAAC,UAAU,CAAC,IAAI,KAAK,CAAC,EAAE;gBAC9B,MAAM,IAAI,CAAC,wBAAwB,EAAE,CAAC;gBACtC,IAAI,CAAC,KAAK,EAAE,CAAC;aACd;YAED,OAAO,UAAU,CAAC;QACpB,CAAC;KAAA;IAED;;;;;;;OAOG;IACG,wBAAwB,CAC5B,UAAsC,EAAE;;YAExC,MAAM,EAAE,iBAAiB,GAAG,IAAI,EAAE,GAAG,OAAO,CAAC;YAC7C,IAAI,mBAAmB,CAAC;YACxB,MAAM,wBAAwB,GAC5B,IAAI,CAAC,0CAA0C,EAAE,CAAC;YAEpD,IAAI,OAAe,CAAC;YACpB,IAAI,OAAO,IAAI,CAAC,cAAc,KAAK,QAAQ,EAAE;gBAC3C,IAAI,IAAA,6BAAW,EAAC,IAAI,CAAC,cAAc,CAAC,EAAE;oBACpC,OAAO,GAAG,QAAQ,CAAC,IAAI,CAAC,cAAc,EAAE,EAAE,CAAC,CAAC;iBAC7C;qBAAM;oBACL,OAAO,GAAG,QAAQ,CAAC,IAAI,CAAC,cAAc,EAAE,EAAE,CAAC,CAAC;iBAC7C;aACF;iBAAM;gBACL,OAAO,GAAG,IAAI,CAAC,cAAc,CAAC;aAC/B;YAED,IAAI;gBACF,mBAAmB,GAAG,MAAM,IAAI,CAAC,uBAAuB,EAAE,CAAC;aAC5D;YAAC,OAAO,CAAC,EAAE;gBACV,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;gBACjB,mBAAmB,GAAG,KAAK,CAAC;aAC7B;YAED,MAAM,kBAAkB,GAAG,MAAM,IAAA,qCAA2B,EAAC;gBAC3D,mBAAmB;gBACnB,wBAAwB;gBACxB,iBAAiB,EAAjB,4BAAiB;gBACjB,oBAAoB,EAAE,IAAI,CAAC,kBAAkB,CAAC,OAAO,CACnD,YAAY,EACZ,GAAG,OAAO,EAAE,CACb;gBACD,iCAAiC,EAAjC,2CAAiC;gBACjC,4BAA4B,EAA5B,uCAA4B;gBAC5B,+BAA+B,EAAE,IAAI,CAAC,iBAAiB,CAAC,OAAO,CAC7D,YAAY,EACZ,GAAG,OAAO,EAAE,CACb;gBACD,wBAAwB,EAAxB,mCAAwB;gBACxB,qBAAqB,EAArB,gCAAqB;gBACrB,QAAQ,EAAE,IAAI,CAAC,QAAQ;gBACvB,QAAQ,EAAE,IAAI,CAAC,QAAQ;aACxB,CAAC,CAAC;YAEH,IAAI,iBAAiB,EAAE;gBACrB,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;oBACpB,KAAK,CAAC,eAAe,GAAG,kBAAkB,CAAC,eAAe,CAAC;oBAC3D,KAAK,CAAC,yBAAyB;wBAC7B,kBAAkB,CAAC,yBAAyB,CAAC;oBAC/C,KAAK,CAAC,eAAe,GAAG,kBAAkB,CAAC,eAAe,CAAC;gBAC7D,CAAC,CAAC,CAAC;aACJ;YAED,OAAO,kBAAkB,CAAC;QAC5B,CAAC;KAAA;IAED;;;;OAIG;IACH,gBAAgB,CAAC,SAAiB;QAChC,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;QAClC,IAAI,IAAI,CAAC,UAAU,CAAC,IAAI,KAAK,CAAC,EAAE;YAC9B,IAAI,CAAC,WAAW,EAAE,CAAC;SACpB;IACH,CAAC;IAED,WAAW;QACT,IAAI,IAAI,CAAC,UAAU,EAAE;YACnB,aAAa,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;SAChC;QACD,IAAI,CAAC,UAAU,CAAC,KAAK,EAAE,CAAC;QACxB,IAAI,CAAC,UAAU,EAAE,CAAC;IACpB,CAAC;IAED;;;;OAIG;IACM,OAAO;QACd,KAAK,CAAC,OAAO,EAAE,CAAC;QAChB,IAAI,CAAC,WAAW,EAAE,CAAC;IACrB,CAAC;IAEO,KAAK;QACX,IAAI,IAAI,CAAC,UAAU,EAAE;YACnB,aAAa,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;SAChC;QAED,IAAI,CAAC,UAAU,GAAG,WAAW,CAAC,GAAS,EAAE;YACvC,MAAM,IAAA,gCAAa,EAAC,GAAG,EAAE,CAAC,IAAI,CAAC,wBAAwB,EAAE,CAAC,CAAC;QAC7D,CAAC,CAAA,EAAE,IAAI,CAAC,aAAa,CAAC,CAAC;IACzB,CAAC;IAEO,UAAU;QAChB,IAAI,CAAC,MAAM,CAAC,GAAG,EAAE;YACf,OAAO,YAAY,CAAC;QACtB,CAAC,CAAC,CAAC;IACL,CAAC;IAEa,uBAAuB;;;YACnC,MAAM,iCAAiC,GACrC,MAAM,IAAI,CAAC,qCAAqC,EAAE,CAAC;YACrD,MAAM,iCAAiC,GACrC,MAAA,MAAA,IAAI,CAAC,qCAAqC,oDAAI,mCAAI,IAAI,CAAC;YAEzD,OAAO,CACL,iCAAiC,IAAI,iCAAiC,CACvE,CAAC;;KACH;IAED,eAAe,CACb,oBAA4B,EAC5B,YAAoB;QAEpB,IACE,CAAC,IAAI,CAAC,KAAK,CAAC,eAAe;YAC3B,IAAI,CAAC,KAAK,CAAC,eAAe,KAAK,0BAAkB,CAAC,UAAU,EAC5D;YACA,OAAO,EAAE,CAAC;SACX;QACD,OAAO,IAAA,gCAAqB,EAC1B,oBAAoB,EACpB,YAAY,EACZ,IAAI,CAAC,KAAK,CAAC,eAAe,CAC3B,CAAC;IACJ,CAAC;CACF;AAhTD,4CAgTC;AAED,kBAAe,gBAAgB,CAAC","sourcesContent":["import type { Patch } from 'immer';\nimport EthQuery from 'eth-query';\nimport { v1 as random } from 'uuid';\nimport { isHexString } from 'ethereumjs-util';\nimport {\n  BaseControllerV2,\n  RestrictedControllerMessenger,\n} from '@metamask/base-controller';\nimport { safelyExecute } from '@metamask/controller-utils';\nimport type {\n  NetworkControllerGetEthQueryAction,\n  NetworkControllerGetProviderConfigAction,\n  NetworkControllerProviderChangeEvent,\n  NetworkController,\n  NetworkState,\n} from '@metamask/network-controller';\nimport {\n  fetchGasEstimates,\n  fetchLegacyGasPriceEstimates,\n  fetchEthGasPriceEstimate,\n  calculateTimeEstimate,\n} from './gas-util';\nimport determineGasFeeCalculations from './determineGasFeeCalculations';\nimport fetchGasEstimatesViaEthFeeHistory from './fetchGasEstimatesViaEthFeeHistory';\n\nconst GAS_FEE_API = 'https://mock-gas-server.herokuapp.com/';\nexport const LEGACY_GAS_PRICES_API_URL = `https://api.metaswap.codefi.network/gasPrices`;\n\nexport type unknownString = 'unknown';\n\n// Fee Market describes the way gas is set after the london hardfork, and was\n// defined by EIP-1559.\nexport type FeeMarketEstimateType = 'fee-market';\n// Legacy describes gasPrice estimates from before london hardfork, when the\n// user is connected to mainnet and are presented with fast/average/slow\n// estimate levels to choose from.\nexport type LegacyEstimateType = 'legacy';\n// EthGasPrice describes a gasPrice estimate received from eth_gasPrice. Post\n// london this value should only be used for legacy type transactions when on\n// networks that support EIP-1559. This type of estimate is the most accurate\n// to display on custom networks that don't support EIP-1559.\nexport type EthGasPriceEstimateType = 'eth_gasPrice';\n// NoEstimate describes the state of the controller before receiving its first\n// estimate.\nexport type NoEstimateType = 'none';\n\n/**\n * Indicates which type of gasEstimate the controller is currently returning.\n * This is useful as a way of asserting that the shape of gasEstimates matches\n * expectations. NONE is a special case indicating that no previous gasEstimate\n * has been fetched.\n */\nexport const GAS_ESTIMATE_TYPES = {\n  FEE_MARKET: 'fee-market' as FeeMarketEstimateType,\n  LEGACY: 'legacy' as LegacyEstimateType,\n  ETH_GASPRICE: 'eth_gasPrice' as EthGasPriceEstimateType,\n  NONE: 'none' as NoEstimateType,\n};\n\nexport type GasEstimateType =\n  | FeeMarketEstimateType\n  | EthGasPriceEstimateType\n  | LegacyEstimateType\n  | NoEstimateType;\n\nexport type EstimatedGasFeeTimeBounds = {\n  lowerTimeBound: number | null;\n  upperTimeBound: number | unknownString;\n};\n\n/**\n * @type EthGasPriceEstimate\n *\n * A single gas price estimate for networks and accounts that don't support EIP-1559\n * This estimate comes from eth_gasPrice but is converted to dec gwei to match other\n * return values\n * @property gasPrice - A GWEI dec string\n */\n\nexport type EthGasPriceEstimate = {\n  gasPrice: string;\n};\n\n/**\n * @type LegacyGasPriceEstimate\n *\n * A set of gas price estimates for networks and accounts that don't support EIP-1559\n * These estimates include low, medium and high all as strings representing gwei in\n * decimal format.\n * @property high - gasPrice, in decimal gwei string format, suggested for fast inclusion\n * @property medium - gasPrice, in decimal gwei string format, suggested for avg inclusion\n * @property low - gasPrice, in decimal gwei string format, suggested for slow inclusion\n */\nexport type LegacyGasPriceEstimate = {\n  high: string;\n  medium: string;\n  low: string;\n};\n\n/**\n * @type Eip1559GasFee\n *\n * Data necessary to provide an estimate of a gas fee with a specific tip\n * @property minWaitTimeEstimate - The fastest the transaction will take, in milliseconds\n * @property maxWaitTimeEstimate - The slowest the transaction will take, in milliseconds\n * @property suggestedMaxPriorityFeePerGas - A suggested \"tip\", a GWEI hex number\n * @property suggestedMaxFeePerGas - A suggested max fee, the most a user will pay. a GWEI hex number\n */\nexport type Eip1559GasFee = {\n  minWaitTimeEstimate: number; // a time duration in milliseconds\n  maxWaitTimeEstimate: number; // a time duration in milliseconds\n  suggestedMaxPriorityFeePerGas: string; // a GWEI decimal number\n  suggestedMaxFeePerGas: string; // a GWEI decimal number\n};\n\n/**\n * @type GasFeeEstimates\n *\n * Data necessary to provide multiple GasFee estimates, and supporting information, to the user\n * @property low - A GasFee for a minimum necessary combination of tip and maxFee\n * @property medium - A GasFee for a recommended combination of tip and maxFee\n * @property high - A GasFee for a high combination of tip and maxFee\n * @property estimatedBaseFee - An estimate of what the base fee will be for the pending/next block. A GWEI dec number\n * @property networkCongestion - A normalized number that can be used to gauge the congestion\n * level of the network, with 0 meaning not congested and 1 meaning extremely congested\n */\nexport type GasFeeEstimates = SourcedGasFeeEstimates | FallbackGasFeeEstimates;\n\ntype SourcedGasFeeEstimates = {\n  low: Eip1559GasFee;\n  medium: Eip1559GasFee;\n  high: Eip1559GasFee;\n  estimatedBaseFee: string;\n  historicalBaseFeeRange: [string, string];\n  baseFeeTrend: 'up' | 'down' | 'level';\n  latestPriorityFeeRange: [string, string];\n  historicalPriorityFeeRange: [string, string];\n  priorityFeeTrend: 'up' | 'down' | 'level';\n  networkCongestion: number;\n};\n\ntype FallbackGasFeeEstimates = {\n  low: Eip1559GasFee;\n  medium: Eip1559GasFee;\n  high: Eip1559GasFee;\n  estimatedBaseFee: string;\n  historicalBaseFeeRange: null;\n  baseFeeTrend: null;\n  latestPriorityFeeRange: null;\n  historicalPriorityFeeRange: null;\n  priorityFeeTrend: null;\n  networkCongestion: null;\n};\n\nconst metadata = {\n  gasFeeEstimates: { persist: true, anonymous: false },\n  estimatedGasFeeTimeBounds: { persist: true, anonymous: false },\n  gasEstimateType: { persist: true, anonymous: false },\n};\n\nexport type GasFeeStateEthGasPrice = {\n  gasFeeEstimates: EthGasPriceEstimate;\n  estimatedGasFeeTimeBounds: Record<string, never>;\n  gasEstimateType: EthGasPriceEstimateType;\n};\n\nexport type GasFeeStateFeeMarket = {\n  gasFeeEstimates: GasFeeEstimates;\n  estimatedGasFeeTimeBounds: EstimatedGasFeeTimeBounds | Record<string, never>;\n  gasEstimateType: FeeMarketEstimateType;\n};\n\nexport type GasFeeStateLegacy = {\n  gasFeeEstimates: LegacyGasPriceEstimate;\n  estimatedGasFeeTimeBounds: Record<string, never>;\n  gasEstimateType: LegacyEstimateType;\n};\n\nexport type GasFeeStateNoEstimates = {\n  gasFeeEstimates: Record<string, never>;\n  estimatedGasFeeTimeBounds: Record<string, never>;\n  gasEstimateType: NoEstimateType;\n};\n\nexport type FetchGasFeeEstimateOptions = {\n  shouldUpdateState?: boolean;\n};\n\n/**\n * @type GasFeeState\n *\n * Gas Fee controller state\n * @property gasFeeEstimates - Gas fee estimate data based on new EIP-1559 properties\n * @property estimatedGasFeeTimeBounds - Estimates representing the minimum and maximum\n */\nexport type GasFeeState =\n  | GasFeeStateEthGasPrice\n  | GasFeeStateFeeMarket\n  | GasFeeStateLegacy\n  | GasFeeStateNoEstimates;\n\nconst name = 'GasFeeController';\n\nexport type GasFeeStateChange = {\n  type: `${typeof name}:stateChange`;\n  payload: [GasFeeState, Patch[]];\n};\n\nexport type GetGasFeeState = {\n  type: `${typeof name}:getState`;\n  handler: () => GasFeeState;\n};\n\ntype GasFeeMessenger = RestrictedControllerMessenger<\n  typeof name,\n  | GetGasFeeState\n  | NetworkControllerGetProviderConfigAction\n  | NetworkControllerGetEthQueryAction,\n  GasFeeStateChange | NetworkControllerProviderChangeEvent,\n  | NetworkControllerGetProviderConfigAction['type']\n  | NetworkControllerGetEthQueryAction['type'],\n  NetworkControllerProviderChangeEvent['type']\n>;\n\nconst defaultState: GasFeeState = {\n  gasFeeEstimates: {},\n  estimatedGasFeeTimeBounds: {},\n  gasEstimateType: GAS_ESTIMATE_TYPES.NONE,\n};\n\nexport type ChainID = `0x${string}` | `${number}` | number;\n\n/**\n * Controller that retrieves gas fee estimate data and polls for updated data on a set interval\n */\nexport class GasFeeController extends BaseControllerV2<\n  typeof name,\n  GasFeeState,\n  GasFeeMessenger\n> {\n  private intervalId?: ReturnType<typeof setTimeout>;\n\n  private intervalDelay;\n\n  private pollTokens: Set<string>;\n\n  private legacyAPIEndpoint: string;\n\n  private EIP1559APIEndpoint: string;\n\n  private getCurrentNetworkEIP1559Compatibility;\n\n  private getCurrentNetworkLegacyGasAPICompatibility;\n\n  private getCurrentAccountEIP1559Compatibility;\n\n  private currentChainId;\n\n  private ethQuery: any;\n\n  private clientId?: string;\n\n  /**\n   * Creates a GasFeeController instance.\n   *\n   * @param options - The controller options.\n   * @param options.interval - The time in milliseconds to wait between polls.\n   * @param options.messenger - The controller messenger.\n   * @param options.state - The initial state.\n   * @param options.getCurrentNetworkEIP1559Compatibility - Determines whether or not the current\n   * network is EIP-1559 compatible.\n   * @param options.getCurrentNetworkLegacyGasAPICompatibility - Determines whether or not the\n   * current network is compatible with the legacy gas price API.\n   * @param options.getCurrentAccountEIP1559Compatibility - Determines whether or not the current\n   * account is EIP-1559 compatible.\n   * @param options.getChainId - Returns the current chain ID.\n   * @param options.getProvider - Returns a network provider for the current network.\n   * @param options.onNetworkStateChange - A function for registering an event handler for the\n   * network state change event.\n   * @param options.legacyAPIEndpoint - The legacy gas price API URL. This option is primarily for\n   * testing purposes.\n   * @param options.EIP1559APIEndpoint - The EIP-1559 gas price API URL. This option is primarily\n   * for testing purposes.\n   * @param options.clientId - The client ID used to identify to the gas estimation API who is\n   * asking for estimates.\n   */\n  constructor({\n    interval = 15000,\n    messenger,\n    state,\n    getCurrentNetworkEIP1559Compatibility,\n    getCurrentAccountEIP1559Compatibility,\n    getChainId,\n    getCurrentNetworkLegacyGasAPICompatibility,\n    getProvider,\n    onNetworkStateChange,\n    legacyAPIEndpoint = LEGACY_GAS_PRICES_API_URL,\n    EIP1559APIEndpoint = GAS_FEE_API,\n    clientId,\n  }: {\n    interval?: number;\n    messenger: GasFeeMessenger;\n    state?: GasFeeState;\n    getCurrentNetworkEIP1559Compatibility: () => Promise<boolean>;\n    getCurrentNetworkLegacyGasAPICompatibility: () => boolean;\n    getCurrentAccountEIP1559Compatibility?: () => boolean;\n    getChainId?: () => `0x${string}` | `${number}` | number;\n    getProvider: () => NetworkController['provider'];\n    onNetworkStateChange?: (listener: (state: NetworkState) => void) => void;\n    legacyAPIEndpoint?: string;\n    EIP1559APIEndpoint?: string;\n    clientId?: string;\n  }) {\n    super({\n      name,\n      metadata,\n      messenger,\n      state: { ...defaultState, ...state },\n    });\n    this.intervalDelay = interval;\n    this.pollTokens = new Set();\n    this.getCurrentNetworkEIP1559Compatibility =\n      getCurrentNetworkEIP1559Compatibility;\n\n    this.getCurrentNetworkLegacyGasAPICompatibility =\n      getCurrentNetworkLegacyGasAPICompatibility;\n\n    this.getCurrentAccountEIP1559Compatibility =\n      getCurrentAccountEIP1559Compatibility;\n    this.EIP1559APIEndpoint = EIP1559APIEndpoint;\n    this.legacyAPIEndpoint = legacyAPIEndpoint;\n    this.clientId = clientId;\n    if (onNetworkStateChange && getChainId) {\n      const initialProvider = getProvider();\n      this.ethQuery = new EthQuery(initialProvider);\n      this.currentChainId = getChainId();\n      onNetworkStateChange(async () => {\n        const newProvider = getProvider();\n        const newChainId = getChainId();\n        this.ethQuery = new EthQuery(newProvider);\n        if (this.currentChainId !== newChainId) {\n          this.currentChainId = newChainId;\n          await this.resetPolling();\n        }\n      });\n    } else {\n      const providerConfig = this.messagingSystem.call(\n        'NetworkController:getProviderConfig',\n      );\n      this.currentChainId = providerConfig.chainId;\n      this.ethQuery = this.messagingSystem.call(\n        'NetworkController:getEthQuery',\n      );\n\n      this.messagingSystem.subscribe(\n        'NetworkController:providerChange',\n        async (provider) => {\n          this.ethQuery = this.messagingSystem.call(\n            'NetworkController:getEthQuery',\n          );\n\n          if (this.currentChainId !== provider.chainId) {\n            this.currentChainId = provider.chainId;\n            await this.resetPolling();\n          }\n        },\n      );\n    }\n  }\n\n  async resetPolling() {\n    if (this.pollTokens.size !== 0) {\n      const tokens = Array.from(this.pollTokens);\n      this.stopPolling();\n      await this.getGasFeeEstimatesAndStartPolling(tokens[0]);\n      tokens.slice(1).forEach((token) => {\n        this.pollTokens.add(token);\n      });\n    }\n  }\n\n  async fetchGasFeeEstimates(options?: FetchGasFeeEstimateOptions) {\n    return await this._fetchGasFeeEstimateData(options);\n  }\n\n  async getGasFeeEstimatesAndStartPolling(\n    pollToken: string | undefined,\n  ): Promise<string> {\n    const _pollToken = pollToken || random();\n\n    this.pollTokens.add(_pollToken);\n\n    if (this.pollTokens.size === 1) {\n      await this._fetchGasFeeEstimateData();\n      this._poll();\n    }\n\n    return _pollToken;\n  }\n\n  /**\n   * Gets and sets gasFeeEstimates in state.\n   *\n   * @param options - The gas fee estimate options.\n   * @param options.shouldUpdateState - Determines whether the state should be updated with the\n   * updated gas estimates.\n   * @returns The gas fee estimates.\n   */\n  async _fetchGasFeeEstimateData(\n    options: FetchGasFeeEstimateOptions = {},\n  ): Promise<GasFeeState> {\n    const { shouldUpdateState = true } = options;\n    let isEIP1559Compatible;\n    const isLegacyGasAPICompatible =\n      this.getCurrentNetworkLegacyGasAPICompatibility();\n\n    let chainId: number;\n    if (typeof this.currentChainId === 'string') {\n      if (isHexString(this.currentChainId)) {\n        chainId = parseInt(this.currentChainId, 16);\n      } else {\n        chainId = parseInt(this.currentChainId, 10);\n      }\n    } else {\n      chainId = this.currentChainId;\n    }\n\n    try {\n      isEIP1559Compatible = await this.getEIP1559Compatibility();\n    } catch (e) {\n      console.error(e);\n      isEIP1559Compatible = false;\n    }\n\n    const gasFeeCalculations = await determineGasFeeCalculations({\n      isEIP1559Compatible,\n      isLegacyGasAPICompatible,\n      fetchGasEstimates,\n      fetchGasEstimatesUrl: this.EIP1559APIEndpoint.replace(\n        '<chain_id>',\n        `${chainId}`,\n      ),\n      fetchGasEstimatesViaEthFeeHistory,\n      fetchLegacyGasPriceEstimates,\n      fetchLegacyGasPriceEstimatesUrl: this.legacyAPIEndpoint.replace(\n        '<chain_id>',\n        `${chainId}`,\n      ),\n      fetchEthGasPriceEstimate,\n      calculateTimeEstimate,\n      clientId: this.clientId,\n      ethQuery: this.ethQuery,\n    });\n\n    if (shouldUpdateState) {\n      this.update((state) => {\n        state.gasFeeEstimates = gasFeeCalculations.gasFeeEstimates;\n        state.estimatedGasFeeTimeBounds =\n          gasFeeCalculations.estimatedGasFeeTimeBounds;\n        state.gasEstimateType = gasFeeCalculations.gasEstimateType;\n      });\n    }\n\n    return gasFeeCalculations;\n  }\n\n  /**\n   * Remove the poll token, and stop polling if the set of poll tokens is empty.\n   *\n   * @param pollToken - The poll token to disconnect.\n   */\n  disconnectPoller(pollToken: string) {\n    this.pollTokens.delete(pollToken);\n    if (this.pollTokens.size === 0) {\n      this.stopPolling();\n    }\n  }\n\n  stopPolling() {\n    if (this.intervalId) {\n      clearInterval(this.intervalId);\n    }\n    this.pollTokens.clear();\n    this.resetState();\n  }\n\n  /**\n   * Prepare to discard this controller.\n   *\n   * This stops any active polling.\n   */\n  override destroy() {\n    super.destroy();\n    this.stopPolling();\n  }\n\n  private _poll() {\n    if (this.intervalId) {\n      clearInterval(this.intervalId);\n    }\n\n    this.intervalId = setInterval(async () => {\n      await safelyExecute(() => this._fetchGasFeeEstimateData());\n    }, this.intervalDelay);\n  }\n\n  private resetState() {\n    this.update(() => {\n      return defaultState;\n    });\n  }\n\n  private async getEIP1559Compatibility() {\n    const currentNetworkIsEIP1559Compatible =\n      await this.getCurrentNetworkEIP1559Compatibility();\n    const currentAccountIsEIP1559Compatible =\n      this.getCurrentAccountEIP1559Compatibility?.() ?? true;\n\n    return (\n      currentNetworkIsEIP1559Compatible && currentAccountIsEIP1559Compatible\n    );\n  }\n\n  getTimeEstimate(\n    maxPriorityFeePerGas: string,\n    maxFeePerGas: string,\n  ): EstimatedGasFeeTimeBounds | Record<string, never> {\n    if (\n      !this.state.gasFeeEstimates ||\n      this.state.gasEstimateType !== GAS_ESTIMATE_TYPES.FEE_MARKET\n    ) {\n      return {};\n    }\n    return calculateTimeEstimate(\n      maxPriorityFeePerGas,\n      maxFeePerGas,\n      this.state.gasFeeEstimates,\n    );\n  }\n}\n\nexport default GasFeeController;\n"]}

package/dist/determineGasFeeCalculations.d.ts

@@ -0,0 +1,40 @@
+import { EstimatedGasFeeTimeBounds, EthGasPriceEstimate, GasFeeEstimates, GasFeeState as GasFeeCalculations, LegacyGasPriceEstimate } from './GasFeeController';
+/**
+ * Obtains a set of max base and priority fee estimates along with time estimates so that we
+ * can present them to users when they are sending transactions or making swaps.
+ *
+ * @param args - The arguments.
+ * @param args.isEIP1559Compatible - Governs whether or not we can use an EIP-1559-only method to
+ * produce estimates.
+ * @param args.isLegacyGasAPICompatible - Governs whether or not we can use a non-EIP-1559 method to
+ * produce estimates (for instance, testnets do not support estimates altogether).
+ * @param args.fetchGasEstimates - A function that fetches gas estimates using an EIP-1559-specific
+ * API.
+ * @param args.fetchGasEstimatesUrl - The URL for the API we can use to obtain EIP-1559-specific
+ * estimates.
+ * @param args.fetchGasEstimatesViaEthFeeHistory - A function that fetches gas estimates using
+ * `eth_feeHistory` (an EIP-1559 feature).
+ * @param args.fetchLegacyGasPriceEstimates - A function that fetches gas estimates using an
+ * non-EIP-1559-specific API.
+ * @param args.fetchLegacyGasPriceEstimatesUrl - The URL for the API we can use to obtain
+ * non-EIP-1559-specific estimates.
+ * @param args.fetchEthGasPriceEstimate - A function that fetches gas estimates using
+ * `eth_gasPrice`.
+ * @param args.calculateTimeEstimate - A function that determine time estimate bounds.
+ * @param args.clientId - An identifier that an API can use to know who is asking for estimates.
+ * @param args.ethQuery - An EthQuery instance we can use to talk to Ethereum directly.
+ * @returns The gas fee calculations.
+ */
+export default function determineGasFeeCalculations({ isEIP1559Compatible, isLegacyGasAPICompatible, fetchGasEstimates, fetchGasEstimatesUrl, fetchGasEstimatesViaEthFeeHistory, fetchLegacyGasPriceEstimates, fetchLegacyGasPriceEstimatesUrl, fetchEthGasPriceEstimate, calculateTimeEstimate, clientId, ethQuery, }: {
+    isEIP1559Compatible: boolean;
+    isLegacyGasAPICompatible: boolean;
+    fetchGasEstimates: (url: string, clientId?: string) => Promise<GasFeeEstimates>;
+    fetchGasEstimatesUrl: string;
+    fetchGasEstimatesViaEthFeeHistory: (ethQuery: any) => Promise<GasFeeEstimates>;
+    fetchLegacyGasPriceEstimates: (url: string, clientId?: string) => Promise<LegacyGasPriceEstimate>;
+    fetchLegacyGasPriceEstimatesUrl: string;
+    fetchEthGasPriceEstimate: (ethQuery: any) => Promise<EthGasPriceEstimate>;
+    calculateTimeEstimate: (maxPriorityFeePerGas: string, maxFeePerGas: string, gasFeeEstimates: GasFeeEstimates) => EstimatedGasFeeTimeBounds;
+    clientId: string | undefined;
+    ethQuery: any;
+}): Promise<GasFeeCalculations>;