Struct MerkleProof

pub struct MerkleProof {
    pub index: usize,
    pub total: usize,
    pub leaf_hash: Hash,
    pub aunts: Vec<Hash>,
}

A proof of inclusion of some leaf in a merkle tree.

Fields

index: usize

Leaf index.

total: usize

Total number of leaves in the Merkle tree.

leaf_hash: Hash

Hash of the leaf.

aunts: Vec<Hash>

Hashes of the sibling nodes at each level of the tree.

Implementations

impl MerkleProof

pub fn new( leaf_to_prove: usize, leaves: &[impl AsRef<[u8]>], ) -> Result<(Self, Hash)>

Create a merkle proof of inclusion of a given leaf in a list.

Returns a proof together with the root hash of a merkle tree built from given leaves.

Errors

This function will return an error if leaf_to_prove index is out of leaves bounds.

Example

use celestia_types::MerkleProof;

let (proof, root) = MerkleProof::new(0, &[b"a", b"b", b"c"]).unwrap();

assert!(proof.verify(b"a", root).is_ok());

pub fn verify(&self, leaf: impl AsRef<[u8]>, root: Hash) -> Result<()>

Verify that given leaf is included under the root hash.

Errors

This function will return an error if:

• provided leaf is different than the one for which proof was created
• proof is malformed, meaning some inconsistency between leaf index, leaves count, or amount of inner nodes
• the recomputed root hash differs from expected one

Trait Implementations

impl Clone for MerkleProof

fn clone(&self) -> MerkleProof

Returns a duplicate 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<'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 From<MerkleProof> for Proof

fn from(value: MerkleProof) -> Self

Converts to this type from the input type.

impl PartialEq for MerkleProof

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Protobuf<Proof> for MerkleProof

fn encode<B>(self, buf: &mut B) -> Result<(), Error>

where B: BufMut,

Encode into a buffer in Protobuf format.

fn encode_length_delimited<B>(self, buf: &mut B) -> Result<(), Error>

where B: BufMut,

Encode with a length-delimiter to a buffer in Protobuf format.

fn decode<B>(buf: B) -> Result<Self, Error>

where B: Buf,

Constructor that attempts to decode an instance from a buffer.

fn decode_length_delimited<B>(buf: B) -> Result<Self, Error>

where B: Buf,

Constructor that attempts to decode a length-delimited instance from the buffer.

fn encoded_len(self) -> usize

Returns the encoded length of the message without a length delimiter.

fn encode_vec(self) -> Vec<u8>

Encodes into a Protobuf-encoded Vec<u8>.

fn decode_vec(v: &[u8]) -> Result<Self, Error>

Constructor that attempts to decode a Protobuf-encoded instance from a Vec<u8> (or equivalent).

fn encode_length_delimited_vec(self) -> Vec<u8>

Encode with a length-delimiter to a Vec<u8> Protobuf-encoded message.

fn decode_length_delimited_vec(v: &[u8]) -> Result<Self, Error>

Constructor that attempts to decode a Protobuf-encoded instance with a length-delimiter from a Vec<u8> or equivalent.

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 TryFrom<Proof> for MerkleProof

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: RawMerkleProof) -> Result<Self, Self::Error>

Performs the conversion.

impl StructuralPartialEq for MerkleProof