plutus-core-1.34.1.0: Language library for Plutus Core
Safe HaskellSafe-Inferred
LanguageHaskell2010

PlutusCore.Examples.Builtins

Synopsis

Documentation

size ∷ ∀ a. (Bounded a, Enum a) ⇒ Int Source #

data ExtensionFun Source #

Constructors

Factorial 
ForallFortyTwo 
SumInteger 
Const 
Id 
IdAssumeBool 
IdAssumeCheckBool 
IdSomeConstantBool 
IdIntegerAsBool 
IdFInteger 
IdList 
IdRank2 
ScottToMetaUnit 
FailingSucc 
ExpensiveSucc 
FailingPlus 
ExpensivePlus 
IsConstant 
UnsafeCoerce 
UnsafeCoerceEl 
Undefined 
Absurd 
ErrorPrime 
Comma 
BiconstPair 
Swap 
SwapEls 
ExtensionVersion 
TrackCosts 
IntNoIntegerNoWord 

Instances

Instances details
Bounded ExtensionFun Source # 
Instance details

Defined in PlutusCore.Examples.Builtins

Methods

minBound ∷ ExtensionFun Source #

maxBound ∷ ExtensionFun Source #

Enum ExtensionFun Source # 
Instance details

Defined in PlutusCore.Examples.Builtins

Methods

succ ∷ ExtensionFun → ExtensionFun Source #

pred ∷ ExtensionFun → ExtensionFun Source #

toEnum ∷ Int → ExtensionFun Source #

fromEnum ∷ ExtensionFun → Int Source #

enumFrom ∷ ExtensionFun → [ExtensionFun] Source #

enumFromThen ∷ ExtensionFun → ExtensionFun → [ExtensionFun] Source #

enumFromTo ∷ ExtensionFun → ExtensionFun → [ExtensionFun] Source #

enumFromThenTo ∷ ExtensionFun → ExtensionFun → ExtensionFun → [ExtensionFun] Source #

Generic ExtensionFun Source # 
Instance details

Defined in PlutusCore.Examples.Builtins

Associated Types

type Rep ExtensionFun ∷ Type → Type Source #

Methods

from ∷ ExtensionFun → Rep ExtensionFun x Source #

to ∷ Rep ExtensionFun x → ExtensionFun Source #

Ix ExtensionFun Source # 
Instance details

Defined in PlutusCore.Examples.Builtins

Methods

range ∷ (ExtensionFun, ExtensionFun) → [ExtensionFun] Source #

index ∷ (ExtensionFun, ExtensionFun) → ExtensionFun → Int Source #

unsafeIndex ∷ (ExtensionFun, ExtensionFun) → ExtensionFun → Int Source #

inRange ∷ (ExtensionFun, ExtensionFun) → ExtensionFun → Bool Source #

rangeSize ∷ (ExtensionFun, ExtensionFun) → Int Source #

unsafeRangeSize ∷ (ExtensionFun, ExtensionFun) → Int Source #

Show ExtensionFun Source # 
Instance details

Defined in PlutusCore.Examples.Builtins

Methods

showsPrec ∷ Int → ExtensionFun → ShowS Source #

show ∷ ExtensionFun → String Source #

showList ∷ [ExtensionFun] → ShowS Source #

Eq ExtensionFun Source # 
Instance details

Defined in PlutusCore.Examples.Builtins

Methods

(==) ∷ ExtensionFun → ExtensionFun → Bool Source #

(/=) ∷ ExtensionFun → ExtensionFun → Bool Source #

Ord ExtensionFun Source # 
Instance details

Defined in PlutusCore.Examples.Builtins

Methods

compare ∷ ExtensionFun → ExtensionFun → Ordering Source #

(<) ∷ ExtensionFun → ExtensionFun → Bool Source #

(<=) ∷ ExtensionFun → ExtensionFun → Bool Source #

(>) ∷ ExtensionFun → ExtensionFun → Bool Source #

(>=) ∷ ExtensionFun → ExtensionFun → Bool Source #

max ∷ ExtensionFun → ExtensionFun → ExtensionFun Source #

min ∷ ExtensionFun → ExtensionFun → ExtensionFun Source #

Hashable ExtensionFun Source # 
Instance details

Defined in PlutusCore.Examples.Builtins

Methods

hashWithSalt ∷ Int → ExtensionFun → Int Source #

