pub struct SparseMerkleTree<'a, const N: usize, const M: usize, F: FieldElement, H: FieldHasher<F, 2>, S: StorageAdapter<Value = F>> {
    store: S,
    hasher: H,
    empty_nodes: &'a [F; M],
}
Expand description

The Sparse Merkle Tree struct.

SMT stores a set of leaves represented in a map and a set of empty hashes that it uses to represent the sparse areas of the tree.

The trait param N is the depth of the tree. A tree with a depth of N will have N + 1 levels.

Fields§

§store: S

A map from leaf indices to leaf data stored as field elements.

§hasher: H

The hasher used to build the Merkle tree.

§empty_nodes: &'a [F; M]

An array of empty hashes hashed with themselves N times.

Implementations§

source§

impl<'a, const N: usize, const M: usize, F: FieldElement, H: FieldHasher<F, 2>, S: StorageAdapter<Value = F>> SparseMerkleTree<'a, N, M, F, H, S>

source

pub fn new(store: S, hasher: H, empty_nodes: &'a [F; M]) -> Self

Creates a new SMT

source

pub fn insert_batch(&mut self, leaves: Vec<(F, F)>) -> ContractResult

Takes a batch of field elements, inserts these hashes into the tree, and updates the Merkle root.

source

pub fn remove_leaves(&mut self, leaves: Vec<(F, F)>) -> ContractResult

source

pub fn root(&self) -> F

Returns the Merkle tree root.

source

fn recompute_tree(&mut self, dirty_idxs: &mut Vec<BigUint>) -> ContractResult

Recomputes the Merkle tree depth first from the bottom of the tree

source

pub fn prove_membership(&self, pos: &F) -> Path<N, F, H>

Give the path leading from the leaf at index up to the root. This is a “proof” in the sense of “valid path in a Merkle tree”, not a ZK argument.

source

pub fn get_leaf(&self, pos: &F) -> F

Fast lookup for leaf. The SMT can be used as a generic container for objects with very little overhead using this method.

source

fn get_node(&self, idx: &BigUint) -> F

source

fn put_node(&mut self, key: BigUint, value: F) -> ContractResult

source

fn remove_node(&mut self, key: &BigUint) -> ContractResult

Trait Implementations§

source§

impl<'a, const N: usize, const M: usize, F: Clone + FieldElement, H: Clone + FieldHasher<F, 2>, S: Clone + StorageAdapter<Value = F>> Clone for SparseMerkleTree<'a, N, M, F, H, S>

source§

fn clone(&self) -> SparseMerkleTree<'a, N, M, F, H, S>

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
source§

impl<'a, const N: usize, const M: usize, F: Debug + FieldElement, H: Debug + FieldHasher<F, 2>, S: Debug + StorageAdapter<Value = F>> Debug for SparseMerkleTree<'a, N, M, F, H, S>

source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<'a, const N: usize, const M: usize, F, H, S> Freeze for SparseMerkleTree<'a, N, M, F, H, S>
where H: Clone + Freeze, F: PrimeField<Output = F, Output = F, Output = F, Output = F, Output = F, Output = F, Output = F> + From<u64> + Field + for<'a> MulAssign<&'a F> + for<'a> SubAssign<&'a F> + for<'a> AddAssign<&'a F> + MulAssign + SubAssign + AddAssign + for<'a> Product<&'a F> + for<'a> Sum<&'a F> + for<'a> Mul<&'a F> + for<'a> Sub<&'a F> + for<'a> Add<&'a F> + Product + Sum + Mul + Sub + Add + Neg + ConstantTimeEq + ConditionallySelectable + Debug + Sync + Send + Default + Clone + Copy + Eq + PartialEq + Ord + PartialOrd + WithSmallOrderMulGroup<3> + 'static, S: Freeze,

§

impl<'a, const N: usize, const M: usize, F, H, S> RefUnwindSafe for SparseMerkleTree<'a, N, M, F, H, S>
where H: Clone + RefUnwindSafe, F: PrimeField<Output = F, Output = F, Output = F, Output = F, Output = F, Output = F, Output = F> + From<u64> + Field + for<'a> MulAssign<&'a F> + for<'a> SubAssign<&'a F> + for<'a> AddAssign<&'a F> + MulAssign + SubAssign + AddAssign + for<'a> Product<&'a F> + for<'a> Sum<&'a F> + for<'a> Mul<&'a F> + for<'a> Sub<&'a F> + for<'a> Add<&'a F> + Product + Sum + Mul + Sub + Add + Neg + ConstantTimeEq + ConditionallySelectable + Debug + Sync + Send + Default + Clone + Copy + Eq + PartialEq + Ord + PartialOrd + WithSmallOrderMulGroup<3> + 'static + RefUnwindSafe, S: RefUnwindSafe,

§

impl<'a, const N: usize, const M: usize, F, H, S> Send for SparseMerkleTree<'a, N, M, F, H, S>
where H: Clone + Send, F: PrimeField<Output = F, Output = F, Output = F, Output = F, Output = F, Output = F, Output = F> + From<u64> + Field + for<'a> MulAssign<&'a F> + for<'a> SubAssign<&'a F> + for<'a> AddAssign<&'a F> + MulAssign + SubAssign + AddAssign + for<'a> Product<&'a F> + for<'a> Sum<&'a F> + for<'a> Mul<&'a F> + for<'a> Sub<&'a F> + for<'a> Add<&'a F> + Product + Sum + Mul + Sub + Add + Neg + ConstantTimeEq + ConditionallySelectable + Debug + Sync + Send + Default + Clone + Copy + Eq + PartialEq + Ord + PartialOrd + WithSmallOrderMulGroup<3> + 'static, S: Send,

§

impl<'a, const N: usize, const M: usize, F, H, S> Sync for SparseMerkleTree<'a, N, M, F, H, S>
where H: Clone + Sync, F: PrimeField<Output = F, Output = F, Output = F, Output = F, Output = F, Output = F, Output = F> + From<u64> + Field + for<'a> MulAssign<&'a F> + for<'a> SubAssign<&'a F> + for<'a> AddAssign<&'a F> + MulAssign + SubAssign + AddAssign + for<'a> Product<&'a F> + for<'a> Sum<&'a F> + for<'a> Mul<&'a F> + for<'a> Sub<&'a F> + for<'a> Add<&'a F> + Product + Sum + Mul + Sub + Add + Neg + ConstantTimeEq + ConditionallySelectable + Debug + Sync + Send + Default + Clone + Copy + Eq + PartialEq + Ord + PartialOrd + WithSmallOrderMulGroup<3> + 'static, S: Sync,

§

impl<'a, const N: usize, const M: usize, F, H, S> Unpin for SparseMerkleTree<'a, N, M, F, H, S>
where H: Clone + Unpin, F: PrimeField<Output = F, Output = F, Output = F, Output = F, Output = F, Output = F, Output = F> + From<u64> + Field + for<'a> MulAssign<&'a F> + for<'a> SubAssign<&'a F> + for<'a> AddAssign<&'a F> + MulAssign + SubAssign + AddAssign + for<'a> Product<&'a F> + for<'a> Sum<&'a F> + for<'a> Mul<&'a F> + for<'a> Sub<&'a F> + for<'a> Add<&'a F> + Product + Sum + Mul + Sub + Add + Neg + ConstantTimeEq + ConditionallySelectable + Debug + Sync + Send + Default + Clone + Copy + Eq + PartialEq + Ord + PartialOrd + WithSmallOrderMulGroup<3> + 'static, S: Unpin,

§

impl<'a, const N: usize, const M: usize, F, H, S> UnwindSafe for SparseMerkleTree<'a, N, M, F, H, S>
where H: Clone + UnwindSafe, F: PrimeField<Output = F, Output = F, Output = F, Output = F, Output = F, Output = F, Output = F> + From<u64> + Field + for<'a> MulAssign<&'a F> + for<'a> SubAssign<&'a F> + for<'a> AddAssign<&'a F> + MulAssign + SubAssign + AddAssign + for<'a> Product<&'a F> + for<'a> Sum<&'a F> + for<'a> Mul<&'a F> + for<'a> Sub<&'a F> + for<'a> Add<&'a F> + Product + Sum + Mul + Sub + Add + Neg + ConstantTimeEq + ConditionallySelectable + Debug + Sync + Send + Default + Clone + Copy + Eq + PartialEq + Ord + PartialOrd + WithSmallOrderMulGroup<3> + 'static + RefUnwindSafe, S: UnwindSafe,

Blanket Implementations§

source§

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

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

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

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

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

source§

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

Mutably borrows from an owned value. Read more
§

impl<T> Conv for T

§

fn conv<T>(self) -> T
where Self: Into<T>,

Converts self into T using Into<T>. Read more
§

impl<T> FmtForward for T

§

fn fmt_binary(self) -> FmtBinary<Self>
where Self: Binary,

Causes self to use its Binary implementation when Debug-formatted.
§

fn fmt_display(self) -> FmtDisplay<Self>
where Self: Display,

Causes self to use its Display implementation when Debug-formatted.
§

fn fmt_lower_exp(self) -> FmtLowerExp<Self>
where Self: LowerExp,

Causes self to use its LowerExp implementation when Debug-formatted.
§

fn fmt_lower_hex(self) -> FmtLowerHex<Self>
where Self: LowerHex,

Causes self to use its LowerHex implementation when Debug-formatted.
§

fn fmt_octal(self) -> FmtOctal<Self>
where Self: Octal,

Causes self to use its Octal implementation when Debug-formatted.
§

fn fmt_pointer(self) -> FmtPointer<Self>
where Self: Pointer,

Causes self to use its Pointer implementation when Debug-formatted.
§

fn fmt_upper_exp(self) -> FmtUpperExp<Self>
where Self: UpperExp,

Causes self to use its UpperExp implementation when Debug-formatted.
§

fn fmt_upper_hex(self) -> FmtUpperHex<Self>
where Self: UpperHex,

Causes self to use its UpperHex implementation when Debug-formatted.
§

fn fmt_list(self) -> FmtList<Self>
where &'a Self: for<'a> IntoIterator,

Formats each item in a sequence. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

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

fn in_current_span(self) -> Instrumented<Self>

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

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

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.

source§

impl<T> IntoEither for T

source§

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 more
source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

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
§

impl<T> Pipe for T
where T: ?Sized,

§

fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> R
where Self: Sized,

Pipes by value. This is generally the method you want to use. Read more
§

fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> R
where R: 'a,

Borrows self and passes that borrow into the pipe function. Read more
§

fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> R
where R: 'a,

Mutably borrows self and passes that borrow into the pipe function. Read more
§

fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
where Self: Borrow<B>, B: 'a + ?Sized, R: 'a,

Borrows self, then passes self.borrow() into the pipe function. Read more
§

fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R ) -> R
where Self: BorrowMut<B>, B: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.borrow_mut() into the pipe function. Read more
§

fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
where Self: AsRef<U>, U: 'a + ?Sized, R: 'a,

Borrows self, then passes self.as_ref() into the pipe function.
§

fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
where Self: AsMut<U>, U: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.as_mut() into the pipe function.
§

fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
where Self: Deref<Target = T>, T: 'a + ?Sized, R: 'a,

Borrows self, then passes self.deref() into the pipe function.
§

fn pipe_deref_mut<'a, T, R>( &'a mut self, func: impl FnOnce(&'a mut T) -> R ) -> R
where Self: DerefMut<Target = T> + Deref, T: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.deref_mut() into the pipe function.
§

impl<T> Pointable for T

§

const ALIGN: usize = _

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 for T

§

type Output = T

Should always be Self
§

impl<T> Tap for T

§

fn tap(self, func: impl FnOnce(&Self)) -> Self

Immutable access to a value. Read more
§

fn tap_mut(self, func: impl FnOnce(&mut Self)) -> Self

Mutable access to a value. Read more
§

fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow<B>, B: ?Sized,

Immutable access to the Borrow<B> of a value. Read more
§

fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut<B>, B: ?Sized,

Mutable access to the BorrowMut<B> of a value. Read more
§

fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
where Self: AsRef<R>, R: ?Sized,

Immutable access to the AsRef<R> view of a value. Read more
§

fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
where Self: AsMut<R>, R: ?Sized,

Mutable access to the AsMut<R> view of a value. Read more
§

fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
where Self: Deref<Target = T>, T: ?Sized,

Immutable access to the Deref::Target of a value. Read more
§

fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

Mutable access to the Deref::Target of a value. Read more
§

fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self

Calls .tap() only in debug builds, and is erased in release builds.
§

fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self

Calls .tap_mut() only in debug builds, and is erased in release builds.
§

fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow<B>, B: ?Sized,

Calls .tap_borrow() only in debug builds, and is erased in release builds.
§

fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut<B>, B: ?Sized,

Calls .tap_borrow_mut() only in debug builds, and is erased in release builds.
§

fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
where Self: AsRef<R>, R: ?Sized,

Calls .tap_ref() only in debug builds, and is erased in release builds.
§

fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
where Self: AsMut<R>, R: ?Sized,

Calls .tap_ref_mut() only in debug builds, and is erased in release builds.
§

fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
where Self: Deref<Target = T>, T: ?Sized,

Calls .tap_deref() only in debug builds, and is erased in release builds.
§

fn tap_deref_mut_dbg<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

Calls .tap_deref_mut() only in debug builds, and is erased in release builds.
source§

impl<T> ToOwned for T
where 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
§

impl<T> TryConv for T

§

fn try_conv<T>(self) -> Result<T, Self::Error>
where Self: TryInto<T>,

Attempts to convert self into T using TryInto<T>. Read more
source§

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

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

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

Performs the conversion.
source§

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

§

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

The type returned in the event of a conversion error.
source§

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

Performs the conversion.
§

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

§

fn vzip(self) -> V

§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

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

fn with_current_subscriber(self) -> WithDispatch<Self>

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