cardano-cli
Safe HaskellNone
LanguageHaskell2010

Cardano.CLI.Read

Synopsis

Metadata

data MetadataError Source #

Constructors

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

Instances

Instances details
Show MetadataError Source # 
Instance details

Defined in Cardano.CLI.Read

Methods

showsPrec :: Int -> MetadataError -> ShowS Source #

show :: MetadataError -> String Source #

showList :: [MetadataError] -> ShowS Source #

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

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

Instances

Instances details
Show ScriptWitnessError Source # 
Instance details

Defined in Cardano.CLI.Read

Methods

showsPrec :: Int -> ScriptWitnessError -> ShowS Source #

show :: ScriptWitnessError -> String Source #

showList :: [ScriptWitnessError] -> ShowS Source #

renderScriptWitnessError :: ScriptWitnessError -> Doc ann Source #

readScriptDataOrFile :: forall (m :: Type -> Type). MonadIO m => ScriptDataOrFile -> ExceptT ScriptDataError m HashableScriptData Source #

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 
ScriptDecodeUnknownPlutusScriptVersion Text 

Instances

Instances details
Show ScriptDecodeError Source # 
Instance details

Defined in Cardano.CLI.Types.Errors.ScriptDecodeError

Methods

showsPrec :: Int -> ScriptDecodeError -> ShowS Source #

show :: ScriptDecodeError -> String Source #

showList :: [ScriptDecodeError] -> ShowS Source #

Error ScriptDecodeError Source # 
Instance details

Defined in Cardano.CLI.Types.Errors.ScriptDecodeError

Methods

prettyError :: ScriptDecodeError -> Doc ann #

deserialiseScriptInAnyLang :: ByteString -> Either ScriptDecodeError ScriptInAnyLang Source #

readFileScriptInAnyLang :: forall t (m :: Type -> Type). 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.

