Struct 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 NoteDetails, in addition of specific information about the note state.

Once a proof is received, the InputNoteRecord can be transformed into an InputNote and used as input for transactions. It is also possible to convert Note and InputNote into InputNoteRecord (we fill the metadata and inclusion_proof fields if possible).

Notes can also be consumed as unauthenticated notes, where their existence is verified by the network.

Implementations

impl InputNoteRecord

pub fn new( details: NoteDetails, created_at: Option<u64>, state: InputNoteState, ) -> InputNoteRecord

pub fn id(&self) -> NoteId

pub fn recipient(&self) -> Digest

pub fn assets(&self) -> &NoteAssets

pub fn created_at(&self) -> Option<u64>

pub fn state(&self) -> &InputNoteState

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

pub fn nullifier(&self) -> Nullifier

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

pub fn details(&self) -> &NoteDetails

pub fn consumer_transaction_id(&self) -> Option<&TransactionId>

pub fn is_authenticated(&self) -> bool

Returns true if the note is authenticated, meaning that it has the necessary inclusion proof and block header information to be considered valid.

pub fn is_consumed(&self) -> bool

Returns true if the note has been nullified on chain.

pub fn is_processing(&self) -> bool

Returns true if the note is currently being processed by a local transaction.

pub fn is_committed(&self) -> bool

Returns true if the note is in a committed state (i.e. it has a valid inclusion proof but isn’t consumed or being processed).

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

fn from(value: InputNote) -> Self

Converts to this type from the input type.

impl From<InputNoteRecord> for NoteDetails

fn from(value: InputNoteRecord) -> Self

Converts to this type from the input type.

impl From<Note> for InputNoteRecord

fn from(value: 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 TryInto<InputNote> for InputNoteRecord

type Error = NoteRecordError

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

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryInto<Note> for InputNoteRecord

type Error = NoteRecordError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryInto<NoteTagRecord> for &InputNoteRecord

type Error = NoteRecordError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl StructuralPartialEq for InputNoteRecord