WalletClientSigner

client

{ account: undefined | Account; addChain: (args) => Promise<void>; batch?: { multicall?: | boolean | { batchSize?: number; wait?: number; }; }; cacheTime: number; ccipRead?: | false | { request?: (parameters) => Promise<`0x${string}`>; }; chain: undefined | Chain; deployContract: <abi, chainOverride>(args) => Promise<`0x${string}`>; experimental_blockTag?: BlockTag; extend: <client>(fn) => Client<Transport, undefined | Chain, undefined | Account, WalletRpcSchema, { [K in string | number | symbol]: client[K] } & WalletActions<undefined | Chain, undefined | Account>>; getAddresses: () => Promise<GetAddressesReturnType>; getCallsStatus: (parameters) => Promise<{ atomic: boolean; capabilities?: | { [key: string]: any; } | { [key: string]: any; }; chainId: number; id: string; receipts?: WalletCallReceipt<bigint, "success" | "reverted">[]; status: undefined | "pending" | "success" | "failure"; statusCode: number; version: string; }>; getCapabilities: <chainId>(parameters?) => Promise<{ [K in string | number | symbol]: (chainId extends number ? { atomic?: { status: “ready” | “supported” | “unsupported” }; paymasterService?: { supported: boolean }; unstable_addSubAccount?: { keyTypes: ((…) | (…) | (…) | (…))[]; supported: boolean }; [key: string]: any } : ChainIdToCapabilities<Capabilities<{ atomic?: { status: … }; paymasterService?: { supported: … }; unstable_addSubAccount?: { keyTypes: …; supported: … }; [key: string]: any }>, number>)[K] }>; getChainId: () => Promise<number>; getPermissions: () => Promise<GetPermissionsReturnType>; key: string; name: string; pollingInterval: number; prepareAuthorization: (parameters) => Promise<PrepareAuthorizationReturnType>; prepareTransactionRequest: <request, chainOverride, accountOverride>(args) => Promise<{ [K in string | number | symbol]: (UnionRequiredBy<Extract<UnionOmit<(…), (…)> & ((…) extends (…) ? (…) : (…)) & ((…) extends (…) ? (…) : (…)), IsNever<(…)> extends true ? unknown : ExactPartial<(…)>> & { chainId?: number }, ParameterTypeToParameters<request[“parameters”] extends readonly PrepareTransactionRequestParameterType[] ? any[any][number] : “type” | “gas” | “nonce” | “blobVersionedHashes” | “fees” | “chainId”>> & (unknown extends request[“kzg”] ? {} : Pick<request, “kzg”>))[K] }>; request: EIP1193RequestFn<WalletRpcSchema>; requestAddresses: () => Promise<RequestAddressesReturnType>; requestPermissions: (args) => Promise<RequestPermissionsReturnType>; sendCalls: <calls, chainOverride>(parameters) => Promise<{ capabilities?: { [key: string]: any; }; id: string; }>; sendRawTransaction: (args) => Promise<`0x${string}`>; sendTransaction: <request, chainOverride>(args) => Promise<`0x${string}`>; showCallsStatus: (parameters) => Promise<void>; signAuthorization: (parameters) => Promise<SignAuthorizationReturnType>; signMessage: (args) => Promise<`0x${string}`>; signTransaction: <chainOverride, request>(args) => Promise<TransactionSerialized<GetTransactionType<request, | request extends LegacyProperties ? "legacy" : never | request extends EIP1559Properties ? "eip1559" : never | request extends EIP2930Properties ? "eip2930" : never | request extends EIP4844Properties ? "eip4844" : never | request extends EIP7702Properties ? "eip7702" : never | request["type"] extends undefined | string ? Extract<any[any], string> : never>, | GetTransactionType<request, | request extends LegacyProperties ? "legacy" : never | request extends EIP1559Properties ? "eip1559" : never | request extends EIP2930Properties ? "eip2930" : never | request extends EIP4844Properties ? "eip4844" : never | request extends EIP7702Properties ? "eip7702" : never | request["type"] extends undefined | string ? Extract<any[any], string> : never> extends "eip1559" ? `0x02${string}` : never | GetTransactionType<request, | request extends LegacyProperties ? "legacy" : never | request extends EIP1559Properties ? "eip1559" : never | request extends EIP2930Properties ? "eip2930" : never | request extends EIP4844Properties ? "eip4844" : never | request extends EIP7702Properties ? "eip7702" : never | request["type"] extends undefined | string ? Extract<any[any], string> : never> extends "eip2930" ? `0x01${string}` : never | GetTransactionType<request, | request extends LegacyProperties ? "legacy" : never | request extends EIP1559Properties ? "eip1559" : never | request extends EIP2930Properties ? "eip2930" : never | request extends EIP4844Properties ? "eip4844" : never | request extends EIP7702Properties ? "eip7702" : never | request["type"] extends undefined | string ? Extract<any[any], string> : never> extends "eip4844" ? `0x03${string}` : never | GetTransactionType<request, | request extends LegacyProperties ? "legacy" : never | request extends EIP1559Properties ? "eip1559" : never | request extends EIP2930Properties ? "eip2930" : never | request extends EIP4844Properties ? "eip4844" : never | request extends EIP7702Properties ? "eip7702" : never | request["type"] extends undefined | string ? Extract<any[any], string> : never> extends "eip7702" ? `0x04${string}` : never | GetTransactionType<request, | request extends LegacyProperties ? "legacy" : never | request extends EIP1559Properties ? "eip1559" : never | request extends EIP2930Properties ? "eip2930" : never | request extends EIP4844Properties ? "eip4844" : never | request extends EIP7702Properties ? "eip7702" : never | request["type"] extends undefined | string ? Extract<any[any], string> : never> extends "legacy" ? TransactionSerializedLegacy : never>>; signTypedData: <typedData, primaryType>(args) => Promise<`0x${string}`>; switchChain: (args) => Promise<void>; transport: TransportConfig<string, EIP1193RequestFn> & Record<string, any>; type: string; uid: string; waitForCallsStatus: (parameters) => Promise<{ atomic: boolean; capabilities?: | { [key: string]: any; } | { [key: string]: any; }; chainId: number; id: string; receipts?: WalletCallReceipt<bigint, "success" | "reverted">[]; status: undefined | "pending" | "success" | "failure"; statusCode: number; version: string; }>; watchAsset: (args) => Promise<boolean>; writeContract: <abi, functionName, args, chainOverride>(args) => Promise<`0x${string}`>; }

The wallet client to interact with

client.account

undefined | Account

The Account of the Client.

client.addChain

(args) => Promise<void>

Adds an EVM chain to the wallet.

• Docs: https://viem.sh/docs/actions/wallet/addChain
• JSON-RPC Methods: eth_addEthereumChain

Example

1
import { createWalletClient, custom } from 'viem'
2
import { optimism } from 'viem/chains'
3
4
const client = createWalletClient({
5
  transport: custom(window.ethereum),
6
})
7
await client.addChain({ chain: optimism })

client.batch?

{ multicall?: | boolean | { batchSize?: number; wait?: number; }; }

Flags for batch settings.

client.batch.multicall?

| boolean | { batchSize?: number; wait?: number; }

Toggle to enable eth_call multicall aggregation.

client.cacheTime

number

Time (in ms) that cached data will remain in memory.

client.ccipRead?

| false | { request?: (parameters) => Promise<`0x${string}`>; }

CCIP Read configuration.

client.chain

undefined | Chain

Chain for the client.

client.deployContract

<abi, chainOverride>(args) => Promise<`0x${string}`>

