Merge pull request #386 from TheBlueMatt/2019-10-useless-lints

[rust-lightning] / src / util / errors.rs

diff --git a/src/util/errors.rs b/src/util/errors.rs
index 66ddf84d96871857ed027cc5c3c74f3bfb749dfb..27f837775ef19ad4c605a6e3b0659d158ed47164 100644 (file)
--- a/src/util/errors.rs
+++ b/src/util/errors.rs
@@ -49,3 +49,48 @@ impl fmt::Debug for APIError {
                }
        }
 }
+
+#[inline]
+pub(crate) fn get_onion_debug_field(error_code: u16) -> (&'static str, usize) {
+       match error_code & 0xff {
+               4|5|6 => ("sha256_of_onion", 32),
+               11|12 => ("htlc_msat", 8),
+               13|18 => ("cltv_expiry", 4),
+               19 => ("incoming_htlc_msat", 8),
+               20 => ("flags", 2),
+               _ => ("", 0),
+       }
+}
+
+#[inline]
+pub(crate) fn get_onion_error_description(error_code: u16) -> (&'static str, &'static str) {
+       const BADONION: u16 = 0x8000;
+       const PERM: u16 = 0x4000;
+       const NODE: u16 = 0x2000;
+       const UPDATE: u16 = 0x1000;
+       match error_code {
+               _c if _c == PERM|1 => ("The realm byte was not understood by the processing node", "invalid_realm"),
+               _c if _c == NODE|2 => ("Node indicated temporary node failure", "temporary_node_failure"),
+               _c if _c == PERM|NODE|2 => ("Node indicated permanent node failure", "permanent_node_failure"),
+               _c if _c == PERM|NODE|3 => ("Node indicated the required node feature is missing in the onion", "required_node_feature_missing"),
+               _c if _c == BADONION|PERM|4 => ("Node indicated the version by is not understood", "invalid_onion_version"),
+               _c if _c == BADONION|PERM|5  => ("Node indicated the HMAC of the onion is incorrect", "invalid_onion_hmac"),
+               _c if _c == BADONION|PERM|6 => ("Node indicated the ephemeral public keys is not parseable", "invalid_onion_key"),
+               _c if _c == UPDATE|7 => ("Node indicated the outgoing channel is unable to handle the HTLC temporarily", "temporary_channel_failure"),
+               _c if _c == PERM|8 => ("Node indicated the outgoing channel is unable to handle the HTLC peramanently", "permanent_channel_failure"),
+               _c if _c == PERM|9 => ("Node indicated the required feature for the outgoing channel is not satisfied", "required_channel_feature_missing"),
+               _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"),
+               _c if _c == UPDATE|11 => ("Node indicated the HTLC amount was below the required minmum for the outbound channel", "amount_below_minimum"),
+               _c if _c == UPDATE|12 => ("Node indicated the fee amount does not meet the required level", "fee_insufficient"),
+               _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"),
+               _c if _c == UPDATE|14 => ("Node indicated the CLTV expiry too close to the current block height for safe handling", "expiry_too_soon"),
+               _c if _c == PERM|15 => ("The final node indicated the payment hash is unknown or amount is incorrect", "incorrect_or_unknown_payment_details"),
+               _c if _c == PERM|16 => ("The final node indicated the payment amount is incorrect", "incorrect_payment_amount"),
+               _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"),
+               _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"),
+               _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"),
+               _c if _c == UPDATE|20 => ("Node indicated the outbound channel has been disabled", "channel_disabled"),
+               _c if _c == 21 => ("Node indicated the CLTV expiry in the HTLC is too far in the future", "expiry_too_far"),
+               _ => ("Unknown", ""),
+       }
+}