Neo N3 MCP

🚀 Neo N3 MCP 服務器與 HTTP 服務器文檔

Neo N3 MCP 服務器基於 Model Context Protocol (MCP) 協議實現，為區塊鏈應用提供強大的功能支持。同時，該軟件包配備的 HTTP 服務器，通過 RESTful API 接口將 Neo N3 功能對外暴露，極大地方便了開發者的使用。

🚀 快速開始

安裝依賴

npm install neo-mcp-server http-restify

初始化項目

創建 server.js 文件：

const MCP = require('neo-mcp-server');
const restify = require('http-restify');

// 初始化 MCP 服務器
const mcpServer = new MCP.Server({
    network: 'test',
    contextPath: '/context'
});

// 初始化 HTTP 服務器
const httpServer = restify.createServer();

// 掛載 MCP 相關路由
mcpServer.applyRoutes(httpServer);

// 啟動服務器
httpServer.listen(3000, () => {
    console.log('服務器已啟動，監聽地址：http://localhost:3000');
});

運行應用

node server.js

✨ 主要特性

• MCP 協議支持：遵循 Model Context Protocol 標準，實現跨鏈數據交換和智能合約交互。
• HTTP REST API：提供一系列 RESTful API 接口，方便開發者集成區塊鏈功能到應用中。
• 錢包管理：支持創建、導入和管理多種格式的錢包文件。
• 智能合約操作：包括部署、調用和查詢智能合約的功能。
• 網絡模式切換：支持主網和測試網的無縫切換。

📚 詳細文檔

MCP 協議

功能概述

MCP 協議允許應用通過訂閱特定區塊鏈事件，實現即時數據獲取功能。其主要特點包括：

• 事件訂閱：開發者可以通過發佈感興趣的事件類型，即時接收鏈上發生的相關數據。
• 狀態變更通知：當區塊鏈上的某個地址或合約發生狀態變化時，系統會自動推送通知到訂閱端。
• 異步處理：所有事件處理都是異步進行的，確保高併發場景下的性能穩定。

MCP 服務器

初始化與配置

// 創建 MCP 實例並設置配置
const mcp = new MCP({
    network: 'test', // 網絡環境：main 或 test
    contextPath: '/context' // 上下文路徑，默認為 /context
});

// 啟動服務器
await mcp.start();

事件處理示例

// 訂閱某個地址的餘額變更事件
mcp.subscribe('address-balance-changed', (event) => {
    console.log(`Address ${event.address} 的餘額發生了變化，當前餘額為 ${event.balance}`);
});

// 處理智能合約調用事件
mcp.on('contract-invoked', async (event) => {
    try {
        const result = await event.execute();
        console.log(`Contract ${event.contract} 調用成功，返回結果：${result}`);
    } catch (error) {
        console.error(`Contract ${event.contract} 調用失敗，錯誤信息：${error.message}`);
    }
});

HTTP 服務器

功能概述

HTTP 服務器通過 RESTful API 提供以下功能：

• 區塊鏈信息查詢：獲取鏈上基本信息、區塊詳情和交易記錄。
• 錢包管理：創建新錢包、導入現有錢包以及查看錢包信息。
• 智能合約操作：部署新合約、調用已部署的合約並查詢合約狀態。
• 網絡模式切換：在主網和測試網之間進行切換。

HTTP 端點

使用示例

# 獲取區塊鏈信息
curl http://localhost:3000/api/context/current

# 部署智能合約
curl -X POST http://localhost:3000/api/contracts \
  -H "Content-Type: application/json" \
  -d '{"contractName": "MyContract", "code":"..."}'

# 調用智能合約
curl -X POST http://localhost:3000/api/contracts/MyContract/call \
  -H "Content-Type: application/json" \
  -d '{"method":"balanceOf","params":["userAddress"]}'

💡 使用說明

• 日誌監控：建議在生產環境中啟用詳細日誌記錄，便於排查問題。
• 性能調優：根據實際需求調整服務器配置參數，如連接數和超時設置。
• 版本升級：定期檢查依賴庫的更新，確保系統安全性和穩定性。

⚠️ 安全注意事項

• 錢包密鑰保護：確保所有錢包私鑰的安全性，避免明文存儲或傳輸。
• 網絡隔離：在測試環境中進行充分的測試，防止誤操作影響主網。
• 訪問控制：建議在生產環境啟用身份認證和權限管理功能。

🛠️ 技術支持

如有任何問題或建議，請聯繫我們的技術支持團隊：support@neonetwork.org