Struct Program 

pub struct Program<T> {
    pub version: (usize, usize, usize),
    pub term: Term<T>,
}

This represents a program in Untyped Plutus Core. A program contains a version tuple and a term. It is generic because Term requires a generic type.

Fields

version: (usize, usize, usize)

term: Term<T>

Implementations

impl<T> Program<T>

where T: Clone,

pub fn apply(&self, program: &Self) -> Self

We use this to apply the validator to Datum, then redeemer, then ScriptContext. If datum is even necessary (i.e. minting policy).

pub fn apply_data(&self, plutus_data: PlutusData) -> Self

A convenient and faster version that apply_term since the program doesn’t need to be re-interned (constant Data do not introduce new bindings).

impl Program<Name>

pub fn apply_term(&self, term: &Term<Name>) -> Self

We use this to apply the validator to Datum, then redeemer, then ScriptContext. If datum is even necessary (i.e. minting policy).

pub fn to_debruijn(self) -> Result<Program<DeBruijn>, Error>

A convenient method to convery named programs to debruijn programs.

pub fn to_named_debruijn(self) -> Result<Program<NamedDeBruijn>, Error>

A convenient method to convery named programs to named debruijn programs.

impl Program<DeBruijn>

pub fn address( &self, network: Network, delegation: ShelleyDelegationPart, plutus_version: &Language, ) -> ShelleyAddress

impl Program<NamedDeBruijn>

pub fn eval(self, initial_budget: ExBudget) -> EvalResult

pub fn eval_version( self, initial_budget: ExBudget, version: &Language, ) -> EvalResult

Evaluate a Program as a specific PlutusVersion

pub fn eval_as( self, version: &Language, costs: &[i64], initial_budget: Option<&ExBudget>, ) -> EvalResult

impl Program<DeBruijn>

pub fn eval(&self, initial_budget: ExBudget) -> EvalResult

pub fn eval_version( self, initial_budget: ExBudget, version: &Language, ) -> EvalResult

impl<'b, T> Program<T>

where T: Binder<'b> + Debug,

pub fn from_cbor( bytes: &'b [u8], buffer: &'b mut Vec<u8>, ) -> Result<Self, Error>

pub fn from_flat(bytes: &'b [u8]) -> Result<Self, Error>

pub fn from_hex( hex_str: &str, cbor_buffer: &'b mut Vec<u8>, flat_buffer: &'b mut Vec<u8>, ) -> Result<Self, Error>

pub fn to_cbor(&self) -> Result<Vec<u8>, Error>

Convert a program to cbor bytes.

note: The cbor bytes of a program are merely the flat bytes of the program encoded as cbor bytes.

Examples

use uplc::ast::{Program, Name, Term};

let term = Term::var("x").lambda("x");
let program = Program { version: (1, 0, 0), term };

assert_eq!(
    program.to_debruijn().unwrap().to_cbor().unwrap(),
    vec![
        0x46, 0x01, 0x00, 0x00,
        0x20, 0x01, 0x01
    ],
);

pub fn to_flat(&self) -> Result<Vec<u8>, Error>

Convert a program to a flat bytes.

note: Convenient so that people don’t need to depend on the flat crate directly to call programs flat function.

Examples

use uplc::ast::{Program, Name, Term};

let term = Term::var("x").lambda("x");
let program = Program { version: (1, 0, 0), term };

assert_eq!(
    program
        .to_debruijn()
        .unwrap()
        .to_flat()
        .unwrap(),
    vec![
        0x01, 0x00, 0x00,
        0x20, 0x01, 0x01
    ],
);

pub fn to_hex(&self) -> Result<String, Error>

Convert a program to hex encoded cbor bytes

Examples

use uplc::ast::{Program, Name, Term};

let term = Term::var("x").lambda("x");
let program = Program { version: (1, 0, 0), term };

assert_eq!(
    program.to_debruijn().unwrap().to_hex().unwrap(),
    "46010000200101".to_string(),
);

impl Program<Name>

pub fn run_once_pass(self) -> Self

pub fn multi_pass(self) -> (Self, Context)

pub fn run_one_opt( self, inline_lambda: bool, with: &mut impl FnMut(Option<usize>, &mut Term<Name>, Vec<Args>, &Scope, &mut Context), ) -> Self

pub fn clean_up_no_inlines(self) -> Self

pub fn afterwards(self) -> Self

pub fn builtin_curry_reducer(self) -> Self

pub fn split_body_lambda_reducer(self) -> Self

Trait Implementations

impl<T: Clone> Clone for Program<T>

fn clone(&self) -> Program<T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for Program<T>

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

Formats the value using the given formatter.

impl<'b, T> Decode<'b> for Program<T>

where T: Binder<'b>,

fn decode(d: &mut Decoder<'_>) -> Result<Self, Error>

impl<'a, T> Display for Program<T>

where T: Binder<'a>,

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

Formats the value using the given formatter.

impl<'b, T> Encode for Program<T>

where T: Binder<'b> + Debug,

fn encode(&self, e: &mut Encoder) -> Result<(), Error>

impl<'b, T> Flat<'b> for Program<T>

where T: Binder<'b> + Debug,

fn flat(&self) -> Result<Vec<u8>, Error>

fn unflat(bytes: &'b [u8]) -> Result<Self, Error>

impl From<Program<DeBruijn>> for Program<NamedDeBruijn>

fn from(value: Program<DeBruijn>) -> Self

Converts to this type from the input type.

impl From<Program<FakeNamedDeBruijn>> for Program<NamedDeBruijn>

fn from(value: Program<FakeNamedDeBruijn>) -> Self

Converts to this type from the input type.

impl From<Program<NamedDeBruijn>> for Program<DeBruijn>

fn from(value: Program<NamedDeBruijn>) -> Self

Converts to this type from the input type.

impl From<Program<NamedDeBruijn>> for Program<FakeNamedDeBruijn>

fn from(value: Program<NamedDeBruijn>) -> Self

Converts to this type from the input type.

impl<T: PartialEq> PartialEq for Program<T>

fn eq(&self, other: &Program<T>) -> 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 TryFrom<&Program<DeBruijn>> for Program<Name>

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: &Program<DeBruijn>) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Program<DeBruijn>> for Program<Name>

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: Program<DeBruijn>) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Program<Name>> for Program<DeBruijn>

Convert a Parsed Program to a Program in Debruijn form. This checks for any Free Uniques in the Program and returns an error if found.

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: Program<Name>) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Program<Name>> for Program<NamedDeBruijn>

Convert a Parsed Program to a Program in NamedDebruijn form. This checks for any Free Uniques in the Program and returns an error if found.

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: Program<Name>) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Program<NamedDeBruijn>> for Program<Name>

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: Program<NamedDeBruijn>) -> Result<Self, Self::Error>

Performs the conversion.

impl<T> StructuralPartialEq for Program<T>