Burn AMM Liquidity

Removes liquidity from a pool.

Usage

import { client } from './viem.config'
 
const { receipt, ...event } = await client.amm.burnSync({
  liquidity: 500000n,
  to: '0x742d35Cc6634C0532925a3b844Bc9e7595f0bEbb',
  userToken: '0x20c0000000000000000000000000000000000001',
  validatorToken: '0x20c0000000000000000000000000000000000002',
})
 
console.log('Burn:', event)
Burn: { amountUserToken: 500000n, amountValidatorToken: 500000n, liquidity: 500000n, to: '0x742d35Cc6634C0532925a3b844Bc9e7595f0bEbb', userToken: '0x20c0000000000000000000000000000000000001', validatorToken: '0x20c0000000000000000000000000000000000002', sender: '0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266' }

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

Asynchronous Usage

The examples above use 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 { Actions } from 'viem/tempo'
import { client } from './viem.config'
 
const hash = await client.amm.burn({
  liquidity: 500000n,
  to: '0x742d35Cc6634C0532925a3b844Bc9e7595f0bEbb',
  userToken: '0x20c0000000000000000000000000000000000001',
  validatorToken: '0x20c0000000000000000000000000000000000002',
})
const receipt = await client.transaction.waitForReceipt({ hash }).receipt
 
const { args } = Actions.amm.burn.extractEvent(receipt.logs)

Recipes

Exit a Pool Completely

Combine amm.getLiquidityBalance with burnSync to withdraw a full position, for example when winding down a treasury's allocation to a pool.

import { client } from './viem.config'
 
const userToken = '0x20c0000000000000000000000000000000000001'
const validatorToken = '0x20c0000000000000000000000000000000000002'
 
const liquidity = await client.amm.getLiquidityBalance({
  address: client.account.address,
  userToken,
  validatorToken,
})
 
const { amountUserToken, amountValidatorToken } = await client.amm.burnSync({
  liquidity,
  to: client.account.address,
  userToken,
  validatorToken,
})
 
console.log('Withdrawn:', amountUserToken, amountValidatorToken)
Withdrawn: 500000n 500000n

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

Preview the Tokens a Burn Returns

Use amm.getPool to compute the pro-rata share a burn will return, so a withdrawal report shows expected amounts before execution.

import { client } from './viem.config'
 
const userToken = '0x20c0000000000000000000000000000000000001'
const validatorToken = '0x20c0000000000000000000000000000000000002'
const liquidity = 500_000n
 
const pool = await client.amm.getPool({ userToken, validatorToken })
 
const expectedUserToken =
  (liquidity * pool.reserveUserToken) / pool.totalSupply
const expectedValidatorToken =
  (liquidity * pool.reserveValidatorToken) / pool.totalSupply
 
console.log('Expected:', expectedUserToken, expectedValidatorToken)
Expected: 500000n 500000n
 await client.amm.burnSync({
  liquidity,
  to: client.account.address,
  userToken,
  validatorToken,
})

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

Return Value

type ReturnType = {
  /** Address that removed liquidity. */
  sender: Address
  /** User token address. */
  userToken: Address
  /** Validator token address. */
  validatorToken: Address
  /** Amount of user token returned. */
  amountUserToken: bigint
  /** Amount of validator token returned. */
  amountValidatorToken: bigint
  /** Amount of LP tokens burned. */
  liquidity: bigint
  /** Address that received tokens. */
  to: Address
  /** Transaction receipt. */
  receipt: TransactionReceipt
}

The transaction receipt and decoded Burn event data.

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.

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.