accessKey.burnWitness

Burns a key-authorization witness, invalidating any authorization bound to it before it is submitted onchain.

A witness is an optional 32-byte value bound into a key authorization's signing hash (see accessKey.authorize). Once burned, an authorization carrying the same witness can no longer be submitted, giving applications a revocation handle for signed-but-not-yet-submitted authorizations.

TIP-1053

Usage

import { client } from './viem.config'
 
const { receipt } = await client.accessKey.burnWitnessSync({
  witness: '0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef',
})
 
console.log('Transaction hash:', receipt.transactionHash)
Transaction hash: 0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef

import { Account, createClient } from 'viem/tempo'
 
export const client = createClient({
  account: Account.fromSecp256k1('0x...'),
})

Asynchronous Usage

The example above uses a *Sync variant of the action, that will wait for the transaction to be included before returning.

If you are optimizing for performance, you should use the non-sync accessKey.burnWitness action and wait for inclusion manually:

import { Actions } from 'viem/tempo'
import { client } from './viem.config'
 
const hash = await client.accessKey.burnWitness({
  witness: '0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef',
})
const receipt = await client.waitForTransactionReceipt({ hash })
 
const { args }
  = Actions.accessKey.burnWitness.extractEvent(receipt.logs)

Return Type

type ReturnType = {
  /** The account that burned the witness. */
  account: Address
  /** The witness that was burned. */
  witness: Hex
  /** Transaction receipt */
  receipt: TransactionReceipt
}

Parameters

witness

• Type: Hex

The 32-byte witness to burn.

account (optional)

• Type: Account | Address

Account that will be used to send the transaction.

feeToken (optional)

• Type: Address | bigint

Fee token for the transaction.

Can be an unpaused USD-denominated TIP-20 token address or ID. Use client.fee.validateToken({ token }) to validate a token before submitting a transaction or setting it as a fee preference.

feePayer (optional)

• Type: Account | true

Fee payer for the transaction.

Can be a Viem Account, or true if a Fee Payer Service will be used.

gas (optional)

• Type: bigint

Gas limit for the transaction.

maxFeePerGas (optional)

• Type: bigint

Max fee per gas for the transaction.

maxPriorityFeePerGas (optional)

• Type: bigint

Max priority fee per gas for the transaction.

nonce (optional)

• Type: number

Nonce for the transaction.

nonceKey (optional)

• Type: 'expiring' | bigint

Nonce key for the transaction. Use 'expiring' to use expiring nonces (TIP-1009), which enables concurrent transaction submission without nonce ordering.

validBefore (optional)

• Type: number

Unix timestamp before which the transaction must be included.

validAfter (optional)

• Type: number

Unix timestamp after which the transaction can be included.

throwOnReceiptRevert (optional)

• Type: boolean
• Default: true

Whether to throw an error if the transaction receipt indicates a revert. Only applicable to *Sync actions.