Struct storage_proofs::merkle::MerkleProof

pub struct MerkleProof<H: Hasher> {
    pub root: H::Domain,
    // some fields omitted
}

Representation of a merkle proof. Each element in the path vector consists of a tuple (hash, is_right), with hash being the the hash of the node at the current level and is_right a boolean indicating if the path is taking the right path. The first element is the hash of leaf itself, and the last is the root hash.

Fields

root: H::Domain

Methods

impl<H: Hasher> MerkleProof<H>

pub fn new(n: usize) -> MerkleProof<H>

pub fn new_from_proof(p: &Proof<H::Domain>) -> MerkleProof<H>

pub fn as_options(&self) -> Vec<Option<(Fr, bool)>>

Convert the merkle path into the format expected by the circuits, which is a vector of options of the tuples. This does not include the root and the leaf.

pub fn as_pairs(&self) -> Vec<(Fr, bool)>

pub fn validate(&self, node: usize) -> bool

Validates the MerkleProof and that it corresponds to the supplied node.

pub fn validate_data(&self, data: &[u8]) -> bool

Validates that the data hashes to the leaf of the merkle path.

pub fn leaf(&self) -> &H::Domain

Returns the hash of leaf that this MerkleProof represents.

pub fn root(&self) -> &H::Domain

Returns the root hash

pub fn len(&self) -> usize

Returns the length of the proof. That is all path elements plus 1 for the leaf and 1 for the root.

pub fn serialize(&self) -> Vec<u8>

Serialize into bytes. TODO: probably improve

pub fn path(&self) -> &Vec<(H::Domain, bool)>

Trait Implementations

impl<H: Clone + Hasher> Clone for MerkleProof<H> where
    H::Domain: Clone,
    H::Domain: Clone,
    H::Domain: Clone, 

fn clone(&self) -> MerkleProof<H>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<H: Default + Hasher> Default for MerkleProof<H> where
    H::Domain: Default,
    H::Domain: Default,
    H::Domain: Default, 

fn default() -> MerkleProof<H>

Returns the "default value" for a type.

impl<H: Debug + Hasher> Debug for MerkleProof<H> where
    H::Domain: Debug,
    H::Domain: Debug,
    H::Domain: Debug, 

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

Formats the value using the given formatter.

impl<H: Hasher> Serialize for MerkleProof<H> where
    H::Domain: Serialize,
    H::Domain: Serialize, 

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

Serialize this value into the given Serde serializer.

impl<'de, H: Hasher> Deserialize<'de> for MerkleProof<H> where
    H::Domain: Deserialize<'de>,
    H::Domain: Deserialize<'de>, 

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

Deserialize this value from the given Serde deserializer.