Deploys a contract to the network, given bytecode and constructor arguments.

• Docs: https://viem.sh/docs/contract/deployContract
• Examples: https://stackblitz.com/github/wevm/viem/tree/main/examples/contracts\_deploying-contracts

Example

1
import { createWalletClient, http } from 'viem'
2
import { privateKeyToAccount } from 'viem/accounts'
3
import { mainnet } from 'viem/chains'
4
5
const client = createWalletClient({
6
  account: privateKeyToAccount('0x…'),
7
  chain: mainnet,
8
  transport: http(),
9
})
10
const hash = await client.deployContract({
11
  abi: [],
12
  account: '0x…,
13
  bytecode: '0x608060405260405161083e38038061083e833981016040819052610...',
14
})

client.experimental_blockTag?

BlockTag

Default block tag to use for RPC requests.

client.extend

<client>(fn) => Client<Transport, undefined | Chain, undefined | Account, WalletRpcSchema, { [K in string | number | symbol]: client[K] } & WalletActions<undefined | Chain, undefined | Account>>

‐

client.getAddresses

() => Promise<GetAddressesReturnType>

Returns a list of account addresses owned by the wallet or client.

• Docs: https://viem.sh/docs/actions/wallet/getAddresses
• JSON-RPC Methods: eth_accounts

Example

1
import { createWalletClient, custom } from 'viem'
2
import { mainnet } from 'viem/chains'
3
4
const client = createWalletClient({
5
  chain: mainnet,
6
  transport: custom(window.ethereum),
7
})
8
const accounts = await client.getAddresses()

client.getCallsStatus

(parameters) => Promise<{ atomic: boolean; capabilities?: | { [key: string]: any; } | { [key: string]: any; }; chainId: number; id: string; receipts?: WalletCallReceipt<bigint, "success" | "reverted">[]; status: undefined | "pending" | "success" | "failure"; statusCode: number; version: string; }>

Returns the status of a call batch that was sent via sendCalls.

• Docs: https://viem.sh/docs/actions/wallet/getCallsStatus
• JSON-RPC Methods: wallet_getCallsStatus

Example

1
import { createWalletClient, custom } from 'viem'
2
import { mainnet } from 'viem/chains'
3
4
const client = createWalletClient({
5
  chain: mainnet,
6
  transport: custom(window.ethereum),
7
})
8
9
const { receipts, status } = await client.getCallsStatus({ id: '0xdeadbeef' })

client.getCapabilities

<chainId>(parameters?) => Promise<{ [K in string | number | symbol]: (chainId extends number ? { atomic?: { status: “ready” | “supported” | “unsupported” }; paymasterService?: { supported: boolean }; unstable_addSubAccount?: { keyTypes: ((…) | (…) | (…) | (…))[]; supported: boolean }; [key: string]: any } : ChainIdToCapabilities<Capabilities<{ atomic?: { status: … }; paymasterService?: { supported: … }; unstable_addSubAccount?: { keyTypes: …; supported: … }; [key: string]: any }>, number>)[K] }>

Extract capabilities that a connected wallet supports (e.g. paymasters, session keys, etc).

• Docs: https://viem.sh/docs/actions/wallet/getCapabilities
• JSON-RPC Methods: wallet_getCapabilities

Example

1
import { createWalletClient, custom } from 'viem'
2
import { mainnet } from 'viem/chains'
3
4
const client = createWalletClient({
5
  chain: mainnet,
6
  transport: custom(window.ethereum),
7
})
8
9
const capabilities = await client.getCapabilities({
10
  account: '0xA0Cf798816D4b9b9866b5330EEa46a18382f251e',
11
})

client.getChainId

() => Promise<number>

Returns the chain ID associated with the current network.

• Docs: https://viem.sh/docs/actions/public/getChainId
• JSON-RPC Methods: eth_chainId

Example

1
import { createWalletClient, http } from 'viem'
2
import { mainnet } from 'viem/chains'
3
4
const client = createWalletClient({
5
  chain: mainnet,
6
  transport: custom(window.ethereum),
7
})
8
const chainId = await client.getChainId()
9
// 1

client.getPermissions

() => Promise<GetPermissionsReturnType>

Gets the wallets current permissions.

• Docs: https://viem.sh/docs/actions/wallet/getPermissions
• JSON-RPC Methods: wallet_getPermissions

Example

1
import { createWalletClient, custom } from 'viem'
2
import { mainnet } from 'viem/chains'
3
4
const client = createWalletClient({
5
  chain: mainnet,
6
  transport: custom(window.ethereum),
7
})
8
const permissions = await client.getPermissions()

client.key

string

A key for the client.

client.name

string

A name for the client.

client.pollingInterval

number

Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds.

client.prepareAuthorization

(parameters) => Promise<PrepareAuthorizationReturnType>

Prepares an EIP-7702 Authorization object for signing. This Action will fill the required fields of the Authorization object if they are not provided (e.g. nonce and chainId).

With the prepared Authorization object, you can use signAuthorization to sign over the Authorization object.

Examples

1
import { createWalletClient, http } from 'viem'
2
import { privateKeyToAccount } from 'viem/accounts'
3
import { mainnet } from 'viem/chains'
4
5
const client = createWalletClient({
6
  chain: mainnet,
7
  transport: http(),
8
})
9
10
const authorization = await client.prepareAuthorization({
11
  account: privateKeyToAccount('0x..'),
12
  contractAddress: '0xA0Cf798816D4b9b9866b5330EEa46a18382f251e',
13
})

1
// Account Hoisting
2
import { createWalletClient, http } from 'viem'
3
import { privateKeyToAccount } from 'viem/accounts'
4
import { mainnet } from 'viem/chains'
5
6
const client = createWalletClient({
7
  account: privateKeyToAccount('0x…'),
8
  chain: mainnet,
9
  transport: http(),
10
})
11
12
const authorization = await client.prepareAuthorization({
13
  contractAddress: '0xA0Cf798816D4b9b9866b5330EEa46a18382f251e',
14
})

client.prepareTransactionRequest

<request, chainOverride, accountOverride>(args) => Promise<{ [K in string | number | symbol]: (UnionRequiredBy<Extract<UnionOmit<(…), (…)> & ((…) extends (…) ? (…) : (…)) & ((…) extends (…) ? (…) : (…)), IsNever<(…)> extends true ? unknown : ExactPartial<(…)>> & { chainId?: number }, ParameterTypeToParameters<request[“parameters”] extends readonly PrepareTransactionRequestParameterType[] ? any[any][number] : “type” | “gas” | “nonce” | “blobVersionedHashes” | “fees” | “chainId”>> & (unknown extends request[“kzg”] ? {} : Pick<request, “kzg”>))[K] }>

Prepares a transaction request for signing.

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

Examples

1
import { createWalletClient, custom } from 'viem'
2
import { mainnet } from 'viem/chains'
3
4
const client = createWalletClient({
5
  chain: mainnet,
6
  transport: custom(window.ethereum),
7
})
8
const request = await client.prepareTransactionRequest({
9
  account: '0xA0Cf798816D4b9b9866b5330EEa46a18382f251e',
10
  to: '0x0000000000000000000000000000000000000000',
11
  value: 1n,
12
})

1
// Account Hoisting
2
import { createWalletClient, http } from 'viem'
3
import { privateKeyToAccount } from 'viem/accounts'
4
import { mainnet } from 'viem/chains'
5
6
const client = createWalletClient({
7
  account: privateKeyToAccount('0x…'),
8
  chain: mainnet,
9
  transport: custom(window.ethereum),
10
})
11
const request = await client.prepareTransactionRequest({
12
  to: '0x0000000000000000000000000000000000000000',
13
  value: 1n,
14
})

