Safe Haskell	None
Language	Haskell2010

Cardano.Api.TxBody

Contents

Transaction bodies
Byron only
- Transaction body builders
Transaction Ids
Transaction inputs
Transaction outputs
Other transaction body types
- Building vs viewing transactions
Inspecting ScriptWitnesses
Conversion to inline data
Internal conversion functions & types
Misc helpers
Data family instances

Description

Transaction bodies

Synopsis

parseTxId :: Parser TxId
data TxBody era where
- ShelleyTxBody :: ShelleyBasedEra era -> TxBody (ShelleyLedgerEra era) -> [Script (ShelleyLedgerEra era)] -> TxBodyScriptData era -> Maybe (TxAuxData (ShelleyLedgerEra era)) -> TxScriptValidity era -> TxBody era
- pattern TxBody :: TxBodyContent ViewTx era -> TxBody era
createTransactionBody :: ShelleyBasedEra era -> TxBodyContent BuildTx era -> Either TxBodyError (TxBody era)
createAndValidateTransactionBody :: ShelleyBasedEra era -> TxBodyContent BuildTx era -> Either TxBodyError (TxBody era)
data TxBodyContent build era = TxBodyContent {
- txIns :: TxIns build era
- txInsCollateral :: TxInsCollateral era
- txInsReference :: TxInsReference build era
- txOuts :: [TxOut CtxTx era]
- txTotalCollateral :: TxTotalCollateral era
- txReturnCollateral :: TxReturnCollateral CtxTx era
- txFee :: TxFee era
- txValidityLowerBound :: TxValidityLowerBound era
- txValidityUpperBound :: TxValidityUpperBound era
- txMetadata :: TxMetadataInEra era
- txAuxScripts :: TxAuxScripts era
- txExtraKeyWits :: TxExtraKeyWitnesses era
- txProtocolParams :: BuildTxWith build (Maybe (LedgerProtocolParameters era))
- txWithdrawals :: TxWithdrawals build era
- txCertificates :: TxCertificates build era
- txUpdateProposal :: TxUpdateProposal era
- txMintValue :: TxMintValue build era
- txScriptValidity :: TxScriptValidity era
- txProposalProcedures :: Maybe (Featured ConwayEraOnwards era [Proposal era])
- txVotingProcedures :: Maybe (Featured ConwayEraOnwards era (VotingProcedures era))
}
makeByronTransactionBody :: TxIns BuildTx ByronEra -> [TxOut CtxTx ByronEra] -> Either TxBodyError (Annotated Tx ByteString)
defaultTxBodyContent :: ShelleyBasedEra era -> TxBodyContent BuildTx era
defaultTxFee :: ShelleyBasedEra era -> TxFee era
defaultTxValidityUpperBound :: ShelleyBasedEra era -> TxValidityUpperBound era
setTxIns :: TxIns build era -> TxBodyContent build era -> TxBodyContent build era
modTxIns :: (TxIns build era -> TxIns build era) -> TxBodyContent build era -> TxBodyContent build era
addTxIn :: (TxIn, BuildTxWith build (Witness WitCtxTxIn era)) -> TxBodyContent build era -> TxBodyContent build era
setTxInsCollateral :: TxInsCollateral era -> TxBodyContent build era -> TxBodyContent build era
setTxInsReference :: TxInsReference build era -> TxBodyContent build era -> TxBodyContent build era
setTxOuts :: [TxOut CtxTx era] -> TxBodyContent build era -> TxBodyContent build era
modTxOuts :: ([TxOut CtxTx era] -> [TxOut CtxTx era]) -> TxBodyContent build era -> TxBodyContent build era
addTxOut :: TxOut CtxTx era -> TxBodyContent build era -> TxBodyContent build era
setTxTotalCollateral :: TxTotalCollateral era -> TxBodyContent build era -> TxBodyContent build era
setTxReturnCollateral :: TxReturnCollateral CtxTx era -> TxBodyContent build era -> TxBodyContent build era
setTxFee :: TxFee era -> TxBodyContent build era -> TxBodyContent build era
setTxValidityLowerBound :: TxValidityLowerBound era -> TxBodyContent build era -> TxBodyContent build era
setTxValidityUpperBound :: TxValidityUpperBound era -> TxBodyContent build era -> TxBodyContent build era
setTxMetadata :: TxMetadataInEra era -> TxBodyContent build era -> TxBodyContent build era
setTxAuxScripts :: TxAuxScripts era -> TxBodyContent build era -> TxBodyContent build era
setTxExtraKeyWits :: TxExtraKeyWitnesses era -> TxBodyContent build era -> TxBodyContent build era
setTxProtocolParams :: BuildTxWith build (Maybe (LedgerProtocolParameters era)) -> TxBodyContent build era -> TxBodyContent build era
setTxWithdrawals :: TxWithdrawals build era -> TxBodyContent build era -> TxBodyContent build era
setTxCertificates :: TxCertificates build era -> TxBodyContent build era -> TxBodyContent build era
setTxUpdateProposal :: TxUpdateProposal era -> TxBodyContent build era -> TxBodyContent build era
setTxMintValue :: TxMintValue build era -> TxBodyContent build era -> TxBodyContent build era
setTxScriptValidity :: TxScriptValidity era -> TxBodyContent build era -> TxBodyContent build era
data TxBodyError
- = TxBodyEmptyTxIns
- | TxBodyEmptyTxInsCollateral
- | TxBodyEmptyTxOuts
- | TxBodyOutputNegative !Quantity !TxOutInAnyEra
- | TxBodyOutputOverflow !Quantity !TxOutInAnyEra
- | TxBodyMetadataError ![(Word64, TxMetadataRangeError)]
- | TxBodyMintAdaError
- | TxBodyInIxOverflow !TxIn
- | TxBodyMissingProtocolParams
- | TxBodyProtocolParamsConversionError !ProtocolParametersConversionError
data TxBodyScriptData era where
- TxBodyNoScriptData :: TxBodyScriptData era
- TxBodyScriptData :: AlonzoEraOnwards era -> TxDats (ShelleyLedgerEra era) -> Redeemers (ShelleyLedgerEra era) -> TxBodyScriptData era
data TxScriptValidity era where
- TxScriptValidityNone :: TxScriptValidity era
- TxScriptValidity :: AlonzoEraOnwards era -> ScriptValidity -> TxScriptValidity era
data ScriptValidity
- = ScriptInvalid
- | ScriptValid
scriptValidityToIsValid :: ScriptValidity -> IsValid
isValidToScriptValidity :: IsValid -> ScriptValidity
scriptValidityToTxScriptValidity :: ShelleyBasedEra era -> ScriptValidity -> TxScriptValidity era
txScriptValidityToIsValid :: TxScriptValidity era -> IsValid
txScriptValidityToScriptValidity :: TxScriptValidity era -> ScriptValidity
newtype TxId = TxId (Hash StandardCrypto EraIndependentTxBody)
getTxId :: TxBody era -> TxId
getTxIdByron :: ATxAux ByteString -> TxId
getTxIdShelley :: EraCrypto (ShelleyLedgerEra era) ~ StandardCrypto => EraTxBody (ShelleyLedgerEra era) => ShelleyBasedEra era -> TxBody (ShelleyLedgerEra era) -> TxId
data TxIn = TxIn TxId TxIx
type TxIns build era = [(TxIn, BuildTxWith build (Witness WitCtxTxIn era))]
newtype TxIx = TxIx Word
genesisUTxOPseudoTxIn :: NetworkId -> Hash GenesisUTxOKey -> TxIn
data CtxTx
data CtxUTxO
data TxOut ctx era = TxOut (AddressInEra era) (TxOutValue era) (TxOutDatum ctx era) (ReferenceScript era)
data TxOutValue era where
- TxOutValueByron :: Lovelace -> TxOutValue era
- TxOutValueShelleyBased :: (Eq (Value (ShelleyLedgerEra era)), Show (Value (ShelleyLedgerEra era))) => ShelleyBasedEra era -> Value (ShelleyLedgerEra era) -> TxOutValue era
data TxOutDatum ctx era where
- TxOutDatumNone :: TxOutDatum ctx era
- TxOutDatumHash :: AlonzoEraOnwards era -> Hash ScriptData -> TxOutDatum ctx era
- TxOutDatumInline :: BabbageEraOnwards era -> HashableScriptData -> TxOutDatum ctx era
- pattern TxOutDatumInTx :: AlonzoEraOnwards era -> HashableScriptData -> TxOutDatum CtxTx era
toCtxUTxOTxOut :: TxOut CtxTx era -> TxOut CtxUTxO era
lovelaceToTxOutValue :: ShelleyBasedEra era -> Lovelace -> TxOutValue era
prettyRenderTxOut :: TxOutInAnyEra -> Text
txOutValueToLovelace :: TxOutValue era -> Lovelace
txOutValueToValue :: TxOutValue era -> Value
parseHash :: SerialiseAsRawBytes (Hash a) => AsType (Hash a) -> Parser (Hash a)
data TxOutInAnyEra where
- TxOutInAnyEra :: CardanoEra era -> TxOut CtxTx era -> TxOutInAnyEra
txOutInAnyEra :: CardanoEra era -> TxOut CtxTx era -> TxOutInAnyEra
data TxInsCollateral era where
- TxInsCollateralNone :: TxInsCollateral era
- TxInsCollateral :: AlonzoEraOnwards era -> [TxIn] -> TxInsCollateral era
data TxInsReference build era where
- TxInsReferenceNone :: TxInsReference build era
- TxInsReference :: BabbageEraOnwards era -> [TxIn] -> TxInsReference build era
data TxReturnCollateral ctx era where
- TxReturnCollateralNone :: TxReturnCollateral ctx era
- TxReturnCollateral :: BabbageEraOnwards era -> TxOut ctx era -> TxReturnCollateral ctx era
data TxTotalCollateral era where
- TxTotalCollateralNone :: TxTotalCollateral era
- TxTotalCollateral :: BabbageEraOnwards era -> Lovelace -> TxTotalCollateral era
data TxFee era where
- TxFeeExplicit :: ShelleyBasedEra era -> Lovelace -> TxFee era
data TxValidityLowerBound era where
- TxValidityNoLowerBound :: TxValidityLowerBound era
- TxValidityLowerBound :: AllegraEraOnwards era -> SlotNo -> TxValidityLowerBound era
data TxValidityUpperBound era where
- TxValidityUpperBound :: ShelleyBasedEra era -> Maybe SlotNo -> TxValidityUpperBound era
data TxMetadataInEra era where
- TxMetadataNone :: TxMetadataInEra era
- TxMetadataInEra :: ShelleyBasedEra era -> TxMetadata -> TxMetadataInEra era
data TxAuxScripts era where
- TxAuxScriptsNone :: TxAuxScripts era
- TxAuxScripts :: AllegraEraOnwards era -> [ScriptInEra era] -> TxAuxScripts era
data TxExtraKeyWitnesses era where
- TxExtraKeyWitnessesNone :: TxExtraKeyWitnesses era
- TxExtraKeyWitnesses :: AlonzoEraOnwards era -> [Hash PaymentKey] -> TxExtraKeyWitnesses era
data TxWithdrawals build era where
- TxWithdrawalsNone :: TxWithdrawals build era
- TxWithdrawals :: ShelleyBasedEra era -> [(StakeAddress, Lovelace, BuildTxWith build (Witness WitCtxStake era))] -> TxWithdrawals build era
data TxCertificates build era where
- TxCertificatesNone :: TxCertificates build era
- TxCertificates :: ShelleyBasedEra era -> [Certificate era] -> BuildTxWith build (Map StakeCredential (Witness WitCtxStake era)) -> TxCertificates build era
data TxUpdateProposal era where
- TxUpdateProposalNone :: TxUpdateProposal era
- TxUpdateProposal :: ShelleyToBabbageEra era -> UpdateProposal -> TxUpdateProposal era
data TxMintValue build era where
- TxMintNone :: TxMintValue build era
- TxMintValue :: MaryEraOnwards era -> Value -> BuildTxWith build (Map PolicyId (ScriptWitness WitCtxMint era)) -> TxMintValue build era
data BuildTxWith build a where
- ViewTx :: BuildTxWith ViewTx a
- BuildTxWith :: a -> BuildTxWith BuildTx a
data BuildTx
data ViewTx
data AnyScriptWitness era where
- AnyScriptWitness :: ScriptWitness witctx era -> AnyScriptWitness era
data ScriptWitnessIndex
- = ScriptWitnessIndexTxIn !Word
- | ScriptWitnessIndexMint !Word
- | ScriptWitnessIndexCertificate !Word
- | ScriptWitnessIndexWithdrawal !Word
renderScriptWitnessIndex :: ScriptWitnessIndex -> String
collectTxBodyScriptWitnesses :: forall era. ShelleyBasedEra era -> TxBodyContent BuildTx era -> [(ScriptWitnessIndex, AnyScriptWitness era)]
scriptDataToInlineDatum :: Era ledgerera => HashableScriptData -> Datum ledgerera
toByronTxId :: TxId -> TxId
toShelleyTxId :: TxId -> TxId StandardCrypto
toShelleyTxIn :: TxIn -> TxIn StandardCrypto
toShelleyTxOut :: forall era ledgerera. ShelleyLedgerEra era ~ ledgerera => ShelleyBasedEra era -> TxOut CtxUTxO era -> TxOut ledgerera
toShelleyTxOutAny :: forall ctx era ledgerera. ShelleyLedgerEra era ~ ledgerera => ShelleyBasedEra era -> TxOut ctx era -> TxOut ledgerera
fromShelleyTxId :: TxId StandardCrypto -> TxId
fromShelleyTxIn :: TxIn StandardCrypto -> TxIn
fromShelleyTxOut :: forall era ctx. ShelleyBasedEra era -> TxOut (ShelleyLedgerEra era) -> TxOut ctx era
toAlonzoRdmrPtr :: ScriptWitnessIndex -> RdmrPtr
fromAlonzoRdmrPtr :: RdmrPtr -> ScriptWitnessIndex
fromByronTxIn :: TxIn -> TxIn
fromLedgerTxOuts :: forall era. ShelleyBasedEra era -> TxBody (ShelleyLedgerEra era) -> TxBodyScriptData era -> [TxOut CtxTx era]
renderTxIn :: TxIn -> Text
calculateExecutionUnitsLovelace :: Prices -> ExecutionUnits -> Maybe Lovelace
orderStakeAddrs :: [(StakeAddress, x, v)] -> [(StakeAddress, x, v)]
orderTxIns :: [(TxIn, v)] -> [(TxIn, v)]
data family AsType t
getTxBodyContent :: TxBody era -> TxBodyContent ViewTx era

