Safe Haskell | Safe-Inferred |
---|---|
Language | Haskell2010 |
Cardano.CLI.Types
Synopsis
- data BalanceTxExecUnits
- data CBORObject
- newtype CertificateFile = CertificateFile {}
- newtype CurrentKesPeriod = CurrentKesPeriod {}
- data EpochLeadershipSchedule
- newtype GenesisFile = GenesisFile {}
- newtype OpCertEndingKesPeriod = OpCertEndingKesPeriod {}
- data OpCertIntervalInformation
- = OpCertWithinInterval OpCertStartingKesPeriod OpCertEndingKesPeriod CurrentKesPeriod SlotsTillKesKeyExpiry
- | OpCertStartingKesPeriodIsInTheFuture OpCertStartingKesPeriod OpCertEndingKesPeriod CurrentKesPeriod
- | OpCertExpired OpCertStartingKesPeriod OpCertEndingKesPeriod CurrentKesPeriod
- | OpCertSomeOtherError OpCertStartingKesPeriod OpCertEndingKesPeriod CurrentKesPeriod
- newtype OpCertOnDiskCounter = OpCertOnDiskCounter {}
- data OpCertNodeAndOnDiskCounterInformation
- = OpCertOnDiskCounterEqualToNodeState OpCertOnDiskCounter OpCertNodeStateCounter
- | OpCertOnDiskCounterAheadOfNodeState OpCertOnDiskCounter OpCertNodeStateCounter
- | OpCertOnDiskCounterTooFarAheadOfNodeState OpCertOnDiskCounter OpCertNodeStateCounter
- | OpCertOnDiskCounterBehindNodeState OpCertOnDiskCounter OpCertNodeStateCounter
- | OpCertNoBlocksMintedYet OpCertOnDiskCounter
- newtype OpCertNodeStateCounter = OpCertNodeStateCounter {}
- newtype OpCertStartingKesPeriod = OpCertStartingKesPeriod {}
- data OutputFormat
- data TxBuildOutputOptions
- data ReferenceScriptAnyEra
- newtype SigningKeyFile = SigningKeyFile {}
- newtype ScriptFile = ScriptFile {}
- data ScriptDataOrFile
- type ScriptRedeemerOrFile = ScriptDataOrFile
- data ScriptWitnessFiles witctx where
- SimpleScriptWitnessFile ∷ ScriptFile → ScriptWitnessFiles witctx
- PlutusScriptWitnessFiles ∷ ScriptFile → ScriptDatumOrFile witctx → ScriptRedeemerOrFile → ExecutionUnits → ScriptWitnessFiles witctx
- PlutusReferenceScriptWitnessFiles ∷ TxIn → AnyScriptLanguage → ScriptDatumOrFile witctx → ScriptRedeemerOrFile → ExecutionUnits → Maybe PolicyId → ScriptWitnessFiles witctx
- SimpleReferenceScriptWitnessFiles ∷ TxIn → AnyScriptLanguage → Maybe PolicyId → ScriptWitnessFiles witctx
- data ScriptDatumOrFile witctx where
- newtype SlotsTillKesKeyExpiry = SlotsTillKesKeyExpiry {}
- data TransferDirection
- newtype TxBodyFile = TxBodyFile FilePath
- data TxOutAnyEra = TxOutAnyEra AddressAny Value TxOutDatumAnyEra ReferenceScriptAnyEra
- newtype TxOutChangeAddress = TxOutChangeAddress AddressAny
- data TxOutDatumAnyEra
- newtype TxFile = TxFile FilePath
- data TxMempoolQuery
- newtype UpdateProposalFile = UpdateProposalFile {}
- newtype VerificationKeyFile = VerificationKeyFile {}
- data Params crypto = Params {
- poolParameters ∷ Maybe (PoolParams crypto)
- futurePoolParameters ∷ Maybe (PoolParams crypto)
- retiringEpoch ∷ Maybe EpochNo
- data RequiredSigner
- data AllOrOnly a
Documentation
data BalanceTxExecUnits Source #
A flag that differentiates between automatically and manually balancing a tx.
Constructors
AutoBalance | |
ManualBalance |
data CBORObject Source #
Specify what the CBOR file is i.e a block, a tx, etc
Constructors
CBORBlockByron EpochSlots | |
CBORDelegationCertificateByron | |
CBORTxByron | |
CBORUpdateProposalByron | |
CBORVoteByron |
Instances
Show CBORObject Source # | |
Defined in Cardano.CLI.Types |
newtype CertificateFile Source #
Constructors
CertificateFile | |
Fields |
Instances
Show CertificateFile Source # | |
Defined in Cardano.CLI.Types | |
Eq CertificateFile Source # | |
Defined in Cardano.CLI.Types Methods |
newtype CurrentKesPeriod Source #
Constructors
CurrentKesPeriod | |
Fields |
Instances
FromJSON CurrentKesPeriod Source # | |
Defined in Cardano.CLI.Types Methods parseJSON ∷ Value → Parser CurrentKesPeriod # parseJSONList ∷ Value → Parser [CurrentKesPeriod] # | |
ToJSON CurrentKesPeriod Source # | |
Defined in Cardano.CLI.Types Methods toJSON ∷ CurrentKesPeriod → Value # toEncoding ∷ CurrentKesPeriod → Encoding # toJSONList ∷ [CurrentKesPeriod] → Value # toEncodingList ∷ [CurrentKesPeriod] → Encoding # | |
Show CurrentKesPeriod Source # | |
Defined in Cardano.CLI.Types | |
Eq CurrentKesPeriod Source # | |
Defined in Cardano.CLI.Types Methods |
data EpochLeadershipSchedule Source #
Which leadership schedule we are interested in. TODO: Implement Previous and Next epochs
Constructors
CurrentEpoch | |
NextEpoch |
Instances
Show EpochLeadershipSchedule Source # | |
Defined in Cardano.CLI.Types |
newtype GenesisFile Source #
Constructors
GenesisFile | |
Fields |
Instances
FromJSON GenesisFile Source # | |
Defined in Cardano.CLI.Types | |
IsString GenesisFile Source # | |
Defined in Cardano.CLI.Types Methods | |
Show GenesisFile Source # | |
Defined in Cardano.CLI.Types | |
Eq GenesisFile Source # | |
Defined in Cardano.CLI.Types Methods (==) ∷ GenesisFile → GenesisFile → Bool Source # (/=) ∷ GenesisFile → GenesisFile → Bool Source # | |
Ord GenesisFile Source # | |
Defined in Cardano.CLI.Types Methods compare ∷ GenesisFile → GenesisFile → Ordering Source # (<) ∷ GenesisFile → GenesisFile → Bool Source # (<=) ∷ GenesisFile → GenesisFile → Bool Source # (>) ∷ GenesisFile → GenesisFile → Bool Source # (>=) ∷ GenesisFile → GenesisFile → Bool Source # max ∷ GenesisFile → GenesisFile → GenesisFile Source # min ∷ GenesisFile → GenesisFile → GenesisFile Source # |
newtype OpCertEndingKesPeriod Source #
Constructors
OpCertEndingKesPeriod | |
Fields |
Instances
FromJSON OpCertEndingKesPeriod Source # | |
Defined in Cardano.CLI.Types Methods parseJSON ∷ Value → Parser OpCertEndingKesPeriod # parseJSONList ∷ Value → Parser [OpCertEndingKesPeriod] # | |
ToJSON OpCertEndingKesPeriod Source # | |
Defined in Cardano.CLI.Types Methods toJSON ∷ OpCertEndingKesPeriod → Value # toEncoding ∷ OpCertEndingKesPeriod → Encoding # toJSONList ∷ [OpCertEndingKesPeriod] → Value # toEncodingList ∷ [OpCertEndingKesPeriod] → Encoding # | |
Show OpCertEndingKesPeriod Source # | |
Defined in Cardano.CLI.Types | |
Eq OpCertEndingKesPeriod Source # | |
Defined in Cardano.CLI.Types Methods (==) ∷ OpCertEndingKesPeriod → OpCertEndingKesPeriod → Bool Source # (/=) ∷ OpCertEndingKesPeriod → OpCertEndingKesPeriod → Bool Source # |
data OpCertIntervalInformation Source #
Constructors
Instances
Show OpCertIntervalInformation Source # | |
Defined in Cardano.CLI.Types | |
Eq OpCertIntervalInformation Source # | |
Defined in Cardano.CLI.Types |
newtype OpCertOnDiskCounter Source #
Constructors
OpCertOnDiskCounter | |
Fields |
Instances
FromJSON OpCertOnDiskCounter Source # | |
Defined in Cardano.CLI.Types Methods parseJSON ∷ Value → Parser OpCertOnDiskCounter # parseJSONList ∷ Value → Parser [OpCertOnDiskCounter] # | |
ToJSON OpCertOnDiskCounter Source # | |
Defined in Cardano.CLI.Types Methods toJSON ∷ OpCertOnDiskCounter → Value # toEncoding ∷ OpCertOnDiskCounter → Encoding # toJSONList ∷ [OpCertOnDiskCounter] → Value # toEncodingList ∷ [OpCertOnDiskCounter] → Encoding # | |
Show OpCertOnDiskCounter Source # | |
Defined in Cardano.CLI.Types | |
Eq OpCertOnDiskCounter Source # | |
Defined in Cardano.CLI.Types Methods (==) ∷ OpCertOnDiskCounter → OpCertOnDiskCounter → Bool Source # (/=) ∷ OpCertOnDiskCounter → OpCertOnDiskCounter → Bool Source # |
data OpCertNodeAndOnDiskCounterInformation Source #
Constructors
OpCertOnDiskCounterEqualToNodeState OpCertOnDiskCounter OpCertNodeStateCounter | The on disk operational certificate has a counter that is equal to its corresponding counter in the node state. The on disk operational certificate therefore has a valid counter. |
OpCertOnDiskCounterAheadOfNodeState OpCertOnDiskCounter OpCertNodeStateCounter | The on disk operational certificate has a counter that is ahead of the counter in the node state by 1. The on disk operational certificate is invalid in this case. |
OpCertOnDiskCounterTooFarAheadOfNodeState OpCertOnDiskCounter OpCertNodeStateCounter | The on disk operational certificate has a counter that is less than the counter in the node state. The on disk operational certificate is invalid in this case. |
OpCertOnDiskCounterBehindNodeState OpCertOnDiskCounter OpCertNodeStateCounter | The corresponding counter for operational certificate was not found in the node state. This means the relevant stake pool has not minted a block yet. When the stake pool has minted a block the corresponding operational certificate's counter will be present in the node state. |
OpCertNoBlocksMintedYet OpCertOnDiskCounter | The on disk operational certificate has a counter that is ahead of the counter in the node state by more than 1. The on disk operational certificate is invalid in this case. |
Instances
newtype OpCertNodeStateCounter Source #
Constructors
OpCertNodeStateCounter | |
Fields |
Instances
FromJSON OpCertNodeStateCounter Source # | |
Defined in Cardano.CLI.Types Methods parseJSON ∷ Value → Parser OpCertNodeStateCounter # parseJSONList ∷ Value → Parser [OpCertNodeStateCounter] # | |
ToJSON OpCertNodeStateCounter Source # | |
Defined in Cardano.CLI.Types Methods toJSON ∷ OpCertNodeStateCounter → Value # toEncoding ∷ OpCertNodeStateCounter → Encoding # toJSONList ∷ [OpCertNodeStateCounter] → Value # toEncodingList ∷ [OpCertNodeStateCounter] → Encoding # | |
Show OpCertNodeStateCounter Source # | |
Defined in Cardano.CLI.Types | |
Eq OpCertNodeStateCounter Source # | |
Defined in Cardano.CLI.Types |
newtype OpCertStartingKesPeriod Source #
Constructors
OpCertStartingKesPeriod | |
Fields |
Instances
FromJSON OpCertStartingKesPeriod Source # | |
Defined in Cardano.CLI.Types Methods parseJSON ∷ Value → Parser OpCertStartingKesPeriod # parseJSONList ∷ Value → Parser [OpCertStartingKesPeriod] # | |
ToJSON OpCertStartingKesPeriod Source # | |
Defined in Cardano.CLI.Types Methods toJSON ∷ OpCertStartingKesPeriod → Value # toEncoding ∷ OpCertStartingKesPeriod → Encoding # toJSONList ∷ [OpCertStartingKesPeriod] → Value # toEncodingList ∷ [OpCertStartingKesPeriod] → Encoding # | |
Show OpCertStartingKesPeriod Source # | |
Defined in Cardano.CLI.Types | |
Eq OpCertStartingKesPeriod Source # | |
Defined in Cardano.CLI.Types |
data OutputFormat Source #
The desired output format.
Constructors
OutputFormatHex | |
OutputFormatBech32 |
Instances
Show OutputFormat Source # | |
Defined in Cardano.CLI.Types | |
Eq OutputFormat Source # | |
Defined in Cardano.CLI.Types Methods (==) ∷ OutputFormat → OutputFormat → Bool Source # (/=) ∷ OutputFormat → OutputFormat → Bool Source # |
data TxBuildOutputOptions Source #
Specify whether to render the script cost as JSON in the cli's build command.
Constructors
OutputScriptCostOnly FilePath | |
OutputTxBodyOnly TxBodyFile |
Instances
Show TxBuildOutputOptions Source # | |
Defined in Cardano.CLI.Types |
data ReferenceScriptAnyEra Source #
Constructors
ReferenceScriptAnyEraNone | |
ReferenceScriptAnyEra FilePath |
Instances
Show ReferenceScriptAnyEra Source # | |
Defined in Cardano.CLI.Types | |
Eq ReferenceScriptAnyEra Source # | |
Defined in Cardano.CLI.Types Methods (==) ∷ ReferenceScriptAnyEra → ReferenceScriptAnyEra → Bool Source # (/=) ∷ ReferenceScriptAnyEra → ReferenceScriptAnyEra → Bool Source # |
newtype SigningKeyFile Source #
Constructors
SigningKeyFile | |
Fields |
Instances
IsString SigningKeyFile Source # | |
Defined in Cardano.CLI.Types Methods | |
Show SigningKeyFile Source # | |
Defined in Cardano.CLI.Types | |
Eq SigningKeyFile Source # | |
Defined in Cardano.CLI.Types Methods (==) ∷ SigningKeyFile → SigningKeyFile → Bool Source # (/=) ∷ SigningKeyFile → SigningKeyFile → Bool Source # | |
Ord SigningKeyFile Source # | |
Defined in Cardano.CLI.Types Methods compare ∷ SigningKeyFile → SigningKeyFile → Ordering Source # (<) ∷ SigningKeyFile → SigningKeyFile → Bool Source # (<=) ∷ SigningKeyFile → SigningKeyFile → Bool Source # (>) ∷ SigningKeyFile → SigningKeyFile → Bool Source # (>=) ∷ SigningKeyFile → SigningKeyFile → Bool Source # max ∷ SigningKeyFile → SigningKeyFile → SigningKeyFile Source # min ∷ SigningKeyFile → SigningKeyFile → SigningKeyFile Source # |
newtype ScriptFile Source #
Constructors
ScriptFile | |
Fields |
Instances
Show ScriptFile Source # | |
Defined in Cardano.CLI.Types | |
Eq ScriptFile Source # | |
Defined in Cardano.CLI.Types |
data ScriptDataOrFile Source #
Constructors
ScriptDataCborFile FilePath | By reference to a CBOR file |
ScriptDataJsonFile FilePath | By reference to a JSON file |
ScriptDataValue HashableScriptData | By value |
Instances
Show ScriptDataOrFile Source # | |
Defined in Cardano.CLI.Types | |
Eq ScriptDataOrFile Source # | |
Defined in Cardano.CLI.Types Methods |
data ScriptWitnessFiles witctx where Source #
This type is like ScriptWitness
, but the file paths from which to load
the script witness data representation.
It is era-independent, but witness context-dependent.
Constructors
SimpleScriptWitnessFile ∷ ScriptFile → ScriptWitnessFiles witctx | |
PlutusScriptWitnessFiles ∷ ScriptFile → ScriptDatumOrFile witctx → ScriptRedeemerOrFile → ExecutionUnits → ScriptWitnessFiles witctx | |
PlutusReferenceScriptWitnessFiles | |
Fields
| |
SimpleReferenceScriptWitnessFiles | |
Fields
|
Instances
Show (ScriptWitnessFiles witctx) Source # | |
Defined in Cardano.CLI.Types |
data ScriptDatumOrFile witctx where Source #
Constructors
Instances
Show (ScriptDatumOrFile witctx) Source # | |
Defined in Cardano.CLI.Types |
newtype SlotsTillKesKeyExpiry Source #
Constructors
SlotsTillKesKeyExpiry | |
Fields |
Instances
FromJSON SlotsTillKesKeyExpiry Source # | |
Defined in Cardano.CLI.Types Methods parseJSON ∷ Value → Parser SlotsTillKesKeyExpiry # parseJSONList ∷ Value → Parser [SlotsTillKesKeyExpiry] # | |
ToJSON SlotsTillKesKeyExpiry Source # | |
Defined in Cardano.CLI.Types Methods toJSON ∷ SlotsTillKesKeyExpiry → Value # toEncoding ∷ SlotsTillKesKeyExpiry → Encoding # toJSONList ∷ [SlotsTillKesKeyExpiry] → Value # toEncodingList ∷ [SlotsTillKesKeyExpiry] → Encoding # | |
Show SlotsTillKesKeyExpiry Source # | |
Defined in Cardano.CLI.Types | |
Eq SlotsTillKesKeyExpiry Source # | |
Defined in Cardano.CLI.Types Methods (==) ∷ SlotsTillKesKeyExpiry → SlotsTillKesKeyExpiry → Bool Source # (/=) ∷ SlotsTillKesKeyExpiry → SlotsTillKesKeyExpiry → Bool Source # |
data TransferDirection Source #
Determines the direction in which the MIR certificate will transfer ADA.
Constructors
TransferToReserves | |
TransferToTreasury |
Instances
Show TransferDirection Source # | |
Defined in Cardano.CLI.Types |
newtype TxBodyFile Source #
Constructors
TxBodyFile FilePath |
Instances
Show TxBodyFile Source # | |
Defined in Cardano.CLI.Types |
data TxOutAnyEra Source #
A TxOut value that is the superset of possibilities for any era: any
address type and allowing multi-asset values. This is used as the type for
values passed on the command line. It can be converted into the
era-dependent TxOutValue
type.
Constructors
TxOutAnyEra AddressAny Value TxOutDatumAnyEra ReferenceScriptAnyEra |
Instances
Show TxOutAnyEra Source # | |
Defined in Cardano.CLI.Types | |
Eq TxOutAnyEra Source # | |
Defined in Cardano.CLI.Types Methods (==) ∷ TxOutAnyEra → TxOutAnyEra → Bool Source # (/=) ∷ TxOutAnyEra → TxOutAnyEra → Bool Source # |
newtype TxOutChangeAddress Source #
A partially-specified transaction output indented to use as a change output.
It does not specify a value, since this will be worked out automatically.
It does not use any script data hash, since that's generally not used for change outputs.
Constructors
TxOutChangeAddress AddressAny |
Instances
Show TxOutChangeAddress Source # | |
Defined in Cardano.CLI.Types | |
Eq TxOutChangeAddress Source # | |
Defined in Cardano.CLI.Types Methods (==) ∷ TxOutChangeAddress → TxOutChangeAddress → Bool Source # (/=) ∷ TxOutChangeAddress → TxOutChangeAddress → Bool Source # |
data TxOutDatumAnyEra Source #
Constructors
TxOutDatumByHashOnly (Hash ScriptData) | |
TxOutDatumByHashOf ScriptDataOrFile | |
TxOutDatumByValue ScriptDataOrFile | |
TxOutInlineDatumByValue ScriptDataOrFile | |
TxOutDatumByNone |
Instances
Show TxOutDatumAnyEra Source # | |
Defined in Cardano.CLI.Types | |
Eq TxOutDatumAnyEra Source # | |
Defined in Cardano.CLI.Types Methods |
data TxMempoolQuery Source #
Instances
Show TxMempoolQuery Source # | |
Defined in Cardano.CLI.Types |
newtype UpdateProposalFile Source #
Constructors
UpdateProposalFile | |
Fields |
Instances
Show UpdateProposalFile Source # | |
Defined in Cardano.CLI.Types | |
Eq UpdateProposalFile Source # | |
Defined in Cardano.CLI.Types Methods (==) ∷ UpdateProposalFile → UpdateProposalFile → Bool Source # (/=) ∷ UpdateProposalFile → UpdateProposalFile → Bool Source # |
newtype VerificationKeyFile Source #
Constructors
VerificationKeyFile | |
Fields |
Instances
Show VerificationKeyFile Source # | |
Defined in Cardano.CLI.Types | |
Eq VerificationKeyFile Source # | |
Defined in Cardano.CLI.Types Methods (==) ∷ VerificationKeyFile → VerificationKeyFile → Bool Source # (/=) ∷ VerificationKeyFile → VerificationKeyFile → Bool Source # |
This data structure is used to allow nicely formatted output in the query pool-params command. params are the current pool parameter settings, futureparams are new parameters, retiringEpoch is the epoch that has been set for pool retirement. Any of these may be Nothing.
Constructors
Params | |
Fields
|
Instances
Crypto crypto ⇒ ToJSON (Params crypto) Source # | Pretty printing for pool parameters |
Defined in Cardano.CLI.Types Methods toJSON ∷ Params crypto → Value # toEncoding ∷ Params crypto → Encoding # toJSONList ∷ [Params crypto] → Value # toEncodingList ∷ [Params crypto] → Encoding # | |
Show (Params crypto) Source # | |
data RequiredSigner Source #
Plutus script required signers
Constructors
RequiredSignerSkeyFile SigningKeyFile | |
RequiredSignerHash (Hash PaymentKey) |
Instances
Show RequiredSigner Source # | |
Defined in Cardano.CLI.Types |