Safe Haskell	Safe-Inferred
Language	Haskell2010

PlutusCore.Builtin.Result

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
newtype UnliftingError = MkUnliftingError {
- unUnliftingError ∷ Text
}
newtype UnliftingEvaluationError = MkUnliftingEvaluationError {
- unUnliftingEvaluationError ∷ EvaluationError UnliftingError UnliftingError
}
data BuiltinError
- = BuiltinUnliftingEvaluationError UnliftingEvaluationError
- | BuiltinEvaluationFailure
data BuiltinResult a
- = BuiltinSuccess a
- | BuiltinSuccessWithLogs (DList Text) a
- | BuiltinFailure (DList Text) BuiltinError
class AsUnliftingEvaluationError r where
- _UnliftingEvaluationError ∷ Prism' r UnliftingEvaluationError
- _MkUnliftingEvaluationError ∷ Prism' r (EvaluationError UnliftingError UnliftingError)
class AsUnliftingError r where
- _UnliftingError ∷ Prism' r UnliftingError
- _MkUnliftingError ∷ Prism' r Text
class AsBuiltinError r where
- _BuiltinError ∷ Prism' r BuiltinError
- _BuiltinUnliftingEvaluationError ∷ Prism' r UnliftingEvaluationError
- _BuiltinEvaluationFailure ∷ Prism' r ()
class AsBuiltinResult r a | r → a where
- _BuiltinResult ∷ Prism' r (BuiltinResult a)
- _BuiltinSuccess ∷ Prism' r a
- _BuiltinSuccessWithLogs ∷ Prism' r (DList Text, a)
- _BuiltinFailure ∷ Prism' r (DList Text, BuiltinError)
_UnliftingErrorVia ∷ Pretty err ⇒ err → Prism' err UnliftingError
_StructuralUnliftingError ∷ AsBuiltinError err ⇒ Prism' err UnliftingError
_OperationalUnliftingError ∷ AsBuiltinError err ⇒ Prism' err UnliftingError
throwNotAConstant ∷ MonadError BuiltinError m ⇒ m void
throwUnderTypeError ∷ MonadError BuiltinError m ⇒ m void
emit ∷ Text → BuiltinResult ()
withLogs ∷ DList Text → BuiltinResult a → BuiltinResult a
throwing ∷ MonadError e m ⇒ AReview e t → t → m x
throwing_ ∷ MonadError e m ⇒ AReview e () → m x

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 `structural` and `operational` 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 # _NonConstrScrutinizedMachineError ∷ Prism' (EvaluationError structural operational) () Source # _MissingCaseBranchMachineError ∷ Prism' (EvaluationError structural operational) Word64 Source # _PanicMachineError ∷ Prism' (EvaluationError structural operational) String 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.46.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 #

newtype UnliftingError Source #

The error message part of an UnliftingEvaluationError.

Constructors

MkUnliftingError
Fields unUnliftingError ∷ Text

Instances

Instances details

IsString UnliftingError Source #
Instance details Defined in PlutusCore.Builtin.Result Methods fromString ∷ String → UnliftingError Source #
Monoid UnliftingError Source #
Instance details Defined in PlutusCore.Builtin.Result Methods mempty ∷ UnliftingError Source # mappend ∷ UnliftingError → UnliftingError → UnliftingError Source # mconcat ∷ [UnliftingError] → UnliftingError Source #
Semigroup UnliftingError Source #
Instance details Defined in PlutusCore.Builtin.Result Methods (<>) ∷ UnliftingError → UnliftingError → UnliftingError Source # sconcat ∷ NonEmpty UnliftingError → UnliftingError Source # stimes ∷ Integral b ⇒ b → UnliftingError → UnliftingError Source #
Show UnliftingError Source #
Instance details Defined in PlutusCore.Builtin.Result Methods showsPrec ∷ Int → UnliftingError → ShowS Source # show ∷ UnliftingError → String Source # showList ∷ [UnliftingError] → ShowS Source #
NFData UnliftingError Source #
Instance details Defined in PlutusCore.Builtin.Result Methods rnf ∷ UnliftingError → () Source #
Eq UnliftingError Source #
Instance details Defined in PlutusCore.Builtin.Result Methods (==) ∷ UnliftingError → UnliftingError → Bool Source # (/=) ∷ UnliftingError → UnliftingError → Bool Source #
AsUnliftingError UnliftingError Source #
Instance details Defined in PlutusCore.Builtin.Result Methods _UnliftingError ∷ Prism' UnliftingError UnliftingError Source # _MkUnliftingError ∷ Prism' UnliftingError Text Source #
Pretty UnliftingError Source #
Instance details Defined in PlutusCore.Builtin.Result Methods pretty ∷ UnliftingError → Doc ann Source # prettyList ∷ [UnliftingError] → Doc ann Source #
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 #

