1#![cfg_attr(not(feature = "std"), no_std)]
 2#![deny(
 3    warnings,
 4    unused,
 5    future_incompatible,
 6    nonstandard_style,
 7    rust_2018_idioms
 8)]
 9#![forbid(unsafe_code)]
10
11//! This library implements the MNT4_298 curve generated by
12//! [\[BCTV14\]](https://eprint.iacr.org/2014/595).  The name denotes that it is a
13//! Miyaji--Nakabayashi--Takano curve of embedding degree 4, defined over a 298-bit (prime) field.
14//! The main feature of this curve is that its scalar field and base field respectively equal the
15//! base field and scalar field of MNT6_298.
16//!
17//!
18//! Curve information:
19//! * Base field: q = 475922286169261325753349249653048451545124879242694725395555128576210262817955800483758081
20//! * Scalar field: r = 475922286169261325753349249653048451545124878552823515553267735739164647307408490559963137
21//! * valuation(q - 1, 2) = 17
22//! * valuation(r - 1, 2) = 34
23//! * G1 curve equation: y^2 = x^3 + ax + b, where
24//!    * a = 2
25//!    * b = 423894536526684178289416011533888240029318103673896002803341544124054745019340795360841685
26//! * G2 curve equation: y^2 = x^3 + Ax + B, where
27//!    * A = Fq2 = (a * NON_RESIDUE, 0)
28//!    * B = Fq2(0, b * NON_RESIDUE)
29//!    * NON_RESIDUE = 17 is the quadratic non-residue used for constructing the extension field Fq2
30
31#[cfg(feature = "curve")]
32mod curves;
33#[cfg(any(feature = "scalar_field", feature = "base_field"))]
34mod fields;
35
36#[cfg(feature = "r1cs")]
37pub mod constraints;
38
39#[cfg(feature = "curve")]
40pub use curves::*;
41#[cfg(any(feature = "scalar_field", feature = "base_field"))]
42pub use fields::*;