Skip to content

Breakup CooperativeClosure into Local/Remote initiated#2863

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
TheBlueMatt merged 2 commits into from
Feb 5, 2024
Merged

Breakup CooperativeClosure into Local/Remote initiated #2863

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
58f7942
Breakup CooperativeClosure into Local/Remote initiated
benthecarman Jan 31, 2024
efcb5d9
Rename old CooperativeClosure to LegacyCooperativeClosure
benthecarman Feb 4, 2024
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
21 changes: 16 additions & 5 deletions lightning/src/events/mod.rs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -184,8 +184,15 @@ pub enum ClosureReason {
HolderForceClosed,
/// The channel was closed after negotiating a cooperative close and we've now broadcasted
/// the cooperative close transaction. Note the shutdown may have been initiated by us.
//TODO: split between CounterpartyInitiated/LocallyInitiated
CooperativeClosure,
// Can be removed once we disallow downgrading to 0.0.121
LegacyCooperativeClosure,
Comment thread
benthecarman marked this conversation as resolved.
/// The channel was closed after negotiating a cooperative close and we've now broadcasted
/// the cooperative close transaction. This indicates that the shutdown was initiated by our
/// counterparty.

@TheBlueMattTheBlueMattFeb 5, 2024

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Suggested change
/// counterparty.
/// counterparty.
///
/// In rare cases where we sent our peer a `shutdown`, crashed, then restarted this reason may be given even though we initiated the shutdown.

CounterpartyInitiatedCooperativeClosure,
/// The channel was closed after negotiating a cooperative close and we've now broadcasted
/// the cooperative close transaction. This indicates that the shutdown was initiated by us.
LocallyInitiatedCooperativeClosure,
/// A commitment transaction was confirmed on chain, closing the channel. Most likely this
/// commitment transaction came from our counterparty, but it may also have come from
/// a copy of our own `ChannelMonitor`.
Expand DownExpand Up@@ -230,7 +237,9 @@ impl core::fmt::Display for ClosureReason {
f.write_fmt(format_args!("counterparty force-closed with message: {}", peer_msg))
},
ClosureReason::HolderForceClosed => f.write_str("user manually force-closed the channel"),
ClosureReason::CooperativeClosure => f.write_str("the channel was cooperatively closed"),
ClosureReason::LegacyCooperativeClosure => f.write_str("the channel was cooperatively closed"),
ClosureReason::CounterpartyInitiatedCooperativeClosure => f.write_str("the channel was cooperatively closed by our peer"),
ClosureReason::LocallyInitiatedCooperativeClosure => f.write_str("the channel was cooperatively closed by us"),
ClosureReason::CommitmentTxConfirmed => f.write_str("commitment or closing transaction was confirmed on chain."),
ClosureReason::FundingTimedOut => write!(f, "funding transaction failed to confirm within {} blocks", FUNDING_CONF_DEADLINE_BLOCKS),
ClosureReason::ProcessingError { err } => {
Expand All@@ -250,12 +259,14 @@ impl_writeable_tlv_based_enum_upgradable!(ClosureReason,
(1, FundingTimedOut) => {},
(2, HolderForceClosed) => {},
(6, CommitmentTxConfirmed) => {},
(4, CooperativeClosure) => {},
(4, LegacyCooperativeClosure) => {},
Comment on lines 261 to +262

@shaavanshaavanFeb 1, 2024

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Unrelated nit:

Since we are touching these lines, should we think about reordering these enums? I think it's pretty odd to write 6th before 4th.

Suggested change
(6,CommitmentTxConfirmed) => {},
(4,CooperativeClosure) => {},
(4,LegacyCooperativeClosure) => {},
(4,LegacyCooperativeClosure) => {},
(6,CommitmentTxConfirmed) => {},

(8, ProcessingError) => { (1, err, required) },
(10, DisconnectedPeer) => {},
(12, OutdatedChannelManager) => {},
(13, CounterpartyCoopClosedUnfundedChannel) => {},
(15, FundingBatchClosure) => {}
(15, FundingBatchClosure) => {},
(17, CounterpartyInitiatedCooperativeClosure) => {},
(19, LocallyInitiatedCooperativeClosure) => {},
);

/// Intended destination of a failed HTLC as indicated in [`Event::HTLCHandlingFailed`].
Expand Down
8 changes: 4 additions & 4 deletions lightning/src/ln/chanmon_update_fail_tests.rs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -1955,8 +1955,8 @@ fn do_during_funding_monitor_fail(confirm_a_first: bool, restore_b_before_conf:

send_payment(&nodes[0], &[&nodes[1]], 8000000);
close_channel(&nodes[0], &nodes[1], &channel_id, funding_tx, true);
check_closed_event!(nodes[0], 1, ClosureReason::CooperativeClosure, [nodes[1].node.get_our_node_id()], 100000);
check_closed_event!(nodes[1], 1, ClosureReason::CooperativeClosure, [nodes[0].node.get_our_node_id()], 100000);
check_closed_event!(nodes[0], 1, ClosureReason::CounterpartyInitiatedCooperativeClosure, [nodes[1].node.get_our_node_id()], 100000);
check_closed_event!(nodes[1], 1, ClosureReason::LocallyInitiatedCooperativeClosure, [nodes[0].node.get_our_node_id()], 100000);
}

#[test]
Expand DownExpand Up@@ -2634,8 +2634,8 @@ fn test_temporary_error_during_shutdown() {
assert_eq!(txn_a, txn_b);
assert_eq!(txn_a.len(), 1);
check_spends!(txn_a[0], funding_tx);
check_closed_event!(nodes[1], 1, ClosureReason::CooperativeClosure, [nodes[0].node.get_our_node_id()], 100000);
check_closed_event!(nodes[0], 1, ClosureReason::CooperativeClosure, [nodes[1].node.get_our_node_id()], 100000);
check_closed_event!(nodes[1], 1, ClosureReason::CounterpartyInitiatedCooperativeClosure, [nodes[0].node.get_our_node_id()], 100000);
check_closed_event!(nodes[0], 1, ClosureReason::LocallyInitiatedCooperativeClosure, [nodes[1].node.get_our_node_id()], 100000);
}

#[test]
Expand Down
28 changes: 26 additions & 2 deletions lightning/src/ln/channel.rs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -1256,6 +1256,9 @@ pub(super) struct ChannelContext<SP: Deref> where SP::Target: SignerProvider {
// We track whether we already emitted a `ChannelReady` event.
channel_ready_event_emitted: bool,

/// Some if we initiated to shut down the channel.
local_initiated_shutdown: Option<()>,

/// The unique identifier used to re-derive the private key material for the channel through
/// [`SignerProvider::derive_channel_signer`].
channel_keys_id: [u8; 32],
Expand DownExpand Up@@ -4959,11 +4962,17 @@ impl<SP: Deref> Channel<SP> where
}
}

let closure_reason = if self.initiated_shutdown() {
ClosureReason::LocallyInitiatedCooperativeClosure
} else {
ClosureReason::CounterpartyInitiatedCooperativeClosure
};

assert!(self.context.shutdown_scriptpubkey.is_some());
if let Some((last_fee, sig)) = self.context.last_sent_closing_fee {
if last_fee == msg.fee_satoshis {
let shutdown_result = ShutdownResult {
closure_reason: ClosureReason::CooperativeClosure,
closure_reason,
monitor_update: None,
dropped_outbound_htlcs: Vec::new(),
unbroadcasted_batch_funding_txid: self.context.unbroadcasted_batch_funding_txid(),
Expand DownExpand Up@@ -4998,7 +5007,7 @@ impl<SP: Deref> Channel<SP> where
.map_err(|_| ChannelError::Close("External signer refused to sign closing transaction".to_owned()))?;
let (signed_tx, shutdown_result) = if $new_fee == msg.fee_satoshis {
let shutdown_result = ShutdownResult {
closure_reason: ClosureReason::CooperativeClosure,
closure_reason,
monitor_update: None,
dropped_outbound_htlcs: Vec::new(),
unbroadcasted_batch_funding_txid: self.context.unbroadcasted_batch_funding_txid(),
Expand DownExpand Up@@ -5263,6 +5272,11 @@ impl<SP: Deref> Channel<SP> where
self.context.channel_state.is_local_shutdown_sent()
}

/// Returns true if we initiated to shut down the channel.
pub fn initiated_shutdown(&self) -> bool {
self.context.local_initiated_shutdown.is_some()
}

/// Returns true if this channel is fully shut down. True here implies that no further actions
/// may/will be taken on this channel, and thus this object should be freed. Any future changes
/// will be handled appropriately by the chain monitor.
Expand DownExpand Up@@ -6177,6 +6191,7 @@ impl<SP: Deref> Channel<SP> where
// From here on out, we may not fail!
self.context.target_closing_feerate_sats_per_kw = target_feerate_sats_per_kw;
self.context.channel_state.set_local_shutdown_sent();
self.context.local_initiated_shutdown = Some(());
self.context.update_time_counter += 1;

let monitor_update = if update_shutdown_script {
Expand DownExpand Up@@ -6437,6 +6452,7 @@ impl<SP: Deref> OutboundV1Channel<SP> where SP::Target: SignerProvider {
channel_keys_id,

blocked_monitor_updates: Vec::new(),
local_initiated_shutdown: None,
},
unfunded_context: UnfundedChannelContext { unfunded_channel_age_ticks: 0 }
})
Expand DownExpand Up@@ -7237,6 +7253,8 @@ impl<SP: Deref> InboundV1Channel<SP> where SP::Target: SignerProvider {
channel_type,
channel_keys_id,

local_initiated_shutdown: None,

blocked_monitor_updates: Vec::new(),
},
unfunded_context: UnfundedChannelContext { unfunded_channel_age_ticks: 0 }
Expand DownExpand Up@@ -7811,6 +7829,7 @@ impl<SP: Deref> Writeable for Channel<SP> where SP::Target: SignerProvider {
(39, pending_outbound_blinding_points, optional_vec),
(41, holding_cell_blinding_points, optional_vec),
(43, malformed_htlcs, optional_vec), // Added in 0.0.119
(45, self.context.local_initiated_shutdown, option), // Added in 0.0.122
});

Ok(())
Expand DownExpand Up@@ -8098,6 +8117,8 @@ impl<'a, 'b, 'c, ES: Deref, SP: Deref> ReadableArgs<(&'a ES, &'b SP, u32, &'c Ch

let mut is_batch_funding: Option<()> = None;

let mut local_initiated_shutdown: Option<()> = None;

let mut pending_outbound_blinding_points_opt: Option<Vec<Option<PublicKey>>> = None;
let mut holding_cell_blinding_points_opt: Option<Vec<Option<PublicKey>>> = None;

Expand DownExpand Up@@ -8132,6 +8153,7 @@ impl<'a, 'b, 'c, ES: Deref, SP: Deref> ReadableArgs<(&'a ES, &'b SP, u32, &'c Ch
(39, pending_outbound_blinding_points_opt, optional_vec),
(41, holding_cell_blinding_points_opt, optional_vec),
(43, malformed_htlcs, optional_vec), // Added in 0.0.119
(45, local_initiated_shutdown, option),
});

let (channel_keys_id, holder_signer) = if let Some(channel_keys_id) = channel_keys_id {
Expand DownExpand Up@@ -8362,6 +8384,8 @@ impl<'a, 'b, 'c, ES: Deref, SP: Deref> ReadableArgs<(&'a ES, &'b SP, u32, &'c Ch
channel_type: channel_type.unwrap(),
channel_keys_id,

local_initiated_shutdown,

blocked_monitor_updates: blocked_monitor_updates.unwrap(),
}
})
Expand Down
4 changes: 2 additions & 2 deletions lightning/src/ln/channelmanager.rs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -11856,8 +11856,8 @@ mod tests {
}
let (_nodes_1_update, _none) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());

check_closed_event!(nodes[0], 1, ClosureReason::CooperativeClosure, [nodes[1].node.get_our_node_id()], 1000000);
check_closed_event!(nodes[1], 1, ClosureReason::CooperativeClosure, [nodes[0].node.get_our_node_id()], 1000000);
check_closed_event!(nodes[0], 1, ClosureReason::LocallyInitiatedCooperativeClosure, [nodes[1].node.get_our_node_id()], 1000000);
check_closed_event!(nodes[1], 1, ClosureReason::CounterpartyInitiatedCooperativeClosure, [nodes[0].node.get_our_node_id()], 1000000);
}

fn check_not_connected_to_peer_error<T>(res_err: Result<T, APIError>, expected_public_key: PublicKey) {
Expand Down
28 changes: 14 additions & 14 deletions lightning/src/ln/functional_tests.rs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -871,8 +871,8 @@ fn test_update_fee_with_fundee_update_add_htlc() {
send_payment(&nodes[1], &vec!(&nodes[0])[..], 800000);
send_payment(&nodes[0], &vec!(&nodes[1])[..], 800000);
close_channel(&nodes[0], &nodes[1], &chan.2, chan.3, true);
check_closed_event!(nodes[0], 1, ClosureReason::CooperativeClosure, [nodes[1].node.get_our_node_id()], 100000);
check_closed_event!(nodes[1], 1, ClosureReason::CooperativeClosure, [nodes[0].node.get_our_node_id()], 100000);
check_closed_event!(nodes[0], 1, ClosureReason::CounterpartyInitiatedCooperativeClosure, [nodes[1].node.get_our_node_id()], 100000);
check_closed_event!(nodes[1], 1, ClosureReason::LocallyInitiatedCooperativeClosure, [nodes[0].node.get_our_node_id()], 100000);
}

#[test]
Expand DownExpand Up@@ -985,8 +985,8 @@ fn test_update_fee() {
assert_eq!(get_feerate!(nodes[0], nodes[1], channel_id), feerate + 30);
assert_eq!(get_feerate!(nodes[1], nodes[0], channel_id), feerate + 30);
close_channel(&nodes[0], &nodes[1], &chan.2, chan.3, true);
check_closed_event!(nodes[0], 1, ClosureReason::CooperativeClosure, [nodes[1].node.get_our_node_id()], 100000);
check_closed_event!(nodes[1], 1, ClosureReason::CooperativeClosure, [nodes[0].node.get_our_node_id()], 100000);
check_closed_event!(nodes[0], 1, ClosureReason::CounterpartyInitiatedCooperativeClosure, [nodes[1].node.get_our_node_id()], 100000);
check_closed_event!(nodes[1], 1, ClosureReason::LocallyInitiatedCooperativeClosure, [nodes[0].node.get_our_node_id()], 100000);
}

#[test]
Expand DownExpand Up@@ -1104,17 +1104,17 @@ fn fake_network_test() {

// Close down the channels...
close_channel(&nodes[0], &nodes[1], &chan_1.2, chan_1.3, true);
check_closed_event!(nodes[0], 1, ClosureReason::CooperativeClosure, [nodes[1].node.get_our_node_id()], 100000);
check_closed_event!(nodes[1], 1, ClosureReason::CooperativeClosure, [nodes[0].node.get_our_node_id()], 100000);
check_closed_event!(nodes[0], 1, ClosureReason::CounterpartyInitiatedCooperativeClosure, [nodes[1].node.get_our_node_id()], 100000);
check_closed_event!(nodes[1], 1, ClosureReason::LocallyInitiatedCooperativeClosure, [nodes[0].node.get_our_node_id()], 100000);
close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, false);
check_closed_event!(nodes[1], 1, ClosureReason::CooperativeClosure, [nodes[2].node.get_our_node_id()], 100000);
check_closed_event!(nodes[2], 1, ClosureReason::CooperativeClosure, [nodes[1].node.get_our_node_id()], 100000);
check_closed_event!(nodes[1], 1, ClosureReason::LocallyInitiatedCooperativeClosure, [nodes[2].node.get_our_node_id()], 100000);
check_closed_event!(nodes[2], 1, ClosureReason::CounterpartyInitiatedCooperativeClosure, [nodes[1].node.get_our_node_id()], 100000);
close_channel(&nodes[2], &nodes[3], &chan_3.2, chan_3.3, true);
check_closed_event!(nodes[2], 1, ClosureReason::CooperativeClosure, [nodes[3].node.get_our_node_id()], 100000);
check_closed_event!(nodes[3], 1, ClosureReason::CooperativeClosure, [nodes[2].node.get_our_node_id()], 100000);
check_closed_event!(nodes[2], 1, ClosureReason::CounterpartyInitiatedCooperativeClosure, [nodes[3].node.get_our_node_id()], 100000);
check_closed_event!(nodes[3], 1, ClosureReason::LocallyInitiatedCooperativeClosure, [nodes[2].node.get_our_node_id()], 100000);
close_channel(&nodes[1], &nodes[3], &chan_4.2, chan_4.3, false);
check_closed_event!(nodes[1], 1, ClosureReason::CooperativeClosure, [nodes[3].node.get_our_node_id()], 100000);
check_closed_event!(nodes[3], 1, ClosureReason::CooperativeClosure, [nodes[1].node.get_our_node_id()], 100000);
check_closed_event!(nodes[1], 1, ClosureReason::LocallyInitiatedCooperativeClosure, [nodes[3].node.get_our_node_id()], 100000);
check_closed_event!(nodes[3], 1, ClosureReason::CounterpartyInitiatedCooperativeClosure, [nodes[1].node.get_our_node_id()], 100000);
}

#[test]
Expand DownExpand Up@@ -5619,15 +5619,15 @@ fn test_static_output_closing_tx() {
let closing_tx = close_channel(&nodes[0], &nodes[1], &chan.2, chan.3, true).2;

mine_transaction(&nodes[0], &closing_tx);
check_closed_event!(nodes[0], 1, ClosureReason::CooperativeClosure, [nodes[1].node.get_our_node_id()], 100000);
check_closed_event!(nodes[0], 1, ClosureReason::CounterpartyInitiatedCooperativeClosure, [nodes[1].node.get_our_node_id()], 100000);
connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);

let spend_txn = check_spendable_outputs!(nodes[0], node_cfgs[0].keys_manager);
assert_eq!(spend_txn.len(), 1);
check_spends!(spend_txn[0], closing_tx);

mine_transaction(&nodes[1], &closing_tx);
check_closed_event!(nodes[1], 1, ClosureReason::CooperativeClosure, [nodes[0].node.get_our_node_id()], 100000);
check_closed_event!(nodes[1], 1, ClosureReason::LocallyInitiatedCooperativeClosure, [nodes[0].node.get_our_node_id()], 100000);
connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);

let spend_txn = check_spendable_outputs!(nodes[1], node_cfgs[1].keys_manager);
Expand Down
4 changes: 2 additions & 2 deletions lightning/src/ln/monitor_tests.rs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -257,8 +257,8 @@ fn do_chanmon_claim_value_coop_close(anchors: bool) {
spendable_outputs_b
);

check_closed_event!(nodes[0], 1, ClosureReason::CooperativeClosure, [nodes[1].node.get_our_node_id()], 1000000);
check_closed_event!(nodes[1], 1, ClosureReason::CooperativeClosure, [nodes[0].node.get_our_node_id()], 1000000);
check_closed_event!(nodes[0], 1, ClosureReason::LocallyInitiatedCooperativeClosure, [nodes[1].node.get_our_node_id()], 1000000);
check_closed_event!(nodes[1], 1, ClosureReason::CounterpartyInitiatedCooperativeClosure, [nodes[0].node.get_our_node_id()], 1000000);
}

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

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

TheBlueMatt
merged 2 commits into

from

Feb 5, 2024
 Merged


Breakup CooperativeClosure into Local/Remote initiated
#2863
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
58f7942

Breakup CooperativeClosure into Local/Remote initiated


