KaleidoSDK: Getting Started - KaleidoSwap Documentation

This is the path from an installed package to a first quote. If you have not installed the SDK yet, start with Installation.

Basic Setup

import { KaleidoClient } from 'kaleido-sdk';

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

const assets = await client.maker.listAssets();
console.log(`Found ${assets.assets.length} assets`);

from kaleido_sdk import KaleidoClient

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

assets = await client.maker.list_assets()
print(f"Found {len(assets.assets)} assets")

KaleidoClient.create() is synchronous in both SDKs. Do not await client creation.

Every field you can pass to create() is listed in Configuration.

Sub-Client Architecture

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

const pairs = await client.maker.listPairs();

if (client.hasNode()) {
  const nodeInfo = await client.rln.getNodeInfo();
  const channels = await client.rln.listChannels();
}

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

pairs = await client.maker.list_pairs()

if client.has_node():
    node_info = await client.rln.get_node_info()
    channels = await client.rln.list_channels()

Node Configuration Checks

TypeScript exposes client.hasNode() and always returns an rln client instance. Python exposes client.has_node(), and client.rln raises NodeNotConfiguredError if node_url is missing.

if (!client.hasNode()) {
  console.log('Node URL not configured; only maker operations are available');
} else {
  const nodeInfo = await client.rln.getNodeInfo();
  console.log(nodeInfo.pubkey);
}

if not client.has_node():
    print("Node URL not configured; only maker operations are available")
else:
    node_info = await client.rln.get_node_info()
    print(node_info.pubkey)

First Quote

import { KaleidoClient, Layer } from 'kaleido-sdk';

const client = KaleidoClient.create();

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

console.log(quote.rfq_id);
console.log(quote.price);

from kaleido_sdk import KaleidoClient, Layer, PairQuoteRequest, SwapLegInput

client = KaleidoClient.create()

quote = await client.maker.get_quote(
    PairQuoteRequest(
        from_asset=SwapLegInput(asset_id="BTC", layer=Layer.BTC_LN, amount=100000),
        to_asset=SwapLegInput(asset_id="USDT", layer=Layer.RGB_LN),
    )
)

print(quote.rfq_id)
print(quote.price)

Once a quote looks right, How to Swap walks the atomic swap flow end to end.