Add test for configurable in-flight limit

Author: ViktorTigerstrom

lightning/src/ln/channel.rs

@@ -6348,7 +6348,7 @@ mod tests {
 	use hex;
 	use ln::PaymentHash;
 	use ln::channelmanager::{HTLCSource, PaymentId};
-	use ln::channel::{Channel, InboundHTLCOutput, OutboundHTLCOutput, InboundHTLCState, OutboundHTLCState, HTLCCandidate, HTLCInitiator};
+	use ln::channel::{Channel, InboundHTLCOutput, OutboundHTLCOutput, InboundHTLCState, OutboundHTLCState, HTLCCandidate, HTLCInitiator, ChannelError};
 	use ln::channel::MAX_FUNDING_SATOSHIS;
 	use ln::features::InitFeatures;
 	use ln::msgs::{ChannelUpdate, DataLossProtect, DecodeError, OptionalField, UnsignedChannelUpdate};
@@ -6665,6 +6665,99 @@ mod tests {
 		}
 	}
 
+	#[test]
+	fn test_configured_holder_max_htlc_value_in_flight() {
+		let feeest = TestFeeEstimator{fee_est: 15000};
+		let logger = test_utils::TestLogger::new();
+		let secp_ctx = Secp256k1::new();
+		let seed = [42; 32];
+		let network = Network::Testnet;
+		let keys_provider = test_utils::TestKeysInterface::new(&seed, network);
+		let outbound_node_id = PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[42; 32]).unwrap());
+		let inbound_node_id = PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[7; 32]).unwrap());
+
+		let mut config_1_percent = UserConfig::default();
+		config_1_percent.channel_options.holder_max_htlc_value_in_flight_msat_channel_value_percent = 1;
+		let mut config_100_percent = UserConfig::default();
+		config_100_percent.channel_options.holder_max_htlc_value_in_flight_msat_channel_value_percent = 100;
+		let mut config_0_percent = UserConfig::default();
+		config_0_percent.channel_options.holder_max_htlc_value_in_flight_msat_channel_value_percent = 0;
+		let mut config_101_percent = UserConfig::default();
+		config_101_percent.channel_options.holder_max_htlc_value_in_flight_msat_channel_value_percent = 101;
+
+		// Test that `new_outbound` creates a channel with the correct value for
+		// `holder_max_htlc_value_in_flight_msat`, when configured with a valid percentage value,
+		// which is set to the lower bound (1%) of the `channel_value`.
+		let chan_1 = Channel::<EnforcingSigner>::new_outbound(&&feeest, &&keys_provider, outbound_node_id, &InitFeatures::known(), 10000000, 100000, 42, &config_1_percent, 0, 42).unwrap();
+		let chan_1_value_msat = chan_1.channel_value_satoshis * 1000;
+		assert_eq!(chan_1.holder_max_htlc_value_in_flight_msat, (chan_1_value_msat as f64 * 0.01) as u64);
+
+		// Test with the upper bound of valid values (100%).
+		let chan_2 = Channel::<EnforcingSigner>::new_outbound(&&feeest, &&keys_provider, outbound_node_id, &InitFeatures::known(), 10000000, 100000, 42, &config_100_percent, 0, 42).unwrap();
+		let chan_2_value_msat = chan_2.channel_value_satoshis * 1000;
+		assert_eq!(chan_2.holder_max_htlc_value_in_flight_msat, chan_2_value_msat);
+
+		let chan_1_open_channel_msg = chan_1.get_open_channel(genesis_block(network).header.block_hash());
+
+		// Test that `new_from_req` creates a channel with the correct value for
+		// `holder_max_htlc_value_in_flight_msat`, when configured with a valid percentage value,
+		// which is set to the lower bound (1%) of the `channel_value`.
+		let chan_3 = Channel::<EnforcingSigner>::new_from_req(&&feeest, &&keys_provider, inbound_node_id, &InitFeatures::known(), &chan_1_open_channel_msg, 7, &config_1_percent, 0, &&logger, 42).unwrap();
+		let chan_3_value_msat = chan_3.channel_value_satoshis * 1000;
+		assert_eq!(chan_3.holder_max_htlc_value_in_flight_msat, (chan_3_value_msat as f64 * 0.01) as u64);
+
+		// Test with the upper bound of valid values (100%).
+		let chan_4 = Channel::<EnforcingSigner>::new_from_req(&&feeest, &&keys_provider, inbound_node_id, &InitFeatures::known(), &chan_1_open_channel_msg, 7, &config_100_percent, 0, &&logger, 42).unwrap();
+		let chan_4_value_msat = chan_4.channel_value_satoshis * 1000;
+		assert_eq!(chan_4.holder_max_htlc_value_in_flight_msat, chan_4_value_msat);
+
+		// Test invalid values
+		let get_error_string = | percentage_value | { format!(
+			"UserConfig::channel_options::holder_max_htlc_value_in_flight_msat_channel_value_percent must be set to a value between 1-100. Current value set ({})",
+			percentage_value)
+		};
+
+		// Test that `new_outbound` fails when trying to create a channel invalid percentage value
+		// set for `holder_max_htlc_value_in_flight_msat_channel_value_percent` (less than 1).
+		let err_1 = Channel::<EnforcingSigner>::new_outbound(&&feeest, &&keys_provider, outbound_node_id, &InitFeatures::known(), 10000000, 100000, 42, &config_0_percent, 0, 42);
+		match err_1 {
+			Err(APIError::APIMisuseError { err }) => {
+				assert_eq!(err, get_error_string(0));
+			}
+			_ => { panic!("new_outbound should have resulted in APIError::APIMisuseError"); }
+		}
+
+		// Test that `new_outbound` fails when trying to create a channel invalid percentage value
+		// set for `holder_max_htlc_value_in_flight_msat_channel_value_percent` (larger than 100).
+		let err_2 = Channel::<EnforcingSigner>::new_outbound(&&feeest, &&keys_provider, outbound_node_id, &InitFeatures::known(), 10000000, 100000, 42, &config_101_percent, 0, 42);
+		match err_2 {
+			Err(APIError::APIMisuseError { err }) => {
+				assert_eq!(err, get_error_string(101));
+			}
+			_ => { panic!("new_outbound should have resulted in APIError::APIMisuseError"); }
+		}
+
+		// Test that `new_from_req` fails when trying to create a channel invalid percentage value
+		// set for `holder_max_htlc_value_in_flight_msat_channel_value_percent` (less than 1).
+		let err_3 = Channel::<EnforcingSigner>::new_from_req(&&feeest, &&keys_provider, inbound_node_id, &InitFeatures::known(), &chan_1_open_channel_msg, 7, &config_0_percent, 0, &&logger, 42);
+		match err_3 {
+			Err(ChannelError::Close(err)) => {
+				assert_eq!(err, get_error_string(0));
+			}
+			_ => { panic!("new_from_req should have resulted in ChannelError::Close"); }
+		}
+
+		// Test that `new_from_req` fails when trying to create a channel invalid percentage value
+		// set for `holder_max_htlc_value_in_flight_msat_channel_value_percent` (larger than 100).
+		let err_4 = Channel::<EnforcingSigner>::new_from_req(&&feeest, &&keys_provider, inbound_node_id, &InitFeatures::known(), &chan_1_open_channel_msg, 7, &config_101_percent, 0, &&logger, 42);
+		match err_4 {
+			Err(ChannelError::Close(err)) => {
+				assert_eq!(err, get_error_string(101));
+			}
+			_ => { panic!("new_from_req should have resulted in ChannelError::Close"); }
+		}
+	}
+
 	#[test]
 	fn channel_update() {
 		let feeest = TestFeeEstimator{fee_est: 15000};