Skip to content

Commit 11b228b

Browse files
committed
Correct ChannelUnavailable error docs on send_payment_with_route
Monitor update failure can no longer lead to a `ChannelUnavailable` error, but more common cases such as the peer being disconnected always could, so those should be documented clearer.
1 parent 4abc939 commit 11b228b

File tree

1 file changed

+2
-3
lines changed

1 file changed

+2
-3
lines changed

lightning/src/ln/channelmanager.rs

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3388,9 +3388,8 @@ where
33883388
/// In general, a path may raise:
33893389
/// * [`APIError::InvalidRoute`] when an invalid route or forwarding parameter (cltv_delta, fee,
33903390
/// node public key) is specified.
3391-
/// * [`APIError::ChannelUnavailable`] if the next-hop channel is not available for updates
3392-
/// (including due to previous monitor update failure or new permanent monitor update
3393-
/// failure).
3391+
/// * [`APIError::ChannelUnavailable`] if the next-hop channel is not available as it has been
3392+
/// closed, doesn't exist, or the peer is currently disconnected.
33943393
/// * [`APIError::MonitorUpdateInProgress`] if a new monitor update failure prevented sending the
33953394
/// relevant updates.
33963395
///

0 commit comments

Comments
 (0)