Safe Haskell	Safe-Inferred
Language	Haskell2010

Cardano.Ledger.Plutus.ExUnits

Synopsis

txscriptfee ∷ Prices → ExUnits → Coin
pointWiseExUnits ∷ (Natural → Natural → Bool) → ExUnits → ExUnits → Bool
zipSemiExUnits ∷ Semigroup a ⇒ (Natural → Natural → a) → ExUnits → ExUnits → a
newtype ExUnits where
- WrapExUnits {
  - unWrapExUnits ∷ ExUnits' Natural
  }
- pattern ExUnits ∷ Natural → Natural → ExUnits
data ExUnits' a = ExUnits' {
- exUnitsMem' ∷ !a
- exUnitsSteps' ∷ !a
}
data Prices = Prices {
- prMem ∷ !NonNegativeInterval
- prSteps ∷ !NonNegativeInterval
}

Documentation

txscriptfee ∷ Prices → ExUnits → Coin Source #

Compute the cost of a script based upon prices and the number of execution units.

pointWiseExUnits ∷ (Natural → Natural → Bool) → ExUnits → ExUnits → Bool Source #

It is deliberate that there is no Ord instance for ExUnits. Use this function to compare if one ExUnit is pointwise compareable to another. In case when Ord instance like comparison is necessary you can use zipSemiExUnits compare

zipSemiExUnits ∷ Semigroup a ⇒ (Natural → Natural → a) → ExUnits → ExUnits → a Source #

Pointwise combine units into a semigroup and mappened the results.

newtype ExUnits Source #

This newtype wrapper of ExUnits' is used to hide an implementation detail inside the ExUnits pattern.

Constructors

WrapExUnits
Fields unWrapExUnits ∷ ExUnits' Natural

Bundled Patterns

pattern ExUnits ∷ Natural → Natural → ExUnits

Arbitrary execution unit in which we measure the cost of scripts in terms of space in memory and execution time.

This pattern hides the fact that ExUnits' is parametric in the underlying type. The ledger itself uses ExUnits Natural' exclusively.

We would have preferred to use a type alias for ExUnits Natural', but this is not possible: https://gitlab.haskell.org/ghc/ghc/-/issues/19507.

Instances

Instances details

FromJSON ExUnits Source #
Instance details Defined in Cardano.Ledger.Plutus.ExUnits Methods parseJSON ∷ Value → Parser ExUnits Source # parseJSONList ∷ Value → Parser [ExUnits] Source # omittedField ∷ Maybe ExUnits Source #
ToJSON ExUnits Source #
Instance details Defined in Cardano.Ledger.Plutus.ExUnits Methods toJSON ∷ ExUnits → Value Source # toEncoding ∷ ExUnits → Encoding Source # toJSONList ∷ [ExUnits] → Value Source # toEncodingList ∷ [ExUnits] → Encoding Source # omitField ∷ ExUnits → Bool Source #
Monoid ExUnits Source #
Instance details Defined in Cardano.Ledger.Plutus.ExUnits Methods mempty ∷ ExUnits Source # mappend ∷ ExUnits → ExUnits → ExUnits Source # mconcat ∷ [ExUnits] → ExUnits Source #
Semigroup ExUnits Source #
Instance details Defined in Cardano.Ledger.Plutus.ExUnits Methods (<>) ∷ ExUnits → ExUnits → ExUnits Source # sconcat ∷ NonEmpty ExUnits → ExUnits Source # stimes ∷ Integral b ⇒ b → ExUnits → ExUnits Source #
Generic ExUnits Source #
Instance details Defined in Cardano.Ledger.Plutus.ExUnits Associated Types type Rep ExUnits ∷ Type → Type Source # Methods from ∷ ExUnits → Rep ExUnits x Source # to ∷ Rep ExUnits x → ExUnits Source #
Show ExUnits Source #
Instance details Defined in Cardano.Ledger.Plutus.ExUnits Methods showsPrec ∷ Int → ExUnits → ShowS Source # show ∷ ExUnits → String Source # showList ∷ [ExUnits] → ShowS Source #
DecCBOR ExUnits Source #
Instance details Defined in Cardano.Ledger.Plutus.ExUnits Methods decCBOR ∷ Decoder s ExUnits Source # dropCBOR ∷ Proxy ExUnits → Decoder s () Source # label ∷ Proxy ExUnits → Text Source #
EncCBOR ExUnits Source #
Instance details Defined in Cardano.Ledger.Plutus.ExUnits Methods encCBOR ∷ ExUnits → Encoding Source # encodedSizeExpr ∷ (∀ t. EncCBOR t ⇒ Proxy t → Size) → Proxy ExUnits → Size Source # encodedListSizeExpr ∷ (∀ t. EncCBOR t ⇒ Proxy t → Size) → Proxy [ExUnits] → Size Source #
ToPlutusData ExUnits Source #
Instance details Defined in Cardano.Ledger.Plutus.ToPlutusData Methods toPlutusData ∷ ExUnits → Data Source # fromPlutusData ∷ Data → Maybe ExUnits Source #
NFData ExUnits Source #
Instance details Defined in Cardano.Ledger.Plutus.ExUnits Methods rnf ∷ ExUnits → () Source #
Eq ExUnits Source #
Instance details Defined in Cardano.Ledger.Plutus.ExUnits Methods (==) ∷ ExUnits → ExUnits → Bool Source # (/=) ∷ ExUnits → ExUnits → Bool Source #
NoThunks ExUnits Source #
Instance details Defined in Cardano.Ledger.Plutus.ExUnits Methods noThunks ∷ Context → ExUnits → IO (Maybe ThunkInfo) Source # wNoThunks ∷ Context → ExUnits → IO (Maybe ThunkInfo) Source # showTypeOf ∷ Proxy ExUnits → String Source #
type Rep ExUnits Source #
Instance details Defined in Cardano.Ledger.Plutus.ExUnits type Rep ExUnits = D1 ('MetaData "ExUnits" "Cardano.Ledger.Plutus.ExUnits" "cardano-ledger-core-1.17.0.0-inplace" 'True) (C1 ('MetaCons "WrapExUnits" 'PrefixI 'True) (S1 ('MetaSel ('Just "unWrapExUnits") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (ExUnits' Natural))))

