cardano-cli-1.36.0: The Cardano command-line interface
Safe HaskellNone
LanguageHaskell2010

Cardano.CLI.Shelley.Run.Read

Synopsis

Metadata

data MetadataError Source #

Constructors

MetadataErrorFile (FileError ()) 
MetadataErrorJsonParseError !FilePath !String 
MetadataErrorConversionError !FilePath !TxMetadataJsonError 
MetadataErrorValidationError !FilePath ![(Word64, TxMetadataRangeError)] 
MetadataErrorDecodeError !FilePath !DecoderError 
MetadataErrorNotAvailableInEra AnyCardanoEra 

renderMetadataError ∷ MetadataError → Text Source #

readFileTxMetadata ∷ TxMetadataJsonSchema → MetadataFile → ExceptT MetadataError IO TxMetadata Source #

readTxMetadata ∷ CardanoEra era → TxMetadataJsonSchema → [MetadataFile] → IO (Either MetadataError (TxMetadataInEra era)) Source #

Script

data ScriptWitnessError Source #

Constructors

ScriptWitnessErrorFile (FileError ScriptDecodeError) 
ScriptWitnessErrorScriptLanguageNotSupportedInEra AnyScriptLanguage AnyCardanoEra 
ScriptWitnessErrorExpectedSimple !FilePath !AnyScriptLanguage 
ScriptWitnessErrorExpectedPlutus !FilePath !AnyScriptLanguage 
ScriptWitnessErrorReferenceScriptsNotSupportedInEra !AnyCardanoEra 
ScriptWitnessErrorScriptData ScriptDataError 

renderScriptWitnessError ∷ ScriptWitnessError → Text Source #

readScriptDataOrFile ∷ ScriptDataOrFile → ExceptT ScriptDataError IO ScriptData Source #

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

Instances details
Show ScriptDecodeError Source # 
Instance details

Defined in Cardano.CLI.Shelley.Run.Read

Methods

showsPrec ∷ Int → ScriptDecodeError → ShowS Source #

show ∷ ScriptDecodeError → String Source #

showList ∷ [ScriptDecodeError] → ShowS Source #

Error ScriptDecodeError Source # 
Instance details

Defined in Cardano.CLI.Shelley.Run.Read

Methods

displayError ∷ ScriptDecodeError → String Source #

deserialiseScriptInAnyLang ∷ ByteString → Either ScriptDecodeError ScriptInAnyLang Source #

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

ScriptDataErrorFile (FileError ()) 
ScriptDataErrorJsonParse !FilePath !String 
ScriptDataErrorConversion !FilePath !ScriptDataJsonError 
ScriptDataErrorValidation !FilePath !ScriptDataRangeError 
ScriptDataErrorMetadataDecode !FilePath !DecoderError 

readScriptDatumOrFile ∷ ScriptDatumOrFile witctx → ExceptT ScriptDataError IO (ScriptDatum witctx) Source #

readScriptRedeemerOrFile ∷ ScriptRedeemerOrFile → ExceptT ScriptDataError IO ScriptRedeemer Source #

renderScriptDataError ∷ ScriptDataError → Text Source #

Tx

data CddlError Source #

newtype CddlTx Source #

Constructors

CddlTx 

Fields

Instances

Instances details
Eq CddlTx Source # 
Instance details

Defined in Cardano.CLI.Shelley.Run.Read

Methods

(==) ∷ CddlTx → CddlTx → Bool Source #

(/=) ∷ CddlTx → CddlTx → Bool Source #

Show CddlTx Source # 
Instance details

Defined in Cardano.CLI.Shelley.Run.Read

Methods

showsPrec ∷ Int → CddlTx → ShowS Source #

show ∷ CddlTx → String Source #

showList ∷ [CddlTx] → ShowS Source #

data IncompleteTx Source #

Constructors

UnwitnessedCliFormattedTxBody (InAnyCardanoEra TxBody) 
IncompleteCddlFormattedTx (InAnyCardanoEra Tx) 

readFileTx ∷ FilePath → IO (Either CddlError (InAnyCardanoEra Tx)) Source #

readFileTxBody ∷ FilePath → IO (Either CddlError IncompleteTx) Source #

renderCddlError ∷ CddlError → Text Source #

readCddlTx ∷ FilePath → IO (Either (FileError TextEnvelopeCddlError) CddlTx) 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

Instances details
Show ReadWitnessSigningDataError Source # 
Instance details

Defined in Cardano.CLI.Shelley.Run.Read

Methods

showsPrec ∷ Int → ReadWitnessSigningDataError → ShowS Source #

show ∷ ReadWitnessSigningDataError → String Source #

showList ∷ [ReadWitnessSigningDataError] → ShowS Source #

renderReadWitnessSigningDataError ∷ ReadWitnessSigningDataError → Text Source #

Render an error message for a ReadWitnessSigningDataError.

data SomeWitness Source #

Constructors

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 Source #

Some kind of Byron or Shelley witness.

Constructors

AByronWitness !ShelleyBootstrapWitnessSigningKeyData 
AShelleyKeyWitness !ShelleyWitnessSigningKey 

data ShelleyBootstrapWitnessSigningKeyData Source #

Data required for constructing a Shelley bootstrap witness.

Constructors

ShelleyBootstrapWitnessSigningKeyData 

Fields

  • !(SigningKey ByronKey)

    Byron signing key.

  • !(Maybe (Address ByronAddr))

    An optionally specified Byron address.

    If specified, both the network ID and derivation path are extracted from the address and used in the construction of the Byron witness.

data CddlWitnessError Source #

Constructors

CddlWitnessErrorTextEnv (FileError TextEnvelopeError) (FileError TextEnvelopeCddlError) 
CddlWitnessIOError (FileError TextEnvelopeError) 

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 

categoriseSomeWitness ∷ SomeWitness → ByronOrShelleyWitness Source #

readRequiredSigner ∷ RequiredSigner → IO (Either RequiredSignerError (Hash PaymentKey)) Source #