Safe Haskell	Safe-Inferred
Language	Haskell2010

Cardano.Ledger.Plutus.Evaluate

Synopsis

data PlutusWithContext c where
- PlutusWithContext ∷ PlutusLanguage l ⇒ {..} → PlutusWithContext c
data ScriptFailure c = ScriptFailure {
- scriptFailureMessage ∷ Text
- scriptFailurePlutus ∷ PlutusWithContext c
}
data ScriptResult c
- = Passes [PlutusWithContext c]
- | Fails [PlutusWithContext c] (NonEmpty (ScriptFailure c))
scriptPass ∷ PlutusWithContext c → ScriptResult c
scriptFail ∷ ScriptFailure c → ScriptResult c
newtype PlutusDatums = PlutusDatums {
- unPlutusDatums ∷ [Data]
}
data PlutusDebugInfo c
- = DebugBadHex String
- | DebugCannotDecode String
- | DebugSuccess [Text] ExBudget
- | DebugFailure [Text] EvaluationError (PlutusWithContext c)
debugPlutus ∷ Crypto c ⇒ String → PlutusDebugInfo c
runPlutusScript ∷ PlutusWithContext c → ScriptResult c
runPlutusScriptWithLogs ∷ PlutusWithContext c → ([Text], ScriptResult c)
evaluatePlutusWithContext ∷ VerboseMode → PlutusWithContext c → ([Text], Either EvaluationError ExBudget)
explainPlutusEvaluationError ∷ PlutusWithContext c → EvaluationError → ScriptResult c

Documentation

data PlutusWithContext c where Source #

This type contains all that is necessary from Ledger to evaluate a plutus script.

Constructors

PlutusWithContext

Fields

∷ PlutusLanguage l
⇒ { pwcProtocolVersion ∷ !Version
Mayjor protocol version that is necessary for [de]serialization
, pwcScript ∷ !(Either (Plutus l) (PlutusRunnable l))
Actual plutus script that will be evaluated. Script is allowed to be in two forms: serialized and deserialized. This is necesary for implementing the opptimization that preserves deserialized PlutusRunnable after verifying wellformedness of plutus scripts during transaction validation (yet to be implemented).
, pwcScriptHash ∷ !(ScriptHash c)
, pwcDatums ∷ !PlutusDatums
All of the arguments to the Plutus scripts, including the redeemer and the Plutus context that was obtained from the transaction translation
, pwcExUnits ∷ !ExUnits
Limit on the execution units
, pwcCostModel ∷ !CostModel
CostModel to be used during script evaluation. It must match the language version in the pwcScript
} → PlutusWithContext c

Instances

Instances details

Show (PlutusWithContext c) Source #
Instance details Defined in Cardano.Ledger.Plutus.Evaluate Methods showsPrec ∷ Int → PlutusWithContext c → ShowS Source # show ∷ PlutusWithContext c → String Source # showList ∷ [PlutusWithContext c] → ShowS Source #
Crypto c ⇒ FromCBOR (PlutusWithContext c) Source #
Instance details Defined in Cardano.Ledger.Plutus.Evaluate Methods fromCBOR ∷ Decoder s (PlutusWithContext c) Source # label ∷ Proxy (PlutusWithContext c) → Text Source #
Crypto c ⇒ ToCBOR (PlutusWithContext c) Source #
Instance details Defined in Cardano.Ledger.Plutus.Evaluate Methods toCBOR ∷ PlutusWithContext c → Encoding Source # encodedSizeExpr ∷ (∀ t. ToCBOR t ⇒ Proxy t → Size) → Proxy (PlutusWithContext c) → Size Source # encodedListSizeExpr ∷ (∀ t. ToCBOR t ⇒ Proxy t → Size) → Proxy [PlutusWithContext c] → Size Source #
NFData (PlutusWithContext c) Source #
Instance details Defined in Cardano.Ledger.Plutus.Evaluate Methods rnf ∷ PlutusWithContext c → () Source #
Eq (PlutusWithContext c) Source #
Instance details Defined in Cardano.Ledger.Plutus.Evaluate Methods (==) ∷ PlutusWithContext c → PlutusWithContext c → Bool Source # (/=) ∷ PlutusWithContext c → PlutusWithContext c → Bool Source #

data ScriptFailure c Source #

Constructors

ScriptFailure
Fields scriptFailureMessage ∷ Text scriptFailurePlutus ∷ PlutusWithContext c

Instances

Instances details

