| Safe Haskell | Safe-Inferred |
|---|---|
| Language | Haskell2010 |
Cardano.Ledger.Plutus.Language
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 {}
- isValidPlutus ∷ PlutusLanguage l ⇒ Version → Plutus l → Bool
- newtype PlutusBinary = PlutusBinary {}
- newtype PlutusRunnable (l ∷ Language) = PlutusRunnable {}
- plutusFromRunnable ∷ PlutusRunnable l → Plutus l
- decodeWithPlutus ∷ (∀ si l. PlutusLanguage l ⇒ Plutus l → Decoder si a) → Decoder so a
- hashPlutusScript ∷ (PlutusLanguage l, Crypto c) ⇒ Plutus l → ScriptHash c
- data Language
- mkLanguageEnum ∷ Int → Maybe Language
- languageToText ∷ Language → Text
- languageFromText ∷ MonadFail m ⇒ Text → m Language
- nonNativeLanguages ∷ [Language]
- guardPlutus ∷ Language → Decoder s ()
- data SLanguage (l ∷ Language) where
- class Typeable l ⇒ PlutusLanguage (l ∷ Language) where
- isLanguage ∷ SLanguage l
- plutusLanguageTag ∷ Plutus l → Word8
- decodePlutusRunnable ∷ Version → Plutus l → Either ScriptDecodeError (PlutusRunnable l)
- evaluatePlutusRunnable ∷ Version → VerboseMode → EvaluationContext → ExBudget → PlutusRunnable l → [Data] → (LogOutput, Either EvaluationError ExBudget)
- evaluatePlutusRunnableBudget ∷ Version → VerboseMode → EvaluationContext → PlutusRunnable l → [Data] → (LogOutput, Either EvaluationError ExBudget)
- plutusLanguage ∷ ∀ l proxy. PlutusLanguage l ⇒ proxy l → Language
- plutusSLanguage ∷ PlutusLanguage l ⇒ proxy l → SLanguage l
- fromSLanguage ∷ PlutusLanguage l ⇒ SLanguage l → Language
- toSLanguage ∷ ∀ l m. (PlutusLanguage l, MonadFail m) ⇒ Language → m (SLanguage l)
- withSLanguage ∷ Language → (∀ l. PlutusLanguage l ⇒ SLanguage l → a) → a
- asSLanguage ∷ SLanguage l → proxy l → proxy l
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 | |
Instances
| Generic (Plutus l) Source # | |
| Show (Plutus l) Source # | |
| PlutusLanguage l ⇒ DecCBOR (Plutus l) Source # | |
| PlutusLanguage l ⇒ EncCBOR (Plutus l) Source # | |
| SafeToHash (Plutus l) Source # | |
Defined in Cardano.Ledger.Plutus.Language Methods originalBytes ∷ Plutus l → ByteString Source # originalBytesSize ∷ Plutus l → Int Source # makeHashWithExplicitProxys ∷ HashAlgorithm (HASH c) ⇒ Proxy c → Proxy index → Plutus l → SafeHash c index Source # | |
| NFData (Plutus l) Source # | |
Defined in Cardano.Ledger.Plutus.Language | |
| Eq (Plutus l) Source # | |
| Ord (Plutus l) Source # | |
Defined in Cardano.Ledger.Plutus.Language | |
| NoThunks (Plutus l) Source # | |
| type Rep (Plutus l) Source # | |
Defined in Cardano.Ledger.Plutus.Language type Rep (Plutus l) = D1 ('MetaData "Plutus" "Cardano.Ledger.Plutus.Language" "cardano-ledger-core-1.12.0.0-inplace" 'True) (C1 ('MetaCons "Plutus" 'PrefixI 'True) (S1 ('MetaSel ('Just "plutusBinary") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 PlutusBinary))) | |
isValidPlutus ∷ 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 | |
Instances
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 | |
Instances
plutusFromRunnable ∷ PlutusRunnable l → Plutus l Source #
Serialize the runnable version of the plutus script
decodePlutusRunnable majVer (plutusFromRunnable pr) == Right pr
decodeWithPlutus ∷ (∀ si l. 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 ∷ (PlutusLanguage l, Crypto c) ⇒ Plutus l → ScriptHash c 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
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.
Instances
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 |
class Typeable l ⇒ PlutusLanguage (l ∷ Language) where Source #
For implicit reflection on 'SLanguage'
See Cardano.Ledger.Alonzo.Plutus.TxInfo for example usage
Methods
isLanguage ∷ SLanguage l Source #
plutusLanguageTag ∷ Plutus l → Word8 Source #
Tag that will be used as a prefix to compute the ScriptHash
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 |
| → [Data] | 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 |
| → [Data] | 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.
Instances
plutusLanguage ∷ ∀ l proxy. PlutusLanguage l ⇒ proxy l → Language Source #
Construct value level laguage version from the type level
plutusSLanguage ∷ PlutusLanguage l ⇒ proxy l → SLanguage l Source #
fromSLanguage ∷ PlutusLanguage l ⇒ SLanguage l → Language Source #
Deprecated: In favor of plutusLanguage
Reflection for 'SLanguage'
toSLanguage ∷ ∀ l m. (PlutusLanguage l, MonadFail m) ⇒ Language → m (SLanguage l) Source #
withSLanguage ∷ Language → (∀ l. PlutusLanguage l ⇒ SLanguage l → a) → a Source #
asSLanguage ∷ SLanguage l → proxy l → proxy l Source #