Watch Nonce Increments

nonce.watchIncremented

Watches NonceIncremented events on the nonce manager.

Usage

import {  } from './viem.config'
 
const  = ..()
 
.(() => {
  for (const  of ) .(.)
{  account: '0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266',  nonceKey: 1n,  newNonce: 42n}
})
 
// Later, tear down the watcher.
.()

import { ,  } from 'viem/tempo'
 
export const  = .({
  : .('0x...'),
})

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

Recipes

Follow Payout Lane Confirmations

Filter args to your own account to turn nonce increments into per-lane confirmation events, for example to drive a payout dashboard.

import {  } from './viem.config'
 
const  = ..({
  : { : .. },
})
 
.(() => {
  for (const  of )
    .(`Lane ${..}: ${..} confirmed`)
Lane 7: 46 confirmed
})

import { ,  } from 'viem/tempo'
 
export const  = .({
  : .('0x...'),
})

Backfill Missed Increments After a Restart

Pass fromBlock from a persisted checkpoint so increments emitted while your service was down are still delivered before live events.

import {  } from './viem.config'
 
const  = 1_204_560n // last processed block, from your store
 
const  = ..({
  : { : '0x8ba1f109551bD432803012645Ac136ddd64DBA72' },
  :  + 1n,
})
 
.(() => {
  for (const  of ) .(., ..)
})

import { ,  } from 'viem/tempo'
 
export const  = .({
  : .('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 `NonceIncremented` event arguments. */
  args: {
    /** Account whose nonce was incremented. */
    account: Address
    /** Nonce key that was incremented. */
    nonceKey: bigint
    /** New nonce value. */
    newNonce: bigint
  }
  /** Name of the emitted event. */
  eventName: 'NonceIncremented'
  // ...standard log fields (address, blockHash, blockNumber, logIndex, transactionHash, ...)
}

Parameters

args

Type: object

type Args = {
  /** Filter by account address. */
  account?: Address | Address[] | null
  /** Filter by nonce key. */
  nonceKey?: bigint | bigint[] | 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).

Suggest changes to this page