Add channel funding txo to Channel Event::ChannelClosed#2800

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 1 commit into from
Jan 11, 2024
Merged

Add channel funding txo to Channel Event::ChannelClosed #2800

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

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 11 additions & 3 deletions lightning/src/events/mod.rs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -24,6 +24,7 @@ use crate::ln::channel::FUNDING_CONF_DEADLINE_BLOCKS;
use crate::ln::features::ChannelTypeFeatures;
use crate::ln::msgs;
use crate::ln::{ChannelId, PaymentPreimage, PaymentHash, PaymentSecret};
use crate::chain::transaction;
use crate::routing::gossip::NetworkUpdate;
use crate::util::errors::APIError;
use crate::util::ser::{BigSize, FixedLengthReader, Writeable, Writer, MaybeReadable, Readable, RequiredWrapper, UpgradableRequired, WithoutLength};
Expand DownExpand Up@@ -861,7 +862,7 @@ pub enum Event {
///
/// [`ChannelManager::accept_inbound_channel`]: crate::ln::channelmanager::ChannelManager::accept_inbound_channel
/// [`UserConfig::manually_accept_inbound_channels`]: crate::util::config::UserConfig::manually_accept_inbound_channels
ChannelClosed {
ChannelClosed {
/// The `channel_id` of the channel which has been closed. Note that on-chain transactions
/// resolving the channel are likely still awaiting confirmation.
channel_id: ChannelId,
Expand All@@ -886,6 +887,10 @@ pub enum Event {
///
/// This field will be `None` for objects serialized prior to LDK 0.0.117.
channel_capacity_sats: Option<u64>,
/// The original channel funding TXO; this helps checking for the existence and confirmation
/// status of the closing tx.
/// Note that for instances serialized in v0.0.119 or prior this will be missing (None).
channel_funding_txo: Option<transaction::OutPoint>,
},
/// Used to indicate to the user that they can abandon the funding transaction and recycle the
/// inputs for another purpose.
Expand DownExpand Up@@ -1091,7 +1096,7 @@ impl Writeable for Event {
});
},
&Event::ChannelClosed { ref channel_id, ref user_channel_id, ref reason,
ref counterparty_node_id, ref channel_capacity_sats
ref counterparty_node_id, ref channel_capacity_sats, ref channel_funding_txo
} => {
9u8.write(writer)?;
// `user_channel_id` used to be a single u64 value. In order to remain backwards
Expand All@@ -1106,6 +1111,7 @@ impl Writeable for Event {
(3, user_channel_id_high, required),
(5, counterparty_node_id, option),
(7, channel_capacity_sats, option),
(9, channel_funding_txo, option),
});
},
&Event::DiscardFunding { ref channel_id, ref transaction } => {
Expand DownExpand Up@@ -1405,13 +1411,15 @@ impl MaybeReadable for Event {
let mut user_channel_id_high_opt: Option<u64> = None;
let mut counterparty_node_id = None;
let mut channel_capacity_sats = None;
let mut channel_funding_txo = None;
read_tlv_fields!(reader, {
(0, channel_id, required),
(1, user_channel_id_low_opt, option),
(2, reason, upgradable_required),
(3, user_channel_id_high_opt, option),
(5, counterparty_node_id, option),
(7, channel_capacity_sats, option),
(9, channel_funding_txo, option),
});

// `user_channel_id` used to be a single u64 value. In order to remain
Expand All@@ -1421,7 +1429,7 @@ impl MaybeReadable for Event {
((user_channel_id_high_opt.unwrap_or(0) as u128) << 64);

Ok(Some(Event::ChannelClosed { channel_id, user_channel_id, reason: _init_tlv_based_struct_field!(reason, upgradable_required),
counterparty_node_id, channel_capacity_sats }))
counterparty_node_id, channel_capacity_sats, channel_funding_txo }))
};
f()
},
Expand Down
4 changes: 4 additions & 0 deletions lightning/src/ln/channel.rs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -827,6 +827,7 @@ pub(crate) struct ShutdownResult {
pub(crate) channel_capacity_satoshis: u64,
pub(crate) counterparty_node_id: PublicKey,
pub(crate) unbroadcasted_funding_tx: Option<Transaction>,
pub(crate) channel_funding_txo: Option<OutPoint>,
}

/// If the majority of the channels funds are to the fundee and the initiator holds only just
Expand DownExpand Up@@ -2420,6 +2421,7 @@ impl<SP: Deref> ChannelContext<SP> where SP::Target: SignerProvider {
channel_capacity_satoshis: self.channel_value_satoshis,
counterparty_node_id: self.counterparty_node_id,
unbroadcasted_funding_tx,
channel_funding_txo: self.get_funding_txo(),
}
}

Expand DownExpand Up@@ -4956,6 +4958,7 @@ impl<SP: Deref> Channel<SP> where
channel_capacity_satoshis: self.context.channel_value_satoshis,
counterparty_node_id: self.context.counterparty_node_id,
unbroadcasted_funding_tx: self.context.unbroadcasted_funding(),
channel_funding_txo: self.context.get_funding_txo(),
};
let tx = self.build_signed_closing_transaction(&mut closing_tx, &msg.signature, &sig);
self.context.channel_state = ChannelState::ShutdownComplete;
Expand DownExpand Up@@ -4990,6 +4993,7 @@ impl<SP: Deref> Channel<SP> where
channel_capacity_satoshis: self.context.channel_value_satoshis,
counterparty_node_id: self.context.counterparty_node_id,
unbroadcasted_funding_tx: self.context.unbroadcasted_funding(),
channel_funding_txo: self.context.get_funding_txo(),
};
self.context.channel_state = ChannelState::ShutdownComplete;
self.context.update_time_counter += 1;
Expand Down
3 changes: 3 additions & 0 deletions lightning/src/ln/channelmanager.rs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -2878,6 +2878,7 @@ where
reason: shutdown_res.closure_reason,
counterparty_node_id: Some(shutdown_res.counterparty_node_id),
channel_capacity_sats: Some(shutdown_res.channel_capacity_satoshis),
channel_funding_txo: shutdown_res.channel_funding_txo,
}, None));

if let Some(transaction) = shutdown_res.unbroadcasted_funding_tx {
Expand DownExpand Up@@ -10304,6 +10305,7 @@ where
reason: ClosureReason::OutdatedChannelManager,
counterparty_node_id: Some(channel.context.get_counterparty_node_id()),
channel_capacity_sats: Some(channel.context.get_value_satoshis()),
channel_funding_txo: channel.context.get_funding_txo(),
}, None));
for (channel_htlc_source, payment_hash) in channel.inflight_htlc_sources() {
let mut found_htlc = false;
Expand DownExpand Up@@ -10357,6 +10359,7 @@ where
reason: ClosureReason::DisconnectedPeer,
counterparty_node_id: Some(channel.context.get_counterparty_node_id()),
channel_capacity_sats: Some(channel.context.get_value_satoshis()),
channel_funding_txo: channel.context.get_funding_txo(),
}, None));
} else {
log_error!(logger, "Missing ChannelMonitor for channel {} needed by ChannelManager.", &channel.context.channel_id());
Expand Down
18 changes: 16 additions & 2 deletions lightning/src/ln/functional_test_utils.rs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -1539,6 +1539,8 @@ pub struct ExpectedCloseEvent {
pub counterparty_node_id: Option<PublicKey>,
pub discard_funding: bool,
pub reason: Option<ClosureReason>,
pub channel_funding_txo: Option<OutPoint>,
pub user_channel_id: Option<u128>,
}

impl ExpectedCloseEvent {
Expand All@@ -1549,6 +1551,8 @@ impl ExpectedCloseEvent {
counterparty_node_id: None,
discard_funding,
reason: Some(reason),
channel_funding_txo: None,
user_channel_id: None,
}
}
}
Expand All@@ -1567,12 +1571,20 @@ pub fn check_closed_events(node: &Node, expected_close_events: &[ExpectedCloseEv
reason,
counterparty_node_id,
channel_capacity_sats,
channel_funding_txo,
user_channel_id,
..
} if (
expected_event.channel_id.map(|expected| *channel_id == expected).unwrap_or(true) &&
expected_event.reason.as_ref().map(|expected| reason == expected).unwrap_or(true) &&
expected_event.counterparty_node_id.map(|expected| *counterparty_node_id == Some(expected)).unwrap_or(true) &&
expected_event.channel_capacity_sats.map(|expected| *channel_capacity_sats == Some(expected)).unwrap_or(true)
expected_event.
counterparty_node_id.map(|expected| *counterparty_node_id == Some(expected)).unwrap_or(true) &&
expected_event.channel_capacity_sats
.map(|expected| *channel_capacity_sats == Some(expected)).unwrap_or(true) &&
expected_event.channel_funding_txo
.map(|expected| *channel_funding_txo == Some(expected)).unwrap_or(true) &&
expected_event.user_channel_id
.map(|expected| *user_channel_id == expected).unwrap_or(true)
)
)));
}
Expand All@@ -1597,6 +1609,8 @@ pub fn check_closed_event(node: &Node, events_count: usize, expected_reason: Clo
counterparty_node_id: Some(*node_id),
discard_funding: is_check_discard_funding,
reason: Some(expected_reason.clone()),
channel_funding_txo: None,
user_channel_id: None,
}).collect::<Vec<_>>();
check_closed_events(node, expected_close_events.as_slice());
}
Expand Down
20 changes: 16 additions & 4 deletions lightning/src/ln/functional_tests.rs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -10687,17 +10687,23 @@ fn test_disconnect_in_funding_batch() {
nodes[0].node.peer_disconnected(&nodes[2].node.get_our_node_id());

// The channels in the batch will close immediately.
let channel_id_1 = OutPoint { txid: tx.txid(), index: 0 }.to_channel_id();
let channel_id_2 = OutPoint { txid: tx.txid(), index: 1 }.to_channel_id();
let funding_txo_1 = OutPoint { txid: tx.txid(), index: 0 };
let funding_txo_2 = OutPoint { txid: tx.txid(), index: 1 };
let channel_id_1 = funding_txo_1.to_channel_id();
let channel_id_2 = funding_txo_2.to_channel_id();
check_closed_events(&nodes[0], &[
ExpectedCloseEvent {
channel_id: Some(channel_id_1),
discard_funding: true,
channel_funding_txo: Some(funding_txo_1),
user_channel_id: Some(42),
..Default::default()
},
ExpectedCloseEvent {
channel_id: Some(channel_id_2),
discard_funding: true,
channel_funding_txo: Some(funding_txo_2),
user_channel_id: Some(43),
..Default::default()
},
]);
Expand DownExpand Up@@ -10755,8 +10761,10 @@ fn test_batch_funding_close_after_funding_signed() {
assert_eq!(nodes[0].tx_broadcaster.txn_broadcast().len(), 0);

// Force-close the channel for which we've completed the initial monitor.
let channel_id_1 = OutPoint { txid: tx.txid(), index: 0 }.to_channel_id();
let channel_id_2 = OutPoint { txid: tx.txid(), index: 1 }.to_channel_id();
let funding_txo_1 = OutPoint { txid: tx.txid(), index: 0 };
let funding_txo_2 = OutPoint { txid: tx.txid(), index: 1 };
let channel_id_1 = funding_txo_1.to_channel_id();
let channel_id_2 = funding_txo_2.to_channel_id();
nodes[0].node.force_close_broadcasting_latest_txn(&channel_id_1, &nodes[1].node.get_our_node_id()).unwrap();
check_added_monitors(&nodes[0], 2);
{
Expand DownExpand Up@@ -10788,11 +10796,15 @@ fn test_batch_funding_close_after_funding_signed() {
ExpectedCloseEvent {
channel_id: Some(channel_id_1),
discard_funding: true,
channel_funding_txo: Some(funding_txo_1),
user_channel_id: Some(42),
..Default::default()
},
ExpectedCloseEvent {
channel_id: Some(channel_id_2),
discard_funding: true,
channel_funding_txo: Some(funding_txo_2),
user_channel_id: Some(43),
..Default::default()
},
]);
Expand Down
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all 
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n 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;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '

Skip to content
Add channel funding txo to Channel Event::ChannelClosed#2800

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 1 commit into

from

Jan 11, 2024
 Merged


Add channel funding txo to Channel Event::ChannelClosed
#2800
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


14 changes: 11 additions & 3 deletions
lightning/src/events/mod.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -24,6 +24,7 @@ use crate::ln::channel::FUNDING_CONF_DEADLINE_BLOCKS;
use crate::ln::features::ChannelTypeFeatures;
use crate::ln::msgs;
use crate::ln::{ChannelId, PaymentPreimage, PaymentHash, PaymentSecret};
use crate::chain::transaction;
use crate::routing::gossip::NetworkUpdate;
use crate::util::errors::APIError;
use crate::util::ser::{BigSize, FixedLengthReader, Writeable, Writer, MaybeReadable, Readable, RequiredWrapper, UpgradableRequired, WithoutLength};
Expand DownExpand Up@@ -861,7 +862,7 @@ pub enum Event {
	///
	/// [`ChannelManager::accept_inbound_channel`]: crate::ln::channelmanager::ChannelManager::accept_inbound_channel
	/// [`UserConfig::manually_accept_inbound_channels`]: crate::util::config::UserConfig::manually_accept_inbound_channels
	ChannelClosed {
	ChannelClosed {
 /// The `channel_id` of the channel which has been closed. Note that on-chain transactions
 /// resolving the channel are likely still awaiting confirmation.
 channel_id: ChannelId,
Expand All@@ -886,6 +887,10 @@ pub enum Event {
 ///
 /// This field will be `None` for objects serialized prior to LDK 0.0.117.
 channel_capacity_sats: Option<u64>,
 /// The original channel funding TXO; this helps checking for the existence and confirmation
 /// status of the closing tx.
 /// Note that for instances serialized in v0.0.119 or prior this will be missing (None).
 channel_funding_txo: Option<transaction::OutPoint>,
	},
	/// Used to indicate to the user that they can abandon the funding transaction and recycle the
	/// inputs for another purpose.
Expand DownExpand Up@@ -1091,7 +1096,7 @@ impl Writeable for Event {
 });
 },
 &Event::ChannelClosed { ref channel_id, ref user_channel_id, ref reason,
 ref counterparty_node_id, ref channel_capacity_sats
 ref counterparty_node_id, ref channel_capacity_sats, ref channel_funding_txo
 } => {
 9u8.write(writer)?;
 // `user_channel_id` used to be a single u64 value. In order to remain backwards
Expand All@@ -1106,6 +1111,7 @@ impl Writeable for Event {
 (3, user_channel_id_high, required),
 (5, counterparty_node_id, option),
 (7, channel_capacity_sats, option),
 (9, channel_funding_txo, option),
 });
 },
 &Event::DiscardFunding { ref channel_id, ref transaction } => {
Expand DownExpand Up@@ -1405,13 +1411,15 @@ impl MaybeReadable for Event {
 let mut user_channel_id_high_opt: Option<u64> = None;
 let mut counterparty_node_id = None;
 let mut channel_capacity_sats = None;
 let mut channel_funding_txo = None;
 read_tlv_fields!(reader, {
 (0, channel_id, required),
 (1, user_channel_id_low_opt, option),
 (2, reason, upgradable_required),
 (3, user_channel_id_high_opt, option),
 (5, counterparty_node_id, option),
 (7, channel_capacity_sats, option),
 (9, channel_funding_txo, option),
 });

 // `user_channel_id` used to be a single u64 value. In order to remain
Expand All@@ -1421,7 +1429,7 @@ impl MaybeReadable for Event {
 ((user_channel_id_high_opt.unwrap_or(0) as u128) << 64);

 Ok(Some(Event::ChannelClosed { channel_id, user_channel_id, reason: _init_tlv_based_struct_field!(reason, upgradable_required),
 counterparty_node_id, channel_capacity_sats }))
 counterparty_node_id, channel_capacity_sats, channel_funding_txo }))
 };
 f()
 },
