Register PerasVoteDiffusion mini-protocol in NodeToNode

Co-authored-by: Agustin Mista <[email protected]>
Co-authored-by: Alexander Esgen <[email protected]>
Co-authored-by: Georgy Lukyanov <[email protected]>
Co-authored-by: Nicolas BACQUEY <[email protected]>
Co-authored-by: Nicolas "Niols" Jeannerod <[email protected]>

Author: 6 people

cardano-diffusion/lib/Cardano/Network/NodeToNode.hs

@@ -22,6 +22,7 @@ module Cardano.Network.NodeToNode
   , keepAliveProtocolLimits
   , peerSharingProtocolLimits
   , perasCertDiffusionProtocolLimits
+  , perasVoteDiffusionProtocolLimits
   , defaultMiniProtocolParameters
   , NodeToNodeVersion (..)
   , NodeToNodeVersionData (..)
@@ -71,6 +72,7 @@ module Cardano.Network.NodeToNode
   , keepAliveMiniProtocolNum
   , peerSharingMiniProtocolNum
   , perasCertDiffusionMiniProtocolNum
+  , perasVoteDiffusionMiniProtocolNum
   ) where
 
 import Control.Exception (SomeException)
@@ -128,6 +130,10 @@ data NodeToNodeProtocols appType initiatorCtx responderCtx bytes m a b = NodeToN
     --
     perasCertDiffusionProtocol :: RunMiniProtocol appType initiatorCtx responderCtx bytes m a b,
 
+    -- | Peras vote diffusion mini-protocol
+    --
+    perasVoteDiffusionProtocol :: RunMiniProtocol appType initiatorCtx responderCtx bytes m a b,
+
     -- | keep-alive mini-protocol
     --
     keepAliveProtocol          :: RunMiniProtocol appType initiatorCtx responderCtx bytes m a b,
@@ -164,7 +170,7 @@ data MiniProtocolParameters = MiniProtocolParameters {
       txDecisionPolicy                :: !TxDecisionPolicy,
       -- ^ tx submission protocol decision logic parameters
 
-      perasCertDiffusionMaxFifoLength :: !NumObjectsOutstanding
+      perasCertDiffusionMaxFifoLength :: !NumObjectsOutstanding,
       -- ^ Maximum number of PerasCerts in the outbound peer's outstanding FIFO.
       --
       -- This indirectly limits the number of pipelined requests from the inbound peer:
@@ -184,6 +190,11 @@ data MiniProtocolParameters = MiniProtocolParameters {
       -- So, the theoretical maximum pipeline size is
       -- @2 * perasCertDiffusionMaxFifoLength@, but in practice the pipeline size will
       -- be much smaller, as the inbound peer typically batches requests.
+
+      perasVoteDiffusionMaxFifoLength :: !NumObjectsOutstanding
+      -- ^ Maximum number of PerasVotes in the outbound peer's outstanding FIFO.
+      -- See comment on 'perasCertDiffusionMaxFifoLength' for more details to
+      -- understand why this indirectly limits the number of pipelined requests.
     }
 
 defaultMiniProtocolParameters :: MiniProtocolParameters
@@ -195,6 +206,9 @@ defaultMiniProtocolParameters = MiniProtocolParameters {
     -- | TODO: this value is still being discussed.
     -- See https://github.com/tweag/cardano-peras/issues/97 for reference.
     , perasCertDiffusionMaxFifoLength = 10
+    -- | TODO: this value is still being discussed.
+    -- See https://github.com/tweag/cardano-peras/issues/97 for reference.
+    , perasVoteDiffusionMaxFifoLength = 10_000
   }
 
 -- | Make an 'OuroborosApplication' for the bundle of mini-protocols that
@@ -234,7 +248,8 @@ nodeToNodeProtocols featureFlags miniProtocolParameters protocols
           NodeToNodeProtocols { chainSyncProtocol,
                                 blockFetchProtocol,
                                 txSubmissionProtocol,
-                                perasCertDiffusionProtocol
+                                perasCertDiffusionProtocol,
+                                perasVoteDiffusionProtocol
                               } ->
             [ MiniProtocol {
                 miniProtocolNum    = chainSyncMiniProtocolNum,
@@ -264,6 +279,12 @@ nodeToNodeProtocols featureFlags miniProtocolParameters protocols
                    miniProtocolLimits = perasCertDiffusionProtocolLimits miniProtocolParameters,
                    miniProtocolRun    = perasCertDiffusionProtocol
                  }
+               , MiniProtocol {
+                   miniProtocolNum    = perasVoteDiffusionMiniProtocolNum,
+                   miniProtocolStart  = StartOnDemand,
+                   miniProtocolLimits = perasVoteDiffusionProtocolLimits miniProtocolParameters,
+                   miniProtocolRun    = perasVoteDiffusionProtocol
+                 }
                ])
 
       -- Warm protocols: reserved for 'tip-sample'.
@@ -301,7 +322,8 @@ chainSyncProtocolLimits
   , txSubmissionProtocolLimits
   , keepAliveProtocolLimits
   , peerSharingProtocolLimits
-  , perasCertDiffusionProtocolLimits :: MiniProtocolParameters -> MiniProtocolLimits
+  , perasCertDiffusionProtocolLimits
+  , perasVoteDiffusionProtocolLimits :: MiniProtocolParameters -> MiniProtocolLimits
 
 chainSyncProtocolLimits MiniProtocolParameters { chainSyncPipeliningHighMark } =
   MiniProtocolLimits {
@@ -431,6 +453,15 @@ perasCertDiffusionProtocolLimits MiniProtocolParameters { perasCertDiffusionMaxF
         fromIntegral perasCertDiffusionMaxFifoLength * 20_000
     }
 
+perasVoteDiffusionProtocolLimits MiniProtocolParameters { perasVoteDiffusionMaxFifoLength } =
+  MiniProtocolLimits {
+      -- Peras votes are expected to be much smaller than Peras certificates.
+      -- We assume an upper bound of 1 kB per vote.
+      -- See https://github.com/tweag/cardano-peras/issues/97
+      maximumIngressQueue = addSafetyMargin $
+        fromIntegral perasVoteDiffusionMaxFifoLength * 1_000
+    }
+
 chainSyncMiniProtocolNum :: MiniProtocolNum
 chainSyncMiniProtocolNum = MiniProtocolNum 2
 
@@ -449,6 +480,9 @@ peerSharingMiniProtocolNum = MiniProtocolNum 10
 perasCertDiffusionMiniProtocolNum :: MiniProtocolNum
 perasCertDiffusionMiniProtocolNum = MiniProtocolNum 16
 
+perasVoteDiffusionMiniProtocolNum :: MiniProtocolNum
+perasVoteDiffusionMiniProtocolNum = MiniProtocolNum 17
+
 -- | A specialised version of @'Ouroboros.Network.Socket.connectToNode'@.
 --
 connectTo