hash ∷ ExtensionFun → Int Source #

Pretty ExtensionFun Source # 
Instance details

Defined in PlutusCore.Examples.Builtins

Methods

pretty ∷ ExtensionFun → Doc ann Source #

prettyList ∷ [ExtensionFun] → Doc ann Source #

uni ~ DefaultUni ⇒ ToBuiltinMeaning uni ExtensionFun Source # 
Instance details

Defined in PlutusCore.Examples.Builtins

Associated Types

type CostingPart uni ExtensionFun Source #

data BuiltinSemanticsVariant ExtensionFun Source #

Methods

toBuiltinMeaning ∷ HasMeaningIn uni val ⇒ BuiltinSemanticsVariant ExtensionFun → ExtensionFun → BuiltinMeaning val (CostingPart uni ExtensionFun) Source #

Bounded (BuiltinSemanticsVariant ExtensionFun) Source # 
Instance details

Defined in PlutusCore.Examples.Builtins

Methods

minBound ∷ BuiltinSemanticsVariant ExtensionFun Source #

maxBound ∷ BuiltinSemanticsVariant ExtensionFun Source #

Enum (BuiltinSemanticsVariant ExtensionFun) Source # 
Instance details

Defined in PlutusCore.Examples.Builtins

Methods

succ ∷ BuiltinSemanticsVariant ExtensionFun → BuiltinSemanticsVariant ExtensionFun Source #

pred ∷ BuiltinSemanticsVariant ExtensionFun → BuiltinSemanticsVariant ExtensionFun Source #

toEnum ∷ Int → BuiltinSemanticsVariant ExtensionFun Source #

fromEnum ∷ BuiltinSemanticsVariant ExtensionFun → Int Source #

enumFrom ∷ BuiltinSemanticsVariant ExtensionFun → [BuiltinSemanticsVariant ExtensionFun] Source #

enumFromThen ∷ BuiltinSemanticsVariant ExtensionFun → BuiltinSemanticsVariant ExtensionFun → [BuiltinSemanticsVariant ExtensionFun] Source #

enumFromTo ∷ BuiltinSemanticsVariant ExtensionFun → BuiltinSemanticsVariant ExtensionFun → [BuiltinSemanticsVariant ExtensionFun] Source #

enumFromThenTo ∷ BuiltinSemanticsVariant ExtensionFun → BuiltinSemanticsVariant ExtensionFun → BuiltinSemanticsVariant ExtensionFun → [BuiltinSemanticsVariant ExtensionFun] Source #

Show (BuiltinSemanticsVariant ExtensionFun) Source # 
Instance details

Defined in PlutusCore.Examples.Builtins

Methods

showsPrec ∷ Int → BuiltinSemanticsVariant ExtensionFun → ShowS Source #

show ∷ BuiltinSemanticsVariant ExtensionFun → String Source #

showList ∷ [BuiltinSemanticsVariant ExtensionFun] → ShowS Source #

Default (BuiltinSemanticsVariant ExtensionFun) Source # 
Instance details

Defined in PlutusCore.Examples.Builtins

Methods

def ∷ BuiltinSemanticsVariant ExtensionFun Source #

Eq (BuiltinSemanticsVariant ExtensionFun) Source # 
Instance details

Defined in PlutusCore.Examples.Builtins

Methods

(==) ∷ BuiltinSemanticsVariant ExtensionFun → BuiltinSemanticsVariant ExtensionFun → Bool Source #

(/=) ∷ BuiltinSemanticsVariant ExtensionFun → BuiltinSemanticsVariant ExtensionFun → Bool Source #

Ord (BuiltinSemanticsVariant ExtensionFun) Source # 
Instance details

Defined in PlutusCore.Examples.Builtins

Methods

compare ∷ BuiltinSemanticsVariant ExtensionFun → BuiltinSemanticsVariant ExtensionFun → Ordering Source #

(<) ∷ BuiltinSemanticsVariant ExtensionFun → BuiltinSemanticsVariant ExtensionFun → Bool Source #

(<=) ∷ BuiltinSemanticsVariant ExtensionFun → BuiltinSemanticsVariant ExtensionFun → Bool Source #

(>) ∷ BuiltinSemanticsVariant ExtensionFun → BuiltinSemanticsVariant ExtensionFun → Bool Source #

