Skip to content

AGENTS.md

Latest commit

 

History

History
36 lines (26 loc) · 1.44 KB

AGENTS.md

File metadata and controls

36 lines (26 loc) · 1.44 KB
Raw

Opaque documentation (Mintlify)

About

  • Mintlify site for Opaque Protocol (@opaquecash/opaque SDK)
  • Pages are MDX with YAML frontmatter; config in docs.json
  • Remote: https://github.com/opaquecash/docs (Mintlify GitHub app deploys main automatically; PRs get preview deployments)

Terminology

  • OpaqueClient: unified SDK class; document methods, not low-level chain packages unless in utilities
  • Meta-address: 66-byte EIP-5564 stealth meta-address
  • PSR: Provable Stealth Reputation (schemas, attestations, ZK proofs)
  • UAB: Universal Announcement Bus (Wormhole cross-chain)
  • WASM: cryptography.js from opaque-scanner; required for scan/sweep/prove

Style

  • Active voice, second person
  • No em dashes anywhere; use commas, colons, parentheses, or separate sentences
  • Every SDK method: signature, params, return type, signer/WASM requirements, runnable example
  • Link to guides for E2E flows; link to opaquecash/spec for protocol details
  • Self-host WASM (/pkg/cryptography.js); do not recommend the opaque.cash CDN for production

Content boundaries

  • Document the public OpaqueClient API, @opaquecash/react, and re-exported utilities
  • sdk/api/ is generated by TypeDoc (npm run docs:api in the sdk repo); never edit it by hand
  • Do not duplicate full CSAP/PSR/UAB specs; link to GitHub
  • Note limitations (no ERC-20/SPL stealth sends yet, relayer required for UAB delivery)

Local dev

mint dev