Wallet, Assets, And Payments

Before You Start

These command groups require an active and unlocked node:

kaleido node use default
kaleido node unlock

Units on this page. wallet amounts are satoshis, and asset and payment amounts are raw integer units, where the asset’s precision decides the conversion — check it with kaleido asset metadata <asset-id>. Display amounts such as --from-amount 0.001 appear only on market and swap commands.

BTC Wallet

Common wallet commands

Command	Purpose
`kaleido wallet address`	Generate a new on-chain BTC deposit address
`kaleido wallet balance`	Show BTC balance
`kaleido wallet send <amount> <address>`	Send on-chain BTC
`kaleido wallet utxos`	List UTXOs
`kaleido wallet create-utxos`	Create colored UTXOs for RGB operations
`kaleido wallet transactions`	List on-chain transactions
`kaleido wallet estimate-fee`	Estimate 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-password`	Rotate the wallet password
`balance`, `utxos`, and `transactions` accept `--skip-sync` to return cached state without syncing first.

Examples

kaleido wallet address
kaleido wallet balance
kaleido wallet send 50000 bc1q... --fee-rate 2
kaleido wallet estimate-fee --blocks 6

Colored UTXOs

RGB assignments live on specific Bitcoin outputs, so the node needs spare UTXOs before it can issue, receive, or send an asset:

kaleido wallet create-utxos --num 10 --size 3000

Option	Purpose
`--num`, `-n`	How many UTXOs to create
`--size`	Size of each UTXO in satoshis
`--up-to`	Treat `--num` as a total to top up to, rather than a count to add
`--fee-rate`	On-chain fee rate in sat/vbyte
`--skip-sync`	Skip the blockchain sync before creating them

Backup and restore

kaleido wallet backup ~/kaleido-backup.zip
kaleido wallet restore ~/kaleido-backup.zip
kaleido wallet change-password --old-password <old> --new-password <new>

backup and restore both accept --password, -p. Restore overwrites the current node data, so use it deliberately.

RGB Assets

Core asset commands

Command	Purpose
`kaleido asset list`	List 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-batch <json-file>`	Send to multiple RGB recipients in one transaction, from a JSON file
`kaleido asset transfers <asset-id>`	Inspect transfer history
`kaleido asset refresh`	Refresh pending transfers
`kaleido asset sync`	Synchronize the RGB wallet
`kaleido asset fail-transfers`	Mark pending transfers as failed
`kaleido asset media`	Fetch 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 --ticker TKT1 --name "Ticket #1" --file ./ticket.png

Use:

nia for fixed-supply fungible assets
cfa for collectible fungible assets
uda for unique digital assets

All three accept --precision for the number of decimal places, and --supply is expressed in the smallest raw unit. cfa and uda also accept --description.

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
--witness-amount-sat and --witness-blinding
--skip-sync

Batch sends

asset send-batch takes a path to a JSON file describing the recipients, not inline flags:

kaleido asset send-batch ./transfers.json

Keeping transfers moving

kaleido asset refresh
kaleido asset sync
kaleido asset transfers rgb:abc123...

Run refresh to advance pending transfers and sync to resynchronise the RGB wallet. Only when a transfer is genuinely dead should you release its allocations with kaleido asset fail-transfers, which accepts --batch-idx to target one batch, --no-asset-only to limit it to transfers with no asset, and --skip-sync.

Lightning And RGB+LN Payments

Payment commands

Command	Purpose
`kaleido payment invoice`	Create a BOLT11 invoice
`kaleido payment send <invoice>`	Pay a Lightning invoice
`kaleido payment list`	List 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 keysend`	Send 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, or Troubleshooting if a balance, transfer, or send is not behaving.

Introduction

Node Operations

Channels & Trading

Reference

Before You Start

BTC Wallet

Common wallet commands

Examples

Colored UTXOs

Backup and restore

RGB Assets

Core asset commands

Issue new assets

Asset invoice and send examples

Batch sends

Keeping transfers moving

Lightning And RGB+LN Payments

Payment commands

Examples

Working Style

​Before You Start

​BTC Wallet

​Common wallet commands

​Examples

​Colored UTXOs

​Backup and restore

​RGB Assets

​Core asset commands

​Issue new assets

​Asset invoice and send examples

​Batch sends

​Keeping transfers moving

​Lightning And RGB+LN Payments

​Payment commands

​Examples

​Working Style

Before You Start

BTC Wallet

Common wallet commands

Examples

Colored UTXOs

Backup and restore

RGB Assets

Core asset commands

Issue new assets

Asset invoice and send examples

Batch sends

Keeping transfers moving

Lightning And RGB+LN Payments

Payment commands

Examples

Working Style