Safe Haskell	Safe-Inferred
Language	Haskell2010

PlutusLedgerApi.V4.Tx

Contents

Transactions
Transaction outputs

Synopsis

newtype TxId = TxId {
- getTxId ∷ BuiltinByteString
}
data TxOutRef where
- pattern TxOutRef ∷ TxId → Integer → TxOutRef
data OutputDatum
- = NoOutputDatum
- | OutputDatumHash DatumHash
- | OutputDatum Datum
data TxOut = TxOut {
- txOutAddress ∷ Address
- txOutValue ∷ Value
- txOutDatum ∷ OutputDatum
- txOutReferenceScript ∷ Maybe ScriptHash
}
txOutPubKey ∷ TxOut → Maybe PubKeyHash
txOutScriptHash ∷ TxOut → Maybe ScriptHash
isPubKeyOut ∷ TxOut → Bool
isPayToScriptOut ∷ TxOut → Bool
pubKeyHashTxOut ∷ Value → PubKeyHash → TxOut

Transactions

newtype TxId 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.

Constructors

TxId
Fields getTxId ∷ BuiltinByteString

Instances

Instances details

IsString TxId Source #	from hex encoding
Instance details Defined in PlutusLedgerApi.V3.Tx Methods fromString ∷ String → TxId Source #
Generic TxId Source #
Instance details Defined in PlutusLedgerApi.V3.Tx Associated Types type Rep TxId ∷ Type → Type Source # Methods from ∷ TxId → Rep TxId x Source # to ∷ Rep TxId x → TxId Source #
Show TxId Source #	using hex encoding
Instance details Defined in PlutusLedgerApi.V3.Tx Methods showsPrec ∷ Int → TxId → ShowS Source # show ∷ TxId → String Source # showList ∷ [TxId] → ShowS Source #
NFData TxId Source #
Instance details Defined in PlutusLedgerApi.V3.Tx Methods rnf ∷ TxId → () Source #
Eq TxId Source #
Instance details Defined in PlutusLedgerApi.V3.Tx Methods (==) ∷ TxId → TxId → Bool Source # (/=) ∷ TxId → TxId → Bool Source #
Ord TxId Source #
Instance details Defined in PlutusLedgerApi.V3.Tx Methods compare ∷ TxId → TxId → Ordering Source # (<) ∷ TxId → TxId → Bool Source # (<=) ∷ TxId → TxId → Bool Source # (>) ∷ TxId → TxId → Bool Source # (>=) ∷ TxId → TxId → Bool Source # max ∷ TxId → TxId → TxId Source # min ∷ TxId → TxId → TxId Source #
HasBlueprintDefinition TxId Source #
Instance details Defined in PlutusLedgerApi.V3.Tx Associated Types type Unroll TxId ∷ [Type] Source # Methods definitionId ∷ DefinitionId Source #
Eq TxId Source #
Instance details Defined in PlutusLedgerApi.V3.Tx Methods (==) ∷ TxId → TxId → Bool Source #
FromData TxId Source #
Instance details Defined in PlutusLedgerApi.V3.Tx Methods fromBuiltinData ∷ BuiltinData → Maybe TxId Source #
ToData TxId Source #
Instance details Defined in PlutusLedgerApi.V3.Tx Methods toBuiltinData ∷ TxId → BuiltinData Source #
UnsafeFromData TxId Source #
Instance details Defined in PlutusLedgerApi.V3.Tx Methods unsafeFromBuiltinData ∷ BuiltinData → TxId Source #
Ord TxId Source #
Instance details Defined in PlutusLedgerApi.V3.Tx Methods compare ∷ TxId → TxId → Ordering Source # (<) ∷ TxId → TxId → Bool Source # (<=) ∷ TxId → TxId → Bool Source # (>) ∷ TxId → TxId → Bool Source # (>=) ∷ TxId → TxId → Bool Source # max ∷ TxId → TxId → TxId Source # min ∷ TxId → TxId → TxId Source #
Pretty TxId Source #	using hex encoding
Instance details Defined in PlutusLedgerApi.V3.Tx Methods pretty ∷ TxId → Doc ann Source # prettyList ∷ [TxId] → Doc ann Source #
HasBlueprintSchema TxId referencedTypes Source #
Instance details Defined in PlutusLedgerApi.V3.Tx Methods schema ∷ Schema referencedTypes Source #
Lift DefaultUni TxId Source #
Instance details Defined in PlutusLedgerApi.V3.Tx Methods lift ∷ TxId → RTCompile DefaultUni fun (Term TyName Name DefaultUni fun ()) Source #
Typeable DefaultUni TxId Source #
Instance details Defined in PlutusLedgerApi.V3.Tx Methods typeRep ∷ Proxy TxId → RTCompile DefaultUni fun (Type TyName DefaultUni ()) Source #
type Rep TxId Source #
Instance details Defined in PlutusLedgerApi.V3.Tx type Rep TxId = D1 ('MetaData "TxId" "PlutusLedgerApi.V3.Tx" "plutus-ledger-api-1.69.0.0-inplace" 'True) (C1 ('MetaCons "TxId" 'PrefixI 'True) (S1 ('MetaSel ('Just "getTxId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 BuiltinByteString)))
type Unroll TxId Source #
Instance details Defined in PlutusLedgerApi.V3.Tx type Unroll TxId = Insert TxId (GUnroll (IfStuckRep (RepIsStuckError TxId ∷ Type → Type) (Rep TxId)))

Transaction outputs

data TxOutRef where Source #

Bundled Patterns

pattern TxOutRef ∷ TxId → Integer → TxOutRef

Instances

Instances details

Generic TxOutRef Source #
Instance details Defined in PlutusLedgerApi.V4.Tx Associated Types type Rep TxOutRef ∷ Type → Type Source # Methods from ∷ TxOutRef → Rep TxOutRef x Source # to ∷ Rep TxOutRef x → TxOutRef Source #
Show TxOutRef Source #
Instance details Defined in PlutusLedgerApi.V4.Tx Methods showsPrec ∷ Int → TxOutRef → ShowS Source # show ∷ TxOutRef → String Source # showList ∷ [TxOutRef] → ShowS Source #
NFData TxOutRef Source #
Instance details Defined in PlutusLedgerApi.V4.Tx Methods rnf ∷ TxOutRef → () Source #
Eq TxOutRef Source #
Instance details Defined in PlutusLedgerApi.V4.Tx Methods (==) ∷ TxOutRef → TxOutRef → Bool Source # (/=) ∷ TxOutRef → TxOutRef → Bool Source #
Ord TxOutRef Source #
Instance details Defined in PlutusLedgerApi.V4.Tx Methods compare ∷ TxOutRef → TxOutRef → Ordering Source # (<) ∷ TxOutRef → TxOutRef → Bool Source # (<=) ∷ TxOutRef → TxOutRef → Bool Source # (>) ∷ TxOutRef → TxOutRef → Bool Source # (>=) ∷ TxOutRef → TxOutRef → Bool Source # max ∷ TxOutRef → TxOutRef → TxOutRef Source # min ∷ TxOutRef → TxOutRef → TxOutRef Source #
HasBlueprintDefinition TxOutRef Source #
Instance details Defined in PlutusLedgerApi.V4.Tx Associated Types type Unroll TxOutRef ∷ [Type] Source # Methods definitionId ∷ DefinitionId Source #
Eq TxOutRef Source #
Instance details Defined in PlutusLedgerApi.V4.Tx Methods (==) ∷ TxOutRef → TxOutRef → Bool Source #
FromData TxOutRef Source #
Instance details Defined in PlutusLedgerApi.V4.Tx Methods fromBuiltinData ∷ BuiltinData → Maybe TxOutRef Source #
ToData TxOutRef Source #
Instance details Defined in PlutusLedgerApi.V4.Tx Methods toBuiltinData ∷ TxOutRef → BuiltinData Source #
UnsafeFromData TxOutRef Source #
Instance details Defined in PlutusLedgerApi.V4.Tx Methods unsafeFromBuiltinData ∷ BuiltinData → TxOutRef Source #
Pretty TxOutRef Source #
Instance details Defined in PlutusLedgerApi.V4.Tx Methods pretty ∷ TxOutRef → Doc ann Source # prettyList ∷ [TxOutRef] → Doc ann Source #
HasBlueprintSchema TxOutRef referencedTypes ⇒ HasBlueprintSchema TxOutRef referencedTypes Source #
Instance details Defined in PlutusLedgerApi.V4.Tx Methods schema ∷ Schema referencedTypes Source #
Lift DefaultUni TxOutRef Source #
Instance details Defined in PlutusLedgerApi.V4.Tx Methods lift ∷ TxOutRef → RTCompile DefaultUni fun (Term TyName Name DefaultUni fun ()) Source #
Typeable DefaultUni TxOutRef Source #
Instance details Defined in PlutusLedgerApi.V4.Tx Methods typeRep ∷ Proxy TxOutRef → RTCompile DefaultUni fun (Type TyName DefaultUni ()) Source #
type Rep TxOutRef Source #
Instance details Defined in PlutusLedgerApi.V4.Tx type Rep TxOutRef = D1 ('MetaData "TxOutRef" "PlutusLedgerApi.V4.Tx" "plutus-ledger-api-1.69.0.0-inplace" 'True) (C1 ('MetaCons "TxOutRefValue" 'PrefixI 'False) (S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 TxOutRef)))
type Unroll TxOutRef Source #
Instance details Defined in PlutusLedgerApi.V4.Tx type Unroll TxOutRef = TxOutRef ': UnrollAll '[TxId, Integer]

data OutputDatum Source #

The datum attached to an output: either nothing; a datum hash; or the datum itself (an "inline datum").

Constructors

NoOutputDatum
OutputDatumHash DatumHash
OutputDatum Datum

Instances

Instances details

Generic OutputDatum Source #
Instance details Defined in PlutusLedgerApi.V2.Tx Associated Types type Rep OutputDatum ∷ Type → Type Source # Methods from ∷ OutputDatum → Rep OutputDatum x Source # to ∷ Rep OutputDatum x → OutputDatum Source #
Show OutputDatum Source #
Instance details Defined in PlutusLedgerApi.V2.Tx Methods showsPrec ∷ Int → OutputDatum → ShowS Source # show ∷ OutputDatum → String Source # showList ∷ [OutputDatum] → ShowS Source #
NFData OutputDatum Source #
Instance details Defined in PlutusLedgerApi.V2.Tx Methods rnf ∷ OutputDatum → () Source #
Eq OutputDatum Source #
Instance details Defined in PlutusLedgerApi.V2.Tx Methods (==) ∷ OutputDatum → OutputDatum → Bool Source # (/=) ∷ OutputDatum → OutputDatum → Bool Source #
HasBlueprintDefinition OutputDatum Source #
Instance details Defined in PlutusLedgerApi.V2.Tx Associated Types type Unroll OutputDatum ∷ [Type] Source # Methods definitionId ∷ DefinitionId Source #
Eq OutputDatum Source #
Instance details Defined in PlutusLedgerApi.V2.Tx Methods (==) ∷ OutputDatum → OutputDatum → Bool Source #
FromData OutputDatum Source #
Instance details Defined in PlutusLedgerApi.V2.Tx Methods fromBuiltinData ∷ BuiltinData → Maybe OutputDatum Source #
ToData OutputDatum Source #
Instance details Defined in PlutusLedgerApi.V2.Tx Methods toBuiltinData ∷ OutputDatum → BuiltinData Source #
UnsafeFromData OutputDatum Source #
Instance details Defined in PlutusLedgerApi.V2.Tx Methods unsafeFromBuiltinData ∷ BuiltinData → OutputDatum Source #
Pretty OutputDatum Source #
Instance details Defined in PlutusLedgerApi.V2.Tx Methods pretty ∷ OutputDatum → Doc ann Source # prettyList ∷ [OutputDatum] → Doc ann Source #
(HasSchemaDefinition DatumHash referencedTypes, HasSchemaDefinition Datum referencedTypes) ⇒ HasBlueprintSchema OutputDatum referencedTypes Source #
Instance details Defined in PlutusLedgerApi.V2.Tx Methods schema ∷ Schema referencedTypes Source #
Lift DefaultUni OutputDatum Source #
Instance details Defined in PlutusLedgerApi.V2.Tx Methods lift ∷ OutputDatum → RTCompile DefaultUni fun (Term TyName Name DefaultUni fun ()) Source #
Typeable DefaultUni OutputDatum Source #
Instance details Defined in PlutusLedgerApi.V2.Tx Methods typeRep ∷ Proxy OutputDatum → RTCompile DefaultUni fun (Type TyName DefaultUni ()) Source #
type Rep OutputDatum Source #
Instance details Defined in PlutusLedgerApi.V2.Tx type Rep OutputDatum = D1 ('MetaData "OutputDatum" "PlutusLedgerApi.V2.Tx" "plutus-ledger-api-1.69.0.0-inplace" 'False) (C1 ('MetaCons "NoOutputDatum" 'PrefixI 'False) (U1 ∷ Type → Type) :+: (C1 ('MetaCons "OutputDatumHash" 'PrefixI 'False) (S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 DatumHash)) :+: C1 ('MetaCons "OutputDatum" 'PrefixI 'False) (S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Datum))))
type Unroll OutputDatum Source #
Instance details Defined in PlutusLedgerApi.V2.Tx type Unroll OutputDatum = Insert OutputDatum (GUnroll (IfStuckRep (RepIsStuckError OutputDatum ∷ Type → Type) (Rep OutputDatum)))

data TxOut Source #

Transaction output for Plutus V4.

Constructors

TxOut
Fields txOutAddress ∷ Address txOutValue ∷ Value txOutDatum ∷ OutputDatum txOutReferenceScript ∷ Maybe ScriptHash

Instances

Instances details

Generic TxOut Source #
Instance details Defined in PlutusLedgerApi.V4.Tx Associated Types type Rep TxOut ∷ Type → Type Source # Methods from ∷ TxOut → Rep TxOut x Source # to ∷ Rep TxOut x → TxOut Source #
Show TxOut Source #
Instance details Defined in PlutusLedgerApi.V4.Tx Methods showsPrec ∷ Int → TxOut → ShowS Source # show ∷ TxOut → String Source # showList ∷ [TxOut] → ShowS Source #
Eq TxOut Source #
Instance details Defined in PlutusLedgerApi.V4.Tx Methods (==) ∷ TxOut → TxOut → Bool Source # (/=) ∷ TxOut → TxOut → Bool Source #
HasBlueprintDefinition TxOut Source #
Instance details Defined in PlutusLedgerApi.V4.Tx Associated Types type Unroll TxOut ∷ [Type] Source # Methods definitionId ∷ DefinitionId Source #
Eq TxOut Source #
Instance details Defined in PlutusLedgerApi.V4.Tx Methods (==) ∷ TxOut → TxOut → Bool Source #
FromData TxOut Source #
Instance details Defined in PlutusLedgerApi.V4.Tx Methods fromBuiltinData ∷ BuiltinData → Maybe TxOut Source #
ToData TxOut Source #
Instance details Defined in PlutusLedgerApi.V4.Tx Methods toBuiltinData ∷ TxOut → BuiltinData Source #
UnsafeFromData TxOut Source #
Instance details Defined in PlutusLedgerApi.V4.Tx Methods unsafeFromBuiltinData ∷ BuiltinData → TxOut Source #
Pretty TxOut Source #
Instance details Defined in PlutusLedgerApi.V4.Tx Methods pretty ∷ TxOut → Doc ann Source # prettyList ∷ [TxOut] → Doc ann Source #
(HasSchemaDefinition Address referencedTypes, HasSchemaDefinition Value referencedTypes, HasSchemaDefinition OutputDatum referencedTypes, HasSchemaDefinition (Maybe ScriptHash) referencedTypes) ⇒ HasBlueprintSchema TxOut referencedTypes Source #
Instance details Defined in PlutusLedgerApi.V4.Tx Methods schema ∷ Schema referencedTypes Source #
Lift DefaultUni TxOut Source #
Instance details Defined in PlutusLedgerApi.V4.Tx Methods lift ∷ TxOut → RTCompile DefaultUni fun (Term TyName Name DefaultUni fun ()) Source #
Typeable DefaultUni TxOut Source #
Instance details Defined in PlutusLedgerApi.V4.Tx Methods typeRep ∷ Proxy TxOut → RTCompile DefaultUni fun (Type TyName DefaultUni ()) Source #
type Rep TxOut Source #
Instance details Defined in PlutusLedgerApi.V4.Tx type Rep TxOut = D1 ('MetaData "TxOut" "PlutusLedgerApi.V4.Tx" "plutus-ledger-api-1.69.0.0-inplace" 'False) (C1 ('MetaCons "TxOut" 'PrefixI 'True) ((S1 ('MetaSel ('Just "txOutAddress") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Address) :: S1 ('MetaSel ('Just "txOutValue") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Value)) :: (S1 ('MetaSel ('Just "txOutDatum") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 OutputDatum) :*: S1 ('MetaSel ('Just "txOutReferenceScript") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe ScriptHash)))))
type Unroll TxOut Source #
Instance details Defined in PlutusLedgerApi.V4.Tx type Unroll TxOut = Insert TxOut (GUnroll (IfStuckRep (RepIsStuckError TxOut ∷ Type → Type) (Rep TxOut)))

txOutPubKey ∷ TxOut → Maybe PubKeyHash Source #

The public key attached to a TxOut, if there is one.

txOutScriptHash ∷ TxOut → Maybe ScriptHash Source #

The validator hash attached to a TxOut, if there is one.

isPubKeyOut ∷ TxOut → Bool Source #

Whether the output is a pay-to-pubkey output.

isPayToScriptOut ∷ TxOut → Bool Source #

Whether the output is a pay-to-script output.

pubKeyHashTxOut ∷ Value → PubKeyHash → TxOut Source #

Create a transaction output locked by a public key.