Fix TODOs or add link to issue

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

Author: 6 people

ouroboros-consensus/src/ouroboros-consensus/Ouroboros/Consensus/Storage/ChainDB/API.hs

@@ -393,11 +393,11 @@ data ChainDB m blk = ChainDB
   -- ^ Get statistics from the LedgerDB, in particular the number of entries
   -- in the tables.
   , addPerasCertAsync :: ValidatedPerasCert blk -> m (AddPerasCertPromise m)
-  -- ^ TODO docs
+  -- ^ Asynchronously insert a certificate to the DB.
   , getPerasWeightSnapshot :: STM m (WithFingerprint (PerasWeightSnapshot blk))
-  -- ^ TODO
+  -- ^ Get the weight snapshot from the DB.
   , getPerasCertSnapshot :: STM m (PerasCertSnapshot blk)
-  -- ^ TODO
+  -- ^ Get the certificate snapshot from the DB.
   , closeDB :: m ()
   -- ^ Close the ChainDB
   --

ouroboros-consensus/test/storage-test/Test/Ouroboros/Storage/ChainDB/Model.hs

@@ -1086,6 +1086,7 @@ garbageCollect secParam m@Model{..} =
   m
     { volatileDbBlocks = Map.filter (not . collectable) volatileDbBlocks
     -- TODO garbage collection Peras certs?
+    -- See https://github.com/tweag/cardano-peras/issues/121
     }
  where
   -- TODO what about iterators that will stream garbage collected blocks?
@@ -1125,6 +1126,8 @@ closeDB m@Model{..} =
 reopen :: Model blk -> Model blk
 reopen m = m{isOpen = True}
 
+-- TODO: update to account for persisted Peras certificates.
+-- see https://github.com/tweag/cardano-peras/issues/122
 wipeVolatileDB ::
   forall blk.
   (LedgerSupportsProtocol blk, LedgerTablesAreTrivial (ExtLedgerState blk)) =>
@@ -1137,14 +1140,7 @@ wipeVolatileDB cfg m =
   m' =
     (closeDB m)
       { volatileDbBlocks = Map.empty
-      , -- TODO: Currently, the SUT has no persistence of Peras certs across
-        -- restarts, but this will change. There are at least two options:
-        --
-        --  * Change this command to mean "wipe volatile state" (including
-        --    volatile certificates)
-        --
-        --  * Add a separate "Wipe volatile certs".
-        perasCerts = Map.empty
+      , perasCerts = Map.empty
       , cps = CPS.switchFork newChain (cps m)
       , currentLedger = newLedger
       , invalid = Map.empty

ouroboros-consensus/test/storage-test/Test/Ouroboros/Storage/ChainDB/Model/Test.hs

@@ -107,6 +107,7 @@ prop_alwaysPickPreferredChain bt p =
     candFragment = Chain.toAnchoredFragment (getHeader <$> candidate)
 
     -- TODO test with non-trivial weights
+    -- see https://github.com/tweag/cardano-peras/issues/123
     weights :: PerasWeightSnapshot TestBlock
     weights = emptyPerasWeightSnapshot
 

ouroboros-consensus/test/storage-test/Test/Ouroboros/Storage/ChainDB/StateMachine.hs

@@ -1045,7 +1045,8 @@ generator loe genBlock m@Model{..} =
 
   genAddPerasCert :: Gen (ValidatedPerasCert blk)
   genAddPerasCert = do
-    -- TODO chain condition?
+    -- TODO should we be more strict on which blocks we add certs to?
+    -- see https://github.com/tweag/cardano-peras/issues/124
     blk <- genBlock m
     let roundNo = case Model.maxPerasRoundNo dbModel of
           Nothing -> PerasRoundNo 0