Package Exports

eth-gas-fee-estimator
eth-gas-fee-estimator/dist/index.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (eth-gas-fee-estimator) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

Ethereum Gas Fee Estimator

A small utility to estimate the gas fee for the Ethereum transactions. It supports legacy fee and EIP-1559 fee.

Installation

You can install this package using npm:

npm install ethereum-gas-fee-estimator

or using yarn:

yarn add ethereum-gas-fee-estimator

Usage

Using default gas fee estimation provided by the node.

import { gasFee } from 'ethereum-gas-fee-estimator';

// provider = ethersJs JsonRpcProvider

// legacy = true for legacy fee estimation and false for EIP-1559 fee estimation. (Default is false)

// priorityFeeBufferPercent = Percentage of maxPriorityFee to add to maxPriorityFee as a buffer. Should be between 0 and 1. (Default is 0)

const fee = await gasFee(provider,legacy,priorityFeeBufferPercent);

// fee is either bigint or {
//   maxFee: bigint,
//   maxPriorityFee: bigint
//}

Using customizable gas tracker to get three different fee estimations. (slow, average and fast)

import { gasFeeTracker } from 'ethereum-gas-fee-estimator';

// provider = ethersJs JsonRpcProvider

// numberOfBlocks = The number of blocks preceding the latest block to use in the calculation. (Default 10)

// percentilesList = A monotonically increasing list of percentile values to sample from each block's effective priority fees per gas in ascending order. Must have 3 elements and each element must be between 1 and 99. (Default is [25, 50, 75])

const fee = await gasFeeTracker(provider,numberOfBlocks,percentilesList);

// fee {
//   slow: {
//     maxFee: bigint,
//     maxPriorityFee: bigint
//   },
//   average: {
//     maxFee: bigint,
//     maxPriorityFee: bigint
//   },
//   fast: {
//     maxFee: bigint,
//     maxPriorityFee: bigint
//   }
//}