Skip to content

Finish migration to tracking all payments by PaymentId#784

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
tnull wants to merge 2 commits into from
Closed

Finish migration to tracking all payments by PaymentId#784

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
c529c40
Make `payment_id` a required field in `Event`s
tnull Feb 4, 2026
0069271
WIP switch to `PaymentId` fully
tnull Feb 4, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions bindings/ldk_node.udl
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -214,9 +214,9 @@ interface Bolt11Payment {
[Throws=NodeError]
void send_probes_using_amount([ByRef]Bolt11Invoice invoice, u64 amount_msat, RouteParametersConfig? route_parameters);
[Throws=NodeError]
void claim_for_hash(PaymentHash payment_hash, u64 claimable_amount_msat, PaymentPreimage preimage);
void claim_for_id(PaymentId payment_id, u64 claimable_amount_msat, PaymentPreimage preimage);
[Throws=NodeError]
void fail_for_hash(PaymentHash payment_hash);
void fail_for_id(PaymentId payment_id);
[Throws=NodeError]
Bolt11Invoice receive(u64 amount_msat, [ByRef]Bolt11InvoiceDescription description, u32 expiry_secs);
[Throws=NodeError]
Expand DownExpand Up@@ -413,9 +413,9 @@ enum VssHeaderProviderError {

[Enum]
interface Event {
PaymentSuccessful(PaymentId? payment_id, PaymentHash payment_hash, PaymentPreimage? payment_preimage, u64? fee_paid_msat);
PaymentFailed(PaymentId? payment_id, PaymentHash? payment_hash, PaymentFailureReason? reason);
PaymentReceived(PaymentId? payment_id, PaymentHash payment_hash, u64 amount_msat, sequence<CustomTlvRecord> custom_records);
PaymentSuccessful(PaymentId payment_id, PaymentHash payment_hash, PaymentPreimage? payment_preimage, u64? fee_paid_msat);
PaymentFailed(PaymentId payment_id, PaymentHash? payment_hash, PaymentFailureReason? reason);
PaymentReceived(PaymentId payment_id, PaymentHash payment_hash, u64 amount_msat, sequence<CustomTlvRecord> custom_records);
PaymentClaimable(PaymentId payment_id, PaymentHash payment_hash, u64 claimable_amount_msat, u32? claim_deadline, sequence<CustomTlvRecord> custom_records);
PaymentForwarded(ChannelId prev_channel_id, ChannelId next_channel_id, UserChannelId?
prev_user_channel_id, UserChannelId? next_user_channel_id, PublicKey? prev_node_id, PublicKey? next_node_id, u64? total_fee_earned_msat, u64? skimmed_fee_msat, boolean claim_from_onchain_tx, u64? outbound_amount_forwarded_msat);
Expand Down
159 changes: 87 additions & 72 deletions src/event.rs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -62,9 +62,7 @@ pub enum Event {
/// A sent payment was successful.
PaymentSuccessful {
/// A local identifier used to track the payment.
///
/// Will only be `None` for events serialized with LDK Node v0.2.1 or prior.
payment_id: Option<PaymentId>,
payment_id: PaymentId,
/// The hash of the payment.
payment_hash: PaymentHash,
/// The preimage to the `payment_hash`.
Expand All@@ -79,9 +77,7 @@ pub enum Event {
/// A sent payment has failed.
PaymentFailed {
/// A local identifier used to track the payment.
///
/// Will only be `None` for events serialized with LDK Node v0.2.1 or prior.
payment_id: Option<PaymentId>,
payment_id: PaymentId,
/// The hash of the payment.
///
/// This will be `None` if the payment failed before receiving an invoice when paying a
Expand All@@ -97,9 +93,7 @@ pub enum Event {
/// A payment has been received.
PaymentReceived {
/// A local identifier used to track the payment.
///
/// Will only be `None` for events serialized with LDK Node v0.2.1 or prior.
payment_id: Option<PaymentId>,
payment_id: PaymentId,
/// The hash of the payment.
payment_hash: PaymentHash,
/// The value, in thousandths of a satoshi, that has been received.
Expand DownExpand Up@@ -262,17 +256,17 @@ impl_writeable_tlv_based_enum!(Event,
(0, PaymentSuccessful) => {
(0, payment_hash, required),
(1, fee_paid_msat, option),
(3, payment_id, option),
(3, payment_id, required),
(5, payment_preimage, option),
},
(1, PaymentFailed) => {
(0, payment_hash, option),
(1, reason, upgradable_option),
(3, payment_id, option),
(3, payment_id, required),
},
(2, PaymentReceived) => {
(0, payment_hash, required),
(1, payment_id, option),
(1, payment_id, required),
(2, amount_msat, required),
(3, custom_records, optional_vec),
},
Expand DownExpand Up@@ -641,9 +635,10 @@ where
claim_deadline,
onion_fields,
counterparty_skimmed_fee_msat,
payment_id,
..
} => {
let payment_id = PaymentId(payment_hash.0);
let payment_id = payment_id.unwrap_or(PaymentId(payment_hash.0));
if let Some(info) = self.payment_store.get(&payment_id) {
if info.direction == PaymentDirection::Outbound {
log_info!(
Expand DownExpand Up@@ -750,46 +745,6 @@ where
_ => debug_assert!(false, "We only expect the counterparty to get away with withholding fees for JIT payments."),
}
}

// If this is known by the store but ChannelManager doesn't know the preimage,
// the payment has been registered via `_for_hash` variants and needs to be manually claimed via
// user interaction.
match info.kind {
PaymentKind::Bolt11 { preimage, .. }
| PaymentKind::Bolt11Jit { preimage, .. } => {
if purpose.preimage().is_none() {
debug_assert!(
preimage.is_none(),
"We would have registered the preimage if we knew"
);

let custom_records = onion_fields
.map(|cf| {
cf.custom_tlvs().into_iter().map(|tlv| tlv.into()).collect()
})
.unwrap_or_default();
let event = Event::PaymentClaimable {
payment_id,
payment_hash,
claimable_amount_msat: amount_msat,
claim_deadline,
custom_records,
};
match self.event_queue.add_event(event).await {
Ok(_) => return Ok(()),
Err(e) => {
log_error!(
self.logger,
"Failed to push to event queue: {}",
e
);
return Err(ReplayEvent());
},
};
}
},
_ => {},
}
}

log_info!(
Expand All@@ -799,7 +754,46 @@ where
amount_msat,
);
let payment_preimage = match purpose {
PaymentPurpose::Bolt11InvoicePayment { payment_preimage, .. } => {
PaymentPurpose::Bolt11InvoicePayment {
payment_preimage,
payment_secret,
..
} => {
let kind = PaymentKind::Bolt11 {
hash: payment_hash,
preimage: payment_preimage,
secret: Some(payment_secret),
};

let payment = PaymentDetails::new(
payment_id,
kind,
Some(amount_msat),
None,
PaymentDirection::Inbound,
PaymentStatus::Pending,
);

match self.payment_store.insert(payment) {
Ok(false) => (),
Ok(true) => {
log_error!(
self.logger,
"Bolt11InvoicePayment with ID {} was previously known",
payment_id,
);
debug_assert!(false);
},
Err(e) => {
log_error!(
self.logger,
"Failed to insert payment with ID {}: {}",
payment_id,
e
);
debug_assert!(false);
},
}
payment_preimage
},
PaymentPurpose::Bolt12OfferPayment {
Expand DownExpand Up@@ -898,25 +892,47 @@ where
if let Some(preimage) = payment_preimage {
self.channel_manager.claim_funds(preimage);
} else {
log_error!(
self.logger,
"Failed to claim payment with ID {}: preimage unknown.",
// If ChannelManager doesn't know the preimage the payment needs to be
// manually claimed via user interaction.
//if purpose.preimage().is_none() {
let custom_records = onion_fields
.map(|cf| cf.custom_tlvs().into_iter().map(|tlv| tlv.into()).collect())
.unwrap_or_default();
let event = Event::PaymentClaimable {
payment_id,
);
self.channel_manager.fail_htlc_backwards(&payment_hash);

let update = PaymentDetailsUpdate {
hash: Some(Some(payment_hash)),
status: Some(PaymentStatus::Failed),
..PaymentDetailsUpdate::new(payment_id)
payment_hash,
claimable_amount_msat: amount_msat,
claim_deadline,
custom_records,
};
match self.payment_store.update(&update) {
match self.event_queue.add_event(event).await {
Ok(_) => return Ok(()),
Err(e) => {
log_error!(self.logger, "Failed to access payment store: {}", e);
log_error!(self.logger, "Failed to push to event queue: {}", e);
return Err(ReplayEvent());
},
};
//}

//log_error!(
// self.logger,
// "Failed to claim payment with ID {}: preimage unknown.",
// payment_id,
//);
//self.channel_manager.fail_htlc_backwards(&payment_hash);

//let update = PaymentDetailsUpdate {
// hash: Some(Some(payment_hash)),
// status: Some(PaymentStatus::Failed),
// ..PaymentDetailsUpdate::new(payment_id)
//};
//match self.payment_store.update(&update) {
// Ok(_) => return Ok(()),
// Err(e) => {
// log_error!(self.logger, "Failed to access payment store: {}", e);
// return Err(ReplayEvent());
// },
//};
}
},
LdkEvent::PaymentClaimed {
Expand All@@ -927,9 +943,9 @@ where
htlcs: _,
sender_intended_total_msat: _,
onion_fields,
payment_id: _,
payment_id,
} => {
let payment_id = PaymentId(payment_hash.0);
let payment_id = payment_id.unwrap_or(PaymentId(payment_hash.0));
log_info!(
self.logger,
"Claimed payment with ID {} from payment hash {} of {}msat.",
Expand DownExpand Up@@ -1002,7 +1018,7 @@ where
}

let event = Event::PaymentReceived {
payment_id: Some(payment_id),
payment_id,
payment_hash,
amount_msat,
custom_records: onion_fields
Expand DownExpand Up@@ -1063,7 +1079,7 @@ where
);
});
let event = Event::PaymentSuccessful {
payment_id: Some(payment_id),
payment_id,
payment_hash,
payment_preimage: Some(payment_preimage),
fee_paid_msat,
Expand DownExpand Up@@ -1098,8 +1114,7 @@ where
},
};

let event =
Event::PaymentFailed { payment_id: Some(payment_id), payment_hash, reason };
let event = Event::PaymentFailed { payment_id, payment_hash, reason };
match self.event_queue.add_event(event).await {
Ok(_) => return Ok(()),
Err(e) => {
Expand Down
Loading
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Add copy buttons to all 
 blocks
(function() {
function addCopyButtons() {
document.querySelectorAll('pre code').forEach(function(codeBlock) {
if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;
codeBlock.parentElement.setAttribute('data-copy-added', 'true');
var btn = document.createElement('button');
btn.textContent = 'Copy';
btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';
btn.onmouseover = function() { this.style.opacity = '1'; };
btn.onmouseout = function() { this.style.opacity = '0.7'; };
btn.onclick = function() {
navigator.clipboard.writeText(codeBlock.textContent).then(function() {
btn.textContent = 'Copied!';
setTimeout(function() { btn.textContent = 'Copy'; }, 1500);
});
};
codeBlock.parentElement.style.position = 'relative';
codeBlock.parentElement.appendChild(btn);
});
}
addCopyButtons();
// Re-run on dynamic content
var observer = new MutationObserver(addCopyButtons);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
Finish migration to tracking all payments by `PaymentId` by tnull · Pull Request #784 · lightningdevkit/ldk-node · GitHub
Skip to content
Finish migration to tracking all payments by PaymentId#784

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

tnull
wants to merge
2
commits into

from

 Closed


Finish migration to tracking all payments by PaymentId#784
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
c529c40

Make `payment_id` a required field in `Event`s


tnull Feb 4, 2026
0069271

WIP switch to `PaymentId` fully


tnull Feb 4, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


10 changes: 5 additions & 5 deletions
bindings/ldk_node.udl

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -214,9 +214,9 @@ interface Bolt11Payment {
	[Throws=NodeError]
	void send_probes_using_amount([ByRef]Bolt11Invoice invoice, u64 amount_msat, RouteParametersConfig? route_parameters);
	[Throws=NodeError]
	void claim_for_hash(PaymentHash payment_hash, u64 claimable_amount_msat, PaymentPreimage preimage);
	void claim_for_id(PaymentId payment_id, u64 claimable_amount_msat, PaymentPreimage preimage);
	[Throws=NodeError]
	void fail_for_hash(PaymentHash payment_hash);
	void fail_for_id(PaymentId payment_id);
	[Throws=NodeError]
	Bolt11Invoice receive(u64 amount_msat, [ByRef]Bolt11InvoiceDescription description, u32 expiry_secs);
	[Throws=NodeError]
Expand DownExpand Up@@ -413,9 +413,9 @@ enum VssHeaderProviderError {

[Enum]
interface Event {
	PaymentSuccessful(PaymentId? payment_id, PaymentHash payment_hash, PaymentPreimage? payment_preimage, u64? fee_paid_msat);
	PaymentFailed(PaymentId? payment_id, PaymentHash? payment_hash, PaymentFailureReason? reason);
	PaymentReceived(PaymentId? payment_id, PaymentHash payment_hash, u64 amount_msat, sequence<CustomTlvRecord> custom_records);
	PaymentSuccessful(PaymentId payment_id, PaymentHash payment_hash, PaymentPreimage? payment_preimage, u64? fee_paid_msat);
	PaymentFailed(PaymentId payment_id, PaymentHash? payment_hash, PaymentFailureReason? reason);
	PaymentReceived(PaymentId payment_id, PaymentHash payment_hash, u64 amount_msat, sequence<CustomTlvRecord> custom_records);
	PaymentClaimable(PaymentId payment_id, PaymentHash payment_hash, u64 claimable_amount_msat, u32? claim_deadline, sequence<CustomTlvRecord> custom_records);
	PaymentForwarded(ChannelId prev_channel_id, ChannelId next_channel_id, UserChannelId?
	prev_user_channel_id, UserChannelId? next_user_channel_id, PublicKey? prev_node_id, PublicKey? next_node_id, u64? total_fee_earned_msat, u64? skimmed_fee_msat, boolean claim_from_onchain_tx, u64? outbound_amount_forwarded_msat);
Expand Down

159 changes: 87 additions & 72 deletions
src/event.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -62,9 +62,7 @@ pub enum Event {
	/// A sent payment was successful.
	PaymentSuccessful {
 /// A local identifier used to track the payment.
 ///
 /// Will only be `None` for events serialized with LDK Node v0.2.1 or prior.
 payment_id: Option<PaymentId>,
 payment_id: PaymentId,
 /// The hash of the payment.
 payment_hash: PaymentHash,
 /// The preimage to the `payment_hash`.
Expand All@@ -79,9 +77,7 @@ pub enum Event {
	/// A sent payment has failed.
	PaymentFailed {
 /// A local identifier used to track the payment.
 ///
 /// Will only be `None` for events serialized with LDK Node v0.2.1 or prior.
 payment_id: Option<PaymentId>,
 payment_id: PaymentId,
 /// The hash of the payment.
 ///
 /// This will be `None` if the payment failed before receiving an invoice when paying a
Expand All@@ -97,9 +93,7 @@ pub enum Event {
	/// A payment has been received.
	PaymentReceived {
 /// A local identifier used to track the payment.
 ///
 /// Will only be `None` for events serialized with LDK Node v0.2.1 or prior.
 payment_id: Option<PaymentId>,
 payment_id: PaymentId,
 /// The hash of the payment.
 payment_hash: PaymentHash,
 /// The value, in thousandths of a satoshi, that has been received.
Expand DownExpand Up@@ -262,17 +256,17 @@ impl_writeable_tlv_based_enum!(Event,
	(0, PaymentSuccessful) => {
 (0, payment_hash, required),
 (1, fee_paid_msat, option),
 (3, payment_id, option),
 (3, payment_id, required),
 (5, payment_preimage, option),
	},
	(1, PaymentFailed) => {
 (0, payment_hash, option),
 (1, reason, upgradable_option),
 (3, payment_id, option),
 (3, payment_id, required),
	},
	(2, PaymentReceived) => {
 (0, payment_hash, required),
 (1, payment_id, option),
 (1, payment_id, required),
 (2, amount_msat, required),
 (3, custom_records, optional_vec),
	},
Expand DownExpand Up@@ -641,9 +635,10 @@ where
 claim_deadline,
 onion_fields,
 counterparty_skimmed_fee_msat,
 payment_id,
 ..
 } => {
 let payment_id = PaymentId(payment_hash.0);
 let payment_id = payment_id.unwrap_or(PaymentId(payment_hash.0));
 if let Some(info) = self.payment_store.get(&payment_id) {
 if info.direction == PaymentDirection::Outbound {
 log_info!(
Expand DownExpand Up@@ -750,46 +745,6 @@ where
 _ => debug_assert!(false, "We only expect the counterparty to get away with withholding fees for JIT payments."),
 }
 }

 // If this is known by the store but ChannelManager doesn't know the preimage,
 // the payment has been registered via `_for_hash` variants and needs to be manually claimed via
 // user interaction.
 match info.kind {
 PaymentKind::Bolt11 { preimage, .. }
 | PaymentKind::Bolt11Jit { preimage, .. } => {
 if purpose.preimage().is_none() {
 debug_assert!(
 preimage.is_none(),
 "We would have registered the preimage if we knew"
 );

 let custom_records = onion_fields
 .map(|cf| {
 cf.custom_tlvs().into_iter().map(|tlv| tlv.into()).collect()
 })
 .unwrap_or_default();
 let event = Event::PaymentClaimable {
 payment_id,
 payment_hash,
 claimable_amount_msat: amount_msat,
 claim_deadline,
 custom_records,
 };
 match self.event_queue.add_event(event).await {
 Ok(_) => return Ok(()),
 Err(e) => {
 log_error!(
 self.logger,
 "Failed to push to event queue: {}",
 e
 );
 return Err(ReplayEvent());
 },
 };
 }
 },
 _ => {},
 }
 }

 log_info!(
Expand All@@ -799,7 +754,46 @@ where
 amount_msat,
 );
 let payment_preimage = match purpose {
 PaymentPurpose::Bolt11InvoicePayment { payment_preimage, .. } => {
 PaymentPurpose::Bolt11InvoicePayment {
 payment_preimage,
 payment_secret,
 ..
 } => {
 let kind = PaymentKind::Bolt11 {
 hash: payment_hash,
 preimage: payment_preimage,
 secret: Some(payment_secret),
 };

 let payment = PaymentDetails::new(
 payment_id,
 kind,
 Some(amount_msat),
 None,
 PaymentDirection::Inbound,
 PaymentStatus::Pending,
 );

 match self.payment_store.insert(payment) {
 Ok(false) => (),
 Ok(true) => {
 log_error!(
 self.logger,
 "Bolt11InvoicePayment with ID {} was previously known",
 payment_id,
 );
 debug_assert!(false);
 },
 Err(e) => {
 log_error!(
 self.logger,
 "Failed to insert payment with ID {}: {}",
 payment_id,
 e
 );
 debug_assert!(false);
 },
 }
 payment_preimage
 },
 PaymentPurpose::Bolt12OfferPayment {
Expand DownExpand Up@@ -898,25 +892,47 @@ where
 if let Some(preimage) = payment_preimage {
 self.channel_manager.claim_funds(preimage);
 } else {
 log_error!(
 self.logger,
 "Failed to claim payment with ID {}: preimage unknown.",
 // If ChannelManager doesn't know the preimage the payment needs to be
 // manually claimed via user interaction.
 //if purpose.preimage().is_none() {
 let custom_records = onion_fields
 .map(|cf| cf.custom_tlvs().into_iter().map(|tlv| tlv.into()).collect())
 .unwrap_or_default();
 let event = Event::PaymentClaimable {
 payment_id,
 );
 self.channel_manager.fail_htlc_backwards(&payment_hash);

 let update = PaymentDetailsUpdate {
 hash: Some(Some(payment_hash)),
 status: Some(PaymentStatus::Failed),
 ..PaymentDetailsUpdate::new(payment_id)
 payment_hash,
 claimable_amount_msat: amount_msat,
 claim_deadline,
 custom_records,
 };
 match self.payment_store.update(&update) {
 match self.event_queue.add_event(event).await {
 Ok(_) => return Ok(()),
 Err(e) => {
 log_error!(self.logger, "Failed to access payment store: {}", e);
 log_error!(self.logger, "Failed to push to event queue: {}", e);
 return Err(ReplayEvent());
 },
 };
 //}

 //log_error!(
 //	self.logger,
 //	"Failed to claim payment with ID {}: preimage unknown.",
 //	payment_id,
 //);
 //self.channel_manager.fail_htlc_backwards(&payment_hash);

 //let update = PaymentDetailsUpdate {
 //	hash: Some(Some(payment_hash)),
 //	status: Some(PaymentStatus::Failed),
 //	..PaymentDetailsUpdate::new(payment_id)
 //};
 //match self.payment_store.update(&update) {
 //	Ok(_) => return Ok(()),
 //	Err(e) => {
 // log_error!(self.logger, "Failed to access payment store: {}", e);
 // return Err(ReplayEvent());
 //	},
 //};
 }
 },
 LdkEvent::PaymentClaimed {
Expand All@@ -927,9 +943,9 @@ where
 htlcs: _,
 sender_intended_total_msat: _,
 onion_fields,
 payment_id: _,
 payment_id,
 } => {
 let payment_id = PaymentId(payment_hash.0);
 let payment_id = payment_id.unwrap_or(PaymentId(payment_hash.0));
 log_info!(
 self.logger,
 "Claimed payment with ID {} from payment hash {} of {}msat.",
Expand DownExpand Up@@ -1002,7 +1018,7 @@ where
 }

 let event = Event::PaymentReceived {
 payment_id: Some(payment_id),
 payment_id,
 payment_hash,
 amount_msat,
 custom_records: onion_fields
Expand DownExpand Up@@ -1063,7 +1079,7 @@ where
 );
 });
 let event = Event::PaymentSuccessful {
 payment_id: Some(payment_id),
 payment_id,
 payment_hash,
 payment_preimage: Some(payment_preimage),
 fee_paid_msat,
Expand DownExpand Up@@ -1098,8 +1114,7 @@ where
 },
 };

 let event =
 Event::PaymentFailed { payment_id: Some(payment_id), payment_hash, reason };
 let event = Event::PaymentFailed { payment_id, payment_hash, reason };
 match self.event_queue.add_event(event).await {
 Ok(_) => return Ok(()),
 Err(e) => {
Expand Down
Loading
Loading

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

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

tnull
wants to merge
2
commits into

from

 Closed


Finish migration to tracking all payments by PaymentId#784
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
c529c40

Make `payment_id` a required field in `Event`s


tnull Feb 4, 2026
0069271

WIP switch to `PaymentId` fully


tnull Feb 4, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


10 changes: 5 additions & 5 deletions
bindings/ldk_node.udl

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -214,9 +214,9 @@ interface Bolt11Payment {
	[Throws=NodeError]
	void send_probes_using_amount([ByRef]Bolt11Invoice invoice, u64 amount_msat, RouteParametersConfig? route_parameters);
	[Throws=NodeError]
	void claim_for_hash(PaymentHash payment_hash, u64 claimable_amount_msat, PaymentPreimage preimage);
	void claim_for_id(PaymentId payment_id, u64 claimable_amount_msat, PaymentPreimage preimage);
	[Throws=NodeError]
	void fail_for_hash(PaymentHash payment_hash);
	void fail_for_id(PaymentId payment_id);
	[Throws=NodeError]
	Bolt11Invoice receive(u64 amount_msat, [ByRef]Bolt11InvoiceDescription description, u32 expiry_secs);
	[Throws=NodeError]
Expand DownExpand Up@@ -413,9 +413,9 @@ enum VssHeaderProviderError {

[Enum]
interface Event {
	PaymentSuccessful(PaymentId? payment_id, PaymentHash payment_hash, PaymentPreimage? payment_preimage, u64? fee_paid_msat);
	PaymentFailed(PaymentId? payment_id, PaymentHash? payment_hash, PaymentFailureReason? reason);
	PaymentReceived(PaymentId? payment_id, PaymentHash payment_hash, u64 amount_msat, sequence<CustomTlvRecord> custom_records);
	PaymentSuccessful(PaymentId payment_id, PaymentHash payment_hash, PaymentPreimage? payment_preimage, u64? fee_paid_msat);
	PaymentFailed(PaymentId payment_id, PaymentHash? payment_hash, PaymentFailureReason? reason);
	PaymentReceived(PaymentId payment_id, PaymentHash payment_hash, u64 amount_msat, sequence<CustomTlvRecord> custom_records);
	PaymentClaimable(PaymentId payment_id, PaymentHash payment_hash, u64 claimable_amount_msat, u32? claim_deadline, sequence<CustomTlvRecord> custom_records);
	PaymentForwarded(ChannelId prev_channel_id, ChannelId next_channel_id, UserChannelId?
	prev_user_channel_id, UserChannelId? next_user_channel_id, PublicKey? prev_node_id, PublicKey? next_node_id, u64? total_fee_earned_msat, u64? skimmed_fee_msat, boolean claim_from_onchain_tx, u64? outbound_amount_forwarded_msat);
Expand Down

159 changes: 87 additions & 72 deletions
src/event.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -62,9 +62,7 @@ pub enum Event {
	/// A sent payment was successful.
	PaymentSuccessful {
 /// A local identifier used to track the payment.
 ///
 /// Will only be `None` for events serialized with LDK Node v0.2.1 or prior.
 payment_id: Option<PaymentId>,
 payment_id: PaymentId,
 /// The hash of the payment.
 payment_hash: PaymentHash,
 /// The preimage to the `payment_hash`.
Expand All@@ -79,9 +77,7 @@ pub enum Event {
	/// A sent payment has failed.
	PaymentFailed {
 /// A local identifier used to track the payment.
 ///
 /// Will only be `None` for events serialized with LDK Node v0.2.1 or prior.
 payment_id: Option<PaymentId>,
 payment_id: PaymentId,
 /// The hash of the payment.
 ///
 /// This will be `None` if the payment failed before receiving an invoice when paying a
Expand All@@ -97,9 +93,7 @@ pub enum Event {
	/// A payment has been received.
	PaymentReceived {
 /// A local identifier used to track the payment.
 ///
 /// Will only be `None` for events serialized with LDK Node v0.2.1 or prior.
 payment_id: Option<PaymentId>,
 payment_id: PaymentId,
 /// The hash of the payment.
 payment_hash: PaymentHash,
 /// The value, in thousandths of a satoshi, that has been received.
Expand DownExpand Up@@ -262,17 +256,17 @@ impl_writeable_tlv_based_enum!(Event,
	(0, PaymentSuccessful) => {
 (0, payment_hash, required),
 (1, fee_paid_msat, option),
 (3, payment_id, option),
 (3, payment_id, required),
 (5, payment_preimage, option),
	},
	(1, PaymentFailed) => {
 (0, payment_hash, option),
 (1, reason, upgradable_option),
 (3, payment_id, option),
 (3, payment_id, required),
	},
	(2, PaymentReceived) => {
 (0, payment_hash, required),
 (1, payment_id, option),
 (1, payment_id, required),
 (2, amount_msat, required),
 (3, custom_records, optional_vec),
	},
Expand DownExpand Up@@ -641,9 +635,10 @@ where
 claim_deadline,
 onion_fields,
 counterparty_skimmed_fee_msat,
 payment_id,
 ..
 } => {
 let payment_id = PaymentId(payment_hash.0);
 let payment_id = payment_id.unwrap_or(PaymentId(payment_hash.0));
 if let Some(info) = self.payment_store.get(&payment_id) {
 if info.direction == PaymentDirection::Outbound {
 log_info!(
Expand DownExpand Up@@ -750,46 +745,6 @@ where
 _ => debug_assert!(false, "We only expect the counterparty to get away with withholding fees for JIT payments."),
 }
 }

 // If this is known by the store but ChannelManager doesn't know the preimage,
 // the payment has been registered via `_for_hash` variants and needs to be manually claimed via
 // user interaction.
 match info.kind {
 PaymentKind::Bolt11 { preimage, .. }
 | PaymentKind::Bolt11Jit { preimage, .. } => {
 if purpose.preimage().is_none() {
 debug_assert!(
 preimage.is_none(),
 "We would have registered the preimage if we knew"
 );

 let custom_records = onion_fields
 .map(|cf| {
 cf.custom_tlvs().into_iter().map(|tlv| tlv.into()).collect()
 })
 .unwrap_or_default();
 let event = Event::PaymentClaimable {
 payment_id,
 payment_hash,
 claimable_amount_msat: amount_msat,
 claim_deadline,
 custom_records,
 };
 match self.event_queue.add_event(event).await {
 Ok(_) => return Ok(()),
 Err(e) => {
 log_error!(
 self.logger,
 "Failed to push to event queue: {}",
 e
 );
 return Err(ReplayEvent());
 },
 };
 }
 },
 _ => {},
 }
 }

 log_info!(
Expand All@@ -799,7 +754,46 @@ where
 amount_msat,
 );
 let payment_preimage = match purpose {
 PaymentPurpose::Bolt11InvoicePayment { payment_preimage, .. } => {
 PaymentPurpose::Bolt11InvoicePayment {
 payment_preimage,
 payment_secret,
 ..
 } => {
 let kind = PaymentKind::Bolt11 {
 hash: payment_hash,
 preimage: payment_preimage,
 secret: Some(payment_secret),
 };

 let payment = PaymentDetails::new(
 payment_id,
 kind,
 Some(amount_msat),
 None,
 PaymentDirection::Inbound,
 PaymentStatus::Pending,
 );

 match self.payment_store.insert(payment) {
 Ok(false) => (),
 Ok(true) => {
 log_error!(
 self.logger,
 "Bolt11InvoicePayment with ID {} was previously known",
 payment_id,
 );
 debug_assert!(false);
 },
 Err(e) => {
 log_error!(
 self.logger,
 "Failed to insert payment with ID {}: {}",
 payment_id,
 e
 );
 debug_assert!(false);
 },
 }
 payment_preimage
 },
 PaymentPurpose::Bolt12OfferPayment {
Expand DownExpand Up@@ -898,25 +892,47 @@ where
 if let Some(preimage) = payment_preimage {
 self.channel_manager.claim_funds(preimage);
 } else {
 log_error!(
 self.logger,
 "Failed to claim payment with ID {}: preimage unknown.",
 // If ChannelManager doesn't know the preimage the payment needs to be
 // manually claimed via user interaction.
 //if purpose.preimage().is_none() {
 let custom_records = onion_fields
 .map(|cf| cf.custom_tlvs().into_iter().map(|tlv| tlv.into()).collect())
 .unwrap_or_default();
 let event = Event::PaymentClaimable {
 payment_id,
 );
 self.channel_manager.fail_htlc_backwards(&payment_hash);

 let update = PaymentDetailsUpdate {
 hash: Some(Some(payment_hash)),
 status: Some(PaymentStatus::Failed),
 ..PaymentDetailsUpdate::new(payment_id)
 payment_hash,
 claimable_amount_msat: amount_msat,
 claim_deadline,
 custom_records,
 };
 match self.payment_store.update(&update) {
 match self.event_queue.add_event(event).await {
 Ok(_) => return Ok(()),
 Err(e) => {
 log_error!(self.logger, "Failed to access payment store: {}", e);
 log_error!(self.logger, "Failed to push to event queue: {}", e);
 return Err(ReplayEvent());
 },
 };
 //}

 //log_error!(
 //	self.logger,
 //	"Failed to claim payment with ID {}: preimage unknown.",
 //	payment_id,
 //);
 //self.channel_manager.fail_htlc_backwards(&payment_hash);

 //let update = PaymentDetailsUpdate {
 //	hash: Some(Some(payment_hash)),
 //	status: Some(PaymentStatus::Failed),
 //	..PaymentDetailsUpdate::new(payment_id)
 //};
 //match self.payment_store.update(&update) {
 //	Ok(_) => return Ok(()),
 //	Err(e) => {
 // log_error!(self.logger, "Failed to access payment store: {}", e);
 // return Err(ReplayEvent());
 //	},
 //};
 }
 },
 LdkEvent::PaymentClaimed {
Expand All@@ -927,9 +943,9 @@ where
 htlcs: _,
 sender_intended_total_msat: _,
 onion_fields,
 payment_id: _,
 payment_id,
 } => {
 let payment_id = PaymentId(payment_hash.0);
 let payment_id = payment_id.unwrap_or(PaymentId(payment_hash.0));
 log_info!(
 self.logger,
 "Claimed payment with ID {} from payment hash {} of {}msat.",
Expand DownExpand Up@@ -1002,7 +1018,7 @@ where
 }

 let event = Event::PaymentReceived {
 payment_id: Some(payment_id),
 payment_id,
 payment_hash,
 amount_msat,
 custom_records: onion_fields
Expand DownExpand Up@@ -1063,7 +1079,7 @@ where
 );
 });
 let event = Event::PaymentSuccessful {
 payment_id: Some(payment_id),
 payment_id,
 payment_hash,
 payment_preimage: Some(payment_preimage),
 fee_paid_msat,
Expand DownExpand Up@@ -1098,8 +1114,7 @@ where
 },
 };

 let event =
 Event::PaymentFailed { payment_id: Some(payment_id), payment_hash, reason };
 let event = Event::PaymentFailed { payment_id, payment_hash, reason };
 match self.event_queue.add_event(event).await {
 Ok(_) => return Ok(()),
 Err(e) => {
Expand Down
Loading
Loading

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

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

tnull
wants to merge
2
commits into

from

 Closed


Finish migration to tracking all payments by PaymentId#784
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
c529c40

Make `payment_id` a required field in `Event`s


tnull Feb 4, 2026
0069271

WIP switch to `PaymentId` fully


tnull Feb 4, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


10 changes: 5 additions & 5 deletions
bindings/ldk_node.udl

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -214,9 +214,9 @@ interface Bolt11Payment {
	[Throws=NodeError]
	void send_probes_using_amount([ByRef]Bolt11Invoice invoice, u64 amount_msat, RouteParametersConfig? route_parameters);
	[Throws=NodeError]
	void claim_for_hash(PaymentHash payment_hash, u64 claimable_amount_msat, PaymentPreimage preimage);
	void claim_for_id(PaymentId payment_id, u64 claimable_amount_msat, PaymentPreimage preimage);
	[Throws=NodeError]
	void fail_for_hash(PaymentHash payment_hash);
	void fail_for_id(PaymentId payment_id);
	[Throws=NodeError]
	Bolt11Invoice receive(u64 amount_msat, [ByRef]Bolt11InvoiceDescription description, u32 expiry_secs);
	[Throws=NodeError]
Expand DownExpand Up@@ -413,9 +413,9 @@ enum VssHeaderProviderError {

[Enum]
interface Event {
	PaymentSuccessful(PaymentId? payment_id, PaymentHash payment_hash, PaymentPreimage? payment_preimage, u64? fee_paid_msat);
	PaymentFailed(PaymentId? payment_id, PaymentHash? payment_hash, PaymentFailureReason? reason);
	PaymentReceived(PaymentId? payment_id, PaymentHash payment_hash, u64 amount_msat, sequence<CustomTlvRecord> custom_records);
	PaymentSuccessful(PaymentId payment_id, PaymentHash payment_hash, PaymentPreimage? payment_preimage, u64? fee_paid_msat);
	PaymentFailed(PaymentId payment_id, PaymentHash? payment_hash, PaymentFailureReason? reason);
	PaymentReceived(PaymentId payment_id, PaymentHash payment_hash, u64 amount_msat, sequence<CustomTlvRecord> custom_records);
	PaymentClaimable(PaymentId payment_id, PaymentHash payment_hash, u64 claimable_amount_msat, u32? claim_deadline, sequence<CustomTlvRecord> custom_records);
	PaymentForwarded(ChannelId prev_channel_id, ChannelId next_channel_id, UserChannelId?
	prev_user_channel_id, UserChannelId? next_user_channel_id, PublicKey? prev_node_id, PublicKey? next_node_id, u64? total_fee_earned_msat, u64? skimmed_fee_msat, boolean claim_from_onchain_tx, u64? outbound_amount_forwarded_msat);
Expand Down

159 changes: 87 additions & 72 deletions
src/event.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -62,9 +62,7 @@ pub enum Event {
	/// A sent payment was successful.
	PaymentSuccessful {
 /// A local identifier used to track the payment.
 ///
 /// Will only be `None` for events serialized with LDK Node v0.2.1 or prior.
 payment_id: Option<PaymentId>,
 payment_id: PaymentId,
 /// The hash of the payment.
 payment_hash: PaymentHash,
 /// The preimage to the `payment_hash`.
Expand All@@ -79,9 +77,7 @@ pub enum Event {
	/// A sent payment has failed.
	PaymentFailed {
 /// A local identifier used to track the payment.
 ///
 /// Will only be `None` for events serialized with LDK Node v0.2.1 or prior.
 payment_id: Option<PaymentId>,
 payment_id: PaymentId,
 /// The hash of the payment.
 ///
 /// This will be `None` if the payment failed before receiving an invoice when paying a
Expand All@@ -97,9 +93,7 @@ pub enum Event {
	/// A payment has been received.
	PaymentReceived {
 /// A local identifier used to track the payment.
 ///
 /// Will only be `None` for events serialized with LDK Node v0.2.1 or prior.
 payment_id: Option<PaymentId>,
 payment_id: PaymentId,
 /// The hash of the payment.
 payment_hash: PaymentHash,
 /// The value, in thousandths of a satoshi, that has been received.
Expand DownExpand Up@@ -262,17 +256,17 @@ impl_writeable_tlv_based_enum!(Event,
	(0, PaymentSuccessful) => {
 (0, payment_hash, required),
 (1, fee_paid_msat, option),
 (3, payment_id, option),
 (3, payment_id, required),
 (5, payment_preimage, option),
	},
	(1, PaymentFailed) => {
 (0, payment_hash, option),
 (1, reason, upgradable_option),
 (3, payment_id, option),
 (3, payment_id, required),
	},
	(2, PaymentReceived) => {
 (0, payment_hash, required),
 (1, payment_id, option),
 (1, payment_id, required),
 (2, amount_msat, required),
 (3, custom_records, optional_vec),
	},
Expand DownExpand Up@@ -641,9 +635,10 @@ where
 claim_deadline,
 onion_fields,
 counterparty_skimmed_fee_msat,
 payment_id,
 ..
 } => {
 let payment_id = PaymentId(payment_hash.0);
 let payment_id = payment_id.unwrap_or(PaymentId(payment_hash.0));
 if let Some(info) = self.payment_store.get(&payment_id) {
 if info.direction == PaymentDirection::Outbound {
 log_info!(
Expand DownExpand Up@@ -750,46 +745,6 @@ where
 _ => debug_assert!(false, "We only expect the counterparty to get away with withholding fees for JIT payments."),
 }
 }

 // If this is known by the store but ChannelManager doesn't know the preimage,
 // the payment has been registered via `_for_hash` variants and needs to be manually claimed via
 // user interaction.
 match info.kind {
 PaymentKind::Bolt11 { preimage, .. }
 | PaymentKind::Bolt11Jit { preimage, .. } => {
 if purpose.preimage().is_none() {
 debug_assert!(
 preimage.is_none(),
 "We would have registered the preimage if we knew"
 );

 let custom_records = onion_fields
 .map(|cf| {
 cf.custom_tlvs().into_iter().map(|tlv| tlv.into()).collect()
 })
 .unwrap_or_default();
 let event = Event::PaymentClaimable {
 payment_id,
 payment_hash,
 claimable_amount_msat: amount_msat,
 claim_deadline,
 custom_records,
 };
 match self.event_queue.add_event(event).await {
 Ok(_) => return Ok(()),
 Err(e) => {
 log_error!(
 self.logger,
 "Failed to push to event queue: {}",
 e
 );
 return Err(ReplayEvent());
 },
 };
 }
 },
 _ => {},
 }
 }

 log_info!(
Expand All@@ -799,7 +754,46 @@ where
 amount_msat,
 );
 let payment_preimage = match purpose {
 PaymentPurpose::Bolt11InvoicePayment { payment_preimage, .. } => {
 PaymentPurpose::Bolt11InvoicePayment {
 payment_preimage,
 payment_secret,
 ..
 } => {
 let kind = PaymentKind::Bolt11 {
 hash: payment_hash,
 preimage: payment_preimage,
 secret: Some(payment_secret),
 };

 let payment = PaymentDetails::new(
 payment_id,
 kind,
 Some(amount_msat),
 None,
 PaymentDirection::Inbound,
 PaymentStatus::Pending,
 );

 match self.payment_store.insert(payment) {
 Ok(false) => (),
 Ok(true) => {
 log_error!(
 self.logger,
 "Bolt11InvoicePayment with ID {} was previously known",
 payment_id,
 );
 debug_assert!(false);
 },
 Err(e) => {
 log_error!(
 self.logger,
 "Failed to insert payment with ID {}: {}",
 payment_id,
 e
 );
 debug_assert!(false);
 },
 }
 payment_preimage
 },
 PaymentPurpose::Bolt12OfferPayment {
Expand DownExpand Up@@ -898,25 +892,47 @@ where
 if let Some(preimage) = payment_preimage {
 self.channel_manager.claim_funds(preimage);
 } else {
 log_error!(
 self.logger,
 "Failed to claim payment with ID {}: preimage unknown.",
 // If ChannelManager doesn't know the preimage the payment needs to be
 // manually claimed via user interaction.
 //if purpose.preimage().is_none() {
 let custom_records = onion_fields
 .map(|cf| cf.custom_tlvs().into_iter().map(|tlv| tlv.into()).collect())
 .unwrap_or_default();
 let event = Event::PaymentClaimable {
 payment_id,
 );
 self.channel_manager.fail_htlc_backwards(&payment_hash);

 let update = PaymentDetailsUpdate {
 hash: Some(Some(payment_hash)),
 status: Some(PaymentStatus::Failed),
 ..PaymentDetailsUpdate::new(payment_id)
 payment_hash,
 claimable_amount_msat: amount_msat,
 claim_deadline,
 custom_records,
 };
 match self.payment_store.update(&update) {
 match self.event_queue.add_event(event).await {
 Ok(_) => return Ok(()),
 Err(e) => {
 log_error!(self.logger, "Failed to access payment store: {}", e);
 log_error!(self.logger, "Failed to push to event queue: {}", e);
 return Err(ReplayEvent());
 },
 };
 //}

 //log_error!(
 //	self.logger,
 //	"Failed to claim payment with ID {}: preimage unknown.",
 //	payment_id,
 //);
 //self.channel_manager.fail_htlc_backwards(&payment_hash);

 //let update = PaymentDetailsUpdate {
 //	hash: Some(Some(payment_hash)),
 //	status: Some(PaymentStatus::Failed),
 //	..PaymentDetailsUpdate::new(payment_id)
 //};
 //match self.payment_store.update(&update) {
 //	Ok(_) => return Ok(()),
 //	Err(e) => {
 // log_error!(self.logger, "Failed to access payment store: {}", e);
 // return Err(ReplayEvent());
 //	},
 //};
 }
 },
 LdkEvent::PaymentClaimed {
Expand All@@ -927,9 +943,9 @@ where
 htlcs: _,
 sender_intended_total_msat: _,
 onion_fields,
 payment_id: _,
 payment_id,
 } => {
 let payment_id = PaymentId(payment_hash.0);
 let payment_id = payment_id.unwrap_or(PaymentId(payment_hash.0));
 log_info!(
 self.logger,
 "Claimed payment with ID {} from payment hash {} of {}msat.",
Expand DownExpand Up@@ -1002,7 +1018,7 @@ where
 }

 let event = Event::PaymentReceived {
 payment_id: Some(payment_id),
 payment_id,
 payment_hash,
 amount_msat,
 custom_records: onion_fields
Expand DownExpand Up@@ -1063,7 +1079,7 @@ where
 );
 });
 let event = Event::PaymentSuccessful {
 payment_id: Some(payment_id),
 payment_id,
 payment_hash,
 payment_preimage: Some(payment_preimage),
 fee_paid_msat,
Expand DownExpand Up@@ -1098,8 +1114,7 @@ where
 },
 };

 let event =
 Event::PaymentFailed { payment_id: Some(payment_id), payment_hash, reason };
 let event = Event::PaymentFailed { payment_id, payment_hash, reason };
 match self.event_queue.add_event(event).await {
 Ok(_) => return Ok(()),
 Err(e) => {
Expand Down
Loading
Loading

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

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

tnull
wants to merge
2
commits into

from

 Closed


Finish migration to tracking all payments by PaymentId#784
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
c529c40

Make `payment_id` a required field in `Event`s


tnull Feb 4, 2026
0069271

WIP switch to `PaymentId` fully


tnull Feb 4, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


10 changes: 5 additions & 5 deletions
bindings/ldk_node.udl

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -214,9 +214,9 @@ interface Bolt11Payment {
	[Throws=NodeError]
	void send_probes_using_amount([ByRef]Bolt11Invoice invoice, u64 amount_msat, RouteParametersConfig? route_parameters);
	[Throws=NodeError]
	void claim_for_hash(PaymentHash payment_hash, u64 claimable_amount_msat, PaymentPreimage preimage);
	void claim_for_id(PaymentId payment_id, u64 claimable_amount_msat, PaymentPreimage preimage);
	[Throws=NodeError]
	void fail_for_hash(PaymentHash payment_hash);
	void fail_for_id(PaymentId payment_id);
	[Throws=NodeError]
	Bolt11Invoice receive(u64 amount_msat, [ByRef]Bolt11InvoiceDescription description, u32 expiry_secs);
	[Throws=NodeError]
Expand DownExpand Up@@ -413,9 +413,9 @@ enum VssHeaderProviderError {

[Enum]
interface Event {
	PaymentSuccessful(PaymentId? payment_id, PaymentHash payment_hash, PaymentPreimage? payment_preimage, u64? fee_paid_msat);
	PaymentFailed(PaymentId? payment_id, PaymentHash? payment_hash, PaymentFailureReason? reason);
	PaymentReceived(PaymentId? payment_id, PaymentHash payment_hash, u64 amount_msat, sequence<CustomTlvRecord> custom_records);
	PaymentSuccessful(PaymentId payment_id, PaymentHash payment_hash, PaymentPreimage? payment_preimage, u64? fee_paid_msat);
	PaymentFailed(PaymentId payment_id, PaymentHash? payment_hash, PaymentFailureReason? reason);
	PaymentReceived(PaymentId payment_id, PaymentHash payment_hash, u64 amount_msat, sequence<CustomTlvRecord> custom_records);
	PaymentClaimable(PaymentId payment_id, PaymentHash payment_hash, u64 claimable_amount_msat, u32? claim_deadline, sequence<CustomTlvRecord> custom_records);
	PaymentForwarded(ChannelId prev_channel_id, ChannelId next_channel_id, UserChannelId?
	prev_user_channel_id, UserChannelId? next_user_channel_id, PublicKey? prev_node_id, PublicKey? next_node_id, u64? total_fee_earned_msat, u64? skimmed_fee_msat, boolean claim_from_onchain_tx, u64? outbound_amount_forwarded_msat);
Expand Down

159 changes: 87 additions & 72 deletions
src/event.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -62,9 +62,7 @@ pub enum Event {
	/// A sent payment was successful.
	PaymentSuccessful {
 /// A local identifier used to track the payment.
 ///
 /// Will only be `None` for events serialized with LDK Node v0.2.1 or prior.
 payment_id: Option<PaymentId>,
 payment_id: PaymentId,
 /// The hash of the payment.
 payment_hash: PaymentHash,
 /// The preimage to the `payment_hash`.
Expand All@@ -79,9 +77,7 @@ pub enum Event {
	/// A sent payment has failed.
	PaymentFailed {
 /// A local identifier used to track the payment.
 ///
 /// Will only be `None` for events serialized with LDK Node v0.2.1 or prior.
 payment_id: Option<PaymentId>,
 payment_id: PaymentId,
 /// The hash of the payment.
 ///
 /// This will be `None` if the payment failed before receiving an invoice when paying a
Expand All@@ -97,9 +93,7 @@ pub enum Event {
	/// A payment has been received.
	PaymentReceived {
 /// A local identifier used to track the payment.
 ///
 /// Will only be `None` for events serialized with LDK Node v0.2.1 or prior.
 payment_id: Option<PaymentId>,
 payment_id: PaymentId,
 /// The hash of the payment.
 payment_hash: PaymentHash,
 /// The value, in thousandths of a satoshi, that has been received.
Expand DownExpand Up@@ -262,17 +256,17 @@ impl_writeable_tlv_based_enum!(Event,
	(0, PaymentSuccessful) => {
 (0, payment_hash, required),
 (1, fee_paid_msat, option),
 (3, payment_id, option),
 (3, payment_id, required),
 (5, payment_preimage, option),
	},
	(1, PaymentFailed) => {
 (0, payment_hash, option),
 (1, reason, upgradable_option),
 (3, payment_id, option),
 (3, payment_id, required),
	},
	(2, PaymentReceived) => {
 (0, payment_hash, required),
 (1, payment_id, option),
 (1, payment_id, required),
 (2, amount_msat, required),
 (3, custom_records, optional_vec),
	},
Expand DownExpand Up@@ -641,9 +635,10 @@ where
 claim_deadline,
 onion_fields,
 counterparty_skimmed_fee_msat,
 payment_id,
 ..
 } => {
 let payment_id = PaymentId(payment_hash.0);
 let payment_id = payment_id.unwrap_or(PaymentId(payment_hash.0));
 if let Some(info) = self.payment_store.get(&payment_id) {
 if info.direction == PaymentDirection::Outbound {
 log_info!(
Expand DownExpand Up@@ -750,46 +745,6 @@ where
 _ => debug_assert!(false, "We only expect the counterparty to get away with withholding fees for JIT payments."),
 }
 }

 // If this is known by the store but ChannelManager doesn't know the preimage,
 // the payment has been registered via `_for_hash` variants and needs to be manually claimed via
 // user interaction.
 match info.kind {
 PaymentKind::Bolt11 { preimage, .. }
 | PaymentKind::Bolt11Jit { preimage, .. } => {
 if purpose.preimage().is_none() {
 debug_assert!(
 preimage.is_none(),
 "We would have registered the preimage if we knew"
 );

 let custom_records = onion_fields
 .map(|cf| {
 cf.custom_tlvs().into_iter().map(|tlv| tlv.into()).collect()
 })
 .unwrap_or_default();
 let event = Event::PaymentClaimable {
 payment_id,
 payment_hash,
 claimable_amount_msat: amount_msat,
 claim_deadline,
 custom_records,
 };
 match self.event_queue.add_event(event).await {
 Ok(_) => return Ok(()),
 Err(e) => {
 log_error!(
 self.logger,
 "Failed to push to event queue: {}",
 e
 );
 return Err(ReplayEvent());
 },
 };
 }
 },
 _ => {},
 }
 }

 log_info!(
Expand All@@ -799,7 +754,46 @@ where
 amount_msat,
 );
 let payment_preimage = match purpose {
 PaymentPurpose::Bolt11InvoicePayment { payment_preimage, .. } => {
 PaymentPurpose::Bolt11InvoicePayment {
 payment_preimage,
 payment_secret,
 ..
 } => {
 let kind = PaymentKind::Bolt11 {
 hash: payment_hash,
 preimage: payment_preimage,
 secret: Some(payment_secret),
 };

 let payment = PaymentDetails::new(
 payment_id,
 kind,
 Some(amount_msat),
 None,
 PaymentDirection::Inbound,
 PaymentStatus::Pending,
 );

 match self.payment_store.insert(payment) {
 Ok(false) => (),
 Ok(true) => {
 log_error!(
 self.logger,
 "Bolt11InvoicePayment with ID {} was previously known",
 payment_id,
 );
 debug_assert!(false);
 },
 Err(e) => {
 log_error!(
 self.logger,
 "Failed to insert payment with ID {}: {}",
 payment_id,
 e
 );
 debug_assert!(false);
 },
 }
 payment_preimage
 },
 PaymentPurpose::Bolt12OfferPayment {
Expand DownExpand Up@@ -898,25 +892,47 @@ where
 if let Some(preimage) = payment_preimage {
 self.channel_manager.claim_funds(preimage);
 } else {
 log_error!(
 self.logger,
 "Failed to claim payment with ID {}: preimage unknown.",
 // If ChannelManager doesn't know the preimage the payment needs to be
 // manually claimed via user interaction.
 //if purpose.preimage().is_none() {
 let custom_records = onion_fields
 .map(|cf| cf.custom_tlvs().into_iter().map(|tlv| tlv.into()).collect())
 .unwrap_or_default();
 let event = Event::PaymentClaimable {
 payment_id,
 );
 self.channel_manager.fail_htlc_backwards(&payment_hash);

 let update = PaymentDetailsUpdate {
 hash: Some(Some(payment_hash)),
 status: Some(PaymentStatus::Failed),
 ..PaymentDetailsUpdate::new(payment_id)
 payment_hash,
 claimable_amount_msat: amount_msat,
 claim_deadline,
 custom_records,
 };
 match self.payment_store.update(&update) {
 match self.event_queue.add_event(event).await {
 Ok(_) => return Ok(()),
 Err(e) => {
 log_error!(self.logger, "Failed to access payment store: {}", e);
 log_error!(self.logger, "Failed to push to event queue: {}", e);
 return Err(ReplayEvent());
 },
 };
 //}

 //log_error!(
 //	self.logger,
 //	"Failed to claim payment with ID {}: preimage unknown.",
 //	payment_id,
 //);
 //self.channel_manager.fail_htlc_backwards(&payment_hash);

 //let update = PaymentDetailsUpdate {
 //	hash: Some(Some(payment_hash)),
 //	status: Some(PaymentStatus::Failed),
 //	..PaymentDetailsUpdate::new(payment_id)
 //};
 //match self.payment_store.update(&update) {
 //	Ok(_) => return Ok(()),
 //	Err(e) => {
 // log_error!(self.logger, "Failed to access payment store: {}", e);
 // return Err(ReplayEvent());
 //	},
 //};
 }
 },
 LdkEvent::PaymentClaimed {
Expand All@@ -927,9 +943,9 @@ where
 htlcs: _,
 sender_intended_total_msat: _,
 onion_fields,
 payment_id: _,
 payment_id,
 } => {
 let payment_id = PaymentId(payment_hash.0);
 let payment_id = payment_id.unwrap_or(PaymentId(payment_hash.0));
 log_info!(
 self.logger,
 "Claimed payment with ID {} from payment hash {} of {}msat.",
Expand DownExpand Up@@ -1002,7 +1018,7 @@ where
 }

 let event = Event::PaymentReceived {
 payment_id: Some(payment_id),
 payment_id,
 payment_hash,
 amount_msat,
 custom_records: onion_fields
Expand DownExpand Up@@ -1063,7 +1079,7 @@ where
 );
 });
 let event = Event::PaymentSuccessful {
 payment_id: Some(payment_id),
 payment_id,
 payment_hash,
 payment_preimage: Some(payment_preimage),
 fee_paid_msat,
Expand DownExpand Up@@ -1098,8 +1114,7 @@ where
 },
 };

 let event =
 Event::PaymentFailed { payment_id: Some(payment_id), payment_hash, reason };
 let event = Event::PaymentFailed { payment_id, payment_hash, reason };
 match self.event_queue.add_event(event).await {
 Ok(_) => return Ok(()),
 Err(e) => {
Expand Down
Loading
Loading

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

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

tnull
wants to merge
2
commits into

from

 Closed


Finish migration to tracking all payments by PaymentId#784
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
c529c40

Make `payment_id` a required field in `Event`s


tnull Feb 4, 2026
0069271

WIP switch to `PaymentId` fully


tnull Feb 4, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


10 changes: 5 additions & 5 deletions
bindings/ldk_node.udl

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -214,9 +214,9 @@ interface Bolt11Payment {
	[Throws=NodeError]
	void send_probes_using_amount([ByRef]Bolt11Invoice invoice, u64 amount_msat, RouteParametersConfig? route_parameters);
	[Throws=NodeError]
	void claim_for_hash(PaymentHash payment_hash, u64 claimable_amount_msat, PaymentPreimage preimage);
	void claim_for_id(PaymentId payment_id, u64 claimable_amount_msat, PaymentPreimage preimage);
	[Throws=NodeError]
	void fail_for_hash(PaymentHash payment_hash);
	void fail_for_id(PaymentId payment_id);
	[Throws=NodeError]
	Bolt11Invoice receive(u64 amount_msat, [ByRef]Bolt11InvoiceDescription description, u32 expiry_secs);
	[Throws=NodeError]
Expand DownExpand Up@@ -413,9 +413,9 @@ enum VssHeaderProviderError {

[Enum]
interface Event {
	PaymentSuccessful(PaymentId? payment_id, PaymentHash payment_hash, PaymentPreimage? payment_preimage, u64? fee_paid_msat);
	PaymentFailed(PaymentId? payment_id, PaymentHash? payment_hash, PaymentFailureReason? reason);
	PaymentReceived(PaymentId? payment_id, PaymentHash payment_hash, u64 amount_msat, sequence<CustomTlvRecord> custom_records);
	PaymentSuccessful(PaymentId payment_id, PaymentHash payment_hash, PaymentPreimage? payment_preimage, u64? fee_paid_msat);
	PaymentFailed(PaymentId payment_id, PaymentHash? payment_hash, PaymentFailureReason? reason);
	PaymentReceived(PaymentId payment_id, PaymentHash payment_hash, u64 amount_msat, sequence<CustomTlvRecord> custom_records);
	PaymentClaimable(PaymentId payment_id, PaymentHash payment_hash, u64 claimable_amount_msat, u32? claim_deadline, sequence<CustomTlvRecord> custom_records);
	PaymentForwarded(ChannelId prev_channel_id, ChannelId next_channel_id, UserChannelId?
	prev_user_channel_id, UserChannelId? next_user_channel_id, PublicKey? prev_node_id, PublicKey? next_node_id, u64? total_fee_earned_msat, u64? skimmed_fee_msat, boolean claim_from_onchain_tx, u64? outbound_amount_forwarded_msat);
Expand Down

159 changes: 87 additions & 72 deletions
src/event.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -62,9 +62,7 @@ pub enum Event {
	/// A sent payment was successful.
	PaymentSuccessful {
 /// A local identifier used to track the payment.
 ///
 /// Will only be `None` for events serialized with LDK Node v0.2.1 or prior.
 payment_id: Option<PaymentId>,
 payment_id: PaymentId,
 /// The hash of the payment.
 payment_hash: PaymentHash,
 /// The preimage to the `payment_hash`.
Expand All@@ -79,9 +77,7 @@ pub enum Event {
	/// A sent payment has failed.
	PaymentFailed {
 /// A local identifier used to track the payment.
 ///
 /// Will only be `None` for events serialized with LDK Node v0.2.1 or prior.
 payment_id: Option<PaymentId>,
 payment_id: PaymentId,
 /// The hash of the payment.
 ///
 /// This will be `None` if the payment failed before receiving an invoice when paying a
Expand All@@ -97,9 +93,7 @@ pub enum Event {
	/// A payment has been received.
	PaymentReceived {
 /// A local identifier used to track the payment.
 ///
 /// Will only be `None` for events serialized with LDK Node v0.2.1 or prior.
 payment_id: Option<PaymentId>,
 payment_id: PaymentId,
 /// The hash of the payment.
 payment_hash: PaymentHash,
 /// The value, in thousandths of a satoshi, that has been received.
Expand DownExpand Up@@ -262,17 +256,17 @@ impl_writeable_tlv_based_enum!(Event,
	(0, PaymentSuccessful) => {
 (0, payment_hash, required),
 (1, fee_paid_msat, option),
 (3, payment_id, option),
 (3, payment_id, required),
 (5, payment_preimage, option),
	},
	(1, PaymentFailed) => {
 (0, payment_hash, option),
 (1, reason, upgradable_option),
 (3, payment_id, option),
 (3, payment_id, required),
	},
	(2, PaymentReceived) => {
 (0, payment_hash, required),
 (1, payment_id, option),
 (1, payment_id, required),
 (2, amount_msat, required),
 (3, custom_records, optional_vec),
	},
Expand DownExpand Up@@ -641,9 +635,10 @@ where
 claim_deadline,
 onion_fields,
 counterparty_skimmed_fee_msat,
 payment_id,
 ..
 } => {
 let payment_id = PaymentId(payment_hash.0);
 let payment_id = payment_id.unwrap_or(PaymentId(payment_hash.0));
 if let Some(info) = self.payment_store.get(&payment_id) {
 if info.direction == PaymentDirection::Outbound {
 log_info!(
Expand DownExpand Up@@ -750,46 +745,6 @@ where
 _ => debug_assert!(false, "We only expect the counterparty to get away with withholding fees for JIT payments."),
 }
 }

 // If this is known by the store but ChannelManager doesn't know the preimage,
 // the payment has been registered via `_for_hash` variants and needs to be manually claimed via
 // user interaction.
 match info.kind {
 PaymentKind::Bolt11 { preimage, .. }
 | PaymentKind::Bolt11Jit { preimage, .. } => {
 if purpose.preimage().is_none() {
 debug_assert!(
 preimage.is_none(),
 "We would have registered the preimage if we knew"
 );

 let custom_records = onion_fields
 .map(|cf| {
 cf.custom_tlvs().into_iter().map(|tlv| tlv.into()).collect()
 })
 .unwrap_or_default();
 let event = Event::PaymentClaimable {
 payment_id,
 payment_hash,
 claimable_amount_msat: amount_msat,
 claim_deadline,
 custom_records,
 };
 match self.event_queue.add_event(event).await {
 Ok(_) => return Ok(()),
 Err(e) => {
 log_error!(
 self.logger,
 "Failed to push to event queue: {}",
 e
 );
 return Err(ReplayEvent());
 },
 };
 }
 },
 _ => {},
 }
 }

 log_info!(
Expand All@@ -799,7 +754,46 @@ where
 amount_msat,
 );
 let payment_preimage = match purpose {
 PaymentPurpose::Bolt11InvoicePayment { payment_preimage, .. } => {
 PaymentPurpose::Bolt11InvoicePayment {
 payment_preimage,
 payment_secret,
 ..
 } => {
 let kind = PaymentKind::Bolt11 {
 hash: payment_hash,
 preimage: payment_preimage,
 secret: Some(payment_secret),
 };

 let payment = PaymentDetails::new(
 payment_id,
 kind,
 Some(amount_msat),
 None,
 PaymentDirection::Inbound,
 PaymentStatus::Pending,
 );

 match self.payment_store.insert(payment) {
 Ok(false) => (),
 Ok(true) => {
 log_error!(
 self.logger,
 "Bolt11InvoicePayment with ID {} was previously known",
 payment_id,
 );
 debug_assert!(false);
 },
 Err(e) => {
 log_error!(
 self.logger,
 "Failed to insert payment with ID {}: {}",
 payment_id,
 e
 );
 debug_assert!(false);
 },
 }
 payment_preimage
 },
 PaymentPurpose::Bolt12OfferPayment {
Expand DownExpand Up@@ -898,25 +892,47 @@ where
 if let Some(preimage) = payment_preimage {
 self.channel_manager.claim_funds(preimage);
 } else {
 log_error!(
 self.logger,
 "Failed to claim payment with ID {}: preimage unknown.",
 // If ChannelManager doesn't know the preimage the payment needs to be
 // manually claimed via user interaction.
 //if purpose.preimage().is_none() {
 let custom_records = onion_fields
 .map(|cf| cf.custom_tlvs().into_iter().map(|tlv| tlv.into()).collect())
 .unwrap_or_default();
 let event = Event::PaymentClaimable {
 payment_id,
 );
 self.channel_manager.fail_htlc_backwards(&payment_hash);

 let update = PaymentDetailsUpdate {
 hash: Some(Some(payment_hash)),
 status: Some(PaymentStatus::Failed),
 ..PaymentDetailsUpdate::new(payment_id)
 payment_hash,
 claimable_amount_msat: amount_msat,
 claim_deadline,
 custom_records,
 };
 match self.payment_store.update(&update) {
 match self.event_queue.add_event(event).await {
 Ok(_) => return Ok(()),
 Err(e) => {
 log_error!(self.logger, "Failed to access payment store: {}", e);
 log_error!(self.logger, "Failed to push to event queue: {}", e);
 return Err(ReplayEvent());
 },
 };
 //}

 //log_error!(
 //	self.logger,
 //	"Failed to claim payment with ID {}: preimage unknown.",
 //	payment_id,
 //);
 //self.channel_manager.fail_htlc_backwards(&payment_hash);

 //let update = PaymentDetailsUpdate {
 //	hash: Some(Some(payment_hash)),
 //	status: Some(PaymentStatus::Failed),
 //	..PaymentDetailsUpdate::new(payment_id)
 //};
 //match self.payment_store.update(&update) {
 //	Ok(_) => return Ok(()),
 //	Err(e) => {
 // log_error!(self.logger, "Failed to access payment store: {}", e);
 // return Err(ReplayEvent());
 //	},
 //};
 }
 },
 LdkEvent::PaymentClaimed {
Expand All@@ -927,9 +943,9 @@ where
 htlcs: _,
 sender_intended_total_msat: _,
 onion_fields,
 payment_id: _,
 payment_id,
 } => {
 let payment_id = PaymentId(payment_hash.0);
 let payment_id = payment_id.unwrap_or(PaymentId(payment_hash.0));
 log_info!(
 self.logger,
 "Claimed payment with ID {} from payment hash {} of {}msat.",
Expand DownExpand Up@@ -1002,7 +1018,7 @@ where
 }

 let event = Event::PaymentReceived {
 payment_id: Some(payment_id),
 payment_id,
 payment_hash,
 amount_msat,
 custom_records: onion_fields
Expand DownExpand Up@@ -1063,7 +1079,7 @@ where
 );
 });
 let event = Event::PaymentSuccessful {
 payment_id: Some(payment_id),
 payment_id,
 payment_hash,
 payment_preimage: Some(payment_preimage),
 fee_paid_msat,
Expand DownExpand Up@@ -1098,8 +1114,7 @@ where
 },
 };

 let event =
 Event::PaymentFailed { payment_id: Some(payment_id), payment_hash, reason };
 let event = Event::PaymentFailed { payment_id, payment_hash, reason };
 match self.event_queue.add_event(event).await {
 Ok(_) => return Ok(()),
 Err(e) => {
Expand Down
Loading
Loading

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

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

tnull
wants to merge
2
commits into

from

 Closed


Finish migration to tracking all payments by PaymentId#784
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
c529c40

Make `payment_id` a required field in `Event`s


tnull Feb 4, 2026
0069271

WIP switch to `PaymentId` fully


tnull Feb 4, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


10 changes: 5 additions & 5 deletions
bindings/ldk_node.udl

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -214,9 +214,9 @@ interface Bolt11Payment {
	[Throws=NodeError]
	void send_probes_using_amount([ByRef]Bolt11Invoice invoice, u64 amount_msat, RouteParametersConfig? route_parameters);
	[Throws=NodeError]
	void claim_for_hash(PaymentHash payment_hash, u64 claimable_amount_msat, PaymentPreimage preimage);
	void claim_for_id(PaymentId payment_id, u64 claimable_amount_msat, PaymentPreimage preimage);
	[Throws=NodeError]
	void fail_for_hash(PaymentHash payment_hash);
	void fail_for_id(PaymentId payment_id);
	[Throws=NodeError]
	Bolt11Invoice receive(u64 amount_msat, [ByRef]Bolt11InvoiceDescription description, u32 expiry_secs);
	[Throws=NodeError]
Expand DownExpand Up@@ -413,9 +413,9 @@ enum VssHeaderProviderError {

[Enum]
interface Event {
	PaymentSuccessful(PaymentId? payment_id, PaymentHash payment_hash, PaymentPreimage? payment_preimage, u64? fee_paid_msat);
	PaymentFailed(PaymentId? payment_id, PaymentHash? payment_hash, PaymentFailureReason? reason);
	PaymentReceived(PaymentId? payment_id, PaymentHash payment_hash, u64 amount_msat, sequence<CustomTlvRecord> custom_records);
	PaymentSuccessful(PaymentId payment_id, PaymentHash payment_hash, PaymentPreimage? payment_preimage, u64? fee_paid_msat);
	PaymentFailed(PaymentId payment_id, PaymentHash? payment_hash, PaymentFailureReason? reason);
	PaymentReceived(PaymentId payment_id, PaymentHash payment_hash, u64 amount_msat, sequence<CustomTlvRecord> custom_records);
	PaymentClaimable(PaymentId payment_id, PaymentHash payment_hash, u64 claimable_amount_msat, u32? claim_deadline, sequence<CustomTlvRecord> custom_records);
	PaymentForwarded(ChannelId prev_channel_id, ChannelId next_channel_id, UserChannelId?
	prev_user_channel_id, UserChannelId? next_user_channel_id, PublicKey? prev_node_id, PublicKey? next_node_id, u64? total_fee_earned_msat, u64? skimmed_fee_msat, boolean claim_from_onchain_tx, u64? outbound_amount_forwarded_msat);
Expand Down

159 changes: 87 additions & 72 deletions
src/event.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -62,9 +62,7 @@ pub enum Event {
	/// A sent payment was successful.
	PaymentSuccessful {
 /// A local identifier used to track the payment.
 ///
 /// Will only be `None` for events serialized with LDK Node v0.2.1 or prior.
 payment_id: Option<PaymentId>,
 payment_id: PaymentId,
 /// The hash of the payment.
 payment_hash: PaymentHash,
 /// The preimage to the `payment_hash`.
Expand All@@ -79,9 +77,7 @@ pub enum Event {
	/// A sent payment has failed.
	PaymentFailed {
 /// A local identifier used to track the payment.
 ///
 /// Will only be `None` for events serialized with LDK Node v0.2.1 or prior.
 payment_id: Option<PaymentId>,
 payment_id: PaymentId,
 /// The hash of the payment.
 ///
 /// This will be `None` if the payment failed before receiving an invoice when paying a
Expand All@@ -97,9 +93,7 @@ pub enum Event {
	/// A payment has been received.
	PaymentReceived {
 /// A local identifier used to track the payment.
 ///
 /// Will only be `None` for events serialized with LDK Node v0.2.1 or prior.
 payment_id: Option<PaymentId>,
 payment_id: PaymentId,
 /// The hash of the payment.
 payment_hash: PaymentHash,
 /// The value, in thousandths of a satoshi, that has been received.
Expand DownExpand Up@@ -262,17 +256,17 @@ impl_writeable_tlv_based_enum!(Event,
	(0, PaymentSuccessful) => {
 (0, payment_hash, required),
 (1, fee_paid_msat, option),
 (3, payment_id, option),
 (3, payment_id, required),
 (5, payment_preimage, option),
	},
	(1, PaymentFailed) => {
 (0, payment_hash, option),
 (1, reason, upgradable_option),
 (3, payment_id, option),
 (3, payment_id, required),
	},
	(2, PaymentReceived) => {
 (0, payment_hash, required),
 (1, payment_id, option),
 (1, payment_id, required),
 (2, amount_msat, required),
 (3, custom_records, optional_vec),
	},
Expand DownExpand Up@@ -641,9 +635,10 @@ where
 claim_deadline,
 onion_fields,
 counterparty_skimmed_fee_msat,
 payment_id,
 ..
 } => {
 let payment_id = PaymentId(payment_hash.0);
 let payment_id = payment_id.unwrap_or(PaymentId(payment_hash.0));
 if let Some(info) = self.payment_store.get(&payment_id) {
 if info.direction == PaymentDirection::Outbound {
 log_info!(
Expand DownExpand Up@@ -750,46 +745,6 @@ where
 _ => debug_assert!(false, "We only expect the counterparty to get away with withholding fees for JIT payments."),
 }
 }

 // If this is known by the store but ChannelManager doesn't know the preimage,
 // the payment has been registered via `_for_hash` variants and needs to be manually claimed via
 // user interaction.
 match info.kind {
 PaymentKind::Bolt11 { preimage, .. }
 | PaymentKind::Bolt11Jit { preimage, .. } => {
 if purpose.preimage().is_none() {
 debug_assert!(
 preimage.is_none(),
 "We would have registered the preimage if we knew"
 );

 let custom_records = onion_fields
 .map(|cf| {
 cf.custom_tlvs().into_iter().map(|tlv| tlv.into()).collect()
 })
 .unwrap_or_default();
 let event = Event::PaymentClaimable {
 payment_id,
 payment_hash,
 claimable_amount_msat: amount_msat,
 claim_deadline,
 custom_records,
 };
 match self.event_queue.add_event(event).await {
 Ok(_) => return Ok(()),
 Err(e) => {
 log_error!(
 self.logger,
 "Failed to push to event queue: {}",
 e
 );
 return Err(ReplayEvent());
 },
 };
 }
 },
 _ => {},
 }
 }

 log_info!(
Expand All@@ -799,7 +754,46 @@ where
 amount_msat,
 );
 let payment_preimage = match purpose {
 PaymentPurpose::Bolt11InvoicePayment { payment_preimage, .. } => {
 PaymentPurpose::Bolt11InvoicePayment {
 payment_preimage,
 payment_secret,
 ..
 } => {
 let kind = PaymentKind::Bolt11 {
 hash: payment_hash,
 preimage: payment_preimage,
 secret: Some(payment_secret),
 };

 let payment = PaymentDetails::new(
 payment_id,
 kind,
 Some(amount_msat),
 None,
 PaymentDirection::Inbound,
 PaymentStatus::Pending,
 );

 match self.payment_store.insert(payment) {
 Ok(false) => (),
 Ok(true) => {
 log_error!(
 self.logger,
 "Bolt11InvoicePayment with ID {} was previously known",
 payment_id,
 );
 debug_assert!(false);
 },
 Err(e) => {
 log_error!(
 self.logger,
 "Failed to insert payment with ID {}: {}",
 payment_id,
 e
 );
 debug_assert!(false);
 },
 }
 payment_preimage
 },
 PaymentPurpose::Bolt12OfferPayment {
Expand DownExpand Up@@ -898,25 +892,47 @@ where
 if let Some(preimage) = payment_preimage {
 self.channel_manager.claim_funds(preimage);
 } else {
 log_error!(
 self.logger,
 "Failed to claim payment with ID {}: preimage unknown.",
 // If ChannelManager doesn't know the preimage the payment needs to be
 // manually claimed via user interaction.
 //if purpose.preimage().is_none() {
 let custom_records = onion_fields
 .map(|cf| cf.custom_tlvs().into_iter().map(|tlv| tlv.into()).collect())
 .unwrap_or_default();
 let event = Event::PaymentClaimable {
 payment_id,
 );
 self.channel_manager.fail_htlc_backwards(&payment_hash);

 let update = PaymentDetailsUpdate {
 hash: Some(Some(payment_hash)),
 status: Some(PaymentStatus::Failed),
 ..PaymentDetailsUpdate::new(payment_id)
 payment_hash,
 claimable_amount_msat: amount_msat,
 claim_deadline,
 custom_records,
 };
 match self.payment_store.update(&update) {
 match self.event_queue.add_event(event).await {
 Ok(_) => return Ok(()),
 Err(e) => {
 log_error!(self.logger, "Failed to access payment store: {}", e);
 log_error!(self.logger, "Failed to push to event queue: {}", e);
 return Err(ReplayEvent());
 },
 };
 //}

 //log_error!(
 //	self.logger,
 //	"Failed to claim payment with ID {}: preimage unknown.",
 //	payment_id,
 //);
 //self.channel_manager.fail_htlc_backwards(&payment_hash);

 //let update = PaymentDetailsUpdate {
 //	hash: Some(Some(payment_hash)),
 //	status: Some(PaymentStatus::Failed),
 //	..PaymentDetailsUpdate::new(payment_id)
 //};
 //match self.payment_store.update(&update) {
 //	Ok(_) => return Ok(()),
 //	Err(e) => {
 // log_error!(self.logger, "Failed to access payment store: {}", e);
 // return Err(ReplayEvent());
 //	},
 //};
 }
 },
 LdkEvent::PaymentClaimed {
Expand All@@ -927,9 +943,9 @@ where
 htlcs: _,
 sender_intended_total_msat: _,
 onion_fields,
 payment_id: _,
 payment_id,
 } => {
 let payment_id = PaymentId(payment_hash.0);
 let payment_id = payment_id.unwrap_or(PaymentId(payment_hash.0));
 log_info!(
 self.logger,
 "Claimed payment with ID {} from payment hash {} of {}msat.",
Expand DownExpand Up@@ -1002,7 +1018,7 @@ where
 }

 let event = Event::PaymentReceived {
 payment_id: Some(payment_id),
 payment_id,
 payment_hash,
 amount_msat,
 custom_records: onion_fields
Expand DownExpand Up@@ -1063,7 +1079,7 @@ where
 );
 });
 let event = Event::PaymentSuccessful {
 payment_id: Some(payment_id),
 payment_id,
 payment_hash,
 payment_preimage: Some(payment_preimage),
 fee_paid_msat,
Expand DownExpand Up@@ -1098,8 +1114,7 @@ where
 },
 };

 let event =
 Event::PaymentFailed { payment_id: Some(payment_id), payment_hash, reason };
 let event = Event::PaymentFailed { payment_id, payment_hash, reason };
 match self.event_queue.add_event(event).await {
 Ok(_) => return Ok(()),
 Err(e) => {
Expand Down
Loading
Loading

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

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

tnull
wants to merge
2
commits into

from

 Closed


Finish migration to tracking all payments by PaymentId#784
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
c529c40

Make `payment_id` a required field in `Event`s


tnull Feb 4, 2026
0069271

WIP switch to `PaymentId` fully


tnull Feb 4, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


10 changes: 5 additions & 5 deletions
bindings/ldk_node.udl

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -214,9 +214,9 @@ interface Bolt11Payment {
	[Throws=NodeError]
	void send_probes_using_amount([ByRef]Bolt11Invoice invoice, u64 amount_msat, RouteParametersConfig? route_parameters);
	[Throws=NodeError]
	void claim_for_hash(PaymentHash payment_hash, u64 claimable_amount_msat, PaymentPreimage preimage);
	void claim_for_id(PaymentId payment_id, u64 claimable_amount_msat, PaymentPreimage preimage);
	[Throws=NodeError]
	void fail_for_hash(PaymentHash payment_hash);
	void fail_for_id(PaymentId payment_id);
	[Throws=NodeError]
	Bolt11Invoice receive(u64 amount_msat, [ByRef]Bolt11InvoiceDescription description, u32 expiry_secs);
	[Throws=NodeError]
Expand DownExpand Up@@ -413,9 +413,9 @@ enum VssHeaderProviderError {

[Enum]
interface Event {
	PaymentSuccessful(PaymentId? payment_id, PaymentHash payment_hash, PaymentPreimage? payment_preimage, u64? fee_paid_msat);
	PaymentFailed(PaymentId? payment_id, PaymentHash? payment_hash, PaymentFailureReason? reason);
	PaymentReceived(PaymentId? payment_id, PaymentHash payment_hash, u64 amount_msat, sequence<CustomTlvRecord> custom_records);
	PaymentSuccessful(PaymentId payment_id, PaymentHash payment_hash, PaymentPreimage? payment_preimage, u64? fee_paid_msat);
	PaymentFailed(PaymentId payment_id, PaymentHash? payment_hash, PaymentFailureReason? reason);
	PaymentReceived(PaymentId payment_id, PaymentHash payment_hash, u64 amount_msat, sequence<CustomTlvRecord> custom_records);
	PaymentClaimable(PaymentId payment_id, PaymentHash payment_hash, u64 claimable_amount_msat, u32? claim_deadline, sequence<CustomTlvRecord> custom_records);
	PaymentForwarded(ChannelId prev_channel_id, ChannelId next_channel_id, UserChannelId?
	prev_user_channel_id, UserChannelId? next_user_channel_id, PublicKey? prev_node_id, PublicKey? next_node_id, u64? total_fee_earned_msat, u64? skimmed_fee_msat, boolean claim_from_onchain_tx, u64? outbound_amount_forwarded_msat);
Expand Down

159 changes: 87 additions & 72 deletions
src/event.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -62,9 +62,7 @@ pub enum Event {
	/// A sent payment was successful.
	PaymentSuccessful {
 /// A local identifier used to track the payment.
 ///
 /// Will only be `None` for events serialized with LDK Node v0.2.1 or prior.
 payment_id: Option<PaymentId>,
 payment_id: PaymentId,
 /// The hash of the payment.
 payment_hash: PaymentHash,
 /// The preimage to the `payment_hash`.
Expand All@@ -79,9 +77,7 @@ pub enum Event {
	/// A sent payment has failed.
	PaymentFailed {
 /// A local identifier used to track the payment.
 ///
 /// Will only be `None` for events serialized with LDK Node v0.2.1 or prior.
 payment_id: Option<PaymentId>,
 payment_id: PaymentId,
 /// The hash of the payment.
 ///
 /// This will be `None` if the payment failed before receiving an invoice when paying a
Expand All@@ -97,9 +93,7 @@ pub enum Event {
	/// A payment has been received.
	PaymentReceived {
 /// A local identifier used to track the payment.
 ///
 /// Will only be `None` for events serialized with LDK Node v0.2.1 or prior.
 payment_id: Option<PaymentId>,
 payment_id: PaymentId,
 /// The hash of the payment.
 payment_hash: PaymentHash,
 /// The value, in thousandths of a satoshi, that has been received.
Expand DownExpand Up@@ -262,17 +256,17 @@ impl_writeable_tlv_based_enum!(Event,
	(0, PaymentSuccessful) => {
 (0, payment_hash, required),
 (1, fee_paid_msat, option),
 (3, payment_id, option),
 (3, payment_id, required),
 (5, payment_preimage, option),
	},
	(1, PaymentFailed) => {
 (0, payment_hash, option),
 (1, reason, upgradable_option),
 (3, payment_id, option),
 (3, payment_id, required),
	},
	(2, PaymentReceived) => {
 (0, payment_hash, required),
 (1, payment_id, option),
 (1, payment_id, required),
 (2, amount_msat, required),
 (3, custom_records, optional_vec),
	},
Expand DownExpand Up@@ -641,9 +635,10 @@ where
 claim_deadline,
 onion_fields,
 counterparty_skimmed_fee_msat,
 payment_id,
 ..
 } => {
 let payment_id = PaymentId(payment_hash.0);
 let payment_id = payment_id.unwrap_or(PaymentId(payment_hash.0));
 if let Some(info) = self.payment_store.get(&payment_id) {
 if info.direction == PaymentDirection::Outbound {
 log_info!(
Expand DownExpand Up@@ -750,46 +745,6 @@ where
 _ => debug_assert!(false, "We only expect the counterparty to get away with withholding fees for JIT payments."),
 }
 }

 // If this is known by the store but ChannelManager doesn't know the preimage,
 // the payment has been registered via `_for_hash` variants and needs to be manually claimed via
 // user interaction.
 match info.kind {
 PaymentKind::Bolt11 { preimage, .. }
 | PaymentKind::Bolt11Jit { preimage, .. } => {
 if purpose.preimage().is_none() {
 debug_assert!(
 preimage.is_none(),
 "We would have registered the preimage if we knew"
 );

 let custom_records = onion_fields
 .map(|cf| {
 cf.custom_tlvs().into_iter().map(|tlv| tlv.into()).collect()
 })
 .unwrap_or_default();
 let event = Event::PaymentClaimable {
 payment_id,
 payment_hash,
 claimable_amount_msat: amount_msat,
 claim_deadline,
 custom_records,
 };
 match self.event_queue.add_event(event).await {
 Ok(_) => return Ok(()),
 Err(e) => {
 log_error!(
 self.logger,
 "Failed to push to event queue: {}",
 e
 );
 return Err(ReplayEvent());
 },
 };
 }
 },
 _ => {},
 }
 }

 log_info!(
Expand All@@ -799,7 +754,46 @@ where
 amount_msat,
 );
 let payment_preimage = match purpose {
 PaymentPurpose::Bolt11InvoicePayment { payment_preimage, .. } => {
 PaymentPurpose::Bolt11InvoicePayment {
 payment_preimage,
 payment_secret,
 ..
 } => {
 let kind = PaymentKind::Bolt11 {
 hash: payment_hash,
 preimage: payment_preimage,
 secret: Some(payment_secret),
 };

 let payment = PaymentDetails::new(
 payment_id,
 kind,
 Some(amount_msat),
 None,
 PaymentDirection::Inbound,
 PaymentStatus::Pending,
 );

 match self.payment_store.insert(payment) {
 Ok(false) => (),
 Ok(true) => {
 log_error!(
 self.logger,
 "Bolt11InvoicePayment with ID {} was previously known",
 payment_id,
 );
 debug_assert!(false);
 },
 Err(e) => {
 log_error!(
 self.logger,
 "Failed to insert payment with ID {}: {}",
 payment_id,
 e
 );
 debug_assert!(false);
 },
 }
 payment_preimage
 },
 PaymentPurpose::Bolt12OfferPayment {
Expand DownExpand Up@@ -898,25 +892,47 @@ where
 if let Some(preimage) = payment_preimage {
 self.channel_manager.claim_funds(preimage);
 } else {
 log_error!(
 self.logger,
 "Failed to claim payment with ID {}: preimage unknown.",
 // If ChannelManager doesn't know the preimage the payment needs to be
 // manually claimed via user interaction.
 //if purpose.preimage().is_none() {
 let custom_records = onion_fields
 .map(|cf| cf.custom_tlvs().into_iter().map(|tlv| tlv.into()).collect())
 .unwrap_or_default();
 let event = Event::PaymentClaimable {
 payment_id,
 );
 self.channel_manager.fail_htlc_backwards(&payment_hash);

 let update = PaymentDetailsUpdate {
 hash: Some(Some(payment_hash)),
 status: Some(PaymentStatus::Failed),
 ..PaymentDetailsUpdate::new(payment_id)
 payment_hash,
 claimable_amount_msat: amount_msat,
 claim_deadline,
 custom_records,
 };
 match self.payment_store.update(&update) {
 match self.event_queue.add_event(event).await {
 Ok(_) => return Ok(()),
 Err(e) => {
 log_error!(self.logger, "Failed to access payment store: {}", e);
 log_error!(self.logger, "Failed to push to event queue: {}", e);
 return Err(ReplayEvent());
 },
 };
 //}

 //log_error!(
 //	self.logger,
 //	"Failed to claim payment with ID {}: preimage unknown.",
 //	payment_id,
 //);
 //self.channel_manager.fail_htlc_backwards(&payment_hash);

 //let update = PaymentDetailsUpdate {
 //	hash: Some(Some(payment_hash)),
 //	status: Some(PaymentStatus::Failed),
 //	..PaymentDetailsUpdate::new(payment_id)
 //};
 //match self.payment_store.update(&update) {
 //	Ok(_) => return Ok(()),
 //	Err(e) => {
 // log_error!(self.logger, "Failed to access payment store: {}", e);
 // return Err(ReplayEvent());
 //	},
 //};
 }
 },
 LdkEvent::PaymentClaimed {
Expand All@@ -927,9 +943,9 @@ where
 htlcs: _,
 sender_intended_total_msat: _,
 onion_fields,
 payment_id: _,
 payment_id,
 } => {
 let payment_id = PaymentId(payment_hash.0);
 let payment_id = payment_id.unwrap_or(PaymentId(payment_hash.0));
 log_info!(
 self.logger,
 "Claimed payment with ID {} from payment hash {} of {}msat.",
Expand DownExpand Up@@ -1002,7 +1018,7 @@ where
 }

 let event = Event::PaymentReceived {
 payment_id: Some(payment_id),
 payment_id,
 payment_hash,
 amount_msat,
 custom_records: onion_fields
Expand DownExpand Up@@ -1063,7 +1079,7 @@ where
 );
 });
 let event = Event::PaymentSuccessful {
 payment_id: Some(payment_id),
 payment_id,
 payment_hash,
 payment_preimage: Some(payment_preimage),
 fee_paid_msat,
Expand DownExpand Up@@ -1098,8 +1114,7 @@ where
 },
 };

 let event =
 Event::PaymentFailed { payment_id: Some(payment_id), payment_hash, reason };
 let event = Event::PaymentFailed { payment_id, payment_hash, reason };
 match self.event_queue.add_event(event).await {
 Ok(_) => return Ok(()),
 Err(e) => {
Expand Down
Loading
Loading