Skip to main content
Glama
wdk-wallet-rln-mcp

wdk-wallet-rln-mcp

Official
by kaleidoswap

wdk-wallet-rln-mcp

IMPORTANT

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

wdk_get_node_info

Node pubkey, channel count, Lightning balance, connected peers

wdk_get_balances

BTC on-chain (vanilla + colored UTXOs) and Lightning balance

wdk_get_asset_balance

RGB asset balance by asset_id — settled, spendable, off-chain

wdk_list_assets

All RGB assets held by the node (NIA, UDA, CFA schemas)

wdk_get_address

On-chain BTC deposit address

Invoices & Payments

Tool

Description

wdk_create_rgb_invoice

Create an RGB invoice to receive an asset off-chain

wdk_create_ln_invoice

Create a BOLT11 Lightning invoice to receive BTC

wdk_pay_invoice

Pay a BOLT11 Lightning invoice

wdk_send_btc

Send BTC on-chain

wdk_send_asset

Send an RGB asset on-chain to a recipient ID

Channel Management

Tool

Description

wdk_list_channels

All channels: capacity, outbound/inbound balance, usability, RGB asset

wdk_open_channel

Open a new channel, optionally with RGB asset allocation

wdk_connect_peer

Connect to a Lightning peer (pubkey@host:port) — required before requesting an LSPS1 channel if the LSP isn't already a connected peer

Transfers & Payments History

Tool

Description

wdk_list_payments

Recent Lightning payments (sent and received)

wdk_refresh_transfers

Flush pending RGB asset transfers

wdk_list_transfers

RGB transfers for one asset with status — check if an RGB invoice was paid

RGB Issuance

Tool

Description

wdk_create_utxos

Create colorable UTXOs — needed before issuing, invoicing RGB, or opening asset channels

wdk_issue_asset

Issue a new RGB asset: NIA (fungible token with ticker), CFA (collectible fungible), UDA (unique / NFT). Amount in display units, converted with precision

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

wdk_atomic_taker

Step 2 of atomic swap — whitelist HTLC on node before execute

wdk_list_swaps

List all atomic swaps on the node

wdk_get_swap

Get atomic swap state by payment_hash

MPP (Machine Payments Protocol)

Tool

Description

wdk_mpp_pay

Pay an MPP Lightning challenge from the RLN wallet; returns a credential JSON for mpp_submit_credential (mpp-gateway domain)

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 build

Usage

# Stdio transport (use with any MCP host)
RLN_NODE_URL=http://localhost:3001 node dist/index.js

Claude 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_NODE_URL

http://localhost:3001

RLN daemon HTTP API URL

Requirements

A running RGB Lightning Node daemon accessible at RLN_NODE_URL.

License

Apache-2.0

Available Tools

19 tools
wdk_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

    A3.8/5.0

    Scored across 19 tools

    Disambiguation5/5

    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.

    Naming Consistency4/5

    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.

    Tool Count4/5

    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.

    Completeness4/5

    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

    ActivitySlowing
    ResponsivenessNo recent community issues

    Related MCP Connectors

    Related MCP Servers

    • A
      license
      B
      quality
      D
      maintenance
      Enables 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.
      18
      10 npm
      1
      MIT
    • A
      license
      B
      quality
      D
      maintenance
      Enables LLMs to manage a phoenixd Bitcoin Lightning wallet, including creating and paying invoices, managing channels, and querying balances and node info.
      17
      24 npm
      1
      MIT