Expand Down

4 changes: 4 additions & 0 deletions
lightning/src/ln/channel.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -827,6 +827,7 @@ pub(crate) struct ShutdownResult {
	pub(crate) channel_capacity_satoshis: u64,
	pub(crate) counterparty_node_id: PublicKey,
	pub(crate) unbroadcasted_funding_tx: Option<Transaction>,
	pub(crate) channel_funding_txo: Option<OutPoint>,
}

/// If the majority of the channels funds are to the fundee and the initiator holds only just
Expand DownExpand Up@@ -2420,6 +2421,7 @@ impl<SP: Deref> ChannelContext<SP> where SP::Target: SignerProvider {
 channel_capacity_satoshis: self.channel_value_satoshis,
 counterparty_node_id: self.counterparty_node_id,
 unbroadcasted_funding_tx,
 channel_funding_txo: self.get_funding_txo(),
 }
	}

Expand DownExpand Up@@ -4956,6 +4958,7 @@ impl<SP: Deref> Channel<SP> where
 channel_capacity_satoshis: self.context.channel_value_satoshis,
 counterparty_node_id: self.context.counterparty_node_id,
 unbroadcasted_funding_tx: self.context.unbroadcasted_funding(),
 channel_funding_txo: self.context.get_funding_txo(),
 };
 let tx = self.build_signed_closing_transaction(&mut closing_tx, &msg.signature, &sig);
 self.context.channel_state = ChannelState::ShutdownComplete;
Expand DownExpand Up@@ -4990,6 +4993,7 @@ impl<SP: Deref> Channel<SP> where
 channel_capacity_satoshis: self.context.channel_value_satoshis,
 counterparty_node_id: self.context.counterparty_node_id,
 unbroadcasted_funding_tx: self.context.unbroadcasted_funding(),
 channel_funding_txo: self.context.get_funding_txo(),
 };
 self.context.channel_state = ChannelState::ShutdownComplete;
 self.context.update_time_counter += 1;
Expand Down

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

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2878,6 +2878,7 @@ where
 reason: shutdown_res.closure_reason,
 counterparty_node_id: Some(shutdown_res.counterparty_node_id),
 channel_capacity_sats: Some(shutdown_res.channel_capacity_satoshis),
 channel_funding_txo: shutdown_res.channel_funding_txo,
 }, None));

 if let Some(transaction) = shutdown_res.unbroadcasted_funding_tx {
Expand DownExpand Up@@ -10304,6 +10305,7 @@ where
 reason: ClosureReason::OutdatedChannelManager,
 counterparty_node_id: Some(channel.context.get_counterparty_node_id()),
 channel_capacity_sats: Some(channel.context.get_value_satoshis()),
 channel_funding_txo: channel.context.get_funding_txo(),
 }, None));
 for (channel_htlc_source, payment_hash) in channel.inflight_htlc_sources() {
 let mut found_htlc = false;
Expand DownExpand Up@@ -10357,6 +10359,7 @@ where
 reason: ClosureReason::DisconnectedPeer,
 counterparty_node_id: Some(channel.context.get_counterparty_node_id()),
 channel_capacity_sats: Some(channel.context.get_value_satoshis()),
 channel_funding_txo: channel.context.get_funding_txo(),
 }, None));
 } else {
 log_error!(logger, "Missing ChannelMonitor for channel {} needed by ChannelManager.", &channel.context.channel_id());
Expand Down

18 changes: 16 additions & 2 deletions
lightning/src/ln/functional_test_utils.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1539,6 +1539,8 @@ pub struct ExpectedCloseEvent {
	pub counterparty_node_id: Option<PublicKey>,
	pub discard_funding: bool,
	pub reason: Option<ClosureReason>,
	pub channel_funding_txo: Option<OutPoint>,
	pub user_channel_id: Option<u128>,
}

impl ExpectedCloseEvent {
Expand All@@ -1549,6 +1551,8 @@ impl ExpectedCloseEvent {
 counterparty_node_id: None,
 discard_funding,
 reason: Some(reason),
 channel_funding_txo: None,
 user_channel_id: None,
 }
	}
}
Expand All@@ -1567,12 +1571,20 @@ pub fn check_closed_events(node: &Node, expected_close_events: &[ExpectedCloseEv
 reason,
 counterparty_node_id,
 channel_capacity_sats,
 channel_funding_txo,
 user_channel_id,
 ..
 } if (
 expected_event.channel_id.map(|expected| *channel_id == expected).unwrap_or(true) &&
 expected_event.reason.as_ref().map(|expected| reason == expected).unwrap_or(true) &&
 expected_event.counterparty_node_id.map(|expected| *counterparty_node_id == Some(expected)).unwrap_or(true) &&
 expected_event.channel_capacity_sats.map(|expected| *channel_capacity_sats == Some(expected)).unwrap_or(true)
 expected_event.
 counterparty_node_id.map(|expected| *counterparty_node_id == Some(expected)).unwrap_or(true) &&
 expected_event.channel_capacity_sats
 .map(|expected| *channel_capacity_sats == Some(expected)).unwrap_or(true) &&
 expected_event.channel_funding_txo
 .map(|expected| *channel_funding_txo == Some(expected)).unwrap_or(true) &&
 expected_event.user_channel_id
 .map(|expected| *user_channel_id == expected).unwrap_or(true)
 )
 )));
	}
Expand All@@ -1597,6 +1609,8 @@ pub fn check_closed_event(node: &Node, events_count: usize, expected_reason: Clo
 counterparty_node_id: Some(*node_id),
 discard_funding: is_check_discard_funding,
 reason: Some(expected_reason.clone()),
 channel_funding_txo: None,
 user_channel_id: None,
	}).collect::<Vec<_>>();
	check_closed_events(node, expected_close_events.as_slice());
}
Expand Down

