From bd56d5500bd71d8a591e8e065d125fe0c64a1873 Mon Sep 17 00:00:00 2001
From: Marcin Szamotulski <coot@coot.me>
Date: Sat, 8 Feb 2025 08:37:44 +0100
Subject: [PATCH] diffusion: added TODOs

---
 .../src/Ouroboros/Cardano/Network/ArgumentsExtra.hs           | 4 ++++
 .../Network/PeerSelection/Governor/PeerSelectionActions.hs    | 2 ++
 .../Ouroboros/Cardano/Network/PeerSelection/Governor/Types.hs | 2 ++
 ouroboros-network/src/Ouroboros/Network/Diffusion.hs          | 2 ++
 ouroboros-network/src/Ouroboros/Network/Diffusion/Common.hs   | 1 +
 5 files changed, 11 insertions(+)

diff --git a/ouroboros-network/src/Ouroboros/Cardano/Network/ArgumentsExtra.hs b/ouroboros-network/src/Ouroboros/Cardano/Network/ArgumentsExtra.hs
index adba2e1170a..d250b9ebe49 100644
--- a/ouroboros-network/src/Ouroboros/Cardano/Network/ArgumentsExtra.hs
+++ b/ouroboros-network/src/Ouroboros/Cardano/Network/ArgumentsExtra.hs
@@ -30,9 +30,13 @@ data ExtraArguments m =
     -- to get a strong guarantee that when syncing up we will finish with a true
     -- ledger state. When false, we will fall back on the previous algorithms
     -- that leverage UseBootstrapPeers flag
+    --
+    -- TODO: duplicate, also present in `ExtraState` 
   , consensusMode          :: ConsensusMode
   }
 
+-- TODO it should be called `extraArgsToPeerSelectionActions`.  The module is
+-- supposed to be imported qualified.
 cardanoExtraArgsToPeerSelectionActions :: ExtraArguments m
                                        -> ExtraPeerSelectionActions m
 cardanoExtraArgsToPeerSelectionActions ExtraArguments {
diff --git a/ouroboros-network/src/Ouroboros/Cardano/Network/PeerSelection/Governor/PeerSelectionActions.hs b/ouroboros-network/src/Ouroboros/Cardano/Network/PeerSelection/Governor/PeerSelectionActions.hs
index 1d1811c1a38..8008f27b969 100644
--- a/ouroboros-network/src/Ouroboros/Cardano/Network/PeerSelection/Governor/PeerSelectionActions.hs
+++ b/ouroboros-network/src/Ouroboros/Cardano/Network/PeerSelection/Governor/PeerSelectionActions.hs
@@ -19,6 +19,8 @@ data ExtraPeerSelectionActions m =
     genesisPeerTargets    :: PeerSelectionTargets
 
     -- | Read the current bootstrap peers flag
+    --
+    -- TODO: a duplicate, it's also in `ExtraArguments`
   , readUseBootstrapPeers :: STM m UseBootstrapPeers
   }
 
diff --git a/ouroboros-network/src/Ouroboros/Cardano/Network/PeerSelection/Governor/Types.hs b/ouroboros-network/src/Ouroboros/Cardano/Network/PeerSelection/Governor/Types.hs
index eaef465a235..333eb59416d 100644
--- a/ouroboros-network/src/Ouroboros/Cardano/Network/PeerSelection/Governor/Types.hs
+++ b/ouroboros-network/src/Ouroboros/Cardano/Network/PeerSelection/Governor/Types.hs
@@ -188,7 +188,9 @@ cardanoPeerSelectionGovernorArgs
      )
   => Cardano.ExtraPeerSelectionActions m
   -> STM m UseLedgerPeers
+  -- ^ TODO: add to `ExtraPeerSelectionActions`
   -> PeerSharing
+  -- ^ PeerSharing configuration option (not the negotiated one).
   -> (OutboundConnectionsState -> STM m ())
   -> PeerSelectionGovernorArgs
        Cardano.ExtraState
diff --git a/ouroboros-network/src/Ouroboros/Network/Diffusion.hs b/ouroboros-network/src/Ouroboros/Network/Diffusion.hs
index 277334d11cc..b85e37ee06d 100644
--- a/ouroboros-network/src/Ouroboros/Network/Diffusion.hs
+++ b/ouroboros-network/src/Ouroboros/Network/Diffusion.hs
@@ -67,6 +67,8 @@ data ExtraTracers (p2p :: P2P) extraState extraDebugState extraFlags extraPeers
 
 -- | Diffusion arguments which depend on p2p mode.
 --
+-- TODO: specifying `exception` in a type is bad.
+-- TODO: swap order of `extraPeers` & `extraFlags` (for consistency sake)
 data ArgumentsExtra
        (p2p :: P2P) extraArgs extraState extraDebugState extraAPI
        extraFlags extraPeers extraChurnArgs extraCounters exception ntnAddr resolver resolverError m where
diff --git a/ouroboros-network/src/Ouroboros/Network/Diffusion/Common.hs b/ouroboros-network/src/Ouroboros/Network/Diffusion/Common.hs
index 93dda76a258..ea71f8248c5 100644
--- a/ouroboros-network/src/Ouroboros/Network/Diffusion/Common.hs
+++ b/ouroboros-network/src/Ouroboros/Network/Diffusion/Common.hs
@@ -361,6 +361,7 @@ nullTracersExtra =
 
 -- | P2P Arguments Extras
 --
+-- TODO: this ought to be in `P2P` module.
 data ArgumentsExtra extraState extraDebugState extraFlags extraPeers
                     extraAPI extraChurnArgs extraCounters exception
                     peeraddr resolver resolverError m = ArgumentsExtra {