benthecarman Jan 31, 2024
efcb5d9

Rename old CooperativeClosure to LegacyCooperativeClosure


benthecarman Feb 4, 2024

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


21 changes: 16 additions & 5 deletions
lightning/src/events/mod.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -184,8 +184,15 @@ pub enum ClosureReason {
	HolderForceClosed,
	/// The channel was closed after negotiating a cooperative close and we've now broadcasted
	/// the cooperative close transaction. Note the shutdown may have been initiated by us.
	//TODO: split between CounterpartyInitiated/LocallyInitiated
	CooperativeClosure,
	// Can be removed once we disallow downgrading to 0.0.121
	LegacyCooperativeClosure,
Comment thread
benthecarman marked this conversation as resolved.

	/// The channel was closed after negotiating a cooperative close and we've now broadcasted
	/// the cooperative close transaction. This indicates that the shutdown was initiated by our
	/// counterparty.
@TheBlueMattTheBlueMattFeb 5, 2024

Copy link


Copy Markdown

Collaborator
Choose a reason for hiding this comment

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


Suggested change

/// counterparty.
/// counterparty.
///
/// In rare cases where we sent our peer a `shutdown`, crashed, then restarted this reason may be given even though we initiated the shutdown.
	CounterpartyInitiatedCooperativeClosure,
	/// The channel was closed after negotiating a cooperative close and we've now broadcasted
	/// the cooperative close transaction. This indicates that the shutdown was initiated by us.
	LocallyInitiatedCooperativeClosure,
	/// A commitment transaction was confirmed on chain, closing the channel. Most likely this
	/// commitment transaction came from our counterparty, but it may also have come from
	/// a copy of our own `ChannelMonitor`.
Expand DownExpand Up@@ -230,7 +237,9 @@ impl core::fmt::Display for ClosureReason {
 f.write_fmt(format_args!("counterparty force-closed with message: {}", peer_msg))
 },
 ClosureReason::HolderForceClosed => f.write_str("user manually force-closed the channel"),
 ClosureReason::CooperativeClosure => f.write_str("the channel was cooperatively closed"),
 ClosureReason::LegacyCooperativeClosure => f.write_str("the channel was cooperatively closed"),
 ClosureReason::CounterpartyInitiatedCooperativeClosure => f.write_str("the channel was cooperatively closed by our peer"),
 ClosureReason::LocallyInitiatedCooperativeClosure => f.write_str("the channel was cooperatively closed by us"),
 ClosureReason::CommitmentTxConfirmed => f.write_str("commitment or closing transaction was confirmed on chain."),
 ClosureReason::FundingTimedOut => write!(f, "funding transaction failed to confirm within {} blocks", FUNDING_CONF_DEADLINE_BLOCKS),
 ClosureReason::ProcessingError { err } => {
Expand All@@ -250,12 +259,14 @@ impl_writeable_tlv_based_enum_upgradable!(ClosureReason,
	(1, FundingTimedOut) => {},
	(2, HolderForceClosed) => {},
	(6, CommitmentTxConfirmed) => {},
	(4, CooperativeClosure) => {},
	(4, LegacyCooperativeClosure) => {},

Comment on lines

261
 to 
+262

@shaavanshaavanFeb 1, 2024

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

Unrelated nit:
Since we are touching these lines, should we think about reordering these enums? I think it's pretty odd to write 6th before 4th.

Suggested change

(6,CommitmentTxConfirmed) => {},
(4,CooperativeClosure) => {},
(4,LegacyCooperativeClosure) => {},
(4,LegacyCooperativeClosure) => {},
(6,CommitmentTxConfirmed) => {},
	(8, ProcessingError) => { (1, err, required) },
	(10, DisconnectedPeer) => {},
	(12, OutdatedChannelManager) => {},
	(13, CounterpartyCoopClosedUnfundedChannel) => {},
	(15, FundingBatchClosure) => {}
	(15, FundingBatchClosure) => {},
	(17, CounterpartyInitiatedCooperativeClosure) => {},
	(19, LocallyInitiatedCooperativeClosure) => {},
);

/// Intended destination of a failed HTLC as indicated in [`Event::HTLCHandlingFailed`].
Expand Down

8 changes: 4 additions & 4 deletions
lightning/src/ln/chanmon_update_fail_tests.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1955,8 +1955,8 @@ fn do_during_funding_monitor_fail(confirm_a_first: bool, restore_b_before_conf:

	send_payment(&nodes[0], &[&nodes[1]], 8000000);
	close_channel(&nodes[0], &nodes[1], &channel_id, funding_tx, true);
	check_closed_event!(nodes[0], 1, ClosureReason::CooperativeClosure, [nodes[1].node.get_our_node_id()], 100000);
	check_closed_event!(nodes[1], 1, ClosureReason::CooperativeClosure, [nodes[0].node.get_our_node_id()], 100000);
	check_closed_event!(nodes[0], 1, ClosureReason::CounterpartyInitiatedCooperativeClosure, [nodes[1].node.get_our_node_id()], 100000);
	check_closed_event!(nodes[1], 1, ClosureReason::LocallyInitiatedCooperativeClosure, [nodes[0].node.get_our_node_id()], 100000);
}

#[test]
Expand DownExpand Up@@ -2634,8 +2634,8 @@ fn test_temporary_error_during_shutdown() {
	assert_eq!(txn_a, txn_b);
	assert_eq!(txn_a.len(), 1);
	check_spends!(txn_a[0], funding_tx);
	check_closed_event!(nodes[1], 1, ClosureReason::CooperativeClosure, [nodes[0].node.get_our_node_id()], 100000);
	check_closed_event!(nodes[0], 1, ClosureReason::CooperativeClosure, [nodes[1].node.get_our_node_id()], 100000);
	check_closed_event!(nodes[1], 1, ClosureReason::CounterpartyInitiatedCooperativeClosure, [nodes[0].node.get_our_node_id()], 100000);
	check_closed_event!(nodes[0], 1, ClosureReason::LocallyInitiatedCooperativeClosure, [nodes[1].node.get_our_node_id()], 100000);
}

#[test]
Expand Down

28 changes: 26 additions & 2 deletions
lightning/src/ln/channel.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1256,6 +1256,9 @@ pub(super) struct ChannelContext<SP: Deref> where SP::Target: SignerProvider {
	// We track whether we already emitted a `ChannelReady` event.
	channel_ready_event_emitted: bool,

	/// Some if we initiated to shut down the channel.
	local_initiated_shutdown: Option<()>,

	/// The unique identifier used to re-derive the private key material for the channel through
	/// [`SignerProvider::derive_channel_signer`].
	channel_keys_id: [u8; 32],
Expand DownExpand Up@@ -4959,11 +4962,17 @@ impl<SP: Deref> Channel<SP> where
 }
 }

 let closure_reason = if self.initiated_shutdown() {
 ClosureReason::LocallyInitiatedCooperativeClosure
 } else {
 ClosureReason::CounterpartyInitiatedCooperativeClosure
 };

 assert!(self.context.shutdown_scriptpubkey.is_some());
 if let Some((last_fee, sig)) = self.context.last_sent_closing_fee {
 if last_fee == msg.fee_satoshis {
 let shutdown_result = ShutdownResult {
 closure_reason: ClosureReason::CooperativeClosure,
 closure_reason,
 monitor_update: None,
 dropped_outbound_htlcs: Vec::new(),
 unbroadcasted_batch_funding_txid: self.context.unbroadcasted_batch_funding_txid(),
Expand DownExpand Up@@ -4998,7 +5007,7 @@ impl<SP: Deref> Channel<SP> where
 .map_err(|_| ChannelError::Close("External signer refused to sign closing transaction".to_owned()))?;
 let (signed_tx, shutdown_result) = if $new_fee == msg.fee_satoshis {
 let shutdown_result = ShutdownResult {
 closure_reason: ClosureReason::CooperativeClosure,
 closure_reason,
 monitor_update: None,
 dropped_outbound_htlcs: Vec::new(),
 unbroadcasted_batch_funding_txid: self.context.unbroadcasted_batch_funding_txid(),
Expand DownExpand Up@@ -5263,6 +5272,11 @@ impl<SP: Deref> Channel<SP> where
 self.context.channel_state.is_local_shutdown_sent()
	}

	/// Returns true if we initiated to shut down the channel.
	pub fn initiated_shutdown(&self) -> bool {
 self.context.local_initiated_shutdown.is_some()
	}

	/// Returns true if this channel is fully shut down. True here implies that no further actions
	/// may/will be taken on this channel, and thus this object should be freed. Any future changes
	/// will be handled appropriately by the chain monitor.
Expand DownExpand Up@@ -6177,6 +6191,7 @@ impl<SP: Deref> Channel<SP> where
 // From here on out, we may not fail!
 self.context.target_closing_feerate_sats_per_kw = target_feerate_sats_per_kw;
 self.context.channel_state.set_local_shutdown_sent();
 self.context.local_initiated_shutdown = Some(());
 self.context.update_time_counter += 1;

 let monitor_update = if update_shutdown_script {
Expand DownExpand Up@@ -6437,6 +6452,7 @@ impl<SP: Deref> OutboundV1Channel<SP> where SP::Target: SignerProvider {
 channel_keys_id,

 blocked_monitor_updates: Vec::new(),
 local_initiated_shutdown: None,
 },
 unfunded_context: UnfundedChannelContext { unfunded_channel_age_ticks: 0 }
 })
Expand DownExpand Up@@ -7237,6 +7253,8 @@ impl<SP: Deref> InboundV1Channel<SP> where SP::Target: SignerProvider {
 channel_type,
 channel_keys_id,

 local_initiated_shutdown: None,

 blocked_monitor_updates: Vec::new(),
 },
 unfunded_context: UnfundedChannelContext { unfunded_channel_age_ticks: 0 }
Expand DownExpand Up@@ -7811,6 +7829,7 @@ impl<SP: Deref> Writeable for Channel<SP> where SP::Target: SignerProvider {
 (39, pending_outbound_blinding_points, optional_vec),
 (41, holding_cell_blinding_points, optional_vec),
 (43, malformed_htlcs, optional_vec), // Added in 0.0.119
 (45, self.context.local_initiated_shutdown, option), // Added in 0.0.122
 });

 Ok(())
Expand DownExpand Up@@ -8098,6 +8117,8 @@ impl<'a, 'b, 'c, ES: Deref, SP: Deref> ReadableArgs<(&'a ES, &'b SP, u32, &'c Ch

 let mut is_batch_funding: Option<()> = None;

 let mut local_initiated_shutdown: Option<()> = None;

 let mut pending_outbound_blinding_points_opt: Option<Vec<Option<PublicKey>>> = None;
 let mut holding_cell_blinding_points_opt: Option<Vec<Option<PublicKey>>> = None;

Expand DownExpand Up@@ -8132,6 +8153,7 @@ impl<'a, 'b, 'c, ES: Deref, SP: Deref> ReadableArgs<(&'a ES, &'b SP, u32, &'c Ch
 (39, pending_outbound_blinding_points_opt, optional_vec),
 (41, holding_cell_blinding_points_opt, optional_vec),
 (43, malformed_htlcs, optional_vec), // Added in 0.0.119
 (45, local_initiated_shutdown, option),
 });

 let (channel_keys_id, holder_signer) = if let Some(channel_keys_id) = channel_keys_id {
Expand DownExpand Up@@ -8362,6 +8384,8 @@ impl<'a, 'b, 'c, ES: Deref, SP: Deref> ReadableArgs<(&'a ES, &'b SP, u32, &'c Ch
 channel_type: channel_type.unwrap(),
 channel_keys_id,

 local_initiated_shutdown,

 blocked_monitor_updates: blocked_monitor_updates.unwrap(),
 }
 })
Expand Down

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

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -11856,8 +11856,8 @@ mod tests {
 }
 let (_nodes_1_update, _none) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());

 check_closed_event!(nodes[0], 1, ClosureReason::CooperativeClosure, [nodes[1].node.get_our_node_id()], 1000000);
 check_closed_event!(nodes[1], 1, ClosureReason::CooperativeClosure, [nodes[0].node.get_our_node_id()], 1000000);
 check_closed_event!(nodes[0], 1, ClosureReason::LocallyInitiatedCooperativeClosure, [nodes[1].node.get_our_node_id()], 1000000);
 check_closed_event!(nodes[1], 1, ClosureReason::CounterpartyInitiatedCooperativeClosure, [nodes[0].node.get_our_node_id()], 1000000);
	}

	fn check_not_connected_to_peer_error<T>(res_err: Result<T, APIError>, expected_public_key: PublicKey) {
Expand Down

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

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -871,8 +871,8 @@ fn test_update_fee_with_fundee_update_add_htlc() {
	send_payment(&nodes[1], &vec!(&nodes[0])[..], 800000);
	send_payment(&nodes[0], &vec!(&nodes[1])[..], 800000);
	close_channel(&nodes[0], &nodes[1], &chan.2, chan.3, true);
	check_closed_event!(nodes[0], 1, ClosureReason::CooperativeClosure, [nodes[1].node.get_our_node_id()], 100000);
	check_closed_event!(nodes[1], 1, ClosureReason::CooperativeClosure, [nodes[0].node.get_our_node_id()], 100000);
	check_closed_event!(nodes[0], 1, ClosureReason::CounterpartyInitiatedCooperativeClosure, [nodes[1].node.get_our_node_id()], 100000);
	check_closed_event!(nodes[1], 1, ClosureReason::LocallyInitiatedCooperativeClosure, [nodes[0].node.get_our_node_id()], 100000);
}

#[test]
Expand DownExpand Up@@ -985,8 +985,8 @@ fn test_update_fee() {
	assert_eq!(get_feerate!(nodes[0], nodes[1], channel_id), feerate + 30);
	assert_eq!(get_feerate!(nodes[1], nodes[0], channel_id), feerate + 30);
	close_channel(&nodes[0], &nodes[1], &chan.2, chan.3, true);
	check_closed_event!(nodes[0], 1, ClosureReason::CooperativeClosure, [nodes[1].node.get_our_node_id()], 100000);
	check_closed_event!(nodes[1], 1, ClosureReason::CooperativeClosure, [nodes[0].node.get_our_node_id()], 100000);
	check_closed_event!(nodes[0], 1, ClosureReason::CounterpartyInitiatedCooperativeClosure, [nodes[1].node.get_our_node_id()], 100000);
	check_closed_event!(nodes[1], 1, ClosureReason::LocallyInitiatedCooperativeClosure, [nodes[0].node.get_our_node_id()], 100000);
}

#[test]
Expand DownExpand Up@@ -1104,17 +1104,17 @@ fn fake_network_test() {

	// Close down the channels...
	close_channel(&nodes[0], &nodes[1], &chan_1.2, chan_1.3, true);
	check_closed_event!(nodes[0], 1, ClosureReason::CooperativeClosure, [nodes[1].node.get_our_node_id()], 100000);
	check_closed_event!(nodes[1], 1, ClosureReason::CooperativeClosure, [nodes[0].node.get_our_node_id()], 100000);
	check_closed_event!(nodes[0], 1, ClosureReason::CounterpartyInitiatedCooperativeClosure, [nodes[1].node.get_our_node_id()], 100000);
	check_closed_event!(nodes[1], 1, ClosureReason::LocallyInitiatedCooperativeClosure, [nodes[0].node.get_our_node_id()], 100000);
	close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, false);
	check_closed_event!(nodes[1], 1, ClosureReason::CooperativeClosure, [nodes[2].node.get_our_node_id()], 100000);
	check_closed_event!(nodes[2], 1, ClosureReason::CooperativeClosure, [nodes[1].node.get_our_node_id()], 100000);
	check_closed_event!(nodes[1], 1, ClosureReason::LocallyInitiatedCooperativeClosure, [nodes[2].node.get_our_node_id()], 100000);
	check_closed_event!(nodes[2], 1, ClosureReason::CounterpartyInitiatedCooperativeClosure, [nodes[1].node.get_our_node_id()], 100000);
	close_channel(&nodes[2], &nodes[3], &chan_3.2, chan_3.3, true);
	check_closed_event!(nodes[2], 1, ClosureReason::CooperativeClosure, [nodes[3].node.get_our_node_id()], 100000);
	check_closed_event!(nodes[3], 1, ClosureReason::CooperativeClosure, [nodes[2].node.get_our_node_id()], 100000);
	check_closed_event!(nodes[2], 1, ClosureReason::CounterpartyInitiatedCooperativeClosure, [nodes[3].node.get_our_node_id()], 100000);
	check_closed_event!(nodes[3], 1, ClosureReason::LocallyInitiatedCooperativeClosure, [nodes[2].node.get_our_node_id()], 100000);
	close_channel(&nodes[1], &nodes[3], &chan_4.2, chan_4.3, false);
	check_closed_event!(nodes[1], 1, ClosureReason::CooperativeClosure, [nodes[3].node.get_our_node_id()], 100000);
	check_closed_event!(nodes[3], 1, ClosureReason::CooperativeClosure, [nodes[1].node.get_our_node_id()], 100000);
	check_closed_event!(nodes[1], 1, ClosureReason::LocallyInitiatedCooperativeClosure, [nodes[3].node.get_our_node_id()], 100000);
	check_closed_event!(nodes[3], 1, ClosureReason::CounterpartyInitiatedCooperativeClosure, [nodes[1].node.get_our_node_id()], 100000);
}

#[test]
Expand DownExpand Up@@ -5619,15 +5619,15 @@ fn test_static_output_closing_tx() {
	let closing_tx = close_channel(&nodes[0], &nodes[1], &chan.2, chan.3, true).2;

	mine_transaction(&nodes[0], &closing_tx);
	check_closed_event!(nodes[0], 1, ClosureReason::CooperativeClosure, [nodes[1].node.get_our_node_id()], 100000);
	check_closed_event!(nodes[0], 1, ClosureReason::CounterpartyInitiatedCooperativeClosure, [nodes[1].node.get_our_node_id()], 100000);
	connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);

	let spend_txn = check_spendable_outputs!(nodes[0], node_cfgs[0].keys_manager);
	assert_eq!(spend_txn.len(), 1);
	check_spends!(spend_txn[0], closing_tx);

	mine_transaction(&nodes[1], &closing_tx);
	check_closed_event!(nodes[1], 1, ClosureReason::CooperativeClosure, [nodes[0].node.get_our_node_id()], 100000);
	check_closed_event!(nodes[1], 1, ClosureReason::LocallyInitiatedCooperativeClosure, [nodes[0].node.get_our_node_id()], 100000);
	connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);

	let spend_txn = check_spendable_outputs!(nodes[1], node_cfgs[1].keys_manager);
Expand Down

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

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -257,8 +257,8 @@ fn do_chanmon_claim_value_coop_close(anchors: bool) {
 spendable_outputs_b
	);

	check_closed_event!(nodes[0], 1, ClosureReason::CooperativeClosure, [nodes[1].node.get_our_node_id()], 1000000);
	check_closed_event!(nodes[1], 1, ClosureReason::CooperativeClosure, [nodes[0].node.get_our_node_id()], 1000000);
	check_closed_event!(nodes[0], 1, ClosureReason::LocallyInitiatedCooperativeClosure, [nodes[1].node.get_our_node_id()], 1000000);
	check_closed_event!(nodes[1], 1, ClosureReason::CounterpartyInitiatedCooperativeClosure, [nodes[0].node.get_our_node_id()], 1000000);
}

#[test]
Expand Down
Loading

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

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

TheBlueMatt
merged 2 commits into

from

Feb 5, 2024
 Merged


Breakup CooperativeClosure into Local/Remote initiated
#2863
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
58f7942

Breakup CooperativeClosure into Local/Remote initiated


