Struct PartialNote 

pub struct PartialNote { /* private fields */ }

A note without detailed recipient information.

A partial note consists of PartialNoteMetadata, NoteAssets, NoteAttachments, and a commitment to the NoteRecipient). However, it does not contain the full recipient, including note script, note storage, and note’s serial number. This means that a partial note is sufficient to compute note ID and note header, but not sufficient to compute note nullifier, and generally does not have enough info to execute the note.

One use case for the PartialNote is to return the details of a private note created during a transaction, where the assets and attachments are known, but the recipient is not.

Implementations

impl PartialNote

pub fn new( partial_metadata: PartialNoteMetadata, recipient_digest: Word, assets: NoteAssets, attachments: NoteAttachments, ) -> Self

Returns a new PartialNote instantiated from the provided parameters.

pub fn id(&self) -> NoteId

Returns the ID corresponding to this note.

pub fn details_commitment(&self) -> NoteDetailsCommitment

Returns the commitment to the note’s details, excluding metadata.

pub fn metadata(&self) -> &NoteMetadata

Returns a reference to the NoteMetadata of this note.

pub fn partial_metadata(&self) -> &PartialNoteMetadata

Returns the partial metadata associated with this note.

pub fn recipient_digest(&self) -> Word

Returns the digest of the recipient associated with this note.

See super::NoteRecipient for more info.

pub fn assets(&self) -> &NoteAssets

Returns a list of assets associated with this note.

pub fn attachments(&self) -> &NoteAttachments

Returns the note’s attachments.

pub fn header(&self) -> &NoteHeader

Returns the NoteHeader of this note.

pub fn into_parts(self) -> (NoteAssets, NoteHeader, NoteAttachments)

Consumes self and returns the non-Copy parts of this note.

Trait Implementations

impl Clone for PartialNote

fn clone(&self) -> PartialNote

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PartialNote

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

Formats the value using the given formatter.

impl Deserializable for PartialNote

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 From<Note> for PartialNote

fn from(note: Note) -> Self

Converts to this type from the input type.

impl PartialEq for PartialNote

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

fn write_into<W: ByteWriter>(&self, target: &mut W)

Serializes self into bytes and writes these bytes into the target.

fn get_size_hint(&self) -> usize

Returns an estimate of how many bytes are needed to represent self.

fn to_bytes(&self) -> Vec<u8>

Serializes self into a vector of bytes.

impl Eq for PartialNote

impl StructuralPartialEq for PartialNote