Struct miden_objects::notes::NoteInclusionProof

pub struct NoteInclusionProof { /* private fields */ }

Contains the data required to prove inclusion of a note in the canonical chain.

block_num - the block number the note was created in. sub_hash - the sub hash of the block the note was created in. note_root - the note root of the block the note was created in. note_index - the index of the note in the note Merkle tree of the block the note was created in. note_path - the Merkle path to the note in the note Merkle tree of the block the note was created in.

Implementations

impl NoteInclusionProof

pub fn new( block_num: u32, sub_hash: Digest, note_root: Digest, index: u64, note_path: MerklePath ) -> Result<Self, NoteError>

Creates a new note origin.

pub fn sub_hash(&self) -> Digest

Returns the sub hash of the block header the note was created in.

pub fn note_root(&self) -> Digest

Returns the note root of the block header the note was created in.

pub fn origin(&self) -> &NoteOrigin

Returns the origin of the note.

pub fn note_path(&self) -> &MerklePath

Returns the Merkle path to the note in the note Merkle tree of the block the note was created in.

Trait Implementations

impl Clone for NoteInclusionProof

fn clone(&self) -> NoteInclusionProof

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for NoteInclusionProof

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

Formats the value using the given formatter.

impl Deserializable for NoteInclusionProof

fn read_from<R: ByteReader>( source: &mut R ) -> Result<Self, DeserializationError>

Reads a sequence of bytes from the provided source, attempts to deserialize these bytes into Self, and returns the result.

fn read_from_bytes(bytes: &[u8]) -> Result<Self, DeserializationError>

Attempts to deserialize the provided bytes into Self and returns the result.

impl PartialEq for NoteInclusionProof

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

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

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

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

impl Serializable for NoteInclusionProof

fn write_into<W: ByteWriter>(&self, target: &mut W)

Serializes self into bytes and writes these bytes into the target.

fn to_bytes(&self) -> Vec<u8>

Serializes self into a vector of bytes.

fn get_size_hint(&self) -> usize

Returns an estimate of how many bytes are needed to represent self.

impl Eq for NoteInclusionProof

impl StructuralPartialEq for NoteInclusionProof