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