plutus-ledger-api
Safe HaskellNone
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. -- editorconfig-checker-disable-file

Constructors

TxId 

Fields

Instances

Instances details
IsString TxId Source #

from hex encoding

Instance details

Defined in PlutusLedgerApi.V1.Data.Tx

Methods

fromString :: String -> TxId Source #

Generic TxId Source # 
Instance details

Defined in PlutusLedgerApi.V1.Data.Tx

Associated Types

type Rep TxId 
Instance details

Defined in PlutusLedgerApi.V1.Data.Tx

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

Methods

from :: TxId -> Rep TxId x Source #

to :: Rep TxId x -> TxId Source #

Show TxId Source #

using hex encoding

Instance details

Defined in PlutusLedgerApi.V1.Data.Tx

Methods

showsPrec :: Int -> TxId -> ShowS Source #

show :: TxId -> String Source #

showList :: [TxId] -> ShowS Source #

NFData TxId Source # 
Instance details

Defined in PlutusLedgerApi.V1.Data.Tx

Methods

rnf :: TxId -> () Source #

Eq TxId Source # 
Instance details

Defined in PlutusLedgerApi.V1.Data.Tx

Methods

(==) :: TxId -> TxId -> Bool Source #

(/=) :: TxId -> TxId -> Bool Source #

Ord TxId Source # 
Instance details

Defined in PlutusLedgerApi.V1.Data.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 #

Eq TxId Source # 
Instance details

Defined in PlutusLedgerApi.V1.Data.Tx

Methods

(==) :: TxId -> TxId -> Bool

FromData TxId Source # 
Instance details

Defined in PlutusLedgerApi.V1.Data.Tx

Methods

fromBuiltinData :: BuiltinData -> Maybe TxId #

ToData TxId Source # 
Instance details

Defined in PlutusLedgerApi.V1.Data.Tx

Methods

toBuiltinData :: TxId -> BuiltinData #

UnsafeFromData TxId Source # 
Instance details

Defined in PlutusLedgerApi.V1.Data.Tx

Methods

unsafeFromBuiltinData :: BuiltinData -> TxId #

Ord TxId Source # 
Instance details

Defined in PlutusLedgerApi.V1.Data.Tx

Methods

compare :: TxId -> TxId -> Ordering

(<) :: TxId -> TxId -> Bool

(<=) :: TxId -> TxId -> Bool

(>) :: TxId -> TxId -> Bool

(>=) :: TxId -> TxId -> Bool

max :: TxId -> TxId -> TxId

min :: TxId -> TxId -> TxId

Pretty TxId Source #

using hex encoding

Instance details

Defined in PlutusLedgerApi.V1.Data.Tx

Methods

pretty :: TxId -> Doc ann

prettyList :: [TxId] -> Doc ann

Lift DefaultUni TxId Source # 
Instance details

Defined in PlutusLedgerApi.V1.Data.Tx

Methods

lift :: TxId -> RTCompile DefaultUni fun (Term TyName Name DefaultUni fun ())

Typeable DefaultUni TxId Source # 
Instance details

Defined in PlutusLedgerApi.V1.Data.Tx

Methods

typeRep :: Proxy TxId -> RTCompile DefaultUni fun (Type TyName DefaultUni ())

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.60.0.0-G1HmqwHNllaA7AnJNjAfhP" '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 ScriptTag 
Instance details

Defined in PlutusLedgerApi.V1.Data.Tx

