Skip to content

Commit ae84540

Browse files
committed
f - Rephrase update_best_block docs
1 parent 963c281 commit ae84540

File tree

1 file changed

+4
-5
lines changed

1 file changed

+4
-5
lines changed

lightning/src/chain/chainmonitor.rs

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -96,7 +96,7 @@ where C::Target: chain::Filter,
9696
///
9797
/// Used instead of [`block_connected`] by clients that are notified of transactions rather than
9898
/// blocks. May be called before or after [`update_best_block`] for transactions in the
99-
/// corresponding block. See [`update_best_block`] for further calling expectations.
99+
/// corresponding block. See [`update_best_block`] for further calling expectations.
100100
///
101101
/// [`block_connected`]: Self::block_connected
102102
/// [`update_best_block`]: Self::update_best_block
@@ -116,10 +116,9 @@ where C::Target: chain::Filter,
116116
/// block.
117117
///
118118
/// Must be called after new blocks become available for the most recent block. Intermediary
119-
/// blocks, however, may be safely skipped. For a chain reorganization, must either be:
120-
/// * called at at the fork point and then again for the most recent block -- intermediary
121-
/// blocks may be skipped as before -- or
122-
/// * not called in favor of calling [`transaction_unconfirmed`] for any affected transactions.
119+
/// blocks, however, may be safely skipped. In the event of a chain re-organization, this only
120+
/// needs to be called for the most recent block assuming `transaction_unconfirmed` is called
121+
/// for any affected transactions.
123122
///
124123
/// [`block_connected`]: Self::block_connected
125124
/// [`transactions_confirmed`]: Self::transactions_confirmed

0 commit comments

Comments
 (0)