Skip to content

Commit 1f40c34

Browse files
committed
feat: add Lightning Network support with LNBits integration - Add decode_invoice and pay_invoice tools - Add LNBits client for Lightning operations - Make Lightning config optional - Update documentation
1 parent c812db3 commit 1f40c34

File tree

10 files changed

+684
-17
lines changed

10 files changed

+684
-17
lines changed

.env.example

+5
Original file line numberDiff line numberDiff line change
@@ -7,3 +7,8 @@ BITCOIN_NETWORK=mainnet
77
# Server mode (e.g., stdio or sse) and port (if applicable)
88
SERVER_MODE=stdio
99
PORT=3000
10+
11+
## lnbits information
12+
LNBITS_URL="https://demo.lnbits.com"
13+
LNBITS_ADMIN_KEY="..."
14+
LNBITS_READ_KEY="..."

README.md

+20
Original file line numberDiff line numberDiff line change
@@ -67,6 +67,9 @@ A Model Context Protocol (MCP) server that enables AI models to interact with Bi
6767
- **Blockchain Queries**:
6868
- **Latest Block**: Retrieve details about the most recent block (hash, height, timestamp, transaction count, etc.).
6969
- **Transaction Details**: Fetch detailed information about a transaction using its TXID.
70+
- **Lightning Network**:
71+
- **Invoice Decoding**: Parse a BOLT11 Lightning invoice and display human-readable information.
72+
- **Payment**: Pay a Lightning invoice directly from your LNBits wallet.
7073

7174
## 🔑 Claude Desktop Integration
7275

@@ -170,6 +173,23 @@ If Goose does not seem to use the extension (for instance, if it responds that i
170173
171174
Find the setup instructions in the [Development Setup](https://abdelstark.github.io/bitcoin-mcp/docs/getting-started/development-setup) guide.
172175
176+
### Lightning Network Configuration (Optional)
177+
178+
To use Lightning Network features, you'll need to configure LNBits connection details. These are optional and only required if you plan to use the Lightning Network tools.
179+
180+
```json
181+
{
182+
"lnbitsUrl": "https://demo.lnbits.com",
183+
"lnbitsAdminKey": "your_admin_key", // Required for making payments
184+
"lnbitsReadKey": "your_read_key" // Required for wallet information
185+
}
186+
```
187+
188+
You can obtain these values by:
189+
1. Creating an account at [LNBits](https://lnbits.com/)
190+
2. Creating a new wallet
191+
3. Going to API info to find your API keys
192+
173193
## 📦 Available Tools
174194
175195
Find the available tools in the [API Reference](https://abdelstark.github.io/bitcoin-mcp/docs/api/generate-key) guide.

0 commit comments

Comments
 (0)