peer-selection: reorganised exports, part 1

Expanded `Ouroboros.Network.PeerSelection` module to simplify imports in
downstream libraries.

Author: coot

cardano-diffusion/lib/Cardano/Network/PeerSelection/Churn.hs

@@ -133,11 +133,12 @@ peerChurnGovernor PeerChurnArgs {
                     pcaRng                 = inRng,
                     pcaPeerSelectionVar    = peerSelectionVar,
                     pcaReadCounters        = readCounters,
-                    getLedgerStateCtx = LedgerPeersConsensusInterface {
-                      lpExtraAPI    = Cardano.LedgerPeersConsensusInterface {
-                        Cardano.readFetchMode,
-                        Cardano.getLedgerStateJudgement
-                      }
+                    getLedgerPeersAPI      =
+                      LedgerPeersConsensusInterface {
+                        lpExtraAPI = Cardano.LedgerPeersConsensusInterface {
+                          Cardano.readFetchMode,
+                          Cardano.getLedgerStateJudgement
+                        }
                     },
                     getLocalRootHotTarget,
                     pcaPeerSelectionTargets = peerSelectionTargets,

cardano-diffusion/lib/Cardano/Network/PeerSelection/Governor/Monitor.hs

@@ -645,7 +645,7 @@ waitForSystemToQuiesce st@PeerSelectionState{
   , not hasOnlyBootstrapPeers
   -- Are the local root peers all trustable?
   , all (\case
-          LocalRootConfig { extraFlags = IsTrustable }
+          LocalRootConfig { extraLocalRootFlags = IsTrustable }
             -> True
           _ -> False
         )

cardano-diffusion/lib/Cardano/Network/PeerSelection/PeerSelectionActions.hs

@@ -72,12 +72,12 @@ requestPublicRootPeers
                        $ requiresBootstrapPeers <$> useBootstrapped
                                                 <*> getLedgerStateJudgement
   if usingBootstrapPeers
-     then do
+    then do
       -- If the ledger state is in sensitive state we should get trustable peers.
       (bootstrapPeers, dt) <- requestConfiguredBootstrapPeers n
       pure (Cardano.PublicRootPeers.fromBootstrapPeers bootstrapPeers, dt)
-     else do
-      Ouroboros.requestPublicRootPeers
+    else do
+      Ouroboros.requestPublicRootPeersImpl
         publicTracer
         readPublicRootPeers
         pad

cardano-diffusion/lib/Cardano/Network/PeerSelection/State/LocalRootPeers.hs

@@ -19,18 +19,20 @@ clampToTrustable :: Ord peeraddr
                  => LocalRootPeers PeerTrustable peeraddr
                  -> LocalRootPeers PeerTrustable peeraddr
 clampToTrustable (LocalRootPeers m gs) =
-  let trustedMap = Map.filter (\LocalRootConfig { extraFlags } -> case extraFlags of
-                                 IsTrustable    -> True
-                                 IsNotTrustable -> False
+  let trustedMap = Map.filter (\LocalRootConfig { extraLocalRootFlags } ->
+                                case extraLocalRootFlags of
+                                  IsTrustable    -> True
+                                  IsNotTrustable -> False
                               )
                               m
    in LocalRootPeers trustedMap (trustedGroups gs)
   where
     trustedGroups [] = []
     trustedGroups ((h, w, g):gss) =
-      let trusted = Map.filter (\LocalRootConfig { extraFlags } -> case extraFlags of
-                                  IsTrustable    -> True
-                                  IsNotTrustable -> False
+      let trusted = Map.filter (\LocalRootConfig { extraLocalRootFlags } ->
+                                 case extraLocalRootFlags of
+                                   IsTrustable    -> True
+                                   IsNotTrustable -> False
                                )
                                m
           trustedSet = Map.keysSet trusted
@@ -47,16 +49,16 @@ isPeerTrustable :: Ord peeraddr
                 -> Bool
 isPeerTrustable peeraddr lrp =
   case Map.lookup peeraddr (toMap lrp) of
-    Just LocalRootConfig { extraFlags = IsTrustable }
+    Just LocalRootConfig { extraLocalRootFlags = IsTrustable }
       -> True
     _ -> False
 
 trustableKeysSet :: LocalRootPeers PeerTrustable peeraddr
                  -> Set peeraddr
 trustableKeysSet (LocalRootPeers m _) =
     Map.keysSet
-  . Map.filter (\LocalRootConfig { extraFlags } ->
-                 case extraFlags of
+  . Map.filter (\LocalRootConfig { extraLocalRootFlags } ->
+                 case extraLocalRootFlags of
                    IsTrustable    -> True
                    IsNotTrustable -> False)
   $ m

cardano-diffusion/tests/lib/Test/Cardano/Network/Diffusion/Testnet/Simulation.hs

@@ -98,7 +98,6 @@ import Cardano.Network.PeerSelection.Governor.Types qualified as Cardano
 import Cardano.Network.PeerSelection.Governor.Types qualified as ExtraSizes
 import Cardano.Network.PeerSelection.PeerSelectionActions
            (requestPublicRootPeers)
-import Ouroboros.Network.PeerSelection.RelayAccessPoint
 
 import Ouroboros.Network.Block (BlockNo)
 import Ouroboros.Network.BlockFetch (FetchMode (..), PraosFetchMode (..),
@@ -116,13 +115,9 @@ import Ouroboros.Network.Handshake.Acceptable (Acceptable (acceptableVersion))
 import Ouroboros.Network.InboundGovernor (RemoteTransitionTrace)
 import Ouroboros.Network.InboundGovernor qualified as IG
 import Ouroboros.Network.Mux (MiniProtocolLimits (..))
-import Ouroboros.Network.PeerSelection hiding (peerChurnGovernor,
-           requestPublicRootPeers)
+import Ouroboros.Network.PeerSelection hiding (requestPublicRootPeers)
 import Ouroboros.Network.PeerSelection.Governor qualified as Governor
 import Ouroboros.Network.PeerSelection.LedgerPeers (accPoolStake)
-import Ouroboros.Network.PeerSelection.RootPeersDNS
-import Ouroboros.Network.PeerSelection.State.LocalRootPeers (HotValency (..),
-           LocalRootConfig, WarmValency (..))
 import Ouroboros.Network.Protocol.BlockFetch.Codec (byteLimitsBlockFetch,
            timeLimitsBlockFetch)
 import Ouroboros.Network.Protocol.ChainSync.Codec (byteLimitsChainSync,

cardano-diffusion/tests/lib/Test/Cardano/Network/PeerSelection.hs

@@ -3726,7 +3726,7 @@ prop_governor_only_bootstrap_peers_in_clean_state env =
           . selectEnvEvents
           $ events
           where
-            isTrustable LocalRootConfig { extraFlags = IsTrustable }
+            isTrustable LocalRootConfig { extraLocalRootFlags = IsTrustable }
                           = True
             isTrustable _ = False
 

ouroboros-network/lib/Ouroboros/Network/Diffusion.hs

@@ -1,14 +1,14 @@
-{-# LANGUAGE BlockArguments           #-}
-{-# LANGUAGE CPP                      #-}
-{-# LANGUAGE DataKinds                #-}
-{-# LANGUAGE DisambiguateRecordFields #-}
-{-# LANGUAGE FlexibleContexts         #-}
-{-# LANGUAGE GADTs                    #-}
-{-# LANGUAGE KindSignatures           #-}
-{-# LANGUAGE NamedFieldPuns           #-}
-{-# LANGUAGE RankNTypes               #-}
-{-# LANGUAGE ScopedTypeVariables      #-}
-{-# LANGUAGE TypeOperators            #-}
+{-# LANGUAGE BlockArguments        #-}
+{-# LANGUAGE CPP                   #-}
+{-# LANGUAGE DataKinds             #-}
+{-# LANGUAGE DuplicateRecordFields #-}
+{-# LANGUAGE FlexibleContexts      #-}
+{-# LANGUAGE GADTs                 #-}
+{-# LANGUAGE KindSignatures        #-}
+{-# LANGUAGE NamedFieldPuns        #-}
+{-# LANGUAGE RankNTypes            #-}
+{-# LANGUAGE ScopedTypeVariables   #-}
+{-# LANGUAGE TypeOperators         #-}
 
 -- | This module is expected to be imported qualified.
 --
@@ -70,8 +70,8 @@ import Ouroboros.Network.IOManager
 import Ouroboros.Network.Mux hiding (MiniProtocol (..))
 import Ouroboros.Network.MuxMode
 import Ouroboros.Network.PeerSelection as PeerSelection
-import Ouroboros.Network.PeerSelection.Governor qualified as Governor
-import Ouroboros.Network.PeerSelection.RootPeersDNS (PeerActionsDNS (..))
+import Ouroboros.Network.PeerSelection.Churn as PeerSelection
+import Ouroboros.Network.PeerSelection.PeerSelectionActions as PeerSelection
 import Ouroboros.Network.PeerSelection.RootPeersDNS qualified as RootPeersDNS
 import Ouroboros.Network.PeerSelection.State.LocalRootPeers qualified as LocalRootPeers
 import Ouroboros.Network.PeerSharing (PeerSharingRegistry (..))
@@ -440,9 +440,9 @@ runM Interfaces
       localRootsVar <- newTVarIO mempty
 
       -- churn will set initial targets
-      peerSelectionTargetsVar <- newTVarIO Governor.nullPeerSelectionTargets
+      peerSelectionTargetsVar <- newTVarIO PeerSelection.nullPeerSelectionTargets
 
-      countersVar <- newTVarIO (Governor.emptyPeerSelectionCounters daEmptyExtraCounters)
+      countersVar <- newTVarIO (PeerSelection.emptyPeerSelectionCounters daEmptyExtraCounters)
 
       -- Design notes:
       --  - We split the following code into two parts:
@@ -558,7 +558,7 @@ runM Interfaces
                  muxMode socket (ExpandedInitiatorContext ntnAddr m)
                  responderCtx ntnAddr ntnVersionData ntnVersion
                  ByteString m a b
-            -> (Governor.PeerStateActions
+            -> (PeerSelection.PeerStateActions
                   ntnAddr
                   (PeerConnectionHandle muxMode responderCtx ntnAddr
                      ntnVersionData ByteString m a b)
@@ -625,7 +625,7 @@ runM Interfaces
                                          requestPublicRootPeers     =
                                            case daRequestPublicRootPeers of
                                              Nothing ->
-                                               PeerSelection.requestPublicRootPeers
+                                               PeerSelection.requestPublicRootPeersImpl
                                                  dtTracePublicRootPeersTracer
                                                  dcReadPublicRootPeers
                                                  dnsActions
@@ -665,7 +665,7 @@ runM Interfaces
                 m
             -> m Void
           peerSelectionGovernor' peerSelectionTracer dbgVar peerSelectionActions =
-            Governor.peerSelectionGovernor
+            PeerSelection.peerSelectionGovernor
               dtTracePeerSelectionTracer
               peerSelectionTracer
               dtTracePeerSelectionCounters
@@ -697,7 +697,7 @@ runM Interfaces
               , pcaRng                 = churnRng
               , pcaPeerSelectionVar    = peerSelectionTargetsVar
               , pcaReadCounters        = readTVar countersVar
-              , getLedgerStateCtx      = daLedgerPeersCtx
+              , getLedgerPeersAPI      = daLedgerPeersCtx
               , getLocalRootHotTarget  =
                    LocalRootPeers.hotTarget
                  . LocalRootPeers.fromGroups
@@ -755,13 +755,13 @@ runM Interfaces
         -- InitiatorOnly mode, run peer selection only:
         InitiatorOnlyDiffusionMode ->
           withConnectionManagerInitiatorOnlyMode $ \connectionManager -> do
-          debugStateVar <- newTVarIO $ Governor.emptyPeerSelectionState fuzzRng daEmptyExtraState mempty
+          debugStateVar <- newTVarIO $ PeerSelection.emptyPeerSelectionState fuzzRng daEmptyExtraState mempty
           daInstallSigUSR1Handler connectionManager debugStateVar
           withPeerStateActions' connectionManager $ \peerStateActions->
             withPeerSelectionActions'
               (return Map.empty)
               peerStateActions $
-              \(ledgerPeersThread, localRootPeersProvider) peerSelectionActions->
+              \(ledgerPeersThread, localRootPeersProviderThread) peerSelectionActions->
                 Async.withAsync
                   (peerSelectionGovernor'
                     dtDebugPeerSelectionInitiatorTracer
@@ -771,7 +771,7 @@ runM Interfaces
                       peerChurnGovernor' $ \churnGovernorThread ->
                       -- wait for any thread to fail:
                       snd <$> Async.waitAny
-                                [ledgerPeersThread, localRootPeersProvider, governorThread, churnGovernorThread]
+                                [ledgerPeersThread, localRootPeersProviderThread, governorThread, churnGovernorThread]
 
         -- InitiatorAndResponder mode, run peer selection and the server:
         InitiatorAndResponderDiffusionMode -> do
@@ -788,14 +788,14 @@ runM Interfaces
             -- end, unique to ...
             withServer sockets inboundInfoChannel
               \inboundGovernorThread readInboundState connectionManager -> do
-                debugStateVar <- newTVarIO $ Governor.emptyPeerSelectionState fuzzRng daEmptyExtraState mempty
+                debugStateVar <- newTVarIO $ PeerSelection.emptyPeerSelectionState fuzzRng daEmptyExtraState mempty
                 daInstallSigUSR1Handler connectionManager debugStateVar
                 withPeerStateActions' connectionManager $
                   \peerStateActions ->
                     withPeerSelectionActions'
                       (mkInboundPeersMap <$> readInboundState)
                       peerStateActions $
-                        \(ledgerPeersThread, localRootPeersProvider) peerSelectionActions ->
+                        \(ledgerPeersThread, localRootPeersProviderThread) peerSelectionActions ->
                           Async.withAsync
                             (do
                               labelThisThread "Peer selection governor"
@@ -807,7 +807,7 @@ runM Interfaces
                                     \churnGovernorThread ->
                                       -- wait for any thread to fail:
                                       snd <$> Async.waitAny [ ledgerPeersThread
-                                                            , localRootPeersProvider
+                                                            , localRootPeersProviderThread
                                                             , governorThread
                                                             , churnGovernorThread
                                                             , inboundGovernorThread

ouroboros-network/lib/Ouroboros/Network/Diffusion/Topology.hs

@@ -10,8 +10,7 @@ import Ouroboros.Network.Diffusion.Configuration (DiffusionMode)
 import Ouroboros.Network.PeerSelection.LedgerPeers.Type (UseLedgerPeers)
 import Ouroboros.Network.PeerSelection.PeerAdvertise (PeerAdvertise)
 import Ouroboros.Network.PeerSelection.RelayAccessPoint (RelayAccessPoint)
-import Ouroboros.Network.PeerSelection.State.LocalRootPeers hiding (extraFlags)
-import Ouroboros.Network.PeerSelection.State.LocalRootPeers qualified as LRP
+import Ouroboros.Network.PeerSelection.State.LocalRootPeers
 
 data NetworkTopology extraConfig extraFlags =
   NetworkTopology {
@@ -85,7 +84,7 @@ producerAddresses NetworkTopology { localRootPeersGroups
                          , LocalRootConfig {
                              diffusionMode = rootDiffusionMode lrp,
                              peerAdvertise,
-                             LRP.extraFlags = extraFlags lrp
+                             extraLocalRootFlags = extraFlags lrp
                            }
                          )
                        )

ouroboros-network/lib/Ouroboros/Network/Diffusion/Types.hs

@@ -77,8 +77,7 @@ import Ouroboros.Network.Snocket (FileDescriptor, Snocket)
 import Ouroboros.Network.Socket (SystemdSocketTracer)
 
 import Ouroboros.Network.PeerSelection as PeerSelection
-import Ouroboros.Network.PeerSelection.Governor.Types
-import Ouroboros.Network.PeerSelection.RootPeersDNS
+import Ouroboros.Network.PeerSelection.Churn as PeerSelection
 import Ouroboros.Network.PeerSelection.State.LocalRootPeers qualified as LocalRootPeers
 import Ouroboros.Network.Server.RateLimiting (AcceptedConnectionsLimit)
 

ouroboros-network/lib/Ouroboros/Network/PeerSelection.hs

@@ -1,4 +1,5 @@
-{-# LANGUAGE ExplicitNamespaces #-}
+{-# LANGUAGE DuplicateRecordFields #-}
+{-# LANGUAGE ExplicitNamespaces    #-}
 
 module Ouroboros.Network.PeerSelection
   ( module Governor
@@ -10,33 +11,48 @@ module Ouroboros.Network.PeerSelection
   , module PeerSelection.RelayAccessPoint
   , module PeerSelection.LedgerPeers
   , module PeerSelection.PeerMetrics
-  , module PeerSelection.Churn
   , module PeerSelection.PeerAdvertise
   , module PeerSelection.PeerSharing
+  , module PeerSelection.RootPeersDNS
+  , module PeerSelection.State.KnownPeers
+  , module PeerSelection.State.LocalRootPeers
   ) where
 
-import Ouroboros.Network.PeerSelection.Churn as PeerSelection.Churn
--- Only essential `Governor` types.
-import Ouroboros.Network.PeerSelection.Governor as Governor
-           (DebugPeerSelection (..), PeerSelectionActions,
-           PeerSelectionInterfaces (..), PeerSelectionPolicy (..),
-           PeerSelectionState, PeerSelectionTargets (..), PeerStateActions,
-           PickPolicy)
+import Ouroboros.Network.PeerSelection.Governor as Governor (PeerSelectionState)
+import Ouroboros.Network.PeerSelection.Governor as Governor hiding
+           (PeerSelectionState (..))
 import Ouroboros.Network.PeerSelection.LedgerPeers as PeerSelection.LedgerPeers
            (AfterSlot (..), IsBigLedgerPeer (..), LedgerPeerSnapshot (..),
            LedgerPeers (..), LedgerPeersConsensusInterface (..),
-           LedgerPeersKind (..), NumberOfPeers (..), TraceLedgerPeers (..),
-           UseLedgerPeers (..), WithLedgerPeersArgs (..), withLedgerPeers)
+           LedgerPeersKind (..), NumberOfPeers (..), PoolStake (..),
+           TraceLedgerPeers (..), UseLedgerPeers (..), WithLedgerPeersArgs (..),
+           withLedgerPeers)
 import Ouroboros.Network.PeerSelection.PeerAdvertise as PeerSelection.PeerAdvertise
 import Ouroboros.Network.PeerSelection.PeerMetric as PeerSelection.PeerMetrics
            (PeerMetrics, PeerMetricsConfiguration (..), ReportPeerMetrics (..),
            newPeerMetric, newPeerMetric', nullMetric, reportMetric)
-import Ouroboros.Network.PeerSelection.PeerSelectionActions as PeerSelection.PeerSelectionActions
+-- NOTE: not re-exporting `requestPublicRootPeersImpl` to avoid name clash
+-- with the same function in `cardano-diffusion`.
+import Ouroboros.Network.PeerSelection.PeerSelectionActions as PeerSelection.PeerSelectionActions hiding
+           (requestPublicRootPeersImpl)
 import Ouroboros.Network.PeerSelection.PeerSharing as PeerSelection.PeerSharing
 import Ouroboros.Network.PeerSelection.PeerStateActions as PeerSelection.PeerStateActions
 import Ouroboros.Network.PeerSelection.PublicRootPeers as PeerSelection.PublicRootPeers
            (PublicRootPeers)
 import Ouroboros.Network.PeerSelection.RelayAccessPoint as PeerSelection.RelayAccessPoint
-           (IP (..), PortNumber, RelayAccessPoint (..))
+import Ouroboros.Network.PeerSelection.RootPeersDNS as PeerSelection.RootPeersDNS
+           (DNSorIOError)
+import Ouroboros.Network.PeerSelection.RootPeersDNS as PeerSelection.RootPeersDNS hiding
+           (DNSorIOError (..))
+import Ouroboros.Network.PeerSelection.State.KnownPeers as PeerSelection.State.KnownPeers
+           (KnownPeerInfo (..))
+import Ouroboros.Network.PeerSelection.State.LocalRootPeers as PeerSelection.State.LocalRootPeers
+           (HotValency (..), LocalRootConfig (..), LocalRootPeers,
+           WarmValency (..))
 import Ouroboros.Network.PeerSelection.Types as PeerSelection
 import Ouroboros.Network.PeerSelection.Types as PeerSelection.Types
+import Ouroboros.Network.Protocol.PeerSharing.Type as PeerSelection.PeerSharing
+           (PeerSharingAmount (..), PeerSharingResult (..))
+
+-- NOTE: not re-exporting `Ouroboros.Network.PeerSelection.Churn` to avoid name
+-- clash with `peerChurnGovernor` in `cardano-diffusion`.