pub struct UniversalMerkleTree<E, H, I, const ARITY: usize, T>{ /* private fields */ }
Expand description
A standard append only Merkle tree implementation
Implementations§
Source§impl<E, H, I, const ARITY: usize, T> UniversalMerkleTree<E, H, I, ARITY, T>
impl<E, H, I, const ARITY: usize, T> UniversalMerkleTree<E, H, I, ARITY, T>
Sourcepub fn from_kv_set<BI, BE>(
height: usize,
data: impl IntoIterator<Item = impl Borrow<(BI, BE)>>,
) -> Result<Self, MerkleTreeError>
pub fn from_kv_set<BI, BE>( height: usize, data: impl IntoIterator<Item = impl Borrow<(BI, BE)>>, ) -> Result<Self, MerkleTreeError>
Build a universal merkle tree from a key-value set.
height
- height of the merkle treedata
- an iterator of key-value pairs. Could be a hashmap or simply an array or a slice of (key, value) pairs
Trait Implementations§
Source§impl<E, H, I, const ARITY: usize, T> Clone for UniversalMerkleTree<E, H, I, ARITY, T>
impl<E, H, I, const ARITY: usize, T> Clone for UniversalMerkleTree<E, H, I, ARITY, T>
Source§fn clone(&self) -> UniversalMerkleTree<E, H, I, ARITY, T>
fn clone(&self) -> UniversalMerkleTree<E, H, I, ARITY, T>
Returns a copy of the value. Read more
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from
source
. Read moreSource§impl<E, H, I, const ARITY: usize, T> Debug for UniversalMerkleTree<E, H, I, ARITY, T>
impl<E, H, I, const ARITY: usize, T> Debug for UniversalMerkleTree<E, H, I, ARITY, T>
Source§impl<'de, E, H, I, const ARITY: usize, T> Deserialize<'de> for UniversalMerkleTree<E, H, I, ARITY, T>where
E: Element + CanonicalSerialize + CanonicalDeserialize,
H: DigestAlgorithm<E, I, T>,
I: Index + CanonicalSerialize + CanonicalDeserialize,
T: NodeValue,
impl<'de, E, H, I, const ARITY: usize, T> Deserialize<'de> for UniversalMerkleTree<E, H, I, ARITY, T>where
E: Element + CanonicalSerialize + CanonicalDeserialize,
H: DigestAlgorithm<E, I, T>,
I: Index + CanonicalSerialize + CanonicalDeserialize,
T: NodeValue,
Source§fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
Deserialize this value from the given Serde deserializer. Read more
Source§impl<E, H, I, const ARITY: usize, T> ForgetableMerkleTreeScheme for UniversalMerkleTree<E, H, I, ARITY, T>
impl<E, H, I, const ARITY: usize, T> ForgetableMerkleTreeScheme for UniversalMerkleTree<E, H, I, ARITY, T>
Source§fn from_commitment(
com: impl Borrow<Self::Commitment>,
height: usize,
num_leaves: u64,
) -> Self
fn from_commitment( com: impl Borrow<Self::Commitment>, height: usize, num_leaves: u64, ) -> Self
Rebuild a merkle tree from a commitment.
Return a tree which is entirely forgotten.
Source§fn forget(
&mut self,
pos: impl Borrow<Self::Index>,
) -> LookupResult<Self::Element, Self::MembershipProof, ()>
fn forget( &mut self, pos: impl Borrow<Self::Index>, ) -> LookupResult<Self::Element, Self::MembershipProof, ()>
Trim the leaf at position
i
from memory, if present.
Should not trim if position i
is the last inserted leaf position.
Return is identical to result if get_leaf(pos)
were called before this
call.Source§fn remember(
&mut self,
pos: impl Borrow<Self::Index>,
element: impl Borrow<Self::Element>,
proof: impl Borrow<Self::MembershipProof>,
) -> Result<(), MerkleTreeError>
fn remember( &mut self, pos: impl Borrow<Self::Index>, element: impl Borrow<Self::Element>, proof: impl Borrow<Self::MembershipProof>, ) -> Result<(), MerkleTreeError>
“Re-insert” a leaf into the tree using its proof.
Returns Ok(()) if insertion is successful, or Err(err) if the
proof disagrees with the merkle tree
Source§impl<E, H, I, const ARITY: usize, T> ForgetableUniversalMerkleTreeScheme for UniversalMerkleTree<E, H, I, ARITY, T>
impl<E, H, I, const ARITY: usize, T> ForgetableUniversalMerkleTreeScheme for UniversalMerkleTree<E, H, I, ARITY, T>
Source§fn universal_forget(
&mut self,
pos: Self::Index,
) -> LookupResult<Self::Element, Self::MembershipProof, Self::NonMembershipProof>
fn universal_forget( &mut self, pos: Self::Index, ) -> LookupResult<Self::Element, Self::MembershipProof, Self::NonMembershipProof>
WARN(#495): this method breaks non-membership proofs.
Source§fn non_membership_remember(
&mut self,
pos: Self::Index,
proof: impl Borrow<Self::NonMembershipProof>,
) -> Result<(), MerkleTreeError>
fn non_membership_remember( &mut self, pos: Self::Index, proof: impl Borrow<Self::NonMembershipProof>, ) -> Result<(), MerkleTreeError>
“Re-insert” an empty leaf into the tree using its proof. Read more
Source§impl<E, H, I, const ARITY: usize, T> Hash for UniversalMerkleTree<E, H, I, ARITY, T>
impl<E, H, I, const ARITY: usize, T> Hash for UniversalMerkleTree<E, H, I, ARITY, T>
Source§impl<'a, E, H, I, const ARITY: usize, T> IntoIterator for &'a UniversalMerkleTree<E, H, I, ARITY, T>
impl<'a, E, H, I, const ARITY: usize, T> IntoIterator for &'a UniversalMerkleTree<E, H, I, ARITY, T>
Source§impl<E, H, I, const ARITY: usize, T> IntoIterator for UniversalMerkleTree<E, H, I, ARITY, T>
impl<E, H, I, const ARITY: usize, T> IntoIterator for UniversalMerkleTree<E, H, I, ARITY, T>
Source§impl<E, H, I, const ARITY: usize, T> MerkleTreeScheme for UniversalMerkleTree<E, H, I, ARITY, T>
impl<E, H, I, const ARITY: usize, T> MerkleTreeScheme for UniversalMerkleTree<E, H, I, ARITY, T>
Source§type MembershipProof = MerkleTreeProof<T>
type MembershipProof = MerkleTreeProof<T>
Merkle proof
Source§type BatchMembershipProof = ()
type BatchMembershipProof = ()
Batch proof
Source§type Commitment = T
type Commitment = T
Merkle tree commitment
Source§fn num_leaves(&self) -> u64
fn num_leaves(&self) -> u64
Return the current number of leaves
Source§fn commitment(&self) -> Self::Commitment
fn commitment(&self) -> Self::Commitment
Return a merkle commitment
Source§fn lookup(
&self,
pos: impl Borrow<Self::Index>,
) -> LookupResult<&Self::Element, Self::MembershipProof, ()>
fn lookup( &self, pos: impl Borrow<Self::Index>, ) -> LookupResult<&Self::Element, Self::MembershipProof, ()>
Returns the leaf value given a position Read more
Source§impl<E, H, I, const ARITY: usize, T> PartialEq for UniversalMerkleTree<E, H, I, ARITY, T>
impl<E, H, I, const ARITY: usize, T> PartialEq for UniversalMerkleTree<E, H, I, ARITY, T>
Source§fn eq(&self, other: &UniversalMerkleTree<E, H, I, ARITY, T>) -> bool
fn eq(&self, other: &UniversalMerkleTree<E, H, I, ARITY, T>) -> bool
Tests for
self
and other
values to be equal, and is used by ==
.Source§impl<E, H, I, const ARITY: usize, T> PersistentUniversalMerkleTreeScheme for UniversalMerkleTree<E, H, I, ARITY, T>
impl<E, H, I, const ARITY: usize, T> PersistentUniversalMerkleTreeScheme for UniversalMerkleTree<E, H, I, ARITY, T>
Source§fn persistent_update_with<F>(
&self,
pos: impl Borrow<Self::Index>,
f: F,
) -> Result<Self, MerkleTreeError>
fn persistent_update_with<F>( &self, pos: impl Borrow<Self::Index>, f: F, ) -> Result<Self, MerkleTreeError>
A persistent update_with interface, check
PersistentUniversalMerkleTreeScheme and
UniversalMerkleTreeScheme::update_with.
Source§fn persistent_update(
&self,
pos: impl Borrow<Self::Index>,
elem: impl Borrow<Self::Element>,
) -> Result<Self, MerkleTreeError>
fn persistent_update( &self, pos: impl Borrow<Self::Index>, elem: impl Borrow<Self::Element>, ) -> Result<Self, MerkleTreeError>
A non destructive update interface, check
PersistentUniversalMerkleTreeScheme and
UniversalMerkleTreeScheme::update.
Source§fn persistent_remove(&self, pos: Self::Index) -> Result<Self, MerkleTreeError>
fn persistent_remove(&self, pos: Self::Index) -> Result<Self, MerkleTreeError>
A persistent remove interface, check
PersistentUniversalMerkleTreeScheme and
UniversalMerkleTreeScheme::remove.
Source§impl<E, H, I, const ARITY: usize, T> Serialize for UniversalMerkleTree<E, H, I, ARITY, T>where
E: Element + CanonicalSerialize + CanonicalDeserialize,
H: DigestAlgorithm<E, I, T>,
I: Index + CanonicalSerialize + CanonicalDeserialize,
T: NodeValue,
impl<E, H, I, const ARITY: usize, T> Serialize for UniversalMerkleTree<E, H, I, ARITY, T>where
E: Element + CanonicalSerialize + CanonicalDeserialize,
H: DigestAlgorithm<E, I, T>,
I: Index + CanonicalSerialize + CanonicalDeserialize,
T: NodeValue,
Source§impl<E, H, I, const ARITY: usize, T> UniversalMerkleTreeScheme for UniversalMerkleTree<E, H, I, ARITY, T>
impl<E, H, I, const ARITY: usize, T> UniversalMerkleTreeScheme for UniversalMerkleTree<E, H, I, ARITY, T>
Source§type NonMembershipProof = MerkleTreeProof<T>
type NonMembershipProof = MerkleTreeProof<T>
Non membership proof for a given index
Source§type BatchNonMembershipProof = ()
type BatchNonMembershipProof = ()
Batch non membership proof
Source§fn update_with<F>(
&mut self,
pos: impl Borrow<Self::Index>,
f: F,
) -> Result<LookupResult<E, (), ()>, MerkleTreeError>
fn update_with<F>( &mut self, pos: impl Borrow<Self::Index>, f: F, ) -> Result<LookupResult<E, (), ()>, MerkleTreeError>
Apply an update function
f
at a given position Read moreSource§fn non_membership_verify(
commitment: impl Borrow<Self::Commitment>,
pos: impl Borrow<Self::Index>,
proof: impl Borrow<Self::NonMembershipProof>,
) -> Result<Result<(), ()>, MerkleTreeError>
fn non_membership_verify( commitment: impl Borrow<Self::Commitment>, pos: impl Borrow<Self::Index>, proof: impl Borrow<Self::NonMembershipProof>, ) -> Result<Result<(), ()>, MerkleTreeError>
Verify an index is not in this merkle tree Read more
Source§fn universal_lookup(
&self,
pos: impl Borrow<Self::Index>,
) -> LookupResult<&Self::Element, Self::MembershipProof, Self::NonMembershipProof>
fn universal_lookup( &self, pos: impl Borrow<Self::Index>, ) -> LookupResult<&Self::Element, Self::MembershipProof, Self::NonMembershipProof>
Returns the leaf value given a position Read more
impl<E, H, I, const ARITY: usize, T> Eq for UniversalMerkleTree<E, H, I, ARITY, T>
impl<E, H, I, const ARITY: usize, T> StructuralPartialEq for UniversalMerkleTree<E, H, I, ARITY, T>
Auto Trait Implementations§
impl<E, H, I, const ARITY: usize, T> Freeze for UniversalMerkleTree<E, H, I, ARITY, T>
impl<E, H, I, const ARITY: usize, T> RefUnwindSafe for UniversalMerkleTree<E, H, I, ARITY, T>
impl<E, H, I, const ARITY: usize, T> Send for UniversalMerkleTree<E, H, I, ARITY, T>
impl<E, H, I, const ARITY: usize, T> Sync for UniversalMerkleTree<E, H, I, ARITY, T>
impl<E, H, I, const ARITY: usize, T> Unpin for UniversalMerkleTree<E, H, I, ARITY, T>where
H: Unpin,
impl<E, H, I, const ARITY: usize, T> UnwindSafe for UniversalMerkleTree<E, H, I, ARITY, T>
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
§impl<T> Downcast for Twhere
T: Any,
impl<T> Downcast for Twhere
T: Any,
§fn into_any(self: Box<T>) -> Box<dyn Any>
fn into_any(self: Box<T>) -> Box<dyn Any>
Convert
Box<dyn Trait>
(where Trait: Downcast
) to Box<dyn Any>
. Box<dyn Any>
can
then be further downcast
into Box<ConcreteType>
where ConcreteType
implements Trait
.§fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
Convert
Rc<Trait>
(where Trait: Downcast
) to Rc<Any>
. Rc<Any>
can then be
further downcast
into Rc<ConcreteType>
where ConcreteType
implements Trait
.§fn as_any(&self) -> &(dyn Any + 'static)
fn as_any(&self) -> &(dyn Any + 'static)
Convert
&Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &Any
’s vtable from &Trait
’s.§fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
Convert
&mut Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &mut Any
’s vtable from &mut Trait
’s.§impl<T> DowncastSync for T
impl<T> DowncastSync for T
§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
§fn equivalent(&self, key: &K) -> bool
fn equivalent(&self, key: &K) -> bool
Checks if this value is equivalent to the given key. Read more
§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
§fn equivalent(&self, key: &K) -> bool
fn equivalent(&self, key: &K) -> bool
Checks if this value is equivalent to the given key. Read more
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
Converts
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
Converts
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read more