Cancel Stale DEX Order

Cancels a stale DEX order.

Usage

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

import { Account, Client } from 'viem/tempo'
 
export const client = Client.create({
  account: Account.fromSecp256k1('0x...'),
})

Asynchronous Usage

The example above uses the *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.transaction.waitForReceipt({ hash }).receipt
 
const { args } = Actions.dex.cancelStale.extractEvent(receipt.logs)

Recipes

Skip Cancels That Would Revert

Simulate the cancel first: cancelStaleOrder reverts for healthy orders, so a keeper can filter candidates before paying for a transaction.

import { Actions } from 'viem/tempo'
import { client } from './viem.config'
 
const orderId = 123n
 
// Throws if the order is still backed by balance and allowance.
await Actions.dex.cancelStale.simulate(client, { orderId })
 
const { orderId: cancelled } = await client.dex.cancelStaleSync({ orderId })
 
console.log('Cleared stale order:', cancelled)
Cleared stale order: 123n

import { Account, Client } from 'viem/tempo'
 
export const client = Client.create({
  account: Account.fromSecp256k1('0x...'),
})

Sweep a Price Level for Stale Orders

Combine dex.getTickLevel with dex.getOrder to walk every order resting at a tick and clear the ones no longer backed.

import { client } from './viem.config'
 
const level = await client.dex.getTickLevel({
  base: '0x20c0000000000000000000000000000000000001',
  isBid: true,
  tick: -100,
})
 
let orderId = level.head
while (orderId !== 0n) {
  const order = await client.dex.getOrder({ orderId })
  // Healthy orders revert; skip them.
  await client.dex.cancelStaleSync({ orderId }).catch(() => {})
  orderId = order.next
}

import { Account, Client } from 'viem/tempo'
 
export const client = Client.create({
  account: Account.fromSecp256k1('0x...'),
})

Return Value

type ReturnType = {
  /** Cancelled order ID. */
  orderId: bigint
  /** Transaction receipt. */
  receipt: TransactionReceipt
}

The cancelled order id and transaction receipt.

Parameters

orderId

• Type: bigint

Order ID to cancel.

account (optional)

• Type: Account | Address

Account that will be used to send the transaction.

feePayer (optional)

• Type: Account | boolean

Fee payer for the transaction (TIP-1 gas sponsorship).

Pass true to defer the fee token to an external fee payer (e.g. a relay), or a local Account to co-sign the transaction as the fee payer.

feeToken (optional)

• Type: Address | bigint

Fee token for the transaction.

Can be an unpaused USD-denominated TIP-20 token address or ID.

gas (optional)

• Type: bigint

Gas limit for the transaction.

keyAuthorization (optional)

• Type: KeyAuthorization

Signed key authorization to include with the transaction, authorizing an access key to act for the sending account.

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: 'expiring' | 'random' | bigint

Nonce key for the transaction (TIP-1009 2D nonces).

Use 'expiring' to select an expiring nonce, which enables concurrent transaction submission without nonce ordering. Use 'random' to select a random key.

throwOnReceiptRevert (optional)

• Type: boolean
• Default: true

Whether a Sync action throws when the receipt reports a revert.

validAfter (optional)

• Type: number

Unix timestamp after which the transaction can be included.

validBefore (optional)

• Type: number

Unix timestamp before which the transaction must be included.