Skip to content

Commit bd69ee3

Browse files
joostjagerjoostjager
committed
Allow config defaults override for inbound channels
This commit introduces a config override struct parameter to the accept_inbound_channel methods. With manual channel acceptance enabled, users can modify the default configuration as needed.
1 parent 1b281f1 commit bd69ee3

File tree

8 files changed

+145
-41
lines changed

8 files changed

+145
-41
lines changed

‎fuzz/src/chanmon_consistency.rs‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,7 @@ use lightning::events;
4646
use lightning::events::MessageSendEventsProvider;
4747
use lightning::ln::channel::FEE_SPIKE_BUFFER_FEE_INCREASE_MULTIPLE;
4848
use lightning::ln::channel_state::ChannelDetails;
49+
use lightning::ln::channelmanager::InboundChannelConfigOverrides;
4950
use lightning::ln::channelmanager::{
5051
ChainParameters, ChannelManager, ChannelManagerReadArgs, PaymentId, RecentPaymentDetails,
5152
RecipientOnionFields,
@@ -809,6 +810,7 @@ pub fn do_test<Out: Output>(data: &[u8], underlying_out: Out, anchors: bool) {
809810
temporary_channel_id,
810811
counterparty_node_id,
811812
user_channel_id,
813+
InboundChannelConfigOverrides::default(),
812814
)
813815
.unwrap();
814816
} else {

‎lightning/src/ln/async_signer_tests.rs‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@
1111
//! properly with a signer implementation that asynchronously derives signatures.
1212
1313
use crate::prelude::*;
14+
use crate::util::config::InboundChannelConfigOverrides;
1415
use bitcoin::secp256k1::Secp256k1;
1516
use bitcoin::{Transaction, TxOut, TxIn, Amount};
1617
use bitcoin::locktime::absolute::LockTime;
@@ -74,7 +75,7 @@ fn do_test_open_channel(zero_conf: bool) {
7475
match &events[0] {
7576
Event::OpenChannelRequest { temporary_channel_id, .. } => {
7677
nodes[1].node.accept_inbound_channel_from_trusted_peer_0conf(
77-
temporary_channel_id, &nodes[0].node.get_our_node_id(), 0)
78+
temporary_channel_id, &nodes[0].node.get_our_node_id(), 0, InboundChannelConfigOverrides::default())
7879
.expect("Unable to accept inbound zero-conf channel");
7980
},
8081
ev => panic!("Expected OpenChannelRequest, not {:?}", ev)
@@ -319,7 +320,7 @@ fn do_test_funding_signed_0conf(signer_ops: Vec<SignerOp>) {
319320
match &events[0] {
320321
Event::OpenChannelRequest { temporary_channel_id, .. } => {
321322
nodes[1].node.accept_inbound_channel_from_trusted_peer_0conf(
322-
temporary_channel_id, &nodes[0].node.get_our_node_id(), 0)
323+
temporary_channel_id, &nodes[0].node.get_our_node_id(), 0, InboundChannelConfigOverrides::default())
323324
.expect("Unable to accept inbound zero-conf channel");
324325
},
325326
ev => panic!("Expected OpenChannelRequest, not {:?}", ev)

‎lightning/src/ln/chanmon_update_fail_tests.rs‎

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,7 @@ use crate::ln::channel::AnnouncementSigsState;
2323
use crate::ln::msgs;
2424
use crate::ln::types::ChannelId;
2525
use crate::ln::msgs::{ChannelMessageHandler, RoutingMessageHandler};
26+
use crate::util::config::InboundChannelConfigOverrides;
2627
use crate::util::test_channel_signer::TestChannelSigner;
2728
use crate::util::ser::{ReadableArgs, Writeable};
2829
use crate::util::test_utils::TestBroadcaster;
@@ -2775,9 +2776,9 @@ fn do_test_outbound_reload_without_init_mon(use_0conf: bool) {
27752776
match events[0] {
27762777
Event::OpenChannelRequest { temporary_channel_id, .. } => {
27772778
if use_0conf {
2778-
nodes[1].node.accept_inbound_channel_from_trusted_peer_0conf(&temporary_channel_id, &nodes[0].node.get_our_node_id(), 0).unwrap();
2779+
nodes[1].node.accept_inbound_channel_from_trusted_peer_0conf(&temporary_channel_id, &nodes[0].node.get_our_node_id(), 0, InboundChannelConfigOverrides::default()).unwrap();
27792780
} else {
2780-
nodes[1].node.accept_inbound_channel(&temporary_channel_id, &nodes[0].node.get_our_node_id(), 0).unwrap();
2781+
nodes[1].node.accept_inbound_channel(&temporary_channel_id, &nodes[0].node.get_our_node_id(), 0, InboundChannelConfigOverrides::default()).unwrap();
27812782
}
27822783
},
27832784
_ => panic!("Unexpected event"),
@@ -2866,9 +2867,9 @@ fn do_test_inbound_reload_without_init_mon(use_0conf: bool, lock_commitment: boo
28662867
match events[0] {
28672868
Event::OpenChannelRequest { temporary_channel_id, .. } => {
28682869
if use_0conf {
2869-
nodes[1].node.accept_inbound_channel_from_trusted_peer_0conf(&temporary_channel_id, &nodes[0].node.get_our_node_id(), 0).unwrap();
2870+
nodes[1].node.accept_inbound_channel_from_trusted_peer_0conf(&temporary_channel_id, &nodes[0].node.get_our_node_id(), 0, InboundChannelConfigOverrides::default()).unwrap();
28702871
} else {
2871-
nodes[1].node.accept_inbound_channel(&temporary_channel_id, &nodes[0].node.get_our_node_id(), 0).unwrap();
2872+
nodes[1].node.accept_inbound_channel(&temporary_channel_id, &nodes[0].node.get_our_node_id(), 0, InboundChannelConfigOverrides::default()).unwrap();
28722873
}
28732874
},
28742875
_ => panic!("Unexpected event"),

‎lightning/src/ln/channelmanager.rs‎

Lines changed: 46 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,7 @@ use crate::onion_message::messenger::{Destination, MessageRouter, Responder, Res
7878
use crate::onion_message::offers::{OffersMessage, OffersMessageHandler};
7979
use crate::sign::{EntropySource, NodeSigner, Recipient, SignerProvider};
8080
use crate::sign::ecdsa::EcdsaChannelSigner;
81-
use crate::util::config::{UserConfig, ChannelConfig, ChannelConfigUpdate};
81+
use crate::util::config::{ChannelConfig, ChannelConfigUpdate, InboundChannelConfigOverrides, UserConfig};
8282
use crate::util::wakers::{Future, Notifier};
8383
use crate::util::scid_utils::fake_scid;
8484
use crate::util::string::UntrustedString;
@@ -1851,7 +1851,7 @@ where
18511851
///
18521852
/// ```
18531853
/// # use bitcoin::secp256k1::PublicKey;
1854-
/// # use lightning::ln::channelmanager::AChannelManager;
1854+
/// # use lightning::ln::channelmanager::{AChannelManager, InboundChannelConfigOverrides};
18551855
/// # use lightning::events::{Event, EventsProvider};
18561856
/// #
18571857
/// # fn is_trusted(counterparty_node_id: PublicKey) -> bool {
@@ -1877,7 +1877,7 @@ where
18771877
///
18781878
/// let user_channel_id = 43;
18791879
/// match channel_manager.accept_inbound_channel(
1880-
/// &temporary_channel_id, &counterparty_node_id, user_channel_id
1880+
/// &temporary_channel_id, &counterparty_node_id, user_channel_id, InboundChannelConfigOverrides::default()
18811881
/// ) {
18821882
/// Ok(()) => println!("Accepting channel {}", temporary_channel_id),
18831883
/// Err(e) => println!("Error accepting channel {}: {:?}", temporary_channel_id, e),
@@ -7699,8 +7699,8 @@ This indicates a bug inside LDK. Please report this error at https://github.com/
76997699
///
77007700
/// [`Event::OpenChannelRequest`]: events::Event::OpenChannelRequest
77017701
/// [`Event::ChannelClosed::user_channel_id`]: events::Event::ChannelClosed::user_channel_id
7702-
pub fn accept_inbound_channel(&self, temporary_channel_id: &ChannelId, counterparty_node_id: &PublicKey, user_channel_id: u128) -> Result<(), APIError> {
7703-
self.do_accept_inbound_channel(temporary_channel_id, counterparty_node_id, false, user_channel_id, vec![], Weight::from_wu(0))
7702+
pub fn accept_inbound_channel(&self, temporary_channel_id: &ChannelId, counterparty_node_id: &PublicKey, user_channel_id: u128, config_overrides: InboundChannelConfigOverrides) -> Result<(), APIError> {
7703+
self.do_accept_inbound_channel(temporary_channel_id, counterparty_node_id, false, user_channel_id, vec![], Weight::from_wu(0), config_overrides)
77047704
}
77057705

77067706
/// Accepts a request to open a channel after a [`events::Event::OpenChannelRequest`], treating
@@ -7721,15 +7721,19 @@ This indicates a bug inside LDK. Please report this error at https://github.com/
77217721
///
77227722
/// [`Event::OpenChannelRequest`]: events::Event::OpenChannelRequest
77237723
/// [`Event::ChannelClosed::user_channel_id`]: events::Event::ChannelClosed::user_channel_id
7724-
pub fn accept_inbound_channel_from_trusted_peer_0conf(&self, temporary_channel_id: &ChannelId, counterparty_node_id: &PublicKey, user_channel_id: u128) -> Result<(), APIError> {
7725-
self.do_accept_inbound_channel(temporary_channel_id, counterparty_node_id, true, user_channel_id, vec![], Weight::from_wu(0))
7724+
pub fn accept_inbound_channel_from_trusted_peer_0conf(&self, temporary_channel_id: &ChannelId, counterparty_node_id: &PublicKey, user_channel_id: u128, config_overrides: InboundChannelConfigOverrides) -> Result<(), APIError> {
7725+
self.do_accept_inbound_channel(temporary_channel_id, counterparty_node_id, true, user_channel_id, vec![], Weight::from_wu(0), config_overrides)
77267726
}
77277727

77287728
fn do_accept_inbound_channel(
77297729
&self, temporary_channel_id: &ChannelId, counterparty_node_id: &PublicKey, accept_0conf: bool,
77307730
user_channel_id: u128, _funding_inputs: Vec<(TxIn, TransactionU16LenLimited)>,
7731-
_total_witness_weight: Weight,
7731+
_total_witness_weight: Weight, config_overrides: InboundChannelConfigOverrides
77327732
) -> Result<(), APIError> {
7733+
7734+
// Apply configuration overrides.
7735+
let config: UserConfig = config_overrides.apply(&self.default_configuration);
7736+
77337737
let logger = WithContext::from(&self.logger, Some(*counterparty_node_id), Some(*temporary_channel_id), None);
77347738
let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
77357739

@@ -7759,7 +7763,7 @@ This indicates a bug inside LDK. Please report this error at https://github.com/
77597763
InboundV1Channel::new(
77607764
&self.fee_estimator, &self.entropy_source, &self.signer_provider, *counterparty_node_id,
77617765
&self.channel_type_features(), &peer_state.latest_features, &open_channel_msg,
7762-
user_channel_id, &self.default_configuration, best_block_height, &self.logger, accept_0conf
7766+
user_channel_id, &config, best_block_height, &self.logger, accept_0conf
77637767
).map_err(|err| MsgHandleErrInternal::from_chan_no_close(err, *temporary_channel_id)
77647768
).map(|mut channel| {
77657769
let logger = WithChannelContext::from(&self.logger, &channel.context, None);
@@ -14478,9 +14482,9 @@ mod tests {
1447814482
use crate::events::{Event, HTLCDestination, MessageSendEvent, MessageSendEventsProvider, ClosureReason};
1447914483
use crate::ln::types::ChannelId;
1448014484
use crate::types::payment::{PaymentPreimage, PaymentHash, PaymentSecret};
14481-
use crate::ln::channelmanager::{create_recv_pending_htlc_info, HTLCForwardInfo, inbound_payment, PaymentId, RecipientOnionFields, InterceptId};
14485+
use crate::ln::channelmanager::{create_recv_pending_htlc_info, inbound_payment, InboundChannelConfigOverrides, HTLCForwardInfo, InterceptId, PaymentId, RecipientOnionFields};
1448214486
use crate::ln::functional_test_utils::*;
14483-
use crate::ln::msgs::{self, ErrorAction};
14487+
use crate::ln::msgs::{self, AcceptChannel, ErrorAction};
1448414488
use crate::ln::msgs::ChannelMessageHandler;
1448514489
use crate::ln::outbound_payment::Retry;
1448614490
use crate::prelude::*;
@@ -15237,7 +15241,7 @@ mod tests {
1523715241
// Test the API functions.
1523815242
check_not_connected_to_peer_error(nodes[0].node.create_channel(unkown_public_key, 1_000_000, 500_000_000, 42, None, None), unkown_public_key);
1523915243

15240-
check_unkown_peer_error(nodes[0].node.accept_inbound_channel(&channel_id, &unkown_public_key, 42), unkown_public_key);
15244+
check_unkown_peer_error(nodes[0].node.accept_inbound_channel(&channel_id, &unkown_public_key, 42, InboundChannelConfigOverrides::default()), unkown_public_key);
1524115245

1524215246
check_unkown_peer_error(nodes[0].node.close_channel(&channel_id, &unkown_public_key), unkown_public_key);
1524315247

@@ -15268,7 +15272,7 @@ mod tests {
1526815272
let error_message = "Channel force-closed";
1526915273

1527015274
// Test the API functions.
15271-
check_api_misuse_error(nodes[0].node.accept_inbound_channel(&channel_id, &counterparty_node_id, 42));
15275+
check_api_misuse_error(nodes[0].node.accept_inbound_channel(&channel_id, &counterparty_node_id, 42, InboundChannelConfigOverrides::default()));
1527215276

1527315277
check_channel_unavailable_error(nodes[0].node.close_channel(&channel_id, &counterparty_node_id), channel_id, counterparty_node_id);
1527415278

@@ -15459,7 +15463,7 @@ mod tests {
1545915463
let events = nodes[1].node.get_and_clear_pending_events();
1546015464
match events[0] {
1546115465
Event::OpenChannelRequest { temporary_channel_id, .. } => {
15462-
nodes[1].node.accept_inbound_channel(&temporary_channel_id, &random_pk, 23).unwrap();
15466+
nodes[1].node.accept_inbound_channel(&temporary_channel_id, &random_pk, 23, InboundChannelConfigOverrides::default()).unwrap();
1546315467
}
1546415468
_ => panic!("Unexpected event"),
1546515469
}
@@ -15477,7 +15481,7 @@ mod tests {
1547715481
let events = nodes[1].node.get_and_clear_pending_events();
1547815482
match events[0] {
1547915483
Event::OpenChannelRequest { temporary_channel_id, .. } => {
15480-
match nodes[1].node.accept_inbound_channel(&temporary_channel_id, &last_random_pk, 23) {
15484+
match nodes[1].node.accept_inbound_channel(&temporary_channel_id, &last_random_pk, 23, InboundChannelConfigOverrides::default()) {
1548115485
Err(APIError::APIMisuseError { err }) =>
1548215486
assert_eq!(err, "Too many peers with unfunded channels, refusing to accept new ones"),
1548315487
_ => panic!(),
@@ -15493,7 +15497,7 @@ mod tests {
1549315497
let events = nodes[1].node.get_and_clear_pending_events();
1549415498
match events[0] {
1549515499
Event::OpenChannelRequest { temporary_channel_id, .. } => {
15496-
nodes[1].node.accept_inbound_channel_from_trusted_peer_0conf(&temporary_channel_id, &last_random_pk, 23).unwrap();
15500+
nodes[1].node.accept_inbound_channel_from_trusted_peer_0conf(&temporary_channel_id, &last_random_pk, 23, InboundChannelConfigOverrides::default()).unwrap();
1549715501
}
1549815502
_ => panic!("Unexpected event"),
1549915503
}
@@ -15573,6 +15577,30 @@ mod tests {
1557315577

1557415578
#[test]
1557515579
fn test_inbound_anchors_manual_acceptance() {
15580+
test_inbound_anchors_manual_acceptance_with_override(InboundChannelConfigOverrides::default());
15581+
}
15582+
15583+
#[test]
15584+
fn test_inbound_anchors_manual_acceptance_overridden() {
15585+
let overrides = InboundChannelConfigOverrides {
15586+
max_inbound_htlc_value_in_flight_percent_of_channel: Some(5),
15587+
htlc_minimum_msat: Some(1000),
15588+
minimum_depth: Some(2),
15589+
to_self_delay: Some(200),
15590+
max_accepted_htlcs: Some(5),
15591+
channel_reserve_proportional_millionths: Some(20000),
15592+
};
15593+
15594+
let accept_message = test_inbound_anchors_manual_acceptance_with_override(overrides);
15595+
assert_eq!(accept_message.common_fields.max_htlc_value_in_flight_msat, 5_000_000);
15596+
assert_eq!(accept_message.common_fields.htlc_minimum_msat, 1_000);
15597+
assert_eq!(accept_message.common_fields.minimum_depth, 2);
15598+
assert_eq!(accept_message.common_fields.to_self_delay, 200);
15599+
assert_eq!(accept_message.common_fields.max_accepted_htlcs, 5);
15600+
assert_eq!(accept_message.channel_reserve_satoshis, 2_000);
15601+
}
15602+
15603+
fn test_inbound_anchors_manual_acceptance_with_override(config_overrides: InboundChannelConfigOverrides) -> AcceptChannel {
1557615604
// Tests that we properly limit inbound channels when we have the manual-channel-acceptance
1557715605
// flag set and (sometimes) accept channels as 0conf.
1557815606
let mut anchors_cfg = test_default_channel_config();
@@ -15609,10 +15637,10 @@ mod tests {
1560915637
let events = nodes[2].node.get_and_clear_pending_events();
1561015638
match events[0] {
1561115639
Event::OpenChannelRequest { temporary_channel_id, .. } =>
15612-
nodes[2].node.accept_inbound_channel(&temporary_channel_id, &nodes[0].node.get_our_node_id(), 23).unwrap(),
15640+
nodes[2].node.accept_inbound_channel(&temporary_channel_id, &nodes[0].node.get_our_node_id(), 23, config_overrides).unwrap(),
1561315641
_ => panic!("Unexpected event"),
1561415642
}
15615-
get_event_msg!(nodes[2], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
15643+
get_event_msg!(nodes[2], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id())
1561615644
}
1561715645

1561815646
#[test]

‎lightning/src/ln/functional_test_utils.rs‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ use crate::onion_message::messenger::OnionMessenger;
2727
use crate::routing::gossip::{P2PGossipSync, NetworkGraph, NetworkUpdate};
2828
use crate::routing::router::{self, PaymentParameters, Route, RouteParameters};
2929
use crate::sign::{EntropySource, RandomBytes};
30-
use crate::util::config::{UserConfig, MaxDustHTLCExposure};
30+
use crate::util::config::{InboundChannelConfigOverrides, MaxDustHTLCExposure, UserConfig};
3131
#[cfg(test)]
3232
use crate::util::logger::Logger;
3333
use crate::util::scid_utils;
@@ -1321,7 +1321,7 @@ pub fn open_zero_conf_channel<'a, 'b, 'c, 'd>(initiator: &'a Node<'b, 'c, 'd>, r
13211321
assert_eq!(events.len(), 1);
13221322
match events[0] {
13231323
Event::OpenChannelRequest { temporary_channel_id, .. } => {
1324-
receiver.node.accept_inbound_channel_from_trusted_peer_0conf(&temporary_channel_id, &initiator.node.get_our_node_id(), 0).unwrap();
1324+
receiver.node.accept_inbound_channel_from_trusted_peer_0conf(&temporary_channel_id, &initiator.node.get_our_node_id(), 0, InboundChannelConfigOverrides::default()).unwrap();
13251325
},
13261326
_ => panic!("Unexpected event"),
13271327
};
@@ -1389,7 +1389,7 @@ pub fn exchange_open_accept_chan<'a, 'b, 'c>(node_a: &Node<'a, 'b, 'c>, node_b:
13891389
assert_eq!(events.len(), 1);
13901390
match &events[0] {
13911391
Event::OpenChannelRequest { temporary_channel_id, counterparty_node_id, .. } =>
1392-
node_b.node.accept_inbound_channel(temporary_channel_id, counterparty_node_id, 42).unwrap(),
1392+
node_b.node.accept_inbound_channel(temporary_channel_id, counterparty_node_id, 42, InboundChannelConfigOverrides::default()).unwrap(),
13931393
_ => panic!("Unexpected event"),
13941394
};
13951395
}

0 commit comments

Comments
 (0)