ark_mnt4_298/
lib.rs

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
14//! 298-bit (prime) field. The main feature of this curve is that its scalar
15//! field and base field respectively equal the base field and scalar field of
16//! MNT6_298.
17//!
18//!
19//! Curve information:
20//! * Base field: q =
21//!   475922286169261325753349249653048451545124879242694725395555128576210262817955800483758081
22//! * Scalar field: r =
23//!   475922286169261325753349249653048451545124878552823515553267735739164647307408490559963137
24//! * valuation(q - 1, 2) = 17
25//! * valuation(r - 1, 2) = 34
26//! * G1 curve equation: y^2 = x^3 + ax + b, where
27//!    * a = 2
28//!    * b = 423894536526684178289416011533888240029318103673896002803341544124054745019340795360841685
29//! * G2 curve equation: y^2 = x^3 + Ax + B, where
30//!    * A = Fq2 = (a * NON_RESIDUE, 0)
31//!    * B = Fq2(0, b * NON_RESIDUE)
32//!    * NON_RESIDUE = 17 is the quadratic non-residue used for constructing the
33//!      extension field Fq2
34
35#[cfg(feature = "curve")]
36mod curves;
37#[cfg(any(feature = "scalar_field", feature = "base_field"))]
38mod fields;
39
40#[cfg(feature = "r1cs")]
41pub mod constraints;
42
43#[cfg(feature = "curve")]
44pub use curves::*;
45#[cfg(any(feature = "scalar_field", feature = "base_field"))]
46pub use fields::*;