Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.cloak.ag/llms.txt

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

Cloak is a privacy stack on Solana built around a shielded UTXO model and zero-knowledge proofs. It has three public surfaces:
  • SDK (@cloak.dev/sdk) for proof generation, tx building, and scanning
  • Shield Pool program for on-chain verification and state transitions
  • Circuit package for Groth16 artifact generation and verifier-key export

​
Use cases

​
Private Treasury Flows

Run deposits, transfers, withdrawals, and swaps with shielded state transitions while keeping verifiable protocol guarantees on-chain. Designed for: treasury teams, privacy-focused wallets, protocol operators

​
Compliance-Aware Privacy Apps

Build products that keep user transaction details private by default, while still supporting controlled compliance export paths via registered viewing keys. Designed for: regulated apps, custody workflows, institutional operators

​
What Cloak optimizes for

  • Privacy-preserving transfers and withdrawals with deterministic verification
  • Cross-surface consistency across SDK, program, and circuit layers
  • Operational reliability through retries, queueing, and root/index recovery
  • Compliance-friendly history scanning via viewing keys and chain-note envelopes

​
Capabilities

  • Shielded UTXO Runtime: 2-in/2-out proof-constrained transactions with nullifier-based spend protection.
  • Chain-Native Compliance: encrypted chain notes, viewing-key registration, and controlled compliance workflows.
  • Operational Tooling: circuits build/publish pipeline for verifier artifact consistency.

​
Integration starting points

Build with SDK

Use TypeScript APIs for deposit, transfer, withdraw, swap, and scanning.

Read Code Examples

Use concise snippets for send, swap, payroll, and history.

Understand Runtime Flows

Follow end-to-end behavior from client request to on-chain finalization.

Review Program Rules

See instruction-level constraints, account model, and fee enforcement.

Security Model

Review trust boundaries, key handling, and failure containment.