API Reference

import { KaleidoClient } from 'kaleidoswap-sdk';

const client = KaleidoClient.create({
  baseUrl: 'https://api.regtest.kaleidoswap.com',
  nodeUrl: 'http://localhost:3001',  // optional
  apiKey: 'your-api-key',           // optional
  timeout: 30,                       // optional, seconds
  maxRetries: 3,                     // optional
  cacheTtl: 60,                      // optional, seconds
});

client.hasNode();  // boolean -- check if nodeUrl is configured
client.maker;      // MakerClient instance
client.rln;        // RlnClient instance

const response = await client.maker.listAssets();
// Returns: MarketListAssetsResponse

const response = await client.maker.listPairs();
// Returns: ListPairsResponse

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

const routes = await client.maker.getPairRoutes({ /* GetPairRoutesRequest */ });
// Returns: GetPairRoutesResponse

const routes = await client.maker.getMarketRoutes({ /* DiscoverRoutesRequest */ });
// Returns: DiscoverRoutesResponse

const order = await client.maker.createSwapOrder({
  rfq_id: quote.rfq_id,
  from_asset: { asset_id: 'BTC', layer: 'BTC_LN', amount: 100000 },
  to_asset: { asset_id: 'USDT', layer: 'RGB_LN', amount: 9500 },
  receiver_address: 'lnbc1...',
  min_onchain_conf: 1
});
// Returns: CreateSwapOrderResponse (order_id, deposit_address, status)

const status = await client.maker.getSwapOrderStatus({ order_id: 'order-123' });
// Returns: GetSwapOrderStatusResponse

const history = await client.maker.getOrderHistory({
  status: 'FILLED',
  limit: 10,
  skip: 0
});
// Returns: GetOrderHistoryResponse

const stats = await client.maker.getOrderAnalytics();
// Returns: GetOrderStatsResponse

const result = await client.maker.submitRateDecision({
  order_id: 'order-123',
  accept_new_rate: true
});
// Returns: SwapOrderRateDecisionResponse

const completed = await client.maker.waitForSwapCompletion('order-123', {
  timeout: 300,        // seconds
  pollInterval: 10,    // seconds
  onStatusUpdate: (status) => console.log(`Status: ${status}`)
});
// Returns: SwapOrder

const result = await client.maker.initSwap({ /* InitiateSwapRequest */ });

const result = await client.maker.executeSwap({ /* ConfirmSwapRequest */ });

const status = await client.maker.getAtomicSwapStatus({ /* GetSwapStatusRequest */ });

const info = await client.maker.getSwapNodeInfo();

const info = await client.maker.getLspInfo();

const networkInfo = await client.maker.getLspNetworkInfo();

const order = await client.maker.createLspOrder({ /* CreateLspOrderRequest */ });

const order = await client.maker.getLspOrder({ order_id: 'lsp-order-123' });

const fees = await client.maker.estimateLspFees({ /* CreateLspOrderRequest */ });

const result = await client.maker.submitLspRateDecision({ /* LspRateDecisionRequest */ });

const result = await client.maker.retryAssetDelivery({ /* RetryDeliveryRequest */ });

const ws = client.maker.enableWebSocket('wss://api.kaleidoswap.com/ws/my-client-id');
// Returns: WSClient

const unsubscribe = await client.maker.streamQuotes(
  'BTC',           // from_asset
  'USDT',          // to_asset
  100000,          // from_amount
  'BTC_LN',        // from_layer
  'RGB_LN',        // to_layer
  (quote) => {
    console.log(`Price: ${quote.price}`);
  }
);
// Call unsubscribe() to stop streaming

const unsubscribe = await client.maker.streamQuotesByTicker(
  'BTC',           // fromTicker
  'USDT',          // toTicker
  100000,          // amount
  (quote) => console.log(`Quote: ${quote.price}`),
  { preferredFromLayer: 'BTC_LN', preferredToLayer: 'RGB_LN' }
);

const unsubscribers = await client.maker.streamQuotesForAllRoutes(
  'BTC', 'USDT', 100000,
  (route, quote) => console.log(`${route}: ${quote.price}`)
);
// Returns: Map<string, () => void>

const routes = await client.maker.getAvailableRoutes('BTC', 'USDT');
// Returns: Array<{ from_layer: string; to_layer: string }>

const raw = client.maker.toRaw(0.001, 8);  // 100000

const display = client.maker.toDisplay(100000, 8);  // 0.001