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: New prover documentation #2466

Merged
merged 3 commits into from
Jul 26, 2024
Merged

feat: New prover documentation #2466

merged 3 commits into from
Jul 26, 2024

Conversation

popzxc
Copy link
Member

@popzxc popzxc commented Jul 23, 2024

New prover documentation.

Rendered form is recommended, as it's easier to view.

Additionally, does the following:

  • Introduces ordering for advanced guides (it was a mix, not it's more or less sorted and suggests an order for reading).
  • Fixes a few things in the setup-dev.md.
  • Creates a prover-local config profile, so that no manual interactions with configs are needed.
  • Gets rid of prover/setup.sh as it's no longer needed that much.

@popzxc popzxc requested review from EmilLuta and mm-zk July 23, 2024 13:41
@popzxc popzxc force-pushed the popzxc-new-prover-docs branch from 3ca1c2b to 3f2e75f Compare July 23, 2024 13:42
@popzxc popzxc force-pushed the popzxc-new-prover-docs branch from 3f2e75f to 79d9ea2 Compare July 23, 2024 13:54
mm-zk
mm-zk previously approved these changes Jul 23, 2024
prover/docs/00_intro.md Show resolved Hide resolved
prover/docs/00_intro.md Outdated Show resolved Hide resolved
prover/docs/01_gcp_vm.md Show resolved Hide resolved
prover/docs/01_gcp_vm.md Outdated Show resolved Hide resolved
prover/docs/03_launch.md Show resolved Hide resolved
@pbeza
Copy link
Collaborator

pbeza commented Jul 23, 2024

I'm not very familiar with the prover setup, but I just want to give a heads up to ensure you are aware that, ideally, we probably want to be able to optionally enable or disable the SGX prover (or other types of TEE provers) alongside the regular one. So it would be nice if the setup was flexible enough to handle that. Not sure if that's something to be concerned about in this PR, though. cc @haraldh

Copy link
Contributor

@EmilLuta EmilLuta left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is outstanding work. I've added a bunch of nits here and there, mostly terminology. Thanks for taking the time!

prover/crates/bin/prover_fri/README.md Outdated Show resolved Hide resolved
prover/crates/bin/prover_fri/README.md Outdated Show resolved Hide resolved
prover/docs/00_intro.md Outdated Show resolved Hide resolved
prover/docs/00_intro.md Outdated Show resolved Hide resolved
prover/docs/00_intro.md Outdated Show resolved Hide resolved
prover/docs/04_flow.md Outdated Show resolved Hide resolved
prover/docs/04_flow.md Show resolved Hide resolved
prover/docs/04_flow.md Outdated Show resolved Hide resolved
prover/docs/04_flow.md Show resolved Hide resolved
docs/guides/setup-dev.md Show resolved Hide resolved
@popzxc popzxc added this pull request to the merge queue Jul 26, 2024
Merged via the queue into main with commit 1b61d07 Jul 26, 2024
54 checks passed
@popzxc popzxc deleted the popzxc-new-prover-docs branch July 26, 2024 04:47
github-merge-queue bot pushed a commit that referenced this pull request Aug 2, 2024
🤖 I have created a release *beep* *boop*
---


##
[16.2.0](prover-v16.1.0...prover-v16.2.0)
(2024-08-02)


### Features

* **configs:** Do not panic if config is only partially filled
([#2545](#2545))
([db13fe3](db13fe3))
* Introduce more tracing instrumentation
([#2523](#2523))
([79d407a](79d407a))
* New prover documentation
([#2466](#2466))
([1b61d07](1b61d07))
* optimize LWG and NWG
([#2512](#2512))
([0d00650](0d00650))
* Poll the main node for the next batch to sign (BFT-496)
([#2544](#2544))
([22cf820](22cf820))
* Remove CI and docker images for CPU prover & compressor
([#2540](#2540))
([0dda805](0dda805))
* Remove unused VKs, add docs for BWG
([#2468](#2468))
([2fa6bf0](2fa6bf0))
* Support sending logs via OTLP
([#2556](#2556))
([1d206c0](1d206c0))
* Update to consensus 0.1.0-rc.4 (BFT-486)
([#2475](#2475))
([ff6b10c](ff6b10c))
* **vlog:** New vlog interface + opentelemtry improvements
([#2472](#2472))
([c0815cd](c0815cd))
* **witness_vector_generator:** Make it possible to run multiple wvg
instances in one binary
([#2493](#2493))
([572ad40](572ad40))
* **zk_toolbox:** use configs from the main repo
([#2470](#2470))
([4222d13](4222d13))


### Bug Fixes

* **prover:** Parallelize circuit metadata uploading for BWG
([#2520](#2520))
([f49720f](f49720f))
* **prover:** Reduce database connection overhead for BWG
([#2543](#2543))
([c2439e9](c2439e9))
* **witness_generator:** Only spawn 1 prometheus exporter per witness
generator
([#2492](#2492))
([b9cb222](b9cb222))


### Reverts

* "feat: Poll the main node for the next batch to sign (BFT-496)"
([#2574](#2574))
([72d3be8](72d3be8))

---
This PR was generated with [Release
Please](https://github.com/googleapis/release-please). See
[documentation](https://github.com/googleapis/release-please#release-please).

---------

Co-authored-by: Danil <[email protected]>
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.

4 participants