RGB wallet
Use the UTEXO RGB wallet module for RGB assets on Bitcoin.
@utexo/wdk-wallet-rgb is a WDK wallet module for RGB assets on Bitcoin. It wraps the UTEXO RGB runtime behind WDK wallet manager and account classes.
Powered by @utexo/wdk-wallet-rgb.
This module is developed and maintained independently by a third-party contributor. Tether and the WDK team do not endorse or assume responsibility for its code, security, or maintenance. Review the package and use your own judgment before using it with real funds.
When to use it
Use this module when your application needs RGB asset support on Bitcoin and can persist local RGB wallet state.
| Use case | Module |
|---|---|
| RGB asset issuance, balances, and transfers | @utexo/wdk-wallet-rgb |
| Base-layer Bitcoin wallet flows without RGB assets | @tetherto/wdk-wallet-btc |
| Lightning payments through Spark | @tetherto/wdk-wallet-spark |
Requirements
The module requires:
- a BIP-39 seed phrase or seed bytes;
- a supported RGB network;
- a persistent app-private
dataDirfor RGB wallet state; - access to a Bitcoin indexer;
- access to an RGB transport endpoint.
The package README warns that losing dataDir invalidates RGB asset balances even though seed-derived BTC addresses still exist. Pick a durable app-private path and include it in your backup strategy.
Install
npm install @utexo/wdk-wallet-rgbMinimal setup
import WalletManagerRgb from '@utexo/wdk-wallet-rgb'
const manager = new WalletManagerRgb(seedPhrase, {
network: 'regtest',
dataDir: './wallet-data'
})
const account = await manager.getAccount()
const address = await account.getAddress()
console.log(address)