wdk-wallet-rln-mcp
OfficialThis server provides full control over an RGB Lightning Node (RLN) wallet for AI agents via MCP. Capabilities include:
Node & Balances: Retrieve node identity, BTC on-chain/colored UTXO balances, RGB asset balances (by ID and list all), Lightning channel/peer info, and generate a BTC deposit address.
Invoices & Payments: Create RGB invoices for off-chain asset reception, BOLT11 invoices for BTC, pay BOLT11 invoices, send BTC on-chain, and send RGB assets on-chain.
Channel Management: List, open Lightning channels (optionally with RGB allocation), and connect to peers.
Transfers & History: List Lightning payments, refresh pending RGB transfers.
Atomic Swaps: Taker-side operations: whitelist HTLCs (step 2), list swaps, get status.
Machine Payments Protocol (MPP): Pay MPP Lightning challenges to receive L402-compatible credentials.
Provides tools for managing an RGB Lightning Node (RLN) wallet, including on-chain and Lightning balances, RGB asset management, Lightning invoices and payments, channel operations, and atomic swap taker support.
Click on "Deploy Server".
Wait a few minutes for the server to deploy. Once ready, it will show a "Started" state.
In the chat, type
@followed by the MCP server name and your instructions, e.g., "@wdk-wallet-rln-mcp what are my current balances?"
That's it! The server will respond to your query, and you can continue using it as needed.
Here is a step-by-step guide with screenshots.
wdk-wallet-rln-mcp
This repository is archived. All of its tools now ship in the unified
kaleido-mcp server (0.3.0+), together with
KaleidoSwap DEX, RLN, Spark, Liquid and MPP/L402 tools. Use npx -y kaleido-mcp instead.
MCP server that exposes an RGB Lightning Node (RLN) wallet to AI agents via the Model Context Protocol.
Provides full wallet control: balances, RGB invoices, Lightning payments, channel management, and atomic swap taker support.
Tools
Node & Balances
Tool | Description |
| Node pubkey, channel count, Lightning balance, connected peers |
| BTC on-chain (vanilla + colored UTXOs) and Lightning balance |
| RGB asset balance by |
| All RGB assets held by the node (NIA, UDA, CFA schemas) |
| On-chain BTC deposit address |
Invoices & Payments
Tool | Description |
| Create an RGB invoice to receive an asset off-chain |
| Create a BOLT11 Lightning invoice to receive BTC |
| Pay a BOLT11 Lightning invoice |
| Send BTC on-chain |
| Send an RGB asset on-chain to a recipient ID |
Channel Management
Tool | Description |
| All channels: capacity, outbound/inbound balance, usability, RGB asset |
| Open a new channel, optionally with RGB asset allocation |
| Connect to a Lightning peer ( |
Transfers & Payments History
Tool | Description |
| Recent Lightning payments (sent and received) |
| Flush pending RGB asset transfers |
| RGB transfers for one asset with status — check if an RGB invoice was paid |
RGB Issuance
Tool | Description |
| Create colorable UTXOs — needed before issuing, invoicing RGB, or opening asset channels |
| Issue a new RGB asset: |
Typical flow on a fresh regtest node: wdk_get_address → fund it → wdk_create_utxos → wdk_issue_asset { name: "Hackathon Ticket", ticker: "TICKET", amount: 1000 } → wdk_create_rgb_invoice / wdk_send_asset.
Atomic Swap Taker
Tool | Description |
| Step 2 of atomic swap — whitelist HTLC on node before execute |
| List all atomic swaps on the node |
| Get atomic swap state by |
MPP (Machine Payments Protocol)
Tool | Description |
| Pay an MPP Lightning challenge from the RLN wallet; returns a credential JSON for |
Related MCP server: Alby Bitcoin Payments MCP Server
Atomic Swap Flow
This server handles step 2 of the 5-step atomic swap flow:
kaleidoswap_atomic_init → swapstring + payment_hash (kaleidoswap-mcp)
wdk_atomic_taker → whitelist HTLC on node ← this server
wdk_get_node_info → taker_pubkey ← this server
kaleidoswap_atomic_execute → HTLC settlement (kaleidoswap-mcp)Installation
npm install
npm run buildUsage
# Stdio transport (use with any MCP host)
RLN_NODE_URL=http://localhost:3001 node dist/index.jsClaude Desktop
{
"mcpServers": {
"wdk_wallet": {
"command": "node",
"args": ["/path/to/wdk-wallet-rln-mcp/dist/index.js"],
"env": {
"RLN_NODE_URL": "http://localhost:3001"
}
}
}
}Configuration
Env var | Default | Description |
|
| RLN daemon HTTP API URL |
Requirements
A running RGB Lightning Node daemon accessible at RLN_NODE_URL.
License
Apache-2.0
Available Tools
19 toolswdk_atomic_takerA
Step 2 of atomic swap: whitelist the incoming HTLC on the RLN node. Must be called with the swapstring from kaleidoswap_atomic_init BEFORE calling kaleidoswap_atomic_execute. This locks the HTLC on the node so it is ready to receive the atomic payment.
Inputs: swapstring (required).
wdk_connect_peerA
Connect the RLN node to a Lightning peer. Required before requesting an LSPS1 channel from the KaleidoSwap LSP — call this first if the LSP is not already a connected peer. Format: "@:".
Inputs: peer_pubkey_and_addr (required).
wdk_create_ln_invoiceB
Create a BOLT11 Lightning invoice to receive BTC via Lightning Network.
Inputs: expiry_sec, amount_msat, description.
wdk_create_rgb_invoiceA
Create an RGB invoice to receive an RGB asset (e.g. USDT from a KaleidoSwap). Pass the returned invoice string as receiver_address when calling kaleidoswap_place_order with receiver_address_format="RGB_INVOICE".
Inputs: amount, asset_id, duration_seconds.
wdk_get_addressA
Get the node on-chain BTC address for receiving Bitcoin deposits.
Inputs: no named parameters.
wdk_get_asset_balanceA
Get the balance of a specific RGB asset (e.g. USDT, XAUT) by its asset_id. Returns settled, future, spendable, and off-chain amounts.
Inputs: asset_id (required).
wdk_get_balancesA
Get current wallet balances: BTC on-chain (vanilla and colored UTXOs). For RGB asset balances use wdk_get_asset_balance with a specific asset_id.
Inputs: skip_sync.
wdk_get_node_infoA
Get the RLN node identity and network summary: pubkey, number of channels, Lightning balance, connected peers. Call this first to confirm the node is reachable.
Inputs: no named parameters.
wdk_get_swapA
Get atomic swap status by payment_hash from the RLN node. Use after kaleidoswap_atomic_execute to confirm the node-side swap state. Optionally filter by taker=true to check taker-side swaps.
Inputs: payment_hash (required), taker.
wdk_list_assetsA
List all RGB assets held by the node (NIA, UDA, CFA schemas). Returns asset IDs, names, tickers, and precision.
Inputs: schemas.
wdk_list_channelsA
List all Lightning channels: capacity, local balance, usability status, and any RGB asset allocated to the channel.
Inputs: usable_only.
wdk_list_paymentsA
List recent Lightning payments (sent and received). Useful for confirming that a swap deposit was sent successfully.
Inputs: limit, inbound_only, outbound_only.
wdk_list_swapsA
List all atomic swaps on the RLN node, split by maker and taker side. Useful for monitoring active and historical atomic swap activity.
Inputs: no named parameters.
wdk_mpp_payA
Pay an MPP (Machine Payments Protocol) Lightning challenge using the RLN wallet. Pass the invoice from mpp_request_challenge. Returns a credential JSON string to pass directly to mpp_submit_credential. Also returns the payment_hash for auditing. Supports optional macaroon and challenge_id fields from the challenge for L402-compatible credential construction.
Inputs: invoice (required), macaroon, challenge_id.
wdk_open_channelB
Open a new Lightning channel to a peer. Optionally allocate an RGB asset to the channel for off-chain asset transfers.
Inputs: capacity_sat (required), peer_pubkey_and_addr (required), asset_id, is_public, +2 more.
wdk_pay_invoiceA
Pay a BOLT11 Lightning invoice. Use this to send payment to a KaleidoSwap deposit_address after placing a swap order.
Inputs: invoice (required).
wdk_refresh_transfersA
Refresh pending RGB asset transfers. Call this after a swap is reported FILLED to update on-chain asset balances.
Inputs: skip_sync.
wdk_send_assetA
Send an RGB asset (e.g. USDT) on-chain to a recipient identified by their RGB recipient_id. Use this to fund a KaleidoSwap order whose deposit_address.format is "RGB_INVOICE" — pass the deposit_address.address as recipient_id.
Inputs: amount (required), asset_id (required), recipient_id (required), fee_rate, +1 more.
wdk_send_btcB
Send BTC on-chain to a Bitcoin address.
Inputs: address (required), amount_sat (required), fee_rate.
Tool Schema Changelog
Recent tool additions, removals, and schema changes observed during successful MCP inspections.
Loading tool schema changelog…
TDQS
Scored across 19 tools
Each tool targets a specific operation with clear boundaries: atomic swap steps, connection management, invoice creation, balance queries (separate for BTC and RGB), node info, payment handling, channel operations, asset transfers. No overlapping purposes.
All tools start with 'wdk_' and mostly follow verb_noun pattern (e.g., wdk_create_ln_invoice, wdk_send_asset). Minor deviations like 'wdk_atomic_taker' (noun) and 'wdk_mpp_pay' (noun_verb) but overall consistent snake_case.
19 tools cover a broad scope (wallet, lightning, RGB assets, atomic swaps). Slightly above typical range but each tool serves a distinct purpose; no obvious bloat.
Core workflows are covered: connect, node info, balances, invoices, payments, channels, RGB assets, atomic swaps, on-chain sends. Minor gaps like channel closure or wallet backup, but nothing critical.
Maintenance
Related MCP Connectors
Give AI agents a Bitcoin wallet with Lightning Network payments and L402 support.
Crypto wallet for AI agents: balances, payments, swaps and trading with owner controls.
Bitcoin wallet intelligence for AI agents: trust, labels, tx verify, fees, and timestamps.
Agent registry with Nostr identity, reputation, escrow, observability, and Lightning payments.
Related MCP Servers
- AlicenseBqualityDmaintenanceEnables AI assistants to interact with RGB assets, Lightning Network operations, and Bitcoin transactions through RGB Lightning Node APIs. Supports asset management, invoice creation/payment, channel management, on-chain transactions, and asset swaps.1810 npm1MIT
- AlicenseNot gradedqualityDmaintenanceEnables Bitcoin Lightning wallet integration with LLMs through Nostr Wallet Connect (NWC). Supports lightning payments, LNURL operations, and L402 authentication for AI-powered bitcoin transactions.Apache 2.0
- AlicenseAqualityDmaintenanceEnables AI agents to perform Bitcoin and Lightning Network payments using a non-custodial, zero-trust architecture. It provides 13 tools for wallet management, invoice creation, and payment processing while keeping node credentials local to the user's machine.138 npmMIT
- AlicenseBqualityDmaintenanceEnables LLMs to manage a phoenixd Bitcoin Lightning wallet, including creating and paying invoices, managing channels, and querying balances and node info.1724 npm1MIT