(>=) ∷ BuiltinSemanticsVariant ExtensionFun → BuiltinSemanticsVariant ExtensionFun → Bool Source #

max ∷ BuiltinSemanticsVariant ExtensionFun → BuiltinSemanticsVariant ExtensionFun → BuiltinSemanticsVariant ExtensionFun Source #

min ∷ BuiltinSemanticsVariant ExtensionFun → BuiltinSemanticsVariant ExtensionFun → BuiltinSemanticsVariant ExtensionFun Source #

type Rep ExtensionFun Source # 
Instance details

Defined in PlutusCore.Examples.Builtins

type Rep ExtensionFun = D1 ('MetaData "ExtensionFun" "PlutusCore.Examples.Builtins" "plutus-core-1.34.1.0-inplace" 'False) ((((C1 ('MetaCons "Factorial" 'PrefixI 'False) (U1 ∷ Type → Type) :+: (C1 ('MetaCons "ForallFortyTwo" 'PrefixI 'False) (U1 ∷ Type → Type) :+: C1 ('MetaCons "SumInteger" 'PrefixI 'False) (U1 ∷ Type → Type))) :+: ((C1 ('MetaCons "Const" 'PrefixI 'False) (U1 ∷ Type → Type) :+: C1 ('MetaCons "Id" 'PrefixI 'False) (U1 ∷ Type → Type)) :+: (C1 ('MetaCons "IdAssumeBool" 'PrefixI 'False) (U1 ∷ Type → Type) :+: C1 ('MetaCons "IdAssumeCheckBool" 'PrefixI 'False) (U1 ∷ Type → Type)))) :+: (((C1 ('MetaCons "IdSomeConstantBool" 'PrefixI 'False) (U1 ∷ Type → Type) :+: C1 ('MetaCons "IdIntegerAsBool" 'PrefixI 'False) (U1 ∷ Type → Type)) :+: (C1 ('MetaCons "IdFInteger" 'PrefixI 'False) (U1 ∷ Type → Type) :+: C1 ('MetaCons "IdList" 'PrefixI 'False) (U1 ∷ Type → Type))) :+: ((C1 ('MetaCons "IdRank2" 'PrefixI 'False) (U1 ∷ Type → Type) :+: C1 ('MetaCons "ScottToMetaUnit" 'PrefixI 'False) (U1 ∷ Type → Type)) :+: (C1 ('MetaCons "FailingSucc" 'PrefixI 'False) (U1 ∷ Type → Type) :+: C1 ('MetaCons "ExpensiveSucc" 'PrefixI 'False) (U1 ∷ Type → Type))))) :+: (((C1 ('MetaCons "FailingPlus" 'PrefixI 'False) (U1 ∷ Type → Type) :+: (C1 ('MetaCons "ExpensivePlus" 'PrefixI 'False) (U1 ∷ Type → Type) :+: C1 ('MetaCons "IsConstant" 'PrefixI 'False) (U1 ∷ Type → Type))) :+: ((C1 ('MetaCons "UnsafeCoerce" 'PrefixI 'False) (U1 ∷ Type → Type) :+: C1 ('MetaCons "UnsafeCoerceEl" 'PrefixI 'False) (U1 ∷ Type → Type)) :+: (C1 ('MetaCons "Undefined" 'PrefixI 'False) (U1 ∷ Type → Type) :+: C1 ('MetaCons "Absurd" 'PrefixI 'False) (U1 ∷ Type → Type)))) :+: (((C1 ('MetaCons "ErrorPrime" 'PrefixI 'False) (U1 ∷ Type → Type) :+: C1 ('MetaCons "Comma" 'PrefixI 'False) (U1 ∷ Type → Type)) :+: (C1 ('MetaCons "BiconstPair" 'PrefixI 'False) (U1 ∷ Type → Type) :+: C1 ('MetaCons "Swap" 'PrefixI 'False) (U1 ∷ Type → Type))) :+: ((C1 ('MetaCons "SwapEls" 'PrefixI 'False) (U1 ∷ Type → Type) :+: C1 ('MetaCons "ExtensionVersion" 'PrefixI 'False) (U1 ∷ Type → Type)) :+: (C1 ('MetaCons "TrackCosts" 'PrefixI 'False) (U1 ∷ Type → Type) :+: C1 ('MetaCons "IntNoIntegerNoWord" 'PrefixI 'False) (U1 ∷ Type → Type))))))
data BuiltinSemanticsVariant ExtensionFun Source # 
Instance details

