Skip to main content

Python SDK for the Kaleidoswap protocol - Trade RGB assets on Lightning Network

This project has been archived.

The maintainers of this project have marked this project as archived. No new releases are expected.

Project description

Kaleidoswap Python SDK

Python SDK for trading RGB assets on the Lightning Network via the Kaleidoswap protocol.

Installation

pip install kaleidoswap-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

kaleidoswap_sdk-0.5.5.tar.gz (117.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

kaleidoswap_sdk-0.5.5-py3-none-any.whl (46.2 kB view details)

Uploaded Python 3

File details

Details for the file kaleidoswap_sdk-0.5.5.tar.gz.

File metadata

  • Download URL: kaleidoswap_sdk-0.5.5.tar.gz
  • Upload date:
  • Size: 117.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.14

File hashes

Hashes for kaleidoswap_sdk-0.5.5.tar.gz
Algorithm Hash digest
SHA256 5aeeb74a93a6c37e90ad1808e3013e5f6eccf14ed07196eef57e8a533b9f0487
MD5 d264fbd2ed33f81213570fe357050782
BLAKE2b-256 8e2981497d8f90f1392b9ba5a9be681528c3074ee92f337889485c085fa28209

See more details on using hashes here.

File details

Details for the file kaleidoswap_sdk-0.5.5-py3-none-any.whl.

File metadata

File hashes

Hashes for kaleidoswap_sdk-0.5.5-py3-none-any.whl
Algorithm Hash digest
SHA256 ea44d89e40f2847747470b624be87a3cabbc9691414fe88f6691dc5c0b075f66
MD5 98de29bb368d304ba5f9afc2fcd73413
BLAKE2b-256 1f332b9f1854f9fb527a82cb454e50fa49f32d90892d9a231db26a5a8ade166a

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