20 changes: 16 additions & 4 deletions
lightning/src/ln/functional_tests.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10687,17 +10687,23 @@ fn test_disconnect_in_funding_batch() {
	nodes[0].node.peer_disconnected(&nodes[2].node.get_our_node_id());

	// The channels in the batch will close immediately.
	let channel_id_1 = OutPoint { txid: tx.txid(), index: 0 }.to_channel_id();
	let channel_id_2 = OutPoint { txid: tx.txid(), index: 1 }.to_channel_id();
	let funding_txo_1 = OutPoint { txid: tx.txid(), index: 0 };
	let funding_txo_2 = OutPoint { txid: tx.txid(), index: 1 };
	let channel_id_1 = funding_txo_1.to_channel_id();
	let channel_id_2 = funding_txo_2.to_channel_id();
	check_closed_events(&nodes[0], &[
 ExpectedCloseEvent {
 channel_id: Some(channel_id_1),
 discard_funding: true,
 channel_funding_txo: Some(funding_txo_1),
 user_channel_id: Some(42),
 ..Default::default()
 },
 ExpectedCloseEvent {
 channel_id: Some(channel_id_2),
 discard_funding: true,
 channel_funding_txo: Some(funding_txo_2),
 user_channel_id: Some(43),
 ..Default::default()
 },
	]);
Expand DownExpand Up@@ -10755,8 +10761,10 @@ fn test_batch_funding_close_after_funding_signed() {
	assert_eq!(nodes[0].tx_broadcaster.txn_broadcast().len(), 0);

	// Force-close the channel for which we've completed the initial monitor.
	let channel_id_1 = OutPoint { txid: tx.txid(), index: 0 }.to_channel_id();
	let channel_id_2 = OutPoint { txid: tx.txid(), index: 1 }.to_channel_id();
	let funding_txo_1 = OutPoint { txid: tx.txid(), index: 0 };
	let funding_txo_2 = OutPoint { txid: tx.txid(), index: 1 };
	let channel_id_1 = funding_txo_1.to_channel_id();
	let channel_id_2 = funding_txo_2.to_channel_id();
	nodes[0].node.force_close_broadcasting_latest_txn(&channel_id_1, &nodes[1].node.get_our_node_id()).unwrap();
	check_added_monitors(&nodes[0], 2);
	{
Expand DownExpand Up@@ -10788,11 +10796,15 @@ fn test_batch_funding_close_after_funding_signed() {
 ExpectedCloseEvent {
 channel_id: Some(channel_id_1),
 discard_funding: true,
 channel_funding_txo: Some(funding_txo_1),
 user_channel_id: Some(42),
 ..Default::default()
 },
 ExpectedCloseEvent {
 channel_id: Some(channel_id_2),
 discard_funding: true,
 channel_funding_txo: Some(funding_txo_2),
 user_channel_id: Some(43),
 ..Default::default()
 },
	]);
Expand Down

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

Skip to content
Add channel funding txo to Channel Event::ChannelClosed#2800

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 1 commit into

from

Jan 11, 2024
 Merged


Add channel funding txo to Channel Event::ChannelClosed
#2800
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


14 changes: 11 additions & 3 deletions
lightning/src/events/mod.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -24,6 +24,7 @@ use crate::ln::channel::FUNDING_CONF_DEADLINE_BLOCKS;
use crate::ln::features::ChannelTypeFeatures;
use crate::ln::msgs;
use crate::ln::{ChannelId, PaymentPreimage, PaymentHash, PaymentSecret};
use crate::chain::transaction;
use crate::routing::gossip::NetworkUpdate;
use crate::util::errors::APIError;
use crate::util::ser::{BigSize, FixedLengthReader, Writeable, Writer, MaybeReadable, Readable, RequiredWrapper, UpgradableRequired, WithoutLength};
Expand DownExpand Up@@ -861,7 +862,7 @@ pub enum Event {
	///
	/// [`ChannelManager::accept_inbound_channel`]: crate::ln::channelmanager::ChannelManager::accept_inbound_channel
	/// [`UserConfig::manually_accept_inbound_channels`]: crate::util::config::UserConfig::manually_accept_inbound_channels
	ChannelClosed {
	ChannelClosed {
 /// The `channel_id` of the channel which has been closed. Note that on-chain transactions
 /// resolving the channel are likely still awaiting confirmation.
 channel_id: ChannelId,
Expand All@@ -886,6 +887,10 @@ pub enum Event {
 ///
 /// This field will be `None` for objects serialized prior to LDK 0.0.117.
 channel_capacity_sats: Option<u64>,
 /// The original channel funding TXO; this helps checking for the existence and confirmation
 /// status of the closing tx.
 /// Note that for instances serialized in v0.0.119 or prior this will be missing (None).
 channel_funding_txo: Option<transaction::OutPoint>,
	},
	/// Used to indicate to the user that they can abandon the funding transaction and recycle the
	/// inputs for another purpose.
Expand DownExpand Up@@ -1091,7 +1096,7 @@ impl Writeable for Event {
 });
 },
 &Event::ChannelClosed { ref channel_id, ref user_channel_id, ref reason,
 ref counterparty_node_id, ref channel_capacity_sats
 ref counterparty_node_id, ref channel_capacity_sats, ref channel_funding_txo
 } => {
 9u8.write(writer)?;
 // `user_channel_id` used to be a single u64 value. In order to remain backwards
Expand All@@ -1106,6 +1111,7 @@ impl Writeable for Event {
 (3, user_channel_id_high, required),
 (5, counterparty_node_id, option),
 (7, channel_capacity_sats, option),
 (9, channel_funding_txo, option),
 });
 },
 &Event::DiscardFunding { ref channel_id, ref transaction } => {
Expand DownExpand Up@@ -1405,13 +1411,15 @@ impl MaybeReadable for Event {
 let mut user_channel_id_high_opt: Option<u64> = None;
 let mut counterparty_node_id = None;
 let mut channel_capacity_sats = None;
 let mut channel_funding_txo = None;
 read_tlv_fields!(reader, {
 (0, channel_id, required),
 (1, user_channel_id_low_opt, option),
 (2, reason, upgradable_required),
 (3, user_channel_id_high_opt, option),
 (5, counterparty_node_id, option),
 (7, channel_capacity_sats, option),
 (9, channel_funding_txo, option),
 });

 // `user_channel_id` used to be a single u64 value. In order to remain
Expand All@@ -1421,7 +1429,7 @@ impl MaybeReadable for Event {
 ((user_channel_id_high_opt.unwrap_or(0) as u128) << 64);

 Ok(Some(Event::ChannelClosed { channel_id, user_channel_id, reason: _init_tlv_based_struct_field!(reason, upgradable_required),
 counterparty_node_id, channel_capacity_sats }))
 counterparty_node_id, channel_capacity_sats, channel_funding_txo }))
 };
 f()
 },
Expand Down

4 changes: 4 additions & 0 deletions
lightning/src/ln/channel.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -827,6 +827,7 @@ pub(crate) struct ShutdownResult {
	pub(crate) channel_capacity_satoshis: u64,
	pub(crate) counterparty_node_id: PublicKey,
	pub(crate) unbroadcasted_funding_tx: Option<Transaction>,
	pub(crate) channel_funding_txo: Option<OutPoint>,
}

/// If the majority of the channels funds are to the fundee and the initiator holds only just
Expand DownExpand Up@@ -2420,6 +2421,7 @@ impl<SP: Deref> ChannelContext<SP> where SP::Target: SignerProvider {
 channel_capacity_satoshis: self.channel_value_satoshis,
 counterparty_node_id: self.counterparty_node_id,
 unbroadcasted_funding_tx,
 channel_funding_txo: self.get_funding_txo(),
 }
	}

Expand DownExpand Up@@ -4956,6 +4958,7 @@ impl<SP: Deref> Channel<SP> where
 channel_capacity_satoshis: self.context.channel_value_satoshis,
 counterparty_node_id: self.context.counterparty_node_id,
 unbroadcasted_funding_tx: self.context.unbroadcasted_funding(),
 channel_funding_txo: self.context.get_funding_txo(),
 };
 let tx = self.build_signed_closing_transaction(&mut closing_tx, &msg.signature, &sig);
 self.context.channel_state = ChannelState::ShutdownComplete;
Expand DownExpand Up@@ -4990,6 +4993,7 @@ impl<SP: Deref> Channel<SP> where
 channel_capacity_satoshis: self.context.channel_value_satoshis,
 counterparty_node_id: self.context.counterparty_node_id,
 unbroadcasted_funding_tx: self.context.unbroadcasted_funding(),
 channel_funding_txo: self.context.get_funding_txo(),
 };
 self.context.channel_state = ChannelState::ShutdownComplete;
 self.context.update_time_counter += 1;
Expand Down

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

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2878,6 +2878,7 @@ where
 reason: shutdown_res.closure_reason,
 counterparty_node_id: Some(shutdown_res.counterparty_node_id),
 channel_capacity_sats: Some(shutdown_res.channel_capacity_satoshis),
 channel_funding_txo: shutdown_res.channel_funding_txo,
 }, None));

 if let Some(transaction) = shutdown_res.unbroadcasted_funding_tx {
Expand DownExpand Up@@ -10304,6 +10305,7 @@ where
 reason: ClosureReason::OutdatedChannelManager,
 counterparty_node_id: Some(channel.context.get_counterparty_node_id()),
 channel_capacity_sats: Some(channel.context.get_value_satoshis()),
 channel_funding_txo: channel.context.get_funding_txo(),
 }, None));
 for (channel_htlc_source, payment_hash) in channel.inflight_htlc_sources() {
 let mut found_htlc = false;
Expand DownExpand Up@@ -10357,6 +10359,7 @@ where
 reason: ClosureReason::DisconnectedPeer,
 counterparty_node_id: Some(channel.context.get_counterparty_node_id()),
 channel_capacity_sats: Some(channel.context.get_value_satoshis()),
 channel_funding_txo: channel.context.get_funding_txo(),
 }, None));
 } else {
 log_error!(logger, "Missing ChannelMonitor for channel {} needed by ChannelManager.", &channel.context.channel_id());
Expand Down

18 changes: 16 additions & 2 deletions
lightning/src/ln/functional_test_utils.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1539,6 +1539,8 @@ pub struct ExpectedCloseEvent {
	pub counterparty_node_id: Option<PublicKey>,
	pub discard_funding: bool,
	pub reason: Option<ClosureReason>,
	pub channel_funding_txo: Option<OutPoint>,
	pub user_channel_id: Option<u128>,
}

impl ExpectedCloseEvent {
Expand All@@ -1549,6 +1551,8 @@ impl ExpectedCloseEvent {
 counterparty_node_id: None,
 discard_funding,
 reason: Some(reason),
 channel_funding_txo: None,
 user_channel_id: None,
 }
	}
}
Expand All@@ -1567,12 +1571,20 @@ pub fn check_closed_events(node: &Node, expected_close_events: &[ExpectedCloseEv
 reason,
 counterparty_node_id,
 channel_capacity_sats,
 channel_funding_txo,
 user_channel_id,
 ..
 } if (
 expected_event.channel_id.map(|expected| *channel_id == expected).unwrap_or(true) &&
 expected_event.reason.as_ref().map(|expected| reason == expected).unwrap_or(true) &&
 expected_event.counterparty_node_id.map(|expected| *counterparty_node_id == Some(expected)).unwrap_or(true) &&
 expected_event.channel_capacity_sats.map(|expected| *channel_capacity_sats == Some(expected)).unwrap_or(true)
 expected_event.
 counterparty_node_id.map(|expected| *counterparty_node_id == Some(expected)).unwrap_or(true) &&
 expected_event.channel_capacity_sats
 .map(|expected| *channel_capacity_sats == Some(expected)).unwrap_or(true) &&
 expected_event.channel_funding_txo
 .map(|expected| *channel_funding_txo == Some(expected)).unwrap_or(true) &&
 expected_event.user_channel_id
 .map(|expected| *user_channel_id == expected).unwrap_or(true)
 )
 )));
	}
Expand All@@ -1597,6 +1609,8 @@ pub fn check_closed_event(node: &Node, events_count: usize, expected_reason: Clo
 counterparty_node_id: Some(*node_id),
 discard_funding: is_check_discard_funding,
 reason: Some(expected_reason.clone()),
 channel_funding_txo: None,
 user_channel_id: None,
	}).collect::<Vec<_>>();
	check_closed_events(node, expected_close_events.as_slice());
}
Expand Down

