Safe Haskell	None
Language	Haskell2010

Plutus.V1.Ledger.Tx

Contents

Transactions
Transaction outputs
Transaction inputs

Synopsis

newtype TxId = TxId {
- getTxId :: BuiltinByteString
}
data ScriptTag
- = Spend
- | Mint
- | Cert
- | Reward
data RedeemerPtr = RedeemerPtr ScriptTag Integer
type Redeemers = Map RedeemerPtr Redeemer
data TxOut = TxOut {
- txOutAddress :: Address
- txOutValue :: Value
- txOutDatumHash :: Maybe DatumHash
}
data TxOutRef = TxOutRef {
- txOutRefId :: TxId
- txOutRefIdx :: Integer
}
isPubKeyOut :: TxOut -> Bool
isPayToScriptOut :: TxOut -> Bool
outAddress :: Lens' TxOut Address
outValue :: Lens' TxOut Value
txOutPubKey :: TxOut -> Maybe PubKeyHash
txOutDatum :: TxOut -> Maybe DatumHash
pubKeyHashTxOut :: Value -> PubKeyHash -> TxOut
data TxInType
- = ConsumeScriptAddress ! Validator ! Redeemer ! Datum
- | ConsumePublicKeyAddress
- | ConsumeSimpleScriptAddress
data TxIn = TxIn {
- txInRef :: ! TxOutRef
- txInType :: Maybe TxInType
}
inRef :: Lens' TxIn TxOutRef
inType :: Lens' TxIn ( Maybe TxInType )
inScripts :: TxIn -> Maybe ( Validator , Redeemer , Datum )
pubKeyTxIn :: TxOutRef -> TxIn
scriptTxIn :: TxOutRef -> Validator -> Redeemer -> Datum -> TxIn
pubKeyTxIns :: Fold ( Set TxIn ) TxIn
scriptTxIns :: Fold ( Set TxIn ) TxIn

Transactions

newtype TxId Source #

A transaction ID, using a SHA256 hash as the transaction id.

Constructors

TxId
Fields getTxId :: BuiltinByteString

Instances

Instances details

