Struct grin_core::core::merkle_proof::MerkleProof

pub struct MerkleProof {
    pub mmr_size: u64,
    pub path: Vec<Hash>,
}

A Merkle proof that proves a particular element exists in the MMR.

Fields

mmr_size: u64

The size of the MMR at the time the proof was created.

path: Vec<Hash>

The sibling path from the leaf up to the final sibling hashing to the root.

Methods

impl MerkleProof

pub fn empty() -> MerkleProof

The "empty" Merkle proof.

pub fn to_hex(&self) -> String

Serialize the Merkle proof as a hex string (for api json endpoints)

pub fn from_hex(hex: &str) -> Result<MerkleProof, String>

Convert hex string representation back to a Merkle proof instance

pub fn verify(
    &self,
    root: Hash,
    element: &dyn PMMRIndexHashable,
    node_pos: u64
) -> Result<(), MerkleProofError>

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

Trait Implementations

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 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 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 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 Eq for MerkleProof

impl Default for MerkleProof

fn default() -> MerkleProof

Returns the "default value" for a type.

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 Debug for MerkleProof

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

Formats the value using the given formatter.

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.

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.