cardano-cli-1.36.0: The Cardano command-line interface
Safe HaskellSafe-Inferred
LanguageHaskell2010

Cardano.CLI.Types

Synopsis

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

Instances

Instances details
Show CBORObject Source # 
Instance details

Defined in Cardano.CLI.Types

newtype CurrentKesPeriod Source #

Constructors

CurrentKesPeriod 

Instances

Instances details
FromJSON CurrentKesPeriod Source # 
Instance details

Defined in Cardano.CLI.Types

Methods

parseJSON ∷ Value → Parser CurrentKesPeriod #

parseJSONList ∷ Value → Parser [CurrentKesPeriod] #

ToJSON CurrentKesPeriod Source # 
Instance details

Defined in Cardano.CLI.Types

Methods

toJSONCurrentKesPeriod → Value #

toEncodingCurrentKesPeriod → Encoding #

toJSONList ∷ [CurrentKesPeriod] → Value #

toEncodingList ∷ [CurrentKesPeriod] → Encoding #

Show CurrentKesPeriod Source # 
Instance details

Defined in Cardano.CLI.Types

Eq CurrentKesPeriod Source # 
Instance details

Defined in Cardano.CLI.Types

data EpochLeadershipSchedule Source #

Which leadership schedule we are interested in. TODO: Implement Previous and Next epochs

Constructors

CurrentEpoch 
NextEpoch 

newtype GenesisFile Source #

Constructors

GenesisFile 

Instances

Instances details
FromJSON GenesisFile Source # 
Instance details

Defined in Cardano.CLI.Types

Methods

parseJSON ∷ Value → Parser GenesisFile #

parseJSONList ∷ Value → Parser [GenesisFile] #

IsString GenesisFile Source # 
Instance details

Defined in Cardano.CLI.Types

Show GenesisFile Source # 
Instance details

Defined in Cardano.CLI.Types

Eq GenesisFile Source # 
Instance details

Defined in Cardano.CLI.Types

Ord GenesisFile Source # 
Instance details

Defined in Cardano.CLI.Types

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.

data OutputFormat Source #

The desired output format.

Instances

Instances details
Show OutputFormat Source # 
Instance details

Defined in Cardano.CLI.Types

Eq OutputFormat Source # 
Instance details

Defined in Cardano.CLI.Types

data TxBuildOutputOptions Source #

Specify whether to render the script cost as JSON in the cli's build command.

newtype ScriptFile Source #

Constructors

ScriptFile 

Instances

Instances details
Show ScriptFile Source # 
Instance details

Defined in Cardano.CLI.Types

Eq ScriptFile Source # 
Instance details

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

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.

Instances

Instances details
Show (ScriptWitnessFiles witctx) Source # 
Instance details

Defined in Cardano.CLI.Types

data TransferDirection Source #

Determines the direction in which the MIR certificate will transfer ADA.

Instances

Instances details
Show TransferDirection Source # 
Instance details

Defined in Cardano.CLI.Types

newtype TxBodyFile Source #

Constructors

TxBodyFile FilePath 

Instances

Instances details
Show TxBodyFile Source # 
Instance details

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.

Instances

Instances details
Show TxOutAnyEra Source # 
Instance details

Defined in Cardano.CLI.Types

Eq TxOutAnyEra Source # 
Instance details

Defined in Cardano.CLI.Types

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.

newtype TxFile Source #

Constructors

TxFile FilePath 

Instances

Instances details
Show TxFile Source # 
Instance details

Defined in Cardano.CLI.Types

data Params crypto 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

Instances details
Crypto crypto ⇒ ToJSON (Params crypto) Source #

Pretty printing for pool parameters

Instance details

Defined in Cardano.CLI.Types

Methods

toJSONParams crypto → Value #

toEncodingParams crypto → Encoding #

toJSONList ∷ [Params crypto] → Value #

toEncodingList ∷ [Params crypto] → Encoding #

Show (Params crypto) Source # 
Instance details

Defined in Cardano.CLI.Types

Methods

showsPrecIntParams crypto → ShowS Source #

showParams crypto → String Source #

showList ∷ [Params crypto] → ShowS Source #

data RequiredSigner Source #

Plutus script required signers

Instances

Instances details
Show RequiredSigner Source # 
Instance details

Defined in Cardano.CLI.Types

data AllOrOnly a Source #

Constructors

All 
Only a 

Instances

Instances details
Show a ⇒ Show (AllOrOnly a) Source # 
Instance details

Defined in Cardano.CLI.Types

Eq a ⇒ Eq (AllOrOnly a) Source # 
Instance details

Defined in Cardano.CLI.Types

Methods

(==)AllOrOnly a → AllOrOnly a → Bool Source #

(/=)AllOrOnly a → AllOrOnly a → Bool Source #