Skip to content

chore: update docs#153

Merged
JoE11-y merged 1 commit into
mainfrom
feat/ui-updates
May 9, 2026
Merged

chore: update docs#153
JoE11-y merged 1 commit into
mainfrom
feat/ui-updates

Conversation

@JoE11-y
Copy link
Copy Markdown
Contributor

@JoE11-y JoE11-y commented May 9, 2026

Summary by CodeRabbit

  • Documentation
    • Updated Merkle/Computation Validation documentation to clarify how cross-chain ZK proofs are validated.
    • Refined descriptions of security properties, including zero-knowledge attestation, nullifier system, and encrypted state.
    • Improved explanations of on-chain SNARK attestation processes for authorization and deposits circuits.

Review Change Stack

@vercel
Copy link
Copy Markdown

vercel Bot commented May 9, 2026

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

Project Deployment Actions Updated (UTC)
proof-bridge-dashboard Ready Ready Preview, Comment May 9, 2026 4:10pm
proof-bridge-frontend Building Building Preview, Comment May 9, 2026 4:10pm
proof-bridge-status Building Building Preview, Comment May 9, 2026 4:10pm

@JoE11-y JoE11-y merged commit f261024 into main May 9, 2026
6 of 9 checks passed
@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented May 9, 2026

Caution

Review failed

The pull request is closed.

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: eba47205-8e2c-48f3-81c3-1c45b732f3f2

📥 Commits

Reviewing files that changed from the base of the PR and between 9336e4f and 9e5e05d.

📒 Files selected for processing (4)
  • README.md
  • apps/backend-relayer/README.md
  • proof_circuits/auth/README.md
  • proof_circuits/deposits/README.md

📝 Walkthrough

Walkthrough

This PR updates documentation across four README files to clarify the cross-chain ZK proof verification architecture. The root README, deposits circuit, auth circuit, and relayer documentation are revised to specify fixed-size attestations, concrete security mechanisms (nullifier-based double-spend prevention, stale-root rejection, forgery resistance), and on-chain verification semantics.

Changes

Cross-Chain Proof Verification Documentation

Layer / File(s) Summary
Main Architecture Overview
README.md
Cross-chain verification clarified: destination-chain verifier contracts validate a single fixed-size proof payload (14,592 bytes) containing deposit-state attestation, eliminating need for native source-chain state access.
Deposits Circuit Documentation
proof_circuits/deposits/README.md
Circuit description rewritten to define cross-chain attestation purpose (MMR inclusion + nullifier derivation + side-binding). Security section replaced with concrete mechanisms: on-chain nullifier_hash recording for double-spend prevention, ad_contract side-binding, public target_root validation for stale-root rejection, and Poseidon2-based forgery resistance.
Auth Circuit Documentation
proof_circuits/auth/README.md
Intro reframed to document on-chain-verifiable SNARK attestation for trade authorization. Verification logic clarified: on-chain verifier checks fixed-size proof against signature-hash commitment without re-running ECDSA, rather than proving authorization while hiding the signature.
Relayer Security Documentation
apps/backend-relayer/README.md
Security bullets updated: destination-chain direct proof verification, one-time-use nullifier semantics, and encrypted-at-rest trade parameters reframed as backend concern distinct from ZK properties.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Suggested reviewers

  • Ugo-X

Poem

🐰 Four docs align in harmony,
Cross-chain proofs now clear as can be—
Attestations bound, security sound,
From source to dest, no secrets found!
Nullifiers keep the replays at bay,
Documentation lights the way! 🌟

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch feat/ui-updates

Tip

💬 Introducing Slack Agent: The best way for teams to turn conversations into code.

Slack Agent is built on CodeRabbit's deep understanding of your code, so your team can collaborate across the entire SDLC without losing context.

  • Generate code and open pull requests
  • Plan features and break down work
  • Investigate incidents and troubleshoot customer tickets together
  • Automate recurring tasks and respond to alerts with triggers
  • Summarize progress and report instantly

Built for teams:

  • Shared memory across your entire org—no repeating context
  • Per-thread sandboxes to safely plan and execute work
  • Governance built-in—scoped access, auditability, and budget controls

One agent for your entire SDLC. Right inside Slack.

👉 Get started


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

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant