Skip to content

Commit f3d1f0b

Browse files
committed
f - Rework comment
1 parent 67a9c0d commit f3d1f0b

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

lightning/src/ln/channelmanager.rs

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3358,18 +3358,18 @@ impl<Signer: Sign, M: Deref, T: Deref, K: Deref, F: Deref, L: Deref> ChannelMana
33583358
/// Provides a payment preimage in response to [`Event::PaymentReceived`], generating any
33593359
/// [`MessageSendEvent`]s needed to claim the payment.
33603360
///
3361-
/// Returns whether any HTLCs were claimed. If true, you must have the network layer process any
3362-
/// [`MessageSendEvent`]s returned by [`get_and_clear_pending_msg_events`].
3363-
///
33643361
/// Note that if you did not set an `amount_msat` when calling [`create_inbound_payment`] or
33653362
/// [`create_inbound_payment_for_hash`] you must check that the amount in the `PaymentReceived`
33663363
/// event matches your expectation. If you fail to do so and call this method, you may provide
33673364
/// the sender "proof-of-payment" when they did not fulfill the full expected payment.
33683365
///
3366+
/// Returns whether any HTLCs were claimed, and thus if any new [`MessageSendEvent`]s are now
3367+
/// pending for processing via [`get_and_clear_pending_msg_events`].
3368+
///
33693369
/// [`Event::PaymentReceived`]: crate::util::events::Event::PaymentReceived
3370-
/// [`get_and_clear_pending_msg_events`]: MessageSendEventsProvider::get_and_clear_pending_msg_events
33713370
/// [`create_inbound_payment`]: Self::create_inbound_payment
33723371
/// [`create_inbound_payment_for_hash`]: Self::create_inbound_payment_for_hash
3372+
/// [`get_and_clear_pending_msg_events`]: MessageSendEventsProvider::get_and_clear_pending_msg_events
33733373
pub fn claim_funds(&self, payment_preimage: PaymentPreimage) -> bool {
33743374
let payment_hash = PaymentHash(Sha256::hash(&payment_preimage.0).into_inner());
33753375

0 commit comments

Comments
 (0)