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

Cardano.CLI.Types.Common

Synopsis

Documentation

data AllOrOnly a Source #

Constructors

All 
Only [a] 

Instances

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

Defined in Cardano.CLI.Types.Common

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

Defined in Cardano.CLI.Types.Common

Methods

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

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

data BalanceTxExecUnits Source #

A flag that differentiates between automatically and manually balancing a tx.

Constructors

AutoBalance 
ManualBalance 

newtype BlockId Source #

Constructors

BlockId String 

Instances

Instances details
Show BlockId Source # 
Instance details

Defined in Cardano.CLI.Types.Common

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.Common

data DRepCredentials Source #

Constructors

DRepCredentials 

Fields

Instances

Instances details
Show DRepCredentials Source # 
Instance details

Defined in Cardano.CLI.Types.Common

data EpochLeadershipSchedule Source #

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

Constructors

CurrentEpoch 
NextEpoch 

newtype File content (direction ∷ FileDirection) Source #

A file path with additional type information to indicate what the file is meant to contain and whether it is to be used for reading or writing.

Constructors

File 

Fields

Instances

Instances details
FromJSON (File content direction) 
Instance details

Defined in Cardano.Api.IO.Base

Methods

parseJSONValueParser (File content direction) Source #

parseJSONListValueParser [File content direction] Source #

omittedFieldMaybe (File content direction) Source #

ToJSON (File content direction) 
Instance details

Defined in Cardano.Api.IO.Base

Methods

toJSONFile content direction → Value Source #

toEncodingFile content direction → Encoding Source #

toJSONList ∷ [File content direction] → Value Source #

toEncodingList ∷ [File content direction] → Encoding Source #

omitFieldFile content direction → Bool Source #

IsString (File content direction) 
Instance details

Defined in Cardano.Api.IO.Base

Methods

fromStringStringFile content direction Source #

Read (File content direction) 
Instance details

Defined in Cardano.Api.IO.Base

Methods

readsPrecIntReadS (File content direction) Source #

readListReadS [File content direction] Source #

readPrecReadPrec (File content direction) Source #

readListPrecReadPrec [File content direction] Source #

Show (File content direction) 
Instance details

Defined in Cardano.Api.IO.Base

Methods

showsPrecIntFile content direction → ShowS Source #

showFile content direction → String Source #

showList ∷ [File content direction] → ShowS Source #

Eq (File content direction) 
Instance details

Defined in Cardano.Api.IO.Base

Methods

(==)File content direction → File content direction → Bool Source #

(/=)File content direction → File content direction → Bool Source #

Ord (File content direction) 
Instance details

Defined in Cardano.Api.IO.Base

Methods

compareFile content direction → File content direction → Ordering Source #

(<)File content direction → File content direction → Bool Source #

(<=)File content direction → File content direction → Bool Source #

(>)File content direction → File content direction → Bool Source #

(>=)File content direction → File content direction → Bool Source #

maxFile content direction → File content direction → File content direction Source #

minFile content direction → File content direction → File content direction Source #

data FileDirection Source #

Constructors

In

Indicate the file is to be used for reading.

Out

Indicate the file is to be used for writing.

InOut

Indicate the file is to be used for both reading and writing.

newtype GenesisDir Source #

Constructors

GenesisDir FilePath 

Instances

Instances details
Show GenesisDir Source # 
Instance details

Defined in Cardano.CLI.Types.Common

newtype GenesisKeyFile Source #

Constructors

GenesisKeyFile FilePath 

Instances

Instances details
Show GenesisKeyFile Source # 
Instance details

Defined in Cardano.CLI.Types.Common

data MetadataFile Source #

Constructors

MetadataFileJSON (File () In) 
MetadataFileCBOR (File () In) 

Instances

Instances details
Show MetadataFile Source # 
Instance details

Defined in Cardano.CLI.Types.Common

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 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.

Instances

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

Pretty printing for pool parameters

Instance details

Defined in Cardano.CLI.Types.Common

Methods

toJSONParams crypto → Value Source #

toEncodingParams crypto → Encoding Source #

toJSONList ∷ [Params crypto] → Value Source #

toEncodingList ∷ [Params crypto] → Encoding Source #

