Upgrade to work with latest ark-ff (#95)

Co-authored-by: Sun <[email protected]>

Cargo.toml

@@ -63,3 +63,4 @@ ark-ec = { git = "https://github.com/arkworks-rs/algebra" }
 ark-ff = { git = "https://github.com/arkworks-rs/algebra" }
 ark-serialize = { git = "https://github.com/arkworks-rs/algebra" }
 ark-algebra-test-templates = { git = "https://github.com/arkworks-rs/algebra" }
+ark-r1cs-std = { git = "https://github.com/arkworks-rs/r1cs-std" }

bls12_377/scripts/base_field.sage

@@ -0,0 +1,28 @@
+modulus = 258664426012969094010652733694893533536393512754914660539884262666720468348340822774968888139573360124440321458177
+
+assert(modulus.is_prime())
+
+Fp = GF(modulus)
+
+generator = Fp(0);
+for i in range(0, 20):
+    i = Fp(i);
+    neg_i = Fp(-i)
+    if not(i.is_primitive_root() or neg_i.is_primitive_root()):
+        continue
+    elif i.is_primitive_root():
+        assert(i.is_primitive_root());
+        print("Generator: %d" % i)
+        generator = i
+        break
+    else:
+        assert(neg_i.is_primitive_root());
+        print("Generator: %d" % neg_i)
+        generator = neg_i
+        break
+
+
+two_adicity = valuation(modulus - 1, 2);
+trace = (modulus - 1) / 2**two_adicity;
+two_adic_root_of_unity = generator^trace
+print("2-adic Root of Unity: %d " % two_adic_root_of_unity)

bls12_377/scripts/scalar_field.sage

@@ -0,0 +1,28 @@
+modulus = 8444461749428370424248824938781546531375899335154063827935233455917409239041
+
+assert(modulus.is_prime())
+
+Fp = GF(modulus)
+
+generator = Fp(0);
+for i in range(0, 30):
+    i = Fp(i);
+    neg_i = Fp(-i)
+    if not(i.is_primitive_root() or neg_i.is_primitive_root()):
+        continue
+    elif i.is_primitive_root():
+        assert(i.is_primitive_root());
+        print("Generator: %d" % i)
+        generator = i
+        break
+    else:
+        assert(neg_i.is_primitive_root());
+        print("Generator: %d" % neg_i)
+        generator = neg_i
+        break
+
+
+two_adicity = valuation(modulus - 1, 2);
+trace = (modulus - 1) / 2**two_adicity;
+two_adic_root_of_unity = generator^trace
+print("2-adic Root of Unity: %d " % two_adic_root_of_unity)

bls12_377/src/constraints/curves.rs

@@ -1,11 +1,11 @@
-use crate::Parameters;
-use ark_ec::bls12::Bls12Parameters;
-use ark_ec::ModelParameters;
+use ark_ec::{bls12::Bls12Parameters, ModelParameters};
 use ark_r1cs_std::{
     fields::fp::FpVar,
     groups::{bls12, curves::twisted_edwards::AffineVar as TEAffineVar},
 };
 
+use crate::Parameters;
+
 /// An element of G1 in the BLS12-377 bilinear group.
 pub type G1Var = bls12::G1Var<Parameters>;
 /// An element of G2 in the BLS12-377 bilinear group.

bls12_377/src/constraints/fields.rs

@@ -1,16 +1,16 @@
-use crate::{Fq, Fq12Parameters, Fq2Parameters, Fq6Parameters};
-
 use ark_r1cs_std::fields::{fp::FpVar, fp12::Fp12Var, fp2::Fp2Var, fp6_3over2::Fp6Var};
 
+use crate::{Fq, Fq12Config, Fq2Config, Fq6Config};
+
 /// A variable that is the R1CS equivalent of `crate::Fq`.
 pub type FqVar = FpVar<Fq>;
 
 /// A variable that is the R1CS equivalent of `crate::Fq2`.
-pub type Fq2Var = Fp2Var<Fq2Parameters>;
+pub type Fq2Var = Fp2Var<Fq2Config>;
 /// A variable that is the R1CS equivalent of `crate::Fq6`.
-pub type Fq6Var = Fp6Var<Fq6Parameters>;
+pub type Fq6Var = Fp6Var<Fq6Config>;
 /// A variable that is the R1CS equivalent of `crate::Fq12`.
-pub type Fq12Var = Fp12Var<Fq12Parameters>;
+pub type Fq12Var = Fp12Var<Fq12Config>;
 
 #[test]
 fn bls12_377_field_test() {

bls12_377/src/constraints/pairing.rs

@@ -1,6 +1,7 @@
 use crate::Parameters;
 
-/// Specifies the constraints for computing a pairing in the BLS12-377 bilinear group.
+/// Specifies the constraints for computing a pairing in the BLS12-377 bilinear
+/// group.
 pub type PairingVar = ark_r1cs_std::pairing::bls12::PairingVar<Parameters>;
 
 #[test]

bls12_377/src/curves/g1.rs

@@ -4,7 +4,7 @@ use ark_ec::models::{
     },
     ModelParameters, MontgomeryModelParameters, SWModelParameters, TEModelParameters,
 };
-use ark_ff::{field_new, Zero};
+use ark_ff::{MontFp, Zero};
 use core::ops::Neg;
 
 use crate::{
@@ -24,16 +24,17 @@ impl ModelParameters for Parameters {
 
     /// COFACTOR_INV = COFACTOR^{-1} mod r
     /// = 5285428838741532253824584287042945485047145357130994810877
-    #[rustfmt::skip]
-    const COFACTOR_INV: Fr = field_new!(Fr, "5285428838741532253824584287042945485047145357130994810877");
+    const COFACTOR_INV: Fr = MontFp!(
+        Fr,
+        "5285428838741532253824584287042945485047145357130994810877"
+    );
 }
 
 impl SWModelParameters for Parameters {
     /// COEFF_A = 0
     const COEFF_A: Fq = FQ_ZERO;
 
     /// COEFF_B = 1
-    #[rustfmt::skip]
     const COEFF_B: Fq = FQ_ONE;
 
     /// AFFINE_GENERATOR_COEFFS = (G1_GENERATOR_X, G1_GENERATOR_Y)
@@ -54,7 +55,6 @@ pub type G1TEProjective = TEGroupProjective<Parameters>;
 /// 1. SW -> Montgomery -> TE1 transformation: <https://en.wikipedia.org/wiki/Montgomery_curve>
 /// 2. TE1 -> TE2 normalization (enforcing `a = -1`)
 /// ``` sage
-///
 /// # modulus
 /// p = 0x1ae3a4617c510eac63b05c06ca1493b1a22d9f300f5138f1ef3622fba094800170b5d44300000008508c00000000001
 /// Fp = Zmod(p)
@@ -96,15 +96,13 @@ pub type G1TEProjective = TEGroupProjective<Parameters>;
 /// TE2a = Fp(-1)
 /// # b = -TE1d/TE1a
 /// TE2d = Fp(122268283598675559488486339158635529096981886914877139579534153582033676785385790730042363341236035746924960903179)
-///
 /// ```
 impl TEModelParameters for Parameters {
     /// COEFF_A = -1
-    const COEFF_A: Fq = field_new!(Fq, "-1");
+    const COEFF_A: Fq = MontFp!(Fq, "-1");
 
     /// COEFF_D = 122268283598675559488486339158635529096981886914877139579534153582033676785385790730042363341236035746924960903179 mod q
-    #[rustfmt::skip]
-    const COEFF_D: Fq = field_new!(Fq, "122268283598675559488486339158635529096981886914877139579534153582033676785385790730042363341236035746924960903179");
+    const COEFF_D: Fq = MontFp!(Fq, "122268283598675559488486339158635529096981886914877139579534153582033676785385790730042363341236035746924960903179");
 
     /// AFFINE_GENERATOR_COEFFS = (GENERATOR_X, GENERATOR_Y)
     const AFFINE_GENERATOR_COEFFS: (Self::BaseField, Self::BaseField) =
@@ -124,7 +122,6 @@ impl TEModelParameters for Parameters {
 // It can be obtained via the following script, implementing
 // SW -> Montgomery transformation: <https://en.wikipedia.org/wiki/Montgomery_curve>
 // ``` sage
-//
 // # modulus
 // p=0x1ae3a4617c510eac63b05c06ca1493b1a22d9f300f5138f1ef3622fba094800170b5d44300000008508c00000000001
 // Fp=Zmod(p)
@@ -151,28 +148,25 @@ impl TEModelParameters for Parameters {
 // ```
 impl MontgomeryModelParameters for Parameters {
     /// COEFF_A = 228097355113300204138531148905234651262148041026195375645000724271212049151994375092458297304264351187709081232384
-    #[rustfmt::skip]
-    const COEFF_A: Fq = field_new!(Fq, "228097355113300204138531148905234651262148041026195375645000724271212049151994375092458297304264351187709081232384");
+    const COEFF_A: Fq = MontFp!(Fq, "228097355113300204138531148905234651262148041026195375645000724271212049151994375092458297304264351187709081232384");
 
     /// COEFF_B = 10189023633222963290707194929886294091415157242906428298294512798502806398782149227503530278436336312243746741931
-    #[rustfmt::skip]
-    const COEFF_B: Fq = field_new!(Fq, "10189023633222963290707194929886294091415157242906428298294512798502806398782149227503530278436336312243746741931");
+    const COEFF_B: Fq = MontFp!(Fq, "10189023633222963290707194929886294091415157242906428298294512798502806398782149227503530278436336312243746741931");
 
     type TEModelParameters = Parameters;
 }
 
 /// G1_GENERATOR_X =
 /// 81937999373150964239938255573465948239988671502647976594219695644855304257327692006745978603320413799295628339695
-#[rustfmt::skip]
-pub const G1_GENERATOR_X: Fq = field_new!(Fq, "81937999373150964239938255573465948239988671502647976594219695644855304257327692006745978603320413799295628339695");
+pub const G1_GENERATOR_X: Fq = MontFp!(Fq, "81937999373150964239938255573465948239988671502647976594219695644855304257327692006745978603320413799295628339695");
 
 /// G1_GENERATOR_Y =
 /// 241266749859715473739788878240585681733927191168601896383759122102112907357779751001206799952863815012735208165030
-#[rustfmt::skip]
-pub const G1_GENERATOR_Y: Fq = field_new!(Fq, "241266749859715473739788878240585681733927191168601896383759122102112907357779751001206799952863815012735208165030");
+pub const G1_GENERATOR_Y: Fq = MontFp!(Fq, "241266749859715473739788878240585681733927191168601896383759122102112907357779751001206799952863815012735208165030");
 
-// The generator for twisted Edward form is the same SW generator converted into the normalized TE form (TE2).
-// ``` sage
+// The generator for twisted Edward form is the same SW generator converted into
+// the normalized TE form (TE2).
+//``` sage
 // # following scripts in previous section
 // #####################################################
 // # Weierstrass curve generator
@@ -216,10 +210,8 @@ pub const G1_GENERATOR_Y: Fq = field_new!(Fq, "241266749859715473739788878240585
 // ```
 /// TE_GENERATOR_X =
 /// 71222569531709137229370268896323705690285216175189308202338047559628438110820800641278662592954630774340654489393
-#[rustfmt::skip]
-pub const TE_GENERATOR_X: Fq = field_new!(Fq, "71222569531709137229370268896323705690285216175189308202338047559628438110820800641278662592954630774340654489393");
+pub const TE_GENERATOR_X: Fq = MontFp!(Fq, "71222569531709137229370268896323705690285216175189308202338047559628438110820800641278662592954630774340654489393");
 
 /// TE_GENERATOR_Y =
 /// 6177051365529633638563236407038680211609544222665285371549726196884440490905471891908272386851767077598415378235
-#[rustfmt::skip]
-pub const TE_GENERATOR_Y: Fq = field_new!(Fq, "6177051365529633638563236407038680211609544222665285371549726196884440490905471891908272386851767077598415378235");
+pub const TE_GENERATOR_Y: Fq = MontFp!(Fq, "6177051365529633638563236407038680211609544222665285371549726196884440490905471891908272386851767077598415378235");

bls12_377/src/curves/g2.rs

@@ -1,5 +1,5 @@
 use ark_ec::models::{ModelParameters, SWModelParameters};
-use ark_ff::{field_new, Zero};
+use ark_ff::{MontFp, QuadExt, Zero};
 
 use crate::{fields::FQ_ZERO, g1, Fq, Fq2, Fr};
 
@@ -26,28 +26,25 @@ impl ModelParameters for Parameters {
 
     /// COFACTOR_INV = COFACTOR^{-1} mod r
     /// = 6764900296503390671038341982857278410319949526107311149686707033187604810669
-    #[rustfmt::skip]
-    const COFACTOR_INV: Fr = field_new!(Fr, "6764900296503390671038341982857278410319949526107311149686707033187604810669");
+    const COFACTOR_INV: Fr = MontFp!(
+        Fr,
+        "6764900296503390671038341982857278410319949526107311149686707033187604810669"
+    );
 }
 
 impl SWModelParameters for Parameters {
     /// COEFF_A = [0, 0]
-    #[rustfmt::skip]
-    const COEFF_A: Fq2 = field_new!(Fq2,
-        g1::Parameters::COEFF_A,
-        g1::Parameters::COEFF_A,
-    );
+    const COEFF_A: Fq2 = QuadExt!(g1::Parameters::COEFF_A, g1::Parameters::COEFF_A,);
 
     // As per https://eprint.iacr.org/2012/072.pdf,
     // this curve has b' = b/i, where b is the COEFF_B of G1, and x^6 -i is
     // the irreducible poly used to extend from Fp2 to Fp12.
     // In our case, i = u (App A.3, T_6).
     /// COEFF_B = [0,
     /// 155198655607781456406391640216936120121836107652948796323930557600032281009004493664981332883744016074664192874906]
-    #[rustfmt::skip]
-    const COEFF_B: Fq2 = field_new!(Fq2,
+    const COEFF_B: Fq2 = QuadExt!(
         FQ_ZERO,
-        field_new!(Fq, "155198655607781456406391640216936120121836107652948796323930557600032281009004493664981332883744016074664192874906"),
+        MontFp!(Fq, "155198655607781456406391640216936120121836107652948796323930557600032281009004493664981332883744016074664192874906"),
     );
 
     /// AFFINE_GENERATOR_COEFFS = (G2_GENERATOR_X, G2_GENERATOR_Y)
@@ -60,27 +57,21 @@ impl SWModelParameters for Parameters {
     }
 }
 
-#[rustfmt::skip]
-pub const G2_GENERATOR_X: Fq2 = field_new!(Fq2, G2_GENERATOR_X_C0, G2_GENERATOR_X_C1);
-#[rustfmt::skip]
-pub const G2_GENERATOR_Y: Fq2 = field_new!(Fq2, G2_GENERATOR_Y_C0, G2_GENERATOR_Y_C1);
+pub const G2_GENERATOR_X: Fq2 = QuadExt!(G2_GENERATOR_X_C0, G2_GENERATOR_X_C1);
+pub const G2_GENERATOR_Y: Fq2 = QuadExt!(G2_GENERATOR_Y_C0, G2_GENERATOR_Y_C1);
 
 /// G2_GENERATOR_X_C0 =
 /// 233578398248691099356572568220835526895379068987715365179118596935057653620464273615301663571204657964920925606294
-#[rustfmt::skip]
-pub const G2_GENERATOR_X_C0: Fq = field_new!(Fq, "233578398248691099356572568220835526895379068987715365179118596935057653620464273615301663571204657964920925606294");
+pub const G2_GENERATOR_X_C0: Fq = MontFp!(Fq, "233578398248691099356572568220835526895379068987715365179118596935057653620464273615301663571204657964920925606294");
 
 /// G2_GENERATOR_X_C1 =
 /// 140913150380207355837477652521042157274541796891053068589147167627541651775299824604154852141315666357241556069118
-#[rustfmt::skip]
-pub const G2_GENERATOR_X_C1: Fq = field_new!(Fq, "140913150380207355837477652521042157274541796891053068589147167627541651775299824604154852141315666357241556069118");
+pub const G2_GENERATOR_X_C1: Fq = MontFp!(Fq, "140913150380207355837477652521042157274541796891053068589147167627541651775299824604154852141315666357241556069118");
 
 /// G2_GENERATOR_Y_C0 =
 /// 63160294768292073209381361943935198908131692476676907196754037919244929611450776219210369229519898517858833747423
-#[rustfmt::skip]
-pub const G2_GENERATOR_Y_C0: Fq = field_new!(Fq, "63160294768292073209381361943935198908131692476676907196754037919244929611450776219210369229519898517858833747423");
+pub const G2_GENERATOR_Y_C0: Fq = MontFp!(Fq, "63160294768292073209381361943935198908131692476676907196754037919244929611450776219210369229519898517858833747423");
 
 /// G2_GENERATOR_Y_C1 =
 /// 149157405641012693445398062341192467754805999074082136895788947234480009303640899064710353187729182149407503257491
-#[rustfmt::skip]
-pub const G2_GENERATOR_Y_C1: Fq = field_new!(Fq, "149157405641012693445398062341192467754805999074082136895788947234480009303640899064710353187729182149407503257491");
+pub const G2_GENERATOR_Y_C1: Fq = MontFp!(Fq, "149157405641012693445398062341192467754805999074082136895788947234480009303640899064710353187729182149407503257491");

bls12_377/src/curves/mod.rs

@@ -1,9 +1,10 @@
-use crate::*;
 use ark_ec::{
     bls12,
     bls12::{Bls12, Bls12Parameters, TwistType},
 };
 
+use crate::*;
+
 pub mod g1;
 pub mod g2;
 
@@ -18,9 +19,9 @@ impl Bls12Parameters for Parameters {
     const X_IS_NEGATIVE: bool = false;
     const TWIST_TYPE: TwistType = TwistType::D;
     type Fp = Fq;
-    type Fp2Params = Fq2Parameters;
-    type Fp6Params = Fq6Parameters;
-    type Fp12Params = Fq12Parameters;
+    type Fp2Config = Fq2Config;
+    type Fp6Config = Fq6Config;
+    type Fp12Config = Fq12Config;
     type G1Parameters = g1::Parameters;
     type G2Parameters = g2::Parameters;
 }

bls12_377/src/curves/tests.rs

@@ -1,25 +1,19 @@
-#![allow(unused_imports)]
-use crate::{
-    g1, g2, Bls12_377, Fq, Fq12, Fq2, Fr, G1Affine, G1Projective, G1TEProjective, G2Affine,
-    G2Projective,
-};
-use ark_ec::{
-    models::SWModelParameters, short_weierstrass_jacobian, AffineCurve, PairingEngine,
-    ProjectiveCurve,
+use ark_algebra_test_templates::{
+    curves::{curve_tests, edwards_tests, sw_tests},
+    generate_bilinearity_test, generate_g1_generator_raw_test, generate_g1_test, generate_g2_test,
+    groups::group_test,
+    msm::test_var_base_msm,
 };
+use ark_ec::{models::SWModelParameters, AffineCurve, PairingEngine};
 use ark_ff::{
-    fields::{Field, FpParameters, PrimeField, SquareRootField},
+    fields::{Field, PrimeField, SquareRootField},
     One, Zero,
 };
-use ark_serialize::CanonicalSerialize;
 use ark_std::{rand::Rng, test_rng};
 use core::ops::{AddAssign, MulAssign};
 
-use ark_algebra_test_templates::{
-    curves::{curve_tests, edwards_tests, sw_tests},
-    generate_bilinearity_test, generate_g1_generator_raw_test, generate_g1_test, generate_g2_test,
-    groups::group_test,
-    msm::test_var_base_msm,
+use crate::{
+    g1, g2, Bls12_377, Fq, Fq12, Fr, G1Affine, G1Projective, G1TEProjective, G2Affine, G2Projective,
 };
 
 generate_g1_test!(bls12_377; curve_tests; sw_tests; edwards_tests; te_group_tests;);