client.request

EIP1193RequestFn<WalletRpcSchema>

Request function wrapped with friendly error handling

client.requestAddresses

() => Promise<RequestAddressesReturnType>

Requests a list of accounts managed by a wallet.

• Docs: https://viem.sh/docs/actions/wallet/requestAddresses
• JSON-RPC Methods: eth_requestAccounts

Sends a request to the wallet, asking for permission to access the user’s accounts. After the user accepts the request, it will return a list of accounts (addresses).

This API can be useful for dapps that need to access the user’s accounts in order to execute transactions or interact with smart contracts.

Example

1
import { createWalletClient, custom } from 'viem'
2
import { mainnet } from 'viem/chains'
3
4
const client = createWalletClient({
5
  chain: mainnet,
6
  transport: custom(window.ethereum),
7
})
8
const accounts = await client.requestAddresses()

client.requestPermissions

(args) => Promise<RequestPermissionsReturnType>

Requests permissions for a wallet.

• Docs: https://viem.sh/docs/actions/wallet/requestPermissions
• JSON-RPC Methods: wallet_requestPermissions

Example

1
import { createWalletClient, custom } from 'viem'
2
import { mainnet } from 'viem/chains'
3
4
const client = createWalletClient({
5
  chain: mainnet,
6
  transport: custom(window.ethereum),
7
})
8
const permissions = await client.requestPermissions({
9
  eth_accounts: {}
10
})

client.sendCalls

<calls, chainOverride>(parameters) => Promise<{ capabilities?: { [key: string]: any; }; id: string; }>

Requests the connected wallet to send a batch of calls.

• Docs: https://viem.sh/docs/actions/wallet/sendCalls
• JSON-RPC Methods: wallet_sendCalls

Example

1
import { createWalletClient, custom } from 'viem'
2
import { mainnet } from 'viem/chains'
3
4
const client = createWalletClient({
5
  chain: mainnet,
6
  transport: custom(window.ethereum),
7
})
8
9
const id = await client.sendCalls({
10
  account: '0xA0Cf798816D4b9b9866b5330EEa46a18382f251e',
11
  calls: [
12
    {
13
      data: '0xdeadbeef',
14
      to: '0x70997970c51812dc3a010c7d01b50e0d17dc79c8',
15
    },
16
    {
17
      to: '0x70997970c51812dc3a010c7d01b50e0d17dc79c8',
18
      value: 69420n,
19
    },
20
  ],
21
})

client.sendRawTransaction

(args) => Promise<`0x${string}`>

Sends a signed transaction to the network

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

Example

1
import { createWalletClient, custom } from 'viem'
2
import { mainnet } from 'viem/chains'
3
import { sendRawTransaction } from 'viem/wallet'
4
5
const client = createWalletClient({
6
  chain: mainnet,
7
  transport: custom(window.ethereum),
8
})
9
10
const hash = await client.sendRawTransaction({
11
  serializedTransaction: '0x02f850018203118080825208808080c080a04012522854168b27e5dc3d5839bab5e6b39e1a0ffd343901ce1622e3d64b48f1a04e00902ae0502c4728cbf12156290df99c3ed7de85b1dbfe20b5c36931733a33'
12
})

client.sendTransaction

<request, chainOverride>(args) => Promise<`0x${string}`>

Creates, signs, and sends a new transaction to the network.

• Docs: https://viem.sh/docs/actions/wallet/sendTransaction
• Examples: https://stackblitz.com/github/wevm/viem/tree/main/examples/transactions\_sending-transactions
• JSON-RPC Methods:
  • JSON-RPC Accounts: eth_sendTransaction
  • Local Accounts: eth_sendRawTransaction

Examples

1
import { createWalletClient, custom } from 'viem'
2
import { mainnet } from 'viem/chains'
3
4
const client = createWalletClient({
5
  chain: mainnet,
6
  transport: custom(window.ethereum),
7
})
8
const hash = await client.sendTransaction({
9
  account: '0xA0Cf798816D4b9b9866b5330EEa46a18382f251e',
10
  to: '0x70997970c51812dc3a010c7d01b50e0d17dc79c8',
11
  value: 1000000000000000000n,
12
})

1
// Account Hoisting
2
import { createWalletClient, http } from 'viem'
3
import { privateKeyToAccount } from 'viem/accounts'
4
import { mainnet } from 'viem/chains'
5
6
const client = createWalletClient({
7
  account: privateKeyToAccount('0x…'),
8
  chain: mainnet,
9
  transport: http(),
10
})
11
const hash = await client.sendTransaction({
12
  to: '0x70997970c51812dc3a010c7d01b50e0d17dc79c8',
13
  value: 1000000000000000000n,
14
})

client.showCallsStatus

(parameters) => Promise<void>

Requests for the wallet to show information about a call batch that was sent via sendCalls.

• Docs: https://viem.sh/docs/actions/wallet/showCallsStatus
• JSON-RPC Methods: wallet_showCallsStatus

Example

1
import { createWalletClient, custom } from 'viem'
2
import { mainnet } from 'viem/chains'
3
4
const client = createWalletClient({
5
  chain: mainnet,
6
  transport: custom(window.ethereum),
7
})
8
9
await client.showCallsStatus({ id: '0xdeadbeef' })

client.signAuthorization

(parameters) => Promise<SignAuthorizationReturnType>

Signs an EIP-7702 Authorization object.

With the calculated signature, you can:

• use verifyAuthorization to verify the signed Authorization object,
• use recoverAuthorizationAddress to recover the signing address from the signed Authorization object.

Examples

1
import { createWalletClient, http } from 'viem'
2
import { privateKeyToAccount } from 'viem/accounts'
3
import { mainnet } from 'viem/chains'
4
5
const client = createWalletClient({
6
  chain: mainnet,
7
  transport: http(),
8
})
9
10
const signature = await client.signAuthorization({
11
  account: privateKeyToAccount('0x..'),
12
  contractAddress: '0xA0Cf798816D4b9b9866b5330EEa46a18382f251e',
13
})

1
// Account Hoisting
2
import { createWalletClient, http } from 'viem'
3
import { privateKeyToAccount } from 'viem/accounts'
4
import { mainnet } from 'viem/chains'
5
6
const client = createWalletClient({
7
  account: privateKeyToAccount('0x…'),
8
  chain: mainnet,
9
  transport: http(),
10
})
11
12
const signature = await client.signAuthorization({
13
  contractAddress: '0xA0Cf798816D4b9b9866b5330EEa46a18382f251e',
14
})

client.signMessage

(args) => Promise<`0x${string}`>

Calculates an Ethereum-specific signature in EIP-191 format: keccak256("\x19Ethereum Signed Message:\n" + len(message) + message)).

• Docs: https://viem.sh/docs/actions/wallet/signMessage
• JSON-RPC Methods:
  • JSON-RPC Accounts: personal_sign
  • Local Accounts: Signs locally. No JSON-RPC request.

With the calculated signature, you can:

• use verifyMessage to verify the signature,
• use recoverMessageAddress to recover the signing address from a signature.

Examples

1
import { createWalletClient, custom } from 'viem'
2
import { mainnet } from 'viem/chains'
3
4
const client = createWalletClient({
5
  chain: mainnet,
6
  transport: custom(window.ethereum),
7
})
8
const signature = await client.signMessage({
9
  account: '0xA0Cf798816D4b9b9866b5330EEa46a18382f251e',
10
  message: 'hello world',
11
})

