getWalletClient

Action for getting a Viem WalletClient object for the current or provided connector.

Import

import { getWalletClient } from '@wagmi/core'

Usage

index.ts

import { getWalletClient } from '@wagmi/core'
import { config } from './config'

const client = getWalletClient(config)

config.ts

import { http, createConfig } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

WARNING

If you want to optimize bundle size, you should use getConnectorClient along with Viem's tree-shakable actions instead. Since Wallet Client has all wallet actions attached directly to it.

Parameters

import { type GetWalletClientParameters } from '@wagmi/core'

account

Address | Account | undefined

Account to use with client. Throws if account is not found on connector.

index.ts

import { getWalletClient } from '@wagmi/core'
import { config } from './config'

const client = getWalletClient(config, {
  account: '0xd2135CfB216b74109775236E36d4b433F1DF507B', 
})

config.ts

import { http, createConfig } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

chainId

config['chains'][number]['id'] | undefined

ID of chain to use with client.

index.ts

import { getWalletClient } from '@wagmi/core'
import { mainnet } from '@wagmi/core/chains'
import { config } from './config'

const client = getWalletClient(config, {
  chainId: mainnet.id, 
})

config.ts

import { http, createConfig } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

connector

Connector | undefined

• Connector to get client for.
• Defaults to current connector.

index.ts

import { getConnections, getWalletClient } from '@wagmi/core'
import { config } from './config'

const connections = getConnections(config)
const client = getWalletClient(config, {
  connector: connections[0]?.connector, 
})

config.ts

import { http, createConfig } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

Return Type

import { type GetChainIdReturnType } from '@wagmi/core'

WalletClient

Viem WalletClient object for the current or provided connector.

Error

import { type GetWalletClientErrorType } from '@wagmi/core'

TanStack Query

import {
  type GetWalletClientData,
  type GetWalletClientOptions,
  type GetWalletClientQueryFnData,
  type GetWalletClientQueryKey,
  getWalletClientQueryKey,
  getWalletClientQueryOptions,
} from '@wagmi/core/query'