Skip to content

Expose more info in PaymentForwarded event#1419

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
valentinewallace merged 1 commit into from
Apr 20, 2022
Merged

Expose more info in PaymentForwarded event #1419

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
10 changes: 5 additions & 5 deletions lightning/src/ln/chanmon_update_fail_tests.rs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -1102,7 +1102,7 @@ fn test_monitor_update_fail_reestablish() {
assert!(updates.update_fee.is_none());
assert_eq!(updates.update_fulfill_htlcs.len(), 1);
nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
expect_payment_forwarded!(nodes[1], Some(1000), false);
expect_payment_forwarded!(nodes[1], nodes[0], Some(1000), false);
check_added_monitors!(nodes[1], 1);
assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, false);
Expand DownExpand Up@@ -2087,7 +2087,7 @@ fn test_fail_htlc_on_broadcast_after_claim() {
nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &cs_updates.update_fulfill_htlcs[0]);
let bs_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
check_added_monitors!(nodes[1], 1);
expect_payment_forwarded!(nodes[1], Some(1000), false);
expect_payment_forwarded!(nodes[1], nodes[0], Some(1000), false);

mine_transaction(&nodes[1], &bs_txn[0]);
check_closed_event!(nodes[1], 1, ClosureReason::CommitmentTxConfirmed);
Expand DownExpand Up@@ -2423,7 +2423,7 @@ fn do_test_reconnect_dup_htlc_claims(htlc_status: HTLCStatusAtDupClaim, second_f
let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);

create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known()).2;
let chan_id_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known()).2;

let (payment_preimage, payment_hash, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 100_000);

Expand All@@ -2450,7 +2450,7 @@ fn do_test_reconnect_dup_htlc_claims(htlc_status: HTLCStatusAtDupClaim, second_f
}

let fulfill_msg = msgs::UpdateFulfillHTLC {
channel_id: chan_2,
channel_id: chan_id_2,
htlc_id: 0,
payment_preimage,
};
Expand All@@ -2468,7 +2468,7 @@ fn do_test_reconnect_dup_htlc_claims(htlc_status: HTLCStatusAtDupClaim, second_f
assert_eq!(fulfill_msg, cs_updates.update_fulfill_htlcs[0]);
}
nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &fulfill_msg);
expect_payment_forwarded!(nodes[1], Some(1000), false);
expect_payment_forwarded!(nodes[1], nodes[0], Some(1000), false);
check_added_monitors!(nodes[1], 1);

let mut bs_updates = None;
Expand Down
3 changes: 3 additions & 0 deletions lightning/src/ln/channelmanager.rs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -4291,7 +4291,10 @@ impl<Signer: Sign, M: Deref, T: Deref, K: Deref, F: Deref, L: Deref> ChannelMana
} else { None };

let mut pending_events = self.pending_events.lock().unwrap();

let source_channel_id = Some(prev_outpoint.to_channel_id());
pending_events.push(events::Event::PaymentForwarded {
source_channel_id,
fee_earned_msat,
claim_from_onchain_tx: from_onchain,
});
Expand Down
21 changes: 16 additions & 5 deletions lightning/src/ln/functional_test_utils.rs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -1328,12 +1328,16 @@ macro_rules! expect_payment_path_successful {
}

