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 a twisted Edwards curve whose base field is the scalar field of the
12//! curve BN254. This allows defining cryptographic primitives that use elliptic curves over
13//! the scalar field of the latter curve. This curve is also known as [Baby-Jubjub](https://github.com/barryWhiteHat/baby_jubjub).
14//!
15//! Curve information:
16//! * Base field: q = 21888242871839275222246405745257275088548364400416034343698204186575808495617
17//! * Scalar field: r = 2736030358979909402780800718157159386076813972158567259200215660948447373041
18//! * Valuation(q - 1, 2) = 28
19//! * Valuation(r - 1, 2) = 4
20//! * Curve equation: ax^2 + y^2 =1 + dx^2y^2, where
21//!    * a = 1
22//!    * d = 168696/168700 mod q
23//!        = 9706598848417545097372247223557719406784115219466060233080913168975159366771
24
25#[cfg(feature = "r1cs")]
26pub mod constraints;
27mod curves;
28mod fields;
29
30pub use curves::*;
31pub use fields::*;