Skip to main content

Read balances

Filter by token:

Read transactions

Transaction status

deposit(), transfer(), and withdraw() return a TransactionHandle with txId, status, txHash, and wait(). status is the backend processing state. The wait result also includes confirmationStatus, the user-facing lifecycle state, and fundsUsable. Public lifecycle states:
  • pending: preparing, proving, or waiting for an on-chain hash.
  • relayed: submitted on chain, but private effects are not observed yet.
  • confirmed: receipt or indexed evidence has observed the transaction effects, and those effects are visible to API reads.
  • processed: durable state persistence has completed.
  • failed: terminal failure.
By default, wait() resolves at user-facing confirmation (confirmed, processed, or failed). It does not wait for durable canonical processing unless you ask for it.
Wait for durable canonical processing when a backend reliability check needs finality:
finalized is an alias for backend processed, which is reached at the configured canonical boundary. If you already have a transaction ID, poll directly:
Polling throws TimeoutError if the timeout elapses before the selected wait target. See Error handling.

Backend reads

Use admin reads for backend dashboards and support tooling, and the user client for signed actions.
Call admin.users.register(payload) from your backend when a browser or server client registers. See Custody models for how the admin client is wired.