| Safe Haskell | Safe-Inferred |
|---|---|
| Language | Haskell2010 |
PlutusLedgerApi.V1
Description
The interface to Plutus V1 for the ledger.
Synopsis
- newtype ScriptHash = ScriptHash {}
- newtype Redeemer = Redeemer {}
- newtype RedeemerHash = RedeemerHash BuiltinByteString
- newtype Datum = Datum {}
- newtype DatumHash = DatumHash BuiltinByteString
- newtype Context = Context BuiltinData
- data ScriptError
- = EvaluationError ![Text] !String
- | EvaluationException !String !String
- type SerialisedScript = ShortByteString
- data ScriptForEvaluation
- data ScriptDecodeError
- newtype ScriptNamedDeBruijn = ScriptNamedDeBruijn (Program NamedDeBruijn DefaultUni DefaultFun ())
- serialisedScript ∷ ScriptForEvaluation → SerialisedScript
- deserialisedScript ∷ ScriptForEvaluation → ScriptNamedDeBruijn
- serialiseCompiledCode ∷ ∀ a. CompiledCode a → SerialisedScript
- serialiseUPLC ∷ Program DeBruijn DefaultUni DefaultFun () → SerialisedScript
- deserialiseScript ∷ ∀ m. MonadError ScriptDecodeError m ⇒ MajorProtocolVersion → SerialisedScript → m ScriptForEvaluation
- uncheckedDeserialiseUPLC ∷ SerialisedScript → Program DeBruijn DefaultUni DefaultFun ()
- evaluateScriptRestricting ∷ MajorProtocolVersion → VerboseMode → EvaluationContext → ExBudget → ScriptForEvaluation → [Data] → (LogOutput, Either EvaluationError ExBudget)
- evaluateScriptCounting ∷ MajorProtocolVersion → VerboseMode → EvaluationContext → ScriptForEvaluation → [Data] → (LogOutput, Either EvaluationError ExBudget)
- newtype MajorProtocolVersion = MajorProtocolVersion {}
- data ExBudget = ExBudget {}
- newtype ExCPU = ExCPU CostingInteger
- newtype ExMemory = ExMemory CostingInteger
- data SatInt
- fromSatInt ∷ Num a ⇒ SatInt → a
- data ParamName
- = AddInteger'cpu'arguments'intercept
- | AddInteger'cpu'arguments'slope
- | AddInteger'memory'arguments'intercept
- | AddInteger'memory'arguments'slope
- | AppendByteString'cpu'arguments'intercept
- | AppendByteString'cpu'arguments'slope
- | AppendByteString'memory'arguments'intercept
- | AppendByteString'memory'arguments'slope
- | AppendString'cpu'arguments'intercept
- | AppendString'cpu'arguments'slope
- | AppendString'memory'arguments'intercept
- | AppendString'memory'arguments'slope
- | BData'cpu'arguments
- | BData'memory'arguments
- | Blake2b_256'cpu'arguments'intercept
- | Blake2b_256'cpu'arguments'slope
- | Blake2b_256'memory'arguments
- | CekApplyCost'exBudgetCPU
- | CekApplyCost'exBudgetMemory
- | CekBuiltinCost'exBudgetCPU
- | CekBuiltinCost'exBudgetMemory
- | CekConstCost'exBudgetCPU
- | CekConstCost'exBudgetMemory
- | CekDelayCost'exBudgetCPU
- | CekDelayCost'exBudgetMemory
- | CekForceCost'exBudgetCPU
- | CekForceCost'exBudgetMemory
- | CekLamCost'exBudgetCPU
- | CekLamCost'exBudgetMemory
- | CekStartupCost'exBudgetCPU
- | CekStartupCost'exBudgetMemory
- | CekVarCost'exBudgetCPU
- | CekVarCost'exBudgetMemory
- | ChooseData'cpu'arguments
- | ChooseData'memory'arguments
- | ChooseList'cpu'arguments
- | ChooseList'memory'arguments
- | ChooseUnit'cpu'arguments
- | ChooseUnit'memory'arguments
- | ConsByteString'cpu'arguments'intercept
- | ConsByteString'cpu'arguments'slope
- | ConsByteString'memory'arguments'intercept
- | ConsByteString'memory'arguments'slope
- | ConstrData'cpu'arguments
- | ConstrData'memory'arguments
- | DecodeUtf8'cpu'arguments'intercept
- | DecodeUtf8'cpu'arguments'slope
- | DecodeUtf8'memory'arguments'intercept
- | DecodeUtf8'memory'arguments'slope
- | DivideInteger'cpu'arguments'constant
- | DivideInteger'cpu'arguments'model'arguments'intercept
- | DivideInteger'cpu'arguments'model'arguments'slope
- | DivideInteger'memory'arguments'intercept
- | DivideInteger'memory'arguments'minimum
- | DivideInteger'memory'arguments'slope
- | EncodeUtf8'cpu'arguments'intercept
- | EncodeUtf8'cpu'arguments'slope
- | EncodeUtf8'memory'arguments'intercept
- | EncodeUtf8'memory'arguments'slope
- | EqualsByteString'cpu'arguments'constant
- | EqualsByteString'cpu'arguments'intercept
- | EqualsByteString'cpu'arguments'slope
- | EqualsByteString'memory'arguments
- | EqualsData'cpu'arguments'intercept
- | EqualsData'cpu'arguments'slope
- | EqualsData'memory'arguments
- | EqualsInteger'cpu'arguments'intercept
- | EqualsInteger'cpu'arguments'slope
- | EqualsInteger'memory'arguments
- | EqualsString'cpu'arguments'constant
- | EqualsString'cpu'arguments'intercept
- | EqualsString'cpu'arguments'slope
- | EqualsString'memory'arguments
- | FstPair'cpu'arguments
- | FstPair'memory'arguments
- | HeadList'cpu'arguments
- | HeadList'memory'arguments
- | IData'cpu'arguments
- | IData'memory'arguments
- | IfThenElse'cpu'arguments
- | IfThenElse'memory'arguments
- | IndexByteString'cpu'arguments
- | IndexByteString'memory'arguments
- | LengthOfByteString'cpu'arguments
- | LengthOfByteString'memory'arguments
- | LessThanByteString'cpu'arguments'intercept
- | LessThanByteString'cpu'arguments'slope
- | LessThanByteString'memory'arguments
- | LessThanEqualsByteString'cpu'arguments'intercept
- | LessThanEqualsByteString'cpu'arguments'slope
- | LessThanEqualsByteString'memory'arguments
- | LessThanEqualsInteger'cpu'arguments'intercept
- | LessThanEqualsInteger'cpu'arguments'slope
- | LessThanEqualsInteger'memory'arguments
- | LessThanInteger'cpu'arguments'intercept
- | LessThanInteger'cpu'arguments'slope
- | LessThanInteger'memory'arguments
- | ListData'cpu'arguments
- | ListData'memory'arguments
- | MapData'cpu'arguments
- | MapData'memory'arguments
- | MkCons'cpu'arguments
- | MkCons'memory'arguments
- | MkNilData'cpu'arguments
- | MkNilData'memory'arguments
- | MkNilPairData'cpu'arguments
- | MkNilPairData'memory'arguments
- | MkPairData'cpu'arguments
- | MkPairData'memory'arguments
- | ModInteger'cpu'arguments'constant
- | ModInteger'cpu'arguments'model'arguments'intercept
- | ModInteger'cpu'arguments'model'arguments'slope
- | ModInteger'memory'arguments'intercept
- | ModInteger'memory'arguments'minimum
- | ModInteger'memory'arguments'slope
- | MultiplyInteger'cpu'arguments'intercept
- | MultiplyInteger'cpu'arguments'slope
- | MultiplyInteger'memory'arguments'intercept
- | MultiplyInteger'memory'arguments'slope
- | NullList'cpu'arguments
- | NullList'memory'arguments
- | QuotientInteger'cpu'arguments'constant
- | QuotientInteger'cpu'arguments'model'arguments'intercept
- | QuotientInteger'cpu'arguments'model'arguments'slope
- | QuotientInteger'memory'arguments'intercept
- | QuotientInteger'memory'arguments'minimum
- | QuotientInteger'memory'arguments'slope
- | RemainderInteger'cpu'arguments'constant
- | RemainderInteger'cpu'arguments'model'arguments'intercept
- | RemainderInteger'cpu'arguments'model'arguments'slope
- | RemainderInteger'memory'arguments'intercept
- | RemainderInteger'memory'arguments'minimum
- | RemainderInteger'memory'arguments'slope
- | Sha2_256'cpu'arguments'intercept
- | Sha2_256'cpu'arguments'slope
- | Sha2_256'memory'arguments
- | Sha3_256'cpu'arguments'intercept
- | Sha3_256'cpu'arguments'slope
- | Sha3_256'memory'arguments
- | SliceByteString'cpu'arguments'intercept
- | SliceByteString'cpu'arguments'slope
- | SliceByteString'memory'arguments'intercept
- | SliceByteString'memory'arguments'slope
- | SndPair'cpu'arguments
- | SndPair'memory'arguments
- | SubtractInteger'cpu'arguments'intercept
- | SubtractInteger'cpu'arguments'slope
- | SubtractInteger'memory'arguments'intercept
- | SubtractInteger'memory'arguments'slope
- | TailList'cpu'arguments
- | TailList'memory'arguments
- | Trace'cpu'arguments
- | Trace'memory'arguments
- | UnBData'cpu'arguments
- | UnBData'memory'arguments
- | UnConstrData'cpu'arguments
- | UnConstrData'memory'arguments
- | UnIData'cpu'arguments
- | UnIData'memory'arguments
- | UnListData'cpu'arguments
- | UnListData'memory'arguments
- | UnMapData'cpu'arguments
- | UnMapData'memory'arguments
- | VerifyEd25519Signature'cpu'arguments'intercept
- | VerifyEd25519Signature'cpu'arguments'slope
- | VerifyEd25519Signature'memory'arguments
- tagWithParamNames ∷ ∀ k m. (Enum k, Bounded k, MonadError CostModelApplyError m, MonadWriter [CostModelApplyWarn] m) ⇒ [Int64] → m [(k, Int64)]
- data EvaluationError
- data EvaluationContext
- class AsScriptDecodeError r where
- _ScriptDecodeError ∷ Prism' r ScriptDecodeError
- _CBORDeserialiseError ∷ Prism' r DeserialiseFailureInfo
- _RemainderError ∷ Prism' r ByteString
- _LedgerLanguageNotAvailableError ∷ Prism' r (PlutusLedgerLanguage, MajorProtocolVersion, MajorProtocolVersion)
- _PlutusCoreLanguageNotAvailableError ∷ Prism' r (Version, PlutusLedgerLanguage, MajorProtocolVersion)
- type LogOutput = [Text]
- data VerboseMode
- evaluateTerm ∷ ExBudgetMode cost DefaultUni DefaultFun → MajorProtocolVersion → VerboseMode → EvaluationContext → Term NamedDeBruijn DefaultUni DefaultFun () → (Either (CekEvaluationException NamedDeBruijn DefaultUni DefaultFun) (Term NamedDeBruijn DefaultUni DefaultFun ()), cost, [Text])
- mkDynEvaluationContext ∷ MonadError CostModelApplyError m ⇒ PlutusLedgerLanguage → [BuiltinSemanticsVariant DefaultFun] → (MajorProtocolVersion → BuiltinSemanticsVariant DefaultFun) → CostModelParams → m EvaluationContext
- toMachineParameters ∷ MajorProtocolVersion → EvaluationContext → DefaultMachineParameters
- mkTermToEvaluate ∷ MonadError EvaluationError m ⇒ PlutusLedgerLanguage → MajorProtocolVersion → ScriptForEvaluation → [Data] → m (Term NamedDeBruijn DefaultUni DefaultFun ())
- assertWellFormedCostModelParams ∷ MonadError CostModelApplyError m ⇒ CostModelParams → m ()
- mkEvaluationContext ∷ (MonadError CostModelApplyError m, MonadWriter [CostModelApplyWarn] m) ⇒ [Int64] → m EvaluationContext
- type CostModelParams = Map Text Int64
- data CostModelApplyError
- data TxInfo = TxInfo {}
- data ScriptContext = ScriptContext {}
- data ScriptPurpose
- newtype TxId = TxId {}
- data TxOut = TxOut {}
- data TxOutRef = TxOutRef {}
- data TxInInfo = TxInInfo {}
- findOwnInput ∷ ScriptContext → Maybe TxInInfo
- findDatum ∷ DatumHash → TxInfo → Maybe Datum
- findDatumHash ∷ Datum → TxInfo → Maybe DatumHash
- findTxInByTxOutRef ∷ TxOutRef → TxInfo → Maybe TxInInfo
- findContinuingOutputs ∷ ScriptContext → [Integer]
- getContinuingOutputs ∷ ScriptContext → [TxOut]
- pubKeyOutputsAt ∷ PubKeyHash → TxInfo → [Value]
- valuePaidTo ∷ TxInfo → PubKeyHash → Value
- spendsOutput ∷ TxInfo → TxId → Integer → Bool
- txSignedBy ∷ TxInfo → PubKeyHash → Bool
- valueSpent ∷ TxInfo → Value
- valueProduced ∷ TxInfo → Value
- ownCurrencySymbol ∷ ScriptContext → CurrencySymbol
- data BuiltinByteString
- toBuiltin ∷ HasToBuiltin a ⇒ a → ToBuiltin a
- fromBuiltin ∷ HasFromBuiltin arep ⇒ arep → FromBuiltin arep
- toOpaque ∷ HasToOpaque a arep ⇒ a → arep
- fromOpaque ∷ HasFromOpaque arep a ⇒ arep → a
- newtype LedgerBytes = LedgerBytes {}
- data LedgerBytesError
- fromBytes ∷ ByteString → LedgerBytes
- fromHex ∷ ByteString → Either LedgerBytesError LedgerBytes
- bytes ∷ LedgerBytes → ByteString
- encodeByteString ∷ ByteString → Text
- data DCert
- data StakingCredential
- data Credential
- newtype Value = Value {}
- newtype Lovelace = Lovelace {}
- currencySymbolValueOf ∷ Value → CurrencySymbol → Integer
- flattenValue ∷ Value → [(CurrencySymbol, TokenName, Integer)]
- isZero ∷ Value → Bool
- lovelaceValue ∷ Lovelace → Value
- lovelaceValueOf ∷ Value → Lovelace
- scale ∷ Module s v ⇒ s → v → v
- singleton ∷ CurrencySymbol → TokenName → Integer → Value
- split ∷ Value → (Value, Value)
- unionWith ∷ (Integer → Integer → Integer) → Value → Value → Value
- valueOf ∷ Value → CurrencySymbol → TokenName → Integer
- newtype CurrencySymbol = CurrencySymbol {}
- currencySymbol ∷ ByteString → CurrencySymbol
- adaSymbol ∷ CurrencySymbol
- symbols ∷ Value → [CurrencySymbol]
- newtype TokenName = TokenName {}
- tokenName ∷ ByteString → TokenName
- adaToken ∷ TokenName
- newtype AssetClass = AssetClass {}
- assetClass ∷ CurrencySymbol → TokenName → AssetClass
- assetClassValue ∷ AssetClass → Integer → Value
- assetClassValueOf ∷ Value → AssetClass → Integer
- data Address = Address {}
- pubKeyHashAddress ∷ PubKeyHash → Address
- toPubKeyHash ∷ Address → Maybe PubKeyHash
- toScriptHash ∷ Address → Maybe ScriptHash
- scriptHashAddress ∷ ScriptHash → Address
- stakingCredential ∷ Address → Maybe StakingCredential
- newtype PubKeyHash = PubKeyHash {}
- newtype POSIXTime = POSIXTime {}
- type POSIXTimeRange = Interval POSIXTime
- newtype DiffMilliSeconds = DiffMilliSeconds Integer
- fromMilliSeconds ∷ DiffMilliSeconds → POSIXTime
- data Interval a = Interval {
- ivFrom ∷ LowerBound a
- ivTo ∷ UpperBound a
- data Extended a
- type Closure = Bool
- data UpperBound a = UpperBound (Extended a) Closure
- data LowerBound a = LowerBound (Extended a) Closure
- never ∷ Interval a
- always ∷ Interval a
- from ∷ a → Interval a
- to ∷ a → Interval a
- lowerBound ∷ a → LowerBound a
- upperBound ∷ a → UpperBound a
- strictLowerBound ∷ a → LowerBound a
- strictUpperBound ∷ a → UpperBound a
- member ∷ (Enum a, Ord a) ⇒ a → Interval a → Bool
- interval ∷ a → a → Interval a
- hull ∷ (Enum a, Ord a) ⇒ Interval a → Interval a → Interval a
- intersection ∷ (Enum a, Ord a) ⇒ Interval a → Interval a → Interval a
- overlaps ∷ (Enum a, Ord a) ⇒ Interval a → Interval a → Bool
- contains ∷ (Enum a, Ord a) ⇒ Interval a → Interval a → Bool
- isEmpty ∷ (Enum a, Ord a) ⇒ Interval a → Bool
- before ∷ (Enum a, Ord a) ⇒ a → Interval a → Bool
- after ∷ (Enum a, Ord a) ⇒ a → Interval a → Bool
- data Data
- data BuiltinData = BuiltinData ~Data
- class ToData a where
- toBuiltinData ∷ a → BuiltinData
- class FromData a where
- fromBuiltinData ∷ BuiltinData → Maybe a
- class UnsafeFromData a where
- toData ∷ ToData a ⇒ a → Data
- fromData ∷ FromData a ⇒ Data → Maybe a
- unsafeFromData ∷ UnsafeFromData a ⇒ Data → a
- dataToBuiltinData ∷ Data → BuiltinData
- builtinDataToData ∷ BuiltinData → Data
- class Monad m ⇒ MonadError e (m ∷ Type → Type) | m → e
Scripts
newtype ScriptHash Source #
Type representing the BLAKE2b-224 hash of a script. 28 bytes.
This is a simple type without any validation, use with caution. You may want to add checks for its invariants. See the Shelley ledger specification.
Constructors
| ScriptHash | |
Fields | |
Instances
Redeemer is a wrapper around Data values that are used as redeemers in transaction inputs.
Constructors
| Redeemer | |
Fields | |
Instances
newtype RedeemerHash Source #
Type representing the BLAKE2b-256 hash of a redeemer. 32 bytes.
This is a simple type without any validation, use with caution. You may want to add checks for its invariants. See the Shelley ledger specification.
Constructors
| RedeemerHash BuiltinByteString |
Instances
Datum is a wrapper around Data values which are used as data in transaction outputs.
Constructors
| Datum | |
Fields | |
Instances
Type representing the BLAKE2b-256 hash of a datum. 32 bytes.
This is a simple type without any validation, use with caution. You may want to add checks for its invariants. See the Shelley ledger specification.
Constructors
| DatumHash BuiltinByteString |
Instances
Information about the state of the blockchain and about the transaction
that is currently being validated, represented as a value in Data.
Constructors
| Context BuiltinData |
data ScriptError Source #
A higher-level evaluation error.
Constructors
| EvaluationError ![Text] !String | Expected behavior of the engine (e.g. user-provided error) |
| EvaluationException !String !String | Unexpected behavior of the engine (a bug) |
Instances
Script (de)serialization
type SerialisedScript = ShortByteString Source #
Scripts to the ledger are serialised bytestrings.
data ScriptForEvaluation Source #
A Plutus script ready to be evaluated on-chain, via evaluateScriptRestricting.
Instances
data ScriptDecodeError Source #
An error that occurred during script deserialization.
Constructors
| CBORDeserialiseError !DeserialiseFailureInfo | an error from the underlying CBOR/serialise library |
| RemainderError !ByteString | Script was successfully parsed, but more (runaway) bytes encountered after script's position |
| LedgerLanguageNotAvailableError | the plutus version of the given script is not enabled yet |
Fields
| |
| PlutusCoreLanguageNotAvailableError | |
Fields
| |
Instances
newtype ScriptNamedDeBruijn Source #
A script with named de-bruijn indices.
Constructors
| ScriptNamedDeBruijn (Program NamedDeBruijn DefaultUni DefaultFun ()) |
Instances
serialisedScript ∷ ScriptForEvaluation → SerialisedScript Source #
Get a SerialisedScript from a ScriptForEvaluation. O(1).
deserialisedScript ∷ ScriptForEvaluation → ScriptNamedDeBruijn Source #
Get a ScriptNamedDeBruijn from a ScriptForEvaluation. O(1).
serialiseCompiledCode ∷ ∀ a. CompiledCode a → SerialisedScript Source #
Turns a program which was compiled using the 'PlutusTx' toolchain into a binary format that is understood by the network and can be stored on-chain.
serialiseUPLC ∷ Program DeBruijn DefaultUni DefaultFun () → SerialisedScript Source #
Turns a program's AST (most likely manually constructed) into a binary format that is understood by the network and can be stored on-chain.
Arguments
| ∷ ∀ m. MonadError ScriptDecodeError m | |
| ⇒ MajorProtocolVersion | which major protocol version the script was submitted in. |
| → SerialisedScript | the script to deserialise. |
| → m ScriptForEvaluation |
The deserialization from a serialised script into a ScriptForEvaluation,
ready to be evaluated on-chain.
Called inside phase-1 validation (i.e., deserialisation error is a phase-1 error).
uncheckedDeserialiseUPLC ∷ SerialisedScript → Program DeBruijn DefaultUni DefaultFun () Source #
Deserialises a SerialisedScript back into an AST. Does *not* do
ledger-language-version-specific checks like for allowable builtins.
Running scripts
evaluateScriptRestricting Source #
Arguments
| ∷ MajorProtocolVersion | Which major protocol version to run the operation in |
| → VerboseMode | Whether to produce log output |
| → EvaluationContext | Includes the cost model to use for tallying up the execution costs |
| → ExBudget | The resource budget which must not be exceeded during evaluation |
| → ScriptForEvaluation | The script to evaluate |
| → [Data] | The arguments to the script |
| → (LogOutput, Either EvaluationError ExBudget) |
Evaluates a script, with a cost model and a budget that restricts how many resources it can use according to the cost model. Also returns the budget that was actually used.
Can be used to calculate budgets for scripts, but even in this case you must give a limit to guard against scripts that run for a long time or loop.
evaluateScriptCounting Source #
Arguments
| ∷ MajorProtocolVersion | Which major protocol version to run the operation in |
| → VerboseMode | Whether to produce log output |
| → EvaluationContext | Includes the cost model to use for tallying up the execution costs |
| → ScriptForEvaluation | The script to evaluate |
| → [Data] | The arguments to the script |
| → (LogOutput, Either EvaluationError ExBudget) |
Evaluates a script, returning the minimum budget that the script would need
to evaluate successfully. This will take as long as the script takes, if you need to
limit the execution time of the script also, you can use evaluateScriptRestricting, which
also returns the used budget.
Protocol version
newtype MajorProtocolVersion Source #
This represents the major component of the Cardano protocol version. The ledger can only supply the major component of the protocol version, not the minor component, and Plutus should only need to care about the major component anyway. This relies on careful understanding between us and the ledger as to what this means.
Constructors
| MajorProtocolVersion | |
Fields | |
Instances
Costing-related types
Constructors
| ExBudget | |
Fields | |
Instances
| FromJSON ExBudget | |
Defined in PlutusCore.Evaluation.Machine.ExBudget | |
| ToJSON ExBudget | |
Defined in PlutusCore.Evaluation.Machine.ExBudget Methods toEncoding ∷ ExBudget → Encoding toJSONList ∷ [ExBudget] → Value toEncodingList ∷ [ExBudget] → Encoding | |
| Monoid ExBudget | |
| Semigroup ExBudget | |
| Generic ExBudget | |
| Show ExBudget | |
| NFData ExBudget | |
Defined in PlutusCore.Evaluation.Machine.ExBudget | |
| Eq ExBudget | |
| NoThunks ExBudget | |
| Pretty ExBudget | |
| Serialise ExBudget | |
| PrettyBy config ExBudget | |
| Lift ExBudget | |
| type Rep ExBudget | |
Defined in PlutusCore.Evaluation.Machine.ExBudget type Rep ExBudget = D1 ('MetaData "ExBudget" "PlutusCore.Evaluation.Machine.ExBudget" "plutus-core-1.39.0.0-inplace" 'False) (C1 ('MetaCons "ExBudget" 'PrefixI 'True) (S1 ('MetaSel ('Just "exBudgetCPU") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedUnpack) (Rec0 ExCPU) :*: S1 ('MetaSel ('Just "exBudgetMemory") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedUnpack) (Rec0 ExMemory))) | |
Counts CPU units in picoseconds: maximum value for SatInt is 2^63 ps, or appproximately 106 days.
Constructors
| ExCPU CostingInteger |
Instances
| FromJSON ExCPU | |
Defined in PlutusCore.Evaluation.Machine.ExMemory | |
| ToJSON ExCPU | |
Defined in PlutusCore.Evaluation.Machine.ExMemory | |
| Monoid ExCPU | |
| Semigroup ExCPU | |
| Bounded ExCPU | |
| Generic ExCPU | |
| Num ExCPU | |
| Read ExCPU | |
| Show ExCPU | |
| NFData ExCPU | |
Defined in PlutusCore.Evaluation.Machine.ExMemory | |
| Eq ExCPU | |
| Ord ExCPU | |
Defined in PlutusCore.Evaluation.Machine.ExMemory | |
| NoThunks ExCPU | |
| Pretty ExCPU | |
| Serialise ExCPU | |
| PrettyBy config ExCPU | |
| Lift ExCPU | |
| type Rep ExCPU | |
Defined in PlutusCore.Evaluation.Machine.ExMemory type Rep ExCPU = D1 ('MetaData "ExCPU" "PlutusCore.Evaluation.Machine.ExMemory" "plutus-core-1.39.0.0-inplace" 'True) (C1 ('MetaCons "ExCPU" 'PrefixI 'False) (S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 CostingInteger))) | |
Counts size in machine words.
Constructors
| ExMemory CostingInteger |
Instances
| FromJSON ExMemory | |
Defined in PlutusCore.Evaluation.Machine.ExMemory | |
| ToJSON ExMemory | |
Defined in PlutusCore.Evaluation.Machine.ExMemory Methods toEncoding ∷ ExMemory → Encoding toJSONList ∷ [ExMemory] → Value toEncodingList ∷ [ExMemory] → Encoding | |
| Monoid ExMemory | |
| Semigroup ExMemory | |
| Bounded ExMemory | |
| Generic ExMemory | |
| Num ExMemory | |
Defined in PlutusCore.Evaluation.Machine.ExMemory | |
| Read ExMemory | |
| Show ExMemory | |
| NFData ExMemory | |
Defined in PlutusCore.Evaluation.Machine.ExMemory | |
| Eq ExMemory | |
| Ord ExMemory | |
Defined in PlutusCore.Evaluation.Machine.ExMemory | |
| NoThunks ExMemory | |
| Pretty ExMemory | |
| Serialise ExMemory | |
| PrettyBy config ExMemory | |
| Lift ExMemory | |
| type Rep ExMemory | |
Defined in PlutusCore.Evaluation.Machine.ExMemory type Rep ExMemory = D1 ('MetaData "ExMemory" "PlutusCore.Evaluation.Machine.ExMemory" "plutus-core-1.39.0.0-inplace" 'True) (C1 ('MetaCons "ExMemory" 'PrefixI 'False) (S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 CostingInteger))) | |
Instances
fromSatInt ∷ Num a ⇒ SatInt → a Source #
An optimized version of fromIntegral . unSatInt.
The enumeration of all possible cost model parameter names for this language version.
IMPORTANT: The order of appearance of the data constructors here matters. DO NOT REORDER. See Note [Quotation marks in cost model parameter constructors] See Note [Cost model parameters from the ledger's point of view]
Constructors
Instances
| Bounded ParamName Source # | |
| Enum ParamName Source # | |
Defined in PlutusLedgerApi.V1.ParamName Methods succ ∷ ParamName → ParamName Source # pred ∷ ParamName → ParamName Source # toEnum ∷ Int → ParamName Source # fromEnum ∷ ParamName → Int Source # enumFrom ∷ ParamName → [ParamName] Source # enumFromThen ∷ ParamName → ParamName → [ParamName] Source # enumFromTo ∷ ParamName → ParamName → [ParamName] Source # enumFromThenTo ∷ ParamName → ParamName → ParamName → [ParamName] Source # | |
| Generic ParamName Source # | |
| Ix ParamName Source # | |
Defined in PlutusLedgerApi.V1.ParamName | |
| Eq ParamName Source # | |
| Ord ParamName Source # | |
Defined in PlutusLedgerApi.V1.ParamName | |
| IsParamName ParamName Source # | |
Defined in PlutusLedgerApi.V1.ParamName | |
| type Rep ParamName Source # | |
Defined in PlutusLedgerApi.V1.ParamName type Rep ParamName = D1 ('MetaData "ParamName" "PlutusLedgerApi.V1.ParamName" "plutus-ledger-api-1.39.0.0-inplace" 'False) (((((((C1 ('MetaCons "AddInteger'cpu'arguments'intercept" 'PrefixI 'False) (U1 ∷ Type → Type) :+: C1 ('MetaCons "AddInteger'cpu'arguments'slope" 'PrefixI 'False) (U1 ∷ Type → Type)) :+: (C1 ('MetaCons "AddInteger'memory'arguments'intercept" 'PrefixI 'False) (U1 ∷ Type → Type) :+: (C1 ('MetaCons "AddInteger'memory'arguments'slope" 'PrefixI 'False) (U1 ∷ Type → Type) :+: C1 ('MetaCons "AppendByteString'cpu'arguments'intercept" 'PrefixI 'False) (U1 ∷ Type → Type)))) :+: ((C1 ('MetaCons "AppendByteString'cpu'arguments'slope" 'PrefixI 'False) (U1 ∷ Type → Type) :+: C1 ('MetaCons "AppendByteString'memory'arguments'intercept" 'PrefixI 'False) (U1 ∷ Type → Type)) :+: (C1 ('MetaCons "AppendByteString'memory'arguments'slope" 'PrefixI 'False) (U1 ∷ Type → Type) :+: (C1 ('MetaCons "AppendString'cpu'arguments'intercept" 'PrefixI 'False) (U1 ∷ Type → Type) :+: C1 ('MetaCons "AppendString'cpu'arguments'slope" 'PrefixI 'False) (U1 ∷ Type → Type))))) :+: (((C1 ('MetaCons "AppendString'memory'arguments'intercept" 'PrefixI 'False) (U1 ∷ Type → Type) :+: C1 ('MetaCons "AppendString'memory'arguments'slope" 'PrefixI 'False) (U1 ∷ Type → Type)) :+: (C1 ('MetaCons "BData'cpu'arguments" 'PrefixI 'False) (U1 ∷ Type → Type) :+: (C1 ('MetaCons "BData'memory'arguments" 'PrefixI 'False) (U1 ∷ Type → Type) :+: C1 ('MetaCons "Blake2b_256'cpu'arguments'intercept" 'PrefixI 'False) (U1 ∷ Type → Type)))) :+: ((C1 ('MetaCons "Blake2b_256'cpu'arguments'slope" 'PrefixI 'False) (U1 ∷ Type → Type) :+: C1 ('MetaCons "Blake2b_256'memory'arguments" 'PrefixI 'False) (U1 ∷ Type → Type)) :+: (C1 ('MetaCons "CekApplyCost'exBudgetCPU" 'PrefixI 'False) (U1 ∷ Type → Type) :+: (C1 ('MetaCons "CekApplyCost'exBudgetMemory" 'PrefixI 'False) (U1 ∷ Type → Type) :+: C1 ('MetaCons "CekBuiltinCost'exBudgetCPU" 'PrefixI 'False) (U1 ∷ Type → Type)))))) :+: ((((C1 ('MetaCons "CekBuiltinCost'exBudgetMemory" 'PrefixI 'False) (U1 ∷ Type → Type) :+: C1 ('MetaCons "CekConstCost'exBudgetCPU" 'PrefixI 'False) (U1 ∷ Type → Type)) :+: (C1 ('MetaCons "CekConstCost'exBudgetMemory" 'PrefixI 'False) (U1 ∷ Type → Type) :+: (C1 ('MetaCons "CekDelayCost'exBudgetCPU" 'PrefixI 'False) (U1 ∷ Type → Type) :+: C1 ('MetaCons "CekDelayCost'exBudgetMemory" 'PrefixI 'False) (U1 ∷ Type → Type)))) :+: ((C1 ('MetaCons "CekForceCost'exBudgetCPU" 'PrefixI 'False) (U1 ∷ Type → Type) :+: C1 ('MetaCons "CekForceCost'exBudgetMemory" 'PrefixI 'False) (U1 ∷ Type → Type)) :+: (C1 ('MetaCons "CekLamCost'exBudgetCPU" 'PrefixI 'False) (U1 ∷ Type → Type) :+: (C1 ('MetaCons "CekLamCost'exBudgetMemory" 'PrefixI 'False) (U1 ∷ Type → Type) :+: C1 ('MetaCons "CekStartupCost'exBudgetCPU" 'PrefixI 'False) (U1 ∷ Type → Type))))) :+: (((C1 ('MetaCons "CekStartupCost'exBudgetMemory" 'PrefixI 'False) (U1 ∷ Type → Type) :+: C1 ('MetaCons "CekVarCost'exBudgetCPU" 'PrefixI 'False) (U1 ∷ Type → Type)) :+: (C1 ('MetaCons "CekVarCost'exBudgetMemory" 'PrefixI 'False) (U1 ∷ Type → Type) :+: (C1 ('MetaCons "ChooseData'cpu'arguments" 'PrefixI 'False) (U1 ∷ Type → Type) :+: C1 ('MetaCons "ChooseData'memory'arguments" 'PrefixI 'False) (U1 ∷ Type → Type)))) :+: ((C1 ('MetaCons "ChooseList'cpu'arguments" 'PrefixI 'False) (U1 ∷ Type → Type) :+: (C1 ('MetaCons "ChooseList'memory'arguments" 'PrefixI 'False) (U1 ∷ Type → Type) :+: C1 ('MetaCons "ChooseUnit'cpu'arguments" 'PrefixI 'False) (U1 ∷ Type → Type))) :+: (C1 ('MetaCons "ChooseUnit'memory'arguments" 'PrefixI 'False) (U1 ∷ Type → Type) :+: (C1 ('MetaCons "ConsByteString'cpu'arguments'intercept" 'PrefixI 'False) (U1 ∷ Type → Type) :+: C1 ('MetaCons "ConsByteString'cpu'arguments'slope" 'PrefixI 'False) (U1 ∷ Type → Type))))))) :+: (((((C1 ('MetaCons "ConsByteString'memory'arguments'intercept" 'PrefixI 'False) (U1 ∷ Type → Type) :+: C1 ('MetaCons "ConsByteString'memory'arguments'slope" 'PrefixI 'False) (U1 ∷ Type → Type)) :+: (C1 ('MetaCons "ConstrData'cpu'arguments" 'PrefixI 'False) (U1 ∷ Type → Type) :+: (C1 ('MetaCons "ConstrData'memory'arguments" 'PrefixI 'False) (U1 ∷ Type → Type) :+: C1 ('MetaCons "DecodeUtf8'cpu'arguments'intercept" 'PrefixI 'False) (U1 ∷ Type → Type)))) :+: ((C1 ('MetaCons "DecodeUtf8'cpu'arguments'slope" 'PrefixI 'False) (U1 ∷ Type → Type) :+: C1 ('MetaCons "DecodeUtf8'memory'arguments'intercept" 'PrefixI 'False) (U1 ∷ Type → Type)) :+: (C1 ('MetaCons "DecodeUtf8'memory'arguments'slope" 'PrefixI 'False) (U1 ∷ Type → Type) :+: (C1 ('MetaCons "DivideInteger'cpu'arguments'constant" 'PrefixI 'False) (U1 ∷ Type → Type) :+: C1 ('MetaCons "DivideInteger'cpu'arguments'model'arguments'intercept" 'PrefixI 'False) (U1 ∷ Type → Type))))) :+: (((C1 ('MetaCons "DivideInteger'cpu'arguments'model'arguments'slope" 'PrefixI 'False) (U1 ∷ Type → Type) :+: C1 ('MetaCons "DivideInteger'memory'arguments'intercept" 'PrefixI 'False) (U1 ∷ Type → Type)) :+: (C1 ('MetaCons "DivideInteger'memory'arguments'minimum" 'PrefixI 'False) (U1 ∷ Type → Type) :+: (C1 ('MetaCons "DivideInteger'memory'arguments'slope" 'PrefixI 'False) (U1 ∷ Type → Type) :+: C1 ('MetaCons "EncodeUtf8'cpu'arguments'intercept" 'PrefixI 'False) (U1 ∷ Type → Type)))) :+: ((C1 ('MetaCons "EncodeUtf8'cpu'arguments'slope" 'PrefixI 'False) (U1 ∷ Type → Type) :+: (C1 ('MetaCons "EncodeUtf8'memory'arguments'intercept" 'PrefixI 'False) (U1 ∷ Type → Type) :+: C1 ('MetaCons "EncodeUtf8'memory'arguments'slope" 'PrefixI 'False) (U1 ∷ Type → Type))) :+: (C1 ('MetaCons "EqualsByteString'cpu'arguments'constant" 'PrefixI 'False) (U1 ∷ Type → Type) :+: (C1 ('MetaCons "EqualsByteString'cpu'arguments'intercept" 'PrefixI 'False) (U1 ∷ Type → Type) :+: C1 ('MetaCons "EqualsByteString'cpu'arguments'slope" 'PrefixI 'False) (U1 ∷ Type → Type)))))) :+: ((((C1 ('MetaCons "EqualsByteString'memory'arguments" 'PrefixI 'False) (U1 ∷ Type → Type) :+: C1 ('MetaCons "EqualsData'cpu'arguments'intercept" 'PrefixI 'False) (U1 ∷ Type → Type)) :+: (C1 ('MetaCons "EqualsData'cpu'arguments'slope" 'PrefixI 'False) (U1 ∷ Type → Type) :+: (C1 ('MetaCons "EqualsData'memory'arguments" 'PrefixI 'False) (U1 ∷ Type → Type) :+: C1 ('MetaCons "EqualsInteger'cpu'arguments'intercept" 'PrefixI 'False) (U1 ∷ Type → Type)))) :+: ((C1 ('MetaCons "EqualsInteger'cpu'arguments'slope" 'PrefixI 'False) (U1 ∷ Type → Type) :+: C1 ('MetaCons "EqualsInteger'memory'arguments" 'PrefixI 'False) (U1 ∷ Type → Type)) :+: (C1 ('MetaCons "EqualsString'cpu'arguments'constant" 'PrefixI 'False) (U1 ∷ Type → Type) :+: (C1 ('MetaCons "EqualsString'cpu'arguments'intercept" 'PrefixI 'False) (U1 ∷ Type → Type) :+: C1 ('MetaCons "EqualsString'cpu'arguments'slope" 'PrefixI 'False) (U1 ∷ Type → Type))))) :+: (((C1 ('MetaCons "EqualsString'memory'arguments" 'PrefixI 'False) (U1 ∷ Type → Type) :+: C1 ('MetaCons "FstPair'cpu'arguments" 'PrefixI 'False) (U1 ∷ Type → Type)) :+: (C1 ('MetaCons "FstPair'memory'arguments" 'PrefixI 'False) (U1 ∷ Type → Type) :+: (C1 ('MetaCons "HeadList'cpu'arguments" 'PrefixI 'False) (U1 ∷ Type → Type) :+: C1 ('MetaCons "HeadList'memory'arguments" 'PrefixI 'False) (U1 ∷ Type → Type)))) :+: ((C1 ('MetaCons "IData'cpu'arguments" 'PrefixI 'False) (U1 ∷ Type → Type) :+: (C1 ('MetaCons "IData'memory'arguments" 'PrefixI 'False) (U1 ∷ Type → Type) :+: C1 ('MetaCons "IfThenElse'cpu'arguments" 'PrefixI 'False) (U1 ∷ Type → Type))) :+: (C1 ('MetaCons "IfThenElse'memory'arguments" 'PrefixI 'False) (U1 ∷ Type → Type) :+: (C1 ('MetaCons "IndexByteString'cpu'arguments" 'PrefixI 'False) (U1 ∷ Type → Type) :+: C1 ('MetaCons "IndexByteString'memory'arguments" 'PrefixI 'False) (U1 ∷ Type → Type)))))))) :+: ((((((C1 ('MetaCons "LengthOfByteString'cpu'arguments" 'PrefixI 'False) (U1 ∷ Type → Type) :+: C1 ('MetaCons "LengthOfByteString'memory'arguments" 'PrefixI 'False) (U1 ∷ Type → Type)) :+: (C1 ('MetaCons "LessThanByteString'cpu'arguments'intercept" 'PrefixI 'False) (U1 ∷ Type → Type) :+: (C1 ('MetaCons "LessThanByteString'cpu'arguments'slope" 'PrefixI 'False) (U1 ∷ Type → Type) :+: C1 ('MetaCons "LessThanByteString'memory'arguments" 'PrefixI 'False) (U1 ∷ Type → Type)))) :+: ((C1 ('MetaCons "LessThanEqualsByteString'cpu'arguments'intercept" 'PrefixI 'False) (U1 ∷ Type → Type) :+: C1 ('MetaCons "LessThanEqualsByteString'cpu'arguments'slope" 'PrefixI 'False) (U1 ∷ Type → Type)) :+: (C1 ('MetaCons "LessThanEqualsByteString'memory'arguments" 'PrefixI 'False) (U1 ∷ Type → Type) :+: (C1 ('MetaCons "LessThanEqualsInteger'cpu'arguments'intercept" 'PrefixI 'False) (U1 ∷ Type → Type) :+: C1 ('MetaCons "LessThanEqualsInteger'cpu'arguments'slope" 'PrefixI 'False) (U1 ∷ Type → Type))))) :+: (((C1 ('MetaCons "LessThanEqualsInteger'memory'arguments" 'PrefixI 'False) (U1 ∷ Type → Type) :+: C1 ('MetaCons "LessThanInteger'cpu'arguments'intercept" 'PrefixI 'False) (U1 ∷ Type → Type)) :+: (C1 ('MetaCons "LessThanInteger'cpu'arguments'slope" 'PrefixI 'False) (U1 ∷ Type → Type) :+: (C1 ('MetaCons "LessThanInteger'memory'arguments" 'PrefixI 'False) (U1 ∷ Type → Type) :+: C1 ('MetaCons "ListData'cpu'arguments" 'PrefixI 'False) (U1 ∷ Type → Type)))) :+: ((C1 ('MetaCons "ListData'memory'arguments" 'PrefixI 'False) (U1 ∷ Type → Type) :+: C1 ('MetaCons "MapData'cpu'arguments" 'PrefixI 'False) (U1 ∷ Type → Type)) :+: (C1 ('MetaCons "MapData'memory'arguments" 'PrefixI 'False) (U1 ∷ Type → Type) :+: (C1 ('MetaCons "MkCons'cpu'arguments" 'PrefixI 'False) (U1 ∷ Type → Type) :+: C1 ('MetaCons "MkCons'memory'arguments" 'PrefixI 'False) (U1 ∷ Type → Type)))))) :+: ((((C1 ('MetaCons "MkNilData'cpu'arguments" 'PrefixI 'False) (U1 ∷ Type → Type) :+: C1 ('MetaCons "MkNilData'memory'arguments" 'PrefixI 'False) (U1 ∷ Type → Type)) :+: (C1 ('MetaCons "MkNilPairData'cpu'arguments" 'PrefixI 'False) (U1 ∷ Type → Type) :+: (C1 ('MetaCons "MkNilPairData'memory'arguments" 'PrefixI 'False) (U1 ∷ Type → Type) :+: C1 ('MetaCons "MkPairData'cpu'arguments" 'PrefixI 'False) (U1 ∷ Type → Type)))) :+: ((C1 ('MetaCons "MkPairData'memory'arguments" 'PrefixI 'False) (U1 ∷ Type → Type) :+: C1 ('MetaCons "ModInteger'cpu'arguments'constant" 'PrefixI 'False) (U1 ∷ Type → Type)) :+: (C1 ('MetaCons "ModInteger'cpu'arguments'model'arguments'intercept" 'PrefixI 'False) (U1 ∷ Type → Type) :+: (C1 ('MetaCons "ModInteger'cpu'arguments'model'arguments'slope" 'PrefixI 'False) (U1 ∷ Type → Type) :+: C1 ('MetaCons "ModInteger'memory'arguments'intercept" 'PrefixI 'False) (U1 ∷ Type → Type))))) :+: (((C1 ('MetaCons "ModInteger'memory'arguments'minimum" 'PrefixI 'False) (U1 ∷ Type → Type) :+: C1 ('MetaCons "ModInteger'memory'arguments'slope" 'PrefixI 'False) (U1 ∷ Type → Type)) :+: (C1 ('MetaCons "MultiplyInteger'cpu'arguments'intercept" 'PrefixI 'False) (U1 ∷ Type → Type) :+: (C1 ('MetaCons "MultiplyInteger'cpu'arguments'slope" 'PrefixI 'False) (U1 ∷ Type → Type) :+: C1 ('MetaCons "MultiplyInteger'memory'arguments'intercept" 'PrefixI 'False) (U1 ∷ Type → Type)))) :+: ((C1 ('MetaCons "MultiplyInteger'memory'arguments'slope" 'PrefixI 'False) (U1 ∷ Type → Type) :+: (C1 ('MetaCons "NullList'cpu'arguments" 'PrefixI 'False) (U1 ∷ Type → Type) :+: C1 ('MetaCons "NullList'memory'arguments" 'PrefixI 'False) (U1 ∷ Type → Type))) :+: (C1 ('MetaCons "QuotientInteger'cpu'arguments'constant" 'PrefixI 'False) (U1 ∷ Type → Type) :+: (C1 ('MetaCons "QuotientInteger'cpu'arguments'model'arguments'intercept" 'PrefixI 'False) (U1 ∷ Type → Type) :+: C1 ('MetaCons "QuotientInteger'cpu'arguments'model'arguments'slope" 'PrefixI 'False) (U1 ∷ Type → Type))))))) :+: (((((C1 ('MetaCons "QuotientInteger'memory'arguments'intercept" 'PrefixI 'False) (U1 ∷ Type → Type) :+: C1 ('MetaCons "QuotientInteger'memory'arguments'minimum" 'PrefixI 'False) (U1 ∷ Type → Type)) :+: (C1 ('MetaCons "QuotientInteger'memory'arguments'slope" 'PrefixI 'False) (U1 ∷ Type → Type) :+: (C1 ('MetaCons "RemainderInteger'cpu'arguments'constant" 'PrefixI 'False) (U1 ∷ Type → Type) :+: C1 ('MetaCons "RemainderInteger'cpu'arguments'model'arguments'intercept" 'PrefixI 'False) (U1 ∷ Type → Type)))) :+: ((C1 ('MetaCons "RemainderInteger'cpu'arguments'model'arguments'slope" 'PrefixI 'False) (U1 ∷ Type → Type) :+: C1 ('MetaCons "RemainderInteger'memory'arguments'intercept" 'PrefixI 'False) (U1 ∷ Type → Type)) :+: (C1 ('MetaCons "RemainderInteger'memory'arguments'minimum" 'PrefixI 'False) (U1 ∷ Type → Type) :+: (C1 ('MetaCons "RemainderInteger'memory'arguments'slope" 'PrefixI 'False) (U1 ∷ Type → Type) :+: C1 ('MetaCons "Sha2_256'cpu'arguments'intercept" 'PrefixI 'False) (U1 ∷ Type → Type))))) :+: (((C1 ('MetaCons "Sha2_256'cpu'arguments'slope" 'PrefixI 'False) (U1 ∷ Type → Type) :+: C1 ('MetaCons "Sha2_256'memory'arguments" 'PrefixI 'False) (U1 ∷ Type → Type)) :+: (C1 ('MetaCons "Sha3_256'cpu'arguments'intercept" 'PrefixI 'False) (U1 ∷ Type → Type) :+: (C1 ('MetaCons "Sha3_256'cpu'arguments'slope" 'PrefixI 'False) (U1 ∷ Type → Type) :+: C1 ('MetaCons "Sha3_256'memory'arguments" 'PrefixI 'False) (U1 ∷ Type → Type)))) :+: ((C1 ('MetaCons "SliceByteString'cpu'arguments'intercept" 'PrefixI 'False) (U1 ∷ Type → Type) :+: (C1 ('MetaCons "SliceByteString'cpu'arguments'slope" 'PrefixI 'False) (U1 ∷ Type → Type) :+: C1 ('MetaCons "SliceByteString'memory'arguments'intercept" 'PrefixI 'False) (U1 ∷ Type → Type))) :+: (C1 ('MetaCons "SliceByteString'memory'arguments'slope" 'PrefixI 'False) (U1 ∷ Type → Type) :+: (C1 ('MetaCons "SndPair'cpu'arguments" 'PrefixI 'False) (U1 ∷ Type → Type) :+: C1 ('MetaCons "SndPair'memory'arguments" 'PrefixI 'False) (U1 ∷ Type → Type)))))) :+: ((((C1 ('MetaCons "SubtractInteger'cpu'arguments'intercept" 'PrefixI 'False) (U1 ∷ Type → Type) :+: C1 ('MetaCons "SubtractInteger'cpu'arguments'slope" 'PrefixI 'False) (U1 ∷ Type → Type)) :+: (C1 ('MetaCons "SubtractInteger'memory'arguments'intercept" 'PrefixI 'False) (U1 ∷ Type → Type) :+: (C1 ('MetaCons "SubtractInteger'memory'arguments'slope" 'PrefixI 'False) (U1 ∷ Type → Type) :+: C1 ('MetaCons "TailList'cpu'arguments" 'PrefixI 'False) (U1 ∷ Type → Type)))) :+: ((C1 ('MetaCons "TailList'memory'arguments" 'PrefixI 'False) (U1 ∷ Type → Type) :+: C1 ('MetaCons "Trace'cpu'arguments" 'PrefixI 'False) (U1 ∷ Type → Type)) :+: (C1 ('MetaCons "Trace'memory'arguments" 'PrefixI 'False) (U1 ∷ Type → Type) :+: (C1 ('MetaCons "UnBData'cpu'arguments" 'PrefixI 'False) (U1 ∷ Type → Type) :+: C1 ('MetaCons "UnBData'memory'arguments" 'PrefixI 'False) (U1 ∷ Type → Type))))) :+: (((C1 ('MetaCons "UnConstrData'cpu'arguments" 'PrefixI 'False) (U1 ∷ Type → Type) :+: C1 ('MetaCons "UnConstrData'memory'arguments" 'PrefixI 'False) (U1 ∷ Type → Type)) :+: (C1 ('MetaCons "UnIData'cpu'arguments" 'PrefixI 'False) (U1 ∷ Type → Type) :+: (C1 ('MetaCons "UnIData'memory'arguments" 'PrefixI 'False) (U1 ∷ Type → Type) :+: C1 ('MetaCons "UnListData'cpu'arguments" 'PrefixI 'False) (U1 ∷ Type → Type)))) :+: ((C1 ('MetaCons "UnListData'memory'arguments" 'PrefixI 'False) (U1 ∷ Type → Type) :+: (C1 ('MetaCons "UnMapData'cpu'arguments" 'PrefixI 'False) (U1 ∷ Type → Type) :+: C1 ('MetaCons "UnMapData'memory'arguments" 'PrefixI 'False) (U1 ∷ Type → Type))) :+: (C1 ('MetaCons "VerifyEd25519Signature'cpu'arguments'intercept" 'PrefixI 'False) (U1 ∷ Type → Type) :+: (C1 ('MetaCons "VerifyEd25519Signature'cpu'arguments'slope" 'PrefixI 'False) (U1 ∷ Type → Type) :+: C1 ('MetaCons "VerifyEd25519Signature'memory'arguments" 'PrefixI 'False) (U1 ∷ Type → Type))))))))) | |
tagWithParamNames ∷ ∀ k m. (Enum k, Bounded k, MonadError CostModelApplyError m, MonadWriter [CostModelApplyWarn] m) ⇒ [Int64] → m [(k, Int64)] Source #
Given an ordered list of parameter values, tag them with their parameter names. If the passed parameter values are more than expected: the function will ignore the extraneous values at the tail of the list, if the passed values are less than expected: the function will throw an error; for more information, see Note [Cost model parameters from the ledger's point of view]
Evaluation
data EvaluationError Source #
Errors that can be thrown when evaluating a Plutus script.
Constructors
| CekError !(CekEvaluationException NamedDeBruijn DefaultUni DefaultFun) | An error from the evaluator itself |
| DeBruijnError !FreeVariableError | An error in the pre-evaluation step of converting from de-Bruijn indices |
| CodecError !ScriptDecodeError | A deserialisation error TODO: make this error more informative when we have more information about what went wrong |
| CostModelParameterMismatch | An error indicating that the cost model parameters didn't match what we expected |
| InvalidReturnValue | The script evaluated to a value that is not a valid return value. |
Instances
| Show EvaluationError Source # | |
Defined in PlutusLedgerApi.Common.Eval | |
| Eq EvaluationError Source # | |
Defined in PlutusLedgerApi.Common.Eval Methods | |
| AsScriptDecodeError EvaluationError Source # | |
Defined in PlutusLedgerApi.Common.Eval Methods _ScriptDecodeError ∷ Prism' EvaluationError ScriptDecodeError Source # _CBORDeserialiseError ∷ Prism' EvaluationError DeserialiseFailureInfo Source # _RemainderError ∷ Prism' EvaluationError ByteString Source # _LedgerLanguageNotAvailableError ∷ Prism' EvaluationError (PlutusLedgerLanguage, MajorProtocolVersion, MajorProtocolVersion) Source # _PlutusCoreLanguageNotAvailableError ∷ Prism' EvaluationError (Version, PlutusLedgerLanguage, MajorProtocolVersion) Source # | |
| Pretty EvaluationError Source # | |
Defined in PlutusLedgerApi.Common.Eval | |
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.
Different protocol versions may require different bundles of machine parameters, which allows us for
example to tweak the shape of the costing function of a builtin, so that the builtin costs less.
Currently this means that we have to create multiple DefaultMachineParameters per language
version, which we put into a cache (represented by an association list) in order to avoid costly
recomputation of machine parameters.
In order to get the appropriate DefaultMachineParameters at validation time we look it up in the
cache using a semantics variant as a key. We compute the semantics variant from the protocol
version using the stored function. Note that the semantics variant depends on the language version
too, but the latter is known statically (because each language version has its own evaluation
context), hence there's no reason to require it to be provided at runtime.
To say it differently, there's a matrix of semantics variants indexed by (LL, PV) pairs and we
cache its particular row corresponding to the statically given LL in an EvaluationContext.
The reason why we associate a DefaultMachineParameters with a semantics variant rather than a
protocol version are
- generally there are far more protocol versions than semantics variants supported by a specific language version, so we save on pointless duplication of bundles of machine parameters
- builtins don't know anything about protocol versions, only semantics variants. It is therefore more semantically precise to associate bundles of machine parameters with semantics variants than with protocol versions
Instances
class AsScriptDecodeError r where Source #
Minimal complete definition
Methods
_ScriptDecodeError ∷ Prism' r ScriptDecodeError Source #
_CBORDeserialiseError ∷ Prism' r DeserialiseFailureInfo Source #
_RemainderError ∷ Prism' r ByteString Source #
_LedgerLanguageNotAvailableError ∷ Prism' r (PlutusLedgerLanguage, MajorProtocolVersion, MajorProtocolVersion) Source #
_PlutusCoreLanguageNotAvailableError ∷ Prism' r (Version, PlutusLedgerLanguage, MajorProtocolVersion) Source #
Instances
type LogOutput = [Text] Source #
The type of the executed script's accumulated log output: a list of Text.
It will be an empty list if the VerboseMode is set to Quiet.
data VerboseMode Source #
A simple toggle indicating whether or not we should accumulate logs during script execution.
Instances
| Eq VerboseMode Source # | |
Defined in PlutusLedgerApi.Common.Eval Methods (==) ∷ VerboseMode → VerboseMode → Bool Source # (/=) ∷ VerboseMode → VerboseMode → Bool Source # | |
evaluateTerm ∷ ExBudgetMode cost DefaultUni DefaultFun → MajorProtocolVersion → VerboseMode → EvaluationContext → Term NamedDeBruijn DefaultUni DefaultFun () → (Either (CekEvaluationException NamedDeBruijn DefaultUni DefaultFun) (Term NamedDeBruijn DefaultUni DefaultFun ()), cost, [Text]) Source #
Evaluate a fully-applied term using the CEK machine. Useful for mimicking the behaviour of the on-chain evaluator.
mkDynEvaluationContext ∷ MonadError CostModelApplyError m ⇒ PlutusLedgerLanguage → [BuiltinSemanticsVariant DefaultFun] → (MajorProtocolVersion → BuiltinSemanticsVariant DefaultFun) → CostModelParams → m EvaluationContext Source #
Create an EvaluationContext given all builtin semantics variants supported by the provided
language version.
The input is a Map of Texts to cost integer values (aka CostModelParams, CostModel)
See Note [Inlining meanings of builtins].
IMPORTANT: the toSemVar argument computes the semantics variant for each MajorProtocolVersion
and it must only return semantics variants from the semVars list, as well as cover ANY
MajorProtocolVersion, including those that do not exist yet (i.e. toSemVar must never fail).
IMPORTANT: The evaluation context of every Plutus version must be recreated upon a protocol update with the updated cost model parameters.
Arguments
| ∷ MonadError EvaluationError m | |
| ⇒ PlutusLedgerLanguage | the Plutus ledger language of the script under execution. |
| → MajorProtocolVersion | which major protocol version to run the operation in |
| → ScriptForEvaluation | the script to evaluate |
| → [Data] | the arguments that the script's underlying term will be applied to |
| → m (Term NamedDeBruijn DefaultUni DefaultFun ()) |
Shared helper for the evaluation functions: evaluateScriptCounting and evaluateScriptRestricting,
Given a ScriptForEvaluation:
1) applies the term to a list of Data arguments (e.g. Datum, Redeemer, ScriptContext)
2) checks that the applied-term is well-scoped
3) returns the applied-term
assertWellFormedCostModelParams ∷ MonadError CostModelApplyError m ⇒ CostModelParams → m () Source #
Evaluation context
Arguments
| ∷ (MonadError CostModelApplyError m, MonadWriter [CostModelApplyWarn] m) | |
| ⇒ [Int64] | 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 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]
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
Script Context
A pending transaction. This is the view as seen by validator scripts, so some details are stripped out.
Constructors
| TxInfo | |
Fields
| |
Instances
data ScriptContext Source #
The context that the currently-executing script can access.
Constructors
| ScriptContext | |
Fields
| |
Instances
data ScriptPurpose Source #
Purpose of the script that is currently running
Instances
A transaction ID, i.e. the hash of a transaction. Hashed with BLAKE2b-256. 32 byte.
This is a simple type without any validation, use with caution. You may want to add checks for its invariants. See the Shelley ledger specification.
Constructors
| TxId | |
Fields | |
Instances
A transaction output, consisting of a target address (Address), a value (Value),
and optionally a datum hash (DatumHash).
Constructors
| TxOut | |
Fields | |
Instances
A reference to a transaction output. This is a
pair of a transaction ID (TxId), and an index indicating which of the outputs
of that transaction we are referring to.
Constructors
| TxOutRef | |
Fields
| |
Instances
An input of a pending transaction.
Constructors
| TxInInfo | |
Fields | |
Instances
findOwnInput ∷ ScriptContext → Maybe TxInInfo Source #
Find the input currently being validated.
findDatum ∷ DatumHash → TxInfo → Maybe Datum Source #
Find the data corresponding to a data hash, if there is one
findDatumHash ∷ Datum → TxInfo → Maybe DatumHash Source #
Find the hash of a datum, if it is part of the pending transaction's hashes
findContinuingOutputs ∷ ScriptContext → [Integer] Source #
Finds all the outputs that pay to the same script address that we are currently spending from, if any.
getContinuingOutputs ∷ ScriptContext → [TxOut] Source #
Get all the outputs that pay to the same script address we are currently spending from, if any.
pubKeyOutputsAt ∷ PubKeyHash → TxInfo → [Value] Source #
Get the values paid to a public key address by a pending transaction.
valuePaidTo ∷ TxInfo → PubKeyHash → Value Source #
Get the total value paid to a public key address by a pending transaction.
spendsOutput ∷ TxInfo → TxId → Integer → Bool Source #
Check if the pending transaction spends a specific transaction output (identified by the hash of a transaction and an index into that transactions' outputs)
txSignedBy ∷ TxInfo → PubKeyHash → Bool Source #
Check if a transaction was signed by the given public key.
valueSpent ∷ TxInfo → Value Source #
Get the total value of inputs spent by this transaction.
valueProduced ∷ TxInfo → Value Source #
Get the total value of outputs produced by this transaction.
ownCurrencySymbol ∷ ScriptContext → CurrencySymbol Source #
The CurrencySymbol of the current validator script.
Builtins
data BuiltinByteString Source #
An opaque type representing Plutus Core ByteStrings.
Instances
toBuiltin ∷ HasToBuiltin a ⇒ a → ToBuiltin a Source #
fromBuiltin ∷ HasFromBuiltin arep ⇒ arep → FromBuiltin arep Source #
toOpaque ∷ HasToOpaque a arep ⇒ a → arep Source #
fromOpaque ∷ HasFromOpaque arep a ⇒ arep → a Source #
Bytes
newtype LedgerBytes Source #
Constructors
| LedgerBytes | |
Fields | |
Instances
data LedgerBytesError Source #
An error that is encountered when converting a ByteString to a LedgerBytes.
Constructors
| UnpairedDigit | Odd number of bytes in the original bytestring. |
| NotHexit !Char | A non-hex digit character ([^A-Fa-f0-9]) encountered during decoding. |
Instances
| Exception LedgerBytesError Source # | |
Defined in PlutusLedgerApi.V1.Bytes | |
| Show LedgerBytesError Source # | |
Defined in PlutusLedgerApi.V1.Bytes | |
fromBytes ∷ ByteString → LedgerBytes Source #
Lift a Haskell bytestring to the Plutus abstraction LedgerBytes
fromHex ∷ ByteString → Either LedgerBytesError LedgerBytes Source #
Convert a hex-encoded (Base16) ByteString to a LedgerBytes.
May return an error (LedgerBytesError).
bytes ∷ LedgerBytes → ByteString Source #
Extract the Haskell bytestring from inside the Plutus opaque LedgerBytes.
encodeByteString ∷ ByteString → Text Source #
Encode a ByteString value to Base16 (i.e. hexadecimal), then
decode with UTF-8 to a Text.
Certificates
A representation of the ledger DCert. Some information is digested, and not included
Constructors
| DCertDelegRegKey StakingCredential | |
| DCertDelegDeRegKey StakingCredential | |
| DCertDelegDelegate | |
Fields
| |
| DCertPoolRegister | A digest of the PoolParams |
Fields
| |
| DCertPoolRetire PubKeyHash Integer | The retirement certificate and the Epoch in which the retirement will take place |
| DCertGenesis | A really terse Digest |
| DCertMir | Another really terse Digest |
Instances
Credentials
data StakingCredential Source #
Staking credential used to assign rewards.
Constructors
| StakingHash Credential | The staking hash is the |
| StakingPtr | The certificate pointer, constructed by the given
slot number, transaction and certificate indices.
NB: The fields should really be all |
Instances
data Credential Source #
Credentials required to unlock a transaction output.
Constructors
| PubKeyCredential PubKeyHash | The transaction that spends this output must be signed by the private key.
See |
| ScriptCredential ScriptHash | The transaction that spends this output must include the validator script and
be accepted by the validator. See |
Instances
Value
The Value type represents a collection of amounts of different currencies.
We can think of Value as a vector space whose dimensions are currencies.
Operations on currencies are usually implemented pointwise. That is,
we apply the operation to the quantities for each currency in turn. So
when we add two Values the resulting Value has, for each currency,
the sum of the quantities of that particular currency in the argument
Value. The effect of this is that the currencies in the Value are "independent",
and are operated on separately.
Whenever we need to get the quantity of a currency in a Value where there
is no explicit quantity of that currency in the Value, then the quantity is
taken to be zero.
There is no 'Ord Value' instance since Value is only a partial order, so compare can't
do the right thing in some cases.
Instances
Constructors
| Lovelace | |
Fields | |
Instances
currencySymbolValueOf ∷ Value → CurrencySymbol → Integer Source #
Get the total value of the currency symbol in the Value map.
Assumes that the underlying map doesn't contain duplicate keys.
Note that each token of the currency symbol may have a value that is positive, zero or negative.
flattenValue ∷ Value → [(CurrencySymbol, TokenName, Integer)] Source #
singleton ∷ CurrencySymbol → TokenName → Integer → Value Source #
Make a Value containing only the given quantity of the given currency.
unionWith ∷ (Integer → Integer → Integer) → Value → Value → Value Source #
Combine two Value maps with the argument function.
Assumes the well-definedness of the two maps.
valueOf ∷ Value → CurrencySymbol → TokenName → Integer Source #
Get the quantity of the given currency in the Value.
Assumes that the underlying map doesn't contain duplicate keys.
Currency symbols
newtype CurrencySymbol Source #
ByteString representing the currency, hashed with BLAKE2b-224.
It is empty for Ada, 28 bytes for MintingPolicyHash.
Forms an AssetClass along with TokenName.
A Value is a map from CurrencySymbol's to a map from TokenName to an Integer.
This is a simple type without any validation, use with caution. You may want to add checks for its invariants. See the Shelley ledger specification.
Constructors
| CurrencySymbol | |
Fields | |
Instances
currencySymbol ∷ ByteString → CurrencySymbol Source #
Creates CurrencySymbol from raw ByteString.
adaSymbol ∷ CurrencySymbol Source #
The CurrencySymbol of the Ada currency.
symbols ∷ Value → [CurrencySymbol] Source #
The list of CurrencySymbols of a Value.
Token names
ByteString of a name of a token.
Shown as UTF-8 string when possible.
Should be no longer than 32 bytes, empty for Ada.
Forms an AssetClass along with a CurrencySymbol.
This is a simple type without any validation, use with caution. You may want to add checks for its invariants. See the Shelley ledger specification.
Constructors
| TokenName | |
Fields | |
Instances
tokenName ∷ ByteString → TokenName Source #
Creates TokenName from raw ByteString.
Asset classes
newtype AssetClass Source #
An asset class, identified by a CurrencySymbol and a TokenName.
Constructors
| AssetClass | |
Fields | |
Instances
assetClass ∷ CurrencySymbol → TokenName → AssetClass Source #
The curried version of AssetClass constructor
assetClassValue ∷ AssetClass → Integer → Value Source #
A Value containing the given amount of the asset class.
assetClassValueOf ∷ Value → AssetClass → Integer Source #
Get the quantity of the given AssetClass class in the Value.
Addresses
An address may contain two credentials,
the payment credential and optionally a StakingCredential.
Constructors
| Address | |
Fields
| |
Instances
pubKeyHashAddress ∷ PubKeyHash → Address Source #
The address that should be targeted by a transaction output locked by the public key with the given hash.
toPubKeyHash ∷ Address → Maybe PubKeyHash Source #
The PubKeyHash of the address, if any
toScriptHash ∷ Address → Maybe ScriptHash Source #
The validator hash of the address, if any
scriptHashAddress ∷ ScriptHash → Address Source #
The address that should be used by a transaction output locked by the given validator script hash.
stakingCredential ∷ Address → Maybe StakingCredential Source #
The staking credential of an address (if any)
Crypto
newtype PubKeyHash Source #
The hash of a public key. This is frequently used to identify the public key, rather than the key itself. Hashed with BLAKE2b-224. 28 bytes.
This is a simple type without any validation, use with caution. You may want to add checks for its invariants. See the Shelley ledger specification.
Constructors
| PubKeyHash | |
Fields | |
Instances
Time
POSIX time is measured as the number of milliseconds since 1970-01-01T00:00:00Z.
This is not the same as Haskell's POSIXTime
Constructors
| POSIXTime | |
Fields | |
Instances
newtype DiffMilliSeconds Source #
This is a length of time, as measured by a number of milliseconds.
Constructors
| DiffMilliSeconds Integer |
Instances
fromMilliSeconds ∷ DiffMilliSeconds → POSIXTime Source #
Simple conversion from DiffMilliSeconds to POSIXTime.
Intervals
An interval of as.
The interval may be either closed or open at either end, meaning that the endpoints may or may not be included in the interval.
The interval can also be unbounded on either side.
The Eq instance gives equality of the intervals, not structural equality.
There is no Ord instance, but contains gives a partial order.
Note that some of the functions on Interval rely on Enum in order to
handle non-inclusive endpoints. For this reason, it may not be safe to
use Intervals with non-inclusive endpoints on types whose Enum
instances have partial methods.
Constructors
| Interval | |
Fields
| |
Instances
A set extended with a positive and negative infinity.
Instances
data UpperBound a Source #
The upper bound of an interval.
Constructors
| UpperBound (Extended a) Closure |
Instances
data LowerBound a Source #
The lower bound of an interval.
Constructors
| LowerBound (Extended a) Closure |
Instances
from ∷ a → Interval a Source #
from a is an Interval that includes all values that are
greater than or equal to a. In math. notation: [a,+∞]
to a is an Interval that includes all values that are
smaller than or equal to a. In math. notation: [-∞,a]
lowerBound ∷ a → LowerBound a Source #
Construct a lower bound from a value. The resulting bound includes all values that are equal or greater than the input value.
upperBound ∷ a → UpperBound a Source #
Construct an upper bound from a value. The resulting bound includes all values that are equal or smaller than the input value.
strictLowerBound ∷ a → LowerBound a Source #
Construct a strict lower bound from a value. The resulting bound includes all values that are (strictly) greater than the input value.
strictUpperBound ∷ a → UpperBound a Source #
Construct a strict upper bound from a value. The resulting bound includes all values that are (strictly) smaller than the input value.
interval ∷ a → a → Interval a Source #
interval a b includes all values that are greater than or equal to a
and smaller than or equal to b. Therefore it includes a and b. In math. notation: [a,b]
hull ∷ (Enum a, Ord a) ⇒ Interval a → Interval a → Interval a Source #
'hull a b' is the smallest interval containing a and b.
intersection ∷ (Enum a, Ord a) ⇒ Interval a → Interval a → Interval a Source #
'intersection a b' is the largest interval that is contained in a and in
b, if it exists.
overlaps ∷ (Enum a, Ord a) ⇒ Interval a → Interval a → Bool Source #
Check whether two intervals overlap, that is, whether there is a value that is a member of both intervals.
before ∷ (Enum a, Ord a) ⇒ a → Interval a → Bool Source #
Check if a value is earlier than the beginning of an Interval.
after ∷ (Enum a, Ord a) ⇒ a → Interval a → Bool Source #
Check if a value is later than the end of an Interval.
Data
A generic "data" type.
The main constructor Constr represents a datatype value in sum-of-products
form: Constr i args represents a use of the ith constructor along with its arguments.
The other constructors are various primitives.
Instances
data BuiltinData Source #
A type corresponding to the Plutus Core builtin equivalent of Data.
The point of this type is to be an opaque equivalent of Data, so as to
ensure that it is only used in ways that the compiler can handle.
As such, you should use this type in your on-chain code, and in any data structures that you want to be representable on-chain.
For off-chain usage, there are conversion functions builtinDataToData and
dataToBuiltinData, but note that these will not work on-chain.
Constructors
| BuiltinData ~Data |
Instances
A typeclass for types that can be converted to and from BuiltinData.
Instances
class FromData a where Source #
Methods
fromBuiltinData ∷ BuiltinData → Maybe a Source #
Convert a value from BuiltinData, returning Nothing if this fails.
Instances
class UnsafeFromData a where Source #
Methods
unsafeFromBuiltinData ∷ BuiltinData → a Source #
Convert a value from BuiltinData, calling error if this fails.
This is typically much faster than fromBuiltinData.
When implementing this function, make sure to call unsafeFromBuiltinData
rather than fromBuiltinData when converting substructures!
This is a simple type without any validation, use with caution.
Instances
unsafeFromData ∷ UnsafeFromData a ⇒ Data → a Source #
Convert a value from Data, throwing if this fails.
dataToBuiltinData ∷ Data → BuiltinData Source #
Convert a Data into a BuiltinData. Only works off-chain.
builtinDataToData ∷ BuiltinData → Data Source #
Convert a BuiltinData into a Data. Only works off-chain.
Errors
class Monad m ⇒ MonadError e (m ∷ Type → Type) | m → e Source #
The strategy of combining computations that can throw exceptions by bypassing bound functions from the point an exception is thrown to the point that it is handled.
Is parameterized over the type of error information and
the monad type constructor.
It is common to use Either StringMonadError class.
You can also define your own error type and/or use a monad type constructor
other than Either StringEither IOErrorMonadError
class.
(If you are using the deprecated Control.Monad.Error or
Control.Monad.Trans.Error, you may also have to define an Error instance.)
Minimal complete definition
Instances
| MonadError IOException IO | |
Defined in Control.Monad.Error.Class Methods throwError ∷ IOException → IO a Source # catchError ∷ IO a → (IOException → IO a) → IO a Source # | |
| MonadError BuiltinError BuiltinResult |
|
Defined in PlutusCore.Builtin.Result Methods throwError ∷ BuiltinError → BuiltinResult a Source # catchError ∷ BuiltinResult a → (BuiltinError → BuiltinResult a) → BuiltinResult a Source # | |
| MonadError () EvaluationResult | |
Defined in PlutusCore.Evaluation.Result Methods throwError ∷ () → EvaluationResult a Source # catchError ∷ EvaluationResult a → (() → EvaluationResult a) → EvaluationResult a Source # | |
| MonadError () Maybe | Since: mtl-2.2.2 |
Defined in Control.Monad.Error.Class | |
| MonadError e (Either e) | |
Defined in Control.Monad.Error.Class Methods throwError ∷ e → Either e a Source # catchError ∷ Either e a → (e → Either e a) → Either e a Source # | |
| MonadError e m ⇒ MonadError e (Free m) | |
Defined in Control.Monad.Free | |
| MonadError e m ⇒ MonadError e (GenT m) | |
Defined in Hedgehog.Internal.Gen | |
| MonadError e m ⇒ MonadError e (PropertyT m) | |
Defined in Hedgehog.Internal.Property Methods throwError ∷ e → PropertyT m a Source # catchError ∷ PropertyT m a → (e → PropertyT m a) → PropertyT m a Source # | |
| MonadError e m ⇒ MonadError e (TestT m) | |
Defined in Hedgehog.Internal.Property Methods throwError ∷ e → TestT m a Source # catchError ∷ TestT m a → (e → TestT m a) → TestT m a Source # | |
| MonadError e m ⇒ MonadError e (TreeT m) | |
Defined in Hedgehog.Internal.Tree Methods throwError ∷ e → TreeT m a Source # catchError ∷ TreeT m a → (e → TreeT m a) → TreeT m a Source # | |
| MonadError e m ⇒ MonadError e (ListT m) | |
Defined in ListT Methods throwError ∷ e → ListT m a Source # catchError ∷ ListT m a → (e → ListT m a) → ListT m a Source # | |
| MonadError e m ⇒ MonadError e (QuoteT m) | |
Defined in PlutusCore.Quote Methods throwError ∷ e → QuoteT m a Source # catchError ∷ QuoteT m a → (e → QuoteT m a) → QuoteT m a Source # | |
| MonadError e m ⇒ MonadError e (ResourceT m) | |
Defined in Control.Monad.Trans.Resource.Internal Methods throwError ∷ e → ResourceT m a Source # catchError ∷ ResourceT m a → (e → ResourceT m a) → ResourceT m a Source # | |
| MonadError e m ⇒ MonadError e (MaybeT m) | |
Defined in Control.Monad.Error.Class Methods throwError ∷ e → MaybeT m a Source # catchError ∷ MaybeT m a → (e → MaybeT m a) → MaybeT m a Source # | |
| (Functor f, MonadError e m) ⇒ MonadError e (FreeT f m) | |
Defined in Control.Monad.Trans.Free Methods throwError ∷ e → FreeT f m a Source # catchError ∷ FreeT f m a → (e → FreeT f m a) → FreeT f m a Source # | |
| (Monoid w, MonadError e m) ⇒ MonadError e (AccumT w m) | Since: mtl-2.3 |
Defined in Control.Monad.Error.Class Methods throwError ∷ e → AccumT w m a Source # catchError ∷ AccumT w m a → (e → AccumT w m a) → AccumT w m a Source # | |
| Monad m ⇒ MonadError e (ExceptT e m) | Since: mtl-2.2 |
Defined in Control.Monad.Error.Class Methods throwError ∷ e → ExceptT e m a Source # catchError ∷ ExceptT e m a → (e → ExceptT e m a) → ExceptT e m a Source # | |
| MonadError e m ⇒ MonadError e (IdentityT m) | |
Defined in Control.Monad.Error.Class Methods throwError ∷ e → IdentityT m a Source # catchError ∷ IdentityT m a → (e → IdentityT m a) → IdentityT m a Source # | |
| MonadError e m ⇒ MonadError e (ReaderT r m) | |
Defined in Control.Monad.Error.Class Methods throwError ∷ e → ReaderT r m a Source # catchError ∷ ReaderT r m a → (e → ReaderT r m a) → ReaderT r m a Source # | |
| MonadError e m ⇒ MonadError e (StateT s m) | |
Defined in Control.Monad.Error.Class Methods throwError ∷ e → StateT s m a Source # catchError ∷ StateT s m a → (e → StateT s m a) → StateT s m a Source # | |
| MonadError e m ⇒ MonadError e (StateT s m) | |
Defined in Control.Monad.Error.Class Methods throwError ∷ e → StateT s m a Source # catchError ∷ StateT s m a → (e → StateT s m a) → StateT s m a Source # | |
| (Monoid w, MonadError e m) ⇒ MonadError e (WriterT w m) | Since: mtl-2.3 |
Defined in Control.Monad.Error.Class Methods throwError ∷ e → WriterT w m a Source # catchError ∷ WriterT w m a → (e → WriterT w m a) → WriterT w m a Source # | |
| (Monoid w, MonadError e m) ⇒ MonadError e (WriterT w m) | |
Defined in Control.Monad.Error.Class Methods throwError ∷ e → WriterT w m a Source # catchError ∷ WriterT w m a → (e → WriterT w m a) → WriterT w m a Source # | |
| (Monoid w, MonadError e m) ⇒ MonadError e (WriterT w m) | |
Defined in Control.Monad.Error.Class Methods throwError ∷ e → WriterT w m a Source # catchError ∷ WriterT w m a → (e → WriterT w m a) → WriterT w m a Source # | |
| (Monoid w, MonadError e m) ⇒ MonadError e (RWST r w s m) | Since: mtl-2.3 |
Defined in Control.Monad.Error.Class Methods throwError ∷ e → RWST r w s m a Source # catchError ∷ RWST r w s m a → (e → RWST r w s m a) → RWST r w s m a Source # | |
| (Monoid w, MonadError e m) ⇒ MonadError e (RWST r w s m) | |
Defined in Control.Monad.Error.Class Methods throwError ∷ e → RWST r w s m a Source # catchError ∷ RWST r w s m a → (e → RWST r w s m a) → RWST r w s m a Source # | |
| (Monoid w, MonadError e m) ⇒ MonadError e (RWST r w s m) | |
Defined in Control.Monad.Error.Class Methods throwError ∷ e → RWST r w s m a Source # catchError ∷ RWST r w s m a → (e → RWST r w s m a) → RWST r w s m a Source # | |
| MonadError e m ⇒ MonadError e (DefT key uni fun ann m) | |
Defined in PlutusIR.Compiler.Definitions Methods throwError ∷ e → DefT key uni fun ann m a Source # catchError ∷ DefT key uni fun ann m a → (e → DefT key uni fun ann m a) → DefT key uni fun ann m a Source # | |
| ThrowableBuiltins uni fun ⇒ MonadError (CekEvaluationException NamedDeBruijn uni fun) (CekM uni fun s) | |
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 # | |