@metamask/gas-fee-controller 1.0.0

package/dist/fetchGasEstimatesViaEthFeeHistory/medianOf.d.ts

@@ -0,0 +1,10 @@
+/// <reference types="bn.js" />
+import { BN } from 'ethereumjs-util';
+/**
+ * Finds the median among a list of numbers. Note that this is different from the implementation
+ * in the MetaSwap API, as we want to hold to using BN as much as possible.
+ *
+ * @param numbers - A list of numbers, as BNs. Will be sorted automatically if unsorted.
+ * @returns The median number.
+ */
+export default function medianOf(numbers: BN[]): BN;

package/dist/fetchGasEstimatesViaEthFeeHistory/medianOf.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+/**
+ * Finds the median among a list of numbers. Note that this is different from the implementation
+ * in the MetaSwap API, as we want to hold to using BN as much as possible.
+ *
+ * @param numbers - A list of numbers, as BNs. Will be sorted automatically if unsorted.
+ * @returns The median number.
+ */
+function medianOf(numbers) {
+    const sortedNumbers = numbers.slice().sort((a, b) => a.cmp(b));
+    const len = sortedNumbers.length;
+    const index = Math.floor((len - 1) / 2);
+    return sortedNumbers[index];
+}
+exports.default = medianOf;
+//# sourceMappingURL=medianOf.js.map

package/dist/fetchGasEstimatesViaEthFeeHistory/medianOf.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"medianOf.js","sourceRoot":"","sources":["../../src/fetchGasEstimatesViaEthFeeHistory/medianOf.ts"],"names":[],"mappings":";;AAEA;;;;;;GAMG;AACH,SAAwB,QAAQ,CAAC,OAAa;IAC5C,MAAM,aAAa,GAAG,OAAO,CAAC,KAAK,EAAE,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;IAC/D,MAAM,GAAG,GAAG,aAAa,CAAC,MAAM,CAAC;IACjC,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,GAAG,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;IACxC,OAAO,aAAa,CAAC,KAAK,CAAC,CAAC;AAC9B,CAAC;AALD,2BAKC","sourcesContent":["import { BN } from 'ethereumjs-util';\n\n/**\n * Finds the median among a list of numbers. Note that this is different from the implementation\n * in the MetaSwap API, as we want to hold to using BN as much as possible.\n *\n * @param numbers - A list of numbers, as BNs. Will be sorted automatically if unsorted.\n * @returns The median number.\n */\nexport default function medianOf(numbers: BN[]): BN {\n  const sortedNumbers = numbers.slice().sort((a, b) => a.cmp(b));\n  const len = sortedNumbers.length;\n  const index = Math.floor((len - 1) / 2);\n  return sortedNumbers[index];\n}\n"]}

package/dist/fetchGasEstimatesViaEthFeeHistory/types.d.ts

@@ -0,0 +1,10 @@
+/// <reference types="bn.js" />
+import { BN } from 'ethereumjs-util';
+export declare type EthBlock = {
+    number: BN;
+    baseFeePerGas: BN;
+};
+export declare type EthQuery = {
+    getBlockByNumber: (blockNumber: BN | 'latest' | 'earliest' | 'pending') => Promise<EthBlock>;
+};
+export declare type FeeRange = [string, string];

package/dist/fetchGasEstimatesViaEthFeeHistory/types.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=types.js.map

package/dist/fetchGasEstimatesViaEthFeeHistory/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/fetchGasEstimatesViaEthFeeHistory/types.ts"],"names":[],"mappings":"","sourcesContent":["import { BN } from 'ethereumjs-util';\n\nexport type EthBlock = {\n  number: BN;\n  baseFeePerGas: BN;\n};\n\nexport type EthQuery = {\n  getBlockByNumber: (\n    blockNumber: BN | 'latest' | 'earliest' | 'pending',\n  ) => Promise<EthBlock>;\n};\n\nexport type FeeRange = [string, string];\n"]}

package/dist/fetchGasEstimatesViaEthFeeHistory.d.ts

@@ -0,0 +1,21 @@
+import { GasFeeEstimates } from './GasFeeController';
+import { EthQuery } from './fetchGasEstimatesViaEthFeeHistory/types';
+/**
+ * Generates gas fee estimates based on gas fees that have been used in the recent past so that
+ * those estimates can be displayed to users.
+ *
+ * To produce the estimates, the last 5 blocks are read from the network, and for each block, the
+ * priority fees for transactions at the 10th, 20th, and 30th percentiles are also read (here
+ * "percentile" signifies the level at which those transactions contribute to the overall gas used
+ * for the block, where higher percentiles correspond to higher fees). This information is used to
+ * calculate reasonable max priority and max fees for three different priority levels (higher
+ * priority = higher fee).
+ *
+ * Note that properties are returned for other data that are normally obtained via the API; however,
+ * to prevent extra requests to Infura, these properties are empty.
+ *
+ * @param ethQuery - An EthQuery instance.
+ * @returns Base and priority fee estimates, categorized by priority level, as well as an estimate
+ * for the next block's base fee.
+ */
+export default function fetchGasEstimatesViaEthFeeHistory(ethQuery: EthQuery): Promise<GasFeeEstimates>;

