Migrate to GR1CS

Cargo.toml

@@ -1,7 +1,7 @@
 [package]
 name = "ark-r1cs-std"
 version = "0.5.0"
-authors = [ "arkworks contributors" ]
+authors = ["arkworks contributors"]
 description = "A standard library for constraint system gadgets"
 homepage = "https://arkworks.rs"
 repository = "https://github.com/arkworks-rs/r1cs-std"
@@ -20,28 +20,33 @@ ark-std = { version = "0.5.0", default-features = false }
 ark-relations = { version = "0.5.0", default-features = false }
 
 educe = "0.6.0"
-tracing = { version = "0.1", default-features = false, features = [ "attributes" ] }
+tracing = { version = "^0.1.0", default-features = false, features = ["attributes"] }
 num-bigint = { version = "0.4", default-features = false }
 num-traits = { version = "0.2", default-features = false }
 num-integer = { version = "0.1.44", default-features = false }
 
 [dev-dependencies]
-ark-test-curves = { version = "0.5.0", default-features = false, features = ["bls12_381_scalar_field", "bls12_381_curve", "mnt4_753_scalar_field"] }
+ark-test-curves = { version = "0.5.0", default-features = false, features = [
+    "bls12_381_scalar_field",
+    "bls12_381_curve",
+    "mnt4_753_scalar_field",
+] }
 ark-poly = { version = "0.5.0", default-features = false }
 paste = "1.0"
-ark-bls12-377 = { version = "0.5.0", features = ["curve"], default-features = false  }
-ark-bls12-381 = { version = "0.5.0", features = ["curve"], default-features = false  }
-ark-mnt4-298 = { version = "0.5.0", features = ["curve"], default-features = false  }
-ark-mnt4-753 = { version = "0.5.0", features = ["curve"], default-features = false  }
-ark-mnt6-298 = { version = "0.5.0", default-features = false  }
-ark-mnt6-753 = { version = "0.5.0", default-features = false  }
-ark-pallas = { version = "0.5.0", features = ["curve"],  default-features = false  }
-ark-bn254 = { version = "0.5.0", features = ["curve"], default-features = false  }
+ark-bls12-377 = { version = "0.5.0", features = ["curve"], default-features = false }
+ark-bls12-381 = { version = "0.5.0", features = ["curve"], default-features = false }
+ark-mnt4-298 = { version = "0.5.0", features = ["curve"], default-features = false }
+ark-mnt4-753 = { version = "0.5.0", features = ["curve"], default-features = false }
+ark-mnt6-298 = { version = "0.5.0", default-features = false }
+ark-mnt6-753 = { version = "0.5.0", default-features = false }
+ark-pallas = { version = "0.5.0", features = ["curve"], default-features = false }
+ark-bn254 = { version = "0.5.0", features = ["curve"], default-features = false }
+tracing-subscriber = { version = "0.3", default-features = true }
 
 [features]
 default = ["std"]
-std = [ "ark-ff/std", "ark-relations/std", "ark-std/std", "num-bigint/std" ]
-parallel = [ "std", "ark-ff/parallel", "ark-std/parallel"]
+std = ["ark-ff/std", "ark-relations/std", "ark-std/std", "num-bigint/std"]
+parallel = ["std", "ark-ff/parallel", "ark-std/parallel"]
 
 [[bench]]
 name = "emulated-bench"
@@ -76,3 +81,7 @@ debug = true
 [lints.rust]
 unexpected_cfgs = { level = "warn", check-cfg = ['cfg(ci)'] }
 
+
+# patch 
+[patch.crates-io]
+ark-relations = { git = "https://github.com/arkworks-rs/snark.git", default-features = true }

benches/bench.rs

@@ -5,8 +5,8 @@ use ark_r1cs_std::{
     fields::{emulated_fp::EmulatedFpVar, FieldVar},
 };
 use ark_relations::{
+    gr1cs::{ConstraintSystem, ConstraintSystemRef, OptimizationGoal},
     ns,
-    r1cs::{ConstraintSystem, ConstraintSystemRef, OptimizationGoal},
 };
 use ark_std::rand::RngCore;
 
@@ -19,9 +19,20 @@ fn get_density<BaseField: PrimeField>(cs: &ConstraintSystemRef<BaseField>) -> us
             let mut cs_bak = r.borrow().clone();
 
             cs_bak.finalize();
