fix(docs): fix minor inconsistencies in documentation (#25)

Author: MariaGhandour

src/errors.rs

@@ -1,4 +1,4 @@
-//! # ProofError: Error Types for Zero-Knowledge Proofs
+//! # Error: Error Types for Zero-Knowledge Proofs
 //!
 //! This module defines the [`Error`] enum, which encapsulates possible errors that may occur
 //! during the execution of Sigma protocols or their non-interactive variants.

src/fiat_shamir.rs

@@ -128,10 +128,10 @@ where
     ///
     /// # Returns
     /// - `Ok(())` if the proof is valid.
-    /// - `Err(ProofError::VerificationFailure)` if the challenge is invalid or the response fails to verify.
+    /// - `Err(Error::VerificationFailure)` if the challenge is invalid or the response fails to verify.
     ///
     /// # Errors
-    /// - Returns `ProofError::VerificationFailure` if:
+    /// - Returns `Error::VerificationFailure` if:
     ///   - The challenge doesn't match the recomputed one from the commitment.
     ///   - The response fails verification under the Sigma protocol.
     pub fn verify(
@@ -182,10 +182,10 @@ where
     ///
     /// # Returns
     /// - `Ok(())` if the proof is valid.
-    /// - `Err(ProofError)` if deserialization or verification fails.
+    /// - `Err(Error)` if deserialization or verification fails.
     ///
     /// # Errors
-    /// - Returns `ProofError::VerificationFailure` if:
+    /// - Returns `Error::VerificationFailure` if:
     ///   - The challenge doesn't match the recomputed one from the commitment.
     ///   - The response fails verification under the Sigma protocol.
     pub fn verify_batchable(&self, proof: &[u8]) -> Result<(), Error> {
@@ -241,10 +241,10 @@ where
     ///
     /// # Returns
     /// - `Ok(())` if the proof is valid.
-    /// - `Err(ProofError)` if deserialization or verification fails.
+    /// - `Err(Error)` if deserialization or verification fails.
     ///
     /// # Errors
-    /// - Returns `ProofError::VerificationFailure` if:
+    /// - Returns `Error::VerificationFailure` if:
     ///   - Deserialization fails.
     ///   - The recomputed commitment or response is invalid under the Sigma protocol.
     pub fn verify_compact(&self, proof: &[u8]) -> Result<(), Error> {

src/group_serialization.rs

@@ -26,7 +26,7 @@ pub fn serialize_element<G: Group + GroupEncoding>(element: &G) -> Vec<u8> {
 ///
 /// # Returns
 /// - `Ok(G)`: The deserialized group element if the input is valid.
-/// - `Err(ProofError::GroupSerializationFailure)`: If the byte slice length is incorrect or the data
+/// - `Err(Error::GroupSerializationFailure)`: If the byte slice length is incorrect or the data
 ///   does not represent a valid group element.
 pub fn deserialize_element<G: Group + GroupEncoding>(data: &[u8]) -> Result<G, Error> {
     let element_len = G::Repr::default().as_ref().len();
@@ -64,7 +64,7 @@ pub fn serialize_scalar<G: Group>(scalar: &G::Scalar) -> Vec<u8> {
 ///
 /// # Returns
 /// - `Ok(G::Scalar)`: The deserialized scalar if the input is valid.
-/// - `Err(ProofError::GroupSerializationFailure)`: If the byte slice length is incorrect or the data
+/// - `Err(Error::GroupSerializationFailure)`: If the byte slice length is incorrect or the data
 ///   does not represent a valid scalar.
 pub fn deserialize_scalar<G: Group>(data: &[u8]) -> Result<G::Scalar, Error> {
     let scalar_len = <<G as Group>::Scalar as PrimeField>::Repr::default()

src/schnorr_protocol.rs

@@ -68,7 +68,7 @@ where
     ///     - The prover state (random nonces and witness) used to compute the response.
     ///
     /// # Errors
-    /// -`ProofError::ProofSizeMismatch` if the witness vector length is incorrect.
+    /// -`Error::ProofSizeMismatch` if the witness vector length is incorrect.
     fn prover_commit(
         &self,
         witness: &Self::Witness,
@@ -96,7 +96,7 @@ where
     /// - A vector of scalars forming the prover's response.
     ///
     /// # Errors
-    /// - Returns `ProofError::ProofSizeMismatch` if the prover state vectors have incorrect lengths.
+    /// - Returns `Error::ProofSizeMismatch` if the prover state vectors have incorrect lengths.
     fn prover_response(
         &self,
         state: Self::ProverState,
@@ -121,13 +121,13 @@ where
     ///
     /// # Returns
     /// - `Ok(())` if the proof is valid.
-    /// - `Err(ProofError::VerificationFailure)` if the proof is invalid.
-    /// - `Err(ProofError::ProofSizeMismatch)` if the lengths of commitment or response do not match the expected counts.
+    /// - `Err(Error::VerificationFailure)` if the proof is invalid.
+    /// - `Err(Error::ProofSizeMismatch)` if the lengths of commitment or response do not match the expected counts.
     ///
     /// # Errors
-    /// -`Err(ProofError::VerificationFailure)` if the computed relation
+    /// -`Err(Error::VerificationFailure)` if the computed relation
     /// does not hold for the provided challenge and response, indicating proof invalidity.
-    /// -`Err(ProofError::ProofSizeMismatch)` if the commitment or response length is incorrect.
+    /// -`Err(Error::ProofSizeMismatch)` if the commitment or response length is incorrect.
     fn verifier(
         &self,
         commitment: &Self::Commitment,
@@ -163,7 +163,7 @@ where
     /// - A byte vector representing the serialized batchable proof.
     ///
     /// # Errors
-    /// - `ProofError::ProofSizeMismatch` if the commitment or response length is incorrect.
+    /// - `Error::ProofSizeMismatch` if the commitment or response length is incorrect.
     fn serialize_batchable(
         &self,
         commitment: &Self::Commitment,
@@ -196,13 +196,13 @@ where
     ///
     /// # Returns
     /// - A tuple `(commitment, response)` where
-    ///   * `commitment` is a vector of group elements (one per statement), and
-    ///   * `response`   is a vector of scalars (one per witness).
+    ///   * `commitment` is a vector of group elements, and
+    ///   * `response` is a vector of scalars.
     ///
     /// # Errors
-    /// - `ProofError::ProofSizeMismatch` if the input length is not the exact number of bytes
+    /// - `Error::ProofSizeMismatch` if the input length is not the exact number of bytes
     ///   expected for `commit_nb` commitments plus `response_nb` responses.
-    /// - `ProofError::GroupSerializationFailure` if any group element or scalar fails to
+    /// - `Error::GroupSerializationFailure` if any group element or scalar fails to
     ///   deserialize (propagated from `deserialize_element` or `deserialize_scalar`).
     fn deserialize_batchable(
         &self,
@@ -260,7 +260,7 @@ where
     /// - A vector of group elements representing the recomputed commitment (one per linear constraint).
     ///
     /// # Errors
-    /// - `ProofError::ProofSizeMismatch` if the response length does not match the expected number of scalars.
+    /// - `Error::ProofSizeMismatch` if the response length does not match the expected number of scalars.
     fn get_commitment(
         &self,
         challenge: &Self::Challenge,
@@ -280,6 +280,17 @@ where
         Ok(commitment)
     }
 
+    /// Serializes a compact transcript: challenge followed by responses.
+    /// # Parameters
+    /// - `_commitment`: Omitted in compact format (reconstructed during verification).
+    /// - `challenge`: The challenge scalar.
+    /// - `response`: The prover’s response.
+    ///
+    /// # Returns
+    /// - A byte vector representing the compact proof.
+    ///
+    /// # Errors
+    /// - `Error::ProofSizeMismatch` if the response length does not match the expected number of scalars.
     fn serialize_response(&self, response: &Self::Response) -> Result<Vec<u8>, Error> {
         let mut bytes = Vec::new();
         let response_nb = self.scalars_nb();
@@ -294,6 +305,17 @@ where
         Ok(bytes)
     }
 
+    /// Deserializes a compact proof into a challenge and response.
+    ///
+    /// # Parameters
+    /// - `data`: A byte slice encoding the compact proof.
+    ///
+    /// # Returns
+    /// - A tuple `(challenge, response)`.
+    ///
+    /// # Errors
+    /// - `Error::ProofSizeMismatch` if the input data length does not match the expected size.
+    /// - `Error::GroupSerializationFailure` if scalar deserialization fails.
     fn deserialize_response(&self, data: &[u8]) -> Result<(Self::Response, usize), Error> {
         let response_nb = self.scalars_nb();
         let response_size = <<G as Group>::Scalar as PrimeField>::Repr::default()
@@ -326,7 +348,7 @@ where
     /// - A byte vector representing the compact proof.
     ///
     /// # Errors
-    /// - `ProofError::ProofSizeMismatch` if the response length does not match the expected number of scalars.
+    /// - `Error::ProofSizeMismatch` if the response length does not match the expected number of scalars.
     fn serialize_compact(
         &self,
         _commitment: &Self::Commitment,
@@ -352,8 +374,8 @@ where
     /// - A tuple `(challenge, response)`.
     ///
     /// # Errors
-    /// - `ProofError::ProofSizeMismatch` if the input data length does not match the expected size.
-    /// - `ProofError::GroupSerializationFailure` if scalar deserialization fails.
+    /// - `Error::ProofSizeMismatch` if the input data length does not match the expected size.
+    /// - `Error::GroupSerializationFailure` if scalar deserialization fails.
     fn deserialize_compact(&self, data: &[u8]) -> Result<(Self::Challenge, Self::Response), Error> {
         let scalar_size = <<G as Group>::Scalar as PrimeField>::Repr::default()
             .as_ref()