Remove Liquidity

Last updated 4 months ago

Decrease Liquidity PSBT

post

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.

Authorizations

Body

feeRateinteger · min: 1required

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

runePubkeystring · min: 64 · max: 66required

The public key of the rune address of the user initiating the request.

Pattern: ^[0-9a-fA-F]+$

paymentPubkeystring · min: 64 · max: 66optional

The public key of the bitcoin address of the user initiating the request. If the user doesn't have a bitcoin address, the runePubkey will be used

Pattern: ^[0-9a-fA-F]+$

runeAddressstringrequired

The rune address of the user. It must be a taproot address. (P2TR). If no bitcoin address is provided, the rune address will be used for bitcoin too.

paymentAddressstringoptional

The bitcoin address of the user.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://api-dev.saturnbtc.io/v0/pool/decrease-liquidity/psbt' \
  --header 'x-api-key: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "feeRate": 1,
    "runePubkey": "text",
    "paymentPubkey": "text",
    "runeAddress": "text",
    "paymentAddress": "text"
  }'

201

400

401

403

500

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

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

Decrease Liquidity Message

post

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

Authorizations

Body

poolIdstring · min: 64 · max: 66required

The pubkey of the pool.

Pattern: ^[0-9a-fA-F]+$

positionPubKeystring · min: 64 · max: 66required

The pubkey of the position.

Pattern: ^[0-9a-fA-F]+$

liquidityAmountstringrequired

The amount of liquidity to withdraw.

feeRateinteger · min: 1required

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

minToken0stringrequired

The minimum amount of the first token to withdraw.

Pattern: ^[1-9][0-9]*$

minToken1stringrequired

The minimum amount of the second token to withdraw.

Pattern: ^[1-9][0-9]*$

withdrawAddressToken0stringrequired

The address to withdraw the first token to.

withdrawAddressToken1stringrequired

The address to withdraw the second token to.

signedPsbtstringoptional

The signed PSBT in base64 format.

Pattern: ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{4}|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{2}={2})$

runePubkeystring · min: 64 · max: 66required

The public key of the rune address of the user initiating the request.

Pattern: ^[0-9a-fA-F]+$

paymentPubkeystring · min: 64 · max: 66optional

The public key of the bitcoin address of the user initiating the request. If the user doesn't have a bitcoin address, the runePubkey will be used

Pattern: ^[0-9a-fA-F]+$

runeAddressstringrequired

The rune address of the user. It must be a taproot address. (P2TR). If no bitcoin address is provided, the rune address will be used for bitcoin too.

paymentAddressstringoptional

The bitcoin address of the user.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://api-dev.saturnbtc.io/v0/pool/decrease-liquidity/message' \
  --header 'x-api-key: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "poolId": "text",
    "positionPubKey": "text",
    "liquidityAmount": "text",
    "feeRate": 1,
    "minToken0": "text",
    "minToken1": "text",
    "withdrawAddressToken0": "text",
    "withdrawAddressToken1": "text",
    "signedPsbt": "text",
    "runePubkey": "text",
    "paymentPubkey": "text",
    "runeAddress": "text",
    "paymentAddress": "text"
  }'

201

400

401

403

500

text

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

Decrease Liquidity

post

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

Authorizations

Body

signaturestringrequired

The user's signature of the decrease liquidity message.

Pattern: ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{4}|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{2}={2})$

poolIdstring · min: 64 · max: 66required

The pubkey of the pool.

Pattern: ^[0-9a-fA-F]+$

positionPubKeystring · min: 64 · max: 66required

The pubkey of the position.

Pattern: ^[0-9a-fA-F]+$

liquidityAmountstringrequired

The amount of liquidity to withdraw.

feeRateinteger · min: 1required

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

minToken0stringrequired

The minimum amount of the first token to withdraw.

Pattern: ^[1-9][0-9]*$

minToken1stringrequired

The minimum amount of the second token to withdraw.

Pattern: ^[1-9][0-9]*$

withdrawAddressToken0stringrequired

The address to withdraw the first token to.

withdrawAddressToken1stringrequired

The address to withdraw the second token to.

signedPsbtstringoptional

The signed PSBT in base64 format.

Pattern: ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{4}|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{2}={2})$

runePubkeystring · min: 64 · max: 66required

The public key of the rune address of the user initiating the request.

Pattern: ^[0-9a-fA-F]+$

paymentPubkeystring · min: 64 · max: 66optional

The public key of the bitcoin address of the user initiating the request. If the user doesn't have a bitcoin address, the runePubkey will be used

Pattern: ^[0-9a-fA-F]+$

runeAddressstringrequired

The rune address of the user. It must be a taproot address. (P2TR). If no bitcoin address is provided, the rune address will be used for bitcoin too.

paymentAddressstringoptional

The bitcoin address of the user.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://api-dev.saturnbtc.io/v0/pool/decrease-liquidity' \
  --header 'x-api-key: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "signature": "text",
    "poolId": "text",
    "positionPubKey": "text",
    "liquidityAmount": "text",
    "feeRate": 1,
    "minToken0": "text",
    "minToken1": "text",
    "withdrawAddressToken0": "text",
    "withdrawAddressToken1": "text",
    "signedPsbt": "text",
    "runePubkey": "text",
    "paymentPubkey": "text",
    "runeAddress": "text",
    "paymentAddress": "text"
  }'

201

400

401

403

500

{
  "archTxId": "text",
  "bitcoinTxIds": [
    "text"
  ]
}

The Arch Network transaction ID of the liquidity decrease.