readFileSimpleScript :: forall t (m :: Type -> Type). MonadIOTransError (FileError ScriptDecodeError) t m => FilePath -> t m (Script SimpleScript') Source #

data AnyPlutusScript where Source #

Constructors

AnyPlutusScript :: forall lang. IsPlutusScriptLanguage lang => PlutusScriptVersion lang -> PlutusScript lang -> AnyPlutusScript 

data PlutusScriptDecodeError Source #

Constructors

PlutusScriptDecodeErrorUnknownVersion !Text 
PlutusScriptJsonDecodeError !JsonDecodeError 
PlutusScriptDecodeTextEnvelopeError !TextEnvelopeError 
PlutusScriptDecodeErrorVersionMismatch 

Fields

Instances

Instances details
Error PlutusScriptDecodeError Source # 
Instance details

Defined in Cardano.CLI.Types.Errors.PlutusScriptDecodeError

Methods

prettyError :: PlutusScriptDecodeError -> Doc ann #

readFilePlutusScript :: forall t (m :: Type -> Type). MonadIOTransError (FileError PlutusScriptDecodeError) t m => FilePath -> t m AnyPlutusScript Source #

Script data (datums and redeemers)

data ScriptDataError Source #

Constructors

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

Instances

Instances details
Show ScriptDataError Source # 
Instance details

Defined in Cardano.CLI.Types.Errors.ScriptDataError

Methods

showsPrec :: Int -> ScriptDataError -> ShowS Source #

show :: ScriptDataError -> String Source #

showList :: [ScriptDataError] -> ShowS Source #

readScriptDatumOrFile :: ScriptDatumOrFile witctx -> ExceptT ScriptDataError IO (ScriptDatum witctx) Source #

readScriptRedeemerOrFile :: ScriptRedeemerOrFile -> ExceptT ScriptDataError IO ScriptRedeemer Source #

renderScriptDataError :: ScriptDataError -> Doc ann Source #

Tx

data CddlError Source #

Constructors

CddlErrorTextEnv !(FileError TextEnvelopeError) !(FileError TextEnvelopeCddlError) 
CddlIOError (FileError TextEnvelopeError) 

Instances

Instances details
Show CddlError Source # 
Instance details

Defined in Cardano.CLI.Read

Methods

showsPrec :: Int -> CddlError -> ShowS Source #

show :: CddlError -> String Source #

showList :: [CddlError] -> ShowS Source #

Error CddlError Source # 
Instance details

Defined in Cardano.CLI.Read

Methods

prettyError :: CddlError -> Doc ann #

newtype CddlTx Source #

Constructors

CddlTx 

Fields

Instances

Instances details
Show CddlTx Source # 
Instance details

Defined in Cardano.CLI.Read

Methods

showsPrec :: Int -> CddlTx -> ShowS Source #

show :: CddlTx -> String Source #

showList :: [CddlTx] -> ShowS Source #

Eq CddlTx Source # 
Instance details

Defined in Cardano.CLI.Read

Methods

(==) :: CddlTx -> CddlTx -> Bool Source #

(/=) :: CddlTx -> CddlTx -> Bool Source #

newtype IncompleteCddlTxBody Source #

Constructors

IncompleteCddlTxBody 

Fields

readFileTx :: FileOrPipe -> IO (Either (FileError TextEnvelopeCddlError) (InAnyShelleyBasedEra Tx)) Source #

readFileTxBody :: FileOrPipe -> IO (Either (FileError TextEnvelopeCddlError) IncompleteCddlTxBody) Source #

readCddlTx :: FileOrPipe -> IO (Either (FileError TextEnvelopeCddlError) CddlTx) Source #

txTextEnvelopeTypes :: [Text] 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.Read

Methods

showsPrec :: Int -> ReadWitnessSigningDataError -> ShowS Source #

show :: ReadWitnessSigningDataError -> String Source #

showList :: [ReadWitnessSigningDataError] -> ShowS Source #

renderReadWitnessSigningDataError :: ReadWitnessSigningDataError -> Doc ann Source #

Render an error message for a ReadWitnessSigningDataError.

data SomeSigningWitness Source #

Constructors

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) 

Instances

Instances details
Show SomeSigningWitness Source # 
Instance details

Defined in Cardano.CLI.Read

Methods

showsPrec :: Int -> SomeSigningWitness -> ShowS Source #

show :: SomeSigningWitness -> String Source #

showList :: [SomeSigningWitness] -> ShowS Source #

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) 

Instances

Instances details
Show CddlWitnessError Source # 
Instance details

Defined in Cardano.CLI.Read

Methods

showsPrec :: Int -> CddlWitnessError -> ShowS Source #

show :: CddlWitnessError -> String Source #

showList :: [CddlWitnessError] -> ShowS Source #

Error CddlWitnessError Source # 
Instance details

Defined in Cardano.CLI.Read

Methods

prettyError :: CddlWitnessError -> Doc ann #

readFileTxKeyWitness :: FilePath -> IO (Either CddlWitnessError (InAnyShelleyBasedEra KeyWitness)) Source #

readWitnessSigningData :: WitnessSigningData -> IO (Either ReadWitnessSigningDataError SomeSigningWitness) Source #

txWitnessTextEnvelopeTypes :: [Text] Source #

Required signer

data RequiredSignerError Source #

Constructors

