Skip to content

Replace OUR_MAX_HTLCS with config knob#2138

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
TheBlueMatt merged 1 commit into from
Apr 17, 2023
Merged

Replace OUR_MAX_HTLCS with config knob #2138

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 22 additions & 11 deletions lightning/src/ln/channel.rs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -653,7 +653,7 @@ pub(super) struct Channel<Signer: ChannelSigner> {
pub counterparty_max_accepted_htlcs: u16,
#[cfg(not(test))]
counterparty_max_accepted_htlcs: u16,
//implied by OUR_MAX_HTLCS: max_accepted_htlcs: u16,
holder_max_accepted_htlcs: u16,
minimum_depth: Option<u32>,

counterparty_forwarding_info: Option<CounterpartyForwardingInfo>,
Expand DownExpand Up@@ -756,7 +756,7 @@ struct CommitmentTxInfoCached {
feerate: u32,
}

pub const OUR_MAX_HTLCS: u16 = 50; //TODO
Comment thread
swilliamson5 marked this conversation as resolved.
pub const DEFAULT_MAX_HTLCS: u16 = 50;

pub(crate) fn commitment_tx_base_weight(opt_anchors: bool) -> u64 {
const COMMITMENT_TX_BASE_WEIGHT: u64 = 724;
Expand DownExpand Up@@ -1072,6 +1072,7 @@ impl<Signer: WriteableEcdsaChannelSigner> Channel<Signer> {
counterparty_htlc_minimum_msat: 0,
holder_htlc_minimum_msat: if config.channel_handshake_config.our_htlc_minimum_msat == 0 { 1 } else { config.channel_handshake_config.our_htlc_minimum_msat },
counterparty_max_accepted_htlcs: 0,
holder_max_accepted_htlcs: cmp::min(config.channel_handshake_config.our_max_accepted_htlcs, MAX_HTLCS),
minimum_depth: None, // Filled in in accept_channel

counterparty_forwarding_info: None,
Expand DownExpand Up@@ -1419,6 +1420,7 @@ impl<Signer: WriteableEcdsaChannelSigner> Channel<Signer> {
counterparty_htlc_minimum_msat: msg.htlc_minimum_msat,
holder_htlc_minimum_msat: if config.channel_handshake_config.our_htlc_minimum_msat == 0 { 1 } else { config.channel_handshake_config.our_htlc_minimum_msat },
counterparty_max_accepted_htlcs: msg.max_accepted_htlcs,
holder_max_accepted_htlcs: cmp::min(config.channel_handshake_config.our_max_accepted_htlcs, MAX_HTLCS),
minimum_depth: Some(cmp::max(config.channel_handshake_config.minimum_depth, 1)),

counterparty_forwarding_info: None,
Expand DownExpand Up@@ -2874,8 +2876,8 @@ impl<Signer: WriteableEcdsaChannelSigner> Channel<Signer> {

let inbound_stats = self.get_inbound_pending_htlc_stats(None);
let outbound_stats = self.get_outbound_pending_htlc_stats(None);
if inbound_stats.pending_htlcs + 1 > OUR_MAX_HTLCS as u32 {
return Err(ChannelError::Close(format!("Remote tried to push more than our max accepted HTLCs ({})", OUR_MAX_HTLCS)));
if inbound_stats.pending_htlcs + 1 > self.holder_max_accepted_htlcs as u32 {
return Err(ChannelError::Close(format!("Remote tried to push more than our max accepted HTLCs ({})", self.holder_max_accepted_htlcs)));
}
if inbound_stats.pending_htlcs_value_msat + msg.amount_msat > self.holder_max_htlc_value_in_flight_msat {
return Err(ChannelError::Close(format!("Remote HTLC add would put them over our max HTLC value ({})", self.holder_max_htlc_value_in_flight_msat)));
Expand DownExpand Up@@ -5313,7 +5315,7 @@ impl<Signer: WriteableEcdsaChannelSigner> Channel<Signer> {
htlc_minimum_msat: self.holder_htlc_minimum_msat,
feerate_per_kw: self.feerate_per_kw as u32,
to_self_delay: self.get_holder_selected_contest_delay(),
max_accepted_htlcs: OUR_MAX_HTLCS,
max_accepted_htlcs: self.holder_max_accepted_htlcs,
funding_pubkey: keys.funding_pubkey,
revocation_basepoint: keys.revocation_basepoint,
payment_point: keys.payment_point,
Expand DownExpand Up@@ -5380,7 +5382,7 @@ impl<Signer: WriteableEcdsaChannelSigner> Channel<Signer> {
htlc_minimum_msat: self.holder_htlc_minimum_msat,
minimum_depth: self.minimum_depth.unwrap(),
to_self_delay: self.get_holder_selected_contest_delay(),
max_accepted_htlcs: OUR_MAX_HTLCS,
max_accepted_htlcs: self.holder_max_accepted_htlcs,
funding_pubkey: keys.funding_pubkey,
revocation_basepoint: keys.revocation_basepoint,
payment_point: keys.payment_point,
Expand DownExpand Up@@ -6496,6 +6498,8 @@ impl<Signer: WriteableEcdsaChannelSigner> Writeable for Channel<Signer> {
// we write the high bytes as an option here.
let user_id_high_opt = Some((self.user_id >> 64) as u64);

let holder_max_accepted_htlcs = if self.holder_max_accepted_htlcs == DEFAULT_MAX_HTLCS { None } else { Some(self.holder_max_accepted_htlcs) };

write_tlv_fields!(writer, {
(0, self.announcement_sigs, option),
// minimum_depth and counterparty_selected_channel_reserve_satoshis used to have a
Expand All@@ -6521,6 +6525,7 @@ impl<Signer: WriteableEcdsaChannelSigner> Writeable for Channel<Signer> {
(23, channel_ready_event_emitted, option),
(25, user_id_high_opt, option),
(27, self.channel_keys_id, required),
(28, holder_max_accepted_htlcs, option),
(29, self.temporary_channel_id, option),
(31, channel_pending_event_emitted, option),
});
Expand DownExpand Up@@ -6589,7 +6594,8 @@ impl<'a, 'b, 'c, ES: Deref, SP: Deref> ReadableArgs<(&'a ES, &'b SP, u32, &'c Ch
let value_to_self_msat = Readable::read(reader)?;

let pending_inbound_htlc_count: u64 = Readable::read(reader)?;
let mut pending_inbound_htlcs = Vec::with_capacity(cmp::min(pending_inbound_htlc_count as usize, OUR_MAX_HTLCS as usize));

let mut pending_inbound_htlcs = Vec::with_capacity(cmp::min(pending_inbound_htlc_count as usize, DEFAULT_MAX_HTLCS as usize));
for _ in 0..pending_inbound_htlc_count {
pending_inbound_htlcs.push(InboundHTLCOutput {
htlc_id: Readable::read(reader)?,
Expand All@@ -6607,7 +6613,7 @@ impl<'a, 'b, 'c, ES: Deref, SP: Deref> ReadableArgs<(&'a ES, &'b SP, u32, &'c Ch
}

let pending_outbound_htlc_count: u64 = Readable::read(reader)?;
let mut pending_outbound_htlcs = Vec::with_capacity(cmp::min(pending_outbound_htlc_count as usize, OUR_MAX_HTLCS as usize));
let mut pending_outbound_htlcs = Vec::with_capacity(cmp::min(pending_outbound_htlc_count as usize, DEFAULT_MAX_HTLCS as usize));
for _ in 0..pending_outbound_htlc_count {
pending_outbound_htlcs.push(OutboundHTLCOutput {
htlc_id: Readable::read(reader)?,
Expand DownExpand Up@@ -6636,7 +6642,7 @@ impl<'a, 'b, 'c, ES: Deref, SP: Deref> ReadableArgs<(&'a ES, &'b SP, u32, &'c Ch
}

let holding_cell_htlc_update_count: u64 = Readable::read(reader)?;
let mut holding_cell_htlc_updates = Vec::with_capacity(cmp::min(holding_cell_htlc_update_count as usize, OUR_MAX_HTLCS as usize*2));
let mut holding_cell_htlc_updates = Vec::with_capacity(cmp::min(holding_cell_htlc_update_count as usize, DEFAULT_MAX_HTLCS as usize*2));
for _ in 0..holding_cell_htlc_update_count {
holding_cell_htlc_updates.push(match <u8 as Readable>::read(reader)? {
0 => HTLCUpdateAwaitingACK::AddHTLC {
Expand DownExpand Up@@ -6669,13 +6675,13 @@ impl<'a, 'b, 'c, ES: Deref, SP: Deref> ReadableArgs<(&'a ES, &'b SP, u32, &'c Ch
let monitor_pending_commitment_signed = Readable::read(reader)?;

let monitor_pending_forwards_count: u64 = Readable::read(reader)?;
let mut monitor_pending_forwards = Vec::with_capacity(cmp::min(monitor_pending_forwards_count as usize, OUR_MAX_HTLCS as usize));
let mut monitor_pending_forwards = Vec::with_capacity(cmp::min(monitor_pending_forwards_count as usize, DEFAULT_MAX_HTLCS as usize));
for _ in 0..monitor_pending_forwards_count {
monitor_pending_forwards.push((Readable::read(reader)?, Readable::read(reader)?));
}

let monitor_pending_failures_count: u64 = Readable::read(reader)?;
let mut monitor_pending_failures = Vec::with_capacity(cmp::min(monitor_pending_failures_count as usize, OUR_MAX_HTLCS as usize));
let mut monitor_pending_failures = Vec::with_capacity(cmp::min(monitor_pending_failures_count as usize, DEFAULT_MAX_HTLCS as usize));
for _ in 0..monitor_pending_failures_count {
monitor_pending_failures.push((Readable::read(reader)?, Readable::read(reader)?, Readable::read(reader)?));
}
Expand DownExpand Up@@ -6796,6 +6802,7 @@ impl<'a, 'b, 'c, ES: Deref, SP: Deref> ReadableArgs<(&'a ES, &'b SP, u32, &'c Ch
let mut user_id_high_opt: Option<u64> = None;
let mut channel_keys_id: Option<[u8; 32]> = None;
let mut temporary_channel_id: Option<[u8; 32]> = None;
let mut holder_max_accepted_htlcs: Option<u16> = None;

read_tlv_fields!(reader, {
(0, announcement_sigs, option),
Expand All@@ -6816,6 +6823,7 @@ impl<'a, 'b, 'c, ES: Deref, SP: Deref> ReadableArgs<(&'a ES, &'b SP, u32, &'c Ch
(23, channel_ready_event_emitted, option),
(25, user_id_high_opt, option),
(27, channel_keys_id, option),
(28, holder_max_accepted_htlcs, option),
(29, temporary_channel_id, option),
(31, channel_pending_event_emitted, option),
});
Expand DownExpand Up@@ -6870,6 +6878,8 @@ impl<'a, 'b, 'c, ES: Deref, SP: Deref> ReadableArgs<(&'a ES, &'b SP, u32, &'c Ch
// separate u64 values.
let user_id = user_id_low as u128 + ((user_id_high_opt.unwrap_or(0) as u128) << 64);

let holder_max_accepted_htlcs = holder_max_accepted_htlcs.unwrap_or(DEFAULT_MAX_HTLCS);

Ok(Channel {
user_id,

Expand DownExpand Up@@ -6898,6 +6908,7 @@ impl<'a, 'b, 'c, ES: Deref, SP: Deref> ReadableArgs<(&'a ES, &'b SP, u32, &'c Ch
cur_counterparty_commitment_transaction_number,
value_to_self_msat,

holder_max_accepted_htlcs,
pending_inbound_htlcs,
pending_outbound_htlcs,
holding_cell_htlc_updates,
Expand Down
6 changes: 3 additions & 3 deletions lightning/src/ln/functional_tests.rs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -1107,7 +1107,7 @@ fn holding_cell_htlc_counting() {
let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2);

let mut payments = Vec::new();
for _ in 0..crate::ln::channel::OUR_MAX_HTLCS {
for _ in 0..50 {
let (route, payment_hash, payment_preimage, payment_secret) = get_route_and_payment_hash!(nodes[1], nodes[2], 100000);
nodes[1].node.send_payment_with_route(&route, payment_hash,
RecipientOnionFields::secret_only(payment_secret), PaymentId(payment_hash.0)).unwrap();
Expand DownExpand Up@@ -6278,11 +6278,11 @@ fn test_update_add_htlc_bolt2_receiver_check_max_htlc_limit() {
onion_routing_packet: onion_packet.clone(),
};

for i in 0..super::channel::OUR_MAX_HTLCS {
for i in 0..50 {
msg.htlc_id = i as u64;
nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &msg);
}
msg.htlc_id = (super::channel::OUR_MAX_HTLCS) as u64;
msg.htlc_id = (50) as u64;
nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &msg);

assert!(nodes[1].node.list_channels().is_empty());
Expand Down
14 changes: 14 additions & 0 deletions lightning/src/util/config.rs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -170,6 +170,19 @@ pub struct ChannelHandshakeConfig {
/// [`DecodeError::InvalidValue`]: crate::ln::msgs::DecodeError::InvalidValue
/// [`SIGHASH_SINGLE + update_fee Considered Harmful`]: https://lists.linuxfoundation.org/pipermail/lightning-dev/2020-September/002796.html
pub negotiate_anchors_zero_fee_htlc_tx: bool,

/// The maximum number of HTLCs in-flight from our counterparty towards us at the same time.
///
/// Increasing the value can help improve liquidity and stability in
/// routing at the cost of higher long term disk / DB usage.
///
/// Note: Versions of LDK earlier than v0.0.115 will fail to read channels with a configuration
/// other than the default value.
///
/// Default value: 50
Comment thread
swilliamson5 marked this conversation as resolved.
/// Maximum value: 483, any values larger will be treated as 483.
/// This is the BOLT #2 spec limit on `max_accepted_htlcs`.
pub our_max_accepted_htlcs: u16,
}

impl Default for ChannelHandshakeConfig {
Expand All@@ -185,6 +198,7 @@ impl Default for ChannelHandshakeConfig {
their_channel_reserve_proportional_millionths: 10_000,
#[cfg(anchors)]
negotiate_anchors_zero_fee_htlc_tx: false,
our_max_accepted_htlcs: 50,
}
}
}
Expand Down
, 'i'); if (__m === '*' || __re.test(location.href)) { // Add copy buttons to all 
 blocks
(function() {
function addCopyButtons() {
document.querySelectorAll('pre code').forEach(function(codeBlock) {
if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;
codeBlock.parentElement.setAttribute('data-copy-added', 'true');
var btn = document.createElement('button');
btn.textContent = 'Copy';
btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';
btn.onmouseover = function() { this.style.opacity = '1'; };
btn.onmouseout = function() { this.style.opacity = '0.7'; };
btn.onclick = function() {
navigator.clipboard.writeText(codeBlock.textContent).then(function() {
btn.textContent = 'Copied!';
setTimeout(function() { btn.textContent = 'Copy'; }, 1500);
});
};
codeBlock.parentElement.style.position = 'relative';
codeBlock.parentElement.appendChild(btn);
});
}
addCopyButtons();
// Re-run on dynamic content
var observer = new MutationObserver(addCopyButtons);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
Replace `OUR_MAX_HTLCS` with config knob by swilliamson5 · Pull Request #2138 · lightningdevkit/rust-lightning · GitHub
Skip to content
Replace OUR_MAX_HTLCS with config knob#2138

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

TheBlueMatt
merged 1 commit into

from

Apr 17, 2023
 Merged


Replace OUR_MAX_HTLCS with config knob
#2138
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


33 changes: 22 additions & 11 deletions
lightning/src/ln/channel.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -653,7 +653,7 @@ pub(super) struct Channel<Signer: ChannelSigner> {
	pub counterparty_max_accepted_htlcs: u16,
	#[cfg(not(test))]
	counterparty_max_accepted_htlcs: u16,
//implied by OUR_MAX_HTLCS: max_accepted_htlcs: u16,
holder_max_accepted_htlcs: u16,
	minimum_depth: Option<u32>,

	counterparty_forwarding_info: Option<CounterpartyForwardingInfo>,
Expand DownExpand Up@@ -756,7 +756,7 @@ struct CommitmentTxInfoCached {
	feerate: u32,
}

pub const OUR_MAX_HTLCS: u16 = 50; //TODO
Comment thread
swilliamson5 marked this conversation as resolved.

pub const DEFAULT_MAX_HTLCS: u16 = 50;

pub(crate) fn commitment_tx_base_weight(opt_anchors: bool) -> u64 {
	const COMMITMENT_TX_BASE_WEIGHT: u64 = 724;
Expand DownExpand Up@@ -1072,6 +1072,7 @@ impl<Signer: WriteableEcdsaChannelSigner> Channel<Signer> {
 counterparty_htlc_minimum_msat: 0,
 holder_htlc_minimum_msat: if config.channel_handshake_config.our_htlc_minimum_msat == 0 { 1 } else { config.channel_handshake_config.our_htlc_minimum_msat },
 counterparty_max_accepted_htlcs: 0,
 holder_max_accepted_htlcs: cmp::min(config.channel_handshake_config.our_max_accepted_htlcs, MAX_HTLCS),
 minimum_depth: None, // Filled in in accept_channel

 counterparty_forwarding_info: None,
Expand DownExpand Up@@ -1419,6 +1420,7 @@ impl<Signer: WriteableEcdsaChannelSigner> Channel<Signer> {
 counterparty_htlc_minimum_msat: msg.htlc_minimum_msat,
 holder_htlc_minimum_msat: if config.channel_handshake_config.our_htlc_minimum_msat == 0 { 1 } else { config.channel_handshake_config.our_htlc_minimum_msat },
 counterparty_max_accepted_htlcs: msg.max_accepted_htlcs,
 holder_max_accepted_htlcs: cmp::min(config.channel_handshake_config.our_max_accepted_htlcs, MAX_HTLCS),
 minimum_depth: Some(cmp::max(config.channel_handshake_config.minimum_depth, 1)),

 counterparty_forwarding_info: None,
Expand DownExpand Up@@ -2874,8 +2876,8 @@ impl<Signer: WriteableEcdsaChannelSigner> Channel<Signer> {

 let inbound_stats = self.get_inbound_pending_htlc_stats(None);
 let outbound_stats = self.get_outbound_pending_htlc_stats(None);
 if inbound_stats.pending_htlcs + 1 > OUR_MAX_HTLCS as u32 {
 return Err(ChannelError::Close(format!("Remote tried to push more than our max accepted HTLCs ({})", OUR_MAX_HTLCS)));
 if inbound_stats.pending_htlcs + 1 > self.holder_max_accepted_htlcs as u32 {
 return Err(ChannelError::Close(format!("Remote tried to push more than our max accepted HTLCs ({})", self.holder_max_accepted_htlcs)));
 }
 if inbound_stats.pending_htlcs_value_msat + msg.amount_msat > self.holder_max_htlc_value_in_flight_msat {
 return Err(ChannelError::Close(format!("Remote HTLC add would put them over our max HTLC value ({})", self.holder_max_htlc_value_in_flight_msat)));
Expand DownExpand Up@@ -5313,7 +5315,7 @@ impl<Signer: WriteableEcdsaChannelSigner> Channel<Signer> {
 htlc_minimum_msat: self.holder_htlc_minimum_msat,
 feerate_per_kw: self.feerate_per_kw as u32,
 to_self_delay: self.get_holder_selected_contest_delay(),
 max_accepted_htlcs: OUR_MAX_HTLCS,
 max_accepted_htlcs: self.holder_max_accepted_htlcs,
 funding_pubkey: keys.funding_pubkey,
 revocation_basepoint: keys.revocation_basepoint,
 payment_point: keys.payment_point,
Expand DownExpand Up@@ -5380,7 +5382,7 @@ impl<Signer: WriteableEcdsaChannelSigner> Channel<Signer> {
 htlc_minimum_msat: self.holder_htlc_minimum_msat,
 minimum_depth: self.minimum_depth.unwrap(),
 to_self_delay: self.get_holder_selected_contest_delay(),
 max_accepted_htlcs: OUR_MAX_HTLCS,
 max_accepted_htlcs: self.holder_max_accepted_htlcs,
 funding_pubkey: keys.funding_pubkey,
 revocation_basepoint: keys.revocation_basepoint,
 payment_point: keys.payment_point,
Expand DownExpand Up@@ -6496,6 +6498,8 @@ impl<Signer: WriteableEcdsaChannelSigner> Writeable for Channel<Signer> {
 // we write the high bytes as an option here.
 let user_id_high_opt = Some((self.user_id >> 64) as u64);

 let holder_max_accepted_htlcs = if self.holder_max_accepted_htlcs == DEFAULT_MAX_HTLCS { None } else { Some(self.holder_max_accepted_htlcs) };

 write_tlv_fields!(writer, {
 (0, self.announcement_sigs, option),
 // minimum_depth and counterparty_selected_channel_reserve_satoshis used to have a
Expand All@@ -6521,6 +6525,7 @@ impl<Signer: WriteableEcdsaChannelSigner> Writeable for Channel<Signer> {
 (23, channel_ready_event_emitted, option),
 (25, user_id_high_opt, option),
 (27, self.channel_keys_id, required),
 (28, holder_max_accepted_htlcs, option),
 (29, self.temporary_channel_id, option),
 (31, channel_pending_event_emitted, option),
 });
Expand DownExpand Up@@ -6589,7 +6594,8 @@ impl<'a, 'b, 'c, ES: Deref, SP: Deref> ReadableArgs<(&'a ES, &'b SP, u32, &'c Ch
 let value_to_self_msat = Readable::read(reader)?;

 let pending_inbound_htlc_count: u64 = Readable::read(reader)?;
 let mut pending_inbound_htlcs = Vec::with_capacity(cmp::min(pending_inbound_htlc_count as usize, OUR_MAX_HTLCS as usize));

 let mut pending_inbound_htlcs = Vec::with_capacity(cmp::min(pending_inbound_htlc_count as usize, DEFAULT_MAX_HTLCS as usize));
 for _ in 0..pending_inbound_htlc_count {
 pending_inbound_htlcs.push(InboundHTLCOutput {
 htlc_id: Readable::read(reader)?,
Expand All@@ -6607,7 +6613,7 @@ impl<'a, 'b, 'c, ES: Deref, SP: Deref> ReadableArgs<(&'a ES, &'b SP, u32, &'c Ch
 }

 let pending_outbound_htlc_count: u64 = Readable::read(reader)?;
 let mut pending_outbound_htlcs = Vec::with_capacity(cmp::min(pending_outbound_htlc_count as usize, OUR_MAX_HTLCS as usize));
 let mut pending_outbound_htlcs = Vec::with_capacity(cmp::min(pending_outbound_htlc_count as usize, DEFAULT_MAX_HTLCS as usize));
 for _ in 0..pending_outbound_htlc_count {
 pending_outbound_htlcs.push(OutboundHTLCOutput {
 htlc_id: Readable::read(reader)?,
Expand DownExpand Up@@ -6636,7 +6642,7 @@ impl<'a, 'b, 'c, ES: Deref, SP: Deref> ReadableArgs<(&'a ES, &'b SP, u32, &'c Ch
 }

 let holding_cell_htlc_update_count: u64 = Readable::read(reader)?;
 let mut holding_cell_htlc_updates = Vec::with_capacity(cmp::min(holding_cell_htlc_update_count as usize, OUR_MAX_HTLCS as usize*2));
 let mut holding_cell_htlc_updates = Vec::with_capacity(cmp::min(holding_cell_htlc_update_count as usize, DEFAULT_MAX_HTLCS as usize*2));
 for _ in 0..holding_cell_htlc_update_count {
 holding_cell_htlc_updates.push(match <u8 as Readable>::read(reader)? {
 0 => HTLCUpdateAwaitingACK::AddHTLC {
Expand DownExpand Up@@ -6669,13 +6675,13 @@ impl<'a, 'b, 'c, ES: Deref, SP: Deref> ReadableArgs<(&'a ES, &'b SP, u32, &'c Ch
 let monitor_pending_commitment_signed = Readable::read(reader)?;

 let monitor_pending_forwards_count: u64 = Readable::read(reader)?;
 let mut monitor_pending_forwards = Vec::with_capacity(cmp::min(monitor_pending_forwards_count as usize, OUR_MAX_HTLCS as usize));
 let mut monitor_pending_forwards = Vec::with_capacity(cmp::min(monitor_pending_forwards_count as usize, DEFAULT_MAX_HTLCS as usize));
 for _ in 0..monitor_pending_forwards_count {
 monitor_pending_forwards.push((Readable::read(reader)?, Readable::read(reader)?));
 }

 let monitor_pending_failures_count: u64 = Readable::read(reader)?;
 let mut monitor_pending_failures = Vec::with_capacity(cmp::min(monitor_pending_failures_count as usize, OUR_MAX_HTLCS as usize));
 let mut monitor_pending_failures = Vec::with_capacity(cmp::min(monitor_pending_failures_count as usize, DEFAULT_MAX_HTLCS as usize));
 for _ in 0..monitor_pending_failures_count {
 monitor_pending_failures.push((Readable::read(reader)?, Readable::read(reader)?, Readable::read(reader)?));
 }
Expand DownExpand Up@@ -6796,6 +6802,7 @@ impl<'a, 'b, 'c, ES: Deref, SP: Deref> ReadableArgs<(&'a ES, &'b SP, u32, &'c Ch
 let mut user_id_high_opt: Option<u64> = None;
 let mut channel_keys_id: Option<[u8; 32]> = None;
 let mut temporary_channel_id: Option<[u8; 32]> = None;
 let mut holder_max_accepted_htlcs: Option<u16> = None;

 read_tlv_fields!(reader, {
 (0, announcement_sigs, option),
Expand All@@ -6816,6 +6823,7 @@ impl<'a, 'b, 'c, ES: Deref, SP: Deref> ReadableArgs<(&'a ES, &'b SP, u32, &'c Ch
 (23, channel_ready_event_emitted, option),
 (25, user_id_high_opt, option),
 (27, channel_keys_id, option),
 (28, holder_max_accepted_htlcs, option),
 (29, temporary_channel_id, option),
 (31, channel_pending_event_emitted, option),
 });
Expand DownExpand Up@@ -6870,6 +6878,8 @@ impl<'a, 'b, 'c, ES: Deref, SP: Deref> ReadableArgs<(&'a ES, &'b SP, u32, &'c Ch
 // separate u64 values.
 let user_id = user_id_low as u128 + ((user_id_high_opt.unwrap_or(0) as u128) << 64);

 let holder_max_accepted_htlcs = holder_max_accepted_htlcs.unwrap_or(DEFAULT_MAX_HTLCS);

 Ok(Channel {
 user_id,

Expand DownExpand Up@@ -6898,6 +6908,7 @@ impl<'a, 'b, 'c, ES: Deref, SP: Deref> ReadableArgs<(&'a ES, &'b SP, u32, &'c Ch
 cur_counterparty_commitment_transaction_number,
 value_to_self_msat,

 holder_max_accepted_htlcs,
 pending_inbound_htlcs,
 pending_outbound_htlcs,
 holding_cell_htlc_updates,
Expand Down

6 changes: 3 additions & 3 deletions
lightning/src/ln/functional_tests.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1107,7 +1107,7 @@ fn holding_cell_htlc_counting() {
	let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2);

	let mut payments = Vec::new();
	for _ in 0..crate::ln::channel::OUR_MAX_HTLCS {
	for _ in 0..50 {
 let (route, payment_hash, payment_preimage, payment_secret) = get_route_and_payment_hash!(nodes[1], nodes[2], 100000);
 nodes[1].node.send_payment_with_route(&route, payment_hash,
 RecipientOnionFields::secret_only(payment_secret), PaymentId(payment_hash.0)).unwrap();
Expand DownExpand Up@@ -6278,11 +6278,11 @@ fn test_update_add_htlc_bolt2_receiver_check_max_htlc_limit() {
 onion_routing_packet: onion_packet.clone(),
	};

	for i in 0..super::channel::OUR_MAX_HTLCS {
	for i in 0..50 {
 msg.htlc_id = i as u64;
 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &msg);
	}
	msg.htlc_id = (super::channel::OUR_MAX_HTLCS) as u64;
	msg.htlc_id = (50) as u64;
	nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &msg);

	assert!(nodes[1].node.list_channels().is_empty());
Expand Down

14 changes: 14 additions & 0 deletions
lightning/src/util/config.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -170,6 +170,19 @@ pub struct ChannelHandshakeConfig {
	/// [`DecodeError::InvalidValue`]: crate::ln::msgs::DecodeError::InvalidValue
	/// [`SIGHASH_SINGLE + update_fee Considered Harmful`]: https://lists.linuxfoundation.org/pipermail/lightning-dev/2020-September/002796.html
	pub negotiate_anchors_zero_fee_htlc_tx: bool,

	/// The maximum number of HTLCs in-flight from our counterparty towards us at the same time.
	///
	/// Increasing the value can help improve liquidity and stability in
	/// routing at the cost of higher long term disk / DB usage.
	///
	/// Note: Versions of LDK earlier than v0.0.115 will fail to read channels with a configuration
	/// other than the default value.
	///
	/// Default value: 50
Comment thread
swilliamson5 marked this conversation as resolved.

	/// Maximum value: 483, any values larger will be treated as 483.
	/// This is the BOLT #2 spec limit on `max_accepted_htlcs`.
	pub our_max_accepted_htlcs: u16,
}

impl Default for ChannelHandshakeConfig {
Expand All@@ -185,6 +198,7 @@ impl Default for ChannelHandshakeConfig {
 their_channel_reserve_proportional_millionths: 10_000,
 #[cfg(anchors)]
 negotiate_anchors_zero_fee_htlc_tx: false,
 our_max_accepted_htlcs: 50,
 }
	}
}
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Force GitHub README to respect dark mode
(function() {
var style = document.createElement('style');
style.textContent = '
.markdown-body {
color-scheme: dark light;
}
.markdown-body pre { background: #161b22 !important; }
.markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }
.markdown-body table th, .markdown-body table td { border-color: #30363d !important; }
.markdown-body img { background: #0d1117; }
.markdown-body blockquote { border-left-color: #8b949e; }
.markdown-body hr { border-color: #30363d; }
';
document.head.appendChild(style);
})();
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
Replace `OUR_MAX_HTLCS` with config knob by swilliamson5 · Pull Request #2138 · lightningdevkit/rust-lightning · GitHub
Skip to content
Replace OUR_MAX_HTLCS with config knob#2138

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

TheBlueMatt
merged 1 commit into

from

Apr 17, 2023
 Merged


Replace OUR_MAX_HTLCS with config knob
#2138
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


33 changes: 22 additions & 11 deletions
lightning/src/ln/channel.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -653,7 +653,7 @@ pub(super) struct Channel<Signer: ChannelSigner> {
	pub counterparty_max_accepted_htlcs: u16,
	#[cfg(not(test))]
	counterparty_max_accepted_htlcs: u16,
//implied by OUR_MAX_HTLCS: max_accepted_htlcs: u16,
holder_max_accepted_htlcs: u16,
	minimum_depth: Option<u32>,

	counterparty_forwarding_info: Option<CounterpartyForwardingInfo>,
Expand DownExpand Up@@ -756,7 +756,7 @@ struct CommitmentTxInfoCached {
	feerate: u32,
}

pub const OUR_MAX_HTLCS: u16 = 50; //TODO
Comment thread
swilliamson5 marked this conversation as resolved.

pub const DEFAULT_MAX_HTLCS: u16 = 50;

pub(crate) fn commitment_tx_base_weight(opt_anchors: bool) -> u64 {
	const COMMITMENT_TX_BASE_WEIGHT: u64 = 724;
Expand DownExpand Up@@ -1072,6 +1072,7 @@ impl<Signer: WriteableEcdsaChannelSigner> Channel<Signer> {
 counterparty_htlc_minimum_msat: 0,
 holder_htlc_minimum_msat: if config.channel_handshake_config.our_htlc_minimum_msat == 0 { 1 } else { config.channel_handshake_config.our_htlc_minimum_msat },
 counterparty_max_accepted_htlcs: 0,
 holder_max_accepted_htlcs: cmp::min(config.channel_handshake_config.our_max_accepted_htlcs, MAX_HTLCS),
 minimum_depth: None, // Filled in in accept_channel

 counterparty_forwarding_info: None,
Expand DownExpand Up@@ -1419,6 +1420,7 @@ impl<Signer: WriteableEcdsaChannelSigner> Channel<Signer> {
 counterparty_htlc_minimum_msat: msg.htlc_minimum_msat,
 holder_htlc_minimum_msat: if config.channel_handshake_config.our_htlc_minimum_msat == 0 { 1 } else { config.channel_handshake_config.our_htlc_minimum_msat },
 counterparty_max_accepted_htlcs: msg.max_accepted_htlcs,
 holder_max_accepted_htlcs: cmp::min(config.channel_handshake_config.our_max_accepted_htlcs, MAX_HTLCS),
 minimum_depth: Some(cmp::max(config.channel_handshake_config.minimum_depth, 1)),

 counterparty_forwarding_info: None,
Expand DownExpand Up@@ -2874,8 +2876,8 @@ impl<Signer: WriteableEcdsaChannelSigner> Channel<Signer> {

 let inbound_stats = self.get_inbound_pending_htlc_stats(None);
 let outbound_stats = self.get_outbound_pending_htlc_stats(None);
 if inbound_stats.pending_htlcs + 1 > OUR_MAX_HTLCS as u32 {
 return Err(ChannelError::Close(format!("Remote tried to push more than our max accepted HTLCs ({})", OUR_MAX_HTLCS)));
 if inbound_stats.pending_htlcs + 1 > self.holder_max_accepted_htlcs as u32 {
 return Err(ChannelError::Close(format!("Remote tried to push more than our max accepted HTLCs ({})", self.holder_max_accepted_htlcs)));
 }
 if inbound_stats.pending_htlcs_value_msat + msg.amount_msat > self.holder_max_htlc_value_in_flight_msat {
 return Err(ChannelError::Close(format!("Remote HTLC add would put them over our max HTLC value ({})", self.holder_max_htlc_value_in_flight_msat)));
Expand DownExpand Up@@ -5313,7 +5315,7 @@ impl<Signer: WriteableEcdsaChannelSigner> Channel<Signer> {
 htlc_minimum_msat: self.holder_htlc_minimum_msat,
 feerate_per_kw: self.feerate_per_kw as u32,
 to_self_delay: self.get_holder_selected_contest_delay(),
 max_accepted_htlcs: OUR_MAX_HTLCS,
 max_accepted_htlcs: self.holder_max_accepted_htlcs,
 funding_pubkey: keys.funding_pubkey,
 revocation_basepoint: keys.revocation_basepoint,
 payment_point: keys.payment_point,
Expand DownExpand Up@@ -5380,7 +5382,7 @@ impl<Signer: WriteableEcdsaChannelSigner> Channel<Signer> {
 htlc_minimum_msat: self.holder_htlc_minimum_msat,
 minimum_depth: self.minimum_depth.unwrap(),
 to_self_delay: self.get_holder_selected_contest_delay(),
 max_accepted_htlcs: OUR_MAX_HTLCS,
 max_accepted_htlcs: self.holder_max_accepted_htlcs,
 funding_pubkey: keys.funding_pubkey,
 revocation_basepoint: keys.revocation_basepoint,
 payment_point: keys.payment_point,
Expand DownExpand Up@@ -6496,6 +6498,8 @@ impl<Signer: WriteableEcdsaChannelSigner> Writeable for Channel<Signer> {
 // we write the high bytes as an option here.
 let user_id_high_opt = Some((self.user_id >> 64) as u64);

 let holder_max_accepted_htlcs = if self.holder_max_accepted_htlcs == DEFAULT_MAX_HTLCS { None } else { Some(self.holder_max_accepted_htlcs) };

 write_tlv_fields!(writer, {
 (0, self.announcement_sigs, option),
 // minimum_depth and counterparty_selected_channel_reserve_satoshis used to have a
Expand All@@ -6521,6 +6525,7 @@ impl<Signer: WriteableEcdsaChannelSigner> Writeable for Channel<Signer> {
 (23, channel_ready_event_emitted, option),
 (25, user_id_high_opt, option),
 (27, self.channel_keys_id, required),
 (28, holder_max_accepted_htlcs, option),
 (29, self.temporary_channel_id, option),
 (31, channel_pending_event_emitted, option),
 });
Expand DownExpand Up@@ -6589,7 +6594,8 @@ impl<'a, 'b, 'c, ES: Deref, SP: Deref> ReadableArgs<(&'a ES, &'b SP, u32, &'c Ch
 let value_to_self_msat = Readable::read(reader)?;

 let pending_inbound_htlc_count: u64 = Readable::read(reader)?;
 let mut pending_inbound_htlcs = Vec::with_capacity(cmp::min(pending_inbound_htlc_count as usize, OUR_MAX_HTLCS as usize));

 let mut pending_inbound_htlcs = Vec::with_capacity(cmp::min(pending_inbound_htlc_count as usize, DEFAULT_MAX_HTLCS as usize));
 for _ in 0..pending_inbound_htlc_count {
 pending_inbound_htlcs.push(InboundHTLCOutput {
 htlc_id: Readable::read(reader)?,
Expand All@@ -6607,7 +6613,7 @@ impl<'a, 'b, 'c, ES: Deref, SP: Deref> ReadableArgs<(&'a ES, &'b SP, u32, &'c Ch
 }

 let pending_outbound_htlc_count: u64 = Readable::read(reader)?;
 let mut pending_outbound_htlcs = Vec::with_capacity(cmp::min(pending_outbound_htlc_count as usize, OUR_MAX_HTLCS as usize));
 let mut pending_outbound_htlcs = Vec::with_capacity(cmp::min(pending_outbound_htlc_count as usize, DEFAULT_MAX_HTLCS as usize));
 for _ in 0..pending_outbound_htlc_count {
 pending_outbound_htlcs.push(OutboundHTLCOutput {
 htlc_id: Readable::read(reader)?,
Expand DownExpand Up@@ -6636,7 +6642,7 @@ impl<'a, 'b, 'c, ES: Deref, SP: Deref> ReadableArgs<(&'a ES, &'b SP, u32, &'c Ch
 }

 let holding_cell_htlc_update_count: u64 = Readable::read(reader)?;
 let mut holding_cell_htlc_updates = Vec::with_capacity(cmp::min(holding_cell_htlc_update_count as usize, OUR_MAX_HTLCS as usize*2));
 let mut holding_cell_htlc_updates = Vec::with_capacity(cmp::min(holding_cell_htlc_update_count as usize, DEFAULT_MAX_HTLCS as usize*2));
 for _ in 0..holding_cell_htlc_update_count {
 holding_cell_htlc_updates.push(match <u8 as Readable>::read(reader)? {
 0 => HTLCUpdateAwaitingACK::AddHTLC {
Expand DownExpand Up@@ -6669,13 +6675,13 @@ impl<'a, 'b, 'c, ES: Deref, SP: Deref> ReadableArgs<(&'a ES, &'b SP, u32, &'c Ch
 let monitor_pending_commitment_signed = Readable::read(reader)?;

 let monitor_pending_forwards_count: u64 = Readable::read(reader)?;
 let mut monitor_pending_forwards = Vec::with_capacity(cmp::min(monitor_pending_forwards_count as usize, OUR_MAX_HTLCS as usize));
 let mut monitor_pending_forwards = Vec::with_capacity(cmp::min(monitor_pending_forwards_count as usize, DEFAULT_MAX_HTLCS as usize));
 for _ in 0..monitor_pending_forwards_count {
 monitor_pending_forwards.push((Readable::read(reader)?, Readable::read(reader)?));
 }

 let monitor_pending_failures_count: u64 = Readable::read(reader)?;
 let mut monitor_pending_failures = Vec::with_capacity(cmp::min(monitor_pending_failures_count as usize, OUR_MAX_HTLCS as usize));
 let mut monitor_pending_failures = Vec::with_capacity(cmp::min(monitor_pending_failures_count as usize, DEFAULT_MAX_HTLCS as usize));
 for _ in 0..monitor_pending_failures_count {
 monitor_pending_failures.push((Readable::read(reader)?, Readable::read(reader)?, Readable::read(reader)?));
 }
Expand DownExpand Up@@ -6796,6 +6802,7 @@ impl<'a, 'b, 'c, ES: Deref, SP: Deref> ReadableArgs<(&'a ES, &'b SP, u32, &'c Ch
 let mut user_id_high_opt: Option<u64> = None;
 let mut channel_keys_id: Option<[u8; 32]> = None;
 let mut temporary_channel_id: Option<[u8; 32]> = None;
 let mut holder_max_accepted_htlcs: Option<u16> = None;

 read_tlv_fields!(reader, {
 (0, announcement_sigs, option),
Expand All@@ -6816,6 +6823,7 @@ impl<'a, 'b, 'c, ES: Deref, SP: Deref> ReadableArgs<(&'a ES, &'b SP, u32, &'c Ch
 (23, channel_ready_event_emitted, option),
 (25, user_id_high_opt, option),
 (27, channel_keys_id, option),
 (28, holder_max_accepted_htlcs, option),
 (29, temporary_channel_id, option),
 (31, channel_pending_event_emitted, option),
 });
Expand DownExpand Up@@ -6870,6 +6878,8 @@ impl<'a, 'b, 'c, ES: Deref, SP: Deref> ReadableArgs<(&'a ES, &'b SP, u32, &'c Ch
 // separate u64 values.
 let user_id = user_id_low as u128 + ((user_id_high_opt.unwrap_or(0) as u128) << 64);

 let holder_max_accepted_htlcs = holder_max_accepted_htlcs.unwrap_or(DEFAULT_MAX_HTLCS);

 Ok(Channel {
 user_id,

Expand DownExpand Up@@ -6898,6 +6908,7 @@ impl<'a, 'b, 'c, ES: Deref, SP: Deref> ReadableArgs<(&'a ES, &'b SP, u32, &'c Ch
 cur_counterparty_commitment_transaction_number,
 value_to_self_msat,

 holder_max_accepted_htlcs,
 pending_inbound_htlcs,
 pending_outbound_htlcs,
 holding_cell_htlc_updates,
Expand Down

6 changes: 3 additions & 3 deletions
lightning/src/ln/functional_tests.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1107,7 +1107,7 @@ fn holding_cell_htlc_counting() {
	let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2);

	let mut payments = Vec::new();
	for _ in 0..crate::ln::channel::OUR_MAX_HTLCS {
	for _ in 0..50 {
 let (route, payment_hash, payment_preimage, payment_secret) = get_route_and_payment_hash!(nodes[1], nodes[2], 100000);
 nodes[1].node.send_payment_with_route(&route, payment_hash,
 RecipientOnionFields::secret_only(payment_secret), PaymentId(payment_hash.0)).unwrap();
Expand DownExpand Up@@ -6278,11 +6278,11 @@ fn test_update_add_htlc_bolt2_receiver_check_max_htlc_limit() {
 onion_routing_packet: onion_packet.clone(),
	};

	for i in 0..super::channel::OUR_MAX_HTLCS {
	for i in 0..50 {
 msg.htlc_id = i as u64;
 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &msg);
	}
	msg.htlc_id = (super::channel::OUR_MAX_HTLCS) as u64;
	msg.htlc_id = (50) as u64;
	nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &msg);

	assert!(nodes[1].node.list_channels().is_empty());
Expand Down

14 changes: 14 additions & 0 deletions
lightning/src/util/config.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -170,6 +170,19 @@ pub struct ChannelHandshakeConfig {
	/// [`DecodeError::InvalidValue`]: crate::ln::msgs::DecodeError::InvalidValue
	/// [`SIGHASH_SINGLE + update_fee Considered Harmful`]: https://lists.linuxfoundation.org/pipermail/lightning-dev/2020-September/002796.html
	pub negotiate_anchors_zero_fee_htlc_tx: bool,

	/// The maximum number of HTLCs in-flight from our counterparty towards us at the same time.
	///
	/// Increasing the value can help improve liquidity and stability in
	/// routing at the cost of higher long term disk / DB usage.
	///
	/// Note: Versions of LDK earlier than v0.0.115 will fail to read channels with a configuration
	/// other than the default value.
	///
	/// Default value: 50
Comment thread
swilliamson5 marked this conversation as resolved.

	/// Maximum value: 483, any values larger will be treated as 483.
	/// This is the BOLT #2 spec limit on `max_accepted_htlcs`.
	pub our_max_accepted_htlcs: u16,
}

impl Default for ChannelHandshakeConfig {
Expand All@@ -185,6 +198,7 @@ impl Default for ChannelHandshakeConfig {
 their_channel_reserve_proportional_millionths: 10_000,
 #[cfg(anchors)]
 negotiate_anchors_zero_fee_htlc_tx: false,
 our_max_accepted_htlcs: 50,
 }
	}
}
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Highlight search terms from Google/DuckDuckGo/Bing referrer
(function() {
var ref = document.referrer;
var terms = [];
if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {
var url = new URL(ref);
var q = url.searchParams.get('q') || url.searchParams.get('p');
if (q) {
terms = q.split(/\s+/).filter(function(t) { return t.length > 2; });
}
}
if (terms.length === 0) return;
var style = document.createElement('style');
style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';
document.head.appendChild(style);
function highlight(node) {
if (node.nodeType === 3) { // text node
var text = node.textContent;
var found = false;
terms.forEach(function(term) {
var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\]\\]/g, '\\') + ')', 'gi');
if (regex.test(text)) {
found = true;
var frag = document.createDocumentFragment();
var parts = text.split(regex);
parts.forEach(function(part, i) {
if (i % 2 === 0) {
frag.appendChild(document.createTextNode(part));
} else {
var span = document.createElement('span');
span.className = 'userscript-highlight';
span.textContent = part;
frag.appendChild(span);
}
});
node.parentNode.replaceChild(frag, node);
}
});
} else if (node.nodeType === 1 && node.childNodes) { // element
var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];
if (!skipTags.includes(node.tagName)) {
Array.from(node.childNodes).forEach(highlight);
}
}
}
highlight(document.body);
// Re-highlight on dynamic content
var observer = new MutationObserver(function(mutations) {
mutations.forEach(function(m) {
m.addedNodes.forEach(function(node) {
if (node.nodeType === 1 || node.nodeType === 3) highlight(node);
});
});
});
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
Replace `OUR_MAX_HTLCS` with config knob by swilliamson5 · Pull Request #2138 · lightningdevkit/rust-lightning · GitHub
Skip to content
Replace OUR_MAX_HTLCS with config knob#2138

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

TheBlueMatt
merged 1 commit into

from

Apr 17, 2023
 Merged


Replace OUR_MAX_HTLCS with config knob
#2138
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


33 changes: 22 additions & 11 deletions
lightning/src/ln/channel.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -653,7 +653,7 @@ pub(super) struct Channel<Signer: ChannelSigner> {
	pub counterparty_max_accepted_htlcs: u16,
	#[cfg(not(test))]
	counterparty_max_accepted_htlcs: u16,
//implied by OUR_MAX_HTLCS: max_accepted_htlcs: u16,
holder_max_accepted_htlcs: u16,
	minimum_depth: Option<u32>,

	counterparty_forwarding_info: Option<CounterpartyForwardingInfo>,
Expand DownExpand Up@@ -756,7 +756,7 @@ struct CommitmentTxInfoCached {
	feerate: u32,
}

pub const OUR_MAX_HTLCS: u16 = 50; //TODO
Comment thread
swilliamson5 marked this conversation as resolved.

pub const DEFAULT_MAX_HTLCS: u16 = 50;

pub(crate) fn commitment_tx_base_weight(opt_anchors: bool) -> u64 {
	const COMMITMENT_TX_BASE_WEIGHT: u64 = 724;
Expand DownExpand Up@@ -1072,6 +1072,7 @@ impl<Signer: WriteableEcdsaChannelSigner> Channel<Signer> {
 counterparty_htlc_minimum_msat: 0,
 holder_htlc_minimum_msat: if config.channel_handshake_config.our_htlc_minimum_msat == 0 { 1 } else { config.channel_handshake_config.our_htlc_minimum_msat },
 counterparty_max_accepted_htlcs: 0,
 holder_max_accepted_htlcs: cmp::min(config.channel_handshake_config.our_max_accepted_htlcs, MAX_HTLCS),
 minimum_depth: None, // Filled in in accept_channel

 counterparty_forwarding_info: None,
Expand DownExpand Up@@ -1419,6 +1420,7 @@ impl<Signer: WriteableEcdsaChannelSigner> Channel<Signer> {
 counterparty_htlc_minimum_msat: msg.htlc_minimum_msat,
 holder_htlc_minimum_msat: if config.channel_handshake_config.our_htlc_minimum_msat == 0 { 1 } else { config.channel_handshake_config.our_htlc_minimum_msat },
 counterparty_max_accepted_htlcs: msg.max_accepted_htlcs,
 holder_max_accepted_htlcs: cmp::min(config.channel_handshake_config.our_max_accepted_htlcs, MAX_HTLCS),
 minimum_depth: Some(cmp::max(config.channel_handshake_config.minimum_depth, 1)),

 counterparty_forwarding_info: None,
Expand DownExpand Up@@ -2874,8 +2876,8 @@ impl<Signer: WriteableEcdsaChannelSigner> Channel<Signer> {

 let inbound_stats = self.get_inbound_pending_htlc_stats(None);
 let outbound_stats = self.get_outbound_pending_htlc_stats(None);
 if inbound_stats.pending_htlcs + 1 > OUR_MAX_HTLCS as u32 {
 return Err(ChannelError::Close(format!("Remote tried to push more than our max accepted HTLCs ({})", OUR_MAX_HTLCS)));
 if inbound_stats.pending_htlcs + 1 > self.holder_max_accepted_htlcs as u32 {
 return Err(ChannelError::Close(format!("Remote tried to push more than our max accepted HTLCs ({})", self.holder_max_accepted_htlcs)));
 }
 if inbound_stats.pending_htlcs_value_msat + msg.amount_msat > self.holder_max_htlc_value_in_flight_msat {
 return Err(ChannelError::Close(format!("Remote HTLC add would put them over our max HTLC value ({})", self.holder_max_htlc_value_in_flight_msat)));
Expand DownExpand Up@@ -5313,7 +5315,7 @@ impl<Signer: WriteableEcdsaChannelSigner> Channel<Signer> {
 htlc_minimum_msat: self.holder_htlc_minimum_msat,
 feerate_per_kw: self.feerate_per_kw as u32,
 to_self_delay: self.get_holder_selected_contest_delay(),
 max_accepted_htlcs: OUR_MAX_HTLCS,
 max_accepted_htlcs: self.holder_max_accepted_htlcs,
 funding_pubkey: keys.funding_pubkey,
 revocation_basepoint: keys.revocation_basepoint,
 payment_point: keys.payment_point,
Expand DownExpand Up@@ -5380,7 +5382,7 @@ impl<Signer: WriteableEcdsaChannelSigner> Channel<Signer> {
 htlc_minimum_msat: self.holder_htlc_minimum_msat,
 minimum_depth: self.minimum_depth.unwrap(),
 to_self_delay: self.get_holder_selected_contest_delay(),
 max_accepted_htlcs: OUR_MAX_HTLCS,
 max_accepted_htlcs: self.holder_max_accepted_htlcs,
 funding_pubkey: keys.funding_pubkey,
 revocation_basepoint: keys.revocation_basepoint,
 payment_point: keys.payment_point,
Expand DownExpand Up@@ -6496,6 +6498,8 @@ impl<Signer: WriteableEcdsaChannelSigner> Writeable for Channel<Signer> {
 // we write the high bytes as an option here.
 let user_id_high_opt = Some((self.user_id >> 64) as u64);

 let holder_max_accepted_htlcs = if self.holder_max_accepted_htlcs == DEFAULT_MAX_HTLCS { None } else { Some(self.holder_max_accepted_htlcs) };

 write_tlv_fields!(writer, {
 (0, self.announcement_sigs, option),
 // minimum_depth and counterparty_selected_channel_reserve_satoshis used to have a
Expand All@@ -6521,6 +6525,7 @@ impl<Signer: WriteableEcdsaChannelSigner> Writeable for Channel<Signer> {
 (23, channel_ready_event_emitted, option),
 (25, user_id_high_opt, option),
 (27, self.channel_keys_id, required),
 (28, holder_max_accepted_htlcs, option),
 (29, self.temporary_channel_id, option),
 (31, channel_pending_event_emitted, option),
 });
Expand DownExpand Up@@ -6589,7 +6594,8 @@ impl<'a, 'b, 'c, ES: Deref, SP: Deref> ReadableArgs<(&'a ES, &'b SP, u32, &'c Ch
 let value_to_self_msat = Readable::read(reader)?;

 let pending_inbound_htlc_count: u64 = Readable::read(reader)?;
 let mut pending_inbound_htlcs = Vec::with_capacity(cmp::min(pending_inbound_htlc_count as usize, OUR_MAX_HTLCS as usize));

 let mut pending_inbound_htlcs = Vec::with_capacity(cmp::min(pending_inbound_htlc_count as usize, DEFAULT_MAX_HTLCS as usize));
 for _ in 0..pending_inbound_htlc_count {
 pending_inbound_htlcs.push(InboundHTLCOutput {
 htlc_id: Readable::read(reader)?,
Expand All@@ -6607,7 +6613,7 @@ impl<'a, 'b, 'c, ES: Deref, SP: Deref> ReadableArgs<(&'a ES, &'b SP, u32, &'c Ch
 }

 let pending_outbound_htlc_count: u64 = Readable::read(reader)?;
 let mut pending_outbound_htlcs = Vec::with_capacity(cmp::min(pending_outbound_htlc_count as usize, OUR_MAX_HTLCS as usize));
 let mut pending_outbound_htlcs = Vec::with_capacity(cmp::min(pending_outbound_htlc_count as usize, DEFAULT_MAX_HTLCS as usize));
 for _ in 0..pending_outbound_htlc_count {
 pending_outbound_htlcs.push(OutboundHTLCOutput {
 htlc_id: Readable::read(reader)?,
Expand DownExpand Up@@ -6636,7 +6642,7 @@ impl<'a, 'b, 'c, ES: Deref, SP: Deref> ReadableArgs<(&'a ES, &'b SP, u32, &'c Ch
 }

 let holding_cell_htlc_update_count: u64 = Readable::read(reader)?;
 let mut holding_cell_htlc_updates = Vec::with_capacity(cmp::min(holding_cell_htlc_update_count as usize, OUR_MAX_HTLCS as usize*2));
 let mut holding_cell_htlc_updates = Vec::with_capacity(cmp::min(holding_cell_htlc_update_count as usize, DEFAULT_MAX_HTLCS as usize*2));
 for _ in 0..holding_cell_htlc_update_count {
 holding_cell_htlc_updates.push(match <u8 as Readable>::read(reader)? {
 0 => HTLCUpdateAwaitingACK::AddHTLC {
Expand DownExpand Up@@ -6669,13 +6675,13 @@ impl<'a, 'b, 'c, ES: Deref, SP: Deref> ReadableArgs<(&'a ES, &'b SP, u32, &'c Ch
 let monitor_pending_commitment_signed = Readable::read(reader)?;

 let monitor_pending_forwards_count: u64 = Readable::read(reader)?;
 let mut monitor_pending_forwards = Vec::with_capacity(cmp::min(monitor_pending_forwards_count as usize, OUR_MAX_HTLCS as usize));
 let mut monitor_pending_forwards = Vec::with_capacity(cmp::min(monitor_pending_forwards_count as usize, DEFAULT_MAX_HTLCS as usize));
 for _ in 0..monitor_pending_forwards_count {
 monitor_pending_forwards.push((Readable::read(reader)?, Readable::read(reader)?));
 }

 let monitor_pending_failures_count: u64 = Readable::read(reader)?;
 let mut monitor_pending_failures = Vec::with_capacity(cmp::min(monitor_pending_failures_count as usize, OUR_MAX_HTLCS as usize));
 let mut monitor_pending_failures = Vec::with_capacity(cmp::min(monitor_pending_failures_count as usize, DEFAULT_MAX_HTLCS as usize));
 for _ in 0..monitor_pending_failures_count {
 monitor_pending_failures.push((Readable::read(reader)?, Readable::read(reader)?, Readable::read(reader)?));
 }
Expand DownExpand Up@@ -6796,6 +6802,7 @@ impl<'a, 'b, 'c, ES: Deref, SP: Deref> ReadableArgs<(&'a ES, &'b SP, u32, &'c Ch
 let mut user_id_high_opt: Option<u64> = None;
 let mut channel_keys_id: Option<[u8; 32]> = None;
 let mut temporary_channel_id: Option<[u8; 32]> = None;
 let mut holder_max_accepted_htlcs: Option<u16> = None;

 read_tlv_fields!(reader, {
 (0, announcement_sigs, option),
Expand All@@ -6816,6 +6823,7 @@ impl<'a, 'b, 'c, ES: Deref, SP: Deref> ReadableArgs<(&'a ES, &'b SP, u32, &'c Ch
 (23, channel_ready_event_emitted, option),
 (25, user_id_high_opt, option),
 (27, channel_keys_id, option),
 (28, holder_max_accepted_htlcs, option),
 (29, temporary_channel_id, option),
 (31, channel_pending_event_emitted, option),
 });
Expand DownExpand Up@@ -6870,6 +6878,8 @@ impl<'a, 'b, 'c, ES: Deref, SP: Deref> ReadableArgs<(&'a ES, &'b SP, u32, &'c Ch
 // separate u64 values.
 let user_id = user_id_low as u128 + ((user_id_high_opt.unwrap_or(0) as u128) << 64);

 let holder_max_accepted_htlcs = holder_max_accepted_htlcs.unwrap_or(DEFAULT_MAX_HTLCS);

 Ok(Channel {
 user_id,

Expand DownExpand Up@@ -6898,6 +6908,7 @@ impl<'a, 'b, 'c, ES: Deref, SP: Deref> ReadableArgs<(&'a ES, &'b SP, u32, &'c Ch
 cur_counterparty_commitment_transaction_number,
 value_to_self_msat,

 holder_max_accepted_htlcs,
 pending_inbound_htlcs,
 pending_outbound_htlcs,
 holding_cell_htlc_updates,
Expand Down

6 changes: 3 additions & 3 deletions
lightning/src/ln/functional_tests.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1107,7 +1107,7 @@ fn holding_cell_htlc_counting() {
	let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2);

	let mut payments = Vec::new();
	for _ in 0..crate::ln::channel::OUR_MAX_HTLCS {
	for _ in 0..50 {
 let (route, payment_hash, payment_preimage, payment_secret) = get_route_and_payment_hash!(nodes[1], nodes[2], 100000);
 nodes[1].node.send_payment_with_route(&route, payment_hash,
 RecipientOnionFields::secret_only(payment_secret), PaymentId(payment_hash.0)).unwrap();
Expand DownExpand Up@@ -6278,11 +6278,11 @@ fn test_update_add_htlc_bolt2_receiver_check_max_htlc_limit() {
 onion_routing_packet: onion_packet.clone(),
	};

	for i in 0..super::channel::OUR_MAX_HTLCS {
	for i in 0..50 {
 msg.htlc_id = i as u64;
 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &msg);
	}
	msg.htlc_id = (super::channel::OUR_MAX_HTLCS) as u64;
	msg.htlc_id = (50) as u64;
	nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &msg);

	assert!(nodes[1].node.list_channels().is_empty());
Expand Down

14 changes: 14 additions & 0 deletions
lightning/src/util/config.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -170,6 +170,19 @@ pub struct ChannelHandshakeConfig {
	/// [`DecodeError::InvalidValue`]: crate::ln::msgs::DecodeError::InvalidValue
	/// [`SIGHASH_SINGLE + update_fee Considered Harmful`]: https://lists.linuxfoundation.org/pipermail/lightning-dev/2020-September/002796.html
	pub negotiate_anchors_zero_fee_htlc_tx: bool,

	/// The maximum number of HTLCs in-flight from our counterparty towards us at the same time.
	///
	/// Increasing the value can help improve liquidity and stability in
	/// routing at the cost of higher long term disk / DB usage.
	///
	/// Note: Versions of LDK earlier than v0.0.115 will fail to read channels with a configuration
	/// other than the default value.
	///
	/// Default value: 50
Comment thread
swilliamson5 marked this conversation as resolved.

	/// Maximum value: 483, any values larger will be treated as 483.
	/// This is the BOLT #2 spec limit on `max_accepted_htlcs`.
	pub our_max_accepted_htlcs: u16,
}

impl Default for ChannelHandshakeConfig {
Expand All@@ -185,6 +198,7 @@ impl Default for ChannelHandshakeConfig {
 their_channel_reserve_proportional_millionths: 10_000,
 #[cfg(anchors)]
 negotiate_anchors_zero_fee_htlc_tx: false,
 our_max_accepted_htlcs: 50,
 }
	}
}
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Strip utm_, fbclid, gclid, etc. from all links on page
(function() {
var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',
'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',
'ref', 'ref_src', 'source', 'medium', 'campaign'];
function cleanUrl(url) {
try {
var u = new URL(url, window.location.origin);
var changed = false;
trackingParams.forEach(function(p) {
if (u.searchParams.has(p)) {
u.searchParams.delete(p);
changed = true;
}
});
return changed ? u.toString() : url;
} catch (e) {
return url;
}
}
function cleanLinks() {
document.querySelectorAll('a[href]').forEach(function(a) {
var clean = cleanUrl(a.href);
if (clean !== a.href) a.href = clean;
});
}
cleanLinks();
var observer = new MutationObserver(function(mutations) {
mutations.forEach(function(m) {
m.addedNodes.forEach(function(node) {
if (node.nodeType === 1) {
if (node.tagName === 'A') cleanLinks();
node.querySelectorAll('a[href]').forEach(function(a) {
var clean = cleanUrl(a.href);
if (clean !== a.href) a.href = clean;
});
}
});
});
});
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '
Replace `OUR_MAX_HTLCS` with config knob by swilliamson5 · Pull Request #2138 · lightningdevkit/rust-lightning · GitHub
Skip to content
Replace OUR_MAX_HTLCS with config knob#2138

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

TheBlueMatt
merged 1 commit into

from

Apr 17, 2023
 Merged


Replace OUR_MAX_HTLCS with config knob
#2138
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


33 changes: 22 additions & 11 deletions
lightning/src/ln/channel.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -653,7 +653,7 @@ pub(super) struct Channel<Signer: ChannelSigner> {
	pub counterparty_max_accepted_htlcs: u16,
	#[cfg(not(test))]
	counterparty_max_accepted_htlcs: u16,
//implied by OUR_MAX_HTLCS: max_accepted_htlcs: u16,
holder_max_accepted_htlcs: u16,
	minimum_depth: Option<u32>,

	counterparty_forwarding_info: Option<CounterpartyForwardingInfo>,
Expand DownExpand Up@@ -756,7 +756,7 @@ struct CommitmentTxInfoCached {
	feerate: u32,
}

pub const OUR_MAX_HTLCS: u16 = 50; //TODO
Comment thread
swilliamson5 marked this conversation as resolved.

pub const DEFAULT_MAX_HTLCS: u16 = 50;

pub(crate) fn commitment_tx_base_weight(opt_anchors: bool) -> u64 {
	const COMMITMENT_TX_BASE_WEIGHT: u64 = 724;
Expand DownExpand Up@@ -1072,6 +1072,7 @@ impl<Signer: WriteableEcdsaChannelSigner> Channel<Signer> {
 counterparty_htlc_minimum_msat: 0,
 holder_htlc_minimum_msat: if config.channel_handshake_config.our_htlc_minimum_msat == 0 { 1 } else { config.channel_handshake_config.our_htlc_minimum_msat },
 counterparty_max_accepted_htlcs: 0,
 holder_max_accepted_htlcs: cmp::min(config.channel_handshake_config.our_max_accepted_htlcs, MAX_HTLCS),
 minimum_depth: None, // Filled in in accept_channel

 counterparty_forwarding_info: None,
Expand DownExpand Up@@ -1419,6 +1420,7 @@ impl<Signer: WriteableEcdsaChannelSigner> Channel<Signer> {
 counterparty_htlc_minimum_msat: msg.htlc_minimum_msat,
 holder_htlc_minimum_msat: if config.channel_handshake_config.our_htlc_minimum_msat == 0 { 1 } else { config.channel_handshake_config.our_htlc_minimum_msat },
 counterparty_max_accepted_htlcs: msg.max_accepted_htlcs,
 holder_max_accepted_htlcs: cmp::min(config.channel_handshake_config.our_max_accepted_htlcs, MAX_HTLCS),
 minimum_depth: Some(cmp::max(config.channel_handshake_config.minimum_depth, 1)),

 counterparty_forwarding_info: None,
Expand DownExpand Up@@ -2874,8 +2876,8 @@ impl<Signer: WriteableEcdsaChannelSigner> Channel<Signer> {

 let inbound_stats = self.get_inbound_pending_htlc_stats(None);
 let outbound_stats = self.get_outbound_pending_htlc_stats(None);
 if inbound_stats.pending_htlcs + 1 > OUR_MAX_HTLCS as u32 {
 return Err(ChannelError::Close(format!("Remote tried to push more than our max accepted HTLCs ({})", OUR_MAX_HTLCS)));
 if inbound_stats.pending_htlcs + 1 > self.holder_max_accepted_htlcs as u32 {
 return Err(ChannelError::Close(format!("Remote tried to push more than our max accepted HTLCs ({})", self.holder_max_accepted_htlcs)));
 }
 if inbound_stats.pending_htlcs_value_msat + msg.amount_msat > self.holder_max_htlc_value_in_flight_msat {
 return Err(ChannelError::Close(format!("Remote HTLC add would put them over our max HTLC value ({})", self.holder_max_htlc_value_in_flight_msat)));
Expand DownExpand Up@@ -5313,7 +5315,7 @@ impl<Signer: WriteableEcdsaChannelSigner> Channel<Signer> {
 htlc_minimum_msat: self.holder_htlc_minimum_msat,
 feerate_per_kw: self.feerate_per_kw as u32,
 to_self_delay: self.get_holder_selected_contest_delay(),
 max_accepted_htlcs: OUR_MAX_HTLCS,
 max_accepted_htlcs: self.holder_max_accepted_htlcs,
 funding_pubkey: keys.funding_pubkey,
 revocation_basepoint: keys.revocation_basepoint,
 payment_point: keys.payment_point,
Expand DownExpand Up@@ -5380,7 +5382,7 @@ impl<Signer: WriteableEcdsaChannelSigner> Channel<Signer> {
 htlc_minimum_msat: self.holder_htlc_minimum_msat,
 minimum_depth: self.minimum_depth.unwrap(),
 to_self_delay: self.get_holder_selected_contest_delay(),
 max_accepted_htlcs: OUR_MAX_HTLCS,
 max_accepted_htlcs: self.holder_max_accepted_htlcs,
 funding_pubkey: keys.funding_pubkey,
 revocation_basepoint: keys.revocation_basepoint,
 payment_point: keys.payment_point,
Expand DownExpand Up@@ -6496,6 +6498,8 @@ impl<Signer: WriteableEcdsaChannelSigner> Writeable for Channel<Signer> {
 // we write the high bytes as an option here.
 let user_id_high_opt = Some((self.user_id >> 64) as u64);

 let holder_max_accepted_htlcs = if self.holder_max_accepted_htlcs == DEFAULT_MAX_HTLCS { None } else { Some(self.holder_max_accepted_htlcs) };

 write_tlv_fields!(writer, {
 (0, self.announcement_sigs, option),
 // minimum_depth and counterparty_selected_channel_reserve_satoshis used to have a
Expand All@@ -6521,6 +6525,7 @@ impl<Signer: WriteableEcdsaChannelSigner> Writeable for Channel<Signer> {
 (23, channel_ready_event_emitted, option),
 (25, user_id_high_opt, option),
 (27, self.channel_keys_id, required),
 (28, holder_max_accepted_htlcs, option),
 (29, self.temporary_channel_id, option),
 (31, channel_pending_event_emitted, option),
 });
Expand DownExpand Up@@ -6589,7 +6594,8 @@ impl<'a, 'b, 'c, ES: Deref, SP: Deref> ReadableArgs<(&'a ES, &'b SP, u32, &'c Ch
 let value_to_self_msat = Readable::read(reader)?;

 let pending_inbound_htlc_count: u64 = Readable::read(reader)?;
 let mut pending_inbound_htlcs = Vec::with_capacity(cmp::min(pending_inbound_htlc_count as usize, OUR_MAX_HTLCS as usize));

 let mut pending_inbound_htlcs = Vec::with_capacity(cmp::min(pending_inbound_htlc_count as usize, DEFAULT_MAX_HTLCS as usize));
 for _ in 0..pending_inbound_htlc_count {
 pending_inbound_htlcs.push(InboundHTLCOutput {
 htlc_id: Readable::read(reader)?,
Expand All@@ -6607,7 +6613,7 @@ impl<'a, 'b, 'c, ES: Deref, SP: Deref> ReadableArgs<(&'a ES, &'b SP, u32, &'c Ch
 }

 let pending_outbound_htlc_count: u64 = Readable::read(reader)?;
 let mut pending_outbound_htlcs = Vec::with_capacity(cmp::min(pending_outbound_htlc_count as usize, OUR_MAX_HTLCS as usize));
 let mut pending_outbound_htlcs = Vec::with_capacity(cmp::min(pending_outbound_htlc_count as usize, DEFAULT_MAX_HTLCS as usize));
 for _ in 0..pending_outbound_htlc_count {
 pending_outbound_htlcs.push(OutboundHTLCOutput {
 htlc_id: Readable::read(reader)?,
Expand DownExpand Up@@ -6636,7 +6642,7 @@ impl<'a, 'b, 'c, ES: Deref, SP: Deref> ReadableArgs<(&'a ES, &'b SP, u32, &'c Ch
 }

 let holding_cell_htlc_update_count: u64 = Readable::read(reader)?;
 let mut holding_cell_htlc_updates = Vec::with_capacity(cmp::min(holding_cell_htlc_update_count as usize, OUR_MAX_HTLCS as usize*2));
 let mut holding_cell_htlc_updates = Vec::with_capacity(cmp::min(holding_cell_htlc_update_count as usize, DEFAULT_MAX_HTLCS as usize*2));
 for _ in 0..holding_cell_htlc_update_count {
 holding_cell_htlc_updates.push(match <u8 as Readable>::read(reader)? {
 0 => HTLCUpdateAwaitingACK::AddHTLC {
Expand DownExpand Up@@ -6669,13 +6675,13 @@ impl<'a, 'b, 'c, ES: Deref, SP: Deref> ReadableArgs<(&'a ES, &'b SP, u32, &'c Ch
 let monitor_pending_commitment_signed = Readable::read(reader)?;

 let monitor_pending_forwards_count: u64 = Readable::read(reader)?;
 let mut monitor_pending_forwards = Vec::with_capacity(cmp::min(monitor_pending_forwards_count as usize, OUR_MAX_HTLCS as usize));
 let mut monitor_pending_forwards = Vec::with_capacity(cmp::min(monitor_pending_forwards_count as usize, DEFAULT_MAX_HTLCS as usize));
 for _ in 0..monitor_pending_forwards_count {
 monitor_pending_forwards.push((Readable::read(reader)?, Readable::read(reader)?));
 }

 let monitor_pending_failures_count: u64 = Readable::read(reader)?;
 let mut monitor_pending_failures = Vec::with_capacity(cmp::min(monitor_pending_failures_count as usize, OUR_MAX_HTLCS as usize));
 let mut monitor_pending_failures = Vec::with_capacity(cmp::min(monitor_pending_failures_count as usize, DEFAULT_MAX_HTLCS as usize));
 for _ in 0..monitor_pending_failures_count {
 monitor_pending_failures.push((Readable::read(reader)?, Readable::read(reader)?, Readable::read(reader)?));
 }
Expand DownExpand Up@@ -6796,6 +6802,7 @@ impl<'a, 'b, 'c, ES: Deref, SP: Deref> ReadableArgs<(&'a ES, &'b SP, u32, &'c Ch
 let mut user_id_high_opt: Option<u64> = None;
 let mut channel_keys_id: Option<[u8; 32]> = None;
 let mut temporary_channel_id: Option<[u8; 32]> = None;
 let mut holder_max_accepted_htlcs: Option<u16> = None;

 read_tlv_fields!(reader, {
 (0, announcement_sigs, option),
Expand All@@ -6816,6 +6823,7 @@ impl<'a, 'b, 'c, ES: Deref, SP: Deref> ReadableArgs<(&'a ES, &'b SP, u32, &'c Ch
 (23, channel_ready_event_emitted, option),
 (25, user_id_high_opt, option),
 (27, channel_keys_id, option),
 (28, holder_max_accepted_htlcs, option),
 (29, temporary_channel_id, option),
 (31, channel_pending_event_emitted, option),
 });
Expand DownExpand Up@@ -6870,6 +6878,8 @@ impl<'a, 'b, 'c, ES: Deref, SP: Deref> ReadableArgs<(&'a ES, &'b SP, u32, &'c Ch
 // separate u64 values.
 let user_id = user_id_low as u128 + ((user_id_high_opt.unwrap_or(0) as u128) << 64);

 let holder_max_accepted_htlcs = holder_max_accepted_htlcs.unwrap_or(DEFAULT_MAX_HTLCS);

 Ok(Channel {
 user_id,

Expand DownExpand Up@@ -6898,6 +6908,7 @@ impl<'a, 'b, 'c, ES: Deref, SP: Deref> ReadableArgs<(&'a ES, &'b SP, u32, &'c Ch
 cur_counterparty_commitment_transaction_number,
 value_to_self_msat,

 holder_max_accepted_htlcs,
 pending_inbound_htlcs,
 pending_outbound_htlcs,
 holding_cell_htlc_updates,
Expand Down

6 changes: 3 additions & 3 deletions
lightning/src/ln/functional_tests.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1107,7 +1107,7 @@ fn holding_cell_htlc_counting() {
	let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2);

	let mut payments = Vec::new();
	for _ in 0..crate::ln::channel::OUR_MAX_HTLCS {
	for _ in 0..50 {
 let (route, payment_hash, payment_preimage, payment_secret) = get_route_and_payment_hash!(nodes[1], nodes[2], 100000);
 nodes[1].node.send_payment_with_route(&route, payment_hash,
 RecipientOnionFields::secret_only(payment_secret), PaymentId(payment_hash.0)).unwrap();
Expand DownExpand Up@@ -6278,11 +6278,11 @@ fn test_update_add_htlc_bolt2_receiver_check_max_htlc_limit() {
 onion_routing_packet: onion_packet.clone(),
	};

	for i in 0..super::channel::OUR_MAX_HTLCS {
	for i in 0..50 {
 msg.htlc_id = i as u64;
 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &msg);
	}
	msg.htlc_id = (super::channel::OUR_MAX_HTLCS) as u64;
	msg.htlc_id = (50) as u64;
	nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &msg);

	assert!(nodes[1].node.list_channels().is_empty());
Expand Down

14 changes: 14 additions & 0 deletions
lightning/src/util/config.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -170,6 +170,19 @@ pub struct ChannelHandshakeConfig {
	/// [`DecodeError::InvalidValue`]: crate::ln::msgs::DecodeError::InvalidValue
	/// [`SIGHASH_SINGLE + update_fee Considered Harmful`]: https://lists.linuxfoundation.org/pipermail/lightning-dev/2020-September/002796.html
	pub negotiate_anchors_zero_fee_htlc_tx: bool,

	/// The maximum number of HTLCs in-flight from our counterparty towards us at the same time.
	///
	/// Increasing the value can help improve liquidity and stability in
	/// routing at the cost of higher long term disk / DB usage.
	///
	/// Note: Versions of LDK earlier than v0.0.115 will fail to read channels with a configuration
	/// other than the default value.
	///
	/// Default value: 50
Comment thread
swilliamson5 marked this conversation as resolved.

	/// Maximum value: 483, any values larger will be treated as 483.
	/// This is the BOLT #2 spec limit on `max_accepted_htlcs`.
	pub our_max_accepted_htlcs: u16,
}

impl Default for ChannelHandshakeConfig {
Expand All@@ -185,6 +198,7 @@ impl Default for ChannelHandshakeConfig {
 their_channel_reserve_proportional_millionths: 10_000,
 #[cfg(anchors)]
 negotiate_anchors_zero_fee_htlc_tx: false,
 our_max_accepted_htlcs: 50,
 }
	}
}
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Auto-enable theater mode on YouTube
(function() {
function tryTheater() {
var btn = document.querySelector('button[aria-label="Theater mode"], ytd-player #player button[title="Theater mode"]');
if (btn && !btn.classList.contains('activated')) {
btn.click();
}
}
// Try immediately
tryTheater();
// Try after navigation (SPA)
var lastUrl = location.href;
setInterval(function() {
if (location.href !== lastUrl) {
lastUrl = location.href;
setTimeout(tryTheater, 500);
}
}, 1000);
// Also try on player load
var observer = new MutationObserver(tryTheater);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
Replace `OUR_MAX_HTLCS` with config knob by swilliamson5 · Pull Request #2138 · lightningdevkit/rust-lightning · GitHub
Skip to content
Replace OUR_MAX_HTLCS with config knob#2138

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

TheBlueMatt
merged 1 commit into

from

Apr 17, 2023
 Merged


Replace OUR_MAX_HTLCS with config knob
#2138
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


33 changes: 22 additions & 11 deletions
lightning/src/ln/channel.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -653,7 +653,7 @@ pub(super) struct Channel<Signer: ChannelSigner> {
	pub counterparty_max_accepted_htlcs: u16,
	#[cfg(not(test))]
	counterparty_max_accepted_htlcs: u16,
//implied by OUR_MAX_HTLCS: max_accepted_htlcs: u16,
holder_max_accepted_htlcs: u16,
	minimum_depth: Option<u32>,

	counterparty_forwarding_info: Option<CounterpartyForwardingInfo>,
Expand DownExpand Up@@ -756,7 +756,7 @@ struct CommitmentTxInfoCached {
	feerate: u32,
}

pub const OUR_MAX_HTLCS: u16 = 50; //TODO
Comment thread
swilliamson5 marked this conversation as resolved.

pub const DEFAULT_MAX_HTLCS: u16 = 50;

pub(crate) fn commitment_tx_base_weight(opt_anchors: bool) -> u64 {
	const COMMITMENT_TX_BASE_WEIGHT: u64 = 724;
Expand DownExpand Up@@ -1072,6 +1072,7 @@ impl<Signer: WriteableEcdsaChannelSigner> Channel<Signer> {
 counterparty_htlc_minimum_msat: 0,
 holder_htlc_minimum_msat: if config.channel_handshake_config.our_htlc_minimum_msat == 0 { 1 } else { config.channel_handshake_config.our_htlc_minimum_msat },
 counterparty_max_accepted_htlcs: 0,
 holder_max_accepted_htlcs: cmp::min(config.channel_handshake_config.our_max_accepted_htlcs, MAX_HTLCS),
 minimum_depth: None, // Filled in in accept_channel

 counterparty_forwarding_info: None,
Expand DownExpand Up@@ -1419,6 +1420,7 @@ impl<Signer: WriteableEcdsaChannelSigner> Channel<Signer> {
 counterparty_htlc_minimum_msat: msg.htlc_minimum_msat,
 holder_htlc_minimum_msat: if config.channel_handshake_config.our_htlc_minimum_msat == 0 { 1 } else { config.channel_handshake_config.our_htlc_minimum_msat },
 counterparty_max_accepted_htlcs: msg.max_accepted_htlcs,
 holder_max_accepted_htlcs: cmp::min(config.channel_handshake_config.our_max_accepted_htlcs, MAX_HTLCS),
 minimum_depth: Some(cmp::max(config.channel_handshake_config.minimum_depth, 1)),

 counterparty_forwarding_info: None,
Expand DownExpand Up@@ -2874,8 +2876,8 @@ impl<Signer: WriteableEcdsaChannelSigner> Channel<Signer> {

 let inbound_stats = self.get_inbound_pending_htlc_stats(None);
 let outbound_stats = self.get_outbound_pending_htlc_stats(None);
 if inbound_stats.pending_htlcs + 1 > OUR_MAX_HTLCS as u32 {
 return Err(ChannelError::Close(format!("Remote tried to push more than our max accepted HTLCs ({})", OUR_MAX_HTLCS)));
 if inbound_stats.pending_htlcs + 1 > self.holder_max_accepted_htlcs as u32 {
 return Err(ChannelError::Close(format!("Remote tried to push more than our max accepted HTLCs ({})", self.holder_max_accepted_htlcs)));
 }
 if inbound_stats.pending_htlcs_value_msat + msg.amount_msat > self.holder_max_htlc_value_in_flight_msat {
 return Err(ChannelError::Close(format!("Remote HTLC add would put them over our max HTLC value ({})", self.holder_max_htlc_value_in_flight_msat)));
Expand DownExpand Up@@ -5313,7 +5315,7 @@ impl<Signer: WriteableEcdsaChannelSigner> Channel<Signer> {
 htlc_minimum_msat: self.holder_htlc_minimum_msat,
 feerate_per_kw: self.feerate_per_kw as u32,
 to_self_delay: self.get_holder_selected_contest_delay(),
 max_accepted_htlcs: OUR_MAX_HTLCS,
 max_accepted_htlcs: self.holder_max_accepted_htlcs,
 funding_pubkey: keys.funding_pubkey,
 revocation_basepoint: keys.revocation_basepoint,
 payment_point: keys.payment_point,
Expand DownExpand Up@@ -5380,7 +5382,7 @@ impl<Signer: WriteableEcdsaChannelSigner> Channel<Signer> {
 htlc_minimum_msat: self.holder_htlc_minimum_msat,
 minimum_depth: self.minimum_depth.unwrap(),
 to_self_delay: self.get_holder_selected_contest_delay(),
 max_accepted_htlcs: OUR_MAX_HTLCS,
 max_accepted_htlcs: self.holder_max_accepted_htlcs,
 funding_pubkey: keys.funding_pubkey,
 revocation_basepoint: keys.revocation_basepoint,
 payment_point: keys.payment_point,
Expand DownExpand Up@@ -6496,6 +6498,8 @@ impl<Signer: WriteableEcdsaChannelSigner> Writeable for Channel<Signer> {
 // we write the high bytes as an option here.
 let user_id_high_opt = Some((self.user_id >> 64) as u64);

 let holder_max_accepted_htlcs = if self.holder_max_accepted_htlcs == DEFAULT_MAX_HTLCS { None } else { Some(self.holder_max_accepted_htlcs) };

 write_tlv_fields!(writer, {
 (0, self.announcement_sigs, option),
 // minimum_depth and counterparty_selected_channel_reserve_satoshis used to have a
Expand All@@ -6521,6 +6525,7 @@ impl<Signer: WriteableEcdsaChannelSigner> Writeable for Channel<Signer> {
 (23, channel_ready_event_emitted, option),
 (25, user_id_high_opt, option),
 (27, self.channel_keys_id, required),
 (28, holder_max_accepted_htlcs, option),
 (29, self.temporary_channel_id, option),
 (31, channel_pending_event_emitted, option),
 });
Expand DownExpand Up@@ -6589,7 +6594,8 @@ impl<'a, 'b, 'c, ES: Deref, SP: Deref> ReadableArgs<(&'a ES, &'b SP, u32, &'c Ch
 let value_to_self_msat = Readable::read(reader)?;

 let pending_inbound_htlc_count: u64 = Readable::read(reader)?;
 let mut pending_inbound_htlcs = Vec::with_capacity(cmp::min(pending_inbound_htlc_count as usize, OUR_MAX_HTLCS as usize));

 let mut pending_inbound_htlcs = Vec::with_capacity(cmp::min(pending_inbound_htlc_count as usize, DEFAULT_MAX_HTLCS as usize));
 for _ in 0..pending_inbound_htlc_count {
 pending_inbound_htlcs.push(InboundHTLCOutput {
 htlc_id: Readable::read(reader)?,
Expand All@@ -6607,7 +6613,7 @@ impl<'a, 'b, 'c, ES: Deref, SP: Deref> ReadableArgs<(&'a ES, &'b SP, u32, &'c Ch
 }

 let pending_outbound_htlc_count: u64 = Readable::read(reader)?;
 let mut pending_outbound_htlcs = Vec::with_capacity(cmp::min(pending_outbound_htlc_count as usize, OUR_MAX_HTLCS as usize));
 let mut pending_outbound_htlcs = Vec::with_capacity(cmp::min(pending_outbound_htlc_count as usize, DEFAULT_MAX_HTLCS as usize));
 for _ in 0..pending_outbound_htlc_count {
 pending_outbound_htlcs.push(OutboundHTLCOutput {
 htlc_id: Readable::read(reader)?,
Expand DownExpand Up@@ -6636,7 +6642,7 @@ impl<'a, 'b, 'c, ES: Deref, SP: Deref> ReadableArgs<(&'a ES, &'b SP, u32, &'c Ch
 }

 let holding_cell_htlc_update_count: u64 = Readable::read(reader)?;
 let mut holding_cell_htlc_updates = Vec::with_capacity(cmp::min(holding_cell_htlc_update_count as usize, OUR_MAX_HTLCS as usize*2));
 let mut holding_cell_htlc_updates = Vec::with_capacity(cmp::min(holding_cell_htlc_update_count as usize, DEFAULT_MAX_HTLCS as usize*2));
 for _ in 0..holding_cell_htlc_update_count {
 holding_cell_htlc_updates.push(match <u8 as Readable>::read(reader)? {
 0 => HTLCUpdateAwaitingACK::AddHTLC {
Expand DownExpand Up@@ -6669,13 +6675,13 @@ impl<'a, 'b, 'c, ES: Deref, SP: Deref> ReadableArgs<(&'a ES, &'b SP, u32, &'c Ch
 let monitor_pending_commitment_signed = Readable::read(reader)?;

 let monitor_pending_forwards_count: u64 = Readable::read(reader)?;
 let mut monitor_pending_forwards = Vec::with_capacity(cmp::min(monitor_pending_forwards_count as usize, OUR_MAX_HTLCS as usize));
 let mut monitor_pending_forwards = Vec::with_capacity(cmp::min(monitor_pending_forwards_count as usize, DEFAULT_MAX_HTLCS as usize));
 for _ in 0..monitor_pending_forwards_count {
 monitor_pending_forwards.push((Readable::read(reader)?, Readable::read(reader)?));
 }

 let monitor_pending_failures_count: u64 = Readable::read(reader)?;
 let mut monitor_pending_failures = Vec::with_capacity(cmp::min(monitor_pending_failures_count as usize, OUR_MAX_HTLCS as usize));
 let mut monitor_pending_failures = Vec::with_capacity(cmp::min(monitor_pending_failures_count as usize, DEFAULT_MAX_HTLCS as usize));
 for _ in 0..monitor_pending_failures_count {
 monitor_pending_failures.push((Readable::read(reader)?, Readable::read(reader)?, Readable::read(reader)?));
 }
Expand DownExpand Up@@ -6796,6 +6802,7 @@ impl<'a, 'b, 'c, ES: Deref, SP: Deref> ReadableArgs<(&'a ES, &'b SP, u32, &'c Ch
 let mut user_id_high_opt: Option<u64> = None;
 let mut channel_keys_id: Option<[u8; 32]> = None;
 let mut temporary_channel_id: Option<[u8; 32]> = None;
 let mut holder_max_accepted_htlcs: Option<u16> = None;

 read_tlv_fields!(reader, {
 (0, announcement_sigs, option),
Expand All@@ -6816,6 +6823,7 @@ impl<'a, 'b, 'c, ES: Deref, SP: Deref> ReadableArgs<(&'a ES, &'b SP, u32, &'c Ch
 (23, channel_ready_event_emitted, option),
 (25, user_id_high_opt, option),
 (27, channel_keys_id, option),
 (28, holder_max_accepted_htlcs, option),
 (29, temporary_channel_id, option),
 (31, channel_pending_event_emitted, option),
 });
Expand DownExpand Up@@ -6870,6 +6878,8 @@ impl<'a, 'b, 'c, ES: Deref, SP: Deref> ReadableArgs<(&'a ES, &'b SP, u32, &'c Ch
 // separate u64 values.
 let user_id = user_id_low as u128 + ((user_id_high_opt.unwrap_or(0) as u128) << 64);

 let holder_max_accepted_htlcs = holder_max_accepted_htlcs.unwrap_or(DEFAULT_MAX_HTLCS);

 Ok(Channel {
 user_id,

Expand DownExpand Up@@ -6898,6 +6908,7 @@ impl<'a, 'b, 'c, ES: Deref, SP: Deref> ReadableArgs<(&'a ES, &'b SP, u32, &'c Ch
 cur_counterparty_commitment_transaction_number,
 value_to_self_msat,

 holder_max_accepted_htlcs,
 pending_inbound_htlcs,
 pending_outbound_htlcs,
 holding_cell_htlc_updates,
Expand Down

6 changes: 3 additions & 3 deletions
lightning/src/ln/functional_tests.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1107,7 +1107,7 @@ fn holding_cell_htlc_counting() {
	let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2);

	let mut payments = Vec::new();
	for _ in 0..crate::ln::channel::OUR_MAX_HTLCS {
	for _ in 0..50 {
 let (route, payment_hash, payment_preimage, payment_secret) = get_route_and_payment_hash!(nodes[1], nodes[2], 100000);
 nodes[1].node.send_payment_with_route(&route, payment_hash,
 RecipientOnionFields::secret_only(payment_secret), PaymentId(payment_hash.0)).unwrap();
Expand DownExpand Up@@ -6278,11 +6278,11 @@ fn test_update_add_htlc_bolt2_receiver_check_max_htlc_limit() {
 onion_routing_packet: onion_packet.clone(),
	};

	for i in 0..super::channel::OUR_MAX_HTLCS {
	for i in 0..50 {
 msg.htlc_id = i as u64;
 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &msg);
	}
	msg.htlc_id = (super::channel::OUR_MAX_HTLCS) as u64;
	msg.htlc_id = (50) as u64;
	nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &msg);

	assert!(nodes[1].node.list_channels().is_empty());
Expand Down

14 changes: 14 additions & 0 deletions
lightning/src/util/config.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -170,6 +170,19 @@ pub struct ChannelHandshakeConfig {
	/// [`DecodeError::InvalidValue`]: crate::ln::msgs::DecodeError::InvalidValue
	/// [`SIGHASH_SINGLE + update_fee Considered Harmful`]: https://lists.linuxfoundation.org/pipermail/lightning-dev/2020-September/002796.html
	pub negotiate_anchors_zero_fee_htlc_tx: bool,

	/// The maximum number of HTLCs in-flight from our counterparty towards us at the same time.
	///
	/// Increasing the value can help improve liquidity and stability in
	/// routing at the cost of higher long term disk / DB usage.
	///
	/// Note: Versions of LDK earlier than v0.0.115 will fail to read channels with a configuration
	/// other than the default value.
	///
	/// Default value: 50
Comment thread
swilliamson5 marked this conversation as resolved.

	/// Maximum value: 483, any values larger will be treated as 483.
	/// This is the BOLT #2 spec limit on `max_accepted_htlcs`.
	pub our_max_accepted_htlcs: u16,
}

impl Default for ChannelHandshakeConfig {
Expand All@@ -185,6 +198,7 @@ impl Default for ChannelHandshakeConfig {
 their_channel_reserve_proportional_millionths: 10_000,
 #[cfg(anchors)]
 negotiate_anchors_zero_fee_htlc_tx: false,
 our_max_accepted_htlcs: 50,
 }
	}
}
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Remove or un-stick sticky/fixed headers that block content
(function() {
function unstick() {
document.querySelectorAll('header, nav, [role="banner"], .header, .navbar, .sticky, .fixed-top, [style*="position: fixed"], [style*="position:sticky"]').forEach(function(el) {
if (el.style.position === 'fixed' || el.style.position === 'sticky' || getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {
el.style.position = 'static';
el.style.top = 'auto';
el.style.zIndex = 'auto';
}
});
}
unstick();
var observer = new MutationObserver(unstick);
observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });
})();
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
Replace `OUR_MAX_HTLCS` with config knob by swilliamson5 · Pull Request #2138 · lightningdevkit/rust-lightning · GitHub
Skip to content
Replace OUR_MAX_HTLCS with config knob#2138

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

TheBlueMatt
merged 1 commit into

from

Apr 17, 2023
 Merged


Replace OUR_MAX_HTLCS with config knob
#2138
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


33 changes: 22 additions & 11 deletions
lightning/src/ln/channel.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -653,7 +653,7 @@ pub(super) struct Channel<Signer: ChannelSigner> {
	pub counterparty_max_accepted_htlcs: u16,
	#[cfg(not(test))]
	counterparty_max_accepted_htlcs: u16,
//implied by OUR_MAX_HTLCS: max_accepted_htlcs: u16,
holder_max_accepted_htlcs: u16,
	minimum_depth: Option<u32>,

	counterparty_forwarding_info: Option<CounterpartyForwardingInfo>,
Expand DownExpand Up@@ -756,7 +756,7 @@ struct CommitmentTxInfoCached {
	feerate: u32,
}

pub const OUR_MAX_HTLCS: u16 = 50; //TODO
Comment thread
swilliamson5 marked this conversation as resolved.

pub const DEFAULT_MAX_HTLCS: u16 = 50;

pub(crate) fn commitment_tx_base_weight(opt_anchors: bool) -> u64 {
	const COMMITMENT_TX_BASE_WEIGHT: u64 = 724;
Expand DownExpand Up@@ -1072,6 +1072,7 @@ impl<Signer: WriteableEcdsaChannelSigner> Channel<Signer> {
 counterparty_htlc_minimum_msat: 0,
 holder_htlc_minimum_msat: if config.channel_handshake_config.our_htlc_minimum_msat == 0 { 1 } else { config.channel_handshake_config.our_htlc_minimum_msat },
 counterparty_max_accepted_htlcs: 0,
 holder_max_accepted_htlcs: cmp::min(config.channel_handshake_config.our_max_accepted_htlcs, MAX_HTLCS),
 minimum_depth: None, // Filled in in accept_channel

 counterparty_forwarding_info: None,
Expand DownExpand Up@@ -1419,6 +1420,7 @@ impl<Signer: WriteableEcdsaChannelSigner> Channel<Signer> {
 counterparty_htlc_minimum_msat: msg.htlc_minimum_msat,
 holder_htlc_minimum_msat: if config.channel_handshake_config.our_htlc_minimum_msat == 0 { 1 } else { config.channel_handshake_config.our_htlc_minimum_msat },
 counterparty_max_accepted_htlcs: msg.max_accepted_htlcs,
 holder_max_accepted_htlcs: cmp::min(config.channel_handshake_config.our_max_accepted_htlcs, MAX_HTLCS),
 minimum_depth: Some(cmp::max(config.channel_handshake_config.minimum_depth, 1)),

 counterparty_forwarding_info: None,
Expand DownExpand Up@@ -2874,8 +2876,8 @@ impl<Signer: WriteableEcdsaChannelSigner> Channel<Signer> {

 let inbound_stats = self.get_inbound_pending_htlc_stats(None);
 let outbound_stats = self.get_outbound_pending_htlc_stats(None);
 if inbound_stats.pending_htlcs + 1 > OUR_MAX_HTLCS as u32 {
 return Err(ChannelError::Close(format!("Remote tried to push more than our max accepted HTLCs ({})", OUR_MAX_HTLCS)));
 if inbound_stats.pending_htlcs + 1 > self.holder_max_accepted_htlcs as u32 {
 return Err(ChannelError::Close(format!("Remote tried to push more than our max accepted HTLCs ({})", self.holder_max_accepted_htlcs)));
 }
 if inbound_stats.pending_htlcs_value_msat + msg.amount_msat > self.holder_max_htlc_value_in_flight_msat {
 return Err(ChannelError::Close(format!("Remote HTLC add would put them over our max HTLC value ({})", self.holder_max_htlc_value_in_flight_msat)));
Expand DownExpand Up@@ -5313,7 +5315,7 @@ impl<Signer: WriteableEcdsaChannelSigner> Channel<Signer> {
 htlc_minimum_msat: self.holder_htlc_minimum_msat,
 feerate_per_kw: self.feerate_per_kw as u32,
 to_self_delay: self.get_holder_selected_contest_delay(),
 max_accepted_htlcs: OUR_MAX_HTLCS,
 max_accepted_htlcs: self.holder_max_accepted_htlcs,
 funding_pubkey: keys.funding_pubkey,
 revocation_basepoint: keys.revocation_basepoint,
 payment_point: keys.payment_point,
Expand DownExpand Up@@ -5380,7 +5382,7 @@ impl<Signer: WriteableEcdsaChannelSigner> Channel<Signer> {
 htlc_minimum_msat: self.holder_htlc_minimum_msat,
 minimum_depth: self.minimum_depth.unwrap(),
 to_self_delay: self.get_holder_selected_contest_delay(),
 max_accepted_htlcs: OUR_MAX_HTLCS,
 max_accepted_htlcs: self.holder_max_accepted_htlcs,
 funding_pubkey: keys.funding_pubkey,
 revocation_basepoint: keys.revocation_basepoint,
 payment_point: keys.payment_point,
Expand DownExpand Up@@ -6496,6 +6498,8 @@ impl<Signer: WriteableEcdsaChannelSigner> Writeable for Channel<Signer> {
 // we write the high bytes as an option here.
 let user_id_high_opt = Some((self.user_id >> 64) as u64);

 let holder_max_accepted_htlcs = if self.holder_max_accepted_htlcs == DEFAULT_MAX_HTLCS { None } else { Some(self.holder_max_accepted_htlcs) };

 write_tlv_fields!(writer, {
 (0, self.announcement_sigs, option),
 // minimum_depth and counterparty_selected_channel_reserve_satoshis used to have a
Expand All@@ -6521,6 +6525,7 @@ impl<Signer: WriteableEcdsaChannelSigner> Writeable for Channel<Signer> {
 (23, channel_ready_event_emitted, option),
 (25, user_id_high_opt, option),
 (27, self.channel_keys_id, required),
 (28, holder_max_accepted_htlcs, option),
 (29, self.temporary_channel_id, option),
 (31, channel_pending_event_emitted, option),
 });
Expand DownExpand Up@@ -6589,7 +6594,8 @@ impl<'a, 'b, 'c, ES: Deref, SP: Deref> ReadableArgs<(&'a ES, &'b SP, u32, &'c Ch
 let value_to_self_msat = Readable::read(reader)?;

 let pending_inbound_htlc_count: u64 = Readable::read(reader)?;
 let mut pending_inbound_htlcs = Vec::with_capacity(cmp::min(pending_inbound_htlc_count as usize, OUR_MAX_HTLCS as usize));

 let mut pending_inbound_htlcs = Vec::with_capacity(cmp::min(pending_inbound_htlc_count as usize, DEFAULT_MAX_HTLCS as usize));
 for _ in 0..pending_inbound_htlc_count {
 pending_inbound_htlcs.push(InboundHTLCOutput {
 htlc_id: Readable::read(reader)?,
Expand All@@ -6607,7 +6613,7 @@ impl<'a, 'b, 'c, ES: Deref, SP: Deref> ReadableArgs<(&'a ES, &'b SP, u32, &'c Ch
 }

 let pending_outbound_htlc_count: u64 = Readable::read(reader)?;
 let mut pending_outbound_htlcs = Vec::with_capacity(cmp::min(pending_outbound_htlc_count as usize, OUR_MAX_HTLCS as usize));
 let mut pending_outbound_htlcs = Vec::with_capacity(cmp::min(pending_outbound_htlc_count as usize, DEFAULT_MAX_HTLCS as usize));
 for _ in 0..pending_outbound_htlc_count {
 pending_outbound_htlcs.push(OutboundHTLCOutput {
 htlc_id: Readable::read(reader)?,
Expand DownExpand Up@@ -6636,7 +6642,7 @@ impl<'a, 'b, 'c, ES: Deref, SP: Deref> ReadableArgs<(&'a ES, &'b SP, u32, &'c Ch
 }

 let holding_cell_htlc_update_count: u64 = Readable::read(reader)?;
 let mut holding_cell_htlc_updates = Vec::with_capacity(cmp::min(holding_cell_htlc_update_count as usize, OUR_MAX_HTLCS as usize*2));
 let mut holding_cell_htlc_updates = Vec::with_capacity(cmp::min(holding_cell_htlc_update_count as usize, DEFAULT_MAX_HTLCS as usize*2));
 for _ in 0..holding_cell_htlc_update_count {
 holding_cell_htlc_updates.push(match <u8 as Readable>::read(reader)? {
 0 => HTLCUpdateAwaitingACK::AddHTLC {
Expand DownExpand Up@@ -6669,13 +6675,13 @@ impl<'a, 'b, 'c, ES: Deref, SP: Deref> ReadableArgs<(&'a ES, &'b SP, u32, &'c Ch
 let monitor_pending_commitment_signed = Readable::read(reader)?;

 let monitor_pending_forwards_count: u64 = Readable::read(reader)?;
 let mut monitor_pending_forwards = Vec::with_capacity(cmp::min(monitor_pending_forwards_count as usize, OUR_MAX_HTLCS as usize));
 let mut monitor_pending_forwards = Vec::with_capacity(cmp::min(monitor_pending_forwards_count as usize, DEFAULT_MAX_HTLCS as usize));
 for _ in 0..monitor_pending_forwards_count {
 monitor_pending_forwards.push((Readable::read(reader)?, Readable::read(reader)?));
 }

 let monitor_pending_failures_count: u64 = Readable::read(reader)?;
 let mut monitor_pending_failures = Vec::with_capacity(cmp::min(monitor_pending_failures_count as usize, OUR_MAX_HTLCS as usize));
 let mut monitor_pending_failures = Vec::with_capacity(cmp::min(monitor_pending_failures_count as usize, DEFAULT_MAX_HTLCS as usize));
 for _ in 0..monitor_pending_failures_count {
 monitor_pending_failures.push((Readable::read(reader)?, Readable::read(reader)?, Readable::read(reader)?));
 }
Expand DownExpand Up@@ -6796,6 +6802,7 @@ impl<'a, 'b, 'c, ES: Deref, SP: Deref> ReadableArgs<(&'a ES, &'b SP, u32, &'c Ch
 let mut user_id_high_opt: Option<u64> = None;
 let mut channel_keys_id: Option<[u8; 32]> = None;
 let mut temporary_channel_id: Option<[u8; 32]> = None;
 let mut holder_max_accepted_htlcs: Option<u16> = None;

 read_tlv_fields!(reader, {
 (0, announcement_sigs, option),
Expand All@@ -6816,6 +6823,7 @@ impl<'a, 'b, 'c, ES: Deref, SP: Deref> ReadableArgs<(&'a ES, &'b SP, u32, &'c Ch
 (23, channel_ready_event_emitted, option),
 (25, user_id_high_opt, option),
 (27, channel_keys_id, option),
 (28, holder_max_accepted_htlcs, option),
 (29, temporary_channel_id, option),
 (31, channel_pending_event_emitted, option),
 });
Expand DownExpand Up@@ -6870,6 +6878,8 @@ impl<'a, 'b, 'c, ES: Deref, SP: Deref> ReadableArgs<(&'a ES, &'b SP, u32, &'c Ch
 // separate u64 values.
 let user_id = user_id_low as u128 + ((user_id_high_opt.unwrap_or(0) as u128) << 64);

 let holder_max_accepted_htlcs = holder_max_accepted_htlcs.unwrap_or(DEFAULT_MAX_HTLCS);

 Ok(Channel {
 user_id,

Expand DownExpand Up@@ -6898,6 +6908,7 @@ impl<'a, 'b, 'c, ES: Deref, SP: Deref> ReadableArgs<(&'a ES, &'b SP, u32, &'c Ch
 cur_counterparty_commitment_transaction_number,
 value_to_self_msat,

 holder_max_accepted_htlcs,
 pending_inbound_htlcs,
 pending_outbound_htlcs,
 holding_cell_htlc_updates,
Expand Down

6 changes: 3 additions & 3 deletions
lightning/src/ln/functional_tests.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1107,7 +1107,7 @@ fn holding_cell_htlc_counting() {
	let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2);

	let mut payments = Vec::new();
	for _ in 0..crate::ln::channel::OUR_MAX_HTLCS {
	for _ in 0..50 {
 let (route, payment_hash, payment_preimage, payment_secret) = get_route_and_payment_hash!(nodes[1], nodes[2], 100000);
 nodes[1].node.send_payment_with_route(&route, payment_hash,
 RecipientOnionFields::secret_only(payment_secret), PaymentId(payment_hash.0)).unwrap();
Expand DownExpand Up@@ -6278,11 +6278,11 @@ fn test_update_add_htlc_bolt2_receiver_check_max_htlc_limit() {
 onion_routing_packet: onion_packet.clone(),
	};

	for i in 0..super::channel::OUR_MAX_HTLCS {
	for i in 0..50 {
 msg.htlc_id = i as u64;
 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &msg);
	}
	msg.htlc_id = (super::channel::OUR_MAX_HTLCS) as u64;
	msg.htlc_id = (50) as u64;
	nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &msg);

	assert!(nodes[1].node.list_channels().is_empty());
Expand Down

14 changes: 14 additions & 0 deletions
lightning/src/util/config.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -170,6 +170,19 @@ pub struct ChannelHandshakeConfig {
	/// [`DecodeError::InvalidValue`]: crate::ln::msgs::DecodeError::InvalidValue
	/// [`SIGHASH_SINGLE + update_fee Considered Harmful`]: https://lists.linuxfoundation.org/pipermail/lightning-dev/2020-September/002796.html
	pub negotiate_anchors_zero_fee_htlc_tx: bool,

	/// The maximum number of HTLCs in-flight from our counterparty towards us at the same time.
	///
	/// Increasing the value can help improve liquidity and stability in
	/// routing at the cost of higher long term disk / DB usage.
	///
	/// Note: Versions of LDK earlier than v0.0.115 will fail to read channels with a configuration
	/// other than the default value.
	///
	/// Default value: 50
Comment thread
swilliamson5 marked this conversation as resolved.

	/// Maximum value: 483, any values larger will be treated as 483.
	/// This is the BOLT #2 spec limit on `max_accepted_htlcs`.
	pub our_max_accepted_htlcs: u16,
}

impl Default for ChannelHandshakeConfig {
Expand All@@ -185,6 +198,7 @@ impl Default for ChannelHandshakeConfig {
 their_channel_reserve_proportional_millionths: 10_000,
 #[cfg(anchors)]
 negotiate_anchors_zero_fee_htlc_tx: false,
 our_max_accepted_htlcs: 50,
 }
	}
}
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Universal Dark Mode - works on any site
(function() {
var enabled = true;
function applyDarkMode() {
if (!enabled) return;
// Create style element if it doesn't exist
var style = document.getElementById('universal-dark-mode-style');
if (!style) {
style = document.createElement('style');
style.id = 'universal-dark-mode-style';
document.head.appendChild(style);
}
// Dark mode CSS - inverts colors but preserves images/video
style.textContent = '
/* Invert everything except media */
html {
filter: invert(1) hue-rotate(180deg) !important;
background: #1a1a2e !important;
}
/* Restore images, videos, iframes, canvas */
img, video, iframe, canvas, svg, picture, [style*="background-image"] {
filter: invert(1) hue-rotate(180deg) !important;
}
/* Preserve specific elements that should not be inverted */
.no-dark-mode, .no-dark-mode *,
[data-theme="light"], [data-theme="light"],
.ace_editor, .ace_editor *,
.CodeMirror, .CodeMirror *,
.monaco-editor, .monaco-editor *,
.markdown-body pre, .markdown-body pre *,
.highlight, .highlight *,
pre code, pre code * {
filter: none !important;
}
/* Fix common UI elements */
.modal, .popup, .dropdown-menu, .tooltip, .popover {
filter: invert(1) hue-rotate(180deg) !important;
background: #2d2d44 !important;
border-color: #444 !important;
}
/* Scrollbars */
::-webkit-scrollbar { background: #1a1a2e !important; }
::-webkit-scrollbar-thumb { background: #444 !important; }
::-webkit-scrollbar-thumb:hover { background: #555 !important; }
/* Selection */
::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }
::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }
';
}
function removeDarkMode() {
var style = document.getElementById('universal-dark-mode-style');
if (style) style.remove();
}
// Toggle with Alt+Shift+D
document.addEventListener('keydown', function(e) {
if (e.altKey && e.shiftKey && e.key === 'D') {
e.preventDefault();
enabled = !enabled;
if (enabled) {
applyDarkMode();
console.log('[Universal Dark Mode] Enabled');
} else {
removeDarkMode();
console.log('[Universal Dark Mode] Disabled');
}
}
});
// Apply on load
applyDarkMode();
// Re-apply on dynamic content
var observer = new MutationObserver(function(mutations) {
if (enabled && !document.getElementById('universal-dark-mode-style')) {
applyDarkMode();
}
});
observer.observe(document.head, { childList: true });
console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');
})();
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();
Replace `OUR_MAX_HTLCS` with config knob by swilliamson5 · Pull Request #2138 · lightningdevkit/rust-lightning · GitHub
Skip to content
Replace OUR_MAX_HTLCS with config knob#2138

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

TheBlueMatt
merged 1 commit into

from

Apr 17, 2023
 Merged


Replace OUR_MAX_HTLCS with config knob
#2138
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


33 changes: 22 additions & 11 deletions
lightning/src/ln/channel.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -653,7 +653,7 @@ pub(super) struct Channel<Signer: ChannelSigner> {
	pub counterparty_max_accepted_htlcs: u16,
	#[cfg(not(test))]
	counterparty_max_accepted_htlcs: u16,
//implied by OUR_MAX_HTLCS: max_accepted_htlcs: u16,
holder_max_accepted_htlcs: u16,
	minimum_depth: Option<u32>,

	counterparty_forwarding_info: Option<CounterpartyForwardingInfo>,
Expand DownExpand Up@@ -756,7 +756,7 @@ struct CommitmentTxInfoCached {
	feerate: u32,
}

pub const OUR_MAX_HTLCS: u16 = 50; //TODO
Comment thread
swilliamson5 marked this conversation as resolved.

pub const DEFAULT_MAX_HTLCS: u16 = 50;

pub(crate) fn commitment_tx_base_weight(opt_anchors: bool) -> u64 {
	const COMMITMENT_TX_BASE_WEIGHT: u64 = 724;
Expand DownExpand Up@@ -1072,6 +1072,7 @@ impl<Signer: WriteableEcdsaChannelSigner> Channel<Signer> {
 counterparty_htlc_minimum_msat: 0,
 holder_htlc_minimum_msat: if config.channel_handshake_config.our_htlc_minimum_msat == 0 { 1 } else { config.channel_handshake_config.our_htlc_minimum_msat },
 counterparty_max_accepted_htlcs: 0,
 holder_max_accepted_htlcs: cmp::min(config.channel_handshake_config.our_max_accepted_htlcs, MAX_HTLCS),
 minimum_depth: None, // Filled in in accept_channel

 counterparty_forwarding_info: None,
Expand DownExpand Up@@ -1419,6 +1420,7 @@ impl<Signer: WriteableEcdsaChannelSigner> Channel<Signer> {
 counterparty_htlc_minimum_msat: msg.htlc_minimum_msat,
 holder_htlc_minimum_msat: if config.channel_handshake_config.our_htlc_minimum_msat == 0 { 1 } else { config.channel_handshake_config.our_htlc_minimum_msat },
 counterparty_max_accepted_htlcs: msg.max_accepted_htlcs,
 holder_max_accepted_htlcs: cmp::min(config.channel_handshake_config.our_max_accepted_htlcs, MAX_HTLCS),
 minimum_depth: Some(cmp::max(config.channel_handshake_config.minimum_depth, 1)),

 counterparty_forwarding_info: None,
Expand DownExpand Up@@ -2874,8 +2876,8 @@ impl<Signer: WriteableEcdsaChannelSigner> Channel<Signer> {

 let inbound_stats = self.get_inbound_pending_htlc_stats(None);
 let outbound_stats = self.get_outbound_pending_htlc_stats(None);
 if inbound_stats.pending_htlcs + 1 > OUR_MAX_HTLCS as u32 {
 return Err(ChannelError::Close(format!("Remote tried to push more than our max accepted HTLCs ({})", OUR_MAX_HTLCS)));
 if inbound_stats.pending_htlcs + 1 > self.holder_max_accepted_htlcs as u32 {
 return Err(ChannelError::Close(format!("Remote tried to push more than our max accepted HTLCs ({})", self.holder_max_accepted_htlcs)));
 }
 if inbound_stats.pending_htlcs_value_msat + msg.amount_msat > self.holder_max_htlc_value_in_flight_msat {
 return Err(ChannelError::Close(format!("Remote HTLC add would put them over our max HTLC value ({})", self.holder_max_htlc_value_in_flight_msat)));
Expand DownExpand Up@@ -5313,7 +5315,7 @@ impl<Signer: WriteableEcdsaChannelSigner> Channel<Signer> {
 htlc_minimum_msat: self.holder_htlc_minimum_msat,
 feerate_per_kw: self.feerate_per_kw as u32,
 to_self_delay: self.get_holder_selected_contest_delay(),
 max_accepted_htlcs: OUR_MAX_HTLCS,
 max_accepted_htlcs: self.holder_max_accepted_htlcs,
 funding_pubkey: keys.funding_pubkey,
 revocation_basepoint: keys.revocation_basepoint,
 payment_point: keys.payment_point,
Expand DownExpand Up@@ -5380,7 +5382,7 @@ impl<Signer: WriteableEcdsaChannelSigner> Channel<Signer> {
 htlc_minimum_msat: self.holder_htlc_minimum_msat,
 minimum_depth: self.minimum_depth.unwrap(),
 to_self_delay: self.get_holder_selected_contest_delay(),
 max_accepted_htlcs: OUR_MAX_HTLCS,
 max_accepted_htlcs: self.holder_max_accepted_htlcs,
 funding_pubkey: keys.funding_pubkey,
 revocation_basepoint: keys.revocation_basepoint,
 payment_point: keys.payment_point,
Expand DownExpand Up@@ -6496,6 +6498,8 @@ impl<Signer: WriteableEcdsaChannelSigner> Writeable for Channel<Signer> {
 // we write the high bytes as an option here.
 let user_id_high_opt = Some((self.user_id >> 64) as u64);

 let holder_max_accepted_htlcs = if self.holder_max_accepted_htlcs == DEFAULT_MAX_HTLCS { None } else { Some(self.holder_max_accepted_htlcs) };

 write_tlv_fields!(writer, {
 (0, self.announcement_sigs, option),
 // minimum_depth and counterparty_selected_channel_reserve_satoshis used to have a
Expand All@@ -6521,6 +6525,7 @@ impl<Signer: WriteableEcdsaChannelSigner> Writeable for Channel<Signer> {
 (23, channel_ready_event_emitted, option),
 (25, user_id_high_opt, option),
 (27, self.channel_keys_id, required),
 (28, holder_max_accepted_htlcs, option),
 (29, self.temporary_channel_id, option),
 (31, channel_pending_event_emitted, option),
 });
Expand DownExpand Up@@ -6589,7 +6594,8 @@ impl<'a, 'b, 'c, ES: Deref, SP: Deref> ReadableArgs<(&'a ES, &'b SP, u32, &'c Ch
 let value_to_self_msat = Readable::read(reader)?;

 let pending_inbound_htlc_count: u64 = Readable::read(reader)?;
 let mut pending_inbound_htlcs = Vec::with_capacity(cmp::min(pending_inbound_htlc_count as usize, OUR_MAX_HTLCS as usize));

 let mut pending_inbound_htlcs = Vec::with_capacity(cmp::min(pending_inbound_htlc_count as usize, DEFAULT_MAX_HTLCS as usize));
 for _ in 0..pending_inbound_htlc_count {
 pending_inbound_htlcs.push(InboundHTLCOutput {
 htlc_id: Readable::read(reader)?,
Expand All@@ -6607,7 +6613,7 @@ impl<'a, 'b, 'c, ES: Deref, SP: Deref> ReadableArgs<(&'a ES, &'b SP, u32, &'c Ch
 }

 let pending_outbound_htlc_count: u64 = Readable::read(reader)?;
 let mut pending_outbound_htlcs = Vec::with_capacity(cmp::min(pending_outbound_htlc_count as usize, OUR_MAX_HTLCS as usize));
 let mut pending_outbound_htlcs = Vec::with_capacity(cmp::min(pending_outbound_htlc_count as usize, DEFAULT_MAX_HTLCS as usize));
 for _ in 0..pending_outbound_htlc_count {
 pending_outbound_htlcs.push(OutboundHTLCOutput {
 htlc_id: Readable::read(reader)?,
Expand DownExpand Up@@ -6636,7 +6642,7 @@ impl<'a, 'b, 'c, ES: Deref, SP: Deref> ReadableArgs<(&'a ES, &'b SP, u32, &'c Ch
 }

 let holding_cell_htlc_update_count: u64 = Readable::read(reader)?;
 let mut holding_cell_htlc_updates = Vec::with_capacity(cmp::min(holding_cell_htlc_update_count as usize, OUR_MAX_HTLCS as usize*2));
 let mut holding_cell_htlc_updates = Vec::with_capacity(cmp::min(holding_cell_htlc_update_count as usize, DEFAULT_MAX_HTLCS as usize*2));
 for _ in 0..holding_cell_htlc_update_count {
 holding_cell_htlc_updates.push(match <u8 as Readable>::read(reader)? {
 0 => HTLCUpdateAwaitingACK::AddHTLC {
Expand DownExpand Up@@ -6669,13 +6675,13 @@ impl<'a, 'b, 'c, ES: Deref, SP: Deref> ReadableArgs<(&'a ES, &'b SP, u32, &'c Ch
 let monitor_pending_commitment_signed = Readable::read(reader)?;

 let monitor_pending_forwards_count: u64 = Readable::read(reader)?;
 let mut monitor_pending_forwards = Vec::with_capacity(cmp::min(monitor_pending_forwards_count as usize, OUR_MAX_HTLCS as usize));
 let mut monitor_pending_forwards = Vec::with_capacity(cmp::min(monitor_pending_forwards_count as usize, DEFAULT_MAX_HTLCS as usize));
 for _ in 0..monitor_pending_forwards_count {
 monitor_pending_forwards.push((Readable::read(reader)?, Readable::read(reader)?));
 }

 let monitor_pending_failures_count: u64 = Readable::read(reader)?;
 let mut monitor_pending_failures = Vec::with_capacity(cmp::min(monitor_pending_failures_count as usize, OUR_MAX_HTLCS as usize));
 let mut monitor_pending_failures = Vec::with_capacity(cmp::min(monitor_pending_failures_count as usize, DEFAULT_MAX_HTLCS as usize));
 for _ in 0..monitor_pending_failures_count {
 monitor_pending_failures.push((Readable::read(reader)?, Readable::read(reader)?, Readable::read(reader)?));
 }
Expand DownExpand Up@@ -6796,6 +6802,7 @@ impl<'a, 'b, 'c, ES: Deref, SP: Deref> ReadableArgs<(&'a ES, &'b SP, u32, &'c Ch
 let mut user_id_high_opt: Option<u64> = None;
 let mut channel_keys_id: Option<[u8; 32]> = None;
 let mut temporary_channel_id: Option<[u8; 32]> = None;
 let mut holder_max_accepted_htlcs: Option<u16> = None;

 read_tlv_fields!(reader, {
 (0, announcement_sigs, option),
Expand All@@ -6816,6 +6823,7 @@ impl<'a, 'b, 'c, ES: Deref, SP: Deref> ReadableArgs<(&'a ES, &'b SP, u32, &'c Ch
 (23, channel_ready_event_emitted, option),
 (25, user_id_high_opt, option),
 (27, channel_keys_id, option),
 (28, holder_max_accepted_htlcs, option),
 (29, temporary_channel_id, option),
 (31, channel_pending_event_emitted, option),
 });
Expand DownExpand Up@@ -6870,6 +6878,8 @@ impl<'a, 'b, 'c, ES: Deref, SP: Deref> ReadableArgs<(&'a ES, &'b SP, u32, &'c Ch
 // separate u64 values.
 let user_id = user_id_low as u128 + ((user_id_high_opt.unwrap_or(0) as u128) << 64);

 let holder_max_accepted_htlcs = holder_max_accepted_htlcs.unwrap_or(DEFAULT_MAX_HTLCS);

 Ok(Channel {
 user_id,

Expand DownExpand Up@@ -6898,6 +6908,7 @@ impl<'a, 'b, 'c, ES: Deref, SP: Deref> ReadableArgs<(&'a ES, &'b SP, u32, &'c Ch
 cur_counterparty_commitment_transaction_number,
 value_to_self_msat,

 holder_max_accepted_htlcs,
 pending_inbound_htlcs,
 pending_outbound_htlcs,
 holding_cell_htlc_updates,
Expand Down

6 changes: 3 additions & 3 deletions
lightning/src/ln/functional_tests.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1107,7 +1107,7 @@ fn holding_cell_htlc_counting() {
	let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2);

	let mut payments = Vec::new();
	for _ in 0..crate::ln::channel::OUR_MAX_HTLCS {
	for _ in 0..50 {
 let (route, payment_hash, payment_preimage, payment_secret) = get_route_and_payment_hash!(nodes[1], nodes[2], 100000);
 nodes[1].node.send_payment_with_route(&route, payment_hash,
 RecipientOnionFields::secret_only(payment_secret), PaymentId(payment_hash.0)).unwrap();
Expand DownExpand Up@@ -6278,11 +6278,11 @@ fn test_update_add_htlc_bolt2_receiver_check_max_htlc_limit() {
 onion_routing_packet: onion_packet.clone(),
	};

	for i in 0..super::channel::OUR_MAX_HTLCS {
	for i in 0..50 {
 msg.htlc_id = i as u64;
 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &msg);
	}
	msg.htlc_id = (super::channel::OUR_MAX_HTLCS) as u64;
	msg.htlc_id = (50) as u64;
	nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &msg);

	assert!(nodes[1].node.list_channels().is_empty());
Expand Down

14 changes: 14 additions & 0 deletions
lightning/src/util/config.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -170,6 +170,19 @@ pub struct ChannelHandshakeConfig {
	/// [`DecodeError::InvalidValue`]: crate::ln::msgs::DecodeError::InvalidValue
	/// [`SIGHASH_SINGLE + update_fee Considered Harmful`]: https://lists.linuxfoundation.org/pipermail/lightning-dev/2020-September/002796.html
	pub negotiate_anchors_zero_fee_htlc_tx: bool,

	/// The maximum number of HTLCs in-flight from our counterparty towards us at the same time.
	///
	/// Increasing the value can help improve liquidity and stability in
	/// routing at the cost of higher long term disk / DB usage.
	///
	/// Note: Versions of LDK earlier than v0.0.115 will fail to read channels with a configuration
	/// other than the default value.
	///
	/// Default value: 50
Comment thread
swilliamson5 marked this conversation as resolved.

	/// Maximum value: 483, any values larger will be treated as 483.
	/// This is the BOLT #2 spec limit on `max_accepted_htlcs`.
	pub our_max_accepted_htlcs: u16,
}

impl Default for ChannelHandshakeConfig {
Expand All@@ -185,6 +198,7 @@ impl Default for ChannelHandshakeConfig {
 their_channel_reserve_proportional_millionths: 10_000,
 #[cfg(anchors)]
 negotiate_anchors_zero_fee_htlc_tx: false,
 our_max_accepted_htlcs: 50,
 }
	}
}
Expand Down