plutus-ledger-api-1.36.0.0: Interface to the Plutus ledger for the Cardano ledger.
Safe HaskellSafe-Inferred
LanguageHaskell2010

PlutusLedgerApi.V1.Data.Tx

Synopsis

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 

Instances

Instances details
IsString TxId Source #

from hex encoding

Instance details

Defined in PlutusLedgerApi.V1.Data.Tx

Methods

fromStringStringTxId Source #

Generic TxId Source # 
Instance details

Defined in PlutusLedgerApi.V1.Data.Tx

Associated Types

type Rep TxIdTypeType Source #

Methods

fromTxIdRep TxId x Source #

toRep TxId x → TxId Source #

Show TxId Source #

using hex encoding

Instance details

Defined in PlutusLedgerApi.V1.Data.Tx

Methods

showsPrecIntTxIdShowS Source #

showTxIdString Source #

showList ∷ [TxId] → ShowS Source #

NFData TxId Source # 
Instance details

Defined in PlutusLedgerApi.V1.Data.Tx

Methods

rnfTxId → () Source #

Eq TxId Source # 
Instance details

Defined in PlutusLedgerApi.V1.Data.Tx

Methods

(==)TxIdTxIdBool Source #

(/=)TxIdTxIdBool Source #

Ord TxId Source # 
Instance details

Defined in PlutusLedgerApi.V1.Data.Tx

Methods

compareTxIdTxIdOrdering Source #

(<)TxIdTxIdBool Source #

(<=)TxIdTxIdBool Source #

(>)TxIdTxIdBool Source #

(>=)TxIdTxIdBool Source #

maxTxIdTxIdTxId Source #

minTxIdTxIdTxId Source #

Eq TxId Source # 
Instance details

Defined in PlutusLedgerApi.V1.Data.Tx

Methods

(==)TxIdTxIdBool Source #

FromData TxId Source # 
Instance details

Defined in PlutusLedgerApi.V1.Data.Tx

ToData TxId Source # 
Instance details

Defined in PlutusLedgerApi.V1.Data.Tx

UnsafeFromData TxId Source # 
Instance details

Defined in PlutusLedgerApi.V1.Data.Tx

Ord TxId Source # 
Instance details

Defined in PlutusLedgerApi.V1.Data.Tx

Methods

compareTxIdTxIdOrdering Source #

(<)TxIdTxIdBool Source #

(<=)TxIdTxIdBool Source #

(>)TxIdTxIdBool Source #

(>=)TxIdTxIdBool Source #

maxTxIdTxIdTxId Source #

minTxIdTxIdTxId Source #

Pretty TxId Source #

using hex encoding

Instance details

Defined in PlutusLedgerApi.V1.Data.Tx

Methods

prettyTxIdDoc ann Source #

prettyList ∷ [TxId] → Doc ann Source #

Lift DefaultUni TxId Source # 
Instance details

Defined in PlutusLedgerApi.V1.Data.Tx

Typeable DefaultUni TxId Source # 
Instance details

Defined in PlutusLedgerApi.V1.Data.Tx

type Rep TxId Source # 
Instance details

Defined in PlutusLedgerApi.V1.Data.Tx

