Safe Haskell	None
Language	Haskell2010

Ouroboros.Consensus.Node.Serialisation

Contents

Defaults
Re-exported for convenience

Description

Serialisation for sending things across the network.

We separate NodeToNode from NodeToClient to be very explicit about what gets sent where.

Unlike in Ouroboros.Consensus.Storage.Serialisation, we don't separate the encoder from the decoder, because the reasons don't apply: we always need both directions and we don't have access to the bytestrings that could be used for the annotations (we use CBOR-in-CBOR in those cases).

Synopsis

class SerialiseNodeToNode blk a where
- encodeNodeToNode :: CodecConfig blk -> BlockNodeToNodeVersion blk -> a -> Encoding
- decodeNodeToNode :: CodecConfig blk -> BlockNodeToNodeVersion blk -> forall s. Decoder s a
class SerialiseNodeToClient blk a where
- encodeNodeToClient :: CodecConfig blk -> BlockNodeToClientVersion blk -> a -> Encoding
- decodeNodeToClient :: CodecConfig blk -> BlockNodeToClientVersion blk -> forall s. Decoder s a
class SerialiseResult blk query where
- encodeResult :: forall result. CodecConfig blk -> BlockNodeToClientVersion blk -> query result -> result -> Encoding
- decodeResult :: forall result. CodecConfig blk -> BlockNodeToClientVersion blk -> query result -> forall s. Decoder s result
defaultEncodeCBORinCBOR :: Serialise a => a -> Encoding
defaultDecodeCBORinCBOR :: Serialise a => Decoder s a
data Some (f :: k -> Type) where
- Some :: forall k (f :: k -> Type) (a :: k). f a -> Some f

Documentation

class SerialiseNodeToNode blk a where Source #

Serialise a type a so that it can be sent across network via a node-to-node protocol.

Minimal complete definition

Nothing

Methods

encodeNodeToNode :: CodecConfig blk -> BlockNodeToNodeVersion blk -> a -> Encoding Source #

default encodeNodeToNode :: Serialise a => CodecConfig blk -> BlockNodeToNodeVersion blk -> a -> Encoding Source #

decodeNodeToNode :: CodecConfig blk -> BlockNodeToNodeVersion blk -> forall s. Decoder s a Source #

default decodeNodeToNode :: Serialise a => CodecConfig blk -> BlockNodeToNodeVersion blk -> forall s. Decoder s a Source #

Instances

Instances details