1
// Account Hoisting
2
import { createWalletClient, http } from 'viem'
3
import { privateKeyToAccount } from 'viem/accounts'
4
import { mainnet } from 'viem/chains'
5
6
const client = createWalletClient({
7
  account: privateKeyToAccount('0x…'),
8
  chain: mainnet,
9
  transport: http(),
10
})
11
const signature = await client.signMessage({
12
  message: 'hello world',
13
})

client.signTransaction

<chainOverride, request>(args) => Promise<TransactionSerialized<GetTransactionType<request, | request extends LegacyProperties ? "legacy" : never | request extends EIP1559Properties ? "eip1559" : never | request extends EIP2930Properties ? "eip2930" : never | request extends EIP4844Properties ? "eip4844" : never | request extends EIP7702Properties ? "eip7702" : never | request["type"] extends undefined | string ? Extract<any[any], string> : never>, | GetTransactionType<request, | request extends LegacyProperties ? "legacy" : never | request extends EIP1559Properties ? "eip1559" : never | request extends EIP2930Properties ? "eip2930" : never | request extends EIP4844Properties ? "eip4844" : never | request extends EIP7702Properties ? "eip7702" : never | request["type"] extends undefined | string ? Extract<any[any], string> : never> extends "eip1559" ? `0x02${string}` : never | GetTransactionType<request, | request extends LegacyProperties ? "legacy" : never | request extends EIP1559Properties ? "eip1559" : never | request extends EIP2930Properties ? "eip2930" : never | request extends EIP4844Properties ? "eip4844" : never | request extends EIP7702Properties ? "eip7702" : never | request["type"] extends undefined | string ? Extract<any[any], string> : never> extends "eip2930" ? `0x01${string}` : never | GetTransactionType<request, | request extends LegacyProperties ? "legacy" : never | request extends EIP1559Properties ? "eip1559" : never | request extends EIP2930Properties ? "eip2930" : never | request extends EIP4844Properties ? "eip4844" : never | request extends EIP7702Properties ? "eip7702" : never | request["type"] extends undefined | string ? Extract<any[any], string> : never> extends "eip4844" ? `0x03${string}` : never | GetTransactionType<request, | request extends LegacyProperties ? "legacy" : never | request extends EIP1559Properties ? "eip1559" : never | request extends EIP2930Properties ? "eip2930" : never | request extends EIP4844Properties ? "eip4844" : never | request extends EIP7702Properties ? "eip7702" : never | request["type"] extends undefined | string ? Extract<any[any], string> : never> extends "eip7702" ? `0x04${string}` : never | GetTransactionType<request, | request extends LegacyProperties ? "legacy" : never | request extends EIP1559Properties ? "eip1559" : never | request extends EIP2930Properties ? "eip2930" : never | request extends EIP4844Properties ? "eip4844" : never | request extends EIP7702Properties ? "eip7702" : never | request["type"] extends undefined | string ? Extract<any[any], string> : never> extends "legacy" ? TransactionSerializedLegacy : never>>

Signs a transaction.

• Docs: https://viem.sh/docs/actions/wallet/signTransaction
• JSON-RPC Methods:
  • JSON-RPC Accounts: eth_signTransaction
  • Local Accounts: Signs locally. No JSON-RPC request.

Examples

1
import { createWalletClient, custom } from 'viem'
2
import { mainnet } from 'viem/chains'
3
4
const client = createWalletClient({
5
  chain: mainnet,
6
  transport: custom(window.ethereum),
7
})
8
const request = await client.prepareTransactionRequest({
9
  account: '0xA0Cf798816D4b9b9866b5330EEa46a18382f251e',
10
  to: '0x0000000000000000000000000000000000000000',
11
  value: 1n,
12
})
13
const signature = await client.signTransaction(request)

1
// Account Hoisting
2
import { createWalletClient, http } from 'viem'
3
import { privateKeyToAccount } from 'viem/accounts'
4
import { mainnet } from 'viem/chains'
5
6
const client = createWalletClient({
7
  account: privateKeyToAccount('0x…'),
8
  chain: mainnet,
9
  transport: custom(window.ethereum),
10
})
11
const request = await client.prepareTransactionRequest({
12
  to: '0x0000000000000000000000000000000000000000',
13
  value: 1n,
14
})
15
const signature = await client.signTransaction(request)

client.signTypedData

<typedData, primaryType>(args) => Promise<`0x${string}`>

Signs typed data and calculates an Ethereum-specific signature in EIP-191 format: keccak256("\x19Ethereum Signed Message:\n" + len(message) + message)).

• Docs: https://viem.sh/docs/actions/wallet/signTypedData
• JSON-RPC Methods:
  • JSON-RPC Accounts: eth_signTypedData_v4
  • Local Accounts: Signs locally. No JSON-RPC request.

Examples

1
import { createWalletClient, custom } from 'viem'
2
import { mainnet } from 'viem/chains'
3
4
const client = createWalletClient({
5
  chain: mainnet,
6
  transport: custom(window.ethereum),
7
})
8
const signature = await client.signTypedData({
9
  account: '0xA0Cf798816D4b9b9866b5330EEa46a18382f251e',
10
  domain: {
11
    name: 'Ether Mail',
12
    version: '1',
13
    chainId: 1,
14
    verifyingContract: '0xCcCCccccCCCCcCCCCCCcCcCccCcCCCcCcccccccC',
15
  },
16
  types: {
17
    Person: [
18
      { name: 'name', type: 'string' },
19
      { name: 'wallet', type: 'address' },
20
    ],
21
    Mail: [
22
      { name: 'from', type: 'Person' },
23
      { name: 'to', type: 'Person' },
24
      { name: 'contents', type: 'string' },
25
    ],
26
  },
27
  primaryType: 'Mail',
28
  message: {
29
    from: {
30
      name: 'Cow',
31
      wallet: '0xCD2a3d9F938E13CD947Ec05AbC7FE734Df8DD826',
32
    },
33
    to: {
34
      name: 'Bob',
35
      wallet: '0xbBbBBBBbbBBBbbbBbbBbbbbBBbBbbbbBbBbbBBbB',
36
    },
37
    contents: 'Hello, Bob!',
38
  },
39
})

1
// Account Hoisting
2
import { createWalletClient, http } from 'viem'
3
import { privateKeyToAccount } from 'viem/accounts'
4
import { mainnet } from 'viem/chains'
5
6
const client = createWalletClient({
7
  account: privateKeyToAccount('0x…'),
8
  chain: mainnet,
9
  transport: http(),
10
})
11
const signature = await client.signTypedData({
12
  domain: {
13
    name: 'Ether Mail',
14
    version: '1',
15
    chainId: 1,
16
    verifyingContract: '0xCcCCccccCCCCcCCCCCCcCcCccCcCCCcCcccccccC',
17
  },
18
  types: {
19
    Person: [
20
      { name: 'name', type: 'string' },
21
      { name: 'wallet', type: 'address' },
22
    ],
23
    Mail: [
24
      { name: 'from', type: 'Person' },
25
      { name: 'to', type: 'Person' },
26
      { name: 'contents', type: 'string' },
27
    ],
28
  },
29
  primaryType: 'Mail',
30
  message: {
31
    from: {
32
      name: 'Cow',
33
      wallet: '0xCD2a3d9F938E13CD947Ec05AbC7FE734Df8DD826',
34
    },
35
    to: {
36
      name: 'Bob',
37
      wallet: '0xbBbBBBBbbBBBbbbBbbBbbbbBBbBbbbbBbBbbBBbB',
38
    },
39
    contents: 'Hello, Bob!',
40
  },
41
})

