Struct JubjubBase 

pub struct JubjubBase(/* private fields */);

Represents an element of the scalar field Fq of the BLS12-381 elliptic curve construction.

The inner representation blst_fr is stored in Montgomery form as little-endian u64 limbs.

Implementations

impl Fq

pub const fn mul_const(lhs: &[u64; 4], rhs: &[u64; 4]) -> Fq

Multiplies this element by another element

pub const fn from_raw(val: [u64; 4]) -> Fq

Converts from an integer represented in little endian into its (congruent) Fr representation.

impl Fq

pub fn from_bytes_le(bytes: &[u8; 32]) -> CtOption<Fq>

Attempts to convert a little-endian byte representation of a scalar into a Fq, failing if the input is not canonical.

pub fn from_bytes_be(be_bytes: &[u8; 32]) -> CtOption<Fq>

Attempts to convert a big-endian byte representation of a scalar into a Fq, failing if the input is not canonical.

pub fn to_bytes_le(&self) -> [u8; 32]

Converts an element of Fq into a byte representation in little-endian byte order.

pub fn to_bytes_be(&self) -> [u8; 32]

Converts an element of Fq into a byte representation in big-endian byte order.

pub fn from_u64s_le(bytes: &[u64; 4]) -> CtOption<Fq>

pub fn char() -> <Fq as PrimeField>::Repr

pub fn num_bits(&self) -> u32

pub fn mul3(&self) -> Fq

Multiplies self with 3, returning the result.

pub fn shl(&self, count: usize) -> Fq

Left shift self by count, returning the result.

pub fn shr(&self, count: usize) -> Fq

Right shift self by count, returning the result.

pub fn square_assign(&mut self)

Calculates the square of this element.

Trait Implementations

impl Add<&Fq> for &Fq

type Output = Fq

The resulting type after applying the + operator.

fn add(self, rhs: &Fq) -> Fq

Performs the + operation.

impl Add<&Fq> for Fq

type Output = Fq

The resulting type after applying the + operator.

fn add(self, rhs: &Fq) -> Fq

Performs the + operation.

impl Add<Fq> for &Fq

type Output = Fq

The resulting type after applying the + operator.

fn add(self, rhs: Fq) -> Fq

Performs the + operation.

impl Add for Fq

type Output = Fq

The resulting type after applying the + operator.

fn add(self, rhs: Fq) -> Fq

Performs the + operation.

impl AddAssign<&Fq> for Fq

fn add_assign(&mut self, rhs: &Fq)

Performs the += operation.

impl AddAssign for Fq

fn add_assign(&mut self, rhs: Fq)

Performs the += operation.

impl Clone for Fq

fn clone(&self) -> Fq

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl ConditionallySelectable for Fq

fn conditional_select(a: &Fq, b: &Fq, choice: Choice) -> Fq

Select a or b according to choice.

fn conditional_assign(&mut self, other: &Self, choice: Choice)

Conditionally assign other to self, according to choice.

fn conditional_swap(a: &mut Self, b: &mut Self, choice: Choice)

Conditionally swap self and other if choice == 1; otherwise, reassign both unto themselves.

impl ConstantTimeEq for Fq

fn ct_eq(&self, other: &Fq) -> Choice

Determine if two items are equal.

fn ct_ne(&self, other: &Self) -> Choice

Determine if two items are NOT equal.

impl Debug for Fq

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl Default for Fq

fn default() -> Fq

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Fq

fn deserialize<D>(d: D) -> Result<Fq, <D as Deserializer<'de>>::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Fq

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl Field for Fq

const ZERO: Fq = ZERO

The zero element of the field, the additive identity.

const ONE: Fq = R

The one element of the field, the multiplicative identity.

fn random(rng: impl RngCore) -> Fq

Returns an element chosen uniformly at random using a user-provided RNG.

fn is_zero(&self) -> Choice

Returns true iff this element is zero.

fn square(&self) -> Fq

Squares this element.

fn double(&self) -> Fq

Doubles this element.

fn invert(&self) -> CtOption<Fq>

Computes the multiplicative inverse of this element, failing if the element is zero.

fn sqrt(&self) -> CtOption<Fq>

Returns the square root of the field element, if it is quadratic residue.

fn sqrt_ratio(num: &Fq, div: &Fq) -> (Choice, Fq)

Computes:

fn is_zero_vartime(&self) -> bool

Returns true iff this element is zero.

fn cube(&self) -> Self

Cubes this element.

fn sqrt_alt(&self) -> (Choice, Self)

Equivalent to Self::sqrt_ratio(self, one()).

fn pow<S>(&self, exp: S) -> Self

where S: AsRef<[u64]>,

Exponentiates self by exp, where exp is a little-endian order integer exponent.

