Add usage example with viem test client #28

What is the type of issue?

Documentation is missing

What is the issue?

There is no usage example with viem test client

Where did you find it?

Problem

Following the the example from README I created a prool server:

import { createServer } from 'prool'
import { anvil } from 'prool/instances'

const server = createServer({
  instance: anvil(),
})
await server.start()

After that following viem docs I created a test client:

import { createTestClient, http } from 'viem'
import { foundry } from 'viem/chains'
 
const client = createTestClient({
  chain: foundry,
  mode: 'anvil',
  transport: http(), 
})

After calling client.mine({ blocks: 1 }) I expected my transaction to be mined. Instead I received ECONNREFUSED error.

Solution

After some investigation I managed to make this set up working by explicitly starting anvil instance:

import { createServer } from 'prool'
import { anvil } from 'prool/instances'

const instance = anvil()
await instance.start()
const server = createServer({ instance })
await server.start()

This way client.mine works as expected.

Versions

viem: 2.21.1
prool: 0.0.16

Resolution

I believe usage example with viem test client should be either added to prool README or to viem docs.