Skip to content

amm.burn

Burns liquidity tokens and receives the underlying token pair. Learn more about the Fee AMM

Usage

example.ts
import { parseUnits } from 'viem'
import { client } from './viem.config'
 
const { amountUserToken, amountValidatorToken, receipt } =
  await client.amm.burnSync({
    liquidity: parseUnits('10.5', 18),
    to: '0x742d35Cc6634C0532925a3b844Bc9e7595f0bEbb',
    userToken: '0x20c0000000000000000000000000000000000000',
    validatorToken: '0x20c0000000000000000000000000000000000001',
  })
 
console.log('Received user tokens:', amountUserToken)

Received user tokens: 5250000000000000000n
console.log('Received validator tokens:', amountValidatorToken)
Received validator tokens: 5250000000000000000n

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

import { parseUnits } from 'viem'
import { Actions } from 'tempo.ts/viem'
import { client } from './viem.config'
 
const hash = await client.amm.burn({
  liquidity: parseUnits('10.5', 18),
  to: '0x742d35Cc6634C0532925a3b844Bc9e7595f0bEbb',
  userToken: '0x20c0000000000000000000000000000000000000',
  validatorToken: '0x20c0000000000000000000000000000000000001',
})
const receipt = await client.waitForTransactionReceipt({ hash })
 
const { args: { amountUserToken, amountValidatorToken } }
  = Actions.amm.burn.extractEvent(receipt.logs)

Return Type

type ReturnType = {
  /** Amount of user tokens received */
  amountUserToken: bigint
  /** Amount of validator tokens received */
  amountValidatorToken: bigint
  /** Amount of liquidity tokens burned */
  liquidity: bigint
  /** Transaction receipt */
  receipt: TransactionReceipt
  /** Address that initiated the burn */
  sender: Address
  /** Address that received the underlying tokens */
  to: Address
  /** Address of the user token */
  userToken: Address
  /** Address of the validator token */
  validatorToken: Address
}

Parameters

liquidity

  • Type: bigint

Amount of LP tokens to burn.

to

  • Type: Address

Address to send tokens to.

userToken

  • Type: Address | bigint

Address or ID of the user token.

validatorToken

  • Type: Address | bigint

Address or ID of the validator token.

account (optional)

  • Type: Account | Address

Account that will be used to send the transaction.

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.