Skip to main content

Packages & Source

npm — kaleido-sdk

The published TypeScript package. npm install kaleido-sdk

PyPI — kaleido-sdk

The published Python package. pip install kaleido-sdk

SDK Source

Source, releases, and issue tracking for both language implementations.

OpenAPI Specifications

The specs both SDKs generate their API types from, which is what keeps request and response shapes identical across the two languages.

Protocol References

Swap Protocol

The atomic HTLC flow the SDK drives, endpoint by endpoint, with the sequence diagram.

RGB LSPS1 APIs

The channel-ordering interface behind client.maker LSPS1 calls.

RGB Lightning Node

The node client.rln talks to. This is the KaleidoSwap fork; the upstream project is maintained by RGB Tools.

RGB Protocol Documentation

Client-side validation, asset interfaces, and the specification itself.

Development & Testing

Build against a test network before mainnet. Both environments are live and need no API key. Pass these to baseUrl / base_url as shown — the SDK appends the /api/v1 path itself.

Mutiny Faucet

Get Signet Bitcoin to fund a node and open test channels.

API Getting Started

Base URLs, authentication, request format, and rate limits.

Community & Support

GitHub Issues

Report a bug or request a feature against the SDK.

Telegram

Ask the community and the team.

Email Support

Direct support for urgent issues.

FAQ

Language choice, sub-clients, custody, versioning, and amounts.