]> git.bitcoin.ninja Git - rust-lightning/blob - lightning/src/util/errors.rs
Underscore TxCreationKeys ownership
[rust-lightning] / lightning / src / util / errors.rs
1 // This file is Copyright its original authors, visible in version control
2 // history.
3 //
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
8 // licenses.
9
10 //! Error types live here.
11
12 use std::fmt;
13
14 /// Indicates an error on the client's part (usually some variant of attempting to use too-low or
15 /// too-high values)
16 pub enum APIError {
17         /// Indicates the API was wholly misused (see err for more). Cases where these can be returned
18         /// are documented, but generally indicates some precondition of a function was violated.
19         APIMisuseError {
20                 /// A human-readable error message
21                 err: String
22         },
23         /// Due to a high feerate, we were unable to complete the request.
24         /// For example, this may be returned if the feerate implies we cannot open a channel at the
25         /// requested value, but opening a larger channel would succeed.
26         FeeRateTooHigh {
27                 /// A human-readable error message
28                 err: String,
29                 /// The feerate which was too high.
30                 feerate: u32
31         },
32         /// A malformed Route was provided (eg overflowed value, node id mismatch, overly-looped route,
33         /// too-many-hops, etc).
34         RouteError {
35                 /// A human-readable error message
36                 err: &'static str
37         },
38         /// We were unable to complete the request as the Channel required to do so is unable to
39         /// complete the request (or was not found). This can take many forms, including disconnected
40         /// peer, channel at capacity, channel shutting down, etc.
41         ChannelUnavailable {
42                 /// A human-readable error message
43                 err: String
44         },
45         /// An attempt to call add/update_monitor returned an Err (ie you did this!), causing the
46         /// attempted action to fail.
47         MonitorUpdateFailed,
48 }
49
50 impl fmt::Debug for APIError {
51         fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
52                 match *self {
53                         APIError::APIMisuseError {ref err} => f.write_str(err),
54                         APIError::FeeRateTooHigh {ref err, ref feerate} => write!(f, "{} feerate: {}", err, feerate),
55                         APIError::RouteError {ref err} => f.write_str(err),
56                         APIError::ChannelUnavailable {ref err} => f.write_str(err),
57                         APIError::MonitorUpdateFailed => f.write_str("Client indicated a channel monitor update failed"),
58                 }
59         }
60 }
61
62 #[inline]
63 pub(crate) fn get_onion_debug_field(error_code: u16) -> (&'static str, usize) {
64         match error_code & 0xff {
65                 4|5|6 => ("sha256_of_onion", 32),
66                 11|12 => ("htlc_msat", 8),
67                 13|18 => ("cltv_expiry", 4),
68                 19 => ("incoming_htlc_msat", 8),
69                 20 => ("flags", 2),
70                 _ => ("", 0),
71         }
72 }
73
74 #[inline]
75 pub(crate) fn get_onion_error_description(error_code: u16) -> (&'static str, &'static str) {
76         const BADONION: u16 = 0x8000;
77         const PERM: u16 = 0x4000;
78         const NODE: u16 = 0x2000;
79         const UPDATE: u16 = 0x1000;
80         match error_code {
81                 _c if _c == PERM|1 => ("The realm byte was not understood by the processing node", "invalid_realm"),
82                 _c if _c == NODE|2 => ("Node indicated temporary node failure", "temporary_node_failure"),
83                 _c if _c == PERM|NODE|2 => ("Node indicated permanent node failure", "permanent_node_failure"),
84                 _c if _c == PERM|NODE|3 => ("Node indicated the required node feature is missing in the onion", "required_node_feature_missing"),
85                 _c if _c == BADONION|PERM|4 => ("Node indicated the version by is not understood", "invalid_onion_version"),
86                 _c if _c == BADONION|PERM|5  => ("Node indicated the HMAC of the onion is incorrect", "invalid_onion_hmac"),
87                 _c if _c == BADONION|PERM|6 => ("Node indicated the ephemeral public keys is not parseable", "invalid_onion_key"),
88                 _c if _c == UPDATE|7 => ("Node indicated the outgoing channel is unable to handle the HTLC temporarily", "temporary_channel_failure"),
89                 _c if _c == PERM|8 => ("Node indicated the outgoing channel is unable to handle the HTLC peramanently", "permanent_channel_failure"),
90                 _c if _c == PERM|9 => ("Node indicated the required feature for the outgoing channel is not satisfied", "required_channel_feature_missing"),
91                 _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"),
92                 _c if _c == UPDATE|11 => ("Node indicated the HTLC amount was below the required minmum for the outbound channel", "amount_below_minimum"),
93                 _c if _c == UPDATE|12 => ("Node indicated the fee amount does not meet the required level", "fee_insufficient"),
94                 _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"),
95                 _c if _c == UPDATE|14 => ("Node indicated the CLTV expiry too close to the current block height for safe handling", "expiry_too_soon"),
96                 _c if _c == PERM|15 => ("The final node indicated the payment hash is unknown or amount is incorrect", "incorrect_or_unknown_payment_details"),
97                 _c if _c == PERM|16 => ("The final node indicated the payment amount is incorrect", "incorrect_payment_amount"),
98                 _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"),
99                 _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"),
100                 _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"),
101                 _c if _c == UPDATE|20 => ("Node indicated the outbound channel has been disabled", "channel_disabled"),
102                 _c if _c == 21 => ("Node indicated the CLTV expiry in the HTLC is too far in the future", "expiry_too_far"),
103                 _ => ("Unknown", ""),
104         }
105 }