Skip to content

Post-#2314 Cleanups #3#2769

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
wpaulino merged 6 commits into from
Dec 4, 2023
Merged

Post-#2314 Cleanups #3 #2769

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
f57295f
Include counterparty node id and channel id in shutdown log
TheBlueMatt Dec 2, 2023
0ce0d48
Add missing counterparty node id metadata to logs in HTLC decoding
TheBlueMatt Dec 2, 2023
2fc79cb
Include next-hop counterparty node id in log metadata when sending
TheBlueMatt Dec 2, 2023
b0606a1
Log next-hop metadata when forwarding or failing to forward HTLC
TheBlueMatt Dec 2, 2023
2be5e37
Set log metadata in a few additional locations in `channelmanager`
TheBlueMatt Dec 3, 2023
cf0539e
Doc that `Record::node_id` may be missing even with `channel_id`
TheBlueMatt Dec 3, 2023
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
10 changes: 10 additions & 0 deletions lightning/src/ln/channel.rs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -599,6 +599,8 @@ pub(crate) struct ShutdownResult {
/// An unbroadcasted batch funding transaction id. The closure of this channel should be
/// propagated to the remainder of the batch.
pub(crate) unbroadcasted_batch_funding_txid: Option<Txid>,
pub(crate) channel_id: ChannelId,
pub(crate) counterparty_node_id: PublicKey,
}

/// If the majority of the channels funds are to the fundee and the initiator holds only just
Expand DownExpand Up@@ -2164,6 +2166,8 @@ impl<SP: Deref> ChannelContext<SP> where SP::Target: SignerProvider {
monitor_update,
dropped_outbound_htlcs,
unbroadcasted_batch_funding_txid,
channel_id: self.channel_id,
counterparty_node_id: self.counterparty_node_id,
}
}

Expand DownExpand Up@@ -4707,6 +4711,8 @@ impl<SP: Deref> Channel<SP> where
monitor_update: None,
dropped_outbound_htlcs: Vec::new(),
unbroadcasted_batch_funding_txid: self.context.unbroadcasted_batch_funding_txid(),
channel_id: self.context.channel_id,
counterparty_node_id: self.context.counterparty_node_id,
};
let tx = self.build_signed_closing_transaction(&mut closing_tx, &msg.signature, &sig);
self.context.channel_state = ChannelState::ShutdownComplete as u32;
Expand DownExpand Up@@ -4735,6 +4741,8 @@ impl<SP: Deref> Channel<SP> where
monitor_update: None,
dropped_outbound_htlcs: Vec::new(),
unbroadcasted_batch_funding_txid: self.context.unbroadcasted_batch_funding_txid(),
channel_id: self.context.channel_id,
counterparty_node_id: self.context.counterparty_node_id,
};
self.context.channel_state = ChannelState::ShutdownComplete as u32;
self.context.update_time_counter += 1;
Expand DownExpand Up@@ -5913,6 +5921,8 @@ impl<SP: Deref> Channel<SP> where
monitor_update: None,
dropped_outbound_htlcs: Vec::new(),
unbroadcasted_batch_funding_txid: self.context.unbroadcasted_batch_funding_txid(),
channel_id: self.context.channel_id,
counterparty_node_id: self.context.counterparty_node_id,
};
self.context.channel_state = ChannelState::ShutdownComplete as u32;
Some(shutdown_result)
Expand Down
59 changes: 41 additions & 18 deletions lightning/src/ln/channelmanager.rs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -2808,7 +2808,10 @@ where
debug_assert_ne!(peer.held_by_thread(), LockHeldState::HeldByThread);
}

log_debug!(self.logger, "Finishing closure of channel with {} HTLCs to fail", shutdown_res.dropped_outbound_htlcs.len());
let logger = WithContext::from(
&self.logger, Some(shutdown_res.counterparty_node_id), Some(shutdown_res.channel_id),
);
log_debug!(logger, "Finishing closure of channel with {} HTLCs to fail", shutdown_res.dropped_outbound_htlcs.len());
for htlc_source in shutdown_res.dropped_outbound_htlcs.drain(..) {
let (source, payment_hash, counterparty_node_id, channel_id) = htlc_source;
let reason = HTLCFailReason::from_failure_code(0x4000 | 8);
Expand DownExpand Up@@ -2967,7 +2970,7 @@ where
}

