Safe Haskell	Safe-Inferred
Language	Haskell2010

Ouroboros.Network.PeerSelection.LedgerPeers.Type

Description

Various types related to ledger peers. This module is re-exported from Ouroboros.Network.PeerSelection.LedgerPeers.

Synopsis

newtype PoolStake = PoolStake {
- unPoolStake ∷ Rational
}
newtype AccPoolStake = AccPoolStake {
- unAccPoolStake ∷ Rational
}
data IsBigLedgerPeer
- = IsBigLedgerPeer
- | IsNotBigLedgerPeer
data LedgerStateJudgement
- = YoungEnough
- | TooOld
data LedgerPeersConsensusInterface m = LedgerPeersConsensusInterface {
- lpGetLatestSlot ∷ STM m (WithOrigin SlotNo)
- lpGetLedgerStateJudgement ∷ STM m LedgerStateJudgement
- lpGetLedgerPeers ∷ STM m [(PoolStake, NonEmpty RelayAccessPoint)]
}
data UseLedgerPeers
- = DontUseLedgerPeers
- | UseLedgerPeers AfterSlot
data AfterSlot
- = Always
- | After SlotNo
isLedgerPeersEnabled ∷ UseLedgerPeers → Bool

Documentation

newtype PoolStake Source #

The relative stake of a stakepool in relation to the total amount staked. A value in the [0, 1] range.

Constructors

PoolStake
Fields unPoolStake ∷ Rational

Instances

Instances details

Num PoolStake Source #
Instance details Defined in Ouroboros.Network.PeerSelection.LedgerPeers.Type Methods (+) ∷ PoolStake → PoolStake → PoolStake # (-) ∷ PoolStake → PoolStake → PoolStake # (*) ∷ PoolStake → PoolStake → PoolStake # negate ∷ PoolStake → PoolStake # abs ∷ PoolStake → PoolStake # signum ∷ PoolStake → PoolStake # fromInteger ∷ Integer → PoolStake #
Fractional PoolStake Source #
Instance details Defined in Ouroboros.Network.PeerSelection.LedgerPeers.Type Methods (/) ∷ PoolStake → PoolStake → PoolStake # recip ∷ PoolStake → PoolStake # fromRational ∷ Rational → PoolStake #
Show PoolStake Source #
Instance details Defined in Ouroboros.Network.PeerSelection.LedgerPeers.Type Methods showsPrec ∷ Int → PoolStake → ShowS # show ∷ PoolStake → String # showList ∷ [PoolStake] → ShowS #
NFData PoolStake Source #
Instance details Defined in Ouroboros.Network.PeerSelection.LedgerPeers.Type Methods rnf ∷ PoolStake → () #
Eq PoolStake Source #
Instance details Defined in Ouroboros.Network.PeerSelection.LedgerPeers.Type Methods (==) ∷ PoolStake → PoolStake → Bool # (/=) ∷ PoolStake → PoolStake → Bool #
Ord PoolStake Source #
Instance details Defined in Ouroboros.Network.PeerSelection.LedgerPeers.Type Methods compare ∷ PoolStake → PoolStake → Ordering # (<) ∷ PoolStake → PoolStake → Bool # (<=) ∷ PoolStake → PoolStake → Bool # (>) ∷ PoolStake → PoolStake → Bool # (>=) ∷ PoolStake → PoolStake → Bool # max ∷ PoolStake → PoolStake → PoolStake # min ∷ PoolStake → PoolStake → PoolStake #

newtype AccPoolStake Source #

The accumulated relative stake of a stake pool, like PoolStake but it also includes the relative stake of all preceding pools. A value in the range [0, 1].

Constructors

AccPoolStake
Fields unAccPoolStake ∷ Rational

Instances

Instances details

