doc: add explanations for assert in index and magic numbers in test

These were suggested in review of bitcoin#23365 Co-authored-by: John Newbery <john@johnnewbery.com>
syscoin · Dec 15, 2021 · e4a8d56 · e4a8d56
1 parent aaaceb7
commit e4a8d56
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 0 deletions.
diff --git a/src/index/base.cpp b/src/index/base.cpp
@@ -96,6 +96,8 @@ bool BaseIndex::Init()
                     prune_violation = false;
                     break;
                 }
+                // block->pprev must exist at this point, since block_to_test is part of the chain
+                // and thus must be encountered when going backwards from the tip
                 assert(block->pprev);
                 block = block->pprev;
             }

diff --git a/test/functional/feature_blockfilterindex_prune.py b/test/functional/feature_blockfilterindex_prune.py
@@ -29,6 +29,8 @@ def run_test(self):
 
         self.log.info("prune some blocks")
         pruneheight = self.nodes[0].pruneblockchain(400)
+        # the prune heights used here and below are magic numbers that are determined by the
+        # thresholds at which block files wrap, so they depend on disk serialization and default block file size.
         assert_equal(pruneheight, 248)
 
         self.log.info("check if we can access the tips blockfilter when we have pruned some blocks")