X-Git-Url: http://git.bitcoin.ninja/index.cgi?a=blobdiff_plain;f=src%2Futil%2Ferrors.rs;h=27f837775ef19ad4c605a6e3b0659d158ed47164;hb=38098ba657b1aaf5551f882bc900dafbc027617c;hp=71e5eed67f26abf7892ab698aaf5c723f6fad271;hpb=7743cbdf14412bfbe37fbce787e7b1f9a9a44d53;p=rust-lightning

diff --git a/src/util/errors.rs b/src/util/errors.rs
index 71e5eed6..27f83777 100644
--- a/src/util/errors.rs
+++ b/src/util/errors.rs
@@ -1,3 +1,5 @@
+//! Error types live here.
+
 use std::fmt;
 
 /// Indicates an error on the client's part (usually some variant of attempting to use too-low or
@@ -5,18 +7,90 @@ use std::fmt;
 pub enum APIError {
 	/// Indicates the API was wholly misused (see err for more). Cases where these can be returned
 	/// are documented, but generally indicates some precondition of a function was violated.
-	APIMisuseError {err: &'static str},
+	APIMisuseError {
+		/// A human-readable error message
+		err: &'static str
+	},
 	/// Due to a high feerate, we were unable to complete the request.
 	/// For example, this may be returned if the feerate implies we cannot open a channel at the
 	/// requested value, but opening a larger channel would succeed.
-	FeeRateTooHigh {err: String, feerate: u64},
+	FeeRateTooHigh {
+		/// A human-readable error message
+		err: String,
+		/// The feerate which was too high.
+		feerate: u64
+	},
+	/// A malformed Route was provided (eg overflowed value, node id mismatch, overly-looped route,
+	/// too-many-hops, etc).
+	RouteError {
+		/// A human-readable error message
+		err: &'static str
+	},
+	/// We were unable to complete the request as the Channel required to do so is unable to
+	/// complete the request (or was not found). This can take many forms, including disconnected
+	/// peer, channel at capacity, channel shutting down, etc.
+	ChannelUnavailable {
+		/// A human-readable error message
+		err: &'static str
+	},
+	/// An attempt to call add_update_monitor returned an Err (ie you did this!), causing the
+	/// attempted action to fail.
+	MonitorUpdateFailed,
 }
 
 impl fmt::Debug for APIError {
 	fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
 		match *self {
 			APIError::APIMisuseError {ref err} => f.write_str(err),
-			APIError::FeeRateTooHigh {ref err, ref feerate} => write!(f, "{} feerate: {}", err, feerate)
+			APIError::FeeRateTooHigh {ref err, ref feerate} => write!(f, "{} feerate: {}", err, feerate),
+			APIError::RouteError {ref err} => f.write_str(err),
+			APIError::ChannelUnavailable {ref err} => f.write_str(err),
+			APIError::MonitorUpdateFailed => f.write_str("Client indicated a channel monitor update failed"),
 		}
 	}
 }
+
+#[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", ""),
+	}
+}