Documentation

parseTxId :: Parser TxId Source #

Transaction bodies

data TxBody era where Source #

Constructors

ShelleyTxBody
Fields :: ShelleyBasedEra era -> TxBody (ShelleyLedgerEra era) -> [Script (ShelleyLedgerEra era)] -> TxBodyScriptData era -> Maybe (TxAuxData (ShelleyLedgerEra era)) -> TxScriptValidity era Mark script as expected to pass or fail validation -> TxBody era

Bundled Patterns

pattern TxBody :: TxBodyContent ViewTx era -> TxBody era

Instances

Instances details

Eq (TxBody era) Source #
Instance details Defined in Cardano.Api.TxBody Methods (==) :: TxBody era -> TxBody era -> Bool Source # (/=) :: TxBody era -> TxBody era -> Bool Source #
Show (TxBody era) Source #
Instance details Defined in Cardano.Api.TxBody Methods showsPrec :: Int -> TxBody era -> ShowS Source # show :: TxBody era -> String Source # showList :: [TxBody era] -> ShowS Source #
HasTypeProxy era => HasTypeProxy (TxBody era) Source #
Instance details Defined in Cardano.Api.TxBody Associated Types data AsType (TxBody era) Source # Methods proxyToAsType :: Proxy (TxBody era) -> AsType (TxBody era) Source #
IsShelleyBasedEra era => SerialiseAsCBOR (TxBody era) Source #
Instance details Defined in Cardano.Api.TxBody Methods serialiseToCBOR :: TxBody era -> ByteString Source # deserialiseFromCBOR :: AsType (TxBody era) -> ByteString -> Either DecoderError (TxBody era) Source #
IsShelleyBasedEra era => HasTextEnvelope (TxBody era) Source #
Instance details Defined in Cardano.Api.TxBody Methods textEnvelopeType :: AsType (TxBody era) -> TextEnvelopeType Source # textEnvelopeDefaultDescr :: TxBody era -> TextEnvelopeDescr Source #
data AsType (TxBody era) Source #
Instance details Defined in Cardano.Api.TxBody data AsType (TxBody era) = AsTxBody (AsType era)

createTransactionBody :: ShelleyBasedEra era -> TxBodyContent BuildTx era -> Either TxBodyError (TxBody era) Source #

createAndValidateTransactionBody :: ShelleyBasedEra era -> TxBodyContent BuildTx era -> Either TxBodyError (TxBody era) Source #

data TxBodyContent build era Source #

Constructors

TxBodyContent

Fields

