Improve unit tests and remove unnecessary prefix checks

Author: arik-so

lightning-graph-sync/src/processing.rs

@@ -37,11 +37,6 @@ where
     read_cursor.read_exact(&mut prefix)?;
 
     let _deserialize_unsigned = match &prefix[..] {
-        &[71, 83, 80, 1] => {
-            return Err(GraphSyncError::ProcessingError(
-                "Signed deserialization not supported".to_string(),
-            ));
-        }
         &[76, 68, 75, 2] => true,
         _ => {
             return Err(GraphSyncError::ProcessingError(
@@ -120,7 +115,7 @@ where
 
 		} else {
 			// incremental update
-			println!("channel flags: {:b}, incremental update", channel_flags);
+			// println!("channel flags: {:b}, incremental update", channel_flags);
 
 			// locate the last channel update by this id
 			let mut channel_mutation_properties: Vec<ChannelMutationProperty> = Vec::with_capacity(5);
@@ -165,18 +160,8 @@ where
 				}
 			}
 
-			network_graph.override_directional_channel_properties(short_channel_id, standard_channel_flags, channel_mutation_properties);
+			network_graph.override_directional_channel_properties(short_channel_id, standard_channel_flags, channel_mutation_properties)?;
 		}
-
-		// println!("work in progress");
-
-		// let mut restricted_cursor = read_cursor.take(message_length.0);
-		// let mut channel_update: msgs::UnsignedChannelUpdate =
-		// 	Readable::read(&mut restricted_cursor).unwrap();
-		// channel_update.timestamp = current_timestamp;
-		// network_graph.update_channel_unsigned(&channel_update)?;
-		//
-		// read_cursor = restricted_cursor.into_inner();
 	}
 
     Ok(())
