ouroboros-network
Safe HaskellNone
LanguageHaskell2010

Ouroboros.Network.PeerSelection.LedgerPeers

Synopsis

Documentation

data IP #

A unified IP data for IPv4 and IPv6. 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

IPv6 

Fields

Instances

Instances details
Data IP 
Instance details

Defined in Data.IP.Addr

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> IP -> c IP #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c IP #

toConstr :: IP -> Constr #

dataTypeOf :: IP -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c IP) #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c IP) #

gmapT :: (forall b. Data b => b -> b) -> IP -> IP #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> IP -> r #

gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> IP -> r #

gmapQ :: (forall d. Data d => d -> u) -> IP -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> IP -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> IP -> m IP #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> IP -> m IP #

gmapMo :: MonadPlus m => (forall 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 
Instance details

Defined in Data.IP.Addr

type Rep IP = D1 ('MetaData "IP" "Data.IP.Addr" "iproute-1.7.15-adb6e80798aeb86ddb3df9d76d84bdb3df480b0343b0132a9c3e0621347204b0" '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)))

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.15-adb6e80798aeb86ddb3df9d76d84bdb3df480b0343b0132a9c3e0621347204b0" '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 [(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

Methods

showsPrec :: Int -> LedgerPeers -> ShowS #

show :: LedgerPeers -> String #

showList :: [LedgerPeers] -> ShowS #

Eq LedgerPeers Source # 
Instance details

Defined in Ouroboros.Network.PeerSelection.LedgerPeers

Methods

(==) :: LedgerPeers -> LedgerPeers -> Bool #

(/=) :: LedgerPeers -> LedgerPeers -> Bool #

getLedgerPeers :: forall (m :: Type -> Type) extraAPI. MonadSTM m => LedgerPeersConsensusInterface extraAPI 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 #

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

Constructors

RelayAccessDomain !Domain !PortNumber 
RelayAccessSRVDomain !Domain 
RelayAccessAddress !IP !PortNumber 

Instances

Instances details
FromJSON RelayAccessPoint 
Instance details

Defined in Ouroboros.Network.PeerSelection.RelayAccessPoint

Methods

parseJSON :: Value -> Parser RelayAccessPoint #

parseJSONList :: Value -> Parser [RelayAccessPoint] #

omittedField :: Maybe RelayAccessPoint #

ToJSON RelayAccessPoint 
Instance details

Defined in Ouroboros.Network.PeerSelection.RelayAccessPoint

Methods

toJSON :: RelayAccessPoint -> Value #

toEncoding :: RelayAccessPoint -> Encoding #

toJSONList :: [RelayAccessPoint] -> Value #

toEncodingList :: [RelayAccessPoint] -> Encoding #

omitField :: RelayAccessPoint -> Bool #

FromCBOR RelayAccessPoint 
Instance details

Defined in Ouroboros.Network.PeerSelection.RelayAccessPoint

Methods

fromCBOR :: Decoder s RelayAccessPoint #

label :: Proxy RelayAccessPoint -> Text #

ToCBOR RelayAccessPoint 
Instance details

Defined in Ouroboros.Network.PeerSelection.RelayAccessPoint

Methods

toCBOR :: RelayAccessPoint -> Encoding #

encodedSizeExpr :: (forall t. ToCBOR t => Proxy t -> Size) -> Proxy RelayAccessPoint -> Size #

encodedListSizeExpr :: (forall t. ToCBOR t => Proxy t -> Size) -> Proxy [RelayAccessPoint] -> Size #

NFData RelayAccessPoint 
Instance details

Defined in Ouroboros.Network.PeerSelection.RelayAccessPoint

Methods

rnf :: RelayAccessPoint -> () #

Show RelayAccessPoint 
Instance details

Defined in Ouroboros.Network.PeerSelection.RelayAccessPoint

Methods

showsPrec :: Int -> RelayAccessPoint -> ShowS #

show :: RelayAccessPoint -> String #

showList :: [RelayAccessPoint] -> ShowS #

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 #

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

Constructors

PoolStake 

Fields

Instances