txIns :: TxIns build era
txInsCollateral :: TxInsCollateral era
txInsReference :: TxInsReference build era
txOuts :: [TxOut CtxTx era]
txTotalCollateral :: TxTotalCollateral era
txReturnCollateral :: TxReturnCollateral CtxTx era
txFee :: TxFee era
txValidityLowerBound :: TxValidityLowerBound era
txValidityUpperBound :: TxValidityUpperBound era
txMetadata :: TxMetadataInEra era
txAuxScripts :: TxAuxScripts era
txExtraKeyWits :: TxExtraKeyWitnesses era
txProtocolParams :: BuildTxWith build (Maybe (LedgerProtocolParameters era))
txWithdrawals :: TxWithdrawals build era
txCertificates :: TxCertificates build era
txUpdateProposal :: TxUpdateProposal era
txMintValue :: TxMintValue build era
txScriptValidity :: TxScriptValidity era
txProposalProcedures :: Maybe (Featured ConwayEraOnwards era [Proposal era])
txVotingProcedures :: Maybe (Featured ConwayEraOnwards era (VotingProcedures era))

Instances

Instances details

IsShelleyBasedEra era => Eq (TxBodyContent build era) Source #
Instance details Defined in Cardano.Api.TxBody Methods (==) :: TxBodyContent build era -> TxBodyContent build era -> Bool Source # (/=) :: TxBodyContent build era -> TxBodyContent build era -> Bool Source #
IsShelleyBasedEra era => Show (TxBodyContent build era) Source #
Instance details Defined in Cardano.Api.TxBody Methods showsPrec :: Int -> TxBodyContent build era -> ShowS Source # show :: TxBodyContent build era -> String Source # showList :: [TxBodyContent build era] -> ShowS Source #

Byron only

makeByronTransactionBody :: TxIns BuildTx ByronEra -> [TxOut CtxTx ByronEra] -> Either TxBodyError (Annotated Tx ByteString) Source #

Transaction body builders

defaultTxBodyContent :: ShelleyBasedEra era -> TxBodyContent BuildTx era Source #

defaultTxFee :: ShelleyBasedEra era -> TxFee era Source #

defaultTxValidityUpperBound :: ShelleyBasedEra era -> TxValidityUpperBound era Source #

setTxIns :: TxIns build era -> TxBodyContent build era -> TxBodyContent build era Source #

modTxIns :: (TxIns build era -> TxIns build era) -> TxBodyContent build era -> TxBodyContent build era Source #

addTxIn :: (TxIn, BuildTxWith build (Witness WitCtxTxIn era)) -> TxBodyContent build era -> TxBodyContent build era Source #

setTxInsCollateral :: TxInsCollateral era -> TxBodyContent build era -> TxBodyContent build era Source #

setTxInsReference :: TxInsReference build era -> TxBodyContent build era -> TxBodyContent build era Source #

setTxOuts :: [TxOut CtxTx era] -> TxBodyContent build era -> TxBodyContent build era Source #

modTxOuts :: ([TxOut CtxTx era] -> [TxOut CtxTx era]) -> TxBodyContent build era -> TxBodyContent build era Source #

addTxOut :: TxOut CtxTx era -> TxBodyContent build era -> TxBodyContent build era Source #

setTxTotalCollateral :: TxTotalCollateral era -> TxBodyContent build era -> TxBodyContent build era Source #

setTxReturnCollateral :: TxReturnCollateral CtxTx era -> TxBodyContent build era -> TxBodyContent build era Source #

setTxFee :: TxFee era -> TxBodyContent build era -> TxBodyContent build era Source #

setTxValidityLowerBound :: TxValidityLowerBound era -> TxBodyContent build era -> TxBodyContent build era Source #

setTxValidityUpperBound :: TxValidityUpperBound era -> TxBodyContent build era -> TxBodyContent build era Source #

setTxMetadata :: TxMetadataInEra era -> TxBodyContent build era -> TxBodyContent build era Source #

setTxAuxScripts :: TxAuxScripts era -> TxBodyContent build era -> TxBodyContent build era Source #

setTxExtraKeyWits :: TxExtraKeyWitnesses era -> TxBodyContent build era -> TxBodyContent build era Source #

setTxProtocolParams :: BuildTxWith build (Maybe (LedgerProtocolParameters era)) -> TxBodyContent build era -> TxBodyContent build era Source #

setTxWithdrawals :: TxWithdrawals build era -> TxBodyContent build era -> TxBodyContent build era Source #

setTxCertificates :: TxCertificates build era -> TxBodyContent build era -> TxBodyContent build era Source #

setTxUpdateProposal :: TxUpdateProposal era -> TxBodyContent build era -> TxBodyContent build era Source #

setTxMintValue :: TxMintValue build era -> TxBodyContent build era -> TxBodyContent build era Source #

setTxScriptValidity :: TxScriptValidity era -> TxBodyContent build era -> TxBodyContent build era Source #

data TxBodyError Source #

Constructors

TxBodyEmptyTxIns
TxBodyEmptyTxInsCollateral
TxBodyEmptyTxOuts
TxBodyOutputNegative !Quantity !TxOutInAnyEra
TxBodyOutputOverflow !Quantity !TxOutInAnyEra
TxBodyMetadataError ![(Word64, TxMetadataRangeError)]
TxBodyMintAdaError
TxBodyInIxOverflow !TxIn
TxBodyMissingProtocolParams
TxBodyProtocolParamsConversionError !ProtocolParametersConversionError

Instances

Instances details

Eq TxBodyError Source #
Instance details Defined in Cardano.Api.TxBody Methods (==) :: TxBodyError -> TxBodyError -> Bool Source # (/=) :: TxBodyError -> TxBodyError -> Bool Source #
Show TxBodyError Source #
Instance details Defined in Cardano.Api.TxBody Methods showsPrec :: Int -> TxBodyError -> ShowS Source # show :: TxBodyError -> String Source # showList :: [TxBodyError] -> ShowS Source #
Error TxBodyError Source #
Instance details Defined in Cardano.Api.TxBody Methods prettyError :: TxBodyError -> Doc ann Source #

data TxBodyScriptData era where Source #

Constructors

TxBodyNoScriptData :: TxBodyScriptData era
TxBodyScriptData :: AlonzoEraOnwards era -> TxDats (ShelleyLedgerEra era) -> Redeemers (ShelleyLedgerEra era) -> TxBodyScriptData era

Instances

Instances details

Eq (TxBodyScriptData era) Source #
Instance details Defined in Cardano.Api.TxBody Methods (==) :: TxBodyScriptData era -> TxBodyScriptData era -> Bool Source # (/=) :: TxBodyScriptData era -> TxBodyScriptData era -> Bool Source #
EraCrypto (ShelleyLedgerEra era) ~ StandardCrypto => Show (TxBodyScriptData era) Source #
Instance details Defined in Cardano.Api.TxBody Methods showsPrec :: Int -> TxBodyScriptData era -> ShowS Source # show :: TxBodyScriptData era -> String Source # showList :: [TxBodyScriptData era] -> ShowS Source #

data TxScriptValidity era where Source #

A representation of whether the era supports tx script validity.

The Alonzo and subsequent eras support script validity.

Constructors

TxScriptValidityNone :: TxScriptValidity era
TxScriptValidity :: AlonzoEraOnwards era -> ScriptValidity -> TxScriptValidity era	Tx script validity is supported in transactions in the `Alonzo` era onwards.

Instances

Instances details

Eq (TxScriptValidity era) Source #
Instance details Defined in Cardano.Api.TxBody Methods (==) :: TxScriptValidity era -> TxScriptValidity era -> Bool Source # (/=) :: TxScriptValidity era -> TxScriptValidity era -> Bool Source #
Show (TxScriptValidity era) Source #
Instance details Defined in Cardano.Api.TxBody Methods showsPrec :: Int -> TxScriptValidity era -> ShowS Source # show :: TxScriptValidity era -> String Source # showList :: [TxScriptValidity era] -> ShowS Source #

data ScriptValidity Source #

Indicates whether a script is expected to fail or pass validation.

Constructors

ScriptInvalid	Script is expected to fail validation. Transactions marked as such can include scripts that fail validation. Such transactions may be submitted to the chain, in which case the collateral will be taken upon on chain script validation failure.
ScriptValid	Script is expected to pass validation. Transactions marked as such cannot include scripts that fail validation.

Instances

Instances details

Eq ScriptValidity Source #
Instance details Defined in Cardano.Api.TxBody Methods (==) :: ScriptValidity -> ScriptValidity -> Bool Source # (/=) :: ScriptValidity -> ScriptValidity -> Bool Source #
Show ScriptValidity Source #
Instance details Defined in Cardano.Api.TxBody Methods showsPrec :: Int -> ScriptValidity -> ShowS Source # show :: ScriptValidity -> String Source # showList :: [ScriptValidity] -> ShowS Source #
DecCBOR ScriptValidity Source #
Instance details Defined in Cardano.Api.TxBody Methods decCBOR :: Decoder s ScriptValidity dropCBOR :: Proxy ScriptValidity -> Decoder s () label :: Proxy ScriptValidity -> Text
EncCBOR ScriptValidity Source #
Instance details Defined in Cardano.Api.TxBody Methods encCBOR :: ScriptValidity -> Encoding encodedSizeExpr :: (forall t. EncCBOR t => Proxy t -> Size) -> Proxy ScriptValidity -> Size encodedListSizeExpr :: (forall t. EncCBOR t => Proxy t -> Size) -> Proxy [ScriptValidity] -> Size

