Skip to content

docs: add research document on how to handle asyncrony with zk recursion #8

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

hxrts
Copy link

@hxrts hxrts commented Mar 20, 2025

Made this mainly to sharpen my understanding of how this flow would work, but figured it would be nice to have as a shared document.

Review is low priority.

Summary by CodeRabbit

  • Documentation
    • Introduced a new guide on asynchronous interaction patterns using recursive zero-knowledge computations.
    • The document explains how off-chain computations are verifiably anchored on-chain.
    • It features detailed walkthroughs, sequence diagrams, and tables illustrating interaction flows and verification roles.

@hxrts hxrts requested review from vlopes11 and uditvira March 20, 2025 23:41
Copy link

coderabbitai bot commented Mar 20, 2025

Walkthrough

This change introduces a new documentation file that explains an asynchronous interaction pattern using recursive zero-knowledge (ZK) computations. The document details a system where a dedicated ZK coprocessor handles recursive computations, proof generation, and blockchain submissions. It outlines a step-by-step flow starting from an on-chain commitment through multiple off-chain computations, culminating with user and trader interactions, and includes diagrams and tables describing roles, conditions, and verification processes.

Changes

File Change Summary
docs/concept_001_async_recursive_zk.md Added new document detailing recursive ZK computation models with off-chain computations, on-chain anchoring, proof generation, updated zk-nonce values, and associated actor roles. Includes a sequence diagram and tables outlining actor discretion, information asymmetries, and a provability matrix.

Sequence Diagram(s)

sequenceDiagram
    participant BC as Blockchain
    participant CoOp as Coprocessor Operator
    participant U as User
    participant T as Trader

    U->>BC: Submit on-chain commitment
    BC->>CoOp: Trigger recursive ZK computation
    CoOp->>CoOp: Perform computations & update zk-nonce
    CoOp->>BC: Submit proof and updated state
    BC->>U: Request signed transaction (market price trigger)
    U->>BC: Send signed transaction
    BC->>T: Notify trader of final transaction
Loading

Poem

I'm a rabbit with a hop so bright,
New ZK flows make my day feel light,
Off-chain proofs and on-chain cheer,
Recursion and proofs, oh so clear!
Hopping along in code so free,
Celebrating changes with a joyful spree!
🐇✨


📜 Recent review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between b3efea0 and 850cb81.

📒 Files selected for processing (1)
  • docs/concept_001_async_recursive_zk.md (1 hunks)

Note

🎁 Summarized by CodeRabbit Free

Your organization has reached its limit of developer seats under the Pro Plan. For new users, CodeRabbit will generate a high-level summary and a walkthrough for each pull request. For a comprehensive line-by-line review, please add seats to your subscription by visiting https://app.coderabbit.ai/login.If you believe this is a mistake and have available seats, please assign one to the pull request author through the subscription management page using the link above.

🪧 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 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.

@hxrts hxrts added the documentation Improvements or additions to documentation label Mar 21, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant