From c968780785c18bd6d0a8659c9e251ccf8fdc91dc Mon Sep 17 00:00:00 2001 From: r8921039 Date: Sun, 24 Mar 2019 14:54:40 -0700 Subject: [PATCH] [docs] fix comment: the return value of findFork is _not_ an ancestor when the specified block is on the active chain update with suggested comment text from the reviewers --- src/interfaces/chain.h | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/src/interfaces/chain.h b/src/interfaces/chain.h index a9b05f27f..ae546c415 100644 --- a/src/interfaces/chain.h +++ b/src/interfaces/chain.h @@ -120,8 +120,9 @@ public: //! nullopt if no block in the range is pruned. Range is inclusive. virtual Optional findPruned(int start_height = 0, Optional stop_height = nullopt) = 0; - //! Return height of the highest block on the chain that is an ancestor - //! of the specified block, or nullopt if no common ancestor is found. + //! Return height of the specified block if it is on the chain, otherwise + //! return the height of the highest block on chain that's an ancestor + //! of the specified block, or nullopt if there is no common ancestor. //! Also return the height of the specified block as an optional output //! parameter (to avoid the cost of a second hash lookup in case this //! information is desired). @@ -135,9 +136,9 @@ public: //! Get locator for the current chain tip. virtual CBlockLocator getTipLocator() = 0; - //! Return height of the latest block common to locator and chain, which - //! is guaranteed to be an ancestor of the block used to create the - //! locator. + //! Return height of the highest block on chain in common with the locator, + //! which will either be the original block used to create the locator, + //! or one of its ancestors. virtual Optional findLocatorFork(const CBlockLocator& locator) = 0; //! Check if transaction will be final given chain height current time.