Umbra SDK Documentation
Entry point for the @classes, @client, @functions, and @type-aliases references.
Welcome to the Umbra SDK reference. The documentation is generated straight from the TypeScript source, then organised into four focused collections so you can locate symbols by intent instead of guessing file paths.
@classes
High-level clients, forwarders, provers, and error surfaces.
@functions
Standalone helpers for serialization, randomness, and PDA derivation.
@type-aliases
Branded primitives that keep Umbra interactions type-safe.
How to use these docs
- Browse by namespace: Use the sidebar tree (now populated with clean titles and descriptions) to hop between classes, functions, and aliases.
- Search globally: The search modal indexes every page with the new metadata, so symbol lookups behave like your IDE.
- Trace sources: Each page links back to the exact file and line in
github.com/umbra-defi/sdk-prime, making it easy to audit behaviour.
Need inspiration? Start with @client to see how higher-level flows are wired,
then follow the links into @classes, @functions, or @type-aliases for the
underlying building blocks.