Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 1 addition & 6 deletions mintlify-docs/api-reference/getting-started.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "Bitcoin Swap API: Getting Started"
sidebarTitle: "Getting Started"
description: "Start using the KaleidoSwap swap API, with base URLs for regtest, signet, and mainnet plus authentication, request format, and rate limits"
description: "Start using the KaleidoSwap swap API, with base URLs for signet and mainnet plus authentication, request format, and rate limits"
---

Welcome to the KaleidoSwap API! This guide will help you set up and start using the API quickly and effectively.
Expand All @@ -12,11 +12,6 @@ Welcome to the KaleidoSwap API! This guide will help you set up and start using

The KaleidoSwap API is accessible via HTTPS for secure communication. Here are the available environments:

### Regtest
A local-style regtest network with instant block generation, ideal for rapid development and unit testing. This environment is **currently live**. All API requests in this environment should be directed to the following base URL:

- **Base URL:** `https://api.regtest.kaleidoswap.com/api/v1`

### Signet (MutinyNet)
A public testnet with realistic network conditions, recommended for integration testing before mainnet. This environment is **currently live**. All API requests in this environment should be directed to the following base URL:

Expand Down
2 changes: 1 addition & 1 deletion mintlify-docs/api-reference/market-apis.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ The Market APIs are the starting point for any swap integration. They give you t

All Market API endpoints are public and require no authentication.

**Base URL:** `https://api.signet.kaleidoswap.com/api/v1` (Signet) or `https://api.regtest.kaleidoswap.com/api/v1` (Regtest)
**Base URL:** `https://api.signet.kaleidoswap.com/api/v1` (Signet)

---

Expand Down
2 changes: 1 addition & 1 deletion mintlify-docs/api-reference/rgb-lsps1-apis.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ The RGB LSPS1 APIs let clients order Lightning channels with RGB asset allocatio

These endpoints are used by the KaleidoSwap Desktop App when you open a channel through the default LSP. SDK users can call them directly via `client.maker.createLspOrder()`.

**Base URL:** `https://api.signet.kaleidoswap.com/api/v1` (Signet) or `https://api.regtest.kaleidoswap.com/api/v1` (Regtest)
**Base URL:** `https://api.signet.kaleidoswap.com/api/v1` (Signet)

---

Expand Down
3 changes: 1 addition & 2 deletions mintlify-docs/api-reference/swap-apis.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ To use these endpoints you need:

See the [Market APIs](/api-reference/market-apis) for quotes and asset data, and the [Swap Protocol](/api-reference/swap-protocol) for a full walkthrough of the atomic swap flow.

**Base URL:** `https://api.signet.kaleidoswap.com/api/v1` (Signet) or `https://api.regtest.kaleidoswap.com/api/v1` (Regtest)
**Base URL:** `https://api.signet.kaleidoswap.com/api/v1` (Signet)

---

Expand Down Expand Up @@ -45,7 +45,6 @@ Retrieve the public identity of the maker's RGB Lightning Node — its pubkey, t

| Environment | URL |
|-------------|-----|
| **Regtest** | `wss://api.regtest.kaleidoswap.com/api/v1/market/ws/{client_id}` |
| **Signet** | `wss://api.signet.kaleidoswap.com/api/v1/market/ws/{client_id}` |
| **Mainnet** | `wss://api.kaleidoswap.com/api/v1/market/ws/{client_id}` *(coming soon)* |

Expand Down
1 change: 0 additions & 1 deletion mintlify-docs/api-reference/swap-protocol.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,6 @@ Taker Client Maker (RGB-LSP) Taker RLN

| Environment | URL |
|-------------|-----|
| **Regtest** | `wss://api.regtest.kaleidoswap.com/api/v1/market/ws/{client_id}` |
| **Signet** | `wss://api.signet.kaleidoswap.com/api/v1/market/ws/{client_id}` |
| **Mainnet** | `wss://api.kaleidoswap.com/api/v1/market/ws/{client_id}` *(coming soon)* |

Expand Down
1 change: 0 additions & 1 deletion mintlify-docs/sdk/additional-resources.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,6 @@ Pass these to `baseUrl` / `base_url` as shown — the SDK appends the `/api/v1`

| Environment | Base URL | Best for |
|-------------|----------|----------|
| **Regtest** | `https://api.regtest.kaleidoswap.com` | Unit tests and rapid iteration, instant blocks |
| **Signet (MutinyNet)** | `https://api.signet.kaleidoswap.com` | Integration testing under realistic conditions |

