WIP: questions & todos

Author: coot

ouroboros-network/src/Ouroboros/Network/TxSubmission/Inbound/Registry.hs

@@ -100,6 +100,10 @@ data PeerTxAPI m txid tx = PeerTxAPI {
 
     withMempoolSem      :: m (Either (txid, tx) (txid, tx))
                         -> m (Either (txid, tx) (txid, tx))
+    -- TODO:
+    -- the split into `addTx` in the `Server` and `withMempoolSem` is artificial. 
+    -- Better exose: `addTxToMempool :: txid -> tx -> m ()` which composes both
+    -- actions. We can ignore the result, since it is ignored in the `Server`.
   }
 
 
@@ -239,6 +243,7 @@ withPeer tracer
         inflightTxs' = foldl' purgeInflightTxs inflightTxs requestedTxsInflight
         inflightTxsSize' = inflightTxsSize - requestedTxsInflightSize
 
+        -- TODO: describe why we need to add `toMempoolTxs` to `limboTxs`.
         limboTxs' =
           foldl' (flip $ Map.update
                              \cnt -> if cnt > 1

ouroboros-network/src/Ouroboros/Network/TxSubmission/Inbound/State.hs

@@ -145,6 +145,7 @@ acknowledgeTxIds
       , 0
       , TxsToMempool []
       , RefCountDiff Map.empty
+      -- Q: why we don't return `toMempoolTxs'` in this case?
       , ps
       )
   where
@@ -241,6 +242,7 @@ tickTimedTxs now st@SharedTxState{ timedTxs
                                  , bufferedTxs } =
     let (expiredTxs, timedTxs') = Map.split now timedTxs
         expiredTxs'             =  -- Map.split doesn't include the `now` entry in any map
+                                   -- TODO: there must be a better way.
                                   case Map.lookup now timedTxs of
                                        Just txids -> Map.insert now txids expiredTxs
                                        Nothing    -> expiredTxs