scriptValidityToIsValid :: ScriptValidity -> IsValid Source #

isValidToScriptValidity :: IsValid -> ScriptValidity Source #

scriptValidityToTxScriptValidity :: ShelleyBasedEra era -> ScriptValidity -> TxScriptValidity era Source #

txScriptValidityToIsValid :: TxScriptValidity era -> IsValid Source #

txScriptValidityToScriptValidity :: TxScriptValidity era -> ScriptValidity Source #

Transaction Ids

newtype TxId Source #

Constructors

TxId (Hash StandardCrypto EraIndependentTxBody)

Instances

Instances details

Eq TxId Source #
Instance details Defined in Cardano.Api.TxIn Methods (==) :: TxId -> TxId -> Bool Source # (/=) :: TxId -> TxId -> Bool Source #
Ord TxId Source #
Instance details Defined in Cardano.Api.TxIn 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 Cardano.Api.TxIn Methods showsPrec :: Int -> TxId -> ShowS Source # show :: TxId -> String Source # showList :: [TxId] -> ShowS Source #
IsString TxId Source #
Instance details Defined in Cardano.Api.TxIn Methods fromString :: String -> TxId Source #
FromJSON TxId Source #
Instance details Defined in Cardano.Api.TxIn Methods parseJSON :: Value -> Parser TxId # parseJSONList :: Value -> Parser [TxId] # omittedField :: Maybe TxId #
ToJSON TxId Source #
Instance details Defined in Cardano.Api.TxIn Methods toJSON :: TxId -> Value # toEncoding :: TxId -> Encoding # toJSONList :: [TxId] -> Value # toEncodingList :: [TxId] -> Encoding # omitField :: TxId -> Bool #
ToJSONKey TxId Source #
Instance details Defined in Cardano.Api.TxIn Methods toJSONKey :: ToJSONKeyFunction TxId toJSONKeyList :: ToJSONKeyFunction [TxId]
HasTypeProxy TxId Source #
Instance details Defined in Cardano.Api.TxIn Associated Types data AsType TxId Source # Methods proxyToAsType :: Proxy TxId -> AsType TxId Source #
FromJSONKey TxId Source #
Instance details Defined in Cardano.Api.TxIn Methods fromJSONKey :: FromJSONKeyFunction TxId fromJSONKeyList :: FromJSONKeyFunction [TxId]
SerialiseAsRawBytes TxId Source #
Instance details Defined in Cardano.Api.TxIn Methods serialiseToRawBytes :: TxId -> ByteString Source # deserialiseFromRawBytes :: AsType TxId -> ByteString -> Either SerialiseAsRawBytesError TxId Source #
data AsType TxId Source #
Instance details Defined in Cardano.Api.TxIn data AsType TxId = AsTxId

getTxId :: TxBody era -> TxId Source #

Calculate the transaction identifier for a TxBody.

getTxIdByron :: ATxAux ByteString -> TxId Source #

getTxIdShelley :: EraCrypto (ShelleyLedgerEra era) ~ StandardCrypto => EraTxBody (ShelleyLedgerEra era) => ShelleyBasedEra era -> TxBody (ShelleyLedgerEra era) -> TxId Source #

Transaction inputs

data TxIn Source #

Constructors

TxIn TxId TxIx

Instances

Instances details

Eq TxIn Source #
Instance details Defined in Cardano.Api.TxIn Methods (==) :: TxIn -> TxIn -> Bool Source # (/=) :: TxIn -> TxIn -> Bool Source #
Ord TxIn Source #
Instance details Defined in Cardano.Api.TxIn 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 Cardano.Api.TxIn Methods showsPrec :: Int -> TxIn -> ShowS Source # show :: TxIn -> String Source # showList :: [TxIn] -> ShowS Source #
FromJSON TxIn Source #
Instance details Defined in Cardano.Api.TxIn Methods parseJSON :: Value -> Parser TxIn # parseJSONList :: Value -> Parser [TxIn] # omittedField :: Maybe TxIn #
ToJSON TxIn Source #
Instance details Defined in Cardano.Api.TxIn Methods toJSON :: TxIn -> Value # toEncoding :: TxIn -> Encoding # toJSONList :: [TxIn] -> Value # toEncodingList :: [TxIn] -> Encoding # omitField :: TxIn -> Bool #
ToJSONKey TxIn Source #
Instance details Defined in Cardano.Api.TxIn Methods toJSONKey :: ToJSONKeyFunction TxIn toJSONKeyList :: ToJSONKeyFunction [TxIn]
Pretty TxIn Source #
Instance details Defined in Cardano.Api.TxIn Methods pretty :: TxIn -> Doc ann # prettyList :: [TxIn] -> Doc ann #
FromJSONKey TxIn Source #
Instance details Defined in Cardano.Api.TxIn Methods fromJSONKey :: FromJSONKeyFunction TxIn fromJSONKeyList :: FromJSONKeyFunction [TxIn]

type TxIns build era = [(TxIn, BuildTxWith build (Witness WitCtxTxIn era))] Source #

newtype TxIx Source #

Constructors

TxIx Word

Instances

Instances details

Enum TxIx Source #
Instance details Defined in Cardano.Api.TxIn Methods succ :: TxIx -> TxIx Source # pred :: TxIx -> TxIx Source # toEnum :: Int -> TxIx Source # fromEnum :: TxIx -> Int Source # enumFrom :: TxIx -> [TxIx] Source # enumFromThen :: TxIx -> TxIx -> [TxIx] Source # enumFromTo :: TxIx -> TxIx -> [TxIx] Source # enumFromThenTo :: TxIx -> TxIx -> TxIx -> [TxIx] Source #
Eq TxIx Source #
Instance details Defined in Cardano.Api.TxIn Methods (==) :: TxIx -> TxIx -> Bool Source # (/=) :: TxIx -> TxIx -> Bool Source #
Ord TxIx Source #
Instance details Defined in Cardano.Api.TxIn Methods compare :: TxIx -> TxIx -> Ordering Source # (<) :: TxIx -> TxIx -> Bool Source # (<=) :: TxIx -> TxIx -> Bool Source # (>) :: TxIx -> TxIx -> Bool Source # (>=) :: TxIx -> TxIx -> Bool Source # max :: TxIx -> TxIx -> TxIx Source # min :: TxIx -> TxIx -> TxIx Source #
Show TxIx Source #
Instance details Defined in Cardano.Api.TxIn Methods showsPrec :: Int -> TxIx -> ShowS Source # show :: TxIx -> String Source # showList :: [TxIx] -> ShowS Source #
FromJSON TxIx Source #
Instance details Defined in Cardano.Api.TxIn Methods parseJSON :: Value -> Parser TxIx # parseJSONList :: Value -> Parser [TxIx] # omittedField :: Maybe TxIx #
ToJSON TxIx Source #
Instance details Defined in Cardano.Api.TxIn Methods toJSON :: TxIx -> Value # toEncoding :: TxIx -> Encoding # toJSONList :: [TxIx] -> Value # toEncodingList :: [TxIx] -> Encoding # omitField :: TxIx -> Bool #

genesisUTxOPseudoTxIn :: NetworkId -> Hash GenesisUTxOKey -> TxIn Source #

Compute the TxIn of the initial UTxO pseudo-transaction corresponding to the given address in the genesis initial funds.

The Shelley initial UTxO is constructed from the sgInitialFunds which is not a full UTxO but just a map from addresses to coin values.

This gets turned into a UTxO by making a pseudo-transaction for each address, with the 0th output being the coin value. So to spend from the initial UTxO we need this same TxIn to use as an input to the spending transaction.

Transaction outputs

data CtxTx Source #

The context is a transaction body

Instances

Instances details

IsShelleyBasedEra era => FromJSON (TxOut CtxTx era) Source #
Instance details Defined in Cardano.Api.TxBody Methods parseJSON :: Value -> Parser (TxOut CtxTx era) # parseJSONList :: Value -> Parser [TxOut CtxTx era] # omittedField :: Maybe (TxOut CtxTx era) #

data CtxUTxO Source #

The context is the UTxO

Instances

Instances details

IsShelleyBasedEra era => FromJSON (TxOut CtxUTxO era) Source #
Instance details Defined in Cardano.Api.TxBody Methods parseJSON :: Value -> Parser (TxOut CtxUTxO era) # parseJSONList :: Value -> Parser [TxOut CtxUTxO era] # omittedField :: Maybe (TxOut CtxUTxO era) #

data TxOut ctx era Source #

Constructors

TxOut (AddressInEra era) (TxOutValue era) (TxOutDatum ctx era) (ReferenceScript era)

Instances

Instances details

