Safe Haskell	Safe-Inferred
Language	Haskell2010

PlutusCore.Evaluation.Error

Description

The exceptions that an abstract machine can throw.

Synopsis

data EvaluationError structural operational
- = StructuralEvaluationError !structural
- | OperationalEvaluationError !operational
class AsEvaluationError r structural operational | r → structural operational where
- _EvaluationError ∷ Prism' r (EvaluationError structural operational)
- _StructuralEvaluationError ∷ Prism' r structural
- _OperationalEvaluationError ∷ Prism' r operational

Documentation

data EvaluationError structural operational Source #

The type of errors that can occur during evaluation. There are two kinds of errors:

Structural ones -- these are errors that are indicative of the _structure_ of the program being wrong. For example, a free variable was encountered during evaluation, a non-function was applied to an argument or tailList was applied to a non-list.
Operational ones -- these are errors that are indicative of the _logic_ of the program being wrong. For example, error was executed, tailList was applied to an empty list or evaluation ran out of gas.

On the chain both of these are just regular failures and we don't distinguish between them there: if a script fails, it fails, it doesn't matter what the reason was. However in the tests it does matter why the failure occurred: a structural error may indicate that the test was written incorrectly while an operational error may be entirely expected.

In other words, structural errors are "runtime type errors" and operational errors are regular runtime errors. Which means that evaluating an (erased) well-typed program should never produce a structural error, only an operational one. This creates a sort of "runtime type system" for UPLC and it would be great to stick to it and enforce in tests etc, but we currently don't.

Constructors

StructuralEvaluationError !structural
OperationalEvaluationError !operational

Instances

Instances details

