Fix indents issue and add comments for the events serialization test

Author: sourabhmarathe

lightning/src/ln/functional_tests.rs

@@ -3916,12 +3916,13 @@ fn test_manager_serialize_deserialize_events() {
 	let nodes_0_deserialized: ChannelManager<EnforcingChannelKeys, &test_utils::TestChannelMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator>;
 	let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 
-    let channel_value = 100000;
-    let push_msat = 10001;
-    let a_flags = InitFeatures::known();
-    let b_flags = InitFeatures::known();
-    let node_a = nodes.pop().unwrap();
-    let node_b = nodes.pop().unwrap();
+	// Start creating the channel, but stop right before broadcasting the event message FundingBroadcastSafe
+	let channel_value = 100000;
+	let push_msat = 10001;
+	let a_flags = InitFeatures::known();
+	let b_flags = InitFeatures::known();
+	let node_a = nodes.pop().unwrap();
+	let node_b = nodes.pop().unwrap();
 	node_a.node.create_channel(node_b.node.get_our_node_id(), channel_value, push_msat, 42, None).unwrap();
 	node_b.node.handle_open_channel(&node_a.node.get_our_node_id(), a_flags, &get_event_msg!(node_a, MessageSendEvent::SendOpenChannel, node_b.node.get_our_node_id()));
 	node_a.node.handle_accept_channel(&node_b.node.get_our_node_id(), b_flags, &get_event_msg!(node_b, MessageSendEvent::SendAcceptChannel, node_a.node.get_our_node_id()));
@@ -3947,9 +3948,10 @@ fn test_manager_serialize_deserialize_events() {
 		added_monitors.clear();
 	}
 
-    nodes.push(node_a);
-    nodes.push(node_b);
+	nodes.push(node_a);
+	nodes.push(node_b);
 
+	// Start the de/seriailization process mid-channel creation to check that the channel manager will hold onto events that are serialized
 	let nodes_0_serialized = nodes[0].node.encode();
 	let mut chan_0_monitor_serialized = test_utils::TestVecWriter(Vec::new());
 	nodes[0].chan_monitor.simple_monitor.monitors.lock().unwrap().iter().next().unwrap().1.write_for_disk(&mut chan_0_monitor_serialized).unwrap();
@@ -3979,12 +3981,13 @@ fn test_manager_serialize_deserialize_events() {
 	};
 	nodes_0_deserialized = nodes_0_deserialized_tmp;
 	assert!(nodes_0_read.is_empty());
-    
+
 	nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
 
 	assert!(nodes[0].chan_monitor.add_monitor(chan_0_monitor.get_funding_txo(), chan_0_monitor).is_ok());
 	nodes[0].node = &nodes_0_deserialized;
 
+	// After deserializing, make sure the FundingBroadcastSafe event is still held by the channel manager
 	let events_4 = nodes[0].node.get_and_clear_pending_events();
 	assert_eq!(events_4.len(), 1);
 	match events_4[0] {
@@ -3994,6 +3997,8 @@ fn test_manager_serialize_deserialize_events() {
 		},
 		_ => panic!("Unexpected event"),
 	};
+
+	// Make sure the channel is functioning as thought the de/serialization never happened
 	nodes[0].block_notifier.register_listener(nodes[0].node);
 	assert_eq!(nodes[0].node.list_channels().len(), 1);
 	check_added_monitors!(nodes[0], 1);