← Watch feed
Replace `get_closing_signed_broadcast!` macro with direct function calls
Public commit record
65/100 · Adequate
What the developer wrote
Authored by elnosh
Replace `get_closing_signed_broadcast!` macro with direct function calls
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
✓ Specific, descriptive subject✓ Names a concrete action or component✓ Provides an explanatory body
What changed, and why it matters
This commit is a straightforward code cleanup in the project's test suite. It replaces a Rust macro used only in tests with an equivalent regular function. There is no change to the actual Lightning node logic that runs in production, and no security-relevant behavior is altered.
Recommended action
No security action required. Treat as normal refactoring/test-maintenance commit.
Security signals we found
No strong security signals were identified.
Evidence from the diff
The change refactors get_closing_signed_broadcast!, a test-only macro in lightning/src/ln/functional_test_utils.rs, into a public function get_closing_signed_broadcast. Call sites in five test files are updated from macro syntax (get_closing_signed_broadcast!(...)) to function-call syntax (get_closing_signed_broadcast(...)). The function body is identical to the macro expansion: it retrieves pending message events, asserts on the count, returns the BroadcastChannelUpdate event and optionally a SendClosingSigned event. No production code paths are modified.
Changed components
lightning/src/ln/functional_test_utils.rslightning/src/ln/async_signer_tests.rslightning/src/ln/chanmon_update_fail_tests.rslightning/src/ln/monitor_tests.rslightning/src/ln/shutdown_tests.rsInspect captured patch +55 / −57
diff --git a/lightning/src/ln/async_signer_tests.rs b/lightning/src/ln/async_signer_tests.rs
index f34a2b3..d8dc22c 100644
--- a/lightning/src/ln/async_signer_tests.rs
+++ b/lightning/src/ln/async_signer_tests.rs
@@ -1308,9 +1308,9 @@ fn do_test_closing_signed(extra_closing_signed: bool, reconnect: bool) {
}
nodes[0].node.signer_unblocked(None);
- let (_, node_0_2nd_closing_signed) = get_closing_signed_broadcast!(nodes[0].node, node_b_id);
+ let (_, node_0_2nd_closing_signed) = get_closing_signed_broadcast(&nodes[0], node_b_id);
nodes[1].node.handle_closing_signed(node_a_id, &node_0_2nd_closing_signed.unwrap());
- let (_, node_1_closing_signed) = get_closing_signed_broadcast!(nodes[1].node, node_a_id);
+ let (_, node_1_closing_signed) = get_closing_signed_broadcast(&nodes[1], node_a_id);
assert!(node_1_closing_signed.is_none());
assert!(nodes[0].node.list_channels().is_empty());
diff --git a/lightning/src/ln/chanmon_update_fail_tests.rs b/lightning/src/ln/chanmon_update_fail_tests.rs
index bcdc5b6..5e544c7 100644
--- a/lightning/src/ln/chanmon_update_fail_tests.rs
+++ b/lightning/src/ln/chanmon_update_fail_tests.rs
@@ -3048,11 +3048,11 @@ fn test_temporary_error_during_shutdown() {
node_b_id,
&get_event_msg!(nodes[1], MessageSendEvent::SendClosingSigned, node_a_id),
);
- let (_, closing_signed_a) = get_closing_signed_broadcast!(nodes[0].node, node_b_id);
+ let (_, closing_signed_a) = get_closing_signed_broadcast(&nodes[0], node_b_id);
let txn_a = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
nodes[1].node.handle_closing_signed(node_a_id, &closing_signed_a.unwrap());
- let (_, none_b) = get_closing_signed_broadcast!(nodes[1].node, node_a_id);
+ let (_, none_b) = get_closing_signed_broadcast(&nodes[1], node_a_id);
assert!(none_b.is_none());
let txn_b = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
diff --git a/lightning/src/ln/functional_test_utils.rs b/lightning/src/ln/functional_test_utils.rs
index ed74b39..45cab14 100644
--- a/lightning/src/ln/functional_test_utils.rs
+++ b/lightning/src/ln/functional_test_utils.rs
@@ -2210,31 +2210,31 @@ macro_rules! check_spends {
}
}
-macro_rules! get_closing_signed_broadcast {
- ($node: expr, $dest_pubkey: expr) => {{
- let events = $node.get_and_clear_pending_msg_events();
- assert!(events.len() == 1 || events.len() == 2);
- (
- match events[events.len() - 1] {
- MessageSendEvent::BroadcastChannelUpdate { ref msg, .. } => {
- assert_eq!(msg.contents.channel_flags & 2, 2);
- msg.clone()
+pub fn get_closing_signed_broadcast(
+ node: &Node, dest_pubkey: PublicKey,
+) -> (msgs::ChannelUpdate, Option<msgs::ClosingSigned>) {
+ let events = node.node.get_and_clear_pending_msg_events();
+ assert!(events.len() == 1 || events.len() == 2);
+ (
+ match events[events.len() - 1] {
+ MessageSendEvent::BroadcastChannelUpdate { ref msg, .. } => {
+ assert_eq!(msg.contents.channel_flags & 2, 2);
+ msg.clone()
+ },
+ _ => panic!("Unexpected event"),
+ },
+ if events.len() == 2 {
+ match events[0] {
+ MessageSendEvent::SendClosingSigned { ref node_id, ref msg } => {
+ assert_eq!(*node_id, dest_pubkey);
+ Some(msg.clone())
},
_ => panic!("Unexpected event"),
- },
- if events.len() == 2 {
- match events[0] {
- MessageSendEvent::SendClosingSigned { ref node_id, ref msg } => {
- assert_eq!(*node_id, $dest_pubkey);
- Some(msg.clone())
- },
- _ => panic!("Unexpected event"),
- }
- } else {
- None
- },
- )
- }};
+ }
+ } else {
+ None
+ },
+ )
}
#[cfg(test)]
@@ -2519,10 +2519,10 @@ pub fn close_channel<'a, 'b, 'c>(
assert_eq!(broadcaster_b.txn_broadcasted.lock().unwrap().len(), 1);
tx_b = broadcaster_b.txn_broadcasted.lock().unwrap().remove(0);
let (bs_update, closing_signed_b) =
- get_closing_signed_broadcast!(node_b, node_a.get_our_node_id());
+ get_closing_signed_broadcast(struct_b, node_a.get_our_node_id());
node_a.handle_closing_signed(node_b.get_our_node_id(), &closing_signed_b.unwrap());
- let (as_update, none_a) = get_closing_signed_broadcast!(node_a, node_b.get_our_node_id());
+ let (as_update, none_a) = get_closing_signed_broadcast(struct_a, node_b.get_our_node_id());
assert!(none_a.is_none());
assert_eq!(broadcaster_a.txn_broadcasted.lock().unwrap().len(), 1);
tx_a = broadcaster_a.txn_broadcasted.lock().unwrap().remove(0);
@@ -2539,10 +2539,10 @@ pub fn close_channel<'a, 'b, 'c>(
assert_eq!(broadcaster_a.txn_broadcasted.lock().unwrap().len(), 1);
tx_a = broadcaster_a.txn_broadcasted.lock().unwrap().remove(0);
let (as_update, closing_signed_a) =
- get_closing_signed_broadcast!(node_a, node_b.get_our_node_id());
+ get_closing_signed_broadcast(struct_a, node_b.get_our_node_id());
node_b.handle_closing_signed(node_a.get_our_node_id(), &closing_signed_a.unwrap());
- let (bs_update, none_b) = get_closing_signed_broadcast!(node_b, node_a.get_our_node_id());
+ let (bs_update, none_b) = get_closing_signed_broadcast(struct_b, node_a.get_our_node_id());
assert!(none_b.is_none());
assert_eq!(broadcaster_b.txn_broadcasted.lock().unwrap().len(), 1);
tx_b = broadcaster_b.txn_broadcasted.lock().unwrap().remove(0);
diff --git a/lightning/src/ln/monitor_tests.rs b/lightning/src/ln/monitor_tests.rs
index 05bc85c..1574458 100644
--- a/lightning/src/ln/monitor_tests.rs
+++ b/lightning/src/ln/monitor_tests.rs
@@ -369,9 +369,9 @@ fn do_chanmon_claim_value_coop_close(keyed_anchors: bool, p2a_anchor: bool) {
nodes[1].node.handle_closing_signed(nodes[0].node.get_our_node_id(), &node_0_closing_signed);
let node_1_closing_signed = get_event_msg!(nodes[1], MessageSendEvent::SendClosingSigned, nodes[0].node.get_our_node_id());
nodes[0].node.handle_closing_signed(nodes[1].node.get_our_node_id(), &node_1_closing_signed);
- let (_, node_0_2nd_closing_signed) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
+ let (_, node_0_2nd_closing_signed) = get_closing_signed_broadcast(&nodes[0], nodes[1].node.get_our_node_id());
nodes[1].node.handle_closing_signed(nodes[0].node.get_our_node_id(), &node_0_2nd_closing_signed.unwrap());
- let (_, node_1_none) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
+ let (_, node_1_none) = get_closing_signed_broadcast(&nodes[1], nodes[0].node.get_our_node_id());
assert!(node_1_none.is_none());
let shutdown_tx = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
diff --git a/lightning/src/ln/shutdown_tests.rs b/lightning/src/ln/shutdown_tests.rs
index 58c90b8..474b422 100644
--- a/lightning/src/ln/shutdown_tests.rs
+++ b/lightning/src/ln/shutdown_tests.rs
@@ -71,9 +71,9 @@ fn pre_funding_lock_shutdown_test() {
let node_1_closing_signed =
get_event_msg!(nodes[1], MessageSendEvent::SendClosingSigned, node_a_id);
nodes[0].node.handle_closing_signed(node_b_id, &node_1_closing_signed);
- let (_, node_0_2nd_closing_signed) = get_closing_signed_broadcast!(nodes[0].node, node_b_id);
+ let (_, node_0_2nd_closing_signed) = get_closing_signed_broadcast(&nodes[0], node_b_id);
nodes[1].node.handle_closing_signed(node_a_id, &node_0_2nd_closing_signed.unwrap());
- let (_, node_1_none) = get_closing_signed_broadcast!(nodes[1].node, node_a_id);
+ let (_, node_1_none) = get_closing_signed_broadcast(&nodes[1], node_a_id);
assert!(node_1_none.is_none());
assert!(nodes[0].node.list_channels().is_empty());
@@ -122,9 +122,9 @@ fn expect_channel_shutdown_state() {
let node_1_closing_signed =
get_event_msg!(nodes[1], MessageSendEvent::SendClosingSigned, node_a_id);
nodes[0].node.handle_closing_signed(node_b_id, &node_1_closing_signed);
- let (_, node_0_2nd_closing_signed) = get_closing_signed_broadcast!(nodes[0].node, node_b_id);
+ let (_, node_0_2nd_closing_signed) = get_closing_signed_broadcast(&nodes[0], node_b_id);
nodes[1].node.handle_closing_signed(node_a_id, &node_0_2nd_closing_signed.unwrap());
- let (_, node_1_none) = get_closing_signed_broadcast!(nodes[1].node, node_a_id);
+ let (_, node_1_none) = get_closing_signed_broadcast(&nodes[1], node_a_id);
assert!(node_1_none.is_none());
assert!(nodes[0].node.list_channels().is_empty());
@@ -216,9 +216,9 @@ fn expect_channel_shutdown_state_with_htlc() {
let node_1_closing_signed =
get_event_msg!(nodes[1], MessageSendEvent::SendClosingSigned, node_a_id);
nodes[0].node.handle_closing_signed(node_b_id, &node_1_closing_signed);
- let (_, node_0_2nd_closing_signed) = get_closing_signed_broadcast!(nodes[0].node, node_b_id);
+ let (_, node_0_2nd_closing_signed) = get_closing_signed_broadcast(&nodes[0], node_b_id);
nodes[1].node.handle_closing_signed(node_a_id, &node_0_2nd_closing_signed.unwrap());
- let (_, node_1_none) = get_closing_signed_broadcast!(nodes[1].node, node_a_id);
+ let (_, node_1_none) = get_closing_signed_broadcast(&nodes[1], node_a_id);
assert!(node_1_none.is_none());
let reason_a = ClosureReason::LocallyInitiatedCooperativeClosure;
check_closed_event(&nodes[0], 1, reason_a, &[node_b_id], 100000);
@@ -284,9 +284,9 @@ fn test_lnd_bug_6039() {
let node_1_closing_signed =
get_event_msg!(nodes[1], MessageSendEvent::SendClosingSigned, node_a_id);
nodes[0].node.handle_closing_signed(node_b_id, &node_1_closing_signed);
- let (_, node_0_2nd_closing_signed) = get_closing_signed_broadcast!(nodes[0].node, node_b_id);
+ let (_, node_0_2nd_closing_signed) = get_closing_signed_broadcast(&nodes[0], node_b_id);
nodes[1].node.handle_closing_signed(node_a_id, &node_0_2nd_closing_signed.unwrap());
- let (_, node_1_none) = get_closing_signed_broadcast!(nodes[1].node, node_a_id);
+ let (_, node_1_none) = get_closing_signed_broadcast(&nodes[1], node_a_id);
assert!(node_1_none.is_none());
let reason_a = ClosureReason::LocallyInitiatedCooperativeClosure;
@@ -483,9 +483,9 @@ fn updates_shutdown_wait() {
let node_1_closing_signed =
get_event_msg!(nodes[1], MessageSendEvent::SendClosingSigned, node_a_id);
nodes[0].node.handle_closing_signed(node_b_id, &node_1_closing_signed);
- let (_, node_0_2nd_closing_signed) = get_closing_signed_broadcast!(nodes[0].node, node_b_id);
+ let (_, node_0_2nd_closing_signed) = get_closing_signed_broadcast(&nodes[0], node_b_id);
nodes[1].node.handle_closing_signed(node_a_id, &node_0_2nd_closing_signed.unwrap());
- let (_, node_1_none) = get_closing_signed_broadcast!(nodes[1].node, node_a_id);
+ let (_, node_1_none) = get_closing_signed_broadcast(&nodes[1], node_a_id);
assert!(node_1_none.is_none());
let reason_a = ClosureReason::LocallyInitiatedCooperativeClosure;
@@ -618,9 +618,9 @@ fn do_htlc_fail_async_shutdown(blinded_recipient: bool) {
let node_1_closing_signed =
get_event_msg!(nodes[1], MessageSendEvent::SendClosingSigned, node_a_id);
nodes[0].node.handle_closing_signed(node_b_id, &node_1_closing_signed);
- let (_, node_0_2nd_closing_signed) = get_closing_signed_broadcast!(nodes[0].node, node_b_id);
+ let (_, node_0_2nd_closing_signed) = get_closing_signed_broadcast(&nodes[0], node_b_id);
nodes[1].node.handle_closing_signed(node_a_id, &node_0_2nd_closing_signed.unwrap());
- let (_, node_1_none) = get_closing_signed_broadcast!(nodes[1].node, node_a_id);
+ let (_, node_1_none) = get_closing_signed_broadcast(&nodes[1], node_a_id);
assert!(node_1_none.is_none());
assert!(nodes[0].node.list_channels().is_empty());
@@ -750,8 +750,7 @@ fn do_test_shutdown_rebroadcast(recv_count: u8) {
let node_1_closing_signed =
get_event_msg!(nodes[1], MessageSendEvent::SendClosingSigned, node_a_id);
nodes[0].node.handle_closing_signed(node_b_id, &node_1_closing_signed);
- let (_, node_0_2nd_closing_signed) =
- get_closing_signed_broadcast!(nodes[0].node, node_b_id);
+ let (_, node_0_2nd_closing_signed) = get_closing_signed_broadcast(&nodes[0], node_b_id);
assert!(node_0_2nd_closing_signed.is_some());
}
@@ -799,10 +798,9 @@ fn do_test_shutdown_rebroadcast(recv_count: u8) {
let node_1_closing_signed =
get_event_msg!(nodes[1], MessageSendEvent::SendClosingSigned, node_a_id);
nodes[0].node.handle_closing_signed(node_b_id, &node_1_closing_signed);
- let (_, node_0_2nd_closing_signed) =
- get_closing_signed_broadcast!(nodes[0].node, node_b_id);
+ let (_, node_0_2nd_closing_signed) = get_closing_signed_broadcast(&nodes[0], node_b_id);
nodes[1].node.handle_closing_signed(node_a_id, &node_0_2nd_closing_signed.unwrap());
- let (_, node_1_none) = get_closing_signed_broadcast!(nodes[1].node, node_a_id);
+ let (_, node_1_none) = get_closing_signed_broadcast(&nodes[1], node_a_id);
assert!(node_1_none.is_none());
let reason = ClosureReason::LocallyInitiatedCooperativeClosure;
check_closed_event(&nodes[1], 1, reason, &[node_a_id], 100000);
@@ -1388,7 +1386,7 @@ fn do_test_closing_signed_reinit_timeout(timeout_step: TimeoutStep) {
let node_1_closing_signed =
get_event_msg!(nodes[1], MessageSendEvent::SendClosingSigned, node_a_id);
nodes[0].node.handle_closing_signed(node_b_id, &node_1_closing_signed);
- let node_0_2nd_closing_signed = get_closing_signed_broadcast!(nodes[0].node, node_b_id);
+ let node_0_2nd_closing_signed = get_closing_signed_broadcast(&nodes[0], node_b_id);
if timeout_step == TimeoutStep::NoTimeout {
nodes[1].node.handle_closing_signed(node_a_id, &node_0_2nd_closing_signed.1.unwrap());
let reason_b = ClosureReason::CounterpartyInitiatedCooperativeClosure;
@@ -1480,11 +1478,11 @@ fn do_simple_legacy_shutdown_test(high_initiator_fee: bool) {
}
nodes[1].node.handle_closing_signed(node_a_id, &node_0_closing_signed);
- let (_, mut node_1_closing_signed) = get_closing_signed_broadcast!(nodes[1].node, node_a_id);
+ let (_, mut node_1_closing_signed) = get_closing_signed_broadcast(&nodes[1], node_a_id);
node_1_closing_signed.as_mut().unwrap().fee_range = None;
nodes[0].node.handle_closing_signed(node_b_id, &node_1_closing_signed.unwrap());
- let (_, node_0_none) = get_closing_signed_broadcast!(nodes[0].node, node_b_id);
+ let (_, node_0_none) = get_closing_signed_broadcast(&nodes[0], node_b_id);
assert!(node_0_none.is_none());
let reason_a = ClosureReason::LocallyInitiatedCooperativeClosure;
check_closed_event(&nodes[0], 1, reason_a, &[node_b_id], 100000);
@@ -1528,7 +1526,7 @@ fn simple_target_feerate_shutdown() {
let node_0_closing_signed =
get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, node_b_id);
nodes[1].node.handle_closing_signed(node_a_id, &node_0_closing_signed);
- let (_, node_1_closing_signed_opt) = get_closing_signed_broadcast!(nodes[1].node, node_a_id);
+ let (_, node_1_closing_signed_opt) = get_closing_signed_broadcast(&nodes[1], node_a_id);
let node_1_closing_signed = node_1_closing_signed_opt.unwrap();
// nodes[1] was passed a target which was larger than the current channel feerate, which it
@@ -1558,7 +1556,7 @@ fn simple_target_feerate_shutdown() {
assert_eq!(node_0_closing_signed.fee_satoshis, node_1_closing_signed.fee_satoshis);
nodes[0].node.handle_closing_signed(node_b_id, &node_1_closing_signed);
- let (_, node_0_none) = get_closing_signed_broadcast!(nodes[0].node, node_b_id);
+ let (_, node_0_none) = get_closing_signed_broadcast(&nodes[0], node_b_id);
assert!(node_0_none.is_none());
let reason_a = ClosureReason::LocallyInitiatedCooperativeClosure;
check_closed_event(&nodes[0], 1, reason_a, &[node_b_id], 100000);
@@ -1660,9 +1658,9 @@ fn do_outbound_update_no_early_closing_signed(use_htlc: bool) {
let bs_closing_signed =
get_event_msg!(nodes[1], MessageSendEvent::SendClosingSigned, node_a_id);
nodes[0].node.handle_closing_signed(node_b_id, &bs_closing_signed);
- let (_, as_2nd_closing_signed) = get_closing_signed_broadcast!(nodes[0].node, node_b_id);
+ let (_, as_2nd_closing_signed) = get_closing_signed_broadcast(&nodes[0], node_b_id);
nodes[1].node.handle_closing_signed(node_a_id, &as_2nd_closing_signed.unwrap());
- let (_, node_1_none) = get_closing_signed_broadcast!(nodes[1].node, node_a_id);
+ let (_, node_1_none) = get_closing_signed_broadcast(&nodes[1], node_a_id);
assert!(node_1_none.is_none());
let reason_a = ClosureReason::LocallyInitiatedCooperativeClosure;
Risk score
Our methodology →Why this scored 15/100
Human-validated context
Community notes
Notes can correct, qualify, or add evidence to the AI analysis. Every note shown here has been validated by a human moderator.
No validated notes yet.
The AI analysis stands alone for now. Submit a note if you can add evidence or important context.