package/dist/fetchGasEstimatesViaEthFeeHistory.js

@@ -0,0 +1,53 @@
+"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 });
+const ethjs_unit_1 = require("ethjs-unit");
+const controller_utils_1 = require("@metamask/controller-utils");
+const fetchBlockFeeHistory_1 = __importDefault(require("./fetchBlockFeeHistory"));
+const fetchLatestBlock_1 = __importDefault(require("./fetchGasEstimatesViaEthFeeHistory/fetchLatestBlock"));
+const calculateGasFeeEstimatesForPriorityLevels_1 = __importDefault(require("./fetchGasEstimatesViaEthFeeHistory/calculateGasFeeEstimatesForPriorityLevels"));
+/**
+ * Generates gas fee estimates based on gas fees that have been used in the recent past so that
+ * those estimates can be displayed to users.
+ *
+ * To produce the estimates, the last 5 blocks are read from the network, and for each block, the
+ * priority fees for transactions at the 10th, 20th, and 30th percentiles are also read (here
+ * "percentile" signifies the level at which those transactions contribute to the overall gas used
+ * for the block, where higher percentiles correspond to higher fees). This information is used to
+ * calculate reasonable max priority and max fees for three different priority levels (higher
+ * priority = higher fee).
+ *
+ * Note that properties are returned for other data that are normally obtained via the API; however,
+ * to prevent extra requests to Infura, these properties are empty.
+ *
+ * @param ethQuery - An EthQuery instance.
+ * @returns Base and priority fee estimates, categorized by priority level, as well as an estimate
+ * for the next block's base fee.
+ */
+function fetchGasEstimatesViaEthFeeHistory(ethQuery) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const latestBlock = yield (0, fetchLatestBlock_1.default)(ethQuery);
+        const blocks = yield (0, fetchBlockFeeHistory_1.default)({
+            ethQuery,
+            endBlock: latestBlock.number,
+            numberOfBlocks: 5,
+            percentiles: [10, 20, 30],
+        });
+        const estimatedBaseFee = (0, ethjs_unit_1.fromWei)(latestBlock.baseFeePerGas, controller_utils_1.GWEI);
+        const levelSpecificEstimates = (0, calculateGasFeeEstimatesForPriorityLevels_1.default)(blocks);
+        return Object.assign(Object.assign({}, levelSpecificEstimates), { estimatedBaseFee, historicalBaseFeeRange: null, baseFeeTrend: null, latestPriorityFeeRange: null, historicalPriorityFeeRange: null, priorityFeeTrend: null, networkCongestion: null });
+    });
+}
+exports.default = fetchGasEstimatesViaEthFeeHistory;
+//# sourceMappingURL=fetchGasEstimatesViaEthFeeHistory.js.map

package/dist/fetchGasEstimatesViaEthFeeHistory.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"fetchGasEstimatesViaEthFeeHistory.js","sourceRoot":"","sources":["../src/fetchGasEstimatesViaEthFeeHistory.ts"],"names":[],"mappings":";;;;;;;;;;;;;;AAAA,2CAAqC;AACrC,iEAAkD;AAGlD,kFAA0D;AAC1D,4GAAoF;AACpF,8JAAsI;AAEtI;;;;;;;;;;;;;;;;;GAiBG;AACH,SAA8B,iCAAiC,CAC7D,QAAkB;;QAElB,MAAM,WAAW,GAAG,MAAM,IAAA,0BAAgB,EAAC,QAAQ,CAAC,CAAC;QACrD,MAAM,MAAM,GAAG,MAAM,IAAA,8BAAoB,EAAC;YACxC,QAAQ;YACR,QAAQ,EAAE,WAAW,CAAC,MAAM;YAC5B,cAAc,EAAE,CAAC;YACjB,WAAW,EAAE,CAAC,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC;SAC1B,CAAC,CAAC;QACH,MAAM,gBAAgB,GAAG,IAAA,oBAAO,EAAC,WAAW,CAAC,aAAa,EAAE,uBAAI,CAAC,CAAC;QAElE,MAAM,sBAAsB,GAC1B,IAAA,mDAAyC,EAAC,MAAM,CAAC,CAAC;QAEpD,uCACK,sBAAsB,KACzB,gBAAgB,EAChB,sBAAsB,EAAE,IAAI,EAC5B,YAAY,EAAE,IAAI,EAClB,sBAAsB,EAAE,IAAI,EAC5B,0BAA0B,EAAE,IAAI,EAChC,gBAAgB,EAAE,IAAI,EACtB,iBAAiB,EAAE,IAAI,IACvB;IACJ,CAAC;CAAA;AAzBD,oDAyBC","sourcesContent":["import { fromWei } from 'ethjs-unit';\nimport { GWEI } from '@metamask/controller-utils';\nimport { GasFeeEstimates } from './GasFeeController';\nimport { EthQuery } from './fetchGasEstimatesViaEthFeeHistory/types';\nimport fetchBlockFeeHistory from './fetchBlockFeeHistory';\nimport fetchLatestBlock from './fetchGasEstimatesViaEthFeeHistory/fetchLatestBlock';\nimport calculateGasFeeEstimatesForPriorityLevels from './fetchGasEstimatesViaEthFeeHistory/calculateGasFeeEstimatesForPriorityLevels';\n\n/**\n * Generates gas fee estimates based on gas fees that have been used in the recent past so that\n * those estimates can be displayed to users.\n *\n * To produce the estimates, the last 5 blocks are read from the network, and for each block, the\n * priority fees for transactions at the 10th, 20th, and 30th percentiles are also read (here\n * \"percentile\" signifies the level at which those transactions contribute to the overall gas used\n * for the block, where higher percentiles correspond to higher fees). This information is used to\n * calculate reasonable max priority and max fees for three different priority levels (higher\n * priority = higher fee).\n *\n * Note that properties are returned for other data that are normally obtained via the API; however,\n * to prevent extra requests to Infura, these properties are empty.\n *\n * @param ethQuery - An EthQuery instance.\n * @returns Base and priority fee estimates, categorized by priority level, as well as an estimate\n * for the next block's base fee.\n */\nexport default async function fetchGasEstimatesViaEthFeeHistory(\n  ethQuery: EthQuery,\n): Promise<GasFeeEstimates> {\n  const latestBlock = await fetchLatestBlock(ethQuery);\n  const blocks = await fetchBlockFeeHistory({\n    ethQuery,\n    endBlock: latestBlock.number,\n    numberOfBlocks: 5,\n    percentiles: [10, 20, 30],\n  });\n  const estimatedBaseFee = fromWei(latestBlock.baseFeePerGas, GWEI);\n\n  const levelSpecificEstimates =\n    calculateGasFeeEstimatesForPriorityLevels(blocks);\n\n  return {\n    ...levelSpecificEstimates,\n    estimatedBaseFee,\n    historicalBaseFeeRange: null,\n    baseFeeTrend: null,\n    latestPriorityFeeRange: null,\n    historicalPriorityFeeRange: null,\n    priorityFeeTrend: null,\n    networkCongestion: null,\n  };\n}\n"]}

