Umbra SDK Docs

@classes

Umbra SDK clients, forwarders, provers, and error types.

The Umbra SDK exposes a rich collection of classes for orchestrating privacy flows, forwarding transactions, and surfacing granular errors. Everything in this folder comes directly from the auto-generated API reference, so each page includes constructor signatures, method docs, and source links.

Start with the core clients

  • UmbraClient – high-level entry point that manages keys, proofs, and network connectivity on behalf of the app.
  • UmbraWallet – wallet facade for handling deposits, transfers, and encrypted balances.
  • ConnectionBasedForwarder and RelayerForwarder – concrete strategies for submitting transactions either directly or through the relayer service.

Cryptography and proving

  • WasmZkProver implements the WASM-based Groth16 prover.
  • RescueCipher documents encryption helpers that back the Rescue-based message flow.
  • Poseidon* classes cover hashing, constants, and parameter validation.

Error classes

All operational surfaces ship with typed errors, grouped by namespace. A few useful entry points:

Need a specific type? Use the sidebar search or the browser’s find shortcut while browsing this directory. Every class page now has clean titles and metadata, so search and deep links work as expected.