Introduce ChannelMonitor::is_paying_spendable_output
[rust-lightning] / lightning / src / ln / channelmonitor.rs
1 //! The logic to monitor for on-chain transactions and create the relevant claim responses lives
2 //! here.
3 //!
4 //! ChannelMonitor objects are generated by ChannelManager in response to relevant
5 //! messages/actions, and MUST be persisted to disk (and, preferably, remotely) before progress can
6 //! be made in responding to certain messages, see ManyChannelMonitor for more.
7 //!
8 //! Note that ChannelMonitors are an important part of the lightning trust model and a copy of the
9 //! latest ChannelMonitor must always be actively monitoring for chain updates (and no out-of-date
10 //! ChannelMonitors should do so). Thus, if you're building rust-lightning into an HSM or other
11 //! security-domain-separated system design, you should consider having multiple paths for
12 //! ChannelMonitors to get out of the HSM and onto monitoring devices.
13
14 use bitcoin::blockdata::block::BlockHeader;
15 use bitcoin::blockdata::transaction::{TxOut,Transaction};
16 use bitcoin::blockdata::transaction::OutPoint as BitcoinOutPoint;
17 use bitcoin::blockdata::script::{Script, Builder};
18 use bitcoin::blockdata::opcodes;
19 use bitcoin::consensus::encode;
20 use bitcoin::util::hash::BitcoinHash;
21
22 use bitcoin_hashes::Hash;
23 use bitcoin_hashes::sha256::Hash as Sha256;
24 use bitcoin_hashes::hash160::Hash as Hash160;
25 use bitcoin_hashes::sha256d::Hash as Sha256dHash;
26
27 use secp256k1::{Secp256k1,Signature};
28 use secp256k1::key::{SecretKey,PublicKey};
29 use secp256k1;
30
31 use ln::msgs::DecodeError;
32 use ln::chan_utils;
33 use ln::chan_utils::{CounterpartyCommitmentSecrets, HTLCOutputInCommitment, LocalCommitmentTransaction, HTLCType};
34 use ln::channelmanager::{HTLCSource, PaymentPreimage, PaymentHash};
35 use ln::onchaintx::OnchainTxHandler;
36 use chain::chaininterface::{ChainListener, ChainWatchInterface, BroadcasterInterface, FeeEstimator};
37 use chain::transaction::OutPoint;
38 use chain::keysinterface::{SpendableOutputDescriptor, ChannelKeys};
39 use util::logger::Logger;
40 use util::ser::{ReadableArgs, Readable, MaybeReadable, Writer, Writeable, U48};
41 use util::{byte_utils, events};
42
43 use std::collections::{HashMap, hash_map};
44 use std::sync::{Arc,Mutex};
45 use std::{hash,cmp, mem};
46 use std::ops::Deref;
47
48 /// An update generated by the underlying Channel itself which contains some new information the
49 /// ChannelMonitor should be made aware of.
50 #[cfg_attr(test, derive(PartialEq))]
51 #[derive(Clone)]
52 #[must_use]
53 pub struct ChannelMonitorUpdate {
54         pub(super) updates: Vec<ChannelMonitorUpdateStep>,
55         /// The sequence number of this update. Updates *must* be replayed in-order according to this
56         /// sequence number (and updates may panic if they are not). The update_id values are strictly
57         /// increasing and increase by one for each new update.
58         ///
59         /// This sequence number is also used to track up to which points updates which returned
60         /// ChannelMonitorUpdateErr::TemporaryFailure have been applied to all copies of a given
61         /// ChannelMonitor when ChannelManager::channel_monitor_updated is called.
62         pub update_id: u64,
63 }
64
65 impl Writeable for ChannelMonitorUpdate {
66         fn write<W: Writer>(&self, w: &mut W) -> Result<(), ::std::io::Error> {
67                 self.update_id.write(w)?;
68                 (self.updates.len() as u64).write(w)?;
69                 for update_step in self.updates.iter() {
70                         update_step.write(w)?;
71                 }
72                 Ok(())
73         }
74 }
75 impl Readable for ChannelMonitorUpdate {
76         fn read<R: ::std::io::Read>(r: &mut R) -> Result<Self, DecodeError> {
77                 let update_id: u64 = Readable::read(r)?;
78                 let len: u64 = Readable::read(r)?;
79                 let mut updates = Vec::with_capacity(cmp::min(len as usize, MAX_ALLOC_SIZE / ::std::mem::size_of::<ChannelMonitorUpdateStep>()));
80                 for _ in 0..len {
81                         updates.push(Readable::read(r)?);
82                 }
83                 Ok(Self { update_id, updates })
84         }
85 }
86
87 /// An error enum representing a failure to persist a channel monitor update.
88 #[derive(Clone)]
89 pub enum ChannelMonitorUpdateErr {
90         /// Used to indicate a temporary failure (eg connection to a watchtower or remote backup of
91         /// our state failed, but is expected to succeed at some point in the future).
92         ///
93         /// Such a failure will "freeze" a channel, preventing us from revoking old states or
94         /// submitting new commitment transactions to the remote party. Once the update(s) which failed
95         /// have been successfully applied, ChannelManager::channel_monitor_updated can be used to
96         /// restore the channel to an operational state.
97         ///
98         /// Note that a given ChannelManager will *never* re-generate a given ChannelMonitorUpdate. If
99         /// you return a TemporaryFailure you must ensure that it is written to disk safely before
100         /// writing out the latest ChannelManager state.
101         ///
102         /// Even when a channel has been "frozen" updates to the ChannelMonitor can continue to occur
103         /// (eg if an inbound HTLC which we forwarded was claimed upstream resulting in us attempting
104         /// to claim it on this channel) and those updates must be applied wherever they can be. At
105         /// least one such updated ChannelMonitor must be persisted otherwise PermanentFailure should
106         /// be returned to get things on-chain ASAP using only the in-memory copy. Obviously updates to
107         /// the channel which would invalidate previous ChannelMonitors are not made when a channel has
108         /// been "frozen".
109         ///
110         /// Note that even if updates made after TemporaryFailure succeed you must still call
111         /// channel_monitor_updated to ensure you have the latest monitor and re-enable normal channel
112         /// operation.
113         ///
114         /// Note that the update being processed here will not be replayed for you when you call
115         /// ChannelManager::channel_monitor_updated, so you must store the update itself along
116         /// with the persisted ChannelMonitor on your own local disk prior to returning a
117         /// TemporaryFailure. You may, of course, employ a journaling approach, storing only the
118         /// ChannelMonitorUpdate on disk without updating the monitor itself, replaying the journal at
119         /// reload-time.
120         ///
121         /// For deployments where a copy of ChannelMonitors and other local state are backed up in a
122         /// remote location (with local copies persisted immediately), it is anticipated that all
123         /// updates will return TemporaryFailure until the remote copies could be updated.
124         TemporaryFailure,
125         /// Used to indicate no further channel monitor updates will be allowed (eg we've moved on to a
126         /// different watchtower and cannot update with all watchtowers that were previously informed
127         /// of this channel). This will force-close the channel in question (which will generate one
128         /// final ChannelMonitorUpdate which must be delivered to at least one ChannelMonitor copy).
129         ///
130         /// Should also be used to indicate a failure to update the local persisted copy of the channel
131         /// monitor.
132         PermanentFailure,
133 }
134
135 /// General Err type for ChannelMonitor actions. Generally, this implies that the data provided is
136 /// inconsistent with the ChannelMonitor being called. eg for ChannelMonitor::update_monitor this
137 /// means you tried to update a monitor for a different channel or the ChannelMonitorUpdate was
138 /// corrupted.
139 /// Contains a human-readable error message.
140 #[derive(Debug)]
141 pub struct MonitorUpdateError(pub &'static str);
142
143 /// Simple structure send back by ManyChannelMonitor in case of HTLC detected onchain from a
144 /// forward channel and from which info are needed to update HTLC in a backward channel.
145 #[derive(Clone, PartialEq)]
146 pub struct HTLCUpdate {
147         pub(super) payment_hash: PaymentHash,
148         pub(super) payment_preimage: Option<PaymentPreimage>,
149         pub(super) source: HTLCSource
150 }
151 impl_writeable!(HTLCUpdate, 0, { payment_hash, payment_preimage, source });
152
153 /// Simple trait indicating ability to track a set of ChannelMonitors and multiplex events between
154 /// them. Generally should be implemented by keeping a local SimpleManyChannelMonitor and passing
155 /// events to it, while also taking any add/update_monitor events and passing them to some remote
156 /// server(s).
157 ///
158 /// In general, you must always have at least one local copy in memory, which must never fail to
159 /// update (as it is responsible for broadcasting the latest state in case the channel is closed),
160 /// and then persist it to various on-disk locations. If, for some reason, the in-memory copy fails
161 /// to update (eg out-of-memory or some other condition), you must immediately shut down without
162 /// taking any further action such as writing the current state to disk. This should likely be
163 /// accomplished via panic!() or abort().
164 ///
165 /// Note that any updates to a channel's monitor *must* be applied to each instance of the
166 /// channel's monitor everywhere (including remote watchtowers) *before* this function returns. If
167 /// an update occurs and a remote watchtower is left with old state, it may broadcast transactions
168 /// which we have revoked, allowing our counterparty to claim all funds in the channel!
169 ///
170 /// User needs to notify implementors of ManyChannelMonitor when a new block is connected or
171 /// disconnected using their `block_connected` and `block_disconnected` methods. However, rather
172 /// than calling these methods directly, the user should register implementors as listeners to the
173 /// BlockNotifier and call the BlockNotifier's `block_(dis)connected` methods, which will notify
174 /// all registered listeners in one go.
175 pub trait ManyChannelMonitor<ChanSigner: ChannelKeys>: Send + Sync {
176         /// Adds a monitor for the given `funding_txo`.
177         ///
178         /// Implementer must also ensure that the funding_txo txid *and* outpoint are registered with
179         /// any relevant ChainWatchInterfaces such that the provided monitor receives block_connected
180         /// callbacks with the funding transaction, or any spends of it.
181         ///
182         /// Further, the implementer must also ensure that each output returned in
183         /// monitor.get_outputs_to_watch() is registered to ensure that the provided monitor learns about
184         /// any spends of any of the outputs.
185         ///
186         /// Any spends of outputs which should have been registered which aren't passed to
187         /// ChannelMonitors via block_connected may result in FUNDS LOSS.
188         fn add_monitor(&self, funding_txo: OutPoint, monitor: ChannelMonitor<ChanSigner>) -> Result<(), ChannelMonitorUpdateErr>;
189
190         /// Updates a monitor for the given `funding_txo`.
191         ///
192         /// Implementer must also ensure that the funding_txo txid *and* outpoint are registered with
193         /// any relevant ChainWatchInterfaces such that the provided monitor receives block_connected
194         /// callbacks with the funding transaction, or any spends of it.
195         ///
196         /// Further, the implementer must also ensure that each output returned in
197         /// monitor.get_watch_outputs() is registered to ensure that the provided monitor learns about
198         /// any spends of any of the outputs.
199         ///
200         /// Any spends of outputs which should have been registered which aren't passed to
201         /// ChannelMonitors via block_connected may result in FUNDS LOSS.
202         fn update_monitor(&self, funding_txo: OutPoint, monitor: ChannelMonitorUpdate) -> Result<(), ChannelMonitorUpdateErr>;
203
204         /// Used by ChannelManager to get list of HTLC resolved onchain and which needed to be updated
205         /// with success or failure.
206         ///
207         /// You should probably just call through to
208         /// ChannelMonitor::get_and_clear_pending_htlcs_updated() for each ChannelMonitor and return
209         /// the full list.
210         fn get_and_clear_pending_htlcs_updated(&self) -> Vec<HTLCUpdate>;
211 }
212
213 /// A simple implementation of a ManyChannelMonitor and ChainListener. Can be used to create a
214 /// watchtower or watch our own channels.
215 ///
216 /// Note that you must provide your own key by which to refer to channels.
217 ///
218 /// If you're accepting remote monitors (ie are implementing a watchtower), you must verify that
219 /// users cannot overwrite a given channel by providing a duplicate key. ie you should probably
220 /// index by a PublicKey which is required to sign any updates.
221 ///
222 /// If you're using this for local monitoring of your own channels, you probably want to use
223 /// `OutPoint` as the key, which will give you a ManyChannelMonitor implementation.
224 pub struct SimpleManyChannelMonitor<Key, ChanSigner: ChannelKeys, T: Deref, F: Deref>
225         where T::Target: BroadcasterInterface,
226         F::Target: FeeEstimator
227 {
228         #[cfg(test)] // Used in ChannelManager tests to manipulate channels directly
229         pub monitors: Mutex<HashMap<Key, ChannelMonitor<ChanSigner>>>,
230         #[cfg(not(test))]
231         monitors: Mutex<HashMap<Key, ChannelMonitor<ChanSigner>>>,
232         chain_monitor: Arc<ChainWatchInterface>,
233         broadcaster: T,
234         logger: Arc<Logger>,
235         fee_estimator: F
236 }
237
238 impl<'a, Key : Send + cmp::Eq + hash::Hash, ChanSigner: ChannelKeys, T: Deref + Sync + Send, F: Deref + Sync + Send>
239         ChainListener for SimpleManyChannelMonitor<Key, ChanSigner, T, F>
240         where T::Target: BroadcasterInterface,
241               F::Target: FeeEstimator
242 {
243         fn block_connected(&self, header: &BlockHeader, height: u32, txn_matched: &[&Transaction], _indexes_of_txn_matched: &[u32]) {
244                 let block_hash = header.bitcoin_hash();
245                 {
246                         let mut monitors = self.monitors.lock().unwrap();
247                         for monitor in monitors.values_mut() {
248                                 let txn_outputs = monitor.block_connected(txn_matched, height, &block_hash, &*self.broadcaster, &*self.fee_estimator);
249
250                                 for (ref txid, ref outputs) in txn_outputs {
251                                         for (idx, output) in outputs.iter().enumerate() {
252                                                 self.chain_monitor.install_watch_outpoint((txid.clone(), idx as u32), &output.script_pubkey);
253                                         }
254                                 }
255                         }
256                 }
257         }
258
259         fn block_disconnected(&self, header: &BlockHeader, disconnected_height: u32) {
260                 let block_hash = header.bitcoin_hash();
261                 let mut monitors = self.monitors.lock().unwrap();
262                 for monitor in monitors.values_mut() {
263                         monitor.block_disconnected(disconnected_height, &block_hash, &*self.broadcaster, &*self.fee_estimator);
264                 }
265         }
266 }
267
268 impl<Key : Send + cmp::Eq + hash::Hash + 'static, ChanSigner: ChannelKeys, T: Deref, F: Deref> SimpleManyChannelMonitor<Key, ChanSigner, T, F>
269         where T::Target: BroadcasterInterface,
270               F::Target: FeeEstimator
271 {
272         /// Creates a new object which can be used to monitor several channels given the chain
273         /// interface with which to register to receive notifications.
274         pub fn new(chain_monitor: Arc<ChainWatchInterface>, broadcaster: T, logger: Arc<Logger>, feeest: F) -> SimpleManyChannelMonitor<Key, ChanSigner, T, F> {
275                 let res = SimpleManyChannelMonitor {
276                         monitors: Mutex::new(HashMap::new()),
277                         chain_monitor,
278                         broadcaster,
279                         logger,
280                         fee_estimator: feeest,
281                 };
282
283                 res
284         }
285
286         /// Adds or updates the monitor which monitors the channel referred to by the given key.
287         pub fn add_monitor_by_key(&self, key: Key, monitor: ChannelMonitor<ChanSigner>) -> Result<(), MonitorUpdateError> {
288                 let mut monitors = self.monitors.lock().unwrap();
289                 let entry = match monitors.entry(key) {
290                         hash_map::Entry::Occupied(_) => return Err(MonitorUpdateError("Channel monitor for given key is already present")),
291                         hash_map::Entry::Vacant(e) => e,
292                 };
293                 match monitor.key_storage {
294                         Storage::Local { ref funding_info, .. } => {
295                                 match funding_info {
296                                         &None => {
297                                                 return Err(MonitorUpdateError("Try to update a useless monitor without funding_txo !"));
298                                         },
299                                         &Some((ref outpoint, ref script)) => {
300                                                 log_trace!(self, "Got new Channel Monitor for channel {}", log_bytes!(outpoint.to_channel_id()[..]));
301                                                 self.chain_monitor.install_watch_tx(&outpoint.txid, script);
302                                                 self.chain_monitor.install_watch_outpoint((outpoint.txid, outpoint.index as u32), script);
303                                         },
304                                 }
305                         },
306                         Storage::Watchtower { .. } => {
307                                 self.chain_monitor.watch_all_txn();
308                         }
309                 }
310                 for (txid, outputs) in monitor.get_outputs_to_watch().iter() {
311                         for (idx, script) in outputs.iter().enumerate() {
312                                 self.chain_monitor.install_watch_outpoint((*txid, idx as u32), script);
313                         }
314                 }
315                 entry.insert(monitor);
316                 Ok(())
317         }
318
319         /// Updates the monitor which monitors the channel referred to by the given key.
320         pub fn update_monitor_by_key(&self, key: Key, update: ChannelMonitorUpdate) -> Result<(), MonitorUpdateError> {
321                 let mut monitors = self.monitors.lock().unwrap();
322                 match monitors.get_mut(&key) {
323                         Some(orig_monitor) => {
324                                 log_trace!(self, "Updating Channel Monitor for channel {}", log_funding_info!(orig_monitor.key_storage));
325                                 orig_monitor.update_monitor(update, &self.broadcaster)
326                         },
327                         None => Err(MonitorUpdateError("No such monitor registered"))
328                 }
329         }
330 }
331
332 impl<ChanSigner: ChannelKeys, T: Deref + Sync + Send, F: Deref + Sync + Send> ManyChannelMonitor<ChanSigner> for SimpleManyChannelMonitor<OutPoint, ChanSigner, T, F>
333         where T::Target: BroadcasterInterface,
334               F::Target: FeeEstimator
335 {
336         fn add_monitor(&self, funding_txo: OutPoint, monitor: ChannelMonitor<ChanSigner>) -> Result<(), ChannelMonitorUpdateErr> {
337                 match self.add_monitor_by_key(funding_txo, monitor) {
338                         Ok(_) => Ok(()),
339                         Err(_) => Err(ChannelMonitorUpdateErr::PermanentFailure),
340                 }
341         }
342
343         fn update_monitor(&self, funding_txo: OutPoint, update: ChannelMonitorUpdate) -> Result<(), ChannelMonitorUpdateErr> {
344                 match self.update_monitor_by_key(funding_txo, update) {
345                         Ok(_) => Ok(()),
346                         Err(_) => Err(ChannelMonitorUpdateErr::PermanentFailure),
347                 }
348         }
349
350         fn get_and_clear_pending_htlcs_updated(&self) -> Vec<HTLCUpdate> {
351                 let mut pending_htlcs_updated = Vec::new();
352                 for chan in self.monitors.lock().unwrap().values_mut() {
353                         pending_htlcs_updated.append(&mut chan.get_and_clear_pending_htlcs_updated());
354                 }
355                 pending_htlcs_updated
356         }
357 }
358
359 impl<Key : Send + cmp::Eq + hash::Hash, ChanSigner: ChannelKeys, T: Deref, F: Deref> events::EventsProvider for SimpleManyChannelMonitor<Key, ChanSigner, T, F>
360         where T::Target: BroadcasterInterface,
361               F::Target: FeeEstimator
362 {
363         fn get_and_clear_pending_events(&self) -> Vec<events::Event> {
364                 let mut pending_events = Vec::new();
365                 for chan in self.monitors.lock().unwrap().values_mut() {
366                         pending_events.append(&mut chan.get_and_clear_pending_events());
367                 }
368                 pending_events
369         }
370 }
371
372 /// If an HTLC expires within this many blocks, don't try to claim it in a shared transaction,
373 /// instead claiming it in its own individual transaction.
374 pub(crate) const CLTV_SHARED_CLAIM_BUFFER: u32 = 12;
375 /// If an HTLC expires within this many blocks, force-close the channel to broadcast the
376 /// HTLC-Success transaction.
377 /// In other words, this is an upper bound on how many blocks we think it can take us to get a
378 /// transaction confirmed (and we use it in a few more, equivalent, places).
379 pub(crate) const CLTV_CLAIM_BUFFER: u32 = 6;
380 /// Number of blocks by which point we expect our counterparty to have seen new blocks on the
381 /// network and done a full update_fail_htlc/commitment_signed dance (+ we've updated all our
382 /// copies of ChannelMonitors, including watchtowers). We could enforce the contract by failing
383 /// at CLTV expiration height but giving a grace period to our peer may be profitable for us if he
384 /// can provide an over-late preimage. Nevertheless, grace period has to be accounted in our
385 /// CLTV_EXPIRY_DELTA to be secure. Following this policy we may decrease the rate of channel failures
386 /// due to expiration but increase the cost of funds being locked longuer in case of failure.
387 /// This delay also cover a low-power peer being slow to process blocks and so being behind us on
388 /// accurate block height.
389 /// In case of onchain failure to be pass backward we may see the last block of ANTI_REORG_DELAY
390 /// with at worst this delay, so we are not only using this value as a mercy for them but also
391 /// us as a safeguard to delay with enough time.
392 pub(crate) const LATENCY_GRACE_PERIOD_BLOCKS: u32 = 3;
393 /// Number of blocks we wait on seeing a HTLC output being solved before we fail corresponding inbound
394 /// HTLCs. This prevents us from failing backwards and then getting a reorg resulting in us losing money.
395 /// We use also this delay to be sure we can remove our in-flight claim txn from bump candidates buffer.
396 /// It may cause spurrious generation of bumped claim txn but that's allright given the outpoint is already
397 /// solved by a previous claim tx. What we want to avoid is reorg evicting our claim tx and us not
398 /// keeping bumping another claim tx to solve the outpoint.
399 pub(crate) const ANTI_REORG_DELAY: u32 = 6;
400
401 enum Storage<ChanSigner: ChannelKeys> {
402         Local {
403                 keys: ChanSigner,
404                 funding_key: SecretKey,
405                 revocation_base_key: SecretKey,
406                 htlc_base_key: SecretKey,
407                 delayed_payment_base_key: SecretKey,
408                 payment_base_key: SecretKey,
409                 shutdown_pubkey: PublicKey,
410                 funding_info: Option<(OutPoint, Script)>,
411                 current_remote_commitment_txid: Option<Sha256dHash>,
412                 prev_remote_commitment_txid: Option<Sha256dHash>,
413         },
414         Watchtower {
415                 revocation_base_key: PublicKey,
416                 htlc_base_key: PublicKey,
417         }
418 }
419
420 #[cfg(any(test, feature = "fuzztarget"))]
421 impl<ChanSigner: ChannelKeys> PartialEq for Storage<ChanSigner> {
422         fn eq(&self, other: &Self) -> bool {
423                 match *self {
424                         Storage::Local { ref keys, .. } => {
425                                 let k = keys;
426                                 match *other {
427                                         Storage::Local { ref keys, .. } => keys.pubkeys() == k.pubkeys(),
428                                         Storage::Watchtower { .. } => false,
429                                 }
430                         },
431                         Storage::Watchtower {ref revocation_base_key, ref htlc_base_key} => {
432                                 let (rbk, hbk) = (revocation_base_key, htlc_base_key);
433                                 match *other {
434                                         Storage::Local { .. } => false,
435                                         Storage::Watchtower {ref revocation_base_key, ref htlc_base_key} =>
436                                                 revocation_base_key == rbk && htlc_base_key == hbk,
437                                 }
438                         },
439                 }
440         }
441 }
442
443 #[derive(Clone, PartialEq)]
444 struct LocalSignedTx {
445         /// txid of the transaction in tx, just used to make comparison faster
446         txid: Sha256dHash,
447         tx: LocalCommitmentTransaction,
448         revocation_key: PublicKey,
449         a_htlc_key: PublicKey,
450         b_htlc_key: PublicKey,
451         delayed_payment_key: PublicKey,
452         per_commitment_point: PublicKey,
453         feerate_per_kw: u64,
454         htlc_outputs: Vec<(HTLCOutputInCommitment, Option<Signature>, Option<HTLCSource>)>,
455 }
456
457 /// When ChannelMonitor discovers an onchain outpoint being a step of a channel and that it needs
458 /// to generate a tx to push channel state forward, we cache outpoint-solving tx material to build
459 /// a new bumped one in case of lenghty confirmation delay
460 #[derive(Clone, PartialEq)]
461 pub(crate) enum InputMaterial {
462         Revoked {
463                 witness_script: Script,
464                 pubkey: Option<PublicKey>,
465                 key: SecretKey,
466                 is_htlc: bool,
467                 amount: u64,
468         },
469         RemoteHTLC {
470                 witness_script: Script,
471                 key: SecretKey,
472                 preimage: Option<PaymentPreimage>,
473                 amount: u64,
474                 locktime: u32,
475         },
476         LocalHTLC {
477                 witness_script: Script,
478                 sigs: (Signature, Signature),
479                 preimage: Option<PaymentPreimage>,
480                 amount: u64,
481         }
482 }
483
484 impl Writeable for InputMaterial  {
485         fn write<W: Writer>(&self, writer: &mut W) -> Result<(), ::std::io::Error> {
486                 match self {
487                         &InputMaterial::Revoked { ref witness_script, ref pubkey, ref key, ref is_htlc, ref amount} => {
488                                 writer.write_all(&[0; 1])?;
489                                 witness_script.write(writer)?;
490                                 pubkey.write(writer)?;
491                                 writer.write_all(&key[..])?;
492                                 is_htlc.write(writer)?;
493                                 writer.write_all(&byte_utils::be64_to_array(*amount))?;
494                         },
495                         &InputMaterial::RemoteHTLC { ref witness_script, ref key, ref preimage, ref amount, ref locktime } => {
496                                 writer.write_all(&[1; 1])?;
497                                 witness_script.write(writer)?;
498                                 key.write(writer)?;
499                                 preimage.write(writer)?;
500                                 writer.write_all(&byte_utils::be64_to_array(*amount))?;
501                                 writer.write_all(&byte_utils::be32_to_array(*locktime))?;
502                         },
503                         &InputMaterial::LocalHTLC { ref witness_script, ref sigs, ref preimage, ref amount } => {
504                                 writer.write_all(&[2; 1])?;
505                                 witness_script.write(writer)?;
506                                 sigs.0.write(writer)?;
507                                 sigs.1.write(writer)?;
508                                 preimage.write(writer)?;
509                                 writer.write_all(&byte_utils::be64_to_array(*amount))?;
510                         }
511                 }
512                 Ok(())
513         }
514 }
515
516 impl Readable for InputMaterial {
517         fn read<R: ::std::io::Read>(reader: &mut R) -> Result<Self, DecodeError> {
518                 let input_material = match <u8 as Readable>::read(reader)? {
519                         0 => {
520                                 let witness_script = Readable::read(reader)?;
521                                 let pubkey = Readable::read(reader)?;
522                                 let key = Readable::read(reader)?;
523                                 let is_htlc = Readable::read(reader)?;
524                                 let amount = Readable::read(reader)?;
525                                 InputMaterial::Revoked {
526                                         witness_script,
527                                         pubkey,
528                                         key,
529                                         is_htlc,
530                                         amount
531                                 }
532                         },
533                         1 => {
534                                 let witness_script = Readable::read(reader)?;
535                                 let key = Readable::read(reader)?;
536                                 let preimage = Readable::read(reader)?;
537                                 let amount = Readable::read(reader)?;
538                                 let locktime = Readable::read(reader)?;
539                                 InputMaterial::RemoteHTLC {
540                                         witness_script,
541                                         key,
542                                         preimage,
543                                         amount,
544                                         locktime
545                                 }
546                         },
547                         2 => {
548                                 let witness_script = Readable::read(reader)?;
549                                 let their_sig = Readable::read(reader)?;
550                                 let our_sig = Readable::read(reader)?;
551                                 let preimage = Readable::read(reader)?;
552                                 let amount = Readable::read(reader)?;
553                                 InputMaterial::LocalHTLC {
554                                         witness_script,
555                                         sigs: (their_sig, our_sig),
556                                         preimage,
557                                         amount
558                                 }
559                         }
560                         _ => return Err(DecodeError::InvalidValue),
561                 };
562                 Ok(input_material)
563         }
564 }
565
566 /// ClaimRequest is a descriptor structure to communicate between detection
567 /// and reaction module. They are generated by ChannelMonitor while parsing
568 /// onchain txn leaked from a channel and handed over to OnchainTxHandler which
569 /// is responsible for opportunistic aggregation, selecting and enforcing
570 /// bumping logic, building and signing transactions.
571 pub(crate) struct ClaimRequest {
572         // Block height before which claiming is exclusive to one party,
573         // after reaching it, claiming may be contentious.
574         pub(crate) absolute_timelock: u32,
575         // Timeout tx must have nLocktime set which means aggregating multiple
576         // ones must take the higher nLocktime among them to satisfy all of them.
577         // Sadly it has few pitfalls, a) it takes longuer to get fund back b) CLTV_DELTA
578         // of a sooner-HTLC could be swallowed by the highest nLocktime of the HTLC set.
579         // Do simplify we mark them as non-aggregable.
580         pub(crate) aggregable: bool,
581         // Basic bitcoin outpoint (txid, vout)
582         pub(crate) outpoint: BitcoinOutPoint,
583         // Following outpoint type, set of data needed to generate transaction digest
584         // and satisfy witness program.
585         pub(crate) witness_data: InputMaterial
586 }
587
588 /// Upon discovering of some classes of onchain tx by ChannelMonitor, we may have to take actions on it
589 /// once they mature to enough confirmations (ANTI_REORG_DELAY)
590 #[derive(Clone, PartialEq)]
591 enum OnchainEvent {
592         /// HTLC output getting solved by a timeout, at maturation we pass upstream payment source information to solve
593         /// inbound HTLC in backward channel. Note, in case of preimage, we pass info to upstream without delay as we can
594         /// only win from it, so it's never an OnchainEvent
595         HTLCUpdate {
596                 htlc_update: (HTLCSource, PaymentHash),
597         },
598 }
599
600 const SERIALIZATION_VERSION: u8 = 1;
601 const MIN_SERIALIZATION_VERSION: u8 = 1;
602
603 #[cfg_attr(test, derive(PartialEq))]
604 #[derive(Clone)]
605 pub(super) enum ChannelMonitorUpdateStep {
606         LatestLocalCommitmentTXInfo {
607                 // TODO: We really need to not be generating a fully-signed transaction in Channel and
608                 // passing it here, we need to hold off so that the ChanSigner can enforce a
609                 // only-sign-local-state-for-broadcast once invariant:
610                 commitment_tx: LocalCommitmentTransaction,
611                 local_keys: chan_utils::TxCreationKeys,
612                 feerate_per_kw: u64,
613                 htlc_outputs: Vec<(HTLCOutputInCommitment, Option<Signature>, Option<HTLCSource>)>,
614         },
615         LatestRemoteCommitmentTXInfo {
616                 unsigned_commitment_tx: Transaction, // TODO: We should actually only need the txid here
617                 htlc_outputs: Vec<(HTLCOutputInCommitment, Option<Box<HTLCSource>>)>,
618                 commitment_number: u64,
619                 their_revocation_point: PublicKey,
620         },
621         PaymentPreimage {
622                 payment_preimage: PaymentPreimage,
623         },
624         CommitmentSecret {
625                 idx: u64,
626                 secret: [u8; 32],
627         },
628         /// Indicates our channel is likely a stale version, we're closing, but this update should
629         /// allow us to spend what is ours if our counterparty broadcasts their latest state.
630         RescueRemoteCommitmentTXInfo {
631                 their_current_per_commitment_point: PublicKey,
632         },
633         /// Used to indicate that the no future updates will occur, and likely that the latest local
634         /// commitment transaction(s) should be broadcast, as the channel has been force-closed.
635         ChannelForceClosed {
636                 /// If set to false, we shouldn't broadcast the latest local commitment transaction as we
637                 /// think we've fallen behind!
638                 should_broadcast: bool,
639         },
640 }
641
642 impl Writeable for ChannelMonitorUpdateStep {
643         fn write<W: Writer>(&self, w: &mut W) -> Result<(), ::std::io::Error> {
644                 match self {
645                         &ChannelMonitorUpdateStep::LatestLocalCommitmentTXInfo { ref commitment_tx, ref local_keys, ref feerate_per_kw, ref htlc_outputs } => {
646                                 0u8.write(w)?;
647                                 commitment_tx.write(w)?;
648                                 local_keys.write(w)?;
649                                 feerate_per_kw.write(w)?;
650                                 (htlc_outputs.len() as u64).write(w)?;
651                                 for &(ref output, ref signature, ref source) in htlc_outputs.iter() {
652                                         output.write(w)?;
653                                         signature.write(w)?;
654                                         source.write(w)?;
655                                 }
656                         }
657                         &ChannelMonitorUpdateStep::LatestRemoteCommitmentTXInfo { ref unsigned_commitment_tx, ref htlc_outputs, ref commitment_number, ref their_revocation_point } => {
658                                 1u8.write(w)?;
659                                 unsigned_commitment_tx.write(w)?;
660                                 commitment_number.write(w)?;
661                                 their_revocation_point.write(w)?;
662                                 (htlc_outputs.len() as u64).write(w)?;
663                                 for &(ref output, ref source) in htlc_outputs.iter() {
664                                         output.write(w)?;
665                                         source.as_ref().map(|b| b.as_ref()).write(w)?;
666                                 }
667                         },
668                         &ChannelMonitorUpdateStep::PaymentPreimage { ref payment_preimage } => {
669                                 2u8.write(w)?;
670                                 payment_preimage.write(w)?;
671                         },
672                         &ChannelMonitorUpdateStep::CommitmentSecret { ref idx, ref secret } => {
673                                 3u8.write(w)?;
674                                 idx.write(w)?;
675                                 secret.write(w)?;
676                         },
677                         &ChannelMonitorUpdateStep::RescueRemoteCommitmentTXInfo { ref their_current_per_commitment_point } => {
678                                 4u8.write(w)?;
679                                 their_current_per_commitment_point.write(w)?;
680                         },
681                         &ChannelMonitorUpdateStep::ChannelForceClosed { ref should_broadcast } => {
682                                 5u8.write(w)?;
683                                 should_broadcast.write(w)?;
684                         },
685                 }
686                 Ok(())
687         }
688 }
689 impl Readable for ChannelMonitorUpdateStep {
690         fn read<R: ::std::io::Read>(r: &mut R) -> Result<Self, DecodeError> {
691                 match Readable::read(r)? {
692                         0u8 => {
693                                 Ok(ChannelMonitorUpdateStep::LatestLocalCommitmentTXInfo {
694                                         commitment_tx: Readable::read(r)?,
695                                         local_keys: Readable::read(r)?,
696                                         feerate_per_kw: Readable::read(r)?,
697                                         htlc_outputs: {
698                                                 let len: u64 = Readable::read(r)?;
699                                                 let mut res = Vec::new();
700                                                 for _ in 0..len {
701                                                         res.push((Readable::read(r)?, Readable::read(r)?, Readable::read(r)?));
702                                                 }
703                                                 res
704                                         },
705                                 })
706                         },
707                         1u8 => {
708                                 Ok(ChannelMonitorUpdateStep::LatestRemoteCommitmentTXInfo {
709                                         unsigned_commitment_tx: Readable::read(r)?,
710                                         commitment_number: Readable::read(r)?,
711                                         their_revocation_point: Readable::read(r)?,
712                                         htlc_outputs: {
713                                                 let len: u64 = Readable::read(r)?;
714                                                 let mut res = Vec::new();
715                                                 for _ in 0..len {
716                                                         res.push((Readable::read(r)?, <Option<HTLCSource> as Readable>::read(r)?.map(|o| Box::new(o))));
717                                                 }
718                                                 res
719                                         },
720                                 })
721                         },
722                         2u8 => {
723                                 Ok(ChannelMonitorUpdateStep::PaymentPreimage {
724                                         payment_preimage: Readable::read(r)?,
725                                 })
726                         },
727                         3u8 => {
728                                 Ok(ChannelMonitorUpdateStep::CommitmentSecret {
729                                         idx: Readable::read(r)?,
730                                         secret: Readable::read(r)?,
731                                 })
732                         },
733                         4u8 => {
734                                 Ok(ChannelMonitorUpdateStep::RescueRemoteCommitmentTXInfo {
735                                         their_current_per_commitment_point: Readable::read(r)?,
736                                 })
737                         },
738                         5u8 => {
739                                 Ok(ChannelMonitorUpdateStep::ChannelForceClosed {
740                                         should_broadcast: Readable::read(r)?
741                                 })
742                         },
743                         _ => Err(DecodeError::InvalidValue),
744                 }
745         }
746 }
747
748 /// A ChannelMonitor handles chain events (blocks connected and disconnected) and generates
749 /// on-chain transactions to ensure no loss of funds occurs.
750 ///
751 /// You MUST ensure that no ChannelMonitors for a given channel anywhere contain out-of-date
752 /// information and are actively monitoring the chain.
753 ///
754 /// Pending Events or updated HTLCs which have not yet been read out by
755 /// get_and_clear_pending_htlcs_updated or get_and_clear_pending_events are serialized to disk and
756 /// reloaded at deserialize-time. Thus, you must ensure that, when handling events, all events
757 /// gotten are fully handled before re-serializing the new state.
758 pub struct ChannelMonitor<ChanSigner: ChannelKeys> {
759         latest_update_id: u64,
760         commitment_transaction_number_obscure_factor: u64,
761
762         destination_script: Script,
763         key_storage: Storage<ChanSigner>,
764         their_htlc_base_key: Option<PublicKey>,
765         their_delayed_payment_base_key: Option<PublicKey>,
766         funding_redeemscript: Option<Script>,
767         channel_value_satoshis: Option<u64>,
768         // first is the idx of the first of the two revocation points
769         their_cur_revocation_points: Option<(u64, PublicKey, Option<PublicKey>)>,
770
771         our_to_self_delay: u16,
772         their_to_self_delay: Option<u16>,
773
774         commitment_secrets: CounterpartyCommitmentSecrets,
775         remote_claimable_outpoints: HashMap<Sha256dHash, Vec<(HTLCOutputInCommitment, Option<Box<HTLCSource>>)>>,
776         /// We cannot identify HTLC-Success or HTLC-Timeout transactions by themselves on the chain.
777         /// Nor can we figure out their commitment numbers without the commitment transaction they are
778         /// spending. Thus, in order to claim them via revocation key, we track all the remote
779         /// commitment transactions which we find on-chain, mapping them to the commitment number which
780         /// can be used to derive the revocation key and claim the transactions.
781         remote_commitment_txn_on_chain: HashMap<Sha256dHash, (u64, Vec<Script>)>,
782         /// Cache used to make pruning of payment_preimages faster.
783         /// Maps payment_hash values to commitment numbers for remote transactions for non-revoked
784         /// remote transactions (ie should remain pretty small).
785         /// Serialized to disk but should generally not be sent to Watchtowers.
786         remote_hash_commitment_number: HashMap<PaymentHash, u64>,
787
788         // We store two local commitment transactions to avoid any race conditions where we may update
789         // some monitors (potentially on watchtowers) but then fail to update others, resulting in the
790         // various monitors for one channel being out of sync, and us broadcasting a local
791         // transaction for which we have deleted claim information on some watchtowers.
792         prev_local_signed_commitment_tx: Option<LocalSignedTx>,
793         current_local_signed_commitment_tx: Option<LocalSignedTx>,
794
795         // Used just for ChannelManager to make sure it has the latest channel data during
796         // deserialization
797         current_remote_commitment_number: u64,
798
799         payment_preimages: HashMap<PaymentHash, PaymentPreimage>,
800
801         pending_htlcs_updated: Vec<HTLCUpdate>,
802         pending_events: Vec<events::Event>,
803
804         // Thanks to data loss protection, we may be able to claim our non-htlc funds
805         // back, this is the script we have to spend from but we need to
806         // scan every commitment transaction for that
807         to_remote_rescue: Option<(Script, SecretKey)>,
808
809         // Used to track onchain events, i.e transactions parts of channels confirmed on chain, on which
810         // we have to take actions once they reach enough confs. Key is a block height timer, i.e we enforce
811         // actions when we receive a block with given height. Actions depend on OnchainEvent type.
812         onchain_events_waiting_threshold_conf: HashMap<u32, Vec<OnchainEvent>>,
813
814         // If we get serialized out and re-read, we need to make sure that the chain monitoring
815         // interface knows about the TXOs that we want to be notified of spends of. We could probably
816         // be smart and derive them from the above storage fields, but its much simpler and more
817         // Obviously Correct (tm) if we just keep track of them explicitly.
818         outputs_to_watch: HashMap<Sha256dHash, Vec<Script>>,
819
820         #[cfg(test)]
821         pub onchain_tx_handler: OnchainTxHandler,
822         #[cfg(not(test))]
823         onchain_tx_handler: OnchainTxHandler,
824
825         // We simply modify last_block_hash in Channel's block_connected so that serialization is
826         // consistent but hopefully the users' copy handles block_connected in a consistent way.
827         // (we do *not*, however, update them in update_monitor to ensure any local user copies keep
828         // their last_block_hash from its state and not based on updated copies that didn't run through
829         // the full block_connected).
830         pub(crate) last_block_hash: Sha256dHash,
831         secp_ctx: Secp256k1<secp256k1::All>, //TODO: dedup this a bit...
832         logger: Arc<Logger>,
833 }
834
835 #[cfg(any(test, feature = "fuzztarget"))]
836 /// Used only in testing and fuzztarget to check serialization roundtrips don't change the
837 /// underlying object
838 impl<ChanSigner: ChannelKeys> PartialEq for ChannelMonitor<ChanSigner> {
839         fn eq(&self, other: &Self) -> bool {
840                 if self.latest_update_id != other.latest_update_id ||
841                         self.commitment_transaction_number_obscure_factor != other.commitment_transaction_number_obscure_factor ||
842                         self.destination_script != other.destination_script ||
843                         self.key_storage != other.key_storage ||
844                         self.their_htlc_base_key != other.their_htlc_base_key ||
845                         self.their_delayed_payment_base_key != other.their_delayed_payment_base_key ||
846                         self.funding_redeemscript != other.funding_redeemscript ||
847                         self.channel_value_satoshis != other.channel_value_satoshis ||
848                         self.their_cur_revocation_points != other.their_cur_revocation_points ||
849                         self.our_to_self_delay != other.our_to_self_delay ||
850                         self.their_to_self_delay != other.their_to_self_delay ||
851                         self.commitment_secrets != other.commitment_secrets ||
852                         self.remote_claimable_outpoints != other.remote_claimable_outpoints ||
853                         self.remote_commitment_txn_on_chain != other.remote_commitment_txn_on_chain ||
854                         self.remote_hash_commitment_number != other.remote_hash_commitment_number ||
855                         self.prev_local_signed_commitment_tx != other.prev_local_signed_commitment_tx ||
856                         self.current_remote_commitment_number != other.current_remote_commitment_number ||
857                         self.current_local_signed_commitment_tx != other.current_local_signed_commitment_tx ||
858                         self.payment_preimages != other.payment_preimages ||
859                         self.pending_htlcs_updated != other.pending_htlcs_updated ||
860                         self.pending_events.len() != other.pending_events.len() || // We trust events to round-trip properly
861                         self.to_remote_rescue != other.to_remote_rescue ||
862                         self.onchain_events_waiting_threshold_conf != other.onchain_events_waiting_threshold_conf ||
863                         self.outputs_to_watch != other.outputs_to_watch
864                 {
865                         false
866                 } else {
867                         true
868                 }
869         }
870 }
871
872 impl<ChanSigner: ChannelKeys + Writeable> ChannelMonitor<ChanSigner> {
873         /// Serializes into a vec, with various modes for the exposed pub fns
874         fn write<W: Writer>(&self, writer: &mut W, for_local_storage: bool) -> Result<(), ::std::io::Error> {
875                 //TODO: We still write out all the serialization here manually instead of using the fancy
876                 //serialization framework we have, we should migrate things over to it.
877                 writer.write_all(&[SERIALIZATION_VERSION; 1])?;
878                 writer.write_all(&[MIN_SERIALIZATION_VERSION; 1])?;
879
880                 self.latest_update_id.write(writer)?;
881
882                 // Set in initial Channel-object creation, so should always be set by now:
883                 U48(self.commitment_transaction_number_obscure_factor).write(writer)?;
884
885                 self.destination_script.write(writer)?;
886                 match self.key_storage {
887                         Storage::Local { ref keys, ref funding_key, ref revocation_base_key, ref htlc_base_key, ref delayed_payment_base_key, ref payment_base_key, ref shutdown_pubkey, ref funding_info, ref current_remote_commitment_txid, ref prev_remote_commitment_txid } => {
888                                 writer.write_all(&[0; 1])?;
889                                 keys.write(writer)?;
890                                 writer.write_all(&funding_key[..])?;
891                                 writer.write_all(&revocation_base_key[..])?;
892                                 writer.write_all(&htlc_base_key[..])?;
893                                 writer.write_all(&delayed_payment_base_key[..])?;
894                                 writer.write_all(&payment_base_key[..])?;
895                                 writer.write_all(&shutdown_pubkey.serialize())?;
896                                 match funding_info  {
897                                         &Some((ref outpoint, ref script)) => {
898                                                 writer.write_all(&outpoint.txid[..])?;
899                                                 writer.write_all(&byte_utils::be16_to_array(outpoint.index))?;
900                                                 script.write(writer)?;
901                                         },
902                                         &None => {
903                                                 debug_assert!(false, "Try to serialize a useless Local monitor !");
904                                         },
905                                 }
906                                 current_remote_commitment_txid.write(writer)?;
907                                 prev_remote_commitment_txid.write(writer)?;
908                         },
909                         Storage::Watchtower { .. } => unimplemented!(),
910                 }
911
912                 writer.write_all(&self.their_htlc_base_key.as_ref().unwrap().serialize())?;
913                 writer.write_all(&self.their_delayed_payment_base_key.as_ref().unwrap().serialize())?;
914                 self.funding_redeemscript.as_ref().unwrap().write(writer)?;
915                 self.channel_value_satoshis.unwrap().write(writer)?;
916
917                 match self.their_cur_revocation_points {
918                         Some((idx, pubkey, second_option)) => {
919                                 writer.write_all(&byte_utils::be48_to_array(idx))?;
920                                 writer.write_all(&pubkey.serialize())?;
921                                 match second_option {
922                                         Some(second_pubkey) => {
923                                                 writer.write_all(&second_pubkey.serialize())?;
924                                         },
925                                         None => {
926                                                 writer.write_all(&[0; 33])?;
927                                         },
928                                 }
929                         },
930                         None => {
931                                 writer.write_all(&byte_utils::be48_to_array(0))?;
932                         },
933                 }
934
935                 writer.write_all(&byte_utils::be16_to_array(self.our_to_self_delay))?;
936                 writer.write_all(&byte_utils::be16_to_array(self.their_to_self_delay.unwrap()))?;
937
938                 self.commitment_secrets.write(writer)?;
939
940                 macro_rules! serialize_htlc_in_commitment {
941                         ($htlc_output: expr) => {
942                                 writer.write_all(&[$htlc_output.offered as u8; 1])?;
943                                 writer.write_all(&byte_utils::be64_to_array($htlc_output.amount_msat))?;
944                                 writer.write_all(&byte_utils::be32_to_array($htlc_output.cltv_expiry))?;
945                                 writer.write_all(&$htlc_output.payment_hash.0[..])?;
946                                 $htlc_output.transaction_output_index.write(writer)?;
947                         }
948                 }
949
950                 writer.write_all(&byte_utils::be64_to_array(self.remote_claimable_outpoints.len() as u64))?;
951                 for (ref txid, ref htlc_infos) in self.remote_claimable_outpoints.iter() {
952                         writer.write_all(&txid[..])?;
953                         writer.write_all(&byte_utils::be64_to_array(htlc_infos.len() as u64))?;
954                         for &(ref htlc_output, ref htlc_source) in htlc_infos.iter() {
955                                 serialize_htlc_in_commitment!(htlc_output);
956                                 htlc_source.as_ref().map(|b| b.as_ref()).write(writer)?;
957                         }
958                 }
959
960                 writer.write_all(&byte_utils::be64_to_array(self.remote_commitment_txn_on_chain.len() as u64))?;
961                 for (ref txid, &(commitment_number, ref txouts)) in self.remote_commitment_txn_on_chain.iter() {
962                         writer.write_all(&txid[..])?;
963                         writer.write_all(&byte_utils::be48_to_array(commitment_number))?;
964                         (txouts.len() as u64).write(writer)?;
965                         for script in txouts.iter() {
966                                 script.write(writer)?;
967                         }
968                 }
969
970                 if for_local_storage {
971                         writer.write_all(&byte_utils::be64_to_array(self.remote_hash_commitment_number.len() as u64))?;
972                         for (ref payment_hash, commitment_number) in self.remote_hash_commitment_number.iter() {
973                                 writer.write_all(&payment_hash.0[..])?;
974                                 writer.write_all(&byte_utils::be48_to_array(*commitment_number))?;
975                         }
976                 } else {
977                         writer.write_all(&byte_utils::be64_to_array(0))?;
978                 }
979
980                 macro_rules! serialize_local_tx {
981                         ($local_tx: expr) => {
982                                 $local_tx.tx.write(writer)?;
983                                 writer.write_all(&$local_tx.revocation_key.serialize())?;
984                                 writer.write_all(&$local_tx.a_htlc_key.serialize())?;
985                                 writer.write_all(&$local_tx.b_htlc_key.serialize())?;
986                                 writer.write_all(&$local_tx.delayed_payment_key.serialize())?;
987                                 writer.write_all(&$local_tx.per_commitment_point.serialize())?;
988
989                                 writer.write_all(&byte_utils::be64_to_array($local_tx.feerate_per_kw))?;
990                                 writer.write_all(&byte_utils::be64_to_array($local_tx.htlc_outputs.len() as u64))?;
991                                 for &(ref htlc_output, ref sig, ref htlc_source) in $local_tx.htlc_outputs.iter() {
992                                         serialize_htlc_in_commitment!(htlc_output);
993                                         if let &Some(ref their_sig) = sig {
994                                                 1u8.write(writer)?;
995                                                 writer.write_all(&their_sig.serialize_compact())?;
996                                         } else {
997                                                 0u8.write(writer)?;
998                                         }
999                                         htlc_source.write(writer)?;
1000                                 }
1001                         }
1002                 }
1003
1004                 if let Some(ref prev_local_tx) = self.prev_local_signed_commitment_tx {
1005                         writer.write_all(&[1; 1])?;
1006                         serialize_local_tx!(prev_local_tx);
1007                 } else {
1008                         writer.write_all(&[0; 1])?;
1009                 }
1010
1011                 if let Some(ref cur_local_tx) = self.current_local_signed_commitment_tx {
1012                         writer.write_all(&[1; 1])?;
1013                         serialize_local_tx!(cur_local_tx);
1014                 } else {
1015                         writer.write_all(&[0; 1])?;
1016                 }
1017
1018                 if for_local_storage {
1019                         writer.write_all(&byte_utils::be48_to_array(self.current_remote_commitment_number))?;
1020                 } else {
1021                         writer.write_all(&byte_utils::be48_to_array(0))?;
1022                 }
1023
1024                 writer.write_all(&byte_utils::be64_to_array(self.payment_preimages.len() as u64))?;
1025                 for payment_preimage in self.payment_preimages.values() {
1026                         writer.write_all(&payment_preimage.0[..])?;
1027                 }
1028
1029                 writer.write_all(&byte_utils::be64_to_array(self.pending_htlcs_updated.len() as u64))?;
1030                 for data in self.pending_htlcs_updated.iter() {
1031                         data.write(writer)?;
1032                 }
1033
1034                 writer.write_all(&byte_utils::be64_to_array(self.pending_events.len() as u64))?;
1035                 for event in self.pending_events.iter() {
1036                         event.write(writer)?;
1037                 }
1038
1039                 self.last_block_hash.write(writer)?;
1040                 if let Some((ref to_remote_script, ref local_key)) = self.to_remote_rescue {
1041                         writer.write_all(&[1; 1])?;
1042                         to_remote_script.write(writer)?;
1043                         local_key.write(writer)?;
1044                 } else {
1045                         writer.write_all(&[0; 1])?;
1046                 }
1047
1048                 writer.write_all(&byte_utils::be64_to_array(self.onchain_events_waiting_threshold_conf.len() as u64))?;
1049                 for (ref target, ref events) in self.onchain_events_waiting_threshold_conf.iter() {
1050                         writer.write_all(&byte_utils::be32_to_array(**target))?;
1051                         writer.write_all(&byte_utils::be64_to_array(events.len() as u64))?;
1052                         for ev in events.iter() {
1053                                 match *ev {
1054                                         OnchainEvent::HTLCUpdate { ref htlc_update } => {
1055                                                 0u8.write(writer)?;
1056                                                 htlc_update.0.write(writer)?;
1057                                                 htlc_update.1.write(writer)?;
1058                                         },
1059                                 }
1060                         }
1061                 }
1062
1063                 (self.outputs_to_watch.len() as u64).write(writer)?;
1064                 for (txid, output_scripts) in self.outputs_to_watch.iter() {
1065                         txid.write(writer)?;
1066                         (output_scripts.len() as u64).write(writer)?;
1067                         for script in output_scripts.iter() {
1068                                 script.write(writer)?;
1069                         }
1070                 }
1071                 self.onchain_tx_handler.write(writer)?;
1072
1073                 Ok(())
1074         }
1075
1076         /// Writes this monitor into the given writer, suitable for writing to disk.
1077         ///
1078         /// Note that the deserializer is only implemented for (Sha256dHash, ChannelMonitor), which
1079         /// tells you the last block hash which was block_connect()ed. You MUST rescan any blocks along
1080         /// the "reorg path" (ie not just starting at the same height but starting at the highest
1081         /// common block that appears on your best chain as well as on the chain which contains the
1082         /// last block hash returned) upon deserializing the object!
1083         pub fn write_for_disk<W: Writer>(&self, writer: &mut W) -> Result<(), ::std::io::Error> {
1084                 self.write(writer, true)
1085         }
1086
1087         /// Encodes this monitor into the given writer, suitable for sending to a remote watchtower
1088         ///
1089         /// Note that the deserializer is only implemented for (Sha256dHash, ChannelMonitor), which
1090         /// tells you the last block hash which was block_connect()ed. You MUST rescan any blocks along
1091         /// the "reorg path" (ie not just starting at the same height but starting at the highest
1092         /// common block that appears on your best chain as well as on the chain which contains the
1093         /// last block hash returned) upon deserializing the object!
1094         pub fn write_for_watchtower<W: Writer>(&self, writer: &mut W) -> Result<(), ::std::io::Error> {
1095                 self.write(writer, false)
1096         }
1097 }
1098
1099 impl<ChanSigner: ChannelKeys> ChannelMonitor<ChanSigner> {
1100         pub(super) fn new(keys: ChanSigner, shutdown_pubkey: &PublicKey,
1101                         our_to_self_delay: u16, destination_script: &Script, funding_info: (OutPoint, Script),
1102                         their_htlc_base_key: &PublicKey, their_delayed_payment_base_key: &PublicKey,
1103                         their_to_self_delay: u16, funding_redeemscript: Script, channel_value_satoshis: u64,
1104                         commitment_transaction_number_obscure_factor: u64,
1105                         logger: Arc<Logger>) -> ChannelMonitor<ChanSigner> {
1106
1107                 assert!(commitment_transaction_number_obscure_factor <= (1 << 48));
1108                 let funding_key = keys.funding_key().clone();
1109                 let revocation_base_key = keys.revocation_base_key().clone();
1110                 let htlc_base_key = keys.htlc_base_key().clone();
1111                 let delayed_payment_base_key = keys.delayed_payment_base_key().clone();
1112                 let payment_base_key = keys.payment_base_key().clone();
1113                 ChannelMonitor {
1114                         latest_update_id: 0,
1115                         commitment_transaction_number_obscure_factor,
1116
1117                         destination_script: destination_script.clone(),
1118                         key_storage: Storage::Local {
1119                                 keys,
1120                                 funding_key,
1121                                 revocation_base_key,
1122                                 htlc_base_key,
1123                                 delayed_payment_base_key,
1124                                 payment_base_key,
1125                                 shutdown_pubkey: shutdown_pubkey.clone(),
1126                                 funding_info: Some(funding_info),
1127                                 current_remote_commitment_txid: None,
1128                                 prev_remote_commitment_txid: None,
1129                         },
1130                         their_htlc_base_key: Some(their_htlc_base_key.clone()),
1131                         their_delayed_payment_base_key: Some(their_delayed_payment_base_key.clone()),
1132                         funding_redeemscript: Some(funding_redeemscript),
1133                         channel_value_satoshis: Some(channel_value_satoshis),
1134                         their_cur_revocation_points: None,
1135
1136                         our_to_self_delay: our_to_self_delay,
1137                         their_to_self_delay: Some(their_to_self_delay),
1138
1139                         commitment_secrets: CounterpartyCommitmentSecrets::new(),
1140                         remote_claimable_outpoints: HashMap::new(),
1141                         remote_commitment_txn_on_chain: HashMap::new(),
1142                         remote_hash_commitment_number: HashMap::new(),
1143
1144                         prev_local_signed_commitment_tx: None,
1145                         current_local_signed_commitment_tx: None,
1146                         current_remote_commitment_number: 1 << 48,
1147
1148                         payment_preimages: HashMap::new(),
1149                         pending_htlcs_updated: Vec::new(),
1150                         pending_events: Vec::new(),
1151
1152                         to_remote_rescue: None,
1153
1154                         onchain_events_waiting_threshold_conf: HashMap::new(),
1155                         outputs_to_watch: HashMap::new(),
1156
1157                         onchain_tx_handler: OnchainTxHandler::new(destination_script.clone(), logger.clone()),
1158
1159                         last_block_hash: Default::default(),
1160                         secp_ctx: Secp256k1::new(),
1161                         logger,
1162                 }
1163         }
1164
1165         /// Inserts a revocation secret into this channel monitor. Prunes old preimages if neither
1166         /// needed by local commitment transactions HTCLs nor by remote ones. Unless we haven't already seen remote
1167         /// commitment transaction's secret, they are de facto pruned (we can use revocation key).
1168         pub(super) fn provide_secret(&mut self, idx: u64, secret: [u8; 32]) -> Result<(), MonitorUpdateError> {
1169                 if let Err(()) = self.commitment_secrets.provide_secret(idx, secret) {
1170                         return Err(MonitorUpdateError("Previous secret did not match new one"));
1171                 }
1172
1173                 // Prune HTLCs from the previous remote commitment tx so we don't generate failure/fulfill
1174                 // events for now-revoked/fulfilled HTLCs.
1175                 if let Storage::Local { ref mut prev_remote_commitment_txid, .. } = self.key_storage {
1176                         if let Some(txid) = prev_remote_commitment_txid.take() {
1177                                 for &mut (_, ref mut source) in self.remote_claimable_outpoints.get_mut(&txid).unwrap() {
1178                                         *source = None;
1179                                 }
1180                         }
1181                 }
1182
1183                 if !self.payment_preimages.is_empty() {
1184                         let local_signed_commitment_tx = self.current_local_signed_commitment_tx.as_ref().expect("Channel needs at least an initial commitment tx !");
1185                         let prev_local_signed_commitment_tx = self.prev_local_signed_commitment_tx.as_ref();
1186                         let min_idx = self.get_min_seen_secret();
1187                         let remote_hash_commitment_number = &mut self.remote_hash_commitment_number;
1188
1189                         self.payment_preimages.retain(|&k, _| {
1190                                 for &(ref htlc, _, _) in &local_signed_commitment_tx.htlc_outputs {
1191                                         if k == htlc.payment_hash {
1192                                                 return true
1193                                         }
1194                                 }
1195                                 if let Some(prev_local_commitment_tx) = prev_local_signed_commitment_tx {
1196                                         for &(ref htlc, _, _) in prev_local_commitment_tx.htlc_outputs.iter() {
1197                                                 if k == htlc.payment_hash {
1198                                                         return true
1199                                                 }
1200                                         }
1201                                 }
1202                                 let contains = if let Some(cn) = remote_hash_commitment_number.get(&k) {
1203                                         if *cn < min_idx {
1204                                                 return true
1205                                         }
1206                                         true
1207                                 } else { false };
1208                                 if contains {
1209                                         remote_hash_commitment_number.remove(&k);
1210                                 }
1211                                 false
1212                         });
1213                 }
1214
1215                 Ok(())
1216         }
1217
1218         /// Informs this monitor of the latest remote (ie non-broadcastable) commitment transaction.
1219         /// The monitor watches for it to be broadcasted and then uses the HTLC information (and
1220         /// possibly future revocation/preimage information) to claim outputs where possible.
1221         /// We cache also the mapping hash:commitment number to lighten pruning of old preimages by watchtowers.
1222         pub(super) fn provide_latest_remote_commitment_tx_info(&mut self, unsigned_commitment_tx: &Transaction, htlc_outputs: Vec<(HTLCOutputInCommitment, Option<Box<HTLCSource>>)>, commitment_number: u64, their_revocation_point: PublicKey) {
1223                 // TODO: Encrypt the htlc_outputs data with the single-hash of the commitment transaction
1224                 // so that a remote monitor doesn't learn anything unless there is a malicious close.
1225                 // (only maybe, sadly we cant do the same for local info, as we need to be aware of
1226                 // timeouts)
1227                 for &(ref htlc, _) in &htlc_outputs {
1228                         self.remote_hash_commitment_number.insert(htlc.payment_hash, commitment_number);
1229                 }
1230
1231                 let new_txid = unsigned_commitment_tx.txid();
1232                 log_trace!(self, "Tracking new remote commitment transaction with txid {} at commitment number {} with {} HTLC outputs", new_txid, commitment_number, htlc_outputs.len());
1233                 log_trace!(self, "New potential remote commitment transaction: {}", encode::serialize_hex(unsigned_commitment_tx));
1234                 if let Storage::Local { ref mut current_remote_commitment_txid, ref mut prev_remote_commitment_txid, .. } = self.key_storage {
1235                         *prev_remote_commitment_txid = current_remote_commitment_txid.take();
1236                         *current_remote_commitment_txid = Some(new_txid);
1237                 }
1238                 self.remote_claimable_outpoints.insert(new_txid, htlc_outputs);
1239                 self.current_remote_commitment_number = commitment_number;
1240                 //TODO: Merge this into the other per-remote-transaction output storage stuff
1241                 match self.their_cur_revocation_points {
1242                         Some(old_points) => {
1243                                 if old_points.0 == commitment_number + 1 {
1244                                         self.their_cur_revocation_points = Some((old_points.0, old_points.1, Some(their_revocation_point)));
1245                                 } else if old_points.0 == commitment_number + 2 {
1246                                         if let Some(old_second_point) = old_points.2 {
1247                                                 self.their_cur_revocation_points = Some((old_points.0 - 1, old_second_point, Some(their_revocation_point)));
1248                                         } else {
1249                                                 self.their_cur_revocation_points = Some((commitment_number, their_revocation_point, None));
1250                                         }
1251                                 } else {
1252                                         self.their_cur_revocation_points = Some((commitment_number, their_revocation_point, None));
1253                                 }
1254                         },
1255                         None => {
1256                                 self.their_cur_revocation_points = Some((commitment_number, their_revocation_point, None));
1257                         }
1258                 }
1259         }
1260
1261         pub(super) fn provide_rescue_remote_commitment_tx_info(&mut self, their_revocation_point: PublicKey) {
1262                 match self.key_storage {
1263                         Storage::Local { ref payment_base_key, ref keys, .. } => {
1264                                 if let Ok(payment_key) = chan_utils::derive_public_key(&self.secp_ctx, &their_revocation_point, &keys.pubkeys().payment_basepoint) {
1265                                         let to_remote_script =  Builder::new().push_opcode(opcodes::all::OP_PUSHBYTES_0)
1266                                                 .push_slice(&Hash160::hash(&payment_key.serialize())[..])
1267                                                 .into_script();
1268                                         if let Ok(to_remote_key) = chan_utils::derive_private_key(&self.secp_ctx, &their_revocation_point, &payment_base_key) {
1269                                                 self.to_remote_rescue = Some((to_remote_script, to_remote_key));
1270                                         }
1271                                 }
1272                         },
1273                         Storage::Watchtower { .. } => {}
1274                 }
1275         }
1276
1277         /// Informs this monitor of the latest local (ie broadcastable) commitment transaction. The
1278         /// monitor watches for timeouts and may broadcast it if we approach such a timeout. Thus, it
1279         /// is important that any clones of this channel monitor (including remote clones) by kept
1280         /// up-to-date as our local commitment transaction is updated.
1281         /// Panics if set_their_to_self_delay has never been called.
1282         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<Signature>, Option<HTLCSource>)>) -> Result<(), MonitorUpdateError> {
1283                 if self.their_to_self_delay.is_none() {
1284                         return Err(MonitorUpdateError("Got a local commitment tx info update before we'd set basic information about the channel"));
1285                 }
1286                 self.prev_local_signed_commitment_tx = self.current_local_signed_commitment_tx.take();
1287                 self.current_local_signed_commitment_tx = Some(LocalSignedTx {
1288                         txid: commitment_tx.txid(),
1289                         tx: commitment_tx,
1290                         revocation_key: local_keys.revocation_key,
1291                         a_htlc_key: local_keys.a_htlc_key,
1292                         b_htlc_key: local_keys.b_htlc_key,
1293                         delayed_payment_key: local_keys.a_delayed_payment_key,
1294                         per_commitment_point: local_keys.per_commitment_point,
1295                         feerate_per_kw,
1296                         htlc_outputs,
1297                 });
1298                 Ok(())
1299         }
1300
1301         /// Provides a payment_hash->payment_preimage mapping. Will be automatically pruned when all
1302         /// commitment_tx_infos which contain the payment hash have been revoked.
1303         pub(super) fn provide_payment_preimage(&mut self, payment_hash: &PaymentHash, payment_preimage: &PaymentPreimage) {
1304                 self.payment_preimages.insert(payment_hash.clone(), payment_preimage.clone());
1305         }
1306
1307         pub(super) fn broadcast_latest_local_commitment_txn<B: Deref>(&mut self, broadcaster: &B)
1308                 where B::Target: BroadcasterInterface,
1309         {
1310                 for tx in self.get_latest_local_commitment_txn().iter() {
1311                         broadcaster.broadcast_transaction(tx);
1312                 }
1313         }
1314
1315         /// Used in Channel to cheat wrt the update_ids since it plays games, will be removed soon!
1316         pub(super) fn update_monitor_ooo(&mut self, mut updates: ChannelMonitorUpdate) -> Result<(), MonitorUpdateError> {
1317                 for update in updates.updates.drain(..) {
1318                         match update {
1319                                 ChannelMonitorUpdateStep::LatestLocalCommitmentTXInfo { commitment_tx, local_keys, feerate_per_kw, htlc_outputs } =>
1320                                         self.provide_latest_local_commitment_tx_info(commitment_tx, local_keys, feerate_per_kw, htlc_outputs)?,
1321                                 ChannelMonitorUpdateStep::LatestRemoteCommitmentTXInfo { unsigned_commitment_tx, htlc_outputs, commitment_number, their_revocation_point } =>
1322                                         self.provide_latest_remote_commitment_tx_info(&unsigned_commitment_tx, htlc_outputs, commitment_number, their_revocation_point),
1323                                 ChannelMonitorUpdateStep::PaymentPreimage { payment_preimage } =>
1324                                         self.provide_payment_preimage(&PaymentHash(Sha256::hash(&payment_preimage.0[..]).into_inner()), &payment_preimage),
1325                                 ChannelMonitorUpdateStep::CommitmentSecret { idx, secret } =>
1326                                         self.provide_secret(idx, secret)?,
1327                                 ChannelMonitorUpdateStep::RescueRemoteCommitmentTXInfo { their_current_per_commitment_point } =>
1328                                         self.provide_rescue_remote_commitment_tx_info(their_current_per_commitment_point),
1329                                 ChannelMonitorUpdateStep::ChannelForceClosed { .. } => {},
1330                         }
1331                 }
1332                 self.latest_update_id = updates.update_id;
1333                 Ok(())
1334         }
1335
1336         /// Updates a ChannelMonitor on the basis of some new information provided by the Channel
1337         /// itself.
1338         ///
1339         /// panics if the given update is not the next update by update_id.
1340         pub fn update_monitor<B: Deref>(&mut self, mut updates: ChannelMonitorUpdate, broadcaster: &B) -> Result<(), MonitorUpdateError>
1341                 where B::Target: BroadcasterInterface,
1342         {
1343                 if self.latest_update_id + 1 != updates.update_id {
1344                         panic!("Attempted to apply ChannelMonitorUpdates out of order, check the update_id before passing an update to update_monitor!");
1345                 }
1346                 for update in updates.updates.drain(..) {
1347                         match update {
1348                                 ChannelMonitorUpdateStep::LatestLocalCommitmentTXInfo { commitment_tx, local_keys, feerate_per_kw, htlc_outputs } =>
1349                                         self.provide_latest_local_commitment_tx_info(commitment_tx, local_keys, feerate_per_kw, htlc_outputs)?,
1350                                 ChannelMonitorUpdateStep::LatestRemoteCommitmentTXInfo { unsigned_commitment_tx, htlc_outputs, commitment_number, their_revocation_point } =>
1351                                         self.provide_latest_remote_commitment_tx_info(&unsigned_commitment_tx, htlc_outputs, commitment_number, their_revocation_point),
1352                                 ChannelMonitorUpdateStep::PaymentPreimage { payment_preimage } =>
1353                                         self.provide_payment_preimage(&PaymentHash(Sha256::hash(&payment_preimage.0[..]).into_inner()), &payment_preimage),
1354                                 ChannelMonitorUpdateStep::CommitmentSecret { idx, secret } =>
1355                                         self.provide_secret(idx, secret)?,
1356                                 ChannelMonitorUpdateStep::RescueRemoteCommitmentTXInfo { their_current_per_commitment_point } =>
1357                                         self.provide_rescue_remote_commitment_tx_info(their_current_per_commitment_point),
1358                                 ChannelMonitorUpdateStep::ChannelForceClosed { should_broadcast } => {
1359                                         if should_broadcast {
1360                                                 self.broadcast_latest_local_commitment_txn(broadcaster);
1361                                         } else {
1362                                                 log_error!(self, "You have a toxic local commitment transaction avaible in channel monitor, read comment in ChannelMonitor::get_latest_local_commitment_txn to be informed of manual action to take");
1363                                         }
1364                                 }
1365                         }
1366                 }
1367                 self.latest_update_id = updates.update_id;
1368                 Ok(())
1369         }
1370
1371         /// Gets the update_id from the latest ChannelMonitorUpdate which was applied to this
1372         /// ChannelMonitor.
1373         pub fn get_latest_update_id(&self) -> u64 {
1374                 self.latest_update_id
1375         }
1376
1377         /// Gets the funding transaction outpoint of the channel this ChannelMonitor is monitoring for.
1378         pub fn get_funding_txo(&self) -> Option<OutPoint> {
1379                 match self.key_storage {
1380                         Storage::Local { ref funding_info, .. } => {
1381                                 match funding_info {
1382                                         &Some((outpoint, _)) => Some(outpoint),
1383                                         &None => None
1384                                 }
1385                         },
1386                         Storage::Watchtower { .. } => {
1387                                 return None;
1388                         }
1389                 }
1390         }
1391
1392         /// Gets a list of txids, with their output scripts (in the order they appear in the
1393         /// transaction), which we must learn about spends of via block_connected().
1394         pub fn get_outputs_to_watch(&self) -> &HashMap<Sha256dHash, Vec<Script>> {
1395                 &self.outputs_to_watch
1396         }
1397
1398         /// Gets the sets of all outpoints which this ChannelMonitor expects to hear about spends of.
1399         /// Generally useful when deserializing as during normal operation the return values of
1400         /// block_connected are sufficient to ensure all relevant outpoints are being monitored (note
1401         /// that the get_funding_txo outpoint and transaction must also be monitored for!).
1402         pub fn get_monitored_outpoints(&self) -> Vec<(Sha256dHash, u32, &Script)> {
1403                 let mut res = Vec::with_capacity(self.remote_commitment_txn_on_chain.len() * 2);
1404                 for (ref txid, &(_, ref outputs)) in self.remote_commitment_txn_on_chain.iter() {
1405                         for (idx, output) in outputs.iter().enumerate() {
1406                                 res.push(((*txid).clone(), idx as u32, output));
1407                         }
1408                 }
1409                 res
1410         }
1411
1412         /// Get the list of HTLCs who's status has been updated on chain. This should be called by
1413         /// ChannelManager via ManyChannelMonitor::get_and_clear_pending_htlcs_updated().
1414         pub fn get_and_clear_pending_htlcs_updated(&mut self) -> Vec<HTLCUpdate> {
1415                 let mut ret = Vec::new();
1416                 mem::swap(&mut ret, &mut self.pending_htlcs_updated);
1417                 ret
1418         }
1419
1420         /// Gets the list of pending events which were generated by previous actions, clearing the list
1421         /// in the process.
1422         ///
1423         /// This is called by ManyChannelMonitor::get_and_clear_pending_events() and is equivalent to
1424         /// EventsProvider::get_and_clear_pending_events() except that it requires &mut self as we do
1425         /// no internal locking in ChannelMonitors.
1426         pub fn get_and_clear_pending_events(&mut self) -> Vec<events::Event> {
1427                 let mut ret = Vec::new();
1428                 mem::swap(&mut ret, &mut self.pending_events);
1429                 ret
1430         }
1431
1432         /// Can only fail if idx is < get_min_seen_secret
1433         pub(super) fn get_secret(&self, idx: u64) -> Option<[u8; 32]> {
1434                 self.commitment_secrets.get_secret(idx)
1435         }
1436
1437         pub(super) fn get_min_seen_secret(&self) -> u64 {
1438                 self.commitment_secrets.get_min_seen_secret()
1439         }
1440
1441         pub(super) fn get_cur_remote_commitment_number(&self) -> u64 {
1442                 self.current_remote_commitment_number
1443         }
1444
1445         pub(super) fn get_cur_local_commitment_number(&self) -> u64 {
1446                 if let &Some(ref local_tx) = &self.current_local_signed_commitment_tx {
1447                         0xffff_ffff_ffff - ((((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)
1448                 } else { 0xffff_ffff_ffff }
1449         }
1450
1451         /// Attempts to claim a remote commitment transaction's outputs using the revocation key and
1452         /// data in remote_claimable_outpoints. Will directly claim any HTLC outputs which expire at a
1453         /// height > height + CLTV_SHARED_CLAIM_BUFFER. In any case, will install monitoring for
1454         /// HTLC-Success/HTLC-Timeout transactions.
1455         /// Return updates for HTLC pending in the channel and failed automatically by the broadcast of
1456         /// revoked remote commitment tx
1457         fn check_spend_remote_transaction(&mut self, tx: &Transaction, height: u32) -> (Vec<ClaimRequest>, (Sha256dHash, Vec<TxOut>), Vec<SpendableOutputDescriptor>) {
1458                 // Most secp and related errors trying to create keys means we have no hope of constructing
1459                 // a spend transaction...so we return no transactions to broadcast
1460                 let mut claimable_outpoints = Vec::new();
1461                 let mut watch_outputs = Vec::new();
1462                 let mut spendable_outputs = Vec::new();
1463
1464                 let commitment_txid = tx.txid(); //TODO: This is gonna be a performance bottleneck for watchtowers!
1465                 let per_commitment_option = self.remote_claimable_outpoints.get(&commitment_txid);
1466
1467                 macro_rules! ignore_error {
1468                         ( $thing : expr ) => {
1469                                 match $thing {
1470                                         Ok(a) => a,
1471                                         Err(_) => return (claimable_outpoints, (commitment_txid, watch_outputs), spendable_outputs)
1472                                 }
1473                         };
1474                 }
1475
1476                 let commitment_number = 0xffffffffffff - ((((tx.input[0].sequence as u64 & 0xffffff) << 3*8) | (tx.lock_time as u64 & 0xffffff)) ^ self.commitment_transaction_number_obscure_factor);
1477                 if commitment_number >= self.get_min_seen_secret() {
1478                         let secret = self.get_secret(commitment_number).unwrap();
1479                         let per_commitment_key = ignore_error!(SecretKey::from_slice(&secret));
1480                         let (revocation_pubkey, revocation_key, b_htlc_key, local_payment_key) = match self.key_storage {
1481                                 Storage::Local { ref keys, ref revocation_base_key, ref payment_base_key, .. } => {
1482                                         let per_commitment_point = PublicKey::from_secret_key(&self.secp_ctx, &per_commitment_key);
1483                                         (ignore_error!(chan_utils::derive_public_revocation_key(&self.secp_ctx, &per_commitment_point, &keys.pubkeys().revocation_basepoint)),
1484                                         ignore_error!(chan_utils::derive_private_revocation_key(&self.secp_ctx, &per_commitment_key, &revocation_base_key)),
1485                                         ignore_error!(chan_utils::derive_public_key(&self.secp_ctx, &per_commitment_point, &keys.pubkeys().htlc_basepoint)),
1486                                         Some(ignore_error!(chan_utils::derive_private_key(&self.secp_ctx, &per_commitment_point, &payment_base_key))))
1487                                 },
1488                                 Storage::Watchtower { .. } => {
1489                                         unimplemented!()
1490                                 },
1491                         };
1492                         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()));
1493                         let a_htlc_key = match self.their_htlc_base_key {
1494                                 None => return (claimable_outpoints, (commitment_txid, watch_outputs), spendable_outputs),
1495                                 Some(their_htlc_base_key) => ignore_error!(chan_utils::derive_public_key(&self.secp_ctx, &PublicKey::from_secret_key(&self.secp_ctx, &per_commitment_key), &their_htlc_base_key)),
1496                         };
1497
1498                         let revokeable_redeemscript = chan_utils::get_revokeable_redeemscript(&revocation_pubkey, self.our_to_self_delay, &delayed_key);
1499                         let revokeable_p2wsh = revokeable_redeemscript.to_v0_p2wsh();
1500
1501                         let local_payment_p2wpkh = if let Some(payment_key) = local_payment_key {
1502                                 // Note that the Network here is ignored as we immediately drop the address for the
1503                                 // script_pubkey version.
1504                                 let payment_hash160 = Hash160::hash(&PublicKey::from_secret_key(&self.secp_ctx, &payment_key).serialize());
1505                                 Some(Builder::new().push_opcode(opcodes::all::OP_PUSHBYTES_0).push_slice(&payment_hash160[..]).into_script())
1506                         } else { None };
1507
1508                         // First, process non-htlc outputs (to_local & to_remote)
1509                         for (idx, outp) in tx.output.iter().enumerate() {
1510                                 if outp.script_pubkey == revokeable_p2wsh {
1511                                         let witness_data = InputMaterial::Revoked { witness_script: revokeable_redeemscript.clone(), pubkey: Some(revocation_pubkey), key: revocation_key, is_htlc: false, amount: outp.value };
1512                                         claimable_outpoints.push(ClaimRequest { absolute_timelock: height + self.our_to_self_delay as u32, aggregable: true, outpoint: BitcoinOutPoint { txid: commitment_txid, vout: idx as u32 }, witness_data});
1513                                 } else if Some(&outp.script_pubkey) == local_payment_p2wpkh.as_ref() {
1514                                         spendable_outputs.push(SpendableOutputDescriptor::DynamicOutputP2WPKH {
1515                                                 outpoint: BitcoinOutPoint { txid: commitment_txid, vout: idx as u32 },
1516                                                 key: local_payment_key.unwrap(),
1517                                                 output: outp.clone(),
1518                                         });
1519                                 }
1520                         }
1521
1522                         // Then, try to find revoked htlc outputs
1523                         if let Some(ref per_commitment_data) = per_commitment_option {
1524                                 for (_, &(ref htlc, _)) in per_commitment_data.iter().enumerate() {
1525                                         if let Some(transaction_output_index) = htlc.transaction_output_index {
1526                                                 let expected_script = chan_utils::get_htlc_redeemscript_with_explicit_keys(&htlc, &a_htlc_key, &b_htlc_key, &revocation_pubkey);
1527                                                 if transaction_output_index as usize >= tx.output.len() ||
1528                                                                 tx.output[transaction_output_index as usize].value != htlc.amount_msat / 1000 ||
1529                                                                 tx.output[transaction_output_index as usize].script_pubkey != expected_script.to_v0_p2wsh() {
1530                                                         return (claimable_outpoints, (commitment_txid, watch_outputs), spendable_outputs); // Corrupted per_commitment_data, fuck this user
1531                                                 }
1532                                                 let witness_data = InputMaterial::Revoked { witness_script: expected_script, pubkey: Some(revocation_pubkey), key: revocation_key, is_htlc: true, amount: tx.output[transaction_output_index as usize].value };
1533                                                 claimable_outpoints.push(ClaimRequest { absolute_timelock: htlc.cltv_expiry, aggregable: true, outpoint: BitcoinOutPoint { txid: commitment_txid, vout: transaction_output_index }, witness_data });
1534                                         }
1535                                 }
1536                         }
1537
1538                         // Last, track onchain revoked commitment transaction and fail backward outgoing HTLCs as payment path is broken
1539                         if !claimable_outpoints.is_empty() || per_commitment_option.is_some() { // ie we're confident this is actually ours
1540                                 // We're definitely a remote commitment transaction!
1541                                 log_trace!(self, "Got broadcast of revoked remote commitment transaction, going to generate general spend tx with {} inputs", claimable_outpoints.len());
1542                                 watch_outputs.append(&mut tx.output.clone());
1543                                 self.remote_commitment_txn_on_chain.insert(commitment_txid, (commitment_number, tx.output.iter().map(|output| { output.script_pubkey.clone() }).collect()));
1544
1545                                 macro_rules! check_htlc_fails {
1546                                         ($txid: expr, $commitment_tx: expr) => {
1547                                                 if let Some(ref outpoints) = self.remote_claimable_outpoints.get($txid) {
1548                                                         for &(ref htlc, ref source_option) in outpoints.iter() {
1549                                                                 if let &Some(ref source) = source_option {
1550                                                                         log_info!(self, "Failing HTLC with payment_hash {} from {} remote commitment tx due to broadcast of revoked remote commitment transaction, waiting for confirmation (at height {})", log_bytes!(htlc.payment_hash.0), $commitment_tx, height + ANTI_REORG_DELAY - 1);
1551                                                                         match self.onchain_events_waiting_threshold_conf.entry(height + ANTI_REORG_DELAY - 1) {
1552                                                                                 hash_map::Entry::Occupied(mut entry) => {
1553                                                                                         let e = entry.get_mut();
1554                                                                                         e.retain(|ref event| {
1555                                                                                                 match **event {
1556                                                                                                         OnchainEvent::HTLCUpdate { ref htlc_update } => {
1557                                                                                                                 return htlc_update.0 != **source
1558                                                                                                         },
1559                                                                                                 }
1560                                                                                         });
1561                                                                                         e.push(OnchainEvent::HTLCUpdate { htlc_update: ((**source).clone(), htlc.payment_hash.clone())});
1562                                                                                 }
1563                                                                                 hash_map::Entry::Vacant(entry) => {
1564                                                                                         entry.insert(vec![OnchainEvent::HTLCUpdate { htlc_update: ((**source).clone(), htlc.payment_hash.clone())}]);
1565                                                                                 }
1566                                                                         }
1567                                                                 }
1568                                                         }
1569                                                 }
1570                                         }
1571                                 }
1572                                 if let Storage::Local { ref current_remote_commitment_txid, ref prev_remote_commitment_txid, .. } = self.key_storage {
1573                                         if let &Some(ref txid) = current_remote_commitment_txid {
1574                                                 check_htlc_fails!(txid, "current");
1575                                         }
1576                                         if let &Some(ref txid) = prev_remote_commitment_txid {
1577                                                 check_htlc_fails!(txid, "remote");
1578                                         }
1579                                 }
1580                                 // No need to check local commitment txn, symmetric HTLCSource must be present as per-htlc data on remote commitment tx
1581                         }
1582                 } else if let Some(per_commitment_data) = per_commitment_option {
1583                         // While this isn't useful yet, there is a potential race where if a counterparty
1584                         // revokes a state at the same time as the commitment transaction for that state is
1585                         // confirmed, and the watchtower receives the block before the user, the user could
1586                         // upload a new ChannelMonitor with the revocation secret but the watchtower has
1587                         // already processed the block, resulting in the remote_commitment_txn_on_chain entry
1588                         // not being generated by the above conditional. Thus, to be safe, we go ahead and
1589                         // insert it here.
1590                         watch_outputs.append(&mut tx.output.clone());
1591                         self.remote_commitment_txn_on_chain.insert(commitment_txid, (commitment_number, tx.output.iter().map(|output| { output.script_pubkey.clone() }).collect()));
1592
1593                         log_trace!(self, "Got broadcast of non-revoked remote commitment transaction {}", commitment_txid);
1594
1595                         macro_rules! check_htlc_fails {
1596                                 ($txid: expr, $commitment_tx: expr, $id: tt) => {
1597                                         if let Some(ref latest_outpoints) = self.remote_claimable_outpoints.get($txid) {
1598                                                 $id: for &(ref htlc, ref source_option) in latest_outpoints.iter() {
1599                                                         if let &Some(ref source) = source_option {
1600                                                                 // Check if the HTLC is present in the commitment transaction that was
1601                                                                 // broadcast, but not if it was below the dust limit, which we should
1602                                                                 // fail backwards immediately as there is no way for us to learn the
1603                                                                 // payment_preimage.
1604                                                                 // Note that if the dust limit were allowed to change between
1605                                                                 // commitment transactions we'd want to be check whether *any*
1606                                                                 // broadcastable commitment transaction has the HTLC in it, but it
1607                                                                 // cannot currently change after channel initialization, so we don't
1608                                                                 // need to here.
1609                                                                 for &(ref broadcast_htlc, ref broadcast_source) in per_commitment_data.iter() {
1610                                                                         if broadcast_htlc.transaction_output_index.is_some() && Some(source) == broadcast_source.as_ref() {
1611                                                                                 continue $id;
1612                                                                         }
1613                                                                 }
1614                                                                 log_trace!(self, "Failing HTLC with payment_hash {} from {} remote commitment tx due to broadcast of remote commitment transaction", log_bytes!(htlc.payment_hash.0), $commitment_tx);
1615                                                                 match self.onchain_events_waiting_threshold_conf.entry(height + ANTI_REORG_DELAY - 1) {
1616                                                                         hash_map::Entry::Occupied(mut entry) => {
1617                                                                                 let e = entry.get_mut();
1618                                                                                 e.retain(|ref event| {
1619                                                                                         match **event {
1620                                                                                                 OnchainEvent::HTLCUpdate { ref htlc_update } => {
1621                                                                                                         return htlc_update.0 != **source
1622                                                                                                 },
1623                                                                                         }
1624                                                                                 });
1625                                                                                 e.push(OnchainEvent::HTLCUpdate { htlc_update: ((**source).clone(), htlc.payment_hash.clone())});
1626                                                                         }
1627                                                                         hash_map::Entry::Vacant(entry) => {
1628                                                                                 entry.insert(vec![OnchainEvent::HTLCUpdate { htlc_update: ((**source).clone(), htlc.payment_hash.clone())}]);
1629                                                                         }
1630                                                                 }
1631                                                         }
1632                                                 }
1633                                         }
1634                                 }
1635                         }
1636                         if let Storage::Local { ref current_remote_commitment_txid, ref prev_remote_commitment_txid, .. } = self.key_storage {
1637                                 if let &Some(ref txid) = current_remote_commitment_txid {
1638                                         check_htlc_fails!(txid, "current", 'current_loop);
1639                                 }
1640                                 if let &Some(ref txid) = prev_remote_commitment_txid {
1641                                         check_htlc_fails!(txid, "previous", 'prev_loop);
1642                                 }
1643                         }
1644
1645                         if let Some(revocation_points) = self.their_cur_revocation_points {
1646                                 let revocation_point_option =
1647                                         if revocation_points.0 == commitment_number { Some(&revocation_points.1) }
1648                                         else if let Some(point) = revocation_points.2.as_ref() {
1649                                                 if revocation_points.0 == commitment_number + 1 { Some(point) } else { None }
1650                                         } else { None };
1651                                 if let Some(revocation_point) = revocation_point_option {
1652                                         let (revocation_pubkey, b_htlc_key, htlc_privkey) = match self.key_storage {
1653                                                 Storage::Local { ref keys, ref htlc_base_key, .. } => {
1654                                                         (ignore_error!(chan_utils::derive_public_revocation_key(&self.secp_ctx, revocation_point, &keys.pubkeys().revocation_basepoint)),
1655                                                         ignore_error!(chan_utils::derive_public_key(&self.secp_ctx, revocation_point, &keys.pubkeys().htlc_basepoint)),
1656                                                         ignore_error!(chan_utils::derive_private_key(&self.secp_ctx, revocation_point, &htlc_base_key)))
1657                                                 },
1658                                                 Storage::Watchtower { .. } => { unimplemented!() }
1659                                         };
1660                                         let a_htlc_key = match self.their_htlc_base_key {
1661                                                 None => return (claimable_outpoints, (commitment_txid, watch_outputs), spendable_outputs),
1662                                                 Some(their_htlc_base_key) => ignore_error!(chan_utils::derive_public_key(&self.secp_ctx, revocation_point, &their_htlc_base_key)),
1663                                         };
1664
1665                                         // First, mark as spendable our to_remote output
1666                                         for (idx, outp) in tx.output.iter().enumerate() {
1667                                                 if outp.script_pubkey.is_v0_p2wpkh() {
1668                                                         match self.key_storage {
1669                                                                 Storage::Local { ref payment_base_key, .. } => {
1670                                                                         if let Ok(local_key) = chan_utils::derive_private_key(&self.secp_ctx, &revocation_point, &payment_base_key) {
1671                                                                                 spendable_outputs.push(SpendableOutputDescriptor::DynamicOutputP2WPKH {
1672                                                                                         outpoint: BitcoinOutPoint { txid: commitment_txid, vout: idx as u32 },
1673                                                                                         key: local_key,
1674                                                                                         output: outp.clone(),
1675                                                                                 });
1676                                                                         }
1677                                                                 },
1678                                                                 Storage::Watchtower { .. } => {}
1679                                                         }
1680                                                         break; // Only to_remote ouput is claimable
1681                                                 }
1682                                         }
1683
1684                                         // Then, try to find htlc outputs
1685                                         for (_, &(ref htlc, _)) in per_commitment_data.iter().enumerate() {
1686                                                 if let Some(transaction_output_index) = htlc.transaction_output_index {
1687                                                         let expected_script = chan_utils::get_htlc_redeemscript_with_explicit_keys(&htlc, &a_htlc_key, &b_htlc_key, &revocation_pubkey);
1688                                                         if transaction_output_index as usize >= tx.output.len() ||
1689                                                                         tx.output[transaction_output_index as usize].value != htlc.amount_msat / 1000 ||
1690                                                                         tx.output[transaction_output_index as usize].script_pubkey != expected_script.to_v0_p2wsh() {
1691                                                                 return (claimable_outpoints, (commitment_txid, watch_outputs), spendable_outputs); // Corrupted per_commitment_data, fuck this user
1692                                                         }
1693                                                         let preimage = if htlc.offered { if let Some(p) = self.payment_preimages.get(&htlc.payment_hash) { Some(*p) } else { None } } else { None };
1694                                                         let aggregable = if !htlc.offered { false } else { true };
1695                                                         if preimage.is_some() || !htlc.offered {
1696                                                                 let witness_data = InputMaterial::RemoteHTLC { witness_script: expected_script, key: htlc_privkey, preimage, amount: htlc.amount_msat / 1000, locktime: htlc.cltv_expiry };
1697                                                                 claimable_outpoints.push(ClaimRequest { absolute_timelock: htlc.cltv_expiry, aggregable, outpoint: BitcoinOutPoint { txid: commitment_txid, vout: transaction_output_index }, witness_data });
1698                                                         }
1699                                                 }
1700                                         }
1701                                 }
1702                         }
1703                 } else if let Some((ref to_remote_rescue, ref local_key)) = self.to_remote_rescue {
1704                         for (idx, outp) in tx.output.iter().enumerate() {
1705                                 if to_remote_rescue == &outp.script_pubkey {
1706                                         spendable_outputs.push(SpendableOutputDescriptor::DynamicOutputP2WPKH {
1707                                                 outpoint: BitcoinOutPoint { txid: commitment_txid, vout: idx as u32 },
1708                                                 key: local_key.clone(),
1709                                                 output: outp.clone(),
1710                                         });
1711                                 }
1712                         }
1713                 }
1714                 (claimable_outpoints, (commitment_txid, watch_outputs), spendable_outputs)
1715         }
1716
1717         /// Attempts to claim a remote HTLC-Success/HTLC-Timeout's outputs using the revocation key
1718         fn check_spend_remote_htlc(&mut self, tx: &Transaction, commitment_number: u64, height: u32) -> (Vec<ClaimRequest>, Option<(Sha256dHash, Vec<TxOut>)>) {
1719                 let htlc_txid = tx.txid();
1720                 if tx.input.len() != 1 || tx.output.len() != 1 || tx.input[0].witness.len() != 5 {
1721                         return (Vec::new(), None)
1722                 }
1723
1724                 macro_rules! ignore_error {
1725                         ( $thing : expr ) => {
1726                                 match $thing {
1727                                         Ok(a) => a,
1728                                         Err(_) => return (Vec::new(), None)
1729                                 }
1730                         };
1731                 }
1732
1733                 let secret = if let Some(secret) = self.get_secret(commitment_number) { secret } else { return (Vec::new(), None); };
1734                 let per_commitment_key = ignore_error!(SecretKey::from_slice(&secret));
1735                 let per_commitment_point = PublicKey::from_secret_key(&self.secp_ctx, &per_commitment_key);
1736                 let (revocation_pubkey, revocation_key) = match self.key_storage {
1737                         Storage::Local { ref keys, ref revocation_base_key, .. } => {
1738                                 (ignore_error!(chan_utils::derive_public_revocation_key(&self.secp_ctx, &per_commitment_point, &keys.pubkeys().revocation_basepoint)),
1739                                 ignore_error!(chan_utils::derive_private_revocation_key(&self.secp_ctx, &per_commitment_key, revocation_base_key)))
1740                         },
1741                         Storage::Watchtower { .. } => { unimplemented!() }
1742                 };
1743                 let delayed_key = match self.their_delayed_payment_base_key {
1744                         None => return (Vec::new(), None),
1745                         Some(their_delayed_payment_base_key) => ignore_error!(chan_utils::derive_public_key(&self.secp_ctx, &per_commitment_point, &their_delayed_payment_base_key)),
1746                 };
1747                 let redeemscript = chan_utils::get_revokeable_redeemscript(&revocation_pubkey, self.our_to_self_delay, &delayed_key);
1748
1749                 log_trace!(self, "Remote HTLC broadcast {}:{}", htlc_txid, 0);
1750                 let witness_data = InputMaterial::Revoked { witness_script: redeemscript, pubkey: Some(revocation_pubkey), key: revocation_key, is_htlc: false, amount: tx.output[0].value };
1751                 let claimable_outpoints = vec!(ClaimRequest { absolute_timelock: height + self.our_to_self_delay as u32, aggregable: true, outpoint: BitcoinOutPoint { txid: htlc_txid, vout: 0}, witness_data });
1752                 (claimable_outpoints, Some((htlc_txid, tx.output.clone())))
1753         }
1754
1755         fn broadcast_by_local_state(&self, local_tx: &LocalSignedTx, delayed_payment_base_key: &SecretKey) -> (Vec<Transaction>, Vec<SpendableOutputDescriptor>, Vec<TxOut>) {
1756                 let mut res = Vec::with_capacity(local_tx.htlc_outputs.len());
1757                 let mut spendable_outputs = Vec::with_capacity(local_tx.htlc_outputs.len());
1758                 let mut watch_outputs = Vec::with_capacity(local_tx.htlc_outputs.len());
1759
1760                 macro_rules! add_dynamic_output {
1761                         ($father_tx: expr, $vout: expr) => {
1762                                 if let Ok(local_delayedkey) = chan_utils::derive_private_key(&self.secp_ctx, &local_tx.per_commitment_point, delayed_payment_base_key) {
1763                                         spendable_outputs.push(SpendableOutputDescriptor::DynamicOutputP2WSH {
1764                                                 outpoint: BitcoinOutPoint { txid: $father_tx.txid(), vout: $vout },
1765                                                 key: local_delayedkey,
1766                                                 witness_script: chan_utils::get_revokeable_redeemscript(&local_tx.revocation_key, self.our_to_self_delay, &local_tx.delayed_payment_key),
1767                                                 to_self_delay: self.our_to_self_delay,
1768                                                 output: $father_tx.output[$vout as usize].clone(),
1769                                         });
1770                                 }
1771                         }
1772                 }
1773
1774                 let redeemscript = chan_utils::get_revokeable_redeemscript(&local_tx.revocation_key, self.their_to_self_delay.unwrap(), &local_tx.delayed_payment_key);
1775                 let revokeable_p2wsh = redeemscript.to_v0_p2wsh();
1776                 for (idx, output) in local_tx.tx.without_valid_witness().output.iter().enumerate() {
1777                         if output.script_pubkey == revokeable_p2wsh {
1778                                 add_dynamic_output!(local_tx.tx.without_valid_witness(), idx as u32);
1779                                 break;
1780                         }
1781                 }
1782
1783                 if let &Storage::Local { ref htlc_base_key, .. } = &self.key_storage {
1784                         for &(ref htlc, ref sigs, _) in local_tx.htlc_outputs.iter() {
1785                                 if let Some(transaction_output_index) = htlc.transaction_output_index {
1786                                         if let &Some(ref their_sig) = sigs {
1787                                                 if htlc.offered {
1788                                                         log_trace!(self, "Broadcasting HTLC-Timeout transaction against local commitment transactions");
1789                                                         let mut htlc_timeout_tx = chan_utils::build_htlc_transaction(&local_tx.txid, local_tx.feerate_per_kw, self.their_to_self_delay.unwrap(), htlc, &local_tx.delayed_payment_key, &local_tx.revocation_key);
1790                                                         let (our_sig, htlc_script) = match
1791                                                                         chan_utils::sign_htlc_transaction(&mut htlc_timeout_tx, their_sig, &None, htlc, &local_tx.a_htlc_key, &local_tx.b_htlc_key, &local_tx.revocation_key, &local_tx.per_commitment_point, htlc_base_key, &self.secp_ctx) {
1792                                                                 Ok(res) => res,
1793                                                                 Err(_) => continue,
1794                                                         };
1795
1796                                                         add_dynamic_output!(htlc_timeout_tx, 0);
1797                                                         let mut per_input_material = HashMap::with_capacity(1);
1798                                                         per_input_material.insert(htlc_timeout_tx.input[0].previous_output, InputMaterial::LocalHTLC { witness_script: htlc_script, sigs: (*their_sig, our_sig), preimage: None, amount: htlc.amount_msat / 1000});
1799                                                         //TODO: with option_simplified_commitment track outpoint too
1800                                                         log_trace!(self, "Outpoint {}:{} is being being claimed", htlc_timeout_tx.input[0].previous_output.vout, htlc_timeout_tx.input[0].previous_output.txid);
1801                                                         res.push(htlc_timeout_tx);
1802                                                 } else {
1803                                                         if let Some(payment_preimage) = self.payment_preimages.get(&htlc.payment_hash) {
1804                                                                 log_trace!(self, "Broadcasting HTLC-Success transaction against local commitment transactions");
1805                                                                 let mut htlc_success_tx = chan_utils::build_htlc_transaction(&local_tx.txid, local_tx.feerate_per_kw, self.their_to_self_delay.unwrap(), htlc, &local_tx.delayed_payment_key, &local_tx.revocation_key);
1806                                                                 let (our_sig, htlc_script) = match
1807                                                                                 chan_utils::sign_htlc_transaction(&mut htlc_success_tx, their_sig, &Some(*payment_preimage), htlc, &local_tx.a_htlc_key, &local_tx.b_htlc_key, &local_tx.revocation_key, &local_tx.per_commitment_point, htlc_base_key, &self.secp_ctx) {
1808                                                                         Ok(res) => res,
1809                                                                         Err(_) => continue,
1810                                                                 };
1811
1812                                                                 add_dynamic_output!(htlc_success_tx, 0);
1813                                                                 let mut per_input_material = HashMap::with_capacity(1);
1814                                                                 per_input_material.insert(htlc_success_tx.input[0].previous_output, InputMaterial::LocalHTLC { witness_script: htlc_script, sigs: (*their_sig, our_sig), preimage: Some(*payment_preimage), amount: htlc.amount_msat / 1000});
1815                                                                 //TODO: with option_simplified_commitment track outpoint too
1816                                                                 log_trace!(self, "Outpoint {}:{} is being being claimed", htlc_success_tx.input[0].previous_output.vout, htlc_success_tx.input[0].previous_output.txid);
1817                                                                 res.push(htlc_success_tx);
1818                                                         }
1819                                                 }
1820                                                 watch_outputs.push(local_tx.tx.without_valid_witness().output[transaction_output_index as usize].clone());
1821                                         } else { panic!("Should have sigs for non-dust local tx outputs!") }
1822                                 }
1823                         }
1824                 }
1825
1826                 (res, spendable_outputs, watch_outputs)
1827         }
1828
1829         /// Attempts to claim any claimable HTLCs in a commitment transaction which was not (yet)
1830         /// revoked using data in local_claimable_outpoints.
1831         /// Should not be used if check_spend_revoked_transaction succeeds.
1832         fn check_spend_local_transaction(&mut self, tx: &Transaction, height: u32) -> (Vec<Transaction>, Vec<SpendableOutputDescriptor>, (Sha256dHash, Vec<TxOut>)) {
1833                 let commitment_txid = tx.txid();
1834                 let mut local_txn = Vec::new();
1835                 let mut spendable_outputs = Vec::new();
1836                 let mut watch_outputs = Vec::new();
1837
1838                 macro_rules! wait_threshold_conf {
1839                         ($height: expr, $source: expr, $commitment_tx: expr, $payment_hash: expr) => {
1840                                 log_trace!(self, "Failing HTLC with payment_hash {} from {} local commitment tx due to broadcast of transaction, waiting confirmation (at height{})", log_bytes!($payment_hash.0), $commitment_tx, height + ANTI_REORG_DELAY - 1);
1841                                 match self.onchain_events_waiting_threshold_conf.entry($height + ANTI_REORG_DELAY - 1) {
1842                                         hash_map::Entry::Occupied(mut entry) => {
1843                                                 let e = entry.get_mut();
1844                                                 e.retain(|ref event| {
1845                                                         match **event {
1846                                                                 OnchainEvent::HTLCUpdate { ref htlc_update } => {
1847                                                                         return htlc_update.0 != $source
1848                                                                 },
1849                                                         }
1850                                                 });
1851                                                 e.push(OnchainEvent::HTLCUpdate { htlc_update: ($source, $payment_hash)});
1852                                         }
1853                                         hash_map::Entry::Vacant(entry) => {
1854                                                 entry.insert(vec![OnchainEvent::HTLCUpdate { htlc_update: ($source, $payment_hash)}]);
1855                                         }
1856                                 }
1857                         }
1858                 }
1859
1860                 macro_rules! append_onchain_update {
1861                         ($updates: expr) => {
1862                                 local_txn.append(&mut $updates.0);
1863                                 spendable_outputs.append(&mut $updates.1);
1864                                 watch_outputs.append(&mut $updates.2);
1865                         }
1866                 }
1867
1868                 // HTLCs set may differ between last and previous local commitment txn, in case of one them hitting chain, ensure we cancel all HTLCs backward
1869                 let mut is_local_tx = false;
1870
1871                 if let &mut Some(ref mut local_tx) = &mut self.current_local_signed_commitment_tx {
1872                         if local_tx.txid == commitment_txid {
1873                                 match self.key_storage {
1874                                         Storage::Local { ref funding_key, .. } => {
1875                                                 local_tx.tx.add_local_sig(funding_key, self.funding_redeemscript.as_ref().unwrap(), self.channel_value_satoshis.unwrap(), &self.secp_ctx);
1876                                         },
1877                                         _ => {},
1878                                 }
1879                         }
1880                 }
1881                 if let &Some(ref local_tx) = &self.current_local_signed_commitment_tx {
1882                         if local_tx.txid == commitment_txid {
1883                                 is_local_tx = true;
1884                                 log_trace!(self, "Got latest local commitment tx broadcast, searching for available HTLCs to claim");
1885                                 assert!(local_tx.tx.has_local_sig());
1886                                 match self.key_storage {
1887                                         Storage::Local { ref delayed_payment_base_key, .. } => {
1888                                                 let mut res = self.broadcast_by_local_state(local_tx, delayed_payment_base_key);
1889                                                 append_onchain_update!(res);
1890                                         },
1891                                         Storage::Watchtower { .. } => { }
1892                                 }
1893                         }
1894                 }
1895                 if let &mut Some(ref mut local_tx) = &mut self.prev_local_signed_commitment_tx {
1896                         if local_tx.txid == commitment_txid {
1897                                 match self.key_storage {
1898                                         Storage::Local { ref funding_key, .. } => {
1899                                                 local_tx.tx.add_local_sig(funding_key, self.funding_redeemscript.as_ref().unwrap(), self.channel_value_satoshis.unwrap(), &self.secp_ctx);
1900                                         },
1901                                         _ => {},
1902                                 }
1903                         }
1904                 }
1905                 if let &Some(ref local_tx) = &self.prev_local_signed_commitment_tx {
1906                         if local_tx.txid == commitment_txid {
1907                                 is_local_tx = true;
1908                                 log_trace!(self, "Got previous local commitment tx broadcast, searching for available HTLCs to claim");
1909                                 assert!(local_tx.tx.has_local_sig());
1910                                 match self.key_storage {
1911                                         Storage::Local { ref delayed_payment_base_key, .. } => {
1912                                                 let mut res = self.broadcast_by_local_state(local_tx, delayed_payment_base_key);
1913                                                 append_onchain_update!(res);
1914                                         },
1915                                         Storage::Watchtower { .. } => { }
1916                                 }
1917                         }
1918                 }
1919
1920                 macro_rules! fail_dust_htlcs_after_threshold_conf {
1921                         ($local_tx: expr) => {
1922                                 for &(ref htlc, _, ref source) in &$local_tx.htlc_outputs {
1923                                         if htlc.transaction_output_index.is_none() {
1924                                                 if let &Some(ref source) = source {
1925                                                         wait_threshold_conf!(height, source.clone(), "lastest", htlc.payment_hash.clone());
1926                                                 }
1927                                         }
1928                                 }
1929                         }
1930                 }
1931
1932                 if is_local_tx {
1933                         if let &Some(ref local_tx) = &self.current_local_signed_commitment_tx {
1934                                 fail_dust_htlcs_after_threshold_conf!(local_tx);
1935                         }
1936                         if let &Some(ref local_tx) = &self.prev_local_signed_commitment_tx {
1937                                 fail_dust_htlcs_after_threshold_conf!(local_tx);
1938                         }
1939                 }
1940
1941                 (local_txn, spendable_outputs, (commitment_txid, watch_outputs))
1942         }
1943
1944         /// Generate a spendable output event when closing_transaction get registered onchain.
1945         fn check_spend_closing_transaction(&self, tx: &Transaction) -> Option<SpendableOutputDescriptor> {
1946                 if tx.input[0].sequence == 0xFFFFFFFF && !tx.input[0].witness.is_empty() && tx.input[0].witness.last().unwrap().len() == 71 {
1947                         match self.key_storage {
1948                                 Storage::Local { ref shutdown_pubkey, .. } =>  {
1949                                         let our_channel_close_key_hash = Hash160::hash(&shutdown_pubkey.serialize());
1950                                         let shutdown_script = Builder::new().push_opcode(opcodes::all::OP_PUSHBYTES_0).push_slice(&our_channel_close_key_hash[..]).into_script();
1951                                         for (idx, output) in tx.output.iter().enumerate() {
1952                                                 if shutdown_script == output.script_pubkey {
1953                                                         return Some(SpendableOutputDescriptor::StaticOutput {
1954                                                                 outpoint: BitcoinOutPoint { txid: tx.txid(), vout: idx as u32 },
1955                                                                 output: output.clone(),
1956                                                         });
1957                                                 }
1958                                         }
1959                                 }
1960                                 Storage::Watchtower { .. } => {
1961                                         //TODO: we need to ensure an offline client will generate the event when it
1962                                         // comes back online after only the watchtower saw the transaction
1963                                 }
1964                         }
1965                 }
1966                 None
1967         }
1968
1969         /// Used by ChannelManager deserialization to broadcast the latest local state if its copy of
1970         /// the Channel was out-of-date. You may use it to get a broadcastable local toxic tx in case of
1971         /// fallen-behind, i.e when receiving a channel_reestablish with a proof that our remote side knows
1972         /// a higher revocation secret than the local commitment number we are aware of. Broadcasting these
1973         /// transactions are UNSAFE, as they allow remote side to punish you. Nevertheless you may want to
1974         /// broadcast them if remote don't close channel with his higher commitment transaction after a
1975         /// substantial amount of time (a month or even a year) to get back funds. Best may be to contact
1976         /// out-of-band the other node operator to coordinate with him if option is available to you.
1977         /// In any-case, choice is up to the user.
1978         pub fn get_latest_local_commitment_txn(&mut self) -> Vec<Transaction> {
1979                 // TODO: We should likely move all of the logic in here into OnChainTxHandler and unify it
1980                 // to ensure add_local_sig is only ever called once no matter what. This likely includes
1981                 // tracking state and panic!()ing if we get an update after force-closure/local-tx signing.
1982                 log_trace!(self, "Getting signed latest local commitment transaction!");
1983                 if let &mut Some(ref mut local_tx) = &mut self.current_local_signed_commitment_tx {
1984                         match self.key_storage {
1985                                 Storage::Local { ref funding_key, .. } => {
1986                                         local_tx.tx.add_local_sig(funding_key, self.funding_redeemscript.as_ref().unwrap(), self.channel_value_satoshis.unwrap(), &self.secp_ctx);
1987                                 },
1988                                 _ => {},
1989                         }
1990                 }
1991                 if let &Some(ref local_tx) = &self.current_local_signed_commitment_tx {
1992                         let mut res = vec![local_tx.tx.with_valid_witness().clone()];
1993                         match self.key_storage {
1994                                 Storage::Local { ref delayed_payment_base_key, .. } => {
1995                                         res.append(&mut self.broadcast_by_local_state(local_tx, delayed_payment_base_key).0);
1996                                         // We throw away the generated waiting_first_conf data as we aren't (yet) confirmed and we don't actually know what the caller wants to do.
1997                                         // The data will be re-generated and tracked in check_spend_local_transaction if we get a confirmation.
1998                                 },
1999                                 _ => panic!("Can only broadcast by local channelmonitor"),
2000                         };
2001                         res
2002                 } else {
2003                         Vec::new()
2004                 }
2005         }
2006
2007         /// Called by SimpleManyChannelMonitor::block_connected, which implements
2008         /// ChainListener::block_connected.
2009         /// Eventually this should be pub and, roughly, implement ChainListener, however this requires
2010         /// &mut self, as well as returns new spendable outputs and outpoints to watch for spending of
2011         /// on-chain.
2012         fn block_connected<B: Deref, F: Deref>(&mut self, txn_matched: &[&Transaction], height: u32, block_hash: &Sha256dHash, broadcaster: B, fee_estimator: F)-> Vec<(Sha256dHash, Vec<TxOut>)>
2013                 where B::Target: BroadcasterInterface,
2014                       F::Target: FeeEstimator
2015         {
2016                 for tx in txn_matched {
2017                         let mut output_val = 0;
2018                         for out in tx.output.iter() {
2019                                 if out.value > 21_000_000_0000_0000 { panic!("Value-overflowing transaction provided to block connected"); }
2020                                 output_val += out.value;
2021                                 if output_val > 21_000_000_0000_0000 { panic!("Value-overflowing transaction provided to block connected"); }
2022                         }
2023                 }
2024
2025                 log_trace!(self, "Block {} at height {} connected with {} txn matched", block_hash, height, txn_matched.len());
2026                 let mut watch_outputs = Vec::new();
2027                 let mut spendable_outputs = Vec::new();
2028                 let mut claimable_outpoints = Vec::new();
2029                 for tx in txn_matched {
2030                         if tx.input.len() == 1 {
2031                                 // Assuming our keys were not leaked (in which case we're screwed no matter what),
2032                                 // commitment transactions and HTLC transactions will all only ever have one input,
2033                                 // which is an easy way to filter out any potential non-matching txn for lazy
2034                                 // filters.
2035                                 let prevout = &tx.input[0].previous_output;
2036                                 let funding_txo = match self.key_storage {
2037                                         Storage::Local { ref funding_info, .. } => {
2038                                                 funding_info.clone()
2039                                         }
2040                                         Storage::Watchtower { .. } => {
2041                                                 unimplemented!();
2042                                         }
2043                                 };
2044                                 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) {
2045                                         if (tx.input[0].sequence >> 8*3) as u8 == 0x80 && (tx.lock_time >> 8*3) as u8 == 0x20 {
2046                                                 let (mut new_outpoints, new_outputs, mut spendable_output) = self.check_spend_remote_transaction(&tx, height);
2047                                                 spendable_outputs.append(&mut spendable_output);
2048                                                 if !new_outputs.1.is_empty() {
2049                                                         watch_outputs.push(new_outputs);
2050                                                 }
2051                                                 if new_outpoints.is_empty() {
2052                                                         let (local_txn, mut spendable_output, new_outputs) = self.check_spend_local_transaction(&tx, height);
2053                                                         spendable_outputs.append(&mut spendable_output);
2054                                                         for tx in local_txn.iter() {
2055                                                                 log_trace!(self, "Broadcast onchain {}", log_tx!(tx));
2056                                                                 broadcaster.broadcast_transaction(tx);
2057                                                         }
2058                                                         if !new_outputs.1.is_empty() {
2059                                                                 watch_outputs.push(new_outputs);
2060                                                         }
2061                                                 }
2062                                                 claimable_outpoints.append(&mut new_outpoints);
2063                                         }
2064                                         if !funding_txo.is_none() && claimable_outpoints.is_empty() {
2065                                                 if let Some(spendable_output) = self.check_spend_closing_transaction(&tx) {
2066                                                         spendable_outputs.push(spendable_output);
2067                                                 }
2068                                         }
2069                                 } else {
2070                                         if let Some(&(commitment_number, _)) = self.remote_commitment_txn_on_chain.get(&prevout.txid) {
2071                                                 let (mut new_outpoints, new_outputs_option) = self.check_spend_remote_htlc(&tx, commitment_number, height);
2072                                                 claimable_outpoints.append(&mut new_outpoints);
2073                                                 if let Some(new_outputs) = new_outputs_option {
2074                                                         watch_outputs.push(new_outputs);
2075                                                 }
2076                                         }
2077                                 }
2078                         }
2079                         // While all commitment/HTLC-Success/HTLC-Timeout transactions have one input, HTLCs
2080                         // can also be resolved in a few other ways which can have more than one output. Thus,
2081                         // we call is_resolving_htlc_output here outside of the tx.input.len() == 1 check.
2082                         self.is_resolving_htlc_output(&tx, height);
2083
2084                         if let Some(spendable_output) = self.is_paying_spendable_output(&tx) {
2085                                 spendable_outputs.push(spendable_output);
2086                         }
2087                 }
2088                 let should_broadcast = if let Some(_) = self.current_local_signed_commitment_tx {
2089                         self.would_broadcast_at_height(height)
2090                 } else { false };
2091                 if let Some(ref mut cur_local_tx) = self.current_local_signed_commitment_tx {
2092                         if should_broadcast {
2093                                 match self.key_storage {
2094                                         Storage::Local { ref funding_key, .. } => {
2095                                                 cur_local_tx.tx.add_local_sig(funding_key, self.funding_redeemscript.as_ref().unwrap(), self.channel_value_satoshis.unwrap(), &self.secp_ctx);
2096                                         },
2097                                         _ => {}
2098                                 }
2099                         }
2100                 }
2101                 if let Some(ref cur_local_tx) = self.current_local_signed_commitment_tx {
2102                         if should_broadcast {
2103                                 log_trace!(self, "Broadcast onchain {}", log_tx!(cur_local_tx.tx.with_valid_witness()));
2104                                 broadcaster.broadcast_transaction(&cur_local_tx.tx.with_valid_witness());
2105                                 match self.key_storage {
2106                                         Storage::Local { ref delayed_payment_base_key, .. } => {
2107                                                 let (txs, mut spendable_output, new_outputs) = self.broadcast_by_local_state(&cur_local_tx, delayed_payment_base_key);
2108                                                 spendable_outputs.append(&mut spendable_output);
2109                                                 if !new_outputs.is_empty() {
2110                                                         watch_outputs.push((cur_local_tx.txid.clone(), new_outputs));
2111                                                 }
2112                                                 for tx in txs {
2113                                                         log_trace!(self, "Broadcast onchain {}", log_tx!(tx));
2114                                                         broadcaster.broadcast_transaction(&tx);
2115                                                 }
2116                                         },
2117                                         Storage::Watchtower { .. } => { },
2118                                 }
2119                         }
2120                 }
2121                 if let Some(events) = self.onchain_events_waiting_threshold_conf.remove(&height) {
2122                         for ev in events {
2123                                 match ev {
2124                                         OnchainEvent::HTLCUpdate { htlc_update } => {
2125                                                 log_trace!(self, "HTLC {} failure update has got enough confirmations to be passed upstream", log_bytes!((htlc_update.1).0));
2126                                                 self.pending_htlcs_updated.push(HTLCUpdate {
2127                                                         payment_hash: htlc_update.1,
2128                                                         payment_preimage: None,
2129                                                         source: htlc_update.0,
2130                                                 });
2131                                         },
2132                                 }
2133                         }
2134                 }
2135                 self.onchain_tx_handler.block_connected(txn_matched, claimable_outpoints, height, &*broadcaster, &*fee_estimator);
2136
2137                 self.last_block_hash = block_hash.clone();
2138                 for &(ref txid, ref output_scripts) in watch_outputs.iter() {
2139                         self.outputs_to_watch.insert(txid.clone(), output_scripts.iter().map(|o| o.script_pubkey.clone()).collect());
2140                 }
2141
2142                 for spend in spendable_outputs.iter() {
2143                         log_trace!(self, "Announcing spendable output to user: {}", log_spendable!(spend));
2144                 }
2145
2146                 if spendable_outputs.len() > 0 {
2147                         self.pending_events.push(events::Event::SpendableOutputs {
2148                                 outputs: spendable_outputs,
2149                         });
2150                 }
2151
2152                 watch_outputs
2153         }
2154
2155         fn block_disconnected<B: Deref, F: Deref>(&mut self, height: u32, block_hash: &Sha256dHash, broadcaster: B, fee_estimator: F)
2156                 where B::Target: BroadcasterInterface,
2157                       F::Target: FeeEstimator
2158         {
2159                 log_trace!(self, "Block {} at height {} disconnected", block_hash, height);
2160                 if let Some(_) = self.onchain_events_waiting_threshold_conf.remove(&(height + ANTI_REORG_DELAY - 1)) {
2161                         //We may discard:
2162                         //- htlc update there as failure-trigger tx (revoked commitment tx, non-revoked commitment tx, HTLC-timeout tx) has been disconnected
2163                 }
2164
2165                 self.onchain_tx_handler.block_disconnected(height, broadcaster, fee_estimator);
2166
2167                 self.last_block_hash = block_hash.clone();
2168         }
2169
2170         pub(super) fn would_broadcast_at_height(&self, height: u32) -> bool {
2171                 // We need to consider all HTLCs which are:
2172                 //  * in any unrevoked remote commitment transaction, as they could broadcast said
2173                 //    transactions and we'd end up in a race, or
2174                 //  * are in our latest local commitment transaction, as this is the thing we will
2175                 //    broadcast if we go on-chain.
2176                 // Note that we consider HTLCs which were below dust threshold here - while they don't
2177                 // strictly imply that we need to fail the channel, we need to go ahead and fail them back
2178                 // to the source, and if we don't fail the channel we will have to ensure that the next
2179                 // updates that peer sends us are update_fails, failing the channel if not. It's probably
2180                 // easier to just fail the channel as this case should be rare enough anyway.
2181                 macro_rules! scan_commitment {
2182                         ($htlcs: expr, $local_tx: expr) => {
2183                                 for ref htlc in $htlcs {
2184                                         // For inbound HTLCs which we know the preimage for, we have to ensure we hit the
2185                                         // chain with enough room to claim the HTLC without our counterparty being able to
2186                                         // time out the HTLC first.
2187                                         // For outbound HTLCs which our counterparty hasn't failed/claimed, our primary
2188                                         // concern is being able to claim the corresponding inbound HTLC (on another
2189                                         // channel) before it expires. In fact, we don't even really care if our
2190                                         // counterparty here claims such an outbound HTLC after it expired as long as we
2191                                         // can still claim the corresponding HTLC. Thus, to avoid needlessly hitting the
2192                                         // chain when our counterparty is waiting for expiration to off-chain fail an HTLC
2193                                         // we give ourselves a few blocks of headroom after expiration before going
2194                                         // on-chain for an expired HTLC.
2195                                         // Note that, to avoid a potential attack whereby a node delays claiming an HTLC
2196                                         // from us until we've reached the point where we go on-chain with the
2197                                         // corresponding inbound HTLC, we must ensure that outbound HTLCs go on chain at
2198                                         // least CLTV_CLAIM_BUFFER blocks prior to the inbound HTLC.
2199                                         //  aka outbound_cltv + LATENCY_GRACE_PERIOD_BLOCKS == height - CLTV_CLAIM_BUFFER
2200                                         //      inbound_cltv == height + CLTV_CLAIM_BUFFER
2201                                         //      outbound_cltv + LATENCY_GRACE_PERIOD_BLOCKS + CLTV_CLAIM_BUFFER <= inbound_cltv - CLTV_CLAIM_BUFFER
2202                                         //      LATENCY_GRACE_PERIOD_BLOCKS + 2*CLTV_CLAIM_BUFFER <= inbound_cltv - outbound_cltv
2203                                         //      CLTV_EXPIRY_DELTA <= inbound_cltv - outbound_cltv (by check in ChannelManager::decode_update_add_htlc_onion)
2204                                         //      LATENCY_GRACE_PERIOD_BLOCKS + 2*CLTV_CLAIM_BUFFER <= CLTV_EXPIRY_DELTA
2205                                         //  The final, above, condition is checked for statically in channelmanager
2206                                         //  with CHECK_CLTV_EXPIRY_SANITY_2.
2207                                         let htlc_outbound = $local_tx == htlc.offered;
2208                                         if ( htlc_outbound && htlc.cltv_expiry + LATENCY_GRACE_PERIOD_BLOCKS <= height) ||
2209                                            (!htlc_outbound && htlc.cltv_expiry <= height + CLTV_CLAIM_BUFFER && self.payment_preimages.contains_key(&htlc.payment_hash)) {
2210                                                 log_info!(self, "Force-closing channel due to {} HTLC timeout, HTLC expiry is {}", if htlc_outbound { "outbound" } else { "inbound "}, htlc.cltv_expiry);
2211                                                 return true;
2212                                         }
2213                                 }
2214                         }
2215                 }
2216
2217                 if let Some(ref cur_local_tx) = self.current_local_signed_commitment_tx {
2218                         scan_commitment!(cur_local_tx.htlc_outputs.iter().map(|&(ref a, _, _)| a), true);
2219                 }
2220
2221                 if let Storage::Local { ref current_remote_commitment_txid, ref prev_remote_commitment_txid, .. } = self.key_storage {
2222                         if let &Some(ref txid) = current_remote_commitment_txid {
2223                                 if let Some(ref htlc_outputs) = self.remote_claimable_outpoints.get(txid) {
2224                                         scan_commitment!(htlc_outputs.iter().map(|&(ref a, _)| a), false);
2225                                 }
2226                         }
2227                         if let &Some(ref txid) = prev_remote_commitment_txid {
2228                                 if let Some(ref htlc_outputs) = self.remote_claimable_outpoints.get(txid) {
2229                                         scan_commitment!(htlc_outputs.iter().map(|&(ref a, _)| a), false);
2230                                 }
2231                         }
2232                 }
2233
2234                 false
2235         }
2236
2237         /// Check if any transaction broadcasted is resolving HTLC output by a success or timeout on a local
2238         /// or remote commitment tx, if so send back the source, preimage if found and payment_hash of resolved HTLC
2239         fn is_resolving_htlc_output(&mut self, tx: &Transaction, height: u32) {
2240                 'outer_loop: for input in &tx.input {
2241                         let mut payment_data = None;
2242                         let revocation_sig_claim = (input.witness.len() == 3 && HTLCType::scriptlen_to_htlctype(input.witness[2].len()) == Some(HTLCType::OfferedHTLC) && input.witness[1].len() == 33)
2243                                 || (input.witness.len() == 3 && HTLCType::scriptlen_to_htlctype(input.witness[2].len()) == Some(HTLCType::AcceptedHTLC) && input.witness[1].len() == 33);
2244                         let accepted_preimage_claim = input.witness.len() == 5 && HTLCType::scriptlen_to_htlctype(input.witness[4].len()) == Some(HTLCType::AcceptedHTLC);
2245                         let offered_preimage_claim = input.witness.len() == 3 && HTLCType::scriptlen_to_htlctype(input.witness[2].len()) == Some(HTLCType::OfferedHTLC);
2246
2247                         macro_rules! log_claim {
2248                                 ($tx_info: expr, $local_tx: expr, $htlc: expr, $source_avail: expr) => {
2249                                         // We found the output in question, but aren't failing it backwards
2250                                         // as we have no corresponding source and no valid remote commitment txid
2251                                         // to try a weak source binding with same-hash, same-value still-valid offered HTLC.
2252                                         // This implies either it is an inbound HTLC or an outbound HTLC on a revoked transaction.
2253                                         let outbound_htlc = $local_tx == $htlc.offered;
2254                                         if ($local_tx && revocation_sig_claim) ||
2255                                                         (outbound_htlc && !$source_avail && (accepted_preimage_claim || offered_preimage_claim)) {
2256                                                 log_error!(self, "Input spending {} ({}:{}) in {} resolves {} HTLC with payment hash {} with {}!",
2257                                                         $tx_info, input.previous_output.txid, input.previous_output.vout, tx.txid(),
2258                                                         if outbound_htlc { "outbound" } else { "inbound" }, log_bytes!($htlc.payment_hash.0),
2259                                                         if revocation_sig_claim { "revocation sig" } else { "preimage claim after we'd passed the HTLC resolution back" });
2260                                         } else {
2261                                                 log_info!(self, "Input spending {} ({}:{}) in {} resolves {} HTLC with payment hash {} with {}",
2262                                                         $tx_info, input.previous_output.txid, input.previous_output.vout, tx.txid(),
2263                                                         if outbound_htlc { "outbound" } else { "inbound" }, log_bytes!($htlc.payment_hash.0),
2264                                                         if revocation_sig_claim { "revocation sig" } else if accepted_preimage_claim || offered_preimage_claim { "preimage" } else { "timeout" });
2265                                         }
2266                                 }
2267                         }
2268
2269                         macro_rules! check_htlc_valid_remote {
2270                                 ($remote_txid: expr, $htlc_output: expr) => {
2271                                         if let &Some(txid) = $remote_txid {
2272                                                 for &(ref pending_htlc, ref pending_source) in self.remote_claimable_outpoints.get(&txid).unwrap() {
2273                                                         if pending_htlc.payment_hash == $htlc_output.payment_hash && pending_htlc.amount_msat == $htlc_output.amount_msat {
2274                                                                 if let &Some(ref source) = pending_source {
2275                                                                         log_claim!("revoked remote commitment tx", false, pending_htlc, true);
2276                                                                         payment_data = Some(((**source).clone(), $htlc_output.payment_hash));
2277                                                                         break;
2278                                                                 }
2279                                                         }
2280                                                 }
2281                                         }
2282                                 }
2283                         }
2284
2285                         macro_rules! scan_commitment {
2286                                 ($htlcs: expr, $tx_info: expr, $local_tx: expr) => {
2287                                         for (ref htlc_output, source_option) in $htlcs {
2288                                                 if Some(input.previous_output.vout) == htlc_output.transaction_output_index {
2289                                                         if let Some(ref source) = source_option {
2290                                                                 log_claim!($tx_info, $local_tx, htlc_output, true);
2291                                                                 // We have a resolution of an HTLC either from one of our latest
2292                                                                 // local commitment transactions or an unrevoked remote commitment
2293                                                                 // transaction. This implies we either learned a preimage, the HTLC
2294                                                                 // has timed out, or we screwed up. In any case, we should now
2295                                                                 // resolve the source HTLC with the original sender.
2296                                                                 payment_data = Some(((*source).clone(), htlc_output.payment_hash));
2297                                                         } else if !$local_tx {
2298                                                                 if let Storage::Local { ref current_remote_commitment_txid, .. } = self.key_storage {
2299                                                                         check_htlc_valid_remote!(current_remote_commitment_txid, htlc_output);
2300                                                                 }
2301                                                                 if payment_data.is_none() {
2302                                                                         if let Storage::Local { ref prev_remote_commitment_txid, .. } = self.key_storage {
2303                                                                                 check_htlc_valid_remote!(prev_remote_commitment_txid, htlc_output);
2304                                                                         }
2305                                                                 }
2306                                                         }
2307                                                         if payment_data.is_none() {
2308                                                                 log_claim!($tx_info, $local_tx, htlc_output, false);
2309                                                                 continue 'outer_loop;
2310                                                         }
2311                                                 }
2312                                         }
2313                                 }
2314                         }
2315
2316                         if let Some(ref current_local_signed_commitment_tx) = self.current_local_signed_commitment_tx {
2317                                 if input.previous_output.txid == current_local_signed_commitment_tx.txid {
2318                                         scan_commitment!(current_local_signed_commitment_tx.htlc_outputs.iter().map(|&(ref a, _, ref b)| (a, b.as_ref())),
2319                                                 "our latest local commitment tx", true);
2320                                 }
2321                         }
2322                         if let Some(ref prev_local_signed_commitment_tx) = self.prev_local_signed_commitment_tx {
2323                                 if input.previous_output.txid == prev_local_signed_commitment_tx.txid {
2324                                         scan_commitment!(prev_local_signed_commitment_tx.htlc_outputs.iter().map(|&(ref a, _, ref b)| (a, b.as_ref())),
2325                                                 "our previous local commitment tx", true);
2326                                 }
2327                         }
2328                         if let Some(ref htlc_outputs) = self.remote_claimable_outpoints.get(&input.previous_output.txid) {
2329                                 scan_commitment!(htlc_outputs.iter().map(|&(ref a, ref b)| (a, (b.as_ref().clone()).map(|boxed| &**boxed))),
2330                                         "remote commitment tx", false);
2331                         }
2332
2333                         // Check that scan_commitment, above, decided there is some source worth relaying an
2334                         // HTLC resolution backwards to and figure out whether we learned a preimage from it.
2335                         if let Some((source, payment_hash)) = payment_data {
2336                                 let mut payment_preimage = PaymentPreimage([0; 32]);
2337                                 if accepted_preimage_claim {
2338                                         if !self.pending_htlcs_updated.iter().any(|update| update.source == source) {
2339                                                 payment_preimage.0.copy_from_slice(&input.witness[3]);
2340                                                 self.pending_htlcs_updated.push(HTLCUpdate {
2341                                                         source,
2342                                                         payment_preimage: Some(payment_preimage),
2343                                                         payment_hash
2344                                                 });
2345                                         }
2346                                 } else if offered_preimage_claim {
2347                                         if !self.pending_htlcs_updated.iter().any(|update| update.source == source) {
2348                                                 payment_preimage.0.copy_from_slice(&input.witness[1]);
2349                                                 self.pending_htlcs_updated.push(HTLCUpdate {
2350                                                         source,
2351                                                         payment_preimage: Some(payment_preimage),
2352                                                         payment_hash
2353                                                 });
2354                                         }
2355                                 } else {
2356                                         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);
2357                                         match self.onchain_events_waiting_threshold_conf.entry(height + ANTI_REORG_DELAY - 1) {
2358                                                 hash_map::Entry::Occupied(mut entry) => {
2359                                                         let e = entry.get_mut();
2360                                                         e.retain(|ref event| {
2361                                                                 match **event {
2362                                                                         OnchainEvent::HTLCUpdate { ref htlc_update } => {
2363                                                                                 return htlc_update.0 != source
2364                                                                         },
2365                                                                 }
2366                                                         });
2367                                                         e.push(OnchainEvent::HTLCUpdate { htlc_update: (source, payment_hash)});
2368                                                 }
2369                                                 hash_map::Entry::Vacant(entry) => {
2370                                                         entry.insert(vec![OnchainEvent::HTLCUpdate { htlc_update: (source, payment_hash)}]);
2371                                                 }
2372                                         }
2373                                 }
2374                         }
2375                 }
2376         }
2377
2378         /// Check if any transaction broadcasted is paying fund back to some address we can assume to own
2379         fn is_paying_spendable_output(&self, tx: &Transaction) -> Option<SpendableOutputDescriptor> {
2380                 for (i, outp) in tx.output.iter().enumerate() { // There is max one spendable output for any channel tx, including ones generated by us
2381                         if outp.script_pubkey == self.destination_script {
2382                                 return Some(SpendableOutputDescriptor::StaticOutput {
2383                                         outpoint: BitcoinOutPoint { txid: tx.txid(), vout: i as u32 },
2384                                         output: outp.clone(),
2385                                 });
2386                         }
2387                 }
2388                 None
2389         }
2390 }
2391
2392 const MAX_ALLOC_SIZE: usize = 64*1024;
2393
2394 impl<ChanSigner: ChannelKeys + Readable> ReadableArgs<Arc<Logger>> for (Sha256dHash, ChannelMonitor<ChanSigner>) {
2395         fn read<R: ::std::io::Read>(reader: &mut R, logger: Arc<Logger>) -> Result<Self, DecodeError> {
2396                 macro_rules! unwrap_obj {
2397                         ($key: expr) => {
2398                                 match $key {
2399                                         Ok(res) => res,
2400                                         Err(_) => return Err(DecodeError::InvalidValue),
2401                                 }
2402                         }
2403                 }
2404
2405                 let _ver: u8 = Readable::read(reader)?;
2406                 let min_ver: u8 = Readable::read(reader)?;
2407                 if min_ver > SERIALIZATION_VERSION {
2408                         return Err(DecodeError::UnknownVersion);
2409                 }
2410
2411                 let latest_update_id: u64 = Readable::read(reader)?;
2412                 let commitment_transaction_number_obscure_factor = <U48 as Readable>::read(reader)?.0;
2413
2414                 let destination_script = Readable::read(reader)?;
2415
2416                 let key_storage = match <u8 as Readable>::read(reader)? {
2417                         0 => {
2418                                 let keys = Readable::read(reader)?;
2419                                 let funding_key = Readable::read(reader)?;
2420                                 let revocation_base_key = Readable::read(reader)?;
2421                                 let htlc_base_key = Readable::read(reader)?;
2422                                 let delayed_payment_base_key = Readable::read(reader)?;
2423                                 let payment_base_key = Readable::read(reader)?;
2424                                 let shutdown_pubkey = Readable::read(reader)?;
2425                                 // Technically this can fail and serialize fail a round-trip, but only for serialization of
2426                                 // barely-init'd ChannelMonitors that we can't do anything with.
2427                                 let outpoint = OutPoint {
2428                                         txid: Readable::read(reader)?,
2429                                         index: Readable::read(reader)?,
2430                                 };
2431                                 let funding_info = Some((outpoint, Readable::read(reader)?));
2432                                 let current_remote_commitment_txid = Readable::read(reader)?;
2433                                 let prev_remote_commitment_txid = Readable::read(reader)?;
2434                                 Storage::Local {
2435                                         keys,
2436                                         funding_key,
2437                                         revocation_base_key,
2438                                         htlc_base_key,
2439                                         delayed_payment_base_key,
2440                                         payment_base_key,
2441                                         shutdown_pubkey,
2442                                         funding_info,
2443                                         current_remote_commitment_txid,
2444                                         prev_remote_commitment_txid,
2445                                 }
2446                         },
2447                         _ => return Err(DecodeError::InvalidValue),
2448                 };
2449
2450                 let their_htlc_base_key = Some(Readable::read(reader)?);
2451                 let their_delayed_payment_base_key = Some(Readable::read(reader)?);
2452                 let funding_redeemscript = Some(Readable::read(reader)?);
2453                 let channel_value_satoshis = Some(Readable::read(reader)?);
2454
2455                 let their_cur_revocation_points = {
2456                         let first_idx = <U48 as Readable>::read(reader)?.0;
2457                         if first_idx == 0 {
2458                                 None
2459                         } else {
2460                                 let first_point = Readable::read(reader)?;
2461                                 let second_point_slice: [u8; 33] = Readable::read(reader)?;
2462                                 if second_point_slice[0..32] == [0; 32] && second_point_slice[32] == 0 {
2463                                         Some((first_idx, first_point, None))
2464                                 } else {
2465                                         Some((first_idx, first_point, Some(unwrap_obj!(PublicKey::from_slice(&second_point_slice)))))
2466                                 }
2467                         }
2468                 };
2469
2470                 let our_to_self_delay: u16 = Readable::read(reader)?;
2471                 let their_to_self_delay: Option<u16> = Some(Readable::read(reader)?);
2472
2473                 let commitment_secrets = Readable::read(reader)?;
2474
2475                 macro_rules! read_htlc_in_commitment {
2476                         () => {
2477                                 {
2478                                         let offered: bool = Readable::read(reader)?;
2479                                         let amount_msat: u64 = Readable::read(reader)?;
2480                                         let cltv_expiry: u32 = Readable::read(reader)?;
2481                                         let payment_hash: PaymentHash = Readable::read(reader)?;
2482                                         let transaction_output_index: Option<u32> = Readable::read(reader)?;
2483
2484                                         HTLCOutputInCommitment {
2485                                                 offered, amount_msat, cltv_expiry, payment_hash, transaction_output_index
2486                                         }
2487                                 }
2488                         }
2489                 }
2490
2491                 let remote_claimable_outpoints_len: u64 = Readable::read(reader)?;
2492                 let mut remote_claimable_outpoints = HashMap::with_capacity(cmp::min(remote_claimable_outpoints_len as usize, MAX_ALLOC_SIZE / 64));
2493                 for _ in 0..remote_claimable_outpoints_len {
2494                         let txid: Sha256dHash = Readable::read(reader)?;
2495                         let htlcs_count: u64 = Readable::read(reader)?;
2496                         let mut htlcs = Vec::with_capacity(cmp::min(htlcs_count as usize, MAX_ALLOC_SIZE / 32));
2497                         for _ in 0..htlcs_count {
2498                                 htlcs.push((read_htlc_in_commitment!(), <Option<HTLCSource> as Readable>::read(reader)?.map(|o: HTLCSource| Box::new(o))));
2499                         }
2500                         if let Some(_) = remote_claimable_outpoints.insert(txid, htlcs) {
2501                                 return Err(DecodeError::InvalidValue);
2502                         }
2503                 }
2504
2505                 let remote_commitment_txn_on_chain_len: u64 = Readable::read(reader)?;
2506                 let mut remote_commitment_txn_on_chain = HashMap::with_capacity(cmp::min(remote_commitment_txn_on_chain_len as usize, MAX_ALLOC_SIZE / 32));
2507                 for _ in 0..remote_commitment_txn_on_chain_len {
2508                         let txid: Sha256dHash = Readable::read(reader)?;
2509                         let commitment_number = <U48 as Readable>::read(reader)?.0;
2510                         let outputs_count = <u64 as Readable>::read(reader)?;
2511                         let mut outputs = Vec::with_capacity(cmp::min(outputs_count as usize, MAX_ALLOC_SIZE / 8));
2512                         for _ in 0..outputs_count {
2513                                 outputs.push(Readable::read(reader)?);
2514                         }
2515                         if let Some(_) = remote_commitment_txn_on_chain.insert(txid, (commitment_number, outputs)) {
2516                                 return Err(DecodeError::InvalidValue);
2517                         }
2518                 }
2519
2520                 let remote_hash_commitment_number_len: u64 = Readable::read(reader)?;
2521                 let mut remote_hash_commitment_number = HashMap::with_capacity(cmp::min(remote_hash_commitment_number_len as usize, MAX_ALLOC_SIZE / 32));
2522                 for _ in 0..remote_hash_commitment_number_len {
2523                         let payment_hash: PaymentHash = Readable::read(reader)?;
2524                         let commitment_number = <U48 as Readable>::read(reader)?.0;
2525                         if let Some(_) = remote_hash_commitment_number.insert(payment_hash, commitment_number) {
2526                                 return Err(DecodeError::InvalidValue);
2527                         }
2528                 }
2529
2530                 macro_rules! read_local_tx {
2531                         () => {
2532                                 {
2533                                         let tx = <LocalCommitmentTransaction as Readable>::read(reader)?;
2534                                         let revocation_key = Readable::read(reader)?;
2535                                         let a_htlc_key = Readable::read(reader)?;
2536                                         let b_htlc_key = Readable::read(reader)?;
2537                                         let delayed_payment_key = Readable::read(reader)?;
2538                                         let per_commitment_point = Readable::read(reader)?;
2539                                         let feerate_per_kw: u64 = Readable::read(reader)?;
2540
2541                                         let htlcs_len: u64 = Readable::read(reader)?;
2542                                         let mut htlcs = Vec::with_capacity(cmp::min(htlcs_len as usize, MAX_ALLOC_SIZE / 128));
2543                                         for _ in 0..htlcs_len {
2544                                                 let htlc = read_htlc_in_commitment!();
2545                                                 let sigs = match <u8 as Readable>::read(reader)? {
2546                                                         0 => None,
2547                                                         1 => Some(Readable::read(reader)?),
2548                                                         _ => return Err(DecodeError::InvalidValue),
2549                                                 };
2550                                                 htlcs.push((htlc, sigs, Readable::read(reader)?));
2551                                         }
2552
2553                                         LocalSignedTx {
2554                                                 txid: tx.txid(),
2555                                                 tx, revocation_key, a_htlc_key, b_htlc_key, delayed_payment_key, per_commitment_point, feerate_per_kw,
2556                                                 htlc_outputs: htlcs
2557                                         }
2558                                 }
2559                         }
2560                 }
2561
2562                 let prev_local_signed_commitment_tx = match <u8 as Readable>::read(reader)? {
2563                         0 => None,
2564                         1 => {
2565                                 Some(read_local_tx!())
2566                         },
2567                         _ => return Err(DecodeError::InvalidValue),
2568                 };
2569
2570                 let current_local_signed_commitment_tx = match <u8 as Readable>::read(reader)? {
2571                         0 => None,
2572                         1 => {
2573                                 Some(read_local_tx!())
2574                         },
2575                         _ => return Err(DecodeError::InvalidValue),
2576                 };
2577
2578                 let current_remote_commitment_number = <U48 as Readable>::read(reader)?.0;
2579
2580                 let payment_preimages_len: u64 = Readable::read(reader)?;
2581                 let mut payment_preimages = HashMap::with_capacity(cmp::min(payment_preimages_len as usize, MAX_ALLOC_SIZE / 32));
2582                 for _ in 0..payment_preimages_len {
2583                         let preimage: PaymentPreimage = Readable::read(reader)?;
2584                         let hash = PaymentHash(Sha256::hash(&preimage.0[..]).into_inner());
2585                         if let Some(_) = payment_preimages.insert(hash, preimage) {
2586                                 return Err(DecodeError::InvalidValue);
2587                         }
2588                 }
2589
2590                 let pending_htlcs_updated_len: u64 = Readable::read(reader)?;
2591                 let mut pending_htlcs_updated = Vec::with_capacity(cmp::min(pending_htlcs_updated_len as usize, MAX_ALLOC_SIZE / (32 + 8*3)));
2592                 for _ in 0..pending_htlcs_updated_len {
2593                         pending_htlcs_updated.push(Readable::read(reader)?);
2594                 }
2595
2596                 let pending_events_len: u64 = Readable::read(reader)?;
2597                 let mut pending_events = Vec::with_capacity(cmp::min(pending_events_len as usize, MAX_ALLOC_SIZE / mem::size_of::<events::Event>()));
2598                 for _ in 0..pending_events_len {
2599                         if let Some(event) = MaybeReadable::read(reader)? {
2600                                 pending_events.push(event);
2601                         }
2602                 }
2603
2604                 let last_block_hash: Sha256dHash = Readable::read(reader)?;
2605                 let to_remote_rescue = match <u8 as Readable>::read(reader)? {
2606                         0 => None,
2607                         1 => {
2608                                 let to_remote_script = Readable::read(reader)?;
2609                                 let local_key = Readable::read(reader)?;
2610                                 Some((to_remote_script, local_key))
2611                         }
2612                         _ => return Err(DecodeError::InvalidValue),
2613                 };
2614
2615                 let waiting_threshold_conf_len: u64 = Readable::read(reader)?;
2616                 let mut onchain_events_waiting_threshold_conf = HashMap::with_capacity(cmp::min(waiting_threshold_conf_len as usize, MAX_ALLOC_SIZE / 128));
2617                 for _ in 0..waiting_threshold_conf_len {
2618                         let height_target = Readable::read(reader)?;
2619                         let events_len: u64 = Readable::read(reader)?;
2620                         let mut events = Vec::with_capacity(cmp::min(events_len as usize, MAX_ALLOC_SIZE / 128));
2621                         for _ in 0..events_len {
2622                                 let ev = match <u8 as Readable>::read(reader)? {
2623                                         0 => {
2624                                                 let htlc_source = Readable::read(reader)?;
2625                                                 let hash = Readable::read(reader)?;
2626                                                 OnchainEvent::HTLCUpdate {
2627                                                         htlc_update: (htlc_source, hash)
2628                                                 }
2629                                         },
2630                                         _ => return Err(DecodeError::InvalidValue),
2631                                 };
2632                                 events.push(ev);
2633                         }
2634                         onchain_events_waiting_threshold_conf.insert(height_target, events);
2635                 }
2636
2637                 let outputs_to_watch_len: u64 = Readable::read(reader)?;
2638                 let mut outputs_to_watch = HashMap::with_capacity(cmp::min(outputs_to_watch_len as usize, MAX_ALLOC_SIZE / (mem::size_of::<Sha256dHash>() + mem::size_of::<Vec<Script>>())));
2639                 for _ in 0..outputs_to_watch_len {
2640                         let txid = Readable::read(reader)?;
2641                         let outputs_len: u64 = Readable::read(reader)?;
2642                         let mut outputs = Vec::with_capacity(cmp::min(outputs_len as usize, MAX_ALLOC_SIZE / mem::size_of::<Script>()));
2643                         for _ in 0..outputs_len {
2644                                 outputs.push(Readable::read(reader)?);
2645                         }
2646                         if let Some(_) = outputs_to_watch.insert(txid, outputs) {
2647                                 return Err(DecodeError::InvalidValue);
2648                         }
2649                 }
2650                 let onchain_tx_handler = ReadableArgs::read(reader, logger.clone())?;
2651
2652                 Ok((last_block_hash.clone(), ChannelMonitor {
2653                         latest_update_id,
2654                         commitment_transaction_number_obscure_factor,
2655
2656                         destination_script,
2657
2658                         key_storage,
2659                         their_htlc_base_key,
2660                         their_delayed_payment_base_key,
2661                         funding_redeemscript,
2662                         channel_value_satoshis,
2663                         their_cur_revocation_points,
2664
2665                         our_to_self_delay,
2666                         their_to_self_delay,
2667
2668                         commitment_secrets,
2669                         remote_claimable_outpoints,
2670                         remote_commitment_txn_on_chain,
2671                         remote_hash_commitment_number,
2672
2673                         prev_local_signed_commitment_tx,
2674                         current_local_signed_commitment_tx,
2675                         current_remote_commitment_number,
2676
2677                         payment_preimages,
2678                         pending_htlcs_updated,
2679                         pending_events,
2680
2681                         to_remote_rescue,
2682
2683                         onchain_events_waiting_threshold_conf,
2684                         outputs_to_watch,
2685
2686                         onchain_tx_handler,
2687
2688                         last_block_hash,
2689                         secp_ctx: Secp256k1::new(),
2690                         logger,
2691                 }))
2692         }
2693 }
2694
2695 #[cfg(test)]
2696 mod tests {
2697         use bitcoin::blockdata::script::{Script, Builder};
2698         use bitcoin::blockdata::opcodes;
2699         use bitcoin::blockdata::transaction::{Transaction, TxIn, TxOut, SigHashType};
2700         use bitcoin::blockdata::transaction::OutPoint as BitcoinOutPoint;
2701         use bitcoin::util::bip143;
2702         use bitcoin_hashes::Hash;
2703         use bitcoin_hashes::sha256::Hash as Sha256;
2704         use bitcoin_hashes::sha256d::Hash as Sha256dHash;
2705         use bitcoin_hashes::hex::FromHex;
2706         use hex;
2707         use chain::transaction::OutPoint;
2708         use ln::channelmanager::{PaymentPreimage, PaymentHash};
2709         use ln::channelmonitor::ChannelMonitor;
2710         use ln::onchaintx::{OnchainTxHandler, InputDescriptors};
2711         use ln::chan_utils;
2712         use ln::chan_utils::{HTLCOutputInCommitment, TxCreationKeys, LocalCommitmentTransaction};
2713         use util::test_utils::TestLogger;
2714         use secp256k1::key::{SecretKey,PublicKey};
2715         use secp256k1::Secp256k1;
2716         use rand::{thread_rng,Rng};
2717         use std::sync::Arc;
2718         use chain::keysinterface::InMemoryChannelKeys;
2719
2720         #[test]
2721         fn test_prune_preimages() {
2722                 let secp_ctx = Secp256k1::new();
2723                 let logger = Arc::new(TestLogger::new());
2724
2725                 let dummy_key = PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[42; 32]).unwrap());
2726                 macro_rules! dummy_keys {
2727                         () => {
2728                                 {
2729                                         TxCreationKeys {
2730                                                 per_commitment_point: dummy_key.clone(),
2731                                                 revocation_key: dummy_key.clone(),
2732                                                 a_htlc_key: dummy_key.clone(),
2733                                                 b_htlc_key: dummy_key.clone(),
2734                                                 a_delayed_payment_key: dummy_key.clone(),
2735                                                 b_payment_key: dummy_key.clone(),
2736                                         }
2737                                 }
2738                         }
2739                 }
2740                 let dummy_tx = Transaction { version: 0, lock_time: 0, input: Vec::new(), output: Vec::new() };
2741
2742                 let mut preimages = Vec::new();
2743                 {
2744                         let mut rng  = thread_rng();
2745                         for _ in 0..20 {
2746                                 let mut preimage = PaymentPreimage([0; 32]);
2747                                 rng.fill_bytes(&mut preimage.0[..]);
2748                                 let hash = PaymentHash(Sha256::hash(&preimage.0[..]).into_inner());
2749                                 preimages.push((preimage, hash));
2750                         }
2751                 }
2752
2753                 macro_rules! preimages_slice_to_htlc_outputs {
2754                         ($preimages_slice: expr) => {
2755                                 {
2756                                         let mut res = Vec::new();
2757                                         for (idx, preimage) in $preimages_slice.iter().enumerate() {
2758                                                 res.push((HTLCOutputInCommitment {
2759                                                         offered: true,
2760                                                         amount_msat: 0,
2761                                                         cltv_expiry: 0,
2762                                                         payment_hash: preimage.1.clone(),
2763                                                         transaction_output_index: Some(idx as u32),
2764                                                 }, None));
2765                                         }
2766                                         res
2767                                 }
2768                         }
2769                 }
2770                 macro_rules! preimages_to_local_htlcs {
2771                         ($preimages_slice: expr) => {
2772                                 {
2773                                         let mut inp = preimages_slice_to_htlc_outputs!($preimages_slice);
2774                                         let res: Vec<_> = inp.drain(..).map(|e| { (e.0, None, e.1) }).collect();
2775                                         res
2776                                 }
2777                         }
2778                 }
2779
2780                 macro_rules! test_preimages_exist {
2781                         ($preimages_slice: expr, $monitor: expr) => {
2782                                 for preimage in $preimages_slice {
2783                                         assert!($monitor.payment_preimages.contains_key(&preimage.1));
2784                                 }
2785                         }
2786                 }
2787
2788                 let keys = InMemoryChannelKeys::new(
2789                         &secp_ctx,
2790                         SecretKey::from_slice(&[41; 32]).unwrap(),
2791                         SecretKey::from_slice(&[41; 32]).unwrap(),
2792                         SecretKey::from_slice(&[41; 32]).unwrap(),
2793                         SecretKey::from_slice(&[41; 32]).unwrap(),
2794                         SecretKey::from_slice(&[41; 32]).unwrap(),
2795                         [41; 32],
2796                         0,
2797                 );
2798
2799                 // Prune with one old state and a local commitment tx holding a few overlaps with the
2800                 // old state.
2801                 let mut monitor = ChannelMonitor::new(keys,
2802                         &PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[42; 32]).unwrap()), 0, &Script::new(),
2803                         (OutPoint { txid: Sha256dHash::from_slice(&[43; 32]).unwrap(), index: 0 }, Script::new()),
2804                         &PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[44; 32]).unwrap()),
2805                         &PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[45; 32]).unwrap()),
2806                         0, Script::new(), 46, 0, logger.clone());
2807
2808                 monitor.their_to_self_delay = Some(10);
2809
2810                 monitor.provide_latest_local_commitment_tx_info(LocalCommitmentTransaction::dummy(), dummy_keys!(), 0, preimages_to_local_htlcs!(preimages[0..10])).unwrap();
2811                 monitor.provide_latest_remote_commitment_tx_info(&dummy_tx, preimages_slice_to_htlc_outputs!(preimages[5..15]), 281474976710655, dummy_key);
2812                 monitor.provide_latest_remote_commitment_tx_info(&dummy_tx, preimages_slice_to_htlc_outputs!(preimages[15..20]), 281474976710654, dummy_key);
2813                 monitor.provide_latest_remote_commitment_tx_info(&dummy_tx, preimages_slice_to_htlc_outputs!(preimages[17..20]), 281474976710653, dummy_key);
2814                 monitor.provide_latest_remote_commitment_tx_info(&dummy_tx, preimages_slice_to_htlc_outputs!(preimages[18..20]), 281474976710652, dummy_key);
2815                 for &(ref preimage, ref hash) in preimages.iter() {
2816                         monitor.provide_payment_preimage(hash, preimage);
2817                 }
2818
2819                 // Now provide a secret, pruning preimages 10-15
2820                 let mut secret = [0; 32];
2821                 secret[0..32].clone_from_slice(&hex::decode("7cc854b54e3e0dcdb010d7a3fee464a9687be6e8db3be6854c475621e007a5dc").unwrap());
2822                 monitor.provide_secret(281474976710655, secret.clone()).unwrap();
2823                 assert_eq!(monitor.payment_preimages.len(), 15);
2824                 test_preimages_exist!(&preimages[0..10], monitor);
2825                 test_preimages_exist!(&preimages[15..20], monitor);
2826
2827                 // Now provide a further secret, pruning preimages 15-17
2828                 secret[0..32].clone_from_slice(&hex::decode("c7518c8ae4660ed02894df8976fa1a3659c1a8b4b5bec0c4b872abeba4cb8964").unwrap());
2829                 monitor.provide_secret(281474976710654, secret.clone()).unwrap();
2830                 assert_eq!(monitor.payment_preimages.len(), 13);
2831                 test_preimages_exist!(&preimages[0..10], monitor);
2832                 test_preimages_exist!(&preimages[17..20], monitor);
2833
2834                 // Now update local commitment tx info, pruning only element 18 as we still care about the
2835                 // previous commitment tx's preimages too
2836                 monitor.provide_latest_local_commitment_tx_info(LocalCommitmentTransaction::dummy(), dummy_keys!(), 0, preimages_to_local_htlcs!(preimages[0..5])).unwrap();
2837                 secret[0..32].clone_from_slice(&hex::decode("2273e227a5b7449b6e70f1fb4652864038b1cbf9cd7c043a7d6456b7fc275ad8").unwrap());
2838                 monitor.provide_secret(281474976710653, secret.clone()).unwrap();
2839                 assert_eq!(monitor.payment_preimages.len(), 12);
2840                 test_preimages_exist!(&preimages[0..10], monitor);
2841                 test_preimages_exist!(&preimages[18..20], monitor);
2842
2843                 // But if we do it again, we'll prune 5-10
2844                 monitor.provide_latest_local_commitment_tx_info(LocalCommitmentTransaction::dummy(), dummy_keys!(), 0, preimages_to_local_htlcs!(preimages[0..3])).unwrap();
2845                 secret[0..32].clone_from_slice(&hex::decode("27cddaa5624534cb6cb9d7da077cf2b22ab21e9b506fd4998a51d54502e99116").unwrap());
2846                 monitor.provide_secret(281474976710652, secret.clone()).unwrap();
2847                 assert_eq!(monitor.payment_preimages.len(), 5);
2848                 test_preimages_exist!(&preimages[0..5], monitor);
2849         }
2850
2851         #[test]
2852         fn test_claim_txn_weight_computation() {
2853                 // We test Claim txn weight, knowing that we want expected weigth and
2854                 // not actual case to avoid sigs and time-lock delays hell variances.
2855
2856                 let secp_ctx = Secp256k1::new();
2857                 let privkey = SecretKey::from_slice(&hex::decode("0101010101010101010101010101010101010101010101010101010101010101").unwrap()[..]).unwrap();
2858                 let pubkey = PublicKey::from_secret_key(&secp_ctx, &privkey);
2859                 let mut sum_actual_sigs = 0;
2860
2861                 macro_rules! sign_input {
2862                         ($sighash_parts: expr, $input: expr, $idx: expr, $amount: expr, $input_type: expr, $sum_actual_sigs: expr) => {
2863                                 let htlc = HTLCOutputInCommitment {
2864                                         offered: if *$input_type == InputDescriptors::RevokedOfferedHTLC || *$input_type == InputDescriptors::OfferedHTLC { true } else { false },
2865                                         amount_msat: 0,
2866                                         cltv_expiry: 2 << 16,
2867                                         payment_hash: PaymentHash([1; 32]),
2868                                         transaction_output_index: Some($idx),
2869                                 };
2870                                 let redeem_script = if *$input_type == InputDescriptors::RevokedOutput { chan_utils::get_revokeable_redeemscript(&pubkey, 256, &pubkey) } else { chan_utils::get_htlc_redeemscript_with_explicit_keys(&htlc, &pubkey, &pubkey, &pubkey) };
2871                                 let sighash = hash_to_message!(&$sighash_parts.sighash_all(&$input, &redeem_script, $amount)[..]);
2872                                 let sig = secp_ctx.sign(&sighash, &privkey);
2873                                 $input.witness.push(sig.serialize_der().to_vec());
2874                                 $input.witness[0].push(SigHashType::All as u8);
2875                                 sum_actual_sigs += $input.witness[0].len();
2876                                 if *$input_type == InputDescriptors::RevokedOutput {
2877                                         $input.witness.push(vec!(1));
2878                                 } else if *$input_type == InputDescriptors::RevokedOfferedHTLC || *$input_type == InputDescriptors::RevokedReceivedHTLC {
2879                                         $input.witness.push(pubkey.clone().serialize().to_vec());
2880                                 } else if *$input_type == InputDescriptors::ReceivedHTLC {
2881                                         $input.witness.push(vec![0]);
2882                                 } else {
2883                                         $input.witness.push(PaymentPreimage([1; 32]).0.to_vec());
2884                                 }
2885                                 $input.witness.push(redeem_script.into_bytes());
2886                                 println!("witness[0] {}", $input.witness[0].len());
2887                                 println!("witness[1] {}", $input.witness[1].len());
2888                                 println!("witness[2] {}", $input.witness[2].len());
2889                         }
2890                 }
2891
2892                 let script_pubkey = Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script();
2893                 let txid = Sha256dHash::from_hex("56944c5d3f98413ef45cf54545538103cc9f298e0575820ad3591376e2e0f65d").unwrap();
2894
2895                 // Justice tx with 1 to_local, 2 revoked offered HTLCs, 1 revoked received HTLCs
2896                 let mut claim_tx = Transaction { version: 0, lock_time: 0, input: Vec::new(), output: Vec::new() };
2897                 for i in 0..4 {
2898                         claim_tx.input.push(TxIn {
2899                                 previous_output: BitcoinOutPoint {
2900                                         txid,
2901                                         vout: i,
2902                                 },
2903                                 script_sig: Script::new(),
2904                                 sequence: 0xfffffffd,
2905                                 witness: Vec::new(),
2906                         });
2907                 }
2908                 claim_tx.output.push(TxOut {
2909                         script_pubkey: script_pubkey.clone(),
2910                         value: 0,
2911                 });
2912                 let base_weight = claim_tx.get_weight();
2913                 let sighash_parts = bip143::SighashComponents::new(&claim_tx);
2914                 let inputs_des = vec![InputDescriptors::RevokedOutput, InputDescriptors::RevokedOfferedHTLC, InputDescriptors::RevokedOfferedHTLC, InputDescriptors::RevokedReceivedHTLC];
2915                 for (idx, inp) in claim_tx.input.iter_mut().zip(inputs_des.iter()).enumerate() {
2916                         sign_input!(sighash_parts, inp.0, idx as u32, 0, inp.1, sum_actual_sigs);
2917                 }
2918                 assert_eq!(base_weight + OnchainTxHandler::get_witnesses_weight(&inputs_des[..]),  claim_tx.get_weight() + /* max_length_sig */ (73 * inputs_des.len() - sum_actual_sigs));
2919
2920                 // Claim tx with 1 offered HTLCs, 3 received HTLCs
2921                 claim_tx.input.clear();
2922                 sum_actual_sigs = 0;
2923                 for i in 0..4 {
2924                         claim_tx.input.push(TxIn {
2925                                 previous_output: BitcoinOutPoint {
2926                                         txid,
2927                                         vout: i,
2928                                 },
2929                                 script_sig: Script::new(),
2930                                 sequence: 0xfffffffd,
2931                                 witness: Vec::new(),
2932                         });
2933                 }
2934                 let base_weight = claim_tx.get_weight();
2935                 let sighash_parts = bip143::SighashComponents::new(&claim_tx);
2936                 let inputs_des = vec![InputDescriptors::OfferedHTLC, InputDescriptors::ReceivedHTLC, InputDescriptors::ReceivedHTLC, InputDescriptors::ReceivedHTLC];
2937                 for (idx, inp) in claim_tx.input.iter_mut().zip(inputs_des.iter()).enumerate() {
2938                         sign_input!(sighash_parts, inp.0, idx as u32, 0, inp.1, sum_actual_sigs);
2939                 }
2940                 assert_eq!(base_weight + OnchainTxHandler::get_witnesses_weight(&inputs_des[..]),  claim_tx.get_weight() + /* max_length_sig */ (73 * inputs_des.len() - sum_actual_sigs));
2941
2942                 // Justice tx with 1 revoked HTLC-Success tx output
2943                 claim_tx.input.clear();
2944                 sum_actual_sigs = 0;
2945                 claim_tx.input.push(TxIn {
2946                         previous_output: BitcoinOutPoint {
2947                                 txid,
2948                                 vout: 0,
2949                         },
2950                         script_sig: Script::new(),
2951                         sequence: 0xfffffffd,
2952                         witness: Vec::new(),
2953                 });
2954                 let base_weight = claim_tx.get_weight();
2955                 let sighash_parts = bip143::SighashComponents::new(&claim_tx);
2956                 let inputs_des = vec![InputDescriptors::RevokedOutput];
2957                 for (idx, inp) in claim_tx.input.iter_mut().zip(inputs_des.iter()).enumerate() {
2958                         sign_input!(sighash_parts, inp.0, idx as u32, 0, inp.1, sum_actual_sigs);
2959                 }
2960                 assert_eq!(base_weight + OnchainTxHandler::get_witnesses_weight(&inputs_des[..]), claim_tx.get_weight() + /* max_length_isg */ (73 * inputs_des.len() - sum_actual_sigs));
2961         }
2962
2963         // Further testing is done in the ChannelManager integration tests.
2964 }