| Safe Haskell | None |
|---|---|
| Language | Haskell2010 |
Plutus.V1.Ledger.Api
Description
The interface to Plutus V1 for the ledger.
Synopsis
- type SerializedScript = ShortByteString
- data Script
- fromCompiledCode :: CompiledCode a -> Script
- isScriptWellFormed :: ProtocolVersion -> SerializedScript -> Bool
- evaluateScriptRestricting :: ProtocolVersion -> VerboseMode -> EvaluationContext -> ExBudget -> SerializedScript -> [ Data ] -> ( LogOutput , Either EvaluationError ExBudget )
- evaluateScriptCounting :: ProtocolVersion -> VerboseMode -> EvaluationContext -> SerializedScript -> [ Data ] -> ( LogOutput , Either EvaluationError ExBudget )
- data ProtocolVersion = ProtocolVersion { }
- data VerboseMode
- type LogOutput = [ Text ]
- data ExBudget = ExBudget { }
- newtype ExCPU = ExCPU CostingInteger
- newtype ExMemory = ExMemory CostingInteger
- data SatInt
- data EvaluationContext
- mkEvaluationContext :: MonadError CostModelApplyError m => CostModelParams -> m EvaluationContext
- data CostModelApplyError
- type CostModelParams = Map Text Integer
- assertWellFormedCostModelParams :: MonadError CostModelApplyError m => CostModelParams -> m ()
- costModelParamNames :: Set Text
- data ScriptContext = ScriptContext { }
- data ScriptPurpose
- data BuiltinByteString
- toBuiltin :: ToBuiltin a arep => a -> arep
- fromBuiltin :: FromBuiltin arep a => arep -> a
- newtype LedgerBytes = LedgerBytes { }
- fromBytes :: ByteString -> LedgerBytes
- data DCert
- data StakingCredential
- data Credential
- newtype Value = Value { }
- newtype CurrencySymbol = CurrencySymbol { }
- newtype TokenName = TokenName { }
- singleton :: CurrencySymbol -> TokenName -> Integer -> Value
- unionWith :: ( Integer -> Integer -> Integer ) -> Value -> Value -> Value
- adaSymbol :: CurrencySymbol
- adaToken :: TokenName
- newtype POSIXTime = POSIXTime { }
- type POSIXTimeRange = Interval POSIXTime
- data Address = Address { }
- newtype PubKeyHash = PubKeyHash { }
- newtype TxId = TxId { }
-
data
TxInfo
=
TxInfo
{
- txInfoInputs :: [ TxInInfo ]
- txInfoOutputs :: [ TxOut ]
- txInfoFee :: Value
- txInfoMint :: Value
- txInfoDCert :: [ DCert ]
- txInfoWdrl :: [( StakingCredential , Integer )]
- txInfoValidRange :: POSIXTimeRange
- txInfoSignatories :: [ PubKeyHash ]
- txInfoData :: [( DatumHash , Datum )]
- txInfoId :: TxId
- data TxOut = TxOut { }
-
data
TxOutRef
=
TxOutRef
{
- txOutRefId :: TxId
- txOutRefIdx :: Integer
- data TxInInfo = TxInInfo { }
-
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
- 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
- newtype Validator = Validator { }
- mkValidatorScript :: CompiledCode ( BuiltinData -> BuiltinData -> BuiltinData -> ()) -> Validator
- unValidatorScript :: Validator -> Script
- newtype ValidatorHash = ValidatorHash BuiltinByteString
- newtype MintingPolicy = MintingPolicy { }
- mkMintingPolicyScript :: CompiledCode ( BuiltinData -> BuiltinData -> ()) -> MintingPolicy
- unMintingPolicyScript :: MintingPolicy -> Script
- newtype MintingPolicyHash = MintingPolicyHash BuiltinByteString
- newtype StakeValidator = StakeValidator { }
- mkStakeValidatorScript :: CompiledCode ( BuiltinData -> BuiltinData -> ()) -> StakeValidator
- unStakeValidatorScript :: StakeValidator -> Script
- newtype StakeValidatorHash = StakeValidatorHash BuiltinByteString
- newtype Redeemer = Redeemer { }
- newtype RedeemerHash = RedeemerHash BuiltinByteString
- newtype Datum = Datum { }
- newtype DatumHash = DatumHash BuiltinByteString
- 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
- unsafeFromBuiltinData :: BuiltinData -> a
- toData :: ToData a => a -> Data
- fromData :: FromData a => Data -> Maybe a
- dataToBuiltinData :: Data -> BuiltinData
- builtinDataToData :: BuiltinData -> Data
- data EvaluationError
Scripts
type SerializedScript = ShortByteString Source #
Scripts to the ledger are serialised bytestrings.
A script on the chain. This is an opaque type as far as the chain is concerned.
Instances
| Eq Script Source # |
Note [Using Flat inside CBOR instance of Script] `plutus-ledger` uses CBOR for data serialisation and `plutus-core` uses Flat. The choice to use Flat was made to have a more efficient (most wins are in uncompressed size) data serialisation format and use less space on-chain. To make `plutus-ledger` work with scripts serialised with Flat, and keep the CBOR format otherwise we have defined a Serialise instance for Script, which is a wrapper over Programs serialised with Flat. The instance will see programs as an opaque ByteString, which is the result of encoding programs using Flat. Because Flat is not self-describing and it gets used in the encoding of Programs, data structures that include scripts (for example, transactions) no-longer benefit for CBOR's ability to self-describe it's format. |
| Ord Script Source # | |
|
Defined in Plutus.V1.Ledger.Scripts |
|
| Show Script Source # | |
| Generic Script Source # | |
| NFData Script Source # | |
|
Defined in Plutus.V1.Ledger.Scripts |
|
| Serialise Script Source # | |
| type Rep Script Source # | |
|
Defined in Plutus.V1.Ledger.Scripts
type
Rep
Script
=
D1
('
MetaData
"Script" "Plutus.V1.Ledger.Scripts" "plutus-ledger-api-1.0.0.1-GlUFhIIE0LJGuJDDdHh5lQ" '
True
) (
C1
('
MetaCons
"Script" '
PrefixI
'
True
) (
S1
('
MetaSel
('
Just
"unScript") '
NoSourceUnpackedness
'
NoSourceStrictness
'
DecidedLazy
) (
Rec0
(
Program
DeBruijn
DefaultUni
DefaultFun
()))))
|
|
fromCompiledCode :: CompiledCode a -> Script Source #
Turn a
CompiledCode
(usually produced by
compile
) into a
Script
for use with this package.
Validating scripts
isScriptWellFormed :: ProtocolVersion -> SerializedScript -> Bool Source #
Check if a
Script
is "valid" according to a protocol version. At the moment this means "deserialises correctly", which in particular
implies that it is (almost certainly) an encoded script and the script does not mention any builtins unavailable in the given protocol version.
Running scripts
evaluateScriptRestricting Source #
Arguments
| :: ProtocolVersion | |
| -> VerboseMode |
Whether to produce log output |
| -> EvaluationContext |
The cost model that should already be synced to the most recent cost-model-params coming from the current protocol |
| -> ExBudget |
The resource budget which must not be exceeded during evaluation |
| -> SerializedScript |
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
| :: ProtocolVersion | |
| -> VerboseMode |
Whether to produce log output |
| -> EvaluationContext |
The cost model that should already be synced to the most recent cost-model-params coming from the current protocol |
| -> SerializedScript |
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
data ProtocolVersion Source #
This represents the Cardano protocol version, with its major and minor components. This relies on careful understanding between us and the ledger as to what this means.
Constructors
| ProtocolVersion | |
Instances
| Eq ProtocolVersion Source # | |
|
Defined in Plutus.ApiCommon Methods (==) :: ProtocolVersion -> ProtocolVersion -> Bool Source # (/=) :: ProtocolVersion -> ProtocolVersion -> Bool Source # |
|
| Ord ProtocolVersion Source # | |
|
Defined in Plutus.ApiCommon Methods compare :: ProtocolVersion -> ProtocolVersion -> Ordering Source # (<) :: ProtocolVersion -> ProtocolVersion -> Bool Source # (<=) :: ProtocolVersion -> ProtocolVersion -> Bool Source # (>) :: ProtocolVersion -> ProtocolVersion -> Bool Source # (>=) :: ProtocolVersion -> ProtocolVersion -> Bool Source # max :: ProtocolVersion -> ProtocolVersion -> ProtocolVersion Source # min :: ProtocolVersion -> ProtocolVersion -> ProtocolVersion Source # |
|
| Show ProtocolVersion Source # | |
|
Defined in Plutus.ApiCommon |
|
| Pretty ProtocolVersion Source # | |
|
Defined in Plutus.ApiCommon Methods pretty :: ProtocolVersion -> Doc ann Source # prettyList :: [ ProtocolVersion ] -> Doc ann Source # |
|
Verbose mode and log output
data VerboseMode Source #
A simple toggle indicating whether or not we should produce logs.
Instances
| Eq VerboseMode Source # | |
|
Defined in Plutus.ApiCommon Methods (==) :: VerboseMode -> VerboseMode -> Bool Source # (/=) :: VerboseMode -> VerboseMode -> Bool Source # |
|
Costing-related types
Constructors
| ExBudget | |
|
Fields |
|
Instances
| Eq ExBudget | |
| Show ExBudget | |
| Generic ExBudget | |
| Semigroup ExBudget | |
| Monoid ExBudget | |
| ToJSON ExBudget | |
| FromJSON ExBudget | |
| NFData ExBudget | |
|
Defined in PlutusCore.Evaluation.Machine.ExBudget |
|
| NoThunks ExBudget | |
| Pretty ExBudget | |
| Lift ExBudget | |
| PrettyBy config ExBudget | |
| type Rep ExBudget | |
|
Defined in PlutusCore.Evaluation.Machine.ExBudget
type
Rep
ExBudget
=
D1
('
MetaData
"ExBudget" "PlutusCore.Evaluation.Machine.ExBudget" "plutus-core-1.0.0.1-76bWF9ZEWyb4eDyjHx0kCS" '
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
| Eq ExCPU | |
| Num ExCPU | |
|
Defined in PlutusCore.Evaluation.Machine.ExMemory |
|
| Ord ExCPU | |
|
Defined in PlutusCore.Evaluation.Machine.ExMemory |
|
| Show ExCPU | |
| Generic ExCPU | |
| Semigroup ExCPU | |
| Monoid ExCPU | |
| ToJSON ExCPU | |
| FromJSON ExCPU | |
| NFData ExCPU | |
|
Defined in PlutusCore.Evaluation.Machine.ExMemory |
|
| NoThunks ExCPU | |
| Pretty ExCPU | |
| Lift ExCPU | |
| PrettyBy config ExCPU | |
| type Rep ExCPU | |
|
Defined in PlutusCore.Evaluation.Machine.ExMemory
type
Rep
ExCPU
=
D1
('
MetaData
"ExCPU" "PlutusCore.Evaluation.Machine.ExMemory" "plutus-core-1.0.0.1-76bWF9ZEWyb4eDyjHx0kCS" '
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
Instances
Cost model
data EvaluationContext Source #
An opaque type that contains all the static parameters that the evaluator needs to evaluate a script. This is so that they can be computed once and cached, rather than recomputed on every evaluation.
There are two sets of parameters: one is with immediate unlifting and the other one is with deferred unlifting. We have to keep both of them, because depending on the language version either one has to be used or the other. We also compile them separately due to all the inlining and optimization that need to happen for things to be efficient.
Instances
| Generic EvaluationContext Source # | |
|
Defined in Plutus.ApiCommon Methods from :: EvaluationContext -> Rep EvaluationContext x Source # to :: Rep EvaluationContext x -> EvaluationContext Source # |
|
| NFData EvaluationContext Source # | |
|
Defined in Plutus.ApiCommon Methods rnf :: EvaluationContext -> () Source # |
|
| NoThunks EvaluationContext Source # | |
|
Defined in Plutus.ApiCommon |
|
| type Rep EvaluationContext Source # | |
|
Defined in Plutus.ApiCommon
type
Rep
EvaluationContext
=
D1
('
MetaData
"EvaluationContext" "Plutus.ApiCommon" "plutus-ledger-api-1.0.0.1-GlUFhIIE0LJGuJDDdHh5lQ" '
False
) (
C1
('
MetaCons
"EvaluationContext" '
PrefixI
'
True
) (
S1
('
MetaSel
('
Just
"machineParametersImmediate") '
NoSourceUnpackedness
'
NoSourceStrictness
'
DecidedStrict
) (
Rec0
DefaultMachineParameters
)
:*:
S1
('
MetaSel
('
Just
"machineParametersDeferred") '
NoSourceUnpackedness
'
NoSourceStrictness
'
DecidedStrict
) (
Rec0
DefaultMachineParameters
)))
|
|
mkEvaluationContext :: MonadError CostModelApplyError m => CostModelParams -> m EvaluationContext Source #
Build the
EvaluationContext
.
The input is a
Map
of strings to cost integer values (aka
CostModelParams
,
CostModel
)
See Note [Inlining meanings of builtins].
data CostModelApplyError Source #
The type of errors that
applyParams
can throw.
Constructors
| CMUnknownParamError Text |
a costmodel parameter with the give name does not exist in the costmodel to be applied upon |
| CMInternalReadError |
internal error when we are transforming the applyParams' input to json (should not happen) |
| CMInternalWriteError String |
internal error when we are transforming the applied params from json with given jsonstring error (should not happen) |
Instances
| Show CostModelApplyError | |
|
|
|
| Exception CostModelApplyError | |
|
Defined in PlutusCore.Evaluation.Machine.CostModelInterface Methods toException :: CostModelApplyError -> SomeException Source # fromException :: SomeException -> Maybe CostModelApplyError Source # |
|
| Pretty CostModelApplyError | |
|
Defined in PlutusCore.Evaluation.Machine.CostModelInterface Methods pretty :: CostModelApplyError -> Doc ann Source # prettyList :: [ CostModelApplyError ] -> Doc ann Source # |
|
assertWellFormedCostModelParams :: MonadError CostModelApplyError m => CostModelParams -> m () Source #
Comparably expensive to
mkEvaluationContext
, so it should only be used sparingly.
costModelParamNames :: Set Text Source #
The set of valid names that a cost model parameter can take for this language version.
It is used for the deserialization of
CostModelParams
.
Context types
data ScriptContext Source #
Constructors
| ScriptContext | |
|
Fields |
|
Instances
data ScriptPurpose Source #
Purpose of the script that is currently running
Constructors
| Minting CurrencySymbol | |
| Spending TxOutRef | |
| Rewarding StakingCredential | |
| Certifying DCert |
Instances
Supporting types used in the context types
ByteStrings
data BuiltinByteString Source #
An opaque type representing Plutus Core ByteStrings.
Instances
fromBuiltin :: FromBuiltin arep a => arep -> a Source #
Bytes
newtype LedgerBytes Source #
Constructors
| LedgerBytes | |
|
Fields |
|
Instances
fromBytes :: ByteString -> LedgerBytes Source #
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 retiremant certificate and the Epoch N |
| DCertGenesis |
A really terse Digest |
| DCertMir |
Another really terse Digest |
Instances
Credentials
data StakingCredential Source #
Staking credential used to assign rewards
Constructors
| StakingHash Credential | |
| StakingPtr Integer Integer Integer |
Instances
data Credential Source #
Credential required to unlock a transaction output
Constructors
| PubKeyCredential PubKeyHash |
The transaction that spends this output must be signed by the private key |
| ScriptCredential ValidatorHash |
The transaction that spends this output must include the validator script and be accepted by the validator. |
Instances
Value
A cryptocurrency value. This is a map from
CurrencySymbol
s to a
quantity of that currency.
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
Value
s 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.
See note [Currencies] for more details.
Instances
newtype CurrencySymbol Source #
Constructors
| CurrencySymbol | |
|
Fields |
|
Instances
ByteString of a name of a token, shown as UTF-8 string when possible
Constructors
| TokenName | |
|
Fields |
|
Instances
singleton :: CurrencySymbol -> TokenName -> Integer -> Value Source #
Make a
Value
containing only the given quantity of the given currency.
adaSymbol :: CurrencySymbol Source #
The
CurrencySymbol
of the
Ada
currency.
Time
POSIX time is measured as the number of milliseconds since 1970-01-01T00:00:00Z
Constructors
| POSIXTime | |
|
Fields |
|