Merge pull request #196 from yuntai/shutdown-apify

Raise APIError from close_channel

Author: TheBlueMatt

src/ln/channel.rs

@@ -2879,18 +2879,23 @@ impl Channel {
 
 	/// Begins the shutdown process, getting a message for the remote peer and returning all
 	/// holding cell HTLCs for payment failure.
-	pub fn get_shutdown(&mut self) -> Result<(msgs::Shutdown, Vec<(HTLCSource, [u8; 32])>), HandleError> {
+	pub fn get_shutdown(&mut self) -> Result<(msgs::Shutdown, Vec<(HTLCSource, [u8; 32])>), APIError> {
 		for htlc in self.pending_outbound_htlcs.iter() {
 			if htlc.state == OutboundHTLCState::LocalAnnounced {
-				return Err(HandleError{err: "Cannot begin shutdown with pending HTLCs, call send_commitment first", action: None});
+				return Err(APIError::APIMisuseError{err: "Cannot begin shutdown with pending HTLCs. Process pending events first"});
 			}
 		}
 		if self.channel_state & BOTH_SIDES_SHUTDOWN_MASK != 0 {
-			return Err(HandleError{err: "Shutdown already in progress", action: None});
+			if (self.channel_state & ChannelState::LocalShutdownSent as u32) == ChannelState::LocalShutdownSent as u32 {
+				return Err(APIError::APIMisuseError{err: "Shutdown already in progress"});
+			}
+			else if (self.channel_state & ChannelState::RemoteShutdownSent as u32) == ChannelState::RemoteShutdownSent as u32 {
+				return Err(APIError::ChannelUnavailable{err: "Shutdown already in progress by remote"});
+			}
 		}
 		assert_eq!(self.channel_state & ChannelState::ShutdownComplete as u32, 0);
 		if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
-			return Err(HandleError{err: "Cannot begin shutdown while peer is disconnected, maybe force-close instead?", action: None});
+			return Err(APIError::ChannelUnavailable{err: "Cannot begin shutdown while peer is disconnected, maybe force-close instead?"});
 		}
 
 		let our_closing_script = self.get_closing_scriptpubkey();

src/ln/channelmanager.rs

@@ -467,7 +467,7 @@ impl ChannelManager {
 	/// pending HTLCs, the channel will be closed on chain.
 	///
 	/// May generate a SendShutdown event on success, which should be relayed.
-	pub fn close_channel(&self, channel_id: &[u8; 32]) -> Result<(), HandleError> {
+	pub fn close_channel(&self, channel_id: &[u8; 32]) -> Result<(), APIError> {
 		let (mut res, node_id, chan_option) = {
 			let mut channel_state_lock = self.channel_state.lock().unwrap();
 			let channel_state = channel_state_lock.borrow_parts();
@@ -481,7 +481,7 @@ impl ChannelManager {
 						(res, chan_entry.get().get_their_node_id(), Some(chan_entry.remove_entry().1))
 					} else { (res, chan_entry.get().get_their_node_id(), None) }
 				},
-				hash_map::Entry::Vacant(_) => return Err(HandleError{err: "No such channel", action: None})
+				hash_map::Entry::Vacant(_) => return Err(APIError::ChannelUnavailable{err: "No such channel"})
 			}
 		};
 		for htlc_source in res.1.drain(..) {

src/util/errors.rs

@@ -26,6 +26,14 @@ pub enum APIError {
 		/// A human-readable error message
 		err: &'static str
 	},
+
+
+	/// We were unable to complete the request since channel is disconnected or
+	/// shutdown in progress initiated by remote
+	ChannelUnavailable {
+		/// A human-readable error message
+		err: &'static str
+	}
 }
 
 impl fmt::Debug for APIError {
@@ -34,6 +42,7 @@ 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),
 		}
 	}
 }