Moduleouroboros-consensus-4.2.1.0

Ouroboros.Consensus.HardFork.Combinator.Serialisation.Common

8 types
2 classes
24 values

Packageouroboros-consensus-4.2.1.0
Exports36
LicenceApache-2.0

valuedistribAnnTip :: SListI xs => AnnTip (HardForkBlock xs) -> NS AnnTip xs

valueundistribAnnTip :: SListI xs => NS AnnTip xs -> AnnTip (HardForkBlock xs)

valueisHardForkNodeToClientEnabled :: HardForkNodeToClientVersion xs -> Bool

valueisHardForkNodeToNodeEnabled :: HardForkNodeToNodeVersion xs -> Bool

valuedecodeAnnNS

:: SListI xs
=> NP (AnnDecoder f) xs
-> forall s. Decoder s (ByteString -> Either DecoderError (NS f xs))

valuedecodeEitherMismatch

:: SListI xs
=> BlockNodeToClientVersion (HardForkBlock xs)
-> Decoder s a
-> Decoder s (Either (MismatchEraInfo xs) a)

valuedecodeNS :: SListI xs => NP (Decoder s :.: f) xs -> Decoder s (NS f xs)

valuedecodeNested

:: All (DecodeDiskDep (NestedCtxt f)) xs
=> CodecConfig (HardForkBlock xs)
-> NestedCtxt f (HardForkBlock xs) a
-> forall s. Decoder s (ByteString -> a)

valuedecodeNestedCtxt

:: All (DecodeDiskDepIx (NestedCtxt f)) xs
=> CodecConfig (HardForkBlock xs)
-> forall s. Decoder s (SomeSecond (NestedCtxt f) (HardForkBlock xs))

valuedecodeTelescope :: NP (Decoder s :.: f) xs -> Decoder s (HardForkState f xs)

valuedisabledEraException

valuedistribQueryIfCurrent

:: SomeBlockQuery (QueryIfCurrent xs)
-> NS (SomeBlockQuery :.: BlockQuery) xs

valuedistribSerialisedHeader

:: SerialisedHeader (HardForkBlock xs)
-> NS SerialisedHeader xs

valueencodeEitherMismatch

:: SListI xs
=> BlockNodeToClientVersion (HardForkBlock xs)
-> a -> Encoding
-> Either (MismatchEraInfo xs) a
-> Encoding

valueencodeNS :: SListI xs => NP (f -.-> K Encoding) xs -> NS f xs -> Encoding

valueencodeNested

:: All (EncodeDiskDep (NestedCtxt f)) xs
=> CodecConfig (HardForkBlock xs)
-> NestedCtxt f (HardForkBlock xs) a
-> a
-> Encoding

valueencodeNestedCtxt

:: All (EncodeDiskDepIx (NestedCtxt f)) xs
=> CodecConfig (HardForkBlock xs)
-> SomeSecond (NestedCtxt f) (HardForkBlock xs)
-> Encoding

valueencodeTelescope

:: SListI xs
=> NP (f -.-> K Encoding) xs
-> HardForkState f xs
-> Encoding

valuefutureEraException

valueisFirstEra

:: All SingleEraBlock xs
=> NS f xs
-> Either (NS SingleEraInfo (LaterEra xs)) (f (FirstEra xs))

valuenotFirstEra :: All SingleEraBlock xs => NS f xs -> NS SingleEraInfo xs

valuepSHFC :: Proxy SerialiseConstraintsHFC

valueundistribQueryIfCurrent

:: NS (SomeBlockQuery :.: BlockQuery) xs
-> SomeBlockQuery (QueryIfCurrent xs)

valueundistribSerialisedHeader

:: NS SerialisedHeader xs
-> SerialisedHeader (HardForkBlock xs)

datadata EraNodeToClientVersion blk

Constructors

EraNodeToClientEnabled !(BlockNodeToClientVersion blk)
EraNodeToClientDisabled

Instances2Eq, Show

Eq (BlockNodeToClientVersion blk) => Eq (EraNodeToClientVersion blk)Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.HardFork.Combinator.NetworkVersion
Show (BlockNodeToClientVersion blk) => Show (EraNodeToClientVersion blk)Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.HardFork.Combinator.NetworkVersion

datadata HardForkNodeToClientVersion (xs :: [Type]) where

Constructors

