plutus-ledger-api-1.0.0.1: Interface to the Plutus ledger for the Cardano ledger.
Safe Haskell None
Language Haskell2010

Plutus.V1.Ledger.EvaluationContext

Synopsis

Documentation

data EvaluationContext Source #

An opaque type that contains all the static parameters that the evaluator needs to evaluate a script. This is so that they can be computed once and cached, rather than recomputed on every evaluation.

There are two sets of parameters: one is with immediate unlifting and the other one is with deferred unlifting. We have to keep both of them, because depending on the language version either one has to be used or the other. We also compile them separately due to all the inlining and optimization that need to happen for things to be efficient.

Instances

Instances details
Generic EvaluationContext Source #
Instance details

Defined in Plutus.ApiCommon

Associated Types

type Rep EvaluationContext :: Type -> Type Source #

Methods

from :: EvaluationContext -> Rep EvaluationContext x Source #

to :: Rep EvaluationContext x -> EvaluationContext Source #

NFData EvaluationContext Source #
Instance details

Defined in Plutus.ApiCommon

Methods

rnf :: EvaluationContext -> () Source #

NoThunks EvaluationContext Source #
Instance details

Defined in Plutus.ApiCommon

Methods

noThunks :: Context -> EvaluationContext -> IO ( Maybe ThunkInfo ) Source #

wNoThunks :: Context -> EvaluationContext -> IO ( Maybe ThunkInfo ) Source #

showTypeOf :: Proxy EvaluationContext -> String Source #

type Rep EvaluationContext Source #
Instance details

Defined in Plutus.ApiCommon

type Rep EvaluationContext = D1 (' MetaData "EvaluationContext" "Plutus.ApiCommon" "plutus-ledger-api-1.0.0.1-GlUFhIIE0LJGuJDDdHh5lQ" ' False ) ( C1 (' MetaCons "EvaluationContext" ' PrefixI ' True ) ( S1 (' MetaSel (' Just "machineParametersImmediate") ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedStrict ) ( Rec0 DefaultMachineParameters ) :*: S1 (' MetaSel (' Just "machineParametersDeferred") ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedStrict ) ( Rec0 DefaultMachineParameters )))

mkEvaluationContext :: MonadError CostModelApplyError m => CostModelParams -> m EvaluationContext Source #

Build the EvaluationContext .

The input is a Map of strings to cost integer values (aka CostModelParams , CostModel ) See Note [Inlining meanings of builtins].

type CostModelParams = Map Text Integer Source #

assertWellFormedCostModelParams :: MonadError CostModelApplyError m => CostModelParams -> m () Source #

Comparably expensive to mkEvaluationContext , so it should only be used sparingly.

machineParametersImmediate :: EvaluationContext -> DefaultMachineParameters Source #

machineParametersDeferred :: EvaluationContext -> DefaultMachineParameters Source #

toMachineParameters :: ProtocolVersion -> EvaluationContext -> DefaultMachineParameters Source #

costModelParamNames :: Set Text Source #

The set of valid names that a cost model parameter can take for this language version. It is used for the deserialization of CostModelParams .

costModelParamsForTesting :: CostModelParams Source #

The raw cost model params, only to be used for testing purposes.

evalCtxForTesting :: EvaluationContext Source #

only to be for testing purposes: make an evaluation context by applying an empty set of protocol parameters

data CostModelApplyError Source #

The type of errors that applyParams can throw.

Constructors

CMUnknownParamError Text

a costmodel parameter with the give name does not exist in the costmodel to be applied upon

CMInternalReadError

internal error when we are transforming the applyParams' input to json (should not happen)

CMInternalWriteError String

internal error when we are transforming the applied params from json with given jsonstring error (should not happen)

Instances

Instances details
Show CostModelApplyError
Instance details

Defined in PlutusCore.Evaluation.Machine.CostModelInterface

Methods

showsPrec :: Int -> CostModelApplyError -> ShowS Source #

show :: CostModelApplyError -> String Source #

showList :: [ CostModelApplyError ] -> ShowS Source #

Exception CostModelApplyError
Instance details

Defined in PlutusCore.Evaluation.Machine.CostModelInterface

Methods

toException :: CostModelApplyError -> SomeException Source #

fromException :: SomeException -> Maybe CostModelApplyError Source #

displayException :: CostModelApplyError -> String Source #

Pretty CostModelApplyError
Instance details

Defined in PlutusCore.Evaluation.Machine.CostModelInterface

Methods

pretty :: CostModelApplyError -> Doc ann Source #

prettyList :: [ CostModelApplyError ] -> Doc ann Source #