policy.watchWhitelistUpdated

Watches for whitelist update events on the TIP403 Registry.

Usage

import { Actions } from 'tempo.ts/wagmi'
import { config } from './wagmi.config'
 
const unwatch = Actions.policy.watchWhitelistUpdated(config, {
  onWhitelistUpdated: (args, log) => {
    console.log('Account:', args.account)
    console.log('Allowed:', args.allowed)
    console.log('Policy ID:', args.policyId)
    console.log('Updater:', args.updater)
  },
})
 
// Later, stop watching
unwatch()

Return Type

type ReturnType = () => void

Returns a function to unsubscribe from the event.

Parameters

onWhitelistUpdated

• Type: function

declare function onWhitelistUpdated(args: Args, log: Log): void
 
type Args = {
  /** Address of the account */
  account: Address
  /** Whether the account is allowed */
  allowed: boolean
  /** ID of the policy */
  policyId: bigint
  /** Address that updated the whitelist */
  updater: Address
}

Callback to invoke when a whitelist is updated.

args (optional)

• Type: object

type Args = {
  /** Filter by policy ID */
  policyId?: bigint | bigint[] | null
  /** Filter by updater address */
  updater?: Address | Address[] | null
  /** Filter by account address */
  account?: Address | Address[] | null
}

Optional filter arguments for the watch.

fromBlock (optional)

• Type: bigint

Block to start listening from.

onError (optional)

• Type: function

declare function onError(error: Error): void

The callback to call when an error occurred when trying to get for a new block.

poll (optional)

• Type: true

Whether to use polling.

pollingInterval (optional)

• Type: number

Polling frequency (in ms). Defaults to Client's pollingInterval config.