Safe Haskell	Safe-Inferred
Language	Haskell2010

Ouroboros.Network.PeerSelection.LedgerPeers

Contents

Ledger Peers specific functions
DNS based provider for ledger root peers
Internal only exported for testing purposes

Synopsis

data DomainAccessPoint = DomainAccessPoint {
- dapDomain ∷ !Domain
- dapPortNumber ∷ !PortNumber
}
data IP
- = IPv4 {
  - ipv4 ∷ IPv4
  }
- | IPv6 {
  - ipv6 ∷ IPv6
  }
data LedgerPeers
- = LedgerPeers LedgerStateJudgement [(PoolStake, NonEmpty RelayAccessPoint)]
- | BeforeSlot
getLedgerPeers ∷ MonadSTM m ⇒ LedgerPeersConsensusInterface m → AfterSlot → STM m LedgerPeers
data RelayAccessPoint where
- RelayAccessDomain !Domain !PortNumber
- RelayAccessAddress !IP !PortNumber
- pattern RelayDomainAccessPoint ∷ DomainAccessPoint → RelayAccessPoint
newtype PoolStake = PoolStake {
- unPoolStake ∷ Rational
}
newtype AccPoolStake = AccPoolStake {
- unAccPoolStake ∷ Rational
}
data TraceLedgerPeers
newtype NumberOfPeers = NumberOfPeers {
- getNumberOfPeers ∷ Word16
}
data LedgerPeersKind
- = AllLedgerPeers
- | BigLedgerPeers
accPoolStake ∷ [(PoolStake, NonEmpty RelayAccessPoint)] → Map AccPoolStake (PoolStake, NonEmpty RelayAccessPoint)
accBigPoolStake ∷ [(PoolStake, NonEmpty RelayAccessPoint)] → Map AccPoolStake (PoolStake, NonEmpty RelayAccessPoint)
bigLedgerPeerQuota ∷ AccPoolStake
data WithLedgerPeersArgs m = WithLedgerPeersArgs {
- wlpRng ∷ StdGen
- wlpConsensusInterface ∷ LedgerPeersConsensusInterface m
- wlpTracer ∷ Tracer m TraceLedgerPeers
- wlpGetUseLedgerPeers ∷ STM m UseLedgerPeers
}
withLedgerPeers ∷ ∀ peerAddr resolver exception m a. (MonadAsync m, MonadThrow m, MonadMonotonicTime m, Exception exception, Ord peerAddr) ⇒ PeerActionsDNS peerAddr resolver exception m → WithLedgerPeersArgs m → ((NumberOfPeers → LedgerPeersKind → m (Maybe (Set peerAddr, DiffTime))) → Async m Void → m a) → m a
module Ouroboros.Network.PeerSelection.LedgerPeers.Type
module Ouroboros.Network.PeerSelection.LedgerPeers.Common
resolveLedgerPeers ∷ ∀ m peerAddr resolver exception. (Ord peerAddr, MonadThrow m, MonadAsync m, Exception exception) ⇒ Tracer m TraceLedgerPeers → (IP → PortNumber → peerAddr) → DNSSemaphore m → ResolvConf → DNSActions resolver exception m → [DomainAccessPoint] → m (Map DomainAccessPoint (Set peerAddr))

Documentation

data DomainAccessPoint Source #

A product of a Domain and PortNumber. After resolving the domain we will use the PortNumber to form SockAddr.

Constructors

DomainAccessPoint
Fields dapDomain ∷ !Domain dapPortNumber ∷ !PortNumber

Instances

Instances details