Generic (ScriptFailure c) Source #
Instance details Defined in Cardano.Ledger.Plutus.Evaluate Associated Types type Rep (ScriptFailure c) ∷ Type → Type Source # Methods from ∷ ScriptFailure c → Rep (ScriptFailure c) x Source # to ∷ Rep (ScriptFailure c) x → ScriptFailure c Source #
Show (ScriptFailure c) Source #
Instance details Defined in Cardano.Ledger.Plutus.Evaluate Methods showsPrec ∷ Int → ScriptFailure c → ShowS Source # show ∷ ScriptFailure c → String Source # showList ∷ [ScriptFailure c] → ShowS Source #
type Rep (ScriptFailure c) Source #
Instance details Defined in Cardano.Ledger.Plutus.Evaluate type Rep (ScriptFailure c) = D1 ('MetaData "ScriptFailure" "Cardano.Ledger.Plutus.Evaluate" "cardano-ledger-core-1.12.0.0-inplace" 'False) (C1 ('MetaCons "ScriptFailure" 'PrefixI 'True) (S1 ('MetaSel ('Just "scriptFailureMessage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: S1 ('MetaSel ('Just "scriptFailurePlutus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (PlutusWithContext c))))

data ScriptResult c Source #

Constructors

Passes [PlutusWithContext c]
Fails [PlutusWithContext c] (NonEmpty (ScriptFailure c))

Instances

Instances details

Monoid (ScriptResult c) Source #
Instance details Defined in Cardano.Ledger.Plutus.Evaluate Methods mempty ∷ ScriptResult c Source # mappend ∷ ScriptResult c → ScriptResult c → ScriptResult c Source # mconcat ∷ [ScriptResult c] → ScriptResult c Source #
Semigroup (ScriptResult c) Source #
Instance details Defined in Cardano.Ledger.Plutus.Evaluate Methods (<>) ∷ ScriptResult c → ScriptResult c → ScriptResult c Source # sconcat ∷ NonEmpty (ScriptResult c) → ScriptResult c Source # stimes ∷ Integral b ⇒ b → ScriptResult c → ScriptResult c Source #
Generic (ScriptResult c) Source #
Instance details Defined in Cardano.Ledger.Plutus.Evaluate Associated Types type Rep (ScriptResult c) ∷ Type → Type Source # Methods from ∷ ScriptResult c → Rep (ScriptResult c) x Source # to ∷ Rep (ScriptResult c) x → ScriptResult c Source #
type Rep (ScriptResult c) Source #
Instance details Defined in Cardano.Ledger.Plutus.Evaluate type Rep (ScriptResult c) = D1 ('MetaData "ScriptResult" "Cardano.Ledger.Plutus.Evaluate" "cardano-ledger-core-1.12.0.0-inplace" 'False) (C1 ('MetaCons "Passes" 'PrefixI 'False) (S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [PlutusWithContext c])) :+: C1 ('MetaCons "Fails" 'PrefixI 'False) (S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [PlutusWithContext c]) :*: S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (NonEmpty (ScriptFailure c)))))

scriptPass ∷ PlutusWithContext c → ScriptResult c Source #

scriptFail ∷ ScriptFailure c → ScriptResult c Source #

newtype PlutusDatums Source #

Constructors

PlutusDatums
Fields unPlutusDatums ∷ [Data]

Instances

Instances details

Generic PlutusDatums Source #
Instance details Defined in Cardano.Ledger.Plutus.Evaluate Associated Types type Rep PlutusDatums ∷ Type → Type Source # Methods from ∷ PlutusDatums → Rep PlutusDatums x Source # to ∷ Rep PlutusDatums x → PlutusDatums Source #
Show PlutusDatums Source #
Instance details Defined in Cardano.Ledger.Plutus.Evaluate Methods showsPrec ∷ Int → PlutusDatums → ShowS Source # show ∷ PlutusDatums → String Source # showList ∷ [PlutusDatums] → ShowS Source #
DecCBOR PlutusDatums Source #
Instance details Defined in Cardano.Ledger.Plutus.Evaluate Methods decCBOR ∷ Decoder s PlutusDatums Source # dropCBOR ∷ Proxy PlutusDatums → Decoder s () Source # label ∷ Proxy PlutusDatums → Text Source #
EncCBOR PlutusDatums Source #
Instance details Defined in Cardano.Ledger.Plutus.Evaluate Methods encCBOR ∷ PlutusDatums → Encoding Source # encodedSizeExpr ∷ (∀ t. EncCBOR t ⇒ Proxy t → Size) → Proxy PlutusDatums → Size Source # encodedListSizeExpr ∷ (∀ t. EncCBOR t ⇒ Proxy t → Size) → Proxy [PlutusDatums] → Size Source #
NFData PlutusDatums Source #
Instance details Defined in Cardano.Ledger.Plutus.Evaluate Methods rnf ∷ PlutusDatums → () Source #
Eq PlutusDatums Source #
Instance details Defined in Cardano.Ledger.Plutus.Evaluate Methods (==) ∷ PlutusDatums → PlutusDatums → Bool Source # (/=) ∷ PlutusDatums → PlutusDatums → Bool Source #
type Rep PlutusDatums Source #
Instance details Defined in Cardano.Ledger.Plutus.Evaluate type Rep PlutusDatums = D1 ('MetaData "PlutusDatums" "Cardano.Ledger.Plutus.Evaluate" "cardano-ledger-core-1.12.0.0-inplace" 'True) (C1 ('MetaCons "PlutusDatums" 'PrefixI 'True) (S1 ('MetaSel ('Just "unPlutusDatums") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [Data])))

data PlutusDebugInfo c Source #

Constructors

DebugBadHex String
DebugCannotDecode String
DebugSuccess [Text] ExBudget
DebugFailure [Text] EvaluationError (PlutusWithContext c)

Instances

Instances details

Show (PlutusDebugInfo c) Source #
Instance details Defined in Cardano.Ledger.Plutus.Evaluate Methods showsPrec ∷ Int → PlutusDebugInfo c → ShowS Source # show ∷ PlutusDebugInfo c → String Source # showList ∷ [PlutusDebugInfo c] → ShowS Source #

debugPlutus ∷ Crypto c ⇒ String → PlutusDebugInfo c Source #

runPlutusScript ∷ PlutusWithContext c → ScriptResult c Source #

runPlutusScriptWithLogs ∷ PlutusWithContext c → ([Text], ScriptResult c) Source #

evaluatePlutusWithContext ∷ VerboseMode → PlutusWithContext c → ([Text], Either EvaluationError ExBudget) Source #

explainPlutusEvaluationError ∷ PlutusWithContext c → EvaluationError → ScriptResult c Source #

Explain why a script might fail. Scripts come in two flavors:

with 3 data arguments [data,redeemer,context]
with 2 data arguments [redeemer,context].

It pays to decode the context data into a real context because that provides way more information. But there is no guarantee the context data really can be decoded.