Watch Burned Access Key Witnesses

Watches KeyAuthorizationWitnessBurned events on the account keychain.

Usage

import { client } from './viem.config'
 
const watcher = client.accessKey.watchWitnessBurned()
 
watcher.onLogs((logs) => {
  for (const log of logs) console.log(log.args)
{ account: '0x742d35Cc6634C0532925a3b844Bc9e7595f0bEbb', witness: '0xdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeef' }
})
 
// Later, tear down the watcher.
watcher.off()

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

Also callable standalone: Actions.accessKey.watchWitnessBurned(client, options), with Actions imported from 'viem/tempo'.

Recipes

Purge Cancelled Authorizations from Storage

Filter args to your account and delete stored authorizations when their witness is burned via accessKey.burnWitness.

import { client } from './viem.config'
 
const watcher = client.accessKey.watchWitnessBurned({
  args: { account: client.account.address },
})
 
watcher.onLogs((logs) => {
  for (const log of logs) {
    // Delete the stored authorization bound to this witness
    // so it is never attached to a transaction.
    console.log('Cancelled witness:', log.args.witness)
  }
})

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

Return Value

Returns a watcher handle. Watching starts when the first listener (or async iterator) attaches, and stops when off is called.

type ReturnType = {
  /** Registers a log listener. Starts the watcher on first registration. Returns an unregister function. */
  onLogs: (fn: (logs: readonly Log[]) => void) => () => void
  /** Registers an error listener. Returns an unregister function. */
  onError: (fn: (error: Error) => void) => () => void
  /** Tears down the watcher: removes listeners, ends iterators, stops the poll or subscription. */
  off: () => void
  /** Async-iterates emitted log batches (latest-only stream). */
  [Symbol.asyncIterator]: () => AsyncIterableIterator<{ logs: readonly Log[] }>
}

Each log is decoded, with the event arguments on args:

type Log = {
  /** Decoded `KeyAuthorizationWitnessBurned` event arguments. */
  args: {
    account: Address
    witness: Hex
  }
  /** Name of the emitted event. */
  eventName: 'KeyAuthorizationWitnessBurned'
  // ...standard log fields (address, blockHash, blockNumber, logIndex, transactionHash, ...)
}

Parameters

args

• Type: object

type Args = {
  account?: Address | Address[] | null
  witness?: Hex | Hex[] | null
}

Indexed argument values to filter logs by.

batch

• Type: boolean
• Default: true

Whether to batch the logs found within a poll interval into a single emission. When false, each log is emitted on its own.

fromBlock

• Type: bigint

Block number from which to start watching for logs.

poll

• Type: boolean

Whether to poll for new logs instead of using a subscription. Defaults to true when the transport cannot subscribe or fromBlock is provided.

pollingInterval

• Type: number
• Default: client.pollingInterval

Polling frequency (in ms).