Bitcoin MCP Server

🚀 Bitcoin - MCP 拡張機能

Bitcoin - MCP 拡張機能は、Bitcoin データの取得や管理を容易にするツールです。この拡張機能を使用することで、Bitcoin の最新ブロック情報やトランザクション詳細を簡単に取得できます。

🚀 クイックスタート

インストール

1. リポジトリのクローン：まず、GitHub から Bitcoin - MCP リポジトリをクローンします。

git clone https://github.com/abdelstark/bitcoin-mcp.git

2. 依存関係のインストール：プロジェクトディレクトリに移動した後、必要な依存関係をインストールします。

npm install

3. 設定の構成：config.json ファイルを作成し、以下の内容を追加します。

{
  "network": "mainnet",    // ネットワーク環境：mainnet、testnet または regtest
  "mempoolUrl": "http://localhost:8081" // Mempool Connect インスタンス URL
}

4. サーバーの起動：

npm start

💻 使用例

基本的な使用法

最新ブロック情報の取得

コマンドを入力：

curl http://localhost:3000/api/block/latest

出力結果：

{
  "height": 709642,
  "hash": "0000000000000000bda5f8c196a0e9d6931b8727e14ae195614ab14ed861efdf",
  "time": "2023-10-05T12:34:56Z",
  "difficulty": 2398721.456,
  "txCount": 2145
}

トランザクション詳細の取得

コマンドを入力：

curl http://localhost:3000/api/tx/abcdef1234567890abcdef1234567890abcdef1234567890abcdef1234567890

出力結果：

{
  "hash": "abcdef1234567890abcdef1234567890abcdef1234567890abcdef1234567890",
  "size": 258,
  "fee": 0.0015,
  "vin": [
    {
      "txid": "1a2b3c4d5e6f7g8h9i0j1k2l3m4n5o6p7q8r9s",
      "vout_index": 1
    }
  ],
  "vout": [
    {
      "value": 0.5,
      "script_pub_key": "OP_DUP OP_HASH160 ... OP_EQUALVERIFY OP_CHECKSIG"
    },
    {
      "value": 0.4985,
      "script_pub_key": "OP_HASH160 ... OP_EQUAL"
    }
  ]
}

🛡️ セキュリティに関する注意事項

⚠️ 重要提示

• 設定ファイルに機密情報を平文で保存しないでください。環境変数または暗号化方式を使用してキーを保存することをおすすめします。
• テスト環境と本番環境のネットワークを分離し、データ漏洩や不正アクセスを防止してください。

📚 ドキュメント

開発設定

詳細な開発設定については、開発ガイドを参照してください。

Lightning ネットワークの設定（オプション）

Lightning ネットワーク機能を使用するには、LNBits 接続情報を設定する必要があります。

{
  "lnbits": {
    "url": "http://localhost:3000",
    "api_key": "your_api_key_here"
  }
}

エラー処理

一般的なエラーと解決策

1. Mempool Connect への接続ができない

   • mempoolUrl が正しいか確認してください。
   • Mempool Connect インスタンスが実行中であることを確認してください。

2. 404 ページが見つからない

   • API パスとパラメータが正しいことを確認してください。
   • サーバーログを確認して、詳細なエラー情報を取得してください。

3. 内部サーバーエラー (500)

   • リクエストボディの形式が要件を満たしていることを確認してください。
   • サーバー側のログを確認して、具体的な問題を特定してください。

🤝 コントリビューションガイド

コードの貢献方法

1. リポジトリのクローン：git clone https://github.com/abdelstark/bitcoin-mcp.git
2. 機能ブランチの作成：git checkout -b feature/new-feature
3. 変更のコミット：git add . && git commit -m '新機能の追加'
4. プッシュとプルリクエストの作成：git push origin feature/new-feature

問題の報告方法

• GitHub リポジトリで新しい Issue を作成してください。
• 詳細なエラー情報と再現手順を提供してください。

📄 ライセンス

このプロジェクトは MIT ライセンスに準拠しています。コードを使用または変更する際には、関連するライセンス条項を遵守してください。