Safe Haskell	Safe-Inferred
Language	Haskell2010

PlutusLedgerApi.V3.EvaluationContext

Synopsis

data EvaluationContext
mkEvaluationContext :: (MonadError CostModelApplyError m, MonadWriter [CostModelApplyWarn] m) => [Integer] -> m EvaluationContext
type CostModelParams = Map Text Integer
assertWellFormedCostModelParams :: MonadError CostModelApplyError m => CostModelParams -> m ()
toMachineParameters :: MajorProtocolVersion -> EvaluationContext -> DefaultMachineParameters
data CostModelApplyError
- = CMUnknownParamError !Text
- | CMInternalReadError
- | CMInternalWriteError !String
- | CMTooFewParamsError {
  - cmTooFewExpected :: !Int
  - cmTooFewActual :: !Int
  }

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 being recomputed on every evaluation.

Instances

Instances details

Generic EvaluationContext Source #
Instance details Defined in PlutusLedgerApi.Common.Eval 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 PlutusLedgerApi.Common.Eval Methods rnf :: EvaluationContext -> () Source #
NoThunks EvaluationContext Source #
Instance details Defined in PlutusLedgerApi.Common.Eval Methods noThunks :: Context -> EvaluationContext -> IO (Maybe ThunkInfo) wNoThunks :: Context -> EvaluationContext -> IO (Maybe ThunkInfo) showTypeOf :: Proxy EvaluationContext -> String
type Rep EvaluationContext Source #
Instance details Defined in PlutusLedgerApi.Common.Eval type Rep EvaluationContext = D1 ('MetaData "EvaluationContext" "PlutusLedgerApi.Common.Eval" "plutus-ledger-api-1.18.0.0-Arniy3OL4wy69RH7u4QMZP" 'True) (C1 ('MetaCons "EvaluationContext" 'PrefixI 'True) (S1 ('MetaSel ('Just "machineParameters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 DefaultMachineParameters)))

mkEvaluationContext Source #

Arguments

:: (MonadError CostModelApplyError m, MonadWriter [CostModelApplyWarn] m)
=> [Integer]	the (updated) cost model parameters of the protocol
-> m EvaluationContext

Build the EvaluationContext.

The input is a list of cost model parameters (which are integer values) passed from the ledger.

IMPORTANT: the cost model parameters MUST appear in the correct order, matching the names in ParamName. If the parameters are supplied in the wrong order then script cost calculations will be incorrect.

IMPORTANT: The evaluation context of every Plutus version must be recreated upon a protocol update with the updated cost model parameters.

type CostModelParams = Map Text Integer #

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

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

data CostModelApplyError #

Constructors

CMUnknownParamError !Text
CMInternalReadError
CMInternalWriteError !String
CMTooFewParamsError
Fields cmTooFewExpected :: !Int cmTooFewActual :: !Int

Instances

Instances details

Data CostModelApplyError
Instance details Defined in PlutusCore.Evaluation.Machine.CostModelInterface Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> CostModelApplyError -> c CostModelApplyError Source # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c CostModelApplyError Source # toConstr :: CostModelApplyError -> Constr Source # dataTypeOf :: CostModelApplyError -> DataType Source # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c CostModelApplyError) Source # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c CostModelApplyError) Source # gmapT :: (forall b. Data b => b -> b) -> CostModelApplyError -> CostModelApplyError Source # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> CostModelApplyError -> r Source # gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> CostModelApplyError -> r Source # gmapQ :: (forall d. Data d => d -> u) -> CostModelApplyError -> [u] Source # gmapQi :: Int -> (forall d. Data d => d -> u) -> CostModelApplyError -> u Source # gmapM :: Monad m => (forall d. Data d => d -> m d) -> CostModelApplyError -> m CostModelApplyError Source # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> CostModelApplyError -> m CostModelApplyError Source # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> CostModelApplyError -> m CostModelApplyError 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 #
Generic CostModelApplyError
Instance details Defined in PlutusCore.Evaluation.Machine.CostModelInterface Associated Types type Rep CostModelApplyError :: Type -> Type Source # Methods from :: CostModelApplyError -> Rep CostModelApplyError x Source # to :: Rep CostModelApplyError x -> CostModelApplyError Source #
Show CostModelApplyError
Instance details Defined in PlutusCore.Evaluation.Machine.CostModelInterface Methods showsPrec :: Int -> CostModelApplyError -> ShowS Source # show :: CostModelApplyError -> String Source # showList :: [CostModelApplyError] -> ShowS Source #
NFData CostModelApplyError
Instance details Defined in PlutusCore.Evaluation.Machine.CostModelInterface Methods rnf :: CostModelApplyError -> () Source #
Eq CostModelApplyError
Instance details Defined in PlutusCore.Evaluation.Machine.CostModelInterface Methods (==) :: CostModelApplyError -> CostModelApplyError -> Bool Source # (/=) :: CostModelApplyError -> CostModelApplyError -> Bool Source #
NoThunks CostModelApplyError
Instance details Defined in PlutusCore.Evaluation.Machine.CostModelInterface Methods noThunks :: Context -> CostModelApplyError -> IO (Maybe ThunkInfo) wNoThunks :: Context -> CostModelApplyError -> IO (Maybe ThunkInfo) showTypeOf :: Proxy CostModelApplyError -> String
Pretty CostModelApplyError
Instance details Defined in PlutusCore.Evaluation.Machine.CostModelInterface Methods pretty :: CostModelApplyError -> Doc ann prettyList :: [CostModelApplyError] -> Doc ann
type Rep CostModelApplyError
Instance details Defined in PlutusCore.Evaluation.Machine.CostModelInterface type Rep CostModelApplyError = D1 ('MetaData "CostModelApplyError" "PlutusCore.Evaluation.Machine.CostModelInterface" "plutus-core-1.18.0.0-Bo1HApUitrK8tVw3GuwnrY" 'False) ((C1 ('MetaCons "CMUnknownParamError" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Text)) :+: C1 ('MetaCons "CMInternalReadError" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "CMInternalWriteError" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 String)) :+: C1 ('MetaCons "CMTooFewParamsError" 'PrefixI 'True) (S1 ('MetaSel ('Just "cmTooFewExpected") 'NoSourceUnpackedness 'SourceStrict 'DecidedUnpack) (Rec0 Int) :*: S1 ('MetaSel ('Just "cmTooFewActual") 'NoSourceUnpackedness 'SourceStrict 'DecidedUnpack) (Rec0 Int))))