cardano-cli
Safe HaskellNone
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

data AnchorScheme Source #

The different schemes that can be used to fetch anchor data.

data AnyPlutusScriptVersion where #

Instances

Instances details
FromJSON AnyPlutusScriptVersion 
Instance details

Defined in Cardano.Api.Script

FromJSONKey AnyPlutusScriptVersion 
Instance details

Defined in Cardano.Api.Script

ToJSON AnyPlutusScriptVersion 
Instance details

Defined in Cardano.Api.Script

ToJSONKey AnyPlutusScriptVersion 
Instance details

Defined in Cardano.Api.Script

Bounded AnyPlutusScriptVersion 
Instance details

Defined in Cardano.Api.Script

Enum AnyPlutusScriptVersion 
Instance details

Defined in Cardano.Api.Script

Show AnyPlutusScriptVersion 
Instance details

Defined in Cardano.Api.Script

FromCBOR AnyPlutusScriptVersion 
Instance details

Defined in Cardano.Api.Script

ToCBOR AnyPlutusScriptVersion 
Instance details

Defined in Cardano.Api.Script

Eq AnyPlutusScriptVersion 
Instance details

Defined in Cardano.Api.Script

Ord AnyPlutusScriptVersion 
Instance details

Defined in Cardano.Api.Script

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

data EpochLeadershipSchedule Source #

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

Constructors

CurrentEpoch 
NextEpoch 

newtype File content (direction :: FileDirection) #

Constructors

File 

Fields

Instances

Instances details
FromJSON (File content direction) 
Instance details

Defined in Cardano.Api.IO.Base

Methods

parseJSON :: Value -> Parser (File content direction) Source #

parseJSONList :: Value -> Parser [File content direction] Source #

omittedField :: Maybe (File content direction) Source #

ToJSON (File content direction) 
Instance details

Defined in Cardano.Api.IO.Base

Methods

toJSON :: File content direction -> Value Source #

toEncoding :: File content direction -> Encoding Source #

toJSONList :: [File content direction] -> Value Source #

toEncodingList :: [File content direction] -> Encoding Source #

omitField :: File content direction -> Bool Source #

IsString (File content direction) 
Instance details

Defined in Cardano.Api.IO.Base

Methods

fromString :: String -> File content direction Source #

Read (File content direction) 
Instance details

Defined in Cardano.Api.IO.Base

Methods

readsPrec :: Int -> ReadS (File content direction) Source #

readList :: ReadS [File content direction] Source #

readPrec :: ReadPrec (File content direction) Source #

readListPrec :: ReadPrec [File content direction] Source #

Show (File content direction) 
Instance details

Defined in Cardano.Api.IO.Base

Methods

showsPrec :: Int -> File content direction -> ShowS Source #

show :: File 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

compare :: File 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 #

max :: File content direction -> File content direction -> File content direction Source #

min :: File content direction -> File content direction -> File content direction Source #

data FileDirection #

Constructors

In 
Out 
InOut 

newtype GenesisDir Source #

Constructors

GenesisDir FilePath 

Instances

Instances details
Show GenesisDir Source # 
Instance details

Defined in Cardano.CLI.Types.Common

data IncludeStake Source #

Whether to include the stake, as queried by drep-stake-distribution, in the output of drep-state. This is (computationally) expensive, but sometimes convenient.

Constructors

WithStake 
NoStake 

Instances

Instances details
Show IncludeStake 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 MustCheckHash a Source #

Constructors

CheckHash 
TrustHash 

Instances

Instances details
Show (MustCheckHash a) Source # 
Instance details

Defined in Cardano.CLI.Types.Common

Eq (MustCheckHash a) 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

toJSON :: Params crypto -> Value Source #

toEncoding :: Params crypto -> Encoding Source #

toJSONList :: [Params crypto] -> Value Source #

toEncodingList :: [Params crypto] -> Encoding Source #

omitField :: Params crypto -> Bool Source #

Show (Params crypto) Source # 
Instance details

Defined in Cardano.CLI.Types.Common

Methods

showsPrec :: Int -> Params crypto -> ShowS Source #

