Type alias PublicActions<TTransport, TChain, TAccount>

PublicActions<TTransport, TChain, TAccount>: {
    call: ((parameters) => Promise<CallReturnType>);
    createBlockFilter: (() => Promise<CreateBlockFilterReturnType>);
    createContractEventFilter: (<const TAbi, TEventName, TArgs, TStrict, TFromBlock, TToBlock>(args) => Promise<CreateContractEventFilterReturnType<TAbi, TEventName, TArgs, TStrict, TFromBlock, TToBlock>>);
    createEventFilter: (<const TAbiEvent, const TAbiEvents, TStrict, TFromBlock, TToBlock, _EventName, _Args>(args?) => Promise<CreateEventFilterReturnType<TAbiEvent, TAbiEvents, TStrict, TFromBlock, TToBlock, _EventName, _Args>>);
    createPendingTransactionFilter: (() => Promise<CreatePendingTransactionFilterReturnType>);
    estimateContractGas: (<TChain, const TAbi, TFunctionName>(args) => Promise<EstimateContractGasReturnType>);
    estimateFeesPerGas: (<TChainOverride, TType>(args?) => Promise<EstimateFeesPerGasReturnType>);
    estimateGas: ((args) => Promise<EstimateGasReturnType>);
    estimateMaxPriorityFeePerGas: (<TChainOverride>(args?) => Promise<EstimateMaxPriorityFeePerGasReturnType>);
    getBalance: ((args) => Promise<GetBalanceReturnType>);
    getBlock: (<TIncludeTransactions, TBlockTag>(args?) => Promise<GetBlockReturnType<TChain, TIncludeTransactions, TBlockTag>>);
    getBlockNumber: ((args?) => Promise<GetBlockNumberReturnType>);
    getBlockTransactionCount: ((args?) => Promise<GetBlockTransactionCountReturnType>);
    getBytecode: ((args) => Promise<GetBytecodeReturnType>);
    getChainId: (() => Promise<GetChainIdReturnType>);
    getContractEvents: (<const TAbi, TEventName, TStrict, TFromBlock, TToBlock>(args) => Promise<GetContractEventsReturnType<TAbi, TEventName, TStrict, TFromBlock, TToBlock>>);
    getEnsAddress: ((args) => Promise<GetEnsAddressReturnType>);
    getEnsAvatar: ((args) => Promise<GetEnsAvatarReturnType>);
    getEnsName: ((args) => Promise<GetEnsNameReturnType>);
    getEnsResolver: ((args) => Promise<GetEnsResolverReturnType>);
    getEnsText: ((args) => Promise<GetEnsTextReturnType>);
    getFeeHistory: ((args) => Promise<GetFeeHistoryReturnType>);
    getFilterChanges: (<TFilterType, const TAbi, TEventName, TStrict, TFromBlock, TToBlock>(args) => Promise<GetFilterChangesReturnType<TFilterType, TAbi, TEventName, TStrict, TFromBlock, TToBlock>>);
    getFilterLogs: (<const TAbi, TEventName, TStrict, TFromBlock, TToBlock>(args) => Promise<GetFilterLogsReturnType<TAbi, TEventName, TStrict, TFromBlock, TToBlock>>);
    getGasPrice: (() => Promise<GetGasPriceReturnType>);
    getLogs: (<const TAbiEvent, const TAbiEvents, TStrict, TFromBlock, TToBlock>(args?) => Promise<GetLogsReturnType<TAbiEvent, TAbiEvents, TStrict, TFromBlock, TToBlock>>);
    getProof: ((args) => Promise<GetProofReturnType>);
    getStorageAt: ((args) => Promise<GetStorageAtReturnType>);
    getTransaction: (<TBlockTag>(args) => Promise<GetTransactionReturnType<TChain, TBlockTag>>);
    getTransactionConfirmations: ((args) => Promise<GetTransactionConfirmationsReturnType>);
    getTransactionCount: ((args) => Promise<GetTransactionCountReturnType>);
    getTransactionReceipt: ((args) => Promise<GetTransactionReceiptReturnType<TChain>>);
    multicall: (<TContracts, TAllowFailure>(args) => Promise<MulticallReturnType<TContracts, TAllowFailure>>);
    prepareTransactionRequest: (<TChainOverride>(args) => Promise<PrepareTransactionRequestReturnType>);
    readContract: (<const TAbi, TFunctionName>(args) => Promise<ReadContractReturnType<TAbi, TFunctionName>>);
    sendRawTransaction: ((args) => Promise<SendRawTransactionReturnType>);
    simulateContract: (<const TAbi, TFunctionName, TChainOverride>(args) => Promise<SimulateContractReturnType<TAbi, TFunctionName, TChain, TChainOverride>>);
    uninstallFilter: ((args) => Promise<UninstallFilterReturnType>);
    verifyMessage: ((args) => Promise<VerifyMessageReturnType>);
    verifyTypedData: ((args) => Promise<VerifyTypedDataReturnType>);
    waitForTransactionReceipt: ((args) => Promise<WaitForTransactionReceiptReturnType<TChain>>);
    watchBlockNumber: ((args) => WatchBlockNumberReturnType);
    watchBlocks: (<TIncludeTransactions, TBlockTag>(args) => WatchBlocksReturnType);
    watchContractEvent: (<const TAbi, TEventName, TStrict>(args) => WatchContractEventReturnType);
    watchEvent: (<const TAbiEvent, const TAbiEvents, TStrict>(args) => WatchEventReturnType);
    watchPendingTransactions: ((args) => WatchPendingTransactionsReturnType);
}

Type Parameters

TTransport extends Transport = Transport
TChain extends Chain | undefined = Chain | undefined
TAccount extends Account | undefined = Account | undefined

Type declaration

call: ((parameters) => Promise<CallReturnType>)

Executes a new message call immediately without submitting a transaction to the network.

Docs: https://viem.sh/docs/actions/public/call.html
JSON-RPC Methods: eth_call

Param: args

CallParameters

Returns

The call data. CallReturnType

Example

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',
})

(parameters): Promise<CallReturnType>

Executes a new message call immediately without submitting a transaction to the network.

Docs: https://viem.sh/docs/actions/public/call.html
JSON-RPC Methods: eth_call

Parameters

parameters: CallParameters<TChain>

Returns Promise<CallReturnType>

The call data. CallReturnType

Example

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',
})

createBlockFilter: (() => Promise<CreateBlockFilterReturnType>)

Creates a Filter to listen for new block hashes that can be used with getFilterChanges.

Docs: https://viem.sh/docs/actions/public/createBlockFilter.html
JSON-RPC Methods: eth_newBlockFilter

Returns

Filter. CreateBlockFilterReturnType

Example

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' }

(): Promise<CreateBlockFilterReturnType>

Creates a Filter to listen for new block hashes that can be used with getFilterChanges.

Docs: https://viem.sh/docs/actions/public/createBlockFilter.html
JSON-RPC Methods: eth_newBlockFilter

Returns Promise<CreateBlockFilterReturnType>

Filter. CreateBlockFilterReturnType

Example

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' }

createContractEventFilter: (<const TAbi, TEventName, TArgs, TStrict, TFromBlock, TToBlock>(args) => Promise<CreateContractEventFilterReturnType<TAbi, TEventName, TArgs, TStrict, TFromBlock, TToBlock>>)
Creates a Filter to retrieve event logs that can be used with getFilterChanges or getFilterLogs.
- Docs: https://viem.sh/docs/contract/createContractEventFilter.html
Param: args
CreateContractEventFilterParameters

Returns
Filter. CreateContractEventFilterReturnType

Example
```
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)']),
})
```
- - <const TAbi, TEventName, TArgs, TStrict, TFromBlock, TToBlock>(args): Promise<CreateContractEventFilterReturnType<TAbi, TEventName, TArgs, TStrict, TFromBlock, TToBlock>>
  - Creates a Filter to retrieve event logs that can be used with getFilterChanges or getFilterLogs.
    - Docs: https://viem.sh/docs/contract/createContractEventFilter.html
    Type Parameters
    - const TAbi extends Abi | readonly unknown[]
    - TEventName extends string | undefined
    - TArgs extends MaybeExtractEventArgsFromAbi<TAbi, TEventName> | undefined
    - TStrict extends boolean | undefined = undefined
    - TFromBlock extends BlockNumber | BlockTag | undefined = undefined
    - TToBlock extends BlockNumber | BlockTag | undefined = undefined
    Parameters
    - args: CreateContractEventFilterParameters<TAbi, TEventName, TArgs, TStrict, TFromBlock, TToBlock>
      CreateContractEventFilterParameters
    Returns Promise<CreateContractEventFilterReturnType<TAbi, TEventName, TArgs, TStrict, TFromBlock, TToBlock>>
    Filter. CreateContractEventFilterReturnType
    Example
```
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)']),
})
```
createEventFilter: (<const TAbiEvent, const TAbiEvents, TStrict, TFromBlock, TToBlock, _EventName, _Args>(args?) => Promise<CreateEventFilterReturnType<TAbiEvent, TAbiEvents, TStrict, TFromBlock, TToBlock, _EventName, _Args>>)
Creates a Filter to listen for new events that can be used with getFilterChanges.
- Docs: https://viem.sh/docs/actions/public/createEventFilter.html
- JSON-RPC Methods: eth_newFilter
Param: args
CreateEventFilterParameters

