Constructs a new SemaphoreViem instance, initializing it with a network or a custom Ethereum node URL, and optional configuration settings for the viem client and contract.
The Ethereum network name or a custom JSON-RPC URL to connect to.
Configuration options for the viem client and the Semaphore contract.
Private _clientThe Account of the Client.
Optional batch?: { Flags for batch settings.
Optional multicall?: boolean | { Toggle to enable eth_call multicall aggregation.
Time (in ms) that cached data will remain in memory.
Executes a new message call immediately without submitting a transaction to the network.
eth_callThe call data. CallReturnType
import { 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',
})
Optional ccipCCIP Read configuration.
Chain for the client.
Creates an EIP-2930 access list that you can include in a transaction.
eth_createAccessListThe call data. CreateAccessListReturnType
import { createPublicClient, http } from 'viem'
import { mainnet } from 'viem/chains'
const client = createPublicClient({
chain: mainnet,
transport: http(),
})
const data = await client.createAccessList({
data: '0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2',
to: '0x70997970c51812dc3a010c7d01b50e0d17dc79c8',
})
Creates a Filter to listen for new block hashes that can be used with getFilterChanges.
eth_newBlockFilterFilter. CreateBlockFilterReturnType
import { 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' }
Creates a Filter to retrieve event logs that can be used with getFilterChanges or getFilterLogs.
Filter. CreateContractEventFilterReturnType
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)']),
})
Creates a Filter to listen for new events that can be used with getFilterChanges.
eth_newFilterFilter. CreateEventFilterReturnType
import { createPublicClient, http } from 'viem'
import { mainnet } from 'viem/chains'
const client = createPublicClient({
chain: mainnet,
transport: http(),
})
const filter = await client.createEventFilter({
address: '0xfba3912ca04dd458c843e2ee08967fc04f3579c2',
})
Creates a Filter to listen for new pending transaction hashes that can be used with getFilterChanges.
eth_newPendingTransactionFilterFilter. CreateBlockFilterReturnType
import { 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' }
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.
The gas estimate (in wei). EstimateContractGasReturnType
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
Returns an estimate for the fees per gas for a transaction to be included in the next block.
An estimate (in wei) for the fees per gas. EstimateFeesPerGasReturnType
import { createPublicClient, http } from 'viem'
import { mainnet } from 'viem/chains'
const client = createPublicClient({
chain: mainnet,
transport: http(),
})
const maxPriorityFeePerGas = await client.estimateFeesPerGas()
// { maxFeePerGas: ..., maxPriorityFeePerGas: ... }
Optional args: EstimateFeesPerGasParameters<undefined | Chain, chainOverride, type>Estimates the gas necessary to complete a transaction without submitting it to the network.
eth_estimateGasThe gas estimate (in wei). EstimateGasReturnType
import { 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
Returns an estimate for the max priority fee per gas (in wei) for a transaction to be included in the next block.
An estimate (in wei) for the max priority fee per gas. EstimateMaxPriorityFeePerGasReturnType
import { createPublicClient, http } from 'viem'
import { mainnet } from 'viem/chains'
const client = createPublicClient({
chain: mainnet,
transport: http(),
})
const maxPriorityFeePerGas = await client.estimateMaxPriorityFeePerGas()
// 10000000n
Optional args: { 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"
The balance of the address in wei. GetBalanceReturnType
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
Returns the base fee per blob gas in wei.
eth_blobBaseFeeThe blob base fee (in wei). GetBlobBaseFeeReturnType
import { 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()
Returns information about a block at a block number, hash, or tag.
eth_getBlockByNumber for blockNumber & blockTag.eth_getBlockByHash for blockHash.Information about the block. GetBlockReturnType
import { createPublicClient, http } from 'viem'
import { mainnet } from 'viem/chains'
const client = createPublicClient({
chain: mainnet,
transport: http(),
})
const block = await client.getBlock()
Optional args: GetBlockParameters<includeTransactions, blockTag>GetBlockParameters
Returns the number of the most recent block seen.
The number of the block. GetBlockNumberReturnType
import { createPublicClient, http } from 'viem'
import { mainnet } from 'viem/chains'
const client = createPublicClient({
chain: mainnet,
transport: http(),
})
const blockNumber = await client.getBlockNumber()
// 69420n
Optional args: GetBlockNumberParametersGetBlockNumberParameters
Returns the number of Transactions at a block number, hash, or tag.
eth_getBlockTransactionCountByNumber for blockNumber & blockTag.eth_getBlockTransactionCountByHash for blockHash.The block transaction count. GetBlockTransactionCountReturnType
import { createPublicClient, http } from 'viem'
import { mainnet } from 'viem/chains'
const client = createPublicClient({
chain: mainnet,
transport: http(),
})
const count = await client.getBlockTransactionCount()
Optional args: GetBlockTransactionCountParametersGetBlockTransactionCountParameters
Use getCode instead.
Returns the chain ID associated with the current network.
eth_chainIdThe current chain ID. GetChainIdReturnType
import { createPublicClient, http } from 'viem'
import { mainnet } from 'viem/chains'
const client = createPublicClient({
chain: mainnet,
transport: http(),
})
const chainId = await client.getChainId()
// 1
Retrieves the bytecode at an address.
eth_getCodeThe contract's bytecode. GetBytecodeReturnType
import { createPublicClient, http } from 'viem'
import { mainnet } from 'viem/chains'
const client = createPublicClient({
chain: mainnet,
transport: http(),
})
const code = await client.getCode({
address: '0xFBA3912Ca04dd458c843e2EE08967fC04f3579c2',
})
GetBytecodeParameters
Returns a list of event logs emitted by a contract.
eth_getLogsA list of event logs. GetContractEventsReturnType
import { 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.
The EIP-712 domain, fields, and extensions. GetEip712DomainReturnType
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: [],
// }
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.
Address for ENS name or null if not found. GetEnsAddressReturnType
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
Optional blockThe balance of the account at a block number.
Optional blockThe balance of the account at a block tag.
'latest'
Optional coinENSIP-9 compliant coinType used to resolve addresses for other chains
Optional gatewayUniversal Resolver gateway URLs to use for resolving CCIP-read requests.
Name to get the address for.
Optional strict?: booleanWhether or not to throw errors propagated from the ENS Universal Resolver Contract.
Optional universalAddress of ENS Universal Resolver Contract.
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.
Avatar URI or null if not found. GetEnsAvatarReturnType
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
Optional assetGateway urls to resolve IPFS and/or Arweave assets.
Optional blockThe balance of the account at a block number.
Optional blockThe balance of the account at a block tag.
'latest'
Optional gatewayUniversal Resolver gateway URLs to use for resolving CCIP-read requests.
ENS name to get Text for.
Optional strict?: booleanWhether or not to throw errors propagated from the ENS Universal Resolver Contract.
Optional universalAddress of ENS Universal Resolver Contract.
Gets primary name for specified address.
Calls reverse(bytes) on ENS Universal Resolver Contract to "reverse resolve" the address to the primary ENS name.
Name or null if not found. GetEnsNameReturnType
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
Address to get ENS name for.
Optional blockThe balance of the account at a block number.
Optional blockThe balance of the account at a block tag.
'latest'
Optional gatewayUniversal Resolver gateway URLs to use for resolving CCIP-read requests.
Optional strict?: booleanWhether or not to throw errors propagated from the ENS Universal Resolver Contract.
Optional universalAddress of ENS Universal Resolver Contract.
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.
Address for ENS resolver. GetEnsResolverReturnType
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
Optional blockThe balance of the account at a block number.
Optional blockThe balance of the account at a block tag.
'latest'
Name to get the address for.
Optional universalAddress of ENS Universal Resolver Contract.
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.
Address for ENS resolver. GetEnsTextReturnType
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
Optional blockThe balance of the account at a block number.
Optional blockThe balance of the account at a block tag.
'latest'
Optional gatewayUniversal Resolver gateway URLs to use for resolving CCIP-read requests.
Text record to retrieve.
ENS name to get Text for.
Optional strict?: booleanWhether or not to throw errors propagated from the ENS Universal Resolver Contract.
Optional universalAddress of ENS Universal Resolver Contract.
Returns a collection of historical gas information.
eth_feeHistoryThe gas estimate (in wei). GetFeeHistoryReturnType
import { 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
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.Logs or hashes. GetFilterChangesReturnType
// 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 })
Returns a list of event logs since the filter was created.
eth_getFilterLogsgetFilterLogs is only compatible with event filters.
A list of event logs. GetFilterLogsReturnType
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_gasPriceThe gas price (in wei). GetGasPriceReturnType
import { createPublicClient, http } from 'viem'
import { mainnet } from 'viem/chains'
const client = createPublicClient({
chain: mainnet,
transport: http(),
})
const gasPrice = await client.getGasPrice()
Returns a list of event logs matching the provided parameters.
eth_getLogsA list of event logs. GetLogsReturnType
import { createPublicClient, http, parseAbiItem } from 'viem'
import { mainnet } from 'viem/chains'
const client = createPublicClient({
chain: mainnet,
transport: http(),
})
const logs = await client.getLogs()
Returns the account and storage values of the specified account including the Merkle-proof.
eth_getProofProof data. GetProofReturnType
import { 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...'],
})
Returns the value from a storage slot at a given address.
eth_getStorageAtThe value of the storage slot. GetStorageAtReturnType
import { 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
Returns information about a Transaction given a hash or block identifier.
The transaction information. GetTransactionReturnType
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
Returns the number of blocks passed (confirmations) since the transaction was processed on a block.
The number of blocks passed since the transaction was processed. If confirmations is 0, then the Transaction has not been confirmed & processed yet. GetTransactionConfirmationsReturnType
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
Returns the number of Transactions an Account has broadcast / sent.
eth_getTransactionCountThe number of transactions an account has sent. GetTransactionCountReturnType
import { createPublicClient, http } from 'viem'
import { mainnet } from 'viem/chains'
const client = createPublicClient({
chain: mainnet,
transport: http(),
})
const transactionCount = await client.getTransactionCount({
address: '0xA0Cf798816D4b9b9866b5330EEa46a18382f251e',
})
GetTransactionCountParameters
Returns the Transaction Receipt given a Transaction hash.
The transaction receipt. GetTransactionReceiptReturnType
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
A key for the client.
Similar to readContract, but batches up multiple functions on a contract in a single RPC call via the multicall3 contract.
An array of results with accompanying status. MulticallReturnType
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
A name for the client.
Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds.
Prepares a transaction request for signing.
The transaction request. PrepareTransactionRequestReturnType
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
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.
The response from the contract. Type is inferred. ReadContractReturnType
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
Request function wrapped with friendly error handling
Sends a signed transaction to the network
eth_sendRawTransactionThe transaction hash. SendRawTransactionReturnType
import { 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'
})
Use simulateBlocks instead.
Simulates a set of calls on block(s) with optional block and state overrides.
import { createPublicClient, http, parseEther } from 'viem'
import { mainnet } from 'viem/chains'
const client = createPublicClient({
chain: mainnet,
transport: http(),
})
const result = await client.simulateBlocks({
blocks: [{
blockOverrides: {
number: 69420n,
},
calls: [{
{
account: '0x5a0b54d5dc17e482fe8b0bdca5320161b95fb929',
data: '0xdeadbeef',
to: '0x70997970c51812dc3a010c7d01b50e0d17dc79c8',
},
{
account: '0x5a0b54d5dc17e482fe8b0bdca5320161b95fb929',
to: '0x70997970c51812dc3a010c7d01b50e0d17dc79c8',
value: parseEther('1'),
},
}],
stateOverrides: [{
address: '0x5a0b54d5dc17e482fe8b0bdca5320161b95fb929',
balance: parseEther('10'),
}],
}]
})
Simulated blocks. SimulateReturnType
Simulates a set of calls.
import { createPublicClient, http, parseEther } from 'viem'
import { mainnet } from 'viem/chains'
const client = createPublicClient({
chain: mainnet,
transport: http(),
})
const result = await client.simulateCalls({
account: '0x5a0b54d5dc17e482fe8b0bdca5320161b95fb929',
calls: [{
{
data: '0xdeadbeef',
to: '0x70997970c51812dc3a010c7d01b50e0d17dc79c8',
},
{
to: '0x70997970c51812dc3a010c7d01b50e0d17dc79c8',
value: parseEther('1'),
},
]
})
Results. SimulateCallsReturnType
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.
The simulation result and write request. SimulateContractReturnType
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 RPC transport
The type of client.
A unique ID for the client.
Destroys a Filter that was created from one of the following Actions:
A boolean indicating if the Filter was successfully uninstalled. UninstallFilterReturnType
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
Verify that a message was signed by the provided address.
Compatible with Smart Contract Accounts & Externally Owned Accounts via ERC-6492.
Whether or not the signature is valid. VerifyMessageReturnType
The address that signed the original message.
Optional blockThe balance of the account at a block number.
Optional blockThe balance of the account at a block tag.
'latest'
Optional factory?: `0x${string}`Optional factoryThe message to be verified.
The signature that was generated by signing the message with the address's private key.
Optional universalVerifies EIP-4361 formatted message was signed.
Compatible with Smart Contract Accounts & Externally Owned Accounts via ERC-6492.
Whether or not the signature is valid. VerifySiweMessageReturnType
Optional address?: `0x${string}`Ethereum address to check against.
Optional blockThe balance of the account at a block number.
Optional blockThe balance of the account at a block tag.
'latest'
Optional domain?: stringRFC 3986 authority to check against.
EIP-4361 formatted message.
Optional nonce?: stringRandom string to check against.
Optional scheme?: stringRFC 3986 URI scheme to check against.
Signature to check against.
Optional time?: DateCurrent time to check optional expirationTime and notBefore fields.
new Date()
Verify that typed data was signed by the provided address.
Whether or not the signature is valid. VerifyTypedDataReturnType
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)The transaction receipt. WaitForTransactionReceiptReturnType
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
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.A function that can be invoked to stop watching for new block numbers. WatchBlockNumberReturnType
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
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.A function that can be invoked to stop watching for new block numbers. WatchBlocksReturnType
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
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.
A function that can be invoked to stop watching for new event logs. WatchContractEventReturnType
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.
A function that can be invoked to stop watching for new Event Logs. WatchEventReturnType
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: trueeth_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.
A function that can be invoked to stop watching for new pending transaction hashes. WatchPendingTransactionsReturnType
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
Private _contractCreates a Filter to retrieve event logs that can be used with getFilterChanges or getFilterLogs.
import { createPublicClient, getContract, http, parseAbi } from 'viem'
import { mainnet } from 'viem/chains'
const publicClient = createPublicClient({
chain: mainnet,
transport: http(),
})
const contract = getContract({
address: '0xFBA3912Ca04dd458c843e2EE08967fC04f3579c2',
abi: parseAbi(['event Transfer(address indexed, address indexed, uint256)']),
client: publicClient,
})
const filter = await contract.createEventFilter.Transfer()
Estimates the gas necessary to complete a transaction without submitting it to the network.
import { createPublicClient, getContract, http, parseAbi } from 'viem'
import { mainnet } from 'viem/chains'
const publicClient = createPublicClient({
chain: mainnet,
transport: http(),
})
const contract = getContract({
address: '0xFBA3912Ca04dd458c843e2EE08967fC04f3579c2',
abi: parseAbi(['function mint() public']),
client: publicClient,
})
const gas = await contract.estimateGas.mint({
account: '0xf39fd6e51aad88f6f4ce6ab8827279cfffb92266',
})
Creates a Filter to retrieve event logs that can be used with getFilterChanges or getFilterLogs.
import { createPublicClient, getContract, http, parseAbi } from 'viem'
import { mainnet } from 'viem/chains'
const publicClient = createPublicClient({
chain: mainnet,
transport: http(),
})
const contract = getContract({
address: '0xFBA3912Ca04dd458c843e2EE08967fC04f3579c2',
abi: parseAbi(['event Transfer(address indexed, address indexed, uint256)']),
client: publicClient,
})
const filter = await contract.createEventFilter.Transfer()
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, read uses a Public Client to call the call action with ABI-encoded data.
import { createPublicClient, getContract, http, parseAbi } from 'viem'
import { mainnet } from 'viem/chains'
const publicClient = createPublicClient({
chain: mainnet,
transport: http(),
})
const contract = getContract({
address: '0xFBA3912Ca04dd458c843e2EE08967fC04f3579c2',
abi: parseAbi([
'function balanceOf(address owner) view returns (uint256)',
]),
client: publicClient,
})
const result = await contract.read.balanceOf(['0xA0Cf798816D4b9b9866b5330EEa46a18382f251e'])
// 424122n
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, simulate uses a Public Client to call the call action with ABI-encoded data.
import { createPublicClient, getContract, http, parseAbi } from 'viem'
import { mainnet } from 'viem/chains'
const publicClient = createPublicClient({
chain: mainnet,
transport: http(),
})
const contract = getContract({
address: '0xFBA3912Ca04dd458c843e2EE08967fC04f3579c2',
abi: parseAbi(['function mint() public']),
client: publicClient,
})
const result = await contract.simulate.mint({
account: '0xf39fd6e51aad88f6f4ce6ab8827279cfffb92266',
})
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.
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, getContract, http, parseAbi } from 'viem'
import { mainnet } from 'viem/chains'
const publicClient = createPublicClient({
chain: mainnet,
transport: http(),
})
const contract = getContract({
address: '0xFBA3912Ca04dd458c843e2EE08967fC04f3579c2',
abi: parseAbi(['event Transfer(address indexed, address indexed, uint256)']),
client: publicClient,
})
const filter = await contract.createEventFilter.Transfer()
const unwatch = contract.watchEvent.Transfer(
{ from: '0xc961145a54C96E3aE9bAA048c4F4D6b04C13916b' },
{ onLogs: (logs) => console.log(logs) },
)
Executes a write function on a contract.
A "write" function on a Solidity contract modifies the state of the blockchain. These types of functions require gas to be executed, and hence a Transaction is needed to be broadcast in order to change the state.
Internally, write uses a Wallet Client to call the sendTransaction action with ABI-encoded data.
Warning: The write internally sends a transaction – it does not validate if the contract write will succeed (the contract may throw an error). It is highly recommended to simulate the contract write with contract.simulate before you execute it.
import { createWalletClient, getContract, http, parseAbi } from 'viem'
import { mainnet } from 'viem/chains'
const walletClient = createWalletClient({
chain: mainnet,
transport: http(),
})
const contract = getContract({
address: '0xFBA3912Ca04dd458c843e2EE08967fC04f3579c2',
abi: parseAbi(['function mint(uint32 tokenId) nonpayable']),
client: walletClient,
})
const hash = await contract.write.min([69420], {
address: '0xFBA3912Ca04dd458c843e2EE08967fC04f3579c2',
})
Private _networkPrivate _optionsRetrieves the viem Public Client instance used to interact with the blockchain.
The Public Client instance.
The Account of the Client.
Optional batch?: { Flags for batch settings.
Optional multicall?: boolean | { Toggle to enable eth_call multicall aggregation.
Time (in ms) that cached data will remain in memory.
Executes a new message call immediately without submitting a transaction to the network.
eth_callThe call data. CallReturnType
import { 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',
})
Optional ccipCCIP Read configuration.
Chain for the client.
Creates an EIP-2930 access list that you can include in a transaction.
eth_createAccessListThe call data. CreateAccessListReturnType
import { createPublicClient, http } from 'viem'
import { mainnet } from 'viem/chains'
const client = createPublicClient({
chain: mainnet,
transport: http(),
})
const data = await client.createAccessList({
data: '0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2',
to: '0x70997970c51812dc3a010c7d01b50e0d17dc79c8',
})
Creates a Filter to listen for new block hashes that can be used with getFilterChanges.
eth_newBlockFilterFilter. CreateBlockFilterReturnType
import { 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' }
Creates a Filter to retrieve event logs that can be used with getFilterChanges or getFilterLogs.
Filter. CreateContractEventFilterReturnType
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)']),
})
Creates a Filter to listen for new events that can be used with getFilterChanges.
eth_newFilterFilter. CreateEventFilterReturnType
import { createPublicClient, http } from 'viem'
import { mainnet } from 'viem/chains'
const client = createPublicClient({
chain: mainnet,
transport: http(),
})
const filter = await client.createEventFilter({
address: '0xfba3912ca04dd458c843e2ee08967fc04f3579c2',
})
Creates a Filter to listen for new pending transaction hashes that can be used with getFilterChanges.
eth_newPendingTransactionFilterFilter. CreateBlockFilterReturnType
import { 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' }
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.
The gas estimate (in wei). EstimateContractGasReturnType
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
Returns an estimate for the fees per gas for a transaction to be included in the next block.
An estimate (in wei) for the fees per gas. EstimateFeesPerGasReturnType
import { createPublicClient, http } from 'viem'
import { mainnet } from 'viem/chains'
const client = createPublicClient({
chain: mainnet,
transport: http(),
})
const maxPriorityFeePerGas = await client.estimateFeesPerGas()
// { maxFeePerGas: ..., maxPriorityFeePerGas: ... }
Optional args: EstimateFeesPerGasParameters<undefined | Chain, chainOverride, type>Estimates the gas necessary to complete a transaction without submitting it to the network.
eth_estimateGasThe gas estimate (in wei). EstimateGasReturnType
import { 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
Returns an estimate for the max priority fee per gas (in wei) for a transaction to be included in the next block.
An estimate (in wei) for the max priority fee per gas. EstimateMaxPriorityFeePerGasReturnType
import { createPublicClient, http } from 'viem'
import { mainnet } from 'viem/chains'
const client = createPublicClient({
chain: mainnet,
transport: http(),
})
const maxPriorityFeePerGas = await client.estimateMaxPriorityFeePerGas()
// 10000000n
Optional args: { 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"
The balance of the address in wei. GetBalanceReturnType
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
Returns the base fee per blob gas in wei.
eth_blobBaseFeeThe blob base fee (in wei). GetBlobBaseFeeReturnType
import { 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()
Returns information about a block at a block number, hash, or tag.
eth_getBlockByNumber for blockNumber & blockTag.eth_getBlockByHash for blockHash.Information about the block. GetBlockReturnType
import { createPublicClient, http } from 'viem'
import { mainnet } from 'viem/chains'
const client = createPublicClient({
chain: mainnet,
transport: http(),
})
const block = await client.getBlock()
Optional args: GetBlockParameters<includeTransactions, blockTag>GetBlockParameters
Returns the number of the most recent block seen.
The number of the block. GetBlockNumberReturnType
import { createPublicClient, http } from 'viem'
import { mainnet } from 'viem/chains'
const client = createPublicClient({
chain: mainnet,
transport: http(),
})
const blockNumber = await client.getBlockNumber()
// 69420n
Optional args: GetBlockNumberParametersGetBlockNumberParameters
Returns the number of Transactions at a block number, hash, or tag.
eth_getBlockTransactionCountByNumber for blockNumber & blockTag.eth_getBlockTransactionCountByHash for blockHash.The block transaction count. GetBlockTransactionCountReturnType
import { createPublicClient, http } from 'viem'
import { mainnet } from 'viem/chains'
const client = createPublicClient({
chain: mainnet,
transport: http(),
})
const count = await client.getBlockTransactionCount()
Optional args: GetBlockTransactionCountParametersGetBlockTransactionCountParameters
Use getCode instead.
Returns the chain ID associated with the current network.
eth_chainIdThe current chain ID. GetChainIdReturnType
import { createPublicClient, http } from 'viem'
import { mainnet } from 'viem/chains'
const client = createPublicClient({
chain: mainnet,
transport: http(),
})
const chainId = await client.getChainId()
// 1
Retrieves the bytecode at an address.
eth_getCodeThe contract's bytecode. GetBytecodeReturnType
import { createPublicClient, http } from 'viem'
import { mainnet } from 'viem/chains'
const client = createPublicClient({
chain: mainnet,
transport: http(),
})
const code = await client.getCode({
address: '0xFBA3912Ca04dd458c843e2EE08967fC04f3579c2',
})
GetBytecodeParameters
Returns a list of event logs emitted by a contract.
eth_getLogsA list of event logs. GetContractEventsReturnType
import { 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.
The EIP-712 domain, fields, and extensions. GetEip712DomainReturnType
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: [],
// }
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.
Address for ENS name or null if not found. GetEnsAddressReturnType
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
Optional blockThe balance of the account at a block number.
Optional blockThe balance of the account at a block tag.
'latest'
Optional coinENSIP-9 compliant coinType used to resolve addresses for other chains
Optional gatewayUniversal Resolver gateway URLs to use for resolving CCIP-read requests.
Name to get the address for.
Optional strict?: booleanWhether or not to throw errors propagated from the ENS Universal Resolver Contract.
Optional universalAddress of ENS Universal Resolver Contract.
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.
Avatar URI or null if not found. GetEnsAvatarReturnType
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
Optional assetGateway urls to resolve IPFS and/or Arweave assets.
Optional blockThe balance of the account at a block number.
Optional blockThe balance of the account at a block tag.
'latest'
Optional gatewayUniversal Resolver gateway URLs to use for resolving CCIP-read requests.
ENS name to get Text for.
Optional strict?: booleanWhether or not to throw errors propagated from the ENS Universal Resolver Contract.
Optional universalAddress of ENS Universal Resolver Contract.
Gets primary name for specified address.
Calls reverse(bytes) on ENS Universal Resolver Contract to "reverse resolve" the address to the primary ENS name.
Name or null if not found. GetEnsNameReturnType
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
Address to get ENS name for.
Optional blockThe balance of the account at a block number.
Optional blockThe balance of the account at a block tag.
'latest'
Optional gatewayUniversal Resolver gateway URLs to use for resolving CCIP-read requests.
Optional strict?: booleanWhether or not to throw errors propagated from the ENS Universal Resolver Contract.
Optional universalAddress of ENS Universal Resolver Contract.
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.
Address for ENS resolver. GetEnsResolverReturnType
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
Optional blockThe balance of the account at a block number.
Optional blockThe balance of the account at a block tag.
'latest'
Name to get the address for.
Optional universalAddress of ENS Universal Resolver Contract.
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.
Address for ENS resolver. GetEnsTextReturnType
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
Optional blockThe balance of the account at a block number.
Optional blockThe balance of the account at a block tag.
'latest'
Optional gatewayUniversal Resolver gateway URLs to use for resolving CCIP-read requests.
Text record to retrieve.
ENS name to get Text for.
Optional strict?: booleanWhether or not to throw errors propagated from the ENS Universal Resolver Contract.
Optional universalAddress of ENS Universal Resolver Contract.
Returns a collection of historical gas information.
eth_feeHistoryThe gas estimate (in wei). GetFeeHistoryReturnType
import { 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
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.Logs or hashes. GetFilterChangesReturnType
// 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 })
Returns a list of event logs since the filter was created.
eth_getFilterLogsgetFilterLogs is only compatible with event filters.
A list of event logs. GetFilterLogsReturnType
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_gasPriceThe gas price (in wei). GetGasPriceReturnType
import { createPublicClient, http } from 'viem'
import { mainnet } from 'viem/chains'
const client = createPublicClient({
chain: mainnet,
transport: http(),
})
const gasPrice = await client.getGasPrice()
Returns a list of event logs matching the provided parameters.
eth_getLogsA list of event logs. GetLogsReturnType
import { createPublicClient, http, parseAbiItem } from 'viem'
import { mainnet } from 'viem/chains'
const client = createPublicClient({
chain: mainnet,
transport: http(),
})
const logs = await client.getLogs()
Returns the account and storage values of the specified account including the Merkle-proof.
eth_getProofProof data. GetProofReturnType
import { 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...'],
})
Returns the value from a storage slot at a given address.
eth_getStorageAtThe value of the storage slot. GetStorageAtReturnType
import { 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
Returns information about a Transaction given a hash or block identifier.
The transaction information. GetTransactionReturnType
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
Returns the number of blocks passed (confirmations) since the transaction was processed on a block.
The number of blocks passed since the transaction was processed. If confirmations is 0, then the Transaction has not been confirmed & processed yet. GetTransactionConfirmationsReturnType
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
Returns the number of Transactions an Account has broadcast / sent.
eth_getTransactionCountThe number of transactions an account has sent. GetTransactionCountReturnType
import { createPublicClient, http } from 'viem'
import { mainnet } from 'viem/chains'
const client = createPublicClient({
chain: mainnet,
transport: http(),
})
const transactionCount = await client.getTransactionCount({
address: '0xA0Cf798816D4b9b9866b5330EEa46a18382f251e',
})
GetTransactionCountParameters
Returns the Transaction Receipt given a Transaction hash.
The transaction receipt. GetTransactionReceiptReturnType
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
A key for the client.
Similar to readContract, but batches up multiple functions on a contract in a single RPC call via the multicall3 contract.
An array of results with accompanying status. MulticallReturnType
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
A name for the client.
Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds.
Prepares a transaction request for signing.
The transaction request. PrepareTransactionRequestReturnType
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
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.
The response from the contract. Type is inferred. ReadContractReturnType
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
Request function wrapped with friendly error handling
Sends a signed transaction to the network
eth_sendRawTransactionThe transaction hash. SendRawTransactionReturnType
import { 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'
})
Use simulateBlocks instead.
Simulates a set of calls on block(s) with optional block and state overrides.
import { createPublicClient, http, parseEther } from 'viem'
import { mainnet } from 'viem/chains'
const client = createPublicClient({
chain: mainnet,
transport: http(),
})
const result = await client.simulateBlocks({
blocks: [{
blockOverrides: {
number: 69420n,
},
calls: [{
{
account: '0x5a0b54d5dc17e482fe8b0bdca5320161b95fb929',
data: '0xdeadbeef',
to: '0x70997970c51812dc3a010c7d01b50e0d17dc79c8',
},
{
account: '0x5a0b54d5dc17e482fe8b0bdca5320161b95fb929',
to: '0x70997970c51812dc3a010c7d01b50e0d17dc79c8',
value: parseEther('1'),
},
}],
stateOverrides: [{
address: '0x5a0b54d5dc17e482fe8b0bdca5320161b95fb929',
balance: parseEther('10'),
}],
}]
})
Simulated blocks. SimulateReturnType
Simulates a set of calls.
import { createPublicClient, http, parseEther } from 'viem'
import { mainnet } from 'viem/chains'
const client = createPublicClient({
chain: mainnet,
transport: http(),
})
const result = await client.simulateCalls({
account: '0x5a0b54d5dc17e482fe8b0bdca5320161b95fb929',
calls: [{
{
data: '0xdeadbeef',
to: '0x70997970c51812dc3a010c7d01b50e0d17dc79c8',
},
{
to: '0x70997970c51812dc3a010c7d01b50e0d17dc79c8',
value: parseEther('1'),
},
]
})
Results. SimulateCallsReturnType
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.
The simulation result and write request. SimulateContractReturnType
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 RPC transport
The type of client.
A unique ID for the client.
Destroys a Filter that was created from one of the following Actions:
A boolean indicating if the Filter was successfully uninstalled. UninstallFilterReturnType
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
Verify that a message was signed by the provided address.
Compatible with Smart Contract Accounts & Externally Owned Accounts via ERC-6492.
Whether or not the signature is valid. VerifyMessageReturnType
The address that signed the original message.
Optional blockThe balance of the account at a block number.
Optional blockThe balance of the account at a block tag.
'latest'
Optional factory?: `0x${string}`Optional factoryThe message to be verified.
The signature that was generated by signing the message with the address's private key.
Optional universalVerifies EIP-4361 formatted message was signed.
Compatible with Smart Contract Accounts & Externally Owned Accounts via ERC-6492.
Whether or not the signature is valid. VerifySiweMessageReturnType
Optional address?: `0x${string}`Ethereum address to check against.
Optional blockThe balance of the account at a block number.
Optional blockThe balance of the account at a block tag.
'latest'
Optional domain?: stringRFC 3986 authority to check against.
EIP-4361 formatted message.
Optional nonce?: stringRandom string to check against.
Optional scheme?: stringRFC 3986 URI scheme to check against.
Signature to check against.
Optional time?: DateCurrent time to check optional expirationTime and notBefore fields.
new Date()
Verify that typed data was signed by the provided address.
Whether or not the signature is valid. VerifyTypedDataReturnType
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)The transaction receipt. WaitForTransactionReceiptReturnType
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
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.A function that can be invoked to stop watching for new block numbers. WatchBlockNumberReturnType
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
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.A function that can be invoked to stop watching for new block numbers. WatchBlocksReturnType
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
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.
A function that can be invoked to stop watching for new event logs. WatchContractEventReturnType
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.
A function that can be invoked to stop watching for new Event Logs. WatchEventReturnType
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: trueeth_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.
A function that can be invoked to stop watching for new pending transaction hashes. WatchPendingTransactionsReturnType
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
Retrieves the viem Contract instance used to interact with the Semaphore contract.
The Contract instance.
Creates a Filter to retrieve event logs that can be used with getFilterChanges or getFilterLogs.
import { createPublicClient, getContract, http, parseAbi } from 'viem'
import { mainnet } from 'viem/chains'
const publicClient = createPublicClient({
chain: mainnet,
transport: http(),
})
const contract = getContract({
address: '0xFBA3912Ca04dd458c843e2EE08967fC04f3579c2',
abi: parseAbi(['event Transfer(address indexed, address indexed, uint256)']),
client: publicClient,
})
const filter = await contract.createEventFilter.Transfer()
Estimates the gas necessary to complete a transaction without submitting it to the network.
import { createPublicClient, getContract, http, parseAbi } from 'viem'
import { mainnet } from 'viem/chains'
const publicClient = createPublicClient({
chain: mainnet,
transport: http(),
})
const contract = getContract({
address: '0xFBA3912Ca04dd458c843e2EE08967fC04f3579c2',
abi: parseAbi(['function mint() public']),
client: publicClient,
})
const gas = await contract.estimateGas.mint({
account: '0xf39fd6e51aad88f6f4ce6ab8827279cfffb92266',
})
Creates a Filter to retrieve event logs that can be used with getFilterChanges or getFilterLogs.
import { createPublicClient, getContract, http, parseAbi } from 'viem'
import { mainnet } from 'viem/chains'
const publicClient = createPublicClient({
chain: mainnet,
transport: http(),
})
const contract = getContract({
address: '0xFBA3912Ca04dd458c843e2EE08967fC04f3579c2',
abi: parseAbi(['event Transfer(address indexed, address indexed, uint256)']),
client: publicClient,
})
const filter = await contract.createEventFilter.Transfer()
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, read uses a Public Client to call the call action with ABI-encoded data.
import { createPublicClient, getContract, http, parseAbi } from 'viem'
import { mainnet } from 'viem/chains'
const publicClient = createPublicClient({
chain: mainnet,
transport: http(),
})
const contract = getContract({
address: '0xFBA3912Ca04dd458c843e2EE08967fC04f3579c2',
abi: parseAbi([
'function balanceOf(address owner) view returns (uint256)',
]),
client: publicClient,
})
const result = await contract.read.balanceOf(['0xA0Cf798816D4b9b9866b5330EEa46a18382f251e'])
// 424122n
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, simulate uses a Public Client to call the call action with ABI-encoded data.
import { createPublicClient, getContract, http, parseAbi } from 'viem'
import { mainnet } from 'viem/chains'
const publicClient = createPublicClient({
chain: mainnet,
transport: http(),
})
const contract = getContract({
address: '0xFBA3912Ca04dd458c843e2EE08967fC04f3579c2',
abi: parseAbi(['function mint() public']),
client: publicClient,
})
const result = await contract.simulate.mint({
account: '0xf39fd6e51aad88f6f4ce6ab8827279cfffb92266',
})
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.
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, getContract, http, parseAbi } from 'viem'
import { mainnet } from 'viem/chains'
const publicClient = createPublicClient({
chain: mainnet,
transport: http(),
})
const contract = getContract({
address: '0xFBA3912Ca04dd458c843e2EE08967fC04f3579c2',
abi: parseAbi(['event Transfer(address indexed, address indexed, uint256)']),
client: publicClient,
})
const filter = await contract.createEventFilter.Transfer()
const unwatch = contract.watchEvent.Transfer(
{ from: '0xc961145a54C96E3aE9bAA048c4F4D6b04C13916b' },
{ onLogs: (logs) => console.log(logs) },
)
Executes a write function on a contract.
A "write" function on a Solidity contract modifies the state of the blockchain. These types of functions require gas to be executed, and hence a Transaction is needed to be broadcast in order to change the state.
Internally, write uses a Wallet Client to call the sendTransaction action with ABI-encoded data.
Warning: The write internally sends a transaction – it does not validate if the contract write will succeed (the contract may throw an error). It is highly recommended to simulate the contract write with contract.simulate before you execute it.
import { createWalletClient, getContract, http, parseAbi } from 'viem'
import { mainnet } from 'viem/chains'
const walletClient = createWalletClient({
chain: mainnet,
transport: http(),
})
const contract = getContract({
address: '0xFBA3912Ca04dd458c843e2EE08967fC04f3579c2',
abi: parseAbi(['function mint(uint32 tokenId) nonpayable']),
client: walletClient,
})
const hash = await contract.write.min([69420], {
address: '0xFBA3912Ca04dd458c843e2EE08967fC04f3579c2',
})
Retrieves the Ethereum network or custom URL currently used by this instance.
The network or URL as a string.
Retrieves the options used for configuring the viem client and the Semaphore contract.
The configuration options.
Retrieves detailed information about a specific group by its ID. This method queries the Semaphore contract to get the group's admin, Merkle tree root, depth, and size.
The unique identifier of the group.
A promise that resolves to a GroupResponse object.
Fetches a list of members from a specific group. This method queries the Semaphore contract for events related to member additions and updates, and constructs the list of current group members.
The unique identifier of the group.
A promise that resolves to an array of member identity commitments as strings.
Fetches a list of validated proofs for a specific group. This method queries the Semaphore contract for events related to proof verification.
The unique identifier of the group.
A promise that resolves to an array of validated proofs.
Checks if a given identity commitment is a member of a specific group.
The unique identifier of the group.
The identity commitment to check.
A promise that resolves to a boolean indicating whether the member is in the group.
The SemaphoreViem class provides a high-level interface to interact with the Semaphore smart contract using the viem library. It encapsulates all necessary functionalities to connect to Ethereum networks, manage contract instances, and perform operations such as retrieving group information or checking group memberships. This class simplifies the interaction with the Ethereum blockchain by abstracting the details of network connections and contract interactions.