Document ConnectBlock connectTrace postconditions

TheBlueMatt · furszy · commit 0e59badd9558 · 2020-10-16T12:39:52.000-03:00
diff --git a/src/validation.cpp b/src/validation.cpp
@@ -1934,6 +1934,10 @@ struct ConnectTrace {
 /**
  * Connect a new block to chainActive. pblock is either NULL or a pointer to a CBlock
  * corresponding to pindexNew, to bypass loading it again from disk.
+ *
+ * The block is always added to connectTrace (either after loading from disk or by copying
+ * pblock) - if that is not intended, care must be taken to remove the last entry in
+ * blocksConnected in case of failure.
  */
 bool static ConnectTip(CValidationState& state, CBlockIndex* pindexNew, const std::shared_ptr<const CBlock>& pblock, bool fAlreadyChecked, ConnectTrace& connectTrace)
 {
