| Safe Haskell | Safe-Inferred |
|---|---|
| Language | Haskell2010 |
PlutusLedgerApi.V2.Data.Contexts
Synopsis
- data TxInfo
- pattern TxInfo :: List TxInInfo -> List TxInInfo -> List TxOut -> Value -> Value -> List DCert -> Map StakingCredential Integer -> POSIXTimeRange -> List PubKeyHash -> Map ScriptPurpose Redeemer -> Map DatumHash Datum -> TxId -> TxInfo
- txInfoInputs :: TxInfo -> List TxInInfo
- txInfoReferenceInputs :: TxInfo -> List TxInInfo
- txInfoOutputs :: TxInfo -> List TxOut
- txInfoFee :: TxInfo -> Value
- txInfoMint :: TxInfo -> Value
- txInfoDCert :: TxInfo -> List DCert
- txInfoWdrl :: TxInfo -> Map StakingCredential Integer
- txInfoValidRange :: TxInfo -> POSIXTimeRange
- txInfoSignatories :: TxInfo -> List PubKeyHash
- txInfoRedeemers :: TxInfo -> Map ScriptPurpose Redeemer
- txInfoData :: TxInfo -> Map DatumHash Datum
- txInfoId :: TxInfo -> TxId
- data ScriptContext
- pattern ScriptContext :: TxInfo -> ScriptPurpose -> ScriptContext
- scriptContextTxInfo :: ScriptContext -> TxInfo
- scriptContextPurpose :: ScriptContext -> ScriptPurpose
- data ScriptPurpose
- pattern Minting :: CurrencySymbol -> ScriptPurpose
- pattern Spending :: TxOutRef -> ScriptPurpose
- pattern Rewarding :: StakingCredential -> ScriptPurpose
- pattern Certifying :: DCert -> ScriptPurpose
- newtype TxId = TxId {}
- data TxOut
- pattern TxOut :: Address -> Value -> OutputDatum -> Maybe ScriptHash -> TxOut
- txOutAddress :: TxOut -> Address
- txOutValue :: TxOut -> Value
- txOutDatum :: TxOut -> OutputDatum
- txOutReferenceScript :: TxOut -> Maybe ScriptHash
- data TxOutRef
- pattern TxOutRef :: TxId -> Integer -> TxOutRef
- txOutRefId :: TxOutRef -> TxId
- txOutRefIdx :: TxOutRef -> Integer
- data TxInInfo
- pattern TxInInfo :: TxOutRef -> TxOut -> TxInInfo
- txInInfoOutRef :: TxInInfo -> TxOutRef
- txInInfoResolved :: TxInInfo -> TxOut
- findOwnInput :: ScriptContext -> Maybe TxInInfo
- findDatum :: DatumHash -> TxInfo -> Maybe Datum
- findDatumHash :: Datum -> TxInfo -> Maybe DatumHash
- findTxInByTxOutRef :: TxOutRef -> TxInfo -> Maybe TxInInfo
- findContinuingOutputs :: ScriptContext -> List Integer
- getContinuingOutputs :: ScriptContext -> List TxOut
- pubKeyOutputsAt :: PubKeyHash -> TxInfo -> List Value
- valuePaidTo :: TxInfo -> PubKeyHash -> Value
- spendsOutput :: TxInfo -> TxId -> Integer -> Bool
- txSignedBy :: TxInfo -> PubKeyHash -> Bool
- valueSpent :: TxInfo -> Value
- valueProduced :: TxInfo -> Value
- ownCurrencySymbol :: ScriptContext -> CurrencySymbol
Pending transactions and related types
A pending transaction. This is the view as seen by validator scripts, so some details are stripped out.
Instances
| Generic TxInfo Source # | |
| Show TxInfo Source # | |
| FromData TxInfo Source # | |
Defined in PlutusLedgerApi.V2.Data.Contexts Methods fromBuiltinData :: BuiltinData -> Maybe TxInfo # | |
| ToData TxInfo Source # | |
Defined in PlutusLedgerApi.V2.Data.Contexts Methods toBuiltinData :: TxInfo -> BuiltinData # | |
| UnsafeFromData TxInfo Source # | |
Defined in PlutusLedgerApi.V2.Data.Contexts Methods | |
| Pretty TxInfo Source # | |
Defined in PlutusLedgerApi.V2.Data.Contexts | |
| Lift DefaultUni TxInfo Source # | |
Defined in PlutusLedgerApi.V2.Data.Contexts | |
| Typeable DefaultUni TxInfo Source # | |
Defined in PlutusLedgerApi.V2.Data.Contexts | |
| type Rep TxInfo Source # | |
Defined in PlutusLedgerApi.V2.Data.Contexts type Rep TxInfo = D1 ('MetaData "TxInfo" "PlutusLedgerApi.V2.Data.Contexts" "plutus-ledger-api-1.40.0.0-EwL3g0rD7enBEzHV6wRFG7" 'True) (C1 ('MetaCons "TxInfo_6989586621680809706" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 BuiltinData))) | |
pattern TxInfo :: List TxInInfo -> List TxInInfo -> List TxOut -> Value -> Value -> List DCert -> Map StakingCredential Integer -> POSIXTimeRange -> List PubKeyHash -> Map ScriptPurpose Redeemer -> Map DatumHash Datum -> TxId -> TxInfo Source #
txInfoInputs :: TxInfo -> List TxInInfo Source #
txInfoReferenceInputs :: TxInfo -> List TxInInfo Source #
txInfoOutputs :: TxInfo -> List TxOut Source #
txInfoMint :: TxInfo -> Value Source #
txInfoDCert :: TxInfo -> List DCert Source #
txInfoSignatories :: TxInfo -> List PubKeyHash Source #
data ScriptContext Source #
The context that the currently-executing script can access.
Instances
pattern ScriptContext :: TxInfo -> ScriptPurpose -> ScriptContext Source #
data ScriptPurpose Source #
Purpose of the script that is currently running
Instances
pattern Minting :: CurrencySymbol -> ScriptPurpose Source #
pattern Spending :: TxOutRef -> ScriptPurpose Source #
pattern Rewarding :: StakingCredential -> ScriptPurpose Source #
pattern Certifying :: DCert -> ScriptPurpose Source #
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. -- editorconfig-checker-disable-file
Constructors
| TxId | |
Fields | |
Instances
A transaction output, consisting of a target address, a value, optionally a datum/datum hash, and optionally a reference script.
Instances
| Generic TxOut Source # | |
| Show TxOut Source # | |
| Eq TxOut Source # | |
| Eq TxOut Source # | |
Defined in PlutusLedgerApi.V2.Data.Tx | |
| FromData TxOut Source # | |
Defined in PlutusLedgerApi.V2.Data.Tx Methods fromBuiltinData :: BuiltinData -> Maybe TxOut # | |
| ToData TxOut Source # | |
Defined in PlutusLedgerApi.V2.Data.Tx Methods toBuiltinData :: TxOut -> BuiltinData # | |
| UnsafeFromData TxOut Source # | |
Defined in PlutusLedgerApi.V2.Data.Tx Methods | |
| Pretty TxOut Source # | |
Defined in PlutusLedgerApi.V2.Data.Tx | |
| Lift DefaultUni TxOut Source # | |
Defined in PlutusLedgerApi.V2.Data.Tx | |
| Typeable DefaultUni TxOut Source # | |
Defined in PlutusLedgerApi.V2.Data.Tx | |
| type Rep TxOut Source # | |
Defined in PlutusLedgerApi.V2.Data.Tx type Rep TxOut = D1 ('MetaData "TxOut" "PlutusLedgerApi.V2.Data.Tx" "plutus-ledger-api-1.40.0.0-EwL3g0rD7enBEzHV6wRFG7" 'True) (C1 ('MetaCons "TxOut_6989586621680759785" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 BuiltinData))) | |
pattern TxOut :: Address -> Value -> OutputDatum -> Maybe ScriptHash -> TxOut Source #
txOutAddress :: TxOut -> Address Source #
txOutValue :: TxOut -> Value Source #
txOutDatum :: TxOut -> OutputDatum Source #
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.
Instances
txOutRefId :: TxOutRef -> TxId Source #
txOutRefIdx :: TxOutRef -> Integer Source #
An input of a pending transaction.
Instances
txInInfoOutRef :: TxInInfo -> TxOutRef Source #
txInInfoResolved :: TxInInfo -> TxOut Source #
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 -> List Integer Source #
Find the indices of all the outputs that pay to the same script address we are currently spending from, if any.
getContinuingOutputs :: ScriptContext -> List TxOut Source #
Get all the outputs that pay to the same script address we are currently spending from, if any.
Validator functions
pubKeyOutputsAt :: PubKeyHash -> TxInfo -> List 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.