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