FromJSON DomainAccessPoint
Instance details Defined in Ouroboros.Network.PeerSelection.RelayAccessPoint Methods parseJSON ∷ Value → Parser DomainAccessPoint Source # parseJSONList ∷ Value → Parser [DomainAccessPoint] Source # omittedField ∷ Maybe DomainAccessPoint Source #
ToJSON DomainAccessPoint
Instance details Defined in Ouroboros.Network.PeerSelection.RelayAccessPoint Methods toJSON ∷ DomainAccessPoint → Value Source # toEncoding ∷ DomainAccessPoint → Encoding Source # toJSONList ∷ [DomainAccessPoint] → Value Source # toEncodingList ∷ [DomainAccessPoint] → Encoding Source # omitField ∷ DomainAccessPoint → Bool Source #
Show DomainAccessPoint
Instance details Defined in Ouroboros.Network.PeerSelection.RelayAccessPoint Methods showsPrec ∷ Int → DomainAccessPoint → ShowS # show ∷ DomainAccessPoint → String # showList ∷ [DomainAccessPoint] → ShowS #
Eq DomainAccessPoint
Instance details Defined in Ouroboros.Network.PeerSelection.RelayAccessPoint Methods (==) ∷ DomainAccessPoint → DomainAccessPoint → Bool # (/=) ∷ DomainAccessPoint → DomainAccessPoint → Bool #
Ord DomainAccessPoint
Instance details Defined in Ouroboros.Network.PeerSelection.RelayAccessPoint Methods compare ∷ DomainAccessPoint → DomainAccessPoint → Ordering # (<) ∷ DomainAccessPoint → DomainAccessPoint → Bool # (<=) ∷ DomainAccessPoint → DomainAccessPoint → Bool # (>) ∷ DomainAccessPoint → DomainAccessPoint → Bool # (>=) ∷ DomainAccessPoint → DomainAccessPoint → Bool # max ∷ DomainAccessPoint → DomainAccessPoint → DomainAccessPoint # min ∷ DomainAccessPoint → DomainAccessPoint → DomainAccessPoint #

data IP Source #

A unified IP data for IP and IP. To create this, use the data constructors. Or use read "192.0.2.1" :: IP, for example. Also, "192.0.2.1" can be used as literal with OverloadedStrings.

>>> (read "192.0.2.1" :: IP) == IPv4 (read "192.0.2.1" :: IPv4)
True
>>> (read "2001:db8:00:00:00:00:00:01" :: IP) == IPv6 (read "2001:db8:00:00:00:00:00:01" :: IPv6)
True

Constructors

IPv4
Fields ipv4 ∷ IPv4
IPv6
Fields ipv6 ∷ IPv6

Instances

Instances details

Data IP
Instance details Defined in Data.IP.Addr Methods gfoldl ∷ (∀ d b. Data d ⇒ c (d → b) → d → c b) → (∀ g. g → c g) → IP → c IP # gunfold ∷ (∀ b r. Data b ⇒ c (b → r) → c r) → (∀ r. r → c r) → Constr → c IP # toConstr ∷ IP → Constr # dataTypeOf ∷ IP → DataType # dataCast1 ∷ Typeable t ⇒ (∀ d. Data d ⇒ c (t d)) → Maybe (c IP) # dataCast2 ∷ Typeable t ⇒ (∀ d e. (Data d, Data e) ⇒ c (t d e)) → Maybe (c IP) # gmapT ∷ (∀ b. Data b ⇒ b → b) → IP → IP # gmapQl ∷ (r → r' → r) → r → (∀ d. Data d ⇒ d → r') → IP → r # gmapQr ∷ ∀ r r'. (r' → r → r) → r → (∀ d. Data d ⇒ d → r') → IP → r # gmapQ ∷ (∀ d. Data d ⇒ d → u) → IP → [u] # gmapQi ∷ Int → (∀ d. Data d ⇒ d → u) → IP → u # gmapM ∷ Monad m ⇒ (∀ d. Data d ⇒ d → m d) → IP → m IP # gmapMp ∷ MonadPlus m ⇒ (∀ d. Data d ⇒ d → m d) → IP → m IP # gmapMo ∷ MonadPlus m ⇒ (∀ d. Data d ⇒ d → m d) → IP → m IP #
IsString IP
Instance details Defined in Data.IP.Addr Methods fromString ∷ String → IP #
Enum IP
Instance details Defined in Data.IP.Addr Methods succ ∷ IP → IP # pred ∷ IP → IP # toEnum ∷ Int → IP # fromEnum ∷ IP → Int # enumFrom ∷ IP → [IP] # enumFromThen ∷ IP → IP → [IP] # enumFromTo ∷ IP → IP → [IP] # enumFromThenTo ∷ IP → IP → IP → [IP] #
Generic IP
Instance details Defined in Data.IP.Addr Associated Types type Rep IP ∷ Type → Type # Methods from ∷ IP → Rep IP x # to ∷ Rep IP x → IP #
Read IP
Instance details Defined in Data.IP.Addr Methods readsPrec ∷ Int → ReadS IP # readList ∷ ReadS [IP] # readPrec ∷ ReadPrec IP # readListPrec ∷ ReadPrec [IP] #
Show IP
Instance details Defined in Data.IP.Addr Methods showsPrec ∷ Int → IP → ShowS # show ∷ IP → String # showList ∷ [IP] → ShowS #
Eq IP	Equality over IP addresses. Correctly compare IPv4 and IPv4-embedded-in-IPv6 addresses. `>>>` `(read "2001:db8:00:00:00:00:00:01" :: IP) == (read "2001:db8:00:00:00:00:00:01" :: IP)`True `>>>` `(read "2001:db8:00:00:00:00:00:01" :: IP) == (read "2001:db8:00:00:00:00:00:05" :: IP)`False `>>>` `(read "127.0.0.1" :: IP) == (read "127.0.0.1" :: IP)`True `>>>` `(read "127.0.0.1" :: IP) == (read "10.0.0.1" :: IP)`False `>>>` `(read "::ffff:127.0.0.1" :: IP) == (read "127.0.0.1" :: IP)`True `>>>` `(read "::ffff:127.0.0.1" :: IP) == (read "127.0.0.9" :: IP)`False `>>>` `(read "::ffff:127.0.0.1" :: IP) >= (read "127.0.0.1" :: IP)`True `>>>` `(read "::ffff:127.0.0.1" :: IP) <= (read "127.0.0.1" :: IP)`True
Instance details Defined in Data.IP.Addr Methods (==) ∷ IP → IP → Bool # (/=) ∷ IP → IP → Bool #
Ord IP
Instance details Defined in Data.IP.Addr Methods compare ∷ IP → IP → Ordering # (<) ∷ IP → IP → Bool # (<=) ∷ IP → IP → Bool # (>) ∷ IP → IP → Bool # (>=) ∷ IP → IP → Bool # max ∷ IP → IP → IP # min ∷ IP → IP → IP #
type Rep IP
Instance details Defined in Data.IP.Addr type Rep IP = D1 ('MetaData "IP" "Data.IP.Addr" "iproute-1.7.12-7e6c7236f52e47d853564e9d1065d94de4fcb7a87d1339acf7a9018fdf58b700" 'False) (C1 ('MetaCons "IPv4" 'PrefixI 'True) (S1 ('MetaSel ('Just "ipv4") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedUnpack) (Rec0 IPv4)) :+: C1 ('MetaCons "IPv6" 'PrefixI 'True) (S1 ('MetaSel ('Just "ipv6") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 IPv6)))

