Struct snarkvm_wasm::algorithms::BHP

pub struct BHP<E, const NUM_WINDOWS: u8, const WINDOW_SIZE: u8>where
    E: Environment,{ /* private fields */ }

BHP is a collision-resistant hash function that takes a variable-length input. The BHP hash function does not behave like a random oracle, see Poseidon for one.

Design

The BHP hash function splits the given input into blocks, and processes them iteratively.

The first iteration is initialized as follows:

DIGEST_0 = BHP([ 0...0 || DOMAIN || LENGTH(INPUT) || INPUT[0..BLOCK_SIZE] ]);

Each subsequent iteration is initialized as follows:

DIGEST_N+1 = BHP([ DIGEST_N[0..DATA_BITS] || INPUT[(N+1)*BLOCK_SIZE..(N+2)*BLOCK_SIZE] ]);

Implementations

impl<E, const NUM_WINDOWS: u8, const WINDOW_SIZE: u8> BHP<E, NUM_WINDOWS, WINDOW_SIZE>where
    E: Environment,

pub fn setup(domain: &str) -> Result<BHP<E, NUM_WINDOWS, WINDOW_SIZE>, Error>

Initializes a new instance of BHP with the given domain.

pub fn domain(&self) -> &[bool]

Returns the domain separator for the BHP hash function.

pub fn bases(&self) -> &Arc<Vec<Vec<Group<E>, Global>, Global>>

Returns the bases.

pub fn random_base(&self) -> &Arc<Vec<Group<E>, Global>>

Returns the random base window.

pub fn num_windows(&self) -> u8

Returns the number of windows.

pub fn window_size(&self) -> u8

Returns the window size.

Trait Implementations

impl<E, const NUM_WINDOWS: u8, const WINDOW_SIZE: u8> Clone for BHP<E, NUM_WINDOWS, WINDOW_SIZE>where
    E: Clone + Environment,

fn clone(&self) -> BHP<E, NUM_WINDOWS, WINDOW_SIZE>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<E, const NUM_WINDOWS: u8, const WINDOW_SIZE: u8> Commit for BHP<E, NUM_WINDOWS, WINDOW_SIZE>where
    E: Environment,

fn commit(
    &self,
    input: &[<BHP<E, NUM_WINDOWS, WINDOW_SIZE> as Commit>::Input],
    randomizer: &<BHP<E, NUM_WINDOWS, WINDOW_SIZE> as Commit>::Randomizer
) -> Result<<BHP<E, NUM_WINDOWS, WINDOW_SIZE> as Commit>::Output, Error>

Returns the BHP commitment of the given input and randomizer as a field element.

type Input = bool

type Output = Field<E>

type Randomizer = Scalar<E>

impl<E, const NUM_WINDOWS: u8, const WINDOW_SIZE: u8> CommitUncompressed for BHP<E, NUM_WINDOWS, WINDOW_SIZE>where
    E: Environment,

fn commit_uncompressed(
    &self,
    input: &[<BHP<E, NUM_WINDOWS, WINDOW_SIZE> as CommitUncompressed>::Input],
    randomizer: &<BHP<E, NUM_WINDOWS, WINDOW_SIZE> as CommitUncompressed>::Randomizer
) -> Result<<BHP<E, NUM_WINDOWS, WINDOW_SIZE> as CommitUncompressed>::Output, Error>

Returns the BHP commitment of the given input and randomizer as an affine group element.

type Input = bool

type Output = Group<E>

type Randomizer = Scalar<E>

impl<E, const NUM_WINDOWS: u8, const WINDOW_SIZE: u8> Hash for BHP<E, NUM_WINDOWS, WINDOW_SIZE>where
    E: Environment,

fn hash(
    &self,
    input: &[<BHP<E, NUM_WINDOWS, WINDOW_SIZE> as Hash>::Input]
) -> Result<<BHP<E, NUM_WINDOWS, WINDOW_SIZE> as Hash>::Output, Error>

Returns the BHP hash of the given input as a field element.

type Input = bool

type Output = Field<E>

impl<E, const NUM_WINDOWS: u8, const WINDOW_SIZE: u8> HashUncompressed for BHP<E, NUM_WINDOWS, WINDOW_SIZE>where
    E: Environment,

fn hash_uncompressed(
    &self,
    input: &[<BHP<E, NUM_WINDOWS, WINDOW_SIZE> as HashUncompressed>::Input]
) -> Result<<BHP<E, NUM_WINDOWS, WINDOW_SIZE> as HashUncompressed>::Output, Error>

Returns the BHP hash of the given input as an affine group element.

This uncompressed variant of the BHP hash function is provided to support the BHP commitment scheme, as it is typically not used by applications.

type Input = bool

type Output = Group<E>

impl<E, const NUM_WINDOWS: u8, const WINDOW_SIZE: u8> LeafHash for BHP<E, NUM_WINDOWS, WINDOW_SIZE>where
    E: Environment,

fn hash_leaf(
    &self,
    leaf: &<BHP<E, NUM_WINDOWS, WINDOW_SIZE> as LeafHash>::Leaf
) -> Result<<BHP<E, NUM_WINDOWS, WINDOW_SIZE> as LeafHash>::Hash, Error>

Returns the hash of the given leaf node.

type Hash = Field<E>

type Leaf = Vec<bool, Global>

fn hash_leaves(
    &self,
    leaves: &[Self::Leaf]
) -> Result<Vec<Self::Hash, Global>, Error>

Returns the hash for each leaf node.

impl<E, const NUM_WINDOWS: u8, const WINDOW_SIZE: u8> PathHash for BHP<E, NUM_WINDOWS, WINDOW_SIZE>where
    E: Environment,

fn hash_children(
    &self,
    left: &<BHP<E, NUM_WINDOWS, WINDOW_SIZE> as PathHash>::Hash,
    right: &<BHP<E, NUM_WINDOWS, WINDOW_SIZE> as PathHash>::Hash
) -> Result<<BHP<E, NUM_WINDOWS, WINDOW_SIZE> as PathHash>::Hash, Error>

Returns the hash of the given child nodes.

type Hash = Field<E>

fn hash_empty(&self) -> Result<Self::Hash, Error>

Returns the empty hash.

fn hash_all_children(
    &self,
    child_nodes: &[(Self::Hash, Self::Hash)]
) -> Result<Vec<Self::Hash, Global>, Error>

Returns the hash for each tuple of child nodes.