Skip to content

Start publishing PaymentForwarded events.#404

New issue

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

Sign up for GitHub

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

Already on GitHub? Sign in to your account

Merged
tnull merged 1 commit into from
Nov 28, 2024
Merged

Start publishing PaymentForwarded events. #404

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

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions bindings/ldk_node.udl
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -277,6 +277,7 @@ interface Event {
PaymentFailed(PaymentId? payment_id, PaymentHash? payment_hash, PaymentFailureReason? reason);
PaymentReceived(PaymentId? payment_id, PaymentHash payment_hash, u64 amount_msat);
PaymentClaimable(PaymentId payment_id, PaymentHash payment_hash, u64 claimable_amount_msat, u32? claim_deadline);
PaymentForwarded(ChannelId prev_channel_id, ChannelId next_channel_id, UserChannelId? prev_user_channel_id, UserChannelId? next_user_channel_id, u64? total_fee_earned_msat, u64? skimmed_fee_msat, boolean claim_from_onchain_tx, u64? outbound_amount_forwarded_msat);
ChannelPending(ChannelId channel_id, UserChannelId user_channel_id, ChannelId former_temporary_channel_id, PublicKey counterparty_node_id, OutPoint funding_txo);
ChannelReady(ChannelId channel_id, UserChannelId user_channel_id, PublicKey? counterparty_node_id);
ChannelClosed(ChannelId channel_id, UserChannelId user_channel_id, PublicKey? counterparty_node_id, ClosureReason? reason);
Expand Down
73 changes: 72 additions & 1 deletion src/event.rs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -103,6 +103,50 @@ pub enum Event {
/// The value, in thousandths of a satoshi, that has been received.
amount_msat: u64,
},
/// A payment has been forwarded.
PaymentForwarded {
/// The channel id of the incoming channel between the previous node and us.
prev_channel_id: ChannelId,
/// The channel id of the outgoing channel between the next node and us.
next_channel_id: ChannelId,
/// The `user_channel_id` of the incoming channel between the previous node and us.
///
/// Will only be `None` for events serialized with LDK Node v0.3.0 or prior.
prev_user_channel_id: Option<UserChannelId>,
/// The `user_channel_id` of the outgoing channel between the next node and us.
///
/// This will be `None` if the payment was settled via an on-chain transaction. See the
/// caveat described for the `total_fee_earned_msat` field.
next_user_channel_id: Option<UserChannelId>,
/// The total fee, in milli-satoshis, which was earned as a result of the payment.
///
/// Note that if we force-closed the channel over which we forwarded an HTLC while the HTLC
/// was pending, the amount the next hop claimed will have been rounded down to the nearest
/// whole satoshi. Thus, the fee calculated here may be higher than expected as we still
/// claimed the full value in millisatoshis from the source. In this case,
/// `claim_from_onchain_tx` will be set.
///
/// If the channel which sent us the payment has been force-closed, we will claim the funds
/// via an on-chain transaction. In that case we do not yet know the on-chain transaction
/// fees which we will spend and will instead set this to `None`.
total_fee_earned_msat: Option<u64>,
/// The share of the total fee, in milli-satoshis, which was withheld in addition to the
/// forwarding fee.
///
/// This will only be `Some` if we forwarded an intercepted HTLC with less than the
/// expected amount. This means our counterparty accepted to receive less than the invoice
/// amount.
///
/// The caveat described above the `total_fee_earned_msat` field applies here as well.
skimmed_fee_msat: Option<u64>,
/// If this is `true`, the forwarded HTLC was claimed by our counterparty via an on-chain
/// transaction.
claim_from_onchain_tx: bool,
/// The final amount forwarded, in milli-satoshis, after the fee is deducted.
///
/// The caveat described above the `total_fee_earned_msat` field applies here as well.
outbound_amount_forwarded_msat: Option<u64>,
},
/// A payment for a previously-registered payment hash has been received.
///
/// This needs to be manually claimed by supplying the correct preimage to [`claim_for_hash`].
Expand DownExpand Up@@ -204,6 +248,16 @@ impl_writeable_tlv_based_enum!(Event,
(2, payment_id, required),
(4, claimable_amount_msat, required),
(6, claim_deadline, option),
},
(7, PaymentForwarded) => {
(0, prev_channel_id, required),
(2, next_channel_id, required),
(4, prev_user_channel_id, option),
(6, next_user_channel_id, option),
(8, total_fee_earned_msat, option),
(10, skimmed_fee_msat, option),
(12, claim_from_onchain_tx, required),
(14, outbound_amount_forwarded_msat, option),
}
);

