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.11.tar.gz (121.0 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.11-py3-none-any.whl (47.5 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: kaleido_sdk-0.1.11.tar.gz
  • Upload date:
  • Size: 121.0 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.11.tar.gz
Algorithm Hash digest
SHA256 5da05d62e192b336f32ac8678d4d3da1fed3279295872f1bf962ec51d8a8569a
MD5 c627165759105f2aea2460302013f2fd
BLAKE2b-256 f81770bb48c5834eec6cc51c1cbf18c87cb851410012b56eead7d135de9f84c8

See more details on using hashes here.

File details

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

File metadata

  • Download URL: kaleido_sdk-0.1.11-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.11-py3-none-any.whl
Algorithm Hash digest
SHA256 1090aff1aa628cf1851f9528dac06fb5b1ada4026f98990eee349126576eb1b3
MD5 278358a35bbe8a08d2a7833e7bbad06b
BLAKE2b-256 c902c2f1bb19710096b480e11c3542a59bf0489e2da461bc98bb22bdeba230df

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