data LedgerPeers Source #

Ledger Peer request result

Constructors

LedgerPeers
Fields LedgerStateJudgement Current ledger state [(PoolStake, NonEmpty RelayAccessPoint)] Ledger peers
BeforeSlot	No result because the node is still before the configured UseLedgerAfter slot number

Instances

Instances details

Show LedgerPeers Source #
Instance details Defined in Ouroboros.Network.PeerSelection.LedgerPeers.Common Methods showsPrec ∷ Int → LedgerPeers → ShowS # show ∷ LedgerPeers → String # showList ∷ [LedgerPeers] → ShowS #
Eq LedgerPeers Source #
Instance details Defined in Ouroboros.Network.PeerSelection.LedgerPeers.Common Methods (==) ∷ LedgerPeers → LedgerPeers → Bool # (/=) ∷ LedgerPeers → LedgerPeers → Bool #

getLedgerPeers ∷ MonadSTM m ⇒ LedgerPeersConsensusInterface m → AfterSlot → STM m LedgerPeers Source #

Internal API to deal with UseLedgerAfter configuration option

Receiving the LedgerPeersConsensusInterface we are able to compute a function that given a SlotNo will give us LedgerPeers according to the following invariants:

BeforeSlot is returned iff the latest slot is before the slotNo;
'LedgerPeers lsj peers' is returned iff the latest slot is after the slotNo.

data RelayAccessPoint Source #

A relay can have either an IP address and a port number or a domain with a port number

Constructors

RelayAccessDomain !Domain !PortNumber
RelayAccessAddress !IP !PortNumber

Bundled Patterns

pattern RelayDomainAccessPoint ∷ DomainAccessPoint → RelayAccessPoint

RelayDomainAccessPoint a bidirectional pattern which links RelayAccessDomain and DomainAccessPoint.

Instances

Instances details

