Merge pull request #86 from TheBlueMatt/2018-07-event-fixes

Fix one bug on event handling, clean up docs

Author: TheBlueMatt

fuzz/fuzz_targets/full_stack_target.rs

@@ -263,7 +263,7 @@ pub fn do_test(data: &[u8]) {
 			},
 			7 => {
 				if should_forward {
-					channelmanager.process_pending_htlc_forward();
+					channelmanager.process_pending_htlc_forwards();
 					handler.process_events();
 					should_forward = false;
 				}

src/ln/channelmanager.rs

@@ -766,7 +766,10 @@ impl ChannelManager {
 		}))
 	}
 
-	pub fn process_pending_htlc_forward(&self) {
+	/// Processes HTLCs which are pending waiting on random forward delay.
+	/// Should only really ever be called in response to an PendingHTLCsForwardable event.
+	/// Will likely generate further events.
+	pub fn process_pending_htlc_forwards(&self) {
 		let mut new_events = Vec::new();
 		let mut failed_forwards = Vec::new();
 		{
@@ -958,7 +961,7 @@ impl ChannelManager {
 	pub fn claim_funds(&self, payment_preimage: [u8; 32]) -> bool {
 		self.claim_funds_internal(payment_preimage, true)
 	}
-	pub fn claim_funds_internal(&self, payment_preimage: [u8; 32], from_user: bool) -> bool {
+	fn claim_funds_internal(&self, payment_preimage: [u8; 32], from_user: bool) -> bool {
 		let mut sha = Sha256::new();
 		sha.input(&payment_preimage);
 		let mut payment_hash = [0; 32];
@@ -2359,7 +2362,7 @@ mod tests {
 			};
 
 			node.node.channel_state.lock().unwrap().next_forward = Instant::now();
-			node.node.process_pending_htlc_forward();
+			node.node.process_pending_htlc_forwards();
 
 			let mut events_2 = node.node.get_and_clear_pending_events();
 			assert_eq!(events_2.len(), 1);

src/ln/peer_handler.rs

@@ -628,11 +628,8 @@ impl<Descriptor: SocketDescriptor> PeerManager<Descriptor> {
 					Event::PaymentReceived {..} => { /* Hand upstream */ },
 					Event::PaymentSent {..} => { /* Hand upstream */ },
 					Event::PaymentFailed {..} => { /* Hand upstream */ },
+					Event::PendingHTLCsForwardable {..} => { /* Hand upstream */ },
 
-					Event::PendingHTLCsForwardable {..} => {
-						//TODO: Handle upstream in some confused form so that upstream just knows
-						//to call us somehow?
-					},
 					Event::SendOpenChannel { ref node_id, ref msg } => {
 						let (mut descriptor, peer) = get_peer_for_forwarding!(node_id, {
 								//TODO: Drop the pending channel? (or just let it timeout, but that sucks)
@@ -750,6 +747,7 @@ impl<Descriptor: SocketDescriptor> PeerManager<Descriptor> {
 							descriptor.disconnect_socket();
 							self.message_handler.chan_handler.peer_disconnected(&node_id, false);
 						}
+						continue;
 					},
 				}
 

src/util/events.rs

@@ -46,13 +46,13 @@ pub enum Event {
 	PaymentFailed {
 		payment_hash: [u8; 32],
 	},
-
-	// Events indicating the network loop should send a message to a peer:
 	/// Used to indicate that ChannelManager::process_pending_htlc_forwards should be called at a
 	/// time in the future.
 	PendingHTLCsForwardable {
 		time_forwardable: Instant,
 	},
+
+	// Events indicating the network loop should send a message to a peer:
 	/// Used to indicate that we've initialted a channel open and should send the open_channel
 	/// message provided to the given peer
 	SendOpenChannel {