ChainSync client: allow to prevent historical MsgRollBackward/MsgAwaitReply

ouroboros-consensus-diffusion/changelog.d/20240722_170436_alexander.esgen_historical_rollbacks.md

@@ -0,0 +1,3 @@
+### Breaking
+
+- Adapted to ChainSync client changes due to new message historicity check.

ouroboros-consensus-diffusion/src/ouroboros-consensus-diffusion/Ouroboros/Consensus/Network/NodeToNode.hs

@@ -211,14 +211,15 @@ mkHandlers ::
   -> NodeKernel     m addrNTN addrNTC blk
   -> Handlers       m addrNTN           blk
 mkHandlers
-      NodeKernelArgs {chainSyncFutureCheck, keepAliveRng, miniProtocolParameters}
-      NodeKernel {getChainDB, getMempool, getTopLevelConfig, getTracers = tracers, getPeerSharingAPI} =
+      NodeKernelArgs {chainSyncFutureCheck, chainSyncHistoricityCheck, keepAliveRng, miniProtocolParameters}
+      NodeKernel {getChainDB, getMempool, getTopLevelConfig, getTracers = tracers, getPeerSharingAPI, getGsmState} =
     Handlers {
         hChainSyncClient = \peer _isBigLedgerpeer dynEnv ->
           CsClient.chainSyncClient
             CsClient.ConfigEnv {
                 CsClient.cfg                     = getTopLevelConfig
               , CsClient.someHeaderInFutureCheck = chainSyncFutureCheck
+              , CsClient.historicityCheck        = chainSyncHistoricityCheck (atomically getGsmState)
               , CsClient.chainDbView             =
                   CsClient.defaultChainDbView getChainDB
               , CsClient.mkPipelineDecision0     = pipelineDecisionLowHighMark

ouroboros-consensus-diffusion/src/ouroboros-consensus-diffusion/Ouroboros/Consensus/Node.hs

@@ -81,6 +81,9 @@ import           Ouroboros.Consensus.Fragment.InFuture (CheckInFuture,
                      ClockSkew)
 import qualified Ouroboros.Consensus.Fragment.InFuture as InFuture
 import           Ouroboros.Consensus.Ledger.Extended (ExtLedgerState (..))
+import           Ouroboros.Consensus.MiniProtocol.ChainSync.Client.HistoricityCheck
+                     (HistoricityCheck)
+import qualified Ouroboros.Consensus.MiniProtocol.ChainSync.Client.HistoricityCheck as HistoricityCheck
 import qualified Ouroboros.Consensus.MiniProtocol.ChainSync.Client.InFutureCheck as InFutureCheck
 import qualified Ouroboros.Consensus.Network.NodeToClient as NTC
 import qualified Ouroboros.Consensus.Network.NodeToNode as NTN
@@ -491,6 +494,11 @@ runWith RunNodeArgs{..} encAddrNtN decAddrNtN LowLevelRunNodeArgs{..} =
               let gsmMarkerFileView =
                     case ChainDB.cdbsHasFSGsmDB $ ChainDB.cdbsArgs finalArgs of
                         SomeHasFS x -> GSM.realMarkerFileView chainDB x
+                  historicityCheck getGsmState =
+                    case gcHistoricityCutoff llrnGenesisConfig of
+                      Nothing                -> HistoricityCheck.noCheck
+                      Just historicityCutoff ->
+                        HistoricityCheck.mkCheck systemTime getGsmState historicityCutoff
               fmap (nodeKernelArgsEnforceInvariants . llrnCustomiseNodeKernelArgs)
                 $ mkNodeKernelArgs
                     registry
@@ -501,6 +509,7 @@ runWith RunNodeArgs{..} encAddrNtN decAddrNtN LowLevelRunNodeArgs{..} =
                     rnTraceConsensus
                     btime
                     (InFutureCheck.realHeaderInFutureCheck llrnMaxClockSkew systemTime)
+                    historicityCheck
                     chainDB
                     llrnMaxCaughtUpAge
                     (Just durationUntilTooOld)
@@ -744,6 +753,7 @@ mkNodeKernelArgs ::
   -> Tracers m (ConnectionId addrNTN) (ConnectionId addrNTC) blk
   -> BlockchainTime m
   -> InFutureCheck.SomeHeaderInFutureCheck m blk
+  -> (m GSM.GsmState -> HistoricityCheck m blk)
   -> ChainDB m blk
   -> NominalDiffTime
   -> Maybe (GSM.WrapDurationUntilTooOld m blk)
@@ -761,6 +771,7 @@ mkNodeKernelArgs
   tracers
   btime
   chainSyncFutureCheck
+  chainSyncHistoricityCheck
   chainDB
   maxCaughtUpAge
   gsmDurationUntilTooOld
@@ -778,6 +789,7 @@ mkNodeKernelArgs
       , chainDB
       , initChainDB             = nodeInitChainDB
       , chainSyncFutureCheck
+      , chainSyncHistoricityCheck
       , blockFetchSize          = estimateBlockSize
       , mempoolCapacityOverride = NoMempoolCapacityBytesOverride
       , miniProtocolParameters  = defaultMiniProtocolParameters

ouroboros-consensus-diffusion/src/ouroboros-consensus-diffusion/Ouroboros/Consensus/Node/Genesis.hs

@@ -24,6 +24,8 @@ import           Ouroboros.Consensus.MiniProtocol.ChainSync.Client
                      (CSJConfig (..), CSJEnabledConfig (..),
                      ChainSyncLoPBucketConfig (..),
                      ChainSyncLoPBucketEnabledConfig (..))
+import           Ouroboros.Consensus.MiniProtocol.ChainSync.Client.HistoricityCheck
+                     (HistoricityCutoff (..))
 import qualified Ouroboros.Consensus.Node.GsmState as GSM
 import           Ouroboros.Consensus.Storage.ChainDB (ChainDbArgs)
 import qualified Ouroboros.Consensus.Storage.ChainDB as ChainDB
@@ -45,6 +47,7 @@ data GenesisConfig = GenesisConfig {
     gcChainSyncLoPBucketConfig :: !ChainSyncLoPBucketConfig
   , gcCSJConfig                :: !CSJConfig
   , gcLoEAndGDDConfig          :: !(LoEAndGDDConfig ())
+  , gcHistoricityCutoff        :: !(Maybe HistoricityCutoff)
   }
 
 -- TODO justification/derivation from other parameters
@@ -58,6 +61,10 @@ enableGenesisConfigDefault = GenesisConfig {
           csjcJumpSize = 3 * 2160 * 20 -- mainnet forecast range
         }
     , gcLoEAndGDDConfig = LoEAndGDDEnabled ()
+      -- Duration in seconds of one Cardano mainnet Shelley stability window
+      -- (3k/f slots times one second per slot) plus one extra hour as a
+      -- safety margin.
+    , gcHistoricityCutoff = Just $ HistoricityCutoff $ 3 * 2160 * 20 + 3600
     }
 
 -- | Disable all Genesis components, yielding Praos behavior.
@@ -66,6 +73,7 @@ disableGenesisConfig = GenesisConfig {
       gcChainSyncLoPBucketConfig = ChainSyncLoPBucketDisabled
     , gcCSJConfig                = CSJDisabled
     , gcLoEAndGDDConfig          = LoEAndGDDDisabled
+    , gcHistoricityCutoff        = Nothing
     }
 
 -- | Genesis-related arguments needed by the NodeKernel initialization logic.

ouroboros-consensus-diffusion/src/ouroboros-consensus-diffusion/Ouroboros/Consensus/NodeKernel.hs

@@ -63,6 +63,8 @@ import qualified Ouroboros.Consensus.MiniProtocol.BlockFetch.ClientInterface as
 import           Ouroboros.Consensus.MiniProtocol.ChainSync.Client
                      (ChainSyncClientHandle (..), ChainSyncState (..),
                      viewChainSyncState)
+import           Ouroboros.Consensus.MiniProtocol.ChainSync.Client.HistoricityCheck
+                     (HistoricityCheck)
 import           Ouroboros.Consensus.MiniProtocol.ChainSync.Client.InFutureCheck
                      (SomeHeaderInFutureCheck)
 import           Ouroboros.Consensus.Node.Genesis (GenesisNodeKernelArgs (..),
@@ -171,6 +173,9 @@ data NodeKernelArgs m addrNTN addrNTC blk = NodeKernelArgs {
     , chainDB                 :: ChainDB m blk
     , initChainDB             :: StorageConfig blk -> InitChainDB m blk -> m ()
     , chainSyncFutureCheck    :: SomeHeaderInFutureCheck m blk
+      -- | See 'HistoricityCheck' for details.
+    , chainSyncHistoricityCheck
+                              :: m GSM.GsmState -> HistoricityCheck m blk
     , blockFetchSize          :: Header blk -> SizeInBytes
     , mempoolCapacityOverride :: MempoolCapacityBytesOverride
     , miniProtocolParameters  :: MiniProtocolParameters

ouroboros-consensus-diffusion/src/unstable-diffusion-testlib/Test/ThreadNet/Network.hs

@@ -71,6 +71,7 @@ import           Ouroboros.Consensus.Ledger.SupportsMempool
 import           Ouroboros.Consensus.Ledger.SupportsProtocol
 import           Ouroboros.Consensus.Mempool
 import qualified Ouroboros.Consensus.MiniProtocol.ChainSync.Client as CSClient
+import qualified Ouroboros.Consensus.MiniProtocol.ChainSync.Client.HistoricityCheck as HistoricityCheck
 import qualified Ouroboros.Consensus.MiniProtocol.ChainSync.Client.InFutureCheck as InFutureCheck
 import qualified Ouroboros.Consensus.Network.NodeToNode as NTN
 import           Ouroboros.Consensus.Node.ExitPolicy
@@ -1003,6 +1004,7 @@ runThreadNetwork systemTime ThreadNetworkArgs
                   InFutureCheck.realHeaderInFutureCheck
                     InFuture.defaultClockSkew
                     (OracularClock.finiteSystemTime clock)
+            , chainSyncHistoricityCheck = \_getGsmState -> HistoricityCheck.noCheck
             , blockFetchSize          = estimateBlockSize
             , mempoolCapacityOverride = NoMempoolCapacityBytesOverride
             , keepAliveRng            = kaRng

ouroboros-consensus-diffusion/test/consensus-test/Test/Consensus/PeerSimulator/ChainSync.hs

@@ -17,6 +17,7 @@ import           Data.Map.Strict (Map)
 import           Data.Proxy (Proxy (..))
 import           Network.TypedProtocol.Codec (AnyMessage)
 import           Ouroboros.Consensus.Block (Header, Point)
+import           Ouroboros.Consensus.BlockchainTime (RelativeTime (..))
 import           Ouroboros.Consensus.Config (TopLevelConfig (..))
 import           Ouroboros.Consensus.Ledger.SupportsProtocol
                      (LedgerSupportsProtocol)
@@ -25,6 +26,7 @@ import           Ouroboros.Consensus.MiniProtocol.ChainSync.Client
                      ChainSyncLoPBucketConfig, ChainSyncStateView (..),
                      Consensus, bracketChainSyncClient, chainSyncClient)
 import qualified Ouroboros.Consensus.MiniProtocol.ChainSync.Client as CSClient
+import qualified Ouroboros.Consensus.MiniProtocol.ChainSync.Client.HistoricityCheck as HistoricityCheck
 import qualified Ouroboros.Consensus.MiniProtocol.ChainSync.Client.InFutureCheck as InFutureCheck
 import           Ouroboros.Consensus.Node.GsmState (GsmState (Syncing))
 import           Ouroboros.Consensus.Util (ShowProxy)
@@ -84,6 +86,10 @@ basicChainSyncClient
       , CSClient.cfg
       , CSClient.chainDbView
       , CSClient.someHeaderInFutureCheck = dummyHeaderInFutureCheck
+        -- Preventing historical MsgRollBack and MsgAwaitReply messages is
+        -- motivated by preventing additional load from CSJ-disengaged peers; we
+        -- do not care about this in these tests.
+      , CSClient.historicityCheck        = HistoricityCheck.noCheck
       }
     CSClient.DynamicEnv {
         CSClient.version             = maxBound
@@ -103,7 +109,9 @@ basicChainSyncClient
       { InFutureCheck.proxyArrival = Proxy
       , InFutureCheck.recordHeaderArrival = \_ -> pure ()
       , InFutureCheck.judgeHeaderArrival = \_ _ _ -> pure ()
-      , InFutureCheck.handleHeaderArrival = \_ -> pure Nothing
+      , InFutureCheck.handleHeaderArrival = \_ ->
+          -- We are not inspecting header slot time in the Genesis tests.
+          pure $ pure $ RelativeTime 0
       }
 
 -- | Create and run a ChainSync client using 'bracketChainSyncClient' and

ouroboros-consensus/bench/ChainSync-client-bench/Main.hs

@@ -22,6 +22,7 @@ import qualified Ouroboros.Consensus.HeaderStateHistory as HeaderStateHistory
 import qualified Ouroboros.Consensus.HeaderValidation as HV
 import qualified Ouroboros.Consensus.Ledger.Extended as Extended
 import qualified Ouroboros.Consensus.MiniProtocol.ChainSync.Client as CSClient
+import qualified Ouroboros.Consensus.MiniProtocol.ChainSync.Client.HistoricityCheck as HistoricityCheck
 import qualified Ouroboros.Consensus.MiniProtocol.ChainSync.Client.InFutureCheck as InFutureCheck
 import           Ouroboros.Consensus.MiniProtocol.ChainSync.Server
                      (chainSyncServerForFollower)
@@ -38,10 +39,10 @@ import           Ouroboros.Consensus.Util.STM (Fingerprint (..),
 import           Ouroboros.Consensus.Util.Time (secondsToNominalDiffTime)
 import           Ouroboros.Network.AnchoredFragment (AnchoredFragment)
 import qualified Ouroboros.Network.AnchoredFragment as AF
-import qualified Ouroboros.Network.AnchoredSeq as AS
 import           Ouroboros.Network.Block (ChainUpdate (AddBlock, RollBack),
                      Tip (TipGenesis), tipFromHeader)
 import           Ouroboros.Network.ControlMessage (ControlMessage (Continue))
+import qualified Ouroboros.Network.Mock.Chain as Chain
 import           Ouroboros.Network.Protocol.ChainSync.ClientPipelined
 import           Ouroboros.Network.Protocol.ChainSync.Codec (codecChainSyncId)
 import           Ouroboros.Network.Protocol.ChainSync.PipelineDecision
@@ -105,11 +106,12 @@ oneBenchRun
         CSClient.getCurrentChain       = pure $ AF.Empty AF.AnchorGenesis
       , CSClient.getHeaderStateHistory =
             pure
-          $ HeaderStateHistory.HeaderStateHistory
-          $ AS.Empty
-          $ HV.genesisHeaderState ()
+          $ HeaderStateHistory.fromChain
+              topConfig
+              (oracularLedgerDB GenesisPoint)
+              Chain.Genesis
       , CSClient.getIsInvalidBlock     = pure invalidBlock
-      , CSClient.getPastLedger         = pure . oracularLedgerDB
+      , CSClient.getPastLedger         = pure . Just . oracularLedgerDB
       }
 
     headerInFutureCheck ::
@@ -127,6 +129,7 @@ oneBenchRun
               , CSClient.cfg                     = topConfig
               , CSClient.tracer                  = nullTracer `asTypeOf` contramap show debugTracer
               , CSClient.someHeaderInFutureCheck = headerInFutureCheck
+              , CSClient.historicityCheck        = HistoricityCheck.noCheck
               , CSClient.mkPipelineDecision0     =
                     pipelineDecisionLowHighMark 10 20
               }
@@ -174,9 +177,9 @@ inTheYearOneBillion = SystemTime {
         * 1e9
   }
 
-oracularLedgerDB :: Point B -> Maybe (Extended.ExtLedgerState B)
+oracularLedgerDB :: Point B -> Extended.ExtLedgerState B
 oracularLedgerDB p =
-    Just Extended.ExtLedgerState {
+    Extended.ExtLedgerState {
         Extended.headerState = HV.HeaderState {
             HV.headerStateTip      = case pointToWithOriginRealPoint p of
                 Origin       -> Origin

ouroboros-consensus/changelog.d/20240722_170344_alexander.esgen_historical_rollbacks.md

@@ -0,0 +1,4 @@
+### Breaking
+
+- Added functionality to disallow historical `MsgRollBackward`s and
+  `MsgAwaitReply`s in the ChainSync client.

ouroboros-consensus/ouroboros-consensus.cabal

@@ -170,6 +170,7 @@ library
     Ouroboros.Consensus.MiniProtocol.BlockFetch.ClientInterface
     Ouroboros.Consensus.MiniProtocol.BlockFetch.Server
     Ouroboros.Consensus.MiniProtocol.ChainSync.Client
+    Ouroboros.Consensus.MiniProtocol.ChainSync.Client.HistoricityCheck
     Ouroboros.Consensus.MiniProtocol.ChainSync.Client.InFutureCheck
     Ouroboros.Consensus.MiniProtocol.ChainSync.Client.Jumping
     Ouroboros.Consensus.MiniProtocol.ChainSync.Client.State
@@ -723,6 +724,7 @@ benchmark ChainSync-client-bench
     contra-tracer,
     ouroboros-consensus,
     ouroboros-network-api,
+    ouroboros-network-mock,
     ouroboros-network-protocols,
     time,
     typed-protocols-examples,