Struct FieldElement 

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

Represents a field element of the base field (Fq) in the World ID Protocol.

The World ID Protocol uses the BabyJubJub curve throughout. Note the base field of BabyJubJub is the scalar field of the BN254 curve.

This wrapper ensures consistent serialization and deserialization of field elements, where string-based serialization is done with hex encoding and binary serialization is done with byte vectors.

Implementations

impl FieldElement

pub const ZERO: Self

The additive identity of the field.

pub const ONE: Self

The multiplicative identity of the field.

pub fn serialize_as_bytes<W: Write>( &self, writer: &mut W, ) -> Result<(), PrimitiveError>

Serializes the field element into a byte vector.

Errors

Will return an error if the serialization unexpectedly fails.

pub fn deserialize_from_bytes<R: Read>( bytes: &mut R, ) -> Result<Self, PrimitiveError>

Deserializes a field element from a byte vector.

Errors

Will return an error if the provided input is not a valid field element (e.g. not on the curve).

pub fn from_be_bytes_mod_order(bytes: &[u8]) -> Self

Deserializes a field element from a big-endian byte slice.

pub fn from_arbitrary_raw_bytes(bytes: &[u8]) -> Self

Takes arbitrary raw bytes, hashes them with a byte-friendly gas-efficient hash function and reduces it to a field element.

pub fn random<R: CryptoRng + RngCore>(rng: &mut R) -> Self

Generates a random field element using the system’s CSPRNG.

Trait Implementations

impl Clone for FieldElement

fn clone(&self) -> FieldElement

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FieldElement

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

Formats the value using the given formatter.

impl Default for FieldElement

fn default() -> FieldElement

Returns the “default value” for a type.

impl Deref for FieldElement

type Target = Fp<MontBackend<FrConfig, 4>, 4>

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl DerefMut for FieldElement

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl<'de> Deserialize<'de> for FieldElement

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for FieldElement

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

Formats the value using the given formatter.

impl From<FieldElement> for U256

fn from(value: FieldElement) -> Self

Converts to this type from the input type.

impl From<Fp<MontBackend<FrConfig, 4>, 4>> for FieldElement

fn from(value: Fq) -> Self

Converts to this type from the input type.

impl From<RpId> for FieldElement

fn from(value: RpId) -> Self

Converts to this type from the input type.

impl From<Uint<160, 3>> for FieldElement

fn from(value: U160) -> Self

Converts to this type from the input type.

impl From<u128> for FieldElement

fn from(value: u128) -> Self

Converts to this type from the input type.

impl From<u64> for FieldElement

fn from(value: u64) -> Self

Converts to this type from the input type.

impl FromStr for FieldElement

type Err = PrimitiveError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl Hash for FieldElement

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

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 Ord for FieldElement

fn cmp(&self, other: &FieldElement) -> 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 FieldElement

fn eq(&self, other: &FieldElement) -> 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 FieldElement

fn partial_cmp(&self, other: &FieldElement) -> 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 Serialize for FieldElement

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<Uint<256, 4>> for FieldElement

type Error = PrimitiveError

The type returned in the event of a conversion error.

fn try_from(value: U256) -> Result<Self, Self::Error>

Performs the conversion.

impl Copy for FieldElement

impl Eq for FieldElement

impl StructuralPartialEq for FieldElement