Safe Haskell	Safe-Inferred
Language	Haskell2010

Convex.NodeClient.Fold

Description

A node client that applies a fold to the stream of blocks. Unlike foldBlocks from Api, this one supports rollbacks.

Synopsis

data CatchingUp
- = CatchingUpWithNode {
  - clientPoint ∷ JSONChainPoint
  - clientBlockNo ∷ Maybe JSONBlockNo
  - serverTip ∷ Maybe JSONChainPoint
  }
- | CaughtUpWithNode {
  - tip ∷ JSONChainTip
  }
catchingUpWithNode ∷ ChainPoint → Maybe BlockNo → Maybe ChainPoint → CatchingUp
caughtUpWithNode ∷ ChainTip → CatchingUp
resumingFrom ∷ ResumingFrom → CatchingUp
catchingUp ∷ CatchingUp → Bool
caughtUp ∷ CatchingUp → Bool
getClientPoint ∷ CatchingUp → JSONChainPoint
shouldLog ∷ CatchingUp → Bool
foldClient ∷ ∀ s. s → Env → (CatchingUp → s → BlockInMode CardanoMode → IO (Maybe s)) → PipelinedLedgerStateClient
foldClient' ∷ ∀ s w. Monoid w ⇒ s → Env → (ChainPoint → w → s → IO (w, s)) → (CatchingUp → s → BlockInMode CardanoMode → IO (Maybe (w, s))) → PipelinedLedgerStateClient

Documentation

data CatchingUp Source #

Whether we have fully caught up with the node

Constructors

CatchingUpWithNode	Client is still catching up
Fields clientPoint ∷ JSONChainPoint clientBlockNo ∷ Maybe JSONBlockNo serverTip ∷ Maybe JSONChainPoint
CaughtUpWithNode	Client fully caught up (client tip == server tip)
Fields tip ∷ JSONChainTip

Instances

Instances details

FromJSON CatchingUp Source #
Instance details Defined in Convex.NodeClient.Fold Methods parseJSON ∷ Value → Parser CatchingUp Source # parseJSONList ∷ Value → Parser [CatchingUp] Source #
ToJSON CatchingUp Source #
Instance details Defined in Convex.NodeClient.Fold Methods toJSON ∷ CatchingUp → Value Source # toEncoding ∷ CatchingUp → Encoding Source # toJSONList ∷ [CatchingUp] → Value Source # toEncodingList ∷ [CatchingUp] → Encoding Source #
Generic CatchingUp Source #
Instance details Defined in Convex.NodeClient.Fold Associated Types type Rep CatchingUp ∷ Type → Type Source # Methods from ∷ CatchingUp → Rep CatchingUp x Source # to ∷ Rep CatchingUp x → CatchingUp Source #
Show CatchingUp Source #
Instance details Defined in Convex.NodeClient.Fold Methods showsPrec ∷ Int → CatchingUp → ShowS Source # show ∷ CatchingUp → String Source # showList ∷ [CatchingUp] → ShowS Source #
Eq CatchingUp Source #
Instance details Defined in Convex.NodeClient.Fold Methods (==) ∷ CatchingUp → CatchingUp → Bool Source # (/=) ∷ CatchingUp → CatchingUp → Bool Source #
type Rep CatchingUp Source #
Instance details Defined in Convex.NodeClient.Fold type Rep CatchingUp = D1 ('MetaData "CatchingUp" "Convex.NodeClient.Fold" "convex-node-client-0.2.0.0-inplace" 'False) (C1 ('MetaCons "CatchingUpWithNode" 'PrefixI 'True) (S1 ('MetaSel ('Just "clientPoint") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 JSONChainPoint) :: (S1 ('MetaSel ('Just "clientBlockNo") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe JSONBlockNo)) :: S1 ('MetaSel ('Just "serverTip") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe JSONChainPoint)))) :+: C1 ('MetaCons "CaughtUpWithNode" 'PrefixI 'True) (S1 ('MetaSel ('Just "tip") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 JSONChainTip)))

catchingUpWithNode ∷ ChainPoint → Maybe BlockNo → Maybe ChainPoint → CatchingUp Source #

caughtUpWithNode ∷ ChainTip → CatchingUp Source #

resumingFrom ∷ ResumingFrom → CatchingUp Source #

catchingUp ∷ CatchingUp → Bool Source #

caughtUp ∷ CatchingUp → Bool Source #

getClientPoint ∷ CatchingUp → JSONChainPoint Source #

shouldLog ∷ CatchingUp → Bool Source #

Whether it is a good time to log something. Returns true if

The client has fully caught up with the node, OR
The client is catching up and the block number is a multiple of 10.000

foldClient Source #

Arguments

∷ ∀ s. s	Initial state
→ Env	Node connection data
→ (CatchingUp → s → BlockInMode CardanoMode → IO (Maybe s))	Fold
→ PipelinedLedgerStateClient

Run the client until Nothing is returned

foldClient' Source #

Arguments

∷ ∀ s w. Monoid w
⇒ s	Initial state
→ Env	Node connection data
→ (ChainPoint → w → s → IO (w, s))	Rollback
→ (CatchingUp → s → BlockInMode CardanoMode → IO (Maybe (w, s)))	Fold
→ PipelinedLedgerStateClient

A variant of foldClient with more detailed control over rollbacks.