docs
API
Generated with
docs/scalus/scalus.uplc/Program

Program

scalus.uplc.Program
See theProgram companion object
case class Program(version: (Int, Int, Int), term: Term)

A Cardano Plutus program.

A program is a versioned Term. The version is a tuple of three integers: major, minor, and patch.

Value parameters

term

the term of the program

version

the version of the program

Attributes

Companion
object
Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all

Members list

Value members

Concrete methods

infix def $(arg: Term): Program

Applies an argument to the program.

Applies an argument to the program.

Value parameters

arg

the argument

Attributes

Returns

the program with the argument applied

infix def $(arg: Data): Program
infix def `α_==`(that: Program): Boolean

Checks if two programs are equal.

Checks if two programs are equal.

Two programs are equal if their versions are equal and their terms are alpha-equivalent. This means that the names of the variables are not important, only their De Bruijn indices. We use unique negative indices to represent free variables.

Value parameters

that

the other program

Attributes

Returns

true if the programs are alpha-equal, false otherwise

infix def alphaEq(that: Program): Boolean

Checks if two programs are equal.

Checks if two programs are equal.

Two programs are equal if their versions are equal and their terms are alpha-equivalent. This means that the names of the variables are not important, only their De Bruijn indices. We use unique negative indices to represent free variables.

Value parameters

that

the other program

Attributes

Returns

true if the programs are alpha-equal, false otherwise

def evaluate(using vm: PlutusVM): Term

Evaluates the program using the given VM according to the Plutus specification.

Evaluates the program using the given VM according to the Plutus specification.

Attributes

Throws
RuntimeException

on evaluation error

def evaluateDebug(using vm: PlutusVM): Result

Evaluates the program using the given VM according to the Plutus specification.

Evaluates the program using the given VM according to the Plutus specification.

Attributes

Returns

scalus.uplc.eval.Result with the evaluation result and the spent budget

def pretty: Doc

Pretty-print the program.

Pretty-print the program.

Attributes

def prettyXTerm: Doc

Pretty-print the program with XTerm syntax highlighting.

Pretty-print the program with XTerm syntax highlighting.

Attributes

def show: String

Show the program as a string.

Show the program as a string.

Attributes

def showHighlighted: String

Show the program as a string with XTerm syntax highlighting.

Show the program as a string with XTerm syntax highlighting.

Attributes

def writePlutusFile(path: String, plutusVersion: Language): Unit

Write the program to a Plutus file.

Write the program to a Plutus file.

Value parameters

path

the path to the file

plutusVersion

the Plutus version (V1, V2, or V3)

Attributes

Deprecated methods

def evaluate(using vm: PlutusVM): Term
Extension method from scalus

Attributes

Deprecated
[Since version 0.14.2] Use Program.evaluate method instead
def evaluateDebug(using vm: PlutusVM): Result
Extension method from scalus

Attributes

Deprecated
[Since version 0.14.2] Use Program.evaluateDebug method instead
def pretty: Doc
Extension method from scalus

Attributes

Deprecated
[Since version 0.14.2] Use Program.pretty method instead
def prettyXTerm: Doc
Extension method from scalus

Attributes

Deprecated
[Since version 0.14.2] Use Program.prettyXTerm method instead
def show: String
Extension method from scalus

Attributes

Deprecated
[Since version 0.14.2] Use Program.show method instead
def showHighlighted: String
Extension method from scalus

Attributes

Deprecated
[Since version 0.14.2] Use Program.showHighlighted method instead
def writePlutusFile(path: String, plutusVersion: Language): Unit
Extension method from scalus

Attributes

Deprecated
[Since version 0.14.2] Use Program.writePlutusFile method instead

Inherited methods

def productElementNames: Iterator[String]

Attributes

Inherited from:
Product
def productIterator: Iterator[Any]

Attributes

Inherited from:
Product

Concrete fields

lazy val cborByteString: ByteString

CBOR-encoded scalus.uplc.builtin.ByteString of the program.

CBOR-encoded scalus.uplc.builtin.ByteString of the program.

The CBOR-encoded representation is a byte array that contains the program in a CBOR format.

Attributes

lazy val cborEncoded: Array[Byte]

CBOR-encoded representation of the program.

CBOR-encoded representation of the program.

The CBOR-encoded representation is a byte array that contains the program in a CBOR format.

Attributes

lazy val deBruijnedProgram: DeBruijnedProgram

De Bruijn-indexed representation of the program.

De Bruijn-indexed representation of the program.

The De Bruijn-indexed representation is a versioned Term where the variables are indexed using De Bruijn indices. A program must be named.

Attributes

lazy val doubleCborEncoded: Array[Byte]

Double CBOR-encoded representation of the program.

Double CBOR-encoded representation of the program.

Cardano uses a double-CBOR encoding for Plutus scripts in many places.

Attributes

lazy val doubleCborHex: String

Double CBOR-encoded hex string of the program.

Double CBOR-encoded hex string of the program.

Cardano uses a double-CBOR encoding for Plutus scripts in many places.

Attributes

lazy val flatEncoded: Array[Byte]

Flat-encoded representation of the program.

Flat-encoded representation of the program.

The flat-encoded representation is a byte array that contains the program in a flat format. This format is used to serialize the program to CBOR.

Attributes

Generated with