Modulecardano-api-11.7.0.0

Cardano.Api.Experimental.Tx

Synopsis

value collectPlutusScriptHashes
value convertTxBodyToUnsignedTx
value evaluateSignedTx
value getUnsignedTxFee
value hashTxBody
value makeKeyWitness
value signTx
value getAnyWitnessPlutusLanguage
value getAnyWitnessReferenceInput
value getAnyWitnessScript
value getAnyWitnessScriptData
value defaultTxBodyContent
value extractAllIndexedPlutusScriptWitnesses
value extractDatumsAndHashes
value extractWitnessableCertificates
value extractWitnessableMints
value extractWitnessableProposals
value extractWitnessableTxIns
value extractWitnessableVotes
value extractWitnessableWithdrawals
value getDatums
value makeUnsignedTx
value mkTxCertificates
value mkTxProposalProcedures
value mkTxVotingProcedures
value modTxOuts
value setTxAuxScripts
value setTxCertificates
value setTxCurrentTreasuryValue
value setTxExtraKeyWits
value setTxFee
value setTxIns
value setTxInsCollateral
value setTxInsReference
value setTxMetadata
value setTxMintValue
value setTxOuts
value setTxProposalProcedures
value setTxProtocolParams
value setTxReturnCollateral
value setTxScriptValidity
value setTxSupplementalDatums
value setTxTotalCollateral
value setTxTreasuryDonation
value setTxValidityLowerBound
value setTxValidityUpperBound
value setTxVotingProcedures
value setTxWithdrawals
value calculateMinimumUTxO
value evaluateTransaction
value evaluateTransactionExecutionUnits
value makeTransactionBodyAutoBalance
value extractExecutionUnits
value getTxScriptWitnessRequirements
value getTxScriptWitnessesRequirements
value obtainMonoidConstraint
data SignedTx
data AnyWitness
data Datum
data MakeUnsignedTxError
data TxBodyContent
newtype TxCertificates
newtype TxExtraKeyWitnesses
data TxInsReference
newtype TxMintValue
data TxOut
newtype TxProposalProcedures
newtype TxReturnCollateral
newtype TxTotalCollateral
data TxVotingProcedures
newtype TxWithdrawals
data TxBodyErrorAutoBalance
data TxEvaluationResult
data TxFeeEstimationError
data TxScriptWitnessRequirements
data UnsignedTx

Packagecardano-api-11.7.0.0
Exports76
LicenceApache-2.0

valuecollectPlutusScriptHashes

valueconvertTxBodyToUnsignedTx

:: HasCallStack
=> ShelleyBasedEra era
-> TxBody era
-> UnsignedTx (LedgerEra era)

valueevaluateSignedTx

:: IsEra era
=> SystemStart
-> LedgerEpochInfo
-> PParams (LedgerEra era)
-> Set PoolId
-> Map StakeCredential Coin
-> UTxO (LedgerEra era)
-> SignedTx era
-> TxEvaluationResult (LedgerEra era)

valuegetUnsignedTxFee :: UnsignedTx era -> Coin

valuehashTxBody

:: HashAnnotated (TxBody TopTx era) EraIndependentTxBody
=> TxBody TopTx era
-> Hash HASH EraIndependentTxBody

valuemakeKeyWitness

valuesignTx

:: Era era
-> [BootstrapWitness]
-> [WitVKey Witness]
-> UnsignedTx (LedgerEra era)
-> SignedTx era

valuegetAnyWitnessPlutusLanguage :: AnyWitness era -> Maybe Language

valuegetAnyWitnessReferenceInput :: AnyWitness era -> Maybe TxIn

valuegetAnyWitnessScript

:: AlonzoEraScript era
=> AnyWitness era
-> Maybe (Script era)

valuegetAnyWitnessScriptData :: Era era => AnyWitness era -> TxDats era

valuedefaultTxBodyContent :: TxBodyContent era

valueextractAllIndexedPlutusScriptWitnesses

:: Era era
-> TxBodyContent (LedgerEra era)
-> Either DecoderError [AnyIndexedPlutusScriptWitness (LedgerEra era)]

