Struct NoteScript 

pub struct NoteScript { /* private fields */ }

An executable program of a note.

A note’s script represents a program which must be executed for a note to be consumed. As such it defines the rules and side effects of consuming a given note.

Implementations

impl NoteScript

pub fn new(code: Program) -> Self

Returns a new NoteScript instantiated from the provided program.

pub fn from_bytes(bytes: &[u8]) -> Result<Self, NoteError>

Returns a new NoteScript deserialized from the provided bytes.

Errors

Returns an error if note script deserialization fails.

pub fn from_parts(mast: Arc<MastForest>, entrypoint: MastNodeId) -> Self

Returns a new NoteScript instantiated from the provided components.

Panics

Panics if the specified entrypoint is not in the provided MAST forest.

pub fn from_library(library: &Library) -> Result<Self, NoteError>

Returns a new NoteScript instantiated from the provided library.

The library must contain exactly one procedure with the @note_script attribute, which will be used as the entrypoint.

Errors

Returns an error if:

• The library does not contain a procedure with the @note_script attribute.
• The library contains multiple procedures with the @note_script attribute.

pub fn from_library_reference( library: &Library, path: &Path, ) -> Result<Self, NoteError>

Returns a new NoteScript containing only a reference to a procedure in the provided library.

This method is useful when a library contains multiple note scripts and you need to extract a specific one by its fully qualified path (e.g., miden::standards::notes::burn::main).

The procedure at the specified path must have the @note_script attribute.

Note: This method creates a minimal MastForest containing only an external node referencing the procedure’s digest, rather than copying the entire library. The actual procedure code will be resolved at runtime via the MastForestStore.

Errors

Returns an error if:

• The library does not contain a procedure at the specified path.
• The procedure at the specified path does not have the @note_script attribute.

pub fn root(&self) -> Word

Returns the commitment of this note script (i.e., the script’s MAST root).

pub fn mast(&self) -> Arc<MastForest>

Returns a reference to the MastForest backing this note script.

pub fn entrypoint(&self) -> MastNodeId

Returns an entrypoint node ID of the current script.

pub fn with_advice_map(self, advice_map: AdviceMap) -> Self

Returns a new NoteScript with the provided advice map entries merged into the underlying MastForest.

This allows adding advice map entries to an already-compiled note script, which is useful when the entries are determined after script compilation.

Trait Implementations

impl AsRef<NoteScript> for NoteScript

fn as_ref(&self) -> &NoteScript

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

impl Clone for NoteScript

fn clone(&self) -> NoteScript

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for NoteScript

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

Formats the value using the given formatter.

impl Deserializable for NoteScript

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 Display for NoteScript

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

Formats the value using the given formatter.

impl From<&NoteScript> for Vec<Felt>

fn from(script: &NoteScript) -> Self

Converts to this type from the input type.

impl From<NoteScript> for Vec<Felt>

fn from(value: NoteScript) -> Self

Converts to this type from the input type.

impl PartialEq for NoteScript

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

fn render(&self) -> Document

The core of the PrettyPrint functionality.

fn to_pretty_string(&self) -> String

Produce a String containing the results of pretty-printing this object.

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

Pretty-print this object to the given core::fmt::Formatter.

impl Serializable for NoteScript

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<&[BaseElement]> for NoteScript

type Error = DeserializationError

The type returned in the event of a conversion error.

fn try_from(elements: &[Felt]) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Vec<BaseElement>> for NoteScript

type Error = DeserializationError

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 NoteScript

impl StructuralPartialEq for NoteScript