Num AccPoolStake Source #
Instance details Defined in Ouroboros.Network.PeerSelection.LedgerPeers.Type Methods (+) ∷ AccPoolStake → AccPoolStake → AccPoolStake # (-) ∷ AccPoolStake → AccPoolStake → AccPoolStake # (*) ∷ AccPoolStake → AccPoolStake → AccPoolStake # negate ∷ AccPoolStake → AccPoolStake # abs ∷ AccPoolStake → AccPoolStake # signum ∷ AccPoolStake → AccPoolStake # fromInteger ∷ Integer → AccPoolStake #
Fractional AccPoolStake Source #
Instance details Defined in Ouroboros.Network.PeerSelection.LedgerPeers.Type Methods (/) ∷ AccPoolStake → AccPoolStake → AccPoolStake # recip ∷ AccPoolStake → AccPoolStake # fromRational ∷ Rational → AccPoolStake #
Show AccPoolStake Source #
Instance details Defined in Ouroboros.Network.PeerSelection.LedgerPeers.Type Methods showsPrec ∷ Int → AccPoolStake → ShowS # show ∷ AccPoolStake → String # showList ∷ [AccPoolStake] → ShowS #
Eq AccPoolStake Source #
Instance details Defined in Ouroboros.Network.PeerSelection.LedgerPeers.Type Methods (==) ∷ AccPoolStake → AccPoolStake → Bool # (/=) ∷ AccPoolStake → AccPoolStake → Bool #
Ord AccPoolStake Source #
Instance details Defined in Ouroboros.Network.PeerSelection.LedgerPeers.Type Methods compare ∷ AccPoolStake → AccPoolStake → Ordering # (<) ∷ AccPoolStake → AccPoolStake → Bool # (<=) ∷ AccPoolStake → AccPoolStake → Bool # (>) ∷ AccPoolStake → AccPoolStake → Bool # (>=) ∷ AccPoolStake → AccPoolStake → Bool # max ∷ AccPoolStake → AccPoolStake → AccPoolStake # min ∷ AccPoolStake → AccPoolStake → AccPoolStake #

data IsBigLedgerPeer Source #

A boolean like type. Big ledger peers are the largest SPOs which control 90% of staked stake.

Note that IsBigLedgerPeer indicates a role that peer plays in the eclipse evasion, e.g. that a peer was explicitly selected as a big ledger peer, e.g. IsNotBigLedgerPeer does not necessarily mean that the peer isn't a big ledger peer. This is because we select root peers from all ledger peers (including big ones).

Constructors

IsBigLedgerPeer
IsNotBigLedgerPeer

Instances

Instances details

Eq IsBigLedgerPeer Source #
Instance details Defined in Ouroboros.Network.PeerSelection.LedgerPeers.Type Methods (==) ∷ IsBigLedgerPeer → IsBigLedgerPeer → Bool # (/=) ∷ IsBigLedgerPeer → IsBigLedgerPeer → Bool #

data LedgerStateJudgement Source #

Wether the node is caught up or fell too far behind the chain

Constructors

YoungEnough
TooOld

Instances

Instances details

Generic LedgerStateJudgement Source #
Instance details Defined in Ouroboros.Network.PeerSelection.LedgerPeers.Type Associated Types type Rep LedgerStateJudgement ∷ Type → Type # Methods from ∷ LedgerStateJudgement → Rep LedgerStateJudgement x # to ∷ Rep LedgerStateJudgement x → LedgerStateJudgement #
Show LedgerStateJudgement Source #
Instance details Defined in Ouroboros.Network.PeerSelection.LedgerPeers.Type Methods showsPrec ∷ Int → LedgerStateJudgement → ShowS # show ∷ LedgerStateJudgement → String # showList ∷ [LedgerStateJudgement] → ShowS #
Eq LedgerStateJudgement Source #
Instance details Defined in Ouroboros.Network.PeerSelection.LedgerPeers.Type Methods (==) ∷ LedgerStateJudgement → LedgerStateJudgement → Bool # (/=) ∷ LedgerStateJudgement → LedgerStateJudgement → Bool #
NoThunks LedgerStateJudgement Source #
Instance details Defined in Ouroboros.Network.PeerSelection.LedgerPeers.Type Methods noThunks ∷ Context → LedgerStateJudgement → IO (Maybe ThunkInfo) Source # wNoThunks ∷ Context → LedgerStateJudgement → IO (Maybe ThunkInfo) Source # showTypeOf ∷ Proxy LedgerStateJudgement → String Source #
type Rep LedgerStateJudgement Source #
Instance details Defined in Ouroboros.Network.PeerSelection.LedgerPeers.Type type Rep LedgerStateJudgement = D1 ('MetaData "LedgerStateJudgement" "Ouroboros.Network.PeerSelection.LedgerPeers.Type" "ouroboros-network-api-0.7.2.0-inplace" 'False) (C1 ('MetaCons "YoungEnough" 'PrefixI 'False) (U1 ∷ Type → Type) :+: C1 ('MetaCons "TooOld" 'PrefixI 'False) (U1 ∷ Type → Type))

data LedgerPeersConsensusInterface m Source #

Return ledger state information and ledger peers.

