Struct NoteInputs

pub struct NoteInputs { /* private fields */ }

A container for note inputs.

A note can be associated with up to 128 input values. Each value is represented by a single field element. Thus, note input values can contain up to ~1 KB of data.

All inputs associated with a note can be reduced to a single commitment which is computed by first padding the inputs with ZEROs to the next multiple of 8, and then by computing a sequential hash of the resulting elements.

Implementations

impl NoteInputs

pub fn new(values: Vec<Felt>) -> Result<Self, NoteError>

Returns NoteInputs instantiated from the provided values.

Errors

Returns an error if the number of provided inputs is greater than 128.

pub fn commitment(&self) -> Digest

Returns a commitment to these inputs.

pub fn num_values(&self) -> u8

Returns the number of input values.

The returned value is guaranteed to be smaller than or equal to 128.

pub fn values(&self) -> &[Felt]

Returns a reference to the input values.

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

Returns the note’s input formatted to be used with the advice map.

The format is INPUTS || PADDING, where:

Where:

• INPUTS is the variable inputs for the note
• PADDING is the optional padding to align the data with a 2WORD boundary

Trait Implementations

impl Clone for NoteInputs

fn clone(&self) -> NoteInputs

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for NoteInputs

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

Formats the value using the given formatter.

impl Default for NoteInputs

fn default() -> Self

Returns the “default value” for a type.

impl Deserializable for NoteInputs

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<NoteInputs> for Vec<Felt>

fn from(value: NoteInputs) -> Self

Converts to this type from the input type.

impl PartialEq for NoteInputs

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 Serializable for NoteInputs

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<Vec<BaseElement>> for NoteInputs

type Error = NoteError

The type returned in the event of a conversion error.

fn try_from(value: Vec<Felt>) -> Result<Self, Self::Error>

Performs the conversion.

impl Eq for NoteInputs