Initialize pool

Initialize Pool PSBT

Generates a partially signed Bitcoin transaction (PSBT) for creating the needed UTXOs for creating the accounts for a pool.

The request body containing details for creating accounts PSBT.

post

/v0/pool/initialize-pool/psbt

Authorizations

Body

feeRateThe fee rate for the transaction (in sats per byte)required

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

accountsLengthThe number of accounts to create. Maximum is 11required

The number of accounts to create. Maximum is 11.

runePubkeyThe public key of the rune address of the user initiating the requestrequired

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

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

paymentPubkeyThe public key of the bitcoin address of the user initiating the request

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]+$

runeAddressThe rune address of the user. It must be a taproot address. (P2TR)required

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.

paymentAddressThe bitcoin address of the user

The bitcoin address of the user.

Responses

application/json

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

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

201

400

401

403

500

201

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

An object containing the PSBT, fee, utxos to sign, and the created accounts.

Initialize Pool Message

Generates a message hash required to initialize a pool.

post

/v0/pool/initialize-pool/message

Authorizations

Body

token0The first token's identifierrequired

The first token's identifier.

token1The second token's identifierrequired

The second token's identifier.

feeTierThe fee tier for the poolrequired

The fee tier for the pool.

feeRateThe fee rate for the transaction (in sats per byte)required

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

signedPsbtThe signed PSBT in base64 formatrequired

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

runePubkeyThe public key of the rune address of the user initiating the requestrequired

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

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

paymentPubkeyThe public key of the bitcoin address of the user initiating the request

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]+$

runeAddressThe rune address of the user. It must be a taproot address. (P2TR)required

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.

paymentAddressThe bitcoin address of the user

The bitcoin address of the user.

accountsThe accounts created in the `initialize-pool/psbt` endpointrequired

The accounts created in the initialize-pool/psbt endpoint.

Responses

application/json

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api-dev.saturnbtc.io/v0/pool/initialize-pool/message' \
  --header 'x-api-key: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{"token0":"text","token1":"text","feeTier":1,"feeRate":1,"signedPsbt":"text","runePubkey":"text","runeAddress":"text","accounts":[{"privkey":"text","pubkey":"text","address":"text"}]}'

201

400

401

403

500

201

text

A hexadecimal string representing the hash of the initialization message.

Initialize Pool

Finalizes the pool initialization process.

post

/v0/pool/initialize-pool

Authorizations

Body

signatureThe user's signature of the initialization messagerequired

The user's signature of the initialization message.

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

token0The first token's identifierrequired

The first token's identifier.

token1The second token's identifierrequired

The second token's identifier.

feeTierThe fee tier for the poolrequired

The fee tier for the pool.

feeRateThe fee rate for the transaction (in sats per byte)required

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

signedPsbtThe signed PSBT in base64 formatrequired

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

runePubkeyThe public key of the rune address of the user initiating the requestrequired

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

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

paymentPubkeyThe public key of the bitcoin address of the user initiating the request

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]+$

runeAddressThe rune address of the user. It must be a taproot address. (P2TR)required

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.

paymentAddressThe bitcoin address of the user

The bitcoin address of the user.

accountsThe accounts created in the `initialize-pool/psbt` endpointrequired

The accounts created in the initialize-pool/psbt endpoint.

Responses

application/json

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api-dev.saturnbtc.io/v0/pool/initialize-pool' \
  --header 'x-api-key: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{"signature":"text","token0":"text","token1":"text","feeTier":1,"feeRate":1,"signedPsbt":"text","runePubkey":"text","runeAddress":"text","accounts":[{"privkey":"text","pubkey":"text","address":"text"}]}'

201

400

401

403

500

201

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

The Arch Network transaction ID of the pool creation.