Create DEX Pair

Creates a DEX orderbook pair for a base token.

Usage

import { client } from './viem.config'
 
const { base, key, quote } = await client.dex.createPairSync({
  base: '0x20c0000000000000000000000000000000000001',
})
 
console.log('Pair:', { base, quote, key })
Pair: { base: '0x20c0000000000000000000000000000000000001', quote: '0x20c0000000000000000000000000000000000000', key: '0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef' }

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

import { Actions } from 'viem/tempo'
import { client } from './viem.config'
 
const hash = await client.dex.createPair({
  base: '0x20c0000000000000000000000000000000000001',
})
const receipt = await client.transaction.waitForReceipt({ hash }).receipt
 
const { args } = Actions.dex.createPair.extractEvent(receipt.logs)

Recipes

List a Newly Issued Stablecoin

Combine token.create with createPairSync to issue a stablecoin and open its market against the default quote token in one flow.

import { client } from './viem.config'
 
const { token } = await client.token.createSync({
  currency: 'USD',
  name: 'Alpha USD',
  symbol: 'AUSD',
})
 
const { key, quote } = await client.dex.createPairSync({ base: token })

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

Seed a New Pair with Resting Liquidity

A new pair opens with an empty book, so seed it with a dex.placeFlip order that keeps quoting both sides as it fills.

import { Tick } from 'viem/tempo'
import { client } from './viem.config'
 
const alphaUsd = '0x20c0000000000000000000000000000000000001'
 
const { base } = await client.dex.createPairSync({ base: alphaUsd })
 
const { orderId } = await client.dex.placeFlipSync({
  amount: 25_000_000000n,
  flipTick: Tick.fromPrice('1.001'),
  tick: Tick.fromPrice('0.999'),
  token: base,
  type: 'buy',
})

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

Return Value

type ReturnType = {
  /** Pair key. */
  key: Hex
  /** Base token. */
  base: Address
  /** Quote token. */
  quote: Address
  /** Transaction receipt. */
  receipt: TransactionReceipt
}

The created pair key, base token, quote token, and transaction receipt.

Parameters

base

• Type: Address | bigint

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

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.