@@ -193,50 +178,6 @@ mod tests {
 
     use crate::processing::update_network_graph;
 
-    #[test]
-    fn network_graph_updates_from_example_binary_input() {
-        let block_hash = genesis_block(Network::Bitcoin).block_hash();
-        let network_graph = NetworkGraph::new(block_hash);
-
-        let before = network_graph.to_string();
-        assert_eq!(before.len(), 31);
-
-        let chain_source: Option<Box<dyn lightning::chain::Access>> = None;
-
-        let example_input = vec![
-            76, 68, 75, 2, 176, 1, 0, 0, 0, 111, 226, 140, 10, 182, 241, 179, 114, 193, 166, 162,
-            70, 174, 99, 247, 79, 147, 30, 131, 101, 225, 90, 8, 156, 104, 214, 25, 0, 0, 0, 0, 0,
-            10, 209, 73, 0, 2, 144, 0, 0, 2, 96, 250, 182, 51, 6, 110, 215, 177, 217, 185, 184,
-            160, 250, 200, 126, 21, 121, 209, 112, 158, 135, 77, 40, 160, 209, 113, 161, 245, 196,
-            59, 184, 119, 2, 180, 101, 113, 124, 204, 150, 157, 103, 192, 42, 110, 145, 224, 176,
-            14, 26, 197, 136, 6, 143, 13, 46, 3, 200, 220, 34, 228, 191, 104, 238, 134, 80, 3, 167,
-            152, 93, 150, 15, 179, 70, 61, 160, 42, 198, 253, 53, 249, 37, 29, 21, 176, 28, 136,
-            240, 237, 138, 165, 218, 254, 14, 245, 123, 228, 145, 150, 2, 25, 120, 160, 148, 15,
-            56, 179, 42, 198, 99, 96, 81, 85, 53, 227, 51, 62, 134, 4, 175, 0, 151, 217, 104, 180,
-            201, 249, 117, 196, 87, 94, 150, 74, 1, 2, 111, 226, 140, 10, 182, 241, 179, 114, 193,
-            166, 162, 70, 174, 99, 247, 79, 147, 30, 131, 101, 225, 90, 8, 156, 104, 214, 25, 0, 0,
-            0, 0, 0, 10, 209, 73, 0, 2, 144, 0, 0, 97, 139, 55, 91, 1, 2, 0, 40, 0, 0, 0, 0, 0, 0,
-            3, 232, 0, 0, 0, 0, 0, 0, 0, 100, 0, 0, 0, 0, 123, 235, 5, 192, 74, 1, 2, 111, 226,
-            140, 10, 182, 241, 179, 114, 193, 166, 162, 70, 174, 99, 247, 79, 147, 30, 131, 101,
-            225, 90, 8, 156, 104, 214, 25, 0, 0, 0, 0, 0, 10, 209, 73, 0, 2, 144, 0, 0, 97, 138,
-            144, 189, 1, 1, 0, 40, 0, 0, 0, 0, 0, 0, 3, 232, 0, 0, 0, 0, 0, 0, 5, 220, 0, 0, 0, 0,
-            123, 235, 5, 192,
-        ];
-        let update_result = update_network_graph(&network_graph, &example_input[..], &chain_source);
-        assert!(update_result.is_ok());
-
-        let after = network_graph.to_string();
-        assert_eq!(after.len(), 1132);
-        assert!(after.contains("779484474903625728: features: 0000"));
-        assert!(after.contains(
-            "node_one: 0260fab633066ed7b1d9b9b8a0fac87e1579d1709e874d28a0d171a1f5c43bb877"
-        ));
-        assert!(after.contains(
-            "node_two: 02b465717ccc969d67c02a6e91e0b00e1ac588068f0d2e03c8dc22e4bf68ee8650"
-        ));
-        assert!(after.contains("channels: [779484474903625728]"));
-    }
-
     #[test]
     fn network_graph_fails_to_update_from_clipped_input() {
         let block_hash = genesis_block(Network::Bitcoin).block_hash();
@@ -341,4 +282,109 @@ mod tests {
             assert!(false);
         }
     }
+
+	#[test]
+	fn incremental_only_update_fails_without_prior_announcements() {
+		let incremental_update_input = vec![76, 68, 75, 2, 0, 2, 8, 153, 192, 0, 2, 27, 0, 0, 136, 0, 0, 2, 217, 10, 222, 162, 0, 8, 38, 0, 1, 128];
+
+		let block_hash = genesis_block(Network::Bitcoin).block_hash();
+		let network_graph = NetworkGraph::new(block_hash);
+
+		let before = network_graph.to_string();
+		assert_eq!(before.len(), 31);
+
+		let chain_source: Option<Box<dyn lightning::chain::Access>> = None;
+
+		let update_result = update_network_graph(&network_graph, &incremental_update_input[..], &chain_source);
+		assert!(update_result.is_err());
+		if let Err(GraphSyncError::LightningError(lightning_error)) = update_result {
+			assert_eq!(lightning_error.err, "Couldn't find channel for update");
+		}else {
+			assert!(false);
+		}
+	}
+
+	#[test]
+	fn incremental_only_update_fails_without_prior_updates() {
+		let announced_update_input = vec![76, 68, 75, 2, 2, 174, 0, 0, 111, 226, 140, 10, 182, 241, 179, 114, 193, 166, 162, 70, 174, 99, 247, 79, 147, 30, 131, 101, 225, 90, 8, 156, 104, 214, 25, 0, 0, 0, 0, 0, 8, 153, 192, 0, 2, 27, 0, 0, 2, 22, 7, 207, 206, 25, 164, 197, 231, 230, 231, 56, 102, 61, 250, 251, 187, 172, 38, 46, 79, 247, 108, 44, 155, 48, 219, 238, 252, 53, 192, 6, 67, 2, 36, 125, 157, 176, 223, 175, 234, 116, 94, 248, 201, 225, 97, 235, 50, 47, 115, 172, 63, 136, 88, 216, 115, 11, 111, 217, 114, 84, 116, 124, 231, 107, 2, 163, 216, 116, 204, 120, 152, 52, 172, 208, 143, 140, 71, 242, 209, 153, 111, 23, 61, 222, 28, 106, 198, 149, 87, 166, 201, 180, 51, 64, 252, 143, 166, 2, 57, 240, 15, 230, 190, 255, 224, 70, 176, 137, 155, 249, 125, 20, 170, 114, 97, 221, 142, 89, 231, 233, 205, 126, 199, 216, 149, 155, 0, 210, 45, 67, 174, 0, 0, 111, 226, 140, 10, 182, 241, 179, 114, 193, 166, 162, 70, 174, 99, 247, 79, 147, 30, 131, 101, 225, 90, 8, 156, 104, 214, 25, 0, 0, 0, 0, 0, 10, 222, 162, 0, 8, 38, 0, 1, 2, 158, 1, 242, 121, 152, 106, 204, 131, 186, 35, 93, 70, 216, 10, 237, 224, 183, 89, 95, 65, 3, 83, 185, 58, 138, 181, 64, 187, 103, 127, 68, 50, 2, 201, 19, 17, 138, 136, 149, 185, 226, 156, 137, 175, 110, 32, 237, 0, 217, 90, 31, 100, 228, 149, 46, 219, 175, 168, 77, 4, 143, 38, 128, 76, 97, 2, 155, 9, 173, 229, 75, 82, 137, 57, 21, 112, 207, 99, 92, 145, 58, 48, 229, 10, 228, 163, 3, 106, 147, 39, 177, 90, 242, 186, 249, 11, 210, 54, 2, 212, 16, 225, 46, 42, 209, 254, 11, 28, 254, 196, 167, 139, 164, 241, 7, 176, 120, 192, 199, 148, 152, 38, 17, 118, 41, 122, 240, 223, 249, 158, 145, 2, 8, 153, 192, 0, 2, 27, 0, 0, 136, 0, 0, 2, 217, 10, 222, 162, 0, 8, 38, 0, 1, 128];
+
+		let block_hash = genesis_block(Network::Bitcoin).block_hash();
+		let network_graph = NetworkGraph::new(block_hash);
+
+		let before = network_graph.to_string();
+		assert_eq!(before.len(), 31);
+
+		let chain_source: Option<Box<dyn lightning::chain::Access>> = None;
+
+		let update_result = update_network_graph(&network_graph, &announced_update_input[..], &chain_source);
+		assert!(update_result.is_err());
+		if let Err(GraphSyncError::LightningError(lightning_error)) = update_result {
+			assert_eq!(lightning_error.err, "Couldn't find previous directional data for update");
+		}else {
+			assert!(false);
+		}
+	}
+
+	#[test]
+	fn incremental_only_update_fails_without_prior_same_direction_updates() {
+		let initialization_input = vec![76, 68, 75, 2, 2, 174, 0, 0, 111, 226, 140, 10, 182, 241, 179, 114, 193, 166, 162, 70, 174, 99, 247, 79, 147, 30, 131, 101, 225, 90, 8, 156, 104, 214, 25, 0, 0, 0, 0, 0, 8, 153, 192, 0, 2, 27, 0, 0, 2, 22, 7, 207, 206, 25, 164, 197, 231, 230, 231, 56, 102, 61, 250, 251, 187, 172, 38, 46, 79, 247, 108, 44, 155, 48, 219, 238, 252, 53, 192, 6, 67, 2, 36, 125, 157, 176, 223, 175, 234, 116, 94, 248, 201, 225, 97, 235, 50, 47, 115, 172, 63, 136, 88, 216, 115, 11, 111, 217, 114, 84, 116, 124, 231, 107, 2, 163, 216, 116, 204, 120, 152, 52, 172, 208, 143, 140, 71, 242, 209, 153, 111, 23, 61, 222, 28, 106, 198, 149, 87, 166, 201, 180, 51, 64, 252, 143, 166, 2, 57, 240, 15, 230, 190, 255, 224, 70, 176, 137, 155, 249, 125, 20, 170, 114, 97, 221, 142, 89, 231, 233, 205, 126, 199, 216, 149, 155, 0, 210, 45, 67, 174, 0, 0, 111, 226, 140, 10, 182, 241, 179, 114, 193, 166, 162, 70, 174, 99, 247, 79, 147, 30, 131, 101, 225, 90, 8, 156, 104, 214, 25, 0, 0, 0, 0, 0, 10, 222, 162, 0, 8, 38, 0, 1, 2, 158, 1, 242, 121, 152, 106, 204, 131, 186, 35, 93, 70, 216, 10, 237, 224, 183, 89, 95, 65, 3, 83, 185, 58, 138, 181, 64, 187, 103, 127, 68, 50, 2, 201, 19, 17, 138, 136, 149, 185, 226, 156, 137, 175, 110, 32, 237, 0, 217, 90, 31, 100, 228, 149, 46, 219, 175, 168, 77, 4, 143, 38, 128, 76, 97, 2, 155, 9, 173, 229, 75, 82, 137, 57, 21, 112, 207, 99, 92, 145, 58, 48, 229, 10, 228, 163, 3, 106, 147, 39, 177, 90, 242, 186, 249, 11, 210, 54, 2, 212, 16, 225, 46, 42, 209, 254, 11, 28, 254, 196, 167, 139, 164, 241, 7, 176, 120, 192, 199, 148, 152, 38, 17, 118, 41, 122, 240, 223, 249, 158, 145, 2, 8, 153, 192, 0, 2, 27, 0, 0, 1, 27, 1, 0, 40, 0, 0, 0, 0, 0, 0, 3, 232, 0, 0, 0, 1, 0, 0, 0, 125, 0, 0, 0, 0, 58, 85, 116, 216, 10, 222, 162, 0, 8, 38, 0, 1, 1, 27, 1, 0, 40, 0, 0, 0, 0, 0, 0, 3, 232, 0, 0, 3, 232, 0, 0, 0, 1, 0, 0, 0, 0, 29, 129, 25, 192];
+
+		let block_hash = genesis_block(Network::Bitcoin).block_hash();
+		let network_graph = NetworkGraph::new(block_hash);
+
+		let before = network_graph.to_string();
+		assert_eq!(before.len(), 31);
+
+		let chain_source: Option<Box<dyn lightning::chain::Access>> = None;
+
+		let initialization_result = update_network_graph(&network_graph, &initialization_input[..], &chain_source);
+		assert!(initialization_result.is_ok());
+
+		let initialized = network_graph.to_string();
+		assert_eq!(initialized.len(), 1737);
+		assert!(initialized.contains("021607cfce19a4c5e7e6e738663dfafbbbac262e4ff76c2c9b30dbeefc35c00643:"));
+		assert!(initialized.contains("02247d9db0dfafea745ef8c9e161eb322f73ac3f8858d8730b6fd97254747ce76b:"));
+		assert!(initialized.contains("029e01f279986acc83ba235d46d80aede0b7595f410353b93a8ab540bb677f4432:"));
+		assert!(initialized.contains("02c913118a8895b9e29c89af6e20ed00d95a1f64e4952edbafa84d048f26804c61:"));
+		assert!(initialized.contains("channels: [619737530008010752]"));
+		assert!(initialized.contains("channels: [783241506229452801]"));
+
+		let opposite_direction_incremental_update_input = vec![76, 68, 75, 2, 0, 2, 8, 153, 192, 0, 2, 27, 0, 0, 136, 0, 0, 2, 217, 10, 222, 162, 0, 8, 38, 0, 1, 128];
+		let update_result = update_network_graph(&network_graph, &opposite_direction_incremental_update_input[..], &chain_source);
+		assert!(update_result.is_err());
+		if let Err(GraphSyncError::LightningError(lightning_error)) = update_result {
+			assert_eq!(lightning_error.err, "Couldn't find previous directional data for update");
+		}else {
+			assert!(false);
+		}
+	}
+
+	#[test]
+	fn incremental_update_succeeds_with_prior_announcements_and_full_updates() {
+		let initialization_input = vec![76, 68, 75, 2, 2, 174, 0, 0, 111, 226, 140, 10, 182, 241, 179, 114, 193, 166, 162, 70, 174, 99, 247, 79, 147, 30, 131, 101, 225, 90, 8, 156, 104, 214, 25, 0, 0, 0, 0, 0, 8, 153, 192, 0, 2, 27, 0, 0, 2, 22, 7, 207, 206, 25, 164, 197, 231, 230, 231, 56, 102, 61, 250, 251, 187, 172, 38, 46, 79, 247, 108, 44, 155, 48, 219, 238, 252, 53, 192, 6, 67, 2, 36, 125, 157, 176, 223, 175, 234, 116, 94, 248, 201, 225, 97, 235, 50, 47, 115, 172, 63, 136, 88, 216, 115, 11, 111, 217, 114, 84, 116, 124, 231, 107, 2, 163, 216, 116, 204, 120, 152, 52, 172, 208, 143, 140, 71, 242, 209, 153, 111, 23, 61, 222, 28, 106, 198, 149, 87, 166, 201, 180, 51, 64, 252, 143, 166, 2, 57, 240, 15, 230, 190, 255, 224, 70, 176, 137, 155, 249, 125, 20, 170, 114, 97, 221, 142, 89, 231, 233, 205, 126, 199, 216, 149, 155, 0, 210, 45, 67, 174, 0, 0, 111, 226, 140, 10, 182, 241, 179, 114, 193, 166, 162, 70, 174, 99, 247, 79, 147, 30, 131, 101, 225, 90, 8, 156, 104, 214, 25, 0, 0, 0, 0, 0, 10, 222, 162, 0, 8, 38, 0, 1, 2, 158, 1, 242, 121, 152, 106, 204, 131, 186, 35, 93, 70, 216, 10, 237, 224, 183, 89, 95, 65, 3, 83, 185, 58, 138, 181, 64, 187, 103, 127, 68, 50, 2, 201, 19, 17, 138, 136, 149, 185, 226, 156, 137, 175, 110, 32, 237, 0, 217, 90, 31, 100, 228, 149, 46, 219, 175, 168, 77, 4, 143, 38, 128, 76, 97, 2, 155, 9, 173, 229, 75, 82, 137, 57, 21, 112, 207, 99, 92, 145, 58, 48, 229, 10, 228, 163, 3, 106, 147, 39, 177, 90, 242, 186, 249, 11, 210, 54, 2, 212, 16, 225, 46, 42, 209, 254, 11, 28, 254, 196, 167, 139, 164, 241, 7, 176, 120, 192, 199, 148, 152, 38, 17, 118, 41, 122, 240, 223, 249, 158, 145, 4, 8, 153, 192, 0, 2, 27, 0, 0, 0, 27, 1, 0, 40, 0, 0, 0, 0, 0, 0, 0, 1, 0, 0, 0, 100, 0, 0, 2, 224, 0, 0, 0, 0, 58, 85, 116, 216, 8, 153, 192, 0, 2, 27, 0, 0, 1, 27, 1, 0, 40, 0, 0, 0, 0, 0, 0, 3, 232, 0, 0, 0, 1, 0, 0, 0, 125, 0, 0, 0, 0, 58, 85, 116, 216, 10, 222, 162, 0, 8, 38, 0, 1, 0, 27, 1, 0, 40, 0, 0, 0, 0, 0, 0, 3, 232, 0, 0, 3, 232, 0, 0, 0, 1, 0, 0, 0, 0, 29, 129, 25, 192, 10, 222, 162, 0, 8, 38, 0, 1, 1, 27, 1, 0, 40, 0, 0, 0, 0, 0, 0, 3, 232, 0, 0, 3, 232, 0, 0, 0, 1, 0, 0, 0, 0, 29, 129, 25, 192];
+
+		let block_hash = genesis_block(Network::Bitcoin).block_hash();
+		let network_graph = NetworkGraph::new(block_hash);
+
+		let before = network_graph.to_string();
+		assert_eq!(before.len(), 31);
+
+		let chain_source: Option<Box<dyn lightning::chain::Access>> = None;
+
+		let initialization_result = update_network_graph(&network_graph, &initialization_input[..], &chain_source);
+		assert!(initialization_result.is_ok());
+
+		let single_direction_incremental_update_input = vec![76, 68, 75, 2, 0, 2, 8, 153, 192, 0, 2, 27, 0, 0, 136, 0, 0, 2, 217, 10, 222, 162, 0, 8, 38, 0, 1, 128];
+		let update_result = update_network_graph(&network_graph, &single_direction_incremental_update_input[..], &chain_source);
+		assert!(update_result.is_ok());
+
+		let after = network_graph.to_string();
+		assert_eq!(after.len(), 2348);
+		assert!(after.contains("021607cfce19a4c5e7e6e738663dfafbbbac262e4ff76c2c9b30dbeefc35c00643:"));
+		assert!(after.contains("02247d9db0dfafea745ef8c9e161eb322f73ac3f8858d8730b6fd97254747ce76b:"));
+		assert!(after.contains("029e01f279986acc83ba235d46d80aede0b7595f410353b93a8ab540bb677f4432:"));
+		assert!(after.contains("02c913118a8895b9e29c89af6e20ed00d95a1f64e4952edbafa84d048f26804c61:"));
+		assert!(after.contains("channels: [619737530008010752]"));
+		assert!(after.contains("channels: [783241506229452801]"));
+	}
 }

lightning/src/routing/network_graph.rs

@@ -1191,7 +1191,15 @@ impl NetworkGraph {
 	}
 
 	#[cfg(feature = "rapid-graph-sync")]
-	/// DANGER DO NOT CALL YET
+	/// Override a (directed) channel's individual properties without having a full update
+	/// This method should be used exclusively in conjunction with rapid graph sync, which is intended
+	/// for mobile devices.
+	///
+	/// `short_channel_id`: Channel to be updated
+	///
+	/// `flags`: Channel flags to set. Least significant bit serves as directional indicator
+	///
+	/// `mutations: Vec<ChannelMutationProperty>`: Array of properties to mutate
 	pub fn override_directional_channel_properties(&self, short_channel_id: u64, flags: u8, mutations: Vec<ChannelMutationProperty>) -> Result<(), LightningError> {
 		let mut channels = self.channels.write().unwrap();
 		let direction = flags & 1u8;