feat: CanonicalLinearRelation, and renaming NI into Nizk

Author: mmaker

README.md

@@ -9,7 +9,7 @@ This library provides a flexible framework for creating zero-knowledge proofs fo
 ## Quick Example
 
 ```rust
-use sigma_rs::{LinearRelation, Protocol, ProtocolWitness, NISigmaProtocol};
+use sigma_rs::{LinearRelation, Protocol, ProtocolWitness, Nizk};
 use sigma_rs::codec::ShakeCodec;
 use curve25519_dalek::RistrettoPoint as G;
 

examples/simple_composition.rs

@@ -8,7 +8,7 @@ use sigma_rs::{
     codec::ShakeCodec,
     composition::{Protocol, ProtocolWitness},
     errors::Error,
-    LinearRelation, NISigmaProtocol,
+    LinearRelation, Nizk,
 };
 
 type G = RistrettoPoint;
@@ -56,7 +56,7 @@ fn prove(P1: G, x2: Scalar, H: G) -> ProofResult<Vec<u8>> {
 
     let protocol = create_relation(P1, P2, Q, H);
     let witness = ProtocolWitness::Or(1, vec![ProtocolWitness::Simple(vec![x2])]);
-    let nizk = NISigmaProtocol::<_, ShakeCodec<G>>::new(b"or_proof_example", protocol);
+    let nizk = Nizk::<_, ShakeCodec<G>>::new(b"or_proof_example", protocol);
 
     nizk.prove_batchable(&witness, &mut rng)
 }
@@ -65,7 +65,7 @@ fn prove(P1: G, x2: Scalar, H: G) -> ProofResult<Vec<u8>> {
 #[allow(non_snake_case)]
 fn verify(P1: G, P2: G, Q: G, H: G, proof: &[u8]) -> ProofResult<()> {
     let protocol = create_relation(P1, P2, Q, H);
-    let nizk = NISigmaProtocol::<_, ShakeCodec<G>>::new(b"or_proof_example", protocol);
+    let nizk = Nizk::<_, ShakeCodec<G>>::new(b"or_proof_example", protocol);
 
     nizk.verify_batchable(proof)
 }

src/fiat_shamir.rs

@@ -1,6 +1,6 @@
 //! Fiat-Shamir transformation for [`SigmaProtocol`]s.
 //!
-//! This module defines [`NISigmaProtocol`], a generic non-interactive Sigma protocol wrapper,
+//! This module defines [`Nizk`], a generic non-interactive Sigma protocol wrapper,
 //! based on applying the Fiat-Shamir heuristic using a codec.
 //!
 //! It transforms an interactive [`SigmaProtocol`] into a non-interactive one,
@@ -26,7 +26,7 @@ type Transcript<P> = (
 
 /// A Fiat-Shamir transformation of a [`SigmaProtocol`] into a non-interactive proof.
 ///
-/// [`NISigmaProtocol`] wraps an interactive Sigma protocol `P`
+/// [`Nizk`] wraps an interactive Sigma protocol `P`
 /// and a hash-based codec `C`, to produce non-interactive proofs.
 ///
 /// It manages the domain separation, codec reset,
@@ -36,7 +36,7 @@ type Transcript<P> = (
 /// - `P`: the Sigma protocol implementation.
 /// - `C`: the codec used for Fiat-Shamir.
 #[derive(Debug)]
-pub struct NISigmaProtocol<P, C>
+pub struct Nizk<P, C>
 where
     P: SigmaProtocol,
     P::Challenge: PartialEq,
@@ -48,20 +48,20 @@ where
     pub interactive_proof: P,
 }
 
-impl<P, C> NISigmaProtocol<P, C>
+impl<P, C> Nizk<P, C>
 where
     P: SigmaProtocol,
     P::Challenge: PartialEq,
     C: Codec<Challenge = P::Challenge> + Clone,
 {
-    /// Constructs a new [`NISigmaProtocol`] instance.
+    /// Constructs a new [`Nizk`] instance.
     ///
     /// # Parameters
     /// - `iv`: Domain separation tag for the hash function (e.g., protocol name or context).
     /// - `instance`: An instance of the interactive Sigma protocol.
     ///
     /// # Returns
-    /// A new [`NISigmaProtocol`] that can generate and verify non-interactive proofs.
+    /// A new [`Nizk`] that can generate and verify non-interactive proofs.
     pub fn new(session_identifier: &[u8], interactive_proof: P) -> Self {
         let hash_state = C::new(
             interactive_proof.protocol_identifier().as_ref(),
@@ -233,7 +233,7 @@ where
     }
 }
 
-impl<P, C> NISigmaProtocol<P, C>
+impl<P, C> Nizk<P, C>
 where
     P: SigmaProtocol + SigmaProtocolSimulator,
     P::Challenge: PartialEq,

src/lib.rs

@@ -28,7 +28,7 @@
 //!
 //! 1. Define your mathematical relation using [`LinearRelation`]
 //! 2. Create a Sigma protocol with [`schnorr_protocol::SchnorrProof`]
-//! 3. Convert to non-interactive using [`fiat_shamir::NISigmaProtocol`]
+//! 3. Convert to non-interactive using [`fiat_shamir::Nizk`]
 //! 4. Generate and verify proofs using the protocol interface
 //!
 //! ---
@@ -37,7 +37,7 @@
 //!
 //! - **[`traits::SigmaProtocol`]**: The fundamental three-move protocol interface
 //! - **[`linear_relation::LinearRelation`]**: Express mathematical relations over groups
-//! - **[`fiat_shamir::NISigmaProtocol`]**: Convert interactive proofs to standalone proofs
+//! - **[`fiat_shamir::Nizk`]**: Convert interactive proofs to standalone proofs
 //! - **[`composition::Protocol`]**: Combine multiple proofs together
 //! - **[`codec`]**: Hash function backends for proof generation
 //!
@@ -64,5 +64,5 @@ pub mod duplex_sponge;
 #[cfg(test)]
 pub mod tests;
 
-pub use fiat_shamir::NISigmaProtocol;
+pub use fiat_shamir::Nizk;
 pub use linear_relation::LinearRelation;