docs: update docstring for each crate

Author: prajwolrg

adapters/risc0/groth16-verifier/src/lib.rs

@@ -1,4 +1,7 @@
-//! FIXME: add docstring
+//! # zkaleido-risc0-groth16-verifier
+//!
+//! This crate integrates RISC Zero-based Groth16 proof verification based on zkaleido traits.
+
 use risc0_zkvm::{Groth16Receipt, MaybePruned, ReceiptClaim};
 use sha2::Digest;
 use zkaleido::{ProofReceipt, ZkVmResult};

adapters/risc0/guest/src/lib.rs

@@ -1,3 +1,7 @@
-//! FIXME: update docstring
+//! # zkaleido-risc0-guest-env
+//!
+//! This crate serves as the RISC Zero implementation of `ZkVmEnv`, enabling guest applications to
+//! interact with the host environment seamlessly by receiving inputs and committing outputs.
+
 mod env;
 pub use env::Risc0ZkVmEnv;

adapters/risc0/host/src/lib.rs

@@ -1,14 +1,9 @@
-//! # zkaleido-risc0-adapter
+//! # zkaleido-risc0-host
 //!
-//! This crate integrates the [RISC Zero](https://www.risczero.com/) zero-knowledge proof
-//! framework with the zkVM environment provided by [zkaleido](https://github.com/novifinancial/zkaleido).
-//! It enables both the generation of RISC0 proofs and the verification of RISC0-based Groth16
-//! proofs within a zkVM context.
-//!
-//! ## Features
-//!
-//! - **`prover`**: Enables proof generation via the RISC0 host and proof input builder. If you only
-//!   need to perform verification, you can disable this feature.
+//! This crate integrates the [RISC Zero](https://www.risczero.com/) zeroframework
+//! with the zkVM traits defined by [zkaleido](https://github.com/alpenlabs/zkaleido)
+//! on the host side.
+
 mod host;
 mod input;
 mod proof;

adapters/sp1/groth16-verifier/src/lib.rs

@@ -1,4 +1,7 @@
-//! FIXME: update here
+//! # zkaleido-sp1-groth16-verifier
+//!
+//! This crate integrates SP1-based Groth16 proof verification based on zkaleido traits.
+
 use sp1_verifier::{Groth16Verifier, GROTH16_VK_BYTES};
 use zkaleido::{ProofReceipt, ZkVmError, ZkVmResult};
 

adapters/sp1/guest/Cargo.toml

@@ -23,4 +23,4 @@ sha2 = { workspace = true, optional = true }
 
 [features]
 zkvm-verify = ["sp1-zkvm/verify", "sha2"]
-mock = []
+mock-verify = []

adapters/sp1/guest/src/env.rs

@@ -38,11 +38,11 @@ impl ZkVmEnv for Sp1ZkVmEnv {
             if #[cfg(feature = "zkvm-verify")] {
                 let pv_digest = Sha256::digest(public_values);
                 verify_sp1_proof(vk_digest, &pv_digest.into());
-            } else if #[cfg(feature = "mock")] {}
+            } else if #[cfg(feature = "mock-verify")] {}
             else {
                 panic!(
                     "No verification feature enabled. \
-                     Please enable either `zkvm-verify` or `mock`."
+                     Please enable either `zkvm-verify` or `mock-verify`."
                 );
             }
         }

adapters/sp1/guest/src/lib.rs

@@ -1,3 +1,19 @@
-//! FIXME: update here
+//! # zkaleido-risc0-guest-env
+//!
+//! This crate serves as the SP1 implementation of `ZkVmEnv`, enabling guest applications to
+//! interact with the host environment seamlessly by receiving inputs and committing outputs.
+//!
+//! ## Features
+//!
+//! - **zkvm-verify**: Activates the SP1 proof recursive verification logic using the
+//!   `sp1-zkvm/verify` adapter along with the `sha2` crate for cryptographic verification. When
+//!   enabled, `verify_native_proof` computes a SHA256 digest of the public values and verifies the
+//!   SP1 proof against the provided verification key digest.
+//!
+//! - **mock-verify**: Provides a no-op verification stub for testing purposes. When enabled, this
+//!   feature bypasses the actual cryptographic verification.
+//!
+//! If neither feature is enabled, calling `verify_native_proof` will panic.
+
 mod env;
 pub use env::Sp1ZkVmEnv;

artifacts/sp1/build.rs

@@ -25,11 +25,11 @@ fn main() {
     build_args.features = {
         #[cfg(feature = "mock")]
         {
-            vec!["mock".to_string()]
+            vec!["mock-verify".to_string()]
         }
         #[cfg(not(feature = "mock"))]
         {
-            vec![]
+            vec!["zkvm-verify".to_string()]
         }
     };
 

artifacts/sp1/templates/Cargo.toml.tera

@@ -11,7 +11,8 @@ zkaleido-sp1-guest-env = { path = "../../../adapters/sp1/guest" }
 sp1-zkvm = "4.1.0"
 
 [features]
-mock = ["zkaleido-sp1-guest-env/mock"]
+mock-verify = ["zkaleido-sp1-guest-env/mock-verify"]
+zkvm-verify = ["zkaleido-sp1-guest-env/zkvm-verify"]
 
 [patch.crates-io]
 sha2-v0-10-8 = { git = "https://github.com/sp1-patches/RustCrypto-hashes", package = "sha2", branch = "patch-sha2-v0.10.8" }