cardano-api-1.36.0: The cardano api
Safe HaskellSafe-Inferred
LanguageHaskell2010

Cardano.Api.TxBody

Description

Transaction bodies

Synopsis

Documentation

Transaction bodies

data TxBody era where Source #

Constructors

ByronTxBody ∷ Annotated Tx ByteStringTxBody ByronEra 
ShelleyTxBody 

Fields

Bundled Patterns

pattern TxBodyTxBodyContent ViewTx era → TxBody era 

Instances

Instances details
Show (TxBody era) Source # 
Instance details

Defined in Cardano.Api.TxBody

Methods

showsPrecIntTxBody era → ShowS Source #

showTxBody 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

proxyToAsTypeProxy (TxBody era) → AsType (TxBody era) Source #

IsCardanoEra era ⇒ SerialiseAsCBOR (TxBody era) Source # 
Instance details

Defined in Cardano.Api.TxBody

Methods

serialiseToCBORTxBody era → ByteString Source #

deserialiseFromCBORAsType (TxBody era) → ByteStringEither DecoderError (TxBody era) Source #

IsCardanoEra era ⇒ HasTextEnvelope (TxBody era) Source # 
Instance details

Defined in Cardano.Api.TxBody

Eq (TxBody era) Source # 
Instance details

Defined in Cardano.Api.TxBody

Methods

(==)TxBody era → TxBody era → Bool Source #

(/=)TxBody era → TxBody era → Bool Source #

data AsType (TxBody era) Source # 
Instance details

Defined in Cardano.Api.TxBody

data AsType (TxBody era) = AsTxBody (AsType era)

makeTransactionBody ∷ ∀ era. IsCardanoEra era ⇒ TxBodyContent BuildTx era → Either TxBodyError (TxBody era) Source #

Deprecated: Use createAndValidateTransactionBody.

data TxBodyContent build era Source #

Instances

Instances details
Show (TxBodyContent build era) Source # 
Instance details

Defined in Cardano.Api.TxBody

Methods

showsPrecIntTxBodyContent build era → ShowS Source #

showTxBodyContent build era → String Source #

showList ∷ [TxBodyContent build era] → ShowS Source #

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 #

data TxBodyScriptData era where Source #

Constructors

TxBodyNoScriptDataTxBodyScriptData era 
TxBodyScriptDataScriptDataSupportedInEra era → TxDats (ShelleyLedgerEra era) → Redeemers (ShelleyLedgerEra era) → TxBodyScriptData era 

Instances

Instances details
Show (TxBodyScriptData era) Source # 
Instance details

Defined in Cardano.Api.TxBody

Eq (TxBodyScriptData era) Source # 
Instance details

Defined in Cardano.Api.TxBody

data TxScriptValidity era where Source #

A representation of whether the era supports tx script validity.

The Alonzo and subsequent eras support script validity.

Constructors

TxScriptValidityNoneTxScriptValidity era 
TxScriptValidityTxScriptValiditySupportedInEra era → ScriptValidityTxScriptValidity era

Tx script validity is supported in transactions in the Alonzo era onwards.

Instances

Instances details
Show (TxScriptValidity era) Source # 
Instance details

Defined in Cardano.Api.TxBody

Eq (TxScriptValidity era) Source # 
Instance details

Defined in Cardano.Api.TxBody

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
Show ScriptValidity Source # 
Instance details

Defined in Cardano.Api.TxBody

FromCBOR ScriptValidity Source # 
Instance details

Defined in Cardano.Api.TxBody

Methods

fromCBOR ∷ Decoder s ScriptValidity #

labelProxy ScriptValidityText #

ToCBOR ScriptValidity Source # 
Instance details

Defined in Cardano.Api.TxBody

Methods

toCBORScriptValidity → Encoding #

encodedSizeExpr ∷ (∀ t. ToCBOR t ⇒ Proxy t → Size) → Proxy ScriptValidity → Size #

encodedListSizeExpr ∷ (∀ t. ToCBOR t ⇒ Proxy t → Size) → Proxy [ScriptValidity] → Size #

Eq ScriptValidity Source # 
Instance details

Defined in Cardano.Api.TxBody

Transaction Ids

newtype TxId Source #

Constructors

TxId (Hash StandardCrypto EraIndependentTxBody) 

Instances

Instances details
FromJSON TxId Source # 
Instance details

