Safe Haskell | Safe-Inferred |
---|---|
Language | Haskell2010 |
Synopsis
- data AllOrOnly a
- data AddressKeyType
- data BalanceTxExecUnits
- newtype BlockId = BlockId String
- data ByronKeyFormat
- data ByronKeyType
- data CardanoAddressKeyType
- data CBORObject
- newtype CertificateFile = CertificateFile {}
- data ConstitutionHashSource
- newtype ConstitutionText = ConstitutionText {}
- newtype ConstitutionUrl = ConstitutionUrl {}
- data CredentialGenerationMode
- newtype CurrentKesPeriod = CurrentKesPeriod {}
- data DRepCredentials = DRepCredentials {}
- data EpochLeadershipSchedule
- newtype File content (direction ∷ FileDirection) = File {}
- data FileDirection
- newtype GenesisDir = GenesisDir FilePath
- newtype GenesisFile = GenesisFile {}
- newtype GenesisKeyFile = GenesisKeyFile FilePath
- data InputTxBodyOrTxFile
- = InputTxBodyFile (TxBodyFile In)
- | InputTxFile (TxFile In)
- data KeyOutputFormat
- data MetadataFile
- = MetadataFileJSON (File () In)
- | MetadataFileCBOR (File () In)
- data OpCertCounter
- type OpCertCounterFile = File OpCertCounter
- newtype OpCertEndingKesPeriod = OpCertEndingKesPeriod {}
- data OpCertIntervalInformation
- = OpCertWithinInterval OpCertStartingKesPeriod OpCertEndingKesPeriod CurrentKesPeriod SlotsTillKesKeyExpiry
- | OpCertStartingKesPeriodIsInTheFuture OpCertStartingKesPeriod OpCertEndingKesPeriod CurrentKesPeriod
- | OpCertExpired OpCertStartingKesPeriod OpCertEndingKesPeriod CurrentKesPeriod
- | OpCertSomeOtherError OpCertStartingKesPeriod OpCertEndingKesPeriod CurrentKesPeriod
- data OpCertNodeAndOnDiskCounterInformation
- = OpCertOnDiskCounterEqualToNodeState OpCertOnDiskCounter OpCertNodeStateCounter
- | OpCertOnDiskCounterAheadOfNodeState OpCertOnDiskCounter OpCertNodeStateCounter
- | OpCertOnDiskCounterTooFarAheadOfNodeState OpCertOnDiskCounter OpCertNodeStateCounter
- | OpCertOnDiskCounterBehindNodeState OpCertOnDiskCounter OpCertNodeStateCounter
- | OpCertNoBlocksMintedYet OpCertOnDiskCounter
- newtype OpCertNodeStateCounter = OpCertNodeStateCounter {}
- newtype OpCertOnDiskCounter = OpCertOnDiskCounter {}
- newtype OpCertStartingKesPeriod = OpCertStartingKesPeriod {}
- data Params crypto = Params {
- poolParameters ∷ Maybe (PoolParams crypto)
- futurePoolParameters ∷ Maybe (PoolParams crypto)
- retiringEpoch ∷ Maybe EpochNo
- data ParserFileDirection
- data IdOutputFormat
- newtype PrivKeyFile = PrivKeyFile FilePath
- data ProposalBinary
- type ProposalFile = File ()
- data ProposalText
- newtype ProposalUrl = ProposalUrl {}
- newtype ProtocolParamsFile = ProtocolParamsFile FilePath
- data QueryOutputFormat
- data ReferenceScriptAnyEra
- newtype ReferenceScriptSize = ReferenceScriptSize {}
- data RequiredSigner
- data ScriptDataOrFile
- data ScriptDatumOrFile witctx where
- type ScriptFile = File ScriptInAnyLang In
- type ScriptRedeemerOrFile = ScriptDataOrFile
- data ScriptWitnessFiles witctx where
- SimpleScriptWitnessFile ∷ ScriptFile → ScriptWitnessFiles witctx
- PlutusScriptWitnessFiles ∷ ScriptFile → ScriptDatumOrFile witctx → ScriptRedeemerOrFile → ExecutionUnits → ScriptWitnessFiles witctx
- PlutusReferenceScriptWitnessFiles ∷ TxIn → AnyScriptLanguage → ScriptDatumOrFile witctx → ScriptRedeemerOrFile → ExecutionUnits → Maybe PolicyId → ScriptWitnessFiles witctx
- SimpleReferenceScriptWitnessFiles ∷ TxIn → AnyScriptLanguage → Maybe PolicyId → ScriptWitnessFiles witctx
- type SigningKeyFile = File (SigningKey ())
- newtype SlotsTillKesKeyExpiry = SlotsTillKesKeyExpiry {}
- data SomeKeyFile direction
- = AVerificationKeyFile (VerificationKeyFile direction)
- | ASigningKeyFile (SigningKeyFile direction)
- data StakeDelegators = StakeDelegators {}
- type StakePoolMetadataFile = File StakePoolMetadata
- data TransferDirection
- type TxBodyFile = File (TxBody ())
- data TxBuildOutputOptions
- = OutputScriptCostOnly (File () Out)
- | OutputTxBodyOnly (TxBodyFile Out)
- newtype TxByronWitnessCount = TxByronWitnessCount Int
- type TxFile = File (Tx ())
- newtype TxInCount = TxInCount Int
- data TxMempoolQuery
- data TxOutAnyEra = TxOutAnyEra AddressAny Value TxOutDatumAnyEra ReferenceScriptAnyEra
- data TxOutShelleyBasedEra = TxOutShelleyBasedEra !(Address ShelleyAddr) Value TxOutDatumAnyEra ReferenceScriptAnyEra
- newtype TxOutChangeAddress = TxOutChangeAddress AddressAny
- newtype TxOutCount = TxOutCount Int
- data TxOutDatumAnyEra
- newtype TxShelleyWitnessCount = TxShelleyWitnessCount Int
- newtype UpdateProposalFile = UpdateProposalFile {}
- newtype VerificationKeyBase64 = VerificationKeyBase64 String
- type VerificationKeyFile = File (VerificationKey ())
- data ViewOutputFormat
- newtype VoteUrl = VoteUrl {}
- newtype VoteText = VoteText {}
- data VoteHashSource
- newtype WitnessFile = WitnessFile FilePath
- data WitnessSigningData = KeyWitnessSigningData !(SigningKeyFile In) !(Maybe (Address ByronAddr))
- type DRepMetadataFile = File DRepMetadata
Documentation
data AddressKeyType Source #
Instances
Show AddressKeyType Source # | |
Defined in Cardano.CLI.Types.Common |
data BalanceTxExecUnits Source #
A flag that differentiates between automatically and manually balancing a tx.
data ByronKeyFormat Source #
Instances
Show ByronKeyFormat Source # | |
Defined in Cardano.CLI.Types.Common |
data ByronKeyType Source #
Instances
Show ByronKeyType Source # | |
Defined in Cardano.CLI.Types.Common |
data CardanoAddressKeyType Source #
The type of cardano-address
key.
Instances
Show CardanoAddressKeyType Source # | |
Defined in Cardano.CLI.Types.Common |
data CBORObject Source #
Specify what the CBOR file is i.e a block, a tx, etc
CBORBlockByron EpochSlots | |
CBORDelegationCertificateByron | |
CBORTxByron | |
CBORUpdateProposalByron | |
CBORVoteByron |
Instances
Show CBORObject Source # | |
Defined in Cardano.CLI.Types.Common |
newtype CertificateFile Source #
Instances
Show CertificateFile Source # | |
Defined in Cardano.CLI.Types.Common | |
Eq CertificateFile Source # | |
Defined in Cardano.CLI.Types.Common |
data ConstitutionHashSource Source #
ConstitutionHashSourceFile (File ConstitutionText In) | |
ConstitutionHashSourceText Text | |
ConstitutionHashSourceHash (SafeHash StandardCrypto AnchorData) |
Instances
newtype ConstitutionText Source #
Instances
Show ConstitutionText Source # | |
Defined in Cardano.CLI.Types.Common | |
Eq ConstitutionText Source # | |
Defined in Cardano.CLI.Types.Common |
newtype ConstitutionUrl Source #
Instances
Show ConstitutionUrl Source # | |
Defined in Cardano.CLI.Types.Common | |
Eq ConstitutionUrl Source # | |
Defined in Cardano.CLI.Types.Common |
data CredentialGenerationMode Source #
Instances
newtype CurrentKesPeriod Source #
Instances
FromJSON CurrentKesPeriod Source # | |
ToJSON CurrentKesPeriod Source # | |
Defined in Cardano.CLI.Types.Common | |
Show CurrentKesPeriod Source # | |
Defined in Cardano.CLI.Types.Common | |
Eq CurrentKesPeriod Source # | |
Defined in Cardano.CLI.Types.Common |
data DRepCredentials Source #
DRepCredentials | |
|
Instances
Show DRepCredentials Source # | |
Defined in Cardano.CLI.Types.Common |
data EpochLeadershipSchedule Source #
Which leadership schedule we are interested in. TODO: Implement Previous and Next epochs
Instances
newtype File content (direction ∷ FileDirection) Source #
A file path with additional type information to indicate what the file is meant to contain and whether it is to be used for reading or writing.
Instances
FromJSON (File content direction) | |
ToJSON (File content direction) | |
IsString (File content direction) | |
Defined in Cardano.Api.IO.Base fromString ∷ String → File content direction Source # | |
Read (File content direction) | |
Show (File content direction) | |
Eq (File content direction) | |
Ord (File content direction) | |
Defined in Cardano.Api.IO.Base 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 Source #
newtype GenesisDir Source #
Instances
Show GenesisDir Source # | |
Defined in Cardano.CLI.Types.Common |
newtype GenesisFile Source #
Instances
FromJSON GenesisFile Source # | |
Defined in Cardano.CLI.Types.Common | |
IsString GenesisFile Source # | |
Defined in Cardano.CLI.Types.Common | |
Show GenesisFile Source # | |
Defined in Cardano.CLI.Types.Common | |
Eq GenesisFile Source # | |
Defined in Cardano.CLI.Types.Common (==) ∷ GenesisFile → GenesisFile → Bool Source # (/=) ∷ GenesisFile → GenesisFile → Bool Source # | |
Ord GenesisFile Source # | |
Defined in Cardano.CLI.Types.Common compare ∷ GenesisFile → GenesisFile → Ordering Source # (<) ∷ GenesisFile → GenesisFile → Bool Source # (<=) ∷ GenesisFile → GenesisFile → Bool Source # (>) ∷ GenesisFile → GenesisFile → Bool Source # (>=) ∷ GenesisFile → GenesisFile → Bool Source # max ∷ GenesisFile → GenesisFile → GenesisFile Source # min ∷ GenesisFile → GenesisFile → GenesisFile Source # |
newtype GenesisKeyFile Source #
Instances
Show GenesisKeyFile Source # | |
Defined in Cardano.CLI.Types.Common |
data InputTxBodyOrTxFile Source #
Instances
Show InputTxBodyOrTxFile Source # | |
Defined in Cardano.CLI.Types.Common |
data KeyOutputFormat Source #
Instances
Show KeyOutputFormat Source # | |
Defined in Cardano.CLI.Types.Common | |
Eq KeyOutputFormat Source # | |
Defined in Cardano.CLI.Types.Common |
data MetadataFile Source #
MetadataFileJSON (File () In) | |
MetadataFileCBOR (File () In) |
Instances
Show MetadataFile Source # | |
Defined in Cardano.CLI.Types.Common |
data OpCertCounter Source #
type OpCertCounterFile = File OpCertCounter Source #
newtype OpCertEndingKesPeriod Source #
data OpCertIntervalInformation Source #
Instances
data OpCertNodeAndOnDiskCounterInformation Source #
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. |
newtype OpCertNodeStateCounter Source #
Instances
newtype OpCertOnDiskCounter Source #
Instances
newtype OpCertStartingKesPeriod Source #
Instances
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.
Params | |
|
data ParserFileDirection Source #
Instances
Show ParserFileDirection Source # | |
Defined in Cardano.CLI.Types.Common | |
Eq ParserFileDirection Source # | |
Defined in Cardano.CLI.Types.Common |
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.
Instances
Show IdOutputFormat Source # | |
Defined in Cardano.CLI.Types.Common | |
Eq IdOutputFormat Source # | |
Defined in Cardano.CLI.Types.Common (==) ∷ IdOutputFormat → IdOutputFormat → Bool Source # (/=) ∷ IdOutputFormat → IdOutputFormat → Bool Source # |
newtype PrivKeyFile Source #
Instances
Show PrivKeyFile Source # | |
Defined in Cardano.CLI.Types.Common |
data ProposalBinary Source #
Tag for tracking proposals submitted as Bytestring
type ProposalFile = File () Source #
data ProposalText Source #
Tag for tracking proposals submitted as Text
newtype ProposalUrl Source #
Instances
Show ProposalUrl Source # | |
Defined in Cardano.CLI.Types.Common | |
Eq ProposalUrl Source # | |
Defined in Cardano.CLI.Types.Common (==) ∷ ProposalUrl → ProposalUrl → Bool Source # (/=) ∷ ProposalUrl → ProposalUrl → Bool Source # |
newtype ProtocolParamsFile Source #
Instances
Show ProtocolParamsFile Source # | |
Defined in Cardano.CLI.Types.Common | |
Eq ProtocolParamsFile Source # | |
Defined in Cardano.CLI.Types.Common |
data QueryOutputFormat Source #
Instances
Show QueryOutputFormat Source # | |
Defined in Cardano.CLI.Types.Common |
data ReferenceScriptAnyEra Source #
Instances
newtype ReferenceScriptSize Source #
Instances
Show ReferenceScriptSize Source # | |
Defined in Cardano.CLI.Types.Common |
data RequiredSigner Source #
Plutus script required signers
Instances
Show RequiredSigner Source # | |
Defined in Cardano.CLI.Types.Common |
data ScriptDataOrFile Source #
ScriptDataCborFile FilePath | By reference to a CBOR file |
ScriptDataJsonFile FilePath | By reference to a JSON file |
ScriptDataValue HashableScriptData | By value |
Instances
Show ScriptDataOrFile Source # | |
Defined in Cardano.CLI.Types.Common | |
Eq ScriptDataOrFile Source # | |
Defined in Cardano.CLI.Types.Common |
data ScriptDatumOrFile witctx where Source #
Instances
Show (ScriptDatumOrFile witctx) Source # | |
Defined in Cardano.CLI.Types.Common |
type ScriptFile = File ScriptInAnyLang In Source #
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.
TODO: Potentially update to WitnessFiles so we can get rid of Maybe (ScriptWitnessFiles). This will be clearer in conveying that we either expect a script witness or a key witness is provided at the signing stage.
SimpleScriptWitnessFile ∷ ScriptFile → ScriptWitnessFiles witctx | |
PlutusScriptWitnessFiles ∷ ScriptFile → ScriptDatumOrFile witctx → ScriptRedeemerOrFile → ExecutionUnits → ScriptWitnessFiles witctx | |
PlutusReferenceScriptWitnessFiles | |
| |
SimpleReferenceScriptWitnessFiles | |
|
Instances
Show (ScriptWitnessFiles witctx) Source # | |
Defined in Cardano.CLI.Types.Common |
type SigningKeyFile = File (SigningKey ()) Source #
newtype SlotsTillKesKeyExpiry Source #
data SomeKeyFile direction Source #
Either a verification or signing key, used for conversions and other commands that make sense for both.
AVerificationKeyFile (VerificationKeyFile direction) | |
ASigningKeyFile (SigningKeyFile direction) |
Instances
Show (SomeKeyFile direction) Source # | |
Defined in Cardano.CLI.Types.Common |
data StakeDelegators Source #
StakeDelegators | |
|
Instances
Show StakeDelegators Source # | |
Defined in Cardano.CLI.Types.Common |
data TransferDirection Source #
Determines the direction in which the MIR certificate will transfer ADA.
Instances
Show TransferDirection Source # | |
Defined in Cardano.CLI.Types.Common |
type TxBodyFile = File (TxBody ()) Source #
data TxBuildOutputOptions Source #
Specify whether to render the script cost as JSON in the cli's build command.
Instances
Show TxBuildOutputOptions Source # | |
Defined in Cardano.CLI.Types.Common |
newtype TxByronWitnessCount Source #
Instances
Show TxByronWitnessCount Source # | |
Defined in Cardano.CLI.Types.Common |
data TxMempoolQuery Source #
Instances
Show TxMempoolQuery Source # | |
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
Show TxOutAnyEra Source # | |
Defined in Cardano.CLI.Types.Common | |
Eq TxOutAnyEra Source # | |
Defined in Cardano.CLI.Types.Common (==) ∷ TxOutAnyEra → TxOutAnyEra → Bool Source # (/=) ∷ TxOutAnyEra → TxOutAnyEra → Bool Source # |
data TxOutShelleyBasedEra Source #
Instances
Show TxOutShelleyBasedEra Source # | |
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.
Instances
Show TxOutChangeAddress Source # | |
Defined in Cardano.CLI.Types.Common | |
Eq TxOutChangeAddress Source # | |
Defined in Cardano.CLI.Types.Common |
newtype TxOutCount Source #
Instances
Show TxOutCount Source # | |
Defined in Cardano.CLI.Types.Common |
data TxOutDatumAnyEra Source #
TxOutDatumByHashOnly (Hash ScriptData) | |
TxOutDatumByHashOf ScriptDataOrFile | |
TxOutDatumByValue ScriptDataOrFile | |
TxOutInlineDatumByValue ScriptDataOrFile | |
TxOutDatumByNone |
Instances
Show TxOutDatumAnyEra Source # | |
Defined in Cardano.CLI.Types.Common | |
Eq TxOutDatumAnyEra Source # | |
Defined in Cardano.CLI.Types.Common |
newtype TxShelleyWitnessCount Source #
Instances
Show TxShelleyWitnessCount Source # | |
Defined in Cardano.CLI.Types.Common |
newtype UpdateProposalFile Source #
Instances
Show UpdateProposalFile Source # | |
Defined in Cardano.CLI.Types.Common | |
Eq UpdateProposalFile Source # | |
Defined in Cardano.CLI.Types.Common |
newtype VerificationKeyBase64 Source #
A raw verification key given in Base64, and decoded into a ByteString.
Instances
Show VerificationKeyBase64 Source # | |
Defined in Cardano.CLI.Types.Common |
type VerificationKeyFile = File (VerificationKey ()) Source #
data ViewOutputFormat Source #
Instances
Show ViewOutputFormat Source # | |
Defined in Cardano.CLI.Types.Common |
data VoteHashSource Source #
VoteHashSourceFile (File VoteText In) | |
VoteHashSourceText Text | |
VoteHashSourceHash (SafeHash StandardCrypto AnchorData) |
Instances
Show VoteHashSource Source # | |
Defined in Cardano.CLI.Types.Common |
newtype WitnessFile Source #
Instances
Show WitnessFile Source # | |
Defined in Cardano.CLI.Types.Common |
data WitnessSigningData Source #
Data required to construct a witness.
KeyWitnessSigningData | |
|
Instances
Show WitnessSigningData Source # | |
Defined in Cardano.CLI.Types.Common |
type DRepMetadataFile = File DRepMetadata Source #