cardano-cli-1.28.0
Safe HaskellNone
LanguageHaskell2010

Cardano.CLI.Shelley.Commands

Description

Shelley CLI command types

Synopsis

CLI command types

data TransactionCmd Source #

Constructors

TxBuildRaw 

Fields

TxBuild

Like TxBuildRaw but without the fee, and with a change output.

Fields

TxSign TxBodyFile [WitnessSigningData] (Maybe NetworkId) TxFile 
TxCreateWitness TxBodyFile WitnessSigningData (Maybe NetworkId) OutputFile 
TxAssembleTxBodyWitness TxBodyFile [WitnessFile] OutputFile 
TxSubmit AnyConsensusModeParams NetworkId FilePath 
TxMintedPolicyId ScriptFile 
TxCalculateMinFee TxBodyFile (Maybe NetworkId) ProtocolParamsSourceSpec TxInCount TxOutCount TxShelleyWitnessCount TxByronWitnessCount 
TxCalculateMinValue ProtocolParamsSourceSpec Value 
TxHashScriptData ScriptDataOrFile 
TxGetTxId InputTxFile 
TxView InputTxFile 

Instances

Instances details
Show TransactionCmd Source # 
Instance details

Defined in Cardano.CLI.Shelley.Commands

data PoolCmd Source #

Constructors

PoolRegistrationCert 

Fields

PoolRetirementCert 

Fields

PoolGetId (VerificationKeyOrFile StakePoolKey) OutputFormat 
PoolMetadataHash PoolMetadataFile (Maybe OutputFile) 

Instances

Instances details
Show PoolCmd Source # 
Instance details

Defined in Cardano.CLI.Shelley.Commands

Methods

showsPrecIntPoolCmdShowS #

showPoolCmdString #

showList ∷ [PoolCmd] → ShowS #

data TextViewCmd Source #

Instances

Instances details
Show TextViewCmd Source # 
Instance details

Defined in Cardano.CLI.Shelley.Commands

CLI flag types

newtype GenesisDir Source #

Constructors

GenesisDir FilePath 

Instances

Instances details
Show GenesisDir Source # 
Instance details

Defined in Cardano.CLI.Shelley.Commands

newtype TxInCount Source #

Constructors

TxInCount Int 

Instances

Instances details
Show TxInCount Source # 
Instance details

Defined in Cardano.CLI.Shelley.Commands

Methods

showsPrecIntTxInCountShowS #

showTxInCountString #

showList ∷ [TxInCount] → ShowS #

newtype TxOutCount Source #

Constructors

TxOutCount Int 

Instances

Instances details
Show TxOutCount Source # 
Instance details

Defined in Cardano.CLI.Shelley.Commands

data SomeKeyFile Source #

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

Instances

Instances details
Show SomeKeyFile Source # 
Instance details

Defined in Cardano.CLI.Shelley.Commands

newtype OutputFile Source #

Constructors

OutputFile FilePath 

Instances

Instances details
Show OutputFile Source # 
Instance details

Defined in Cardano.CLI.Shelley.Commands

data ProtocolParamsSourceSpec Source #

Constructors

ParamsFromGenesis !GenesisFile

We allow an appropriately forewarned user to obtain protocol params directly from the genesis file, which allows them to avoid running the node in case they would like to estimate the fee using the blockchain's initial protocol parameters.

ParamsFromFile !ProtocolParamsFile

Obtain protocol parameters from a file structured by the 'cardano-api' ProtocolParameters data type.

newtype WitnessFile Source #

Constructors

WitnessFile FilePath 

Instances

Instances details
Show WitnessFile Source # 
Instance details

Defined in Cardano.CLI.Shelley.Commands

newtype TxBodyFile Source #

Constructors

TxBodyFile FilePath 

Instances

Instances details
Show TxBodyFile Source # 
Instance details

Defined in Cardano.CLI.Shelley.Commands

newtype TxFile Source #

Constructors

TxFile FilePath 

Instances

Instances details
Show TxFile Source # 
Instance details

Defined in Cardano.CLI.Shelley.Commands

Methods

showsPrecIntTxFileShowS #

showTxFileString #

showList ∷ [TxFile] → ShowS #

data InputTxFile Source #

Instances

Instances details
Show InputTxFile Source # 
Instance details

Defined in Cardano.CLI.Shelley.Commands

newtype VerificationKeyBase64 Source #

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

newtype GenesisKeyFile Source #

Constructors

GenesisKeyFile FilePath 

Instances

Instances details
Show GenesisKeyFile Source # 
Instance details

Defined in Cardano.CLI.Shelley.Commands

data MetadataFile Source #

Instances

Instances details
Show MetadataFile Source # 
Instance details

Defined in Cardano.CLI.Shelley.Commands

newtype PoolId Source #

Constructors

PoolId String 

Instances

Instances details
Show PoolId Source # 
Instance details

Defined in Cardano.CLI.Shelley.Commands

Methods

showsPrecIntPoolIdShowS #

showPoolIdString #

showList ∷ [PoolId] → ShowS #

newtype PoolMetadataFile Source #

Instances

Instances details
Show PoolMetadataFile Source # 
Instance details

Defined in Cardano.CLI.Shelley.Commands

newtype PrivKeyFile Source #

Constructors

PrivKeyFile FilePath 

Instances

Instances details
Show PrivKeyFile Source # 
Instance details

Defined in Cardano.CLI.Shelley.Commands

newtype BlockId Source #

Constructors

BlockId String 

Instances

Instances details
Show BlockId Source # 
Instance details

Defined in Cardano.CLI.Shelley.Commands

Methods

showsPrecIntBlockIdShowS #

showBlockIdString #

showList ∷ [BlockId] → ShowS #

data WitnessSigningData Source #

Data required to construct a witness.

Constructors

KeyWitnessSigningData 

Fields

  • !SigningKeyFile

    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.

Instances

Instances details
Show WitnessSigningData Source # 
Instance details

Defined in Cardano.CLI.Shelley.Commands

data ColdVerificationKeyOrFile Source #

Either a stake pool verification key, genesis delegate verification key, or a path to a cold verification key file.

Note that a "cold verification key" refers to either a stake pool or genesis delegate verification key.

TODO: A genesis delegate extended key should also be valid here.