Skip to content
On this page

Wallet Client

The createWalletClient function sets up a Wallet Client with a given Transport.

The Wallet Client provides access to Wallet Actions

Import

ts
import { createWalletClient } from 'viem'

Usage

Initialize a Client with your desired Transport (e.g. custom).

ts
import { createWalletClient, custom } from 'viem'

const client = createWalletClient({
  transport: custom(window.ethereum)
})

Parameters

key (optional)

  • Type: string
  • Default: "wallet"

A key for the Client.

ts
import { createWalletClient, custom } from 'viem'

const client = createWalletClient({
  key: 'foo', 
  transport: custom(window.ethereum)
})

name (optional)

  • Type: string
  • Default: "Wallet Client"

A name for the Client.

ts
import { createWalletClient, custom } from 'viem'

const client = createWalletClient({
  name: 'Foo Wallet Client', 
  transport: custom(window.ethereum)
})

pollingInterval (optional)

  • Type: number
  • Default: 4_000

Frequency (in ms) for polling enabled Actions.

ts
import { createWalletClient, custom } from 'viem'

const client = createWalletClient({
  pollingInterval: 10_000, 
  transport: custom(window.ethereum)
})

Released under the MIT License.