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.

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

Authorization

Body

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

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

accountsLength*The number of accounts to create. Maximum is 11

The number of accounts to create. Maximum is 11.

pubkey*The public key of the user initiating the request

The public key of the user initiating the request.

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

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, fee, utxos to sign, and the created accounts.

Body

accounts*Accounts that we will create in Arch after we send the transaction

Accounts that we will create in Arch after we send the transaction.

psbt*string

Psbt base64 encoded to sign

fee*number

Raw fees in satoshis of the transaction

utxosToSign*array of UtxoToSign (object)

Inputs to sign

Request

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

Response

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

Initialize Pool Message

Generates a message hash required to initialize a pool.

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

Authorization

Body

The request body containing pool initialization details.

token0*The first token's identifier

The first token's identifier.

token1*The second token's identifier

The second token's identifier.

feeTier*The fee tier for the pool

The fee tier for the pool.

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.

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

accounts*The accounts created in the `initialize-pool/psbt` endpoint

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

signedPsbt*The signed PSBT in base64 format

The signed PSBT in base64 format.

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 initialization message.

Body

string

Request

const response = await fetch('https://api-dev.saturnbtc.io/v0/pool/initialize-pool/message', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "token0": "text",
      "token1": "text",
      "feeTier": 0,
      "feeRate": 0,
      "pubkey": "text",
      "accounts": [
        {
          "privkey": "text",
          "pubkey": "text",
          "address": "text"
        }
      ],
      "signedPsbt": "text",
      "address": "text"
    }),
});
const data = await response.json();

Response

text

Initialize Pool

Finalizes the pool initialization process.

POSThttps://api-dev.saturnbtc.io/v0/pool/initialize-pool

Authorization

Body

The request body containing the initialization request and signature.

signature*The user's signature of the initialization message

The user's signature of the initialization message.

token0*The first token's identifier

The first token's identifier.

token1*The second token's identifier

The second token's identifier.

feeTier*The fee tier for the pool

The fee tier for the pool.

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.

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

accounts*The accounts created in the `initialize-pool/psbt` endpoint

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

signedPsbt*The signed PSBT in base64 format

The signed PSBT in base64 format.

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 pool creation.

Body

archTxId*Transaction id of the transaction in Arch

Transaction id of the transaction in Arch.

bitcoinTxIds*array of string

Some bitcoin transactions ids that we have broadcasted. The Arch Network will submit a new bitcoin transaction after these ones.

Request

const response = await fetch('https://api-dev.saturnbtc.io/v0/pool/initialize-pool', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "signature": "text",
      "token0": "text",
      "token1": "text",
      "feeTier": 0,
      "feeRate": 0,
      "pubkey": "text",
      "accounts": [
        {
          "privkey": "text",
          "pubkey": "text",
          "address": "text"
        }
      ],
      "signedPsbt": "text",
      "address": "text"
    }),
});
const data = await response.json();

Response

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

PreviousPool API NextAdd Shards

Last updated 2 months ago

const response = await fetch('https://api-dev.saturnbtc.io/v0/pool/initialize-pool', { method: 'POST', headers: { "Content-Type": "application/json" }, body: JSON.stringify({ "signature": "text", "token0": "text", "token1": "text", "feeTier": 0, "feeRate": 0, "pubkey": "text", "accounts": [ { "privkey": "text", "pubkey": "text", "address": "text" } ], "signedPsbt": "text", "address": "text" }), }); const data = await response.json();