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