Skip to content

Commit 5014400

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 5014400

File tree

8 files changed

+143
-40
lines changed

8 files changed

+143
-40
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 & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ use crate::events::bump_transaction::WalletSource;
2323
use crate::events::{ClosureReason, Event, MessageSendEvent, MessageSendEventsProvider};
2424
use crate::ln::chan_utils::ClosingTransaction;
2525
use crate::ln::channel_state::{ChannelDetails, ChannelShutdownState};
26-
use crate::ln::channelmanager::{PaymentId, RAACommitmentOrder, RecipientOnionFields};
26+
use crate::ln::channelmanager::{InboundChannelConfigOverrides, PaymentId, RAACommitmentOrder, RecipientOnionFields};
2727
use crate::ln::msgs::ChannelMessageHandler;
2828
use crate::ln::{functional_test_utils::*, msgs};
2929
use crate::sign::ecdsa::EcdsaChannelSigner;
@@ -74,7 +74,7 @@ fn do_test_open_channel(zero_conf: bool) {
7474
match &events[0] {
7575
Event::OpenChannelRequest { temporary_channel_id, .. } => {
7676
nodes[1].node.accept_inbound_channel_from_trusted_peer_0conf(
77-
temporary_channel_id, &nodes[0].node.get_our_node_id(), 0)
77+
temporary_channel_id, &nodes[0].node.get_our_node_id(), 0, InboundChannelConfigOverrides::default())
7878
.expect("Unable to accept inbound zero-conf channel");
7979
},
8080
ev => panic!("Expected OpenChannelRequest, not {:?}", ev)
@@ -319,7 +319,7 @@ fn do_test_funding_signed_0conf(signer_ops: Vec<SignerOp>) {
319319
match &events[0] {
320320
Event::OpenChannelRequest { temporary_channel_id, .. } => {
321321
nodes[1].node.accept_inbound_channel_from_trusted_peer_0conf(
322-
temporary_channel_id, &nodes[0].node.get_our_node_id(), 0)
322+
temporary_channel_id, &nodes[0].node.get_our_node_id(), 0, InboundChannelConfigOverrides::default())
323323
.expect("Unable to accept inbound zero-conf channel");
324324
},
325325
ev => panic!("Expected OpenChannelRequest, not {:?}", ev)

‎lightning/src/ln/chanmon_update_fail_tests.rs‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ use bitcoin::network::Network;
1818
use crate::chain::channelmonitor::{ANTI_REORG_DELAY, ChannelMonitor};
1919
use crate::chain::{ChannelMonitorUpdateStatus, Listen, Watch};
2020
use crate::events::{Event, MessageSendEvent, MessageSendEventsProvider, PaymentPurpose, ClosureReason, HTLCDestination};
21-
use crate::ln::channelmanager::{PaymentId, RAACommitmentOrder, RecipientOnionFields};
21+
use crate::ln::channelmanager::{InboundChannelConfigOverrides, PaymentId, RAACommitmentOrder, RecipientOnionFields};
2222
use crate::ln::channel::AnnouncementSigsState;
2323
use crate::ln::msgs;
2424
use crate::ln::types::ChannelId;
@@ -2775,9 +2775,9 @@ fn do_test_outbound_reload_without_init_mon(use_0conf: bool) {
27752775
match events[0] {
27762776
Event::OpenChannelRequest { temporary_channel_id, .. } => {
27772777
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();
2778+
nodes[1].node.accept_inbound_channel_from_trusted_peer_0conf(&temporary_channel_id, &nodes[0].node.get_our_node_id(), 0, InboundChannelConfigOverrides::default()).unwrap();
27792779
} else {
2780-
nodes[1].node.accept_inbound_channel(&temporary_channel_id, &nodes[0].node.get_our_node_id(), 0).unwrap();
2780+
nodes[1].node.accept_inbound_channel(&temporary_channel_id, &nodes[0].node.get_our_node_id(), 0, InboundChannelConfigOverrides::default()).unwrap();
27812781
}
27822782
},
27832783
_ => panic!("Unexpected event"),
@@ -2866,9 +2866,9 @@ fn do_test_inbound_reload_without_init_mon(use_0conf: bool, lock_commitment: boo
28662866
match events[0] {
28672867
Event::OpenChannelRequest { temporary_channel_id, .. } => {
28682868
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();
2869+
nodes[1].node.accept_inbound_channel_from_trusted_peer_0conf(&temporary_channel_id, &nodes[0].node.get_our_node_id(), 0, InboundChannelConfigOverrides::default()).unwrap();
28702870
} else {
2871-
nodes[1].node.accept_inbound_channel(&temporary_channel_id, &nodes[0].node.get_our_node_id(), 0).unwrap();
2871+
nodes[1].node.accept_inbound_channel(&temporary_channel_id, &nodes[0].node.get_our_node_id(), 0, InboundChannelConfigOverrides::default()).unwrap();
28722872
}
28732873
},
28742874
_ => panic!("Unexpected event"),

‎lightning/src/ln/channelmanager.rs‎

Lines changed: 48 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;
@@ -132,6 +132,8 @@ pub use crate::ln::outbound_payment::{Bolt12PaymentError, ProbeSendFailure, Retr
132132
pub(crate) use crate::ln::outbound_payment::PaymentSendFailure;
133133
use crate::ln::script::ShutdownScript;
134134

135+
136+
135137
// We hold various information about HTLC relay in the HTLC objects in Channel itself:
136138
//
137139
// Upon receipt of an HTLC from a peer, we'll give it a PendingHTLCStatus indicating if it should
@@ -1851,7 +1853,7 @@ where
18511853
///
18521854
/// ```
18531855
/// # use bitcoin::secp256k1::PublicKey;
1854-
/// # use lightning::ln::channelmanager::AChannelManager;
1856+
/// # use lightning::ln::channelmanager::{AChannelManager, InboundChannelConfigOverrides};
18551857
/// # use lightning::events::{Event, EventsProvider};
18561858
/// #
18571859
/// # fn is_trusted(counterparty_node_id: PublicKey) -> bool {
@@ -1877,7 +1879,7 @@ where
18771879
///
18781880
/// let user_channel_id = 43;
18791881
/// match channel_manager.accept_inbound_channel(
1880-
/// &temporary_channel_id, &counterparty_node_id, user_channel_id
1882+
/// &temporary_channel_id, &counterparty_node_id, user_channel_id, InboundChannelConfigOverrides::default()
18811883
/// ) {
18821884
/// Ok(()) => println!("Accepting channel {}", temporary_channel_id),
18831885
/// Err(e) => println!("Error accepting channel {}: {:?}", temporary_channel_id, e),
@@ -7699,8 +7701,8 @@ This indicates a bug inside LDK. Please report this error at https://github.com/
76997701
///
77007702
/// [`Event::OpenChannelRequest`]: events::Event::OpenChannelRequest
77017703
/// [`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))
7704+
pub fn accept_inbound_channel(&self, temporary_channel_id: &ChannelId, counterparty_node_id: &PublicKey, user_channel_id: u128, config_overrides: InboundChannelConfigOverrides) -> Result<(), APIError> {
7705+
self.do_accept_inbound_channel(temporary_channel_id, counterparty_node_id, false, user_channel_id, vec![], Weight::from_wu(0), config_overrides)
77047706
}
77057707

77067708
/// Accepts a request to open a channel after a [`events::Event::OpenChannelRequest`], treating
@@ -7721,15 +7723,19 @@ This indicates a bug inside LDK. Please report this error at https://github.com/
77217723
///
77227724
/// [`Event::OpenChannelRequest`]: events::Event::OpenChannelRequest
77237725
/// [`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))
7726+
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> {
7727+
self.do_accept_inbound_channel(temporary_channel_id, counterparty_node_id, true, user_channel_id, vec![], Weight::from_wu(0), config_overrides)
77267728
}
77277729

77287730
fn do_accept_inbound_channel(
77297731
&self, temporary_channel_id: &ChannelId, counterparty_node_id: &PublicKey, accept_0conf: bool,
77307732
user_channel_id: u128, _funding_inputs: Vec<(TxIn, TransactionU16LenLimited)>,
7731-
_total_witness_weight: Weight,
7733+
_total_witness_weight: Weight, config_overrides: InboundChannelConfigOverrides
77327734
) -> Result<(), APIError> {
7735+
7736+
// Apply configuration overrides.
7737+
let config: UserConfig = config_overrides.apply(&self.default_configuration);
7738+
77337739
let logger = WithContext::from(&self.logger, Some(*counterparty_node_id), Some(*temporary_channel_id), None);
77347740
let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
77357741

@@ -7759,7 +7765,7 @@ This indicates a bug inside LDK. Please report this error at https://github.com/
77597765
InboundV1Channel::new(
77607766
&self.fee_estimator, &self.entropy_source, &self.signer_provider, *counterparty_node_id,
77617767
&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
7768+
user_channel_id, &config, best_block_height, &self.logger, accept_0conf
77637769
).map_err(|err| MsgHandleErrInternal::from_chan_no_close(err, *temporary_channel_id)
77647770
).map(|mut channel| {
77657771
let logger = WithChannelContext::from(&self.logger, &channel.context, None);
@@ -14478,9 +14484,9 @@ mod tests {
1447814484
use crate::events::{Event, HTLCDestination, MessageSendEvent, MessageSendEventsProvider, ClosureReason};
1447914485
use crate::ln::types::ChannelId;
1448014486
use crate::types::payment::{PaymentPreimage, PaymentHash, PaymentSecret};
14481-
use crate::ln::channelmanager::{create_recv_pending_htlc_info, HTLCForwardInfo, inbound_payment, PaymentId, RecipientOnionFields, InterceptId};
14487+
use crate::ln::channelmanager::{create_recv_pending_htlc_info, inbound_payment, InboundChannelConfigOverrides, HTLCForwardInfo, InterceptId, PaymentId, RecipientOnionFields};
1448214488
use crate::ln::functional_test_utils::*;
14483-
use crate::ln::msgs::{self, ErrorAction};
14489+
use crate::ln::msgs::{self, AcceptChannel, ErrorAction};
1448414490
use crate::ln::msgs::ChannelMessageHandler;
1448514491
use crate::ln::outbound_payment::Retry;
1448614492
use crate::prelude::*;
@@ -15237,7 +15243,7 @@ mod tests {
1523715243
// Test the API functions.
1523815244
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);
1523915245

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

1524215248
check_unkown_peer_error(nodes[0].node.close_channel(&channel_id, &unkown_public_key), unkown_public_key);
1524315249

@@ -15268,7 +15274,7 @@ mod tests {
1526815274
let error_message = "Channel force-closed";
1526915275

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

1527315279
check_channel_unavailable_error(nodes[0].node.close_channel(&channel_id, &counterparty_node_id), channel_id, counterparty_node_id);
1527415280

@@ -15459,7 +15465,7 @@ mod tests {
1545915465
let events = nodes[1].node.get_and_clear_pending_events();
1546015466
match events[0] {
1546115467
Event::OpenChannelRequest { temporary_channel_id, .. } => {
15462-
nodes[1].node.accept_inbound_channel(&temporary_channel_id, &random_pk, 23).unwrap();
15468+
nodes[1].node.accept_inbound_channel(&temporary_channel_id, &random_pk, 23, InboundChannelConfigOverrides::default()).unwrap();
1546315469
}
1546415470
_ => panic!("Unexpected event"),
1546515471
}
@@ -15477,7 +15483,7 @@ mod tests {
1547715483
let events = nodes[1].node.get_and_clear_pending_events();
1547815484
match events[0] {
1547915485
Event::OpenChannelRequest { temporary_channel_id, .. } => {
15480-
match nodes[1].node.accept_inbound_channel(&temporary_channel_id, &last_random_pk, 23) {
15486+
match nodes[1].node.accept_inbound_channel(&temporary_channel_id, &last_random_pk, 23, InboundChannelConfigOverrides::default()) {
1548115487
Err(APIError::APIMisuseError { err }) =>
1548215488
assert_eq!(err, "Too many peers with unfunded channels, refusing to accept new ones"),
1548315489
_ => panic!(),
@@ -15493,7 +15499,7 @@ mod tests {
1549315499
let events = nodes[1].node.get_and_clear_pending_events();
1549415500
match events[0] {
1549515501
Event::OpenChannelRequest { temporary_channel_id, .. } => {
15496-
nodes[1].node.accept_inbound_channel_from_trusted_peer_0conf(&temporary_channel_id, &last_random_pk, 23).unwrap();
15502+
nodes[1].node.accept_inbound_channel_from_trusted_peer_0conf(&temporary_channel_id, &last_random_pk, 23, InboundChannelConfigOverrides::default()).unwrap();
1549715503
}
1549815504
_ => panic!("Unexpected event"),
1549915505
}
@@ -15573,6 +15579,30 @@ mod tests {
1557315579

1557415580
#[test]
1557515581
fn test_inbound_anchors_manual_acceptance() {
15582+
test_inbound_anchors_manual_acceptance_with_override(InboundChannelConfigOverrides::default());
15583+
}
15584+
15585+
#[test]
15586+
fn test_inbound_anchors_manual_acceptance_overridden() {
15587+
let overrides = InboundChannelConfigOverrides {
15588+
max_inbound_htlc_value_in_flight_percent_of_channel: Some(5),
15589+
htlc_minimum_msat: Some(1000),
15590+
minimum_depth: Some(2),
15591+
to_self_delay: Some(200),
15592+
max_accepted_htlcs: Some(5),
15593+
channel_reserve_proportional_millionths: Some(20000),
15594+
};
15595+
15596+
let accept_message = test_inbound_anchors_manual_acceptance_with_override(overrides);
15597+
assert_eq!(accept_message.common_fields.max_htlc_value_in_flight_msat, 5_000_000);
15598+
assert_eq!(accept_message.common_fields.htlc_minimum_msat, 1_000);
15599+
assert_eq!(accept_message.common_fields.minimum_depth, 2);
15600+
assert_eq!(accept_message.common_fields.to_self_delay, 200);
15601+
assert_eq!(accept_message.common_fields.max_accepted_htlcs, 5);
15602+
assert_eq!(accept_message.channel_reserve_satoshis, 2_000);
15603+
}
15604+
15605+
fn test_inbound_anchors_manual_acceptance_with_override(config_overrides: InboundChannelConfigOverrides) -> AcceptChannel {
1557615606
// Tests that we properly limit inbound channels when we have the manual-channel-acceptance
1557715607
// flag set and (sometimes) accept channels as 0conf.
1557815608
let mut anchors_cfg = test_default_channel_config();
@@ -15609,10 +15639,10 @@ mod tests {
1560915639
let events = nodes[2].node.get_and_clear_pending_events();
1561015640
match events[0] {
1561115641
Event::OpenChannelRequest { temporary_channel_id, .. } =>
15612-
nodes[2].node.accept_inbound_channel(&temporary_channel_id, &nodes[0].node.get_our_node_id(), 23).unwrap(),
15642+
nodes[2].node.accept_inbound_channel(&temporary_channel_id, &nodes[0].node.get_our_node_id(), 23, config_overrides).unwrap(),
1561315643
_ => panic!("Unexpected event"),
1561415644
}
15615-
get_event_msg!(nodes[2], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
15645+
get_event_msg!(nodes[2], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id())
1561615646
}
1561715647

1561815648
#[test]

‎lightning/src/ln/functional_test_utils.rs‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,7 @@ use crate::util::test_channel_signer::SignerOp;
3737
use crate::util::test_utils;
3838
use crate::util::test_utils::{TestChainMonitor, TestScorer, TestKeysInterface};
3939
use crate::util::ser::{ReadableArgs, Writeable};
40+
use crate::ln::channelmanager::InboundChannelConfigOverrides;
4041

4142
use bitcoin::WPubkeyHash;
4243
use bitcoin::amount::Amount;
@@ -1321,7 +1322,7 @@ pub fn open_zero_conf_channel<'a, 'b, 'c, 'd>(initiator: &'a Node<'b, 'c, 'd>, r
13211322
assert_eq!(events.len(), 1);
13221323
match events[0] {
13231324
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();
1325+
receiver.node.accept_inbound_channel_from_trusted_peer_0conf(&temporary_channel_id, &initiator.node.get_our_node_id(), 0, InboundChannelConfigOverrides::default()).unwrap();
13251326
},
13261327
_ => panic!("Unexpected event"),
13271328
};
@@ -1389,7 +1390,7 @@ pub fn exchange_open_accept_chan<'a, 'b, 'c>(node_a: &Node<'a, 'b, 'c>, node_b:
13891390
assert_eq!(events.len(), 1);
13901391
match &events[0] {
13911392
Event::OpenChannelRequest { temporary_channel_id, counterparty_node_id, .. } =>
1392-
node_b.node.accept_inbound_channel(temporary_channel_id, counterparty_node_id, 42).unwrap(),
1393+
node_b.node.accept_inbound_channel(temporary_channel_id, counterparty_node_id, 42, InboundChannelConfigOverrides::default()).unwrap(),
13931394
_ => panic!("Unexpected event"),
13941395
};
13951396
}

0 commit comments

Comments
 (0)