client.switchChain

(args) => Promise<void>

Switch the target chain in a wallet.

• Docs: https://viem.sh/docs/actions/wallet/switchChain
• JSON-RPC Methods: eth_switchEthereumChain

Example

1
import { createWalletClient, custom } from 'viem'
2
import { mainnet, optimism } from 'viem/chains'
3
4
const client = createWalletClient({
5
  chain: mainnet,
6
  transport: custom(window.ethereum),
7
})
8
await client.switchChain({ id: optimism.id })

client.transport

TransportConfig<string, EIP1193RequestFn> & Record<string, any>

The RPC transport

client.type

string

The type of client.

client.uid

string

A unique ID for the client.

client.waitForCallsStatus

(parameters) => Promise<{ atomic: boolean; capabilities?: | { [key: string]: any; } | { [key: string]: any; }; chainId: number; id: string; receipts?: WalletCallReceipt<bigint, "success" | "reverted">[]; status: undefined | "pending" | "success" | "failure"; statusCode: number; version: string; }>

Waits for the status & receipts of a call bundle that was sent via sendCalls.

• Docs: https://viem.sh/docs/actions/wallet/waitForCallsStatus
• JSON-RPC Methods: wallet_getCallsStatus

Example

1
import { createWalletClient, custom } from 'viem'
2
import { mainnet } from 'viem/chains'
3
4
const client = createWalletClient({
5
  chain: mainnet,
6
  transport: custom(window.ethereum),
7
})
8
9
const { receipts, status } = await waitForCallsStatus(client, { id: '0xdeadbeef' })

client.watchAsset

(args) => Promise<boolean>

Adds an EVM chain to the wallet.

• Docs: https://viem.sh/docs/actions/wallet/watchAsset
• JSON-RPC Methods: eth_switchEthereumChain

Example

1
import { createWalletClient, custom } from 'viem'
2
import { mainnet } from 'viem/chains'
3
4
const client = createWalletClient({
5
  chain: mainnet,
6
  transport: custom(window.ethereum),
7
})
8
const success = await client.watchAsset({
9
  type: 'ERC20',
10
  options: {
11
    address: '0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2',
12
    decimals: 18,
13
    symbol: 'WETH',
14
  },
15
})

client.writeContract

<abi, functionName, args, chainOverride>(args) => Promise<`0x${string}`>

Executes a write function on a contract.

• Docs: https://viem.sh/docs/contract/writeContract
• Examples: https://stackblitz.com/github/wevm/viem/tree/main/examples/contracts\_writing-to-contracts

A “write” function on a Solidity contract modifies the state of the blockchain. These types of functions require gas to be executed, and hence a Transaction is needed to be broadcast in order to change the state.

Internally, uses a Wallet Client to call the sendTransaction action with ABI-encoded data.

Warning: The write internally sends a transaction – it does not validate if the contract write will succeed (the contract may throw an error). It is highly recommended to simulate the contract write with contract.simulate before you execute it.

Examples

1
import { createWalletClient, custom, parseAbi } from 'viem'
2
import { mainnet } from 'viem/chains'
3
4
const client = createWalletClient({
5
  chain: mainnet,
6
  transport: custom(window.ethereum),
7
})
8
const hash = await client.writeContract({
9
  address: '0xFBA3912Ca04dd458c843e2EE08967fC04f3579c2',
10
  abi: parseAbi(['function mint(uint32 tokenId) nonpayable']),
11
  functionName: 'mint',
12
  args: [69420],
13
})