omitFieldParams crypto → Bool Source #

Show (Params crypto) Source # 
Instance details

Defined in Cardano.CLI.Types.Common

Methods

showsPrecIntParams crypto → ShowS Source #

showParams crypto → String Source #

showList ∷ [Params crypto] → ShowS Source #

data IdOutputFormat Source #

Some entities such as stake pools and dreps have a notion of an ID and that id can be encoded as either a bech32 or hex string. This type is used to specify which encoding to use.

newtype PrivKeyFile Source #

Constructors

PrivKeyFile FilePath 

Instances

Instances details
Show PrivKeyFile Source # 
Instance details

Defined in Cardano.CLI.Types.Common

data ProposalBinary Source #

Tag for tracking proposals submitted as Bytestring

data ProposalText Source #

Tag for tracking proposals submitted as Text

newtype ProposalUrl Source #

Constructors

ProposalUrl 

Fields

Instances

Instances details
Show ProposalUrl Source # 
Instance details

Defined in Cardano.CLI.Types.Common

Eq ProposalUrl Source # 
Instance details

Defined in Cardano.CLI.Types.Common

data RequiredSigner Source #

Plutus script required signers

Instances

Instances details
Show RequiredSigner Source # 
Instance details

Defined in Cardano.CLI.Types.Common

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.

TODO: Potentially update to WitnessFiles so we can get rid of Maybe (ScriptWitnessFiles). This will be clearer in conveying that we either expect a script witness or a key witness is provided at the signing stage.

Instances

Instances details
Show (ScriptWitnessFiles witctx) Source # 
Instance details

Defined in Cardano.CLI.Types.Common

data SomeKeyFile direction Source #

Either a verification or signing key, used for conversions and other commands that make sense for both.

Instances

Instances details
Show (SomeKeyFile direction) Source # 
Instance details

Defined in Cardano.CLI.Types.Common

Methods

showsPrecIntSomeKeyFile direction → ShowS Source #

showSomeKeyFile direction → String Source #

showList ∷ [SomeKeyFile direction] → ShowS Source #

data StakeDelegators Source #

Constructors

StakeDelegators 

Fields

Instances

Instances details
Show StakeDelegators Source # 
Instance details

Defined in Cardano.CLI.Types.Common

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.Common

data TxBuildOutputOptions Source #

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

type TxFile = File (Tx ()) Source #

newtype TxInCount Source #

Constructors

TxInCount Int 

Instances

Instances details
Show TxInCount Source # 
Instance details

Defined in Cardano.CLI.Types.Common

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.Common

Eq TxOutAnyEra Source # 
Instance details

Defined in Cardano.CLI.Types.Common

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 TxOutCount Source #

Constructors

TxOutCount Int 

Instances

Instances details
Show TxOutCount Source # 
Instance details

Defined in Cardano.CLI.Types.Common

newtype VerificationKeyBase64 Source #

A raw verification key given in Base64, and decoded into a ByteString.

newtype VoteUrl Source #

Constructors

VoteUrl 

Fields

Instances

Instances details
Show VoteUrl Source # 
Instance details

Defined in Cardano.CLI.Types.Common

Eq VoteUrl Source # 
Instance details

Defined in Cardano.CLI.Types.Common

Methods

(==)VoteUrlVoteUrlBool Source #

(/=)VoteUrlVoteUrlBool Source #

newtype VoteText Source #

Constructors

VoteText 

Fields

Instances

Instances details
Show VoteText Source # 
Instance details

Defined in Cardano.CLI.Types.Common

Eq VoteText Source # 
Instance details

Defined in Cardano.CLI.Types.Common

newtype WitnessFile Source #

Constructors

WitnessFile FilePath 

Instances

Instances details
Show WitnessFile Source # 
Instance details

Defined in Cardano.CLI.Types.Common

data WitnessSigningData Source #

Data required to construct a witness.

Constructors

KeyWitnessSigningData 

Fields

  • !(SigningKeyFile In)

    Path to a file that should contain a signing key.

  • !(Maybe (Address ByronAddr))

    An optionally specified Byron address.

    If specified, both the network ID and derivation path are extracted from the address and used in the construction of the Byron witness.