Skip to main content

Python SDK for the Kaleidoswap protocol - Trade RGB assets on Lightning Network

Project description

Kaleidoswap Python SDK

pypi package

Python SDK for trading RGB assets on the Lightning Network via the Kaleidoswap protocol.

Installation

pip install kaleido-sdk

Quick Start

The SDK exposes two sub-clients depending on what you need:

Sub-client Config key What it does
client.maker base_url Kaleidoswap market API — assets, quotes, swap orders, LSP
client.rln node_url Your RGB Lightning Node — wallet, channels, payments, RGB assets
from kaleido_sdk import KaleidoClient

# Zero-config — defaults to regtest
client = KaleidoClient.create()
assets = await client.maker.list_assets()

# Maker API only
client = KaleidoClient.create(base_url="https://api.kaleidoswap.com")
assets = await client.maker.list_assets()

# Node only (base_url still defaults to regtest)
client = KaleidoClient.create(node_url="http://localhost:3001")
info = await client.rln.get_node_info()

# Both together
client = KaleidoClient.create(
    base_url="https://api.kaleidoswap.com",
    node_url="http://localhost:3001",
)
pairs    = await client.maker.list_pairs()
channels = await client.rln.list_channels()

Documentation

Full usage guide, API reference, and examples at https://docs.kaleidoswap.com/sdk/introduction

License

MIT

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

kaleido_sdk-0.1.9.tar.gz (120.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

kaleido_sdk-0.1.9-py3-none-any.whl (47.5 kB view details)

Uploaded Python 3

File details

Details for the file kaleido_sdk-0.1.9.tar.gz.

File metadata

  • Download URL: kaleido_sdk-0.1.9.tar.gz
  • Upload date:
  • Size: 120.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.15

File hashes

Hashes for kaleido_sdk-0.1.9.tar.gz
Algorithm Hash digest
SHA256 be70c0c1d5242236d6ebd2e99354c36c918114dc3f2869cf0a85f7acebdffa4a
MD5 406dd1198babf763f4ee0a43e3f16a8b
BLAKE2b-256 0bd244ff021c634402f7056fdea942359cc07811efbd6bd3b31bac3a89089b5c

See more details on using hashes here.

File details

Details for the file kaleido_sdk-0.1.9-py3-none-any.whl.

File metadata

  • Download URL: kaleido_sdk-0.1.9-py3-none-any.whl
  • Upload date:
  • Size: 47.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.15

File hashes

Hashes for kaleido_sdk-0.1.9-py3-none-any.whl
Algorithm Hash digest
SHA256 727cbcb1c0abf979e154b107ee8d15c25bf5296bf5994915f9a8775d0bb6ed15
MD5 9f300908c790fed39b6bd4ec709715cf
BLAKE2b-256 aeba29b0a79a89e89c2246e4d5f5c3eb82a8bf47de11ae514eef15cdb6ba554b

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page