Skip to content

Commit 84a220d

Browse files
committed
Note that balance entries remain as long as a splice has < 6 confs
This may be somewhat surprising, so it seems worth noting.
1 parent 3292ef1 commit 84a220d

File tree

1 file changed

+5
-0
lines changed

1 file changed

+5
-0
lines changed

lightning/src/chain/channelmonitor.rs

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -835,6 +835,11 @@ pub enum Balance {
835835
/// When multiple candidates exist, the last one reflects the balance of the
836836
/// latest splice/RBF attempt, while the first reflects the balance prior to the splice
837837
/// occurring.
838+
///
839+
/// Entries remain in this vec until the pending splice has reached [`ANTI_REORG_DELAY`]
840+
/// confirmations, at which point any conflicts will be removed. Once a splice confirms
841+
/// [`Self::ClaimableOnChannelClose::confirmed_balance_candidate_index`] will point to the
842+
/// confirmed entry, even if it has fewer than [`ANTI_REORG_DELAY`] confirmations.
838843
balance_candidates: Vec<HolderCommitmentTransactionBalance>,
839844
/// The index within [`Balance::ClaimableOnChannelClose::balance_candidates`] for the
840845
/// balance according to the current onchain state of the channel. This can be helpful when

0 commit comments

Comments
 (0)