fn pow_vartime<S>(&self, exp: S) -> Self

where S: AsRef<[u64]>,

Exponentiates self by exp, where exp is a little-endian order integer exponent.

impl From<Position> for JubjubBase

fn from(value: Position) -> Self

Converts to this type from the input type.

impl From<blst_fr> for Fq

fn from(val: blst_fr) -> Fq

Converts to this type from the input type.

impl From<u64> for Fq

fn from(val: u64) -> Fq

Converts to this type from the input type.

impl FromUniformBytes<64> for Fq

fn from_uniform_bytes(bytes: &[u8; 64]) -> Fq

Returns a field element that is congruent to the provided little endian unsigned byte representation of an integer.

impl Hash for Fq

fn hash<H>(&self, state: &mut H)

where H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Hashable<PoseidonState<Fq>> for Fq

fn to_input(&self) -> Vec<Fq>

Converts the hashable type to a format that can be hashed with H

fn to_bytes(&self) -> Vec<u8>

Converts the hashable type to bytes to be added to the transcript.

fn read(buffer: &mut impl Read) -> Result<Fq, Error>

Reads bytes from a buffer and returns Self.

impl Hashable<State> for Fq

fn to_input(&self) -> Vec<u8>

Converts the hashable type to a format that can be hashed with H

fn to_bytes(&self) -> Vec<u8>

Converts the hashable type to bytes to be added to the transcript.

fn read(buffer: &mut impl Read) -> Result<Fq, Error>

Reads bytes from a buffer and returns Self.

impl Into<blst_scalar> for Fq

fn into(self) -> blst_scalar

Converts this type into the (usually inferred) input type.

impl Legendre for Fq

fn legendre(&self) -> i64

Compute the Legendre symbol of this field element.

fn ct_quadratic_non_residue(&self) -> Choice

Returns Choice(1) if this element is a quadratic non-residue.

fn ct_quadratic_residue(&self) -> Choice

Returns Choice(1) if this element is a quadratic residue. Note: 0 is considered a quadratic residue.

impl MapToEdwardsParams<Fq> for JubjubExtended

const MONT_J: Fq

J constant of Montgomery curve: K * y^2 = x^3 + J * x^2 + x.

const MONT_K: Fq

K constant of Montgomery curve: K * y^2 = x^3 + J * x^2 + x.

impl Mul<&Fq> for &Fq

type Output = Fq

The resulting type after applying the * operator.

fn mul(self, rhs: &Fq) -> Fq

Performs the * operation.

impl Mul<&Fq> for Fq

type Output = Fq

The resulting type after applying the * operator.

fn mul(self, rhs: &Fq) -> Fq

Performs the * operation.

impl Mul<Fq> for &Fq

type Output = Fq

The resulting type after applying the * operator.

fn mul(self, rhs: Fq) -> Fq

Performs the * operation.

impl Mul for Fq

type Output = Fq

The resulting type after applying the * operator.

fn mul(self, rhs: Fq) -> Fq

Performs the * operation.

impl MulAssign<&Fq> for Fq

fn mul_assign(&mut self, rhs: &Fq)

Performs the *= operation.

impl MulAssign for Fq

fn mul_assign(&mut self, rhs: Fq)

Performs the *= operation.

impl Neg for &Fq

type Output = Fq

The resulting type after applying the - operator.

fn neg(self) -> Fq

Performs the unary - operation.

impl Neg for Fq

type Output = Fq

The resulting type after applying the - operator.

fn neg(self) -> Fq

Performs the unary - operation.

impl Ord for Fq

fn cmp(&self, other: &Fq) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for Fq

fn eq(&self, other: &Fq) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for Fq

fn partial_cmp(&self, other: &Fq) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl PoseidonField for Fq

const ROUND_CONSTANTS: [[Fq; 3]; 68]

The constants added to Poseidon’s state on every round.

const MDS: [[Fq; 3]; 3]

The MDS matrix used for the linear layer at each round of Poseidon.

impl PrimeField for Fq

const TWO_INV: Fq

2^-1

const ROOT_OF_UNITY_INV: Fq

ROOT_OF_UNITY^-1

const DELTA: Fq

In other words, this is a t root of unity.

const MODULUS: &'static str = "0x73eda753299d7d483339d80809a1d80553bda402fffe5bfeffffffff00000001"

Constant representing the modulus

fn from_repr(repr: <Fq as PrimeField>::Repr) -> CtOption<Fq>

Converts a little-endian non-Montgomery form repr into a Montgomery form Fq.

fn to_repr(&self) -> <Fq as PrimeField>::Repr

Converts a Montgomery form Fq into little-endian non-Montgomery from.

const NUM_BITS: u32 = NUM_BITS

How many bits are needed to represent an element of this field.