-            let matrices = cs_bak.to_matrices().unwrap();
-
-            matrices.a_num_non_zero + matrices.b_num_non_zero + matrices.c_num_non_zero
+            let matrices_map = cs_bak.to_matrices().unwrap();
+            match matrices_map.get(ark_relations::gr1cs::R1CS_PREDICATE_LABEL) {
+                None => 0,
+                Some(matrices) => {
+                    let a = &matrices[0];
+                    let b = &matrices[1];
+                    let c = &matrices[2];
+                    let a_num_non_zero: usize = a.iter().map(|lc| lc.len()).sum();
+                    let b_num_non_zero: usize = b.iter().map(|lc| lc.len()).sum();
+                    let c_num_non_zero: usize = c.iter().map(|lc| lc.len()).sum();
+
+                    a_num_non_zero + b_num_non_zero + c_num_non_zero
+                },
+            }
         },
     }
 }

scripts/migrate.sh

@@ -0,0 +1,62 @@
+#!/usr/bin/env bash
+
+# -----------------------------------------------------------------------------
+# rename_r1cs.sh (Regex Version)
+# 
+# Recursively:
+# 1. Renames .rs filenames: R1CS->GR1CS, r1cs->gr1cs (except those with r1cs_std).
+# 2. In .rs file contents, replaces R1CS->GR1CS, r1cs->gr1cs (except lines with r1cs_std),
+#    ensuring words already in GR1CS/gr1cs are not changed again.
+# 3. Finally replaces enforce_constraint->enforce_r1cs_constraint (except lines with r1cs_std),
+#    ensuring enforce_r1cs_constraint is not changed again.
+# -----------------------------------------------------------------------------
+
+# --- Detect which 'sed' in-place flag to use (GNU vs BSD/macOS) ---
+if sed --version 2>/dev/null | grep -q "GNU"; then
+    SED_INPLACE=(-i)
+else
+    SED_INPLACE=(-i '')
+fi
+
+echo "###############################################"
+echo "#  Make sure you have a backup before running. #"
+echo "###############################################"
+echo
+read -p "Are you sure you want to continue? (yes/no) " choice
+
+if [[ "$choice" != "yes" ]]; then
+    echo "Aborting script execution."
+    exit 1
+fi
+
+# 1) Rename files that contain 'r1cs' or 'R1CS' in their name, skipping 'r1cs_std' and existing 'gr1cs'.
+echo "Renaming files that contain 'r1cs' or 'R1CS' (but not 'r1cs_std' and already converted ones)..."
+export LC_ALL=C # Ensure consistent behavior for case conversions
+
+while IFS= read -r -d '' file; do
+    if [[ "$file" =~ r1cs_std || "$file" =~ gr1cs ]]; then
+        continue
+    fi
+    newfile="$(echo "$file" | sed -E 's/(^|[^g])r1cs/\1gr1cs/g; s/(^|[^G])R1CS/\1GR1CS/g')"
+    if [[ "$newfile" != "$file" ]]; then
+        echo " -> Renaming: $file -> $newfile"
+        mv "$file" "$newfile"
+    fi
+done < <(find . -type f -name "*.rs" -print0)
+
+# 2) Replace R1CS->GR1CS and r1cs->gr1cs in file contents,
+#    skipping lines that have 'r1cs_std' and ensuring already transformed words are not changed again.
+echo "Replacing (R1CS->GR1CS, r1cs->gr1cs) in .rs file contents..."
+while IFS= read -r -d '' file; do
+    sed "${SED_INPLACE[@]}" -E '/r1cs_std|enforce_r1cs_constraint/! s/(^|[^g])r1cs/\1gr1cs/g' "$file"
+    sed "${SED_INPLACE[@]}" -E '/r1cs_std|enforce_r1cs_constraint/! s/(^|[^G])R1CS/\1GR1CS/g' "$file"
+done < <(find . -type f -name "*.rs" ! -name "*r1cs_std*" -print0)
+
+# 3) Replace 'enforce_constraint' -> 'enforce_r1cs_constraint',
+#    skipping lines that have 'r1cs_std' and ensuring enforce_r1cs_constraint is not changed again.
+echo "Replacing enforce_constraint->enforce_r1cs_constraint..."
+while IFS= read -r -d '' file; do
+    sed "${SED_INPLACE[@]}" '/r1cs_std|enforce_r1cs_constraint/! s/enforce_constraint/enforce_r1cs_constraint/g' "$file"
+done < <(find . -type f -name "*.rs" ! -name "*r1cs_std*" -print0)
+
+echo "Done!"

src/alloc.rs

@@ -1,6 +1,6 @@
 use crate::Vec;
 use ark_ff::Field;
