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

PlutusV3

scalus.uplc.PlutusV3
See thePlutusV3 companion class
object PlutusV3

Factory methods for creating compiled Plutus V3 scripts.

Attributes

Companion
class
Graph
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
PlutusV3.type

Members list

Type members

Inherited and Abstract types

type MirroredElemLabels <: Tuple

The names of the product elements

The names of the product elements

Attributes

Inherited from:
Mirror
type MirroredLabel <: String

The name of the type

The name of the type

Attributes

Inherited from:
Mirror

Value members

Concrete methods

inline def compile[A](inline code: A)(using opts: Options): PlutusV3[A]

Compiles Scala code to a Plutus V3 script.

Compiles Scala code to a Plutus V3 script.

This is the main entry point for compiling Cardano smart contracts. The code is compiled at compile-time using the Scalus compiler plugin.

Type parameters

A

the type of the code being compiled

Value parameters

code

the Scala code to compile (must be within the Scalus-supported subset)

opts

compiler options controlling compilation, lowering, and optimization

Attributes

Returns

a PlutusV3 containing the compiled script

Example 
 given scalus.compiler.Options = scalus.compiler.Options.release
 val validator = PlutusV3.compile { (datum: Data) =>
   val d = datum.to[MyDatum]
   require(d.value > 0)
 }

Extensions

Extensions

extension [A, B](self: PlutusV3[A => B])(implicit evidence$1: LiftValue[A])
def apply: PlutusV3[B]

Applies an argument to a compiled function, producing a new compiled script.

Applies an argument to a compiled function, producing a new compiled script.

The argument is converted to a UPLC constant and applied to the SIR representation, resulting in a specialized script with the parameter baked in.

Value parameters

arg

the argument to apply, must have a Constant.LiftValue instance

Attributes

Returns

a new PlutusV3 with the argument applied

Generated with