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