Remove Liquidity

Decrease Liquidity PSBT

Generates a PSBT for decreasing liquidity from a position. This PSBT is optional and it will be used to pay for the decrease transaction fees if the funds to withdraw are not enough to cover the fees.

POSThttps://api-dev.saturnbtc.io/v0/pool/decrease-liquidity/psbt

Authorization

Body

The request body containing the PSBT creation details.

feeRate*The fee rate for the transaction (in sats per byte)

The fee rate for the transaction (in sats per byte).

pubkey*The public key of the user initiating the request

The public key of the user initiating the request.

address*string

The address of the user. If no secondary address is provided, the primary address must be a taproot address. (P2TR)

secondaryAddressstring

The secondary address of the user. Must be a taproot address. (P2TR)

Response

An object containing the PSBT (in base64 format), the fee, and the list of UTXOs to sign.

Body

psbt*string

fee*number

utxosToSign*array of UtxoToSign (object)

Request

const response = await fetch('https://api-dev.saturnbtc.io/v0/pool/decrease-liquidity/psbt', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "feeRate": 0,
      "pubkey": "text",
      "address": "text"
    }),
});
const data = await response.json();

Response

{
  "psbt": "text",
  "fee": 0,
  "utxosToSign": [
    {
      "address": "text",
      "signingIndexes": [
        0
      ],
      "sigHash": 0,
      "utxo": "text"
    }
  ]
}

Decrease Liquidity Message

Generates a message hash for decreasing liquidity from a position, which the user should sign.

POSThttps://api-dev.saturnbtc.io/v0/pool/decrease-liquidity/message

Authorization

Body

The request body containing the liquidity decrease details.

poolId*The pubkey of the pool

The pubkey of the pool.

positionPubKey*The pubkey of the position

The pubkey of the position.

liquidityAmount*The amount of liquidity to withdraw

The amount of liquidity to withdraw.

feeRate*The fee rate for the transaction (in sats per byte)

The fee rate for the transaction (in sats per byte).

minToken0*The minimum amount of the first token to withdraw

The minimum amount of the first token to withdraw.

minToken1*The minimum amount of the second token to withdraw

The minimum amount of the second token to withdraw.

withdrawAddressToken0*The address to withdraw the first token to

The address to withdraw the first token to.

withdrawAddressToken1*The address to withdraw the second token to

The address to withdraw the second token to.

signedPsbtThe signed PSBT in base64 format

The signed PSBT in base64 format.

pubkey*The public key of the user initiating the request

The public key of the user initiating the request.

address*string

The address of the user. If no secondary address is provided, the primary address must be a taproot address. (P2TR)

secondaryAddressstring

The secondary address of the user. Must be a taproot address. (P2TR)

Response

A hexadecimal string representing the hash of the message to be signed by the user.

Body

string

Request

const response = await fetch('https://api-dev.saturnbtc.io/v0/pool/decrease-liquidity/message', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "poolId": "text",
      "positionPubKey": "text",
      "liquidityAmount": "text",
      "feeRate": 0,
      "minToken0": "text",
      "minToken1": "text",
      "withdrawAddressToken0": "text",
      "withdrawAddressToken1": "text",
      "pubkey": "text",
      "address": "text"
    }),
});
const data = await response.json();

Response

text

Decrease Liquidity

Finalizes the decrease of liquidity from a position by submitting the signed message and executing the transaction on the network.

POSThttps://api-dev.saturnbtc.io/v0/pool/decrease-liquidity

Authorization

Body

The request body containing the liquidity decrease request and signature.

signature*The user's signature of the decrease liquidity message

The user's signature of the decrease liquidity message.

poolId*The pubkey of the pool

The pubkey of the pool.

positionPubKey*The pubkey of the position

The pubkey of the position.

liquidityAmount*The amount of liquidity to withdraw

The amount of liquidity to withdraw.

feeRate*The fee rate for the transaction (in sats per byte)

The fee rate for the transaction (in sats per byte).

minToken0*The minimum amount of the first token to withdraw

The minimum amount of the first token to withdraw.

minToken1*The minimum amount of the second token to withdraw

The minimum amount of the second token to withdraw.

withdrawAddressToken0*The address to withdraw the first token to

The address to withdraw the first token to.

withdrawAddressToken1*The address to withdraw the second token to

The address to withdraw the second token to.

signedPsbtThe signed PSBT in base64 format

The signed PSBT in base64 format.

pubkey*The public key of the user initiating the request

The public key of the user initiating the request.

address*string

The address of the user. If no secondary address is provided, the primary address must be a taproot address. (P2TR)

secondaryAddressstring

The secondary address of the user. Must be a taproot address. (P2TR)

Response

The Arch Network transaction ID of the liquidity decrease.

Body

string

Request

const response = await fetch('https://api-dev.saturnbtc.io/v0/pool/decrease-liquidity', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "signature": "text",
      "poolId": "text",
      "positionPubKey": "text",
      "liquidityAmount": "text",
      "feeRate": 0,
      "minToken0": "text",
      "minToken1": "text",
      "withdrawAddressToken0": "text",
      "withdrawAddressToken1": "text",
      "pubkey": "text",
      "address": "text"
    }),
});
const data = await response.json();

Response

text

PreviousIncrease Liquidity NextSwap

Last updated 2 days ago

const response = await fetch('https://api-dev.saturnbtc.io/v0/pool/decrease-liquidity/message', { method: 'POST', headers: { "Content-Type": "application/json" }, body: JSON.stringify({ "poolId": "text", "positionPubKey": "text", "liquidityAmount": "text", "feeRate": 0, "minToken0": "text", "minToken1": "text", "withdrawAddressToken0": "text", "withdrawAddressToken1": "text", "pubkey": "text", "address": "text" }), }); const data = await response.json();

const response = await fetch('https://api-dev.saturnbtc.io/v0/pool/decrease-liquidity', { method: 'POST', headers: { "Content-Type": "application/json" }, body: JSON.stringify({ "signature": "text", "poolId": "text", "positionPubKey": "text", "liquidityAmount": "text", "feeRate": 0, "minToken0": "text", "minToken1": "text", "withdrawAddressToken0": "text", "withdrawAddressToken1": "text", "pubkey": "text", "address": "text" }), }); const data = await response.json();