Struct snarkvm_algorithms::crypto_hash::poseidon::PoseidonSponge

pub struct PoseidonSponge<F: PrimeField, const RATE: usize, const CAPACITY: usize> {
    pub mode: DuplexSpongeMode,
    /* private fields */
}

A duplex sponge based using the Poseidon permutation.

This implementation of Poseidon is entirely from Fractal’s implementation in COS20 with small syntax changes.

Fields

mode: DuplexSpongeMode

Current mode (whether its absorbing or squeezing)

Implementations

impl<F: PrimeField, const RATE: usize> PoseidonSponge<F, RATE, 1>

pub fn compress_elements<TargetField: PrimeField>(
    src_limbs: &[(F, F)],
    ty: OptimizationType
) -> Vec<F>

Compress every two elements if possible. Provides a vector of (limb, num_of_additions), both of which are F.

pub fn get_limbs_representations<TargetField: PrimeField>(
    elem: &TargetField,
    optimization_type: OptimizationType
) -> SmallVec<[F; 10]>

Convert a TargetField element into limbs (not constraints) This is an internal function that would be reused by a number of other functions

pub fn get_limbs_representations_from_big_integer<TargetField: PrimeField>(
    elem: &<TargetField as PrimeField>::BigInteger,
    optimization_type: OptimizationType
) -> SmallVec<[F; 10]>

Obtain the limbs directly from a big int

pub fn push_elements_to_sponge<TargetField: PrimeField>(
    &mut self,
    src: impl IntoIterator<Item = TargetField>,
    ty: OptimizationType
)

Push elements to sponge, treated in the non-native field representations.

pub fn get_bits(&mut self, num_bits: usize) -> Vec<bool>

obtain random bits from hashchain. not guaranteed to be uniformly distributed, should only be used in certain situations.

pub fn get_fe<TargetField: PrimeField>(
    &mut self,
    num_elements: usize,
    outputs_short_elements: bool
) -> SmallVec<[TargetField; 10]>

obtain random field elements from hashchain. not guaranteed to be uniformly distributed, should only be used in certain situations.

Trait Implementations

impl<F: PrimeField, const RATE: usize> AlgebraicSponge<F, RATE> for PoseidonSponge<F, RATE, 1>

fn absorb_native_field_elements<T: ToConstraintField<F>>(
    &mut self,
    elements: &[T]
)

Takes in field elements.

fn absorb_nonnative_field_elements<Target: PrimeField>(
    &mut self,
    elements: impl IntoIterator<Item = Target>
)

Takes in field elements.

fn squeeze_short_nonnative_field_elements<Target: PrimeField>(
    &mut self,
    num: usize
) -> SmallVec<[Target; 10]>

Takes out field elements of 168 bits.

type Parameters = Arc<PoseidonParameters<F, RATE, 1>>

Parameters used by the sponge.

fn sample_parameters() -> Self::Parameters

fn new_with_parameters(parameters: &Self::Parameters) -> Self

Initialize a new instance of the sponge.

fn squeeze_nonnative_field_elements<Target: PrimeField>(
    &mut self,
    num: usize
) -> SmallVec<[Target; 10]>

Takes out field elements.

fn squeeze_native_field_elements(
    &mut self,
    num_elements: usize
) -> SmallVec<[F; 10]>

Takes in field elements.

fn new() -> Self

Initialize a new instance of the sponge.

fn absorb_bytes(&mut self, elements: &[u8])

Takes in bytes.

fn squeeze_short_nonnative_field_element<Target: PrimeField>(
    &mut self
) -> Target

Takes out a field element of 168 bits.

impl<F: Clone + PrimeField, const RATE: usize, const CAPACITY: usize> Clone for PoseidonSponge<F, RATE, CAPACITY>

fn clone(&self) -> PoseidonSponge<F, RATE, CAPACITY>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<F: Debug + PrimeField, const RATE: usize, const CAPACITY: usize> Debug for PoseidonSponge<F, RATE, CAPACITY>

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

Formats the value using the given formatter.