Defined in Cardano.Api.TxIn

Methods

parseJSON ∷ Value → Parser TxId #

parseJSONList ∷ Value → Parser [TxId] #

FromJSONKey TxId Source # 
Instance details

Defined in Cardano.Api.TxIn

Methods

fromJSONKey ∷ FromJSONKeyFunction TxId

fromJSONKeyList ∷ FromJSONKeyFunction [TxId]

ToJSON TxId Source # 
Instance details

Defined in Cardano.Api.TxIn

Methods

toJSONTxId → Value #

toEncodingTxId → Encoding #

toJSONList ∷ [TxId] → Value #

toEncodingList ∷ [TxId] → Encoding #

ToJSONKey TxId Source # 
Instance details

Defined in Cardano.Api.TxIn

Methods

toJSONKey ∷ ToJSONKeyFunction TxId

toJSONKeyList ∷ ToJSONKeyFunction [TxId]

IsString TxId Source # 
Instance details

Defined in Cardano.Api.TxIn

Methods

fromStringStringTxId Source #

Show TxId Source # 
Instance details

Defined in Cardano.Api.TxIn

Methods

showsPrecIntTxIdShowS Source #

showTxIdString Source #

showList ∷ [TxId] → ShowS Source #

HasTypeProxy TxId Source # 
Instance details

Defined in Cardano.Api.TxIn

Associated Types

data AsType TxId Source #

SerialiseAsRawBytes TxId Source # 
Instance details

Defined in Cardano.Api.TxIn

Eq TxId Source # 
Instance details

Defined in Cardano.Api.TxIn

Methods

(==)TxIdTxIdBool Source #

(/=)TxIdTxIdBool Source #

Ord TxId Source # 
Instance details

Defined in Cardano.Api.TxIn

Methods

compareTxIdTxIdOrdering Source #

(<)TxIdTxIdBool Source #

(<=)TxIdTxIdBool Source #

(>)TxIdTxIdBool Source #

(>=)TxIdTxIdBool Source #

maxTxIdTxIdTxId Source #

minTxIdTxIdTxId Source #

data AsType TxId Source # 
Instance details

Defined in Cardano.Api.TxIn

getTxId ∷ ∀ era. TxBody era → TxId Source #

Calculate the transaction identifier for a TxBody.

getTxIdShelley ∷ Crypto (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
FromJSON TxIn Source # 
Instance details

Defined in Cardano.Api.TxIn

Methods

parseJSON ∷ Value → Parser TxIn #

parseJSONList ∷ Value → Parser [TxIn] #

FromJSONKey TxIn Source # 
Instance details

Defined in Cardano.Api.TxIn

Methods

fromJSONKey ∷ FromJSONKeyFunction TxIn

fromJSONKeyList ∷ FromJSONKeyFunction [TxIn]

ToJSON TxIn Source # 
Instance details

Defined in Cardano.Api.TxIn

Methods

toJSONTxIn → Value #

toEncodingTxIn → Encoding #

toJSONList ∷ [TxIn] → Value #

toEncodingList ∷ [TxIn] → Encoding #

ToJSONKey TxIn Source # 
Instance details

Defined in Cardano.Api.TxIn

Methods

toJSONKey ∷ ToJSONKeyFunction TxIn

toJSONKeyList ∷ ToJSONKeyFunction [TxIn]

Show TxIn Source # 
Instance details

Defined in Cardano.Api.TxIn

Methods

showsPrecIntTxInShowS Source #

showTxInString Source #

showList ∷ [TxIn] → ShowS Source #

Eq TxIn Source # 
Instance details

Defined in Cardano.Api.TxIn

Methods

(==)TxInTxInBool Source #

(/=)TxInTxInBool Source #

Ord TxIn Source # 
Instance details

Defined in Cardano.Api.TxIn

Methods

compareTxInTxInOrdering Source #

(<)TxInTxInBool Source #

(<=)TxInTxInBool Source #

(>)TxInTxInBool Source #

(>=)TxInTxInBool Source #

maxTxInTxInTxIn Source #

minTxInTxInTxIn Source #

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

newtype TxIx Source #

Constructors

TxIx Word 

Instances

Instances details
FromJSON TxIx Source # 
Instance details

Defined in Cardano.Api.TxIn

Methods

parseJSON ∷ Value → Parser TxIx #

parseJSONList ∷ Value → Parser [TxIx] #

ToJSON TxIx Source # 
Instance details

Defined in Cardano.Api.TxIn

Methods

toJSONTxIx → Value #

toEncodingTxIx → Encoding #

toJSONList ∷ [TxIx] → Value #

toEncodingList ∷ [TxIx] → Encoding #

Enum TxIx Source # 
Instance details

Defined in Cardano.Api.TxIn

Show TxIx Source # 
Instance details

Defined in Cardano.Api.TxIn

Methods

showsPrecIntTxIxShowS Source #

showTxIxString Source #

showList ∷ [TxIx] → ShowS Source #

Eq TxIx Source # 
Instance details

Defined in Cardano.Api.TxIn

Methods

(==)TxIxTxIxBool Source #

(/=)TxIxTxIxBool Source #

Ord TxIx Source # 
Instance details

Defined in Cardano.Api.TxIn

Methods

compareTxIxTxIxOrdering Source #

(<)TxIxTxIxBool Source #

(<=)TxIxTxIxBool Source #

(>)TxIxTxIxBool Source #

(>=)TxIxTxIxBool Source #

maxTxIxTxIxTxIx Source #

minTxIxTxIxTxIx Source #

genesisUTxOPseudoTxInNetworkIdHash GenesisUTxOKeyTxIn 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] #

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] #