FromJSON RelayAccessPoint
Instance details Defined in Ouroboros.Network.PeerSelection.RelayAccessPoint Methods parseJSON ∷ Value → Parser RelayAccessPoint Source # parseJSONList ∷ Value → Parser [RelayAccessPoint] Source # omittedField ∷ Maybe RelayAccessPoint Source #
ToJSON RelayAccessPoint
Instance details Defined in Ouroboros.Network.PeerSelection.RelayAccessPoint Methods toJSON ∷ RelayAccessPoint → Value Source # toEncoding ∷ RelayAccessPoint → Encoding Source # toJSONList ∷ [RelayAccessPoint] → Value Source # toEncodingList ∷ [RelayAccessPoint] → Encoding Source # omitField ∷ RelayAccessPoint → Bool Source #
Show RelayAccessPoint
Instance details Defined in Ouroboros.Network.PeerSelection.RelayAccessPoint Methods showsPrec ∷ Int → RelayAccessPoint → ShowS # show ∷ RelayAccessPoint → String # showList ∷ [RelayAccessPoint] → ShowS #
NFData RelayAccessPoint
Instance details Defined in Ouroboros.Network.PeerSelection.RelayAccessPoint Methods rnf ∷ RelayAccessPoint → () #
Eq RelayAccessPoint
Instance details Defined in Ouroboros.Network.PeerSelection.RelayAccessPoint Methods (==) ∷ RelayAccessPoint → RelayAccessPoint → Bool # (/=) ∷ RelayAccessPoint → RelayAccessPoint → Bool #
Ord RelayAccessPoint
Instance details Defined in Ouroboros.Network.PeerSelection.RelayAccessPoint Methods compare ∷ RelayAccessPoint → RelayAccessPoint → Ordering # (<) ∷ RelayAccessPoint → RelayAccessPoint → Bool # (<=) ∷ RelayAccessPoint → RelayAccessPoint → Bool # (>) ∷ RelayAccessPoint → RelayAccessPoint → Bool # (>=) ∷ RelayAccessPoint → RelayAccessPoint → Bool # max ∷ RelayAccessPoint → RelayAccessPoint → RelayAccessPoint # min ∷ RelayAccessPoint → RelayAccessPoint → RelayAccessPoint #

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
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
Instance details Defined in Ouroboros.Network.PeerSelection.LedgerPeers.Type Methods (/) ∷ PoolStake → PoolStake → PoolStake # recip ∷ PoolStake → PoolStake # fromRational ∷ Rational → PoolStake #
Show PoolStake
Instance details Defined in Ouroboros.Network.PeerSelection.LedgerPeers.Type Methods showsPrec ∷ Int → PoolStake → ShowS # show ∷ PoolStake → String # showList ∷ [PoolStake] → ShowS #
NFData PoolStake
Instance details Defined in Ouroboros.Network.PeerSelection.LedgerPeers.Type Methods rnf ∷ PoolStake → () #
Eq PoolStake
Instance details Defined in Ouroboros.Network.PeerSelection.LedgerPeers.Type Methods (==) ∷ PoolStake → PoolStake → Bool # (/=) ∷ PoolStake → PoolStake → Bool #
Ord PoolStake
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
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
Instance details Defined in Ouroboros.Network.PeerSelection.LedgerPeers.Type Methods (/) ∷ AccPoolStake → AccPoolStake → AccPoolStake # recip ∷ AccPoolStake → AccPoolStake # fromRational ∷ Rational → AccPoolStake #
Show AccPoolStake
Instance details Defined in Ouroboros.Network.PeerSelection.LedgerPeers.Type Methods showsPrec ∷ Int → AccPoolStake → ShowS # show ∷ AccPoolStake → String # showList ∷ [AccPoolStake] → ShowS #
Eq AccPoolStake
Instance details Defined in Ouroboros.Network.PeerSelection.LedgerPeers.Type Methods (==) ∷ AccPoolStake → AccPoolStake → Bool # (/=) ∷ AccPoolStake → AccPoolStake → Bool #
Ord AccPoolStake
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 TraceLedgerPeers Source #

Trace LedgerPeers events.

Constructors

PickedBigLedgerPeer RelayAccessPoint AccPoolStake PoolStake	Trace for a significant ledger peer picked with accumulated and relative stake of its pool.
PickedLedgerPeer RelayAccessPoint AccPoolStake PoolStake	Trace for a ledger peer picked with accumulated and relative stake of its pool.
PickedBigLedgerPeers NumberOfPeers [RelayAccessPoint]
PickedLedgerPeers NumberOfPeers [RelayAccessPoint]	Trace for the number of peers and we wanted to pick and the list of peers picked.
FetchingNewLedgerState Int Int	Trace for fetching a new list of peers from the ledger. The first Int is the number of ledger peers returned the latter is the number of big ledger peers.
TraceLedgerPeersDomains [DomainAccessPoint]
TraceLedgerPeersResult Domain [(IP, TTL)]
TraceLedgerPeersFailure Domain DNSError
DisabledLedgerPeers	Trace for when getting peers from the ledger is disabled, that is DontUseLedgerPeers.
TraceUseLedgerPeers UseLedgerPeers	Trace UseLedgerPeers value
WaitingOnRequest
RequestForPeers NumberOfPeers
ReusingLedgerState Int DiffTime
FallingBackToPublicRootPeers
NotEnoughBigLedgerPeers NumberOfPeers Int
NotEnoughLedgerPeers NumberOfPeers Int