Eq (TxOut ctx era) Source #
Instance details Defined in Cardano.Api.TxBody Methods (==) :: TxOut ctx era -> TxOut ctx era -> Bool Source # (/=) :: TxOut ctx era -> TxOut ctx era -> Bool Source #
Show (TxOut ctx era) Source #
Instance details Defined in Cardano.Api.TxBody Methods showsPrec :: Int -> TxOut ctx era -> ShowS Source # show :: TxOut ctx era -> String Source # showList :: [TxOut ctx era] -> ShowS Source #
IsShelleyBasedEra era => FromJSON (TxOut CtxUTxO era) Source #
Instance details Defined in Cardano.Api.TxBody Methods parseJSON :: Value -> Parser (TxOut CtxUTxO era) # parseJSONList :: Value -> Parser [TxOut CtxUTxO era] # omittedField :: Maybe (TxOut CtxUTxO era) #
IsShelleyBasedEra era => FromJSON (TxOut CtxTx era) Source #
Instance details Defined in Cardano.Api.TxBody Methods parseJSON :: Value -> Parser (TxOut CtxTx era) # parseJSONList :: Value -> Parser [TxOut CtxTx era] # omittedField :: Maybe (TxOut CtxTx era) #
IsCardanoEra era => ToJSON (TxOut ctx era) Source #
Instance details Defined in Cardano.Api.TxBody Methods toJSON :: TxOut ctx era -> Value # toEncoding :: TxOut ctx era -> Encoding # toJSONList :: [TxOut ctx era] -> Value # toEncodingList :: [TxOut ctx era] -> Encoding # omitField :: TxOut ctx era -> Bool #

data TxOutValue era where Source #

Constructors

TxOutValueByron :: Lovelace -> TxOutValue era
TxOutValueShelleyBased :: (Eq (Value (ShelleyLedgerEra era)), Show (Value (ShelleyLedgerEra era))) => ShelleyBasedEra era -> Value (ShelleyLedgerEra era) -> TxOutValue era

Instances

Instances details

Eq (TxOutValue era) Source #
Instance details Defined in Cardano.Api.TxBody Methods (==) :: TxOutValue era -> TxOutValue era -> Bool Source # (/=) :: TxOutValue era -> TxOutValue era -> Bool Source #
Show (TxOutValue era) Source #
Instance details Defined in Cardano.Api.TxBody Methods showsPrec :: Int -> TxOutValue era -> ShowS Source # show :: TxOutValue era -> String Source # showList :: [TxOutValue era] -> ShowS Source #
IsShelleyBasedEra era => FromJSON (TxOutValue era) Source #
Instance details Defined in Cardano.Api.TxBody Methods parseJSON :: Value -> Parser (TxOutValue era) # parseJSONList :: Value -> Parser [TxOutValue era] # omittedField :: Maybe (TxOutValue era) #
IsCardanoEra era => ToJSON (TxOutValue era) Source #
Instance details Defined in Cardano.Api.TxBody Methods toJSON :: TxOutValue era -> Value # toEncoding :: TxOutValue era -> Encoding # toJSONList :: [TxOutValue era] -> Value # toEncodingList :: [TxOutValue era] -> Encoding # omitField :: TxOutValue era -> Bool #

data TxOutDatum ctx era where Source #

Constructors

TxOutDatumNone :: TxOutDatum ctx era
TxOutDatumHash :: AlonzoEraOnwards era -> Hash ScriptData -> TxOutDatum ctx era	A transaction output that only specifies the hash of the datum, but not the full datum value.
TxOutDatumInline :: BabbageEraOnwards era -> HashableScriptData -> TxOutDatum ctx era	A transaction output that specifies the whole datum instead of the datum hash. Note that the datum map will not be updated with this datum, it only exists at the transaction output.

Bundled Patterns

pattern TxOutDatumInTx :: AlonzoEraOnwards era -> HashableScriptData -> TxOutDatum CtxTx era

Instances

Instances details

Eq (TxOutDatum ctx era) Source #
Instance details Defined in Cardano.Api.TxBody Methods (==) :: TxOutDatum ctx era -> TxOutDatum ctx era -> Bool Source # (/=) :: TxOutDatum ctx era -> TxOutDatum ctx era -> Bool Source #
Show (TxOutDatum ctx era) Source #
Instance details Defined in Cardano.Api.TxBody Methods showsPrec :: Int -> TxOutDatum ctx era -> ShowS Source # show :: TxOutDatum ctx era -> String Source # showList :: [TxOutDatum ctx era] -> ShowS Source #

toCtxUTxOTxOut :: TxOut CtxTx era -> TxOut CtxUTxO era Source #

lovelaceToTxOutValue :: ShelleyBasedEra era -> Lovelace -> TxOutValue era Source #

prettyRenderTxOut :: TxOutInAnyEra -> Text Source #

txOutValueToLovelace :: TxOutValue era -> Lovelace Source #

txOutValueToValue :: TxOutValue era -> Value Source #

parseHash :: SerialiseAsRawBytes (Hash a) => AsType (Hash a) -> Parser (Hash a) Source #

data TxOutInAnyEra where Source #

Constructors

TxOutInAnyEra :: CardanoEra era -> TxOut CtxTx era -> TxOutInAnyEra

Instances

Instances details

Eq TxOutInAnyEra Source #
Instance details Defined in Cardano.Api.TxBody Methods (==) :: TxOutInAnyEra -> TxOutInAnyEra -> Bool Source # (/=) :: TxOutInAnyEra -> TxOutInAnyEra -> Bool Source #
Show TxOutInAnyEra Source #
Instance details Defined in Cardano.Api.TxBody Methods showsPrec :: Int -> TxOutInAnyEra -> ShowS Source # show :: TxOutInAnyEra -> String Source # showList :: [TxOutInAnyEra] -> ShowS Source #
Pretty TxOutInAnyEra Source #
Instance details Defined in Cardano.Api.TxBody Methods pretty :: TxOutInAnyEra -> Doc ann # prettyList :: [TxOutInAnyEra] -> Doc ann #

txOutInAnyEra :: CardanoEra era -> TxOut CtxTx era -> TxOutInAnyEra Source #

Convenience constructor for TxOutInAnyEra

Other transaction body types

data TxInsCollateral era where Source #

Constructors

TxInsCollateralNone :: TxInsCollateral era
TxInsCollateral :: AlonzoEraOnwards era -> [TxIn] -> TxInsCollateral era

Instances

Instances details

Eq (TxInsCollateral era) Source #
Instance details Defined in Cardano.Api.TxBody Methods (==) :: TxInsCollateral era -> TxInsCollateral era -> Bool Source # (/=) :: TxInsCollateral era -> TxInsCollateral era -> Bool Source #
Show (TxInsCollateral era) Source #
Instance details Defined in Cardano.Api.TxBody Methods showsPrec :: Int -> TxInsCollateral era -> ShowS Source # show :: TxInsCollateral era -> String Source # showList :: [TxInsCollateral era] -> ShowS Source #

data TxInsReference build era where Source #

Constructors

TxInsReferenceNone :: TxInsReference build era
TxInsReference :: BabbageEraOnwards era -> [TxIn] -> TxInsReference build era

Instances

Instances details

Eq (TxInsReference build era) Source #
Instance details Defined in Cardano.Api.TxBody Methods (==) :: TxInsReference build era -> TxInsReference build era -> Bool Source # (/=) :: TxInsReference build era -> TxInsReference build era -> Bool Source #
Show (TxInsReference build era) Source #
Instance details Defined in Cardano.Api.TxBody Methods showsPrec :: Int -> TxInsReference build era -> ShowS Source # show :: TxInsReference build era -> String Source # showList :: [TxInsReference build era] -> ShowS Source #

data TxReturnCollateral ctx era where Source #

Constructors

TxReturnCollateralNone :: TxReturnCollateral ctx era
TxReturnCollateral :: BabbageEraOnwards era -> TxOut ctx era -> TxReturnCollateral ctx era

Instances

Instances details

Eq (TxReturnCollateral ctx era) Source #
Instance details Defined in Cardano.Api.TxBody Methods (==) :: TxReturnCollateral ctx era -> TxReturnCollateral ctx era -> Bool Source # (/=) :: TxReturnCollateral ctx era -> TxReturnCollateral ctx era -> Bool Source #
Show (TxReturnCollateral ctx era) Source #
Instance details Defined in Cardano.Api.TxBody Methods showsPrec :: Int -> TxReturnCollateral ctx era -> ShowS Source # show :: TxReturnCollateral ctx era -> String Source # showList :: [TxReturnCollateral ctx era] -> ShowS Source #

data TxTotalCollateral era where Source #

Constructors

TxTotalCollateralNone :: TxTotalCollateral era
TxTotalCollateral :: BabbageEraOnwards era -> Lovelace -> TxTotalCollateral era

Instances

Instances details

