Skip to content

Commit b043972

Browse files
f: clarify docs for funding_transaction_generated_manual_broadcast
1 parent 89f6d59 commit b043972

File tree

1 file changed

+10
-1
lines changed

1 file changed

+10
-1
lines changed

lightning/src/ln/channelmanager.rs

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5775,7 +5775,16 @@ where
57755775
self.batch_funding_transaction_generated_intern(temporary_chans, funding_type)
57765776
}
57775777

5778-
/// Same as batch_funding_transaction_generated but it does not automatically broadcast the funding transaction
5778+
/// Call this upon creation of a funding transaction for the given channel.
5779+
///
5780+
/// This method executes the same checks as [`ChannelManager::funding_transaction_generated`],
5781+
/// but it does not automatically broadcast the funding transaction.
5782+
///
5783+
/// Call this in response to a [`Event::FundingGenerationReady`] event, only in a context where you want to manually
5784+
/// control the broadcast of the funding transaction.
5785+
///
5786+
/// [`ChannelManager::funding_transaction_generated`]: crate::ln::channelmanager::ChannelManager::funding_transaction_generated
5787+
/// [`Event::FundingGenerationReady`]: crate::events::Event::FundingGenerationReady
57795788
pub fn funding_transaction_generated_manual_broadcast(
57805789
&self, temporary_channel_id: ChannelId, counterparty_node_id: PublicKey,
57815790
funding_transaction: Transaction,

0 commit comments

Comments
 (0)