newtype UnliftingEvaluationError Source #

When unlifting of a PLC term into a Haskell value fails, this error is thrown.

Constructors

MkUnliftingEvaluationError
Fields unUnliftingEvaluationError ∷ EvaluationError UnliftingError UnliftingError

Instances

Instances details

Show UnliftingEvaluationError Source #
Instance details Defined in PlutusCore.Builtin.Result Methods showsPrec ∷ Int → UnliftingEvaluationError → ShowS Source # show ∷ UnliftingEvaluationError → String Source # showList ∷ [UnliftingEvaluationError] → ShowS Source #
NFData UnliftingEvaluationError Source #
Instance details Defined in PlutusCore.Builtin.Result Methods rnf ∷ UnliftingEvaluationError → () Source #
Eq UnliftingEvaluationError Source #
Instance details Defined in PlutusCore.Builtin.Result Methods (==) ∷ UnliftingEvaluationError → UnliftingEvaluationError → Bool Source # (/=) ∷ UnliftingEvaluationError → UnliftingEvaluationError → Bool Source #
AsUnliftingEvaluationError UnliftingEvaluationError Source #
Instance details Defined in PlutusCore.Builtin.Result Methods _UnliftingEvaluationError ∷ Prism' UnliftingEvaluationError UnliftingEvaluationError Source # _MkUnliftingEvaluationError ∷ Prism' UnliftingEvaluationError (EvaluationError UnliftingError UnliftingError) Source #
Pretty UnliftingEvaluationError Source #
Instance details Defined in PlutusCore.Builtin.Result Methods pretty ∷ UnliftingEvaluationError → Doc ann Source # prettyList ∷ [UnliftingEvaluationError] → Doc ann Source #
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 #

data BuiltinError Source #

The type of errors that readKnown and makeKnown can return.

Constructors

BuiltinUnliftingEvaluationError UnliftingEvaluationError
BuiltinEvaluationFailure

Instances

Instances details

Show BuiltinError Source #
Instance details Defined in PlutusCore.Builtin.Result Methods showsPrec ∷ Int → BuiltinError → ShowS Source # show ∷ BuiltinError → String Source # showList ∷ [BuiltinError] → ShowS Source #
Eq BuiltinError Source #
Instance details Defined in PlutusCore.Builtin.Result Methods (==) ∷ BuiltinError → BuiltinError → Bool Source # (/=) ∷ BuiltinError → BuiltinError → Bool Source #
AsBuiltinError BuiltinError Source #
Instance details Defined in PlutusCore.Builtin.Result Methods _BuiltinError ∷ Prism' BuiltinError BuiltinError Source # _BuiltinUnliftingEvaluationError ∷ Prism' BuiltinError UnliftingEvaluationError Source # _BuiltinEvaluationFailure ∷ Prism' BuiltinError () Source #
AsUnliftingEvaluationError BuiltinError Source #
Instance details Defined in PlutusCore.Builtin.Result Methods _UnliftingEvaluationError ∷ Prism' BuiltinError UnliftingEvaluationError Source # _MkUnliftingEvaluationError ∷ Prism' BuiltinError (EvaluationError UnliftingError UnliftingError) Source #
AsEvaluationFailure BuiltinError Source #
Instance details Defined in PlutusCore.Builtin.Result Methods _EvaluationFailure ∷ Prism' BuiltinError () Source #
Pretty BuiltinError Source #
Instance details Defined in PlutusCore.Builtin.Result Methods pretty ∷ BuiltinError → Doc ann Source # prettyList ∷ [BuiltinError] → Doc ann Source #
MonadError BuiltinError BuiltinResult Source #	`throwError` puts every operational unlifting error into the `BuiltinFailure` logs. This is to compensate for the historical lack of error message content in operational errors (structural ones don't have this problem) in our evaluators (the CK and CEK machines). It would be better to fix the underlying issue and allow operational evaluation errors to carry some form of content, but for now we just fix the symptom in order for the end user to see the error message that they are supposed to see. The fix even makes some sense: what we do here is we emulate logging when the thrown unlifting error is an operational one, i.e. this is similar to what some builtins do manually (like when a crypto builtin fails and puts info about the failure into the logs).
Instance details Defined in PlutusCore.Builtin.Result Methods throwError ∷ BuiltinError → BuiltinResult a Source # catchError ∷ BuiltinResult a → (BuiltinError → BuiltinResult a) → BuiltinResult a Source #