Eq (TxTotalCollateral era) Source #
Instance details Defined in Cardano.Api.TxBody Methods (==) :: TxTotalCollateral era -> TxTotalCollateral era -> Bool Source # (/=) :: TxTotalCollateral era -> TxTotalCollateral era -> Bool Source #
Show (TxTotalCollateral era) Source #
Instance details Defined in Cardano.Api.TxBody Methods showsPrec :: Int -> TxTotalCollateral era -> ShowS Source # show :: TxTotalCollateral era -> String Source # showList :: [TxTotalCollateral era] -> ShowS Source #

data TxFee era where Source #

Constructors

TxFeeExplicit :: ShelleyBasedEra era -> Lovelace -> TxFee era

Instances

Instances details

Eq (TxFee era) Source #
Instance details Defined in Cardano.Api.TxBody Methods (==) :: TxFee era -> TxFee era -> Bool Source # (/=) :: TxFee era -> TxFee era -> Bool Source #
Show (TxFee era) Source #
Instance details Defined in Cardano.Api.TxBody Methods showsPrec :: Int -> TxFee era -> ShowS Source # show :: TxFee era -> String Source # showList :: [TxFee era] -> ShowS Source #

data TxValidityLowerBound era where Source #

Constructors

TxValidityNoLowerBound :: TxValidityLowerBound era
TxValidityLowerBound :: AllegraEraOnwards era -> SlotNo -> TxValidityLowerBound era

Instances

Instances details

Eq (TxValidityLowerBound era) Source #
Instance details Defined in Cardano.Api.TxBody Methods (==) :: TxValidityLowerBound era -> TxValidityLowerBound era -> Bool Source # (/=) :: TxValidityLowerBound era -> TxValidityLowerBound era -> Bool Source #
Show (TxValidityLowerBound era) Source #
Instance details Defined in Cardano.Api.TxBody Methods showsPrec :: Int -> TxValidityLowerBound era -> ShowS Source # show :: TxValidityLowerBound era -> String Source # showList :: [TxValidityLowerBound era] -> ShowS Source #

data TxValidityUpperBound era where Source #

This was formerly known as the TTL.

Constructors

TxValidityUpperBound :: ShelleyBasedEra era -> Maybe SlotNo -> TxValidityUpperBound era

Instances

Instances details

Eq (TxValidityUpperBound era) Source #
Instance details Defined in Cardano.Api.TxBody Methods (==) :: TxValidityUpperBound era -> TxValidityUpperBound era -> Bool Source # (/=) :: TxValidityUpperBound era -> TxValidityUpperBound era -> Bool Source #
Show (TxValidityUpperBound era) Source #
Instance details Defined in Cardano.Api.TxBody Methods showsPrec :: Int -> TxValidityUpperBound era -> ShowS Source # show :: TxValidityUpperBound era -> String Source # showList :: [TxValidityUpperBound era] -> ShowS Source #

data TxMetadataInEra era where Source #

Constructors

TxMetadataNone :: TxMetadataInEra era
TxMetadataInEra :: ShelleyBasedEra era -> TxMetadata -> TxMetadataInEra era

Instances

Instances details

Eq (TxMetadataInEra era) Source #
Instance details Defined in Cardano.Api.TxBody Methods (==) :: TxMetadataInEra era -> TxMetadataInEra era -> Bool Source # (/=) :: TxMetadataInEra era -> TxMetadataInEra era -> Bool Source #
Show (TxMetadataInEra era) Source #
Instance details Defined in Cardano.Api.TxBody Methods showsPrec :: Int -> TxMetadataInEra era -> ShowS Source # show :: TxMetadataInEra era -> String Source # showList :: [TxMetadataInEra era] -> ShowS Source #

data TxAuxScripts era where Source #

Constructors

TxAuxScriptsNone :: TxAuxScripts era
TxAuxScripts :: AllegraEraOnwards era -> [ScriptInEra era] -> TxAuxScripts era

Instances

Instances details

Eq (TxAuxScripts era) Source #
Instance details Defined in Cardano.Api.TxBody Methods (==) :: TxAuxScripts era -> TxAuxScripts era -> Bool Source # (/=) :: TxAuxScripts era -> TxAuxScripts era -> Bool Source #
Show (TxAuxScripts era) Source #
Instance details Defined in Cardano.Api.TxBody Methods showsPrec :: Int -> TxAuxScripts era -> ShowS Source # show :: TxAuxScripts era -> String Source # showList :: [TxAuxScripts era] -> ShowS Source #

data TxExtraKeyWitnesses era where Source #

Constructors

TxExtraKeyWitnessesNone :: TxExtraKeyWitnesses era
TxExtraKeyWitnesses :: AlonzoEraOnwards era -> [Hash PaymentKey] -> TxExtraKeyWitnesses era

Instances

Instances details

Eq (TxExtraKeyWitnesses era) Source #
Instance details Defined in Cardano.Api.TxBody Methods (==) :: TxExtraKeyWitnesses era -> TxExtraKeyWitnesses era -> Bool Source # (/=) :: TxExtraKeyWitnesses era -> TxExtraKeyWitnesses era -> Bool Source #
Show (TxExtraKeyWitnesses era) Source #
Instance details Defined in Cardano.Api.TxBody Methods showsPrec :: Int -> TxExtraKeyWitnesses era -> ShowS Source # show :: TxExtraKeyWitnesses era -> String Source # showList :: [TxExtraKeyWitnesses era] -> ShowS Source #

data TxWithdrawals build era where Source #

Constructors

TxWithdrawalsNone :: TxWithdrawals build era
TxWithdrawals :: ShelleyBasedEra era -> [(StakeAddress, Lovelace, BuildTxWith build (Witness WitCtxStake era))] -> TxWithdrawals build era

Instances

Instances details

Eq (TxWithdrawals build era) Source #
Instance details Defined in Cardano.Api.TxBody Methods (==) :: TxWithdrawals build era -> TxWithdrawals build era -> Bool Source # (/=) :: TxWithdrawals build era -> TxWithdrawals build era -> Bool Source #
Show (TxWithdrawals build era) Source #
Instance details Defined in Cardano.Api.TxBody Methods showsPrec :: Int -> TxWithdrawals build era -> ShowS Source # show :: TxWithdrawals build era -> String Source # showList :: [TxWithdrawals build era] -> ShowS Source #

data TxCertificates build era where Source #

Constructors

TxCertificatesNone :: TxCertificates build era
TxCertificates :: ShelleyBasedEra era -> [Certificate era] -> BuildTxWith build (Map StakeCredential (Witness WitCtxStake era)) -> TxCertificates build era

Instances

Instances details

Eq (TxCertificates build era) Source #
Instance details Defined in Cardano.Api.TxBody Methods (==) :: TxCertificates build era -> TxCertificates build era -> Bool Source # (/=) :: TxCertificates build era -> TxCertificates build era -> Bool Source #
Show (TxCertificates build era) Source #
Instance details Defined in Cardano.Api.TxBody Methods showsPrec :: Int -> TxCertificates build era -> ShowS Source # show :: TxCertificates build era -> String Source # showList :: [TxCertificates build era] -> ShowS Source #

data TxUpdateProposal era where Source #

Constructors

TxUpdateProposalNone :: TxUpdateProposal era
TxUpdateProposal :: ShelleyToBabbageEra era -> UpdateProposal -> TxUpdateProposal era

Instances

Instances details

Eq (TxUpdateProposal era) Source #
Instance details Defined in Cardano.Api.TxBody Methods (==) :: TxUpdateProposal era -> TxUpdateProposal era -> Bool Source # (/=) :: TxUpdateProposal era -> TxUpdateProposal era -> Bool Source #
Show (TxUpdateProposal era) Source #
Instance details Defined in Cardano.Api.TxBody Methods showsPrec :: Int -> TxUpdateProposal era -> ShowS Source # show :: TxUpdateProposal era -> String Source # showList :: [TxUpdateProposal era] -> ShowS Source #

data TxMintValue build era where Source #

Constructors

TxMintNone :: TxMintValue build era
TxMintValue :: MaryEraOnwards era -> Value -> BuildTxWith build (Map PolicyId (ScriptWitness WitCtxMint era)) -> TxMintValue build era

Instances

Instances details

Eq (TxMintValue build era) Source #
Instance details Defined in Cardano.Api.TxBody Methods (==) :: TxMintValue build era -> TxMintValue build era -> Bool Source # (/=) :: TxMintValue build era -> TxMintValue build era -> Bool Source #
Show (TxMintValue build era) Source #
Instance details Defined in Cardano.Api.TxBody Methods showsPrec :: Int -> TxMintValue build era -> ShowS Source # show :: TxMintValue build era -> String Source # showList :: [TxMintValue build era] -> ShowS Source #

Building vs viewing transactions

data BuildTxWith build a where Source #

Constructors

ViewTx :: BuildTxWith ViewTx a
BuildTxWith :: a -> BuildTxWith BuildTx a

