Safe Haskell	None
Language	Haskell2010

Plutus.ChainIndex.SyncStats

Synopsis

data SyncStats = SyncStats {
}
data SyncLog = SyncLog {
- syncStateSyncLog :: SyncState
- syncStatsSyncLog :: SyncStats
- syncPeriodSyncLog :: Second
}
data SyncState
- = Synced
- | Syncing Double
- | NotSyncing
isSyncStateSynced :: SyncState -> Bool
isSyncStateNotSyncing :: SyncState -> Bool
isSyncStateSyncing :: SyncState -> Bool
logProgress :: forall effs. Member (LogMsg SyncLog) effs => [ChainSyncEvent] -> TimeSpec -> Eff effs ()
getSyncStateFromStats :: SyncStats -> SyncState
getSyncState :: Point -> Point -> SyncState
convertEventToSyncStats :: ChainSyncEvent -> SyncStats

Documentation

data SyncStats Source #

Constructors

SyncStats
Fields syncStatsAppliedBlocks :: Integer Number of applied blocks syncStatsAppliedRollbacks :: Integer Number of rollbacks syncStatsChainSyncPoint :: Point Chain index syncing tip syncStatsNodePoint :: Point Current tip of the node

Instances

Instances details

Eq SyncStats Source #
Instance details Defined in Plutus.ChainIndex.SyncStats Methods (==) :: SyncStats -> SyncStats -> Bool Source # (/=) :: SyncStats -> SyncStats -> Bool Source #
Show SyncStats Source #
Instance details Defined in Plutus.ChainIndex.SyncStats Methods showsPrec :: Int -> SyncStats -> ShowS Source # show :: SyncStats -> String Source # showList :: [SyncStats] -> ShowS Source #
Generic SyncStats Source #
Instance details Defined in Plutus.ChainIndex.SyncStats Associated Types type Rep SyncStats :: Type -> Type Source # Methods from :: SyncStats -> Rep SyncStats x Source # to :: Rep SyncStats x -> SyncStats Source #
Semigroup SyncStats Source #
Instance details Defined in Plutus.ChainIndex.SyncStats Methods (<>) :: SyncStats -> SyncStats -> SyncStats Source # sconcat :: NonEmpty SyncStats -> SyncStats Source # stimes :: Integral b => b -> SyncStats -> SyncStats Source #
Monoid SyncStats Source #
Instance details Defined in Plutus.ChainIndex.SyncStats Methods mempty :: SyncStats Source # mappend :: SyncStats -> SyncStats -> SyncStats Source # mconcat :: [SyncStats] -> SyncStats Source #
ToJSON SyncStats Source #
Instance details Defined in Plutus.ChainIndex.SyncStats Methods toJSON :: SyncStats -> Value Source # toEncoding :: SyncStats -> Encoding Source # toJSONList :: [SyncStats] -> Value Source # toEncodingList :: [SyncStats] -> Encoding Source #
FromJSON SyncStats Source #
Instance details Defined in Plutus.ChainIndex.SyncStats Methods parseJSON :: Value -> Parser SyncStats Source # parseJSONList :: Value -> Parser [SyncStats] Source #
ToObject SyncStats Source #
Instance details Defined in Plutus.ChainIndex.SyncStats Methods toObject :: TracingVerbosity -> SyncStats -> Object textTransformer :: SyncStats -> Object -> Text
type Rep SyncStats Source #
Instance details Defined in Plutus.ChainIndex.SyncStats type Rep SyncStats = D1 ('MetaData "SyncStats" "Plutus.ChainIndex.SyncStats" "plutus-chain-index-1.1.0.0-KDkoMMh6X2yB1S5IHvoANH" 'False) (C1 ('MetaCons "SyncStats" 'PrefixI 'True) ((S1 ('MetaSel ('Just "syncStatsAppliedBlocks") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Integer) :: S1 ('MetaSel ('Just "syncStatsAppliedRollbacks") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Integer)) :: (S1 ('MetaSel ('Just "syncStatsChainSyncPoint") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Point) :*: S1 ('MetaSel ('Just "syncStatsNodePoint") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Point))))

data SyncLog Source #

Constructors

SyncLog
Fields syncStateSyncLog :: SyncState State of the syncing syncStatsSyncLog :: SyncStats Stats of the syncing syncPeriodSyncLog :: Second Period in seconds used to accumulate log events

Instances

Instances details

Eq SyncLog Source #
Instance details Defined in Plutus.ChainIndex.SyncStats Methods (==) :: SyncLog -> SyncLog -> Bool Source # (/=) :: SyncLog -> SyncLog -> Bool Source #
Show SyncLog Source #
Instance details Defined in Plutus.ChainIndex.SyncStats Methods showsPrec :: Int -> SyncLog -> ShowS Source # show :: SyncLog -> String Source # showList :: [SyncLog] -> ShowS Source #
Generic SyncLog Source #
Instance details Defined in Plutus.ChainIndex.SyncStats Associated Types type Rep SyncLog :: Type -> Type Source # Methods from :: SyncLog -> Rep SyncLog x Source # to :: Rep SyncLog x -> SyncLog Source #
ToJSON SyncLog Source #
Instance details Defined in Plutus.ChainIndex.SyncStats Methods toJSON :: SyncLog -> Value Source # toEncoding :: SyncLog -> Encoding Source # toJSONList :: [SyncLog] -> Value Source # toEncodingList :: [SyncLog] -> Encoding Source #
FromJSON SyncLog Source #
Instance details Defined in Plutus.ChainIndex.SyncStats Methods parseJSON :: Value -> Parser SyncLog Source # parseJSONList :: Value -> Parser [SyncLog] Source #
Pretty SyncLog Source #
Instance details Defined in Plutus.ChainIndex.SyncStats Methods pretty :: SyncLog -> Doc ann Source # prettyList :: [SyncLog] -> Doc ann Source #
ToObject SyncLog Source #
Instance details Defined in Plutus.ChainIndex.SyncStats Methods toObject :: TracingVerbosity -> SyncLog -> Object textTransformer :: SyncLog -> Object -> Text
type Rep SyncLog Source #
Instance details Defined in Plutus.ChainIndex.SyncStats type Rep SyncLog = D1 ('MetaData "SyncLog" "Plutus.ChainIndex.SyncStats" "plutus-chain-index-1.1.0.0-KDkoMMh6X2yB1S5IHvoANH" 'False) (C1 ('MetaCons "SyncLog" 'PrefixI 'True) (S1 ('MetaSel ('Just "syncStateSyncLog") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 SyncState) :: (S1 ('MetaSel ('Just "syncStatsSyncLog") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 SyncStats) :: S1 ('MetaSel ('Just "syncPeriodSyncLog") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Second))))

data SyncState Source #

Constructors

Synced
Syncing Double
NotSyncing

Instances

Instances details

Eq SyncState Source #
Instance details Defined in Plutus.ChainIndex.SyncStats Methods (==) :: SyncState -> SyncState -> Bool Source # (/=) :: SyncState -> SyncState -> Bool Source #
Show SyncState Source #
Instance details Defined in Plutus.ChainIndex.SyncStats Methods showsPrec :: Int -> SyncState -> ShowS Source # show :: SyncState -> String Source # showList :: [SyncState] -> ShowS Source #
Generic SyncState Source #
Instance details Defined in Plutus.ChainIndex.SyncStats Associated Types type Rep SyncState :: Type -> Type Source # Methods from :: SyncState -> Rep SyncState x Source # to :: Rep SyncState x -> SyncState Source #
ToJSON SyncState Source #
Instance details Defined in Plutus.ChainIndex.SyncStats Methods toJSON :: SyncState -> Value Source # toEncoding :: SyncState -> Encoding Source # toJSONList :: [SyncState] -> Value Source # toEncodingList :: [SyncState] -> Encoding Source #
FromJSON SyncState Source #
Instance details Defined in Plutus.ChainIndex.SyncStats Methods parseJSON :: Value -> Parser SyncState Source # parseJSONList :: Value -> Parser [SyncState] Source #
Pretty SyncState Source #
Instance details Defined in Plutus.ChainIndex.SyncStats Methods pretty :: SyncState -> Doc ann Source # prettyList :: [SyncState] -> Doc ann Source #
ToObject SyncState Source #
Instance details Defined in Plutus.ChainIndex.SyncStats Methods toObject :: TracingVerbosity -> SyncState -> Object textTransformer :: SyncState -> Object -> Text
type Rep SyncState Source #
Instance details Defined in Plutus.ChainIndex.SyncStats type Rep SyncState = D1 ('MetaData "SyncState" "Plutus.ChainIndex.SyncStats" "plutus-chain-index-1.1.0.0-KDkoMMh6X2yB1S5IHvoANH" 'False) (C1 ('MetaCons "Synced" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "Syncing" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Double)) :+: C1 ('MetaCons "NotSyncing" 'PrefixI 'False) (U1 :: Type -> Type)))

isSyncStateSynced :: SyncState -> Bool Source #

isSyncStateNotSyncing :: SyncState -> Bool Source #

isSyncStateSyncing :: SyncState -> Bool Source #

logProgress :: forall effs. Member (LogMsg SyncLog) effs => [ChainSyncEvent] -> TimeSpec -> Eff effs () Source #

Log syncing summary.

getSyncStateFromStats :: SyncStats -> SyncState Source #

Get the SyncState for a SyncState.

TODO: The syncing percentage is valid when the node is already fully synced. But when the node and chain-index are started at the same time, the syncing percentage is not a valid number considering the actual tip of the node. Find a better way to calculate this percentage.

getSyncState :: Point -> Point -> SyncState Source #

convertEventToSyncStats :: ChainSyncEvent -> SyncStats Source #