Defined in PlutusCore.Examples.Builtins

data BuiltinSemanticsVariant ExtensionFun
type CostingPart uni ExtensionFun Source # 
Instance details

Defined in PlutusCore.Examples.Builtins

type CostingPart uni ExtensionFun = ()

newtype MetaForall name a Source #

Normally forall in the type of a Haskell function gets detected and instantiated automatically, however there's no way of doing that for a forall that binds a never referenced type variable. Which is OK, because that would be a pretty weird builtin, however it's definable and for the purpose of testing we do introduce such a builtin, hence this definition allowing us to create an all that binds a never referenced type variable in Plutus while still using makeBuiltinMeaning.

Constructors

MetaForall a 

Instances

Instances details
(name ~ ('TyNameRep text uniq ∷ TyNameRep kind), KnownSymbol text, KnownNat uniq, KnownKind kind, KnownTypeAst tyname uni a) ⇒ KnownTypeAst tyname uni (MetaForall name a ∷ Type) Source # 
Instance details

Defined in PlutusCore.Examples.Builtins

Associated Types

type IsBuiltin uni (MetaForall name a) ∷ Bool Source #

type ToHoles uni (MetaForall name a) ∷ [Hole] Source #

type ToBinds uni acc (MetaForall name a) ∷ [Some TyNameRep] Source #

Methods

typeAst ∷ Type0 tyname uni () Source #

MakeKnownIn DefaultUni term a ⇒ MakeKnownIn DefaultUni term (MetaForall name a) Source # 
Instance details

Defined in PlutusCore.Examples.Builtins

Methods

makeKnown ∷ MetaForall name a → BuiltinResult term Source #

type ToBinds uni acc (MetaForall name a ∷ Type) Source # 
Instance details

Defined in PlutusCore.Examples.Builtins

type ToBinds uni acc (MetaForall name a ∷ Type) = ToBinds uni (Insert ('Some name) acc) a
type IsBuiltin uni (MetaForall name a ∷ Type) Source # 
Instance details

Defined in PlutusCore.Examples.Builtins

type IsBuiltin uni (MetaForall name a ∷ Type) = 'False
type ToHoles uni (MetaForall name a ∷ Type) Source # 
Instance details

Defined in PlutusCore.Examples.Builtins

type ToHoles uni (MetaForall name a ∷ Type) = '[TypeHole a ∷ Hole]

data PlcListRep (a ∷ Type) Source #

Instances

Instances details
(tyname ~ TyName, KnownTypeAst tyname uni a) ⇒ KnownTypeAst tyname uni (PlcListRep a ∷ Type) Source # 
Instance details

Defined in PlutusCore.Examples.Builtins

Associated Types

type IsBuiltin uni (PlcListRep a) ∷ Bool Source #

type ToHoles uni (PlcListRep a) ∷ [Hole] Source #

type ToBinds uni acc (PlcListRep a) ∷ [Some TyNameRep] Source #

Methods

typeAst ∷ Type0 tyname uni () Source #

type ToBinds uni acc (PlcListRep a ∷ Type) Source # 
Instance details

Defined in PlutusCore.Examples.Builtins

type ToBinds uni acc (PlcListRep a ∷ Type) = ToBinds uni acc a
type IsBuiltin uni (PlcListRep a ∷ Type) Source # 
Instance details

Defined in PlutusCore.Examples.Builtins

type IsBuiltin uni (PlcListRep a ∷ Type) = 'False
type ToHoles uni (PlcListRep a ∷ Type) Source # 
Instance details

Defined in PlutusCore.Examples.Builtins

type ToHoles uni (PlcListRep a ∷ Type) = '[RepHole a ∷ Hole]

data BuiltinErrorCall Source #

Constructors

BuiltinErrorCall 

Instances

Instances details
Exception BuiltinErrorCall Source # 
Instance details

Defined in PlutusCore.Examples.Builtins

Methods

toException ∷ BuiltinErrorCall → SomeException Source #

fromException ∷ SomeException → Maybe BuiltinErrorCall Source #

displayException ∷ BuiltinErrorCall → String Source #

Show BuiltinErrorCall Source # 
Instance details

Defined in PlutusCore.Examples.Builtins

Methods

showsPrec ∷ Int → BuiltinErrorCall → ShowS Source #

show ∷ BuiltinErrorCall → String Source #

showList ∷ [BuiltinErrorCall] → ShowS Source #

Eq BuiltinErrorCall Source # 
Instance details

Defined in PlutusCore.Examples.Builtins

Methods

(==) ∷ BuiltinErrorCall → BuiltinErrorCall → Bool Source #

(/=) ∷ BuiltinErrorCall → BuiltinErrorCall → Bool Source #

class Whatever a where Source #

For the most part we don't care about costing functions of example builtins, hence this class for being explicit about not caring.

Methods

whatever ∷ a Source #

The costing function of a builtin whose costing function doesn't matter.

Instances

Instances details
Whatever ExBudgetStream Source # 
Instance details

Defined in PlutusCore.Examples.Builtins

Methods

whatever ∷ ExBudgetStream Source #

Whatever b ⇒ Whatever (a → b) Source # 
Instance details

Defined in PlutusCore.Examples.Builtins

Methods

whatever ∷ a → b Source #

Orphan instances

UniOf term ~ DefaultUni ⇒ MakeKnownIn DefaultUni term Void Source # 
Instance details

Methods

makeKnown ∷ Void → BuiltinResult term Source #

UniOf term ~ DefaultUni ⇒ ReadKnownIn DefaultUni term Void Source # 
Instance details

Methods

readKnown ∷ term → ReadKnownM Void Source #

tyname ~ TyName ⇒ KnownTypeAst tyname DefaultUni Void Source # 
Instance details

Associated Types

type IsBuiltin DefaultUni Void ∷ Bool Source #

type ToHoles DefaultUni Void ∷ [Hole] Source #

type ToBinds DefaultUni acc Void ∷ [Some TyNameRep] Source #

Methods

typeAst ∷ Type tyname DefaultUni () Source #

(ToBuiltinMeaning uni fun1, ToBuiltinMeaning uni fun2, Default (BuiltinSemanticsVariant fun1), Default (BuiltinSemanticsVariant fun2)) ⇒ ToBuiltinMeaning uni (Either fun1 fun2) Source # 
Instance details

Associated Types

type CostingPart uni (Either fun1 fun2) Source #

data BuiltinSemanticsVariant (Either fun1 fun2) Source #

Methods

toBuiltinMeaning ∷ HasMeaningIn uni val ⇒ BuiltinSemanticsVariant (Either fun1 fun2) → Either fun1 fun2 → BuiltinMeaning val (CostingPart uni (Either fun1 fun2)) Source #

(Default (BuiltinSemanticsVariant fun1), Default (BuiltinSemanticsVariant fun2)) ⇒ Default (BuiltinSemanticsVariant (Either fun1 fun2)) Source # 
Instance details

Methods

def ∷ BuiltinSemanticsVariant (Either fun1 fun2) Source #

(Bounded a, Bounded b) ⇒ Bounded (Either a b) Source # 
Instance details

Methods

minBound ∷ Either a b Source #

maxBound ∷ Either a b Source #

(Eq a, Eq b, Bounded a, Bounded b, Enum a, Enum b) ⇒ Enum (Either a b) Source # 
Instance details

Methods

succ ∷ Either a b → Either a b Source #

pred ∷ Either a b → Either a b Source #

toEnum ∷ Int → Either a b Source #

fromEnum ∷ Either a b → Int Source #

enumFrom ∷ Either a b → [Either a b] Source #

enumFromThen ∷ Either a b → Either a b → [Either a b] Source #

enumFromTo ∷ Either a b → Either a b → [Either a b] Source #

enumFromThenTo ∷ Either a b → Either a b → Either a b → [Either a b] Source #

(Bounded a, Bounded b, Ix a, Ix b) ⇒ Ix (Either a b) Source # 
Instance details

Methods

range ∷ (Either a b, Either a b) → [Either a b] Source #

index ∷ (Either a b, Either a b) → Either a b → Int Source #

unsafeIndex ∷ (Either a b, Either a b) → Either a b → Int Source #

inRange ∷ (Either a b, Either a b) → Either a b → Bool Source #

rangeSize ∷ (Either a b, Either a b) → Int Source #

unsafeRangeSize ∷ (Either a b, Either a b) → Int Source #