Bitcoin MCP Server

🚀 Bitcoin - MCP 擴展

Bitcoin - MCP 擴展是一個用於查詢比特幣數據的工具，通過簡單的配置和操作，你可以輕鬆獲取比特幣的最新區塊信息、交易詳情等數據。

🚀 快速開始

要使用 Bitcoin - MCP 擴展，請按照以下步驟操作：

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

💻 使用示例

基礎用法

示例 1：獲取最新區塊信息

輸入命令：

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

輸出結果：

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

示例 2：查詢交易詳情

輸入命令：

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 網絡配置（可選）

要使用閃電網絡功能，需要配置 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 協議。請在使用或修改代碼時遵守相關許可條款。