prune: clarify how ancestor nodes are pruned

ChainSafe · Jan 23, 2023 · 0ece6da · 0ece6da
1 parent 84aead7
commit 0ece6da
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/lib/blocktree/node.go b/lib/blocktree/node.go
@@ -175,6 +175,8 @@ func (n *node) prune(finalised *node, forkOriginToChain map[Hash][]Hash,
 	if finalised.isDescendantOf(n) {
 		// The node is an ancestor of the finalised node.
 		// ... -> N -> ... -> FINALISED -> ...
+		// Ancestor nodes are all replaced when the root node is replaced
+		// by the finalised node in the `Prune` method.
 		// Check its children which may not be on the canonical chain
 		// between the node and the finalised node.
 		for _, child := range n.children {