1 // This file is Copyright its original authors, visible in version control
4 // This file is licensed under the Apache License, Version 2.0 <LICENSE-APACHE
5 // or http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
6 // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your option.
7 // You may not use this file except in accordance with one or both of these
10 //! Error types live here.
12 use ln::script::ShutdownScript;
14 use alloc::string::String;
17 /// Indicates an error on the client's part (usually some variant of attempting to use too-low or
21 /// Indicates the API was wholly misused (see err for more). Cases where these can be returned
22 /// are documented, but generally indicates some precondition of a function was violated.
24 /// A human-readable error message
27 /// Due to a high feerate, we were unable to complete the request.
28 /// For example, this may be returned if the feerate implies we cannot open a channel at the
29 /// requested value, but opening a larger channel would succeed.
31 /// A human-readable error message
33 /// The feerate which was too high.
36 /// A malformed Route was provided (eg overflowed value, node id mismatch, overly-looped route,
37 /// too-many-hops, etc).
39 /// A human-readable error message
42 /// We were unable to complete the request as the Channel required to do so is unable to
43 /// complete the request (or was not found). This can take many forms, including disconnected
44 /// peer, channel at capacity, channel shutting down, etc.
46 /// A human-readable error message
49 /// An attempt to call watch/update_channel returned an Err (ie you did this!), causing the
50 /// attempted action to fail.
52 /// [`KeysInterface::get_shutdown_scriptpubkey`] returned a shutdown scriptpubkey incompatible
53 /// with the channel counterparty as negotiated in [`InitFeatures`].
55 /// Using a SegWit v0 script should resolve this issue. If you cannot, you won't be able to open
56 /// a channel or cooperatively close one with this peer (and will have to force-close instead).
58 /// [`KeysInterface::get_shutdown_scriptpubkey`]: crate::chain::keysinterface::KeysInterface::get_shutdown_scriptpubkey
59 /// [`InitFeatures`]: crate::ln::features::InitFeatures
60 IncompatibleShutdownScript {
61 /// The incompatible shutdown script.
62 script: ShutdownScript,
66 impl fmt::Debug for APIError {
67 fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
69 APIError::APIMisuseError {ref err} => f.write_str(err),
70 APIError::FeeRateTooHigh {ref err, ref feerate} => write!(f, "{} feerate: {}", err, feerate),
71 APIError::RouteError {ref err} => f.write_str(err),
72 APIError::ChannelUnavailable {ref err} => f.write_str(err),
73 APIError::MonitorUpdateFailed => f.write_str("Client indicated a channel monitor update failed"),
74 APIError::IncompatibleShutdownScript { ref script } => {
75 write!(f, "Provided a scriptpubkey format not accepted by peer: {}", script)
82 pub(crate) fn get_onion_debug_field(error_code: u16) -> (&'static str, usize) {
83 match error_code & 0xff {
84 4|5|6 => ("sha256_of_onion", 32),
85 11|12 => ("htlc_msat", 8),
86 13|18 => ("cltv_expiry", 4),
87 19 => ("incoming_htlc_msat", 8),
94 pub(crate) fn get_onion_error_description(error_code: u16) -> (&'static str, &'static str) {
95 const BADONION: u16 = 0x8000;
96 const PERM: u16 = 0x4000;
97 const NODE: u16 = 0x2000;
98 const UPDATE: u16 = 0x1000;
100 _c if _c == PERM|1 => ("The realm byte was not understood by the processing node", "invalid_realm"),
101 _c if _c == NODE|2 => ("Node indicated temporary node failure", "temporary_node_failure"),
102 _c if _c == PERM|NODE|2 => ("Node indicated permanent node failure", "permanent_node_failure"),
103 _c if _c == PERM|NODE|3 => ("Node indicated the required node feature is missing in the onion", "required_node_feature_missing"),
104 _c if _c == BADONION|PERM|4 => ("Node indicated the version by is not understood", "invalid_onion_version"),
105 _c if _c == BADONION|PERM|5 => ("Node indicated the HMAC of the onion is incorrect", "invalid_onion_hmac"),
106 _c if _c == BADONION|PERM|6 => ("Node indicated the ephemeral public keys is not parseable", "invalid_onion_key"),
107 _c if _c == UPDATE|7 => ("Node indicated the outgoing channel is unable to handle the HTLC temporarily", "temporary_channel_failure"),
108 _c if _c == PERM|8 => ("Node indicated the outgoing channel is unable to handle the HTLC peramanently", "permanent_channel_failure"),
109 _c if _c == PERM|9 => ("Node indicated the required feature for the outgoing channel is not satisfied", "required_channel_feature_missing"),
110 _c if _c == PERM|10 => ("Node indicated the outbound channel is not found for the specified short_channel_id in the onion packet", "unknown_next_peer"),
111 _c if _c == UPDATE|11 => ("Node indicated the HTLC amount was below the required minmum for the outbound channel", "amount_below_minimum"),
112 _c if _c == UPDATE|12 => ("Node indicated the fee amount does not meet the required level", "fee_insufficient"),
113 _c if _c == UPDATE|13 => ("Node indicated the cltv_expiry does not comply with the cltv_expiry_delta required by the outgoing channel", "incorrect_cltv_expiry"),
114 _c if _c == UPDATE|14 => ("Node indicated the CLTV expiry too close to the current block height for safe handling", "expiry_too_soon"),
115 _c if _c == PERM|15 => ("The final node indicated the payment hash is unknown or amount is incorrect", "incorrect_or_unknown_payment_details"),
116 _c if _c == PERM|16 => ("The final node indicated the payment amount is incorrect", "incorrect_payment_amount"),
117 _c if _c == 17 => ("The final node indicated the CLTV expiry is too close to the current block height for safe handling", "final_expiry_too_soon"),
118 _c if _c == 18 => ("The final node indicated the CLTV expiry in the HTLC does not match the value in the onion", "final_incorrect_cltv_expiry"),
119 _c if _c == 19 => ("The final node indicated the amount in the HTLC does not match the value in the onion", "final_incorrect_htlc_amount"),
120 _c if _c == UPDATE|20 => ("Node indicated the outbound channel has been disabled", "channel_disabled"),
121 _c if _c == 21 => ("Node indicated the CLTV expiry in the HTLC is too far in the future", "expiry_too_far"),
122 _ => ("Unknown", ""),