Umbra SDK Docs

@type-aliases

Branded primitive types that keep Umbra SDK calls type-safe.

Umbra relies heavily on branded aliases to prevent mixing raw numbers, byte arrays, and Solana identifiers. The aliases in this folder double as living documentation for every typed value that flows between the client, relayer, and on-chain programs.

Common categories

  • Addresses & PDAs: ProgramDerivedAddress, SolanaAddress, MintAddress, and their transaction-input variants.
  • Timing & scheduling: Slot, Second, Minute, Hour, Day, Month, and Year, alongside corresponding *TransactionInput helpers.
  • Big number primitives: Unsigned (U8U256) and signed (I8I256) widths plus endian-specific byte arrays.
  • Cryptography: PoseidonHash, RescueCiphertext, Groth16Proof*, and Sha3Hash.

How to use this section

  1. Find the alias you need via the sidebar or global search.
  2. Copy the branded type name directly into your TypeScript code to get compile-time guarantees.
  3. Follow the “Defined in” links on each page to inspect the precise source.

Pair these aliases with the conversion helpers under @functions to move data between application state, zero-knowledge circuits, and Solana transactions without losing type safety.