Struct NoteRecipient

pub struct NoteRecipient { /* private fields */ }

Value that describes under which condition a note can be consumed.

The recipient is not an account address, instead it is a value that describes when a note can be consumed. Because not all notes have predetermined consumer addresses, e.g. swap notes can be consumed by anyone, the recipient is defined as the code and its inputs, that when successfully executed results in the note’s consumption.

Recipient is computed as:

hash(hash(hash(serial_num, [0; 4]), script_root), input_commitment)

Implementations

impl NoteRecipient

pub fn new(serial_num: Word, script: NoteScript, inputs: NoteInputs) -> Self

pub fn serial_num(&self) -> Word

The recipient’s serial_num, the secret required to consume the note.

pub fn script(&self) -> &NoteScript

The recipients’s script which locks the assets of this note.

pub fn inputs(&self) -> &NoteInputs

The recipient’s inputs which customizes the script’s behavior.

pub fn digest(&self) -> Digest

The recipient’s digest, which commits to its details.

This is the public data required to create a note.

pub fn format_for_advice(&self) -> Vec<Felt>

Returns the recipient formatted to be used with the advice map.

The format is inputs_length || INPUTS_COMMITMENT || SCRIPT_ROOT || SERIAL_NUMBER

Where:

• inputs_length is the length of the note inputs
• INPUTS_COMMITMENT is the commitment of the note inputs
• SCRIPT_ROOT is the commitment of the note script (i.e., the script’s MAST root)
• SERIAL_NUMBER is the recipient’s serial number

Trait Implementations

impl AsRef<NoteRecipient> for Note

fn as_ref(&self) -> &NoteRecipient

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<NoteRecipient> for NoteDetails

fn as_ref(&self) -> &NoteRecipient

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for NoteRecipient

fn clone(&self) -> NoteRecipient

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for NoteRecipient

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

Formats the value using the given formatter.

impl Deserializable for NoteRecipient

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

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

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 Eq for NoteRecipient

impl StructuralPartialEq for NoteRecipient