Skip to content

Commit a9ae5f3

Browse files
committed
f improve external docs on ClaimableBalance
1 parent 9f5dbea commit a9ae5f3

File tree

1 file changed

+6
-3
lines changed

1 file changed

+6
-3
lines changed

lightning/src/chain/channelmonitor.rs

+6-3
Original file line numberDiff line numberDiff line change
@@ -525,12 +525,15 @@ impl_writeable_tlv_based_enum_upgradable!(ChannelMonitorUpdateStep,
525525
},
526526
);
527527

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

0 commit comments

Comments
 (0)