Struct InputNotes 

pub struct InputNotes<T> { /* private fields */ }

Input notes for a transaction, empty if the transaction does not consume notes.

This structure is generic over T, so it can be used to create the input notes for transaction execution, which require the note’s details to run the transaction kernel, and the input notes for proof verification, which require only the commitment data.

Implementations

impl<T: ToInputNoteCommitments> InputNotes<T>

pub fn new(notes: Vec<T>) -> Result<Self, TransactionInputError>

Returns new InputNotes instantiated from the provided vector of notes.

Errors

Returns an error if:

• The total number of notes is greater than MAX_INPUT_NOTES_PER_TX.
• The vector of notes contains duplicates.

pub fn new_unchecked(notes: Vec<T>) -> Self

Returns new InputNotes instantiated from the provided vector of notes without checking their validity.

This is exposed for use in transaction batches, but should generally not be used.

Warning

This does not run the checks from InputNotes::new, so the latter should be preferred.

pub fn commitment(&self) -> Word

Returns a sequential hash of nullifiers for all notes.

For non empty lists the commitment is defined as:

hash(nullifier_0 || noteid0_or_zero || nullifier_1 || noteid1_or_zero || .. || nullifier_n || noteidn_or_zero)

Otherwise defined as ZERO for empty lists.

pub fn num_notes(&self) -> u16

Returns total number of input notes.

pub fn is_empty(&self) -> bool

Returns true if this InputNotes does not contain any notes.

pub fn get_note(&self, idx: usize) -> &T

Returns a reference to the note located at the specified index.

pub fn iter(&self) -> impl Iterator<Item = &T>

Returns an iterator over notes in this InputNotes.

pub fn into_vec(self) -> Vec<T>

Converts self into a vector of input notes.

impl InputNotes<InputNote>

pub fn from_unauthenticated_notes( notes: Vec<Note>, ) -> Result<Self, TransactionInputError>

Returns new InputNotes instantiated from the provided vector of notes.

This constructor internally converts the provided notes into the InputNote::Unauthenticated, which are then used in the Self::new constructor.

Errors

Returns an error if:

• The total number of notes is greater than MAX_INPUT_NOTES_PER_TX.
• The vector of notes contains duplicates.

Trait Implementations

impl<T: Clone> Clone for InputNotes<T>

fn clone(&self) -> InputNotes<T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for InputNotes<T>

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

Formats the value using the given formatter.

impl<T: ToInputNoteCommitments> Default for InputNotes<T>

fn default() -> Self

Returns the “default value” for a type.

impl<T: Deserializable + ToInputNoteCommitments> Deserializable for InputNotes<T>

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<'a, T> IntoIterator for &'a InputNotes<T>

type Item = &'a T

The type of the elements being iterated over.

type IntoIter = Iter<'a, T>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Iter<'a, T>

Creates an iterator from a value.

impl<T> IntoIterator for InputNotes<T>

type Item = T

The type of the elements being iterated over.

type IntoIter = IntoIter<<InputNotes<T> as IntoIterator>::Item>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<T: PartialEq> PartialEq for InputNotes<T>

fn eq(&self, other: &Self) -> 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<T: Serializable> Serializable for InputNotes<T>

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<T: Eq> Eq for InputNotes<T>