show :: Params 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. NB: This is in the process of being deprecated because it is difficult to accomodate for changes for specific plutus script purposes. As an example when minting a multi-asset with a plutus script we need the policy id of the said script. This is fine when we have access to the plutus script however in the case of a reference script we demand the user provides the policy id. Enshrining that change in the ScriptWitnessFiles is difficult because only minting scripts require this but not the other kinds of plutus scripts (spending, certifying etc.) Another example is CIP-69 where datums are no longer required for spending scripts. This is further complicated by the fact at the parsing level we make user facing simplifications e.g `--mint-script-file` which says nothing about the script type (simple vs plutus) or script version. As a result need to separate the different script purposes into their own separate data definitions where we can make changes specific to that script purpose more easily without affecting the rest of the api.

Instances

Instances details
Show (ScriptWitnessFiles witctx) Source # 
Instance details

Defined in Cardano.CLI.Types.Common

data SomeKeyFile (direction :: FileDirection) 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

showsPrec :: Int -> SomeKeyFile direction -> ShowS Source #

show :: SomeKeyFile direction -> String Source #

showList :: [SomeKeyFile direction] -> ShowS Source #

data StakeDelegators Source #

Constructors

StakeDelegators 

Fields

type SupportedSchemes = [AnchorScheme] Source #

Specifies the schemes that are allowed to fetch anchor data.

data TransferDirection Source #

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

data TxBuildOutputOptions Source #

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

type TxFile = File (Tx ()) Source #

newtype TxSubmissionResult Source #

Type used for serialization when printing the hash of a transaction after having submitted it.

Constructors

TxSubmissionResult 

Fields

Instances

Instances details
FromJSON TxSubmissionResult Source # 
Instance details

Defined in Cardano.CLI.Types.Common

ToJSON TxSubmissionResult Source # 
Instance details

Defined in Cardano.CLI.Types.Common

Generic TxSubmissionResult Source # 
Instance details

Defined in Cardano.CLI.Types.Common

Associated Types

type Rep TxSubmissionResult 
Instance details

Defined in Cardano.CLI.Types.Common

type Rep TxSubmissionResult = D1 ('MetaData "TxSubmissionResult" "Cardano.CLI.Types.Common" "cardano-cli-10.1.1.0-inplace" 'True) (C1 ('MetaCons "TxSubmissionResult" 'PrefixI 'True) (S1 ('MetaSel ('Just "txhash") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 TxId)))
Show TxSubmissionResult Source # 
Instance details

Defined in Cardano.CLI.Types.Common

type Rep TxSubmissionResult Source # 
Instance details

Defined in Cardano.CLI.Types.Common

type Rep TxSubmissionResult = D1 ('MetaData "TxSubmissionResult" "Cardano.CLI.Types.Common" "cardano-cli-10.1.1.0-inplace" 'True) (C1 ('MetaCons "TxSubmissionResult" 'PrefixI 'True) (S1 ('MetaSel ('Just "txhash") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 TxId)))

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

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.

data DRepMetadataUrl Source #

Tag for differentiating between DRep metadata sources and sources for other types of anchor data

data ResignationMetadataUrl Source #

Tag for differentiating between resignation metadatata sources and sources for other types of anchor data

data PotentiallyCheckedAnchor anchorType anchor Source #

Constructors

PotentiallyCheckedAnchor 

Fields

  • pcaAnchor :: anchor

    The anchor data whose hash is to be checked

  • pcaMustCheck :: MustCheckHash anchorType

    Whether to check the hash or not (CheckHash for checking or TrustHash for not checking)

Instances

Instances details
Show anchor => Show (PotentiallyCheckedAnchor anchorType anchor) Source # 
Instance details

Defined in Cardano.CLI.Types.Common

Methods

showsPrec :: Int -> PotentiallyCheckedAnchor anchorType anchor -> ShowS Source #

show :: PotentiallyCheckedAnchor anchorType anchor -> String Source #

showList :: [PotentiallyCheckedAnchor anchorType anchor] -> ShowS Source #

Eq anchor => Eq (PotentiallyCheckedAnchor anchorType anchor) Source # 
Instance details

Defined in Cardano.CLI.Types.Common

Methods

(==) :: PotentiallyCheckedAnchor anchorType anchor -> PotentiallyCheckedAnchor anchorType anchor -> Bool Source #

(/=) :: PotentiallyCheckedAnchor anchorType anchor -> PotentiallyCheckedAnchor anchorType anchor -> Bool Source #