Bifoldable EvaluationError Source #
Instance details Defined in PlutusCore.Evaluation.Error Methods bifold ∷ Monoid m ⇒ EvaluationError m m → m Source # bifoldMap ∷ Monoid m ⇒ (a → m) → (b → m) → EvaluationError a b → m Source # bifoldr ∷ (a → c → c) → (b → c → c) → c → EvaluationError a b → c Source # bifoldl ∷ (c → a → c) → (c → b → c) → c → EvaluationError a b → c Source #
Bifunctor EvaluationError Source #
Instance details Defined in PlutusCore.Evaluation.Error Methods bimap ∷ (a → b) → (c → d) → EvaluationError a c → EvaluationError b d Source # first ∷ (a → b) → EvaluationError a c → EvaluationError b c Source # second ∷ (b → c) → EvaluationError a b → EvaluationError a c Source #
Bitraversable EvaluationError Source #
Instance details Defined in PlutusCore.Evaluation.Error Methods bitraverse ∷ Applicative f ⇒ (a → f c) → (b → f d) → EvaluationError a b → f (EvaluationError c d) Source #
(HasPrettyDefaults config ~ 'True, PrettyBy config structural, Pretty operational) ⇒ PrettyBy config (EvaluationError structural operational) Source #
Instance details Defined in PlutusCore.Evaluation.Error Methods prettyBy ∷ config → EvaluationError structural operational → Doc ann Source # prettyListBy ∷ config → [EvaluationError structural operational] → Doc ann Source #
Functor (EvaluationError structural) Source #
Instance details Defined in PlutusCore.Evaluation.Error Methods fmap ∷ (a → b) → EvaluationError structural a → EvaluationError structural b Source # (<$) ∷ a → EvaluationError structural b → EvaluationError structural a Source #
Generic (EvaluationError structural operational) Source #
Instance details Defined in PlutusCore.Evaluation.Error Associated Types type Rep (EvaluationError structural operational) ∷ Type → Type Source # Methods from ∷ EvaluationError structural operational → Rep (EvaluationError structural operational) x Source # to ∷ Rep (EvaluationError structural operational) x → EvaluationError structural operational Source #
(Show structural, Show operational) ⇒ Show (EvaluationError structural operational) Source #
Instance details Defined in PlutusCore.Evaluation.Error Methods showsPrec ∷ Int → EvaluationError structural operational → ShowS Source # show ∷ EvaluationError structural operational → String Source # showList ∷ [EvaluationError structural operational] → ShowS Source #
(NFData structural, NFData operational) ⇒ NFData (EvaluationError structural operational) Source #
Instance details Defined in PlutusCore.Evaluation.Error Methods rnf ∷ EvaluationError structural operational → () Source #
(Eq structural, Eq operational) ⇒ Eq (EvaluationError structural operational) Source #
Instance details Defined in PlutusCore.Evaluation.Error Methods (==) ∷ EvaluationError structural operational → EvaluationError structural operational → Bool Source # (/=) ∷ EvaluationError structural operational → EvaluationError structural operational → Bool Source #
(AsUnliftingError structural, AsUnliftingError operational) ⇒ AsUnliftingEvaluationError (EvaluationError structural operational) Source #	An `UnliftingEvaluationError` is an `EvaluationError`, hence for this instance we only require both `operational` and `structural` to have `_UnliftingError` prisms, so that we can handle both the cases pointwisely.
Instance details Defined in PlutusCore.Builtin.Result Methods _UnliftingEvaluationError ∷ Prism' (EvaluationError structural operational) UnliftingEvaluationError Source # _MkUnliftingEvaluationError ∷ Prism' (EvaluationError structural operational) (EvaluationError UnliftingError UnliftingError) Source #
AsEvaluationFailure operational ⇒ AsEvaluationFailure (EvaluationError structural operational) Source #	A raw evaluation failure is always an operational error.
Instance details Defined in PlutusCore.Evaluation.Error Methods _EvaluationFailure ∷ Prism' (EvaluationError structural operational) () Source #
(Pretty structural, Pretty operational) ⇒ Pretty (EvaluationError structural operational) Source #
Instance details Defined in PlutusCore.Evaluation.Error Methods pretty ∷ EvaluationError structural operational → Doc ann Source # prettyList ∷ [EvaluationError structural operational] → Doc ann Source #
structural ~ MachineError fun ⇒ AsMachineError (EvaluationError structural operational) fun Source #
Instance details Defined in PlutusCore.Evaluation.Machine.Exception Methods _MachineError ∷ Prism' (EvaluationError structural operational) (MachineError fun) Source # _NonPolymorphicInstantiationMachineError ∷ Prism' (EvaluationError structural operational) () Source # _NonWrapUnwrappedMachineError ∷ Prism' (EvaluationError structural operational) () Source # _NonFunctionalApplicationMachineError ∷ Prism' (EvaluationError structural operational) () Source # _OpenTermEvaluatedMachineError ∷ Prism' (EvaluationError structural operational) () Source # _UnliftingMachineError ∷ Prism' (EvaluationError structural operational) UnliftingError Source # _BuiltinTermArgumentExpectedMachineError ∷ Prism' (EvaluationError structural operational) () Source # _UnexpectedBuiltinTermArgumentMachineError ∷ Prism' (EvaluationError structural operational) () Source # _NonConstrScrutinized ∷ Prism' (EvaluationError structural operational) () Source # _MissingCaseBranch ∷ Prism' (EvaluationError structural operational) Word64 Source #
AsEvaluationError (EvaluationError structural operational) structural operational Source #
Instance details Defined in PlutusCore.Evaluation.Error Methods _EvaluationError ∷ Prism' (EvaluationError structural operational) (EvaluationError structural operational) Source # _StructuralEvaluationError ∷ Prism' (EvaluationError structural operational) structural Source # _OperationalEvaluationError ∷ Prism' (EvaluationError structural operational) operational Source #
ThrowableBuiltins uni fun ⇒ MonadError (CekEvaluationException NamedDeBruijn uni fun) (CekM uni fun s) Source #
Instance details Defined in UntypedPlutusCore.Evaluation.Machine.Cek.Internal Methods throwError ∷ CekEvaluationException NamedDeBruijn uni fun → CekM uni fun s a Source # catchError ∷ CekM uni fun s a → (CekEvaluationException NamedDeBruijn uni fun → CekM uni fun s a) → CekM uni fun s a Source #
type Rep (EvaluationError structural operational) Source #
Instance details Defined in PlutusCore.Evaluation.Error type Rep (EvaluationError structural operational) = D1 ('MetaData "EvaluationError" "PlutusCore.Evaluation.Error" "plutus-core-1.34.0.0-inplace" 'False) (C1 ('MetaCons "StructuralEvaluationError" 'PrefixI 'False) (S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 structural)) :+: C1 ('MetaCons "OperationalEvaluationError" 'PrefixI 'False) (S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 operational)))

class AsEvaluationError r structural operational | r → structural operational where Source #

Minimal complete definition

_EvaluationError

Methods

_EvaluationError ∷ Prism' r (EvaluationError structural operational) Source #

_StructuralEvaluationError ∷ Prism' r structural Source #

_OperationalEvaluationError ∷ Prism' r operational Source #

Instances

Instances details

AsEvaluationError UnliftingEvaluationError UnliftingError UnliftingError Source #
Instance details Defined in PlutusCore.Builtin.Result Methods _EvaluationError ∷ Prism' UnliftingEvaluationError (EvaluationError UnliftingError UnliftingError) Source # _StructuralEvaluationError ∷ Prism' UnliftingEvaluationError UnliftingError Source # _OperationalEvaluationError ∷ Prism' UnliftingEvaluationError UnliftingError Source #
AsEvaluationError (EvaluationError structural operational) structural operational Source #
Instance details Defined in PlutusCore.Evaluation.Error Methods _EvaluationError ∷ Prism' (EvaluationError structural operational) (EvaluationError structural operational) Source # _StructuralEvaluationError ∷ Prism' (EvaluationError structural operational) structural Source # _OperationalEvaluationError ∷ Prism' (EvaluationError structural operational) operational Source #