Skip to main content

Documentation Index

Fetch the complete documentation index at: https://umbra.0xcreator.dev/llms.txt

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

umbra utxo claim [options]
Scans for claimable UTXOs and claims them in a single step. Internally it runs the same scan as utxo scan, then generates ZK proofs and submits claim transactions for every UTXO it finds. Claimed UTXOs are deposited into your encrypted balance by default. Pass --to public to claim self-claimable UTXOs to your public ATA instead.
Received UTXOs (sent by another user) always go to your encrypted balance, regardless of --to.

​
Options

FlagDefaultDescription
--tree <n>0First Merkle tree index to scan
--endTree <n>Same as --treeLast Merkle tree index to scan (inclusive)
--allTreesfalseScan all trees starting from --tree until no more are found
--start <n>0Start insertion index (inclusive)
--end <n>End of treeEnd insertion index (inclusive)
--pageSize <n>Entire rangeInsertion indices per indexer request
--to <destination>encryptedClaim destination for self-claimable UTXOs: encrypted or public
--relayer <url>Umbra devnet relayerRelayer API endpoint used to submit claim transactions

​
Examples

# Scan tree 0 and claim everything found into your encrypted balance
umbra utxo claim

# Claim to your public wallet instead
umbra utxo claim --to public

# Scan all trees and claim
umbra utxo claim --allTrees

# Continue from a known position
umbra utxo claim --tree 2 --start 1500

# Mainnet with a custom relayer
umbra utxo claim --relayer https://relayer.api.umbraprivacy.com

​
Output

✓ Claimed 3 UTXOs
  Batch 0: finalized — 5KtP...vXm2
  Batch 1: finalized — 9aQr...nM4k
Each batch corresponds to a group of UTXOs processed together. The transaction signature and final status are shown per batch.

​
Prerequisites

  • A user must be added and active (umbra user add), and indexerApiEndpoint must be set (umbra config set indexerApiEndpoint <url>).
  • umbra register must have been run (both --confidential and --anonymous for full support).
  • For --to public: the destination ATA must already exist for each claimed mint.