Safe Haskell	Safe-Inferred
Language	Haskell2010

Ouroboros.Network.Protocol.ChainSync.Client

Contents

Protocol type for the client
Execution as a typed protocol
Null chain sync client
Utilities

Description

A view of the chain synchronisation protocol from the point of view of the client.

This provides a view that uses less complex types and should be easier to use than the underlying typed protocol itself.

For execution, a conversion into the typed protocol is provided.

Synopsis

newtype ChainSyncClient header point tip m a = ChainSyncClient {
- runChainSyncClient ∷ m (ClientStIdle header point tip m a)
}
data ClientStIdle header point tip m a where
- SendMsgRequestNext ∷ m () → ClientStNext header point tip m a → ClientStIdle header point tip m a
- SendMsgFindIntersect ∷ [point] → ClientStIntersect header point tip m a → ClientStIdle header point tip m a
- SendMsgDone ∷ a → ClientStIdle header point tip m a
data ClientStNext header point tip m a = ClientStNext {
- recvMsgRollForward ∷ header → tip → ChainSyncClient header point tip m a
- recvMsgRollBackward ∷ point → tip → ChainSyncClient header point tip m a
}
data ClientStIntersect header point tip m a = ClientStIntersect {
- recvMsgIntersectFound ∷ point → tip → ChainSyncClient header point tip m a
- recvMsgIntersectNotFound ∷ tip → ChainSyncClient header point tip m a
}
chainSyncClientPeer ∷ ∀ header point tip m a. Monad m ⇒ ChainSyncClient header point tip m a → Peer (ChainSync header point tip) AsClient StIdle m a
chainSyncClientNull ∷ MonadTimer m ⇒ ChainSyncClient header point tip m a
mapChainSyncClient ∷ ∀ header header' point point' tip tip' m a. Functor m ⇒ (point → point') → (point' → point) → (header' → header) → (tip' → tip) → ChainSyncClient header point tip m a → ChainSyncClient header' point' tip' m a

Protocol type for the client

The protocol states from the point of view of the client.

newtype ChainSyncClient header point tip m a Source #

A chain sync protocol client, on top of some effect m. The first choice of request is within that m.

Constructors

ChainSyncClient
Fields runChainSyncClient ∷ m (ClientStIdle header point tip m a)

data ClientStIdle header point tip m a where Source #

In the StIdle protocol state, the server does not have agency and can choose to send a request next, or a find intersection message.

Constructors

SendMsgRequestNext	Send the `MsgRequestNext`, with handlers for the replies. The handlers for this message are more complicated than most RPCs because the server can either send us a reply immediately or it can send us a `MsgAwaitReply` to indicate that the server itself has to block for a state change before it can send us the reply. In the waiting case, the client gets the chance to take a local action.
Fields ∷ m () promptly invoked when `MsgAwaitReply` is received → ClientStNext header point tip m a → ClientStIdle header point tip m a
SendMsgFindIntersect ∷ [point] → ClientStIntersect header point tip m a → ClientStIdle header point tip m a	Send the `MsgFindIntersect`, with handlers for the replies.
SendMsgDone ∷ a → ClientStIdle header point tip m a	The client decided to end the protocol.

data ClientStNext header point tip m a Source #

In the StNext protocol state, the client does not have agency and is waiting to receive either

a roll forward,
roll back message,

It must be prepared to handle any of these.

Constructors

ClientStNext
Fields recvMsgRollForward ∷ header → tip → ChainSyncClient header point tip m a recvMsgRollBackward ∷ point → tip → ChainSyncClient header point tip m a

data ClientStIntersect header point tip m a Source #

In the StIntersect protocol state, the client does not have agency and is waiting to receive:

an intersection improved,
unchanged message,
the termination message.

It must be prepared to handle any of these.

Constructors

ClientStIntersect
Fields recvMsgIntersectFound ∷ point → tip → ChainSyncClient header point tip m a recvMsgIntersectNotFound ∷ tip → ChainSyncClient header point tip m a

Execution as a typed protocol

chainSyncClientPeer ∷ ∀ header point tip m a. Monad m ⇒ ChainSyncClient header point tip m a → Peer (ChainSync header point tip) AsClient StIdle m a Source #

Interpret a ChainSyncClient action sequence as a Peer on the client side of the ChainSyncProtocol.

Null chain sync client

chainSyncClientNull ∷ MonadTimer m ⇒ ChainSyncClient header point tip m a Source #

Deprecated: Use Ouroboros.Network.NodeToClient.chainSyncPeerNull

A chain sync client which never sends any message.

Utilities

mapChainSyncClient ∷ ∀ header header' point point' tip tip' m a. Functor m ⇒ (point → point') → (point' → point) → (header' → header) → (tip' → tip) → ChainSyncClient header point tip m a → ChainSyncClient header' point' tip' m a Source #

Transform a ChainSyncClient by mapping over the tx header and the chain tip values.

Note the direction of the individual mapping functions corresponds to whether the types are used as protocol inputs or outputs (or both, as is the case for points).