Skip to content
LogoLogo

dex.watchOrderCancelled

Watches for order cancelled events on the Stablecoin DEX.

Usage

import {  } from './viem.config'
 
const  = .dex.watchOrderCancelled({
  : (, ) => {
    .('Order cancelled:', .orderId)
  },
})
 
// Later, stop watching
()

Return Type

type ReturnType = () => void

Returns a function to unsubscribe from the event.

Parameters

onOrderCancelled

  • Type: function
declare function onOrderCancelled(args: Args, log: Log): void
 
type Args = {
  /** ID of the cancelled order */
  orderId: bigint
}

Callback to invoke when an order is cancelled.

args (optional)

  • Type: object
type Args = {
  /** Order ID to filter events */
  orderId?: bigint | bigint[] | null
}

Filter options for the event.

orderId (optional)

  • Type: bigint

Order ID to filter events.

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

Enable polling mode.

pollingInterval (optional)

  • Type: number

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