Skip to content

Do not broadcast commitment txn on Permanent mon update failure#1106

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
TheBlueMatt merged 7 commits into from
Sep 29, 2022
Merged

Do not broadcast commitment txn on Permanent mon update failure #1106

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
313810e
Do not broadcast commitment txn on Permanent mon update failure
TheBlueMatt Oct 5, 2021
12fa0b1
Rework `chain::Watch` return types to make async updates less scary
TheBlueMatt Jul 18, 2022
72416b9
Add a TODO for an important issue for making async mon updates safe
TheBlueMatt Aug 16, 2022
721a858
Rename `Channel::monitor_update_failed` to `monitor_updating_paused`
TheBlueMatt Aug 16, 2022
fb0a481
Rename `handle_monitor_err!()` `handle_monitor_update_res!`
TheBlueMatt Aug 16, 2022
f961dae
Rename APIError::MonitorUpdateFailed to MonitorUpdateInProgress
TheBlueMatt Sep 29, 2022
52934e0
Clarify ambiguous comment in persist methods
TheBlueMatt Aug 24, 2022
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
37 changes: 21 additions & 16 deletions fuzz/src/chanmon_consistency.rs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -32,7 +32,7 @@ use bitcoin::hashes::sha256::Hash as Sha256;
use bitcoin::hash_types::{BlockHash, WPubkeyHash};

