X-Git-Url: http://git.bitcoin.ninja/index.cgi?a=blobdiff_plain;f=src%2Futil%2Ferrors.rs;h=66ddf84d96871857ed027cc5c3c74f3bfb749dfb;hb=96d17ee7370af557330ccd8618648e82a6899ac0;hp=23a349e3e850f9e6aed90dee6058f95a6d8587a5;hpb=77c26226155fc63ed08de96bd09b03e29c9a8196;p=rust-lightning

diff --git a/src/util/errors.rs b/src/util/errors.rs
index 23a349e3..66ddf84d 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,14 +7,35 @@ 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},
-
-	/// Invalid route or parameters (cltv_delta, fee, pubkey) was specified
-	RouteError {err: &'static str},
+	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 {
@@ -21,6 +44,8 @@ impl fmt::Debug for APIError {
 			APIError::APIMisuseError {ref err} => f.write_str(err),
 			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"),
 		}
 	}
 }