benthecarman Jan 31, 2024
efcb5d9

Rename old CooperativeClosure to LegacyCooperativeClosure


benthecarman Feb 4, 2024

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


21 changes: 16 additions & 5 deletions
lightning/src/events/mod.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -184,8 +184,15 @@ pub enum ClosureReason {
	HolderForceClosed,
	/// The channel was closed after negotiating a cooperative close and we've now broadcasted
	/// the cooperative close transaction. Note the shutdown may have been initiated by us.
	//TODO: split between CounterpartyInitiated/LocallyInitiated
	CooperativeClosure,
	// Can be removed once we disallow downgrading to 0.0.121
	LegacyCooperativeClosure,
Comment thread
benthecarman marked this conversation as resolved.

	/// The channel was closed after negotiating a cooperative close and we've now broadcasted
	/// the cooperative close transaction. This indicates that the shutdown was initiated by our
	/// counterparty.
@TheBlueMattTheBlueMattFeb 5, 2024

Copy link


Copy Markdown

Collaborator
Choose a reason for hiding this comment

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


Suggested change

/// counterparty.
/// counterparty.
///
/// In rare cases where we sent our peer a `shutdown`, crashed, then restarted this reason may be given even though we initiated the shutdown.
	CounterpartyInitiatedCooperativeClosure,
	/// The channel was closed after negotiating a cooperative close and we've now broadcasted
	/// the cooperative close transaction. This indicates that the shutdown was initiated by us.
	LocallyInitiatedCooperativeClosure,
	/// A commitment transaction was confirmed on chain, closing the channel. Most likely this
	/// commitment transaction came from our counterparty, but it may also have come from
	/// a copy of our own `ChannelMonitor`.
Expand DownExpand Up@@ -230,7 +237,9 @@ impl core::fmt::Display for ClosureReason {
 f.write_fmt(format_args!("counterparty force-closed with message: {}", peer_msg))
 },
 ClosureReason::HolderForceClosed => f.write_str("user manually force-closed the channel"),
 ClosureReason::CooperativeClosure => f.write_str("the channel was cooperatively closed"),
 ClosureReason::LegacyCooperativeClosure => f.write_str("the channel was cooperatively closed"),
 ClosureReason::CounterpartyInitiatedCooperativeClosure => f.write_str("the channel was cooperatively closed by our peer"),
 ClosureReason::LocallyInitiatedCooperativeClosure => f.write_str("the channel was cooperatively closed by us"),
 ClosureReason::CommitmentTxConfirmed => f.write_str("commitment or closing transaction was confirmed on chain."),
 ClosureReason::FundingTimedOut => write!(f, "funding transaction failed to confirm within {} blocks", FUNDING_CONF_DEADLINE_BLOCKS),
 ClosureReason::ProcessingError { err } => {
Expand All@@ -250,12 +259,14 @@ impl_writeable_tlv_based_enum_upgradable!(ClosureReason,
	(1, FundingTimedOut) => {},
	(2, HolderForceClosed) => {},
	(6, CommitmentTxConfirmed) => {},
	(4, CooperativeClosure) => {},
	(4, LegacyCooperativeClosure) => {},

Comment on lines

261
 to 
+262

@shaavanshaavanFeb 1, 2024

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

Unrelated nit:
Since we are touching these lines, should we think about reordering these enums? I think it's pretty odd to write 6th before 4th.

Suggested change

(6,CommitmentTxConfirmed) => {},
(4,CooperativeClosure) => {},
(4,LegacyCooperativeClosure) => {},
(4,LegacyCooperativeClosure) => {},
(6,CommitmentTxConfirmed) => {},
	(8, ProcessingError) => { (1, err, required) },
	(10, DisconnectedPeer) => {},
	(12, OutdatedChannelManager) => {},
	(13, CounterpartyCoopClosedUnfundedChannel) => {},
	(15, FundingBatchClosure) => {}
	(15, FundingBatchClosure) => {},
	(17, CounterpartyInitiatedCooperativeClosure) => {},
	(19, LocallyInitiatedCooperativeClosure) => {},
);

/// Intended destination of a failed HTLC as indicated in [`Event::HTLCHandlingFailed`].
Expand Down

8 changes: 4 additions & 4 deletions
lightning/src/ln/chanmon_update_fail_tests.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1955,8 +1955,8 @@ fn do_during_funding_monitor_fail(confirm_a_first: bool, restore_b_before_conf:

	send_payment(&nodes[0], &[&nodes[1]], 8000000);
	close_channel(&nodes[0], &nodes[1], &channel_id, funding_tx, true);
	check_closed_event!(nodes[0], 1, ClosureReason::CooperativeClosure, [nodes[1].node.get_our_node_id()], 100000);
	check_closed_event!(nodes[1], 1, ClosureReason::CooperativeClosure, [nodes[0].node.get_our_node_id()], 100000);
	check_closed_event!(nodes[0], 1, ClosureReason::CounterpartyInitiatedCooperativeClosure, [nodes[1].node.get_our_node_id()], 100000);
	check_closed_event!(nodes[1], 1, ClosureReason::LocallyInitiatedCooperativeClosure, [nodes[0].node.get_our_node_id()], 100000);
}

#[test]
Expand DownExpand Up@@ -2634,8 +2634,8 @@ fn test_temporary_error_during_shutdown() {
	assert_eq!(txn_a, txn_b);
	assert_eq!(txn_a.len(), 1);
	check_spends!(txn_a[0], funding_tx);
	check_closed_event!(nodes[1], 1, ClosureReason::CooperativeClosure, [nodes[0].node.get_our_node_id()], 100000);
	check_closed_event!(nodes[0], 1, ClosureReason::CooperativeClosure, [nodes[1].node.get_our_node_id()], 100000);
	check_closed_event!(nodes[1], 1, ClosureReason::CounterpartyInitiatedCooperativeClosure, [nodes[0].node.get_our_node_id()], 100000);
	check_closed_event!(nodes[0], 1, ClosureReason::LocallyInitiatedCooperativeClosure, [nodes[1].node.get_our_node_id()], 100000);
}

#[test]
Expand Down

28 changes: 26 additions & 2 deletions
lightning/src/ln/channel.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1256,6 +1256,9 @@ pub(super) struct ChannelContext<SP: Deref> where SP::Target: SignerProvider {
	// We track whether we already emitted a `ChannelReady` event.
	channel_ready_event_emitted: bool,

	/// Some if we initiated to shut down the channel.
	local_initiated_shutdown: Option<()>,

	/// The unique identifier used to re-derive the private key material for the channel through
	/// [`SignerProvider::derive_channel_signer`].
	channel_keys_id: [u8; 32],
Expand DownExpand Up@@ -4959,11 +4962,17 @@ impl<SP: Deref> Channel<SP> where
 }
 }

 let closure_reason = if self.initiated_shutdown() {
 ClosureReason::LocallyInitiatedCooperativeClosure
 } else {
 ClosureReason::CounterpartyInitiatedCooperativeClosure
 };

 assert!(self.context.shutdown_scriptpubkey.is_some());
 if let Some((last_fee, sig)) = self.context.last_sent_closing_fee {
 if last_fee == msg.fee_satoshis {
 let shutdown_result = ShutdownResult {
 closure_reason: ClosureReason::CooperativeClosure,
 closure_reason,
 monitor_update: None,
 dropped_outbound_htlcs: Vec::new(),
 unbroadcasted_batch_funding_txid: self.context.unbroadcasted_batch_funding_txid(),
Expand DownExpand Up@@ -4998,7 +5007,7 @@ impl<SP: Deref> Channel<SP> where
 .map_err(|_| ChannelError::Close("External signer refused to sign closing transaction".to_owned()))?;
 let (signed_tx, shutdown_result) = if $new_fee == msg.fee_satoshis {
 let shutdown_result = ShutdownResult {
 closure_reason: ClosureReason::CooperativeClosure,
 closure_reason,
 monitor_update: None,
 dropped_outbound_htlcs: Vec::new(),
 unbroadcasted_batch_funding_txid: self.context.unbroadcasted_batch_funding_txid(),
Expand DownExpand Up@@ -5263,6 +5272,11 @@ impl<SP: Deref> Channel<SP> where
 self.context.channel_state.is_local_shutdown_sent()
	}

	/// Returns true if we initiated to shut down the channel.
	pub fn initiated_shutdown(&self) -> bool {
 self.context.local_initiated_shutdown.is_some()
	}

	/// Returns true if this channel is fully shut down. True here implies that no further actions
	/// may/will be taken on this channel, and thus this object should be freed. Any future changes
	/// will be handled appropriately by the chain monitor.
Expand DownExpand Up@@ -6177,6 +6191,7 @@ impl<SP: Deref> Channel<SP> where
 // From here on out, we may not fail!
 self.context.target_closing_feerate_sats_per_kw = target_feerate_sats_per_kw;
 self.context.channel_state.set_local_shutdown_sent();
 self.context.local_initiated_shutdown = Some(());
 self.context.update_time_counter += 1;

 let monitor_update = if update_shutdown_script {
Expand DownExpand Up@@ -6437,6 +6452,7 @@ impl<SP: Deref> OutboundV1Channel<SP> where SP::Target: SignerProvider {
 channel_keys_id,

 blocked_monitor_updates: Vec::new(),
 local_initiated_shutdown: None,
 },
 unfunded_context: UnfundedChannelContext { unfunded_channel_age_ticks: 0 }
 })
Expand DownExpand Up@@ -7237,6 +7253,8 @@ impl<SP: Deref> InboundV1Channel<SP> where SP::Target: SignerProvider {
 channel_type,
 channel_keys_id,

 local_initiated_shutdown: None,

 blocked_monitor_updates: Vec::new(),
 },
 unfunded_context: UnfundedChannelContext { unfunded_channel_age_ticks: 0 }
Expand DownExpand Up@@ -7811,6 +7829,7 @@ impl<SP: Deref> Writeable for Channel<SP> where SP::Target: SignerProvider {
 (39, pending_outbound_blinding_points, optional_vec),
 (41, holding_cell_blinding_points, optional_vec),
 (43, malformed_htlcs, optional_vec), // Added in 0.0.119
 (45, self.context.local_initiated_shutdown, option), // Added in 0.0.122
 });

 Ok(())
Expand DownExpand Up@@ -8098,6 +8117,8 @@ impl<'a, 'b, 'c, ES: Deref, SP: Deref> ReadableArgs<(&'a ES, &'b SP, u32, &'c Ch

 let mut is_batch_funding: Option<()> = None;

 let mut local_initiated_shutdown: Option<()> = None;

 let mut pending_outbound_blinding_points_opt: Option<Vec<Option<PublicKey>>> = None;
 let mut holding_cell_blinding_points_opt: Option<Vec<Option<PublicKey>>> = None;

Expand DownExpand Up@@ -8132,6 +8153,7 @@ impl<'a, 'b, 'c, ES: Deref, SP: Deref> ReadableArgs<(&'a ES, &'b SP, u32, &'c Ch
 (39, pending_outbound_blinding_points_opt, optional_vec),
 (41, holding_cell_blinding_points_opt, optional_vec),
 (43, malformed_htlcs, optional_vec), // Added in 0.0.119
 (45, local_initiated_shutdown, option),
 });

 let (channel_keys_id, holder_signer) = if let Some(channel_keys_id) = channel_keys_id {
Expand DownExpand Up@@ -8362,6 +8384,8 @@ impl<'a, 'b, 'c, ES: Deref, SP: Deref> ReadableArgs<(&'a ES, &'b SP, u32, &'c Ch
 channel_type: channel_type.unwrap(),
 channel_keys_id,

 local_initiated_shutdown,

 blocked_monitor_updates: blocked_monitor_updates.unwrap(),
 }
 })
Expand Down

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

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -11856,8 +11856,8 @@ mod tests {
 }
 let (_nodes_1_update, _none) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());

 check_closed_event!(nodes[0], 1, ClosureReason::CooperativeClosure, [nodes[1].node.get_our_node_id()], 1000000);
 check_closed_event!(nodes[1], 1, ClosureReason::CooperativeClosure, [nodes[0].node.get_our_node_id()], 1000000);
 check_closed_event!(nodes[0], 1, ClosureReason::LocallyInitiatedCooperativeClosure, [nodes[1].node.get_our_node_id()], 1000000);
 check_closed_event!(nodes[1], 1, ClosureReason::CounterpartyInitiatedCooperativeClosure, [nodes[0].node.get_our_node_id()], 1000000);
	}

	fn check_not_connected_to_peer_error<T>(res_err: Result<T, APIError>, expected_public_key: PublicKey) {
Expand Down

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

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -871,8 +871,8 @@ fn test_update_fee_with_fundee_update_add_htlc() {
	send_payment(&nodes[1], &vec!(&nodes[0])[..], 800000);
	send_payment(&nodes[0], &vec!(&nodes[1])[..], 800000);
	close_channel(&nodes[0], &nodes[1], &chan.2, chan.3, true);
	check_closed_event!(nodes[0], 1, ClosureReason::CooperativeClosure, [nodes[1].node.get_our_node_id()], 100000);
	check_closed_event!(nodes[1], 1, ClosureReason::CooperativeClosure, [nodes[0].node.get_our_node_id()], 100000);
	check_closed_event!(nodes[0], 1, ClosureReason::CounterpartyInitiatedCooperativeClosure, [nodes[1].node.get_our_node_id()], 100000);
	check_closed_event!(nodes[1], 1, ClosureReason::LocallyInitiatedCooperativeClosure, [nodes[0].node.get_our_node_id()], 100000);
}

#[test]
Expand DownExpand Up@@ -985,8 +985,8 @@ fn test_update_fee() {
	assert_eq!(get_feerate!(nodes[0], nodes[1], channel_id), feerate + 30);
	assert_eq!(get_feerate!(nodes[1], nodes[0], channel_id), feerate + 30);
	close_channel(&nodes[0], &nodes[1], &chan.2, chan.3, true);
	check_closed_event!(nodes[0], 1, ClosureReason::CooperativeClosure, [nodes[1].node.get_our_node_id()], 100000);
	check_closed_event!(nodes[1], 1, ClosureReason::CooperativeClosure, [nodes[0].node.get_our_node_id()], 100000);
	check_closed_event!(nodes[0], 1, ClosureReason::CounterpartyInitiatedCooperativeClosure, [nodes[1].node.get_our_node_id()], 100000);
	check_closed_event!(nodes[1], 1, ClosureReason::LocallyInitiatedCooperativeClosure, [nodes[0].node.get_our_node_id()], 100000);
}

#[test]
Expand DownExpand Up@@ -1104,17 +1104,17 @@ fn fake_network_test() {

	// Close down the channels...
	close_channel(&nodes[0], &nodes[1], &chan_1.2, chan_1.3, true);
	check_closed_event!(nodes[0], 1, ClosureReason::CooperativeClosure, [nodes[1].node.get_our_node_id()], 100000);
	check_closed_event!(nodes[1], 1, ClosureReason::CooperativeClosure, [nodes[0].node.get_our_node_id()], 100000);
	check_closed_event!(nodes[0], 1, ClosureReason::CounterpartyInitiatedCooperativeClosure, [nodes[1].node.get_our_node_id()], 100000);
	check_closed_event!(nodes[1], 1, ClosureReason::LocallyInitiatedCooperativeClosure, [nodes[0].node.get_our_node_id()], 100000);
	close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, false);
	check_closed_event!(nodes[1], 1, ClosureReason::CooperativeClosure, [nodes[2].node.get_our_node_id()], 100000);
	check_closed_event!(nodes[2], 1, ClosureReason::CooperativeClosure, [nodes[1].node.get_our_node_id()], 100000);
	check_closed_event!(nodes[1], 1, ClosureReason::LocallyInitiatedCooperativeClosure, [nodes[2].node.get_our_node_id()], 100000);
	check_closed_event!(nodes[2], 1, ClosureReason::CounterpartyInitiatedCooperativeClosure, [nodes[1].node.get_our_node_id()], 100000);
	close_channel(&nodes[2], &nodes[3], &chan_3.2, chan_3.3, true);
	check_closed_event!(nodes[2], 1, ClosureReason::CooperativeClosure, [nodes[3].node.get_our_node_id()], 100000);
	check_closed_event!(nodes[3], 1, ClosureReason::CooperativeClosure, [nodes[2].node.get_our_node_id()], 100000);
	check_closed_event!(nodes[2], 1, ClosureReason::CounterpartyInitiatedCooperativeClosure, [nodes[3].node.get_our_node_id()], 100000);
	check_closed_event!(nodes[3], 1, ClosureReason::LocallyInitiatedCooperativeClosure, [nodes[2].node.get_our_node_id()], 100000);
	close_channel(&nodes[1], &nodes[3], &chan_4.2, chan_4.3, false);
	check_closed_event!(nodes[1], 1, ClosureReason::CooperativeClosure, [nodes[3].node.get_our_node_id()], 100000);
	check_closed_event!(nodes[3], 1, ClosureReason::CooperativeClosure, [nodes[1].node.get_our_node_id()], 100000);
	check_closed_event!(nodes[1], 1, ClosureReason::LocallyInitiatedCooperativeClosure, [nodes[3].node.get_our_node_id()], 100000);
	check_closed_event!(nodes[3], 1, ClosureReason::CounterpartyInitiatedCooperativeClosure, [nodes[1].node.get_our_node_id()], 100000);
}

#[test]
Expand DownExpand Up@@ -5619,15 +5619,15 @@ fn test_static_output_closing_tx() {
	let closing_tx = close_channel(&nodes[0], &nodes[1], &chan.2, chan.3, true).2;

	mine_transaction(&nodes[0], &closing_tx);
	check_closed_event!(nodes[0], 1, ClosureReason::CooperativeClosure, [nodes[1].node.get_our_node_id()], 100000);
	check_closed_event!(nodes[0], 1, ClosureReason::CounterpartyInitiatedCooperativeClosure, [nodes[1].node.get_our_node_id()], 100000);
	connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);

	let spend_txn = check_spendable_outputs!(nodes[0], node_cfgs[0].keys_manager);
	assert_eq!(spend_txn.len(), 1);
	check_spends!(spend_txn[0], closing_tx);

	mine_transaction(&nodes[1], &closing_tx);
	check_closed_event!(nodes[1], 1, ClosureReason::CooperativeClosure, [nodes[0].node.get_our_node_id()], 100000);
	check_closed_event!(nodes[1], 1, ClosureReason::LocallyInitiatedCooperativeClosure, [nodes[0].node.get_our_node_id()], 100000);
	connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);

	let spend_txn = check_spendable_outputs!(nodes[1], node_cfgs[1].keys_manager);
Expand Down

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

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -257,8 +257,8 @@ fn do_chanmon_claim_value_coop_close(anchors: bool) {
 spendable_outputs_b
	);

	check_closed_event!(nodes[0], 1, ClosureReason::CooperativeClosure, [nodes[1].node.get_our_node_id()], 1000000);
	check_closed_event!(nodes[1], 1, ClosureReason::CooperativeClosure, [nodes[0].node.get_our_node_id()], 1000000);
	check_closed_event!(nodes[0], 1, ClosureReason::LocallyInitiatedCooperativeClosure, [nodes[1].node.get_our_node_id()], 1000000);
	check_closed_event!(nodes[1], 1, ClosureReason::CounterpartyInitiatedCooperativeClosure, [nodes[0].node.get_our_node_id()], 1000000);
}

#[test]
Expand Down
Loading

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

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

TheBlueMatt
merged 2 commits into

from

Feb 5, 2024
 Merged


Breakup CooperativeClosure into Local/Remote initiated
#2863
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
58f7942

