Skip to content
LogoLogo

estimateGas

An Action for estimating gas for a transaction.

Estimates the gas necessary to complete a transaction without submitting it to the network.

Usage

// @filename: config.ts
import { createPublicClient, http } from 'viem'
import { privateKeyToAccount } from 'viem/accounts'
import { mainnet } from 'viem/chains'
 
↓ JSON-RPC Account
export const account = '0xf39fd6e51aad88f6f4ce6ab8827279cfffb92266'
 
↓ Local Account
// export const account = privateKeyToAccount('0x...')
 
export const publicClient = createPublicClient({
  chain: mainnet,
  transport: http()
})
// @filename: example.ts
// ---cut---
import { account, publicClient } from './config'
 
const gas = await publicClient.estimateGas({ 
  account,
  to: '0x70997970c51812dc3a010c7d01b50e0d17dc79c8',
  value: parseEther('1')
})

Returns

bigint

The gas estimate (in gas).

Parameters

account

  • Type: Account | Address

The Account to estimate gas from.

Accepts a JSON-RPC Account or Local Account (Private Key, etc).

import {  } from 'viem'
 
const  = await .({
  : '0xf39fd6e51aad88f6f4ce6ab8827279cfffb92266', 
  : '0x70997970c51812dc3a010c7d01b50e0d17dc79c8',
  : ('1')
})

data (optional)

  • Type: 0x${string}

Contract code or a hashed method call with encoded args which can be generated using encodeFunctionData.

import {  } from 'viem'
 
const  = await .({
  : '0x...', 
  : '0xf39fd6e51aad88f6f4ce6ab8827279cfffb92266',
  : '0x70997970c51812dc3a010c7d01b50e0d17dc79c8',
  : ('1')
})

gasPrice (optional)

  • Type: bigint

The price (in wei) to pay per gas. Only applies to Legacy Transactions.

import { ,  } from 'viem'
 
const  = await .({
  : '0xf39fd6e51aad88f6f4ce6ab8827279cfffb92266',
  : ('20'), 
  : '0x70997970c51812dc3a010c7d01b50e0d17dc79c8',
  : ('1') 
})

maxFeePerGas (optional)

  • Type: bigint

Total fee per gas (in wei), inclusive of maxPriorityFeePerGas. Only applies to EIP-1559 Transactions

import { ,  } from 'viem'
 
const  = await .({
  : '0xf39fd6e51aad88f6f4ce6ab8827279cfffb92266',
  : ('20'),  
  : '0x70997970c51812dc3a010c7d01b50e0d17dc79c8',
  : ('1')
})

maxPriorityFeePerGas (optional)

  • Type: bigint

Max priority fee per gas (in wei). Only applies to EIP-1559 Transactions

import { ,  } from 'viem'
 
const  = await .({
  : '0xf39fd6e51aad88f6f4ce6ab8827279cfffb92266',
  : ('20'),
  : ('2'), 
  : '0x70997970c51812dc3a010c7d01b50e0d17dc79c8',
  : ('1')
})

to (optional)

Transaction recipient.

import {  } from 'viem'
 
const  = await .({
  : '0xf39fd6e51aad88f6f4ce6ab8827279cfffb92266',
  : '0x70997970c51812dc3a010c7d01b50e0d17dc79c8', 
  : ('1')
})

value (optional)

  • Type: bigint

Value (in wei) sent with this transaction.

import {  } from 'viem'
 
const  = await .({
  : '0xf39fd6e51aad88f6f4ce6ab8827279cfffb92266',
  : '0x70997970c51812dc3a010c7d01b50e0d17dc79c8',
  : ('1') 
})

blockNumber (optional)

  • Type: number

The block number to perform the gas estimate against.

import {  } from 'viem'
 
const  = await .({
  : 15121123n, 
  : '0xf39fd6e51aad88f6f4ce6ab8827279cfffb92266',
  : '0x70997970c51812dc3a010c7d01b50e0d17dc79c8',
  : ('1') 
})

blockTag (optional)

  • Type: 'latest' | 'earliest' | 'pending' | 'safe' | 'finalized'
  • Default: 'latest'

The block tag to perform the gas estimate against.

import {  } from 'viem'
 
const  = await .({
  : 'safe', 
  : '0xf39fd6e51aad88f6f4ce6ab8827279cfffb92266',
  : '0x70997970c51812dc3a010c7d01b50e0d17dc79c8',
  : ('1') 
})

stateOverride (optional)

The state override set is an optional address-to-state mapping, where each entry specifies some state to be ephemerally overridden prior to executing the call.

const data = await publicClient.estimateGas({
  account,
  data: '0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2',
  to: '0x70997970c51812dc3a010c7d01b50e0d17dc79c8',
  stateOverride: [ 
    { 
      address: '0xa5cc3c03994DB5b0d9A5eEdD10CabaB0813678AC', 
      balance: parseEther('1'), 
      stateDiff: [ 
        { 
          slot: '0x3ea2f1d0abf3fc66cf29eebb70cbd4e7fe762ef8a09bcc06c8edf641230afec0', 
          value: '0x00000000000000000000000000000000000000000000000000000000000001a4', 
        }, 
      ], 
    } 
  ], 
})

JSON-RPC Methods

eth_estimateGas

Suggest changes to this page