1use crate::prelude::*;
  2use algebra::{Field, PairingEngine};
  3use core::fmt::Debug;
  4use r1cs_core::{ConstraintSystem, SynthesisError};
  5
  6pub mod bls12;
  7pub mod mnt4;
  8pub mod mnt6;
  9
 10pub trait PairingGadget<PairingE: PairingEngine, ConstraintF: Field> {
 11    type G1Gadget: GroupGadget<PairingE::G1Projective, ConstraintF>;
 12    type G2Gadget: GroupGadget<PairingE::G2Projective, ConstraintF>;
 13    type G1PreparedGadget: ToBytesGadget<ConstraintF> + Clone + Debug;
 14    type G2PreparedGadget: ToBytesGadget<ConstraintF> + Clone + Debug;
 15    type GTGadget: FieldGadget<PairingE::Fqk, ConstraintF> + Clone;
 16
 17    fn miller_loop<CS: ConstraintSystem<ConstraintF>>(
 18        cs: CS,
 19        p: &[Self::G1PreparedGadget],
 20        q: &[Self::G2PreparedGadget],
 21    ) -> Result<Self::GTGadget, SynthesisError>;
 22
 23    fn final_exponentiation<CS: ConstraintSystem<ConstraintF>>(
 24        cs: CS,
 25        p: &Self::GTGadget,
 26    ) -> Result<Self::GTGadget, SynthesisError>;
 27
 28    fn pairing<CS: ConstraintSystem<ConstraintF>>(
 29        mut cs: CS,
 30        p: Self::G1PreparedGadget,
 31        q: Self::G2PreparedGadget,
 32    ) -> Result<Self::GTGadget, SynthesisError> {
 33        let tmp = Self::miller_loop(cs.ns(|| "miller loop"), &[p], &[q])?;
 34        Self::final_exponentiation(cs.ns(|| "final_exp"), &tmp)
 35    }
 36
 37    /// Computes a product of pairings.
 38    #[must_use]
 39    fn product_of_pairings<CS: ConstraintSystem<ConstraintF>>(
 40        mut cs: CS,
 41        p: &[Self::G1PreparedGadget],
 42        q: &[Self::G2PreparedGadget],
 43    ) -> Result<Self::GTGadget, SynthesisError> {
 44        let miller_result = Self::miller_loop(&mut cs.ns(|| "Miller loop"), p, q)?;
 45        Self::final_exponentiation(&mut cs.ns(|| "Final Exp"), &miller_result)
 46    }
 47
 48    fn prepare_g1<CS: ConstraintSystem<ConstraintF>>(
 49        cs: CS,
 50        q: &Self::G1Gadget,
 51    ) -> Result<Self::G1PreparedGadget, SynthesisError>;
 52
 53    fn prepare_g2<CS: ConstraintSystem<ConstraintF>>(
 54        cs: CS,
 55        q: &Self::G2Gadget,
 56    ) -> Result<Self::G2PreparedGadget, SynthesisError>;
 57}
 58
 59#[cfg(test)]
 60pub(crate) mod tests {
 61    use crate::{
 62        bits::boolean::Boolean, prelude::*, test_constraint_system::TestConstraintSystem, Vec,
 63    };
 64    use algebra::{test_rng, BitIterator, Field, PairingEngine, PrimeField, UniformRand};
 65    use r1cs_core::ConstraintSystem;
 66
 67    #[allow(dead_code)]
 68    pub(crate) fn bilinearity_test<
 69        E: PairingEngine,
 70        ConstraintF: Field,
 71        P: PairingGadget<E, ConstraintF>,
 72    >() {
 73        let mut cs = TestConstraintSystem::<ConstraintF>::new();
 74
 75        let mut rng = test_rng();
 76        let a = E::G1Projective::rand(&mut rng);
 77        let b = E::G2Projective::rand(&mut rng);
 78        let s = E::Fr::rand(&mut rng);
 79
 80        let mut sa = a;
 81        sa *= s;
 82        let mut sb = b;
 83        sb *= s;
 84
 85        let a_g = P::G1Gadget::alloc(&mut cs.ns(|| "a"), || Ok(a)).unwrap();
 86        let b_g = P::G2Gadget::alloc(&mut cs.ns(|| "b"), || Ok(b)).unwrap();
 87        let sa_g = P::G1Gadget::alloc(&mut cs.ns(|| "sa"), || Ok(sa)).unwrap();
 88        let sb_g = P::G2Gadget::alloc(&mut cs.ns(|| "sb"), || Ok(sb)).unwrap();
 89
 90        let a_prep_g = P::prepare_g1(&mut cs.ns(|| "a_prep"), &a_g).unwrap();
 91        let b_prep_g = P::prepare_g2(&mut cs.ns(|| "b_prep"), &b_g).unwrap();
 92
 93        let sa_prep_g = P::prepare_g1(&mut cs.ns(|| "sa_prep"), &sa_g).unwrap();
 94        let sb_prep_g = P::prepare_g2(&mut cs.ns(|| "sb_prep"), &sb_g).unwrap();
 95
 96        let (ans1_g, ans1_n) = {
 97            let ans_g = P::pairing(cs.ns(|| "pair(sa, b)"), sa_prep_g, b_prep_g.clone()).unwrap();
 98            let ans_n = E::pairing(sa, b);
 99            (ans_g, ans_n)
100        };
101
102        let (ans2_g, ans2_n) = {
103            let ans_g = P::pairing(cs.ns(|| "pair(a, sb)"), a_prep_g.clone(), sb_prep_g).unwrap();
104            let ans_n = E::pairing(a, sb);
105            (ans_g, ans_n)
106        };
107
108        let (ans3_g, ans3_n) = {
109            let s_iter = BitIterator::new(s.into_repr())
110                .map(Boolean::constant)
111                .collect::<Vec<_>>();
112
113            let mut ans_g = P::pairing(cs.ns(|| "pair(a, b)"), a_prep_g, b_prep_g).unwrap();
114            let mut ans_n = E::pairing(a, b);
115            ans_n = ans_n.pow(s.into_repr());
116            ans_g = ans_g.pow(cs.ns(|| "pow"), &s_iter).unwrap();
117
118            (ans_g, ans_n)
119        };
120
121        assert_eq!(ans1_n, ans2_n, "Failed ans1_native == ans2_native");
122        assert_eq!(ans2_n, ans3_n, "Failed ans2_native == ans3_native");
123        assert_eq!(
124            ans1_g.get_value(),
125            ans3_g.get_value(),
126            "Failed ans1 == ans3"
127        );
128        assert_eq!(
129            ans1_g.get_value(),
130            ans2_g.get_value(),
131            "Failed ans1 == ans2"
132        );
133        assert_eq!(
134            ans2_g.get_value(),
135            ans3_g.get_value(),
136            "Failed ans2 == ans3"
137        );
138
139        ans1_g
140            .enforce_equal(&mut cs.ns(|| "ans1 == ans2?"), &ans2_g)
141            .unwrap();
142        ans2_g
143            .enforce_equal(&mut cs.ns(|| "ans2 == ans3?"), &ans3_g)
144            .unwrap();
145
146        assert_eq!(ans1_g.get_value().unwrap(), ans1_n, "Failed native test 1");
147        assert_eq!(ans2_g.get_value().unwrap(), ans2_n, "Failed native test 2");
148        assert_eq!(ans3_g.get_value().unwrap(), ans3_n, "Failed native test 3");
149
150        if !cs.is_satisfied() {
151            println!("Unsatisfied: {:?}", cs.which_is_unsatisfied());
152        }
153
154        assert!(cs.is_satisfied(), "cs is not satisfied");
155    }
156}