Struct 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 recipient details (nullifier, script, inputs and serial number).

It is also possible to convert Note into OutputNoteRecord with the state OutputNoteState::ExpectedFull.

Implementations

impl OutputNoteRecord

pub fn new( recipient_digest: Digest, assets: NoteAssets, metadata: NoteMetadata, state: OutputNoteState, expected_height: BlockNumber, ) -> OutputNoteRecord

pub fn id(&self) -> NoteId

pub fn recipient_digest(&self) -> Digest

pub fn assets(&self) -> &NoteAssets

pub fn state(&self) -> &OutputNoteState

pub fn metadata(&self) -> &NoteMetadata

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

pub fn recipient(&self) -> Option<&NoteRecipient>

pub fn nullifier(&self) -> Option<Nullifier>

pub fn expected_height(&self) -> BlockNumber

pub fn is_consumed(&self) -> bool

Returns true if the note has been nullified on chain.

pub fn is_committed(&self) -> bool

Returns true if the note is in a committed state (i.e. it has a inclusion proof but isn’t consumed) regardless of whether it is full or partial.

impl OutputNoteRecord

pub fn from_full_note(note: Note, expected_height: BlockNumber) -> Self

pub fn from_partial_note( partial_note: PartialNote, expected_height: BlockNumber, ) -> Self

pub fn try_from_output_note( output_note: OutputNote, expected_height: BlockNumber, ) -> Result<Self, NoteRecordError>

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.

impl OutputNoteRecord

pub fn into_note_file( self, export_type: NoteExportType, ) -> Result<NoteFile, NoteRecordError>

Converts the output note record into a note file for exporting. The export type is used to determine the variant of NoteFile to be created.

Errors

Will return an error if there isn’t enough information to create the requested NoteFile variant.

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 PartialEq for OutputNoteRecord

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

type Error = NoteRecordError

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 = NoteRecordError

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