Safe Haskell	Safe-Inferred
Language	Haskell2010

PlutusCore.Evaluation.Machine.CostModelInterface

Synopsis

type CostModelParams = Map Text Int64
type CekMachineCosts = CekMachineCostsBase Identity
extractCostModelParams ∷ (ToJSON machinecosts, ToJSON builtincosts) ⇒ CostModel machinecosts builtincosts → Maybe CostModelParams
applyCostModelParams ∷ (FromJSON evaluatorcosts, FromJSON builtincosts, ToJSON evaluatorcosts, ToJSON builtincosts, MonadError CostModelApplyError m) ⇒ CostModel evaluatorcosts builtincosts → CostModelParams → m (CostModel evaluatorcosts builtincosts)
data CostModelApplyError
- = CMUnknownParamError !Text
- | CMInternalReadError
- | CMInternalWriteError !String
data CostModelApplyWarn
- = CMTooManyParamsWarn {
  - cmExpected ∷ !Int
  - cmActual ∷ !Int
  }
- | CMTooFewParamsWarn {
  - cmExpected ∷ !Int
  - cmActual ∷ !Int
  }

Documentation

type CostModelParams = Map Text Int64 Source #

A raw representation of the ledger's cost model parameters.

The associated keys/names to the parameter values are arbitrarily set by the plutus team; the ledger does not hold any such names.

See Note [Cost model parameters]

type CekMachineCosts = CekMachineCostsBase Identity Source #

Costs for evaluating AST nodes. Times should be specified in picoseconds, memory sizes in bytes.

extractCostModelParams ∷ (ToJSON machinecosts, ToJSON builtincosts) ⇒ CostModel machinecosts builtincosts → Maybe CostModelParams Source #

Given a CostModel, produce a single map containing the parameters from both components

applyCostModelParams ∷ (FromJSON evaluatorcosts, FromJSON builtincosts, ToJSON evaluatorcosts, ToJSON builtincosts, MonadError CostModelApplyError m) ⇒ CostModel evaluatorcosts builtincosts → CostModelParams → m (CostModel evaluatorcosts builtincosts) Source #

Update a CostModel for the CEK machine with a given set of parameters. Note that this is costly. See here. Callers are recommended to call this once and cache the results.

data CostModelApplyError Source #

A fatal error when trying to create a cost given some plain costmodel parameters.

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

Data CostModelApplyError Source #
Instance details Defined in PlutusCore.Evaluation.Machine.CostModelInterface Methods gfoldl ∷ (∀ d b. Data d ⇒ c (d → b) → d → c b) → (∀ g. g → c g) → CostModelApplyError → c CostModelApplyError Source # gunfold ∷ (∀ b r. Data b ⇒ c (b → r) → c r) → (∀ r. r → c r) → Constr → c CostModelApplyError Source # toConstr ∷ CostModelApplyError → Constr Source # dataTypeOf ∷ CostModelApplyError → DataType Source # dataCast1 ∷ Typeable t ⇒ (∀ d. Data d ⇒ c (t d)) → Maybe (c CostModelApplyError) Source # dataCast2 ∷ Typeable t ⇒ (∀ d e. (Data d, Data e) ⇒ c (t d e)) → Maybe (c CostModelApplyError) Source # gmapT ∷ (∀ b. Data b ⇒ b → b) → CostModelApplyError → CostModelApplyError Source # gmapQl ∷ (r → r' → r) → r → (∀ d. Data d ⇒ d → r') → CostModelApplyError → r Source # gmapQr ∷ ∀ r r'. (r' → r → r) → r → (∀ d. Data d ⇒ d → r') → CostModelApplyError → r Source # gmapQ ∷ (∀ d. Data d ⇒ d → u) → CostModelApplyError → [u] Source # gmapQi ∷ Int → (∀ d. Data d ⇒ d → u) → CostModelApplyError → u Source # gmapM ∷ Monad m ⇒ (∀ d. Data d ⇒ d → m d) → CostModelApplyError → m CostModelApplyError Source # gmapMp ∷ MonadPlus m ⇒ (∀ d. Data d ⇒ d → m d) → CostModelApplyError → m CostModelApplyError Source # gmapMo ∷ MonadPlus m ⇒ (∀ d. Data d ⇒ d → m d) → CostModelApplyError → m CostModelApplyError Source #
Exception CostModelApplyError Source #
Instance details Defined in PlutusCore.Evaluation.Machine.CostModelInterface Methods toException ∷ CostModelApplyError → SomeException Source # fromException ∷ SomeException → Maybe CostModelApplyError Source # displayException ∷ CostModelApplyError → String Source #
Generic CostModelApplyError Source #
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 Source #
Instance details Defined in PlutusCore.Evaluation.Machine.CostModelInterface Methods showsPrec ∷ Int → CostModelApplyError → ShowS Source # show ∷ CostModelApplyError → String Source # showList ∷ [CostModelApplyError] → ShowS Source #
NFData CostModelApplyError Source #
Instance details Defined in PlutusCore.Evaluation.Machine.CostModelInterface Methods rnf ∷ CostModelApplyError → () Source #
Eq CostModelApplyError Source #
Instance details Defined in PlutusCore.Evaluation.Machine.CostModelInterface Methods (==) ∷ CostModelApplyError → CostModelApplyError → Bool Source # (/=) ∷ CostModelApplyError → CostModelApplyError → Bool Source #
NoThunks CostModelApplyError Source #
Instance details Defined in PlutusCore.Evaluation.Machine.CostModelInterface Methods noThunks ∷ Context → CostModelApplyError → IO (Maybe ThunkInfo) Source # wNoThunks ∷ Context → CostModelApplyError → IO (Maybe ThunkInfo) Source # showTypeOf ∷ Proxy CostModelApplyError → String Source #
Pretty CostModelApplyError Source #
Instance details Defined in PlutusCore.Evaluation.Machine.CostModelInterface Methods pretty ∷ CostModelApplyError → Doc ann Source # prettyList ∷ [CostModelApplyError] → Doc ann Source #
type Rep CostModelApplyError Source #
Instance details Defined in PlutusCore.Evaluation.Machine.CostModelInterface type Rep CostModelApplyError = D1 ('MetaData "CostModelApplyError" "PlutusCore.Evaluation.Machine.CostModelInterface" "plutus-core-1.34.0.0-inplace" '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))))

data CostModelApplyWarn Source #

A non-fatal warning when trying to create a cost given some plain costmodel parameters.

Constructors

CMTooManyParamsWarn	See Note [Cost model parameters from the ledger's point of view]
Fields cmExpected ∷ !Int cmActual ∷ !Int
CMTooFewParamsWarn	See Note [Cost model parameters from the ledger's point of view]
Fields cmExpected ∷ !Int cmActual ∷ !Int

Instances

Instances details

Pretty CostModelApplyWarn Source #
Instance details Defined in PlutusCore.Evaluation.Machine.CostModelInterface Methods pretty ∷ CostModelApplyWarn → Doc ann Source # prettyList ∷ [CostModelApplyWarn] → Doc ann Source #