Skip to content

Commit 6a81d5d

Browse files
committed
Add additional documentation on Channel::unbroadcasted_funding
1 parent 3b70bd2 commit 6a81d5d

File tree

1 file changed

+3
-0
lines changed

1 file changed

+3
-0
lines changed

lightning/src/ln/channel.rs

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3457,6 +3457,9 @@ impl<SP: Deref> ChannelContext<SP> where SP::Target: SignerProvider {
34573457

34583458
/// Returns the transaction if there is a pending funding transaction that is yet to be
34593459
/// broadcast.
3460+
///
3461+
/// Note that if [`Self::is_manual_broadcast`] is true the transaction will be a dummy
3462+
/// transaction.
34603463
pub fn unbroadcasted_funding(&self) -> Option<Transaction> {
34613464
self.if_unbroadcasted_funding(|| self.funding_transaction.clone())
34623465
}

0 commit comments

Comments
 (0)