chore: update sdk docs

[hmzakhalid]

Summary by CodeRabbit

• New Features

  • Enhanced React hook with additional fields for improved error handling and utility access
  • Added generateProof method to create ZK proofs directly from circuit inputs
  • Added public client access through getPublicClient capability

• Documentation

  • Expanded documentation for event types and utility exports with detailed descriptions

• Refactor

  • Updated encryption API to use circuitInputs nomenclature for clarity

[vercel]

The latest updates on your projects. Learn more about Vercel for GitHub.

Project	Deployment	Actions	Updated (UTC)
enclave-docs	Building	Preview, Comment	Mar 12, 2026 5:54pm

1 Skipped Deployment

Project	Deployment	Actions	Updated (UTC)
crisp	Skipped		Mar 12, 2026 5:54pm

[coderabbitai]

Caution

Review failed

The pull request is closed.

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: 01eb5b04-3ad6-468b-a099-c6edb67ed47e

📥 Commits

Reviewing files that changed from the base of the PR and between ba7e131 and 42077e9.

📒 Files selected for processing (2)

• docs/pages/sdk.mdx
• packages/enclave-contracts/scripts/utils.ts

---

📝 Walkthrough

Walkthrough

This PR updates SDK documentation to reflect recent API surface changes: useEnclaveSDK hook now returns additional fields (sdk, error, getThresholdBfvParamsSet, RegistryEventType), encryptNumberAndGenInputs returns circuitInputs instead of publicInputs, and new generateProof() and getPublicClient() methods are documented. Minor formatting adjustments in contract scripts.

Changes

Cohort / File(s)	Summary
SDK Documentation docs/pages/sdk.mdx	Updated React hook API documentation for useEnclaveSDK with new return fields and error handling; renamed encryption API return value from publicInputs to circuitInputs; documented new generateProof() and getPublicClient() methods; added event type and utility export documentation.
Contract Scripts packages/enclave-contracts/scripts/utils.ts	Reformatted conditional blocks and multi-line string templates in updateE3Config for improved readability; no runtime logic changes.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~12 minutes

Possibly related PRs

• #831 — Introduces the core API changes to useEnclaveSDK and EnclaveSDK methods that are being documented in this PR (new return fields, renamed encrypt API, added generateProof/getPublicClient).
• #1388 — Refactor that relies on the SDK API surface changes documented here, particularly the useEnclaveSDK hook modifications and method signatures.

Suggested labels

documentation

Suggested reviewers

• cedoor
• ctrlc03
• ryardley

Poem

🐰 A doc so fine, now crystal clear,
With APIs new, for all to cheer!
CircuitInputs dance, proofs take flight,
The SDK shines in documented light! ✨

✨ Finishing Touches

• 📝 Generate docstrings (stacked PR)
• 📝 Generate docstrings (commit on current branch)

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch chore/update-docs-vt0.0.1

📝 Coding Plan

• Generate coding plan for human review comments

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}