Swap
Generates a PSBT for performing a swap between tokens in a pool.
The identifier of the pool.
^[0-9a-fA-F]+$The amount of input token to swap.
^[1-9][0-9]*$The amount of output token expected.
^[1-9][0-9]*$The fee rate for the transaction (in sats per byte).
A boolean indicating whether to swap from token0 to token1.
A boolean indicating whether the swap is exact in.
The split rune PSBT in base64 format.
^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{4}|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{2}={2})$The public key of the rune address of the user initiating the request.
^[0-9a-fA-F]+$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
^[0-9a-fA-F]+$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.
The bitcoin address of the user.
An object containing the PSBT (in base64 format), the fee, the list of UTXOs to sign, and optionally additional swap details.
Pool error
Unauthorized
User not found
Internal Server Error
POST /v0/pool/swap/psbt HTTP/1.1
Host: api-dev.saturnbtc.io
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 209
{
"poolId": "text",
"amountIn": "text",
"amountOut": "text",
"feeRate": 1,
"zeroToOne": true,
"exactIn": true,
"splitRunePsbt": "text",
"runePubkey": "text",
"paymentPubkey": "text",
"runeAddress": "text",
"paymentAddress": "text"
}{
"splitRunePsbt": {
"totalAmount": "text",
"amountToReceive": "text",
"psbt": "text",
"fee": 1,
"utxosToSign": [
{
"address": "text",
"signingIndexes": [
1
],
"sigHash": 1,
"utxo": "text"
}
]
},
"mergeUtxoPsbt": {
"psbt": "text",
"fee": 1,
"utxosToSign": [
{
"address": "text",
"signingIndexes": [
1
],
"sigHash": 1,
"utxo": "text"
}
]
},
"shardPubkeys": [
"text"
],
"psbt": "text",
"fee": 1,
"utxosToSign": [
{
"address": "text",
"signingIndexes": [
1
],
"sigHash": 1,
"utxo": "text"
}
]
}Generates a message hash for performing a swap, which the user should sign.
The signed PSBT in base64 format.
^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{4}|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{2}={2})$The split rune PSBT in base64 format.
^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{4}|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{2}={2})$The merge UTXO PSBT in base64 format.
^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{4}|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{2}={2})$The pubkeys of the shards. Only applicable in the btc=>rune swap. (zeroToOne=false)
The recent blockhash of the transaction.
The identifier of the pool.
^[0-9a-fA-F]+$The amount of input token to swap.
^[1-9][0-9]*$The amount of output token expected.
^[1-9][0-9]*$The fee rate for the transaction (in sats per byte).
A boolean indicating whether to swap from token0 to token1.
A boolean indicating whether the swap is exact in.
The public key of the rune address of the user initiating the request.
^[0-9a-fA-F]+$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
^[0-9a-fA-F]+$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.
The bitcoin address of the user.
A hexadecimal string representing the hash of the message to be signed by the user.
Pool error
Unauthorized
User not found
Internal Server Error
POST /v0/pool/swap/message HTTP/1.1
Host: api-dev.saturnbtc.io
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 301
{
"signedPsbt": "text",
"splitRunePsbt": "text",
"mergeUtxoPsbt": "text",
"shardPubkeys": [
"text"
],
"recentBlockhash": "text",
"poolId": "text",
"amountIn": "text",
"amountOut": "text",
"feeRate": 1,
"zeroToOne": true,
"exactIn": true,
"runePubkey": "text",
"paymentPubkey": "text",
"runeAddress": "text",
"paymentAddress": "text"
}textFinalizes the swap transaction by submitting the signed message and executing the swap on the network.
The signed PSBT in base64 format.
^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{4}|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{2}={2})$The split rune PSBT in base64 format.
^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{4}|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{2}={2})$The merge UTXO PSBT in base64 format.
^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{4}|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{2}={2})$The pubkeys of the shards. Only applicable in the btc=>rune swap. (zeroToOne=false)
The recent blockhash of the transaction.
The identifier of the pool.
^[0-9a-fA-F]+$The amount of input token to swap.
^[1-9][0-9]*$The amount of output token expected.
^[1-9][0-9]*$The fee rate for the transaction (in sats per byte).
A boolean indicating whether to swap from token0 to token1.
A boolean indicating whether the swap is exact in.
The public key of the rune address of the user initiating the request.
^[0-9a-fA-F]+$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
^[0-9a-fA-F]+$The user's signature of the swap message.
^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{4}|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{2}={2})$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.
The bitcoin address of the user.
The Arch Network transaction ID of the swap.
Pool error
Unauthorized
User not found
Internal Server Error
POST /v0/pool/swap HTTP/1.1
Host: api-dev.saturnbtc.io
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 320
{
"signedPsbt": "text",
"splitRunePsbt": "text",
"mergeUtxoPsbt": "text",
"shardPubkeys": [
"text"
],
"recentBlockhash": "text",
"poolId": "text",
"amountIn": "text",
"amountOut": "text",
"feeRate": 1,
"zeroToOne": true,
"exactIn": true,
"runePubkey": "text",
"paymentPubkey": "text",
"signature": "text",
"runeAddress": "text",
"paymentAddress": "text"
}{
"archTxId": "text",
"bitcoinTxIds": [
"text"
]
}How to Apply Slippage to Your Swaps
Understanding Slippage: Slippage refers to the difference between the expected price of a trade and the price at which the trade is executed.
Applying Slippage:
To apply slippage, request less
amountOutfor theamountInyou are swapping.For example, to apply a 3% slippage tolerance:
Subtract 3% from the
amountOutvalue.Use this adjusted
amountOutin your swap request.
Swap Processing:
Program Behavior:
The program checks if you are entitled to receive more
tokenOutthan specified in the transaction.If Yes:
Swap from Rune to BTC: The program will include the additional BTC you should receive in the transaction.
Swap from BTC to Rune: The program will hold the extra Rune you should have received. In your next call to the program, it will send you your corresponding portion.
Last updated