Constructors

LedgerPeersConsensusInterface
Fields lpGetLatestSlot ∷ STM m (WithOrigin SlotNo) lpGetLedgerStateJudgement ∷ STM m LedgerStateJudgement lpGetLedgerPeers ∷ STM m [(PoolStake, NonEmpty RelayAccessPoint)]

data UseLedgerPeers Source #

Only use the ledger after the given slot number.

Constructors

DontUseLedgerPeers
UseLedgerPeers AfterSlot

Instances

Instances details

Generic UseLedgerPeers Source #
Instance details Defined in Ouroboros.Network.PeerSelection.LedgerPeers.Type Associated Types type Rep UseLedgerPeers ∷ Type → Type # Methods from ∷ UseLedgerPeers → Rep UseLedgerPeers x # to ∷ Rep UseLedgerPeers x → UseLedgerPeers #
Show UseLedgerPeers Source #
Instance details Defined in Ouroboros.Network.PeerSelection.LedgerPeers.Type Methods showsPrec ∷ Int → UseLedgerPeers → ShowS # show ∷ UseLedgerPeers → String # showList ∷ [UseLedgerPeers] → ShowS #
Eq UseLedgerPeers Source #
Instance details Defined in Ouroboros.Network.PeerSelection.LedgerPeers.Type Methods (==) ∷ UseLedgerPeers → UseLedgerPeers → Bool # (/=) ∷ UseLedgerPeers → UseLedgerPeers → Bool #
NoThunks UseLedgerPeers Source #
Instance details Defined in Ouroboros.Network.PeerSelection.LedgerPeers.Type Methods noThunks ∷ Context → UseLedgerPeers → IO (Maybe ThunkInfo) Source # wNoThunks ∷ Context → UseLedgerPeers → IO (Maybe ThunkInfo) Source # showTypeOf ∷ Proxy UseLedgerPeers → String Source #
type Rep UseLedgerPeers Source #
Instance details Defined in Ouroboros.Network.PeerSelection.LedgerPeers.Type type Rep UseLedgerPeers = D1 ('MetaData "UseLedgerPeers" "Ouroboros.Network.PeerSelection.LedgerPeers.Type" "ouroboros-network-api-0.7.2.0-inplace" 'False) (C1 ('MetaCons "DontUseLedgerPeers" 'PrefixI 'False) (U1 ∷ Type → Type) :+: C1 ('MetaCons "UseLedgerPeers" 'PrefixI 'False) (S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 AfterSlot)))

data AfterSlot Source #

Only use the ledger after the given slot number.

Constructors

Always
After SlotNo

Instances

Instances details

Generic AfterSlot Source #
Instance details Defined in Ouroboros.Network.PeerSelection.LedgerPeers.Type Associated Types type Rep AfterSlot ∷ Type → Type # Methods from ∷ AfterSlot → Rep AfterSlot x # to ∷ Rep AfterSlot x → AfterSlot #
Show AfterSlot Source #
Instance details Defined in Ouroboros.Network.PeerSelection.LedgerPeers.Type Methods showsPrec ∷ Int → AfterSlot → ShowS # show ∷ AfterSlot → String # showList ∷ [AfterSlot] → ShowS #
Eq AfterSlot Source #
Instance details Defined in Ouroboros.Network.PeerSelection.LedgerPeers.Type Methods (==) ∷ AfterSlot → AfterSlot → Bool # (/=) ∷ AfterSlot → AfterSlot → Bool #
NoThunks AfterSlot Source #
Instance details Defined in Ouroboros.Network.PeerSelection.LedgerPeers.Type Methods noThunks ∷ Context → AfterSlot → IO (Maybe ThunkInfo) Source # wNoThunks ∷ Context → AfterSlot → IO (Maybe ThunkInfo) Source # showTypeOf ∷ Proxy AfterSlot → String Source #
type Rep AfterSlot Source #
Instance details Defined in Ouroboros.Network.PeerSelection.LedgerPeers.Type type Rep AfterSlot = D1 ('MetaData "AfterSlot" "Ouroboros.Network.PeerSelection.LedgerPeers.Type" "ouroboros-network-api-0.7.2.0-inplace" 'False) (C1 ('MetaCons "Always" 'PrefixI 'False) (U1 ∷ Type → Type) :+: C1 ('MetaCons "After" 'PrefixI 'False) (S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 SlotNo)))

isLedgerPeersEnabled ∷ UseLedgerPeers → Bool Source #