HardForkNodeToClientDisabled :: BlockNodeToClientVersion x -> HardForkNodeToClientVersion (x ': xs1)
HardForkNodeToClientEnabled :: HardForkSpecificNodeToClientVersion -> NP EraNodeToClientVersion xs -> HardForkNodeToClientVersion xs

Instances2Eq, Show

(All HasNetworkProtocolVersion xs, All (Compose Eq EraNodeToClientVersion) xs) => Eq (HardForkNodeToClientVersion xs)Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.HardFork.Combinator.NetworkVersion
(All HasNetworkProtocolVersion xs, All (Compose Show EraNodeToClientVersion) xs) => Show (HardForkNodeToClientVersion xs)Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.HardFork.Combinator.NetworkVersion

datadata HardForkNodeToNodeVersion (xs :: [Type]) where

Constructors

HardForkNodeToNodeDisabled :: BlockNodeToNodeVersion x -> HardForkNodeToNodeVersion (x ': xs1)
HardForkNodeToNodeEnabled :: HardForkSpecificNodeToNodeVersion -> NP WrapNodeToNodeVersion xs -> HardForkNodeToNodeVersion xs

Instances2Eq, Show

(All HasNetworkProtocolVersion xs, All (Compose Eq WrapNodeToNodeVersion) xs) => Eq (HardForkNodeToNodeVersion xs)Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.HardFork.Combinator.NetworkVersion
(All HasNetworkProtocolVersion xs, All (Compose Show WrapNodeToNodeVersion) xs) => Show (HardForkNodeToNodeVersion xs)Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.HardFork.Combinator.NetworkVersion

datadata HardForkSpecificNodeToClientVersion

HardForkSpecificNodeToClientVersion3

Instances5Bounded, Enum, Eq, Ord, Show

Bounded HardForkSpecificNodeToClientVersionDefined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.HardFork.Combinator.NetworkVersion
Enum HardForkSpecificNodeToClientVersionDefined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.HardFork.Combinator.NetworkVersion
Eq HardForkSpecificNodeToClientVersionDefined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.HardFork.Combinator.NetworkVersion
Ord HardForkSpecificNodeToClientVersionDefined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.HardFork.Combinator.NetworkVersion
Show HardForkSpecificNodeToClientVersionDefined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.HardFork.Combinator.NetworkVersion

datadata HardForkSpecificNodeToNodeVersion

HardForkSpecificNodeToNodeVersion1

Instances5Bounded, Enum, Eq, Ord, Show

Bounded HardForkSpecificNodeToNodeVersionDefined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.HardFork.Combinator.NetworkVersion
Enum HardForkSpecificNodeToNodeVersionDefined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.HardFork.Combinator.NetworkVersion
Eq HardForkSpecificNodeToNodeVersionDefined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.HardFork.Combinator.NetworkVersion
Ord HardForkSpecificNodeToNodeVersionDefined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.HardFork.Combinator.NetworkVersion
Show HardForkSpecificNodeToNodeVersionDefined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.HardFork.Combinator.NetworkVersion

datadata AnnDecoder (f :: Type -> Type) blk

Constructors

AnnDecoder
- annDecoder :: forall s. Decoder s (ByteString -> Either DecoderError (f blk))

familytype family FirstEra (xs :: [Type]) where

Equations

FirstEra (x ': xs) = x

datadata HardForkEncoderException where

Constructors

HardForkEncoderFutureEra :: SingleEraInfo blk -> HardForkEncoderException
HardForkEncoderDisabledEra :: SingleEraInfo blk -> HardForkEncoderException
HardForkEncoderQueryHfcDisabled :: HardForkEncoderException
HardForkEncoderQueryWrongVersion :: HardForkEncoderException

Instances2Show, Exception

Show HardForkEncoderExceptionDefined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.HardFork.Combinator.Serialisation.Common
Exception HardForkEncoderExceptionDefined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.HardFork.Combinator.Serialisation.Common

familytype family LaterEra (xs :: [Type]) :: [Type] where

Equations

LaterEra (x ': xs) = xs

class

class (SingleEraBlock blk, SerialiseDiskConstraints blk, SerialiseNodeToNodeConstraints blk, SerialiseNodeToClientConstraints blk, HasNetworkProtocolVersion blk) => SerialiseConstraintsHFC blk

class

class (CanHardFork xs, All SerialiseConstraintsHFC xs, All (Compose Show EraNodeToClientVersion) xs, All (Compose Eq EraNodeToClientVersion) xs, All (Compose Show WrapNodeToNodeVersion) xs, All (Compose Eq WrapNodeToNodeVersion) xs, All (EncodeDiskDepIx (NestedCtxt Header)) xs, All (DecodeDiskDepIx (NestedCtxt Header)) xs, All HasBinaryBlockInfo xs, All HasNetworkProtocolVersion xs, All BlockSupportsLedgerQuery xs, ImmutableDbSerialiseConstraints (HardForkBlock xs), LedgerDbSerialiseConstraints (HardForkBlock xs), VolatileDbSerialiseConstraints (HardForkBlock xs), EncodeDiskDep (NestedCtxt Header) (HardForkBlock xs)) => SerialiseHFC (xs :: [Type]) where

Methods

encodeDiskHfcBlock :: CodecConfig (HardForkBlock xs) -> HardForkBlock xs -> Encoding
decodeDiskHfcBlock :: CodecConfig (HardForkBlock xs) -> forall s. Decoder s (ByteString -> Either DecoderError (HardForkBlock xs))
reconstructHfcPrefixLen :: proxy (Header (HardForkBlock xs)) -> PrefixLen
reconstructHfcNestedCtxt :: proxy (Header (HardForkBlock xs)) -> ShortByteString -> SizeInBytes -> SomeSecond (NestedCtxt Header) (HardForkBlock xs)
getHfcBinaryBlockInfo :: HardForkBlock xs -> BinaryBlockInfo
estimateHfcBlockSize :: Header (HardForkBlock xs) -> SizeInBytes

newtypenewtype SerialiseNS (f :: Type -> Type) (xs :: [Type])

Constructors

SerialiseNS
- getSerialiseNS :: NS f xs

Instances1Serialise

All (Compose Serialise f) xs => Serialise (SerialiseNS f xs)Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.HardFork.Combinator.Serialisation.Common