| Safe Haskell | Safe-Inferred |
|---|---|
| Language | Haskell2010 |
Cardano.CLI.Shelley.Run.Read
Synopsis
- data MetadataError
- = MetadataErrorFile (FileError ())
- | MetadataErrorJsonParseError !FilePath !String
- | MetadataErrorConversionError !FilePath !TxMetadataJsonError
- | MetadataErrorValidationError !FilePath ![(Word64, TxMetadataRangeError)]
- | MetadataErrorDecodeError !FilePath !DecoderError
- | MetadataErrorNotAvailableInEra AnyCardanoEra
- renderMetadataError ∷ MetadataError → Text
- readFileTxMetadata ∷ TxMetadataJsonSchema → MetadataFile → ExceptT MetadataError IO TxMetadata
- readTxMetadata ∷ CardanoEra era → TxMetadataJsonSchema → [MetadataFile] → IO (Either MetadataError (TxMetadataInEra era))
- data ScriptWitnessError
- = ScriptWitnessErrorFile (FileError ScriptDecodeError)
- | ScriptWitnessErrorScriptLanguageNotSupportedInEra AnyScriptLanguage AnyCardanoEra
- | ScriptWitnessErrorExpectedSimple !FilePath !AnyScriptLanguage
- | ScriptWitnessErrorExpectedPlutus !FilePath !AnyScriptLanguage
- | ScriptWitnessErrorReferenceScriptsNotSupportedInEra !AnyCardanoEra
- | ScriptWitnessErrorScriptData ScriptDataError
- renderScriptWitnessError ∷ ScriptWitnessError → Text
- readScriptDataOrFile ∷ ScriptDataOrFile → ExceptT ScriptDataError IO HashableScriptData
- readScriptWitness ∷ CardanoEra era → ScriptWitnessFiles witctx → ExceptT ScriptWitnessError IO (ScriptWitness witctx era)
- readScriptWitnessFiles ∷ CardanoEra era → [(a, Maybe (ScriptWitnessFiles ctx))] → ExceptT ScriptWitnessError IO [(a, Maybe (ScriptWitness ctx era))]
- readScriptWitnessFilesThruple ∷ CardanoEra era → [(a, b, Maybe (ScriptWitnessFiles ctx))] → ExceptT ScriptWitnessError IO [(a, b, Maybe (ScriptWitness ctx era))]
- data ScriptDecodeError
- deserialiseScriptInAnyLang ∷ ByteString → Either ScriptDecodeError ScriptInAnyLang
- readFileScriptInAnyLang ∷ FilePath → ExceptT (FileError ScriptDecodeError) IO 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 → Text
- data CddlError
- newtype CddlTx = CddlTx {}
- data IncompleteTx
- readFileTx ∷ FileOrPipe → IO (Either CddlError (InAnyCardanoEra Tx))
- readFileTxBody ∷ FileOrPipe → IO (Either CddlError IncompleteTx)
- readCddlTx ∷ FileOrPipe → IO (Either (FileError TextEnvelopeCddlError) CddlTx)
- data ReadWitnessSigningDataError
- renderReadWitnessSigningDataError ∷ ReadWitnessSigningDataError → Text
- data SomeWitness
- = AByronSigningKey (SigningKey ByronKey) (Maybe (Address ByronAddr))
- | APaymentSigningKey (SigningKey PaymentKey)
- | APaymentExtendedSigningKey (SigningKey PaymentExtendedKey)
- | AStakeSigningKey (SigningKey StakeKey)
- | AStakeExtendedSigningKey (SigningKey StakeExtendedKey)
- | AStakePoolSigningKey (SigningKey StakePoolKey)
- | AGenesisSigningKey (SigningKey GenesisKey)
- | AGenesisExtendedSigningKey (SigningKey GenesisExtendedKey)
- | AGenesisDelegateSigningKey (SigningKey GenesisDelegateKey)
- | AGenesisDelegateExtendedSigningKey (SigningKey GenesisDelegateExtendedKey)
- | AGenesisUTxOSigningKey (SigningKey GenesisUTxOKey)
- data ByronOrShelleyWitness
- data ShelleyBootstrapWitnessSigningKeyData = ShelleyBootstrapWitnessSigningKeyData !(SigningKey ByronKey) !(Maybe (Address ByronAddr))
- data CddlWitnessError
- readFileTxKeyWitness ∷ FilePath → IO (Either CddlWitnessError (InAnyCardanoEra KeyWitness))
- readWitnessSigningData ∷ WitnessSigningData → IO (Either ReadWitnessSigningDataError SomeWitness)
- data RequiredSignerError
- categoriseSomeWitness ∷ SomeWitness → ByronOrShelleyWitness
- readRequiredSigner ∷ RequiredSigner → IO (Either RequiredSignerError (Hash PaymentKey))
- data FileOrPipe
- fileOrPipe ∷ FilePath → IO FileOrPipe
- fileOrPipePath ∷ FileOrPipe → FilePath
- fileOrPipeCache ∷ FileOrPipe → IO (Maybe ByteString)
- readFileOrPipe ∷ FileOrPipe → IO ByteString
Metadata
data MetadataError Source #
Constructors
readFileTxMetadata ∷ TxMetadataJsonSchema → MetadataFile → ExceptT MetadataError IO TxMetadata Source #
readTxMetadata ∷ CardanoEra era → TxMetadataJsonSchema → [MetadataFile] → IO (Either MetadataError (TxMetadataInEra era)) Source #
Script
data ScriptWitnessError Source #
Constructors
readScriptWitness ∷ CardanoEra era → ScriptWitnessFiles witctx → ExceptT ScriptWitnessError IO (ScriptWitness witctx era) Source #
readScriptWitnessFiles ∷ CardanoEra era → [(a, Maybe (ScriptWitnessFiles ctx))] → ExceptT ScriptWitnessError IO [(a, Maybe (ScriptWitness ctx era))] Source #
readScriptWitnessFilesThruple ∷ CardanoEra 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.Shelley.Run.Read | |
| Error ScriptDecodeError Source # | |
Defined in Cardano.CLI.Shelley.Run.Read Methods | |
readFileScriptInAnyLang ∷ FilePath → ExceptT (FileError ScriptDecodeError) IO 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
readScriptDatumOrFile ∷ ScriptDatumOrFile witctx → ExceptT ScriptDataError IO (ScriptDatum witctx) Source #
readScriptRedeemerOrFile ∷ ScriptRedeemerOrFile → ExceptT ScriptDataError IO ScriptRedeemer Source #
Tx
data IncompleteTx Source #
readFileTx ∷ FileOrPipe → IO (Either CddlError (InAnyCardanoEra Tx)) 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
renderReadWitnessSigningDataError ∷ ReadWitnessSigningDataError → Text Source #
Render an error message for a ReadWitnessSigningDataError.
data SomeWitness Source #
Constructors
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.Shelley.Run.Read | |
| Error CddlWitnessError Source # | |
Defined in Cardano.CLI.Shelley.Run.Read Methods | |
readFileTxKeyWitness ∷ FilePath → IO (Either CddlWitnessError (InAnyCardanoEra KeyWitness)) Source #
readWitnessSigningData ∷ WitnessSigningData → IO (Either ReadWitnessSigningDataError SomeWitness) Source #
Required signer
data RequiredSignerError Source #
Constructors
| RequiredSignerErrorFile (FileError InputDecodeError) | |
| RequiredSignerErrorByronKey SigningKeyFile |
Instances
| Show RequiredSignerError Source # | |
Defined in Cardano.CLI.Shelley.Run.Read | |
| Error RequiredSignerError Source # | |
Defined in Cardano.CLI.Shelley.Run.Read Methods | |
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.Shelley.Run.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.