docs: verifier crate docs #1764
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
yuwen01
commented
Nov 6, 2024
| verify SP1 proofs in wasm. For a more detailed explanation of the process, please see the [README](https://github.com/succinctlabs/example-sp1-wasm-verifier/blob/main/README.md). | ||
|
|
||
| At a high level, the process is as follows: | ||
|
|
There was a problem hiding this comment.
I want to give some sense of how to do wasm verification, but the process is kind of complicated.
See here for the entire process.
|
SP1 Performance Test Results Branch: yuwen/verifier-docs
|
jtguibas
reviewed
Nov 6, 2024
| [bn254](https://blog.succinct.xyz/succinctshipsprecompiles/) precompiles. For an example of this, see | ||
| the [Groth16 Example](https://github.com/succinctlabs/sp1/tree/main/examples/groth16/). | ||
|
|
||
| ### Instafllation |
jtguibas
reviewed
Nov 6, 2024
| let vkey_hash = "0x00e60860c07bfc6e4c480286c0ddbb879674eb47f84b4ef041cf858b17aa0ed1"; | ||
|
|
||
| let is_valid = | ||
| crate::Groth16Verifier::verify(&proof, &public_inputs, vkey_hash, &crate::GROTH16_VK_BYTES) |
There was a problem hiding this comment.
you should show a more detailed example that includes also the import paths for these variables
There was a problem hiding this comment.
the crate:: is unrealistic
jtguibas
reviewed
Nov 6, 2024
| The [`example-sp1-wasm-verifier`](https://github.com/succinctlabs/example-sp1-wasm-verifier) demonstrates how to | ||
| verify SP1 proofs in wasm. For a more detailed explanation of the process, please see the [README](https://github.com/succinctlabs/example-sp1-wasm-verifier/blob/main/README.md). | ||
|
|
||
| At a high level, the process is as follows: |
There was a problem hiding this comment.
if you're gonna defer the docs to that repo, just delete this part imo.
jtguibas
approved these changes
Nov 6, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Documents the verifier crate. Assumes that v3.2.0 is released and that docs.rs contains information on
sp1-verifier.