Skip to content
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

feat(refactor) - code refactoring and generalization #22

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

Conversation

ctrlc03
Copy link
Collaborator

@ctrlc03 ctrlc03 commented Sep 8, 2023

  • Add admin only endpoint to add a new circuit config (zkey and wasm)
  • Add endpoint to generate multiple proofs at once
  • Refactor single proof generation endpoint to spawn a new go routines safely
  • Add DB support (postgres) to store data to a DB
  • Add endpoint to get the registered circuits details
  • Add endpoint to get multiple proofs results for one circuit
  • Add endpoint to get multiple proofs results for multiple circuits
  • Add endpoint to dump all available proofs from the DB
  • Generalize API to support any circuit
  • Add TLS support
  • Add new demo cli commands

…ests, generalize code to accept multiple circuits and param configurations
@ctrlc03 ctrlc03 requested a review from baumstern September 8, 2023 14:17
@ctrlc03 ctrlc03 self-assigned this Sep 8, 2023
@ctrlc03 ctrlc03 linked an issue Sep 8, 2023 that may be closed by this pull request
11 tasks
@samajammin
Copy link
Member

What's the status on this PR? @gurrpi have you reviewed?

@baumstern
Copy link
Member

baumstern commented Oct 16, 2023

What's the status on this PR? @gurrpi have you reviewed?

Beginning a review now, noting the PR's extensive scope and the need for a design evaluation.

@baumstern
Copy link
Member

@ctrlc03 thank you for your patience. I'm now beginning a review of this PR. A few high-level concerns before code review:

  1. Size: The PR is large, making it difficult for an effective review. Could it be broken down into smaller, more manageable parts?
  2. Design Alignment: The PR suggests a broader generalization, moving away from our current MACI-centric focus. A separate design discussion is needed to align it with our project's existing goals and documentation (PO doc, Design doc.
    2.1. Project Focus: We should clarify if we aim to create a library that can be used broadly by zk developers, or if our focus is on building services specifically for MACI application developers.
  3. Isolated Features: Elements like the zkey downloading feature could be isolated and submitted as separate PRs. This could also address our current issue with the Docker image size.
  4. Use-Cases and Implementation Strategy: Implementation strategies will differ depending on use-cases and request patterns (e.g., I/O-intensive vs. computation-intensive), making complete generalization challenging.

Please clarify these before we proceed.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Refactor coordinator service to be persistent and create proofs concurrently
3 participants