watchPendingTransactions
Watches and returns pending transaction hashes.
This Action will batch up all the pending transactions found within the pollingInterval, and invoke them via onTransactions.
Import
ts
import { watchPendingTransactions } from 'viem'
Usage
ts
import { watchPendingTransactions } from 'viem'
import { publicClient } from '.'
const unwatch = watchPendingTransactions(
publicClient,
{ onTransactions: hashes => console.log(hashes) }
)
/**
* > ['0x...', '0x...', '0x...']
* > ['0x...', '0x...']
* > ['0x...', '0x...', '0x...', ...]
*/
Returns
UnwatchFn
A function that can be invoked to stop watching for new pending transaction hashes.
Parameters
onTransactions
- Type:
(hashes: '0x${string}'[]) => void
The new pending transaction hashes.
ts
const unwatch = watchPendingTransactions(
publicClient,
{ onTransactions: hashes => console.log(hashes) }
)
batch (optional)
- Type:
boolean - Default:
true
Whether or not to batch the transaction hashes between polling intervals.
ts
const unwatch = watchPendingTransactions(
publicClient,
{
batch: false,
onTransactions: hashes => console.log(hashes),
}
)
onError (optional)
- Type:
(error: Error) => void
Error thrown from listening for new pending transactions.
ts
const unwatch = watchPendingTransactions(
publicClient,
{
onError: error => console.log(error)
onTransactions: hashes => console.log(hashes),
}
)
pollingInterval (optional)
- Type:
number
Polling frequency (in ms). Defaults to the Client's pollingInterval config.
ts
const unwatch = watchPendingTransactions(
client,
{
pollingInterval: 1_000,
onTransactions: hashes => console.log(hashes),
}
)