data TxOut ctx era Source #

Constructors

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

Instances

Instances details
EraCast (TxOut ctx) Source # 
Instance details

Defined in Cardano.Api.TxBody

Methods

eraCast ∷ (IsCardanoEra fromEra, IsCardanoEra toEra) ⇒ CardanoEra toEra → TxOut ctx fromEra → Either EraCastError (TxOut ctx toEra) Source #

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] #

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] #

IsCardanoEra era ⇒ ToJSON (TxOut ctx era) Source # 
Instance details

Defined in Cardano.Api.TxBody

Methods

toJSONTxOut ctx era → Value #

toEncodingTxOut ctx era → Encoding #

toJSONList ∷ [TxOut ctx era] → Value #

toEncodingList ∷ [TxOut ctx era] → Encoding #

Show (TxOut ctx era) Source # 
Instance details

Defined in Cardano.Api.TxBody

Methods

showsPrecIntTxOut ctx era → ShowS Source #

showTxOut ctx era → String Source #

showList ∷ [TxOut ctx era] → ShowS Source #

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 #

data TxOutValue era where Source #

Instances

Instances details
EraCast TxOutValue Source # 
Instance details

Defined in Cardano.Api.TxBody

Methods

eraCast ∷ (IsCardanoEra fromEra, IsCardanoEra toEra) ⇒ CardanoEra toEra → TxOutValue fromEra → Either EraCastError (TxOutValue toEra) Source #

IsCardanoEra era ⇒ FromJSON (TxOutValue era) Source # 
Instance details

Defined in Cardano.Api.TxBody

Methods

parseJSON ∷ Value → Parser (TxOutValue era) #

parseJSONList ∷ Value → Parser [TxOutValue era] #

ToJSON (TxOutValue era) Source # 
Instance details

Defined in Cardano.Api.TxBody

Methods

toJSONTxOutValue era → Value #

toEncodingTxOutValue era → Encoding #

toJSONList ∷ [TxOutValue era] → Value #

toEncodingList ∷ [TxOutValue era] → Encoding #

Generic (TxOutValue era) Source # 
Instance details

Defined in Cardano.Api.TxBody

Associated Types

type Rep (TxOutValue era) ∷ TypeType Source #

Methods

fromTxOutValue era → Rep (TxOutValue era) x Source #

toRep (TxOutValue era) x → TxOutValue era Source #

Show (TxOutValue era) Source # 
Instance details

Defined in Cardano.Api.TxBody

Methods

showsPrecIntTxOutValue era → ShowS Source #

showTxOutValue era → String Source #

showList ∷ [TxOutValue era] → ShowS Source #

Eq (TxOutValue era) Source # 
Instance details

Defined in Cardano.Api.TxBody

Methods

(==)TxOutValue era → TxOutValue era → Bool Source #

(/=)TxOutValue era → TxOutValue era → Bool Source #

type Rep (TxOutValue era) Source # 
Instance details

Defined in Cardano.Api.TxBody

data TxOutDatum ctx era where Source #