1
// With Validation
2
import { createWalletClient, custom, parseAbi } from 'viem'
3
import { mainnet } from 'viem/chains'
4
5
const client = createWalletClient({
6
  chain: mainnet,
7
  transport: custom(window.ethereum),
8
})
9
const { request } = await client.simulateContract({
10
  address: '0xFBA3912Ca04dd458c843e2EE08967fC04f3579c2',
11
  abi: parseAbi(['function mint(uint32 tokenId) nonpayable']),
12
  functionName: 'mint',
13
  args: [69420],
14
}
15
const hash = await client.writeContract(request)

signerType

string

The type of signer; must be a valid signer type, otherwise an error will be thrown

getAddress

() => Promise<`0x${string}`>

Asynchronously retrieves addresses from the inner object and returns the first address after applying the getAddress function.

Example

1
import { WalletClientSigner } from "@aa-sdk/core";
2
import { createWalletClient, custom } from 'viem'
3
import { mainnet } from 'viem/chains'
4
5
const client = createWalletClient({
6
  chain: mainnet,
7
  transport: custom(window.ethereum!)
8
});
9
10
const signer = new WalletClientSigner(client, 'wallet');
11
console.log(await signer.getAddress());

inner

object

‐

inner.account

undefined | Account

The Account of the Client.

inner.addChain

(args) => Promise<void>

Adds an EVM chain to the wallet.

• Docs: https://viem.sh/docs/actions/wallet/addChain
• JSON-RPC Methods: eth_addEthereumChain

Example

1
import { createWalletClient, custom } from 'viem'
2
import { optimism } from 'viem/chains'
3
4
const client = createWalletClient({
5
  transport: custom(window.ethereum),
6
})
7
await client.addChain({ chain: optimism })

inner.batch?

object

Flags for batch settings.

inner.batch.multicall?

| boolean | { batchSize?: number; wait?: number; }

Toggle to enable eth_call multicall aggregation.

inner.cacheTime

number

Time (in ms) that cached data will remain in memory.

inner.ccipRead?

| false | { request?: (parameters) => Promise<`0x${string}`>; }

CCIP Read configuration.

inner.chain

undefined | Chain

Chain for the client.

inner.deployContract

<abi, chainOverride>(args) => Promise<`0x${string}`>

Deploys a contract to the network, given bytecode and constructor arguments.

• Docs: https://viem.sh/docs/contract/deployContract
• Examples: https://stackblitz.com/github/wevm/viem/tree/main/examples/contracts\_deploying-contracts

Example

1
import { createWalletClient, http } from 'viem'
2
import { privateKeyToAccount } from 'viem/accounts'
3
import { mainnet } from 'viem/chains'
4
5
const client = createWalletClient({
6
  account: privateKeyToAccount('0x…'),
7
  chain: mainnet,
8
  transport: http(),
9
})
10
const hash = await client.deployContract({
11
  abi: [],
12
  account: '0x…,
13
  bytecode: '0x608060405260405161083e38038061083e833981016040819052610...',
14
})

inner.experimental_blockTag?

BlockTag

Default block tag to use for RPC requests.

inner.extend

<client>(fn) => Client<Transport, undefined | Chain, undefined | Account, WalletRpcSchema, { [K in string | number | symbol]: client[K] } & WalletActions<undefined | Chain, undefined | Account>>

‐

inner.getAddresses

() => Promise<GetAddressesReturnType>

Returns a list of account addresses owned by the wallet or client.

• Docs: https://viem.sh/docs/actions/wallet/getAddresses
• JSON-RPC Methods: eth_accounts

Example

1
import { createWalletClient, custom } from 'viem'
2
import { mainnet } from 'viem/chains'
3
4
const client = createWalletClient({
5
  chain: mainnet,
6
  transport: custom(window.ethereum),
7
})
8
const accounts = await client.getAddresses()

inner.getCallsStatus

(parameters) => Promise<{ atomic: boolean; capabilities?: | { [key: string]: any; } | { [key: string]: any; }; chainId: number; id: string; receipts?: WalletCallReceipt<bigint, "success" | "reverted">[]; status: undefined | "pending" | "success" | "failure"; statusCode: number; version: string; }>

Returns the status of a call batch that was sent via sendCalls.

• Docs: https://viem.sh/docs/actions/wallet/getCallsStatus
• JSON-RPC Methods: wallet_getCallsStatus

Example

1
import { createWalletClient, custom } from 'viem'
2
import { mainnet } from 'viem/chains'
3
4
const client = createWalletClient({
5
  chain: mainnet,
6
  transport: custom(window.ethereum),
7
})
8
9
const { receipts, status } = await client.getCallsStatus({ id: '0xdeadbeef' })

inner.getCapabilities

<chainId>(parameters?) => Promise<{ [K in string | number | symbol]: (chainId extends number ? { atomic?: { status: “ready” | “supported” | “unsupported” }; paymasterService?: { supported: boolean }; unstable_addSubAccount?: { keyTypes: ((…) | (…) | (…) | (…))[]; supported: boolean }; [key: string]: any } : ChainIdToCapabilities<Capabilities<{ atomic?: { status: … }; paymasterService?: { supported: … }; unstable_addSubAccount?: { keyTypes: …; supported: … }; [key: string]: any }>, number>)[K] }>

Extract capabilities that a connected wallet supports (e.g. paymasters, session keys, etc).

• Docs: https://viem.sh/docs/actions/wallet/getCapabilities
• JSON-RPC Methods: wallet_getCapabilities

Example

1
import { createWalletClient, custom } from 'viem'
2
import { mainnet } from 'viem/chains'
3
4
const client = createWalletClient({
5
  chain: mainnet,
6
  transport: custom(window.ethereum),
7
})
8
9
const capabilities = await client.getCapabilities({
10
  account: '0xA0Cf798816D4b9b9866b5330EEa46a18382f251e',
11
})

inner.getChainId

() => Promise<number>

Returns the chain ID associated with the current network.

• Docs: https://viem.sh/docs/actions/public/getChainId
• JSON-RPC Methods: eth_chainId

Example

1
import { createWalletClient, http } from 'viem'
2
import { mainnet } from 'viem/chains'
3
4
const client = createWalletClient({
5
  chain: mainnet,
6
  transport: custom(window.ethereum),
7
})
8
const chainId = await client.getChainId()
9
// 1

inner.getPermissions

() => Promise<GetPermissionsReturnType>

Gets the wallets current permissions.

• Docs: https://viem.sh/docs/actions/wallet/getPermissions
• JSON-RPC Methods: wallet_getPermissions

Example

1
import { createWalletClient, custom } from 'viem'
2
import { mainnet } from 'viem/chains'
3
4
const client = createWalletClient({
5
  chain: mainnet,
6
  transport: custom(window.ethereum),
7
})
8
const permissions = await client.getPermissions()

inner.key

string

A key for the client.

inner.name

string

A name for the client.

inner.pollingInterval

number

Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds.

inner.prepareAuthorization

(parameters) => Promise<PrepareAuthorizationReturnType>

Prepares an EIP-7702 Authorization object for signing. This Action will fill the required fields of the Authorization object if they are not provided (e.g. nonce and chainId).

With the prepared Authorization object, you can use signAuthorization to sign over the Authorization object.

Examples

1
import { createWalletClient, http } from 'viem'
2
import { privateKeyToAccount } from 'viem/accounts'
3
import { mainnet } from 'viem/chains'
4
5
const client = createWalletClient({
6
  chain: mainnet,
7
  transport: http(),
8
})
9
10
const authorization = await client.prepareAuthorization({
11
  account: privateKeyToAccount('0x..'),
12
  contractAddress: '0xA0Cf798816D4b9b9866b5330EEa46a18382f251e',
13
})

1
// Account Hoisting
2
import { createWalletClient, http } from 'viem'
3
import { privateKeyToAccount } from 'viem/accounts'
4
import { mainnet } from 'viem/chains'
5
6
const client = createWalletClient({
7
  account: privateKeyToAccount('0x…'),
8
  chain: mainnet,
9
  transport: http(),
10
})
11
12
const authorization = await client.prepareAuthorization({
13
  contractAddress: '0xA0Cf798816D4b9b9866b5330EEa46a18382f251e',
14
})

inner.prepareTransactionRequest

<request, chainOverride, accountOverride>(args) => Promise<{ [K in string | number | symbol]: (UnionRequiredBy<Extract<UnionOmit<(…), (…)> & ((…) extends (…) ? (…) : (…)) & ((…) extends (…) ? (…) : (…)), IsNever<(…)> extends true ? unknown : ExactPartial<(…)>> & { chainId?: number }, ParameterTypeToParameters<request[“parameters”] extends readonly PrepareTransactionRequestParameterType[] ? any[any][number] : “type” | “gas” | “nonce” | “blobVersionedHashes” | “fees” | “chainId”>> & (unknown extends request[“kzg”] ? {} : Pick<request, “kzg”>))[K] }>

Prepares a transaction request for signing.

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

Examples

1
import { createWalletClient, custom } from 'viem'
2
import { mainnet } from 'viem/chains'
3
4
const client = createWalletClient({
5
  chain: mainnet,
6
  transport: custom(window.ethereum),
7
})
8
const request = await client.prepareTransactionRequest({
9
  account: '0xA0Cf798816D4b9b9866b5330EEa46a18382f251e',
10
  to: '0x0000000000000000000000000000000000000000',
11
  value: 1n,
12
})

1
// Account Hoisting
2
import { createWalletClient, http } from 'viem'
3
import { privateKeyToAccount } from 'viem/accounts'
4
import { mainnet } from 'viem/chains'
5
6
const client = createWalletClient({
7
  account: privateKeyToAccount('0x…'),
8
  chain: mainnet,
9
  transport: custom(window.ethereum),
10
})
11
const request = await client.prepareTransactionRequest({
12
  to: '0x0000000000000000000000000000000000000000',
13
  value: 1n,
14
})

inner.request

EIP1193RequestFn<WalletRpcSchema>

Request function wrapped with friendly error handling

inner.requestAddresses

() => Promise<RequestAddressesReturnType>

Requests a list of accounts managed by a wallet.

• Docs: https://viem.sh/docs/actions/wallet/requestAddresses
• JSON-RPC Methods: eth_requestAccounts

Sends a request to the wallet, asking for permission to access the user’s accounts. After the user accepts the request, it will return a list of accounts (addresses).

This API can be useful for dapps that need to access the user’s accounts in order to execute transactions or interact with smart contracts.

Example

1
import { createWalletClient, custom } from 'viem'
2
import { mainnet } from 'viem/chains'
3
4
const client = createWalletClient({
5
  chain: mainnet,
6
  transport: custom(window.ethereum),
7
})
8
const accounts = await client.requestAddresses()

inner.requestPermissions

(args) => Promise<RequestPermissionsReturnType>

Requests permissions for a wallet.

• Docs: https://viem.sh/docs/actions/wallet/requestPermissions
• JSON-RPC Methods: wallet_requestPermissions

Example

1
import { createWalletClient, custom } from 'viem'
2
import { mainnet } from 'viem/chains'
3
4
const client = createWalletClient({
5
  chain: mainnet,
6
  transport: custom(window.ethereum),
7
})
8
const permissions = await client.requestPermissions({
9
  eth_accounts: {}
10
})

inner.sendCalls

<calls, chainOverride>(parameters) => Promise<{ capabilities?: { [key: string]: any; }; id: string; }>

Requests the connected wallet to send a batch of calls.

• Docs: https://viem.sh/docs/actions/wallet/sendCalls
• JSON-RPC Methods: wallet_sendCalls

Example

1
import { createWalletClient, custom } from 'viem'
2
import { mainnet } from 'viem/chains'
3
4
const client = createWalletClient({
5
  chain: mainnet,
6
  transport: custom(window.ethereum),
7
})
8
9
const id = await client.sendCalls({
10
  account: '0xA0Cf798816D4b9b9866b5330EEa46a18382f251e',
11
  calls: [
12
    {
13
      data: '0xdeadbeef',
14
      to: '0x70997970c51812dc3a010c7d01b50e0d17dc79c8',
15
    },
16
    {
17
      to: '0x70997970c51812dc3a010c7d01b50e0d17dc79c8',
18
      value: 69420n,
19
    },
20
  ],
21
})

inner.sendRawTransaction

(args) => Promise<`0x${string}`>

Sends a signed transaction to the network

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

Example

1
import { createWalletClient, custom } from 'viem'
2
import { mainnet } from 'viem/chains'
3
import { sendRawTransaction } from 'viem/wallet'
4
5
const client = createWalletClient({
6
  chain: mainnet,
7
  transport: custom(window.ethereum),
8
})
9
10
const hash = await client.sendRawTransaction({
11
  serializedTransaction: '0x02f850018203118080825208808080c080a04012522854168b27e5dc3d5839bab5e6b39e1a0ffd343901ce1622e3d64b48f1a04e00902ae0502c4728cbf12156290df99c3ed7de85b1dbfe20b5c36931733a33'
12
})

inner.sendTransaction

<request, chainOverride>(args) => Promise<`0x${string}`>

Creates, signs, and sends a new transaction to the network.

• Docs: https://viem.sh/docs/actions/wallet/sendTransaction
• Examples: https://stackblitz.com/github/wevm/viem/tree/main/examples/transactions\_sending-transactions
• JSON-RPC Methods:
  • JSON-RPC Accounts: eth_sendTransaction
  • Local Accounts: eth_sendRawTransaction

Examples

1
import { createWalletClient, custom } from 'viem'
2
import { mainnet } from 'viem/chains'
3
4
const client = createWalletClient({
5
  chain: mainnet,
6
  transport: custom(window.ethereum),
7
})
8
const hash = await client.sendTransaction({
9
  account: '0xA0Cf798816D4b9b9866b5330EEa46a18382f251e',
10
  to: '0x70997970c51812dc3a010c7d01b50e0d17dc79c8',
11
  value: 1000000000000000000n,
12
})

1
// Account Hoisting
2
import { createWalletClient, http } from 'viem'
3
import { privateKeyToAccount } from 'viem/accounts'
4
import { mainnet } from 'viem/chains'
5
6
const client = createWalletClient({
7
  account: privateKeyToAccount('0x…'),
8
  chain: mainnet,
9
  transport: http(),
10
})
11
const hash = await client.sendTransaction({
12
  to: '0x70997970c51812dc3a010c7d01b50e0d17dc79c8',
13
  value: 1000000000000000000n,
14
})

inner.showCallsStatus

(parameters) => Promise<void>

Requests for the wallet to show information about a call batch that was sent via sendCalls.

• Docs: https://viem.sh/docs/actions/wallet/showCallsStatus
• JSON-RPC Methods: wallet_showCallsStatus

Example

1
import { createWalletClient, custom } from 'viem'
2
import { mainnet } from 'viem/chains'
3
4
const client = createWalletClient({
5
  chain: mainnet,
6
  transport: custom(window.ethereum),
7
})
8
9
await client.showCallsStatus({ id: '0xdeadbeef' })

inner.signAuthorization

(parameters) => Promise<SignAuthorizationReturnType>

Signs an EIP-7702 Authorization object.

With the calculated signature, you can:

• use verifyAuthorization to verify the signed Authorization object,
• use recoverAuthorizationAddress to recover the signing address from the signed Authorization object.

Examples

1
import { createWalletClient, http } from 'viem'
2
import { privateKeyToAccount } from 'viem/accounts'
3
import { mainnet } from 'viem/chains'
4
5
const client = createWalletClient({
6
  chain: mainnet,
7
  transport: http(),
8
})
9
10
const signature = await client.signAuthorization({
11
  account: privateKeyToAccount('0x..'),
12
  contractAddress: '0xA0Cf798816D4b9b9866b5330EEa46a18382f251e',
13
})

1
// Account Hoisting
2
import { createWalletClient, http } from 'viem'
3
import { privateKeyToAccount } from 'viem/accounts'
4
import { mainnet } from 'viem/chains'
5
6
const client = createWalletClient({
7
  account: privateKeyToAccount('0x…'),
8
  chain: mainnet,
9
  transport: http(),
10
})
11
12
const signature = await client.signAuthorization({
13
  contractAddress: '0xA0Cf798816D4b9b9866b5330EEa46a18382f251e',
14
})

inner.signMessage

(args) => Promise<`0x${string}`>

Calculates an Ethereum-specific signature in EIP-191 format: keccak256("\x19Ethereum Signed Message:\n" + len(message) + message)).

