Skip to main content
The Swap SDK lets your wallet or app swap between Bitcoin, Lightning, Liquid, RGB, and Arkade against the KaleidoSwap maker. Your users never hand their funds to anyone: every swap is locked so that either both sides settle, or your user gets their money back.

Quickstart

Make a first swap on signet with quote, start, and resume.

How swaps work

Who pays first, who claims, and what happens if a swap fails.

Trust model

What the SDK verifies, and what the maker controls.

What you can build

Mainnet is not available yet: asking the SDK for it returns an error, never another provider. The maker’s catalogue (submarinePairs(), reversePairs(), chainPairs(), the corridor card) is the source of truth, so read it at runtime. See Networks.

Two ways to use it

Start with the KaleidoSwap API. Use the engine for a route it does not serve yet, or when you want to own each step. Both ship in the same package.

What the SDK does, and what your app does

The SDK holds no funds and runs no background timers: a swap moves only while your app is running and following it. With the swap engine, your app also stores each swap record and each signed transaction, and decides when to claim and refund. Common mistakes lists what goes wrong when it does not.

Packages

One Rust engine, published for four runtimes. All four share one version number.
Running your own RGB Lightning Node and want to control it from code (channels, RGB assets, payments)? That is the Node SDK, documented with the CLI.