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.

Desktop App

Atomic swaps via the desktop application

Developer

Integrate KaleidoSwap into your application

​
Desktop App Quickstart

1

Download & Install

Download the latest release for your platform:
Always verify the binary signatures before installing. Learn how →
2

Create Wallet

Launch KaleidoSwap and create a new wallet:
  1. Click “Create New Wallet”
  2. Save your 12-word recovery phrase securely
  3. Set a strong password
  4. Confirm your seed phrase
Never share your recovery phrase! Anyone with access to it can steal your funds.
3

Deposit Funds

Get your Bitcoin address and deposit funds:
  1. Navigate to “Wallet” → “Receive”
  2. Copy your Bitcoin address
  3. Send BTC to this address from your exchange or wallet
  4. Wait for confirmations (usually 10-60 minutes)
4

Open a Channel

Connect to a Lightning Service Provider:
  1. Go to “Channels” → “Open Channel”
  2. Select an LSP or use the default
  3. Choose channel capacity (recommended: 1M sats minimum)
  4. Select RGB assets to allocate (e.g., USDT)
  5. Confirm and wait for channel to open
5

Make Your First Swap

Execute an atomic swap:
  1. Go to “Swap” tab
  2. Select assets: BTC → USDT (or vice versa)
  3. Enter amount to swap
  4. Review the quote
  5. Confirm swap
  6. Wait for completion (usually less than 30 seconds)
Congratulations! You’ve completed your first atomic RGB asset swap on Lightning Network.

​
Developer Quickstart

​
Python SDK

pip install kaleido-sdk

Python SDK Documentation

Explore the complete SDK documentation →

​
TypeScript SDK

npm install kaleido-sdk

TypeScript SDK Documentation

Explore the complete SDK documentation →

​
API Quick Reference

curl https://api.signet.kaleidoswap.com/api/v1/pairs

API Reference

View complete API documentation →

​
Available Networks

API URL: https://api.signet.kaleidoswap.com/api/v1WebSocket: wss://api.signet.kaleidoswap.com/ws/{client_id}
  • Bitcoin Signet (MutinyNet) — public testnet with realistic conditions
  • Recommended for integration testing before mainnet
  • Currently live

​
Next Steps

Desktop App Guide

Advanced features: channels, backups, and more

SDK Examples

Real-world code examples for common workflows

API Documentation

Deep dive into REST API endpoints

Join Community

Get help and connect with other users