• Docs: https://viem.sh/docs/actions/wallet/signMessage
• JSON-RPC Methods:
  • JSON-RPC Accounts: personal_sign
  • Local Accounts: Signs locally. No JSON-RPC request.

With the calculated signature, you can:

• use verifyMessage to verify the signature,
• use recoverMessageAddress to recover the signing address from a signature.

Examples

1
import { createWalletClient, custom } from 'viem'
2
import { mainnet } from 'viem/chains'
3
4
const client = createWalletClient({
5
  chain: mainnet,
6
  transport: custom(window.ethereum),
7
})
8
const signature = await client.signMessage({
9
  account: '0xA0Cf798816D4b9b9866b5330EEa46a18382f251e',
10
  message: 'hello world',
11
})

1
// Account Hoisting
2
import { createWalletClient, http } from 'viem'
3
import { privateKeyToAccount } from 'viem/accounts'
4
import { mainnet } from 'viem/chains'
5
6
const client = createWalletClient({
7
  account: privateKeyToAccount('0x…'),
8
  chain: mainnet,
9
  transport: http(),
10
})
11
const signature = await client.signMessage({
12
  message: 'hello world',
13
})

inner.signTransaction

<chainOverride, request>(args) => Promise<TransactionSerialized<GetTransactionType<request, | request extends LegacyProperties ? "legacy" : never | request extends EIP1559Properties ? "eip1559" : never | request extends EIP2930Properties ? "eip2930" : never | request extends EIP4844Properties ? "eip4844" : never | request extends EIP7702Properties ? "eip7702" : never | request["type"] extends undefined | string ? Extract<any[any], string> : never>, | GetTransactionType<request, | request extends LegacyProperties ? "legacy" : never | request extends EIP1559Properties ? "eip1559" : never | request extends EIP2930Properties ? "eip2930" : never | request extends EIP4844Properties ? "eip4844" : never | request extends EIP7702Properties ? "eip7702" : never | request["type"] extends undefined | string ? Extract<any[any], string> : never> extends "eip1559" ? `0x02${string}` : never | GetTransactionType<request, | request extends LegacyProperties ? "legacy" : never | request extends EIP1559Properties ? "eip1559" : never | request extends EIP2930Properties ? "eip2930" : never | request extends EIP4844Properties ? "eip4844" : never | request extends EIP7702Properties ? "eip7702" : never | request["type"] extends undefined | string ? Extract<any[any], string> : never> extends "eip2930" ? `0x01${string}` : never | GetTransactionType<request, | request extends LegacyProperties ? "legacy" : never | request extends EIP1559Properties ? "eip1559" : never | request extends EIP2930Properties ? "eip2930" : never | request extends EIP4844Properties ? "eip4844" : never | request extends EIP7702Properties ? "eip7702" : never | request["type"] extends undefined | string ? Extract<any[any], string> : never> extends "eip4844" ? `0x03${string}` : never | GetTransactionType<request, | request extends LegacyProperties ? "legacy" : never | request extends EIP1559Properties ? "eip1559" : never | request extends EIP2930Properties ? "eip2930" : never | request extends EIP4844Properties ? "eip4844" : never | request extends EIP7702Properties ? "eip7702" : never | request["type"] extends undefined | string ? Extract<any[any], string> : never> extends "eip7702" ? `0x04${string}` : never | GetTransactionType<request, | request extends LegacyProperties ? "legacy" : never | request extends EIP1559Properties ? "eip1559" : never | request extends EIP2930Properties ? "eip2930" : never | request extends EIP4844Properties ? "eip4844" : never | request extends EIP7702Properties ? "eip7702" : never | request["type"] extends undefined | string ? Extract<any[any], string> : never> extends "legacy" ? TransactionSerializedLegacy : never>>

