Flatten ChannelMonitor substructs that don't add clarity#558

New issue

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

Sign up for GitHub

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

Already on GitHub? Sign in to your account

Merged
TheBlueMatt merged 2 commits into from
Apr 19, 2020
Merged

Flatten ChannelMonitor substructs that don't add clarity #558

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3c5ba6b
Drop uneccessary clone() introduced in 16fba9fd664522ac8d24111547b4
TheBlueMatt Mar 21, 2020
b49e63b
Flatten ChannelMonitor substructs that don't add clarity
TheBlueMatt Mar 21, 2020
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
136 changes: 61 additions & 75 deletions lightning/src/ln/channelmonitor.rs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -290,7 +290,7 @@ impl<Key : Send + cmp::Eq + hash::Hash + 'static, ChanSigner: ChannelKeys, T: De
hash_map::Entry::Occupied(_) => return Err(MonitorUpdateError("Channel monitor for given key is already present")),
hash_map::Entry::Vacant(e) => e,
};
match monitor.onchain_detection.funding_info {
match monitor.funding_info {
None => {
return Err(MonitorUpdateError("Try to update a useless monitor without funding_txo !"));
},
Expand All@@ -314,7 +314,7 @@ impl<Key : Send + cmp::Eq + hash::Hash + 'static, ChanSigner: ChannelKeys, T: De
let mut monitors = self.monitors.lock().unwrap();
match monitors.get_mut(&key) {
Some(orig_monitor) => {
log_trace!(self, "Updating Channel Monitor for channel {}", log_funding_info!(orig_monitor.onchain_detection));
log_trace!(self, "Updating Channel Monitor for channel {}", log_funding_info!(orig_monitor));
orig_monitor.update_monitor(update, &self.broadcaster)
},
None => Err(MonitorUpdateError("No such monitor registered"))
Expand DownExpand Up@@ -391,20 +391,6 @@ pub(crate) const LATENCY_GRACE_PERIOD_BLOCKS: u32 = 3;
/// keeping bumping another claim tx to solve the outpoint.
pub(crate) const ANTI_REORG_DELAY: u32 = 6;

struct OnchainDetection<ChanSigner: ChannelKeys> {
keys: ChanSigner,
funding_info: Option<(OutPoint, Script)>,
current_remote_commitment_txid: Option<Sha256dHash>,
prev_remote_commitment_txid: Option<Sha256dHash>,
}

#[cfg(any(test, feature = "fuzztarget"))]
impl<ChanSigner: ChannelKeys> PartialEq for OnchainDetection<ChanSigner> {
fn eq(&self, other: &Self) -> bool {
self.keys.pubkeys() == other.keys.pubkeys()
}
}

#[derive(Clone, PartialEq)]
struct LocalSignedTx {
/// txid of the transaction in tx, just used to make comparison faster
Expand DownExpand Up@@ -734,7 +720,11 @@ pub struct ChannelMonitor<ChanSigner: ChannelKeys> {
broadcasted_remote_payment_script: Option<(Script, SecretKey)>,
shutdown_script: Script,

onchain_detection: OnchainDetection<ChanSigner>,
keys: ChanSigner,
funding_info: Option<(OutPoint, Script)>,
current_remote_commitment_txid: Option<Sha256dHash>,
prev_remote_commitment_txid: Option<Sha256dHash>,

their_htlc_base_key: Option<PublicKey>,
their_delayed_payment_base_key: Option<PublicKey>,
funding_redeemscript: Option<Script>,
Expand DownExpand Up@@ -817,7 +807,10 @@ impl<ChanSigner: ChannelKeys> PartialEq for ChannelMonitor<ChanSigner> {
self.destination_script != other.destination_script ||
self.broadcasted_local_revokable_script != other.broadcasted_local_revokable_script ||
self.broadcasted_remote_payment_script != other.broadcasted_remote_payment_script ||
self.onchain_detection != other.onchain_detection ||
self.keys.pubkeys() != other.keys.pubkeys() ||
self.funding_info != other.funding_info ||
self.current_remote_commitment_txid != other.current_remote_commitment_txid ||
self.prev_remote_commitment_txid != other.prev_remote_commitment_txid ||
self.their_htlc_base_key != other.their_htlc_base_key ||
self.their_delayed_payment_base_key != other.their_delayed_payment_base_key ||
self.funding_redeemscript != other.funding_redeemscript ||
Expand DownExpand Up@@ -878,8 +871,8 @@ impl<ChanSigner: ChannelKeys + Writeable> ChannelMonitor<ChanSigner> {
}
self.shutdown_script.write(writer)?;

self.onchain_detection.keys.write(writer)?;
match self.onchain_detection.funding_info {
self.keys.write(writer)?;
match self.funding_info {
Some((ref outpoint, ref script)) => {
writer.write_all(&outpoint.txid[..])?;
writer.write_all(&byte_utils::be16_to_array(outpoint.index))?;
Expand All@@ -889,8 +882,8 @@ impl<ChanSigner: ChannelKeys + Writeable> ChannelMonitor<ChanSigner> {
debug_assert!(false, "Try to serialize a useless Local monitor !");
},
}
self.onchain_detection.current_remote_commitment_txid.write(writer)?;
self.onchain_detection.prev_remote_commitment_txid.write(writer)?;
self.current_remote_commitment_txid.write(writer)?;
self.prev_remote_commitment_txid.write(writer)?;

writer.write_all(&self.their_htlc_base_key.as_ref().unwrap().serialize())?;
writer.write_all(&self.their_delayed_payment_base_key.as_ref().unwrap().serialize())?;
Expand DownExpand Up@@ -1096,13 +1089,6 @@ impl<ChanSigner: ChannelKeys> ChannelMonitor<ChanSigner> {
let our_channel_close_key_hash = Hash160::hash(&shutdown_pubkey.serialize());
let shutdown_script = Builder::new().push_opcode(opcodes::all::OP_PUSHBYTES_0).push_slice(&our_channel_close_key_hash[..]).into_script();

let onchain_detection = OnchainDetection {
keys: keys.clone(),
funding_info: Some(funding_info.clone()),
current_remote_commitment_txid: None,
prev_remote_commitment_txid: None,
};

ChannelMonitor {
latest_update_id: 0,
commitment_transaction_number_obscure_factor,
Expand All@@ -1112,7 +1098,11 @@ impl<ChanSigner: ChannelKeys> ChannelMonitor<ChanSigner> {
broadcasted_remote_payment_script: None,
shutdown_script,

onchain_detection: onchain_detection,
keys: keys.clone(),
funding_info: Some(funding_info),
current_remote_commitment_txid: None,
prev_remote_commitment_txid: None,

their_htlc_base_key: Some(their_htlc_base_key.clone()),
their_delayed_payment_base_key: Some(their_delayed_payment_base_key.clone()),
funding_redeemscript: Some(funding_redeemscript.clone()),
Expand DownExpand Up@@ -1159,7 +1149,7 @@ impl<ChanSigner: ChannelKeys> ChannelMonitor<ChanSigner> {

// Prune HTLCs from the previous remote commitment tx so we don't generate failure/fulfill
// events for now-revoked/fulfilled HTLCs.
if let Some(txid) = self.onchain_detection.prev_remote_commitment_txid.take() {
if let Some(txid) = self.prev_remote_commitment_txid.take() {
for &mut (_, ref mut source) in self.remote_claimable_outpoints.get_mut(&txid).unwrap() {
*source = None;
}
Expand DownExpand Up@@ -1216,8 +1206,8 @@ impl<ChanSigner: ChannelKeys> ChannelMonitor<ChanSigner> {
let new_txid = unsigned_commitment_tx.txid();
log_trace!(self, "Tracking new remote commitment transaction with txid {} at commitment number {} with {} HTLC outputs", new_txid, commitment_number, htlc_outputs.len());
log_trace!(self, "New potential remote commitment transaction: {}", encode::serialize_hex(unsigned_commitment_tx));
self.onchain_detection.prev_remote_commitment_txid = self.onchain_detection.current_remote_commitment_txid.take();
self.onchain_detection.current_remote_commitment_txid = Some(new_txid);
self.prev_remote_commitment_txid = self.current_remote_commitment_txid.take();
self.current_remote_commitment_txid = Some(new_txid);
self.remote_claimable_outpoints.insert(new_txid, htlc_outputs);
self.current_remote_commitment_number = commitment_number;
//TODO: Merge this into the other per-remote-transaction output storage stuff
Expand All@@ -1242,11 +1232,11 @@ impl<ChanSigner: ChannelKeys> ChannelMonitor<ChanSigner> {
}

pub(super) fn provide_rescue_remote_commitment_tx_info(&mut self, their_revocation_point: PublicKey) {
if let Ok(payment_key) = chan_utils::derive_public_key(&self.secp_ctx, &their_revocation_point, &self.onchain_detection.keys.pubkeys().payment_basepoint) {
if let Ok(payment_key) = chan_utils::derive_public_key(&self.secp_ctx, &their_revocation_point, &self.keys.pubkeys().payment_basepoint) {
let to_remote_script = Builder::new().push_opcode(opcodes::all::OP_PUSHBYTES_0)
.push_slice(&Hash160::hash(&payment_key.serialize())[..])
.into_script();
if let Ok(to_remote_key) = chan_utils::derive_private_key(&self.secp_ctx, &their_revocation_point, &self.onchain_detection.keys.payment_base_key()) {
if let Ok(to_remote_key) = chan_utils::derive_private_key(&self.secp_ctx, &their_revocation_point, &self.keys.payment_base_key()) {
self.broadcasted_remote_payment_script = Some((to_remote_script, to_remote_key));
}
}
Expand DownExpand Up@@ -1377,7 +1367,7 @@ impl<ChanSigner: ChannelKeys> ChannelMonitor<ChanSigner> {

/// Gets the funding transaction outpoint of the channel this ChannelMonitor is monitoring for.
pub fn get_funding_txo(&self) -> Option<OutPoint> {
if let Some((outp, _)) = self.onchain_detection.funding_info {
if let Some((outp, _)) = self.funding_info {
return Some(outp)
}
None
Expand DownExpand Up@@ -1469,10 +1459,10 @@ impl<ChanSigner: ChannelKeys> ChannelMonitor<ChanSigner> {
let secret = self.get_secret(commitment_number).unwrap();
let per_commitment_key = ignore_error!(SecretKey::from_slice(&secret));
let per_commitment_point = PublicKey::from_secret_key(&self.secp_ctx, &per_commitment_key);
let revocation_pubkey = ignore_error!(chan_utils::derive_public_revocation_key(&self.secp_ctx, &per_commitment_point, &self.onchain_detection.keys.pubkeys().revocation_basepoint));
let revocation_key = ignore_error!(chan_utils::derive_private_revocation_key(&self.secp_ctx, &per_commitment_key, &self.onchain_detection.keys.revocation_base_key()));
let b_htlc_key = ignore_error!(chan_utils::derive_public_key(&self.secp_ctx, &per_commitment_point, &self.onchain_detection.keys.pubkeys().htlc_basepoint));
let local_payment_key = ignore_error!(chan_utils::derive_private_key(&self.secp_ctx, &per_commitment_point, &self.onchain_detection.keys.payment_base_key()));
let revocation_pubkey = ignore_error!(chan_utils::derive_public_revocation_key(&self.secp_ctx, &per_commitment_point, &self.keys.pubkeys().revocation_basepoint));
let revocation_key = ignore_error!(chan_utils::derive_private_revocation_key(&self.secp_ctx, &per_commitment_key, &self.keys.revocation_base_key()));
let b_htlc_key = ignore_error!(chan_utils::derive_public_key(&self.secp_ctx, &per_commitment_point, &self.keys.pubkeys().htlc_basepoint));
let local_payment_key = ignore_error!(chan_utils::derive_private_key(&self.secp_ctx, &per_commitment_point, &self.keys.payment_base_key()));
let delayed_key = ignore_error!(chan_utils::derive_public_key(&self.secp_ctx, &PublicKey::from_secret_key(&self.secp_ctx, &per_commitment_key), &self.their_delayed_payment_base_key.unwrap()));
let a_htlc_key = match self.their_htlc_base_key {
None => return (claimable_outpoints, (commitment_txid, watch_outputs)),
Expand DownExpand Up@@ -1548,10 +1538,10 @@ impl<ChanSigner: ChannelKeys> ChannelMonitor<ChanSigner> {
}
}
}
if let Some(ref txid) = self.onchain_detection.current_remote_commitment_txid {
if let Some(ref txid) = self.current_remote_commitment_txid {
check_htlc_fails!(txid, "current");
}
if let Some(ref txid) = self.onchain_detection.prev_remote_commitment_txid {
if let Some(ref txid) = self.prev_remote_commitment_txid {
check_htlc_fails!(txid, "remote");
}
// No need to check local commitment txn, symmetric HTLCSource must be present as per-htlc data on remote commitment tx
Expand DownExpand Up@@ -1611,10 +1601,10 @@ impl<ChanSigner: ChannelKeys> ChannelMonitor<ChanSigner> {
}
}
}
if let Some(ref txid) = self.onchain_detection.current_remote_commitment_txid {
if let Some(ref txid) = self.current_remote_commitment_txid {
check_htlc_fails!(txid, "current", 'current_loop);
}
if let Some(ref txid) = self.onchain_detection.prev_remote_commitment_txid {
if let Some(ref txid) = self.prev_remote_commitment_txid {
check_htlc_fails!(txid, "previous", 'prev_loop);
}

Expand All@@ -1625,14 +1615,14 @@ impl<ChanSigner: ChannelKeys> ChannelMonitor<ChanSigner> {
if revocation_points.0 == commitment_number + 1 { Some(point) } else { None }
} else { None };
if let Some(revocation_point) = revocation_point_option {
let revocation_pubkey = ignore_error!(chan_utils::derive_public_revocation_key(&self.secp_ctx, revocation_point, &self.onchain_detection.keys.pubkeys().revocation_basepoint));
let b_htlc_key = ignore_error!(chan_utils::derive_public_key(&self.secp_ctx, revocation_point, &self.onchain_detection.keys.pubkeys().htlc_basepoint));
let htlc_privkey = ignore_error!(chan_utils::derive_private_key(&self.secp_ctx, revocation_point, &self.onchain_detection.keys.htlc_base_key()));
let revocation_pubkey = ignore_error!(chan_utils::derive_public_revocation_key(&self.secp_ctx, revocation_point, &self.keys.pubkeys().revocation_basepoint));
let b_htlc_key = ignore_error!(chan_utils::derive_public_key(&self.secp_ctx, revocation_point, &self.keys.pubkeys().htlc_basepoint));
let htlc_privkey = ignore_error!(chan_utils::derive_private_key(&self.secp_ctx, revocation_point, &self.keys.htlc_base_key()));
let a_htlc_key = match self.their_htlc_base_key {
None => return (claimable_outpoints, (commitment_txid, watch_outputs)),
Some(their_htlc_base_key) => ignore_error!(chan_utils::derive_public_key(&self.secp_ctx, revocation_point, &their_htlc_base_key)),
};
let local_payment_key = ignore_error!(chan_utils::derive_private_key(&self.secp_ctx, revocation_point, &self.onchain_detection.keys.payment_base_key()));
let local_payment_key = ignore_error!(chan_utils::derive_private_key(&self.secp_ctx, revocation_point, &self.keys.payment_base_key()));

self.broadcasted_remote_payment_script = {
// Note that the Network here is ignored as we immediately drop the address for the
Expand DownExpand Up@@ -1683,8 +1673,8 @@ impl<ChanSigner: ChannelKeys> ChannelMonitor<ChanSigner> {
let secret = if let Some(secret) = self.get_secret(commitment_number) { secret } else { return (Vec::new(), None); };
let per_commitment_key = ignore_error!(SecretKey::from_slice(&secret));
let per_commitment_point = PublicKey::from_secret_key(&self.secp_ctx, &per_commitment_key);
let revocation_pubkey = ignore_error!(chan_utils::derive_public_revocation_key(&self.secp_ctx, &per_commitment_point, &self.onchain_detection.keys.pubkeys().revocation_basepoint));
let revocation_key = ignore_error!(chan_utils::derive_private_revocation_key(&self.secp_ctx, &per_commitment_key, &self.onchain_detection.keys.revocation_base_key()));
let revocation_pubkey = ignore_error!(chan_utils::derive_public_revocation_key(&self.secp_ctx, &per_commitment_point, &self.keys.pubkeys().revocation_basepoint));
let revocation_key = ignore_error!(chan_utils::derive_private_revocation_key(&self.secp_ctx, &per_commitment_key, &self.keys.revocation_base_key()));
let delayed_key = match self.their_delayed_payment_base_key {
None => return (Vec::new(), None),
Some(their_delayed_payment_base_key) => ignore_error!(chan_utils::derive_public_key(&self.secp_ctx, &per_commitment_point, &their_delayed_payment_base_key)),
Expand All@@ -1702,7 +1692,7 @@ impl<ChanSigner: ChannelKeys> ChannelMonitor<ChanSigner> {
let mut watch_outputs = Vec::with_capacity(local_tx.htlc_outputs.len());

let redeemscript = chan_utils::get_revokeable_redeemscript(&local_tx.revocation_key, self.their_to_self_delay.unwrap(), &local_tx.delayed_payment_key);
let broadcasted_local_revokable_script = if let Ok(local_delayedkey) = chan_utils::derive_private_key(&self.secp_ctx, &local_tx.per_commitment_point, self.onchain_detection.keys.delayed_payment_base_key()) {
let broadcasted_local_revokable_script = if let Ok(local_delayedkey) = chan_utils::derive_private_key(&self.secp_ctx, &local_tx.per_commitment_point, self.keys.delayed_payment_base_key()) {
Some((redeemscript.to_v0_p2wsh(), local_delayedkey, redeemscript))
} else { None };

Expand DownExpand Up@@ -1883,7 +1873,7 @@ impl<ChanSigner: ChannelKeys> ChannelMonitor<ChanSigner> {
// which is an easy way to filter out any potential non-matching txn for lazy
// filters.
let prevout = &tx.input[0].previous_output;
let funding_txo = self.onchain_detection.funding_info.clone();
let funding_txo = self.funding_info.clone();
if funding_txo.is_none() || (prevout.txid == funding_txo.as_ref().unwrap().0.txid && prevout.vout == funding_txo.as_ref().unwrap().0.index as u32) {
if (tx.input[0].sequence >> 8*3) as u8 == 0x80 && (tx.lock_time >> 8*3) as u8 == 0x20 {
let (mut new_outpoints, new_outputs) = self.check_spend_remote_transaction(&tx, height);
Expand DownExpand Up@@ -1920,7 +1910,7 @@ impl<ChanSigner: ChannelKeys> ChannelMonitor<ChanSigner> {
self.would_broadcast_at_height(height)
} else { false };
if should_broadcast {
claimable_outpoints.push(ClaimRequest { absolute_timelock: height, aggregable: false, outpoint: BitcoinOutPoint { txid: self.onchain_detection.funding_info.as_ref().unwrap().0.txid.clone(), vout: self.onchain_detection.funding_info.as_ref().unwrap().0.index as u32 }, witness_data: InputMaterial::Funding { channel_value: self.channel_value_satoshis.unwrap() }});
claimable_outpoints.push(ClaimRequest { absolute_timelock: height, aggregable: false, outpoint: BitcoinOutPoint { txid: self.funding_info.as_ref().unwrap().0.txid.clone(), vout: self.funding_info.as_ref().unwrap().0.index as u32 }, witness_data: InputMaterial::Funding { channel_value: self.channel_value_satoshis.unwrap() }});
}
if let Some(ref cur_local_tx) = self.current_local_signed_commitment_tx {
if should_broadcast {
Expand DownExpand Up@@ -2030,12 +2020,12 @@ impl<ChanSigner: ChannelKeys> ChannelMonitor<ChanSigner> {
scan_commitment!(cur_local_tx.htlc_outputs.iter().map(|&(ref a, _, _)| a), true);
}

if let Some(ref txid) = self.onchain_detection.current_remote_commitment_txid {
if let Some(ref txid) = self.current_remote_commitment_txid {
if let Some(ref htlc_outputs) = self.remote_claimable_outpoints.get(txid) {
scan_commitment!(htlc_outputs.iter().map(|&(ref a, _)| a), false);
}
}
if let Some(ref txid) = self.onchain_detection.prev_remote_commitment_txid {
if let Some(ref txid) = self.prev_remote_commitment_txid {
if let Some(ref htlc_outputs) = self.remote_claimable_outpoints.get(txid) {
scan_commitment!(htlc_outputs.iter().map(|&(ref a, _)| a), false);
}
Expand DownExpand Up@@ -2105,9 +2095,9 @@ impl<ChanSigner: ChannelKeys> ChannelMonitor<ChanSigner> {
// resolve the source HTLC with the original sender.
payment_data = Some(((*source).clone(), htlc_output.payment_hash));
} else if !$local_tx {
check_htlc_valid_remote!(self.onchain_detection.current_remote_commitment_txid, htlc_output);
check_htlc_valid_remote!(self.current_remote_commitment_txid, htlc_output);
if payment_data.is_none() {
check_htlc_valid_remote!(self.onchain_detection.prev_remote_commitment_txid, htlc_output);
check_htlc_valid_remote!(self.prev_remote_commitment_txid, htlc_output);
}
}
if payment_data.is_none() {
Expand DownExpand Up@@ -2278,24 +2268,16 @@ impl<ChanSigner: ChannelKeys + Readable> ReadableArgs<Arc<Logger>> for (Sha256dH
};
let shutdown_script = Readable::read(reader)?;

let onchain_detection = {
let keys = Readable::read(reader)?;
// Technically this can fail and serialize fail a round-trip, but only for serialization of
// barely-init'd ChannelMonitors that we can't do anything with.
let outpoint = OutPoint {
txid: Readable::read(reader)?,
index: Readable::read(reader)?,
};
let funding_info = Some((outpoint, Readable::read(reader)?));
let current_remote_commitment_txid = Readable::read(reader)?;
let prev_remote_commitment_txid = Readable::read(reader)?;
OnchainDetection {
keys,
funding_info,
current_remote_commitment_txid,
prev_remote_commitment_txid,
}
let keys = Readable::read(reader)?;
// Technically this can fail and serialize fail a round-trip, but only for serialization of
// barely-init'd ChannelMonitors that we can't do anything with.
let outpoint = OutPoint {
txid: Readable::read(reader)?,
index: Readable::read(reader)?,
};
let funding_info = Some((outpoint, Readable::read(reader)?));
let current_remote_commitment_txid = Readable::read(reader)?;
let prev_remote_commitment_txid = Readable::read(reader)?;

let their_htlc_base_key = Some(Readable::read(reader)?);
let their_delayed_payment_base_key = Some(Readable::read(reader)?);
Expand DownExpand Up@@ -2508,7 +2490,11 @@ impl<ChanSigner: ChannelKeys + Readable> ReadableArgs<Arc<Logger>> for (Sha256dH
broadcasted_remote_payment_script,
shutdown_script,

onchain_detection,
keys,
funding_info,
current_remote_commitment_txid,
prev_remote_commitment_txid,

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

Skip to content
Flatten ChannelMonitor substructs that don't add clarity#558

New issue

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

 Sign up for GitHub

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

Already on GitHub?
Sign in
to your account

 Merged

TheBlueMatt
merged 2 commits into

from

Apr 19, 2020
 Merged


Flatten ChannelMonitor substructs that don't add clarity
#558
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
3c5ba6b

Drop uneccessary clone() introduced in 16fba9fd664522ac8d24111547b4


TheBlueMatt Mar 21, 2020
b49e63b

Flatten ChannelMonitor substructs that don't add clarity


TheBlueMatt Mar 21, 2020

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


136 changes: 61 additions & 75 deletions
lightning/src/ln/channelmonitor.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -290,7 +290,7 @@ impl<Key : Send + cmp::Eq + hash::Hash + 'static, ChanSigner: ChannelKeys, T: De
 hash_map::Entry::Occupied(_) => return Err(MonitorUpdateError("Channel monitor for given key is already present")),
 hash_map::Entry::Vacant(e) => e,
 };
 match monitor.onchain_detection.funding_info {
 match monitor.funding_info {
 None => {
 return Err(MonitorUpdateError("Try to update a useless monitor without funding_txo !"));
 },
Expand All@@ -314,7 +314,7 @@ impl<Key : Send + cmp::Eq + hash::Hash + 'static, ChanSigner: ChannelKeys, T: De
 let mut monitors = self.monitors.lock().unwrap();
 match monitors.get_mut(&key) {
 Some(orig_monitor) => {
 log_trace!(self, "Updating Channel Monitor for channel {}", log_funding_info!(orig_monitor.onchain_detection));
 log_trace!(self, "Updating Channel Monitor for channel {}", log_funding_info!(orig_monitor));
 orig_monitor.update_monitor(update, &self.broadcaster)
 },
 None => Err(MonitorUpdateError("No such monitor registered"))
Expand DownExpand Up@@ -391,20 +391,6 @@ pub(crate) const LATENCY_GRACE_PERIOD_BLOCKS: u32 = 3;
/// keeping bumping another claim tx to solve the outpoint.
pub(crate) const ANTI_REORG_DELAY: u32 = 6;

struct OnchainDetection<ChanSigner: ChannelKeys> {
	keys: ChanSigner,
	funding_info: Option<(OutPoint, Script)>,
	current_remote_commitment_txid: Option<Sha256dHash>,
	prev_remote_commitment_txid: Option<Sha256dHash>,
}

#[cfg(any(test, feature = "fuzztarget"))]
impl<ChanSigner: ChannelKeys> PartialEq for OnchainDetection<ChanSigner> {
	fn eq(&self, other: &Self) -> bool {
 self.keys.pubkeys() == other.keys.pubkeys()
	}
}

#[derive(Clone, PartialEq)]
struct LocalSignedTx {
	/// txid of the transaction in tx, just used to make comparison faster
Expand DownExpand Up@@ -734,7 +720,11 @@ pub struct ChannelMonitor<ChanSigner: ChannelKeys> {
	broadcasted_remote_payment_script: Option<(Script, SecretKey)>,
	shutdown_script: Script,

	onchain_detection: OnchainDetection<ChanSigner>,
	keys: ChanSigner,
	funding_info: Option<(OutPoint, Script)>,
	current_remote_commitment_txid: Option<Sha256dHash>,
	prev_remote_commitment_txid: Option<Sha256dHash>,

	their_htlc_base_key: Option<PublicKey>,
	their_delayed_payment_base_key: Option<PublicKey>,
	funding_redeemscript: Option<Script>,
Expand DownExpand Up@@ -817,7 +807,10 @@ impl<ChanSigner: ChannelKeys> PartialEq for ChannelMonitor<ChanSigner> {
 self.destination_script != other.destination_script ||
 self.broadcasted_local_revokable_script != other.broadcasted_local_revokable_script ||
 self.broadcasted_remote_payment_script != other.broadcasted_remote_payment_script ||
 self.onchain_detection != other.onchain_detection ||
 self.keys.pubkeys() != other.keys.pubkeys() ||
 self.funding_info != other.funding_info ||
 self.current_remote_commitment_txid != other.current_remote_commitment_txid ||
 self.prev_remote_commitment_txid != other.prev_remote_commitment_txid ||
 self.their_htlc_base_key != other.their_htlc_base_key ||
 self.their_delayed_payment_base_key != other.their_delayed_payment_base_key ||
 self.funding_redeemscript != other.funding_redeemscript ||
Expand DownExpand Up@@ -878,8 +871,8 @@ impl<ChanSigner: ChannelKeys + Writeable> ChannelMonitor<ChanSigner> {
 }
 self.shutdown_script.write(writer)?;

 self.onchain_detection.keys.write(writer)?;
 match self.onchain_detection.funding_info {
 self.keys.write(writer)?;
 match self.funding_info {
 Some((ref outpoint, ref script)) => {
 writer.write_all(&outpoint.txid[..])?;
 writer.write_all(&byte_utils::be16_to_array(outpoint.index))?;
Expand All@@ -889,8 +882,8 @@ impl<ChanSigner: ChannelKeys + Writeable> ChannelMonitor<ChanSigner> {
 debug_assert!(false, "Try to serialize a useless Local monitor !");
 },
 }
 self.onchain_detection.current_remote_commitment_txid.write(writer)?;
 self.onchain_detection.prev_remote_commitment_txid.write(writer)?;
 self.current_remote_commitment_txid.write(writer)?;
 self.prev_remote_commitment_txid.write(writer)?;

 writer.write_all(&self.their_htlc_base_key.as_ref().unwrap().serialize())?;
 writer.write_all(&self.their_delayed_payment_base_key.as_ref().unwrap().serialize())?;
Expand DownExpand Up@@ -1096,13 +1089,6 @@ impl<ChanSigner: ChannelKeys> ChannelMonitor<ChanSigner> {
 let our_channel_close_key_hash = Hash160::hash(&shutdown_pubkey.serialize());
 let shutdown_script = Builder::new().push_opcode(opcodes::all::OP_PUSHBYTES_0).push_slice(&our_channel_close_key_hash[..]).into_script();

 let onchain_detection = OnchainDetection {
 keys: keys.clone(),
 funding_info: Some(funding_info.clone()),
 current_remote_commitment_txid: None,
 prev_remote_commitment_txid: None,
 };

 ChannelMonitor {
 latest_update_id: 0,
 commitment_transaction_number_obscure_factor,
Expand All@@ -1112,7 +1098,11 @@ impl<ChanSigner: ChannelKeys> ChannelMonitor<ChanSigner> {
 broadcasted_remote_payment_script: None,
 shutdown_script,

 onchain_detection: onchain_detection,
 keys: keys.clone(),
 funding_info: Some(funding_info),
 current_remote_commitment_txid: None,
 prev_remote_commitment_txid: None,

 their_htlc_base_key: Some(their_htlc_base_key.clone()),
 their_delayed_payment_base_key: Some(their_delayed_payment_base_key.clone()),
 funding_redeemscript: Some(funding_redeemscript.clone()),
Expand DownExpand Up@@ -1159,7 +1149,7 @@ impl<ChanSigner: ChannelKeys> ChannelMonitor<ChanSigner> {

 // Prune HTLCs from the previous remote commitment tx so we don't generate failure/fulfill
 // events for now-revoked/fulfilled HTLCs.
 if let Some(txid) = self.onchain_detection.prev_remote_commitment_txid.take() {
 if let Some(txid) = self.prev_remote_commitment_txid.take() {
 for &mut (_, ref mut source) in self.remote_claimable_outpoints.get_mut(&txid).unwrap() {
 *source = None;
 }
Expand DownExpand Up@@ -1216,8 +1206,8 @@ impl<ChanSigner: ChannelKeys> ChannelMonitor<ChanSigner> {
 let new_txid = unsigned_commitment_tx.txid();
 log_trace!(self, "Tracking new remote commitment transaction with txid {} at commitment number {} with {} HTLC outputs", new_txid, commitment_number, htlc_outputs.len());
 log_trace!(self, "New potential remote commitment transaction: {}", encode::serialize_hex(unsigned_commitment_tx));
 self.onchain_detection.prev_remote_commitment_txid = self.onchain_detection.current_remote_commitment_txid.take();
 self.onchain_detection.current_remote_commitment_txid = Some(new_txid);
 self.prev_remote_commitment_txid = self.current_remote_commitment_txid.take();
 self.current_remote_commitment_txid = Some(new_txid);
 self.remote_claimable_outpoints.insert(new_txid, htlc_outputs);
 self.current_remote_commitment_number = commitment_number;
 //TODO: Merge this into the other per-remote-transaction output storage stuff
Expand All@@ -1242,11 +1232,11 @@ impl<ChanSigner: ChannelKeys> ChannelMonitor<ChanSigner> {
	}

	pub(super) fn provide_rescue_remote_commitment_tx_info(&mut self, their_revocation_point: PublicKey) {
 if let Ok(payment_key) = chan_utils::derive_public_key(&self.secp_ctx, &their_revocation_point, &self.onchain_detection.keys.pubkeys().payment_basepoint) {
 if let Ok(payment_key) = chan_utils::derive_public_key(&self.secp_ctx, &their_revocation_point, &self.keys.pubkeys().payment_basepoint) {
 let to_remote_script = Builder::new().push_opcode(opcodes::all::OP_PUSHBYTES_0)
 .push_slice(&Hash160::hash(&payment_key.serialize())[..])
 .into_script();
 if let Ok(to_remote_key) = chan_utils::derive_private_key(&self.secp_ctx, &their_revocation_point, &self.onchain_detection.keys.payment_base_key()) {
 if let Ok(to_remote_key) = chan_utils::derive_private_key(&self.secp_ctx, &their_revocation_point, &self.keys.payment_base_key()) {
 self.broadcasted_remote_payment_script = Some((to_remote_script, to_remote_key));
 }
 }
Expand DownExpand Up@@ -1377,7 +1367,7 @@ impl<ChanSigner: ChannelKeys> ChannelMonitor<ChanSigner> {

	/// Gets the funding transaction outpoint of the channel this ChannelMonitor is monitoring for.
	pub fn get_funding_txo(&self) -> Option<OutPoint> {
 if let Some((outp, _)) = self.onchain_detection.funding_info {
 if let Some((outp, _)) = self.funding_info {
 return Some(outp)
 }
 None
Expand DownExpand Up@@ -1469,10 +1459,10 @@ impl<ChanSigner: ChannelKeys> ChannelMonitor<ChanSigner> {
 let secret = self.get_secret(commitment_number).unwrap();
 let per_commitment_key = ignore_error!(SecretKey::from_slice(&secret));
 let per_commitment_point = PublicKey::from_secret_key(&self.secp_ctx, &per_commitment_key);
 let revocation_pubkey = ignore_error!(chan_utils::derive_public_revocation_key(&self.secp_ctx, &per_commitment_point, &self.onchain_detection.keys.pubkeys().revocation_basepoint));
 let revocation_key = ignore_error!(chan_utils::derive_private_revocation_key(&self.secp_ctx, &per_commitment_key, &self.onchain_detection.keys.revocation_base_key()));
 let b_htlc_key = ignore_error!(chan_utils::derive_public_key(&self.secp_ctx, &per_commitment_point, &self.onchain_detection.keys.pubkeys().htlc_basepoint));
 let local_payment_key = ignore_error!(chan_utils::derive_private_key(&self.secp_ctx, &per_commitment_point, &self.onchain_detection.keys.payment_base_key()));
 let revocation_pubkey = ignore_error!(chan_utils::derive_public_revocation_key(&self.secp_ctx, &per_commitment_point, &self.keys.pubkeys().revocation_basepoint));
 let revocation_key = ignore_error!(chan_utils::derive_private_revocation_key(&self.secp_ctx, &per_commitment_key, &self.keys.revocation_base_key()));
 let b_htlc_key = ignore_error!(chan_utils::derive_public_key(&self.secp_ctx, &per_commitment_point, &self.keys.pubkeys().htlc_basepoint));
 let local_payment_key = ignore_error!(chan_utils::derive_private_key(&self.secp_ctx, &per_commitment_point, &self.keys.payment_base_key()));
 let delayed_key = ignore_error!(chan_utils::derive_public_key(&self.secp_ctx, &PublicKey::from_secret_key(&self.secp_ctx, &per_commitment_key), &self.their_delayed_payment_base_key.unwrap()));
 let a_htlc_key = match self.their_htlc_base_key {
 None => return (claimable_outpoints, (commitment_txid, watch_outputs)),
Expand DownExpand Up@@ -1548,10 +1538,10 @@ impl<ChanSigner: ChannelKeys> ChannelMonitor<ChanSigner> {
 }
 }
 }
 if let Some(ref txid) = self.onchain_detection.current_remote_commitment_txid {
 if let Some(ref txid) = self.current_remote_commitment_txid {
 check_htlc_fails!(txid, "current");
 }
 if let Some(ref txid) = self.onchain_detection.prev_remote_commitment_txid {
 if let Some(ref txid) = self.prev_remote_commitment_txid {
 check_htlc_fails!(txid, "remote");
 }
 // No need to check local commitment txn, symmetric HTLCSource must be present as per-htlc data on remote commitment tx
Expand DownExpand Up@@ -1611,10 +1601,10 @@ impl<ChanSigner: ChannelKeys> ChannelMonitor<ChanSigner> {
 }
 }
 }
 if let Some(ref txid) = self.onchain_detection.current_remote_commitment_txid {
 if let Some(ref txid) = self.current_remote_commitment_txid {
 check_htlc_fails!(txid, "current", 'current_loop);
 }
 if let Some(ref txid) = self.onchain_detection.prev_remote_commitment_txid {
 if let Some(ref txid) = self.prev_remote_commitment_txid {
 check_htlc_fails!(txid, "previous", 'prev_loop);
 }

Expand All@@ -1625,14 +1615,14 @@ impl<ChanSigner: ChannelKeys> ChannelMonitor<ChanSigner> {
 if revocation_points.0 == commitment_number + 1 { Some(point) } else { None }
 } else { None };
 if let Some(revocation_point) = revocation_point_option {
 let revocation_pubkey = ignore_error!(chan_utils::derive_public_revocation_key(&self.secp_ctx, revocation_point, &self.onchain_detection.keys.pubkeys().revocation_basepoint));
 let b_htlc_key = ignore_error!(chan_utils::derive_public_key(&self.secp_ctx, revocation_point, &self.onchain_detection.keys.pubkeys().htlc_basepoint));
 let htlc_privkey = ignore_error!(chan_utils::derive_private_key(&self.secp_ctx, revocation_point, &self.onchain_detection.keys.htlc_base_key()));
 let revocation_pubkey = ignore_error!(chan_utils::derive_public_revocation_key(&self.secp_ctx, revocation_point, &self.keys.pubkeys().revocation_basepoint));
 let b_htlc_key = ignore_error!(chan_utils::derive_public_key(&self.secp_ctx, revocation_point, &self.keys.pubkeys().htlc_basepoint));
 let htlc_privkey = ignore_error!(chan_utils::derive_private_key(&self.secp_ctx, revocation_point, &self.keys.htlc_base_key()));
 let a_htlc_key = match self.their_htlc_base_key {
 None => return (claimable_outpoints, (commitment_txid, watch_outputs)),
 Some(their_htlc_base_key) => ignore_error!(chan_utils::derive_public_key(&self.secp_ctx, revocation_point, &their_htlc_base_key)),
 };
 let local_payment_key = ignore_error!(chan_utils::derive_private_key(&self.secp_ctx, revocation_point, &self.onchain_detection.keys.payment_base_key()));
 let local_payment_key = ignore_error!(chan_utils::derive_private_key(&self.secp_ctx, revocation_point, &self.keys.payment_base_key()));

 self.broadcasted_remote_payment_script = {
 // Note that the Network here is ignored as we immediately drop the address for the
Expand DownExpand Up@@ -1683,8 +1673,8 @@ impl<ChanSigner: ChannelKeys> ChannelMonitor<ChanSigner> {
 let secret = if let Some(secret) = self.get_secret(commitment_number) { secret } else { return (Vec::new(), None); };
 let per_commitment_key = ignore_error!(SecretKey::from_slice(&secret));
 let per_commitment_point = PublicKey::from_secret_key(&self.secp_ctx, &per_commitment_key);
 let revocation_pubkey = ignore_error!(chan_utils::derive_public_revocation_key(&self.secp_ctx, &per_commitment_point, &self.onchain_detection.keys.pubkeys().revocation_basepoint));
 let revocation_key = ignore_error!(chan_utils::derive_private_revocation_key(&self.secp_ctx, &per_commitment_key, &self.onchain_detection.keys.revocation_base_key()));
 let revocation_pubkey = ignore_error!(chan_utils::derive_public_revocation_key(&self.secp_ctx, &per_commitment_point, &self.keys.pubkeys().revocation_basepoint));
 let revocation_key = ignore_error!(chan_utils::derive_private_revocation_key(&self.secp_ctx, &per_commitment_key, &self.keys.revocation_base_key()));
 let delayed_key = match self.their_delayed_payment_base_key {
 None => return (Vec::new(), None),
 Some(their_delayed_payment_base_key) => ignore_error!(chan_utils::derive_public_key(&self.secp_ctx, &per_commitment_point, &their_delayed_payment_base_key)),
Expand All@@ -1702,7 +1692,7 @@ impl<ChanSigner: ChannelKeys> ChannelMonitor<ChanSigner> {
 let mut watch_outputs = Vec::with_capacity(local_tx.htlc_outputs.len());

 let redeemscript = chan_utils::get_revokeable_redeemscript(&local_tx.revocation_key, self.their_to_self_delay.unwrap(), &local_tx.delayed_payment_key);
 let broadcasted_local_revokable_script = if let Ok(local_delayedkey) = chan_utils::derive_private_key(&self.secp_ctx, &local_tx.per_commitment_point, self.onchain_detection.keys.delayed_payment_base_key()) {
 let broadcasted_local_revokable_script = if let Ok(local_delayedkey) = chan_utils::derive_private_key(&self.secp_ctx, &local_tx.per_commitment_point, self.keys.delayed_payment_base_key()) {
 Some((redeemscript.to_v0_p2wsh(), local_delayedkey, redeemscript))
 } else { None };

Expand DownExpand Up@@ -1883,7 +1873,7 @@ impl<ChanSigner: ChannelKeys> ChannelMonitor<ChanSigner> {
 // which is an easy way to filter out any potential non-matching txn for lazy
 // filters.
 let prevout = &tx.input[0].previous_output;
 let funding_txo = self.onchain_detection.funding_info.clone();
 let funding_txo = self.funding_info.clone();
 if funding_txo.is_none() || (prevout.txid == funding_txo.as_ref().unwrap().0.txid && prevout.vout == funding_txo.as_ref().unwrap().0.index as u32) {
 if (tx.input[0].sequence >> 8*3) as u8 == 0x80 && (tx.lock_time >> 8*3) as u8 == 0x20 {
 let (mut new_outpoints, new_outputs) = self.check_spend_remote_transaction(&tx, height);
Expand DownExpand Up@@ -1920,7 +1910,7 @@ impl<ChanSigner: ChannelKeys> ChannelMonitor<ChanSigner> {
 self.would_broadcast_at_height(height)
 } else { false };
 if should_broadcast {
 claimable_outpoints.push(ClaimRequest { absolute_timelock: height, aggregable: false, outpoint: BitcoinOutPoint { txid: self.onchain_detection.funding_info.as_ref().unwrap().0.txid.clone(), vout: self.onchain_detection.funding_info.as_ref().unwrap().0.index as u32 }, witness_data: InputMaterial::Funding { channel_value: self.channel_value_satoshis.unwrap() }});
 claimable_outpoints.push(ClaimRequest { absolute_timelock: height, aggregable: false, outpoint: BitcoinOutPoint { txid: self.funding_info.as_ref().unwrap().0.txid.clone(), vout: self.funding_info.as_ref().unwrap().0.index as u32 }, witness_data: InputMaterial::Funding { channel_value: self.channel_value_satoshis.unwrap() }});
 }
 if let Some(ref cur_local_tx) = self.current_local_signed_commitment_tx {
 if should_broadcast {
Expand DownExpand Up@@ -2030,12 +2020,12 @@ impl<ChanSigner: ChannelKeys> ChannelMonitor<ChanSigner> {
 scan_commitment!(cur_local_tx.htlc_outputs.iter().map(|&(ref a, _, _)| a), true);
 }

 if let Some(ref txid) = self.onchain_detection.current_remote_commitment_txid {
 if let Some(ref txid) = self.current_remote_commitment_txid {
 if let Some(ref htlc_outputs) = self.remote_claimable_outpoints.get(txid) {
 scan_commitment!(htlc_outputs.iter().map(|&(ref a, _)| a), false);
 }
 }
 if let Some(ref txid) = self.onchain_detection.prev_remote_commitment_txid {
 if let Some(ref txid) = self.prev_remote_commitment_txid {
 if let Some(ref htlc_outputs) = self.remote_claimable_outpoints.get(txid) {
 scan_commitment!(htlc_outputs.iter().map(|&(ref a, _)| a), false);
 }
Expand DownExpand Up@@ -2105,9 +2095,9 @@ impl<ChanSigner: ChannelKeys> ChannelMonitor<ChanSigner> {
 // resolve the source HTLC with the original sender.
 payment_data = Some(((*source).clone(), htlc_output.payment_hash));
 } else if !$local_tx {
 check_htlc_valid_remote!(self.onchain_detection.current_remote_commitment_txid, htlc_output);
 check_htlc_valid_remote!(self.current_remote_commitment_txid, htlc_output);
 if payment_data.is_none() {
 check_htlc_valid_remote!(self.onchain_detection.prev_remote_commitment_txid, htlc_output);
 check_htlc_valid_remote!(self.prev_remote_commitment_txid, htlc_output);
 }
 }
 if payment_data.is_none() {
Expand DownExpand Up@@ -2278,24 +2268,16 @@ impl<ChanSigner: ChannelKeys + Readable> ReadableArgs<Arc<Logger>> for (Sha256dH
 };
 let shutdown_script = Readable::read(reader)?;

 let onchain_detection = {
 let keys = Readable::read(reader)?;
 // Technically this can fail and serialize fail a round-trip, but only for serialization of
 // barely-init'd ChannelMonitors that we can't do anything with.
 let outpoint = OutPoint {
 txid: Readable::read(reader)?,
 index: Readable::read(reader)?,
 };
 let funding_info = Some((outpoint, Readable::read(reader)?));
 let current_remote_commitment_txid = Readable::read(reader)?;
 let prev_remote_commitment_txid = Readable::read(reader)?;
 OnchainDetection {
 keys,
 funding_info,
 current_remote_commitment_txid,
 prev_remote_commitment_txid,
 }
 let keys = Readable::read(reader)?;
 // Technically this can fail and serialize fail a round-trip, but only for serialization of
 // barely-init'd ChannelMonitors that we can't do anything with.
 let outpoint = OutPoint {
 txid: Readable::read(reader)?,
 index: Readable::read(reader)?,
 };
 let funding_info = Some((outpoint, Readable::read(reader)?));
 let current_remote_commitment_txid = Readable::read(reader)?;
 let prev_remote_commitment_txid = Readable::read(reader)?;

 let their_htlc_base_key = Some(Readable::read(reader)?);
 let their_delayed_payment_base_key = Some(Readable::read(reader)?);
Expand DownExpand Up@@ -2508,7 +2490,11 @@ impl<ChanSigner: ChannelKeys + Readable> ReadableArgs<Arc<Logger>> for (Sha256dH
 broadcasted_remote_payment_script,
 shutdown_script,

 onchain_detection,
 keys,
 funding_info,
 current_remote_commitment_txid,
 prev_remote_commitment_txid,

 their_htlc_base_key,
 their_delayed_payment_base_key,
 funding_redeemscript,
Expand Down

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

Skip to content
Flatten ChannelMonitor substructs that don't add clarity#558

New issue

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

 Sign up for GitHub

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

Already on GitHub?
Sign in
to your account

 Merged

TheBlueMatt
merged 2 commits into

from

Apr 19, 2020
 Merged


Flatten ChannelMonitor substructs that don't add clarity
#558
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
3c5ba6b

Drop uneccessary clone() introduced in 16fba9fd664522ac8d24111547b4


TheBlueMatt Mar 21, 2020
b49e63b

Flatten ChannelMonitor substructs that don't add clarity


TheBlueMatt Mar 21, 2020

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


136 changes: 61 additions & 75 deletions
lightning/src/ln/channelmonitor.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -290,7 +290,7 @@ impl<Key : Send + cmp::Eq + hash::Hash + 'static, ChanSigner: ChannelKeys, T: De
 hash_map::Entry::Occupied(_) => return Err(MonitorUpdateError("Channel monitor for given key is already present")),
 hash_map::Entry::Vacant(e) => e,
 };
 match monitor.onchain_detection.funding_info {
 match monitor.funding_info {
 None => {
 return Err(MonitorUpdateError("Try to update a useless monitor without funding_txo !"));
 },
Expand All@@ -314,7 +314,7 @@ impl<Key : Send + cmp::Eq + hash::Hash + 'static, ChanSigner: ChannelKeys, T: De
 let mut monitors = self.monitors.lock().unwrap();
 match monitors.get_mut(&key) {
 Some(orig_monitor) => {
 log_trace!(self, "Updating Channel Monitor for channel {}", log_funding_info!(orig_monitor.onchain_detection));
 log_trace!(self, "Updating Channel Monitor for channel {}", log_funding_info!(orig_monitor));
 orig_monitor.update_monitor(update, &self.broadcaster)
 },
 None => Err(MonitorUpdateError("No such monitor registered"))
Expand DownExpand Up@@ -391,20 +391,6 @@ pub(crate) const LATENCY_GRACE_PERIOD_BLOCKS: u32 = 3;
/// keeping bumping another claim tx to solve the outpoint.
pub(crate) const ANTI_REORG_DELAY: u32 = 6;

struct OnchainDetection<ChanSigner: ChannelKeys> {
	keys: ChanSigner,
	funding_info: Option<(OutPoint, Script)>,
	current_remote_commitment_txid: Option<Sha256dHash>,
	prev_remote_commitment_txid: Option<Sha256dHash>,
}

#[cfg(any(test, feature = "fuzztarget"))]
impl<ChanSigner: ChannelKeys> PartialEq for OnchainDetection<ChanSigner> {
	fn eq(&self, other: &Self) -> bool {
 self.keys.pubkeys() == other.keys.pubkeys()
	}
}

#[derive(Clone, PartialEq)]
struct LocalSignedTx {
	/// txid of the transaction in tx, just used to make comparison faster
Expand DownExpand Up@@ -734,7 +720,11 @@ pub struct ChannelMonitor<ChanSigner: ChannelKeys> {
	broadcasted_remote_payment_script: Option<(Script, SecretKey)>,
	shutdown_script: Script,

	onchain_detection: OnchainDetection<ChanSigner>,
	keys: ChanSigner,
	funding_info: Option<(OutPoint, Script)>,
	current_remote_commitment_txid: Option<Sha256dHash>,
	prev_remote_commitment_txid: Option<Sha256dHash>,

	their_htlc_base_key: Option<PublicKey>,
	their_delayed_payment_base_key: Option<PublicKey>,
	funding_redeemscript: Option<Script>,
Expand DownExpand Up@@ -817,7 +807,10 @@ impl<ChanSigner: ChannelKeys> PartialEq for ChannelMonitor<ChanSigner> {
 self.destination_script != other.destination_script ||
 self.broadcasted_local_revokable_script != other.broadcasted_local_revokable_script ||
 self.broadcasted_remote_payment_script != other.broadcasted_remote_payment_script ||
 self.onchain_detection != other.onchain_detection ||
 self.keys.pubkeys() != other.keys.pubkeys() ||
 self.funding_info != other.funding_info ||
 self.current_remote_commitment_txid != other.current_remote_commitment_txid ||
 self.prev_remote_commitment_txid != other.prev_remote_commitment_txid ||
 self.their_htlc_base_key != other.their_htlc_base_key ||
 self.their_delayed_payment_base_key != other.their_delayed_payment_base_key ||
 self.funding_redeemscript != other.funding_redeemscript ||
Expand DownExpand Up@@ -878,8 +871,8 @@ impl<ChanSigner: ChannelKeys + Writeable> ChannelMonitor<ChanSigner> {
 }
 self.shutdown_script.write(writer)?;

 self.onchain_detection.keys.write(writer)?;
 match self.onchain_detection.funding_info {
 self.keys.write(writer)?;
 match self.funding_info {
 Some((ref outpoint, ref script)) => {
 writer.write_all(&outpoint.txid[..])?;
 writer.write_all(&byte_utils::be16_to_array(outpoint.index))?;
Expand All@@ -889,8 +882,8 @@ impl<ChanSigner: ChannelKeys + Writeable> ChannelMonitor<ChanSigner> {
 debug_assert!(false, "Try to serialize a useless Local monitor !");
 },
 }
 self.onchain_detection.current_remote_commitment_txid.write(writer)?;
 self.onchain_detection.prev_remote_commitment_txid.write(writer)?;
 self.current_remote_commitment_txid.write(writer)?;
 self.prev_remote_commitment_txid.write(writer)?;

 writer.write_all(&self.their_htlc_base_key.as_ref().unwrap().serialize())?;
 writer.write_all(&self.their_delayed_payment_base_key.as_ref().unwrap().serialize())?;
Expand DownExpand Up@@ -1096,13 +1089,6 @@ impl<ChanSigner: ChannelKeys> ChannelMonitor<ChanSigner> {
 let our_channel_close_key_hash = Hash160::hash(&shutdown_pubkey.serialize());
 let shutdown_script = Builder::new().push_opcode(opcodes::all::OP_PUSHBYTES_0).push_slice(&our_channel_close_key_hash[..]).into_script();

 let onchain_detection = OnchainDetection {
 keys: keys.clone(),
 funding_info: Some(funding_info.clone()),
 current_remote_commitment_txid: None,
 prev_remote_commitment_txid: None,
 };

 ChannelMonitor {
 latest_update_id: 0,
 commitment_transaction_number_obscure_factor,
Expand All@@ -1112,7 +1098,11 @@ impl<ChanSigner: ChannelKeys> ChannelMonitor<ChanSigner> {
 broadcasted_remote_payment_script: None,
 shutdown_script,

 onchain_detection: onchain_detection,
 keys: keys.clone(),
 funding_info: Some(funding_info),
 current_remote_commitment_txid: None,
 prev_remote_commitment_txid: None,

 their_htlc_base_key: Some(their_htlc_base_key.clone()),
 their_delayed_payment_base_key: Some(their_delayed_payment_base_key.clone()),
 funding_redeemscript: Some(funding_redeemscript.clone()),
Expand DownExpand Up@@ -1159,7 +1149,7 @@ impl<ChanSigner: ChannelKeys> ChannelMonitor<ChanSigner> {

 // Prune HTLCs from the previous remote commitment tx so we don't generate failure/fulfill
 // events for now-revoked/fulfilled HTLCs.
 if let Some(txid) = self.onchain_detection.prev_remote_commitment_txid.take() {
 if let Some(txid) = self.prev_remote_commitment_txid.take() {
 for &mut (_, ref mut source) in self.remote_claimable_outpoints.get_mut(&txid).unwrap() {
 *source = None;
 }
Expand DownExpand Up@@ -1216,8 +1206,8 @@ impl<ChanSigner: ChannelKeys> ChannelMonitor<ChanSigner> {
 let new_txid = unsigned_commitment_tx.txid();
 log_trace!(self, "Tracking new remote commitment transaction with txid {} at commitment number {} with {} HTLC outputs", new_txid, commitment_number, htlc_outputs.len());
 log_trace!(self, "New potential remote commitment transaction: {}", encode::serialize_hex(unsigned_commitment_tx));
 self.onchain_detection.prev_remote_commitment_txid = self.onchain_detection.current_remote_commitment_txid.take();
 self.onchain_detection.current_remote_commitment_txid = Some(new_txid);
 self.prev_remote_commitment_txid = self.current_remote_commitment_txid.take();
 self.current_remote_commitment_txid = Some(new_txid);
 self.remote_claimable_outpoints.insert(new_txid, htlc_outputs);
 self.current_remote_commitment_number = commitment_number;
 //TODO: Merge this into the other per-remote-transaction output storage stuff
Expand All@@ -1242,11 +1232,11 @@ impl<ChanSigner: ChannelKeys> ChannelMonitor<ChanSigner> {
	}

	pub(super) fn provide_rescue_remote_commitment_tx_info(&mut self, their_revocation_point: PublicKey) {
 if let Ok(payment_key) = chan_utils::derive_public_key(&self.secp_ctx, &their_revocation_point, &self.onchain_detection.keys.pubkeys().payment_basepoint) {
 if let Ok(payment_key) = chan_utils::derive_public_key(&self.secp_ctx, &their_revocation_point, &self.keys.pubkeys().payment_basepoint) {
 let to_remote_script = Builder::new().push_opcode(opcodes::all::OP_PUSHBYTES_0)
 .push_slice(&Hash160::hash(&payment_key.serialize())[..])
 .into_script();
 if let Ok(to_remote_key) = chan_utils::derive_private_key(&self.secp_ctx, &their_revocation_point, &self.onchain_detection.keys.payment_base_key()) {
 if let Ok(to_remote_key) = chan_utils::derive_private_key(&self.secp_ctx, &their_revocation_point, &self.keys.payment_base_key()) {
 self.broadcasted_remote_payment_script = Some((to_remote_script, to_remote_key));
 }
 }
Expand DownExpand Up@@ -1377,7 +1367,7 @@ impl<ChanSigner: ChannelKeys> ChannelMonitor<ChanSigner> {

	/// Gets the funding transaction outpoint of the channel this ChannelMonitor is monitoring for.
	pub fn get_funding_txo(&self) -> Option<OutPoint> {
 if let Some((outp, _)) = self.onchain_detection.funding_info {
 if let Some((outp, _)) = self.funding_info {
 return Some(outp)
 }
 None
Expand DownExpand Up@@ -1469,10 +1459,10 @@ impl<ChanSigner: ChannelKeys> ChannelMonitor<ChanSigner> {
 let secret = self.get_secret(commitment_number).unwrap();
 let per_commitment_key = ignore_error!(SecretKey::from_slice(&secret));
 let per_commitment_point = PublicKey::from_secret_key(&self.secp_ctx, &per_commitment_key);
 let revocation_pubkey = ignore_error!(chan_utils::derive_public_revocation_key(&self.secp_ctx, &per_commitment_point, &self.onchain_detection.keys.pubkeys().revocation_basepoint));
 let revocation_key = ignore_error!(chan_utils::derive_private_revocation_key(&self.secp_ctx, &per_commitment_key, &self.onchain_detection.keys.revocation_base_key()));
 let b_htlc_key = ignore_error!(chan_utils::derive_public_key(&self.secp_ctx, &per_commitment_point, &self.onchain_detection.keys.pubkeys().htlc_basepoint));
 let local_payment_key = ignore_error!(chan_utils::derive_private_key(&self.secp_ctx, &per_commitment_point, &self.onchain_detection.keys.payment_base_key()));
 let revocation_pubkey = ignore_error!(chan_utils::derive_public_revocation_key(&self.secp_ctx, &per_commitment_point, &self.keys.pubkeys().revocation_basepoint));
 let revocation_key = ignore_error!(chan_utils::derive_private_revocation_key(&self.secp_ctx, &per_commitment_key, &self.keys.revocation_base_key()));
 let b_htlc_key = ignore_error!(chan_utils::derive_public_key(&self.secp_ctx, &per_commitment_point, &self.keys.pubkeys().htlc_basepoint));
 let local_payment_key = ignore_error!(chan_utils::derive_private_key(&self.secp_ctx, &per_commitment_point, &self.keys.payment_base_key()));
 let delayed_key = ignore_error!(chan_utils::derive_public_key(&self.secp_ctx, &PublicKey::from_secret_key(&self.secp_ctx, &per_commitment_key), &self.their_delayed_payment_base_key.unwrap()));
 let a_htlc_key = match self.their_htlc_base_key {
 None => return (claimable_outpoints, (commitment_txid, watch_outputs)),
Expand DownExpand Up@@ -1548,10 +1538,10 @@ impl<ChanSigner: ChannelKeys> ChannelMonitor<ChanSigner> {
 }
 }
 }
 if let Some(ref txid) = self.onchain_detection.current_remote_commitment_txid {
 if let Some(ref txid) = self.current_remote_commitment_txid {
 check_htlc_fails!(txid, "current");
 }
 if let Some(ref txid) = self.onchain_detection.prev_remote_commitment_txid {
 if let Some(ref txid) = self.prev_remote_commitment_txid {
 check_htlc_fails!(txid, "remote");
 }
 // No need to check local commitment txn, symmetric HTLCSource must be present as per-htlc data on remote commitment tx
Expand DownExpand Up@@ -1611,10 +1601,10 @@ impl<ChanSigner: ChannelKeys> ChannelMonitor<ChanSigner> {
 }
 }
 }
 if let Some(ref txid) = self.onchain_detection.current_remote_commitment_txid {
 if let Some(ref txid) = self.current_remote_commitment_txid {
 check_htlc_fails!(txid, "current", 'current_loop);
 }
 if let Some(ref txid) = self.onchain_detection.prev_remote_commitment_txid {
 if let Some(ref txid) = self.prev_remote_commitment_txid {
 check_htlc_fails!(txid, "previous", 'prev_loop);
 }

Expand All@@ -1625,14 +1615,14 @@ impl<ChanSigner: ChannelKeys> ChannelMonitor<ChanSigner> {
 if revocation_points.0 == commitment_number + 1 { Some(point) } else { None }
 } else { None };
 if let Some(revocation_point) = revocation_point_option {
 let revocation_pubkey = ignore_error!(chan_utils::derive_public_revocation_key(&self.secp_ctx, revocation_point, &self.onchain_detection.keys.pubkeys().revocation_basepoint));
 let b_htlc_key = ignore_error!(chan_utils::derive_public_key(&self.secp_ctx, revocation_point, &self.onchain_detection.keys.pubkeys().htlc_basepoint));
 let htlc_privkey = ignore_error!(chan_utils::derive_private_key(&self.secp_ctx, revocation_point, &self.onchain_detection.keys.htlc_base_key()));
 let revocation_pubkey = ignore_error!(chan_utils::derive_public_revocation_key(&self.secp_ctx, revocation_point, &self.keys.pubkeys().revocation_basepoint));
 let b_htlc_key = ignore_error!(chan_utils::derive_public_key(&self.secp_ctx, revocation_point, &self.keys.pubkeys().htlc_basepoint));
 let htlc_privkey = ignore_error!(chan_utils::derive_private_key(&self.secp_ctx, revocation_point, &self.keys.htlc_base_key()));
 let a_htlc_key = match self.their_htlc_base_key {
 None => return (claimable_outpoints, (commitment_txid, watch_outputs)),
 Some(their_htlc_base_key) => ignore_error!(chan_utils::derive_public_key(&self.secp_ctx, revocation_point, &their_htlc_base_key)),
 };
 let local_payment_key = ignore_error!(chan_utils::derive_private_key(&self.secp_ctx, revocation_point, &self.onchain_detection.keys.payment_base_key()));
 let local_payment_key = ignore_error!(chan_utils::derive_private_key(&self.secp_ctx, revocation_point, &self.keys.payment_base_key()));

 self.broadcasted_remote_payment_script = {
 // Note that the Network here is ignored as we immediately drop the address for the
Expand DownExpand Up@@ -1683,8 +1673,8 @@ impl<ChanSigner: ChannelKeys> ChannelMonitor<ChanSigner> {
 let secret = if let Some(secret) = self.get_secret(commitment_number) { secret } else { return (Vec::new(), None); };
 let per_commitment_key = ignore_error!(SecretKey::from_slice(&secret));
 let per_commitment_point = PublicKey::from_secret_key(&self.secp_ctx, &per_commitment_key);
 let revocation_pubkey = ignore_error!(chan_utils::derive_public_revocation_key(&self.secp_ctx, &per_commitment_point, &self.onchain_detection.keys.pubkeys().revocation_basepoint));
 let revocation_key = ignore_error!(chan_utils::derive_private_revocation_key(&self.secp_ctx, &per_commitment_key, &self.onchain_detection.keys.revocation_base_key()));
 let revocation_pubkey = ignore_error!(chan_utils::derive_public_revocation_key(&self.secp_ctx, &per_commitment_point, &self.keys.pubkeys().revocation_basepoint));
 let revocation_key = ignore_error!(chan_utils::derive_private_revocation_key(&self.secp_ctx, &per_commitment_key, &self.keys.revocation_base_key()));
 let delayed_key = match self.their_delayed_payment_base_key {
 None => return (Vec::new(), None),
 Some(their_delayed_payment_base_key) => ignore_error!(chan_utils::derive_public_key(&self.secp_ctx, &per_commitment_point, &their_delayed_payment_base_key)),
Expand All@@ -1702,7 +1692,7 @@ impl<ChanSigner: ChannelKeys> ChannelMonitor<ChanSigner> {
 let mut watch_outputs = Vec::with_capacity(local_tx.htlc_outputs.len());

 let redeemscript = chan_utils::get_revokeable_redeemscript(&local_tx.revocation_key, self.their_to_self_delay.unwrap(), &local_tx.delayed_payment_key);
 let broadcasted_local_revokable_script = if let Ok(local_delayedkey) = chan_utils::derive_private_key(&self.secp_ctx, &local_tx.per_commitment_point, self.onchain_detection.keys.delayed_payment_base_key()) {
 let broadcasted_local_revokable_script = if let Ok(local_delayedkey) = chan_utils::derive_private_key(&self.secp_ctx, &local_tx.per_commitment_point, self.keys.delayed_payment_base_key()) {
 Some((redeemscript.to_v0_p2wsh(), local_delayedkey, redeemscript))
 } else { None };

Expand DownExpand Up@@ -1883,7 +1873,7 @@ impl<ChanSigner: ChannelKeys> ChannelMonitor<ChanSigner> {
 // which is an easy way to filter out any potential non-matching txn for lazy
 // filters.
 let prevout = &tx.input[0].previous_output;
 let funding_txo = self.onchain_detection.funding_info.clone();
 let funding_txo = self.funding_info.clone();
 if funding_txo.is_none() || (prevout.txid == funding_txo.as_ref().unwrap().0.txid && prevout.vout == funding_txo.as_ref().unwrap().0.index as u32) {
 if (tx.input[0].sequence >> 8*3) as u8 == 0x80 && (tx.lock_time >> 8*3) as u8 == 0x20 {
 let (mut new_outpoints, new_outputs) = self.check_spend_remote_transaction(&tx, height);
Expand DownExpand Up@@ -1920,7 +1910,7 @@ impl<ChanSigner: ChannelKeys> ChannelMonitor<ChanSigner> {
 self.would_broadcast_at_height(height)
 } else { false };
 if should_broadcast {
 claimable_outpoints.push(ClaimRequest { absolute_timelock: height, aggregable: false, outpoint: BitcoinOutPoint { txid: self.onchain_detection.funding_info.as_ref().unwrap().0.txid.clone(), vout: self.onchain_detection.funding_info.as_ref().unwrap().0.index as u32 }, witness_data: InputMaterial::Funding { channel_value: self.channel_value_satoshis.unwrap() }});
 claimable_outpoints.push(ClaimRequest { absolute_timelock: height, aggregable: false, outpoint: BitcoinOutPoint { txid: self.funding_info.as_ref().unwrap().0.txid.clone(), vout: self.funding_info.as_ref().unwrap().0.index as u32 }, witness_data: InputMaterial::Funding { channel_value: self.channel_value_satoshis.unwrap() }});
 }
 if let Some(ref cur_local_tx) = self.current_local_signed_commitment_tx {
 if should_broadcast {
Expand DownExpand Up@@ -2030,12 +2020,12 @@ impl<ChanSigner: ChannelKeys> ChannelMonitor<ChanSigner> {
 scan_commitment!(cur_local_tx.htlc_outputs.iter().map(|&(ref a, _, _)| a), true);
 }

 if let Some(ref txid) = self.onchain_detection.current_remote_commitment_txid {
 if let Some(ref txid) = self.current_remote_commitment_txid {
 if let Some(ref htlc_outputs) = self.remote_claimable_outpoints.get(txid) {
 scan_commitment!(htlc_outputs.iter().map(|&(ref a, _)| a), false);
 }
 }
 if let Some(ref txid) = self.onchain_detection.prev_remote_commitment_txid {
 if let Some(ref txid) = self.prev_remote_commitment_txid {
 if let Some(ref htlc_outputs) = self.remote_claimable_outpoints.get(txid) {
 scan_commitment!(htlc_outputs.iter().map(|&(ref a, _)| a), false);
 }
Expand DownExpand Up@@ -2105,9 +2095,9 @@ impl<ChanSigner: ChannelKeys> ChannelMonitor<ChanSigner> {
 // resolve the source HTLC with the original sender.
 payment_data = Some(((*source).clone(), htlc_output.payment_hash));
 } else if !$local_tx {
 check_htlc_valid_remote!(self.onchain_detection.current_remote_commitment_txid, htlc_output);
 check_htlc_valid_remote!(self.current_remote_commitment_txid, htlc_output);
 if payment_data.is_none() {
 check_htlc_valid_remote!(self.onchain_detection.prev_remote_commitment_txid, htlc_output);
 check_htlc_valid_remote!(self.prev_remote_commitment_txid, htlc_output);
 }
 }
 if payment_data.is_none() {
Expand DownExpand Up@@ -2278,24 +2268,16 @@ impl<ChanSigner: ChannelKeys + Readable> ReadableArgs<Arc<Logger>> for (Sha256dH
 };
 let shutdown_script = Readable::read(reader)?;

 let onchain_detection = {
 let keys = Readable::read(reader)?;
 // Technically this can fail and serialize fail a round-trip, but only for serialization of
 // barely-init'd ChannelMonitors that we can't do anything with.
 let outpoint = OutPoint {
 txid: Readable::read(reader)?,
 index: Readable::read(reader)?,
 };
 let funding_info = Some((outpoint, Readable::read(reader)?));
 let current_remote_commitment_txid = Readable::read(reader)?;
 let prev_remote_commitment_txid = Readable::read(reader)?;
 OnchainDetection {
 keys,
 funding_info,
 current_remote_commitment_txid,
 prev_remote_commitment_txid,
 }
 let keys = Readable::read(reader)?;
 // Technically this can fail and serialize fail a round-trip, but only for serialization of
 // barely-init'd ChannelMonitors that we can't do anything with.
 let outpoint = OutPoint {
 txid: Readable::read(reader)?,
 index: Readable::read(reader)?,
 };
 let funding_info = Some((outpoint, Readable::read(reader)?));
 let current_remote_commitment_txid = Readable::read(reader)?;
 let prev_remote_commitment_txid = Readable::read(reader)?;

 let their_htlc_base_key = Some(Readable::read(reader)?);
 let their_delayed_payment_base_key = Some(Readable::read(reader)?);
Expand DownExpand Up@@ -2508,7 +2490,11 @@ impl<ChanSigner: ChannelKeys + Readable> ReadableArgs<Arc<Logger>> for (Sha256dH
 broadcasted_remote_payment_script,
 shutdown_script,

 onchain_detection,
 keys,
 funding_info,
 current_remote_commitment_txid,
 prev_remote_commitment_txid,

 their_htlc_base_key,
 their_delayed_payment_base_key,
 funding_redeemscript,
Expand Down

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

Skip to content
Flatten ChannelMonitor substructs that don't add clarity#558

New issue

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

 Sign up for GitHub

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

Already on GitHub?
Sign in
to your account

 Merged

TheBlueMatt
merged 2 commits into

from

Apr 19, 2020
 Merged


Flatten ChannelMonitor substructs that don't add clarity
#558
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
3c5ba6b

Drop uneccessary clone() introduced in 16fba9fd664522ac8d24111547b4


TheBlueMatt Mar 21, 2020
b49e63b

Flatten ChannelMonitor substructs that don't add clarity


TheBlueMatt Mar 21, 2020

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


136 changes: 61 additions & 75 deletions
lightning/src/ln/channelmonitor.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -290,7 +290,7 @@ impl<Key : Send + cmp::Eq + hash::Hash + 'static, ChanSigner: ChannelKeys, T: De
 hash_map::Entry::Occupied(_) => return Err(MonitorUpdateError("Channel monitor for given key is already present")),
 hash_map::Entry::Vacant(e) => e,
 };
 match monitor.onchain_detection.funding_info {
 match monitor.funding_info {
 None => {
 return Err(MonitorUpdateError("Try to update a useless monitor without funding_txo !"));
 },
Expand All@@ -314,7 +314,7 @@ impl<Key : Send + cmp::Eq + hash::Hash + 'static, ChanSigner: ChannelKeys, T: De
 let mut monitors = self.monitors.lock().unwrap();
 match monitors.get_mut(&key) {
 Some(orig_monitor) => {
 log_trace!(self, "Updating Channel Monitor for channel {}", log_funding_info!(orig_monitor.onchain_detection));
 log_trace!(self, "Updating Channel Monitor for channel {}", log_funding_info!(orig_monitor));
 orig_monitor.update_monitor(update, &self.broadcaster)
 },
 None => Err(MonitorUpdateError("No such monitor registered"))
Expand DownExpand Up@@ -391,20 +391,6 @@ pub(crate) const LATENCY_GRACE_PERIOD_BLOCKS: u32 = 3;
/// keeping bumping another claim tx to solve the outpoint.
pub(crate) const ANTI_REORG_DELAY: u32 = 6;

struct OnchainDetection<ChanSigner: ChannelKeys> {
	keys: ChanSigner,
	funding_info: Option<(OutPoint, Script)>,
	current_remote_commitment_txid: Option<Sha256dHash>,
	prev_remote_commitment_txid: Option<Sha256dHash>,
}

#[cfg(any(test, feature = "fuzztarget"))]
impl<ChanSigner: ChannelKeys> PartialEq for OnchainDetection<ChanSigner> {
	fn eq(&self, other: &Self) -> bool {
 self.keys.pubkeys() == other.keys.pubkeys()
	}
}

#[derive(Clone, PartialEq)]
struct LocalSignedTx {
	/// txid of the transaction in tx, just used to make comparison faster
Expand DownExpand Up@@ -734,7 +720,11 @@ pub struct ChannelMonitor<ChanSigner: ChannelKeys> {
	broadcasted_remote_payment_script: Option<(Script, SecretKey)>,
	shutdown_script: Script,

	onchain_detection: OnchainDetection<ChanSigner>,
	keys: ChanSigner,
	funding_info: Option<(OutPoint, Script)>,
	current_remote_commitment_txid: Option<Sha256dHash>,
	prev_remote_commitment_txid: Option<Sha256dHash>,

	their_htlc_base_key: Option<PublicKey>,
	their_delayed_payment_base_key: Option<PublicKey>,
	funding_redeemscript: Option<Script>,
Expand DownExpand Up@@ -817,7 +807,10 @@ impl<ChanSigner: ChannelKeys> PartialEq for ChannelMonitor<ChanSigner> {
 self.destination_script != other.destination_script ||
 self.broadcasted_local_revokable_script != other.broadcasted_local_revokable_script ||
 self.broadcasted_remote_payment_script != other.broadcasted_remote_payment_script ||
 self.onchain_detection != other.onchain_detection ||
 self.keys.pubkeys() != other.keys.pubkeys() ||
 self.funding_info != other.funding_info ||
 self.current_remote_commitment_txid != other.current_remote_commitment_txid ||
 self.prev_remote_commitment_txid != other.prev_remote_commitment_txid ||
 self.their_htlc_base_key != other.their_htlc_base_key ||
 self.their_delayed_payment_base_key != other.their_delayed_payment_base_key ||
 self.funding_redeemscript != other.funding_redeemscript ||
Expand DownExpand Up@@ -878,8 +871,8 @@ impl<ChanSigner: ChannelKeys + Writeable> ChannelMonitor<ChanSigner> {
 }
 self.shutdown_script.write(writer)?;

 self.onchain_detection.keys.write(writer)?;
 match self.onchain_detection.funding_info {
 self.keys.write(writer)?;
 match self.funding_info {
 Some((ref outpoint, ref script)) => {
 writer.write_all(&outpoint.txid[..])?;
 writer.write_all(&byte_utils::be16_to_array(outpoint.index))?;
Expand All@@ -889,8 +882,8 @@ impl<ChanSigner: ChannelKeys + Writeable> ChannelMonitor<ChanSigner> {
 debug_assert!(false, "Try to serialize a useless Local monitor !");
 },
 }
 self.onchain_detection.current_remote_commitment_txid.write(writer)?;
 self.onchain_detection.prev_remote_commitment_txid.write(writer)?;
 self.current_remote_commitment_txid.write(writer)?;
 self.prev_remote_commitment_txid.write(writer)?;

 writer.write_all(&self.their_htlc_base_key.as_ref().unwrap().serialize())?;
 writer.write_all(&self.their_delayed_payment_base_key.as_ref().unwrap().serialize())?;
Expand DownExpand Up@@ -1096,13 +1089,6 @@ impl<ChanSigner: ChannelKeys> ChannelMonitor<ChanSigner> {
 let our_channel_close_key_hash = Hash160::hash(&shutdown_pubkey.serialize());
 let shutdown_script = Builder::new().push_opcode(opcodes::all::OP_PUSHBYTES_0).push_slice(&our_channel_close_key_hash[..]).into_script();

 let onchain_detection = OnchainDetection {
 keys: keys.clone(),
 funding_info: Some(funding_info.clone()),
 current_remote_commitment_txid: None,
 prev_remote_commitment_txid: None,
 };

 ChannelMonitor {
 latest_update_id: 0,
 commitment_transaction_number_obscure_factor,
Expand All@@ -1112,7 +1098,11 @@ impl<ChanSigner: ChannelKeys> ChannelMonitor<ChanSigner> {
 broadcasted_remote_payment_script: None,
 shutdown_script,

 onchain_detection: onchain_detection,
 keys: keys.clone(),
 funding_info: Some(funding_info),
 current_remote_commitment_txid: None,
 prev_remote_commitment_txid: None,

 their_htlc_base_key: Some(their_htlc_base_key.clone()),
 their_delayed_payment_base_key: Some(their_delayed_payment_base_key.clone()),
 funding_redeemscript: Some(funding_redeemscript.clone()),
Expand DownExpand Up@@ -1159,7 +1149,7 @@ impl<ChanSigner: ChannelKeys> ChannelMonitor<ChanSigner> {

 // Prune HTLCs from the previous remote commitment tx so we don't generate failure/fulfill
 // events for now-revoked/fulfilled HTLCs.
 if let Some(txid) = self.onchain_detection.prev_remote_commitment_txid.take() {
 if let Some(txid) = self.prev_remote_commitment_txid.take() {
 for &mut (_, ref mut source) in self.remote_claimable_outpoints.get_mut(&txid).unwrap() {
 *source = None;
 }
Expand DownExpand Up@@ -1216,8 +1206,8 @@ impl<ChanSigner: ChannelKeys> ChannelMonitor<ChanSigner> {
 let new_txid = unsigned_commitment_tx.txid();
 log_trace!(self, "Tracking new remote commitment transaction with txid {} at commitment number {} with {} HTLC outputs", new_txid, commitment_number, htlc_outputs.len());
 log_trace!(self, "New potential remote commitment transaction: {}", encode::serialize_hex(unsigned_commitment_tx));
 self.onchain_detection.prev_remote_commitment_txid = self.onchain_detection.current_remote_commitment_txid.take();
 self.onchain_detection.current_remote_commitment_txid = Some(new_txid);
 self.prev_remote_commitment_txid = self.current_remote_commitment_txid.take();
 self.current_remote_commitment_txid = Some(new_txid);
 self.remote_claimable_outpoints.insert(new_txid, htlc_outputs);
 self.current_remote_commitment_number = commitment_number;
 //TODO: Merge this into the other per-remote-transaction output storage stuff
Expand All@@ -1242,11 +1232,11 @@ impl<ChanSigner: ChannelKeys> ChannelMonitor<ChanSigner> {
	}

	pub(super) fn provide_rescue_remote_commitment_tx_info(&mut self, their_revocation_point: PublicKey) {
 if let Ok(payment_key) = chan_utils::derive_public_key(&self.secp_ctx, &their_revocation_point, &self.onchain_detection.keys.pubkeys().payment_basepoint) {
 if let Ok(payment_key) = chan_utils::derive_public_key(&self.secp_ctx, &their_revocation_point, &self.keys.pubkeys().payment_basepoint) {
 let to_remote_script = Builder::new().push_opcode(opcodes::all::OP_PUSHBYTES_0)
 .push_slice(&Hash160::hash(&payment_key.serialize())[..])
 .into_script();
 if let Ok(to_remote_key) = chan_utils::derive_private_key(&self.secp_ctx, &their_revocation_point, &self.onchain_detection.keys.payment_base_key()) {
 if let Ok(to_remote_key) = chan_utils::derive_private_key(&self.secp_ctx, &their_revocation_point, &self.keys.payment_base_key()) {
 self.broadcasted_remote_payment_script = Some((to_remote_script, to_remote_key));
 }
 }
Expand DownExpand Up@@ -1377,7 +1367,7 @@ impl<ChanSigner: ChannelKeys> ChannelMonitor<ChanSigner> {

	/// Gets the funding transaction outpoint of the channel this ChannelMonitor is monitoring for.
	pub fn get_funding_txo(&self) -> Option<OutPoint> {
 if let Some((outp, _)) = self.onchain_detection.funding_info {
 if let Some((outp, _)) = self.funding_info {
 return Some(outp)
 }
 None
Expand DownExpand Up@@ -1469,10 +1459,10 @@ impl<ChanSigner: ChannelKeys> ChannelMonitor<ChanSigner> {
 let secret = self.get_secret(commitment_number).unwrap();
 let per_commitment_key = ignore_error!(SecretKey::from_slice(&secret));
 let per_commitment_point = PublicKey::from_secret_key(&self.secp_ctx, &per_commitment_key);
 let revocation_pubkey = ignore_error!(chan_utils::derive_public_revocation_key(&self.secp_ctx, &per_commitment_point, &self.onchain_detection.keys.pubkeys().revocation_basepoint));
 let revocation_key = ignore_error!(chan_utils::derive_private_revocation_key(&self.secp_ctx, &per_commitment_key, &self.onchain_detection.keys.revocation_base_key()));
 let b_htlc_key = ignore_error!(chan_utils::derive_public_key(&self.secp_ctx, &per_commitment_point, &self.onchain_detection.keys.pubkeys().htlc_basepoint));
 let local_payment_key = ignore_error!(chan_utils::derive_private_key(&self.secp_ctx, &per_commitment_point, &self.onchain_detection.keys.payment_base_key()));
 let revocation_pubkey = ignore_error!(chan_utils::derive_public_revocation_key(&self.secp_ctx, &per_commitment_point, &self.keys.pubkeys().revocation_basepoint));
 let revocation_key = ignore_error!(chan_utils::derive_private_revocation_key(&self.secp_ctx, &per_commitment_key, &self.keys.revocation_base_key()));
 let b_htlc_key = ignore_error!(chan_utils::derive_public_key(&self.secp_ctx, &per_commitment_point, &self.keys.pubkeys().htlc_basepoint));
 let local_payment_key = ignore_error!(chan_utils::derive_private_key(&self.secp_ctx, &per_commitment_point, &self.keys.payment_base_key()));
 let delayed_key = ignore_error!(chan_utils::derive_public_key(&self.secp_ctx, &PublicKey::from_secret_key(&self.secp_ctx, &per_commitment_key), &self.their_delayed_payment_base_key.unwrap()));
 let a_htlc_key = match self.their_htlc_base_key {
 None => return (claimable_outpoints, (commitment_txid, watch_outputs)),
Expand DownExpand Up@@ -1548,10 +1538,10 @@ impl<ChanSigner: ChannelKeys> ChannelMonitor<ChanSigner> {
 }
 }
 }
 if let Some(ref txid) = self.onchain_detection.current_remote_commitment_txid {
 if let Some(ref txid) = self.current_remote_commitment_txid {
 check_htlc_fails!(txid, "current");
 }
 if let Some(ref txid) = self.onchain_detection.prev_remote_commitment_txid {
 if let Some(ref txid) = self.prev_remote_commitment_txid {
 check_htlc_fails!(txid, "remote");
 }
 // No need to check local commitment txn, symmetric HTLCSource must be present as per-htlc data on remote commitment tx
Expand DownExpand Up@@ -1611,10 +1601,10 @@ impl<ChanSigner: ChannelKeys> ChannelMonitor<ChanSigner> {
 }
 }
 }
 if let Some(ref txid) = self.onchain_detection.current_remote_commitment_txid {
 if let Some(ref txid) = self.current_remote_commitment_txid {
 check_htlc_fails!(txid, "current", 'current_loop);
 }
 if let Some(ref txid) = self.onchain_detection.prev_remote_commitment_txid {
 if let Some(ref txid) = self.prev_remote_commitment_txid {
 check_htlc_fails!(txid, "previous", 'prev_loop);
 }

Expand All@@ -1625,14 +1615,14 @@ impl<ChanSigner: ChannelKeys> ChannelMonitor<ChanSigner> {
 if revocation_points.0 == commitment_number + 1 { Some(point) } else { None }
 } else { None };
 if let Some(revocation_point) = revocation_point_option {
 let revocation_pubkey = ignore_error!(chan_utils::derive_public_revocation_key(&self.secp_ctx, revocation_point, &self.onchain_detection.keys.pubkeys().revocation_basepoint));
 let b_htlc_key = ignore_error!(chan_utils::derive_public_key(&self.secp_ctx, revocation_point, &self.onchain_detection.keys.pubkeys().htlc_basepoint));
 let htlc_privkey = ignore_error!(chan_utils::derive_private_key(&self.secp_ctx, revocation_point, &self.onchain_detection.keys.htlc_base_key()));
 let revocation_pubkey = ignore_error!(chan_utils::derive_public_revocation_key(&self.secp_ctx, revocation_point, &self.keys.pubkeys().revocation_basepoint));
 let b_htlc_key = ignore_error!(chan_utils::derive_public_key(&self.secp_ctx, revocation_point, &self.keys.pubkeys().htlc_basepoint));
 let htlc_privkey = ignore_error!(chan_utils::derive_private_key(&self.secp_ctx, revocation_point, &self.keys.htlc_base_key()));
 let a_htlc_key = match self.their_htlc_base_key {
 None => return (claimable_outpoints, (commitment_txid, watch_outputs)),
 Some(their_htlc_base_key) => ignore_error!(chan_utils::derive_public_key(&self.secp_ctx, revocation_point, &their_htlc_base_key)),
 };
 let local_payment_key = ignore_error!(chan_utils::derive_private_key(&self.secp_ctx, revocation_point, &self.onchain_detection.keys.payment_base_key()));
 let local_payment_key = ignore_error!(chan_utils::derive_private_key(&self.secp_ctx, revocation_point, &self.keys.payment_base_key()));

 self.broadcasted_remote_payment_script = {
 // Note that the Network here is ignored as we immediately drop the address for the
Expand DownExpand Up@@ -1683,8 +1673,8 @@ impl<ChanSigner: ChannelKeys> ChannelMonitor<ChanSigner> {
 let secret = if let Some(secret) = self.get_secret(commitment_number) { secret } else { return (Vec::new(), None); };
 let per_commitment_key = ignore_error!(SecretKey::from_slice(&secret));
 let per_commitment_point = PublicKey::from_secret_key(&self.secp_ctx, &per_commitment_key);
 let revocation_pubkey = ignore_error!(chan_utils::derive_public_revocation_key(&self.secp_ctx, &per_commitment_point, &self.onchain_detection.keys.pubkeys().revocation_basepoint));
 let revocation_key = ignore_error!(chan_utils::derive_private_revocation_key(&self.secp_ctx, &per_commitment_key, &self.onchain_detection.keys.revocation_base_key()));
 let revocation_pubkey = ignore_error!(chan_utils::derive_public_revocation_key(&self.secp_ctx, &per_commitment_point, &self.keys.pubkeys().revocation_basepoint));
 let revocation_key = ignore_error!(chan_utils::derive_private_revocation_key(&self.secp_ctx, &per_commitment_key, &self.keys.revocation_base_key()));
 let delayed_key = match self.their_delayed_payment_base_key {
 None => return (Vec::new(), None),
 Some(their_delayed_payment_base_key) => ignore_error!(chan_utils::derive_public_key(&self.secp_ctx, &per_commitment_point, &their_delayed_payment_base_key)),
Expand All@@ -1702,7 +1692,7 @@ impl<ChanSigner: ChannelKeys> ChannelMonitor<ChanSigner> {
 let mut watch_outputs = Vec::with_capacity(local_tx.htlc_outputs.len());

 let redeemscript = chan_utils::get_revokeable_redeemscript(&local_tx.revocation_key, self.their_to_self_delay.unwrap(), &local_tx.delayed_payment_key);
 let broadcasted_local_revokable_script = if let Ok(local_delayedkey) = chan_utils::derive_private_key(&self.secp_ctx, &local_tx.per_commitment_point, self.onchain_detection.keys.delayed_payment_base_key()) {
 let broadcasted_local_revokable_script = if let Ok(local_delayedkey) = chan_utils::derive_private_key(&self.secp_ctx, &local_tx.per_commitment_point, self.keys.delayed_payment_base_key()) {
 Some((redeemscript.to_v0_p2wsh(), local_delayedkey, redeemscript))
 } else { None };

Expand DownExpand Up@@ -1883,7 +1873,7 @@ impl<ChanSigner: ChannelKeys> ChannelMonitor<ChanSigner> {
 // which is an easy way to filter out any potential non-matching txn for lazy
 // filters.
 let prevout = &tx.input[0].previous_output;
 let funding_txo = self.onchain_detection.funding_info.clone();
 let funding_txo = self.funding_info.clone();
 if funding_txo.is_none() || (prevout.txid == funding_txo.as_ref().unwrap().0.txid && prevout.vout == funding_txo.as_ref().unwrap().0.index as u32) {
 if (tx.input[0].sequence >> 8*3) as u8 == 0x80 && (tx.lock_time >> 8*3) as u8 == 0x20 {
 let (mut new_outpoints, new_outputs) = self.check_spend_remote_transaction(&tx, height);
Expand DownExpand Up@@ -1920,7 +1910,7 @@ impl<ChanSigner: ChannelKeys> ChannelMonitor<ChanSigner> {
 self.would_broadcast_at_height(height)
 } else { false };
 if should_broadcast {
 claimable_outpoints.push(ClaimRequest { absolute_timelock: height, aggregable: false, outpoint: BitcoinOutPoint { txid: self.onchain_detection.funding_info.as_ref().unwrap().0.txid.clone(), vout: self.onchain_detection.funding_info.as_ref().unwrap().0.index as u32 }, witness_data: InputMaterial::Funding { channel_value: self.channel_value_satoshis.unwrap() }});
 claimable_outpoints.push(ClaimRequest { absolute_timelock: height, aggregable: false, outpoint: BitcoinOutPoint { txid: self.funding_info.as_ref().unwrap().0.txid.clone(), vout: self.funding_info.as_ref().unwrap().0.index as u32 }, witness_data: InputMaterial::Funding { channel_value: self.channel_value_satoshis.unwrap() }});
 }
 if let Some(ref cur_local_tx) = self.current_local_signed_commitment_tx {
 if should_broadcast {
Expand DownExpand Up@@ -2030,12 +2020,12 @@ impl<ChanSigner: ChannelKeys> ChannelMonitor<ChanSigner> {
 scan_commitment!(cur_local_tx.htlc_outputs.iter().map(|&(ref a, _, _)| a), true);
 }

 if let Some(ref txid) = self.onchain_detection.current_remote_commitment_txid {
 if let Some(ref txid) = self.current_remote_commitment_txid {
 if let Some(ref htlc_outputs) = self.remote_claimable_outpoints.get(txid) {
 scan_commitment!(htlc_outputs.iter().map(|&(ref a, _)| a), false);
 }
 }
 if let Some(ref txid) = self.onchain_detection.prev_remote_commitment_txid {
 if let Some(ref txid) = self.prev_remote_commitment_txid {
 if let Some(ref htlc_outputs) = self.remote_claimable_outpoints.get(txid) {
 scan_commitment!(htlc_outputs.iter().map(|&(ref a, _)| a), false);
 }
Expand DownExpand Up@@ -2105,9 +2095,9 @@ impl<ChanSigner: ChannelKeys> ChannelMonitor<ChanSigner> {
 // resolve the source HTLC with the original sender.
 payment_data = Some(((*source).clone(), htlc_output.payment_hash));
 } else if !$local_tx {
 check_htlc_valid_remote!(self.onchain_detection.current_remote_commitment_txid, htlc_output);
 check_htlc_valid_remote!(self.current_remote_commitment_txid, htlc_output);
 if payment_data.is_none() {
 check_htlc_valid_remote!(self.onchain_detection.prev_remote_commitment_txid, htlc_output);
 check_htlc_valid_remote!(self.prev_remote_commitment_txid, htlc_output);
 }
 }
 if payment_data.is_none() {
Expand DownExpand Up@@ -2278,24 +2268,16 @@ impl<ChanSigner: ChannelKeys + Readable> ReadableArgs<Arc<Logger>> for (Sha256dH
 };
 let shutdown_script = Readable::read(reader)?;

 let onchain_detection = {
 let keys = Readable::read(reader)?;
 // Technically this can fail and serialize fail a round-trip, but only for serialization of
 // barely-init'd ChannelMonitors that we can't do anything with.
 let outpoint = OutPoint {
 txid: Readable::read(reader)?,
 index: Readable::read(reader)?,
 };
 let funding_info = Some((outpoint, Readable::read(reader)?));
 let current_remote_commitment_txid = Readable::read(reader)?;
 let prev_remote_commitment_txid = Readable::read(reader)?;
 OnchainDetection {
 keys,
 funding_info,
 current_remote_commitment_txid,
 prev_remote_commitment_txid,
 }
 let keys = Readable::read(reader)?;
 // Technically this can fail and serialize fail a round-trip, but only for serialization of
 // barely-init'd ChannelMonitors that we can't do anything with.
 let outpoint = OutPoint {
 txid: Readable::read(reader)?,
 index: Readable::read(reader)?,
 };
 let funding_info = Some((outpoint, Readable::read(reader)?));
 let current_remote_commitment_txid = Readable::read(reader)?;
 let prev_remote_commitment_txid = Readable::read(reader)?;

 let their_htlc_base_key = Some(Readable::read(reader)?);
 let their_delayed_payment_base_key = Some(Readable::read(reader)?);
Expand DownExpand Up@@ -2508,7 +2490,11 @@ impl<ChanSigner: ChannelKeys + Readable> ReadableArgs<Arc<Logger>> for (Sha256dH
 broadcasted_remote_payment_script,
 shutdown_script,

 onchain_detection,
 keys,
 funding_info,
 current_remote_commitment_txid,
 prev_remote_commitment_txid,

 their_htlc_base_key,
 their_delayed_payment_base_key,
 funding_redeemscript,
Expand Down

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

Skip to content
Flatten ChannelMonitor substructs that don't add clarity#558

New issue

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

 Sign up for GitHub

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

Already on GitHub?
Sign in
to your account

 Merged

TheBlueMatt
merged 2 commits into

from

Apr 19, 2020
 Merged


Flatten ChannelMonitor substructs that don't add clarity
#558
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
3c5ba6b

Drop uneccessary clone() introduced in 16fba9fd664522ac8d24111547b4


TheBlueMatt Mar 21, 2020
b49e63b

Flatten ChannelMonitor substructs that don't add clarity


TheBlueMatt Mar 21, 2020

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


136 changes: 61 additions & 75 deletions
lightning/src/ln/channelmonitor.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -290,7 +290,7 @@ impl<Key : Send + cmp::Eq + hash::Hash + 'static, ChanSigner: ChannelKeys, T: De
 hash_map::Entry::Occupied(_) => return Err(MonitorUpdateError("Channel monitor for given key is already present")),
 hash_map::Entry::Vacant(e) => e,
 };
 match monitor.onchain_detection.funding_info {
 match monitor.funding_info {
 None => {
 return Err(MonitorUpdateError("Try to update a useless monitor without funding_txo !"));
 },
Expand All@@ -314,7 +314,7 @@ impl<Key : Send + cmp::Eq + hash::Hash + 'static, ChanSigner: ChannelKeys, T: De
 let mut monitors = self.monitors.lock().unwrap();
 match monitors.get_mut(&key) {
 Some(orig_monitor) => {
 log_trace!(self, "Updating Channel Monitor for channel {}", log_funding_info!(orig_monitor.onchain_detection));
 log_trace!(self, "Updating Channel Monitor for channel {}", log_funding_info!(orig_monitor));
 orig_monitor.update_monitor(update, &self.broadcaster)
 },
 None => Err(MonitorUpdateError("No such monitor registered"))
Expand DownExpand Up@@ -391,20 +391,6 @@ pub(crate) const LATENCY_GRACE_PERIOD_BLOCKS: u32 = 3;
/// keeping bumping another claim tx to solve the outpoint.
pub(crate) const ANTI_REORG_DELAY: u32 = 6;

struct OnchainDetection<ChanSigner: ChannelKeys> {
	keys: ChanSigner,
	funding_info: Option<(OutPoint, Script)>,
	current_remote_commitment_txid: Option<Sha256dHash>,
	prev_remote_commitment_txid: Option<Sha256dHash>,
}

#[cfg(any(test, feature = "fuzztarget"))]
impl<ChanSigner: ChannelKeys> PartialEq for OnchainDetection<ChanSigner> {
	fn eq(&self, other: &Self) -> bool {
 self.keys.pubkeys() == other.keys.pubkeys()
	}
}

#[derive(Clone, PartialEq)]
struct LocalSignedTx {
	/// txid of the transaction in tx, just used to make comparison faster
Expand DownExpand Up@@ -734,7 +720,11 @@ pub struct ChannelMonitor<ChanSigner: ChannelKeys> {
	broadcasted_remote_payment_script: Option<(Script, SecretKey)>,
	shutdown_script: Script,

	onchain_detection: OnchainDetection<ChanSigner>,
	keys: ChanSigner,
	funding_info: Option<(OutPoint, Script)>,
	current_remote_commitment_txid: Option<Sha256dHash>,
	prev_remote_commitment_txid: Option<Sha256dHash>,

	their_htlc_base_key: Option<PublicKey>,
	their_delayed_payment_base_key: Option<PublicKey>,
	funding_redeemscript: Option<Script>,
Expand DownExpand Up@@ -817,7 +807,10 @@ impl<ChanSigner: ChannelKeys> PartialEq for ChannelMonitor<ChanSigner> {
 self.destination_script != other.destination_script ||
 self.broadcasted_local_revokable_script != other.broadcasted_local_revokable_script ||
 self.broadcasted_remote_payment_script != other.broadcasted_remote_payment_script ||
 self.onchain_detection != other.onchain_detection ||
 self.keys.pubkeys() != other.keys.pubkeys() ||
 self.funding_info != other.funding_info ||
 self.current_remote_commitment_txid != other.current_remote_commitment_txid ||
 self.prev_remote_commitment_txid != other.prev_remote_commitment_txid ||
 self.their_htlc_base_key != other.their_htlc_base_key ||
 self.their_delayed_payment_base_key != other.their_delayed_payment_base_key ||
 self.funding_redeemscript != other.funding_redeemscript ||
Expand DownExpand Up@@ -878,8 +871,8 @@ impl<ChanSigner: ChannelKeys + Writeable> ChannelMonitor<ChanSigner> {
 }
 self.shutdown_script.write(writer)?;

 self.onchain_detection.keys.write(writer)?;
 match self.onchain_detection.funding_info {
 self.keys.write(writer)?;
 match self.funding_info {
 Some((ref outpoint, ref script)) => {
 writer.write_all(&outpoint.txid[..])?;
 writer.write_all(&byte_utils::be16_to_array(outpoint.index))?;
Expand All@@ -889,8 +882,8 @@ impl<ChanSigner: ChannelKeys + Writeable> ChannelMonitor<ChanSigner> {
 debug_assert!(false, "Try to serialize a useless Local monitor !");
 },
 }
 self.onchain_detection.current_remote_commitment_txid.write(writer)?;
 self.onchain_detection.prev_remote_commitment_txid.write(writer)?;
 self.current_remote_commitment_txid.write(writer)?;
 self.prev_remote_commitment_txid.write(writer)?;

 writer.write_all(&self.their_htlc_base_key.as_ref().unwrap().serialize())?;
 writer.write_all(&self.their_delayed_payment_base_key.as_ref().unwrap().serialize())?;
Expand DownExpand Up@@ -1096,13 +1089,6 @@ impl<ChanSigner: ChannelKeys> ChannelMonitor<ChanSigner> {
 let our_channel_close_key_hash = Hash160::hash(&shutdown_pubkey.serialize());
 let shutdown_script = Builder::new().push_opcode(opcodes::all::OP_PUSHBYTES_0).push_slice(&our_channel_close_key_hash[..]).into_script();

 let onchain_detection = OnchainDetection {
 keys: keys.clone(),
 funding_info: Some(funding_info.clone()),
 current_remote_commitment_txid: None,
 prev_remote_commitment_txid: None,
 };

 ChannelMonitor {
 latest_update_id: 0,
 commitment_transaction_number_obscure_factor,
Expand All@@ -1112,7 +1098,11 @@ impl<ChanSigner: ChannelKeys> ChannelMonitor<ChanSigner> {
 broadcasted_remote_payment_script: None,
 shutdown_script,

 onchain_detection: onchain_detection,
 keys: keys.clone(),
 funding_info: Some(funding_info),
 current_remote_commitment_txid: None,
 prev_remote_commitment_txid: None,

 their_htlc_base_key: Some(their_htlc_base_key.clone()),
 their_delayed_payment_base_key: Some(their_delayed_payment_base_key.clone()),
 funding_redeemscript: Some(funding_redeemscript.clone()),
Expand DownExpand Up@@ -1159,7 +1149,7 @@ impl<ChanSigner: ChannelKeys> ChannelMonitor<ChanSigner> {

 // Prune HTLCs from the previous remote commitment tx so we don't generate failure/fulfill
 // events for now-revoked/fulfilled HTLCs.
 if let Some(txid) = self.onchain_detection.prev_remote_commitment_txid.take() {
 if let Some(txid) = self.prev_remote_commitment_txid.take() {
 for &mut (_, ref mut source) in self.remote_claimable_outpoints.get_mut(&txid).unwrap() {
 *source = None;
 }
Expand DownExpand Up@@ -1216,8 +1206,8 @@ impl<ChanSigner: ChannelKeys> ChannelMonitor<ChanSigner> {
 let new_txid = unsigned_commitment_tx.txid();
 log_trace!(self, "Tracking new remote commitment transaction with txid {} at commitment number {} with {} HTLC outputs", new_txid, commitment_number, htlc_outputs.len());
 log_trace!(self, "New potential remote commitment transaction: {}", encode::serialize_hex(unsigned_commitment_tx));
 self.onchain_detection.prev_remote_commitment_txid = self.onchain_detection.current_remote_commitment_txid.take();
 self.onchain_detection.current_remote_commitment_txid = Some(new_txid);
 self.prev_remote_commitment_txid = self.current_remote_commitment_txid.take();
 self.current_remote_commitment_txid = Some(new_txid);
 self.remote_claimable_outpoints.insert(new_txid, htlc_outputs);
 self.current_remote_commitment_number = commitment_number;
 //TODO: Merge this into the other per-remote-transaction output storage stuff
Expand All@@ -1242,11 +1232,11 @@ impl<ChanSigner: ChannelKeys> ChannelMonitor<ChanSigner> {
	}

	pub(super) fn provide_rescue_remote_commitment_tx_info(&mut self, their_revocation_point: PublicKey) {
 if let Ok(payment_key) = chan_utils::derive_public_key(&self.secp_ctx, &their_revocation_point, &self.onchain_detection.keys.pubkeys().payment_basepoint) {
 if let Ok(payment_key) = chan_utils::derive_public_key(&self.secp_ctx, &their_revocation_point, &self.keys.pubkeys().payment_basepoint) {
 let to_remote_script = Builder::new().push_opcode(opcodes::all::OP_PUSHBYTES_0)
 .push_slice(&Hash160::hash(&payment_key.serialize())[..])
 .into_script();
 if let Ok(to_remote_key) = chan_utils::derive_private_key(&self.secp_ctx, &their_revocation_point, &self.onchain_detection.keys.payment_base_key()) {
 if let Ok(to_remote_key) = chan_utils::derive_private_key(&self.secp_ctx, &their_revocation_point, &self.keys.payment_base_key()) {
 self.broadcasted_remote_payment_script = Some((to_remote_script, to_remote_key));
 }
 }
Expand DownExpand Up@@ -1377,7 +1367,7 @@ impl<ChanSigner: ChannelKeys> ChannelMonitor<ChanSigner> {

	/// Gets the funding transaction outpoint of the channel this ChannelMonitor is monitoring for.
	pub fn get_funding_txo(&self) -> Option<OutPoint> {
 if let Some((outp, _)) = self.onchain_detection.funding_info {
 if let Some((outp, _)) = self.funding_info {
 return Some(outp)
 }
 None
Expand DownExpand Up@@ -1469,10 +1459,10 @@ impl<ChanSigner: ChannelKeys> ChannelMonitor<ChanSigner> {
 let secret = self.get_secret(commitment_number).unwrap();
 let per_commitment_key = ignore_error!(SecretKey::from_slice(&secret));
 let per_commitment_point = PublicKey::from_secret_key(&self.secp_ctx, &per_commitment_key);
 let revocation_pubkey = ignore_error!(chan_utils::derive_public_revocation_key(&self.secp_ctx, &per_commitment_point, &self.onchain_detection.keys.pubkeys().revocation_basepoint));
 let revocation_key = ignore_error!(chan_utils::derive_private_revocation_key(&self.secp_ctx, &per_commitment_key, &self.onchain_detection.keys.revocation_base_key()));
 let b_htlc_key = ignore_error!(chan_utils::derive_public_key(&self.secp_ctx, &per_commitment_point, &self.onchain_detection.keys.pubkeys().htlc_basepoint));
 let local_payment_key = ignore_error!(chan_utils::derive_private_key(&self.secp_ctx, &per_commitment_point, &self.onchain_detection.keys.payment_base_key()));
 let revocation_pubkey = ignore_error!(chan_utils::derive_public_revocation_key(&self.secp_ctx, &per_commitment_point, &self.keys.pubkeys().revocation_basepoint));
 let revocation_key = ignore_error!(chan_utils::derive_private_revocation_key(&self.secp_ctx, &per_commitment_key, &self.keys.revocation_base_key()));
 let b_htlc_key = ignore_error!(chan_utils::derive_public_key(&self.secp_ctx, &per_commitment_point, &self.keys.pubkeys().htlc_basepoint));
 let local_payment_key = ignore_error!(chan_utils::derive_private_key(&self.secp_ctx, &per_commitment_point, &self.keys.payment_base_key()));
 let delayed_key = ignore_error!(chan_utils::derive_public_key(&self.secp_ctx, &PublicKey::from_secret_key(&self.secp_ctx, &per_commitment_key), &self.their_delayed_payment_base_key.unwrap()));
 let a_htlc_key = match self.their_htlc_base_key {
 None => return (claimable_outpoints, (commitment_txid, watch_outputs)),
Expand DownExpand Up@@ -1548,10 +1538,10 @@ impl<ChanSigner: ChannelKeys> ChannelMonitor<ChanSigner> {
 }
 }
 }
 if let Some(ref txid) = self.onchain_detection.current_remote_commitment_txid {
 if let Some(ref txid) = self.current_remote_commitment_txid {
 check_htlc_fails!(txid, "current");
 }
 if let Some(ref txid) = self.onchain_detection.prev_remote_commitment_txid {
 if let Some(ref txid) = self.prev_remote_commitment_txid {
 check_htlc_fails!(txid, "remote");
 }
 // No need to check local commitment txn, symmetric HTLCSource must be present as per-htlc data on remote commitment tx
Expand DownExpand Up@@ -1611,10 +1601,10 @@ impl<ChanSigner: ChannelKeys> ChannelMonitor<ChanSigner> {
 }
 }
 }
 if let Some(ref txid) = self.onchain_detection.current_remote_commitment_txid {
 if let Some(ref txid) = self.current_remote_commitment_txid {
 check_htlc_fails!(txid, "current", 'current_loop);
 }
 if let Some(ref txid) = self.onchain_detection.prev_remote_commitment_txid {
 if let Some(ref txid) = self.prev_remote_commitment_txid {
 check_htlc_fails!(txid, "previous", 'prev_loop);
 }

Expand All@@ -1625,14 +1615,14 @@ impl<ChanSigner: ChannelKeys> ChannelMonitor<ChanSigner> {
 if revocation_points.0 == commitment_number + 1 { Some(point) } else { None }
 } else { None };
 if let Some(revocation_point) = revocation_point_option {
 let revocation_pubkey = ignore_error!(chan_utils::derive_public_revocation_key(&self.secp_ctx, revocation_point, &self.onchain_detection.keys.pubkeys().revocation_basepoint));
 let b_htlc_key = ignore_error!(chan_utils::derive_public_key(&self.secp_ctx, revocation_point, &self.onchain_detection.keys.pubkeys().htlc_basepoint));
 let htlc_privkey = ignore_error!(chan_utils::derive_private_key(&self.secp_ctx, revocation_point, &self.onchain_detection.keys.htlc_base_key()));
 let revocation_pubkey = ignore_error!(chan_utils::derive_public_revocation_key(&self.secp_ctx, revocation_point, &self.keys.pubkeys().revocation_basepoint));
 let b_htlc_key = ignore_error!(chan_utils::derive_public_key(&self.secp_ctx, revocation_point, &self.keys.pubkeys().htlc_basepoint));
 let htlc_privkey = ignore_error!(chan_utils::derive_private_key(&self.secp_ctx, revocation_point, &self.keys.htlc_base_key()));
 let a_htlc_key = match self.their_htlc_base_key {
 None => return (claimable_outpoints, (commitment_txid, watch_outputs)),
 Some(their_htlc_base_key) => ignore_error!(chan_utils::derive_public_key(&self.secp_ctx, revocation_point, &their_htlc_base_key)),
 };
 let local_payment_key = ignore_error!(chan_utils::derive_private_key(&self.secp_ctx, revocation_point, &self.onchain_detection.keys.payment_base_key()));
 let local_payment_key = ignore_error!(chan_utils::derive_private_key(&self.secp_ctx, revocation_point, &self.keys.payment_base_key()));

 self.broadcasted_remote_payment_script = {
 // Note that the Network here is ignored as we immediately drop the address for the
Expand DownExpand Up@@ -1683,8 +1673,8 @@ impl<ChanSigner: ChannelKeys> ChannelMonitor<ChanSigner> {
 let secret = if let Some(secret) = self.get_secret(commitment_number) { secret } else { return (Vec::new(), None); };
 let per_commitment_key = ignore_error!(SecretKey::from_slice(&secret));
 let per_commitment_point = PublicKey::from_secret_key(&self.secp_ctx, &per_commitment_key);
 let revocation_pubkey = ignore_error!(chan_utils::derive_public_revocation_key(&self.secp_ctx, &per_commitment_point, &self.onchain_detection.keys.pubkeys().revocation_basepoint));
 let revocation_key = ignore_error!(chan_utils::derive_private_revocation_key(&self.secp_ctx, &per_commitment_key, &self.onchain_detection.keys.revocation_base_key()));
 let revocation_pubkey = ignore_error!(chan_utils::derive_public_revocation_key(&self.secp_ctx, &per_commitment_point, &self.keys.pubkeys().revocation_basepoint));
 let revocation_key = ignore_error!(chan_utils::derive_private_revocation_key(&self.secp_ctx, &per_commitment_key, &self.keys.revocation_base_key()));
 let delayed_key = match self.their_delayed_payment_base_key {
 None => return (Vec::new(), None),
 Some(their_delayed_payment_base_key) => ignore_error!(chan_utils::derive_public_key(&self.secp_ctx, &per_commitment_point, &their_delayed_payment_base_key)),
Expand All@@ -1702,7 +1692,7 @@ impl<ChanSigner: ChannelKeys> ChannelMonitor<ChanSigner> {
 let mut watch_outputs = Vec::with_capacity(local_tx.htlc_outputs.len());

 let redeemscript = chan_utils::get_revokeable_redeemscript(&local_tx.revocation_key, self.their_to_self_delay.unwrap(), &local_tx.delayed_payment_key);
 let broadcasted_local_revokable_script = if let Ok(local_delayedkey) = chan_utils::derive_private_key(&self.secp_ctx, &local_tx.per_commitment_point, self.onchain_detection.keys.delayed_payment_base_key()) {
 let broadcasted_local_revokable_script = if let Ok(local_delayedkey) = chan_utils::derive_private_key(&self.secp_ctx, &local_tx.per_commitment_point, self.keys.delayed_payment_base_key()) {
 Some((redeemscript.to_v0_p2wsh(), local_delayedkey, redeemscript))
 } else { None };

Expand DownExpand Up@@ -1883,7 +1873,7 @@ impl<ChanSigner: ChannelKeys> ChannelMonitor<ChanSigner> {
 // which is an easy way to filter out any potential non-matching txn for lazy
 // filters.
 let prevout = &tx.input[0].previous_output;
 let funding_txo = self.onchain_detection.funding_info.clone();
 let funding_txo = self.funding_info.clone();
 if funding_txo.is_none() || (prevout.txid == funding_txo.as_ref().unwrap().0.txid && prevout.vout == funding_txo.as_ref().unwrap().0.index as u32) {
 if (tx.input[0].sequence >> 8*3) as u8 == 0x80 && (tx.lock_time >> 8*3) as u8 == 0x20 {
 let (mut new_outpoints, new_outputs) = self.check_spend_remote_transaction(&tx, height);
Expand DownExpand Up@@ -1920,7 +1910,7 @@ impl<ChanSigner: ChannelKeys> ChannelMonitor<ChanSigner> {
 self.would_broadcast_at_height(height)
 } else { false };
 if should_broadcast {
 claimable_outpoints.push(ClaimRequest { absolute_timelock: height, aggregable: false, outpoint: BitcoinOutPoint { txid: self.onchain_detection.funding_info.as_ref().unwrap().0.txid.clone(), vout: self.onchain_detection.funding_info.as_ref().unwrap().0.index as u32 }, witness_data: InputMaterial::Funding { channel_value: self.channel_value_satoshis.unwrap() }});
 claimable_outpoints.push(ClaimRequest { absolute_timelock: height, aggregable: false, outpoint: BitcoinOutPoint { txid: self.funding_info.as_ref().unwrap().0.txid.clone(), vout: self.funding_info.as_ref().unwrap().0.index as u32 }, witness_data: InputMaterial::Funding { channel_value: self.channel_value_satoshis.unwrap() }});
 }
 if let Some(ref cur_local_tx) = self.current_local_signed_commitment_tx {
 if should_broadcast {
Expand DownExpand Up@@ -2030,12 +2020,12 @@ impl<ChanSigner: ChannelKeys> ChannelMonitor<ChanSigner> {
 scan_commitment!(cur_local_tx.htlc_outputs.iter().map(|&(ref a, _, _)| a), true);
 }

 if let Some(ref txid) = self.onchain_detection.current_remote_commitment_txid {
 if let Some(ref txid) = self.current_remote_commitment_txid {
 if let Some(ref htlc_outputs) = self.remote_claimable_outpoints.get(txid) {
 scan_commitment!(htlc_outputs.iter().map(|&(ref a, _)| a), false);
 }
 }
 if let Some(ref txid) = self.onchain_detection.prev_remote_commitment_txid {
 if let Some(ref txid) = self.prev_remote_commitment_txid {
 if let Some(ref htlc_outputs) = self.remote_claimable_outpoints.get(txid) {
 scan_commitment!(htlc_outputs.iter().map(|&(ref a, _)| a), false);
 }
Expand DownExpand Up@@ -2105,9 +2095,9 @@ impl<ChanSigner: ChannelKeys> ChannelMonitor<ChanSigner> {
 // resolve the source HTLC with the original sender.
 payment_data = Some(((*source).clone(), htlc_output.payment_hash));
 } else if !$local_tx {
 check_htlc_valid_remote!(self.onchain_detection.current_remote_commitment_txid, htlc_output);
 check_htlc_valid_remote!(self.current_remote_commitment_txid, htlc_output);
 if payment_data.is_none() {
 check_htlc_valid_remote!(self.onchain_detection.prev_remote_commitment_txid, htlc_output);
 check_htlc_valid_remote!(self.prev_remote_commitment_txid, htlc_output);
 }
 }
 if payment_data.is_none() {
Expand DownExpand Up@@ -2278,24 +2268,16 @@ impl<ChanSigner: ChannelKeys + Readable> ReadableArgs<Arc<Logger>> for (Sha256dH
 };
 let shutdown_script = Readable::read(reader)?;

 let onchain_detection = {
 let keys = Readable::read(reader)?;
 // Technically this can fail and serialize fail a round-trip, but only for serialization of
 // barely-init'd ChannelMonitors that we can't do anything with.
 let outpoint = OutPoint {
 txid: Readable::read(reader)?,
 index: Readable::read(reader)?,
 };
 let funding_info = Some((outpoint, Readable::read(reader)?));
 let current_remote_commitment_txid = Readable::read(reader)?;
 let prev_remote_commitment_txid = Readable::read(reader)?;
 OnchainDetection {
 keys,
 funding_info,
 current_remote_commitment_txid,
 prev_remote_commitment_txid,
 }
 let keys = Readable::read(reader)?;
 // Technically this can fail and serialize fail a round-trip, but only for serialization of
 // barely-init'd ChannelMonitors that we can't do anything with.
 let outpoint = OutPoint {
 txid: Readable::read(reader)?,
 index: Readable::read(reader)?,
 };
 let funding_info = Some((outpoint, Readable::read(reader)?));
 let current_remote_commitment_txid = Readable::read(reader)?;
 let prev_remote_commitment_txid = Readable::read(reader)?;

 let their_htlc_base_key = Some(Readable::read(reader)?);
 let their_delayed_payment_base_key = Some(Readable::read(reader)?);
Expand DownExpand Up@@ -2508,7 +2490,11 @@ impl<ChanSigner: ChannelKeys + Readable> ReadableArgs<Arc<Logger>> for (Sha256dH
 broadcasted_remote_payment_script,
 shutdown_script,

 onchain_detection,
 keys,
 funding_info,
 current_remote_commitment_txid,
 prev_remote_commitment_txid,

 their_htlc_base_key,
 their_delayed_payment_base_key,
 funding_redeemscript,
Expand Down

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

Skip to content
Flatten ChannelMonitor substructs that don't add clarity#558

New issue

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

 Sign up for GitHub

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

Already on GitHub?
Sign in
to your account

 Merged

TheBlueMatt
merged 2 commits into

from

Apr 19, 2020
 Merged


Flatten ChannelMonitor substructs that don't add clarity
#558
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
3c5ba6b

Drop uneccessary clone() introduced in 16fba9fd664522ac8d24111547b4


TheBlueMatt Mar 21, 2020
b49e63b

Flatten ChannelMonitor substructs that don't add clarity


TheBlueMatt Mar 21, 2020

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


136 changes: 61 additions & 75 deletions
lightning/src/ln/channelmonitor.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -290,7 +290,7 @@ impl<Key : Send + cmp::Eq + hash::Hash + 'static, ChanSigner: ChannelKeys, T: De
 hash_map::Entry::Occupied(_) => return Err(MonitorUpdateError("Channel monitor for given key is already present")),
 hash_map::Entry::Vacant(e) => e,
 };
 match monitor.onchain_detection.funding_info {
 match monitor.funding_info {
 None => {
 return Err(MonitorUpdateError("Try to update a useless monitor without funding_txo !"));
 },
Expand All@@ -314,7 +314,7 @@ impl<Key : Send + cmp::Eq + hash::Hash + 'static, ChanSigner: ChannelKeys, T: De
 let mut monitors = self.monitors.lock().unwrap();
 match monitors.get_mut(&key) {
 Some(orig_monitor) => {
 log_trace!(self, "Updating Channel Monitor for channel {}", log_funding_info!(orig_monitor.onchain_detection));
 log_trace!(self, "Updating Channel Monitor for channel {}", log_funding_info!(orig_monitor));
 orig_monitor.update_monitor(update, &self.broadcaster)
 },
 None => Err(MonitorUpdateError("No such monitor registered"))
Expand DownExpand Up@@ -391,20 +391,6 @@ pub(crate) const LATENCY_GRACE_PERIOD_BLOCKS: u32 = 3;
/// keeping bumping another claim tx to solve the outpoint.
pub(crate) const ANTI_REORG_DELAY: u32 = 6;

struct OnchainDetection<ChanSigner: ChannelKeys> {
	keys: ChanSigner,
	funding_info: Option<(OutPoint, Script)>,
	current_remote_commitment_txid: Option<Sha256dHash>,
	prev_remote_commitment_txid: Option<Sha256dHash>,
}

#[cfg(any(test, feature = "fuzztarget"))]
impl<ChanSigner: ChannelKeys> PartialEq for OnchainDetection<ChanSigner> {
	fn eq(&self, other: &Self) -> bool {
 self.keys.pubkeys() == other.keys.pubkeys()
	}
}

#[derive(Clone, PartialEq)]
struct LocalSignedTx {
	/// txid of the transaction in tx, just used to make comparison faster
Expand DownExpand Up@@ -734,7 +720,11 @@ pub struct ChannelMonitor<ChanSigner: ChannelKeys> {
	broadcasted_remote_payment_script: Option<(Script, SecretKey)>,
	shutdown_script: Script,

	onchain_detection: OnchainDetection<ChanSigner>,
	keys: ChanSigner,
	funding_info: Option<(OutPoint, Script)>,
	current_remote_commitment_txid: Option<Sha256dHash>,
	prev_remote_commitment_txid: Option<Sha256dHash>,

	their_htlc_base_key: Option<PublicKey>,
	their_delayed_payment_base_key: Option<PublicKey>,
	funding_redeemscript: Option<Script>,
Expand DownExpand Up@@ -817,7 +807,10 @@ impl<ChanSigner: ChannelKeys> PartialEq for ChannelMonitor<ChanSigner> {
 self.destination_script != other.destination_script ||
 self.broadcasted_local_revokable_script != other.broadcasted_local_revokable_script ||
 self.broadcasted_remote_payment_script != other.broadcasted_remote_payment_script ||
 self.onchain_detection != other.onchain_detection ||
 self.keys.pubkeys() != other.keys.pubkeys() ||
 self.funding_info != other.funding_info ||
 self.current_remote_commitment_txid != other.current_remote_commitment_txid ||
 self.prev_remote_commitment_txid != other.prev_remote_commitment_txid ||
 self.their_htlc_base_key != other.their_htlc_base_key ||
 self.their_delayed_payment_base_key != other.their_delayed_payment_base_key ||
 self.funding_redeemscript != other.funding_redeemscript ||
Expand DownExpand Up@@ -878,8 +871,8 @@ impl<ChanSigner: ChannelKeys + Writeable> ChannelMonitor<ChanSigner> {
 }
 self.shutdown_script.write(writer)?;

 self.onchain_detection.keys.write(writer)?;
 match self.onchain_detection.funding_info {
 self.keys.write(writer)?;
 match self.funding_info {
 Some((ref outpoint, ref script)) => {
 writer.write_all(&outpoint.txid[..])?;
 writer.write_all(&byte_utils::be16_to_array(outpoint.index))?;
Expand All@@ -889,8 +882,8 @@ impl<ChanSigner: ChannelKeys + Writeable> ChannelMonitor<ChanSigner> {
 debug_assert!(false, "Try to serialize a useless Local monitor !");
 },
 }
 self.onchain_detection.current_remote_commitment_txid.write(writer)?;
 self.onchain_detection.prev_remote_commitment_txid.write(writer)?;
 self.current_remote_commitment_txid.write(writer)?;
 self.prev_remote_commitment_txid.write(writer)?;

 writer.write_all(&self.their_htlc_base_key.as_ref().unwrap().serialize())?;
 writer.write_all(&self.their_delayed_payment_base_key.as_ref().unwrap().serialize())?;
Expand DownExpand Up@@ -1096,13 +1089,6 @@ impl<ChanSigner: ChannelKeys> ChannelMonitor<ChanSigner> {
 let our_channel_close_key_hash = Hash160::hash(&shutdown_pubkey.serialize());
 let shutdown_script = Builder::new().push_opcode(opcodes::all::OP_PUSHBYTES_0).push_slice(&our_channel_close_key_hash[..]).into_script();

 let onchain_detection = OnchainDetection {
 keys: keys.clone(),
 funding_info: Some(funding_info.clone()),
 current_remote_commitment_txid: None,
 prev_remote_commitment_txid: None,
 };

 ChannelMonitor {
 latest_update_id: 0,
 commitment_transaction_number_obscure_factor,
Expand All@@ -1112,7 +1098,11 @@ impl<ChanSigner: ChannelKeys> ChannelMonitor<ChanSigner> {
 broadcasted_remote_payment_script: None,
 shutdown_script,

 onchain_detection: onchain_detection,
 keys: keys.clone(),
 funding_info: Some(funding_info),
 current_remote_commitment_txid: None,
 prev_remote_commitment_txid: None,

 their_htlc_base_key: Some(their_htlc_base_key.clone()),
 their_delayed_payment_base_key: Some(their_delayed_payment_base_key.clone()),
 funding_redeemscript: Some(funding_redeemscript.clone()),
Expand DownExpand Up@@ -1159,7 +1149,7 @@ impl<ChanSigner: ChannelKeys> ChannelMonitor<ChanSigner> {

 // Prune HTLCs from the previous remote commitment tx so we don't generate failure/fulfill
 // events for now-revoked/fulfilled HTLCs.
 if let Some(txid) = self.onchain_detection.prev_remote_commitment_txid.take() {
 if let Some(txid) = self.prev_remote_commitment_txid.take() {
 for &mut (_, ref mut source) in self.remote_claimable_outpoints.get_mut(&txid).unwrap() {
 *source = None;
 }
Expand DownExpand Up@@ -1216,8 +1206,8 @@ impl<ChanSigner: ChannelKeys> ChannelMonitor<ChanSigner> {
 let new_txid = unsigned_commitment_tx.txid();
 log_trace!(self, "Tracking new remote commitment transaction with txid {} at commitment number {} with {} HTLC outputs", new_txid, commitment_number, htlc_outputs.len());
 log_trace!(self, "New potential remote commitment transaction: {}", encode::serialize_hex(unsigned_commitment_tx));
 self.onchain_detection.prev_remote_commitment_txid = self.onchain_detection.current_remote_commitment_txid.take();
 self.onchain_detection.current_remote_commitment_txid = Some(new_txid);
 self.prev_remote_commitment_txid = self.current_remote_commitment_txid.take();
 self.current_remote_commitment_txid = Some(new_txid);
 self.remote_claimable_outpoints.insert(new_txid, htlc_outputs);
 self.current_remote_commitment_number = commitment_number;
 //TODO: Merge this into the other per-remote-transaction output storage stuff
Expand All@@ -1242,11 +1232,11 @@ impl<ChanSigner: ChannelKeys> ChannelMonitor<ChanSigner> {
	}

	pub(super) fn provide_rescue_remote_commitment_tx_info(&mut self, their_revocation_point: PublicKey) {
 if let Ok(payment_key) = chan_utils::derive_public_key(&self.secp_ctx, &their_revocation_point, &self.onchain_detection.keys.pubkeys().payment_basepoint) {
 if let Ok(payment_key) = chan_utils::derive_public_key(&self.secp_ctx, &their_revocation_point, &self.keys.pubkeys().payment_basepoint) {
 let to_remote_script = Builder::new().push_opcode(opcodes::all::OP_PUSHBYTES_0)
 .push_slice(&Hash160::hash(&payment_key.serialize())[..])
 .into_script();
 if let Ok(to_remote_key) = chan_utils::derive_private_key(&self.secp_ctx, &their_revocation_point, &self.onchain_detection.keys.payment_base_key()) {
 if let Ok(to_remote_key) = chan_utils::derive_private_key(&self.secp_ctx, &their_revocation_point, &self.keys.payment_base_key()) {
 self.broadcasted_remote_payment_script = Some((to_remote_script, to_remote_key));
 }
 }
Expand DownExpand Up@@ -1377,7 +1367,7 @@ impl<ChanSigner: ChannelKeys> ChannelMonitor<ChanSigner> {

	/// Gets the funding transaction outpoint of the channel this ChannelMonitor is monitoring for.
	pub fn get_funding_txo(&self) -> Option<OutPoint> {
 if let Some((outp, _)) = self.onchain_detection.funding_info {
 if let Some((outp, _)) = self.funding_info {
 return Some(outp)
 }
 None
Expand DownExpand Up@@ -1469,10 +1459,10 @@ impl<ChanSigner: ChannelKeys> ChannelMonitor<ChanSigner> {
 let secret = self.get_secret(commitment_number).unwrap();
 let per_commitment_key = ignore_error!(SecretKey::from_slice(&secret));
 let per_commitment_point = PublicKey::from_secret_key(&self.secp_ctx, &per_commitment_key);
 let revocation_pubkey = ignore_error!(chan_utils::derive_public_revocation_key(&self.secp_ctx, &per_commitment_point, &self.onchain_detection.keys.pubkeys().revocation_basepoint));
 let revocation_key = ignore_error!(chan_utils::derive_private_revocation_key(&self.secp_ctx, &per_commitment_key, &self.onchain_detection.keys.revocation_base_key()));
 let b_htlc_key = ignore_error!(chan_utils::derive_public_key(&self.secp_ctx, &per_commitment_point, &self.onchain_detection.keys.pubkeys().htlc_basepoint));
 let local_payment_key = ignore_error!(chan_utils::derive_private_key(&self.secp_ctx, &per_commitment_point, &self.onchain_detection.keys.payment_base_key()));
 let revocation_pubkey = ignore_error!(chan_utils::derive_public_revocation_key(&self.secp_ctx, &per_commitment_point, &self.keys.pubkeys().revocation_basepoint));
 let revocation_key = ignore_error!(chan_utils::derive_private_revocation_key(&self.secp_ctx, &per_commitment_key, &self.keys.revocation_base_key()));
 let b_htlc_key = ignore_error!(chan_utils::derive_public_key(&self.secp_ctx, &per_commitment_point, &self.keys.pubkeys().htlc_basepoint));
 let local_payment_key = ignore_error!(chan_utils::derive_private_key(&self.secp_ctx, &per_commitment_point, &self.keys.payment_base_key()));
 let delayed_key = ignore_error!(chan_utils::derive_public_key(&self.secp_ctx, &PublicKey::from_secret_key(&self.secp_ctx, &per_commitment_key), &self.their_delayed_payment_base_key.unwrap()));
 let a_htlc_key = match self.their_htlc_base_key {
 None => return (claimable_outpoints, (commitment_txid, watch_outputs)),
Expand DownExpand Up@@ -1548,10 +1538,10 @@ impl<ChanSigner: ChannelKeys> ChannelMonitor<ChanSigner> {
 }
 }
 }
 if let Some(ref txid) = self.onchain_detection.current_remote_commitment_txid {
 if let Some(ref txid) = self.current_remote_commitment_txid {
 check_htlc_fails!(txid, "current");
 }
 if let Some(ref txid) = self.onchain_detection.prev_remote_commitment_txid {
 if let Some(ref txid) = self.prev_remote_commitment_txid {
 check_htlc_fails!(txid, "remote");
 }
 // No need to check local commitment txn, symmetric HTLCSource must be present as per-htlc data on remote commitment tx
Expand DownExpand Up@@ -1611,10 +1601,10 @@ impl<ChanSigner: ChannelKeys> ChannelMonitor<ChanSigner> {
 }
 }
 }
 if let Some(ref txid) = self.onchain_detection.current_remote_commitment_txid {
 if let Some(ref txid) = self.current_remote_commitment_txid {
 check_htlc_fails!(txid, "current", 'current_loop);
 }
 if let Some(ref txid) = self.onchain_detection.prev_remote_commitment_txid {
 if let Some(ref txid) = self.prev_remote_commitment_txid {
 check_htlc_fails!(txid, "previous", 'prev_loop);
 }

Expand All@@ -1625,14 +1615,14 @@ impl<ChanSigner: ChannelKeys> ChannelMonitor<ChanSigner> {
 if revocation_points.0 == commitment_number + 1 { Some(point) } else { None }
 } else { None };
 if let Some(revocation_point) = revocation_point_option {
 let revocation_pubkey = ignore_error!(chan_utils::derive_public_revocation_key(&self.secp_ctx, revocation_point, &self.onchain_detection.keys.pubkeys().revocation_basepoint));
 let b_htlc_key = ignore_error!(chan_utils::derive_public_key(&self.secp_ctx, revocation_point, &self.onchain_detection.keys.pubkeys().htlc_basepoint));
 let htlc_privkey = ignore_error!(chan_utils::derive_private_key(&self.secp_ctx, revocation_point, &self.onchain_detection.keys.htlc_base_key()));
 let revocation_pubkey = ignore_error!(chan_utils::derive_public_revocation_key(&self.secp_ctx, revocation_point, &self.keys.pubkeys().revocation_basepoint));
 let b_htlc_key = ignore_error!(chan_utils::derive_public_key(&self.secp_ctx, revocation_point, &self.keys.pubkeys().htlc_basepoint));
 let htlc_privkey = ignore_error!(chan_utils::derive_private_key(&self.secp_ctx, revocation_point, &self.keys.htlc_base_key()));
 let a_htlc_key = match self.their_htlc_base_key {
 None => return (claimable_outpoints, (commitment_txid, watch_outputs)),
 Some(their_htlc_base_key) => ignore_error!(chan_utils::derive_public_key(&self.secp_ctx, revocation_point, &their_htlc_base_key)),
 };
 let local_payment_key = ignore_error!(chan_utils::derive_private_key(&self.secp_ctx, revocation_point, &self.onchain_detection.keys.payment_base_key()));
 let local_payment_key = ignore_error!(chan_utils::derive_private_key(&self.secp_ctx, revocation_point, &self.keys.payment_base_key()));

 self.broadcasted_remote_payment_script = {
 // Note that the Network here is ignored as we immediately drop the address for the
Expand DownExpand Up@@ -1683,8 +1673,8 @@ impl<ChanSigner: ChannelKeys> ChannelMonitor<ChanSigner> {
 let secret = if let Some(secret) = self.get_secret(commitment_number) { secret } else { return (Vec::new(), None); };
 let per_commitment_key = ignore_error!(SecretKey::from_slice(&secret));
 let per_commitment_point = PublicKey::from_secret_key(&self.secp_ctx, &per_commitment_key);
 let revocation_pubkey = ignore_error!(chan_utils::derive_public_revocation_key(&self.secp_ctx, &per_commitment_point, &self.onchain_detection.keys.pubkeys().revocation_basepoint));
 let revocation_key = ignore_error!(chan_utils::derive_private_revocation_key(&self.secp_ctx, &per_commitment_key, &self.onchain_detection.keys.revocation_base_key()));
 let revocation_pubkey = ignore_error!(chan_utils::derive_public_revocation_key(&self.secp_ctx, &per_commitment_point, &self.keys.pubkeys().revocation_basepoint));
 let revocation_key = ignore_error!(chan_utils::derive_private_revocation_key(&self.secp_ctx, &per_commitment_key, &self.keys.revocation_base_key()));
 let delayed_key = match self.their_delayed_payment_base_key {
 None => return (Vec::new(), None),
 Some(their_delayed_payment_base_key) => ignore_error!(chan_utils::derive_public_key(&self.secp_ctx, &per_commitment_point, &their_delayed_payment_base_key)),
Expand All@@ -1702,7 +1692,7 @@ impl<ChanSigner: ChannelKeys> ChannelMonitor<ChanSigner> {
 let mut watch_outputs = Vec::with_capacity(local_tx.htlc_outputs.len());

 let redeemscript = chan_utils::get_revokeable_redeemscript(&local_tx.revocation_key, self.their_to_self_delay.unwrap(), &local_tx.delayed_payment_key);
 let broadcasted_local_revokable_script = if let Ok(local_delayedkey) = chan_utils::derive_private_key(&self.secp_ctx, &local_tx.per_commitment_point, self.onchain_detection.keys.delayed_payment_base_key()) {
 let broadcasted_local_revokable_script = if let Ok(local_delayedkey) = chan_utils::derive_private_key(&self.secp_ctx, &local_tx.per_commitment_point, self.keys.delayed_payment_base_key()) {
 Some((redeemscript.to_v0_p2wsh(), local_delayedkey, redeemscript))
 } else { None };

Expand DownExpand Up@@ -1883,7 +1873,7 @@ impl<ChanSigner: ChannelKeys> ChannelMonitor<ChanSigner> {
 // which is an easy way to filter out any potential non-matching txn for lazy
 // filters.
 let prevout = &tx.input[0].previous_output;
 let funding_txo = self.onchain_detection.funding_info.clone();
 let funding_txo = self.funding_info.clone();
 if funding_txo.is_none() || (prevout.txid == funding_txo.as_ref().unwrap().0.txid && prevout.vout == funding_txo.as_ref().unwrap().0.index as u32) {
 if (tx.input[0].sequence >> 8*3) as u8 == 0x80 && (tx.lock_time >> 8*3) as u8 == 0x20 {
 let (mut new_outpoints, new_outputs) = self.check_spend_remote_transaction(&tx, height);
Expand DownExpand Up@@ -1920,7 +1910,7 @@ impl<ChanSigner: ChannelKeys> ChannelMonitor<ChanSigner> {
 self.would_broadcast_at_height(height)
 } else { false };
 if should_broadcast {
 claimable_outpoints.push(ClaimRequest { absolute_timelock: height, aggregable: false, outpoint: BitcoinOutPoint { txid: self.onchain_detection.funding_info.as_ref().unwrap().0.txid.clone(), vout: self.onchain_detection.funding_info.as_ref().unwrap().0.index as u32 }, witness_data: InputMaterial::Funding { channel_value: self.channel_value_satoshis.unwrap() }});
 claimable_outpoints.push(ClaimRequest { absolute_timelock: height, aggregable: false, outpoint: BitcoinOutPoint { txid: self.funding_info.as_ref().unwrap().0.txid.clone(), vout: self.funding_info.as_ref().unwrap().0.index as u32 }, witness_data: InputMaterial::Funding { channel_value: self.channel_value_satoshis.unwrap() }});
 }
 if let Some(ref cur_local_tx) = self.current_local_signed_commitment_tx {
 if should_broadcast {
Expand DownExpand Up@@ -2030,12 +2020,12 @@ impl<ChanSigner: ChannelKeys> ChannelMonitor<ChanSigner> {
 scan_commitment!(cur_local_tx.htlc_outputs.iter().map(|&(ref a, _, _)| a), true);
 }

 if let Some(ref txid) = self.onchain_detection.current_remote_commitment_txid {
 if let Some(ref txid) = self.current_remote_commitment_txid {
 if let Some(ref htlc_outputs) = self.remote_claimable_outpoints.get(txid) {
 scan_commitment!(htlc_outputs.iter().map(|&(ref a, _)| a), false);
 }
 }
 if let Some(ref txid) = self.onchain_detection.prev_remote_commitment_txid {
 if let Some(ref txid) = self.prev_remote_commitment_txid {
 if let Some(ref htlc_outputs) = self.remote_claimable_outpoints.get(txid) {
 scan_commitment!(htlc_outputs.iter().map(|&(ref a, _)| a), false);
 }
Expand DownExpand Up@@ -2105,9 +2095,9 @@ impl<ChanSigner: ChannelKeys> ChannelMonitor<ChanSigner> {
 // resolve the source HTLC with the original sender.
 payment_data = Some(((*source).clone(), htlc_output.payment_hash));
 } else if !$local_tx {
 check_htlc_valid_remote!(self.onchain_detection.current_remote_commitment_txid, htlc_output);
 check_htlc_valid_remote!(self.current_remote_commitment_txid, htlc_output);
 if payment_data.is_none() {
 check_htlc_valid_remote!(self.onchain_detection.prev_remote_commitment_txid, htlc_output);
 check_htlc_valid_remote!(self.prev_remote_commitment_txid, htlc_output);
 }
 }
 if payment_data.is_none() {
Expand DownExpand Up@@ -2278,24 +2268,16 @@ impl<ChanSigner: ChannelKeys + Readable> ReadableArgs<Arc<Logger>> for (Sha256dH
 };
 let shutdown_script = Readable::read(reader)?;

 let onchain_detection = {
 let keys = Readable::read(reader)?;
 // Technically this can fail and serialize fail a round-trip, but only for serialization of
 // barely-init'd ChannelMonitors that we can't do anything with.
 let outpoint = OutPoint {
 txid: Readable::read(reader)?,
 index: Readable::read(reader)?,
 };
 let funding_info = Some((outpoint, Readable::read(reader)?));
 let current_remote_commitment_txid = Readable::read(reader)?;
 let prev_remote_commitment_txid = Readable::read(reader)?;
 OnchainDetection {
 keys,
 funding_info,
 current_remote_commitment_txid,
 prev_remote_commitment_txid,
 }
 let keys = Readable::read(reader)?;
 // Technically this can fail and serialize fail a round-trip, but only for serialization of
 // barely-init'd ChannelMonitors that we can't do anything with.
 let outpoint = OutPoint {
 txid: Readable::read(reader)?,
 index: Readable::read(reader)?,
 };
 let funding_info = Some((outpoint, Readable::read(reader)?));
 let current_remote_commitment_txid = Readable::read(reader)?;
 let prev_remote_commitment_txid = Readable::read(reader)?;

 let their_htlc_base_key = Some(Readable::read(reader)?);
 let their_delayed_payment_base_key = Some(Readable::read(reader)?);
Expand DownExpand Up@@ -2508,7 +2490,11 @@ impl<ChanSigner: ChannelKeys + Readable> ReadableArgs<Arc<Logger>> for (Sha256dH
 broadcasted_remote_payment_script,
 shutdown_script,

 onchain_detection,
 keys,
 funding_info,
 current_remote_commitment_txid,
 prev_remote_commitment_txid,

 their_htlc_base_key,
 their_delayed_payment_base_key,
 funding_redeemscript,
Expand Down

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

Skip to content
Flatten ChannelMonitor substructs that don't add clarity#558

New issue

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

 Sign up for GitHub

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

Already on GitHub?
Sign in
to your account

 Merged

TheBlueMatt
merged 2 commits into

from

Apr 19, 2020
 Merged


Flatten ChannelMonitor substructs that don't add clarity
#558
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
3c5ba6b

Drop uneccessary clone() introduced in 16fba9fd664522ac8d24111547b4


TheBlueMatt Mar 21, 2020
b49e63b

Flatten ChannelMonitor substructs that don't add clarity


TheBlueMatt Mar 21, 2020

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


136 changes: 61 additions & 75 deletions
lightning/src/ln/channelmonitor.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -290,7 +290,7 @@ impl<Key : Send + cmp::Eq + hash::Hash + 'static, ChanSigner: ChannelKeys, T: De
 hash_map::Entry::Occupied(_) => return Err(MonitorUpdateError("Channel monitor for given key is already present")),
 hash_map::Entry::Vacant(e) => e,
 };
 match monitor.onchain_detection.funding_info {
 match monitor.funding_info {
 None => {
 return Err(MonitorUpdateError("Try to update a useless monitor without funding_txo !"));
 },
Expand All@@ -314,7 +314,7 @@ impl<Key : Send + cmp::Eq + hash::Hash + 'static, ChanSigner: ChannelKeys, T: De
 let mut monitors = self.monitors.lock().unwrap();
 match monitors.get_mut(&key) {
 Some(orig_monitor) => {
 log_trace!(self, "Updating Channel Monitor for channel {}", log_funding_info!(orig_monitor.onchain_detection));
 log_trace!(self, "Updating Channel Monitor for channel {}", log_funding_info!(orig_monitor));
 orig_monitor.update_monitor(update, &self.broadcaster)
 },
 None => Err(MonitorUpdateError("No such monitor registered"))
Expand DownExpand Up@@ -391,20 +391,6 @@ pub(crate) const LATENCY_GRACE_PERIOD_BLOCKS: u32 = 3;
/// keeping bumping another claim tx to solve the outpoint.
pub(crate) const ANTI_REORG_DELAY: u32 = 6;

struct OnchainDetection<ChanSigner: ChannelKeys> {
	keys: ChanSigner,
	funding_info: Option<(OutPoint, Script)>,
	current_remote_commitment_txid: Option<Sha256dHash>,
	prev_remote_commitment_txid: Option<Sha256dHash>,
}

#[cfg(any(test, feature = "fuzztarget"))]
impl<ChanSigner: ChannelKeys> PartialEq for OnchainDetection<ChanSigner> {
	fn eq(&self, other: &Self) -> bool {
 self.keys.pubkeys() == other.keys.pubkeys()
	}
}

#[derive(Clone, PartialEq)]
struct LocalSignedTx {
	/// txid of the transaction in tx, just used to make comparison faster
Expand DownExpand Up@@ -734,7 +720,11 @@ pub struct ChannelMonitor<ChanSigner: ChannelKeys> {
	broadcasted_remote_payment_script: Option<(Script, SecretKey)>,
	shutdown_script: Script,

	onchain_detection: OnchainDetection<ChanSigner>,
	keys: ChanSigner,
	funding_info: Option<(OutPoint, Script)>,
	current_remote_commitment_txid: Option<Sha256dHash>,
	prev_remote_commitment_txid: Option<Sha256dHash>,

	their_htlc_base_key: Option<PublicKey>,
	their_delayed_payment_base_key: Option<PublicKey>,
	funding_redeemscript: Option<Script>,
Expand DownExpand Up@@ -817,7 +807,10 @@ impl<ChanSigner: ChannelKeys> PartialEq for ChannelMonitor<ChanSigner> {
 self.destination_script != other.destination_script ||
 self.broadcasted_local_revokable_script != other.broadcasted_local_revokable_script ||
 self.broadcasted_remote_payment_script != other.broadcasted_remote_payment_script ||
 self.onchain_detection != other.onchain_detection ||
 self.keys.pubkeys() != other.keys.pubkeys() ||
 self.funding_info != other.funding_info ||
 self.current_remote_commitment_txid != other.current_remote_commitment_txid ||
 self.prev_remote_commitment_txid != other.prev_remote_commitment_txid ||
 self.their_htlc_base_key != other.their_htlc_base_key ||
 self.their_delayed_payment_base_key != other.their_delayed_payment_base_key ||
 self.funding_redeemscript != other.funding_redeemscript ||
Expand DownExpand Up@@ -878,8 +871,8 @@ impl<ChanSigner: ChannelKeys + Writeable> ChannelMonitor<ChanSigner> {
 }
 self.shutdown_script.write(writer)?;

 self.onchain_detection.keys.write(writer)?;
 match self.onchain_detection.funding_info {
 self.keys.write(writer)?;
 match self.funding_info {
 Some((ref outpoint, ref script)) => {
 writer.write_all(&outpoint.txid[..])?;
 writer.write_all(&byte_utils::be16_to_array(outpoint.index))?;
Expand All@@ -889,8 +882,8 @@ impl<ChanSigner: ChannelKeys + Writeable> ChannelMonitor<ChanSigner> {
 debug_assert!(false, "Try to serialize a useless Local monitor !");
 },
 }
 self.onchain_detection.current_remote_commitment_txid.write(writer)?;
 self.onchain_detection.prev_remote_commitment_txid.write(writer)?;
 self.current_remote_commitment_txid.write(writer)?;
 self.prev_remote_commitment_txid.write(writer)?;

 writer.write_all(&self.their_htlc_base_key.as_ref().unwrap().serialize())?;
 writer.write_all(&self.their_delayed_payment_base_key.as_ref().unwrap().serialize())?;
Expand DownExpand Up@@ -1096,13 +1089,6 @@ impl<ChanSigner: ChannelKeys> ChannelMonitor<ChanSigner> {
 let our_channel_close_key_hash = Hash160::hash(&shutdown_pubkey.serialize());
 let shutdown_script = Builder::new().push_opcode(opcodes::all::OP_PUSHBYTES_0).push_slice(&our_channel_close_key_hash[..]).into_script();

 let onchain_detection = OnchainDetection {
 keys: keys.clone(),
 funding_info: Some(funding_info.clone()),
 current_remote_commitment_txid: None,
 prev_remote_commitment_txid: None,
 };

 ChannelMonitor {
 latest_update_id: 0,
 commitment_transaction_number_obscure_factor,
Expand All@@ -1112,7 +1098,11 @@ impl<ChanSigner: ChannelKeys> ChannelMonitor<ChanSigner> {
 broadcasted_remote_payment_script: None,
 shutdown_script,

 onchain_detection: onchain_detection,
 keys: keys.clone(),
 funding_info: Some(funding_info),
 current_remote_commitment_txid: None,
 prev_remote_commitment_txid: None,

 their_htlc_base_key: Some(their_htlc_base_key.clone()),
 their_delayed_payment_base_key: Some(their_delayed_payment_base_key.clone()),
 funding_redeemscript: Some(funding_redeemscript.clone()),
Expand DownExpand Up@@ -1159,7 +1149,7 @@ impl<ChanSigner: ChannelKeys> ChannelMonitor<ChanSigner> {

 // Prune HTLCs from the previous remote commitment tx so we don't generate failure/fulfill
 // events for now-revoked/fulfilled HTLCs.
 if let Some(txid) = self.onchain_detection.prev_remote_commitment_txid.take() {
 if let Some(txid) = self.prev_remote_commitment_txid.take() {
 for &mut (_, ref mut source) in self.remote_claimable_outpoints.get_mut(&txid).unwrap() {
 *source = None;
 }
Expand DownExpand Up@@ -1216,8 +1206,8 @@ impl<ChanSigner: ChannelKeys> ChannelMonitor<ChanSigner> {
 let new_txid = unsigned_commitment_tx.txid();
 log_trace!(self, "Tracking new remote commitment transaction with txid {} at commitment number {} with {} HTLC outputs", new_txid, commitment_number, htlc_outputs.len());
 log_trace!(self, "New potential remote commitment transaction: {}", encode::serialize_hex(unsigned_commitment_tx));
 self.onchain_detection.prev_remote_commitment_txid = self.onchain_detection.current_remote_commitment_txid.take();
 self.onchain_detection.current_remote_commitment_txid = Some(new_txid);
 self.prev_remote_commitment_txid = self.current_remote_commitment_txid.take();
 self.current_remote_commitment_txid = Some(new_txid);
 self.remote_claimable_outpoints.insert(new_txid, htlc_outputs);
 self.current_remote_commitment_number = commitment_number;
 //TODO: Merge this into the other per-remote-transaction output storage stuff
Expand All@@ -1242,11 +1232,11 @@ impl<ChanSigner: ChannelKeys> ChannelMonitor<ChanSigner> {
	}

	pub(super) fn provide_rescue_remote_commitment_tx_info(&mut self, their_revocation_point: PublicKey) {
 if let Ok(payment_key) = chan_utils::derive_public_key(&self.secp_ctx, &their_revocation_point, &self.onchain_detection.keys.pubkeys().payment_basepoint) {
 if let Ok(payment_key) = chan_utils::derive_public_key(&self.secp_ctx, &their_revocation_point, &self.keys.pubkeys().payment_basepoint) {
 let to_remote_script = Builder::new().push_opcode(opcodes::all::OP_PUSHBYTES_0)
 .push_slice(&Hash160::hash(&payment_key.serialize())[..])
 .into_script();
 if let Ok(to_remote_key) = chan_utils::derive_private_key(&self.secp_ctx, &their_revocation_point, &self.onchain_detection.keys.payment_base_key()) {
 if let Ok(to_remote_key) = chan_utils::derive_private_key(&self.secp_ctx, &their_revocation_point, &self.keys.payment_base_key()) {
 self.broadcasted_remote_payment_script = Some((to_remote_script, to_remote_key));
 }
 }
Expand DownExpand Up@@ -1377,7 +1367,7 @@ impl<ChanSigner: ChannelKeys> ChannelMonitor<ChanSigner> {

	/// Gets the funding transaction outpoint of the channel this ChannelMonitor is monitoring for.
	pub fn get_funding_txo(&self) -> Option<OutPoint> {
 if let Some((outp, _)) = self.onchain_detection.funding_info {
 if let Some((outp, _)) = self.funding_info {
 return Some(outp)
 }
 None
Expand DownExpand Up@@ -1469,10 +1459,10 @@ impl<ChanSigner: ChannelKeys> ChannelMonitor<ChanSigner> {
 let secret = self.get_secret(commitment_number).unwrap();
 let per_commitment_key = ignore_error!(SecretKey::from_slice(&secret));
 let per_commitment_point = PublicKey::from_secret_key(&self.secp_ctx, &per_commitment_key);
 let revocation_pubkey = ignore_error!(chan_utils::derive_public_revocation_key(&self.secp_ctx, &per_commitment_point, &self.onchain_detection.keys.pubkeys().revocation_basepoint));
 let revocation_key = ignore_error!(chan_utils::derive_private_revocation_key(&self.secp_ctx, &per_commitment_key, &self.onchain_detection.keys.revocation_base_key()));
 let b_htlc_key = ignore_error!(chan_utils::derive_public_key(&self.secp_ctx, &per_commitment_point, &self.onchain_detection.keys.pubkeys().htlc_basepoint));
 let local_payment_key = ignore_error!(chan_utils::derive_private_key(&self.secp_ctx, &per_commitment_point, &self.onchain_detection.keys.payment_base_key()));
 let revocation_pubkey = ignore_error!(chan_utils::derive_public_revocation_key(&self.secp_ctx, &per_commitment_point, &self.keys.pubkeys().revocation_basepoint));
 let revocation_key = ignore_error!(chan_utils::derive_private_revocation_key(&self.secp_ctx, &per_commitment_key, &self.keys.revocation_base_key()));
 let b_htlc_key = ignore_error!(chan_utils::derive_public_key(&self.secp_ctx, &per_commitment_point, &self.keys.pubkeys().htlc_basepoint));
 let local_payment_key = ignore_error!(chan_utils::derive_private_key(&self.secp_ctx, &per_commitment_point, &self.keys.payment_base_key()));
 let delayed_key = ignore_error!(chan_utils::derive_public_key(&self.secp_ctx, &PublicKey::from_secret_key(&self.secp_ctx, &per_commitment_key), &self.their_delayed_payment_base_key.unwrap()));
 let a_htlc_key = match self.their_htlc_base_key {
 None => return (claimable_outpoints, (commitment_txid, watch_outputs)),
Expand DownExpand Up@@ -1548,10 +1538,10 @@ impl<ChanSigner: ChannelKeys> ChannelMonitor<ChanSigner> {
 }
 }
 }
 if let Some(ref txid) = self.onchain_detection.current_remote_commitment_txid {
 if let Some(ref txid) = self.current_remote_commitment_txid {
 check_htlc_fails!(txid, "current");
 }
 if let Some(ref txid) = self.onchain_detection.prev_remote_commitment_txid {
 if let Some(ref txid) = self.prev_remote_commitment_txid {
 check_htlc_fails!(txid, "remote");
 }
 // No need to check local commitment txn, symmetric HTLCSource must be present as per-htlc data on remote commitment tx
Expand DownExpand Up@@ -1611,10 +1601,10 @@ impl<ChanSigner: ChannelKeys> ChannelMonitor<ChanSigner> {
 }
 }
 }
 if let Some(ref txid) = self.onchain_detection.current_remote_commitment_txid {
 if let Some(ref txid) = self.current_remote_commitment_txid {
 check_htlc_fails!(txid, "current", 'current_loop);
 }
 if let Some(ref txid) = self.onchain_detection.prev_remote_commitment_txid {
 if let Some(ref txid) = self.prev_remote_commitment_txid {
 check_htlc_fails!(txid, "previous", 'prev_loop);
 }

Expand All@@ -1625,14 +1615,14 @@ impl<ChanSigner: ChannelKeys> ChannelMonitor<ChanSigner> {
 if revocation_points.0 == commitment_number + 1 { Some(point) } else { None }
 } else { None };
 if let Some(revocation_point) = revocation_point_option {
 let revocation_pubkey = ignore_error!(chan_utils::derive_public_revocation_key(&self.secp_ctx, revocation_point, &self.onchain_detection.keys.pubkeys().revocation_basepoint));
 let b_htlc_key = ignore_error!(chan_utils::derive_public_key(&self.secp_ctx, revocation_point, &self.onchain_detection.keys.pubkeys().htlc_basepoint));
 let htlc_privkey = ignore_error!(chan_utils::derive_private_key(&self.secp_ctx, revocation_point, &self.onchain_detection.keys.htlc_base_key()));
 let revocation_pubkey = ignore_error!(chan_utils::derive_public_revocation_key(&self.secp_ctx, revocation_point, &self.keys.pubkeys().revocation_basepoint));
 let b_htlc_key = ignore_error!(chan_utils::derive_public_key(&self.secp_ctx, revocation_point, &self.keys.pubkeys().htlc_basepoint));
 let htlc_privkey = ignore_error!(chan_utils::derive_private_key(&self.secp_ctx, revocation_point, &self.keys.htlc_base_key()));
 let a_htlc_key = match self.their_htlc_base_key {
 None => return (claimable_outpoints, (commitment_txid, watch_outputs)),
 Some(their_htlc_base_key) => ignore_error!(chan_utils::derive_public_key(&self.secp_ctx, revocation_point, &their_htlc_base_key)),
 };
 let local_payment_key = ignore_error!(chan_utils::derive_private_key(&self.secp_ctx, revocation_point, &self.onchain_detection.keys.payment_base_key()));
 let local_payment_key = ignore_error!(chan_utils::derive_private_key(&self.secp_ctx, revocation_point, &self.keys.payment_base_key()));

 self.broadcasted_remote_payment_script = {
 // Note that the Network here is ignored as we immediately drop the address for the
Expand DownExpand Up@@ -1683,8 +1673,8 @@ impl<ChanSigner: ChannelKeys> ChannelMonitor<ChanSigner> {
 let secret = if let Some(secret) = self.get_secret(commitment_number) { secret } else { return (Vec::new(), None); };
 let per_commitment_key = ignore_error!(SecretKey::from_slice(&secret));
 let per_commitment_point = PublicKey::from_secret_key(&self.secp_ctx, &per_commitment_key);
 let revocation_pubkey = ignore_error!(chan_utils::derive_public_revocation_key(&self.secp_ctx, &per_commitment_point, &self.onchain_detection.keys.pubkeys().revocation_basepoint));
 let revocation_key = ignore_error!(chan_utils::derive_private_revocation_key(&self.secp_ctx, &per_commitment_key, &self.onchain_detection.keys.revocation_base_key()));
 let revocation_pubkey = ignore_error!(chan_utils::derive_public_revocation_key(&self.secp_ctx, &per_commitment_point, &self.keys.pubkeys().revocation_basepoint));
 let revocation_key = ignore_error!(chan_utils::derive_private_revocation_key(&self.secp_ctx, &per_commitment_key, &self.keys.revocation_base_key()));
 let delayed_key = match self.their_delayed_payment_base_key {
 None => return (Vec::new(), None),
 Some(their_delayed_payment_base_key) => ignore_error!(chan_utils::derive_public_key(&self.secp_ctx, &per_commitment_point, &their_delayed_payment_base_key)),
Expand All@@ -1702,7 +1692,7 @@ impl<ChanSigner: ChannelKeys> ChannelMonitor<ChanSigner> {
 let mut watch_outputs = Vec::with_capacity(local_tx.htlc_outputs.len());

 let redeemscript = chan_utils::get_revokeable_redeemscript(&local_tx.revocation_key, self.their_to_self_delay.unwrap(), &local_tx.delayed_payment_key);
 let broadcasted_local_revokable_script = if let Ok(local_delayedkey) = chan_utils::derive_private_key(&self.secp_ctx, &local_tx.per_commitment_point, self.onchain_detection.keys.delayed_payment_base_key()) {
 let broadcasted_local_revokable_script = if let Ok(local_delayedkey) = chan_utils::derive_private_key(&self.secp_ctx, &local_tx.per_commitment_point, self.keys.delayed_payment_base_key()) {
 Some((redeemscript.to_v0_p2wsh(), local_delayedkey, redeemscript))
 } else { None };

Expand DownExpand Up@@ -1883,7 +1873,7 @@ impl<ChanSigner: ChannelKeys> ChannelMonitor<ChanSigner> {
 // which is an easy way to filter out any potential non-matching txn for lazy
 // filters.
 let prevout = &tx.input[0].previous_output;
 let funding_txo = self.onchain_detection.funding_info.clone();
 let funding_txo = self.funding_info.clone();
 if funding_txo.is_none() || (prevout.txid == funding_txo.as_ref().unwrap().0.txid && prevout.vout == funding_txo.as_ref().unwrap().0.index as u32) {
 if (tx.input[0].sequence >> 8*3) as u8 == 0x80 && (tx.lock_time >> 8*3) as u8 == 0x20 {
 let (mut new_outpoints, new_outputs) = self.check_spend_remote_transaction(&tx, height);
Expand DownExpand Up@@ -1920,7 +1910,7 @@ impl<ChanSigner: ChannelKeys> ChannelMonitor<ChanSigner> {
 self.would_broadcast_at_height(height)
 } else { false };
 if should_broadcast {
 claimable_outpoints.push(ClaimRequest { absolute_timelock: height, aggregable: false, outpoint: BitcoinOutPoint { txid: self.onchain_detection.funding_info.as_ref().unwrap().0.txid.clone(), vout: self.onchain_detection.funding_info.as_ref().unwrap().0.index as u32 }, witness_data: InputMaterial::Funding { channel_value: self.channel_value_satoshis.unwrap() }});
 claimable_outpoints.push(ClaimRequest { absolute_timelock: height, aggregable: false, outpoint: BitcoinOutPoint { txid: self.funding_info.as_ref().unwrap().0.txid.clone(), vout: self.funding_info.as_ref().unwrap().0.index as u32 }, witness_data: InputMaterial::Funding { channel_value: self.channel_value_satoshis.unwrap() }});
 }
 if let Some(ref cur_local_tx) = self.current_local_signed_commitment_tx {
 if should_broadcast {
Expand DownExpand Up@@ -2030,12 +2020,12 @@ impl<ChanSigner: ChannelKeys> ChannelMonitor<ChanSigner> {
 scan_commitment!(cur_local_tx.htlc_outputs.iter().map(|&(ref a, _, _)| a), true);
 }

 if let Some(ref txid) = self.onchain_detection.current_remote_commitment_txid {
 if let Some(ref txid) = self.current_remote_commitment_txid {
 if let Some(ref htlc_outputs) = self.remote_claimable_outpoints.get(txid) {
 scan_commitment!(htlc_outputs.iter().map(|&(ref a, _)| a), false);
 }
 }
 if let Some(ref txid) = self.onchain_detection.prev_remote_commitment_txid {
 if let Some(ref txid) = self.prev_remote_commitment_txid {
 if let Some(ref htlc_outputs) = self.remote_claimable_outpoints.get(txid) {
 scan_commitment!(htlc_outputs.iter().map(|&(ref a, _)| a), false);
 }
Expand DownExpand Up@@ -2105,9 +2095,9 @@ impl<ChanSigner: ChannelKeys> ChannelMonitor<ChanSigner> {
 // resolve the source HTLC with the original sender.
 payment_data = Some(((*source).clone(), htlc_output.payment_hash));
 } else if !$local_tx {
 check_htlc_valid_remote!(self.onchain_detection.current_remote_commitment_txid, htlc_output);
 check_htlc_valid_remote!(self.current_remote_commitment_txid, htlc_output);
 if payment_data.is_none() {
 check_htlc_valid_remote!(self.onchain_detection.prev_remote_commitment_txid, htlc_output);
 check_htlc_valid_remote!(self.prev_remote_commitment_txid, htlc_output);
 }
 }
 if payment_data.is_none() {
Expand DownExpand Up@@ -2278,24 +2268,16 @@ impl<ChanSigner: ChannelKeys + Readable> ReadableArgs<Arc<Logger>> for (Sha256dH
 };
 let shutdown_script = Readable::read(reader)?;

 let onchain_detection = {
 let keys = Readable::read(reader)?;
 // Technically this can fail and serialize fail a round-trip, but only for serialization of
 // barely-init'd ChannelMonitors that we can't do anything with.
 let outpoint = OutPoint {
 txid: Readable::read(reader)?,
 index: Readable::read(reader)?,
 };
 let funding_info = Some((outpoint, Readable::read(reader)?));
 let current_remote_commitment_txid = Readable::read(reader)?;
 let prev_remote_commitment_txid = Readable::read(reader)?;
 OnchainDetection {
 keys,
 funding_info,
 current_remote_commitment_txid,
 prev_remote_commitment_txid,
 }
 let keys = Readable::read(reader)?;
 // Technically this can fail and serialize fail a round-trip, but only for serialization of
 // barely-init'd ChannelMonitors that we can't do anything with.
 let outpoint = OutPoint {
 txid: Readable::read(reader)?,
 index: Readable::read(reader)?,
 };
 let funding_info = Some((outpoint, Readable::read(reader)?));
 let current_remote_commitment_txid = Readable::read(reader)?;
 let prev_remote_commitment_txid = Readable::read(reader)?;

 let their_htlc_base_key = Some(Readable::read(reader)?);
 let their_delayed_payment_base_key = Some(Readable::read(reader)?);
Expand DownExpand Up@@ -2508,7 +2490,11 @@ impl<ChanSigner: ChannelKeys + Readable> ReadableArgs<Arc<Logger>> for (Sha256dH
 broadcasted_remote_payment_script,
 shutdown_script,

 onchain_detection,
 keys,
 funding_info,
 current_remote_commitment_txid,
 prev_remote_commitment_txid,

 their_htlc_base_key,
 their_delayed_payment_base_key,
 funding_redeemscript,
Expand Down

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

Skip to content
Flatten ChannelMonitor substructs that don't add clarity#558

New issue

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

 Sign up for GitHub

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

Already on GitHub?
Sign in
to your account

 Merged

TheBlueMatt
merged 2 commits into

from

Apr 19, 2020
 Merged


Flatten ChannelMonitor substructs that don't add clarity
#558
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
3c5ba6b

Drop uneccessary clone() introduced in 16fba9fd664522ac8d24111547b4


TheBlueMatt Mar 21, 2020
b49e63b

Flatten ChannelMonitor substructs that don't add clarity


TheBlueMatt Mar 21, 2020

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


136 changes: 61 additions & 75 deletions
lightning/src/ln/channelmonitor.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -290,7 +290,7 @@ impl<Key : Send + cmp::Eq + hash::Hash + 'static, ChanSigner: ChannelKeys, T: De
 hash_map::Entry::Occupied(_) => return Err(MonitorUpdateError("Channel monitor for given key is already present")),
 hash_map::Entry::Vacant(e) => e,
 };
 match monitor.onchain_detection.funding_info {
 match monitor.funding_info {
 None => {
 return Err(MonitorUpdateError("Try to update a useless monitor without funding_txo !"));
 },
Expand All@@ -314,7 +314,7 @@ impl<Key : Send + cmp::Eq + hash::Hash + 'static, ChanSigner: ChannelKeys, T: De
 let mut monitors = self.monitors.lock().unwrap();
 match monitors.get_mut(&key) {
 Some(orig_monitor) => {
 log_trace!(self, "Updating Channel Monitor for channel {}", log_funding_info!(orig_monitor.onchain_detection));
 log_trace!(self, "Updating Channel Monitor for channel {}", log_funding_info!(orig_monitor));
 orig_monitor.update_monitor(update, &self.broadcaster)
 },
 None => Err(MonitorUpdateError("No such monitor registered"))
Expand DownExpand Up@@ -391,20 +391,6 @@ pub(crate) const LATENCY_GRACE_PERIOD_BLOCKS: u32 = 3;
/// keeping bumping another claim tx to solve the outpoint.
pub(crate) const ANTI_REORG_DELAY: u32 = 6;

struct OnchainDetection<ChanSigner: ChannelKeys> {
	keys: ChanSigner,
	funding_info: Option<(OutPoint, Script)>,
	current_remote_commitment_txid: Option<Sha256dHash>,
	prev_remote_commitment_txid: Option<Sha256dHash>,
}

#[cfg(any(test, feature = "fuzztarget"))]
impl<ChanSigner: ChannelKeys> PartialEq for OnchainDetection<ChanSigner> {
	fn eq(&self, other: &Self) -> bool {
 self.keys.pubkeys() == other.keys.pubkeys()
	}
}

#[derive(Clone, PartialEq)]
struct LocalSignedTx {
	/// txid of the transaction in tx, just used to make comparison faster
Expand DownExpand Up@@ -734,7 +720,11 @@ pub struct ChannelMonitor<ChanSigner: ChannelKeys> {
	broadcasted_remote_payment_script: Option<(Script, SecretKey)>,
	shutdown_script: Script,

	onchain_detection: OnchainDetection<ChanSigner>,
	keys: ChanSigner,
	funding_info: Option<(OutPoint, Script)>,
	current_remote_commitment_txid: Option<Sha256dHash>,
	prev_remote_commitment_txid: Option<Sha256dHash>,

	their_htlc_base_key: Option<PublicKey>,
	their_delayed_payment_base_key: Option<PublicKey>,
	funding_redeemscript: Option<Script>,
Expand DownExpand Up@@ -817,7 +807,10 @@ impl<ChanSigner: ChannelKeys> PartialEq for ChannelMonitor<ChanSigner> {
 self.destination_script != other.destination_script ||
 self.broadcasted_local_revokable_script != other.broadcasted_local_revokable_script ||
 self.broadcasted_remote_payment_script != other.broadcasted_remote_payment_script ||
 self.onchain_detection != other.onchain_detection ||
 self.keys.pubkeys() != other.keys.pubkeys() ||
 self.funding_info != other.funding_info ||
 self.current_remote_commitment_txid != other.current_remote_commitment_txid ||
 self.prev_remote_commitment_txid != other.prev_remote_commitment_txid ||
 self.their_htlc_base_key != other.their_htlc_base_key ||
 self.their_delayed_payment_base_key != other.their_delayed_payment_base_key ||
 self.funding_redeemscript != other.funding_redeemscript ||
Expand DownExpand Up@@ -878,8 +871,8 @@ impl<ChanSigner: ChannelKeys + Writeable> ChannelMonitor<ChanSigner> {
 }
 self.shutdown_script.write(writer)?;

 self.onchain_detection.keys.write(writer)?;
 match self.onchain_detection.funding_info {
 self.keys.write(writer)?;
 match self.funding_info {
 Some((ref outpoint, ref script)) => {
 writer.write_all(&outpoint.txid[..])?;
 writer.write_all(&byte_utils::be16_to_array(outpoint.index))?;
Expand All@@ -889,8 +882,8 @@ impl<ChanSigner: ChannelKeys + Writeable> ChannelMonitor<ChanSigner> {
 debug_assert!(false, "Try to serialize a useless Local monitor !");
 },
 }
 self.onchain_detection.current_remote_commitment_txid.write(writer)?;
 self.onchain_detection.prev_remote_commitment_txid.write(writer)?;
 self.current_remote_commitment_txid.write(writer)?;
 self.prev_remote_commitment_txid.write(writer)?;

 writer.write_all(&self.their_htlc_base_key.as_ref().unwrap().serialize())?;
 writer.write_all(&self.their_delayed_payment_base_key.as_ref().unwrap().serialize())?;
Expand DownExpand Up@@ -1096,13 +1089,6 @@ impl<ChanSigner: ChannelKeys> ChannelMonitor<ChanSigner> {
 let our_channel_close_key_hash = Hash160::hash(&shutdown_pubkey.serialize());
 let shutdown_script = Builder::new().push_opcode(opcodes::all::OP_PUSHBYTES_0).push_slice(&our_channel_close_key_hash[..]).into_script();

 let onchain_detection = OnchainDetection {
 keys: keys.clone(),
 funding_info: Some(funding_info.clone()),
 current_remote_commitment_txid: None,
 prev_remote_commitment_txid: None,
 };

 ChannelMonitor {
 latest_update_id: 0,
 commitment_transaction_number_obscure_factor,
Expand All@@ -1112,7 +1098,11 @@ impl<ChanSigner: ChannelKeys> ChannelMonitor<ChanSigner> {
 broadcasted_remote_payment_script: None,
 shutdown_script,

 onchain_detection: onchain_detection,
 keys: keys.clone(),
 funding_info: Some(funding_info),
 current_remote_commitment_txid: None,
 prev_remote_commitment_txid: None,

 their_htlc_base_key: Some(their_htlc_base_key.clone()),
 their_delayed_payment_base_key: Some(their_delayed_payment_base_key.clone()),
 funding_redeemscript: Some(funding_redeemscript.clone()),
Expand DownExpand Up@@ -1159,7 +1149,7 @@ impl<ChanSigner: ChannelKeys> ChannelMonitor<ChanSigner> {

 // Prune HTLCs from the previous remote commitment tx so we don't generate failure/fulfill
 // events for now-revoked/fulfilled HTLCs.
 if let Some(txid) = self.onchain_detection.prev_remote_commitment_txid.take() {
 if let Some(txid) = self.prev_remote_commitment_txid.take() {
 for &mut (_, ref mut source) in self.remote_claimable_outpoints.get_mut(&txid).unwrap() {
 *source = None;
 }
Expand DownExpand Up@@ -1216,8 +1206,8 @@ impl<ChanSigner: ChannelKeys> ChannelMonitor<ChanSigner> {
 let new_txid = unsigned_commitment_tx.txid();
 log_trace!(self, "Tracking new remote commitment transaction with txid {} at commitment number {} with {} HTLC outputs", new_txid, commitment_number, htlc_outputs.len());
 log_trace!(self, "New potential remote commitment transaction: {}", encode::serialize_hex(unsigned_commitment_tx));
 self.onchain_detection.prev_remote_commitment_txid = self.onchain_detection.current_remote_commitment_txid.take();
 self.onchain_detection.current_remote_commitment_txid = Some(new_txid);
 self.prev_remote_commitment_txid = self.current_remote_commitment_txid.take();
 self.current_remote_commitment_txid = Some(new_txid);
 self.remote_claimable_outpoints.insert(new_txid, htlc_outputs);
 self.current_remote_commitment_number = commitment_number;
 //TODO: Merge this into the other per-remote-transaction output storage stuff
Expand All@@ -1242,11 +1232,11 @@ impl<ChanSigner: ChannelKeys> ChannelMonitor<ChanSigner> {
	}

	pub(super) fn provide_rescue_remote_commitment_tx_info(&mut self, their_revocation_point: PublicKey) {
 if let Ok(payment_key) = chan_utils::derive_public_key(&self.secp_ctx, &their_revocation_point, &self.onchain_detection.keys.pubkeys().payment_basepoint) {
 if let Ok(payment_key) = chan_utils::derive_public_key(&self.secp_ctx, &their_revocation_point, &self.keys.pubkeys().payment_basepoint) {
 let to_remote_script = Builder::new().push_opcode(opcodes::all::OP_PUSHBYTES_0)
 .push_slice(&Hash160::hash(&payment_key.serialize())[..])
 .into_script();
 if let Ok(to_remote_key) = chan_utils::derive_private_key(&self.secp_ctx, &their_revocation_point, &self.onchain_detection.keys.payment_base_key()) {
 if let Ok(to_remote_key) = chan_utils::derive_private_key(&self.secp_ctx, &their_revocation_point, &self.keys.payment_base_key()) {
 self.broadcasted_remote_payment_script = Some((to_remote_script, to_remote_key));
 }
 }
Expand DownExpand Up@@ -1377,7 +1367,7 @@ impl<ChanSigner: ChannelKeys> ChannelMonitor<ChanSigner> {

	/// Gets the funding transaction outpoint of the channel this ChannelMonitor is monitoring for.
	pub fn get_funding_txo(&self) -> Option<OutPoint> {
 if let Some((outp, _)) = self.onchain_detection.funding_info {
 if let Some((outp, _)) = self.funding_info {
 return Some(outp)
 }
 None
Expand DownExpand Up@@ -1469,10 +1459,10 @@ impl<ChanSigner: ChannelKeys> ChannelMonitor<ChanSigner> {
 let secret = self.get_secret(commitment_number).unwrap();
 let per_commitment_key = ignore_error!(SecretKey::from_slice(&secret));
 let per_commitment_point = PublicKey::from_secret_key(&self.secp_ctx, &per_commitment_key);
 let revocation_pubkey = ignore_error!(chan_utils::derive_public_revocation_key(&self.secp_ctx, &per_commitment_point, &self.onchain_detection.keys.pubkeys().revocation_basepoint));
 let revocation_key = ignore_error!(chan_utils::derive_private_revocation_key(&self.secp_ctx, &per_commitment_key, &self.onchain_detection.keys.revocation_base_key()));
 let b_htlc_key = ignore_error!(chan_utils::derive_public_key(&self.secp_ctx, &per_commitment_point, &self.onchain_detection.keys.pubkeys().htlc_basepoint));
 let local_payment_key = ignore_error!(chan_utils::derive_private_key(&self.secp_ctx, &per_commitment_point, &self.onchain_detection.keys.payment_base_key()));
 let revocation_pubkey = ignore_error!(chan_utils::derive_public_revocation_key(&self.secp_ctx, &per_commitment_point, &self.keys.pubkeys().revocation_basepoint));
 let revocation_key = ignore_error!(chan_utils::derive_private_revocation_key(&self.secp_ctx, &per_commitment_key, &self.keys.revocation_base_key()));
 let b_htlc_key = ignore_error!(chan_utils::derive_public_key(&self.secp_ctx, &per_commitment_point, &self.keys.pubkeys().htlc_basepoint));
 let local_payment_key = ignore_error!(chan_utils::derive_private_key(&self.secp_ctx, &per_commitment_point, &self.keys.payment_base_key()));
 let delayed_key = ignore_error!(chan_utils::derive_public_key(&self.secp_ctx, &PublicKey::from_secret_key(&self.secp_ctx, &per_commitment_key), &self.their_delayed_payment_base_key.unwrap()));
 let a_htlc_key = match self.their_htlc_base_key {
 None => return (claimable_outpoints, (commitment_txid, watch_outputs)),
Expand DownExpand Up@@ -1548,10 +1538,10 @@ impl<ChanSigner: ChannelKeys> ChannelMonitor<ChanSigner> {
 }
 }
 }
 if let Some(ref txid) = self.onchain_detection.current_remote_commitment_txid {
 if let Some(ref txid) = self.current_remote_commitment_txid {
 check_htlc_fails!(txid, "current");
 }
 if let Some(ref txid) = self.onchain_detection.prev_remote_commitment_txid {
 if let Some(ref txid) = self.prev_remote_commitment_txid {
 check_htlc_fails!(txid, "remote");
 }
 // No need to check local commitment txn, symmetric HTLCSource must be present as per-htlc data on remote commitment tx
Expand DownExpand Up@@ -1611,10 +1601,10 @@ impl<ChanSigner: ChannelKeys> ChannelMonitor<ChanSigner> {
 }
 }
 }
 if let Some(ref txid) = self.onchain_detection.current_remote_commitment_txid {
 if let Some(ref txid) = self.current_remote_commitment_txid {
 check_htlc_fails!(txid, "current", 'current_loop);
 }
 if let Some(ref txid) = self.onchain_detection.prev_remote_commitment_txid {
 if let Some(ref txid) = self.prev_remote_commitment_txid {
 check_htlc_fails!(txid, "previous", 'prev_loop);
 }

Expand All@@ -1625,14 +1615,14 @@ impl<ChanSigner: ChannelKeys> ChannelMonitor<ChanSigner> {
 if revocation_points.0 == commitment_number + 1 { Some(point) } else { None }
 } else { None };
 if let Some(revocation_point) = revocation_point_option {
 let revocation_pubkey = ignore_error!(chan_utils::derive_public_revocation_key(&self.secp_ctx, revocation_point, &self.onchain_detection.keys.pubkeys().revocation_basepoint));
 let b_htlc_key = ignore_error!(chan_utils::derive_public_key(&self.secp_ctx, revocation_point, &self.onchain_detection.keys.pubkeys().htlc_basepoint));
 let htlc_privkey = ignore_error!(chan_utils::derive_private_key(&self.secp_ctx, revocation_point, &self.onchain_detection.keys.htlc_base_key()));
 let revocation_pubkey = ignore_error!(chan_utils::derive_public_revocation_key(&self.secp_ctx, revocation_point, &self.keys.pubkeys().revocation_basepoint));
 let b_htlc_key = ignore_error!(chan_utils::derive_public_key(&self.secp_ctx, revocation_point, &self.keys.pubkeys().htlc_basepoint));
 let htlc_privkey = ignore_error!(chan_utils::derive_private_key(&self.secp_ctx, revocation_point, &self.keys.htlc_base_key()));
 let a_htlc_key = match self.their_htlc_base_key {
 None => return (claimable_outpoints, (commitment_txid, watch_outputs)),
 Some(their_htlc_base_key) => ignore_error!(chan_utils::derive_public_key(&self.secp_ctx, revocation_point, &their_htlc_base_key)),
 };
 let local_payment_key = ignore_error!(chan_utils::derive_private_key(&self.secp_ctx, revocation_point, &self.onchain_detection.keys.payment_base_key()));
 let local_payment_key = ignore_error!(chan_utils::derive_private_key(&self.secp_ctx, revocation_point, &self.keys.payment_base_key()));

 self.broadcasted_remote_payment_script = {
 // Note that the Network here is ignored as we immediately drop the address for the
Expand DownExpand Up@@ -1683,8 +1673,8 @@ impl<ChanSigner: ChannelKeys> ChannelMonitor<ChanSigner> {
 let secret = if let Some(secret) = self.get_secret(commitment_number) { secret } else { return (Vec::new(), None); };
 let per_commitment_key = ignore_error!(SecretKey::from_slice(&secret));
 let per_commitment_point = PublicKey::from_secret_key(&self.secp_ctx, &per_commitment_key);
 let revocation_pubkey = ignore_error!(chan_utils::derive_public_revocation_key(&self.secp_ctx, &per_commitment_point, &self.onchain_detection.keys.pubkeys().revocation_basepoint));
 let revocation_key = ignore_error!(chan_utils::derive_private_revocation_key(&self.secp_ctx, &per_commitment_key, &self.onchain_detection.keys.revocation_base_key()));
 let revocation_pubkey = ignore_error!(chan_utils::derive_public_revocation_key(&self.secp_ctx, &per_commitment_point, &self.keys.pubkeys().revocation_basepoint));
 let revocation_key = ignore_error!(chan_utils::derive_private_revocation_key(&self.secp_ctx, &per_commitment_key, &self.keys.revocation_base_key()));
 let delayed_key = match self.their_delayed_payment_base_key {
 None => return (Vec::new(), None),
 Some(their_delayed_payment_base_key) => ignore_error!(chan_utils::derive_public_key(&self.secp_ctx, &per_commitment_point, &their_delayed_payment_base_key)),
Expand All@@ -1702,7 +1692,7 @@ impl<ChanSigner: ChannelKeys> ChannelMonitor<ChanSigner> {
 let mut watch_outputs = Vec::with_capacity(local_tx.htlc_outputs.len());

 let redeemscript = chan_utils::get_revokeable_redeemscript(&local_tx.revocation_key, self.their_to_self_delay.unwrap(), &local_tx.delayed_payment_key);
 let broadcasted_local_revokable_script = if let Ok(local_delayedkey) = chan_utils::derive_private_key(&self.secp_ctx, &local_tx.per_commitment_point, self.onchain_detection.keys.delayed_payment_base_key()) {
 let broadcasted_local_revokable_script = if let Ok(local_delayedkey) = chan_utils::derive_private_key(&self.secp_ctx, &local_tx.per_commitment_point, self.keys.delayed_payment_base_key()) {
 Some((redeemscript.to_v0_p2wsh(), local_delayedkey, redeemscript))
 } else { None };

Expand DownExpand Up@@ -1883,7 +1873,7 @@ impl<ChanSigner: ChannelKeys> ChannelMonitor<ChanSigner> {
 // which is an easy way to filter out any potential non-matching txn for lazy
 // filters.
 let prevout = &tx.input[0].previous_output;
 let funding_txo = self.onchain_detection.funding_info.clone();
 let funding_txo = self.funding_info.clone();
 if funding_txo.is_none() || (prevout.txid == funding_txo.as_ref().unwrap().0.txid && prevout.vout == funding_txo.as_ref().unwrap().0.index as u32) {
 if (tx.input[0].sequence >> 8*3) as u8 == 0x80 && (tx.lock_time >> 8*3) as u8 == 0x20 {
 let (mut new_outpoints, new_outputs) = self.check_spend_remote_transaction(&tx, height);
Expand DownExpand Up@@ -1920,7 +1910,7 @@ impl<ChanSigner: ChannelKeys> ChannelMonitor<ChanSigner> {
 self.would_broadcast_at_height(height)
 } else { false };
 if should_broadcast {
 claimable_outpoints.push(ClaimRequest { absolute_timelock: height, aggregable: false, outpoint: BitcoinOutPoint { txid: self.onchain_detection.funding_info.as_ref().unwrap().0.txid.clone(), vout: self.onchain_detection.funding_info.as_ref().unwrap().0.index as u32 }, witness_data: InputMaterial::Funding { channel_value: self.channel_value_satoshis.unwrap() }});
 claimable_outpoints.push(ClaimRequest { absolute_timelock: height, aggregable: false, outpoint: BitcoinOutPoint { txid: self.funding_info.as_ref().unwrap().0.txid.clone(), vout: self.funding_info.as_ref().unwrap().0.index as u32 }, witness_data: InputMaterial::Funding { channel_value: self.channel_value_satoshis.unwrap() }});
 }
 if let Some(ref cur_local_tx) = self.current_local_signed_commitment_tx {
 if should_broadcast {
Expand DownExpand Up@@ -2030,12 +2020,12 @@ impl<ChanSigner: ChannelKeys> ChannelMonitor<ChanSigner> {
 scan_commitment!(cur_local_tx.htlc_outputs.iter().map(|&(ref a, _, _)| a), true);
 }

 if let Some(ref txid) = self.onchain_detection.current_remote_commitment_txid {
 if let Some(ref txid) = self.current_remote_commitment_txid {
 if let Some(ref htlc_outputs) = self.remote_claimable_outpoints.get(txid) {
 scan_commitment!(htlc_outputs.iter().map(|&(ref a, _)| a), false);
 }
 }
 if let Some(ref txid) = self.onchain_detection.prev_remote_commitment_txid {
 if let Some(ref txid) = self.prev_remote_commitment_txid {
 if let Some(ref htlc_outputs) = self.remote_claimable_outpoints.get(txid) {
 scan_commitment!(htlc_outputs.iter().map(|&(ref a, _)| a), false);
 }
Expand DownExpand Up@@ -2105,9 +2095,9 @@ impl<ChanSigner: ChannelKeys> ChannelMonitor<ChanSigner> {
 // resolve the source HTLC with the original sender.
 payment_data = Some(((*source).clone(), htlc_output.payment_hash));
 } else if !$local_tx {
 check_htlc_valid_remote!(self.onchain_detection.current_remote_commitment_txid, htlc_output);
 check_htlc_valid_remote!(self.current_remote_commitment_txid, htlc_output);
 if payment_data.is_none() {
 check_htlc_valid_remote!(self.onchain_detection.prev_remote_commitment_txid, htlc_output);
 check_htlc_valid_remote!(self.prev_remote_commitment_txid, htlc_output);
 }
 }
 if payment_data.is_none() {
Expand DownExpand Up@@ -2278,24 +2268,16 @@ impl<ChanSigner: ChannelKeys + Readable> ReadableArgs<Arc<Logger>> for (Sha256dH
 };
 let shutdown_script = Readable::read(reader)?;

 let onchain_detection = {
 let keys = Readable::read(reader)?;
 // Technically this can fail and serialize fail a round-trip, but only for serialization of
 // barely-init'd ChannelMonitors that we can't do anything with.
 let outpoint = OutPoint {
 txid: Readable::read(reader)?,
 index: Readable::read(reader)?,
 };
 let funding_info = Some((outpoint, Readable::read(reader)?));
 let current_remote_commitment_txid = Readable::read(reader)?;
 let prev_remote_commitment_txid = Readable::read(reader)?;
 OnchainDetection {
 keys,
 funding_info,
 current_remote_commitment_txid,
 prev_remote_commitment_txid,
 }
 let keys = Readable::read(reader)?;
 // Technically this can fail and serialize fail a round-trip, but only for serialization of
 // barely-init'd ChannelMonitors that we can't do anything with.
 let outpoint = OutPoint {
 txid: Readable::read(reader)?,
 index: Readable::read(reader)?,
 };
 let funding_info = Some((outpoint, Readable::read(reader)?));
 let current_remote_commitment_txid = Readable::read(reader)?;
 let prev_remote_commitment_txid = Readable::read(reader)?;

 let their_htlc_base_key = Some(Readable::read(reader)?);
 let their_delayed_payment_base_key = Some(Readable::read(reader)?);
Expand DownExpand Up@@ -2508,7 +2490,11 @@ impl<ChanSigner: ChannelKeys + Readable> ReadableArgs<Arc<Logger>> for (Sha256dH
 broadcasted_remote_payment_script,
 shutdown_script,

 onchain_detection,
 keys,
 funding_info,
 current_remote_commitment_txid,
 prev_remote_commitment_txid,

 their_htlc_base_key,
 their_delayed_payment_base_key,
 funding_redeemscript,
Expand Down