RequiredSignerErrorFile (FileError InputDecodeError) 
RequiredSignerErrorByronKey (SigningKeyFile 'In) 

Instances

Instances details
Show RequiredSignerError Source # 
Instance details

Defined in Cardano.CLI.Read

Methods

showsPrec :: Int -> RequiredSignerError -> ShowS Source #

show :: RequiredSignerError -> String Source #

showList :: [RequiredSignerError] -> ShowS Source #

Error RequiredSignerError Source # 
Instance details

Defined in Cardano.CLI.Read

Methods

prettyError :: RequiredSignerError -> Doc ann #

categoriseSomeSigningWitness :: SomeSigningWitness -> ByronOrShelleyWitness Source #

readRequiredSigner :: RequiredSigner -> IO (Either RequiredSignerError (Hash PaymentKey)) Source #

Governance related

data ConstitutionError Source #

Constructors

ConstitutionErrorFile (FileError TextEnvelopeError) 
ConstitutionNotSupportedInEra AnyCardanoEra 
ConstitutionNotUnicodeError UnicodeException 

Instances

Instances details
Show ConstitutionError Source # 
Instance details

Defined in Cardano.CLI.Read

Methods

showsPrec :: Int -> ConstitutionError -> ShowS Source #

show :: ConstitutionError -> String Source #

showList :: [ConstitutionError] -> ShowS Source #

data ProposalError Source #

Constructors

ProposalErrorFile (FileError TextEnvelopeError) 
ProposalNotSupportedInEra AnyCardanoEra 
ProposalNotUnicodeError UnicodeException 
ProposalErrorScriptWitness ScriptWitnessError 

Instances

Instances details
Show ProposalError Source # 
Instance details

Defined in Cardano.CLI.Read

Methods

showsPrec :: Int -> ProposalError -> ShowS Source #

show :: ProposalError -> String Source #

showList :: [ProposalError] -> ShowS Source #

data VoteError Source #

Constructors

VoteErrorFile (FileError TextEnvelopeError) 
VoteErrorTextNotUnicode UnicodeException 
VoteErrorScriptWitness ScriptWitnessError 

Instances

Instances details
Show VoteError Source # 
Instance details

Defined in Cardano.CLI.Read

Methods

showsPrec :: Int -> VoteError -> ShowS Source #

show :: VoteError -> String Source #

showList :: [VoteError] -> ShowS Source #

Error VoteError Source # 
Instance details

Defined in Cardano.CLI.Read

Methods

prettyError :: VoteError -> Doc ann #

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

Instances details
Show CostModelsError Source # 
Instance details

Defined in Cardano.CLI.Read

Methods

showsPrec :: Int -> CostModelsError -> ShowS Source #

show :: CostModelsError -> String Source #

showList :: [CostModelsError] -> ShowS Source #

Error CostModelsError Source # 
Instance details

Defined in Cardano.CLI.Read

Methods

prettyError :: CostModelsError -> Doc ann #

readCostModels :: File CostModels 'In -> ExceptT CostModelsError IO CostModels 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

Instances details
Show FileOrPipe Source # 
Instance details

Defined in Cardano.CLI.Read

Methods

showsPrec :: Int -> FileOrPipe -> ShowS Source #

show :: FileOrPipe -> String Source #

showList :: [FileOrPipe] -> ShowS Source #

fileOrPipe :: FilePath -> IO FileOrPipe Source #

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

fileOrPipeCache :: FileOrPipe -> IO (Maybe ByteString) Source #

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 :: forall t (m :: Type -> Type). MonadIOTransError (FileError InputDecodeError) t m => VerificationKeyOrHashOrFile DRepKey -> t m (Credential 'DRepRole StandardCrypto) Source #

data ReadSafeHashError Source #

Constructors

ReadSafeHashErrorNotHex ByteString String 
ReadSafeHashErrorInvalidHash Text 

readHexAsSafeHash :: Text -> Either ReadSafeHashError (SafeHash StandardCrypto AnchorData) Source #

readSafeHash :: ReadM (SafeHash StandardCrypto AnchorData) Source #

scriptHashReader :: ReadM ScriptHash 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 :: forall t (m :: Type -> Type) keyrole (kr :: KeyRole). (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 :: forall t (m :: Type -> Type) keyrole (kr :: KeyRole). (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 #

Genesis hashes

readShelleyOnwardsGenesisAndHash Source #

Arguments

:: MonadIO m 
=> FilePath

The file to read

-> m (Hash Blake2b_256 ByteString)