Safe Haskell	None
Language	Haskell2010

Cardano.CLI.EraIndependent.Key.Command

Synopsis

data KeyCmds
data KeyVerificationKeyCmdArgs = KeyVerificationKeyCmdArgs {
- skeyFile :: !(SigningKeyFile 'In)
- vkeyFile :: !(VerificationKeyFile 'Out)
}
data KeyNonExtendedKeyCmdArgs = KeyNonExtendedKeyCmdArgs {
- extendedVkeyFileIn :: !(VerificationKeyFile 'In)
- nonExtendedVkeyFileOut :: !(VerificationKeyFile 'Out)
}
data KeyGenerateMnemonicCmdArgs = KeyGenerateMnemonicCmdArgs {
- mnemonicOutputFormat :: !(Maybe (File () 'Out))
- mnemonicWords :: !MnemonicSize
}
data KeyExtendedSigningKeyFromMnemonicArgs = KeyExtendedSigningKeyFromMnemonicArgs {
- keyOutputFormat :: !KeyOutputFormat
- derivedExtendedSigningKeyType :: !ExtendedSigningType
- derivationAccountNo :: !Word32
- mnemonicSource :: !MnemonicSource
- signingKeyFileOut :: !(SigningKeyFile 'Out)
}
data ExtendedSigningType
data MnemonicSource
- = MnemonicFromFile !(File () 'In)
- | MnemonicFromInteractivePrompt
data KeyConvertByronKeyCmdArgs = KeyConvertByronKeyCmdArgs {
- mPassword :: !(Maybe Text)
- byronKeyType :: !ByronKeyType
- someKeyFileIn :: !(SomeKeyFile 'In)
- someKeyFileOut :: !(File () 'Out)
}
data KeyConvertByronGenesisVKeyCmdArgs = KeyConvertByronGenesisVKeyCmdArgs {
- vkey :: !VerificationKeyBase64
- vkeyFileOut :: !(File () 'Out)
}
data KeyConvertITNKeyCmdArgs = KeyConvertITNKeyCmdArgs {
- itnKeyFile :: !(SomeKeyFile 'In)
- outFile :: !(File () 'Out)
}
data KeyConvertITNExtendedKeyCmdArgs = KeyConvertITNExtendedKeyCmdArgs {
- itnPrivKeyFile :: !(SomeKeyFile 'In)
- outFile :: !(File () 'Out)
}
data KeyConvertITNBip32KeyCmdArgs = KeyConvertITNBip32KeyCmdArgs {
- itnPrivKeyFile :: !(SomeKeyFile 'In)
- outFile :: !(File () 'Out)
}
data KeyConvertCardanoAddressKeyCmdArgs = KeyConvertCardanoAddressKeyCmdArgs {
- cardanoAddressKeyType :: !CardanoAddressKeyType
- skeyFileIn :: !(SigningKeyFile 'In)
- skeyFileOut :: !(File () 'Out)
}
renderKeyCmds :: KeyCmds -> Text

Documentation

data KeyCmds Source #

Instances

Instances details

Show KeyCmds Source #
Instance details Defined in Cardano.CLI.EraIndependent.Key.Command Methods showsPrec :: Int -> KeyCmds -> ShowS Source # show :: KeyCmds -> String Source # showList :: [KeyCmds] -> ShowS Source #

data KeyVerificationKeyCmdArgs Source #

Get a verification key from a signing key. This supports all key types

Constructors

KeyVerificationKeyCmdArgs
Fields skeyFile :: !(SigningKeyFile 'In) Input filepath of the signing key vkeyFile :: !(VerificationKeyFile 'Out) Output filepath of the verification key

Instances

Instances details

Show KeyVerificationKeyCmdArgs Source #
Instance details Defined in Cardano.CLI.EraIndependent.Key.Command Methods showsPrec :: Int -> KeyVerificationKeyCmdArgs -> ShowS Source # show :: KeyVerificationKeyCmdArgs -> String Source # showList :: [KeyVerificationKeyCmdArgs] -> ShowS Source #

data KeyNonExtendedKeyCmdArgs Source #

Get a non-extended verification key from an extended verification key. This supports all extended key types.

Constructors

KeyNonExtendedKeyCmdArgs
Fields extendedVkeyFileIn :: !(VerificationKeyFile 'In) Input filepath of the ed25519-bip32 verification key nonExtendedVkeyFileOut :: !(VerificationKeyFile 'Out) Output filepath of the verification key

Instances

Instances details

Show KeyNonExtendedKeyCmdArgs Source #
Instance details Defined in Cardano.CLI.EraIndependent.Key.Command Methods showsPrec :: Int -> KeyNonExtendedKeyCmdArgs -> ShowS Source # show :: KeyNonExtendedKeyCmdArgs -> String Source # showList :: [KeyNonExtendedKeyCmdArgs] -> ShowS Source #

data KeyGenerateMnemonicCmdArgs Source #

Generate a mnemonic phrase that can be used to derive signing keys.

Constructors

KeyGenerateMnemonicCmdArgs
Fields mnemonicOutputFormat :: !(Maybe (File () 'Out)) Output format for the mnemonic phrase mnemonicWords :: !MnemonicSize Number of mnemonic words to generate it must be one of: 12, 15, 18, 21, or 24.

Instances

Instances details

Show KeyGenerateMnemonicCmdArgs Source #
Instance details Defined in Cardano.CLI.EraIndependent.Key.Command Methods showsPrec :: Int -> KeyGenerateMnemonicCmdArgs -> ShowS Source # show :: KeyGenerateMnemonicCmdArgs -> String Source # showList :: [KeyGenerateMnemonicCmdArgs] -> ShowS Source #

data KeyExtendedSigningKeyFromMnemonicArgs Source #

Get an extended signing key from a mnemonic.

Constructors

KeyExtendedSigningKeyFromMnemonicArgs
Fields keyOutputFormat :: !KeyOutputFormat derivedExtendedSigningKeyType :: !ExtendedSigningType derivationAccountNo :: !Word32 mnemonicSource :: !MnemonicSource signingKeyFileOut :: !(SigningKeyFile 'Out)

Instances

Instances details

Show KeyExtendedSigningKeyFromMnemonicArgs Source #
Instance details Defined in Cardano.CLI.EraIndependent.Key.Command Methods showsPrec :: Int -> KeyExtendedSigningKeyFromMnemonicArgs -> ShowS Source # show :: KeyExtendedSigningKeyFromMnemonicArgs -> String Source # showList :: [KeyExtendedSigningKeyFromMnemonicArgs] -> ShowS Source #

data ExtendedSigningType Source #

Type of the key derived from a mnemonic together with the payment key number in the derivation path for cases where it is applicable.

Constructors

ExtendedSigningPaymentKey !Word32
ExtendedSigningStakeKey !Word32
ExtendedSigningDRepKey
ExtendedSigningCCColdKey
ExtendedSigningCCHotKey

Instances

Instances details

Show ExtendedSigningType Source #
Instance details Defined in Cardano.CLI.EraIndependent.Key.Command Methods showsPrec :: Int -> ExtendedSigningType -> ShowS Source # show :: ExtendedSigningType -> String Source # showList :: [ExtendedSigningType] -> ShowS Source #

data MnemonicSource Source #

Constructors

MnemonicFromFile !(File () 'In)
MnemonicFromInteractivePrompt

Instances

Instances details

Show MnemonicSource Source #
Instance details Defined in Cardano.CLI.EraIndependent.Key.Command Methods showsPrec :: Int -> MnemonicSource -> ShowS Source # show :: MnemonicSource -> String Source # showList :: [MnemonicSource] -> ShowS Source #

data KeyConvertByronKeyCmdArgs Source #

Convert a Byron payment, genesis or genesis delegate key (signing or verification) to a corresponding Shelley-format key.

Constructors

KeyConvertByronKeyCmdArgs
Fields mPassword :: !(Maybe Text) Password for signing key (if applicable) byronKeyType :: !ByronKeyType The byron key type of the input file someKeyFileIn :: !(SomeKeyFile 'In) Input file containing the byron key someKeyFileOut :: !(File () 'Out) The output file to which the Shelley-format key will be written

Instances

Instances details

Show KeyConvertByronKeyCmdArgs Source #
Instance details Defined in Cardano.CLI.EraIndependent.Key.Command Methods showsPrec :: Int -> KeyConvertByronKeyCmdArgs -> ShowS Source # show :: KeyConvertByronKeyCmdArgs -> String Source # showList :: [KeyConvertByronKeyCmdArgs] -> ShowS Source #

data KeyConvertByronGenesisVKeyCmdArgs Source #

Constructors

KeyConvertByronGenesisVKeyCmdArgs
Fields vkey :: !VerificationKeyBase64 Base64 string for the Byron genesis verification key vkeyFileOut :: !(File () 'Out) The output file

Instances

Instances details

Show KeyConvertByronGenesisVKeyCmdArgs Source #
Instance details Defined in Cardano.CLI.EraIndependent.Key.Command Methods showsPrec :: Int -> KeyConvertByronGenesisVKeyCmdArgs -> ShowS Source # show :: KeyConvertByronGenesisVKeyCmdArgs -> String Source # showList :: [KeyConvertByronGenesisVKeyCmdArgs] -> ShowS Source #

data KeyConvertITNKeyCmdArgs Source #

Convert an Incentivized Testnet (ITN) non-extended (Ed25519) signing or verification key to a corresponding Shelley stake key

Constructors

KeyConvertITNKeyCmdArgs
Fields itnKeyFile :: !(SomeKeyFile 'In) Filepath of the ITN key (signing or verification) outFile :: !(File () 'Out) The output file

Instances

Instances details

Show KeyConvertITNKeyCmdArgs Source #
Instance details Defined in Cardano.CLI.EraIndependent.Key.Command Methods showsPrec :: Int -> KeyConvertITNKeyCmdArgs -> ShowS Source # show :: KeyConvertITNKeyCmdArgs -> String Source # showList :: [KeyConvertITNKeyCmdArgs] -> ShowS Source #

data KeyConvertITNExtendedKeyCmdArgs Source #

Convert an Incentivized Testnet (ITN) extended (Ed25519Extended) signing key to a corresponding Shelley stake signing key

Constructors

KeyConvertITNExtendedKeyCmdArgs
Fields itnPrivKeyFile :: !(SomeKeyFile 'In) Filepath of the ITN signing key outFile :: !(File () 'Out) The output file

Instances

Instances details

Show KeyConvertITNExtendedKeyCmdArgs Source #
Instance details Defined in Cardano.CLI.EraIndependent.Key.Command Methods showsPrec :: Int -> KeyConvertITNExtendedKeyCmdArgs -> ShowS Source # show :: KeyConvertITNExtendedKeyCmdArgs -> String Source # showList :: [KeyConvertITNExtendedKeyCmdArgs] -> ShowS Source #

data KeyConvertITNBip32KeyCmdArgs Source #

Convert an Incentivized Testnet (ITN) BIP32 (Ed25519Bip32) signing key to a corresponding Shelley stake signing key

Constructors

KeyConvertITNBip32KeyCmdArgs
Fields itnPrivKeyFile :: !(SomeKeyFile 'In) Filepath of the ITN signing key outFile :: !(File () 'Out) The output file

Instances

Instances details

Show KeyConvertITNBip32KeyCmdArgs Source #
Instance details Defined in Cardano.CLI.EraIndependent.Key.Command Methods showsPrec :: Int -> KeyConvertITNBip32KeyCmdArgs -> ShowS Source # show :: KeyConvertITNBip32KeyCmdArgs -> String Source # showList :: [KeyConvertITNBip32KeyCmdArgs] -> ShowS Source #

data KeyConvertCardanoAddressKeyCmdArgs Source #

Convert a cardano-address extended signing key to a corresponding Shelley-format key

Constructors

KeyConvertCardanoAddressKeyCmdArgs
Fields cardanoAddressKeyType :: !CardanoAddressKeyType Address key type of th signing key input file skeyFileIn :: !(SigningKeyFile 'In) Input filepath of the signing key skeyFileOut :: !(File () 'Out) The output file

Instances

Instances details

Show KeyConvertCardanoAddressKeyCmdArgs Source #
Instance details Defined in Cardano.CLI.EraIndependent.Key.Command Methods showsPrec :: Int -> KeyConvertCardanoAddressKeyCmdArgs -> ShowS Source # show :: KeyConvertCardanoAddressKeyCmdArgs -> String Source # showList :: [KeyConvertCardanoAddressKeyCmdArgs] -> ShowS Source #

renderKeyCmds :: KeyCmds -> Text Source #

KeyVerificationKeyCmd !KeyVerificationKeyCmdArgs
KeyNonExtendedKeyCmd !KeyNonExtendedKeyCmdArgs
KeyGenerateMnemonicCmd !KeyGenerateMnemonicCmdArgs
KeyExtendedSigningKeyFromMnemonicCmd !KeyExtendedSigningKeyFromMnemonicArgs
KeyConvertByronKeyCmd !KeyConvertByronKeyCmdArgs
KeyConvertByronGenesisVKeyCmd !KeyConvertByronGenesisVKeyCmdArgs
KeyConvertITNKeyCmd !KeyConvertITNKeyCmdArgs
KeyConvertITNExtendedKeyCmd !KeyConvertITNExtendedKeyCmdArgs
KeyConvertITNBip32KeyCmd !KeyConvertITNBip32KeyCmdArgs
KeyConvertCardanoAddressKeyCmd !KeyConvertCardanoAddressKeyCmdArgs

Key	Shortcut
s	Open this search box
esc	Close this search box
↓,ctrl + j	Move down in search results
↑,ctrl + k	Move up in search results
↵	Go to active search result