| Safe Haskell | None |
|---|---|
| Language | Haskell2010 |
Cardano.CLI.EraBased.Transaction.Command
Synopsis
- data MustExtendSafeZone
- data NodeContextInfoSource era
- data SystemStartOrGenesisFileSource
- data TransactionBuildCmdArgs era = TransactionBuildCmdArgs {
- currentEra :: !(Era era)
- nodeConnInfo :: !LocalNodeConnectInfo
- mScriptValidity :: !(Maybe ScriptValidity)
- mOverrideWitnesses :: !(Maybe Word)
- txins :: ![(TxIn, Maybe (ScriptRequirements 'TxInItem))]
- readOnlyReferenceInputs :: ![TxIn]
- requiredSigners :: ![RequiredSigner]
- txinsc :: ![TxIn]
- mReturnCollateral :: !(Maybe TxOutShelleyBasedEra)
- mTotalCollateral :: !(Maybe Coin)
- txouts :: ![TxOutAnyEra]
- changeAddresses :: !TxOutChangeAddress
- mMintedAssets :: !(Maybe (MultiAsset, [ScriptRequirements 'MintItem]))
- mValidityLowerBound :: !(Maybe SlotNo)
- mValidityUpperBound :: !(TxValidityUpperBound era)
- certificates :: ![(CertificateFile, Maybe (ScriptRequirements 'CertItem))]
- withdrawals :: ![(StakeAddress, Coin, Maybe (ScriptRequirements 'WithdrawalItem))]
- metadataSchema :: !TxMetadataJsonSchema
- scriptFiles :: ![ScriptFile]
- metadataFiles :: ![MetadataFile]
- mUpdateProposalFile :: !(Maybe (Featured ShelleyToBabbageEra era (Maybe UpdateProposalFile)))
- voteFiles :: ![(VoteFile 'In, Maybe (ScriptRequirements 'VoterItem))]
- proposalFiles :: ![(ProposalFile 'In, Maybe (ScriptRequirements 'ProposalItem))]
- treasuryDonation :: !(Maybe TxTreasuryDonation)
- isCborOutCanonical :: !TxCborFormat
- buildOutputOptions :: !TxBuildOutputOptions
- data TransactionBuildEstimateCmdArgs era = TransactionBuildEstimateCmdArgs {
- currentEra :: !(Era era)
- mScriptValidity :: !(Maybe ScriptValidity)
- shelleyWitnesses :: !Int
- mByronWitnesses :: !(Maybe Int)
- protocolParamsFile :: !ProtocolParamsFile
- totalUTxOValue :: !Value
- txins :: ![(TxIn, Maybe (ScriptRequirements 'TxInItem))]
- readOnlyReferenceInputs :: ![TxIn]
- requiredSigners :: ![RequiredSigner]
- txinsc :: ![TxIn]
- mReturnCollateral :: !(Maybe TxOutShelleyBasedEra)
- txouts :: ![TxOutAnyEra]
- changeAddress :: !TxOutChangeAddress
- mMintedAssets :: !(Maybe (MultiAsset, [ScriptRequirements 'MintItem]))
- mValidityLowerBound :: !(Maybe SlotNo)
- mValidityUpperBound :: !(TxValidityUpperBound era)
- certificates :: ![(CertificateFile, Maybe (ScriptRequirements 'CertItem))]
- withdrawals :: ![(StakeAddress, Coin, Maybe (ScriptRequirements 'WithdrawalItem))]
- plutusCollateral :: !(Maybe Coin)
- totalReferenceScriptSize :: !(Maybe ReferenceScriptSize)
- metadataSchema :: !TxMetadataJsonSchema
- scriptFiles :: ![ScriptFile]
- metadataFiles :: ![MetadataFile]
- voteFiles :: ![(VoteFile 'In, Maybe (ScriptRequirements 'VoterItem))]
- proposalFiles :: ![(ProposalFile 'In, Maybe (ScriptRequirements 'ProposalItem))]
- currentTreasuryValueAndDonation :: !(Maybe (TxCurrentTreasuryValue, TxTreasuryDonation))
- isCborOutCanonical :: !TxCborFormat
- txBodyOutFile :: !(TxBodyFile 'Out)
- data TransactionBuildRawCmdArgs era = TransactionBuildRawCmdArgs {
- eon :: !(Era era)
- mScriptValidity :: !(Maybe ScriptValidity)
- txIns :: ![(TxIn, Maybe (ScriptRequirements 'TxInItem))]
- readOnlyRefIns :: ![TxIn]
- txInsCollateral :: ![TxIn]
- mReturnCollateral :: !(Maybe TxOutShelleyBasedEra)
- mTotalCollateral :: !(Maybe Coin)
- requiredSigners :: ![RequiredSigner]
- txouts :: ![TxOutAnyEra]
- mMintedAssets :: !(Maybe (MultiAsset, [ScriptRequirements 'MintItem]))
- mValidityLowerBound :: !(Maybe SlotNo)
- mValidityUpperBound :: !(TxValidityUpperBound era)
- fee :: !Coin
- certificates :: ![(CertificateFile, Maybe (ScriptRequirements 'CertItem))]
- withdrawals :: ![(StakeAddress, Coin, Maybe (ScriptRequirements 'WithdrawalItem))]
- metadataSchema :: !TxMetadataJsonSchema
- scriptFiles :: ![ScriptFile]
- metadataFiles :: ![MetadataFile]
- mProtocolParamsFile :: !(Maybe ProtocolParamsFile)
- mUpdateProprosalFile :: !(Maybe (Featured ShelleyToBabbageEra era (Maybe UpdateProposalFile)))
- voteFiles :: ![(VoteFile 'In, Maybe (ScriptRequirements 'VoterItem))]
- proposalFiles :: ![(ProposalFile 'In, Maybe (ScriptRequirements 'ProposalItem))]
- currentTreasuryValueAndDonation :: !(Maybe (TxCurrentTreasuryValue, TxTreasuryDonation))
- isCborOutCanonical :: !TxCborFormat
- txBodyOutFile :: !(TxBodyFile 'Out)
- data TransactionCalculateMinFeeCmdArgs = TransactionCalculateMinFeeCmdArgs {
- txBodyFile :: !(TxBodyFile 'In)
- protocolParamsFile :: !ProtocolParamsFile
- txShelleyWitnessCount :: !TxShelleyWitnessCount
- txByronWitnessCount :: !TxByronWitnessCount
- referenceScriptSize :: !ReferenceScriptSize
- outputFormat :: !(Vary '[FormatJson, FormatText, FormatYaml])
- outFile :: !(Maybe (File () 'Out))
- data TransactionCalculateMinValueCmdArgs era = TransactionCalculateMinValueCmdArgs {
- era :: !(Era era)
- protocolParamsFile :: !ProtocolParamsFile
- txOut :: !TxOutShelleyBasedEra
- data TransactionCalculatePlutusScriptCostCmdArgs era = TransactionCalculatePlutusScriptCostCmdArgs {
- nodeContextInfoSource :: !(NodeContextInfoSource era)
- txFileIn :: FilePath
- outputFile :: !(Maybe (File () 'Out))
- data TransactionCmds era
- = TransactionBuildRawCmd !(TransactionBuildRawCmdArgs era)
- | TransactionBuildCmd !(TransactionBuildCmdArgs era)
- | TransactionBuildEstimateCmd !(TransactionBuildEstimateCmdArgs era)
- | TransactionSignCmd !TransactionSignCmdArgs
- | TransactionWitnessCmd !TransactionWitnessCmdArgs
- | TransactionSignWitnessCmd !TransactionSignWitnessCmdArgs
- | TransactionSubmitCmd !TransactionSubmitCmdArgs
- | TransactionPolicyIdCmd !TransactionPolicyIdCmdArgs
- | TransactionCalculateMinFeeCmd !TransactionCalculateMinFeeCmdArgs
- | TransactionCalculateMinValueCmd !(TransactionCalculateMinValueCmdArgs era)
- | TransactionCalculatePlutusScriptCostCmd !(TransactionCalculatePlutusScriptCostCmdArgs era)
- | TransactionHashScriptDataCmd !TransactionHashScriptDataCmdArgs
- | TransactionTxIdCmd !TransactionTxIdCmdArgs
- data TransactionContext era = TransactionContext {}
- newtype TransactionHashScriptDataCmdArgs = TransactionHashScriptDataCmdArgs {}
- newtype TransactionPolicyIdCmdArgs = TransactionPolicyIdCmdArgs {}
- data TransactionSignCmdArgs = TransactionSignCmdArgs {}
- data TransactionSignWitnessCmdArgs = TransactionSignWitnessCmdArgs {
- txBodyFile :: !(TxBodyFile 'In)
- witnessFiles :: ![WitnessFile]
- isCborOutCanonical :: !TxCborFormat
- outFile :: !(File () 'Out)
- data TransactionSubmitCmdArgs = TransactionSubmitCmdArgs {}
- data TransactionTxIdCmdArgs = TransactionTxIdCmdArgs {
- inputTxBodyOrTxFile :: InputTxBodyOrTxFile
- outputFormat :: !(Vary '[FormatJson, FormatText, FormatYaml])
- data TransactionViewCmdArgs = TransactionViewCmdArgs
- data TransactionWitnessCmdArgs = TransactionWitnessCmdArgs {
- txBodyFile :: !(TxBodyFile 'In)
- witnessSigningData :: !WitnessSigningData
- mNetworkId :: !(Maybe NetworkId)
- outFile :: !(File () 'Out)
- data TxCborFormat
- renderTransactionCmds :: TransactionCmds era -> Text
Documentation
data MustExtendSafeZone Source #
Allow overriding the validity of the era history past the safe zone. The safe zone is a period of time during which we are sure there won't be any era transition (hard fork), and we are confident that the slot duration will not change, thus the conversion from slot numbers to POSIX times using the era history will be correct.
This safe zone is conservative. Even if we are past the safe zone, if there hasn't been any era transition (hard fork) since we obtained it, we can continue safely using the era history.
MustExtendSafeZone essentially disables the safe zone check. This allows the user to
use the era history past the safe zone, at the user's discretion.
Constructors
| MustExtendSafeZone | |
| DoNotExtendSafeZone |
data NodeContextInfoSource era Source #
Either information about the context in which the transaction command is run, or information required to obtain it (information to connect to the node).
Constructors
| NodeConnectionInfo !LocalNodeConnectInfo | |
| ProvidedTransactionContextInfo !(TransactionContext era) |
data SystemStartOrGenesisFileSource Source #
The system start time or the genesis file from which to get it
Constructors
| SystemStartLiteral !SystemStart | |
| SystemStartFromGenesisFile !GenesisFile |
data TransactionBuildCmdArgs era Source #
Like TransactionBuildRaw but without the fee, and with a change output.
Constructors
Instances
| Show (TransactionBuildCmdArgs era) Source # | |
Defined in Cardano.CLI.EraBased.Transaction.Command | |
data TransactionBuildEstimateCmdArgs era Source #
Like TransactionBuildCmd but does not require explicit access to a running node
Constructors
data TransactionBuildRawCmdArgs era Source #
Constructors
Instances
| Show (TransactionBuildRawCmdArgs era) Source # | |
Defined in Cardano.CLI.EraBased.Transaction.Command | |
data TransactionCalculateMinFeeCmdArgs Source #
Constructors
| TransactionCalculateMinFeeCmdArgs | |
Fields
| |
Instances
data TransactionCalculateMinValueCmdArgs era Source #
Constructors
| TransactionCalculateMinValueCmdArgs | |
Fields
| |
Instances
data TransactionCalculatePlutusScriptCostCmdArgs era Source #
Constructors
| TransactionCalculatePlutusScriptCostCmdArgs | |
Fields
| |
data TransactionCmds era Source #
Constructors
data TransactionContext era Source #
Transaction context, required to evaluate the execution costs of the plutus scripts in the transaction.
Constructors
| TransactionContext | |
newtype TransactionHashScriptDataCmdArgs Source #
Constructors
| TransactionHashScriptDataCmdArgs | |
Fields | |
Instances
newtype TransactionPolicyIdCmdArgs Source #
Constructors
| TransactionPolicyIdCmdArgs | |
Fields | |
Instances
data TransactionSignCmdArgs Source #
Constructors
| TransactionSignCmdArgs | |
Fields
| |
Instances
data TransactionSignWitnessCmdArgs Source #
Constructors
| TransactionSignWitnessCmdArgs | |
Fields
| |
Instances
data TransactionSubmitCmdArgs Source #
Constructors
| TransactionSubmitCmdArgs | |
Fields | |
Instances
data TransactionTxIdCmdArgs Source #
Constructors
| TransactionTxIdCmdArgs | |
Fields
| |
Instances
data TransactionViewCmdArgs Source #
Constructors
| TransactionViewCmdArgs |
Instances
data TransactionWitnessCmdArgs Source #
Constructors
| TransactionWitnessCmdArgs | |
Fields
| |
Instances
data TxCborFormat Source #
Whether output transaction is in CBOR canonical format according to RFC7049 section 3.9.
Constructors
| TxCborCanonical | |
| TxCborNotCanonical |
Instances
| Show TxCborFormat Source # | |
Defined in Cardano.CLI.EraBased.Transaction.Command | |
| Eq TxCborFormat Source # | |
Defined in Cardano.CLI.EraBased.Transaction.Command Methods (==) :: TxCborFormat -> TxCborFormat -> Bool Source # (/=) :: TxCborFormat -> TxCborFormat -> Bool Source # | |
renderTransactionCmds :: TransactionCmds era -> Text Source #