Struct grin_core::core::pmmr::ReadonlyPMMR

pub struct ReadonlyPMMR<'a, T, B>
where
    T: PMMRable,
    B: Backend<T>,
{ /* private fields */ }

Readonly view of a PMMR.

Implementations

impl<'a, T, B> ReadonlyPMMR<'a, T, B>

where T: PMMRable, B: 'a + Backend<T>,

pub fn new(backend: &'a B) -> ReadonlyPMMR<'_, T, B>

Build a new readonly PMMR.

pub fn at(backend: &'a B, size: u64) -> ReadonlyPMMR<'_, T, B>

Build a new readonly PMMR pre-initialized to size with the provided backend.

pub fn elements_from_pmmr_index( &self, pmmr_index1: u64, max_count: u64, max_pmmr_pos1: Option<u64> ) -> (u64, Vec<T::E>)

Helper function which returns un-pruned nodes from the insertion index forward returns last pmmr index returned along with data

pub fn get_last_n_insertions(&self, n: u64) -> Vec<(Hash, T::E)>

Helper function to get the last N nodes inserted, i.e. the last n nodes along the bottom of the tree. May return less than n items if the MMR has been pruned/compacted. NOTE This should just iterate over insertion indices to avoid the repeated calls to bintree_rightmost!

Trait Implementations

impl<'a, T, B> ReadablePMMR for ReadonlyPMMR<'a, T, B>

where T: PMMRable, B: 'a + Backend<T>,

type Item = <T as PMMRable>::E

Leaf type

fn get_hash(&self, pos0: u64) -> Option<Hash>

Get the hash at provided position in the MMR. NOTE all positions are 0-based, so a size n MMR has nodes in positions 0 through n-1 just like a Rust Range 0..n

fn get_data(&self, pos0: u64) -> Option<Self::Item>

Get the data element at provided position in the MMR.

fn get_from_file(&self, pos0: u64) -> Option<Hash>

Get the hash from the underlying MMR file (ignores the remove log).

fn get_peak_from_file(&self, pos0: u64) -> Option<Hash>

Get the hash for the provided peak pos. Optimized for reading peak hashes rather than arbitrary pos hashes. Peaks can be assumed to not be compacted.

fn get_data_from_file(&self, pos0: u64) -> Option<Self::Item>

Get the data element at provided position in the MMR (ignores the remove log).

fn unpruned_size(&self) -> u64

Total size of the tree, including intermediary nodes and ignoring any pruning.

fn leaf_pos_iter(&self) -> Box<dyn Iterator<Item = u64> + '_>

Iterator over current (unpruned, unremoved) leaf positions.

fn leaf_idx_iter(&self, from_idx: u64) -> Box<dyn Iterator<Item = u64> + '_>

Iterator over current (unpruned, unremoved) leaf insertion indices.

fn n_unpruned_leaves(&self) -> u64

Number of leaves in the MMR

fn n_unpruned_leaves_to_index(&self, to_index: u64) -> u64

Number of leaves in the MMR up to index

fn is_empty(&self) -> bool

Is the MMR empty?

fn bag_the_rhs(&self, peak_pos0: u64) -> Option<Hash>

Takes a single peak position and hashes together all the peaks to the right of this peak (if any). If this return a hash then this is our peaks sibling. If none then the sibling of our peak is the peak to the left.

fn peaks(&self) -> Vec<Hash>

Returns a vec of the peaks of this MMR.

fn peak_path(&self, peak_pos0: u64) -> Vec<Hash>

Hashes of the peaks excluding peak_pos, where the rhs is bagged together

fn root(&self) -> Result<Hash, String>

Computes the root of the MMR. Find all the peaks in the current tree and “bags” them to get a single peak.

fn merkle_proof(&self, pos0: u64) -> Result<MerkleProof, String>

Build a Merkle proof for the element at the given position.