docs
API
Generated with
docs/scalus

scalus

package scalus

Members list

Packages

package scalus.builtin
package scalus.examples
package scalus.flat
package scalus.ledger
package scalus.macros
package scalus.prelude
package scalus.sir
package scalus.uplc
package scalus.utils

Type members

Classlikes

final class Compile extends Annotation

Attributes

Supertypes
class Annotation
class Object
trait Matchable
class Any
object Compiler

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type
Compiler.type
final class Ignore extends Annotation

Attributes

Supertypes
class Annotation
class Object
trait Matchable
class Any

Extensions

Extensions

extension [A](inline a: A)
infix inline def |>[B](inline f: A => B): B

Pipe operator

Pipe operator

Attributes

extension (c: Constant)
def pretty: Doc
extension (du: DefaultUni)
def pretty: Doc

Deprecated extensions

extension (p: Program)
def eval: Term

Attributes

Deprecated
true
def evalDebug: Result

Attributes

Deprecated
true
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

Result with the evaluation result and the spent budget

def pretty: Doc
def prettyXTerm: Doc
def show: String
def showHighlighted: String
def writePlutusFile(path: String, plutusVersion: PlutusLedgerLanguage): Unit
extension (p: DeBruijnedProgram)
def eval: Term

Attributes

Deprecated
true
def evalDebug: Result

Attributes

Deprecated
true
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

Result with the evaluation result and the spent budget

def pretty: Doc
def prettyXTerm: Doc
def show: String
def showHighlighted: String
def writePlutusFile(path: String, plutusVersion: PlutusLedgerLanguage): Unit
extension (self: Term)
def eval: Term

Attributes

Deprecated
true
def evalDebug: Result

Attributes

Deprecated
true
def evaluate(using vm: PlutusVM): Term

Evaluate the term using the given VM.

Evaluate the term using the given VM.

Attributes

Throws
RuntimeException

on evaluation error

Note

This method just runs the CEK machine on the term. It does not follow Plutus specification like CIP-117

def evaluateDebug(using vm: PlutusVM): Result

Evaluate the term using the given VM.

Evaluate the term using the given VM.

Attributes

Returns

Result with the evaluation result and the spent budget

Note

This method just runs the CEK machine on the term. It does not follow Plutus * specification like CIP-117

def pretty: Doc
def prettyXTerm: Doc
def show: String
def showHighlighted: String
extension (sir: SIR)
def doubleCborHex(version: (Int, Int, Int), generateErrorTraces: Boolean): String

Attributes

Deprecated
true
def pretty: Doc
def prettyXTerm: Doc
def show: String
def showHighlighted: String
def toPlutusProgram(version: (Int, Int, Int), generateErrorTraces: Boolean): Program

Attributes

Deprecated
true
def toUplc(generateErrorTraces: Boolean): Term
def toUplcOptimized(generateErrorTraces: Boolean): Term
Generated with