Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.kaleidoswap.com/llms.txt

Use this file to discover all available pages before exploring further.

​
Market Data

The market group is the read-only entry point for pairs, quotes, routes, and maker metadata.
CommandPurpose
kaleido market assetsList tradeable assets
kaleido market pairsList trading pairs
kaleido market quote <pair>Request a quote
kaleido market infoShow maker node information
kaleido market routes <pair>List route options
kaleido market analyticsShow maker-side order analytics

​
Quote examples

kaleido market quote BTC/USDT --from-amount 100000
kaleido market quote BTC/USDT --to-amount 500 --from-layer BTC_LN --to-layer RGB_LN
Important quote options:
  • --from-amount or --to-amount
  • --from-layer
  • --to-layer
Supported layer values include BTC_LN, RGB_LN, and BTC_ONCHAIN for market quotes.

​
Swap Scopes

Swaps are split across two command groups:
ScopeUse case
swap orderCreate and track maker swap orders through the KaleidoSwap server
swap atomicRun maker-backed atomic swaps using your local node as taker
node swapDrive low-level local RLN swap steps directly (under the node group)

​
Maker Order Flow

Use this flow when you want server-managed swap orders.

​
Subcommands

CommandPurpose
kaleido swap order create <pair>Create an order from a live quote
kaleido swap order decide <order-id>Submit a pending rate decision
kaleido swap order status <order-id>Check order status
kaleido swap order historyList historical orders

​
Example

kaleido swap order create BTC/USDT \
  --to-amount 5000000 \
  --receiver-address lnbcrt... \
  --receiver-format BOLT11
Useful options:
  • --from-amount or --to-amount
  • --from-layer
  • --to-layer
  • --receiver-address
  • --receiver-format
  • --min-onchain-conf
  • --refund-address
  • --email

​
Atomic Swap Flow

Use swap atomic when the maker side is remote but execution uses your local node as taker.

​
Subcommands

CommandPurpose
kaleido swap atomic init <pair>Initialize the atomic swap
kaleido swap atomic executeExecute the initialized swap
kaleido swap atomic status <payment-hash>Track atomic swap status
kaleido swap atomic run <pair>Run init, whitelist, and execute in one command

​
Example

kaleido swap atomic run BTC/USDT --to-amount 5000000
You can also provide:
  • --taker-pubkey
  • --yes
  • explicit --from-layer and --to-layer

​
Local Node Swap Flow

Use node swap for low-level RLN swap steps (these live under the node command group):
CommandPurpose
kaleido node swap pubkeyPrint the taker public key
kaleido node swap initStart a local maker-init swap flow
kaleido node swap whitelistWhitelist the swap on the taker side
kaleido node swap executeExecute after whitelisting
kaleido node swap status <payment-hash>Inspect status
kaleido node swap listList swaps known to the node
This path is useful for debugging, demos, and lower-level protocol operations where you want each step exposed separately.

​
Market-only

kaleido market pairs
kaleido market quote BTC/USDT --from-amount 100000
kaleido swap order create BTC/USDT --to-amount 5000000 --receiver-address lnbcrt... --receiver-format BOLT11

​
With a local node

kaleido node unlock
kaleido node swap pubkey
kaleido swap atomic run BTC/USDT --from-amount 100000 --from-layer BTC_LN --to-layer RGB_LN
Use Command Reference for the complete command map.