Struct geen::MerkleProof

pub struct MerkleProof { /* fields omitted */ }

A Merkle proof that proves a particular element at a particular position exists in an MMR.

Methods

impl MerkleProof

pub fn for_leaf_node<B>(
    mmr: &MerkleMountainRange<B>,
    leaf_pos: usize
) -> Result<MerkleProof, GeneError> where
    B: Storage<Value = H256>, 

Build a Merkle Proof the given MMR at the given leaf position. This is usually the version you'll want to call, since you'll know the leaf index more often than the MMR index.

For the difference between leaf node and MMR node indices, see the [mod level] documentation.

See MerkleProof::for_node for more details on how the proof is constructed.

pub fn for_node<B>(
    mmr: &MerkleMountainRange<B>,
    pos: usize
) -> Result<MerkleProof, GeneError> where
    B: Storage<Value = H256>, 

Build a Merkle proof for the candidate node at the given MMR index. If you want to build a proof using the leaf position, call MerkleProof::for_leaf_node instead. The given node position must be a leaf node, otherwise a MerkleProofError::NonLeafNode error will be returned.

The proof for the MMR consists of two parts: a) A list of sibling node hashes starting from the candidate node and walking up the tree to the local root (i.e. the root of the binary tree that the candidate node lives in. b) A list of MMR peaks, excluding the local node hash. The final Merkle proof is constructed by hashing all the peaks together (this is slightly different to how other MMR implementations work).

pub fn verify_leaf(
    &self,
    root: &H256,
    hash: &H256,
    leaf_pos: usize
) -> Result<(), GeneError>

pub fn verify(
    &self,
    root: &H256,
    hash: &H256,
    pos: usize
) -> Result<(), GeneError>

Verifies the Merkle proof against the provided root hash, element and position in the MMR.

Trait Implementations

impl Clone for MerkleProof

fn clone(&self) -> MerkleProof

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Default for MerkleProof

fn default() -> MerkleProof

Returns the "default value" for a type.

impl Eq for MerkleProof

impl Ord for MerkleProof

fn cmp(&self, other: &MerkleProof) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl PartialEq<MerkleProof> for MerkleProof

fn eq(&self, other: &MerkleProof) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &MerkleProof) -> bool

This method tests for !=.

impl PartialOrd<MerkleProof> for MerkleProof

fn partial_cmp(&self, other: &MerkleProof) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &MerkleProof) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &MerkleProof) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &MerkleProof) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &MerkleProof) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Display for MerkleProof

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

Formats the value using the given formatter.

impl Debug for MerkleProof

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

Formats the value using the given formatter.

impl StructuralPartialEq for MerkleProof

impl StructuralEq for MerkleProof

impl Writeable for MerkleProof

fn write<W: Writer>(&self, writer: &mut W) -> Result<(), Error>

Write the data held by this Writeable to the provided writer

impl Readable for MerkleProof

fn read(reader: &mut dyn Reader) -> Result<MerkleProof, Error>

Reads the data necessary to this Readable from the provided reader

impl<'de> Deserialize<'de> for MerkleProof

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl Serialize for MerkleProof

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

Serialize this value into the given Serde serializer.