docs
API
Generated with
docs/scalus/scalus.uplc/scalus.uplc.eval/VM

VM

scalus.uplc.eval.VM
object VM extends PlutusVMBase

Attributes

Deprecated
true
Graph
Supertypes
class PlutusVMBase
class Object
trait Matchable
class Any
Self type
VM.type

Members list

Type members

Inherited types

type ScriptForEvaluation = Array[Byte]

Attributes

Inherited from:
PlutusVMBase

Value members

Inherited methods

def evaluateDebug(term: Term, params: MachineParams): Result

Evaluates a UPLC term, capturing the execution budget, evaluation logs and costs.

Evaluates a UPLC term, capturing the execution budget, evaluation logs and costs.

Attributes

Returns

Result with the resulting term, the execution budget, evaluation logs and costs, and an exception if the evaluation failed

Note

This method doesn't follow the CIP-117, so it can't be used to correctly evaluate Cardano validators.

Inherited from:
PlutusVMBase
def evaluateProgram(p: Program, params: MachineParams): Term

Evaluates a UPLC Program using default CEK machine parameters and no budget calculation.

Evaluates a UPLC Program using default CEK machine parameters and no budget calculation.

Useful for testing and debugging.

Attributes

Note

This method doesn't follow the CIP-117, so it can't be used to correctly evaluate Cardano validators.

Inherited from:
PlutusVMBase
def evaluateScriptCounting(params: MachineParams, script: ScriptForEvaluation, args: Data*): CekResult

Evaluates a script, returning the minimum budget that the script would need to evaluate. This will take as long as the script takes.

Evaluates a script, returning the minimum budget that the script would need to evaluate. This will take as long as the script takes.

Value parameters

args

The arguments to the script

params

The machine parameters

script

Flat encoded script to evaluate

Attributes

Returns

CekResult with the resulting term and the execution budget

Inherited from:
PlutusVMBase
def evaluateScriptRestricting(params: MachineParams, budget: ExBudget, script: ScriptForEvaluation, args: Data*): CekResult

Evaluates a script, returning the execution budget and logs.

Evaluates a script, returning the execution budget and logs.

Value parameters

args

The arguments to the script

budget

The budget to restrict the evaluation

params

The machine parameters

script

Flat encoded script to evaluate

Attributes

Returns

CekResult with the resulting term and the execution budget

Inherited from:
PlutusVMBase
def evaluateTerm(term: Term, params: MachineParams): Term

Evaluates a UPLC Term using default MachinePrameters and no budget calculation.

Evaluates a UPLC Term using default MachinePrameters and no budget calculation.

Useful for testing and debugging.

Value parameters

params

The machine parameters

term

The debruijned term to evaluate

Attributes

Returns

The resulting term

Throws
StackTraceMachineError

subtypes if the evaluation fails

Note

This method doesn't follow the CIP-117, so it can't be used to correctly evaluate Cardano validators.

Inherited from:
PlutusVMBase
Generated with