type Rep TxId = D1 ('MetaData "TxId" "PlutusLedgerApi.V1.Data.Tx" "plutus-ledger-api-1.36.0.0-inplace" 'True) (C1 ('MetaCons "TxId" 'PrefixI 'True) (S1 ('MetaSel ('Just "getTxId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 BuiltinByteString)))

data ScriptTag Source #

A tag indicating the type of script that we are pointing to.

See also ScriptPurpose

Constructors

Spend 
Mint 
Cert 
Reward 

Instances

Instances details
Generic ScriptTag Source # 
Instance details

Defined in PlutusLedgerApi.V1.Data.Tx

Associated Types

type Rep ScriptTagTypeType Source #

Show ScriptTag Source # 
Instance details

Defined in PlutusLedgerApi.V1.Data.Tx

NFData ScriptTag Source # 
Instance details

Defined in PlutusLedgerApi.V1.Data.Tx

Methods

rnfScriptTag → () Source #

Eq ScriptTag Source # 
Instance details

Defined in PlutusLedgerApi.V1.Data.Tx

Ord ScriptTag Source # 
Instance details

Defined in PlutusLedgerApi.V1.Data.Tx

type Rep ScriptTag Source # 
Instance details

Defined in PlutusLedgerApi.V1.Data.Tx

type Rep ScriptTag = D1 ('MetaData "ScriptTag" "PlutusLedgerApi.V1.Data.Tx" "plutus-ledger-api-1.36.0.0-inplace" 'False) ((C1 ('MetaCons "Spend" 'PrefixI 'False) (U1TypeType) :+: C1 ('MetaCons "Mint" 'PrefixI 'False) (U1TypeType)) :+: (C1 ('MetaCons "Cert" 'PrefixI 'False) (U1TypeType) :+: C1 ('MetaCons "Reward" 'PrefixI 'False) (U1TypeType)))

data RedeemerPtr Source #

A redeemer pointer is a pair of a script type tag (ScriptTag) t and an index i, picking out the i-th script of type t in the transaction.

Instances

Instances details
Generic RedeemerPtr Source # 
Instance details

Defined in PlutusLedgerApi.V1.Data.Tx

Associated Types

type Rep RedeemerPtrTypeType Source #

Show RedeemerPtr Source # 
Instance details

Defined in PlutusLedgerApi.V1.Data.Tx

NFData RedeemerPtr Source # 
Instance details

Defined in PlutusLedgerApi.V1.Data.Tx

Methods

rnfRedeemerPtr → () Source #

Eq RedeemerPtr Source # 
Instance details

Defined in PlutusLedgerApi.V1.Data.Tx

Ord RedeemerPtr Source # 
Instance details

Defined in PlutusLedgerApi.V1.Data.Tx

type Rep RedeemerPtr Source # 
Instance details

Defined in PlutusLedgerApi.V1.Data.Tx

type Rep RedeemerPtr = D1 ('MetaData "RedeemerPtr" "PlutusLedgerApi.V1.Data.Tx" "plutus-ledger-api-1.36.0.0-inplace" 'False) (C1 ('MetaCons "RedeemerPtr" 'PrefixI 'False) (S1 ('MetaSel ('NothingMaybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ScriptTag) :*: S1 ('MetaSel ('NothingMaybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Integer)))

type Redeemers = Map RedeemerPtr Redeemer Source #

Redeemers is a Map of redeemer pointer (RedeemerPtr) and its Redeemer.

Transaction outputs

data TxOut Source #

A transaction output, consisting of a target address (Address), a value (Value), and optionally a datum hash (DatumHash).

Instances

Instances details
Generic TxOut Source # 
Instance details

Defined in PlutusLedgerApi.V1.Data.Tx

Associated Types

type Rep TxOutTypeType Source #

Methods

fromTxOutRep TxOut x Source #

toRep TxOut x → TxOut Source #

Show TxOut Source # 
Instance details

Defined in PlutusLedgerApi.V1.Data.Tx

Eq TxOut Source # 
Instance details

Defined in PlutusLedgerApi.V1.Data.Tx

Methods

(==)TxOutTxOutBool Source #

(/=)TxOutTxOutBool Source #

Eq TxOut Source # 
Instance details

Defined in PlutusLedgerApi.V1.Data.Tx

Methods

(==)TxOutTxOutBool Source #

FromData TxOut Source # 
Instance details

Defined in PlutusLedgerApi.V1.Data.Tx

ToData TxOut Source # 
Instance details

Defined in PlutusLedgerApi.V1.Data.Tx

UnsafeFromData TxOut Source # 
Instance details

Defined in PlutusLedgerApi.V1.Data.Tx

Pretty TxOut Source # 
Instance details

Defined in PlutusLedgerApi.V1.Data.Tx

Methods

prettyTxOutDoc ann Source #

prettyList ∷ [TxOut] → Doc ann Source #

Lift DefaultUni TxOut Source # 
Instance details

Defined in PlutusLedgerApi.V1.Data.Tx

Typeable DefaultUni TxOut Source # 
Instance details

Defined in PlutusLedgerApi.V1.Data.Tx

type Rep TxOut Source # 
Instance details

Defined in PlutusLedgerApi.V1.Data.Tx

type Rep TxOut = D1 ('MetaData "TxOut" "PlutusLedgerApi.V1.Data.Tx" "plutus-ledger-api-1.36.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 "txOutDatumHash") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe DatumHash)))))

data TxOutRef 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.

Constructors

TxOutRef 

Fields

Instances

Instances details
Generic TxOutRef Source # 
Instance details

Defined in PlutusLedgerApi.V1.Data.Tx

Associated Types

type Rep TxOutRefTypeType Source #

Show TxOutRef Source # 
Instance details

Defined in PlutusLedgerApi.V1.Data.Tx

NFData TxOutRef Source # 
Instance details

Defined in PlutusLedgerApi.V1.Data.Tx

Methods

rnfTxOutRef → () Source #

Eq TxOutRef Source # 
Instance details

Defined in PlutusLedgerApi.V1.Data.Tx

Ord TxOutRef Source # 
Instance details

Defined in PlutusLedgerApi.V1.Data.Tx

Eq TxOutRef Source # 
Instance details

Defined in PlutusLedgerApi.V1.Data.Tx

Methods

(==)TxOutRefTxOutRefBool Source #

FromData TxOutRef Source # 
Instance details

Defined in PlutusLedgerApi.V1.Data.Tx

ToData TxOutRef Source # 
Instance details

Defined in PlutusLedgerApi.V1.Data.Tx

UnsafeFromData TxOutRef Source # 
Instance details

Defined in PlutusLedgerApi.V1.Data.Tx

Pretty TxOutRef Source # 
Instance details

Defined in PlutusLedgerApi.V1.Data.Tx

Methods

prettyTxOutRefDoc ann Source #

prettyList ∷ [TxOutRef] → Doc ann Source #

Lift DefaultUni TxOutRef Source # 
Instance details

Defined in PlutusLedgerApi.V1.Data.Tx

Typeable DefaultUni TxOutRef Source # 
Instance details

Defined in PlutusLedgerApi.V1.Data.Tx

type Rep TxOutRef Source # 
Instance details

Defined in PlutusLedgerApi.V1.Data.Tx

type Rep TxOutRef = D1 ('MetaData "TxOutRef" "PlutusLedgerApi.V1.Data.Tx" "plutus-ledger-api-1.36.0.0-inplace" 'False) (C1 ('MetaCons "TxOutRef" 'PrefixI 'True) (S1 ('MetaSel ('Just "txOutRefId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 TxId) :*: S1 ('MetaSel ('Just "txOutRefIdx") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Integer)))

isPubKeyOutTxOutBool Source #

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

isPayToScriptOutTxOutBool Source #

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

outAddressLens' TxOut Address Source #

The address of a transaction output.

outValueLens' TxOut Value Source #

The value of a transaction output. | TODO: Compute address again

txOutPubKeyTxOutMaybe PubKeyHash Source #

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

txOutDatumTxOutMaybe DatumHash Source #

The datum attached to a TxOut, if there is one.

pubKeyHashTxOutValuePubKeyHashTxOut Source #

Create a transaction output locked by a public key.