macro_rules! expect_payment_forwarded {
($node: expr, $expected_fee: expr, $upstream_force_closed: expr) => {
($node: expr, $source_node: expr, $expected_fee: expr, $upstream_force_closed: expr) => {
let events = $node.node.get_and_clear_pending_events();
assert_eq!(events.len(), 1);
match events[0] {
Event::PaymentForwarded { fee_earned_msat, claim_from_onchain_tx } => {
Event::PaymentForwarded { fee_earned_msat, source_channel_id, claim_from_onchain_tx } => {
assert_eq!(fee_earned_msat, $expected_fee);
if fee_earned_msat.is_some() {
// Is the event channel_id in one of the channels between the two nodes?
assert!($node.node.list_channels().iter().any(|x| x.counterparty.node_id == $source_node.node.get_our_node_id() && x.channel_id == source_channel_id.unwrap()));
}
assert_eq!(claim_from_onchain_tx, $upstream_force_closed);
},
_ => panic!("Unexpected event"),
Expand DownExpand Up@@ -1572,11 +1576,11 @@ pub fn do_claim_payment_along_route<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>,
}
}
macro_rules! mid_update_fulfill_dance {
($node: expr, $prev_node: expr, $new_msgs: expr) => {
($node: expr, $prev_node: expr, $next_node: expr, $new_msgs: expr) => {
{
$node.node.handle_update_fulfill_htlc(&$prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0);
let fee = $node.node.channel_state.lock().unwrap().by_id.get(&next_msgs.as_ref().unwrap().0.channel_id).unwrap().config.forwarding_fee_base_msat;
expect_payment_forwarded!($node, Some(fee as u64), false);
expect_payment_forwarded!($node, $next_node, Some(fee as u64), false);
expected_total_fee_msat += fee as u64;
check_added_monitors!($node, 1);
let new_next_msgs = if $new_msgs {
Expand All@@ -1600,7 +1604,14 @@ pub fn do_claim_payment_along_route<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>,
assert_eq!(expected_next_node, node.node.get_our_node_id());
let update_next_msgs = !skip_last || idx != expected_route.len() - 1;
if next_msgs.is_some() {
mid_update_fulfill_dance!(node, prev_node, update_next_msgs);
// Since we are traversing in reverse, next_node is actually the previous node
let next_node: &Node;
if idx == expected_route.len() - 1 {
next_node = origin_node;
} else {
next_node = expected_route[expected_route.len() - 1 - idx - 1];
}
mid_update_fulfill_dance!(node, prev_node, next_node, update_next_msgs);
} else {
assert!(!update_next_msgs);
assert!(node.node.get_and_clear_pending_msg_events().is_empty());
Expand Down
28 changes: 21 additions & 7 deletions lightning/src/ln/functional_tests.rs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -2684,10 +2684,23 @@ fn test_htlc_on_chain_success() {
Event::ChannelClosed { reason: ClosureReason::CommitmentTxConfirmed, .. } => {}
_ => panic!("Unexpected event"),
}
if let Event::PaymentForwarded { fee_earned_msat: Some(1000), claim_from_onchain_tx: true } = forwarded_events[1] {
} else { panic!(); }
if let Event::PaymentForwarded { fee_earned_msat: Some(1000), claim_from_onchain_tx: true } = forwarded_events[2] {
} else { panic!(); }
let chan_id = Some(chan_1.2);
match forwarded_events[1] {
Event::PaymentForwarded { fee_earned_msat, source_channel_id, claim_from_onchain_tx } => {
assert_eq!(fee_earned_msat, Some(1000));
assert_eq!(source_channel_id, chan_id);
assert_eq!(claim_from_onchain_tx, true);
},
_ => panic!()
}
match forwarded_events[2] {
Event::PaymentForwarded { fee_earned_msat, source_channel_id, claim_from_onchain_tx } => {
assert_eq!(fee_earned_msat, Some(1000));
assert_eq!(source_channel_id, chan_id);
assert_eq!(claim_from_onchain_tx, true);
},
_ => panic!()
}
let events = nodes[1].node.get_and_clear_pending_msg_events();
{
let mut added_monitors = nodes[1].chain_monitor.added_monitors.lock().unwrap();
Expand DownExpand Up@@ -5104,8 +5117,9 @@ fn test_onchain_to_onchain_claim() {
_ => panic!("Unexpected event"),
}
match events[1] {
Event::PaymentForwarded { fee_earned_msat, claim_from_onchain_tx } => {
Event::PaymentForwarded { fee_earned_msat, source_channel_id, claim_from_onchain_tx } => {
assert_eq!(fee_earned_msat, Some(1000));
assert_eq!(source_channel_id, Some(chan_1.2));
assert_eq!(claim_from_onchain_tx, true);
},
_ => panic!("Unexpected event"),
Expand DownExpand Up@@ -5271,7 +5285,7 @@ fn test_duplicate_payment_hash_one_failure_one_success() {
// Note that the fee paid is effectively double as the HTLC value (including the nodes[1] fee
// and nodes[2] fee) is rounded down and then claimed in full.
mine_transaction(&nodes[1], &htlc_success_txn[0]);
expect_payment_forwarded!(nodes[1], Some(196*2), true);
expect_payment_forwarded!(nodes[1], nodes[0], Some(196*2), true);
let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
assert!(updates.update_add_htlcs.is_empty());
assert!(updates.update_fail_htlcs.is_empty());
Expand DownExpand Up@@ -8849,7 +8863,7 @@ fn do_test_onchain_htlc_settlement_after_close(broadcast_alice: bool, go_onchain
assert_eq!(carol_updates.update_fulfill_htlcs.len(), 1);

nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &carol_updates.update_fulfill_htlcs[0]);
expect_payment_forwarded!(nodes[1], if go_onchain_before_fulfill || force_closing_node == 1 { None } else { Some(1000) }, false);
expect_payment_forwarded!(nodes[1], nodes[0], if go_onchain_before_fulfill || force_closing_node == 1 { None } else { Some(1000) }, false);
// If Alice broadcasted but Bob doesn't know yet, here he prepares to tell her about the preimage.
if !go_onchain_before_fulfill && broadcast_alice {
let events = nodes[1].node.get_and_clear_pending_msg_events();
Expand Down
2 changes: 1 addition & 1 deletion lightning/src/ln/payment_tests.rs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -495,7 +495,7 @@ fn do_retry_with_no_persist(confirm_before_reload: bool) {
let bs_htlc_claim_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
assert_eq!(bs_htlc_claim_txn.len(), 1);
check_spends!(bs_htlc_claim_txn[0], as_commitment_tx);
expect_payment_forwarded!(nodes[1], None, false);
expect_payment_forwarded!(nodes[1], nodes[0], None, false);

if !confirm_before_reload {
mine_transaction(&nodes[0], &as_commitment_tx);
Expand Down
2 changes: 1 addition & 1 deletion lightning/src/ln/reorg_tests.rs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -138,7 +138,7 @@ fn do_test_onchain_htlc_reorg(local_commitment: bool, claim: bool) {
// ChannelManager only polls chain::Watch::release_pending_monitor_events when we
// probe it for events, so we probe non-message events here (which should just be the
// PaymentForwarded event).
expect_payment_forwarded!(nodes[1], Some(1000), true);
expect_payment_forwarded!(nodes[1], nodes[0], Some(1000), true);
} else {
// Confirm the timeout tx and check that we fail the HTLC backwards
let block = Block {
Expand Down
4 changes: 2 additions & 2 deletions lightning/src/ln/shutdown_tests.rs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -110,7 +110,7 @@ fn updates_shutdown_wait() {
assert!(updates.update_fee.is_none());
assert_eq!(updates.update_fulfill_htlcs.len(), 1);
nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
expect_payment_forwarded!(nodes[1], Some(1000), false);
expect_payment_forwarded!(nodes[1], nodes[0], Some(1000), false);
check_added_monitors!(nodes[1], 1);
let updates_2 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, false);
Expand DownExpand Up@@ -279,7 +279,7 @@ fn do_test_shutdown_rebroadcast(recv_count: u8) {
assert!(updates.update_fee.is_none());
assert_eq!(updates.update_fulfill_htlcs.len(), 1);
nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
expect_payment_forwarded!(nodes[1], Some(1000), false);
expect_payment_forwarded!(nodes[1], nodes[0], Some(1000), false);
check_added_monitors!(nodes[1], 1);
let updates_2 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, false);
Expand Down
10 changes: 8 additions & 2 deletions lightning/src/util/events.rs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -343,6 +343,9 @@ pub enum Event {
/// This event is generated when a payment has been successfully forwarded through us and a
/// forwarding fee earned.
PaymentForwarded {
/// The channel between the source node and us. Optional because versions prior to 0.0.107
/// do not serialize this field.
source_channel_id: Option<[u8; 32]>,
/// The 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
Expand DownExpand Up@@ -520,10 +523,11 @@ impl Writeable for Event {
(0, VecWriteWrapper(outputs), required),
});
},
&Event::PaymentForwarded { fee_earned_msat, claim_from_onchain_tx } => {
&Event::PaymentForwarded { fee_earned_msat, source_channel_id, claim_from_onchain_tx } => {
7u8.write(writer)?;
write_tlv_fields!(writer, {
(0, fee_earned_msat, option),
(1, source_channel_id, option),
(2, claim_from_onchain_tx, required),
});
},
Expand DownExpand Up@@ -684,12 +688,14 @@ impl MaybeReadable for Event {
7u8 => {
let f = || {
let mut fee_earned_msat = None;
let mut source_channel_id = None;
let mut claim_from_onchain_tx = false;
read_tlv_fields!(reader, {
(0, fee_earned_msat, option),
(1, source_channel_id, option),
(2, claim_from_onchain_tx, required),
});
Ok(Some(Event::PaymentForwarded { fee_earned_msat, claim_from_onchain_tx }))
Ok(Some(Event::PaymentForwarded { fee_earned_msat, source_channel_id, claim_from_onchain_tx }))
};
f()
},
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" + '
Expose more info in `PaymentForwarded` event by atalw · Pull Request #1419 · lightningdevkit/rust-lightning · GitHub
Skip to content
Expose more info in PaymentForwarded event#1419

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

valentinewallace
merged 1 commit into

from

Apr 20, 2022
 Merged


Expose more info in PaymentForwarded event
#1419
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


10 changes: 5 additions & 5 deletions
lightning/src/ln/chanmon_update_fail_tests.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1102,7 +1102,7 @@ fn test_monitor_update_fail_reestablish() {
	assert!(updates.update_fee.is_none());
	assert_eq!(updates.update_fulfill_htlcs.len(), 1);
	nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
	expect_payment_forwarded!(nodes[1], Some(1000), false);
	expect_payment_forwarded!(nodes[1], nodes[0], Some(1000), false);
	check_added_monitors!(nodes[1], 1);
	assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
	commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, false);
Expand DownExpand Up@@ -2087,7 +2087,7 @@ fn test_fail_htlc_on_broadcast_after_claim() {
	nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &cs_updates.update_fulfill_htlcs[0]);
	let bs_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
	check_added_monitors!(nodes[1], 1);
	expect_payment_forwarded!(nodes[1], Some(1000), false);
	expect_payment_forwarded!(nodes[1], nodes[0], Some(1000), false);

	mine_transaction(&nodes[1], &bs_txn[0]);
	check_closed_event!(nodes[1], 1, ClosureReason::CommitmentTxConfirmed);
Expand DownExpand Up@@ -2423,7 +2423,7 @@ fn do_test_reconnect_dup_htlc_claims(htlc_status: HTLCStatusAtDupClaim, second_f
	let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);

	create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
	let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known()).2;
	let chan_id_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known()).2;

	let (payment_preimage, payment_hash, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 100_000);

Expand All@@ -2450,7 +2450,7 @@ fn do_test_reconnect_dup_htlc_claims(htlc_status: HTLCStatusAtDupClaim, second_f
	}

	let fulfill_msg = msgs::UpdateFulfillHTLC {
 channel_id: chan_2,
 channel_id: chan_id_2,
 htlc_id: 0,
 payment_preimage,
	};
Expand All@@ -2468,7 +2468,7 @@ fn do_test_reconnect_dup_htlc_claims(htlc_status: HTLCStatusAtDupClaim, second_f
 assert_eq!(fulfill_msg, cs_updates.update_fulfill_htlcs[0]);
	}
	nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &fulfill_msg);
	expect_payment_forwarded!(nodes[1], Some(1000), false);
	expect_payment_forwarded!(nodes[1], nodes[0], Some(1000), false);
	check_added_monitors!(nodes[1], 1);

	let mut bs_updates = None;
Expand Down

3 changes: 3 additions & 0 deletions
lightning/src/ln/channelmanager.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4291,7 +4291,10 @@ impl<Signer: Sign, M: Deref, T: Deref, K: Deref, F: Deref, L: Deref> ChannelMana
 } else { None };

 let mut pending_events = self.pending_events.lock().unwrap();

 let source_channel_id = Some(prev_outpoint.to_channel_id());
 pending_events.push(events::Event::PaymentForwarded {
 source_channel_id,
 fee_earned_msat,
 claim_from_onchain_tx: from_onchain,
 });
Expand Down

21 changes: 16 additions & 5 deletions
lightning/src/ln/functional_test_utils.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1328,12 +1328,16 @@ macro_rules! expect_payment_path_successful {
}

macro_rules! expect_payment_forwarded {
	($node: expr, $expected_fee: expr, $upstream_force_closed: expr) => {
	($node: expr, $source_node: expr, $expected_fee: expr, $upstream_force_closed: expr) => {
 let events = $node.node.get_and_clear_pending_events();
 assert_eq!(events.len(), 1);
 match events[0] {
 Event::PaymentForwarded { fee_earned_msat, claim_from_onchain_tx } => {
 Event::PaymentForwarded { fee_earned_msat, source_channel_id, claim_from_onchain_tx } => {
 assert_eq!(fee_earned_msat, $expected_fee);
 if fee_earned_msat.is_some() {
 // Is the event channel_id in one of the channels between the two nodes?
 assert!($node.node.list_channels().iter().any(|x| x.counterparty.node_id == $source_node.node.get_our_node_id() && x.channel_id == source_channel_id.unwrap()));
 }
 assert_eq!(claim_from_onchain_tx, $upstream_force_closed);
 },
 _ => panic!("Unexpected event"),
Expand DownExpand Up@@ -1572,11 +1576,11 @@ pub fn do_claim_payment_along_route<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>,
 }
 }
 macro_rules! mid_update_fulfill_dance {
 ($node: expr, $prev_node: expr, $new_msgs: expr) => {
 ($node: expr, $prev_node: expr, $next_node: expr, $new_msgs: expr) => {
 {
 $node.node.handle_update_fulfill_htlc(&$prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0);
 let fee = $node.node.channel_state.lock().unwrap().by_id.get(&next_msgs.as_ref().unwrap().0.channel_id).unwrap().config.forwarding_fee_base_msat;
 expect_payment_forwarded!($node, Some(fee as u64), false);
 expect_payment_forwarded!($node, $next_node, Some(fee as u64), false);
 expected_total_fee_msat += fee as u64;
 check_added_monitors!($node, 1);
 let new_next_msgs = if $new_msgs {
Expand All@@ -1600,7 +1604,14 @@ pub fn do_claim_payment_along_route<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>,
 assert_eq!(expected_next_node, node.node.get_our_node_id());
 let update_next_msgs = !skip_last || idx != expected_route.len() - 1;
 if next_msgs.is_some() {
 mid_update_fulfill_dance!(node, prev_node, update_next_msgs);
 // Since we are traversing in reverse, next_node is actually the previous node
 let next_node: &Node;
 if idx == expected_route.len() - 1 {
 next_node = origin_node;
 } else {
 next_node = expected_route[expected_route.len() - 1 - idx - 1];
 }
 mid_update_fulfill_dance!(node, prev_node, next_node, update_next_msgs);
 } else {
 assert!(!update_next_msgs);
 assert!(node.node.get_and_clear_pending_msg_events().is_empty());
Expand Down

28 changes: 21 additions & 7 deletions
lightning/src/ln/functional_tests.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2684,10 +2684,23 @@ fn test_htlc_on_chain_success() {
 Event::ChannelClosed { reason: ClosureReason::CommitmentTxConfirmed, .. } => {}
 _ => panic!("Unexpected event"),
	}
	if let Event::PaymentForwarded { fee_earned_msat: Some(1000), claim_from_onchain_tx: true } = forwarded_events[1] {
 } else { panic!(); }
	if let Event::PaymentForwarded { fee_earned_msat: Some(1000), claim_from_onchain_tx: true } = forwarded_events[2] {
 } else { panic!(); }
	let chan_id = Some(chan_1.2);
	match forwarded_events[1] {
 Event::PaymentForwarded { fee_earned_msat, source_channel_id, claim_from_onchain_tx } => {
 assert_eq!(fee_earned_msat, Some(1000));
 assert_eq!(source_channel_id, chan_id);
 assert_eq!(claim_from_onchain_tx, true);
 },
 _ => panic!()
	}
	match forwarded_events[2] {
 Event::PaymentForwarded { fee_earned_msat, source_channel_id, claim_from_onchain_tx } => {
 assert_eq!(fee_earned_msat, Some(1000));
 assert_eq!(source_channel_id, chan_id);
 assert_eq!(claim_from_onchain_tx, true);
 },
 _ => panic!()
	}
	let events = nodes[1].node.get_and_clear_pending_msg_events();
	{
 let mut added_monitors = nodes[1].chain_monitor.added_monitors.lock().unwrap();
Expand DownExpand Up@@ -5104,8 +5117,9 @@ fn test_onchain_to_onchain_claim() {
 _ => panic!("Unexpected event"),
	}
	match events[1] {
 Event::PaymentForwarded { fee_earned_msat, claim_from_onchain_tx } => {
 Event::PaymentForwarded { fee_earned_msat, source_channel_id, claim_from_onchain_tx } => {
 assert_eq!(fee_earned_msat, Some(1000));
 assert_eq!(source_channel_id, Some(chan_1.2));
 assert_eq!(claim_from_onchain_tx, true);
 },
 _ => panic!("Unexpected event"),
Expand DownExpand Up@@ -5271,7 +5285,7 @@ fn test_duplicate_payment_hash_one_failure_one_success() {
	// Note that the fee paid is effectively double as the HTLC value (including the nodes[1] fee
	// and nodes[2] fee) is rounded down and then claimed in full.
	mine_transaction(&nodes[1], &htlc_success_txn[0]);
	expect_payment_forwarded!(nodes[1], Some(196*2), true);
	expect_payment_forwarded!(nodes[1], nodes[0], Some(196*2), true);
	let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
	assert!(updates.update_add_htlcs.is_empty());
	assert!(updates.update_fail_htlcs.is_empty());
Expand DownExpand Up@@ -8849,7 +8863,7 @@ fn do_test_onchain_htlc_settlement_after_close(broadcast_alice: bool, go_onchain
	assert_eq!(carol_updates.update_fulfill_htlcs.len(), 1);

	nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &carol_updates.update_fulfill_htlcs[0]);
	expect_payment_forwarded!(nodes[1], if go_onchain_before_fulfill || force_closing_node == 1 { None } else { Some(1000) }, false);
	expect_payment_forwarded!(nodes[1], nodes[0], if go_onchain_before_fulfill || force_closing_node == 1 { None } else { Some(1000) }, false);
	// If Alice broadcasted but Bob doesn't know yet, here he prepares to tell her about the preimage.
	if !go_onchain_before_fulfill && broadcast_alice {
 let events = nodes[1].node.get_and_clear_pending_msg_events();
Expand Down

2 changes: 1 addition & 1 deletion
lightning/src/ln/payment_tests.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -495,7 +495,7 @@ fn do_retry_with_no_persist(confirm_before_reload: bool) {
	let bs_htlc_claim_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
	assert_eq!(bs_htlc_claim_txn.len(), 1);
	check_spends!(bs_htlc_claim_txn[0], as_commitment_tx);
	expect_payment_forwarded!(nodes[1], None, false);
	expect_payment_forwarded!(nodes[1], nodes[0], None, false);

	if !confirm_before_reload {
 mine_transaction(&nodes[0], &as_commitment_tx);
Expand Down

2 changes: 1 addition & 1 deletion
lightning/src/ln/reorg_tests.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -138,7 +138,7 @@ fn do_test_onchain_htlc_reorg(local_commitment: bool, claim: bool) {
 // ChannelManager only polls chain::Watch::release_pending_monitor_events when we
 // probe it for events, so we probe non-message events here (which should just be the
 // PaymentForwarded event).
 expect_payment_forwarded!(nodes[1], Some(1000), true);
 expect_payment_forwarded!(nodes[1], nodes[0], Some(1000), true);
	} else {
 // Confirm the timeout tx and check that we fail the HTLC backwards
 let block = Block {
Expand Down

4 changes: 2 additions & 2 deletions
lightning/src/ln/shutdown_tests.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -110,7 +110,7 @@ fn updates_shutdown_wait() {
	assert!(updates.update_fee.is_none());
	assert_eq!(updates.update_fulfill_htlcs.len(), 1);
	nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
	expect_payment_forwarded!(nodes[1], Some(1000), false);
	expect_payment_forwarded!(nodes[1], nodes[0], Some(1000), false);
	check_added_monitors!(nodes[1], 1);
	let updates_2 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
	commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, false);
Expand DownExpand Up@@ -279,7 +279,7 @@ fn do_test_shutdown_rebroadcast(recv_count: u8) {
	assert!(updates.update_fee.is_none());
	assert_eq!(updates.update_fulfill_htlcs.len(), 1);
	nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
	expect_payment_forwarded!(nodes[1], Some(1000), false);
	expect_payment_forwarded!(nodes[1], nodes[0], Some(1000), false);
	check_added_monitors!(nodes[1], 1);
	let updates_2 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
	commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, false);
Expand Down

10 changes: 8 additions & 2 deletions
lightning/src/util/events.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -343,6 +343,9 @@ pub enum Event {
	/// This event is generated when a payment has been successfully forwarded through us and a
	/// forwarding fee earned.
	PaymentForwarded {
 /// The channel between the source node and us. Optional because versions prior to 0.0.107
 /// do not serialize this field.
 source_channel_id: Option<[u8; 32]>,
 /// The 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
Expand DownExpand Up@@ -520,10 +523,11 @@ impl Writeable for Event {
 (0, VecWriteWrapper(outputs), required),
 });
 },
 &Event::PaymentForwarded { fee_earned_msat, claim_from_onchain_tx } => {
 &Event::PaymentForwarded { fee_earned_msat, source_channel_id, claim_from_onchain_tx } => {
 7u8.write(writer)?;
 write_tlv_fields!(writer, {
 (0, fee_earned_msat, option),
 (1, source_channel_id, option),
 (2, claim_from_onchain_tx, required),
 });
 },
Expand DownExpand Up@@ -684,12 +688,14 @@ impl MaybeReadable for Event {
 7u8 => {
 let f = || {
 let mut fee_earned_msat = None;
 let mut source_channel_id = None;
 let mut claim_from_onchain_tx = false;
 read_tlv_fields!(reader, {
 (0, fee_earned_msat, option),
 (1, source_channel_id, option),
 (2, claim_from_onchain_tx, required),
 });
 Ok(Some(Event::PaymentForwarded { fee_earned_msat, claim_from_onchain_tx }))
 Ok(Some(Event::PaymentForwarded { fee_earned_msat, source_channel_id, claim_from_onchain_tx }))
 };
 f()
 },
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('^' + ".*" + '
Expose more info in `PaymentForwarded` event by atalw · Pull Request #1419 · lightningdevkit/rust-lightning · GitHub
Skip to content
Expose more info in PaymentForwarded event#1419

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

valentinewallace
merged 1 commit into

from

Apr 20, 2022
 Merged


Expose more info in PaymentForwarded event
#1419
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


10 changes: 5 additions & 5 deletions
lightning/src/ln/chanmon_update_fail_tests.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1102,7 +1102,7 @@ fn test_monitor_update_fail_reestablish() {
	assert!(updates.update_fee.is_none());
	assert_eq!(updates.update_fulfill_htlcs.len(), 1);
	nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
	expect_payment_forwarded!(nodes[1], Some(1000), false);
	expect_payment_forwarded!(nodes[1], nodes[0], Some(1000), false);
	check_added_monitors!(nodes[1], 1);
	assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
	commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, false);
Expand DownExpand Up@@ -2087,7 +2087,7 @@ fn test_fail_htlc_on_broadcast_after_claim() {
	nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &cs_updates.update_fulfill_htlcs[0]);
	let bs_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
	check_added_monitors!(nodes[1], 1);
	expect_payment_forwarded!(nodes[1], Some(1000), false);
	expect_payment_forwarded!(nodes[1], nodes[0], Some(1000), false);

	mine_transaction(&nodes[1], &bs_txn[0]);
	check_closed_event!(nodes[1], 1, ClosureReason::CommitmentTxConfirmed);
Expand DownExpand Up@@ -2423,7 +2423,7 @@ fn do_test_reconnect_dup_htlc_claims(htlc_status: HTLCStatusAtDupClaim, second_f
	let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);

	create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
	let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known()).2;
	let chan_id_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known()).2;

	let (payment_preimage, payment_hash, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 100_000);

Expand All@@ -2450,7 +2450,7 @@ fn do_test_reconnect_dup_htlc_claims(htlc_status: HTLCStatusAtDupClaim, second_f
	}

	let fulfill_msg = msgs::UpdateFulfillHTLC {
 channel_id: chan_2,
 channel_id: chan_id_2,
 htlc_id: 0,
 payment_preimage,
	};
Expand All@@ -2468,7 +2468,7 @@ fn do_test_reconnect_dup_htlc_claims(htlc_status: HTLCStatusAtDupClaim, second_f
 assert_eq!(fulfill_msg, cs_updates.update_fulfill_htlcs[0]);
	}
	nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &fulfill_msg);
	expect_payment_forwarded!(nodes[1], Some(1000), false);
	expect_payment_forwarded!(nodes[1], nodes[0], Some(1000), false);
	check_added_monitors!(nodes[1], 1);

	let mut bs_updates = None;
Expand Down

3 changes: 3 additions & 0 deletions
lightning/src/ln/channelmanager.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4291,7 +4291,10 @@ impl<Signer: Sign, M: Deref, T: Deref, K: Deref, F: Deref, L: Deref> ChannelMana
 } else { None };

 let mut pending_events = self.pending_events.lock().unwrap();

 let source_channel_id = Some(prev_outpoint.to_channel_id());
 pending_events.push(events::Event::PaymentForwarded {
 source_channel_id,
 fee_earned_msat,
 claim_from_onchain_tx: from_onchain,
 });
Expand Down

21 changes: 16 additions & 5 deletions
lightning/src/ln/functional_test_utils.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1328,12 +1328,16 @@ macro_rules! expect_payment_path_successful {
}

macro_rules! expect_payment_forwarded {
	($node: expr, $expected_fee: expr, $upstream_force_closed: expr) => {
	($node: expr, $source_node: expr, $expected_fee: expr, $upstream_force_closed: expr) => {
 let events = $node.node.get_and_clear_pending_events();
 assert_eq!(events.len(), 1);
 match events[0] {
 Event::PaymentForwarded { fee_earned_msat, claim_from_onchain_tx } => {
 Event::PaymentForwarded { fee_earned_msat, source_channel_id, claim_from_onchain_tx } => {
 assert_eq!(fee_earned_msat, $expected_fee);
 if fee_earned_msat.is_some() {
 // Is the event channel_id in one of the channels between the two nodes?
 assert!($node.node.list_channels().iter().any(|x| x.counterparty.node_id == $source_node.node.get_our_node_id() && x.channel_id == source_channel_id.unwrap()));
 }
 assert_eq!(claim_from_onchain_tx, $upstream_force_closed);
 },
 _ => panic!("Unexpected event"),
Expand DownExpand Up@@ -1572,11 +1576,11 @@ pub fn do_claim_payment_along_route<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>,
 }
 }
 macro_rules! mid_update_fulfill_dance {
 ($node: expr, $prev_node: expr, $new_msgs: expr) => {
 ($node: expr, $prev_node: expr, $next_node: expr, $new_msgs: expr) => {
 {
 $node.node.handle_update_fulfill_htlc(&$prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0);
 let fee = $node.node.channel_state.lock().unwrap().by_id.get(&next_msgs.as_ref().unwrap().0.channel_id).unwrap().config.forwarding_fee_base_msat;
 expect_payment_forwarded!($node, Some(fee as u64), false);
 expect_payment_forwarded!($node, $next_node, Some(fee as u64), false);
 expected_total_fee_msat += fee as u64;
 check_added_monitors!($node, 1);
 let new_next_msgs = if $new_msgs {
Expand All@@ -1600,7 +1604,14 @@ pub fn do_claim_payment_along_route<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>,
 assert_eq!(expected_next_node, node.node.get_our_node_id());
 let update_next_msgs = !skip_last || idx != expected_route.len() - 1;
 if next_msgs.is_some() {
 mid_update_fulfill_dance!(node, prev_node, update_next_msgs);
 // Since we are traversing in reverse, next_node is actually the previous node
 let next_node: &Node;
 if idx == expected_route.len() - 1 {
 next_node = origin_node;
 } else {
 next_node = expected_route[expected_route.len() - 1 - idx - 1];
 }
 mid_update_fulfill_dance!(node, prev_node, next_node, update_next_msgs);
 } else {
 assert!(!update_next_msgs);
 assert!(node.node.get_and_clear_pending_msg_events().is_empty());
Expand Down

28 changes: 21 additions & 7 deletions
lightning/src/ln/functional_tests.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2684,10 +2684,23 @@ fn test_htlc_on_chain_success() {
 Event::ChannelClosed { reason: ClosureReason::CommitmentTxConfirmed, .. } => {}
 _ => panic!("Unexpected event"),
	}
	if let Event::PaymentForwarded { fee_earned_msat: Some(1000), claim_from_onchain_tx: true } = forwarded_events[1] {
 } else { panic!(); }
	if let Event::PaymentForwarded { fee_earned_msat: Some(1000), claim_from_onchain_tx: true } = forwarded_events[2] {
 } else { panic!(); }
	let chan_id = Some(chan_1.2);
	match forwarded_events[1] {
 Event::PaymentForwarded { fee_earned_msat, source_channel_id, claim_from_onchain_tx } => {
 assert_eq!(fee_earned_msat, Some(1000));
 assert_eq!(source_channel_id, chan_id);
 assert_eq!(claim_from_onchain_tx, true);
 },
 _ => panic!()
	}
	match forwarded_events[2] {
 Event::PaymentForwarded { fee_earned_msat, source_channel_id, claim_from_onchain_tx } => {
 assert_eq!(fee_earned_msat, Some(1000));
 assert_eq!(source_channel_id, chan_id);
 assert_eq!(claim_from_onchain_tx, true);
 },
 _ => panic!()
	}
	let events = nodes[1].node.get_and_clear_pending_msg_events();
	{
 let mut added_monitors = nodes[1].chain_monitor.added_monitors.lock().unwrap();
Expand DownExpand Up@@ -5104,8 +5117,9 @@ fn test_onchain_to_onchain_claim() {
 _ => panic!("Unexpected event"),
	}
	match events[1] {
 Event::PaymentForwarded { fee_earned_msat, claim_from_onchain_tx } => {
 Event::PaymentForwarded { fee_earned_msat, source_channel_id, claim_from_onchain_tx } => {
 assert_eq!(fee_earned_msat, Some(1000));
 assert_eq!(source_channel_id, Some(chan_1.2));
 assert_eq!(claim_from_onchain_tx, true);
 },
 _ => panic!("Unexpected event"),
Expand DownExpand Up@@ -5271,7 +5285,7 @@ fn test_duplicate_payment_hash_one_failure_one_success() {
	// Note that the fee paid is effectively double as the HTLC value (including the nodes[1] fee
	// and nodes[2] fee) is rounded down and then claimed in full.
	mine_transaction(&nodes[1], &htlc_success_txn[0]);
	expect_payment_forwarded!(nodes[1], Some(196*2), true);
	expect_payment_forwarded!(nodes[1], nodes[0], Some(196*2), true);
	let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
	assert!(updates.update_add_htlcs.is_empty());
	assert!(updates.update_fail_htlcs.is_empty());
Expand DownExpand Up@@ -8849,7 +8863,7 @@ fn do_test_onchain_htlc_settlement_after_close(broadcast_alice: bool, go_onchain
	assert_eq!(carol_updates.update_fulfill_htlcs.len(), 1);

	nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &carol_updates.update_fulfill_htlcs[0]);
	expect_payment_forwarded!(nodes[1], if go_onchain_before_fulfill || force_closing_node == 1 { None } else { Some(1000) }, false);
	expect_payment_forwarded!(nodes[1], nodes[0], if go_onchain_before_fulfill || force_closing_node == 1 { None } else { Some(1000) }, false);
	// If Alice broadcasted but Bob doesn't know yet, here he prepares to tell her about the preimage.
	if !go_onchain_before_fulfill && broadcast_alice {
 let events = nodes[1].node.get_and_clear_pending_msg_events();
Expand Down

2 changes: 1 addition & 1 deletion
lightning/src/ln/payment_tests.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -495,7 +495,7 @@ fn do_retry_with_no_persist(confirm_before_reload: bool) {
	let bs_htlc_claim_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
	assert_eq!(bs_htlc_claim_txn.len(), 1);
	check_spends!(bs_htlc_claim_txn[0], as_commitment_tx);
	expect_payment_forwarded!(nodes[1], None, false);
	expect_payment_forwarded!(nodes[1], nodes[0], None, false);

	if !confirm_before_reload {
 mine_transaction(&nodes[0], &as_commitment_tx);
Expand Down

2 changes: 1 addition & 1 deletion
lightning/src/ln/reorg_tests.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -138,7 +138,7 @@ fn do_test_onchain_htlc_reorg(local_commitment: bool, claim: bool) {
 // ChannelManager only polls chain::Watch::release_pending_monitor_events when we
 // probe it for events, so we probe non-message events here (which should just be the
 // PaymentForwarded event).
 expect_payment_forwarded!(nodes[1], Some(1000), true);
 expect_payment_forwarded!(nodes[1], nodes[0], Some(1000), true);
	} else {
 // Confirm the timeout tx and check that we fail the HTLC backwards
 let block = Block {
Expand Down

4 changes: 2 additions & 2 deletions
lightning/src/ln/shutdown_tests.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -110,7 +110,7 @@ fn updates_shutdown_wait() {
	assert!(updates.update_fee.is_none());
	assert_eq!(updates.update_fulfill_htlcs.len(), 1);
	nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
	expect_payment_forwarded!(nodes[1], Some(1000), false);
	expect_payment_forwarded!(nodes[1], nodes[0], Some(1000), false);
	check_added_monitors!(nodes[1], 1);
	let updates_2 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
	commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, false);
Expand DownExpand Up@@ -279,7 +279,7 @@ fn do_test_shutdown_rebroadcast(recv_count: u8) {
	assert!(updates.update_fee.is_none());
	assert_eq!(updates.update_fulfill_htlcs.len(), 1);
	nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
	expect_payment_forwarded!(nodes[1], Some(1000), false);
	expect_payment_forwarded!(nodes[1], nodes[0], Some(1000), false);
	check_added_monitors!(nodes[1], 1);
	let updates_2 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
	commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, false);
Expand Down

10 changes: 8 additions & 2 deletions
lightning/src/util/events.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -343,6 +343,9 @@ pub enum Event {
	/// This event is generated when a payment has been successfully forwarded through us and a
	/// forwarding fee earned.
	PaymentForwarded {
 /// The channel between the source node and us. Optional because versions prior to 0.0.107
 /// do not serialize this field.
 source_channel_id: Option<[u8; 32]>,
 /// The 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
Expand DownExpand Up@@ -520,10 +523,11 @@ impl Writeable for Event {
 (0, VecWriteWrapper(outputs), required),
 });
 },
 &Event::PaymentForwarded { fee_earned_msat, claim_from_onchain_tx } => {
 &Event::PaymentForwarded { fee_earned_msat, source_channel_id, claim_from_onchain_tx } => {
 7u8.write(writer)?;
 write_tlv_fields!(writer, {
 (0, fee_earned_msat, option),
 (1, source_channel_id, option),
 (2, claim_from_onchain_tx, required),
 });
 },
Expand DownExpand Up@@ -684,12 +688,14 @@ impl MaybeReadable for Event {
 7u8 => {
 let f = || {
 let mut fee_earned_msat = None;
 let mut source_channel_id = None;
 let mut claim_from_onchain_tx = false;
 read_tlv_fields!(reader, {
 (0, fee_earned_msat, option),
 (1, source_channel_id, option),
 (2, claim_from_onchain_tx, required),
 });
 Ok(Some(Event::PaymentForwarded { fee_earned_msat, claim_from_onchain_tx }))
 Ok(Some(Event::PaymentForwarded { fee_earned_msat, source_channel_id, claim_from_onchain_tx }))
 };
 f()
 },
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('^' + ".*" + '
Expose more info in `PaymentForwarded` event by atalw · Pull Request #1419 · lightningdevkit/rust-lightning · GitHub
Skip to content
Expose more info in PaymentForwarded event#1419

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

valentinewallace
merged 1 commit into

from

Apr 20, 2022
 Merged


Expose more info in PaymentForwarded event
#1419
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


10 changes: 5 additions & 5 deletions
lightning/src/ln/chanmon_update_fail_tests.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1102,7 +1102,7 @@ fn test_monitor_update_fail_reestablish() {
	assert!(updates.update_fee.is_none());
	assert_eq!(updates.update_fulfill_htlcs.len(), 1);
	nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
	expect_payment_forwarded!(nodes[1], Some(1000), false);
	expect_payment_forwarded!(nodes[1], nodes[0], Some(1000), false);
	check_added_monitors!(nodes[1], 1);
	assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
	commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, false);
Expand DownExpand Up@@ -2087,7 +2087,7 @@ fn test_fail_htlc_on_broadcast_after_claim() {
	nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &cs_updates.update_fulfill_htlcs[0]);
	let bs_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
	check_added_monitors!(nodes[1], 1);
	expect_payment_forwarded!(nodes[1], Some(1000), false);
	expect_payment_forwarded!(nodes[1], nodes[0], Some(1000), false);

	mine_transaction(&nodes[1], &bs_txn[0]);
	check_closed_event!(nodes[1], 1, ClosureReason::CommitmentTxConfirmed);
Expand DownExpand Up@@ -2423,7 +2423,7 @@ fn do_test_reconnect_dup_htlc_claims(htlc_status: HTLCStatusAtDupClaim, second_f
	let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);

	create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
	let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known()).2;
	let chan_id_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known()).2;

	let (payment_preimage, payment_hash, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 100_000);

Expand All@@ -2450,7 +2450,7 @@ fn do_test_reconnect_dup_htlc_claims(htlc_status: HTLCStatusAtDupClaim, second_f
	}

	let fulfill_msg = msgs::UpdateFulfillHTLC {
 channel_id: chan_2,
 channel_id: chan_id_2,
 htlc_id: 0,
 payment_preimage,
	};
Expand All@@ -2468,7 +2468,7 @@ fn do_test_reconnect_dup_htlc_claims(htlc_status: HTLCStatusAtDupClaim, second_f
 assert_eq!(fulfill_msg, cs_updates.update_fulfill_htlcs[0]);
	}
	nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &fulfill_msg);
	expect_payment_forwarded!(nodes[1], Some(1000), false);
	expect_payment_forwarded!(nodes[1], nodes[0], Some(1000), false);
	check_added_monitors!(nodes[1], 1);

	let mut bs_updates = None;
Expand Down

3 changes: 3 additions & 0 deletions
lightning/src/ln/channelmanager.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4291,7 +4291,10 @@ impl<Signer: Sign, M: Deref, T: Deref, K: Deref, F: Deref, L: Deref> ChannelMana
 } else { None };

 let mut pending_events = self.pending_events.lock().unwrap();

 let source_channel_id = Some(prev_outpoint.to_channel_id());
 pending_events.push(events::Event::PaymentForwarded {
 source_channel_id,
 fee_earned_msat,
 claim_from_onchain_tx: from_onchain,
 });
Expand Down

21 changes: 16 additions & 5 deletions
lightning/src/ln/functional_test_utils.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1328,12 +1328,16 @@ macro_rules! expect_payment_path_successful {
}

macro_rules! expect_payment_forwarded {
	($node: expr, $expected_fee: expr, $upstream_force_closed: expr) => {
	($node: expr, $source_node: expr, $expected_fee: expr, $upstream_force_closed: expr) => {
 let events = $node.node.get_and_clear_pending_events();
 assert_eq!(events.len(), 1);
 match events[0] {
 Event::PaymentForwarded { fee_earned_msat, claim_from_onchain_tx } => {
 Event::PaymentForwarded { fee_earned_msat, source_channel_id, claim_from_onchain_tx } => {
 assert_eq!(fee_earned_msat, $expected_fee);
 if fee_earned_msat.is_some() {
 // Is the event channel_id in one of the channels between the two nodes?
 assert!($node.node.list_channels().iter().any(|x| x.counterparty.node_id == $source_node.node.get_our_node_id() && x.channel_id == source_channel_id.unwrap()));
 }
 assert_eq!(claim_from_onchain_tx, $upstream_force_closed);
 },
 _ => panic!("Unexpected event"),
Expand DownExpand Up@@ -1572,11 +1576,11 @@ pub fn do_claim_payment_along_route<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>,
 }
 }
 macro_rules! mid_update_fulfill_dance {
 ($node: expr, $prev_node: expr, $new_msgs: expr) => {
 ($node: expr, $prev_node: expr, $next_node: expr, $new_msgs: expr) => {
 {
 $node.node.handle_update_fulfill_htlc(&$prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0);
 let fee = $node.node.channel_state.lock().unwrap().by_id.get(&next_msgs.as_ref().unwrap().0.channel_id).unwrap().config.forwarding_fee_base_msat;
 expect_payment_forwarded!($node, Some(fee as u64), false);
 expect_payment_forwarded!($node, $next_node, Some(fee as u64), false);
 expected_total_fee_msat += fee as u64;
 check_added_monitors!($node, 1);
 let new_next_msgs = if $new_msgs {
Expand All@@ -1600,7 +1604,14 @@ pub fn do_claim_payment_along_route<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>,
 assert_eq!(expected_next_node, node.node.get_our_node_id());
 let update_next_msgs = !skip_last || idx != expected_route.len() - 1;
 if next_msgs.is_some() {
 mid_update_fulfill_dance!(node, prev_node, update_next_msgs);
 // Since we are traversing in reverse, next_node is actually the previous node
 let next_node: &Node;
 if idx == expected_route.len() - 1 {
 next_node = origin_node;
 } else {
 next_node = expected_route[expected_route.len() - 1 - idx - 1];
 }
 mid_update_fulfill_dance!(node, prev_node, next_node, update_next_msgs);
 } else {
 assert!(!update_next_msgs);
 assert!(node.node.get_and_clear_pending_msg_events().is_empty());
Expand Down

28 changes: 21 additions & 7 deletions
lightning/src/ln/functional_tests.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2684,10 +2684,23 @@ fn test_htlc_on_chain_success() {
 Event::ChannelClosed { reason: ClosureReason::CommitmentTxConfirmed, .. } => {}
 _ => panic!("Unexpected event"),
	}
	if let Event::PaymentForwarded { fee_earned_msat: Some(1000), claim_from_onchain_tx: true } = forwarded_events[1] {
 } else { panic!(); }
	if let Event::PaymentForwarded { fee_earned_msat: Some(1000), claim_from_onchain_tx: true } = forwarded_events[2] {
 } else { panic!(); }
	let chan_id = Some(chan_1.2);
	match forwarded_events[1] {
 Event::PaymentForwarded { fee_earned_msat, source_channel_id, claim_from_onchain_tx } => {
 assert_eq!(fee_earned_msat, Some(1000));
 assert_eq!(source_channel_id, chan_id);
 assert_eq!(claim_from_onchain_tx, true);
 },
 _ => panic!()
	}
	match forwarded_events[2] {
 Event::PaymentForwarded { fee_earned_msat, source_channel_id, claim_from_onchain_tx } => {
 assert_eq!(fee_earned_msat, Some(1000));
 assert_eq!(source_channel_id, chan_id);
 assert_eq!(claim_from_onchain_tx, true);
 },
 _ => panic!()
	}
	let events = nodes[1].node.get_and_clear_pending_msg_events();
	{
 let mut added_monitors = nodes[1].chain_monitor.added_monitors.lock().unwrap();
Expand DownExpand Up@@ -5104,8 +5117,9 @@ fn test_onchain_to_onchain_claim() {
 _ => panic!("Unexpected event"),
	}
	match events[1] {
 Event::PaymentForwarded { fee_earned_msat, claim_from_onchain_tx } => {
 Event::PaymentForwarded { fee_earned_msat, source_channel_id, claim_from_onchain_tx } => {
 assert_eq!(fee_earned_msat, Some(1000));
 assert_eq!(source_channel_id, Some(chan_1.2));
 assert_eq!(claim_from_onchain_tx, true);
 },
 _ => panic!("Unexpected event"),
Expand DownExpand Up@@ -5271,7 +5285,7 @@ fn test_duplicate_payment_hash_one_failure_one_success() {
	// Note that the fee paid is effectively double as the HTLC value (including the nodes[1] fee
	// and nodes[2] fee) is rounded down and then claimed in full.
	mine_transaction(&nodes[1], &htlc_success_txn[0]);
	expect_payment_forwarded!(nodes[1], Some(196*2), true);
	expect_payment_forwarded!(nodes[1], nodes[0], Some(196*2), true);
	let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
	assert!(updates.update_add_htlcs.is_empty());
	assert!(updates.update_fail_htlcs.is_empty());
Expand DownExpand Up@@ -8849,7 +8863,7 @@ fn do_test_onchain_htlc_settlement_after_close(broadcast_alice: bool, go_onchain
	assert_eq!(carol_updates.update_fulfill_htlcs.len(), 1);

	nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &carol_updates.update_fulfill_htlcs[0]);
	expect_payment_forwarded!(nodes[1], if go_onchain_before_fulfill || force_closing_node == 1 { None } else { Some(1000) }, false);
	expect_payment_forwarded!(nodes[1], nodes[0], if go_onchain_before_fulfill || force_closing_node == 1 { None } else { Some(1000) }, false);
	// If Alice broadcasted but Bob doesn't know yet, here he prepares to tell her about the preimage.
	if !go_onchain_before_fulfill && broadcast_alice {
 let events = nodes[1].node.get_and_clear_pending_msg_events();
Expand Down

2 changes: 1 addition & 1 deletion
lightning/src/ln/payment_tests.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -495,7 +495,7 @@ fn do_retry_with_no_persist(confirm_before_reload: bool) {
	let bs_htlc_claim_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
	assert_eq!(bs_htlc_claim_txn.len(), 1);
	check_spends!(bs_htlc_claim_txn[0], as_commitment_tx);
	expect_payment_forwarded!(nodes[1], None, false);
	expect_payment_forwarded!(nodes[1], nodes[0], None, false);

	if !confirm_before_reload {
 mine_transaction(&nodes[0], &as_commitment_tx);
Expand Down

2 changes: 1 addition & 1 deletion
lightning/src/ln/reorg_tests.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -138,7 +138,7 @@ fn do_test_onchain_htlc_reorg(local_commitment: bool, claim: bool) {
 // ChannelManager only polls chain::Watch::release_pending_monitor_events when we
 // probe it for events, so we probe non-message events here (which should just be the
 // PaymentForwarded event).
 expect_payment_forwarded!(nodes[1], Some(1000), true);
 expect_payment_forwarded!(nodes[1], nodes[0], Some(1000), true);
	} else {
 // Confirm the timeout tx and check that we fail the HTLC backwards
 let block = Block {
Expand Down

4 changes: 2 additions & 2 deletions
lightning/src/ln/shutdown_tests.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -110,7 +110,7 @@ fn updates_shutdown_wait() {
	assert!(updates.update_fee.is_none());
	assert_eq!(updates.update_fulfill_htlcs.len(), 1);
	nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
	expect_payment_forwarded!(nodes[1], Some(1000), false);
	expect_payment_forwarded!(nodes[1], nodes[0], Some(1000), false);
	check_added_monitors!(nodes[1], 1);
	let updates_2 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
	commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, false);
Expand DownExpand Up@@ -279,7 +279,7 @@ fn do_test_shutdown_rebroadcast(recv_count: u8) {
	assert!(updates.update_fee.is_none());
	assert_eq!(updates.update_fulfill_htlcs.len(), 1);
	nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
	expect_payment_forwarded!(nodes[1], Some(1000), false);
	expect_payment_forwarded!(nodes[1], nodes[0], Some(1000), false);
	check_added_monitors!(nodes[1], 1);
	let updates_2 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
	commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, false);
Expand Down

10 changes: 8 additions & 2 deletions
lightning/src/util/events.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -343,6 +343,9 @@ pub enum Event {
	/// This event is generated when a payment has been successfully forwarded through us and a
	/// forwarding fee earned.
	PaymentForwarded {
 /// The channel between the source node and us. Optional because versions prior to 0.0.107
 /// do not serialize this field.
 source_channel_id: Option<[u8; 32]>,
 /// The 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
Expand DownExpand Up@@ -520,10 +523,11 @@ impl Writeable for Event {
 (0, VecWriteWrapper(outputs), required),
 });
 },
 &Event::PaymentForwarded { fee_earned_msat, claim_from_onchain_tx } => {
 &Event::PaymentForwarded { fee_earned_msat, source_channel_id, claim_from_onchain_tx } => {
 7u8.write(writer)?;
 write_tlv_fields!(writer, {
 (0, fee_earned_msat, option),
 (1, source_channel_id, option),
 (2, claim_from_onchain_tx, required),
 });
 },
Expand DownExpand Up@@ -684,12 +688,14 @@ impl MaybeReadable for Event {
 7u8 => {
 let f = || {
 let mut fee_earned_msat = None;
 let mut source_channel_id = None;
 let mut claim_from_onchain_tx = false;
 read_tlv_fields!(reader, {
 (0, fee_earned_msat, option),
 (1, source_channel_id, option),
 (2, claim_from_onchain_tx, required),
 });
 Ok(Some(Event::PaymentForwarded { fee_earned_msat, claim_from_onchain_tx }))
 Ok(Some(Event::PaymentForwarded { fee_earned_msat, source_channel_id, claim_from_onchain_tx }))
 };
 f()
 },
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" + '
Expose more info in `PaymentForwarded` event by atalw · Pull Request #1419 · lightningdevkit/rust-lightning · GitHub
Skip to content
Expose more info in PaymentForwarded event#1419

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

valentinewallace
merged 1 commit into

from

Apr 20, 2022
 Merged


Expose more info in PaymentForwarded event
#1419
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


10 changes: 5 additions & 5 deletions
lightning/src/ln/chanmon_update_fail_tests.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1102,7 +1102,7 @@ fn test_monitor_update_fail_reestablish() {
	assert!(updates.update_fee.is_none());
	assert_eq!(updates.update_fulfill_htlcs.len(), 1);
	nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
	expect_payment_forwarded!(nodes[1], Some(1000), false);
	expect_payment_forwarded!(nodes[1], nodes[0], Some(1000), false);
	check_added_monitors!(nodes[1], 1);
	assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
	commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, false);
Expand DownExpand Up@@ -2087,7 +2087,7 @@ fn test_fail_htlc_on_broadcast_after_claim() {
	nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &cs_updates.update_fulfill_htlcs[0]);
	let bs_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
	check_added_monitors!(nodes[1], 1);
	expect_payment_forwarded!(nodes[1], Some(1000), false);
	expect_payment_forwarded!(nodes[1], nodes[0], Some(1000), false);

	mine_transaction(&nodes[1], &bs_txn[0]);
	check_closed_event!(nodes[1], 1, ClosureReason::CommitmentTxConfirmed);
Expand DownExpand Up@@ -2423,7 +2423,7 @@ fn do_test_reconnect_dup_htlc_claims(htlc_status: HTLCStatusAtDupClaim, second_f
	let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);

	create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
	let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known()).2;
	let chan_id_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known()).2;

	let (payment_preimage, payment_hash, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 100_000);

Expand All@@ -2450,7 +2450,7 @@ fn do_test_reconnect_dup_htlc_claims(htlc_status: HTLCStatusAtDupClaim, second_f
	}

	let fulfill_msg = msgs::UpdateFulfillHTLC {
 channel_id: chan_2,
 channel_id: chan_id_2,
 htlc_id: 0,
 payment_preimage,
	};
Expand All@@ -2468,7 +2468,7 @@ fn do_test_reconnect_dup_htlc_claims(htlc_status: HTLCStatusAtDupClaim, second_f
 assert_eq!(fulfill_msg, cs_updates.update_fulfill_htlcs[0]);
	}
	nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &fulfill_msg);
	expect_payment_forwarded!(nodes[1], Some(1000), false);
	expect_payment_forwarded!(nodes[1], nodes[0], Some(1000), false);
	check_added_monitors!(nodes[1], 1);

	let mut bs_updates = None;
Expand Down

3 changes: 3 additions & 0 deletions
lightning/src/ln/channelmanager.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4291,7 +4291,10 @@ impl<Signer: Sign, M: Deref, T: Deref, K: Deref, F: Deref, L: Deref> ChannelMana
 } else { None };

 let mut pending_events = self.pending_events.lock().unwrap();

 let source_channel_id = Some(prev_outpoint.to_channel_id());
 pending_events.push(events::Event::PaymentForwarded {
 source_channel_id,
 fee_earned_msat,
 claim_from_onchain_tx: from_onchain,
 });
Expand Down

21 changes: 16 additions & 5 deletions
lightning/src/ln/functional_test_utils.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1328,12 +1328,16 @@ macro_rules! expect_payment_path_successful {
}

macro_rules! expect_payment_forwarded {
	($node: expr, $expected_fee: expr, $upstream_force_closed: expr) => {
	($node: expr, $source_node: expr, $expected_fee: expr, $upstream_force_closed: expr) => {
 let events = $node.node.get_and_clear_pending_events();
 assert_eq!(events.len(), 1);
 match events[0] {
 Event::PaymentForwarded { fee_earned_msat, claim_from_onchain_tx } => {
 Event::PaymentForwarded { fee_earned_msat, source_channel_id, claim_from_onchain_tx } => {
 assert_eq!(fee_earned_msat, $expected_fee);
 if fee_earned_msat.is_some() {
 // Is the event channel_id in one of the channels between the two nodes?
 assert!($node.node.list_channels().iter().any(|x| x.counterparty.node_id == $source_node.node.get_our_node_id() && x.channel_id == source_channel_id.unwrap()));
 }
 assert_eq!(claim_from_onchain_tx, $upstream_force_closed);
 },
 _ => panic!("Unexpected event"),
Expand DownExpand Up@@ -1572,11 +1576,11 @@ pub fn do_claim_payment_along_route<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>,
 }
 }
 macro_rules! mid_update_fulfill_dance {
 ($node: expr, $prev_node: expr, $new_msgs: expr) => {
 ($node: expr, $prev_node: expr, $next_node: expr, $new_msgs: expr) => {
 {
 $node.node.handle_update_fulfill_htlc(&$prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0);
 let fee = $node.node.channel_state.lock().unwrap().by_id.get(&next_msgs.as_ref().unwrap().0.channel_id).unwrap().config.forwarding_fee_base_msat;
 expect_payment_forwarded!($node, Some(fee as u64), false);
 expect_payment_forwarded!($node, $next_node, Some(fee as u64), false);
 expected_total_fee_msat += fee as u64;
 check_added_monitors!($node, 1);
 let new_next_msgs = if $new_msgs {
Expand All@@ -1600,7 +1604,14 @@ pub fn do_claim_payment_along_route<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>,
 assert_eq!(expected_next_node, node.node.get_our_node_id());
 let update_next_msgs = !skip_last || idx != expected_route.len() - 1;
 if next_msgs.is_some() {
 mid_update_fulfill_dance!(node, prev_node, update_next_msgs);
 // Since we are traversing in reverse, next_node is actually the previous node
 let next_node: &Node;
 if idx == expected_route.len() - 1 {
 next_node = origin_node;
 } else {
 next_node = expected_route[expected_route.len() - 1 - idx - 1];
 }
 mid_update_fulfill_dance!(node, prev_node, next_node, update_next_msgs);
 } else {
 assert!(!update_next_msgs);
 assert!(node.node.get_and_clear_pending_msg_events().is_empty());
Expand Down

28 changes: 21 additions & 7 deletions
lightning/src/ln/functional_tests.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2684,10 +2684,23 @@ fn test_htlc_on_chain_success() {
 Event::ChannelClosed { reason: ClosureReason::CommitmentTxConfirmed, .. } => {}
 _ => panic!("Unexpected event"),
	}
	if let Event::PaymentForwarded { fee_earned_msat: Some(1000), claim_from_onchain_tx: true } = forwarded_events[1] {
 } else { panic!(); }
	if let Event::PaymentForwarded { fee_earned_msat: Some(1000), claim_from_onchain_tx: true } = forwarded_events[2] {
 } else { panic!(); }
	let chan_id = Some(chan_1.2);
	match forwarded_events[1] {
 Event::PaymentForwarded { fee_earned_msat, source_channel_id, claim_from_onchain_tx } => {
 assert_eq!(fee_earned_msat, Some(1000));
 assert_eq!(source_channel_id, chan_id);
 assert_eq!(claim_from_onchain_tx, true);
 },
 _ => panic!()
	}
	match forwarded_events[2] {
 Event::PaymentForwarded { fee_earned_msat, source_channel_id, claim_from_onchain_tx } => {
 assert_eq!(fee_earned_msat, Some(1000));
 assert_eq!(source_channel_id, chan_id);
 assert_eq!(claim_from_onchain_tx, true);
 },
 _ => panic!()
	}
	let events = nodes[1].node.get_and_clear_pending_msg_events();
	{
 let mut added_monitors = nodes[1].chain_monitor.added_monitors.lock().unwrap();
Expand DownExpand Up@@ -5104,8 +5117,9 @@ fn test_onchain_to_onchain_claim() {
 _ => panic!("Unexpected event"),
	}
	match events[1] {
 Event::PaymentForwarded { fee_earned_msat, claim_from_onchain_tx } => {
 Event::PaymentForwarded { fee_earned_msat, source_channel_id, claim_from_onchain_tx } => {
 assert_eq!(fee_earned_msat, Some(1000));
 assert_eq!(source_channel_id, Some(chan_1.2));
 assert_eq!(claim_from_onchain_tx, true);
 },
 _ => panic!("Unexpected event"),
Expand DownExpand Up@@ -5271,7 +5285,7 @@ fn test_duplicate_payment_hash_one_failure_one_success() {
	// Note that the fee paid is effectively double as the HTLC value (including the nodes[1] fee
	// and nodes[2] fee) is rounded down and then claimed in full.
	mine_transaction(&nodes[1], &htlc_success_txn[0]);
	expect_payment_forwarded!(nodes[1], Some(196*2), true);
	expect_payment_forwarded!(nodes[1], nodes[0], Some(196*2), true);
	let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
	assert!(updates.update_add_htlcs.is_empty());
	assert!(updates.update_fail_htlcs.is_empty());
Expand DownExpand Up@@ -8849,7 +8863,7 @@ fn do_test_onchain_htlc_settlement_after_close(broadcast_alice: bool, go_onchain
	assert_eq!(carol_updates.update_fulfill_htlcs.len(), 1);

	nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &carol_updates.update_fulfill_htlcs[0]);
	expect_payment_forwarded!(nodes[1], if go_onchain_before_fulfill || force_closing_node == 1 { None } else { Some(1000) }, false);
	expect_payment_forwarded!(nodes[1], nodes[0], if go_onchain_before_fulfill || force_closing_node == 1 { None } else { Some(1000) }, false);
	// If Alice broadcasted but Bob doesn't know yet, here he prepares to tell her about the preimage.
	if !go_onchain_before_fulfill && broadcast_alice {
 let events = nodes[1].node.get_and_clear_pending_msg_events();
Expand Down

2 changes: 1 addition & 1 deletion
lightning/src/ln/payment_tests.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -495,7 +495,7 @@ fn do_retry_with_no_persist(confirm_before_reload: bool) {
	let bs_htlc_claim_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
	assert_eq!(bs_htlc_claim_txn.len(), 1);
	check_spends!(bs_htlc_claim_txn[0], as_commitment_tx);
	expect_payment_forwarded!(nodes[1], None, false);
	expect_payment_forwarded!(nodes[1], nodes[0], None, false);

	if !confirm_before_reload {
 mine_transaction(&nodes[0], &as_commitment_tx);
Expand Down

2 changes: 1 addition & 1 deletion
lightning/src/ln/reorg_tests.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -138,7 +138,7 @@ fn do_test_onchain_htlc_reorg(local_commitment: bool, claim: bool) {
 // ChannelManager only polls chain::Watch::release_pending_monitor_events when we
 // probe it for events, so we probe non-message events here (which should just be the
 // PaymentForwarded event).
 expect_payment_forwarded!(nodes[1], Some(1000), true);
 expect_payment_forwarded!(nodes[1], nodes[0], Some(1000), true);
	} else {
 // Confirm the timeout tx and check that we fail the HTLC backwards
 let block = Block {
Expand Down

4 changes: 2 additions & 2 deletions
lightning/src/ln/shutdown_tests.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -110,7 +110,7 @@ fn updates_shutdown_wait() {
	assert!(updates.update_fee.is_none());
	assert_eq!(updates.update_fulfill_htlcs.len(), 1);
	nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
	expect_payment_forwarded!(nodes[1], Some(1000), false);
	expect_payment_forwarded!(nodes[1], nodes[0], Some(1000), false);
	check_added_monitors!(nodes[1], 1);
	let updates_2 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
	commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, false);
Expand DownExpand Up@@ -279,7 +279,7 @@ fn do_test_shutdown_rebroadcast(recv_count: u8) {
	assert!(updates.update_fee.is_none());
	assert_eq!(updates.update_fulfill_htlcs.len(), 1);
	nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
	expect_payment_forwarded!(nodes[1], Some(1000), false);
	expect_payment_forwarded!(nodes[1], nodes[0], Some(1000), false);
	check_added_monitors!(nodes[1], 1);
	let updates_2 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
	commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, false);
Expand Down

10 changes: 8 additions & 2 deletions
lightning/src/util/events.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -343,6 +343,9 @@ pub enum Event {
	/// This event is generated when a payment has been successfully forwarded through us and a
	/// forwarding fee earned.
	PaymentForwarded {
 /// The channel between the source node and us. Optional because versions prior to 0.0.107
 /// do not serialize this field.
 source_channel_id: Option<[u8; 32]>,
 /// The 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
Expand DownExpand Up@@ -520,10 +523,11 @@ impl Writeable for Event {
 (0, VecWriteWrapper(outputs), required),
 });
 },
 &Event::PaymentForwarded { fee_earned_msat, claim_from_onchain_tx } => {
 &Event::PaymentForwarded { fee_earned_msat, source_channel_id, claim_from_onchain_tx } => {
 7u8.write(writer)?;
 write_tlv_fields!(writer, {
 (0, fee_earned_msat, option),
 (1, source_channel_id, option),
 (2, claim_from_onchain_tx, required),
 });
 },
Expand DownExpand Up@@ -684,12 +688,14 @@ impl MaybeReadable for Event {
 7u8 => {
 let f = || {
 let mut fee_earned_msat = None;
 let mut source_channel_id = None;
 let mut claim_from_onchain_tx = false;
 read_tlv_fields!(reader, {
 (0, fee_earned_msat, option),
 (1, source_channel_id, option),
 (2, claim_from_onchain_tx, required),
 });
 Ok(Some(Event::PaymentForwarded { fee_earned_msat, claim_from_onchain_tx }))
 Ok(Some(Event::PaymentForwarded { fee_earned_msat, source_channel_id, claim_from_onchain_tx }))
 };
 f()
 },
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('^' + ".*" + '
Expose more info in `PaymentForwarded` event by atalw · Pull Request #1419 · lightningdevkit/rust-lightning · GitHub
Skip to content
Expose more info in PaymentForwarded event#1419

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

valentinewallace
merged 1 commit into

from

Apr 20, 2022
 Merged


Expose more info in PaymentForwarded event
#1419
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


10 changes: 5 additions & 5 deletions
lightning/src/ln/chanmon_update_fail_tests.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1102,7 +1102,7 @@ fn test_monitor_update_fail_reestablish() {
	assert!(updates.update_fee.is_none());
	assert_eq!(updates.update_fulfill_htlcs.len(), 1);
	nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
	expect_payment_forwarded!(nodes[1], Some(1000), false);
	expect_payment_forwarded!(nodes[1], nodes[0], Some(1000), false);
	check_added_monitors!(nodes[1], 1);
	assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
	commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, false);
Expand DownExpand Up@@ -2087,7 +2087,7 @@ fn test_fail_htlc_on_broadcast_after_claim() {
	nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &cs_updates.update_fulfill_htlcs[0]);
	let bs_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
	check_added_monitors!(nodes[1], 1);
	expect_payment_forwarded!(nodes[1], Some(1000), false);
	expect_payment_forwarded!(nodes[1], nodes[0], Some(1000), false);

	mine_transaction(&nodes[1], &bs_txn[0]);
	check_closed_event!(nodes[1], 1, ClosureReason::CommitmentTxConfirmed);
Expand DownExpand Up@@ -2423,7 +2423,7 @@ fn do_test_reconnect_dup_htlc_claims(htlc_status: HTLCStatusAtDupClaim, second_f
	let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);

	create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
	let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known()).2;
	let chan_id_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known()).2;

	let (payment_preimage, payment_hash, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 100_000);

Expand All@@ -2450,7 +2450,7 @@ fn do_test_reconnect_dup_htlc_claims(htlc_status: HTLCStatusAtDupClaim, second_f
	}

	let fulfill_msg = msgs::UpdateFulfillHTLC {
 channel_id: chan_2,
 channel_id: chan_id_2,
 htlc_id: 0,
 payment_preimage,
	};
Expand All@@ -2468,7 +2468,7 @@ fn do_test_reconnect_dup_htlc_claims(htlc_status: HTLCStatusAtDupClaim, second_f
 assert_eq!(fulfill_msg, cs_updates.update_fulfill_htlcs[0]);
	}
	nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &fulfill_msg);
	expect_payment_forwarded!(nodes[1], Some(1000), false);
	expect_payment_forwarded!(nodes[1], nodes[0], Some(1000), false);
	check_added_monitors!(nodes[1], 1);

	let mut bs_updates = None;
Expand Down

3 changes: 3 additions & 0 deletions
lightning/src/ln/channelmanager.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4291,7 +4291,10 @@ impl<Signer: Sign, M: Deref, T: Deref, K: Deref, F: Deref, L: Deref> ChannelMana
 } else { None };

 let mut pending_events = self.pending_events.lock().unwrap();

 let source_channel_id = Some(prev_outpoint.to_channel_id());
 pending_events.push(events::Event::PaymentForwarded {
 source_channel_id,
 fee_earned_msat,
 claim_from_onchain_tx: from_onchain,
 });
Expand Down

21 changes: 16 additions & 5 deletions
lightning/src/ln/functional_test_utils.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1328,12 +1328,16 @@ macro_rules! expect_payment_path_successful {
}

macro_rules! expect_payment_forwarded {
	($node: expr, $expected_fee: expr, $upstream_force_closed: expr) => {
	($node: expr, $source_node: expr, $expected_fee: expr, $upstream_force_closed: expr) => {
 let events = $node.node.get_and_clear_pending_events();
 assert_eq!(events.len(), 1);
 match events[0] {
 Event::PaymentForwarded { fee_earned_msat, claim_from_onchain_tx } => {
 Event::PaymentForwarded { fee_earned_msat, source_channel_id, claim_from_onchain_tx } => {
 assert_eq!(fee_earned_msat, $expected_fee);
 if fee_earned_msat.is_some() {
 // Is the event channel_id in one of the channels between the two nodes?
 assert!($node.node.list_channels().iter().any(|x| x.counterparty.node_id == $source_node.node.get_our_node_id() && x.channel_id == source_channel_id.unwrap()));
 }
 assert_eq!(claim_from_onchain_tx, $upstream_force_closed);
 },
 _ => panic!("Unexpected event"),
Expand DownExpand Up@@ -1572,11 +1576,11 @@ pub fn do_claim_payment_along_route<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>,
 }
 }
 macro_rules! mid_update_fulfill_dance {
 ($node: expr, $prev_node: expr, $new_msgs: expr) => {
 ($node: expr, $prev_node: expr, $next_node: expr, $new_msgs: expr) => {
 {
 $node.node.handle_update_fulfill_htlc(&$prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0);
 let fee = $node.node.channel_state.lock().unwrap().by_id.get(&next_msgs.as_ref().unwrap().0.channel_id).unwrap().config.forwarding_fee_base_msat;
 expect_payment_forwarded!($node, Some(fee as u64), false);
 expect_payment_forwarded!($node, $next_node, Some(fee as u64), false);
 expected_total_fee_msat += fee as u64;
 check_added_monitors!($node, 1);
 let new_next_msgs = if $new_msgs {
Expand All@@ -1600,7 +1604,14 @@ pub fn do_claim_payment_along_route<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>,
 assert_eq!(expected_next_node, node.node.get_our_node_id());
 let update_next_msgs = !skip_last || idx != expected_route.len() - 1;
 if next_msgs.is_some() {
 mid_update_fulfill_dance!(node, prev_node, update_next_msgs);
 // Since we are traversing in reverse, next_node is actually the previous node
 let next_node: &Node;
 if idx == expected_route.len() - 1 {
 next_node = origin_node;
 } else {
 next_node = expected_route[expected_route.len() - 1 - idx - 1];
 }
 mid_update_fulfill_dance!(node, prev_node, next_node, update_next_msgs);
 } else {
 assert!(!update_next_msgs);
 assert!(node.node.get_and_clear_pending_msg_events().is_empty());
Expand Down

28 changes: 21 additions & 7 deletions
lightning/src/ln/functional_tests.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2684,10 +2684,23 @@ fn test_htlc_on_chain_success() {
 Event::ChannelClosed { reason: ClosureReason::CommitmentTxConfirmed, .. } => {}
 _ => panic!("Unexpected event"),
	}
	if let Event::PaymentForwarded { fee_earned_msat: Some(1000), claim_from_onchain_tx: true } = forwarded_events[1] {
 } else { panic!(); }
	if let Event::PaymentForwarded { fee_earned_msat: Some(1000), claim_from_onchain_tx: true } = forwarded_events[2] {
 } else { panic!(); }
	let chan_id = Some(chan_1.2);
	match forwarded_events[1] {
 Event::PaymentForwarded { fee_earned_msat, source_channel_id, claim_from_onchain_tx } => {
 assert_eq!(fee_earned_msat, Some(1000));
 assert_eq!(source_channel_id, chan_id);
 assert_eq!(claim_from_onchain_tx, true);
 },
 _ => panic!()
	}
	match forwarded_events[2] {
 Event::PaymentForwarded { fee_earned_msat, source_channel_id, claim_from_onchain_tx } => {
 assert_eq!(fee_earned_msat, Some(1000));
 assert_eq!(source_channel_id, chan_id);
 assert_eq!(claim_from_onchain_tx, true);
 },
 _ => panic!()
	}
	let events = nodes[1].node.get_and_clear_pending_msg_events();
	{
 let mut added_monitors = nodes[1].chain_monitor.added_monitors.lock().unwrap();
Expand DownExpand Up@@ -5104,8 +5117,9 @@ fn test_onchain_to_onchain_claim() {
 _ => panic!("Unexpected event"),
	}
	match events[1] {
 Event::PaymentForwarded { fee_earned_msat, claim_from_onchain_tx } => {
 Event::PaymentForwarded { fee_earned_msat, source_channel_id, claim_from_onchain_tx } => {
 assert_eq!(fee_earned_msat, Some(1000));
 assert_eq!(source_channel_id, Some(chan_1.2));
 assert_eq!(claim_from_onchain_tx, true);
 },
 _ => panic!("Unexpected event"),
Expand DownExpand Up@@ -5271,7 +5285,7 @@ fn test_duplicate_payment_hash_one_failure_one_success() {
	// Note that the fee paid is effectively double as the HTLC value (including the nodes[1] fee
	// and nodes[2] fee) is rounded down and then claimed in full.
	mine_transaction(&nodes[1], &htlc_success_txn[0]);
	expect_payment_forwarded!(nodes[1], Some(196*2), true);
	expect_payment_forwarded!(nodes[1], nodes[0], Some(196*2), true);
	let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
	assert!(updates.update_add_htlcs.is_empty());
	assert!(updates.update_fail_htlcs.is_empty());
Expand DownExpand Up@@ -8849,7 +8863,7 @@ fn do_test_onchain_htlc_settlement_after_close(broadcast_alice: bool, go_onchain
	assert_eq!(carol_updates.update_fulfill_htlcs.len(), 1);

	nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &carol_updates.update_fulfill_htlcs[0]);
	expect_payment_forwarded!(nodes[1], if go_onchain_before_fulfill || force_closing_node == 1 { None } else { Some(1000) }, false);
	expect_payment_forwarded!(nodes[1], nodes[0], if go_onchain_before_fulfill || force_closing_node == 1 { None } else { Some(1000) }, false);
	// If Alice broadcasted but Bob doesn't know yet, here he prepares to tell her about the preimage.
	if !go_onchain_before_fulfill && broadcast_alice {
 let events = nodes[1].node.get_and_clear_pending_msg_events();
Expand Down

2 changes: 1 addition & 1 deletion
lightning/src/ln/payment_tests.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -495,7 +495,7 @@ fn do_retry_with_no_persist(confirm_before_reload: bool) {
	let bs_htlc_claim_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
	assert_eq!(bs_htlc_claim_txn.len(), 1);
	check_spends!(bs_htlc_claim_txn[0], as_commitment_tx);
	expect_payment_forwarded!(nodes[1], None, false);
	expect_payment_forwarded!(nodes[1], nodes[0], None, false);

	if !confirm_before_reload {
 mine_transaction(&nodes[0], &as_commitment_tx);
Expand Down

2 changes: 1 addition & 1 deletion
lightning/src/ln/reorg_tests.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -138,7 +138,7 @@ fn do_test_onchain_htlc_reorg(local_commitment: bool, claim: bool) {
 // ChannelManager only polls chain::Watch::release_pending_monitor_events when we
 // probe it for events, so we probe non-message events here (which should just be the
 // PaymentForwarded event).
 expect_payment_forwarded!(nodes[1], Some(1000), true);
 expect_payment_forwarded!(nodes[1], nodes[0], Some(1000), true);
	} else {
 // Confirm the timeout tx and check that we fail the HTLC backwards
 let block = Block {
Expand Down

4 changes: 2 additions & 2 deletions
lightning/src/ln/shutdown_tests.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -110,7 +110,7 @@ fn updates_shutdown_wait() {
	assert!(updates.update_fee.is_none());
	assert_eq!(updates.update_fulfill_htlcs.len(), 1);
	nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
	expect_payment_forwarded!(nodes[1], Some(1000), false);
	expect_payment_forwarded!(nodes[1], nodes[0], Some(1000), false);
	check_added_monitors!(nodes[1], 1);
	let updates_2 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
	commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, false);
Expand DownExpand Up@@ -279,7 +279,7 @@ fn do_test_shutdown_rebroadcast(recv_count: u8) {
	assert!(updates.update_fee.is_none());
	assert_eq!(updates.update_fulfill_htlcs.len(), 1);
	nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
	expect_payment_forwarded!(nodes[1], Some(1000), false);
	expect_payment_forwarded!(nodes[1], nodes[0], Some(1000), false);
	check_added_monitors!(nodes[1], 1);
	let updates_2 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
	commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, false);
Expand Down

10 changes: 8 additions & 2 deletions
lightning/src/util/events.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -343,6 +343,9 @@ pub enum Event {
	/// This event is generated when a payment has been successfully forwarded through us and a
	/// forwarding fee earned.
	PaymentForwarded {
 /// The channel between the source node and us. Optional because versions prior to 0.0.107
 /// do not serialize this field.
 source_channel_id: Option<[u8; 32]>,
 /// The 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
Expand DownExpand Up@@ -520,10 +523,11 @@ impl Writeable for Event {
 (0, VecWriteWrapper(outputs), required),
 });
 },
 &Event::PaymentForwarded { fee_earned_msat, claim_from_onchain_tx } => {
 &Event::PaymentForwarded { fee_earned_msat, source_channel_id, claim_from_onchain_tx } => {
 7u8.write(writer)?;
 write_tlv_fields!(writer, {
 (0, fee_earned_msat, option),
 (1, source_channel_id, option),
 (2, claim_from_onchain_tx, required),
 });
 },
Expand DownExpand Up@@ -684,12 +688,14 @@ impl MaybeReadable for Event {
 7u8 => {
 let f = || {
 let mut fee_earned_msat = None;
 let mut source_channel_id = None;
 let mut claim_from_onchain_tx = false;
 read_tlv_fields!(reader, {
 (0, fee_earned_msat, option),
 (1, source_channel_id, option),
 (2, claim_from_onchain_tx, required),
 });
 Ok(Some(Event::PaymentForwarded { fee_earned_msat, claim_from_onchain_tx }))
 Ok(Some(Event::PaymentForwarded { fee_earned_msat, source_channel_id, claim_from_onchain_tx }))
 };
 f()
 },
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('^' + ".*" + '
Expose more info in `PaymentForwarded` event by atalw · Pull Request #1419 · lightningdevkit/rust-lightning · GitHub
Skip to content
Expose more info in PaymentForwarded event#1419

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

valentinewallace
merged 1 commit into

from

Apr 20, 2022
 Merged


Expose more info in PaymentForwarded event
#1419
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


10 changes: 5 additions & 5 deletions
lightning/src/ln/chanmon_update_fail_tests.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1102,7 +1102,7 @@ fn test_monitor_update_fail_reestablish() {
	assert!(updates.update_fee.is_none());
	assert_eq!(updates.update_fulfill_htlcs.len(), 1);
	nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
	expect_payment_forwarded!(nodes[1], Some(1000), false);
	expect_payment_forwarded!(nodes[1], nodes[0], Some(1000), false);
	check_added_monitors!(nodes[1], 1);
	assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
	commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, false);
Expand DownExpand Up@@ -2087,7 +2087,7 @@ fn test_fail_htlc_on_broadcast_after_claim() {
	nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &cs_updates.update_fulfill_htlcs[0]);
	let bs_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
	check_added_monitors!(nodes[1], 1);
	expect_payment_forwarded!(nodes[1], Some(1000), false);
	expect_payment_forwarded!(nodes[1], nodes[0], Some(1000), false);

	mine_transaction(&nodes[1], &bs_txn[0]);
	check_closed_event!(nodes[1], 1, ClosureReason::CommitmentTxConfirmed);
Expand DownExpand Up@@ -2423,7 +2423,7 @@ fn do_test_reconnect_dup_htlc_claims(htlc_status: HTLCStatusAtDupClaim, second_f
	let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);

	create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
	let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known()).2;
	let chan_id_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known()).2;

	let (payment_preimage, payment_hash, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 100_000);

Expand All@@ -2450,7 +2450,7 @@ fn do_test_reconnect_dup_htlc_claims(htlc_status: HTLCStatusAtDupClaim, second_f
	}

	let fulfill_msg = msgs::UpdateFulfillHTLC {
 channel_id: chan_2,
 channel_id: chan_id_2,
 htlc_id: 0,
 payment_preimage,
	};
Expand All@@ -2468,7 +2468,7 @@ fn do_test_reconnect_dup_htlc_claims(htlc_status: HTLCStatusAtDupClaim, second_f
 assert_eq!(fulfill_msg, cs_updates.update_fulfill_htlcs[0]);
	}
	nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &fulfill_msg);
	expect_payment_forwarded!(nodes[1], Some(1000), false);
	expect_payment_forwarded!(nodes[1], nodes[0], Some(1000), false);
	check_added_monitors!(nodes[1], 1);

	let mut bs_updates = None;
Expand Down

3 changes: 3 additions & 0 deletions
lightning/src/ln/channelmanager.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4291,7 +4291,10 @@ impl<Signer: Sign, M: Deref, T: Deref, K: Deref, F: Deref, L: Deref> ChannelMana
 } else { None };

 let mut pending_events = self.pending_events.lock().unwrap();

 let source_channel_id = Some(prev_outpoint.to_channel_id());
 pending_events.push(events::Event::PaymentForwarded {
 source_channel_id,
 fee_earned_msat,
 claim_from_onchain_tx: from_onchain,
 });
Expand Down

21 changes: 16 additions & 5 deletions
lightning/src/ln/functional_test_utils.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1328,12 +1328,16 @@ macro_rules! expect_payment_path_successful {
}

macro_rules! expect_payment_forwarded {
	($node: expr, $expected_fee: expr, $upstream_force_closed: expr) => {
	($node: expr, $source_node: expr, $expected_fee: expr, $upstream_force_closed: expr) => {
 let events = $node.node.get_and_clear_pending_events();
 assert_eq!(events.len(), 1);
 match events[0] {
 Event::PaymentForwarded { fee_earned_msat, claim_from_onchain_tx } => {
 Event::PaymentForwarded { fee_earned_msat, source_channel_id, claim_from_onchain_tx } => {
 assert_eq!(fee_earned_msat, $expected_fee);
 if fee_earned_msat.is_some() {
 // Is the event channel_id in one of the channels between the two nodes?
 assert!($node.node.list_channels().iter().any(|x| x.counterparty.node_id == $source_node.node.get_our_node_id() && x.channel_id == source_channel_id.unwrap()));
 }
 assert_eq!(claim_from_onchain_tx, $upstream_force_closed);
 },
 _ => panic!("Unexpected event"),
Expand DownExpand Up@@ -1572,11 +1576,11 @@ pub fn do_claim_payment_along_route<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>,
 }
 }
 macro_rules! mid_update_fulfill_dance {
 ($node: expr, $prev_node: expr, $new_msgs: expr) => {
 ($node: expr, $prev_node: expr, $next_node: expr, $new_msgs: expr) => {
 {
 $node.node.handle_update_fulfill_htlc(&$prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0);
 let fee = $node.node.channel_state.lock().unwrap().by_id.get(&next_msgs.as_ref().unwrap().0.channel_id).unwrap().config.forwarding_fee_base_msat;
 expect_payment_forwarded!($node, Some(fee as u64), false);
 expect_payment_forwarded!($node, $next_node, Some(fee as u64), false);
 expected_total_fee_msat += fee as u64;
 check_added_monitors!($node, 1);
 let new_next_msgs = if $new_msgs {
Expand All@@ -1600,7 +1604,14 @@ pub fn do_claim_payment_along_route<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>,
 assert_eq!(expected_next_node, node.node.get_our_node_id());
 let update_next_msgs = !skip_last || idx != expected_route.len() - 1;
 if next_msgs.is_some() {
 mid_update_fulfill_dance!(node, prev_node, update_next_msgs);
 // Since we are traversing in reverse, next_node is actually the previous node
 let next_node: &Node;
 if idx == expected_route.len() - 1 {
 next_node = origin_node;
 } else {
 next_node = expected_route[expected_route.len() - 1 - idx - 1];
 }
 mid_update_fulfill_dance!(node, prev_node, next_node, update_next_msgs);
 } else {
 assert!(!update_next_msgs);
 assert!(node.node.get_and_clear_pending_msg_events().is_empty());
Expand Down

28 changes: 21 additions & 7 deletions
lightning/src/ln/functional_tests.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2684,10 +2684,23 @@ fn test_htlc_on_chain_success() {
 Event::ChannelClosed { reason: ClosureReason::CommitmentTxConfirmed, .. } => {}
 _ => panic!("Unexpected event"),
	}
	if let Event::PaymentForwarded { fee_earned_msat: Some(1000), claim_from_onchain_tx: true } = forwarded_events[1] {
 } else { panic!(); }
	if let Event::PaymentForwarded { fee_earned_msat: Some(1000), claim_from_onchain_tx: true } = forwarded_events[2] {
 } else { panic!(); }
	let chan_id = Some(chan_1.2);
	match forwarded_events[1] {
 Event::PaymentForwarded { fee_earned_msat, source_channel_id, claim_from_onchain_tx } => {
 assert_eq!(fee_earned_msat, Some(1000));
 assert_eq!(source_channel_id, chan_id);
 assert_eq!(claim_from_onchain_tx, true);
 },
 _ => panic!()
	}
	match forwarded_events[2] {
 Event::PaymentForwarded { fee_earned_msat, source_channel_id, claim_from_onchain_tx } => {
 assert_eq!(fee_earned_msat, Some(1000));
 assert_eq!(source_channel_id, chan_id);
 assert_eq!(claim_from_onchain_tx, true);
 },
 _ => panic!()
	}
	let events = nodes[1].node.get_and_clear_pending_msg_events();
	{
 let mut added_monitors = nodes[1].chain_monitor.added_monitors.lock().unwrap();
Expand DownExpand Up@@ -5104,8 +5117,9 @@ fn test_onchain_to_onchain_claim() {
 _ => panic!("Unexpected event"),
	}
	match events[1] {
 Event::PaymentForwarded { fee_earned_msat, claim_from_onchain_tx } => {
 Event::PaymentForwarded { fee_earned_msat, source_channel_id, claim_from_onchain_tx } => {
 assert_eq!(fee_earned_msat, Some(1000));
 assert_eq!(source_channel_id, Some(chan_1.2));
 assert_eq!(claim_from_onchain_tx, true);
 },
 _ => panic!("Unexpected event"),
Expand DownExpand Up@@ -5271,7 +5285,7 @@ fn test_duplicate_payment_hash_one_failure_one_success() {
	// Note that the fee paid is effectively double as the HTLC value (including the nodes[1] fee
	// and nodes[2] fee) is rounded down and then claimed in full.
	mine_transaction(&nodes[1], &htlc_success_txn[0]);
	expect_payment_forwarded!(nodes[1], Some(196*2), true);
	expect_payment_forwarded!(nodes[1], nodes[0], Some(196*2), true);
	let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
	assert!(updates.update_add_htlcs.is_empty());
	assert!(updates.update_fail_htlcs.is_empty());
Expand DownExpand Up@@ -8849,7 +8863,7 @@ fn do_test_onchain_htlc_settlement_after_close(broadcast_alice: bool, go_onchain
	assert_eq!(carol_updates.update_fulfill_htlcs.len(), 1);

	nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &carol_updates.update_fulfill_htlcs[0]);
	expect_payment_forwarded!(nodes[1], if go_onchain_before_fulfill || force_closing_node == 1 { None } else { Some(1000) }, false);
	expect_payment_forwarded!(nodes[1], nodes[0], if go_onchain_before_fulfill || force_closing_node == 1 { None } else { Some(1000) }, false);
	// If Alice broadcasted but Bob doesn't know yet, here he prepares to tell her about the preimage.
	if !go_onchain_before_fulfill && broadcast_alice {
 let events = nodes[1].node.get_and_clear_pending_msg_events();
Expand Down

2 changes: 1 addition & 1 deletion
lightning/src/ln/payment_tests.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -495,7 +495,7 @@ fn do_retry_with_no_persist(confirm_before_reload: bool) {
	let bs_htlc_claim_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
	assert_eq!(bs_htlc_claim_txn.len(), 1);
	check_spends!(bs_htlc_claim_txn[0], as_commitment_tx);
	expect_payment_forwarded!(nodes[1], None, false);
	expect_payment_forwarded!(nodes[1], nodes[0], None, false);

	if !confirm_before_reload {
 mine_transaction(&nodes[0], &as_commitment_tx);
Expand Down

2 changes: 1 addition & 1 deletion
lightning/src/ln/reorg_tests.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -138,7 +138,7 @@ fn do_test_onchain_htlc_reorg(local_commitment: bool, claim: bool) {
 // ChannelManager only polls chain::Watch::release_pending_monitor_events when we
 // probe it for events, so we probe non-message events here (which should just be the
 // PaymentForwarded event).
 expect_payment_forwarded!(nodes[1], Some(1000), true);
 expect_payment_forwarded!(nodes[1], nodes[0], Some(1000), true);
	} else {
 // Confirm the timeout tx and check that we fail the HTLC backwards
 let block = Block {
Expand Down

4 changes: 2 additions & 2 deletions
lightning/src/ln/shutdown_tests.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -110,7 +110,7 @@ fn updates_shutdown_wait() {
	assert!(updates.update_fee.is_none());
	assert_eq!(updates.update_fulfill_htlcs.len(), 1);
	nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
	expect_payment_forwarded!(nodes[1], Some(1000), false);
	expect_payment_forwarded!(nodes[1], nodes[0], Some(1000), false);
	check_added_monitors!(nodes[1], 1);
	let updates_2 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
	commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, false);
Expand DownExpand Up@@ -279,7 +279,7 @@ fn do_test_shutdown_rebroadcast(recv_count: u8) {
	assert!(updates.update_fee.is_none());
	assert_eq!(updates.update_fulfill_htlcs.len(), 1);
	nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
	expect_payment_forwarded!(nodes[1], Some(1000), false);
	expect_payment_forwarded!(nodes[1], nodes[0], Some(1000), false);
	check_added_monitors!(nodes[1], 1);
	let updates_2 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
	commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, false);
Expand Down

10 changes: 8 additions & 2 deletions
lightning/src/util/events.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -343,6 +343,9 @@ pub enum Event {
	/// This event is generated when a payment has been successfully forwarded through us and a
	/// forwarding fee earned.
	PaymentForwarded {
 /// The channel between the source node and us. Optional because versions prior to 0.0.107
 /// do not serialize this field.
 source_channel_id: Option<[u8; 32]>,
 /// The 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
Expand DownExpand Up@@ -520,10 +523,11 @@ impl Writeable for Event {
 (0, VecWriteWrapper(outputs), required),
 });
 },
 &Event::PaymentForwarded { fee_earned_msat, claim_from_onchain_tx } => {
 &Event::PaymentForwarded { fee_earned_msat, source_channel_id, claim_from_onchain_tx } => {
 7u8.write(writer)?;
 write_tlv_fields!(writer, {
 (0, fee_earned_msat, option),
 (1, source_channel_id, option),
 (2, claim_from_onchain_tx, required),
 });
 },
Expand DownExpand Up@@ -684,12 +688,14 @@ impl MaybeReadable for Event {
 7u8 => {
 let f = || {
 let mut fee_earned_msat = None;
 let mut source_channel_id = None;
 let mut claim_from_onchain_tx = false;
 read_tlv_fields!(reader, {
 (0, fee_earned_msat, option),
 (1, source_channel_id, option),
 (2, claim_from_onchain_tx, required),
 });
 Ok(Some(Event::PaymentForwarded { fee_earned_msat, claim_from_onchain_tx }))
 Ok(Some(Event::PaymentForwarded { fee_earned_msat, source_channel_id, claim_from_onchain_tx }))
 };
 f()
 },
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); }
})();
})();
Expose more info in `PaymentForwarded` event by atalw · Pull Request #1419 · lightningdevkit/rust-lightning · GitHub
Skip to content
Expose more info in PaymentForwarded event#1419

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

valentinewallace
merged 1 commit into

from

Apr 20, 2022
 Merged


Expose more info in PaymentForwarded event
#1419
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


10 changes: 5 additions & 5 deletions
lightning/src/ln/chanmon_update_fail_tests.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1102,7 +1102,7 @@ fn test_monitor_update_fail_reestablish() {
	assert!(updates.update_fee.is_none());
	assert_eq!(updates.update_fulfill_htlcs.len(), 1);
	nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
	expect_payment_forwarded!(nodes[1], Some(1000), false);
	expect_payment_forwarded!(nodes[1], nodes[0], Some(1000), false);
	check_added_monitors!(nodes[1], 1);
	assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
	commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, false);
Expand DownExpand Up@@ -2087,7 +2087,7 @@ fn test_fail_htlc_on_broadcast_after_claim() {
	nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &cs_updates.update_fulfill_htlcs[0]);
	let bs_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
	check_added_monitors!(nodes[1], 1);
	expect_payment_forwarded!(nodes[1], Some(1000), false);
	expect_payment_forwarded!(nodes[1], nodes[0], Some(1000), false);

	mine_transaction(&nodes[1], &bs_txn[0]);
	check_closed_event!(nodes[1], 1, ClosureReason::CommitmentTxConfirmed);
Expand DownExpand Up@@ -2423,7 +2423,7 @@ fn do_test_reconnect_dup_htlc_claims(htlc_status: HTLCStatusAtDupClaim, second_f
	let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);

	create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
	let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known()).2;
	let chan_id_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known()).2;

	let (payment_preimage, payment_hash, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 100_000);

Expand All@@ -2450,7 +2450,7 @@ fn do_test_reconnect_dup_htlc_claims(htlc_status: HTLCStatusAtDupClaim, second_f
	}

	let fulfill_msg = msgs::UpdateFulfillHTLC {
 channel_id: chan_2,
 channel_id: chan_id_2,
 htlc_id: 0,
 payment_preimage,
	};
Expand All@@ -2468,7 +2468,7 @@ fn do_test_reconnect_dup_htlc_claims(htlc_status: HTLCStatusAtDupClaim, second_f
 assert_eq!(fulfill_msg, cs_updates.update_fulfill_htlcs[0]);
	}
	nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &fulfill_msg);
	expect_payment_forwarded!(nodes[1], Some(1000), false);
	expect_payment_forwarded!(nodes[1], nodes[0], Some(1000), false);
	check_added_monitors!(nodes[1], 1);

	let mut bs_updates = None;
Expand Down

3 changes: 3 additions & 0 deletions
lightning/src/ln/channelmanager.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4291,7 +4291,10 @@ impl<Signer: Sign, M: Deref, T: Deref, K: Deref, F: Deref, L: Deref> ChannelMana
 } else { None };

 let mut pending_events = self.pending_events.lock().unwrap();

 let source_channel_id = Some(prev_outpoint.to_channel_id());
 pending_events.push(events::Event::PaymentForwarded {
 source_channel_id,
 fee_earned_msat,
 claim_from_onchain_tx: from_onchain,
 });
Expand Down

21 changes: 16 additions & 5 deletions
lightning/src/ln/functional_test_utils.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1328,12 +1328,16 @@ macro_rules! expect_payment_path_successful {
}

macro_rules! expect_payment_forwarded {
	($node: expr, $expected_fee: expr, $upstream_force_closed: expr) => {
	($node: expr, $source_node: expr, $expected_fee: expr, $upstream_force_closed: expr) => {
 let events = $node.node.get_and_clear_pending_events();
 assert_eq!(events.len(), 1);
 match events[0] {
 Event::PaymentForwarded { fee_earned_msat, claim_from_onchain_tx } => {
 Event::PaymentForwarded { fee_earned_msat, source_channel_id, claim_from_onchain_tx } => {
 assert_eq!(fee_earned_msat, $expected_fee);
 if fee_earned_msat.is_some() {
 // Is the event channel_id in one of the channels between the two nodes?
 assert!($node.node.list_channels().iter().any(|x| x.counterparty.node_id == $source_node.node.get_our_node_id() && x.channel_id == source_channel_id.unwrap()));
 }
 assert_eq!(claim_from_onchain_tx, $upstream_force_closed);
 },
 _ => panic!("Unexpected event"),
Expand DownExpand Up@@ -1572,11 +1576,11 @@ pub fn do_claim_payment_along_route<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>,
 }
 }
 macro_rules! mid_update_fulfill_dance {
 ($node: expr, $prev_node: expr, $new_msgs: expr) => {
 ($node: expr, $prev_node: expr, $next_node: expr, $new_msgs: expr) => {
 {
 $node.node.handle_update_fulfill_htlc(&$prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0);
 let fee = $node.node.channel_state.lock().unwrap().by_id.get(&next_msgs.as_ref().unwrap().0.channel_id).unwrap().config.forwarding_fee_base_msat;
 expect_payment_forwarded!($node, Some(fee as u64), false);
 expect_payment_forwarded!($node, $next_node, Some(fee as u64), false);
 expected_total_fee_msat += fee as u64;
 check_added_monitors!($node, 1);
 let new_next_msgs = if $new_msgs {
Expand All@@ -1600,7 +1604,14 @@ pub fn do_claim_payment_along_route<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>,
 assert_eq!(expected_next_node, node.node.get_our_node_id());
 let update_next_msgs = !skip_last || idx != expected_route.len() - 1;
 if next_msgs.is_some() {
 mid_update_fulfill_dance!(node, prev_node, update_next_msgs);
 // Since we are traversing in reverse, next_node is actually the previous node
 let next_node: &Node;
 if idx == expected_route.len() - 1 {
 next_node = origin_node;
 } else {
 next_node = expected_route[expected_route.len() - 1 - idx - 1];
 }
 mid_update_fulfill_dance!(node, prev_node, next_node, update_next_msgs);
 } else {
 assert!(!update_next_msgs);
 assert!(node.node.get_and_clear_pending_msg_events().is_empty());
Expand Down

28 changes: 21 additions & 7 deletions
lightning/src/ln/functional_tests.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2684,10 +2684,23 @@ fn test_htlc_on_chain_success() {
 Event::ChannelClosed { reason: ClosureReason::CommitmentTxConfirmed, .. } => {}
 _ => panic!("Unexpected event"),
	}
	if let Event::PaymentForwarded { fee_earned_msat: Some(1000), claim_from_onchain_tx: true } = forwarded_events[1] {
 } else { panic!(); }
	if let Event::PaymentForwarded { fee_earned_msat: Some(1000), claim_from_onchain_tx: true } = forwarded_events[2] {
 } else { panic!(); }
	let chan_id = Some(chan_1.2);
	match forwarded_events[1] {
 Event::PaymentForwarded { fee_earned_msat, source_channel_id, claim_from_onchain_tx } => {
 assert_eq!(fee_earned_msat, Some(1000));
 assert_eq!(source_channel_id, chan_id);
 assert_eq!(claim_from_onchain_tx, true);
 },
 _ => panic!()
	}
	match forwarded_events[2] {
 Event::PaymentForwarded { fee_earned_msat, source_channel_id, claim_from_onchain_tx } => {
 assert_eq!(fee_earned_msat, Some(1000));
 assert_eq!(source_channel_id, chan_id);
 assert_eq!(claim_from_onchain_tx, true);
 },
 _ => panic!()
	}
	let events = nodes[1].node.get_and_clear_pending_msg_events();
	{
 let mut added_monitors = nodes[1].chain_monitor.added_monitors.lock().unwrap();
Expand DownExpand Up@@ -5104,8 +5117,9 @@ fn test_onchain_to_onchain_claim() {
 _ => panic!("Unexpected event"),
	}
	match events[1] {
 Event::PaymentForwarded { fee_earned_msat, claim_from_onchain_tx } => {
 Event::PaymentForwarded { fee_earned_msat, source_channel_id, claim_from_onchain_tx } => {
 assert_eq!(fee_earned_msat, Some(1000));
 assert_eq!(source_channel_id, Some(chan_1.2));
 assert_eq!(claim_from_onchain_tx, true);
 },
 _ => panic!("Unexpected event"),
Expand DownExpand Up@@ -5271,7 +5285,7 @@ fn test_duplicate_payment_hash_one_failure_one_success() {
	// Note that the fee paid is effectively double as the HTLC value (including the nodes[1] fee
	// and nodes[2] fee) is rounded down and then claimed in full.
	mine_transaction(&nodes[1], &htlc_success_txn[0]);
	expect_payment_forwarded!(nodes[1], Some(196*2), true);
	expect_payment_forwarded!(nodes[1], nodes[0], Some(196*2), true);
	let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
	assert!(updates.update_add_htlcs.is_empty());
	assert!(updates.update_fail_htlcs.is_empty());
Expand DownExpand Up@@ -8849,7 +8863,7 @@ fn do_test_onchain_htlc_settlement_after_close(broadcast_alice: bool, go_onchain
	assert_eq!(carol_updates.update_fulfill_htlcs.len(), 1);

	nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &carol_updates.update_fulfill_htlcs[0]);
	expect_payment_forwarded!(nodes[1], if go_onchain_before_fulfill || force_closing_node == 1 { None } else { Some(1000) }, false);
	expect_payment_forwarded!(nodes[1], nodes[0], if go_onchain_before_fulfill || force_closing_node == 1 { None } else { Some(1000) }, false);
	// If Alice broadcasted but Bob doesn't know yet, here he prepares to tell her about the preimage.
	if !go_onchain_before_fulfill && broadcast_alice {
 let events = nodes[1].node.get_and_clear_pending_msg_events();
Expand Down

2 changes: 1 addition & 1 deletion
lightning/src/ln/payment_tests.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -495,7 +495,7 @@ fn do_retry_with_no_persist(confirm_before_reload: bool) {
	let bs_htlc_claim_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
	assert_eq!(bs_htlc_claim_txn.len(), 1);
	check_spends!(bs_htlc_claim_txn[0], as_commitment_tx);
	expect_payment_forwarded!(nodes[1], None, false);
	expect_payment_forwarded!(nodes[1], nodes[0], None, false);

	if !confirm_before_reload {
 mine_transaction(&nodes[0], &as_commitment_tx);
Expand Down

2 changes: 1 addition & 1 deletion
lightning/src/ln/reorg_tests.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -138,7 +138,7 @@ fn do_test_onchain_htlc_reorg(local_commitment: bool, claim: bool) {
 // ChannelManager only polls chain::Watch::release_pending_monitor_events when we
 // probe it for events, so we probe non-message events here (which should just be the
 // PaymentForwarded event).
 expect_payment_forwarded!(nodes[1], Some(1000), true);
 expect_payment_forwarded!(nodes[1], nodes[0], Some(1000), true);
	} else {
 // Confirm the timeout tx and check that we fail the HTLC backwards
 let block = Block {
Expand Down

4 changes: 2 additions & 2 deletions
lightning/src/ln/shutdown_tests.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -110,7 +110,7 @@ fn updates_shutdown_wait() {
	assert!(updates.update_fee.is_none());
	assert_eq!(updates.update_fulfill_htlcs.len(), 1);
	nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
	expect_payment_forwarded!(nodes[1], Some(1000), false);
	expect_payment_forwarded!(nodes[1], nodes[0], Some(1000), false);
	check_added_monitors!(nodes[1], 1);
	let updates_2 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
	commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, false);
Expand DownExpand Up@@ -279,7 +279,7 @@ fn do_test_shutdown_rebroadcast(recv_count: u8) {
	assert!(updates.update_fee.is_none());
	assert_eq!(updates.update_fulfill_htlcs.len(), 1);
	nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
	expect_payment_forwarded!(nodes[1], Some(1000), false);
	expect_payment_forwarded!(nodes[1], nodes[0], Some(1000), false);
	check_added_monitors!(nodes[1], 1);
	let updates_2 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
	commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, false);
Expand Down

10 changes: 8 additions & 2 deletions
lightning/src/util/events.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -343,6 +343,9 @@ pub enum Event {
	/// This event is generated when a payment has been successfully forwarded through us and a
	/// forwarding fee earned.
	PaymentForwarded {
 /// The channel between the source node and us. Optional because versions prior to 0.0.107
 /// do not serialize this field.
 source_channel_id: Option<[u8; 32]>,
 /// The 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
Expand DownExpand Up@@ -520,10 +523,11 @@ impl Writeable for Event {
 (0, VecWriteWrapper(outputs), required),
 });
 },
 &Event::PaymentForwarded { fee_earned_msat, claim_from_onchain_tx } => {
 &Event::PaymentForwarded { fee_earned_msat, source_channel_id, claim_from_onchain_tx } => {
 7u8.write(writer)?;
 write_tlv_fields!(writer, {
 (0, fee_earned_msat, option),
 (1, source_channel_id, option),
 (2, claim_from_onchain_tx, required),
 });
 },
Expand DownExpand Up@@ -684,12 +688,14 @@ impl MaybeReadable for Event {
 7u8 => {
 let f = || {
 let mut fee_earned_msat = None;
 let mut source_channel_id = None;
 let mut claim_from_onchain_tx = false;
 read_tlv_fields!(reader, {
 (0, fee_earned_msat, option),
 (1, source_channel_id, option),
 (2, claim_from_onchain_tx, required),
 });
 Ok(Some(Event::PaymentForwarded { fee_earned_msat, claim_from_onchain_tx }))
 Ok(Some(Event::PaymentForwarded { fee_earned_msat, source_channel_id, claim_from_onchain_tx }))
 };
 f()
 },
Expand Down