Instances

Instances details

Functor (BuildTxWith build) Source #
Instance details Defined in Cardano.Api.TxBody Methods fmap :: (a -> b) -> BuildTxWith build a -> BuildTxWith build b Source # (<$) :: a -> BuildTxWith build b -> BuildTxWith build a Source #
Eq a => Eq (BuildTxWith build a) Source #
Instance details Defined in Cardano.Api.TxBody Methods (==) :: BuildTxWith build a -> BuildTxWith build a -> Bool Source # (/=) :: BuildTxWith build a -> BuildTxWith build a -> Bool Source #
Show a => Show (BuildTxWith build a) Source #
Instance details Defined in Cardano.Api.TxBody Methods showsPrec :: Int -> BuildTxWith build a -> ShowS Source # show :: BuildTxWith build a -> String Source # showList :: [BuildTxWith build a] -> ShowS Source #

data BuildTx Source #

data ViewTx Source #

Inspecting `ScriptWitness`es

data AnyScriptWitness era where Source #

A ScriptWitness in any WitCtx. This lets us handle heterogeneous collections of script witnesses from multiple contexts.

Constructors

AnyScriptWitness :: ScriptWitness witctx era -> AnyScriptWitness era

Instances

Instances details

Show (AnyScriptWitness era) Source #
Instance details Defined in Cardano.Api.TxBody Methods showsPrec :: Int -> AnyScriptWitness era -> ShowS Source # show :: AnyScriptWitness era -> String Source # showList :: [AnyScriptWitness era] -> ShowS Source #

data ScriptWitnessIndex Source #

Identify the location of a ScriptWitness within the context of a TxBody. These are indexes of the objects within the transaction that need or can use script witnesses: inputs, minted assets, withdrawals and certificates. These are simple numeric indices, enumerated from zero. Thus the indices are not stable if the transaction body is modified.

Constructors

ScriptWitnessIndexTxIn !Word	The n'th transaction input, in the order of the `TxId`s.
ScriptWitnessIndexMint !Word	The n'th minting `PolicyId`, in the order of the `PolicyId`s.
ScriptWitnessIndexCertificate !Word	The n'th certificate, in the list order of the certificates.
ScriptWitnessIndexWithdrawal !Word	The n'th withdrawal, in the order of the `StakeAddress`s.

Instances

Instances details

Eq ScriptWitnessIndex Source #
Instance details Defined in Cardano.Api.TxBody Methods (==) :: ScriptWitnessIndex -> ScriptWitnessIndex -> Bool Source # (/=) :: ScriptWitnessIndex -> ScriptWitnessIndex -> Bool Source #
Ord ScriptWitnessIndex Source #
Instance details Defined in Cardano.Api.TxBody Methods compare :: ScriptWitnessIndex -> ScriptWitnessIndex -> Ordering Source # (<) :: ScriptWitnessIndex -> ScriptWitnessIndex -> Bool Source # (<=) :: ScriptWitnessIndex -> ScriptWitnessIndex -> Bool Source # (>) :: ScriptWitnessIndex -> ScriptWitnessIndex -> Bool Source # (>=) :: ScriptWitnessIndex -> ScriptWitnessIndex -> Bool Source # max :: ScriptWitnessIndex -> ScriptWitnessIndex -> ScriptWitnessIndex Source # min :: ScriptWitnessIndex -> ScriptWitnessIndex -> ScriptWitnessIndex Source #
Show ScriptWitnessIndex Source #
Instance details Defined in Cardano.Api.TxBody Methods showsPrec :: Int -> ScriptWitnessIndex -> ShowS Source # show :: ScriptWitnessIndex -> String Source # showList :: [ScriptWitnessIndex] -> ShowS Source #
ToJSON ScriptWitnessIndex Source #
Instance details Defined in Cardano.Api.TxBody Methods toJSON :: ScriptWitnessIndex -> Value # toEncoding :: ScriptWitnessIndex -> Encoding # toJSONList :: [ScriptWitnessIndex] -> Value # toEncodingList :: [ScriptWitnessIndex] -> Encoding # omitField :: ScriptWitnessIndex -> Bool #

renderScriptWitnessIndex :: ScriptWitnessIndex -> String Source #

collectTxBodyScriptWitnesses :: forall era. ShelleyBasedEra era -> TxBodyContent BuildTx era -> [(ScriptWitnessIndex, AnyScriptWitness era)] Source #

Conversion to inline data

scriptDataToInlineDatum :: Era ledgerera => HashableScriptData -> Datum ledgerera Source #

Conversion of ScriptData to binary data which allows for the storage of data onchain within a transaction output.

Internal conversion functions & types

toByronTxId :: TxId -> TxId Source #

toShelleyTxId :: TxId -> TxId StandardCrypto Source #

toShelleyTxIn :: TxIn -> TxIn StandardCrypto Source #

This function may overflow on the transaction index. Call sites must ensure that all uses of this function are appropriately guarded.

toShelleyTxOut :: forall era ledgerera. ShelleyLedgerEra era ~ ledgerera => ShelleyBasedEra era -> TxOut CtxUTxO era -> TxOut ledgerera Source #

toShelleyTxOutAny :: forall ctx era ledgerera. ShelleyLedgerEra era ~ ledgerera => ShelleyBasedEra era -> TxOut ctx era -> TxOut ledgerera Source #

A variant of 'toShelleyTxOutAny that is used only internally to this module that works with a TxOut in any context (including CtxTx) by ignoring embedded datums (taking only their hash).

fromShelleyTxId :: TxId StandardCrypto -> TxId Source #

fromShelleyTxIn :: TxIn StandardCrypto -> TxIn Source #

fromShelleyTxOut :: forall era ctx. ShelleyBasedEra era -> TxOut (ShelleyLedgerEra era) -> TxOut ctx era Source #

toAlonzoRdmrPtr :: ScriptWitnessIndex -> RdmrPtr Source #

fromAlonzoRdmrPtr :: RdmrPtr -> ScriptWitnessIndex Source #

fromByronTxIn :: TxIn -> TxIn Source #

fromLedgerTxOuts :: forall era. ShelleyBasedEra era -> TxBody (ShelleyLedgerEra era) -> TxBodyScriptData era -> [TxOut CtxTx era] Source #

renderTxIn :: TxIn -> Text Source #

Misc helpers

calculateExecutionUnitsLovelace :: Prices -> ExecutionUnits -> Maybe Lovelace Source #

orderStakeAddrs :: [(StakeAddress, x, v)] -> [(StakeAddress, x, v)] Source #

orderTxIns :: [(TxIn, v)] -> [(TxIn, v)] Source #

Data family instances

data family AsType t Source #

A family of singleton types used in this API to indicate which type to use where it would otherwise be ambiguous or merely unclear.

Values of this type are passed to deserialisation functions for example.

Instances

Instances details