use lightning::chain;
use lightning::chain::{BestBlock, ChannelMonitorUpdateErr, chainmonitor, channelmonitor, Confirm, Watch};
use lightning::chain::{BestBlock, ChannelMonitorUpdateStatus, chainmonitor, channelmonitor, Confirm, Watch};
use lightning::chain::channelmonitor::{ChannelMonitor, MonitorEvent};
use lightning::chain::transaction::OutPoint;
use lightning::chain::chaininterface::{BroadcasterInterface, ConfirmationTarget, FeeEstimator};
Expand DownExpand Up@@ -124,7 +124,7 @@ impl TestChainMonitor {
}
}
impl chain::Watch<EnforcingSigner> for TestChainMonitor {
fn watch_channel(&self, funding_txo: OutPoint, monitor: channelmonitor::ChannelMonitor<EnforcingSigner>) -> Result<(), chain::ChannelMonitorUpdateErr> {
fn watch_channel(&self, funding_txo: OutPoint, monitor: channelmonitor::ChannelMonitor<EnforcingSigner>) -> chain::ChannelMonitorUpdateStatus {
let mut ser = VecWriter(Vec::new());
monitor.write(&mut ser).unwrap();
if let Some(_) = self.latest_monitors.lock().unwrap().insert(funding_txo, (monitor.get_latest_update_id(), ser.0)) {
Expand All@@ -134,7 +134,7 @@ impl chain::Watch<EnforcingSigner> for TestChainMonitor {
self.chain_monitor.watch_channel(funding_txo, monitor)
}

fn update_channel(&self, funding_txo: OutPoint, update: channelmonitor::ChannelMonitorUpdate) -> Result<(), chain::ChannelMonitorUpdateErr> {
fn update_channel(&self, funding_txo: OutPoint, update: channelmonitor::ChannelMonitorUpdate) -> chain::ChannelMonitorUpdateStatus {
let mut map_lock = self.latest_monitors.lock().unwrap();
let mut map_entry = match map_lock.entry(funding_txo) {
hash_map::Entry::Occupied(entry) => entry,
Expand DownExpand Up@@ -270,7 +270,7 @@ fn check_api_err(api_err: APIError) {
_ => panic!("{}", err),
}
},
APIError::MonitorUpdateFailed => {
APIError::MonitorUpdateInProgress => {
// We can (obviously) temp-fail a monitor update
},
APIError::IncompatibleShutdownScript { .. } => panic!("Cannot send an incompatible shutdown script"),
Expand DownExpand Up@@ -363,7 +363,9 @@ pub fn do_test<Out: Output>(data: &[u8], underlying_out: Out) {
let logger: Arc<dyn Logger> = Arc::new(test_logger::TestLogger::new($node_id.to_string(), out.clone()));
let keys_manager = Arc::new(KeyProvider { node_id: $node_id, rand_bytes_id: atomic::AtomicU32::new(0), enforcement_states: Mutex::new(HashMap::new()) });
let monitor = Arc::new(TestChainMonitor::new(broadcast.clone(), logger.clone(), $fee_estimator.clone(),
Arc::new(TestPersister { update_ret: Mutex::new(Ok(())) }), Arc::clone(&keys_manager)));
Arc::new(TestPersister {
update_ret: Mutex::new(ChannelMonitorUpdateStatus::Completed)
}), Arc::clone(&keys_manager)));

let mut config = UserConfig::default();
config.channel_config.forwarding_fee_proportional_millionths = 0;
Expand All@@ -383,7 +385,9 @@ pub fn do_test<Out: Output>(data: &[u8], underlying_out: Out) {
let keys_manager = Arc::clone(& $keys_manager);
let logger: Arc<dyn Logger> = Arc::new(test_logger::TestLogger::new($node_id.to_string(), out.clone()));
let chain_monitor = Arc::new(TestChainMonitor::new(broadcast.clone(), logger.clone(), $fee_estimator.clone(),
Arc::new(TestPersister { update_ret: Mutex::new(Ok(())) }), Arc::clone(& $keys_manager)));
Arc::new(TestPersister {
update_ret: Mutex::new(ChannelMonitorUpdateStatus::Completed)
}), Arc::clone(& $keys_manager)));

let mut config = UserConfig::default();
config.channel_config.forwarding_fee_proportional_millionths = 0;
Expand DownExpand Up@@ -412,7 +416,8 @@ pub fn do_test<Out: Output>(data: &[u8], underlying_out: Out) {

let res = (<(BlockHash, ChanMan)>::read(&mut Cursor::new(&$ser.0), read_args).expect("Failed to read manager").1, chain_monitor.clone());
for (funding_txo, mon) in monitors.drain() {
assert!(chain_monitor.chain_monitor.watch_channel(funding_txo, mon).is_ok());
assert_eq!(chain_monitor.chain_monitor.watch_channel(funding_txo, mon),
ChannelMonitorUpdateStatus::Completed);
}
res
} }
Expand DownExpand Up@@ -889,12 +894,12 @@ pub fn do_test<Out: Output>(data: &[u8], underlying_out: Out) {
// bit-twiddling mutations to have similar effects. This is probably overkill, but no
// harm in doing so.

0x00 => *monitor_a.persister.update_ret.lock().unwrap() = Err(ChannelMonitorUpdateErr::TemporaryFailure),
0x01 => *monitor_b.persister.update_ret.lock().unwrap() = Err(ChannelMonitorUpdateErr::TemporaryFailure),
0x02 => *monitor_c.persister.update_ret.lock().unwrap() = Err(ChannelMonitorUpdateErr::TemporaryFailure),
0x04 => *monitor_a.persister.update_ret.lock().unwrap() = Ok(()),
0x05 => *monitor_b.persister.update_ret.lock().unwrap() = Ok(()),
0x06 => *monitor_c.persister.update_ret.lock().unwrap() = Ok(()),
0x00 => *monitor_a.persister.update_ret.lock().unwrap() = ChannelMonitorUpdateStatus::InProgress,
0x01 => *monitor_b.persister.update_ret.lock().unwrap() = ChannelMonitorUpdateStatus::InProgress,
0x02 => *monitor_c.persister.update_ret.lock().unwrap() = ChannelMonitorUpdateStatus::InProgress,
0x04 => *monitor_a.persister.update_ret.lock().unwrap() = ChannelMonitorUpdateStatus::Completed,
0x05 => *monitor_b.persister.update_ret.lock().unwrap() = ChannelMonitorUpdateStatus::Completed,
0x06 => *monitor_c.persister.update_ret.lock().unwrap() = ChannelMonitorUpdateStatus::Completed,

0x08 => {
if let Some((id, _)) = monitor_a.latest_monitors.lock().unwrap().get(&chan_1_funding) {
Expand DownExpand Up@@ -1119,9 +1124,9 @@ pub fn do_test<Out: Output>(data: &[u8], underlying_out: Out) {
// after we resolve all pending events.
// First make sure there are no pending monitor updates, resetting the error state
// and calling force_channel_monitor_updated for each monitor.
*monitor_a.persister.update_ret.lock().unwrap() = Ok(());
*monitor_b.persister.update_ret.lock().unwrap() = Ok(());
*monitor_c.persister.update_ret.lock().unwrap() = Ok(());
*monitor_a.persister.update_ret.lock().unwrap() = ChannelMonitorUpdateStatus::Completed;
*monitor_b.persister.update_ret.lock().unwrap() = ChannelMonitorUpdateStatus::Completed;
*monitor_c.persister.update_ret.lock().unwrap() = ChannelMonitorUpdateStatus::Completed;

if let Some((id, _)) = monitor_a.latest_monitors.lock().unwrap().get(&chan_1_funding) {
monitor_a.chain_monitor.force_channel_monitor_updated(chan_1_funding, *id);
Expand Down
4 changes: 2 additions & 2 deletions fuzz/src/full_stack.rs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -29,7 +29,7 @@ use bitcoin::hashes::sha256::Hash as Sha256;
use bitcoin::hash_types::{Txid, BlockHash, WPubkeyHash};

use lightning::chain;
use lightning::chain::{BestBlock, Confirm, Listen};
use lightning::chain::{BestBlock, ChannelMonitorUpdateStatus, Confirm, Listen};
use lightning::chain::chaininterface::{BroadcasterInterface, ConfirmationTarget, FeeEstimator};
use lightning::chain::chainmonitor;
use lightning::chain::transaction::OutPoint;
Expand DownExpand Up@@ -389,7 +389,7 @@ pub fn do_test(data: &[u8], logger: &Arc<dyn Logger>) {

let broadcast = Arc::new(TestBroadcaster{ txn_broadcasted: Mutex::new(Vec::new()) });
let monitor = Arc::new(chainmonitor::ChainMonitor::new(None, broadcast.clone(), Arc::clone(&logger), fee_est.clone(),
Arc::new(TestPersister { update_ret: Mutex::new(Ok(())) })));
Arc::new(TestPersister { update_ret: Mutex::new(ChannelMonitorUpdateStatus::Completed) })));

let keys_manager = Arc::new(KeyProvider { node_secret: our_network_key.clone(), inbound_payment_key: KeyMaterial(inbound_payment_key.try_into().unwrap()), counter: AtomicU64::new(0) });
let mut config = UserConfig::default();
Expand Down
6 changes: 3 additions & 3 deletions fuzz/src/utils/test_persister.rs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -7,14 +7,14 @@ use lightning::util::enforcing_trait_impls::EnforcingSigner;
use std::sync::Mutex;

pub struct TestPersister {
pub update_ret: Mutex<Result<(), chain::ChannelMonitorUpdateErr>>,
pub update_ret: Mutex<chain::ChannelMonitorUpdateStatus>,
}
impl chainmonitor::Persist<EnforcingSigner> for TestPersister {
fn persist_new_channel(&self, _funding_txo: OutPoint, _data: &channelmonitor::ChannelMonitor<EnforcingSigner>, _update_id: MonitorUpdateId) -> Result<(), chain::ChannelMonitorUpdateErr> {
fn persist_new_channel(&self, _funding_txo: OutPoint, _data: &channelmonitor::ChannelMonitor<EnforcingSigner>, _update_id: MonitorUpdateId) -> chain::ChannelMonitorUpdateStatus {
self.update_ret.lock().unwrap().clone()
}

fn update_persisted_channel(&self, _funding_txo: OutPoint, _update: &Option<channelmonitor::ChannelMonitorUpdate>, _data: &channelmonitor::ChannelMonitor<EnforcingSigner>, _update_id: MonitorUpdateId) -> Result<(), chain::ChannelMonitorUpdateErr> {
fn update_persisted_channel(&self, _funding_txo: OutPoint, _update: &Option<channelmonitor::ChannelMonitorUpdate>, _data: &channelmonitor::ChannelMonitor<EnforcingSigner>, _update_id: MonitorUpdateId) -> chain::ChannelMonitorUpdateStatus {
self.update_ret.lock().unwrap().clone()
}
}
18 changes: 9 additions & 9 deletions lightning-invoice/src/payment.rs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -513,11 +513,11 @@ where
},
PaymentSendFailure::PartialFailure { failed_paths_retry, payment_id, results } => {
// If a `PartialFailure` event returns a result that is an `Ok()`, it means that
// part of our payment is retried. When we receive `MonitorUpdateFailed`, it
// part of our payment is retried. When we receive `MonitorUpdateInProgress`, it
// means that we are still waiting for our channel monitor update to be completed.
for (result, path) in results.iter().zip(route.paths.into_iter()) {
match result {
Ok(_) | Err(APIError::MonitorUpdateFailed) => {
Ok(_) | Err(APIError::MonitorUpdateInProgress) => {
self.process_path_inflight_htlcs(payment_hash, path);
},
_ => {},
Expand DownExpand Up@@ -617,11 +617,11 @@ where
},
Err(PaymentSendFailure::PartialFailure { failed_paths_retry, results, .. }) => {
// If a `PartialFailure` error contains a result that is an `Ok()`, it means that
// part of our payment is retried. When we receive `MonitorUpdateFailed`, it
// part of our payment is retried. When we receive `MonitorUpdateInProgress`, it
// means that we are still waiting for our channel monitor update to complete.
for (result, path) in results.iter().zip(route.unwrap().paths.into_iter()) {
match result {
Ok(_) | Err(APIError::MonitorUpdateFailed) => {
Ok(_) | Err(APIError::MonitorUpdateInProgress) => {
self.process_path_inflight_htlcs(payment_hash, path);
},
_ => {},
Expand DownExpand Up@@ -796,7 +796,7 @@ mod tests {
use std::time::{SystemTime, Duration};
use time_utils::tests::SinceEpoch;
use DEFAULT_EXPIRY_TIME;
use lightning::util::errors::APIError::{ChannelUnavailable, MonitorUpdateFailed};
use lightning::util::errors::APIError::{ChannelUnavailable, MonitorUpdateInProgress};

fn invoice(payment_preimage: PaymentPreimage) -> Invoice {
let payment_hash = Sha256::hash(&payment_preimage.0);
Expand DownExpand Up@@ -1718,7 +1718,7 @@ mod tests {
.fails_with_partial_failure(
retry.clone(), OnAttempt(1),
Some(vec![
Err(ChannelUnavailable { err: "abc".to_string() }), Err(MonitorUpdateFailed)
Err(ChannelUnavailable { err: "abc".to_string() }), Err(MonitorUpdateInProgress)
]))
.expect_send(Amount::ForInvoice(final_value_msat));

Expand All@@ -1731,7 +1731,7 @@ mod tests {
invoice_payer.pay_invoice(&invoice_to_pay).unwrap();
let inflight_map = invoice_payer.create_inflight_map();

// Only the second path, which failed with `MonitorUpdateFailed` should be added to our
// Only the second path, which failed with `MonitorUpdateInProgress` should be added to our
// inflight map because retries are disabled.
assert_eq!(inflight_map.len(), 2);
}
Expand All@@ -1750,7 +1750,7 @@ mod tests {
.fails_with_partial_failure(
retry.clone(), OnAttempt(1),
Some(vec![
Ok(()), Err(MonitorUpdateFailed)
Ok(()), Err(MonitorUpdateInProgress)
]))
.expect_send(Amount::ForInvoice(final_value_msat));

Expand DownExpand Up@@ -2044,7 +2044,7 @@ mod tests {
}

fn fails_on_attempt(self, attempt: usize) -> Self {
let failure = PaymentSendFailure::ParameterError(APIError::MonitorUpdateFailed);
let failure = PaymentSendFailure::ParameterError(APIError::MonitorUpdateInProgress);
self.fails_with(failure, OnAttempt(attempt))
}

Expand Down
6 changes: 3 additions & 3 deletions lightning-persister/src/lib.rs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -138,7 +138,7 @@ mod tests {
use bitcoin::blockdata::block::{Block, BlockHeader};
use bitcoin::hashes::hex::FromHex;
use bitcoin::{Txid, TxMerkleNode};
use lightning::chain::ChannelMonitorUpdateErr;
use lightning::chain::ChannelMonitorUpdateStatus;
use lightning::chain::chainmonitor::Persist;
use lightning::chain::transaction::OutPoint;
use lightning::{check_closed_broadcast, check_closed_event, check_added_monitors};
Expand DownExpand Up@@ -270,7 +270,7 @@ mod tests {
index: 0
};
match persister.persist_new_channel(test_txo, &added_monitors[0].1, update_id.2) {
Err(ChannelMonitorUpdateErr::PermanentFailure) => {},
ChannelMonitorUpdateStatus::PermanentFailure => {},
_ => panic!("unexpected result from persisting new channel")
}

Expand DownExpand Up@@ -307,7 +307,7 @@ mod tests {
index: 0
};
match persister.persist_new_channel(test_txo, &added_monitors[0].1, update_id.2) {
Err(ChannelMonitorUpdateErr::PermanentFailure) => {},
ChannelMonitorUpdateStatus::PermanentFailure => {},
_ => panic!("unexpected result from persisting new channel")
}

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

TheBlueMatt
merged 7 commits into

from

Sep 29, 2022
 Merged


Do not broadcast commitment txn on Permanent mon update failure
#1106
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


7 commits


Select commit
Hold shift + click to select a range
313810e

Do not broadcast commitment txn on Permanent mon update failure


TheBlueMatt Oct 5, 2021
12fa0b1

Rework `chain::Watch` return types to make async updates less scary


TheBlueMatt Jul 18, 2022
72416b9

Add a TODO for an important issue for making async mon updates safe


TheBlueMatt Aug 16, 2022
721a858

Rename `Channel::monitor_update_failed` to `monitor_updating_paused`


TheBlueMatt Aug 16, 2022
fb0a481

Rename `handle_monitor_err!()` `handle_monitor_update_res!`


TheBlueMatt Aug 16, 2022
f961dae

Rename APIError::MonitorUpdateFailed to MonitorUpdateInProgress


TheBlueMatt Sep 29, 2022
52934e0

Clarify ambiguous comment in persist methods


TheBlueMatt Aug 24, 2022

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


37 changes: 21 additions & 16 deletions
fuzz/src/chanmon_consistency.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -32,7 +32,7 @@ use bitcoin::hashes::sha256::Hash as Sha256;
use bitcoin::hash_types::{BlockHash, WPubkeyHash};

use lightning::chain;
use lightning::chain::{BestBlock, ChannelMonitorUpdateErr, chainmonitor, channelmonitor, Confirm, Watch};
use lightning::chain::{BestBlock, ChannelMonitorUpdateStatus, chainmonitor, channelmonitor, Confirm, Watch};
use lightning::chain::channelmonitor::{ChannelMonitor, MonitorEvent};
use lightning::chain::transaction::OutPoint;
use lightning::chain::chaininterface::{BroadcasterInterface, ConfirmationTarget, FeeEstimator};
Expand DownExpand Up@@ -124,7 +124,7 @@ impl TestChainMonitor {
	}
}
impl chain::Watch<EnforcingSigner> for TestChainMonitor {
	fn watch_channel(&self, funding_txo: OutPoint, monitor: channelmonitor::ChannelMonitor<EnforcingSigner>) -> Result<(), chain::ChannelMonitorUpdateErr> {
	fn watch_channel(&self, funding_txo: OutPoint, monitor: channelmonitor::ChannelMonitor<EnforcingSigner>) -> chain::ChannelMonitorUpdateStatus {
 let mut ser = VecWriter(Vec::new());
 monitor.write(&mut ser).unwrap();
 if let Some(_) = self.latest_monitors.lock().unwrap().insert(funding_txo, (monitor.get_latest_update_id(), ser.0)) {
Expand All@@ -134,7 +134,7 @@ impl chain::Watch<EnforcingSigner> for TestChainMonitor {
 self.chain_monitor.watch_channel(funding_txo, monitor)
	}

	fn update_channel(&self, funding_txo: OutPoint, update: channelmonitor::ChannelMonitorUpdate) -> Result<(), chain::ChannelMonitorUpdateErr> {
	fn update_channel(&self, funding_txo: OutPoint, update: channelmonitor::ChannelMonitorUpdate) -> chain::ChannelMonitorUpdateStatus {
 let mut map_lock = self.latest_monitors.lock().unwrap();
 let mut map_entry = match map_lock.entry(funding_txo) {
 hash_map::Entry::Occupied(entry) => entry,
Expand DownExpand Up@@ -270,7 +270,7 @@ fn check_api_err(api_err: APIError) {
 _ => panic!("{}", err),
 }
 },
 APIError::MonitorUpdateFailed => {
 APIError::MonitorUpdateInProgress => {
 // We can (obviously) temp-fail a monitor update
 },
 APIError::IncompatibleShutdownScript { .. } => panic!("Cannot send an incompatible shutdown script"),
Expand DownExpand Up@@ -363,7 +363,9 @@ pub fn do_test<Out: Output>(data: &[u8], underlying_out: Out) {
 let logger: Arc<dyn Logger> = Arc::new(test_logger::TestLogger::new($node_id.to_string(), out.clone()));
 let keys_manager = Arc::new(KeyProvider { node_id: $node_id, rand_bytes_id: atomic::AtomicU32::new(0), enforcement_states: Mutex::new(HashMap::new()) });
 let monitor = Arc::new(TestChainMonitor::new(broadcast.clone(), logger.clone(), $fee_estimator.clone(),
 Arc::new(TestPersister { update_ret: Mutex::new(Ok(())) }), Arc::clone(&keys_manager)));
 Arc::new(TestPersister {
 update_ret: Mutex::new(ChannelMonitorUpdateStatus::Completed)
 }), Arc::clone(&keys_manager)));

 let mut config = UserConfig::default();
 config.channel_config.forwarding_fee_proportional_millionths = 0;
Expand All@@ -383,7 +385,9 @@ pub fn do_test<Out: Output>(data: &[u8], underlying_out: Out) {
 let keys_manager = Arc::clone(& $keys_manager);
 let logger: Arc<dyn Logger> = Arc::new(test_logger::TestLogger::new($node_id.to_string(), out.clone()));
 let chain_monitor = Arc::new(TestChainMonitor::new(broadcast.clone(), logger.clone(), $fee_estimator.clone(),
 Arc::new(TestPersister { update_ret: Mutex::new(Ok(())) }), Arc::clone(& $keys_manager)));
 Arc::new(TestPersister {
 update_ret: Mutex::new(ChannelMonitorUpdateStatus::Completed)
 }), Arc::clone(& $keys_manager)));

 let mut config = UserConfig::default();
 config.channel_config.forwarding_fee_proportional_millionths = 0;
Expand DownExpand Up@@ -412,7 +416,8 @@ pub fn do_test<Out: Output>(data: &[u8], underlying_out: Out) {

 let res = (<(BlockHash, ChanMan)>::read(&mut Cursor::new(&$ser.0), read_args).expect("Failed to read manager").1, chain_monitor.clone());
 for (funding_txo, mon) in monitors.drain() {
 assert!(chain_monitor.chain_monitor.watch_channel(funding_txo, mon).is_ok());
 assert_eq!(chain_monitor.chain_monitor.watch_channel(funding_txo, mon),
 ChannelMonitorUpdateStatus::Completed);
 }
 res
 } }
Expand DownExpand Up@@ -889,12 +894,12 @@ pub fn do_test<Out: Output>(data: &[u8], underlying_out: Out) {
 // bit-twiddling mutations to have similar effects. This is probably overkill, but no
 // harm in doing so.

 0x00 => *monitor_a.persister.update_ret.lock().unwrap() = Err(ChannelMonitorUpdateErr::TemporaryFailure),
 0x01 => *monitor_b.persister.update_ret.lock().unwrap() = Err(ChannelMonitorUpdateErr::TemporaryFailure),
 0x02 => *monitor_c.persister.update_ret.lock().unwrap() = Err(ChannelMonitorUpdateErr::TemporaryFailure),
 0x04 => *monitor_a.persister.update_ret.lock().unwrap() = Ok(()),
 0x05 => *monitor_b.persister.update_ret.lock().unwrap() = Ok(()),
 0x06 => *monitor_c.persister.update_ret.lock().unwrap() = Ok(()),
 0x00 => *monitor_a.persister.update_ret.lock().unwrap() = ChannelMonitorUpdateStatus::InProgress,
 0x01 => *monitor_b.persister.update_ret.lock().unwrap() = ChannelMonitorUpdateStatus::InProgress,
 0x02 => *monitor_c.persister.update_ret.lock().unwrap() = ChannelMonitorUpdateStatus::InProgress,
 0x04 => *monitor_a.persister.update_ret.lock().unwrap() = ChannelMonitorUpdateStatus::Completed,
 0x05 => *monitor_b.persister.update_ret.lock().unwrap() = ChannelMonitorUpdateStatus::Completed,
 0x06 => *monitor_c.persister.update_ret.lock().unwrap() = ChannelMonitorUpdateStatus::Completed,

 0x08 => {
 if let Some((id, _)) = monitor_a.latest_monitors.lock().unwrap().get(&chan_1_funding) {
Expand DownExpand Up@@ -1119,9 +1124,9 @@ pub fn do_test<Out: Output>(data: &[u8], underlying_out: Out) {
 // after we resolve all pending events.
 // First make sure there are no pending monitor updates, resetting the error state
 // and calling force_channel_monitor_updated for each monitor.
 *monitor_a.persister.update_ret.lock().unwrap() = Ok(());
 *monitor_b.persister.update_ret.lock().unwrap() = Ok(());
 *monitor_c.persister.update_ret.lock().unwrap() = Ok(());
 *monitor_a.persister.update_ret.lock().unwrap() = ChannelMonitorUpdateStatus::Completed;
 *monitor_b.persister.update_ret.lock().unwrap() = ChannelMonitorUpdateStatus::Completed;
 *monitor_c.persister.update_ret.lock().unwrap() = ChannelMonitorUpdateStatus::Completed;

 if let Some((id, _)) = monitor_a.latest_monitors.lock().unwrap().get(&chan_1_funding) {
 monitor_a.chain_monitor.force_channel_monitor_updated(chan_1_funding, *id);
Expand Down

4 changes: 2 additions & 2 deletions
fuzz/src/full_stack.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -29,7 +29,7 @@ use bitcoin::hashes::sha256::Hash as Sha256;
use bitcoin::hash_types::{Txid, BlockHash, WPubkeyHash};

use lightning::chain;
use lightning::chain::{BestBlock, Confirm, Listen};
use lightning::chain::{BestBlock, ChannelMonitorUpdateStatus, Confirm, Listen};
use lightning::chain::chaininterface::{BroadcasterInterface, ConfirmationTarget, FeeEstimator};
use lightning::chain::chainmonitor;
use lightning::chain::transaction::OutPoint;
Expand DownExpand Up@@ -389,7 +389,7 @@ pub fn do_test(data: &[u8], logger: &Arc<dyn Logger>) {

	let broadcast = Arc::new(TestBroadcaster{ txn_broadcasted: Mutex::new(Vec::new()) });
	let monitor = Arc::new(chainmonitor::ChainMonitor::new(None, broadcast.clone(), Arc::clone(&logger), fee_est.clone(),
 Arc::new(TestPersister { update_ret: Mutex::new(Ok(())) })));
 Arc::new(TestPersister { update_ret: Mutex::new(ChannelMonitorUpdateStatus::Completed) })));

	let keys_manager = Arc::new(KeyProvider { node_secret: our_network_key.clone(), inbound_payment_key: KeyMaterial(inbound_payment_key.try_into().unwrap()), counter: AtomicU64::new(0) });
	let mut config = UserConfig::default();
Expand Down

6 changes: 3 additions & 3 deletions
fuzz/src/utils/test_persister.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -7,14 +7,14 @@ use lightning::util::enforcing_trait_impls::EnforcingSigner;
use std::sync::Mutex;

pub struct TestPersister {
	pub update_ret: Mutex<Result<(), chain::ChannelMonitorUpdateErr>>,
	pub update_ret: Mutex<chain::ChannelMonitorUpdateStatus>,
}
impl chainmonitor::Persist<EnforcingSigner> for TestPersister {
	fn persist_new_channel(&self, _funding_txo: OutPoint, _data: &channelmonitor::ChannelMonitor<EnforcingSigner>, _update_id: MonitorUpdateId) -> Result<(), chain::ChannelMonitorUpdateErr> {
	fn persist_new_channel(&self, _funding_txo: OutPoint, _data: &channelmonitor::ChannelMonitor<EnforcingSigner>, _update_id: MonitorUpdateId) -> chain::ChannelMonitorUpdateStatus {
 self.update_ret.lock().unwrap().clone()
	}

	fn update_persisted_channel(&self, _funding_txo: OutPoint, _update: &Option<channelmonitor::ChannelMonitorUpdate>, _data: &channelmonitor::ChannelMonitor<EnforcingSigner>, _update_id: MonitorUpdateId) -> Result<(), chain::ChannelMonitorUpdateErr> {
	fn update_persisted_channel(&self, _funding_txo: OutPoint, _update: &Option<channelmonitor::ChannelMonitorUpdate>, _data: &channelmonitor::ChannelMonitor<EnforcingSigner>, _update_id: MonitorUpdateId) -> chain::ChannelMonitorUpdateStatus {
 self.update_ret.lock().unwrap().clone()
	}
}

18 changes: 9 additions & 9 deletions
lightning-invoice/src/payment.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -513,11 +513,11 @@ where
 },
 PaymentSendFailure::PartialFailure { failed_paths_retry, payment_id, results } => {
 // If a `PartialFailure` event returns a result that is an `Ok()`, it means that
 // part of our payment is retried. When we receive `MonitorUpdateFailed`, it
 // part of our payment is retried. When we receive `MonitorUpdateInProgress`, it
 // means that we are still waiting for our channel monitor update to be completed.
 for (result, path) in results.iter().zip(route.paths.into_iter()) {
 match result {
 Ok(_) | Err(APIError::MonitorUpdateFailed) => {
 Ok(_) | Err(APIError::MonitorUpdateInProgress) => {
 self.process_path_inflight_htlcs(payment_hash, path);
 },
 _ => {},
Expand DownExpand Up@@ -617,11 +617,11 @@ where
 },
 Err(PaymentSendFailure::PartialFailure { failed_paths_retry, results, .. }) => {
 // If a `PartialFailure` error contains a result that is an `Ok()`, it means that
 // part of our payment is retried. When we receive `MonitorUpdateFailed`, it
 // part of our payment is retried. When we receive `MonitorUpdateInProgress`, it
 // means that we are still waiting for our channel monitor update to complete.
 for (result, path) in results.iter().zip(route.unwrap().paths.into_iter()) {
 match result {
 Ok(_) | Err(APIError::MonitorUpdateFailed) => {
 Ok(_) | Err(APIError::MonitorUpdateInProgress) => {
 self.process_path_inflight_htlcs(payment_hash, path);
 },
 _ => {},
Expand DownExpand Up@@ -796,7 +796,7 @@ mod tests {
	use std::time::{SystemTime, Duration};
	use time_utils::tests::SinceEpoch;
	use DEFAULT_EXPIRY_TIME;
	use lightning::util::errors::APIError::{ChannelUnavailable, MonitorUpdateFailed};
	use lightning::util::errors::APIError::{ChannelUnavailable, MonitorUpdateInProgress};

	fn invoice(payment_preimage: PaymentPreimage) -> Invoice {
 let payment_hash = Sha256::hash(&payment_preimage.0);
Expand DownExpand Up@@ -1718,7 +1718,7 @@ mod tests {
 .fails_with_partial_failure(
 retry.clone(), OnAttempt(1),
 Some(vec![
 Err(ChannelUnavailable { err: "abc".to_string() }), Err(MonitorUpdateFailed)
 Err(ChannelUnavailable { err: "abc".to_string() }), Err(MonitorUpdateInProgress)
 ]))
 .expect_send(Amount::ForInvoice(final_value_msat));

Expand All@@ -1731,7 +1731,7 @@ mod tests {
 invoice_payer.pay_invoice(&invoice_to_pay).unwrap();
 let inflight_map = invoice_payer.create_inflight_map();

 // Only the second path, which failed with `MonitorUpdateFailed` should be added to our
 // Only the second path, which failed with `MonitorUpdateInProgress` should be added to our
 // inflight map because retries are disabled.
 assert_eq!(inflight_map.len(), 2);
	}
Expand All@@ -1750,7 +1750,7 @@ mod tests {
 .fails_with_partial_failure(
 retry.clone(), OnAttempt(1),
 Some(vec![
 Ok(()), Err(MonitorUpdateFailed)
 Ok(()), Err(MonitorUpdateInProgress)
 ]))
 .expect_send(Amount::ForInvoice(final_value_msat));

Expand DownExpand Up@@ -2044,7 +2044,7 @@ mod tests {
 }

 fn fails_on_attempt(self, attempt: usize) -> Self {
 let failure = PaymentSendFailure::ParameterError(APIError::MonitorUpdateFailed);
 let failure = PaymentSendFailure::ParameterError(APIError::MonitorUpdateInProgress);
 self.fails_with(failure, OnAttempt(attempt))
 }

Expand Down

6 changes: 3 additions & 3 deletions
lightning-persister/src/lib.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -138,7 +138,7 @@ mod tests {
	use bitcoin::blockdata::block::{Block, BlockHeader};
	use bitcoin::hashes::hex::FromHex;
	use bitcoin::{Txid, TxMerkleNode};
	use lightning::chain::ChannelMonitorUpdateErr;
	use lightning::chain::ChannelMonitorUpdateStatus;
	use lightning::chain::chainmonitor::Persist;
	use lightning::chain::transaction::OutPoint;
	use lightning::{check_closed_broadcast, check_closed_event, check_added_monitors};
Expand DownExpand Up@@ -270,7 +270,7 @@ mod tests {
 index: 0
 };
 match persister.persist_new_channel(test_txo, &added_monitors[0].1, update_id.2) {
Err(ChannelMonitorUpdateErr::PermanentFailure) => {},
ChannelMonitorUpdateStatus::PermanentFailure => {},
 _ => panic!("unexpected result from persisting new channel")
 }

Expand DownExpand Up@@ -307,7 +307,7 @@ mod tests {
 index: 0
 };
 match persister.persist_new_channel(test_txo, &added_monitors[0].1, update_id.2) {
Err(ChannelMonitorUpdateErr::PermanentFailure) => {},
ChannelMonitorUpdateStatus::PermanentFailure => {},
 _ => panic!("unexpected result from persisting new channel")
 }

Expand Down
Loading

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

TheBlueMatt
merged 7 commits into

from

Sep 29, 2022
 Merged


Do not broadcast commitment txn on Permanent mon update failure
#1106
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


7 commits


Select commit
Hold shift + click to select a range
313810e

Do not broadcast commitment txn on Permanent mon update failure


TheBlueMatt Oct 5, 2021
12fa0b1

Rework `chain::Watch` return types to make async updates less scary


TheBlueMatt Jul 18, 2022
72416b9

Add a TODO for an important issue for making async mon updates safe


TheBlueMatt Aug 16, 2022
721a858

Rename `Channel::monitor_update_failed` to `monitor_updating_paused`


TheBlueMatt Aug 16, 2022
fb0a481

Rename `handle_monitor_err!()` `handle_monitor_update_res!`


TheBlueMatt Aug 16, 2022
f961dae

Rename APIError::MonitorUpdateFailed to MonitorUpdateInProgress


TheBlueMatt Sep 29, 2022
52934e0

Clarify ambiguous comment in persist methods


TheBlueMatt Aug 24, 2022

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


37 changes: 21 additions & 16 deletions
fuzz/src/chanmon_consistency.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -32,7 +32,7 @@ use bitcoin::hashes::sha256::Hash as Sha256;
use bitcoin::hash_types::{BlockHash, WPubkeyHash};

use lightning::chain;
use lightning::chain::{BestBlock, ChannelMonitorUpdateErr, chainmonitor, channelmonitor, Confirm, Watch};
use lightning::chain::{BestBlock, ChannelMonitorUpdateStatus, chainmonitor, channelmonitor, Confirm, Watch};
use lightning::chain::channelmonitor::{ChannelMonitor, MonitorEvent};
use lightning::chain::transaction::OutPoint;
use lightning::chain::chaininterface::{BroadcasterInterface, ConfirmationTarget, FeeEstimator};
Expand DownExpand Up@@ -124,7 +124,7 @@ impl TestChainMonitor {
	}
}
impl chain::Watch<EnforcingSigner> for TestChainMonitor {
	fn watch_channel(&self, funding_txo: OutPoint, monitor: channelmonitor::ChannelMonitor<EnforcingSigner>) -> Result<(), chain::ChannelMonitorUpdateErr> {
	fn watch_channel(&self, funding_txo: OutPoint, monitor: channelmonitor::ChannelMonitor<EnforcingSigner>) -> chain::ChannelMonitorUpdateStatus {
 let mut ser = VecWriter(Vec::new());
 monitor.write(&mut ser).unwrap();
 if let Some(_) = self.latest_monitors.lock().unwrap().insert(funding_txo, (monitor.get_latest_update_id(), ser.0)) {
Expand All@@ -134,7 +134,7 @@ impl chain::Watch<EnforcingSigner> for TestChainMonitor {
 self.chain_monitor.watch_channel(funding_txo, monitor)
	}

	fn update_channel(&self, funding_txo: OutPoint, update: channelmonitor::ChannelMonitorUpdate) -> Result<(), chain::ChannelMonitorUpdateErr> {
	fn update_channel(&self, funding_txo: OutPoint, update: channelmonitor::ChannelMonitorUpdate) -> chain::ChannelMonitorUpdateStatus {
 let mut map_lock = self.latest_monitors.lock().unwrap();
 let mut map_entry = match map_lock.entry(funding_txo) {
 hash_map::Entry::Occupied(entry) => entry,
Expand DownExpand Up@@ -270,7 +270,7 @@ fn check_api_err(api_err: APIError) {
 _ => panic!("{}", err),
 }
 },
 APIError::MonitorUpdateFailed => {
 APIError::MonitorUpdateInProgress => {
 // We can (obviously) temp-fail a monitor update
 },
 APIError::IncompatibleShutdownScript { .. } => panic!("Cannot send an incompatible shutdown script"),
Expand DownExpand Up@@ -363,7 +363,9 @@ pub fn do_test<Out: Output>(data: &[u8], underlying_out: Out) {
 let logger: Arc<dyn Logger> = Arc::new(test_logger::TestLogger::new($node_id.to_string(), out.clone()));
 let keys_manager = Arc::new(KeyProvider { node_id: $node_id, rand_bytes_id: atomic::AtomicU32::new(0), enforcement_states: Mutex::new(HashMap::new()) });
 let monitor = Arc::new(TestChainMonitor::new(broadcast.clone(), logger.clone(), $fee_estimator.clone(),
 Arc::new(TestPersister { update_ret: Mutex::new(Ok(())) }), Arc::clone(&keys_manager)));
 Arc::new(TestPersister {
 update_ret: Mutex::new(ChannelMonitorUpdateStatus::Completed)
 }), Arc::clone(&keys_manager)));

 let mut config = UserConfig::default();
 config.channel_config.forwarding_fee_proportional_millionths = 0;
Expand All@@ -383,7 +385,9 @@ pub fn do_test<Out: Output>(data: &[u8], underlying_out: Out) {
 let keys_manager = Arc::clone(& $keys_manager);
 let logger: Arc<dyn Logger> = Arc::new(test_logger::TestLogger::new($node_id.to_string(), out.clone()));
 let chain_monitor = Arc::new(TestChainMonitor::new(broadcast.clone(), logger.clone(), $fee_estimator.clone(),
 Arc::new(TestPersister { update_ret: Mutex::new(Ok(())) }), Arc::clone(& $keys_manager)));
 Arc::new(TestPersister {
 update_ret: Mutex::new(ChannelMonitorUpdateStatus::Completed)
 }), Arc::clone(& $keys_manager)));

 let mut config = UserConfig::default();
 config.channel_config.forwarding_fee_proportional_millionths = 0;
Expand DownExpand Up@@ -412,7 +416,8 @@ pub fn do_test<Out: Output>(data: &[u8], underlying_out: Out) {

 let res = (<(BlockHash, ChanMan)>::read(&mut Cursor::new(&$ser.0), read_args).expect("Failed to read manager").1, chain_monitor.clone());
 for (funding_txo, mon) in monitors.drain() {
 assert!(chain_monitor.chain_monitor.watch_channel(funding_txo, mon).is_ok());
 assert_eq!(chain_monitor.chain_monitor.watch_channel(funding_txo, mon),
 ChannelMonitorUpdateStatus::Completed);
 }
 res
 } }
Expand DownExpand Up@@ -889,12 +894,12 @@ pub fn do_test<Out: Output>(data: &[u8], underlying_out: Out) {
 // bit-twiddling mutations to have similar effects. This is probably overkill, but no
 // harm in doing so.

 0x00 => *monitor_a.persister.update_ret.lock().unwrap() = Err(ChannelMonitorUpdateErr::TemporaryFailure),
 0x01 => *monitor_b.persister.update_ret.lock().unwrap() = Err(ChannelMonitorUpdateErr::TemporaryFailure),
 0x02 => *monitor_c.persister.update_ret.lock().unwrap() = Err(ChannelMonitorUpdateErr::TemporaryFailure),
 0x04 => *monitor_a.persister.update_ret.lock().unwrap() = Ok(()),
 0x05 => *monitor_b.persister.update_ret.lock().unwrap() = Ok(()),
 0x06 => *monitor_c.persister.update_ret.lock().unwrap() = Ok(()),
 0x00 => *monitor_a.persister.update_ret.lock().unwrap() = ChannelMonitorUpdateStatus::InProgress,
 0x01 => *monitor_b.persister.update_ret.lock().unwrap() = ChannelMonitorUpdateStatus::InProgress,
 0x02 => *monitor_c.persister.update_ret.lock().unwrap() = ChannelMonitorUpdateStatus::InProgress,
 0x04 => *monitor_a.persister.update_ret.lock().unwrap() = ChannelMonitorUpdateStatus::Completed,
 0x05 => *monitor_b.persister.update_ret.lock().unwrap() = ChannelMonitorUpdateStatus::Completed,
 0x06 => *monitor_c.persister.update_ret.lock().unwrap() = ChannelMonitorUpdateStatus::Completed,

 0x08 => {
 if let Some((id, _)) = monitor_a.latest_monitors.lock().unwrap().get(&chan_1_funding) {
Expand DownExpand Up@@ -1119,9 +1124,9 @@ pub fn do_test<Out: Output>(data: &[u8], underlying_out: Out) {
 // after we resolve all pending events.
 // First make sure there are no pending monitor updates, resetting the error state
 // and calling force_channel_monitor_updated for each monitor.
 *monitor_a.persister.update_ret.lock().unwrap() = Ok(());
 *monitor_b.persister.update_ret.lock().unwrap() = Ok(());
 *monitor_c.persister.update_ret.lock().unwrap() = Ok(());
 *monitor_a.persister.update_ret.lock().unwrap() = ChannelMonitorUpdateStatus::Completed;
 *monitor_b.persister.update_ret.lock().unwrap() = ChannelMonitorUpdateStatus::Completed;
 *monitor_c.persister.update_ret.lock().unwrap() = ChannelMonitorUpdateStatus::Completed;

 if let Some((id, _)) = monitor_a.latest_monitors.lock().unwrap().get(&chan_1_funding) {
 monitor_a.chain_monitor.force_channel_monitor_updated(chan_1_funding, *id);
Expand Down

4 changes: 2 additions & 2 deletions
fuzz/src/full_stack.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -29,7 +29,7 @@ use bitcoin::hashes::sha256::Hash as Sha256;
use bitcoin::hash_types::{Txid, BlockHash, WPubkeyHash};

use lightning::chain;
use lightning::chain::{BestBlock, Confirm, Listen};
use lightning::chain::{BestBlock, ChannelMonitorUpdateStatus, Confirm, Listen};
use lightning::chain::chaininterface::{BroadcasterInterface, ConfirmationTarget, FeeEstimator};
use lightning::chain::chainmonitor;
use lightning::chain::transaction::OutPoint;
Expand DownExpand Up@@ -389,7 +389,7 @@ pub fn do_test(data: &[u8], logger: &Arc<dyn Logger>) {

	let broadcast = Arc::new(TestBroadcaster{ txn_broadcasted: Mutex::new(Vec::new()) });
	let monitor = Arc::new(chainmonitor::ChainMonitor::new(None, broadcast.clone(), Arc::clone(&logger), fee_est.clone(),
 Arc::new(TestPersister { update_ret: Mutex::new(Ok(())) })));
 Arc::new(TestPersister { update_ret: Mutex::new(ChannelMonitorUpdateStatus::Completed) })));

	let keys_manager = Arc::new(KeyProvider { node_secret: our_network_key.clone(), inbound_payment_key: KeyMaterial(inbound_payment_key.try_into().unwrap()), counter: AtomicU64::new(0) });
	let mut config = UserConfig::default();
Expand Down

6 changes: 3 additions & 3 deletions
fuzz/src/utils/test_persister.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -7,14 +7,14 @@ use lightning::util::enforcing_trait_impls::EnforcingSigner;
use std::sync::Mutex;

pub struct TestPersister {
	pub update_ret: Mutex<Result<(), chain::ChannelMonitorUpdateErr>>,
	pub update_ret: Mutex<chain::ChannelMonitorUpdateStatus>,
}
impl chainmonitor::Persist<EnforcingSigner> for TestPersister {
	fn persist_new_channel(&self, _funding_txo: OutPoint, _data: &channelmonitor::ChannelMonitor<EnforcingSigner>, _update_id: MonitorUpdateId) -> Result<(), chain::ChannelMonitorUpdateErr> {
	fn persist_new_channel(&self, _funding_txo: OutPoint, _data: &channelmonitor::ChannelMonitor<EnforcingSigner>, _update_id: MonitorUpdateId) -> chain::ChannelMonitorUpdateStatus {
 self.update_ret.lock().unwrap().clone()
	}

	fn update_persisted_channel(&self, _funding_txo: OutPoint, _update: &Option<channelmonitor::ChannelMonitorUpdate>, _data: &channelmonitor::ChannelMonitor<EnforcingSigner>, _update_id: MonitorUpdateId) -> Result<(), chain::ChannelMonitorUpdateErr> {
	fn update_persisted_channel(&self, _funding_txo: OutPoint, _update: &Option<channelmonitor::ChannelMonitorUpdate>, _data: &channelmonitor::ChannelMonitor<EnforcingSigner>, _update_id: MonitorUpdateId) -> chain::ChannelMonitorUpdateStatus {
 self.update_ret.lock().unwrap().clone()
	}
}

18 changes: 9 additions & 9 deletions
lightning-invoice/src/payment.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -513,11 +513,11 @@ where
 },
 PaymentSendFailure::PartialFailure { failed_paths_retry, payment_id, results } => {
 // If a `PartialFailure` event returns a result that is an `Ok()`, it means that
 // part of our payment is retried. When we receive `MonitorUpdateFailed`, it
 // part of our payment is retried. When we receive `MonitorUpdateInProgress`, it
 // means that we are still waiting for our channel monitor update to be completed.
 for (result, path) in results.iter().zip(route.paths.into_iter()) {
 match result {
 Ok(_) | Err(APIError::MonitorUpdateFailed) => {
 Ok(_) | Err(APIError::MonitorUpdateInProgress) => {
 self.process_path_inflight_htlcs(payment_hash, path);
 },
 _ => {},
Expand DownExpand Up@@ -617,11 +617,11 @@ where
 },
 Err(PaymentSendFailure::PartialFailure { failed_paths_retry, results, .. }) => {
 // If a `PartialFailure` error contains a result that is an `Ok()`, it means that
 // part of our payment is retried. When we receive `MonitorUpdateFailed`, it
 // part of our payment is retried. When we receive `MonitorUpdateInProgress`, it
 // means that we are still waiting for our channel monitor update to complete.
 for (result, path) in results.iter().zip(route.unwrap().paths.into_iter()) {
 match result {
 Ok(_) | Err(APIError::MonitorUpdateFailed) => {
 Ok(_) | Err(APIError::MonitorUpdateInProgress) => {
 self.process_path_inflight_htlcs(payment_hash, path);
 },
 _ => {},
Expand DownExpand Up@@ -796,7 +796,7 @@ mod tests {
	use std::time::{SystemTime, Duration};
	use time_utils::tests::SinceEpoch;
	use DEFAULT_EXPIRY_TIME;
	use lightning::util::errors::APIError::{ChannelUnavailable, MonitorUpdateFailed};
	use lightning::util::errors::APIError::{ChannelUnavailable, MonitorUpdateInProgress};

	fn invoice(payment_preimage: PaymentPreimage) -> Invoice {
 let payment_hash = Sha256::hash(&payment_preimage.0);
Expand DownExpand Up@@ -1718,7 +1718,7 @@ mod tests {
 .fails_with_partial_failure(
 retry.clone(), OnAttempt(1),
 Some(vec![
 Err(ChannelUnavailable { err: "abc".to_string() }), Err(MonitorUpdateFailed)
 Err(ChannelUnavailable { err: "abc".to_string() }), Err(MonitorUpdateInProgress)
 ]))
 .expect_send(Amount::ForInvoice(final_value_msat));

Expand All@@ -1731,7 +1731,7 @@ mod tests {
 invoice_payer.pay_invoice(&invoice_to_pay).unwrap();
 let inflight_map = invoice_payer.create_inflight_map();

 // Only the second path, which failed with `MonitorUpdateFailed` should be added to our
 // Only the second path, which failed with `MonitorUpdateInProgress` should be added to our
 // inflight map because retries are disabled.
 assert_eq!(inflight_map.len(), 2);
	}
Expand All@@ -1750,7 +1750,7 @@ mod tests {
 .fails_with_partial_failure(
 retry.clone(), OnAttempt(1),
 Some(vec![
 Ok(()), Err(MonitorUpdateFailed)
 Ok(()), Err(MonitorUpdateInProgress)
 ]))
 .expect_send(Amount::ForInvoice(final_value_msat));

Expand DownExpand Up@@ -2044,7 +2044,7 @@ mod tests {
 }

 fn fails_on_attempt(self, attempt: usize) -> Self {
 let failure = PaymentSendFailure::ParameterError(APIError::MonitorUpdateFailed);
 let failure = PaymentSendFailure::ParameterError(APIError::MonitorUpdateInProgress);
 self.fails_with(failure, OnAttempt(attempt))
 }

Expand Down

6 changes: 3 additions & 3 deletions
lightning-persister/src/lib.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -138,7 +138,7 @@ mod tests {
	use bitcoin::blockdata::block::{Block, BlockHeader};
	use bitcoin::hashes::hex::FromHex;
	use bitcoin::{Txid, TxMerkleNode};
	use lightning::chain::ChannelMonitorUpdateErr;
	use lightning::chain::ChannelMonitorUpdateStatus;
	use lightning::chain::chainmonitor::Persist;
	use lightning::chain::transaction::OutPoint;
	use lightning::{check_closed_broadcast, check_closed_event, check_added_monitors};
Expand DownExpand Up@@ -270,7 +270,7 @@ mod tests {
 index: 0
 };
 match persister.persist_new_channel(test_txo, &added_monitors[0].1, update_id.2) {
Err(ChannelMonitorUpdateErr::PermanentFailure) => {},
ChannelMonitorUpdateStatus::PermanentFailure => {},
 _ => panic!("unexpected result from persisting new channel")
 }

Expand DownExpand Up@@ -307,7 +307,7 @@ mod tests {
 index: 0
 };
 match persister.persist_new_channel(test_txo, &added_monitors[0].1, update_id.2) {
Err(ChannelMonitorUpdateErr::PermanentFailure) => {},
ChannelMonitorUpdateStatus::PermanentFailure => {},
 _ => panic!("unexpected result from persisting new channel")
 }

Expand Down
Loading

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

TheBlueMatt
merged 7 commits into

from

Sep 29, 2022
 Merged


Do not broadcast commitment txn on Permanent mon update failure
#1106
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


7 commits


Select commit
Hold shift + click to select a range
313810e

Do not broadcast commitment txn on Permanent mon update failure


TheBlueMatt Oct 5, 2021
12fa0b1

Rework `chain::Watch` return types to make async updates less scary


TheBlueMatt Jul 18, 2022
72416b9

Add a TODO for an important issue for making async mon updates safe


TheBlueMatt Aug 16, 2022
721a858

Rename `Channel::monitor_update_failed` to `monitor_updating_paused`


TheBlueMatt Aug 16, 2022
fb0a481

Rename `handle_monitor_err!()` `handle_monitor_update_res!`


TheBlueMatt Aug 16, 2022
f961dae

Rename APIError::MonitorUpdateFailed to MonitorUpdateInProgress


TheBlueMatt Sep 29, 2022
52934e0

Clarify ambiguous comment in persist methods


TheBlueMatt Aug 24, 2022

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


37 changes: 21 additions & 16 deletions
fuzz/src/chanmon_consistency.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -32,7 +32,7 @@ use bitcoin::hashes::sha256::Hash as Sha256;
use bitcoin::hash_types::{BlockHash, WPubkeyHash};

use lightning::chain;
use lightning::chain::{BestBlock, ChannelMonitorUpdateErr, chainmonitor, channelmonitor, Confirm, Watch};
use lightning::chain::{BestBlock, ChannelMonitorUpdateStatus, chainmonitor, channelmonitor, Confirm, Watch};
use lightning::chain::channelmonitor::{ChannelMonitor, MonitorEvent};
use lightning::chain::transaction::OutPoint;
use lightning::chain::chaininterface::{BroadcasterInterface, ConfirmationTarget, FeeEstimator};
Expand DownExpand Up@@ -124,7 +124,7 @@ impl TestChainMonitor {
	}
}
impl chain::Watch<EnforcingSigner> for TestChainMonitor {
	fn watch_channel(&self, funding_txo: OutPoint, monitor: channelmonitor::ChannelMonitor<EnforcingSigner>) -> Result<(), chain::ChannelMonitorUpdateErr> {
	fn watch_channel(&self, funding_txo: OutPoint, monitor: channelmonitor::ChannelMonitor<EnforcingSigner>) -> chain::ChannelMonitorUpdateStatus {
 let mut ser = VecWriter(Vec::new());
 monitor.write(&mut ser).unwrap();
 if let Some(_) = self.latest_monitors.lock().unwrap().insert(funding_txo, (monitor.get_latest_update_id(), ser.0)) {
Expand All@@ -134,7 +134,7 @@ impl chain::Watch<EnforcingSigner> for TestChainMonitor {
 self.chain_monitor.watch_channel(funding_txo, monitor)
	}

	fn update_channel(&self, funding_txo: OutPoint, update: channelmonitor::ChannelMonitorUpdate) -> Result<(), chain::ChannelMonitorUpdateErr> {
	fn update_channel(&self, funding_txo: OutPoint, update: channelmonitor::ChannelMonitorUpdate) -> chain::ChannelMonitorUpdateStatus {
 let mut map_lock = self.latest_monitors.lock().unwrap();
 let mut map_entry = match map_lock.entry(funding_txo) {
 hash_map::Entry::Occupied(entry) => entry,
Expand DownExpand Up@@ -270,7 +270,7 @@ fn check_api_err(api_err: APIError) {
 _ => panic!("{}", err),
 }
 },
 APIError::MonitorUpdateFailed => {
 APIError::MonitorUpdateInProgress => {
 // We can (obviously) temp-fail a monitor update
 },
 APIError::IncompatibleShutdownScript { .. } => panic!("Cannot send an incompatible shutdown script"),
Expand DownExpand Up@@ -363,7 +363,9 @@ pub fn do_test<Out: Output>(data: &[u8], underlying_out: Out) {
 let logger: Arc<dyn Logger> = Arc::new(test_logger::TestLogger::new($node_id.to_string(), out.clone()));
 let keys_manager = Arc::new(KeyProvider { node_id: $node_id, rand_bytes_id: atomic::AtomicU32::new(0), enforcement_states: Mutex::new(HashMap::new()) });
 let monitor = Arc::new(TestChainMonitor::new(broadcast.clone(), logger.clone(), $fee_estimator.clone(),
 Arc::new(TestPersister { update_ret: Mutex::new(Ok(())) }), Arc::clone(&keys_manager)));
 Arc::new(TestPersister {
 update_ret: Mutex::new(ChannelMonitorUpdateStatus::Completed)
 }), Arc::clone(&keys_manager)));

 let mut config = UserConfig::default();
 config.channel_config.forwarding_fee_proportional_millionths = 0;
Expand All@@ -383,7 +385,9 @@ pub fn do_test<Out: Output>(data: &[u8], underlying_out: Out) {
 let keys_manager = Arc::clone(& $keys_manager);
 let logger: Arc<dyn Logger> = Arc::new(test_logger::TestLogger::new($node_id.to_string(), out.clone()));
 let chain_monitor = Arc::new(TestChainMonitor::new(broadcast.clone(), logger.clone(), $fee_estimator.clone(),
 Arc::new(TestPersister { update_ret: Mutex::new(Ok(())) }), Arc::clone(& $keys_manager)));
 Arc::new(TestPersister {
 update_ret: Mutex::new(ChannelMonitorUpdateStatus::Completed)
 }), Arc::clone(& $keys_manager)));

 let mut config = UserConfig::default();
 config.channel_config.forwarding_fee_proportional_millionths = 0;
Expand DownExpand Up@@ -412,7 +416,8 @@ pub fn do_test<Out: Output>(data: &[u8], underlying_out: Out) {

 let res = (<(BlockHash, ChanMan)>::read(&mut Cursor::new(&$ser.0), read_args).expect("Failed to read manager").1, chain_monitor.clone());
 for (funding_txo, mon) in monitors.drain() {
 assert!(chain_monitor.chain_monitor.watch_channel(funding_txo, mon).is_ok());
 assert_eq!(chain_monitor.chain_monitor.watch_channel(funding_txo, mon),
 ChannelMonitorUpdateStatus::Completed);
 }
 res
 } }
Expand DownExpand Up@@ -889,12 +894,12 @@ pub fn do_test<Out: Output>(data: &[u8], underlying_out: Out) {
 // bit-twiddling mutations to have similar effects. This is probably overkill, but no
 // harm in doing so.

 0x00 => *monitor_a.persister.update_ret.lock().unwrap() = Err(ChannelMonitorUpdateErr::TemporaryFailure),
 0x01 => *monitor_b.persister.update_ret.lock().unwrap() = Err(ChannelMonitorUpdateErr::TemporaryFailure),
 0x02 => *monitor_c.persister.update_ret.lock().unwrap() = Err(ChannelMonitorUpdateErr::TemporaryFailure),
 0x04 => *monitor_a.persister.update_ret.lock().unwrap() = Ok(()),
 0x05 => *monitor_b.persister.update_ret.lock().unwrap() = Ok(()),
 0x06 => *monitor_c.persister.update_ret.lock().unwrap() = Ok(()),
 0x00 => *monitor_a.persister.update_ret.lock().unwrap() = ChannelMonitorUpdateStatus::InProgress,
 0x01 => *monitor_b.persister.update_ret.lock().unwrap() = ChannelMonitorUpdateStatus::InProgress,
 0x02 => *monitor_c.persister.update_ret.lock().unwrap() = ChannelMonitorUpdateStatus::InProgress,
 0x04 => *monitor_a.persister.update_ret.lock().unwrap() = ChannelMonitorUpdateStatus::Completed,
 0x05 => *monitor_b.persister.update_ret.lock().unwrap() = ChannelMonitorUpdateStatus::Completed,
 0x06 => *monitor_c.persister.update_ret.lock().unwrap() = ChannelMonitorUpdateStatus::Completed,

 0x08 => {
 if let Some((id, _)) = monitor_a.latest_monitors.lock().unwrap().get(&chan_1_funding) {
Expand DownExpand Up@@ -1119,9 +1124,9 @@ pub fn do_test<Out: Output>(data: &[u8], underlying_out: Out) {
 // after we resolve all pending events.
 // First make sure there are no pending monitor updates, resetting the error state
 // and calling force_channel_monitor_updated for each monitor.
 *monitor_a.persister.update_ret.lock().unwrap() = Ok(());
 *monitor_b.persister.update_ret.lock().unwrap() = Ok(());
 *monitor_c.persister.update_ret.lock().unwrap() = Ok(());
 *monitor_a.persister.update_ret.lock().unwrap() = ChannelMonitorUpdateStatus::Completed;
 *monitor_b.persister.update_ret.lock().unwrap() = ChannelMonitorUpdateStatus::Completed;
 *monitor_c.persister.update_ret.lock().unwrap() = ChannelMonitorUpdateStatus::Completed;

 if let Some((id, _)) = monitor_a.latest_monitors.lock().unwrap().get(&chan_1_funding) {
 monitor_a.chain_monitor.force_channel_monitor_updated(chan_1_funding, *id);
Expand Down

4 changes: 2 additions & 2 deletions
fuzz/src/full_stack.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -29,7 +29,7 @@ use bitcoin::hashes::sha256::Hash as Sha256;
use bitcoin::hash_types::{Txid, BlockHash, WPubkeyHash};

use lightning::chain;
use lightning::chain::{BestBlock, Confirm, Listen};
use lightning::chain::{BestBlock, ChannelMonitorUpdateStatus, Confirm, Listen};
use lightning::chain::chaininterface::{BroadcasterInterface, ConfirmationTarget, FeeEstimator};
use lightning::chain::chainmonitor;
use lightning::chain::transaction::OutPoint;
Expand DownExpand Up@@ -389,7 +389,7 @@ pub fn do_test(data: &[u8], logger: &Arc<dyn Logger>) {

	let broadcast = Arc::new(TestBroadcaster{ txn_broadcasted: Mutex::new(Vec::new()) });
	let monitor = Arc::new(chainmonitor::ChainMonitor::new(None, broadcast.clone(), Arc::clone(&logger), fee_est.clone(),
 Arc::new(TestPersister { update_ret: Mutex::new(Ok(())) })));
 Arc::new(TestPersister { update_ret: Mutex::new(ChannelMonitorUpdateStatus::Completed) })));

	let keys_manager = Arc::new(KeyProvider { node_secret: our_network_key.clone(), inbound_payment_key: KeyMaterial(inbound_payment_key.try_into().unwrap()), counter: AtomicU64::new(0) });
	let mut config = UserConfig::default();
Expand Down

6 changes: 3 additions & 3 deletions
fuzz/src/utils/test_persister.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -7,14 +7,14 @@ use lightning::util::enforcing_trait_impls::EnforcingSigner;
use std::sync::Mutex;

pub struct TestPersister {
	pub update_ret: Mutex<Result<(), chain::ChannelMonitorUpdateErr>>,
	pub update_ret: Mutex<chain::ChannelMonitorUpdateStatus>,
}
impl chainmonitor::Persist<EnforcingSigner> for TestPersister {
	fn persist_new_channel(&self, _funding_txo: OutPoint, _data: &channelmonitor::ChannelMonitor<EnforcingSigner>, _update_id: MonitorUpdateId) -> Result<(), chain::ChannelMonitorUpdateErr> {
	fn persist_new_channel(&self, _funding_txo: OutPoint, _data: &channelmonitor::ChannelMonitor<EnforcingSigner>, _update_id: MonitorUpdateId) -> chain::ChannelMonitorUpdateStatus {
 self.update_ret.lock().unwrap().clone()
	}

	fn update_persisted_channel(&self, _funding_txo: OutPoint, _update: &Option<channelmonitor::ChannelMonitorUpdate>, _data: &channelmonitor::ChannelMonitor<EnforcingSigner>, _update_id: MonitorUpdateId) -> Result<(), chain::ChannelMonitorUpdateErr> {
	fn update_persisted_channel(&self, _funding_txo: OutPoint, _update: &Option<channelmonitor::ChannelMonitorUpdate>, _data: &channelmonitor::ChannelMonitor<EnforcingSigner>, _update_id: MonitorUpdateId) -> chain::ChannelMonitorUpdateStatus {
 self.update_ret.lock().unwrap().clone()
	}
}

18 changes: 9 additions & 9 deletions
lightning-invoice/src/payment.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -513,11 +513,11 @@ where
 },
 PaymentSendFailure::PartialFailure { failed_paths_retry, payment_id, results } => {
 // If a `PartialFailure` event returns a result that is an `Ok()`, it means that
 // part of our payment is retried. When we receive `MonitorUpdateFailed`, it
 // part of our payment is retried. When we receive `MonitorUpdateInProgress`, it
 // means that we are still waiting for our channel monitor update to be completed.
 for (result, path) in results.iter().zip(route.paths.into_iter()) {
 match result {
 Ok(_) | Err(APIError::MonitorUpdateFailed) => {
 Ok(_) | Err(APIError::MonitorUpdateInProgress) => {
 self.process_path_inflight_htlcs(payment_hash, path);
 },
 _ => {},
Expand DownExpand Up@@ -617,11 +617,11 @@ where
 },
 Err(PaymentSendFailure::PartialFailure { failed_paths_retry, results, .. }) => {
 // If a `PartialFailure` error contains a result that is an `Ok()`, it means that
 // part of our payment is retried. When we receive `MonitorUpdateFailed`, it
 // part of our payment is retried. When we receive `MonitorUpdateInProgress`, it
 // means that we are still waiting for our channel monitor update to complete.
 for (result, path) in results.iter().zip(route.unwrap().paths.into_iter()) {
 match result {
 Ok(_) | Err(APIError::MonitorUpdateFailed) => {
 Ok(_) | Err(APIError::MonitorUpdateInProgress) => {
 self.process_path_inflight_htlcs(payment_hash, path);
 },
 _ => {},
Expand DownExpand Up@@ -796,7 +796,7 @@ mod tests {
	use std::time::{SystemTime, Duration};
	use time_utils::tests::SinceEpoch;
	use DEFAULT_EXPIRY_TIME;
	use lightning::util::errors::APIError::{ChannelUnavailable, MonitorUpdateFailed};
	use lightning::util::errors::APIError::{ChannelUnavailable, MonitorUpdateInProgress};

	fn invoice(payment_preimage: PaymentPreimage) -> Invoice {
 let payment_hash = Sha256::hash(&payment_preimage.0);
Expand DownExpand Up@@ -1718,7 +1718,7 @@ mod tests {
 .fails_with_partial_failure(
 retry.clone(), OnAttempt(1),
 Some(vec![
 Err(ChannelUnavailable { err: "abc".to_string() }), Err(MonitorUpdateFailed)
 Err(ChannelUnavailable { err: "abc".to_string() }), Err(MonitorUpdateInProgress)
 ]))
 .expect_send(Amount::ForInvoice(final_value_msat));

Expand All@@ -1731,7 +1731,7 @@ mod tests {
 invoice_payer.pay_invoice(&invoice_to_pay).unwrap();
 let inflight_map = invoice_payer.create_inflight_map();

 // Only the second path, which failed with `MonitorUpdateFailed` should be added to our
 // Only the second path, which failed with `MonitorUpdateInProgress` should be added to our
 // inflight map because retries are disabled.
 assert_eq!(inflight_map.len(), 2);
	}
Expand All@@ -1750,7 +1750,7 @@ mod tests {
 .fails_with_partial_failure(
 retry.clone(), OnAttempt(1),
 Some(vec![
 Ok(()), Err(MonitorUpdateFailed)
 Ok(()), Err(MonitorUpdateInProgress)
 ]))
 .expect_send(Amount::ForInvoice(final_value_msat));

Expand DownExpand Up@@ -2044,7 +2044,7 @@ mod tests {
 }

 fn fails_on_attempt(self, attempt: usize) -> Self {
 let failure = PaymentSendFailure::ParameterError(APIError::MonitorUpdateFailed);
 let failure = PaymentSendFailure::ParameterError(APIError::MonitorUpdateInProgress);
 self.fails_with(failure, OnAttempt(attempt))
 }

Expand Down

6 changes: 3 additions & 3 deletions
lightning-persister/src/lib.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -138,7 +138,7 @@ mod tests {
	use bitcoin::blockdata::block::{Block, BlockHeader};
	use bitcoin::hashes::hex::FromHex;
	use bitcoin::{Txid, TxMerkleNode};
	use lightning::chain::ChannelMonitorUpdateErr;
	use lightning::chain::ChannelMonitorUpdateStatus;
	use lightning::chain::chainmonitor::Persist;
	use lightning::chain::transaction::OutPoint;
	use lightning::{check_closed_broadcast, check_closed_event, check_added_monitors};
Expand DownExpand Up@@ -270,7 +270,7 @@ mod tests {
 index: 0
 };
 match persister.persist_new_channel(test_txo, &added_monitors[0].1, update_id.2) {
Err(ChannelMonitorUpdateErr::PermanentFailure) => {},
ChannelMonitorUpdateStatus::PermanentFailure => {},
 _ => panic!("unexpected result from persisting new channel")
 }

Expand DownExpand Up@@ -307,7 +307,7 @@ mod tests {
 index: 0
 };
 match persister.persist_new_channel(test_txo, &added_monitors[0].1, update_id.2) {
Err(ChannelMonitorUpdateErr::PermanentFailure) => {},
ChannelMonitorUpdateStatus::PermanentFailure => {},
 _ => panic!("unexpected result from persisting new channel")
 }

Expand Down
Loading

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

TheBlueMatt
merged 7 commits into

from

Sep 29, 2022
 Merged


Do not broadcast commitment txn on Permanent mon update failure
#1106
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


7 commits


Select commit
Hold shift + click to select a range
313810e

Do not broadcast commitment txn on Permanent mon update failure


TheBlueMatt Oct 5, 2021
12fa0b1

Rework `chain::Watch` return types to make async updates less scary


TheBlueMatt Jul 18, 2022
72416b9

Add a TODO for an important issue for making async mon updates safe


TheBlueMatt Aug 16, 2022
721a858

Rename `Channel::monitor_update_failed` to `monitor_updating_paused`


TheBlueMatt Aug 16, 2022
fb0a481

Rename `handle_monitor_err!()` `handle_monitor_update_res!`


TheBlueMatt Aug 16, 2022
f961dae

Rename APIError::MonitorUpdateFailed to MonitorUpdateInProgress


TheBlueMatt Sep 29, 2022
52934e0

Clarify ambiguous comment in persist methods


TheBlueMatt Aug 24, 2022

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


37 changes: 21 additions & 16 deletions
fuzz/src/chanmon_consistency.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -32,7 +32,7 @@ use bitcoin::hashes::sha256::Hash as Sha256;
use bitcoin::hash_types::{BlockHash, WPubkeyHash};

use lightning::chain;
use lightning::chain::{BestBlock, ChannelMonitorUpdateErr, chainmonitor, channelmonitor, Confirm, Watch};
use lightning::chain::{BestBlock, ChannelMonitorUpdateStatus, chainmonitor, channelmonitor, Confirm, Watch};
use lightning::chain::channelmonitor::{ChannelMonitor, MonitorEvent};
use lightning::chain::transaction::OutPoint;
use lightning::chain::chaininterface::{BroadcasterInterface, ConfirmationTarget, FeeEstimator};
Expand DownExpand Up@@ -124,7 +124,7 @@ impl TestChainMonitor {
	}
}
impl chain::Watch<EnforcingSigner> for TestChainMonitor {
	fn watch_channel(&self, funding_txo: OutPoint, monitor: channelmonitor::ChannelMonitor<EnforcingSigner>) -> Result<(), chain::ChannelMonitorUpdateErr> {
	fn watch_channel(&self, funding_txo: OutPoint, monitor: channelmonitor::ChannelMonitor<EnforcingSigner>) -> chain::ChannelMonitorUpdateStatus {
 let mut ser = VecWriter(Vec::new());
 monitor.write(&mut ser).unwrap();
 if let Some(_) = self.latest_monitors.lock().unwrap().insert(funding_txo, (monitor.get_latest_update_id(), ser.0)) {
Expand All@@ -134,7 +134,7 @@ impl chain::Watch<EnforcingSigner> for TestChainMonitor {
 self.chain_monitor.watch_channel(funding_txo, monitor)
	}

	fn update_channel(&self, funding_txo: OutPoint, update: channelmonitor::ChannelMonitorUpdate) -> Result<(), chain::ChannelMonitorUpdateErr> {
	fn update_channel(&self, funding_txo: OutPoint, update: channelmonitor::ChannelMonitorUpdate) -> chain::ChannelMonitorUpdateStatus {
 let mut map_lock = self.latest_monitors.lock().unwrap();
 let mut map_entry = match map_lock.entry(funding_txo) {
 hash_map::Entry::Occupied(entry) => entry,
Expand DownExpand Up@@ -270,7 +270,7 @@ fn check_api_err(api_err: APIError) {
 _ => panic!("{}", err),
 }
 },
 APIError::MonitorUpdateFailed => {
 APIError::MonitorUpdateInProgress => {
 // We can (obviously) temp-fail a monitor update
 },
 APIError::IncompatibleShutdownScript { .. } => panic!("Cannot send an incompatible shutdown script"),
Expand DownExpand Up@@ -363,7 +363,9 @@ pub fn do_test<Out: Output>(data: &[u8], underlying_out: Out) {
 let logger: Arc<dyn Logger> = Arc::new(test_logger::TestLogger::new($node_id.to_string(), out.clone()));
 let keys_manager = Arc::new(KeyProvider { node_id: $node_id, rand_bytes_id: atomic::AtomicU32::new(0), enforcement_states: Mutex::new(HashMap::new()) });
 let monitor = Arc::new(TestChainMonitor::new(broadcast.clone(), logger.clone(), $fee_estimator.clone(),
 Arc::new(TestPersister { update_ret: Mutex::new(Ok(())) }), Arc::clone(&keys_manager)));
 Arc::new(TestPersister {
 update_ret: Mutex::new(ChannelMonitorUpdateStatus::Completed)
 }), Arc::clone(&keys_manager)));

 let mut config = UserConfig::default();
 config.channel_config.forwarding_fee_proportional_millionths = 0;
Expand All@@ -383,7 +385,9 @@ pub fn do_test<Out: Output>(data: &[u8], underlying_out: Out) {
 let keys_manager = Arc::clone(& $keys_manager);
 let logger: Arc<dyn Logger> = Arc::new(test_logger::TestLogger::new($node_id.to_string(), out.clone()));
 let chain_monitor = Arc::new(TestChainMonitor::new(broadcast.clone(), logger.clone(), $fee_estimator.clone(),
 Arc::new(TestPersister { update_ret: Mutex::new(Ok(())) }), Arc::clone(& $keys_manager)));
 Arc::new(TestPersister {
 update_ret: Mutex::new(ChannelMonitorUpdateStatus::Completed)
 }), Arc::clone(& $keys_manager)));

 let mut config = UserConfig::default();
 config.channel_config.forwarding_fee_proportional_millionths = 0;
Expand DownExpand Up@@ -412,7 +416,8 @@ pub fn do_test<Out: Output>(data: &[u8], underlying_out: Out) {

 let res = (<(BlockHash, ChanMan)>::read(&mut Cursor::new(&$ser.0), read_args).expect("Failed to read manager").1, chain_monitor.clone());
 for (funding_txo, mon) in monitors.drain() {
 assert!(chain_monitor.chain_monitor.watch_channel(funding_txo, mon).is_ok());
 assert_eq!(chain_monitor.chain_monitor.watch_channel(funding_txo, mon),
 ChannelMonitorUpdateStatus::Completed);
 }
 res
 } }
Expand DownExpand Up@@ -889,12 +894,12 @@ pub fn do_test<Out: Output>(data: &[u8], underlying_out: Out) {
 // bit-twiddling mutations to have similar effects. This is probably overkill, but no
 // harm in doing so.

 0x00 => *monitor_a.persister.update_ret.lock().unwrap() = Err(ChannelMonitorUpdateErr::TemporaryFailure),
 0x01 => *monitor_b.persister.update_ret.lock().unwrap() = Err(ChannelMonitorUpdateErr::TemporaryFailure),
 0x02 => *monitor_c.persister.update_ret.lock().unwrap() = Err(ChannelMonitorUpdateErr::TemporaryFailure),
 0x04 => *monitor_a.persister.update_ret.lock().unwrap() = Ok(()),
 0x05 => *monitor_b.persister.update_ret.lock().unwrap() = Ok(()),
 0x06 => *monitor_c.persister.update_ret.lock().unwrap() = Ok(()),
 0x00 => *monitor_a.persister.update_ret.lock().unwrap() = ChannelMonitorUpdateStatus::InProgress,
 0x01 => *monitor_b.persister.update_ret.lock().unwrap() = ChannelMonitorUpdateStatus::InProgress,
 0x02 => *monitor_c.persister.update_ret.lock().unwrap() = ChannelMonitorUpdateStatus::InProgress,
 0x04 => *monitor_a.persister.update_ret.lock().unwrap() = ChannelMonitorUpdateStatus::Completed,
 0x05 => *monitor_b.persister.update_ret.lock().unwrap() = ChannelMonitorUpdateStatus::Completed,
 0x06 => *monitor_c.persister.update_ret.lock().unwrap() = ChannelMonitorUpdateStatus::Completed,

 0x08 => {
 if let Some((id, _)) = monitor_a.latest_monitors.lock().unwrap().get(&chan_1_funding) {
Expand DownExpand Up@@ -1119,9 +1124,9 @@ pub fn do_test<Out: Output>(data: &[u8], underlying_out: Out) {
 // after we resolve all pending events.
 // First make sure there are no pending monitor updates, resetting the error state
 // and calling force_channel_monitor_updated for each monitor.
 *monitor_a.persister.update_ret.lock().unwrap() = Ok(());
 *monitor_b.persister.update_ret.lock().unwrap() = Ok(());
 *monitor_c.persister.update_ret.lock().unwrap() = Ok(());
 *monitor_a.persister.update_ret.lock().unwrap() = ChannelMonitorUpdateStatus::Completed;
 *monitor_b.persister.update_ret.lock().unwrap() = ChannelMonitorUpdateStatus::Completed;
 *monitor_c.persister.update_ret.lock().unwrap() = ChannelMonitorUpdateStatus::Completed;

 if let Some((id, _)) = monitor_a.latest_monitors.lock().unwrap().get(&chan_1_funding) {
 monitor_a.chain_monitor.force_channel_monitor_updated(chan_1_funding, *id);
Expand Down

4 changes: 2 additions & 2 deletions
fuzz/src/full_stack.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -29,7 +29,7 @@ use bitcoin::hashes::sha256::Hash as Sha256;
use bitcoin::hash_types::{Txid, BlockHash, WPubkeyHash};

use lightning::chain;
use lightning::chain::{BestBlock, Confirm, Listen};
use lightning::chain::{BestBlock, ChannelMonitorUpdateStatus, Confirm, Listen};
use lightning::chain::chaininterface::{BroadcasterInterface, ConfirmationTarget, FeeEstimator};
use lightning::chain::chainmonitor;
use lightning::chain::transaction::OutPoint;
Expand DownExpand Up@@ -389,7 +389,7 @@ pub fn do_test(data: &[u8], logger: &Arc<dyn Logger>) {

	let broadcast = Arc::new(TestBroadcaster{ txn_broadcasted: Mutex::new(Vec::new()) });
	let monitor = Arc::new(chainmonitor::ChainMonitor::new(None, broadcast.clone(), Arc::clone(&logger), fee_est.clone(),
 Arc::new(TestPersister { update_ret: Mutex::new(Ok(())) })));
 Arc::new(TestPersister { update_ret: Mutex::new(ChannelMonitorUpdateStatus::Completed) })));

	let keys_manager = Arc::new(KeyProvider { node_secret: our_network_key.clone(), inbound_payment_key: KeyMaterial(inbound_payment_key.try_into().unwrap()), counter: AtomicU64::new(0) });
	let mut config = UserConfig::default();
Expand Down

6 changes: 3 additions & 3 deletions
fuzz/src/utils/test_persister.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -7,14 +7,14 @@ use lightning::util::enforcing_trait_impls::EnforcingSigner;
use std::sync::Mutex;

pub struct TestPersister {
	pub update_ret: Mutex<Result<(), chain::ChannelMonitorUpdateErr>>,
	pub update_ret: Mutex<chain::ChannelMonitorUpdateStatus>,
}
impl chainmonitor::Persist<EnforcingSigner> for TestPersister {
	fn persist_new_channel(&self, _funding_txo: OutPoint, _data: &channelmonitor::ChannelMonitor<EnforcingSigner>, _update_id: MonitorUpdateId) -> Result<(), chain::ChannelMonitorUpdateErr> {
	fn persist_new_channel(&self, _funding_txo: OutPoint, _data: &channelmonitor::ChannelMonitor<EnforcingSigner>, _update_id: MonitorUpdateId) -> chain::ChannelMonitorUpdateStatus {
 self.update_ret.lock().unwrap().clone()
	}

	fn update_persisted_channel(&self, _funding_txo: OutPoint, _update: &Option<channelmonitor::ChannelMonitorUpdate>, _data: &channelmonitor::ChannelMonitor<EnforcingSigner>, _update_id: MonitorUpdateId) -> Result<(), chain::ChannelMonitorUpdateErr> {
	fn update_persisted_channel(&self, _funding_txo: OutPoint, _update: &Option<channelmonitor::ChannelMonitorUpdate>, _data: &channelmonitor::ChannelMonitor<EnforcingSigner>, _update_id: MonitorUpdateId) -> chain::ChannelMonitorUpdateStatus {
 self.update_ret.lock().unwrap().clone()
	}
}

18 changes: 9 additions & 9 deletions
lightning-invoice/src/payment.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -513,11 +513,11 @@ where
 },
 PaymentSendFailure::PartialFailure { failed_paths_retry, payment_id, results } => {
 // If a `PartialFailure` event returns a result that is an `Ok()`, it means that
 // part of our payment is retried. When we receive `MonitorUpdateFailed`, it
 // part of our payment is retried. When we receive `MonitorUpdateInProgress`, it
 // means that we are still waiting for our channel monitor update to be completed.
 for (result, path) in results.iter().zip(route.paths.into_iter()) {
 match result {
 Ok(_) | Err(APIError::MonitorUpdateFailed) => {
 Ok(_) | Err(APIError::MonitorUpdateInProgress) => {
 self.process_path_inflight_htlcs(payment_hash, path);
 },
 _ => {},
Expand DownExpand Up@@ -617,11 +617,11 @@ where
 },
 Err(PaymentSendFailure::PartialFailure { failed_paths_retry, results, .. }) => {
 // If a `PartialFailure` error contains a result that is an `Ok()`, it means that
 // part of our payment is retried. When we receive `MonitorUpdateFailed`, it
 // part of our payment is retried. When we receive `MonitorUpdateInProgress`, it
 // means that we are still waiting for our channel monitor update to complete.
 for (result, path) in results.iter().zip(route.unwrap().paths.into_iter()) {
 match result {
 Ok(_) | Err(APIError::MonitorUpdateFailed) => {
 Ok(_) | Err(APIError::MonitorUpdateInProgress) => {
 self.process_path_inflight_htlcs(payment_hash, path);
 },
 _ => {},
Expand DownExpand Up@@ -796,7 +796,7 @@ mod tests {
	use std::time::{SystemTime, Duration};
	use time_utils::tests::SinceEpoch;
	use DEFAULT_EXPIRY_TIME;
	use lightning::util::errors::APIError::{ChannelUnavailable, MonitorUpdateFailed};
	use lightning::util::errors::APIError::{ChannelUnavailable, MonitorUpdateInProgress};

	fn invoice(payment_preimage: PaymentPreimage) -> Invoice {
 let payment_hash = Sha256::hash(&payment_preimage.0);
Expand DownExpand Up@@ -1718,7 +1718,7 @@ mod tests {
 .fails_with_partial_failure(
 retry.clone(), OnAttempt(1),
 Some(vec![
 Err(ChannelUnavailable { err: "abc".to_string() }), Err(MonitorUpdateFailed)
 Err(ChannelUnavailable { err: "abc".to_string() }), Err(MonitorUpdateInProgress)
 ]))
 .expect_send(Amount::ForInvoice(final_value_msat));

Expand All@@ -1731,7 +1731,7 @@ mod tests {
 invoice_payer.pay_invoice(&invoice_to_pay).unwrap();
 let inflight_map = invoice_payer.create_inflight_map();

 // Only the second path, which failed with `MonitorUpdateFailed` should be added to our
 // Only the second path, which failed with `MonitorUpdateInProgress` should be added to our
 // inflight map because retries are disabled.
 assert_eq!(inflight_map.len(), 2);
	}
Expand All@@ -1750,7 +1750,7 @@ mod tests {
 .fails_with_partial_failure(
 retry.clone(), OnAttempt(1),
 Some(vec![
 Ok(()), Err(MonitorUpdateFailed)
 Ok(()), Err(MonitorUpdateInProgress)
 ]))
 .expect_send(Amount::ForInvoice(final_value_msat));

Expand DownExpand Up@@ -2044,7 +2044,7 @@ mod tests {
 }

 fn fails_on_attempt(self, attempt: usize) -> Self {
 let failure = PaymentSendFailure::ParameterError(APIError::MonitorUpdateFailed);
 let failure = PaymentSendFailure::ParameterError(APIError::MonitorUpdateInProgress);
 self.fails_with(failure, OnAttempt(attempt))
 }

Expand Down

6 changes: 3 additions & 3 deletions
lightning-persister/src/lib.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -138,7 +138,7 @@ mod tests {
	use bitcoin::blockdata::block::{Block, BlockHeader};
	use bitcoin::hashes::hex::FromHex;
	use bitcoin::{Txid, TxMerkleNode};
	use lightning::chain::ChannelMonitorUpdateErr;
	use lightning::chain::ChannelMonitorUpdateStatus;
	use lightning::chain::chainmonitor::Persist;
	use lightning::chain::transaction::OutPoint;
	use lightning::{check_closed_broadcast, check_closed_event, check_added_monitors};
Expand DownExpand Up@@ -270,7 +270,7 @@ mod tests {
 index: 0
 };
 match persister.persist_new_channel(test_txo, &added_monitors[0].1, update_id.2) {
Err(ChannelMonitorUpdateErr::PermanentFailure) => {},
ChannelMonitorUpdateStatus::PermanentFailure => {},
 _ => panic!("unexpected result from persisting new channel")
 }

Expand DownExpand Up@@ -307,7 +307,7 @@ mod tests {
 index: 0
 };
 match persister.persist_new_channel(test_txo, &added_monitors[0].1, update_id.2) {
Err(ChannelMonitorUpdateErr::PermanentFailure) => {},
ChannelMonitorUpdateStatus::PermanentFailure => {},
 _ => panic!("unexpected result from persisting new channel")
 }

Expand Down
Loading

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

TheBlueMatt
merged 7 commits into

from

Sep 29, 2022
 Merged


Do not broadcast commitment txn on Permanent mon update failure
#1106
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


7 commits


Select commit
Hold shift + click to select a range
313810e

Do not broadcast commitment txn on Permanent mon update failure


TheBlueMatt Oct 5, 2021
12fa0b1

Rework `chain::Watch` return types to make async updates less scary


TheBlueMatt Jul 18, 2022
72416b9

Add a TODO for an important issue for making async mon updates safe


TheBlueMatt Aug 16, 2022
721a858

Rename `Channel::monitor_update_failed` to `monitor_updating_paused`


TheBlueMatt Aug 16, 2022
fb0a481

Rename `handle_monitor_err!()` `handle_monitor_update_res!`


TheBlueMatt Aug 16, 2022
f961dae

Rename APIError::MonitorUpdateFailed to MonitorUpdateInProgress


TheBlueMatt Sep 29, 2022
52934e0

Clarify ambiguous comment in persist methods


TheBlueMatt Aug 24, 2022

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


37 changes: 21 additions & 16 deletions
fuzz/src/chanmon_consistency.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -32,7 +32,7 @@ use bitcoin::hashes::sha256::Hash as Sha256;
use bitcoin::hash_types::{BlockHash, WPubkeyHash};

use lightning::chain;
use lightning::chain::{BestBlock, ChannelMonitorUpdateErr, chainmonitor, channelmonitor, Confirm, Watch};
use lightning::chain::{BestBlock, ChannelMonitorUpdateStatus, chainmonitor, channelmonitor, Confirm, Watch};
use lightning::chain::channelmonitor::{ChannelMonitor, MonitorEvent};
use lightning::chain::transaction::OutPoint;
use lightning::chain::chaininterface::{BroadcasterInterface, ConfirmationTarget, FeeEstimator};
Expand DownExpand Up@@ -124,7 +124,7 @@ impl TestChainMonitor {
	}
}
impl chain::Watch<EnforcingSigner> for TestChainMonitor {
	fn watch_channel(&self, funding_txo: OutPoint, monitor: channelmonitor::ChannelMonitor<EnforcingSigner>) -> Result<(), chain::ChannelMonitorUpdateErr> {
	fn watch_channel(&self, funding_txo: OutPoint, monitor: channelmonitor::ChannelMonitor<EnforcingSigner>) -> chain::ChannelMonitorUpdateStatus {
 let mut ser = VecWriter(Vec::new());
 monitor.write(&mut ser).unwrap();
 if let Some(_) = self.latest_monitors.lock().unwrap().insert(funding_txo, (monitor.get_latest_update_id(), ser.0)) {
Expand All@@ -134,7 +134,7 @@ impl chain::Watch<EnforcingSigner> for TestChainMonitor {
 self.chain_monitor.watch_channel(funding_txo, monitor)
	}

	fn update_channel(&self, funding_txo: OutPoint, update: channelmonitor::ChannelMonitorUpdate) -> Result<(), chain::ChannelMonitorUpdateErr> {
	fn update_channel(&self, funding_txo: OutPoint, update: channelmonitor::ChannelMonitorUpdate) -> chain::ChannelMonitorUpdateStatus {
 let mut map_lock = self.latest_monitors.lock().unwrap();
 let mut map_entry = match map_lock.entry(funding_txo) {
 hash_map::Entry::Occupied(entry) => entry,
Expand DownExpand Up@@ -270,7 +270,7 @@ fn check_api_err(api_err: APIError) {
 _ => panic!("{}", err),
 }
 },
 APIError::MonitorUpdateFailed => {
 APIError::MonitorUpdateInProgress => {
 // We can (obviously) temp-fail a monitor update
 },
 APIError::IncompatibleShutdownScript { .. } => panic!("Cannot send an incompatible shutdown script"),
Expand DownExpand Up@@ -363,7 +363,9 @@ pub fn do_test<Out: Output>(data: &[u8], underlying_out: Out) {
 let logger: Arc<dyn Logger> = Arc::new(test_logger::TestLogger::new($node_id.to_string(), out.clone()));
 let keys_manager = Arc::new(KeyProvider { node_id: $node_id, rand_bytes_id: atomic::AtomicU32::new(0), enforcement_states: Mutex::new(HashMap::new()) });
 let monitor = Arc::new(TestChainMonitor::new(broadcast.clone(), logger.clone(), $fee_estimator.clone(),
 Arc::new(TestPersister { update_ret: Mutex::new(Ok(())) }), Arc::clone(&keys_manager)));
 Arc::new(TestPersister {
 update_ret: Mutex::new(ChannelMonitorUpdateStatus::Completed)
 }), Arc::clone(&keys_manager)));

 let mut config = UserConfig::default();
 config.channel_config.forwarding_fee_proportional_millionths = 0;
Expand All@@ -383,7 +385,9 @@ pub fn do_test<Out: Output>(data: &[u8], underlying_out: Out) {
 let keys_manager = Arc::clone(& $keys_manager);
 let logger: Arc<dyn Logger> = Arc::new(test_logger::TestLogger::new($node_id.to_string(), out.clone()));
 let chain_monitor = Arc::new(TestChainMonitor::new(broadcast.clone(), logger.clone(), $fee_estimator.clone(),
 Arc::new(TestPersister { update_ret: Mutex::new(Ok(())) }), Arc::clone(& $keys_manager)));
 Arc::new(TestPersister {
 update_ret: Mutex::new(ChannelMonitorUpdateStatus::Completed)
 }), Arc::clone(& $keys_manager)));

 let mut config = UserConfig::default();
 config.channel_config.forwarding_fee_proportional_millionths = 0;
Expand DownExpand Up@@ -412,7 +416,8 @@ pub fn do_test<Out: Output>(data: &[u8], underlying_out: Out) {

 let res = (<(BlockHash, ChanMan)>::read(&mut Cursor::new(&$ser.0), read_args).expect("Failed to read manager").1, chain_monitor.clone());
 for (funding_txo, mon) in monitors.drain() {
 assert!(chain_monitor.chain_monitor.watch_channel(funding_txo, mon).is_ok());
 assert_eq!(chain_monitor.chain_monitor.watch_channel(funding_txo, mon),
 ChannelMonitorUpdateStatus::Completed);
 }
 res
 } }
Expand DownExpand Up@@ -889,12 +894,12 @@ pub fn do_test<Out: Output>(data: &[u8], underlying_out: Out) {
 // bit-twiddling mutations to have similar effects. This is probably overkill, but no
 // harm in doing so.

 0x00 => *monitor_a.persister.update_ret.lock().unwrap() = Err(ChannelMonitorUpdateErr::TemporaryFailure),
 0x01 => *monitor_b.persister.update_ret.lock().unwrap() = Err(ChannelMonitorUpdateErr::TemporaryFailure),
 0x02 => *monitor_c.persister.update_ret.lock().unwrap() = Err(ChannelMonitorUpdateErr::TemporaryFailure),
 0x04 => *monitor_a.persister.update_ret.lock().unwrap() = Ok(()),
 0x05 => *monitor_b.persister.update_ret.lock().unwrap() = Ok(()),
 0x06 => *monitor_c.persister.update_ret.lock().unwrap() = Ok(()),
 0x00 => *monitor_a.persister.update_ret.lock().unwrap() = ChannelMonitorUpdateStatus::InProgress,
 0x01 => *monitor_b.persister.update_ret.lock().unwrap() = ChannelMonitorUpdateStatus::InProgress,
 0x02 => *monitor_c.persister.update_ret.lock().unwrap() = ChannelMonitorUpdateStatus::InProgress,
 0x04 => *monitor_a.persister.update_ret.lock().unwrap() = ChannelMonitorUpdateStatus::Completed,
 0x05 => *monitor_b.persister.update_ret.lock().unwrap() = ChannelMonitorUpdateStatus::Completed,
 0x06 => *monitor_c.persister.update_ret.lock().unwrap() = ChannelMonitorUpdateStatus::Completed,

 0x08 => {
 if let Some((id, _)) = monitor_a.latest_monitors.lock().unwrap().get(&chan_1_funding) {
Expand DownExpand Up@@ -1119,9 +1124,9 @@ pub fn do_test<Out: Output>(data: &[u8], underlying_out: Out) {
 // after we resolve all pending events.
 // First make sure there are no pending monitor updates, resetting the error state
 // and calling force_channel_monitor_updated for each monitor.
 *monitor_a.persister.update_ret.lock().unwrap() = Ok(());
 *monitor_b.persister.update_ret.lock().unwrap() = Ok(());
 *monitor_c.persister.update_ret.lock().unwrap() = Ok(());
 *monitor_a.persister.update_ret.lock().unwrap() = ChannelMonitorUpdateStatus::Completed;
 *monitor_b.persister.update_ret.lock().unwrap() = ChannelMonitorUpdateStatus::Completed;
 *monitor_c.persister.update_ret.lock().unwrap() = ChannelMonitorUpdateStatus::Completed;

 if let Some((id, _)) = monitor_a.latest_monitors.lock().unwrap().get(&chan_1_funding) {
 monitor_a.chain_monitor.force_channel_monitor_updated(chan_1_funding, *id);
Expand Down

4 changes: 2 additions & 2 deletions
fuzz/src/full_stack.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -29,7 +29,7 @@ use bitcoin::hashes::sha256::Hash as Sha256;
use bitcoin::hash_types::{Txid, BlockHash, WPubkeyHash};

use lightning::chain;
use lightning::chain::{BestBlock, Confirm, Listen};
use lightning::chain::{BestBlock, ChannelMonitorUpdateStatus, Confirm, Listen};
use lightning::chain::chaininterface::{BroadcasterInterface, ConfirmationTarget, FeeEstimator};
use lightning::chain::chainmonitor;
use lightning::chain::transaction::OutPoint;
Expand DownExpand Up@@ -389,7 +389,7 @@ pub fn do_test(data: &[u8], logger: &Arc<dyn Logger>) {

	let broadcast = Arc::new(TestBroadcaster{ txn_broadcasted: Mutex::new(Vec::new()) });
	let monitor = Arc::new(chainmonitor::ChainMonitor::new(None, broadcast.clone(), Arc::clone(&logger), fee_est.clone(),
 Arc::new(TestPersister { update_ret: Mutex::new(Ok(())) })));
 Arc::new(TestPersister { update_ret: Mutex::new(ChannelMonitorUpdateStatus::Completed) })));

	let keys_manager = Arc::new(KeyProvider { node_secret: our_network_key.clone(), inbound_payment_key: KeyMaterial(inbound_payment_key.try_into().unwrap()), counter: AtomicU64::new(0) });
	let mut config = UserConfig::default();
Expand Down

6 changes: 3 additions & 3 deletions
fuzz/src/utils/test_persister.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -7,14 +7,14 @@ use lightning::util::enforcing_trait_impls::EnforcingSigner;
use std::sync::Mutex;

pub struct TestPersister {
	pub update_ret: Mutex<Result<(), chain::ChannelMonitorUpdateErr>>,
	pub update_ret: Mutex<chain::ChannelMonitorUpdateStatus>,
}
impl chainmonitor::Persist<EnforcingSigner> for TestPersister {
	fn persist_new_channel(&self, _funding_txo: OutPoint, _data: &channelmonitor::ChannelMonitor<EnforcingSigner>, _update_id: MonitorUpdateId) -> Result<(), chain::ChannelMonitorUpdateErr> {
	fn persist_new_channel(&self, _funding_txo: OutPoint, _data: &channelmonitor::ChannelMonitor<EnforcingSigner>, _update_id: MonitorUpdateId) -> chain::ChannelMonitorUpdateStatus {
 self.update_ret.lock().unwrap().clone()
	}

	fn update_persisted_channel(&self, _funding_txo: OutPoint, _update: &Option<channelmonitor::ChannelMonitorUpdate>, _data: &channelmonitor::ChannelMonitor<EnforcingSigner>, _update_id: MonitorUpdateId) -> Result<(), chain::ChannelMonitorUpdateErr> {
	fn update_persisted_channel(&self, _funding_txo: OutPoint, _update: &Option<channelmonitor::ChannelMonitorUpdate>, _data: &channelmonitor::ChannelMonitor<EnforcingSigner>, _update_id: MonitorUpdateId) -> chain::ChannelMonitorUpdateStatus {
 self.update_ret.lock().unwrap().clone()
	}
}

18 changes: 9 additions & 9 deletions
lightning-invoice/src/payment.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -513,11 +513,11 @@ where
 },
 PaymentSendFailure::PartialFailure { failed_paths_retry, payment_id, results } => {
 // If a `PartialFailure` event returns a result that is an `Ok()`, it means that
 // part of our payment is retried. When we receive `MonitorUpdateFailed`, it
 // part of our payment is retried. When we receive `MonitorUpdateInProgress`, it
 // means that we are still waiting for our channel monitor update to be completed.
 for (result, path) in results.iter().zip(route.paths.into_iter()) {
 match result {
 Ok(_) | Err(APIError::MonitorUpdateFailed) => {
 Ok(_) | Err(APIError::MonitorUpdateInProgress) => {
 self.process_path_inflight_htlcs(payment_hash, path);
 },
 _ => {},
Expand DownExpand Up@@ -617,11 +617,11 @@ where
 },
 Err(PaymentSendFailure::PartialFailure { failed_paths_retry, results, .. }) => {
 // If a `PartialFailure` error contains a result that is an `Ok()`, it means that
 // part of our payment is retried. When we receive `MonitorUpdateFailed`, it
 // part of our payment is retried. When we receive `MonitorUpdateInProgress`, it
 // means that we are still waiting for our channel monitor update to complete.
 for (result, path) in results.iter().zip(route.unwrap().paths.into_iter()) {
 match result {
 Ok(_) | Err(APIError::MonitorUpdateFailed) => {
 Ok(_) | Err(APIError::MonitorUpdateInProgress) => {
 self.process_path_inflight_htlcs(payment_hash, path);
 },
 _ => {},
Expand DownExpand Up@@ -796,7 +796,7 @@ mod tests {
	use std::time::{SystemTime, Duration};
	use time_utils::tests::SinceEpoch;
	use DEFAULT_EXPIRY_TIME;
	use lightning::util::errors::APIError::{ChannelUnavailable, MonitorUpdateFailed};
	use lightning::util::errors::APIError::{ChannelUnavailable, MonitorUpdateInProgress};

	fn invoice(payment_preimage: PaymentPreimage) -> Invoice {
 let payment_hash = Sha256::hash(&payment_preimage.0);
Expand DownExpand Up@@ -1718,7 +1718,7 @@ mod tests {
 .fails_with_partial_failure(
 retry.clone(), OnAttempt(1),
 Some(vec![
 Err(ChannelUnavailable { err: "abc".to_string() }), Err(MonitorUpdateFailed)
 Err(ChannelUnavailable { err: "abc".to_string() }), Err(MonitorUpdateInProgress)
 ]))
 .expect_send(Amount::ForInvoice(final_value_msat));

Expand All@@ -1731,7 +1731,7 @@ mod tests {
 invoice_payer.pay_invoice(&invoice_to_pay).unwrap();
 let inflight_map = invoice_payer.create_inflight_map();

 // Only the second path, which failed with `MonitorUpdateFailed` should be added to our
 // Only the second path, which failed with `MonitorUpdateInProgress` should be added to our
 // inflight map because retries are disabled.
 assert_eq!(inflight_map.len(), 2);
	}
Expand All@@ -1750,7 +1750,7 @@ mod tests {
 .fails_with_partial_failure(
 retry.clone(), OnAttempt(1),
 Some(vec![
 Ok(()), Err(MonitorUpdateFailed)
 Ok(()), Err(MonitorUpdateInProgress)
 ]))
 .expect_send(Amount::ForInvoice(final_value_msat));

Expand DownExpand Up@@ -2044,7 +2044,7 @@ mod tests {
 }

 fn fails_on_attempt(self, attempt: usize) -> Self {
 let failure = PaymentSendFailure::ParameterError(APIError::MonitorUpdateFailed);
 let failure = PaymentSendFailure::ParameterError(APIError::MonitorUpdateInProgress);
 self.fails_with(failure, OnAttempt(attempt))
 }

Expand Down

6 changes: 3 additions & 3 deletions
lightning-persister/src/lib.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -138,7 +138,7 @@ mod tests {
	use bitcoin::blockdata::block::{Block, BlockHeader};
	use bitcoin::hashes::hex::FromHex;
	use bitcoin::{Txid, TxMerkleNode};
	use lightning::chain::ChannelMonitorUpdateErr;
	use lightning::chain::ChannelMonitorUpdateStatus;
	use lightning::chain::chainmonitor::Persist;
	use lightning::chain::transaction::OutPoint;
	use lightning::{check_closed_broadcast, check_closed_event, check_added_monitors};
Expand DownExpand Up@@ -270,7 +270,7 @@ mod tests {
 index: 0
 };
 match persister.persist_new_channel(test_txo, &added_monitors[0].1, update_id.2) {
Err(ChannelMonitorUpdateErr::PermanentFailure) => {},
ChannelMonitorUpdateStatus::PermanentFailure => {},
 _ => panic!("unexpected result from persisting new channel")
 }

Expand DownExpand Up@@ -307,7 +307,7 @@ mod tests {
 index: 0
 };
 match persister.persist_new_channel(test_txo, &added_monitors[0].1, update_id.2) {
Err(ChannelMonitorUpdateErr::PermanentFailure) => {},
ChannelMonitorUpdateStatus::PermanentFailure => {},
 _ => panic!("unexpected result from persisting new channel")
 }

Expand Down
Loading

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

TheBlueMatt
merged 7 commits into

from

Sep 29, 2022
 Merged


Do not broadcast commitment txn on Permanent mon update failure
#1106
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


7 commits


Select commit
Hold shift + click to select a range
313810e

Do not broadcast commitment txn on Permanent mon update failure


TheBlueMatt Oct 5, 2021
12fa0b1

Rework `chain::Watch` return types to make async updates less scary


TheBlueMatt Jul 18, 2022
72416b9

Add a TODO for an important issue for making async mon updates safe


TheBlueMatt Aug 16, 2022
721a858

Rename `Channel::monitor_update_failed` to `monitor_updating_paused`


TheBlueMatt Aug 16, 2022
fb0a481

Rename `handle_monitor_err!()` `handle_monitor_update_res!`


TheBlueMatt Aug 16, 2022
f961dae

Rename APIError::MonitorUpdateFailed to MonitorUpdateInProgress


TheBlueMatt Sep 29, 2022
52934e0

Clarify ambiguous comment in persist methods


TheBlueMatt Aug 24, 2022

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


37 changes: 21 additions & 16 deletions
fuzz/src/chanmon_consistency.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -32,7 +32,7 @@ use bitcoin::hashes::sha256::Hash as Sha256;
use bitcoin::hash_types::{BlockHash, WPubkeyHash};

use lightning::chain;
use lightning::chain::{BestBlock, ChannelMonitorUpdateErr, chainmonitor, channelmonitor, Confirm, Watch};
use lightning::chain::{BestBlock, ChannelMonitorUpdateStatus, chainmonitor, channelmonitor, Confirm, Watch};
use lightning::chain::channelmonitor::{ChannelMonitor, MonitorEvent};
use lightning::chain::transaction::OutPoint;
use lightning::chain::chaininterface::{BroadcasterInterface, ConfirmationTarget, FeeEstimator};
Expand DownExpand Up@@ -124,7 +124,7 @@ impl TestChainMonitor {
	}
}
impl chain::Watch<EnforcingSigner> for TestChainMonitor {
	fn watch_channel(&self, funding_txo: OutPoint, monitor: channelmonitor::ChannelMonitor<EnforcingSigner>) -> Result<(), chain::ChannelMonitorUpdateErr> {
	fn watch_channel(&self, funding_txo: OutPoint, monitor: channelmonitor::ChannelMonitor<EnforcingSigner>) -> chain::ChannelMonitorUpdateStatus {
 let mut ser = VecWriter(Vec::new());
 monitor.write(&mut ser).unwrap();
 if let Some(_) = self.latest_monitors.lock().unwrap().insert(funding_txo, (monitor.get_latest_update_id(), ser.0)) {
Expand All@@ -134,7 +134,7 @@ impl chain::Watch<EnforcingSigner> for TestChainMonitor {
 self.chain_monitor.watch_channel(funding_txo, monitor)
	}

	fn update_channel(&self, funding_txo: OutPoint, update: channelmonitor::ChannelMonitorUpdate) -> Result<(), chain::ChannelMonitorUpdateErr> {
	fn update_channel(&self, funding_txo: OutPoint, update: channelmonitor::ChannelMonitorUpdate) -> chain::ChannelMonitorUpdateStatus {
 let mut map_lock = self.latest_monitors.lock().unwrap();
 let mut map_entry = match map_lock.entry(funding_txo) {
 hash_map::Entry::Occupied(entry) => entry,
Expand DownExpand Up@@ -270,7 +270,7 @@ fn check_api_err(api_err: APIError) {
 _ => panic!("{}", err),
 }
 },
 APIError::MonitorUpdateFailed => {
 APIError::MonitorUpdateInProgress => {
 // We can (obviously) temp-fail a monitor update
 },
 APIError::IncompatibleShutdownScript { .. } => panic!("Cannot send an incompatible shutdown script"),
Expand DownExpand Up@@ -363,7 +363,9 @@ pub fn do_test<Out: Output>(data: &[u8], underlying_out: Out) {
 let logger: Arc<dyn Logger> = Arc::new(test_logger::TestLogger::new($node_id.to_string(), out.clone()));
 let keys_manager = Arc::new(KeyProvider { node_id: $node_id, rand_bytes_id: atomic::AtomicU32::new(0), enforcement_states: Mutex::new(HashMap::new()) });
 let monitor = Arc::new(TestChainMonitor::new(broadcast.clone(), logger.clone(), $fee_estimator.clone(),
 Arc::new(TestPersister { update_ret: Mutex::new(Ok(())) }), Arc::clone(&keys_manager)));
 Arc::new(TestPersister {
 update_ret: Mutex::new(ChannelMonitorUpdateStatus::Completed)
 }), Arc::clone(&keys_manager)));

 let mut config = UserConfig::default();
 config.channel_config.forwarding_fee_proportional_millionths = 0;
Expand All@@ -383,7 +385,9 @@ pub fn do_test<Out: Output>(data: &[u8], underlying_out: Out) {
 let keys_manager = Arc::clone(& $keys_manager);
 let logger: Arc<dyn Logger> = Arc::new(test_logger::TestLogger::new($node_id.to_string(), out.clone()));
 let chain_monitor = Arc::new(TestChainMonitor::new(broadcast.clone(), logger.clone(), $fee_estimator.clone(),
 Arc::new(TestPersister { update_ret: Mutex::new(Ok(())) }), Arc::clone(& $keys_manager)));
 Arc::new(TestPersister {
 update_ret: Mutex::new(ChannelMonitorUpdateStatus::Completed)
 }), Arc::clone(& $keys_manager)));

 let mut config = UserConfig::default();
 config.channel_config.forwarding_fee_proportional_millionths = 0;
Expand DownExpand Up@@ -412,7 +416,8 @@ pub fn do_test<Out: Output>(data: &[u8], underlying_out: Out) {

 let res = (<(BlockHash, ChanMan)>::read(&mut Cursor::new(&$ser.0), read_args).expect("Failed to read manager").1, chain_monitor.clone());
 for (funding_txo, mon) in monitors.drain() {
 assert!(chain_monitor.chain_monitor.watch_channel(funding_txo, mon).is_ok());
 assert_eq!(chain_monitor.chain_monitor.watch_channel(funding_txo, mon),
 ChannelMonitorUpdateStatus::Completed);
 }
 res
 } }
Expand DownExpand Up@@ -889,12 +894,12 @@ pub fn do_test<Out: Output>(data: &[u8], underlying_out: Out) {
 // bit-twiddling mutations to have similar effects. This is probably overkill, but no
 // harm in doing so.

 0x00 => *monitor_a.persister.update_ret.lock().unwrap() = Err(ChannelMonitorUpdateErr::TemporaryFailure),
 0x01 => *monitor_b.persister.update_ret.lock().unwrap() = Err(ChannelMonitorUpdateErr::TemporaryFailure),
 0x02 => *monitor_c.persister.update_ret.lock().unwrap() = Err(ChannelMonitorUpdateErr::TemporaryFailure),
 0x04 => *monitor_a.persister.update_ret.lock().unwrap() = Ok(()),
 0x05 => *monitor_b.persister.update_ret.lock().unwrap() = Ok(()),
 0x06 => *monitor_c.persister.update_ret.lock().unwrap() = Ok(()),
 0x00 => *monitor_a.persister.update_ret.lock().unwrap() = ChannelMonitorUpdateStatus::InProgress,
 0x01 => *monitor_b.persister.update_ret.lock().unwrap() = ChannelMonitorUpdateStatus::InProgress,
 0x02 => *monitor_c.persister.update_ret.lock().unwrap() = ChannelMonitorUpdateStatus::InProgress,
 0x04 => *monitor_a.persister.update_ret.lock().unwrap() = ChannelMonitorUpdateStatus::Completed,
 0x05 => *monitor_b.persister.update_ret.lock().unwrap() = ChannelMonitorUpdateStatus::Completed,
 0x06 => *monitor_c.persister.update_ret.lock().unwrap() = ChannelMonitorUpdateStatus::Completed,

 0x08 => {
 if let Some((id, _)) = monitor_a.latest_monitors.lock().unwrap().get(&chan_1_funding) {
Expand DownExpand Up@@ -1119,9 +1124,9 @@ pub fn do_test<Out: Output>(data: &[u8], underlying_out: Out) {
 // after we resolve all pending events.
 // First make sure there are no pending monitor updates, resetting the error state
 // and calling force_channel_monitor_updated for each monitor.
 *monitor_a.persister.update_ret.lock().unwrap() = Ok(());
 *monitor_b.persister.update_ret.lock().unwrap() = Ok(());
 *monitor_c.persister.update_ret.lock().unwrap() = Ok(());
 *monitor_a.persister.update_ret.lock().unwrap() = ChannelMonitorUpdateStatus::Completed;
 *monitor_b.persister.update_ret.lock().unwrap() = ChannelMonitorUpdateStatus::Completed;
 *monitor_c.persister.update_ret.lock().unwrap() = ChannelMonitorUpdateStatus::Completed;

 if let Some((id, _)) = monitor_a.latest_monitors.lock().unwrap().get(&chan_1_funding) {
 monitor_a.chain_monitor.force_channel_monitor_updated(chan_1_funding, *id);
Expand Down

4 changes: 2 additions & 2 deletions
fuzz/src/full_stack.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -29,7 +29,7 @@ use bitcoin::hashes::sha256::Hash as Sha256;
use bitcoin::hash_types::{Txid, BlockHash, WPubkeyHash};

use lightning::chain;
use lightning::chain::{BestBlock, Confirm, Listen};
use lightning::chain::{BestBlock, ChannelMonitorUpdateStatus, Confirm, Listen};
use lightning::chain::chaininterface::{BroadcasterInterface, ConfirmationTarget, FeeEstimator};
use lightning::chain::chainmonitor;
use lightning::chain::transaction::OutPoint;
Expand DownExpand Up@@ -389,7 +389,7 @@ pub fn do_test(data: &[u8], logger: &Arc<dyn Logger>) {

	let broadcast = Arc::new(TestBroadcaster{ txn_broadcasted: Mutex::new(Vec::new()) });
	let monitor = Arc::new(chainmonitor::ChainMonitor::new(None, broadcast.clone(), Arc::clone(&logger), fee_est.clone(),
 Arc::new(TestPersister { update_ret: Mutex::new(Ok(())) })));
 Arc::new(TestPersister { update_ret: Mutex::new(ChannelMonitorUpdateStatus::Completed) })));

	let keys_manager = Arc::new(KeyProvider { node_secret: our_network_key.clone(), inbound_payment_key: KeyMaterial(inbound_payment_key.try_into().unwrap()), counter: AtomicU64::new(0) });
	let mut config = UserConfig::default();
Expand Down

6 changes: 3 additions & 3 deletions
fuzz/src/utils/test_persister.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -7,14 +7,14 @@ use lightning::util::enforcing_trait_impls::EnforcingSigner;
use std::sync::Mutex;

pub struct TestPersister {
	pub update_ret: Mutex<Result<(), chain::ChannelMonitorUpdateErr>>,
	pub update_ret: Mutex<chain::ChannelMonitorUpdateStatus>,
}
impl chainmonitor::Persist<EnforcingSigner> for TestPersister {
	fn persist_new_channel(&self, _funding_txo: OutPoint, _data: &channelmonitor::ChannelMonitor<EnforcingSigner>, _update_id: MonitorUpdateId) -> Result<(), chain::ChannelMonitorUpdateErr> {
	fn persist_new_channel(&self, _funding_txo: OutPoint, _data: &channelmonitor::ChannelMonitor<EnforcingSigner>, _update_id: MonitorUpdateId) -> chain::ChannelMonitorUpdateStatus {
 self.update_ret.lock().unwrap().clone()
	}

	fn update_persisted_channel(&self, _funding_txo: OutPoint, _update: &Option<channelmonitor::ChannelMonitorUpdate>, _data: &channelmonitor::ChannelMonitor<EnforcingSigner>, _update_id: MonitorUpdateId) -> Result<(), chain::ChannelMonitorUpdateErr> {
	fn update_persisted_channel(&self, _funding_txo: OutPoint, _update: &Option<channelmonitor::ChannelMonitorUpdate>, _data: &channelmonitor::ChannelMonitor<EnforcingSigner>, _update_id: MonitorUpdateId) -> chain::ChannelMonitorUpdateStatus {
 self.update_ret.lock().unwrap().clone()
	}
}

18 changes: 9 additions & 9 deletions
lightning-invoice/src/payment.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -513,11 +513,11 @@ where
 },
 PaymentSendFailure::PartialFailure { failed_paths_retry, payment_id, results } => {
 // If a `PartialFailure` event returns a result that is an `Ok()`, it means that
 // part of our payment is retried. When we receive `MonitorUpdateFailed`, it
 // part of our payment is retried. When we receive `MonitorUpdateInProgress`, it
 // means that we are still waiting for our channel monitor update to be completed.
 for (result, path) in results.iter().zip(route.paths.into_iter()) {
 match result {
 Ok(_) | Err(APIError::MonitorUpdateFailed) => {
 Ok(_) | Err(APIError::MonitorUpdateInProgress) => {
 self.process_path_inflight_htlcs(payment_hash, path);
 },
 _ => {},
Expand DownExpand Up@@ -617,11 +617,11 @@ where
 },
 Err(PaymentSendFailure::PartialFailure { failed_paths_retry, results, .. }) => {
 // If a `PartialFailure` error contains a result that is an `Ok()`, it means that
 // part of our payment is retried. When we receive `MonitorUpdateFailed`, it
 // part of our payment is retried. When we receive `MonitorUpdateInProgress`, it
 // means that we are still waiting for our channel monitor update to complete.
 for (result, path) in results.iter().zip(route.unwrap().paths.into_iter()) {
 match result {
 Ok(_) | Err(APIError::MonitorUpdateFailed) => {
 Ok(_) | Err(APIError::MonitorUpdateInProgress) => {
 self.process_path_inflight_htlcs(payment_hash, path);
 },
 _ => {},
Expand DownExpand Up@@ -796,7 +796,7 @@ mod tests {
	use std::time::{SystemTime, Duration};
	use time_utils::tests::SinceEpoch;
	use DEFAULT_EXPIRY_TIME;
	use lightning::util::errors::APIError::{ChannelUnavailable, MonitorUpdateFailed};
	use lightning::util::errors::APIError::{ChannelUnavailable, MonitorUpdateInProgress};

	fn invoice(payment_preimage: PaymentPreimage) -> Invoice {
 let payment_hash = Sha256::hash(&payment_preimage.0);
Expand DownExpand Up@@ -1718,7 +1718,7 @@ mod tests {
 .fails_with_partial_failure(
 retry.clone(), OnAttempt(1),
 Some(vec![
 Err(ChannelUnavailable { err: "abc".to_string() }), Err(MonitorUpdateFailed)
 Err(ChannelUnavailable { err: "abc".to_string() }), Err(MonitorUpdateInProgress)
 ]))
 .expect_send(Amount::ForInvoice(final_value_msat));

Expand All@@ -1731,7 +1731,7 @@ mod tests {
 invoice_payer.pay_invoice(&invoice_to_pay).unwrap();
 let inflight_map = invoice_payer.create_inflight_map();

 // Only the second path, which failed with `MonitorUpdateFailed` should be added to our
 // Only the second path, which failed with `MonitorUpdateInProgress` should be added to our
 // inflight map because retries are disabled.
 assert_eq!(inflight_map.len(), 2);
	}
Expand All@@ -1750,7 +1750,7 @@ mod tests {
 .fails_with_partial_failure(
 retry.clone(), OnAttempt(1),
 Some(vec![
 Ok(()), Err(MonitorUpdateFailed)
 Ok(()), Err(MonitorUpdateInProgress)
 ]))
 .expect_send(Amount::ForInvoice(final_value_msat));

Expand DownExpand Up@@ -2044,7 +2044,7 @@ mod tests {
 }

 fn fails_on_attempt(self, attempt: usize) -> Self {
 let failure = PaymentSendFailure::ParameterError(APIError::MonitorUpdateFailed);
 let failure = PaymentSendFailure::ParameterError(APIError::MonitorUpdateInProgress);
 self.fails_with(failure, OnAttempt(attempt))
 }

Expand Down

6 changes: 3 additions & 3 deletions
lightning-persister/src/lib.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -138,7 +138,7 @@ mod tests {
	use bitcoin::blockdata::block::{Block, BlockHeader};
	use bitcoin::hashes::hex::FromHex;
	use bitcoin::{Txid, TxMerkleNode};
	use lightning::chain::ChannelMonitorUpdateErr;
	use lightning::chain::ChannelMonitorUpdateStatus;
	use lightning::chain::chainmonitor::Persist;
	use lightning::chain::transaction::OutPoint;
	use lightning::{check_closed_broadcast, check_closed_event, check_added_monitors};
Expand DownExpand Up@@ -270,7 +270,7 @@ mod tests {
 index: 0
 };
 match persister.persist_new_channel(test_txo, &added_monitors[0].1, update_id.2) {
Err(ChannelMonitorUpdateErr::PermanentFailure) => {},
ChannelMonitorUpdateStatus::PermanentFailure => {},
 _ => panic!("unexpected result from persisting new channel")
 }

Expand DownExpand Up@@ -307,7 +307,7 @@ mod tests {
 index: 0
 };
 match persister.persist_new_channel(test_txo, &added_monitors[0].1, update_id.2) {
Err(ChannelMonitorUpdateErr::PermanentFailure) => {},
ChannelMonitorUpdateStatus::PermanentFailure => {},
 _ => panic!("unexpected result from persisting new channel")
 }

Expand Down
Loading

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

TheBlueMatt
merged 7 commits into

from

Sep 29, 2022
 Merged


Do not broadcast commitment txn on Permanent mon update failure
#1106
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


7 commits


Select commit
Hold shift + click to select a range
313810e

Do not broadcast commitment txn on Permanent mon update failure


TheBlueMatt Oct 5, 2021
12fa0b1

Rework `chain::Watch` return types to make async updates less scary


TheBlueMatt Jul 18, 2022
72416b9

Add a TODO for an important issue for making async mon updates safe


TheBlueMatt Aug 16, 2022
721a858

Rename `Channel::monitor_update_failed` to `monitor_updating_paused`


TheBlueMatt Aug 16, 2022
fb0a481

Rename `handle_monitor_err!()` `handle_monitor_update_res!`


TheBlueMatt Aug 16, 2022
f961dae

Rename APIError::MonitorUpdateFailed to MonitorUpdateInProgress


TheBlueMatt Sep 29, 2022
52934e0

Clarify ambiguous comment in persist methods


TheBlueMatt Aug 24, 2022

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


37 changes: 21 additions & 16 deletions
fuzz/src/chanmon_consistency.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -32,7 +32,7 @@ use bitcoin::hashes::sha256::Hash as Sha256;
use bitcoin::hash_types::{BlockHash, WPubkeyHash};

use lightning::chain;
use lightning::chain::{BestBlock, ChannelMonitorUpdateErr, chainmonitor, channelmonitor, Confirm, Watch};
use lightning::chain::{BestBlock, ChannelMonitorUpdateStatus, chainmonitor, channelmonitor, Confirm, Watch};
use lightning::chain::channelmonitor::{ChannelMonitor, MonitorEvent};
use lightning::chain::transaction::OutPoint;
use lightning::chain::chaininterface::{BroadcasterInterface, ConfirmationTarget, FeeEstimator};
Expand DownExpand Up@@ -124,7 +124,7 @@ impl TestChainMonitor {
	}
}
impl chain::Watch<EnforcingSigner> for TestChainMonitor {
	fn watch_channel(&self, funding_txo: OutPoint, monitor: channelmonitor::ChannelMonitor<EnforcingSigner>) -> Result<(), chain::ChannelMonitorUpdateErr> {
	fn watch_channel(&self, funding_txo: OutPoint, monitor: channelmonitor::ChannelMonitor<EnforcingSigner>) -> chain::ChannelMonitorUpdateStatus {
 let mut ser = VecWriter(Vec::new());
 monitor.write(&mut ser).unwrap();
 if let Some(_) = self.latest_monitors.lock().unwrap().insert(funding_txo, (monitor.get_latest_update_id(), ser.0)) {
Expand All@@ -134,7 +134,7 @@ impl chain::Watch<EnforcingSigner> for TestChainMonitor {
 self.chain_monitor.watch_channel(funding_txo, monitor)
	}

	fn update_channel(&self, funding_txo: OutPoint, update: channelmonitor::ChannelMonitorUpdate) -> Result<(), chain::ChannelMonitorUpdateErr> {
	fn update_channel(&self, funding_txo: OutPoint, update: channelmonitor::ChannelMonitorUpdate) -> chain::ChannelMonitorUpdateStatus {
 let mut map_lock = self.latest_monitors.lock().unwrap();
 let mut map_entry = match map_lock.entry(funding_txo) {
 hash_map::Entry::Occupied(entry) => entry,
Expand DownExpand Up@@ -270,7 +270,7 @@ fn check_api_err(api_err: APIError) {
 _ => panic!("{}", err),
 }
 },
 APIError::MonitorUpdateFailed => {
 APIError::MonitorUpdateInProgress => {
 // We can (obviously) temp-fail a monitor update
 },
 APIError::IncompatibleShutdownScript { .. } => panic!("Cannot send an incompatible shutdown script"),
Expand DownExpand Up@@ -363,7 +363,9 @@ pub fn do_test<Out: Output>(data: &[u8], underlying_out: Out) {
 let logger: Arc<dyn Logger> = Arc::new(test_logger::TestLogger::new($node_id.to_string(), out.clone()));
 let keys_manager = Arc::new(KeyProvider { node_id: $node_id, rand_bytes_id: atomic::AtomicU32::new(0), enforcement_states: Mutex::new(HashMap::new()) });
 let monitor = Arc::new(TestChainMonitor::new(broadcast.clone(), logger.clone(), $fee_estimator.clone(),
 Arc::new(TestPersister { update_ret: Mutex::new(Ok(())) }), Arc::clone(&keys_manager)));
 Arc::new(TestPersister {
 update_ret: Mutex::new(ChannelMonitorUpdateStatus::Completed)
 }), Arc::clone(&keys_manager)));

 let mut config = UserConfig::default();
 config.channel_config.forwarding_fee_proportional_millionths = 0;
Expand All@@ -383,7 +385,9 @@ pub fn do_test<Out: Output>(data: &[u8], underlying_out: Out) {
 let keys_manager = Arc::clone(& $keys_manager);
 let logger: Arc<dyn Logger> = Arc::new(test_logger::TestLogger::new($node_id.to_string(), out.clone()));
 let chain_monitor = Arc::new(TestChainMonitor::new(broadcast.clone(), logger.clone(), $fee_estimator.clone(),
 Arc::new(TestPersister { update_ret: Mutex::new(Ok(())) }), Arc::clone(& $keys_manager)));
 Arc::new(TestPersister {
 update_ret: Mutex::new(ChannelMonitorUpdateStatus::Completed)
 }), Arc::clone(& $keys_manager)));

 let mut config = UserConfig::default();
 config.channel_config.forwarding_fee_proportional_millionths = 0;
Expand DownExpand Up@@ -412,7 +416,8 @@ pub fn do_test<Out: Output>(data: &[u8], underlying_out: Out) {

 let res = (<(BlockHash, ChanMan)>::read(&mut Cursor::new(&$ser.0), read_args).expect("Failed to read manager").1, chain_monitor.clone());
 for (funding_txo, mon) in monitors.drain() {
 assert!(chain_monitor.chain_monitor.watch_channel(funding_txo, mon).is_ok());
 assert_eq!(chain_monitor.chain_monitor.watch_channel(funding_txo, mon),
 ChannelMonitorUpdateStatus::Completed);
 }
 res
 } }
Expand DownExpand Up@@ -889,12 +894,12 @@ pub fn do_test<Out: Output>(data: &[u8], underlying_out: Out) {
 // bit-twiddling mutations to have similar effects. This is probably overkill, but no
 // harm in doing so.

 0x00 => *monitor_a.persister.update_ret.lock().unwrap() = Err(ChannelMonitorUpdateErr::TemporaryFailure),
 0x01 => *monitor_b.persister.update_ret.lock().unwrap() = Err(ChannelMonitorUpdateErr::TemporaryFailure),
 0x02 => *monitor_c.persister.update_ret.lock().unwrap() = Err(ChannelMonitorUpdateErr::TemporaryFailure),
 0x04 => *monitor_a.persister.update_ret.lock().unwrap() = Ok(()),
 0x05 => *monitor_b.persister.update_ret.lock().unwrap() = Ok(()),
 0x06 => *monitor_c.persister.update_ret.lock().unwrap() = Ok(()),
 0x00 => *monitor_a.persister.update_ret.lock().unwrap() = ChannelMonitorUpdateStatus::InProgress,
 0x01 => *monitor_b.persister.update_ret.lock().unwrap() = ChannelMonitorUpdateStatus::InProgress,
 0x02 => *monitor_c.persister.update_ret.lock().unwrap() = ChannelMonitorUpdateStatus::InProgress,
 0x04 => *monitor_a.persister.update_ret.lock().unwrap() = ChannelMonitorUpdateStatus::Completed,
 0x05 => *monitor_b.persister.update_ret.lock().unwrap() = ChannelMonitorUpdateStatus::Completed,
 0x06 => *monitor_c.persister.update_ret.lock().unwrap() = ChannelMonitorUpdateStatus::Completed,

 0x08 => {
 if let Some((id, _)) = monitor_a.latest_monitors.lock().unwrap().get(&chan_1_funding) {
Expand DownExpand Up@@ -1119,9 +1124,9 @@ pub fn do_test<Out: Output>(data: &[u8], underlying_out: Out) {
 // after we resolve all pending events.
 // First make sure there are no pending monitor updates, resetting the error state
 // and calling force_channel_monitor_updated for each monitor.
 *monitor_a.persister.update_ret.lock().unwrap() = Ok(());
 *monitor_b.persister.update_ret.lock().unwrap() = Ok(());
 *monitor_c.persister.update_ret.lock().unwrap() = Ok(());
 *monitor_a.persister.update_ret.lock().unwrap() = ChannelMonitorUpdateStatus::Completed;
 *monitor_b.persister.update_ret.lock().unwrap() = ChannelMonitorUpdateStatus::Completed;
 *monitor_c.persister.update_ret.lock().unwrap() = ChannelMonitorUpdateStatus::Completed;

 if let Some((id, _)) = monitor_a.latest_monitors.lock().unwrap().get(&chan_1_funding) {
 monitor_a.chain_monitor.force_channel_monitor_updated(chan_1_funding, *id);
Expand Down

4 changes: 2 additions & 2 deletions
fuzz/src/full_stack.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -29,7 +29,7 @@ use bitcoin::hashes::sha256::Hash as Sha256;
use bitcoin::hash_types::{Txid, BlockHash, WPubkeyHash};

use lightning::chain;
use lightning::chain::{BestBlock, Confirm, Listen};
use lightning::chain::{BestBlock, ChannelMonitorUpdateStatus, Confirm, Listen};
use lightning::chain::chaininterface::{BroadcasterInterface, ConfirmationTarget, FeeEstimator};
use lightning::chain::chainmonitor;
use lightning::chain::transaction::OutPoint;
Expand DownExpand Up@@ -389,7 +389,7 @@ pub fn do_test(data: &[u8], logger: &Arc<dyn Logger>) {

	let broadcast = Arc::new(TestBroadcaster{ txn_broadcasted: Mutex::new(Vec::new()) });
	let monitor = Arc::new(chainmonitor::ChainMonitor::new(None, broadcast.clone(), Arc::clone(&logger), fee_est.clone(),
 Arc::new(TestPersister { update_ret: Mutex::new(Ok(())) })));
 Arc::new(TestPersister { update_ret: Mutex::new(ChannelMonitorUpdateStatus::Completed) })));

	let keys_manager = Arc::new(KeyProvider { node_secret: our_network_key.clone(), inbound_payment_key: KeyMaterial(inbound_payment_key.try_into().unwrap()), counter: AtomicU64::new(0) });
	let mut config = UserConfig::default();
Expand Down

6 changes: 3 additions & 3 deletions
fuzz/src/utils/test_persister.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -7,14 +7,14 @@ use lightning::util::enforcing_trait_impls::EnforcingSigner;
use std::sync::Mutex;

pub struct TestPersister {
	pub update_ret: Mutex<Result<(), chain::ChannelMonitorUpdateErr>>,
	pub update_ret: Mutex<chain::ChannelMonitorUpdateStatus>,
}
impl chainmonitor::Persist<EnforcingSigner> for TestPersister {
	fn persist_new_channel(&self, _funding_txo: OutPoint, _data: &channelmonitor::ChannelMonitor<EnforcingSigner>, _update_id: MonitorUpdateId) -> Result<(), chain::ChannelMonitorUpdateErr> {
	fn persist_new_channel(&self, _funding_txo: OutPoint, _data: &channelmonitor::ChannelMonitor<EnforcingSigner>, _update_id: MonitorUpdateId) -> chain::ChannelMonitorUpdateStatus {
 self.update_ret.lock().unwrap().clone()
	}

	fn update_persisted_channel(&self, _funding_txo: OutPoint, _update: &Option<channelmonitor::ChannelMonitorUpdate>, _data: &channelmonitor::ChannelMonitor<EnforcingSigner>, _update_id: MonitorUpdateId) -> Result<(), chain::ChannelMonitorUpdateErr> {
	fn update_persisted_channel(&self, _funding_txo: OutPoint, _update: &Option<channelmonitor::ChannelMonitorUpdate>, _data: &channelmonitor::ChannelMonitor<EnforcingSigner>, _update_id: MonitorUpdateId) -> chain::ChannelMonitorUpdateStatus {
 self.update_ret.lock().unwrap().clone()
	}
}

18 changes: 9 additions & 9 deletions
lightning-invoice/src/payment.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -513,11 +513,11 @@ where
 },
 PaymentSendFailure::PartialFailure { failed_paths_retry, payment_id, results } => {
 // If a `PartialFailure` event returns a result that is an `Ok()`, it means that
 // part of our payment is retried. When we receive `MonitorUpdateFailed`, it
 // part of our payment is retried. When we receive `MonitorUpdateInProgress`, it
 // means that we are still waiting for our channel monitor update to be completed.
 for (result, path) in results.iter().zip(route.paths.into_iter()) {
 match result {
 Ok(_) | Err(APIError::MonitorUpdateFailed) => {
 Ok(_) | Err(APIError::MonitorUpdateInProgress) => {
 self.process_path_inflight_htlcs(payment_hash, path);
 },
 _ => {},
Expand DownExpand Up@@ -617,11 +617,11 @@ where
 },
 Err(PaymentSendFailure::PartialFailure { failed_paths_retry, results, .. }) => {
 // If a `PartialFailure` error contains a result that is an `Ok()`, it means that
 // part of our payment is retried. When we receive `MonitorUpdateFailed`, it
 // part of our payment is retried. When we receive `MonitorUpdateInProgress`, it
 // means that we are still waiting for our channel monitor update to complete.
 for (result, path) in results.iter().zip(route.unwrap().paths.into_iter()) {
 match result {
 Ok(_) | Err(APIError::MonitorUpdateFailed) => {
 Ok(_) | Err(APIError::MonitorUpdateInProgress) => {
 self.process_path_inflight_htlcs(payment_hash, path);
 },
 _ => {},
Expand DownExpand Up@@ -796,7 +796,7 @@ mod tests {
	use std::time::{SystemTime, Duration};
	use time_utils::tests::SinceEpoch;
	use DEFAULT_EXPIRY_TIME;
	use lightning::util::errors::APIError::{ChannelUnavailable, MonitorUpdateFailed};
	use lightning::util::errors::APIError::{ChannelUnavailable, MonitorUpdateInProgress};

	fn invoice(payment_preimage: PaymentPreimage) -> Invoice {
 let payment_hash = Sha256::hash(&payment_preimage.0);
Expand DownExpand Up@@ -1718,7 +1718,7 @@ mod tests {
 .fails_with_partial_failure(
 retry.clone(), OnAttempt(1),
 Some(vec![
 Err(ChannelUnavailable { err: "abc".to_string() }), Err(MonitorUpdateFailed)
 Err(ChannelUnavailable { err: "abc".to_string() }), Err(MonitorUpdateInProgress)
 ]))
 .expect_send(Amount::ForInvoice(final_value_msat));

Expand All@@ -1731,7 +1731,7 @@ mod tests {
 invoice_payer.pay_invoice(&invoice_to_pay).unwrap();
 let inflight_map = invoice_payer.create_inflight_map();

 // Only the second path, which failed with `MonitorUpdateFailed` should be added to our
 // Only the second path, which failed with `MonitorUpdateInProgress` should be added to our
 // inflight map because retries are disabled.
 assert_eq!(inflight_map.len(), 2);
	}
Expand All@@ -1750,7 +1750,7 @@ mod tests {
 .fails_with_partial_failure(
 retry.clone(), OnAttempt(1),
 Some(vec![
 Ok(()), Err(MonitorUpdateFailed)
 Ok(()), Err(MonitorUpdateInProgress)
 ]))
 .expect_send(Amount::ForInvoice(final_value_msat));

Expand DownExpand Up@@ -2044,7 +2044,7 @@ mod tests {
 }

 fn fails_on_attempt(self, attempt: usize) -> Self {
 let failure = PaymentSendFailure::ParameterError(APIError::MonitorUpdateFailed);
 let failure = PaymentSendFailure::ParameterError(APIError::MonitorUpdateInProgress);
 self.fails_with(failure, OnAttempt(attempt))
 }

Expand Down

6 changes: 3 additions & 3 deletions
lightning-persister/src/lib.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -138,7 +138,7 @@ mod tests {
	use bitcoin::blockdata::block::{Block, BlockHeader};
	use bitcoin::hashes::hex::FromHex;
	use bitcoin::{Txid, TxMerkleNode};
	use lightning::chain::ChannelMonitorUpdateErr;
	use lightning::chain::ChannelMonitorUpdateStatus;
	use lightning::chain::chainmonitor::Persist;
	use lightning::chain::transaction::OutPoint;
	use lightning::{check_closed_broadcast, check_closed_event, check_added_monitors};
Expand DownExpand Up@@ -270,7 +270,7 @@ mod tests {
 index: 0
 };
 match persister.persist_new_channel(test_txo, &added_monitors[0].1, update_id.2) {
Err(ChannelMonitorUpdateErr::PermanentFailure) => {},
ChannelMonitorUpdateStatus::PermanentFailure => {},
 _ => panic!("unexpected result from persisting new channel")
 }

Expand DownExpand Up@@ -307,7 +307,7 @@ mod tests {
 index: 0
 };
 match persister.persist_new_channel(test_txo, &added_monitors[0].1, update_id.2) {
Err(ChannelMonitorUpdateErr::PermanentFailure) => {},
ChannelMonitorUpdateStatus::PermanentFailure => {},
 _ => panic!("unexpected result from persisting new channel")
 }

Expand Down
Loading