Skip to content

dex.placeFlip

Places a flip order that automatically flips to the opposite side when filled.

Usage

example.ts
import { Actions } from 'tempo.ts/wagmi'
import { parseUnits } from 'viem'
import { Tick } from 'tempo.ts/viem'
import { config } from './wagmi.config'
 
const { orderId, receipt } = await Actions.dex.placeFlipSync(config, {
  amount: parseUnits('100', 6),
  flipTick: Tick.fromPrice('1.01'),
  tick: Tick.fromPrice('0.99'),
  token: '0x20c0000000000000000000000000000000000001',
  type: 'buy',
})
 
console.log('Flip order ID:', orderId)

Flip order ID: 456n

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

import { Actions } from 'tempo.ts/wagmi'
import { Actions as viem_Actions } from 'tempo.ts/viem'
import { waitForTransactionReceipt } from 'wagmi/actions'
import { parseUnits } from 'viem'
import { Tick } from 'tempo.ts/viem'
import { config } from './wagmi.config'
 
const hash = await Actions.dex.placeFlip(config, {
  amount: parseUnits('100', 6),
  flipTick: Tick.fromPrice('1.01'),
  tick: Tick.fromPrice('0.99'),
  token: '0x20c0000000000000000000000000000000000001',
  type: 'buy',
})
const receipt = await waitForTransactionReceipt(config, { hash })
 
const { args: { orderId } } 
  = viem_Actions.dex.placeFlip.extractEvent(receipt.logs)

Return Type

type ReturnType = {
  /** ID of the placed flip order */
  orderId: bigint
  /** Address of the order maker */
  maker: Address
  /** Address of the base token */
  token: Address
  /** Amount of tokens in the order */
  amount: bigint
  /** Whether this is a buy order */
  isBid: boolean
  /** Price tick for the order */
  tick: number
  /** Target tick to flip to when order is filled */
  flipTick: number
  /** Transaction receipt */
  receipt: TransactionReceipt
}

Parameters

amount

  • Type: bigint

Amount of tokens to place in the order.

flipTick

  • Type: number

Target tick to flip to when order is filled. Must be greater than tick for buy orders, less than tick for sell orders.

tick

  • Type: number

Price tick for the order. Use Tick.fromPrice() to convert from a price string.

token

  • Type: Address

Address of the base token.

type

  • Type: 'buy' | 'sell'

Order type - 'buy' to buy the token, 'sell' to sell it.

account (optional)

  • Type: Account | Address

Account that will be used to send the transaction. Defaults to connected Wagmi account.

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.