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

Uploaded Python 3

File details

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

File metadata

  • Download URL: kaleido_sdk-0.1.4.tar.gz
  • Upload date:
  • Size: 119.7 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.4.tar.gz
Algorithm Hash digest
SHA256 dfb81f3b618f26637db97929b3cdcf7a53bfed70b3bd22ec715753c29562cb36
MD5 f27c8aa3aafad6b0b72bd65042dfdf70
BLAKE2b-256 8c816bb849c91cedbcb5f2f615a00835835b38ec9c53c04cb59e2bd200da7cea

See more details on using hashes here.

File details

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

File metadata

  • Download URL: kaleido_sdk-0.1.4-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.4-py3-none-any.whl
Algorithm Hash digest
SHA256 0b37fed7f21e5e57ac224ace6e3d19d9871c3499ad54e47511aa7f84f908c346
MD5 3b18e4fb93ab32793fbf53c43bfc8c18
BLAKE2b-256 a7fc55f82ccb217febcd7f858d7c8dc881fbcbf50f083def04a262f22d7b3b5d

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