Skip to main content

​
Compatibility

SDK v0.5.x is compatible with the latest RLN (RGB Lightning Node) API version. The SDK automatically supports the most recent RLN API release. Always keep your SDK and RGB Lightning Node updated to ensure full compatibility and access to the latest features and security improvements.
To check the latest RLN API changes and updates, refer to the RGB Lightning Node or your node documentation.

​
RLN API Overview

The RLN (RGB Lightning Node) API is provided directly by your configured RGB Lightning Node. It enables wallet operations, Lightning channel management, and node-to-node swap coordination.

​
RLN API Categories

CategoryPurposeExamples
WalletBTC and RGB asset managementBalance queries, transfers, asset operations
ChannelsLightning Network channel operationsOpen, close, monitor, backup channels
InvoicesPayment request managementCreate, list, and monitor invoices
PaymentsPayment executionPay invoices, coordinate swaps, node-to-node transactions
Node InfoNode status and configurationPubkey, sync status, capabilities

​
Accessing RLN Operations

Before using RLN operations, ensure your node is configured: 
import { KaleidoClient } from 'kaleido-sdk';

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

// Check if node is configured
if (client.hasNode()) {
  // Access RLN API through client.rln
  const nodeInfo = await client.rln.getNodeInfo();
  const balance = await client.rln.getBtcBalance();
  const channels = await client.rln.listChannels();
} else {
  console.log('Node not configured - RLN operations unavailable');
}