X-Git-Url: http://git.bitcoin.ninja/index.cgi?a=blobdiff_plain;f=lightning%2Fsrc%2Fln%2Fchannelmonitor.rs;h=c480260938e1e221973b19f2ff7840c2b7c863e7;hb=f328094b49dcbc9967d17d5706992a6bf167de23;hp=a1577712fdd8e2196529535fa912c3432c46aebd;hpb=bae2338b4dc1b8e33ac97b8b867fb68592fdb91b;p=rust-lightning diff --git a/lightning/src/ln/channelmonitor.rs b/lightning/src/ln/channelmonitor.rs index a1577712..c4802609 100644 --- a/lightning/src/ln/channelmonitor.rs +++ b/lightning/src/ln/channelmonitor.rs @@ -31,7 +31,7 @@ use secp256k1; use ln::msgs::DecodeError; use ln::chan_utils; -use ln::chan_utils::{HTLCOutputInCommitment, LocalCommitmentTransaction, HTLCType}; +use ln::chan_utils::{CounterpartyCommitmentSecrets, HTLCOutputInCommitment, LocalCommitmentTransaction, HTLCType}; use ln::channelmanager::{HTLCSource, PaymentPreimage, PaymentHash}; use chain::chaininterface::{ChainListener, ChainWatchInterface, BroadcasterInterface, FeeEstimator, ConfirmationTarget, MIN_RELAY_FEE_SAT_PER_1000_WEIGHT}; use chain::transaction::OutPoint; @@ -43,6 +43,46 @@ use util::{byte_utils, events}; use std::collections::{HashMap, hash_map, HashSet}; use std::sync::{Arc,Mutex}; use std::{hash,cmp, mem}; +use std::ops::Deref; + +/// An update generated by the underlying Channel itself which contains some new information the +/// ChannelMonitor should be made aware of. +#[cfg_attr(test, derive(PartialEq))] +#[derive(Clone)] +#[must_use] +pub struct ChannelMonitorUpdate { + pub(super) updates: Vec, + /// The sequence number of this update. Updates *must* be replayed in-order according to this + /// sequence number (and updates may panic if they are not). The update_id values are strictly + /// increasing and increase by one for each new update. + /// + /// This sequence number is also used to track up to which points updates which returned + /// ChannelMonitorUpdateErr::TemporaryFailure have been applied to all copies of a given + /// ChannelMonitor when ChannelManager::channel_monitor_updated is called. + pub update_id: u64, +} + +impl Writeable for ChannelMonitorUpdate { + fn write(&self, w: &mut W) -> Result<(), ::std::io::Error> { + self.update_id.write(w)?; + (self.updates.len() as u64).write(w)?; + for update_step in self.updates.iter() { + update_step.write(w)?; + } + Ok(()) + } +} +impl Readable for ChannelMonitorUpdate { + fn read(r: &mut R) -> Result { + let update_id: u64 = Readable::read(r)?; + let len: u64 = Readable::read(r)?; + let mut updates = Vec::with_capacity(cmp::min(len as usize, MAX_ALLOC_SIZE / ::std::mem::size_of::())); + for _ in 0..len { + updates.push(Readable::read(r)?); + } + Ok(Self { update_id, updates }) + } +} /// An error enum representing a failure to persist a channel monitor update. #[derive(Clone)] @@ -51,13 +91,13 @@ pub enum ChannelMonitorUpdateErr { /// our state failed, but is expected to succeed at some point in the future). /// /// Such a failure will "freeze" a channel, preventing us from revoking old states or - /// submitting new commitment transactions to the remote party. - /// ChannelManager::test_restore_channel_monitor can be used to retry the update(s) and restore - /// the channel to an operational state. + /// submitting new commitment transactions to the remote party. Once the update(s) which failed + /// have been successfully applied, ChannelManager::channel_monitor_updated can be used to + /// restore the channel to an operational state. /// - /// Note that continuing to operate when no copy of the updated ChannelMonitor could be - /// persisted is unsafe - if you failed to store the update on your own local disk you should - /// instead return PermanentFailure to force closure of the channel ASAP. + /// Note that a given ChannelManager will *never* re-generate a given ChannelMonitorUpdate. If + /// you return a TemporaryFailure you must ensure that it is written to disk safely before + /// writing out the latest ChannelManager state. /// /// Even when a channel has been "frozen" updates to the ChannelMonitor can continue to occur /// (eg if an inbound HTLC which we forwarded was claimed upstream resulting in us attempting @@ -68,8 +108,15 @@ pub enum ChannelMonitorUpdateErr { /// been "frozen". /// /// Note that even if updates made after TemporaryFailure succeed you must still call - /// test_restore_channel_monitor to ensure you have the latest monitor and re-enable normal - /// channel operation. + /// channel_monitor_updated to ensure you have the latest monitor and re-enable normal channel + /// operation. + /// + /// Note that the update being processed here will not be replayed for you when you call + /// ChannelManager::channel_monitor_updated, so you must store the update itself along + /// with the persisted ChannelMonitor on your own local disk prior to returning a + /// TemporaryFailure. You may, of course, employ a journaling approach, storing only the + /// ChannelMonitorUpdate on disk without updating the monitor itself, replaying the journal at + /// reload-time. /// /// For deployments where a copy of ChannelMonitors and other local state are backed up in a /// remote location (with local copies persisted immediately), it is anticipated that all @@ -84,24 +131,26 @@ pub enum ChannelMonitorUpdateErr { } /// General Err type for ChannelMonitor actions. Generally, this implies that the data provided is -/// inconsistent with the ChannelMonitor being called. eg for ChannelMonitor::insert_combine this -/// means you tried to merge two monitors for different channels or for a channel which was -/// restored from a backup and then generated new commitment updates. +/// inconsistent with the ChannelMonitor being called. eg for ChannelMonitor::update_monitor this +/// means you tried to update a monitor for a different channel or the ChannelMonitorUpdate was +/// corrupted. /// Contains a human-readable error message. #[derive(Debug)] pub struct MonitorUpdateError(pub &'static str); /// Simple structure send back by ManyChannelMonitor in case of HTLC detected onchain from a /// forward channel and from which info are needed to update HTLC in a backward channel. +#[derive(Clone, PartialEq)] pub struct HTLCUpdate { pub(super) payment_hash: PaymentHash, pub(super) payment_preimage: Option, pub(super) source: HTLCSource } +impl_writeable!(HTLCUpdate, 0, { payment_hash, payment_preimage, source }); /// Simple trait indicating ability to track a set of ChannelMonitors and multiplex events between /// them. Generally should be implemented by keeping a local SimpleManyChannelMonitor and passing -/// events to it, while also taking any add_update_monitor events and passing them to some remote +/// events to it, while also taking any add/update_monitor events and passing them to some remote /// server(s). /// /// Note that any updates to a channel's monitor *must* be applied to each instance of the @@ -115,16 +164,41 @@ pub struct HTLCUpdate { /// BlockNotifier and call the BlockNotifier's `block_(dis)connected` methods, which will notify /// all registered listeners in one go. pub trait ManyChannelMonitor: Send + Sync { - /// Adds or updates a monitor for the given `funding_txo`. + /// Adds a monitor for the given `funding_txo`. + /// + /// Implementer must also ensure that the funding_txo txid *and* outpoint are registered with + /// any relevant ChainWatchInterfaces such that the provided monitor receives block_connected + /// callbacks with the funding transaction, or any spends of it. + /// + /// Further, the implementer must also ensure that each output returned in + /// monitor.get_outputs_to_watch() is registered to ensure that the provided monitor learns about + /// any spends of any of the outputs. /// - /// Implementor must also ensure that the funding_txo outpoint is registered with any relevant - /// ChainWatchInterfaces such that the provided monitor receives block_connected callbacks with - /// any spends of it. - fn add_update_monitor(&self, funding_txo: OutPoint, monitor: ChannelMonitor) -> Result<(), ChannelMonitorUpdateErr>; + /// Any spends of outputs which should have been registered which aren't passed to + /// ChannelMonitors via block_connected may result in FUNDS LOSS. + fn add_monitor(&self, funding_txo: OutPoint, monitor: ChannelMonitor) -> Result<(), ChannelMonitorUpdateErr>; + + /// Updates a monitor for the given `funding_txo`. + /// + /// Implementer must also ensure that the funding_txo txid *and* outpoint are registered with + /// any relevant ChainWatchInterfaces such that the provided monitor receives block_connected + /// callbacks with the funding transaction, or any spends of it. + /// + /// Further, the implementer must also ensure that each output returned in + /// monitor.get_watch_outputs() is registered to ensure that the provided monitor learns about + /// any spends of any of the outputs. + /// + /// Any spends of outputs which should have been registered which aren't passed to + /// ChannelMonitors via block_connected may result in FUNDS LOSS. + fn update_monitor(&self, funding_txo: OutPoint, monitor: ChannelMonitorUpdate) -> Result<(), ChannelMonitorUpdateErr>; /// Used by ChannelManager to get list of HTLC resolved onchain and which needed to be updated - /// with success or failure backward - fn fetch_pending_htlc_updated(&self) -> Vec; + /// with success or failure. + /// + /// You should probably just call through to + /// ChannelMonitor::get_and_clear_pending_htlcs_updated() for each ChannelMonitor and return + /// the full list. + fn get_and_clear_pending_htlcs_updated(&self) -> Vec; } /// A simple implementation of a ManyChannelMonitor and ChainListener. Can be used to create a @@ -138,28 +212,28 @@ pub trait ManyChannelMonitor: Send + Sync { /// /// If you're using this for local monitoring of your own channels, you probably want to use /// `OutPoint` as the key, which will give you a ManyChannelMonitor implementation. -pub struct SimpleManyChannelMonitor { +pub struct SimpleManyChannelMonitor where T::Target: BroadcasterInterface { #[cfg(test)] // Used in ChannelManager tests to manipulate channels directly pub monitors: Mutex>>, #[cfg(not(test))] monitors: Mutex>>, chain_monitor: Arc, - broadcaster: Arc, + broadcaster: T, pending_events: Mutex>, - pending_htlc_updated: Mutex)>>>, logger: Arc, fee_estimator: Arc } -impl<'a, Key : Send + cmp::Eq + hash::Hash, ChanSigner: ChannelKeys> ChainListener for SimpleManyChannelMonitor { +impl<'a, Key : Send + cmp::Eq + hash::Hash, ChanSigner: ChannelKeys, T: Deref + Sync + Send> ChainListener for SimpleManyChannelMonitor + where T::Target: BroadcasterInterface +{ fn block_connected(&self, header: &BlockHeader, height: u32, txn_matched: &[&Transaction], _indexes_of_txn_matched: &[u32]) { let block_hash = header.bitcoin_hash(); let mut new_events: Vec = Vec::with_capacity(0); - let mut htlc_updated_infos = Vec::new(); { let mut monitors = self.monitors.lock().unwrap(); for monitor in monitors.values_mut() { - let (txn_outputs, spendable_outputs, mut htlc_updated) = monitor.block_connected(txn_matched, height, &block_hash, &*self.broadcaster, &*self.fee_estimator); + let (txn_outputs, spendable_outputs) = monitor.block_connected(txn_matched, height, &block_hash, &*self.broadcaster, &*self.fee_estimator); if spendable_outputs.len() > 0 { new_events.push(events::Event::SpendableOutputs { outputs: spendable_outputs, @@ -171,35 +245,6 @@ impl<'a, Key : Send + cmp::Eq + hash::Hash, ChanSigner: ChannelKeys> ChainListen self.chain_monitor.install_watch_outpoint((txid.clone(), idx as u32), &output.script_pubkey); } } - htlc_updated_infos.append(&mut htlc_updated); - } - } - { - // ChannelManager will just need to fetch pending_htlc_updated and pass state backward - let mut pending_htlc_updated = self.pending_htlc_updated.lock().unwrap(); - for htlc in htlc_updated_infos.drain(..) { - match pending_htlc_updated.entry(htlc.2) { - hash_map::Entry::Occupied(mut e) => { - // In case of reorg we may have htlc outputs solved in a different way so - // we prefer to keep claims but don't store duplicate updates for a given - // (payment_hash, HTLCSource) pair. - let mut existing_claim = false; - e.get_mut().retain(|htlc_data| { - if htlc.0 == htlc_data.0 { - if htlc_data.1.is_some() { - existing_claim = true; - true - } else { false } - } else { true } - }); - if !existing_claim { - e.get_mut().push((htlc.0, htlc.1)); - } - } - hash_map::Entry::Vacant(e) => { - e.insert(vec![(htlc.0, htlc.1)]); - } - } } } let mut pending_events = self.pending_events.lock().unwrap(); @@ -215,16 +260,17 @@ impl<'a, Key : Send + cmp::Eq + hash::Hash, ChanSigner: ChannelKeys> ChainListen } } -impl SimpleManyChannelMonitor { +impl SimpleManyChannelMonitor + where T::Target: BroadcasterInterface +{ /// Creates a new object which can be used to monitor several channels given the chain /// interface with which to register to receive notifications. - pub fn new(chain_monitor: Arc, broadcaster: Arc, logger: Arc, feeest: Arc) -> SimpleManyChannelMonitor { + pub fn new(chain_monitor: Arc, broadcaster: T, logger: Arc, feeest: Arc) -> SimpleManyChannelMonitor { let res = SimpleManyChannelMonitor { monitors: Mutex::new(HashMap::new()), chain_monitor, broadcaster, pending_events: Mutex::new(Vec::new()), - pending_htlc_updated: Mutex::new(HashMap::new()), logger, fee_estimator: feeest, }; @@ -233,14 +279,11 @@ impl Simpl } /// Adds or updates the monitor which monitors the channel referred to by the given key. - pub fn add_update_monitor_by_key(&self, key: Key, monitor: ChannelMonitor) -> Result<(), MonitorUpdateError> { + pub fn add_monitor_by_key(&self, key: Key, monitor: ChannelMonitor) -> Result<(), MonitorUpdateError> { 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!(monitor.key_storage)); - return orig_monitor.insert_combine(monitor); - }, - None => {} + let entry = match monitors.entry(key) { + hash_map::Entry::Occupied(_) => return Err(MonitorUpdateError("Channel monitor for given key is already present")), + hash_map::Entry::Vacant(e) => e, }; match monitor.key_storage { Storage::Local { ref funding_info, .. } => { @@ -259,36 +302,57 @@ impl Simpl self.chain_monitor.watch_all_txn(); } } - monitors.insert(key, monitor); + for (txid, outputs) in monitor.get_outputs_to_watch().iter() { + for (idx, script) in outputs.iter().enumerate() { + self.chain_monitor.install_watch_outpoint((*txid, idx as u32), script); + } + } + entry.insert(monitor); Ok(()) } + + /// Updates the monitor which monitors the channel referred to by the given key. + pub fn update_monitor_by_key(&self, key: Key, update: ChannelMonitorUpdate) -> Result<(), MonitorUpdateError> { + 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.key_storage)); + orig_monitor.update_monitor(update) + }, + None => Err(MonitorUpdateError("No such monitor registered")) + } + } } -impl ManyChannelMonitor for SimpleManyChannelMonitor { - fn add_update_monitor(&self, funding_txo: OutPoint, monitor: ChannelMonitor) -> Result<(), ChannelMonitorUpdateErr> { - match self.add_update_monitor_by_key(funding_txo, monitor) { +impl ManyChannelMonitor for SimpleManyChannelMonitor + where T::Target: BroadcasterInterface +{ + fn add_monitor(&self, funding_txo: OutPoint, monitor: ChannelMonitor) -> Result<(), ChannelMonitorUpdateErr> { + match self.add_monitor_by_key(funding_txo, monitor) { Ok(_) => Ok(()), Err(_) => Err(ChannelMonitorUpdateErr::PermanentFailure), } } - fn fetch_pending_htlc_updated(&self) -> Vec { - let mut updated = self.pending_htlc_updated.lock().unwrap(); - let mut pending_htlcs_updated = Vec::with_capacity(updated.len()); - for (k, v) in updated.drain() { - for htlc_data in v { - pending_htlcs_updated.push(HTLCUpdate { - payment_hash: k, - payment_preimage: htlc_data.1, - source: htlc_data.0, - }); - } + fn update_monitor(&self, funding_txo: OutPoint, update: ChannelMonitorUpdate) -> Result<(), ChannelMonitorUpdateErr> { + match self.update_monitor_by_key(funding_txo, update) { + Ok(_) => Ok(()), + Err(_) => Err(ChannelMonitorUpdateErr::PermanentFailure), + } + } + + fn get_and_clear_pending_htlcs_updated(&self) -> Vec { + let mut pending_htlcs_updated = Vec::new(); + for chan in self.monitors.lock().unwrap().values_mut() { + pending_htlcs_updated.append(&mut chan.get_and_clear_pending_htlcs_updated()); } pending_htlcs_updated } } -impl events::EventsProvider for SimpleManyChannelMonitor { +impl events::EventsProvider for SimpleManyChannelMonitor + where T::Target: BroadcasterInterface +{ fn get_and_clear_pending_events(&self) -> Vec { let mut pending_events = self.pending_events.lock().unwrap(); let mut ret = Vec::new(); @@ -326,7 +390,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; -#[derive(Clone)] enum Storage { Local { keys: ChanSigner, @@ -581,13 +644,148 @@ impl Readable for ClaimTxBumpMaterial { const SERIALIZATION_VERSION: u8 = 1; const MIN_SERIALIZATION_VERSION: u8 = 1; +#[cfg_attr(test, derive(PartialEq))] +#[derive(Clone)] +pub(super) enum ChannelMonitorUpdateStep { + LatestLocalCommitmentTXInfo { + // TODO: We really need to not be generating a fully-signed transaction in Channel and + // passing it here, we need to hold off so that the ChanSigner can enforce a + // only-sign-local-state-for-broadcast once invariant: + commitment_tx: LocalCommitmentTransaction, + local_keys: chan_utils::TxCreationKeys, + feerate_per_kw: u64, + htlc_outputs: Vec<(HTLCOutputInCommitment, Option, Option)>, + }, + LatestRemoteCommitmentTXInfo { + unsigned_commitment_tx: Transaction, // TODO: We should actually only need the txid here + htlc_outputs: Vec<(HTLCOutputInCommitment, Option>)>, + commitment_number: u64, + their_revocation_point: PublicKey, + }, + PaymentPreimage { + payment_preimage: PaymentPreimage, + }, + CommitmentSecret { + idx: u64, + secret: [u8; 32], + }, + /// Indicates our channel is likely a stale version, we're closing, but this update should + /// allow us to spend what is ours if our counterparty broadcasts their latest state. + RescueRemoteCommitmentTXInfo { + their_current_per_commitment_point: PublicKey, + }, +} + +impl Writeable for ChannelMonitorUpdateStep { + fn write(&self, w: &mut W) -> Result<(), ::std::io::Error> { + match self { + &ChannelMonitorUpdateStep::LatestLocalCommitmentTXInfo { ref commitment_tx, ref local_keys, ref feerate_per_kw, ref htlc_outputs } => { + 0u8.write(w)?; + commitment_tx.write(w)?; + local_keys.write(w)?; + feerate_per_kw.write(w)?; + (htlc_outputs.len() as u64).write(w)?; + for &(ref output, ref signature, ref source) in htlc_outputs.iter() { + output.write(w)?; + signature.write(w)?; + source.write(w)?; + } + } + &ChannelMonitorUpdateStep::LatestRemoteCommitmentTXInfo { ref unsigned_commitment_tx, ref htlc_outputs, ref commitment_number, ref their_revocation_point } => { + 1u8.write(w)?; + unsigned_commitment_tx.write(w)?; + commitment_number.write(w)?; + their_revocation_point.write(w)?; + (htlc_outputs.len() as u64).write(w)?; + for &(ref output, ref source) in htlc_outputs.iter() { + output.write(w)?; + match source { + &None => 0u8.write(w)?, + &Some(ref s) => { + 1u8.write(w)?; + s.write(w)?; + }, + } + } + }, + &ChannelMonitorUpdateStep::PaymentPreimage { ref payment_preimage } => { + 2u8.write(w)?; + payment_preimage.write(w)?; + }, + &ChannelMonitorUpdateStep::CommitmentSecret { ref idx, ref secret } => { + 3u8.write(w)?; + idx.write(w)?; + secret.write(w)?; + }, + &ChannelMonitorUpdateStep::RescueRemoteCommitmentTXInfo { ref their_current_per_commitment_point } => { + 4u8.write(w)?; + their_current_per_commitment_point.write(w)?; + }, + } + Ok(()) + } +} +impl Readable for ChannelMonitorUpdateStep { + fn read(r: &mut R) -> Result { + match Readable::read(r)? { + 0u8 => { + Ok(ChannelMonitorUpdateStep::LatestLocalCommitmentTXInfo { + commitment_tx: Readable::read(r)?, + local_keys: Readable::read(r)?, + feerate_per_kw: Readable::read(r)?, + htlc_outputs: { + let len: u64 = Readable::read(r)?; + let mut res = Vec::new(); + for _ in 0..len { + res.push((Readable::read(r)?, Readable::read(r)?, Readable::read(r)?)); + } + res + }, + }) + }, + 1u8 => { + Ok(ChannelMonitorUpdateStep::LatestRemoteCommitmentTXInfo { + unsigned_commitment_tx: Readable::read(r)?, + commitment_number: Readable::read(r)?, + their_revocation_point: Readable::read(r)?, + htlc_outputs: { + let len: u64 = Readable::read(r)?; + let mut res = Vec::new(); + for _ in 0..len { + res.push((Readable::read(r)?, as Readable>::read(r)?.map(|o| Box::new(o)))); + } + res + }, + }) + }, + 2u8 => { + Ok(ChannelMonitorUpdateStep::PaymentPreimage { + payment_preimage: Readable::read(r)?, + }) + }, + 3u8 => { + Ok(ChannelMonitorUpdateStep::CommitmentSecret { + idx: Readable::read(r)?, + secret: Readable::read(r)?, + }) + }, + 4u8 => { + Ok(ChannelMonitorUpdateStep::RescueRemoteCommitmentTXInfo { + their_current_per_commitment_point: Readable::read(r)?, + }) + }, + _ => Err(DecodeError::InvalidValue), + } + } +} + /// A ChannelMonitor handles chain events (blocks connected and disconnected) and generates /// on-chain transactions to ensure no loss of funds occurs. /// /// You MUST ensure that no ChannelMonitors for a given channel anywhere contain out-of-date /// information and are actively monitoring the chain. -#[derive(Clone)] pub struct ChannelMonitor { + latest_update_id: u64, commitment_transaction_number_obscure_factor: u64, key_storage: Storage, @@ -601,7 +799,7 @@ pub struct ChannelMonitor { our_to_self_delay: u16, their_to_self_delay: Option, - old_secrets: [([u8; 32], u64); 49], + commitment_secrets: CounterpartyCommitmentSecrets, remote_claimable_outpoints: HashMap>)>>, /// We cannot identify HTLC-Success or HTLC-Timeout transactions by themselves on the chain. /// Nor can we figure out their commitment numbers without the commitment transaction they are @@ -628,6 +826,8 @@ pub struct ChannelMonitor { payment_preimages: HashMap, + pending_htlcs_updated: Vec, + destination_script: Script, // Thanks to data loss protection, we may be able to claim our non-htlc funds // back, this is the script we have to spend from but we need to @@ -666,16 +866,21 @@ pub struct ChannelMonitor { // actions when we receive a block with given height. Actions depend on OnchainEvent type. onchain_events_waiting_threshold_conf: HashMap>, + // If we get serialized out and re-read, we need to make sure that the chain monitoring + // interface knows about the TXOs that we want to be notified of spends of. We could probably + // be smart and derive them from the above storage fields, but its much simpler and more + // Obviously Correct (tm) if we just keep track of them explicitly. + outputs_to_watch: HashMap>, + // We simply modify last_block_hash in Channel's block_connected so that serialization is // consistent but hopefully the users' copy handles block_connected in a consistent way. - // (we do *not*, however, update them in insert_combine to ensure any local user copies keep + // (we do *not*, however, update them in update_monitor to ensure any local user copies keep // their last_block_hash from its state and not based on updated copies that didn't run through // the full block_connected). pub(crate) last_block_hash: Sha256dHash, secp_ctx: Secp256k1, //TODO: dedup this a bit... logger: Arc, } - macro_rules! subtract_high_prio_fee { ($self: ident, $fee_estimator: expr, $value: expr, $predicted_weight: expr, $used_feerate: expr) => { { @@ -716,7 +921,8 @@ macro_rules! subtract_high_prio_fee { /// underlying object impl PartialEq for ChannelMonitor { fn eq(&self, other: &Self) -> bool { - if self.commitment_transaction_number_obscure_factor != other.commitment_transaction_number_obscure_factor || + if self.latest_update_id != other.latest_update_id || + self.commitment_transaction_number_obscure_factor != other.commitment_transaction_number_obscure_factor || self.key_storage != other.key_storage || self.their_htlc_base_key != other.their_htlc_base_key || self.their_delayed_payment_base_key != other.their_delayed_payment_base_key || @@ -725,6 +931,7 @@ impl PartialEq for ChannelMonitor { self.their_cur_revocation_points != other.their_cur_revocation_points || self.our_to_self_delay != other.our_to_self_delay || self.their_to_self_delay != other.their_to_self_delay || + self.commitment_secrets != other.commitment_secrets || self.remote_claimable_outpoints != other.remote_claimable_outpoints || self.remote_commitment_txn_on_chain != other.remote_commitment_txn_on_chain || self.remote_hash_commitment_number != other.remote_hash_commitment_number || @@ -732,19 +939,16 @@ impl PartialEq for ChannelMonitor { self.current_remote_commitment_number != other.current_remote_commitment_number || self.current_local_signed_commitment_tx != other.current_local_signed_commitment_tx || self.payment_preimages != other.payment_preimages || + self.pending_htlcs_updated != other.pending_htlcs_updated || self.destination_script != other.destination_script || self.to_remote_rescue != other.to_remote_rescue || self.pending_claim_requests != other.pending_claim_requests || self.claimable_outpoints != other.claimable_outpoints || - self.onchain_events_waiting_threshold_conf != other.onchain_events_waiting_threshold_conf + self.onchain_events_waiting_threshold_conf != other.onchain_events_waiting_threshold_conf || + self.outputs_to_watch != other.outputs_to_watch { false } else { - for (&(ref secret, ref idx), &(ref o_secret, ref o_idx)) in self.old_secrets.iter().zip(other.old_secrets.iter()) { - if secret != o_secret || idx != o_idx { - return false - } - } true } } @@ -758,6 +962,8 @@ impl ChannelMonitor { writer.write_all(&[SERIALIZATION_VERSION; 1])?; writer.write_all(&[MIN_SERIALIZATION_VERSION; 1])?; + self.latest_update_id.write(writer)?; + // Set in initial Channel-object creation, so should always be set by now: U48(self.commitment_transaction_number_obscure_factor).write(writer)?; @@ -825,10 +1031,7 @@ impl ChannelMonitor { writer.write_all(&byte_utils::be16_to_array(self.our_to_self_delay))?; writer.write_all(&byte_utils::be16_to_array(self.their_to_self_delay.unwrap()))?; - for &(ref secret, ref idx) in self.old_secrets.iter() { - writer.write_all(secret)?; - writer.write_all(&byte_utils::be64_to_array(*idx))?; - } + self.commitment_secrets.write(writer)?; macro_rules! serialize_htlc_in_commitment { ($htlc_output: expr) => { @@ -919,6 +1122,11 @@ impl ChannelMonitor { writer.write_all(&payment_preimage.0[..])?; } + writer.write_all(&byte_utils::be64_to_array(self.pending_htlcs_updated.len() as u64))?; + for data in self.pending_htlcs_updated.iter() { + data.write(writer)?; + } + self.last_block_hash.write(writer)?; self.destination_script.write(writer)?; if let Some((ref to_remote_script, ref local_key)) = self.to_remote_rescue { @@ -966,6 +1174,15 @@ impl ChannelMonitor { } } + (self.outputs_to_watch.len() as u64).write(writer)?; + for (txid, output_scripts) in self.outputs_to_watch.iter() { + txid.write(writer)?; + (output_scripts.len() as u64).write(writer)?; + for script in output_scripts.iter() { + script.write(writer)?; + } + } + Ok(()) } @@ -993,32 +1210,45 @@ impl ChannelMonitor { } impl ChannelMonitor { - pub(super) fn new(keys: ChanSigner, funding_key: &SecretKey, revocation_base_key: &SecretKey, delayed_payment_base_key: &SecretKey, htlc_base_key: &SecretKey, payment_base_key: &SecretKey, shutdown_pubkey: &PublicKey, our_to_self_delay: u16, destination_script: Script, logger: Arc) -> ChannelMonitor { + pub(super) fn new(keys: ChanSigner, shutdown_pubkey: &PublicKey, + our_to_self_delay: u16, destination_script: &Script, funding_info: (OutPoint, Script), + their_htlc_base_key: &PublicKey, their_delayed_payment_base_key: &PublicKey, + their_to_self_delay: u16, funding_redeemscript: Script, channel_value_satoshis: u64, + commitment_transaction_number_obscure_factor: u64, + logger: Arc) -> ChannelMonitor { + + assert!(commitment_transaction_number_obscure_factor <= (1 << 48)); + let funding_key = keys.funding_key().clone(); + let revocation_base_key = keys.revocation_base_key().clone(); + let htlc_base_key = keys.htlc_base_key().clone(); + let delayed_payment_base_key = keys.delayed_payment_base_key().clone(); + let payment_base_key = keys.payment_base_key().clone(); ChannelMonitor { - commitment_transaction_number_obscure_factor: 0, + latest_update_id: 0, + commitment_transaction_number_obscure_factor, key_storage: Storage::Local { keys, - funding_key: funding_key.clone(), - revocation_base_key: revocation_base_key.clone(), - htlc_base_key: htlc_base_key.clone(), - delayed_payment_base_key: delayed_payment_base_key.clone(), - payment_base_key: payment_base_key.clone(), + funding_key, + revocation_base_key, + htlc_base_key, + delayed_payment_base_key, + payment_base_key, shutdown_pubkey: shutdown_pubkey.clone(), - funding_info: None, + funding_info: Some(funding_info), current_remote_commitment_txid: None, prev_remote_commitment_txid: None, }, - their_htlc_base_key: None, - their_delayed_payment_base_key: None, - funding_redeemscript: None, - channel_value_satoshis: 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), + channel_value_satoshis: Some(channel_value_satoshis), their_cur_revocation_points: None, our_to_self_delay: our_to_self_delay, - their_to_self_delay: None, + their_to_self_delay: Some(their_to_self_delay), - old_secrets: [([0; 32], 1 << 48); 49], + commitment_secrets: CounterpartyCommitmentSecrets::new(), remote_claimable_outpoints: HashMap::new(), remote_commitment_txn_on_chain: HashMap::new(), remote_hash_commitment_number: HashMap::new(), @@ -1028,7 +1258,9 @@ impl ChannelMonitor { current_remote_commitment_number: 1 << 48, payment_preimages: HashMap::new(), - destination_script: destination_script, + pending_htlcs_updated: Vec::new(), + + destination_script: destination_script.clone(), to_remote_rescue: None, pending_claim_requests: HashMap::new(), @@ -1036,6 +1268,7 @@ impl ChannelMonitor { claimable_outpoints: HashMap::new(), onchain_events_waiting_threshold_conf: HashMap::new(), + outputs_to_watch: HashMap::new(), last_block_hash: Default::default(), secp_ctx: Secp256k1::new(), @@ -1082,48 +1315,16 @@ impl ChannelMonitor { current_height + 15 } - #[inline] - fn place_secret(idx: u64) -> u8 { - for i in 0..48 { - if idx & (1 << i) == (1 << i) { - return i - } - } - 48 - } - - #[inline] - fn derive_secret(secret: [u8; 32], bits: u8, idx: u64) -> [u8; 32] { - let mut res: [u8; 32] = secret; - for i in 0..bits { - let bitpos = bits - 1 - i; - if idx & (1 << bitpos) == (1 << bitpos) { - res[(bitpos / 8) as usize] ^= 1 << (bitpos & 7); - res = Sha256::hash(&res).into_inner(); - } - } - res - } - /// Inserts a revocation secret into this channel monitor. Prunes old preimages if neither /// needed by local commitment transactions HTCLs nor by remote ones. Unless we haven't already seen remote /// commitment transaction's secret, they are de facto pruned (we can use revocation key). pub(super) fn provide_secret(&mut self, idx: u64, secret: [u8; 32]) -> Result<(), MonitorUpdateError> { - let pos = ChannelMonitor::::place_secret(idx); - for i in 0..pos { - let (old_secret, old_idx) = self.old_secrets[i as usize]; - if ChannelMonitor::::derive_secret(secret, pos, old_idx) != old_secret { - return Err(MonitorUpdateError("Previous secret did not match new one")); - } + if let Err(()) = self.commitment_secrets.provide_secret(idx, secret) { + return Err(MonitorUpdateError("Previous secret did not match new one")); } - if self.get_min_seen_secret() <= idx { - return Ok(()); - } - self.old_secrets[pos as usize] = (secret, idx); // Prune HTLCs from the previous remote commitment tx so we don't generate failure/fulfill // events for now-revoked/fulfilled HTLCs. - // TODO: We should probably consider whether we're really getting the next secret here. if let Storage::Local { ref mut prev_remote_commitment_txid, .. } = self.key_storage { if let Some(txid) = prev_remote_commitment_txid.take() { for &mut (_, ref mut source) in self.remote_claimable_outpoints.get_mut(&txid).unwrap() { @@ -1231,8 +1432,10 @@ impl ChannelMonitor { /// is important that any clones of this channel monitor (including remote clones) by kept /// up-to-date as our local commitment transaction is updated. /// Panics if set_their_to_self_delay has never been called. - pub(super) fn provide_latest_local_commitment_tx_info(&mut self, commitment_tx: LocalCommitmentTransaction, local_keys: chan_utils::TxCreationKeys, feerate_per_kw: u64, htlc_outputs: Vec<(HTLCOutputInCommitment, Option, Option)>) { - assert!(self.their_to_self_delay.is_some()); + pub(super) fn provide_latest_local_commitment_tx_info(&mut self, commitment_tx: LocalCommitmentTransaction, local_keys: chan_utils::TxCreationKeys, feerate_per_kw: u64, htlc_outputs: Vec<(HTLCOutputInCommitment, Option, Option)>) -> Result<(), MonitorUpdateError> { + if self.their_to_self_delay.is_none() { + return Err(MonitorUpdateError("Got a local commitment tx info update before we'd set basic information about the channel")); + } self.prev_local_signed_commitment_tx = self.current_local_signed_commitment_tx.take(); self.current_local_signed_commitment_tx = Some(LocalSignedTx { txid: commitment_tx.txid(), @@ -1245,6 +1448,7 @@ impl ChannelMonitor { feerate_per_kw, htlc_outputs, }); + Ok(()) } /// Provides a payment_hash->payment_preimage mapping. Will be automatically pruned when all @@ -1253,106 +1457,56 @@ impl ChannelMonitor { self.payment_preimages.insert(payment_hash.clone(), payment_preimage.clone()); } - /// Combines this ChannelMonitor with the information contained in the other ChannelMonitor. - /// After a successful call this ChannelMonitor is up-to-date and is safe to use to monitor the - /// chain for new blocks/transactions. - pub fn insert_combine(&mut self, mut other: ChannelMonitor) -> Result<(), MonitorUpdateError> { - match self.key_storage { - Storage::Local { ref funding_info, .. } => { - if funding_info.is_none() { return Err(MonitorUpdateError("Try to combine a Local monitor without funding_info")); } - let our_funding_info = funding_info; - if let Storage::Local { ref funding_info, .. } = other.key_storage { - if funding_info.is_none() { return Err(MonitorUpdateError("Try to combine a Local monitor without funding_info")); } - // We should be able to compare the entire funding_txo, but in fuzztarget it's trivially - // easy to collide the funding_txo hash and have a different scriptPubKey. - if funding_info.as_ref().unwrap().0 != our_funding_info.as_ref().unwrap().0 { - return Err(MonitorUpdateError("Funding transaction outputs are not identical!")); - } - } else { - return Err(MonitorUpdateError("Try to combine a Local monitor with a Watchtower one !")); - } - }, - Storage::Watchtower { .. } => { - if let Storage::Watchtower { .. } = other.key_storage { - unimplemented!(); - } else { - return Err(MonitorUpdateError("Try to combine a Watchtower monitor with a Local one !")); - } - }, - } - let other_min_secret = other.get_min_seen_secret(); - let our_min_secret = self.get_min_seen_secret(); - if our_min_secret > other_min_secret { - self.provide_secret(other_min_secret, other.get_secret(other_min_secret).unwrap())?; - } - if let Some(ref local_tx) = self.current_local_signed_commitment_tx { - if let Some(ref other_local_tx) = other.current_local_signed_commitment_tx { - let our_commitment_number = 0xffffffffffff - ((((local_tx.tx.without_valid_witness().input[0].sequence as u64 & 0xffffff) << 3*8) | (local_tx.tx.without_valid_witness().lock_time as u64 & 0xffffff)) ^ self.commitment_transaction_number_obscure_factor); - let other_commitment_number = 0xffffffffffff - ((((other_local_tx.tx.without_valid_witness().input[0].sequence as u64 & 0xffffff) << 3*8) | (other_local_tx.tx.without_valid_witness().lock_time as u64 & 0xffffff)) ^ other.commitment_transaction_number_obscure_factor); - if our_commitment_number >= other_commitment_number { - self.key_storage = other.key_storage; - } - } - } - // TODO: We should use current_remote_commitment_number and the commitment number out of - // local transactions to decide how to merge - if our_min_secret >= other_min_secret { - self.their_cur_revocation_points = other.their_cur_revocation_points; - for (txid, htlcs) in other.remote_claimable_outpoints.drain() { - self.remote_claimable_outpoints.insert(txid, htlcs); - } - if let Some(local_tx) = other.prev_local_signed_commitment_tx { - self.prev_local_signed_commitment_tx = Some(local_tx); - } - if let Some(local_tx) = other.current_local_signed_commitment_tx { - self.current_local_signed_commitment_tx = Some(local_tx); - } - self.payment_preimages = other.payment_preimages; - self.to_remote_rescue = other.to_remote_rescue; - } - - self.current_remote_commitment_number = cmp::min(self.current_remote_commitment_number, other.current_remote_commitment_number); + /// Used in Channel to cheat wrt the update_ids since it plays games, will be removed soon! + pub(super) fn update_monitor_ooo(&mut self, mut updates: ChannelMonitorUpdate) -> Result<(), MonitorUpdateError> { + for update in updates.updates.drain(..) { + match update { + ChannelMonitorUpdateStep::LatestLocalCommitmentTXInfo { commitment_tx, local_keys, feerate_per_kw, htlc_outputs } => + self.provide_latest_local_commitment_tx_info(commitment_tx, local_keys, feerate_per_kw, htlc_outputs)?, + ChannelMonitorUpdateStep::LatestRemoteCommitmentTXInfo { unsigned_commitment_tx, htlc_outputs, commitment_number, their_revocation_point } => + self.provide_latest_remote_commitment_tx_info(&unsigned_commitment_tx, htlc_outputs, commitment_number, their_revocation_point), + ChannelMonitorUpdateStep::PaymentPreimage { payment_preimage } => + self.provide_payment_preimage(&PaymentHash(Sha256::hash(&payment_preimage.0[..]).into_inner()), &payment_preimage), + ChannelMonitorUpdateStep::CommitmentSecret { idx, secret } => + self.provide_secret(idx, secret)?, + ChannelMonitorUpdateStep::RescueRemoteCommitmentTXInfo { their_current_per_commitment_point } => + self.provide_rescue_remote_commitment_tx_info(their_current_per_commitment_point), + } + } + self.latest_update_id = updates.update_id; Ok(()) } - /// Allows this monitor to scan only for transactions which are applicable. Note that this is - /// optional, without it this monitor cannot be used in an SPV client, but you may wish to - /// avoid this (or call unset_funding_info) on a monitor you wish to send to a watchtower as it - /// provides slightly better privacy. - /// It's the responsibility of the caller to register outpoint and script with passing the former - /// value as key to add_update_monitor. - pub(super) fn set_funding_info(&mut self, new_funding_info: (OutPoint, Script)) { - match self.key_storage { - Storage::Local { ref mut funding_info, .. } => { - *funding_info = Some(new_funding_info); - }, - Storage::Watchtower { .. } => { - panic!("Channel somehow ended up with its internal ChannelMonitor being in Watchtower mode?"); - } - } - } - - /// We log these base keys at channel opening to being able to rebuild redeemscript in case of leaked revoked commit tx - /// Panics if commitment_transaction_number_obscure_factor doesn't fit in 48 bits - pub(super) fn set_basic_channel_info(&mut self, their_htlc_base_key: &PublicKey, their_delayed_payment_base_key: &PublicKey, their_to_self_delay: u16, funding_redeemscript: Script, channel_value_satoshis: u64, commitment_transaction_number_obscure_factor: u64) { - self.their_htlc_base_key = Some(their_htlc_base_key.clone()); - self.their_delayed_payment_base_key = Some(their_delayed_payment_base_key.clone()); - self.their_to_self_delay = Some(their_to_self_delay); - self.funding_redeemscript = Some(funding_redeemscript); - self.channel_value_satoshis = Some(channel_value_satoshis); - assert!(commitment_transaction_number_obscure_factor < (1 << 48)); - self.commitment_transaction_number_obscure_factor = commitment_transaction_number_obscure_factor; + /// Updates a ChannelMonitor on the basis of some new information provided by the Channel + /// itself. + /// + /// panics if the given update is not the next update by update_id. + pub fn update_monitor(&mut self, mut updates: ChannelMonitorUpdate) -> Result<(), MonitorUpdateError> { + if self.latest_update_id + 1 != updates.update_id { + panic!("Attempted to apply ChannelMonitorUpdates out of order, check the update_id before passing an update to update_monitor!"); + } + for update in updates.updates.drain(..) { + match update { + ChannelMonitorUpdateStep::LatestLocalCommitmentTXInfo { commitment_tx, local_keys, feerate_per_kw, htlc_outputs } => + self.provide_latest_local_commitment_tx_info(commitment_tx, local_keys, feerate_per_kw, htlc_outputs)?, + ChannelMonitorUpdateStep::LatestRemoteCommitmentTXInfo { unsigned_commitment_tx, htlc_outputs, commitment_number, their_revocation_point } => + self.provide_latest_remote_commitment_tx_info(&unsigned_commitment_tx, htlc_outputs, commitment_number, their_revocation_point), + ChannelMonitorUpdateStep::PaymentPreimage { payment_preimage } => + self.provide_payment_preimage(&PaymentHash(Sha256::hash(&payment_preimage.0[..]).into_inner()), &payment_preimage), + ChannelMonitorUpdateStep::CommitmentSecret { idx, secret } => + self.provide_secret(idx, secret)?, + ChannelMonitorUpdateStep::RescueRemoteCommitmentTXInfo { their_current_per_commitment_point } => + self.provide_rescue_remote_commitment_tx_info(their_current_per_commitment_point), + } + } + self.latest_update_id = updates.update_id; + Ok(()) } - pub(super) fn unset_funding_info(&mut self) { - match self.key_storage { - Storage::Local { ref mut funding_info, .. } => { - *funding_info = None; - }, - Storage::Watchtower { .. } => { - panic!("Channel somehow ended up with its internal ChannelMonitor being in Watchtower mode?"); - }, - } + /// Gets the update_id from the latest ChannelMonitorUpdate which was applied to this + /// ChannelMonitor. + pub fn get_latest_update_id(&self) -> u64 { + self.latest_update_id } /// Gets the funding transaction outpoint of the channel this ChannelMonitor is monitoring for. @@ -1370,6 +1524,12 @@ impl ChannelMonitor { } } + /// Gets a list of txids, with their output scripts (in the order they appear in the + /// transaction), which we must learn about spends of via block_connected(). + pub fn get_outputs_to_watch(&self) -> &HashMap> { + &self.outputs_to_watch + } + /// Gets the sets of all outpoints which this ChannelMonitor expects to hear about spends of. /// Generally useful when deserializing as during normal operation the return values of /// block_connected are sufficient to ensure all relevant outpoints are being monitored (note @@ -1384,26 +1544,21 @@ impl ChannelMonitor { res } + /// Get the list of HTLCs who's status has been updated on chain. This should be called by + /// ChannelManager via ManyChannelMonitor::get_and_clear_pending_htlcs_updated(). + pub fn get_and_clear_pending_htlcs_updated(&mut self) -> Vec { + let mut ret = Vec::new(); + mem::swap(&mut ret, &mut self.pending_htlcs_updated); + ret + } + /// Can only fail if idx is < get_min_seen_secret pub(super) fn get_secret(&self, idx: u64) -> Option<[u8; 32]> { - for i in 0..self.old_secrets.len() { - if (idx & (!((1 << i) - 1))) == self.old_secrets[i].1 { - return Some(ChannelMonitor::::derive_secret(self.old_secrets[i].0, i as u8, idx)) - } - } - assert!(idx < self.get_min_seen_secret()); - None + self.commitment_secrets.get_secret(idx) } pub(super) fn get_min_seen_secret(&self) -> u64 { - //TODO This can be optimized? - let mut min = 1 << 48; - for &(_, idx) in self.old_secrets.iter() { - if idx < min { - min = idx; - } - } - min + self.commitment_secrets.get_min_seen_secret() } pub(super) fn get_cur_remote_commitment_number(&self) -> u64 { @@ -2362,7 +2517,14 @@ impl ChannelMonitor { } } - fn block_connected(&mut self, txn_matched: &[&Transaction], height: u32, block_hash: &Sha256dHash, broadcaster: &BroadcasterInterface, fee_estimator: &FeeEstimator)-> (Vec<(Sha256dHash, Vec)>, Vec, Vec<(HTLCSource, Option, PaymentHash)>) { + /// Called by SimpleManyChannelMonitor::block_connected, which implements + /// ChainListener::block_connected. + /// Eventually this should be pub and, roughly, implement ChainListener, however this requires + /// &mut self, as well as returns new spendable outputs and outpoints to watch for spending of + /// on-chain. + fn block_connected(&mut self, txn_matched: &[&Transaction], height: u32, block_hash: &Sha256dHash, broadcaster: B, fee_estimator: &FeeEstimator)-> (Vec<(Sha256dHash, Vec)>, Vec) + where B::Target: BroadcasterInterface + { for tx in txn_matched { let mut output_val = 0; for out in tx.output.iter() { @@ -2375,7 +2537,6 @@ impl ChannelMonitor { log_trace!(self, "Block {} at height {} connected with {} txn matched", block_hash, height, txn_matched.len()); let mut watch_outputs = Vec::new(); let mut spendable_outputs = Vec::new(); - let mut htlc_updated = Vec::new(); let mut bump_candidates = HashSet::new(); for tx in txn_matched { if tx.input.len() == 1 { @@ -2434,10 +2595,7 @@ impl ChannelMonitor { // While all commitment/HTLC-Success/HTLC-Timeout transactions have one input, HTLCs // can also be resolved in a few other ways which can have more than one output. Thus, // we call is_resolving_htlc_output here outside of the tx.input.len() == 1 check. - let mut updated = self.is_resolving_htlc_output(&tx, height); - if updated.len() > 0 { - htlc_updated.append(&mut updated); - } + self.is_resolving_htlc_output(&tx, height); // Scan all input to verify is one of the outpoint spent is of interest for us let mut claimed_outputs_material = Vec::new(); @@ -2560,7 +2718,11 @@ impl ChannelMonitor { }, OnchainEvent::HTLCUpdate { htlc_update } => { log_trace!(self, "HTLC {} failure update has got enough confirmations to be passed upstream", log_bytes!((htlc_update.1).0)); - htlc_updated.push((htlc_update.0, None, htlc_update.1)); + self.pending_htlcs_updated.push(HTLCUpdate { + payment_hash: htlc_update.1, + payment_preimage: None, + source: htlc_update.0, + }); }, OnchainEvent::ContentiousOutpoint { outpoint, .. } => { self.claimable_outpoints.remove(&outpoint); @@ -2589,10 +2751,15 @@ impl ChannelMonitor { } } self.last_block_hash = block_hash.clone(); - (watch_outputs, spendable_outputs, htlc_updated) + for &(ref txid, ref output_scripts) in watch_outputs.iter() { + self.outputs_to_watch.insert(txid.clone(), output_scripts.iter().map(|o| o.script_pubkey.clone()).collect()); + } + (watch_outputs, spendable_outputs) } - fn block_disconnected(&mut self, height: u32, block_hash: &Sha256dHash, broadcaster: &BroadcasterInterface, fee_estimator: &FeeEstimator) { + fn block_disconnected(&mut self, height: u32, block_hash: &Sha256dHash, broadcaster: B, fee_estimator: &FeeEstimator) + where B::Target: BroadcasterInterface + { log_trace!(self, "Block {} at height {} disconnected", block_hash, height); let mut bump_candidates = HashMap::new(); if let Some(events) = self.onchain_events_waiting_threshold_conf.remove(&(height + ANTI_REORG_DELAY - 1)) { @@ -2709,9 +2876,7 @@ impl ChannelMonitor { /// Check if any transaction broadcasted is resolving HTLC output by a success or timeout on a local /// or remote commitment tx, if so send back the source, preimage if found and payment_hash of resolved HTLC - fn is_resolving_htlc_output(&mut self, tx: &Transaction, height: u32) -> Vec<(HTLCSource, Option, PaymentHash)> { - let mut htlc_updated = Vec::new(); - + fn is_resolving_htlc_output(&mut self, tx: &Transaction, height: u32) { 'outer_loop: for input in &tx.input { let mut payment_data = None; let revocation_sig_claim = (input.witness.len() == 3 && HTLCType::scriptlen_to_htlctype(input.witness[2].len()) == Some(HTLCType::OfferedHTLC) && input.witness[1].len() == 33) @@ -2811,10 +2976,18 @@ impl ChannelMonitor { let mut payment_preimage = PaymentPreimage([0; 32]); if accepted_preimage_claim { payment_preimage.0.copy_from_slice(&input.witness[3]); - htlc_updated.push((source, Some(payment_preimage), payment_hash)); + self.pending_htlcs_updated.push(HTLCUpdate { + source, + payment_preimage: Some(payment_preimage), + payment_hash + }); } else if offered_preimage_claim { payment_preimage.0.copy_from_slice(&input.witness[1]); - htlc_updated.push((source, Some(payment_preimage), payment_hash)); + self.pending_htlcs_updated.push(HTLCUpdate { + source, + payment_preimage: Some(payment_preimage), + payment_hash + }); } else { log_info!(self, "Failing HTLC with payment_hash {} timeout by a spend tx, waiting for confirmation (at height{})", log_bytes!(payment_hash.0), height + ANTI_REORG_DELAY - 1); match self.onchain_events_waiting_threshold_conf.entry(height + ANTI_REORG_DELAY - 1) { @@ -2837,7 +3010,6 @@ impl ChannelMonitor { } } } - htlc_updated } /// Lightning security model (i.e being able to redeem/timeout HTLC or penalize coutnerparty onchain) lays on the assumption of claim transactions getting confirmed before timelock expiration @@ -2998,6 +3170,7 @@ impl> ReadableArgs>::read(reader)?.0; let key_storage = match >::read(reader)? { @@ -3057,11 +3230,7 @@ impl> ReadableArgs = Some(Readable::read(reader)?); - let mut old_secrets = [([0; 32], 1 << 48); 49]; - for &mut (ref mut secret, ref mut idx) in old_secrets.iter_mut() { - *secret = Readable::read(reader)?; - *idx = Readable::read(reader)?; - } + let commitment_secrets = Readable::read(reader)?; macro_rules! read_htlc_in_commitment { () => { @@ -3178,6 +3347,12 @@ impl> ReadableArgs>::read(reader)? { @@ -3241,7 +3416,22 @@ impl> ReadableArgs() + mem::size_of::>()))); + for _ in 0..outputs_to_watch_len { + let txid = Readable::read(reader)?; + let outputs_len: u64 = Readable::read(reader)?; + let mut outputs = Vec::with_capacity(cmp::min(outputs_len as usize, MAX_ALLOC_SIZE / mem::size_of::