viem
Version:
36 lines • 2.25 kB
TypeScript
import { type EstimateGasErrorType } from '../../../actions/public/estimateGas.js';
import { type PrepareTransactionRequestErrorType } from '../../../actions/wallet/prepareTransactionRequest.js';
import type { Client } from '../../../clients/createClient.js';
import type { Transport } from '../../../clients/transports/createTransport.js';
import type { ErrorType } from '../../../errors/utils.js';
import type { Account } from '../../../types/account.js';
import { type Chain } from '../../../types/chain.js';
import type { RequestErrorType } from '../../../utils/buildRequest.js';
import { type EstimateL1GasErrorType, type EstimateL1GasParameters } from './estimateL1Gas.js';
export type EstimateTotalGasParameters<TChain extends Chain | undefined = Chain | undefined, TAccount extends Account | undefined = Account | undefined, TChainOverride extends Chain | undefined = Chain | undefined> = EstimateL1GasParameters<TChain, TAccount, TChainOverride>;
export type EstimateTotalGasReturnType = bigint;
export type EstimateTotalGasErrorType = RequestErrorType | PrepareTransactionRequestErrorType | EstimateL1GasErrorType | EstimateGasErrorType | ErrorType;
/**
* Estimates the amount of L1 data gas + L2 gas required to execute an L2 transaction.
*
* @param client - Client to use
* @param parameters - {@link EstimateTotalGasParameters}
* @returns The gas estimate. {@link EstimateTotalGasReturnType}
*
* @example
* import { createPublicClient, http, parseEther } from 'viem'
* import { optimism } from 'viem/chains'
* import { estimateTotalGas } from 'viem/chains/optimism'
*
* const client = createPublicClient({
* chain: optimism,
* transport: http(),
* })
* const totalGas = await estimateTotalGas(client, {
* account: '0xA0Cf798816D4b9b9866b5330EEa46a18382f251e',
* to: '0x70997970c51812dc3a010c7d01b50e0d17dc79c8',
* value: parseEther('1'),
* })
*/
export declare function estimateTotalGas<TChain extends Chain | undefined, TAccount extends Account | undefined, TChainOverride extends Chain | undefined = undefined>(client: Client<Transport, TChain, TAccount>, args: EstimateTotalGasParameters<TChain, TAccount, TChainOverride>): Promise<EstimateTotalGasReturnType>;
//# sourceMappingURL=estimateTotalGas.d.ts.map