Breakup CooperativeClosure into Local/Remote initiated


benthecarman Jan 31, 2024
efcb5d9

Rename old CooperativeClosure to LegacyCooperativeClosure


benthecarman Feb 4, 2024

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


21 changes: 16 additions & 5 deletions
lightning/src/events/mod.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -184,8 +184,15 @@ pub enum ClosureReason {
	HolderForceClosed,
	/// The channel was closed after negotiating a cooperative close and we've now broadcasted
	/// the cooperative close transaction. Note the shutdown may have been initiated by us.
	//TODO: split between CounterpartyInitiated/LocallyInitiated
	CooperativeClosure,
	// Can be removed once we disallow downgrading to 0.0.121
	LegacyCooperativeClosure,
Comment thread
benthecarman marked this conversation as resolved.

	/// The channel was closed after negotiating a cooperative close and we've now broadcasted
	/// the cooperative close transaction. This indicates that the shutdown was initiated by our
	/// counterparty.
@TheBlueMattTheBlueMattFeb 5, 2024

Copy link


Copy Markdown

Collaborator
Choose a reason for hiding this comment

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


Suggested change

/// counterparty.
/// counterparty.
///
/// In rare cases where we sent our peer a `shutdown`, crashed, then restarted this reason may be given even though we initiated the shutdown.
	CounterpartyInitiatedCooperativeClosure,
	/// The channel was closed after negotiating a cooperative close and we've now broadcasted
	/// the cooperative close transaction. This indicates that the shutdown was initiated by us.
	LocallyInitiatedCooperativeClosure,
	/// A commitment transaction was confirmed on chain, closing the channel. Most likely this
	/// commitment transaction came from our counterparty, but it may also have come from
	/// a copy of our own `ChannelMonitor`.
Expand DownExpand Up@@ -230,7 +237,9 @@ impl core::fmt::Display for ClosureReason {
 f.write_fmt(format_args!("counterparty force-closed with message: {}", peer_msg))
 },
 ClosureReason::HolderForceClosed => f.write_str("user manually force-closed the channel"),
 ClosureReason::CooperativeClosure => f.write_str("the channel was cooperatively closed"),
 ClosureReason::LegacyCooperativeClosure => f.write_str("the channel was cooperatively closed"),
 ClosureReason::CounterpartyInitiatedCooperativeClosure => f.write_str("the channel was cooperatively closed by our peer"),
 ClosureReason::LocallyInitiatedCooperativeClosure => f.write_str("the channel was cooperatively closed by us"),
 ClosureReason::CommitmentTxConfirmed => f.write_str("commitment or closing transaction was confirmed on chain."),
 ClosureReason::FundingTimedOut => write!(f, "funding transaction failed to confirm within {} blocks", FUNDING_CONF_DEADLINE_BLOCKS),
 ClosureReason::ProcessingError { err } => {
Expand All@@ -250,12 +259,14 @@ impl_writeable_tlv_based_enum_upgradable!(ClosureReason,
	(1, FundingTimedOut) => {},
	(2, HolderForceClosed) => {},
	(6, CommitmentTxConfirmed) => {},
	(4, CooperativeClosure) => {},
	(4, LegacyCooperativeClosure) => {},

Comment on lines

261
 to 
+262

@shaavanshaavanFeb 1, 2024

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

Unrelated nit:
Since we are touching these lines, should we think about reordering these enums? I think it's pretty odd to write 6th before 4th.

Suggested change

(6,CommitmentTxConfirmed) => {},
(4,CooperativeClosure) => {},
(4,LegacyCooperativeClosure) => {},
(4,LegacyCooperativeClosure) => {},
(6,CommitmentTxConfirmed) => {},
	(8, ProcessingError) => { (1, err, required) },
	(10, DisconnectedPeer) => {},
	(12, OutdatedChannelManager) => {},
	(13, CounterpartyCoopClosedUnfundedChannel) => {},
	(15, FundingBatchClosure) => {}
	(15, FundingBatchClosure) => {},
	(17, CounterpartyInitiatedCooperativeClosure) => {},
	(19, LocallyInitiatedCooperativeClosure) => {},
);

/// Intended destination of a failed HTLC as indicated in [`Event::HTLCHandlingFailed`].
Expand Down

8 changes: 4 additions & 4 deletions
lightning/src/ln/chanmon_update_fail_tests.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1955,8 +1955,8 @@ fn do_during_funding_monitor_fail(confirm_a_first: bool, restore_b_before_conf:

	send_payment(&nodes[0], &[&nodes[1]], 8000000);
	close_channel(&nodes[0], &nodes[1], &channel_id, funding_tx, true);
	check_closed_event!(nodes[0], 1, ClosureReason::CooperativeClosure, [nodes[1].node.get_our_node_id()], 100000);
	check_closed_event!(nodes[1], 1, ClosureReason::CooperativeClosure, [nodes[0].node.get_our_node_id()], 100000);
	check_closed_event!(nodes[0], 1, ClosureReason::CounterpartyInitiatedCooperativeClosure, [nodes[1].node.get_our_node_id()], 100000);
	check_closed_event!(nodes[1], 1, ClosureReason::LocallyInitiatedCooperativeClosure, [nodes[0].node.get_our_node_id()], 100000);
}

#[test]
Expand DownExpand Up@@ -2634,8 +2634,8 @@ fn test_temporary_error_during_shutdown() {
	assert_eq!(txn_a, txn_b);
	assert_eq!(txn_a.len(), 1);
	check_spends!(txn_a[0], funding_tx);
	check_closed_event!(nodes[1], 1, ClosureReason::CooperativeClosure, [nodes[0].node.get_our_node_id()], 100000);
	check_closed_event!(nodes[0], 1, ClosureReason::CooperativeClosure, [nodes[1].node.get_our_node_id()], 100000);
	check_closed_event!(nodes[1], 1, ClosureReason::CounterpartyInitiatedCooperativeClosure, [nodes[0].node.get_our_node_id()], 100000);
	check_closed_event!(nodes[0], 1, ClosureReason::LocallyInitiatedCooperativeClosure, [nodes[1].node.get_our_node_id()], 100000);
}

#[test]
Expand Down

28 changes: 26 additions & 2 deletions
lightning/src/ln/channel.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1256,6 +1256,9 @@ pub(super) struct ChannelContext<SP: Deref> where SP::Target: SignerProvider {
	// We track whether we already emitted a `ChannelReady` event.
	channel_ready_event_emitted: bool,

	/// Some if we initiated to shut down the channel.
	local_initiated_shutdown: Option<()>,

	/// The unique identifier used to re-derive the private key material for the channel through
	/// [`SignerProvider::derive_channel_signer`].
	channel_keys_id: [u8; 32],
Expand DownExpand Up@@ -4959,11 +4962,17 @@ impl<SP: Deref> Channel<SP> where
 }
 }

 let closure_reason = if self.initiated_shutdown() {
 ClosureReason::LocallyInitiatedCooperativeClosure
 } else {
 ClosureReason::CounterpartyInitiatedCooperativeClosure
 };

 assert!(self.context.shutdown_scriptpubkey.is_some());
 if let Some((last_fee, sig)) = self.context.last_sent_closing_fee {
 if last_fee == msg.fee_satoshis {
 let shutdown_result = ShutdownResult {
 closure_reason: ClosureReason::CooperativeClosure,
 closure_reason,
 monitor_update: None,
 dropped_outbound_htlcs: Vec::new(),
 unbroadcasted_batch_funding_txid: self.context.unbroadcasted_batch_funding_txid(),
Expand DownExpand Up@@ -4998,7 +5007,7 @@ impl<SP: Deref> Channel<SP> where
 .map_err(|_| ChannelError::Close("External signer refused to sign closing transaction".to_owned()))?;
 let (signed_tx, shutdown_result) = if $new_fee == msg.fee_satoshis {
 let shutdown_result = ShutdownResult {
 closure_reason: ClosureReason::CooperativeClosure,
 closure_reason,
 monitor_update: None,
 dropped_outbound_htlcs: Vec::new(),
 unbroadcasted_batch_funding_txid: self.context.unbroadcasted_batch_funding_txid(),
Expand DownExpand Up@@ -5263,6 +5272,11 @@ impl<SP: Deref> Channel<SP> where
 self.context.channel_state.is_local_shutdown_sent()
	}

	/// Returns true if we initiated to shut down the channel.
	pub fn initiated_shutdown(&self) -> bool {
 self.context.local_initiated_shutdown.is_some()
	}

	/// Returns true if this channel is fully shut down. True here implies that no further actions
	/// may/will be taken on this channel, and thus this object should be freed. Any future changes
	/// will be handled appropriately by the chain monitor.
Expand DownExpand Up@@ -6177,6 +6191,7 @@ impl<SP: Deref> Channel<SP> where
 // From here on out, we may not fail!
 self.context.target_closing_feerate_sats_per_kw = target_feerate_sats_per_kw;
 self.context.channel_state.set_local_shutdown_sent();
 self.context.local_initiated_shutdown = Some(());
 self.context.update_time_counter += 1;

 let monitor_update = if update_shutdown_script {
Expand DownExpand Up@@ -6437,6 +6452,7 @@ impl<SP: Deref> OutboundV1Channel<SP> where SP::Target: SignerProvider {
 channel_keys_id,

 blocked_monitor_updates: Vec::new(),
 local_initiated_shutdown: None,
 },
 unfunded_context: UnfundedChannelContext { unfunded_channel_age_ticks: 0 }
 })
Expand DownExpand Up@@ -7237,6 +7253,8 @@ impl<SP: Deref> InboundV1Channel<SP> where SP::Target: SignerProvider {
 channel_type,
 channel_keys_id,

 local_initiated_shutdown: None,

 blocked_monitor_updates: Vec::new(),
 },
 unfunded_context: UnfundedChannelContext { unfunded_channel_age_ticks: 0 }
Expand DownExpand Up@@ -7811,6 +7829,7 @@ impl<SP: Deref> Writeable for Channel<SP> where SP::Target: SignerProvider {
 (39, pending_outbound_blinding_points, optional_vec),
 (41, holding_cell_blinding_points, optional_vec),
 (43, malformed_htlcs, optional_vec), // Added in 0.0.119
 (45, self.context.local_initiated_shutdown, option), // Added in 0.0.122
 });

 Ok(())
Expand DownExpand Up@@ -8098,6 +8117,8 @@ impl<'a, 'b, 'c, ES: Deref, SP: Deref> ReadableArgs<(&'a ES, &'b SP, u32, &'c Ch

 let mut is_batch_funding: Option<()> = None;

 let mut local_initiated_shutdown: Option<()> = None;

 let mut pending_outbound_blinding_points_opt: Option<Vec<Option<PublicKey>>> = None;
 let mut holding_cell_blinding_points_opt: Option<Vec<Option<PublicKey>>> = None;

Expand DownExpand Up@@ -8132,6 +8153,7 @@ impl<'a, 'b, 'c, ES: Deref, SP: Deref> ReadableArgs<(&'a ES, &'b SP, u32, &'c Ch
 (39, pending_outbound_blinding_points_opt, optional_vec),
 (41, holding_cell_blinding_points_opt, optional_vec),
 (43, malformed_htlcs, optional_vec), // Added in 0.0.119
 (45, local_initiated_shutdown, option),
 });

 let (channel_keys_id, holder_signer) = if let Some(channel_keys_id) = channel_keys_id {
Expand DownExpand Up@@ -8362,6 +8384,8 @@ impl<'a, 'b, 'c, ES: Deref, SP: Deref> ReadableArgs<(&'a ES, &'b SP, u32, &'c Ch
 channel_type: channel_type.unwrap(),
 channel_keys_id,

 local_initiated_shutdown,

 blocked_monitor_updates: blocked_monitor_updates.unwrap(),
 }
 })
Expand Down

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

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -11856,8 +11856,8 @@ mod tests {
 }
 let (_nodes_1_update, _none) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());

 check_closed_event!(nodes[0], 1, ClosureReason::CooperativeClosure, [nodes[1].node.get_our_node_id()], 1000000);
 check_closed_event!(nodes[1], 1, ClosureReason::CooperativeClosure, [nodes[0].node.get_our_node_id()], 1000000);
 check_closed_event!(nodes[0], 1, ClosureReason::LocallyInitiatedCooperativeClosure, [nodes[1].node.get_our_node_id()], 1000000);
 check_closed_event!(nodes[1], 1, ClosureReason::CounterpartyInitiatedCooperativeClosure, [nodes[0].node.get_our_node_id()], 1000000);
	}

	fn check_not_connected_to_peer_error<T>(res_err: Result<T, APIError>, expected_public_key: PublicKey) {
Expand Down

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

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -871,8 +871,8 @@ fn test_update_fee_with_fundee_update_add_htlc() {
	send_payment(&nodes[1], &vec!(&nodes[0])[..], 800000);
	send_payment(&nodes[0], &vec!(&nodes[1])[..], 800000);
	close_channel(&nodes[0], &nodes[1], &chan.2, chan.3, true);
	check_closed_event!(nodes[0], 1, ClosureReason::CooperativeClosure, [nodes[1].node.get_our_node_id()], 100000);
	check_closed_event!(nodes[1], 1, ClosureReason::CooperativeClosure, [nodes[0].node.get_our_node_id()], 100000);
	check_closed_event!(nodes[0], 1, ClosureReason::CounterpartyInitiatedCooperativeClosure, [nodes[1].node.get_our_node_id()], 100000);
	check_closed_event!(nodes[1], 1, ClosureReason::LocallyInitiatedCooperativeClosure, [nodes[0].node.get_our_node_id()], 100000);
}

#[test]
Expand DownExpand Up@@ -985,8 +985,8 @@ fn test_update_fee() {
	assert_eq!(get_feerate!(nodes[0], nodes[1], channel_id), feerate + 30);
	assert_eq!(get_feerate!(nodes[1], nodes[0], channel_id), feerate + 30);
	close_channel(&nodes[0], &nodes[1], &chan.2, chan.3, true);
	check_closed_event!(nodes[0], 1, ClosureReason::CooperativeClosure, [nodes[1].node.get_our_node_id()], 100000);
	check_closed_event!(nodes[1], 1, ClosureReason::CooperativeClosure, [nodes[0].node.get_our_node_id()], 100000);
	check_closed_event!(nodes[0], 1, ClosureReason::CounterpartyInitiatedCooperativeClosure, [nodes[1].node.get_our_node_id()], 100000);
	check_closed_event!(nodes[1], 1, ClosureReason::LocallyInitiatedCooperativeClosure, [nodes[0].node.get_our_node_id()], 100000);
}

#[test]
Expand DownExpand Up@@ -1104,17 +1104,17 @@ fn fake_network_test() {

	// Close down the channels...
	close_channel(&nodes[0], &nodes[1], &chan_1.2, chan_1.3, true);
	check_closed_event!(nodes[0], 1, ClosureReason::CooperativeClosure, [nodes[1].node.get_our_node_id()], 100000);
	check_closed_event!(nodes[1], 1, ClosureReason::CooperativeClosure, [nodes[0].node.get_our_node_id()], 100000);
	check_closed_event!(nodes[0], 1, ClosureReason::CounterpartyInitiatedCooperativeClosure, [nodes[1].node.get_our_node_id()], 100000);
	check_closed_event!(nodes[1], 1, ClosureReason::LocallyInitiatedCooperativeClosure, [nodes[0].node.get_our_node_id()], 100000);
	close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, false);
	check_closed_event!(nodes[1], 1, ClosureReason::CooperativeClosure, [nodes[2].node.get_our_node_id()], 100000);
	check_closed_event!(nodes[2], 1, ClosureReason::CooperativeClosure, [nodes[1].node.get_our_node_id()], 100000);
	check_closed_event!(nodes[1], 1, ClosureReason::LocallyInitiatedCooperativeClosure, [nodes[2].node.get_our_node_id()], 100000);
	check_closed_event!(nodes[2], 1, ClosureReason::CounterpartyInitiatedCooperativeClosure, [nodes[1].node.get_our_node_id()], 100000);
	close_channel(&nodes[2], &nodes[3], &chan_3.2, chan_3.3, true);
	check_closed_event!(nodes[2], 1, ClosureReason::CooperativeClosure, [nodes[3].node.get_our_node_id()], 100000);
	check_closed_event!(nodes[3], 1, ClosureReason::CooperativeClosure, [nodes[2].node.get_our_node_id()], 100000);
	check_closed_event!(nodes[2], 1, ClosureReason::CounterpartyInitiatedCooperativeClosure, [nodes[3].node.get_our_node_id()], 100000);
	check_closed_event!(nodes[3], 1, ClosureReason::LocallyInitiatedCooperativeClosure, [nodes[2].node.get_our_node_id()], 100000);
	close_channel(&nodes[1], &nodes[3], &chan_4.2, chan_4.3, false);
	check_closed_event!(nodes[1], 1, ClosureReason::CooperativeClosure, [nodes[3].node.get_our_node_id()], 100000);
	check_closed_event!(nodes[3], 1, ClosureReason::CooperativeClosure, [nodes[1].node.get_our_node_id()], 100000);
	check_closed_event!(nodes[1], 1, ClosureReason::LocallyInitiatedCooperativeClosure, [nodes[3].node.get_our_node_id()], 100000);
	check_closed_event!(nodes[3], 1, ClosureReason::CounterpartyInitiatedCooperativeClosure, [nodes[1].node.get_our_node_id()], 100000);
}

#[test]
Expand DownExpand Up@@ -5619,15 +5619,15 @@ fn test_static_output_closing_tx() {
	let closing_tx = close_channel(&nodes[0], &nodes[1], &chan.2, chan.3, true).2;

	mine_transaction(&nodes[0], &closing_tx);
	check_closed_event!(nodes[0], 1, ClosureReason::CooperativeClosure, [nodes[1].node.get_our_node_id()], 100000);
	check_closed_event!(nodes[0], 1, ClosureReason::CounterpartyInitiatedCooperativeClosure, [nodes[1].node.get_our_node_id()], 100000);
	connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);

	let spend_txn = check_spendable_outputs!(nodes[0], node_cfgs[0].keys_manager);
	assert_eq!(spend_txn.len(), 1);
	check_spends!(spend_txn[0], closing_tx);

	mine_transaction(&nodes[1], &closing_tx);
	check_closed_event!(nodes[1], 1, ClosureReason::CooperativeClosure, [nodes[0].node.get_our_node_id()], 100000);
	check_closed_event!(nodes[1], 1, ClosureReason::LocallyInitiatedCooperativeClosure, [nodes[0].node.get_our_node_id()], 100000);
	connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);

	let spend_txn = check_spendable_outputs!(nodes[1], node_cfgs[1].keys_manager);
Expand Down

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

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -257,8 +257,8 @@ fn do_chanmon_claim_value_coop_close(anchors: bool) {
 spendable_outputs_b
	);

	check_closed_event!(nodes[0], 1, ClosureReason::CooperativeClosure, [nodes[1].node.get_our_node_id()], 1000000);
	check_closed_event!(nodes[1], 1, ClosureReason::CooperativeClosure, [nodes[0].node.get_our_node_id()], 1000000);
	check_closed_event!(nodes[0], 1, ClosureReason::LocallyInitiatedCooperativeClosure, [nodes[1].node.get_our_node_id()], 1000000);
	check_closed_event!(nodes[1], 1, ClosureReason::CounterpartyInitiatedCooperativeClosure, [nodes[0].node.get_our_node_id()], 1000000);
}

#[test]
Expand Down
Loading

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

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

TheBlueMatt
merged 2 commits into

from

Feb 5, 2024
 Merged


Breakup CooperativeClosure into Local/Remote initiated
#2863
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
58f7942