<CardGroup cols={2}>
Expand Down
4 changes: 2 additions & 2 deletions mintlify-docs/sdk/api-reference.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ description: "Full reference for KaleidoClient, MakerClient, and RlnClient, cove
import { KaleidoClient, LogLevel } from 'kaleido-sdk';

const client = KaleidoClient.create({
baseUrl: 'https://api.regtest.kaleidoswap.com',
baseUrl: 'https://api.signet.kaleidoswap.com',
nodeUrl: 'http://localhost:3001',
apiKey: process.env.KALEIDO_API_KEY,
timeout: 30,
Expand All @@ -29,7 +29,7 @@ import logging
from kaleido_sdk import KaleidoClient

client = KaleidoClient.create(
base_url="https://api.regtest.kaleidoswap.com",
base_url="https://api.signet.kaleidoswap.com",
node_url="http://localhost:3001",
api_key=None,
timeout=30.0,
Expand Down
12 changes: 0 additions & 12 deletions mintlify-docs/sdk/changelog.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,6 @@ description: "KaleidoSDK version history, listing new features, breaking changes

## SDK v0.1.17 (Current)

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

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

### Fixed
Expand All @@ -28,8 +26,6 @@ description: "KaleidoSDK version history, listing new features, breaking changes

## SDK v0.1.15

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

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

### Fixed
Expand Down Expand Up @@ -75,8 +71,6 @@ If your RGB Lightning Node still runs **v0.7.1**, stay on SDK **0.1.13** — the

## SDK v0.1.11

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

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

### Fixed
Expand All @@ -85,8 +79,6 @@ If your RGB Lightning Node still runs **v0.7.1**, stay on SDK **0.1.13** — the

## SDK v0.1.10

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

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

### Fixed
Expand All @@ -95,8 +87,6 @@ If your RGB Lightning Node still runs **v0.7.1**, stay on SDK **0.1.13** — the

## SDK v0.1.9

**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
Expand All @@ -119,8 +109,6 @@ If your RGB Lightning Node still runs **v0.7.1**, stay on SDK **0.1.13** — the

## SDK v0.1.5

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

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

<Note>
Expand Down
4 changes: 2 additions & 2 deletions mintlify-docs/sdk/examples.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ description: "Working KaleidoSDK code examples in TypeScript and Python, coverin
import { KaleidoClient } from 'kaleido-sdk';

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

const [assets, pairs] = await Promise.all([
Expand All @@ -31,7 +31,7 @@ for (const pair of pairs.pairs.slice(0, 5)) {
from kaleido_sdk import KaleidoClient

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

assets = await client.maker.list_assets()
Expand Down
5 changes: 2 additions & 3 deletions mintlify-docs/sdk/faq.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -35,12 +35,11 @@ description: "Common questions about the KaleidoSDK, covering language choice, t
</Accordion>

<Accordion title="Which networks can I build against?" icon="network-wired">
Regtest and Signet (MutinyNet) are live today; mainnet is coming soon.
Signet (MutinyNet) is live today; mainnet is coming soon.

- **Regtest** — `https://api.regtest.kaleidoswap.com`, instant blocks, best for unit tests
- **Signet** — `https://api.signet.kaleidoswap.com`, realistic conditions, best before mainnet

Pass these as `baseUrl` / `base_url`; the SDK appends `/api/v1` itself. Full list in [Available Environments](/sdk/getting-started#available-environments).
Pass this as `baseUrl` / `base_url`; the SDK appends `/api/v1` itself. Full list in [Available Environments](/sdk/getting-started#available-environments).
</Accordion>

<Accordion title="How do I know which SDK version works with which API?" icon="check-double">
Expand Down
22 changes: 10 additions & 12 deletions mintlify-docs/sdk/getting-started.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ pip install kaleido-sdk
import { KaleidoClient } from 'kaleido-sdk';

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

const assets = await client.maker.listAssets();
Expand All @@ -64,7 +64,7 @@ console.log(`Found ${assets.assets.length} assets`);
from kaleido_sdk import KaleidoClient

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

assets = await client.maker.list_assets()
Expand All @@ -86,7 +86,7 @@ print(f"Found {len(assets.assets)} assets")
import { KaleidoClient, LogLevel } from 'kaleido-sdk';

const client = KaleidoClient.create({
baseUrl: 'https://api.regtest.kaleidoswap.com',
baseUrl: 'https://api.signet.kaleidoswap.com',
nodeUrl: 'http://localhost:3001',
apiKey: process.env.KALEIDO_API_KEY,
timeout: 30,
Expand All @@ -96,7 +96,7 @@ const client = KaleidoClient.create({

Supported config fields:

- `baseUrl?`: Maker API base URL. Defaults to `https://api.regtest.kaleidoswap.com`
- `baseUrl?`: Maker API base URL. Defaults to `https://api.signet.kaleidoswap.com`
- `nodeUrl?`: RGB Lightning Node URL
- `apiKey?`: optional API key
- `nodeApiKey?`: optional bearer token for authenticated RLN node requests
Expand All @@ -113,7 +113,7 @@ import logging
from kaleido_sdk import KaleidoClient

client = KaleidoClient.create(
base_url="https://api.regtest.kaleidoswap.com",
base_url="https://api.signet.kaleidoswap.com",
node_url="http://localhost:3001",
api_key=None,
timeout=30.0,
Expand Down Expand Up @@ -144,7 +144,7 @@ The SDK does not auto-load environment variables, but these names are used by th
import { KaleidoClient } from 'kaleido-sdk';

const client = KaleidoClient.create({
baseUrl: process.env.KALEIDO_API_URL || 'https://api.regtest.kaleidoswap.com',
baseUrl: process.env.KALEIDO_API_URL || 'https://api.signet.kaleidoswap.com',
nodeUrl: process.env.KALEIDO_NODE_URL,
apiKey: process.env.KALEIDO_API_KEY,
});
Expand All @@ -155,7 +155,7 @@ import os
from kaleido_sdk import KaleidoClient

client = KaleidoClient.create(
base_url=os.environ.get("KALEIDO_API_URL", "https://api.regtest.kaleidoswap.com"),
base_url=os.environ.get("KALEIDO_API_URL", "https://api.signet.kaleidoswap.com"),
node_url=os.environ.get("KALEIDO_NODE_URL"),
api_key=os.environ.get("KALEIDO_API_KEY"),
)
Expand All @@ -168,17 +168,15 @@ Pass the API URL as `baseUrl` / `base_url`; the SDK appends the `/api/v1` path i

| Environment | API URL | WebSocket URL | Status |
|-------------|---------|---------------|--------|
| **Regtest** | `https://api.regtest.kaleidoswap.com` | `wss://api.regtest.kaleidoswap.com/ws/{id}` | Live (default) |
| **Signet** | `https://api.signet.kaleidoswap.com` | `wss://api.signet.kaleidoswap.com/ws/{id}` | Live |
| **Staging** | `https://api.staging.kaleidoswap.com` | `wss://api.staging.kaleidoswap.com/ws/{id}` | Signet-backed pre-release |
| **Signet** | `https://api.signet.kaleidoswap.com` | `wss://api.signet.kaleidoswap.com/ws/{id}` | Live (default) |
| **Mainnet** | `https://api.kaleidoswap.com` | `wss://api.kaleidoswap.com/ws/{id}` | Coming soon |

## Sub-Client Architecture

<CodeGroup>
```typescript TypeScript
const client = KaleidoClient.create({
baseUrl: 'https://api.regtest.kaleidoswap.com',
baseUrl: 'https://api.signet.kaleidoswap.com',
nodeUrl: 'http://localhost:3001',
});

Expand All @@ -192,7 +190,7 @@ if (client.hasNode()) {

```python Python
client = KaleidoClient.create(
base_url="https://api.regtest.kaleidoswap.com",
base_url="https://api.signet.kaleidoswap.com",
node_url="http://localhost:3001",
)

Expand Down
4 changes: 2 additions & 2 deletions mintlify-docs/sdk/maker-api-compatibility.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ To use Maker API features with the SDK:
import { KaleidoClient, Layer } from 'kaleido-sdk';

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

// Access Maker API through client.maker
Expand All @@ -52,7 +52,7 @@ from kaleido_sdk import KaleidoClient, Layer, PairQuoteRequest, SwapLegInput

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

# Access Maker API through client.maker
Expand Down
10 changes: 5 additions & 5 deletions mintlify-docs/sdk/troubleshooting.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ description: "Diagnose common KaleidoSDK issues such as connection failures, ver
**Solutions:**
1. Verify the `baseUrl` is correct and accessible
2. Check internet connectivity
3. Try accessing the API URL in a browser: `https://api.regtest.kaleidoswap.com/api/v1/market/assets`
3. Try accessing the API URL in a browser: `https://api.signet.kaleidoswap.com/api/v1/market/assets`
4. If behind a firewall, ensure outbound HTTPS is allowed
</Accordion>

Expand All @@ -65,14 +65,14 @@ description: "Diagnose common KaleidoSDK issues such as connection failures, ver
<CodeGroup>
```typescript TypeScript
const client = KaleidoClient.create({
baseUrl: 'https://api.regtest.kaleidoswap.com',
baseUrl: 'https://api.signet.kaleidoswap.com',
nodeUrl: 'http://localhost:3001', // Add this
});
```

```python Python
client = KaleidoClient.create(
base_url="https://api.regtest.kaleidoswap.com",
base_url="https://api.signet.kaleidoswap.com",
node_url="http://localhost:3001", # Add this
)
```
Expand Down Expand Up @@ -320,7 +320,7 @@ logging.getLogger("websockets").setLevel(logging.DEBUG)
<CodeGroup>
```typescript TypeScript
const client = KaleidoClient.create({
baseUrl: 'https://api.regtest.kaleidoswap.com',
baseUrl: 'https://api.signet.kaleidoswap.com',
nodeUrl: 'http://localhost:3001',
});

Expand All @@ -346,7 +346,7 @@ if (client.hasNode()) {

```python Python
client = KaleidoClient.create(
base_url="https://api.regtest.kaleidoswap.com",
base_url="https://api.signet.kaleidoswap.com",
node_url="http://localhost:3001",
)

Expand Down
4 changes: 2 additions & 2 deletions mintlify-docs/sdk/types.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ The SDK ships generated API models plus a thin handwritten client layer.
import type { KaleidoConfig } from 'kaleido-sdk';

const config: KaleidoConfig = {
baseUrl: 'https://api.regtest.kaleidoswap.com',
baseUrl: 'https://api.signet.kaleidoswap.com',
nodeUrl: 'http://localhost:3001',
apiKey: process.env.KALEIDO_API_KEY,
timeout: 30,
Expand Down Expand Up @@ -47,7 +47,7 @@ import logging
from kaleido_sdk import KaleidoClient

client = KaleidoClient.create(
base_url="https://api.regtest.kaleidoswap.com",
base_url="https://api.signet.kaleidoswap.com",
node_url="http://localhost:3001",
api_key=None,
timeout=30.0,
Expand Down
2 changes: 1 addition & 1 deletion mintlify-docs/sdk/websocket.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ ws = client.maker.enable_websocket("wss://api.signet.kaleidoswap.com/ws/my-clien
The URL includes a client ID for session tracking. The `enableWebSocket` method returns a `WSClient` instance.

<Note>
The examples on this page use Signet. Match the WebSocket URL to the environment your `baseUrl` points at — Regtest is the SDK default, at `wss://api.regtest.kaleidoswap.com/ws/{id}`. See [Available Environments](/sdk/getting-started#available-environments).
The examples on this page use Signet, which is also the SDK default. Match the WebSocket URL to the environment your `baseUrl` points at. See [Available Environments](/sdk/getting-started#available-environments).
</Note>

## High-Level API
Expand Down
2 changes: 1 addition & 1 deletion mintlify-docs/whats-kaleidoswap/introduction.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -109,7 +109,7 @@ Build on KaleidoSwap with our SDKs, APIs, and AI Tools:
</Step>

<Step title="Create a client">
Point `KaleidoClient.create()` at a regtest or signet endpoint — mainnet is coming soon.
Point `KaleidoClient.create()` at the signet endpoint — mainnet is coming soon.
[Client Reference →](/sdk/api-reference)
</Step>

Expand Down
10 changes: 0 additions & 10 deletions mintlify-docs/whats-kaleidoswap/quickstart.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -265,16 +265,6 @@ curl -X POST https://api.signet.kaleidoswap.com/api/v1/market/quote \
- **Currently live**
</Tab>

<Tab title="Regtest">
**API URL**: `https://api.regtest.kaleidoswap.com/api/v1`

**WebSocket**: `wss://api.regtest.kaleidoswap.com/api/v1/market/ws/{client_id}`

- Local regtest network — instant block generation, full control
- Best for rapid development and unit testing
- **Currently live**
</Tab>

<Tab title="Mainnet">
**API URL**: `https://api.kaleidoswap.com/api/v1`

Expand Down
1 change: 0 additions & 1 deletion mintlify-docs/whats-kaleidoswap/troubleshooting.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -409,7 +409,6 @@ The cases below are specific to how the closed beta is installed and how its acc

3. **Incorrect endpoint**: Verify you're using the correct API base URL
- Signet (live): `https://api.signet.kaleidoswap.com/api/v1`
- Regtest (live): `https://api.regtest.kaleidoswap.com/api/v1`
- Mainnet: `https://api.kaleidoswap.com/api/v1` *(coming soon)*
</Accordion>

Expand Down
Loading