@metamask-previews/gas-fee-controller 6.1.1-preview.d32a7cc

package/CHANGELOG.md

@@ -0,0 +1,85 @@
+# 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]
+
+## [6.1.1]
+### Uncategorized
+- Replace `eth-query` ^2.1.2 with `@metamask/eth-query` ^3.0.1 ([#1546](https://github.com/MetaMask/core/pull/1546))
+
+## [6.1.0]
+### Changed
+- Update `@metamask/utils` to `^6.2.0` ([#1514](https://github.com/MetaMask/core/pull/1514))
+- Remove unnecessary `babel-runtime` dependencies ([#1504](https://github.com/MetaMask/core/pull/1504))
+
+## [6.0.1]
+### Changed
+- Bump dependency on `controller-utils` ([#1447](https://github.com/MetaMask/core/pull/1447))
+  - The new version of `controller-utils` adds `eth-query` to the list of dependencies. This dependency was added to improve internal types for `gas-fee-controller`. This has no impact on users of the package.
+
+## [6.0.0]
+### Changed
+- **BREAKING:** Bump to Node 16 ([#1262](https://github.com/MetaMask/core/pull/1262))
+- **BREAKING:** The `getChainId` constructor parameter now expects a `Hex` return type rather than a decimal string ([#1367](https://github.com/MetaMask/core/pull/1367))
+- Add `@metamask/utils` dependency
+- **BREAKING:** The gas fee controller messenger now requires the `NetworkController:stateChange` event instead of the `NetworkController:providerConfigChange` event ([#1329](https://github.com/MetaMask/core/pull/1329))
+  - This does not apply if `onNetworkStateChange` and `getChainId` are provided to the constructor
+- **BREAKING:** The constructor parameter `onNetworkStateChange` now expects event handlers to be passed the full network state ([#1329](https://github.com/MetaMask/core/pull/1329))
+  - The type of the `onNetworkStateChange` parameter already expected the state to be provided, but it wasn't used before now
+- **BREAKING:** Update `@metamask/network-controller` dependency and peer dependency
+
+## [5.0.0]
+### Changed
+- **BREAKING**: peerDeps: @metamask/network-controller@6.0.0->8.0.0 ([#1196](https://github.com/MetaMask/core/pull/1196))
+
+## [4.0.1]
+### Changed
+- Adjust types to align with new version of `NetworkController` ([#1091](https://github.com/MetaMask/core/pull/1091))
+
+## [4.0.0]
+### Changed
+- **BREAKING:** Make the EIP-1559 endpoint a required argument ([#1083](https://github.com/MetaMask/core/pull/1083))
+
+### Removed
+- **BREAKING:** Remove `isomorphic-fetch` ([#1106](https://github.com/MetaMask/controllers/pull/1106))
+  - Consumers must now import `isomorphic-fetch` or another polyfill themselves if they are running in an environment without `fetch`
+
+## [3.0.0]
+### Changed
+- **BREAKING:** Update `@metamask/network-controller` peer dependency to v3 ([#1041](https://github.com/MetaMask/controllers/pull/1041))
+- Rename this repository to `core` ([#1031](https://github.com/MetaMask/controllers/pull/1031))
+- Update `@metamask/controller-utils` package ([#1041](https://github.com/MetaMask/controllers/pull/1041))
+
+## [2.0.1]
+### Fixed
+- This package will now warn if a required package is not present ([#1003](https://github.com/MetaMask/core/pull/1003))
+
+## [2.0.0]
+### Changed
+- **BREAKING:** Bump `@metamask/network-controller` to 2.0.0 ([#995](https://github.com/MetaMask/core/pull/995))
+  - GasFeeController now expects NetworkController to respond to the `NetworkController:providerChangeConfig` event (previously named `NetworkController:providerChange`). If you are depending directly on `@metamask/network-controller`, you should update your version to at least 2.0.0 as well.
+- Relax dependencies on `@metamask/base-controller`, `@metamask/controller-utils`, and `@metamask/network-controller` (use `^` instead of `~`) ([#998](https://github.com/MetaMask/core/pull/998))
+
+## [1.0.0]
+### Added
+- Initial release
+  - As a result of converting our shared controllers repo into a monorepo ([#831](https://github.com/MetaMask/core/pull/831)), we've created this package from select parts of [`@metamask/controllers` v33.0.0](https://github.com/MetaMask/core/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/core/compare/@metamask/gas-fee-controller@6.1.1...HEAD
+[6.1.1]: https://github.com/MetaMask/core/compare/@metamask/gas-fee-controller@6.1.0...@metamask/gas-fee-controller@6.1.1
+[6.1.0]: https://github.com/MetaMask/core/compare/@metamask/gas-fee-controller@6.0.1...@metamask/gas-fee-controller@6.1.0
+[6.0.1]: https://github.com/MetaMask/core/compare/@metamask/gas-fee-controller@6.0.0...@metamask/gas-fee-controller@6.0.1
+[6.0.0]: https://github.com/MetaMask/core/compare/@metamask/gas-fee-controller@5.0.0...@metamask/gas-fee-controller@6.0.0
+[5.0.0]: https://github.com/MetaMask/core/compare/@metamask/gas-fee-controller@4.0.1...@metamask/gas-fee-controller@5.0.0
+[4.0.1]: https://github.com/MetaMask/core/compare/@metamask/gas-fee-controller@4.0.0...@metamask/gas-fee-controller@4.0.1
+[4.0.0]: https://github.com/MetaMask/core/compare/@metamask/gas-fee-controller@3.0.0...@metamask/gas-fee-controller@4.0.0
+[3.0.0]: https://github.com/MetaMask/core/compare/@metamask/gas-fee-controller@2.0.1...@metamask/gas-fee-controller@3.0.0
+[2.0.1]: https://github.com/MetaMask/core/compare/@metamask/gas-fee-controller@2.0.0...@metamask/gas-fee-controller@2.0.1
+[2.0.0]: https://github.com/MetaMask/core/compare/@metamask/gas-fee-controller@1.0.0...@metamask/gas-fee-controller@2.0.0
+[1.0.0]: https://github.com/MetaMask/core/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/core#readme).

package/dist/GasFeeController.d.ts

@@ -0,0 +1,231 @@
+import type { RestrictedControllerMessenger } from '@metamask/base-controller';
+import { BaseControllerV2 } from '@metamask/base-controller';
+import type { NetworkControllerGetStateAction, NetworkControllerStateChangeEvent, NetworkState, ProviderProxy } from '@metamask/network-controller';
+import type { Hex } from '@metamask/utils';
+import type { Patch } from 'immer';
+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 | NetworkControllerGetStateAction, GasFeeStateChange | NetworkControllerStateChangeEvent, NetworkControllerGetStateAction['type'], NetworkControllerStateChangeEvent['type']>;
+/**
+ * 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;
+    private intervalId?;
+    private readonly intervalDelay;
+    private readonly pollTokens;
+    private readonly legacyAPIEndpoint;
+    private readonly EIP1559APIEndpoint;
+    private readonly getCurrentNetworkEIP1559Compatibility;
+    private readonly getCurrentNetworkLegacyGasAPICompatibility;
+    private readonly getCurrentAccountEIP1559Compatibility;
+    private currentChainId;
+    private ethQuery?;
+    private readonly 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.
+     * @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?: () => Hex;
+        getProvider: () => ProviderProxy;
+        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;
+//# sourceMappingURL=GasFeeController.d.ts.map

package/dist/GasFeeController.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"GasFeeController.d.ts","sourceRoot":"","sources":["../src/GasFeeController.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,6BAA6B,EAAE,MAAM,2BAA2B,CAAC;AAC/E,OAAO,EAAE,gBAAgB,EAAE,MAAM,2BAA2B,CAAC;AAG7D,OAAO,KAAK,EACV,+BAA+B,EAC/B,iCAAiC,EACjC,YAAY,EACZ,aAAa,EACd,MAAM,8BAA8B,CAAC;AACtC,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,iBAAiB,CAAC;AAC3C,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,OAAO,CAAC;AAYnC,eAAO,MAAM,yBAAyB,kDAAkD,CAAC;AAEzF,oBAAY,aAAa,GAAG,SAAS,CAAC;AAItC,oBAAY,qBAAqB,GAAG,YAAY,CAAC;AAIjD,oBAAY,kBAAkB,GAAG,QAAQ,CAAC;AAK1C,oBAAY,uBAAuB,GAAG,cAAc,CAAC;AAGrD,oBAAY,cAAc,GAAG,MAAM,CAAC;AAEpC;;;;;GAKG;AACH,eAAO,MAAM,kBAAkB;;;;;CAK9B,CAAC;AAEF,oBAAY,eAAe,GACvB,qBAAqB,GACrB,uBAAuB,GACvB,kBAAkB,GAClB,cAAc,CAAC;AAEnB,oBAAY,yBAAyB,GAAG;IACtC,cAAc,EAAE,MAAM,GAAG,IAAI,CAAC;IAC9B,cAAc,EAAE,MAAM,GAAG,aAAa,CAAC;CACxC,CAAC;AAEF;;;;;;;GAOG;AAEH,oBAAY,mBAAmB,GAAG;IAChC,QAAQ,EAAE,MAAM,CAAC;CAClB,CAAC;AAEF;;;;;;;;;GASG;AACH,oBAAY,sBAAsB,GAAG;IACnC,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,CAAC;IACf,GAAG,EAAE,MAAM,CAAC;CACb,CAAC;AAEF;;;;;;;;GAQG;AACH,oBAAY,aAAa,GAAG;IAC1B,mBAAmB,EAAE,MAAM,CAAC;IAC5B,mBAAmB,EAAE,MAAM,CAAC;IAC5B,6BAA6B,EAAE,MAAM,CAAC;IACtC,qBAAqB,EAAE,MAAM,CAAC;CAC/B,CAAC;AAEF;;;;;;;;;;GAUG;AACH,oBAAY,eAAe,GAAG,sBAAsB,GAAG,uBAAuB,CAAC;AAE/E,aAAK,sBAAsB,GAAG;IAC5B,GAAG,EAAE,aAAa,CAAC;IACnB,MAAM,EAAE,aAAa,CAAC;IACtB,IAAI,EAAE,aAAa,CAAC;IACpB,gBAAgB,EAAE,MAAM,CAAC;IACzB,sBAAsB,EAAE,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACzC,YAAY,EAAE,IAAI,GAAG,MAAM,GAAG,OAAO,CAAC;IACtC,sBAAsB,EAAE,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACzC,0BAA0B,EAAE,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAC7C,gBAAgB,EAAE,IAAI,GAAG,MAAM,GAAG,OAAO,CAAC;IAC1C,iBAAiB,EAAE,MAAM,CAAC;CAC3B,CAAC;AAEF,aAAK,uBAAuB,GAAG;IAC7B,GAAG,EAAE,aAAa,CAAC;IACnB,MAAM,EAAE,aAAa,CAAC;IACtB,IAAI,EAAE,aAAa,CAAC;IACpB,gBAAgB,EAAE,MAAM,CAAC;IACzB,sBAAsB,EAAE,IAAI,CAAC;IAC7B,YAAY,EAAE,IAAI,CAAC;IACnB,sBAAsB,EAAE,IAAI,CAAC;IAC7B,0BAA0B,EAAE,IAAI,CAAC;IACjC,gBAAgB,EAAE,IAAI,CAAC;IACvB,iBAAiB,EAAE,IAAI,CAAC;CACzB,CAAC;AAQF,oBAAY,sBAAsB,GAAG;IACnC,eAAe,EAAE,mBAAmB,CAAC;IACrC,yBAAyB,EAAE,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;IACjD,eAAe,EAAE,uBAAuB,CAAC;CAC1C,CAAC;AAEF,oBAAY,oBAAoB,GAAG;IACjC,eAAe,EAAE,eAAe,CAAC;IACjC,yBAAyB,EAAE,yBAAyB,GAAG,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;IAC7E,eAAe,EAAE,qBAAqB,CAAC;CACxC,CAAC;AAEF,oBAAY,iBAAiB,GAAG;IAC9B,eAAe,EAAE,sBAAsB,CAAC;IACxC,yBAAyB,EAAE,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;IACjD,eAAe,EAAE,kBAAkB,CAAC;CACrC,CAAC;AAEF,oBAAY,sBAAsB,GAAG;IACnC,eAAe,EAAE,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;IACvC,yBAAyB,EAAE,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;IACjD,eAAe,EAAE,cAAc,CAAC;CACjC,CAAC;AAEF,oBAAY,0BAA0B,GAAG;IACvC,iBAAiB,CAAC,EAAE,OAAO,CAAC;CAC7B,CAAC;AAEF;;;;;;GAMG;AACH,oBAAY,WAAW,GACnB,sBAAsB,GACtB,oBAAoB,GACpB,iBAAiB,GACjB,sBAAsB,CAAC;AAE3B,QAAA,MAAM,IAAI,qBAAqB,CAAC;AAEhC,oBAAY,iBAAiB,GAAG;IAC9B,IAAI,EAAE,GAAG,OAAO,IAAI,cAAc,CAAC;IACnC,OAAO,EAAE,CAAC,WAAW,EAAE,KAAK,EAAE,CAAC,CAAC;CACjC,CAAC;AAEF,oBAAY,cAAc,GAAG;IAC3B,IAAI,EAAE,GAAG,OAAO,IAAI,WAAW,CAAC;IAChC,OAAO,EAAE,MAAM,WAAW,CAAC;CAC5B,CAAC;AAEF,aAAK,eAAe,GAAG,6BAA6B,CAClD,OAAO,IAAI,EACX,cAAc,GAAG,+BAA+B,EAChD,iBAAiB,GAAG,iCAAiC,EACrD,+BAA+B,CAAC,MAAM,CAAC,EACvC,iCAAiC,CAAC,MAAM,CAAC,CAC1C,CAAC;AAQF;;GAEG;AACH,qBAAa,gBAAiB,SAAQ,gBAAgB,CACpD,OAAO,IAAI,EACX,WAAW,EACX,eAAe,CAChB;;IACC,OAAO,CAAC,UAAU,CAAC,CAAgC;IAEnD,OAAO,CAAC,QAAQ,CAAC,aAAa,CAAC;IAE/B,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAc;IAEzC,OAAO,CAAC,QAAQ,CAAC,iBAAiB,CAAS;IAE3C,OAAO,CAAC,QAAQ,CAAC,kBAAkB,CAAS;IAE5C,OAAO,CAAC,QAAQ,CAAC,qCAAqC,CAAC;IAEvD,OAAO,CAAC,QAAQ,CAAC,0CAA0C,CAAC;IAE5D,OAAO,CAAC,QAAQ,CAAC,qCAAqC,CAAC;IAEvD,OAAO,CAAC,cAAc,CAAC;IAEvB,OAAO,CAAC,QAAQ,CAAC,CAAW;IAE5B,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAS;IAInC;;;;;;;;;;;;;;;;;;;;;;OAsBG;gBACS,EACV,QAAgB,EAChB,SAAS,EACT,KAAK,EACL,qCAAqC,EACrC,qCAAqC,EACrC,UAAU,EACV,0CAA0C,EAC1C,WAAW,EACX,oBAAoB,EACpB,iBAA6C,EAC7C,kBAAkB,EAClB,QAAQ,GACT,EAAE;QACD,QAAQ,CAAC,EAAE,MAAM,CAAC;QAClB,SAAS,EAAE,eAAe,CAAC;QAC3B,KAAK,CAAC,EAAE,WAAW,CAAC;QACpB,qCAAqC,EAAE,MAAM,OAAO,CAAC,OAAO,CAAC,CAAC;QAC9D,0CAA0C,EAAE,MAAM,OAAO,CAAC;QAC1D,qCAAqC,CAAC,EAAE,MAAM,OAAO,CAAC;QACtD,UAAU,CAAC,EAAE,MAAM,GAAG,CAAC;QACvB,WAAW,EAAE,MAAM,aAAa,CAAC;QACjC,oBAAoB,CAAC,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE,YAAY,KAAK,IAAI,KAAK,IAAI,CAAC;QACzE,iBAAiB,CAAC,EAAE,MAAM,CAAC;QAC3B,kBAAkB,EAAE,MAAM,CAAC;QAC3B,QAAQ,CAAC,EAAE,MAAM,CAAC;KACnB;IAwCK,YAAY;IAWZ,oBAAoB,CAAC,OAAO,CAAC,EAAE,0BAA0B;IAIzD,iCAAiC,CACrC,SAAS,EAAE,MAAM,GAAG,SAAS,GAC5B,OAAO,CAAC,MAAM,CAAC;IAalB;;;;;;;OAOG;IACG,wBAAwB,CAC5B,OAAO,GAAE,0BAA+B,GACvC,OAAO,CAAC,WAAW,CAAC;IA+CvB;;;;OAIG;IACH,gBAAgB,CAAC,SAAS,EAAE,MAAM;IAOlC,WAAW;IAQX;;;;OAIG;IACM,OAAO;IAKhB,OAAO,CAAC,KAAK;IAUb,OAAO,CAAC,UAAU;YAMJ,uBAAuB;IAWrC,eAAe,CACb,oBAAoB,EAAE,MAAM,EAC5B,YAAY,EAAE,MAAM,GACnB,yBAAyB,GAAG,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC;CAwBrD;AAED,eAAe,gBAAgB,CAAC"}

package/dist/GasFeeController.js

@@ -0,0 +1,262 @@
+"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 __classPrivateFieldSet = (this && this.__classPrivateFieldSet) || function (receiver, state, value, kind, f) {
+    if (kind === "m") throw new TypeError("Private method is not writable");
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a setter");
+    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot write private member to an object whose class did not declare it");
+    return (kind === "a" ? f.call(receiver, value) : f ? f.value = value : state.set(receiver, value)), value;
+};
+var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
+    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
+    return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+var _GasFeeController_instances, _GasFeeController_getProvider, _GasFeeController_onNetworkControllerStateChange;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.GasFeeController = exports.GAS_ESTIMATE_TYPES = exports.LEGACY_GAS_PRICES_API_URL = void 0;
+const base_controller_1 = require("@metamask/base-controller");
+const controller_utils_1 = require("@metamask/controller-utils");
+const eth_query_1 = __importDefault(require("@metamask/eth-query"));
+const uuid_1 = require("uuid");
+const determineGasFeeCalculations_1 = __importDefault(require("./determineGasFeeCalculations"));
+const fetchGasEstimatesViaEthFeeHistory_1 = __importDefault(require("./fetchGasEstimatesViaEthFeeHistory"));
+const gas_util_1 = require("./gas-util");
+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.
+     * @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, clientId, }) {
+        super({
+            name,
+            metadata,
+            messenger,
+            state: Object.assign(Object.assign({}, defaultState), state),
+        });
+        _GasFeeController_instances.add(this);
+        _GasFeeController_getProvider.set(this, void 0);
+        this.intervalDelay = interval;
+        this.pollTokens = new Set();
+        this.getCurrentNetworkEIP1559Compatibility =
+            getCurrentNetworkEIP1559Compatibility;
+        this.getCurrentNetworkLegacyGasAPICompatibility =
+            getCurrentNetworkLegacyGasAPICompatibility;
+        this.getCurrentAccountEIP1559Compatibility =
+            getCurrentAccountEIP1559Compatibility;
+        __classPrivateFieldSet(this, _GasFeeController_getProvider, getProvider, "f");
+        this.EIP1559APIEndpoint = EIP1559APIEndpoint;
+        this.legacyAPIEndpoint = legacyAPIEndpoint;
+        this.clientId = clientId;
+        this.ethQuery = new eth_query_1.default(__classPrivateFieldGet(this, _GasFeeController_getProvider, "f").call(this));
+        if (onNetworkStateChange && getChainId) {
+            this.currentChainId = getChainId();
+            onNetworkStateChange((networkControllerState) => __awaiter(this, void 0, void 0, function* () {
+                yield __classPrivateFieldGet(this, _GasFeeController_instances, "m", _GasFeeController_onNetworkControllerStateChange).call(this, networkControllerState);
+            }));
+        }
+        else {
+            this.currentChainId = this.messagingSystem.call('NetworkController:getState').providerConfig.chainId;
+            this.messagingSystem.subscribe('NetworkController:stateChange', (networkControllerState) => __awaiter(this, void 0, void 0, function* () {
+                yield __classPrivateFieldGet(this, _GasFeeController_instances, "m", _GasFeeController_onNetworkControllerStateChange).call(this, networkControllerState);
+            }));
+        }
+    }
+    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();
+            const decimalChainId = (0, controller_utils_1.convertHexToDecimal)(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>', `${decimalChainId}`),
+                fetchGasEstimatesViaEthFeeHistory: fetchGasEstimatesViaEthFeeHistory_1.default,
+                fetchLegacyGasPriceEstimates: gas_util_1.fetchLegacyGasPriceEstimates,
+                fetchLegacyGasPriceEstimatesUrl: this.legacyAPIEndpoint.replace('<chain_id>', `${decimalChainId}`),
+                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;
+_GasFeeController_getProvider = new WeakMap(), _GasFeeController_instances = new WeakSet(), _GasFeeController_onNetworkControllerStateChange = function _GasFeeController_onNetworkControllerStateChange(networkControllerState) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const newChainId = networkControllerState.providerConfig.chainId;
+        if (newChainId !== this.currentChainId) {
+            this.ethQuery = new eth_query_1.default(__classPrivateFieldGet(this, _GasFeeController_getProvider, "f").call(this));
+            yield this.resetPolling();
+            this.currentChainId = newChainId;
+        }
+    });
+};
+exports.default = GasFeeController;
+//# sourceMappingURL=GasFeeController.js.map