Safe Haskell	None
Language	Haskell2010

Ouroboros.Network.Protocol.ChainSync.Examples

Synopsis

chainSyncClientExample :: forall header block tip (m :: Type -> Type) a. (HasHeader header, HeaderHash header ~ HeaderHash block, MonadSTM m) => StrictTVar m (Chain header) -> Client header (Point block) tip m a -> ChainSyncClient header (Point block) tip m a
data Client header point tip (m :: Type -> Type) t = Client {
- rollbackward :: point -> tip -> m (Either t (Client header point tip m t))
- rollforward :: header -> m (Either t (Client header point tip m t))
- points :: [point] -> m (Either t (Client header point tip m t))
}
pureClient :: forall (m :: Type -> Type) header point tip void. Applicative m => Client header point tip m void
controlledClient :: forall (m :: Type -> Type) header point tip. MonadSTM m => ControlMessageSTM m -> Client header point tip m ()
data Tip (b :: k)
- = TipGenesis
- | Tip !SlotNo !(HeaderHash b) !BlockNo
chainSyncServerExample :: forall blk header (m :: Type -> Type) a. (HasHeader blk, MonadSTM m) => a -> StrictTVar m (ChainProducerState blk) -> (blk -> header) -> ChainSyncServer header (Point blk) (Tip blk) m a

Documentation

chainSyncClientExample :: forall header block tip (m :: Type -> Type) a. (HasHeader header, HeaderHash header ~ HeaderHash block, MonadSTM m) => StrictTVar m (Chain header) -> Client header (Point block) tip m a -> ChainSyncClient header (Point block) tip m a Source #

An instance of the client side of the chain sync protocol that consumes into a Chain stored in a StrictTVar.

This is of course only useful in tests and reference implementations since this is not a realistic chain representation.

data Client header point tip (m :: Type -> Type) t Source #

Constructors

Client
Fields rollbackward :: point -> tip -> m (Either t (Client header point tip m t)) rollforward :: header -> m (Either t (Client header point tip m t)) points :: [point] -> m (Either t (Client header point tip m t))

pureClient :: forall (m :: Type -> Type) header point tip void. Applicative m => Client header point tip m void Source #

A client which doesn't do anything and never ends. Used with chainSyncClientExample, the StrictTVar m (Chain header) will be updated but nothing further will happen.

controlledClient :: forall (m :: Type -> Type) header point tip. MonadSTM m => ControlMessageSTM m -> Client header point tip m () Source #

data Tip (b :: k) #

Constructors

TipGenesis
Tip !SlotNo !(HeaderHash b) !BlockNo

Instances

Instances details

ShowProxy b => ShowProxy (Tip b :: Type)

Instance details

Defined in Ouroboros.Network.Block

Methods

showProxy :: Proxy (Tip b) -> String

Arbitrary (Tip BlockHeader) Source #

Instance details

Defined in Ouroboros.Network.Protocol.ChainSync.Test

Methods

arbitrary :: Gen (Tip BlockHeader) #

shrink :: Tip BlockHeader -> [Tip BlockHeader] #

Generic (Tip b)

Instance details

Defined in Ouroboros.Network.Block

Associated Types

type Rep (Tip b)

Instance details

Defined in Ouroboros.Network.Block

type Rep (Tip b) = D1 ('MetaData "Tip" "Ouroboros.Network.Block" "ouroboros-network-0.23.0.0-inplace-api" 'False) (C1 ('MetaCons "TipGenesis" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Tip" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedUnpack) (Rec0 SlotNo) :*: (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (HeaderHash b)) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedUnpack) (Rec0 BlockNo))))

Methods

from :: Tip b -> Rep (Tip b) x #

to :: Rep (Tip b) x -> Tip b #

StandardHash b => Show (Tip b)

Instance details

Defined in Ouroboros.Network.Block

Methods

showsPrec :: Int -> Tip b -> ShowS #

show :: Tip b -> String #

showList :: [Tip b] -> ShowS #

StandardHash b => Eq (Tip b)

Instance details

Defined in Ouroboros.Network.Block

Methods

(==) :: Tip b -> Tip b -> Bool #

(/=) :: Tip b -> Tip b -> Bool #

StandardHash b => NoThunks (Tip b)

Instance details

Defined in Ouroboros.Network.Block

Methods

noThunks :: Context -> Tip b -> IO (Maybe ThunkInfo) #

wNoThunks :: Context -> Tip b -> IO (Maybe ThunkInfo) #

showTypeOf :: Proxy (Tip b) -> String #

type Rep (Tip b)

Instance details

Defined in Ouroboros.Network.Block

type Rep (Tip b) = D1 ('MetaData "Tip" "Ouroboros.Network.Block" "ouroboros-network-0.23.0.0-inplace-api" 'False) (C1 ('MetaCons "TipGenesis" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Tip" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedUnpack) (Rec0 SlotNo) :*: (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (HeaderHash b)) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedUnpack) (Rec0 BlockNo))))

chainSyncServerExample :: forall blk header (m :: Type -> Type) a. (HasHeader blk, MonadSTM m) => a -> StrictTVar m (ChainProducerState blk) -> (blk -> header) -> ChainSyncServer header (Point blk) (Tip blk) m a Source #

An instance of the server side of the chain sync protocol that reads from a pure ChainProducerState stored in a StrictTVar.

This is of course only useful in tests and reference implementations since this is not a realistic chain representation.