Struct miden_objects::notes::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: ProgramAst, assembler: &Assembler ) -> Result<(Self, CodeBlock), NoteError>

Returns a new NoteScript instantiated from the provided program and compiled with the provided assembler. The compiled code block is also returned.

Errors

Returns an error if the compilation of the provided program fails.

pub fn from_parts(code: ProgramAst, hash: Digest) -> Self

Returns a new NoteScript instantiated from the provided components.

Note: this function assumes that the specified hash results from the compilation of the provided program, but this is not checked.

pub fn hash(&self) -> Digest

Returns MAST root of this note script.

pub fn code(&self) -> &ProgramAst

Returns the AST of this note script.

Trait Implementations

impl Clone for NoteScript

fn clone(&self) -> NoteScript

Returns a copy 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 PartialEq for NoteScript

fn eq(&self, other: &NoteScript) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

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

impl StructuralPartialEq for NoteScript