data AsType ConwayEra Source #
Instance details Defined in Cardano.Api.Eras.Core data AsType ConwayEra = AsConwayEra
data AsType BabbageEra Source #
Instance details Defined in Cardano.Api.Eras.Core data AsType BabbageEra = AsBabbageEra
data AsType AlonzoEra Source #
Instance details Defined in Cardano.Api.Eras.Core data AsType AlonzoEra = AsAlonzoEra
data AsType MaryEra Source #
Instance details Defined in Cardano.Api.Eras.Core data AsType MaryEra = AsMaryEra
data AsType AllegraEra Source #
Instance details Defined in Cardano.Api.Eras.Core data AsType AllegraEra = AsAllegraEra
data AsType ShelleyEra Source #
Instance details Defined in Cardano.Api.Eras.Core data AsType ShelleyEra = AsShelleyEra
data AsType ByronEra Source #
Instance details Defined in Cardano.Api.Eras.Core data AsType ByronEra = AsByronEra
data AsType TxId Source #
Instance details Defined in Cardano.Api.TxIn data AsType TxId = AsTxId
data AsType TxMetadata Source #
Instance details Defined in Cardano.Api.TxMetadata data AsType TxMetadata = AsTxMetadata
data AsType TextEnvelope Source #
Instance details Defined in Cardano.Api.SerialiseTextEnvelope data AsType TextEnvelope = AsTextEnvelope
data AsType DRepExtendedKey Source #
Instance details Defined in Cardano.Api.Keys.Shelley data AsType DRepExtendedKey = AsDRepExtendedKey
data AsType DRepKey Source #
Instance details Defined in Cardano.Api.Keys.Shelley data AsType DRepKey = AsDRepKey
data AsType StakePoolKey Source #
Instance details Defined in Cardano.Api.Keys.Shelley data AsType StakePoolKey = AsStakePoolKey
data AsType GenesisUTxOKey Source #
Instance details Defined in Cardano.Api.Keys.Shelley data AsType GenesisUTxOKey = AsGenesisUTxOKey
data AsType GenesisDelegateExtendedKey Source #
Instance details Defined in Cardano.Api.Keys.Shelley data AsType GenesisDelegateExtendedKey = AsGenesisDelegateExtendedKey
data AsType GenesisDelegateKey Source #
Instance details Defined in Cardano.Api.Keys.Shelley data AsType GenesisDelegateKey = AsGenesisDelegateKey
data AsType GenesisExtendedKey Source #
Instance details Defined in Cardano.Api.Keys.Shelley data AsType GenesisExtendedKey = AsGenesisExtendedKey
data AsType CommitteeColdKey Source #
Instance details Defined in Cardano.Api.Keys.Shelley data AsType CommitteeColdKey = AsCommitteeColdKey
data AsType CommitteeHotKey Source #
Instance details Defined in Cardano.Api.Keys.Shelley data AsType CommitteeHotKey = AsCommitteeHotKey
data AsType GenesisKey Source #
Instance details Defined in Cardano.Api.Keys.Shelley data AsType GenesisKey = AsGenesisKey
data AsType StakeExtendedKey Source #
Instance details Defined in Cardano.Api.Keys.Shelley data AsType StakeExtendedKey = AsStakeExtendedKey
data AsType StakeKey Source #
Instance details Defined in Cardano.Api.Keys.Shelley data AsType StakeKey = AsStakeKey
data AsType PaymentExtendedKey Source #
Instance details Defined in Cardano.Api.Keys.Shelley data AsType PaymentExtendedKey = AsPaymentExtendedKey
data AsType PaymentKey Source #
Instance details Defined in Cardano.Api.Keys.Shelley data AsType PaymentKey = AsPaymentKey
data AsType VrfKey Source #
Instance details Defined in Cardano.Api.Keys.Praos data AsType VrfKey = AsVrfKey
data AsType KesKey Source #
Instance details Defined in Cardano.Api.Keys.Praos data AsType KesKey = AsKesKey
data AsType ByronKeyLegacy Source #
Instance details Defined in Cardano.Api.Keys.Byron data AsType ByronKeyLegacy = AsByronKeyLegacy
data AsType ByronKey Source #
Instance details Defined in Cardano.Api.Keys.Byron data AsType ByronKey = AsByronKey
data AsType ByronVote Source #
Instance details Defined in Cardano.Api.SpecialByron data AsType ByronVote = AsByronVote
data AsType ByronUpdateProposal Source #
Instance details Defined in Cardano.Api.SpecialByron data AsType ByronUpdateProposal = AsByronUpdateProposal
data AsType ScriptData Source #
Instance details Defined in Cardano.Api.ScriptData data AsType ScriptData = AsScriptData
data AsType HashableScriptData Source #
Instance details Defined in Cardano.Api.ScriptData data AsType HashableScriptData = AsHashableScriptData
data AsType ScriptHash Source #
Instance details Defined in Cardano.Api.Script data AsType ScriptHash = AsScriptHash
data AsType ScriptInAnyLang Source #
Instance details Defined in Cardano.Api.Script data AsType ScriptInAnyLang = AsScriptInAnyLang
data AsType PlutusScriptV3 Source #
Instance details Defined in Cardano.Api.Script data AsType PlutusScriptV3 = AsPlutusScriptV3
data AsType PlutusScriptV2 Source #
Instance details Defined in Cardano.Api.Script data AsType PlutusScriptV2 = AsPlutusScriptV2
data AsType PlutusScriptV1 Source #
Instance details Defined in Cardano.Api.Script data AsType PlutusScriptV1 = AsPlutusScriptV1
data AsType SimpleScript' Source #
Instance details Defined in Cardano.Api.Script data AsType SimpleScript' = AsSimpleScript
data AsType AssetName Source #
Instance details Defined in Cardano.Api.Value data AsType AssetName = AsAssetName
data AsType PolicyId Source #
Instance details Defined in Cardano.Api.Value data AsType PolicyId = AsPolicyId
data AsType StakePoolMetadata Source #
Instance details Defined in Cardano.Api.StakePoolMetadata data AsType StakePoolMetadata = AsStakePoolMetadata
data AsType DRepMetadata Source #
Instance details Defined in Cardano.Api.DRepMetadata data AsType DRepMetadata = AsDRepMetadata
data AsType StakeAddress Source #
Instance details Defined in Cardano.Api.Address data AsType StakeAddress = AsStakeAddress
data AsType AddressAny Source #
Instance details Defined in Cardano.Api.Address data AsType AddressAny = AsAddressAny
data AsType ShelleyAddr Source #
Instance details Defined in Cardano.Api.Address data AsType ShelleyAddr = AsShelleyAddr
data AsType ByronAddr Source #
Instance details Defined in Cardano.Api.Address data AsType ByronAddr = AsByronAddr
data AsType UpdateProposal Source #
Instance details Defined in Cardano.Api.ProtocolParameters data AsType UpdateProposal = AsUpdateProposal
data AsType PraosNonce Source #
Instance details Defined in Cardano.Api.ProtocolParameters data AsType PraosNonce = AsPraosNonce
data AsType GovernancePollAnswer Source #
Instance details Defined in Cardano.Api.Governance.Poll data AsType GovernancePollAnswer = AsGovernancePollAnswer
data AsType GovernancePoll Source #
Instance details Defined in Cardano.Api.Governance.Poll data AsType GovernancePoll = AsGovernancePoll
data AsType BlockHeader Source #
Instance details Defined in Cardano.Api.Block data AsType BlockHeader = AsBlockHeader
data AsType OperationalCertificateIssueCounter Source #
Instance details Defined in Cardano.Api.OperationalCertificate data AsType OperationalCertificateIssueCounter = AsOperationalCertificateIssueCounter
data AsType OperationalCertificate Source #
Instance details Defined in Cardano.Api.OperationalCertificate data AsType OperationalCertificate = AsOperationalCertificate
data AsType (Hash a) Source #
Instance details Defined in Cardano.Api.Hash data AsType (Hash a) = AsHash (AsType a)
data AsType (VerificationKey a) Source #
Instance details Defined in Cardano.Api.Keys.Class data AsType (VerificationKey a) = AsVerificationKey (AsType a)
data AsType (SigningKey a) Source #
Instance details Defined in Cardano.Api.Keys.Class data AsType (SigningKey a) = AsSigningKey (AsType a)
data AsType (PlutusScript lang) Source #
Instance details Defined in Cardano.Api.Script data AsType (PlutusScript lang) = AsPlutusScript (AsType lang)
data AsType (ScriptInEra era) Source #
Instance details Defined in Cardano.Api.Script data AsType (ScriptInEra era) = AsScriptInEra (AsType era)
data AsType (Script lang) Source #
Instance details Defined in Cardano.Api.Script data AsType (Script lang) = AsScript (AsType lang)
data AsType (AddressInEra era) Source #
Instance details Defined in Cardano.Api.Address data AsType (AddressInEra era) = AsAddressInEra (AsType era)
data AsType (Address addrtype) Source #
Instance details Defined in Cardano.Api.Address data AsType (Address addrtype) = AsAddress (AsType addrtype)
data AsType (Proposal era) Source #
Instance details Defined in Cardano.Api.Governance.Actions.ProposalProcedure data AsType (Proposal era) = AsProposal
data AsType (VotingProcedures era) Source #
Instance details Defined in Cardano.Api.Governance.Actions.VotingProcedure data AsType (VotingProcedures era) = AsVotingProcedures
data AsType (VotingProcedure era) Source #
Instance details Defined in Cardano.Api.Governance.Actions.VotingProcedure data AsType (VotingProcedure era) = AsVote
data AsType (Certificate era) Source #
Instance details Defined in Cardano.Api.Certificate data AsType (Certificate era) = AsCertificate
data AsType (TxBody era) Source #
Instance details Defined in Cardano.Api.TxBody data AsType (TxBody era) = AsTxBody (AsType era)
data AsType (KeyWitness era) Source #
Instance details Defined in Cardano.Api.Tx data AsType (KeyWitness era) = AsKeyWitness (AsType era)
data AsType (Tx era) Source #
Instance details Defined in Cardano.Api.Tx data AsType (Tx era) = AsTx (AsType era)

getTxBodyContent :: TxBody era -> TxBodyContent ViewTx era Source #

Documentation

Transaction bodies

Instances

Instances

Byron only

Transaction body builders

Instances

Instances

Instances

Instances

Transaction Ids

Instances

Transaction inputs

Instances

Instances

Transaction outputs

Instances

Instances

Instances

Instances

Instances

Instances

Other transaction body types

Instances

Instances

Instances

Instances

Instances

Instances

Instances

Instances

Instances

Instances

Instances

Instances

Instances

Instances

Building vs viewing transactions

Instances

Inspecting ScriptWitnesses

Instances

Instances

Conversion to inline data

Internal conversion functions & types

Misc helpers

Data family instances

Instances

Inspecting `ScriptWitness`es