> ## 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.

# Changelog

> SDK and API version history for KaleidoSwap

<Note>
  This changelog covers the KaleidoSwap SDK (`kaleido-sdk`) and the Maker API (`/api/v1`). For desktop app releases, see the [GitHub releases page](https://github.com/kaleidoswap/desktop-app/releases).
</Note>

## SDK v0.1.9 — Current

**Environments:** Regtest (`api.regtest.kaleidoswap.com`), Signet (`api.signet.kaleidoswap.com`)

**Compatible APIs:** Latest Maker API · RLN (RGB Lightning Node) API **v0.7.1**

### Added

* **NWC (Nostr Wallet Connect, NIP-47) client** — new `kaleido-sdk/nwc` subpath. `NWCClient` exposes `rln_*` RLN extension methods and an `RlnTransport` seam that runs the RLN client over an NWC connection (NIP-44 encryption, NIP-04 fallback). LN-invoice decode, send-BTC and list-payments are mapped over the NWC transport.
* RLN client methods + models for `POST /sendrgb`, `POST /inflate`, `POST /issueassetifa`, and Inflatable Fungible Asset (IFA) types.

### Changed

* Regenerated the RLN models against `kaleidoswap/rgb-lightning-node` **v0.7.1**.

### Breaking changes

* `ListUnspentsRequest` now requires `settled_only`. RLN 0.7.1 rejects the old `{skip_sync}`-only body with `HTTP 400 "Failed to deserialize the JSON body into the target type"`. The `list_unspents()` convenience method defaults `settled_only=False`; callers that build the request directly must set it.
* `POST /sendasset` was renamed to `POST /sendrgb` (`SendAssetRequest`/`SendAssetResponse` → `SendRgbRequest`/`SendRgbResponse`).

<Note>
  Versions 0.1.6–0.1.8 are omitted here; see the full [CHANGELOG](https://github.com/kaleidoswap/kaleido-sdk/blob/master/CHANGELOG.md) in the SDK repository.
</Note>

## SDK v0.1.5

**Environments:** Regtest (`api.regtest.kaleidoswap.com`), Signet (`api.signet.kaleidoswap.com`)

**Compatible APIs:** Latest Maker API and Latest RLN API

### What's included

#### Maker API Client (`client.maker`)

Market data, quotes, swap orders, atomic swap protocol, LSPS1 channel ordering, and WebSocket streaming:

* Market operations: asset and pair listing with caching
* Quote endpoints: single and bulk quote requests with real-time streaming
* Swap order management: create, list, and monitor order-based swaps
* Atomic swap protocol: HTLC-based swaps for desktop and direct node interactions
* LSPS1 channel ordering: liquidity and channel provisioning
* WebSocket streaming: `streamQuotesByTicker` / `streamQuotesForAllRoutes` with automatic route discovery and reconnection

#### RLN API Client (`client.rln`)

Full RGB Lightning Node operations for wallet management, Lightning channels, and asset operations:

* Wallet management: BTC and RGB asset operations with balance tracking
* Channel management: open, monitor, and close Lightning channels
* Invoice operations: create, list, and monitor Lightning invoices
* Payment execution: pay invoices and coordinate node-to-node swaps
* Node info and health: retrieve node configuration and pubkey information

#### SDK Features

* `KaleidoClient.create()` — synchronous factory for both TypeScript and Python
* `waitForSwapCompletion` — built-in polling helper with configurable timeout and status callback
* `PrecisionHandler` and `AssetPairMapper` utilities for amount conversion and pair lookups
* Full error hierarchy: `KaleidoError`, `NetworkError`, `ValidationError`, `APIError`, `QuoteExpiredError`, `NodeNotConfiguredError`
* Auto-generated types from OpenAPI specs (TypeScript: `openapi-fetch`; Python: Pydantic models)

***

## API v1 — Current

**Status:** Stable. No breaking changes planned for v1.

### Maker API endpoints

| Endpoint group | Base path              | Description                                           |
| -------------- | ---------------------- | ----------------------------------------------------- |
| Market         | `/api/v1/market/`      | Assets, pairs, quotes, fee estimates                  |
| Swaps (atomic) | `/api/v1/swaps/`       | HTLC swap init, execute, status — used by desktop app |
| Swap orders    | `/api/v1/swap-orders/` | Order-based swaps — used by web app                   |
| LSPS1          | `/api/v1/lsps1/`       | Channel ordering and liquidity                        |

### RLN API endpoints

Provided by the RGB Lightning Node directly at `nodeUrl`. Includes wallet, BTC, RGB assets, channels, invoices, payments, and swap coordination.

***

## Live Environments

| Environment | API URL                               | WebSocket URL                               | Status      |
| ----------- | ------------------------------------- | ------------------------------------------- | ----------- |
| **Regtest** | `https://api.regtest.kaleidoswap.com` | `wss://api.regtest.kaleidoswap.com/ws/{id}` | Live        |
| **Signet**  | `https://api.signet.kaleidoswap.com`  | `wss://api.signet.kaleidoswap.com/ws/{id}`  | Live        |
| **Mainnet** | `https://api.kaleidoswap.com`         | `wss://api.kaleidoswap.com/ws/{id}`         | Coming soon |

***

## Roadmap

* **Atomic order-based swaps** — order-based swaps (currently used by the web app) will be upgraded to use the same HTLC atomic model as the desktop app, removing the trust requirement for web users.
* **Mainnet launch** — production environment for real BTC and RGB assets.
* **Additional Layer support** — Spark, Arkade, and Liquid protocol adapters in the KaleidoSwap Extension.