xrpl-mcp-service

🚀 XRPL MCP 服务

一个 Model Context Protocol (MCP) 服务器，提供对 XRP Ledger (XRPL) 的全面访问。此服务使 AI 模型能够通过标准化端点与 XRPL 进行交互，极大地提升了 AI 与区块链交互的便利性和效率。

🚀 快速开始

要使用本服务，你需要完成以下几个步骤：

1. 创建 .env 文件：

XRPL_NODE_URL=https://xrplcluster.com

2. 安装依赖项：

pip install xrpl-py fastapi uvicorn python-dotenv

3. 启动服务器：

uvicorn main:app --host 0.0.0.0 --port 8000 --reload

✨ 主要特性

账户信息

• xrpl_account_info - 基本账户详情
• xrpl_account_balances - XRP 和代币余额（以人类可读格式显示）
• xrpl_account_lines - 信任线
• xrpl_account_offers - 活跃的交易报价
• xrpl_account_nfts - NFT持有情况
• xrpl_account_tx - 事务历史记录

去中心化交易所

• xrpl_order_book - 查看货币对订单簿
• xrpl_market_price - 获取当前市场价格
• xrpl_amm_info - 自动化市场参与者信息

NFT 操作

• xrpl_nft_offers - 查看NFT购买/销售报价

信任线与支付

• xrpl_set_trust_line - 建立新的信任线
• xrpl_remove_trust_line - 移除现有信任线
• xrpl_payment_channels - 支付通道信息
• xrpl_find_path - 支付路径查找
• xrpl_deposit_auth - 检查支付授权

系统

• xrpl_server_info - 节点状态和信息
• xrpl_submit_tx - 提交签名事务

📦 安装指南

1. 创建 .env 文件：

XRPL_NODE_URL=https://xrplcluster.com

2. 安装依赖项：

pip install xrpl-py fastapi uvicorn python-dotenv

3. 启动服务器：

uvicorn main:app --host 0.0.0.0 --port 8000 --reload

💻 使用示例

基础用法

获取账户信息

POST /call-tool/xrpl_account_info
{
  "account": "rsuUjfWxrACCAwGQDsNeZUhpzXf1n1NK5Z"
}

获取账户余额

POST /call-tool/xrpl_account_balances
{
  "account": "rsuUjfWxrACCAwGQDsNeZUhpzXf1n1NK5Z"
}

设置信任线

POST /call-tool/xrpl_set_trust_line
{
  "account": "alice",
  "trustee": "bob",
  "amount": "100"
}

获取订单簿

POST /call-tool/xrpl_order_book
{
  "order_id": "12345"
}

📚 详细文档

项目结构

• main.py - FastAPI 应用程序入口
• xrpl_tools.py - XRPL 工具和函数
• templates/ - HTML 模板文件
• static/ - 静态资源文件

关键组件

• XrplClient - 用于与 XRPL 网络交互的客户端类
• TrustLineManager - 处理信任线操作的管理器
• PaymentChannel - 支持支付通道功能的类
• OrderBook - 实现订单簿数据结构

未来增强计划

1. 钱包集成：添加对多种钱包提供商的支持
2. 事务监听：实现事务实时更新通知
3. API 文档：生成交互式 API 文档
4. 性能优化：提升处理大量请求的能力

贡献指南

1. 叉代码库
2. 创建功能分支
3. 实现你的更改
4. 提交拉取请求

重要注意事项

⚠️ 重要提示

• 总是使用“已验证”的区块链在生产环境中
• 安全存储钱包种子和私钥
• 监控交易费用
• 在测试网中进行全面测试

资源

• XRPL 文档
• MCP 协议文档
• FastAPI 文档

📄 许可证

本项目采用 MIT 许可证。