Safe Haskell	None
Language	Haskell2010

Cardano.Api.SerialiseLedgerCddl

Contents

Reading one of several transaction or
Byron tx serialization

Description

Ledger CDDL Serialisation

Synopsis

data TextEnvelopeCddl = TextEnvelopeCddl {
- teCddlType :: !Text
- teCddlDescription :: !Text
- teCddlRawCBOR :: !ByteString
}
data TextEnvelopeCddlError
- = TextEnvelopeCddlErrCBORDecodingError DecoderError
- | TextEnvelopeCddlAesonDecodeError FilePath String
- | TextEnvelopeCddlUnknownKeyWitness
- | TextEnvelopeCddlTypeError [Text] Text
- | TextEnvelopeCddlErrUnknownType Text
- | TextEnvelopeCddlErrByronKeyWitnessUnsupported
data FromSomeTypeCDDL c b where
- FromCDDLTx :: Text -> (InAnyShelleyBasedEra Tx -> b) -> FromSomeTypeCDDL TextEnvelopeCddl b
- FromCDDLWitness :: Text -> (InAnyShelleyBasedEra KeyWitness -> b) -> FromSomeTypeCDDL TextEnvelopeCddl b
readFileTextEnvelopeCddlAnyOf :: [FromSomeTypeCDDL TextEnvelopeCddl b] -> FilePath -> IO (Either (FileError TextEnvelopeCddlError) b)
deserialiseFromTextEnvelopeCddlAnyOf :: [FromSomeTypeCDDL TextEnvelopeCddl b] -> TextEnvelopeCddl -> 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 -> TextEnvelopeCddl
deserialiseTxLedgerCddl :: ShelleyBasedEra era -> TextEnvelopeCddl -> Either TextEnvelopeCddlError (Tx era)
deserialiseByronTxCddl :: TextEnvelopeCddl -> Either TextEnvelopeCddlError (ATxAux ByteString)
serialiseWitnessLedgerCddl :: forall era. ShelleyBasedEra era -> KeyWitness era -> TextEnvelopeCddl
deserialiseWitnessLedgerCddl :: ShelleyBasedEra era -> TextEnvelopeCddl -> Either TextEnvelopeCddlError (KeyWitness era)
serializeByronTx :: ATxAux ByteString -> TextEnvelopeCddl
writeByronTxFileTextEnvelopeCddl :: File content Out -> ATxAux ByteString -> IO (Either (FileError ()) ())

Documentation

data TextEnvelopeCddl Source #

Constructors

TextEnvelopeCddl
Fields teCddlType :: !Text teCddlDescription :: !Text teCddlRawCBOR :: !ByteString

Instances

Instances details

Eq TextEnvelopeCddl Source #
Instance details Defined in Cardano.Api.SerialiseLedgerCddl Methods (==) :: TextEnvelopeCddl -> TextEnvelopeCddl -> Bool Source # (/=) :: TextEnvelopeCddl -> TextEnvelopeCddl -> Bool Source #
Show TextEnvelopeCddl Source #
Instance details Defined in Cardano.Api.SerialiseLedgerCddl Methods showsPrec :: Int -> TextEnvelopeCddl -> ShowS Source # show :: TextEnvelopeCddl -> String Source # showList :: [TextEnvelopeCddl] -> ShowS Source #
FromJSON TextEnvelopeCddl Source #
Instance details Defined in Cardano.Api.SerialiseLedgerCddl Methods parseJSON :: Value -> Parser TextEnvelopeCddl # parseJSONList :: Value -> Parser [TextEnvelopeCddl] # omittedField :: Maybe TextEnvelopeCddl #
ToJSON TextEnvelopeCddl Source #
Instance details Defined in Cardano.Api.SerialiseLedgerCddl Methods toJSON :: TextEnvelopeCddl -> Value # toEncoding :: TextEnvelopeCddl -> Encoding # toJSONList :: [TextEnvelopeCddl] -> Value # toEncodingList :: [TextEnvelopeCddl] -> Encoding # omitField :: TextEnvelopeCddl -> Bool #

data TextEnvelopeCddlError Source #

Constructors

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

Instances

Instances details

Eq TextEnvelopeCddlError Source #
Instance details Defined in Cardano.Api.SerialiseLedgerCddl Methods (==) :: TextEnvelopeCddlError -> TextEnvelopeCddlError -> Bool Source # (/=) :: TextEnvelopeCddlError -> TextEnvelopeCddlError -> Bool Source #
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 #

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 :: Text CDDL type that we want -> (InAnyShelleyBasedEra Tx -> b) -> FromSomeTypeCDDL TextEnvelopeCddl b
FromCDDLWitness
Fields :: Text CDDL type that we want -> (InAnyShelleyBasedEra KeyWitness -> b) -> FromSomeTypeCDDL TextEnvelopeCddl b

Reading one of several transaction or

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

deserialiseFromTextEnvelopeCddlAnyOf :: [FromSomeTypeCDDL TextEnvelopeCddl b] -> TextEnvelopeCddl -> 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 -> TextEnvelopeCddl Source #

deserialiseTxLedgerCddl :: ShelleyBasedEra era -> TextEnvelopeCddl -> Either TextEnvelopeCddlError (Tx era) Source #

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

serialiseWitnessLedgerCddl :: forall era. ShelleyBasedEra era -> KeyWitness era -> TextEnvelopeCddl Source #

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

Byron tx serialization

serializeByronTx :: ATxAux ByteString -> TextEnvelopeCddl Source #

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