Skip to content

Commit d81b28f

Browse files
committed
f improve external docs on ClaimableBalance
1 parent bb56a38 commit d81b28f

File tree

1 file changed

+6
-3
lines changed

1 file changed

+6
-3
lines changed

lightning/src/chain/channelmonitor.rs

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -527,12 +527,15 @@ impl_writeable_tlv_based_enum_upgradable!(ChannelMonitorUpdateStep,
527527
},
528528
);
529529

530-
/// Details about the balance available for claim once the channel appears on chain.
530+
/// Details about the balance(s) available for spending once the channel appears on chain.
531+
///
532+
/// See [`ChannelMonitor::get_claimable_balances`] for more details on when these will or will not
533+
/// be provided.
531534
#[derive(Clone, Debug, PartialEq, Eq)]
532535
#[cfg_attr(test, derive(PartialOrd, Ord))]
533536
pub enum ClaimableBalance {
534-
/// The channel is not yet closed (or the initial commitment or closing transaction has not yet
535-
/// been confirmed). The given balance is claimable (less on-chain fees) if the channel is
537+
/// The channel is not yet closed (or the commitment or closing transaction has not yet
538+
/// appeared in a block). The given balance is claimable (less on-chain fees) if the channel is
536539
/// force-closed now.
537540
ClaimableOnChannelClose {
538541
/// The amount available to claim, in satoshis, ignoring the on-chain fees which will be

0 commit comments

Comments
 (0)