From: Matt Corallo <git@bluematt.me>
Date: Wed, 28 Aug 2024 13:50:17 +0000 (+0000)
Subject: Add additional documentation on `Channel::unbroadcasted_funding`
X-Git-Tag: v0.0.124-rc1~4^2~2
X-Git-Url: http://git.bitcoin.ninja/index.cgi?a=commitdiff_plain;h=6a81d5d4bb894e130f753dda9a04f8016c71b8a9;p=rust-lightning

Add additional documentation on `Channel::unbroadcasted_funding`
---

diff --git a/lightning/src/ln/channel.rs b/lightning/src/ln/channel.rs
index 576ae665a..fe01a2629 100644
--- a/lightning/src/ln/channel.rs
+++ b/lightning/src/ln/channel.rs
@@ -3457,6 +3457,9 @@ impl<SP: Deref> ChannelContext<SP> where SP::Target: SignerProvider  {
 
 	/// Returns the transaction if there is a pending funding transaction that is yet to be
 	/// broadcast.
+	///
+	/// Note that if [`Self::is_manual_broadcast`] is true the transaction will be a dummy
+	/// transaction.
 	pub fn unbroadcasted_funding(&self) -> Option<Transaction> {
 		self.if_unbroadcasted_funding(|| self.funding_transaction.clone())
 	}