Add Docs for Risc0 adapter #641
Closed
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
adapters/risc0/src/host.rs
Outdated
| pub struct Risc0Host<'a> { | ||
| env: RefCell<ExecutorEnvBuilder<'a>>, | ||
| elf: &'a [u8], | ||
| } | ||
|
|
||
| impl<'a> Risc0Host<'a> { | ||
| /// Create a new host fo a given reference to an ELF file |
There was a problem hiding this comment.
nit: It's not obvious what it means that a host is "for a given reference to an ELF file". Maybe "Create a host to prove the provided ELF file?"
| @@ -57,6 +59,7 @@ impl<'prover> Zkvm for Risc0Host<'prover> { | |||
| } | |||
| } | |||
|
|
|||
| /// Making verification of Risc0 proofs | |||
There was a problem hiding this comment.
nit: This english isn't quite right. Maybe "Verifies Risc0 proofs"?
adapters/risc0/src/host.rs
Outdated
| @@ -9,12 +9,14 @@ use sov_rollup_interface::zk::{Zkvm, ZkvmHost}; | |||
|
|
|||
| use crate::Risc0MethodId; | |||
|
|
|||
| /// Allows to run prover code and send data to ZkVM | |||
There was a problem hiding this comment.
nit: This comment is a little terse. How about...
"The 'host' of a Risc0 zkVM. Generates a SNARK by running the target code on a virtual RISC-V CPU. The host is responsible for sending the "witness" data to the zkVM guest."
citizen-stig
force-pushed
the
nikolai/risc0_adapter_docs
branch
from
2b6fec1
to
daa57f3
Compare
|
Closed in favour of #934 |
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.
Description
Adds docs to Risc0 adapter
Linked Issues
Testing
No testing
Docs
Added docs