Place DEX Order

Places a limit order on the DEX orderbook.

Usage

import { client } from './viem.config'
 
const { amount, orderId, tick } = await client.dex.placeSync({
  amount: 100000000n,
  tick: 100,
  token: '0x20c0000000000000000000000000000000000001',
  type: 'buy',
})
 
console.log('Order:', { amount, orderId, tick })
Order: { amount: 100000000n, orderId: 123n, tick: 100 }

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.place action and wait for inclusion manually:

import { Actions } from 'viem/tempo'
import { client } from './viem.config'
 
const hash = await client.dex.place({
  amount: 100000000n,
  tick: 100,
  token: '0x20c0000000000000000000000000000000000001',
  type: 'buy',
})
const receipt = await client.transaction.waitForReceipt({ hash }).receipt
 
const { args } = Actions.dex.place.extractEvent(receipt.logs)

Recipes

Quote at a Human-Readable Price

Use Tick.fromPrice to express the order price as a decimal string instead of computing raw ticks by hand.

import { Tick } from 'viem/tempo'
import { client } from './viem.config'
 
const { orderId } = await client.dex.placeSync({
  amount: 100_000000n,
  tick: Tick.fromPrice('0.999'),
  token: '0x20c0000000000000000000000000000000000001',
  type: 'buy',
})

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

Rest Both Sides of the Spread in One Transaction

Combine two place calls with transaction.sendSync to quote a bid and an ask atomically when market making.

import { Actions, Tick } from 'viem/tempo'
import { client } from './viem.config'
 
const alphaUsd = '0x20c0000000000000000000000000000000000001'
 
const receipt = await client.transaction.sendSync({
  calls: [
    Actions.dex.place.call({
      amount: 5_000_000000n,
      tick: Tick.fromPrice('0.999'),
      token: alphaUsd,
      type: 'buy',
    }),
    Actions.dex.place.call({
      amount: 5_000_000000n,
      tick: Tick.fromPrice('1.001'),
      token: alphaUsd,
      type: 'sell',
    }),
  ],
})

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

Return Value

type ReturnType = {
  /** Order ID. */
  orderId: bigint
  /** Order maker. */
  maker: Address
  /** Base token. */
  token: Address
  /** Order amount. */
  amount: bigint
  /** Whether the order is a bid. */
  isBid: boolean
  /** Price tick. */
  tick: number
  /** Whether the order is a flip order. */
  isFlipOrder: boolean
  /** Flip tick. */
  flipTick: number
  /** Transaction receipt. */
  receipt: TransactionReceipt
}

The placed order event data and transaction receipt.

Parameters

amount

• Type: bigint

Amount of tokens to place in the order.

tick

• Type: number

Price tick for the order. A tick of 100 is approximately price 1.001.

token

• Type: Address | bigint

Base token: a TIP-20 token id or a contract address.

type

• Type: 'buy' | 'sell'

Order type.

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.