Returns
Filter. CreateEventFilterReturnType

Example
```
import { createPublicClient, http } from 'viem'
import { mainnet } from 'viem/chains'

const client = createPublicClient({
  chain: mainnet,
  transport: http(),
})
const filter = await client.createEventFilter({
  address: '0xfba3912ca04dd458c843e2ee08967fc04f3579c2',
})
```
- - <const TAbiEvent, const TAbiEvents, TStrict, TFromBlock, TToBlock, _EventName, _Args>(args?): Promise<CreateEventFilterReturnType<TAbiEvent, TAbiEvents, TStrict, TFromBlock, TToBlock, _EventName, _Args>>
  - Creates a Filter to listen for new events that can be used with getFilterChanges.
    - Docs: https://viem.sh/docs/actions/public/createEventFilter.html
    - JSON-RPC Methods: eth_newFilter
    Type Parameters
    - const TAbiEvent extends AbiEvent | undefined = undefined
    - const TAbiEvents extends readonly AbiEvent[] | readonly unknown[] | undefined = TAbiEvent extends AbiEvent
      ? [TAbiEvent]
      : undefined
    - TStrict extends boolean | undefined = undefined
    - TFromBlock extends BlockNumber | BlockTag | undefined = undefined
    - TToBlock extends BlockNumber | BlockTag | undefined = undefined
    - _EventName extends string | undefined = MaybeAbiEventName<TAbiEvent>
    - _Args extends MaybeExtractEventArgsFromAbi<TAbiEvents, _EventName> | undefined = undefined
    Parameters
    - Optional args: CreateEventFilterParameters<TAbiEvent, TAbiEvents, TStrict, TFromBlock, TToBlock, _EventName, _Args>
      CreateEventFilterParameters
    Returns Promise<CreateEventFilterReturnType<TAbiEvent, TAbiEvents, TStrict, TFromBlock, TToBlock, _EventName, _Args>>
    Filter. CreateEventFilterReturnType
    Example
```
import { createPublicClient, http } from 'viem'
import { mainnet } from 'viem/chains'

const client = createPublicClient({
  chain: mainnet,
  transport: http(),
})
const filter = await client.createEventFilter({
  address: '0xfba3912ca04dd458c843e2ee08967fc04f3579c2',
})
```
createPendingTransactionFilter: (() => Promise<CreatePendingTransactionFilterReturnType>)
Creates a Filter to listen for new pending transaction hashes that can be used with getFilterChanges.
- Docs: https://viem.sh/docs/actions/public/createPendingTransactionFilter.html
- JSON-RPC Methods: eth_newPendingTransactionFilter
Returns
Filter. CreateBlockFilterReturnType

Example
```
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' }
```
- - (): Promise<CreatePendingTransactionFilterReturnType>
  - Creates a Filter to listen for new pending transaction hashes that can be used with getFilterChanges.
    - Docs: https://viem.sh/docs/actions/public/createPendingTransactionFilter.html
    - JSON-RPC Methods: eth_newPendingTransactionFilter
    Returns Promise<CreatePendingTransactionFilterReturnType>
    Filter. CreateBlockFilterReturnType
    Example
```
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' }
```
estimateContractGas: (<TChain, const TAbi, TFunctionName>(args) => Promise<EstimateContractGasReturnType>)
Estimates the gas required to successfully execute a contract write function call.
- Docs: https://viem.sh/docs/contract/estimateContractGas.html
Remarks
Internally, uses a Public Client to call the estimateGas action with ABI-encoded data.

Param: args
EstimateContractGasParameters

Returns
The gas estimate (in wei). EstimateContractGasReturnType

Example
```
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',
})
```
- - <TChain, const TAbi, TFunctionName>(args): Promise<EstimateContractGasReturnType>
  - Estimates the gas required to successfully execute a contract write function call.
    - Docs: https://viem.sh/docs/contract/estimateContractGas.html
    Type Parameters
    - TChain extends Chain | undefined
    - const TAbi extends Abi | readonly unknown[]
    - TFunctionName extends string
    Parameters
    - args: EstimateContractGasParameters<TAbi, TFunctionName, TChain, TAccount>
      EstimateContractGasParameters
    Returns Promise<EstimateContractGasReturnType>
    The gas estimate (in wei). EstimateContractGasReturnType
    Remarks
    Internally, uses a Public Client to call the estimateGas action with ABI-encoded data.
    
    Example
```
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',
})
```
estimateFeesPerGas: (<TChainOverride, TType>(args?) => Promise<EstimateFeesPerGasReturnType>)
Returns an estimate for the fees per gas for a transaction to be included in the next block.
- Docs: https://viem.sh/docs/actions/public/estimateFeesPerGas.html
Param: client
Client to use

Param: parameters
EstimateFeesPerGasParameters

Returns
An estimate (in wei) for the fees per gas. EstimateFeesPerGasReturnType

Example
```
import { createPublicClient, http } from 'viem'
import { mainnet } from 'viem/chains'

const client = createPublicClient({
  chain: mainnet,
  transport: http(),
})
const maxPriorityFeePerGas = await client.estimateFeesPerGas()
// { maxFeePerGas: ..., maxPriorityFeePerGas: ... }
```
- - <TChainOverride, TType>(args?): Promise<EstimateFeesPerGasReturnType>
  - Returns an estimate for the fees per gas for a transaction to be included in the next block.
    - Docs: https://viem.sh/docs/actions/public/estimateFeesPerGas.html
    Type Parameters
    - TChainOverride extends Chain | undefined = undefined
    - TType extends FeeValuesType = "eip1559"
    Parameters
    - Optional args: EstimateFeesPerGasParameters<TChain, TChainOverride, TType>
    Returns Promise<EstimateFeesPerGasReturnType>
    An estimate (in wei) for the fees per gas. EstimateFeesPerGasReturnType
    Example
```
import { createPublicClient, http } from 'viem'
import { mainnet } from 'viem/chains'

const client = createPublicClient({
  chain: mainnet,
  transport: http(),
})
const maxPriorityFeePerGas = await client.estimateFeesPerGas()
// { maxFeePerGas: ..., maxPriorityFeePerGas: ... }
```

estimateGas: ((args) => Promise<EstimateGasReturnType>)

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

Docs: https://viem.sh/docs/actions/public/estimateGas.html
JSON-RPC Methods: eth_estimateGas

Param: args

EstimateGasParameters

Returns

The gas estimate (in wei). EstimateGasReturnType

Example

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'),
})

(args): Promise<EstimateGasReturnType>

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

Docs: https://viem.sh/docs/actions/public/estimateGas.html
JSON-RPC Methods: eth_estimateGas

Parameters

args: EstimateGasParameters<TChain, TAccount>
EstimateGasParameters

Returns Promise<EstimateGasReturnType>

The gas estimate (in wei). EstimateGasReturnType

Example

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'),
})

estimateMaxPriorityFeePerGas: (<TChainOverride>(args?) => Promise<EstimateMaxPriorityFeePerGasReturnType>)
Returns an estimate for the max priority fee per gas (in wei) for a transaction to be included in the next block.
- Docs: https://viem.sh/docs/actions/public/estimateMaxPriorityFeePerGas.html
Param: client
Client to use

Returns
An estimate (in wei) for the max priority fee per gas. EstimateMaxPriorityFeePerGasReturnType

Example
```
import { createPublicClient, http } from 'viem'
import { mainnet } from 'viem/chains'

const client = createPublicClient({
  chain: mainnet,
  transport: http(),
})
const maxPriorityFeePerGas = await client.estimateMaxPriorityFeePerGas()
// 10000000n
```
- - <TChainOverride>(args?): Promise<EstimateMaxPriorityFeePerGasReturnType>
  - Returns an estimate for the max priority fee per gas (in wei) for a transaction to be included in the next block.
    - Docs: https://viem.sh/docs/actions/public/estimateMaxPriorityFeePerGas.html
    Type Parameters
    - TChainOverride extends Chain | undefined = undefined
    Parameters
    - Optional args: EstimateMaxPriorityFeePerGasParameters<TChain, TChainOverride>
    Returns Promise<EstimateMaxPriorityFeePerGasReturnType>
    An estimate (in wei) for the max priority fee per gas. EstimateMaxPriorityFeePerGasReturnType
    Example
```
import { createPublicClient, http } from 'viem'
import { mainnet } from 'viem/chains'

const client = createPublicClient({
  chain: mainnet,
  transport: http(),
})
const maxPriorityFeePerGas = await client.estimateMaxPriorityFeePerGas()
// 10000000n
```

getBalance: ((args) => Promise<GetBalanceReturnType>)

Returns the balance of an address in wei.

Docs: https://viem.sh/docs/actions/public/getBalance.html
JSON-RPC Methods: eth_getBalance

Remarks

You can convert the balance to ether units with formatEther.

