tx-submission: added TxsToMempool newtype

Just to make it more outstanding what the output of `acknowledgeTxIds`
is indented for.

Author: coot

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

@@ -214,11 +214,15 @@ pickTxsToDownload policy@TxDecisionPolicy { txsSizeInflightPerPeer,
           sizeInflightOther = sizeInflightAll - requestedTxsInflightSize
 
       in if sizeInflightAll >= maxTxsSizeInflight
-        then let (numTxIdsToAck, numTxIdsToReq, txsToMempool, RefCountDiff { txIdsToAck }, peerTxState') =
-                    acknowledgeTxIds policy sharedState peerTxState
+        then let ( numTxIdsToAck
+                   , numTxIdsToReq
+                   , txsToMempool@TxsToMempool { listOfTxsToMempool }
+                   , RefCountDiff { txIdsToAck }
+                   , peerTxState'
+                   ) = acknowledgeTxIds policy sharedState peerTxState
 
                  stAcknowledged' = Map.unionWith (+) stAcknowledged txIdsToAck
-                 stLimboTx'      = stLimboTx <> (Set.fromList $ map fst txsToMempool)
+                 stLimboTx'      = stLimboTx <> Set.fromList (map fst listOfTxsToMempool)
              in
              if requestedTxIdsInflight peerTxState' > 0
                then
@@ -300,8 +304,12 @@ pickTxsToDownload policy@TxDecisionPolicy { txsSizeInflightPerPeer,
                                           <> txsToRequest
                 }
 
-              (numTxIdsToAck, numTxIdsToReq, txsToMempool, RefCountDiff { txIdsToAck }, peerTxState'') =
-                acknowledgeTxIds policy sharedState peerTxState'
+              ( numTxIdsToAck
+                , numTxIdsToReq
+                , txsToMempool@TxsToMempool { listOfTxsToMempool }
+                , RefCountDiff { txIdsToAck }
+                , peerTxState''
+                ) = acknowledgeTxIds policy sharedState peerTxState'
 
               stAcknowledged' = Map.unionWith (+) stAcknowledged txIdsToAck
 
@@ -313,7 +321,7 @@ pickTxsToDownload policy@TxDecisionPolicy { txsSizeInflightPerPeer,
               stInflight' :: Map txid Int
               stInflight' = Map.unionWith (+) stInflightDelta stInflight
 
-              stLimboTx'      = stLimboTx <> (Set.fromList $ map fst txsToMempool)
+              stLimboTx'      = stLimboTx <> (Set.fromList $ map fst listOfTxsToMempool)
           in
             if requestedTxIdsInflight peerTxState'' > 0
               then
@@ -389,9 +397,9 @@ pickTxsToDownload policy@TxDecisionPolicy { txsSizeInflightPerPeer,
                       TxDecision { txdTxIdsToAcknowledge = 0,
                                    txdTxIdsToRequest     = 0,
                                    txdTxsToRequest,
-                                   txdTxsToMempool }
+                                   txdTxsToMempool = TxsToMempool { listOfTxsToMempool } }
                                  | null txdTxsToRequest
-                                 , null txdTxsToMempool
+                                 , null listOfTxsToMempool
                                  -> Nothing
                       _          -> Just (a, b)
                     )
@@ -403,7 +411,8 @@ pickTxsToDownload policy@TxDecisionPolicy { txsSizeInflightPerPeer,
                           Map txid Int
                        -> (a, TxDecision txid tx)
                        -> Map txid Int
-        updateLimboTxs m (_,d) = foldl' fn m $ txdTxsToMempool d
+        updateLimboTxs m (_,TxDecision { txdTxsToMempool } ) =
+            foldl' fn m (listOfTxsToMempool txdTxsToMempool)
           where
             fn :: Map txid Int
                -> (txid,tx)

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

@@ -77,15 +77,15 @@ txSubmissionInboundV2
     serverIdle = do
         -- Block on next decision.
         txd@TxDecision { txdTxsToRequest = txsToRequest,
-                         txdTxsToMempool = txsToMempool }
+                         txdTxsToMempool = TxsToMempool { listOfTxsToMempool } }
           <- readTxDecision
         traceWith tracer (TraceTxInboundDecision txd)
 
-        let !collected = length txsToMempool
+        let !collected = length listOfTxsToMempool
 
         -- Only attempt to add TXs if we have some work to do
         when (collected > 0) $ do
-            mapM_ (withMempoolSem . addTx) txsToMempool
+            mapM_ (withMempoolSem . addTx) listOfTxsToMempool
 
             traceWith tracer $
               TraceTxSubmissionCollected collected

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

@@ -100,7 +100,12 @@ acknowledgeTxIds
     => TxDecisionPolicy
     -> SharedTxState peeraddr txid tx
     -> PeerTxState txid tx
-    -> (NumTxIdsToAck, NumTxIdsToReq, [(txid,tx)], RefCountDiff txid, PeerTxState txid tx)
+    -> ( NumTxIdsToAck
+       , NumTxIdsToReq
+       , TxsToMempool txid tx
+       , RefCountDiff txid
+       , PeerTxState txid tx
+       )
     -- ^ number of txid to acknowledge, requests, txs which we can submit to the
     -- mempool, txids to acknowledge with multiplicities, updated PeerTxState.
 {-# INLINE acknowledgeTxIds #-}
@@ -124,7 +129,7 @@ acknowledgeTxIds
       then
       ( txIdsToAcknowledge
       , txIdsToRequest
-      , txsToMempool
+      , TxsToMempool txsToMempool
       , refCountDiff
       , ps { unacknowledgedTxIds    = unacknowledgedTxIds',
              availableTxIds         = availableTxIds',
@@ -138,7 +143,7 @@ acknowledgeTxIds
       else
       ( 0
       , 0
-      , []
+      , TxsToMempool []
       , RefCountDiff Map.empty
       , ps
       )

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

@@ -1,15 +1,18 @@
-{-# LANGUAGE DeriveGeneric             #-}
-{-# LANGUAGE ExistentialQuantification #-}
-{-# LANGUAGE FlexibleContexts          #-}
-{-# LANGUAGE NamedFieldPuns            #-}
-{-# LANGUAGE StandaloneDeriving        #-}
+{-# LANGUAGE DeriveGeneric              #-}
+{-# LANGUAGE DerivingStrategies         #-}
+{-# LANGUAGE ExistentialQuantification  #-}
+{-# LANGUAGE FlexibleContexts           #-}
+{-# LANGUAGE GeneralisedNewtypeDeriving #-}
+{-# LANGUAGE NamedFieldPuns             #-}
+{-# LANGUAGE StandaloneDeriving         #-}
 
 module Ouroboros.Network.TxSubmission.Inbound.Types
   ( -- * PeerTxState
     PeerTxState (..)
     -- * SharedTxState
   , SharedTxState (..)
     -- * Decisions
+  , TxsToMempool (..)
   , TxDecision (..)
   , emptyTxDecision
   , SharedDecisionContext (..)
@@ -209,6 +212,10 @@ instance ( NoThunks peeraddr
 -- Decisions
 --
 
+newtype TxsToMempool txid tx = TxsToMempool { listOfTxsToMempool :: [(txid, tx)] }
+  deriving newtype (Eq, Show, Semigroup, Monoid)
+
+
 -- | Decision made by the decision logic.  Each peer will receive a 'Decision'.
 --
 -- /note:/ it is rather non-standard to represent a choice between requesting
@@ -235,7 +242,7 @@ data TxDecision txid tx = TxDecision {
     txdTxsToRequest       :: !(Set txid),
     -- ^ txid's to download.
 
-    txdTxsToMempool       :: ![(txid,tx)]
+    txdTxsToMempool       :: !(TxsToMempool txid tx)
     -- ^ list of `tx`s to submit to the mempool.
   }
   deriving (Show, Eq)
@@ -262,7 +269,7 @@ instance Ord txid => Semigroup (TxDecision txid tx) where
                    txdTxIdsToRequest     = txdTxIdsToRequest + txdTxIdsToRequest',
                    txdPipelineTxIds      = txdPipelineTxIds',
                    txdTxsToRequest       = txdTxsToRequest <> txdTxsToRequest',
-                   txdTxsToMempool       = txdTxsToMempool ++ txdTxsToMempool'
+                   txdTxsToMempool       = txdTxsToMempool <> txdTxsToMempool'
                  }
 
 -- | A no-op decision.
@@ -272,7 +279,7 @@ emptyTxDecision = TxDecision {
     txdTxIdsToRequest     = 0,
     txdPipelineTxIds      = False,
     txdTxsToRequest       = Set.empty,
-    txdTxsToMempool       = []
+    txdTxsToMempool       = mempty
   }
 
 data SharedDecisionContext peeraddr txid tx = SharedDecisionContext {

ouroboros-network/testlib/Test/Ouroboros/Network/TxSubmission/TxLogic.hs

@@ -654,7 +654,7 @@ prop_acknowledgeTxIds :: ArbDecisionContextWithReceivedTxIds
                       -> Property
 prop_acknowledgeTxIds (ArbDecisionContextWithReceivedTxIds policy SharedDecisionContext { sdcSharedTxState = st } ps _ _ _) =
     case TXS.acknowledgeTxIds policy st ps of
-      (numTxIdsToAck, txIdsToRequest, txIdsTxs, TXS.RefCountDiff { TXS.txIdsToAck }, ps') | txIdsToRequest > 0 ->
+      (numTxIdsToAck, txIdsToRequest, TXS.TxsToMempool txIdsTxs, TXS.RefCountDiff { TXS.txIdsToAck }, ps') | txIdsToRequest > 0 ->
              counterexample "number of tx ids to ack must agree with RefCountDiff"
              ( fromIntegral numTxIdsToAck
                ===