20 changes: 16 additions & 4 deletions
lightning/src/ln/functional_tests.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10687,17 +10687,23 @@ fn test_disconnect_in_funding_batch() {
	nodes[0].node.peer_disconnected(&nodes[2].node.get_our_node_id());

	// The channels in the batch will close immediately.
	let channel_id_1 = OutPoint { txid: tx.txid(), index: 0 }.to_channel_id();
	let channel_id_2 = OutPoint { txid: tx.txid(), index: 1 }.to_channel_id();
	let funding_txo_1 = OutPoint { txid: tx.txid(), index: 0 };
	let funding_txo_2 = OutPoint { txid: tx.txid(), index: 1 };
	let channel_id_1 = funding_txo_1.to_channel_id();
	let channel_id_2 = funding_txo_2.to_channel_id();
	check_closed_events(&nodes[0], &[
 ExpectedCloseEvent {
 channel_id: Some(channel_id_1),
 discard_funding: true,
 channel_funding_txo: Some(funding_txo_1),
 user_channel_id: Some(42),
 ..Default::default()
 },
 ExpectedCloseEvent {
 channel_id: Some(channel_id_2),
 discard_funding: true,
 channel_funding_txo: Some(funding_txo_2),
 user_channel_id: Some(43),
 ..Default::default()
 },
	]);
Expand DownExpand Up@@ -10755,8 +10761,10 @@ fn test_batch_funding_close_after_funding_signed() {
	assert_eq!(nodes[0].tx_broadcaster.txn_broadcast().len(), 0);

	// Force-close the channel for which we've completed the initial monitor.
	let channel_id_1 = OutPoint { txid: tx.txid(), index: 0 }.to_channel_id();
	let channel_id_2 = OutPoint { txid: tx.txid(), index: 1 }.to_channel_id();
	let funding_txo_1 = OutPoint { txid: tx.txid(), index: 0 };
	let funding_txo_2 = OutPoint { txid: tx.txid(), index: 1 };
	let channel_id_1 = funding_txo_1.to_channel_id();
	let channel_id_2 = funding_txo_2.to_channel_id();
	nodes[0].node.force_close_broadcasting_latest_txn(&channel_id_1, &nodes[1].node.get_our_node_id()).unwrap();
	check_added_monitors(&nodes[0], 2);
	{
Expand DownExpand Up@@ -10788,11 +10796,15 @@ fn test_batch_funding_close_after_funding_signed() {
 ExpectedCloseEvent {
 channel_id: Some(channel_id_1),
 discard_funding: true,
 channel_funding_txo: Some(funding_txo_1),
 user_channel_id: Some(42),
 ..Default::default()
 },
 ExpectedCloseEvent {
 channel_id: Some(channel_id_2),
 discard_funding: true,
 channel_funding_txo: Some(funding_txo_2),
 user_channel_id: Some(43),
 ..Default::default()
 },
	]);
Expand Down

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

Skip to content
Add channel funding txo to Channel Event::ChannelClosed#2800

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 1 commit into

from

Jan 11, 2024
 Merged


Add channel funding txo to Channel Event::ChannelClosed
#2800
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


14 changes: 11 additions & 3 deletions
lightning/src/events/mod.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -24,6 +24,7 @@ use crate::ln::channel::FUNDING_CONF_DEADLINE_BLOCKS;
use crate::ln::features::ChannelTypeFeatures;
use crate::ln::msgs;
use crate::ln::{ChannelId, PaymentPreimage, PaymentHash, PaymentSecret};
use crate::chain::transaction;
use crate::routing::gossip::NetworkUpdate;
use crate::util::errors::APIError;
use crate::util::ser::{BigSize, FixedLengthReader, Writeable, Writer, MaybeReadable, Readable, RequiredWrapper, UpgradableRequired, WithoutLength};
Expand DownExpand Up@@ -861,7 +862,7 @@ pub enum Event {
	///
	/// [`ChannelManager::accept_inbound_channel`]: crate::ln::channelmanager::ChannelManager::accept_inbound_channel
	/// [`UserConfig::manually_accept_inbound_channels`]: crate::util::config::UserConfig::manually_accept_inbound_channels
	ChannelClosed {
	ChannelClosed {
 /// The `channel_id` of the channel which has been closed. Note that on-chain transactions
 /// resolving the channel are likely still awaiting confirmation.
 channel_id: ChannelId,
Expand All@@ -886,6 +887,10 @@ pub enum Event {
 ///
 /// This field will be `None` for objects serialized prior to LDK 0.0.117.
 channel_capacity_sats: Option<u64>,
 /// The original channel funding TXO; this helps checking for the existence and confirmation
 /// status of the closing tx.
 /// Note that for instances serialized in v0.0.119 or prior this will be missing (None).
 channel_funding_txo: Option<transaction::OutPoint>,
	},
	/// Used to indicate to the user that they can abandon the funding transaction and recycle the
	/// inputs for another purpose.
Expand DownExpand Up@@ -1091,7 +1096,7 @@ impl Writeable for Event {
 });
 },
 &Event::ChannelClosed { ref channel_id, ref user_channel_id, ref reason,
 ref counterparty_node_id, ref channel_capacity_sats
 ref counterparty_node_id, ref channel_capacity_sats, ref channel_funding_txo
 } => {
 9u8.write(writer)?;
 // `user_channel_id` used to be a single u64 value. In order to remain backwards
Expand All@@ -1106,6 +1111,7 @@ impl Writeable for Event {
 (3, user_channel_id_high, required),
 (5, counterparty_node_id, option),
 (7, channel_capacity_sats, option),
 (9, channel_funding_txo, option),
 });
 },
 &Event::DiscardFunding { ref channel_id, ref transaction } => {
Expand DownExpand Up@@ -1405,13 +1411,15 @@ impl MaybeReadable for Event {
 let mut user_channel_id_high_opt: Option<u64> = None;
 let mut counterparty_node_id = None;
 let mut channel_capacity_sats = None;
 let mut channel_funding_txo = None;
 read_tlv_fields!(reader, {
 (0, channel_id, required),
 (1, user_channel_id_low_opt, option),
 (2, reason, upgradable_required),
 (3, user_channel_id_high_opt, option),
 (5, counterparty_node_id, option),
 (7, channel_capacity_sats, option),
 (9, channel_funding_txo, option),
 });

 // `user_channel_id` used to be a single u64 value. In order to remain
Expand All@@ -1421,7 +1429,7 @@ impl MaybeReadable for Event {
 ((user_channel_id_high_opt.unwrap_or(0) as u128) << 64);

 Ok(Some(Event::ChannelClosed { channel_id, user_channel_id, reason: _init_tlv_based_struct_field!(reason, upgradable_required),
 counterparty_node_id, channel_capacity_sats }))
 counterparty_node_id, channel_capacity_sats, channel_funding_txo }))
 };
 f()
 },
Expand Down

4 changes: 4 additions & 0 deletions
lightning/src/ln/channel.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -827,6 +827,7 @@ pub(crate) struct ShutdownResult {
	pub(crate) channel_capacity_satoshis: u64,
	pub(crate) counterparty_node_id: PublicKey,
	pub(crate) unbroadcasted_funding_tx: Option<Transaction>,
	pub(crate) channel_funding_txo: Option<OutPoint>,
}

/// If the majority of the channels funds are to the fundee and the initiator holds only just
Expand DownExpand Up@@ -2420,6 +2421,7 @@ impl<SP: Deref> ChannelContext<SP> where SP::Target: SignerProvider {
 channel_capacity_satoshis: self.channel_value_satoshis,
 counterparty_node_id: self.counterparty_node_id,
 unbroadcasted_funding_tx,
 channel_funding_txo: self.get_funding_txo(),
 }
	}

Expand DownExpand Up@@ -4956,6 +4958,7 @@ impl<SP: Deref> Channel<SP> where
 channel_capacity_satoshis: self.context.channel_value_satoshis,
 counterparty_node_id: self.context.counterparty_node_id,
 unbroadcasted_funding_tx: self.context.unbroadcasted_funding(),
 channel_funding_txo: self.context.get_funding_txo(),
 };
 let tx = self.build_signed_closing_transaction(&mut closing_tx, &msg.signature, &sig);
 self.context.channel_state = ChannelState::ShutdownComplete;
Expand DownExpand Up@@ -4990,6 +4993,7 @@ impl<SP: Deref> Channel<SP> where
 channel_capacity_satoshis: self.context.channel_value_satoshis,
 counterparty_node_id: self.context.counterparty_node_id,
 unbroadcasted_funding_tx: self.context.unbroadcasted_funding(),
 channel_funding_txo: self.context.get_funding_txo(),
 };
 self.context.channel_state = ChannelState::ShutdownComplete;
 self.context.update_time_counter += 1;
Expand Down

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

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2878,6 +2878,7 @@ where
 reason: shutdown_res.closure_reason,
 counterparty_node_id: Some(shutdown_res.counterparty_node_id),
 channel_capacity_sats: Some(shutdown_res.channel_capacity_satoshis),
 channel_funding_txo: shutdown_res.channel_funding_txo,
 }, None));

 if let Some(transaction) = shutdown_res.unbroadcasted_funding_tx {
Expand DownExpand Up@@ -10304,6 +10305,7 @@ where
 reason: ClosureReason::OutdatedChannelManager,
 counterparty_node_id: Some(channel.context.get_counterparty_node_id()),
 channel_capacity_sats: Some(channel.context.get_value_satoshis()),
 channel_funding_txo: channel.context.get_funding_txo(),
 }, None));
 for (channel_htlc_source, payment_hash) in channel.inflight_htlc_sources() {
 let mut found_htlc = false;
Expand DownExpand Up@@ -10357,6 +10359,7 @@ where
 reason: ClosureReason::DisconnectedPeer,
 counterparty_node_id: Some(channel.context.get_counterparty_node_id()),
 channel_capacity_sats: Some(channel.context.get_value_satoshis()),
 channel_funding_txo: channel.context.get_funding_txo(),
 }, None));
 } else {
 log_error!(logger, "Missing ChannelMonitor for channel {} needed by ChannelManager.", &channel.context.channel_id());
Expand Down

18 changes: 16 additions & 2 deletions
lightning/src/ln/functional_test_utils.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1539,6 +1539,8 @@ pub struct ExpectedCloseEvent {
	pub counterparty_node_id: Option<PublicKey>,
	pub discard_funding: bool,
	pub reason: Option<ClosureReason>,
	pub channel_funding_txo: Option<OutPoint>,
	pub user_channel_id: Option<u128>,
}

impl ExpectedCloseEvent {
Expand All@@ -1549,6 +1551,8 @@ impl ExpectedCloseEvent {
 counterparty_node_id: None,
 discard_funding,
 reason: Some(reason),
 channel_funding_txo: None,
 user_channel_id: None,
 }
	}
}
Expand All@@ -1567,12 +1571,20 @@ pub fn check_closed_events(node: &Node, expected_close_events: &[ExpectedCloseEv
 reason,
 counterparty_node_id,
 channel_capacity_sats,
 channel_funding_txo,
 user_channel_id,
 ..
 } if (
 expected_event.channel_id.map(|expected| *channel_id == expected).unwrap_or(true) &&
 expected_event.reason.as_ref().map(|expected| reason == expected).unwrap_or(true) &&
 expected_event.counterparty_node_id.map(|expected| *counterparty_node_id == Some(expected)).unwrap_or(true) &&
 expected_event.channel_capacity_sats.map(|expected| *channel_capacity_sats == Some(expected)).unwrap_or(true)
 expected_event.
 counterparty_node_id.map(|expected| *counterparty_node_id == Some(expected)).unwrap_or(true) &&
 expected_event.channel_capacity_sats
 .map(|expected| *channel_capacity_sats == Some(expected)).unwrap_or(true) &&
 expected_event.channel_funding_txo
 .map(|expected| *channel_funding_txo == Some(expected)).unwrap_or(true) &&
 expected_event.user_channel_id
 .map(|expected| *user_channel_id == expected).unwrap_or(true)
 )
 )));
	}
Expand All@@ -1597,6 +1609,8 @@ pub fn check_closed_event(node: &Node, events_count: usize, expected_reason: Clo
 counterparty_node_id: Some(*node_id),
 discard_funding: is_check_discard_funding,
 reason: Some(expected_reason.clone()),
 channel_funding_txo: None,
 user_channel_id: None,
	}).collect::<Vec<_>>();
	check_closed_events(node, expected_close_events.as_slice());
}
Expand Down

