Safe Haskell	None
Language	Haskell2010

Cardano.CLI.EraBased.Commands.Transaction

Synopsis

data TransactionCmds era
data TransactionBuildRawCmdArgs era = TransactionBuildRawCmdArgs {
- eon :: !(ShelleyBasedEra era)
- mScriptValidity :: !(Maybe ScriptValidity)
- txIns :: ![(TxIn, Maybe (ScriptWitnessFiles WitCtxTxIn))]
- readOnlyRefIns :: ![TxIn]
- txInsCollateral :: ![TxIn]
- mReturnCollateral :: !(Maybe TxOutShelleyBasedEra)
- mTotalCollateral :: !(Maybe Coin)
- requiredSigners :: ![RequiredSigner]
- txouts :: ![TxOutAnyEra]
- mValue :: !(Maybe (Value, [ScriptWitnessFiles WitCtxMint]))
- mValidityLowerBound :: !(Maybe SlotNo)
- mValidityUpperBound :: !(TxValidityUpperBound era)
- fee :: !Coin
- certificates :: ![(CertificateFile, Maybe (ScriptWitnessFiles WitCtxStake))]
- withdrawals :: ![(StakeAddress, Coin, Maybe (ScriptWitnessFiles WitCtxStake))]
- metadataSchema :: !TxMetadataJsonSchema
- scriptFiles :: ![ScriptFile]
- metadataFiles :: ![MetadataFile]
- mProtocolParamsFile :: !(Maybe ProtocolParamsFile)
- mUpdateProprosalFile :: !(Maybe (Featured ShelleyToBabbageEra era (Maybe UpdateProposalFile)))
- voteFiles :: ![(VoteFile 'In, Maybe (ScriptWitnessFiles WitCtxStake))]
- proposalFiles :: ![(ProposalFile 'In, Maybe (ScriptWitnessFiles WitCtxStake))]
- currentTreasuryValueAndDonation :: !(Maybe (TxCurrentTreasuryValue, TxTreasuryDonation))
- txBodyOutFile :: !(TxBodyFile 'Out)
}
data TransactionBuildCmdArgs era = TransactionBuildCmdArgs {
- currentEra :: !(Era era)
- nodeSocketPath :: !SocketPath
- consensusModeParams :: !ConsensusModeParams
- networkId :: !NetworkId
- mScriptValidity :: !(Maybe ScriptValidity)
- mOverrideWitnesses :: !(Maybe Word)
- txins :: ![(TxIn, Maybe (ScriptWitnessFiles WitCtxTxIn))]
- readOnlyReferenceInputs :: ![TxIn]
- requiredSigners :: ![RequiredSigner]
- txinsc :: ![TxIn]
- mReturnCollateral :: !(Maybe TxOutShelleyBasedEra)
- mTotalCollateral :: !(Maybe Coin)
- txouts :: ![TxOutAnyEra]
- changeAddresses :: !TxOutChangeAddress
- mValue :: !(Maybe (Value, [ScriptWitnessFiles WitCtxMint]))
- mValidityLowerBound :: !(Maybe SlotNo)
- mValidityUpperBound :: !(TxValidityUpperBound era)
- certificates :: ![(CertificateFile, Maybe (ScriptWitnessFiles WitCtxStake))]
- withdrawals :: ![(StakeAddress, Coin, Maybe (ScriptWitnessFiles WitCtxStake))]
- metadataSchema :: !TxMetadataJsonSchema
- scriptFiles :: ![ScriptFile]
- metadataFiles :: ![MetadataFile]
- mUpdateProposalFile :: !(Maybe (Featured ShelleyToBabbageEra era (Maybe UpdateProposalFile)))
- voteFiles :: ![(VoteFile 'In, Maybe (ScriptWitnessFiles WitCtxStake))]
- proposalFiles :: ![(ProposalFile 'In, Maybe (ScriptWitnessFiles WitCtxStake))]
- treasuryDonation :: !(Maybe TxTreasuryDonation)
- buildOutputOptions :: !TxBuildOutputOptions
}
data TransactionBuildEstimateCmdArgs era = TransactionBuildEstimateCmdArgs {
- currentEra :: !(Era era)
- mScriptValidity :: !(Maybe ScriptValidity)
- shelleyWitnesses :: !Int
- mByronWitnesses :: !(Maybe Int)
- protocolParamsFile :: !ProtocolParamsFile
- totalUTxOValue :: !Value
- txins :: ![(TxIn, Maybe (ScriptWitnessFiles WitCtxTxIn))]
- readOnlyReferenceInputs :: ![TxIn]
- requiredSigners :: ![RequiredSigner]
- txinsc :: ![TxIn]
- mReturnCollateral :: !(Maybe TxOutShelleyBasedEra)
- txouts :: ![TxOutAnyEra]
- changeAddress :: !TxOutChangeAddress
- mValue :: !(Maybe (Value, [ScriptWitnessFiles WitCtxMint]))
- mValidityLowerBound :: !(Maybe SlotNo)
- mValidityUpperBound :: !(TxValidityUpperBound era)
- certificates :: ![(CertificateFile, Maybe (ScriptWitnessFiles WitCtxStake))]
- withdrawals :: ![(StakeAddress, Coin, Maybe (ScriptWitnessFiles WitCtxStake))]
- plutusCollateral :: !(Maybe Coin)
- totalReferenceScriptSize :: !(Maybe ReferenceScriptSize)
- metadataSchema :: !TxMetadataJsonSchema
- scriptFiles :: ![ScriptFile]
- metadataFiles :: ![MetadataFile]
- mUpdateProposalFile :: !(Maybe (Featured ShelleyToBabbageEra era (Maybe UpdateProposalFile)))
- voteFiles :: ![(VoteFile 'In, Maybe (ScriptWitnessFiles WitCtxStake))]
- proposalFiles :: ![(ProposalFile 'In, Maybe (ScriptWitnessFiles WitCtxStake))]
- currentTreasuryValueAndDonation :: !(Maybe (TxCurrentTreasuryValue, TxTreasuryDonation))
- txBodyOutFile :: !(TxBodyFile 'Out)
}
data TransactionSignCmdArgs = TransactionSignCmdArgs {
- txOrTxBodyFile :: !InputTxBodyOrTxFile
- witnessSigningData :: ![WitnessSigningData]
- mNetworkId :: !(Maybe NetworkId)
- outTxFile :: !(TxFile 'Out)
}
data TransactionWitnessCmdArgs = TransactionWitnessCmdArgs {
- txBodyFile :: !(TxBodyFile 'In)
- witnessSigningData :: !WitnessSigningData
- mNetworkId :: !(Maybe NetworkId)
- outFile :: !(File () 'Out)
}
data TransactionSignWitnessCmdArgs = TransactionSignWitnessCmdArgs {
- txBodyFile :: !(TxBodyFile 'In)
- witnessFiles :: ![WitnessFile]
- outFile :: !(File () 'Out)
}
data TransactionSubmitCmdArgs = TransactionSubmitCmdArgs {
- nodeSocketPath :: !SocketPath
- consensusModeParams :: !ConsensusModeParams
- networkId :: !NetworkId
- txFile :: !FilePath
}
newtype TransactionPolicyIdCmdArgs = TransactionPolicyIdCmdArgs {
- scriptFile :: ScriptFile
}
data TransactionCalculateMinFeeCmdArgs = TransactionCalculateMinFeeCmdArgs {
- txBodyFile :: !(TxBodyFile 'In)
- protocolParamsFile :: !ProtocolParamsFile
- txShelleyWitnessCount :: !TxShelleyWitnessCount
- txByronWitnessCount :: !TxByronWitnessCount
- referenceScriptSize :: !ReferenceScriptSize
- outputFormat :: !(Maybe OutputFormatJsonOrText)
- outFile :: !(Maybe (File () 'Out))
}
data TransactionCalculateMinValueCmdArgs era = TransactionCalculateMinValueCmdArgs {
- eon :: !(ShelleyBasedEra era)
- protocolParamsFile :: !ProtocolParamsFile
- txOut :: !TxOutShelleyBasedEra
}
newtype TransactionHashScriptDataCmdArgs = TransactionHashScriptDataCmdArgs {
- scriptDataOrFile :: ScriptDataOrFile
}
newtype TransactionTxIdCmdArgs = TransactionTxIdCmdArgs {
- inputTxBodyOrTxFile :: InputTxBodyOrTxFile
}
data TransactionViewCmdArgs = TransactionViewCmdArgs
renderTransactionCmds :: TransactionCmds era -> Text

Documentation

data TransactionBuildRawCmdArgs era Source #

Constructors

TransactionBuildRawCmdArgs

Fields

eon :: !(ShelleyBasedEra era)
mScriptValidity :: !(Maybe ScriptValidity)
Mark script as expected to pass or fail validation
txIns :: ![(TxIn, Maybe (ScriptWitnessFiles WitCtxTxIn))]
Transaction inputs with optional spending scripts
readOnlyRefIns :: ![TxIn]
Read only reference inputs
txInsCollateral :: ![TxIn]
Transaction inputs for collateral, only key witnesses, no scripts.
mReturnCollateral :: !(Maybe TxOutShelleyBasedEra)
Return collateral
mTotalCollateral :: !(Maybe Coin)
Total collateral
requiredSigners :: ![RequiredSigner]
Required signers
txouts :: ![TxOutAnyEra]
mValue :: !(Maybe (Value, [ScriptWitnessFiles WitCtxMint]))
Multi-Asset value with script witness
mValidityLowerBound :: !(Maybe SlotNo)
Transaction validity lower bound
mValidityUpperBound :: !(TxValidityUpperBound era)
Transaction validity upper bound
fee :: !Coin
Transaction fee
certificates :: ![(CertificateFile, Maybe (ScriptWitnessFiles WitCtxStake))]
Certificates with potential script witness
withdrawals :: ![(StakeAddress, Coin, Maybe (ScriptWitnessFiles WitCtxStake))]
metadataSchema :: !TxMetadataJsonSchema
scriptFiles :: ![ScriptFile]
Auxiliary scripts
metadataFiles :: ![MetadataFile]
mProtocolParamsFile :: !(Maybe ProtocolParamsFile)
mUpdateProprosalFile :: !(Maybe (Featured ShelleyToBabbageEra era (Maybe UpdateProposalFile)))
voteFiles :: ![(VoteFile 'In, Maybe (ScriptWitnessFiles WitCtxStake))]
proposalFiles :: ![(ProposalFile 'In, Maybe (ScriptWitnessFiles WitCtxStake))]
currentTreasuryValueAndDonation :: !(Maybe (TxCurrentTreasuryValue, TxTreasuryDonation))
txBodyOutFile :: !(TxBodyFile 'Out)

Instances

Instances details

Show (TransactionBuildRawCmdArgs era) Source #
Instance details Defined in Cardano.CLI.EraBased.Commands.Transaction Methods showsPrec :: Int -> TransactionBuildRawCmdArgs era -> ShowS Source # show :: TransactionBuildRawCmdArgs era -> String Source # showList :: [TransactionBuildRawCmdArgs era] -> ShowS Source #

data TransactionBuildCmdArgs era Source #

Like TransactionBuildRaw but without the fee, and with a change output.

Constructors

TransactionBuildCmdArgs

Fields

currentEra :: !(Era era)
nodeSocketPath :: !SocketPath
consensusModeParams :: !ConsensusModeParams
networkId :: !NetworkId
mScriptValidity :: !(Maybe ScriptValidity)
Mark script as expected to pass or fail validation
mOverrideWitnesses :: !(Maybe Word)
Override the required number of tx witnesses
txins :: ![(TxIn, Maybe (ScriptWitnessFiles WitCtxTxIn))]
Transaction inputs with optional spending scripts
readOnlyReferenceInputs :: ![TxIn]
Read only reference inputs
requiredSigners :: ![RequiredSigner]
Required signers
txinsc :: ![TxIn]
Transaction inputs for collateral, only key witnesses, no scripts.
mReturnCollateral :: !(Maybe TxOutShelleyBasedEra)
Return collateral
mTotalCollateral :: !(Maybe Coin)
Total collateral
txouts :: ![TxOutAnyEra]
Normal outputs
changeAddresses :: !TxOutChangeAddress
A change output
mValue :: !(Maybe (Value, [ScriptWitnessFiles WitCtxMint]))
Multi-Asset value with script witness
mValidityLowerBound :: !(Maybe SlotNo)
Transaction validity lower bound
mValidityUpperBound :: !(TxValidityUpperBound era)
Transaction validity upper bound
certificates :: ![(CertificateFile, Maybe (ScriptWitnessFiles WitCtxStake))]
Certificates with potential script witness
withdrawals :: ![(StakeAddress, Coin, Maybe (ScriptWitnessFiles WitCtxStake))]
Withdrawals with potential script witness
metadataSchema :: !TxMetadataJsonSchema
scriptFiles :: ![ScriptFile]
Auxiliary scripts
metadataFiles :: ![MetadataFile]
mUpdateProposalFile :: !(Maybe (Featured ShelleyToBabbageEra era (Maybe UpdateProposalFile)))
voteFiles :: ![(VoteFile 'In, Maybe (ScriptWitnessFiles WitCtxStake))]
proposalFiles :: ![(ProposalFile 'In, Maybe (ScriptWitnessFiles WitCtxStake))]
treasuryDonation :: !(Maybe TxTreasuryDonation)
buildOutputOptions :: !TxBuildOutputOptions

Instances

Instances details

Show (TransactionBuildCmdArgs era) Source #
Instance details Defined in Cardano.CLI.EraBased.Commands.Transaction Methods showsPrec :: Int -> TransactionBuildCmdArgs era -> ShowS Source # show :: TransactionBuildCmdArgs era -> String Source # showList :: [TransactionBuildCmdArgs era] -> ShowS Source #

data TransactionBuildEstimateCmdArgs era Source #

Like TransactionBuildCmd but does not require explicit access to a running node

Constructors

TransactionBuildEstimateCmdArgs

Fields

currentEra :: !(Era era)
mScriptValidity :: !(Maybe ScriptValidity)
Mark script as expected to pass or fail validation
shelleyWitnesses :: !Int
Number of shelley witnesses to be added
mByronWitnesses :: !(Maybe Int)
protocolParamsFile :: !ProtocolParamsFile
totalUTxOValue :: !Value
txins :: ![(TxIn, Maybe (ScriptWitnessFiles WitCtxTxIn))]
Transaction inputs with optional spending scripts
readOnlyReferenceInputs :: ![TxIn]
Read only reference inputs
requiredSigners :: ![RequiredSigner]
Required signers
txinsc :: ![TxIn]
Transaction inputs for collateral, only key witnesses, no scripts.
mReturnCollateral :: !(Maybe TxOutShelleyBasedEra)
Return collateral
txouts :: ![TxOutAnyEra]
Normal outputs
changeAddress :: !TxOutChangeAddress
A change output
mValue :: !(Maybe (Value, [ScriptWitnessFiles WitCtxMint]))
Multi-Asset value with script witness
mValidityLowerBound :: !(Maybe SlotNo)
Transaction validity lower bound
mValidityUpperBound :: !(TxValidityUpperBound era)
Transaction validity upper bound
certificates :: ![(CertificateFile, Maybe (ScriptWitnessFiles WitCtxStake))]
Certificates with potential script witness
withdrawals :: ![(StakeAddress, Coin, Maybe (ScriptWitnessFiles WitCtxStake))]
Withdrawals with potential script witness
plutusCollateral :: !(Maybe Coin)
Total collateral
totalReferenceScriptSize :: !(Maybe ReferenceScriptSize)
Size of all reference scripts in bytes
metadataSchema :: !TxMetadataJsonSchema
scriptFiles :: ![ScriptFile]
Auxiliary scripts
metadataFiles :: ![MetadataFile]
mUpdateProposalFile :: !(Maybe (Featured ShelleyToBabbageEra era (Maybe UpdateProposalFile)))
voteFiles :: ![(VoteFile 'In, Maybe (ScriptWitnessFiles WitCtxStake))]
proposalFiles :: ![(ProposalFile 'In, Maybe (ScriptWitnessFiles WitCtxStake))]
currentTreasuryValueAndDonation :: !(Maybe (TxCurrentTreasuryValue, TxTreasuryDonation))
txBodyOutFile :: !(TxBodyFile 'Out)

data TransactionSignCmdArgs Source #

Constructors

TransactionSignCmdArgs
Fields txOrTxBodyFile :: !InputTxBodyOrTxFile witnessSigningData :: ![WitnessSigningData] mNetworkId :: !(Maybe NetworkId) outTxFile :: !(TxFile 'Out)

Instances

Instances details

Show TransactionSignCmdArgs Source #
Instance details Defined in Cardano.CLI.EraBased.Commands.Transaction Methods showsPrec :: Int -> TransactionSignCmdArgs -> ShowS Source # show :: TransactionSignCmdArgs -> String Source # showList :: [TransactionSignCmdArgs] -> ShowS Source #

data TransactionWitnessCmdArgs Source #

Constructors

TransactionWitnessCmdArgs
Fields txBodyFile :: !(TxBodyFile 'In) witnessSigningData :: !WitnessSigningData mNetworkId :: !(Maybe NetworkId) outFile :: !(File () 'Out)

Instances

Instances details

Show TransactionWitnessCmdArgs Source #
Instance details Defined in Cardano.CLI.EraBased.Commands.Transaction Methods showsPrec :: Int -> TransactionWitnessCmdArgs -> ShowS Source # show :: TransactionWitnessCmdArgs -> String Source # showList :: [TransactionWitnessCmdArgs] -> ShowS Source #

data TransactionSignWitnessCmdArgs Source #

Constructors

TransactionSignWitnessCmdArgs
Fields txBodyFile :: !(TxBodyFile 'In) witnessFiles :: ![WitnessFile] outFile :: !(File () 'Out)

Instances

Instances details

Show TransactionSignWitnessCmdArgs Source #
Instance details Defined in Cardano.CLI.EraBased.Commands.Transaction Methods showsPrec :: Int -> TransactionSignWitnessCmdArgs -> ShowS Source # show :: TransactionSignWitnessCmdArgs -> String Source # showList :: [TransactionSignWitnessCmdArgs] -> ShowS Source #

data TransactionSubmitCmdArgs Source #

Constructors

TransactionSubmitCmdArgs
Fields nodeSocketPath :: !SocketPath consensusModeParams :: !ConsensusModeParams networkId :: !NetworkId txFile :: !FilePath

Instances

Instances details

Show TransactionSubmitCmdArgs Source #
Instance details Defined in Cardano.CLI.EraBased.Commands.Transaction Methods showsPrec :: Int -> TransactionSubmitCmdArgs -> ShowS Source # show :: TransactionSubmitCmdArgs -> String Source # showList :: [TransactionSubmitCmdArgs] -> ShowS Source #

newtype TransactionPolicyIdCmdArgs Source #

Constructors

TransactionPolicyIdCmdArgs
Fields scriptFile :: ScriptFile

Instances

Instances details

Show TransactionPolicyIdCmdArgs Source #
Instance details Defined in Cardano.CLI.EraBased.Commands.Transaction Methods showsPrec :: Int -> TransactionPolicyIdCmdArgs -> ShowS Source # show :: TransactionPolicyIdCmdArgs -> String Source # showList :: [TransactionPolicyIdCmdArgs] -> ShowS Source #

data TransactionCalculateMinFeeCmdArgs Source #

Constructors

TransactionCalculateMinFeeCmdArgs
Fields txBodyFile :: !(TxBodyFile 'In) protocolParamsFile :: !ProtocolParamsFile txShelleyWitnessCount :: !TxShelleyWitnessCount txByronWitnessCount :: !TxByronWitnessCount referenceScriptSize :: !ReferenceScriptSize The total size in bytes of the transaction reference scripts. outputFormat :: !(Maybe OutputFormatJsonOrText) outFile :: !(Maybe (File () 'Out))

Instances

Instances details

Show TransactionCalculateMinFeeCmdArgs Source #
Instance details Defined in Cardano.CLI.EraBased.Commands.Transaction Methods showsPrec :: Int -> TransactionCalculateMinFeeCmdArgs -> ShowS Source # show :: TransactionCalculateMinFeeCmdArgs -> String Source # showList :: [TransactionCalculateMinFeeCmdArgs] -> ShowS Source #

data TransactionCalculateMinValueCmdArgs era Source #

Constructors

TransactionCalculateMinValueCmdArgs
Fields eon :: !(ShelleyBasedEra era) protocolParamsFile :: !ProtocolParamsFile txOut :: !TxOutShelleyBasedEra

Instances

Instances details

Show (TransactionCalculateMinValueCmdArgs era) Source #
Instance details Defined in Cardano.CLI.EraBased.Commands.Transaction Methods showsPrec :: Int -> TransactionCalculateMinValueCmdArgs era -> ShowS Source # show :: TransactionCalculateMinValueCmdArgs era -> String Source # showList :: [TransactionCalculateMinValueCmdArgs era] -> ShowS Source #

newtype TransactionHashScriptDataCmdArgs Source #

Constructors

TransactionHashScriptDataCmdArgs
Fields scriptDataOrFile :: ScriptDataOrFile

Instances

Instances details

Show TransactionHashScriptDataCmdArgs Source #
Instance details Defined in Cardano.CLI.EraBased.Commands.Transaction Methods showsPrec :: Int -> TransactionHashScriptDataCmdArgs -> ShowS Source # show :: TransactionHashScriptDataCmdArgs -> String Source # showList :: [TransactionHashScriptDataCmdArgs] -> ShowS Source #

newtype TransactionTxIdCmdArgs Source #

Constructors

TransactionTxIdCmdArgs
Fields inputTxBodyOrTxFile :: InputTxBodyOrTxFile

Instances

Instances details

Show TransactionTxIdCmdArgs Source #
Instance details Defined in Cardano.CLI.EraBased.Commands.Transaction Methods showsPrec :: Int -> TransactionTxIdCmdArgs -> ShowS Source # show :: TransactionTxIdCmdArgs -> String Source # showList :: [TransactionTxIdCmdArgs] -> ShowS Source #

data TransactionViewCmdArgs Source #

Constructors

TransactionViewCmdArgs

Instances

Instances details

Show TransactionViewCmdArgs Source #
Instance details Defined in Cardano.CLI.EraBased.Commands.Transaction Methods showsPrec :: Int -> TransactionViewCmdArgs -> ShowS Source # show :: TransactionViewCmdArgs -> String Source # showList :: [TransactionViewCmdArgs] -> ShowS Source #

renderTransactionCmds :: TransactionCmds era -> Text Source #

TransactionBuildRawCmd !(TransactionBuildRawCmdArgs era)
TransactionBuildCmd !(TransactionBuildCmdArgs era)
TransactionBuildEstimateCmd !(TransactionBuildEstimateCmdArgs era)
TransactionSignCmd !TransactionSignCmdArgs
TransactionWitnessCmd !TransactionWitnessCmdArgs
TransactionSignWitnessCmd !TransactionSignWitnessCmdArgs
TransactionSubmitCmd !TransactionSubmitCmdArgs
TransactionPolicyIdCmd !TransactionPolicyIdCmdArgs
TransactionCalculateMinFeeCmd !TransactionCalculateMinFeeCmdArgs
TransactionCalculateMinValueCmd !(TransactionCalculateMinValueCmdArgs era)
TransactionHashScriptDataCmd !TransactionHashScriptDataCmdArgs
TransactionTxIdCmd !TransactionTxIdCmdArgs