Constructors

TxOutDatumNoneTxOutDatum ctx era 
TxOutDatumHashScriptDataSupportedInEra era → Hash ScriptDataTxOutDatum ctx era

A transaction output that only specifies the hash of the datum, but not the full datum value.

TxOutDatumInlineReferenceTxInsScriptsInlineDatumsSupportedInEra era → HashableScriptDataTxOutDatum 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 TxOutDatumInTxScriptDataSupportedInEra era → HashableScriptDataTxOutDatum CtxTx era 

Instances

Instances details
EraCast (TxOutDatum ctx) Source # 
Instance details

Defined in Cardano.Api.TxBody

Methods

eraCast ∷ (IsCardanoEra fromEra, IsCardanoEra toEra) ⇒ CardanoEra toEra → TxOutDatum ctx fromEra → Either EraCastError (TxOutDatum ctx toEra) Source #

Show (TxOutDatum ctx era) Source # 
Instance details

Defined in Cardano.Api.TxBody

Methods

showsPrecIntTxOutDatum ctx era → ShowS Source #

showTxOutDatum ctx era → String Source #

showList ∷ [TxOutDatum ctx era] → ShowS Source #

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 #

data TxOutInAnyEra where Source #

Constructors

TxOutInAnyEraCardanoEra era → TxOut CtxTx era → TxOutInAnyEra 

Instances

Instances details
Show TxOutInAnyEra Source # 
Instance details

Defined in Cardano.Api.TxBody

Eq TxOutInAnyEra Source # 
Instance details

Defined in Cardano.Api.TxBody

txOutInAnyEraIsCardanoEra era ⇒ TxOut CtxTx era → TxOutInAnyEra Source #

Convenience constructor for TxOutInAnyEra

Other transaction body types

data TxInsCollateral era where Source #

Instances

Instances details
Show (TxInsCollateral era) Source # 
Instance details

Defined in Cardano.Api.TxBody

Eq (TxInsCollateral era) Source # 
Instance details

Defined in Cardano.Api.TxBody

data TxInsReference build era where Source #

Instances

Instances details
Show (TxInsReference build era) Source # 
Instance details

Defined in Cardano.Api.TxBody

Methods

showsPrecIntTxInsReference build era → ShowS Source #

showTxInsReference build era → String Source #

showList ∷ [TxInsReference build era] → ShowS Source #

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 #

data TxReturnCollateral ctx era where Source #

Instances

Instances details
Show (TxReturnCollateral ctx era) Source # 
Instance details

Defined in Cardano.Api.TxBody

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 #

data TxFee era where Source #

Constructors

TxFeeImplicitTxFeesImplicitInEra era → TxFee era 
TxFeeExplicitTxFeesExplicitInEra era → LovelaceTxFee era 

Instances

Instances details
Show (TxFee era) Source # 
Instance details

Defined in Cardano.Api.TxBody

Methods

showsPrecIntTxFee era → ShowS Source #

showTxFee era → String Source #

showList ∷ [TxFee era] → ShowS Source #

Eq (TxFee era) Source # 
Instance details

Defined in Cardano.Api.TxBody

Methods

(==)TxFee era → TxFee era → Bool Source #

(/=)TxFee era → TxFee era → Bool Source #

data TxMetadataInEra era where Source #

Instances

Instances details
Show (TxMetadataInEra era) Source # 
Instance details

Defined in Cardano.Api.TxBody

Eq (TxMetadataInEra era) Source # 
Instance details

Defined in Cardano.Api.TxBody

data TxAuxScripts era where Source #

Instances

Instances details
Show (TxAuxScripts era) Source # 
Instance details

Defined in Cardano.Api.TxBody

Eq (TxAuxScripts era) Source # 
Instance details

Defined in Cardano.Api.TxBody

Methods

(==)TxAuxScripts era → TxAuxScripts era → Bool Source #

(/=)TxAuxScripts era → TxAuxScripts era → Bool Source #

data TxWithdrawals build era where Source #

Instances

Instances details
Show (TxWithdrawals build era) Source # 
Instance details

Defined in Cardano.Api.TxBody

Methods

showsPrecIntTxWithdrawals build era → ShowS Source #

showTxWithdrawals build era → String Source #

showList ∷ [TxWithdrawals build era] → ShowS Source #

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 #

data TxCertificates build era where Source #

