Skip to content

Commit b03fca0

Browse files
committed
f - Fix ChannelMonitor::update_best_block docs
1 parent 6f79ee0 commit b03fca0

File tree

1 file changed

+6
-4
lines changed

1 file changed

+6
-4
lines changed

lightning/src/chain/channelmonitor.rs

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1337,7 +1337,7 @@ impl<Signer: Sign> ChannelMonitor<Signer> {
13371337
///
13381338
/// Used instead of [`block_disconnected`] by clients that are notified of transactions rather
13391339
/// than blocks. May be called before or after [`update_best_block`] for transactions in the
1340-
/// corresponding block. See [`update_best_block`] for further calling expectations.
1340+
/// corresponding block. See [`update_best_block`] for further calling expectations.
13411341
///
13421342
/// [`block_disconnected`]: Self::block_disconnected
13431343
/// [`update_best_block`]: Self::update_best_block
@@ -1364,12 +1364,14 @@ impl<Signer: Sign> ChannelMonitor<Signer> {
13641364
/// block.
13651365
///
13661366
/// Must be called after new blocks become available for the most recent block. Intermediary
1367-
/// blocks, however, may be safely skipped. For a chain reorganization, this must be called at
1368-
/// least at the fork point and then again for the most recent block; intermediary blocks may be
1369-
/// skipped as before.
1367+
/// blocks, however, may be safely skipped. For a chain reorganization, must either be:
1368+
/// * called at at the fork point and then again for the most recent block -- intermediary
1369+
/// blocks may be skipped as before -- or
1370+
/// * not called in favor of calling [`transaction_unconfirmed`] for any affected transactions.
13701371
///
13711372
/// [`block_connected`]: Self::block_connected
13721373
/// [`transactions_confirmed`]: Self::transactions_confirmed
1374+
/// [`transaction_unconfirmed`]: Self::transaction_unconfirmed
13731375
pub fn update_best_block<B: Deref, F: Deref, L: Deref>(
13741376
&self,
13751377
header: &BlockHeader,

0 commit comments

Comments
 (0)