Breakup CooperativeClosure into Local/Remote initiated


benthecarman Jan 31, 2024
efcb5d9

Rename old CooperativeClosure to LegacyCooperativeClosure


benthecarman Feb 4, 2024

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


21 changes: 16 additions & 5 deletions
lightning/src/events/mod.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -184,8 +184,15 @@ pub enum ClosureReason {
	HolderForceClosed,
	/// The channel was closed after negotiating a cooperative close and we've now broadcasted
	/// the cooperative close transaction. Note the shutdown may have been initiated by us.
	//TODO: split between CounterpartyInitiated/LocallyInitiated
	CooperativeClosure,
	// Can be removed once we disallow downgrading to 0.0.121
	LegacyCooperativeClosure,
Comment thread
benthecarman marked this conversation as resolved.

	/// The channel was closed after negotiating a cooperative close and we've now broadcasted
	/// the cooperative close transaction. This indicates that the shutdown was initiated by our
	/// counterparty.
@TheBlueMattTheBlueMattFeb 5, 2024

Copy link


Copy Markdown

Collaborator
Choose a reason for hiding this comment

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


Suggested change

/// counterparty.
/// counterparty.
///
/// In rare cases where we sent our peer a `shutdown`, crashed, then restarted this reason may be given even though we initiated the shutdown.
	CounterpartyInitiatedCooperativeClosure,
	/// The channel was closed after negotiating a cooperative close and we've now broadcasted
	/// the cooperative close transaction. This indicates that the shutdown was initiated by us.
	LocallyInitiatedCooperativeClosure,
	/// A commitment transaction was confirmed on chain, closing the channel. Most likely this
	/// commitment transaction came from our counterparty, but it may also have come from
	/// a copy of our own `ChannelMonitor`.
Expand DownExpand Up@@ -230,7 +237,9 @@ impl core::fmt::Display for ClosureReason {
 f.write_fmt(format_args!("counterparty force-closed with message: {}", peer_msg))
 },
 ClosureReason::HolderForceClosed => f.write_str("user manually force-closed the channel"),
 ClosureReason::CooperativeClosure => f.write_str("the channel was cooperatively closed"),
 ClosureReason::LegacyCooperativeClosure => f.write_str("the channel was cooperatively closed"),
 ClosureReason::CounterpartyInitiatedCooperativeClosure => f.write_str("the channel was cooperatively closed by our peer"),
 ClosureReason::LocallyInitiatedCooperativeClosure => f.write_str("the channel was cooperatively closed by us"),
 ClosureReason::CommitmentTxConfirmed => f.write_str("commitment or closing transaction was confirmed on chain."),
 ClosureReason::FundingTimedOut => write!(f, "funding transaction failed to confirm within {} blocks", FUNDING_CONF_DEADLINE_BLOCKS),
 ClosureReason::ProcessingError { err } => {
Expand All@@ -250,12 +259,14 @@ impl_writeable_tlv_based_enum_upgradable!(ClosureReason,
	(1, FundingTimedOut) => {},
	(2, HolderForceClosed) => {},
	(6, CommitmentTxConfirmed) => {},
	(4, CooperativeClosure) => {},
	(4, LegacyCooperativeClosure) => {},

Comment on lines

261
 to 
+262

@shaavanshaavanFeb 1, 2024

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

Unrelated nit:
Since we are touching these lines, should we think about reordering these enums? I think it's pretty odd to write 6th before 4th.

Suggested change

(6,CommitmentTxConfirmed) => {},
(4,CooperativeClosure) => {},
(4,LegacyCooperativeClosure) => {},
(4,LegacyCooperativeClosure) => {},
(6,CommitmentTxConfirmed) => {},
	(8, ProcessingError) => { (1, err, required) },
	(10, DisconnectedPeer) => {},
	(12, OutdatedChannelManager) => {},
	(13, CounterpartyCoopClosedUnfundedChannel) => {},
	(15, FundingBatchClosure) => {}
	(15, FundingBatchClosure) => {},
	(17, CounterpartyInitiatedCooperativeClosure) => {},
	(19, LocallyInitiatedCooperativeClosure) => {},
);

/// Intended destination of a failed HTLC as indicated in [`Event::HTLCHandlingFailed`].
Expand Down

8 changes: 4 additions & 4 deletions
lightning/src/ln/chanmon_update_fail_tests.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1955,8 +1955,8 @@ fn do_during_funding_monitor_fail(confirm_a_first: bool, restore_b_before_conf:

	send_payment(&nodes[0], &[&nodes[1]], 8000000);
	close_channel(&nodes[0], &nodes[1], &channel_id, funding_tx, true);
	check_closed_event!(nodes[0], 1, ClosureReason::CooperativeClosure, [nodes[1].node.get_our_node_id()], 100000);
	check_closed_event!(nodes[1], 1, ClosureReason::CooperativeClosure, [nodes[0].node.get_our_node_id()], 100000);
	check_closed_event!(nodes[0], 1, ClosureReason::CounterpartyInitiatedCooperativeClosure, [nodes[1].node.get_our_node_id()], 100000);
	check_closed_event!(nodes[1], 1, ClosureReason::LocallyInitiatedCooperativeClosure, [nodes[0].node.get_our_node_id()], 100000);
}

#[test]
Expand DownExpand Up@@ -2634,8 +2634,8 @@ fn test_temporary_error_during_shutdown() {
	assert_eq!(txn_a, txn_b);
	assert_eq!(txn_a.len(), 1);
	check_spends!(txn_a[0], funding_tx);
	check_closed_event!(nodes[1], 1, ClosureReason::CooperativeClosure, [nodes[0].node.get_our_node_id()], 100000);
	check_closed_event!(nodes[0], 1, ClosureReason::CooperativeClosure, [nodes[1].node.get_our_node_id()], 100000);
	check_closed_event!(nodes[1], 1, ClosureReason::CounterpartyInitiatedCooperativeClosure, [nodes[0].node.get_our_node_id()], 100000);
	check_closed_event!(nodes[0], 1, ClosureReason::LocallyInitiatedCooperativeClosure, [nodes[1].node.get_our_node_id()], 100000);
}

#[test]
Expand Down

28 changes: 26 additions & 2 deletions
lightning/src/ln/channel.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1256,6 +1256,9 @@ pub(super) struct ChannelContext<SP: Deref> where SP::Target: SignerProvider {
	// We track whether we already emitted a `ChannelReady` event.
	channel_ready_event_emitted: bool,

	/// Some if we initiated to shut down the channel.
	local_initiated_shutdown: Option<()>,

	/// The unique identifier used to re-derive the private key material for the channel through
	/// [`SignerProvider::derive_channel_signer`].
	channel_keys_id: [u8; 32],
Expand DownExpand Up@@ -4959,11 +4962,17 @@ impl<SP: Deref> Channel<SP> where
 }
 }

 let closure_reason = if self.initiated_shutdown() {
 ClosureReason::LocallyInitiatedCooperativeClosure
 } else {
 ClosureReason::CounterpartyInitiatedCooperativeClosure
 };

 assert!(self.context.shutdown_scriptpubkey.is_some());
 if let Some((last_fee, sig)) = self.context.last_sent_closing_fee {
 if last_fee == msg.fee_satoshis {
 let shutdown_result = ShutdownResult {
 closure_reason: ClosureReason::CooperativeClosure,
 closure_reason,
 monitor_update: None,
 dropped_outbound_htlcs: Vec::new(),
 unbroadcasted_batch_funding_txid: self.context.unbroadcasted_batch_funding_txid(),
Expand DownExpand Up@@ -4998,7 +5007,7 @@ impl<SP: Deref> Channel<SP> where
 .map_err(|_| ChannelError::Close("External signer refused to sign closing transaction".to_owned()))?;
 let (signed_tx, shutdown_result) = if $new_fee == msg.fee_satoshis {
 let shutdown_result = ShutdownResult {
 closure_reason: ClosureReason::CooperativeClosure,
 closure_reason,
 monitor_update: None,
 dropped_outbound_htlcs: Vec::new(),
 unbroadcasted_batch_funding_txid: self.context.unbroadcasted_batch_funding_txid(),
Expand DownExpand Up@@ -5263,6 +5272,11 @@ impl<SP: Deref> Channel<SP> where
 self.context.channel_state.is_local_shutdown_sent()
	}

	/// Returns true if we initiated to shut down the channel.
	pub fn initiated_shutdown(&self) -> bool {
 self.context.local_initiated_shutdown.is_some()
	}

	/// Returns true if this channel is fully shut down. True here implies that no further actions
	/// may/will be taken on this channel, and thus this object should be freed. Any future changes
	/// will be handled appropriately by the chain monitor.
Expand DownExpand Up@@ -6177,6 +6191,7 @@ impl<SP: Deref> Channel<SP> where
 // From here on out, we may not fail!
 self.context.target_closing_feerate_sats_per_kw = target_feerate_sats_per_kw;
 self.context.channel_state.set_local_shutdown_sent();
 self.context.local_initiated_shutdown = Some(());
 self.context.update_time_counter += 1;

 let monitor_update = if update_shutdown_script {
Expand DownExpand Up@@ -6437,6 +6452,7 @@ impl<SP: Deref> OutboundV1Channel<SP> where SP::Target: SignerProvider {
 channel_keys_id,

 blocked_monitor_updates: Vec::new(),
 local_initiated_shutdown: None,
 },
 unfunded_context: UnfundedChannelContext { unfunded_channel_age_ticks: 0 }
 })
Expand DownExpand Up@@ -7237,6 +7253,8 @@ impl<SP: Deref> InboundV1Channel<SP> where SP::Target: SignerProvider {
 channel_type,
 channel_keys_id,

 local_initiated_shutdown: None,

 blocked_monitor_updates: Vec::new(),
 },
 unfunded_context: UnfundedChannelContext { unfunded_channel_age_ticks: 0 }
Expand DownExpand Up@@ -7811,6 +7829,7 @@ impl<SP: Deref> Writeable for Channel<SP> where SP::Target: SignerProvider {
 (39, pending_outbound_blinding_points, optional_vec),
 (41, holding_cell_blinding_points, optional_vec),
 (43, malformed_htlcs, optional_vec), // Added in 0.0.119
 (45, self.context.local_initiated_shutdown, option), // Added in 0.0.122
 });

 Ok(())
Expand DownExpand Up@@ -8098,6 +8117,8 @@ impl<'a, 'b, 'c, ES: Deref, SP: Deref> ReadableArgs<(&'a ES, &'b SP, u32, &'c Ch

 let mut is_batch_funding: Option<()> = None;

 let mut local_initiated_shutdown: Option<()> = None;

 let mut pending_outbound_blinding_points_opt: Option<Vec<Option<PublicKey>>> = None;
 let mut holding_cell_blinding_points_opt: Option<Vec<Option<PublicKey>>> = None;

Expand DownExpand Up@@ -8132,6 +8153,7 @@ impl<'a, 'b, 'c, ES: Deref, SP: Deref> ReadableArgs<(&'a ES, &'b SP, u32, &'c Ch
 (39, pending_outbound_blinding_points_opt, optional_vec),
 (41, holding_cell_blinding_points_opt, optional_vec),
 (43, malformed_htlcs, optional_vec), // Added in 0.0.119
 (45, local_initiated_shutdown, option),
 });

 let (channel_keys_id, holder_signer) = if let Some(channel_keys_id) = channel_keys_id {
Expand DownExpand Up@@ -8362,6 +8384,8 @@ impl<'a, 'b, 'c, ES: Deref, SP: Deref> ReadableArgs<(&'a ES, &'b SP, u32, &'c Ch
 channel_type: channel_type.unwrap(),
 channel_keys_id,

 local_initiated_shutdown,

 blocked_monitor_updates: blocked_monitor_updates.unwrap(),
 }
 })
Expand Down

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

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -11856,8 +11856,8 @@ mod tests {
 }
 let (_nodes_1_update, _none) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());

 check_closed_event!(nodes[0], 1, ClosureReason::CooperativeClosure, [nodes[1].node.get_our_node_id()], 1000000);
 check_closed_event!(nodes[1], 1, ClosureReason::CooperativeClosure, [nodes[0].node.get_our_node_id()], 1000000);
 check_closed_event!(nodes[0], 1, ClosureReason::LocallyInitiatedCooperativeClosure, [nodes[1].node.get_our_node_id()], 1000000);
 check_closed_event!(nodes[1], 1, ClosureReason::CounterpartyInitiatedCooperativeClosure, [nodes[0].node.get_our_node_id()], 1000000);
	}

	fn check_not_connected_to_peer_error<T>(res_err: Result<T, APIError>, expected_public_key: PublicKey) {
Expand Down

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

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -871,8 +871,8 @@ fn test_update_fee_with_fundee_update_add_htlc() {
	send_payment(&nodes[1], &vec!(&nodes[0])[..], 800000);
	send_payment(&nodes[0], &vec!(&nodes[1])[..], 800000);
	close_channel(&nodes[0], &nodes[1], &chan.2, chan.3, true);
	check_closed_event!(nodes[0], 1, ClosureReason::CooperativeClosure, [nodes[1].node.get_our_node_id()], 100000);
	check_closed_event!(nodes[1], 1, ClosureReason::CooperativeClosure, [nodes[0].node.get_our_node_id()], 100000);
	check_closed_event!(nodes[0], 1, ClosureReason::CounterpartyInitiatedCooperativeClosure, [nodes[1].node.get_our_node_id()], 100000);
	check_closed_event!(nodes[1], 1, ClosureReason::LocallyInitiatedCooperativeClosure, [nodes[0].node.get_our_node_id()], 100000);
}

#[test]
Expand DownExpand Up@@ -985,8 +985,8 @@ fn test_update_fee() {
	assert_eq!(get_feerate!(nodes[0], nodes[1], channel_id), feerate + 30);
	assert_eq!(get_feerate!(nodes[1], nodes[0], channel_id), feerate + 30);
	close_channel(&nodes[0], &nodes[1], &chan.2, chan.3, true);
	check_closed_event!(nodes[0], 1, ClosureReason::CooperativeClosure, [nodes[1].node.get_our_node_id()], 100000);
	check_closed_event!(nodes[1], 1, ClosureReason::CooperativeClosure, [nodes[0].node.get_our_node_id()], 100000);
	check_closed_event!(nodes[0], 1, ClosureReason::CounterpartyInitiatedCooperativeClosure, [nodes[1].node.get_our_node_id()], 100000);
	check_closed_event!(nodes[1], 1, ClosureReason::LocallyInitiatedCooperativeClosure, [nodes[0].node.get_our_node_id()], 100000);
}

#[test]
Expand DownExpand Up@@ -1104,17 +1104,17 @@ fn fake_network_test() {

	// Close down the channels...
	close_channel(&nodes[0], &nodes[1], &chan_1.2, chan_1.3, true);
	check_closed_event!(nodes[0], 1, ClosureReason::CooperativeClosure, [nodes[1].node.get_our_node_id()], 100000);
	check_closed_event!(nodes[1], 1, ClosureReason::CooperativeClosure, [nodes[0].node.get_our_node_id()], 100000);
	check_closed_event!(nodes[0], 1, ClosureReason::CounterpartyInitiatedCooperativeClosure, [nodes[1].node.get_our_node_id()], 100000);
	check_closed_event!(nodes[1], 1, ClosureReason::LocallyInitiatedCooperativeClosure, [nodes[0].node.get_our_node_id()], 100000);
	close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, false);
	check_closed_event!(nodes[1], 1, ClosureReason::CooperativeClosure, [nodes[2].node.get_our_node_id()], 100000);
	check_closed_event!(nodes[2], 1, ClosureReason::CooperativeClosure, [nodes[1].node.get_our_node_id()], 100000);
	check_closed_event!(nodes[1], 1, ClosureReason::LocallyInitiatedCooperativeClosure, [nodes[2].node.get_our_node_id()], 100000);
	check_closed_event!(nodes[2], 1, ClosureReason::CounterpartyInitiatedCooperativeClosure, [nodes[1].node.get_our_node_id()], 100000);
	close_channel(&nodes[2], &nodes[3], &chan_3.2, chan_3.3, true);
	check_closed_event!(nodes[2], 1, ClosureReason::CooperativeClosure, [nodes[3].node.get_our_node_id()], 100000);
	check_closed_event!(nodes[3], 1, ClosureReason::CooperativeClosure, [nodes[2].node.get_our_node_id()], 100000);
	check_closed_event!(nodes[2], 1, ClosureReason::CounterpartyInitiatedCooperativeClosure, [nodes[3].node.get_our_node_id()], 100000);
	check_closed_event!(nodes[3], 1, ClosureReason::LocallyInitiatedCooperativeClosure, [nodes[2].node.get_our_node_id()], 100000);
	close_channel(&nodes[1], &nodes[3], &chan_4.2, chan_4.3, false);
	check_closed_event!(nodes[1], 1, ClosureReason::CooperativeClosure, [nodes[3].node.get_our_node_id()], 100000);
	check_closed_event!(nodes[3], 1, ClosureReason::CooperativeClosure, [nodes[1].node.get_our_node_id()], 100000);
	check_closed_event!(nodes[1], 1, ClosureReason::LocallyInitiatedCooperativeClosure, [nodes[3].node.get_our_node_id()], 100000);
	check_closed_event!(nodes[3], 1, ClosureReason::CounterpartyInitiatedCooperativeClosure, [nodes[1].node.get_our_node_id()], 100000);
}

#[test]
Expand DownExpand Up@@ -5619,15 +5619,15 @@ fn test_static_output_closing_tx() {
	let closing_tx = close_channel(&nodes[0], &nodes[1], &chan.2, chan.3, true).2;

	mine_transaction(&nodes[0], &closing_tx);
	check_closed_event!(nodes[0], 1, ClosureReason::CooperativeClosure, [nodes[1].node.get_our_node_id()], 100000);
	check_closed_event!(nodes[0], 1, ClosureReason::CounterpartyInitiatedCooperativeClosure, [nodes[1].node.get_our_node_id()], 100000);
	connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);

	let spend_txn = check_spendable_outputs!(nodes[0], node_cfgs[0].keys_manager);
	assert_eq!(spend_txn.len(), 1);
	check_spends!(spend_txn[0], closing_tx);

	mine_transaction(&nodes[1], &closing_tx);
	check_closed_event!(nodes[1], 1, ClosureReason::CooperativeClosure, [nodes[0].node.get_our_node_id()], 100000);
	check_closed_event!(nodes[1], 1, ClosureReason::LocallyInitiatedCooperativeClosure, [nodes[0].node.get_our_node_id()], 100000);
	connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);

	let spend_txn = check_spendable_outputs!(nodes[1], node_cfgs[1].keys_manager);
Expand Down

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

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -257,8 +257,8 @@ fn do_chanmon_claim_value_coop_close(anchors: bool) {
 spendable_outputs_b
	);

	check_closed_event!(nodes[0], 1, ClosureReason::CooperativeClosure, [nodes[1].node.get_our_node_id()], 1000000);
	check_closed_event!(nodes[1], 1, ClosureReason::CooperativeClosure, [nodes[0].node.get_our_node_id()], 1000000);
	check_closed_event!(nodes[0], 1, ClosureReason::LocallyInitiatedCooperativeClosure, [nodes[1].node.get_our_node_id()], 1000000);
	check_closed_event!(nodes[1], 1, ClosureReason::CounterpartyInitiatedCooperativeClosure, [nodes[0].node.get_our_node_id()], 1000000);
}

#[test]
Expand Down
Loading

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

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

TheBlueMatt
merged 2 commits into

from

Feb 5, 2024
 Merged