Instances

Instances details

Show TraceLedgerPeers Source #
Instance details Defined in Ouroboros.Network.PeerSelection.LedgerPeers.Common Methods showsPrec ∷ Int → TraceLedgerPeers → ShowS # show ∷ TraceLedgerPeers → String # showList ∷ [TraceLedgerPeers] → ShowS #

newtype NumberOfPeers Source #

Constructors

NumberOfPeers
Fields getNumberOfPeers ∷ Word16

Instances

Instances details

Show NumberOfPeers Source #
Instance details Defined in Ouroboros.Network.PeerSelection.LedgerPeers.Common Methods showsPrec ∷ Int → NumberOfPeers → ShowS # show ∷ NumberOfPeers → String # showList ∷ [NumberOfPeers] → ShowS #

data LedgerPeersKind Source #

Which ledger peers to pick.

Constructors

AllLedgerPeers
BigLedgerPeers

Instances

Instances details

Show LedgerPeersKind Source #
Instance details Defined in Ouroboros.Network.PeerSelection.LedgerPeers.Common Methods showsPrec ∷ Int → LedgerPeersKind → ShowS # show ∷ LedgerPeersKind → String # showList ∷ [LedgerPeersKind] → ShowS #

Ledger Peers specific functions

accPoolStake ∷ [(PoolStake, NonEmpty RelayAccessPoint)] → Map AccPoolStake (PoolStake, NonEmpty RelayAccessPoint) Source #

Convert a list of pools with stake to a Map keyed on the accumulated stake. Consensus provides a list of pairs of relative stake and corresponding relays for all usable registered pools. By creating a Map keyed on the AccPoolStake that is the sum of the pool's relative stake and the stake of all preceding pools we can support weighted random selection in O(log n) time by taking advantage of Map.lookupGE (returns the smallest key greater or equal to the provided value).

accBigPoolStake ∷ [(PoolStake, NonEmpty RelayAccessPoint)] → Map AccPoolStake (PoolStake, NonEmpty RelayAccessPoint) Source #

Convert a list of pools with stake to a Map keyed on the accumulated stake which only contains big ledger peers, e.g. largest ledger peers which cumulatively control 90% of stake.

bigLedgerPeerQuota ∷ AccPoolStake Source #

The total accumulated stake of big ledger peers.

DNS based provider for ledger root peers

data WithLedgerPeersArgs m Source #

Argument record for withLedgerPeers

Constructors

WithLedgerPeersArgs
Fields wlpRng ∷ StdGen Random generator for picking ledger peers wlpConsensusInterface ∷ LedgerPeersConsensusInterface m wlpTracer ∷ Tracer m TraceLedgerPeers Get Ledger Peers comes from here wlpGetUseLedgerPeers ∷ STM m UseLedgerPeers Get Use Ledger After value

withLedgerPeers ∷ ∀ peerAddr resolver exception m a. (MonadAsync m, MonadThrow m, MonadMonotonicTime m, Exception exception, Ord peerAddr) ⇒ PeerActionsDNS peerAddr resolver exception m → WithLedgerPeersArgs m → ((NumberOfPeers → LedgerPeersKind → m (Maybe (Set peerAddr, DiffTime))) → Async m Void → m a) → m a Source #

For a LedgerPeers worker thread and submit request and receive responses.

module Ouroboros.Network.PeerSelection.LedgerPeers.Type

module Ouroboros.Network.PeerSelection.LedgerPeers.Common

Internal only exported for testing purposes

resolveLedgerPeers ∷ ∀ m peerAddr resolver exception. (Ord peerAddr, MonadThrow m, MonadAsync m, Exception exception) ⇒ Tracer m TraceLedgerPeers → (IP → PortNumber → peerAddr) → DNSSemaphore m → ResolvConf → DNSActions resolver exception m → [DomainAccessPoint] → m (Map DomainAccessPoint (Set peerAddr)) Source #

Provides DNS resolution functionality.

Concurrently resolve DNS names, respecting the maxDNSConcurrency limit.