Instances

Instances details
Show (TxCertificates build era) Source # 
Instance details

Defined in Cardano.Api.TxBody

Methods

showsPrecIntTxCertificates build era → ShowS Source #

showTxCertificates build era → String Source #

showList ∷ [TxCertificates build era] → ShowS Source #

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 #

data TxUpdateProposal era where Source #

Instances

Instances details
Show (TxUpdateProposal era) Source # 
Instance details

Defined in Cardano.Api.TxBody

Eq (TxUpdateProposal era) Source # 
Instance details

Defined in Cardano.Api.TxBody

data TxMintValue build era where Source #

Constructors

TxMintNoneTxMintValue build era 
TxMintValueMultiAssetSupportedInEra era → ValueBuildTxWith build (Map PolicyId (ScriptWitness WitCtxMint era)) → TxMintValue build era 

Instances

Instances details
Show (TxMintValue build era) Source # 
Instance details

Defined in Cardano.Api.TxBody

Methods

showsPrecIntTxMintValue build era → ShowS Source #

showTxMintValue build era → String Source #

showList ∷ [TxMintValue build era] → ShowS Source #

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 #

Building vs viewing transactions

data BuildTxWith build a where Source #

Constructors

ViewTxBuildTxWith ViewTx a 
BuildTxWith ∷ a → BuildTxWith BuildTx a 

Instances

Instances details
Show a ⇒ Show (BuildTxWith build a) Source # 
Instance details

Defined in Cardano.Api.TxBody

Methods

showsPrecIntBuildTxWith build a → ShowS Source #

showBuildTxWith build a → String Source #

showList ∷ [BuildTxWith build a] → ShowS 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 #

Era-dependent transaction body features

data CollateralSupportedInEra era where Source #

A representation of whether the era supports transactions with inputs used only for collateral for script fees.

The Alonzo and subsequent eras support collateral inputs.

data MultiAssetSupportedInEra era where Source #

A representation of whether the era supports multi-asset transactions.

The Mary and subsequent eras support multi-asset transactions.

The negation of this is OnlyAdaSupportedInEra.

Constructors

MultiAssetInMaryEraMultiAssetSupportedInEra MaryEra

Multi-asset transactions are supported in the Mary era.

MultiAssetInAlonzoEraMultiAssetSupportedInEra AlonzoEra

Multi-asset transactions are supported in the Alonzo era.

MultiAssetInBabbageEraMultiAssetSupportedInEra BabbageEra

Multi-asset transactions are supported in the Babbage era.

MultiAssetInConwayEraMultiAssetSupportedInEra ConwayEra

Multi-asset transactions are supported in the Conway era.

data OnlyAdaSupportedInEra era where Source #

A representation of whether the era supports only ada transactions.

Prior to the Mary era only ada transactions are supported. Multi-assets are supported from the Mary era onwards.

This is the negation of MultiAssetSupportedInEra. It exists since we need evidence to be positive.

Instances

Instances details
Show (OnlyAdaSupportedInEra era) Source # 
Instance details

Defined in Cardano.Api.TxBody

Eq (OnlyAdaSupportedInEra era) Source # 
Instance details

Defined in Cardano.Api.TxBody

data TxFeesExplicitInEra era where Source #

A representation of whether the era requires explicitly specified fees in transactions.

The Byron era tx fees are implicit (as the difference bettween the sum of outputs and sum of inputs), but all later eras the fees are specified in the transaction explicitly.

Instances

Instances details
Show (TxFeesExplicitInEra era) Source # 
Instance details

Defined in Cardano.Api.TxBody

Eq (TxFeesExplicitInEra era) Source # 
Instance details

Defined in Cardano.Api.TxBody

data TxFeesImplicitInEra era where Source #

A representation of whether the era requires implicitly specified fees in transactions.

This is the negation of TxFeesExplicitInEra.

Instances

Instances details
Show (TxFeesImplicitInEra era) Source # 
Instance details

Defined in Cardano.Api.TxBody

Eq (TxFeesImplicitInEra era) Source # 
Instance details

Defined in Cardano.Api.TxBody

data ValidityNoUpperBoundSupportedInEra era where Source #

A representation of whether the era supports transactions having no upper bound on the range of slots in which they are valid.

Note that the ShelleyEra does not support omitting a validity upper bound. It was introduced as a required field in Shelley and then made optional in Allegra and subsequent eras.

