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.8.tar.gz (120.8 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.8-py3-none-any.whl (47.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: kaleido_sdk-0.1.8.tar.gz
  • Upload date:
  • Size: 120.8 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.8.tar.gz
Algorithm Hash digest
SHA256 7bd9d7a5ed614f6ce69fa8ff7300513bc394a0d8a5d9e47b200b6c51fd0b750f
MD5 73a34a6ae04a8438a658ef87ce7800b0
BLAKE2b-256 dce5a4f72c56a695a85f8748dc6ec0e201ddb3b1cd52f4a9d410a1536dc14e32

See more details on using hashes here.

File details

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

File metadata

  • Download URL: kaleido_sdk-0.1.8-py3-none-any.whl
  • Upload date:
  • Size: 47.4 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.8-py3-none-any.whl
Algorithm Hash digest
SHA256 47e589f56807bc4584e984664eca04113187a58cd530b942f5be58da1d9aa629
MD5 f248799ffb203674887930222c593639
BLAKE2b-256 1c67e522dbdb7d5e90e4d2a21a63f8da861b7f0b939eb6e1a9fae37c4b9683c6

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