Breakup CooperativeClosure into Local/Remote initiated
#2863
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
58f7942

Breakup CooperativeClosure into Local/Remote initiated


benthecarman Jan 31, 2024
efcb5d9

Rename old CooperativeClosure to LegacyCooperativeClosure


benthecarman Feb 4, 2024

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


21 changes: 16 additions & 5 deletions
lightning/src/events/mod.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -184,8 +184,15 @@ pub enum ClosureReason {
	HolderForceClosed,
	/// The channel was closed after negotiating a cooperative close and we've now broadcasted
	/// the cooperative close transaction. Note the shutdown may have been initiated by us.
	//TODO: split between CounterpartyInitiated/LocallyInitiated
	CooperativeClosure,
	// Can be removed once we disallow downgrading to 0.0.121
	LegacyCooperativeClosure,
Comment thread
benthecarman marked this conversation as resolved.

	/// The channel was closed after negotiating a cooperative close and we've now broadcasted
	/// the cooperative close transaction. This indicates that the shutdown was initiated by our
	/// counterparty.
@TheBlueMattTheBlueMattFeb 5, 2024

Copy link


Copy Markdown

Collaborator
Choose a reason for hiding this comment

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


Suggested change

/// counterparty.
/// counterparty.
///
/// In rare cases where we sent our peer a `shutdown`, crashed, then restarted this reason may be given even though we initiated the shutdown.
	CounterpartyInitiatedCooperativeClosure,
	/// The channel was closed after negotiating a cooperative close and we've now broadcasted
	/// the cooperative close transaction. This indicates that the shutdown was initiated by us.
	LocallyInitiatedCooperativeClosure,
	/// A commitment transaction was confirmed on chain, closing the channel. Most likely this
	/// commitment transaction came from our counterparty, but it may also have come from
	/// a copy of our own `ChannelMonitor`.
Expand DownExpand Up@@ -230,7 +237,9 @@ impl core::fmt::Display for ClosureReason {
 f.write_fmt(format_args!("counterparty force-closed with message: {}", peer_msg))
 },
 ClosureReason::HolderForceClosed => f.write_str("user manually force-closed the channel"),
 ClosureReason::CooperativeClosure => f.write_str("the channel was cooperatively closed"),
 ClosureReason::LegacyCooperativeClosure => f.write_str("the channel was cooperatively closed"),
 ClosureReason::CounterpartyInitiatedCooperativeClosure => f.write_str("the channel was cooperatively closed by our peer"),
 ClosureReason::LocallyInitiatedCooperativeClosure => f.write_str("the channel was cooperatively closed by us"),
 ClosureReason::CommitmentTxConfirmed => f.write_str("commitment or closing transaction was confirmed on chain."),
 ClosureReason::FundingTimedOut => write!(f, "funding transaction failed to confirm within {} blocks", FUNDING_CONF_DEADLINE_BLOCKS),
 ClosureReason::ProcessingError { err } => {
Expand All@@ -250,12 +259,14 @@ impl_writeable_tlv_based_enum_upgradable!(ClosureReason,
	(1, FundingTimedOut) => {},
	(2, HolderForceClosed) => {},
	(6, CommitmentTxConfirmed) => {},
	(4, CooperativeClosure) => {},
	(4, LegacyCooperativeClosure) => {},

Comment on lines

261
 to 
+262

@shaavanshaavanFeb 1, 2024

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

Unrelated nit:
Since we are touching these lines, should we think about reordering these enums? I think it's pretty odd to write 6th before 4th.

Suggested change

(6,CommitmentTxConfirmed) => {},
(4,CooperativeClosure) => {},
(4,LegacyCooperativeClosure) => {},
(4,LegacyCooperativeClosure) => {},
(6,CommitmentTxConfirmed) => {},
	(8, ProcessingError) => { (1, err, required) },
	(10, DisconnectedPeer) => {},
	(12, OutdatedChannelManager) => {},
	(13, CounterpartyCoopClosedUnfundedChannel) => {},
	(15, FundingBatchClosure) => {}
	(15, FundingBatchClosure) => {},
	(17, CounterpartyInitiatedCooperativeClosure) => {},
	(19, LocallyInitiatedCooperativeClosure) => {},
);

/// Intended destination of a failed HTLC as indicated in [`Event::HTLCHandlingFailed`].
Expand Down

8 changes: 4 additions & 4 deletions
lightning/src/ln/chanmon_update_fail_tests.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1955,8 +1955,8 @@ fn do_during_funding_monitor_fail(confirm_a_first: bool, restore_b_before_conf:

	send_payment(&nodes[0], &[&nodes[1]], 8000000);
	close_channel(&nodes[0], &nodes[1], &channel_id, funding_tx, true);
	check_closed_event!(nodes[0], 1, ClosureReason::CooperativeClosure, [nodes[1].node.get_our_node_id()], 100000);
	check_closed_event!(nodes[1], 1, ClosureReason::CooperativeClosure, [nodes[0].node.get_our_node_id()], 100000);
	check_closed_event!(nodes[0], 1, ClosureReason::CounterpartyInitiatedCooperativeClosure, [nodes[1].node.get_our_node_id()], 100000);
	check_closed_event!(nodes[1], 1, ClosureReason::LocallyInitiatedCooperativeClosure, [nodes[0].node.get_our_node_id()], 100000);
}

#[test]
Expand DownExpand Up@@ -2634,8 +2634,8 @@ fn test_temporary_error_during_shutdown() {
	assert_eq!(txn_a, txn_b);
	assert_eq!(txn_a.len(), 1);
	check_spends!(txn_a[0], funding_tx);
	check_closed_event!(nodes[1], 1, ClosureReason::CooperativeClosure, [nodes[0].node.get_our_node_id()], 100000);
	check_closed_event!(nodes[0], 1, ClosureReason::CooperativeClosure, [nodes[1].node.get_our_node_id()], 100000);
	check_closed_event!(nodes[1], 1, ClosureReason::CounterpartyInitiatedCooperativeClosure, [nodes[0].node.get_our_node_id()], 100000);
	check_closed_event!(nodes[0], 1, ClosureReason::LocallyInitiatedCooperativeClosure, [nodes[1].node.get_our_node_id()], 100000);
}

#[test]
Expand Down

28 changes: 26 additions & 2 deletions
lightning/src/ln/channel.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1256,6 +1256,9 @@ pub(super) struct ChannelContext<SP: Deref> where SP::Target: SignerProvider {
	// We track whether we already emitted a `ChannelReady` event.
	channel_ready_event_emitted: bool,

	/// Some if we initiated to shut down the channel.
	local_initiated_shutdown: Option<()>,

	/// The unique identifier used to re-derive the private key material for the channel through
	/// [`SignerProvider::derive_channel_signer`].
	channel_keys_id: [u8; 32],
Expand DownExpand Up@@ -4959,11 +4962,17 @@ impl<SP: Deref> Channel<SP> where
 }
 }

 let closure_reason = if self.initiated_shutdown() {
 ClosureReason::LocallyInitiatedCooperativeClosure
 } else {
 ClosureReason::CounterpartyInitiatedCooperativeClosure
 };

 assert!(self.context.shutdown_scriptpubkey.is_some());
 if let Some((last_fee, sig)) = self.context.last_sent_closing_fee {
 if last_fee == msg.fee_satoshis {
 let shutdown_result = ShutdownResult {
 closure_reason: ClosureReason::CooperativeClosure,
 closure_reason,
 monitor_update: None,
 dropped_outbound_htlcs: Vec::new(),
 unbroadcasted_batch_funding_txid: self.context.unbroadcasted_batch_funding_txid(),
Expand DownExpand Up@@ -4998,7 +5007,7 @@ impl<SP: Deref> Channel<SP> where
 .map_err(|_| ChannelError::Close("External signer refused to sign closing transaction".to_owned()))?;
 let (signed_tx, shutdown_result) = if $new_fee == msg.fee_satoshis {
 let shutdown_result = ShutdownResult {
 closure_reason: ClosureReason::CooperativeClosure,
 closure_reason,
 monitor_update: None,
 dropped_outbound_htlcs: Vec::new(),
 unbroadcasted_batch_funding_txid: self.context.unbroadcasted_batch_funding_txid(),
Expand DownExpand Up@@ -5263,6 +5272,11 @@ impl<SP: Deref> Channel<SP> where
 self.context.channel_state.is_local_shutdown_sent()
	}

	/// Returns true if we initiated to shut down the channel.
	pub fn initiated_shutdown(&self) -> bool {
 self.context.local_initiated_shutdown.is_some()
	}

	/// Returns true if this channel is fully shut down. True here implies that no further actions
	/// may/will be taken on this channel, and thus this object should be freed. Any future changes
	/// will be handled appropriately by the chain monitor.
Expand DownExpand Up@@ -6177,6 +6191,7 @@ impl<SP: Deref> Channel<SP> where
 // From here on out, we may not fail!
 self.context.target_closing_feerate_sats_per_kw = target_feerate_sats_per_kw;
 self.context.channel_state.set_local_shutdown_sent();
 self.context.local_initiated_shutdown = Some(());
 self.context.update_time_counter += 1;

 let monitor_update = if update_shutdown_script {
Expand DownExpand Up@@ -6437,6 +6452,7 @@ impl<SP: Deref> OutboundV1Channel<SP> where SP::Target: SignerProvider {
 channel_keys_id,

 blocked_monitor_updates: Vec::new(),
 local_initiated_shutdown: None,
 },
 unfunded_context: UnfundedChannelContext { unfunded_channel_age_ticks: 0 }
 })
Expand DownExpand Up@@ -7237,6 +7253,8 @@ impl<SP: Deref> InboundV1Channel<SP> where SP::Target: SignerProvider {
 channel_type,
 channel_keys_id,

 local_initiated_shutdown: None,

 blocked_monitor_updates: Vec::new(),
 },
 unfunded_context: UnfundedChannelContext { unfunded_channel_age_ticks: 0 }
Expand DownExpand Up@@ -7811,6 +7829,7 @@ impl<SP: Deref> Writeable for Channel<SP> where SP::Target: SignerProvider {
 (39, pending_outbound_blinding_points, optional_vec),
 (41, holding_cell_blinding_points, optional_vec),
 (43, malformed_htlcs, optional_vec), // Added in 0.0.119
 (45, self.context.local_initiated_shutdown, option), // Added in 0.0.122
 });

 Ok(())
Expand DownExpand Up@@ -8098,6 +8117,8 @@ impl<'a, 'b, 'c, ES: Deref, SP: Deref> ReadableArgs<(&'a ES, &'b SP, u32, &'c Ch

 let mut is_batch_funding: Option<()> = None;

 let mut local_initiated_shutdown: Option<()> = None;

 let mut pending_outbound_blinding_points_opt: Option<Vec<Option<PublicKey>>> = None;
 let mut holding_cell_blinding_points_opt: Option<Vec<Option<PublicKey>>> = None;

Expand DownExpand Up@@ -8132,6 +8153,7 @@ impl<'a, 'b, 'c, ES: Deref, SP: Deref> ReadableArgs<(&'a ES, &'b SP, u32, &'c Ch
 (39, pending_outbound_blinding_points_opt, optional_vec),
 (41, holding_cell_blinding_points_opt, optional_vec),
 (43, malformed_htlcs, optional_vec), // Added in 0.0.119
 (45, local_initiated_shutdown, option),
 });

 let (channel_keys_id, holder_signer) = if let Some(channel_keys_id) = channel_keys_id {
Expand DownExpand Up@@ -8362,6 +8384,8 @@ impl<'a, 'b, 'c, ES: Deref, SP: Deref> ReadableArgs<(&'a ES, &'b SP, u32, &'c Ch
 channel_type: channel_type.unwrap(),
 channel_keys_id,

 local_initiated_shutdown,

 blocked_monitor_updates: blocked_monitor_updates.unwrap(),
 }
 })
Expand Down

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

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -11856,8 +11856,8 @@ mod tests {
 }
 let (_nodes_1_update, _none) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());

 check_closed_event!(nodes[0], 1, ClosureReason::CooperativeClosure, [nodes[1].node.get_our_node_id()], 1000000);
 check_closed_event!(nodes[1], 1, ClosureReason::CooperativeClosure, [nodes[0].node.get_our_node_id()], 1000000);
 check_closed_event!(nodes[0], 1, ClosureReason::LocallyInitiatedCooperativeClosure, [nodes[1].node.get_our_node_id()], 1000000);
 check_closed_event!(nodes[1], 1, ClosureReason::CounterpartyInitiatedCooperativeClosure, [nodes[0].node.get_our_node_id()], 1000000);
	}

	fn check_not_connected_to_peer_error<T>(res_err: Result<T, APIError>, expected_public_key: PublicKey) {
Expand Down

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

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -871,8 +871,8 @@ fn test_update_fee_with_fundee_update_add_htlc() {
	send_payment(&nodes[1], &vec!(&nodes[0])[..], 800000);
	send_payment(&nodes[0], &vec!(&nodes[1])[..], 800000);
	close_channel(&nodes[0], &nodes[1], &chan.2, chan.3, true);
	check_closed_event!(nodes[0], 1, ClosureReason::CooperativeClosure, [nodes[1].node.get_our_node_id()], 100000);
	check_closed_event!(nodes[1], 1, ClosureReason::CooperativeClosure, [nodes[0].node.get_our_node_id()], 100000);
	check_closed_event!(nodes[0], 1, ClosureReason::CounterpartyInitiatedCooperativeClosure, [nodes[1].node.get_our_node_id()], 100000);
	check_closed_event!(nodes[1], 1, ClosureReason::LocallyInitiatedCooperativeClosure, [nodes[0].node.get_our_node_id()], 100000);
}

#[test]
Expand DownExpand Up@@ -985,8 +985,8 @@ fn test_update_fee() {
	assert_eq!(get_feerate!(nodes[0], nodes[1], channel_id), feerate + 30);
	assert_eq!(get_feerate!(nodes[1], nodes[0], channel_id), feerate + 30);
	close_channel(&nodes[0], &nodes[1], &chan.2, chan.3, true);
	check_closed_event!(nodes[0], 1, ClosureReason::CooperativeClosure, [nodes[1].node.get_our_node_id()], 100000);
	check_closed_event!(nodes[1], 1, ClosureReason::CooperativeClosure, [nodes[0].node.get_our_node_id()], 100000);
	check_closed_event!(nodes[0], 1, ClosureReason::CounterpartyInitiatedCooperativeClosure, [nodes[1].node.get_our_node_id()], 100000);
	check_closed_event!(nodes[1], 1, ClosureReason::LocallyInitiatedCooperativeClosure, [nodes[0].node.get_our_node_id()], 100000);
}

#[test]
Expand DownExpand Up@@ -1104,17 +1104,17 @@ fn fake_network_test() {

	// Close down the channels...
	close_channel(&nodes[0], &nodes[1], &chan_1.2, chan_1.3, true);
	check_closed_event!(nodes[0], 1, ClosureReason::CooperativeClosure, [nodes[1].node.get_our_node_id()], 100000);
	check_closed_event!(nodes[1], 1, ClosureReason::CooperativeClosure, [nodes[0].node.get_our_node_id()], 100000);
	check_closed_event!(nodes[0], 1, ClosureReason::CounterpartyInitiatedCooperativeClosure, [nodes[1].node.get_our_node_id()], 100000);
	check_closed_event!(nodes[1], 1, ClosureReason::LocallyInitiatedCooperativeClosure, [nodes[0].node.get_our_node_id()], 100000);
	close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, false);
	check_closed_event!(nodes[1], 1, ClosureReason::CooperativeClosure, [nodes[2].node.get_our_node_id()], 100000);
	check_closed_event!(nodes[2], 1, ClosureReason::CooperativeClosure, [nodes[1].node.get_our_node_id()], 100000);
	check_closed_event!(nodes[1], 1, ClosureReason::LocallyInitiatedCooperativeClosure, [nodes[2].node.get_our_node_id()], 100000);
	check_closed_event!(nodes[2], 1, ClosureReason::CounterpartyInitiatedCooperativeClosure, [nodes[1].node.get_our_node_id()], 100000);
	close_channel(&nodes[2], &nodes[3], &chan_3.2, chan_3.3, true);
	check_closed_event!(nodes[2], 1, ClosureReason::CooperativeClosure, [nodes[3].node.get_our_node_id()], 100000);
	check_closed_event!(nodes[3], 1, ClosureReason::CooperativeClosure, [nodes[2].node.get_our_node_id()], 100000);
	check_closed_event!(nodes[2], 1, ClosureReason::CounterpartyInitiatedCooperativeClosure, [nodes[3].node.get_our_node_id()], 100000);
	check_closed_event!(nodes[3], 1, ClosureReason::LocallyInitiatedCooperativeClosure, [nodes[2].node.get_our_node_id()], 100000);
	close_channel(&nodes[1], &nodes[3], &chan_4.2, chan_4.3, false);
	check_closed_event!(nodes[1], 1, ClosureReason::CooperativeClosure, [nodes[3].node.get_our_node_id()], 100000);
	check_closed_event!(nodes[3], 1, ClosureReason::CooperativeClosure, [nodes[1].node.get_our_node_id()], 100000);
	check_closed_event!(nodes[1], 1, ClosureReason::LocallyInitiatedCooperativeClosure, [nodes[3].node.get_our_node_id()], 100000);
	check_closed_event!(nodes[3], 1, ClosureReason::CounterpartyInitiatedCooperativeClosure, [nodes[1].node.get_our_node_id()], 100000);
}

#[test]
Expand DownExpand Up@@ -5619,15 +5619,15 @@ fn test_static_output_closing_tx() {
	let closing_tx = close_channel(&nodes[0], &nodes[1], &chan.2, chan.3, true).2;

	mine_transaction(&nodes[0], &closing_tx);
	check_closed_event!(nodes[0], 1, ClosureReason::CooperativeClosure, [nodes[1].node.get_our_node_id()], 100000);
	check_closed_event!(nodes[0], 1, ClosureReason::CounterpartyInitiatedCooperativeClosure, [nodes[1].node.get_our_node_id()], 100000);
	connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);

	let spend_txn = check_spendable_outputs!(nodes[0], node_cfgs[0].keys_manager);
	assert_eq!(spend_txn.len(), 1);
	check_spends!(spend_txn[0], closing_tx);

	mine_transaction(&nodes[1], &closing_tx);
	check_closed_event!(nodes[1], 1, ClosureReason::CooperativeClosure, [nodes[0].node.get_our_node_id()], 100000);
	check_closed_event!(nodes[1], 1, ClosureReason::LocallyInitiatedCooperativeClosure, [nodes[0].node.get_our_node_id()], 100000);
	connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);

	let spend_txn = check_spendable_outputs!(nodes[1], node_cfgs[1].keys_manager);
Expand Down

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

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -257,8 +257,8 @@ fn do_chanmon_claim_value_coop_close(anchors: bool) {
 spendable_outputs_b
	);

	check_closed_event!(nodes[0], 1, ClosureReason::CooperativeClosure, [nodes[1].node.get_our_node_id()], 1000000);
	check_closed_event!(nodes[1], 1, ClosureReason::CooperativeClosure, [nodes[0].node.get_our_node_id()], 1000000);
	check_closed_event!(nodes[0], 1, ClosureReason::LocallyInitiatedCooperativeClosure, [nodes[1].node.get_our_node_id()], 1000000);
	check_closed_event!(nodes[1], 1, ClosureReason::CounterpartyInitiatedCooperativeClosure, [nodes[0].node.get_our_node_id()], 1000000);
}

#[test]
Expand Down
Loading

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

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

TheBlueMatt
merged 2 commits into

from

