[CBR-482] Document CBR-504 issue

input-output-hk · Feb 14, 2019 · 68d841d · 68d841d
1 parent 29d19ba
commit 68d841d
Showing 1 changed file with 7 additions and 0 deletions.
diff --git a/chain/test/Test/Pos/Chain/Block/Arbitrary.hs b/chain/test/Test/Pos/Chain/Block/Arbitrary.hs
@@ -473,6 +473,13 @@ genHeaderAndParams pm era = do
                 OBFT ObftStrict  -> ObftStrictLeaders <$> thisEpochLeaderSchedule
                 OBFT ObftLenient -> do
                     ls <- thisEpochLeaderSchedule
+                    -- FIXME IN CBR-504:
+                    -- Decided to hardcode some values here since this
+                    -- generator is critically broken and always returns a
+                    -- `Nothing` for `vhpLeaders`. Therefore, when
+                    -- `Pos.Chain.Block.Logic.Integrity.verifyHeader` is
+                    -- provided with this `VerifyHeaderParams` instance, slot
+                    -- leader schedule verification isn't even performed.
                     pure $ ObftLenientLeaders (Set.fromList (toList ls))
                                               (Core.BlockCount 5)
                                               (OldestFirst [])