RGB wallet
Use the community-maintained UTEXO wallet for on-chain RGB assets, Bitcoin UTXOs, and local RGB state.
@utexo/wdk-wallet-rgb is a community-maintained WDK wallet module for on-chain RGB assets on Bitcoin. It wraps @utexo/rgb-sdk behind WDK wallet manager and account classes.
These pages describe the released @utexo/wdk-wallet-rgb@2.0.3.
Community modules are developed and maintained independently by third-party contributors.
Tether and the WDK Team do not endorse or assume responsibility for their code, security, or maintenance. Use your own judgment and proceed at your own risk.
Choose the correct RGB module
The on-chain wallet and RGB Lightning wallet are separate wallets. They derive different wallet identities, own separate rgb-lib state, and do not share asset records.
| Requirement | Module |
|---|---|
| Issue NIA assets, receive or send on-chain RGB assets, and manage RGB-aware Bitcoin UTXOs | @utexo/wdk-wallet-rgb |
| Hold and transfer RGB assets through LDK channels, BOLT11 invoices, or an LSP | @utexo/wdk-rgb-lightning |
| Manage Bitcoin without RGB state | @tetherto/wdk-wallet-btc |
Give the on-chain and Lightning modules different persistent dataDir values. Copying an asset ID between them does not copy its wallet records or balance.
Requirements
For durable use, provide:
- a BIP-39 mnemonic or seed bytes;
mainnet,testnet, orregtest;- a persistent, app-private
dataDir; - a trusted Electrs-compatible indexer;
- an RGB transport endpoint for consignment exchange.
The runtime allows dataDir to be omitted and then uses temporary storage. Do not rely on that behavior for a persistent wallet. A seed recreates key material, but it is not a substitute for preserving and backing up the local RGB state.
Released runtime support
The package is ESM and exposes a conditional Bare entry. Its pinned native RGB dependencies publish artifacts for:
- Linux x64 and arm64;
- macOS arm64.
No Windows or Intel macOS artifact was published for this release. The package does not declare a Node.js engine range; verify the exact host and native artifact before deployment.
The maintainer README labels the package beta despite the 2.0.3 version. Test backup, restore, fee, indexer, transport, and failure paths on the target runtime before handling real funds.
Capabilities and boundaries
- One account at index
0, with BIP-86 vanilla and colored derivation paths. - Settled Bitcoin and RGB balance queries, transaction and transfer history, and receipts.
- NIA issuance and blind or witness receive invoices.
- High-level RGB transfers and lower-level PSBT transfer steps.
- Bitcoin sends and RGB-compatible UTXO creation.
- Encrypted local-state backup and restore.
- Full-account message signing and verification.
This release does not expose multiple accounts, arbitrary derivation paths, or UDA/CFA issuance through its declared WDK account API.
Start building
Get started
Install the released package and create the single RGB account.
Usage guides
Follow task-focused guides for assets, UTXOs, storage, migration, and errors.
Configuration
Choose a network, durable storage, indexer, and transport endpoint.
API reference
Review the public v2.0.3 manager and account surface.
v2.0.3 source
Inspect the exact released source and security guidance.