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.6.tar.gz (120.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.6-py3-none-any.whl (46.9 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: kaleido_sdk-0.1.6.tar.gz
  • Upload date:
  • Size: 120.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.6.tar.gz
Algorithm Hash digest
SHA256 c8ea2ee3d002c638dcc76ebd086817c260443787bbeb0b34e449c557732e2ca6
MD5 45238a110b55e3ce8a08e2d5273294f6
BLAKE2b-256 6f9a16ca4abcbcb2488f490dca2d0da6f0c7120b32f3c7b409d8979af54bf311

See more details on using hashes here.

File details

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

File metadata

  • Download URL: kaleido_sdk-0.1.6-py3-none-any.whl
  • Upload date:
  • Size: 46.9 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.6-py3-none-any.whl
Algorithm Hash digest
SHA256 d451ee0b5abf4b31008b3d7bf73082b582f36415b6b53a90df4a0fe215f43ca9
MD5 5f8872854e986349638b27d77ddcf04c
BLAKE2b-256 872e309e8e0c6fd1d4a88c9f16c98985e451a78ccccd8a8724e2ecdbb69ce7ea

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