Attestor docs

[hadi-saleh14]

Description

• Added docs for attestor contracts management.

Type of change

• New feature

Summary by CodeRabbit

• Documentation
  • Added new guides detailing decentralized contract architecture, staking requirements, and the proof generation process.
  • Introduced an overview of multi-attestor verification, privacy-enhancing proxy services, and economic incentives.
  • Provided clear instructions for local setup and testing of decentralized attestor functionality.
  • Updated the documentation structure to include these new resources.

[vercel]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
docs	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Mar 19, 2025 10:07am

[coderabbitai]

Caution

Review failed

The pull request is closed.

Walkthrough

This pull request adds new documentation and metadata updates for the Reclaim protocol’s decentralized attestor system. It introduces documentation on the core smart contracts, decentralized proof processes, attestor local development, and metadata organization. Additionally, it reorganizes the documentation structure by updating the pages list in the main metadata file.

Changes

File(s)	Change Summary
content/docs/attestor-decentralization/attestor-contracts.mdx, content/docs/attestor-decentralization/index.mdx, content/docs/attestor-decentralization/local-development.mdx	New documentation files added: an overview of Attestor Contracts (smart contracts, consensus, staking, PoP process), a description of the Reclaim Protocol Attestors (decentralized attestation, token staking, penalties), and a guide for local attestor development.
content/docs/attestor-decentralization/meta.json	New JSON metadata file created with a title and a pages array listing “local-development” and “attestor-contracts”.
content/docs/meta.json	Updated the pages array by replacing the "advance-options" entry with "attestor-decentralization" to reflect new content focus.

Sequence Diagram(s)

sequenceDiagram
    participant U as User
    participant TC as Task Contract
    participant A as Attestor
    participant GC as Governance Contract
    
    U ->> TC: Submit Claim Task Request
    TC ->> A: Initiate zkTLS protocol to request proof
    A ->> TC: Return generated proof
    TC ->> TC: Validate proof and achieve consensus
    TC ->> GC: Trigger staking, rewards, and penalties logic
    GC -->> U: Finalize proof verification and update status

Loading

Suggested reviewers

• adithyaakrishna
• Karam19
• AbdulRashidReshamwala

Poem

I'm a bunny hopping through lines of code,
New docs sprout like carrots in a vibrant mode.
Smart contracts and attestors come into play,
With zk proofs leading the merry ballet.
Metadata blossoms in structured array,
I celebrate these changes in a joyful rabbit way!
🐰🥕

Tip

⚡🧪 Multi-step agentic review comment chat (experimental)

• We're introducing multi-step agentic chat in review comments. This experimental feature enhances review discussions with the CodeRabbit agentic chat by enabling advanced interactions, including the ability to create pull requests directly from comments.
  - To enable this feature, set early_access to true under in the settings.

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 23cac2b and 773a260.

📒 Files selected for processing (5)

• content/docs/attestor-decentralization/attestor-contracts.mdx (1 hunks)
• content/docs/attestor-decentralization/index.mdx (1 hunks)
• content/docs/attestor-decentralization/local-development.mdx (1 hunks)
• content/docs/attestor-decentralization/meta.json (1 hunks)
• content/docs/meta.json (1 hunks)

---

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.