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

# Welcome to KaleidoSwap

> Trade RGB assets on the Lightning Network — desktop, browser, and beyond

<img src="https://mintcdn.com/kaleidoswap/wIraRN-IMPyNpW_s/assets/images/hero-banner.png?fit=max&auto=format&n=wIraRN-IMPyNpW_s&q=85&s=9e3c4296c902fc1780223e2d347999d6" alt="KaleidoSwap — Trade RGB assets on Lightning" width="2752" height="1536" data-path="assets/images/hero-banner.png" />

KaleidoSwap is an open-source platform for trading RGB assets on the Lightning Network. Use the **desktop application** for full node control and atomic swaps.

<Card title="Desktop App" icon="desktop" href="/desktop-app/getting-started/installation">
  Full-featured trading with atomic swaps, node management, and channel control
</Card>

***

## Why KaleidoSwap?

<CardGroup cols={2}>
  <Card title="RGB on Lightning" icon="bolt">
    Trade RGB assets (USDT, XAUT, and more) with instant settlement on the Lightning Network — powered by atomic swaps on the desktop app
  </Card>

  <Card title="Non-Custodial" icon="shield-check">
    Your keys, your coins. No accounts, no intermediaries — just connect your wallet or run your own node
  </Card>

  <Card title="Open Source" icon="code-branch">
    Fully open-source with MIT license. Inspect the code, contribute, or build your own integration
  </Card>

  <Card title="Multi-Platform" icon="layer-group">
    Available for macOS, Windows, and Linux
  </Card>
</CardGroup>

***

## Platform Overview

<img src="https://mintcdn.com/kaleidoswap/wIraRN-IMPyNpW_s/assets/images/platform-overview.png?fit=max&auto=format&n=wIraRN-IMPyNpW_s&q=85&s=f570e5b1924148c94f62b02edcb2393d" alt="KaleidoSwap Platform — Desktop, Web, Extension" width="2752" height="1536" data-path="assets/images/platform-overview.png" />

|                | Desktop App                                           |
| -------------- | ----------------------------------------------------- |
| **Swap Model** | Atomic swaps                                          |
| **Node**       | Self-hosted or remote                                 |
| **Wallet**     | Built-in                                              |
| **Best For**   | Power users, node operators                           |
| **Install**    | [Download](/desktop-app/getting-started/installation) |

***

## How It Works

<img src="https://mintcdn.com/kaleidoswap/wIraRN-IMPyNpW_s/assets/images/how-it-works.png?fit=max&auto=format&n=wIraRN-IMPyNpW_s&q=85&s=00b8faa2d9114c158049569dca0067c7" alt="KaleidoSwap — RGB assets on Lightning Network" width="2752" height="1536" data-path="assets/images/how-it-works.png" />

KaleidoSwap combines three technologies to enable fast, private, and scalable asset trading:

<AccordionGroup>
  <Accordion title="RGB Protocol" icon="layer-group">
    Client-validated smart contracts on Bitcoin. Assets use client-side validation to keep data off-chain while anchoring to Bitcoin for security — no blockchain bloat, full privacy.
  </Accordion>

  <Accordion title="Lightning Network" icon="bolt">
    Second-layer payment channels for instant, low-cost transactions. Swaps settle in milliseconds with fees measured in satoshis.
  </Accordion>

  <Accordion title="Lightning Service Providers" icon="server">
    LSPs provide channel liquidity and routing. Connect to an LSP and start trading without managing infrastructure.
  </Accordion>
</AccordionGroup>

***

## Getting Started

<Steps>
  <Step title="Install the app">
    Download for macOS, Windows, or Linux.
    [Installation Guide →](/desktop-app/getting-started/installation)
  </Step>

  <Step title="Create a wallet">
    Generate a new wallet and save your recovery phrase.
    [Wallet Setup →](/desktop-app/wallet/creating-wallet)
  </Step>

  <Step title="Deposit & open channels">
    Fund your wallet and open Lightning channels.
    [Deposit Guide →](/desktop-app/wallet/deposits) · [Channel Guide →](/desktop-app/channels/opening-channel)
  </Step>

  <Step title="Start trading">
    Execute atomic swaps with RGB assets.
    [Trading Guide →](/desktop-app/trading/asset-swaps)
  </Step>
</Steps>

***

## Documentation

<CardGroup cols={3}>
  <Card title="Learn" icon="book-open" href="/whats-kaleidoswap/architecture">
    Architecture, key concepts, and how everything fits together
  </Card>

  <Card title="SDK" icon="code" href="/sdk/introduction">
    TypeScript and Python SDKs for building on KaleidoSwap
  </Card>

  <Card title="API Reference" icon="brackets-curly" href="/api-reference/introduction">
    REST API docs with interactive playground
  </Card>

  <Card title="Desktop Guide" icon="desktop" href="/desktop-app/getting-started/introduction">
    Full desktop app docs: nodes, wallets, channels, and trading
  </Card>
</CardGroup>

***

## For Developers

Build on KaleidoSwap with our SDKs and APIs:

<CodeGroup>
  ```typescript TypeScript theme={null}
  import { KaleidoClient } from 'kaleido-sdk';

  const client = KaleidoClient.create({
    baseUrl: 'https://api.signet.kaleidoswap.com'
  });

  // Get available trading pairs
  const pairs = await client.maker.listPairs();

  // Get a quote
  const quote = await client.maker.getQuote({
    from_asset: { asset_id: 'BTC', layer: 'BTC_LN', amount: 100000 },
    to_asset: { asset_id: 'USDT', layer: 'RGB_LN' }
  });
  ```

  ```python Python theme={null}
  from kaleido_sdk import KaleidoClient

  client = KaleidoClient.create(
      base_url="https://api.signet.kaleidoswap.com"
  )

  # Get available trading pairs
  pairs = client.maker.list_pairs()

  # Get a quote
  quote = client.maker.get_quote({
      "from_asset": {"asset_id": "BTC", "layer": "BTC_LN", "amount": 100000},
      "to_asset": {"asset_id": "USDT", "layer": "RGB_LN"}
  })
  ```
</CodeGroup>

<CardGroup cols={2}>
  <Card title="SDK Docs" icon="code" href="/sdk/introduction">
    Full SDK reference, examples, and best practices
  </Card>

  <Card title="API Reference" icon="brackets-curly" href="/api-reference/introduction">
    REST endpoints and swap protocol details
  </Card>
</CardGroup>

***

## Community & Support

<CardGroup cols={3}>
  <Card title="Telegram" icon="telegram" href="https://t.me/kaleidoswap">
    Join our community chat
  </Card>

  <Card title="Twitter/X" icon="x-twitter" href="https://x.com/kaleidoswap">
    Follow us for updates
  </Card>

  <Card title="GitHub" icon="github" href="https://github.com/kaleidoswap">
    Contribute to the project
  </Card>
</CardGroup>

KaleidoSwap is open-source software licensed under the [MIT License](https://github.com/kaleidoswap/desktop-app/blob/main/LICENSE).