RGB Lightning wallet

@utexo/wdk-rgb-lightning is a community-maintained WDK wallet module that runs an LDK and rgb-lib node behind the WDK manager/account interface.

These pages describe the released @utexo/wdk-rgb-lightning@0.1.0-beta.15.

Choose the correct RGB module

The two UTEXO RGB modules derive different wallet identities and own different rgb-lib databases. They do not share asset records. Give each a separate persistent dataDir.

Runtime architecture

The package uses conditional exports:

The verified Node peer release was 0.1.0-beta.11; the verified Bare peer release was 0.1.0-beta.15. No Windows native artifact was published in this release set.

Each native peer downloads a prebuilt artifact during installation. Validate artifact provenance, platform selection, and native loading in the deployment pipeline.

Security and state model

• The WDK manager retains the BIP-39 secret boundary.
• An in-process VLS external signer handles channel-state cryptography.
• keyPair.privateKey is always null; the account does not expose signer private bytes.
• RLN persists public node identity plus LDK and RGB state under dataDir.
• Optional VSS payloads are encrypted client-side and still require the original seed for recovery.
• manager.dispose() shuts down the binding, destroys the VLS signer, and wipes seed buffers retained by the RGB Lightning binding. Treat disposal as terminal for the node session, and do not reuse the manager, account, read-only adapter, or LSP object afterward.

The account is single-node and single-account: index 0, path m.

Capabilities and boundaries

• Explicit unlock against Bitcoin RPC, indexer, and RGB proxy services.
• Peer connections, channels, BOLT11 invoices, HODL invoices, payments, and keysend.
• Bitcoin balances, transactions, UTXOs, sends, and fee estimates.
• RGB balances, invoices, transfers, media, and channel-aware payments.
• LSP client, Lightning Address/LNURL-pay helpers, composed UTEXO LSP flows, and APay.
• Optional VSS backup and recovery fencing.
• Message signing and verification through the Lightning node identity.
• Query-only account adapter for least-authority reads.

Runtime JavaScript contains RGB issuance forwarders, but beta.15's public declarations omit them. These docs do not present them as supported public account APIs. Use the on-chain RGB module for issuance. Atomic-swap methods remain native-binding-only and are also outside the WDK account surface.

Start building