const balance = await getBalance(client, {
  address: '0xA0Cf798816D4b9b9866b5330EEa46a18382f251e',
  blockTag: 'safe'
})
const balanceAsEther = formatEther(balance)
// "6.942"

Param: args

GetBalanceParameters

Returns

The balance of the address in wei. GetBalanceReturnType

Example

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)

(args): Promise<GetBalanceReturnType>

Returns the balance of an address in wei.

Docs: https://viem.sh/docs/actions/public/getBalance.html
JSON-RPC Methods: eth_getBalance

Parameters

args: GetBalanceParameters
GetBalanceParameters

Returns Promise<GetBalanceReturnType>

The balance of the address in wei. GetBalanceReturnType

Remarks

You can convert the balance to ether units with formatEther.

const balance = await getBalance(client, {
  address: '0xA0Cf798816D4b9b9866b5330EEa46a18382f251e',
  blockTag: 'safe'
})
const balanceAsEther = formatEther(balance)
// "6.942"

Example

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)

getBlock: (<TIncludeTransactions, TBlockTag>(args?) => Promise<GetBlockReturnType<TChain, TIncludeTransactions, TBlockTag>>)
Returns information about a block at a block number, hash, or tag.
- Docs: https://viem.sh/docs/actions/public/getBlock.html
- Examples: https://stackblitz.com/github/wevm/viem/tree/main/examples/blocks/fetching-blocks
- JSON-RPC Methods:
  - Calls eth_getBlockByNumber for blockNumber & blockTag.
  - Calls eth_getBlockByHash for blockHash.
Param: args
GetBlockParameters

Returns
Information about the block. GetBlockReturnType

Example
```
import { createPublicClient, http } from 'viem'
import { mainnet } from 'viem/chains'

const client = createPublicClient({
  chain: mainnet,
  transport: http(),
})
const block = await client.getBlock()
```
- - <TIncludeTransactions, TBlockTag>(args?): Promise<GetBlockReturnType<TChain, TIncludeTransactions, TBlockTag>>
  - Returns information about a block at a block number, hash, or tag.
    - Docs: https://viem.sh/docs/actions/public/getBlock.html
    - Examples: https://stackblitz.com/github/wevm/viem/tree/main/examples/blocks/fetching-blocks
    - JSON-RPC Methods:
      
      Calls eth_getBlockByNumber for blockNumber & blockTag.
      
      Calls eth_getBlockByHash for blockHash.
    Type Parameters
    - TIncludeTransactions extends boolean = false
    - TBlockTag extends BlockTag = "latest"
    Parameters
    - Optional args: GetBlockParameters<TIncludeTransactions, TBlockTag>
      GetBlockParameters
    Returns Promise<GetBlockReturnType<TChain, TIncludeTransactions, TBlockTag>>
    Information about the block. GetBlockReturnType
    Example
```
import { createPublicClient, http } from 'viem'
import { mainnet } from 'viem/chains'

const client = createPublicClient({
  chain: mainnet,
  transport: http(),
})
const block = await client.getBlock()
```
getBlockNumber: ((args?) => Promise<GetBlockNumberReturnType>)
Returns the number of the most recent block seen.
- Docs: https://viem.sh/docs/actions/public/getBlockNumber.html
- Examples: https://stackblitz.com/github/wevm/viem/tree/main/examples/blocks/fetching-blocks
- JSON-RPC Methods: eth_blockNumber
Param: args
GetBlockNumberParameters

Returns
The number of the block. GetBlockNumberReturnType

Example
```
import { createPublicClient, http } from 'viem'
import { mainnet } from 'viem/chains'

const client = createPublicClient({
  chain: mainnet,
  transport: http(),
})
const blockNumber = await client.getBlockNumber()
// 69420n
```
- - (args?): Promise<GetBlockNumberReturnType>
  - Returns the number of the most recent block seen.
    - Docs: https://viem.sh/docs/actions/public/getBlockNumber.html
    - Examples: https://stackblitz.com/github/wevm/viem/tree/main/examples/blocks/fetching-blocks
    - JSON-RPC Methods: eth_blockNumber
    Parameters
    - Optional args: GetBlockNumberParameters
      GetBlockNumberParameters
    Returns Promise<GetBlockNumberReturnType>
    The number of the block. GetBlockNumberReturnType
    Example
```
import { createPublicClient, http } from 'viem'
import { mainnet } from 'viem/chains'

const client = createPublicClient({
  chain: mainnet,
  transport: http(),
})
const blockNumber = await client.getBlockNumber()
// 69420n
```
getBlockTransactionCount: ((args?) => Promise<GetBlockTransactionCountReturnType>)
Returns the number of Transactions at a block number, hash, or tag.
- Docs: https://viem.sh/docs/actions/public/getBlockTransactionCount.html
- JSON-RPC Methods:
  - Calls eth_getBlockTransactionCountByNumber for blockNumber & blockTag.
  - Calls eth_getBlockTransactionCountByHash for blockHash.
Param: args
GetBlockTransactionCountParameters

Returns
The block transaction count. GetBlockTransactionCountReturnType

Example
```
import { createPublicClient, http } from 'viem'
import { mainnet } from 'viem/chains'

const client = createPublicClient({
  chain: mainnet,
  transport: http(),
})
const count = await client.getBlockTransactionCount()
```
- - (args?): Promise<GetBlockTransactionCountReturnType>
  - Returns the number of Transactions at a block number, hash, or tag.
    - Docs: https://viem.sh/docs/actions/public/getBlockTransactionCount.html
    - JSON-RPC Methods:
      
      Calls eth_getBlockTransactionCountByNumber for blockNumber & blockTag.
      
      Calls eth_getBlockTransactionCountByHash for blockHash.
    Parameters
    - Optional args: GetBlockTransactionCountParameters
      GetBlockTransactionCountParameters
    Returns Promise<GetBlockTransactionCountReturnType>
    The block transaction count. GetBlockTransactionCountReturnType
    Example
```
import { createPublicClient, http } from 'viem'
import { mainnet } from 'viem/chains'

const client = createPublicClient({
  chain: mainnet,
  transport: http(),
})
const count = await client.getBlockTransactionCount()
```

getBytecode: ((args) => Promise<GetBytecodeReturnType>)

Retrieves the bytecode at an address.

Docs: https://viem.sh/docs/contract/getBytecode.html
JSON-RPC Methods: eth_getCode

Param: args

GetBytecodeParameters

Returns

The contract's bytecode. GetBytecodeReturnType

Example

import { createPublicClient, http } from 'viem'
import { mainnet } from 'viem/chains'

const client = createPublicClient({
  chain: mainnet,
  transport: http(),
})
const code = await client.getBytecode({
  address: '0xFBA3912Ca04dd458c843e2EE08967fC04f3579c2',
})

- (args): Promise<GetBytecodeReturnType>
- Retrieves the bytecode at an address.
  - Docs: https://viem.sh/docs/contract/getBytecode.html
  - JSON-RPC Methods: eth_getCode
  Parameters
  - args: GetBytecodeParameters
    GetBytecodeParameters
  Returns Promise<GetBytecodeReturnType>
  The contract's bytecode. GetBytecodeReturnType
  Example
```
import { createPublicClient, http } from 'viem'
import { mainnet } from 'viem/chains'

const client = createPublicClient({
  chain: mainnet,
  transport: http(),
})
const code = await client.getBytecode({
  address: '0xFBA3912Ca04dd458c843e2EE08967fC04f3579c2',
})
```

getChainId: (() => Promise<GetChainIdReturnType>)
Returns the chain ID associated with the current network.
- Docs: https://viem.sh/docs/actions/public/getChainId.html
- JSON-RPC Methods: eth_chainId
Returns
The current chain ID. GetChainIdReturnType

Example
```
import { createPublicClient, http } from 'viem'
import { mainnet } from 'viem/chains'

const client = createPublicClient({
  chain: mainnet,
  transport: http(),
})
const chainId = await client.getChainId()
// 1
```
- - (): Promise<GetChainIdReturnType>
  - Returns the chain ID associated with the current network.
    - Docs: https://viem.sh/docs/actions/public/getChainId.html
    - JSON-RPC Methods: eth_chainId
    Returns Promise<GetChainIdReturnType>
    The current chain ID. GetChainIdReturnType
    Example
```
import { createPublicClient, http } from 'viem'
import { mainnet } from 'viem/chains'

const client = createPublicClient({
  chain: mainnet,
  transport: http(),
})
const chainId = await client.getChainId()
// 1
```
getContractEvents: (<const TAbi, TEventName, TStrict, TFromBlock, TToBlock>(args) => Promise<GetContractEventsReturnType<TAbi, TEventName, TStrict, TFromBlock, TToBlock>>)
Returns a list of event logs emitted by a contract.
- Docs: https://viem.sh/docs/actions/public/getContractEvents.html
- JSON-RPC Methods: eth_getLogs
Param: client
Client to use

Param: parameters
GetContractEventsParameters

Returns
A list of event logs. GetContractEventsReturnType

