Test Client
A Test Client is an interface to "test" JSON-RPC API methods accessible through a local Ethereum test node such as Anvil or Hardhat such as mining blocks, impersonating accounts, setting fees, etc through Test Actions.
The createTestClient function sets up a Test RPC Client with a given Transport.
Import
ts
import { createTestClient } from 'viem'
Usage
Initialize a Client with your desired Chain, Transport (e.g. http) and mode (e.g. "anvil").
ts
import { createTestClient, http } from 'viem'
import { foundry } from 'viem/chains'
const client = createTestClient({
chain: foundry,
mode: 'anvil',
transport: http(),
})
Then you can consume Test Actions:
ts
const mine = await client.mine({ blocks: 1 })
Parameters
mode
- Type:
"anvil" | "hardhat" | "ganache"
Mode of the Test Client.
ts
const client = createTestClient({
chain: foundry,
mode: 'anvil',
transport: http(),
})
transport
- Type: Transport
Transport of the Test Client.
ts
const client = createTestClient({
chain: foundry,
mode: 'anvil',
transport: http(),
})
chain (optional)
- Type: Chain
Chain of the Test Client.
ts
const client = createTestClient({
chain: foundry,
mode: 'anvil',
transport: http(),
})
name (optional)
- Type:
string - Default:
"Test Client"
A name for the Client.
ts
const client = createTestClient({
chain: foundry,
mode: 'anvil',
name: 'Anvil Client',
transport: http(),
})
pollingInterval (optional)
- Type:
number - Default:
4_000
Frequency (in ms) for polling enabled Actions.
ts
const client = createTestClient({
chain: foundry,
mode: 'anvil',
pollingInterval: 10_000,
transport: http(),
})