RGB wallet usage

Task-focused guides for the released @utexo/wdk-wallet-rgb 2.0.3 community module.

Use these guides for the single-account, on-chain RGB wallet in @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.

Get started

Install the package and open the index-0 account.

Manage account storage

Persist local RGB state and understand the account and derivation boundaries.

Balances and history

Read Bitcoin and RGB balances, transactions, transfers, and receipts.

Bitcoin and UTXOs

Send Bitcoin and create the UTXOs needed by RGB workflows.

Issue and receive assets

Issue NIA assets and create blind or witness invoices.

Transfer assets

Quote and send RGB assets to a recipient-generated invoice.

Backup, restore, and migrate

Protect local state and move from the legacy remote-node architecture.

Sign and verify messages

Use the full account's message-signing surface.

Handle errors

Handle ambiguous history, fee, network, and cleanup failures.