20 changes: 16 additions & 4 deletions
lightning/src/ln/functional_tests.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10687,17 +10687,23 @@ fn test_disconnect_in_funding_batch() {
	nodes[0].node.peer_disconnected(&nodes[2].node.get_our_node_id());

	// The channels in the batch will close immediately.
	let channel_id_1 = OutPoint { txid: tx.txid(), index: 0 }.to_channel_id();
	let channel_id_2 = OutPoint { txid: tx.txid(), index: 1 }.to_channel_id();
	let funding_txo_1 = OutPoint { txid: tx.txid(), index: 0 };
	let funding_txo_2 = OutPoint { txid: tx.txid(), index: 1 };
	let channel_id_1 = funding_txo_1.to_channel_id();
	let channel_id_2 = funding_txo_2.to_channel_id();
	check_closed_events(&nodes[0], &[
 ExpectedCloseEvent {
 channel_id: Some(channel_id_1),
 discard_funding: true,
 channel_funding_txo: Some(funding_txo_1),
 user_channel_id: Some(42),
 ..Default::default()
 },
 ExpectedCloseEvent {
 channel_id: Some(channel_id_2),
 discard_funding: true,
 channel_funding_txo: Some(funding_txo_2),
 user_channel_id: Some(43),
 ..Default::default()
 },
	]);
Expand DownExpand Up@@ -10755,8 +10761,10 @@ fn test_batch_funding_close_after_funding_signed() {
	assert_eq!(nodes[0].tx_broadcaster.txn_broadcast().len(), 0);

	// Force-close the channel for which we've completed the initial monitor.
	let channel_id_1 = OutPoint { txid: tx.txid(), index: 0 }.to_channel_id();
	let channel_id_2 = OutPoint { txid: tx.txid(), index: 1 }.to_channel_id();
	let funding_txo_1 = OutPoint { txid: tx.txid(), index: 0 };
	let funding_txo_2 = OutPoint { txid: tx.txid(), index: 1 };
	let channel_id_1 = funding_txo_1.to_channel_id();
	let channel_id_2 = funding_txo_2.to_channel_id();
	nodes[0].node.force_close_broadcasting_latest_txn(&channel_id_1, &nodes[1].node.get_our_node_id()).unwrap();
	check_added_monitors(&nodes[0], 2);
	{
Expand DownExpand Up@@ -10788,11 +10796,15 @@ fn test_batch_funding_close_after_funding_signed() {
 ExpectedCloseEvent {
 channel_id: Some(channel_id_1),
 discard_funding: true,
 channel_funding_txo: Some(funding_txo_1),
 user_channel_id: Some(42),
 ..Default::default()
 },
 ExpectedCloseEvent {
 channel_id: Some(channel_id_2),
 discard_funding: true,
 channel_funding_txo: Some(funding_txo_2),
 user_channel_id: Some(43),
 ..Default::default()
 },
	]);
Expand Down

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

Skip to content
Add channel funding txo to Channel Event::ChannelClosed#2800

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 1 commit into

from

Jan 11, 2024
 Merged


Add channel funding txo to Channel Event::ChannelClosed
#2800
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


14 changes: 11 additions & 3 deletions
lightning/src/events/mod.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -24,6 +24,7 @@ use crate::ln::channel::FUNDING_CONF_DEADLINE_BLOCKS;
use crate::ln::features::ChannelTypeFeatures;
use crate::ln::msgs;
use crate::ln::{ChannelId, PaymentPreimage, PaymentHash, PaymentSecret};
use crate::chain::transaction;
use crate::routing::gossip::NetworkUpdate;
use crate::util::errors::APIError;
use crate::util::ser::{BigSize, FixedLengthReader, Writeable, Writer, MaybeReadable, Readable, RequiredWrapper, UpgradableRequired, WithoutLength};
Expand DownExpand Up@@ -861,7 +862,7 @@ pub enum Event {
	///
	/// [`ChannelManager::accept_inbound_channel`]: crate::ln::channelmanager::ChannelManager::accept_inbound_channel
	/// [`UserConfig::manually_accept_inbound_channels`]: crate::util::config::UserConfig::manually_accept_inbound_channels
	ChannelClosed {
	ChannelClosed {
 /// The `channel_id` of the channel which has been closed. Note that on-chain transactions
 /// resolving the channel are likely still awaiting confirmation.
 channel_id: ChannelId,
Expand All@@ -886,6 +887,10 @@ pub enum Event {
 ///
 /// This field will be `None` for objects serialized prior to LDK 0.0.117.
 channel_capacity_sats: Option<u64>,
 /// The original channel funding TXO; this helps checking for the existence and confirmation
 /// status of the closing tx.
 /// Note that for instances serialized in v0.0.119 or prior this will be missing (None).
 channel_funding_txo: Option<transaction::OutPoint>,
	},
	/// Used to indicate to the user that they can abandon the funding transaction and recycle the
	/// inputs for another purpose.
Expand DownExpand Up@@ -1091,7 +1096,7 @@ impl Writeable for Event {
 });
 },
 &Event::ChannelClosed { ref channel_id, ref user_channel_id, ref reason,
 ref counterparty_node_id, ref channel_capacity_sats
 ref counterparty_node_id, ref channel_capacity_sats, ref channel_funding_txo
 } => {
 9u8.write(writer)?;
 // `user_channel_id` used to be a single u64 value. In order to remain backwards
Expand All@@ -1106,6 +1111,7 @@ impl Writeable for Event {
 (3, user_channel_id_high, required),
 (5, counterparty_node_id, option),
 (7, channel_capacity_sats, option),
 (9, channel_funding_txo, option),
 });
 },
 &Event::DiscardFunding { ref channel_id, ref transaction } => {
Expand DownExpand Up@@ -1405,13 +1411,15 @@ impl MaybeReadable for Event {
 let mut user_channel_id_high_opt: Option<u64> = None;
 let mut counterparty_node_id = None;
 let mut channel_capacity_sats = None;
 let mut channel_funding_txo = None;
 read_tlv_fields!(reader, {
 (0, channel_id, required),
 (1, user_channel_id_low_opt, option),
 (2, reason, upgradable_required),
 (3, user_channel_id_high_opt, option),
 (5, counterparty_node_id, option),
 (7, channel_capacity_sats, option),
 (9, channel_funding_txo, option),
 });

 // `user_channel_id` used to be a single u64 value. In order to remain
Expand All@@ -1421,7 +1429,7 @@ impl MaybeReadable for Event {
 ((user_channel_id_high_opt.unwrap_or(0) as u128) << 64);

 Ok(Some(Event::ChannelClosed { channel_id, user_channel_id, reason: _init_tlv_based_struct_field!(reason, upgradable_required),
 counterparty_node_id, channel_capacity_sats }))
 counterparty_node_id, channel_capacity_sats, channel_funding_txo }))
 };
 f()
 },
Expand Down

4 changes: 4 additions & 0 deletions
lightning/src/ln/channel.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -827,6 +827,7 @@ pub(crate) struct ShutdownResult {
	pub(crate) channel_capacity_satoshis: u64,
	pub(crate) counterparty_node_id: PublicKey,
	pub(crate) unbroadcasted_funding_tx: Option<Transaction>,
	pub(crate) channel_funding_txo: Option<OutPoint>,
}

/// If the majority of the channels funds are to the fundee and the initiator holds only just
Expand DownExpand Up@@ -2420,6 +2421,7 @@ impl<SP: Deref> ChannelContext<SP> where SP::Target: SignerProvider {
 channel_capacity_satoshis: self.channel_value_satoshis,
 counterparty_node_id: self.counterparty_node_id,
 unbroadcasted_funding_tx,
 channel_funding_txo: self.get_funding_txo(),
 }
	}

Expand DownExpand Up@@ -4956,6 +4958,7 @@ impl<SP: Deref> Channel<SP> where
 channel_capacity_satoshis: self.context.channel_value_satoshis,
 counterparty_node_id: self.context.counterparty_node_id,
 unbroadcasted_funding_tx: self.context.unbroadcasted_funding(),
 channel_funding_txo: self.context.get_funding_txo(),
 };
 let tx = self.build_signed_closing_transaction(&mut closing_tx, &msg.signature, &sig);
 self.context.channel_state = ChannelState::ShutdownComplete;
Expand DownExpand Up@@ -4990,6 +4993,7 @@ impl<SP: Deref> Channel<SP> where
 channel_capacity_satoshis: self.context.channel_value_satoshis,
 counterparty_node_id: self.context.counterparty_node_id,
 unbroadcasted_funding_tx: self.context.unbroadcasted_funding(),
 channel_funding_txo: self.context.get_funding_txo(),
 };
 self.context.channel_state = ChannelState::ShutdownComplete;
 self.context.update_time_counter += 1;
Expand Down

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

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2878,6 +2878,7 @@ where
 reason: shutdown_res.closure_reason,
 counterparty_node_id: Some(shutdown_res.counterparty_node_id),
 channel_capacity_sats: Some(shutdown_res.channel_capacity_satoshis),
 channel_funding_txo: shutdown_res.channel_funding_txo,
 }, None));

 if let Some(transaction) = shutdown_res.unbroadcasted_funding_tx {
Expand DownExpand Up@@ -10304,6 +10305,7 @@ where
 reason: ClosureReason::OutdatedChannelManager,
 counterparty_node_id: Some(channel.context.get_counterparty_node_id()),
 channel_capacity_sats: Some(channel.context.get_value_satoshis()),
 channel_funding_txo: channel.context.get_funding_txo(),
 }, None));
 for (channel_htlc_source, payment_hash) in channel.inflight_htlc_sources() {
 let mut found_htlc = false;
Expand DownExpand Up@@ -10357,6 +10359,7 @@ where
 reason: ClosureReason::DisconnectedPeer,
 counterparty_node_id: Some(channel.context.get_counterparty_node_id()),
 channel_capacity_sats: Some(channel.context.get_value_satoshis()),
 channel_funding_txo: channel.context.get_funding_txo(),
 }, None));
 } else {
 log_error!(logger, "Missing ChannelMonitor for channel {} needed by ChannelManager.", &channel.context.channel_id());
Expand Down

18 changes: 16 additions & 2 deletions
lightning/src/ln/functional_test_utils.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1539,6 +1539,8 @@ pub struct ExpectedCloseEvent {
	pub counterparty_node_id: Option<PublicKey>,
	pub discard_funding: bool,
	pub reason: Option<ClosureReason>,
	pub channel_funding_txo: Option<OutPoint>,
	pub user_channel_id: Option<u128>,
}

impl ExpectedCloseEvent {
Expand All@@ -1549,6 +1551,8 @@ impl ExpectedCloseEvent {
 counterparty_node_id: None,
 discard_funding,
 reason: Some(reason),
 channel_funding_txo: None,
 user_channel_id: None,
 }
	}
}
Expand All@@ -1567,12 +1571,20 @@ pub fn check_closed_events(node: &Node, expected_close_events: &[ExpectedCloseEv
 reason,
 counterparty_node_id,
 channel_capacity_sats,
 channel_funding_txo,
 user_channel_id,
 ..
 } if (
 expected_event.channel_id.map(|expected| *channel_id == expected).unwrap_or(true) &&
 expected_event.reason.as_ref().map(|expected| reason == expected).unwrap_or(true) &&
 expected_event.counterparty_node_id.map(|expected| *counterparty_node_id == Some(expected)).unwrap_or(true) &&
 expected_event.channel_capacity_sats.map(|expected| *channel_capacity_sats == Some(expected)).unwrap_or(true)
 expected_event.
 counterparty_node_id.map(|expected| *counterparty_node_id == Some(expected)).unwrap_or(true) &&
 expected_event.channel_capacity_sats
 .map(|expected| *channel_capacity_sats == Some(expected)).unwrap_or(true) &&
 expected_event.channel_funding_txo
 .map(|expected| *channel_funding_txo == Some(expected)).unwrap_or(true) &&
 expected_event.user_channel_id
 .map(|expected| *user_channel_id == expected).unwrap_or(true)
 )
 )));
	}
Expand All@@ -1597,6 +1609,8 @@ pub fn check_closed_event(node: &Node, events_count: usize, expected_reason: Clo
 counterparty_node_id: Some(*node_id),
 discard_funding: is_check_discard_funding,
 reason: Some(expected_reason.clone()),
 channel_funding_txo: None,
 user_channel_id: None,
	}).collect::<Vec<_>>();
	check_closed_events(node, expected_close_events.as_slice());
}
Expand Down

