Safe Haskell	None
Language	Haskell2010

Cardano.Api.SerialiseLedgerCddl

Contents

Reading one of several transaction or
Byron tx serialization

Description

Ledger CDDL Serialisation

Synopsis

data TextEnvelopeCddlError
data FromSomeTypeCDDL c b where
- FromCDDLTx :: forall b. Text -> (InAnyShelleyBasedEra Tx -> b) -> FromSomeTypeCDDL TextEnvelope b
- FromCDDLWitness :: forall b. Text -> (InAnyShelleyBasedEra KeyWitness -> b) -> FromSomeTypeCDDL TextEnvelope b
cddlTypeToEra :: Text -> Either TextEnvelopeCddlError AnyShelleyBasedEra
readFileTextEnvelopeCddlAnyOf :: [FromSomeTypeCDDL TextEnvelope b] -> FilePath -> IO (Either (FileError TextEnvelopeCddlError) b)
deserialiseFromTextEnvelopeCddlAnyOf :: [FromSomeTypeCDDL TextEnvelope b] -> TextEnvelope -> Either TextEnvelopeCddlError b
writeTxFileTextEnvelopeCddl :: ShelleyBasedEra era -> File content 'Out -> Tx era -> IO (Either (FileError ()) ())
writeTxWitnessFileTextEnvelopeCddl :: ShelleyBasedEra era -> File () 'Out -> KeyWitness era -> IO (Either (FileError ()) ())
serialiseTxLedgerCddl :: ShelleyBasedEra era -> Tx era -> TextEnvelope
deserialiseTxLedgerCddl :: ShelleyBasedEra era -> TextEnvelope -> Either TextEnvelopeError (Tx era)
deserialiseByronTxCddl :: TextEnvelope -> Either TextEnvelopeCddlError (ATxAux ByteString)
serialiseWitnessLedgerCddl :: ShelleyBasedEra era -> KeyWitness era -> TextEnvelope
deserialiseWitnessLedgerCddl :: ShelleyBasedEra era -> TextEnvelope -> Either TextEnvelopeCddlError (KeyWitness era)
serializeByronTx :: ATxAux ByteString -> TextEnvelope
writeByronTxFileTextEnvelopeCddl :: File content 'Out -> ATxAux ByteString -> IO (Either (FileError ()) ())

Documentation

data TextEnvelopeCddlError Source #

Constructors

TextEnvelopeCddlErrCBORDecodingError DecoderError
TextEnvelopeCddlAesonDecodeError FilePath String
TextEnvelopeCddlUnknownKeyWitness
TextEnvelopeCddlTypeError
Fields [Text] Expected types Text Actual types
TextEnvelopeCddlErrUnknownType Text
TextEnvelopeCddlErrByronKeyWitnessUnsupported

Instances

Instances details

Data TextEnvelopeCddlError Source #
Instance details Defined in Cardano.Api.SerialiseLedgerCddl Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> TextEnvelopeCddlError -> c TextEnvelopeCddlError Source # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c TextEnvelopeCddlError Source # toConstr :: TextEnvelopeCddlError -> Constr Source # dataTypeOf :: TextEnvelopeCddlError -> DataType Source # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c TextEnvelopeCddlError) Source # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c TextEnvelopeCddlError) Source # gmapT :: (forall b. Data b => b -> b) -> TextEnvelopeCddlError -> TextEnvelopeCddlError Source # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> TextEnvelopeCddlError -> r Source # gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> TextEnvelopeCddlError -> r Source # gmapQ :: (forall d. Data d => d -> u) -> TextEnvelopeCddlError -> [u] Source # gmapQi :: Int -> (forall d. Data d => d -> u) -> TextEnvelopeCddlError -> u Source # gmapM :: Monad m => (forall d. Data d => d -> m d) -> TextEnvelopeCddlError -> m TextEnvelopeCddlError Source # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> TextEnvelopeCddlError -> m TextEnvelopeCddlError Source # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> TextEnvelopeCddlError -> m TextEnvelopeCddlError Source #
Show TextEnvelopeCddlError Source #
Instance details Defined in Cardano.Api.SerialiseLedgerCddl Methods showsPrec :: Int -> TextEnvelopeCddlError -> ShowS Source # show :: TextEnvelopeCddlError -> String Source # showList :: [TextEnvelopeCddlError] -> ShowS Source #
Error TextEnvelopeCddlError Source #
Instance details Defined in Cardano.Api.SerialiseLedgerCddl Methods prettyError :: TextEnvelopeCddlError -> Doc ann Source #
Eq TextEnvelopeCddlError Source #
Instance details Defined in Cardano.Api.SerialiseLedgerCddl Methods (==) :: TextEnvelopeCddlError -> TextEnvelopeCddlError -> Bool Source # (/=) :: TextEnvelopeCddlError -> TextEnvelopeCddlError -> Bool Source #

data FromSomeTypeCDDL c b where Source #

This GADT allows us to deserialise a tx or key witness without having to provide the era.

Constructors

FromCDDLTx
Fields :: forall b. Text CDDL type that we want -> (InAnyShelleyBasedEra Tx -> b) -> FromSomeTypeCDDL TextEnvelope b
FromCDDLWitness
Fields :: forall b. Text CDDL type that we want -> (InAnyShelleyBasedEra KeyWitness -> b) -> FromSomeTypeCDDL TextEnvelope b

cddlTypeToEra :: Text -> Either TextEnvelopeCddlError AnyShelleyBasedEra Source #

Reading one of several transaction or

readFileTextEnvelopeCddlAnyOf :: [FromSomeTypeCDDL TextEnvelope b] -> FilePath -> IO (Either (FileError TextEnvelopeCddlError) b) Source #

deserialiseFromTextEnvelopeCddlAnyOf :: [FromSomeTypeCDDL TextEnvelope b] -> TextEnvelope -> Either TextEnvelopeCddlError b Source #

writeTxFileTextEnvelopeCddl :: ShelleyBasedEra era -> File content 'Out -> Tx era -> IO (Either (FileError ()) ()) Source #

writeTxWitnessFileTextEnvelopeCddl :: ShelleyBasedEra era -> File () 'Out -> KeyWitness era -> IO (Either (FileError ()) ()) Source #

serialiseTxLedgerCddl :: ShelleyBasedEra era -> Tx era -> TextEnvelope Source #

Deprecated: Use serialiseToTextEnvelope from SerialiseTextEnvelope instead.

deserialiseTxLedgerCddl :: ShelleyBasedEra era -> TextEnvelope -> Either TextEnvelopeError (Tx era) Source #

Deprecated: Use deserialiseFromTextEnvelope from SerialiseTextEnvelope instead.

deserialiseByronTxCddl :: TextEnvelope -> Either TextEnvelopeCddlError (ATxAux ByteString) Source #

serialiseWitnessLedgerCddl :: ShelleyBasedEra era -> KeyWitness era -> TextEnvelope Source #

deserialiseWitnessLedgerCddl :: ShelleyBasedEra era -> TextEnvelope -> Either TextEnvelopeCddlError (KeyWitness era) Source #

Byron tx serialization

serializeByronTx :: ATxAux ByteString -> TextEnvelope Source #

writeByronTxFileTextEnvelopeCddl :: File content 'Out -> ATxAux ByteString -> IO (Either (FileError ()) ()) Source #