Struct PoseidonPermutation

pub struct PoseidonPermutation<const NAME: u32, F: PrimeField, const R: usize, const N: usize> {
    pub full_rounds: usize,
    pub partial_rounds: usize,
    pub alpha: u64,
    pub ark: &'static [[F; N]],
    pub mds: &'static [[F; N]],
    pub state: [F; N],
}

Poseidon Sponge.

The NAME const is to distinbuish between different bitsizes of the same Field. For instance Bls12_381 and Bn254 both have field type Fp<MontBackend<FrConfig, 4>, 4> but are different fields.

Fields

full_rounds: usize

Number of rounds in a full-round operation.

partial_rounds: usize

Number of rounds in a partial-round operation.

alpha: u64

Exponent used in S-boxes.

ark: &'static [[F; N]]

Additive Round keys. These are added before each MDS matrix application to make it an affine shift. They are indexed by ark[round_num][state_element_index]

mds: &'static [[F; N]]

Maximally Distance Separating (MDS) Matrix.

state: [F; N]

Permutation state

Trait Implementations

impl<const NAME: u32, F: PrimeField, const R: usize, const N: usize> AsMut<[F]> for PoseidonPermutation<NAME, F, R, N>

fn as_mut(&mut self) -> &mut [F]

Converts this type into a mutable reference of the (usually inferred) input type.

impl<const NAME: u32, F: PrimeField, const R: usize, const N: usize> AsRef<[F]> for PoseidonPermutation<NAME, F, R, N>

fn as_ref(&self) -> &[F]

Converts this type into a shared reference of the (usually inferred) input type.

impl<const NAME: u32, F: Clone + PrimeField, const R: usize, const N: usize> Clone for PoseidonPermutation<NAME, F, R, N>

fn clone(&self) -> PoseidonPermutation<NAME, F, R, N>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<const NAME: u32, F: PrimeField, const R: usize, const N: usize> Debug for PoseidonPermutation<NAME, F, R, N>

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

Formats the value using the given formatter.

impl<const NAME: u32, F, const R: usize, const N: usize> Permutation for PoseidonPermutation<NAME, F, R, N>

where Self: Default, F: PrimeField + Unit,

const N: usize = N

The width of the sponge, equal to rate Permutation::R plus capacity. Cannot be less than 1. Cannot be less than Permutation::R.

const R: usize = R

The rate of the sponge.

type U = F

The basic unit over which the sponge operates.

fn new(iv: [u8; 32]) -> Self

Initialize the state of the sponge using 32 bytes of seed.

fn permute(&mut self)

Permute the state of the sponge.

impl<const NAME: u32, F: PrimeField, const R: usize, const N: usize> Zeroize for PoseidonPermutation<NAME, F, R, N>

fn zeroize(&mut self)

Zero out this object from memory using Rust intrinsics which ensure the zeroization operation is not “optimized away” by the compiler.