Struct CommitEngine

pub struct CommitEngine { /* private fields */ }

A helper engine used in computing commitment ids.

Implementations

impl CommitEngine

pub fn new(tag: &'static str) -> Self

Initialize the engine using a type-specific tag string.

The tag should be in a form of a valid URN, ending with a fragment specifying the date of the tag, or other form of versioning.

pub fn commit_to_serialized<T: StrictEncode>(&mut self, value: &T)

Add a commitment to a strict-encoded value.

pub fn commit_to_option<T: StrictEncode + StrictDumb>( &mut self, value: &Option<T>, )

Add a commitment to a strict-encoded optional value.

pub fn commit_to_hash<T: CommitEncode<CommitmentId = StrictHash> + StrictType>( &mut self, value: &T, )

Add a commitment to a value which supports StrictHashing.

pub fn commit_to_merkle<T: MerkleLeaves>(&mut self, value: &T)

where T::Leaf: StrictType,

Add a commitment to a merklized collection.

The collection must implement MerkleLeaves trait.

pub fn commit_to_concealed<T>(&mut self, value: &T)

where T: Conceal + StrictType, T::Concealed: StrictEncode,

Add a commitment to a type which supports Conceal procedure (hiding some of its data).

First, the conceal procedure is called for the value, and then the resulting data are serialized using strict encoding.

pub fn commit_to_linear_list<T, const MIN: usize, const MAX: usize>( &mut self, collection: &Confined<Vec<T>, MIN, MAX>, )

where T: StrictEncode + StrictDumb,

Add a commitment to a vector collection.

Does not use merklization and encodes each element as strict encoding binary data right in to the hasher.

Additionally to all elements, commits to the length of the collection and minimal and maximal dimensions of the confinement.

pub fn commit_to_linear_set<T, const MIN: usize, const MAX: usize>( &mut self, collection: &Confined<BTreeSet<T>, MIN, MAX>, )

where T: Ord + StrictEncode + StrictDumb,

Add a commitment to a set collection.

Does not use merklization and encodes each element as strict encoding binary data right in to the hasher.

Additionally to all elements, commits to the length of the collection and minimal and maximal dimensions of the confinement.

pub fn commit_to_linear_map<K, V, const MIN: usize, const MAX: usize>( &mut self, collection: &Confined<BTreeMap<K, V>, MIN, MAX>, )

where K: Ord + Hash + StrictEncode + StrictDumb, V: StrictEncode + StrictDumb,

Add a commitment to a mapped collection.

Does not use merklization and encodes each element as strict encoding binary data right in to the hasher.

Additionally to all keys and values, commits to the length of the collection and minimal and maximal dimensions of the confinement.

pub fn as_layout(&mut self) -> &[CommitStep]

Get a reference for the underlying sequence of commit steps.

pub fn into_layout(self) -> TinyVec<CommitStep>

Convert into the underlying sequence of commit steps.

pub fn set_finished(&mut self)

Mark the procedure as completed, preventing any further data from being added.

pub fn finish(self) -> Sha256

Complete the commitment returning the resulting hash.

pub fn finish_layout(self) -> (Sha256, TinyVec<CommitStep>)

Complete the commitment returning the resulting hash and the description of all commitment steps performed during the procedure.

Trait Implementations

impl Clone for CommitEngine

fn clone(&self) -> CommitEngine

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CommitEngine

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

Formats the value using the given formatter.