Moveflow_aptos_mcp_server

🚀 MoveFlow 服务端文档

MoveFlow 服务端是一个用于与 Aptos 区块链交互的服务器端组件，具备多种操作模式和安全架构设计。它能帮助开发者轻松实现与 Aptos 区块链的通信，提供丰富的区块链操作工具。

🚀 快速开始

安装依赖

npm install moveflow-aptos-mcp-server

启动服务器

const { MoveFlowServer } = require('moveflow-aptos-mcp-server');

// 初始化配置
const config = {
aptosNodeUrl: 'https://fullnode.mainnet.aptoslabs.com',
network: 'mainnet',
readOnlyMode: true,
};

// 启动服务器
new MoveFlowServer(config).start();

使用工具

const { tools } = require('moveflow-aptos-mcp-server');

// 查询余额
tools.balance.queryBalance("0x1", (error, result) => {
if (error) return console.error(error);
console.log(result);
});

✨ 主要特性

核心功能

• 区块链交互：通过适配器实现与 Aptos 区块链的通信。
• MCP 工具集成：提供多种 Move Command Processor（MCP）工具，支持丰富的区块链操作。
• 安全模式：支持只读模式、客户端签名模式和直接签名模式。

支持的操作

• 查询数据：从区块链查询交易、账户信息等。
• 准备交易：生成交易对象但不签名。
• 签名并提交交易：在直接签名模式下，使用提供的私钥签名并提交交易。

📦 安装指南

环境变量

*当 SIGNING_MODE 设置为 "direct" 且 READ_ONLY_MODE 为 "false" 时需要。

🔧 技术细节

客户端签名模型

服务端设计避免存储私钥：

1. 只读模式：

   • 默认推荐的运行模式
   • 只允许查询区块链数据
   • 不能执行交易
   • 启用通过 READ_ONLY_MODE="true"

2. 交易准备模式：

   • 当 READ_ONLY_MODE 设置为 "false"
   • 服务端准备交易但不签名
   • 交易必须由客户端应用程序签名
   • 提供增强的安全性，将交易准备与签名分离

3. 直接签名模式（用于开发）：

   • 当 SIGNING_MODE 设置为 "direct" 并且 APTOS_PRIVATE_KEY 提供时
   • 服务端使用提供的私钥签名并提交交易
   • 更不安全但测试方便
   • 不建议生产环境使用

安全的交易架构

服务端架构分离职责：

• 服务端：验证输入并准备事务对象
• 客户端：管理私钥并签名事务
• API/连接器：处理服务端与客户端之间的通信

这种设计消除了服务端对私钥处理的需求，使其在生产环境中更加安全。

💻 使用示例

基础用法

# 运行测试脚本
npm run test-tools

这将执行一系列针对每个 MCP 工具的测试，以验证其正确功能。您也可以通过编辑 test-tools.js 中的配置来使用不同的网络或签名模式。

📚 详细文档

项目结构

服务端代码库的组织如下：

moveflow_aptos_mcp_server/
├── src/                    # 源代码
│   ├── adapters/          # 区块链适配器
│   ├── tools/             # MCP 工具集合
│   └── server.js         # 服务端主文件
├── package.json         # 依赖管理
└── README.md            # 文档

开发步骤

1. 克隆仓库：

   git clone [仓库地址]
   cd moveflow-aptos-mcp-server
   

2. 安装依赖：

   npm install
   

3. 启动开发服务器：

   npm start
   

📄 结束语

MoveFlow 服务端为与 Aptos 区块链交互提供了强大的功能和灵活的安全架构。通过合理配置和使用，您可以轻松集成区块链功能到您的应用中。