Skip to content

Commit 04567ef

Browse files
committed
Rename InboundV1Channel::new_from_req to InboundV1Channel::new
1 parent 5006831 commit 04567ef

File tree

3 files changed

+25
-25
lines changed

3 files changed

+25
-25
lines changed

lightning/src/ln/channel.rs

+20-20
Original file line numberDiff line numberDiff line change
@@ -1422,7 +1422,7 @@ impl<Signer: ChannelSigner> ChannelContext<Signer> {
14221422

14231423
/// Gets the redeemscript for the funding transaction output (ie the funding transaction output
14241424
/// pays to get_funding_redeemscript().to_v0_p2wsh()).
1425-
/// Panics if called before accept_channel/new_from_req
1425+
/// Panics if called before accept_channel/InboundV1Channel::new
14261426
pub fn get_funding_redeemscript(&self) -> Script {
14271427
make_funding_redeemscript(&self.get_holder_pubkeys().funding_pubkey, self.counterparty_funding_pubkey())
14281428
}
@@ -5936,7 +5936,7 @@ pub(super) struct InboundV1Channel<Signer: ChannelSigner> {
59365936
impl<Signer: WriteableEcdsaChannelSigner> InboundV1Channel<Signer> {
59375937
/// Creates a new channel from a remote sides' request for one.
59385938
/// Assumes chain_hash has already been checked and corresponds with what we expect!
5939-
pub fn new_from_req<ES: Deref, SP: Deref, F: Deref, L: Deref>(
5939+
pub fn new<ES: Deref, SP: Deref, F: Deref, L: Deref>(
59405940
fee_estimator: &LowerBoundedFeeEstimator<F>, entropy_source: &ES, signer_provider: &SP,
59415941
counterparty_node_id: PublicKey, our_supported_features: &ChannelTypeFeatures,
59425942
their_features: &InitFeatures, msg: &msgs::OpenChannel, user_id: u128, config: &UserConfig,
@@ -7482,7 +7482,7 @@ mod tests {
74827482
// Make sure A's dust limit is as we expect.
74837483
let open_channel_msg = node_a_chan.get_open_channel(genesis_block(network).header.block_hash());
74847484
let node_b_node_id = PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[7; 32]).unwrap());
7485-
let mut node_b_chan = InboundV1Channel::<EnforcingSigner>::new_from_req(&feeest, &&keys_provider, &&keys_provider, node_b_node_id, &channelmanager::provided_channel_type_features(&config), &channelmanager::provided_init_features(&config), &open_channel_msg, 7, &config, 0, &&logger, 42).unwrap();
7485+
let mut node_b_chan = InboundV1Channel::<EnforcingSigner>::new(&feeest, &&keys_provider, &&keys_provider, node_b_node_id, &channelmanager::provided_channel_type_features(&config), &channelmanager::provided_init_features(&config), &open_channel_msg, 7, &config, 0, &&logger, 42).unwrap();
74867486

74877487
// Node B --> Node A: accept channel, explicitly setting B's dust limit.
74887488
let mut accept_channel_msg = node_b_chan.accept_inbound_channel(0);
@@ -7610,7 +7610,7 @@ mod tests {
76107610
// Create Node B's channel by receiving Node A's open_channel message
76117611
let open_channel_msg = node_a_chan.get_open_channel(chain_hash);
76127612
let node_b_node_id = PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[7; 32]).unwrap());
7613-
let mut node_b_chan = InboundV1Channel::<EnforcingSigner>::new_from_req(&feeest, &&keys_provider, &&keys_provider, node_b_node_id, &channelmanager::provided_channel_type_features(&config), &channelmanager::provided_init_features(&config), &open_channel_msg, 7, &config, 0, &&logger, 42).unwrap();
7613+
let mut node_b_chan = InboundV1Channel::<EnforcingSigner>::new(&feeest, &&keys_provider, &&keys_provider, node_b_node_id, &channelmanager::provided_channel_type_features(&config), &channelmanager::provided_init_features(&config), &open_channel_msg, 7, &config, 0, &&logger, 42).unwrap();
76147614

76157615
// Node B --> Node A: accept channel
76167616
let accept_channel_msg = node_b_chan.accept_inbound_channel(0);
@@ -7679,15 +7679,15 @@ mod tests {
76797679

76807680
let chan_1_open_channel_msg = chan_1.get_open_channel(genesis_block(network).header.block_hash());
76817681

7682-
// Test that `new_from_req` creates a channel with the correct value for
7682+
// Test that `InboundV1Channel::new` creates a channel with the correct value for
76837683
// `holder_max_htlc_value_in_flight_msat`, when configured with a valid percentage value,
76847684
// which is set to the lower bound - 1 (2%) of the `channel_value`.
7685-
let chan_3 = InboundV1Channel::<EnforcingSigner>::new_from_req(&feeest, &&keys_provider, &&keys_provider, inbound_node_id, &channelmanager::provided_channel_type_features(&config_2_percent), &channelmanager::provided_init_features(&config_2_percent), &chan_1_open_channel_msg, 7, &config_2_percent, 0, &&logger, 42).unwrap();
7685+
let chan_3 = InboundV1Channel::<EnforcingSigner>::new(&feeest, &&keys_provider, &&keys_provider, inbound_node_id, &channelmanager::provided_channel_type_features(&config_2_percent), &channelmanager::provided_init_features(&config_2_percent), &chan_1_open_channel_msg, 7, &config_2_percent, 0, &&logger, 42).unwrap();
76867686
let chan_3_value_msat = chan_3.context.channel_value_satoshis * 1000;
76877687
assert_eq!(chan_3.context.holder_max_htlc_value_in_flight_msat, (chan_3_value_msat as f64 * 0.02) as u64);
76887688

76897689
// Test with the upper bound - 1 of valid values (99%).
7690-
let chan_4 = InboundV1Channel::<EnforcingSigner>::new_from_req(&feeest, &&keys_provider, &&keys_provider, inbound_node_id, &channelmanager::provided_channel_type_features(&config_99_percent), &channelmanager::provided_init_features(&config_99_percent), &chan_1_open_channel_msg, 7, &config_99_percent, 0, &&logger, 42).unwrap();
7690+
let chan_4 = InboundV1Channel::<EnforcingSigner>::new(&feeest, &&keys_provider, &&keys_provider, inbound_node_id, &channelmanager::provided_channel_type_features(&config_99_percent), &channelmanager::provided_init_features(&config_99_percent), &chan_1_open_channel_msg, 7, &config_99_percent, 0, &&logger, 42).unwrap();
76917691
let chan_4_value_msat = chan_4.context.channel_value_satoshis * 1000;
76927692
assert_eq!(chan_4.context.holder_max_htlc_value_in_flight_msat, (chan_4_value_msat as f64 * 0.99) as u64);
76937693

@@ -7704,24 +7704,24 @@ mod tests {
77047704
let chan_6_value_msat = chan_6.context.channel_value_satoshis * 1000;
77057705
assert_eq!(chan_6.context.holder_max_htlc_value_in_flight_msat, chan_6_value_msat);
77067706

7707-
// Test that `new_from_req` uses the lower bound of the configurable percentage values (1%)
7707+
// Test that `InboundV1Channel::new` uses the lower bound of the configurable percentage values (1%)
77087708
// if `max_inbound_htlc_value_in_flight_percent_of_channel` is set to a value less than 1.
7709-
let chan_7 = InboundV1Channel::<EnforcingSigner>::new_from_req(&feeest, &&keys_provider, &&keys_provider, inbound_node_id, &channelmanager::provided_channel_type_features(&config_0_percent), &channelmanager::provided_init_features(&config_0_percent), &chan_1_open_channel_msg, 7, &config_0_percent, 0, &&logger, 42).unwrap();
7709+
let chan_7 = InboundV1Channel::<EnforcingSigner>::new(&feeest, &&keys_provider, &&keys_provider, inbound_node_id, &channelmanager::provided_channel_type_features(&config_0_percent), &channelmanager::provided_init_features(&config_0_percent), &chan_1_open_channel_msg, 7, &config_0_percent, 0, &&logger, 42).unwrap();
77107710
let chan_7_value_msat = chan_7.context.channel_value_satoshis * 1000;
77117711
assert_eq!(chan_7.context.holder_max_htlc_value_in_flight_msat, (chan_7_value_msat as f64 * 0.01) as u64);
77127712

7713-
// Test that `new_from_req` uses the upper bound of the configurable percentage values
7713+
// Test that `InboundV1Channel::new` uses the upper bound of the configurable percentage values
77147714
// (100%) if `max_inbound_htlc_value_in_flight_percent_of_channel` is set to a larger value
77157715
// than 100.
7716-
let chan_8 = InboundV1Channel::<EnforcingSigner>::new_from_req(&feeest, &&keys_provider, &&keys_provider, inbound_node_id, &channelmanager::provided_channel_type_features(&config_101_percent), &channelmanager::provided_init_features(&config_101_percent), &chan_1_open_channel_msg, 7, &config_101_percent, 0, &&logger, 42).unwrap();
7716+
let chan_8 = InboundV1Channel::<EnforcingSigner>::new(&feeest, &&keys_provider, &&keys_provider, inbound_node_id, &channelmanager::provided_channel_type_features(&config_101_percent), &channelmanager::provided_init_features(&config_101_percent), &chan_1_open_channel_msg, 7, &config_101_percent, 0, &&logger, 42).unwrap();
77177717
let chan_8_value_msat = chan_8.context.channel_value_satoshis * 1000;
77187718
assert_eq!(chan_8.context.holder_max_htlc_value_in_flight_msat, chan_8_value_msat);
77197719
}
77207720

77217721
#[test]
77227722
fn test_configured_holder_selected_channel_reserve_satoshis() {
77237723

7724-
// Test that `OutboundV1Channel::new` and `new_from_req` create a channel with the correct
7724+
// Test that `OutboundV1Channel::new` and `InboundV1Channel::new` create a channel with the correct
77257725
// channel reserves, when `their_channel_reserve_proportional_millionths` is configured.
77267726
test_self_and_counterparty_channel_reserve(10_000_000, 0.02, 0.02);
77277727

@@ -7763,15 +7763,15 @@ mod tests {
77637763
inbound_node_config.channel_handshake_config.their_channel_reserve_proportional_millionths = (inbound_selected_channel_reserve_perc * 1_000_000.0) as u32;
77647764

77657765
if outbound_selected_channel_reserve_perc + inbound_selected_channel_reserve_perc < 1.0 {
7766-
let chan_inbound_node = InboundV1Channel::<EnforcingSigner>::new_from_req(&&fee_est, &&keys_provider, &&keys_provider, inbound_node_id, &channelmanager::provided_channel_type_features(&inbound_node_config), &channelmanager::provided_init_features(&outbound_node_config), &chan_open_channel_msg, 7, &inbound_node_config, 0, &&logger, 42).unwrap();
7766+
let chan_inbound_node = InboundV1Channel::<EnforcingSigner>::new(&&fee_est, &&keys_provider, &&keys_provider, inbound_node_id, &channelmanager::provided_channel_type_features(&inbound_node_config), &channelmanager::provided_init_features(&outbound_node_config), &chan_open_channel_msg, 7, &inbound_node_config, 0, &&logger, 42).unwrap();
77677767

77687768
let expected_inbound_selected_chan_reserve = cmp::max(MIN_THEIR_CHAN_RESERVE_SATOSHIS, (chan.context.channel_value_satoshis as f64 * inbound_selected_channel_reserve_perc) as u64);
77697769

77707770
assert_eq!(chan_inbound_node.context.holder_selected_channel_reserve_satoshis, expected_inbound_selected_chan_reserve);
77717771
assert_eq!(chan_inbound_node.context.counterparty_selected_channel_reserve_satoshis.unwrap(), expected_outbound_selected_chan_reserve);
77727772
} else {
77737773
// Channel Negotiations failed
7774-
let result = InboundV1Channel::<EnforcingSigner>::new_from_req(&&fee_est, &&keys_provider, &&keys_provider, inbound_node_id, &channelmanager::provided_channel_type_features(&inbound_node_config), &channelmanager::provided_init_features(&outbound_node_config), &chan_open_channel_msg, 7, &inbound_node_config, 0, &&logger, 42);
7774+
let result = InboundV1Channel::<EnforcingSigner>::new(&&fee_est, &&keys_provider, &&keys_provider, inbound_node_id, &channelmanager::provided_channel_type_features(&inbound_node_config), &channelmanager::provided_init_features(&outbound_node_config), &chan_open_channel_msg, 7, &inbound_node_config, 0, &&logger, 42);
77757775
assert!(result.is_err());
77767776
}
77777777
}
@@ -7796,7 +7796,7 @@ mod tests {
77967796
// Make sure A's dust limit is as we expect.
77977797
let open_channel_msg = node_a_chan.get_open_channel(genesis_block(network).header.block_hash());
77987798
let node_b_node_id = PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[7; 32]).unwrap());
7799-
let mut node_b_chan = InboundV1Channel::<EnforcingSigner>::new_from_req(&feeest, &&keys_provider, &&keys_provider, node_b_node_id, &channelmanager::provided_channel_type_features(&config), &channelmanager::provided_init_features(&config), &open_channel_msg, 7, &config, 0, &&logger, 42).unwrap();
7799+
let mut node_b_chan = InboundV1Channel::<EnforcingSigner>::new(&feeest, &&keys_provider, &&keys_provider, node_b_node_id, &channelmanager::provided_channel_type_features(&config), &channelmanager::provided_init_features(&config), &open_channel_msg, 7, &config, 0, &&logger, 42).unwrap();
78007800

78017801
// Node B --> Node A: accept channel, explicitly setting B's dust limit.
78027802
let mut accept_channel_msg = node_b_chan.accept_inbound_channel(0);
@@ -8618,7 +8618,7 @@ mod tests {
86188618
let mut open_channel_msg = node_a_chan.get_open_channel(genesis_block(network).header.block_hash());
86198619
open_channel_msg.channel_type = Some(channel_type_features);
86208620
let node_b_node_id = PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[7; 32]).unwrap());
8621-
let res = InboundV1Channel::<EnforcingSigner>::new_from_req(&feeest, &&keys_provider, &&keys_provider,
8621+
let res = InboundV1Channel::<EnforcingSigner>::new(&feeest, &&keys_provider, &&keys_provider,
86228622
node_b_node_id, &channelmanager::provided_channel_type_features(&config),
86238623
&channelmanager::provided_init_features(&config), &open_channel_msg, 7, &config, 0, &&logger, 42);
86248624
assert!(res.is_ok());
@@ -8660,7 +8660,7 @@ mod tests {
86608660
).unwrap();
86618661

86628662
let open_channel_msg = channel_a.get_open_channel(genesis_block(network).header.block_hash());
8663-
let channel_b = InboundV1Channel::<EnforcingSigner>::new_from_req(
8663+
let channel_b = InboundV1Channel::<EnforcingSigner>::new(
86648664
&fee_estimator, &&keys_provider, &&keys_provider, node_id_a,
86658665
&channelmanager::provided_channel_type_features(&config), &channelmanager::provided_init_features(&config),
86668666
&open_channel_msg, 7, &config, 0, &&logger, 42
@@ -8703,7 +8703,7 @@ mod tests {
87038703

87048704
// Since A supports both `static_remote_key` and `option_anchors`, but B only accepts
87058705
// `static_remote_key`, it will fail the channel.
8706-
let channel_b = InboundV1Channel::<EnforcingSigner>::new_from_req(
8706+
let channel_b = InboundV1Channel::<EnforcingSigner>::new(
87078707
&fee_estimator, &&keys_provider, &&keys_provider, node_id_a,
87088708
&channelmanager::provided_channel_type_features(&config), &init_features_with_simple_anchors,
87098709
&open_channel_msg, 7, &config, 0, &&logger, 42
@@ -8747,7 +8747,7 @@ mod tests {
87478747
let mut open_channel_msg = channel_a.get_open_channel(genesis_block(network).header.block_hash());
87488748
open_channel_msg.channel_type = Some(simple_anchors_channel_type.clone());
87498749

8750-
let res = InboundV1Channel::<EnforcingSigner>::new_from_req(
8750+
let res = InboundV1Channel::<EnforcingSigner>::new(
87518751
&fee_estimator, &&keys_provider, &&keys_provider, node_id_a,
87528752
&channelmanager::provided_channel_type_features(&config), &simple_anchors_init,
87538753
&open_channel_msg, 7, &config, 0, &&logger, 42
@@ -8765,7 +8765,7 @@ mod tests {
87658765

87668766
let open_channel_msg = channel_a.get_open_channel(genesis_block(network).header.block_hash());
87678767

8768-
let channel_b = InboundV1Channel::<EnforcingSigner>::new_from_req(
8768+
let channel_b = InboundV1Channel::<EnforcingSigner>::new(
87698769
&fee_estimator, &&keys_provider, &&keys_provider, node_id_a,
87708770
&channelmanager::provided_channel_type_features(&config), &channelmanager::provided_init_features(&config),
87718771
&open_channel_msg, 7, &config, 0, &&logger, 42

lightning/src/ln/channelmanager.rs

+1-1
Original file line numberDiff line numberDiff line change
@@ -5026,7 +5026,7 @@ where
50265026
msg.temporary_channel_id.clone()));
50275027
}
50285028

5029-
let mut channel = match InboundV1Channel::new_from_req(&self.fee_estimator, &self.entropy_source, &self.signer_provider,
5029+
let mut channel = match InboundV1Channel::new(&self.fee_estimator, &self.entropy_source, &self.signer_provider,
50305030
counterparty_node_id.clone(), &self.channel_type_features(), &peer_state.latest_features, msg, user_channel_id,
50315031
&self.default_configuration, best_block_height, &self.logger, outbound_scid_alias)
50325032
{

lightning/src/ln/functional_tests.rs

+4-4
Original file line numberDiff line numberDiff line change
@@ -6968,11 +6968,11 @@ fn test_user_configurable_csv_delay() {
69686968
}
69696969
} else { assert!(false) }
69706970

6971-
// We test config.our_to_self > BREAKDOWN_TIMEOUT is enforced in InboundV1Channel::new_from_req()
6971+
// We test config.our_to_self > BREAKDOWN_TIMEOUT is enforced in InboundV1Channel::new()
69726972
nodes[1].node.create_channel(nodes[0].node.get_our_node_id(), 1000000, 1000000, 42, None).unwrap();
69736973
let mut open_channel = get_event_msg!(nodes[1], MessageSendEvent::SendOpenChannel, nodes[0].node.get_our_node_id());
69746974
open_channel.to_self_delay = 200;
6975-
if let Err(error) = InboundV1Channel::new_from_req(&LowerBoundedFeeEstimator::new(&test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(253) }),
6975+
if let Err(error) = InboundV1Channel::new(&LowerBoundedFeeEstimator::new(&test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(253) }),
69766976
&nodes[0].keys_manager, &nodes[0].keys_manager, nodes[1].node.get_our_node_id(), &nodes[0].node.channel_type_features(), &nodes[1].node.init_features(), &open_channel, 0,
69776977
&low_our_to_self_config, 0, &nodes[0].logger, 42)
69786978
{
@@ -7000,11 +7000,11 @@ fn test_user_configurable_csv_delay() {
70007000
} else { panic!(); }
70017001
check_closed_event!(nodes[0], 1, ClosureReason::ProcessingError { err: reason_msg });
70027002

7003-
// We test msg.to_self_delay <= config.their_to_self_delay is enforced in InboundV1Channel::new_from_req()
7003+
// We test msg.to_self_delay <= config.their_to_self_delay is enforced in InboundV1Channel::new()
70047004
nodes[1].node.create_channel(nodes[0].node.get_our_node_id(), 1000000, 1000000, 42, None).unwrap();
70057005
let mut open_channel = get_event_msg!(nodes[1], MessageSendEvent::SendOpenChannel, nodes[0].node.get_our_node_id());
70067006
open_channel.to_self_delay = 200;
7007-
if let Err(error) = InboundV1Channel::new_from_req(&LowerBoundedFeeEstimator::new(&test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(253) }),
7007+
if let Err(error) = InboundV1Channel::new(&LowerBoundedFeeEstimator::new(&test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(253) }),
70087008
&nodes[0].keys_manager, &nodes[0].keys_manager, nodes[1].node.get_our_node_id(), &nodes[0].node.channel_type_features(), &nodes[1].node.init_features(), &open_channel, 0,
70097009
&high_their_to_self_config, 0, &nodes[0].logger, 42)
70107010
{

0 commit comments

Comments
 (0)