TX Submission Logic

network-mux/src/Network/Mux/Bearer/Socket.hs

@@ -222,7 +222,7 @@ socketAsBearer sduSize batchSize readBuffer_m sduTimeout pollInterval tracer sd
           let ts32 = Mx.timestampMicrosecondsLow32Bits ts
               buf  = map (Mx.encodeSDU .
                            (\sdu -> Mx.setTimestamp sdu (Mx.RemoteClockModel ts32))) sdus
-          r <- timeout ((fromIntegral $ length sdus) * sduTimeout) $
+          r <- timeout (fromIntegral (length sdus) * sduTimeout) $
               Socket.sendMany sd (concatMap BL.toChunks buf)
               `catch` Mx.handleIOException "sendAll errored"
           case r of

network-mux/src/Network/Mux/Codec.hs

@@ -18,13 +18,22 @@ import Network.Mux.Types
 -- >  0                   1                   2                   3
 -- >  0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
 -- > +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
--- > |              transmission time                                |
+-- > |                        transmission time                      |
 -- > +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
--- > |M|    conversation id          |              length           |
+-- > |d|    mini-protocol number     |             length            |
 -- > +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
 --
 -- All fields are in big endian byte order.
 --
+-- * transmission time: time when the SDU was sent
+-- * @d@: mini-protocol direction (`MiniProtocolDir`):
+--
+--     * 1 - initiator direction
+--     * 0 - responder direction
+--
+-- * mini-protocol number (`MiniProtocolNum`)
+-- * length: length of the payload
+--
 encodeSDU :: SDU -> BL.ByteString
 encodeSDU sdu =
   let hdr = Bin.runPut enc in

ouroboros-network-api/CHANGELOG.md

@@ -7,6 +7,7 @@
 ### Non-breaking changes
 
 * `IsLedgerPeer` added to `Ouroboros.Network.LedgerPeers.Types` module.
+* Derived `Bounded` instance for `SizeInBytes`.
 
 ## 0.13.0.0 -- 2025-02-25
 

ouroboros-network-api/src/Ouroboros/Network/SizeInBytes.hs

@@ -17,6 +17,7 @@ import Quiet (Quiet (..))
 newtype SizeInBytes = SizeInBytes { getSizeInBytes :: Word32 }
   deriving (Eq, Ord)
   deriving Show      via Quiet SizeInBytes
+  deriving Bounded   via Word32
   deriving Enum      via Word32
   deriving Num       via Word32
   deriving Real      via Word32

ouroboros-network-protocols/CHANGELOG.md

@@ -4,6 +4,9 @@
 
 ### Breaking changes
 
+* `CollectPipelined` constructor for `TxSubmission2.Server` was modified: now
+  one can run a monadic action in the continuation when no message is available.
+
 ### Non-breaking changes
 
 ## 0.14.0.0 -- 2025-02-25

ouroboros-network-protocols/src/Ouroboros/Network/Protocol/TxSubmission2/Server.hs

@@ -82,9 +82,9 @@ data ServerStIdle (n :: N) txid tx m a where
   -- | Collect a pipelined result.
   --
   CollectPipelined
-    :: Maybe                 (ServerStIdle (S n) txid tx m a)
-    -> (Collect txid tx -> m (ServerStIdle    n  txid tx m a))
-    ->                        ServerStIdle (S n) txid tx m a
+    :: Maybe                 (m (ServerStIdle (S n) txid tx m a))
+    -> (Collect txid tx -> m (   ServerStIdle    n  txid tx m a))
+    ->                           ServerStIdle (S n) txid tx m a
 
 
 -- | Transform a 'TxSubmissionServerPipelined' into a 'PeerPipelined'.
@@ -134,6 +134,6 @@ txSubmissionServerPeerPipelined (TxSubmissionServerPipelined server) =
         (Effect (go <$> k))
 
     go (CollectPipelined mNone collect) =
-      Collect (fmap go mNone)
-              (Effect . fmap go . collect)
+      Collect (Effect . fmap go <$> mNone)
+              (Effect . fmap go  .  collect)
 

ouroboros-network-protocols/src/Ouroboros/Network/Protocol/TxSubmission2/Type.hs

@@ -222,6 +222,12 @@ instance Protocol (TxSubmission2 txid tx) where
     -- * The non-blocking case must be used when there are non-zero remaining
     --   unacknowledged transactions.
     --