Example
```
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'
})
```
- - <const TAbi, TEventName, TStrict, TFromBlock, TToBlock>(args): Promise<GetContractEventsReturnType<TAbi, TEventName, TStrict, TFromBlock, TToBlock>>
  - Returns a list of event logs emitted by a contract.
    - Docs: https://viem.sh/docs/actions/public/getContractEvents.html
    - JSON-RPC Methods: eth_getLogs
    Type Parameters
    - const TAbi extends Abi | readonly unknown[]
    - TEventName extends string | undefined = undefined
    - TStrict extends boolean | undefined = undefined
    - TFromBlock extends BlockNumber | BlockTag | undefined = undefined
    - TToBlock extends BlockNumber | BlockTag | undefined = undefined
    Parameters
    - args: GetContractEventsParameters<TAbi, TEventName, TStrict, TFromBlock, TToBlock>
    Returns Promise<GetContractEventsReturnType<TAbi, TEventName, TStrict, TFromBlock, TToBlock>>
    A list of event logs. GetContractEventsReturnType
    Example
```
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'
})
```
getEnsAddress: ((args) => Promise<GetEnsAddressReturnType>)
Gets address for ENS name.
- Docs: https://viem.sh/docs/ens/actions/getEnsAddress.html
- Examples: https://stackblitz.com/github/wevm/viem/tree/main/examples/ens
Remarks
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.

Param: args
GetEnsAddressParameters

Returns
Address for ENS name or null if not found. GetEnsAddressReturnType

Example
```
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'
```
- - (args): Promise<GetEnsAddressReturnType>
  - Gets address for ENS name.
    - Docs: https://viem.sh/docs/ens/actions/getEnsAddress.html
    - Examples: https://stackblitz.com/github/wevm/viem/tree/main/examples/ens
    Parameters
    - args: GetEnsAddressParameters
      GetEnsAddressParameters
    Returns Promise<GetEnsAddressReturnType>
    Address for ENS name or null if not found. GetEnsAddressReturnType
    Remarks
    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.
    
    Example
```
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'
```
getEnsAvatar: ((args) => Promise<GetEnsAvatarReturnType>)
Gets the avatar of an ENS name.
- Docs: https://viem.sh/docs/ens/actions/getEnsAvatar.html
- Examples: https://stackblitz.com/github/wevm/viem/tree/main/examples/ens
Remarks
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.

Param: args
GetEnsAvatarParameters

Returns
Avatar URI or null if not found. GetEnsAvatarReturnType

Example
```
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'
```
- - (args): Promise<GetEnsAvatarReturnType>
  - Gets the avatar of an ENS name.
    - Docs: https://viem.sh/docs/ens/actions/getEnsAvatar.html
    - Examples: https://stackblitz.com/github/wevm/viem/tree/main/examples/ens
    Parameters
    - args: GetEnsAvatarParameters
      GetEnsAvatarParameters
    Returns Promise<GetEnsAvatarReturnType>
    Avatar URI or null if not found. GetEnsAvatarReturnType
    Remarks
    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.
    
    Example
```
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'
```
getEnsName: ((args) => Promise<GetEnsNameReturnType>)
Gets primary name for specified address.
- Docs: https://viem.sh/docs/ens/actions/getEnsName.html
- Examples: https://stackblitz.com/github/wevm/viem/tree/main/examples/ens
Remarks
Calls reverse(bytes) on ENS Universal Resolver Contract to "reverse resolve" the address to the primary ENS name.

Param: args
GetEnsNameParameters

Returns
Name or null if not found. GetEnsNameReturnType

Example
```
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'
```
- - (args): Promise<GetEnsNameReturnType>
  - Gets primary name for specified address.
    - Docs: https://viem.sh/docs/ens/actions/getEnsName.html
    - Examples: https://stackblitz.com/github/wevm/viem/tree/main/examples/ens
    Parameters
    - args: GetEnsNameParameters
      GetEnsNameParameters
    Returns Promise<GetEnsNameReturnType>
    Name or null if not found. GetEnsNameReturnType
    Remarks
    Calls reverse(bytes) on ENS Universal Resolver Contract to "reverse resolve" the address to the primary ENS name.
    
    Example
```
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'
```
getEnsResolver: ((args) => Promise<GetEnsResolverReturnType>)
Gets resolver for ENS name.
- Docs: https://viem.sh/docs/ens/actions/getEnsResolver.html
- Examples: https://stackblitz.com/github/wevm/viem/tree/main/examples/ens
Remarks
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.

Param: args
GetEnsResolverParameters

Returns
Address for ENS resolver. GetEnsResolverReturnType

Example
```
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'
```
- - (args): Promise<GetEnsResolverReturnType>
  - Gets resolver for ENS name.
    - Docs: https://viem.sh/docs/ens/actions/getEnsResolver.html
    - Examples: https://stackblitz.com/github/wevm/viem/tree/main/examples/ens
    Parameters
    - args: GetEnsResolverParameters
      GetEnsResolverParameters
    Returns Promise<GetEnsResolverReturnType>
    Address for ENS resolver. GetEnsResolverReturnType
    Remarks
    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.
    
    Example
```
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'
```
getEnsText: ((args) => Promise<GetEnsTextReturnType>)
Gets a text record for specified ENS name.
- Docs: https://viem.sh/docs/ens/actions/getEnsResolver.html
- Examples: https://stackblitz.com/github/wevm/viem/tree/main/examples/ens
Remarks
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.

Param: args
GetEnsTextParameters

Returns
Address for ENS resolver. GetEnsTextReturnType

Example
```
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',
})
// 'wagmi_sh'
```
- - (args): Promise<GetEnsTextReturnType>
  - Gets a text record for specified ENS name.
    - Docs: https://viem.sh/docs/ens/actions/getEnsResolver.html
    - Examples: https://stackblitz.com/github/wevm/viem/tree/main/examples/ens
    Parameters
    - args: GetEnsTextParameters
      GetEnsTextParameters
    Returns Promise<GetEnsTextReturnType>
    Address for ENS resolver. GetEnsTextReturnType
    Remarks
    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.
    
    Example
```
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',
})
// 'wagmi_sh'
```
getFeeHistory: ((args) => Promise<GetFeeHistoryReturnType>)
Returns a collection of historical gas information.
- Docs: https://viem.sh/docs/actions/public/getFeeHistory.html
- JSON-RPC Methods: eth_feeHistory
Param: args
GetFeeHistoryParameters

Returns
The gas estimate (in wei). GetFeeHistoryReturnType

Example
```
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],
})
```
- - (args): Promise<GetFeeHistoryReturnType>
  - Returns a collection of historical gas information.
    - Docs: https://viem.sh/docs/actions/public/getFeeHistory.html
    - JSON-RPC Methods: eth_feeHistory
    Parameters
    - args: GetFeeHistoryParameters
      GetFeeHistoryParameters
    Returns Promise<GetFeeHistoryReturnType>
    The gas estimate (in wei). GetFeeHistoryReturnType
    Example
```
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],
})
```

getFilterChanges: (<TFilterType, const TAbi, TEventName, TStrict, TFromBlock, TToBlock>(args) => Promise<GetFilterChangesReturnType<TFilterType, TAbi, TEventName, TStrict, TFromBlock, TToBlock>>)

Returns a list of logs or hashes based on a Filter since the last time it was called.

Docs: https://viem.sh/docs/actions/public/getFilterChanges.html
JSON-RPC Methods: eth_getFilterChanges

Remarks

A Filter can be created from the following actions:

Depending on the type of filter, the return value will be different:

If the filter was created with createContractEventFilter or createEventFilter, it returns a list of logs.
If the filter was created with createPendingTransactionFilter, it returns a list of transaction hashes.
If the filter was created with createBlockFilter, it returns a list of block hashes.

Param: args

GetFilterChangesParameters

Returns

Logs or hashes. GetFilterChangesReturnType

Example

// 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 })

Example

// 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 })

Example

// 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 })

Example

// 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 })

<TFilterType, const TAbi, TEventName, TStrict, TFromBlock, TToBlock>(args): Promise<GetFilterChangesReturnType<TFilterType, TAbi, TEventName, TStrict, TFromBlock, TToBlock>>

Returns a list of logs or hashes based on a Filter since the last time it was called.

Docs: https://viem.sh/docs/actions/public/getFilterChanges.html
JSON-RPC Methods: eth_getFilterChanges

Type Parameters

TFilterType extends FilterType
const TAbi extends Abi | readonly unknown[] | undefined
TEventName extends string | undefined
TStrict extends boolean | undefined = undefined
TFromBlock extends BlockNumber | BlockTag | undefined = undefined
TToBlock extends BlockNumber | BlockTag | undefined = undefined

Parameters

args: GetFilterChangesParameters<TFilterType, TAbi, TEventName, TStrict, TFromBlock, TToBlock>
GetFilterChangesParameters

Returns Promise<GetFilterChangesReturnType<TFilterType, TAbi, TEventName, TStrict, TFromBlock, TToBlock>>

Logs or hashes. GetFilterChangesReturnType

Remarks

A Filter can be created from the following actions:

Depending on the type of filter, the return value will be different:

If the filter was created with createContractEventFilter or createEventFilter, it returns a list of logs.
If the filter was created with createPendingTransactionFilter, it returns a list of transaction hashes.
If the filter was created with createBlockFilter, it returns a list of block hashes.

Example

// 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 })

Example

// 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 })

Example

// 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 })

Example

// 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 })

getFilterLogs: (<const TAbi, TEventName, TStrict, TFromBlock, TToBlock>(args) => Promise<GetFilterLogsReturnType<TAbi, TEventName, TStrict, TFromBlock, TToBlock>>)
Returns a list of event logs since the filter was created.
- Docs: https://viem.sh/docs/actions/public/getFilterLogs.html
- JSON-RPC Methods: eth_getFilterLogs
Remarks
getFilterLogs is only compatible with event filters.

Param: args
GetFilterLogsParameters

Returns
A list of event logs. GetFilterLogsReturnType

Example
```
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 })
```
- - <const TAbi, TEventName, TStrict, TFromBlock, TToBlock>(args): Promise<GetFilterLogsReturnType<TAbi, TEventName, TStrict, TFromBlock, TToBlock>>
  - Returns a list of event logs since the filter was created.
    - Docs: https://viem.sh/docs/actions/public/getFilterLogs.html
    - JSON-RPC Methods: eth_getFilterLogs
    Type Parameters
    - const TAbi extends Abi | readonly unknown[] | undefined
    - TEventName extends string | undefined
    - TStrict extends boolean | undefined = undefined
    - TFromBlock extends BlockNumber | BlockTag | undefined = undefined
    - TToBlock extends BlockNumber | BlockTag | undefined = undefined
    Parameters
    - args: GetFilterLogsParameters<TAbi, TEventName, TStrict, TFromBlock, TToBlock>
      GetFilterLogsParameters
    Returns Promise<GetFilterLogsReturnType<TAbi, TEventName, TStrict, TFromBlock, TToBlock>>
    A list of event logs. GetFilterLogsReturnType
    Remarks
    getFilterLogs is only compatible with event filters.
    
    Example
```
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 })
```
getGasPrice: (() => Promise<GetGasPriceReturnType>)
Returns the current price of gas (in wei).
- Docs: https://viem.sh/docs/actions/public/getGasPrice.html
- JSON-RPC Methods: eth_gasPrice
Returns
The gas price (in wei). GetGasPriceReturnType

Example
```
import { createPublicClient, http } from 'viem'
import { mainnet } from 'viem/chains'

const client = createPublicClient({
  chain: mainnet,
  transport: http(),
})
const gasPrice = await client.getGasPrice()
```
- - (): Promise<GetGasPriceReturnType>
  - Returns the current price of gas (in wei).
    - Docs: https://viem.sh/docs/actions/public/getGasPrice.html
    - JSON-RPC Methods: eth_gasPrice
    Returns Promise<GetGasPriceReturnType>
    The gas price (in wei). GetGasPriceReturnType
    Example
```
import { createPublicClient, http } from 'viem'
import { mainnet } from 'viem/chains'

const client = createPublicClient({
  chain: mainnet,
  transport: http(),
})
const gasPrice = await client.getGasPrice()
```
getLogs: (<const TAbiEvent, const TAbiEvents, TStrict, TFromBlock, TToBlock>(args?) => Promise<GetLogsReturnType<TAbiEvent, TAbiEvents, TStrict, TFromBlock, TToBlock>>)
Returns a list of event logs matching the provided parameters.
- Docs: https://viem.sh/docs/actions/public/getLogs.html
- Examples: https://stackblitz.com/github/wevm/viem/tree/main/examples/filters-and-logs/event-logs
- JSON-RPC Methods: eth_getLogs
Param: args
GetLogsParameters

Returns
A list of event logs. GetLogsReturnType

Example
```
import { createPublicClient, http, parseAbiItem } from 'viem'
import { mainnet } from 'viem/chains'

const client = createPublicClient({
  chain: mainnet,
  transport: http(),
})
const logs = await client.getLogs()
```
- - <const TAbiEvent, const TAbiEvents, TStrict, TFromBlock, TToBlock>(args?): Promise<GetLogsReturnType<TAbiEvent, TAbiEvents, TStrict, TFromBlock, TToBlock>>
  - Returns a list of event logs matching the provided parameters.
    - Docs: https://viem.sh/docs/actions/public/getLogs.html
    - Examples: https://stackblitz.com/github/wevm/viem/tree/main/examples/filters-and-logs/event-logs
    - JSON-RPC Methods: eth_getLogs
    Type Parameters
    - const TAbiEvent extends AbiEvent | undefined = undefined
    - const TAbiEvents extends readonly AbiEvent[] | readonly unknown[] | undefined = TAbiEvent extends AbiEvent
      ? [TAbiEvent]
      : undefined
    - TStrict extends boolean | undefined = undefined
    - TFromBlock extends BlockNumber | BlockTag | undefined = undefined
    - TToBlock extends BlockNumber | BlockTag | undefined = undefined
    Parameters
    - Optional args: GetLogsParameters<TAbiEvent, TAbiEvents, TStrict, TFromBlock, TToBlock>
      GetLogsParameters
    Returns Promise<GetLogsReturnType<TAbiEvent, TAbiEvents, TStrict, TFromBlock, TToBlock>>
    A list of event logs. GetLogsReturnType
    Example
```
import { createPublicClient, http, parseAbiItem } from 'viem'
import { mainnet } from 'viem/chains'

const client = createPublicClient({
  chain: mainnet,
  transport: http(),
})
const logs = await client.getLogs()
```
getProof: ((args) => Promise<GetProofReturnType>)
Returns the account and storage values of the specified account including the Merkle-proof.
- Docs: https://viem.sh/docs/actions/public/getProof.html
- JSON-RPC Methods:
  - Calls eth_getProof
Param: client
Client to use

Param: parameters
GetProofParameters

Returns
Proof data. GetProofReturnType

Example
```
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...'],
})
```
- - (args): Promise<GetProofReturnType>
  - Returns the account and storage values of the specified account including the Merkle-proof.
    - Docs: https://viem.sh/docs/actions/public/getProof.html
    - JSON-RPC Methods:
      
      Calls eth_getProof
    Parameters
    - args: GetProofParameters
    Returns Promise<GetProofReturnType>
    Proof data. GetProofReturnType
    Example
```
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...'],
})
```

getStorageAt: ((args) => Promise<GetStorageAtReturnType>)

Returns the value from a storage slot at a given address.

Docs: https://viem.sh/docs/contract/getStorageAt.html
JSON-RPC Methods: eth_getStorageAt

Param: args

GetStorageAtParameters

Returns

The value of the storage slot. GetStorageAtReturnType

Example

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),
})

(args): Promise<GetStorageAtReturnType>

Returns the value from a storage slot at a given address.

Docs: https://viem.sh/docs/contract/getStorageAt.html
JSON-RPC Methods: eth_getStorageAt

Parameters

args: GetStorageAtParameters
GetStorageAtParameters

Returns Promise<GetStorageAtReturnType>

The value of the storage slot. GetStorageAtReturnType

Example

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),
})

getTransaction: (<TBlockTag>(args) => Promise<GetTransactionReturnType<TChain, TBlockTag>>)
Returns information about a Transaction given a hash or block identifier.
- Docs: https://viem.sh/docs/actions/public/getTransaction.html
- Example: https://stackblitz.com/github/wevm/viem/tree/main/examples/transactions/fetching-transactions
- JSON-RPC Methods: eth_getTransactionByHash
Param: args
GetTransactionParameters

Returns
The transaction information. GetTransactionReturnType

Example
```
import { createPublicClient, http } from 'viem'
import { mainnet } from 'viem/chains'

const client = createPublicClient({
  chain: mainnet,
  transport: http(),
})
const transaction = await client.getTransaction({
  hash: '0x4ca7ee652d57678f26e887c149ab0735f41de37bcad58c9f6d3ed5824f15b74d',
})
```
- - <TBlockTag>(args): Promise<GetTransactionReturnType<TChain, TBlockTag>>
  - Returns information about a Transaction given a hash or block identifier.
    - Docs: https://viem.sh/docs/actions/public/getTransaction.html
    - Example: https://stackblitz.com/github/wevm/viem/tree/main/examples/transactions/fetching-transactions
    - JSON-RPC Methods: eth_getTransactionByHash
    Type Parameters
    - TBlockTag extends BlockTag = "latest"
    Parameters
    - args: GetTransactionParameters<TBlockTag>
      GetTransactionParameters
    Returns Promise<GetTransactionReturnType<TChain, TBlockTag>>
    The transaction information. GetTransactionReturnType
    Example
```
import { createPublicClient, http } from 'viem'
import { mainnet } from 'viem/chains'

const client = createPublicClient({
  chain: mainnet,
  transport: http(),
})
const transaction = await client.getTransaction({
  hash: '0x4ca7ee652d57678f26e887c149ab0735f41de37bcad58c9f6d3ed5824f15b74d',
})
```
getTransactionConfirmations: ((args) => Promise<GetTransactionConfirmationsReturnType>)
Returns the number of blocks passed (confirmations) since the transaction was processed on a block.
- Docs: https://viem.sh/docs/actions/public/getTransactionConfirmations.html
- Example: https://stackblitz.com/github/wevm/viem/tree/main/examples/transactions/fetching-transactions
- JSON-RPC Methods: eth_getTransactionConfirmations
Param: args
GetTransactionConfirmationsParameters

