Safe Haskell	Safe-Inferred
Language	Haskell2010

PlutusLedgerApi.V2.Contexts

Contents

Pending transactions and related types
Validator functions

Synopsis

data TxInfo = TxInfo {
- txInfoInputs :: [TxInInfo]
- txInfoReferenceInputs :: [TxInInfo]
- txInfoOutputs :: [TxOut]
- txInfoFee :: Value
- txInfoMint :: Value
- txInfoDCert :: [DCert]
- txInfoWdrl :: Map StakingCredential Integer
- txInfoValidRange :: POSIXTimeRange
- txInfoSignatories :: [PubKeyHash]
- txInfoRedeemers :: Map ScriptPurpose Redeemer
- txInfoData :: Map DatumHash Datum
- txInfoId :: TxId
}
data ScriptContext = ScriptContext {
- scriptContextTxInfo :: TxInfo
- scriptContextPurpose :: ScriptPurpose
}
data ScriptPurpose
- = Minting CurrencySymbol
- | Spending TxOutRef
- | Rewarding StakingCredential
- | Certifying DCert
newtype TxId = TxId {
- getTxId :: BuiltinByteString
}
data TxOut = TxOut {
- txOutAddress :: Address
- txOutValue :: Value
- txOutDatum :: OutputDatum
- txOutReferenceScript :: Maybe ScriptHash
}
data TxOutRef = TxOutRef {
- txOutRefId :: TxId
- txOutRefIdx :: Integer
}
data TxInInfo = TxInInfo {
- txInInfoOutRef :: TxOutRef
- txInInfoResolved :: TxOut
}
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

Pending transactions and related types

data TxInfo #

A pending transaction. This is the view as seen by validator scripts, so some details are stripped out.

Constructors

TxInfo

Fields

txInfoInputs :: [TxInInfo]
Transaction inputs; cannot be an empty list
txInfoReferenceInputs :: [TxInInfo]
Added in V2: Transaction reference inputs
txInfoOutputs :: [TxOut]
Transaction outputs
txInfoFee :: Value
The fee paid by this transaction.
txInfoMint :: Value
The Value minted by this transaction.
txInfoDCert :: [DCert]
Digests of certificates included in this transaction
txInfoWdrl :: Map StakingCredential Integer
Withdrawals V1->V2: changed from assoc list to a AssocMap
txInfoValidRange :: POSIXTimeRange
The valid range for the transaction.
txInfoSignatories :: [PubKeyHash]
Signatures provided with the transaction, attested that they all signed the tx
txInfoRedeemers :: Map ScriptPurpose Redeemer
Added in V2: a table of redeemers attached to the transaction
txInfoData :: Map DatumHash Datum
The lookup table of datums attached to the transaction V1->V2: changed from assoc list to a RepIsStuckError ScriptPurpose :: Type -> Type) (Rep ScriptPurpose)))

newtype TxId #

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 getTxId :: BuiltinByteString

Instances

Instances details

RepIsStuckError TxId :: Type -> Type) (Rep TxId)))

data TxOut #

A transaction output, consisting of a target address, a value, optionally a datum/datum hash, and optionally a reference script.

Constructors

TxOut
Fields txOutAddress :: Address txOutValue :: Value txOutDatum :: OutputDatum txOutReferenceScript :: RepIsStuckError TxOut :: Type -> Type) (Rep TxOut)))

data TxOutRef #

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 txOutRefId :: TxId The transaction ID. txOutRefIdx :: RepIsStuckError TxInInfo :: Type -> Type) (Rep TxInInfo)))

findOwnInput :: ScriptContext -> Maybe TxInInfo #

Find the input currently being validated.

findDatum :: DatumHash -> TxInfo -> Maybe Datum #

Find the data corresponding to a data hash, if there is one

findDatumHash :: Datum -> TxInfo -> Maybe DatumHash #

Find the hash of a datum, if it is part of the pending transaction's hashes

findTxInByTxOutRef :: TxOutRef -> TxInfo -> Maybe TxInInfo #

Given a UTXO reference and a transaction (TxInfo), resolve it to one of the transaction's inputs (TxInInfo). Note: this only searches the true transaction inputs and not the referenced transaction inputs.

findContinuingOutputs :: ScriptContext -> [Integer] #

Find the indices of all the outputs that pay to the same script address we are currently spending from, if any.

getContinuingOutputs :: ScriptContext -> [TxOut] #

Get all the outputs that pay to the same script address we are currently spending from, if any.

Validator functions

pubKeyOutputsAt :: PubKeyHash -> TxInfo -> [Value] #

Get the values paid to a public key address by a pending transaction.

valuePaidTo :: TxInfo -> PubKeyHash -> Value #

Get the total value paid to a public key address by a pending transaction.

spendsOutput :: TxInfo -> TxId -> Integer -> Bool #

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 #

Check if a transaction was signed by the given public key.

valueSpent :: TxInfo -> Value #

Get the total value of inputs spent by this transaction.

valueProduced :: TxInfo -> Value #

Get the total value of outputs produced by this transaction.

ownCurrencySymbol :: ScriptContext -> CurrencySymbol #

The CurrencySymbol of the current validator script.