The Byron era supports this by virtue of the fact that it does not support validity ranges at all.

data ValidityLowerBoundSupportedInEra era where Source #

A representation of whether the era supports transactions with a lower bound on the range of slots in which they are valid.

The Allegra and subsequent eras support an optional lower bound on the validity range. No equivalent of ValidityNoUpperBoundSupportedInEra is needed since all eras support having no lower bound.

data TxExtraKeyWitnessesSupportedInEra era where Source #

A representation of whether the era supports transactions that specify in the body that they need extra key witnesses, and where this fact is visible to scripts.

Extra key witnesses visible to scripts are supported from the Alonzo era onwards.

data ScriptDataSupportedInEra era where Source #

A representation of whether the era supports script data in transactions.

data WithdrawalsSupportedInEra era where Source #

A representation of whether the era supports withdrawals from reward accounts.

The Shelley and subsequent eras support stake addresses, their associated reward accounts and support for withdrawals from them.

data UpdateProposalSupportedInEra era where Source #

A representation of whether the era supports UpdateProposals embedded in transactions.

The Shelley and subsequent eras support such update proposals. They Byron era has a notion of an update proposal, but it is a standalone chain object and not embedded in a transaction.

Feature availability functions

Inspecting ScriptWitnesses

data AnyScriptWitness era where Source #

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

Constructors

AnyScriptWitnessScriptWitness witctx era → AnyScriptWitness era 

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 TxIds.

ScriptWitnessIndexMint !Word

The n'th minting PolicyId, in the order of the PolicyIds.

ScriptWitnessIndexCertificate !Word

The n'th certificate, in the list order of the certificates.

ScriptWitnessIndexWithdrawal !Word

The n'th withdrawal, in the order of the StakeAddresss.

Conversion to inline data

scriptDataToInlineDatumHashableScriptData → 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

toByronTxIdTxId → TxId Source #

toShelleyTxIdTxId → TxId StandardCrypto Source #

toShelleyTxInTxIn → 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 ∷ ∀ era ledgerera. ShelleyLedgerEra era ~ ledgerera ⇒ ShelleyBasedEra era → TxOut CtxUTxO era → TxOut ledgerera Source #

toShelleyTxOutAny ∷ ∀ 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 #

fromShelleyTxOutShelleyLedgerEra era ~ ledgerera ⇒ ShelleyBasedEra era → TxOut ledgerera → TxOut ctx era Source #

fromByronTxIn ∷ TxIn → TxIn Source #

fromLedgerTxOuts ∷ ∀ era. ShelleyBasedEra era → TxBody (ShelleyLedgerEra era) → TxBodyScriptData era → [TxOut CtxTx era] Source #

Misc helpers

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 AddressAny Source # 
Instance details

Defined in Cardano.Api.Address

data AsType ByronAddr Source # 
Instance details

Defined in Cardano.Api.Address

data AsType ShelleyAddr Source # 
Instance details

Defined in Cardano.Api.Address

data AsType StakeAddress Source # 
Instance details

Defined in Cardano.Api.Address

data AsType BlockHeader Source # 
Instance details

Defined in Cardano.Api.Block

data AsType Certificate Source # 
Instance details

Defined in Cardano.Api.Certificate

data AsType AllegraEra Source # 
Instance details

Defined in Cardano.Api.Eras

data AsType AlonzoEra Source # 
Instance details

Defined in Cardano.Api.Eras

data AsType BabbageEra Source # 
Instance details

Defined in Cardano.Api.Eras

data AsType ByronEra Source # 
Instance details

Defined in Cardano.Api.Eras

data AsType ConwayEra Source # 
Instance details

Defined in Cardano.Api.Eras

data AsType MaryEra Source # 
Instance details

Defined in Cardano.Api.Eras

data AsType ShelleyEra Source # 
Instance details

Defined in Cardano.Api.Eras

data AsType ByronKey Source # 
Instance details

Defined in Cardano.Api.Keys.Byron

data AsType ByronKeyLegacy Source # 
Instance details

Defined in Cardano.Api.Keys.Byron

data AsType KesKey Source # 
Instance details

Defined in Cardano.Api.Keys.Praos

data AsType VrfKey Source # 
Instance details

Defined in Cardano.Api.Keys.Praos