Returns
The number of blocks passed since the transaction was processed. If confirmations is 0, then the Transaction has not been confirmed & processed yet. GetTransactionConfirmationsReturnType

Example
```
import { createPublicClient, http } from 'viem'
import { mainnet } from 'viem/chains'

const client = createPublicClient({
  chain: mainnet,
  transport: http(),
})
const confirmations = await client.getTransactionConfirmations({
  hash: '0x4ca7ee652d57678f26e887c149ab0735f41de37bcad58c9f6d3ed5824f15b74d',
})
```
- - (args): Promise<GetTransactionConfirmationsReturnType>
  - Returns the number of blocks passed (confirmations) since the transaction was processed on a block.
    - Docs: https://viem.sh/docs/actions/public/getTransactionConfirmations.html
    - Example: https://stackblitz.com/github/wevm/viem/tree/main/examples/transactions/fetching-transactions
    - JSON-RPC Methods: eth_getTransactionConfirmations
    Parameters
    - args: GetTransactionConfirmationsParameters<TChain>
      GetTransactionConfirmationsParameters
    Returns Promise<GetTransactionConfirmationsReturnType>
    The number of blocks passed since the transaction was processed. If confirmations is 0, then the Transaction has not been confirmed & processed yet. GetTransactionConfirmationsReturnType
    Example
```
import { createPublicClient, http } from 'viem'
import { mainnet } from 'viem/chains'

const client = createPublicClient({
  chain: mainnet,
  transport: http(),
})
const confirmations = await client.getTransactionConfirmations({
  hash: '0x4ca7ee652d57678f26e887c149ab0735f41de37bcad58c9f6d3ed5824f15b74d',
})
```
getTransactionCount: ((args) => Promise<GetTransactionCountReturnType>)
Returns the number of Transactions an Account has broadcast / sent.
- Docs: https://viem.sh/docs/actions/public/getTransactionCount.html
- JSON-RPC Methods: eth_getTransactionCount
Param: args
GetTransactionCountParameters

Returns
The number of transactions an account has sent. GetTransactionCountReturnType

Example
```
import { createPublicClient, http } from 'viem'
import { mainnet } from 'viem/chains'

const client = createPublicClient({
  chain: mainnet,
  transport: http(),
})
const transactionCount = await client.getTransactionCount({
  address: '0xA0Cf798816D4b9b9866b5330EEa46a18382f251e',
})
```
- - (args): Promise<GetTransactionCountReturnType>
  - Returns the number of Transactions an Account has broadcast / sent.
    - Docs: https://viem.sh/docs/actions/public/getTransactionCount.html
    - JSON-RPC Methods: eth_getTransactionCount
    Parameters
    - args: GetTransactionCountParameters
      GetTransactionCountParameters
    Returns Promise<GetTransactionCountReturnType>
    The number of transactions an account has sent. GetTransactionCountReturnType
    Example
```
import { createPublicClient, http } from 'viem'
import { mainnet } from 'viem/chains'

const client = createPublicClient({
  chain: mainnet,
  transport: http(),
})
const transactionCount = await client.getTransactionCount({
  address: '0xA0Cf798816D4b9b9866b5330EEa46a18382f251e',
})
```
getTransactionReceipt: ((args) => Promise<GetTransactionReceiptReturnType<TChain>>)
Returns the Transaction Receipt given a Transaction hash.
- Docs: https://viem.sh/docs/actions/public/getTransactionReceipt.html
- Example: https://stackblitz.com/github/wevm/viem/tree/main/examples/transactions/fetching-transactions
- JSON-RPC Methods: eth_getTransactionReceipt
Param: args
GetTransactionReceiptParameters

Returns
The transaction receipt. GetTransactionReceiptReturnType

Example
```
import { createPublicClient, http } from 'viem'
import { mainnet } from 'viem/chains'

const client = createPublicClient({
  chain: mainnet,
  transport: http(),
})
const transactionReceipt = await client.getTransactionReceipt({
  hash: '0x4ca7ee652d57678f26e887c149ab0735f41de37bcad58c9f6d3ed5824f15b74d',
})
```
- - (args): Promise<GetTransactionReceiptReturnType<TChain>>
  - Returns the Transaction Receipt given a Transaction hash.
    - Docs: https://viem.sh/docs/actions/public/getTransactionReceipt.html
    - Example: https://stackblitz.com/github/wevm/viem/tree/main/examples/transactions/fetching-transactions
    - JSON-RPC Methods: eth_getTransactionReceipt
    Parameters
    - args: GetTransactionReceiptParameters
      GetTransactionReceiptParameters
    Returns Promise<GetTransactionReceiptReturnType<TChain>>
    The transaction receipt. GetTransactionReceiptReturnType
    Example
```
import { createPublicClient, http } from 'viem'
import { mainnet } from 'viem/chains'

const client = createPublicClient({
  chain: mainnet,
  transport: http(),
})
const transactionReceipt = await client.getTransactionReceipt({
  hash: '0x4ca7ee652d57678f26e887c149ab0735f41de37bcad58c9f6d3ed5824f15b74d',
})
```

multicall: (<TContracts, TAllowFailure>(args) => Promise<MulticallReturnType<TContracts, TAllowFailure>>)

Similar to readContract, but batches up multiple functions on a contract in a single RPC call via the multicall3 contract.

Docs: https://viem.sh/docs/contract/multicall.html

Param: args

MulticallParameters

Returns

An array of results with accompanying status. MulticallReturnType

Example

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' }]

<TContracts, TAllowFailure>(args): Promise<MulticallReturnType<TContracts, TAllowFailure>>

Similar to readContract, but batches up multiple functions on a contract in a single RPC call via the multicall3 contract.

Docs: https://viem.sh/docs/contract/multicall.html

Type Parameters

TContracts extends ContractFunctionConfig[]
TAllowFailure extends boolean = true

Parameters

args: MulticallParameters<TContracts, TAllowFailure>
MulticallParameters

Returns Promise<MulticallReturnType<TContracts, TAllowFailure>>

An array of results with accompanying status. MulticallReturnType

Example

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' }]

prepareTransactionRequest: (<TChainOverride>(args) => Promise<PrepareTransactionRequestReturnType>)

Prepares a transaction request for signing.

Docs: https://viem.sh/docs/actions/wallet/prepareTransactionRequest.html

Param: args

PrepareTransactionRequestParameters

Returns

The transaction request. PrepareTransactionRequestReturnType

Example

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,
})

Example

// 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,
})

<TChainOverride>(args): Promise<PrepareTransactionRequestReturnType>

Prepares a transaction request for signing.

Docs: https://viem.sh/docs/actions/wallet/prepareTransactionRequest.html

Type Parameters

TChainOverride extends Chain | undefined = undefined

Parameters

args: PrepareTransactionRequestParameters<TChain, TAccount, TChainOverride>
PrepareTransactionRequestParameters

Returns Promise<PrepareTransactionRequestReturnType>

The transaction request. PrepareTransactionRequestReturnType

Example

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,
})

Example

// 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,
})

readContract: (<const TAbi, TFunctionName>(args) => Promise<ReadContractReturnType<TAbi, TFunctionName>>)
Calls a read-only function on a contract, and returns the response.
- Docs: https://viem.sh/docs/contract/readContract.html
- Examples: https://stackblitz.com/github/wevm/viem/tree/main/examples/contracts/reading-contracts
Remarks
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.

Param: args
ReadContractParameters

Returns
The response from the contract. Type is inferred. ReadContractReturnType

Example
```
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
```
- - <const TAbi, TFunctionName>(args): Promise<ReadContractReturnType<TAbi, TFunctionName>>
  - Calls a read-only function on a contract, and returns the response.
    - Docs: https://viem.sh/docs/contract/readContract.html
    - Examples: https://stackblitz.com/github/wevm/viem/tree/main/examples/contracts/reading-contracts
    Type Parameters
    - const TAbi extends Abi | readonly unknown[]
    - TFunctionName extends string
    Parameters
    - args: ReadContractParameters<TAbi, TFunctionName>
      ReadContractParameters
    Returns Promise<ReadContractReturnType<TAbi, TFunctionName>>
    The response from the contract. Type is inferred. ReadContractReturnType
    Remarks
    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.
    
    Example
```
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
```

sendRawTransaction: ((args) => Promise<SendRawTransactionReturnType>)

Sends a signed transaction to the network

Docs: https://viem.sh/docs/actions/wallet/sendRawTransaction.html
JSON-RPC Method: eth_sendRawTransaction

Param: client

Client to use

Param: parameters

SendRawTransactionParameters

Returns

The transaction hash. SendRawTransactionReturnType

Example

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'
})

(args): Promise<SendRawTransactionReturnType>

Sends a signed transaction to the network