20 changes: 16 additions & 4 deletions
lightning/src/ln/functional_tests.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10687,17 +10687,23 @@ fn test_disconnect_in_funding_batch() {
	nodes[0].node.peer_disconnected(&nodes[2].node.get_our_node_id());

	// The channels in the batch will close immediately.
	let channel_id_1 = OutPoint { txid: tx.txid(), index: 0 }.to_channel_id();
	let channel_id_2 = OutPoint { txid: tx.txid(), index: 1 }.to_channel_id();
	let funding_txo_1 = OutPoint { txid: tx.txid(), index: 0 };
	let funding_txo_2 = OutPoint { txid: tx.txid(), index: 1 };
	let channel_id_1 = funding_txo_1.to_channel_id();
	let channel_id_2 = funding_txo_2.to_channel_id();
	check_closed_events(&nodes[0], &[
 ExpectedCloseEvent {
 channel_id: Some(channel_id_1),
 discard_funding: true,
 channel_funding_txo: Some(funding_txo_1),
 user_channel_id: Some(42),
 ..Default::default()
 },
 ExpectedCloseEvent {
 channel_id: Some(channel_id_2),
 discard_funding: true,
 channel_funding_txo: Some(funding_txo_2),
 user_channel_id: Some(43),
 ..Default::default()
 },
	]);
Expand DownExpand Up@@ -10755,8 +10761,10 @@ fn test_batch_funding_close_after_funding_signed() {
	assert_eq!(nodes[0].tx_broadcaster.txn_broadcast().len(), 0);

	// Force-close the channel for which we've completed the initial monitor.
	let channel_id_1 = OutPoint { txid: tx.txid(), index: 0 }.to_channel_id();
	let channel_id_2 = OutPoint { txid: tx.txid(), index: 1 }.to_channel_id();
	let funding_txo_1 = OutPoint { txid: tx.txid(), index: 0 };
	let funding_txo_2 = OutPoint { txid: tx.txid(), index: 1 };
	let channel_id_1 = funding_txo_1.to_channel_id();
	let channel_id_2 = funding_txo_2.to_channel_id();
	nodes[0].node.force_close_broadcasting_latest_txn(&channel_id_1, &nodes[1].node.get_our_node_id()).unwrap();
	check_added_monitors(&nodes[0], 2);
	{
Expand DownExpand Up@@ -10788,11 +10796,15 @@ fn test_batch_funding_close_after_funding_signed() {
 ExpectedCloseEvent {
 channel_id: Some(channel_id_1),
 discard_funding: true,
 channel_funding_txo: Some(funding_txo_1),
 user_channel_id: Some(42),
 ..Default::default()
 },
 ExpectedCloseEvent {
 channel_id: Some(channel_id_2),
 discard_funding: true,
 channel_funding_txo: Some(funding_txo_2),
 user_channel_id: Some(43),
 ..Default::default()
 },
	]);
Expand Down

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

Skip to content
Add channel funding txo to Channel Event::ChannelClosed#2800

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 1 commit into

from

Jan 11, 2024
 Merged


Add channel funding txo to Channel Event::ChannelClosed
#2800
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


14 changes: 11 additions & 3 deletions
lightning/src/events/mod.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -24,6 +24,7 @@ use crate::ln::channel::FUNDING_CONF_DEADLINE_BLOCKS;
use crate::ln::features::ChannelTypeFeatures;
use crate::ln::msgs;
use crate::ln::{ChannelId, PaymentPreimage, PaymentHash, PaymentSecret};
use crate::chain::transaction;
use crate::routing::gossip::NetworkUpdate;
use crate::util::errors::APIError;
use crate::util::ser::{BigSize, FixedLengthReader, Writeable, Writer, MaybeReadable, Readable, RequiredWrapper, UpgradableRequired, WithoutLength};
Expand DownExpand Up@@ -861,7 +862,7 @@ pub enum Event {
	///
	/// [`ChannelManager::accept_inbound_channel`]: crate::ln::channelmanager::ChannelManager::accept_inbound_channel
	/// [`UserConfig::manually_accept_inbound_channels`]: crate::util::config::UserConfig::manually_accept_inbound_channels
	ChannelClosed {
	ChannelClosed {
 /// The `channel_id` of the channel which has been closed. Note that on-chain transactions
 /// resolving the channel are likely still awaiting confirmation.
 channel_id: ChannelId,
Expand All@@ -886,6 +887,10 @@ pub enum Event {
 ///
 /// This field will be `None` for objects serialized prior to LDK 0.0.117.
 channel_capacity_sats: Option<u64>,
 /// The original channel funding TXO; this helps checking for the existence and confirmation
 /// status of the closing tx.
 /// Note that for instances serialized in v0.0.119 or prior this will be missing (None).
 channel_funding_txo: Option<transaction::OutPoint>,
	},
	/// Used to indicate to the user that they can abandon the funding transaction and recycle the
	/// inputs for another purpose.
Expand DownExpand Up@@ -1091,7 +1096,7 @@ impl Writeable for Event {
 });
 },
 &Event::ChannelClosed { ref channel_id, ref user_channel_id, ref reason,
 ref counterparty_node_id, ref channel_capacity_sats
 ref counterparty_node_id, ref channel_capacity_sats, ref channel_funding_txo
 } => {
 9u8.write(writer)?;
 // `user_channel_id` used to be a single u64 value. In order to remain backwards
Expand All@@ -1106,6 +1111,7 @@ impl Writeable for Event {
 (3, user_channel_id_high, required),
 (5, counterparty_node_id, option),
 (7, channel_capacity_sats, option),
 (9, channel_funding_txo, option),
 });
 },
 &Event::DiscardFunding { ref channel_id, ref transaction } => {
Expand DownExpand Up@@ -1405,13 +1411,15 @@ impl MaybeReadable for Event {
 let mut user_channel_id_high_opt: Option<u64> = None;
 let mut counterparty_node_id = None;
 let mut channel_capacity_sats = None;
 let mut channel_funding_txo = None;
 read_tlv_fields!(reader, {
 (0, channel_id, required),
 (1, user_channel_id_low_opt, option),
 (2, reason, upgradable_required),
 (3, user_channel_id_high_opt, option),
 (5, counterparty_node_id, option),
 (7, channel_capacity_sats, option),
 (9, channel_funding_txo, option),
 });

 // `user_channel_id` used to be a single u64 value. In order to remain
Expand All@@ -1421,7 +1429,7 @@ impl MaybeReadable for Event {
 ((user_channel_id_high_opt.unwrap_or(0) as u128) << 64);

 Ok(Some(Event::ChannelClosed { channel_id, user_channel_id, reason: _init_tlv_based_struct_field!(reason, upgradable_required),
 counterparty_node_id, channel_capacity_sats }))
 counterparty_node_id, channel_capacity_sats, channel_funding_txo }))
 };
 f()
 },
Expand Down

4 changes: 4 additions & 0 deletions
lightning/src/ln/channel.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -827,6 +827,7 @@ pub(crate) struct ShutdownResult {
	pub(crate) channel_capacity_satoshis: u64,
	pub(crate) counterparty_node_id: PublicKey,
	pub(crate) unbroadcasted_funding_tx: Option<Transaction>,
	pub(crate) channel_funding_txo: Option<OutPoint>,
}

/// If the majority of the channels funds are to the fundee and the initiator holds only just
Expand DownExpand Up@@ -2420,6 +2421,7 @@ impl<SP: Deref> ChannelContext<SP> where SP::Target: SignerProvider {
 channel_capacity_satoshis: self.channel_value_satoshis,
 counterparty_node_id: self.counterparty_node_id,
 unbroadcasted_funding_tx,
 channel_funding_txo: self.get_funding_txo(),
 }
	}

Expand DownExpand Up@@ -4956,6 +4958,7 @@ impl<SP: Deref> Channel<SP> where
 channel_capacity_satoshis: self.context.channel_value_satoshis,
 counterparty_node_id: self.context.counterparty_node_id,
 unbroadcasted_funding_tx: self.context.unbroadcasted_funding(),
 channel_funding_txo: self.context.get_funding_txo(),
 };
 let tx = self.build_signed_closing_transaction(&mut closing_tx, &msg.signature, &sig);
 self.context.channel_state = ChannelState::ShutdownComplete;
Expand DownExpand Up@@ -4990,6 +4993,7 @@ impl<SP: Deref> Channel<SP> where
 channel_capacity_satoshis: self.context.channel_value_satoshis,
 counterparty_node_id: self.context.counterparty_node_id,
 unbroadcasted_funding_tx: self.context.unbroadcasted_funding(),
 channel_funding_txo: self.context.get_funding_txo(),
 };
 self.context.channel_state = ChannelState::ShutdownComplete;
 self.context.update_time_counter += 1;
Expand Down

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

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2878,6 +2878,7 @@ where
 reason: shutdown_res.closure_reason,
 counterparty_node_id: Some(shutdown_res.counterparty_node_id),
 channel_capacity_sats: Some(shutdown_res.channel_capacity_satoshis),
 channel_funding_txo: shutdown_res.channel_funding_txo,
 }, None));

 if let Some(transaction) = shutdown_res.unbroadcasted_funding_tx {
Expand DownExpand Up@@ -10304,6 +10305,7 @@ where
 reason: ClosureReason::OutdatedChannelManager,
 counterparty_node_id: Some(channel.context.get_counterparty_node_id()),
 channel_capacity_sats: Some(channel.context.get_value_satoshis()),
 channel_funding_txo: channel.context.get_funding_txo(),
 }, None));
 for (channel_htlc_source, payment_hash) in channel.inflight_htlc_sources() {
 let mut found_htlc = false;
Expand DownExpand Up@@ -10357,6 +10359,7 @@ where
 reason: ClosureReason::DisconnectedPeer,
 counterparty_node_id: Some(channel.context.get_counterparty_node_id()),
 channel_capacity_sats: Some(channel.context.get_value_satoshis()),
 channel_funding_txo: channel.context.get_funding_txo(),
 }, None));
 } else {
 log_error!(logger, "Missing ChannelMonitor for channel {} needed by ChannelManager.", &channel.context.channel_id());
Expand Down

18 changes: 16 additions & 2 deletions
lightning/src/ln/functional_test_utils.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1539,6 +1539,8 @@ pub struct ExpectedCloseEvent {
	pub counterparty_node_id: Option<PublicKey>,
	pub discard_funding: bool,
	pub reason: Option<ClosureReason>,
	pub channel_funding_txo: Option<OutPoint>,
	pub user_channel_id: Option<u128>,
}

impl ExpectedCloseEvent {
Expand All@@ -1549,6 +1551,8 @@ impl ExpectedCloseEvent {
 counterparty_node_id: None,
 discard_funding,
 reason: Some(reason),
 channel_funding_txo: None,
 user_channel_id: None,
 }
	}
}
Expand All@@ -1567,12 +1571,20 @@ pub fn check_closed_events(node: &Node, expected_close_events: &[ExpectedCloseEv
 reason,
 counterparty_node_id,
 channel_capacity_sats,
 channel_funding_txo,
 user_channel_id,
 ..
 } if (
 expected_event.channel_id.map(|expected| *channel_id == expected).unwrap_or(true) &&
 expected_event.reason.as_ref().map(|expected| reason == expected).unwrap_or(true) &&
 expected_event.counterparty_node_id.map(|expected| *counterparty_node_id == Some(expected)).unwrap_or(true) &&
 expected_event.channel_capacity_sats.map(|expected| *channel_capacity_sats == Some(expected)).unwrap_or(true)
 expected_event.
 counterparty_node_id.map(|expected| *counterparty_node_id == Some(expected)).unwrap_or(true) &&
 expected_event.channel_capacity_sats
 .map(|expected| *channel_capacity_sats == Some(expected)).unwrap_or(true) &&
 expected_event.channel_funding_txo
 .map(|expected| *channel_funding_txo == Some(expected)).unwrap_or(true) &&
 expected_event.user_channel_id
 .map(|expected| *user_channel_id == expected).unwrap_or(true)
 )
 )));
	}
Expand All@@ -1597,6 +1609,8 @@ pub fn check_closed_event(node: &Node, events_count: usize, expected_reason: Clo
 counterparty_node_id: Some(*node_id),
 discard_funding: is_check_discard_funding,
 reason: Some(expected_reason.clone()),
 channel_funding_txo: None,
 user_channel_id: None,
	}).collect::<Vec<_>>();
	check_closed_events(node, expected_close_events.as_slice());
}
Expand Down

