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

Uploaded Python 3

File details

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

File metadata

  • Download URL: kaleido_sdk-0.1.5.tar.gz
  • Upload date:
  • Size: 119.6 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.5.tar.gz
Algorithm Hash digest
SHA256 6d79d62679ac5975f0042e42ea7a4f3e63589e403848d2adba7faafc79fb68d5
MD5 33c5fe6d0889534e9316227d379c4ef9
BLAKE2b-256 57a187b8bc7435d8cac7c0228bc463ce303062df2146a0b0405764401318572f

See more details on using hashes here.

File details

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

File metadata

  • Download URL: kaleido_sdk-0.1.5-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.5-py3-none-any.whl
Algorithm Hash digest
SHA256 efb003e33ca0c196e643ed5d350467d9eb1fced00f4317c8a845d78112f1fc0d
MD5 99b2a4cf6acb0017b6e46c5af2963ed2
BLAKE2b-256 c95ef50b2e0ca429c3b2fbd31b7cd3463d1110bf5b3b806f48e15d5557c38304

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