Sell DEX Tokens

Sells an exact amount of tokens into the DEX orderbook.

Usage

import { client } from './viem.config'
 
const { receipt } = await client.dex.sellSync({
  amountIn: 100000000n,
  minAmountOut: 50000000n,
  tokenIn: '0x20c0000000000000000000000000000000000001',
  tokenOut: '0x20c0000000000000000000000000000000000000',
})
 
console.log('Transaction hash:', receipt.transactionHash)
Transaction hash: 0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef

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

Recipes

Convert an Entire Merchant Balance

Combine token.getBalance with dex.getSellQuote to sweep a full stablecoin balance into your treasury token at a bounded price.

import { client } from './viem.config'
 
const alphaUsd = '0x20c0000000000000000000000000000000000001'
const pathUsd = '0x20c0000000000000000000000000000000000000'
 
const { amount: amountIn } = await client.token.getBalance({
  token: alphaUsd,
})
 
const quote = await client.dex.getSellQuote({
  amountIn,
  tokenIn: alphaUsd,
  tokenOut: pathUsd,
})
 
const { receipt } = await client.dex.sellSync({
  amountIn,
  minAmountOut: (quote * 995n) / 1_000n,
  tokenIn: alphaUsd,
  tokenOut: pathUsd,
})

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

Settle Proceeds Straight to Your Wallet

Sell proceeds settle to your internal DEX balance, so batch the sell with dex.withdraw when you need funds in your wallet immediately.

import { Actions } from 'viem/tempo'
import { client } from './viem.config'
 
const alphaUsd = '0x20c0000000000000000000000000000000000001'
const pathUsd = '0x20c0000000000000000000000000000000000000'
 
const receipt = await client.transaction.sendSync({
  calls: [
    Actions.dex.sell.call({
      amountIn: 1_000_000000n,
      minAmountOut: 995_000000n,
      tokenIn: alphaUsd,
      tokenOut: pathUsd,
    }),
    Actions.dex.withdraw.call({
      amount: 995_000000n,
      token: pathUsd,
    }),
  ],
})

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

Withdraw the minAmountOut you are guaranteed to receive. Any excess output stays on your DEX balance.

Return Value

type ReturnType = {
  /** Transaction receipt. */
  receipt: TransactionReceipt
}

The transaction receipt for the sell.

Parameters

amountIn

• Type: bigint

Amount of tokenIn to sell.

minAmountOut

• Type: bigint

Minimum amount of tokenOut to receive.

tokenIn

• Type: Address | bigint

Token to sell: a TIP-20 token id or a contract address.

tokenOut

• Type: Address | bigint

Token to receive: 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.