dex.cancelStale

Cancels a stale order from the Stablecoin DEX orderbook.

A stale order is one where the maker has been blacklisted by a TIP-403 policy. Anyone can cancel stale orders.

Usage

import { client } from './viem.config'
 
const { orderId, receipt } = await client.dex.cancelStaleSync({
  orderId: 123n,
})
 
console.log('Cancelled stale order ID:', orderId)
Cancelled stale order ID: 123n

Asynchronous Usage

The example above uses a *Sync variant of the action, that will wait for the transaction to be included before returning.

If you are optimizing for performance, you should use the non-sync dex.cancelStale action and wait for inclusion manually:

import { Actions } from 'viem/tempo'
import { client } from './viem.config'
 
const hash = await client.dex.cancelStale({
  orderId: 123n,
})
const receipt = await client.waitForTransactionReceipt({ hash })
 
const { args: { orderId } } 
  = Actions.dex.cancelStale.extractEvent(receipt.logs)

Return Type

type ReturnType = {
  /** ID of the cancelled order */
  orderId: bigint
  /** Transaction receipt */
  receipt: TransactionReceipt
}

Parameters

orderId

• Type: bigint

ID of the stale order to cancel.

account (optional)

• Type: Account | Address

Account that will be used to send the transaction.

feeToken (optional)

• Type: Address | bigint

Fee token for the transaction.

Can be a TIP-20 token address or ID.

feePayer (optional)

• Type: Account | true

Fee payer for the transaction.

Can be a Viem Account, or true if a Fee Payer Service will be used.

gas (optional)

• Type: bigint

Gas limit for the transaction.

maxFeePerGas (optional)

• Type: bigint

Max fee per gas for the transaction.

maxPriorityFeePerGas (optional)

• Type: bigint

Max priority fee per gas for the transaction.

nonce (optional)

• Type: number

Nonce for the transaction.

nonceKey (optional)

• Type: 'random' | bigint

Nonce key for the transaction. Use 'random' to generate a random nonce key.

validBefore (optional)

• Type: number

Unix timestamp before which the transaction must be included.

validAfter (optional)

• Type: number

Unix timestamp after which the transaction can be included.

throwOnReceiptRevert (optional)

• Type: boolean
• Default: true

Whether to throw an error if the transaction receipt indicates a revert. Only applicable to *Sync actions.