The Account of the Client.
Optionalbatch?: { Flags for batch settings.
Optionalmulticall?: boolean | { Toggle to enable eth_call multicall aggregation.
Time (in ms) that cached data will remain in memory.
OptionalccipCCIP Read configuration.
Chain for the client.
A key for the client.
A name for the client.
Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds.
Request function wrapped with friendly error handling
The RPC transport
The type of client.
A unique ID for the client.
Executes a new message call immediately without submitting a transaction to the network.
eth_callimport { createPublicClient, http } from 'viem'
import { mainnet } from 'viem/chains'
const client = createPublicClient({
chain: mainnet,
transport: http(),
})
const data = await client.call({
account: '0xf39fd6e51aad88f6f4ce6ab8827279cfffb92266',
data: '0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2',
to: '0x70997970c51812dc3a010c7d01b50e0d17dc79c8',
})
The call data. CallReturnType
Creates a Filter to listen for new block hashes that can be used with getFilterChanges.
eth_newBlockFilterimport { createPublicClient, createBlockFilter, http } from 'viem'
import { mainnet } from 'viem/chains'
const client = createPublicClient({
chain: mainnet,
transport: http(),
})
const filter = await createBlockFilter(client)
// { id: "0x345a6572337856574a76364e457a4366", type: 'block' }
Filter. CreateBlockFilterReturnType
Creates a Filter to retrieve event logs that can be used with getFilterChanges or getFilterLogs.
import { createPublicClient, http, parseAbi } from 'viem'
import { mainnet } from 'viem/chains'
const client = createPublicClient({
chain: mainnet,
transport: http(),
})
const filter = await client.createContractEventFilter({
abi: parseAbi(['event Transfer(address indexed, address indexed, uint256)']),
})
Filter. CreateContractEventFilterReturnType
Creates a Filter to listen for new events that can be used with getFilterChanges.
eth_newFilterimport { createPublicClient, http } from 'viem'
import { mainnet } from 'viem/chains'
const client = createPublicClient({
chain: mainnet,
transport: http(),
})
const filter = await client.createEventFilter({
address: '0xfba3912ca04dd458c843e2ee08967fc04f3579c2',
})
Filter. CreateEventFilterReturnType
Creates a Filter to listen for new pending transaction hashes that can be used with getFilterChanges.
eth_newPendingTransactionFilterimport { createPublicClient, http } from 'viem'
import { mainnet } from 'viem/chains'
const client = createPublicClient({
chain: mainnet,
transport: http(),
})
const filter = await client.createPendingTransactionFilter()
// { id: "0x345a6572337856574a76364e457a4366", type: 'transaction' }
Filter. CreateBlockFilterReturnType
Estimates the gas required to successfully execute a contract write function call.
Internally, uses a Public Client to call the estimateGas action with ABI-encoded data.
import { createPublicClient, http, parseAbi } from 'viem'
import { mainnet } from 'viem/chains'
const client = createPublicClient({
chain: mainnet,
transport: http(),
})
const gas = await client.estimateContractGas({
address: '0xFBA3912Ca04dd458c843e2EE08967fC04f3579c2',
abi: parseAbi(['function mint() public']),
functionName: 'mint',
account: '0xf39fd6e51aad88f6f4ce6ab8827279cfffb92266',
})
EstimateContractGasParameters
The gas estimate (in wei). EstimateContractGasReturnType
Estimates the gas necessary to complete a transaction without submitting it to the network.
eth_estimateGasimport { createPublicClient, http, parseEther } from 'viem'
import { mainnet } from 'viem/chains'
const client = createPublicClient({
chain: mainnet,
transport: http(),
})
const gasEstimate = await client.estimateGas({
account: '0xA0Cf798816D4b9b9866b5330EEa46a18382f251e',
to: '0x70997970c51812dc3a010c7d01b50e0d17dc79c8',
value: parseEther('1'),
})
EstimateGasParameters
The gas estimate (in wei). EstimateGasReturnType
Returns the balance of an address in wei.
eth_getBalanceYou can convert the balance to ether units with formatEther.
const balance = await getBalance(client, {
address: '0xA0Cf798816D4b9b9866b5330EEa46a18382f251e',
blockTag: 'safe'
})
const balanceAsEther = formatEther(balance)
// "6.942"
import { createPublicClient, http } from 'viem'
import { mainnet } from 'viem/chains'
const client = createPublicClient({
chain: mainnet,
transport: http(),
})
const balance = await client.getBalance({
address: '0xA0Cf798816D4b9b9866b5330EEa46a18382f251e',
})
// 10000000000000000000000n (wei)
GetBalanceParameters
The balance of the address in wei. GetBalanceReturnType
Returns the base fee per blob gas in wei.
eth_blobBaseFeeimport { createPublicClient, http } from 'viem'
import { mainnet } from 'viem/chains'
import { getBlobBaseFee } from 'viem/public'
const client = createPublicClient({
chain: mainnet,
transport: http(),
})
const blobBaseFee = await client.getBlobBaseFee()
The blob base fee (in wei). GetBlobBaseFeeReturnType
Returns information about a block at a block number, hash, or tag.
eth_getBlockByNumber for blockNumber & blockTag.eth_getBlockByHash for blockHash.import { createPublicClient, http } from 'viem'
import { mainnet } from 'viem/chains'
const client = createPublicClient({
chain: mainnet,
transport: http(),
})
const block = await client.getBlock()
Optionalargs: GetBlockParameters<includeTransactions, blockTag>GetBlockParameters
Information about the block. GetBlockReturnType
Returns the number of the most recent block seen.
import { createPublicClient, http } from 'viem'
import { mainnet } from 'viem/chains'
const client = createPublicClient({
chain: mainnet,
transport: http(),
})
const blockNumber = await client.getBlockNumber()
// 69420n
Optionalargs: GetBlockNumberParametersGetBlockNumberParameters
The number of the block. GetBlockNumberReturnType
Returns the number of Transactions at a block number, hash, or tag.
eth_getBlockTransactionCountByNumber for blockNumber & blockTag.eth_getBlockTransactionCountByHash for blockHash.import { createPublicClient, http } from 'viem'
import { mainnet } from 'viem/chains'
const client = createPublicClient({
chain: mainnet,
transport: http(),
})
const count = await client.getBlockTransactionCount()
Optionalargs: GetBlockTransactionCountParametersGetBlockTransactionCountParameters
The block transaction count. GetBlockTransactionCountReturnType
Returns the chain ID associated with the current network.
eth_chainIdimport { createPublicClient, http } from 'viem'
import { mainnet } from 'viem/chains'
const client = createPublicClient({
chain: mainnet,
transport: http(),
})
const chainId = await client.getChainId()
// 1
The current chain ID. GetChainIdReturnType
Retrieves the bytecode at an address.
eth_getCodeimport { createPublicClient, http } from 'viem'
import { mainnet } from 'viem/chains'
const client = createPublicClient({
chain: mainnet,
transport: http(),
})
const code = await client.getCode({
address: '0xFBA3912Ca04dd458c843e2EE08967fC04f3579c2',
})
GetBytecodeParameters
The contract's bytecode. GetBytecodeReturnType
Returns a list of event logs emitted by a contract.
eth_getLogsimport { createPublicClient, http } from 'viem'
import { mainnet } from 'viem/chains'
import { wagmiAbi } from './abi'
const client = createPublicClient({
chain: mainnet,
transport: http(),
})
const logs = await client.getContractEvents(client, {
address: '0xFBA3912Ca04dd458c843e2EE08967fC04f3579c2',
abi: wagmiAbi,
eventName: 'Transfer'
})
Reads the EIP-712 domain from a contract, based on the ERC-5267 specification.
import { createPublicClient, http } from 'viem'
import { mainnet } from 'viem/chains'
const client = createPublicClient({
chain: mainnet,
transport: http(),
})
const domain = await client.getEip712Domain({
address: '0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48',
})
// {
// domain: {
// name: 'ExampleContract',
// version: '1',
// chainId: 1,
// verifyingContract: '0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48',
// },
// fields: '0x0f',
// extensions: [],
// }
The EIP-712 domain, fields, and extensions. GetEip712DomainReturnType
Gets address for ENS name.
Calls resolve(bytes, bytes) on ENS Universal Resolver Contract.
Since ENS names prohibit certain forbidden characters (e.g. underscore) and have other validation rules, you likely want to normalize ENS names with UTS-46 normalization before passing them to getEnsAddress. You can use the built-in normalize function for this.
import { createPublicClient, http } from 'viem'
import { mainnet } from 'viem/chains'
import { normalize } from 'viem/ens'
const client = createPublicClient({
chain: mainnet,
transport: http(),
})
const ensAddress = await client.getEnsAddress({
name: normalize('wevm.eth'),
})
// '0xd2135CfB216b74109775236E36d4b433F1DF507B'
GetEnsAddressParameters
OptionalblockThe balance of the account at a block tag.
OptionalblockThe balance of the account at a block number.
OptionalcoinENSIP-9 compliant coinType used to resolve addresses for other chains
OptionalgatewayUniversal Resolver gateway URLs to use for resolving CCIP-read requests.
Name to get the address for.
Optionalstrict?: booleanWhether or not to throw errors propagated from the ENS Universal Resolver Contract.
OptionaluniversalAddress of ENS Universal Resolver Contract.
Address for ENS name or null if not found. GetEnsAddressReturnType
Gets the avatar of an ENS name.
Calls getEnsText with key set to 'avatar'.
Since ENS names prohibit certain forbidden characters (e.g. underscore) and have other validation rules, you likely want to normalize ENS names with UTS-46 normalization before passing them to getEnsAddress. You can use the built-in normalize function for this.
import { createPublicClient, http } from 'viem'
import { mainnet } from 'viem/chains'
import { normalize } from 'viem/ens'
const client = createPublicClient({
chain: mainnet,
transport: http(),
})
const ensAvatar = await client.getEnsAvatar({
name: normalize('wevm.eth'),
})
// 'https://ipfs.io/ipfs/Qma8mnp6xV3J2cRNf3mTth5C8nV11CAnceVinc3y8jSbio'
GetEnsAvatarParameters
OptionalblockThe balance of the account at a block tag.
ENS name to get Text for.
OptionalblockThe balance of the account at a block number.
OptionalgatewayUniversal Resolver gateway URLs to use for resolving CCIP-read requests.
Optionalstrict?: booleanWhether or not to throw errors propagated from the ENS Universal Resolver Contract.
OptionaluniversalAddress of ENS Universal Resolver Contract.
OptionalassetGateway urls to resolve IPFS and/or Arweave assets.
Avatar URI or null if not found. GetEnsAvatarReturnType
Gets primary name for specified address.
Calls reverse(bytes) on ENS Universal Resolver Contract to "reverse resolve" the address to the primary ENS name.
import { createPublicClient, http } from 'viem'
import { mainnet } from 'viem/chains'
const client = createPublicClient({
chain: mainnet,
transport: http(),
})
const ensName = await client.getEnsName({
address: '0xd2135CfB216b74109775236E36d4b433F1DF507B',
})
// 'wevm.eth'
GetEnsNameParameters
OptionalblockThe balance of the account at a block tag.
OptionalblockThe balance of the account at a block number.
Address to get ENS name for.
OptionalgatewayUniversal Resolver gateway URLs to use for resolving CCIP-read requests.
Optionalstrict?: booleanWhether or not to throw errors propagated from the ENS Universal Resolver Contract.
OptionaluniversalAddress of ENS Universal Resolver Contract.
Name or null if not found. GetEnsNameReturnType
Gets resolver for ENS name.
Calls findResolver(bytes) on ENS Universal Resolver Contract to retrieve the resolver of an ENS name.
Since ENS names prohibit certain forbidden characters (e.g. underscore) and have other validation rules, you likely want to normalize ENS names with UTS-46 normalization before passing them to getEnsAddress. You can use the built-in normalize function for this.
import { createPublicClient, http } from 'viem'
import { mainnet } from 'viem/chains'
import { normalize } from 'viem/ens'
const client = createPublicClient({
chain: mainnet,
transport: http(),
})
const resolverAddress = await client.getEnsResolver({
name: normalize('wevm.eth'),
})
// '0x4976fb03C32e5B8cfe2b6cCB31c09Ba78EBaBa41'
GetEnsResolverParameters
OptionalblockThe balance of the account at a block tag.
OptionalblockThe balance of the account at a block number.
Name to get the address for.
OptionaluniversalAddress of ENS Universal Resolver Contract.
Address for ENS resolver. GetEnsResolverReturnType
Gets a text record for specified ENS name.
Calls resolve(bytes, bytes) on ENS Universal Resolver Contract.
Since ENS names prohibit certain forbidden characters (e.g. underscore) and have other validation rules, you likely want to normalize ENS names with UTS-46 normalization before passing them to getEnsAddress. You can use the built-in normalize function for this.
import { createPublicClient, http } from 'viem'
import { mainnet } from 'viem/chains'
import { normalize } from 'viem/ens'
const client = createPublicClient({
chain: mainnet,
transport: http(),
})
const twitterRecord = await client.getEnsText({
name: normalize('wevm.eth'),
key: 'com.twitter',
})
// 'wevm_dev'
GetEnsTextParameters
OptionalblockThe balance of the account at a block tag.
OptionalblockThe balance of the account at a block number.
ENS name to get Text for.
OptionalgatewayUniversal Resolver gateway URLs to use for resolving CCIP-read requests.
Text record to retrieve.
Optionalstrict?: booleanWhether or not to throw errors propagated from the ENS Universal Resolver Contract.
OptionaluniversalAddress of ENS Universal Resolver Contract.
Address for ENS resolver. GetEnsTextReturnType
Returns a collection of historical gas information.
eth_feeHistoryimport { createPublicClient, http } from 'viem'
import { mainnet } from 'viem/chains'
const client = createPublicClient({
chain: mainnet,
transport: http(),
})
const feeHistory = await client.getFeeHistory({
blockCount: 4,
rewardPercentiles: [25, 75],
})
GetFeeHistoryParameters
The gas estimate (in wei). GetFeeHistoryReturnType
Returns an estimate for the fees per gas for a transaction to be included in the next block.
import { createPublicClient, http } from 'viem'
import { mainnet } from 'viem/chains'
const client = createPublicClient({
chain: mainnet,
transport: http(),
})
const maxPriorityFeePerGas = await client.estimateFeesPerGas()
// { maxFeePerGas: ..., maxPriorityFeePerGas: ... }
Optionalargs: EstimateFeesPerGasParameters<undefined | Chain, chainOverride, type>An estimate (in wei) for the fees per gas. EstimateFeesPerGasReturnType
Returns a list of logs or hashes based on a Filter since the last time it was called.
eth_getFilterChangesA Filter can be created from the following actions:
Depending on the type of filter, the return value will be different:
createContractEventFilter or createEventFilter, it returns a list of logs.createPendingTransactionFilter, it returns a list of transaction hashes.createBlockFilter, it returns a list of block hashes.// Blocks
import { createPublicClient, http } from 'viem'
import { mainnet } from 'viem/chains'
const client = createPublicClient({
chain: mainnet,
transport: http(),
})
const filter = await client.createBlockFilter()
const hashes = await client.getFilterChanges({ filter })
// Contract Events
import { createPublicClient, http, parseAbi } from 'viem'
import { mainnet } from 'viem/chains'
const client = createPublicClient({
chain: mainnet,
transport: http(),
})
const filter = await client.createContractEventFilter({
address: '0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48',
abi: parseAbi(['event Transfer(address indexed, address indexed, uint256)']),
eventName: 'Transfer',
})
const logs = await client.getFilterChanges({ filter })
// Raw Events
import { createPublicClient, http, parseAbiItem } from 'viem'
import { mainnet } from 'viem/chains'
const client = createPublicClient({
chain: mainnet,
transport: http(),
})
const filter = await client.createEventFilter({
address: '0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48',
event: parseAbiItem('event Transfer(address indexed, address indexed, uint256)'),
})
const logs = await client.getFilterChanges({ filter })
// Transactions
import { createPublicClient, http } from 'viem'
import { mainnet } from 'viem/chains'
const client = createPublicClient({
chain: mainnet,
transport: http(),
})
const filter = await client.createPendingTransactionFilter()
const hashes = await client.getFilterChanges({ filter })
Logs or hashes. GetFilterChangesReturnType
Returns a list of event logs since the filter was created.
eth_getFilterLogsgetFilterLogs is only compatible with event filters.
import { createPublicClient, http, parseAbiItem } from 'viem'
import { mainnet } from 'viem/chains'
const client = createPublicClient({
chain: mainnet,
transport: http(),
})
const filter = await client.createEventFilter({
address: '0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48',
event: parseAbiItem('event Transfer(address indexed, address indexed, uint256)'),
})
const logs = await client.getFilterLogs({ filter })
Returns the current price of gas (in wei).
eth_gasPriceimport { createPublicClient, http } from 'viem'
import { mainnet } from 'viem/chains'
const client = createPublicClient({
chain: mainnet,
transport: http(),
})
const gasPrice = await client.getGasPrice()
The gas price (in wei). GetGasPriceReturnType
Returns a list of event logs matching the provided parameters.
eth_getLogsimport { createPublicClient, http, parseAbiItem } from 'viem'
import { mainnet } from 'viem/chains'
const client = createPublicClient({
chain: mainnet,
transport: http(),
})
const logs = await client.getLogs()
A list of event logs. GetLogsReturnType
Returns the account and storage values of the specified account including the Merkle-proof.
eth_getProofimport { createPublicClient, http } from 'viem'
import { mainnet } from 'viem/chains'
const client = createPublicClient({
chain: mainnet,
transport: http(),
})
const block = await client.getProof({
address: '0x...',
storageKeys: ['0x...'],
})
Proof data. GetProofReturnType
Returns an estimate for the max priority fee per gas (in wei) for a transaction to be included in the next block.
import { createPublicClient, http } from 'viem'
import { mainnet } from 'viem/chains'
const client = createPublicClient({
chain: mainnet,
transport: http(),
})
const maxPriorityFeePerGas = await client.estimateMaxPriorityFeePerGas()
// 10000000n
Optionalargs: { An estimate (in wei) for the max priority fee per gas. EstimateMaxPriorityFeePerGasReturnType
Returns the value from a storage slot at a given address.
eth_getStorageAtimport { createPublicClient, http } from 'viem'
import { mainnet } from 'viem/chains'
import { getStorageAt } from 'viem/contract'
const client = createPublicClient({
chain: mainnet,
transport: http(),
})
const code = await client.getStorageAt({
address: '0xFBA3912Ca04dd458c843e2EE08967fC04f3579c2',
slot: toHex(0),
})
GetStorageAtParameters
The value of the storage slot. GetStorageAtReturnType
Returns information about a Transaction given a hash or block identifier.
import { createPublicClient, http } from 'viem'
import { mainnet } from 'viem/chains'
const client = createPublicClient({
chain: mainnet,
transport: http(),
})
const transaction = await client.getTransaction({
hash: '0x4ca7ee652d57678f26e887c149ab0735f41de37bcad58c9f6d3ed5824f15b74d',
})
GetTransactionParameters
The transaction information. GetTransactionReturnType
Returns the number of blocks passed (confirmations) since the transaction was processed on a block.
import { createPublicClient, http } from 'viem'
import { mainnet } from 'viem/chains'
const client = createPublicClient({
chain: mainnet,
transport: http(),
})
const confirmations = await client.getTransactionConfirmations({
hash: '0x4ca7ee652d57678f26e887c149ab0735f41de37bcad58c9f6d3ed5824f15b74d',
})
GetTransactionConfirmationsParameters
The number of blocks passed since the transaction was processed. If confirmations is 0, then the Transaction has not been confirmed & processed yet. GetTransactionConfirmationsReturnType
Returns the number of Transactions an Account has broadcast / sent.
eth_getTransactionCountimport { createPublicClient, http } from 'viem'
import { mainnet } from 'viem/chains'
const client = createPublicClient({
chain: mainnet,
transport: http(),
})
const transactionCount = await client.getTransactionCount({
address: '0xA0Cf798816D4b9b9866b5330EEa46a18382f251e',
})
GetTransactionCountParameters
The number of transactions an account has sent. GetTransactionCountReturnType
Returns the Transaction Receipt given a Transaction hash.
import { createPublicClient, http } from 'viem'
import { mainnet } from 'viem/chains'
const client = createPublicClient({
chain: mainnet,
transport: http(),
})
const transactionReceipt = await client.getTransactionReceipt({
hash: '0x4ca7ee652d57678f26e887c149ab0735f41de37bcad58c9f6d3ed5824f15b74d',
})
GetTransactionReceiptParameters
The transaction receipt. GetTransactionReceiptReturnType
Similar to readContract, but batches up multiple functions on a contract in a single RPC call via the multicall3 contract.
import { createPublicClient, http, parseAbi } from 'viem'
import { mainnet } from 'viem/chains'
const client = createPublicClient({
chain: mainnet,
transport: http(),
})
const abi = parseAbi([
'function balanceOf(address) view returns (uint256)',
'function totalSupply() view returns (uint256)',
])
const result = await client.multicall({
contracts: [
{
address: '0xFBA3912Ca04dd458c843e2EE08967fC04f3579c2',
abi,
functionName: 'balanceOf',
args: ['0xA0Cf798816D4b9b9866b5330EEa46a18382f251e'],
},
{
address: '0xFBA3912Ca04dd458c843e2EE08967fC04f3579c2',
abi,
functionName: 'totalSupply',
},
],
})
// [{ result: 424122n, status: 'success' }, { result: 1000000n, status: 'success' }]
MulticallParameters
An array of results with accompanying status. MulticallReturnType
Prepares a transaction request for signing.
import { createWalletClient, custom } from 'viem'
import { mainnet } from 'viem/chains'
const client = createWalletClient({
chain: mainnet,
transport: custom(window.ethereum),
})
const request = await client.prepareTransactionRequest({
account: '0xA0Cf798816D4b9b9866b5330EEa46a18382f251e',
to: '0x0000000000000000000000000000000000000000',
value: 1n,
})
// Account Hoisting
import { createWalletClient, http } from 'viem'
import { privateKeyToAccount } from 'viem/accounts'
import { mainnet } from 'viem/chains'
const client = createWalletClient({
account: privateKeyToAccount('0x…'),
chain: mainnet,
transport: custom(window.ethereum),
})
const request = await client.prepareTransactionRequest({
to: '0x0000000000000000000000000000000000000000',
value: 1n,
})
PrepareTransactionRequestParameters
The transaction request. PrepareTransactionRequestReturnType
Calls a read-only function on a contract, and returns the response.
A "read-only" function (constant function) on a Solidity contract is denoted by a view or pure keyword. They can only read the state of the contract, and cannot make any changes to it. Since read-only methods do not change the state of the contract, they do not require any gas to be executed, and can be called by any user without the need to pay for gas.
Internally, uses a Public Client to call the call action with ABI-encoded data.
import { createPublicClient, http, parseAbi } from 'viem'
import { mainnet } from 'viem/chains'
import { readContract } from 'viem/contract'
const client = createPublicClient({
chain: mainnet,
transport: http(),
})
const result = await client.readContract({
address: '0xFBA3912Ca04dd458c843e2EE08967fC04f3579c2',
abi: parseAbi(['function balanceOf(address) view returns (uint256)']),
functionName: 'balanceOf',
args: ['0xA0Cf798816D4b9b9866b5330EEa46a18382f251e'],
})
// 424122n
ReadContractParameters
The response from the contract. Type is inferred. ReadContractReturnType
Sends a signed transaction to the network
eth_sendRawTransactionimport { createWalletClient, custom } from 'viem'
import { mainnet } from 'viem/chains'
import { sendRawTransaction } from 'viem/wallet'
const client = createWalletClient({
chain: mainnet,
transport: custom(window.ethereum),
})
const hash = await client.sendRawTransaction({
serializedTransaction: '0x02f850018203118080825208808080c080a04012522854168b27e5dc3d5839bab5e6b39e1a0ffd343901ce1622e3d64b48f1a04e00902ae0502c4728cbf12156290df99c3ed7de85b1dbfe20b5c36931733a33'
})
The transaction hash. SendRawTransactionReturnType
Simulates/validates a contract interaction. This is useful for retrieving return data and revert reasons of contract write functions.
This function does not require gas to execute and does not change the state of the blockchain. It is almost identical to readContract, but also supports contract write functions.
Internally, uses a Public Client to call the call action with ABI-encoded data.
import { createPublicClient, http } from 'viem'
import { mainnet } from 'viem/chains'
const client = createPublicClient({
chain: mainnet,
transport: http(),
})
const result = await client.simulateContract({
address: '0xFBA3912Ca04dd458c843e2EE08967fC04f3579c2',
abi: parseAbi(['function mint(uint32) view returns (uint32)']),
functionName: 'mint',
args: ['69420'],
account: '0xA0Cf798816D4b9b9866b5330EEa46a18382f251e',
})
SimulateContractParameters
The simulation result and write request. SimulateContractReturnType
Verify that a message was signed by the provided address.
Compatible with Smart Contract Accounts & Externally Owned Accounts via ERC-6492.
The address that signed the original message.
The signature that was generated by signing the message with the address's private key.
OptionalblockThe balance of the account at a block tag.
OptionalblockThe balance of the account at a block number.
Optionalfactory?: `0x${string}`OptionalfactoryThe message to be verified.
Whether or not the signature is valid. VerifyMessageReturnType
Verifies EIP-4361 formatted message was signed.
Compatible with Smart Contract Accounts & Externally Owned Accounts via ERC-6492.
OptionalblockThe balance of the account at a block tag.
OptionalblockThe balance of the account at a block number.
Optionaladdress?: `0x${string}`Ethereum address to check against.
Optionalnonce?: stringRandom string to check against.
Optionaldomain?: stringRFC 3986 authority to check against.
Optionalscheme?: stringRFC 3986 URI scheme to check against.
Optionaltime?: DateCurrent time to check optional expirationTime and notBefore fields.
EIP-4361 formatted message.
Signature to check against.
Whether or not the signature is valid. VerifySiweMessageReturnType
Verify that typed data was signed by the provided address.
Whether or not the signature is valid. VerifyTypedDataReturnType
Destroys a Filter that was created from one of the following Actions:
import { createPublicClient, http } from 'viem'
import { mainnet } from 'viem/chains'
import { createPendingTransactionFilter, uninstallFilter } from 'viem/public'
const filter = await client.createPendingTransactionFilter()
const uninstalled = await client.uninstallFilter({ filter })
// true
UninstallFilterParameters
A boolean indicating if the Filter was successfully uninstalled. UninstallFilterReturnType
Waits for the Transaction to be included on a Block (one confirmation), and then returns the Transaction Receipt. If the Transaction reverts, then the action will throw an error.
eth_getTransactionReceipt on each block until it has been processed.eth_getBlockByNumber and extracts the transactionseth_getTransactionReceipt.The waitForTransactionReceipt action additionally supports Replacement detection (e.g. sped up Transactions).
Transactions can be replaced when a user modifies their transaction in their wallet (to speed up or cancel). Transactions are replaced when they are sent from the same nonce.
There are 3 types of Transaction Replacement reasons:
repriced: The gas price has been modified (e.g. different maxFeePerGas)cancelled: The Transaction has been cancelled (e.g. value === 0n)replaced: The Transaction has been replaced (e.g. different value or data)import { createPublicClient, http } from 'viem'
import { mainnet } from 'viem/chains'
const client = createPublicClient({
chain: mainnet,
transport: http(),
})
const transactionReceipt = await client.waitForTransactionReceipt({
hash: '0x4ca7ee652d57678f26e887c149ab0735f41de37bcad58c9f6d3ed5824f15b74d',
})
WaitForTransactionReceiptParameters
The transaction receipt. WaitForTransactionReceiptReturnType
Watches and returns incoming block numbers.
poll: true, calls eth_blockNumber on a polling interval.poll: false & WebSocket Transport, uses a WebSocket subscription via eth_subscribe and the "newHeads" event.import { createPublicClient, http } from 'viem'
import { mainnet } from 'viem/chains'
const client = createPublicClient({
chain: mainnet,
transport: http(),
})
const unwatch = await client.watchBlockNumber({
onBlockNumber: (blockNumber) => console.log(blockNumber),
})
WatchBlockNumberParameters
A function that can be invoked to stop watching for new block numbers. WatchBlockNumberReturnType
Watches and returns information for incoming blocks.
poll: true, calls eth_getBlockByNumber on a polling interval.poll: false & WebSocket Transport, uses a WebSocket subscription via eth_subscribe and the "newHeads" event.import { createPublicClient, http } from 'viem'
import { mainnet } from 'viem/chains'
const client = createPublicClient({
chain: mainnet,
transport: http(),
})
const unwatch = await client.watchBlocks({
onBlock: (block) => console.log(block),
})
WatchBlocksParameters
A function that can be invoked to stop watching for new block numbers. WatchBlocksReturnType
Watches and returns emitted contract event logs.
This Action will batch up all the event logs found within the pollingInterval, and invoke them via onLogs.
watchContractEvent will attempt to create an Event Filter and listen to changes to the Filter per polling interval, however, if the RPC Provider does not support Filters (e.g. eth_newFilter), then watchContractEvent will fall back to using getLogs instead.
import { createPublicClient, http, parseAbi } from 'viem'
import { mainnet } from 'viem/chains'
const client = createPublicClient({
chain: mainnet,
transport: http(),
})
const unwatch = client.watchContractEvent({
address: '0xFBA3912Ca04dd458c843e2EE08967fC04f3579c2',
abi: parseAbi(['event Transfer(address indexed from, address indexed to, uint256 value)']),
eventName: 'Transfer',
args: { from: '0xc961145a54C96E3aE9bAA048c4F4D6b04C13916b' },
onLogs: (logs) => console.log(logs),
})
Watches and returns emitted Event Logs.
eth_newFilter:
eth_newFilter to create a filter (called on initialize).eth_getFilterChanges.eth_newFilter:
eth_getLogs for each block between the polling interval.This Action will batch up all the Event Logs found within the pollingInterval, and invoke them via onLogs.
watchEvent will attempt to create an Event Filter and listen to changes to the Filter per polling interval, however, if the RPC Provider does not support Filters (e.g. eth_newFilter), then watchEvent will fall back to using getLogs instead.
import { createPublicClient, http } from 'viem'
import { mainnet } from 'viem/chains'
const client = createPublicClient({
chain: mainnet,
transport: http(),
})
const unwatch = client.watchEvent({
onLogs: (logs) => console.log(logs),
})
Watches and returns pending transaction hashes.
poll: true
eth_newPendingTransactionFilter to initialize the filter.eth_getFilterChanges on a polling interval.poll: false & WebSocket Transport, uses a WebSocket subscription via eth_subscribe and the "newPendingTransactions" event.This Action will batch up all the pending transactions found within the pollingInterval, and invoke them via onTransactions.
import { createPublicClient, http } from 'viem'
import { mainnet } from 'viem/chains'
const client = createPublicClient({
chain: mainnet,
transport: http(),
})
const unwatch = await client.watchPendingTransactions({
onTransactions: (hashes) => console.log(hashes),
})
WatchPendingTransactionsParameters
A function that can be invoked to stop watching for new pending transaction hashes. WatchPendingTransactionsReturnType
OptionalnonceSpace: bigint
When we retrieve a nonce for a smart contract wallet we can retrieve the nonce in a given 256 bit space. Nonces in each 256 bit space need to be sequential per wallet address. Nonces across 256 bit spaces per wallet address do not. This function overload can be used to invoke transactions in parallel per smart contract wallet if required.