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: Word, assets: NoteAssets, metadata: NoteMetadata, state: OutputNoteState, expected_height: BlockNumber, attachments: NoteAttachments, ) -> OutputNoteRecord

pub fn id(&self) -> NoteId

pub fn details_commitment(&self) -> NoteDetailsCommitment

Returns the commitment to the note’s details (recipient + assets), independent of note metadata.

pub fn recipient_digest(&self) -> Word

pub fn assets(&self) -> &NoteAssets

pub fn state(&self) -> &OutputNoteState

pub fn metadata(&self) -> &NoteMetadata

pub fn attachments(&self) -> &NoteAttachments

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: RawOutputNote, expected_height: BlockNumber, ) -> Result<Self, NoteRecordError>

RawOutputNote can always be turned into an OutputNoteRecord when they’re either RawOutputNote::Full or RawOutputNote::Partial.

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 duplicate 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 Deserializable for OutputNoteRecord

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 min_serialized_size() -> usize

Returns the minimum serialized size for one instance of this type.

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

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

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

Deserializes Self from bytes with a byte budget limit.

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

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

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 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.