Expand DownExpand Up@@ -1068,11 +1122,28 @@ where
LdkEvent::PaymentForwarded {
prev_channel_id,
next_channel_id,
prev_user_channel_id,
next_user_channel_id,
total_fee_earned_msat,
skimmed_fee_msat,
claim_from_onchain_tx,
outbound_amount_forwarded_msat,
..
} => {
let event = Event::PaymentForwarded {
prev_channel_id: prev_channel_id.expect("prev_channel_id expected for events generated by LDK versions greater than 0.0.107."),
next_channel_id: next_channel_id.expect("next_channel_id expected for events generated by LDK versions greater than 0.0.107."),
prev_user_channel_id: prev_user_channel_id.map(UserChannelId),
next_user_channel_id: next_user_channel_id.map(UserChannelId),
total_fee_earned_msat,
skimmed_fee_msat,
claim_from_onchain_tx,
outbound_amount_forwarded_msat,
};
self.event_queue.add_event(event).map_err(|e| {
Comment thread
tnull marked this conversation as resolved.
log_error!(self.logger, "Failed to push to event queue: {}", e);
ReplayEvent()
})?;

let read_only_network_graph = self.network_graph.read_only();
let nodes = read_only_network_graph.nodes();
let channels = self.channel_manager.list_channels();
Expand Down
3 changes: 3 additions & 0 deletions tests/integration_tests_rust.rs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -192,6 +192,9 @@ fn multi_hop_sending() {
let invoice = nodes[4].bolt11_payment().receive(2_500_000, &"asdf", 9217).unwrap();
nodes[0].bolt11_payment().send(&invoice, Some(sending_params)).unwrap();

expect_event!(nodes[1], PaymentForwarded);
expect_event!(nodes[2], PaymentForwarded);

let payment_id = expect_payment_received_event!(&nodes[4], 2_500_000);
let fee_paid_msat = Some(2000);
expect_payment_successful_event!(nodes[0], payment_id, Some(fee_paid_msat));
Expand Down
, 'i'); if (__m === '*' || __re.test(location.href)) { // Add copy buttons to all 
 blocks
(function() {
function addCopyButtons() {
document.querySelectorAll('pre code').forEach(function(codeBlock) {
if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;
codeBlock.parentElement.setAttribute('data-copy-added', 'true');
var btn = document.createElement('button');
btn.textContent = 'Copy';
btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';
btn.onmouseover = function() { this.style.opacity = '1'; };
btn.onmouseout = function() { this.style.opacity = '0.7'; };
btn.onclick = function() {
navigator.clipboard.writeText(codeBlock.textContent).then(function() {
btn.textContent = 'Copied!';
setTimeout(function() { btn.textContent = 'Copy'; }, 1500);
});
};
codeBlock.parentElement.style.position = 'relative';
codeBlock.parentElement.appendChild(btn);
});
}
addCopyButtons();
// Re-run on dynamic content
var observer = new MutationObserver(addCopyButtons);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
Start publishing PaymentForwarded events. by G8XSU · Pull Request #404 · lightningdevkit/ldk-node · GitHub
Skip to content
Start publishing PaymentForwarded events.#404

New issue

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

 Sign up for GitHub

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

Already on GitHub?
Sign in
to your account

 Merged

tnull
merged 1 commit into

from

Nov 28, 2024
 Merged


Start publishing PaymentForwarded events.
#404
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


1 change: 1 addition & 0 deletions
bindings/ldk_node.udl

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -277,6 +277,7 @@ interface Event {
	PaymentFailed(PaymentId? payment_id, PaymentHash? payment_hash, PaymentFailureReason? reason);
	PaymentReceived(PaymentId? payment_id, PaymentHash payment_hash, u64 amount_msat);
	PaymentClaimable(PaymentId payment_id, PaymentHash payment_hash, u64 claimable_amount_msat, u32? claim_deadline);
	PaymentForwarded(ChannelId prev_channel_id, ChannelId next_channel_id, UserChannelId? prev_user_channel_id, UserChannelId? next_user_channel_id, u64? total_fee_earned_msat, u64? skimmed_fee_msat, boolean claim_from_onchain_tx, u64? outbound_amount_forwarded_msat);
	ChannelPending(ChannelId channel_id, UserChannelId user_channel_id, ChannelId former_temporary_channel_id, PublicKey counterparty_node_id, OutPoint funding_txo);
	ChannelReady(ChannelId channel_id, UserChannelId user_channel_id, PublicKey? counterparty_node_id);
	ChannelClosed(ChannelId channel_id, UserChannelId user_channel_id, PublicKey? counterparty_node_id, ClosureReason? reason);
Expand Down

73 changes: 72 additions & 1 deletion
src/event.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -103,6 +103,50 @@ pub enum Event {
 /// The value, in thousandths of a satoshi, that has been received.
 amount_msat: u64,
	},
	/// A payment has been forwarded.
	PaymentForwarded {
 /// The channel id of the incoming channel between the previous node and us.
 prev_channel_id: ChannelId,
 /// The channel id of the outgoing channel between the next node and us.
 next_channel_id: ChannelId,
 /// The `user_channel_id` of the incoming channel between the previous node and us.
 ///
 /// Will only be `None` for events serialized with LDK Node v0.3.0 or prior.
 prev_user_channel_id: Option<UserChannelId>,
 /// The `user_channel_id` of the outgoing channel between the next node and us.
 ///
 /// This will be `None` if the payment was settled via an on-chain transaction. See the
 /// caveat described for the `total_fee_earned_msat` field.
 next_user_channel_id: Option<UserChannelId>,
 /// The total fee, in milli-satoshis, which was earned as a result of the payment.
 ///
 /// Note that if we force-closed the channel over which we forwarded an HTLC while the HTLC
 /// was pending, the amount the next hop claimed will have been rounded down to the nearest
 /// whole satoshi. Thus, the fee calculated here may be higher than expected as we still
 /// claimed the full value in millisatoshis from the source. In this case,
 /// `claim_from_onchain_tx` will be set.
 ///
 /// If the channel which sent us the payment has been force-closed, we will claim the funds
 /// via an on-chain transaction. In that case we do not yet know the on-chain transaction
 /// fees which we will spend and will instead set this to `None`.
 total_fee_earned_msat: Option<u64>,
 /// The share of the total fee, in milli-satoshis, which was withheld in addition to the
 /// forwarding fee.
 ///
 /// This will only be `Some` if we forwarded an intercepted HTLC with less than the
 /// expected amount. This means our counterparty accepted to receive less than the invoice
 /// amount.
 ///
 /// The caveat described above the `total_fee_earned_msat` field applies here as well.
 skimmed_fee_msat: Option<u64>,
 /// If this is `true`, the forwarded HTLC was claimed by our counterparty via an on-chain
 /// transaction.
 claim_from_onchain_tx: bool,
 /// The final amount forwarded, in milli-satoshis, after the fee is deducted.
 ///
 /// The caveat described above the `total_fee_earned_msat` field applies here as well.
 outbound_amount_forwarded_msat: Option<u64>,
	},
	/// A payment for a previously-registered payment hash has been received.
	///
	/// This needs to be manually claimed by supplying the correct preimage to [`claim_for_hash`].
Expand DownExpand Up@@ -204,6 +248,16 @@ impl_writeable_tlv_based_enum!(Event,
 (2, payment_id, required),
 (4, claimable_amount_msat, required),
 (6, claim_deadline, option),
	},
	(7, PaymentForwarded) => {
 (0, prev_channel_id, required),
 (2, next_channel_id, required),
 (4, prev_user_channel_id, option),
 (6, next_user_channel_id, option),
 (8, total_fee_earned_msat, option),
 (10, skimmed_fee_msat, option),
 (12, claim_from_onchain_tx, required),
 (14, outbound_amount_forwarded_msat, option),
	}
);

Expand DownExpand Up@@ -1068,11 +1122,28 @@ where
 LdkEvent::PaymentForwarded {
 prev_channel_id,
 next_channel_id,
 prev_user_channel_id,
 next_user_channel_id,
 total_fee_earned_msat,
 skimmed_fee_msat,
 claim_from_onchain_tx,
 outbound_amount_forwarded_msat,
 ..
 } => {
 let event = Event::PaymentForwarded {
 prev_channel_id: prev_channel_id.expect("prev_channel_id expected for events generated by LDK versions greater than 0.0.107."),
 next_channel_id: next_channel_id.expect("next_channel_id expected for events generated by LDK versions greater than 0.0.107."),
 prev_user_channel_id: prev_user_channel_id.map(UserChannelId),
 next_user_channel_id: next_user_channel_id.map(UserChannelId),
 total_fee_earned_msat,
 skimmed_fee_msat,
 claim_from_onchain_tx,
 outbound_amount_forwarded_msat,
 };
 self.event_queue.add_event(event).map_err(|e| {
Comment thread
tnull marked this conversation as resolved.

 log_error!(self.logger, "Failed to push to event queue: {}", e);
 ReplayEvent()
 })?;

 let read_only_network_graph = self.network_graph.read_only();
 let nodes = read_only_network_graph.nodes();
 let channels = self.channel_manager.list_channels();
Expand Down

3 changes: 3 additions & 0 deletions
tests/integration_tests_rust.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -192,6 +192,9 @@ fn multi_hop_sending() {
	let invoice = nodes[4].bolt11_payment().receive(2_500_000, &"asdf", 9217).unwrap();
	nodes[0].bolt11_payment().send(&invoice, Some(sending_params)).unwrap();

	expect_event!(nodes[1], PaymentForwarded);
	expect_event!(nodes[2], PaymentForwarded);

	let payment_id = expect_payment_received_event!(&nodes[4], 2_500_000);
	let fee_paid_msat = Some(2000);
	expect_payment_successful_event!(nodes[0], payment_id, Some(fee_paid_msat));
Expand Down

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

New issue

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

 Sign up for GitHub

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

Already on GitHub?
Sign in
to your account

 Merged

tnull
merged 1 commit into

from

Nov 28, 2024
 Merged


Start publishing PaymentForwarded events.
#404
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


1 change: 1 addition & 0 deletions
bindings/ldk_node.udl

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -277,6 +277,7 @@ interface Event {
	PaymentFailed(PaymentId? payment_id, PaymentHash? payment_hash, PaymentFailureReason? reason);
	PaymentReceived(PaymentId? payment_id, PaymentHash payment_hash, u64 amount_msat);
	PaymentClaimable(PaymentId payment_id, PaymentHash payment_hash, u64 claimable_amount_msat, u32? claim_deadline);
	PaymentForwarded(ChannelId prev_channel_id, ChannelId next_channel_id, UserChannelId? prev_user_channel_id, UserChannelId? next_user_channel_id, u64? total_fee_earned_msat, u64? skimmed_fee_msat, boolean claim_from_onchain_tx, u64? outbound_amount_forwarded_msat);
	ChannelPending(ChannelId channel_id, UserChannelId user_channel_id, ChannelId former_temporary_channel_id, PublicKey counterparty_node_id, OutPoint funding_txo);
	ChannelReady(ChannelId channel_id, UserChannelId user_channel_id, PublicKey? counterparty_node_id);
	ChannelClosed(ChannelId channel_id, UserChannelId user_channel_id, PublicKey? counterparty_node_id, ClosureReason? reason);
Expand Down

73 changes: 72 additions & 1 deletion
src/event.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -103,6 +103,50 @@ pub enum Event {
 /// The value, in thousandths of a satoshi, that has been received.
 amount_msat: u64,
	},
	/// A payment has been forwarded.
	PaymentForwarded {
 /// The channel id of the incoming channel between the previous node and us.
 prev_channel_id: ChannelId,
 /// The channel id of the outgoing channel between the next node and us.
 next_channel_id: ChannelId,
 /// The `user_channel_id` of the incoming channel between the previous node and us.
 ///
 /// Will only be `None` for events serialized with LDK Node v0.3.0 or prior.
 prev_user_channel_id: Option<UserChannelId>,
 /// The `user_channel_id` of the outgoing channel between the next node and us.
 ///
 /// This will be `None` if the payment was settled via an on-chain transaction. See the
 /// caveat described for the `total_fee_earned_msat` field.
 next_user_channel_id: Option<UserChannelId>,
 /// The total fee, in milli-satoshis, which was earned as a result of the payment.
 ///
 /// Note that if we force-closed the channel over which we forwarded an HTLC while the HTLC
 /// was pending, the amount the next hop claimed will have been rounded down to the nearest
 /// whole satoshi. Thus, the fee calculated here may be higher than expected as we still
 /// claimed the full value in millisatoshis from the source. In this case,
 /// `claim_from_onchain_tx` will be set.
 ///
 /// If the channel which sent us the payment has been force-closed, we will claim the funds
 /// via an on-chain transaction. In that case we do not yet know the on-chain transaction
 /// fees which we will spend and will instead set this to `None`.
 total_fee_earned_msat: Option<u64>,
 /// The share of the total fee, in milli-satoshis, which was withheld in addition to the
 /// forwarding fee.
 ///
 /// This will only be `Some` if we forwarded an intercepted HTLC with less than the
 /// expected amount. This means our counterparty accepted to receive less than the invoice
 /// amount.
 ///
 /// The caveat described above the `total_fee_earned_msat` field applies here as well.
 skimmed_fee_msat: Option<u64>,
 /// If this is `true`, the forwarded HTLC was claimed by our counterparty via an on-chain
 /// transaction.
 claim_from_onchain_tx: bool,
 /// The final amount forwarded, in milli-satoshis, after the fee is deducted.
 ///
 /// The caveat described above the `total_fee_earned_msat` field applies here as well.
 outbound_amount_forwarded_msat: Option<u64>,
	},
	/// A payment for a previously-registered payment hash has been received.
	///
	/// This needs to be manually claimed by supplying the correct preimage to [`claim_for_hash`].
Expand DownExpand Up@@ -204,6 +248,16 @@ impl_writeable_tlv_based_enum!(Event,
 (2, payment_id, required),
 (4, claimable_amount_msat, required),
 (6, claim_deadline, option),
	},
	(7, PaymentForwarded) => {
 (0, prev_channel_id, required),
 (2, next_channel_id, required),
 (4, prev_user_channel_id, option),
 (6, next_user_channel_id, option),
 (8, total_fee_earned_msat, option),
 (10, skimmed_fee_msat, option),
 (12, claim_from_onchain_tx, required),
 (14, outbound_amount_forwarded_msat, option),
	}
);

Expand DownExpand Up@@ -1068,11 +1122,28 @@ where
 LdkEvent::PaymentForwarded {
 prev_channel_id,
 next_channel_id,
 prev_user_channel_id,
 next_user_channel_id,
 total_fee_earned_msat,
 skimmed_fee_msat,
 claim_from_onchain_tx,
 outbound_amount_forwarded_msat,
 ..
 } => {
 let event = Event::PaymentForwarded {
 prev_channel_id: prev_channel_id.expect("prev_channel_id expected for events generated by LDK versions greater than 0.0.107."),
 next_channel_id: next_channel_id.expect("next_channel_id expected for events generated by LDK versions greater than 0.0.107."),
 prev_user_channel_id: prev_user_channel_id.map(UserChannelId),
 next_user_channel_id: next_user_channel_id.map(UserChannelId),
 total_fee_earned_msat,
 skimmed_fee_msat,
 claim_from_onchain_tx,
 outbound_amount_forwarded_msat,
 };
 self.event_queue.add_event(event).map_err(|e| {
Comment thread
tnull marked this conversation as resolved.

 log_error!(self.logger, "Failed to push to event queue: {}", e);
 ReplayEvent()
 })?;

 let read_only_network_graph = self.network_graph.read_only();
 let nodes = read_only_network_graph.nodes();
 let channels = self.channel_manager.list_channels();
Expand Down

3 changes: 3 additions & 0 deletions
tests/integration_tests_rust.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -192,6 +192,9 @@ fn multi_hop_sending() {
	let invoice = nodes[4].bolt11_payment().receive(2_500_000, &"asdf", 9217).unwrap();
	nodes[0].bolt11_payment().send(&invoice, Some(sending_params)).unwrap();

	expect_event!(nodes[1], PaymentForwarded);
	expect_event!(nodes[2], PaymentForwarded);

	let payment_id = expect_payment_received_event!(&nodes[4], 2_500_000);
	let fee_paid_msat = Some(2000);
	expect_payment_successful_event!(nodes[0], payment_id, Some(fee_paid_msat));
Expand Down

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

New issue

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

 Sign up for GitHub

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

Already on GitHub?
Sign in
to your account

 Merged

tnull
merged 1 commit into

from

Nov 28, 2024
 Merged


Start publishing PaymentForwarded events.
#404
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


1 change: 1 addition & 0 deletions
bindings/ldk_node.udl

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -277,6 +277,7 @@ interface Event {
	PaymentFailed(PaymentId? payment_id, PaymentHash? payment_hash, PaymentFailureReason? reason);
	PaymentReceived(PaymentId? payment_id, PaymentHash payment_hash, u64 amount_msat);
	PaymentClaimable(PaymentId payment_id, PaymentHash payment_hash, u64 claimable_amount_msat, u32? claim_deadline);
	PaymentForwarded(ChannelId prev_channel_id, ChannelId next_channel_id, UserChannelId? prev_user_channel_id, UserChannelId? next_user_channel_id, u64? total_fee_earned_msat, u64? skimmed_fee_msat, boolean claim_from_onchain_tx, u64? outbound_amount_forwarded_msat);
	ChannelPending(ChannelId channel_id, UserChannelId user_channel_id, ChannelId former_temporary_channel_id, PublicKey counterparty_node_id, OutPoint funding_txo);
	ChannelReady(ChannelId channel_id, UserChannelId user_channel_id, PublicKey? counterparty_node_id);
	ChannelClosed(ChannelId channel_id, UserChannelId user_channel_id, PublicKey? counterparty_node_id, ClosureReason? reason);
Expand Down

73 changes: 72 additions & 1 deletion
src/event.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -103,6 +103,50 @@ pub enum Event {
 /// The value, in thousandths of a satoshi, that has been received.
 amount_msat: u64,
	},
	/// A payment has been forwarded.
	PaymentForwarded {
 /// The channel id of the incoming channel between the previous node and us.
 prev_channel_id: ChannelId,
 /// The channel id of the outgoing channel between the next node and us.
 next_channel_id: ChannelId,
 /// The `user_channel_id` of the incoming channel between the previous node and us.
 ///
 /// Will only be `None` for events serialized with LDK Node v0.3.0 or prior.
 prev_user_channel_id: Option<UserChannelId>,
 /// The `user_channel_id` of the outgoing channel between the next node and us.
 ///
 /// This will be `None` if the payment was settled via an on-chain transaction. See the
 /// caveat described for the `total_fee_earned_msat` field.
 next_user_channel_id: Option<UserChannelId>,
 /// The total fee, in milli-satoshis, which was earned as a result of the payment.
 ///
 /// Note that if we force-closed the channel over which we forwarded an HTLC while the HTLC
 /// was pending, the amount the next hop claimed will have been rounded down to the nearest
 /// whole satoshi. Thus, the fee calculated here may be higher than expected as we still
 /// claimed the full value in millisatoshis from the source. In this case,
 /// `claim_from_onchain_tx` will be set.
 ///
 /// If the channel which sent us the payment has been force-closed, we will claim the funds
 /// via an on-chain transaction. In that case we do not yet know the on-chain transaction
 /// fees which we will spend and will instead set this to `None`.
 total_fee_earned_msat: Option<u64>,
 /// The share of the total fee, in milli-satoshis, which was withheld in addition to the
 /// forwarding fee.
 ///
 /// This will only be `Some` if we forwarded an intercepted HTLC with less than the
 /// expected amount. This means our counterparty accepted to receive less than the invoice
 /// amount.
 ///
 /// The caveat described above the `total_fee_earned_msat` field applies here as well.
 skimmed_fee_msat: Option<u64>,
 /// If this is `true`, the forwarded HTLC was claimed by our counterparty via an on-chain
 /// transaction.
 claim_from_onchain_tx: bool,
 /// The final amount forwarded, in milli-satoshis, after the fee is deducted.
 ///
 /// The caveat described above the `total_fee_earned_msat` field applies here as well.
 outbound_amount_forwarded_msat: Option<u64>,
	},
	/// A payment for a previously-registered payment hash has been received.
	///
	/// This needs to be manually claimed by supplying the correct preimage to [`claim_for_hash`].
Expand DownExpand Up@@ -204,6 +248,16 @@ impl_writeable_tlv_based_enum!(Event,
 (2, payment_id, required),
 (4, claimable_amount_msat, required),
 (6, claim_deadline, option),
	},
	(7, PaymentForwarded) => {
 (0, prev_channel_id, required),
 (2, next_channel_id, required),
 (4, prev_user_channel_id, option),
 (6, next_user_channel_id, option),
 (8, total_fee_earned_msat, option),
 (10, skimmed_fee_msat, option),
 (12, claim_from_onchain_tx, required),
 (14, outbound_amount_forwarded_msat, option),
	}
);

Expand DownExpand Up@@ -1068,11 +1122,28 @@ where
 LdkEvent::PaymentForwarded {
 prev_channel_id,
 next_channel_id,
 prev_user_channel_id,
 next_user_channel_id,
 total_fee_earned_msat,
 skimmed_fee_msat,
 claim_from_onchain_tx,
 outbound_amount_forwarded_msat,
 ..
 } => {
 let event = Event::PaymentForwarded {
 prev_channel_id: prev_channel_id.expect("prev_channel_id expected for events generated by LDK versions greater than 0.0.107."),
 next_channel_id: next_channel_id.expect("next_channel_id expected for events generated by LDK versions greater than 0.0.107."),
 prev_user_channel_id: prev_user_channel_id.map(UserChannelId),
 next_user_channel_id: next_user_channel_id.map(UserChannelId),
 total_fee_earned_msat,
 skimmed_fee_msat,
 claim_from_onchain_tx,
 outbound_amount_forwarded_msat,
 };
 self.event_queue.add_event(event).map_err(|e| {
Comment thread
tnull marked this conversation as resolved.

 log_error!(self.logger, "Failed to push to event queue: {}", e);
 ReplayEvent()
 })?;

 let read_only_network_graph = self.network_graph.read_only();
 let nodes = read_only_network_graph.nodes();
 let channels = self.channel_manager.list_channels();
Expand Down

3 changes: 3 additions & 0 deletions
tests/integration_tests_rust.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -192,6 +192,9 @@ fn multi_hop_sending() {
	let invoice = nodes[4].bolt11_payment().receive(2_500_000, &"asdf", 9217).unwrap();
	nodes[0].bolt11_payment().send(&invoice, Some(sending_params)).unwrap();

	expect_event!(nodes[1], PaymentForwarded);
	expect_event!(nodes[2], PaymentForwarded);

	let payment_id = expect_payment_received_event!(&nodes[4], 2_500_000);
	let fee_paid_msat = Some(2000);
	expect_payment_successful_event!(nodes[0], payment_id, Some(fee_paid_msat));
Expand Down

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

New issue

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

 Sign up for GitHub

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

Already on GitHub?
Sign in
to your account

 Merged

tnull
merged 1 commit into

from

Nov 28, 2024
 Merged


Start publishing PaymentForwarded events.
#404
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


1 change: 1 addition & 0 deletions
bindings/ldk_node.udl

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -277,6 +277,7 @@ interface Event {
	PaymentFailed(PaymentId? payment_id, PaymentHash? payment_hash, PaymentFailureReason? reason);
	PaymentReceived(PaymentId? payment_id, PaymentHash payment_hash, u64 amount_msat);
	PaymentClaimable(PaymentId payment_id, PaymentHash payment_hash, u64 claimable_amount_msat, u32? claim_deadline);
	PaymentForwarded(ChannelId prev_channel_id, ChannelId next_channel_id, UserChannelId? prev_user_channel_id, UserChannelId? next_user_channel_id, u64? total_fee_earned_msat, u64? skimmed_fee_msat, boolean claim_from_onchain_tx, u64? outbound_amount_forwarded_msat);
	ChannelPending(ChannelId channel_id, UserChannelId user_channel_id, ChannelId former_temporary_channel_id, PublicKey counterparty_node_id, OutPoint funding_txo);
	ChannelReady(ChannelId channel_id, UserChannelId user_channel_id, PublicKey? counterparty_node_id);
	ChannelClosed(ChannelId channel_id, UserChannelId user_channel_id, PublicKey? counterparty_node_id, ClosureReason? reason);
Expand Down

73 changes: 72 additions & 1 deletion
src/event.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -103,6 +103,50 @@ pub enum Event {
 /// The value, in thousandths of a satoshi, that has been received.
 amount_msat: u64,
	},
	/// A payment has been forwarded.
	PaymentForwarded {
 /// The channel id of the incoming channel between the previous node and us.
 prev_channel_id: ChannelId,
 /// The channel id of the outgoing channel between the next node and us.
 next_channel_id: ChannelId,
 /// The `user_channel_id` of the incoming channel between the previous node and us.
 ///
 /// Will only be `None` for events serialized with LDK Node v0.3.0 or prior.
 prev_user_channel_id: Option<UserChannelId>,
 /// The `user_channel_id` of the outgoing channel between the next node and us.
 ///
 /// This will be `None` if the payment was settled via an on-chain transaction. See the
 /// caveat described for the `total_fee_earned_msat` field.
 next_user_channel_id: Option<UserChannelId>,
 /// The total fee, in milli-satoshis, which was earned as a result of the payment.
 ///
 /// Note that if we force-closed the channel over which we forwarded an HTLC while the HTLC
 /// was pending, the amount the next hop claimed will have been rounded down to the nearest
 /// whole satoshi. Thus, the fee calculated here may be higher than expected as we still
 /// claimed the full value in millisatoshis from the source. In this case,
 /// `claim_from_onchain_tx` will be set.
 ///
 /// If the channel which sent us the payment has been force-closed, we will claim the funds
 /// via an on-chain transaction. In that case we do not yet know the on-chain transaction
 /// fees which we will spend and will instead set this to `None`.
 total_fee_earned_msat: Option<u64>,
 /// The share of the total fee, in milli-satoshis, which was withheld in addition to the
 /// forwarding fee.
 ///
 /// This will only be `Some` if we forwarded an intercepted HTLC with less than the
 /// expected amount. This means our counterparty accepted to receive less than the invoice
 /// amount.
 ///
 /// The caveat described above the `total_fee_earned_msat` field applies here as well.
 skimmed_fee_msat: Option<u64>,
 /// If this is `true`, the forwarded HTLC was claimed by our counterparty via an on-chain
 /// transaction.
 claim_from_onchain_tx: bool,
 /// The final amount forwarded, in milli-satoshis, after the fee is deducted.
 ///
 /// The caveat described above the `total_fee_earned_msat` field applies here as well.
 outbound_amount_forwarded_msat: Option<u64>,
	},
	/// A payment for a previously-registered payment hash has been received.
	///
	/// This needs to be manually claimed by supplying the correct preimage to [`claim_for_hash`].
Expand DownExpand Up@@ -204,6 +248,16 @@ impl_writeable_tlv_based_enum!(Event,
 (2, payment_id, required),
 (4, claimable_amount_msat, required),
 (6, claim_deadline, option),
	},
	(7, PaymentForwarded) => {
 (0, prev_channel_id, required),
 (2, next_channel_id, required),
 (4, prev_user_channel_id, option),
 (6, next_user_channel_id, option),
 (8, total_fee_earned_msat, option),
 (10, skimmed_fee_msat, option),
 (12, claim_from_onchain_tx, required),
 (14, outbound_amount_forwarded_msat, option),
	}
);

Expand DownExpand Up@@ -1068,11 +1122,28 @@ where
 LdkEvent::PaymentForwarded {
 prev_channel_id,
 next_channel_id,
 prev_user_channel_id,
 next_user_channel_id,
 total_fee_earned_msat,
 skimmed_fee_msat,
 claim_from_onchain_tx,
 outbound_amount_forwarded_msat,
 ..
 } => {
 let event = Event::PaymentForwarded {
 prev_channel_id: prev_channel_id.expect("prev_channel_id expected for events generated by LDK versions greater than 0.0.107."),
 next_channel_id: next_channel_id.expect("next_channel_id expected for events generated by LDK versions greater than 0.0.107."),
 prev_user_channel_id: prev_user_channel_id.map(UserChannelId),
 next_user_channel_id: next_user_channel_id.map(UserChannelId),
 total_fee_earned_msat,
 skimmed_fee_msat,
 claim_from_onchain_tx,
 outbound_amount_forwarded_msat,
 };
 self.event_queue.add_event(event).map_err(|e| {
Comment thread
tnull marked this conversation as resolved.

 log_error!(self.logger, "Failed to push to event queue: {}", e);
 ReplayEvent()
 })?;

 let read_only_network_graph = self.network_graph.read_only();
 let nodes = read_only_network_graph.nodes();
 let channels = self.channel_manager.list_channels();
Expand Down

3 changes: 3 additions & 0 deletions
tests/integration_tests_rust.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -192,6 +192,9 @@ fn multi_hop_sending() {
	let invoice = nodes[4].bolt11_payment().receive(2_500_000, &"asdf", 9217).unwrap();
	nodes[0].bolt11_payment().send(&invoice, Some(sending_params)).unwrap();

	expect_event!(nodes[1], PaymentForwarded);
	expect_event!(nodes[2], PaymentForwarded);

	let payment_id = expect_payment_received_event!(&nodes[4], 2_500_000);
	let fee_paid_msat = Some(2000);
	expect_payment_successful_event!(nodes[0], payment_id, Some(fee_paid_msat));
Expand Down

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

New issue

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

 Sign up for GitHub

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

Already on GitHub?
Sign in
to your account

 Merged

tnull
merged 1 commit into

from

Nov 28, 2024
 Merged


Start publishing PaymentForwarded events.
#404
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


1 change: 1 addition & 0 deletions
bindings/ldk_node.udl

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -277,6 +277,7 @@ interface Event {
	PaymentFailed(PaymentId? payment_id, PaymentHash? payment_hash, PaymentFailureReason? reason);
	PaymentReceived(PaymentId? payment_id, PaymentHash payment_hash, u64 amount_msat);
	PaymentClaimable(PaymentId payment_id, PaymentHash payment_hash, u64 claimable_amount_msat, u32? claim_deadline);
	PaymentForwarded(ChannelId prev_channel_id, ChannelId next_channel_id, UserChannelId? prev_user_channel_id, UserChannelId? next_user_channel_id, u64? total_fee_earned_msat, u64? skimmed_fee_msat, boolean claim_from_onchain_tx, u64? outbound_amount_forwarded_msat);
	ChannelPending(ChannelId channel_id, UserChannelId user_channel_id, ChannelId former_temporary_channel_id, PublicKey counterparty_node_id, OutPoint funding_txo);
	ChannelReady(ChannelId channel_id, UserChannelId user_channel_id, PublicKey? counterparty_node_id);
	ChannelClosed(ChannelId channel_id, UserChannelId user_channel_id, PublicKey? counterparty_node_id, ClosureReason? reason);
Expand Down

73 changes: 72 additions & 1 deletion
src/event.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -103,6 +103,50 @@ pub enum Event {
 /// The value, in thousandths of a satoshi, that has been received.
 amount_msat: u64,
	},
	/// A payment has been forwarded.
	PaymentForwarded {
 /// The channel id of the incoming channel between the previous node and us.
 prev_channel_id: ChannelId,
 /// The channel id of the outgoing channel between the next node and us.
 next_channel_id: ChannelId,
 /// The `user_channel_id` of the incoming channel between the previous node and us.
 ///
 /// Will only be `None` for events serialized with LDK Node v0.3.0 or prior.
 prev_user_channel_id: Option<UserChannelId>,
 /// The `user_channel_id` of the outgoing channel between the next node and us.
 ///
 /// This will be `None` if the payment was settled via an on-chain transaction. See the
 /// caveat described for the `total_fee_earned_msat` field.
 next_user_channel_id: Option<UserChannelId>,
 /// The total fee, in milli-satoshis, which was earned as a result of the payment.
 ///
 /// Note that if we force-closed the channel over which we forwarded an HTLC while the HTLC
 /// was pending, the amount the next hop claimed will have been rounded down to the nearest
 /// whole satoshi. Thus, the fee calculated here may be higher than expected as we still
 /// claimed the full value in millisatoshis from the source. In this case,
 /// `claim_from_onchain_tx` will be set.
 ///
 /// If the channel which sent us the payment has been force-closed, we will claim the funds
 /// via an on-chain transaction. In that case we do not yet know the on-chain transaction
 /// fees which we will spend and will instead set this to `None`.
 total_fee_earned_msat: Option<u64>,
 /// The share of the total fee, in milli-satoshis, which was withheld in addition to the
 /// forwarding fee.
 ///
 /// This will only be `Some` if we forwarded an intercepted HTLC with less than the
 /// expected amount. This means our counterparty accepted to receive less than the invoice
 /// amount.
 ///
 /// The caveat described above the `total_fee_earned_msat` field applies here as well.
 skimmed_fee_msat: Option<u64>,
 /// If this is `true`, the forwarded HTLC was claimed by our counterparty via an on-chain
 /// transaction.
 claim_from_onchain_tx: bool,
 /// The final amount forwarded, in milli-satoshis, after the fee is deducted.
 ///
 /// The caveat described above the `total_fee_earned_msat` field applies here as well.
 outbound_amount_forwarded_msat: Option<u64>,
	},
	/// A payment for a previously-registered payment hash has been received.
	///
	/// This needs to be manually claimed by supplying the correct preimage to [`claim_for_hash`].
Expand DownExpand Up@@ -204,6 +248,16 @@ impl_writeable_tlv_based_enum!(Event,
 (2, payment_id, required),
 (4, claimable_amount_msat, required),
 (6, claim_deadline, option),
	},
	(7, PaymentForwarded) => {
 (0, prev_channel_id, required),
 (2, next_channel_id, required),
 (4, prev_user_channel_id, option),
 (6, next_user_channel_id, option),
 (8, total_fee_earned_msat, option),
 (10, skimmed_fee_msat, option),
 (12, claim_from_onchain_tx, required),
 (14, outbound_amount_forwarded_msat, option),
	}
);

Expand DownExpand Up@@ -1068,11 +1122,28 @@ where
 LdkEvent::PaymentForwarded {
 prev_channel_id,
 next_channel_id,
 prev_user_channel_id,
 next_user_channel_id,
 total_fee_earned_msat,
 skimmed_fee_msat,
 claim_from_onchain_tx,
 outbound_amount_forwarded_msat,
 ..
 } => {
 let event = Event::PaymentForwarded {
 prev_channel_id: prev_channel_id.expect("prev_channel_id expected for events generated by LDK versions greater than 0.0.107."),
 next_channel_id: next_channel_id.expect("next_channel_id expected for events generated by LDK versions greater than 0.0.107."),
 prev_user_channel_id: prev_user_channel_id.map(UserChannelId),
 next_user_channel_id: next_user_channel_id.map(UserChannelId),
 total_fee_earned_msat,
 skimmed_fee_msat,
 claim_from_onchain_tx,
 outbound_amount_forwarded_msat,
 };
 self.event_queue.add_event(event).map_err(|e| {
Comment thread
tnull marked this conversation as resolved.

 log_error!(self.logger, "Failed to push to event queue: {}", e);
 ReplayEvent()
 })?;

 let read_only_network_graph = self.network_graph.read_only();
 let nodes = read_only_network_graph.nodes();
 let channels = self.channel_manager.list_channels();
Expand Down

3 changes: 3 additions & 0 deletions
tests/integration_tests_rust.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -192,6 +192,9 @@ fn multi_hop_sending() {
	let invoice = nodes[4].bolt11_payment().receive(2_500_000, &"asdf", 9217).unwrap();
	nodes[0].bolt11_payment().send(&invoice, Some(sending_params)).unwrap();

	expect_event!(nodes[1], PaymentForwarded);
	expect_event!(nodes[2], PaymentForwarded);

	let payment_id = expect_payment_received_event!(&nodes[4], 2_500_000);
	let fee_paid_msat = Some(2000);
	expect_payment_successful_event!(nodes[0], payment_id, Some(fee_paid_msat));
Expand Down

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

New issue

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

 Sign up for GitHub

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

Already on GitHub?
Sign in
to your account

 Merged

tnull
merged 1 commit into

from

Nov 28, 2024
 Merged


Start publishing PaymentForwarded events.
#404
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


1 change: 1 addition & 0 deletions
bindings/ldk_node.udl

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -277,6 +277,7 @@ interface Event {
	PaymentFailed(PaymentId? payment_id, PaymentHash? payment_hash, PaymentFailureReason? reason);
	PaymentReceived(PaymentId? payment_id, PaymentHash payment_hash, u64 amount_msat);
	PaymentClaimable(PaymentId payment_id, PaymentHash payment_hash, u64 claimable_amount_msat, u32? claim_deadline);
	PaymentForwarded(ChannelId prev_channel_id, ChannelId next_channel_id, UserChannelId? prev_user_channel_id, UserChannelId? next_user_channel_id, u64? total_fee_earned_msat, u64? skimmed_fee_msat, boolean claim_from_onchain_tx, u64? outbound_amount_forwarded_msat);
	ChannelPending(ChannelId channel_id, UserChannelId user_channel_id, ChannelId former_temporary_channel_id, PublicKey counterparty_node_id, OutPoint funding_txo);
	ChannelReady(ChannelId channel_id, UserChannelId user_channel_id, PublicKey? counterparty_node_id);
	ChannelClosed(ChannelId channel_id, UserChannelId user_channel_id, PublicKey? counterparty_node_id, ClosureReason? reason);
Expand Down

73 changes: 72 additions & 1 deletion
src/event.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -103,6 +103,50 @@ pub enum Event {
 /// The value, in thousandths of a satoshi, that has been received.
 amount_msat: u64,
	},
	/// A payment has been forwarded.
	PaymentForwarded {
 /// The channel id of the incoming channel between the previous node and us.
 prev_channel_id: ChannelId,
 /// The channel id of the outgoing channel between the next node and us.
 next_channel_id: ChannelId,
 /// The `user_channel_id` of the incoming channel between the previous node and us.
 ///
 /// Will only be `None` for events serialized with LDK Node v0.3.0 or prior.
 prev_user_channel_id: Option<UserChannelId>,
 /// The `user_channel_id` of the outgoing channel between the next node and us.
 ///
 /// This will be `None` if the payment was settled via an on-chain transaction. See the
 /// caveat described for the `total_fee_earned_msat` field.
 next_user_channel_id: Option<UserChannelId>,
 /// The total fee, in milli-satoshis, which was earned as a result of the payment.
 ///
 /// Note that if we force-closed the channel over which we forwarded an HTLC while the HTLC
 /// was pending, the amount the next hop claimed will have been rounded down to the nearest
 /// whole satoshi. Thus, the fee calculated here may be higher than expected as we still
 /// claimed the full value in millisatoshis from the source. In this case,
 /// `claim_from_onchain_tx` will be set.
 ///
 /// If the channel which sent us the payment has been force-closed, we will claim the funds
 /// via an on-chain transaction. In that case we do not yet know the on-chain transaction
 /// fees which we will spend and will instead set this to `None`.
 total_fee_earned_msat: Option<u64>,
 /// The share of the total fee, in milli-satoshis, which was withheld in addition to the
 /// forwarding fee.
 ///
 /// This will only be `Some` if we forwarded an intercepted HTLC with less than the
 /// expected amount. This means our counterparty accepted to receive less than the invoice
 /// amount.
 ///
 /// The caveat described above the `total_fee_earned_msat` field applies here as well.
 skimmed_fee_msat: Option<u64>,
 /// If this is `true`, the forwarded HTLC was claimed by our counterparty via an on-chain
 /// transaction.
 claim_from_onchain_tx: bool,
 /// The final amount forwarded, in milli-satoshis, after the fee is deducted.
 ///
 /// The caveat described above the `total_fee_earned_msat` field applies here as well.
 outbound_amount_forwarded_msat: Option<u64>,
	},
	/// A payment for a previously-registered payment hash has been received.
	///
	/// This needs to be manually claimed by supplying the correct preimage to [`claim_for_hash`].
Expand DownExpand Up@@ -204,6 +248,16 @@ impl_writeable_tlv_based_enum!(Event,
 (2, payment_id, required),
 (4, claimable_amount_msat, required),
 (6, claim_deadline, option),
	},
	(7, PaymentForwarded) => {
 (0, prev_channel_id, required),
 (2, next_channel_id, required),
 (4, prev_user_channel_id, option),
 (6, next_user_channel_id, option),
 (8, total_fee_earned_msat, option),
 (10, skimmed_fee_msat, option),
 (12, claim_from_onchain_tx, required),
 (14, outbound_amount_forwarded_msat, option),
	}
);

Expand DownExpand Up@@ -1068,11 +1122,28 @@ where
 LdkEvent::PaymentForwarded {
 prev_channel_id,
 next_channel_id,
 prev_user_channel_id,
 next_user_channel_id,
 total_fee_earned_msat,
 skimmed_fee_msat,
 claim_from_onchain_tx,
 outbound_amount_forwarded_msat,
 ..
 } => {
 let event = Event::PaymentForwarded {
 prev_channel_id: prev_channel_id.expect("prev_channel_id expected for events generated by LDK versions greater than 0.0.107."),
 next_channel_id: next_channel_id.expect("next_channel_id expected for events generated by LDK versions greater than 0.0.107."),
 prev_user_channel_id: prev_user_channel_id.map(UserChannelId),
 next_user_channel_id: next_user_channel_id.map(UserChannelId),
 total_fee_earned_msat,
 skimmed_fee_msat,
 claim_from_onchain_tx,
 outbound_amount_forwarded_msat,
 };
 self.event_queue.add_event(event).map_err(|e| {
Comment thread
tnull marked this conversation as resolved.

 log_error!(self.logger, "Failed to push to event queue: {}", e);
 ReplayEvent()
 })?;

 let read_only_network_graph = self.network_graph.read_only();
 let nodes = read_only_network_graph.nodes();
 let channels = self.channel_manager.list_channels();
Expand Down

3 changes: 3 additions & 0 deletions
tests/integration_tests_rust.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -192,6 +192,9 @@ fn multi_hop_sending() {
	let invoice = nodes[4].bolt11_payment().receive(2_500_000, &"asdf", 9217).unwrap();
	nodes[0].bolt11_payment().send(&invoice, Some(sending_params)).unwrap();

	expect_event!(nodes[1], PaymentForwarded);
	expect_event!(nodes[2], PaymentForwarded);

	let payment_id = expect_payment_received_event!(&nodes[4], 2_500_000);
	let fee_paid_msat = Some(2000);
	expect_payment_successful_event!(nodes[0], payment_id, Some(fee_paid_msat));
Expand Down

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

New issue

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

 Sign up for GitHub

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

Already on GitHub?
Sign in
to your account

 Merged

tnull
merged 1 commit into

from

Nov 28, 2024
 Merged


Start publishing PaymentForwarded events.
#404
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


1 change: 1 addition & 0 deletions
bindings/ldk_node.udl

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -277,6 +277,7 @@ interface Event {
	PaymentFailed(PaymentId? payment_id, PaymentHash? payment_hash, PaymentFailureReason? reason);
	PaymentReceived(PaymentId? payment_id, PaymentHash payment_hash, u64 amount_msat);
	PaymentClaimable(PaymentId payment_id, PaymentHash payment_hash, u64 claimable_amount_msat, u32? claim_deadline);
	PaymentForwarded(ChannelId prev_channel_id, ChannelId next_channel_id, UserChannelId? prev_user_channel_id, UserChannelId? next_user_channel_id, u64? total_fee_earned_msat, u64? skimmed_fee_msat, boolean claim_from_onchain_tx, u64? outbound_amount_forwarded_msat);
	ChannelPending(ChannelId channel_id, UserChannelId user_channel_id, ChannelId former_temporary_channel_id, PublicKey counterparty_node_id, OutPoint funding_txo);
	ChannelReady(ChannelId channel_id, UserChannelId user_channel_id, PublicKey? counterparty_node_id);
	ChannelClosed(ChannelId channel_id, UserChannelId user_channel_id, PublicKey? counterparty_node_id, ClosureReason? reason);
Expand Down

73 changes: 72 additions & 1 deletion
src/event.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -103,6 +103,50 @@ pub enum Event {
 /// The value, in thousandths of a satoshi, that has been received.
 amount_msat: u64,
	},
	/// A payment has been forwarded.
	PaymentForwarded {
 /// The channel id of the incoming channel between the previous node and us.
 prev_channel_id: ChannelId,
 /// The channel id of the outgoing channel between the next node and us.
 next_channel_id: ChannelId,
 /// The `user_channel_id` of the incoming channel between the previous node and us.
 ///
 /// Will only be `None` for events serialized with LDK Node v0.3.0 or prior.
 prev_user_channel_id: Option<UserChannelId>,
 /// The `user_channel_id` of the outgoing channel between the next node and us.
 ///
 /// This will be `None` if the payment was settled via an on-chain transaction. See the
 /// caveat described for the `total_fee_earned_msat` field.
 next_user_channel_id: Option<UserChannelId>,
 /// The total fee, in milli-satoshis, which was earned as a result of the payment.
 ///
 /// Note that if we force-closed the channel over which we forwarded an HTLC while the HTLC
 /// was pending, the amount the next hop claimed will have been rounded down to the nearest
 /// whole satoshi. Thus, the fee calculated here may be higher than expected as we still
 /// claimed the full value in millisatoshis from the source. In this case,
 /// `claim_from_onchain_tx` will be set.
 ///
 /// If the channel which sent us the payment has been force-closed, we will claim the funds
 /// via an on-chain transaction. In that case we do not yet know the on-chain transaction
 /// fees which we will spend and will instead set this to `None`.
 total_fee_earned_msat: Option<u64>,
 /// The share of the total fee, in milli-satoshis, which was withheld in addition to the
 /// forwarding fee.
 ///
 /// This will only be `Some` if we forwarded an intercepted HTLC with less than the
 /// expected amount. This means our counterparty accepted to receive less than the invoice
 /// amount.
 ///
 /// The caveat described above the `total_fee_earned_msat` field applies here as well.
 skimmed_fee_msat: Option<u64>,
 /// If this is `true`, the forwarded HTLC was claimed by our counterparty via an on-chain
 /// transaction.
 claim_from_onchain_tx: bool,
 /// The final amount forwarded, in milli-satoshis, after the fee is deducted.
 ///
 /// The caveat described above the `total_fee_earned_msat` field applies here as well.
 outbound_amount_forwarded_msat: Option<u64>,
	},
	/// A payment for a previously-registered payment hash has been received.
	///
	/// This needs to be manually claimed by supplying the correct preimage to [`claim_for_hash`].
Expand DownExpand Up@@ -204,6 +248,16 @@ impl_writeable_tlv_based_enum!(Event,
 (2, payment_id, required),
 (4, claimable_amount_msat, required),
 (6, claim_deadline, option),
	},
	(7, PaymentForwarded) => {
 (0, prev_channel_id, required),
 (2, next_channel_id, required),
 (4, prev_user_channel_id, option),
 (6, next_user_channel_id, option),
 (8, total_fee_earned_msat, option),
 (10, skimmed_fee_msat, option),
 (12, claim_from_onchain_tx, required),
 (14, outbound_amount_forwarded_msat, option),
	}
);

Expand DownExpand Up@@ -1068,11 +1122,28 @@ where
 LdkEvent::PaymentForwarded {
 prev_channel_id,
 next_channel_id,
 prev_user_channel_id,
 next_user_channel_id,
 total_fee_earned_msat,
 skimmed_fee_msat,
 claim_from_onchain_tx,
 outbound_amount_forwarded_msat,
 ..
 } => {
 let event = Event::PaymentForwarded {
 prev_channel_id: prev_channel_id.expect("prev_channel_id expected for events generated by LDK versions greater than 0.0.107."),
 next_channel_id: next_channel_id.expect("next_channel_id expected for events generated by LDK versions greater than 0.0.107."),
 prev_user_channel_id: prev_user_channel_id.map(UserChannelId),
 next_user_channel_id: next_user_channel_id.map(UserChannelId),
 total_fee_earned_msat,
 skimmed_fee_msat,
 claim_from_onchain_tx,
 outbound_amount_forwarded_msat,
 };
 self.event_queue.add_event(event).map_err(|e| {
Comment thread
tnull marked this conversation as resolved.

 log_error!(self.logger, "Failed to push to event queue: {}", e);
 ReplayEvent()
 })?;

 let read_only_network_graph = self.network_graph.read_only();
 let nodes = read_only_network_graph.nodes();
 let channels = self.channel_manager.list_channels();
Expand Down

3 changes: 3 additions & 0 deletions
tests/integration_tests_rust.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -192,6 +192,9 @@ fn multi_hop_sending() {
	let invoice = nodes[4].bolt11_payment().receive(2_500_000, &"asdf", 9217).unwrap();
	nodes[0].bolt11_payment().send(&invoice, Some(sending_params)).unwrap();

	expect_event!(nodes[1], PaymentForwarded);
	expect_event!(nodes[2], PaymentForwarded);

	let payment_id = expect_payment_received_event!(&nodes[4], 2_500_000);
	let fee_paid_msat = Some(2000);
	expect_payment_successful_event!(nodes[0], payment_id, Some(fee_paid_msat));
Expand Down