Skip to content
LogoLogo

signTransaction

Signs a transaction.

Usage

// @filename: config.ts
import { createWalletClient, http } from 'viem'
import { privateKeyToAccount } from 'viem/accounts'
 
export const walletClient = createWalletClient({
  account: privateKeyToAccount('0x...'),
  transport: http()
})
// @filename: example.ts
// ---cut---
import { account, walletClient } from './config'
 
const request = await walletClient.prepareTransactionRequest({
  account,
  to: '0x70997970c51812dc3a010c7d01b50e0d17dc79c8',
  value: 1000000000000000000n
})
 
const signature = await walletClient.signTransaction(request) 
// 0x02f850018203118080825208808080c080a04012522854168b27e5dc3d5839bab5e6b39e1a0ffd343901ce1622e3d64b48f1a04e00902ae0502c4728cbf12156290df99c3ed7de85b1dbfe20b5c36931733a33
 
const hash = await walletClient.sendRawTransaction(signature)

Account Hoisting

If you do not wish to pass an account to every prepareTransactionRequest, you can also hoist the Account on the Wallet Client (see config.ts).

Learn more.

// @filename: config.ts
import { createWalletClient, http } from 'viem'
import { privateKeyToAccount } from 'viem/accounts'
 
export const walletClient = createWalletClient({
  account: privateKeyToAccount('0x...'),
  transport: http()
})
// @filename: example.ts
// ---cut---
import { walletClient } from './config'
 
const request = await walletClient.prepareTransactionRequest({
  to: '0x70997970c51812dc3a010c7d01b50e0d17dc79c8',
  value: 1000000000000000000n
})
 
const signature = await walletClient.signTransaction(request) 
// 0x02f850018203118080825208808080c080a04012522854168b27e5dc3d5839bab5e6b39e1a0ffd343901ce1622e3d64b48f1a04e00902ae0502c4728cbf12156290df99c3ed7de85b1dbfe20b5c36931733a33
 
const hash = await walletClient.sendRawTransaction(signature)

Returns

Hex

The signed serialized transaction.

Parameters

account

  • Type: Account | Address

The Account to send the transaction from.

Accepts a JSON-RPC Account or Local Account (Private Key, etc).

const  = await .({
  : '0xf39fd6e51aad88f6f4ce6ab8827279cfffb92266', 
  : '0x70997970c51812dc3a010c7d01b50e0d17dc79c8',
  : 1000000000000000000n
})

to

  • Type: 0x${string}

The transaction recipient or contract address.

const  = await .({
  ,
  : '0x70997970c51812dc3a010c7d01b50e0d17dc79c8', 
  : 1000000000000000000n,
  : 69
})

accessList (optional)

The access list.

const  = await .({
  : [ 
    {
      : '0x1',
      : ['0x1'],
    },
  ],
  ,
  : '0x70997970c51812dc3a010c7d01b50e0d17dc79c8',
})

authorizationList (optional)

  • Type: AuthorizationList

Signed EIP-7702 Authorization list.

const  = await .({ 
  ,
  : '0xFBA3912Ca04dd458c843e2EE08967fC04f3579c2', 
}) 
 
const  = await .({
  ,
  : [], 
  : '0xdeadbeef',
  : .,
})

blobs (optional)

  • Type: Hex[]

Blobs for Blob Transactions.

import * as cKzg from 'c-kzg'
import { toBlobs, setupKzg, stringToHex } from 'viem'
import { mainnetTrustedSetupPath } from 'viem/node'
 
const kzg = setupKzg(cKzg, mainnetTrustedSetupPath) 
 
const hash = await walletClient.signTransaction({
  account,
  blobs: toBlobs({ data: stringToHex('blobby blob!') }), 
  kzg,
  to: '0x70997970c51812dc3a010c7d01b50e0d17dc79c8'
})

chain (optional)

  • Type: Chain
  • Default: walletClient.chain

The target chain. If there is a mismatch between the wallet's current chain & the target chain, an error will be thrown.

The chain is also used to infer its request type (e.g. the Celo chain has a gatewayFee that you can pass through to signTransaction).

import {  } from 'viem/chains'
 
const  = await .({
  : , 
  ,
  : '0x70997970c51812dc3a010c7d01b50e0d17dc79c8',
  : 1000000000000000000n
})

data (optional)

  • Type: 0x${string}

A contract hashed method call with encoded args.

const  = await .({
  : '0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2', 
  ,
  : '0x70997970c51812dc3a010c7d01b50e0d17dc79c8',
  : 1000000000000000000n
})

gas (optional)

  • Type: bigint

The gas limit of the transaction. If missing, it will be estimated.

const  = await .({
  ,
  : 21000n, 
  : '0x70997970c51812dc3a010c7d01b50e0d17dc79c8',
  : parseEther('1') 
})

gasPrice (optional)

  • Type: bigint

The price (in wei) to pay per gas. Only applies to Legacy Transactions.

const  = await .({
  ,
  : parseGwei('20'), 
  : '0x70997970c51812dc3a010c7d01b50e0d17dc79c8',
  : parseEther('1') 
})

kzg (optional)

  • Type: KZG

KZG implementation for Blob Transactions.

See setupKzg for more information.

import * as cKzg from 'c-kzg'
import { toBlobs, setupKzg, stringToHex } from 'viem'
import { mainnetTrustedSetupPath } from 'viem/node'
 
const kzg = setupKzg(cKzg, mainnetTrustedSetupPath) 
 
const signature = await walletClient.signTransaction({
  account,
  blobs: toBlobs({ data: stringToHex('blobby blob!') }), 
  kzg, 
  to: '0x70997970c51812dc3a010c7d01b50e0d17dc79c8'
})

maxFeePerGas (optional)

  • Type: bigint

Total fee per gas (in wei), inclusive of maxPriorityFeePerGas. Only applies to EIP-1559 Transactions

const  = await .({
  ,
  : parseGwei('20'),  
  : '0x70997970c51812dc3a010c7d01b50e0d17dc79c8',
  : parseEther('1')
})

maxPriorityFeePerGas (optional)

  • Type: bigint

Max priority fee per gas (in wei). Only applies to EIP-1559 Transactions

const  = await .({
  ,
  : parseGwei('20'),
  : parseGwei('2'), 
  : '0x70997970c51812dc3a010c7d01b50e0d17dc79c8',
  : parseEther('1')
})

nonce (optional)

  • Type: number

Unique number identifying this transaction.

const  = await .({
  ,
  : '0x70997970c51812dc3a010c7d01b50e0d17dc79c8',
  : 1000000000000000000n,
  : 69
})

value (optional)

  • Type: bigint

Value in wei sent with this transaction.

const  = await .({
  ,
  : '0x70997970c51812dc3a010c7d01b50e0d17dc79c8',
  : parseEther('1'), 
  : 69
})
Suggest changes to this page