Safe Haskell	None
Language	Haskell2010

Cardano.Ledger.Plutus.Language

Contents

Plutus Script
Value level Plutus Language version
Type level Plutus Language version
Plutus Script Context
Orphan instances

Description

This module provides data structures and operations for talking about Non-native Script languages. It is expected that new languages (or new versions of old languages) will be added here.

Synopsis

newtype Plutus (l ∷ Language) = Plutus {
- plutusBinary ∷ PlutusBinary
}
isValidPlutus ∷ ∀ (l ∷ Language). PlutusLanguage l ⇒ Version → Plutus l → Bool
newtype PlutusBinary = PlutusBinary {
- unPlutusBinary ∷ ShortByteString
}
newtype PlutusRunnable (l ∷ Language) = PlutusRunnable {
- plutusRunnable ∷ ScriptForEvaluation
}
plutusFromRunnable ∷ ∀ (l ∷ Language). PlutusRunnable l → Plutus l
decodeWithPlutus ∷ (∀ si (l ∷ Language). PlutusLanguage l ⇒ Plutus l → Decoder si a) → Decoder so a
hashPlutusScript ∷ ∀ (l ∷ Language). PlutusLanguage l ⇒ Plutus l → ScriptHash
data Language
- = PlutusV1
- | PlutusV2
- | PlutusV3
- | PlutusV4
mkLanguageEnum ∷ Int → Maybe Language
languageToText ∷ Language → Text
languageFromText ∷ MonadFail m ⇒ Text → m Language
nonNativeLanguages ∷ [Language]
guardPlutus ∷ Language → Decoder s ()
data SLanguage (l ∷ Language) where
- SPlutusV1 ∷ SLanguage 'PlutusV1
- SPlutusV2 ∷ SLanguage 'PlutusV2
- SPlutusV3 ∷ SLanguage 'PlutusV3
- SPlutusV4 ∷ SLanguage 'PlutusV4
class (Typeable l, NFData (PlutusArgs l), EncCBOR (PlutusArgs l), DecCBOR (PlutusArgs l), Pretty (PlutusArgs l), Show (PlutusArgs l), Eq (PlutusArgs l)) ⇒ PlutusLanguage (l ∷ Language) where
- data PlutusArgs (l ∷ Language)
- isLanguage ∷ SLanguage l
- plutusLanguageTag ∷ Plutus l → Word8
- decodePlutusRunnable ∷ Version → Plutus l → Either ScriptDecodeError (PlutusRunnable l)
- evaluatePlutusRunnable ∷ Version → VerboseMode → EvaluationContext → ExBudget → PlutusRunnable l → PlutusArgs l → (LogOutput, Either EvaluationError ExBudget)
- evaluatePlutusRunnableBudget ∷ Version → VerboseMode → EvaluationContext → PlutusRunnable l → PlutusArgs l → (LogOutput, Either EvaluationError ExBudget)
- mkTermToEvaluate ∷ Version → PlutusRunnable l → PlutusArgs l → Either EvaluationError (Term NamedDeBruijn DefaultUni DefaultFun ())
data family PlutusArgs (l ∷ Language)
plutusLanguage ∷ ∀ (l ∷ Language) proxy. PlutusLanguage l ⇒ proxy l → Language
plutusSLanguage ∷ ∀ (l ∷ Language) proxy. PlutusLanguage l ⇒ proxy l → SLanguage l
toSLanguage ∷ ∀ (l ∷ Language) m. (PlutusLanguage l, MonadFail m) ⇒ Language → m (SLanguage l)
withSLanguage ∷ Language → (∀ (l ∷ Language). PlutusLanguage l ⇒ SLanguage l → a) → a
asSLanguage ∷ ∀ (l ∷ Language) proxy. SLanguage l → proxy l → proxy l
withSamePlutusLanguage ∷ ∀ f1 f2 (l1 ∷ Language) (l2 ∷ Language) a. (PlutusLanguage l1, PlutusLanguage l2) ⇒ f1 l1 → f2 l2 → (∀ (l ∷ Language). PlutusLanguage l ⇒ f1 l → f2 l → a) → Maybe a
data LegacyPlutusArgs (l ∷ Language)
- = LegacyPlutusArgs2 !Data !(PlutusScriptContext l)
- | LegacyPlutusArgs3 !Data !Data !(PlutusScriptContext l)
type family PlutusScriptContext (l ∷ Language) = (r ∷ Type) | r → l where ...

Plutus Script

newtype Plutus (l ∷ Language) Source #

Serialized representation of a Plutus script that distinguishes the language version at the type level. When encoded in CBOR language version is also encoded.

Constructors

Plutus
Fields plutusBinary ∷ PlutusBinary

Instances

Instances details

PlutusLanguage l ⇒ DecCBOR (Plutus l) Source #

Instance details

Defined in Cardano.Ledger.Plutus.Language

Methods

decCBOR ∷ Decoder s (Plutus l) Source #

dropCBOR ∷ Proxy (Plutus l) → Decoder s () Source #

label ∷ Proxy (Plutus l) → Text Source #

PlutusLanguage l ⇒ EncCBOR (Plutus l) Source #

Instance details

Defined in Cardano.Ledger.Plutus.Language

Methods

encCBOR ∷ Plutus l → Encoding Source #

SafeToHash (Plutus l) Source #

Instance details

Defined in Cardano.Ledger.Plutus.Language

Methods

originalBytes ∷ Plutus l → ByteString Source #

originalBytesSize ∷ Plutus l → Int Source #

makeHashWithExplicitProxys ∷ Proxy i → Plutus l → SafeHash i Source #

NFData (Plutus l) Source #

Instance details

Defined in Cardano.Ledger.Plutus.Language

Methods

rnf ∷ Plutus l → () #

Generic (Plutus l) Source #

Instance details

Defined in Cardano.Ledger.Plutus.Language

Associated Types