SerialiseNodeToNode blk (GenTxId blk) => SerialiseNodeToNode blk (WrapGenTxId blk) Source #
Instance details Defined in Ouroboros.Consensus.Node.Serialisation Methods encodeNodeToNode :: CodecConfig blk -> BlockNodeToNodeVersion blk -> WrapGenTxId blk -> Encoding Source # decodeNodeToNode :: CodecConfig blk -> BlockNodeToNodeVersion blk -> forall s. Decoder s (WrapGenTxId blk) Source #
SerialiseNodeToNode blk blk => SerialiseNodeToNode blk (I blk) Source #
Instance details Defined in Ouroboros.Consensus.Node.Serialisation Methods encodeNodeToNode :: CodecConfig blk -> BlockNodeToNodeVersion blk -> I blk -> Encoding Source # decodeNodeToNode :: CodecConfig blk -> BlockNodeToNodeVersion blk -> forall s. Decoder s (I blk) Source #
SerialiseHFC xs => SerialiseNodeToNode (HardForkBlock xs) (GenTxId (HardForkBlock xs)) Source #
Instance details Defined in Ouroboros.Consensus.HardFork.Combinator.Serialisation.SerialiseNodeToNode Methods encodeNodeToNode :: CodecConfig (HardForkBlock xs) -> BlockNodeToNodeVersion (HardForkBlock xs) -> GenTxId (HardForkBlock xs) -> Encoding Source # decodeNodeToNode :: CodecConfig (HardForkBlock xs) -> BlockNodeToNodeVersion (HardForkBlock xs) -> forall s. Decoder s (GenTxId (HardForkBlock xs)) Source #
SerialiseHFC xs => SerialiseNodeToNode (HardForkBlock xs) (GenTx (HardForkBlock xs)) Source #
Instance details Defined in Ouroboros.Consensus.HardFork.Combinator.Serialisation.SerialiseNodeToNode Methods encodeNodeToNode :: CodecConfig (HardForkBlock xs) -> BlockNodeToNodeVersion (HardForkBlock xs) -> GenTx (HardForkBlock xs) -> Encoding Source # decodeNodeToNode :: CodecConfig (HardForkBlock xs) -> BlockNodeToNodeVersion (HardForkBlock xs) -> forall s. Decoder s (GenTx (HardForkBlock xs)) Source #
SerialiseHFC xs => SerialiseNodeToNode (HardForkBlock xs) (SerialisedHeader (HardForkBlock xs)) Source #
Instance details Defined in Ouroboros.Consensus.HardFork.Combinator.Serialisation.SerialiseNodeToNode Methods encodeNodeToNode :: CodecConfig (HardForkBlock xs) -> BlockNodeToNodeVersion (HardForkBlock xs) -> SerialisedHeader (HardForkBlock xs) -> Encoding Source # decodeNodeToNode :: CodecConfig (HardForkBlock xs) -> BlockNodeToNodeVersion (HardForkBlock xs) -> forall s. Decoder s (SerialisedHeader (HardForkBlock xs)) Source #
SerialiseHFC xs => SerialiseNodeToNode (HardForkBlock xs) (Serialised (HardForkBlock xs)) Source #
Instance details Defined in Ouroboros.Consensus.HardFork.Combinator.Serialisation.SerialiseNodeToNode Methods encodeNodeToNode :: CodecConfig (HardForkBlock xs) -> BlockNodeToNodeVersion (HardForkBlock xs) -> Serialised (HardForkBlock xs) -> Encoding Source # decodeNodeToNode :: CodecConfig (HardForkBlock xs) -> BlockNodeToNodeVersion (HardForkBlock xs) -> forall s. Decoder s (Serialised (HardForkBlock xs)) Source #
SerialiseHFC xs => SerialiseNodeToNode (HardForkBlock xs) (Header (HardForkBlock xs)) Source #
Instance details Defined in Ouroboros.Consensus.HardFork.Combinator.Serialisation.SerialiseNodeToNode Methods encodeNodeToNode :: CodecConfig (HardForkBlock xs) -> BlockNodeToNodeVersion (HardForkBlock xs) -> Header (HardForkBlock xs) -> Encoding Source # decodeNodeToNode :: CodecConfig (HardForkBlock xs) -> BlockNodeToNodeVersion (HardForkBlock xs) -> forall s. Decoder s (Header (HardForkBlock xs)) Source #
SerialiseHFC xs => SerialiseNodeToNode (HardForkBlock xs) (HardForkBlock xs) Source #
Instance details Defined in Ouroboros.Consensus.HardFork.Combinator.Serialisation.SerialiseNodeToNode Methods encodeNodeToNode :: CodecConfig (HardForkBlock xs) -> BlockNodeToNodeVersion (HardForkBlock xs) -> HardForkBlock xs -> Encoding Source # decodeNodeToNode :: CodecConfig (HardForkBlock xs) -> BlockNodeToNodeVersion (HardForkBlock xs) -> forall s. Decoder s (HardForkBlock xs) Source #

class SerialiseNodeToClient blk a where Source #

Serialise a type a so that it can be sent across the network via node-to-client protocol.

Minimal complete definition

Nothing

Methods

encodeNodeToClient :: CodecConfig blk -> BlockNodeToClientVersion blk -> a -> Encoding Source #

default encodeNodeToClient :: Serialise a => CodecConfig blk -> BlockNodeToClientVersion blk -> a -> Encoding Source #

decodeNodeToClient :: CodecConfig blk -> BlockNodeToClientVersion blk -> forall s. Decoder s a Source #

default decodeNodeToClient :: Serialise a => CodecConfig blk -> BlockNodeToClientVersion blk -> forall s. Decoder s a Source #

Instances

Instances details

