@utexo/rgb-sdk-core foundation. Choose the guide that matches your environment to get started.
Node.js
Server-side applications and backend services. Uses
@utexo/rgb-sdk.React Native
iOS and Android mobile applications. Uses
@utexo/rgb-sdk-rn.Web
Browser-based applications. Uses
@utexo/rgb-sdk-web.How RGB Transfers Work
Before writing any code, it helps to understand the transfer flow. This applies to all platform guides.- The receiver generates a blinded invoice tied to one of their UTXOs.
- The sender calls
.send()with that invoice — the RGB state transition is constructed and broadcast. - Both wallets call
.refreshWallet()to sync the latest on-chain state. - The receiver’s balance updates to reflect the new asset allocation.
New to RGB or UTXOs? See the Glossary for definitions, and Architecture for how Bitcoin, Lightning, and RGB fit together.
Network Endpoints
All SDK platforms connect to the same underlying network infrastructure. No endpoint configuration is needed to follow any of the Quickstart guides — the defaults below are used automatically on testnet.| Service | Testnet Endpoint |
|---|---|
| RGB Transport | rpcs://rgb-proxy-testnet3.utexo.com/json-rpc |
| Bitcoin Indexer | ssl://electrum.iriswallet.com:50013 |
Common Prerequisites
All platform guides share these requirements:- A testnet BTC balance for transaction fees. Get testnet BTC from the Utexo Telegram faucet bot [@Utexo_RLN_bot](https://t.me/Utexo_RLN_bot) — send
/getbtcfollowed by your Bitcoin address.
What You Will Have After Any Guide
- A working
UTEXOWalletinstance connected to testnet - A funded wallet with UTXOs ready to receive RGB assets
- A completed and verified USDT on Bitcoin transfer
SDK Package Summary
| Package | Target | Install |
|---|---|---|
@utexo/rgb-sdk | Node.js (server) | npm install @utexo/rgb-sdk |
@utexo/rgb-sdk-rn | React Native (iOS & Android) | npm install @utexo/rgb-sdk-rn |
@utexo/rgb-sdk-web | Browser (Web) | npm install @utexo/rgb-sdk-web |
UTEXOWallet class and method API. The differences are in installation, initialisation config, and storage model — each guide covers these specifics for its platform.