Skip to main content

​
规范与客户端

OpenAPI 规范

KaleidoSwap API 的带版本规范，每次发布时更新。直接对比两个版本，而不是在运行时才发现变化。

TypeScript 与 Python SDK

由这些规范生成的类型化客户端，把 Maker API 和你的节点分别封装在 client.maker.* 与 client.rln.* 之后。

命令行工具

从终端驱动节点、取报价、做交换 —— 在动手写客户端之前手动摸清 API 的好办法。

快速开始

基础 URL、认证、请求格式、版本管理与速率限制。

​
协议参考

交换协议

完整的原子 HTLC 流程，附时序图以及每一步所用的接口端点。

RGB Lightning Node

提供 RLN API 并负责把 swapstring 加入白名单的节点。这是 KaleidoSwap 的分支；上游项目由 RGB Tools 维护。

LSPS1（bLIP-51）

我们的通道订单接口端点所实现的 Channel Requests 规范，并在此基础上扩展了 RGB 资产分配。

RGB 协议文档

客户端校验、资产接口，以及 API 返回的 rgb: 合约 ID 背后的规范本身。

​
环境与测试

上主网之前请先在 signet 上集成。目前无需 API 密钥，匿名请求仍会被正常处理。 资产 ID 在不同环境之间不通用 —— 请从 GET /api/v1/market/assets 读取，并按环境区分配置。

Mutiny 水龙头

获取 signet 比特币，用于给节点充值和开通测试通道。

Mutinynet 区块浏览器

在链上确认交换是否已结算、通道开启是否已确认。

节点托管

交换接口端点所需的 RGB Lightning Node 的部署方案。

​
相关文档

故障排查

三种错误信封、状态码语义、重试策略，以及每种症状对应的修复方法。

SDK 示例

原子交换流程的端到端代码 —— 如果你更愿意读能跑的代码而不是接口表格。

架构

做市方、LSP 和你的节点各自处在什么位置。

术语表

RFQ、swapstring、HTLC、层，以及这些接口端点默认你已经知道的其他术语。

​
获取帮助

如果遇到的是报错，请查阅故障排查；如果是疑问，请看常见问题。 其他情况请从下面的渠道中选择一个反馈问题，并附上：
  1. 请求 URL 与 HTTP 方法
  2. 请求负载（请隐去 API 密钥）
  3. 完整的错误响应，包含 request_id
  4. 请求的时间戳
  5. 运行环境（signet / 主网）

Telegram 社群

向社群提问。

邮件支持

紧急问题的直接支持渠道。