Docs: https://viem.sh/docs/actions/wallet/sendRawTransaction.html
JSON-RPC Method: eth_sendRawTransaction

Parameters

args: SendRawTransactionParameters

Returns Promise<SendRawTransactionReturnType>

The transaction hash. SendRawTransactionReturnType

Example

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'
})

simulateContract: (<const TAbi, TFunctionName, TChainOverride>(args) => Promise<SimulateContractReturnType<TAbi, TFunctionName, TChain, TChainOverride>>)
Simulates/validates a contract interaction. This is useful for retrieving return data and revert reasons of contract write functions.
- Docs: https://viem.sh/docs/contract/simulateContract.html
- Examples: https://stackblitz.com/github/wevm/viem/tree/main/examples/contracts/writing-to-contracts
Remarks
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.

Param: args
SimulateContractParameters

Returns
The simulation result and write request. SimulateContractReturnType

Example
```
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',
})
```
- - <const TAbi, TFunctionName, TChainOverride>(args): Promise<SimulateContractReturnType<TAbi, TFunctionName, TChain, TChainOverride>>
  - Simulates/validates a contract interaction. This is useful for retrieving return data and revert reasons of contract write functions.
    - Docs: https://viem.sh/docs/contract/simulateContract.html
    - Examples: https://stackblitz.com/github/wevm/viem/tree/main/examples/contracts/writing-to-contracts
    Type Parameters
    - const TAbi extends Abi | readonly unknown[]
    - TFunctionName extends string
    - TChainOverride extends Chain | undefined = undefined
    Parameters
    - args: SimulateContractParameters<TAbi, TFunctionName, TChain, TChainOverride>
      SimulateContractParameters
    Returns Promise<SimulateContractReturnType<TAbi, TFunctionName, TChain, TChainOverride>>
    The simulation result and write request. SimulateContractReturnType
    Remarks
    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.
    
    Example
```
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',
})
```
uninstallFilter: ((args) => Promise<UninstallFilterReturnType>)
Destroys a Filter that was created from one of the following Actions:
- createBlockFilter
- createEventFilter
- createPendingTransactionFilter
- Docs: https://viem.sh/docs/actions/public/uninstallFilter.html
- JSON-RPC Methods: eth_uninstallFilter
Param: args
UninstallFilterParameters

Returns
A boolean indicating if the Filter was successfully uninstalled. UninstallFilterReturnType

Example
```
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
```
- - (args): Promise<UninstallFilterReturnType>
  - Destroys a Filter that was created from one of the following Actions:
    - createBlockFilter
    - createEventFilter
    - createPendingTransactionFilter
    - Docs: https://viem.sh/docs/actions/public/uninstallFilter.html
    - JSON-RPC Methods: eth_uninstallFilter
    Parameters
    - args: UninstallFilterParameters
      UninstallFilterParameters
    Returns Promise<UninstallFilterReturnType>
    A boolean indicating if the Filter was successfully uninstalled. UninstallFilterReturnType
    Example
```
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
```
verifyMessage: ((args) => Promise<VerifyMessageReturnType>)
- - (args): Promise<VerifyMessageReturnType>
  - Parameters
    - args: VerifyMessageParameters
    Returns Promise<VerifyMessageReturnType>
verifyTypedData: ((args) => Promise<VerifyTypedDataReturnType>)
- - (args): Promise<VerifyTypedDataReturnType>
  - Parameters
    - args: VerifyTypedDataParameters
    Returns Promise<VerifyTypedDataReturnType>
waitForTransactionReceipt: ((args) => Promise<WaitForTransactionReceiptReturnType<TChain>>)
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.
- Docs: https://viem.sh/docs/actions/public/waitForTransactionReceipt.html
- Example: https://stackblitz.com/github/wevm/viem/tree/main/examples/transactions/sending-transactions
- JSON-RPC Methods:
  - Polls eth_getTransactionReceipt on each block until it has been processed.
  - If a Transaction has been replaced:
    - Calls eth_getBlockByNumber and extracts the transactions
    - Checks if one of the Transactions is a replacement
    - If so, calls eth_getTransactionReceipt.
Remarks
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)
Param: args
WaitForTransactionReceiptParameters

Returns
The transaction receipt. WaitForTransactionReceiptReturnType

Example
```
import { createPublicClient, http } from 'viem'
import { mainnet } from 'viem/chains'

const client = createPublicClient({
  chain: mainnet,
  transport: http(),
})
const transactionReceipt = await client.waitForTransactionReceipt({
  hash: '0x4ca7ee652d57678f26e887c149ab0735f41de37bcad58c9f6d3ed5824f15b74d',
})
```
- - (args): Promise<WaitForTransactionReceiptReturnType<TChain>>
  - 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.
    - Docs: https://viem.sh/docs/actions/public/waitForTransactionReceipt.html
    - Example: https://stackblitz.com/github/wevm/viem/tree/main/examples/transactions/sending-transactions
    - JSON-RPC Methods:
      
      Polls eth_getTransactionReceipt on each block until it has been processed.
      
      If a Transaction has been replaced:
      
      Calls eth_getBlockByNumber and extracts the transactions
      
      Checks if one of the Transactions is a replacement
      
      If so, calls eth_getTransactionReceipt.
    Parameters
    - args: WaitForTransactionReceiptParameters<TChain>
      WaitForTransactionReceiptParameters
    Returns Promise<WaitForTransactionReceiptReturnType<TChain>>
    The transaction receipt. WaitForTransactionReceiptReturnType
    Remarks
    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)
    Example
```
import { createPublicClient, http } from 'viem'
import { mainnet } from 'viem/chains'

const client = createPublicClient({
  chain: mainnet,
  transport: http(),
})
const transactionReceipt = await client.waitForTransactionReceipt({
  hash: '0x4ca7ee652d57678f26e887c149ab0735f41de37bcad58c9f6d3ed5824f15b74d',
})
```
watchBlockNumber: ((args) => WatchBlockNumberReturnType)
Watches and returns incoming block numbers.
- Docs: https://viem.sh/docs/actions/public/watchBlockNumber.html
- Examples: https://stackblitz.com/github/wevm/viem/tree/main/examples/blocks/watching-blocks
- JSON-RPC Methods:
  - When poll: true, calls eth_blockNumber on a polling interval.
  - When poll: false & WebSocket Transport, uses a WebSocket subscription via eth_subscribe and the "newHeads" event.
Param: args
WatchBlockNumberParameters

Returns
A function that can be invoked to stop watching for new block numbers. WatchBlockNumberReturnType

Example
```
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),
})
```
- - (args): WatchBlockNumberReturnType
  - Watches and returns incoming block numbers.
    - Docs: https://viem.sh/docs/actions/public/watchBlockNumber.html
    - Examples: https://stackblitz.com/github/wevm/viem/tree/main/examples/blocks/watching-blocks
    - JSON-RPC Methods:
      
      When poll: true, calls eth_blockNumber on a polling interval.
      
      When poll: false & WebSocket Transport, uses a WebSocket subscription via eth_subscribe and the "newHeads" event.
    Parameters
    - args: WatchBlockNumberParameters
      WatchBlockNumberParameters
    Returns WatchBlockNumberReturnType
    A function that can be invoked to stop watching for new block numbers. WatchBlockNumberReturnType
    Example
```
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),
})
```
watchBlocks: (<TIncludeTransactions, TBlockTag>(args) => WatchBlocksReturnType)
Watches and returns information for incoming blocks.
- Docs: https://viem.sh/docs/actions/public/watchBlocks.html
- Examples: https://stackblitz.com/github/wevm/viem/tree/main/examples/blocks/watching-blocks
- JSON-RPC Methods:
  - When poll: true, calls eth_getBlockByNumber on a polling interval.
  - When poll: false & WebSocket Transport, uses a WebSocket subscription via eth_subscribe and the "newHeads" event.
Param: args
WatchBlocksParameters

Returns
A function that can be invoked to stop watching for new block numbers. WatchBlocksReturnType

Example
```
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),
})
```
- - <TIncludeTransactions, TBlockTag>(args): WatchBlocksReturnType
  - Watches and returns information for incoming blocks.
    - Docs: https://viem.sh/docs/actions/public/watchBlocks.html
    - Examples: https://stackblitz.com/github/wevm/viem/tree/main/examples/blocks/watching-blocks
    - JSON-RPC Methods:
      
      When poll: true, calls eth_getBlockByNumber on a polling interval.
      
      When poll: false & WebSocket Transport, uses a WebSocket subscription via eth_subscribe and the "newHeads" event.
    Type Parameters
    - TIncludeTransactions extends boolean = false
    - TBlockTag extends BlockTag = "latest"
    Parameters
    - args: WatchBlocksParameters<TTransport, TChain, TIncludeTransactions, TBlockTag>
      WatchBlocksParameters
    Returns WatchBlocksReturnType
    A function that can be invoked to stop watching for new block numbers. WatchBlocksReturnType
    Example
```
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),
})
```
watchContractEvent: (<const TAbi, TEventName, TStrict>(args) => WatchContractEventReturnType)
Watches and returns emitted contract event logs.
- Docs: https://viem.sh/docs/contract/watchContractEvent.html
Remarks
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.

