Struct snarkvm_wasm::algorithms::BHP

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

Expand description

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. Read more

1.0.0 · source

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

Performs copy-assignment from source. Read more

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.

Auto Trait Implementations

impl<E, const NUM_WINDOWS: u8, const WINDOW_SIZE: u8> RefUnwindSafe for BHP<E, NUM_WINDOWS, WINDOW_SIZE>where
<E as Environment>::Projective: RefUnwindSafe,

impl<E, const NUM_WINDOWS: u8, const WINDOW_SIZE: u8> Send for BHP<E, NUM_WINDOWS, WINDOW_SIZE>

impl<E, const NUM_WINDOWS: u8, const WINDOW_SIZE: u8> Sync for BHP<E, NUM_WINDOWS, WINDOW_SIZE>

impl<E, const NUM_WINDOWS: u8, const WINDOW_SIZE: u8> Unpin for BHP<E, NUM_WINDOWS, WINDOW_SIZE>

impl<E, const NUM_WINDOWS: u8, const WINDOW_SIZE: u8> UnwindSafe for BHP<E, NUM_WINDOWS, WINDOW_SIZE>where
<E as Environment>::Projective: RefUnwindSafe,

Blanket Implementations

source

impl<T> Any for Twhere
T: 'static + ?Sized,

source

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

impl<T> Borrow<T> for Twhere
T: ?Sized,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

impl<T> BorrowMut<T> for Twhere
T: ?Sized,

const: unstable · source

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

source

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

source

impl<T> Instrument for T

source

fn instrument(self, span: Span) -> Instrumented<Self>ⓘNotable traits for Instrumented<T>`impl<T> Future for Instrumented<T>where T: Future, type Output = <T as Future>::Output;`

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

source

fn in_current_span(self) -> Instrumented<Self>ⓘNotable traits for Instrumented<T>`impl<T> Future for Instrumented<T>where T: Future, type Output = <T as Future>::Output;`

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

source

impl<T, U> Into for Twhere
U: From<T>,

const: unstable · source

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> Pointable for T

const ALIGN: usize = mem::align_of::<T>()

The alignment of pointer.

type Init = T

The type for initializers.

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more

source

impl<T> Same<T> for T

type Output = T

Should always be Self

source

impl<T> ToOwned for Twhere
T: Clone,

type Owned = T

The resulting type after obtaining ownership.

source

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

source

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

source

impl<T, U> TryFrom for Twhere
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

source

impl<T, U> TryInto for Twhere
U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

impl<V, T> VZip<V> for Twhere
V: MultiLane<T>,

fn vzip(self) -> V

source

impl<T> WithSubscriber for T

source

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>ⓘNotable traits for WithDispatch<T>`impl<T> Future for WithDispatch<T>where T: Future, type Output = <T as Future>::Output;`where
S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more

source

fn with_current_subscriber(self) -> WithDispatch<Self>ⓘNotable traits for WithDispatch<T>`impl<T> Future for WithDispatch<T>where T: Future, type Output = <T as Future>::Output;`

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more

Struct snarkvm_wasm::algorithms::BHP

Design

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>

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

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

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

pub fn num_windows(&self) -> u8

pub fn window_size(&self) -> u8

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>

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

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>

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>

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>

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>

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>

type Hash = Field<E>

type Leaf = Vec<bool, Global>

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

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>

type Hash = Field<E>

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

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

Auto Trait Implementations

impl<E, const NUM_WINDOWS: u8, const WINDOW_SIZE: u8> RefUnwindSafe for BHP<E, NUM_WINDOWS, WINDOW_SIZE>where <E as Environment>::Projective: RefUnwindSafe,

impl<E, const NUM_WINDOWS: u8, const WINDOW_SIZE: u8> Send for BHP<E, NUM_WINDOWS, WINDOW_SIZE>

impl<E, const NUM_WINDOWS: u8, const WINDOW_SIZE: u8> Sync for BHP<E, NUM_WINDOWS, WINDOW_SIZE>

impl<E, const NUM_WINDOWS: u8, const WINDOW_SIZE: u8> Unpin for BHP<E, NUM_WINDOWS, WINDOW_SIZE>

impl<E, const NUM_WINDOWS: u8, const WINDOW_SIZE: u8> UnwindSafe for BHP<E, NUM_WINDOWS, WINDOW_SIZE>where <E as Environment>::Projective: RefUnwindSafe,

Blanket Implementations

impl<T> Any for Twhere T: 'static + ?Sized,

fn type_id(&self) -> TypeId

impl<T> Borrow<T> for Twhere T: ?Sized,

fn borrow(&self) -> &T

impl<T> BorrowMut<T> for Twhere T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

impl<T> From<T> for T

fn from(t: T) -> T

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>ⓘNotable traits for Instrumented<T>impl<T> Future for Instrumented<T>where T: Future, type Output = <T as Future>::Output;

fn in_current_span(self) -> Instrumented<Self>ⓘNotable traits for Instrumented<T>impl<T> Future for Instrumented<T>where T: Future, type Output = <T as Future>::Output;

impl<T, U> Into<U> for Twhere U: From<T>,

fn into(self) -> U

impl<T> Pointable for T

const ALIGN: usize = mem::align_of::<T>()

type Init = T

unsafe fn init(init: <T as Pointable>::Init) -> usize

unsafe fn deref<'a>(ptr: usize) -> &'a T

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

unsafe fn drop(ptr: usize)

impl<T> Same<T> for T

type Output = T

impl<T> ToOwned for Twhere T: Clone,

type Owned = T

fn to_owned(&self) -> T

fn clone_into(&self, target: &mut T)

impl<T, U> TryFrom<U> for Twhere U: Into<T>,

type Error = Infallible

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

impl<T, U> TryInto<U> for Twhere U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

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

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

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>

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>

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>

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>

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>

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

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>

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

impl<E, const NUM_WINDOWS: u8, const WINDOW_SIZE: u8> RefUnwindSafe for BHP<E, NUM_WINDOWS, WINDOW_SIZE>where
<E as Environment>::Projective: RefUnwindSafe,

impl<E, const NUM_WINDOWS: u8, const WINDOW_SIZE: u8> UnwindSafe for BHP<E, NUM_WINDOWS, WINDOW_SIZE>where
<E as Environment>::Projective: RefUnwindSafe,

impl<T> Any for Twhere
T: 'static + ?Sized,

impl<T> Borrow<T> for Twhere
T: ?Sized,

impl<T> BorrowMut<T> for Twhere
T: ?Sized,

fn instrument(self, span: Span) -> Instrumented<Self>ⓘNotable traits for Instrumented<T>`impl<T> Future for Instrumented<T>where T: Future, type Output = <T as Future>::Output;`

fn in_current_span(self) -> Instrumented<Self>ⓘNotable traits for Instrumented<T>`impl<T> Future for Instrumented<T>where T: Future, type Output = <T as Future>::Output;`

impl<T, U> Into<U> for Twhere
U: From<T>,

impl<T> ToOwned for Twhere
T: Clone,

impl<T, U> TryFrom<U> for Twhere
U: Into<T>,

impl<T, U> TryInto<U> for Twhere
U: TryFrom<T>,

impl<V, T> VZip<V> for Twhere
V: MultiLane<T>,

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>ⓘNotable traits for WithDispatch<T>`impl<T> Future for WithDispatch<T>where T: Future, type Output = <T as Future>::Output;`where
S: Into<Dispatch>,

fn with_current_subscriber(self) -> WithDispatch<Self>ⓘNotable traits for WithDispatch<T>`impl<T> Future for WithDispatch<T>where T: Future, type Output = <T as Future>::Output;`