Feb 5, 2024
 Merged


Breakup CooperativeClosure into Local/Remote initiated
#2863
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
58f7942

Breakup CooperativeClosure into Local/Remote initiated


benthecarman Jan 31, 2024
efcb5d9

Rename old CooperativeClosure to LegacyCooperativeClosure


benthecarman Feb 4, 2024

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


21 changes: 16 additions & 5 deletions
lightning/src/events/mod.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -184,8 +184,15 @@ pub enum ClosureReason {
	HolderForceClosed,
	/// The channel was closed after negotiating a cooperative close and we've now broadcasted
	/// the cooperative close transaction. Note the shutdown may have been initiated by us.
	//TODO: split between CounterpartyInitiated/LocallyInitiated
	CooperativeClosure,
	// Can be removed once we disallow downgrading to 0.0.121
	LegacyCooperativeClosure,
Comment thread
benthecarman marked this conversation as resolved.

	/// The channel was closed after negotiating a cooperative close and we've now broadcasted
	/// the cooperative close transaction. This indicates that the shutdown was initiated by our
	/// counterparty.
@TheBlueMattTheBlueMattFeb 5, 2024

Copy link


Copy Markdown

Collaborator
Choose a reason for hiding this comment

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


Suggested change

/// counterparty.
/// counterparty.
///
/// In rare cases where we sent our peer a `shutdown`, crashed, then restarted this reason may be given even though we initiated the shutdown.
	CounterpartyInitiatedCooperativeClosure,
	/// The channel was closed after negotiating a cooperative close and we've now broadcasted
	/// the cooperative close transaction. This indicates that the shutdown was initiated by us.
	LocallyInitiatedCooperativeClosure,
	/// A commitment transaction was confirmed on chain, closing the channel. Most likely this
	/// commitment transaction came from our counterparty, but it may also have come from
	/// a copy of our own `ChannelMonitor`.
Expand DownExpand Up@@ -230,7 +237,9 @@ impl core::fmt::Display for ClosureReason {
 f.write_fmt(format_args!("counterparty force-closed with message: {}", peer_msg))
 },
 ClosureReason::HolderForceClosed => f.write_str("user manually force-closed the channel"),
 ClosureReason::CooperativeClosure => f.write_str("the channel was cooperatively closed"),
 ClosureReason::LegacyCooperativeClosure => f.write_str("the channel was cooperatively closed"),
 ClosureReason::CounterpartyInitiatedCooperativeClosure => f.write_str("the channel was cooperatively closed by our peer"),
 ClosureReason::LocallyInitiatedCooperativeClosure => f.write_str("the channel was cooperatively closed by us"),
 ClosureReason::CommitmentTxConfirmed => f.write_str("commitment or closing transaction was confirmed on chain."),
 ClosureReason::FundingTimedOut => write!(f, "funding transaction failed to confirm within {} blocks", FUNDING_CONF_DEADLINE_BLOCKS),
 ClosureReason::ProcessingError { err } => {
Expand All@@ -250,12 +259,14 @@ impl_writeable_tlv_based_enum_upgradable!(ClosureReason,
	(1, FundingTimedOut) => {},
	(2, HolderForceClosed) => {},
	(6, CommitmentTxConfirmed) => {},
	(4, CooperativeClosure) => {},
	(4, LegacyCooperativeClosure) => {},

Comment on lines

261
 to 
+262

@shaavanshaavanFeb 1, 2024

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

Unrelated nit:
Since we are touching these lines, should we think about reordering these enums? I think it's pretty odd to write 6th before 4th.

Suggested change

(6,CommitmentTxConfirmed) => {},
(4,CooperativeClosure) => {},
(4,LegacyCooperativeClosure) => {},
(4,LegacyCooperativeClosure) => {},
(6,CommitmentTxConfirmed) => {},
	(8, ProcessingError) => { (1, err, required) },
	(10, DisconnectedPeer) => {},
	(12, OutdatedChannelManager) => {},
	(13, CounterpartyCoopClosedUnfundedChannel) => {},
	(15, FundingBatchClosure) => {}
	(15, FundingBatchClosure) => {},
	(17, CounterpartyInitiatedCooperativeClosure) => {},
	(19, LocallyInitiatedCooperativeClosure) => {},
);

/// Intended destination of a failed HTLC as indicated in [`Event::HTLCHandlingFailed`].
Expand Down

8 changes: 4 additions & 4 deletions
lightning/src/ln/chanmon_update_fail_tests.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1955,8 +1955,8 @@ fn do_during_funding_monitor_fail(confirm_a_first: bool, restore_b_before_conf:

	send_payment(&nodes[0], &[&nodes[1]], 8000000);
	close_channel(&nodes[0], &nodes[1], &channel_id, funding_tx, true);
	check_closed_event!(nodes[0], 1, ClosureReason::CooperativeClosure, [nodes[1].node.get_our_node_id()], 100000);
	check_closed_event!(nodes[1], 1, ClosureReason::CooperativeClosure, [nodes[0].node.get_our_node_id()], 100000);
	check_closed_event!(nodes[0], 1, ClosureReason::CounterpartyInitiatedCooperativeClosure, [nodes[1].node.get_our_node_id()], 100000);
	check_closed_event!(nodes[1], 1, ClosureReason::LocallyInitiatedCooperativeClosure, [nodes[0].node.get_our_node_id()], 100000);
}

#[test]
Expand DownExpand Up@@ -2634,8 +2634,8 @@ fn test_temporary_error_during_shutdown() {
	assert_eq!(txn_a, txn_b);
	assert_eq!(txn_a.len(), 1);
	check_spends!(txn_a[0], funding_tx);
	check_closed_event!(nodes[1], 1, ClosureReason::CooperativeClosure, [nodes[0].node.get_our_node_id()], 100000);
	check_closed_event!(nodes[0], 1, ClosureReason::CooperativeClosure, [nodes[1].node.get_our_node_id()], 100000);
	check_closed_event!(nodes[1], 1, ClosureReason::CounterpartyInitiatedCooperativeClosure, [nodes[0].node.get_our_node_id()], 100000);
	check_closed_event!(nodes[0], 1, ClosureReason::LocallyInitiatedCooperativeClosure, [nodes[1].node.get_our_node_id()], 100000);
}

#[test]
Expand Down

28 changes: 26 additions & 2 deletions
lightning/src/ln/channel.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1256,6 +1256,9 @@ pub(super) struct ChannelContext<SP: Deref> where SP::Target: SignerProvider {
	// We track whether we already emitted a `ChannelReady` event.
	channel_ready_event_emitted: bool,

	/// Some if we initiated to shut down the channel.
	local_initiated_shutdown: Option<()>,

	/// The unique identifier used to re-derive the private key material for the channel through
	/// [`SignerProvider::derive_channel_signer`].
	channel_keys_id: [u8; 32],
Expand DownExpand Up@@ -4959,11 +4962,17 @@ impl<SP: Deref> Channel<SP> where
 }
 }

 let closure_reason = if self.initiated_shutdown() {
 ClosureReason::LocallyInitiatedCooperativeClosure
 } else {
 ClosureReason::CounterpartyInitiatedCooperativeClosure
 };

 assert!(self.context.shutdown_scriptpubkey.is_some());
 if let Some((last_fee, sig)) = self.context.last_sent_closing_fee {
 if last_fee == msg.fee_satoshis {
 let shutdown_result = ShutdownResult {
 closure_reason: ClosureReason::CooperativeClosure,
 closure_reason,
 monitor_update: None,
 dropped_outbound_htlcs: Vec::new(),
 unbroadcasted_batch_funding_txid: self.context.unbroadcasted_batch_funding_txid(),
Expand DownExpand Up@@ -4998,7 +5007,7 @@ impl<SP: Deref> Channel<SP> where
 .map_err(|_| ChannelError::Close("External signer refused to sign closing transaction".to_owned()))?;
 let (signed_tx, shutdown_result) = if $new_fee == msg.fee_satoshis {
 let shutdown_result = ShutdownResult {
 closure_reason: ClosureReason::CooperativeClosure,
 closure_reason,
 monitor_update: None,
 dropped_outbound_htlcs: Vec::new(),
 unbroadcasted_batch_funding_txid: self.context.unbroadcasted_batch_funding_txid(),
Expand DownExpand Up@@ -5263,6 +5272,11 @@ impl<SP: Deref> Channel<SP> where
 self.context.channel_state.is_local_shutdown_sent()
	}

	/// Returns true if we initiated to shut down the channel.
	pub fn initiated_shutdown(&self) -> bool {
 self.context.local_initiated_shutdown.is_some()
	}

	/// Returns true if this channel is fully shut down. True here implies that no further actions
	/// may/will be taken on this channel, and thus this object should be freed. Any future changes
	/// will be handled appropriately by the chain monitor.
Expand DownExpand Up@@ -6177,6 +6191,7 @@ impl<SP: Deref> Channel<SP> where
 // From here on out, we may not fail!
 self.context.target_closing_feerate_sats_per_kw = target_feerate_sats_per_kw;
 self.context.channel_state.set_local_shutdown_sent();
 self.context.local_initiated_shutdown = Some(());
 self.context.update_time_counter += 1;

 let monitor_update = if update_shutdown_script {
Expand DownExpand Up@@ -6437,6 +6452,7 @@ impl<SP: Deref> OutboundV1Channel<SP> where SP::Target: SignerProvider {
 channel_keys_id,

 blocked_monitor_updates: Vec::new(),
 local_initiated_shutdown: None,
 },
 unfunded_context: UnfundedChannelContext { unfunded_channel_age_ticks: 0 }
 })
Expand DownExpand Up@@ -7237,6 +7253,8 @@ impl<SP: Deref> InboundV1Channel<SP> where SP::Target: SignerProvider {
 channel_type,
 channel_keys_id,

 local_initiated_shutdown: None,

 blocked_monitor_updates: Vec::new(),
 },
 unfunded_context: UnfundedChannelContext { unfunded_channel_age_ticks: 0 }
Expand DownExpand Up@@ -7811,6 +7829,7 @@ impl<SP: Deref> Writeable for Channel<SP> where SP::Target: SignerProvider {
 (39, pending_outbound_blinding_points, optional_vec),
 (41, holding_cell_blinding_points, optional_vec),
 (43, malformed_htlcs, optional_vec), // Added in 0.0.119
 (45, self.context.local_initiated_shutdown, option), // Added in 0.0.122
 });

 Ok(())
Expand DownExpand Up@@ -8098,6 +8117,8 @@ impl<'a, 'b, 'c, ES: Deref, SP: Deref> ReadableArgs<(&'a ES, &'b SP, u32, &'c Ch

 let mut is_batch_funding: Option<()> = None;

 let mut local_initiated_shutdown: Option<()> = None;

 let mut pending_outbound_blinding_points_opt: Option<Vec<Option<PublicKey>>> = None;
 let mut holding_cell_blinding_points_opt: Option<Vec<Option<PublicKey>>> = None;

Expand DownExpand Up@@ -8132,6 +8153,7 @@ impl<'a, 'b, 'c, ES: Deref, SP: Deref> ReadableArgs<(&'a ES, &'b SP, u32, &'c Ch
 (39, pending_outbound_blinding_points_opt, optional_vec),
 (41, holding_cell_blinding_points_opt, optional_vec),
 (43, malformed_htlcs, optional_vec), // Added in 0.0.119
 (45, local_initiated_shutdown, option),
 });

 let (channel_keys_id, holder_signer) = if let Some(channel_keys_id) = channel_keys_id {
Expand DownExpand Up@@ -8362,6 +8384,8 @@ impl<'a, 'b, 'c, ES: Deref, SP: Deref> ReadableArgs<(&'a ES, &'b SP, u32, &'c Ch
 channel_type: channel_type.unwrap(),
 channel_keys_id,

 local_initiated_shutdown,

 blocked_monitor_updates: blocked_monitor_updates.unwrap(),
 }
 })
Expand Down

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

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -11856,8 +11856,8 @@ mod tests {
 }
 let (_nodes_1_update, _none) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());

 check_closed_event!(nodes[0], 1, ClosureReason::CooperativeClosure, [nodes[1].node.get_our_node_id()], 1000000);
 check_closed_event!(nodes[1], 1, ClosureReason::CooperativeClosure, [nodes[0].node.get_our_node_id()], 1000000);
 check_closed_event!(nodes[0], 1, ClosureReason::LocallyInitiatedCooperativeClosure, [nodes[1].node.get_our_node_id()], 1000000);
 check_closed_event!(nodes[1], 1, ClosureReason::CounterpartyInitiatedCooperativeClosure, [nodes[0].node.get_our_node_id()], 1000000);
	}

	fn check_not_connected_to_peer_error<T>(res_err: Result<T, APIError>, expected_public_key: PublicKey) {
Expand Down

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

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -871,8 +871,8 @@ fn test_update_fee_with_fundee_update_add_htlc() {
	send_payment(&nodes[1], &vec!(&nodes[0])[..], 800000);
	send_payment(&nodes[0], &vec!(&nodes[1])[..], 800000);
	close_channel(&nodes[0], &nodes[1], &chan.2, chan.3, true);
	check_closed_event!(nodes[0], 1, ClosureReason::CooperativeClosure, [nodes[1].node.get_our_node_id()], 100000);
	check_closed_event!(nodes[1], 1, ClosureReason::CooperativeClosure, [nodes[0].node.get_our_node_id()], 100000);
	check_closed_event!(nodes[0], 1, ClosureReason::CounterpartyInitiatedCooperativeClosure, [nodes[1].node.get_our_node_id()], 100000);
	check_closed_event!(nodes[1], 1, ClosureReason::LocallyInitiatedCooperativeClosure, [nodes[0].node.get_our_node_id()], 100000);
}

#[test]
Expand DownExpand Up@@ -985,8 +985,8 @@ fn test_update_fee() {
	assert_eq!(get_feerate!(nodes[0], nodes[1], channel_id), feerate + 30);
	assert_eq!(get_feerate!(nodes[1], nodes[0], channel_id), feerate + 30);
	close_channel(&nodes[0], &nodes[1], &chan.2, chan.3, true);
	check_closed_event!(nodes[0], 1, ClosureReason::CooperativeClosure, [nodes[1].node.get_our_node_id()], 100000);
	check_closed_event!(nodes[1], 1, ClosureReason::CooperativeClosure, [nodes[0].node.get_our_node_id()], 100000);
	check_closed_event!(nodes[0], 1, ClosureReason::CounterpartyInitiatedCooperativeClosure, [nodes[1].node.get_our_node_id()], 100000);
	check_closed_event!(nodes[1], 1, ClosureReason::LocallyInitiatedCooperativeClosure, [nodes[0].node.get_our_node_id()], 100000);
}

#[test]
Expand DownExpand Up@@ -1104,17 +1104,17 @@ fn fake_network_test() {

	// Close down the channels...
	close_channel(&nodes[0], &nodes[1], &chan_1.2, chan_1.3, true);
	check_closed_event!(nodes[0], 1, ClosureReason::CooperativeClosure, [nodes[1].node.get_our_node_id()], 100000);
	check_closed_event!(nodes[1], 1, ClosureReason::CooperativeClosure, [nodes[0].node.get_our_node_id()], 100000);
	check_closed_event!(nodes[0], 1, ClosureReason::CounterpartyInitiatedCooperativeClosure, [nodes[1].node.get_our_node_id()], 100000);
	check_closed_event!(nodes[1], 1, ClosureReason::LocallyInitiatedCooperativeClosure, [nodes[0].node.get_our_node_id()], 100000);
	close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, false);
	check_closed_event!(nodes[1], 1, ClosureReason::CooperativeClosure, [nodes[2].node.get_our_node_id()], 100000);
	check_closed_event!(nodes[2], 1, ClosureReason::CooperativeClosure, [nodes[1].node.get_our_node_id()], 100000);
	check_closed_event!(nodes[1], 1, ClosureReason::LocallyInitiatedCooperativeClosure, [nodes[2].node.get_our_node_id()], 100000);
	check_closed_event!(nodes[2], 1, ClosureReason::CounterpartyInitiatedCooperativeClosure, [nodes[1].node.get_our_node_id()], 100000);
	close_channel(&nodes[2], &nodes[3], &chan_3.2, chan_3.3, true);
	check_closed_event!(nodes[2], 1, ClosureReason::CooperativeClosure, [nodes[3].node.get_our_node_id()], 100000);
	check_closed_event!(nodes[3], 1, ClosureReason::CooperativeClosure, [nodes[2].node.get_our_node_id()], 100000);
	check_closed_event!(nodes[2], 1, ClosureReason::CounterpartyInitiatedCooperativeClosure, [nodes[3].node.get_our_node_id()], 100000);
	check_closed_event!(nodes[3], 1, ClosureReason::LocallyInitiatedCooperativeClosure, [nodes[2].node.get_our_node_id()], 100000);
	close_channel(&nodes[1], &nodes[3], &chan_4.2, chan_4.3, false);
	check_closed_event!(nodes[1], 1, ClosureReason::CooperativeClosure, [nodes[3].node.get_our_node_id()], 100000);
	check_closed_event!(nodes[3], 1, ClosureReason::CooperativeClosure, [nodes[1].node.get_our_node_id()], 100000);
	check_closed_event!(nodes[1], 1, ClosureReason::LocallyInitiatedCooperativeClosure, [nodes[3].node.get_our_node_id()], 100000);
	check_closed_event!(nodes[3], 1, ClosureReason::CounterpartyInitiatedCooperativeClosure, [nodes[1].node.get_our_node_id()], 100000);
}

#[test]
Expand DownExpand Up@@ -5619,15 +5619,15 @@ fn test_static_output_closing_tx() {
	let closing_tx = close_channel(&nodes[0], &nodes[1], &chan.2, chan.3, true).2;

	mine_transaction(&nodes[0], &closing_tx);
	check_closed_event!(nodes[0], 1, ClosureReason::CooperativeClosure, [nodes[1].node.get_our_node_id()], 100000);
	check_closed_event!(nodes[0], 1, ClosureReason::CounterpartyInitiatedCooperativeClosure, [nodes[1].node.get_our_node_id()], 100000);
	connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);

	let spend_txn = check_spendable_outputs!(nodes[0], node_cfgs[0].keys_manager);
	assert_eq!(spend_txn.len(), 1);
	check_spends!(spend_txn[0], closing_tx);

	mine_transaction(&nodes[1], &closing_tx);
	check_closed_event!(nodes[1], 1, ClosureReason::CooperativeClosure, [nodes[0].node.get_our_node_id()], 100000);
	check_closed_event!(nodes[1], 1, ClosureReason::LocallyInitiatedCooperativeClosure, [nodes[0].node.get_our_node_id()], 100000);
	connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);

	let spend_txn = check_spendable_outputs!(nodes[1], node_cfgs[1].keys_manager);
Expand Down

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

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -257,8 +257,8 @@ fn do_chanmon_claim_value_coop_close(anchors: bool) {
 spendable_outputs_b
	);

	check_closed_event!(nodes[0], 1, ClosureReason::CooperativeClosure, [nodes[1].node.get_our_node_id()], 1000000);
	check_closed_event!(nodes[1], 1, ClosureReason::CooperativeClosure, [nodes[0].node.get_our_node_id()], 1000000);
	check_closed_event!(nodes[0], 1, ClosureReason::LocallyInitiatedCooperativeClosure, [nodes[1].node.get_our_node_id()], 1000000);
	check_closed_event!(nodes[1], 1, ClosureReason::CounterpartyInitiatedCooperativeClosure, [nodes[0].node.get_our_node_id()], 1000000);
}

#[test]
Expand Down
Loading

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

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

TheBlueMatt
merged 2 commits into

