RLN API - KaleidoSwap Documentation

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.

Compatibility

SDK v is generated against RGB Lightning Node API v (the kaleidoswap/rgb-lightning-node fork). 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. See the changelog for version history.

To check the latest RLN API changes and updates, refer to the RGB Lightning Node or your node documentation.

Categories

Category	Purpose	Examples
Wallet	BTC and RGB asset management	Balance queries, transfers, asset operations
Channels	Lightning Network channel operations	Open, close, monitor, backup channels
Invoices	Payment request management	Create, list, and monitor invoices
Payments	Payment execution	Pay invoices, coordinate swaps, node-to-node transactions
Node Info	Node status and configuration	Pubkey, sync status, capabilities

These are reached through client.rln, which requires a nodeUrl / node_url on the client: without one, TypeScript throws ConfigError and Python raises NodeNotConfiguredError. See Getting Started for the setup and the node checks, and the Client Reference for every method.