Skip to content

Commit bc0203d

Browse files
committed
Expand docs on failing expired outbound payments
1 parent 62fd36d commit bc0203d

File tree

1 file changed

+10
-6
lines changed

1 file changed

+10
-6
lines changed

lightning/src/ln/channelmanager.rs

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4822,8 +4822,8 @@ where
48224822
/// * Force-closing and removing channels which have not completed establishment in a timely manner.
48234823
/// * Forgetting about stale outbound payments, either those that have already been fulfilled
48244824
/// or those awaiting an invoice that hasn't been delivered in the necessary amount of time.
4825-
/// The latter is determined using the system clock in `std` and the block time minus two
4826-
/// hours in `no-std`.
4825+
/// The latter is determined using the system clock in `std` and the highest seen block time
4826+
/// minus two hours in `no-std`.
48274827
///
48284828
/// Note that this may cause reentrancy through [`chain::Watch::update_channel`] calls or feerate
48294829
/// estimate fetches.
@@ -7308,11 +7308,15 @@ where
73087308
}
73097309

73107310
/// Creates a [`RefundBuilder`] such that the [`Refund`] it builds is recognized by the
7311-
/// [`ChannelManager`] when handling [`Bolt12Invoice`] messages for the refund. The builder will
7312-
/// have the provided expiration set. Any changes to the expiration on the returned builder will
7313-
/// not be honored by [`ChannelManager`].
7311+
/// [`ChannelManager`] when handling [`Bolt12Invoice`] messages for the refund.
73147312
///
7315-
/// The provided `payment_id` is used to ensure that only one invoice is paid for the refund.
7313+
/// The builder will have the provided expiration set. Any changes to the expiration on the
7314+
/// returned builder will not be honored by [`ChannelManager`]. For `no-std`, the highest seen
7315+
/// block time minus two hours is used for the current time when determining if the refund has
7316+
/// expired.
7317+
///
7318+
/// The provided `payment_id` is used to ensure that only one invoice is paid for the refund. To
7319+
/// revoke the refund, use [`ChannelManager::abandon_payment`] prior to receiving the invoice.
73167320
///
73177321
/// Uses a one-hop [`BlindedPath`] for the refund with [`ChannelManager::get_our_node_id`] as
73187322
/// the introduction node and a derived payer id for sender privacy. As such, currently, the

0 commit comments

Comments
 (0)