Return Result from Watch::update_channel to separate monitor failure from persistence status#4445

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

Closed
joostjager wants to merge 1 commit into from
Closed

Return Result from Watch::update_channel to separate monitor failure from persistence status #4445

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
27 changes: 15 additions & 12 deletions fuzz/src/chanmon_consistency.rs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -320,7 +320,7 @@ impl chain::Watch<TestChannelSigner> for TestChainMonitor {

fn update_channel(
&self, channel_id: ChannelId, update: &channelmonitor::ChannelMonitorUpdate,
) -> chain::ChannelMonitorUpdateStatus {
) -> Result<chain::ChannelMonitorUpdateStatus, ()> {
let mut map_lock = self.latest_monitors.lock().unwrap();
let map_entry = map_lock.get_mut(&channel_id).expect("Didn't have monitor on update call");
let latest_monitor_data = map_entry
Expand All@@ -336,26 +336,29 @@ impl chain::Watch<TestChannelSigner> for TestChainMonitor {
)
.unwrap()
.1;
deserialized_monitor
.update_monitor(
update,
&&TestBroadcaster { txn_broadcasted: RefCell::new(Vec::new()) },
&&FuzzEstimator { ret_val: atomic::AtomicU32::new(253) },
&self.logger,
)
.unwrap();
let local_update_res = deserialized_monitor.update_monitor(
update,
&&TestBroadcaster { txn_broadcasted: RefCell::new(Vec::new()) },
&&FuzzEstimator { ret_val: atomic::AtomicU32::new(253) },
&self.logger,
);
let mut ser = VecWriter(Vec::new());
deserialized_monitor.write(&mut ser).unwrap();
let res = self.chain_monitor.update_channel(channel_id, update);
match res {
chain::ChannelMonitorUpdateStatus::Completed => {
Ok(chain::ChannelMonitorUpdateStatus::Completed) => {
assert!(local_update_res.is_ok());
map_entry.persisted_monitor_id = update.update_id;
map_entry.persisted_monitor = ser.0;
},
chain::ChannelMonitorUpdateStatus::InProgress => {
Ok(chain::ChannelMonitorUpdateStatus::InProgress) => {
assert!(local_update_res.is_ok());
map_entry.pending_monitors.push((update.update_id, ser.0));
},
chain::ChannelMonitorUpdateStatus::UnrecoverableError => panic!(),
Ok(chain::ChannelMonitorUpdateStatus::UnrecoverableError) => panic!(),
Err(()) => {
assert!(local_update_res.is_err());
},
}
res
}
Expand Down
8 changes: 4 additions & 4 deletions lightning/src/chain/chainmonitor.rs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -1311,7 +1311,7 @@ where

fn update_channel(
&self, channel_id: ChannelId, update: &ChannelMonitorUpdate,
) -> ChannelMonitorUpdateStatus {
) -> Result<ChannelMonitorUpdateStatus, ()> {
// `ChannelMonitorUpdate`'s `channel_id` is `None` prior to 0.0.121 and all channels in those
// versions are V1-established. For 0.0.121+ the `channel_id` fields is always `Some`.
debug_assert_eq!(update.channel_id.unwrap(), channel_id);
Expand All@@ -1328,7 +1328,7 @@ where
#[cfg(debug_assertions)]
panic!("ChannelManager generated a channel update for a channel that was not yet registered!");
#[cfg(not(debug_assertions))]
ChannelMonitorUpdateStatus::InProgress
Err(())
},
Some(monitor_state) => {
let monitor = &monitor_state.monitor;
Expand DownExpand Up@@ -1415,9 +1415,9 @@ where
}

if update_res.is_err() {
ChannelMonitorUpdateStatus::InProgress
Err(())
} else {
persist_res
Ok(persist_res)
}
},
}
Expand Down
19 changes: 10 additions & 9 deletions lightning/src/chain/mod.rs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -316,22 +316,23 @@ pub trait Watch<ChannelSigner: EcdsaChannelSigner> {

/// Updates a channel identified by `channel_id` by applying `update` to its monitor.
///
/// Implementations must call [`ChannelMonitor::update_monitor`] with the given update. This
/// may fail (returning an `Err(())`), in which case this should return
/// [`ChannelMonitorUpdateStatus::InProgress`] (and the update should never complete). This
/// Implementations must call [`ChannelMonitor::update_monitor`] with the given update. If
/// that call fails (returning an `Err(())`), this method should return `Err(())`. This
/// generally implies the channel has been closed (either by the funding outpoint being spent
/// on-chain or the [`ChannelMonitor`] having decided to do so and broadcasted a transaction),
/// and the [`ChannelManager`] state will be updated once it sees the funding spend on-chain.
/// Even when `update_monitor` fails, the updated monitor state should still be persisted.
///
/// In general, persistence failures should be retried after returning
/// [`ChannelMonitorUpdateStatus::InProgress`] and eventually complete. If a failure truly
/// cannot be retried, the node should shut down immediately after returning
/// [`ChannelMonitorUpdateStatus::UnrecoverableError`], see its documentation for more info.
/// On success, returns the persistence status. In general, persistence failures should be
/// retried after returning [`ChannelMonitorUpdateStatus::InProgress`] and eventually
/// complete. If a failure truly cannot be retried, the node should shut down immediately
/// after returning [`ChannelMonitorUpdateStatus::UnrecoverableError`], see its documentation
/// for more info.
///
/// [`ChannelManager`]: crate::ln::channelmanager::ChannelManager
fn update_channel(
&self, channel_id: ChannelId, update: &ChannelMonitorUpdate,
) -> ChannelMonitorUpdateStatus;
) -> Result<ChannelMonitorUpdateStatus, ()>;

/// Returns any monitor events since the last call. Subsequent calls must only return new
/// events.
Expand All@@ -358,7 +359,7 @@ impl<ChannelSigner: EcdsaChannelSigner, T: Watch<ChannelSigner> + ?Sized, W: Der

fn update_channel(
&self, channel_id: ChannelId, update: &ChannelMonitorUpdate,
) -> ChannelMonitorUpdateStatus {
) -> Result<ChannelMonitorUpdateStatus, ()> {
self.deref().update_channel(channel_id, update)
}

Expand Down
23 changes: 10 additions & 13 deletions lightning/src/ln/chanmon_update_fail_tests.rs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -136,14 +136,11 @@ fn test_monitor_and_persister_update_fail() {
&feeest,
&node_cfgs[0].logger,
) {
// Check that the persister returns InProgress (and will never actually complete)
// as the monitor update errors.
if let ChannelMonitorUpdateStatus::InProgress =
chain_mon.chain_monitor.update_channel(chan.2, &update)
{
} else {
panic!("Expected monitor paused");
}
// Check that the chain monitor returns Err as the monitor update errors.
assert!(
chain_mon.chain_monitor.update_channel(chan.2, &update).is_err(),
"Expected monitor update failure",
);
logger.assert_log_regex(
"lightning::chain::chainmonitor",
regex::Regex::new("Failed to update ChannelMonitor").unwrap(),
Expand All@@ -154,7 +151,7 @@ fn test_monitor_and_persister_update_fail() {
// ChannelManager and ChannelMonitor aren't out of sync.
assert_eq!(
nodes[0].chain_monitor.update_channel(chan.2, &update),
ChannelMonitorUpdateStatus::Completed
Ok(ChannelMonitorUpdateStatus::Completed)
);
} else {
assert!(false);
Expand DownExpand Up@@ -4967,10 +4964,10 @@ fn native_async_persist() {
// Now test two async `ChannelMonitorUpdate`s in flight at once, completing them in-order but
// separately.
let update_status = async_chain_monitor.update_channel(chan_id, &updates[0]);
assert_eq!(update_status, ChannelMonitorUpdateStatus::InProgress);
assert_eq!(update_status, Ok(ChannelMonitorUpdateStatus::InProgress));

let update_status = async_chain_monitor.update_channel(chan_id, &updates[1]);
assert_eq!(update_status, ChannelMonitorUpdateStatus::InProgress);
assert_eq!(update_status, Ok(ChannelMonitorUpdateStatus::InProgress));

persist_futures.poll_futures();
assert_eq!(async_chain_monitor.release_pending_monitor_events().len(), 0);
Expand DownExpand Up@@ -5016,10 +5013,10 @@ fn native_async_persist() {
// out-of-order and ensuring that no `MonitorEvent::Completed` is generated until they are both
// completed (and that it marks both as completed when it is generated).
let update_status = async_chain_monitor.update_channel(chan_id, &updates[2]);
assert_eq!(update_status, ChannelMonitorUpdateStatus::InProgress);
assert_eq!(update_status, Ok(ChannelMonitorUpdateStatus::InProgress));

let update_status = async_chain_monitor.update_channel(chan_id, &updates[3]);
assert_eq!(update_status, ChannelMonitorUpdateStatus::InProgress);
assert_eq!(update_status, Ok(ChannelMonitorUpdateStatus::InProgress));

persist_futures.poll_futures();
assert_eq!(async_chain_monitor.release_pending_monitor_events().len(), 0);
Expand Down
15 changes: 14 additions & 1 deletion lightning/src/ln/channelmanager.rs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -10058,7 +10058,20 @@ This indicates a bug inside LDK. Please report this error at https://github.com/
self.chain_monitor.update_channel(channel_id, &in_flight_updates[update_idx]);
let logger =
WithContext::from(&self.logger, Some(counterparty_node_id), Some(channel_id), None);
let update_completed = self.handle_monitor_update_res(update_res, logger);
// Map monitor update failure (Err) to InProgress to freeze the channel.
// This happens when ChannelMonitor::update_monitor fails internally,
// generally implying the channel has been closed on-chain.
let update_status = match update_res {
Ok(status) => status,
Err(()) => {
log_debug!(
logger,
"ChannelMonitor::update_monitor failed, treating as InProgress to freeze channel.",
);
ChannelMonitorUpdateStatus::InProgress
},
};
let update_completed = self.handle_monitor_update_res(update_status, logger);
if update_completed {
let _ = in_flight_updates.remove(update_idx);
}
Expand Down
16 changes: 5 additions & 11 deletions lightning/src/ln/functional_tests.rs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -7429,13 +7429,10 @@ pub fn test_update_err_monitor_lockdown() {
&feeest,
&node_cfgs[0].logger,
) {
assert_eq!(
watchtower.chain_monitor.update_channel(chan_1.2, &update),
ChannelMonitorUpdateStatus::InProgress
);
assert!(watchtower.chain_monitor.update_channel(chan_1.2, &update).is_err());
assert_eq!(
nodes[0].chain_monitor.update_channel(chan_1.2, &update),
ChannelMonitorUpdateStatus::Completed
Ok(ChannelMonitorUpdateStatus::Completed)
);
} else {
assert!(false);
Expand DownExpand Up@@ -7588,17 +7585,14 @@ pub fn test_concurrent_monitor_claim() {
&node_cfgs[0].logger,
) {
// Watchtower Alice should already have seen the block and reject the update
assert_eq!(
watchtower_alice.chain_monitor.update_channel(chan_1.2, &update),
ChannelMonitorUpdateStatus::InProgress
);
assert!(watchtower_alice.chain_monitor.update_channel(chan_1.2, &update).is_err());
assert_eq!(
watchtower_bob.chain_monitor.update_channel(chan_1.2, &update),
ChannelMonitorUpdateStatus::Completed
Ok(ChannelMonitorUpdateStatus::Completed)
);
assert_eq!(
nodes[0].chain_monitor.update_channel(chan_1.2, &update),
ChannelMonitorUpdateStatus::Completed
Ok(ChannelMonitorUpdateStatus::Completed)
);
} else {
assert!(false);
Expand Down
2 changes: 1 addition & 1 deletion lightning/src/util/test_utils.rs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -617,7 +617,7 @@ impl<'a> chain::Watch<TestChannelSigner> for TestChainMonitor<'a> {

fn update_channel(
&self, channel_id: ChannelId, update: &ChannelMonitorUpdate,
) -> chain::ChannelMonitorUpdateStatus {
) -> Result<chain::ChannelMonitorUpdateStatus, ()> {
#[cfg(feature = "std")]
if let Some(blocker) = &*self.write_blocker.lock().unwrap() {
blocker.recv().unwrap();
Expand Down
Loading
, '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
Return Result from Watch::update_channel to separate monitor failure from persistence status#4445

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

 Closed

joostjager
wants to merge
1
commit into

from

 Closed


Return Result from Watch::update_channel to separate monitor failure from persistence status
#4445
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


27 changes: 15 additions & 12 deletions
fuzz/src/chanmon_consistency.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -320,7 +320,7 @@ impl chain::Watch<TestChannelSigner> for TestChainMonitor {

	fn update_channel(
 &self, channel_id: ChannelId, update: &channelmonitor::ChannelMonitorUpdate,
	) -> chain::ChannelMonitorUpdateStatus {
	) -> Result<chain::ChannelMonitorUpdateStatus, ()> {
 let mut map_lock = self.latest_monitors.lock().unwrap();
 let map_entry = map_lock.get_mut(&channel_id).expect("Didn't have monitor on update call");
 let latest_monitor_data = map_entry
Expand All@@ -336,26 +336,29 @@ impl chain::Watch<TestChannelSigner> for TestChainMonitor {
 )
 .unwrap()
 .1;
 deserialized_monitor
 .update_monitor(
 update,
 &&TestBroadcaster { txn_broadcasted: RefCell::new(Vec::new()) },
 &&FuzzEstimator { ret_val: atomic::AtomicU32::new(253) },
 &self.logger,
 )
 .unwrap();
 let local_update_res = deserialized_monitor.update_monitor(
 update,
 &&TestBroadcaster { txn_broadcasted: RefCell::new(Vec::new()) },
 &&FuzzEstimator { ret_val: atomic::AtomicU32::new(253) },
 &self.logger,
 );
 let mut ser = VecWriter(Vec::new());
 deserialized_monitor.write(&mut ser).unwrap();
 let res = self.chain_monitor.update_channel(channel_id, update);
 match res {
 chain::ChannelMonitorUpdateStatus::Completed => {
 Ok(chain::ChannelMonitorUpdateStatus::Completed) => {
 assert!(local_update_res.is_ok());
 map_entry.persisted_monitor_id = update.update_id;
 map_entry.persisted_monitor = ser.0;
 },
 chain::ChannelMonitorUpdateStatus::InProgress => {
 Ok(chain::ChannelMonitorUpdateStatus::InProgress) => {
 assert!(local_update_res.is_ok());
 map_entry.pending_monitors.push((update.update_id, ser.0));
 },
 chain::ChannelMonitorUpdateStatus::UnrecoverableError => panic!(),
 Ok(chain::ChannelMonitorUpdateStatus::UnrecoverableError) => panic!(),
 Err(()) => {
 assert!(local_update_res.is_err());
 },
 }
 res
	}
Expand Down

8 changes: 4 additions & 4 deletions
lightning/src/chain/chainmonitor.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1311,7 +1311,7 @@ where

	fn update_channel(
 &self, channel_id: ChannelId, update: &ChannelMonitorUpdate,
	) -> ChannelMonitorUpdateStatus {
	) -> Result<ChannelMonitorUpdateStatus, ()> {
 // `ChannelMonitorUpdate`'s `channel_id` is `None` prior to 0.0.121 and all channels in those
 // versions are V1-established. For 0.0.121+ the `channel_id` fields is always `Some`.
 debug_assert_eq!(update.channel_id.unwrap(), channel_id);
Expand All@@ -1328,7 +1328,7 @@ where
 #[cfg(debug_assertions)]
 panic!("ChannelManager generated a channel update for a channel that was not yet registered!");
 #[cfg(not(debug_assertions))]
ChannelMonitorUpdateStatus::InProgress
Err(())
 },
 Some(monitor_state) => {
 let monitor = &monitor_state.monitor;
Expand DownExpand Up@@ -1415,9 +1415,9 @@ where
 }

 if update_res.is_err() {
ChannelMonitorUpdateStatus::InProgress
Err(())
 } else {
 persist_res
Ok(persist_res)
 }
 },
 }
Expand Down

19 changes: 10 additions & 9 deletions
lightning/src/chain/mod.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -316,22 +316,23 @@ pub trait Watch<ChannelSigner: EcdsaChannelSigner> {

	/// Updates a channel identified by `channel_id` by applying `update` to its monitor.
	///
	/// Implementations must call [`ChannelMonitor::update_monitor`] with the given update. This
	/// may fail (returning an `Err(())`), in which case this should return
	/// [`ChannelMonitorUpdateStatus::InProgress`] (and the update should never complete). This
	/// Implementations must call [`ChannelMonitor::update_monitor`] with the given update. If
	/// that call fails (returning an `Err(())`), this method should return `Err(())`. This
	/// generally implies the channel has been closed (either by the funding outpoint being spent
	/// on-chain or the [`ChannelMonitor`] having decided to do so and broadcasted a transaction),
	/// and the [`ChannelManager`] state will be updated once it sees the funding spend on-chain.
	/// Even when `update_monitor` fails, the updated monitor state should still be persisted.
	///
	/// In general, persistence failures should be retried after returning
	/// [`ChannelMonitorUpdateStatus::InProgress`] and eventually complete. If a failure truly
	/// cannot be retried, the node should shut down immediately after returning
	/// [`ChannelMonitorUpdateStatus::UnrecoverableError`], see its documentation for more info.
	/// On success, returns the persistence status. In general, persistence failures should be
	/// retried after returning [`ChannelMonitorUpdateStatus::InProgress`] and eventually
	/// complete. If a failure truly cannot be retried, the node should shut down immediately
	/// after returning [`ChannelMonitorUpdateStatus::UnrecoverableError`], see its documentation
	/// for more info.
	///
	/// [`ChannelManager`]: crate::ln::channelmanager::ChannelManager
	fn update_channel(
 &self, channel_id: ChannelId, update: &ChannelMonitorUpdate,
	) -> ChannelMonitorUpdateStatus;
	) -> Result<ChannelMonitorUpdateStatus, ()>;

	/// Returns any monitor events since the last call. Subsequent calls must only return new
	/// events.
Expand All@@ -358,7 +359,7 @@ impl<ChannelSigner: EcdsaChannelSigner, T: Watch<ChannelSigner> + ?Sized, W: Der

	fn update_channel(
 &self, channel_id: ChannelId, update: &ChannelMonitorUpdate,
	) -> ChannelMonitorUpdateStatus {
	) -> Result<ChannelMonitorUpdateStatus, ()> {
 self.deref().update_channel(channel_id, update)
	}

Expand Down

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

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -136,14 +136,11 @@ fn test_monitor_and_persister_update_fail() {
 &feeest,
 &node_cfgs[0].logger,
 ) {
 // Check that the persister returns InProgress (and will never actually complete)
 // as the monitor update errors.
 if let ChannelMonitorUpdateStatus::InProgress =
 chain_mon.chain_monitor.update_channel(chan.2, &update)
 {
 } else {
 panic!("Expected monitor paused");
 }
 // Check that the chain monitor returns Err as the monitor update errors.
 assert!(
 chain_mon.chain_monitor.update_channel(chan.2, &update).is_err(),
 "Expected monitor update failure",
 );
 logger.assert_log_regex(
 "lightning::chain::chainmonitor",
 regex::Regex::new("Failed to update ChannelMonitor").unwrap(),
Expand All@@ -154,7 +151,7 @@ fn test_monitor_and_persister_update_fail() {
 // ChannelManager and ChannelMonitor aren't out of sync.
 assert_eq!(
 nodes[0].chain_monitor.update_channel(chan.2, &update),
 ChannelMonitorUpdateStatus::Completed
Ok(ChannelMonitorUpdateStatus::Completed)
 );
 } else {
 assert!(false);
Expand DownExpand Up@@ -4967,10 +4964,10 @@ fn native_async_persist() {
	// Now test two async `ChannelMonitorUpdate`s in flight at once, completing them in-order but
	// separately.
	let update_status = async_chain_monitor.update_channel(chan_id, &updates[0]);
	assert_eq!(update_status, ChannelMonitorUpdateStatus::InProgress);
	assert_eq!(update_status, Ok(ChannelMonitorUpdateStatus::InProgress));

	let update_status = async_chain_monitor.update_channel(chan_id, &updates[1]);
	assert_eq!(update_status, ChannelMonitorUpdateStatus::InProgress);
	assert_eq!(update_status, Ok(ChannelMonitorUpdateStatus::InProgress));

	persist_futures.poll_futures();
	assert_eq!(async_chain_monitor.release_pending_monitor_events().len(), 0);
Expand DownExpand Up@@ -5016,10 +5013,10 @@ fn native_async_persist() {
	// out-of-order and ensuring that no `MonitorEvent::Completed` is generated until they are both
	// completed (and that it marks both as completed when it is generated).
	let update_status = async_chain_monitor.update_channel(chan_id, &updates[2]);
	assert_eq!(update_status, ChannelMonitorUpdateStatus::InProgress);
	assert_eq!(update_status, Ok(ChannelMonitorUpdateStatus::InProgress));

	let update_status = async_chain_monitor.update_channel(chan_id, &updates[3]);
	assert_eq!(update_status, ChannelMonitorUpdateStatus::InProgress);
	assert_eq!(update_status, Ok(ChannelMonitorUpdateStatus::InProgress));

	persist_futures.poll_futures();
	assert_eq!(async_chain_monitor.release_pending_monitor_events().len(), 0);
Expand Down

15 changes: 14 additions & 1 deletion
lightning/src/ln/channelmanager.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10058,7 +10058,20 @@ This indicates a bug inside LDK. Please report this error at https://github.com/
 self.chain_monitor.update_channel(channel_id, &in_flight_updates[update_idx]);
 let logger =
 WithContext::from(&self.logger, Some(counterparty_node_id), Some(channel_id), None);
 let update_completed = self.handle_monitor_update_res(update_res, logger);
 // Map monitor update failure (Err) to InProgress to freeze the channel.
 // This happens when ChannelMonitor::update_monitor fails internally,
 // generally implying the channel has been closed on-chain.
 let update_status = match update_res {
 Ok(status) => status,
 Err(()) => {
 log_debug!(
 logger,
 "ChannelMonitor::update_monitor failed, treating as InProgress to freeze channel.",
 );
 ChannelMonitorUpdateStatus::InProgress
 },
 };
 let update_completed = self.handle_monitor_update_res(update_status, logger);
 if update_completed {
 let _ = in_flight_updates.remove(update_idx);
 }
Expand Down

16 changes: 5 additions & 11 deletions
lightning/src/ln/functional_tests.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -7429,13 +7429,10 @@ pub fn test_update_err_monitor_lockdown() {
 &feeest,
 &node_cfgs[0].logger,
 ) {
 assert_eq!(
 watchtower.chain_monitor.update_channel(chan_1.2, &update),
 ChannelMonitorUpdateStatus::InProgress
 );
 assert!(watchtower.chain_monitor.update_channel(chan_1.2, &update).is_err());
 assert_eq!(
 nodes[0].chain_monitor.update_channel(chan_1.2, &update),
 ChannelMonitorUpdateStatus::Completed
Ok(ChannelMonitorUpdateStatus::Completed)
 );
 } else {
 assert!(false);
Expand DownExpand Up@@ -7588,17 +7585,14 @@ pub fn test_concurrent_monitor_claim() {
 &node_cfgs[0].logger,
 ) {
 // Watchtower Alice should already have seen the block and reject the update
 assert_eq!(
 watchtower_alice.chain_monitor.update_channel(chan_1.2, &update),
 ChannelMonitorUpdateStatus::InProgress
 );
 assert!(watchtower_alice.chain_monitor.update_channel(chan_1.2, &update).is_err());
 assert_eq!(
 watchtower_bob.chain_monitor.update_channel(chan_1.2, &update),
 ChannelMonitorUpdateStatus::Completed
Ok(ChannelMonitorUpdateStatus::Completed)
 );
 assert_eq!(
 nodes[0].chain_monitor.update_channel(chan_1.2, &update),
 ChannelMonitorUpdateStatus::Completed
Ok(ChannelMonitorUpdateStatus::Completed)
 );
 } else {
 assert!(false);
Expand Down

2 changes: 1 addition & 1 deletion
lightning/src/util/test_utils.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -617,7 +617,7 @@ impl<'a> chain::Watch<TestChannelSigner> for TestChainMonitor<'a> {

	fn update_channel(
 &self, channel_id: ChannelId, update: &ChannelMonitorUpdate,
	) -> chain::ChannelMonitorUpdateStatus {
	) -> Result<chain::ChannelMonitorUpdateStatus, ()> {
 #[cfg(feature = "std")]
 if let Some(blocker) = &*self.write_blocker.lock().unwrap() {
 blocker.recv().unwrap();
Expand Down
Loading

, '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
Return Result from Watch::update_channel to separate monitor failure from persistence status#4445

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

 Closed

joostjager
wants to merge
1
commit into

from

 Closed


Return Result from Watch::update_channel to separate monitor failure from persistence status
#4445
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


27 changes: 15 additions & 12 deletions
fuzz/src/chanmon_consistency.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -320,7 +320,7 @@ impl chain::Watch<TestChannelSigner> for TestChainMonitor {

	fn update_channel(
 &self, channel_id: ChannelId, update: &channelmonitor::ChannelMonitorUpdate,
	) -> chain::ChannelMonitorUpdateStatus {
	) -> Result<chain::ChannelMonitorUpdateStatus, ()> {
 let mut map_lock = self.latest_monitors.lock().unwrap();
 let map_entry = map_lock.get_mut(&channel_id).expect("Didn't have monitor on update call");
 let latest_monitor_data = map_entry
Expand All@@ -336,26 +336,29 @@ impl chain::Watch<TestChannelSigner> for TestChainMonitor {
 )
 .unwrap()
 .1;
 deserialized_monitor
 .update_monitor(
 update,
 &&TestBroadcaster { txn_broadcasted: RefCell::new(Vec::new()) },
 &&FuzzEstimator { ret_val: atomic::AtomicU32::new(253) },
 &self.logger,
 )
 .unwrap();
 let local_update_res = deserialized_monitor.update_monitor(
 update,
 &&TestBroadcaster { txn_broadcasted: RefCell::new(Vec::new()) },
 &&FuzzEstimator { ret_val: atomic::AtomicU32::new(253) },
 &self.logger,
 );
 let mut ser = VecWriter(Vec::new());
 deserialized_monitor.write(&mut ser).unwrap();
 let res = self.chain_monitor.update_channel(channel_id, update);
 match res {
 chain::ChannelMonitorUpdateStatus::Completed => {
 Ok(chain::ChannelMonitorUpdateStatus::Completed) => {
 assert!(local_update_res.is_ok());
 map_entry.persisted_monitor_id = update.update_id;
 map_entry.persisted_monitor = ser.0;
 },
 chain::ChannelMonitorUpdateStatus::InProgress => {
 Ok(chain::ChannelMonitorUpdateStatus::InProgress) => {
 assert!(local_update_res.is_ok());
 map_entry.pending_monitors.push((update.update_id, ser.0));
 },
 chain::ChannelMonitorUpdateStatus::UnrecoverableError => panic!(),
 Ok(chain::ChannelMonitorUpdateStatus::UnrecoverableError) => panic!(),
 Err(()) => {
 assert!(local_update_res.is_err());
 },
 }
 res
	}
Expand Down

8 changes: 4 additions & 4 deletions
lightning/src/chain/chainmonitor.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1311,7 +1311,7 @@ where

	fn update_channel(
 &self, channel_id: ChannelId, update: &ChannelMonitorUpdate,
	) -> ChannelMonitorUpdateStatus {
	) -> Result<ChannelMonitorUpdateStatus, ()> {
 // `ChannelMonitorUpdate`'s `channel_id` is `None` prior to 0.0.121 and all channels in those
 // versions are V1-established. For 0.0.121+ the `channel_id` fields is always `Some`.
 debug_assert_eq!(update.channel_id.unwrap(), channel_id);
Expand All@@ -1328,7 +1328,7 @@ where
 #[cfg(debug_assertions)]
 panic!("ChannelManager generated a channel update for a channel that was not yet registered!");
 #[cfg(not(debug_assertions))]
ChannelMonitorUpdateStatus::InProgress
Err(())
 },
 Some(monitor_state) => {
 let monitor = &monitor_state.monitor;
Expand DownExpand Up@@ -1415,9 +1415,9 @@ where
 }

 if update_res.is_err() {
ChannelMonitorUpdateStatus::InProgress
Err(())
 } else {
 persist_res
Ok(persist_res)
 }
 },
 }
Expand Down

19 changes: 10 additions & 9 deletions
lightning/src/chain/mod.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -316,22 +316,23 @@ pub trait Watch<ChannelSigner: EcdsaChannelSigner> {

	/// Updates a channel identified by `channel_id` by applying `update` to its monitor.
	///
	/// Implementations must call [`ChannelMonitor::update_monitor`] with the given update. This
	/// may fail (returning an `Err(())`), in which case this should return
	/// [`ChannelMonitorUpdateStatus::InProgress`] (and the update should never complete). This
	/// Implementations must call [`ChannelMonitor::update_monitor`] with the given update. If
	/// that call fails (returning an `Err(())`), this method should return `Err(())`. This
	/// generally implies the channel has been closed (either by the funding outpoint being spent
	/// on-chain or the [`ChannelMonitor`] having decided to do so and broadcasted a transaction),
	/// and the [`ChannelManager`] state will be updated once it sees the funding spend on-chain.
	/// Even when `update_monitor` fails, the updated monitor state should still be persisted.
	///
	/// In general, persistence failures should be retried after returning
	/// [`ChannelMonitorUpdateStatus::InProgress`] and eventually complete. If a failure truly
	/// cannot be retried, the node should shut down immediately after returning
	/// [`ChannelMonitorUpdateStatus::UnrecoverableError`], see its documentation for more info.
	/// On success, returns the persistence status. In general, persistence failures should be
	/// retried after returning [`ChannelMonitorUpdateStatus::InProgress`] and eventually
	/// complete. If a failure truly cannot be retried, the node should shut down immediately
	/// after returning [`ChannelMonitorUpdateStatus::UnrecoverableError`], see its documentation
	/// for more info.
	///
	/// [`ChannelManager`]: crate::ln::channelmanager::ChannelManager
	fn update_channel(
 &self, channel_id: ChannelId, update: &ChannelMonitorUpdate,
	) -> ChannelMonitorUpdateStatus;
	) -> Result<ChannelMonitorUpdateStatus, ()>;

	/// Returns any monitor events since the last call. Subsequent calls must only return new
	/// events.
Expand All@@ -358,7 +359,7 @@ impl<ChannelSigner: EcdsaChannelSigner, T: Watch<ChannelSigner> + ?Sized, W: Der

	fn update_channel(
 &self, channel_id: ChannelId, update: &ChannelMonitorUpdate,
	) -> ChannelMonitorUpdateStatus {
	) -> Result<ChannelMonitorUpdateStatus, ()> {
 self.deref().update_channel(channel_id, update)
	}

Expand Down

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

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -136,14 +136,11 @@ fn test_monitor_and_persister_update_fail() {
 &feeest,
 &node_cfgs[0].logger,
 ) {
 // Check that the persister returns InProgress (and will never actually complete)
 // as the monitor update errors.
 if let ChannelMonitorUpdateStatus::InProgress =
 chain_mon.chain_monitor.update_channel(chan.2, &update)
 {
 } else {
 panic!("Expected monitor paused");
 }
 // Check that the chain monitor returns Err as the monitor update errors.
 assert!(
 chain_mon.chain_monitor.update_channel(chan.2, &update).is_err(),
 "Expected monitor update failure",
 );
 logger.assert_log_regex(
 "lightning::chain::chainmonitor",
 regex::Regex::new("Failed to update ChannelMonitor").unwrap(),
Expand All@@ -154,7 +151,7 @@ fn test_monitor_and_persister_update_fail() {
 // ChannelManager and ChannelMonitor aren't out of sync.
 assert_eq!(
 nodes[0].chain_monitor.update_channel(chan.2, &update),
 ChannelMonitorUpdateStatus::Completed
Ok(ChannelMonitorUpdateStatus::Completed)
 );
 } else {
 assert!(false);
Expand DownExpand Up@@ -4967,10 +4964,10 @@ fn native_async_persist() {
	// Now test two async `ChannelMonitorUpdate`s in flight at once, completing them in-order but
	// separately.
	let update_status = async_chain_monitor.update_channel(chan_id, &updates[0]);
	assert_eq!(update_status, ChannelMonitorUpdateStatus::InProgress);
	assert_eq!(update_status, Ok(ChannelMonitorUpdateStatus::InProgress));

	let update_status = async_chain_monitor.update_channel(chan_id, &updates[1]);
	assert_eq!(update_status, ChannelMonitorUpdateStatus::InProgress);
	assert_eq!(update_status, Ok(ChannelMonitorUpdateStatus::InProgress));

	persist_futures.poll_futures();
	assert_eq!(async_chain_monitor.release_pending_monitor_events().len(), 0);
Expand DownExpand Up@@ -5016,10 +5013,10 @@ fn native_async_persist() {
	// out-of-order and ensuring that no `MonitorEvent::Completed` is generated until they are both
	// completed (and that it marks both as completed when it is generated).
	let update_status = async_chain_monitor.update_channel(chan_id, &updates[2]);
	assert_eq!(update_status, ChannelMonitorUpdateStatus::InProgress);
	assert_eq!(update_status, Ok(ChannelMonitorUpdateStatus::InProgress));

	let update_status = async_chain_monitor.update_channel(chan_id, &updates[3]);
	assert_eq!(update_status, ChannelMonitorUpdateStatus::InProgress);
	assert_eq!(update_status, Ok(ChannelMonitorUpdateStatus::InProgress));

	persist_futures.poll_futures();
	assert_eq!(async_chain_monitor.release_pending_monitor_events().len(), 0);
Expand Down

15 changes: 14 additions & 1 deletion
lightning/src/ln/channelmanager.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10058,7 +10058,20 @@ This indicates a bug inside LDK. Please report this error at https://github.com/
 self.chain_monitor.update_channel(channel_id, &in_flight_updates[update_idx]);
 let logger =
 WithContext::from(&self.logger, Some(counterparty_node_id), Some(channel_id), None);
 let update_completed = self.handle_monitor_update_res(update_res, logger);
 // Map monitor update failure (Err) to InProgress to freeze the channel.
 // This happens when ChannelMonitor::update_monitor fails internally,
 // generally implying the channel has been closed on-chain.
 let update_status = match update_res {
 Ok(status) => status,
 Err(()) => {
 log_debug!(
 logger,
 "ChannelMonitor::update_monitor failed, treating as InProgress to freeze channel.",
 );
 ChannelMonitorUpdateStatus::InProgress
 },
 };
 let update_completed = self.handle_monitor_update_res(update_status, logger);
 if update_completed {
 let _ = in_flight_updates.remove(update_idx);
 }
Expand Down

16 changes: 5 additions & 11 deletions
lightning/src/ln/functional_tests.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -7429,13 +7429,10 @@ pub fn test_update_err_monitor_lockdown() {
 &feeest,
 &node_cfgs[0].logger,
 ) {
 assert_eq!(
 watchtower.chain_monitor.update_channel(chan_1.2, &update),
 ChannelMonitorUpdateStatus::InProgress
 );
 assert!(watchtower.chain_monitor.update_channel(chan_1.2, &update).is_err());
 assert_eq!(
 nodes[0].chain_monitor.update_channel(chan_1.2, &update),
 ChannelMonitorUpdateStatus::Completed
Ok(ChannelMonitorUpdateStatus::Completed)
 );
 } else {
 assert!(false);
Expand DownExpand Up@@ -7588,17 +7585,14 @@ pub fn test_concurrent_monitor_claim() {
 &node_cfgs[0].logger,
 ) {
 // Watchtower Alice should already have seen the block and reject the update
 assert_eq!(
 watchtower_alice.chain_monitor.update_channel(chan_1.2, &update),
 ChannelMonitorUpdateStatus::InProgress
 );
 assert!(watchtower_alice.chain_monitor.update_channel(chan_1.2, &update).is_err());
 assert_eq!(
 watchtower_bob.chain_monitor.update_channel(chan_1.2, &update),
 ChannelMonitorUpdateStatus::Completed
Ok(ChannelMonitorUpdateStatus::Completed)
 );
 assert_eq!(
 nodes[0].chain_monitor.update_channel(chan_1.2, &update),
 ChannelMonitorUpdateStatus::Completed
Ok(ChannelMonitorUpdateStatus::Completed)
 );
 } else {
 assert!(false);
Expand Down

2 changes: 1 addition & 1 deletion
lightning/src/util/test_utils.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -617,7 +617,7 @@ impl<'a> chain::Watch<TestChannelSigner> for TestChainMonitor<'a> {

	fn update_channel(
 &self, channel_id: ChannelId, update: &ChannelMonitorUpdate,
	) -> chain::ChannelMonitorUpdateStatus {
	) -> Result<chain::ChannelMonitorUpdateStatus, ()> {
 #[cfg(feature = "std")]
 if let Some(blocker) = &*self.write_blocker.lock().unwrap() {
 blocker.recv().unwrap();
Expand Down
Loading

, '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
Return Result from Watch::update_channel to separate monitor failure from persistence status#4445

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

 Closed

joostjager
wants to merge
1
commit into

from

 Closed


Return Result from Watch::update_channel to separate monitor failure from persistence status
#4445
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


27 changes: 15 additions & 12 deletions
fuzz/src/chanmon_consistency.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -320,7 +320,7 @@ impl chain::Watch<TestChannelSigner> for TestChainMonitor {

	fn update_channel(
 &self, channel_id: ChannelId, update: &channelmonitor::ChannelMonitorUpdate,
	) -> chain::ChannelMonitorUpdateStatus {
	) -> Result<chain::ChannelMonitorUpdateStatus, ()> {
 let mut map_lock = self.latest_monitors.lock().unwrap();
 let map_entry = map_lock.get_mut(&channel_id).expect("Didn't have monitor on update call");
 let latest_monitor_data = map_entry
Expand All@@ -336,26 +336,29 @@ impl chain::Watch<TestChannelSigner> for TestChainMonitor {
 )
 .unwrap()
 .1;
 deserialized_monitor
 .update_monitor(
 update,
 &&TestBroadcaster { txn_broadcasted: RefCell::new(Vec::new()) },
 &&FuzzEstimator { ret_val: atomic::AtomicU32::new(253) },
 &self.logger,
 )
 .unwrap();
 let local_update_res = deserialized_monitor.update_monitor(
 update,
 &&TestBroadcaster { txn_broadcasted: RefCell::new(Vec::new()) },
 &&FuzzEstimator { ret_val: atomic::AtomicU32::new(253) },
 &self.logger,
 );
 let mut ser = VecWriter(Vec::new());
 deserialized_monitor.write(&mut ser).unwrap();
 let res = self.chain_monitor.update_channel(channel_id, update);
 match res {
 chain::ChannelMonitorUpdateStatus::Completed => {
 Ok(chain::ChannelMonitorUpdateStatus::Completed) => {
 assert!(local_update_res.is_ok());
 map_entry.persisted_monitor_id = update.update_id;
 map_entry.persisted_monitor = ser.0;
 },
 chain::ChannelMonitorUpdateStatus::InProgress => {
 Ok(chain::ChannelMonitorUpdateStatus::InProgress) => {
 assert!(local_update_res.is_ok());
 map_entry.pending_monitors.push((update.update_id, ser.0));
 },
 chain::ChannelMonitorUpdateStatus::UnrecoverableError => panic!(),
 Ok(chain::ChannelMonitorUpdateStatus::UnrecoverableError) => panic!(),
 Err(()) => {
 assert!(local_update_res.is_err());
 },
 }
 res
	}
Expand Down

8 changes: 4 additions & 4 deletions
lightning/src/chain/chainmonitor.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1311,7 +1311,7 @@ where

	fn update_channel(
 &self, channel_id: ChannelId, update: &ChannelMonitorUpdate,
	) -> ChannelMonitorUpdateStatus {
	) -> Result<ChannelMonitorUpdateStatus, ()> {
 // `ChannelMonitorUpdate`'s `channel_id` is `None` prior to 0.0.121 and all channels in those
 // versions are V1-established. For 0.0.121+ the `channel_id` fields is always `Some`.
 debug_assert_eq!(update.channel_id.unwrap(), channel_id);
Expand All@@ -1328,7 +1328,7 @@ where
 #[cfg(debug_assertions)]
 panic!("ChannelManager generated a channel update for a channel that was not yet registered!");
 #[cfg(not(debug_assertions))]
ChannelMonitorUpdateStatus::InProgress
Err(())
 },
 Some(monitor_state) => {
 let monitor = &monitor_state.monitor;
Expand DownExpand Up@@ -1415,9 +1415,9 @@ where
 }

 if update_res.is_err() {
ChannelMonitorUpdateStatus::InProgress
Err(())
 } else {
 persist_res
Ok(persist_res)
 }
 },
 }
Expand Down

19 changes: 10 additions & 9 deletions
lightning/src/chain/mod.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -316,22 +316,23 @@ pub trait Watch<ChannelSigner: EcdsaChannelSigner> {

	/// Updates a channel identified by `channel_id` by applying `update` to its monitor.
	///
	/// Implementations must call [`ChannelMonitor::update_monitor`] with the given update. This
	/// may fail (returning an `Err(())`), in which case this should return
	/// [`ChannelMonitorUpdateStatus::InProgress`] (and the update should never complete). This
	/// Implementations must call [`ChannelMonitor::update_monitor`] with the given update. If
	/// that call fails (returning an `Err(())`), this method should return `Err(())`. This
	/// generally implies the channel has been closed (either by the funding outpoint being spent
	/// on-chain or the [`ChannelMonitor`] having decided to do so and broadcasted a transaction),
	/// and the [`ChannelManager`] state will be updated once it sees the funding spend on-chain.
	/// Even when `update_monitor` fails, the updated monitor state should still be persisted.
	///
	/// In general, persistence failures should be retried after returning
	/// [`ChannelMonitorUpdateStatus::InProgress`] and eventually complete. If a failure truly
	/// cannot be retried, the node should shut down immediately after returning
	/// [`ChannelMonitorUpdateStatus::UnrecoverableError`], see its documentation for more info.
	/// On success, returns the persistence status. In general, persistence failures should be
	/// retried after returning [`ChannelMonitorUpdateStatus::InProgress`] and eventually
	/// complete. If a failure truly cannot be retried, the node should shut down immediately
	/// after returning [`ChannelMonitorUpdateStatus::UnrecoverableError`], see its documentation
	/// for more info.
	///
	/// [`ChannelManager`]: crate::ln::channelmanager::ChannelManager
	fn update_channel(
 &self, channel_id: ChannelId, update: &ChannelMonitorUpdate,
	) -> ChannelMonitorUpdateStatus;
	) -> Result<ChannelMonitorUpdateStatus, ()>;

	/// Returns any monitor events since the last call. Subsequent calls must only return new
	/// events.
Expand All@@ -358,7 +359,7 @@ impl<ChannelSigner: EcdsaChannelSigner, T: Watch<ChannelSigner> + ?Sized, W: Der

	fn update_channel(
 &self, channel_id: ChannelId, update: &ChannelMonitorUpdate,
	) -> ChannelMonitorUpdateStatus {
	) -> Result<ChannelMonitorUpdateStatus, ()> {
 self.deref().update_channel(channel_id, update)
	}

Expand Down

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

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -136,14 +136,11 @@ fn test_monitor_and_persister_update_fail() {
 &feeest,
 &node_cfgs[0].logger,
 ) {
 // Check that the persister returns InProgress (and will never actually complete)
 // as the monitor update errors.
 if let ChannelMonitorUpdateStatus::InProgress =
 chain_mon.chain_monitor.update_channel(chan.2, &update)
 {
 } else {
 panic!("Expected monitor paused");
 }
 // Check that the chain monitor returns Err as the monitor update errors.
 assert!(
 chain_mon.chain_monitor.update_channel(chan.2, &update).is_err(),
 "Expected monitor update failure",
 );
 logger.assert_log_regex(
 "lightning::chain::chainmonitor",
 regex::Regex::new("Failed to update ChannelMonitor").unwrap(),
Expand All@@ -154,7 +151,7 @@ fn test_monitor_and_persister_update_fail() {
 // ChannelManager and ChannelMonitor aren't out of sync.
 assert_eq!(
 nodes[0].chain_monitor.update_channel(chan.2, &update),
 ChannelMonitorUpdateStatus::Completed
Ok(ChannelMonitorUpdateStatus::Completed)
 );
 } else {
 assert!(false);
Expand DownExpand Up@@ -4967,10 +4964,10 @@ fn native_async_persist() {
	// Now test two async `ChannelMonitorUpdate`s in flight at once, completing them in-order but
	// separately.
	let update_status = async_chain_monitor.update_channel(chan_id, &updates[0]);
	assert_eq!(update_status, ChannelMonitorUpdateStatus::InProgress);
	assert_eq!(update_status, Ok(ChannelMonitorUpdateStatus::InProgress));

	let update_status = async_chain_monitor.update_channel(chan_id, &updates[1]);
	assert_eq!(update_status, ChannelMonitorUpdateStatus::InProgress);
	assert_eq!(update_status, Ok(ChannelMonitorUpdateStatus::InProgress));

	persist_futures.poll_futures();
	assert_eq!(async_chain_monitor.release_pending_monitor_events().len(), 0);
Expand DownExpand Up@@ -5016,10 +5013,10 @@ fn native_async_persist() {
	// out-of-order and ensuring that no `MonitorEvent::Completed` is generated until they are both
	// completed (and that it marks both as completed when it is generated).
	let update_status = async_chain_monitor.update_channel(chan_id, &updates[2]);
	assert_eq!(update_status, ChannelMonitorUpdateStatus::InProgress);
	assert_eq!(update_status, Ok(ChannelMonitorUpdateStatus::InProgress));

	let update_status = async_chain_monitor.update_channel(chan_id, &updates[3]);
	assert_eq!(update_status, ChannelMonitorUpdateStatus::InProgress);
	assert_eq!(update_status, Ok(ChannelMonitorUpdateStatus::InProgress));

	persist_futures.poll_futures();
	assert_eq!(async_chain_monitor.release_pending_monitor_events().len(), 0);
Expand Down

15 changes: 14 additions & 1 deletion
lightning/src/ln/channelmanager.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10058,7 +10058,20 @@ This indicates a bug inside LDK. Please report this error at https://github.com/
 self.chain_monitor.update_channel(channel_id, &in_flight_updates[update_idx]);
 let logger =
 WithContext::from(&self.logger, Some(counterparty_node_id), Some(channel_id), None);
 let update_completed = self.handle_monitor_update_res(update_res, logger);
 // Map monitor update failure (Err) to InProgress to freeze the channel.
 // This happens when ChannelMonitor::update_monitor fails internally,
 // generally implying the channel has been closed on-chain.
 let update_status = match update_res {
 Ok(status) => status,
 Err(()) => {
 log_debug!(
 logger,
 "ChannelMonitor::update_monitor failed, treating as InProgress to freeze channel.",
 );
 ChannelMonitorUpdateStatus::InProgress
 },
 };
 let update_completed = self.handle_monitor_update_res(update_status, logger);
 if update_completed {
 let _ = in_flight_updates.remove(update_idx);
 }
Expand Down

16 changes: 5 additions & 11 deletions
lightning/src/ln/functional_tests.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -7429,13 +7429,10 @@ pub fn test_update_err_monitor_lockdown() {
 &feeest,
 &node_cfgs[0].logger,
 ) {
 assert_eq!(
 watchtower.chain_monitor.update_channel(chan_1.2, &update),
 ChannelMonitorUpdateStatus::InProgress
 );
 assert!(watchtower.chain_monitor.update_channel(chan_1.2, &update).is_err());
 assert_eq!(
 nodes[0].chain_monitor.update_channel(chan_1.2, &update),
 ChannelMonitorUpdateStatus::Completed
Ok(ChannelMonitorUpdateStatus::Completed)
 );
 } else {
 assert!(false);
Expand DownExpand Up@@ -7588,17 +7585,14 @@ pub fn test_concurrent_monitor_claim() {
 &node_cfgs[0].logger,
 ) {
 // Watchtower Alice should already have seen the block and reject the update
 assert_eq!(
 watchtower_alice.chain_monitor.update_channel(chan_1.2, &update),
 ChannelMonitorUpdateStatus::InProgress
 );
 assert!(watchtower_alice.chain_monitor.update_channel(chan_1.2, &update).is_err());
 assert_eq!(
 watchtower_bob.chain_monitor.update_channel(chan_1.2, &update),
 ChannelMonitorUpdateStatus::Completed
Ok(ChannelMonitorUpdateStatus::Completed)
 );
 assert_eq!(
 nodes[0].chain_monitor.update_channel(chan_1.2, &update),
 ChannelMonitorUpdateStatus::Completed
Ok(ChannelMonitorUpdateStatus::Completed)
 );
 } else {
 assert!(false);
Expand Down

2 changes: 1 addition & 1 deletion
lightning/src/util/test_utils.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -617,7 +617,7 @@ impl<'a> chain::Watch<TestChannelSigner> for TestChainMonitor<'a> {

	fn update_channel(
 &self, channel_id: ChannelId, update: &ChannelMonitorUpdate,
	) -> chain::ChannelMonitorUpdateStatus {
	) -> Result<chain::ChannelMonitorUpdateStatus, ()> {
 #[cfg(feature = "std")]
 if let Some(blocker) = &*self.write_blocker.lock().unwrap() {
 blocker.recv().unwrap();
Expand Down
Loading

, '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
Return Result from Watch::update_channel to separate monitor failure from persistence status#4445

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

 Closed

joostjager
wants to merge
1
commit into

from

 Closed


Return Result from Watch::update_channel to separate monitor failure from persistence status
#4445
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


27 changes: 15 additions & 12 deletions
fuzz/src/chanmon_consistency.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -320,7 +320,7 @@ impl chain::Watch<TestChannelSigner> for TestChainMonitor {

	fn update_channel(
 &self, channel_id: ChannelId, update: &channelmonitor::ChannelMonitorUpdate,
	) -> chain::ChannelMonitorUpdateStatus {
	) -> Result<chain::ChannelMonitorUpdateStatus, ()> {
 let mut map_lock = self.latest_monitors.lock().unwrap();
 let map_entry = map_lock.get_mut(&channel_id).expect("Didn't have monitor on update call");
 let latest_monitor_data = map_entry
Expand All@@ -336,26 +336,29 @@ impl chain::Watch<TestChannelSigner> for TestChainMonitor {
 )
 .unwrap()
 .1;
 deserialized_monitor
 .update_monitor(
 update,
 &&TestBroadcaster { txn_broadcasted: RefCell::new(Vec::new()) },
 &&FuzzEstimator { ret_val: atomic::AtomicU32::new(253) },
 &self.logger,
 )
 .unwrap();
 let local_update_res = deserialized_monitor.update_monitor(
 update,
 &&TestBroadcaster { txn_broadcasted: RefCell::new(Vec::new()) },
 &&FuzzEstimator { ret_val: atomic::AtomicU32::new(253) },
 &self.logger,
 );
 let mut ser = VecWriter(Vec::new());
 deserialized_monitor.write(&mut ser).unwrap();
 let res = self.chain_monitor.update_channel(channel_id, update);
 match res {
 chain::ChannelMonitorUpdateStatus::Completed => {
 Ok(chain::ChannelMonitorUpdateStatus::Completed) => {
 assert!(local_update_res.is_ok());
 map_entry.persisted_monitor_id = update.update_id;
 map_entry.persisted_monitor = ser.0;
 },
 chain::ChannelMonitorUpdateStatus::InProgress => {
 Ok(chain::ChannelMonitorUpdateStatus::InProgress) => {
 assert!(local_update_res.is_ok());
 map_entry.pending_monitors.push((update.update_id, ser.0));
 },
 chain::ChannelMonitorUpdateStatus::UnrecoverableError => panic!(),
 Ok(chain::ChannelMonitorUpdateStatus::UnrecoverableError) => panic!(),
 Err(()) => {
 assert!(local_update_res.is_err());
 },
 }
 res
	}
Expand Down

8 changes: 4 additions & 4 deletions
lightning/src/chain/chainmonitor.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1311,7 +1311,7 @@ where

	fn update_channel(
 &self, channel_id: ChannelId, update: &ChannelMonitorUpdate,
	) -> ChannelMonitorUpdateStatus {
	) -> Result<ChannelMonitorUpdateStatus, ()> {
 // `ChannelMonitorUpdate`'s `channel_id` is `None` prior to 0.0.121 and all channels in those
 // versions are V1-established. For 0.0.121+ the `channel_id` fields is always `Some`.
 debug_assert_eq!(update.channel_id.unwrap(), channel_id);
Expand All@@ -1328,7 +1328,7 @@ where
 #[cfg(debug_assertions)]
 panic!("ChannelManager generated a channel update for a channel that was not yet registered!");
 #[cfg(not(debug_assertions))]
ChannelMonitorUpdateStatus::InProgress
Err(())
 },
 Some(monitor_state) => {
 let monitor = &monitor_state.monitor;
Expand DownExpand Up@@ -1415,9 +1415,9 @@ where
 }

 if update_res.is_err() {
ChannelMonitorUpdateStatus::InProgress
Err(())
 } else {
 persist_res
Ok(persist_res)
 }
 },
 }
Expand Down

19 changes: 10 additions & 9 deletions
lightning/src/chain/mod.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -316,22 +316,23 @@ pub trait Watch<ChannelSigner: EcdsaChannelSigner> {

	/// Updates a channel identified by `channel_id` by applying `update` to its monitor.
	///
	/// Implementations must call [`ChannelMonitor::update_monitor`] with the given update. This
	/// may fail (returning an `Err(())`), in which case this should return
	/// [`ChannelMonitorUpdateStatus::InProgress`] (and the update should never complete). This
	/// Implementations must call [`ChannelMonitor::update_monitor`] with the given update. If
	/// that call fails (returning an `Err(())`), this method should return `Err(())`. This
	/// generally implies the channel has been closed (either by the funding outpoint being spent
	/// on-chain or the [`ChannelMonitor`] having decided to do so and broadcasted a transaction),
	/// and the [`ChannelManager`] state will be updated once it sees the funding spend on-chain.
	/// Even when `update_monitor` fails, the updated monitor state should still be persisted.
	///
	/// In general, persistence failures should be retried after returning
	/// [`ChannelMonitorUpdateStatus::InProgress`] and eventually complete. If a failure truly
	/// cannot be retried, the node should shut down immediately after returning
	/// [`ChannelMonitorUpdateStatus::UnrecoverableError`], see its documentation for more info.
	/// On success, returns the persistence status. In general, persistence failures should be
	/// retried after returning [`ChannelMonitorUpdateStatus::InProgress`] and eventually
	/// complete. If a failure truly cannot be retried, the node should shut down immediately
	/// after returning [`ChannelMonitorUpdateStatus::UnrecoverableError`], see its documentation
	/// for more info.
	///
	/// [`ChannelManager`]: crate::ln::channelmanager::ChannelManager
	fn update_channel(
 &self, channel_id: ChannelId, update: &ChannelMonitorUpdate,
	) -> ChannelMonitorUpdateStatus;
	) -> Result<ChannelMonitorUpdateStatus, ()>;

	/// Returns any monitor events since the last call. Subsequent calls must only return new
	/// events.
Expand All@@ -358,7 +359,7 @@ impl<ChannelSigner: EcdsaChannelSigner, T: Watch<ChannelSigner> + ?Sized, W: Der

	fn update_channel(
 &self, channel_id: ChannelId, update: &ChannelMonitorUpdate,
	) -> ChannelMonitorUpdateStatus {
	) -> Result<ChannelMonitorUpdateStatus, ()> {
 self.deref().update_channel(channel_id, update)
	}

Expand Down

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

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -136,14 +136,11 @@ fn test_monitor_and_persister_update_fail() {
 &feeest,
 &node_cfgs[0].logger,
 ) {
 // Check that the persister returns InProgress (and will never actually complete)
 // as the monitor update errors.
 if let ChannelMonitorUpdateStatus::InProgress =
 chain_mon.chain_monitor.update_channel(chan.2, &update)
 {
 } else {
 panic!("Expected monitor paused");
 }
 // Check that the chain monitor returns Err as the monitor update errors.
 assert!(
 chain_mon.chain_monitor.update_channel(chan.2, &update).is_err(),
 "Expected monitor update failure",
 );
 logger.assert_log_regex(
 "lightning::chain::chainmonitor",
 regex::Regex::new("Failed to update ChannelMonitor").unwrap(),
Expand All@@ -154,7 +151,7 @@ fn test_monitor_and_persister_update_fail() {
 // ChannelManager and ChannelMonitor aren't out of sync.
 assert_eq!(
 nodes[0].chain_monitor.update_channel(chan.2, &update),
 ChannelMonitorUpdateStatus::Completed
Ok(ChannelMonitorUpdateStatus::Completed)
 );
 } else {
 assert!(false);
Expand DownExpand Up@@ -4967,10 +4964,10 @@ fn native_async_persist() {
	// Now test two async `ChannelMonitorUpdate`s in flight at once, completing them in-order but
	// separately.
	let update_status = async_chain_monitor.update_channel(chan_id, &updates[0]);
	assert_eq!(update_status, ChannelMonitorUpdateStatus::InProgress);
	assert_eq!(update_status, Ok(ChannelMonitorUpdateStatus::InProgress));

	let update_status = async_chain_monitor.update_channel(chan_id, &updates[1]);
	assert_eq!(update_status, ChannelMonitorUpdateStatus::InProgress);
	assert_eq!(update_status, Ok(ChannelMonitorUpdateStatus::InProgress));

	persist_futures.poll_futures();
	assert_eq!(async_chain_monitor.release_pending_monitor_events().len(), 0);
Expand DownExpand Up@@ -5016,10 +5013,10 @@ fn native_async_persist() {
	// out-of-order and ensuring that no `MonitorEvent::Completed` is generated until they are both
	// completed (and that it marks both as completed when it is generated).
	let update_status = async_chain_monitor.update_channel(chan_id, &updates[2]);
	assert_eq!(update_status, ChannelMonitorUpdateStatus::InProgress);
	assert_eq!(update_status, Ok(ChannelMonitorUpdateStatus::InProgress));

	let update_status = async_chain_monitor.update_channel(chan_id, &updates[3]);
	assert_eq!(update_status, ChannelMonitorUpdateStatus::InProgress);
	assert_eq!(update_status, Ok(ChannelMonitorUpdateStatus::InProgress));

	persist_futures.poll_futures();
	assert_eq!(async_chain_monitor.release_pending_monitor_events().len(), 0);
Expand Down

15 changes: 14 additions & 1 deletion
lightning/src/ln/channelmanager.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10058,7 +10058,20 @@ This indicates a bug inside LDK. Please report this error at https://github.com/
 self.chain_monitor.update_channel(channel_id, &in_flight_updates[update_idx]);
 let logger =
 WithContext::from(&self.logger, Some(counterparty_node_id), Some(channel_id), None);
 let update_completed = self.handle_monitor_update_res(update_res, logger);
 // Map monitor update failure (Err) to InProgress to freeze the channel.
 // This happens when ChannelMonitor::update_monitor fails internally,
 // generally implying the channel has been closed on-chain.
 let update_status = match update_res {
 Ok(status) => status,
 Err(()) => {
 log_debug!(
 logger,
 "ChannelMonitor::update_monitor failed, treating as InProgress to freeze channel.",
 );
 ChannelMonitorUpdateStatus::InProgress
 },
 };
 let update_completed = self.handle_monitor_update_res(update_status, logger);
 if update_completed {
 let _ = in_flight_updates.remove(update_idx);
 }
Expand Down

16 changes: 5 additions & 11 deletions
lightning/src/ln/functional_tests.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -7429,13 +7429,10 @@ pub fn test_update_err_monitor_lockdown() {
 &feeest,
 &node_cfgs[0].logger,
 ) {
 assert_eq!(
 watchtower.chain_monitor.update_channel(chan_1.2, &update),
 ChannelMonitorUpdateStatus::InProgress
 );
 assert!(watchtower.chain_monitor.update_channel(chan_1.2, &update).is_err());
 assert_eq!(
 nodes[0].chain_monitor.update_channel(chan_1.2, &update),
 ChannelMonitorUpdateStatus::Completed
Ok(ChannelMonitorUpdateStatus::Completed)
 );
 } else {
 assert!(false);
Expand DownExpand Up@@ -7588,17 +7585,14 @@ pub fn test_concurrent_monitor_claim() {
 &node_cfgs[0].logger,
 ) {
 // Watchtower Alice should already have seen the block and reject the update
 assert_eq!(
 watchtower_alice.chain_monitor.update_channel(chan_1.2, &update),
 ChannelMonitorUpdateStatus::InProgress
 );
 assert!(watchtower_alice.chain_monitor.update_channel(chan_1.2, &update).is_err());
 assert_eq!(
 watchtower_bob.chain_monitor.update_channel(chan_1.2, &update),
 ChannelMonitorUpdateStatus::Completed
Ok(ChannelMonitorUpdateStatus::Completed)
 );
 assert_eq!(
 nodes[0].chain_monitor.update_channel(chan_1.2, &update),
 ChannelMonitorUpdateStatus::Completed
Ok(ChannelMonitorUpdateStatus::Completed)
 );
 } else {
 assert!(false);
Expand Down

2 changes: 1 addition & 1 deletion
lightning/src/util/test_utils.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -617,7 +617,7 @@ impl<'a> chain::Watch<TestChannelSigner> for TestChainMonitor<'a> {

	fn update_channel(
 &self, channel_id: ChannelId, update: &ChannelMonitorUpdate,
	) -> chain::ChannelMonitorUpdateStatus {
	) -> Result<chain::ChannelMonitorUpdateStatus, ()> {
 #[cfg(feature = "std")]
 if let Some(blocker) = &*self.write_blocker.lock().unwrap() {
 blocker.recv().unwrap();
Expand Down
Loading

, '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
Return Result from Watch::update_channel to separate monitor failure from persistence status#4445

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

 Closed

joostjager
wants to merge
1
commit into

from

 Closed


Return Result from Watch::update_channel to separate monitor failure from persistence status
#4445
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


27 changes: 15 additions & 12 deletions
fuzz/src/chanmon_consistency.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -320,7 +320,7 @@ impl chain::Watch<TestChannelSigner> for TestChainMonitor {

	fn update_channel(
 &self, channel_id: ChannelId, update: &channelmonitor::ChannelMonitorUpdate,
	) -> chain::ChannelMonitorUpdateStatus {
	) -> Result<chain::ChannelMonitorUpdateStatus, ()> {
 let mut map_lock = self.latest_monitors.lock().unwrap();
 let map_entry = map_lock.get_mut(&channel_id).expect("Didn't have monitor on update call");
 let latest_monitor_data = map_entry
Expand All@@ -336,26 +336,29 @@ impl chain::Watch<TestChannelSigner> for TestChainMonitor {
 )
 .unwrap()
 .1;
 deserialized_monitor
 .update_monitor(
 update,
 &&TestBroadcaster { txn_broadcasted: RefCell::new(Vec::new()) },
 &&FuzzEstimator { ret_val: atomic::AtomicU32::new(253) },
 &self.logger,
 )
 .unwrap();
 let local_update_res = deserialized_monitor.update_monitor(
 update,
 &&TestBroadcaster { txn_broadcasted: RefCell::new(Vec::new()) },
 &&FuzzEstimator { ret_val: atomic::AtomicU32::new(253) },
 &self.logger,
 );
 let mut ser = VecWriter(Vec::new());
 deserialized_monitor.write(&mut ser).unwrap();
 let res = self.chain_monitor.update_channel(channel_id, update);
 match res {
 chain::ChannelMonitorUpdateStatus::Completed => {
 Ok(chain::ChannelMonitorUpdateStatus::Completed) => {
 assert!(local_update_res.is_ok());
 map_entry.persisted_monitor_id = update.update_id;
 map_entry.persisted_monitor = ser.0;
 },
 chain::ChannelMonitorUpdateStatus::InProgress => {
 Ok(chain::ChannelMonitorUpdateStatus::InProgress) => {
 assert!(local_update_res.is_ok());
 map_entry.pending_monitors.push((update.update_id, ser.0));
 },
 chain::ChannelMonitorUpdateStatus::UnrecoverableError => panic!(),
 Ok(chain::ChannelMonitorUpdateStatus::UnrecoverableError) => panic!(),
 Err(()) => {
 assert!(local_update_res.is_err());
 },
 }
 res
	}
Expand Down

8 changes: 4 additions & 4 deletions
lightning/src/chain/chainmonitor.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1311,7 +1311,7 @@ where

	fn update_channel(
 &self, channel_id: ChannelId, update: &ChannelMonitorUpdate,
	) -> ChannelMonitorUpdateStatus {
	) -> Result<ChannelMonitorUpdateStatus, ()> {
 // `ChannelMonitorUpdate`'s `channel_id` is `None` prior to 0.0.121 and all channels in those
 // versions are V1-established. For 0.0.121+ the `channel_id` fields is always `Some`.
 debug_assert_eq!(update.channel_id.unwrap(), channel_id);
Expand All@@ -1328,7 +1328,7 @@ where
 #[cfg(debug_assertions)]
 panic!("ChannelManager generated a channel update for a channel that was not yet registered!");
 #[cfg(not(debug_assertions))]
ChannelMonitorUpdateStatus::InProgress
Err(())
 },
 Some(monitor_state) => {
 let monitor = &monitor_state.monitor;
Expand DownExpand Up@@ -1415,9 +1415,9 @@ where
 }

 if update_res.is_err() {
ChannelMonitorUpdateStatus::InProgress
Err(())
 } else {
 persist_res
Ok(persist_res)
 }
 },
 }
Expand Down

19 changes: 10 additions & 9 deletions
lightning/src/chain/mod.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -316,22 +316,23 @@ pub trait Watch<ChannelSigner: EcdsaChannelSigner> {

	/// Updates a channel identified by `channel_id` by applying `update` to its monitor.
	///
	/// Implementations must call [`ChannelMonitor::update_monitor`] with the given update. This
	/// may fail (returning an `Err(())`), in which case this should return
	/// [`ChannelMonitorUpdateStatus::InProgress`] (and the update should never complete). This
	/// Implementations must call [`ChannelMonitor::update_monitor`] with the given update. If
	/// that call fails (returning an `Err(())`), this method should return `Err(())`. This
	/// generally implies the channel has been closed (either by the funding outpoint being spent
	/// on-chain or the [`ChannelMonitor`] having decided to do so and broadcasted a transaction),
	/// and the [`ChannelManager`] state will be updated once it sees the funding spend on-chain.
	/// Even when `update_monitor` fails, the updated monitor state should still be persisted.
	///
	/// In general, persistence failures should be retried after returning
	/// [`ChannelMonitorUpdateStatus::InProgress`] and eventually complete. If a failure truly
	/// cannot be retried, the node should shut down immediately after returning
	/// [`ChannelMonitorUpdateStatus::UnrecoverableError`], see its documentation for more info.
	/// On success, returns the persistence status. In general, persistence failures should be
	/// retried after returning [`ChannelMonitorUpdateStatus::InProgress`] and eventually
	/// complete. If a failure truly cannot be retried, the node should shut down immediately
	/// after returning [`ChannelMonitorUpdateStatus::UnrecoverableError`], see its documentation
	/// for more info.
	///
	/// [`ChannelManager`]: crate::ln::channelmanager::ChannelManager
	fn update_channel(
 &self, channel_id: ChannelId, update: &ChannelMonitorUpdate,
	) -> ChannelMonitorUpdateStatus;
	) -> Result<ChannelMonitorUpdateStatus, ()>;

	/// Returns any monitor events since the last call. Subsequent calls must only return new
	/// events.
Expand All@@ -358,7 +359,7 @@ impl<ChannelSigner: EcdsaChannelSigner, T: Watch<ChannelSigner> + ?Sized, W: Der

	fn update_channel(
 &self, channel_id: ChannelId, update: &ChannelMonitorUpdate,
	) -> ChannelMonitorUpdateStatus {
	) -> Result<ChannelMonitorUpdateStatus, ()> {
 self.deref().update_channel(channel_id, update)
	}

Expand Down

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

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -136,14 +136,11 @@ fn test_monitor_and_persister_update_fail() {
 &feeest,
 &node_cfgs[0].logger,
 ) {
 // Check that the persister returns InProgress (and will never actually complete)
 // as the monitor update errors.
 if let ChannelMonitorUpdateStatus::InProgress =
 chain_mon.chain_monitor.update_channel(chan.2, &update)
 {
 } else {
 panic!("Expected monitor paused");
 }
 // Check that the chain monitor returns Err as the monitor update errors.
 assert!(
 chain_mon.chain_monitor.update_channel(chan.2, &update).is_err(),
 "Expected monitor update failure",
 );
 logger.assert_log_regex(
 "lightning::chain::chainmonitor",
 regex::Regex::new("Failed to update ChannelMonitor").unwrap(),
Expand All@@ -154,7 +151,7 @@ fn test_monitor_and_persister_update_fail() {
 // ChannelManager and ChannelMonitor aren't out of sync.
 assert_eq!(
 nodes[0].chain_monitor.update_channel(chan.2, &update),
 ChannelMonitorUpdateStatus::Completed
Ok(ChannelMonitorUpdateStatus::Completed)
 );
 } else {
 assert!(false);
Expand DownExpand Up@@ -4967,10 +4964,10 @@ fn native_async_persist() {
	// Now test two async `ChannelMonitorUpdate`s in flight at once, completing them in-order but
	// separately.
	let update_status = async_chain_monitor.update_channel(chan_id, &updates[0]);
	assert_eq!(update_status, ChannelMonitorUpdateStatus::InProgress);
	assert_eq!(update_status, Ok(ChannelMonitorUpdateStatus::InProgress));

	let update_status = async_chain_monitor.update_channel(chan_id, &updates[1]);
	assert_eq!(update_status, ChannelMonitorUpdateStatus::InProgress);
	assert_eq!(update_status, Ok(ChannelMonitorUpdateStatus::InProgress));

	persist_futures.poll_futures();
	assert_eq!(async_chain_monitor.release_pending_monitor_events().len(), 0);
Expand DownExpand Up@@ -5016,10 +5013,10 @@ fn native_async_persist() {
	// out-of-order and ensuring that no `MonitorEvent::Completed` is generated until they are both
	// completed (and that it marks both as completed when it is generated).
	let update_status = async_chain_monitor.update_channel(chan_id, &updates[2]);
	assert_eq!(update_status, ChannelMonitorUpdateStatus::InProgress);
	assert_eq!(update_status, Ok(ChannelMonitorUpdateStatus::InProgress));

	let update_status = async_chain_monitor.update_channel(chan_id, &updates[3]);
	assert_eq!(update_status, ChannelMonitorUpdateStatus::InProgress);
	assert_eq!(update_status, Ok(ChannelMonitorUpdateStatus::InProgress));

	persist_futures.poll_futures();
	assert_eq!(async_chain_monitor.release_pending_monitor_events().len(), 0);
Expand Down

15 changes: 14 additions & 1 deletion
lightning/src/ln/channelmanager.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10058,7 +10058,20 @@ This indicates a bug inside LDK. Please report this error at https://github.com/
 self.chain_monitor.update_channel(channel_id, &in_flight_updates[update_idx]);
 let logger =
 WithContext::from(&self.logger, Some(counterparty_node_id), Some(channel_id), None);
 let update_completed = self.handle_monitor_update_res(update_res, logger);
 // Map monitor update failure (Err) to InProgress to freeze the channel.
 // This happens when ChannelMonitor::update_monitor fails internally,
 // generally implying the channel has been closed on-chain.
 let update_status = match update_res {
 Ok(status) => status,
 Err(()) => {
 log_debug!(
 logger,
 "ChannelMonitor::update_monitor failed, treating as InProgress to freeze channel.",
 );
 ChannelMonitorUpdateStatus::InProgress
 },
 };
 let update_completed = self.handle_monitor_update_res(update_status, logger);
 if update_completed {
 let _ = in_flight_updates.remove(update_idx);
 }
Expand Down

16 changes: 5 additions & 11 deletions
lightning/src/ln/functional_tests.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -7429,13 +7429,10 @@ pub fn test_update_err_monitor_lockdown() {
 &feeest,
 &node_cfgs[0].logger,
 ) {
 assert_eq!(
 watchtower.chain_monitor.update_channel(chan_1.2, &update),
 ChannelMonitorUpdateStatus::InProgress
 );
 assert!(watchtower.chain_monitor.update_channel(chan_1.2, &update).is_err());
 assert_eq!(
 nodes[0].chain_monitor.update_channel(chan_1.2, &update),
 ChannelMonitorUpdateStatus::Completed
Ok(ChannelMonitorUpdateStatus::Completed)
 );
 } else {
 assert!(false);
Expand DownExpand Up@@ -7588,17 +7585,14 @@ pub fn test_concurrent_monitor_claim() {
 &node_cfgs[0].logger,
 ) {
 // Watchtower Alice should already have seen the block and reject the update
 assert_eq!(
 watchtower_alice.chain_monitor.update_channel(chan_1.2, &update),
 ChannelMonitorUpdateStatus::InProgress
 );
 assert!(watchtower_alice.chain_monitor.update_channel(chan_1.2, &update).is_err());
 assert_eq!(
 watchtower_bob.chain_monitor.update_channel(chan_1.2, &update),
 ChannelMonitorUpdateStatus::Completed
Ok(ChannelMonitorUpdateStatus::Completed)
 );
 assert_eq!(
 nodes[0].chain_monitor.update_channel(chan_1.2, &update),
 ChannelMonitorUpdateStatus::Completed
Ok(ChannelMonitorUpdateStatus::Completed)
 );
 } else {
 assert!(false);
Expand Down

2 changes: 1 addition & 1 deletion
lightning/src/util/test_utils.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -617,7 +617,7 @@ impl<'a> chain::Watch<TestChannelSigner> for TestChainMonitor<'a> {

	fn update_channel(
 &self, channel_id: ChannelId, update: &ChannelMonitorUpdate,
	) -> chain::ChannelMonitorUpdateStatus {
	) -> Result<chain::ChannelMonitorUpdateStatus, ()> {
 #[cfg(feature = "std")]
 if let Some(blocker) = &*self.write_blocker.lock().unwrap() {
 blocker.recv().unwrap();
Expand Down
Loading

, '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
Return Result from Watch::update_channel to separate monitor failure from persistence status#4445

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

 Closed

joostjager
wants to merge
1
commit into

from

 Closed


Return Result from Watch::update_channel to separate monitor failure from persistence status
#4445
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


27 changes: 15 additions & 12 deletions
fuzz/src/chanmon_consistency.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -320,7 +320,7 @@ impl chain::Watch<TestChannelSigner> for TestChainMonitor {

	fn update_channel(
 &self, channel_id: ChannelId, update: &channelmonitor::ChannelMonitorUpdate,
	) -> chain::ChannelMonitorUpdateStatus {
	) -> Result<chain::ChannelMonitorUpdateStatus, ()> {
 let mut map_lock = self.latest_monitors.lock().unwrap();
 let map_entry = map_lock.get_mut(&channel_id).expect("Didn't have monitor on update call");
 let latest_monitor_data = map_entry
Expand All@@ -336,26 +336,29 @@ impl chain::Watch<TestChannelSigner> for TestChainMonitor {
 )
 .unwrap()
 .1;
 deserialized_monitor
 .update_monitor(
 update,
 &&TestBroadcaster { txn_broadcasted: RefCell::new(Vec::new()) },
 &&FuzzEstimator { ret_val: atomic::AtomicU32::new(253) },
 &self.logger,
 )
 .unwrap();
 let local_update_res = deserialized_monitor.update_monitor(
 update,
 &&TestBroadcaster { txn_broadcasted: RefCell::new(Vec::new()) },
 &&FuzzEstimator { ret_val: atomic::AtomicU32::new(253) },
 &self.logger,
 );
 let mut ser = VecWriter(Vec::new());
 deserialized_monitor.write(&mut ser).unwrap();
 let res = self.chain_monitor.update_channel(channel_id, update);
 match res {
 chain::ChannelMonitorUpdateStatus::Completed => {
 Ok(chain::ChannelMonitorUpdateStatus::Completed) => {
 assert!(local_update_res.is_ok());
 map_entry.persisted_monitor_id = update.update_id;
 map_entry.persisted_monitor = ser.0;
 },
 chain::ChannelMonitorUpdateStatus::InProgress => {
 Ok(chain::ChannelMonitorUpdateStatus::InProgress) => {
 assert!(local_update_res.is_ok());
 map_entry.pending_monitors.push((update.update_id, ser.0));
 },
 chain::ChannelMonitorUpdateStatus::UnrecoverableError => panic!(),
 Ok(chain::ChannelMonitorUpdateStatus::UnrecoverableError) => panic!(),
 Err(()) => {
 assert!(local_update_res.is_err());
 },
 }
 res
	}
Expand Down

8 changes: 4 additions & 4 deletions
lightning/src/chain/chainmonitor.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1311,7 +1311,7 @@ where

	fn update_channel(
 &self, channel_id: ChannelId, update: &ChannelMonitorUpdate,
	) -> ChannelMonitorUpdateStatus {
	) -> Result<ChannelMonitorUpdateStatus, ()> {
 // `ChannelMonitorUpdate`'s `channel_id` is `None` prior to 0.0.121 and all channels in those
 // versions are V1-established. For 0.0.121+ the `channel_id` fields is always `Some`.
 debug_assert_eq!(update.channel_id.unwrap(), channel_id);
Expand All@@ -1328,7 +1328,7 @@ where
 #[cfg(debug_assertions)]
 panic!("ChannelManager generated a channel update for a channel that was not yet registered!");
 #[cfg(not(debug_assertions))]
ChannelMonitorUpdateStatus::InProgress
Err(())
 },
 Some(monitor_state) => {
 let monitor = &monitor_state.monitor;
Expand DownExpand Up@@ -1415,9 +1415,9 @@ where
 }

 if update_res.is_err() {
ChannelMonitorUpdateStatus::InProgress
Err(())
 } else {
 persist_res
Ok(persist_res)
 }
 },
 }
Expand Down

19 changes: 10 additions & 9 deletions
lightning/src/chain/mod.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -316,22 +316,23 @@ pub trait Watch<ChannelSigner: EcdsaChannelSigner> {

	/// Updates a channel identified by `channel_id` by applying `update` to its monitor.
	///
	/// Implementations must call [`ChannelMonitor::update_monitor`] with the given update. This
	/// may fail (returning an `Err(())`), in which case this should return
	/// [`ChannelMonitorUpdateStatus::InProgress`] (and the update should never complete). This
	/// Implementations must call [`ChannelMonitor::update_monitor`] with the given update. If
	/// that call fails (returning an `Err(())`), this method should return `Err(())`. This
	/// generally implies the channel has been closed (either by the funding outpoint being spent
	/// on-chain or the [`ChannelMonitor`] having decided to do so and broadcasted a transaction),
	/// and the [`ChannelManager`] state will be updated once it sees the funding spend on-chain.
	/// Even when `update_monitor` fails, the updated monitor state should still be persisted.
	///
	/// In general, persistence failures should be retried after returning
	/// [`ChannelMonitorUpdateStatus::InProgress`] and eventually complete. If a failure truly
	/// cannot be retried, the node should shut down immediately after returning
	/// [`ChannelMonitorUpdateStatus::UnrecoverableError`], see its documentation for more info.
	/// On success, returns the persistence status. In general, persistence failures should be
	/// retried after returning [`ChannelMonitorUpdateStatus::InProgress`] and eventually
	/// complete. If a failure truly cannot be retried, the node should shut down immediately
	/// after returning [`ChannelMonitorUpdateStatus::UnrecoverableError`], see its documentation
	/// for more info.
	///
	/// [`ChannelManager`]: crate::ln::channelmanager::ChannelManager
	fn update_channel(
 &self, channel_id: ChannelId, update: &ChannelMonitorUpdate,
	) -> ChannelMonitorUpdateStatus;
	) -> Result<ChannelMonitorUpdateStatus, ()>;

	/// Returns any monitor events since the last call. Subsequent calls must only return new
	/// events.
Expand All@@ -358,7 +359,7 @@ impl<ChannelSigner: EcdsaChannelSigner, T: Watch<ChannelSigner> + ?Sized, W: Der

	fn update_channel(
 &self, channel_id: ChannelId, update: &ChannelMonitorUpdate,
	) -> ChannelMonitorUpdateStatus {
	) -> Result<ChannelMonitorUpdateStatus, ()> {
 self.deref().update_channel(channel_id, update)
	}

Expand Down

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

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -136,14 +136,11 @@ fn test_monitor_and_persister_update_fail() {
 &feeest,
 &node_cfgs[0].logger,
 ) {
 // Check that the persister returns InProgress (and will never actually complete)
 // as the monitor update errors.
 if let ChannelMonitorUpdateStatus::InProgress =
 chain_mon.chain_monitor.update_channel(chan.2, &update)
 {
 } else {
 panic!("Expected monitor paused");
 }
 // Check that the chain monitor returns Err as the monitor update errors.
 assert!(
 chain_mon.chain_monitor.update_channel(chan.2, &update).is_err(),
 "Expected monitor update failure",
 );
 logger.assert_log_regex(
 "lightning::chain::chainmonitor",
 regex::Regex::new("Failed to update ChannelMonitor").unwrap(),
Expand All@@ -154,7 +151,7 @@ fn test_monitor_and_persister_update_fail() {
 // ChannelManager and ChannelMonitor aren't out of sync.
 assert_eq!(
 nodes[0].chain_monitor.update_channel(chan.2, &update),
 ChannelMonitorUpdateStatus::Completed
Ok(ChannelMonitorUpdateStatus::Completed)
 );
 } else {
 assert!(false);
Expand DownExpand Up@@ -4967,10 +4964,10 @@ fn native_async_persist() {
	// Now test two async `ChannelMonitorUpdate`s in flight at once, completing them in-order but
	// separately.
	let update_status = async_chain_monitor.update_channel(chan_id, &updates[0]);
	assert_eq!(update_status, ChannelMonitorUpdateStatus::InProgress);
	assert_eq!(update_status, Ok(ChannelMonitorUpdateStatus::InProgress));

	let update_status = async_chain_monitor.update_channel(chan_id, &updates[1]);
	assert_eq!(update_status, ChannelMonitorUpdateStatus::InProgress);
	assert_eq!(update_status, Ok(ChannelMonitorUpdateStatus::InProgress));

	persist_futures.poll_futures();
	assert_eq!(async_chain_monitor.release_pending_monitor_events().len(), 0);
Expand DownExpand Up@@ -5016,10 +5013,10 @@ fn native_async_persist() {
	// out-of-order and ensuring that no `MonitorEvent::Completed` is generated until they are both
	// completed (and that it marks both as completed when it is generated).
	let update_status = async_chain_monitor.update_channel(chan_id, &updates[2]);
	assert_eq!(update_status, ChannelMonitorUpdateStatus::InProgress);
	assert_eq!(update_status, Ok(ChannelMonitorUpdateStatus::InProgress));

	let update_status = async_chain_monitor.update_channel(chan_id, &updates[3]);
	assert_eq!(update_status, ChannelMonitorUpdateStatus::InProgress);
	assert_eq!(update_status, Ok(ChannelMonitorUpdateStatus::InProgress));

	persist_futures.poll_futures();
	assert_eq!(async_chain_monitor.release_pending_monitor_events().len(), 0);
Expand Down

15 changes: 14 additions & 1 deletion
lightning/src/ln/channelmanager.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10058,7 +10058,20 @@ This indicates a bug inside LDK. Please report this error at https://github.com/
 self.chain_monitor.update_channel(channel_id, &in_flight_updates[update_idx]);
 let logger =
 WithContext::from(&self.logger, Some(counterparty_node_id), Some(channel_id), None);
 let update_completed = self.handle_monitor_update_res(update_res, logger);
 // Map monitor update failure (Err) to InProgress to freeze the channel.
 // This happens when ChannelMonitor::update_monitor fails internally,
 // generally implying the channel has been closed on-chain.
 let update_status = match update_res {
 Ok(status) => status,
 Err(()) => {
 log_debug!(
 logger,
 "ChannelMonitor::update_monitor failed, treating as InProgress to freeze channel.",
 );
 ChannelMonitorUpdateStatus::InProgress
 },
 };
 let update_completed = self.handle_monitor_update_res(update_status, logger);
 if update_completed {
 let _ = in_flight_updates.remove(update_idx);
 }
Expand Down

16 changes: 5 additions & 11 deletions
lightning/src/ln/functional_tests.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -7429,13 +7429,10 @@ pub fn test_update_err_monitor_lockdown() {
 &feeest,
 &node_cfgs[0].logger,
 ) {
 assert_eq!(
 watchtower.chain_monitor.update_channel(chan_1.2, &update),
 ChannelMonitorUpdateStatus::InProgress
 );
 assert!(watchtower.chain_monitor.update_channel(chan_1.2, &update).is_err());
 assert_eq!(
 nodes[0].chain_monitor.update_channel(chan_1.2, &update),
 ChannelMonitorUpdateStatus::Completed
Ok(ChannelMonitorUpdateStatus::Completed)
 );
 } else {
 assert!(false);
Expand DownExpand Up@@ -7588,17 +7585,14 @@ pub fn test_concurrent_monitor_claim() {
 &node_cfgs[0].logger,
 ) {
 // Watchtower Alice should already have seen the block and reject the update
 assert_eq!(
 watchtower_alice.chain_monitor.update_channel(chan_1.2, &update),
 ChannelMonitorUpdateStatus::InProgress
 );
 assert!(watchtower_alice.chain_monitor.update_channel(chan_1.2, &update).is_err());
 assert_eq!(
 watchtower_bob.chain_monitor.update_channel(chan_1.2, &update),
 ChannelMonitorUpdateStatus::Completed
Ok(ChannelMonitorUpdateStatus::Completed)
 );
 assert_eq!(
 nodes[0].chain_monitor.update_channel(chan_1.2, &update),
 ChannelMonitorUpdateStatus::Completed
Ok(ChannelMonitorUpdateStatus::Completed)
 );
 } else {
 assert!(false);
Expand Down

2 changes: 1 addition & 1 deletion
lightning/src/util/test_utils.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -617,7 +617,7 @@ impl<'a> chain::Watch<TestChannelSigner> for TestChainMonitor<'a> {

	fn update_channel(
 &self, channel_id: ChannelId, update: &ChannelMonitorUpdate,
	) -> chain::ChannelMonitorUpdateStatus {
	) -> Result<chain::ChannelMonitorUpdateStatus, ()> {
 #[cfg(feature = "std")]
 if let Some(blocker) = &*self.write_blocker.lock().unwrap() {
 blocker.recv().unwrap();
Expand Down
Loading

, '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
Return Result from Watch::update_channel to separate monitor failure from persistence status#4445

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

 Closed

joostjager
wants to merge
1
commit into

from

 Closed


Return Result from Watch::update_channel to separate monitor failure from persistence status
#4445
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


27 changes: 15 additions & 12 deletions
fuzz/src/chanmon_consistency.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -320,7 +320,7 @@ impl chain::Watch<TestChannelSigner> for TestChainMonitor {

	fn update_channel(
 &self, channel_id: ChannelId, update: &channelmonitor::ChannelMonitorUpdate,
	) -> chain::ChannelMonitorUpdateStatus {
	) -> Result<chain::ChannelMonitorUpdateStatus, ()> {
 let mut map_lock = self.latest_monitors.lock().unwrap();
 let map_entry = map_lock.get_mut(&channel_id).expect("Didn't have monitor on update call");
 let latest_monitor_data = map_entry
Expand All@@ -336,26 +336,29 @@ impl chain::Watch<TestChannelSigner> for TestChainMonitor {
 )
 .unwrap()
 .1;
 deserialized_monitor
 .update_monitor(
 update,
 &&TestBroadcaster { txn_broadcasted: RefCell::new(Vec::new()) },
 &&FuzzEstimator { ret_val: atomic::AtomicU32::new(253) },
 &self.logger,
 )
 .unwrap();
 let local_update_res = deserialized_monitor.update_monitor(
 update,
 &&TestBroadcaster { txn_broadcasted: RefCell::new(Vec::new()) },
 &&FuzzEstimator { ret_val: atomic::AtomicU32::new(253) },
 &self.logger,
 );
 let mut ser = VecWriter(Vec::new());
 deserialized_monitor.write(&mut ser).unwrap();
 let res = self.chain_monitor.update_channel(channel_id, update);
 match res {
 chain::ChannelMonitorUpdateStatus::Completed => {
 Ok(chain::ChannelMonitorUpdateStatus::Completed) => {
 assert!(local_update_res.is_ok());
 map_entry.persisted_monitor_id = update.update_id;
 map_entry.persisted_monitor = ser.0;
 },
 chain::ChannelMonitorUpdateStatus::InProgress => {
 Ok(chain::ChannelMonitorUpdateStatus::InProgress) => {
 assert!(local_update_res.is_ok());
 map_entry.pending_monitors.push((update.update_id, ser.0));
 },
 chain::ChannelMonitorUpdateStatus::UnrecoverableError => panic!(),
 Ok(chain::ChannelMonitorUpdateStatus::UnrecoverableError) => panic!(),
 Err(()) => {
 assert!(local_update_res.is_err());
 },
 }
 res
	}
Expand Down

8 changes: 4 additions & 4 deletions
lightning/src/chain/chainmonitor.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1311,7 +1311,7 @@ where

	fn update_channel(
 &self, channel_id: ChannelId, update: &ChannelMonitorUpdate,
	) -> ChannelMonitorUpdateStatus {
	) -> Result<ChannelMonitorUpdateStatus, ()> {
 // `ChannelMonitorUpdate`'s `channel_id` is `None` prior to 0.0.121 and all channels in those
 // versions are V1-established. For 0.0.121+ the `channel_id` fields is always `Some`.
 debug_assert_eq!(update.channel_id.unwrap(), channel_id);
Expand All@@ -1328,7 +1328,7 @@ where
 #[cfg(debug_assertions)]
 panic!("ChannelManager generated a channel update for a channel that was not yet registered!");
 #[cfg(not(debug_assertions))]
ChannelMonitorUpdateStatus::InProgress
Err(())
 },
 Some(monitor_state) => {
 let monitor = &monitor_state.monitor;
Expand DownExpand Up@@ -1415,9 +1415,9 @@ where
 }

 if update_res.is_err() {
ChannelMonitorUpdateStatus::InProgress
Err(())
 } else {
 persist_res
Ok(persist_res)
 }
 },
 }
Expand Down

19 changes: 10 additions & 9 deletions
lightning/src/chain/mod.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -316,22 +316,23 @@ pub trait Watch<ChannelSigner: EcdsaChannelSigner> {

	/// Updates a channel identified by `channel_id` by applying `update` to its monitor.
	///
	/// Implementations must call [`ChannelMonitor::update_monitor`] with the given update. This
	/// may fail (returning an `Err(())`), in which case this should return
	/// [`ChannelMonitorUpdateStatus::InProgress`] (and the update should never complete). This
	/// Implementations must call [`ChannelMonitor::update_monitor`] with the given update. If
	/// that call fails (returning an `Err(())`), this method should return `Err(())`. This
	/// generally implies the channel has been closed (either by the funding outpoint being spent
	/// on-chain or the [`ChannelMonitor`] having decided to do so and broadcasted a transaction),
	/// and the [`ChannelManager`] state will be updated once it sees the funding spend on-chain.
	/// Even when `update_monitor` fails, the updated monitor state should still be persisted.
	///
	/// In general, persistence failures should be retried after returning
	/// [`ChannelMonitorUpdateStatus::InProgress`] and eventually complete. If a failure truly
	/// cannot be retried, the node should shut down immediately after returning
	/// [`ChannelMonitorUpdateStatus::UnrecoverableError`], see its documentation for more info.
	/// On success, returns the persistence status. In general, persistence failures should be
	/// retried after returning [`ChannelMonitorUpdateStatus::InProgress`] and eventually
	/// complete. If a failure truly cannot be retried, the node should shut down immediately
	/// after returning [`ChannelMonitorUpdateStatus::UnrecoverableError`], see its documentation
	/// for more info.
	///
	/// [`ChannelManager`]: crate::ln::channelmanager::ChannelManager
	fn update_channel(
 &self, channel_id: ChannelId, update: &ChannelMonitorUpdate,
	) -> ChannelMonitorUpdateStatus;
	) -> Result<ChannelMonitorUpdateStatus, ()>;

	/// Returns any monitor events since the last call. Subsequent calls must only return new
	/// events.
Expand All@@ -358,7 +359,7 @@ impl<ChannelSigner: EcdsaChannelSigner, T: Watch<ChannelSigner> + ?Sized, W: Der

	fn update_channel(
 &self, channel_id: ChannelId, update: &ChannelMonitorUpdate,
	) -> ChannelMonitorUpdateStatus {
	) -> Result<ChannelMonitorUpdateStatus, ()> {
 self.deref().update_channel(channel_id, update)
	}

Expand Down

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

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -136,14 +136,11 @@ fn test_monitor_and_persister_update_fail() {
 &feeest,
 &node_cfgs[0].logger,
 ) {
 // Check that the persister returns InProgress (and will never actually complete)
 // as the monitor update errors.
 if let ChannelMonitorUpdateStatus::InProgress =
 chain_mon.chain_monitor.update_channel(chan.2, &update)
 {
 } else {
 panic!("Expected monitor paused");
 }
 // Check that the chain monitor returns Err as the monitor update errors.
 assert!(
 chain_mon.chain_monitor.update_channel(chan.2, &update).is_err(),
 "Expected monitor update failure",
 );
 logger.assert_log_regex(
 "lightning::chain::chainmonitor",
 regex::Regex::new("Failed to update ChannelMonitor").unwrap(),
Expand All@@ -154,7 +151,7 @@ fn test_monitor_and_persister_update_fail() {
 // ChannelManager and ChannelMonitor aren't out of sync.
 assert_eq!(
 nodes[0].chain_monitor.update_channel(chan.2, &update),
 ChannelMonitorUpdateStatus::Completed
Ok(ChannelMonitorUpdateStatus::Completed)
 );
 } else {
 assert!(false);
Expand DownExpand Up@@ -4967,10 +4964,10 @@ fn native_async_persist() {
	// Now test two async `ChannelMonitorUpdate`s in flight at once, completing them in-order but
	// separately.
	let update_status = async_chain_monitor.update_channel(chan_id, &updates[0]);
	assert_eq!(update_status, ChannelMonitorUpdateStatus::InProgress);
	assert_eq!(update_status, Ok(ChannelMonitorUpdateStatus::InProgress));

	let update_status = async_chain_monitor.update_channel(chan_id, &updates[1]);
	assert_eq!(update_status, ChannelMonitorUpdateStatus::InProgress);
	assert_eq!(update_status, Ok(ChannelMonitorUpdateStatus::InProgress));

	persist_futures.poll_futures();
	assert_eq!(async_chain_monitor.release_pending_monitor_events().len(), 0);
Expand DownExpand Up@@ -5016,10 +5013,10 @@ fn native_async_persist() {
	// out-of-order and ensuring that no `MonitorEvent::Completed` is generated until they are both
	// completed (and that it marks both as completed when it is generated).
	let update_status = async_chain_monitor.update_channel(chan_id, &updates[2]);
	assert_eq!(update_status, ChannelMonitorUpdateStatus::InProgress);
	assert_eq!(update_status, Ok(ChannelMonitorUpdateStatus::InProgress));

	let update_status = async_chain_monitor.update_channel(chan_id, &updates[3]);
	assert_eq!(update_status, ChannelMonitorUpdateStatus::InProgress);
	assert_eq!(update_status, Ok(ChannelMonitorUpdateStatus::InProgress));

	persist_futures.poll_futures();
	assert_eq!(async_chain_monitor.release_pending_monitor_events().len(), 0);
Expand Down

15 changes: 14 additions & 1 deletion
lightning/src/ln/channelmanager.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10058,7 +10058,20 @@ This indicates a bug inside LDK. Please report this error at https://github.com/
 self.chain_monitor.update_channel(channel_id, &in_flight_updates[update_idx]);
 let logger =
 WithContext::from(&self.logger, Some(counterparty_node_id), Some(channel_id), None);
 let update_completed = self.handle_monitor_update_res(update_res, logger);
 // Map monitor update failure (Err) to InProgress to freeze the channel.
 // This happens when ChannelMonitor::update_monitor fails internally,
 // generally implying the channel has been closed on-chain.
 let update_status = match update_res {
 Ok(status) => status,
 Err(()) => {
 log_debug!(
 logger,
 "ChannelMonitor::update_monitor failed, treating as InProgress to freeze channel.",
 );
 ChannelMonitorUpdateStatus::InProgress
 },
 };
 let update_completed = self.handle_monitor_update_res(update_status, logger);
 if update_completed {
 let _ = in_flight_updates.remove(update_idx);
 }
Expand Down

16 changes: 5 additions & 11 deletions
lightning/src/ln/functional_tests.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -7429,13 +7429,10 @@ pub fn test_update_err_monitor_lockdown() {
 &feeest,
 &node_cfgs[0].logger,
 ) {
 assert_eq!(
 watchtower.chain_monitor.update_channel(chan_1.2, &update),
 ChannelMonitorUpdateStatus::InProgress
 );
 assert!(watchtower.chain_monitor.update_channel(chan_1.2, &update).is_err());
 assert_eq!(
 nodes[0].chain_monitor.update_channel(chan_1.2, &update),
 ChannelMonitorUpdateStatus::Completed
Ok(ChannelMonitorUpdateStatus::Completed)
 );
 } else {
 assert!(false);
Expand DownExpand Up@@ -7588,17 +7585,14 @@ pub fn test_concurrent_monitor_claim() {
 &node_cfgs[0].logger,
 ) {
 // Watchtower Alice should already have seen the block and reject the update
 assert_eq!(
 watchtower_alice.chain_monitor.update_channel(chan_1.2, &update),
 ChannelMonitorUpdateStatus::InProgress
 );
 assert!(watchtower_alice.chain_monitor.update_channel(chan_1.2, &update).is_err());
 assert_eq!(
 watchtower_bob.chain_monitor.update_channel(chan_1.2, &update),
 ChannelMonitorUpdateStatus::Completed
Ok(ChannelMonitorUpdateStatus::Completed)
 );
 assert_eq!(
 nodes[0].chain_monitor.update_channel(chan_1.2, &update),
 ChannelMonitorUpdateStatus::Completed
Ok(ChannelMonitorUpdateStatus::Completed)
 );
 } else {
 assert!(false);
Expand Down

2 changes: 1 addition & 1 deletion
lightning/src/util/test_utils.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -617,7 +617,7 @@ impl<'a> chain::Watch<TestChannelSigner> for TestChainMonitor<'a> {

	fn update_channel(
 &self, channel_id: ChannelId, update: &ChannelMonitorUpdate,
	) -> chain::ChannelMonitorUpdateStatus {
	) -> Result<chain::ChannelMonitorUpdateStatus, ()> {
 #[cfg(feature = "std")]
 if let Some(blocker) = &*self.write_blocker.lock().unwrap() {
 blocker.recv().unwrap();
Expand Down
Loading