Struct NoteInclusionProof 

pub struct NoteInclusionProof { /* private fields */ }

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

Implementations

impl NoteInclusionProof

pub fn new( block_num: BlockNumber, node_index_in_block: u16, note_path: SparseMerklePath, ) -> Result<NoteInclusionProof, NoteError>

Returns a new NoteInclusionProof.

pub fn location(&self) -> &NoteLocation

Returns the location of the note.

pub fn note_path(&self) -> &SparseMerklePath

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

pub fn authenticated_nodes( &self, note_commitment: Word, ) -> impl Iterator<Item = InnerNodeInfo>

Returns an iterator over inner nodes of this proof assuming that note_commitment is the value of the node to which this proof opens.

Trait Implementations

impl Clone for NoteInclusionProof

fn clone(&self) -> NoteInclusionProof

Returns a duplicate 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<(), Error>

Formats the value using the given formatter.

impl Deserializable for NoteInclusionProof

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

where R: ByteReader,

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

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 Serializable for NoteInclusionProof

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

where W: ByteWriter,

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 TryFrom<NoteInclusionInBlockProof> for NoteInclusionProof

type Error = RpcConversionError

The type returned in the event of a conversion error.

fn try_from( value: NoteInclusionInBlockProof, ) -> Result<NoteInclusionProof, <NoteInclusionProof as TryFrom<NoteInclusionInBlockProof>>::Error>

Performs the conversion.

impl Eq for NoteInclusionProof

impl StructuralPartialEq for NoteInclusionProof