data ExUnits' a Source #

Arbitrary execution unit in which we measure the cost of scripts in terms of space in memory and execution time.

The ledger itself uses ExUnits Natural' exclusively, but the flexibility here allows the consensus layer to translate the execution units into something equivalent to 'ExUnits (Inf Natural)'. This is needed in order to provide a BoundedMeasure instance, which itself is needed for the alonzo instance of TxLimits (in consensus).

Constructors

ExUnits'
Fields exUnitsMem' ∷ !a exUnitsSteps' ∷ !a

Instances

Instances details

Functor ExUnits' Source #
Instance details Defined in Cardano.Ledger.Plutus.ExUnits Methods fmap ∷ (a → b) → ExUnits' a → ExUnits' b Source # (<$) ∷ a → ExUnits' b → ExUnits' a Source #
FromJSON a ⇒ FromJSON (ExUnits' a) Source #
Instance details Defined in Cardano.Ledger.Plutus.ExUnits Methods parseJSON ∷ Value → Parser (ExUnits' a) Source # parseJSONList ∷ Value → Parser [ExUnits' a] Source # omittedField ∷ Maybe (ExUnits' a) Source #
ToJSON a ⇒ ToJSON (ExUnits' a) Source #
Instance details Defined in Cardano.Ledger.Plutus.ExUnits Methods toJSON ∷ ExUnits' a → Value Source # toEncoding ∷ ExUnits' a → Encoding Source # toJSONList ∷ [ExUnits' a] → Value Source # toEncodingList ∷ [ExUnits' a] → Encoding Source # omitField ∷ ExUnits' a → Bool Source #
Measure a ⇒ Monoid (ExUnits' a) Source #
Instance details Defined in Cardano.Ledger.Plutus.ExUnits Methods mempty ∷ ExUnits' a Source # mappend ∷ ExUnits' a → ExUnits' a → ExUnits' a Source # mconcat ∷ [ExUnits' a] → ExUnits' a Source #
Measure a ⇒ Semigroup (ExUnits' a) Source #
Instance details Defined in Cardano.Ledger.Plutus.ExUnits Methods (<>) ∷ ExUnits' a → ExUnits' a → ExUnits' a Source # sconcat ∷ NonEmpty (ExUnits' a) → ExUnits' a Source # stimes ∷ Integral b ⇒ b → ExUnits' a → ExUnits' a Source #
Generic (ExUnits' a) Source #
Instance details Defined in Cardano.Ledger.Plutus.ExUnits Associated Types type Rep (ExUnits' a) ∷ Type → Type Source # Methods from ∷ ExUnits' a → Rep (ExUnits' a) x Source # to ∷ Rep (ExUnits' a) x → ExUnits' a Source #
Show a ⇒ Show (ExUnits' a) Source #
Instance details Defined in Cardano.Ledger.Plutus.ExUnits Methods showsPrec ∷ Int → ExUnits' a → ShowS Source # show ∷ ExUnits' a → String Source # showList ∷ [ExUnits' a] → ShowS Source #
NFData a ⇒ NFData (ExUnits' a) Source #
Instance details Defined in Cardano.Ledger.Plutus.ExUnits Methods rnf ∷ ExUnits' a → () Source #
Eq a ⇒ Eq (ExUnits' a) Source #
Instance details Defined in Cardano.Ledger.Plutus.ExUnits Methods (==) ∷ ExUnits' a → ExUnits' a → Bool Source # (/=) ∷ ExUnits' a → ExUnits' a → Bool Source #
BoundedMeasure a ⇒ BoundedMeasure (ExUnits' a) Source #
Instance details Defined in Cardano.Ledger.Plutus.ExUnits Methods maxBound ∷ ExUnits' a Source #
Measure a ⇒ Measure (ExUnits' a) Source #
Instance details Defined in Cardano.Ledger.Plutus.ExUnits Methods zero ∷ ExUnits' a Source # plus ∷ ExUnits' a → ExUnits' a → ExUnits' a Source # min ∷ ExUnits' a → ExUnits' a → ExUnits' a Source # max ∷ ExUnits' a → ExUnits' a → ExUnits' a Source #
NoThunks a ⇒ NoThunks (ExUnits' a) Source #
Instance details Defined in Cardano.Ledger.Plutus.ExUnits Methods noThunks ∷ Context → ExUnits' a → IO (Maybe ThunkInfo) Source # wNoThunks ∷ Context → ExUnits' a → IO (Maybe ThunkInfo) Source # showTypeOf ∷ Proxy (ExUnits' a) → String Source #
type Rep (ExUnits' a) Source #
Instance details Defined in Cardano.Ledger.Plutus.ExUnits type Rep (ExUnits' a) = D1 ('MetaData "ExUnits'" "Cardano.Ledger.Plutus.ExUnits" "cardano-ledger-core-1.17.0.0-inplace" 'False) (C1 ('MetaCons "ExUnits'" 'PrefixI 'True) (S1 ('MetaSel ('Just "exUnitsMem'") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 a) :*: S1 ('MetaSel ('Just "exUnitsSteps'") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 a)))

data Prices Source #

Prices per execution unit

Constructors

Prices
Fields prMem ∷ !NonNegativeInterval prSteps ∷ !NonNegativeInterval

Instances

Instances details

FromJSON Prices Source #
Instance details Defined in Cardano.Ledger.Plutus.ExUnits Methods parseJSON ∷ Value → Parser Prices Source # parseJSONList ∷ Value → Parser [Prices] Source # omittedField ∷ Maybe Prices Source #
ToJSON Prices Source #
Instance details Defined in Cardano.Ledger.Plutus.ExUnits Methods toJSON ∷ Prices → Value Source # toEncoding ∷ Prices → Encoding Source # toJSONList ∷ [Prices] → Value Source # toEncodingList ∷ [Prices] → Encoding Source # omitField ∷ Prices → Bool Source #
Generic Prices Source #
Instance details Defined in Cardano.Ledger.Plutus.ExUnits Associated Types type Rep Prices ∷ Type → Type Source # Methods from ∷ Prices → Rep Prices x Source # to ∷ Rep Prices x → Prices Source #
Show Prices Source #
Instance details Defined in Cardano.Ledger.Plutus.ExUnits Methods showsPrec ∷ Int → Prices → ShowS Source # show ∷ Prices → String Source # showList ∷ [Prices] → ShowS Source #
DecCBOR Prices Source #
Instance details Defined in Cardano.Ledger.Plutus.ExUnits Methods decCBOR ∷ Decoder s Prices Source # dropCBOR ∷ Proxy Prices → Decoder s () Source # label ∷ Proxy Prices → Text Source #
EncCBOR Prices Source #
Instance details Defined in Cardano.Ledger.Plutus.ExUnits Methods encCBOR ∷ Prices → Encoding Source # encodedSizeExpr ∷ (∀ t. EncCBOR t ⇒ Proxy t → Size) → Proxy Prices → Size Source # encodedListSizeExpr ∷ (∀ t. EncCBOR t ⇒ Proxy t → Size) → Proxy [Prices] → Size Source #
ToPlutusData Prices Source #
Instance details Defined in Cardano.Ledger.Plutus.ToPlutusData Methods toPlutusData ∷ Prices → Data Source # fromPlutusData ∷ Data → Maybe Prices Source #
NFData Prices Source #
Instance details Defined in Cardano.Ledger.Plutus.ExUnits Methods rnf ∷ Prices → () Source #
Eq Prices Source #
Instance details Defined in Cardano.Ledger.Plutus.ExUnits Methods (==) ∷ Prices → Prices → Bool Source # (/=) ∷ Prices → Prices → Bool Source #
Ord Prices Source #
Instance details Defined in Cardano.Ledger.Plutus.ExUnits Methods compare ∷ Prices → Prices → Ordering Source # (<) ∷ Prices → Prices → Bool Source # (<=) ∷ Prices → Prices → Bool Source # (>) ∷ Prices → Prices → Bool Source # (>=) ∷ Prices → Prices → Bool Source # max ∷ Prices → Prices → Prices Source # min ∷ Prices → Prices → Prices Source #
NoThunks Prices Source #
Instance details Defined in Cardano.Ledger.Plutus.ExUnits Methods noThunks ∷ Context → Prices → IO (Maybe ThunkInfo) Source # wNoThunks ∷ Context → Prices → IO (Maybe ThunkInfo) Source # showTypeOf ∷ Proxy Prices → String Source #
type Rep Prices Source #
Instance details Defined in Cardano.Ledger.Plutus.ExUnits type Rep Prices = D1 ('MetaData "Prices" "Cardano.Ledger.Plutus.ExUnits" "cardano-ledger-core-1.17.0.0-inplace" 'False) (C1 ('MetaCons "Prices" 'PrefixI 'True) (S1 ('MetaSel ('Just "prMem") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 NonNegativeInterval) :*: S1 ('MetaSel ('Just "prSteps") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 NonNegativeInterval)))