fn decode_update_add_htlc_onion(
&self, msg: &msgs::UpdateAddHTLC
&self, msg: &msgs::UpdateAddHTLC, counterparty_node_id: &PublicKey,
) -> Result<
(onion_utils::Hop, [u8; 32], Option<Result<PublicKey, secp256k1::Error>>), HTLCFailureMsg
> {
Expand All@@ -2986,7 +2989,7 @@ where
($msg: expr, $err_code: expr, $data: expr) => {
{
log_info!(
WithContext::from(&self.logger, None, Some(msg.channel_id)),
WithContext::from(&self.logger, Some(*counterparty_node_id), Some(msg.channel_id)),
"Failed to accept/forward incoming HTLC: {}", $msg
);
let (err_code, err_data) = if is_blinded {
Expand DownExpand Up@@ -3133,13 +3136,15 @@ where
}

fn construct_pending_htlc_status<'a>(
&self, msg: &msgs::UpdateAddHTLC, shared_secret: [u8; 32], decoded_hop: onion_utils::Hop,
allow_underpay: bool, next_packet_pubkey_opt: Option<Result<PublicKey, secp256k1::Error>>
&self, msg: &msgs::UpdateAddHTLC, counterparty_node_id: &PublicKey, shared_secret: [u8; 32],
decoded_hop: onion_utils::Hop, allow_underpay: bool,
next_packet_pubkey_opt: Option<Result<PublicKey, secp256k1::Error>>,
) -> PendingHTLCStatus {
macro_rules! return_err {
($msg: expr, $err_code: expr, $data: expr) => {
{
log_info!(WithContext::from(&self.logger, None, Some(msg.channel_id)), "Failed to accept/forward incoming HTLC: {}", $msg);
let logger = WithContext::from(&self.logger, Some(*counterparty_node_id), Some(msg.channel_id));
log_info!(logger, "Failed to accept/forward incoming HTLC: {}", $msg);
return PendingHTLCStatus::Fail(HTLCFailureMsg::Relay(msgs::UpdateFailHTLC {
channel_id: msg.channel_id,
htlc_id: msg.htlc_id,
Expand DownExpand Up@@ -3276,23 +3281,33 @@ where
} = args;
// The top-level caller should hold the total_consistency_lock read lock.
debug_assert!(self.total_consistency_lock.try_write().is_err());
log_trace!(WithContext::from(&self.logger, Some(path.hops.first().unwrap().pubkey), None),
"Attempting to send payment with payment hash {} along path with next hop {}",
payment_hash, path.hops.first().unwrap().short_channel_id);
let prng_seed = self.entropy_source.get_secure_random_bytes();
let session_priv = SecretKey::from_slice(&session_priv_bytes[..]).expect("RNG is busted");

let (onion_packet, htlc_msat, htlc_cltv) = onion_utils::create_payment_onion(
&self.secp_ctx, &path, &session_priv, total_value, recipient_onion, cur_height,
payment_hash, keysend_preimage, prng_seed
)?;
).map_err(|e| {
let logger = WithContext::from(&self.logger, Some(path.hops.first().unwrap().pubkey), None);
log_error!(logger, "Failed to build an onion for path for payment hash {}", payment_hash);
e
})?;

let err: Result<(), _> = loop {
let (counterparty_node_id, id) = match self.short_to_chan_info.read().unwrap().get(&path.hops.first().unwrap().short_channel_id) {
None => return Err(APIError::ChannelUnavailable{err: "No channel available with first hop!".to_owned()}),
None => {
let logger = WithContext::from(&self.logger, Some(path.hops.first().unwrap().pubkey), None);
log_error!(logger, "Failed to find first-hop for payment hash {}", payment_hash);
return Err(APIError::ChannelUnavailable{err: "No channel available with first hop!".to_owned()})
},
Some((cp_id, chan_id)) => (cp_id.clone(), chan_id.clone()),
};

let logger = WithContext::from(&self.logger, Some(counterparty_node_id), Some(id));
log_trace!(logger,
"Attempting to send payment with payment hash {} along path with next hop {}",
payment_hash, path.hops.first().unwrap().short_channel_id);

let per_peer_state = self.per_peer_state.read().unwrap();
let peer_state_mutex = per_peer_state.get(&counterparty_node_id)
.ok_or_else(|| APIError::ChannelUnavailable{err: "No peer matching the path's first hop found!".to_owned() })?;
Expand DownExpand Up@@ -4044,7 +4059,8 @@ where
None => {
let error = format!("Channel with id {} not found for the passed counterparty node_id {}",
next_hop_channel_id, next_node_id);
log_error!(self.logger, "{} when attempting to forward intercepted HTLC", error);
let logger = WithContext::from(&self.logger, Some(next_node_id), Some(*next_hop_channel_id));
log_error!(logger, "{} when attempting to forward intercepted HTLC", error);
return Err(APIError::ChannelUnavailable {
err: error
})
Expand DownExpand Up@@ -4132,6 +4148,7 @@ where

for (short_chan_id, mut pending_forwards) in forward_htlcs {
if short_chan_id != 0 {
let mut forwarding_counterparty = None;
macro_rules! forwarding_channel_not_found {
() => {
for forward_info in pending_forwards.drain(..) {
Expand All@@ -4145,7 +4162,8 @@ where
}) => {
macro_rules! failure_handler {
($msg: expr, $err_code: expr, $err_data: expr, $phantom_ss: expr, $next_hop_unknown: expr) => {
log_info!(self.logger, "Failed to accept/forward incoming HTLC: {}", $msg);
let logger = WithContext::from(&self.logger, forwarding_counterparty, Some(prev_funding_outpoint.to_channel_id()));
log_info!(logger, "Failed to accept/forward incoming HTLC: {}", $msg);

let htlc_source = HTLCSource::PreviousHopData(HTLCPreviousHopData {
short_channel_id: prev_short_channel_id,
Expand DownExpand Up@@ -4244,6 +4262,7 @@ where
continue;
}
};
forwarding_counterparty = Some(counterparty_node_id);
let per_peer_state = self.per_peer_state.read().unwrap();
let peer_state_mutex_opt = per_peer_state.get(&counterparty_node_id);
if peer_state_mutex_opt.is_none() {
Expand DownExpand Up@@ -5347,6 +5366,7 @@ where
}
if valid_mpp {
for htlc in sources.drain(..) {
let prev_hop_chan_id = htlc.prev_hop.outpoint.to_channel_id();
if let Err((pk, err)) = self.claim_funds_from_hop(
htlc.prev_hop, payment_preimage,
|_, definitely_duplicate| {
Expand All@@ -5357,6 +5377,7 @@ where
if let msgs::ErrorAction::IgnoreError = err.err.action {
// We got a temporary failure updating monitor, but will claim the
// HTLC when the monitor updating is restored (or on chain).
let logger = WithContext::from(&self.logger, None, Some(prev_hop_chan_id));
log_error!(self.logger, "Temporary failure claiming HTLC, treating as success: {}", err.err.err);
} else { errs.push((pk, err)); }
}
Expand DownExpand Up@@ -6455,7 +6476,7 @@ where
// Note that the ChannelManager is NOT re-persisted on disk after this (unless we error
// closing a channel), so any changes are likely to be lost on restart!

let decoded_hop_res = self.decode_update_add_htlc_onion(msg);
let decoded_hop_res = self.decode_update_add_htlc_onion(msg, counterparty_node_id);
let per_peer_state = self.per_peer_state.read().unwrap();
let peer_state_mutex = per_peer_state.get(counterparty_node_id)
.ok_or_else(|| {
Expand All@@ -6469,8 +6490,10 @@ where
if let ChannelPhase::Funded(chan) = chan_phase_entry.get_mut() {
let pending_forward_info = match decoded_hop_res {
Ok((next_hop, shared_secret, next_packet_pk_opt)) =>
self.construct_pending_htlc_status(msg, shared_secret, next_hop,
chan.context.config().accept_underpaying_htlcs, next_packet_pk_opt),
self.construct_pending_htlc_status(
msg, counterparty_node_id, shared_secret, next_hop,
chan.context.config().accept_underpaying_htlcs, next_packet_pk_opt,
),
Err(e) => PendingHTLCStatus::Fail(e)
};
let create_pending_htlc_status = |chan: &Channel<SP>, pending_forward_info: PendingHTLCStatus, error_code: u16| {
Expand DownExpand Up@@ -10014,7 +10037,7 @@ where
log_error!(logger, "A ChannelManager is stale compared to the current ChannelMonitor!");
log_error!(logger, " The channel will be force-closed and the latest commitment transaction from the ChannelMonitor broadcast.");
if channel.context.get_latest_monitor_update_id() < monitor.get_latest_update_id() {
log_error!(args.logger, " The ChannelMonitor for channel {} is at update_id {} but the ChannelManager is at update_id {}.",
log_error!(logger, " The ChannelMonitor for channel {} is at update_id {} but the ChannelManager is at update_id {}.",
&channel.context.channel_id(), monitor.get_latest_update_id(), channel.context.get_latest_monitor_update_id());
}
if channel.get_cur_holder_commitment_transaction_number() > monitor.get_cur_holder_commitment_number() {
Expand DownExpand Up@@ -10410,7 +10433,7 @@ where
let counterparty_opt = id_to_peer.get(&monitor.get_funding_txo().0.to_channel_id());
let chan_id = monitor.get_funding_txo().0.to_channel_id();
if counterparty_opt.is_none() {
let logger = WithContext::from(&args.logger, None, Some(chan_id));
let logger = WithChannelMonitor::from(&args.logger, monitor);
for (htlc_source, (htlc, _)) in monitor.get_pending_or_resolved_outbound_htlcs() {
if let HTLCSource::OutboundRoute { payment_id, session_priv, path, .. } = htlc_source {
if path.hops.is_empty() {
Expand Down
4 changes: 4 additions & 0 deletions lightning/src/util/logger.rs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -98,6 +98,10 @@ pub struct Record<'a> {
/// The verbosity level of the message.
pub level: Level,
/// The node id of the peer pertaining to the logged record.
///
/// Note that in some cases a [`Self::channel_id`] may be filled in but this may still be
/// `None`, depending on if the peer information is readily available in LDK when the log is
/// generated.
pub peer_id: Option<PublicKey>,
/// The channel id of the channel pertaining to the logged record. May be a temporary id before
/// the channel has been funded.
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" + '
Post-#2314 Cleanups #3 by TheBlueMatt · Pull Request #2769 · lightningdevkit/rust-lightning · GitHub
Skip to content
Post-#2314 Cleanups #3#2769

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

wpaulino
merged 6 commits into

from

Dec 4, 2023
 Merged


Post-#2314 Cleanups #3
#2769
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


6 commits


Select commit
Hold shift + click to select a range
f57295f

Include counterparty node id and channel id in shutdown log


TheBlueMatt Dec 2, 2023
0ce0d48

Add missing counterparty node id metadata to logs in HTLC decoding


TheBlueMatt Dec 2, 2023
2fc79cb

Include next-hop counterparty node id in log metadata when sending


TheBlueMatt Dec 2, 2023
b0606a1

Log next-hop metadata when forwarding or failing to forward HTLC


TheBlueMatt Dec 2, 2023
2be5e37

Set log metadata in a few additional locations in `channelmanager`


TheBlueMatt Dec 3, 2023
cf0539e

Doc that `Record::node_id` may be missing even with `channel_id`


TheBlueMatt Dec 3, 2023

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


10 changes: 10 additions & 0 deletions
lightning/src/ln/channel.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -599,6 +599,8 @@ pub(crate) struct ShutdownResult {
	/// An unbroadcasted batch funding transaction id. The closure of this channel should be
	/// propagated to the remainder of the batch.
	pub(crate) unbroadcasted_batch_funding_txid: Option<Txid>,
	pub(crate) channel_id: ChannelId,
	pub(crate) counterparty_node_id: PublicKey,
}

/// If the majority of the channels funds are to the fundee and the initiator holds only just
Expand DownExpand Up@@ -2164,6 +2166,8 @@ impl<SP: Deref> ChannelContext<SP> where SP::Target: SignerProvider {
 monitor_update,
 dropped_outbound_htlcs,
 unbroadcasted_batch_funding_txid,
 channel_id: self.channel_id,
 counterparty_node_id: self.counterparty_node_id,
 }
	}

Expand DownExpand Up@@ -4707,6 +4711,8 @@ impl<SP: Deref> Channel<SP> where
 monitor_update: None,
 dropped_outbound_htlcs: Vec::new(),
 unbroadcasted_batch_funding_txid: self.context.unbroadcasted_batch_funding_txid(),
 channel_id: self.context.channel_id,
 counterparty_node_id: self.context.counterparty_node_id,
 };
 let tx = self.build_signed_closing_transaction(&mut closing_tx, &msg.signature, &sig);
 self.context.channel_state = ChannelState::ShutdownComplete as u32;
Expand DownExpand Up@@ -4735,6 +4741,8 @@ impl<SP: Deref> Channel<SP> where
 monitor_update: None,
 dropped_outbound_htlcs: Vec::new(),
 unbroadcasted_batch_funding_txid: self.context.unbroadcasted_batch_funding_txid(),
 channel_id: self.context.channel_id,
 counterparty_node_id: self.context.counterparty_node_id,
 };
 self.context.channel_state = ChannelState::ShutdownComplete as u32;
 self.context.update_time_counter += 1;
Expand DownExpand Up@@ -5913,6 +5921,8 @@ impl<SP: Deref> Channel<SP> where
 monitor_update: None,
 dropped_outbound_htlcs: Vec::new(),
 unbroadcasted_batch_funding_txid: self.context.unbroadcasted_batch_funding_txid(),
 channel_id: self.context.channel_id,
 counterparty_node_id: self.context.counterparty_node_id,
 };
 self.context.channel_state = ChannelState::ShutdownComplete as u32;
 Some(shutdown_result)
Expand Down

59 changes: 41 additions & 18 deletions
lightning/src/ln/channelmanager.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2808,7 +2808,10 @@ where
 debug_assert_ne!(peer.held_by_thread(), LockHeldState::HeldByThread);
 }

 log_debug!(self.logger, "Finishing closure of channel with {} HTLCs to fail", shutdown_res.dropped_outbound_htlcs.len());
 let logger = WithContext::from(
 &self.logger, Some(shutdown_res.counterparty_node_id), Some(shutdown_res.channel_id),
 );
 log_debug!(logger, "Finishing closure of channel with {} HTLCs to fail", shutdown_res.dropped_outbound_htlcs.len());
 for htlc_source in shutdown_res.dropped_outbound_htlcs.drain(..) {
 let (source, payment_hash, counterparty_node_id, channel_id) = htlc_source;
 let reason = HTLCFailReason::from_failure_code(0x4000 | 8);
Expand DownExpand Up@@ -2967,7 +2970,7 @@ where
	}

	fn decode_update_add_htlc_onion(
 &self, msg: &msgs::UpdateAddHTLC
 &self, msg: &msgs::UpdateAddHTLC, counterparty_node_id: &PublicKey,
	) -> Result<
 (onion_utils::Hop, [u8; 32], Option<Result<PublicKey, secp256k1::Error>>), HTLCFailureMsg
	> {
Expand All@@ -2986,7 +2989,7 @@ where
 ($msg: expr, $err_code: expr, $data: expr) => {
 {
 log_info!(
 WithContext::from(&self.logger, None, Some(msg.channel_id)),
 WithContext::from(&self.logger, Some(*counterparty_node_id), Some(msg.channel_id)),
 "Failed to accept/forward incoming HTLC: {}", $msg
 );
 let (err_code, err_data) = if is_blinded {
Expand DownExpand Up@@ -3133,13 +3136,15 @@ where
	}

	fn construct_pending_htlc_status<'a>(
 &self, msg: &msgs::UpdateAddHTLC, shared_secret: [u8; 32], decoded_hop: onion_utils::Hop,
 allow_underpay: bool, next_packet_pubkey_opt: Option<Result<PublicKey, secp256k1::Error>>
 &self, msg: &msgs::UpdateAddHTLC, counterparty_node_id: &PublicKey, shared_secret: [u8; 32],
 decoded_hop: onion_utils::Hop, allow_underpay: bool,
 next_packet_pubkey_opt: Option<Result<PublicKey, secp256k1::Error>>,
	) -> PendingHTLCStatus {
 macro_rules! return_err {
 ($msg: expr, $err_code: expr, $data: expr) => {
 {
 log_info!(WithContext::from(&self.logger, None, Some(msg.channel_id)), "Failed to accept/forward incoming HTLC: {}", $msg);
 let logger = WithContext::from(&self.logger, Some(*counterparty_node_id), Some(msg.channel_id));
 log_info!(logger, "Failed to accept/forward incoming HTLC: {}", $msg);
 return PendingHTLCStatus::Fail(HTLCFailureMsg::Relay(msgs::UpdateFailHTLC {
 channel_id: msg.channel_id,
 htlc_id: msg.htlc_id,
Expand DownExpand Up@@ -3276,23 +3281,33 @@ where
 } = args;
 // The top-level caller should hold the total_consistency_lock read lock.
 debug_assert!(self.total_consistency_lock.try_write().is_err());
 log_trace!(WithContext::from(&self.logger, Some(path.hops.first().unwrap().pubkey), None),
 "Attempting to send payment with payment hash {} along path with next hop {}",
 payment_hash, path.hops.first().unwrap().short_channel_id);
 let prng_seed = self.entropy_source.get_secure_random_bytes();
 let session_priv = SecretKey::from_slice(&session_priv_bytes[..]).expect("RNG is busted");

 let (onion_packet, htlc_msat, htlc_cltv) = onion_utils::create_payment_onion(
 &self.secp_ctx, &path, &session_priv, total_value, recipient_onion, cur_height,
 payment_hash, keysend_preimage, prng_seed
 )?;
 ).map_err(|e| {
 let logger = WithContext::from(&self.logger, Some(path.hops.first().unwrap().pubkey), None);
 log_error!(logger, "Failed to build an onion for path for payment hash {}", payment_hash);
 e
 })?;

 let err: Result<(), _> = loop {
 let (counterparty_node_id, id) = match self.short_to_chan_info.read().unwrap().get(&path.hops.first().unwrap().short_channel_id) {
 None => return Err(APIError::ChannelUnavailable{err: "No channel available with first hop!".to_owned()}),
 None => {
 let logger = WithContext::from(&self.logger, Some(path.hops.first().unwrap().pubkey), None);
 log_error!(logger, "Failed to find first-hop for payment hash {}", payment_hash);
 return Err(APIError::ChannelUnavailable{err: "No channel available with first hop!".to_owned()})
 },
 Some((cp_id, chan_id)) => (cp_id.clone(), chan_id.clone()),
 };

 let logger = WithContext::from(&self.logger, Some(counterparty_node_id), Some(id));
 log_trace!(logger,
 "Attempting to send payment with payment hash {} along path with next hop {}",
 payment_hash, path.hops.first().unwrap().short_channel_id);

 let per_peer_state = self.per_peer_state.read().unwrap();
 let peer_state_mutex = per_peer_state.get(&counterparty_node_id)
 .ok_or_else(|| APIError::ChannelUnavailable{err: "No peer matching the path's first hop found!".to_owned() })?;
Expand DownExpand Up@@ -4044,7 +4059,8 @@ where
 None => {
 let error = format!("Channel with id {} not found for the passed counterparty node_id {}",
 next_hop_channel_id, next_node_id);
 log_error!(self.logger, "{} when attempting to forward intercepted HTLC", error);
 let logger = WithContext::from(&self.logger, Some(next_node_id), Some(*next_hop_channel_id));
 log_error!(logger, "{} when attempting to forward intercepted HTLC", error);
 return Err(APIError::ChannelUnavailable {
 err: error
 })
Expand DownExpand Up@@ -4132,6 +4148,7 @@ where

 for (short_chan_id, mut pending_forwards) in forward_htlcs {
 if short_chan_id != 0 {
 let mut forwarding_counterparty = None;
 macro_rules! forwarding_channel_not_found {
 () => {
 for forward_info in pending_forwards.drain(..) {
Expand All@@ -4145,7 +4162,8 @@ where
 }) => {
 macro_rules! failure_handler {
 ($msg: expr, $err_code: expr, $err_data: expr, $phantom_ss: expr, $next_hop_unknown: expr) => {
 log_info!(self.logger, "Failed to accept/forward incoming HTLC: {}", $msg);
 let logger = WithContext::from(&self.logger, forwarding_counterparty, Some(prev_funding_outpoint.to_channel_id()));
 log_info!(logger, "Failed to accept/forward incoming HTLC: {}", $msg);

 let htlc_source = HTLCSource::PreviousHopData(HTLCPreviousHopData {
 short_channel_id: prev_short_channel_id,
Expand DownExpand Up@@ -4244,6 +4262,7 @@ where
 continue;
 }
 };
 forwarding_counterparty = Some(counterparty_node_id);
 let per_peer_state = self.per_peer_state.read().unwrap();
 let peer_state_mutex_opt = per_peer_state.get(&counterparty_node_id);
 if peer_state_mutex_opt.is_none() {
Expand DownExpand Up@@ -5347,6 +5366,7 @@ where
 }
 if valid_mpp {
 for htlc in sources.drain(..) {
 let prev_hop_chan_id = htlc.prev_hop.outpoint.to_channel_id();
 if let Err((pk, err)) = self.claim_funds_from_hop(
 htlc.prev_hop, payment_preimage,
 |_, definitely_duplicate| {
Expand All@@ -5357,6 +5377,7 @@ where
 if let msgs::ErrorAction::IgnoreError = err.err.action {
 // We got a temporary failure updating monitor, but will claim the
 // HTLC when the monitor updating is restored (or on chain).
 let logger = WithContext::from(&self.logger, None, Some(prev_hop_chan_id));
 log_error!(self.logger, "Temporary failure claiming HTLC, treating as success: {}", err.err.err);
 } else { errs.push((pk, err)); }
 }
Expand DownExpand Up@@ -6455,7 +6476,7 @@ where
 // Note that the ChannelManager is NOT re-persisted on disk after this (unless we error
 // closing a channel), so any changes are likely to be lost on restart!

 let decoded_hop_res = self.decode_update_add_htlc_onion(msg);
 let decoded_hop_res = self.decode_update_add_htlc_onion(msg, counterparty_node_id);
 let per_peer_state = self.per_peer_state.read().unwrap();
 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
 .ok_or_else(|| {
Expand All@@ -6469,8 +6490,10 @@ where
 if let ChannelPhase::Funded(chan) = chan_phase_entry.get_mut() {
 let pending_forward_info = match decoded_hop_res {
 Ok((next_hop, shared_secret, next_packet_pk_opt)) =>
 self.construct_pending_htlc_status(msg, shared_secret, next_hop,
 chan.context.config().accept_underpaying_htlcs, next_packet_pk_opt),
 self.construct_pending_htlc_status(
 msg, counterparty_node_id, shared_secret, next_hop,
 chan.context.config().accept_underpaying_htlcs, next_packet_pk_opt,
 ),
 Err(e) => PendingHTLCStatus::Fail(e)
 };
 let create_pending_htlc_status = |chan: &Channel<SP>, pending_forward_info: PendingHTLCStatus, error_code: u16| {
Expand DownExpand Up@@ -10014,7 +10037,7 @@ where
 log_error!(logger, "A ChannelManager is stale compared to the current ChannelMonitor!");
 log_error!(logger, " The channel will be force-closed and the latest commitment transaction from the ChannelMonitor broadcast.");
 if channel.context.get_latest_monitor_update_id() < monitor.get_latest_update_id() {
 log_error!(args.logger, " The ChannelMonitor for channel {} is at update_id {} but the ChannelManager is at update_id {}.",
 log_error!(logger, " The ChannelMonitor for channel {} is at update_id {} but the ChannelManager is at update_id {}.",
 &channel.context.channel_id(), monitor.get_latest_update_id(), channel.context.get_latest_monitor_update_id());
 }
 if channel.get_cur_holder_commitment_transaction_number() > monitor.get_cur_holder_commitment_number() {
Expand DownExpand Up@@ -10410,7 +10433,7 @@ where
 let counterparty_opt = id_to_peer.get(&monitor.get_funding_txo().0.to_channel_id());
 let chan_id = monitor.get_funding_txo().0.to_channel_id();
 if counterparty_opt.is_none() {
 let logger = WithContext::from(&args.logger, None, Some(chan_id));
 let logger = WithChannelMonitor::from(&args.logger, monitor);
 for (htlc_source, (htlc, _)) in monitor.get_pending_or_resolved_outbound_htlcs() {
 if let HTLCSource::OutboundRoute { payment_id, session_priv, path, .. } = htlc_source {
 if path.hops.is_empty() {
Expand Down

4 changes: 4 additions & 0 deletions
lightning/src/util/logger.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -98,6 +98,10 @@ pub struct Record<'a> {
	/// The verbosity level of the message.
	pub level: Level,
	/// The node id of the peer pertaining to the logged record.
	///
	/// Note that in some cases a [`Self::channel_id`] may be filled in but this may still be
	/// `None`, depending on if the peer information is readily available in LDK when the log is
	/// generated.
	pub peer_id: Option<PublicKey>,
	/// The channel id of the channel pertaining to the logged record. May be a temporary id before
	/// the channel has been funded.
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('^' + ".*" + '
Post-#2314 Cleanups #3 by TheBlueMatt · Pull Request #2769 · lightningdevkit/rust-lightning · GitHub
Skip to content
Post-#2314 Cleanups #3#2769

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

wpaulino
merged 6 commits into

from

Dec 4, 2023
 Merged


Post-#2314 Cleanups #3
#2769
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


6 commits


Select commit
Hold shift + click to select a range
f57295f

Include counterparty node id and channel id in shutdown log


TheBlueMatt Dec 2, 2023
0ce0d48

Add missing counterparty node id metadata to logs in HTLC decoding


TheBlueMatt Dec 2, 2023
2fc79cb

Include next-hop counterparty node id in log metadata when sending


TheBlueMatt Dec 2, 2023
b0606a1

Log next-hop metadata when forwarding or failing to forward HTLC


TheBlueMatt Dec 2, 2023
2be5e37

Set log metadata in a few additional locations in `channelmanager`


TheBlueMatt Dec 3, 2023
cf0539e

Doc that `Record::node_id` may be missing even with `channel_id`


TheBlueMatt Dec 3, 2023

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


10 changes: 10 additions & 0 deletions
lightning/src/ln/channel.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -599,6 +599,8 @@ pub(crate) struct ShutdownResult {
	/// An unbroadcasted batch funding transaction id. The closure of this channel should be
	/// propagated to the remainder of the batch.
	pub(crate) unbroadcasted_batch_funding_txid: Option<Txid>,
	pub(crate) channel_id: ChannelId,
	pub(crate) counterparty_node_id: PublicKey,
}

/// If the majority of the channels funds are to the fundee and the initiator holds only just
Expand DownExpand Up@@ -2164,6 +2166,8 @@ impl<SP: Deref> ChannelContext<SP> where SP::Target: SignerProvider {
 monitor_update,
 dropped_outbound_htlcs,
 unbroadcasted_batch_funding_txid,
 channel_id: self.channel_id,
 counterparty_node_id: self.counterparty_node_id,
 }
	}

Expand DownExpand Up@@ -4707,6 +4711,8 @@ impl<SP: Deref> Channel<SP> where
 monitor_update: None,
 dropped_outbound_htlcs: Vec::new(),
 unbroadcasted_batch_funding_txid: self.context.unbroadcasted_batch_funding_txid(),
 channel_id: self.context.channel_id,
 counterparty_node_id: self.context.counterparty_node_id,
 };
 let tx = self.build_signed_closing_transaction(&mut closing_tx, &msg.signature, &sig);
 self.context.channel_state = ChannelState::ShutdownComplete as u32;
Expand DownExpand Up@@ -4735,6 +4741,8 @@ impl<SP: Deref> Channel<SP> where
 monitor_update: None,
 dropped_outbound_htlcs: Vec::new(),
 unbroadcasted_batch_funding_txid: self.context.unbroadcasted_batch_funding_txid(),
 channel_id: self.context.channel_id,
 counterparty_node_id: self.context.counterparty_node_id,
 };
 self.context.channel_state = ChannelState::ShutdownComplete as u32;
 self.context.update_time_counter += 1;
Expand DownExpand Up@@ -5913,6 +5921,8 @@ impl<SP: Deref> Channel<SP> where
 monitor_update: None,
 dropped_outbound_htlcs: Vec::new(),
 unbroadcasted_batch_funding_txid: self.context.unbroadcasted_batch_funding_txid(),
 channel_id: self.context.channel_id,
 counterparty_node_id: self.context.counterparty_node_id,
 };
 self.context.channel_state = ChannelState::ShutdownComplete as u32;
 Some(shutdown_result)
Expand Down

59 changes: 41 additions & 18 deletions
lightning/src/ln/channelmanager.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2808,7 +2808,10 @@ where
 debug_assert_ne!(peer.held_by_thread(), LockHeldState::HeldByThread);
 }

 log_debug!(self.logger, "Finishing closure of channel with {} HTLCs to fail", shutdown_res.dropped_outbound_htlcs.len());
 let logger = WithContext::from(
 &self.logger, Some(shutdown_res.counterparty_node_id), Some(shutdown_res.channel_id),
 );
 log_debug!(logger, "Finishing closure of channel with {} HTLCs to fail", shutdown_res.dropped_outbound_htlcs.len());
 for htlc_source in shutdown_res.dropped_outbound_htlcs.drain(..) {
 let (source, payment_hash, counterparty_node_id, channel_id) = htlc_source;
 let reason = HTLCFailReason::from_failure_code(0x4000 | 8);
Expand DownExpand Up@@ -2967,7 +2970,7 @@ where
	}

	fn decode_update_add_htlc_onion(
 &self, msg: &msgs::UpdateAddHTLC
 &self, msg: &msgs::UpdateAddHTLC, counterparty_node_id: &PublicKey,
	) -> Result<
 (onion_utils::Hop, [u8; 32], Option<Result<PublicKey, secp256k1::Error>>), HTLCFailureMsg
	> {
Expand All@@ -2986,7 +2989,7 @@ where
 ($msg: expr, $err_code: expr, $data: expr) => {
 {
 log_info!(
 WithContext::from(&self.logger, None, Some(msg.channel_id)),
 WithContext::from(&self.logger, Some(*counterparty_node_id), Some(msg.channel_id)),
 "Failed to accept/forward incoming HTLC: {}", $msg
 );
 let (err_code, err_data) = if is_blinded {
Expand DownExpand Up@@ -3133,13 +3136,15 @@ where
	}

	fn construct_pending_htlc_status<'a>(
 &self, msg: &msgs::UpdateAddHTLC, shared_secret: [u8; 32], decoded_hop: onion_utils::Hop,
 allow_underpay: bool, next_packet_pubkey_opt: Option<Result<PublicKey, secp256k1::Error>>
 &self, msg: &msgs::UpdateAddHTLC, counterparty_node_id: &PublicKey, shared_secret: [u8; 32],
 decoded_hop: onion_utils::Hop, allow_underpay: bool,
 next_packet_pubkey_opt: Option<Result<PublicKey, secp256k1::Error>>,
	) -> PendingHTLCStatus {
 macro_rules! return_err {
 ($msg: expr, $err_code: expr, $data: expr) => {
 {
 log_info!(WithContext::from(&self.logger, None, Some(msg.channel_id)), "Failed to accept/forward incoming HTLC: {}", $msg);
 let logger = WithContext::from(&self.logger, Some(*counterparty_node_id), Some(msg.channel_id));
 log_info!(logger, "Failed to accept/forward incoming HTLC: {}", $msg);
 return PendingHTLCStatus::Fail(HTLCFailureMsg::Relay(msgs::UpdateFailHTLC {
 channel_id: msg.channel_id,
 htlc_id: msg.htlc_id,
Expand DownExpand Up@@ -3276,23 +3281,33 @@ where
 } = args;
 // The top-level caller should hold the total_consistency_lock read lock.
 debug_assert!(self.total_consistency_lock.try_write().is_err());
 log_trace!(WithContext::from(&self.logger, Some(path.hops.first().unwrap().pubkey), None),
 "Attempting to send payment with payment hash {} along path with next hop {}",
 payment_hash, path.hops.first().unwrap().short_channel_id);
 let prng_seed = self.entropy_source.get_secure_random_bytes();
 let session_priv = SecretKey::from_slice(&session_priv_bytes[..]).expect("RNG is busted");

 let (onion_packet, htlc_msat, htlc_cltv) = onion_utils::create_payment_onion(
 &self.secp_ctx, &path, &session_priv, total_value, recipient_onion, cur_height,
 payment_hash, keysend_preimage, prng_seed
 )?;
 ).map_err(|e| {
 let logger = WithContext::from(&self.logger, Some(path.hops.first().unwrap().pubkey), None);
 log_error!(logger, "Failed to build an onion for path for payment hash {}", payment_hash);
 e
 })?;

 let err: Result<(), _> = loop {
 let (counterparty_node_id, id) = match self.short_to_chan_info.read().unwrap().get(&path.hops.first().unwrap().short_channel_id) {
 None => return Err(APIError::ChannelUnavailable{err: "No channel available with first hop!".to_owned()}),
 None => {
 let logger = WithContext::from(&self.logger, Some(path.hops.first().unwrap().pubkey), None);
 log_error!(logger, "Failed to find first-hop for payment hash {}", payment_hash);
 return Err(APIError::ChannelUnavailable{err: "No channel available with first hop!".to_owned()})
 },
 Some((cp_id, chan_id)) => (cp_id.clone(), chan_id.clone()),
 };

 let logger = WithContext::from(&self.logger, Some(counterparty_node_id), Some(id));
 log_trace!(logger,
 "Attempting to send payment with payment hash {} along path with next hop {}",
 payment_hash, path.hops.first().unwrap().short_channel_id);

 let per_peer_state = self.per_peer_state.read().unwrap();
 let peer_state_mutex = per_peer_state.get(&counterparty_node_id)
 .ok_or_else(|| APIError::ChannelUnavailable{err: "No peer matching the path's first hop found!".to_owned() })?;
Expand DownExpand Up@@ -4044,7 +4059,8 @@ where
 None => {
 let error = format!("Channel with id {} not found for the passed counterparty node_id {}",
 next_hop_channel_id, next_node_id);
 log_error!(self.logger, "{} when attempting to forward intercepted HTLC", error);
 let logger = WithContext::from(&self.logger, Some(next_node_id), Some(*next_hop_channel_id));
 log_error!(logger, "{} when attempting to forward intercepted HTLC", error);
 return Err(APIError::ChannelUnavailable {
 err: error
 })
Expand DownExpand Up@@ -4132,6 +4148,7 @@ where

 for (short_chan_id, mut pending_forwards) in forward_htlcs {
 if short_chan_id != 0 {
 let mut forwarding_counterparty = None;
 macro_rules! forwarding_channel_not_found {
 () => {
 for forward_info in pending_forwards.drain(..) {
Expand All@@ -4145,7 +4162,8 @@ where
 }) => {
 macro_rules! failure_handler {
 ($msg: expr, $err_code: expr, $err_data: expr, $phantom_ss: expr, $next_hop_unknown: expr) => {
 log_info!(self.logger, "Failed to accept/forward incoming HTLC: {}", $msg);
 let logger = WithContext::from(&self.logger, forwarding_counterparty, Some(prev_funding_outpoint.to_channel_id()));
 log_info!(logger, "Failed to accept/forward incoming HTLC: {}", $msg);

 let htlc_source = HTLCSource::PreviousHopData(HTLCPreviousHopData {
 short_channel_id: prev_short_channel_id,
Expand DownExpand Up@@ -4244,6 +4262,7 @@ where
 continue;
 }
 };
 forwarding_counterparty = Some(counterparty_node_id);
 let per_peer_state = self.per_peer_state.read().unwrap();
 let peer_state_mutex_opt = per_peer_state.get(&counterparty_node_id);
 if peer_state_mutex_opt.is_none() {
Expand DownExpand Up@@ -5347,6 +5366,7 @@ where
 }
 if valid_mpp {
 for htlc in sources.drain(..) {
 let prev_hop_chan_id = htlc.prev_hop.outpoint.to_channel_id();
 if let Err((pk, err)) = self.claim_funds_from_hop(
 htlc.prev_hop, payment_preimage,
 |_, definitely_duplicate| {
Expand All@@ -5357,6 +5377,7 @@ where
 if let msgs::ErrorAction::IgnoreError = err.err.action {
 // We got a temporary failure updating monitor, but will claim the
 // HTLC when the monitor updating is restored (or on chain).
 let logger = WithContext::from(&self.logger, None, Some(prev_hop_chan_id));
 log_error!(self.logger, "Temporary failure claiming HTLC, treating as success: {}", err.err.err);
 } else { errs.push((pk, err)); }
 }
Expand DownExpand Up@@ -6455,7 +6476,7 @@ where
 // Note that the ChannelManager is NOT re-persisted on disk after this (unless we error
 // closing a channel), so any changes are likely to be lost on restart!

 let decoded_hop_res = self.decode_update_add_htlc_onion(msg);
 let decoded_hop_res = self.decode_update_add_htlc_onion(msg, counterparty_node_id);
 let per_peer_state = self.per_peer_state.read().unwrap();
 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
 .ok_or_else(|| {
Expand All@@ -6469,8 +6490,10 @@ where
 if let ChannelPhase::Funded(chan) = chan_phase_entry.get_mut() {
 let pending_forward_info = match decoded_hop_res {
 Ok((next_hop, shared_secret, next_packet_pk_opt)) =>
 self.construct_pending_htlc_status(msg, shared_secret, next_hop,
 chan.context.config().accept_underpaying_htlcs, next_packet_pk_opt),
 self.construct_pending_htlc_status(
 msg, counterparty_node_id, shared_secret, next_hop,
 chan.context.config().accept_underpaying_htlcs, next_packet_pk_opt,
 ),
 Err(e) => PendingHTLCStatus::Fail(e)
 };
 let create_pending_htlc_status = |chan: &Channel<SP>, pending_forward_info: PendingHTLCStatus, error_code: u16| {
Expand DownExpand Up@@ -10014,7 +10037,7 @@ where
 log_error!(logger, "A ChannelManager is stale compared to the current ChannelMonitor!");
 log_error!(logger, " The channel will be force-closed and the latest commitment transaction from the ChannelMonitor broadcast.");
 if channel.context.get_latest_monitor_update_id() < monitor.get_latest_update_id() {
 log_error!(args.logger, " The ChannelMonitor for channel {} is at update_id {} but the ChannelManager is at update_id {}.",
 log_error!(logger, " The ChannelMonitor for channel {} is at update_id {} but the ChannelManager is at update_id {}.",
 &channel.context.channel_id(), monitor.get_latest_update_id(), channel.context.get_latest_monitor_update_id());
 }
 if channel.get_cur_holder_commitment_transaction_number() > monitor.get_cur_holder_commitment_number() {
Expand DownExpand Up@@ -10410,7 +10433,7 @@ where
 let counterparty_opt = id_to_peer.get(&monitor.get_funding_txo().0.to_channel_id());
 let chan_id = monitor.get_funding_txo().0.to_channel_id();
 if counterparty_opt.is_none() {
 let logger = WithContext::from(&args.logger, None, Some(chan_id));
 let logger = WithChannelMonitor::from(&args.logger, monitor);
 for (htlc_source, (htlc, _)) in monitor.get_pending_or_resolved_outbound_htlcs() {
 if let HTLCSource::OutboundRoute { payment_id, session_priv, path, .. } = htlc_source {
 if path.hops.is_empty() {
Expand Down

4 changes: 4 additions & 0 deletions
lightning/src/util/logger.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -98,6 +98,10 @@ pub struct Record<'a> {
	/// The verbosity level of the message.
	pub level: Level,
	/// The node id of the peer pertaining to the logged record.
	///
	/// Note that in some cases a [`Self::channel_id`] may be filled in but this may still be
	/// `None`, depending on if the peer information is readily available in LDK when the log is
	/// generated.
	pub peer_id: Option<PublicKey>,
	/// The channel id of the channel pertaining to the logged record. May be a temporary id before
	/// the channel has been funded.
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('^' + ".*" + '
Post-#2314 Cleanups #3 by TheBlueMatt · Pull Request #2769 · lightningdevkit/rust-lightning · GitHub
Skip to content
Post-#2314 Cleanups #3#2769

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

wpaulino
merged 6 commits into

from

Dec 4, 2023
 Merged


Post-#2314 Cleanups #3
#2769
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


6 commits


Select commit
Hold shift + click to select a range
f57295f

Include counterparty node id and channel id in shutdown log


TheBlueMatt Dec 2, 2023
0ce0d48

Add missing counterparty node id metadata to logs in HTLC decoding


TheBlueMatt Dec 2, 2023
2fc79cb

Include next-hop counterparty node id in log metadata when sending


TheBlueMatt Dec 2, 2023
b0606a1

Log next-hop metadata when forwarding or failing to forward HTLC


TheBlueMatt Dec 2, 2023
2be5e37

Set log metadata in a few additional locations in `channelmanager`


TheBlueMatt Dec 3, 2023
cf0539e

Doc that `Record::node_id` may be missing even with `channel_id`


TheBlueMatt Dec 3, 2023

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


10 changes: 10 additions & 0 deletions
lightning/src/ln/channel.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -599,6 +599,8 @@ pub(crate) struct ShutdownResult {
	/// An unbroadcasted batch funding transaction id. The closure of this channel should be
	/// propagated to the remainder of the batch.
	pub(crate) unbroadcasted_batch_funding_txid: Option<Txid>,
	pub(crate) channel_id: ChannelId,
	pub(crate) counterparty_node_id: PublicKey,
}

/// If the majority of the channels funds are to the fundee and the initiator holds only just
Expand DownExpand Up@@ -2164,6 +2166,8 @@ impl<SP: Deref> ChannelContext<SP> where SP::Target: SignerProvider {
 monitor_update,
 dropped_outbound_htlcs,
 unbroadcasted_batch_funding_txid,
 channel_id: self.channel_id,
 counterparty_node_id: self.counterparty_node_id,
 }
	}

Expand DownExpand Up@@ -4707,6 +4711,8 @@ impl<SP: Deref> Channel<SP> where
 monitor_update: None,
 dropped_outbound_htlcs: Vec::new(),
 unbroadcasted_batch_funding_txid: self.context.unbroadcasted_batch_funding_txid(),
 channel_id: self.context.channel_id,
 counterparty_node_id: self.context.counterparty_node_id,
 };
 let tx = self.build_signed_closing_transaction(&mut closing_tx, &msg.signature, &sig);
 self.context.channel_state = ChannelState::ShutdownComplete as u32;
Expand DownExpand Up@@ -4735,6 +4741,8 @@ impl<SP: Deref> Channel<SP> where
 monitor_update: None,
 dropped_outbound_htlcs: Vec::new(),
 unbroadcasted_batch_funding_txid: self.context.unbroadcasted_batch_funding_txid(),
 channel_id: self.context.channel_id,
 counterparty_node_id: self.context.counterparty_node_id,
 };
 self.context.channel_state = ChannelState::ShutdownComplete as u32;
 self.context.update_time_counter += 1;
Expand DownExpand Up@@ -5913,6 +5921,8 @@ impl<SP: Deref> Channel<SP> where
 monitor_update: None,
 dropped_outbound_htlcs: Vec::new(),
 unbroadcasted_batch_funding_txid: self.context.unbroadcasted_batch_funding_txid(),
 channel_id: self.context.channel_id,
 counterparty_node_id: self.context.counterparty_node_id,
 };
 self.context.channel_state = ChannelState::ShutdownComplete as u32;
 Some(shutdown_result)
Expand Down

59 changes: 41 additions & 18 deletions
lightning/src/ln/channelmanager.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2808,7 +2808,10 @@ where
 debug_assert_ne!(peer.held_by_thread(), LockHeldState::HeldByThread);
 }

 log_debug!(self.logger, "Finishing closure of channel with {} HTLCs to fail", shutdown_res.dropped_outbound_htlcs.len());
 let logger = WithContext::from(
 &self.logger, Some(shutdown_res.counterparty_node_id), Some(shutdown_res.channel_id),
 );
 log_debug!(logger, "Finishing closure of channel with {} HTLCs to fail", shutdown_res.dropped_outbound_htlcs.len());
 for htlc_source in shutdown_res.dropped_outbound_htlcs.drain(..) {
 let (source, payment_hash, counterparty_node_id, channel_id) = htlc_source;
 let reason = HTLCFailReason::from_failure_code(0x4000 | 8);
Expand DownExpand Up@@ -2967,7 +2970,7 @@ where
	}

	fn decode_update_add_htlc_onion(
 &self, msg: &msgs::UpdateAddHTLC
 &self, msg: &msgs::UpdateAddHTLC, counterparty_node_id: &PublicKey,
	) -> Result<
 (onion_utils::Hop, [u8; 32], Option<Result<PublicKey, secp256k1::Error>>), HTLCFailureMsg
	> {
Expand All@@ -2986,7 +2989,7 @@ where
 ($msg: expr, $err_code: expr, $data: expr) => {
 {
 log_info!(
 WithContext::from(&self.logger, None, Some(msg.channel_id)),
 WithContext::from(&self.logger, Some(*counterparty_node_id), Some(msg.channel_id)),
 "Failed to accept/forward incoming HTLC: {}", $msg
 );
 let (err_code, err_data) = if is_blinded {
Expand DownExpand Up@@ -3133,13 +3136,15 @@ where
	}

	fn construct_pending_htlc_status<'a>(
 &self, msg: &msgs::UpdateAddHTLC, shared_secret: [u8; 32], decoded_hop: onion_utils::Hop,
 allow_underpay: bool, next_packet_pubkey_opt: Option<Result<PublicKey, secp256k1::Error>>
 &self, msg: &msgs::UpdateAddHTLC, counterparty_node_id: &PublicKey, shared_secret: [u8; 32],
 decoded_hop: onion_utils::Hop, allow_underpay: bool,
 next_packet_pubkey_opt: Option<Result<PublicKey, secp256k1::Error>>,
	) -> PendingHTLCStatus {
 macro_rules! return_err {
 ($msg: expr, $err_code: expr, $data: expr) => {
 {
 log_info!(WithContext::from(&self.logger, None, Some(msg.channel_id)), "Failed to accept/forward incoming HTLC: {}", $msg);
 let logger = WithContext::from(&self.logger, Some(*counterparty_node_id), Some(msg.channel_id));
 log_info!(logger, "Failed to accept/forward incoming HTLC: {}", $msg);
 return PendingHTLCStatus::Fail(HTLCFailureMsg::Relay(msgs::UpdateFailHTLC {
 channel_id: msg.channel_id,
 htlc_id: msg.htlc_id,
Expand DownExpand Up@@ -3276,23 +3281,33 @@ where
 } = args;
 // The top-level caller should hold the total_consistency_lock read lock.
 debug_assert!(self.total_consistency_lock.try_write().is_err());
 log_trace!(WithContext::from(&self.logger, Some(path.hops.first().unwrap().pubkey), None),
 "Attempting to send payment with payment hash {} along path with next hop {}",
 payment_hash, path.hops.first().unwrap().short_channel_id);
 let prng_seed = self.entropy_source.get_secure_random_bytes();
 let session_priv = SecretKey::from_slice(&session_priv_bytes[..]).expect("RNG is busted");

 let (onion_packet, htlc_msat, htlc_cltv) = onion_utils::create_payment_onion(
 &self.secp_ctx, &path, &session_priv, total_value, recipient_onion, cur_height,
 payment_hash, keysend_preimage, prng_seed
 )?;
 ).map_err(|e| {
 let logger = WithContext::from(&self.logger, Some(path.hops.first().unwrap().pubkey), None);
 log_error!(logger, "Failed to build an onion for path for payment hash {}", payment_hash);
 e
 })?;

 let err: Result<(), _> = loop {
 let (counterparty_node_id, id) = match self.short_to_chan_info.read().unwrap().get(&path.hops.first().unwrap().short_channel_id) {
 None => return Err(APIError::ChannelUnavailable{err: "No channel available with first hop!".to_owned()}),
 None => {
 let logger = WithContext::from(&self.logger, Some(path.hops.first().unwrap().pubkey), None);
 log_error!(logger, "Failed to find first-hop for payment hash {}", payment_hash);
 return Err(APIError::ChannelUnavailable{err: "No channel available with first hop!".to_owned()})
 },
 Some((cp_id, chan_id)) => (cp_id.clone(), chan_id.clone()),
 };

 let logger = WithContext::from(&self.logger, Some(counterparty_node_id), Some(id));
 log_trace!(logger,
 "Attempting to send payment with payment hash {} along path with next hop {}",
 payment_hash, path.hops.first().unwrap().short_channel_id);

 let per_peer_state = self.per_peer_state.read().unwrap();
 let peer_state_mutex = per_peer_state.get(&counterparty_node_id)
 .ok_or_else(|| APIError::ChannelUnavailable{err: "No peer matching the path's first hop found!".to_owned() })?;
Expand DownExpand Up@@ -4044,7 +4059,8 @@ where
 None => {
 let error = format!("Channel with id {} not found for the passed counterparty node_id {}",
 next_hop_channel_id, next_node_id);
 log_error!(self.logger, "{} when attempting to forward intercepted HTLC", error);
 let logger = WithContext::from(&self.logger, Some(next_node_id), Some(*next_hop_channel_id));
 log_error!(logger, "{} when attempting to forward intercepted HTLC", error);
 return Err(APIError::ChannelUnavailable {
 err: error
 })
Expand DownExpand Up@@ -4132,6 +4148,7 @@ where

 for (short_chan_id, mut pending_forwards) in forward_htlcs {
 if short_chan_id != 0 {
 let mut forwarding_counterparty = None;
 macro_rules! forwarding_channel_not_found {
 () => {
 for forward_info in pending_forwards.drain(..) {
Expand All@@ -4145,7 +4162,8 @@ where
 }) => {
 macro_rules! failure_handler {
 ($msg: expr, $err_code: expr, $err_data: expr, $phantom_ss: expr, $next_hop_unknown: expr) => {
 log_info!(self.logger, "Failed to accept/forward incoming HTLC: {}", $msg);
 let logger = WithContext::from(&self.logger, forwarding_counterparty, Some(prev_funding_outpoint.to_channel_id()));
 log_info!(logger, "Failed to accept/forward incoming HTLC: {}", $msg);

 let htlc_source = HTLCSource::PreviousHopData(HTLCPreviousHopData {
 short_channel_id: prev_short_channel_id,
Expand DownExpand Up@@ -4244,6 +4262,7 @@ where
 continue;
 }
 };
 forwarding_counterparty = Some(counterparty_node_id);
 let per_peer_state = self.per_peer_state.read().unwrap();
 let peer_state_mutex_opt = per_peer_state.get(&counterparty_node_id);
 if peer_state_mutex_opt.is_none() {
Expand DownExpand Up@@ -5347,6 +5366,7 @@ where
 }
 if valid_mpp {
 for htlc in sources.drain(..) {
 let prev_hop_chan_id = htlc.prev_hop.outpoint.to_channel_id();
 if let Err((pk, err)) = self.claim_funds_from_hop(
 htlc.prev_hop, payment_preimage,
 |_, definitely_duplicate| {
Expand All@@ -5357,6 +5377,7 @@ where
 if let msgs::ErrorAction::IgnoreError = err.err.action {
 // We got a temporary failure updating monitor, but will claim the
 // HTLC when the monitor updating is restored (or on chain).
 let logger = WithContext::from(&self.logger, None, Some(prev_hop_chan_id));
 log_error!(self.logger, "Temporary failure claiming HTLC, treating as success: {}", err.err.err);
 } else { errs.push((pk, err)); }
 }
Expand DownExpand Up@@ -6455,7 +6476,7 @@ where
 // Note that the ChannelManager is NOT re-persisted on disk after this (unless we error
 // closing a channel), so any changes are likely to be lost on restart!

 let decoded_hop_res = self.decode_update_add_htlc_onion(msg);
 let decoded_hop_res = self.decode_update_add_htlc_onion(msg, counterparty_node_id);
 let per_peer_state = self.per_peer_state.read().unwrap();
 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
 .ok_or_else(|| {
Expand All@@ -6469,8 +6490,10 @@ where
 if let ChannelPhase::Funded(chan) = chan_phase_entry.get_mut() {
 let pending_forward_info = match decoded_hop_res {
 Ok((next_hop, shared_secret, next_packet_pk_opt)) =>
 self.construct_pending_htlc_status(msg, shared_secret, next_hop,
 chan.context.config().accept_underpaying_htlcs, next_packet_pk_opt),
 self.construct_pending_htlc_status(
 msg, counterparty_node_id, shared_secret, next_hop,
 chan.context.config().accept_underpaying_htlcs, next_packet_pk_opt,
 ),
 Err(e) => PendingHTLCStatus::Fail(e)
 };
 let create_pending_htlc_status = |chan: &Channel<SP>, pending_forward_info: PendingHTLCStatus, error_code: u16| {
Expand DownExpand Up@@ -10014,7 +10037,7 @@ where
 log_error!(logger, "A ChannelManager is stale compared to the current ChannelMonitor!");
 log_error!(logger, " The channel will be force-closed and the latest commitment transaction from the ChannelMonitor broadcast.");
 if channel.context.get_latest_monitor_update_id() < monitor.get_latest_update_id() {
 log_error!(args.logger, " The ChannelMonitor for channel {} is at update_id {} but the ChannelManager is at update_id {}.",
 log_error!(logger, " The ChannelMonitor for channel {} is at update_id {} but the ChannelManager is at update_id {}.",
 &channel.context.channel_id(), monitor.get_latest_update_id(), channel.context.get_latest_monitor_update_id());
 }
 if channel.get_cur_holder_commitment_transaction_number() > monitor.get_cur_holder_commitment_number() {
Expand DownExpand Up@@ -10410,7 +10433,7 @@ where
 let counterparty_opt = id_to_peer.get(&monitor.get_funding_txo().0.to_channel_id());
 let chan_id = monitor.get_funding_txo().0.to_channel_id();
 if counterparty_opt.is_none() {
 let logger = WithContext::from(&args.logger, None, Some(chan_id));
 let logger = WithChannelMonitor::from(&args.logger, monitor);
 for (htlc_source, (htlc, _)) in monitor.get_pending_or_resolved_outbound_htlcs() {
 if let HTLCSource::OutboundRoute { payment_id, session_priv, path, .. } = htlc_source {
 if path.hops.is_empty() {
Expand Down

4 changes: 4 additions & 0 deletions
lightning/src/util/logger.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -98,6 +98,10 @@ pub struct Record<'a> {
	/// The verbosity level of the message.
	pub level: Level,
	/// The node id of the peer pertaining to the logged record.
	///
	/// Note that in some cases a [`Self::channel_id`] may be filled in but this may still be
	/// `None`, depending on if the peer information is readily available in LDK when the log is
	/// generated.
	pub peer_id: Option<PublicKey>,
	/// The channel id of the channel pertaining to the logged record. May be a temporary id before
	/// the channel has been funded.
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" + '
Post-#2314 Cleanups #3 by TheBlueMatt · Pull Request #2769 · lightningdevkit/rust-lightning · GitHub
Skip to content
Post-#2314 Cleanups #3#2769

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

wpaulino
merged 6 commits into

from

Dec 4, 2023
 Merged


Post-#2314 Cleanups #3
#2769
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


6 commits


Select commit
Hold shift + click to select a range
f57295f

Include counterparty node id and channel id in shutdown log


TheBlueMatt Dec 2, 2023
0ce0d48

Add missing counterparty node id metadata to logs in HTLC decoding


TheBlueMatt Dec 2, 2023
2fc79cb

Include next-hop counterparty node id in log metadata when sending


TheBlueMatt Dec 2, 2023
b0606a1

Log next-hop metadata when forwarding or failing to forward HTLC


TheBlueMatt Dec 2, 2023
2be5e37

Set log metadata in a few additional locations in `channelmanager`


TheBlueMatt Dec 3, 2023
cf0539e

Doc that `Record::node_id` may be missing even with `channel_id`


TheBlueMatt Dec 3, 2023

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


10 changes: 10 additions & 0 deletions
lightning/src/ln/channel.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -599,6 +599,8 @@ pub(crate) struct ShutdownResult {
	/// An unbroadcasted batch funding transaction id. The closure of this channel should be
	/// propagated to the remainder of the batch.
	pub(crate) unbroadcasted_batch_funding_txid: Option<Txid>,
	pub(crate) channel_id: ChannelId,
	pub(crate) counterparty_node_id: PublicKey,
}

/// If the majority of the channels funds are to the fundee and the initiator holds only just
Expand DownExpand Up@@ -2164,6 +2166,8 @@ impl<SP: Deref> ChannelContext<SP> where SP::Target: SignerProvider {
 monitor_update,
 dropped_outbound_htlcs,
 unbroadcasted_batch_funding_txid,
 channel_id: self.channel_id,
 counterparty_node_id: self.counterparty_node_id,
 }
	}

Expand DownExpand Up@@ -4707,6 +4711,8 @@ impl<SP: Deref> Channel<SP> where
 monitor_update: None,
 dropped_outbound_htlcs: Vec::new(),
 unbroadcasted_batch_funding_txid: self.context.unbroadcasted_batch_funding_txid(),
 channel_id: self.context.channel_id,
 counterparty_node_id: self.context.counterparty_node_id,
 };
 let tx = self.build_signed_closing_transaction(&mut closing_tx, &msg.signature, &sig);
 self.context.channel_state = ChannelState::ShutdownComplete as u32;
Expand DownExpand Up@@ -4735,6 +4741,8 @@ impl<SP: Deref> Channel<SP> where
 monitor_update: None,
 dropped_outbound_htlcs: Vec::new(),
 unbroadcasted_batch_funding_txid: self.context.unbroadcasted_batch_funding_txid(),
 channel_id: self.context.channel_id,
 counterparty_node_id: self.context.counterparty_node_id,
 };
 self.context.channel_state = ChannelState::ShutdownComplete as u32;
 self.context.update_time_counter += 1;
Expand DownExpand Up@@ -5913,6 +5921,8 @@ impl<SP: Deref> Channel<SP> where
 monitor_update: None,
 dropped_outbound_htlcs: Vec::new(),
 unbroadcasted_batch_funding_txid: self.context.unbroadcasted_batch_funding_txid(),
 channel_id: self.context.channel_id,
 counterparty_node_id: self.context.counterparty_node_id,
 };
 self.context.channel_state = ChannelState::ShutdownComplete as u32;
 Some(shutdown_result)
Expand Down

59 changes: 41 additions & 18 deletions
lightning/src/ln/channelmanager.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2808,7 +2808,10 @@ where
 debug_assert_ne!(peer.held_by_thread(), LockHeldState::HeldByThread);
 }

 log_debug!(self.logger, "Finishing closure of channel with {} HTLCs to fail", shutdown_res.dropped_outbound_htlcs.len());
 let logger = WithContext::from(
 &self.logger, Some(shutdown_res.counterparty_node_id), Some(shutdown_res.channel_id),
 );
 log_debug!(logger, "Finishing closure of channel with {} HTLCs to fail", shutdown_res.dropped_outbound_htlcs.len());
 for htlc_source in shutdown_res.dropped_outbound_htlcs.drain(..) {
 let (source, payment_hash, counterparty_node_id, channel_id) = htlc_source;
 let reason = HTLCFailReason::from_failure_code(0x4000 | 8);
Expand DownExpand Up@@ -2967,7 +2970,7 @@ where
	}

	fn decode_update_add_htlc_onion(
 &self, msg: &msgs::UpdateAddHTLC
 &self, msg: &msgs::UpdateAddHTLC, counterparty_node_id: &PublicKey,
	) -> Result<
 (onion_utils::Hop, [u8; 32], Option<Result<PublicKey, secp256k1::Error>>), HTLCFailureMsg
	> {
Expand All@@ -2986,7 +2989,7 @@ where
 ($msg: expr, $err_code: expr, $data: expr) => {
 {
 log_info!(
 WithContext::from(&self.logger, None, Some(msg.channel_id)),
 WithContext::from(&self.logger, Some(*counterparty_node_id), Some(msg.channel_id)),
 "Failed to accept/forward incoming HTLC: {}", $msg
 );
 let (err_code, err_data) = if is_blinded {
Expand DownExpand Up@@ -3133,13 +3136,15 @@ where
	}

	fn construct_pending_htlc_status<'a>(
 &self, msg: &msgs::UpdateAddHTLC, shared_secret: [u8; 32], decoded_hop: onion_utils::Hop,
 allow_underpay: bool, next_packet_pubkey_opt: Option<Result<PublicKey, secp256k1::Error>>
 &self, msg: &msgs::UpdateAddHTLC, counterparty_node_id: &PublicKey, shared_secret: [u8; 32],
 decoded_hop: onion_utils::Hop, allow_underpay: bool,
 next_packet_pubkey_opt: Option<Result<PublicKey, secp256k1::Error>>,
	) -> PendingHTLCStatus {
 macro_rules! return_err {
 ($msg: expr, $err_code: expr, $data: expr) => {
 {
 log_info!(WithContext::from(&self.logger, None, Some(msg.channel_id)), "Failed to accept/forward incoming HTLC: {}", $msg);
 let logger = WithContext::from(&self.logger, Some(*counterparty_node_id), Some(msg.channel_id));
 log_info!(logger, "Failed to accept/forward incoming HTLC: {}", $msg);
 return PendingHTLCStatus::Fail(HTLCFailureMsg::Relay(msgs::UpdateFailHTLC {
 channel_id: msg.channel_id,
 htlc_id: msg.htlc_id,
Expand DownExpand Up@@ -3276,23 +3281,33 @@ where
 } = args;
 // The top-level caller should hold the total_consistency_lock read lock.
 debug_assert!(self.total_consistency_lock.try_write().is_err());
 log_trace!(WithContext::from(&self.logger, Some(path.hops.first().unwrap().pubkey), None),
 "Attempting to send payment with payment hash {} along path with next hop {}",
 payment_hash, path.hops.first().unwrap().short_channel_id);
 let prng_seed = self.entropy_source.get_secure_random_bytes();
 let session_priv = SecretKey::from_slice(&session_priv_bytes[..]).expect("RNG is busted");

 let (onion_packet, htlc_msat, htlc_cltv) = onion_utils::create_payment_onion(
 &self.secp_ctx, &path, &session_priv, total_value, recipient_onion, cur_height,
 payment_hash, keysend_preimage, prng_seed
 )?;
 ).map_err(|e| {
 let logger = WithContext::from(&self.logger, Some(path.hops.first().unwrap().pubkey), None);
 log_error!(logger, "Failed to build an onion for path for payment hash {}", payment_hash);
 e
 })?;

 let err: Result<(), _> = loop {
 let (counterparty_node_id, id) = match self.short_to_chan_info.read().unwrap().get(&path.hops.first().unwrap().short_channel_id) {
 None => return Err(APIError::ChannelUnavailable{err: "No channel available with first hop!".to_owned()}),
 None => {
 let logger = WithContext::from(&self.logger, Some(path.hops.first().unwrap().pubkey), None);
 log_error!(logger, "Failed to find first-hop for payment hash {}", payment_hash);
 return Err(APIError::ChannelUnavailable{err: "No channel available with first hop!".to_owned()})
 },
 Some((cp_id, chan_id)) => (cp_id.clone(), chan_id.clone()),
 };

 let logger = WithContext::from(&self.logger, Some(counterparty_node_id), Some(id));
 log_trace!(logger,
 "Attempting to send payment with payment hash {} along path with next hop {}",
 payment_hash, path.hops.first().unwrap().short_channel_id);

 let per_peer_state = self.per_peer_state.read().unwrap();
 let peer_state_mutex = per_peer_state.get(&counterparty_node_id)
 .ok_or_else(|| APIError::ChannelUnavailable{err: "No peer matching the path's first hop found!".to_owned() })?;
Expand DownExpand Up@@ -4044,7 +4059,8 @@ where
 None => {
 let error = format!("Channel with id {} not found for the passed counterparty node_id {}",
 next_hop_channel_id, next_node_id);
 log_error!(self.logger, "{} when attempting to forward intercepted HTLC", error);
 let logger = WithContext::from(&self.logger, Some(next_node_id), Some(*next_hop_channel_id));
 log_error!(logger, "{} when attempting to forward intercepted HTLC", error);
 return Err(APIError::ChannelUnavailable {
 err: error
 })
Expand DownExpand Up@@ -4132,6 +4148,7 @@ where

 for (short_chan_id, mut pending_forwards) in forward_htlcs {
 if short_chan_id != 0 {
 let mut forwarding_counterparty = None;
 macro_rules! forwarding_channel_not_found {
 () => {
 for forward_info in pending_forwards.drain(..) {
Expand All@@ -4145,7 +4162,8 @@ where
 }) => {
 macro_rules! failure_handler {
 ($msg: expr, $err_code: expr, $err_data: expr, $phantom_ss: expr, $next_hop_unknown: expr) => {
 log_info!(self.logger, "Failed to accept/forward incoming HTLC: {}", $msg);
 let logger = WithContext::from(&self.logger, forwarding_counterparty, Some(prev_funding_outpoint.to_channel_id()));
 log_info!(logger, "Failed to accept/forward incoming HTLC: {}", $msg);

 let htlc_source = HTLCSource::PreviousHopData(HTLCPreviousHopData {
 short_channel_id: prev_short_channel_id,
Expand DownExpand Up@@ -4244,6 +4262,7 @@ where
 continue;
 }
 };
 forwarding_counterparty = Some(counterparty_node_id);
 let per_peer_state = self.per_peer_state.read().unwrap();
 let peer_state_mutex_opt = per_peer_state.get(&counterparty_node_id);
 if peer_state_mutex_opt.is_none() {
Expand DownExpand Up@@ -5347,6 +5366,7 @@ where
 }
 if valid_mpp {
 for htlc in sources.drain(..) {
 let prev_hop_chan_id = htlc.prev_hop.outpoint.to_channel_id();
 if let Err((pk, err)) = self.claim_funds_from_hop(
 htlc.prev_hop, payment_preimage,
 |_, definitely_duplicate| {
Expand All@@ -5357,6 +5377,7 @@ where
 if let msgs::ErrorAction::IgnoreError = err.err.action {
 // We got a temporary failure updating monitor, but will claim the
 // HTLC when the monitor updating is restored (or on chain).
 let logger = WithContext::from(&self.logger, None, Some(prev_hop_chan_id));
 log_error!(self.logger, "Temporary failure claiming HTLC, treating as success: {}", err.err.err);
 } else { errs.push((pk, err)); }
 }
Expand DownExpand Up@@ -6455,7 +6476,7 @@ where
 // Note that the ChannelManager is NOT re-persisted on disk after this (unless we error
 // closing a channel), so any changes are likely to be lost on restart!

 let decoded_hop_res = self.decode_update_add_htlc_onion(msg);
 let decoded_hop_res = self.decode_update_add_htlc_onion(msg, counterparty_node_id);
 let per_peer_state = self.per_peer_state.read().unwrap();
 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
 .ok_or_else(|| {
Expand All@@ -6469,8 +6490,10 @@ where
 if let ChannelPhase::Funded(chan) = chan_phase_entry.get_mut() {
 let pending_forward_info = match decoded_hop_res {
 Ok((next_hop, shared_secret, next_packet_pk_opt)) =>
 self.construct_pending_htlc_status(msg, shared_secret, next_hop,
 chan.context.config().accept_underpaying_htlcs, next_packet_pk_opt),
 self.construct_pending_htlc_status(
 msg, counterparty_node_id, shared_secret, next_hop,
 chan.context.config().accept_underpaying_htlcs, next_packet_pk_opt,
 ),
 Err(e) => PendingHTLCStatus::Fail(e)
 };
 let create_pending_htlc_status = |chan: &Channel<SP>, pending_forward_info: PendingHTLCStatus, error_code: u16| {
Expand DownExpand Up@@ -10014,7 +10037,7 @@ where
 log_error!(logger, "A ChannelManager is stale compared to the current ChannelMonitor!");
 log_error!(logger, " The channel will be force-closed and the latest commitment transaction from the ChannelMonitor broadcast.");
 if channel.context.get_latest_monitor_update_id() < monitor.get_latest_update_id() {
 log_error!(args.logger, " The ChannelMonitor for channel {} is at update_id {} but the ChannelManager is at update_id {}.",
 log_error!(logger, " The ChannelMonitor for channel {} is at update_id {} but the ChannelManager is at update_id {}.",
 &channel.context.channel_id(), monitor.get_latest_update_id(), channel.context.get_latest_monitor_update_id());
 }
 if channel.get_cur_holder_commitment_transaction_number() > monitor.get_cur_holder_commitment_number() {
Expand DownExpand Up@@ -10410,7 +10433,7 @@ where
 let counterparty_opt = id_to_peer.get(&monitor.get_funding_txo().0.to_channel_id());
 let chan_id = monitor.get_funding_txo().0.to_channel_id();
 if counterparty_opt.is_none() {
 let logger = WithContext::from(&args.logger, None, Some(chan_id));
 let logger = WithChannelMonitor::from(&args.logger, monitor);
 for (htlc_source, (htlc, _)) in monitor.get_pending_or_resolved_outbound_htlcs() {
 if let HTLCSource::OutboundRoute { payment_id, session_priv, path, .. } = htlc_source {
 if path.hops.is_empty() {
Expand Down

4 changes: 4 additions & 0 deletions
lightning/src/util/logger.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -98,6 +98,10 @@ pub struct Record<'a> {
	/// The verbosity level of the message.
	pub level: Level,
	/// The node id of the peer pertaining to the logged record.
	///
	/// Note that in some cases a [`Self::channel_id`] may be filled in but this may still be
	/// `None`, depending on if the peer information is readily available in LDK when the log is
	/// generated.
	pub peer_id: Option<PublicKey>,
	/// The channel id of the channel pertaining to the logged record. May be a temporary id before
	/// the channel has been funded.
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('^' + ".*" + '
Post-#2314 Cleanups #3 by TheBlueMatt · Pull Request #2769 · lightningdevkit/rust-lightning · GitHub
Skip to content
Post-#2314 Cleanups #3#2769

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

wpaulino
merged 6 commits into

from

Dec 4, 2023
 Merged


Post-#2314 Cleanups #3
#2769
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


6 commits


Select commit
Hold shift + click to select a range
f57295f

Include counterparty node id and channel id in shutdown log


TheBlueMatt Dec 2, 2023
0ce0d48

Add missing counterparty node id metadata to logs in HTLC decoding


TheBlueMatt Dec 2, 2023
2fc79cb

Include next-hop counterparty node id in log metadata when sending


TheBlueMatt Dec 2, 2023
b0606a1

Log next-hop metadata when forwarding or failing to forward HTLC


TheBlueMatt Dec 2, 2023
2be5e37

Set log metadata in a few additional locations in `channelmanager`


TheBlueMatt Dec 3, 2023
cf0539e

Doc that `Record::node_id` may be missing even with `channel_id`


TheBlueMatt Dec 3, 2023

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


10 changes: 10 additions & 0 deletions
lightning/src/ln/channel.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -599,6 +599,8 @@ pub(crate) struct ShutdownResult {
	/// An unbroadcasted batch funding transaction id. The closure of this channel should be
	/// propagated to the remainder of the batch.
	pub(crate) unbroadcasted_batch_funding_txid: Option<Txid>,
	pub(crate) channel_id: ChannelId,
	pub(crate) counterparty_node_id: PublicKey,
}

/// If the majority of the channels funds are to the fundee and the initiator holds only just
Expand DownExpand Up@@ -2164,6 +2166,8 @@ impl<SP: Deref> ChannelContext<SP> where SP::Target: SignerProvider {
 monitor_update,
 dropped_outbound_htlcs,
 unbroadcasted_batch_funding_txid,
 channel_id: self.channel_id,
 counterparty_node_id: self.counterparty_node_id,
 }
	}

Expand DownExpand Up@@ -4707,6 +4711,8 @@ impl<SP: Deref> Channel<SP> where
 monitor_update: None,
 dropped_outbound_htlcs: Vec::new(),
 unbroadcasted_batch_funding_txid: self.context.unbroadcasted_batch_funding_txid(),
 channel_id: self.context.channel_id,
 counterparty_node_id: self.context.counterparty_node_id,
 };
 let tx = self.build_signed_closing_transaction(&mut closing_tx, &msg.signature, &sig);
 self.context.channel_state = ChannelState::ShutdownComplete as u32;
Expand DownExpand Up@@ -4735,6 +4741,8 @@ impl<SP: Deref> Channel<SP> where
 monitor_update: None,
 dropped_outbound_htlcs: Vec::new(),
 unbroadcasted_batch_funding_txid: self.context.unbroadcasted_batch_funding_txid(),
 channel_id: self.context.channel_id,
 counterparty_node_id: self.context.counterparty_node_id,
 };
 self.context.channel_state = ChannelState::ShutdownComplete as u32;
 self.context.update_time_counter += 1;
Expand DownExpand Up@@ -5913,6 +5921,8 @@ impl<SP: Deref> Channel<SP> where
 monitor_update: None,
 dropped_outbound_htlcs: Vec::new(),
 unbroadcasted_batch_funding_txid: self.context.unbroadcasted_batch_funding_txid(),
 channel_id: self.context.channel_id,
 counterparty_node_id: self.context.counterparty_node_id,
 };
 self.context.channel_state = ChannelState::ShutdownComplete as u32;
 Some(shutdown_result)
Expand Down

59 changes: 41 additions & 18 deletions
lightning/src/ln/channelmanager.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2808,7 +2808,10 @@ where
 debug_assert_ne!(peer.held_by_thread(), LockHeldState::HeldByThread);
 }

 log_debug!(self.logger, "Finishing closure of channel with {} HTLCs to fail", shutdown_res.dropped_outbound_htlcs.len());
 let logger = WithContext::from(
 &self.logger, Some(shutdown_res.counterparty_node_id), Some(shutdown_res.channel_id),
 );
 log_debug!(logger, "Finishing closure of channel with {} HTLCs to fail", shutdown_res.dropped_outbound_htlcs.len());
 for htlc_source in shutdown_res.dropped_outbound_htlcs.drain(..) {
 let (source, payment_hash, counterparty_node_id, channel_id) = htlc_source;
 let reason = HTLCFailReason::from_failure_code(0x4000 | 8);
Expand DownExpand Up@@ -2967,7 +2970,7 @@ where
	}

	fn decode_update_add_htlc_onion(
 &self, msg: &msgs::UpdateAddHTLC
 &self, msg: &msgs::UpdateAddHTLC, counterparty_node_id: &PublicKey,
	) -> Result<
 (onion_utils::Hop, [u8; 32], Option<Result<PublicKey, secp256k1::Error>>), HTLCFailureMsg
	> {
Expand All@@ -2986,7 +2989,7 @@ where
 ($msg: expr, $err_code: expr, $data: expr) => {
 {
 log_info!(
 WithContext::from(&self.logger, None, Some(msg.channel_id)),
 WithContext::from(&self.logger, Some(*counterparty_node_id), Some(msg.channel_id)),
 "Failed to accept/forward incoming HTLC: {}", $msg
 );
 let (err_code, err_data) = if is_blinded {
Expand DownExpand Up@@ -3133,13 +3136,15 @@ where
	}

	fn construct_pending_htlc_status<'a>(
 &self, msg: &msgs::UpdateAddHTLC, shared_secret: [u8; 32], decoded_hop: onion_utils::Hop,
 allow_underpay: bool, next_packet_pubkey_opt: Option<Result<PublicKey, secp256k1::Error>>
 &self, msg: &msgs::UpdateAddHTLC, counterparty_node_id: &PublicKey, shared_secret: [u8; 32],
 decoded_hop: onion_utils::Hop, allow_underpay: bool,
 next_packet_pubkey_opt: Option<Result<PublicKey, secp256k1::Error>>,
	) -> PendingHTLCStatus {
 macro_rules! return_err {
 ($msg: expr, $err_code: expr, $data: expr) => {
 {
 log_info!(WithContext::from(&self.logger, None, Some(msg.channel_id)), "Failed to accept/forward incoming HTLC: {}", $msg);
 let logger = WithContext::from(&self.logger, Some(*counterparty_node_id), Some(msg.channel_id));
 log_info!(logger, "Failed to accept/forward incoming HTLC: {}", $msg);
 return PendingHTLCStatus::Fail(HTLCFailureMsg::Relay(msgs::UpdateFailHTLC {
 channel_id: msg.channel_id,
 htlc_id: msg.htlc_id,
Expand DownExpand Up@@ -3276,23 +3281,33 @@ where
 } = args;
 // The top-level caller should hold the total_consistency_lock read lock.
 debug_assert!(self.total_consistency_lock.try_write().is_err());
 log_trace!(WithContext::from(&self.logger, Some(path.hops.first().unwrap().pubkey), None),
 "Attempting to send payment with payment hash {} along path with next hop {}",
 payment_hash, path.hops.first().unwrap().short_channel_id);
 let prng_seed = self.entropy_source.get_secure_random_bytes();
 let session_priv = SecretKey::from_slice(&session_priv_bytes[..]).expect("RNG is busted");

 let (onion_packet, htlc_msat, htlc_cltv) = onion_utils::create_payment_onion(
 &self.secp_ctx, &path, &session_priv, total_value, recipient_onion, cur_height,
 payment_hash, keysend_preimage, prng_seed
 )?;
 ).map_err(|e| {
 let logger = WithContext::from(&self.logger, Some(path.hops.first().unwrap().pubkey), None);
 log_error!(logger, "Failed to build an onion for path for payment hash {}", payment_hash);
 e
 })?;

 let err: Result<(), _> = loop {
 let (counterparty_node_id, id) = match self.short_to_chan_info.read().unwrap().get(&path.hops.first().unwrap().short_channel_id) {
 None => return Err(APIError::ChannelUnavailable{err: "No channel available with first hop!".to_owned()}),
 None => {
 let logger = WithContext::from(&self.logger, Some(path.hops.first().unwrap().pubkey), None);
 log_error!(logger, "Failed to find first-hop for payment hash {}", payment_hash);
 return Err(APIError::ChannelUnavailable{err: "No channel available with first hop!".to_owned()})
 },
 Some((cp_id, chan_id)) => (cp_id.clone(), chan_id.clone()),
 };

 let logger = WithContext::from(&self.logger, Some(counterparty_node_id), Some(id));
 log_trace!(logger,
 "Attempting to send payment with payment hash {} along path with next hop {}",
 payment_hash, path.hops.first().unwrap().short_channel_id);

 let per_peer_state = self.per_peer_state.read().unwrap();
 let peer_state_mutex = per_peer_state.get(&counterparty_node_id)
 .ok_or_else(|| APIError::ChannelUnavailable{err: "No peer matching the path's first hop found!".to_owned() })?;
Expand DownExpand Up@@ -4044,7 +4059,8 @@ where
 None => {
 let error = format!("Channel with id {} not found for the passed counterparty node_id {}",
 next_hop_channel_id, next_node_id);
 log_error!(self.logger, "{} when attempting to forward intercepted HTLC", error);
 let logger = WithContext::from(&self.logger, Some(next_node_id), Some(*next_hop_channel_id));
 log_error!(logger, "{} when attempting to forward intercepted HTLC", error);
 return Err(APIError::ChannelUnavailable {
 err: error
 })
Expand DownExpand Up@@ -4132,6 +4148,7 @@ where

 for (short_chan_id, mut pending_forwards) in forward_htlcs {
 if short_chan_id != 0 {
 let mut forwarding_counterparty = None;
 macro_rules! forwarding_channel_not_found {
 () => {
 for forward_info in pending_forwards.drain(..) {
Expand All@@ -4145,7 +4162,8 @@ where
 }) => {
 macro_rules! failure_handler {
 ($msg: expr, $err_code: expr, $err_data: expr, $phantom_ss: expr, $next_hop_unknown: expr) => {
 log_info!(self.logger, "Failed to accept/forward incoming HTLC: {}", $msg);
 let logger = WithContext::from(&self.logger, forwarding_counterparty, Some(prev_funding_outpoint.to_channel_id()));
 log_info!(logger, "Failed to accept/forward incoming HTLC: {}", $msg);

 let htlc_source = HTLCSource::PreviousHopData(HTLCPreviousHopData {
 short_channel_id: prev_short_channel_id,
Expand DownExpand Up@@ -4244,6 +4262,7 @@ where
 continue;
 }
 };
 forwarding_counterparty = Some(counterparty_node_id);
 let per_peer_state = self.per_peer_state.read().unwrap();
 let peer_state_mutex_opt = per_peer_state.get(&counterparty_node_id);
 if peer_state_mutex_opt.is_none() {
Expand DownExpand Up@@ -5347,6 +5366,7 @@ where
 }
 if valid_mpp {
 for htlc in sources.drain(..) {
 let prev_hop_chan_id = htlc.prev_hop.outpoint.to_channel_id();
 if let Err((pk, err)) = self.claim_funds_from_hop(
 htlc.prev_hop, payment_preimage,
 |_, definitely_duplicate| {
Expand All@@ -5357,6 +5377,7 @@ where
 if let msgs::ErrorAction::IgnoreError = err.err.action {
 // We got a temporary failure updating monitor, but will claim the
 // HTLC when the monitor updating is restored (or on chain).
 let logger = WithContext::from(&self.logger, None, Some(prev_hop_chan_id));
 log_error!(self.logger, "Temporary failure claiming HTLC, treating as success: {}", err.err.err);
 } else { errs.push((pk, err)); }
 }
Expand DownExpand Up@@ -6455,7 +6476,7 @@ where
 // Note that the ChannelManager is NOT re-persisted on disk after this (unless we error
 // closing a channel), so any changes are likely to be lost on restart!

 let decoded_hop_res = self.decode_update_add_htlc_onion(msg);
 let decoded_hop_res = self.decode_update_add_htlc_onion(msg, counterparty_node_id);
 let per_peer_state = self.per_peer_state.read().unwrap();
 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
 .ok_or_else(|| {
Expand All@@ -6469,8 +6490,10 @@ where
 if let ChannelPhase::Funded(chan) = chan_phase_entry.get_mut() {
 let pending_forward_info = match decoded_hop_res {
 Ok((next_hop, shared_secret, next_packet_pk_opt)) =>
 self.construct_pending_htlc_status(msg, shared_secret, next_hop,
 chan.context.config().accept_underpaying_htlcs, next_packet_pk_opt),
 self.construct_pending_htlc_status(
 msg, counterparty_node_id, shared_secret, next_hop,
 chan.context.config().accept_underpaying_htlcs, next_packet_pk_opt,
 ),
 Err(e) => PendingHTLCStatus::Fail(e)
 };
 let create_pending_htlc_status = |chan: &Channel<SP>, pending_forward_info: PendingHTLCStatus, error_code: u16| {
Expand DownExpand Up@@ -10014,7 +10037,7 @@ where
 log_error!(logger, "A ChannelManager is stale compared to the current ChannelMonitor!");
 log_error!(logger, " The channel will be force-closed and the latest commitment transaction from the ChannelMonitor broadcast.");
 if channel.context.get_latest_monitor_update_id() < monitor.get_latest_update_id() {
 log_error!(args.logger, " The ChannelMonitor for channel {} is at update_id {} but the ChannelManager is at update_id {}.",
 log_error!(logger, " The ChannelMonitor for channel {} is at update_id {} but the ChannelManager is at update_id {}.",
 &channel.context.channel_id(), monitor.get_latest_update_id(), channel.context.get_latest_monitor_update_id());
 }
 if channel.get_cur_holder_commitment_transaction_number() > monitor.get_cur_holder_commitment_number() {
Expand DownExpand Up@@ -10410,7 +10433,7 @@ where
 let counterparty_opt = id_to_peer.get(&monitor.get_funding_txo().0.to_channel_id());
 let chan_id = monitor.get_funding_txo().0.to_channel_id();
 if counterparty_opt.is_none() {
 let logger = WithContext::from(&args.logger, None, Some(chan_id));
 let logger = WithChannelMonitor::from(&args.logger, monitor);
 for (htlc_source, (htlc, _)) in monitor.get_pending_or_resolved_outbound_htlcs() {
 if let HTLCSource::OutboundRoute { payment_id, session_priv, path, .. } = htlc_source {
 if path.hops.is_empty() {
Expand Down

4 changes: 4 additions & 0 deletions
lightning/src/util/logger.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -98,6 +98,10 @@ pub struct Record<'a> {
	/// The verbosity level of the message.
	pub level: Level,
	/// The node id of the peer pertaining to the logged record.
	///
	/// Note that in some cases a [`Self::channel_id`] may be filled in but this may still be
	/// `None`, depending on if the peer information is readily available in LDK when the log is
	/// generated.
	pub peer_id: Option<PublicKey>,
	/// The channel id of the channel pertaining to the logged record. May be a temporary id before
	/// the channel has been funded.
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('^' + ".*" + '
Post-#2314 Cleanups #3 by TheBlueMatt · Pull Request #2769 · lightningdevkit/rust-lightning · GitHub
Skip to content
Post-#2314 Cleanups #3#2769

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

wpaulino
merged 6 commits into

from

Dec 4, 2023
 Merged


Post-#2314 Cleanups #3
#2769
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


6 commits


Select commit
Hold shift + click to select a range
f57295f

Include counterparty node id and channel id in shutdown log


TheBlueMatt Dec 2, 2023
0ce0d48

Add missing counterparty node id metadata to logs in HTLC decoding


TheBlueMatt Dec 2, 2023
2fc79cb

Include next-hop counterparty node id in log metadata when sending


TheBlueMatt Dec 2, 2023
b0606a1

Log next-hop metadata when forwarding or failing to forward HTLC


TheBlueMatt Dec 2, 2023
2be5e37

Set log metadata in a few additional locations in `channelmanager`


TheBlueMatt Dec 3, 2023
cf0539e

Doc that `Record::node_id` may be missing even with `channel_id`


TheBlueMatt Dec 3, 2023

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


10 changes: 10 additions & 0 deletions
lightning/src/ln/channel.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -599,6 +599,8 @@ pub(crate) struct ShutdownResult {
	/// An unbroadcasted batch funding transaction id. The closure of this channel should be
	/// propagated to the remainder of the batch.
	pub(crate) unbroadcasted_batch_funding_txid: Option<Txid>,
	pub(crate) channel_id: ChannelId,
	pub(crate) counterparty_node_id: PublicKey,
}

/// If the majority of the channels funds are to the fundee and the initiator holds only just
Expand DownExpand Up@@ -2164,6 +2166,8 @@ impl<SP: Deref> ChannelContext<SP> where SP::Target: SignerProvider {
 monitor_update,
 dropped_outbound_htlcs,
 unbroadcasted_batch_funding_txid,
 channel_id: self.channel_id,
 counterparty_node_id: self.counterparty_node_id,
 }
	}

Expand DownExpand Up@@ -4707,6 +4711,8 @@ impl<SP: Deref> Channel<SP> where
 monitor_update: None,
 dropped_outbound_htlcs: Vec::new(),
 unbroadcasted_batch_funding_txid: self.context.unbroadcasted_batch_funding_txid(),
 channel_id: self.context.channel_id,
 counterparty_node_id: self.context.counterparty_node_id,
 };
 let tx = self.build_signed_closing_transaction(&mut closing_tx, &msg.signature, &sig);
 self.context.channel_state = ChannelState::ShutdownComplete as u32;
Expand DownExpand Up@@ -4735,6 +4741,8 @@ impl<SP: Deref> Channel<SP> where
 monitor_update: None,
 dropped_outbound_htlcs: Vec::new(),
 unbroadcasted_batch_funding_txid: self.context.unbroadcasted_batch_funding_txid(),
 channel_id: self.context.channel_id,
 counterparty_node_id: self.context.counterparty_node_id,
 };
 self.context.channel_state = ChannelState::ShutdownComplete as u32;
 self.context.update_time_counter += 1;
Expand DownExpand Up@@ -5913,6 +5921,8 @@ impl<SP: Deref> Channel<SP> where
 monitor_update: None,
 dropped_outbound_htlcs: Vec::new(),
 unbroadcasted_batch_funding_txid: self.context.unbroadcasted_batch_funding_txid(),
 channel_id: self.context.channel_id,
 counterparty_node_id: self.context.counterparty_node_id,
 };
 self.context.channel_state = ChannelState::ShutdownComplete as u32;
 Some(shutdown_result)
Expand Down

59 changes: 41 additions & 18 deletions
lightning/src/ln/channelmanager.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2808,7 +2808,10 @@ where
 debug_assert_ne!(peer.held_by_thread(), LockHeldState::HeldByThread);
 }

 log_debug!(self.logger, "Finishing closure of channel with {} HTLCs to fail", shutdown_res.dropped_outbound_htlcs.len());
 let logger = WithContext::from(
 &self.logger, Some(shutdown_res.counterparty_node_id), Some(shutdown_res.channel_id),
 );
 log_debug!(logger, "Finishing closure of channel with {} HTLCs to fail", shutdown_res.dropped_outbound_htlcs.len());
 for htlc_source in shutdown_res.dropped_outbound_htlcs.drain(..) {
 let (source, payment_hash, counterparty_node_id, channel_id) = htlc_source;
 let reason = HTLCFailReason::from_failure_code(0x4000 | 8);
Expand DownExpand Up@@ -2967,7 +2970,7 @@ where
	}

	fn decode_update_add_htlc_onion(
 &self, msg: &msgs::UpdateAddHTLC
 &self, msg: &msgs::UpdateAddHTLC, counterparty_node_id: &PublicKey,
	) -> Result<
 (onion_utils::Hop, [u8; 32], Option<Result<PublicKey, secp256k1::Error>>), HTLCFailureMsg
	> {
Expand All@@ -2986,7 +2989,7 @@ where
 ($msg: expr, $err_code: expr, $data: expr) => {
 {
 log_info!(
 WithContext::from(&self.logger, None, Some(msg.channel_id)),
 WithContext::from(&self.logger, Some(*counterparty_node_id), Some(msg.channel_id)),
 "Failed to accept/forward incoming HTLC: {}", $msg
 );
 let (err_code, err_data) = if is_blinded {
Expand DownExpand Up@@ -3133,13 +3136,15 @@ where
	}

	fn construct_pending_htlc_status<'a>(
 &self, msg: &msgs::UpdateAddHTLC, shared_secret: [u8; 32], decoded_hop: onion_utils::Hop,
 allow_underpay: bool, next_packet_pubkey_opt: Option<Result<PublicKey, secp256k1::Error>>
 &self, msg: &msgs::UpdateAddHTLC, counterparty_node_id: &PublicKey, shared_secret: [u8; 32],
 decoded_hop: onion_utils::Hop, allow_underpay: bool,
 next_packet_pubkey_opt: Option<Result<PublicKey, secp256k1::Error>>,
	) -> PendingHTLCStatus {
 macro_rules! return_err {
 ($msg: expr, $err_code: expr, $data: expr) => {
 {
 log_info!(WithContext::from(&self.logger, None, Some(msg.channel_id)), "Failed to accept/forward incoming HTLC: {}", $msg);
 let logger = WithContext::from(&self.logger, Some(*counterparty_node_id), Some(msg.channel_id));
 log_info!(logger, "Failed to accept/forward incoming HTLC: {}", $msg);
 return PendingHTLCStatus::Fail(HTLCFailureMsg::Relay(msgs::UpdateFailHTLC {
 channel_id: msg.channel_id,
 htlc_id: msg.htlc_id,
Expand DownExpand Up@@ -3276,23 +3281,33 @@ where
 } = args;
 // The top-level caller should hold the total_consistency_lock read lock.
 debug_assert!(self.total_consistency_lock.try_write().is_err());
 log_trace!(WithContext::from(&self.logger, Some(path.hops.first().unwrap().pubkey), None),
 "Attempting to send payment with payment hash {} along path with next hop {}",
 payment_hash, path.hops.first().unwrap().short_channel_id);
 let prng_seed = self.entropy_source.get_secure_random_bytes();
 let session_priv = SecretKey::from_slice(&session_priv_bytes[..]).expect("RNG is busted");

 let (onion_packet, htlc_msat, htlc_cltv) = onion_utils::create_payment_onion(
 &self.secp_ctx, &path, &session_priv, total_value, recipient_onion, cur_height,
 payment_hash, keysend_preimage, prng_seed
 )?;
 ).map_err(|e| {
 let logger = WithContext::from(&self.logger, Some(path.hops.first().unwrap().pubkey), None);
 log_error!(logger, "Failed to build an onion for path for payment hash {}", payment_hash);
 e
 })?;

 let err: Result<(), _> = loop {
 let (counterparty_node_id, id) = match self.short_to_chan_info.read().unwrap().get(&path.hops.first().unwrap().short_channel_id) {
 None => return Err(APIError::ChannelUnavailable{err: "No channel available with first hop!".to_owned()}),
 None => {
 let logger = WithContext::from(&self.logger, Some(path.hops.first().unwrap().pubkey), None);
 log_error!(logger, "Failed to find first-hop for payment hash {}", payment_hash);
 return Err(APIError::ChannelUnavailable{err: "No channel available with first hop!".to_owned()})
 },
 Some((cp_id, chan_id)) => (cp_id.clone(), chan_id.clone()),
 };

 let logger = WithContext::from(&self.logger, Some(counterparty_node_id), Some(id));
 log_trace!(logger,
 "Attempting to send payment with payment hash {} along path with next hop {}",
 payment_hash, path.hops.first().unwrap().short_channel_id);

 let per_peer_state = self.per_peer_state.read().unwrap();
 let peer_state_mutex = per_peer_state.get(&counterparty_node_id)
 .ok_or_else(|| APIError::ChannelUnavailable{err: "No peer matching the path's first hop found!".to_owned() })?;
Expand DownExpand Up@@ -4044,7 +4059,8 @@ where
 None => {
 let error = format!("Channel with id {} not found for the passed counterparty node_id {}",
 next_hop_channel_id, next_node_id);
 log_error!(self.logger, "{} when attempting to forward intercepted HTLC", error);
 let logger = WithContext::from(&self.logger, Some(next_node_id), Some(*next_hop_channel_id));
 log_error!(logger, "{} when attempting to forward intercepted HTLC", error);
 return Err(APIError::ChannelUnavailable {
 err: error
 })
Expand DownExpand Up@@ -4132,6 +4148,7 @@ where

 for (short_chan_id, mut pending_forwards) in forward_htlcs {
 if short_chan_id != 0 {
 let mut forwarding_counterparty = None;
 macro_rules! forwarding_channel_not_found {
 () => {
 for forward_info in pending_forwards.drain(..) {
Expand All@@ -4145,7 +4162,8 @@ where
 }) => {
 macro_rules! failure_handler {
 ($msg: expr, $err_code: expr, $err_data: expr, $phantom_ss: expr, $next_hop_unknown: expr) => {
 log_info!(self.logger, "Failed to accept/forward incoming HTLC: {}", $msg);
 let logger = WithContext::from(&self.logger, forwarding_counterparty, Some(prev_funding_outpoint.to_channel_id()));
 log_info!(logger, "Failed to accept/forward incoming HTLC: {}", $msg);

 let htlc_source = HTLCSource::PreviousHopData(HTLCPreviousHopData {
 short_channel_id: prev_short_channel_id,
Expand DownExpand Up@@ -4244,6 +4262,7 @@ where
 continue;
 }
 };
 forwarding_counterparty = Some(counterparty_node_id);
 let per_peer_state = self.per_peer_state.read().unwrap();
 let peer_state_mutex_opt = per_peer_state.get(&counterparty_node_id);
 if peer_state_mutex_opt.is_none() {
Expand DownExpand Up@@ -5347,6 +5366,7 @@ where
 }
 if valid_mpp {
 for htlc in sources.drain(..) {
 let prev_hop_chan_id = htlc.prev_hop.outpoint.to_channel_id();
 if let Err((pk, err)) = self.claim_funds_from_hop(
 htlc.prev_hop, payment_preimage,
 |_, definitely_duplicate| {
Expand All@@ -5357,6 +5377,7 @@ where
 if let msgs::ErrorAction::IgnoreError = err.err.action {
 // We got a temporary failure updating monitor, but will claim the
 // HTLC when the monitor updating is restored (or on chain).
 let logger = WithContext::from(&self.logger, None, Some(prev_hop_chan_id));
 log_error!(self.logger, "Temporary failure claiming HTLC, treating as success: {}", err.err.err);
 } else { errs.push((pk, err)); }
 }
Expand DownExpand Up@@ -6455,7 +6476,7 @@ where
 // Note that the ChannelManager is NOT re-persisted on disk after this (unless we error
 // closing a channel), so any changes are likely to be lost on restart!

 let decoded_hop_res = self.decode_update_add_htlc_onion(msg);
 let decoded_hop_res = self.decode_update_add_htlc_onion(msg, counterparty_node_id);
 let per_peer_state = self.per_peer_state.read().unwrap();
 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
 .ok_or_else(|| {
Expand All@@ -6469,8 +6490,10 @@ where
 if let ChannelPhase::Funded(chan) = chan_phase_entry.get_mut() {
 let pending_forward_info = match decoded_hop_res {
 Ok((next_hop, shared_secret, next_packet_pk_opt)) =>
 self.construct_pending_htlc_status(msg, shared_secret, next_hop,
 chan.context.config().accept_underpaying_htlcs, next_packet_pk_opt),
 self.construct_pending_htlc_status(
 msg, counterparty_node_id, shared_secret, next_hop,
 chan.context.config().accept_underpaying_htlcs, next_packet_pk_opt,
 ),
 Err(e) => PendingHTLCStatus::Fail(e)
 };
 let create_pending_htlc_status = |chan: &Channel<SP>, pending_forward_info: PendingHTLCStatus, error_code: u16| {
Expand DownExpand Up@@ -10014,7 +10037,7 @@ where
 log_error!(logger, "A ChannelManager is stale compared to the current ChannelMonitor!");
 log_error!(logger, " The channel will be force-closed and the latest commitment transaction from the ChannelMonitor broadcast.");
 if channel.context.get_latest_monitor_update_id() < monitor.get_latest_update_id() {
 log_error!(args.logger, " The ChannelMonitor for channel {} is at update_id {} but the ChannelManager is at update_id {}.",
 log_error!(logger, " The ChannelMonitor for channel {} is at update_id {} but the ChannelManager is at update_id {}.",
 &channel.context.channel_id(), monitor.get_latest_update_id(), channel.context.get_latest_monitor_update_id());
 }
 if channel.get_cur_holder_commitment_transaction_number() > monitor.get_cur_holder_commitment_number() {
Expand DownExpand Up@@ -10410,7 +10433,7 @@ where
 let counterparty_opt = id_to_peer.get(&monitor.get_funding_txo().0.to_channel_id());
 let chan_id = monitor.get_funding_txo().0.to_channel_id();
 if counterparty_opt.is_none() {
 let logger = WithContext::from(&args.logger, None, Some(chan_id));
 let logger = WithChannelMonitor::from(&args.logger, monitor);
 for (htlc_source, (htlc, _)) in monitor.get_pending_or_resolved_outbound_htlcs() {
 if let HTLCSource::OutboundRoute { payment_id, session_priv, path, .. } = htlc_source {
 if path.hops.is_empty() {
Expand Down

4 changes: 4 additions & 0 deletions
lightning/src/util/logger.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -98,6 +98,10 @@ pub struct Record<'a> {
	/// The verbosity level of the message.
	pub level: Level,
	/// The node id of the peer pertaining to the logged record.
	///
	/// Note that in some cases a [`Self::channel_id`] may be filled in but this may still be
	/// `None`, depending on if the peer information is readily available in LDK when the log is
	/// generated.
	pub peer_id: Option<PublicKey>,
	/// The channel id of the channel pertaining to the logged record. May be a temporary id before
	/// the channel has been funded.
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); }
})();
})();
Post-#2314 Cleanups #3 by TheBlueMatt · Pull Request #2769 · lightningdevkit/rust-lightning · GitHub
Skip to content
Post-#2314 Cleanups #3#2769

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

wpaulino
merged 6 commits into

from

Dec 4, 2023
 Merged


Post-#2314 Cleanups #3
#2769
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


6 commits


Select commit
Hold shift + click to select a range
f57295f

Include counterparty node id and channel id in shutdown log


TheBlueMatt Dec 2, 2023
0ce0d48

Add missing counterparty node id metadata to logs in HTLC decoding


TheBlueMatt Dec 2, 2023
2fc79cb

Include next-hop counterparty node id in log metadata when sending


TheBlueMatt Dec 2, 2023
b0606a1

Log next-hop metadata when forwarding or failing to forward HTLC


TheBlueMatt Dec 2, 2023
2be5e37

Set log metadata in a few additional locations in `channelmanager`


TheBlueMatt Dec 3, 2023
cf0539e

Doc that `Record::node_id` may be missing even with `channel_id`


TheBlueMatt Dec 3, 2023

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


10 changes: 10 additions & 0 deletions
lightning/src/ln/channel.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -599,6 +599,8 @@ pub(crate) struct ShutdownResult {
	/// An unbroadcasted batch funding transaction id. The closure of this channel should be
	/// propagated to the remainder of the batch.
	pub(crate) unbroadcasted_batch_funding_txid: Option<Txid>,
	pub(crate) channel_id: ChannelId,
	pub(crate) counterparty_node_id: PublicKey,
}

/// If the majority of the channels funds are to the fundee and the initiator holds only just
Expand DownExpand Up@@ -2164,6 +2166,8 @@ impl<SP: Deref> ChannelContext<SP> where SP::Target: SignerProvider {
 monitor_update,
 dropped_outbound_htlcs,
 unbroadcasted_batch_funding_txid,
 channel_id: self.channel_id,
 counterparty_node_id: self.counterparty_node_id,
 }
	}

Expand DownExpand Up@@ -4707,6 +4711,8 @@ impl<SP: Deref> Channel<SP> where
 monitor_update: None,
 dropped_outbound_htlcs: Vec::new(),
 unbroadcasted_batch_funding_txid: self.context.unbroadcasted_batch_funding_txid(),
 channel_id: self.context.channel_id,
 counterparty_node_id: self.context.counterparty_node_id,
 };
 let tx = self.build_signed_closing_transaction(&mut closing_tx, &msg.signature, &sig);
 self.context.channel_state = ChannelState::ShutdownComplete as u32;
Expand DownExpand Up@@ -4735,6 +4741,8 @@ impl<SP: Deref> Channel<SP> where
 monitor_update: None,
 dropped_outbound_htlcs: Vec::new(),
 unbroadcasted_batch_funding_txid: self.context.unbroadcasted_batch_funding_txid(),
 channel_id: self.context.channel_id,
 counterparty_node_id: self.context.counterparty_node_id,
 };
 self.context.channel_state = ChannelState::ShutdownComplete as u32;
 self.context.update_time_counter += 1;
Expand DownExpand Up@@ -5913,6 +5921,8 @@ impl<SP: Deref> Channel<SP> where
 monitor_update: None,
 dropped_outbound_htlcs: Vec::new(),
 unbroadcasted_batch_funding_txid: self.context.unbroadcasted_batch_funding_txid(),
 channel_id: self.context.channel_id,
 counterparty_node_id: self.context.counterparty_node_id,
 };
 self.context.channel_state = ChannelState::ShutdownComplete as u32;
 Some(shutdown_result)
Expand Down

59 changes: 41 additions & 18 deletions
lightning/src/ln/channelmanager.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2808,7 +2808,10 @@ where
 debug_assert_ne!(peer.held_by_thread(), LockHeldState::HeldByThread);
 }

 log_debug!(self.logger, "Finishing closure of channel with {} HTLCs to fail", shutdown_res.dropped_outbound_htlcs.len());
 let logger = WithContext::from(
 &self.logger, Some(shutdown_res.counterparty_node_id), Some(shutdown_res.channel_id),
 );
 log_debug!(logger, "Finishing closure of channel with {} HTLCs to fail", shutdown_res.dropped_outbound_htlcs.len());
 for htlc_source in shutdown_res.dropped_outbound_htlcs.drain(..) {
 let (source, payment_hash, counterparty_node_id, channel_id) = htlc_source;
 let reason = HTLCFailReason::from_failure_code(0x4000 | 8);
Expand DownExpand Up@@ -2967,7 +2970,7 @@ where
	}

	fn decode_update_add_htlc_onion(
 &self, msg: &msgs::UpdateAddHTLC
 &self, msg: &msgs::UpdateAddHTLC, counterparty_node_id: &PublicKey,
	) -> Result<
 (onion_utils::Hop, [u8; 32], Option<Result<PublicKey, secp256k1::Error>>), HTLCFailureMsg
	> {
Expand All@@ -2986,7 +2989,7 @@ where
 ($msg: expr, $err_code: expr, $data: expr) => {
 {
 log_info!(
 WithContext::from(&self.logger, None, Some(msg.channel_id)),
 WithContext::from(&self.logger, Some(*counterparty_node_id), Some(msg.channel_id)),
 "Failed to accept/forward incoming HTLC: {}", $msg
 );
 let (err_code, err_data) = if is_blinded {
Expand DownExpand Up@@ -3133,13 +3136,15 @@ where
	}

	fn construct_pending_htlc_status<'a>(
 &self, msg: &msgs::UpdateAddHTLC, shared_secret: [u8; 32], decoded_hop: onion_utils::Hop,
 allow_underpay: bool, next_packet_pubkey_opt: Option<Result<PublicKey, secp256k1::Error>>
 &self, msg: &msgs::UpdateAddHTLC, counterparty_node_id: &PublicKey, shared_secret: [u8; 32],
 decoded_hop: onion_utils::Hop, allow_underpay: bool,
 next_packet_pubkey_opt: Option<Result<PublicKey, secp256k1::Error>>,
	) -> PendingHTLCStatus {
 macro_rules! return_err {
 ($msg: expr, $err_code: expr, $data: expr) => {
 {
 log_info!(WithContext::from(&self.logger, None, Some(msg.channel_id)), "Failed to accept/forward incoming HTLC: {}", $msg);
 let logger = WithContext::from(&self.logger, Some(*counterparty_node_id), Some(msg.channel_id));
 log_info!(logger, "Failed to accept/forward incoming HTLC: {}", $msg);
 return PendingHTLCStatus::Fail(HTLCFailureMsg::Relay(msgs::UpdateFailHTLC {
 channel_id: msg.channel_id,
 htlc_id: msg.htlc_id,
Expand DownExpand Up@@ -3276,23 +3281,33 @@ where
 } = args;
 // The top-level caller should hold the total_consistency_lock read lock.
 debug_assert!(self.total_consistency_lock.try_write().is_err());
 log_trace!(WithContext::from(&self.logger, Some(path.hops.first().unwrap().pubkey), None),
 "Attempting to send payment with payment hash {} along path with next hop {}",
 payment_hash, path.hops.first().unwrap().short_channel_id);
 let prng_seed = self.entropy_source.get_secure_random_bytes();
 let session_priv = SecretKey::from_slice(&session_priv_bytes[..]).expect("RNG is busted");

 let (onion_packet, htlc_msat, htlc_cltv) = onion_utils::create_payment_onion(
 &self.secp_ctx, &path, &session_priv, total_value, recipient_onion, cur_height,
 payment_hash, keysend_preimage, prng_seed
 )?;
 ).map_err(|e| {
 let logger = WithContext::from(&self.logger, Some(path.hops.first().unwrap().pubkey), None);
 log_error!(logger, "Failed to build an onion for path for payment hash {}", payment_hash);
 e
 })?;

 let err: Result<(), _> = loop {
 let (counterparty_node_id, id) = match self.short_to_chan_info.read().unwrap().get(&path.hops.first().unwrap().short_channel_id) {
 None => return Err(APIError::ChannelUnavailable{err: "No channel available with first hop!".to_owned()}),
 None => {
 let logger = WithContext::from(&self.logger, Some(path.hops.first().unwrap().pubkey), None);
 log_error!(logger, "Failed to find first-hop for payment hash {}", payment_hash);
 return Err(APIError::ChannelUnavailable{err: "No channel available with first hop!".to_owned()})
 },
 Some((cp_id, chan_id)) => (cp_id.clone(), chan_id.clone()),
 };

 let logger = WithContext::from(&self.logger, Some(counterparty_node_id), Some(id));
 log_trace!(logger,
 "Attempting to send payment with payment hash {} along path with next hop {}",
 payment_hash, path.hops.first().unwrap().short_channel_id);

 let per_peer_state = self.per_peer_state.read().unwrap();
 let peer_state_mutex = per_peer_state.get(&counterparty_node_id)
 .ok_or_else(|| APIError::ChannelUnavailable{err: "No peer matching the path's first hop found!".to_owned() })?;
Expand DownExpand Up@@ -4044,7 +4059,8 @@ where
 None => {
 let error = format!("Channel with id {} not found for the passed counterparty node_id {}",
 next_hop_channel_id, next_node_id);
 log_error!(self.logger, "{} when attempting to forward intercepted HTLC", error);
 let logger = WithContext::from(&self.logger, Some(next_node_id), Some(*next_hop_channel_id));
 log_error!(logger, "{} when attempting to forward intercepted HTLC", error);
 return Err(APIError::ChannelUnavailable {
 err: error
 })
Expand DownExpand Up@@ -4132,6 +4148,7 @@ where

 for (short_chan_id, mut pending_forwards) in forward_htlcs {
 if short_chan_id != 0 {
 let mut forwarding_counterparty = None;
 macro_rules! forwarding_channel_not_found {
 () => {
 for forward_info in pending_forwards.drain(..) {
Expand All@@ -4145,7 +4162,8 @@ where
 }) => {
 macro_rules! failure_handler {
 ($msg: expr, $err_code: expr, $err_data: expr, $phantom_ss: expr, $next_hop_unknown: expr) => {
 log_info!(self.logger, "Failed to accept/forward incoming HTLC: {}", $msg);
 let logger = WithContext::from(&self.logger, forwarding_counterparty, Some(prev_funding_outpoint.to_channel_id()));
 log_info!(logger, "Failed to accept/forward incoming HTLC: {}", $msg);

 let htlc_source = HTLCSource::PreviousHopData(HTLCPreviousHopData {
 short_channel_id: prev_short_channel_id,
Expand DownExpand Up@@ -4244,6 +4262,7 @@ where
 continue;
 }
 };
 forwarding_counterparty = Some(counterparty_node_id);
 let per_peer_state = self.per_peer_state.read().unwrap();
 let peer_state_mutex_opt = per_peer_state.get(&counterparty_node_id);
 if peer_state_mutex_opt.is_none() {
Expand DownExpand Up@@ -5347,6 +5366,7 @@ where
 }
 if valid_mpp {
 for htlc in sources.drain(..) {
 let prev_hop_chan_id = htlc.prev_hop.outpoint.to_channel_id();
 if let Err((pk, err)) = self.claim_funds_from_hop(
 htlc.prev_hop, payment_preimage,
 |_, definitely_duplicate| {
Expand All@@ -5357,6 +5377,7 @@ where
 if let msgs::ErrorAction::IgnoreError = err.err.action {
 // We got a temporary failure updating monitor, but will claim the
 // HTLC when the monitor updating is restored (or on chain).
 let logger = WithContext::from(&self.logger, None, Some(prev_hop_chan_id));
 log_error!(self.logger, "Temporary failure claiming HTLC, treating as success: {}", err.err.err);
 } else { errs.push((pk, err)); }
 }
Expand DownExpand Up@@ -6455,7 +6476,7 @@ where
 // Note that the ChannelManager is NOT re-persisted on disk after this (unless we error
 // closing a channel), so any changes are likely to be lost on restart!

 let decoded_hop_res = self.decode_update_add_htlc_onion(msg);
 let decoded_hop_res = self.decode_update_add_htlc_onion(msg, counterparty_node_id);
 let per_peer_state = self.per_peer_state.read().unwrap();
 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
 .ok_or_else(|| {
Expand All@@ -6469,8 +6490,10 @@ where
 if let ChannelPhase::Funded(chan) = chan_phase_entry.get_mut() {
 let pending_forward_info = match decoded_hop_res {
 Ok((next_hop, shared_secret, next_packet_pk_opt)) =>
 self.construct_pending_htlc_status(msg, shared_secret, next_hop,
 chan.context.config().accept_underpaying_htlcs, next_packet_pk_opt),
 self.construct_pending_htlc_status(
 msg, counterparty_node_id, shared_secret, next_hop,
 chan.context.config().accept_underpaying_htlcs, next_packet_pk_opt,
 ),
 Err(e) => PendingHTLCStatus::Fail(e)
 };
 let create_pending_htlc_status = |chan: &Channel<SP>, pending_forward_info: PendingHTLCStatus, error_code: u16| {
Expand DownExpand Up@@ -10014,7 +10037,7 @@ where
 log_error!(logger, "A ChannelManager is stale compared to the current ChannelMonitor!");
 log_error!(logger, " The channel will be force-closed and the latest commitment transaction from the ChannelMonitor broadcast.");
 if channel.context.get_latest_monitor_update_id() < monitor.get_latest_update_id() {
 log_error!(args.logger, " The ChannelMonitor for channel {} is at update_id {} but the ChannelManager is at update_id {}.",
 log_error!(logger, " The ChannelMonitor for channel {} is at update_id {} but the ChannelManager is at update_id {}.",
 &channel.context.channel_id(), monitor.get_latest_update_id(), channel.context.get_latest_monitor_update_id());
 }
 if channel.get_cur_holder_commitment_transaction_number() > monitor.get_cur_holder_commitment_number() {
Expand DownExpand Up@@ -10410,7 +10433,7 @@ where
 let counterparty_opt = id_to_peer.get(&monitor.get_funding_txo().0.to_channel_id());
 let chan_id = monitor.get_funding_txo().0.to_channel_id();
 if counterparty_opt.is_none() {
 let logger = WithContext::from(&args.logger, None, Some(chan_id));
 let logger = WithChannelMonitor::from(&args.logger, monitor);
 for (htlc_source, (htlc, _)) in monitor.get_pending_or_resolved_outbound_htlcs() {
 if let HTLCSource::OutboundRoute { payment_id, session_priv, path, .. } = htlc_source {
 if path.hops.is_empty() {
Expand Down

4 changes: 4 additions & 0 deletions
lightning/src/util/logger.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -98,6 +98,10 @@ pub struct Record<'a> {
	/// The verbosity level of the message.
	pub level: Level,
	/// The node id of the peer pertaining to the logged record.
	///
	/// Note that in some cases a [`Self::channel_id`] may be filled in but this may still be
	/// `None`, depending on if the peer information is readily available in LDK when the log is
	/// generated.
	pub peer_id: Option<PublicKey>,
	/// The channel id of the channel pertaining to the logged record. May be a temporary id before
	/// the channel has been funded.
Expand Down