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

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for kaleidoswap_sdk-0.5.6.tar.gz
Algorithm Hash digest
SHA256 8f6c232d3e8f6a57eb1cc960794b396d345d15643aff7c7def1541c0e9861911
MD5 a72cb0a055bb40c72111afae959d27e4
BLAKE2b-256 d6868f54f036109e1efe581a5c6d2faa425f3c73636408c2cc49696a94b334ca

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for kaleidoswap_sdk-0.5.6-py3-none-any.whl
Algorithm Hash digest
SHA256 de19848d0019ffd1df0e39fb01c19c38365cf209cf75b13674865055746940ed
MD5 cddf0ad1ebdb77fb887d029c38ee7a1d
BLAKE2b-256 cd3d45fdea7f2710889d56e95118dd7387b0a3bc6e73c431a789e159249fd89b

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