SerialiseNodeToClient blk (ApplyTxErr blk) => SerialiseNodeToClient blk (WrapApplyTxErr blk) Source #
Instance details Defined in Ouroboros.Consensus.Node.Serialisation Methods encodeNodeToClient :: CodecConfig blk -> BlockNodeToClientVersion blk -> WrapApplyTxErr blk -> Encoding Source # decodeNodeToClient :: CodecConfig blk -> BlockNodeToClientVersion blk -> forall s. Decoder s (WrapApplyTxErr blk) Source #
SerialiseNodeToClient blk blk => SerialiseNodeToClient blk (I blk) Source #
Instance details Defined in Ouroboros.Consensus.Node.Serialisation Methods encodeNodeToClient :: CodecConfig blk -> BlockNodeToClientVersion blk -> I blk -> Encoding Source # decodeNodeToClient :: CodecConfig blk -> BlockNodeToClientVersion blk -> forall s. Decoder s (I blk) Source #
SerialiseHFC xs => SerialiseNodeToClient (HardForkBlock xs) (HardForkApplyTxErr xs) Source #
Instance details Defined in Ouroboros.Consensus.HardFork.Combinator.Serialisation.SerialiseNodeToClient Methods encodeNodeToClient :: CodecConfig (HardForkBlock xs) -> BlockNodeToClientVersion (HardForkBlock xs) -> HardForkApplyTxErr xs -> Encoding Source # decodeNodeToClient :: CodecConfig (HardForkBlock xs) -> BlockNodeToClientVersion (HardForkBlock xs) -> forall s. Decoder s (HardForkApplyTxErr xs) Source #
SerialiseHFC xs => SerialiseNodeToClient (HardForkBlock xs) (GenTx (HardForkBlock xs)) Source #
Instance details Defined in Ouroboros.Consensus.HardFork.Combinator.Serialisation.SerialiseNodeToClient Methods encodeNodeToClient :: CodecConfig (HardForkBlock xs) -> BlockNodeToClientVersion (HardForkBlock xs) -> GenTx (HardForkBlock xs) -> Encoding Source # decodeNodeToClient :: CodecConfig (HardForkBlock xs) -> BlockNodeToClientVersion (HardForkBlock xs) -> forall s. Decoder s (GenTx (HardForkBlock xs)) Source #
SerialiseHFC xs => SerialiseNodeToClient (HardForkBlock xs) (Serialised (HardForkBlock xs)) Source #
Instance details Defined in Ouroboros.Consensus.HardFork.Combinator.Serialisation.SerialiseNodeToClient Methods encodeNodeToClient :: CodecConfig (HardForkBlock xs) -> BlockNodeToClientVersion (HardForkBlock xs) -> Serialised (HardForkBlock xs) -> Encoding Source # decodeNodeToClient :: CodecConfig (HardForkBlock xs) -> BlockNodeToClientVersion (HardForkBlock xs) -> forall s. Decoder s (Serialised (HardForkBlock xs)) Source #
SerialiseHFC xs => SerialiseNodeToClient (HardForkBlock xs) (HardForkBlock xs) Source #
Instance details Defined in Ouroboros.Consensus.HardFork.Combinator.Serialisation.SerialiseNodeToClient Methods encodeNodeToClient :: CodecConfig (HardForkBlock xs) -> BlockNodeToClientVersion (HardForkBlock xs) -> HardForkBlock xs -> Encoding Source # decodeNodeToClient :: CodecConfig (HardForkBlock xs) -> BlockNodeToClientVersion (HardForkBlock xs) -> forall s. Decoder s (HardForkBlock xs) Source #
SerialiseHFC xs => SerialiseNodeToClient (HardForkBlock xs) (SomeSecond Query (HardForkBlock xs)) Source #
Instance details Defined in Ouroboros.Consensus.HardFork.Combinator.Serialisation.SerialiseNodeToClient Methods encodeNodeToClient :: CodecConfig (HardForkBlock xs) -> BlockNodeToClientVersion (HardForkBlock xs) -> SomeSecond Query (HardForkBlock xs) -> Encoding Source # decodeNodeToClient :: CodecConfig (HardForkBlock xs) -> BlockNodeToClientVersion (HardForkBlock xs) -> forall s. Decoder s (SomeSecond Query (HardForkBlock xs)) Source #

class SerialiseResult blk query where Source #

How to serialise the result of the result of a query.

The LocalStateQuery protocol is a node-to-client protocol, hence the NodeToClientVersion argument.

Methods

encodeResult :: forall result. CodecConfig blk -> BlockNodeToClientVersion blk -> query result -> result -> Encoding Source #

decodeResult :: forall result. CodecConfig blk -> BlockNodeToClientVersion blk -> query result -> forall s. Decoder s result Source #

Instances

Instances details

SerialiseHFC xs => SerialiseResult (HardForkBlock xs) (Query (HardForkBlock xs)) Source #

Instance details

Defined in Ouroboros.Consensus.HardFork.Combinator.Serialisation.SerialiseNodeToClient

Methods

encodeResult :: CodecConfig (HardForkBlock xs) -> BlockNodeToClientVersion (HardForkBlock xs) -> Query (HardForkBlock xs) result -> result -> Encoding Source #

decodeResult :: CodecConfig (HardForkBlock xs) -> BlockNodeToClientVersion (HardForkBlock xs) -> Query (HardForkBlock xs) result -> forall s. Decoder s result Source #

Defaults

defaultEncodeCBORinCBOR :: Serialise a => a -> Encoding Source #

Uses the Serialise instance, but wraps it in CBOR-in-CBOR.

Use this for the SerialiseNodeToNode and/or SerialiseNodeToClient instance of blk and/or Header blk, which require CBOR-in-CBOR to be compatible with the corresponding Serialised instance.

defaultDecodeCBORinCBOR :: Serialise a => Decoder s a Source #

Inverse of defaultEncodeCBORinCBOR

Re-exported for convenience

data Some (f :: k -> Type) where #

Constructors

Some :: forall k (f :: k -> Type) (a :: k). f a -> Some f

Instances

Instances details

Serialise (Some QueryAnytime) Source #
Instance details Defined in Ouroboros.Consensus.HardFork.Combinator.Ledger.Query Methods encode :: Some QueryAnytime -> Encoding Source # decode :: Decoder s (Some QueryAnytime) Source # encodeList :: [Some QueryAnytime] -> Encoding Source # decodeList :: Decoder s [Some QueryAnytime] Source #