Bitcoin MCP Server

🚀 Bitcoin-MCP Extension

The Bitcoin-MCP extension offers a convenient way to interact with Bitcoin data and related services. It simplifies the process of querying blockchain information and supports various network environments.

🚀 Quick Start

To use the Bitcoin-MCP extension, follow these steps:

1. Clone the Repository: First, clone the Bitcoin-MCP repository from GitHub:

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

2. Install Dependencies: After entering the project directory, install the required dependencies:

npm install

3. Configure Settings: Create a config.json file and add the following content:

{
  "network": "mainnet",    // Network environment: mainnet, testnet, or regtest
  "mempoolUrl": "http://localhost:8081" // Mempool Connect instance URL
}

4. Start the Server:

npm start

💻 Usage Examples

Querying Bitcoin Data

Example 1: Get the Latest Block Information

Input command:

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

Output result:

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

Example 2: Query Transaction Details

Input command:

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

Output result:

{
  "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"
    }
  ]
}

⚠️ Important Note

• Sensitive Data: Avoid storing sensitive information in plain text in the configuration file. It is recommended to use environment variables or encryption methods to store keys.
• Network Isolation: Ensure that the test environment is network - isolated from the production environment to prevent data leakage and unauthorized access.

📚 Documentation

For detailed development settings, please refer to the Development Setup Guide.

Lightning Network Configuration (Optional)

To use Lightning Network features, you need to configure LNBits connection information:

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

🔧 Error Handling

Common Errors and Solutions:

1. Unable to Connect to Mempool Connect

   • Check if the mempoolUrl is correct.
   • Ensure that the Mempool Connect instance is running.

2. 404 Page Not Found

   • Confirm that the API path and parameters are correct.
   • Check the server logs for more error information.

3. Internal Server Error (500)

   • Check if the request body format meets the requirements.
   • Check the server - side logs to locate the specific problem.

🤝 Contribution Guide

How to Contribute Code:

1. Clone the Repository: git clone https://github.com/abdelstark/bitcoin-mcp.git
2. Create a Feature Branch: git checkout -b feature/new-feature
3. Commit Changes: git add . && git commit -m 'Add a new feature'
4. Push and Create a Pull Request: git push origin feature/new-feature

How to Report Issues:

• Create a new issue in the GitHub repository.
• Provide detailed error information and steps to reproduce the problem.

📄 License

This project is licensed under the MIT License. Please comply with the relevant license terms when using or modifying the code.