mirror of
https://github.com/arnaucube/sonobe.git
synced 2026-01-11 08:21:37 +01:00
Add typos tool to CI to automate typo detection (#76)
* Add typos to CI * Apply typos suggestions * missing typos
This commit is contained in:
@@ -10,7 +10,7 @@ use ark_relations::r1cs::{Namespace, SynthesisError};
|
||||
use ark_std::{One, Zero};
|
||||
use core::borrow::Borrow;
|
||||
|
||||
/// NonNativeAffineVar represents an elliptic curve point in Affine represenation in the non-native
|
||||
/// NonNativeAffineVar represents an elliptic curve point in Affine representation in the non-native
|
||||
/// field, over the constraint field. It is not intended to perform operations, but just to contain
|
||||
/// the affine coordinates in order to perform hash operations of the point.
|
||||
#[derive(Debug, Clone)]
|
||||
|
||||
@@ -111,7 +111,7 @@ impl<C: CurveGroup> CCCS<C> {
|
||||
w: &Witness<C::ScalarField>,
|
||||
) -> Result<(), Error> {
|
||||
// check that C is the commitment of w. Notice that this is not verifying a Pedersen
|
||||
// opening, but checking that the Commmitment comes from committing to the witness.
|
||||
// opening, but checking that the commitment comes from committing to the witness.
|
||||
if self.C != Pedersen::commit(pedersen_params, &w.w, &w.r_w)? {
|
||||
return Err(Error::NotSatisfied);
|
||||
}
|
||||
|
||||
@@ -96,7 +96,7 @@ impl<C: CurveGroup> LCCCS<C> {
|
||||
w: &Witness<C::ScalarField>,
|
||||
) -> Result<(), Error> {
|
||||
// check that C is the commitment of w. Notice that this is not verifying a Pedersen
|
||||
// opening, but checking that the Commmitment comes from committing to the witness.
|
||||
// opening, but checking that the commitment comes from committing to the witness.
|
||||
if self.C != Pedersen::commit(pedersen_params, &w.w, &w.r_w)? {
|
||||
return Err(Error::NotSatisfied);
|
||||
}
|
||||
@@ -133,7 +133,7 @@ pub mod tests {
|
||||
|
||||
let pedersen_params = Pedersen::<Projective>::new_params(&mut rng, ccs.n - ccs.l - 1);
|
||||
let (lcccs, _) = ccs.to_lcccs(&mut rng, &pedersen_params, &z).unwrap();
|
||||
// with our test vector comming from R1CS, v should have length 3
|
||||
// with our test vector coming from R1CS, v should have length 3
|
||||
assert_eq!(lcccs.v.len(), 3);
|
||||
|
||||
let vec_L_j_x = lcccs.compute_Ls(&ccs, &z);
|
||||
@@ -164,7 +164,7 @@ pub mod tests {
|
||||
let pedersen_params = Pedersen::<Projective>::new_params(&mut rng, ccs.n - ccs.l - 1);
|
||||
// Compute v_j with the right z
|
||||
let (lcccs, _) = ccs.to_lcccs(&mut rng, &pedersen_params, &z).unwrap();
|
||||
// with our test vector comming from R1CS, v should have length 3
|
||||
// with our test vector coming from R1CS, v should have length 3
|
||||
assert_eq!(lcccs.v.len(), 3);
|
||||
|
||||
// Bad compute L_j(x) with the bad z
|
||||
|
||||
@@ -445,7 +445,7 @@ where
|
||||
(cf_u_i.cmE.is_zero()?).conditional_enforce_equal(&Boolean::TRUE, &is_not_basecase)?;
|
||||
(cf_u_i.u.is_one()?).conditional_enforce_equal(&Boolean::TRUE, &is_not_basecase)?;
|
||||
|
||||
// check the fold of all the parameteres of the CycleFold instances, where the elliptic
|
||||
// check the fold of all the parameters of the CycleFold instances, where the elliptic
|
||||
// curve points relations are checked natively in Curve1 circuit (this one)
|
||||
let v = NIFSFullGadget::<C2, GC2>::verify(
|
||||
cf_r_bits,
|
||||
@@ -572,7 +572,7 @@ pub mod tests {
|
||||
assert_eq!(hVar.value().unwrap(), h);
|
||||
}
|
||||
|
||||
// checks that the gadget and native implementations of the challenge computation matcbh
|
||||
// checks that the gadget and native implementations of the challenge computation match
|
||||
#[test]
|
||||
fn test_challenge_gadget() {
|
||||
let mut rng = ark_std::test_rng();
|
||||
|
||||
@@ -50,7 +50,7 @@ where
|
||||
<C2 as Group>::ScalarField: Absorb,
|
||||
C1: CurveGroup<BaseField = C2::ScalarField, ScalarField = C2::BaseField>,
|
||||
for<'b> &'b GC2: GroupOpsBounds<'b, C2, GC2>,
|
||||
// constrain FS into Nova, since this is a Decider specificly for Nova
|
||||
// constrain FS into Nova, since this is a Decider specifically for Nova
|
||||
Nova<C1, GC1, C2, GC2, FC, CP1, CP2>: From<FS>,
|
||||
{
|
||||
type ProverParam = S::ProvingKey;
|
||||
|
||||
@@ -491,11 +491,11 @@ where
|
||||
z_i: Vec<C1::ScalarField>, // last state
|
||||
num_steps: C1::ScalarField,
|
||||
running_instance: Self::CommittedInstanceWithWitness,
|
||||
incomming_instance: Self::CommittedInstanceWithWitness,
|
||||
incoming_instance: Self::CommittedInstanceWithWitness,
|
||||
cyclefold_instance: Self::CFCommittedInstanceWithWitness,
|
||||
) -> Result<(), Error> {
|
||||
let (U_i, W_i) = running_instance;
|
||||
let (u_i, w_i) = incomming_instance;
|
||||
let (u_i, w_i) = incoming_instance;
|
||||
let (cf_U_i, cf_W_i) = cyclefold_instance;
|
||||
|
||||
if u_i.x.len() != 1 || U_i.x.len() != 1 {
|
||||
|
||||
@@ -143,7 +143,7 @@ where
|
||||
// use r_T=1 since we don't need hiding property for cm(T)
|
||||
let w3 = NIFS::<C, CP>::fold_witness(r, w1, w2, T, C::ScalarField::one())?;
|
||||
|
||||
// fold committed instancs
|
||||
// fold committed instances
|
||||
let ci3 = NIFS::<C, CP>::fold_committed_instance(r, ci1, ci2, &cmT);
|
||||
|
||||
Ok((w3, ci3))
|
||||
@@ -161,7 +161,7 @@ where
|
||||
NIFS::<C, CP>::fold_committed_instance(r, ci1, ci2, cmT)
|
||||
}
|
||||
|
||||
/// Verify commited folded instance (ci) relations. Notice that this method does not open the
|
||||
/// Verify committed folded instance (ci) relations. Notice that this method does not open the
|
||||
/// commitments, but just checks that the given committed instances (ci1, ci2) when folded
|
||||
/// result in the folded committed instance (ci3) values.
|
||||
pub fn verify_folded_instance(
|
||||
@@ -426,16 +426,16 @@ pub mod tests {
|
||||
|
||||
let num_iters = 10;
|
||||
for i in 0..num_iters {
|
||||
// prepare the incomming instance
|
||||
let incomming_instance_z = get_test_z(i + 4);
|
||||
let (w, x) = r1cs.split_z(&incomming_instance_z);
|
||||
let incomming_instance_w = Witness::<Projective>::new(w.clone(), r1cs.A.n_rows);
|
||||
let incomming_committed_instance = incomming_instance_w
|
||||
// prepare the incoming instance
|
||||
let incoming_instance_z = get_test_z(i + 4);
|
||||
let (w, x) = r1cs.split_z(&incoming_instance_z);
|
||||
let incoming_instance_w = Witness::<Projective>::new(w.clone(), r1cs.A.n_rows);
|
||||
let incoming_committed_instance = incoming_instance_w
|
||||
.commit::<Pedersen<Projective>>(&pedersen_params, x)
|
||||
.unwrap();
|
||||
r1cs.check_relaxed_instance_relation(
|
||||
&incomming_instance_w,
|
||||
&incomming_committed_instance,
|
||||
&incoming_instance_w,
|
||||
&incoming_committed_instance,
|
||||
)
|
||||
.unwrap();
|
||||
|
||||
@@ -447,16 +447,16 @@ pub mod tests {
|
||||
&r1cs,
|
||||
&running_instance_w,
|
||||
&running_committed_instance,
|
||||
&incomming_instance_w,
|
||||
&incomming_committed_instance,
|
||||
&incoming_instance_w,
|
||||
&incoming_committed_instance,
|
||||
)
|
||||
.unwrap();
|
||||
let (folded_w, _) = NIFS::<Projective, Pedersen<Projective>>::fold_instances(
|
||||
r,
|
||||
&running_instance_w,
|
||||
&running_committed_instance,
|
||||
&incomming_instance_w,
|
||||
&incomming_committed_instance,
|
||||
&incoming_instance_w,
|
||||
&incoming_committed_instance,
|
||||
&T,
|
||||
cmT,
|
||||
)
|
||||
@@ -466,7 +466,7 @@ pub mod tests {
|
||||
let folded_committed_instance = NIFS::<Projective, Pedersen<Projective>>::verify(
|
||||
r,
|
||||
&running_committed_instance,
|
||||
&incomming_committed_instance,
|
||||
&incoming_committed_instance,
|
||||
&cmT,
|
||||
);
|
||||
|
||||
|
||||
@@ -40,7 +40,7 @@ where
|
||||
// running instance
|
||||
instance: &CommittedInstance<C>,
|
||||
w: &Witness<C::ScalarField>,
|
||||
// incomming instances
|
||||
// incoming instances
|
||||
vec_instances: &[CommittedInstance<C>],
|
||||
vec_w: &[Witness<C::ScalarField>],
|
||||
) -> Result<
|
||||
@@ -226,7 +226,7 @@ where
|
||||
r1cs: &R1CS<C::ScalarField>,
|
||||
// running instance
|
||||
instance: &CommittedInstance<C>,
|
||||
// incomming instances
|
||||
// incoming instances
|
||||
vec_instances: &[CommittedInstance<C>],
|
||||
// polys from P
|
||||
F_coeffs: Vec<C::ScalarField>,
|
||||
@@ -440,7 +440,7 @@ mod tests {
|
||||
assert!(!is_zero_vec(&f_w));
|
||||
}
|
||||
|
||||
// k represents the number of instances to be fold, appart from the running instance
|
||||
// k represents the number of instances to be fold, apart from the running instance
|
||||
#[allow(clippy::type_complexity)]
|
||||
fn prepare_inputs(
|
||||
k: usize,
|
||||
@@ -522,7 +522,7 @@ mod tests {
|
||||
)
|
||||
.unwrap();
|
||||
|
||||
// veriier
|
||||
// verifier
|
||||
let folded_instance_v = Folding::<Projective>::verify(
|
||||
&mut transcript_v,
|
||||
&r1cs,
|
||||
@@ -572,7 +572,7 @@ mod tests {
|
||||
)
|
||||
.unwrap();
|
||||
|
||||
// veriier
|
||||
// verifier
|
||||
let folded_instance_v = Folding::<Projective>::verify(
|
||||
&mut transcript_v,
|
||||
&r1cs,
|
||||
|
||||
Reference in New Issue
Block a user