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
12//! scalar field of the curve BLS12-381. This allows defining cryptographic
13//! primitives that use elliptic curves over the scalar field of the latter
14//! curve. This curve was generated by Sean Bowe, and is also known as [Jubjub](https://github.com/zkcrypto/jubjub).
15//!
16//! Curve information:
17//! * Base field: q =
18//!   52435875175126190479447740508185965837690552500527637822603658699938581184513
19//! * Scalar field: r =
20//!   6554484396890773809930967563523245729705921265872317281365359162392183254199
21//! * Valuation(q - 1, 2) = 32
22//! * Valuation(r - 1, 2) = 1
23//! * Curve equation: ax^2 + y^2 =1 + dx^2y^2, where
24//!    * a = -1
25//!    * d = -(10240/10241)
26
27#[cfg(feature = "r1cs")]
28pub mod constraints;
29mod curves;
30mod fields;
31
32pub use curves::*;
33pub use fields::*;