from

Feb 5, 2024
 Merged


Breakup CooperativeClosure into Local/Remote initiated
#2863
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
58f7942

Breakup CooperativeClosure into Local/Remote initiated


benthecarman Jan 31, 2024
efcb5d9

Rename old CooperativeClosure to LegacyCooperativeClosure


benthecarman Feb 4, 2024

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


21 changes: 16 additions & 5 deletions
lightning/src/events/mod.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -184,8 +184,15 @@ pub enum ClosureReason {
	HolderForceClosed,
	/// The channel was closed after negotiating a cooperative close and we've now broadcasted
	/// the cooperative close transaction. Note the shutdown may have been initiated by us.
	//TODO: split between CounterpartyInitiated/LocallyInitiated
	CooperativeClosure,
	// Can be removed once we disallow downgrading to 0.0.121
	LegacyCooperativeClosure,
Comment thread
benthecarman marked this conversation as resolved.

	/// The channel was closed after negotiating a cooperative close and we've now broadcasted
	/// the cooperative close transaction. This indicates that the shutdown was initiated by our
	/// counterparty.
@TheBlueMattTheBlueMattFeb 5, 2024

Copy link


Copy Markdown

Collaborator
Choose a reason for hiding this comment

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


Suggested change

/// counterparty.
/// counterparty.
///
/// In rare cases where we sent our peer a `shutdown`, crashed, then restarted this reason may be given even though we initiated the shutdown.
	CounterpartyInitiatedCooperativeClosure,
	/// The channel was closed after negotiating a cooperative close and we've now broadcasted
	/// the cooperative close transaction. This indicates that the shutdown was initiated by us.
	LocallyInitiatedCooperativeClosure,
	/// A commitment transaction was confirmed on chain, closing the channel. Most likely this
	/// commitment transaction came from our counterparty, but it may also have come from
	/// a copy of our own `ChannelMonitor`.
Expand DownExpand Up@@ -230,7 +237,9 @@ impl core::fmt::Display for ClosureReason {
 f.write_fmt(format_args!("counterparty force-closed with message: {}", peer_msg))
 },
 ClosureReason::HolderForceClosed => f.write_str("user manually force-closed the channel"),
 ClosureReason::CooperativeClosure => f.write_str("the channel was cooperatively closed"),
 ClosureReason::LegacyCooperativeClosure => f.write_str("the channel was cooperatively closed"),
 ClosureReason::CounterpartyInitiatedCooperativeClosure => f.write_str("the channel was cooperatively closed by our peer"),
 ClosureReason::LocallyInitiatedCooperativeClosure => f.write_str("the channel was cooperatively closed by us"),
 ClosureReason::CommitmentTxConfirmed => f.write_str("commitment or closing transaction was confirmed on chain."),
 ClosureReason::FundingTimedOut => write!(f, "funding transaction failed to confirm within {} blocks", FUNDING_CONF_DEADLINE_BLOCKS),
 ClosureReason::ProcessingError { err } => {
Expand All@@ -250,12 +259,14 @@ impl_writeable_tlv_based_enum_upgradable!(ClosureReason,
	(1, FundingTimedOut) => {},
	(2, HolderForceClosed) => {},
	(6, CommitmentTxConfirmed) => {},
	(4, CooperativeClosure) => {},
	(4, LegacyCooperativeClosure) => {},

Comment on lines

261
 to 
+262

@shaavanshaavanFeb 1, 2024

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

Unrelated nit:
Since we are touching these lines, should we think about reordering these enums? I think it's pretty odd to write 6th before 4th.

Suggested change

(6,CommitmentTxConfirmed) => {},
(4,CooperativeClosure) => {},
(4,LegacyCooperativeClosure) => {},
(4,LegacyCooperativeClosure) => {},
(6,CommitmentTxConfirmed) => {},
	(8, ProcessingError) => { (1, err, required) },
	(10, DisconnectedPeer) => {},
	(12, OutdatedChannelManager) => {},
	(13, CounterpartyCoopClosedUnfundedChannel) => {},
	(15, FundingBatchClosure) => {}
	(15, FundingBatchClosure) => {},
	(17, CounterpartyInitiatedCooperativeClosure) => {},
	(19, LocallyInitiatedCooperativeClosure) => {},
);

/// Intended destination of a failed HTLC as indicated in [`Event::HTLCHandlingFailed`].
Expand Down

8 changes: 4 additions & 4 deletions
lightning/src/ln/chanmon_update_fail_tests.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1955,8 +1955,8 @@ fn do_during_funding_monitor_fail(confirm_a_first: bool, restore_b_before_conf:

	send_payment(&nodes[0], &[&nodes[1]], 8000000);
	close_channel(&nodes[0], &nodes[1], &channel_id, funding_tx, true);
	check_closed_event!(nodes[0], 1, ClosureReason::CooperativeClosure, [nodes[1].node.get_our_node_id()], 100000);
	check_closed_event!(nodes[1], 1, ClosureReason::CooperativeClosure, [nodes[0].node.get_our_node_id()], 100000);
	check_closed_event!(nodes[0], 1, ClosureReason::CounterpartyInitiatedCooperativeClosure, [nodes[1].node.get_our_node_id()], 100000);
	check_closed_event!(nodes[1], 1, ClosureReason::LocallyInitiatedCooperativeClosure, [nodes[0].node.get_our_node_id()], 100000);
}

#[test]
Expand DownExpand Up@@ -2634,8 +2634,8 @@ fn test_temporary_error_during_shutdown() {
	assert_eq!(txn_a, txn_b);
	assert_eq!(txn_a.len(), 1);
	check_spends!(txn_a[0], funding_tx);
	check_closed_event!(nodes[1], 1, ClosureReason::CooperativeClosure, [nodes[0].node.get_our_node_id()], 100000);
	check_closed_event!(nodes[0], 1, ClosureReason::CooperativeClosure, [nodes[1].node.get_our_node_id()], 100000);
	check_closed_event!(nodes[1], 1, ClosureReason::CounterpartyInitiatedCooperativeClosure, [nodes[0].node.get_our_node_id()], 100000);
	check_closed_event!(nodes[0], 1, ClosureReason::LocallyInitiatedCooperativeClosure, [nodes[1].node.get_our_node_id()], 100000);
}

#[test]
Expand Down

28 changes: 26 additions & 2 deletions
lightning/src/ln/channel.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1256,6 +1256,9 @@ pub(super) struct ChannelContext<SP: Deref> where SP::Target: SignerProvider {
	// We track whether we already emitted a `ChannelReady` event.
	channel_ready_event_emitted: bool,

	/// Some if we initiated to shut down the channel.
	local_initiated_shutdown: Option<()>,

	/// The unique identifier used to re-derive the private key material for the channel through
	/// [`SignerProvider::derive_channel_signer`].
	channel_keys_id: [u8; 32],
Expand DownExpand Up@@ -4959,11 +4962,17 @@ impl<SP: Deref> Channel<SP> where
 }
 }

 let closure_reason = if self.initiated_shutdown() {
 ClosureReason::LocallyInitiatedCooperativeClosure
 } else {
 ClosureReason::CounterpartyInitiatedCooperativeClosure
 };

 assert!(self.context.shutdown_scriptpubkey.is_some());
 if let Some((last_fee, sig)) = self.context.last_sent_closing_fee {
 if last_fee == msg.fee_satoshis {
 let shutdown_result = ShutdownResult {
 closure_reason: ClosureReason::CooperativeClosure,
 closure_reason,
 monitor_update: None,
 dropped_outbound_htlcs: Vec::new(),
 unbroadcasted_batch_funding_txid: self.context.unbroadcasted_batch_funding_txid(),
Expand DownExpand Up@@ -4998,7 +5007,7 @@ impl<SP: Deref> Channel<SP> where
 .map_err(|_| ChannelError::Close("External signer refused to sign closing transaction".to_owned()))?;
 let (signed_tx, shutdown_result) = if $new_fee == msg.fee_satoshis {
 let shutdown_result = ShutdownResult {
 closure_reason: ClosureReason::CooperativeClosure,
 closure_reason,
 monitor_update: None,
 dropped_outbound_htlcs: Vec::new(),
 unbroadcasted_batch_funding_txid: self.context.unbroadcasted_batch_funding_txid(),
Expand DownExpand Up@@ -5263,6 +5272,11 @@ impl<SP: Deref> Channel<SP> where
 self.context.channel_state.is_local_shutdown_sent()
	}

	/// Returns true if we initiated to shut down the channel.
	pub fn initiated_shutdown(&self) -> bool {
 self.context.local_initiated_shutdown.is_some()
	}

	/// Returns true if this channel is fully shut down. True here implies that no further actions
	/// may/will be taken on this channel, and thus this object should be freed. Any future changes
	/// will be handled appropriately by the chain monitor.
Expand DownExpand Up@@ -6177,6 +6191,7 @@ impl<SP: Deref> Channel<SP> where
 // From here on out, we may not fail!
 self.context.target_closing_feerate_sats_per_kw = target_feerate_sats_per_kw;
 self.context.channel_state.set_local_shutdown_sent();
 self.context.local_initiated_shutdown = Some(());
 self.context.update_time_counter += 1;

 let monitor_update = if update_shutdown_script {
Expand DownExpand Up@@ -6437,6 +6452,7 @@ impl<SP: Deref> OutboundV1Channel<SP> where SP::Target: SignerProvider {
 channel_keys_id,

 blocked_monitor_updates: Vec::new(),
 local_initiated_shutdown: None,
 },
 unfunded_context: UnfundedChannelContext { unfunded_channel_age_ticks: 0 }
 })
Expand DownExpand Up@@ -7237,6 +7253,8 @@ impl<SP: Deref> InboundV1Channel<SP> where SP::Target: SignerProvider {
 channel_type,
 channel_keys_id,

 local_initiated_shutdown: None,

 blocked_monitor_updates: Vec::new(),
 },
 unfunded_context: UnfundedChannelContext { unfunded_channel_age_ticks: 0 }
Expand DownExpand Up@@ -7811,6 +7829,7 @@ impl<SP: Deref> Writeable for Channel<SP> where SP::Target: SignerProvider {
 (39, pending_outbound_blinding_points, optional_vec),
 (41, holding_cell_blinding_points, optional_vec),
 (43, malformed_htlcs, optional_vec), // Added in 0.0.119
 (45, self.context.local_initiated_shutdown, option), // Added in 0.0.122
 });

 Ok(())
Expand DownExpand Up@@ -8098,6 +8117,8 @@ impl<'a, 'b, 'c, ES: Deref, SP: Deref> ReadableArgs<(&'a ES, &'b SP, u32, &'c Ch

 let mut is_batch_funding: Option<()> = None;

 let mut local_initiated_shutdown: Option<()> = None;

 let mut pending_outbound_blinding_points_opt: Option<Vec<Option<PublicKey>>> = None;
 let mut holding_cell_blinding_points_opt: Option<Vec<Option<PublicKey>>> = None;

Expand DownExpand Up@@ -8132,6 +8153,7 @@ impl<'a, 'b, 'c, ES: Deref, SP: Deref> ReadableArgs<(&'a ES, &'b SP, u32, &'c Ch
 (39, pending_outbound_blinding_points_opt, optional_vec),
 (41, holding_cell_blinding_points_opt, optional_vec),
 (43, malformed_htlcs, optional_vec), // Added in 0.0.119
 (45, local_initiated_shutdown, option),
 });

 let (channel_keys_id, holder_signer) = if let Some(channel_keys_id) = channel_keys_id {
Expand DownExpand Up@@ -8362,6 +8384,8 @@ impl<'a, 'b, 'c, ES: Deref, SP: Deref> ReadableArgs<(&'a ES, &'b SP, u32, &'c Ch
 channel_type: channel_type.unwrap(),
 channel_keys_id,

 local_initiated_shutdown,

 blocked_monitor_updates: blocked_monitor_updates.unwrap(),
 }
 })
Expand Down

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

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -11856,8 +11856,8 @@ mod tests {
 }
 let (_nodes_1_update, _none) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());

 check_closed_event!(nodes[0], 1, ClosureReason::CooperativeClosure, [nodes[1].node.get_our_node_id()], 1000000);
 check_closed_event!(nodes[1], 1, ClosureReason::CooperativeClosure, [nodes[0].node.get_our_node_id()], 1000000);
 check_closed_event!(nodes[0], 1, ClosureReason::LocallyInitiatedCooperativeClosure, [nodes[1].node.get_our_node_id()], 1000000);
 check_closed_event!(nodes[1], 1, ClosureReason::CounterpartyInitiatedCooperativeClosure, [nodes[0].node.get_our_node_id()], 1000000);
	}

	fn check_not_connected_to_peer_error<T>(res_err: Result<T, APIError>, expected_public_key: PublicKey) {
Expand Down

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

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -871,8 +871,8 @@ fn test_update_fee_with_fundee_update_add_htlc() {
	send_payment(&nodes[1], &vec!(&nodes[0])[..], 800000);
	send_payment(&nodes[0], &vec!(&nodes[1])[..], 800000);
	close_channel(&nodes[0], &nodes[1], &chan.2, chan.3, true);
	check_closed_event!(nodes[0], 1, ClosureReason::CooperativeClosure, [nodes[1].node.get_our_node_id()], 100000);
	check_closed_event!(nodes[1], 1, ClosureReason::CooperativeClosure, [nodes[0].node.get_our_node_id()], 100000);
	check_closed_event!(nodes[0], 1, ClosureReason::CounterpartyInitiatedCooperativeClosure, [nodes[1].node.get_our_node_id()], 100000);
	check_closed_event!(nodes[1], 1, ClosureReason::LocallyInitiatedCooperativeClosure, [nodes[0].node.get_our_node_id()], 100000);
}

#[test]
Expand DownExpand Up@@ -985,8 +985,8 @@ fn test_update_fee() {
	assert_eq!(get_feerate!(nodes[0], nodes[1], channel_id), feerate + 30);
	assert_eq!(get_feerate!(nodes[1], nodes[0], channel_id), feerate + 30);
	close_channel(&nodes[0], &nodes[1], &chan.2, chan.3, true);
	check_closed_event!(nodes[0], 1, ClosureReason::CooperativeClosure, [nodes[1].node.get_our_node_id()], 100000);
	check_closed_event!(nodes[1], 1, ClosureReason::CooperativeClosure, [nodes[0].node.get_our_node_id()], 100000);
	check_closed_event!(nodes[0], 1, ClosureReason::CounterpartyInitiatedCooperativeClosure, [nodes[1].node.get_our_node_id()], 100000);
	check_closed_event!(nodes[1], 1, ClosureReason::LocallyInitiatedCooperativeClosure, [nodes[0].node.get_our_node_id()], 100000);
}

#[test]
Expand DownExpand Up@@ -1104,17 +1104,17 @@ fn fake_network_test() {

	// Close down the channels...
	close_channel(&nodes[0], &nodes[1], &chan_1.2, chan_1.3, true);
	check_closed_event!(nodes[0], 1, ClosureReason::CooperativeClosure, [nodes[1].node.get_our_node_id()], 100000);
	check_closed_event!(nodes[1], 1, ClosureReason::CooperativeClosure, [nodes[0].node.get_our_node_id()], 100000);
	check_closed_event!(nodes[0], 1, ClosureReason::CounterpartyInitiatedCooperativeClosure, [nodes[1].node.get_our_node_id()], 100000);
	check_closed_event!(nodes[1], 1, ClosureReason::LocallyInitiatedCooperativeClosure, [nodes[0].node.get_our_node_id()], 100000);
	close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, false);
	check_closed_event!(nodes[1], 1, ClosureReason::CooperativeClosure, [nodes[2].node.get_our_node_id()], 100000);
	check_closed_event!(nodes[2], 1, ClosureReason::CooperativeClosure, [nodes[1].node.get_our_node_id()], 100000);
	check_closed_event!(nodes[1], 1, ClosureReason::LocallyInitiatedCooperativeClosure, [nodes[2].node.get_our_node_id()], 100000);
	check_closed_event!(nodes[2], 1, ClosureReason::CounterpartyInitiatedCooperativeClosure, [nodes[1].node.get_our_node_id()], 100000);
	close_channel(&nodes[2], &nodes[3], &chan_3.2, chan_3.3, true);
	check_closed_event!(nodes[2], 1, ClosureReason::CooperativeClosure, [nodes[3].node.get_our_node_id()], 100000);
	check_closed_event!(nodes[3], 1, ClosureReason::CooperativeClosure, [nodes[2].node.get_our_node_id()], 100000);
	check_closed_event!(nodes[2], 1, ClosureReason::CounterpartyInitiatedCooperativeClosure, [nodes[3].node.get_our_node_id()], 100000);
	check_closed_event!(nodes[3], 1, ClosureReason::LocallyInitiatedCooperativeClosure, [nodes[2].node.get_our_node_id()], 100000);
	close_channel(&nodes[1], &nodes[3], &chan_4.2, chan_4.3, false);
	check_closed_event!(nodes[1], 1, ClosureReason::CooperativeClosure, [nodes[3].node.get_our_node_id()], 100000);
	check_closed_event!(nodes[3], 1, ClosureReason::CooperativeClosure, [nodes[1].node.get_our_node_id()], 100000);
	check_closed_event!(nodes[1], 1, ClosureReason::LocallyInitiatedCooperativeClosure, [nodes[3].node.get_our_node_id()], 100000);
	check_closed_event!(nodes[3], 1, ClosureReason::CounterpartyInitiatedCooperativeClosure, [nodes[1].node.get_our_node_id()], 100000);
}

#[test]
Expand DownExpand Up@@ -5619,15 +5619,15 @@ fn test_static_output_closing_tx() {
	let closing_tx = close_channel(&nodes[0], &nodes[1], &chan.2, chan.3, true).2;

	mine_transaction(&nodes[0], &closing_tx);
	check_closed_event!(nodes[0], 1, ClosureReason::CooperativeClosure, [nodes[1].node.get_our_node_id()], 100000);
	check_closed_event!(nodes[0], 1, ClosureReason::CounterpartyInitiatedCooperativeClosure, [nodes[1].node.get_our_node_id()], 100000);
	connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);

	let spend_txn = check_spendable_outputs!(nodes[0], node_cfgs[0].keys_manager);
	assert_eq!(spend_txn.len(), 1);
	check_spends!(spend_txn[0], closing_tx);

	mine_transaction(&nodes[1], &closing_tx);
	check_closed_event!(nodes[1], 1, ClosureReason::CooperativeClosure, [nodes[0].node.get_our_node_id()], 100000);
	check_closed_event!(nodes[1], 1, ClosureReason::LocallyInitiatedCooperativeClosure, [nodes[0].node.get_our_node_id()], 100000);
	connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);

	let spend_txn = check_spendable_outputs!(nodes[1], node_cfgs[1].keys_manager);
Expand Down

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

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -257,8 +257,8 @@ fn do_chanmon_claim_value_coop_close(anchors: bool) {
 spendable_outputs_b
	);

	check_closed_event!(nodes[0], 1, ClosureReason::CooperativeClosure, [nodes[1].node.get_our_node_id()], 1000000);
	check_closed_event!(nodes[1], 1, ClosureReason::CooperativeClosure, [nodes[0].node.get_our_node_id()], 1000000);
	check_closed_event!(nodes[0], 1, ClosureReason::LocallyInitiatedCooperativeClosure, [nodes[1].node.get_our_node_id()], 1000000);
	check_closed_event!(nodes[1], 1, ClosureReason::CounterpartyInitiatedCooperativeClosure, [nodes[0].node.get_our_node_id()], 1000000);
}

#[test]
Expand Down
Loading