minmoto/swap

Swap 镜像文档

镜像概述

Swap是一个简单的KES与BTC交换界面，集成了Minmo API，用于处理KES和BTC之间的交换操作。该应用通过统一的Minmo API接口实现所有交换功能，提供便捷的交换流程和灵活的认证方式。

核心功能和特性

Minmo API集成

应用通过统一的Minmo API执行所有交换操作，主要特性包括：

• API基础URL：http://localhost:5000/api/v1/
• 交换端点：
  • /swap/quote：获取交换报价
  • /swap/onramp：入金操作
  • /swap/offramp：出金操作
• 认证支持：同时支持JWT令牌和API密钥两种认证方式
• 组织关联：所有交换操作均与用户组织绑定，确保操作的组织范围性

使用场景

适用于需要在KES和BTC之间进行交换的用户或组织，特别是在已部署Minmo API的环境中，可作为前端界面或服务组件便捷地执行交换相关操作。

使用方法

开发环境启动

1. 启动Minmo API：从项目根目录执行以下命令

   bash
   npm run dev:api
   

2. 启动Swap应用：执行以下命令

   bash
   npm run dev:swap
   

3. 访问应用：通过浏览器访问 http://localhost:3001

API认证配置

使用JWT令牌

1. 获取测试令牌：

   bash
   cd ../../api/keycloak
   ./get-token.sh developer
   

2. 在API调用中使用：

   bash
   curl -H 'Authorization: Bearer <token>' \
     http://localhost:5000/api/v1/swap/quote
   

使用API密钥

1. 创建API密钥（通过Console API）：

   bash
   curl -X POST http://localhost:5000/api/v1/organizations/{orgId}/api-keys \
     -H 'Authorization: Bearer <jwt_token>' \
     -d '{"name": "Swap App", "serviceIds": ["swap"]}'
   

2. 使用API密钥进行交换操作：

   bash
   curl -H 'X-API-Key: mk_...' \
     http://localhost:5000/api/v1/swap/quote
   

详细API文档

访问 http://localhost:5000/api/docs 查看完整的API文档和接口说明。