package/dist/gas-util.d.ts

@@ -0,0 +1,41 @@
+import { GasFeeEstimates, EthGasPriceEstimate, EstimatedGasFeeTimeBounds, LegacyGasPriceEstimate } from './GasFeeController';
+/**
+ * Convert a decimal GWEI value to a decimal string rounded to the nearest WEI.
+ *
+ * @param n - The input GWEI amount, as a decimal string or a number.
+ * @returns The decimal string GWEI amount.
+ */
+export declare function normalizeGWEIDecimalNumbers(n: string | number): any;
+/**
+ * Fetch gas estimates from the given URL.
+ *
+ * @param url - The gas estimate URL.
+ * @param clientId - The client ID used to identify to the API who is asking for estimates.
+ * @returns The gas estimates.
+ */
+export declare function fetchGasEstimates(url: string, clientId?: string): Promise<GasFeeEstimates>;
+/**
+ * Hit the legacy MetaSwaps gasPrices estimate api and return the low, medium
+ * high values from that API.
+ *
+ * @param url - The URL to fetch gas price estimates from.
+ * @param clientId - The client ID used to identify to the API who is asking for estimates.
+ * @returns The gas price estimates.
+ */
+export declare function fetchLegacyGasPriceEstimates(url: string, clientId?: string): Promise<LegacyGasPriceEstimate>;
+/**
+ * Get a gas price estimate from the network using the `eth_gasPrice` method.
+ *
+ * @param ethQuery - The EthQuery instance to call the network with.
+ * @returns A gas price estimate.
+ */
+export declare function fetchEthGasPriceEstimate(ethQuery: any): Promise<EthGasPriceEstimate>;
+/**
+ * Estimate the time it will take for a transaction to be confirmed.
+ *
+ * @param maxPriorityFeePerGas - The max priority fee per gas.
+ * @param maxFeePerGas - The max fee per gas.
+ * @param gasFeeEstimates - The gas fee estimates.
+ * @returns The estimated lower and upper bounds for when this transaction will be confirmed.
+ */
+export declare function calculateTimeEstimate(maxPriorityFeePerGas: string, maxFeePerGas: string, gasFeeEstimates: GasFeeEstimates): EstimatedGasFeeTimeBounds;

package/dist/gas-util.js

