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

Uploaded Python 3

File details

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

File metadata

  • Download URL: kaleido_sdk-0.1.7.tar.gz
  • Upload date:
  • Size: 120.5 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.7.tar.gz
Algorithm Hash digest
SHA256 6c4cca2082fe4c3f9fd3e69431347d89711e357655b7e2e3f6b584549987441d
MD5 912199cb97f684a9978fed6ff2b6702a
BLAKE2b-256 0dfbefaf11b0960a11922c294f0e50a8af6d19e492582139cee67ccbd03f8592

See more details on using hashes here.

File details

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

File metadata

  • Download URL: kaleido_sdk-0.1.7-py3-none-any.whl
  • Upload date:
  • Size: 47.2 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.7-py3-none-any.whl
Algorithm Hash digest
SHA256 23843f281ccc81a18498cf48bb5c419857de5e36894a38fd38c14ced3e1f2221
MD5 efc3b3cd3eba4708ce39593f1286af44
BLAKE2b-256 97fa037d5d57158dc258d90c5b8693936a85df9dd8fd1724dd7df859868aed02

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