data BuiltinResult a Source #

The monad that makeKnown runs in. Equivalent to ExceptT BuiltinError (Writer (DList Text)), except optimized in two ways:

everything is strict
has the BuiltinSuccess constructor that is used for returning a value with no logs attached, which is the most common case for us, so it helps a lot not to construct and deconstruct a redundant tuple

Moving from ExceptT BuiltinError (Writer (DList Text)) to this data type gave us a speedup of 8% of total evaluation time.

Logs are represented as a DList, because we don't particularly care about the efficiency of logging, since there's no logging on the chain and builtins don't emit much anyway. Otherwise we'd have to use text-builder or text-builder-linear or something of this sort.

Constructors

BuiltinSuccess a
BuiltinSuccessWithLogs (DList Text) a
BuiltinFailure (DList Text) BuiltinError

Instances

Instances details

MonadFail BuiltinResult Source #
Instance details Defined in PlutusCore.Builtin.Result Methods fail ∷ String → BuiltinResult a Source #
Foldable BuiltinResult Source #
Instance details Defined in PlutusCore.Builtin.Result Methods fold ∷ Monoid m ⇒ BuiltinResult m → m Source # foldMap ∷ Monoid m ⇒ (a → m) → BuiltinResult a → m Source # foldMap' ∷ Monoid m ⇒ (a → m) → BuiltinResult a → m Source # foldr ∷ (a → b → b) → b → BuiltinResult a → b Source # foldr' ∷ (a → b → b) → b → BuiltinResult a → b Source # foldl ∷ (b → a → b) → b → BuiltinResult a → b Source # foldl' ∷ (b → a → b) → b → BuiltinResult a → b Source # foldr1 ∷ (a → a → a) → BuiltinResult a → a Source # foldl1 ∷ (a → a → a) → BuiltinResult a → a Source # toList ∷ BuiltinResult a → [a] Source # null ∷ BuiltinResult a → Bool Source # length ∷ BuiltinResult a → Int Source # elem ∷ Eq a ⇒ a → BuiltinResult a → Bool Source # maximum ∷ Ord a ⇒ BuiltinResult a → a Source # minimum ∷ Ord a ⇒ BuiltinResult a → a Source # sum ∷ Num a ⇒ BuiltinResult a → a Source # product ∷ Num a ⇒ BuiltinResult a → a Source #
Applicative BuiltinResult Source #
Instance details Defined in PlutusCore.Builtin.Result Methods pure ∷ a → BuiltinResult a Source # (<>) ∷ BuiltinResult (a → b) → BuiltinResult a → BuiltinResult b Source # liftA2 ∷ (a → b → c) → BuiltinResult a → BuiltinResult b → BuiltinResult c Source # (>) ∷ BuiltinResult a → BuiltinResult b → BuiltinResult b Source # (<*) ∷ BuiltinResult a → BuiltinResult b → BuiltinResult a Source #
Functor BuiltinResult Source #
Instance details Defined in PlutusCore.Builtin.Result Methods fmap ∷ (a → b) → BuiltinResult a → BuiltinResult b Source # (<$) ∷ a → BuiltinResult b → BuiltinResult a Source #
Monad BuiltinResult Source #
Instance details Defined in PlutusCore.Builtin.Result Methods (>>=) ∷ BuiltinResult a → (a → BuiltinResult b) → BuiltinResult b Source # (>>) ∷ BuiltinResult a → BuiltinResult b → BuiltinResult b Source # return ∷ a → BuiltinResult a Source #
MonadError BuiltinError BuiltinResult Source #	`throwError` puts every operational unlifting error into the `BuiltinFailure` logs. This is to compensate for the historical lack of error message content in operational errors (structural ones don't have this problem) in our evaluators (the CK and CEK machines). It would be better to fix the underlying issue and allow operational evaluation errors to carry some form of content, but for now we just fix the symptom in order for the end user to see the error message that they are supposed to see. The fix even makes some sense: what we do here is we emulate logging when the thrown unlifting error is an operational one, i.e. this is similar to what some builtins do manually (like when a crypto builtin fails and puts info about the failure into the logs).
Instance details Defined in PlutusCore.Builtin.Result Methods throwError ∷ BuiltinError → BuiltinResult a Source # catchError ∷ BuiltinResult a → (BuiltinError → BuiltinResult a) → BuiltinResult a Source #
KnownTypeAst tyname uni a ⇒ KnownTypeAst tyname uni (BuiltinResult a ∷ Type) Source #
Instance details Defined in PlutusCore.Builtin.KnownTypeAst Associated Types type IsBuiltin uni (BuiltinResult a) ∷ Bool Source # type ToHoles uni hole (BuiltinResult a) ∷ [Hole] Source # type ToBinds uni acc (BuiltinResult a) ∷ [Some TyNameRep] Source # Methods typeAst ∷ Type0 tyname uni () Source #
MakeKnownIn uni val a ⇒ MakeKnownIn uni val (BuiltinResult a) Source #
Instance details Defined in PlutusCore.Builtin.KnownType Methods makeKnown ∷ BuiltinResult a → BuiltinResult (HeadSpine val) Source #
(TypeError ('Text "\8216BuiltinResult\8217 cannot appear in the type of an argument") ∷ Constraint, uni ~ UniOf val) ⇒ ReadKnownIn uni val (BuiltinResult a) Source #
Instance details Defined in PlutusCore.Builtin.KnownType Methods readKnown ∷ val → ReadKnownM (BuiltinResult a) Source #
Show a ⇒ Show (BuiltinResult a) Source #
Instance details Defined in PlutusCore.Builtin.Result Methods showsPrec ∷ Int → BuiltinResult a → ShowS Source # show ∷ BuiltinResult a → String Source # showList ∷ [BuiltinResult a] → ShowS Source #
AsEvaluationFailure (BuiltinResult a) Source #
Instance details Defined in PlutusCore.Builtin.Result Methods _EvaluationFailure ∷ Prism' (BuiltinResult a) () Source #
AsBuiltinResult (BuiltinResult a) a Source #
Instance details Defined in PlutusCore.Builtin.Result Methods _BuiltinResult ∷ Prism' (BuiltinResult a) (BuiltinResult a) Source # _BuiltinSuccess ∷ Prism' (BuiltinResult a) a Source # _BuiltinSuccessWithLogs ∷ Prism' (BuiltinResult a) (DList Text, a) Source # _BuiltinFailure ∷ Prism' (BuiltinResult a) (DList Text, BuiltinError) Source #
type ToBinds uni acc (BuiltinResult a ∷ Type) Source #
Instance details Defined in PlutusCore.Builtin.KnownTypeAst type ToBinds uni acc (BuiltinResult a ∷ Type) = ToBinds uni acc a
type ToHoles uni _1 (BuiltinResult a ∷ Type) Source #
Instance details Defined in PlutusCore.Builtin.KnownTypeAst type ToHoles uni _1 (BuiltinResult a ∷ Type) = '[TypeHole a ∷ Hole]
type IsBuiltin uni (BuiltinResult a ∷ Type) Source #
Instance details Defined in PlutusCore.Builtin.KnownTypeAst type IsBuiltin uni (BuiltinResult a ∷ Type) = 'False

class AsUnliftingEvaluationError r where Source #

Minimal complete definition

_UnliftingEvaluationError

Methods

_UnliftingEvaluationError ∷ Prism' r UnliftingEvaluationError Source #

_MkUnliftingEvaluationError ∷ Prism' r (EvaluationError UnliftingError UnliftingError) Source #

Instances

Instances details

AsUnliftingEvaluationError BuiltinError Source #
Instance details Defined in PlutusCore.Builtin.Result Methods _UnliftingEvaluationError ∷ Prism' BuiltinError UnliftingEvaluationError Source # _MkUnliftingEvaluationError ∷ Prism' BuiltinError (EvaluationError UnliftingError UnliftingError) Source #
AsUnliftingEvaluationError UnliftingEvaluationError Source #
Instance details Defined in PlutusCore.Builtin.Result Methods _UnliftingEvaluationError ∷ Prism' UnliftingEvaluationError UnliftingEvaluationError Source # _MkUnliftingEvaluationError ∷ Prism' UnliftingEvaluationError (EvaluationError UnliftingError UnliftingError) Source #
(AsUnliftingError structural, AsUnliftingError operational) ⇒ AsUnliftingEvaluationError (EvaluationError structural operational) Source #	An `UnliftingEvaluationError` is an `EvaluationError`, hence for this instance we only require both `structural` and `operational` 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 #

class AsUnliftingError r where Source #

Minimal complete definition

_UnliftingError

Methods

_UnliftingError ∷ Prism' r UnliftingError Source #

_MkUnliftingError ∷ Prism' r Text Source #

Instances

Instances details

AsUnliftingError UnliftingError Source #
Instance details Defined in PlutusCore.Builtin.Result Methods _UnliftingError ∷ Prism' UnliftingError UnliftingError Source # _MkUnliftingError ∷ Prism' UnliftingError Text Source #
AsUnliftingError CekUserError Source #
Instance details Defined in UntypedPlutusCore.Evaluation.Machine.Cek.Internal Methods _UnliftingError ∷ Prism' CekUserError UnliftingError Source # _MkUnliftingError ∷ Prism' CekUserError Text Source #
AsUnliftingError (MachineError fun) Source #
Instance details Defined in PlutusCore.Evaluation.Machine.Exception Methods _UnliftingError ∷ Prism' (MachineError fun) UnliftingError Source # _MkUnliftingError ∷ Prism' (MachineError fun) Text Source #

class AsBuiltinError r where Source #

Minimal complete definition

_BuiltinError

Methods

_BuiltinError ∷ Prism' r BuiltinError Source #

_BuiltinUnliftingEvaluationError ∷ Prism' r UnliftingEvaluationError Source #

_BuiltinEvaluationFailure ∷ Prism' r () Source #

Instances

Instances details

AsBuiltinError BuiltinError Source #
Instance details Defined in PlutusCore.Builtin.Result Methods _BuiltinError ∷ Prism' BuiltinError BuiltinError Source # _BuiltinUnliftingEvaluationError ∷ Prism' BuiltinError UnliftingEvaluationError Source # _BuiltinEvaluationFailure ∷ Prism' BuiltinError () Source #

class AsBuiltinResult r a | r → a where Source #

Minimal complete definition

_BuiltinResult

Methods

_BuiltinResult ∷ Prism' r (BuiltinResult a) Source #

_BuiltinSuccess ∷ Prism' r a Source #

_BuiltinSuccessWithLogs ∷ Prism' r (DList Text, a) Source #

_BuiltinFailure ∷ Prism' r (DList Text, BuiltinError) Source #

Instances

Instances details

AsBuiltinResult (BuiltinResult a) a Source #
Instance details Defined in PlutusCore.Builtin.Result Methods _BuiltinResult ∷ Prism' (BuiltinResult a) (BuiltinResult a) Source # _BuiltinSuccess ∷ Prism' (BuiltinResult a) a Source # _BuiltinSuccessWithLogs ∷ Prism' (BuiltinResult a) (DList Text, a) Source # _BuiltinFailure ∷ Prism' (BuiltinResult a) (DList Text, BuiltinError) Source #

_UnliftingErrorVia ∷ Pretty err ⇒ err → Prism' err UnliftingError Source #

Construct a prism focusing on the *EvaluationFailure part of err by taking that *EvaluationFailure and

pretty-printing and embedding it into an UnliftingError for the setter part of the prism
returning it directly for the opposite direction (there's no other way to convert an UnliftingError to an evaluation failure, since the latter doesn't carry any content)

This is useful for providing AsUnliftingError instances for types such as CkUserError and CekUserError.

_StructuralUnliftingError ∷ AsBuiltinError err ⇒ Prism' err UnliftingError Source #

See Note [Structural vs operational errors within builtins]

_OperationalUnliftingError ∷ AsBuiltinError err ⇒ Prism' err UnliftingError Source #

See Note [Structural vs operational errors within builtins]

throwNotAConstant ∷ MonadError BuiltinError m ⇒ m void Source #

throwUnderTypeError ∷ MonadError BuiltinError m ⇒ m void Source #

emit ∷ Text → BuiltinResult () Source #

Add a log line to the logs.

withLogs ∷ DList Text → BuiltinResult a → BuiltinResult a Source #

Prepend logs to a BuiltinResult computation.

throwing ∷ MonadError e m ⇒ AReview e t → t → m x #

throwing_ ∷ MonadError e m ⇒ AReview e () → m x #