Node.js Quickstart

npm install @utexo/rgb-sdk

const { generateKeys } = require('@utexo/rgb-sdk');

const keys = await generateKeys('testnet');
console.log('Mnemonic:', keys.mnemonic); // Store this securely — never share it
console.log('Pubkey:', keys.xpub);

const { UTEXOWallet } = require('@utexo/rgb-sdk');

const wallet = new UTEXOWallet(keys.mnemonic, {
  network: 'testnet'
});
await wallet.initialize();
console.log('Wallet initialised successfully');

const address = await wallet.getAddress();
console.log('Deposit address:', address);

// num: number of UTXOs to create
// size: size of each UTXO in satoshis
await wallet.createUtxos({ num: 5, size: 1000 });
await wallet.refreshWallet();
console.log('UTXOs created and wallet synced');

// List known assets to find the USDT asset ID
const assets = await wallet.listAssets();
console.log('Available assets:', JSON.stringify(assets, null, 2));

// The USDT asset ID will look like:
// "rgb:2dkSTbr-jFhznbPmo-TQafzswCN-av2UEe9m2-LnFCMMG9-M9vByXo"
const usdtAssetId = assets.find(a => a.ticker === 'USDT')?.id;
console.log('USDT Asset ID:', usdtAssetId);

// Run this on the RECEIVER's wallet
const receiveData = await wallet.blindReceive({
  assetId: usdtAssetId,   // RGB asset ID from Step 6
  amount: 100,             // Amount in asset base units (1 USDT = 1 unit)
  minConfirmations: 1,     // Minimum Bitcoin confirmations before the transfer is accepted
  durationSeconds: 3600    // Invoice expiry: 3600 seconds = 1 hour
});
console.log('RGB Invoice:', receiveData.invoice);
// Share receiveData.invoice with the sender

// Run this on the SENDER's wallet (must hold USDT on Bitcoin balance)
const sendResult = await wallet.send({
  invoice: receiveData.invoice, // Invoice string from Step 7
  assetId: usdtAssetId,         // Must match the asset ID in the invoice
  amount: 100                   // Must match the amount in the invoice
});
console.log('Transfer TXID:', sendResult.txid);
console.log('Transfer status:', sendResult.status);

// Sync both wallets after the transfer
await wallet.refreshWallet();        // Sender
await receiverWallet.refreshWallet(); // Receiver (run on receiver's side)

// Check receiver's balance
const receiverAssets = await receiverWallet.listAssets();
console.log('Receiver assets:', JSON.stringify(receiverAssets, null, 2));

// Check sender's remaining BTC balance
const senderBtcBalance = await wallet.getBtcBalance();
console.log('Sender BTC balance (satoshis):', senderBtcBalance);

// Receiver: create a Lightning invoice (BTC-only)
const inv = await receiverWallet.createLightningInvoice({
  amountSats: 3000,
  expirySeconds: 900,
  asset: { assetId: '', amount: 0 }, // set assetId + amount for RGB-asset payments
});

// Sender: pay the invoice
const result = await senderWallet.payLightningInvoice({
  lnInvoice: inv.lnInvoice,
});

// Poll until settled
const payment = await senderWallet.getLightningSendRequest(result.txid);
console.log('Payment status:', payment.status); // 'Settled' when complete

// Get a Bitcoin deposit address for on-chain funding
const address = await wallet.getAddress();
console.log('Deposit address:', address);

// Receiver: generate a blinded RGB invoice for on-chain receipt
const receiveData = await receiverWallet.blindReceive({
  minConfirmations: 1,
  durationSeconds: 3600,
});

// Sender: broadcast an on-chain RGB transfer
await senderWallet.send({
  invoice: receiveData.invoice,
  assetId: usdtAssetId,
  amount: 100,
  donation: false,
  feeRate: 7,
  minConfirmations: 1,
});

// Both parties sync state
await senderWallet.refreshWallet();
await receiverWallet.refreshWallet();