rocketh 0.17.13 → 0.17.15

package/src/utils/eth.ts

@@ -0,0 +1,120 @@
+import {EIP1193BlockTag, EIP1193FeeHistory, EIP1193ProviderWithoutEvents, EIP1193QUANTITY} from 'eip-1193';
+import {logger} from '../internal/logging.js';
+
+function avg(arr: bigint[]) {
+	const sum = arr.reduce((a: bigint, v: bigint) => a + v);
+	return sum / BigInt(arr.length);
+}
+
+export type EstimateGasPriceOptions = {
+	blockCount: number;
+	newestBlock: EIP1193BlockTag;
+	rewardPercentiles: number[];
+};
+
+export type RoughEstimateGasPriceOptions = {
+	blockCount: number;
+	newestBlock: EIP1193BlockTag;
+	rewardPercentiles: [number, number, number];
+};
+
+export type GasPrice = {maxFeePerGas: bigint; maxPriorityFeePerGas: bigint};
+export type EstimateGasPriceResult = GasPrice[];
+export type RoughEstimateGasPriceResult = {slow: GasPrice; average: GasPrice; fast: GasPrice};
+
+export async function getGasPriceEstimate(
+	provider: EIP1193ProviderWithoutEvents,
+	options?: Partial<EstimateGasPriceOptions>,
+): Promise<EstimateGasPriceResult> {
+	const defaultOptions: EstimateGasPriceOptions = {
+		blockCount: 20,
+		newestBlock: 'pending',
+		rewardPercentiles: [10, 50, 80],
+	};
+	const optionsResolved = options ? {...defaultOptions, ...options} : defaultOptions;
+
+	const historicalBlocks = `0x${optionsResolved.blockCount.toString(16)}`;
+
+	let rawFeeHistory: EIP1193FeeHistory;
+	try {
+		rawFeeHistory = await provider.request({
+			method: 'eth_feeHistory',
+			params: [historicalBlocks as EIP1193QUANTITY, optionsResolved.newestBlock, optionsResolved.rewardPercentiles],
+		});
+	} catch (err: any) {
+		const message = 'details' in err && err.details ? err.details : err.message;
+		if (
+			message &&
+			(message.indexOf('unknown method eth_feeHistory') != -1 ||
+				message.indexOf('The method "eth_feeHistory" does not exist') != -1)
+		) {
+			logger.warn(`eth_feeHistory not implemeted by node, falling back on "eth_gasPrice"`);
+			const gasPrice = await provider.request({method: 'eth_gasPrice'});
+			const result: EstimateGasPriceResult = [];
+			for (let i = 0; i < optionsResolved.rewardPercentiles.length; i++) {
+				result.push({
+					maxFeePerGas: BigInt(gasPrice),
+					maxPriorityFeePerGas: BigInt(gasPrice),
+				});
+			}
+			return result;
+		} else {
+			throw err;
+		}
+	}
+
+	let blockNum = Number(rawFeeHistory.oldestBlock);
+	const lastBlock = blockNum + rawFeeHistory.reward.length;
+	let index = 0;
+	const blocksHistory: {number: number; baseFeePerGas: bigint; gasUsedRatio: number; priorityFeePerGas: bigint[]}[] =
+		[];
+	while (blockNum < lastBlock) {
+		blocksHistory.push({
+			number: blockNum,
+			baseFeePerGas: BigInt(rawFeeHistory.baseFeePerGas[index]),
+			gasUsedRatio: Number(rawFeeHistory.gasUsedRatio[index]),
+			priorityFeePerGas: rawFeeHistory.reward[index].map((x) => BigInt(x)),
+		});
+		blockNum += 1;
+		index += 1;
+	}
+
+	const percentilePriorityFeeAverages: bigint[] = [];
+	for (let i = 0; i < optionsResolved.rewardPercentiles.length; i++) {
+		percentilePriorityFeeAverages.push(avg(blocksHistory.map((b) => b.priorityFeePerGas[i])));
+	}
+
+	const baseFeePerGas = BigInt(rawFeeHistory.baseFeePerGas[rawFeeHistory.baseFeePerGas.length - 1]);
+
+	const result: EstimateGasPriceResult = [];
+	for (let i = 0; i < optionsResolved.rewardPercentiles.length; i++) {
+		result.push({
+			maxFeePerGas: percentilePriorityFeeAverages[i] + baseFeePerGas,
+			maxPriorityFeePerGas: percentilePriorityFeeAverages[i],
+		});
+	}
+	return result;
+}
+
+export async function getRoughGasPriceEstimate(
+	provider: EIP1193ProviderWithoutEvents,
+	options?: Partial<RoughEstimateGasPriceOptions>,
+): Promise<RoughEstimateGasPriceResult> {
+	const defaultOptions: EstimateGasPriceOptions = {
+		blockCount: 20,
+		newestBlock: 'pending',
+		rewardPercentiles: [10, 50, 80],
+	};
+	const optionsResolved = options ? {...defaultOptions, ...options} : defaultOptions;
+
+	if (optionsResolved.rewardPercentiles.length !== 3) {
+		throw new Error(`rough gas estimate require 3 percentile, it defaults to [10,50,80]`);
+	}
+
+	const result = await getGasPriceEstimate(provider, optionsResolved);
+	return {
+		slow: result[0],
+		average: result[1],
+		fast: result[2],
+	};
+}