Struct miden_client::store::InputNoteRecord

pub struct InputNoteRecord { /* private fields */ }

Represents a Note of which the Store can keep track and retrieve.

An InputNoteRecord contains all the information of a Note, in addition of (optionally) the NoteInclusionProof that identifies when the note was included in the chain.

Once the proof is set, the InputNoteRecord can be transformed into an InputNote and used as input for transactions.

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.

It is also possible to convert Note and InputNote into InputNoteRecord (we fill the metadata and inclusion_proof fields if possible)

Implementations

impl InputNoteRecord

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

pub fn id(&self) -> NoteId

pub fn recipient(&self) -> Digest

pub fn assets(&self) -> &NoteAssets

pub fn status(&self) -> NoteStatus

pub fn metadata(&self) -> Option<&NoteMetadata>

pub fn nullifier(&self) -> &str

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

pub fn details(&self) -> &NoteRecordDetails

pub fn set_inclusion_proof( &mut self, inclusion_proof: Option<NoteInclusionProof>, )

pub fn ignored(&self) -> bool

pub fn imported_tag(&self) -> Option<NoteTag>

pub fn is_authenticated(&self) -> bool

Returns whether the note record contains a valid inclusion proof correlated with its status

Trait Implementations

impl Clone for InputNoteRecord

fn clone(&self) -> InputNoteRecord

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for InputNoteRecord

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

Formats the value using the given formatter.

impl Deserializable for InputNoteRecord

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 From<&NoteDetails> for InputNoteRecord

fn from(note_details: &NoteDetails) -> Self

Converts to this type from the input type.

impl From<InputNote> for InputNoteRecord

fn from(recorded_note: InputNote) -> Self

Converts to this type from the input type.

impl From<InputNoteRecord> for NoteDetails

fn from(val: InputNoteRecord) -> Self

Converts to this type from the input type.

impl From<Note> for InputNoteRecord

fn from(note: Note) -> Self

Converts to this type from the input type.

impl PartialEq for InputNoteRecord

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

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 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<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 TryInto<InputNote> for InputNoteRecord

type Error = ClientError

The type returned in the event of a conversion error.

fn try_into(self) -> Result<InputNote, Self::Error>

Performs the conversion.

impl TryInto<Note> for InputNoteRecord

type Error = ClientError

The type returned in the event of a conversion error.

fn try_into(self) -> Result<Note, Self::Error>

Performs the conversion.

impl StructuralPartialEq for InputNoteRecord