Neo N3 MCP

🚀 Neo N3 MCP サーバーと HTTP サーバーのドキュメント

Neo N3 MCP サーバーは、Model Context Protocol (MCP) に基づくプロトコル実装で、ブロックチェーンアプリケーションに強力な機能を提供します。また、このソフトウェアパッケージには HTTP サーバーも含まれており、RESTful API を通じて Neo N3 の機能を公開します。

✨ 主な機能

• 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(`アドレス ${event.address} の残高が変更されました。現在の残高は ${event.balance} です。`);
});

// スマートコントラクト呼び出しイベントを処理する
mcp.on('contract-invoked', async (event) => {
    try {
        const result = await event.execute();
        console.log(`コントラクト ${event.contract} の呼び出しに成功しました。戻り値：${result}`);
    } catch (error) {
        console.error(`コントラクト ${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"]}'

🚀 クイックスタート

依存関係のインストール

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

📚 使い方

• ログ監視：本番環境では詳細なログ記録を有効にすることをおすすめします。問題のトラブルシューティングに役立ちます。
• パフォーマンスチューニング：実際のニーズに応じて、サーバーの設定パラメータ（接続数、タイムアウト設定など）を調整してください。
• バージョンアップグレード：定期的に依存ライブラリの更新を確認し、システムの安全性と安定性を確保してください。

🔧 技術詳細

セキュリティ上の注意事項

• ウォレットキーの保護：すべてのウォレットの秘密鍵の安全性を確保し、平文での保存や転送を避けてください。
• ネットワークの分離：テスト環境で十分なテストを行い、誤操作がメインネットに影響を与えないようにしてください。
• アクセス制御：本番環境では、認証と権限管理機能を有効にすることをおすすめします。

📄 技術サポート

何か問題や提案がある場合は、当社の技術サポートチームにお問い合わせください：support@neonetwork.org