Param: args
WatchContractEventParameters

Returns
A function that can be invoked to stop watching for new event logs. WatchContractEventReturnType

Example
```
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),
})
```
- - <const TAbi, TEventName, TStrict>(args): WatchContractEventReturnType
  - Watches and returns emitted contract event logs.
    - Docs: https://viem.sh/docs/contract/watchContractEvent.html
    Type Parameters
    - const TAbi extends Abi | readonly unknown[]
    - TEventName extends string
    - TStrict extends boolean | undefined = undefined
    Parameters
    - args: WatchContractEventParameters<TAbi, TEventName, TStrict>
      WatchContractEventParameters
    Returns WatchContractEventReturnType
    A function that can be invoked to stop watching for new event logs. WatchContractEventReturnType
    Remarks
    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.
    
    Example
```
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),
})
```
watchEvent: (<const TAbiEvent, const TAbiEvents, TStrict>(args) => WatchEventReturnType)
Watches and returns emitted Event Logs.
- Docs: https://viem.sh/docs/actions/public/watchEvent.html
- JSON-RPC Methods:
  - RPC Provider supports eth_newFilter:
    - Calls eth_newFilter to create a filter (called on initialize).
    - On a polling interval, it will call eth_getFilterChanges.
  - RPC Provider does not support eth_newFilter:
    - Calls eth_getLogs for each block between the polling interval.
Remarks
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.

Param: args
WatchEventParameters

Returns
A function that can be invoked to stop watching for new Event Logs. WatchEventReturnType

Example
```
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),
})
```
- - <const TAbiEvent, const TAbiEvents, TStrict>(args): WatchEventReturnType
  - Watches and returns emitted Event Logs.
    - Docs: https://viem.sh/docs/actions/public/watchEvent.html
    - JSON-RPC Methods:
      
      RPC Provider supports eth_newFilter:
      
      Calls eth_newFilter to create a filter (called on initialize).
      
      On a polling interval, it will call eth_getFilterChanges.
      
      RPC Provider does not support eth_newFilter:
      
      Calls eth_getLogs for each block between the polling interval.
    Type Parameters
    - const TAbiEvent extends AbiEvent | undefined = undefined
    - const TAbiEvents extends readonly AbiEvent[] | readonly unknown[] | undefined = TAbiEvent extends AbiEvent
      ? [TAbiEvent]
      : undefined
    - TStrict extends boolean | undefined = undefined
    Parameters
    - args: WatchEventParameters<TAbiEvent, TAbiEvents, TStrict>
      WatchEventParameters
    Returns WatchEventReturnType
    A function that can be invoked to stop watching for new Event Logs. WatchEventReturnType
    Remarks
    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.
    
    Example
```
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),
})
```
watchPendingTransactions: ((args) => WatchPendingTransactionsReturnType)
Watches and returns pending transaction hashes.
- Docs: https://viem.sh/docs/actions/public/watchPendingTransactions.html
- JSON-RPC Methods:
  - When poll: true
    - Calls eth_newPendingTransactionFilter to initialize the filter.
    - Calls eth_getFilterChanges on a polling interval.
  - When poll: false & WebSocket Transport, uses a WebSocket subscription via eth_subscribe and the "newPendingTransactions" event.
Remarks
This Action will batch up all the pending transactions found within the pollingInterval, and invoke them via onTransactions.

Param: args
WatchPendingTransactionsParameters

Returns
A function that can be invoked to stop watching for new pending transaction hashes. WatchPendingTransactionsReturnType

Example
```
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),
})
```
- - (args): WatchPendingTransactionsReturnType
  - Watches and returns pending transaction hashes.
    - Docs: https://viem.sh/docs/actions/public/watchPendingTransactions.html
    - JSON-RPC Methods:
      
      When poll: true
      
      Calls eth_newPendingTransactionFilter to initialize the filter.
      
      Calls eth_getFilterChanges on a polling interval.
      
      When poll: false & WebSocket Transport, uses a WebSocket subscription via eth_subscribe and the "newPendingTransactions" event.
    Parameters
    - args: WatchPendingTransactionsParameters<TTransport>
      WatchPendingTransactionsParameters
    Returns WatchPendingTransactionsReturnType
    A function that can be invoked to stop watching for new pending transaction hashes. WatchPendingTransactionsReturnType
    Remarks
    This Action will batch up all the pending transactions found within the pollingInterval, and invoke them via onTransactions.
    
    Example
```
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),
})
```

Type alias PublicActions<TTransport, TChain, TAccount>

Type Parameters

TTransport extends Transport = Transport

TChain extends Chain | undefined = Chain | undefined

TAccount extends Account | undefined = Account | undefined

Type declaration

call: ((parameters) => Promise<CallReturnType>)

Param: args

Returns

Example

Parameters

parameters: CallParameters<TChain>

Returns Promise<CallReturnType>

Example

createBlockFilter: (() => Promise<CreateBlockFilterReturnType>)

Returns

Example

Returns Promise<CreateBlockFilterReturnType>

Example

createContractEventFilter: (<const TAbi, TEventName, TArgs, TStrict, TFromBlock, TToBlock>(args) => Promise<CreateContractEventFilterReturnType<TAbi, TEventName, TArgs, TStrict, TFromBlock, TToBlock>>)

Param: args

Returns

Example

Type Parameters

const TAbi extends Abi | readonly unknown[]

TEventName extends string | undefined

TArgs extends MaybeExtractEventArgsFromAbi<TAbi, TEventName> | undefined

TStrict extends boolean | undefined = undefined

TFromBlock extends BlockNumber | BlockTag | undefined = undefined

TToBlock extends BlockNumber | BlockTag | undefined = undefined

Parameters

args: CreateContractEventFilterParameters<TAbi, TEventName, TArgs, TStrict, TFromBlock, TToBlock>

Returns Promise<CreateContractEventFilterReturnType<TAbi, TEventName, TArgs, TStrict, TFromBlock, TToBlock>>

Example

createEventFilter: (<const TAbiEvent, const TAbiEvents, TStrict, TFromBlock, TToBlock, _EventName, _Args>(args?) => Promise<CreateEventFilterReturnType<TAbiEvent, TAbiEvents, TStrict, TFromBlock, TToBlock, _EventName, _Args>>)

Param: args

Returns

Example

Type Parameters

const TAbiEvent extends AbiEvent | undefined = undefined

const TAbiEvents extends readonly AbiEvent[] | readonly unknown[] | undefined = TAbiEvent extends AbiEvent ? [TAbiEvent] : undefined

TStrict extends boolean | undefined = undefined

TFromBlock extends BlockNumber | BlockTag | undefined = undefined

TToBlock extends BlockNumber | BlockTag | undefined = undefined

_EventName extends string | undefined = MaybeAbiEventName<TAbiEvent>

_Args extends MaybeExtractEventArgsFromAbi<TAbiEvents, _EventName> | undefined = undefined

Parameters

Optional args: CreateEventFilterParameters<TAbiEvent, TAbiEvents, TStrict, TFromBlock, TToBlock, _EventName, _Args>

Returns Promise<CreateEventFilterReturnType<TAbiEvent, TAbiEvents, TStrict, TFromBlock, TToBlock, _EventName, _Args>>

Example

createPendingTransactionFilter: (() => Promise<CreatePendingTransactionFilterReturnType>)

Returns

Example

Returns Promise<CreatePendingTransactionFilterReturnType>

Example

estimateContractGas: (<TChain, const TAbi, TFunctionName>(args) => Promise<EstimateContractGasReturnType>)

Remarks

Param: args

Returns

Example

Type Parameters

TChain extends Chain | undefined

const TAbi extends Abi | readonly unknown[]

TFunctionName extends string

Parameters

args: EstimateContractGasParameters<TAbi, TFunctionName, TChain, TAccount>

Returns Promise<EstimateContractGasReturnType>

Remarks

Example

estimateFeesPerGas: (<TChainOverride, TType>(args?) => Promise<EstimateFeesPerGasReturnType>)

Param: client

Param: parameters

Returns

Example

Type Parameters

TChainOverride extends Chain | undefined = undefined

TType extends FeeValuesType = "eip1559"

Parameters

Optional args: EstimateFeesPerGasParameters<TChain, TChainOverride, TType>

Returns Promise<EstimateFeesPerGasReturnType>

const TAbiEvents extends readonly AbiEvent[] | readonly unknown[] | undefined = TAbiEvent extends AbiEvent
? [TAbiEvent]
: undefined

`Optional` args: CreateEventFilterParameters<TAbiEvent, TAbiEvents, TStrict, TFromBlock, TToBlock, _EventName, _Args>

`Optional` args: EstimateFeesPerGasParameters<TChain, TChainOverride, TType>

`Optional` args: EstimateMaxPriorityFeePerGasParameters<TChain, TChainOverride>

`Optional` args: GetBlockParameters<TIncludeTransactions, TBlockTag>

`Optional` args: GetBlockNumberParameters

`Optional` args: GetBlockTransactionCountParameters