Attributable errors 2025#3611

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

Closed
joostjager wants to merge 2 commits into from
Closed

Attributable errors 2025 #3611

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d282ea8
Attributable failures
joostjager Mar 5, 2025
e7923e9
Attributable failures optional feature bit
joostjager Mar 10, 2025
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
8 changes: 7 additions & 1 deletion lightning-invoice/src/lib.rs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -597,12 +597,18 @@ impl InvoiceBuilder<tb::False, tb::False, tb::False, tb::False, tb::False, tb::F
/// Construct new, empty `InvoiceBuilder`. All necessary fields have to be filled first before
/// `InvoiceBuilder::build(self)` becomes available.
pub fn new(currency: Currency) -> Self {
let mut features = Bolt11InvoiceFeatures::empty();
features.set_attributable_failures_optional();

let mut tagged_fields = Vec::with_capacity(8);
tagged_fields.push(TaggedField::Features(features));

InvoiceBuilder {
currency,
amount: None,
si_prefix: None,
timestamp: None,
tagged_fields: Vec::with_capacity(8),
tagged_fields,
error: None,

phantom_d: core::marker::PhantomData,
Expand Down
18 changes: 14 additions & 4 deletions lightning-types/src/features.rs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -154,7 +154,7 @@ mod sealed {
// Byte 3
RouteBlinding | ShutdownAnySegwit | DualFund | Taproot,
// Byte 4
Quiescence | OnionMessages,
Quiescence | OnionMessages | AttributableFailures,
// Byte 5
ProvideStorage | ChannelType | SCIDPrivacy,
// Byte 6
Expand All@@ -175,7 +175,7 @@ mod sealed {
// Byte 3
RouteBlinding | ShutdownAnySegwit | DualFund | Taproot,
// Byte 4
Quiescence | OnionMessages,
Quiescence | OnionMessages | AttributableFailures,
// Byte 5
ProvideStorage | ChannelType | SCIDPrivacy,
// Byte 6
Expand All@@ -199,7 +199,7 @@ mod sealed {
// Byte 3
,
// Byte 4
,
AttributableFailures,
// Byte 5
,
// Byte 6
Expand All@@ -219,7 +219,7 @@ mod sealed {
// Byte 3
,
// Byte 4
,
AttributableFailures,
// Byte 5
,
// Byte 6
Expand DownExpand Up@@ -548,6 +548,16 @@ mod sealed {
supports_quiescence,
requires_quiescence
);
define_feature!(
37,
AttributableFailures,
[InitContext, NodeContext, Bolt11InvoiceContext, Bolt12InvoiceContext],
"Feature flags for `option_attributable_failures`.",
set_attributable_failures_optional,
set_attributable_failures_required,
supports_attributable_failures,
requires_attributable_failures
);
define_feature!(
39,
OnionMessages,
Expand Down
93 changes: 86 additions & 7 deletions lightning/src/ln/channel.rs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -50,7 +50,7 @@ use crate::ln::chan_utils::{
#[cfg(splicing)]
use crate::ln::chan_utils::FUNDING_TRANSACTION_WITNESS_WEIGHT;
use crate::ln::chan_utils;
use crate::ln::onion_utils::{HTLCFailReason};
use crate::ln::onion_utils::{HTLCFailReason, ATTRIBUTION_DATA_LEN};
use crate::chain::BestBlock;
use crate::chain::chaininterface::{FeeEstimator, ConfirmationTarget, LowerBoundedFeeEstimator, fee_for_weight};
use crate::chain::channelmonitor::{ChannelMonitor, ChannelMonitorUpdate, ChannelMonitorUpdateStep, LATENCY_GRACE_PERIOD_BLOCKS};
Expand All@@ -68,8 +68,11 @@ use crate::util::scid_utils::scid_from_parts;

use crate::io;
use crate::prelude::*;
use core::time::Duration;
use core::{cmp,mem,fmt};
use core::ops::Deref;
#[cfg(feature = "std")]
use std::time::SystemTime;
#[cfg(any(test, fuzzing, debug_assertions))]
use crate::sync::Mutex;
use crate::sign::type_resolver::ChannelSignerType;
Expand DownExpand Up@@ -323,6 +326,7 @@ struct OutboundHTLCOutput {
source: HTLCSource,
blinding_point: Option<PublicKey>,
skimmed_fee_msat: Option<u64>,
timestamp: Option<Duration>,
}

/// See AwaitingRemoteRevoke ChannelState for more info
Expand DownExpand Up@@ -4933,7 +4937,7 @@ trait FailHTLCContents {
impl FailHTLCContents for msgs::OnionErrorPacket {
type Message = msgs::UpdateFailHTLC;
fn to_message(self, htlc_id: u64, channel_id: ChannelId) -> Self::Message {
msgs::UpdateFailHTLC { htlc_id, channel_id, reason: self.data }
msgs::UpdateFailHTLC { htlc_id, channel_id, reason: self.data, attribution_data: self.attribution_data }
}
fn to_inbound_htlc_state(self) -> InboundHTLCState {
InboundHTLCState::LocalRemoved(InboundHTLCRemovalReason::FailRelay(self))
Expand DownExpand Up@@ -6100,10 +6104,16 @@ impl<SP: Deref> FundedChannel<SP> where
false
} else { true }
});
let now = duration_since_epoch();
pending_outbound_htlcs.retain(|htlc| {
if let &OutboundHTLCState::AwaitingRemovedRemoteRevoke(ref outcome) = &htlc.state {
log_trace!(logger, " ...removing outbound AwaitingRemovedRemoteRevoke {}", &htlc.payment_hash);
if let OutboundHTLCOutcome::Failure(reason) = outcome.clone() { // We really want take() here, but, again, non-mut ref :(
if let OutboundHTLCOutcome::Failure(mut reason) = outcome.clone() { // We really want take() here, but, again, non-mut ref :(
if let (Some(timestamp), Some(now)) = (htlc.timestamp, now) {
let hold_time = u32::try_from((now - timestamp).as_millis()).unwrap_or(u32::MAX);
reason.set_hold_time(hold_time);
}

revoked_htlcs.push((htlc.source.clone(), htlc.payment_hash, reason));
} else {
finalized_claimed_htlcs.push(htlc.source.clone());
Expand DownExpand Up@@ -6845,6 +6855,7 @@ impl<SP: Deref> FundedChannel<SP> where
channel_id: self.context.channel_id(),
htlc_id: htlc.htlc_id,
reason: err_packet.data.clone(),
attribution_data: err_packet.attribution_data,
});
},
&InboundHTLCRemovalReason::FailMalformed((ref sha256_of_onion, ref failure_code)) => {
Expand DownExpand Up@@ -8671,6 +8682,7 @@ impl<SP: Deref> FundedChannel<SP> where
return Ok(None);
}

let timestamp = duration_since_epoch();
self.context.pending_outbound_htlcs.push(OutboundHTLCOutput {
htlc_id: self.context.next_holder_htlc_id,
amount_msat,
Expand All@@ -8680,6 +8692,7 @@ impl<SP: Deref> FundedChannel<SP> where
source,
blinding_point,
skimmed_fee_msat,
timestamp,
});

let res = msgs::UpdateAddHTLC {
Expand DownExpand Up@@ -10247,6 +10260,7 @@ impl<SP: Deref> Writeable for FundedChannel<SP> where SP::Target: SignerProvider
dropped_inbound_htlcs += 1;
}
}
let mut removed_htlc_failure_attribution_data: Vec<&Option<[u8; ATTRIBUTION_DATA_LEN]>> = Vec::new();
(self.context.pending_inbound_htlcs.len() as u64 - dropped_inbound_htlcs).write(writer)?;
for htlc in self.context.pending_inbound_htlcs.iter() {
if let &InboundHTLCState::RemoteAnnounced(_) = &htlc.state {
Expand All@@ -10272,9 +10286,10 @@ impl<SP: Deref> Writeable for FundedChannel<SP> where SP::Target: SignerProvider
&InboundHTLCState::LocalRemoved(ref removal_reason) => {
4u8.write(writer)?;
match removal_reason {
Comment thread
joostjager marked this conversation as resolved.
InboundHTLCRemovalReason::FailRelay(msgs::OnionErrorPacket { data }) => {
InboundHTLCRemovalReason::FailRelay(msgs::OnionErrorPacket { data, attribution_data }) => {
0u8.write(writer)?;
data.write(writer)?;
removed_htlc_failure_attribution_data.push(&attribution_data);
},
InboundHTLCRemovalReason::FailMalformed((hash, code)) => {
1u8.write(writer)?;
Expand DownExpand Up@@ -10336,10 +10351,11 @@ impl<SP: Deref> Writeable for FundedChannel<SP> where SP::Target: SignerProvider

let mut holding_cell_skimmed_fees: Vec<Option<u64>> = Vec::new();
let mut holding_cell_blinding_points: Vec<Option<PublicKey>> = Vec::new();
let mut holding_cell_failure_attribution_data: Vec<(u32, [u8; ATTRIBUTION_DATA_LEN])> = Vec::new();
// Vec of (htlc_id, failure_code, sha256_of_onion)
let mut malformed_htlcs: Vec<(u64, u16, [u8; 32])> = Vec::new();
(self.context.holding_cell_htlc_updates.len() as u64).write(writer)?;
for update in self.context.holding_cell_htlc_updates.iter() {
for (i, update) in self.context.holding_cell_htlc_updates.iter().enumerate() {
match update {
&HTLCUpdateAwaitingACK::AddHTLC {
ref amount_msat, ref cltv_expiry, ref payment_hash, ref source, ref onion_routing_packet,
Expand All@@ -10364,6 +10380,13 @@ impl<SP: Deref> Writeable for FundedChannel<SP> where SP::Target: SignerProvider
2u8.write(writer)?;
htlc_id.write(writer)?;
err_packet.data.write(writer)?;

// Store the attribution data for later writing. Include the holding cell htlc update index because
// FailMalformedHTLC is stored with the same type 2 and we wouldn't be able to distinguish the two
// when reading back in.
if let Some(attribution_data ) = err_packet.attribution_data {
holding_cell_failure_attribution_data.push((i as u32, attribution_data));
}
}
&HTLCUpdateAwaitingACK::FailMalformedHTLC {
htlc_id, failure_code, sha256_of_onion
Expand DownExpand Up@@ -10547,6 +10570,8 @@ impl<SP: Deref> Writeable for FundedChannel<SP> where SP::Target: SignerProvider
(49, self.context.local_initiated_shutdown, option), // Added in 0.0.122
(51, is_manual_broadcast, option), // Added in 0.0.124
(53, funding_tx_broadcast_safe_event_emitted, option), // Added in 0.0.124
(55, removed_htlc_failure_attribution_data, optional_vec), // Added in 0.2
(57, holding_cell_failure_attribution_data, optional_vec), // Added in 0.2
});

Ok(())
Expand DownExpand Up@@ -10624,6 +10649,7 @@ impl<'a, 'b, 'c, ES: Deref, SP: Deref> ReadableArgs<(&'a ES, &'b SP, &'c Channel
let reason = match <u8 as Readable>::read(reader)? {
0 => InboundHTLCRemovalReason::FailRelay(msgs::OnionErrorPacket {

@joostjagerjoostjagerFeb 27, 2025

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Update in holding cell, still waiting for next round of commitment dance. Should be tests that test holding cell persistence.

Strategy: break main, see if tests fail.

@joostjagerjoostjagerMar 3, 2025

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

expect_pending_htlcs_forwardable!(nodes[1]); - in here let node 0 do something else like add another htlc, so that the failure gets into the holding cell

data: Readable::read(reader)?,
attribution_data: None,
}),
1 => InboundHTLCRemovalReason::FailMalformed(Readable::read(reader)?),
2 => InboundHTLCRemovalReason::Fulfill(Readable::read(reader)?),
Expand DownExpand Up@@ -10664,6 +10690,7 @@ impl<'a, 'b, 'c, ES: Deref, SP: Deref> ReadableArgs<(&'a ES, &'b SP, &'c Channel
},
skimmed_fee_msat: None,
blinding_point: None,
timestamp: None,
});
}

Expand All@@ -10688,6 +10715,7 @@ impl<'a, 'b, 'c, ES: Deref, SP: Deref> ReadableArgs<(&'a ES, &'b SP, &'c Channel
htlc_id: Readable::read(reader)?,
err_packet: OnionErrorPacket {
data: Readable::read(reader)?,
attribution_data: None,
},
},
_ => return Err(DecodeError::InvalidValue),
Expand DownExpand Up@@ -10831,6 +10859,9 @@ impl<'a, 'b, 'c, ES: Deref, SP: Deref> ReadableArgs<(&'a ES, &'b SP, &'c Channel
let mut pending_outbound_blinding_points_opt: Option<Vec<Option<PublicKey>>> = None;
let mut holding_cell_blinding_points_opt: Option<Vec<Option<PublicKey>>> = None;

let mut removed_htlc_failure_attribution_data: Option<Vec<Option<[u8; ATTRIBUTION_DATA_LEN]>>> = None;
let mut holding_cell_failure_attribution_data: Option<Vec<(u32, [u8; ATTRIBUTION_DATA_LEN])>> = None;

let mut malformed_htlcs: Option<Vec<(u64, u16, [u8; 32])>> = None;
let mut monitor_pending_update_adds: Option<Vec<msgs::UpdateAddHTLC>> = None;

Expand DownExpand Up@@ -10873,6 +10904,8 @@ impl<'a, 'b, 'c, ES: Deref, SP: Deref> ReadableArgs<(&'a ES, &'b SP, &'c Channel
(49, local_initiated_shutdown, option),
(51, is_manual_broadcast, option),
(53, funding_tx_broadcast_safe_event_emitted, option),
(55, removed_htlc_failure_attribution_data, optional_vec),
(57, holding_cell_failure_attribution_data, optional_vec),
});

let holder_signer = signer_provider.derive_channel_signer(channel_keys_id);
Expand DownExpand Up@@ -10954,6 +10987,38 @@ impl<'a, 'b, 'c, ES: Deref, SP: Deref> ReadableArgs<(&'a ES, &'b SP, &'c Channel
if iter.next().is_some() { return Err(DecodeError::InvalidValue) }
}

if let Some(attribution_datas) = removed_htlc_failure_attribution_data {
let mut removed_htlc_relay_failures =
pending_inbound_htlcs.iter_mut().filter_map(|status|
if let InboundHTLCState::LocalRemoved(ref mut reason) = &mut status.state {
if let InboundHTLCRemovalReason::FailRelay(ref mut packet) = reason {
Some(&mut packet.attribution_data)
} else {
None
}
} else {
None
}
);

for attribution_data in attribution_datas {
*removed_htlc_relay_failures.next().ok_or(DecodeError::InvalidValue)? = attribution_data;
}
if removed_htlc_relay_failures.next().is_some() { return Err(DecodeError::InvalidValue); }
}

if let Some(attribution_datas) = holding_cell_failure_attribution_data {
for (i, attribution_data) in attribution_datas {
let update = holding_cell_htlc_updates.get_mut(i as usize).ok_or(DecodeError::InvalidValue)?;

if let HTLCUpdateAwaitingACK::FailHTLC { htlc_id: _, ref mut err_packet } = update {
err_packet.attribution_data = Some(attribution_data);
} else {
return Err(DecodeError::InvalidValue);
}
}
}

if let Some(malformed_htlcs) = malformed_htlcs {
for (malformed_htlc_id, failure_code, sha256_of_onion) in malformed_htlcs {
let htlc_idx = holding_cell_htlc_updates.iter().position(|htlc| {
Expand DownExpand Up@@ -11144,6 +11209,18 @@ impl<'a, 'b, 'c, ES: Deref, SP: Deref> ReadableArgs<(&'a ES, &'b SP, &'c Channel
}
}

fn duration_since_epoch() -> Option<Duration> {
#[cfg(not(feature = "std"))]
let now = None;

#[cfg(feature = "std")]
let now = Some(std::time::SystemTime::now()
.duration_since(std::time::SystemTime::UNIX_EPOCH)
.expect("SystemTime::now() should come after SystemTime::UNIX_EPOCH"));

now
}

#[cfg(test)]
mod tests {
use std::cmp;
Expand All@@ -11157,7 +11234,7 @@ mod tests {
use bitcoin::network::Network;
#[cfg(splicing)]
use bitcoin::Weight;
use crate::ln::onion_utils::INVALID_ONION_BLINDING;
use crate::ln::onion_utils::{ATTRIBUTION_DATA_LEN, INVALID_ONION_BLINDING};
use crate::types::payment::{PaymentHash, PaymentPreimage};
use crate::ln::channel_keys::{RevocationKey, RevocationBasepoint};
use crate::ln::channelmanager::{self, HTLCSource, PaymentId};
Expand DownExpand Up@@ -11378,6 +11455,7 @@ mod tests {
},
skimmed_fee_msat: None,
blinding_point: None,
timestamp: None,
});

// Make sure when Node A calculates their local commitment transaction, none of the HTLCs pass
Expand DownExpand Up@@ -11762,6 +11840,7 @@ mod tests {
source: dummy_htlc_source.clone(),
skimmed_fee_msat: None,
blinding_point: None,
timestamp: None,
};
let mut pending_outbound_htlcs = vec![dummy_outbound_output.clone(); 10];
for (idx, htlc) in pending_outbound_htlcs.iter_mut().enumerate() {
Expand DownExpand Up@@ -11793,7 +11872,7 @@ mod tests {
htlc_id: 0,
};
let dummy_holding_cell_failed_htlc = |htlc_id| HTLCUpdateAwaitingACK::FailHTLC {
htlc_id, err_packet: msgs::OnionErrorPacket { data: vec![42] }
htlc_id, err_packet: msgs::OnionErrorPacket { data: vec![42], attribution_data: Some([1; ATTRIBUTION_DATA_LEN]) }
};
let dummy_holding_cell_malformed_htlc = |htlc_id| HTLCUpdateAwaitingACK::FailMalformedHTLC {
htlc_id, failure_code: INVALID_ONION_BLINDING, sha256_of_onion: [0; 32],
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all 
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n 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;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '

Skip to content
Attributable errors 2025#3611

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

 Closed

joostjager
wants to merge
2
commits into

from

 Closed


Attributable errors 2025
#3611
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
d282ea8

Attributable failures


joostjager Mar 5, 2025
e7923e9

Attributable failures optional feature bit


joostjager Mar 10, 2025

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


8 changes: 7 additions & 1 deletion
lightning-invoice/src/lib.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -597,12 +597,18 @@ impl InvoiceBuilder<tb::False, tb::False, tb::False, tb::False, tb::False, tb::F
	/// Construct new, empty `InvoiceBuilder`. All necessary fields have to be filled first before
	/// `InvoiceBuilder::build(self)` becomes available.
	pub fn new(currency: Currency) -> Self {
 let mut features = Bolt11InvoiceFeatures::empty();
 features.set_attributable_failures_optional();

 let mut tagged_fields = Vec::with_capacity(8);
 tagged_fields.push(TaggedField::Features(features));

 InvoiceBuilder {
 currency,
 amount: None,
 si_prefix: None,
 timestamp: None,
 tagged_fields: Vec::with_capacity(8),
 tagged_fields,
 error: None,

 phantom_d: core::marker::PhantomData,
Expand Down

18 changes: 14 additions & 4 deletions
lightning-types/src/features.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -154,7 +154,7 @@ mod sealed {
 // Byte 3
 RouteBlinding | ShutdownAnySegwit | DualFund | Taproot,
 // Byte 4
 Quiescence | OnionMessages,
 Quiescence | OnionMessages | AttributableFailures,
 // Byte 5
 ProvideStorage | ChannelType | SCIDPrivacy,
 // Byte 6
Expand All@@ -175,7 +175,7 @@ mod sealed {
 // Byte 3
 RouteBlinding | ShutdownAnySegwit | DualFund | Taproot,
 // Byte 4
 Quiescence | OnionMessages,
 Quiescence | OnionMessages | AttributableFailures,
 // Byte 5
 ProvideStorage | ChannelType | SCIDPrivacy,
 // Byte 6
Expand All@@ -199,7 +199,7 @@ mod sealed {
 // Byte 3
 ,
 // Byte 4
 ,
AttributableFailures,
 // Byte 5
 ,
 // Byte 6
Expand All@@ -219,7 +219,7 @@ mod sealed {
 // Byte 3
 ,
 // Byte 4
 ,
AttributableFailures,
 // Byte 5
 ,
 // Byte 6
Expand DownExpand Up@@ -548,6 +548,16 @@ mod sealed {
 supports_quiescence,
 requires_quiescence
	);
	define_feature!(
 37,
 AttributableFailures,
 [InitContext, NodeContext, Bolt11InvoiceContext, Bolt12InvoiceContext],
 "Feature flags for `option_attributable_failures`.",
 set_attributable_failures_optional,
 set_attributable_failures_required,
 supports_attributable_failures,
 requires_attributable_failures
	);
	define_feature!(
 39,
 OnionMessages,
Expand Down

93 changes: 86 additions & 7 deletions
lightning/src/ln/channel.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -50,7 +50,7 @@ use crate::ln::chan_utils::{
#[cfg(splicing)]
use crate::ln::chan_utils::FUNDING_TRANSACTION_WITNESS_WEIGHT;
use crate::ln::chan_utils;
use crate::ln::onion_utils::{HTLCFailReason};
use crate::ln::onion_utils::{HTLCFailReason, ATTRIBUTION_DATA_LEN};
use crate::chain::BestBlock;
use crate::chain::chaininterface::{FeeEstimator, ConfirmationTarget, LowerBoundedFeeEstimator, fee_for_weight};
use crate::chain::channelmonitor::{ChannelMonitor, ChannelMonitorUpdate, ChannelMonitorUpdateStep, LATENCY_GRACE_PERIOD_BLOCKS};
Expand All@@ -68,8 +68,11 @@ use crate::util::scid_utils::scid_from_parts;

use crate::io;
use crate::prelude::*;
use core::time::Duration;
use core::{cmp,mem,fmt};
use core::ops::Deref;
#[cfg(feature = "std")]
use std::time::SystemTime;
#[cfg(any(test, fuzzing, debug_assertions))]
use crate::sync::Mutex;
use crate::sign::type_resolver::ChannelSignerType;
Expand DownExpand Up@@ -323,6 +326,7 @@ struct OutboundHTLCOutput {
	source: HTLCSource,
	blinding_point: Option<PublicKey>,
	skimmed_fee_msat: Option<u64>,
	timestamp: Option<Duration>,
}

/// See AwaitingRemoteRevoke ChannelState for more info
Expand DownExpand Up@@ -4933,7 +4937,7 @@ trait FailHTLCContents {
impl FailHTLCContents for msgs::OnionErrorPacket {
	type Message = msgs::UpdateFailHTLC;
	fn to_message(self, htlc_id: u64, channel_id: ChannelId) -> Self::Message {
 msgs::UpdateFailHTLC { htlc_id, channel_id, reason: self.data }
 msgs::UpdateFailHTLC { htlc_id, channel_id, reason: self.data, attribution_data: self.attribution_data }
	}
	fn to_inbound_htlc_state(self) -> InboundHTLCState {
 InboundHTLCState::LocalRemoved(InboundHTLCRemovalReason::FailRelay(self))
Expand DownExpand Up@@ -6100,10 +6104,16 @@ impl<SP: Deref> FundedChannel<SP> where
 false
 } else { true }
 });
 let now = duration_since_epoch();
 pending_outbound_htlcs.retain(|htlc| {
 if let &OutboundHTLCState::AwaitingRemovedRemoteRevoke(ref outcome) = &htlc.state {
 log_trace!(logger, " ...removing outbound AwaitingRemovedRemoteRevoke {}", &htlc.payment_hash);
 if let OutboundHTLCOutcome::Failure(reason) = outcome.clone() { // We really want take() here, but, again, non-mut ref :(
 if let OutboundHTLCOutcome::Failure(mut reason) = outcome.clone() { // We really want take() here, but, again, non-mut ref :(
 if let (Some(timestamp), Some(now)) = (htlc.timestamp, now) {
 let hold_time = u32::try_from((now - timestamp).as_millis()).unwrap_or(u32::MAX);
 reason.set_hold_time(hold_time);
 }

 revoked_htlcs.push((htlc.source.clone(), htlc.payment_hash, reason));
 } else {
 finalized_claimed_htlcs.push(htlc.source.clone());
Expand DownExpand Up@@ -6845,6 +6855,7 @@ impl<SP: Deref> FundedChannel<SP> where
 channel_id: self.context.channel_id(),
 htlc_id: htlc.htlc_id,
 reason: err_packet.data.clone(),
 attribution_data: err_packet.attribution_data,
 });
 },
 &InboundHTLCRemovalReason::FailMalformed((ref sha256_of_onion, ref failure_code)) => {
Expand DownExpand Up@@ -8671,6 +8682,7 @@ impl<SP: Deref> FundedChannel<SP> where
 return Ok(None);
 }

 let timestamp = duration_since_epoch();
 self.context.pending_outbound_htlcs.push(OutboundHTLCOutput {
 htlc_id: self.context.next_holder_htlc_id,
 amount_msat,
Expand All@@ -8680,6 +8692,7 @@ impl<SP: Deref> FundedChannel<SP> where
 source,
 blinding_point,
 skimmed_fee_msat,
 timestamp,
 });

 let res = msgs::UpdateAddHTLC {
Expand DownExpand Up@@ -10247,6 +10260,7 @@ impl<SP: Deref> Writeable for FundedChannel<SP> where SP::Target: SignerProvider
 dropped_inbound_htlcs += 1;
 }
 }
 let mut removed_htlc_failure_attribution_data: Vec<&Option<[u8; ATTRIBUTION_DATA_LEN]>> = Vec::new();
 (self.context.pending_inbound_htlcs.len() as u64 - dropped_inbound_htlcs).write(writer)?;
 for htlc in self.context.pending_inbound_htlcs.iter() {
 if let &InboundHTLCState::RemoteAnnounced(_) = &htlc.state {
Expand All@@ -10272,9 +10286,10 @@ impl<SP: Deref> Writeable for FundedChannel<SP> where SP::Target: SignerProvider
 &InboundHTLCState::LocalRemoved(ref removal_reason) => {
 4u8.write(writer)?;
 match removal_reason {
Comment thread
joostjager marked this conversation as resolved.

 InboundHTLCRemovalReason::FailRelay(msgs::OnionErrorPacket { data }) => {
 InboundHTLCRemovalReason::FailRelay(msgs::OnionErrorPacket { data, attribution_data }) => {
 0u8.write(writer)?;
 data.write(writer)?;
 removed_htlc_failure_attribution_data.push(&attribution_data);
 },
 InboundHTLCRemovalReason::FailMalformed((hash, code)) => {
 1u8.write(writer)?;
Expand DownExpand Up@@ -10336,10 +10351,11 @@ impl<SP: Deref> Writeable for FundedChannel<SP> where SP::Target: SignerProvider

 let mut holding_cell_skimmed_fees: Vec<Option<u64>> = Vec::new();
 let mut holding_cell_blinding_points: Vec<Option<PublicKey>> = Vec::new();
 let mut holding_cell_failure_attribution_data: Vec<(u32, [u8; ATTRIBUTION_DATA_LEN])> = Vec::new();
 // Vec of (htlc_id, failure_code, sha256_of_onion)
 let mut malformed_htlcs: Vec<(u64, u16, [u8; 32])> = Vec::new();
 (self.context.holding_cell_htlc_updates.len() as u64).write(writer)?;
 for update in self.context.holding_cell_htlc_updates.iter() {
 for (i, update) in self.context.holding_cell_htlc_updates.iter().enumerate() {
 match update {
 &HTLCUpdateAwaitingACK::AddHTLC {
 ref amount_msat, ref cltv_expiry, ref payment_hash, ref source, ref onion_routing_packet,
Expand All@@ -10364,6 +10380,13 @@ impl<SP: Deref> Writeable for FundedChannel<SP> where SP::Target: SignerProvider
 2u8.write(writer)?;
 htlc_id.write(writer)?;
 err_packet.data.write(writer)?;

 // Store the attribution data for later writing. Include the holding cell htlc update index because
 // FailMalformedHTLC is stored with the same type 2 and we wouldn't be able to distinguish the two
 // when reading back in.
 if let Some(attribution_data ) = err_packet.attribution_data {
 holding_cell_failure_attribution_data.push((i as u32, attribution_data));
 }
 }
 &HTLCUpdateAwaitingACK::FailMalformedHTLC {
 htlc_id, failure_code, sha256_of_onion
Expand DownExpand Up@@ -10547,6 +10570,8 @@ impl<SP: Deref> Writeable for FundedChannel<SP> where SP::Target: SignerProvider
 (49, self.context.local_initiated_shutdown, option), // Added in 0.0.122
 (51, is_manual_broadcast, option), // Added in 0.0.124
 (53, funding_tx_broadcast_safe_event_emitted, option), // Added in 0.0.124
 (55, removed_htlc_failure_attribution_data, optional_vec), // Added in 0.2
 (57, holding_cell_failure_attribution_data, optional_vec), // Added in 0.2
 });

 Ok(())
Expand DownExpand Up@@ -10624,6 +10649,7 @@ impl<'a, 'b, 'c, ES: Deref, SP: Deref> ReadableArgs<(&'a ES, &'b SP, &'c Channel
 let reason = match <u8 as Readable>::read(reader)? {
 0 => InboundHTLCRemovalReason::FailRelay(msgs::OnionErrorPacket {
@joostjagerjoostjagerFeb 27, 2025

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Update in holding cell, still waiting for next round of commitment dance. Should be tests that test holding cell persistence.
Strategy: break main, see if tests fail.
@joostjagerjoostjagerMar 3, 2025

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

expect_pending_htlcs_forwardable!(nodes[1]); - in here let node 0 do something else like add another htlc, so that the failure gets into the holding cell
 data: Readable::read(reader)?,
 attribution_data: None,
 }),
 1 => InboundHTLCRemovalReason::FailMalformed(Readable::read(reader)?),
 2 => InboundHTLCRemovalReason::Fulfill(Readable::read(reader)?),
Expand DownExpand Up@@ -10664,6 +10690,7 @@ impl<'a, 'b, 'c, ES: Deref, SP: Deref> ReadableArgs<(&'a ES, &'b SP, &'c Channel
 },
 skimmed_fee_msat: None,
 blinding_point: None,
 timestamp: None,
 });
 }

Expand All@@ -10688,6 +10715,7 @@ impl<'a, 'b, 'c, ES: Deref, SP: Deref> ReadableArgs<(&'a ES, &'b SP, &'c Channel
 htlc_id: Readable::read(reader)?,
 err_packet: OnionErrorPacket {
 data: Readable::read(reader)?,
 attribution_data: None,
 },
 },
 _ => return Err(DecodeError::InvalidValue),
Expand DownExpand Up@@ -10831,6 +10859,9 @@ impl<'a, 'b, 'c, ES: Deref, SP: Deref> ReadableArgs<(&'a ES, &'b SP, &'c Channel
 let mut pending_outbound_blinding_points_opt: Option<Vec<Option<PublicKey>>> = None;
 let mut holding_cell_blinding_points_opt: Option<Vec<Option<PublicKey>>> = None;

 let mut removed_htlc_failure_attribution_data: Option<Vec<Option<[u8; ATTRIBUTION_DATA_LEN]>>> = None;
 let mut holding_cell_failure_attribution_data: Option<Vec<(u32, [u8; ATTRIBUTION_DATA_LEN])>> = None;

 let mut malformed_htlcs: Option<Vec<(u64, u16, [u8; 32])>> = None;
 let mut monitor_pending_update_adds: Option<Vec<msgs::UpdateAddHTLC>> = None;

Expand DownExpand Up@@ -10873,6 +10904,8 @@ impl<'a, 'b, 'c, ES: Deref, SP: Deref> ReadableArgs<(&'a ES, &'b SP, &'c Channel
 (49, local_initiated_shutdown, option),
 (51, is_manual_broadcast, option),
 (53, funding_tx_broadcast_safe_event_emitted, option),
 (55, removed_htlc_failure_attribution_data, optional_vec),
 (57, holding_cell_failure_attribution_data, optional_vec),
 });

 let holder_signer = signer_provider.derive_channel_signer(channel_keys_id);
Expand DownExpand Up@@ -10954,6 +10987,38 @@ impl<'a, 'b, 'c, ES: Deref, SP: Deref> ReadableArgs<(&'a ES, &'b SP, &'c Channel
 if iter.next().is_some() { return Err(DecodeError::InvalidValue) }
 }

 if let Some(attribution_datas) = removed_htlc_failure_attribution_data {
 let mut removed_htlc_relay_failures =
 pending_inbound_htlcs.iter_mut().filter_map(|status|
 if let InboundHTLCState::LocalRemoved(ref mut reason) = &mut status.state {
 if let InboundHTLCRemovalReason::FailRelay(ref mut packet) = reason {
 Some(&mut packet.attribution_data)
 } else {
 None
 }
 } else {
 None
 }
 );

 for attribution_data in attribution_datas {
 *removed_htlc_relay_failures.next().ok_or(DecodeError::InvalidValue)? = attribution_data;
 }
 if removed_htlc_relay_failures.next().is_some() { return Err(DecodeError::InvalidValue); }
 }

 if let Some(attribution_datas) = holding_cell_failure_attribution_data {
 for (i, attribution_data) in attribution_datas {
 let update = holding_cell_htlc_updates.get_mut(i as usize).ok_or(DecodeError::InvalidValue)?;

 if let HTLCUpdateAwaitingACK::FailHTLC { htlc_id: _, ref mut err_packet } = update {
 err_packet.attribution_data = Some(attribution_data);
 } else {
 return Err(DecodeError::InvalidValue);
 }
 }
 }

 if let Some(malformed_htlcs) = malformed_htlcs {
 for (malformed_htlc_id, failure_code, sha256_of_onion) in malformed_htlcs {
 let htlc_idx = holding_cell_htlc_updates.iter().position(|htlc| {
Expand DownExpand Up@@ -11144,6 +11209,18 @@ impl<'a, 'b, 'c, ES: Deref, SP: Deref> ReadableArgs<(&'a ES, &'b SP, &'c Channel
	}
}

fn duration_since_epoch() -> Option<Duration> {
	#[cfg(not(feature = "std"))]
	let now = None;

	#[cfg(feature = "std")]
	let now = Some(std::time::SystemTime::now()
 .duration_since(std::time::SystemTime::UNIX_EPOCH)
 .expect("SystemTime::now() should come after SystemTime::UNIX_EPOCH"));

	now
}

#[cfg(test)]
mod tests {
	use std::cmp;
Expand All@@ -11157,7 +11234,7 @@ mod tests {
	use bitcoin::network::Network;
	#[cfg(splicing)]
	use bitcoin::Weight;
	use crate::ln::onion_utils::INVALID_ONION_BLINDING;
	use crate::ln::onion_utils::{ATTRIBUTION_DATA_LEN, INVALID_ONION_BLINDING};
	use crate::types::payment::{PaymentHash, PaymentPreimage};
	use crate::ln::channel_keys::{RevocationKey, RevocationBasepoint};
	use crate::ln::channelmanager::{self, HTLCSource, PaymentId};
Expand DownExpand Up@@ -11378,6 +11455,7 @@ mod tests {
 },
 skimmed_fee_msat: None,
 blinding_point: None,
 timestamp: None,
 });

 // Make sure when Node A calculates their local commitment transaction, none of the HTLCs pass
Expand DownExpand Up@@ -11762,6 +11840,7 @@ mod tests {
 source: dummy_htlc_source.clone(),
 skimmed_fee_msat: None,
 blinding_point: None,
 timestamp: None,
 };
 let mut pending_outbound_htlcs = vec![dummy_outbound_output.clone(); 10];
 for (idx, htlc) in pending_outbound_htlcs.iter_mut().enumerate() {
Expand DownExpand Up@@ -11793,7 +11872,7 @@ mod tests {
 htlc_id: 0,
 };
 let dummy_holding_cell_failed_htlc = |htlc_id| HTLCUpdateAwaitingACK::FailHTLC {
 htlc_id, err_packet: msgs::OnionErrorPacket { data: vec![42] }
 htlc_id, err_packet: msgs::OnionErrorPacket { data: vec![42], attribution_data: Some([1; ATTRIBUTION_DATA_LEN]) }
 };
 let dummy_holding_cell_malformed_htlc = |htlc_id| HTLCUpdateAwaitingACK::FailMalformedHTLC {
 htlc_id, failure_code: INVALID_ONION_BLINDING, sha256_of_onion: [0; 32],
Expand Down
Loading

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

Skip to content
Attributable errors 2025#3611

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

 Closed

joostjager
wants to merge
2
commits into

from

 Closed


Attributable errors 2025
#3611
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
d282ea8

Attributable failures


joostjager Mar 5, 2025
e7923e9

Attributable failures optional feature bit


joostjager Mar 10, 2025

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


8 changes: 7 additions & 1 deletion
lightning-invoice/src/lib.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -597,12 +597,18 @@ impl InvoiceBuilder<tb::False, tb::False, tb::False, tb::False, tb::False, tb::F
	/// Construct new, empty `InvoiceBuilder`. All necessary fields have to be filled first before
	/// `InvoiceBuilder::build(self)` becomes available.
	pub fn new(currency: Currency) -> Self {
 let mut features = Bolt11InvoiceFeatures::empty();
 features.set_attributable_failures_optional();

 let mut tagged_fields = Vec::with_capacity(8);
 tagged_fields.push(TaggedField::Features(features));

 InvoiceBuilder {
 currency,
 amount: None,
 si_prefix: None,
 timestamp: None,
 tagged_fields: Vec::with_capacity(8),
 tagged_fields,
 error: None,

 phantom_d: core::marker::PhantomData,
Expand Down

18 changes: 14 additions & 4 deletions
lightning-types/src/features.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -154,7 +154,7 @@ mod sealed {
 // Byte 3
 RouteBlinding | ShutdownAnySegwit | DualFund | Taproot,
 // Byte 4
 Quiescence | OnionMessages,
 Quiescence | OnionMessages | AttributableFailures,
 // Byte 5
 ProvideStorage | ChannelType | SCIDPrivacy,
 // Byte 6
Expand All@@ -175,7 +175,7 @@ mod sealed {
 // Byte 3
 RouteBlinding | ShutdownAnySegwit | DualFund | Taproot,
 // Byte 4
 Quiescence | OnionMessages,
 Quiescence | OnionMessages | AttributableFailures,
 // Byte 5
 ProvideStorage | ChannelType | SCIDPrivacy,
 // Byte 6
Expand All@@ -199,7 +199,7 @@ mod sealed {
 // Byte 3
 ,
 // Byte 4
 ,
AttributableFailures,
 // Byte 5
 ,
 // Byte 6
Expand All@@ -219,7 +219,7 @@ mod sealed {
 // Byte 3
 ,
 // Byte 4
 ,
AttributableFailures,
 // Byte 5
 ,
 // Byte 6
Expand DownExpand Up@@ -548,6 +548,16 @@ mod sealed {
 supports_quiescence,
 requires_quiescence
	);
	define_feature!(
 37,
 AttributableFailures,
 [InitContext, NodeContext, Bolt11InvoiceContext, Bolt12InvoiceContext],
 "Feature flags for `option_attributable_failures`.",
 set_attributable_failures_optional,
 set_attributable_failures_required,
 supports_attributable_failures,
 requires_attributable_failures
	);
	define_feature!(
 39,
 OnionMessages,
Expand Down

93 changes: 86 additions & 7 deletions
lightning/src/ln/channel.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -50,7 +50,7 @@ use crate::ln::chan_utils::{
#[cfg(splicing)]
use crate::ln::chan_utils::FUNDING_TRANSACTION_WITNESS_WEIGHT;
use crate::ln::chan_utils;
use crate::ln::onion_utils::{HTLCFailReason};
use crate::ln::onion_utils::{HTLCFailReason, ATTRIBUTION_DATA_LEN};
use crate::chain::BestBlock;
use crate::chain::chaininterface::{FeeEstimator, ConfirmationTarget, LowerBoundedFeeEstimator, fee_for_weight};
use crate::chain::channelmonitor::{ChannelMonitor, ChannelMonitorUpdate, ChannelMonitorUpdateStep, LATENCY_GRACE_PERIOD_BLOCKS};
Expand All@@ -68,8 +68,11 @@ use crate::util::scid_utils::scid_from_parts;

use crate::io;
use crate::prelude::*;
use core::time::Duration;
use core::{cmp,mem,fmt};
use core::ops::Deref;
#[cfg(feature = "std")]
use std::time::SystemTime;
#[cfg(any(test, fuzzing, debug_assertions))]
use crate::sync::Mutex;
use crate::sign::type_resolver::ChannelSignerType;
Expand DownExpand Up@@ -323,6 +326,7 @@ struct OutboundHTLCOutput {
	source: HTLCSource,
	blinding_point: Option<PublicKey>,
	skimmed_fee_msat: Option<u64>,
	timestamp: Option<Duration>,
}

/// See AwaitingRemoteRevoke ChannelState for more info
Expand DownExpand Up@@ -4933,7 +4937,7 @@ trait FailHTLCContents {
impl FailHTLCContents for msgs::OnionErrorPacket {
	type Message = msgs::UpdateFailHTLC;
	fn to_message(self, htlc_id: u64, channel_id: ChannelId) -> Self::Message {
 msgs::UpdateFailHTLC { htlc_id, channel_id, reason: self.data }
 msgs::UpdateFailHTLC { htlc_id, channel_id, reason: self.data, attribution_data: self.attribution_data }
	}
	fn to_inbound_htlc_state(self) -> InboundHTLCState {
 InboundHTLCState::LocalRemoved(InboundHTLCRemovalReason::FailRelay(self))
Expand DownExpand Up@@ -6100,10 +6104,16 @@ impl<SP: Deref> FundedChannel<SP> where
 false
 } else { true }
 });
 let now = duration_since_epoch();
 pending_outbound_htlcs.retain(|htlc| {
 if let &OutboundHTLCState::AwaitingRemovedRemoteRevoke(ref outcome) = &htlc.state {
 log_trace!(logger, " ...removing outbound AwaitingRemovedRemoteRevoke {}", &htlc.payment_hash);
 if let OutboundHTLCOutcome::Failure(reason) = outcome.clone() { // We really want take() here, but, again, non-mut ref :(
 if let OutboundHTLCOutcome::Failure(mut reason) = outcome.clone() { // We really want take() here, but, again, non-mut ref :(
 if let (Some(timestamp), Some(now)) = (htlc.timestamp, now) {
 let hold_time = u32::try_from((now - timestamp).as_millis()).unwrap_or(u32::MAX);
 reason.set_hold_time(hold_time);
 }

 revoked_htlcs.push((htlc.source.clone(), htlc.payment_hash, reason));
 } else {
 finalized_claimed_htlcs.push(htlc.source.clone());
Expand DownExpand Up@@ -6845,6 +6855,7 @@ impl<SP: Deref> FundedChannel<SP> where
 channel_id: self.context.channel_id(),
 htlc_id: htlc.htlc_id,
 reason: err_packet.data.clone(),
 attribution_data: err_packet.attribution_data,
 });
 },
 &InboundHTLCRemovalReason::FailMalformed((ref sha256_of_onion, ref failure_code)) => {
Expand DownExpand Up@@ -8671,6 +8682,7 @@ impl<SP: Deref> FundedChannel<SP> where
 return Ok(None);
 }

 let timestamp = duration_since_epoch();
 self.context.pending_outbound_htlcs.push(OutboundHTLCOutput {
 htlc_id: self.context.next_holder_htlc_id,
 amount_msat,
Expand All@@ -8680,6 +8692,7 @@ impl<SP: Deref> FundedChannel<SP> where
 source,
 blinding_point,
 skimmed_fee_msat,
 timestamp,
 });

 let res = msgs::UpdateAddHTLC {
Expand DownExpand Up@@ -10247,6 +10260,7 @@ impl<SP: Deref> Writeable for FundedChannel<SP> where SP::Target: SignerProvider
 dropped_inbound_htlcs += 1;
 }
 }
 let mut removed_htlc_failure_attribution_data: Vec<&Option<[u8; ATTRIBUTION_DATA_LEN]>> = Vec::new();
 (self.context.pending_inbound_htlcs.len() as u64 - dropped_inbound_htlcs).write(writer)?;
 for htlc in self.context.pending_inbound_htlcs.iter() {
 if let &InboundHTLCState::RemoteAnnounced(_) = &htlc.state {
Expand All@@ -10272,9 +10286,10 @@ impl<SP: Deref> Writeable for FundedChannel<SP> where SP::Target: SignerProvider
 &InboundHTLCState::LocalRemoved(ref removal_reason) => {
 4u8.write(writer)?;
 match removal_reason {
Comment thread
joostjager marked this conversation as resolved.

 InboundHTLCRemovalReason::FailRelay(msgs::OnionErrorPacket { data }) => {
 InboundHTLCRemovalReason::FailRelay(msgs::OnionErrorPacket { data, attribution_data }) => {
 0u8.write(writer)?;
 data.write(writer)?;
 removed_htlc_failure_attribution_data.push(&attribution_data);
 },
 InboundHTLCRemovalReason::FailMalformed((hash, code)) => {
 1u8.write(writer)?;
Expand DownExpand Up@@ -10336,10 +10351,11 @@ impl<SP: Deref> Writeable for FundedChannel<SP> where SP::Target: SignerProvider

 let mut holding_cell_skimmed_fees: Vec<Option<u64>> = Vec::new();
 let mut holding_cell_blinding_points: Vec<Option<PublicKey>> = Vec::new();
 let mut holding_cell_failure_attribution_data: Vec<(u32, [u8; ATTRIBUTION_DATA_LEN])> = Vec::new();
 // Vec of (htlc_id, failure_code, sha256_of_onion)
 let mut malformed_htlcs: Vec<(u64, u16, [u8; 32])> = Vec::new();
 (self.context.holding_cell_htlc_updates.len() as u64).write(writer)?;
 for update in self.context.holding_cell_htlc_updates.iter() {
 for (i, update) in self.context.holding_cell_htlc_updates.iter().enumerate() {
 match update {
 &HTLCUpdateAwaitingACK::AddHTLC {
 ref amount_msat, ref cltv_expiry, ref payment_hash, ref source, ref onion_routing_packet,
Expand All@@ -10364,6 +10380,13 @@ impl<SP: Deref> Writeable for FundedChannel<SP> where SP::Target: SignerProvider
 2u8.write(writer)?;
 htlc_id.write(writer)?;
 err_packet.data.write(writer)?;

 // Store the attribution data for later writing. Include the holding cell htlc update index because
 // FailMalformedHTLC is stored with the same type 2 and we wouldn't be able to distinguish the two
 // when reading back in.
 if let Some(attribution_data ) = err_packet.attribution_data {
 holding_cell_failure_attribution_data.push((i as u32, attribution_data));
 }
 }
 &HTLCUpdateAwaitingACK::FailMalformedHTLC {
 htlc_id, failure_code, sha256_of_onion
Expand DownExpand Up@@ -10547,6 +10570,8 @@ impl<SP: Deref> Writeable for FundedChannel<SP> where SP::Target: SignerProvider
 (49, self.context.local_initiated_shutdown, option), // Added in 0.0.122
 (51, is_manual_broadcast, option), // Added in 0.0.124
 (53, funding_tx_broadcast_safe_event_emitted, option), // Added in 0.0.124
 (55, removed_htlc_failure_attribution_data, optional_vec), // Added in 0.2
 (57, holding_cell_failure_attribution_data, optional_vec), // Added in 0.2
 });

 Ok(())
Expand DownExpand Up@@ -10624,6 +10649,7 @@ impl<'a, 'b, 'c, ES: Deref, SP: Deref> ReadableArgs<(&'a ES, &'b SP, &'c Channel
 let reason = match <u8 as Readable>::read(reader)? {
 0 => InboundHTLCRemovalReason::FailRelay(msgs::OnionErrorPacket {
@joostjagerjoostjagerFeb 27, 2025

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Update in holding cell, still waiting for next round of commitment dance. Should be tests that test holding cell persistence.
Strategy: break main, see if tests fail.
@joostjagerjoostjagerMar 3, 2025

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

expect_pending_htlcs_forwardable!(nodes[1]); - in here let node 0 do something else like add another htlc, so that the failure gets into the holding cell
 data: Readable::read(reader)?,
 attribution_data: None,
 }),
 1 => InboundHTLCRemovalReason::FailMalformed(Readable::read(reader)?),
 2 => InboundHTLCRemovalReason::Fulfill(Readable::read(reader)?),
Expand DownExpand Up@@ -10664,6 +10690,7 @@ impl<'a, 'b, 'c, ES: Deref, SP: Deref> ReadableArgs<(&'a ES, &'b SP, &'c Channel
 },
 skimmed_fee_msat: None,
 blinding_point: None,
 timestamp: None,
 });
 }

Expand All@@ -10688,6 +10715,7 @@ impl<'a, 'b, 'c, ES: Deref, SP: Deref> ReadableArgs<(&'a ES, &'b SP, &'c Channel
 htlc_id: Readable::read(reader)?,
 err_packet: OnionErrorPacket {
 data: Readable::read(reader)?,
 attribution_data: None,
 },
 },
 _ => return Err(DecodeError::InvalidValue),
Expand DownExpand Up@@ -10831,6 +10859,9 @@ impl<'a, 'b, 'c, ES: Deref, SP: Deref> ReadableArgs<(&'a ES, &'b SP, &'c Channel
 let mut pending_outbound_blinding_points_opt: Option<Vec<Option<PublicKey>>> = None;
 let mut holding_cell_blinding_points_opt: Option<Vec<Option<PublicKey>>> = None;

 let mut removed_htlc_failure_attribution_data: Option<Vec<Option<[u8; ATTRIBUTION_DATA_LEN]>>> = None;
 let mut holding_cell_failure_attribution_data: Option<Vec<(u32, [u8; ATTRIBUTION_DATA_LEN])>> = None;

 let mut malformed_htlcs: Option<Vec<(u64, u16, [u8; 32])>> = None;
 let mut monitor_pending_update_adds: Option<Vec<msgs::UpdateAddHTLC>> = None;

Expand DownExpand Up@@ -10873,6 +10904,8 @@ impl<'a, 'b, 'c, ES: Deref, SP: Deref> ReadableArgs<(&'a ES, &'b SP, &'c Channel
 (49, local_initiated_shutdown, option),
 (51, is_manual_broadcast, option),
 (53, funding_tx_broadcast_safe_event_emitted, option),
 (55, removed_htlc_failure_attribution_data, optional_vec),
 (57, holding_cell_failure_attribution_data, optional_vec),
 });

 let holder_signer = signer_provider.derive_channel_signer(channel_keys_id);
Expand DownExpand Up@@ -10954,6 +10987,38 @@ impl<'a, 'b, 'c, ES: Deref, SP: Deref> ReadableArgs<(&'a ES, &'b SP, &'c Channel
 if iter.next().is_some() { return Err(DecodeError::InvalidValue) }
 }

 if let Some(attribution_datas) = removed_htlc_failure_attribution_data {
 let mut removed_htlc_relay_failures =
 pending_inbound_htlcs.iter_mut().filter_map(|status|
 if let InboundHTLCState::LocalRemoved(ref mut reason) = &mut status.state {
 if let InboundHTLCRemovalReason::FailRelay(ref mut packet) = reason {
 Some(&mut packet.attribution_data)
 } else {
 None
 }
 } else {
 None
 }
 );

 for attribution_data in attribution_datas {
 *removed_htlc_relay_failures.next().ok_or(DecodeError::InvalidValue)? = attribution_data;
 }
 if removed_htlc_relay_failures.next().is_some() { return Err(DecodeError::InvalidValue); }
 }

 if let Some(attribution_datas) = holding_cell_failure_attribution_data {
 for (i, attribution_data) in attribution_datas {
 let update = holding_cell_htlc_updates.get_mut(i as usize).ok_or(DecodeError::InvalidValue)?;

 if let HTLCUpdateAwaitingACK::FailHTLC { htlc_id: _, ref mut err_packet } = update {
 err_packet.attribution_data = Some(attribution_data);
 } else {
 return Err(DecodeError::InvalidValue);
 }
 }
 }

 if let Some(malformed_htlcs) = malformed_htlcs {
 for (malformed_htlc_id, failure_code, sha256_of_onion) in malformed_htlcs {
 let htlc_idx = holding_cell_htlc_updates.iter().position(|htlc| {
Expand DownExpand Up@@ -11144,6 +11209,18 @@ impl<'a, 'b, 'c, ES: Deref, SP: Deref> ReadableArgs<(&'a ES, &'b SP, &'c Channel
	}
}

fn duration_since_epoch() -> Option<Duration> {
	#[cfg(not(feature = "std"))]
	let now = None;

	#[cfg(feature = "std")]
	let now = Some(std::time::SystemTime::now()
 .duration_since(std::time::SystemTime::UNIX_EPOCH)
 .expect("SystemTime::now() should come after SystemTime::UNIX_EPOCH"));

	now
}

#[cfg(test)]
mod tests {
	use std::cmp;
Expand All@@ -11157,7 +11234,7 @@ mod tests {
	use bitcoin::network::Network;
	#[cfg(splicing)]
	use bitcoin::Weight;
	use crate::ln::onion_utils::INVALID_ONION_BLINDING;
	use crate::ln::onion_utils::{ATTRIBUTION_DATA_LEN, INVALID_ONION_BLINDING};
	use crate::types::payment::{PaymentHash, PaymentPreimage};
	use crate::ln::channel_keys::{RevocationKey, RevocationBasepoint};
	use crate::ln::channelmanager::{self, HTLCSource, PaymentId};
Expand DownExpand Up@@ -11378,6 +11455,7 @@ mod tests {
 },
 skimmed_fee_msat: None,
 blinding_point: None,
 timestamp: None,
 });

 // Make sure when Node A calculates their local commitment transaction, none of the HTLCs pass
Expand DownExpand Up@@ -11762,6 +11840,7 @@ mod tests {
 source: dummy_htlc_source.clone(),
 skimmed_fee_msat: None,
 blinding_point: None,
 timestamp: None,
 };
 let mut pending_outbound_htlcs = vec![dummy_outbound_output.clone(); 10];
 for (idx, htlc) in pending_outbound_htlcs.iter_mut().enumerate() {
Expand DownExpand Up@@ -11793,7 +11872,7 @@ mod tests {
 htlc_id: 0,
 };
 let dummy_holding_cell_failed_htlc = |htlc_id| HTLCUpdateAwaitingACK::FailHTLC {
 htlc_id, err_packet: msgs::OnionErrorPacket { data: vec![42] }
 htlc_id, err_packet: msgs::OnionErrorPacket { data: vec![42], attribution_data: Some([1; ATTRIBUTION_DATA_LEN]) }
 };
 let dummy_holding_cell_malformed_htlc = |htlc_id| HTLCUpdateAwaitingACK::FailMalformedHTLC {
 htlc_id, failure_code: INVALID_ONION_BLINDING, sha256_of_onion: [0; 32],
Expand Down
Loading

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

Skip to content
Attributable errors 2025#3611

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

 Closed

joostjager
wants to merge
2
commits into

from

 Closed


Attributable errors 2025
#3611
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
d282ea8

Attributable failures


joostjager Mar 5, 2025
e7923e9

Attributable failures optional feature bit


joostjager Mar 10, 2025

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


8 changes: 7 additions & 1 deletion
lightning-invoice/src/lib.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -597,12 +597,18 @@ impl InvoiceBuilder<tb::False, tb::False, tb::False, tb::False, tb::False, tb::F
	/// Construct new, empty `InvoiceBuilder`. All necessary fields have to be filled first before
	/// `InvoiceBuilder::build(self)` becomes available.
	pub fn new(currency: Currency) -> Self {
 let mut features = Bolt11InvoiceFeatures::empty();
 features.set_attributable_failures_optional();

 let mut tagged_fields = Vec::with_capacity(8);
 tagged_fields.push(TaggedField::Features(features));

 InvoiceBuilder {
 currency,
 amount: None,
 si_prefix: None,
 timestamp: None,
 tagged_fields: Vec::with_capacity(8),
 tagged_fields,
 error: None,

 phantom_d: core::marker::PhantomData,
Expand Down

18 changes: 14 additions & 4 deletions
lightning-types/src/features.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -154,7 +154,7 @@ mod sealed {
 // Byte 3
 RouteBlinding | ShutdownAnySegwit | DualFund | Taproot,
 // Byte 4
 Quiescence | OnionMessages,
 Quiescence | OnionMessages | AttributableFailures,
 // Byte 5
 ProvideStorage | ChannelType | SCIDPrivacy,
 // Byte 6
Expand All@@ -175,7 +175,7 @@ mod sealed {
 // Byte 3
 RouteBlinding | ShutdownAnySegwit | DualFund | Taproot,
 // Byte 4
 Quiescence | OnionMessages,
 Quiescence | OnionMessages | AttributableFailures,
 // Byte 5
 ProvideStorage | ChannelType | SCIDPrivacy,
 // Byte 6
Expand All@@ -199,7 +199,7 @@ mod sealed {
 // Byte 3
 ,
 // Byte 4
 ,
AttributableFailures,
 // Byte 5
 ,
 // Byte 6
Expand All@@ -219,7 +219,7 @@ mod sealed {
 // Byte 3
 ,
 // Byte 4
 ,
AttributableFailures,
 // Byte 5
 ,
 // Byte 6
Expand DownExpand Up@@ -548,6 +548,16 @@ mod sealed {
 supports_quiescence,
 requires_quiescence
	);
	define_feature!(
 37,
 AttributableFailures,
 [InitContext, NodeContext, Bolt11InvoiceContext, Bolt12InvoiceContext],
 "Feature flags for `option_attributable_failures`.",
 set_attributable_failures_optional,
 set_attributable_failures_required,
 supports_attributable_failures,
 requires_attributable_failures
	);
	define_feature!(
 39,
 OnionMessages,
Expand Down

93 changes: 86 additions & 7 deletions
lightning/src/ln/channel.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -50,7 +50,7 @@ use crate::ln::chan_utils::{
#[cfg(splicing)]
use crate::ln::chan_utils::FUNDING_TRANSACTION_WITNESS_WEIGHT;
use crate::ln::chan_utils;
use crate::ln::onion_utils::{HTLCFailReason};
use crate::ln::onion_utils::{HTLCFailReason, ATTRIBUTION_DATA_LEN};
use crate::chain::BestBlock;
use crate::chain::chaininterface::{FeeEstimator, ConfirmationTarget, LowerBoundedFeeEstimator, fee_for_weight};
use crate::chain::channelmonitor::{ChannelMonitor, ChannelMonitorUpdate, ChannelMonitorUpdateStep, LATENCY_GRACE_PERIOD_BLOCKS};
Expand All@@ -68,8 +68,11 @@ use crate::util::scid_utils::scid_from_parts;

use crate::io;
use crate::prelude::*;
use core::time::Duration;
use core::{cmp,mem,fmt};
use core::ops::Deref;
#[cfg(feature = "std")]
use std::time::SystemTime;
#[cfg(any(test, fuzzing, debug_assertions))]
use crate::sync::Mutex;
use crate::sign::type_resolver::ChannelSignerType;
Expand DownExpand Up@@ -323,6 +326,7 @@ struct OutboundHTLCOutput {
	source: HTLCSource,
	blinding_point: Option<PublicKey>,
	skimmed_fee_msat: Option<u64>,
	timestamp: Option<Duration>,
}

/// See AwaitingRemoteRevoke ChannelState for more info
Expand DownExpand Up@@ -4933,7 +4937,7 @@ trait FailHTLCContents {
impl FailHTLCContents for msgs::OnionErrorPacket {
	type Message = msgs::UpdateFailHTLC;
	fn to_message(self, htlc_id: u64, channel_id: ChannelId) -> Self::Message {
 msgs::UpdateFailHTLC { htlc_id, channel_id, reason: self.data }
 msgs::UpdateFailHTLC { htlc_id, channel_id, reason: self.data, attribution_data: self.attribution_data }
	}
	fn to_inbound_htlc_state(self) -> InboundHTLCState {
 InboundHTLCState::LocalRemoved(InboundHTLCRemovalReason::FailRelay(self))
Expand DownExpand Up@@ -6100,10 +6104,16 @@ impl<SP: Deref> FundedChannel<SP> where
 false
 } else { true }
 });
 let now = duration_since_epoch();
 pending_outbound_htlcs.retain(|htlc| {
 if let &OutboundHTLCState::AwaitingRemovedRemoteRevoke(ref outcome) = &htlc.state {
 log_trace!(logger, " ...removing outbound AwaitingRemovedRemoteRevoke {}", &htlc.payment_hash);
 if let OutboundHTLCOutcome::Failure(reason) = outcome.clone() { // We really want take() here, but, again, non-mut ref :(
 if let OutboundHTLCOutcome::Failure(mut reason) = outcome.clone() { // We really want take() here, but, again, non-mut ref :(
 if let (Some(timestamp), Some(now)) = (htlc.timestamp, now) {
 let hold_time = u32::try_from((now - timestamp).as_millis()).unwrap_or(u32::MAX);
 reason.set_hold_time(hold_time);
 }

 revoked_htlcs.push((htlc.source.clone(), htlc.payment_hash, reason));
 } else {
 finalized_claimed_htlcs.push(htlc.source.clone());
Expand DownExpand Up@@ -6845,6 +6855,7 @@ impl<SP: Deref> FundedChannel<SP> where
 channel_id: self.context.channel_id(),
 htlc_id: htlc.htlc_id,
 reason: err_packet.data.clone(),
 attribution_data: err_packet.attribution_data,
 });
 },
 &InboundHTLCRemovalReason::FailMalformed((ref sha256_of_onion, ref failure_code)) => {
Expand DownExpand Up@@ -8671,6 +8682,7 @@ impl<SP: Deref> FundedChannel<SP> where
 return Ok(None);
 }

 let timestamp = duration_since_epoch();
 self.context.pending_outbound_htlcs.push(OutboundHTLCOutput {
 htlc_id: self.context.next_holder_htlc_id,
 amount_msat,
Expand All@@ -8680,6 +8692,7 @@ impl<SP: Deref> FundedChannel<SP> where
 source,
 blinding_point,
 skimmed_fee_msat,
 timestamp,
 });

 let res = msgs::UpdateAddHTLC {
Expand DownExpand Up@@ -10247,6 +10260,7 @@ impl<SP: Deref> Writeable for FundedChannel<SP> where SP::Target: SignerProvider
 dropped_inbound_htlcs += 1;
 }
 }
 let mut removed_htlc_failure_attribution_data: Vec<&Option<[u8; ATTRIBUTION_DATA_LEN]>> = Vec::new();
 (self.context.pending_inbound_htlcs.len() as u64 - dropped_inbound_htlcs).write(writer)?;
 for htlc in self.context.pending_inbound_htlcs.iter() {
 if let &InboundHTLCState::RemoteAnnounced(_) = &htlc.state {
Expand All@@ -10272,9 +10286,10 @@ impl<SP: Deref> Writeable for FundedChannel<SP> where SP::Target: SignerProvider
 &InboundHTLCState::LocalRemoved(ref removal_reason) => {
 4u8.write(writer)?;
 match removal_reason {
Comment thread
joostjager marked this conversation as resolved.

 InboundHTLCRemovalReason::FailRelay(msgs::OnionErrorPacket { data }) => {
 InboundHTLCRemovalReason::FailRelay(msgs::OnionErrorPacket { data, attribution_data }) => {
 0u8.write(writer)?;
 data.write(writer)?;
 removed_htlc_failure_attribution_data.push(&attribution_data);
 },
 InboundHTLCRemovalReason::FailMalformed((hash, code)) => {
 1u8.write(writer)?;
Expand DownExpand Up@@ -10336,10 +10351,11 @@ impl<SP: Deref> Writeable for FundedChannel<SP> where SP::Target: SignerProvider

 let mut holding_cell_skimmed_fees: Vec<Option<u64>> = Vec::new();
 let mut holding_cell_blinding_points: Vec<Option<PublicKey>> = Vec::new();
 let mut holding_cell_failure_attribution_data: Vec<(u32, [u8; ATTRIBUTION_DATA_LEN])> = Vec::new();
 // Vec of (htlc_id, failure_code, sha256_of_onion)
 let mut malformed_htlcs: Vec<(u64, u16, [u8; 32])> = Vec::new();
 (self.context.holding_cell_htlc_updates.len() as u64).write(writer)?;
 for update in self.context.holding_cell_htlc_updates.iter() {
 for (i, update) in self.context.holding_cell_htlc_updates.iter().enumerate() {
 match update {
 &HTLCUpdateAwaitingACK::AddHTLC {
 ref amount_msat, ref cltv_expiry, ref payment_hash, ref source, ref onion_routing_packet,
Expand All@@ -10364,6 +10380,13 @@ impl<SP: Deref> Writeable for FundedChannel<SP> where SP::Target: SignerProvider
 2u8.write(writer)?;
 htlc_id.write(writer)?;
 err_packet.data.write(writer)?;

 // Store the attribution data for later writing. Include the holding cell htlc update index because
 // FailMalformedHTLC is stored with the same type 2 and we wouldn't be able to distinguish the two
 // when reading back in.
 if let Some(attribution_data ) = err_packet.attribution_data {
 holding_cell_failure_attribution_data.push((i as u32, attribution_data));
 }
 }
 &HTLCUpdateAwaitingACK::FailMalformedHTLC {
 htlc_id, failure_code, sha256_of_onion
Expand DownExpand Up@@ -10547,6 +10570,8 @@ impl<SP: Deref> Writeable for FundedChannel<SP> where SP::Target: SignerProvider
 (49, self.context.local_initiated_shutdown, option), // Added in 0.0.122
 (51, is_manual_broadcast, option), // Added in 0.0.124
 (53, funding_tx_broadcast_safe_event_emitted, option), // Added in 0.0.124
 (55, removed_htlc_failure_attribution_data, optional_vec), // Added in 0.2
 (57, holding_cell_failure_attribution_data, optional_vec), // Added in 0.2
 });

 Ok(())
Expand DownExpand Up@@ -10624,6 +10649,7 @@ impl<'a, 'b, 'c, ES: Deref, SP: Deref> ReadableArgs<(&'a ES, &'b SP, &'c Channel
 let reason = match <u8 as Readable>::read(reader)? {
 0 => InboundHTLCRemovalReason::FailRelay(msgs::OnionErrorPacket {
@joostjagerjoostjagerFeb 27, 2025

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Update in holding cell, still waiting for next round of commitment dance. Should be tests that test holding cell persistence.
Strategy: break main, see if tests fail.
@joostjagerjoostjagerMar 3, 2025

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

expect_pending_htlcs_forwardable!(nodes[1]); - in here let node 0 do something else like add another htlc, so that the failure gets into the holding cell
 data: Readable::read(reader)?,
 attribution_data: None,
 }),
 1 => InboundHTLCRemovalReason::FailMalformed(Readable::read(reader)?),
 2 => InboundHTLCRemovalReason::Fulfill(Readable::read(reader)?),
Expand DownExpand Up@@ -10664,6 +10690,7 @@ impl<'a, 'b, 'c, ES: Deref, SP: Deref> ReadableArgs<(&'a ES, &'b SP, &'c Channel
 },
 skimmed_fee_msat: None,
 blinding_point: None,
 timestamp: None,
 });
 }

Expand All@@ -10688,6 +10715,7 @@ impl<'a, 'b, 'c, ES: Deref, SP: Deref> ReadableArgs<(&'a ES, &'b SP, &'c Channel
 htlc_id: Readable::read(reader)?,
 err_packet: OnionErrorPacket {
 data: Readable::read(reader)?,
 attribution_data: None,
 },
 },
 _ => return Err(DecodeError::InvalidValue),
Expand DownExpand Up@@ -10831,6 +10859,9 @@ impl<'a, 'b, 'c, ES: Deref, SP: Deref> ReadableArgs<(&'a ES, &'b SP, &'c Channel
 let mut pending_outbound_blinding_points_opt: Option<Vec<Option<PublicKey>>> = None;
 let mut holding_cell_blinding_points_opt: Option<Vec<Option<PublicKey>>> = None;

 let mut removed_htlc_failure_attribution_data: Option<Vec<Option<[u8; ATTRIBUTION_DATA_LEN]>>> = None;
 let mut holding_cell_failure_attribution_data: Option<Vec<(u32, [u8; ATTRIBUTION_DATA_LEN])>> = None;

 let mut malformed_htlcs: Option<Vec<(u64, u16, [u8; 32])>> = None;
 let mut monitor_pending_update_adds: Option<Vec<msgs::UpdateAddHTLC>> = None;

Expand DownExpand Up@@ -10873,6 +10904,8 @@ impl<'a, 'b, 'c, ES: Deref, SP: Deref> ReadableArgs<(&'a ES, &'b SP, &'c Channel
 (49, local_initiated_shutdown, option),
 (51, is_manual_broadcast, option),
 (53, funding_tx_broadcast_safe_event_emitted, option),
 (55, removed_htlc_failure_attribution_data, optional_vec),
 (57, holding_cell_failure_attribution_data, optional_vec),
 });

 let holder_signer = signer_provider.derive_channel_signer(channel_keys_id);
Expand DownExpand Up@@ -10954,6 +10987,38 @@ impl<'a, 'b, 'c, ES: Deref, SP: Deref> ReadableArgs<(&'a ES, &'b SP, &'c Channel
 if iter.next().is_some() { return Err(DecodeError::InvalidValue) }
 }

 if let Some(attribution_datas) = removed_htlc_failure_attribution_data {
 let mut removed_htlc_relay_failures =
 pending_inbound_htlcs.iter_mut().filter_map(|status|
 if let InboundHTLCState::LocalRemoved(ref mut reason) = &mut status.state {
 if let InboundHTLCRemovalReason::FailRelay(ref mut packet) = reason {
 Some(&mut packet.attribution_data)
 } else {
 None
 }
 } else {
 None
 }
 );

 for attribution_data in attribution_datas {
 *removed_htlc_relay_failures.next().ok_or(DecodeError::InvalidValue)? = attribution_data;
 }
 if removed_htlc_relay_failures.next().is_some() { return Err(DecodeError::InvalidValue); }
 }

 if let Some(attribution_datas) = holding_cell_failure_attribution_data {
 for (i, attribution_data) in attribution_datas {
 let update = holding_cell_htlc_updates.get_mut(i as usize).ok_or(DecodeError::InvalidValue)?;

 if let HTLCUpdateAwaitingACK::FailHTLC { htlc_id: _, ref mut err_packet } = update {
 err_packet.attribution_data = Some(attribution_data);
 } else {
 return Err(DecodeError::InvalidValue);
 }
 }
 }

 if let Some(malformed_htlcs) = malformed_htlcs {
 for (malformed_htlc_id, failure_code, sha256_of_onion) in malformed_htlcs {
 let htlc_idx = holding_cell_htlc_updates.iter().position(|htlc| {
Expand DownExpand Up@@ -11144,6 +11209,18 @@ impl<'a, 'b, 'c, ES: Deref, SP: Deref> ReadableArgs<(&'a ES, &'b SP, &'c Channel
	}
}

fn duration_since_epoch() -> Option<Duration> {
	#[cfg(not(feature = "std"))]
	let now = None;

	#[cfg(feature = "std")]
	let now = Some(std::time::SystemTime::now()
 .duration_since(std::time::SystemTime::UNIX_EPOCH)
 .expect("SystemTime::now() should come after SystemTime::UNIX_EPOCH"));

	now
}

#[cfg(test)]
mod tests {
	use std::cmp;
Expand All@@ -11157,7 +11234,7 @@ mod tests {
	use bitcoin::network::Network;
	#[cfg(splicing)]
	use bitcoin::Weight;
	use crate::ln::onion_utils::INVALID_ONION_BLINDING;
	use crate::ln::onion_utils::{ATTRIBUTION_DATA_LEN, INVALID_ONION_BLINDING};
	use crate::types::payment::{PaymentHash, PaymentPreimage};
	use crate::ln::channel_keys::{RevocationKey, RevocationBasepoint};
	use crate::ln::channelmanager::{self, HTLCSource, PaymentId};
Expand DownExpand Up@@ -11378,6 +11455,7 @@ mod tests {
 },
 skimmed_fee_msat: None,
 blinding_point: None,
 timestamp: None,
 });

 // Make sure when Node A calculates their local commitment transaction, none of the HTLCs pass
Expand DownExpand Up@@ -11762,6 +11840,7 @@ mod tests {
 source: dummy_htlc_source.clone(),
 skimmed_fee_msat: None,
 blinding_point: None,
 timestamp: None,
 };
 let mut pending_outbound_htlcs = vec![dummy_outbound_output.clone(); 10];
 for (idx, htlc) in pending_outbound_htlcs.iter_mut().enumerate() {
Expand DownExpand Up@@ -11793,7 +11872,7 @@ mod tests {
 htlc_id: 0,
 };
 let dummy_holding_cell_failed_htlc = |htlc_id| HTLCUpdateAwaitingACK::FailHTLC {
 htlc_id, err_packet: msgs::OnionErrorPacket { data: vec![42] }
 htlc_id, err_packet: msgs::OnionErrorPacket { data: vec![42], attribution_data: Some([1; ATTRIBUTION_DATA_LEN]) }
 };
 let dummy_holding_cell_malformed_htlc = |htlc_id| HTLCUpdateAwaitingACK::FailMalformedHTLC {
 htlc_id, failure_code: INVALID_ONION_BLINDING, sha256_of_onion: [0; 32],
Expand Down
Loading

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

Skip to content
Attributable errors 2025#3611

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

 Closed

joostjager
wants to merge
2
commits into

from

 Closed


Attributable errors 2025
#3611
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
d282ea8

Attributable failures


joostjager Mar 5, 2025
e7923e9

Attributable failures optional feature bit


joostjager Mar 10, 2025

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


8 changes: 7 additions & 1 deletion
lightning-invoice/src/lib.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -597,12 +597,18 @@ impl InvoiceBuilder<tb::False, tb::False, tb::False, tb::False, tb::False, tb::F
	/// Construct new, empty `InvoiceBuilder`. All necessary fields have to be filled first before
	/// `InvoiceBuilder::build(self)` becomes available.
	pub fn new(currency: Currency) -> Self {
 let mut features = Bolt11InvoiceFeatures::empty();
 features.set_attributable_failures_optional();

 let mut tagged_fields = Vec::with_capacity(8);
 tagged_fields.push(TaggedField::Features(features));

 InvoiceBuilder {
 currency,
 amount: None,
 si_prefix: None,
 timestamp: None,
 tagged_fields: Vec::with_capacity(8),
 tagged_fields,
 error: None,

 phantom_d: core::marker::PhantomData,
Expand Down

18 changes: 14 additions & 4 deletions
lightning-types/src/features.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -154,7 +154,7 @@ mod sealed {
 // Byte 3
 RouteBlinding | ShutdownAnySegwit | DualFund | Taproot,
 // Byte 4
 Quiescence | OnionMessages,
 Quiescence | OnionMessages | AttributableFailures,
 // Byte 5
 ProvideStorage | ChannelType | SCIDPrivacy,
 // Byte 6
Expand All@@ -175,7 +175,7 @@ mod sealed {
 // Byte 3
 RouteBlinding | ShutdownAnySegwit | DualFund | Taproot,
 // Byte 4
 Quiescence | OnionMessages,
 Quiescence | OnionMessages | AttributableFailures,
 // Byte 5
 ProvideStorage | ChannelType | SCIDPrivacy,
 // Byte 6
Expand All@@ -199,7 +199,7 @@ mod sealed {
 // Byte 3
 ,
 // Byte 4
 ,
AttributableFailures,
 // Byte 5
 ,
 // Byte 6
Expand All@@ -219,7 +219,7 @@ mod sealed {
 // Byte 3
 ,
 // Byte 4
 ,
AttributableFailures,
 // Byte 5
 ,
 // Byte 6
Expand DownExpand Up@@ -548,6 +548,16 @@ mod sealed {
 supports_quiescence,
 requires_quiescence
	);
	define_feature!(
 37,
 AttributableFailures,
 [InitContext, NodeContext, Bolt11InvoiceContext, Bolt12InvoiceContext],
 "Feature flags for `option_attributable_failures`.",
 set_attributable_failures_optional,
 set_attributable_failures_required,
 supports_attributable_failures,
 requires_attributable_failures
	);
	define_feature!(
 39,
 OnionMessages,
Expand Down

93 changes: 86 additions & 7 deletions
lightning/src/ln/channel.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -50,7 +50,7 @@ use crate::ln::chan_utils::{
#[cfg(splicing)]
use crate::ln::chan_utils::FUNDING_TRANSACTION_WITNESS_WEIGHT;
use crate::ln::chan_utils;
use crate::ln::onion_utils::{HTLCFailReason};
use crate::ln::onion_utils::{HTLCFailReason, ATTRIBUTION_DATA_LEN};
use crate::chain::BestBlock;
use crate::chain::chaininterface::{FeeEstimator, ConfirmationTarget, LowerBoundedFeeEstimator, fee_for_weight};
use crate::chain::channelmonitor::{ChannelMonitor, ChannelMonitorUpdate, ChannelMonitorUpdateStep, LATENCY_GRACE_PERIOD_BLOCKS};
Expand All@@ -68,8 +68,11 @@ use crate::util::scid_utils::scid_from_parts;

use crate::io;
use crate::prelude::*;
use core::time::Duration;
use core::{cmp,mem,fmt};
use core::ops::Deref;
#[cfg(feature = "std")]
use std::time::SystemTime;
#[cfg(any(test, fuzzing, debug_assertions))]
use crate::sync::Mutex;
use crate::sign::type_resolver::ChannelSignerType;
Expand DownExpand Up@@ -323,6 +326,7 @@ struct OutboundHTLCOutput {
	source: HTLCSource,
	blinding_point: Option<PublicKey>,
	skimmed_fee_msat: Option<u64>,
	timestamp: Option<Duration>,
}

/// See AwaitingRemoteRevoke ChannelState for more info
Expand DownExpand Up@@ -4933,7 +4937,7 @@ trait FailHTLCContents {
impl FailHTLCContents for msgs::OnionErrorPacket {
	type Message = msgs::UpdateFailHTLC;
	fn to_message(self, htlc_id: u64, channel_id: ChannelId) -> Self::Message {
 msgs::UpdateFailHTLC { htlc_id, channel_id, reason: self.data }
 msgs::UpdateFailHTLC { htlc_id, channel_id, reason: self.data, attribution_data: self.attribution_data }
	}
	fn to_inbound_htlc_state(self) -> InboundHTLCState {
 InboundHTLCState::LocalRemoved(InboundHTLCRemovalReason::FailRelay(self))
Expand DownExpand Up@@ -6100,10 +6104,16 @@ impl<SP: Deref> FundedChannel<SP> where
 false
 } else { true }
 });
 let now = duration_since_epoch();
 pending_outbound_htlcs.retain(|htlc| {
 if let &OutboundHTLCState::AwaitingRemovedRemoteRevoke(ref outcome) = &htlc.state {
 log_trace!(logger, " ...removing outbound AwaitingRemovedRemoteRevoke {}", &htlc.payment_hash);
 if let OutboundHTLCOutcome::Failure(reason) = outcome.clone() { // We really want take() here, but, again, non-mut ref :(
 if let OutboundHTLCOutcome::Failure(mut reason) = outcome.clone() { // We really want take() here, but, again, non-mut ref :(
 if let (Some(timestamp), Some(now)) = (htlc.timestamp, now) {
 let hold_time = u32::try_from((now - timestamp).as_millis()).unwrap_or(u32::MAX);
 reason.set_hold_time(hold_time);
 }

 revoked_htlcs.push((htlc.source.clone(), htlc.payment_hash, reason));
 } else {
 finalized_claimed_htlcs.push(htlc.source.clone());
Expand DownExpand Up@@ -6845,6 +6855,7 @@ impl<SP: Deref> FundedChannel<SP> where
 channel_id: self.context.channel_id(),
 htlc_id: htlc.htlc_id,
 reason: err_packet.data.clone(),
 attribution_data: err_packet.attribution_data,
 });
 },
 &InboundHTLCRemovalReason::FailMalformed((ref sha256_of_onion, ref failure_code)) => {
Expand DownExpand Up@@ -8671,6 +8682,7 @@ impl<SP: Deref> FundedChannel<SP> where
 return Ok(None);
 }

 let timestamp = duration_since_epoch();
 self.context.pending_outbound_htlcs.push(OutboundHTLCOutput {
 htlc_id: self.context.next_holder_htlc_id,
 amount_msat,
Expand All@@ -8680,6 +8692,7 @@ impl<SP: Deref> FundedChannel<SP> where
 source,
 blinding_point,
 skimmed_fee_msat,
 timestamp,
 });

 let res = msgs::UpdateAddHTLC {
Expand DownExpand Up@@ -10247,6 +10260,7 @@ impl<SP: Deref> Writeable for FundedChannel<SP> where SP::Target: SignerProvider
 dropped_inbound_htlcs += 1;
 }
 }
 let mut removed_htlc_failure_attribution_data: Vec<&Option<[u8; ATTRIBUTION_DATA_LEN]>> = Vec::new();
 (self.context.pending_inbound_htlcs.len() as u64 - dropped_inbound_htlcs).write(writer)?;
 for htlc in self.context.pending_inbound_htlcs.iter() {
 if let &InboundHTLCState::RemoteAnnounced(_) = &htlc.state {
Expand All@@ -10272,9 +10286,10 @@ impl<SP: Deref> Writeable for FundedChannel<SP> where SP::Target: SignerProvider
 &InboundHTLCState::LocalRemoved(ref removal_reason) => {
 4u8.write(writer)?;
 match removal_reason {
Comment thread
joostjager marked this conversation as resolved.

 InboundHTLCRemovalReason::FailRelay(msgs::OnionErrorPacket { data }) => {
 InboundHTLCRemovalReason::FailRelay(msgs::OnionErrorPacket { data, attribution_data }) => {
 0u8.write(writer)?;
 data.write(writer)?;
 removed_htlc_failure_attribution_data.push(&attribution_data);
 },
 InboundHTLCRemovalReason::FailMalformed((hash, code)) => {
 1u8.write(writer)?;
Expand DownExpand Up@@ -10336,10 +10351,11 @@ impl<SP: Deref> Writeable for FundedChannel<SP> where SP::Target: SignerProvider

 let mut holding_cell_skimmed_fees: Vec<Option<u64>> = Vec::new();
 let mut holding_cell_blinding_points: Vec<Option<PublicKey>> = Vec::new();
 let mut holding_cell_failure_attribution_data: Vec<(u32, [u8; ATTRIBUTION_DATA_LEN])> = Vec::new();
 // Vec of (htlc_id, failure_code, sha256_of_onion)
 let mut malformed_htlcs: Vec<(u64, u16, [u8; 32])> = Vec::new();
 (self.context.holding_cell_htlc_updates.len() as u64).write(writer)?;
 for update in self.context.holding_cell_htlc_updates.iter() {
 for (i, update) in self.context.holding_cell_htlc_updates.iter().enumerate() {
 match update {
 &HTLCUpdateAwaitingACK::AddHTLC {
 ref amount_msat, ref cltv_expiry, ref payment_hash, ref source, ref onion_routing_packet,
Expand All@@ -10364,6 +10380,13 @@ impl<SP: Deref> Writeable for FundedChannel<SP> where SP::Target: SignerProvider
 2u8.write(writer)?;
 htlc_id.write(writer)?;
 err_packet.data.write(writer)?;

 // Store the attribution data for later writing. Include the holding cell htlc update index because
 // FailMalformedHTLC is stored with the same type 2 and we wouldn't be able to distinguish the two
 // when reading back in.
 if let Some(attribution_data ) = err_packet.attribution_data {
 holding_cell_failure_attribution_data.push((i as u32, attribution_data));
 }
 }
 &HTLCUpdateAwaitingACK::FailMalformedHTLC {
 htlc_id, failure_code, sha256_of_onion
Expand DownExpand Up@@ -10547,6 +10570,8 @@ impl<SP: Deref> Writeable for FundedChannel<SP> where SP::Target: SignerProvider
 (49, self.context.local_initiated_shutdown, option), // Added in 0.0.122
 (51, is_manual_broadcast, option), // Added in 0.0.124
 (53, funding_tx_broadcast_safe_event_emitted, option), // Added in 0.0.124
 (55, removed_htlc_failure_attribution_data, optional_vec), // Added in 0.2
 (57, holding_cell_failure_attribution_data, optional_vec), // Added in 0.2
 });

 Ok(())
Expand DownExpand Up@@ -10624,6 +10649,7 @@ impl<'a, 'b, 'c, ES: Deref, SP: Deref> ReadableArgs<(&'a ES, &'b SP, &'c Channel
 let reason = match <u8 as Readable>::read(reader)? {
 0 => InboundHTLCRemovalReason::FailRelay(msgs::OnionErrorPacket {
@joostjagerjoostjagerFeb 27, 2025

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Update in holding cell, still waiting for next round of commitment dance. Should be tests that test holding cell persistence.
Strategy: break main, see if tests fail.
@joostjagerjoostjagerMar 3, 2025

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

expect_pending_htlcs_forwardable!(nodes[1]); - in here let node 0 do something else like add another htlc, so that the failure gets into the holding cell
 data: Readable::read(reader)?,
 attribution_data: None,
 }),
 1 => InboundHTLCRemovalReason::FailMalformed(Readable::read(reader)?),
 2 => InboundHTLCRemovalReason::Fulfill(Readable::read(reader)?),
Expand DownExpand Up@@ -10664,6 +10690,7 @@ impl<'a, 'b, 'c, ES: Deref, SP: Deref> ReadableArgs<(&'a ES, &'b SP, &'c Channel
 },
 skimmed_fee_msat: None,
 blinding_point: None,
 timestamp: None,
 });
 }

Expand All@@ -10688,6 +10715,7 @@ impl<'a, 'b, 'c, ES: Deref, SP: Deref> ReadableArgs<(&'a ES, &'b SP, &'c Channel
 htlc_id: Readable::read(reader)?,
 err_packet: OnionErrorPacket {
 data: Readable::read(reader)?,
 attribution_data: None,
 },
 },
 _ => return Err(DecodeError::InvalidValue),
Expand DownExpand Up@@ -10831,6 +10859,9 @@ impl<'a, 'b, 'c, ES: Deref, SP: Deref> ReadableArgs<(&'a ES, &'b SP, &'c Channel
 let mut pending_outbound_blinding_points_opt: Option<Vec<Option<PublicKey>>> = None;
 let mut holding_cell_blinding_points_opt: Option<Vec<Option<PublicKey>>> = None;

 let mut removed_htlc_failure_attribution_data: Option<Vec<Option<[u8; ATTRIBUTION_DATA_LEN]>>> = None;
 let mut holding_cell_failure_attribution_data: Option<Vec<(u32, [u8; ATTRIBUTION_DATA_LEN])>> = None;

 let mut malformed_htlcs: Option<Vec<(u64, u16, [u8; 32])>> = None;
 let mut monitor_pending_update_adds: Option<Vec<msgs::UpdateAddHTLC>> = None;

Expand DownExpand Up@@ -10873,6 +10904,8 @@ impl<'a, 'b, 'c, ES: Deref, SP: Deref> ReadableArgs<(&'a ES, &'b SP, &'c Channel
 (49, local_initiated_shutdown, option),
 (51, is_manual_broadcast, option),
 (53, funding_tx_broadcast_safe_event_emitted, option),
 (55, removed_htlc_failure_attribution_data, optional_vec),
 (57, holding_cell_failure_attribution_data, optional_vec),
 });

 let holder_signer = signer_provider.derive_channel_signer(channel_keys_id);
Expand DownExpand Up@@ -10954,6 +10987,38 @@ impl<'a, 'b, 'c, ES: Deref, SP: Deref> ReadableArgs<(&'a ES, &'b SP, &'c Channel
 if iter.next().is_some() { return Err(DecodeError::InvalidValue) }
 }

 if let Some(attribution_datas) = removed_htlc_failure_attribution_data {
 let mut removed_htlc_relay_failures =
 pending_inbound_htlcs.iter_mut().filter_map(|status|
 if let InboundHTLCState::LocalRemoved(ref mut reason) = &mut status.state {
 if let InboundHTLCRemovalReason::FailRelay(ref mut packet) = reason {
 Some(&mut packet.attribution_data)
 } else {
 None
 }
 } else {
 None
 }
 );

 for attribution_data in attribution_datas {
 *removed_htlc_relay_failures.next().ok_or(DecodeError::InvalidValue)? = attribution_data;
 }
 if removed_htlc_relay_failures.next().is_some() { return Err(DecodeError::InvalidValue); }
 }

 if let Some(attribution_datas) = holding_cell_failure_attribution_data {
 for (i, attribution_data) in attribution_datas {
 let update = holding_cell_htlc_updates.get_mut(i as usize).ok_or(DecodeError::InvalidValue)?;

 if let HTLCUpdateAwaitingACK::FailHTLC { htlc_id: _, ref mut err_packet } = update {
 err_packet.attribution_data = Some(attribution_data);
 } else {
 return Err(DecodeError::InvalidValue);
 }
 }
 }

 if let Some(malformed_htlcs) = malformed_htlcs {
 for (malformed_htlc_id, failure_code, sha256_of_onion) in malformed_htlcs {
 let htlc_idx = holding_cell_htlc_updates.iter().position(|htlc| {
Expand DownExpand Up@@ -11144,6 +11209,18 @@ impl<'a, 'b, 'c, ES: Deref, SP: Deref> ReadableArgs<(&'a ES, &'b SP, &'c Channel
	}
}

fn duration_since_epoch() -> Option<Duration> {
	#[cfg(not(feature = "std"))]
	let now = None;

	#[cfg(feature = "std")]
	let now = Some(std::time::SystemTime::now()
 .duration_since(std::time::SystemTime::UNIX_EPOCH)
 .expect("SystemTime::now() should come after SystemTime::UNIX_EPOCH"));

	now
}

#[cfg(test)]
mod tests {
	use std::cmp;
Expand All@@ -11157,7 +11234,7 @@ mod tests {
	use bitcoin::network::Network;
	#[cfg(splicing)]
	use bitcoin::Weight;
	use crate::ln::onion_utils::INVALID_ONION_BLINDING;
	use crate::ln::onion_utils::{ATTRIBUTION_DATA_LEN, INVALID_ONION_BLINDING};
	use crate::types::payment::{PaymentHash, PaymentPreimage};
	use crate::ln::channel_keys::{RevocationKey, RevocationBasepoint};
	use crate::ln::channelmanager::{self, HTLCSource, PaymentId};
Expand DownExpand Up@@ -11378,6 +11455,7 @@ mod tests {
 },
 skimmed_fee_msat: None,
 blinding_point: None,
 timestamp: None,
 });

 // Make sure when Node A calculates their local commitment transaction, none of the HTLCs pass
Expand DownExpand Up@@ -11762,6 +11840,7 @@ mod tests {
 source: dummy_htlc_source.clone(),
 skimmed_fee_msat: None,
 blinding_point: None,
 timestamp: None,
 };
 let mut pending_outbound_htlcs = vec![dummy_outbound_output.clone(); 10];
 for (idx, htlc) in pending_outbound_htlcs.iter_mut().enumerate() {
Expand DownExpand Up@@ -11793,7 +11872,7 @@ mod tests {
 htlc_id: 0,
 };
 let dummy_holding_cell_failed_htlc = |htlc_id| HTLCUpdateAwaitingACK::FailHTLC {
 htlc_id, err_packet: msgs::OnionErrorPacket { data: vec![42] }
 htlc_id, err_packet: msgs::OnionErrorPacket { data: vec![42], attribution_data: Some([1; ATTRIBUTION_DATA_LEN]) }
 };
 let dummy_holding_cell_malformed_htlc = |htlc_id| HTLCUpdateAwaitingACK::FailMalformedHTLC {
 htlc_id, failure_code: INVALID_ONION_BLINDING, sha256_of_onion: [0; 32],
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default");
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Attributable errors 2025#3611

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

 Closed

joostjager
wants to merge
2
commits into

from

 Closed


Attributable errors 2025
#3611
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
d282ea8

Attributable failures


joostjager Mar 5, 2025
e7923e9

Attributable failures optional feature bit


joostjager Mar 10, 2025

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


8 changes: 7 additions & 1 deletion
lightning-invoice/src/lib.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -597,12 +597,18 @@ impl InvoiceBuilder<tb::False, tb::False, tb::False, tb::False, tb::False, tb::F
	/// Construct new, empty `InvoiceBuilder`. All necessary fields have to be filled first before
	/// `InvoiceBuilder::build(self)` becomes available.
	pub fn new(currency: Currency) -> Self {
 let mut features = Bolt11InvoiceFeatures::empty();
 features.set_attributable_failures_optional();

 let mut tagged_fields = Vec::with_capacity(8);
 tagged_fields.push(TaggedField::Features(features));

 InvoiceBuilder {
 currency,
 amount: None,
 si_prefix: None,
 timestamp: None,
 tagged_fields: Vec::with_capacity(8),
 tagged_fields,
 error: None,

 phantom_d: core::marker::PhantomData,
Expand Down

18 changes: 14 additions & 4 deletions
lightning-types/src/features.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -154,7 +154,7 @@ mod sealed {
 // Byte 3
 RouteBlinding | ShutdownAnySegwit | DualFund | Taproot,
 // Byte 4
 Quiescence | OnionMessages,
 Quiescence | OnionMessages | AttributableFailures,
 // Byte 5
 ProvideStorage | ChannelType | SCIDPrivacy,
 // Byte 6
Expand All@@ -175,7 +175,7 @@ mod sealed {
 // Byte 3
 RouteBlinding | ShutdownAnySegwit | DualFund | Taproot,
 // Byte 4
 Quiescence | OnionMessages,
 Quiescence | OnionMessages | AttributableFailures,
 // Byte 5
 ProvideStorage | ChannelType | SCIDPrivacy,
 // Byte 6
Expand All@@ -199,7 +199,7 @@ mod sealed {
 // Byte 3
 ,
 // Byte 4
 ,
AttributableFailures,
 // Byte 5
 ,
 // Byte 6
Expand All@@ -219,7 +219,7 @@ mod sealed {
 // Byte 3
 ,
 // Byte 4
 ,
AttributableFailures,
 // Byte 5
 ,
 // Byte 6
Expand DownExpand Up@@ -548,6 +548,16 @@ mod sealed {
 supports_quiescence,
 requires_quiescence
	);
	define_feature!(
 37,
 AttributableFailures,
 [InitContext, NodeContext, Bolt11InvoiceContext, Bolt12InvoiceContext],
 "Feature flags for `option_attributable_failures`.",
 set_attributable_failures_optional,
 set_attributable_failures_required,
 supports_attributable_failures,
 requires_attributable_failures
	);
	define_feature!(
 39,
 OnionMessages,
Expand Down

93 changes: 86 additions & 7 deletions
lightning/src/ln/channel.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -50,7 +50,7 @@ use crate::ln::chan_utils::{
#[cfg(splicing)]
use crate::ln::chan_utils::FUNDING_TRANSACTION_WITNESS_WEIGHT;
use crate::ln::chan_utils;
use crate::ln::onion_utils::{HTLCFailReason};
use crate::ln::onion_utils::{HTLCFailReason, ATTRIBUTION_DATA_LEN};
use crate::chain::BestBlock;
use crate::chain::chaininterface::{FeeEstimator, ConfirmationTarget, LowerBoundedFeeEstimator, fee_for_weight};
use crate::chain::channelmonitor::{ChannelMonitor, ChannelMonitorUpdate, ChannelMonitorUpdateStep, LATENCY_GRACE_PERIOD_BLOCKS};
Expand All@@ -68,8 +68,11 @@ use crate::util::scid_utils::scid_from_parts;

use crate::io;
use crate::prelude::*;
use core::time::Duration;
use core::{cmp,mem,fmt};
use core::ops::Deref;
#[cfg(feature = "std")]
use std::time::SystemTime;
#[cfg(any(test, fuzzing, debug_assertions))]
use crate::sync::Mutex;
use crate::sign::type_resolver::ChannelSignerType;
Expand DownExpand Up@@ -323,6 +326,7 @@ struct OutboundHTLCOutput {
	source: HTLCSource,
	blinding_point: Option<PublicKey>,
	skimmed_fee_msat: Option<u64>,
	timestamp: Option<Duration>,
}

/// See AwaitingRemoteRevoke ChannelState for more info
Expand DownExpand Up@@ -4933,7 +4937,7 @@ trait FailHTLCContents {
impl FailHTLCContents for msgs::OnionErrorPacket {
	type Message = msgs::UpdateFailHTLC;
	fn to_message(self, htlc_id: u64, channel_id: ChannelId) -> Self::Message {
 msgs::UpdateFailHTLC { htlc_id, channel_id, reason: self.data }
 msgs::UpdateFailHTLC { htlc_id, channel_id, reason: self.data, attribution_data: self.attribution_data }
	}
	fn to_inbound_htlc_state(self) -> InboundHTLCState {
 InboundHTLCState::LocalRemoved(InboundHTLCRemovalReason::FailRelay(self))
Expand DownExpand Up@@ -6100,10 +6104,16 @@ impl<SP: Deref> FundedChannel<SP> where
 false
 } else { true }
 });
 let now = duration_since_epoch();
 pending_outbound_htlcs.retain(|htlc| {
 if let &OutboundHTLCState::AwaitingRemovedRemoteRevoke(ref outcome) = &htlc.state {
 log_trace!(logger, " ...removing outbound AwaitingRemovedRemoteRevoke {}", &htlc.payment_hash);
 if let OutboundHTLCOutcome::Failure(reason) = outcome.clone() { // We really want take() here, but, again, non-mut ref :(
 if let OutboundHTLCOutcome::Failure(mut reason) = outcome.clone() { // We really want take() here, but, again, non-mut ref :(
 if let (Some(timestamp), Some(now)) = (htlc.timestamp, now) {
 let hold_time = u32::try_from((now - timestamp).as_millis()).unwrap_or(u32::MAX);
 reason.set_hold_time(hold_time);
 }

 revoked_htlcs.push((htlc.source.clone(), htlc.payment_hash, reason));
 } else {
 finalized_claimed_htlcs.push(htlc.source.clone());
Expand DownExpand Up@@ -6845,6 +6855,7 @@ impl<SP: Deref> FundedChannel<SP> where
 channel_id: self.context.channel_id(),
 htlc_id: htlc.htlc_id,
 reason: err_packet.data.clone(),
 attribution_data: err_packet.attribution_data,
 });
 },
 &InboundHTLCRemovalReason::FailMalformed((ref sha256_of_onion, ref failure_code)) => {
Expand DownExpand Up@@ -8671,6 +8682,7 @@ impl<SP: Deref> FundedChannel<SP> where
 return Ok(None);
 }

 let timestamp = duration_since_epoch();
 self.context.pending_outbound_htlcs.push(OutboundHTLCOutput {
 htlc_id: self.context.next_holder_htlc_id,
 amount_msat,
Expand All@@ -8680,6 +8692,7 @@ impl<SP: Deref> FundedChannel<SP> where
 source,
 blinding_point,
 skimmed_fee_msat,
 timestamp,
 });

 let res = msgs::UpdateAddHTLC {
Expand DownExpand Up@@ -10247,6 +10260,7 @@ impl<SP: Deref> Writeable for FundedChannel<SP> where SP::Target: SignerProvider
 dropped_inbound_htlcs += 1;
 }
 }
 let mut removed_htlc_failure_attribution_data: Vec<&Option<[u8; ATTRIBUTION_DATA_LEN]>> = Vec::new();
 (self.context.pending_inbound_htlcs.len() as u64 - dropped_inbound_htlcs).write(writer)?;
 for htlc in self.context.pending_inbound_htlcs.iter() {
 if let &InboundHTLCState::RemoteAnnounced(_) = &htlc.state {
Expand All@@ -10272,9 +10286,10 @@ impl<SP: Deref> Writeable for FundedChannel<SP> where SP::Target: SignerProvider
 &InboundHTLCState::LocalRemoved(ref removal_reason) => {
 4u8.write(writer)?;
 match removal_reason {
Comment thread
joostjager marked this conversation as resolved.

 InboundHTLCRemovalReason::FailRelay(msgs::OnionErrorPacket { data }) => {
 InboundHTLCRemovalReason::FailRelay(msgs::OnionErrorPacket { data, attribution_data }) => {
 0u8.write(writer)?;
 data.write(writer)?;
 removed_htlc_failure_attribution_data.push(&attribution_data);
 },
 InboundHTLCRemovalReason::FailMalformed((hash, code)) => {
 1u8.write(writer)?;
Expand DownExpand Up@@ -10336,10 +10351,11 @@ impl<SP: Deref> Writeable for FundedChannel<SP> where SP::Target: SignerProvider

 let mut holding_cell_skimmed_fees: Vec<Option<u64>> = Vec::new();
 let mut holding_cell_blinding_points: Vec<Option<PublicKey>> = Vec::new();
 let mut holding_cell_failure_attribution_data: Vec<(u32, [u8; ATTRIBUTION_DATA_LEN])> = Vec::new();
 // Vec of (htlc_id, failure_code, sha256_of_onion)
 let mut malformed_htlcs: Vec<(u64, u16, [u8; 32])> = Vec::new();
 (self.context.holding_cell_htlc_updates.len() as u64).write(writer)?;
 for update in self.context.holding_cell_htlc_updates.iter() {
 for (i, update) in self.context.holding_cell_htlc_updates.iter().enumerate() {
 match update {
 &HTLCUpdateAwaitingACK::AddHTLC {
 ref amount_msat, ref cltv_expiry, ref payment_hash, ref source, ref onion_routing_packet,
Expand All@@ -10364,6 +10380,13 @@ impl<SP: Deref> Writeable for FundedChannel<SP> where SP::Target: SignerProvider
 2u8.write(writer)?;
 htlc_id.write(writer)?;
 err_packet.data.write(writer)?;

 // Store the attribution data for later writing. Include the holding cell htlc update index because
 // FailMalformedHTLC is stored with the same type 2 and we wouldn't be able to distinguish the two
 // when reading back in.
 if let Some(attribution_data ) = err_packet.attribution_data {
 holding_cell_failure_attribution_data.push((i as u32, attribution_data));
 }
 }
 &HTLCUpdateAwaitingACK::FailMalformedHTLC {
 htlc_id, failure_code, sha256_of_onion
Expand DownExpand Up@@ -10547,6 +10570,8 @@ impl<SP: Deref> Writeable for FundedChannel<SP> where SP::Target: SignerProvider
 (49, self.context.local_initiated_shutdown, option), // Added in 0.0.122
 (51, is_manual_broadcast, option), // Added in 0.0.124
 (53, funding_tx_broadcast_safe_event_emitted, option), // Added in 0.0.124
 (55, removed_htlc_failure_attribution_data, optional_vec), // Added in 0.2
 (57, holding_cell_failure_attribution_data, optional_vec), // Added in 0.2
 });

 Ok(())
Expand DownExpand Up@@ -10624,6 +10649,7 @@ impl<'a, 'b, 'c, ES: Deref, SP: Deref> ReadableArgs<(&'a ES, &'b SP, &'c Channel
 let reason = match <u8 as Readable>::read(reader)? {
 0 => InboundHTLCRemovalReason::FailRelay(msgs::OnionErrorPacket {
@joostjagerjoostjagerFeb 27, 2025

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Update in holding cell, still waiting for next round of commitment dance. Should be tests that test holding cell persistence.
Strategy: break main, see if tests fail.
@joostjagerjoostjagerMar 3, 2025

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

expect_pending_htlcs_forwardable!(nodes[1]); - in here let node 0 do something else like add another htlc, so that the failure gets into the holding cell
 data: Readable::read(reader)?,
 attribution_data: None,
 }),
 1 => InboundHTLCRemovalReason::FailMalformed(Readable::read(reader)?),
 2 => InboundHTLCRemovalReason::Fulfill(Readable::read(reader)?),
Expand DownExpand Up@@ -10664,6 +10690,7 @@ impl<'a, 'b, 'c, ES: Deref, SP: Deref> ReadableArgs<(&'a ES, &'b SP, &'c Channel
 },
 skimmed_fee_msat: None,
 blinding_point: None,
 timestamp: None,
 });
 }

Expand All@@ -10688,6 +10715,7 @@ impl<'a, 'b, 'c, ES: Deref, SP: Deref> ReadableArgs<(&'a ES, &'b SP, &'c Channel
 htlc_id: Readable::read(reader)?,
 err_packet: OnionErrorPacket {
 data: Readable::read(reader)?,
 attribution_data: None,
 },
 },
 _ => return Err(DecodeError::InvalidValue),
Expand DownExpand Up@@ -10831,6 +10859,9 @@ impl<'a, 'b, 'c, ES: Deref, SP: Deref> ReadableArgs<(&'a ES, &'b SP, &'c Channel
 let mut pending_outbound_blinding_points_opt: Option<Vec<Option<PublicKey>>> = None;
 let mut holding_cell_blinding_points_opt: Option<Vec<Option<PublicKey>>> = None;

 let mut removed_htlc_failure_attribution_data: Option<Vec<Option<[u8; ATTRIBUTION_DATA_LEN]>>> = None;
 let mut holding_cell_failure_attribution_data: Option<Vec<(u32, [u8; ATTRIBUTION_DATA_LEN])>> = None;

 let mut malformed_htlcs: Option<Vec<(u64, u16, [u8; 32])>> = None;
 let mut monitor_pending_update_adds: Option<Vec<msgs::UpdateAddHTLC>> = None;

Expand DownExpand Up@@ -10873,6 +10904,8 @@ impl<'a, 'b, 'c, ES: Deref, SP: Deref> ReadableArgs<(&'a ES, &'b SP, &'c Channel
 (49, local_initiated_shutdown, option),
 (51, is_manual_broadcast, option),
 (53, funding_tx_broadcast_safe_event_emitted, option),
 (55, removed_htlc_failure_attribution_data, optional_vec),
 (57, holding_cell_failure_attribution_data, optional_vec),
 });

 let holder_signer = signer_provider.derive_channel_signer(channel_keys_id);
Expand DownExpand Up@@ -10954,6 +10987,38 @@ impl<'a, 'b, 'c, ES: Deref, SP: Deref> ReadableArgs<(&'a ES, &'b SP, &'c Channel
 if iter.next().is_some() { return Err(DecodeError::InvalidValue) }
 }

 if let Some(attribution_datas) = removed_htlc_failure_attribution_data {
 let mut removed_htlc_relay_failures =
 pending_inbound_htlcs.iter_mut().filter_map(|status|
 if let InboundHTLCState::LocalRemoved(ref mut reason) = &mut status.state {
 if let InboundHTLCRemovalReason::FailRelay(ref mut packet) = reason {
 Some(&mut packet.attribution_data)
 } else {
 None
 }
 } else {
 None
 }
 );

 for attribution_data in attribution_datas {
 *removed_htlc_relay_failures.next().ok_or(DecodeError::InvalidValue)? = attribution_data;
 }
 if removed_htlc_relay_failures.next().is_some() { return Err(DecodeError::InvalidValue); }
 }

 if let Some(attribution_datas) = holding_cell_failure_attribution_data {
 for (i, attribution_data) in attribution_datas {
 let update = holding_cell_htlc_updates.get_mut(i as usize).ok_or(DecodeError::InvalidValue)?;

 if let HTLCUpdateAwaitingACK::FailHTLC { htlc_id: _, ref mut err_packet } = update {
 err_packet.attribution_data = Some(attribution_data);
 } else {
 return Err(DecodeError::InvalidValue);
 }
 }
 }

 if let Some(malformed_htlcs) = malformed_htlcs {
 for (malformed_htlc_id, failure_code, sha256_of_onion) in malformed_htlcs {
 let htlc_idx = holding_cell_htlc_updates.iter().position(|htlc| {
Expand DownExpand Up@@ -11144,6 +11209,18 @@ impl<'a, 'b, 'c, ES: Deref, SP: Deref> ReadableArgs<(&'a ES, &'b SP, &'c Channel
	}
}

fn duration_since_epoch() -> Option<Duration> {
	#[cfg(not(feature = "std"))]
	let now = None;

	#[cfg(feature = "std")]
	let now = Some(std::time::SystemTime::now()
 .duration_since(std::time::SystemTime::UNIX_EPOCH)
 .expect("SystemTime::now() should come after SystemTime::UNIX_EPOCH"));

	now
}

#[cfg(test)]
mod tests {
	use std::cmp;
Expand All@@ -11157,7 +11234,7 @@ mod tests {
	use bitcoin::network::Network;
	#[cfg(splicing)]
	use bitcoin::Weight;
	use crate::ln::onion_utils::INVALID_ONION_BLINDING;
	use crate::ln::onion_utils::{ATTRIBUTION_DATA_LEN, INVALID_ONION_BLINDING};
	use crate::types::payment::{PaymentHash, PaymentPreimage};
	use crate::ln::channel_keys::{RevocationKey, RevocationBasepoint};
	use crate::ln::channelmanager::{self, HTLCSource, PaymentId};
Expand DownExpand Up@@ -11378,6 +11455,7 @@ mod tests {
 },
 skimmed_fee_msat: None,
 blinding_point: None,
 timestamp: None,
 });

 // Make sure when Node A calculates their local commitment transaction, none of the HTLCs pass
Expand DownExpand Up@@ -11762,6 +11840,7 @@ mod tests {
 source: dummy_htlc_source.clone(),
 skimmed_fee_msat: None,
 blinding_point: None,
 timestamp: None,
 };
 let mut pending_outbound_htlcs = vec![dummy_outbound_output.clone(); 10];
 for (idx, htlc) in pending_outbound_htlcs.iter_mut().enumerate() {
Expand DownExpand Up@@ -11793,7 +11872,7 @@ mod tests {
 htlc_id: 0,
 };
 let dummy_holding_cell_failed_htlc = |htlc_id| HTLCUpdateAwaitingACK::FailHTLC {
 htlc_id, err_packet: msgs::OnionErrorPacket { data: vec![42] }
 htlc_id, err_packet: msgs::OnionErrorPacket { data: vec![42], attribution_data: Some([1; ATTRIBUTION_DATA_LEN]) }
 };
 let dummy_holding_cell_malformed_htlc = |htlc_id| HTLCUpdateAwaitingACK::FailMalformedHTLC {
 htlc_id, failure_code: INVALID_ONION_BLINDING, sha256_of_onion: [0; 32],
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers");
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Attributable errors 2025#3611

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

 Closed

joostjager
wants to merge
2
commits into

from

 Closed


Attributable errors 2025
#3611
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
d282ea8

Attributable failures


joostjager Mar 5, 2025
e7923e9

Attributable failures optional feature bit


joostjager Mar 10, 2025

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


8 changes: 7 additions & 1 deletion
lightning-invoice/src/lib.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -597,12 +597,18 @@ impl InvoiceBuilder<tb::False, tb::False, tb::False, tb::False, tb::False, tb::F
	/// Construct new, empty `InvoiceBuilder`. All necessary fields have to be filled first before
	/// `InvoiceBuilder::build(self)` becomes available.
	pub fn new(currency: Currency) -> Self {
 let mut features = Bolt11InvoiceFeatures::empty();
 features.set_attributable_failures_optional();

 let mut tagged_fields = Vec::with_capacity(8);
 tagged_fields.push(TaggedField::Features(features));

 InvoiceBuilder {
 currency,
 amount: None,
 si_prefix: None,
 timestamp: None,
 tagged_fields: Vec::with_capacity(8),
 tagged_fields,
 error: None,

 phantom_d: core::marker::PhantomData,
Expand Down

18 changes: 14 additions & 4 deletions
lightning-types/src/features.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -154,7 +154,7 @@ mod sealed {
 // Byte 3
 RouteBlinding | ShutdownAnySegwit | DualFund | Taproot,
 // Byte 4
 Quiescence | OnionMessages,
 Quiescence | OnionMessages | AttributableFailures,
 // Byte 5
 ProvideStorage | ChannelType | SCIDPrivacy,
 // Byte 6
Expand All@@ -175,7 +175,7 @@ mod sealed {
 // Byte 3
 RouteBlinding | ShutdownAnySegwit | DualFund | Taproot,
 // Byte 4
 Quiescence | OnionMessages,
 Quiescence | OnionMessages | AttributableFailures,
 // Byte 5
 ProvideStorage | ChannelType | SCIDPrivacy,
 // Byte 6
Expand All@@ -199,7 +199,7 @@ mod sealed {
 // Byte 3
 ,
 // Byte 4
 ,
AttributableFailures,
 // Byte 5
 ,
 // Byte 6
Expand All@@ -219,7 +219,7 @@ mod sealed {
 // Byte 3
 ,
 // Byte 4
 ,
AttributableFailures,
 // Byte 5
 ,
 // Byte 6
Expand DownExpand Up@@ -548,6 +548,16 @@ mod sealed {
 supports_quiescence,
 requires_quiescence
	);
	define_feature!(
 37,
 AttributableFailures,
 [InitContext, NodeContext, Bolt11InvoiceContext, Bolt12InvoiceContext],
 "Feature flags for `option_attributable_failures`.",
 set_attributable_failures_optional,
 set_attributable_failures_required,
 supports_attributable_failures,
 requires_attributable_failures
	);
	define_feature!(
 39,
 OnionMessages,
Expand Down

93 changes: 86 additions & 7 deletions
lightning/src/ln/channel.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -50,7 +50,7 @@ use crate::ln::chan_utils::{
#[cfg(splicing)]
use crate::ln::chan_utils::FUNDING_TRANSACTION_WITNESS_WEIGHT;
use crate::ln::chan_utils;
use crate::ln::onion_utils::{HTLCFailReason};
use crate::ln::onion_utils::{HTLCFailReason, ATTRIBUTION_DATA_LEN};
use crate::chain::BestBlock;
use crate::chain::chaininterface::{FeeEstimator, ConfirmationTarget, LowerBoundedFeeEstimator, fee_for_weight};
use crate::chain::channelmonitor::{ChannelMonitor, ChannelMonitorUpdate, ChannelMonitorUpdateStep, LATENCY_GRACE_PERIOD_BLOCKS};
Expand All@@ -68,8 +68,11 @@ use crate::util::scid_utils::scid_from_parts;

use crate::io;
use crate::prelude::*;
use core::time::Duration;
use core::{cmp,mem,fmt};
use core::ops::Deref;
#[cfg(feature = "std")]
use std::time::SystemTime;
#[cfg(any(test, fuzzing, debug_assertions))]
use crate::sync::Mutex;
use crate::sign::type_resolver::ChannelSignerType;
Expand DownExpand Up@@ -323,6 +326,7 @@ struct OutboundHTLCOutput {
	source: HTLCSource,
	blinding_point: Option<PublicKey>,
	skimmed_fee_msat: Option<u64>,
	timestamp: Option<Duration>,
}

/// See AwaitingRemoteRevoke ChannelState for more info
Expand DownExpand Up@@ -4933,7 +4937,7 @@ trait FailHTLCContents {
impl FailHTLCContents for msgs::OnionErrorPacket {
	type Message = msgs::UpdateFailHTLC;
	fn to_message(self, htlc_id: u64, channel_id: ChannelId) -> Self::Message {
 msgs::UpdateFailHTLC { htlc_id, channel_id, reason: self.data }
 msgs::UpdateFailHTLC { htlc_id, channel_id, reason: self.data, attribution_data: self.attribution_data }
	}
	fn to_inbound_htlc_state(self) -> InboundHTLCState {
 InboundHTLCState::LocalRemoved(InboundHTLCRemovalReason::FailRelay(self))
Expand DownExpand Up@@ -6100,10 +6104,16 @@ impl<SP: Deref> FundedChannel<SP> where
 false
 } else { true }
 });
 let now = duration_since_epoch();
 pending_outbound_htlcs.retain(|htlc| {
 if let &OutboundHTLCState::AwaitingRemovedRemoteRevoke(ref outcome) = &htlc.state {
 log_trace!(logger, " ...removing outbound AwaitingRemovedRemoteRevoke {}", &htlc.payment_hash);
 if let OutboundHTLCOutcome::Failure(reason) = outcome.clone() { // We really want take() here, but, again, non-mut ref :(
 if let OutboundHTLCOutcome::Failure(mut reason) = outcome.clone() { // We really want take() here, but, again, non-mut ref :(
 if let (Some(timestamp), Some(now)) = (htlc.timestamp, now) {
 let hold_time = u32::try_from((now - timestamp).as_millis()).unwrap_or(u32::MAX);
 reason.set_hold_time(hold_time);
 }

 revoked_htlcs.push((htlc.source.clone(), htlc.payment_hash, reason));
 } else {
 finalized_claimed_htlcs.push(htlc.source.clone());
Expand DownExpand Up@@ -6845,6 +6855,7 @@ impl<SP: Deref> FundedChannel<SP> where
 channel_id: self.context.channel_id(),
 htlc_id: htlc.htlc_id,
 reason: err_packet.data.clone(),
 attribution_data: err_packet.attribution_data,
 });
 },
 &InboundHTLCRemovalReason::FailMalformed((ref sha256_of_onion, ref failure_code)) => {
Expand DownExpand Up@@ -8671,6 +8682,7 @@ impl<SP: Deref> FundedChannel<SP> where
 return Ok(None);
 }

 let timestamp = duration_since_epoch();
 self.context.pending_outbound_htlcs.push(OutboundHTLCOutput {
 htlc_id: self.context.next_holder_htlc_id,
 amount_msat,
Expand All@@ -8680,6 +8692,7 @@ impl<SP: Deref> FundedChannel<SP> where
 source,
 blinding_point,
 skimmed_fee_msat,
 timestamp,
 });

 let res = msgs::UpdateAddHTLC {
Expand DownExpand Up@@ -10247,6 +10260,7 @@ impl<SP: Deref> Writeable for FundedChannel<SP> where SP::Target: SignerProvider
 dropped_inbound_htlcs += 1;
 }
 }
 let mut removed_htlc_failure_attribution_data: Vec<&Option<[u8; ATTRIBUTION_DATA_LEN]>> = Vec::new();
 (self.context.pending_inbound_htlcs.len() as u64 - dropped_inbound_htlcs).write(writer)?;
 for htlc in self.context.pending_inbound_htlcs.iter() {
 if let &InboundHTLCState::RemoteAnnounced(_) = &htlc.state {
Expand All@@ -10272,9 +10286,10 @@ impl<SP: Deref> Writeable for FundedChannel<SP> where SP::Target: SignerProvider
 &InboundHTLCState::LocalRemoved(ref removal_reason) => {
 4u8.write(writer)?;
 match removal_reason {
Comment thread
joostjager marked this conversation as resolved.

 InboundHTLCRemovalReason::FailRelay(msgs::OnionErrorPacket { data }) => {
 InboundHTLCRemovalReason::FailRelay(msgs::OnionErrorPacket { data, attribution_data }) => {
 0u8.write(writer)?;
 data.write(writer)?;
 removed_htlc_failure_attribution_data.push(&attribution_data);
 },
 InboundHTLCRemovalReason::FailMalformed((hash, code)) => {
 1u8.write(writer)?;
Expand DownExpand Up@@ -10336,10 +10351,11 @@ impl<SP: Deref> Writeable for FundedChannel<SP> where SP::Target: SignerProvider

 let mut holding_cell_skimmed_fees: Vec<Option<u64>> = Vec::new();
 let mut holding_cell_blinding_points: Vec<Option<PublicKey>> = Vec::new();
 let mut holding_cell_failure_attribution_data: Vec<(u32, [u8; ATTRIBUTION_DATA_LEN])> = Vec::new();
 // Vec of (htlc_id, failure_code, sha256_of_onion)
 let mut malformed_htlcs: Vec<(u64, u16, [u8; 32])> = Vec::new();
 (self.context.holding_cell_htlc_updates.len() as u64).write(writer)?;
 for update in self.context.holding_cell_htlc_updates.iter() {
 for (i, update) in self.context.holding_cell_htlc_updates.iter().enumerate() {
 match update {
 &HTLCUpdateAwaitingACK::AddHTLC {
 ref amount_msat, ref cltv_expiry, ref payment_hash, ref source, ref onion_routing_packet,
Expand All@@ -10364,6 +10380,13 @@ impl<SP: Deref> Writeable for FundedChannel<SP> where SP::Target: SignerProvider
 2u8.write(writer)?;
 htlc_id.write(writer)?;
 err_packet.data.write(writer)?;

 // Store the attribution data for later writing. Include the holding cell htlc update index because
 // FailMalformedHTLC is stored with the same type 2 and we wouldn't be able to distinguish the two
 // when reading back in.
 if let Some(attribution_data ) = err_packet.attribution_data {
 holding_cell_failure_attribution_data.push((i as u32, attribution_data));
 }
 }
 &HTLCUpdateAwaitingACK::FailMalformedHTLC {
 htlc_id, failure_code, sha256_of_onion
Expand DownExpand Up@@ -10547,6 +10570,8 @@ impl<SP: Deref> Writeable for FundedChannel<SP> where SP::Target: SignerProvider
 (49, self.context.local_initiated_shutdown, option), // Added in 0.0.122
 (51, is_manual_broadcast, option), // Added in 0.0.124
 (53, funding_tx_broadcast_safe_event_emitted, option), // Added in 0.0.124
 (55, removed_htlc_failure_attribution_data, optional_vec), // Added in 0.2
 (57, holding_cell_failure_attribution_data, optional_vec), // Added in 0.2
 });

 Ok(())
Expand DownExpand Up@@ -10624,6 +10649,7 @@ impl<'a, 'b, 'c, ES: Deref, SP: Deref> ReadableArgs<(&'a ES, &'b SP, &'c Channel
 let reason = match <u8 as Readable>::read(reader)? {
 0 => InboundHTLCRemovalReason::FailRelay(msgs::OnionErrorPacket {
@joostjagerjoostjagerFeb 27, 2025

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Update in holding cell, still waiting for next round of commitment dance. Should be tests that test holding cell persistence.
Strategy: break main, see if tests fail.
@joostjagerjoostjagerMar 3, 2025

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

expect_pending_htlcs_forwardable!(nodes[1]); - in here let node 0 do something else like add another htlc, so that the failure gets into the holding cell
 data: Readable::read(reader)?,
 attribution_data: None,
 }),
 1 => InboundHTLCRemovalReason::FailMalformed(Readable::read(reader)?),
 2 => InboundHTLCRemovalReason::Fulfill(Readable::read(reader)?),
Expand DownExpand Up@@ -10664,6 +10690,7 @@ impl<'a, 'b, 'c, ES: Deref, SP: Deref> ReadableArgs<(&'a ES, &'b SP, &'c Channel
 },
 skimmed_fee_msat: None,
 blinding_point: None,
 timestamp: None,
 });
 }

Expand All@@ -10688,6 +10715,7 @@ impl<'a, 'b, 'c, ES: Deref, SP: Deref> ReadableArgs<(&'a ES, &'b SP, &'c Channel
 htlc_id: Readable::read(reader)?,
 err_packet: OnionErrorPacket {
 data: Readable::read(reader)?,
 attribution_data: None,
 },
 },
 _ => return Err(DecodeError::InvalidValue),
Expand DownExpand Up@@ -10831,6 +10859,9 @@ impl<'a, 'b, 'c, ES: Deref, SP: Deref> ReadableArgs<(&'a ES, &'b SP, &'c Channel
 let mut pending_outbound_blinding_points_opt: Option<Vec<Option<PublicKey>>> = None;
 let mut holding_cell_blinding_points_opt: Option<Vec<Option<PublicKey>>> = None;

 let mut removed_htlc_failure_attribution_data: Option<Vec<Option<[u8; ATTRIBUTION_DATA_LEN]>>> = None;
 let mut holding_cell_failure_attribution_data: Option<Vec<(u32, [u8; ATTRIBUTION_DATA_LEN])>> = None;

 let mut malformed_htlcs: Option<Vec<(u64, u16, [u8; 32])>> = None;
 let mut monitor_pending_update_adds: Option<Vec<msgs::UpdateAddHTLC>> = None;

Expand DownExpand Up@@ -10873,6 +10904,8 @@ impl<'a, 'b, 'c, ES: Deref, SP: Deref> ReadableArgs<(&'a ES, &'b SP, &'c Channel
 (49, local_initiated_shutdown, option),
 (51, is_manual_broadcast, option),
 (53, funding_tx_broadcast_safe_event_emitted, option),
 (55, removed_htlc_failure_attribution_data, optional_vec),
 (57, holding_cell_failure_attribution_data, optional_vec),
 });

 let holder_signer = signer_provider.derive_channel_signer(channel_keys_id);
Expand DownExpand Up@@ -10954,6 +10987,38 @@ impl<'a, 'b, 'c, ES: Deref, SP: Deref> ReadableArgs<(&'a ES, &'b SP, &'c Channel
 if iter.next().is_some() { return Err(DecodeError::InvalidValue) }
 }

 if let Some(attribution_datas) = removed_htlc_failure_attribution_data {
 let mut removed_htlc_relay_failures =
 pending_inbound_htlcs.iter_mut().filter_map(|status|
 if let InboundHTLCState::LocalRemoved(ref mut reason) = &mut status.state {
 if let InboundHTLCRemovalReason::FailRelay(ref mut packet) = reason {
 Some(&mut packet.attribution_data)
 } else {
 None
 }
 } else {
 None
 }
 );

 for attribution_data in attribution_datas {
 *removed_htlc_relay_failures.next().ok_or(DecodeError::InvalidValue)? = attribution_data;
 }
 if removed_htlc_relay_failures.next().is_some() { return Err(DecodeError::InvalidValue); }
 }

 if let Some(attribution_datas) = holding_cell_failure_attribution_data {
 for (i, attribution_data) in attribution_datas {
 let update = holding_cell_htlc_updates.get_mut(i as usize).ok_or(DecodeError::InvalidValue)?;

 if let HTLCUpdateAwaitingACK::FailHTLC { htlc_id: _, ref mut err_packet } = update {
 err_packet.attribution_data = Some(attribution_data);
 } else {
 return Err(DecodeError::InvalidValue);
 }
 }
 }

 if let Some(malformed_htlcs) = malformed_htlcs {
 for (malformed_htlc_id, failure_code, sha256_of_onion) in malformed_htlcs {
 let htlc_idx = holding_cell_htlc_updates.iter().position(|htlc| {
Expand DownExpand Up@@ -11144,6 +11209,18 @@ impl<'a, 'b, 'c, ES: Deref, SP: Deref> ReadableArgs<(&'a ES, &'b SP, &'c Channel
	}
}

fn duration_since_epoch() -> Option<Duration> {
	#[cfg(not(feature = "std"))]
	let now = None;

	#[cfg(feature = "std")]
	let now = Some(std::time::SystemTime::now()
 .duration_since(std::time::SystemTime::UNIX_EPOCH)
 .expect("SystemTime::now() should come after SystemTime::UNIX_EPOCH"));

	now
}

#[cfg(test)]
mod tests {
	use std::cmp;
Expand All@@ -11157,7 +11234,7 @@ mod tests {
	use bitcoin::network::Network;
	#[cfg(splicing)]
	use bitcoin::Weight;
	use crate::ln::onion_utils::INVALID_ONION_BLINDING;
	use crate::ln::onion_utils::{ATTRIBUTION_DATA_LEN, INVALID_ONION_BLINDING};
	use crate::types::payment::{PaymentHash, PaymentPreimage};
	use crate::ln::channel_keys::{RevocationKey, RevocationBasepoint};
	use crate::ln::channelmanager::{self, HTLCSource, PaymentId};
Expand DownExpand Up@@ -11378,6 +11455,7 @@ mod tests {
 },
 skimmed_fee_msat: None,
 blinding_point: None,
 timestamp: None,
 });

 // Make sure when Node A calculates their local commitment transaction, none of the HTLCs pass
Expand DownExpand Up@@ -11762,6 +11840,7 @@ mod tests {
 source: dummy_htlc_source.clone(),
 skimmed_fee_msat: None,
 blinding_point: None,
 timestamp: None,
 };
 let mut pending_outbound_htlcs = vec![dummy_outbound_output.clone(); 10];
 for (idx, htlc) in pending_outbound_htlcs.iter_mut().enumerate() {
Expand DownExpand Up@@ -11793,7 +11872,7 @@ mod tests {
 htlc_id: 0,
 };
 let dummy_holding_cell_failed_htlc = |htlc_id| HTLCUpdateAwaitingACK::FailHTLC {
 htlc_id, err_packet: msgs::OnionErrorPacket { data: vec![42] }
 htlc_id, err_packet: msgs::OnionErrorPacket { data: vec![42], attribution_data: Some([1; ATTRIBUTION_DATA_LEN]) }
 };
 let dummy_holding_cell_malformed_htlc = |htlc_id| HTLCUpdateAwaitingACK::FailMalformedHTLC {
 htlc_id, failure_code: INVALID_ONION_BLINDING, sha256_of_onion: [0; 32],
Expand Down
Loading

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

Skip to content
Attributable errors 2025#3611

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

 Closed

joostjager
wants to merge
2
commits into

from

 Closed


Attributable errors 2025
#3611
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
d282ea8

Attributable failures


joostjager Mar 5, 2025
e7923e9

Attributable failures optional feature bit


joostjager Mar 10, 2025

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


8 changes: 7 additions & 1 deletion
lightning-invoice/src/lib.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -597,12 +597,18 @@ impl InvoiceBuilder<tb::False, tb::False, tb::False, tb::False, tb::False, tb::F
	/// Construct new, empty `InvoiceBuilder`. All necessary fields have to be filled first before
	/// `InvoiceBuilder::build(self)` becomes available.
	pub fn new(currency: Currency) -> Self {
 let mut features = Bolt11InvoiceFeatures::empty();
 features.set_attributable_failures_optional();

 let mut tagged_fields = Vec::with_capacity(8);
 tagged_fields.push(TaggedField::Features(features));

 InvoiceBuilder {
 currency,
 amount: None,
 si_prefix: None,
 timestamp: None,
 tagged_fields: Vec::with_capacity(8),
 tagged_fields,
 error: None,

 phantom_d: core::marker::PhantomData,
Expand Down

18 changes: 14 additions & 4 deletions
lightning-types/src/features.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -154,7 +154,7 @@ mod sealed {
 // Byte 3
 RouteBlinding | ShutdownAnySegwit | DualFund | Taproot,
 // Byte 4
 Quiescence | OnionMessages,
 Quiescence | OnionMessages | AttributableFailures,
 // Byte 5
 ProvideStorage | ChannelType | SCIDPrivacy,
 // Byte 6
Expand All@@ -175,7 +175,7 @@ mod sealed {
 // Byte 3
 RouteBlinding | ShutdownAnySegwit | DualFund | Taproot,
 // Byte 4
 Quiescence | OnionMessages,
 Quiescence | OnionMessages | AttributableFailures,
 // Byte 5
 ProvideStorage | ChannelType | SCIDPrivacy,
 // Byte 6
Expand All@@ -199,7 +199,7 @@ mod sealed {
 // Byte 3
 ,
 // Byte 4
 ,
AttributableFailures,
 // Byte 5
 ,
 // Byte 6
Expand All@@ -219,7 +219,7 @@ mod sealed {
 // Byte 3
 ,
 // Byte 4
 ,
AttributableFailures,
 // Byte 5
 ,
 // Byte 6
Expand DownExpand Up@@ -548,6 +548,16 @@ mod sealed {
 supports_quiescence,
 requires_quiescence
	);
	define_feature!(
 37,
 AttributableFailures,
 [InitContext, NodeContext, Bolt11InvoiceContext, Bolt12InvoiceContext],
 "Feature flags for `option_attributable_failures`.",
 set_attributable_failures_optional,
 set_attributable_failures_required,
 supports_attributable_failures,
 requires_attributable_failures
	);
	define_feature!(
 39,
 OnionMessages,
Expand Down

93 changes: 86 additions & 7 deletions
lightning/src/ln/channel.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -50,7 +50,7 @@ use crate::ln::chan_utils::{
#[cfg(splicing)]
use crate::ln::chan_utils::FUNDING_TRANSACTION_WITNESS_WEIGHT;
use crate::ln::chan_utils;
use crate::ln::onion_utils::{HTLCFailReason};
use crate::ln::onion_utils::{HTLCFailReason, ATTRIBUTION_DATA_LEN};
use crate::chain::BestBlock;
use crate::chain::chaininterface::{FeeEstimator, ConfirmationTarget, LowerBoundedFeeEstimator, fee_for_weight};
use crate::chain::channelmonitor::{ChannelMonitor, ChannelMonitorUpdate, ChannelMonitorUpdateStep, LATENCY_GRACE_PERIOD_BLOCKS};
Expand All@@ -68,8 +68,11 @@ use crate::util::scid_utils::scid_from_parts;

use crate::io;
use crate::prelude::*;
use core::time::Duration;
use core::{cmp,mem,fmt};
use core::ops::Deref;
#[cfg(feature = "std")]
use std::time::SystemTime;
#[cfg(any(test, fuzzing, debug_assertions))]
use crate::sync::Mutex;
use crate::sign::type_resolver::ChannelSignerType;
Expand DownExpand Up@@ -323,6 +326,7 @@ struct OutboundHTLCOutput {
	source: HTLCSource,
	blinding_point: Option<PublicKey>,
	skimmed_fee_msat: Option<u64>,
	timestamp: Option<Duration>,
}

/// See AwaitingRemoteRevoke ChannelState for more info
Expand DownExpand Up@@ -4933,7 +4937,7 @@ trait FailHTLCContents {
impl FailHTLCContents for msgs::OnionErrorPacket {
	type Message = msgs::UpdateFailHTLC;
	fn to_message(self, htlc_id: u64, channel_id: ChannelId) -> Self::Message {
 msgs::UpdateFailHTLC { htlc_id, channel_id, reason: self.data }
 msgs::UpdateFailHTLC { htlc_id, channel_id, reason: self.data, attribution_data: self.attribution_data }
	}
	fn to_inbound_htlc_state(self) -> InboundHTLCState {
 InboundHTLCState::LocalRemoved(InboundHTLCRemovalReason::FailRelay(self))
Expand DownExpand Up@@ -6100,10 +6104,16 @@ impl<SP: Deref> FundedChannel<SP> where
 false
 } else { true }
 });
 let now = duration_since_epoch();
 pending_outbound_htlcs.retain(|htlc| {
 if let &OutboundHTLCState::AwaitingRemovedRemoteRevoke(ref outcome) = &htlc.state {
 log_trace!(logger, " ...removing outbound AwaitingRemovedRemoteRevoke {}", &htlc.payment_hash);
 if let OutboundHTLCOutcome::Failure(reason) = outcome.clone() { // We really want take() here, but, again, non-mut ref :(
 if let OutboundHTLCOutcome::Failure(mut reason) = outcome.clone() { // We really want take() here, but, again, non-mut ref :(
 if let (Some(timestamp), Some(now)) = (htlc.timestamp, now) {
 let hold_time = u32::try_from((now - timestamp).as_millis()).unwrap_or(u32::MAX);
 reason.set_hold_time(hold_time);
 }

 revoked_htlcs.push((htlc.source.clone(), htlc.payment_hash, reason));
 } else {
 finalized_claimed_htlcs.push(htlc.source.clone());
Expand DownExpand Up@@ -6845,6 +6855,7 @@ impl<SP: Deref> FundedChannel<SP> where
 channel_id: self.context.channel_id(),
 htlc_id: htlc.htlc_id,
 reason: err_packet.data.clone(),
 attribution_data: err_packet.attribution_data,
 });
 },
 &InboundHTLCRemovalReason::FailMalformed((ref sha256_of_onion, ref failure_code)) => {
Expand DownExpand Up@@ -8671,6 +8682,7 @@ impl<SP: Deref> FundedChannel<SP> where
 return Ok(None);
 }

 let timestamp = duration_since_epoch();
 self.context.pending_outbound_htlcs.push(OutboundHTLCOutput {
 htlc_id: self.context.next_holder_htlc_id,
 amount_msat,
Expand All@@ -8680,6 +8692,7 @@ impl<SP: Deref> FundedChannel<SP> where
 source,
 blinding_point,
 skimmed_fee_msat,
 timestamp,
 });

 let res = msgs::UpdateAddHTLC {
Expand DownExpand Up@@ -10247,6 +10260,7 @@ impl<SP: Deref> Writeable for FundedChannel<SP> where SP::Target: SignerProvider
 dropped_inbound_htlcs += 1;
 }
 }
 let mut removed_htlc_failure_attribution_data: Vec<&Option<[u8; ATTRIBUTION_DATA_LEN]>> = Vec::new();
 (self.context.pending_inbound_htlcs.len() as u64 - dropped_inbound_htlcs).write(writer)?;
 for htlc in self.context.pending_inbound_htlcs.iter() {
 if let &InboundHTLCState::RemoteAnnounced(_) = &htlc.state {
Expand All@@ -10272,9 +10286,10 @@ impl<SP: Deref> Writeable for FundedChannel<SP> where SP::Target: SignerProvider
 &InboundHTLCState::LocalRemoved(ref removal_reason) => {
 4u8.write(writer)?;
 match removal_reason {
Comment thread
joostjager marked this conversation as resolved.

 InboundHTLCRemovalReason::FailRelay(msgs::OnionErrorPacket { data }) => {
 InboundHTLCRemovalReason::FailRelay(msgs::OnionErrorPacket { data, attribution_data }) => {
 0u8.write(writer)?;
 data.write(writer)?;
 removed_htlc_failure_attribution_data.push(&attribution_data);
 },
 InboundHTLCRemovalReason::FailMalformed((hash, code)) => {
 1u8.write(writer)?;
Expand DownExpand Up@@ -10336,10 +10351,11 @@ impl<SP: Deref> Writeable for FundedChannel<SP> where SP::Target: SignerProvider

 let mut holding_cell_skimmed_fees: Vec<Option<u64>> = Vec::new();
 let mut holding_cell_blinding_points: Vec<Option<PublicKey>> = Vec::new();
 let mut holding_cell_failure_attribution_data: Vec<(u32, [u8; ATTRIBUTION_DATA_LEN])> = Vec::new();
 // Vec of (htlc_id, failure_code, sha256_of_onion)
 let mut malformed_htlcs: Vec<(u64, u16, [u8; 32])> = Vec::new();
 (self.context.holding_cell_htlc_updates.len() as u64).write(writer)?;
 for update in self.context.holding_cell_htlc_updates.iter() {
 for (i, update) in self.context.holding_cell_htlc_updates.iter().enumerate() {
 match update {
 &HTLCUpdateAwaitingACK::AddHTLC {
 ref amount_msat, ref cltv_expiry, ref payment_hash, ref source, ref onion_routing_packet,
Expand All@@ -10364,6 +10380,13 @@ impl<SP: Deref> Writeable for FundedChannel<SP> where SP::Target: SignerProvider
 2u8.write(writer)?;
 htlc_id.write(writer)?;
 err_packet.data.write(writer)?;

 // Store the attribution data for later writing. Include the holding cell htlc update index because
 // FailMalformedHTLC is stored with the same type 2 and we wouldn't be able to distinguish the two
 // when reading back in.
 if let Some(attribution_data ) = err_packet.attribution_data {
 holding_cell_failure_attribution_data.push((i as u32, attribution_data));
 }
 }
 &HTLCUpdateAwaitingACK::FailMalformedHTLC {
 htlc_id, failure_code, sha256_of_onion
Expand DownExpand Up@@ -10547,6 +10570,8 @@ impl<SP: Deref> Writeable for FundedChannel<SP> where SP::Target: SignerProvider
 (49, self.context.local_initiated_shutdown, option), // Added in 0.0.122
 (51, is_manual_broadcast, option), // Added in 0.0.124
 (53, funding_tx_broadcast_safe_event_emitted, option), // Added in 0.0.124
 (55, removed_htlc_failure_attribution_data, optional_vec), // Added in 0.2
 (57, holding_cell_failure_attribution_data, optional_vec), // Added in 0.2
 });

 Ok(())
Expand DownExpand Up@@ -10624,6 +10649,7 @@ impl<'a, 'b, 'c, ES: Deref, SP: Deref> ReadableArgs<(&'a ES, &'b SP, &'c Channel
 let reason = match <u8 as Readable>::read(reader)? {
 0 => InboundHTLCRemovalReason::FailRelay(msgs::OnionErrorPacket {
@joostjagerjoostjagerFeb 27, 2025

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Update in holding cell, still waiting for next round of commitment dance. Should be tests that test holding cell persistence.
Strategy: break main, see if tests fail.
@joostjagerjoostjagerMar 3, 2025

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

expect_pending_htlcs_forwardable!(nodes[1]); - in here let node 0 do something else like add another htlc, so that the failure gets into the holding cell
 data: Readable::read(reader)?,
 attribution_data: None,
 }),
 1 => InboundHTLCRemovalReason::FailMalformed(Readable::read(reader)?),
 2 => InboundHTLCRemovalReason::Fulfill(Readable::read(reader)?),
Expand DownExpand Up@@ -10664,6 +10690,7 @@ impl<'a, 'b, 'c, ES: Deref, SP: Deref> ReadableArgs<(&'a ES, &'b SP, &'c Channel
 },
 skimmed_fee_msat: None,
 blinding_point: None,
 timestamp: None,
 });
 }

Expand All@@ -10688,6 +10715,7 @@ impl<'a, 'b, 'c, ES: Deref, SP: Deref> ReadableArgs<(&'a ES, &'b SP, &'c Channel
 htlc_id: Readable::read(reader)?,
 err_packet: OnionErrorPacket {
 data: Readable::read(reader)?,
 attribution_data: None,
 },
 },
 _ => return Err(DecodeError::InvalidValue),
Expand DownExpand Up@@ -10831,6 +10859,9 @@ impl<'a, 'b, 'c, ES: Deref, SP: Deref> ReadableArgs<(&'a ES, &'b SP, &'c Channel
 let mut pending_outbound_blinding_points_opt: Option<Vec<Option<PublicKey>>> = None;
 let mut holding_cell_blinding_points_opt: Option<Vec<Option<PublicKey>>> = None;

 let mut removed_htlc_failure_attribution_data: Option<Vec<Option<[u8; ATTRIBUTION_DATA_LEN]>>> = None;
 let mut holding_cell_failure_attribution_data: Option<Vec<(u32, [u8; ATTRIBUTION_DATA_LEN])>> = None;

 let mut malformed_htlcs: Option<Vec<(u64, u16, [u8; 32])>> = None;
 let mut monitor_pending_update_adds: Option<Vec<msgs::UpdateAddHTLC>> = None;

Expand DownExpand Up@@ -10873,6 +10904,8 @@ impl<'a, 'b, 'c, ES: Deref, SP: Deref> ReadableArgs<(&'a ES, &'b SP, &'c Channel
 (49, local_initiated_shutdown, option),
 (51, is_manual_broadcast, option),
 (53, funding_tx_broadcast_safe_event_emitted, option),
 (55, removed_htlc_failure_attribution_data, optional_vec),
 (57, holding_cell_failure_attribution_data, optional_vec),
 });

 let holder_signer = signer_provider.derive_channel_signer(channel_keys_id);
Expand DownExpand Up@@ -10954,6 +10987,38 @@ impl<'a, 'b, 'c, ES: Deref, SP: Deref> ReadableArgs<(&'a ES, &'b SP, &'c Channel
 if iter.next().is_some() { return Err(DecodeError::InvalidValue) }
 }

 if let Some(attribution_datas) = removed_htlc_failure_attribution_data {
 let mut removed_htlc_relay_failures =
 pending_inbound_htlcs.iter_mut().filter_map(|status|
 if let InboundHTLCState::LocalRemoved(ref mut reason) = &mut status.state {
 if let InboundHTLCRemovalReason::FailRelay(ref mut packet) = reason {
 Some(&mut packet.attribution_data)
 } else {
 None
 }
 } else {
 None
 }
 );

 for attribution_data in attribution_datas {
 *removed_htlc_relay_failures.next().ok_or(DecodeError::InvalidValue)? = attribution_data;
 }
 if removed_htlc_relay_failures.next().is_some() { return Err(DecodeError::InvalidValue); }
 }

 if let Some(attribution_datas) = holding_cell_failure_attribution_data {
 for (i, attribution_data) in attribution_datas {
 let update = holding_cell_htlc_updates.get_mut(i as usize).ok_or(DecodeError::InvalidValue)?;

 if let HTLCUpdateAwaitingACK::FailHTLC { htlc_id: _, ref mut err_packet } = update {
 err_packet.attribution_data = Some(attribution_data);
 } else {
 return Err(DecodeError::InvalidValue);
 }
 }
 }

 if let Some(malformed_htlcs) = malformed_htlcs {
 for (malformed_htlc_id, failure_code, sha256_of_onion) in malformed_htlcs {
 let htlc_idx = holding_cell_htlc_updates.iter().position(|htlc| {
Expand DownExpand Up@@ -11144,6 +11209,18 @@ impl<'a, 'b, 'c, ES: Deref, SP: Deref> ReadableArgs<(&'a ES, &'b SP, &'c Channel
	}
}

fn duration_since_epoch() -> Option<Duration> {
	#[cfg(not(feature = "std"))]
	let now = None;

	#[cfg(feature = "std")]
	let now = Some(std::time::SystemTime::now()
 .duration_since(std::time::SystemTime::UNIX_EPOCH)
 .expect("SystemTime::now() should come after SystemTime::UNIX_EPOCH"));

	now
}

#[cfg(test)]
mod tests {
	use std::cmp;
Expand All@@ -11157,7 +11234,7 @@ mod tests {
	use bitcoin::network::Network;
	#[cfg(splicing)]
	use bitcoin::Weight;
	use crate::ln::onion_utils::INVALID_ONION_BLINDING;
	use crate::ln::onion_utils::{ATTRIBUTION_DATA_LEN, INVALID_ONION_BLINDING};
	use crate::types::payment::{PaymentHash, PaymentPreimage};
	use crate::ln::channel_keys::{RevocationKey, RevocationBasepoint};
	use crate::ln::channelmanager::{self, HTLCSource, PaymentId};
Expand DownExpand Up@@ -11378,6 +11455,7 @@ mod tests {
 },
 skimmed_fee_msat: None,
 blinding_point: None,
 timestamp: None,
 });

 // Make sure when Node A calculates their local commitment transaction, none of the HTLCs pass
Expand DownExpand Up@@ -11762,6 +11840,7 @@ mod tests {
 source: dummy_htlc_source.clone(),
 skimmed_fee_msat: None,
 blinding_point: None,
 timestamp: None,
 };
 let mut pending_outbound_htlcs = vec![dummy_outbound_output.clone(); 10];
 for (idx, htlc) in pending_outbound_htlcs.iter_mut().enumerate() {
Expand DownExpand Up@@ -11793,7 +11872,7 @@ mod tests {
 htlc_id: 0,
 };
 let dummy_holding_cell_failed_htlc = |htlc_id| HTLCUpdateAwaitingACK::FailHTLC {
 htlc_id, err_packet: msgs::OnionErrorPacket { data: vec![42] }
 htlc_id, err_packet: msgs::OnionErrorPacket { data: vec![42], attribution_data: Some([1; ATTRIBUTION_DATA_LEN]) }
 };
 let dummy_holding_cell_malformed_htlc = |htlc_id| HTLCUpdateAwaitingACK::FailMalformedHTLC {
 htlc_id, failure_code: INVALID_ONION_BLINDING, sha256_of_onion: [0; 32],
Expand Down
Loading