Safe Haskell	None
Language	Haskell2010

Cardano.Wallet.Primitive.SyncProgress

Contents

Types
Implementations

Description

Functionality for calculating SyncProgress of wallets.

Synopsis

data SyncProgress
- = Ready
- | Syncing !( Quantity "percent" Percentage )
- | NotResponding
newtype SyncTolerance = SyncTolerance NominalDiffTime
mkSyncTolerance :: Int -> SyncTolerance
syncProgress :: ( HasCallStack , Monad m) => SyncTolerance -> TimeInterpreter m -> SlotNo -> RelativeTime -> m SyncProgress

Types

data SyncProgress Source #

Constructors

Ready
Syncing !( Quantity "percent" Percentage )
NotResponding

Instances

Instances details

Eq SyncProgress Source #
Instance details Defined in Cardano.Wallet.Primitive.SyncProgress Methods (==) :: SyncProgress -> SyncProgress -> Bool Source # (/=) :: SyncProgress -> SyncProgress -> Bool Source #
Ord SyncProgress Source #
Instance details Defined in Cardano.Wallet.Primitive.SyncProgress Methods compare :: SyncProgress -> SyncProgress -> Ordering Source # (<) :: SyncProgress -> SyncProgress -> Bool Source # (<=) :: SyncProgress -> SyncProgress -> Bool Source # (>) :: SyncProgress -> SyncProgress -> Bool Source # (>=) :: SyncProgress -> SyncProgress -> Bool Source # max :: SyncProgress -> SyncProgress -> SyncProgress Source # min :: SyncProgress -> SyncProgress -> SyncProgress Source #
Show SyncProgress Source #
Instance details Defined in Cardano.Wallet.Primitive.SyncProgress Methods showsPrec :: Int -> SyncProgress -> ShowS Source # show :: SyncProgress -> String Source # showList :: [ SyncProgress ] -> ShowS Source #
Generic SyncProgress Source #
Instance details Defined in Cardano.Wallet.Primitive.SyncProgress Associated Types type Rep SyncProgress :: Type -> Type Source # Methods from :: SyncProgress -> Rep SyncProgress x Source # to :: Rep SyncProgress x -> SyncProgress Source #
NFData SyncProgress Source #
Instance details Defined in Cardano.Wallet.Primitive.SyncProgress Methods rnf :: SyncProgress -> () Source #
Buildable SyncProgress Source #
Instance details Defined in Cardano.Wallet.Primitive.SyncProgress Methods build :: SyncProgress -> Builder Source #
NoThunks SyncProgress Source #
Instance details Defined in Cardano.Wallet.Primitive.SyncProgress Methods noThunks :: Context -> SyncProgress -> IO ( Maybe ThunkInfo ) Source # wNoThunks :: Context -> SyncProgress -> IO ( Maybe ThunkInfo ) Source # showTypeOf :: Proxy SyncProgress -> String Source #
ToJSON ( ApiT SyncProgress ) Source #
Instance details Defined in Cardano.Wallet.Api.Types Methods toJSON :: ApiT SyncProgress -> Value Source # toEncoding :: ApiT SyncProgress -> Encoding Source # toJSONList :: [ ApiT SyncProgress ] -> Value Source # toEncodingList :: [ ApiT SyncProgress ] -> Encoding Source #
FromJSON ( ApiT SyncProgress ) Source #
Instance details Defined in Cardano.Wallet.Api.Types Methods parseJSON :: Value -> Parser ( ApiT SyncProgress ) Source # parseJSONList :: Value -> Parser [ ApiT SyncProgress ] Source #
type Rep SyncProgress Source #
Instance details Defined in Cardano.Wallet.Primitive.SyncProgress type Rep SyncProgress = D1 (' MetaData "SyncProgress" "Cardano.Wallet.Primitive.SyncProgress" "cardano-wallet-core-2022.7.1-AGKhlyz9liLKN3QqZD1gj" ' False ) ( C1 (' MetaCons "Ready" ' PrefixI ' False ) ( U1 :: Type -> Type ) :+: ( C1 (' MetaCons "Syncing" ' PrefixI ' False ) ( S1 (' MetaSel (' Nothing :: Maybe Symbol ) ' NoSourceUnpackedness ' SourceStrict ' DecidedStrict ) ( Rec0 ( Quantity "percent" Percentage ))) :+: C1 (' MetaCons "NotResponding" ' PrefixI ' False ) ( U1 :: Type -> Type )))

newtype SyncTolerance Source #

Constructors

SyncTolerance NominalDiffTime

Instances

Instances details

Eq SyncTolerance Source #
Instance details Defined in Cardano.Wallet.Primitive.SyncProgress Methods (==) :: SyncTolerance -> SyncTolerance -> Bool Source # (/=) :: SyncTolerance -> SyncTolerance -> Bool Source #
Show SyncTolerance Source #
Instance details Defined in Cardano.Wallet.Primitive.SyncProgress Methods showsPrec :: Int -> SyncTolerance -> ShowS Source # show :: SyncTolerance -> String Source # showList :: [ SyncTolerance ] -> ShowS Source #
Generic SyncTolerance Source #
Instance details Defined in Cardano.Wallet.Primitive.SyncProgress Associated Types type Rep SyncTolerance :: Type -> Type Source # Methods from :: SyncTolerance -> Rep SyncTolerance x Source # to :: Rep SyncTolerance x -> SyncTolerance Source #
ToText SyncTolerance Source #
Instance details Defined in Cardano.Wallet.Primitive.SyncProgress Methods toText :: SyncTolerance -> Text Source #
FromText SyncTolerance Source #
Instance details Defined in Cardano.Wallet.Primitive.SyncProgress Methods fromText :: Text -> Either TextDecodingError SyncTolerance Source #
type Rep SyncTolerance Source #
Instance details Defined in Cardano.Wallet.Primitive.SyncProgress type Rep SyncTolerance = D1 (' MetaData "SyncTolerance" "Cardano.Wallet.Primitive.SyncProgress" "cardano-wallet-core-2022.7.1-AGKhlyz9liLKN3QqZD1gj" ' True ) ( C1 (' MetaCons "SyncTolerance" ' PrefixI ' False ) ( S1 (' MetaSel (' Nothing :: Maybe Symbol ) ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy ) ( Rec0 NominalDiffTime )))

mkSyncTolerance :: Int -> SyncTolerance Source #

Construct a SyncTolerance from a number of seconds

Implementations

syncProgress Source #

Arguments

:: ( HasCallStack , Monad m)
=> SyncTolerance	A time tolerance inside which we consider ourselves synced
-> TimeInterpreter m	Converts slots to actual time.
-> SlotNo	Slot of latest block consumed
-> RelativeTime	Current wall clock time
-> m SyncProgress

Estimate restoration progress based on:

The slot of the latest block consumed (our progress)
The slot corresponding to the latest wall-clock time (our target)

The estimated progress is the quotient of these two quantities.

In the Cardano consensus protocol, only a fraction of slots contains blocks. Hence, the progress percentage will often be < 100%, as the slot corresponding to the current wall-clock time may not be filled with a block. The sync tolerance should be large enough to accommodate this issue.