Struct TransactionScript 

pub struct TransactionScript { /* private fields */ }

Transaction script.

A transaction script is a program that is executed in a transaction after all input notes have been executed.

The TransactionScript object is composed of an executable program defined by a MastForest and an associated entrypoint.

Implementations

impl TransactionScript

pub fn new(code: Program) -> Self

Returns a new TransactionScript instantiated with the provided code.

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

Returns a new TransactionScript instantiated from the provided MAST forest and entrypoint.

Panics

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

pub fn from_package(package: &Package) -> Result<Self, TransactionScriptError>

Creates a TransactionScript from a Package.

The package must be an executable (i.e., its target type must be TargetType::Executable).

Errors

Returns an error if the package cannot be converted to an executable program.

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

Returns a new TransactionScript instantiated from the provided library.

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

Errors

Returns an error if:

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

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

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

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

The procedure at the specified path must have the @transaction_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 @transaction_script attribute.

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

Returns a reference to the MastForest backing this transaction script.

pub fn loaded_mast_forest(&self) -> LoadedMastForest

Returns the MAST forest and package-owned debug information backing this transaction script.

pub fn root(&self) -> TransactionScriptRoot

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

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

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

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

Trait Implementations

impl Clone for TransactionScript

fn clone(&self) -> TransactionScript

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TransactionScript

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

Formats the value using the given formatter.

impl Deserializable for TransactionScript

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 min_serialized_size() -> usize

Returns the minimum serialized size for one instance of this type.

fn read_from_bytes(bytes: &[u8]) -> Result<Self, DeserializationError>

Attempts to deserialize the provided bytes into Self and returns the result.

fn read_from_bytes_with_budget( bytes: &[u8], budget: usize, ) -> Result<Self, DeserializationError>

Deserializes Self from bytes with a byte budget limit.

impl Eq for TransactionScript

impl PartialEq for TransactionScript

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

Equality operator ==.

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

Inequality operator !=.

impl Serializable for TransactionScript

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.