Skip to main content

MerkleTree

Struct MerkleTree 

Source
pub struct MerkleTree<F, Digest> { /* private fields */ }

Implementations§

Source§

impl<F, Digest> MerkleTree<F, Digest>

Source

pub fn backing_matrix(&self) -> &ColMajorMatrix<F>

The matrix that is used to form the leaves of the Merkle tree, which are in turn hashed into the bottom digest layer.

This is typically the codeword matrix in hash-based PCS.

Source

pub fn digest_layers(&self) -> &Vec<Vec<Digest>>

Source§

impl<F, Digest> MerkleTree<F, Digest>

Source

pub fn rows_per_query(&self) -> usize

Source§

impl<F, Digest> MerkleTree<F, Digest>

Source

pub fn query_stride(&self) -> usize

Source

pub fn proof_depth(&self) -> usize

Source§

impl<F, Digest: Clone> MerkleTree<F, Digest>

Source

pub fn root(&self) -> Result<Digest, StackedPcsError>

Source

pub fn query_merkle_proof( &self, query_idx: usize, ) -> Result<Vec<Digest>, StackedPcsError>

Source§

impl<EF: Field, Digest> MerkleTree<EF, Digest>
where Digest: Copy + Send + Sync,

Source

pub fn new<H: MerkleHasher<Digest = Digest>>( hasher: &H, matrix: ColMajorMatrix<EF>, rows_per_query: usize, ) -> Result<Self, StackedPcsError>
where EF: ExtensionField<H::F>,

Source

pub unsafe fn from_raw_parts( backing_matrix: ColMajorMatrix<EF>, digest_layers: Vec<Vec<Digest>>, rows_per_query: usize, ) -> Self

Construct a MerkleTree from pre-computed parts without validation.

§Safety

The caller must guarantee:

  • digest_layers form a valid Merkle tree over backing_matrix: the leaf layer contains correct hashes of the matrix rows and each subsequent layer contains correct compressions of consecutive pairs from the previous layer, terminating in a single root digest.
  • rows_per_query is a power of two and does not exceed the number of leaves (i.e., backing_matrix.height().next_power_of_two()).
  • The leaf layer length equals backing_matrix.height().next_power_of_two() / rows_per_query.

Violating these invariants will produce incorrect Merkle proofs or panics in downstream query/verification code.

Source

pub fn get_opened_rows( &self, index: usize, ) -> Result<Vec<Vec<EF>>, StackedPcsError>

Returns the ordered set of opened rows for the given query index. The rows are { query_idx + t * query_stride() } for t in 0..rows_per_query.

Trait Implementations§

Source§

impl<F: Clone, Digest: Clone> Clone for MerkleTree<F, Digest>

Source§

fn clone(&self) -> MerkleTree<F, Digest>

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<F: Debug, Digest: Debug> Debug for MerkleTree<F, Digest>

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'de, F, Digest> Deserialize<'de> for MerkleTree<F, Digest>
where F: Deserialize<'de>, Digest: Deserialize<'de>,

Source§

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<F, Digest> Serialize for MerkleTree<F, Digest>
where F: Serialize, Digest: Serialize,

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

§

impl<F, Digest> Freeze for MerkleTree<F, Digest>

§

impl<F, Digest> RefUnwindSafe for MerkleTree<F, Digest>
where F: RefUnwindSafe, Digest: RefUnwindSafe,

§

impl<F, Digest> Send for MerkleTree<F, Digest>
where F: Send, Digest: Send,

§

impl<F, Digest> Sync for MerkleTree<F, Digest>
where F: Sync, Digest: Sync,

§

impl<F, Digest> Unpin for MerkleTree<F, Digest>
where F: Unpin, Digest: Unpin,

§

impl<F, Digest> UnsafeUnpin for MerkleTree<F, Digest>

§

impl<F, Digest> UnwindSafe for MerkleTree<F, Digest>
where F: UnwindSafe, Digest: 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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

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

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

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<U> for T
where U: Into<T>,

Source§

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>,

Source§

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