Eq TxId Source #
Instance details Defined in Plutus.V1.Ledger.Tx Methods (==) :: TxId -> TxId -> Bool Source # (/=) :: TxId -> TxId -> Bool Source #
Ord TxId Source #
Instance details Defined in Plutus.V1.Ledger.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 #
Show TxId Source #
Instance details Defined in Plutus.V1.Ledger.Tx Methods showsPrec :: Int -> TxId -> ShowS Source # show :: TxId -> String Source # showList :: [ TxId ] -> ShowS Source #
IsString TxId Source #
Instance details Defined in Plutus.V1.Ledger.Tx Methods fromString :: String -> TxId Source #
Generic TxId Source #
Instance details Defined in Plutus.V1.Ledger.Tx Associated Types type Rep TxId :: Type -> Type Source # Methods from :: TxId -> Rep TxId x Source # to :: Rep TxId x -> TxId Source #
NFData TxId Source #
Instance details Defined in Plutus.V1.Ledger.Tx Methods rnf :: TxId -> () Source #
Pretty TxId Source #
Instance details Defined in Plutus.V1.Ledger.Tx Methods pretty :: TxId -> Doc ann Source # prettyList :: [ TxId ] -> Doc ann Source #
ToData TxId Source #
Instance details Defined in Plutus.V1.Ledger.Tx Methods toBuiltinData :: TxId -> BuiltinData Source #
FromData TxId Source #
Instance details Defined in Plutus.V1.Ledger.Tx Methods fromBuiltinData :: BuiltinData -> Maybe TxId Source #
UnsafeFromData TxId Source #
Instance details Defined in Plutus.V1.Ledger.Tx Methods unsafeFromBuiltinData :: BuiltinData -> TxId Source #
Ord TxId Source #
Instance details Defined in Plutus.V1.Ledger.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 Plutus.V1.Ledger.Tx Methods (==) :: TxId -> TxId -> Bool Source #
Lift DefaultUni TxId Source #
Instance details Defined in Plutus.V1.Ledger.Tx Methods lift :: TxId -> RTCompile DefaultUni fun ( Term TyName Name DefaultUni fun ()) Source #
Typeable DefaultUni TxId Source #
Instance details Defined in Plutus.V1.Ledger.Tx Methods typeRep :: Proxy TxId -> RTCompile DefaultUni fun ( Type TyName DefaultUni ()) Source #
type Rep TxId Source #
Instance details Defined in Plutus.V1.Ledger.Tx type Rep TxId = D1 (' MetaData "TxId" "Plutus.V1.Ledger.Tx" "plutus-ledger-api-1.0.0.1-GlUFhIIE0LJGuJDDdHh5lQ" ' 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.

Constructors

Spend
Mint
Cert
Reward

Instances

Instances details

Eq ScriptTag Source #
Instance details Defined in Plutus.V1.Ledger.Tx Methods (==) :: ScriptTag -> ScriptTag -> Bool Source # (/=) :: ScriptTag -> ScriptTag -> Bool Source #
Ord ScriptTag Source #
Instance details Defined in Plutus.V1.Ledger.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 #
Show ScriptTag Source #
Instance details Defined in Plutus.V1.Ledger.Tx Methods showsPrec :: Int -> ScriptTag -> ShowS Source # show :: ScriptTag -> String Source # showList :: [ ScriptTag ] -> ShowS Source #
Generic ScriptTag Source #
Instance details Defined in Plutus.V1.Ledger.Tx Associated Types type Rep ScriptTag :: Type -> Type Source # Methods from :: ScriptTag -> Rep ScriptTag x Source # to :: Rep ScriptTag x -> ScriptTag Source #
NFData ScriptTag Source #
Instance details Defined in Plutus.V1.Ledger.Tx Methods rnf :: ScriptTag -> () Source #
type Rep ScriptTag Source #
Instance details Defined in Plutus.V1.Ledger.Tx type Rep ScriptTag = D1 (' MetaData "ScriptTag" "Plutus.V1.Ledger.Tx" "plutus-ledger-api-1.0.0.1-GlUFhIIE0LJGuJDDdHh5lQ" ' 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 t and an index i, picking out the ith script of type t in the transaction.

Constructors

RedeemerPtr ScriptTag Integer

Instances

Instances details

Eq RedeemerPtr Source #
Instance details Defined in Plutus.V1.Ledger.Tx Methods (==) :: RedeemerPtr -> RedeemerPtr -> Bool Source # (/=) :: RedeemerPtr -> RedeemerPtr -> Bool Source #
Ord RedeemerPtr Source #
Instance details Defined in Plutus.V1.Ledger.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 #
Show RedeemerPtr Source #
Instance details Defined in Plutus.V1.Ledger.Tx Methods showsPrec :: Int -> RedeemerPtr -> ShowS Source # show :: RedeemerPtr -> String Source # showList :: [ RedeemerPtr ] -> ShowS Source #
Generic RedeemerPtr Source #
Instance details Defined in Plutus.V1.Ledger.Tx Associated Types type Rep RedeemerPtr :: Type -> Type Source # Methods from :: RedeemerPtr -> Rep RedeemerPtr x Source # to :: Rep RedeemerPtr x -> RedeemerPtr Source #
NFData RedeemerPtr Source #
Instance details Defined in Plutus.V1.Ledger.Tx Methods rnf :: RedeemerPtr -> () Source #
type Rep RedeemerPtr Source #
Instance details Defined in Plutus.V1.Ledger.Tx type Rep RedeemerPtr = D1 (' MetaData "RedeemerPtr" "Plutus.V1.Ledger.Tx" "plutus-ledger-api-1.0.0.1-GlUFhIIE0LJGuJDDdHh5lQ" ' 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 #

Transaction outputs

data TxOut Source #

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

Constructors

TxOut
Fields txOutAddress :: Address txOutValue :: Value txOutDatumHash :: Maybe DatumHash

Instances

Instances details

Eq TxOut Source #
Instance details Defined in Plutus.V1.Ledger.Tx Methods (==) :: TxOut -> TxOut -> Bool Source # (/=) :: TxOut -> TxOut -> Bool Source #
Show TxOut Source #
Instance details Defined in Plutus.V1.Ledger.Tx Methods showsPrec :: Int -> TxOut -> ShowS Source # show :: TxOut -> String Source # showList :: [ TxOut ] -> ShowS Source #
Generic TxOut Source #
Instance details Defined in Plutus.V1.Ledger.Tx Associated Types type Rep TxOut :: Type -> Type Source # Methods from :: TxOut -> Rep TxOut x Source # to :: Rep TxOut x -> TxOut Source #
NFData TxOut Source #
Instance details Defined in Plutus.V1.Ledger.Tx Methods rnf :: TxOut -> () Source #
Pretty TxOut Source #
Instance details Defined in Plutus.V1.Ledger.Tx Methods pretty :: TxOut -> Doc ann Source # prettyList :: [ TxOut ] -> Doc ann Source #
ToData TxOut Source #
Instance details Defined in Plutus.V1.Ledger.Tx Methods toBuiltinData :: TxOut -> BuiltinData Source #
FromData TxOut Source #
Instance details Defined in Plutus.V1.Ledger.Tx Methods fromBuiltinData :: BuiltinData -> Maybe TxOut Source #
UnsafeFromData TxOut Source #
Instance details Defined in Plutus.V1.Ledger.Tx Methods unsafeFromBuiltinData :: BuiltinData -> TxOut Source #
Eq TxOut Source #
Instance details Defined in Plutus.V1.Ledger.Tx Methods (==) :: TxOut -> TxOut -> Bool Source #
Lift DefaultUni TxOut Source #
Instance details Defined in Plutus.V1.Ledger.Tx Methods lift :: TxOut -> RTCompile DefaultUni fun ( Term TyName Name DefaultUni fun ()) Source #
Typeable DefaultUni TxOut Source #
Instance details Defined in Plutus.V1.Ledger.Tx Methods typeRep :: Proxy TxOut -> RTCompile DefaultUni fun ( Type TyName DefaultUni ()) Source #
type Rep TxOut Source #
Instance details Defined in Plutus.V1.Ledger.Tx type Rep TxOut = D1 (' MetaData "TxOut" "Plutus.V1.Ledger.Tx" "plutus-ledger-api-1.0.0.1-GlUFhIIE0LJGuJDDdHh5lQ" ' 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 reference, and an index indicating which of the outputs of that transaction we are referring to.

Constructors

TxOutRef
Fields txOutRefId :: TxId txOutRefIdx :: Integer Index into the referenced transaction's outputs

Instances

Instances details

Eq TxOutRef Source #
Instance details Defined in Plutus.V1.Ledger.Tx Methods (==) :: TxOutRef -> TxOutRef -> Bool Source # (/=) :: TxOutRef -> TxOutRef -> Bool Source #
Ord TxOutRef Source #
Instance details Defined in Plutus.V1.Ledger.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 #
Show TxOutRef Source #
Instance details Defined in Plutus.V1.Ledger.Tx Methods showsPrec :: Int -> TxOutRef -> ShowS Source # show :: TxOutRef -> String Source # showList :: [ TxOutRef ] -> ShowS Source #
Generic TxOutRef Source #
Instance details Defined in Plutus.V1.Ledger.Tx Associated Types type Rep TxOutRef :: Type -> Type Source # Methods from :: TxOutRef -> Rep TxOutRef x Source # to :: Rep TxOutRef x -> TxOutRef Source #
NFData TxOutRef Source #
Instance details Defined in Plutus.V1.Ledger.Tx Methods rnf :: TxOutRef -> () Source #
Pretty TxOutRef Source #
Instance details Defined in Plutus.V1.Ledger.Tx Methods pretty :: TxOutRef -> Doc ann Source # prettyList :: [ TxOutRef ] -> Doc ann Source #
ToData TxOutRef Source #
Instance details Defined in Plutus.V1.Ledger.Tx Methods toBuiltinData :: TxOutRef -> BuiltinData Source #
FromData TxOutRef Source #
Instance details Defined in Plutus.V1.Ledger.Tx Methods fromBuiltinData :: BuiltinData -> Maybe TxOutRef Source #
UnsafeFromData TxOutRef Source #
Instance details Defined in Plutus.V1.Ledger.Tx Methods unsafeFromBuiltinData :: BuiltinData -> TxOutRef Source #
Eq TxOutRef Source #
Instance details Defined in Plutus.V1.Ledger.Tx Methods (==) :: TxOutRef -> TxOutRef -> Bool Source #
Lift DefaultUni TxOutRef Source #
Instance details Defined in Plutus.V1.Ledger.Tx Methods lift :: TxOutRef -> RTCompile DefaultUni fun ( Term TyName Name DefaultUni fun ()) Source #
Typeable DefaultUni TxOutRef Source #
Instance details Defined in Plutus.V1.Ledger.Tx Methods typeRep :: Proxy TxOutRef -> RTCompile DefaultUni fun ( Type TyName DefaultUni ()) Source #
type Rep TxOutRef Source #
Instance details Defined in Plutus.V1.Ledger.Tx type Rep TxOutRef = D1 (' MetaData "TxOutRef" "Plutus.V1.Ledger.Tx" "plutus-ledger-api-1.0.0.1-GlUFhIIE0LJGuJDDdHh5lQ" ' False ) ( C1 (' MetaCons "TxOutRef" ' PrefixI ' True ) ( S1 (' MetaSel (' Just "txOutRefId") ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy ) ( Rec0 TxId ) :*: S1 (' MetaSel (' Just "txOutRefIdx") ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy ) ( Rec0 Integer )))

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.

Transaction inputs

data TxInType Source #

The type of a transaction input.

Constructors

ConsumeScriptAddress ! Validator ! Redeemer ! Datum	A transaction input that consumes a script address with the given validator, redeemer, and datum.
ConsumePublicKeyAddress	A transaction input that consumes a public key address.
ConsumeSimpleScriptAddress	Consume a simple script

Instances

Instances details

Eq TxInType Source #
Instance details Defined in Plutus.V1.Ledger.Tx Methods (==) :: TxInType -> TxInType -> Bool Source # (/=) :: TxInType -> TxInType -> Bool Source #
Ord TxInType Source #
Instance details Defined in Plutus.V1.Ledger.Tx Methods compare :: TxInType -> TxInType -> Ordering Source # (<) :: TxInType -> TxInType -> Bool Source # (<=) :: TxInType -> TxInType -> Bool Source # (>) :: TxInType -> TxInType -> Bool Source # (>=) :: TxInType -> TxInType -> Bool Source # max :: TxInType -> TxInType -> TxInType Source # min :: TxInType -> TxInType -> TxInType Source #
Show TxInType Source #
Instance details Defined in Plutus.V1.Ledger.Tx Methods showsPrec :: Int -> TxInType -> ShowS Source # show :: TxInType -> String Source # showList :: [ TxInType ] -> ShowS Source #
Generic TxInType Source #
Instance details Defined in Plutus.V1.Ledger.Tx Associated Types type Rep TxInType :: Type -> Type Source # Methods from :: TxInType -> Rep TxInType x Source # to :: Rep TxInType x -> TxInType Source #
NFData TxInType Source #
Instance details Defined in Plutus.V1.Ledger.Tx Methods rnf :: TxInType -> () Source #
type Rep TxInType Source #
Instance details Defined in Plutus.V1.Ledger.Tx type Rep TxInType = D1 (' MetaData "TxInType" "Plutus.V1.Ledger.Tx" "plutus-ledger-api-1.0.0.1-GlUFhIIE0LJGuJDDdHh5lQ" ' False ) ( C1 (' MetaCons "ConsumeScriptAddress" ' PrefixI ' False ) ( S1 (' MetaSel (' Nothing :: Maybe Symbol ) ' NoSourceUnpackedness ' SourceStrict ' DecidedStrict ) ( Rec0 Validator ) :: ( S1 (' MetaSel (' Nothing :: Maybe Symbol ) ' NoSourceUnpackedness ' SourceStrict ' DecidedStrict ) ( Rec0 Redeemer ) :: S1 (' MetaSel (' Nothing :: Maybe Symbol ) ' NoSourceUnpackedness ' SourceStrict ' DecidedStrict ) ( Rec0 Datum ))) :+: ( C1 (' MetaCons "ConsumePublicKeyAddress" ' PrefixI ' False ) ( U1 :: Type -> Type ) :+: C1 (' MetaCons "ConsumeSimpleScriptAddress" ' PrefixI ' False ) ( U1 :: Type -> Type )))

data TxIn Source #

A transaction input, consisting of a transaction output reference and an input type.

Constructors

TxIn
Fields txInRef :: ! TxOutRef txInType :: Maybe TxInType

Instances

Instances details

Eq TxIn Source #
Instance details Defined in Plutus.V1.Ledger.Tx Methods (==) :: TxIn -> TxIn -> Bool Source # (/=) :: TxIn -> TxIn -> Bool Source #
Ord TxIn Source #
Instance details Defined in Plutus.V1.Ledger.Tx Methods compare :: TxIn -> TxIn -> Ordering Source # (<) :: TxIn -> TxIn -> Bool Source # (<=) :: TxIn -> TxIn -> Bool Source # (>) :: TxIn -> TxIn -> Bool Source # (>=) :: TxIn -> TxIn -> Bool Source # max :: TxIn -> TxIn -> TxIn Source # min :: TxIn -> TxIn -> TxIn Source #
Show TxIn Source #
Instance details Defined in Plutus.V1.Ledger.Tx Methods showsPrec :: Int -> TxIn -> ShowS Source # show :: TxIn -> String Source # showList :: [ TxIn ] -> ShowS Source #
Generic TxIn Source #
Instance details Defined in Plutus.V1.Ledger.Tx Associated Types type Rep TxIn :: Type -> Type Source # Methods from :: TxIn -> Rep TxIn x Source # to :: Rep TxIn x -> TxIn Source #
NFData TxIn Source #
Instance details Defined in Plutus.V1.Ledger.Tx Methods rnf :: TxIn -> () Source #
Pretty TxIn Source #
Instance details Defined in Plutus.V1.Ledger.Tx Methods pretty :: TxIn -> Doc ann Source # prettyList :: [ TxIn ] -> Doc ann Source #
type Rep TxIn Source #
Instance details Defined in Plutus.V1.Ledger.Tx type Rep TxIn = D1 (' MetaData "TxIn" "Plutus.V1.Ledger.Tx" "plutus-ledger-api-1.0.0.1-GlUFhIIE0LJGuJDDdHh5lQ" ' False ) ( C1 (' MetaCons "TxIn" ' PrefixI ' True ) ( S1 (' MetaSel (' Just "txInRef") ' NoSourceUnpackedness ' SourceStrict ' DecidedStrict ) ( Rec0 TxOutRef ) :*: S1 (' MetaSel (' Just "txInType") ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy ) ( Rec0 ( Maybe TxInType ))))

inRef :: Lens' TxIn TxOutRef Source #

The TxOutRef spent by a transaction input.

inType :: Lens' TxIn ( Maybe TxInType ) Source #

The type of a transaction input.

inScripts :: TxIn -> Maybe ( Validator , Redeemer , Datum ) Source #

Validator, redeemer, and data scripts of a transaction input that spends a "pay to script" output.

pubKeyTxIn :: TxOutRef -> TxIn Source #

A transaction input that spends a "pay to public key" output, given the witness.

scriptTxIn :: TxOutRef -> Validator -> Redeemer -> Datum -> TxIn Source #

A transaction input that spends a "pay to script" output, given witnesses.

pubKeyTxIns :: Fold ( Set TxIn ) TxIn Source #

Filter to get only the pubkey inputs.

scriptTxIns :: Fold ( Set TxIn ) TxIn Source #

Filter to get only the script inputs.