data AsType GenesisDelegateExtendedKey Source # 
Instance details

Defined in Cardano.Api.Keys.Shelley

data AsType GenesisDelegateKey Source # 
Instance details

Defined in Cardano.Api.Keys.Shelley

data AsType GenesisExtendedKey Source # 
Instance details

Defined in Cardano.Api.Keys.Shelley

data AsType GenesisKey Source # 
Instance details

Defined in Cardano.Api.Keys.Shelley

data AsType GenesisUTxOKey Source # 
Instance details

Defined in Cardano.Api.Keys.Shelley

data AsType PaymentExtendedKey Source # 
Instance details

Defined in Cardano.Api.Keys.Shelley

data AsType PaymentKey Source # 
Instance details

Defined in Cardano.Api.Keys.Shelley

data AsType StakeExtendedKey Source # 
Instance details

Defined in Cardano.Api.Keys.Shelley

data AsType StakeKey Source # 
Instance details

Defined in Cardano.Api.Keys.Shelley

data AsType StakePoolKey Source # 
Instance details

Defined in Cardano.Api.Keys.Shelley

data AsType OperationalCertificate Source # 
Instance details

Defined in Cardano.Api.OperationalCertificate

data AsType OperationalCertificateIssueCounter Source # 
Instance details

Defined in Cardano.Api.OperationalCertificate

data AsType PraosNonce Source # 
Instance details

Defined in Cardano.Api.ProtocolParameters

data AsType UpdateProposal Source # 
Instance details

Defined in Cardano.Api.ProtocolParameters

data AsType PlutusScriptV1 Source # 
Instance details

Defined in Cardano.Api.Script

data AsType PlutusScriptV2 Source # 
Instance details

Defined in Cardano.Api.Script

data AsType ScriptHash Source # 
Instance details

Defined in Cardano.Api.Script

data AsType ScriptInAnyLang Source # 
Instance details

Defined in Cardano.Api.Script

data AsType SimpleScript' Source # 
Instance details

Defined in Cardano.Api.Script

data AsType HashableScriptData Source # 
Instance details

Defined in Cardano.Api.ScriptData

data AsType ScriptData Source # 
Instance details

Defined in Cardano.Api.ScriptData

data AsType TextEnvelope Source # 
Instance details

Defined in Cardano.Api.SerialiseTextEnvelope

data AsType ByronUpdateProposal Source # 
Instance details

Defined in Cardano.Api.SpecialByron

data AsType ByronVote Source # 
Instance details

Defined in Cardano.Api.SpecialByron

data AsType StakePoolMetadata Source # 
Instance details

Defined in Cardano.Api.StakePoolMetadata

data AsType TxId Source # 
Instance details

Defined in Cardano.Api.TxIn

data AsType TxMetadata Source # 
Instance details

Defined in Cardano.Api.TxMetadata

data AsType AssetName Source # 
Instance details

Defined in Cardano.Api.Value

data AsType PolicyId Source # 
Instance details

Defined in Cardano.Api.Value

data AsType (Address addrtype) Source # 
Instance details

Defined in Cardano.Api.Address

data AsType (Address addrtype) = AsAddress (AsType addrtype)
data AsType (AddressInEra era) Source # 
Instance details

Defined in Cardano.Api.Address

data AsType (Hash a) Source # 
Instance details

Defined in Cardano.Api.Hash

data AsType (Hash a) = AsHash (AsType a)
data AsType (SigningKey a) Source # 
Instance details

Defined in Cardano.Api.Keys.Class

data AsType (VerificationKey a) Source # 
Instance details

Defined in Cardano.Api.Keys.Class

data AsType (PlutusScript lang) Source # 
Instance details

Defined in Cardano.Api.Script

data AsType (Script lang) Source # 
Instance details

Defined in Cardano.Api.Script

data AsType (Script lang) = AsScript (AsType lang)
data AsType (ScriptInEra era) Source # 
Instance details

Defined in Cardano.Api.Script

data AsType (KeyWitness era) Source # 
Instance details

Defined in Cardano.Api.Tx

data AsType (Tx era) Source # 
Instance details

Defined in Cardano.Api.Tx

data AsType (Tx era) = AsTx (AsType era)
data AsType (TxBody era) Source # 
Instance details

Defined in Cardano.Api.TxBody

data AsType (TxBody era) = AsTxBody (AsType era)