浏览代码

A few stray sigma_rs -> sigma_proofs in docs

Ian Goldberg 4 周之前
父节点
当前提交
b4d6cba6e3
共有 3 个文件被更改,包括 8 次插入8 次删除
  1. 2 2
      README.md
  2. 5 5
      sigma-compiler-core/src/sigma/codegen.rs
  3. 1 1
      sigma-compiler-core/src/sigma/combiners.rs

+ 2 - 2
README.md

@@ -179,7 +179,7 @@ The macro creates a submodule with the name specified by
         witness: &Witness,
         session_id: &[u8],
         rng: &mut (impl CryptoRng + RngCore),
-    ) -> Result<Vec<u8>, sigma_rs::errors::Error>
+    ) -> sigma_proofs::errors::Result<Vec<u8>>
     ```
     The parameter `instance` contains the public variables (also
     known to the verifier).  The parameter `witness` contains the
@@ -196,7 +196,7 @@ The macro creates a submodule with the name specified by
         instance: &Instance,
         proof: &[u8],
         session_id: &[u8],
-    ) -> Result<(), sigma_rs::errors::Error>
+    ) -> sigma_proofs::errors::Result<()>
     ```
     The parameter `instance` contains the public variables, and must
     be the same as passed to the `prove` function.  The parameter

+ 5 - 5
sigma-compiler-core/src/sigma/codegen.rs

@@ -1,4 +1,4 @@
-//! A module for generating the code that uses the `sigma-rs` crate API.
+//! A module for generating the code that uses the `sigma-proofs` crate API.
 //!
 //! If that crate gets its own macro interface, it can use this module
 //! directly.
@@ -135,7 +135,7 @@ impl StructFieldList {
     }
 }
 
-/// The main struct to handle code generation using the `sigma-rs` API.
+/// The main struct to handle code generation using the `sigma-proofs` API.
 pub struct CodeGen<'a> {
     proto_name: Ident,
     group_name: Ident,
@@ -535,7 +535,7 @@ impl<'a> CodeGen<'a> {
         }
     }
 
-    /// Generate the code that uses the `sigma-rs` API to prove and
+    /// Generate the code that uses the `sigma-proofs` API to prove and
     /// verify the statements in the [`CodeGen`].
     ///
     /// `emit_prover` and `emit_verifier` are as in
@@ -612,7 +612,7 @@ impl<'a> CodeGen<'a> {
 
         let (protocol_code, witness_code) = self.proto_witness_codegen(self.statements);
 
-        // Generate the function that creates the sigma-rs Protocol
+        // Generate the function that creates the sigma-proofs Protocol
         let protocol_func = {
             let instance_var = format_ident!("{}instance", self.unique_prefix);
 
@@ -625,7 +625,7 @@ impl<'a> CodeGen<'a> {
             }
         };
 
-        // Generate the function that creates the sigma-rs ComposedWitness
+        // Generate the function that creates the sigma-proofs ComposedWitness
         let witness_func = if emit_prover {
             quote! {
                 fn protocol_witness(

+ 1 - 1
sigma-compiler-core/src/sigma/combiners.rs

@@ -490,7 +490,7 @@ impl StatementTree {
     #[cfg(not(doctest))]
     /// Flatten nested `And` nodes in a [`StatementTree`].
     ///
-    /// The underlying `sigma-rs` crate can share `Scalars` across
+    /// The underlying `sigma-proofs` crate can share `Scalars` across
     /// statements that are direct children of the same `And` node, but
     /// not in nested `And` nodes.
     ///