valueextractDatumsAndHashes :: Datum ctx era -> Maybe (DataHash, Data era)

valueextractWitnessableCertificates

:: IsEra era
=> TxCertificates (LedgerEra era)
-> [(Witnessable 'CertItem (LedgerEra era), AnyWitness (LedgerEra era))]

valueextractWitnessableMints

:: IsEra era
=> TxMintValue (LedgerEra era)
-> [(Witnessable 'MintItem (LedgerEra era), AnyScriptWitness (LedgerEra era))]

valueextractWitnessableProposals

:: IsEra era
=> Maybe (TxProposalProcedures (LedgerEra era))
-> [(Witnessable 'ProposalItem (LedgerEra era), AnyWitness (LedgerEra era))]

valueextractWitnessableTxIns

:: IsEra era
=> [(TxIn, AnyWitness (LedgerEra era))]
-> [(Witnessable 'TxInItem (LedgerEra era), AnyWitness (LedgerEra era))]

valueextractWitnessableVotes

:: IsEra era
=> Maybe (TxVotingProcedures (LedgerEra era))
-> [(Witnessable 'VoterItem (LedgerEra era), AnyWitness (LedgerEra era))]

valueextractWitnessableWithdrawals

:: IsEra era
=> TxWithdrawals (LedgerEra era)
-> [(Witnessable 'WithdrawalItem (LedgerEra era), AnyWitness (LedgerEra era))]

valuegetDatums

:: IsEra era
=> TxInsReference (LedgerEra era)
-> Map DataHash (Data (LedgerEra era))
-> TxDats (LedgerEra era)

valuemakeUnsignedTx

:: Era era
-> TxBodyContent (LedgerEra era)
-> Either MakeUnsignedTxError (UnsignedTx (LedgerEra era))

valuemkTxCertificates

:: Era era
-> [(Certificate (LedgerEra era), AnyWitness (LedgerEra era))]
-> TxCertificates (LedgerEra era)

valuemkTxProposalProcedures

:: IsEra era
=> [(ProposalProcedure (LedgerEra era), AnyWitness (LedgerEra era))]
-> TxProposalProcedures (LedgerEra era)

valuemkTxVotingProcedures

:: [(VotingProcedures era, AnyWitness era)]
-> Either (VotingError era) (TxVotingProcedures era)

valuemodTxOuts

:: [TxOut era] -> [TxOut era]
-> TxBodyContent era
-> TxBodyContent era

valuesetTxAuxScripts

:: [SimpleScript era]
-> TxBodyContent era
-> TxBodyContent era

valuesetTxCertificates

:: TxCertificates era
-> TxBodyContent era
-> TxBodyContent era

valuesetTxCurrentTreasuryValue :: Coin -> TxBodyContent era -> TxBodyContent era

valuesetTxExtraKeyWits

:: TxExtraKeyWitnesses
-> TxBodyContent era
-> TxBodyContent era

valuesetTxFee :: Coin -> TxBodyContent era -> TxBodyContent era

valuesetTxIns

:: [(TxIn, AnyWitness era)]
-> TxBodyContent era
-> TxBodyContent era

valuesetTxInsCollateral :: [TxIn] -> TxBodyContent era -> TxBodyContent era

valuesetTxInsReference

:: TxInsReference era
-> TxBodyContent era
-> TxBodyContent era

valuesetTxMetadata :: TxMetadata -> TxBodyContent era -> TxBodyContent era

valuesetTxMintValue :: TxMintValue era -> TxBodyContent era -> TxBodyContent era

valuesetTxOuts :: [TxOut era] -> TxBodyContent era -> TxBodyContent era

valuesetTxProposalProcedures

:: TxProposalProcedures era
-> TxBodyContent era
-> TxBodyContent era

valuesetTxProtocolParams :: PParams era -> TxBodyContent era -> TxBodyContent era

valuesetTxReturnCollateral

:: TxReturnCollateral era
-> TxBodyContent era
-> TxBodyContent era

valuesetTxScriptValidity

:: ScriptValidity
-> TxBodyContent era
-> TxBodyContent era

valuesetTxSupplementalDatums

:: Map DataHash (Data era)
-> TxBodyContent era
-> TxBodyContent era

valuesetTxTotalCollateral

:: TxTotalCollateral
-> TxBodyContent era
-> TxBodyContent era

valuesetTxTreasuryDonation :: Coin -> TxBodyContent era -> TxBodyContent era

valuesetTxValidityLowerBound :: SlotNo -> TxBodyContent era -> TxBodyContent era

valuesetTxValidityUpperBound :: SlotNo -> TxBodyContent era -> TxBodyContent era

valuesetTxVotingProcedures

:: TxVotingProcedures era
-> TxBodyContent era
-> TxBodyContent era

valuesetTxWithdrawals

:: TxWithdrawals era
-> TxBodyContent era
-> TxBodyContent era

valuecalculateMinimumUTxO

:: HasCallStack
=> PParams (LedgerEra era)
-> TxOut (LedgerEra era)
-> Coin

valueevaluateTransaction

valueevaluateTransactionExecutionUnits

:: IsEra era
=> SystemStart
-> LedgerEpochInfo
-> PParams (LedgerEra era)
-> UTxO (LedgerEra era)
-> Tx TopTx (LedgerEra era)
-> Map ScriptWitnessIndex (Either ScriptExecutionError (EvalTxExecutionUnitsLog, ExecutionUnits))

valuemakeTransactionBodyAutoBalance

:: (HasCallStack, IsEra era)
=> SystemStart
-> LedgerEpochInfo
-> PParams (LedgerEra era)
-> Set PoolId
-> Map StakeCredential Coin
-> UTxO (LedgerEra era)
-> TxBodyContent (LedgerEra era)
-> AddressInEra era
-> Maybe Word
-> Either (TxBodyErrorAutoBalance (LedgerEra era)) (UnsignedTx (LedgerEra era), TxBodyContent (LedgerEra era))

valueextractExecutionUnits :: TxScriptWitnessRequirements era -> [ExecutionUnits]

valuegetTxScriptWitnessRequirements

:: (AlonzoEraScript era, Monoid (TxScriptWitnessRequirements era))
=> [(Witnessable witnessable era, AnyWitness era)]
-> TxScriptWitnessRequirements era

valuegetTxScriptWitnessesRequirements

:: (AlonzoEraScript era, Monoid (TxScriptWitnessRequirements era))
=> [(Witnessable witnessable era, AnyWitness era)]
-> TxScriptWitnessRequirements era

valueobtainMonoidConstraint

:: Era era
-> Monoid (TxScriptWitnessRequirements (LedgerEra era)) => a
-> a

datadata SignedTx era

Constructors

EraTx (ShelleyLedgerEra era) => SignedTx (Tx TopTx (ShelleyLedgerEra era))

Instances5Eq, Show, HasTypeProxy, SerialiseAsRawBytes, AsType

Eq (SignedTx era)Defined in cardano-api-11.7.0.0 · Cardano.Api.Experimental.Tx
Show (SignedTx era)Defined in cardano-api-11.7.0.0 · Cardano.Api.Experimental.Tx
HasTypeProxy era => HasTypeProxy (SignedTx era)Defined in cardano-api-11.7.0.0 · Cardano.Api.Experimental.Tx
(HasTypeProxy era, EraTx (ShelleyLedgerEra era)) => SerialiseAsRawBytes (SignedTx era)Defined in cardano-api-11.7.0.0 · Cardano.Api.Experimental.Tx
data AsType (SignedTx era)
- AsSignedTx (AsType era)
Defined in cardano-api-11.7.0.0 · Cardano.Api.Experimental.Tx

datadata AnyWitness era where

Constructors

AnyKeyWitnessPlaceholder :: AnyWitness era
AnySimpleScriptWitness :: SimpleScriptOrReferenceInput era -> AnyWitness era
AnyPlutusScriptWitness :: AnyPlutusScriptWitness lang purpose era -> AnyWitness era

Instances2Eq, Show

Eq (AnyWitness era)Defined in cardano-api-11.7.0.0 · Cardano.Api.Experimental.Tx.Internal.AnyWitness
Show (AnyWitness era)Defined in cardano-api-11.7.0.0 · Cardano.Api.Experimental.Tx.Internal.AnyWitness

datadata Datum ctx era where

Constructors

TxOutDatumHash :: DataHash -> Datum ctx era
TxOutSupplementalDatum :: DataHash -> Data era -> Datum CtxTx era
TxOutDatumInline :: DataHash -> Data era -> Datum ctx era

Instances2Eq, Show

Eq (Datum ctx era)Defined in cardano-api-11.7.0.0 · Cardano.Api.Experimental.Tx.Internal.BodyContent.New
Show (Datum ctx era)Defined in cardano-api-11.7.0.0 · Cardano.Api.Experimental.Tx.Internal.BodyContent.New

datadata MakeUnsignedTxError

MakeUnsignedTxMissingProtocolParams

Instances3Eq, Show, Error

Eq MakeUnsignedTxErrorDefined in cardano-api-11.7.0.0 · Cardano.Api.Experimental.Tx.Internal.BodyContent.New
Show MakeUnsignedTxErrorDefined in cardano-api-11.7.0.0 · Cardano.Api.Experimental.Tx.Internal.BodyContent.New
Error MakeUnsignedTxErrorDefined in cardano-api-11.7.0.0 · Cardano.Api.Experimental.Tx.Internal.BodyContent.New

datadata TxBodyContent era

Constructors

TxBodyContent
- txIns :: [(TxIn, AnyWitness era)]
- txInsCollateral :: [TxIn]
- txInsReference :: TxInsReference era
- txOuts :: [TxOut era]
- txTotalCollateral :: Maybe TxTotalCollateral
- txReturnCollateral :: Maybe (TxReturnCollateral era)
- txFee :: Coin
- txValidityLowerBound :: Maybe SlotNo
- txValidityUpperBound :: Maybe SlotNo
- txMetadata :: TxMetadata
- txAuxScripts :: [SimpleScript era]
- txExtraKeyWits :: TxExtraKeyWitnesses
- txProtocolParams :: Maybe (PParams era)
- txWithdrawals :: TxWithdrawals era
- txCertificates :: TxCertificates era
- txMintValue :: TxMintValue era
- txScriptValidity :: ScriptValidity
- txProposalProcedures :: Maybe (TxProposalProcedures era)
- txVotingProcedures :: Maybe (TxVotingProcedures era)
- txCurrentTreasuryValue :: Maybe Coin
- txTreasuryDonation :: Maybe Coin
- txSupplementalDatums :: Map DataHash (Data era)

newtypenewtype TxCertificates era

Constructors

TxCertificates
- unTxCertificates :: OMap (Certificate era) (Maybe (AnyWitness era))

Instances2Eq, Show

Eq (TxCertificates era)Defined in cardano-api-11.7.0.0 · Cardano.Api.Experimental.Tx.Internal.BodyContent.New
Show (TxCertificates era)Defined in cardano-api-11.7.0.0 · Cardano.Api.Experimental.Tx.Internal.BodyContent.New

newtypenewtype TxExtraKeyWitnesses

Constructors

TxExtraKeyWitnesses [Hash PaymentKey]

datadata TxInsReference era

Constructors

TxInsReference [TxIn] (Set (Datum CtxTx era))

newtypenewtype TxMintValue era

Constructors

TxMintValue
- unTxMintValue :: Map PolicyId (PolicyAssets, AnyScriptWitness era)

Instances2Eq, Show

Eq (TxMintValue era)Defined in cardano-api-11.7.0.0 · Cardano.Api.Experimental.Tx.Internal.BodyContent.New
Show (TxMintValue era)Defined in cardano-api-11.7.0.0 · Cardano.Api.Experimental.Tx.Internal.BodyContent.New

datadata TxOut era where

Constructors

TxOut :: EraTxOut era => TxOut era -> TxOut era

Instances14Eq, Show, FromJSON, ToJSON, …

Eq (TxOut era)Defined in cardano-api-11.7.0.0 · Cardano.Api.Experimental.Tx.Internal.BodyContent.New
Show (TxOut era)Defined in cardano-api-11.7.0.0 · Cardano.Api.Experimental.Tx.Internal.BodyContent.New
FromJSON (TxOut AllegraEra)Defined in cardano-api-11.7.0.0 · Cardano.Api.Experimental.Tx.Internal.BodyContent.New
FromJSON (TxOut AlonzoEra)Defined in cardano-api-11.7.0.0 · Cardano.Api.Experimental.Tx.Internal.BodyContent.New
FromJSON (TxOut BabbageEra)Defined in cardano-api-11.7.0.0 · Cardano.Api.Experimental.Tx.Internal.BodyContent.New
FromJSON (TxOut ConwayEra)Defined in cardano-api-11.7.0.0 · Cardano.Api.Experimental.Tx.Internal.BodyContent.New
FromJSON (TxOut MaryEra)Defined in cardano-api-11.7.0.0 · Cardano.Api.Experimental.Tx.Internal.BodyContent.New
FromJSON (TxOut ShelleyEra)Defined in cardano-api-11.7.0.0 · Cardano.Api.Experimental.Tx.Internal.BodyContent.New
ToJSON (TxOut AllegraEra)Defined in cardano-api-11.7.0.0 · Cardano.Api.Experimental.Tx.Internal.BodyContent.New
ToJSON (TxOut AlonzoEra)Defined in cardano-api-11.7.0.0 · Cardano.Api.Experimental.Tx.Internal.BodyContent.New
ToJSON (TxOut BabbageEra)Defined in cardano-api-11.7.0.0 · Cardano.Api.Experimental.Tx.Internal.BodyContent.New
ToJSON (TxOut ConwayEra)Defined in cardano-api-11.7.0.0 · Cardano.Api.Experimental.Tx.Internal.BodyContent.New
ToJSON (TxOut MaryEra)Defined in cardano-api-11.7.0.0 · Cardano.Api.Experimental.Tx.Internal.BodyContent.New
ToJSON (TxOut ShelleyEra)Defined in cardano-api-11.7.0.0 · Cardano.Api.Experimental.Tx.Internal.BodyContent.New

newtypenewtype TxProposalProcedures era

Constructors

TxProposalProcedures (OMap (ProposalProcedure era) (AnyWitness era))

Instances2Eq, Show

EraPParams era => Eq (TxProposalProcedures era)Defined in cardano-api-11.7.0.0 · Cardano.Api.Experimental.Tx.Internal.BodyContent.New
EraPParams era => Show (TxProposalProcedures era)Defined in cardano-api-11.7.0.0 · Cardano.Api.Experimental.Tx.Internal.BodyContent.New

newtypenewtype TxReturnCollateral era

Constructors

TxReturnCollateral
- unTxReturnCollateral :: TxOut era

newtypenewtype TxTotalCollateral

Constructors

TxTotalCollateral
- unTxTotalCollateral :: Coin

datadata TxVotingProcedures era

Constructors

TxVotingProcedures (VotingProcedures era) (Map Voter (AnyWitness era))

Instances2Eq, Show

Eq (TxVotingProcedures era)Defined in cardano-api-11.7.0.0 · Cardano.Api.Experimental.Tx.Internal.BodyContent.New
Show (TxVotingProcedures era)Defined in cardano-api-11.7.0.0 · Cardano.Api.Experimental.Tx.Internal.BodyContent.New

newtypenewtype TxWithdrawals era

Constructors

TxWithdrawals
- unTxWithdrawals :: [(StakeAddress, Coin, AnyWitness era)]

Instances2Eq, Show

Eq (TxWithdrawals era)Defined in cardano-api-11.7.0.0 · Cardano.Api.Experimental.Tx.Internal.BodyContent.New
Show (TxWithdrawals era)Defined in cardano-api-11.7.0.0 · Cardano.Api.Experimental.Tx.Internal.BodyContent.New

datadata TxBodyErrorAutoBalance era

Instances2Show, Error

Show (TxBodyErrorAutoBalance era)Defined in cardano-api-11.7.0.0 · Cardano.Api.Experimental.Tx.Internal.Fee
Error (TxBodyErrorAutoBalance era)Defined in cardano-api-11.7.0.0 · Cardano.Api.Experimental.Tx.Internal.Fee

datadata TxEvaluationResult era

Constructors

Show (Value era) => TxEvaluationResult
- txEvalFee :: Coin
- txEvalExecutionUnits :: Map ScriptWitnessIndex (Either ScriptExecutionError (EvalTxExecutionUnitsLog, ExecutionUnits))
- txEvalBalance :: Value era

Instances1Show

Show (TxEvaluationResult era)Defined in cardano-api-11.7.0.0 · Cardano.Api.Experimental.Tx.Internal.Fee

datadata TxFeeEstimationError era

Constructors

TxFeeEstimationScriptExecutionError (TxBodyErrorAutoBalance (LedgerEra era))
TxFeeEstimationBalanceError (TxBodyErrorAutoBalance (LedgerEra era))
TxFeeEstimationMakeUnsignedTxError MakeUnsignedTxError

Instances2Show, Error

Show (TxFeeEstimationError era)Defined in cardano-api-11.7.0.0 · Cardano.Api.Experimental.Tx.Internal.Fee
Error (TxFeeEstimationError era)Defined in cardano-api-11.7.0.0 · Cardano.Api.Experimental.Tx.Internal.Fee

datadata TxScriptWitnessRequirements era

Constructors

TxScriptWitnessRequirements (Set Language) [Script era] (TxDats era) (Redeemers era)

Instances8Semigroup, Monoid, …

Semigroup (TxScriptWitnessRequirements AlonzoEra)Defined in cardano-api-11.7.0.0 · Cardano.Api.Experimental.Tx.Internal.TxScriptWitnessRequirements
Semigroup (TxScriptWitnessRequirements BabbageEra)Defined in cardano-api-11.7.0.0 · Cardano.Api.Experimental.Tx.Internal.TxScriptWitnessRequirements
Semigroup (TxScriptWitnessRequirements ConwayEra)Defined in cardano-api-11.7.0.0 · Cardano.Api.Experimental.Tx.Internal.TxScriptWitnessRequirements
Semigroup (TxScriptWitnessRequirements DijkstraEra)Defined in cardano-api-11.7.0.0 · Cardano.Api.Experimental.Tx.Internal.TxScriptWitnessRequirements
Monoid (TxScriptWitnessRequirements AlonzoEra)Defined in cardano-api-11.7.0.0 · Cardano.Api.Experimental.Tx.Internal.TxScriptWitnessRequirements
Monoid (TxScriptWitnessRequirements BabbageEra)Defined in cardano-api-11.7.0.0 · Cardano.Api.Experimental.Tx.Internal.TxScriptWitnessRequirements
Monoid (TxScriptWitnessRequirements ConwayEra)Defined in cardano-api-11.7.0.0 · Cardano.Api.Experimental.Tx.Internal.TxScriptWitnessRequirements
Monoid (TxScriptWitnessRequirements DijkstraEra)Defined in cardano-api-11.7.0.0 · Cardano.Api.Experimental.Tx.Internal.TxScriptWitnessRequirements

datadata UnsignedTx era

Constructors

EraTx era => UnsignedTx (Tx TopTx era)

Instances5Eq, Show, HasTypeProxy, SerialiseAsRawBytes, AsType

Eq (UnsignedTx era)Defined in cardano-api-11.7.0.0 · Cardano.Api.Experimental.Tx.Internal.Type
Show (UnsignedTx era)Defined in cardano-api-11.7.0.0 · Cardano.Api.Experimental.Tx.Internal.Type
Typeable era => HasTypeProxy (UnsignedTx era)Defined in cardano-api-11.7.0.0 · Cardano.Api.Experimental.Tx.Internal.Type
EraTx era => SerialiseAsRawBytes (UnsignedTx era)Defined in cardano-api-11.7.0.0 · Cardano.Api.Experimental.Tx.Internal.Type
data AsType (UnsignedTx era)
- AsUnsignedTx (AsType (ToApiEra era))
Defined in cardano-api-11.7.0.0 · Cardano.Api.Experimental.Tx.Internal.Type