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.2.tar.gz (119.9 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.2-py3-none-any.whl (47.1 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: kaleido_sdk-0.1.2.tar.gz
  • Upload date:
  • Size: 119.9 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.2.tar.gz
Algorithm Hash digest
SHA256 014e663dad2ab08f0b3d8642d4329f6daaa8f75177376508da2f29bbd2730d04
MD5 a8ba7723a88585b1b4dc42dd832f6141
BLAKE2b-256 c54dd381d4f4c2975876c7170708e261e4e0802fecccbd068b2c16560889aa00

See more details on using hashes here.

File details

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

File metadata

  • Download URL: kaleido_sdk-0.1.2-py3-none-any.whl
  • Upload date:
  • Size: 47.1 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.2-py3-none-any.whl
Algorithm Hash digest
SHA256 a1a1ee9e89e7cfb28d1328b30b676c6605918282155ea34da1aa319c553e25ec
MD5 86fb626ac864cdee94cfd1ed3ce2fe32
BLAKE2b-256 f6fb3610d261c9977ab3fa788f590952e965cb82320407e62706f7a159d707a3

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