@@ -0,0 +1,140 @@
+"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());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.calculateTimeEstimate = exports.fetchEthGasPriceEstimate = exports.fetchLegacyGasPriceEstimates = exports.fetchGasEstimates = exports.normalizeGWEIDecimalNumbers = void 0;
+const ethereumjs_util_1 = require("ethereumjs-util");
+const controller_utils_1 = require("@metamask/controller-utils");
+const makeClientIdHeader = (clientId) => ({ 'X-Client-Id': clientId });
+/**
+ * Convert a decimal GWEI value to a decimal string rounded to the nearest WEI.
+ *
+ * @param n - The input GWEI amount, as a decimal string or a number.
+ * @returns The decimal string GWEI amount.
+ */
+function normalizeGWEIDecimalNumbers(n) {
+    const numberAsWEIHex = (0, controller_utils_1.gweiDecToWEIBN)(n).toString(16);
+    const numberAsGWEI = (0, controller_utils_1.weiHexToGweiDec)(numberAsWEIHex).toString(10);
+    return numberAsGWEI;
+}
+exports.normalizeGWEIDecimalNumbers = normalizeGWEIDecimalNumbers;
+/**
+ * Fetch gas estimates from the given URL.
+ *
+ * @param url - The gas estimate URL.
+ * @param clientId - The client ID used to identify to the API who is asking for estimates.
+ * @returns The gas estimates.
+ */
+function fetchGasEstimates(url, clientId) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const estimates = yield (0, controller_utils_1.handleFetch)(url, clientId ? { headers: makeClientIdHeader(clientId) } : undefined);
+        return {
+            low: Object.assign(Object.assign({}, estimates.low), { suggestedMaxPriorityFeePerGas: normalizeGWEIDecimalNumbers(estimates.low.suggestedMaxPriorityFeePerGas), suggestedMaxFeePerGas: normalizeGWEIDecimalNumbers(estimates.low.suggestedMaxFeePerGas) }),
+            medium: Object.assign(Object.assign({}, estimates.medium), { suggestedMaxPriorityFeePerGas: normalizeGWEIDecimalNumbers(estimates.medium.suggestedMaxPriorityFeePerGas), suggestedMaxFeePerGas: normalizeGWEIDecimalNumbers(estimates.medium.suggestedMaxFeePerGas) }),
+            high: Object.assign(Object.assign({}, estimates.high), { suggestedMaxPriorityFeePerGas: normalizeGWEIDecimalNumbers(estimates.high.suggestedMaxPriorityFeePerGas), suggestedMaxFeePerGas: normalizeGWEIDecimalNumbers(estimates.high.suggestedMaxFeePerGas) }),
+            estimatedBaseFee: normalizeGWEIDecimalNumbers(estimates.estimatedBaseFee),
+            historicalBaseFeeRange: estimates.historicalBaseFeeRange,
+            baseFeeTrend: estimates.baseFeeTrend,
+            latestPriorityFeeRange: estimates.latestPriorityFeeRange,
+            historicalPriorityFeeRange: estimates.historicalPriorityFeeRange,
+            priorityFeeTrend: estimates.priorityFeeTrend,
+            networkCongestion: estimates.networkCongestion,
+        };
+    });
+}
+exports.fetchGasEstimates = fetchGasEstimates;
+/**
+ * Hit the legacy MetaSwaps gasPrices estimate api and return the low, medium
+ * high values from that API.
+ *
+ * @param url - The URL to fetch gas price estimates from.
+ * @param clientId - The client ID used to identify to the API who is asking for estimates.
+ * @returns The gas price estimates.
+ */
+function fetchLegacyGasPriceEstimates(url, clientId) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const result = yield (0, controller_utils_1.handleFetch)(url, {
+            referrer: url,
+            referrerPolicy: 'no-referrer-when-downgrade',
+            method: 'GET',
+            mode: 'cors',
+            headers: Object.assign({ 'Content-Type': 'application/json' }, (clientId && makeClientIdHeader(clientId))),
+        });
+        return {
+            low: result.SafeGasPrice,
+            medium: result.ProposeGasPrice,
+            high: result.FastGasPrice,
+        };
+    });
+}
+exports.fetchLegacyGasPriceEstimates = fetchLegacyGasPriceEstimates;
+/**
+ * Get a gas price estimate from the network using the `eth_gasPrice` method.
+ *
+ * @param ethQuery - The EthQuery instance to call the network with.
+ * @returns A gas price estimate.
+ */
+function fetchEthGasPriceEstimate(ethQuery) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const gasPrice = yield (0, controller_utils_1.query)(ethQuery, 'gasPrice');
+        return {
+            gasPrice: (0, controller_utils_1.weiHexToGweiDec)(gasPrice).toString(),
+        };
+    });
+}
+exports.fetchEthGasPriceEstimate = fetchEthGasPriceEstimate;
+/**
+ * Estimate the time it will take for a transaction to be confirmed.
+ *
+ * @param maxPriorityFeePerGas - The max priority fee per gas.
+ * @param maxFeePerGas - The max fee per gas.
+ * @param gasFeeEstimates - The gas fee estimates.
+ * @returns The estimated lower and upper bounds for when this transaction will be confirmed.
+ */
+function calculateTimeEstimate(maxPriorityFeePerGas, maxFeePerGas, gasFeeEstimates) {
+    const { low, medium, high, estimatedBaseFee } = gasFeeEstimates;
+    const maxPriorityFeePerGasInWEI = (0, controller_utils_1.gweiDecToWEIBN)(maxPriorityFeePerGas);
+    const maxFeePerGasInWEI = (0, controller_utils_1.gweiDecToWEIBN)(maxFeePerGas);
+    const estimatedBaseFeeInWEI = (0, controller_utils_1.gweiDecToWEIBN)(estimatedBaseFee);
+    const effectiveMaxPriorityFee = ethereumjs_util_1.BN.min(maxPriorityFeePerGasInWEI, maxFeePerGasInWEI.sub(estimatedBaseFeeInWEI));
+    const lowMaxPriorityFeeInWEI = (0, controller_utils_1.gweiDecToWEIBN)(low.suggestedMaxPriorityFeePerGas);
+    const mediumMaxPriorityFeeInWEI = (0, controller_utils_1.gweiDecToWEIBN)(medium.suggestedMaxPriorityFeePerGas);
+    const highMaxPriorityFeeInWEI = (0, controller_utils_1.gweiDecToWEIBN)(high.suggestedMaxPriorityFeePerGas);
+    let lowerTimeBound;
+    let upperTimeBound;
+    if (effectiveMaxPriorityFee.lt(lowMaxPriorityFeeInWEI)) {
+        lowerTimeBound = null;
+        upperTimeBound = 'unknown';
+    }
+    else if (effectiveMaxPriorityFee.gte(lowMaxPriorityFeeInWEI) &&
+        effectiveMaxPriorityFee.lt(mediumMaxPriorityFeeInWEI)) {
+        lowerTimeBound = low.minWaitTimeEstimate;
+        upperTimeBound = low.maxWaitTimeEstimate;
+    }
+    else if (effectiveMaxPriorityFee.gte(mediumMaxPriorityFeeInWEI) &&
+        effectiveMaxPriorityFee.lt(highMaxPriorityFeeInWEI)) {
+        lowerTimeBound = medium.minWaitTimeEstimate;
+        upperTimeBound = medium.maxWaitTimeEstimate;
+    }
+    else if (effectiveMaxPriorityFee.eq(highMaxPriorityFeeInWEI)) {
+        lowerTimeBound = high.minWaitTimeEstimate;
+        upperTimeBound = high.maxWaitTimeEstimate;
+    }
+    else {
+        lowerTimeBound = 0;
+        upperTimeBound = high.maxWaitTimeEstimate;
+    }
+    return {
+        lowerTimeBound,
+        upperTimeBound,
+    };
+}
+exports.calculateTimeEstimate = calculateTimeEstimate;
+//# sourceMappingURL=gas-util.js.map