20 changes: 16 additions & 4 deletions
lightning/src/ln/functional_tests.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10687,17 +10687,23 @@ fn test_disconnect_in_funding_batch() {
	nodes[0].node.peer_disconnected(&nodes[2].node.get_our_node_id());

	// The channels in the batch will close immediately.
	let channel_id_1 = OutPoint { txid: tx.txid(), index: 0 }.to_channel_id();
	let channel_id_2 = OutPoint { txid: tx.txid(), index: 1 }.to_channel_id();
	let funding_txo_1 = OutPoint { txid: tx.txid(), index: 0 };
	let funding_txo_2 = OutPoint { txid: tx.txid(), index: 1 };
	let channel_id_1 = funding_txo_1.to_channel_id();
	let channel_id_2 = funding_txo_2.to_channel_id();
	check_closed_events(&nodes[0], &[
 ExpectedCloseEvent {
 channel_id: Some(channel_id_1),
 discard_funding: true,
 channel_funding_txo: Some(funding_txo_1),
 user_channel_id: Some(42),
 ..Default::default()
 },
 ExpectedCloseEvent {
 channel_id: Some(channel_id_2),
 discard_funding: true,
 channel_funding_txo: Some(funding_txo_2),
 user_channel_id: Some(43),
 ..Default::default()
 },
	]);
Expand DownExpand Up@@ -10755,8 +10761,10 @@ fn test_batch_funding_close_after_funding_signed() {
	assert_eq!(nodes[0].tx_broadcaster.txn_broadcast().len(), 0);

	// Force-close the channel for which we've completed the initial monitor.
	let channel_id_1 = OutPoint { txid: tx.txid(), index: 0 }.to_channel_id();
	let channel_id_2 = OutPoint { txid: tx.txid(), index: 1 }.to_channel_id();
	let funding_txo_1 = OutPoint { txid: tx.txid(), index: 0 };
	let funding_txo_2 = OutPoint { txid: tx.txid(), index: 1 };
	let channel_id_1 = funding_txo_1.to_channel_id();
	let channel_id_2 = funding_txo_2.to_channel_id();
	nodes[0].node.force_close_broadcasting_latest_txn(&channel_id_1, &nodes[1].node.get_our_node_id()).unwrap();
	check_added_monitors(&nodes[0], 2);
	{
Expand DownExpand Up@@ -10788,11 +10796,15 @@ fn test_batch_funding_close_after_funding_signed() {
 ExpectedCloseEvent {
 channel_id: Some(channel_id_1),
 discard_funding: true,
 channel_funding_txo: Some(funding_txo_1),
 user_channel_id: Some(42),
 ..Default::default()
 },
 ExpectedCloseEvent {
 channel_id: Some(channel_id_2),
 discard_funding: true,
 channel_funding_txo: Some(funding_txo_2),
 user_channel_id: Some(43),
 ..Default::default()
 },
	]);
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers");
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Add channel funding txo to Channel Event::ChannelClosed#2800

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 1 commit into

from

Jan 11, 2024
 Merged


Add channel funding txo to Channel Event::ChannelClosed
#2800
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


14 changes: 11 additions & 3 deletions
lightning/src/events/mod.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -24,6 +24,7 @@ use crate::ln::channel::FUNDING_CONF_DEADLINE_BLOCKS;
use crate::ln::features::ChannelTypeFeatures;
use crate::ln::msgs;
use crate::ln::{ChannelId, PaymentPreimage, PaymentHash, PaymentSecret};
use crate::chain::transaction;
use crate::routing::gossip::NetworkUpdate;
use crate::util::errors::APIError;
use crate::util::ser::{BigSize, FixedLengthReader, Writeable, Writer, MaybeReadable, Readable, RequiredWrapper, UpgradableRequired, WithoutLength};
Expand DownExpand Up@@ -861,7 +862,7 @@ pub enum Event {
	///
	/// [`ChannelManager::accept_inbound_channel`]: crate::ln::channelmanager::ChannelManager::accept_inbound_channel
	/// [`UserConfig::manually_accept_inbound_channels`]: crate::util::config::UserConfig::manually_accept_inbound_channels
	ChannelClosed {
	ChannelClosed {
 /// The `channel_id` of the channel which has been closed. Note that on-chain transactions
 /// resolving the channel are likely still awaiting confirmation.
 channel_id: ChannelId,
Expand All@@ -886,6 +887,10 @@ pub enum Event {
 ///
 /// This field will be `None` for objects serialized prior to LDK 0.0.117.
 channel_capacity_sats: Option<u64>,
 /// The original channel funding TXO; this helps checking for the existence and confirmation
 /// status of the closing tx.
 /// Note that for instances serialized in v0.0.119 or prior this will be missing (None).
 channel_funding_txo: Option<transaction::OutPoint>,
	},
	/// Used to indicate to the user that they can abandon the funding transaction and recycle the
	/// inputs for another purpose.
Expand DownExpand Up@@ -1091,7 +1096,7 @@ impl Writeable for Event {
 });
 },
 &Event::ChannelClosed { ref channel_id, ref user_channel_id, ref reason,
 ref counterparty_node_id, ref channel_capacity_sats
 ref counterparty_node_id, ref channel_capacity_sats, ref channel_funding_txo
 } => {
 9u8.write(writer)?;
 // `user_channel_id` used to be a single u64 value. In order to remain backwards
Expand All@@ -1106,6 +1111,7 @@ impl Writeable for Event {
 (3, user_channel_id_high, required),
 (5, counterparty_node_id, option),
 (7, channel_capacity_sats, option),
 (9, channel_funding_txo, option),
 });
 },
 &Event::DiscardFunding { ref channel_id, ref transaction } => {
Expand DownExpand Up@@ -1405,13 +1411,15 @@ impl MaybeReadable for Event {
 let mut user_channel_id_high_opt: Option<u64> = None;
 let mut counterparty_node_id = None;
 let mut channel_capacity_sats = None;
 let mut channel_funding_txo = None;
 read_tlv_fields!(reader, {
 (0, channel_id, required),
 (1, user_channel_id_low_opt, option),
 (2, reason, upgradable_required),
 (3, user_channel_id_high_opt, option),
 (5, counterparty_node_id, option),
 (7, channel_capacity_sats, option),
 (9, channel_funding_txo, option),
 });

 // `user_channel_id` used to be a single u64 value. In order to remain
Expand All@@ -1421,7 +1429,7 @@ impl MaybeReadable for Event {
 ((user_channel_id_high_opt.unwrap_or(0) as u128) << 64);

 Ok(Some(Event::ChannelClosed { channel_id, user_channel_id, reason: _init_tlv_based_struct_field!(reason, upgradable_required),
 counterparty_node_id, channel_capacity_sats }))
 counterparty_node_id, channel_capacity_sats, channel_funding_txo }))
 };
 f()
 },
Expand Down

4 changes: 4 additions & 0 deletions
lightning/src/ln/channel.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -827,6 +827,7 @@ pub(crate) struct ShutdownResult {
	pub(crate) channel_capacity_satoshis: u64,
	pub(crate) counterparty_node_id: PublicKey,
	pub(crate) unbroadcasted_funding_tx: Option<Transaction>,
	pub(crate) channel_funding_txo: Option<OutPoint>,
}

/// If the majority of the channels funds are to the fundee and the initiator holds only just
Expand DownExpand Up@@ -2420,6 +2421,7 @@ impl<SP: Deref> ChannelContext<SP> where SP::Target: SignerProvider {
 channel_capacity_satoshis: self.channel_value_satoshis,
 counterparty_node_id: self.counterparty_node_id,
 unbroadcasted_funding_tx,
 channel_funding_txo: self.get_funding_txo(),
 }
	}

Expand DownExpand Up@@ -4956,6 +4958,7 @@ impl<SP: Deref> Channel<SP> where
 channel_capacity_satoshis: self.context.channel_value_satoshis,
 counterparty_node_id: self.context.counterparty_node_id,
 unbroadcasted_funding_tx: self.context.unbroadcasted_funding(),
 channel_funding_txo: self.context.get_funding_txo(),
 };
 let tx = self.build_signed_closing_transaction(&mut closing_tx, &msg.signature, &sig);
 self.context.channel_state = ChannelState::ShutdownComplete;
Expand DownExpand Up@@ -4990,6 +4993,7 @@ impl<SP: Deref> Channel<SP> where
 channel_capacity_satoshis: self.context.channel_value_satoshis,
 counterparty_node_id: self.context.counterparty_node_id,
 unbroadcasted_funding_tx: self.context.unbroadcasted_funding(),
 channel_funding_txo: self.context.get_funding_txo(),
 };
 self.context.channel_state = ChannelState::ShutdownComplete;
 self.context.update_time_counter += 1;
Expand Down

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

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2878,6 +2878,7 @@ where
 reason: shutdown_res.closure_reason,
 counterparty_node_id: Some(shutdown_res.counterparty_node_id),
 channel_capacity_sats: Some(shutdown_res.channel_capacity_satoshis),
 channel_funding_txo: shutdown_res.channel_funding_txo,
 }, None));

 if let Some(transaction) = shutdown_res.unbroadcasted_funding_tx {
Expand DownExpand Up@@ -10304,6 +10305,7 @@ where
 reason: ClosureReason::OutdatedChannelManager,
 counterparty_node_id: Some(channel.context.get_counterparty_node_id()),
 channel_capacity_sats: Some(channel.context.get_value_satoshis()),
 channel_funding_txo: channel.context.get_funding_txo(),
 }, None));
 for (channel_htlc_source, payment_hash) in channel.inflight_htlc_sources() {
 let mut found_htlc = false;
Expand DownExpand Up@@ -10357,6 +10359,7 @@ where
 reason: ClosureReason::DisconnectedPeer,
 counterparty_node_id: Some(channel.context.get_counterparty_node_id()),
 channel_capacity_sats: Some(channel.context.get_value_satoshis()),
 channel_funding_txo: channel.context.get_funding_txo(),
 }, None));
 } else {
 log_error!(logger, "Missing ChannelMonitor for channel {} needed by ChannelManager.", &channel.context.channel_id());
Expand Down

18 changes: 16 additions & 2 deletions
lightning/src/ln/functional_test_utils.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1539,6 +1539,8 @@ pub struct ExpectedCloseEvent {
	pub counterparty_node_id: Option<PublicKey>,
	pub discard_funding: bool,
	pub reason: Option<ClosureReason>,
	pub channel_funding_txo: Option<OutPoint>,
	pub user_channel_id: Option<u128>,
}

impl ExpectedCloseEvent {
Expand All@@ -1549,6 +1551,8 @@ impl ExpectedCloseEvent {
 counterparty_node_id: None,
 discard_funding,
 reason: Some(reason),
 channel_funding_txo: None,
 user_channel_id: None,
 }
	}
}
Expand All@@ -1567,12 +1571,20 @@ pub fn check_closed_events(node: &Node, expected_close_events: &[ExpectedCloseEv
 reason,
 counterparty_node_id,
 channel_capacity_sats,
 channel_funding_txo,
 user_channel_id,
 ..
 } if (
 expected_event.channel_id.map(|expected| *channel_id == expected).unwrap_or(true) &&
 expected_event.reason.as_ref().map(|expected| reason == expected).unwrap_or(true) &&
 expected_event.counterparty_node_id.map(|expected| *counterparty_node_id == Some(expected)).unwrap_or(true) &&
 expected_event.channel_capacity_sats.map(|expected| *channel_capacity_sats == Some(expected)).unwrap_or(true)
 expected_event.
 counterparty_node_id.map(|expected| *counterparty_node_id == Some(expected)).unwrap_or(true) &&
 expected_event.channel_capacity_sats
 .map(|expected| *channel_capacity_sats == Some(expected)).unwrap_or(true) &&
 expected_event.channel_funding_txo
 .map(|expected| *channel_funding_txo == Some(expected)).unwrap_or(true) &&
 expected_event.user_channel_id
 .map(|expected| *user_channel_id == expected).unwrap_or(true)
 )
 )));
	}
Expand All@@ -1597,6 +1609,8 @@ pub fn check_closed_event(node: &Node, events_count: usize, expected_reason: Clo
 counterparty_node_id: Some(*node_id),
 discard_funding: is_check_discard_funding,
 reason: Some(expected_reason.clone()),
 channel_funding_txo: None,
 user_channel_id: None,
	}).collect::<Vec<_>>();
	check_closed_events(node, expected_close_events.as_slice());
}
Expand Down

