dex.watchOrderFilled

Watches for order filled events on the Stablecoin DEX.

Usage

import { client } from './viem.config'
 
const unwatch = client.dex.watchOrderFilled({
  onOrderFilled: (args, log) => {
    console.log('Order filled:', args.orderId)
    console.log('Maker:', args.maker)
    console.log('Amount filled:', args.amountFilled)
    console.log('Partial fill:', args.partialFill)
  },
})
 
// Later, stop watching
unwatch()

Return Type

type ReturnType = () => void

Returns a function to unsubscribe from the event.

Parameters

onOrderFilled

• Type: function

declare function onOrderFilled(args: Args, log: Log): void
 
type Args = {
  /** ID of the filled order */
  orderId: bigint
  /** Address that placed the order */
  maker: Address
  /** Amount of tokens filled */
  amountFilled: bigint
  /** Whether the order was partially filled */
  partialFill: boolean
}

Callback to invoke when an order is filled.

maker (optional)

• Type: Address

Address of the maker to filter events.

orderId (optional)

• Type: bigint

Order ID to filter events.

taker (optional)

• Type: Address

Address of the taker 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

Whether to use polling.

pollingInterval (optional)

• Type: number

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