estimateGas
Estimates the gas necessary to complete a transaction without submitting it to the network.
Usage
ts
import { getAccount } from 'viem'
import { publicClient } from './client'
const gasEstimate = await publicClient.estimateGas({
account: getAccount('0xf39fd6e51aad88f6f4ce6ab8827279cfffb92266'),
to: '0x70997970c51812dc3a010c7d01b50e0d17dc79c8',
value: parseEther('1')
})
ts
import { createPublicClient, http } from 'viem'
import { mainnet } from 'viem/chains'
export const publicClient = createPublicClient({
chain: mainnet,
transport: http()
})
Returns
bigint
The gas estimate (in wei).
Parameters
account (optional)
- Type:
Account
The Account sender. Read more.
ts
import { getAccount } from 'viem'
const gasEstimate = await publicClient.estimateGas({
account: getAccount('0xf39fd6e51aad88f6f4ce6ab8827279cfffb92266', // [!code focus)]
to: '0x70997970c51812dc3a010c7d01b50e0d17dc79c8',
value: parseEther('1')
})
data (optional)
- Type:
0x${string}
Contract code or a hashed method call with encoded args.
ts
import { getAccount } from 'viem'
const gasEstimate = await publicClient.estimateGas({
data: '0x...',
account: getAccount('0xf39fd6e51aad88f6f4ce6ab8827279cfffb92266'),
to: '0x70997970c51812dc3a010c7d01b50e0d17dc79c8',
value: parseEther('1')
})
gasPrice (optional)
- Type:
bigint
The price (in wei) to pay per gas. Only applies to Legacy Transactions.
ts
import { getAccount } from 'viem'
const gasEstimate = await publicClient.estimateGas({
account: getAccount('0xf39fd6e51aad88f6f4ce6ab8827279cfffb92266'),
gasPrice: parseGwei('20'),
to: '0x70997970c51812dc3a010c7d01b50e0d17dc79c8',
value: parseEther('1')
})
maxFeePerGas (optional)
- Type:
bigint
Total fee per gas (in wei), inclusive of maxPriorityFeePerGas. Only applies to EIP-1559 Transactions
ts
import { getAccount } from 'viem'
const gasEstimate = await publicClient.estimateGas({
account: getAccount('0xf39fd6e51aad88f6f4ce6ab8827279cfffb92266'),
maxFeePerGas: parseGwei('20'),
to: '0x70997970c51812dc3a010c7d01b50e0d17dc79c8',
value: parseEther('1')
})
maxPriorityFeePerGas (optional)
- Type:
bigint
Max priority fee per gas (in wei). Only applies to EIP-1559 Transactions
ts
import { getAccount } from 'viem'
const gasEstimate = await publicClient.estimateGas({
account: getAccount('0xf39fd6e51aad88f6f4ce6ab8827279cfffb92266'),
maxFeePerGas: parseGwei('20'),
maxPriorityFeePerGas: parseGwei('2'),
to: '0x70997970c51812dc3a010c7d01b50e0d17dc79c8',
value: parseEther('1')
})
to (optional)
- Type:
Address
Transaction recipient.
ts
import { getAccount } from 'viem'
const gasEstimate = await publicClient.estimateGas({
account: getAccount('0xf39fd6e51aad88f6f4ce6ab8827279cfffb92266'),
to: '0x70997970c51812dc3a010c7d01b50e0d17dc79c8',
value: parseEther('1')
})
value (optional)
- Type:
bigint
Value (in wei) sent with this transaction.
ts
import { getAccount } from 'viem'
const gasEstimate = await publicClient.estimateGas({
account: getAccount('0xf39fd6e51aad88f6f4ce6ab8827279cfffb92266'),
to: '0x70997970c51812dc3a010c7d01b50e0d17dc79c8',
value: parseEther('1')
})
blockNumber (optional)
- Type:
number
The block number to perform the gas estimate against.
ts
import { getAccount } from 'viem'
const gasEstimate = await publicClient.estimateGas({
blockNumber: 15121123n,
account: getAccount('0xf39fd6e51aad88f6f4ce6ab8827279cfffb92266'),
to: '0x70997970c51812dc3a010c7d01b50e0d17dc79c8',
value: parseEther('1')
})
blockTag (optional)
- Type:
'latest' | 'earliest' | 'pending' | 'safe' | 'finalized' - Default:
'latest'
The block tag to perform the gas estimate against.
ts
import { getAccount } from 'viem'
const gasEstimate = await publicClient.estimateGas({
blockTag: 'safe',
account: getAccount('0xf39fd6e51aad88f6f4ce6ab8827279cfffb92266'),
to: '0x70997970c51812dc3a010c7d01b50e0d17dc79c8',
value: parseEther('1')
})