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.10.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.10-py3-none-any.whl (47.5 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: kaleido_sdk-0.1.10.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.10.tar.gz
Algorithm Hash digest
SHA256 e60d0443e017e7832e2319575fe97968a55a398132fc39693cb685c8587fae36
MD5 a16561a87fff4cf040675817b426ab05
BLAKE2b-256 4c0c8261138cf57ccf37eb5b40e91d49a1f56711cbb3cf7339788728baa7af22

See more details on using hashes here.

File details

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

File metadata

  • Download URL: kaleido_sdk-0.1.10-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.10-py3-none-any.whl
Algorithm Hash digest
SHA256 aedd416fd4b2c493d5e44716bed10f3e29a9a2afd167df09176b7e3d5c3edc68
MD5 05e0a368a3f7fbb7b0845678e11a807b
BLAKE2b-256 5340bf41b302fa3b634a624af05981b9b3374a7c72325593dfe8c30caab4ac7f

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