+    -- It is a protocol error to:
+    --
+    --  * make a blocking request with  `NumTxIdsToReq 0`;
+    --
+    --  * make a non-blocking request with both `NumTxIdsToAck 0` and `NumTxIdsReq 0`.
+    --
     MsgRequestTxIds
       :: forall (blocking :: StBlockingStyle) txid tx.
          SingBlockingStyle blocking

ouroboros-network-protocols/testlib/Ouroboros/Network/Protocol/TxSubmission2/Direct.hs

@@ -54,7 +54,8 @@ directPipelined (TxSubmissionServerPipelined mserver)
       SendMsgReplyTxs txs client' <- recvMsgRequestTxs txids
       directSender (enqueue (CollectTxs txids txs) q) server' client'
 
-    directSender q (CollectPipelined (Just server') _) client =
+    directSender q (CollectPipelined (Just server) _) client = do
+      server' <- server
       directSender q server' client
 
     directSender (ConsQ c q) (CollectPipelined _ collect) client = do

ouroboros-network-protocols/testlib/Ouroboros/Network/Protocol/TxSubmission2/Examples.hs

@@ -272,7 +272,7 @@ txSubmissionServer tracer txId maxUnacked maxTxIdsToRequest maxTxToRequest =
         --
       | canRequestMoreTxs st
       = CollectPipelined
-          (Just (serverReqTxs accum (Succ n) st))
+          (Just (pure $ serverReqTxs accum (Succ n) st))
           (handleReply accum n st)
 
         -- In this case there is nothing else to do so we block until we

ouroboros-network-testing/CHANGELOG.md

@@ -6,6 +6,10 @@
 
 ### Non-breaking changes
 
+* `renderRanges`: print a range using math notation for open/closed intervals.
+* Pretty print `WithName` using `Show` instance.
+* Pretty print `WithTime` using `Show` instance.
+
 ## 0.8.1.0 -- 2025-02-25
 
 ### Non-breaking changes

ouroboros-network-testing/src/Test/Ouroboros/Network/Utils.hs

@@ -52,6 +52,7 @@ import Data.Ratio
 import Data.Set (Set)
 import Data.Set qualified as Set
 import Text.Pretty.Simple (pPrint)
+import Text.Printf
 
 import Debug.Trace (traceShowM)
 import Test.QuickCheck
@@ -136,7 +137,7 @@ prop_shrink_valid valid (ShrinkCarefully x) =
 -- | Use in 'tabulate' to help summarise data into buckets.
 --
 renderRanges :: Int -> Int -> String
-renderRanges r n = show lower ++ " -- " ++ show upper
+renderRanges r n = "[" ++ printf "% 3d" lower ++ ", " ++ printf "% 3d" upper ++ ")"
   where
     lower = n - n `mod` r
     upper = lower + (r-1)
@@ -167,13 +168,19 @@ data WithName name event = WithName {
     wnName  :: name,
     wnEvent :: event
   }
-  deriving (Show, Functor)
+  deriving Functor
+
+instance (Show name, Show event) => Show (WithName name event) where
+    show WithName { wnName = name, wnEvent = event } = show name ++ ": " ++ show event
 
 data WithTime event = WithTime {
     wtTime  :: Time,
     wtEvent :: event
   }
-  deriving (Show, Functor)
+  deriving Functor
+
+instance Show event => Show (WithTime event) where
+    show WithTime { wtTime = (Time time), wtEvent = event } = show time ++ "@ " ++ show event
 
 tracerWithName :: name -> Tracer m (WithName name a) -> Tracer m a
 tracerWithName name = contramap (WithName name)

ouroboros-network/CHANGELOG.md

@@ -10,6 +10,7 @@
   are captured by the `DNSPeersKind` type, which also distinguishes the type
   of ledger peer.
 * Added `dispatchLookupWithTTL`
+* Added `Ouroboros.Network.TxSubmission.Inbound.V2`.
 
 ### Breaking changes
 
@@ -38,6 +39,10 @@
 - Renamed `Applications` to `DiffusionApplications`
 - `runM` function now receives `ExtraParameters` as an argument
 - Configurable Mux Egress Poll Interval
+- `Ouroboros.Network.TxSubmission.Inbound` moved to `Ouroboros.Network.TxSubmission.Inbound.V1`
+- `Ouroboros.Network.TxSubmission.Inbound.V1.txSubmissionInbound` takes extra argument: `TxSubmissionInitDelay` (previously configurable through `cabal` flags).
+- Removed the `txsubmission-delay` cabal flag.
+- `ProtocolErrorRequestedTooManyTxids` includes number of unacked txids.
 
 ## 0.20.1.0 -- 2025-03-13
 

ouroboros-network/ouroboros-network.cabal

@@ -20,11 +20,6 @@ flag asserts
   manual: False
   default: False
 
-flag txsubmission-delay
-  description: Delay initial request for transactions from outbound/client peer
-  manual: True
-  default: True
-
 source-repository head
   type: git
   location: https://github.com/intersectmbo/ouroboros-network
@@ -96,7 +91,13 @@ library
     Ouroboros.Network.PeerSelection.State.LocalRootPeers
     Ouroboros.Network.PeerSelection.Types
     Ouroboros.Network.PeerSharing
-    Ouroboros.Network.TxSubmission.Inbound
+    Ouroboros.Network.TxSubmission.Inbound.V1
+    Ouroboros.Network.TxSubmission.Inbound.V2
+    Ouroboros.Network.TxSubmission.Inbound.V2.Decision
+    Ouroboros.Network.TxSubmission.Inbound.V2.Policy
+    Ouroboros.Network.TxSubmission.Inbound.V2.Registry
+    Ouroboros.Network.TxSubmission.Inbound.V2.State
+    Ouroboros.Network.TxSubmission.Inbound.V2.Types
     Ouroboros.Network.TxSubmission.Mempool.Reader
     Ouroboros.Network.TxSubmission.Outbound
 
@@ -169,7 +170,8 @@ library
     random,
     si-timers,
     strict-checked-vars ^>=0.2,
-    strict-stm >=1.0 && <1.6,
+    strict-mvar,
+    strict-stm,
     transformers,
     typed-protocols ^>=0.3,
     typed-protocols-stateful,
@@ -181,9 +183,6 @@ library
   if flag(asserts)
     ghc-options: -fno-ignore-asserts
 
-  if flag(txsubmission-delay)
-    cpp-options: -DTXSUBMISSION_DELAY
-
 library ouroboros-orphan-instances
   import: ghc-options
   visibility: public
@@ -321,6 +320,7 @@ library testlib
     bytestring,
     cardano-binary,
     cardano-slotting,
+    cardano-strict-containers,
     cborg,
     containers,
     contra-tracer,
@@ -350,6 +350,7 @@ library testlib
     random,
     serialise,
     si-timers,
+    strict-mvar,
     strict-stm,
     tasty,
     tasty-hunit,
@@ -390,6 +391,10 @@ library testlib
     Test.Ouroboros.Network.PeerSelection.PeerMetric
     Test.Ouroboros.Network.PeerSelection.RootPeersDNS
     Test.Ouroboros.Network.TxSubmission
+    Test.Ouroboros.Network.TxSubmission.AppV1
+    Test.Ouroboros.Network.TxSubmission.AppV2
+    Test.Ouroboros.Network.TxSubmission.TxLogic
+    Test.Ouroboros.Network.TxSubmission.Types
     Test.Ouroboros.Network.Version
 
 -- Simulation tests, and IO tests which don't require native system calls.

ouroboros-network/src/Ouroboros/Network/Diffusion/Configuration.hs

@@ -11,6 +11,7 @@ module Ouroboros.Network.Diffusion.Configuration
   , defaultDeadlineTargets
   , defaultDeadlineChurnInterval
   , defaultBulkChurnInterval
+  , defaultTxSubmissionLogicVersion
     -- re-exports
   , AcceptedConnectionsLimit (..)
   , BlockFetchConfiguration (..)
@@ -20,6 +21,7 @@ module Ouroboros.Network.Diffusion.Configuration
   , PeerSelectionTargets (..)
   , PeerSharing (..)
   , ConsensusMode (..)
+  , TxSubmissionLogicVersion (..)
   , defaultConsensusMode
   , defaultMiniProtocolParameters
   , deactivateTimeout
@@ -57,6 +59,8 @@ import Ouroboros.Network.Protocol.ChainSync.Codec (ChainSyncTimeout (..))
 import Ouroboros.Network.Protocol.Handshake (handshake_QUERY_SHUTDOWN_DELAY)
 import Ouroboros.Network.Protocol.Limits (shortWait)
 import Ouroboros.Network.Server.RateLimiting (AcceptedConnectionsLimit (..))
+import Ouroboros.Network.TxSubmission.Inbound.V2.Types
+           (TxSubmissionLogicVersion (..))
 
 -- |Outbound governor targets
 -- Targets may vary depending on whether a node is operating in
@@ -150,3 +154,7 @@ local_PROTOCOL_IDLE_TIMEOUT = 2 -- 2 seconds
 local_TIME_WAIT_TIMEOUT :: DiffTime
 local_TIME_WAIT_TIMEOUT = 0
 
+-- | The default logic version is the legacy one, the new one is still
+-- experimental.
+defaultTxSubmissionLogicVersion :: TxSubmissionLogicVersion
+defaultTxSubmissionLogicVersion = TxSubmissionLogicV1

ouroboros-network/src/Ouroboros/Network/NodeToNode.hs

@@ -4,6 +4,7 @@
 {-# LANGUAGE NumericUnderscores  #-}
 {-# LANGUAGE RankNTypes          #-}
 {-# LANGUAGE ScopedTypeVariables #-}
+{-# LANGUAGE TypeApplications    #-}
 {-# LANGUAGE TypeFamilies        #-}
 
 {-# OPTIONS_GHC -Wno-orphans #-}
@@ -99,8 +100,11 @@ import Ouroboros.Network.Protocol.Handshake.Type
 import Ouroboros.Network.Protocol.Handshake.Version hiding (Accept)
 import Ouroboros.Network.Protocol.TxSubmission2.Type (NumTxIdsToAck (..))
 import Ouroboros.Network.Server.RateLimiting
+import Ouroboros.Network.SizeInBytes
 import Ouroboros.Network.Snocket
 import Ouroboros.Network.Socket
+import Ouroboros.Network.TxSubmission.Inbound.V2.Policy (TxDecisionPolicy (..),
+           defaultTxDecisionPolicy, max_TX_SIZE)
 import Ouroboros.Network.Util.ShowProxy (ShowProxy, showProxy)
 
 
@@ -157,17 +161,16 @@ data MiniProtocolParameters = MiniProtocolParameters {
       blockFetchPipeliningMax     :: !Word16,
       -- ^ maximal number of pipelined messages in 'block-fetch' mini-protocol.
 
-      txSubmissionMaxUnacked      :: !NumTxIdsToAck
-      -- ^ maximal number of unacked tx (pipelining is bounded by twice this
-      -- number)
+      txDecisionPolicy            :: !TxDecisionPolicy
+      -- ^ tx submission protocol decision logic parameters
     }
 
 defaultMiniProtocolParameters :: MiniProtocolParameters
 defaultMiniProtocolParameters = MiniProtocolParameters {
       chainSyncPipeliningLowMark  = 200
     , chainSyncPipeliningHighMark = 300
     , blockFetchPipeliningMax     = 100
-    , txSubmissionMaxUnacked       = 10
+    , txDecisionPolicy            = defaultTxDecisionPolicy
   }
 
 -- | Make an 'OuroborosApplication' for the bundle of mini-protocols that
@@ -295,7 +298,9 @@ blockFetchProtocolLimits MiniProtocolParameters { blockFetchPipeliningMax } = Mi
       max (10 * 2_097_154 :: Int) (fromIntegral blockFetchPipeliningMax * 90_112)
   }
 
-txSubmissionProtocolLimits MiniProtocolParameters { txSubmissionMaxUnacked } = MiniProtocolLimits {
+txSubmissionProtocolLimits MiniProtocolParameters
+                             { txDecisionPolicy = TxDecisionPolicy { maxUnacknowledgedTxIds }
+                             } = MiniProtocolLimits {
       -- tx-submission server can pipeline both 'MsgRequestTxIds' and
       -- 'MsgRequestTx'. This means that there can be many
       -- 'MsgReplyTxIds', 'MsgReplyTxs' messages in an inbound queue (their
@@ -353,12 +358,12 @@ txSubmissionProtocolLimits MiniProtocolParameters { txSubmissionMaxUnacked } = M
       -- queue of 'txSubmissionOutbound' is bounded by the ingress side of
       -- the 'txSubmissionInbound'
       --
-      -- Currently the value of 'txSubmissionMaxUnacked' is '100', for
-      -- which the upper bound is `100 * (44 + 65_540) = 6_558_400`, we add
+      -- Currently the value of 'txSubmissionMaxUnacked' is '10', for
+      -- which the upper bound is `10 * (44 + 65_540) = 655_840`, we add
       -- 10% as a safety margin.
       --
       maximumIngressQueue = addSafetyMargin $
-          fromIntegral txSubmissionMaxUnacked * (44 + 65_540)
+          fromIntegral maxUnacknowledgedTxIds * (44 + fromIntegral @SizeInBytes @Int max_TX_SIZE)
     }
 
 keepAliveProtocolLimits _ =