Signs a transaction.

• Docs: https://viem.sh/docs/actions/wallet/signTransaction
• JSON-RPC Methods:
  • JSON-RPC Accounts: eth_signTransaction
  • Local Accounts: Signs locally. No JSON-RPC request.

Examples

1
import { createWalletClient, custom } from 'viem'
2
import { mainnet } from 'viem/chains'
3
4
const client = createWalletClient({
5
  chain: mainnet,
6
  transport: custom(window.ethereum),
7
})
8
const request = await client.prepareTransactionRequest({
9
  account: '0xA0Cf798816D4b9b9866b5330EEa46a18382f251e',
10
  to: '0x0000000000000000000000000000000000000000',
11
  value: 1n,
12
})
13
const signature = await client.signTransaction(request)

1
// Account Hoisting
2
import { createWalletClient, http } from 'viem'
3
import { privateKeyToAccount } from 'viem/accounts'
4
import { mainnet } from 'viem/chains'
5
6
const client = createWalletClient({
7
  account: privateKeyToAccount('0x…'),
8
  chain: mainnet,
9
  transport: custom(window.ethereum),
10
})
11
const request = await client.prepareTransactionRequest({
12
  to: '0x0000000000000000000000000000000000000000',
13
  value: 1n,
14
})
15
const signature = await client.signTransaction(request)

inner.signTypedData

<typedData, primaryType>(args) => Promise<`0x${string}`>

Signs typed data and calculates an Ethereum-specific signature in EIP-191 format: keccak256("\x19Ethereum Signed Message:\n" + len(message) + message)).

• Docs: https://viem.sh/docs/actions/wallet/signTypedData
• JSON-RPC Methods:
  • JSON-RPC Accounts: eth_signTypedData_v4
  • Local Accounts: Signs locally. No JSON-RPC request.

Examples

1
import { createWalletClient, custom } from 'viem'
2
import { mainnet } from 'viem/chains'
3
4
const client = createWalletClient({
5
  chain: mainnet,
6
  transport: custom(window.ethereum),
7
})
8
const signature = await client.signTypedData({
9
  account: '0xA0Cf798816D4b9b9866b5330EEa46a18382f251e',
10
  domain: {
11
    name: 'Ether Mail',
12
    version: '1',
13
    chainId: 1,
14
    verifyingContract: '0xCcCCccccCCCCcCCCCCCcCcCccCcCCCcCcccccccC',
15
  },
16
  types: {
17
    Person: [
18
      { name: 'name', type: 'string' },
19
      { name: 'wallet', type: 'address' },
20
    ],
21
    Mail: [
22
      { name: 'from', type: 'Person' },
23
      { name: 'to', type: 'Person' },
24
      { name: 'contents', type: 'string' },
25
    ],
26
  },
27
  primaryType: 'Mail',
28
  message: {
29
    from: {
30
      name: 'Cow',
31
      wallet: '0xCD2a3d9F938E13CD947Ec05AbC7FE734Df8DD826',
32
    },
33
    to: {
34
      name: 'Bob',
35
      wallet: '0xbBbBBBBbbBBBbbbBbbBbbbbBBbBbbbbBbBbbBBbB',
36
    },
37
    contents: 'Hello, Bob!',
38
  },
39
})

1
// Account Hoisting
2
import { createWalletClient, http } from 'viem'
3
import { privateKeyToAccount } from 'viem/accounts'
4
import { mainnet } from 'viem/chains'
5
6
const client = createWalletClient({
7
  account: privateKeyToAccount('0x…'),
8
  chain: mainnet,
9
  transport: http(),
10
})
11
const signature = await client.signTypedData({
12
  domain: {
13
    name: 'Ether Mail',
14
    version: '1',
15
    chainId: 1,
16
    verifyingContract: '0xCcCCccccCCCCcCCCCCCcCcCccCcCCCcCcccccccC',
17
  },
18
  types: {
19
    Person: [
20
      { name: 'name', type: 'string' },
21
      { name: 'wallet', type: 'address' },
22
    ],
23
    Mail: [
24
      { name: 'from', type: 'Person' },
25
      { name: 'to', type: 'Person' },
26
      { name: 'contents', type: 'string' },
27
    ],
28
  },
29
  primaryType: 'Mail',
30
  message: {
31
    from: {
32
      name: 'Cow',
33
      wallet: '0xCD2a3d9F938E13CD947Ec05AbC7FE734Df8DD826',
34
    },
35
    to: {
36
      name: 'Bob',
37
      wallet: '0xbBbBBBBbbBBBbbbBbbBbbbbBBbBbbbbBbBbbBBbB',
38
    },
39
    contents: 'Hello, Bob!',
40
  },
41
})

inner.switchChain

(args) => Promise<void>

Switch the target chain in a wallet.

• Docs: https://viem.sh/docs/actions/wallet/switchChain
• JSON-RPC Methods: eth_switchEthereumChain

Example

1
import { createWalletClient, custom } from 'viem'
2
import { mainnet, optimism } from 'viem/chains'
3
4
const client = createWalletClient({
5
  chain: mainnet,
6
  transport: custom(window.ethereum),
7
})
8
await client.switchChain({ id: optimism.id })

inner.transport

TransportConfig<string, EIP1193RequestFn> & Record<string, any>

The RPC transport

inner.type

string

The type of client.

inner.uid

string

A unique ID for the client.

inner.waitForCallsStatus

(parameters) => Promise<{ atomic: boolean; capabilities?: | { [key: string]: any; } | { [key: string]: any; }; chainId: number; id: string; receipts?: WalletCallReceipt<bigint, "success" | "reverted">[]; status: undefined | "pending" | "success" | "failure"; statusCode: number; version: string; }>

Waits for the status & receipts of a call bundle that was sent via sendCalls.

• Docs: https://viem.sh/docs/actions/wallet/waitForCallsStatus
• JSON-RPC Methods: wallet_getCallsStatus

Example

1
import { createWalletClient, custom } from 'viem'
2
import { mainnet } from 'viem/chains'
3
4
const client = createWalletClient({
5
  chain: mainnet,
6
  transport: custom(window.ethereum),
7
})
8
9
const { receipts, status } = await waitForCallsStatus(client, { id: '0xdeadbeef' })