Safe Haskell	Safe-Inferred
Language	Haskell2010

Cardano.CLI.Shelley.Commands

Contents

CLI command types
CLI flag types

Description

Shelley CLI command types

Synopsis

data ShelleyCommand
- = AddressCmd AddressCmd
- | StakeAddressCmd StakeAddressCmd
- | KeyCmd KeyCmd
- | TransactionCmd TransactionCmd
- | NodeCmd NodeCmd
- | PoolCmd PoolCmd
- | QueryCmd QueryCmd
- | GovernanceCmd GovernanceCmd
- | GenesisCmd GenesisCmd
- | TextViewCmd TextViewCmd
data AddressCmd
- = AddressKeyGen AddressKeyType VerificationKeyFile SigningKeyFile
- | AddressKeyHash VerificationKeyTextOrFile (Maybe OutputFile)
- | AddressBuild PaymentVerifier (Maybe StakeVerifier) NetworkId (Maybe OutputFile)
- | AddressInfo Text (Maybe OutputFile)
data StakeAddressCmd
- = StakeAddressKeyGen VerificationKeyFile SigningKeyFile
- | StakeAddressKeyHash (VerificationKeyOrFile StakeKey) (Maybe OutputFile)
- | StakeAddressBuild StakeVerifier NetworkId (Maybe OutputFile)
- | StakeRegistrationCert StakeVerifier OutputFile
- | StakeCredentialDelegationCert StakeVerifier (VerificationKeyOrHashOrFile StakePoolKey) OutputFile
- | StakeCredentialDeRegistrationCert StakeVerifier OutputFile
data KeyCmd
- = KeyGetVerificationKey SigningKeyFile VerificationKeyFile
- | KeyNonExtendedKey VerificationKeyFile VerificationKeyFile
- | KeyConvertByronKey (Maybe Text) ByronKeyType SomeKeyFile OutputFile
- | KeyConvertByronGenesisVKey VerificationKeyBase64 OutputFile
- | KeyConvertITNStakeKey SomeKeyFile OutputFile
- | KeyConvertITNExtendedToStakeKey SomeKeyFile OutputFile
- | KeyConvertITNBip32ToStakeKey SomeKeyFile OutputFile
- | KeyConvertCardanoAddressSigningKey CardanoAddressKeyType SigningKeyFile OutputFile
data TransactionCmd
- = TxBuildRaw AnyCardanoEra (Maybe ScriptValidity) [(TxIn, Maybe (ScriptWitnessFiles WitCtxTxIn))] [TxIn] [TxIn] (Maybe TxOutAnyEra) (Maybe Lovelace) [RequiredSigner] [TxOutAnyEra] (Maybe (Value, [ScriptWitnessFiles WitCtxMint])) (Maybe SlotNo) (Maybe SlotNo) (Maybe Lovelace) [(CertificateFile, Maybe (ScriptWitnessFiles WitCtxStake))] [(StakeAddress, Lovelace, Maybe (ScriptWitnessFiles WitCtxStake))] TxMetadataJsonSchema [ScriptFile] [MetadataFile] (Maybe ProtocolParamsSourceSpec) (Maybe UpdateProposalFile) TxBodyFile
- | TxBuild AnyCardanoEra AnyConsensusModeParams NetworkId (Maybe ScriptValidity) (Maybe Word) [(TxIn, Maybe (ScriptWitnessFiles WitCtxTxIn))] [TxIn] [RequiredSigner] [TxIn] (Maybe TxOutAnyEra) (Maybe Lovelace) [TxOutAnyEra] TxOutChangeAddress (Maybe (Value, [ScriptWitnessFiles WitCtxMint])) (Maybe SlotNo) (Maybe SlotNo) [(CertificateFile, Maybe (ScriptWitnessFiles WitCtxStake))] [(StakeAddress, Lovelace, Maybe (ScriptWitnessFiles WitCtxStake))] TxMetadataJsonSchema [ScriptFile] [MetadataFile] (Maybe ProtocolParamsSourceSpec) (Maybe UpdateProposalFile) TxBuildOutputOptions
- | TxSign InputTxBodyOrTxFile [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
- | TxCalculateMinRequiredUTxO AnyCardanoEra ProtocolParamsSourceSpec TxOutAnyEra
- | TxHashScriptData ScriptDataOrFile
- | TxGetTxId InputTxBodyOrTxFile
- | TxView InputTxBodyOrTxFile
data NodeCmd
- = NodeKeyGenCold VerificationKeyFile SigningKeyFile OpCertCounterFile
- | NodeKeyGenKES VerificationKeyFile SigningKeyFile
- | NodeKeyGenVRF VerificationKeyFile SigningKeyFile
- | NodeKeyHashVRF (VerificationKeyOrFile VrfKey) (Maybe OutputFile)
- | NodeNewCounter ColdVerificationKeyOrFile Word OpCertCounterFile
- | NodeIssueOpCert (VerificationKeyOrFile KesKey) SigningKeyFile OpCertCounterFile KESPeriod OutputFile
data PoolCmd
- = PoolRegistrationCert (VerificationKeyOrFile StakePoolKey) (VerificationKeyOrFile VrfKey) Lovelace Lovelace Rational (VerificationKeyOrFile StakeKey) [VerificationKeyOrFile StakeKey] [StakePoolRelay] (Maybe StakePoolMetadataReference) NetworkId OutputFile
- | PoolRetirementCert (VerificationKeyOrFile StakePoolKey) EpochNo OutputFile
- | PoolGetId (VerificationKeyOrFile StakePoolKey) OutputFormat
- | PoolMetadataHash PoolMetadataFile (Maybe OutputFile)
data QueryCmd
- = QueryLeadershipSchedule AnyConsensusModeParams NetworkId GenesisFile (VerificationKeyOrHashOrFile StakePoolKey) SigningKeyFile EpochLeadershipSchedule (Maybe OutputFile)
- | QueryProtocolParameters' AnyConsensusModeParams NetworkId (Maybe OutputFile)
- | QueryTip AnyConsensusModeParams NetworkId (Maybe OutputFile)
- | QueryStakePools' AnyConsensusModeParams NetworkId (Maybe OutputFile)
- | QueryStakeDistribution' AnyConsensusModeParams NetworkId (Maybe OutputFile)
- | QueryStakeAddressInfo AnyConsensusModeParams StakeAddress NetworkId (Maybe OutputFile)
- | QueryUTxO' AnyConsensusModeParams QueryUTxOFilter NetworkId (Maybe OutputFile)
- | QueryDebugLedgerState' AnyConsensusModeParams NetworkId (Maybe OutputFile)
- | QueryProtocolState' AnyConsensusModeParams NetworkId (Maybe OutputFile)
- | QueryStakeSnapshot' AnyConsensusModeParams NetworkId (AllOrOnly [Hash StakePoolKey]) (Maybe OutputFile)
- | QueryKesPeriodInfo AnyConsensusModeParams NetworkId FilePath (Maybe OutputFile)
- | QueryPoolState' AnyConsensusModeParams NetworkId [Hash StakePoolKey]
- | QueryTxMempool AnyConsensusModeParams NetworkId TxMempoolQuery (Maybe OutputFile)
data GovernanceCmd
- = GovernanceMIRPayStakeAddressesCertificate MIRPot [StakeAddress] [Lovelace] OutputFile
- | GovernanceMIRTransfer Lovelace OutputFile TransferDirection
- | GovernanceGenesisKeyDelegationCertificate (VerificationKeyOrHashOrFile GenesisKey) (VerificationKeyOrHashOrFile GenesisDelegateKey) (VerificationKeyOrHashOrFile VrfKey) OutputFile
- | GovernanceUpdateProposal OutputFile EpochNo [VerificationKeyFile] ProtocolParametersUpdate (Maybe FilePath)
data GenesisCmd
- = GenesisCreate GenesisDir Word Word (Maybe SystemStart) (Maybe Lovelace) NetworkId
- | GenesisCreateCardano GenesisDir Word Word (Maybe SystemStart) (Maybe Lovelace) BlockCount Word Rational NetworkId FilePath FilePath FilePath FilePath (Maybe FilePath)
- | GenesisCreateStaked GenesisDir Word Word Word Word (Maybe SystemStart) (Maybe Lovelace) Lovelace NetworkId Word Word Word (Maybe FilePath)
- | GenesisKeyGenGenesis VerificationKeyFile SigningKeyFile
- | GenesisKeyGenDelegate VerificationKeyFile SigningKeyFile OpCertCounterFile
- | GenesisKeyGenUTxO VerificationKeyFile SigningKeyFile
- | GenesisCmdKeyHash VerificationKeyFile
- | GenesisVerKey VerificationKeyFile SigningKeyFile
- | GenesisTxIn VerificationKeyFile NetworkId (Maybe OutputFile)
- | GenesisAddr VerificationKeyFile NetworkId (Maybe OutputFile)
- | GenesisHashFile GenesisFile
data TextViewCmd = TextViewInfo !FilePath (Maybe OutputFile)
renderShelleyCommand ∷ ShelleyCommand → Text
data AddressKeyType
- = AddressKeyShelley
- | AddressKeyShelleyExtended
- | AddressKeyByron
data ByronKeyType
- = ByronPaymentKey ByronKeyFormat
- | ByronGenesisKey ByronKeyFormat
- | ByronDelegateKey ByronKeyFormat
data ByronKeyFormat
- = NonLegacyByronKeyFormat
- | LegacyByronKeyFormat
data CardanoAddressKeyType
- = CardanoAddressShelleyPaymentKey
- | CardanoAddressShelleyStakeKey
- | CardanoAddressIcarusPaymentKey
- | CardanoAddressByronPaymentKey
newtype GenesisDir = GenesisDir FilePath
newtype TxInCount = TxInCount Int
newtype TxOutCount = TxOutCount Int
newtype TxShelleyWitnessCount = TxShelleyWitnessCount Int
newtype TxByronWitnessCount = TxByronWitnessCount Int
data SomeKeyFile
- = AVerificationKeyFile VerificationKeyFile
- | ASigningKeyFile SigningKeyFile
newtype OpCertCounterFile = OpCertCounterFile FilePath
newtype OutputFile = OutputFile {
- unOutputFile ∷ FilePath
}
newtype ProtocolParamsFile = ProtocolParamsFile FilePath
data ProtocolParamsSourceSpec
- = ParamsFromGenesis !GenesisFile
- | ParamsFromFile !ProtocolParamsFile
newtype WitnessFile = WitnessFile FilePath
newtype TxFile = TxFile FilePath
data InputTxBodyOrTxFile
- = InputTxBodyFile TxBodyFile
- | InputTxFile TxFile
newtype VerificationKeyBase64 = VerificationKeyBase64 String
newtype GenesisKeyFile = GenesisKeyFile FilePath
data MetadataFile
- = MetadataFileJSON FilePath
- | MetadataFileCBOR FilePath
newtype PoolMetadataFile = PoolMetadataFile {
- unPoolMetadataFile ∷ FilePath
}
newtype PrivKeyFile = PrivKeyFile FilePath
newtype BlockId = BlockId String
data WitnessSigningData = KeyWitnessSigningData !SigningKeyFile !(Maybe (Address ByronAddr))
data ColdVerificationKeyOrFile
- = ColdStakePoolVerificationKey !(VerificationKey StakePoolKey)
- | ColdGenesisDelegateVerificationKey !(VerificationKey GenesisDelegateKey)
- | ColdVerificationKeyFile !VerificationKeyFile

CLI command types

data ShelleyCommand Source #

All the CLI subcommands under "shelley".

data AddressCmd Source #

Constructors

AddressKeyGen AddressKeyType VerificationKeyFile SigningKeyFile
AddressKeyHash VerificationKeyTextOrFile (Maybe OutputFile)
AddressBuild PaymentVerifier (Maybe StakeVerifier) NetworkId (Maybe OutputFile)
AddressInfo Text (Maybe OutputFile)

Instances

Instances details

Show AddressCmd Source #
Instance details Defined in Cardano.CLI.Shelley.Commands Methods showsPrec ∷ Int → AddressCmd → ShowS Source # show ∷ AddressCmd → String Source # showList ∷ [AddressCmd] → ShowS Source #

data StakeAddressCmd Source #

Instances

Instances details

Show StakeAddressCmd Source #
Instance details Defined in Cardano.CLI.Shelley.Commands Methods showsPrec ∷ Int → StakeAddressCmd → ShowS Source # show ∷ StakeAddressCmd → String Source # showList ∷ [StakeAddressCmd] → ShowS Source #

data KeyCmd Source #

Instances

Instances details

Show KeyCmd Source #
Instance details Defined in Cardano.CLI.Shelley.Commands Methods showsPrec ∷ Int → KeyCmd → ShowS Source # show ∷ KeyCmd → String Source # showList ∷ [KeyCmd] → ShowS Source #

data TransactionCmd Source #

Constructors

TxBuildRaw
Fields AnyCardanoEra (Maybe ScriptValidity) Mark script as expected to pass or fail validation [(TxIn, Maybe (ScriptWitnessFiles WitCtxTxIn))] Transaction inputs with optional spending scripts [TxIn] Read only reference inputs [TxIn] Transaction inputs for collateral, only key witnesses, no scripts. (Maybe TxOutAnyEra) Return collateral (Maybe Lovelace) Total collateral [RequiredSigner] Required signers [TxOutAnyEra] (Maybe (Value, [ScriptWitnessFiles WitCtxMint])) Multi-Asset value with script witness (Maybe SlotNo) Transaction lower bound (Maybe SlotNo) Transaction upper bound (Maybe Lovelace) Tx fee [(CertificateFile, Maybe (ScriptWitnessFiles WitCtxStake))] Certificates with potential script witness [(StakeAddress, Lovelace, Maybe (ScriptWitnessFiles WitCtxStake))] TxMetadataJsonSchema [ScriptFile] Auxiliary scripts [MetadataFile] (Maybe ProtocolParamsSourceSpec) (Maybe UpdateProposalFile) TxBodyFile
TxBuild	Like `TxBuildRaw` but without the fee, and with a change output.
Fields AnyCardanoEra AnyConsensusModeParams NetworkId (Maybe ScriptValidity) Mark script as expected to pass or fail validation (Maybe Word) Override the required number of tx witnesses [(TxIn, Maybe (ScriptWitnessFiles WitCtxTxIn))] Transaction inputs with optional spending scripts [TxIn] Read only reference inputs [RequiredSigner] Required signers [TxIn] Transaction inputs for collateral, only key witnesses, no scripts. (Maybe TxOutAnyEra) Return collateral (Maybe Lovelace) Total collateral [TxOutAnyEra] Normal outputs TxOutChangeAddress A change output (Maybe (Value, [ScriptWitnessFiles WitCtxMint])) Multi-Asset value with script witness (Maybe SlotNo) Transaction lower bound (Maybe SlotNo) Transaction upper bound [(CertificateFile, Maybe (ScriptWitnessFiles WitCtxStake))] Certificates with potential script witness [(StakeAddress, Lovelace, Maybe (ScriptWitnessFiles WitCtxStake))] Withdrawals with potential script witness TxMetadataJsonSchema [ScriptFile] Auxiliary scripts [MetadataFile] (Maybe ProtocolParamsSourceSpec) (Maybe UpdateProposalFile) TxBuildOutputOptions
TxSign InputTxBodyOrTxFile [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
TxCalculateMinRequiredUTxO AnyCardanoEra ProtocolParamsSourceSpec TxOutAnyEra
TxHashScriptData ScriptDataOrFile
TxGetTxId InputTxBodyOrTxFile
TxView InputTxBodyOrTxFile

data NodeCmd Source #

Instances

Instances details

Show NodeCmd Source #
Instance details Defined in Cardano.CLI.Shelley.Commands Methods showsPrec ∷ Int → NodeCmd → ShowS Source # show ∷ NodeCmd → String Source # showList ∷ [NodeCmd] → ShowS Source #

data PoolCmd Source #

Constructors

PoolRegistrationCert
Fields (VerificationKeyOrFile StakePoolKey) Stake pool verification key. (VerificationKeyOrFile VrfKey) VRF Verification key. Lovelace Pool pledge. Lovelace Pool cost. Rational Pool margin. (VerificationKeyOrFile StakeKey) Reward account verification staking key. [VerificationKeyOrFile StakeKey] Pool owner verification staking key(s). [StakePoolRelay] Stake pool relays. (Maybe StakePoolMetadataReference) Stake pool metadata. NetworkId OutputFile
PoolRetirementCert
Fields (VerificationKeyOrFile StakePoolKey) Stake pool verification key. EpochNo Epoch in which to retire the stake pool. OutputFile
PoolGetId (VerificationKeyOrFile StakePoolKey) OutputFormat
PoolMetadataHash PoolMetadataFile (Maybe OutputFile)

Instances

Instances details

Show PoolCmd Source #
Instance details Defined in Cardano.CLI.Shelley.Commands Methods showsPrec ∷ Int → PoolCmd → ShowS Source # show ∷ PoolCmd → String Source # showList ∷ [PoolCmd] → ShowS Source #

data QueryCmd Source #

Constructors

QueryLeadershipSchedule AnyConsensusModeParams NetworkId GenesisFile (VerificationKeyOrHashOrFile StakePoolKey) SigningKeyFile EpochLeadershipSchedule (Maybe OutputFile)
QueryProtocolParameters' AnyConsensusModeParams NetworkId (Maybe OutputFile)
QueryTip AnyConsensusModeParams NetworkId (Maybe OutputFile)
QueryStakePools' AnyConsensusModeParams NetworkId (Maybe OutputFile)
QueryStakeDistribution' AnyConsensusModeParams NetworkId (Maybe OutputFile)
QueryStakeAddressInfo AnyConsensusModeParams StakeAddress NetworkId (Maybe OutputFile)
QueryUTxO' AnyConsensusModeParams QueryUTxOFilter NetworkId (Maybe OutputFile)
QueryDebugLedgerState' AnyConsensusModeParams NetworkId (Maybe OutputFile)
QueryProtocolState' AnyConsensusModeParams NetworkId (Maybe OutputFile)
QueryStakeSnapshot' AnyConsensusModeParams NetworkId (AllOrOnly [Hash StakePoolKey]) (Maybe OutputFile)
QueryKesPeriodInfo
Fields AnyConsensusModeParams NetworkId FilePath Node operational certificate (Maybe OutputFile)
QueryPoolState' AnyConsensusModeParams NetworkId [Hash StakePoolKey]
QueryTxMempool AnyConsensusModeParams NetworkId TxMempoolQuery (Maybe OutputFile)

Instances

Instances details

Show QueryCmd Source #
Instance details Defined in Cardano.CLI.Shelley.Commands Methods showsPrec ∷ Int → QueryCmd → ShowS Source # show ∷ QueryCmd → String Source # showList ∷ [QueryCmd] → ShowS Source #

data GovernanceCmd Source #

Instances

Instances details

Show GovernanceCmd Source #
Instance details Defined in Cardano.CLI.Shelley.Commands Methods showsPrec ∷ Int → GovernanceCmd → ShowS Source # show ∷ GovernanceCmd → String Source # showList ∷ [GovernanceCmd] → ShowS Source #

data GenesisCmd Source #

Constructors

GenesisCreate GenesisDir Word Word (Maybe SystemStart) (Maybe Lovelace) NetworkId
GenesisCreateCardano GenesisDir Word Word (Maybe SystemStart) (Maybe Lovelace) BlockCount Word Rational NetworkId FilePath FilePath FilePath FilePath (Maybe FilePath)
GenesisCreateStaked GenesisDir Word Word Word Word (Maybe SystemStart) (Maybe Lovelace) Lovelace NetworkId Word Word Word (Maybe FilePath)	Relay specification filepath
GenesisKeyGenGenesis VerificationKeyFile SigningKeyFile
GenesisKeyGenDelegate VerificationKeyFile SigningKeyFile OpCertCounterFile
GenesisKeyGenUTxO VerificationKeyFile SigningKeyFile
GenesisCmdKeyHash VerificationKeyFile
GenesisVerKey VerificationKeyFile SigningKeyFile
GenesisTxIn VerificationKeyFile NetworkId (Maybe OutputFile)
GenesisAddr VerificationKeyFile NetworkId (Maybe OutputFile)
GenesisHashFile GenesisFile

Instances

Instances details

Show GenesisCmd Source #
Instance details Defined in Cardano.CLI.Shelley.Commands Methods showsPrec ∷ Int → GenesisCmd → ShowS Source # show ∷ GenesisCmd → String Source # showList ∷ [GenesisCmd] → ShowS Source #

data TextViewCmd Source #

Constructors

TextViewInfo !FilePath (Maybe OutputFile)

Instances

Instances details

Show TextViewCmd Source #
Instance details Defined in Cardano.CLI.Shelley.Commands Methods showsPrec ∷ Int → TextViewCmd → ShowS Source # show ∷ TextViewCmd → String Source # showList ∷ [TextViewCmd] → ShowS Source #

renderShelleyCommand ∷ ShelleyCommand → Text Source #

CLI flag types

data AddressKeyType Source #

Constructors

AddressKeyShelley
AddressKeyShelleyExtended
AddressKeyByron

Instances

Instances details

Show AddressKeyType Source #
Instance details Defined in Cardano.CLI.Shelley.Commands Methods showsPrec ∷ Int → AddressKeyType → ShowS Source # show ∷ AddressKeyType → String Source # showList ∷ [AddressKeyType] → ShowS Source #

data ByronKeyType Source #

Constructors

ByronPaymentKey ByronKeyFormat
ByronGenesisKey ByronKeyFormat
ByronDelegateKey ByronKeyFormat

Instances

Instances details

Show ByronKeyType Source #
Instance details Defined in Cardano.CLI.Shelley.Commands Methods showsPrec ∷ Int → ByronKeyType → ShowS Source # show ∷ ByronKeyType → String Source # showList ∷ [ByronKeyType] → ShowS Source #

data ByronKeyFormat Source #

Constructors

NonLegacyByronKeyFormat
LegacyByronKeyFormat

Instances

Instances details

Show ByronKeyFormat Source #
Instance details Defined in Cardano.CLI.Shelley.Commands Methods showsPrec ∷ Int → ByronKeyFormat → ShowS Source # show ∷ ByronKeyFormat → String Source # showList ∷ [ByronKeyFormat] → ShowS Source #

data CardanoAddressKeyType Source #

The type of cardano-address key.

Constructors

CardanoAddressShelleyPaymentKey
CardanoAddressShelleyStakeKey
CardanoAddressIcarusPaymentKey
CardanoAddressByronPaymentKey

Instances

Instances details

Show CardanoAddressKeyType Source #
Instance details Defined in Cardano.CLI.Shelley.Commands Methods showsPrec ∷ Int → CardanoAddressKeyType → ShowS Source # show ∷ CardanoAddressKeyType → String Source # showList ∷ [CardanoAddressKeyType] → ShowS Source #

newtype GenesisDir Source #

Constructors

GenesisDir FilePath

Instances

Instances details

Show GenesisDir Source #
Instance details Defined in Cardano.CLI.Shelley.Commands Methods showsPrec ∷ Int → GenesisDir → ShowS Source # show ∷ GenesisDir → String Source # showList ∷ [GenesisDir] → ShowS Source #

newtype TxInCount Source #

Constructors

TxInCount Int

Instances

Instances details

Show TxInCount Source #
Instance details Defined in Cardano.CLI.Shelley.Commands Methods showsPrec ∷ Int → TxInCount → ShowS Source # show ∷ TxInCount → String Source # showList ∷ [TxInCount] → ShowS Source #

newtype TxOutCount Source #

Constructors

TxOutCount Int

Instances

Instances details

Show TxOutCount Source #
Instance details Defined in Cardano.CLI.Shelley.Commands Methods showsPrec ∷ Int → TxOutCount → ShowS Source # show ∷ TxOutCount → String Source # showList ∷ [TxOutCount] → ShowS Source #

newtype TxShelleyWitnessCount Source #

Constructors

TxShelleyWitnessCount Int

Instances

Instances details

Show TxShelleyWitnessCount Source #
Instance details Defined in Cardano.CLI.Shelley.Commands Methods showsPrec ∷ Int → TxShelleyWitnessCount → ShowS Source # show ∷ TxShelleyWitnessCount → String Source # showList ∷ [TxShelleyWitnessCount] → ShowS Source #

newtype TxByronWitnessCount Source #

Constructors

TxByronWitnessCount Int

Instances

Instances details

Show TxByronWitnessCount Source #
Instance details Defined in Cardano.CLI.Shelley.Commands Methods showsPrec ∷ Int → TxByronWitnessCount → ShowS Source # show ∷ TxByronWitnessCount → String Source # showList ∷ [TxByronWitnessCount] → ShowS Source #

data SomeKeyFile Source #

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

Constructors

AVerificationKeyFile VerificationKeyFile
ASigningKeyFile SigningKeyFile

Instances

Instances details

Show SomeKeyFile Source #
Instance details Defined in Cardano.CLI.Shelley.Commands Methods showsPrec ∷ Int → SomeKeyFile → ShowS Source # show ∷ SomeKeyFile → String Source # showList ∷ [SomeKeyFile] → ShowS Source #

newtype OpCertCounterFile Source #

Constructors

OpCertCounterFile FilePath

Instances

Instances details

Show OpCertCounterFile Source #
Instance details Defined in Cardano.CLI.Shelley.Commands Methods showsPrec ∷ Int → OpCertCounterFile → ShowS Source # show ∷ OpCertCounterFile → String Source # showList ∷ [OpCertCounterFile] → ShowS Source #

newtype OutputFile Source #

Constructors

OutputFile
Fields unOutputFile ∷ FilePath

Instances

Instances details

Show OutputFile Source #
Instance details Defined in Cardano.CLI.Shelley.Commands Methods showsPrec ∷ Int → OutputFile → ShowS Source # show ∷ OutputFile → String Source # showList ∷ [OutputFile] → ShowS Source #

newtype ProtocolParamsFile Source #

Constructors

ProtocolParamsFile FilePath

Instances

Instances details

Show ProtocolParamsFile Source #
Instance details Defined in Cardano.CLI.Shelley.Commands Methods showsPrec ∷ Int → ProtocolParamsFile → ShowS Source # show ∷ ProtocolParamsFile → String Source # showList ∷ [ProtocolParamsFile] → ShowS Source #
Eq ProtocolParamsFile Source #
Instance details Defined in Cardano.CLI.Shelley.Commands Methods (==) ∷ ProtocolParamsFile → ProtocolParamsFile → Bool Source # (/=) ∷ ProtocolParamsFile → ProtocolParamsFile → Bool Source #

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.

Instances

Instances details

Show ProtocolParamsSourceSpec Source #
Instance details Defined in Cardano.CLI.Shelley.Commands Methods showsPrec ∷ Int → ProtocolParamsSourceSpec → ShowS Source # show ∷ ProtocolParamsSourceSpec → String Source # showList ∷ [ProtocolParamsSourceSpec] → ShowS Source #

newtype WitnessFile Source #

Constructors

WitnessFile FilePath

Instances

Instances details

Show WitnessFile Source #
Instance details Defined in Cardano.CLI.Shelley.Commands Methods showsPrec ∷ Int → WitnessFile → ShowS Source # show ∷ WitnessFile → String Source # showList ∷ [WitnessFile] → ShowS Source #

newtype TxFile Source #

Constructors

TxFile FilePath

Instances

Instances details

Show TxFile Source #
Instance details Defined in Cardano.CLI.Types Methods showsPrec ∷ Int → TxFile → ShowS Source # show ∷ TxFile → String Source # showList ∷ [TxFile] → ShowS Source #

data InputTxBodyOrTxFile Source #

Constructors

InputTxBodyFile TxBodyFile
InputTxFile TxFile

Instances

Instances details

Show InputTxBodyOrTxFile Source #
Instance details Defined in Cardano.CLI.Shelley.Commands Methods showsPrec ∷ Int → InputTxBodyOrTxFile → ShowS Source # show ∷ InputTxBodyOrTxFile → String Source # showList ∷ [InputTxBodyOrTxFile] → ShowS Source #

newtype VerificationKeyBase64 Source #

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

Constructors

VerificationKeyBase64 String

Instances

Instances details

Show VerificationKeyBase64 Source #
Instance details Defined in Cardano.CLI.Shelley.Commands Methods showsPrec ∷ Int → VerificationKeyBase64 → ShowS Source # show ∷ VerificationKeyBase64 → String Source # showList ∷ [VerificationKeyBase64] → ShowS Source #

newtype GenesisKeyFile Source #

Constructors

GenesisKeyFile FilePath

Instances

Instances details

Show GenesisKeyFile Source #
Instance details Defined in Cardano.CLI.Shelley.Commands Methods showsPrec ∷ Int → GenesisKeyFile → ShowS Source # show ∷ GenesisKeyFile → String Source # showList ∷ [GenesisKeyFile] → ShowS Source #

data MetadataFile Source #

Constructors

MetadataFileJSON FilePath
MetadataFileCBOR FilePath

Instances

Instances details

Show MetadataFile Source #
Instance details Defined in Cardano.CLI.Shelley.Commands Methods showsPrec ∷ Int → MetadataFile → ShowS Source # show ∷ MetadataFile → String Source # showList ∷ [MetadataFile] → ShowS Source #

newtype PoolMetadataFile Source #

Constructors

PoolMetadataFile
Fields unPoolMetadataFile ∷ FilePath

Instances

Instances details

Show PoolMetadataFile Source #
Instance details Defined in Cardano.CLI.Shelley.Commands Methods showsPrec ∷ Int → PoolMetadataFile → ShowS Source # show ∷ PoolMetadataFile → String Source # showList ∷ [PoolMetadataFile] → ShowS Source #

newtype PrivKeyFile Source #

Constructors

PrivKeyFile FilePath

Instances

Instances details

Show PrivKeyFile Source #
Instance details Defined in Cardano.CLI.Shelley.Commands Methods showsPrec ∷ Int → PrivKeyFile → ShowS Source # show ∷ PrivKeyFile → String Source # showList ∷ [PrivKeyFile] → ShowS Source #

newtype BlockId Source #

Constructors

BlockId String

Instances

Instances details

Show BlockId Source #
Instance details Defined in Cardano.CLI.Shelley.Commands Methods showsPrec ∷ Int → BlockId → ShowS Source # show ∷ BlockId → String Source # showList ∷ [BlockId] → ShowS Source #

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 Methods showsPrec ∷ Int → WitnessSigningData → ShowS Source # show ∷ WitnessSigningData → String Source # showList ∷ [WitnessSigningData] → ShowS Source #

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.

Constructors

ColdStakePoolVerificationKey !(VerificationKey StakePoolKey)
ColdGenesisDelegateVerificationKey !(VerificationKey GenesisDelegateKey)
ColdVerificationKeyFile !VerificationKeyFile

Instances

Instances details

Show ColdVerificationKeyOrFile Source #
Instance details Defined in Cardano.CLI.Shelley.Commands Methods showsPrec ∷ Int → ColdVerificationKeyOrFile → ShowS Source # show ∷ ColdVerificationKeyOrFile → String Source # showList ∷ [ColdVerificationKeyOrFile] → ShowS Source #

AddressCmd AddressCmd
StakeAddressCmd StakeAddressCmd
KeyCmd KeyCmd
TransactionCmd TransactionCmd
NodeCmd NodeCmd
PoolCmd PoolCmd
QueryCmd QueryCmd
GovernanceCmd GovernanceCmd
GenesisCmd GenesisCmd
TextViewCmd TextViewCmd

StakeAddressKeyGen VerificationKeyFile SigningKeyFile
StakeAddressKeyHash (VerificationKeyOrFile StakeKey) (Maybe OutputFile)
StakeAddressBuild StakeVerifier NetworkId (Maybe OutputFile)
StakeRegistrationCert StakeVerifier OutputFile
StakeCredentialDelegationCert StakeVerifier (VerificationKeyOrHashOrFile StakePoolKey) OutputFile
StakeCredentialDeRegistrationCert StakeVerifier OutputFile

KeyGetVerificationKey SigningKeyFile VerificationKeyFile
KeyNonExtendedKey VerificationKeyFile VerificationKeyFile
KeyConvertByronKey (Maybe Text) ByronKeyType SomeKeyFile OutputFile
KeyConvertByronGenesisVKey VerificationKeyBase64 OutputFile
KeyConvertITNStakeKey SomeKeyFile OutputFile
KeyConvertITNExtendedToStakeKey SomeKeyFile OutputFile
KeyConvertITNBip32ToStakeKey SomeKeyFile OutputFile
KeyConvertCardanoAddressSigningKey CardanoAddressKeyType SigningKeyFile OutputFile

NodeKeyGenCold VerificationKeyFile SigningKeyFile OpCertCounterFile
NodeKeyGenKES VerificationKeyFile SigningKeyFile
NodeKeyGenVRF VerificationKeyFile SigningKeyFile
NodeKeyHashVRF (VerificationKeyOrFile VrfKey) (Maybe OutputFile)
NodeNewCounter ColdVerificationKeyOrFile Word OpCertCounterFile
NodeIssueOpCert (VerificationKeyOrFile KesKey) SigningKeyFile OpCertCounterFile KESPeriod OutputFile

GovernanceMIRPayStakeAddressesCertificate MIRPot [StakeAddress] [Lovelace] OutputFile
GovernanceMIRTransfer Lovelace OutputFile TransferDirection
GovernanceGenesisKeyDelegationCertificate (VerificationKeyOrHashOrFile GenesisKey) (VerificationKeyOrHashOrFile GenesisDelegateKey) (VerificationKeyOrHashOrFile VrfKey) OutputFile
GovernanceUpdateProposal OutputFile EpochNo [VerificationKeyFile] ProtocolParametersUpdate (Maybe FilePath)