Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.kaleidoswap.com/llms.txt

Use this file to discover all available pages before exploring further.

​
Before You Start

These command groups require an active and unlocked node: 
kaleido node use default
kaleido node unlock

​
BTC Wallet

​
Common wallet commands

CommandPurpose
kaleido wallet addressGenerate a new on-chain BTC deposit address
kaleido wallet balanceShow BTC balance
kaleido wallet send <amount> <address>Send on-chain BTC
kaleido wallet utxosList UTXOs
kaleido wallet create-utxosCreate colored UTXOs for RGB operations
kaleido wallet transactionsList on-chain transactions
kaleido wallet estimate-feeEstimate the on-chain fee rate
kaleido wallet backup <path>Create an encrypted wallet backup
kaleido wallet restore <path>Restore from a backup archive
kaleido wallet change-passwordRotate the wallet password

​
Examples

kaleido wallet address
kaleido wallet balance
kaleido wallet send 50000 bc1q...
kaleido wallet create-utxos --num 10 --size 3000

​
Backup and restore

kaleido wallet backup ~/kaleido-backup.zip
kaleido wallet restore ~/kaleido-backup.zip
Both commands accept --password. Restore overwrites the current node data, so use it deliberately.

​
RGB Assets

​
Core asset commands

CommandPurpose
kaleido asset listList assets held by the node
kaleido asset balance <asset-id>Show balance for one asset
kaleido asset metadata <asset-id>Show asset metadata
kaleido asset invoice <asset-id>Create an RGB invoice
kaleido asset send <asset-id> <amount> <invoice>Send RGB assets
kaleido asset send-batchSend to multiple RGB recipients in one transaction
kaleido asset transfers <asset-id>Inspect transfer history
kaleido asset refreshRefresh pending transfers
kaleido asset syncSynchronize the RGB wallet
kaleido asset fail-transfersMark pending transfers as failed
kaleido asset mediaFetch asset media bytes by file digest

​
Issue new assets

The issue subgroup supports the three supported schemas: 
kaleido asset issue nia --name "MyToken" --ticker MTK --supply 21000000
kaleido asset issue cfa --name "Art Piece" --supply 100 --file ./art.png
kaleido asset issue uda --name "Ticket #1" --file ./ticket.png
Use:
  • nia for fixed-supply fungible assets
  • cfa for collectible fungible assets
  • uda for unique digital assets

​
Asset invoice and send examples

kaleido asset invoice rgb:abc123... --amount 500 --duration 3600
kaleido asset send rgb:abc123... 100 rgb:invoice...
Notable asset send options:
  • --fee-rate
  • --min-confirmations
  • --donation
  • --transport-endpoint
  • --skip-sync

​
Lightning And RGB+LN Payments

​
Payment commands

CommandPurpose
kaleido payment invoiceCreate a BOLT11 invoice
kaleido payment send <invoice>Pay a Lightning invoice
kaleido payment listList payments
kaleido payment status <payment-hash>Inspect payment state
kaleido payment decode <invoice>Decode a Lightning or RGB invoice
kaleido payment invoice-status <invoice>Check invoice state
kaleido payment keysendSend a spontaneous Lightning payment

​
Examples

# BTC invoice
kaleido payment invoice --amount-msat 10000

# RGB+LN invoice
kaleido payment invoice --asset-id rgb:abc... --asset-amount 500

# Pay an invoice
kaleido payment send lnbc...

# Decode a received invoice
kaleido payment decode rgb:...
When paying zero-amount invoices, provide --amount-msat. For RGB+LN payments, supply --asset-id and --asset-amount.

​
Working Style

  • Use --json when you need machine-readable responses.
  • Use --skip-sync only when stale wallet or transfer state is acceptable.
  • Create extra UTXOs before heavy RGB activity to avoid running out of usable colored outputs.
See Channels And LSP Flows next if you are managing channels or ordering inbound liquidity.