mirror of
https://github.com/Qortal/pirate-librustzcash.git
synced 2025-02-14 10:45:47 +00:00
81 lines
2.1 KiB
Rust
81 lines
2.1 KiB
Rust
//! # `bls12_381`
|
|
//!
|
|
//! This crate provides an implementation of the BLS12-381 pairing-friendly elliptic
|
|
//! curve construction.
|
|
//!
|
|
//! * **This implementation has not been reviewed or audited. Use at your own risk.**
|
|
//! * This implementation targets Rust `1.36` or later.
|
|
//! * This implementation does not require the Rust standard library.
|
|
//! * All operations are constant time unless explicitly noted.
|
|
|
|
#![no_std]
|
|
// Catch documentation errors caused by code changes.
|
|
#![deny(intra_doc_link_resolution_failure)]
|
|
#![deny(missing_debug_implementations)]
|
|
#![deny(missing_docs)]
|
|
#![deny(unsafe_code)]
|
|
#![allow(clippy::too_many_arguments)]
|
|
#![allow(clippy::many_single_char_names)]
|
|
// This lint is described at
|
|
// https://rust-lang.github.io/rust-clippy/master/index.html#suspicious_arithmetic_impl
|
|
// In our library, some of the arithmetic involving extension fields will necessarily
|
|
// involve various binary operators, and so this lint is triggered unnecessarily.
|
|
#![allow(clippy::suspicious_arithmetic_impl)]
|
|
|
|
#[cfg(feature = "alloc")]
|
|
extern crate alloc;
|
|
|
|
#[cfg(test)]
|
|
#[macro_use]
|
|
extern crate std;
|
|
|
|
#[cfg(test)]
|
|
#[cfg(feature = "groups")]
|
|
mod tests;
|
|
|
|
#[macro_use]
|
|
mod util;
|
|
|
|
/// Notes about how the BLS12-381 elliptic curve is designed, specified
|
|
/// and implemented by this library.
|
|
pub mod notes {
|
|
pub mod design;
|
|
pub mod serialization;
|
|
}
|
|
|
|
mod scalar;
|
|
|
|
pub use scalar::Scalar;
|
|
|
|
#[cfg(feature = "groups")]
|
|
mod fp;
|
|
#[cfg(feature = "groups")]
|
|
mod fp2;
|
|
#[cfg(feature = "groups")]
|
|
mod g1;
|
|
#[cfg(feature = "groups")]
|
|
mod g2;
|
|
|
|
#[cfg(feature = "groups")]
|
|
pub use g1::{G1Affine, G1Projective};
|
|
#[cfg(feature = "groups")]
|
|
pub use g2::{G2Affine, G2Projective};
|
|
|
|
#[cfg(feature = "groups")]
|
|
mod fp12;
|
|
#[cfg(feature = "groups")]
|
|
mod fp6;
|
|
|
|
// The BLS parameter x for BLS12-381 is -0xd201000000010000
|
|
const BLS_X: u64 = 0xd201_0000_0001_0000;
|
|
const BLS_X_IS_NEGATIVE: bool = true;
|
|
|
|
#[cfg(feature = "pairings")]
|
|
mod pairings;
|
|
|
|
#[cfg(feature = "pairings")]
|
|
pub use pairings::{pairing, Gt, MillerLoopResult};
|
|
|
|
#[cfg(all(feature = "pairings", feature = "alloc"))]
|
|
pub use pairings::{multi_miller_loop, G2Prepared};
|