Instances details
NFData PoolStake 
Instance details

Defined in Ouroboros.Network.PeerSelection.LedgerPeers.Type

Methods

rnf :: PoolStake -> () #

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 #

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 #

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

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 [RelayAccessPoint] 
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 
UsingBigLedgerPeerSnapshot 

Instances

Instances details
Show TraceLedgerPeers Source # 
Instance details

Defined in Ouroboros.Network.PeerSelection.LedgerPeers

Methods

showsPrec :: Int -> TraceLedgerPeers -> ShowS #

show :: TraceLedgerPeers -> String #

showList :: [TraceLedgerPeers] -> ShowS #

newtype NumberOfPeers Source #

Number of peers to pick.

Constructors

NumberOfPeers 

Fields

Instances

Instances details
Show NumberOfPeers Source # 
Instance details

Defined in Ouroboros.Network.PeerSelection.LedgerPeers

Methods

showsPrec :: Int -> NumberOfPeers -> ShowS #

show :: NumberOfPeers -> String #

showList :: [NumberOfPeers] -> ShowS #

data LedgerPeersKind #

Which ledger peers to pick.

Constructors

AllLedgerPeers 
BigLedgerPeers 

Instances

Instances details
Show LedgerPeersKind 
Instance details

Defined in Ouroboros.Network.PeerSelection.LedgerPeers.Type

Methods

showsPrec :: Int -> LedgerPeersKind -> ShowS #

show :: LedgerPeersKind -> String #

showList :: [LedgerPeersKind] -> ShowS #

data StakeMapOverSource Source #

Arguments record to stakeMapWithSlotOverSource function

Constructors

StakeMapOverSource 

Fields

Instances

Instances details
Show StakeMapOverSource Source # 
Instance details

Defined in Ouroboros.Network.PeerSelection.LedgerPeers

Methods

showsPrec :: Int -> StakeMapOverSource -> ShowS #

show :: StakeMapOverSource -> String #

showList :: [StakeMapOverSource] -> 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).

accumulateBigLedgerStake :: [(PoolStake, NonEmpty RelayAccessPoint)] -> [(AccPoolStake, (PoolStake, NonEmpty RelayAccessPoint))] #

Sort ascendingly a given list of pools with stake, and tag each one with cumulative stake, with a cutoff at bigLedgerPeerQuota

accBigPoolStakeMap :: [(PoolStake, NonEmpty RelayAccessPoint)] -> Map AccPoolStake (PoolStake, NonEmpty RelayAccessPoint) Source #

Take the result of accBigPoolStake and turn it into

bigLedgerPeerQuota :: AccPoolStake #

The total accumulated stake of big ledger peers.

stakeMapWithSlotOverSource :: StakeMapOverSource -> (Map AccPoolStake (PoolStake, NonEmpty RelayAccessPoint), Map AccPoolStake (PoolStake, NonEmpty RelayAccessPoint), Maybe SlotNo) Source #

Build up a stake map to sample ledger peers from. The SlotNo, if different from 0, indicates that the maps are the stake pools from the snapshot taken from the particular slot number.

DNS based provider for ledger root peers

data WithLedgerPeersArgs extraAPI (m :: Type -> Type) Source #

Argument record for withLedgerPeers

Constructors

WithLedgerPeersArgs 

Fields

withLedgerPeers :: forall peerAddr resolver exception extraAPI m a. (MonadAsync m, MonadThrow m, MonadMonotonicTime m, Exception exception, Ord peerAddr) => PeerActionsDNS peerAddr resolver exception m -> WithLedgerPeersArgs extraAPI 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

Internal only exported for testing purposes

resolveLedgerPeers :: forall m peerAddr resolver exception. (Ord peerAddr, MonadThrow m, MonadAsync m, Exception exception) => DNSSemaphore m -> ResolvConf -> DNSActions peerAddr resolver exception m -> LedgerPeersKind -> [RelayAccessPoint] -> StdGen -> m (Map Domain (Set peerAddr)) Source #

Provides DNS resolution functionality.

Concurrently resolve DNS names, respecting the maxDNSConcurrency limit.