package/dist/gas-util.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"gas-util.js","sourceRoot":"","sources":["../src/gas-util.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,qDAAqC;AACrC,iEAKoC;AASpC,MAAM,kBAAkB,GAAG,CAAC,QAAgB,EAAE,EAAE,CAAC,CAAC,EAAE,aAAa,EAAE,QAAQ,EAAE,CAAC,CAAC;AAE/E;;;;;GAKG;AACH,SAAgB,2BAA2B,CAAC,CAAkB;IAC5D,MAAM,cAAc,GAAG,IAAA,iCAAc,EAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC;IACtD,MAAM,YAAY,GAAG,IAAA,kCAAe,EAAC,cAAc,CAAC,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC;IAClE,OAAO,YAAY,CAAC;AACtB,CAAC;AAJD,kEAIC;AAED;;;;;;GAMG;AACH,SAAsB,iBAAiB,CACrC,GAAW,EACX,QAAiB;;QAEjB,MAAM,SAAS,GAAG,MAAM,IAAA,8BAAW,EACjC,GAAG,EACH,QAAQ,CAAC,CAAC,CAAC,EAAE,OAAO,EAAE,kBAAkB,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,CAAC,SAAS,CACjE,CAAC;QACF,OAAO;YACL,GAAG,kCACE,SAAS,CAAC,GAAG,KAChB,6BAA6B,EAAE,2BAA2B,CACxD,SAAS,CAAC,GAAG,CAAC,6BAA6B,CAC5C,EACD,qBAAqB,EAAE,2BAA2B,CAChD,SAAS,CAAC,GAAG,CAAC,qBAAqB,CACpC,GACF;YACD,MAAM,kCACD,SAAS,CAAC,MAAM,KACnB,6BAA6B,EAAE,2BAA2B,CACxD,SAAS,CAAC,MAAM,CAAC,6BAA6B,CAC/C,EACD,qBAAqB,EAAE,2BAA2B,CAChD,SAAS,CAAC,MAAM,CAAC,qBAAqB,CACvC,GACF;YACD,IAAI,kCACC,SAAS,CAAC,IAAI,KACjB,6BAA6B,EAAE,2BAA2B,CACxD,SAAS,CAAC,IAAI,CAAC,6BAA6B,CAC7C,EACD,qBAAqB,EAAE,2BAA2B,CAChD,SAAS,CAAC,IAAI,CAAC,qBAAqB,CACrC,GACF;YACD,gBAAgB,EAAE,2BAA2B,CAAC,SAAS,CAAC,gBAAgB,CAAC;YACzE,sBAAsB,EAAE,SAAS,CAAC,sBAAsB;YACxD,YAAY,EAAE,SAAS,CAAC,YAAY;YACpC,sBAAsB,EAAE,SAAS,CAAC,sBAAsB;YACxD,0BAA0B,EAAE,SAAS,CAAC,0BAA0B;YAChE,gBAAgB,EAAE,SAAS,CAAC,gBAAgB;YAC5C,iBAAiB,EAAE,SAAS,CAAC,iBAAiB;SAC/C,CAAC;IACJ,CAAC;CAAA;AA5CD,8CA4CC;AAED;;;;;;;GAOG;AACH,SAAsB,4BAA4B,CAChD,GAAW,EACX,QAAiB;;QAEjB,MAAM,MAAM,GAAG,MAAM,IAAA,8BAAW,EAAC,GAAG,EAAE;YACpC,QAAQ,EAAE,GAAG;YACb,cAAc,EAAE,4BAA4B;YAC5C,MAAM,EAAE,KAAK;YACb,IAAI,EAAE,MAAM;YACZ,OAAO,kBACL,cAAc,EAAE,kBAAkB,IAC/B,CAAC,QAAQ,IAAI,kBAAkB,CAAC,QAAQ,CAAC,CAAC,CAC9C;SACF,CAAC,CAAC;QACH,OAAO;YACL,GAAG,EAAE,MAAM,CAAC,YAAY;YACxB,MAAM,EAAE,MAAM,CAAC,eAAe;YAC9B,IAAI,EAAE,MAAM,CAAC,YAAY;SAC1B,CAAC;IACJ,CAAC;CAAA;AAnBD,oEAmBC;AAED;;;;;GAKG;AACH,SAAsB,wBAAwB,CAC5C,QAAa;;QAEb,MAAM,QAAQ,GAAG,MAAM,IAAA,wBAAK,EAAC,QAAQ,EAAE,UAAU,CAAC,CAAC;QACnD,OAAO;YACL,QAAQ,EAAE,IAAA,kCAAe,EAAC,QAAQ,CAAC,CAAC,QAAQ,EAAE;SAC/C,CAAC;IACJ,CAAC;CAAA;AAPD,4DAOC;AAED;;;;;;;GAOG;AACH,SAAgB,qBAAqB,CACnC,oBAA4B,EAC5B,YAAoB,EACpB,eAAgC;IAEhC,MAAM,EAAE,GAAG,EAAE,MAAM,EAAE,IAAI,EAAE,gBAAgB,EAAE,GAAG,eAAe,CAAC;IAEhE,MAAM,yBAAyB,GAAG,IAAA,iCAAc,EAAC,oBAAoB,CAAC,CAAC;IACvE,MAAM,iBAAiB,GAAG,IAAA,iCAAc,EAAC,YAAY,CAAC,CAAC;IACvD,MAAM,qBAAqB,GAAG,IAAA,iCAAc,EAAC,gBAAgB,CAAC,CAAC;IAE/D,MAAM,uBAAuB,GAAG,oBAAE,CAAC,GAAG,CACpC,yBAAyB,EACzB,iBAAiB,CAAC,GAAG,CAAC,qBAAqB,CAAC,CAC7C,CAAC;IAEF,MAAM,sBAAsB,GAAG,IAAA,iCAAc,EAC3C,GAAG,CAAC,6BAA6B,CAClC,CAAC;IACF,MAAM,yBAAyB,GAAG,IAAA,iCAAc,EAC9C,MAAM,CAAC,6BAA6B,CACrC,CAAC;IACF,MAAM,uBAAuB,GAAG,IAAA,iCAAc,EAC5C,IAAI,CAAC,6BAA6B,CACnC,CAAC;IAEF,IAAI,cAAc,CAAC;IACnB,IAAI,cAAc,CAAC;IAEnB,IAAI,uBAAuB,CAAC,EAAE,CAAC,sBAAsB,CAAC,EAAE;QACtD,cAAc,GAAG,IAAI,CAAC;QACtB,cAAc,GAAG,SAA0B,CAAC;KAC7C;SAAM,IACL,uBAAuB,CAAC,GAAG,CAAC,sBAAsB,CAAC;QACnD,uBAAuB,CAAC,EAAE,CAAC,yBAAyB,CAAC,EACrD;QACA,cAAc,GAAG,GAAG,CAAC,mBAAmB,CAAC;QACzC,cAAc,GAAG,GAAG,CAAC,mBAAmB,CAAC;KAC1C;SAAM,IACL,uBAAuB,CAAC,GAAG,CAAC,yBAAyB,CAAC;QACtD,uBAAuB,CAAC,EAAE,CAAC,uBAAuB,CAAC,EACnD;QACA,cAAc,GAAG,MAAM,CAAC,mBAAmB,CAAC;QAC5C,cAAc,GAAG,MAAM,CAAC,mBAAmB,CAAC;KAC7C;SAAM,IAAI,uBAAuB,CAAC,EAAE,CAAC,uBAAuB,CAAC,EAAE;QAC9D,cAAc,GAAG,IAAI,CAAC,mBAAmB,CAAC;QAC1C,cAAc,GAAG,IAAI,CAAC,mBAAmB,CAAC;KAC3C;SAAM;QACL,cAAc,GAAG,CAAC,CAAC;QACnB,cAAc,GAAG,IAAI,CAAC,mBAAmB,CAAC;KAC3C;IAED,OAAO;QACL,cAAc;QACd,cAAc;KACf,CAAC;AACJ,CAAC;AAxDD,sDAwDC","sourcesContent":["import { BN } from 'ethereumjs-util';\nimport {\n  query,\n  handleFetch,\n  gweiDecToWEIBN,\n  weiHexToGweiDec,\n} from '@metamask/controller-utils';\nimport {\n  GasFeeEstimates,\n  EthGasPriceEstimate,\n  EstimatedGasFeeTimeBounds,\n  unknownString,\n  LegacyGasPriceEstimate,\n} from './GasFeeController';\n\nconst makeClientIdHeader = (clientId: string) => ({ 'X-Client-Id': clientId });\n\n/**\n * Convert a decimal GWEI value to a decimal string rounded to the nearest WEI.\n *\n * @param n - The input GWEI amount, as a decimal string or a number.\n * @returns The decimal string GWEI amount.\n */\nexport function normalizeGWEIDecimalNumbers(n: string | number) {\n  const numberAsWEIHex = gweiDecToWEIBN(n).toString(16);\n  const numberAsGWEI = weiHexToGweiDec(numberAsWEIHex).toString(10);\n  return numberAsGWEI;\n}\n\n/**\n * Fetch gas estimates from the given URL.\n *\n * @param url - The gas estimate URL.\n * @param clientId - The client ID used to identify to the API who is asking for estimates.\n * @returns The gas estimates.\n */\nexport async function fetchGasEstimates(\n  url: string,\n  clientId?: string,\n): Promise<GasFeeEstimates> {\n  const estimates = await handleFetch(\n    url,\n    clientId ? { headers: makeClientIdHeader(clientId) } : undefined,\n  );\n  return {\n    low: {\n      ...estimates.low,\n      suggestedMaxPriorityFeePerGas: normalizeGWEIDecimalNumbers(\n        estimates.low.suggestedMaxPriorityFeePerGas,\n      ),\n      suggestedMaxFeePerGas: normalizeGWEIDecimalNumbers(\n        estimates.low.suggestedMaxFeePerGas,\n      ),\n    },\n    medium: {\n      ...estimates.medium,\n      suggestedMaxPriorityFeePerGas: normalizeGWEIDecimalNumbers(\n        estimates.medium.suggestedMaxPriorityFeePerGas,\n      ),\n      suggestedMaxFeePerGas: normalizeGWEIDecimalNumbers(\n        estimates.medium.suggestedMaxFeePerGas,\n      ),\n    },\n    high: {\n      ...estimates.high,\n      suggestedMaxPriorityFeePerGas: normalizeGWEIDecimalNumbers(\n        estimates.high.suggestedMaxPriorityFeePerGas,\n      ),\n      suggestedMaxFeePerGas: normalizeGWEIDecimalNumbers(\n        estimates.high.suggestedMaxFeePerGas,\n      ),\n    },\n    estimatedBaseFee: normalizeGWEIDecimalNumbers(estimates.estimatedBaseFee),\n    historicalBaseFeeRange: estimates.historicalBaseFeeRange,\n    baseFeeTrend: estimates.baseFeeTrend,\n    latestPriorityFeeRange: estimates.latestPriorityFeeRange,\n    historicalPriorityFeeRange: estimates.historicalPriorityFeeRange,\n    priorityFeeTrend: estimates.priorityFeeTrend,\n    networkCongestion: estimates.networkCongestion,\n  };\n}\n\n/**\n * Hit the legacy MetaSwaps gasPrices estimate api and return the low, medium\n * high values from that API.\n *\n * @param url - The URL to fetch gas price estimates from.\n * @param clientId - The client ID used to identify to the API who is asking for estimates.\n * @returns The gas price estimates.\n */\nexport async function fetchLegacyGasPriceEstimates(\n  url: string,\n  clientId?: string,\n): Promise<LegacyGasPriceEstimate> {\n  const result = await handleFetch(url, {\n    referrer: url,\n    referrerPolicy: 'no-referrer-when-downgrade',\n    method: 'GET',\n    mode: 'cors',\n    headers: {\n      'Content-Type': 'application/json',\n      ...(clientId && makeClientIdHeader(clientId)),\n    },\n  });\n  return {\n    low: result.SafeGasPrice,\n    medium: result.ProposeGasPrice,\n    high: result.FastGasPrice,\n  };\n}\n\n/**\n * Get a gas price estimate from the network using the `eth_gasPrice` method.\n *\n * @param ethQuery - The EthQuery instance to call the network with.\n * @returns A gas price estimate.\n */\nexport async function fetchEthGasPriceEstimate(\n  ethQuery: any,\n): Promise<EthGasPriceEstimate> {\n  const gasPrice = await query(ethQuery, 'gasPrice');\n  return {\n    gasPrice: weiHexToGweiDec(gasPrice).toString(),\n  };\n}\n\n/**\n * Estimate the time it will take for a transaction to be confirmed.\n *\n * @param maxPriorityFeePerGas - The max priority fee per gas.\n * @param maxFeePerGas - The max fee per gas.\n * @param gasFeeEstimates - The gas fee estimates.\n * @returns The estimated lower and upper bounds for when this transaction will be confirmed.\n */\nexport function calculateTimeEstimate(\n  maxPriorityFeePerGas: string,\n  maxFeePerGas: string,\n  gasFeeEstimates: GasFeeEstimates,\n): EstimatedGasFeeTimeBounds {\n  const { low, medium, high, estimatedBaseFee } = gasFeeEstimates;\n\n  const maxPriorityFeePerGasInWEI = gweiDecToWEIBN(maxPriorityFeePerGas);\n  const maxFeePerGasInWEI = gweiDecToWEIBN(maxFeePerGas);\n  const estimatedBaseFeeInWEI = gweiDecToWEIBN(estimatedBaseFee);\n\n  const effectiveMaxPriorityFee = BN.min(\n    maxPriorityFeePerGasInWEI,\n    maxFeePerGasInWEI.sub(estimatedBaseFeeInWEI),\n  );\n\n  const lowMaxPriorityFeeInWEI = gweiDecToWEIBN(\n    low.suggestedMaxPriorityFeePerGas,\n  );\n  const mediumMaxPriorityFeeInWEI = gweiDecToWEIBN(\n    medium.suggestedMaxPriorityFeePerGas,\n  );\n  const highMaxPriorityFeeInWEI = gweiDecToWEIBN(\n    high.suggestedMaxPriorityFeePerGas,\n  );\n\n  let lowerTimeBound;\n  let upperTimeBound;\n\n  if (effectiveMaxPriorityFee.lt(lowMaxPriorityFeeInWEI)) {\n    lowerTimeBound = null;\n    upperTimeBound = 'unknown' as unknownString;\n  } else if (\n    effectiveMaxPriorityFee.gte(lowMaxPriorityFeeInWEI) &&\n    effectiveMaxPriorityFee.lt(mediumMaxPriorityFeeInWEI)\n  ) {\n    lowerTimeBound = low.minWaitTimeEstimate;\n    upperTimeBound = low.maxWaitTimeEstimate;\n  } else if (\n    effectiveMaxPriorityFee.gte(mediumMaxPriorityFeeInWEI) &&\n    effectiveMaxPriorityFee.lt(highMaxPriorityFeeInWEI)\n  ) {\n    lowerTimeBound = medium.minWaitTimeEstimate;\n    upperTimeBound = medium.maxWaitTimeEstimate;\n  } else if (effectiveMaxPriorityFee.eq(highMaxPriorityFeeInWEI)) {\n    lowerTimeBound = high.minWaitTimeEstimate;\n    upperTimeBound = high.maxWaitTimeEstimate;\n  } else {\n    lowerTimeBound = 0;\n    upperTimeBound = high.maxWaitTimeEstimate;\n  }\n\n  return {\n    lowerTimeBound,\n    upperTimeBound,\n  };\n}\n"]}