20 changes: 16 additions & 4 deletions
lightning/src/ln/functional_tests.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10687,17 +10687,23 @@ fn test_disconnect_in_funding_batch() {
	nodes[0].node.peer_disconnected(&nodes[2].node.get_our_node_id());

	// The channels in the batch will close immediately.
	let channel_id_1 = OutPoint { txid: tx.txid(), index: 0 }.to_channel_id();
	let channel_id_2 = OutPoint { txid: tx.txid(), index: 1 }.to_channel_id();
	let funding_txo_1 = OutPoint { txid: tx.txid(), index: 0 };
	let funding_txo_2 = OutPoint { txid: tx.txid(), index: 1 };
	let channel_id_1 = funding_txo_1.to_channel_id();
	let channel_id_2 = funding_txo_2.to_channel_id();
	check_closed_events(&nodes[0], &[
 ExpectedCloseEvent {
 channel_id: Some(channel_id_1),
 discard_funding: true,
 channel_funding_txo: Some(funding_txo_1),
 user_channel_id: Some(42),
 ..Default::default()
 },
 ExpectedCloseEvent {
 channel_id: Some(channel_id_2),
 discard_funding: true,
 channel_funding_txo: Some(funding_txo_2),
 user_channel_id: Some(43),
 ..Default::default()
 },
	]);
Expand DownExpand Up@@ -10755,8 +10761,10 @@ fn test_batch_funding_close_after_funding_signed() {
	assert_eq!(nodes[0].tx_broadcaster.txn_broadcast().len(), 0);

	// Force-close the channel for which we've completed the initial monitor.
	let channel_id_1 = OutPoint { txid: tx.txid(), index: 0 }.to_channel_id();
	let channel_id_2 = OutPoint { txid: tx.txid(), index: 1 }.to_channel_id();
	let funding_txo_1 = OutPoint { txid: tx.txid(), index: 0 };
	let funding_txo_2 = OutPoint { txid: tx.txid(), index: 1 };
	let channel_id_1 = funding_txo_1.to_channel_id();
	let channel_id_2 = funding_txo_2.to_channel_id();
	nodes[0].node.force_close_broadcasting_latest_txn(&channel_id_1, &nodes[1].node.get_our_node_id()).unwrap();
	check_added_monitors(&nodes[0], 2);
	{
Expand DownExpand Up@@ -10788,11 +10796,15 @@ fn test_batch_funding_close_after_funding_signed() {
 ExpectedCloseEvent {
 channel_id: Some(channel_id_1),
 discard_funding: true,
 channel_funding_txo: Some(funding_txo_1),
 user_channel_id: Some(42),
 ..Default::default()
 },
 ExpectedCloseEvent {
 channel_id: Some(channel_id_2),
 discard_funding: true,
 channel_funding_txo: Some(funding_txo_2),
 user_channel_id: Some(43),
 ..Default::default()
 },
	]);
Expand Down

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

Skip to content
Add channel funding txo to Channel Event::ChannelClosed#2800

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 1 commit into

from

Jan 11, 2024
 Merged


Add channel funding txo to Channel Event::ChannelClosed
#2800
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


14 changes: 11 additions & 3 deletions
lightning/src/events/mod.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -24,6 +24,7 @@ use crate::ln::channel::FUNDING_CONF_DEADLINE_BLOCKS;
use crate::ln::features::ChannelTypeFeatures;
use crate::ln::msgs;
use crate::ln::{ChannelId, PaymentPreimage, PaymentHash, PaymentSecret};
use crate::chain::transaction;
use crate::routing::gossip::NetworkUpdate;
use crate::util::errors::APIError;
use crate::util::ser::{BigSize, FixedLengthReader, Writeable, Writer, MaybeReadable, Readable, RequiredWrapper, UpgradableRequired, WithoutLength};
Expand DownExpand Up@@ -861,7 +862,7 @@ pub enum Event {
	///
	/// [`ChannelManager::accept_inbound_channel`]: crate::ln::channelmanager::ChannelManager::accept_inbound_channel
	/// [`UserConfig::manually_accept_inbound_channels`]: crate::util::config::UserConfig::manually_accept_inbound_channels
	ChannelClosed {
	ChannelClosed {
 /// The `channel_id` of the channel which has been closed. Note that on-chain transactions
 /// resolving the channel are likely still awaiting confirmation.
 channel_id: ChannelId,
Expand All@@ -886,6 +887,10 @@ pub enum Event {
 ///
 /// This field will be `None` for objects serialized prior to LDK 0.0.117.
 channel_capacity_sats: Option<u64>,
 /// The original channel funding TXO; this helps checking for the existence and confirmation
 /// status of the closing tx.
 /// Note that for instances serialized in v0.0.119 or prior this will be missing (None).
 channel_funding_txo: Option<transaction::OutPoint>,
	},
	/// Used to indicate to the user that they can abandon the funding transaction and recycle the
	/// inputs for another purpose.
Expand DownExpand Up@@ -1091,7 +1096,7 @@ impl Writeable for Event {
 });
 },
 &Event::ChannelClosed { ref channel_id, ref user_channel_id, ref reason,
 ref counterparty_node_id, ref channel_capacity_sats
 ref counterparty_node_id, ref channel_capacity_sats, ref channel_funding_txo
 } => {
 9u8.write(writer)?;
 // `user_channel_id` used to be a single u64 value. In order to remain backwards
Expand All@@ -1106,6 +1111,7 @@ impl Writeable for Event {
 (3, user_channel_id_high, required),
 (5, counterparty_node_id, option),
 (7, channel_capacity_sats, option),
 (9, channel_funding_txo, option),
 });
 },
 &Event::DiscardFunding { ref channel_id, ref transaction } => {
Expand DownExpand Up@@ -1405,13 +1411,15 @@ impl MaybeReadable for Event {
 let mut user_channel_id_high_opt: Option<u64> = None;
 let mut counterparty_node_id = None;
 let mut channel_capacity_sats = None;
 let mut channel_funding_txo = None;
 read_tlv_fields!(reader, {
 (0, channel_id, required),
 (1, user_channel_id_low_opt, option),
 (2, reason, upgradable_required),
 (3, user_channel_id_high_opt, option),
 (5, counterparty_node_id, option),
 (7, channel_capacity_sats, option),
 (9, channel_funding_txo, option),
 });

 // `user_channel_id` used to be a single u64 value. In order to remain
Expand All@@ -1421,7 +1429,7 @@ impl MaybeReadable for Event {
 ((user_channel_id_high_opt.unwrap_or(0) as u128) << 64);

 Ok(Some(Event::ChannelClosed { channel_id, user_channel_id, reason: _init_tlv_based_struct_field!(reason, upgradable_required),
 counterparty_node_id, channel_capacity_sats }))
 counterparty_node_id, channel_capacity_sats, channel_funding_txo }))
 };
 f()
 },
Expand Down

4 changes: 4 additions & 0 deletions
lightning/src/ln/channel.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -827,6 +827,7 @@ pub(crate) struct ShutdownResult {
	pub(crate) channel_capacity_satoshis: u64,
	pub(crate) counterparty_node_id: PublicKey,
	pub(crate) unbroadcasted_funding_tx: Option<Transaction>,
	pub(crate) channel_funding_txo: Option<OutPoint>,
}

/// If the majority of the channels funds are to the fundee and the initiator holds only just
Expand DownExpand Up@@ -2420,6 +2421,7 @@ impl<SP: Deref> ChannelContext<SP> where SP::Target: SignerProvider {
 channel_capacity_satoshis: self.channel_value_satoshis,
 counterparty_node_id: self.counterparty_node_id,
 unbroadcasted_funding_tx,
 channel_funding_txo: self.get_funding_txo(),
 }
	}

Expand DownExpand Up@@ -4956,6 +4958,7 @@ impl<SP: Deref> Channel<SP> where
 channel_capacity_satoshis: self.context.channel_value_satoshis,
 counterparty_node_id: self.context.counterparty_node_id,
 unbroadcasted_funding_tx: self.context.unbroadcasted_funding(),
 channel_funding_txo: self.context.get_funding_txo(),
 };
 let tx = self.build_signed_closing_transaction(&mut closing_tx, &msg.signature, &sig);
 self.context.channel_state = ChannelState::ShutdownComplete;
Expand DownExpand Up@@ -4990,6 +4993,7 @@ impl<SP: Deref> Channel<SP> where
 channel_capacity_satoshis: self.context.channel_value_satoshis,
 counterparty_node_id: self.context.counterparty_node_id,
 unbroadcasted_funding_tx: self.context.unbroadcasted_funding(),
 channel_funding_txo: self.context.get_funding_txo(),
 };
 self.context.channel_state = ChannelState::ShutdownComplete;
 self.context.update_time_counter += 1;
Expand Down

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

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2878,6 +2878,7 @@ where
 reason: shutdown_res.closure_reason,
 counterparty_node_id: Some(shutdown_res.counterparty_node_id),
 channel_capacity_sats: Some(shutdown_res.channel_capacity_satoshis),
 channel_funding_txo: shutdown_res.channel_funding_txo,
 }, None));

 if let Some(transaction) = shutdown_res.unbroadcasted_funding_tx {
Expand DownExpand Up@@ -10304,6 +10305,7 @@ where
 reason: ClosureReason::OutdatedChannelManager,
 counterparty_node_id: Some(channel.context.get_counterparty_node_id()),
 channel_capacity_sats: Some(channel.context.get_value_satoshis()),
 channel_funding_txo: channel.context.get_funding_txo(),
 }, None));
 for (channel_htlc_source, payment_hash) in channel.inflight_htlc_sources() {
 let mut found_htlc = false;
Expand DownExpand Up@@ -10357,6 +10359,7 @@ where
 reason: ClosureReason::DisconnectedPeer,
 counterparty_node_id: Some(channel.context.get_counterparty_node_id()),
 channel_capacity_sats: Some(channel.context.get_value_satoshis()),
 channel_funding_txo: channel.context.get_funding_txo(),
 }, None));
 } else {
 log_error!(logger, "Missing ChannelMonitor for channel {} needed by ChannelManager.", &channel.context.channel_id());
Expand Down

18 changes: 16 additions & 2 deletions
lightning/src/ln/functional_test_utils.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1539,6 +1539,8 @@ pub struct ExpectedCloseEvent {
	pub counterparty_node_id: Option<PublicKey>,
	pub discard_funding: bool,
	pub reason: Option<ClosureReason>,
	pub channel_funding_txo: Option<OutPoint>,
	pub user_channel_id: Option<u128>,
}

impl ExpectedCloseEvent {
Expand All@@ -1549,6 +1551,8 @@ impl ExpectedCloseEvent {
 counterparty_node_id: None,
 discard_funding,
 reason: Some(reason),
 channel_funding_txo: None,
 user_channel_id: None,
 }
	}
}
Expand All@@ -1567,12 +1571,20 @@ pub fn check_closed_events(node: &Node, expected_close_events: &[ExpectedCloseEv
 reason,
 counterparty_node_id,
 channel_capacity_sats,
 channel_funding_txo,
 user_channel_id,
 ..
 } if (
 expected_event.channel_id.map(|expected| *channel_id == expected).unwrap_or(true) &&
 expected_event.reason.as_ref().map(|expected| reason == expected).unwrap_or(true) &&
 expected_event.counterparty_node_id.map(|expected| *counterparty_node_id == Some(expected)).unwrap_or(true) &&
 expected_event.channel_capacity_sats.map(|expected| *channel_capacity_sats == Some(expected)).unwrap_or(true)
 expected_event.
 counterparty_node_id.map(|expected| *counterparty_node_id == Some(expected)).unwrap_or(true) &&
 expected_event.channel_capacity_sats
 .map(|expected| *channel_capacity_sats == Some(expected)).unwrap_or(true) &&
 expected_event.channel_funding_txo
 .map(|expected| *channel_funding_txo == Some(expected)).unwrap_or(true) &&
 expected_event.user_channel_id
 .map(|expected| *user_channel_id == expected).unwrap_or(true)
 )
 )));
	}
Expand All@@ -1597,6 +1609,8 @@ pub fn check_closed_event(node: &Node, events_count: usize, expected_reason: Clo
 counterparty_node_id: Some(*node_id),
 discard_funding: is_check_discard_funding,
 reason: Some(expected_reason.clone()),
 channel_funding_txo: None,
 user_channel_id: None,
	}).collect::<Vec<_>>();
	check_closed_events(node, expected_close_events.as_slice());
}
Expand Down

20 changes: 16 additions & 4 deletions
lightning/src/ln/functional_tests.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10687,17 +10687,23 @@ fn test_disconnect_in_funding_batch() {
	nodes[0].node.peer_disconnected(&nodes[2].node.get_our_node_id());

	// The channels in the batch will close immediately.
	let channel_id_1 = OutPoint { txid: tx.txid(), index: 0 }.to_channel_id();
	let channel_id_2 = OutPoint { txid: tx.txid(), index: 1 }.to_channel_id();
	let funding_txo_1 = OutPoint { txid: tx.txid(), index: 0 };
	let funding_txo_2 = OutPoint { txid: tx.txid(), index: 1 };
	let channel_id_1 = funding_txo_1.to_channel_id();
	let channel_id_2 = funding_txo_2.to_channel_id();
	check_closed_events(&nodes[0], &[
 ExpectedCloseEvent {
 channel_id: Some(channel_id_1),
 discard_funding: true,
 channel_funding_txo: Some(funding_txo_1),
 user_channel_id: Some(42),
 ..Default::default()
 },
 ExpectedCloseEvent {
 channel_id: Some(channel_id_2),
 discard_funding: true,
 channel_funding_txo: Some(funding_txo_2),
 user_channel_id: Some(43),
 ..Default::default()
 },
	]);
Expand DownExpand Up@@ -10755,8 +10761,10 @@ fn test_batch_funding_close_after_funding_signed() {
	assert_eq!(nodes[0].tx_broadcaster.txn_broadcast().len(), 0);

	// Force-close the channel for which we've completed the initial monitor.
	let channel_id_1 = OutPoint { txid: tx.txid(), index: 0 }.to_channel_id();
	let channel_id_2 = OutPoint { txid: tx.txid(), index: 1 }.to_channel_id();
	let funding_txo_1 = OutPoint { txid: tx.txid(), index: 0 };
	let funding_txo_2 = OutPoint { txid: tx.txid(), index: 1 };
	let channel_id_1 = funding_txo_1.to_channel_id();
	let channel_id_2 = funding_txo_2.to_channel_id();
	nodes[0].node.force_close_broadcasting_latest_txn(&channel_id_1, &nodes[1].node.get_our_node_id()).unwrap();
	check_added_monitors(&nodes[0], 2);
	{
Expand DownExpand Up@@ -10788,11 +10796,15 @@ fn test_batch_funding_close_after_funding_signed() {
 ExpectedCloseEvent {
 channel_id: Some(channel_id_1),
 discard_funding: true,
 channel_funding_txo: Some(funding_txo_1),
 user_channel_id: Some(42),
 ..Default::default()
 },
 ExpectedCloseEvent {
 channel_id: Some(channel_id_2),
 discard_funding: true,
 channel_funding_txo: Some(funding_txo_2),
 user_channel_id: Some(43),
 ..Default::default()
 },
	]);
Expand Down