Are you an LLM? Read llms.txt for a summary of the docs, or llms-full.txt for the full context.
Skip to content

withdrawLiquidity

Withdraw passive liquidity from a pair by burning LP tokens. The redemption happens at the pool ratio.

Signature

function withdrawLiquidity(
  client: Client<Signer>,
  parameters: {
    sender: Address
    baseDenom: Denom
    quoteDenom: Denom
    funds: Coins
  },
): Promise<{ hash: Uint8Array } & TxData>

Example

import { createSignerClient, createTransport, testnet, PrivateKeySigner } from "@left-curve/sdk"
import type { Address } from "@left-curve/sdk"
 
const client = createSignerClient({
  chain: testnet,
  transport: createTransport(),
  signer: PrivateKeySigner.fromMnemonic(process.env.DANGO_MNEMONIC!),
})
const sender: Address = "0x1234567890abcdef1234567890abcdef12345678"
 
await client.withdrawLiquidity({
  sender,
  baseDenom: "dango",
  quoteDenom: "bridge/usdc",
  funds: { "lp/dango/bridge_usdc": "1000000" },
})

Parameters

sender — Address. The LP.

baseDenom — Denom. Base asset.

quoteDenom — Denom. Quote asset.

funds — Coins. The LP token to burn (lookup lpDenom via getPair).

Returns

{ hash: Uint8Array } & TxData — see broadcastTxSync.

See also