Skip to content

Commit c23d90c

Browse files
committed
f - Fix ChainMonitor::update_best_block docs
1 parent 21f0a80 commit c23d90c

File tree

1 file changed

+5
-3
lines changed

1 file changed

+5
-3
lines changed

lightning/src/chain/chainmonitor.rs

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -116,12 +116,14 @@ 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, this must be called at
120-
/// least at the fork point and then again for the most recent block; intermediary blocks may be
121-
/// skipped as before.
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.
122123
///
123124
/// [`block_connected`]: Self::block_connected
124125
/// [`transactions_confirmed`]: Self::transactions_confirmed
126+
/// [`transaction_unconfirmed`]: Self::transaction_unconfirmed
125127
pub fn update_best_block(&self, header: &BlockHeader, height: u32) {
126128
self.process_transactions(header, &[], |monitor, txdata| {
127129
// Recursive calls can supply txdata when chain::Filter::register_output returns a

0 commit comments

Comments
 (0)