const CAPACITY: u32

How many bits of information can be reliably stored in the field element.

const S: u32 = S

An integer s satisfying the equation 2^s * t = modulus - 1 with t odd.

const MULTIPLICATIVE_GENERATOR: Fq = GENERATOR

A fixed multiplicative generator of modulus - 1 order. This element must also be a quadratic nonresidue.

const ROOT_OF_UNITY: Fq = ROOT_OF_UNITY

The 2^s root of unity.

type Repr = [u8; 32]

The prime field can be converted back and forth into this binary representation.

fn from_repr_vartime(repr: <Fq as PrimeField>::Repr) -> Option<Fq>

Attempts to convert a byte representation of a field element into an element of this prime field, failing if the input is not canonical (is not smaller than the field’s modulus).

fn is_odd(&self) -> Choice

Returns true iff this element is odd.

fn from_str_vartime(s: &str) -> Option<Self>

Interpret a string of numbers as a (congruent) prime field element. Does not accept unnecessary leading zeroes or a blank string.

fn from_u128(v: u128) -> Self

Obtains a field element congruent to the integer v.

fn is_even(&self) -> Choice

Returns true iff this element is even.

impl PrimeFieldBits for Fq

type ReprBits = [u64; 4]

The backing store for a bit representation of a prime field element.

fn to_le_bits(&self) -> BitArray<<Fq as PrimeFieldBits>::ReprBits>

Converts an element of the prime field into a little-endian sequence of bits.

fn char_le_bits() -> BitArray<<Fq as PrimeFieldBits>::ReprBits>

Returns the bits of the field characteristic (the modulus) in little-endian order.

impl<T> Product<T> for Fq

where T: Borrow<Fq>,

fn product<I>(iter: I) -> Fq

where I: Iterator<Item = T>,

Takes an iterator and generates Self from the elements by multiplying the items.

impl Sampleable<PoseidonState<Fq>> for Fq

fn sample(out: Fq) -> Fq

Converts H’s output to Self

impl Sampleable<State> for Fq

fn sample(hash_output: Vec<u8>) -> Fq

Converts H’s output to Self

impl SerdeObject for Fq

fn from_raw_bytes_unchecked(bytes: &[u8]) -> Fq

The purpose of unchecked functions is to read the internal memory representation of a type from bytes as quickly as possible. No sanitization checks are performed to ensure the bytes represent a valid object. As such this function should only be used internally as an extension of machine memory. It should not be used to deserialize externally provided data.

fn from_raw_bytes(bytes: &[u8]) -> Option<Fq>

Read the internal memory representation from bytes. Returns None if the bytes do not represent a valid object.

fn to_raw_bytes(&self) -> Vec<u8>

Convert the internal memory representation to bytes.

fn read_raw_unchecked<R>(reader: &mut R) -> Fq

where R: Read,

The purpose of unchecked functions is to read the internal memory representation of a type from disk as quickly as possible. No sanitization checks are performed to ensure the bytes represent a valid object. This function should only be used internally when some machine state cannot be kept in memory (e.g., between runs) and needs to be reloaded as quickly as possible.

fn read_raw<R>(reader: &mut R) -> Result<Fq, Error>

where R: Read,

Read the internal memory representation from a reader.

fn write_raw<W>(&self, writer: &mut W) -> Result<(), Error>

where W: Write,

Write the internal memory representation to a writer.

impl Serialize for Fq

fn serialize<S>( &self, s: S, ) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl Sub<&Fq> for &Fq

type Output = Fq

The resulting type after applying the - operator.

fn sub(self, rhs: &Fq) -> Fq

Performs the - operation.

impl Sub<&Fq> for Fq

type Output = Fq

The resulting type after applying the - operator.

fn sub(self, rhs: &Fq) -> Fq

Performs the - operation.

impl Sub<Fq> for &Fq

type Output = Fq

The resulting type after applying the - operator.

fn sub(self, rhs: Fq) -> Fq

Performs the - operation.

impl Sub for Fq

type Output = Fq

The resulting type after applying the - operator.

fn sub(self, rhs: Fq) -> Fq

Performs the - operation.

impl SubAssign<&Fq> for Fq

fn sub_assign(&mut self, rhs: &Fq)

Performs the -= operation.

impl SubAssign for Fq

fn sub_assign(&mut self, rhs: Fq)

Performs the -= operation.

impl<T> Sum<T> for Fq

where T: Borrow<Fq>,

fn sum<I>(iter: I) -> Fq

where I: Iterator<Item = T>,

Takes an iterator and generates Self from the elements by “summing up” the items.

impl WithSmallOrderMulGroup<3> for Fq

const ZETA: Fq

A field element of small multiplicative order $N$.

impl Copy for Fq

impl Eq for Fq