Merge pull request #4850 from IntersectMBO/mwojtowicz/provide-peers-from-snapshot

Feed peer selection governor with big ledger peers obtained from a snapshot

Author: crocodile-dentist

ouroboros-network-api/CHANGELOG.md

@@ -14,6 +14,9 @@
   * New type supports CBOR & JSON for serialisation purposes.
   * Ledger peer snapshot is versioned in case changes need to be made to the
     encoding format in the future.
+* Renamed:
+  * `accBigPoolStake` -> `accumulateBigLedgerStake`
+     and `reRelativeStake` -> `recomputeRelativeStake`
 
 * Added `Measure` and `BoundedMeasure` instances for `SizeInBytes`.
 

ouroboros-network-api/src/Ouroboros/Network/PeerSelection/LedgerPeers/Utils.hs

@@ -3,8 +3,8 @@
 
 module Ouroboros.Network.PeerSelection.LedgerPeers.Utils
   ( bigLedgerPeerQuota
-  , accBigPoolStake
-  , reRelativeStake
+  , accumulateBigLedgerStake
+  , recomputeRelativeStake
   , AccPoolStake (..)
   , PoolStake (..)
   , RelayAccessPoint (..)
@@ -29,13 +29,13 @@ bigLedgerPeerQuota = 0.9
 -- and tag each one with cumulative stake, with a cutoff
 -- at 'bigLedgerPeerQuota'
 --
-accBigPoolStake :: [(PoolStake, NonEmpty RelayAccessPoint)]
-                -> [(AccPoolStake, (PoolStake, NonEmpty RelayAccessPoint))]
-accBigPoolStake =
+accumulateBigLedgerStake :: [(PoolStake, NonEmpty RelayAccessPoint)]
+                         -> [(AccPoolStake, (PoolStake, NonEmpty RelayAccessPoint))]
+accumulateBigLedgerStake =
     takeWhilePrev (\(acc, _) -> acc <= bigLedgerPeerQuota)
     . go 0
     . sortOn (Down . fst)
-    . reRelativeStake BigLedgerPeers
+    . recomputeRelativeStake BigLedgerPeers
   where
     takeWhilePrev :: (a -> Bool) -> [a] -> [a]
     takeWhilePrev f as =
@@ -55,10 +55,10 @@ accBigPoolStake =
 -- | Not all stake pools have valid \/ usable relay information. This means that
 -- we need to recalculate the relative stake for each pool.
 --
-reRelativeStake :: LedgerPeersKind
+recomputeRelativeStake :: LedgerPeersKind
                 -> [(PoolStake, NonEmpty RelayAccessPoint)]
                 -> [(PoolStake, NonEmpty RelayAccessPoint)]
-reRelativeStake ledgerPeersKind pl =
+recomputeRelativeStake ledgerPeersKind pl =
     let pl'   = first adjustment <$> pl
         total = List.foldl' (+) 0 (fst <$> pl')
         pl''  = first (/ total) <$> pl'

ouroboros-network/CHANGELOG.md

@@ -7,6 +7,12 @@
 * moved `accBigPoolStake` and `reRelativeStake` to ouroboros-networking-api
   in order to expose functionality of creating snapshots of big ledger peers,
   eg. for Genesis consensus mode.
+* Introduced `daReadLedgerPeerSnapshot` to `P2P.ArgumentsExtra` which holds
+  a `Maybe LedgerPeerSnapshot` from a node's configuration. If present, it
+  may be used to pick big ledger peers by the peer selection governor when
+  bootstrapping a node in Genesis consensus mode, or in general when 
+  LedgerStateJudgement = TooOld, subject to conditions in
+  `LedgerPeers.ledgerPeersThread`.
 
 ### Non-Breaking changes
 
@@ -15,6 +21,12 @@
 - Refactored Testnet suite according to changed Signal API.
 - Fixed block fetch client assertion failure
 * Make it build with ghc-9.10
+* Implemented provision of big ledger peers from the snapshot by `ledgerPeersThread`
+* Added property test checking if `ledgerPeersThread` is providing big ledger peers
+  from the snapshot when appropriate conditions are met
+* Added property tests checking if `LedgerPeerSnapshot` CBOR encoding is valid,
+  and decode/encode = id, as well as some property tests for calculating big ledger
+  peers
 
 ## 0.16.1.1 -- 2024-06-28
 

ouroboros-network/ouroboros-network.cabal

@@ -168,6 +168,7 @@ library sim-tests-lib
                        quickcheck-monoids,
                        aeson,
                        array,
+                       cardano-binary,
                        cborg,
                        containers,
                        deepseq,

ouroboros-network/sim-tests-lib/Test/Ouroboros/Network/Diffusion/Node.hs

@@ -390,16 +390,17 @@ run blockGeneratorArgs limits ni na tracersExtra tracerBlockFetch =
     mkArgsExtra :: StrictTVar m (Script UseBootstrapPeers)
                 -> Diff.P2P.ArgumentsExtra m
     mkArgsExtra ubpVar = Diff.P2P.ArgumentsExtra
-      { Diff.P2P.daPeerSelectionTargets  = aPeerSelectionTargets na
-      , Diff.P2P.daReadLocalRootPeers    = aReadLocalRootPeers na
-      , Diff.P2P.daReadPublicRootPeers   = aReadPublicRootPeers na
-      , Diff.P2P.daReadUseBootstrapPeers = stepScriptSTM' ubpVar
-      , Diff.P2P.daOwnPeerSharing        = aOwnPeerSharing na
-      , Diff.P2P.daReadUseLedgerPeers    = aReadUseLedgerPeers na
-      , Diff.P2P.daProtocolIdleTimeout   = aProtocolIdleTimeout na
-      , Diff.P2P.daTimeWaitTimeout       = aTimeWaitTimeout na
-      , Diff.P2P.daDeadlineChurnInterval = 3300
-      , Diff.P2P.daBulkChurnInterval     = 300
+      { Diff.P2P.daPeerSelectionTargets   = aPeerSelectionTargets na
+      , Diff.P2P.daReadLocalRootPeers     = aReadLocalRootPeers na
+      , Diff.P2P.daReadPublicRootPeers    = aReadPublicRootPeers na
+      , Diff.P2P.daReadUseBootstrapPeers  = stepScriptSTM' ubpVar
+      , Diff.P2P.daOwnPeerSharing         = aOwnPeerSharing na
+      , Diff.P2P.daReadUseLedgerPeers     = aReadUseLedgerPeers na
+      , Diff.P2P.daProtocolIdleTimeout    = aProtocolIdleTimeout na
+      , Diff.P2P.daTimeWaitTimeout        = aTimeWaitTimeout na
+      , Diff.P2P.daDeadlineChurnInterval  = 3300
+      , Diff.P2P.daBulkChurnInterval      = 300
+      , Diff.P2P.daReadLedgerPeerSnapshot = pure Nothing -- ^ tested independently
       }
 
     appArgs :: Node.AppArgs BlockHeader Block m