From: Matt Corallo Date: Thu, 21 Sep 2023 20:19:08 +0000 (+0000) Subject: Correct ChannelUnavailable error docs on `send_payment_with_route` X-Git-Tag: v0.0.117-rc1~11^2~3 X-Git-Url: http://git.bitcoin.ninja/index.cgi?a=commitdiff_plain;ds=sidebyside;h=11b228b7b0d0f4f8cf0ca4829f89a9b281359606;p=rust-lightning 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. --- diff --git a/lightning/src/ln/channelmanager.rs b/lightning/src/ln/channelmanager.rs index e2641d2cf..23b45077a 100644 --- a/lightning/src/ln/channelmanager.rs +++ b/lightning/src/ln/channelmanager.rs @@ -3388,9 +3388,8 @@ where /// In general, a path may raise: /// * [`APIError::InvalidRoute`] when an invalid route or forwarding parameter (cltv_delta, fee, /// node public key) is specified. - /// * [`APIError::ChannelUnavailable`] if the next-hop channel is not available for updates - /// (including due to previous monitor update failure or new permanent monitor update - /// failure). + /// * [`APIError::ChannelUnavailable`] if the next-hop channel is not available as it has been + /// closed, doesn't exist, or the peer is currently disconnected. /// * [`APIError::MonitorUpdateInProgress`] if a new monitor update failure prevented sending the /// relevant updates. ///