Safe Haskell | None |
---|---|
Language | Haskell2010 |
Cardano.CLI.Shelley.Commands
Contents
Description
Shelley CLI command types
Synopsis
- data ShelleyCommand
- data AddressCmd
- = AddressKeyGen AddressKeyType VerificationKeyFile SigningKeyFile
- | AddressKeyHash VerificationKeyTextOrFile (Maybe OutputFile)
- | AddressBuild VerificationKeyTextOrFile (Maybe (VerificationKeyOrFile StakeKey)) NetworkId (Maybe OutputFile)
- | AddressBuildMultiSig ScriptFile NetworkId (Maybe OutputFile)
- | AddressInfo Text (Maybe OutputFile)
- data StakeAddressCmd
- = StakeAddressKeyGen VerificationKeyFile SigningKeyFile
- | StakeAddressKeyHash (VerificationKeyOrFile StakeKey) (Maybe OutputFile)
- | StakeAddressBuild (VerificationKeyOrFile StakeKey) NetworkId (Maybe OutputFile)
- | StakeKeyRegistrationCert (VerificationKeyOrFile StakeKey) OutputFile
- | StakeKeyDelegationCert (VerificationKeyOrFile StakeKey) (VerificationKeyOrHashOrFile StakePoolKey) OutputFile
- | StakeKeyDeRegistrationCert (VerificationKeyOrFile StakeKey) 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 [TxIn] [TxOut Shelley] SlotNo Lovelace [CertificateFile] [(StakeAddress, Lovelace)] TxMetadataJsonSchema [MetaDataFile] (Maybe UpdateProposalFile) TxBodyFile
- | TxSign TxBodyFile [WitnessSigningData] (Maybe NetworkId) TxFile
- | TxCreateWitness TxBodyFile WitnessSigningData (Maybe NetworkId) OutputFile
- | TxAssembleTxBodyWitness TxBodyFile [WitnessFile] OutputFile
- | TxSubmit Protocol NetworkId FilePath
- | TxCalculateMinFee TxBodyFile (Maybe NetworkId) ProtocolParamsFile TxInCount TxOutCount TxShelleyWitnessCount TxByronWitnessCount
- | TxGetTxId TxBodyFile
- 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
- = QueryProtocolParameters Protocol NetworkId (Maybe OutputFile)
- | QueryTip Protocol NetworkId (Maybe OutputFile)
- | QueryStakeDistribution Protocol NetworkId (Maybe OutputFile)
- | QueryStakeAddressInfo Protocol StakeAddress NetworkId (Maybe OutputFile)
- | QueryUTxO Protocol QueryFilter NetworkId (Maybe OutputFile)
- | QueryLedgerState Protocol NetworkId (Maybe OutputFile)
- data GovernanceCmd
- = GovernanceMIRCertificate MIRPot [VerificationKeyFile] [Lovelace] OutputFile
- | GovernanceGenesisKeyDelegationCertificate (VerificationKeyOrHashOrFile GenesisKey) (VerificationKeyOrHashOrFile GenesisDelegateKey) (VerificationKeyOrHashOrFile VrfKey) OutputFile
- | GovernanceUpdateProposal OutputFile EpochNo [VerificationKeyFile] ProtocolParametersUpdate
- data GenesisCmd
- = GenesisCreate GenesisDir Word Word (Maybe SystemStart) (Maybe Lovelace) NetworkId
- | 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
- data ByronKeyType
- data ByronKeyFormat
- data CardanoAddressKeyType
- newtype GenesisDir = GenesisDir FilePath
- newtype TxInCount = TxInCount Int
- newtype TxOutCount = TxOutCount Int
- newtype TxShelleyWitnessCount = TxShelleyWitnessCount Int
- newtype TxByronWitnessCount = TxByronWitnessCount Int
- data SomeKeyFile
- newtype OpCertCounterFile = OpCertCounterFile FilePath
- newtype OutputFile = OutputFile FilePath
- newtype ProtocolParamsFile = ProtocolParamsFile FilePath
- newtype WitnessFile = WitnessFile FilePath
- newtype TxBodyFile = TxBodyFile FilePath
- newtype TxFile = TxFile FilePath
- newtype VerificationKeyBase64 = VerificationKeyBase64 String
- newtype GenesisKeyFile = GenesisKeyFile FilePath
- data MetaDataFile
- newtype PoolId = PoolId String
- newtype PoolMetaDataFile = PoolMetaDataFile {}
- newtype PrivKeyFile = PrivKeyFile FilePath
- newtype BlockId = BlockId String
- data WitnessSigningData
- data ColdVerificationKeyOrFile
- = ColdStakePoolVerificationKey !(VerificationKey StakePoolKey)
- | ColdGenesisDelegateVerificationKey !(VerificationKey GenesisDelegateKey)
- | ColdVerificationKeyFile !VerificationKeyFile
CLI command types
data ShelleyCommand Source #
All the CLI subcommands under "shelley".
Constructors
Instances
Eq ShelleyCommand Source # | |
Defined in Cardano.CLI.Shelley.Commands Methods (==) :: ShelleyCommand -> ShelleyCommand -> Bool # (/=) :: ShelleyCommand -> ShelleyCommand -> Bool # | |
Show ShelleyCommand Source # | |
Defined in Cardano.CLI.Shelley.Commands Methods showsPrec :: Int -> ShelleyCommand -> ShowS # show :: ShelleyCommand -> String # showList :: [ShelleyCommand] -> ShowS # |
data AddressCmd Source #
Constructors
Instances
Eq AddressCmd Source # | |
Defined in Cardano.CLI.Shelley.Commands | |
Show AddressCmd Source # | |
Defined in Cardano.CLI.Shelley.Commands Methods showsPrec :: Int -> AddressCmd -> ShowS # show :: AddressCmd -> String # showList :: [AddressCmd] -> ShowS # |
data StakeAddressCmd Source #
Constructors
Instances
Eq StakeAddressCmd Source # | |
Defined in Cardano.CLI.Shelley.Commands Methods (==) :: StakeAddressCmd -> StakeAddressCmd -> Bool # (/=) :: StakeAddressCmd -> StakeAddressCmd -> Bool # | |
Show StakeAddressCmd Source # | |
Defined in Cardano.CLI.Shelley.Commands Methods showsPrec :: Int -> StakeAddressCmd -> ShowS # show :: StakeAddressCmd -> String # showList :: [StakeAddressCmd] -> ShowS # |
Constructors
Instances
data TransactionCmd Source #
Constructors
Instances
Eq TransactionCmd Source # | |
Defined in Cardano.CLI.Shelley.Commands Methods (==) :: TransactionCmd -> TransactionCmd -> Bool # (/=) :: TransactionCmd -> TransactionCmd -> Bool # | |
Show TransactionCmd Source # | |
Defined in Cardano.CLI.Shelley.Commands Methods showsPrec :: Int -> TransactionCmd -> ShowS # show :: TransactionCmd -> String # showList :: [TransactionCmd] -> ShowS # |
Constructors
Constructors
PoolRegistrationCert | |
Fields
| |
PoolRetirementCert | |
Fields
| |
PoolGetId (VerificationKeyOrFile StakePoolKey) OutputFormat | |
PoolMetaDataHash PoolMetaDataFile (Maybe OutputFile) |
Constructors
data GovernanceCmd Source #
Constructors
Instances
Eq GovernanceCmd Source # | |
Defined in Cardano.CLI.Shelley.Commands Methods (==) :: GovernanceCmd -> GovernanceCmd -> Bool # (/=) :: GovernanceCmd -> GovernanceCmd -> Bool # | |
Show GovernanceCmd Source # | |
Defined in Cardano.CLI.Shelley.Commands Methods showsPrec :: Int -> GovernanceCmd -> ShowS # show :: GovernanceCmd -> String # showList :: [GovernanceCmd] -> ShowS # |
data GenesisCmd Source #
Constructors
Instances
Eq GenesisCmd Source # | |
Defined in Cardano.CLI.Shelley.Commands | |
Show GenesisCmd Source # | |
Defined in Cardano.CLI.Shelley.Commands Methods showsPrec :: Int -> GenesisCmd -> ShowS # show :: GenesisCmd -> String # showList :: [GenesisCmd] -> ShowS # |
data TextViewCmd Source #
Constructors
TextViewInfo !FilePath (Maybe OutputFile) |
Instances
Eq TextViewCmd Source # | |
Defined in Cardano.CLI.Shelley.Commands | |
Show TextViewCmd Source # | |
Defined in Cardano.CLI.Shelley.Commands Methods showsPrec :: Int -> TextViewCmd -> ShowS # show :: TextViewCmd -> String # showList :: [TextViewCmd] -> ShowS # |
CLI flag types
data AddressKeyType Source #
Instances
Eq AddressKeyType Source # | |
Defined in Cardano.CLI.Shelley.Commands Methods (==) :: AddressKeyType -> AddressKeyType -> Bool # (/=) :: AddressKeyType -> AddressKeyType -> Bool # | |
Show AddressKeyType Source # | |
Defined in Cardano.CLI.Shelley.Commands Methods showsPrec :: Int -> AddressKeyType -> ShowS # show :: AddressKeyType -> String # showList :: [AddressKeyType] -> ShowS # |
data ByronKeyType Source #
Constructors
ByronPaymentKey ByronKeyFormat | |
ByronGenesisKey ByronKeyFormat | |
ByronDelegateKey ByronKeyFormat |
Instances
Eq ByronKeyType Source # | |
Defined in Cardano.CLI.Shelley.Commands | |
Show ByronKeyType Source # | |
Defined in Cardano.CLI.Shelley.Commands Methods showsPrec :: Int -> ByronKeyType -> ShowS # show :: ByronKeyType -> String # showList :: [ByronKeyType] -> ShowS # |
data ByronKeyFormat Source #
Constructors
NonLegacyByronKeyFormat | |
LegacyByronKeyFormat |
Instances
Eq ByronKeyFormat Source # | |
Defined in Cardano.CLI.Shelley.Commands Methods (==) :: ByronKeyFormat -> ByronKeyFormat -> Bool # (/=) :: ByronKeyFormat -> ByronKeyFormat -> Bool # | |
Show ByronKeyFormat Source # | |
Defined in Cardano.CLI.Shelley.Commands Methods showsPrec :: Int -> ByronKeyFormat -> ShowS # show :: ByronKeyFormat -> String # showList :: [ByronKeyFormat] -> ShowS # |
data CardanoAddressKeyType Source #
The type of cardano-address
key.
Constructors
CardanoAddressShelleyPaymentKey | |
CardanoAddressShelleyStakeKey | |
CardanoAddressIcarusPaymentKey | |
CardanoAddressByronPaymentKey |
Instances
Eq CardanoAddressKeyType Source # | |
Defined in Cardano.CLI.Shelley.Commands Methods (==) :: CardanoAddressKeyType -> CardanoAddressKeyType -> Bool # (/=) :: CardanoAddressKeyType -> CardanoAddressKeyType -> Bool # | |
Show CardanoAddressKeyType Source # | |
Defined in Cardano.CLI.Shelley.Commands Methods showsPrec :: Int -> CardanoAddressKeyType -> ShowS # show :: CardanoAddressKeyType -> String # showList :: [CardanoAddressKeyType] -> ShowS # |
newtype GenesisDir Source #
Constructors
GenesisDir FilePath |
Instances
Eq GenesisDir Source # | |
Defined in Cardano.CLI.Shelley.Commands | |
Show GenesisDir Source # | |
Defined in Cardano.CLI.Shelley.Commands Methods showsPrec :: Int -> GenesisDir -> ShowS # show :: GenesisDir -> String # showList :: [GenesisDir] -> ShowS # |
newtype TxOutCount Source #
Constructors
TxOutCount Int |
Instances
Eq TxOutCount Source # | |
Defined in Cardano.CLI.Shelley.Commands | |
Show TxOutCount Source # | |
Defined in Cardano.CLI.Shelley.Commands Methods showsPrec :: Int -> TxOutCount -> ShowS # show :: TxOutCount -> String # showList :: [TxOutCount] -> ShowS # |
newtype TxShelleyWitnessCount Source #
Constructors
TxShelleyWitnessCount Int |
Instances
Eq TxShelleyWitnessCount Source # | |
Defined in Cardano.CLI.Shelley.Commands Methods (==) :: TxShelleyWitnessCount -> TxShelleyWitnessCount -> Bool # (/=) :: TxShelleyWitnessCount -> TxShelleyWitnessCount -> Bool # | |
Show TxShelleyWitnessCount Source # | |
Defined in Cardano.CLI.Shelley.Commands Methods showsPrec :: Int -> TxShelleyWitnessCount -> ShowS # show :: TxShelleyWitnessCount -> String # showList :: [TxShelleyWitnessCount] -> ShowS # |
newtype TxByronWitnessCount Source #
Constructors
TxByronWitnessCount Int |
Instances
Eq TxByronWitnessCount Source # | |
Defined in Cardano.CLI.Shelley.Commands Methods (==) :: TxByronWitnessCount -> TxByronWitnessCount -> Bool # (/=) :: TxByronWitnessCount -> TxByronWitnessCount -> Bool # | |
Show TxByronWitnessCount Source # | |
Defined in Cardano.CLI.Shelley.Commands Methods showsPrec :: Int -> TxByronWitnessCount -> ShowS # show :: TxByronWitnessCount -> String # showList :: [TxByronWitnessCount] -> ShowS # |
data SomeKeyFile Source #
Either a verification or signing key, used for conversions and other commands that make sense for both.
Instances
Eq SomeKeyFile Source # | |
Defined in Cardano.CLI.Shelley.Commands | |
Show SomeKeyFile Source # | |
Defined in Cardano.CLI.Shelley.Commands Methods showsPrec :: Int -> SomeKeyFile -> ShowS # show :: SomeKeyFile -> String # showList :: [SomeKeyFile] -> ShowS # |
newtype OpCertCounterFile Source #
Constructors
OpCertCounterFile FilePath |
Instances
Eq OpCertCounterFile Source # | |
Defined in Cardano.CLI.Shelley.Commands Methods (==) :: OpCertCounterFile -> OpCertCounterFile -> Bool # (/=) :: OpCertCounterFile -> OpCertCounterFile -> Bool # | |
Show OpCertCounterFile Source # | |
Defined in Cardano.CLI.Shelley.Commands Methods showsPrec :: Int -> OpCertCounterFile -> ShowS # show :: OpCertCounterFile -> String # showList :: [OpCertCounterFile] -> ShowS # |
newtype OutputFile Source #
Constructors
OutputFile FilePath |
Instances
Eq OutputFile Source # | |
Defined in Cardano.CLI.Shelley.Commands | |
Show OutputFile Source # | |
Defined in Cardano.CLI.Shelley.Commands Methods showsPrec :: Int -> OutputFile -> ShowS # show :: OutputFile -> String # showList :: [OutputFile] -> ShowS # |
newtype ProtocolParamsFile Source #
Constructors
ProtocolParamsFile FilePath |
Instances
Eq ProtocolParamsFile Source # | |
Defined in Cardano.CLI.Shelley.Commands Methods (==) :: ProtocolParamsFile -> ProtocolParamsFile -> Bool # (/=) :: ProtocolParamsFile -> ProtocolParamsFile -> Bool # | |
Show ProtocolParamsFile Source # | |
Defined in Cardano.CLI.Shelley.Commands Methods showsPrec :: Int -> ProtocolParamsFile -> ShowS # show :: ProtocolParamsFile -> String # showList :: [ProtocolParamsFile] -> ShowS # |
newtype WitnessFile Source #
Constructors
WitnessFile FilePath |
Instances
Eq WitnessFile Source # | |
Defined in Cardano.CLI.Shelley.Commands | |
Show WitnessFile Source # | |
Defined in Cardano.CLI.Shelley.Commands Methods showsPrec :: Int -> WitnessFile -> ShowS # show :: WitnessFile -> String # showList :: [WitnessFile] -> ShowS # |
newtype TxBodyFile Source #
Constructors
TxBodyFile FilePath |
Instances
Eq TxBodyFile Source # | |
Defined in Cardano.CLI.Shelley.Commands | |
Show TxBodyFile Source # | |
Defined in Cardano.CLI.Shelley.Commands Methods showsPrec :: Int -> TxBodyFile -> ShowS # show :: TxBodyFile -> String # showList :: [TxBodyFile] -> ShowS # |
Instances
newtype VerificationKeyBase64 Source #
A raw verification key given in Base64, and decoded into a ByteString.
Constructors
VerificationKeyBase64 String |
Instances
Eq VerificationKeyBase64 Source # | |
Defined in Cardano.CLI.Shelley.Commands Methods (==) :: VerificationKeyBase64 -> VerificationKeyBase64 -> Bool # (/=) :: VerificationKeyBase64 -> VerificationKeyBase64 -> Bool # | |
Show VerificationKeyBase64 Source # | |
Defined in Cardano.CLI.Shelley.Commands Methods showsPrec :: Int -> VerificationKeyBase64 -> ShowS # show :: VerificationKeyBase64 -> String # showList :: [VerificationKeyBase64] -> ShowS # |
newtype GenesisKeyFile Source #
Constructors
GenesisKeyFile FilePath |
Instances
Eq GenesisKeyFile Source # | |
Defined in Cardano.CLI.Shelley.Commands Methods (==) :: GenesisKeyFile -> GenesisKeyFile -> Bool # (/=) :: GenesisKeyFile -> GenesisKeyFile -> Bool # | |
Show GenesisKeyFile Source # | |
Defined in Cardano.CLI.Shelley.Commands Methods showsPrec :: Int -> GenesisKeyFile -> ShowS # show :: GenesisKeyFile -> String # showList :: [GenesisKeyFile] -> ShowS # |
data MetaDataFile Source #
Constructors
MetaDataFileJSON FilePath | |
MetaDataFileCBOR FilePath |
Instances
Eq MetaDataFile Source # | |
Defined in Cardano.CLI.Shelley.Commands | |
Show MetaDataFile Source # | |
Defined in Cardano.CLI.Shelley.Commands Methods showsPrec :: Int -> MetaDataFile -> ShowS # show :: MetaDataFile -> String # showList :: [MetaDataFile] -> ShowS # |
Instances
newtype PoolMetaDataFile Source #
Constructors
PoolMetaDataFile | |
Fields |
Instances
Eq PoolMetaDataFile Source # | |
Defined in Cardano.CLI.Shelley.Commands Methods (==) :: PoolMetaDataFile -> PoolMetaDataFile -> Bool # (/=) :: PoolMetaDataFile -> PoolMetaDataFile -> Bool # | |
Show PoolMetaDataFile Source # | |
Defined in Cardano.CLI.Shelley.Commands Methods showsPrec :: Int -> PoolMetaDataFile -> ShowS # show :: PoolMetaDataFile -> String # showList :: [PoolMetaDataFile] -> ShowS # |
newtype PrivKeyFile Source #
Constructors
PrivKeyFile FilePath |
Instances
Eq PrivKeyFile Source # | |
Defined in Cardano.CLI.Shelley.Commands | |
Show PrivKeyFile Source # | |
Defined in Cardano.CLI.Shelley.Commands Methods showsPrec :: Int -> PrivKeyFile -> ShowS # show :: PrivKeyFile -> String # showList :: [PrivKeyFile] -> ShowS # |
data WitnessSigningData Source #
Data required to construct a witness.
Constructors
KeyWitnessSigningData | |
Fields
| |
ScriptWitnessSigningData !ScriptFile |
Instances
Eq WitnessSigningData Source # | |
Defined in Cardano.CLI.Shelley.Commands Methods (==) :: WitnessSigningData -> WitnessSigningData -> Bool # (/=) :: WitnessSigningData -> WitnessSigningData -> Bool # | |
Show WitnessSigningData Source # | |
Defined in Cardano.CLI.Shelley.Commands Methods showsPrec :: Int -> WitnessSigningData -> ShowS # show :: WitnessSigningData -> String # showList :: [WitnessSigningData] -> ShowS # |
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
Eq ColdVerificationKeyOrFile Source # | |
Defined in Cardano.CLI.Shelley.Commands Methods (==) :: ColdVerificationKeyOrFile -> ColdVerificationKeyOrFile -> Bool # (/=) :: ColdVerificationKeyOrFile -> ColdVerificationKeyOrFile -> Bool # | |
Show ColdVerificationKeyOrFile Source # | |
Defined in Cardano.CLI.Shelley.Commands Methods showsPrec :: Int -> ColdVerificationKeyOrFile -> ShowS # show :: ColdVerificationKeyOrFile -> String # showList :: [ColdVerificationKeyOrFile] -> ShowS # |