hardhat/dist/src/internal/builtin-plugins/network-manager/request-handlers/handlers/gas/multiplied-gas-estimation.js

Hardhat is an extensible developer tool that helps smart contract developers increase productivity by reliably bringing together the tools they want.

import { assertHardhatInvariant } from "@nomicfoundation/hardhat-errors";
import { ensureError } from "@nomicfoundation/hardhat-utils/error";
import { hexStringToNumber, numberToHexString, } from "@nomicfoundation/hardhat-utils/hex";
/**
 * This class handles gas estimation for transactions by applying a multiplier to the estimated gas value.
 * It requests a gas estimation from the provider and multiplies it by a predefined gas multiplier, ensuring the gas does not exceed the block's gas limit.
 * If an execution error occurs, the method returns the block's gas limit instead.
 * The block gas limit is cached after the first retrieval to optimize performance.
 */
export class MultipliedGasEstimation {
    #provider;
    #gasMultiplier;
    #blockGasLimit;
    constructor(provider, gasMultiplier) {
        this.#provider = provider;
        this.#gasMultiplier = gasMultiplier;
    }
    async getMultipliedGasEstimation(params) {
        try {
            const realEstimation = await this.#provider.request({
                method: "eth_estimateGas",
                params,
            });
            assertHardhatInvariant(typeof realEstimation === "string", "realEstimation should be a string");
            if (this.#gasMultiplier === 1) {
                return realEstimation;
            }
            const normalGas = hexStringToNumber(realEstimation);
            const gasLimit = await this.#getBlockGasLimit();
            const multiplied = Math.floor(normalGas * this.#gasMultiplier);
            const gas = multiplied > gasLimit ? gasLimit - 1 : multiplied;
            return numberToHexString(gas);
        }
        catch (error) {
            ensureError(error);
            if (error.message.toLowerCase().includes("execution error")) {
                const blockGasLimitTmp = await this.#getBlockGasLimit();
                return numberToHexString(blockGasLimitTmp);
            }
            throw error;
        }
    }
    async #getBlockGasLimit() {
        if (this.#blockGasLimit === undefined) {
            const latestBlock = await this.#provider.request({
                method: "eth_getBlockByNumber",
                params: ["latest", false],
            });
            assertHardhatInvariant(typeof latestBlock === "object" &&
                latestBlock !== null &&
                "gasLimit" in latestBlock &&
                typeof latestBlock.gasLimit === "string", "latestBlock should have a gasLimit");
            const fetchedGasLimit = hexStringToNumber(latestBlock.gasLimit);
            // We store a lower value in case the gas limit varies slightly
            this.#blockGasLimit = Math.floor(fetchedGasLimit * 0.95);
        }
        return this.#blockGasLimit;
    }
}
//# sourceMappingURL=multiplied-gas-estimation.js.map