Open position

Open Position PSBT

post

/v0/pool/open-position/psbt

Generates a PSBT for opening a new liquidity position by sending funds to the pool.

Authorizations

x-api-keystringRequired

Body

poolIdstring · min: 64 · max: 66Required

The pool's identifier.

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

amount0stringRequired

The amount of the first token to deposit.

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

amount1stringRequired

The amount of the second token to deposit.

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

initializeAccountUtxobooleanRequired

A boolean indicating whether to initialize the account UTXO. If you're creating a new position, you should set this to true.

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

201

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

application/json

400

Pool error

application/json

401

Unauthorized

application/json

403

User not found

application/json

500

Internal Server Error

application/json

post

/v0/pool/open-position/psbt

POST /v0/pool/open-position/psbt HTTP/1.1
Host: api-dev.saturnbtc.io
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 180

{
  "poolId": "text",
  "amount0": "text",
  "amount1": "text",
  "initializeAccountUtxo": true,
  "feeRate": 1,
  "runePubkey": "text",
  "paymentPubkey": "text",
  "runeAddress": "text",
  "paymentAddress": "text"
}

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

Open Position Message

post

/v0/pool/open-position/message

Generates a message hash for opening a new liquidity position, which the user should sign.

Authorizations

x-api-keystringRequired

Body

poolIdstring · min: 64 · max: 66Required

The pubkey of the pool.

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

amount0stringRequired

The amount of the first token to deposit.

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

amount1stringRequired

The amount of the second token to deposit.

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

maxAmount0stringRequired

The maximum amount of the first token to deposit.

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

maxAmount1stringRequired

The maximum amount of the second token to deposit.

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

feeRateinteger · min: 1Required

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

signedPsbtstringRequired

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})$

recentBlockhashstringRequired

The recent blockhash of the transaction.

mergeUtxoPsbtstringOptional

The merge UTXO 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

201

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

application/json

400

Pool error

application/json

401

Unauthorized

application/json

403

User not found

application/json

500

Internal Server Error

application/json

post

/v0/pool/open-position/message

POST /v0/pool/open-position/message HTTP/1.1
Host: api-dev.saturnbtc.io
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 259

{
  "poolId": "text",
  "amount0": "text",
  "amount1": "text",
  "maxAmount0": "text",
  "maxAmount1": "text",
  "feeRate": 1,
  "signedPsbt": "text",
  "recentBlockhash": "text",
  "mergeUtxoPsbt": "text",
  "runePubkey": "text",
  "paymentPubkey": "text",
  "runeAddress": "text",
  "paymentAddress": "text"
}

text

Open Position

post

/v0/pool/open-position

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

Authorizations

x-api-keystringRequired

Body

signaturestringRequired

The user's signature of the open position 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]+$

amount0stringRequired

The amount of the first token to deposit.

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

amount1stringRequired

The amount of the second token to deposit.

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

maxAmount0stringRequired

The maximum amount of the first token to deposit.

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

maxAmount1stringRequired

The maximum amount of the second token to deposit.

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

feeRateinteger · min: 1Required

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

signedPsbtstringRequired

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})$

recentBlockhashstringRequired

The recent blockhash of the transaction.

mergeUtxoPsbtstringOptional

The merge UTXO 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

201

The Arch Network transaction ID of the position opening.

application/json

400

Pool error

application/json

401

Unauthorized

application/json

403

User not found

application/json

500

Internal Server Error

application/json

post

/v0/pool/open-position

POST /v0/pool/open-position HTTP/1.1
Host: api-dev.saturnbtc.io
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 278

{
  "signature": "text",
  "poolId": "text",
  "amount0": "text",
  "amount1": "text",
  "maxAmount0": "text",
  "maxAmount1": "text",
  "feeRate": 1,
  "signedPsbt": "text",
  "recentBlockhash": "text",
  "mergeUtxoPsbt": "text",
  "runePubkey": "text",
  "paymentPubkey": "text",
  "runeAddress": "text",
  "paymentAddress": "text"
}

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

PreviousAdd Shards NextIncrease Liquidity

Last updated 7 months ago