package/dist/index.d.ts

@@ -0,0 +1 @@
+export * from './GasFeeController';

package/dist/index.js

@@ -0,0 +1,18 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./GasFeeController"), exports);
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,qDAAmC","sourcesContent":["export * from './GasFeeController';\n"]}

package/package.json

@@ -0,0 +1,64 @@
+{
+  "name": "@metamask/gas-fee-controller",
+  "version": "1.0.0",
+  "description": "Periodically calculates gas fee estimates based on various gas limits as well as other data displayed on transaction confirm screens",
+  "keywords": [
+    "MetaMask",
+    "Ethereum"
+  ],
+  "homepage": "https://github.com/MetaMask/controllers/tree/main/packages/gas-fee-controller#readme",
+  "bugs": {
+    "url": "https://github.com/MetaMask/controllers/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/MetaMask/controllers.git"
+  },
+  "license": "MIT",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "files": [
+    "dist/"
+  ],
+  "scripts": {
+    "build:docs": "typedoc",
+    "changelog:validate": "../../scripts/validate-changelog.sh @metamask/gas-fee-controller",
+    "prepare-manifest:preview": "../../scripts/prepare-preview-manifest.sh",
+    "publish:preview": "yarn npm publish --tag preview",
+    "test": "jest",
+    "test:watch": "jest --watch"
+  },
+  "dependencies": {
+    "@metamask/base-controller": "~1.0.0",
+    "@metamask/controller-utils": "~1.0.0",
+    "@metamask/network-controller": "~1.0.0",
+    "@types/uuid": "^8.3.0",
+    "babel-runtime": "^6.26.0",
+    "eth-query": "^2.1.2",
+    "ethereumjs-util": "^7.0.10",
+    "ethjs-unit": "^0.1.6",
+    "immer": "^9.0.6",
+    "uuid": "^8.3.2"
+  },
+  "devDependencies": {
+    "@metamask/auto-changelog": "^3.1.0",
+    "@types/jest": "^26.0.22",
+    "@types/jest-when": "^2.7.3",
+    "deepmerge": "^4.2.2",
+    "jest": "^26.4.2",
+    "jest-when": "^3.4.2",
+    "nock": "^13.0.7",
+    "sinon": "^9.2.4",
+    "ts-jest": "^26.5.2",
+    "typedoc": "^0.22.15",
+    "typedoc-plugin-missing-exports": "^0.22.6",
+    "typescript": "~4.6.3"
+  },
+  "engines": {
+    "node": ">=14.0.0"
+  },
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
+  }
+}