@magnusmage/gasmate v1.0.6

Gas Mate

Gas Mate is designed to provide real-time gas prices to ensure that your transactions get included in a block. It provides an asynchronous function getGasFeeEstimates that estimates gas fees across different blockchain networks.

Features

• Gas Fee Estimation: Calculate low, medium, and high gas fee estimates for transactions.
• Network Support: The function handles modern, legacy, and custom networks like Ethereum, Binance Smart Chain, Polygon, Avalanche, and others.
• Custom Gas Fee Scaling: Dynamically adjust gas fees using percentile-based scaling for a more accurate estimation.
• Historical Data: Utilizes recent blocks and transaction data to provide an accurate estimation of gas prices.

Supported Networks

Installation

You can install this package using npm:

npm install @magnusmage/gasmate

or using yarn:

yarn add @magnusmage/gasmate

Usage

1. Import the getGasFeeEstimates function in your project:

   const getGasFeeEstimates = require('@magnusmage/gasmate');

or

   import getGasFeeEstimates from '@magnusmage/gasmate';

2. Call the function, passing the desired network's RPC URL:

(async () => {
  try {
    const gasFeeEstimates = await getGasFeeEstimates('https://bsc-dataseed.binance.org/');
    console.log(gasFeeEstimates);
  } catch (error) {
    console.error(error.message);
  }
})();

Example Output

The function returns an object containing gas fee estimates for low, medium, and high priority transactions:

{
  "low": {
    "suggestedMaxPriorityFeePerGas": "1.2",
    "suggestedMaxFeePerGas": "12.34",
    "minWaitTimeEstimate": 15000,
    "maxWaitTimeEstimate": 60000
  },
  "medium": {
    "suggestedMaxPriorityFeePerGas": "1.5",
    "suggestedMaxFeePerGas": "15.67",
    "minWaitTimeEstimate": 15000,
    "maxWaitTimeEstimate": 45000
  },
  "high": {
    "suggestedMaxPriorityFeePerGas": "1.8",
    "suggestedMaxFeePerGas": "18.90",
    "minWaitTimeEstimate": 15000,
    "maxWaitTimeEstimate": 30000
  },
  "estimatedBaseFee": "12.34"
}

Error Handling

• Invalid RPC URLs will result in an error.
• If there are no gas prices found in recent blocks, the function throws an appropriate error message.