Struct miden_client::store::OutputNoteRecord

pub struct OutputNoteRecord { /* private fields */ }

Represents a Note which was the result of executing some transaction of which the Store can keep track and retrieve.

An OutputNoteRecord contains all the information of a Note while it allows for not knowing the details (nullifier, script, inputs and serial number), in addition of (optionally) the NoteInclusionProof that identifies when the note was included in the chain.

It is also possible to convert Note into OutputNoteRecord (we fill the details and inclusion_proof fields if possible)

The consumer_account_id field is used to keep track of the account that consumed the note. It is only valid if the status is NoteStatus::Consumed. If the note is consumed but the field is None it means that the note was consumed by an untracked account.

Implementations

impl OutputNoteRecord

pub fn new( id: NoteId, recipient: Digest, assets: NoteAssets, status: NoteStatus, metadata: NoteMetadata, inclusion_proof: Option<NoteInclusionProof>, details: Option<NoteRecordDetails>, ) -> OutputNoteRecord

pub fn id(&self) -> NoteId

pub fn recipient(&self) -> Digest

pub fn assets(&self) -> &NoteAssets

pub fn status(&self) -> NoteStatus

pub fn metadata(&self) -> &NoteMetadata

pub fn inclusion_proof(&self) -> Option<&NoteInclusionProof>

pub fn details(&self) -> Option<&NoteRecordDetails>

Trait Implementations

impl Clone for OutputNoteRecord

fn clone(&self) -> OutputNoteRecord

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for OutputNoteRecord

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

Formats the value using the given formatter.

impl From<Note> for OutputNoteRecord

fn from(note: Note) -> Self

Converts to this type from the input type.

impl From<PartialNote> for OutputNoteRecord

fn from(partial_note: PartialNote) -> Self

Converts to this type from the input type.

impl PartialEq for OutputNoteRecord

fn eq(&self, other: &OutputNoteRecord) -> 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 TryFrom<InputNoteRecord> for OutputNoteRecord

type Error = ClientError

The type returned in the event of a conversion error.

fn try_from(input_note: InputNoteRecord) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<OutputNote> for OutputNoteRecord

OutputNote can always be turned into an OutputNoteRecord when they’re either OutputNote::Full or OutputNote::Partial and always fail the conversion if it’s OutputNote::Header. This also mean that output_note.try_from() can also be used as a way to filter the full and partial output notes

type Error = ClientError

The type returned in the event of a conversion error.

fn try_from(output_note: OutputNote) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<OutputNoteRecord> for InputNoteRecord

type Error = ClientError

The type returned in the event of a conversion error.

fn try_from(output_note: OutputNoteRecord) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<OutputNoteRecord> for Note

type Error = ClientError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<OutputNoteRecord> for NoteDetails

type Error = ClientError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl StructuralPartialEq for OutputNoteRecord