type Rep (Plutus l)
Instance details Defined in Cardano.Ledger.Plutus.Language type Rep (Plutus l) = D1 ('MetaData "Plutus" "Cardano.Ledger.Plutus.Language" "cardano-ledger-core-1.19.0.0-inplace" 'True) (C1 ('MetaCons "Plutus" 'PrefixI 'True) (S1 ('MetaSel ('Just "plutusBinary") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 PlutusBinary)))

Methods

from ∷ Plutus l → Rep (Plutus l) x #

to ∷ Rep (Plutus l) x → Plutus l #

Show (Plutus l) Source #

Instance details

Defined in Cardano.Ledger.Plutus.Language

Methods

showsPrec ∷ Int → Plutus l → ShowS #

show ∷ Plutus l → String #

showList ∷ [Plutus l] → ShowS #

Eq (Plutus l) Source #

Instance details

Defined in Cardano.Ledger.Plutus.Language

Methods

(==) ∷ Plutus l → Plutus l → Bool #

(/=) ∷ Plutus l → Plutus l → Bool #

Ord (Plutus l) Source #

Instance details

Defined in Cardano.Ledger.Plutus.Language

Methods

compare ∷ Plutus l → Plutus l → Ordering #

(<) ∷ Plutus l → Plutus l → Bool #

(<=) ∷ Plutus l → Plutus l → Bool #

(>) ∷ Plutus l → Plutus l → Bool #

(>=) ∷ Plutus l → Plutus l → Bool #

max ∷ Plutus l → Plutus l → Plutus l #

min ∷ Plutus l → Plutus l → Plutus l #

MemPack (Plutus l) Source #

Instance details

Defined in Cardano.Ledger.Plutus.Language

Methods

typeName ∷ String Source #

packedByteCount ∷ Plutus l → Int Source #

packM ∷ Plutus l → Pack s () Source #

unpackM ∷ Buffer b ⇒ Unpack s b (Plutus l) Source #

NoThunks (Plutus l) Source #

Instance details

Defined in Cardano.Ledger.Plutus.Language

Methods

noThunks ∷ Context → Plutus l → IO (Maybe ThunkInfo) Source #

wNoThunks ∷ Context → Plutus l → IO (Maybe ThunkInfo) Source #

showTypeOf ∷ Proxy (Plutus l) → String Source #

type Rep (Plutus l) Source #

Instance details

Defined in Cardano.Ledger.Plutus.Language

type Rep (Plutus l) = D1 ('MetaData "Plutus" "Cardano.Ledger.Plutus.Language" "cardano-ledger-core-1.19.0.0-inplace" 'True) (C1 ('MetaCons "Plutus" 'PrefixI 'True) (S1 ('MetaSel ('Just "plutusBinary") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 PlutusBinary)))

isValidPlutus ∷ ∀ (l ∷ Language). PlutusLanguage l ⇒ Version → Plutus l → Bool Source #

Verify that the binary version of the Plutus script is deserializable.

newtype PlutusBinary Source #

Binary representation of a Plutus script.

Constructors

PlutusBinary
Fields unPlutusBinary ∷ ShortByteString

Instances

Instances details

FromCBOR PlutusBinary Source #

Instance details

Defined in Cardano.Ledger.Plutus.Language

Methods

fromCBOR ∷ Decoder s PlutusBinary Source #

label ∷ Proxy PlutusBinary → Text Source #

ToCBOR PlutusBinary Source #

Instance details

Defined in Cardano.Ledger.Plutus.Language

Methods

toCBOR ∷ PlutusBinary → Encoding Source #

encodedSizeExpr ∷ (∀ t. ToCBOR t ⇒ Proxy t → Size) → Proxy PlutusBinary → Size Source #

encodedListSizeExpr ∷ (∀ t. ToCBOR t ⇒ Proxy t → Size) → Proxy [PlutusBinary] → Size Source #

DecCBOR PlutusBinary Source #

Instance details

Defined in Cardano.Ledger.Plutus.Language

Methods

decCBOR ∷ Decoder s PlutusBinary Source #

dropCBOR ∷ Proxy PlutusBinary → Decoder s () Source #

label ∷ Proxy PlutusBinary → Text Source #

EncCBOR PlutusBinary Source #

Instance details

Defined in Cardano.Ledger.Plutus.Language

Methods

encCBOR ∷ PlutusBinary → Encoding Source #

SafeToHash PlutusBinary Source #

Instance details

Defined in Cardano.Ledger.Plutus.Language

Methods

originalBytes ∷ PlutusBinary → ByteString Source #

originalBytesSize ∷ PlutusBinary → Int Source #

makeHashWithExplicitProxys ∷ Proxy i → PlutusBinary → SafeHash i Source #

NFData PlutusBinary Source #

Instance details

Defined in Cardano.Ledger.Plutus.Language

Methods

rnf ∷ PlutusBinary → () #

Generic PlutusBinary Source #

Instance details

Defined in Cardano.Ledger.Plutus.Language

Associated Types

type Rep PlutusBinary
Instance details Defined in Cardano.Ledger.Plutus.Language type Rep PlutusBinary = D1 ('MetaData "PlutusBinary" "Cardano.Ledger.Plutus.Language" "cardano-ledger-core-1.19.0.0-inplace" 'True) (C1 ('MetaCons "PlutusBinary" 'PrefixI 'True) (S1 ('MetaSel ('Just "unPlutusBinary") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ShortByteString)))

Methods

from ∷ PlutusBinary → Rep PlutusBinary x #

to ∷ Rep PlutusBinary x → PlutusBinary #

Show PlutusBinary Source #

Instance details

Defined in Cardano.Ledger.Plutus.Language

Methods

showsPrec ∷ Int → PlutusBinary → ShowS #

show ∷ PlutusBinary → String #

showList ∷ [PlutusBinary] → ShowS #

Eq PlutusBinary Source #

Instance details

Defined in Cardano.Ledger.Plutus.Language

Methods

(==) ∷ PlutusBinary → PlutusBinary → Bool #

(/=) ∷ PlutusBinary → PlutusBinary → Bool #

Ord PlutusBinary Source #

Instance details

Defined in Cardano.Ledger.Plutus.Language

Methods

compare ∷ PlutusBinary → PlutusBinary → Ordering #

(<) ∷ PlutusBinary → PlutusBinary → Bool #

(<=) ∷ PlutusBinary → PlutusBinary → Bool #

(>) ∷ PlutusBinary → PlutusBinary → Bool #

(>=) ∷ PlutusBinary → PlutusBinary → Bool #

max ∷ PlutusBinary → PlutusBinary → PlutusBinary #

min ∷ PlutusBinary → PlutusBinary → PlutusBinary #

MemPack PlutusBinary Source #

Instance details

Defined in Cardano.Ledger.Plutus.Language

Methods

typeName ∷ String Source #

packedByteCount ∷ PlutusBinary → Int Source #

packM ∷ PlutusBinary → Pack s () Source #

unpackM ∷ Buffer b ⇒ Unpack s b PlutusBinary Source #

NoThunks PlutusBinary Source #

Instance details

Defined in Cardano.Ledger.Plutus.Language

Methods

noThunks ∷ Context → PlutusBinary → IO (Maybe ThunkInfo) Source #

wNoThunks ∷ Context → PlutusBinary → IO (Maybe ThunkInfo) Source #

showTypeOf ∷ Proxy PlutusBinary → String Source #

DecCBOR (Annotator PlutusBinary) Source #

Instance details

Defined in Cardano.Ledger.Plutus.Language

Methods

decCBOR ∷ Decoder s (Annotator PlutusBinary) Source #

dropCBOR ∷ Proxy (Annotator PlutusBinary) → Decoder s () Source #

label ∷ Proxy (Annotator PlutusBinary) → Text Source #

type Rep PlutusBinary Source #

Instance details

Defined in Cardano.Ledger.Plutus.Language

type Rep PlutusBinary = D1 ('MetaData "PlutusBinary" "Cardano.Ledger.Plutus.Language" "cardano-ledger-core-1.19.0.0-inplace" 'True) (C1 ('MetaCons "PlutusBinary" 'PrefixI 'True) (S1 ('MetaSel ('Just "unPlutusBinary") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ShortByteString)))

newtype PlutusRunnable (l ∷ Language) Source #

This is a deserialized version of the Plutus type that can be used directly with evaluation functions that rely on evaluatePlutusRunnable.

The only way to obtain this type is by the means of deserializing Plutus with decodePlutusRunnable

Constructors

PlutusRunnable
Fields plutusRunnable ∷ ScriptForEvaluation

Instances

Instances details

PlutusLanguage l ⇒ DecCBOR (PlutusRunnable l) Source #

Instance details

Defined in Cardano.Ledger.Plutus.Language

Methods

decCBOR ∷ Decoder s (PlutusRunnable l) Source #

dropCBOR ∷ Proxy (PlutusRunnable l) → Decoder s () Source #

label ∷ Proxy (PlutusRunnable l) → Text Source #

PlutusLanguage l ⇒ EncCBOR (PlutusRunnable l) Source #

Instance details

Defined in Cardano.Ledger.Plutus.Language

Methods

encCBOR ∷ PlutusRunnable l → Encoding Source #

NFData (PlutusRunnable l) Source #

Instance details

Defined in Cardano.Ledger.Plutus.Language

Methods

rnf ∷ PlutusRunnable l → () #

Generic (PlutusRunnable l) Source #

Instance details

Defined in Cardano.Ledger.Plutus.Language

Associated Types

type Rep (PlutusRunnable l)
Instance details Defined in Cardano.Ledger.Plutus.Language type Rep (PlutusRunnable l) = D1 ('MetaData "PlutusRunnable" "Cardano.Ledger.Plutus.Language" "cardano-ledger-core-1.19.0.0-inplace" 'True) (C1 ('MetaCons "PlutusRunnable" 'PrefixI 'True) (S1 ('MetaSel ('Just "plutusRunnable") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ScriptForEvaluation)))

Methods

from ∷ PlutusRunnable l → Rep (PlutusRunnable l) x #

to ∷ Rep (PlutusRunnable l) x → PlutusRunnable l #

Show (PlutusRunnable l) Source #

Instance details

Defined in Cardano.Ledger.Plutus.Language

Methods

showsPrec ∷ Int → PlutusRunnable l → ShowS #

show ∷ PlutusRunnable l → String #

showList ∷ [PlutusRunnable l] → ShowS #

Eq (PlutusRunnable l) Source #

Instance details

Defined in Cardano.Ledger.Plutus.Language

Methods

(==) ∷ PlutusRunnable l → PlutusRunnable l → Bool #

(/=) ∷ PlutusRunnable l → PlutusRunnable l → Bool #

NoThunks (PlutusRunnable l) Source #

Instance details

Defined in Cardano.Ledger.Plutus.Language

Methods

noThunks ∷ Context → PlutusRunnable l → IO (Maybe ThunkInfo) Source #

wNoThunks ∷ Context → PlutusRunnable l → IO (Maybe ThunkInfo) Source #

showTypeOf ∷ Proxy (PlutusRunnable l) → String Source #

type Rep (PlutusRunnable l) Source #

Instance details

Defined in Cardano.Ledger.Plutus.Language

type Rep (PlutusRunnable l) = D1 ('MetaData "PlutusRunnable" "Cardano.Ledger.Plutus.Language" "cardano-ledger-core-1.19.0.0-inplace" 'True) (C1 ('MetaCons "PlutusRunnable" 'PrefixI 'True) (S1 ('MetaSel ('Just "plutusRunnable") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ScriptForEvaluation)))

plutusFromRunnable ∷ ∀ (l ∷ Language). PlutusRunnable l → Plutus l Source #

Serialize the runnable version of the plutus script

decodePlutusRunnable majVer (plutusFromRunnable pr) == Right pr

decodeWithPlutus ∷ (∀ si (l ∷ Language). PlutusLanguage l ⇒ Plutus l → Decoder si a) → Decoder so a Source #

Plutus script decoder that will enforce the type level language equals the one included in the serialization

hashPlutusScript ∷ ∀ (l ∷ Language). PlutusLanguage l ⇒ Plutus l → ScriptHash Source #

Compute a ScriptHash of a Plutus script. This function is equivalent to hashScript, except it is restricted to Plutus scripts

Value level Plutus Language version

data Language Source #

Non-Native Plutus Script language. This is expected to be an open type. We will add new Constuctors to this type as additional Plutus language versions as are added. We use an enumerated type for two reasons.

We can write total functions by case analysis over the constructors
We use DataKinds to make some datatypes indexed by Language.

Note that the the serialization of Language depends on the ordering.

Constructors

PlutusV1
PlutusV2
PlutusV3
PlutusV4

Instances

Instances details

FromJSON Language Source #

Instance details

Defined in Cardano.Ledger.Plutus.Language

Methods

parseJSON ∷ Value → Parser Language Source #

parseJSONList ∷ Value → Parser [Language] Source #

omittedField ∷ Maybe Language Source #

FromJSONKey Language Source #

Instance details

Defined in Cardano.Ledger.Plutus.Language

Methods

fromJSONKey ∷ FromJSONKeyFunction Language Source #

fromJSONKeyList ∷ FromJSONKeyFunction [Language] Source #

ToJSON Language Source #

Instance details

Defined in Cardano.Ledger.Plutus.Language

Methods

toJSON ∷ Language → Value Source #

toEncoding ∷ Language → Encoding Source #

toJSONList ∷ [Language] → Value Source #

toEncodingList ∷ [Language] → Encoding Source #

omitField ∷ Language → Bool Source #

ToJSONKey Language Source #

Instance details

Defined in Cardano.Ledger.Plutus.Language

Methods

toJSONKey ∷ ToJSONKeyFunction Language Source #

toJSONKeyList ∷ ToJSONKeyFunction [Language] Source #

FromCBOR Language Source #

Instance details

Defined in Cardano.Ledger.Plutus.Language

Methods

fromCBOR ∷ Decoder s Language Source #

label ∷ Proxy Language → Text Source #

ToCBOR Language Source #

Instance details

Defined in Cardano.Ledger.Plutus.Language

Methods

toCBOR ∷ Language → Encoding Source #

encodedSizeExpr ∷ (∀ t. ToCBOR t ⇒ Proxy t → Size) → Proxy Language → Size Source #

encodedListSizeExpr ∷ (∀ t. ToCBOR t ⇒ Proxy t → Size) → Proxy [Language] → Size Source #

DecCBOR Language Source #

Instance details

Defined in Cardano.Ledger.Plutus.Language

Methods

decCBOR ∷ Decoder s Language Source #

dropCBOR ∷ Proxy Language → Decoder s () Source #

label ∷ Proxy Language → Text Source #

EncCBOR Language Source #

Instance details

Defined in Cardano.Ledger.Plutus.Language

Methods

encCBOR ∷ Language → Encoding Source #

NFData Language Source #

Instance details

Defined in Cardano.Ledger.Plutus.Language

Methods

rnf ∷ Language → () #

Bounded Language Source #

Instance details

Defined in Cardano.Ledger.Plutus.Language

Methods

minBound ∷ Language #

maxBound ∷ Language #

Enum Language Source #

Instance details

Defined in Cardano.Ledger.Plutus.Language

Methods

succ ∷ Language → Language #

pred ∷ Language → Language #

toEnum ∷ Int → Language #

fromEnum ∷ Language → Int #

enumFrom ∷ Language → [Language] #

enumFromThen ∷ Language → Language → [Language] #

enumFromTo ∷ Language → Language → [Language] #

enumFromThenTo ∷ Language → Language → Language → [Language] #

Generic Language Source #

Instance details

Defined in Cardano.Ledger.Plutus.Language

Associated Types

type Rep Language

Instance details

Defined in Cardano.Ledger.Plutus.Language

type Rep Language = D1 ('MetaData "Language" "Cardano.Ledger.Plutus.Language" "cardano-ledger-core-1.19.0.0-inplace" 'False) ((C1 ('MetaCons "PlutusV1" 'PrefixI 'False) (U1 ∷ Type → Type) :+: C1 ('MetaCons "PlutusV2" 'PrefixI 'False) (U1 ∷ Type → Type)) :+: (C1 ('MetaCons "PlutusV3" 'PrefixI 'False) (U1 ∷ Type → Type) :+: C1 ('MetaCons "PlutusV4" 'PrefixI 'False) (U1 ∷ Type → Type)))

Methods

from ∷ Language → Rep Language x #

to ∷ Rep Language x → Language #

Ix Language Source #

Instance details

Defined in Cardano.Ledger.Plutus.Language

Methods

range ∷ (Language, Language) → [Language] #

index ∷ (Language, Language) → Language → Int #

unsafeIndex ∷ (Language, Language) → Language → Int #

inRange ∷ (Language, Language) → Language → Bool #

rangeSize ∷ (Language, Language) → Int #

unsafeRangeSize ∷ (Language, Language) → Int #

Read Language Source #

Instance details

Defined in Cardano.Ledger.Plutus.Language

Methods

readsPrec ∷ Int → ReadS Language #

readList ∷ ReadS [Language] #

readPrec ∷ ReadPrec Language #

readListPrec ∷ ReadPrec [Language] #

Show Language Source #

Instance details

Defined in Cardano.Ledger.Plutus.Language

Methods

showsPrec ∷ Int → Language → ShowS #

show ∷ Language → String #

showList ∷ [Language] → ShowS #

Eq Language Source #

Instance details

Defined in Cardano.Ledger.Plutus.Language

Methods

(==) ∷ Language → Language → Bool #

(/=) ∷ Language → Language → Bool #

Ord Language Source #

Instance details

Defined in Cardano.Ledger.Plutus.Language

Methods

compare ∷ Language → Language → Ordering #

(<) ∷ Language → Language → Bool #

(<=) ∷ Language → Language → Bool #

(>) ∷ Language → Language → Bool #

(>=) ∷ Language → Language → Bool #

max ∷ Language → Language → Language #

min ∷ Language → Language → Language #

NoThunks Language Source #

Instance details

Defined in Cardano.Ledger.Plutus.Language

Methods

noThunks ∷ Context → Language → IO (Maybe ThunkInfo) Source #

wNoThunks ∷ Context → Language → IO (Maybe ThunkInfo) Source #

showTypeOf ∷ Proxy Language → String Source #

Random Language Source #

Instance details

Defined in Cardano.Ledger.Plutus.Language

Methods

randomR ∷ RandomGen g ⇒ (Language, Language) → g → (Language, g) Source #

random ∷ RandomGen g ⇒ g → (Language, g) Source #

randomRs ∷ RandomGen g ⇒ (Language, Language) → g → [Language] Source #

randoms ∷ RandomGen g ⇒ g → [Language] Source #

Uniform Language Source #

Instance details

Defined in Cardano.Ledger.Plutus.Language

Methods

uniformM ∷ StatefulGen g m ⇒ g → m Language Source #

UniformRange Language Source #

Instance details

Defined in Cardano.Ledger.Plutus.Language

Methods

uniformRM ∷ StatefulGen g m ⇒ (Language, Language) → g → m Language Source #

isInRange ∷ (Language, Language) → Language → Bool Source #

type Rep Language Source #

Instance details

Defined in Cardano.Ledger.Plutus.Language

type Rep Language = D1 ('MetaData "Language" "Cardano.Ledger.Plutus.Language" "cardano-ledger-core-1.19.0.0-inplace" 'False) ((C1 ('MetaCons "PlutusV1" 'PrefixI 'False) (U1 ∷ Type → Type) :+: C1 ('MetaCons "PlutusV2" 'PrefixI 'False) (U1 ∷ Type → Type)) :+: (C1 ('MetaCons "PlutusV3" 'PrefixI 'False) (U1 ∷ Type → Type) :+: C1 ('MetaCons "PlutusV4" 'PrefixI 'False) (U1 ∷ Type → Type)))

mkLanguageEnum ∷ Int → Maybe Language Source #

Make a language from its Enum index.

languageToText ∷ Language → Text Source #

languageFromText ∷ MonadFail m ⇒ Text → m Language Source #

nonNativeLanguages ∷ [Language] Source #

guardPlutus ∷ Language → Decoder s () Source #

Prevent decoding a version of Plutus until the appropriate protocol version.

Type level Plutus Language version

data SLanguage (l ∷ Language) where Source #

Singleton for 'Language'

Constructors

SPlutusV1 ∷ SLanguage 'PlutusV1
SPlutusV2 ∷ SLanguage 'PlutusV2
SPlutusV3 ∷ SLanguage 'PlutusV3
SPlutusV4 ∷ SLanguage 'PlutusV4

Instances

Instances details

PlutusLanguage l ⇒ FromCBOR (SLanguage l) Source #
Instance details Defined in Cardano.Ledger.Plutus.Language Methods fromCBOR ∷ Decoder s (SLanguage l) Source # label ∷ Proxy (SLanguage l) → Text Source #
PlutusLanguage l ⇒ ToCBOR (SLanguage l) Source #
Instance details Defined in Cardano.Ledger.Plutus.Language Methods toCBOR ∷ SLanguage l → Encoding Source # encodedSizeExpr ∷ (∀ t. ToCBOR t ⇒ Proxy t → Size) → Proxy (SLanguage l) → Size Source # encodedListSizeExpr ∷ (∀ t. ToCBOR t ⇒ Proxy t → Size) → Proxy [SLanguage l] → Size Source #
PlutusLanguage l ⇒ DecCBOR (SLanguage l) Source #
Instance details Defined in Cardano.Ledger.Plutus.Language Methods decCBOR ∷ Decoder s (SLanguage l) Source # dropCBOR ∷ Proxy (SLanguage l) → Decoder s () Source # label ∷ Proxy (SLanguage l) → Text Source #
PlutusLanguage l ⇒ EncCBOR (SLanguage l) Source #
Instance details Defined in Cardano.Ledger.Plutus.Language Methods encCBOR ∷ SLanguage l → Encoding Source #
Show (SLanguage l) Source #
Instance details Defined in Cardano.Ledger.Plutus.Language Methods showsPrec ∷ Int → SLanguage l → ShowS # show ∷ SLanguage l → String # showList ∷ [SLanguage l] → ShowS #
Eq (SLanguage l) Source #
Instance details Defined in Cardano.Ledger.Plutus.Language Methods (==) ∷ SLanguage l → SLanguage l → Bool # (/=) ∷ SLanguage l → SLanguage l → Bool #

class (Typeable l, NFData (PlutusArgs l), EncCBOR (PlutusArgs l), DecCBOR (PlutusArgs l), Pretty (PlutusArgs l), Show (PlutusArgs l), Eq (PlutusArgs l)) ⇒ PlutusLanguage (l ∷ Language) where Source #

For implicit reflection on 'SLanguage' See Cardano.Ledger.Alonzo.Plutus.TxInfo for example usage

Associated Types

data PlutusArgs (l ∷ Language) Source #

Methods

isLanguage ∷ SLanguage l Source #

plutusLanguageTag ∷ Plutus l → Word8 Source #

Tag that will be used as a prefix to compute the ScriptHash

decodePlutusRunnable Source #

Arguments

∷ Version	Which major protocol version to use for deserialization and further execution
→ Plutus l	Binary version of the script that will be deserialized
→ Either ScriptDecodeError (PlutusRunnable l)

evaluatePlutusRunnable Source #

Arguments

∷ Version	Which major protocol version to use for script execution
→ VerboseMode	Whether to produce log output
→ EvaluationContext	Includes the cost model to use for tallying up the execution costs
→ ExBudget	The resource budget which must not be exceeded during evaluation
→ PlutusRunnable l	The script to evaluate
→ PlutusArgs l	The arguments to the script
→ (LogOutput, Either EvaluationError ExBudget)

evaluatePlutusRunnableBudget Source #

Arguments

∷ Version	Which major protocol version to use for script execution
→ VerboseMode	Whether to produce log output
→ EvaluationContext	Includes the cost model to use for tallying up the execution costs
→ PlutusRunnable l	The script to evaluate
→ PlutusArgs l	The arguments to the script
→ (LogOutput, Either EvaluationError ExBudget)

Similar to evaluatePlutusRunnable, except does not require ExBudget to be provided as input and instead computes it as output. This function is meant to be used for testing.

mkTermToEvaluate Source #

Arguments

∷ Version	Which major protocol version to use for script execution
→ PlutusRunnable l	The script to evaluate
→ PlutusArgs l	The arguments to the script
→ Either EvaluationError (Term NamedDeBruijn DefaultUni DefaultFun ())

Instances

Instances details

PlutusLanguage 'PlutusV1 Source #

Instance details

Defined in Cardano.Ledger.Plutus.Language

Associated Types

newtype PlutusArgs 'PlutusV1
Instance details Defined in Cardano.Ledger.Plutus.Language newtype PlutusArgs 'PlutusV1 = PlutusV1Args { unPlutusV1Args ∷ LegacyPlutusArgs 'PlutusV1 }

Methods

isLanguage ∷ SLanguage 'PlutusV1 Source #

plutusLanguageTag ∷ Plutus 'PlutusV1 → Word8 Source #

decodePlutusRunnable ∷ Version → Plutus 'PlutusV1 → Either ScriptDecodeError (PlutusRunnable 'PlutusV1) Source #

evaluatePlutusRunnable ∷ Version → VerboseMode → EvaluationContext → ExBudget → PlutusRunnable 'PlutusV1 → PlutusArgs 'PlutusV1 → (LogOutput, Either EvaluationError ExBudget) Source #

evaluatePlutusRunnableBudget ∷ Version → VerboseMode → EvaluationContext → PlutusRunnable 'PlutusV1 → PlutusArgs 'PlutusV1 → (LogOutput, Either EvaluationError ExBudget) Source #

mkTermToEvaluate ∷ Version → PlutusRunnable 'PlutusV1 → PlutusArgs 'PlutusV1 → Either EvaluationError (Term NamedDeBruijn DefaultUni DefaultFun ()) Source #

PlutusLanguage 'PlutusV2 Source #

Instance details

Defined in Cardano.Ledger.Plutus.Language

Associated Types

newtype PlutusArgs 'PlutusV2
Instance details Defined in Cardano.Ledger.Plutus.Language newtype PlutusArgs 'PlutusV2 = PlutusV2Args { unPlutusV2Args ∷ LegacyPlutusArgs 'PlutusV2 }

Methods

isLanguage ∷ SLanguage 'PlutusV2 Source #

plutusLanguageTag ∷ Plutus 'PlutusV2 → Word8 Source #

decodePlutusRunnable ∷ Version → Plutus 'PlutusV2 → Either ScriptDecodeError (PlutusRunnable 'PlutusV2) Source #

evaluatePlutusRunnable ∷ Version → VerboseMode → EvaluationContext → ExBudget → PlutusRunnable 'PlutusV2 → PlutusArgs 'PlutusV2 → (LogOutput, Either EvaluationError ExBudget) Source #

evaluatePlutusRunnableBudget ∷ Version → VerboseMode → EvaluationContext → PlutusRunnable 'PlutusV2 → PlutusArgs 'PlutusV2 → (LogOutput, Either EvaluationError ExBudget) Source #

mkTermToEvaluate ∷ Version → PlutusRunnable 'PlutusV2 → PlutusArgs 'PlutusV2 → Either EvaluationError (Term NamedDeBruijn DefaultUni DefaultFun ()) Source #

PlutusLanguage 'PlutusV3 Source #

Instance details

Defined in Cardano.Ledger.Plutus.Language

Associated Types

newtype PlutusArgs 'PlutusV3
Instance details Defined in Cardano.Ledger.Plutus.Language newtype PlutusArgs 'PlutusV3 = PlutusV3Args { unPlutusV3Args ∷ ScriptContext }

Methods

isLanguage ∷ SLanguage 'PlutusV3 Source #

plutusLanguageTag ∷ Plutus 'PlutusV3 → Word8 Source #

decodePlutusRunnable ∷ Version → Plutus 'PlutusV3 → Either ScriptDecodeError (PlutusRunnable 'PlutusV3) Source #

evaluatePlutusRunnable ∷ Version → VerboseMode → EvaluationContext → ExBudget → PlutusRunnable 'PlutusV3 → PlutusArgs 'PlutusV3 → (LogOutput, Either EvaluationError ExBudget) Source #

evaluatePlutusRunnableBudget ∷ Version → VerboseMode → EvaluationContext → PlutusRunnable 'PlutusV3 → PlutusArgs 'PlutusV3 → (LogOutput, Either EvaluationError ExBudget) Source #

mkTermToEvaluate ∷ Version → PlutusRunnable 'PlutusV3 → PlutusArgs 'PlutusV3 → Either EvaluationError (Term NamedDeBruijn DefaultUni DefaultFun ()) Source #

PlutusLanguage 'PlutusV4 Source #

Instance details

Defined in Cardano.Ledger.Plutus.Language

Associated Types

newtype PlutusArgs 'PlutusV4
Instance details Defined in Cardano.Ledger.Plutus.Language newtype PlutusArgs 'PlutusV4 = PlutusV4Args { unPlutusV4Args ∷ ScriptContext }

Methods

isLanguage ∷ SLanguage 'PlutusV4 Source #

plutusLanguageTag ∷ Plutus 'PlutusV4 → Word8 Source #

decodePlutusRunnable ∷ Version → Plutus 'PlutusV4 → Either ScriptDecodeError (PlutusRunnable 'PlutusV4) Source #

evaluatePlutusRunnable ∷ Version → VerboseMode → EvaluationContext → ExBudget → PlutusRunnable 'PlutusV4 → PlutusArgs 'PlutusV4 → (LogOutput, Either EvaluationError ExBudget) Source #

evaluatePlutusRunnableBudget ∷ Version → VerboseMode → EvaluationContext → PlutusRunnable 'PlutusV4 → PlutusArgs 'PlutusV4 → (LogOutput, Either EvaluationError ExBudget) Source #

mkTermToEvaluate ∷ Version → PlutusRunnable 'PlutusV4 → PlutusArgs 'PlutusV4 → Either EvaluationError (Term NamedDeBruijn DefaultUni DefaultFun ()) Source #

data family PlutusArgs (l ∷ Language) Source #

Instances

Instances details

DecCBOR (PlutusArgs 'PlutusV1) Source #
Instance details Defined in Cardano.Ledger.Plutus.Language Methods decCBOR ∷ Decoder s (PlutusArgs 'PlutusV1) Source # dropCBOR ∷ Proxy (PlutusArgs 'PlutusV1) → Decoder s () Source # label ∷ Proxy (PlutusArgs 'PlutusV1) → Text Source #
DecCBOR (PlutusArgs 'PlutusV2) Source #
Instance details Defined in Cardano.Ledger.Plutus.Language Methods decCBOR ∷ Decoder s (PlutusArgs 'PlutusV2) Source # dropCBOR ∷ Proxy (PlutusArgs 'PlutusV2) → Decoder s () Source # label ∷ Proxy (PlutusArgs 'PlutusV2) → Text Source #
DecCBOR (PlutusArgs 'PlutusV3) Source #
Instance details Defined in Cardano.Ledger.Plutus.Language Methods decCBOR ∷ Decoder s (PlutusArgs 'PlutusV3) Source # dropCBOR ∷ Proxy (PlutusArgs 'PlutusV3) → Decoder s () Source # label ∷ Proxy (PlutusArgs 'PlutusV3) → Text Source #
DecCBOR (PlutusArgs 'PlutusV4) Source #
Instance details Defined in Cardano.Ledger.Plutus.Language Methods decCBOR ∷ Decoder s (PlutusArgs 'PlutusV4) Source # dropCBOR ∷ Proxy (PlutusArgs 'PlutusV4) → Decoder s () Source # label ∷ Proxy (PlutusArgs 'PlutusV4) → Text Source #
EncCBOR (PlutusArgs 'PlutusV1) Source #
Instance details Defined in Cardano.Ledger.Plutus.Language Methods encCBOR ∷ PlutusArgs 'PlutusV1 → Encoding Source #
EncCBOR (PlutusArgs 'PlutusV2) Source #
Instance details Defined in Cardano.Ledger.Plutus.Language Methods encCBOR ∷ PlutusArgs 'PlutusV2 → Encoding Source #
EncCBOR (PlutusArgs 'PlutusV3) Source #
Instance details Defined in Cardano.Ledger.Plutus.Language Methods encCBOR ∷ PlutusArgs 'PlutusV3 → Encoding Source #
EncCBOR (PlutusArgs 'PlutusV4) Source #
Instance details Defined in Cardano.Ledger.Plutus.Language Methods encCBOR ∷ PlutusArgs 'PlutusV4 → Encoding Source #
NFData (PlutusArgs 'PlutusV1) Source #
Instance details Defined in Cardano.Ledger.Plutus.Language Methods rnf ∷ PlutusArgs 'PlutusV1 → () #
NFData (PlutusArgs 'PlutusV2) Source #
Instance details Defined in Cardano.Ledger.Plutus.Language Methods rnf ∷ PlutusArgs 'PlutusV2 → () #
NFData (PlutusArgs 'PlutusV3) Source #
Instance details Defined in Cardano.Ledger.Plutus.Language Methods rnf ∷ PlutusArgs 'PlutusV3 → () #
NFData (PlutusArgs 'PlutusV4) Source #
Instance details Defined in Cardano.Ledger.Plutus.Language Methods rnf ∷ PlutusArgs 'PlutusV4 → () #
Show (PlutusArgs 'PlutusV1) Source #
Instance details Defined in Cardano.Ledger.Plutus.Language Methods showsPrec ∷ Int → PlutusArgs 'PlutusV1 → ShowS # show ∷ PlutusArgs 'PlutusV1 → String # showList ∷ [PlutusArgs 'PlutusV1] → ShowS #
Show (PlutusArgs 'PlutusV2) Source #
Instance details Defined in Cardano.Ledger.Plutus.Language Methods showsPrec ∷ Int → PlutusArgs 'PlutusV2 → ShowS # show ∷ PlutusArgs 'PlutusV2 → String # showList ∷ [PlutusArgs 'PlutusV2] → ShowS #
Show (PlutusArgs 'PlutusV3) Source #
Instance details Defined in Cardano.Ledger.Plutus.Language Methods showsPrec ∷ Int → PlutusArgs 'PlutusV3 → ShowS # show ∷ PlutusArgs 'PlutusV3 → String # showList ∷ [PlutusArgs 'PlutusV3] → ShowS #
Show (PlutusArgs 'PlutusV4) Source #
Instance details Defined in Cardano.Ledger.Plutus.Language Methods showsPrec ∷ Int → PlutusArgs 'PlutusV4 → ShowS # show ∷ PlutusArgs 'PlutusV4 → String # showList ∷ [PlutusArgs 'PlutusV4] → ShowS #
Eq (PlutusArgs 'PlutusV1) Source #
Instance details Defined in Cardano.Ledger.Plutus.Language Methods (==) ∷ PlutusArgs 'PlutusV1 → PlutusArgs 'PlutusV1 → Bool # (/=) ∷ PlutusArgs 'PlutusV1 → PlutusArgs 'PlutusV1 → Bool #
Eq (PlutusArgs 'PlutusV2) Source #
Instance details Defined in Cardano.Ledger.Plutus.Language Methods (==) ∷ PlutusArgs 'PlutusV2 → PlutusArgs 'PlutusV2 → Bool # (/=) ∷ PlutusArgs 'PlutusV2 → PlutusArgs 'PlutusV2 → Bool #
Eq (PlutusArgs 'PlutusV3) Source #
Instance details Defined in Cardano.Ledger.Plutus.Language Methods (==) ∷ PlutusArgs 'PlutusV3 → PlutusArgs 'PlutusV3 → Bool # (/=) ∷ PlutusArgs 'PlutusV3 → PlutusArgs 'PlutusV3 → Bool #
Eq (PlutusArgs 'PlutusV4) Source #
Instance details Defined in Cardano.Ledger.Plutus.Language Methods (==) ∷ PlutusArgs 'PlutusV4 → PlutusArgs 'PlutusV4 → Bool # (/=) ∷ PlutusArgs 'PlutusV4 → PlutusArgs 'PlutusV4 → Bool #
Pretty (PlutusArgs 'PlutusV1) Source #
Instance details Defined in Cardano.Ledger.Plutus.Language Methods pretty ∷ PlutusArgs 'PlutusV1 → Doc ann Source # prettyList ∷ [PlutusArgs 'PlutusV1] → Doc ann Source #
Pretty (PlutusArgs 'PlutusV2) Source #
Instance details Defined in Cardano.Ledger.Plutus.Language Methods pretty ∷ PlutusArgs 'PlutusV2 → Doc ann Source # prettyList ∷ [PlutusArgs 'PlutusV2] → Doc ann Source #
Pretty (PlutusArgs 'PlutusV3) Source #
Instance details Defined in Cardano.Ledger.Plutus.Language Methods pretty ∷ PlutusArgs 'PlutusV3 → Doc ann Source # prettyList ∷ [PlutusArgs 'PlutusV3] → Doc ann Source #
Pretty (PlutusArgs 'PlutusV4) Source #
Instance details Defined in Cardano.Ledger.Plutus.Language Methods pretty ∷ PlutusArgs 'PlutusV4 → Doc ann Source # prettyList ∷ [PlutusArgs 'PlutusV4] → Doc ann Source #
newtype PlutusArgs 'PlutusV1 Source #
Instance details Defined in Cardano.Ledger.Plutus.Language newtype PlutusArgs 'PlutusV1 = PlutusV1Args { unPlutusV1Args ∷ LegacyPlutusArgs 'PlutusV1 }
newtype PlutusArgs 'PlutusV2 Source #
Instance details Defined in Cardano.Ledger.Plutus.Language newtype PlutusArgs 'PlutusV2 = PlutusV2Args { unPlutusV2Args ∷ LegacyPlutusArgs 'PlutusV2 }
newtype PlutusArgs 'PlutusV3 Source #
Instance details Defined in Cardano.Ledger.Plutus.Language newtype PlutusArgs 'PlutusV3 = PlutusV3Args { unPlutusV3Args ∷ ScriptContext }
newtype PlutusArgs 'PlutusV4 Source #
Instance details Defined in Cardano.Ledger.Plutus.Language newtype PlutusArgs 'PlutusV4 = PlutusV4Args { unPlutusV4Args ∷ ScriptContext }

plutusLanguage ∷ ∀ (l ∷ Language) proxy. PlutusLanguage l ⇒ proxy l → Language Source #

Construct value level laguage version from the type level

plutusSLanguage ∷ ∀ (l ∷ Language) proxy. PlutusLanguage l ⇒ proxy l → SLanguage l Source #

toSLanguage ∷ ∀ (l ∷ Language) m. (PlutusLanguage l, MonadFail m) ⇒ Language → m (SLanguage l) Source #

withSLanguage ∷ Language → (∀ (l ∷ Language). PlutusLanguage l ⇒ SLanguage l → a) → a Source #

asSLanguage ∷ ∀ (l ∷ Language) proxy. SLanguage l → proxy l → proxy l Source #

withSamePlutusLanguage ∷ ∀ f1 f2 (l1 ∷ Language) (l2 ∷ Language) a. (PlutusLanguage l1, PlutusLanguage l2) ⇒ f1 l1 → f2 l2 → (∀ (l ∷ Language). PlutusLanguage l ⇒ f1 l → f2 l → a) → Maybe a Source #

Plutus Script Context

data LegacyPlutusArgs (l ∷ Language) Source #

Constructors

LegacyPlutusArgs2	Scripts that require 2 arguments.
Fields !Data Redeemer !(PlutusScriptContext l) PlutusScriptContext
LegacyPlutusArgs3	Scripts that require 3 arguments. Which is only PlutusV1/V2 spending scripts
Fields !Data Mandatory Spending Datum !Data Redeemer !(PlutusScriptContext l) PlutusScriptContext

Instances

Instances details

(PlutusLanguage l, FromData (PlutusScriptContext l)) ⇒ DecCBOR (LegacyPlutusArgs l) Source #
Instance details Defined in Cardano.Ledger.Plutus.Language Methods decCBOR ∷ Decoder s (LegacyPlutusArgs l) Source # dropCBOR ∷ Proxy (LegacyPlutusArgs l) → Decoder s () Source # label ∷ Proxy (LegacyPlutusArgs l) → Text Source #
ToData (PlutusScriptContext l) ⇒ EncCBOR (LegacyPlutusArgs l) Source #
Instance details Defined in Cardano.Ledger.Plutus.Language Methods encCBOR ∷ LegacyPlutusArgs l → Encoding Source #
NFData (PlutusScriptContext l) ⇒ NFData (LegacyPlutusArgs l) Source #
Instance details Defined in Cardano.Ledger.Plutus.Language Methods rnf ∷ LegacyPlutusArgs l → () #
Show (PlutusScriptContext l) ⇒ Show (LegacyPlutusArgs l) Source #
Instance details Defined in Cardano.Ledger.Plutus.Language Methods showsPrec ∷ Int → LegacyPlutusArgs l → ShowS # show ∷ LegacyPlutusArgs l → String # showList ∷ [LegacyPlutusArgs l] → ShowS #
Eq (PlutusScriptContext l) ⇒ Eq (LegacyPlutusArgs l) Source #
Instance details Defined in Cardano.Ledger.Plutus.Language Methods (==) ∷ LegacyPlutusArgs l → LegacyPlutusArgs l → Bool # (/=) ∷ LegacyPlutusArgs l → LegacyPlutusArgs l → Bool #
Pretty (PlutusScriptContext l) ⇒ Pretty (LegacyPlutusArgs l) Source #
Instance details Defined in Cardano.Ledger.Plutus.Language Methods pretty ∷ LegacyPlutusArgs l → Doc ann Source # prettyList ∷ [LegacyPlutusArgs l] → Doc ann Source #

type family PlutusScriptContext (l ∷ Language) = (r ∷ Type) | r → l where ... Source #

Equations

PlutusScriptContext 'PlutusV1 = ScriptContext
PlutusScriptContext 'PlutusV2 = ScriptContext
PlutusScriptContext 'PlutusV3 = ScriptContext

Orphan instances

NFData ScriptContext Source #
Instance details Methods rnf ∷ ScriptContext → () #
NFData ScriptContext Source #
Instance details Methods rnf ∷ ScriptContext → () #
NFData ScriptContext Source #
Instance details Methods rnf ∷ ScriptContext → () #