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 mast(&self) -> Arc<MastForest>

Returns a reference to the MastForest backing this transaction script.

pub fn root(&self) -> Word

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 read_from_bytes(bytes: &[u8]) -> Result<Self, DeserializationError>

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

impl PartialEq for TransactionScript

fn eq(&self, other: &TransactionScript) -> 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 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.

impl Eq for TransactionScript

impl StructuralPartialEq for TransactionScript