| Safe Haskell | Safe-Inferred |
|---|---|
| Language | Haskell2010 |
Cardano.CLI.Read
Synopsis
- data MetadataError
- renderMetadataError ∷ MetadataError → Doc ann
- readFileTxMetadata ∷ TxMetadataJsonSchema → MetadataFile → ExceptT MetadataError IO TxMetadata
- readTxMetadata ∷ ShelleyBasedEra era → TxMetadataJsonSchema → [MetadataFile] → IO (Either MetadataError (TxMetadataInEra era))
- data ScriptWitnessError
- = ScriptWitnessErrorFile (FileError ScriptDecodeError)
- | ScriptWitnessErrorScriptLanguageNotSupportedInEra AnyScriptLanguage AnyCardanoEra
- | ScriptWitnessErrorExpectedSimple !FilePath !AnyScriptLanguage
- | ScriptWitnessErrorExpectedPlutus !FilePath !AnyScriptLanguage
- | ScriptWitnessErrorReferenceScriptsNotSupportedInEra !AnyShelleyBasedEra
- | ScriptWitnessErrorScriptData ScriptDataError
- renderScriptWitnessError ∷ ScriptWitnessError → Doc ann
- readScriptDataOrFile ∷ ScriptDataOrFile → ExceptT ScriptDataError IO HashableScriptData
- readScriptWitness ∷ ShelleyBasedEra era → ScriptWitnessFiles witctx → ExceptT ScriptWitnessError IO (ScriptWitness witctx era)
- readScriptWitnessFiles ∷ ShelleyBasedEra era → [(a, Maybe (ScriptWitnessFiles ctx))] → ExceptT ScriptWitnessError IO [(a, Maybe (ScriptWitness ctx era))]
- readScriptWitnessFilesTuple ∷ ShelleyBasedEra era → [(a, b, Maybe (ScriptWitnessFiles ctx))] → ExceptT ScriptWitnessError IO [(a, b, Maybe (ScriptWitness ctx era))]
- data ScriptDecodeError
- deserialiseScriptInAnyLang ∷ ByteString → Either ScriptDecodeError ScriptInAnyLang
- readFileScriptInAnyLang ∷ MonadIOTransError (FileError ScriptDecodeError) t m ⇒ FilePath → t m ScriptInAnyLang
- data ScriptDataError
- = ScriptDataErrorFile (FileError ())
- | ScriptDataErrorJsonParse !FilePath !String
- | ScriptDataErrorConversion !FilePath !ScriptDataJsonError
- | ScriptDataErrorValidation !FilePath !ScriptDataRangeError
- | ScriptDataErrorMetadataDecode !FilePath !DecoderError
- | ScriptDataErrorJsonBytes !ScriptDataJsonBytesError
- readScriptDatumOrFile ∷ ScriptDatumOrFile witctx → ExceptT ScriptDataError IO (ScriptDatum witctx)
- readScriptRedeemerOrFile ∷ ScriptRedeemerOrFile → ExceptT ScriptDataError IO ScriptRedeemer
- renderScriptDataError ∷ ScriptDataError → Doc ann
- data CddlError
- newtype CddlTx = CddlTx {}
- data IncompleteTx
- readFileTx ∷ FileOrPipe → IO (Either CddlError (InAnyShelleyBasedEra Tx))
- readFileTxBody ∷ FileOrPipe → IO (Either CddlError IncompleteTx)
- readCddlTx ∷ FileOrPipe → IO (Either (FileError TextEnvelopeCddlError) CddlTx)
- data ReadWitnessSigningDataError
- renderReadWitnessSigningDataError ∷ ReadWitnessSigningDataError → Doc ann
- data SomeSigningWitness
- = AByronSigningWitness (SigningKey ByronKey) (Maybe (Address ByronAddr))
- | APaymentSigningWitness (SigningKey PaymentKey)
- | APaymentExtendedSigningWitness (SigningKey PaymentExtendedKey)
- | AStakeSigningWitness (SigningKey StakeKey)
- | AStakeExtendedSigningWitness (SigningKey StakeExtendedKey)
- | AStakePoolSigningWitness (SigningKey StakePoolKey)
- | AGenesisSigningWitness (SigningKey GenesisKey)
- | AGenesisExtendedSigningWitness (SigningKey GenesisExtendedKey)
- | AGenesisDelegateSigningWitness (SigningKey GenesisDelegateKey)
- | AGenesisDelegateExtendedSigningWitness (SigningKey GenesisDelegateExtendedKey)
- | AGenesisUTxOSigningWitness (SigningKey GenesisUTxOKey)
- | ADRepSigningWitness (SigningKey DRepKey)
- | ADRepExtendedSigningWitness (SigningKey DRepExtendedKey)
- | ACommitteeColdSigningWitness (SigningKey CommitteeColdKey)
- | ACommitteeColdExtendedSigningWitness (SigningKey CommitteeColdExtendedKey)
- | ACommitteeHotSigningWitness (SigningKey CommitteeHotKey)
- | ACommitteeHotExtendedSigningWitness (SigningKey CommitteeHotExtendedKey)
- data ByronOrShelleyWitness
- data ShelleyBootstrapWitnessSigningKeyData = ShelleyBootstrapWitnessSigningKeyData !(SigningKey ByronKey) !(Maybe (Address ByronAddr))
- data CddlWitnessError
- readFileTxKeyWitness ∷ FilePath → IO (Either CddlWitnessError (InAnyShelleyBasedEra KeyWitness))
- readWitnessSigningData ∷ WitnessSigningData → IO (Either ReadWitnessSigningDataError SomeSigningWitness)
- data RequiredSignerError
- categoriseSomeSigningWitness ∷ SomeSigningWitness → ByronOrShelleyWitness
- readRequiredSigner ∷ RequiredSigner → IO (Either RequiredSignerError (Hash PaymentKey))
- data ConstitutionError
- data ProposalError
- data VoteError
- readTxGovernanceActions ∷ ShelleyBasedEra era → [(ProposalFile In, Maybe (ScriptWitnessFiles WitCtxStake))] → IO (Either ProposalError [(Proposal era, Maybe (ScriptWitness WitCtxStake era))])
- constitutionHashSourceToHash ∷ ConstitutionHashSource → ExceptT ConstitutionError IO (SafeHash StandardCrypto AnchorData)
- readProposal ∷ ConwayEraOnwards era → (ProposalFile In, Maybe (ScriptWitnessFiles WitCtxStake)) → IO (Either ProposalError (Proposal era, Maybe (ScriptWitness WitCtxStake era)))
- data CostModelsError
- readCostModels ∷ File CostModels In → ExceptT CostModelsError IO CostModels
- data FileOrPipe
- fileOrPipe ∷ FilePath → IO FileOrPipe
- fileOrPipePath ∷ FileOrPipe → FilePath
- fileOrPipeCache ∷ FileOrPipe → IO (Maybe ByteString)
- readFileOrPipe ∷ FileOrPipe → IO ByteString
- getStakeCredentialFromVerifier ∷ StakeVerifier → ExceptT StakeCredentialError IO StakeCredential
- getStakeCredentialFromIdentifier ∷ StakeIdentifier → ExceptT StakeCredentialError IO StakeCredential
- getStakeAddressFromVerifier ∷ NetworkId → StakeVerifier → ExceptT StakeCredentialError IO StakeAddress
- readVotingProceduresFiles ∷ ConwayEraOnwards era → [(VoteFile In, Maybe (ScriptWitnessFiles WitCtxStake))] → IO (Either VoteError [(VotingProcedures era, Maybe (ScriptWitness WitCtxStake era))])
- readSingleVote ∷ ConwayEraOnwards era → (VoteFile In, Maybe (ScriptWitnessFiles WitCtxStake)) → IO (Either VoteError (VotingProcedures era, Maybe (ScriptWitness WitCtxStake era)))
- getDRepCredentialFromVerKeyHashOrFile ∷ MonadIOTransError (FileError InputDecodeError) t m ⇒ VerificationKeyOrHashOrFile DRepKey → t m (Credential DRepRole StandardCrypto)
- data ReadSafeHashError
- readHexAsSafeHash ∷ Text → Either ReadSafeHashError (SafeHash StandardCrypto AnchorData)
- readSafeHash ∷ ReadM (SafeHash StandardCrypto AnchorData)
- scriptHashReader ∷ ReadM ScriptHash
- readTxUpdateProposal ∷ ShelleyToBabbageEra era → UpdateProposalFile → ExceptT (FileError TextEnvelopeError) IO (TxUpdateProposal era)
- readVoteDelegationTarget ∷ VoteDelegationTarget → ExceptT DelegationError IO (DRep StandardCrypto)
- readVerificationKeyOrHashOrFileOrScript ∷ MonadIOTransError (Either (FileError ScriptDecodeError) (FileError InputDecodeError)) t m ⇒ Key keyrole ⇒ AsType keyrole → (Hash keyrole → KeyHash kr StandardCrypto) → VerificationKeyOrHashOrFileOrScript keyrole → t m (Credential kr StandardCrypto)
- readVerificationKeySource ∷ MonadIOTransError (Either (FileError ScriptDecodeError) (FileError InputDecodeError)) t m ⇒ Key keyrole ⇒ AsType keyrole → (Hash keyrole → KeyHash kr StandardCrypto) → VerificationKeySource keyrole → t m (Credential kr StandardCrypto)
Metadata
data MetadataError Source #
Constructors
Instances
| Show MetadataError Source # | |
Defined in Cardano.CLI.Read | |
renderMetadataError ∷ MetadataError → Doc ann Source #
readFileTxMetadata ∷ TxMetadataJsonSchema → MetadataFile → ExceptT MetadataError IO TxMetadata Source #
readTxMetadata ∷ ShelleyBasedEra era → TxMetadataJsonSchema → [MetadataFile] → IO (Either MetadataError (TxMetadataInEra era)) Source #
Script
data ScriptWitnessError Source #
Constructors
Instances
| Show ScriptWitnessError Source # | |
Defined in Cardano.CLI.Read | |
readScriptWitness ∷ ShelleyBasedEra era → ScriptWitnessFiles witctx → ExceptT ScriptWitnessError IO (ScriptWitness witctx era) Source #
readScriptWitnessFiles ∷ ShelleyBasedEra era → [(a, Maybe (ScriptWitnessFiles ctx))] → ExceptT ScriptWitnessError IO [(a, Maybe (ScriptWitness ctx era))] Source #
readScriptWitnessFilesTuple ∷ ShelleyBasedEra era → [(a, b, Maybe (ScriptWitnessFiles ctx))] → ExceptT ScriptWitnessError IO [(a, b, Maybe (ScriptWitness ctx era))] Source #
data ScriptDecodeError Source #
Constructors
| ScriptDecodeTextEnvelopeError TextEnvelopeError | |
| ScriptDecodeSimpleScriptError JsonDecodeError |
Instances
| Show ScriptDecodeError Source # | |
Defined in Cardano.CLI.Types.Errors.ScriptDecodeError | |
| Error ScriptDecodeError Source # | |
Defined in Cardano.CLI.Types.Errors.ScriptDecodeError Methods prettyError ∷ ScriptDecodeError → Doc ann Source # | |
readFileScriptInAnyLang ∷ MonadIOTransError (FileError ScriptDecodeError) t m ⇒ FilePath → t m ScriptInAnyLang Source #
Read a script file. The file can either be in the text envelope format wrapping the binary representation of any of the supported script languages, or alternatively it can be a JSON format file for one of the simple script language versions.
Script data (datums and redeemers)
data ScriptDataError Source #
Constructors
Instances
| Show ScriptDataError Source # | |
Defined in Cardano.CLI.Read | |
readScriptDatumOrFile ∷ ScriptDatumOrFile witctx → ExceptT ScriptDataError IO (ScriptDatum witctx) Source #
readScriptRedeemerOrFile ∷ ScriptRedeemerOrFile → ExceptT ScriptDataError IO ScriptRedeemer Source #
renderScriptDataError ∷ ScriptDataError → Doc ann Source #
Tx
Constructors
| CddlTx | |
Fields | |
Instances
data IncompleteTx Source #
Tx witnesses
data ReadWitnessSigningDataError Source #
Constructors
| ReadWitnessSigningDataSigningKeyDecodeError !(FileError InputDecodeError) | |
| ReadWitnessSigningDataScriptError !(FileError JsonDecodeError) | |
| ReadWitnessSigningDataSigningKeyAndAddressMismatch | A Byron address was specified alongside a non-Byron signing key. |
Instances
| Show ReadWitnessSigningDataError Source # | |
Defined in Cardano.CLI.Read | |
renderReadWitnessSigningDataError ∷ ReadWitnessSigningDataError → Doc ann Source #
Render an error message for a ReadWitnessSigningDataError.
data SomeSigningWitness Source #
Constructors
Instances
| Show SomeSigningWitness Source # | |
Defined in Cardano.CLI.Read | |
data ByronOrShelleyWitness Source #
Some kind of Byron or Shelley witness.
data ShelleyBootstrapWitnessSigningKeyData Source #
Data required for constructing a Shelley bootstrap witness.
Constructors
| ShelleyBootstrapWitnessSigningKeyData | |
Fields
| |
data CddlWitnessError Source #
Constructors
| CddlWitnessErrorTextEnv (FileError TextEnvelopeError) (FileError TextEnvelopeCddlError) | |
| CddlWitnessIOError (FileError TextEnvelopeError) |
Instances
| Show CddlWitnessError Source # | |
Defined in Cardano.CLI.Read | |
| Error CddlWitnessError Source # | |
Defined in Cardano.CLI.Read Methods prettyError ∷ CddlWitnessError → Doc ann Source # | |
readFileTxKeyWitness ∷ FilePath → IO (Either CddlWitnessError (InAnyShelleyBasedEra KeyWitness)) Source #
readWitnessSigningData ∷ WitnessSigningData → IO (Either ReadWitnessSigningDataError SomeSigningWitness) Source #
Required signer
data RequiredSignerError Source #
Constructors
| RequiredSignerErrorFile (FileError InputDecodeError) | |
| RequiredSignerErrorByronKey (SigningKeyFile In) |
Instances
| Show RequiredSignerError Source # | |
Defined in Cardano.CLI.Read | |
| Error RequiredSignerError Source # | |
Defined in Cardano.CLI.Read Methods prettyError ∷ RequiredSignerError → Doc ann Source # | |
Governance related
data ConstitutionError Source #
Constructors
| ConstitutionErrorFile (FileError TextEnvelopeError) | |
| ConstitutionNotSupportedInEra AnyCardanoEra | |
| ConstitutionNotUnicodeError UnicodeException |
Instances
| Show ConstitutionError Source # | |
Defined in Cardano.CLI.Read | |
data ProposalError Source #
Constructors
| ProposalErrorFile (FileError TextEnvelopeError) | |
| ProposalNotSupportedInEra AnyCardanoEra | |
| ProposalNotUnicodeError UnicodeException | |
| ProposalErrorScriptWitness ScriptWitnessError |
Instances
| Show ProposalError Source # | |
Defined in Cardano.CLI.Read | |
readTxGovernanceActions ∷ ShelleyBasedEra era → [(ProposalFile In, Maybe (ScriptWitnessFiles WitCtxStake))] → IO (Either ProposalError [(Proposal era, Maybe (ScriptWitness WitCtxStake era))]) Source #
constitutionHashSourceToHash ∷ ConstitutionHashSource → ExceptT ConstitutionError IO (SafeHash StandardCrypto AnchorData) Source #
readProposal ∷ ConwayEraOnwards era → (ProposalFile In, Maybe (ScriptWitnessFiles WitCtxStake)) → IO (Either ProposalError (Proposal era, Maybe (ScriptWitness WitCtxStake era))) Source #
data CostModelsError Source #
Constructors
| CostModelsErrorReadFile (FileError ()) | |
| CostModelsErrorJSONDecode FilePath String | |
| CostModelsErrorEmpty FilePath |
Instances
| Show CostModelsError Source # | |
Defined in Cardano.CLI.Read | |
| Error CostModelsError Source # | |
Defined in Cardano.CLI.Read Methods prettyError ∷ CostModelsError → Doc ann Source # | |
FileOrPipe
data FileOrPipe Source #
We need a type for handling files that may be actually be things like pipes. Currently the CLI makes no guarantee that a "file" will only be read once. This is a problem for a user who who expects to be able to pass a pipe. To handle this, we have a type for representing either files or pipes where the contents will be saved in memory if what we're reading is a pipe (so it can be re-read later). Unfortunately this means we can't easily stream data from pipes, but at present that's not an issue.
Instances
| Show FileOrPipe Source # | |
Defined in Cardano.CLI.Read | |
fileOrPipePath ∷ FileOrPipe → FilePath Source #
Get the path backing a FileOrPipe. This should primarily be used when generating error messages for a user. A user should not call directly call a function like readFile on the result of this function
readFileOrPipe ∷ FileOrPipe → IO ByteString Source #
Get the contents of a file or pipe. This function reads the entire contents of the file or pipe, and is blocking.
Stake credentials
getStakeCredentialFromVerifier ∷ StakeVerifier → ExceptT StakeCredentialError IO StakeCredential Source #
getStakeCredentialFromIdentifier ∷ StakeIdentifier → ExceptT StakeCredentialError IO StakeCredential Source #
getStakeAddressFromVerifier ∷ NetworkId → StakeVerifier → ExceptT StakeCredentialError IO StakeAddress Source #
readVotingProceduresFiles ∷ ConwayEraOnwards era → [(VoteFile In, Maybe (ScriptWitnessFiles WitCtxStake))] → IO (Either VoteError [(VotingProcedures era, Maybe (ScriptWitness WitCtxStake era))]) Source #
readSingleVote ∷ ConwayEraOnwards era → (VoteFile In, Maybe (ScriptWitnessFiles WitCtxStake)) → IO (Either VoteError (VotingProcedures era, Maybe (ScriptWitness WitCtxStake era))) Source #
DRep credentials
getDRepCredentialFromVerKeyHashOrFile ∷ MonadIOTransError (FileError InputDecodeError) t m ⇒ VerificationKeyOrHashOrFile DRepKey → t m (Credential DRepRole StandardCrypto) Source #
data ReadSafeHashError Source #
Update proposals
readTxUpdateProposal ∷ ShelleyToBabbageEra era → UpdateProposalFile → ExceptT (FileError TextEnvelopeError) IO (TxUpdateProposal era) Source #
Vote related
readVoteDelegationTarget ∷ VoteDelegationTarget → ExceptT DelegationError IO (DRep StandardCrypto) Source #
readVerificationKeyOrHashOrFileOrScript ∷ MonadIOTransError (Either (FileError ScriptDecodeError) (FileError InputDecodeError)) t m ⇒ Key keyrole ⇒ AsType keyrole → (Hash keyrole → KeyHash kr StandardCrypto) → VerificationKeyOrHashOrFileOrScript keyrole → t m (Credential kr StandardCrypto) Source #
readVerificationKeySource ∷ MonadIOTransError (Either (FileError ScriptDecodeError) (FileError InputDecodeError)) t m ⇒ Key keyrole ⇒ AsType keyrole → (Hash keyrole → KeyHash kr StandardCrypto) → VerificationKeySource keyrole → t m (Credential kr StandardCrypto) Source #