type Rep ScriptTag = D1 ('MetaData "ScriptTag" "PlutusLedgerApi.V1.Data.Tx" "plutus-ledger-api-1.60.0.0-G1HmqwHNllaA7AnJNjAfhP" 'False) ((C1 ('MetaCons "Spend" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Mint" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "Cert" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Reward" 'PrefixI 'False) (U1 :: Type -> Type)))

Methods

from :: ScriptTag -> Rep ScriptTag x Source #

to :: Rep ScriptTag x -> ScriptTag Source #

Show ScriptTag Source # 
Instance details

Defined in PlutusLedgerApi.V1.Data.Tx

Methods

showsPrec :: Int -> ScriptTag -> ShowS Source #

show :: ScriptTag -> String Source #

showList :: [ScriptTag] -> ShowS Source #

NFData ScriptTag Source # 
Instance details

Defined in PlutusLedgerApi.V1.Data.Tx

Methods

rnf :: ScriptTag -> () Source #

Eq ScriptTag Source # 
Instance details

Defined in PlutusLedgerApi.V1.Data.Tx

Methods

(==) :: ScriptTag -> ScriptTag -> Bool Source #

(/=) :: ScriptTag -> ScriptTag -> Bool Source #

Ord ScriptTag Source # 
Instance details

Defined in PlutusLedgerApi.V1.Data.Tx

Methods

compare :: ScriptTag -> ScriptTag -> Ordering Source #

(<) :: ScriptTag -> ScriptTag -> Bool Source #

(<=) :: ScriptTag -> ScriptTag -> Bool Source #

(>) :: ScriptTag -> ScriptTag -> Bool Source #

(>=) :: ScriptTag -> ScriptTag -> Bool Source #

max :: ScriptTag -> ScriptTag -> ScriptTag Source #

min :: ScriptTag -> ScriptTag -> ScriptTag Source #

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.60.0.0-G1HmqwHNllaA7AnJNjAfhP" 'False) ((C1 ('MetaCons "Spend" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Mint" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "Cert" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Reward" 'PrefixI 'False) (U1 :: Type -> Type)))

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.

Constructors

RedeemerPtr ScriptTag Integer 

Instances

Instances details
Generic RedeemerPtr Source # 
Instance details

Defined in PlutusLedgerApi.V1.Data.Tx

Associated Types

type Rep RedeemerPtr 
Instance details

Defined in PlutusLedgerApi.V1.Data.Tx

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

Methods

from :: RedeemerPtr -> Rep RedeemerPtr x Source #

to :: Rep RedeemerPtr x -> RedeemerPtr Source #

Show RedeemerPtr Source # 
Instance details

Defined in PlutusLedgerApi.V1.Data.Tx

Methods

showsPrec :: Int -> RedeemerPtr -> ShowS Source #

show :: RedeemerPtr -> String Source #

showList :: [RedeemerPtr] -> ShowS Source #

NFData RedeemerPtr Source # 
Instance details

Defined in PlutusLedgerApi.V1.Data.Tx

Methods

rnf :: RedeemerPtr -> () Source #

Eq RedeemerPtr Source # 
Instance details

Defined in PlutusLedgerApi.V1.Data.Tx

Methods

(==) :: RedeemerPtr -> RedeemerPtr -> Bool Source #

(/=) :: RedeemerPtr -> RedeemerPtr -> Bool Source #

Ord RedeemerPtr Source # 
Instance details

Defined in PlutusLedgerApi.V1.Data.Tx

Methods

compare :: RedeemerPtr -> RedeemerPtr -> Ordering Source #

(<) :: RedeemerPtr -> RedeemerPtr -> Bool Source #

(<=) :: RedeemerPtr -> RedeemerPtr -> Bool Source #

(>) :: RedeemerPtr -> RedeemerPtr -> Bool Source #

(>=) :: RedeemerPtr -> RedeemerPtr -> Bool Source #

max :: RedeemerPtr -> RedeemerPtr -> RedeemerPtr Source #

min :: RedeemerPtr -> RedeemerPtr -> RedeemerPtr Source #

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.60.0.0-G1HmqwHNllaA7AnJNjAfhP" 'False) (C1 ('MetaCons "RedeemerPtr" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ScriptTag) :*: S1 ('MetaSel ('Nothing :: Maybe 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 TxOut 
Instance details

Defined in PlutusLedgerApi.V1.Data.Tx

type Rep TxOut = D1 ('MetaData "TxOut" "PlutusLedgerApi.V1.Data.Tx" "plutus-ledger-api-1.60.0.0-G1HmqwHNllaA7AnJNjAfhP" 'True) (C1 ('MetaCons "TxOut_6989586621680122187" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 BuiltinData)))

Methods

from :: TxOut -> Rep TxOut x Source #

to :: Rep TxOut x -> TxOut Source #

Show TxOut Source # 
Instance details

Defined in PlutusLedgerApi.V1.Data.Tx

Methods

showsPrec :: Int -> TxOut -> ShowS Source #

show :: TxOut -> String Source #

showList :: [TxOut] -> ShowS Source #

Eq TxOut Source # 
Instance details

Defined in PlutusLedgerApi.V1.Data.Tx

Methods

(==) :: TxOut -> TxOut -> Bool Source #

(/=) :: TxOut -> TxOut -> Bool Source #

Eq TxOut Source # 
Instance details

Defined in PlutusLedgerApi.V1.Data.Tx

Methods

(==) :: TxOut -> TxOut -> Bool

FromData TxOut Source # 
Instance details

Defined in PlutusLedgerApi.V1.Data.Tx

Methods

fromBuiltinData :: BuiltinData -> Maybe TxOut #

ToData TxOut Source # 
Instance details

Defined in PlutusLedgerApi.V1.Data.Tx

Methods

toBuiltinData :: TxOut -> BuiltinData #

UnsafeFromData TxOut Source # 
Instance details

Defined in PlutusLedgerApi.V1.Data.Tx

Methods

unsafeFromBuiltinData :: BuiltinData -> TxOut #

Pretty TxOut Source # 
Instance details

Defined in PlutusLedgerApi.V1.Data.Tx

Methods

pretty :: TxOut -> Doc ann

prettyList :: [TxOut] -> Doc ann

Lift DefaultUni TxOut Source # 
Instance details

Defined in PlutusLedgerApi.V1.Data.Tx

Methods

lift :: TxOut -> RTCompile DefaultUni fun (Term TyName Name DefaultUni fun ())

Typeable DefaultUni TxOut Source # 
Instance details

Defined in PlutusLedgerApi.V1.Data.Tx

Methods

typeRep :: Proxy TxOut -> RTCompile DefaultUni fun (Type TyName DefaultUni ())

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.60.0.0-G1HmqwHNllaA7AnJNjAfhP" 'True) (C1 ('MetaCons "TxOut_6989586621680122187" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 BuiltinData)))

pattern TxOut :: Address -> Value -> Maybe DatumHash -> TxOut Source #

matchTxOut :: TxOut -> (Address -> Value -> Maybe DatumHash -> r) -> r Source #

txOutAddress :: TxOut -> Address Source #

txOutValue :: TxOut -> Value Source #

txOutDatumHash :: TxOut -> Maybe DatumHash Source #

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.

Instances

Instances details
Generic TxOutRef Source # 
Instance details

Defined in PlutusLedgerApi.V1.Data.Tx

Associated Types

type Rep TxOutRef 
Instance details

Defined in PlutusLedgerApi.V1.Data.Tx

type Rep TxOutRef = D1 ('MetaData "TxOutRef" "PlutusLedgerApi.V1.Data.Tx" "plutus-ledger-api-1.60.0.0-G1HmqwHNllaA7AnJNjAfhP" 'True) (C1 ('MetaCons "TxOutRef_6989586621680121377" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 BuiltinData)))

Methods

from :: TxOutRef -> Rep TxOutRef x Source #

to :: Rep TxOutRef x -> TxOutRef Source #

Show TxOutRef Source # 
Instance details

Defined in PlutusLedgerApi.V1.Data.Tx

Methods

showsPrec :: Int -> TxOutRef -> ShowS Source #

show :: TxOutRef -> String Source #

showList :: [TxOutRef] -> ShowS Source #

NFData TxOutRef Source # 
Instance details

Defined in PlutusLedgerApi.V1.Data.Tx

Methods

rnf :: TxOutRef -> () Source #

Eq TxOutRef Source # 
Instance details

Defined in PlutusLedgerApi.V1.Data.Tx

Methods

(==) :: TxOutRef -> TxOutRef -> Bool Source #

(/=) :: TxOutRef -> TxOutRef -> Bool Source #

Ord TxOutRef Source # 
Instance details

Defined in PlutusLedgerApi.V1.Data.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 #

Eq TxOutRef Source # 
Instance details

Defined in PlutusLedgerApi.V1.Data.Tx

Methods

(==) :: TxOutRef -> TxOutRef -> Bool

FromData TxOutRef Source # 
Instance details

Defined in PlutusLedgerApi.V1.Data.Tx

Methods

fromBuiltinData :: BuiltinData -> Maybe TxOutRef #

ToData TxOutRef Source # 
Instance details

Defined in PlutusLedgerApi.V1.Data.Tx

Methods

toBuiltinData :: TxOutRef -> BuiltinData #

UnsafeFromData TxOutRef Source # 
Instance details

Defined in PlutusLedgerApi.V1.Data.Tx

Methods

unsafeFromBuiltinData :: BuiltinData -> TxOutRef #

Pretty TxOutRef Source # 
Instance details

Defined in PlutusLedgerApi.V1.Data.Tx

Methods

pretty :: TxOutRef -> Doc ann

prettyList :: [TxOutRef] -> Doc ann

Lift DefaultUni TxOutRef Source # 
Instance details

Defined in PlutusLedgerApi.V1.Data.Tx

Methods

lift :: TxOutRef -> RTCompile DefaultUni fun (Term TyName Name DefaultUni fun ())

Typeable DefaultUni TxOutRef Source # 
Instance details

Defined in PlutusLedgerApi.V1.Data.Tx

Methods

typeRep :: Proxy TxOutRef -> RTCompile DefaultUni fun (Type TyName DefaultUni ())

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.60.0.0-G1HmqwHNllaA7AnJNjAfhP" 'True) (C1 ('MetaCons "TxOutRef_6989586621680121377" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 BuiltinData)))

pattern TxOutRef :: TxId -> Integer -> TxOutRef Source #

matchTxOutRef :: TxOutRef -> (TxId -> Integer -> r) -> r Source #

txOutRefId :: TxOutRef -> TxId Source #

txOutRefIdx :: TxOutRef -> Integer Source #

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.

outAddress :: Lens' TxOut Address Source #

The address of a transaction output.

outValue :: Lens' TxOut Value Source #

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

txOutPubKey :: TxOut -> Maybe PubKeyHash Source #

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

txOutDatum :: TxOut -> Maybe DatumHash Source #

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

pubKeyHashTxOut :: Value -> PubKeyHash -> TxOut Source #

Create a transaction output locked by a public key.