docs
API
Generated with
docs/scalus/scalus.uplc

scalus.uplc

package scalus.uplc

Members list

Packages

package scalus.uplc.eval
package scalus.uplc.test
package scalus.uplc.transform

Type members

Classlikes

case class BuiltinRuntime(typeScheme: TypeScheme, f: (Logger, Seq[CekValue]) => CekValue, args: Seq[CekValue], costFunction: CostingFun)

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
enum BuiltinSemanticsVariant

Attributes

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

Attributes

Companion
enum
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
class CardanoBuiltins(builtinCostModel: BuiltinCostModel, platformSpecific: PlatformSpecific, semanticVariant: BuiltinSemanticsVariant) extends BuiltinsMeaning

Attributes

Supertypes
class Object
trait Matchable
class Any
trait Compiled[A]

Attributes

Supertypes
class Object
trait Matchable
class Any
Known subtypes
class PlutusV3[A]
sealed trait Constant

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
class Array
class Bool
class BuiltinValue
class ByteString
class Data
class Integer
class List
class Pair
class String
object Unit
Show all
object Constant

Attributes

Companion
trait
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
Constant.type
object DeBruijn

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type
DeBruijn.type
case class DeBruijnedProgram

A De Bruijn-indexed program.

A De Bruijn-indexed program.

A De Bruijn-indexed program is a versioned Term where the variables are indexed using De Bruijn indices. A program must be De Bruijn-indexed before it can be evaluated.

Value parameters

term

the term of the program

version

the version of the program

Attributes

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

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
enum DefaultFun extends Enum[DefaultFun]

Attributes

Companion
object
Supertypes
trait Enum
trait Product
trait Equals
class Enum[DefaultFun]
trait Serializable
trait Comparable[DefaultFun]
trait Constable
class Object
trait Matchable
class Any
Show all
object DefaultFun

Attributes

Companion
enum
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
DefaultFun.type
object DefaultFunOrdering extends Ordering[DefaultFun]

Attributes

Supertypes
trait Ordering[DefaultFun]
trait PartialOrdering[DefaultFun]
trait Equiv[DefaultFun]
trait Serializable
trait Comparator[DefaultFun]
class Object
trait Matchable
class Any
Show all
Self type
sealed abstract class DefaultUni

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
class Apply
object BuiltinValue
object Data
class LiftedUni[A]
object Bool
object ByteString
object Integer
object String
object Unit
object ProtoArray
object ProtoList
object ProtoPair
Show all
object DefaultUni

Attributes

Companion
class
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
DefaultUni.type
trait Delayed[+A]

Attributes

Supertypes
class Object
trait Matchable
class Any
case class Expr[+A](term: Term)

Attributes

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

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type
object Meaning

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type
Meaning.type
case class NamedDeBruijn(name: String, index: Int = ...)

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
trait PlutusParams

Attributes

Supertypes
class Object
trait Matchable
class Any
Known subtypes
class PlutusV1Params extends PlutusParams

Plutus V1 cost model parameters.

Plutus V1 cost model parameters.

The names of the fields are taken from https://github.com/input-output-hk/plutus/blob/1.40.0.0/plutus-ledger-api/src/PlutusLedgerApi/V1/ParamName.hs and Blockfrost Protocol Parameters JSON uses these names as well in blockfrost-params-epoch-544.json

But what's really important is the order of the fields because that's the order of the parameters in the protocol parameters array.

Attributes

Companion
object
Supertypes
trait PlutusParams
class Object
trait Matchable
class Any
object PlutusV1Params

Attributes

Companion
class
Supertypes
class Object
trait Matchable
class Any
Self type
class PlutusV2Params extends PlutusParams

Plutus V2 cost model parameters.

Plutus V2 cost model parameters.

The names of the fields are taken from https://github.com/input-output-hk/plutus/blob/1.40.0.0/plutus-ledger-api/src/PlutusLedgerApi/V2/ParamName.hs and Blockfrost Protocol Parameters JSON uses these names as well in blockfrost-params-epoch-544.json

But what's really important is the order of the fields because that's the order of the parameters in the protocol parameters array.

Attributes

Companion
object
Supertypes
trait PlutusParams
class Object
trait Matchable
class Any
object PlutusV2Params

Attributes

Companion
class
Supertypes
class Object
trait Matchable
class Any
Self type
case class PlutusV3[A](lazyCode: () => A, sir: SIR, options: Options, optimizer: Optimizer) extends Compiled[A]

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
trait Compiled[A]
class Object
trait Matchable
class Any
Show all
object PlutusV3

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
PlutusV3.type
class PlutusV3Params extends PlutusParams

Plutus V3 cost model parameters.

Plutus V3 cost model parameters.

The names of the fields are taken from https://github.com/input-output-hk/plutus/blob/1.40.0.0/plutus-ledger-api/src/PlutusLedgerApi/V3/ParamName.hs and Blockfrost Protocol Parameters JSON uses these names as well in blockfrost-params-epoch-544.json

But what's really important is the order of the fields because that's the order of the parameters in the protocol parameters array.

Attributes

Companion
object
Supertypes
trait PlutusParams
class Object
trait Matchable
class Any
object PlutusV3Params

Attributes

Companion
class
Supertypes
class Object
trait Matchable
class Any
Self type
object PlutusV4Params

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type
case class Program(version: (Int, Int, Int), term: Term)

A Cardano Plutus program.

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
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object Program

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
Program.type
object ProgramFlatCodec

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type
enum Term

Attributes

Companion
object
Supertypes
trait Enum
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
Known subtypes
class Var
class LamAbs
class Apply
class Force
class Delay
class Const
class Builtin
Show all
object Term

Attributes

Companion
enum
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
Term.type
object TermDSL

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type
TermDSL.type
object TermSanitizer

Sanitizes UPLC Terms to ensure all variable names conform to the UPLC text format requirements.

Sanitizes UPLC Terms to ensure all variable names conform to the UPLC text format requirements.

UPLC text format only allows:

  • First character: letters (a-z, A-Z) or underscore (_)
  • Subsequent characters: letters, digits, underscore (_), or apostrophe (')
  • Optional suffix: hyphen followed by digits (-\d+)

This sanitizer transforms variable names to comply with these rules while avoiding conflicts.

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type
enum TypeScheme

Attributes

Supertypes
trait Enum
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object UplcCli

Cardano uplc CLI interface

Cardano uplc CLI interface

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type
UplcCli.type
enum UplcEvalResult

Represents the result of evaluating a UPLC program using uplc CLI

Represents the result of evaluating a UPLC program using uplc CLI

Attributes

Supertypes
trait Enum
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
class UplcParser(initialVersion: (Int, Int, Int) = ...)

UPLC parsers.

UPLC parsers.

It's a collection of parsers for the UPLC language. Term and Program parsers are statefull and are program version dependent, that's why this is a class and not an object.

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
object UplcParser

Attributes

Companion
class
Supertypes
class Object
trait Matchable
class Any
Self type
UplcParser.type

Deprecated classlikes

class BuiltinsMeaning(builtinCostModel: BuiltinCostModel, platformSpecific: PlatformSpecific, semanticVariant: BuiltinSemanticsVariant)

Attributes

Deprecated
[Since version 0.12.1] Use CardanoBuiltins instead
Supertypes
class Object
trait Matchable
class Any
Known subtypes

Types

Givens

Givens

Extensions

Extensions

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