Struct Poseidon 

pub struct Poseidon<E: Environment, const RATE: usize> { /* private fields */ }

Implementations

impl<E: Environment, const RATE: usize> Poseidon<E, RATE>

pub fn setup(domain: &str) -> Result<Self>

Initializes a new instance of Poseidon.

pub fn domain(&self) -> Field<E>

Returns the domain separator for the hash function.

pub fn parameters(&self) -> &Arc<PoseidonParameters<E::Field, RATE, CAPACITY>>

Returns the Poseidon parameters for hashing.

pub fn merkle_empty_hash(&self) -> Result<Field<E>>

Returns the Merkle empty hash of this instance, computing it on first use.

This is PathHash::hash_children(0, 0) from snarkvm-console-collections, and test_cached_empty_hash_matches_the_computed_one checks that the two agree. The hash depends on the domain, so it is cached per instance, not per type.

Trait Implementations

impl<E: Clone + Environment, const RATE: usize> Clone for Poseidon<E, RATE>

where E::Field: Clone,

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<E: Debug + Environment, const RATE: usize> Debug for Poseidon<E, RATE>

where E::Field: Debug,

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

Formats the value using the given formatter.

impl<E: Environment, const RATE: usize> Hash for Poseidon<E, RATE>

fn hash(&self, input: &[Self::Input]) -> Result<Self::Output>

Returns the cryptographic hash for a list of field elements as input.

type Input = Field<E>

type Output = Field<E>

impl<E: Environment, const RATE: usize> HashMany for Poseidon<E, RATE>

fn hash_many( &self, input: &[Self::Input], num_outputs: u16, ) -> Vec<Self::Output>

Returns the cryptographic hash for a list of field elements as input, and returns the specified number of field elements as output.

type Input = Field<E>

type Output = Field<E>

impl<E: Environment, const RATE: usize> HashToGroup for Poseidon<E, RATE>

fn hash_to_group(&self, input: &[Self::Input]) -> Result<Self::Output>

Returns a group element from hashing the input.

type Input = Field<E>

type Output = Group<E>

impl<E: Environment, const RATE: usize> HashToScalar for Poseidon<E, RATE>

fn hash_to_scalar(&self, input: &[Self::Input]) -> Result<Self::Output>

Returns a scalar from hashing the input. This method uses truncation (up to data bits) to project onto the scalar field.

type Input = Field<E>

type Output = Scalar<E>

impl<E: Environment, const RATE: usize> PRF for Poseidon<E, RATE>

type Input = Field<E>

type Output = Field<E>

type Seed = Field<E>

fn prf(&self, seed: &Self::Seed, input: &[Self::Input]) -> Result<Self::Output>

Returns the output for the given seed and input.

impl<E: Environment, const RATE: usize> PartialEq for Poseidon<E, RATE>

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

Ignores the cached empty hash, which is derived from the domain and parameters.

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

Inequality operator !=.