-use ark_relations::r1cs::{Namespace, SynthesisError};
+use ark_relations::gr1cs::{Namespace, SynthesisError};
 use core::borrow::Borrow;
 
 /// Describes the mode that a variable should be allocated in within
@@ -49,7 +49,7 @@ pub trait AllocVar<V: ?Sized, F: Field>: Sized {
     /// Allocates a new constant of type `Self` in the `ConstraintSystem` `cs`.
     ///
     /// This should *not* allocate any new variables or constraints in `cs`.
-    #[tracing::instrument(target = "r1cs", skip(cs, t))]
+    #[tracing::instrument(target = "gr1cs", skip(cs, t))]
     fn new_constant(
         cs: impl Into<Namespace<F>>,
         t: impl Borrow<V>,
@@ -59,7 +59,7 @@ pub trait AllocVar<V: ?Sized, F: Field>: Sized {
 
     /// Allocates a new public input of type `Self` in the `ConstraintSystem`
     /// `cs`.
-    #[tracing::instrument(target = "r1cs", skip(cs, f))]
+    #[tracing::instrument(target = "gr1cs", skip(cs, f))]
     fn new_input<T: Borrow<V>>(
         cs: impl Into<Namespace<F>>,
         f: impl FnOnce() -> Result<T, SynthesisError>,
@@ -69,7 +69,7 @@ pub trait AllocVar<V: ?Sized, F: Field>: Sized {
 
     /// Allocates a new private witness of type `Self` in the `ConstraintSystem`
     /// `cs`.
-    #[tracing::instrument(target = "r1cs", skip(cs, f))]
+    #[tracing::instrument(target = "gr1cs", skip(cs, f))]
     fn new_witness<T: Borrow<V>>(
         cs: impl Into<Namespace<F>>,
         f: impl FnOnce() -> Result<T, SynthesisError>,
@@ -90,8 +90,8 @@ pub trait AllocVar<V: ?Sized, F: Field>: Sized {
     /// variable, one can write:
     /// ```
     /// use ark_ff::PrimeField;
-    /// use ark_r1cs_std::{alloc::AllocVar, fields::{fp::FpVar, FieldVar}, R1CSVar};
-    /// use ark_relations::r1cs::SynthesisError;
+    /// use ark_r1cs_std::{alloc::AllocVar, fields::{fp::FpVar, FieldVar}, GR1CSVar};
+    /// use ark_relations::gr1cs::SynthesisError;
     ///
     /// fn div<F: PrimeField>(x_var: &FpVar<F>, y_var: &FpVar<F>) -> Result<FpVar<F>, SynthesisError> {
     ///   let cs = x_var.cs().or(y_var.cs());

src/boolean/allocated.rs

@@ -1,7 +1,7 @@
 use core::borrow::Borrow;
 
 use ark_ff::{Field, PrimeField};
-use ark_relations::r1cs::{ConstraintSystemRef, Namespace, SynthesisError, Variable};
+use ark_relations::gr1cs::{ConstraintSystemRef, Namespace, SynthesisError, Variable};
 
 use crate::{
     alloc::{AllocVar, AllocationMode},
@@ -58,7 +58,7 @@ impl<F: Field> AllocatedBool<F> {
 
     /// Performs an XOR operation over the two operands, returning
     /// an `AllocatedBool`.
-    #[tracing::instrument(target = "r1cs")]
+    #[tracing::instrument(target = "gr1cs")]
     pub fn not(&self) -> Result<Self, SynthesisError> {
         let variable = self.cs.new_lc(lc!() + Variable::One - self.variable)?;
         Ok(Self {
@@ -69,7 +69,7 @@ impl<F: Field> AllocatedBool<F> {
 
     /// Performs an XOR operation over the two operands, returning
     /// an `AllocatedBool`.
-    #[tracing::instrument(target = "r1cs")]
+    #[tracing::instrument(target = "gr1cs")]
     pub fn xor(&self, b: &Self) -> Result<Self, SynthesisError> {
         let result = Self::new_witness_without_booleanity_check(self.cs.clone(), || {
             Ok(self.value()? ^ b.value()?)
@@ -90,7 +90,7 @@ impl<F: Field> AllocatedBool<F> {
         // -2a * b = c - a - b
         // 2a * b = a + b - c
         // (a + a) * b = a + b - c
-        self.cs.enforce_constraint(
+        self.cs.enforce_r1cs_constraint(
             lc!() + self.variable + self.variable,
             lc!() + b.variable,
             lc!() + self.variable + b.variable - result.variable,
@@ -101,15 +101,15 @@ impl<F: Field> AllocatedBool<F> {
 
     /// Performs an AND operation over the two operands, returning
     /// an `AllocatedBool`.
-    #[tracing::instrument(target = "r1cs")]
+    #[tracing::instrument(target = "gr1cs")]
     pub fn and(&self, b: &Self) -> Result<Self, SynthesisError> {
         let result = Self::new_witness_without_booleanity_check(self.cs.clone(), || {
             Ok(self.value()? & b.value()?)
         })?;
 
         // Constrain (a) * (b) = (c), ensuring c is 1 iff
         // a AND b are both 1.
-        self.cs.enforce_constraint(
+        self.cs.enforce_r1cs_constraint(
             lc!() + self.variable,
             lc!() + b.variable,
             lc!() + result.variable,
@@ -120,15 +120,15 @@ impl<F: Field> AllocatedBool<F> {
 
     /// Performs an OR operation over the two operands, returning
     /// an `AllocatedBool`.
-    #[tracing::instrument(target = "r1cs")]
+    #[tracing::instrument(target = "gr1cs")]
     pub fn or(&self, b: &Self) -> Result<Self, SynthesisError> {
         let result = Self::new_witness_without_booleanity_check(self.cs.clone(), || {
             Ok(self.value()? | b.value()?)
         })?;
 
         // Constrain (1 - a) * (1 - b) = (1 - c), ensuring c is 0 iff
         // a and b are both false, and otherwise c is 1.
-        self.cs.enforce_constraint(
+        self.cs.enforce_r1cs_constraint(
             lc!() + Variable::One - self.variable,
             lc!() + Variable::One - b.variable,
             lc!() + Variable::One - result.variable,
@@ -138,15 +138,15 @@ impl<F: Field> AllocatedBool<F> {
     }
 
     /// Calculates `a AND (NOT b)`.
-    #[tracing::instrument(target = "r1cs")]
+    #[tracing::instrument(target = "gr1cs")]
     pub fn and_not(&self, b: &Self) -> Result<Self, SynthesisError> {
         let result = Self::new_witness_without_booleanity_check(self.cs.clone(), || {
             Ok(self.value()? & !b.value()?)
         })?;
 
         // Constrain (a) * (1 - b) = (c), ensuring c is 1 iff
         // a is true and b is false, and otherwise c is 0.
-        self.cs.enforce_constraint(
+        self.cs.enforce_r1cs_constraint(
             lc!() + self.variable,
             lc!() + Variable::One - b.variable,
             lc!() + result.variable,
@@ -156,15 +156,15 @@ impl<F: Field> AllocatedBool<F> {
     }
 
     /// Calculates `(NOT a) AND (NOT b)`.
-    #[tracing::instrument(target = "r1cs")]
+    #[tracing::instrument(target = "gr1cs")]
     pub fn nor(&self, b: &Self) -> Result<Self, SynthesisError> {
         let result = Self::new_witness_without_booleanity_check(self.cs.clone(), || {
             Ok(!(self.value()? | b.value()?))
         })?;
 
         // Constrain (1 - a) * (1 - b) = (c), ensuring c is 1 iff
         // a and b are both false, and otherwise c is 0.
-        self.cs.enforce_constraint(
+        self.cs.enforce_r1cs_constraint(
             lc!() + Variable::One - self.variable,
             lc!() + Variable::One - b.variable,
             lc!() + result.variable,
@@ -205,15 +205,15 @@ impl<F: Field> AllocVar<bool, F> for AllocatedBool<F> {
             // Constrain: (1 - a) * a = 0
             // This constrains a to be either 0 or 1.
 
-            cs.enforce_constraint(lc!() + Variable::One - variable, lc!() + variable, lc!())?;
+            cs.enforce_r1cs_constraint(lc!() + Variable::One - variable, lc!() + variable, lc!())?;
 
             Ok(Self { variable, cs })
         }
     }
 }
 
 impl<F: PrimeField> CondSelectGadget<F> for AllocatedBool<F> {
-    #[tracing::instrument(target = "r1cs")]
+    #[tracing::instrument(target = "gr1cs")]
     fn conditionally_select(
         cond: &Boolean<F>,
         true_val: &Self,
@@ -235,7 +235,7 @@ impl<F: PrimeField> CondSelectGadget<F> for AllocatedBool<F> {
 mod test {
     use super::*;
 
-    use ark_relations::r1cs::ConstraintSystem;
+    use ark_relations::gr1cs::ConstraintSystem;
     use ark_test_curves::bls12_381::Fr;
     #[test]
     fn allocated_xor() -> Result<(), SynthesisError> {