1 //! The logic to monitor for on-chain transactions and create the relevant claim responses lives
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.
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.
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;
22 use bitcoin::hashes::Hash;
23 use bitcoin::hashes::sha256::Hash as Sha256;
24 use bitcoin::hash_types::{Txid, BlockHash, WPubkeyHash};
26 use bitcoin::secp256k1::{Secp256k1,Signature};
27 use bitcoin::secp256k1::key::{SecretKey,PublicKey};
28 use bitcoin::secp256k1;
30 use ln::msgs::DecodeError;
32 use ln::chan_utils::{CounterpartyCommitmentSecrets, HTLCOutputInCommitment, LocalCommitmentTransaction, HTLCType};
33 use ln::channelmanager::{HTLCSource, PaymentPreimage, PaymentHash};
34 use ln::onchaintx::{OnchainTxHandler, InputDescriptors};
35 use chain::chaininterface::{ChainListener, ChainWatchInterface, BroadcasterInterface, FeeEstimator};
36 use chain::transaction::OutPoint;
37 use chain::keysinterface::{SpendableOutputDescriptor, ChannelKeys};
38 use util::logger::Logger;
39 use util::ser::{Readable, MaybeReadable, Writer, Writeable, U48};
40 use util::{byte_utils, events};
42 use std::collections::{HashMap, hash_map};
44 use std::{hash,cmp, mem};
47 /// An update generated by the underlying Channel itself which contains some new information the
48 /// ChannelMonitor should be made aware of.
49 #[cfg_attr(test, derive(PartialEq))]
52 pub struct ChannelMonitorUpdate {
53 pub(super) updates: Vec<ChannelMonitorUpdateStep>,
54 /// The sequence number of this update. Updates *must* be replayed in-order according to this
55 /// sequence number (and updates may panic if they are not). The update_id values are strictly
56 /// increasing and increase by one for each new update.
58 /// This sequence number is also used to track up to which points updates which returned
59 /// ChannelMonitorUpdateErr::TemporaryFailure have been applied to all copies of a given
60 /// ChannelMonitor when ChannelManager::channel_monitor_updated is called.
64 impl Writeable for ChannelMonitorUpdate {
65 fn write<W: Writer>(&self, w: &mut W) -> Result<(), ::std::io::Error> {
66 self.update_id.write(w)?;
67 (self.updates.len() as u64).write(w)?;
68 for update_step in self.updates.iter() {
69 update_step.write(w)?;
74 impl Readable for ChannelMonitorUpdate {
75 fn read<R: ::std::io::Read>(r: &mut R) -> Result<Self, DecodeError> {
76 let update_id: u64 = Readable::read(r)?;
77 let len: u64 = Readable::read(r)?;
78 let mut updates = Vec::with_capacity(cmp::min(len as usize, MAX_ALLOC_SIZE / ::std::mem::size_of::<ChannelMonitorUpdateStep>()));
80 updates.push(Readable::read(r)?);
82 Ok(Self { update_id, updates })
86 /// An error enum representing a failure to persist a channel monitor update.
88 pub enum ChannelMonitorUpdateErr {
89 /// Used to indicate a temporary failure (eg connection to a watchtower or remote backup of
90 /// our state failed, but is expected to succeed at some point in the future).
92 /// Such a failure will "freeze" a channel, preventing us from revoking old states or
93 /// submitting new commitment transactions to the remote party. Once the update(s) which failed
94 /// have been successfully applied, ChannelManager::channel_monitor_updated can be used to
95 /// restore the channel to an operational state.
97 /// Note that a given ChannelManager will *never* re-generate a given ChannelMonitorUpdate. If
98 /// you return a TemporaryFailure you must ensure that it is written to disk safely before
99 /// writing out the latest ChannelManager state.
101 /// Even when a channel has been "frozen" updates to the ChannelMonitor can continue to occur
102 /// (eg if an inbound HTLC which we forwarded was claimed upstream resulting in us attempting
103 /// to claim it on this channel) and those updates must be applied wherever they can be. At
104 /// least one such updated ChannelMonitor must be persisted otherwise PermanentFailure should
105 /// be returned to get things on-chain ASAP using only the in-memory copy. Obviously updates to
106 /// the channel which would invalidate previous ChannelMonitors are not made when a channel has
109 /// Note that even if updates made after TemporaryFailure succeed you must still call
110 /// channel_monitor_updated to ensure you have the latest monitor and re-enable normal channel
113 /// Note that the update being processed here will not be replayed for you when you call
114 /// ChannelManager::channel_monitor_updated, so you must store the update itself along
115 /// with the persisted ChannelMonitor on your own local disk prior to returning a
116 /// TemporaryFailure. You may, of course, employ a journaling approach, storing only the
117 /// ChannelMonitorUpdate on disk without updating the monitor itself, replaying the journal at
120 /// For deployments where a copy of ChannelMonitors and other local state are backed up in a
121 /// remote location (with local copies persisted immediately), it is anticipated that all
122 /// updates will return TemporaryFailure until the remote copies could be updated.
124 /// Used to indicate no further channel monitor updates will be allowed (eg we've moved on to a
125 /// different watchtower and cannot update with all watchtowers that were previously informed
126 /// of this channel). This will force-close the channel in question (which will generate one
127 /// final ChannelMonitorUpdate which must be delivered to at least one ChannelMonitor copy).
129 /// Should also be used to indicate a failure to update the local persisted copy of the channel
134 /// General Err type for ChannelMonitor actions. Generally, this implies that the data provided is
135 /// inconsistent with the ChannelMonitor being called. eg for ChannelMonitor::update_monitor this
136 /// means you tried to update a monitor for a different channel or the ChannelMonitorUpdate was
138 /// Contains a human-readable error message.
140 pub struct MonitorUpdateError(pub &'static str);
142 /// Simple structure send back by ManyChannelMonitor in case of HTLC detected onchain from a
143 /// forward channel and from which info are needed to update HTLC in a backward channel.
144 #[derive(Clone, PartialEq)]
145 pub struct HTLCUpdate {
146 pub(super) payment_hash: PaymentHash,
147 pub(super) payment_preimage: Option<PaymentPreimage>,
148 pub(super) source: HTLCSource
150 impl_writeable!(HTLCUpdate, 0, { payment_hash, payment_preimage, source });
152 /// Simple trait indicating ability to track a set of ChannelMonitors and multiplex events between
153 /// them. Generally should be implemented by keeping a local SimpleManyChannelMonitor and passing
154 /// events to it, while also taking any add/update_monitor events and passing them to some remote
157 /// In general, you must always have at least one local copy in memory, which must never fail to
158 /// update (as it is responsible for broadcasting the latest state in case the channel is closed),
159 /// and then persist it to various on-disk locations. If, for some reason, the in-memory copy fails
160 /// to update (eg out-of-memory or some other condition), you must immediately shut down without
161 /// taking any further action such as writing the current state to disk. This should likely be
162 /// accomplished via panic!() or abort().
164 /// Note that any updates to a channel's monitor *must* be applied to each instance of the
165 /// channel's monitor everywhere (including remote watchtowers) *before* this function returns. If
166 /// an update occurs and a remote watchtower is left with old state, it may broadcast transactions
167 /// which we have revoked, allowing our counterparty to claim all funds in the channel!
169 /// User needs to notify implementors of ManyChannelMonitor when a new block is connected or
170 /// disconnected using their `block_connected` and `block_disconnected` methods. However, rather
171 /// than calling these methods directly, the user should register implementors as listeners to the
172 /// BlockNotifier and call the BlockNotifier's `block_(dis)connected` methods, which will notify
173 /// all registered listeners in one go.
174 pub trait ManyChannelMonitor<ChanSigner: ChannelKeys>: Send + Sync {
175 /// Adds a monitor for the given `funding_txo`.
177 /// Implementer must also ensure that the funding_txo txid *and* outpoint are registered with
178 /// any relevant ChainWatchInterfaces such that the provided monitor receives block_connected
179 /// callbacks with the funding transaction, or any spends of it.
181 /// Further, the implementer must also ensure that each output returned in
182 /// monitor.get_outputs_to_watch() is registered to ensure that the provided monitor learns about
183 /// any spends of any of the outputs.
185 /// Any spends of outputs which should have been registered which aren't passed to
186 /// ChannelMonitors via block_connected may result in FUNDS LOSS.
187 fn add_monitor(&self, funding_txo: OutPoint, monitor: ChannelMonitor<ChanSigner>) -> Result<(), ChannelMonitorUpdateErr>;
189 /// Updates a monitor for the given `funding_txo`.
191 /// Implementer must also ensure that the funding_txo txid *and* outpoint are registered with
192 /// any relevant ChainWatchInterfaces such that the provided monitor receives block_connected
193 /// callbacks with the funding transaction, or any spends of it.
195 /// Further, the implementer must also ensure that each output returned in
196 /// monitor.get_watch_outputs() is registered to ensure that the provided monitor learns about
197 /// any spends of any of the outputs.
199 /// Any spends of outputs which should have been registered which aren't passed to
200 /// ChannelMonitors via block_connected may result in FUNDS LOSS.
201 fn update_monitor(&self, funding_txo: OutPoint, monitor: ChannelMonitorUpdate) -> Result<(), ChannelMonitorUpdateErr>;
203 /// Used by ChannelManager to get list of HTLC resolved onchain and which needed to be updated
204 /// with success or failure.
206 /// You should probably just call through to
207 /// ChannelMonitor::get_and_clear_pending_htlcs_updated() for each ChannelMonitor and return
209 fn get_and_clear_pending_htlcs_updated(&self) -> Vec<HTLCUpdate>;
212 /// A simple implementation of a ManyChannelMonitor and ChainListener. Can be used to create a
213 /// watchtower or watch our own channels.
215 /// Note that you must provide your own key by which to refer to channels.
217 /// If you're accepting remote monitors (ie are implementing a watchtower), you must verify that
218 /// users cannot overwrite a given channel by providing a duplicate key. ie you should probably
219 /// index by a PublicKey which is required to sign any updates.
221 /// If you're using this for local monitoring of your own channels, you probably want to use
222 /// `OutPoint` as the key, which will give you a ManyChannelMonitor implementation.
223 pub struct SimpleManyChannelMonitor<Key, ChanSigner: ChannelKeys, T: Deref, F: Deref, L: Deref, C: Deref>
224 where T::Target: BroadcasterInterface,
225 F::Target: FeeEstimator,
227 C::Target: ChainWatchInterface,
229 #[cfg(test)] // Used in ChannelManager tests to manipulate channels directly
230 pub monitors: Mutex<HashMap<Key, ChannelMonitor<ChanSigner>>>,
232 monitors: Mutex<HashMap<Key, ChannelMonitor<ChanSigner>>>,
239 impl<Key : Send + cmp::Eq + hash::Hash, ChanSigner: ChannelKeys, T: Deref + Sync + Send, F: Deref + Sync + Send, L: Deref + Sync + Send, C: Deref + Sync + Send>
240 ChainListener for SimpleManyChannelMonitor<Key, ChanSigner, T, F, L, C>
241 where T::Target: BroadcasterInterface,
242 F::Target: FeeEstimator,
244 C::Target: ChainWatchInterface,
246 fn block_connected(&self, header: &BlockHeader, height: u32, txn_matched: &[&Transaction], _indexes_of_txn_matched: &[u32]) {
247 let block_hash = header.bitcoin_hash();
249 let mut monitors = self.monitors.lock().unwrap();
250 for monitor in monitors.values_mut() {
251 let txn_outputs = monitor.block_connected(txn_matched, height, &block_hash, &*self.broadcaster, &*self.fee_estimator, &*self.logger);
253 for (ref txid, ref outputs) in txn_outputs {
254 for (idx, output) in outputs.iter().enumerate() {
255 self.chain_monitor.install_watch_outpoint((txid.clone(), idx as u32), &output.script_pubkey);
262 fn block_disconnected(&self, header: &BlockHeader, disconnected_height: u32) {
263 let block_hash = header.bitcoin_hash();
264 let mut monitors = self.monitors.lock().unwrap();
265 for monitor in monitors.values_mut() {
266 monitor.block_disconnected(disconnected_height, &block_hash, &*self.broadcaster, &*self.fee_estimator, &*self.logger);
271 impl<Key : Send + cmp::Eq + hash::Hash + 'static, ChanSigner: ChannelKeys, T: Deref, F: Deref, L: Deref, C: Deref> SimpleManyChannelMonitor<Key, ChanSigner, T, F, L, C>
272 where T::Target: BroadcasterInterface,
273 F::Target: FeeEstimator,
275 C::Target: ChainWatchInterface,
277 /// Creates a new object which can be used to monitor several channels given the chain
278 /// interface with which to register to receive notifications.
279 pub fn new(chain_monitor: C, broadcaster: T, logger: L, feeest: F) -> SimpleManyChannelMonitor<Key, ChanSigner, T, F, L, C> {
280 let res = SimpleManyChannelMonitor {
281 monitors: Mutex::new(HashMap::new()),
285 fee_estimator: feeest,
291 /// Adds or updates the monitor which monitors the channel referred to by the given key.
292 pub fn add_monitor_by_key(&self, key: Key, monitor: ChannelMonitor<ChanSigner>) -> Result<(), MonitorUpdateError> {
293 let mut monitors = self.monitors.lock().unwrap();
294 let entry = match monitors.entry(key) {
295 hash_map::Entry::Occupied(_) => return Err(MonitorUpdateError("Channel monitor for given key is already present")),
296 hash_map::Entry::Vacant(e) => e,
298 log_trace!(self.logger, "Got new Channel Monitor for channel {}", log_bytes!(monitor.funding_info.0.to_channel_id()[..]));
299 self.chain_monitor.install_watch_tx(&monitor.funding_info.0.txid, &monitor.funding_info.1);
300 self.chain_monitor.install_watch_outpoint((monitor.funding_info.0.txid, monitor.funding_info.0.index as u32), &monitor.funding_info.1);
301 for (txid, outputs) in monitor.get_outputs_to_watch().iter() {
302 for (idx, script) in outputs.iter().enumerate() {
303 self.chain_monitor.install_watch_outpoint((*txid, idx as u32), script);
306 entry.insert(monitor);
310 /// Updates the monitor which monitors the channel referred to by the given key.
311 pub fn update_monitor_by_key(&self, key: Key, update: ChannelMonitorUpdate) -> Result<(), MonitorUpdateError> {
312 let mut monitors = self.monitors.lock().unwrap();
313 match monitors.get_mut(&key) {
314 Some(orig_monitor) => {
315 log_trace!(self.logger, "Updating Channel Monitor for channel {}", log_funding_info!(orig_monitor));
316 orig_monitor.update_monitor(update, &self.broadcaster, &self.logger)
318 None => Err(MonitorUpdateError("No such monitor registered"))
323 impl<ChanSigner: ChannelKeys, T: Deref + Sync + Send, F: Deref + Sync + Send, L: Deref + Sync + Send, C: Deref + Sync + Send> ManyChannelMonitor<ChanSigner> for SimpleManyChannelMonitor<OutPoint, ChanSigner, T, F, L, C>
324 where T::Target: BroadcasterInterface,
325 F::Target: FeeEstimator,
327 C::Target: ChainWatchInterface,
329 fn add_monitor(&self, funding_txo: OutPoint, monitor: ChannelMonitor<ChanSigner>) -> Result<(), ChannelMonitorUpdateErr> {
330 match self.add_monitor_by_key(funding_txo, monitor) {
332 Err(_) => Err(ChannelMonitorUpdateErr::PermanentFailure),
336 fn update_monitor(&self, funding_txo: OutPoint, update: ChannelMonitorUpdate) -> Result<(), ChannelMonitorUpdateErr> {
337 match self.update_monitor_by_key(funding_txo, update) {
339 Err(_) => Err(ChannelMonitorUpdateErr::PermanentFailure),
343 fn get_and_clear_pending_htlcs_updated(&self) -> Vec<HTLCUpdate> {
344 let mut pending_htlcs_updated = Vec::new();
345 for chan in self.monitors.lock().unwrap().values_mut() {
346 pending_htlcs_updated.append(&mut chan.get_and_clear_pending_htlcs_updated());
348 pending_htlcs_updated
352 impl<Key : Send + cmp::Eq + hash::Hash, ChanSigner: ChannelKeys, T: Deref, F: Deref, L: Deref, C: Deref> events::EventsProvider for SimpleManyChannelMonitor<Key, ChanSigner, T, F, L, C>
353 where T::Target: BroadcasterInterface,
354 F::Target: FeeEstimator,
356 C::Target: ChainWatchInterface,
358 fn get_and_clear_pending_events(&self) -> Vec<events::Event> {
359 let mut pending_events = Vec::new();
360 for chan in self.monitors.lock().unwrap().values_mut() {
361 pending_events.append(&mut chan.get_and_clear_pending_events());
367 /// If an HTLC expires within this many blocks, don't try to claim it in a shared transaction,
368 /// instead claiming it in its own individual transaction.
369 pub(crate) const CLTV_SHARED_CLAIM_BUFFER: u32 = 12;
370 /// If an HTLC expires within this many blocks, force-close the channel to broadcast the
371 /// HTLC-Success transaction.
372 /// In other words, this is an upper bound on how many blocks we think it can take us to get a
373 /// transaction confirmed (and we use it in a few more, equivalent, places).
374 pub(crate) const CLTV_CLAIM_BUFFER: u32 = 6;
375 /// Number of blocks by which point we expect our counterparty to have seen new blocks on the
376 /// network and done a full update_fail_htlc/commitment_signed dance (+ we've updated all our
377 /// copies of ChannelMonitors, including watchtowers). We could enforce the contract by failing
378 /// at CLTV expiration height but giving a grace period to our peer may be profitable for us if he
379 /// can provide an over-late preimage. Nevertheless, grace period has to be accounted in our
380 /// CLTV_EXPIRY_DELTA to be secure. Following this policy we may decrease the rate of channel failures
381 /// due to expiration but increase the cost of funds being locked longuer in case of failure.
382 /// This delay also cover a low-power peer being slow to process blocks and so being behind us on
383 /// accurate block height.
384 /// In case of onchain failure to be pass backward we may see the last block of ANTI_REORG_DELAY
385 /// with at worst this delay, so we are not only using this value as a mercy for them but also
386 /// us as a safeguard to delay with enough time.
387 pub(crate) const LATENCY_GRACE_PERIOD_BLOCKS: u32 = 3;
388 /// Number of blocks we wait on seeing a HTLC output being solved before we fail corresponding inbound
389 /// HTLCs. This prevents us from failing backwards and then getting a reorg resulting in us losing money.
390 /// We use also this delay to be sure we can remove our in-flight claim txn from bump candidates buffer.
391 /// It may cause spurrious generation of bumped claim txn but that's allright given the outpoint is already
392 /// solved by a previous claim tx. What we want to avoid is reorg evicting our claim tx and us not
393 /// keeping bumping another claim tx to solve the outpoint.
394 pub(crate) const ANTI_REORG_DELAY: u32 = 6;
395 /// Number of blocks before confirmation at which we fail back an un-relayed HTLC or at which we
396 /// refuse to accept a new HTLC.
398 /// This is used for a few separate purposes:
399 /// 1) if we've received an MPP HTLC to us and it expires within this many blocks and we are
400 /// waiting on additional parts (or waiting on the preimage for any HTLC from the user), we will
402 /// 2) if we receive an HTLC within this many blocks of its expiry (plus one to avoid a race
403 /// condition with the above), we will fail this HTLC without telling the user we received it,
404 /// 3) if we are waiting on a connection or a channel state update to send an HTLC to a peer, and
405 /// that HTLC expires within this many blocks, we will simply fail the HTLC instead.
407 /// (1) is all about protecting us - we need enough time to update the channel state before we hit
408 /// CLTV_CLAIM_BUFFER, at which point we'd go on chain to claim the HTLC with the preimage.
410 /// (2) is the same, but with an additional buffer to avoid accepting an HTLC which is immediately
411 /// in a race condition between the user connecting a block (which would fail it) and the user
412 /// providing us the preimage (which would claim it).
414 /// (3) is about our counterparty - we don't want to relay an HTLC to a counterparty when they may
415 /// end up force-closing the channel on us to claim it.
416 pub(crate) const HTLC_FAIL_BACK_BUFFER: u32 = CLTV_CLAIM_BUFFER + LATENCY_GRACE_PERIOD_BLOCKS;
418 #[derive(Clone, PartialEq)]
419 struct LocalSignedTx {
420 /// txid of the transaction in tx, just used to make comparison faster
422 revocation_key: PublicKey,
423 a_htlc_key: PublicKey,
424 b_htlc_key: PublicKey,
425 delayed_payment_key: PublicKey,
426 per_commitment_point: PublicKey,
428 htlc_outputs: Vec<(HTLCOutputInCommitment, Option<Signature>, Option<HTLCSource>)>,
431 /// We use this to track remote commitment transactions and htlcs outputs and
432 /// use it to generate any justice or 2nd-stage preimage/timeout transactions.
434 struct RemoteCommitmentTransaction {
435 remote_delayed_payment_base_key: PublicKey,
436 remote_htlc_base_key: PublicKey,
437 on_remote_tx_csv: u16,
438 per_htlc: HashMap<Txid, Vec<HTLCOutputInCommitment>>
441 impl Writeable for RemoteCommitmentTransaction {
442 fn write<W: Writer>(&self, w: &mut W) -> Result<(), ::std::io::Error> {
443 self.remote_delayed_payment_base_key.write(w)?;
444 self.remote_htlc_base_key.write(w)?;
445 w.write_all(&byte_utils::be16_to_array(self.on_remote_tx_csv))?;
446 w.write_all(&byte_utils::be64_to_array(self.per_htlc.len() as u64))?;
447 for (ref txid, ref htlcs) in self.per_htlc.iter() {
448 w.write_all(&txid[..])?;
449 w.write_all(&byte_utils::be64_to_array(htlcs.len() as u64))?;
450 for &ref htlc in htlcs.iter() {
457 impl Readable for RemoteCommitmentTransaction {
458 fn read<R: ::std::io::Read>(r: &mut R) -> Result<Self, DecodeError> {
459 let remote_commitment_transaction = {
460 let remote_delayed_payment_base_key = Readable::read(r)?;
461 let remote_htlc_base_key = Readable::read(r)?;
462 let on_remote_tx_csv: u16 = Readable::read(r)?;
463 let per_htlc_len: u64 = Readable::read(r)?;
464 let mut per_htlc = HashMap::with_capacity(cmp::min(per_htlc_len as usize, MAX_ALLOC_SIZE / 64));
465 for _ in 0..per_htlc_len {
466 let txid: Txid = Readable::read(r)?;
467 let htlcs_count: u64 = Readable::read(r)?;
468 let mut htlcs = Vec::with_capacity(cmp::min(htlcs_count as usize, MAX_ALLOC_SIZE / 32));
469 for _ in 0..htlcs_count {
470 let htlc = Readable::read(r)?;
473 if let Some(_) = per_htlc.insert(txid, htlcs) {
474 return Err(DecodeError::InvalidValue);
477 RemoteCommitmentTransaction {
478 remote_delayed_payment_base_key,
479 remote_htlc_base_key,
484 Ok(remote_commitment_transaction)
488 /// When ChannelMonitor discovers an onchain outpoint being a step of a channel and that it needs
489 /// to generate a tx to push channel state forward, we cache outpoint-solving tx material to build
490 /// a new bumped one in case of lenghty confirmation delay
491 #[derive(Clone, PartialEq)]
492 pub(crate) enum InputMaterial {
494 per_commitment_point: PublicKey,
495 remote_delayed_payment_base_key: PublicKey,
496 remote_htlc_base_key: PublicKey,
497 per_commitment_key: SecretKey,
498 input_descriptor: InputDescriptors,
500 htlc: Option<HTLCOutputInCommitment>,
501 on_remote_tx_csv: u16,
504 per_commitment_point: PublicKey,
505 remote_delayed_payment_base_key: PublicKey,
506 remote_htlc_base_key: PublicKey,
507 preimage: Option<PaymentPreimage>,
508 htlc: HTLCOutputInCommitment
511 preimage: Option<PaymentPreimage>,
515 funding_redeemscript: Script,
519 impl Writeable for InputMaterial {
520 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), ::std::io::Error> {
522 &InputMaterial::Revoked { ref per_commitment_point, ref remote_delayed_payment_base_key, ref remote_htlc_base_key, ref per_commitment_key, ref input_descriptor, ref amount, ref htlc, ref on_remote_tx_csv} => {
523 writer.write_all(&[0; 1])?;
524 per_commitment_point.write(writer)?;
525 remote_delayed_payment_base_key.write(writer)?;
526 remote_htlc_base_key.write(writer)?;
527 writer.write_all(&per_commitment_key[..])?;
528 input_descriptor.write(writer)?;
529 writer.write_all(&byte_utils::be64_to_array(*amount))?;
531 on_remote_tx_csv.write(writer)?;
533 &InputMaterial::RemoteHTLC { ref per_commitment_point, ref remote_delayed_payment_base_key, ref remote_htlc_base_key, ref preimage, ref htlc} => {
534 writer.write_all(&[1; 1])?;
535 per_commitment_point.write(writer)?;
536 remote_delayed_payment_base_key.write(writer)?;
537 remote_htlc_base_key.write(writer)?;
538 preimage.write(writer)?;
541 &InputMaterial::LocalHTLC { ref preimage, ref amount } => {
542 writer.write_all(&[2; 1])?;
543 preimage.write(writer)?;
544 writer.write_all(&byte_utils::be64_to_array(*amount))?;
546 &InputMaterial::Funding { ref funding_redeemscript } => {
547 writer.write_all(&[3; 1])?;
548 funding_redeemscript.write(writer)?;
555 impl Readable for InputMaterial {
556 fn read<R: ::std::io::Read>(reader: &mut R) -> Result<Self, DecodeError> {
557 let input_material = match <u8 as Readable>::read(reader)? {
559 let per_commitment_point = Readable::read(reader)?;
560 let remote_delayed_payment_base_key = Readable::read(reader)?;
561 let remote_htlc_base_key = Readable::read(reader)?;
562 let per_commitment_key = Readable::read(reader)?;
563 let input_descriptor = Readable::read(reader)?;
564 let amount = Readable::read(reader)?;
565 let htlc = Readable::read(reader)?;
566 let on_remote_tx_csv = Readable::read(reader)?;
567 InputMaterial::Revoked {
568 per_commitment_point,
569 remote_delayed_payment_base_key,
570 remote_htlc_base_key,
579 let per_commitment_point = Readable::read(reader)?;
580 let remote_delayed_payment_base_key = Readable::read(reader)?;
581 let remote_htlc_base_key = Readable::read(reader)?;
582 let preimage = Readable::read(reader)?;
583 let htlc = Readable::read(reader)?;
584 InputMaterial::RemoteHTLC {
585 per_commitment_point,
586 remote_delayed_payment_base_key,
587 remote_htlc_base_key,
593 let preimage = Readable::read(reader)?;
594 let amount = Readable::read(reader)?;
595 InputMaterial::LocalHTLC {
601 InputMaterial::Funding {
602 funding_redeemscript: Readable::read(reader)?,
605 _ => return Err(DecodeError::InvalidValue),
611 /// ClaimRequest is a descriptor structure to communicate between detection
612 /// and reaction module. They are generated by ChannelMonitor while parsing
613 /// onchain txn leaked from a channel and handed over to OnchainTxHandler which
614 /// is responsible for opportunistic aggregation, selecting and enforcing
615 /// bumping logic, building and signing transactions.
616 pub(crate) struct ClaimRequest {
617 // Block height before which claiming is exclusive to one party,
618 // after reaching it, claiming may be contentious.
619 pub(crate) absolute_timelock: u32,
620 // Timeout tx must have nLocktime set which means aggregating multiple
621 // ones must take the higher nLocktime among them to satisfy all of them.
622 // Sadly it has few pitfalls, a) it takes longuer to get fund back b) CLTV_DELTA
623 // of a sooner-HTLC could be swallowed by the highest nLocktime of the HTLC set.
624 // Do simplify we mark them as non-aggregable.
625 pub(crate) aggregable: bool,
626 // Basic bitcoin outpoint (txid, vout)
627 pub(crate) outpoint: BitcoinOutPoint,
628 // Following outpoint type, set of data needed to generate transaction digest
629 // and satisfy witness program.
630 pub(crate) witness_data: InputMaterial
633 /// Upon discovering of some classes of onchain tx by ChannelMonitor, we may have to take actions on it
634 /// once they mature to enough confirmations (ANTI_REORG_DELAY)
635 #[derive(Clone, PartialEq)]
637 /// HTLC output getting solved by a timeout, at maturation we pass upstream payment source information to solve
638 /// inbound HTLC in backward channel. Note, in case of preimage, we pass info to upstream without delay as we can
639 /// only win from it, so it's never an OnchainEvent
641 htlc_update: (HTLCSource, PaymentHash),
644 descriptor: SpendableOutputDescriptor,
648 const SERIALIZATION_VERSION: u8 = 1;
649 const MIN_SERIALIZATION_VERSION: u8 = 1;
651 #[cfg_attr(test, derive(PartialEq))]
653 pub(super) enum ChannelMonitorUpdateStep {
654 LatestLocalCommitmentTXInfo {
655 commitment_tx: LocalCommitmentTransaction,
656 htlc_outputs: Vec<(HTLCOutputInCommitment, Option<Signature>, Option<HTLCSource>)>,
658 LatestRemoteCommitmentTXInfo {
659 unsigned_commitment_tx: Transaction, // TODO: We should actually only need the txid here
660 htlc_outputs: Vec<(HTLCOutputInCommitment, Option<Box<HTLCSource>>)>,
661 commitment_number: u64,
662 their_revocation_point: PublicKey,
665 payment_preimage: PaymentPreimage,
671 /// Used to indicate that the no future updates will occur, and likely that the latest local
672 /// commitment transaction(s) should be broadcast, as the channel has been force-closed.
674 /// If set to false, we shouldn't broadcast the latest local commitment transaction as we
675 /// think we've fallen behind!
676 should_broadcast: bool,
680 impl Writeable for ChannelMonitorUpdateStep {
681 fn write<W: Writer>(&self, w: &mut W) -> Result<(), ::std::io::Error> {
683 &ChannelMonitorUpdateStep::LatestLocalCommitmentTXInfo { ref commitment_tx, ref htlc_outputs } => {
685 commitment_tx.write(w)?;
686 (htlc_outputs.len() as u64).write(w)?;
687 for &(ref output, ref signature, ref source) in htlc_outputs.iter() {
693 &ChannelMonitorUpdateStep::LatestRemoteCommitmentTXInfo { ref unsigned_commitment_tx, ref htlc_outputs, ref commitment_number, ref their_revocation_point } => {
695 unsigned_commitment_tx.write(w)?;
696 commitment_number.write(w)?;
697 their_revocation_point.write(w)?;
698 (htlc_outputs.len() as u64).write(w)?;
699 for &(ref output, ref source) in htlc_outputs.iter() {
701 source.as_ref().map(|b| b.as_ref()).write(w)?;
704 &ChannelMonitorUpdateStep::PaymentPreimage { ref payment_preimage } => {
706 payment_preimage.write(w)?;
708 &ChannelMonitorUpdateStep::CommitmentSecret { ref idx, ref secret } => {
713 &ChannelMonitorUpdateStep::ChannelForceClosed { ref should_broadcast } => {
715 should_broadcast.write(w)?;
721 impl Readable for ChannelMonitorUpdateStep {
722 fn read<R: ::std::io::Read>(r: &mut R) -> Result<Self, DecodeError> {
723 match Readable::read(r)? {
725 Ok(ChannelMonitorUpdateStep::LatestLocalCommitmentTXInfo {
726 commitment_tx: Readable::read(r)?,
728 let len: u64 = Readable::read(r)?;
729 let mut res = Vec::new();
731 res.push((Readable::read(r)?, Readable::read(r)?, Readable::read(r)?));
738 Ok(ChannelMonitorUpdateStep::LatestRemoteCommitmentTXInfo {
739 unsigned_commitment_tx: Readable::read(r)?,
740 commitment_number: Readable::read(r)?,
741 their_revocation_point: Readable::read(r)?,
743 let len: u64 = Readable::read(r)?;
744 let mut res = Vec::new();
746 res.push((Readable::read(r)?, <Option<HTLCSource> as Readable>::read(r)?.map(|o| Box::new(o))));
753 Ok(ChannelMonitorUpdateStep::PaymentPreimage {
754 payment_preimage: Readable::read(r)?,
758 Ok(ChannelMonitorUpdateStep::CommitmentSecret {
759 idx: Readable::read(r)?,
760 secret: Readable::read(r)?,
764 Ok(ChannelMonitorUpdateStep::ChannelForceClosed {
765 should_broadcast: Readable::read(r)?
768 _ => Err(DecodeError::InvalidValue),
773 /// A ChannelMonitor handles chain events (blocks connected and disconnected) and generates
774 /// on-chain transactions to ensure no loss of funds occurs.
776 /// You MUST ensure that no ChannelMonitors for a given channel anywhere contain out-of-date
777 /// information and are actively monitoring the chain.
779 /// Pending Events or updated HTLCs which have not yet been read out by
780 /// get_and_clear_pending_htlcs_updated or get_and_clear_pending_events are serialized to disk and
781 /// reloaded at deserialize-time. Thus, you must ensure that, when handling events, all events
782 /// gotten are fully handled before re-serializing the new state.
783 pub struct ChannelMonitor<ChanSigner: ChannelKeys> {
784 latest_update_id: u64,
785 commitment_transaction_number_obscure_factor: u64,
787 destination_script: Script,
788 broadcasted_local_revokable_script: Option<(Script, PublicKey, PublicKey)>,
789 remote_payment_script: Script,
790 shutdown_script: Script,
793 funding_info: (OutPoint, Script),
794 current_remote_commitment_txid: Option<Txid>,
795 prev_remote_commitment_txid: Option<Txid>,
797 remote_tx_cache: RemoteCommitmentTransaction,
798 funding_redeemscript: Script,
799 channel_value_satoshis: u64,
800 // first is the idx of the first of the two revocation points
801 their_cur_revocation_points: Option<(u64, PublicKey, Option<PublicKey>)>,
803 on_local_tx_csv: u16,
805 commitment_secrets: CounterpartyCommitmentSecrets,
806 remote_claimable_outpoints: HashMap<Txid, Vec<(HTLCOutputInCommitment, Option<Box<HTLCSource>>)>>,
807 /// We cannot identify HTLC-Success or HTLC-Timeout transactions by themselves on the chain.
808 /// Nor can we figure out their commitment numbers without the commitment transaction they are
809 /// spending. Thus, in order to claim them via revocation key, we track all the remote
810 /// commitment transactions which we find on-chain, mapping them to the commitment number which
811 /// can be used to derive the revocation key and claim the transactions.
812 remote_commitment_txn_on_chain: HashMap<Txid, (u64, Vec<Script>)>,
813 /// Cache used to make pruning of payment_preimages faster.
814 /// Maps payment_hash values to commitment numbers for remote transactions for non-revoked
815 /// remote transactions (ie should remain pretty small).
816 /// Serialized to disk but should generally not be sent to Watchtowers.
817 remote_hash_commitment_number: HashMap<PaymentHash, u64>,
819 // We store two local commitment transactions to avoid any race conditions where we may update
820 // some monitors (potentially on watchtowers) but then fail to update others, resulting in the
821 // various monitors for one channel being out of sync, and us broadcasting a local
822 // transaction for which we have deleted claim information on some watchtowers.
823 prev_local_signed_commitment_tx: Option<LocalSignedTx>,
824 current_local_commitment_tx: LocalSignedTx,
826 // Used just for ChannelManager to make sure it has the latest channel data during
828 current_remote_commitment_number: u64,
829 // Used just for ChannelManager to make sure it has the latest channel data during
831 current_local_commitment_number: u64,
833 payment_preimages: HashMap<PaymentHash, PaymentPreimage>,
835 pending_htlcs_updated: Vec<HTLCUpdate>,
836 pending_events: Vec<events::Event>,
838 // Used to track onchain events, i.e transactions parts of channels confirmed on chain, on which
839 // we have to take actions once they reach enough confs. Key is a block height timer, i.e we enforce
840 // actions when we receive a block with given height. Actions depend on OnchainEvent type.
841 onchain_events_waiting_threshold_conf: HashMap<u32, Vec<OnchainEvent>>,
843 // If we get serialized out and re-read, we need to make sure that the chain monitoring
844 // interface knows about the TXOs that we want to be notified of spends of. We could probably
845 // be smart and derive them from the above storage fields, but its much simpler and more
846 // Obviously Correct (tm) if we just keep track of them explicitly.
847 outputs_to_watch: HashMap<Txid, Vec<Script>>,
850 pub onchain_tx_handler: OnchainTxHandler<ChanSigner>,
852 onchain_tx_handler: OnchainTxHandler<ChanSigner>,
854 // This is set when the Channel[Manager] generated a ChannelMonitorUpdate which indicated the
855 // channel has been force-closed. After this is set, no further local commitment transaction
856 // updates may occur, and we panic!() if one is provided.
857 lockdown_from_offchain: bool,
859 // Set once we've signed a local commitment transaction and handed it over to our
860 // OnchainTxHandler. After this is set, no future updates to our local commitment transactions
861 // may occur, and we fail any such monitor updates.
862 local_tx_signed: bool,
864 // We simply modify last_block_hash in Channel's block_connected so that serialization is
865 // consistent but hopefully the users' copy handles block_connected in a consistent way.
866 // (we do *not*, however, update them in update_monitor to ensure any local user copies keep
867 // their last_block_hash from its state and not based on updated copies that didn't run through
868 // the full block_connected).
869 pub(crate) last_block_hash: BlockHash,
870 secp_ctx: Secp256k1<secp256k1::All>, //TODO: dedup this a bit...
873 #[cfg(any(test, feature = "fuzztarget"))]
874 /// Used only in testing and fuzztarget to check serialization roundtrips don't change the
875 /// underlying object
876 impl<ChanSigner: ChannelKeys> PartialEq for ChannelMonitor<ChanSigner> {
877 fn eq(&self, other: &Self) -> bool {
878 if self.latest_update_id != other.latest_update_id ||
879 self.commitment_transaction_number_obscure_factor != other.commitment_transaction_number_obscure_factor ||
880 self.destination_script != other.destination_script ||
881 self.broadcasted_local_revokable_script != other.broadcasted_local_revokable_script ||
882 self.remote_payment_script != other.remote_payment_script ||
883 self.keys.pubkeys() != other.keys.pubkeys() ||
884 self.funding_info != other.funding_info ||
885 self.current_remote_commitment_txid != other.current_remote_commitment_txid ||
886 self.prev_remote_commitment_txid != other.prev_remote_commitment_txid ||
887 self.remote_tx_cache != other.remote_tx_cache ||
888 self.funding_redeemscript != other.funding_redeemscript ||
889 self.channel_value_satoshis != other.channel_value_satoshis ||
890 self.their_cur_revocation_points != other.their_cur_revocation_points ||
891 self.on_local_tx_csv != other.on_local_tx_csv ||
892 self.commitment_secrets != other.commitment_secrets ||
893 self.remote_claimable_outpoints != other.remote_claimable_outpoints ||
894 self.remote_commitment_txn_on_chain != other.remote_commitment_txn_on_chain ||
895 self.remote_hash_commitment_number != other.remote_hash_commitment_number ||
896 self.prev_local_signed_commitment_tx != other.prev_local_signed_commitment_tx ||
897 self.current_remote_commitment_number != other.current_remote_commitment_number ||
898 self.current_local_commitment_number != other.current_local_commitment_number ||
899 self.current_local_commitment_tx != other.current_local_commitment_tx ||
900 self.payment_preimages != other.payment_preimages ||
901 self.pending_htlcs_updated != other.pending_htlcs_updated ||
902 self.pending_events.len() != other.pending_events.len() || // We trust events to round-trip properly
903 self.onchain_events_waiting_threshold_conf != other.onchain_events_waiting_threshold_conf ||
904 self.outputs_to_watch != other.outputs_to_watch ||
905 self.lockdown_from_offchain != other.lockdown_from_offchain ||
906 self.local_tx_signed != other.local_tx_signed
915 impl<ChanSigner: ChannelKeys + Writeable> ChannelMonitor<ChanSigner> {
916 /// Writes this monitor into the given writer, suitable for writing to disk.
918 /// Note that the deserializer is only implemented for (Sha256dHash, ChannelMonitor), which
919 /// tells you the last block hash which was block_connect()ed. You MUST rescan any blocks along
920 /// the "reorg path" (ie disconnecting blocks until you find a common ancestor from both the
921 /// returned block hash and the the current chain and then reconnecting blocks to get to the
922 /// best chain) upon deserializing the object!
923 pub fn write_for_disk<W: Writer>(&self, writer: &mut W) -> Result<(), ::std::io::Error> {
924 //TODO: We still write out all the serialization here manually instead of using the fancy
925 //serialization framework we have, we should migrate things over to it.
926 writer.write_all(&[SERIALIZATION_VERSION; 1])?;
927 writer.write_all(&[MIN_SERIALIZATION_VERSION; 1])?;
929 self.latest_update_id.write(writer)?;
931 // Set in initial Channel-object creation, so should always be set by now:
932 U48(self.commitment_transaction_number_obscure_factor).write(writer)?;
934 self.destination_script.write(writer)?;
935 if let Some(ref broadcasted_local_revokable_script) = self.broadcasted_local_revokable_script {
936 writer.write_all(&[0; 1])?;
937 broadcasted_local_revokable_script.0.write(writer)?;
938 broadcasted_local_revokable_script.1.write(writer)?;
939 broadcasted_local_revokable_script.2.write(writer)?;
941 writer.write_all(&[1; 1])?;
944 self.remote_payment_script.write(writer)?;
945 self.shutdown_script.write(writer)?;
947 self.keys.write(writer)?;
948 writer.write_all(&self.funding_info.0.txid[..])?;
949 writer.write_all(&byte_utils::be16_to_array(self.funding_info.0.index))?;
950 self.funding_info.1.write(writer)?;
951 self.current_remote_commitment_txid.write(writer)?;
952 self.prev_remote_commitment_txid.write(writer)?;
954 self.remote_tx_cache.write(writer)?;
955 self.funding_redeemscript.write(writer)?;
956 self.channel_value_satoshis.write(writer)?;
958 match self.their_cur_revocation_points {
959 Some((idx, pubkey, second_option)) => {
960 writer.write_all(&byte_utils::be48_to_array(idx))?;
961 writer.write_all(&pubkey.serialize())?;
962 match second_option {
963 Some(second_pubkey) => {
964 writer.write_all(&second_pubkey.serialize())?;
967 writer.write_all(&[0; 33])?;
972 writer.write_all(&byte_utils::be48_to_array(0))?;
976 writer.write_all(&byte_utils::be16_to_array(self.on_local_tx_csv))?;
978 self.commitment_secrets.write(writer)?;
980 macro_rules! serialize_htlc_in_commitment {
981 ($htlc_output: expr) => {
982 writer.write_all(&[$htlc_output.offered as u8; 1])?;
983 writer.write_all(&byte_utils::be64_to_array($htlc_output.amount_msat))?;
984 writer.write_all(&byte_utils::be32_to_array($htlc_output.cltv_expiry))?;
985 writer.write_all(&$htlc_output.payment_hash.0[..])?;
986 $htlc_output.transaction_output_index.write(writer)?;
990 writer.write_all(&byte_utils::be64_to_array(self.remote_claimable_outpoints.len() as u64))?;
991 for (ref txid, ref htlc_infos) in self.remote_claimable_outpoints.iter() {
992 writer.write_all(&txid[..])?;
993 writer.write_all(&byte_utils::be64_to_array(htlc_infos.len() as u64))?;
994 for &(ref htlc_output, ref htlc_source) in htlc_infos.iter() {
995 serialize_htlc_in_commitment!(htlc_output);
996 htlc_source.as_ref().map(|b| b.as_ref()).write(writer)?;
1000 writer.write_all(&byte_utils::be64_to_array(self.remote_commitment_txn_on_chain.len() as u64))?;
1001 for (ref txid, &(commitment_number, ref txouts)) in self.remote_commitment_txn_on_chain.iter() {
1002 writer.write_all(&txid[..])?;
1003 writer.write_all(&byte_utils::be48_to_array(commitment_number))?;
1004 (txouts.len() as u64).write(writer)?;
1005 for script in txouts.iter() {
1006 script.write(writer)?;
1010 writer.write_all(&byte_utils::be64_to_array(self.remote_hash_commitment_number.len() as u64))?;
1011 for (ref payment_hash, commitment_number) in self.remote_hash_commitment_number.iter() {
1012 writer.write_all(&payment_hash.0[..])?;
1013 writer.write_all(&byte_utils::be48_to_array(*commitment_number))?;
1016 macro_rules! serialize_local_tx {
1017 ($local_tx: expr) => {
1018 $local_tx.txid.write(writer)?;
1019 writer.write_all(&$local_tx.revocation_key.serialize())?;
1020 writer.write_all(&$local_tx.a_htlc_key.serialize())?;
1021 writer.write_all(&$local_tx.b_htlc_key.serialize())?;
1022 writer.write_all(&$local_tx.delayed_payment_key.serialize())?;
1023 writer.write_all(&$local_tx.per_commitment_point.serialize())?;
1025 writer.write_all(&byte_utils::be64_to_array($local_tx.feerate_per_kw))?;
1026 writer.write_all(&byte_utils::be64_to_array($local_tx.htlc_outputs.len() as u64))?;
1027 for &(ref htlc_output, ref sig, ref htlc_source) in $local_tx.htlc_outputs.iter() {
1028 serialize_htlc_in_commitment!(htlc_output);
1029 if let &Some(ref their_sig) = sig {
1031 writer.write_all(&their_sig.serialize_compact())?;
1035 htlc_source.write(writer)?;
1040 if let Some(ref prev_local_tx) = self.prev_local_signed_commitment_tx {
1041 writer.write_all(&[1; 1])?;
1042 serialize_local_tx!(prev_local_tx);
1044 writer.write_all(&[0; 1])?;
1047 serialize_local_tx!(self.current_local_commitment_tx);
1049 writer.write_all(&byte_utils::be48_to_array(self.current_remote_commitment_number))?;
1050 writer.write_all(&byte_utils::be48_to_array(self.current_local_commitment_number))?;
1052 writer.write_all(&byte_utils::be64_to_array(self.payment_preimages.len() as u64))?;
1053 for payment_preimage in self.payment_preimages.values() {
1054 writer.write_all(&payment_preimage.0[..])?;
1057 writer.write_all(&byte_utils::be64_to_array(self.pending_htlcs_updated.len() as u64))?;
1058 for data in self.pending_htlcs_updated.iter() {
1059 data.write(writer)?;
1062 writer.write_all(&byte_utils::be64_to_array(self.pending_events.len() as u64))?;
1063 for event in self.pending_events.iter() {
1064 event.write(writer)?;
1067 self.last_block_hash.write(writer)?;
1069 writer.write_all(&byte_utils::be64_to_array(self.onchain_events_waiting_threshold_conf.len() as u64))?;
1070 for (ref target, ref events) in self.onchain_events_waiting_threshold_conf.iter() {
1071 writer.write_all(&byte_utils::be32_to_array(**target))?;
1072 writer.write_all(&byte_utils::be64_to_array(events.len() as u64))?;
1073 for ev in events.iter() {
1075 OnchainEvent::HTLCUpdate { ref htlc_update } => {
1077 htlc_update.0.write(writer)?;
1078 htlc_update.1.write(writer)?;
1080 OnchainEvent::MaturingOutput { ref descriptor } => {
1082 descriptor.write(writer)?;
1088 (self.outputs_to_watch.len() as u64).write(writer)?;
1089 for (txid, output_scripts) in self.outputs_to_watch.iter() {
1090 txid.write(writer)?;
1091 (output_scripts.len() as u64).write(writer)?;
1092 for script in output_scripts.iter() {
1093 script.write(writer)?;
1096 self.onchain_tx_handler.write(writer)?;
1098 self.lockdown_from_offchain.write(writer)?;
1099 self.local_tx_signed.write(writer)?;
1105 impl<ChanSigner: ChannelKeys> ChannelMonitor<ChanSigner> {
1106 pub(super) fn new(keys: ChanSigner, shutdown_pubkey: &PublicKey,
1107 on_remote_tx_csv: u16, destination_script: &Script, funding_info: (OutPoint, Script),
1108 remote_htlc_base_key: &PublicKey, remote_delayed_payment_base_key: &PublicKey,
1109 on_local_tx_csv: u16, funding_redeemscript: Script, channel_value_satoshis: u64,
1110 commitment_transaction_number_obscure_factor: u64,
1111 initial_local_commitment_tx: LocalCommitmentTransaction) -> ChannelMonitor<ChanSigner> {
1113 assert!(commitment_transaction_number_obscure_factor <= (1 << 48));
1114 let our_channel_close_key_hash = WPubkeyHash::hash(&shutdown_pubkey.serialize());
1115 let shutdown_script = Builder::new().push_opcode(opcodes::all::OP_PUSHBYTES_0).push_slice(&our_channel_close_key_hash[..]).into_script();
1116 let payment_key_hash = WPubkeyHash::hash(&keys.pubkeys().payment_point.serialize());
1117 let remote_payment_script = Builder::new().push_opcode(opcodes::all::OP_PUSHBYTES_0).push_slice(&payment_key_hash[..]).into_script();
1119 let remote_tx_cache = RemoteCommitmentTransaction { remote_delayed_payment_base_key: *remote_delayed_payment_base_key, remote_htlc_base_key: *remote_htlc_base_key, on_remote_tx_csv, per_htlc: HashMap::new() };
1121 let mut onchain_tx_handler = OnchainTxHandler::new(destination_script.clone(), keys.clone(), on_local_tx_csv);
1123 let local_tx_sequence = initial_local_commitment_tx.unsigned_tx.input[0].sequence as u64;
1124 let local_tx_locktime = initial_local_commitment_tx.unsigned_tx.lock_time as u64;
1125 let local_commitment_tx = LocalSignedTx {
1126 txid: initial_local_commitment_tx.txid(),
1127 revocation_key: initial_local_commitment_tx.local_keys.revocation_key,
1128 a_htlc_key: initial_local_commitment_tx.local_keys.a_htlc_key,
1129 b_htlc_key: initial_local_commitment_tx.local_keys.b_htlc_key,
1130 delayed_payment_key: initial_local_commitment_tx.local_keys.a_delayed_payment_key,
1131 per_commitment_point: initial_local_commitment_tx.local_keys.per_commitment_point,
1132 feerate_per_kw: initial_local_commitment_tx.feerate_per_kw,
1133 htlc_outputs: Vec::new(), // There are never any HTLCs in the initial commitment transactions
1135 // Returning a monitor error before updating tracking points means in case of using
1136 // a concurrent watchtower implementation for same channel, if this one doesn't
1137 // reject update as we do, you MAY have the latest local valid commitment tx onchain
1138 // for which you want to spend outputs. We're NOT robust again this scenario right
1139 // now but we should consider it later.
1140 onchain_tx_handler.provide_latest_local_tx(initial_local_commitment_tx).unwrap();
1143 latest_update_id: 0,
1144 commitment_transaction_number_obscure_factor,
1146 destination_script: destination_script.clone(),
1147 broadcasted_local_revokable_script: None,
1148 remote_payment_script,
1153 current_remote_commitment_txid: None,
1154 prev_remote_commitment_txid: None,
1157 funding_redeemscript,
1158 channel_value_satoshis: channel_value_satoshis,
1159 their_cur_revocation_points: None,
1163 commitment_secrets: CounterpartyCommitmentSecrets::new(),
1164 remote_claimable_outpoints: HashMap::new(),
1165 remote_commitment_txn_on_chain: HashMap::new(),
1166 remote_hash_commitment_number: HashMap::new(),
1168 prev_local_signed_commitment_tx: None,
1169 current_local_commitment_tx: local_commitment_tx,
1170 current_remote_commitment_number: 1 << 48,
1171 current_local_commitment_number: 0xffff_ffff_ffff - ((((local_tx_sequence & 0xffffff) << 3*8) | (local_tx_locktime as u64 & 0xffffff)) ^ commitment_transaction_number_obscure_factor),
1173 payment_preimages: HashMap::new(),
1174 pending_htlcs_updated: Vec::new(),
1175 pending_events: Vec::new(),
1177 onchain_events_waiting_threshold_conf: HashMap::new(),
1178 outputs_to_watch: HashMap::new(),
1182 lockdown_from_offchain: false,
1183 local_tx_signed: false,
1185 last_block_hash: Default::default(),
1186 secp_ctx: Secp256k1::new(),
1190 /// Inserts a revocation secret into this channel monitor. Prunes old preimages if neither
1191 /// needed by local commitment transactions HTCLs nor by remote ones. Unless we haven't already seen remote
1192 /// commitment transaction's secret, they are de facto pruned (we can use revocation key).
1193 pub(super) fn provide_secret(&mut self, idx: u64, secret: [u8; 32]) -> Result<(), MonitorUpdateError> {
1194 if let Err(()) = self.commitment_secrets.provide_secret(idx, secret) {
1195 return Err(MonitorUpdateError("Previous secret did not match new one"));
1198 // Prune HTLCs from the previous remote commitment tx so we don't generate failure/fulfill
1199 // events for now-revoked/fulfilled HTLCs.
1200 if let Some(txid) = self.prev_remote_commitment_txid.take() {
1201 for &mut (_, ref mut source) in self.remote_claimable_outpoints.get_mut(&txid).unwrap() {
1206 if !self.payment_preimages.is_empty() {
1207 let cur_local_signed_commitment_tx = &self.current_local_commitment_tx;
1208 let prev_local_signed_commitment_tx = self.prev_local_signed_commitment_tx.as_ref();
1209 let min_idx = self.get_min_seen_secret();
1210 let remote_hash_commitment_number = &mut self.remote_hash_commitment_number;
1212 self.payment_preimages.retain(|&k, _| {
1213 for &(ref htlc, _, _) in cur_local_signed_commitment_tx.htlc_outputs.iter() {
1214 if k == htlc.payment_hash {
1218 if let Some(prev_local_commitment_tx) = prev_local_signed_commitment_tx {
1219 for &(ref htlc, _, _) in prev_local_commitment_tx.htlc_outputs.iter() {
1220 if k == htlc.payment_hash {
1225 let contains = if let Some(cn) = remote_hash_commitment_number.get(&k) {
1232 remote_hash_commitment_number.remove(&k);
1241 /// Informs this monitor of the latest remote (ie non-broadcastable) commitment transaction.
1242 /// The monitor watches for it to be broadcasted and then uses the HTLC information (and
1243 /// possibly future revocation/preimage information) to claim outputs where possible.
1244 /// We cache also the mapping hash:commitment number to lighten pruning of old preimages by watchtowers.
1245 pub(super) fn provide_latest_remote_commitment_tx_info<L: Deref>(&mut self, unsigned_commitment_tx: &Transaction, htlc_outputs: Vec<(HTLCOutputInCommitment, Option<Box<HTLCSource>>)>, commitment_number: u64, their_revocation_point: PublicKey, logger: &L) where L::Target: Logger {
1246 // TODO: Encrypt the htlc_outputs data with the single-hash of the commitment transaction
1247 // so that a remote monitor doesn't learn anything unless there is a malicious close.
1248 // (only maybe, sadly we cant do the same for local info, as we need to be aware of
1250 for &(ref htlc, _) in &htlc_outputs {
1251 self.remote_hash_commitment_number.insert(htlc.payment_hash, commitment_number);
1254 let new_txid = unsigned_commitment_tx.txid();
1255 log_trace!(logger, "Tracking new remote commitment transaction with txid {} at commitment number {} with {} HTLC outputs", new_txid, commitment_number, htlc_outputs.len());
1256 log_trace!(logger, "New potential remote commitment transaction: {}", encode::serialize_hex(unsigned_commitment_tx));
1257 self.prev_remote_commitment_txid = self.current_remote_commitment_txid.take();
1258 self.current_remote_commitment_txid = Some(new_txid);
1259 self.remote_claimable_outpoints.insert(new_txid, htlc_outputs.clone());
1260 self.current_remote_commitment_number = commitment_number;
1261 //TODO: Merge this into the other per-remote-transaction output storage stuff
1262 match self.their_cur_revocation_points {
1263 Some(old_points) => {
1264 if old_points.0 == commitment_number + 1 {
1265 self.their_cur_revocation_points = Some((old_points.0, old_points.1, Some(their_revocation_point)));
1266 } else if old_points.0 == commitment_number + 2 {
1267 if let Some(old_second_point) = old_points.2 {
1268 self.their_cur_revocation_points = Some((old_points.0 - 1, old_second_point, Some(their_revocation_point)));
1270 self.their_cur_revocation_points = Some((commitment_number, their_revocation_point, None));
1273 self.their_cur_revocation_points = Some((commitment_number, their_revocation_point, None));
1277 self.their_cur_revocation_points = Some((commitment_number, their_revocation_point, None));
1280 let mut htlcs = Vec::with_capacity(htlc_outputs.len());
1281 for htlc in htlc_outputs {
1282 if htlc.0.transaction_output_index.is_some() {
1286 self.remote_tx_cache.per_htlc.insert(new_txid, htlcs);
1289 /// Informs this monitor of the latest local (ie broadcastable) commitment transaction. The
1290 /// monitor watches for timeouts and may broadcast it if we approach such a timeout. Thus, it
1291 /// is important that any clones of this channel monitor (including remote clones) by kept
1292 /// up-to-date as our local commitment transaction is updated.
1293 /// Panics if set_on_local_tx_csv has never been called.
1294 pub(super) fn provide_latest_local_commitment_tx_info(&mut self, commitment_tx: LocalCommitmentTransaction, htlc_outputs: Vec<(HTLCOutputInCommitment, Option<Signature>, Option<HTLCSource>)>) -> Result<(), MonitorUpdateError> {
1295 if self.local_tx_signed {
1296 return Err(MonitorUpdateError("A local commitment tx has already been signed, no new local commitment txn can be sent to our counterparty"));
1298 let txid = commitment_tx.txid();
1299 let sequence = commitment_tx.unsigned_tx.input[0].sequence as u64;
1300 let locktime = commitment_tx.unsigned_tx.lock_time as u64;
1301 let mut new_local_commitment_tx = LocalSignedTx {
1303 revocation_key: commitment_tx.local_keys.revocation_key,
1304 a_htlc_key: commitment_tx.local_keys.a_htlc_key,
1305 b_htlc_key: commitment_tx.local_keys.b_htlc_key,
1306 delayed_payment_key: commitment_tx.local_keys.a_delayed_payment_key,
1307 per_commitment_point: commitment_tx.local_keys.per_commitment_point,
1308 feerate_per_kw: commitment_tx.feerate_per_kw,
1309 htlc_outputs: htlc_outputs,
1311 // Returning a monitor error before updating tracking points means in case of using
1312 // a concurrent watchtower implementation for same channel, if this one doesn't
1313 // reject update as we do, you MAY have the latest local valid commitment tx onchain
1314 // for which you want to spend outputs. We're NOT robust again this scenario right
1315 // now but we should consider it later.
1316 if let Err(_) = self.onchain_tx_handler.provide_latest_local_tx(commitment_tx) {
1317 return Err(MonitorUpdateError("Local commitment signed has already been signed, no further update of LOCAL commitment transaction is allowed"));
1319 self.current_local_commitment_number = 0xffff_ffff_ffff - ((((sequence & 0xffffff) << 3*8) | (locktime as u64 & 0xffffff)) ^ self.commitment_transaction_number_obscure_factor);
1320 mem::swap(&mut new_local_commitment_tx, &mut self.current_local_commitment_tx);
1321 self.prev_local_signed_commitment_tx = Some(new_local_commitment_tx);
1325 /// Provides a payment_hash->payment_preimage mapping. Will be automatically pruned when all
1326 /// commitment_tx_infos which contain the payment hash have been revoked.
1327 pub(super) fn provide_payment_preimage(&mut self, payment_hash: &PaymentHash, payment_preimage: &PaymentPreimage) {
1328 self.payment_preimages.insert(payment_hash.clone(), payment_preimage.clone());
1331 pub(super) fn broadcast_latest_local_commitment_txn<B: Deref, L: Deref>(&mut self, broadcaster: &B, logger: &L)
1332 where B::Target: BroadcasterInterface,
1335 for tx in self.get_latest_local_commitment_txn(logger).iter() {
1336 broadcaster.broadcast_transaction(tx);
1340 /// Used in Channel to cheat wrt the update_ids since it plays games, will be removed soon!
1341 pub(super) fn update_monitor_ooo<L: Deref>(&mut self, mut updates: ChannelMonitorUpdate, logger: &L) -> Result<(), MonitorUpdateError> where L::Target: Logger {
1342 for update in updates.updates.drain(..) {
1344 ChannelMonitorUpdateStep::LatestLocalCommitmentTXInfo { commitment_tx, htlc_outputs } => {
1345 if self.lockdown_from_offchain { panic!(); }
1346 self.provide_latest_local_commitment_tx_info(commitment_tx, htlc_outputs)?
1348 ChannelMonitorUpdateStep::LatestRemoteCommitmentTXInfo { unsigned_commitment_tx, htlc_outputs, commitment_number, their_revocation_point } =>
1349 self.provide_latest_remote_commitment_tx_info(&unsigned_commitment_tx, htlc_outputs, commitment_number, their_revocation_point, logger),
1350 ChannelMonitorUpdateStep::PaymentPreimage { payment_preimage } =>
1351 self.provide_payment_preimage(&PaymentHash(Sha256::hash(&payment_preimage.0[..]).into_inner()), &payment_preimage),
1352 ChannelMonitorUpdateStep::CommitmentSecret { idx, secret } =>
1353 self.provide_secret(idx, secret)?,
1354 ChannelMonitorUpdateStep::ChannelForceClosed { .. } => {},
1357 self.latest_update_id = updates.update_id;
1361 /// Updates a ChannelMonitor on the basis of some new information provided by the Channel
1364 /// panics if the given update is not the next update by update_id.
1365 pub fn update_monitor<B: Deref, L: Deref>(&mut self, mut updates: ChannelMonitorUpdate, broadcaster: &B, logger: &L) -> Result<(), MonitorUpdateError>
1366 where B::Target: BroadcasterInterface,
1369 if self.latest_update_id + 1 != updates.update_id {
1370 panic!("Attempted to apply ChannelMonitorUpdates out of order, check the update_id before passing an update to update_monitor!");
1372 for update in updates.updates.drain(..) {
1374 ChannelMonitorUpdateStep::LatestLocalCommitmentTXInfo { commitment_tx, htlc_outputs } => {
1375 if self.lockdown_from_offchain { panic!(); }
1376 self.provide_latest_local_commitment_tx_info(commitment_tx, htlc_outputs)?
1378 ChannelMonitorUpdateStep::LatestRemoteCommitmentTXInfo { unsigned_commitment_tx, htlc_outputs, commitment_number, their_revocation_point } =>
1379 self.provide_latest_remote_commitment_tx_info(&unsigned_commitment_tx, htlc_outputs, commitment_number, their_revocation_point, logger),
1380 ChannelMonitorUpdateStep::PaymentPreimage { payment_preimage } =>
1381 self.provide_payment_preimage(&PaymentHash(Sha256::hash(&payment_preimage.0[..]).into_inner()), &payment_preimage),
1382 ChannelMonitorUpdateStep::CommitmentSecret { idx, secret } =>
1383 self.provide_secret(idx, secret)?,
1384 ChannelMonitorUpdateStep::ChannelForceClosed { should_broadcast } => {
1385 self.lockdown_from_offchain = true;
1386 if should_broadcast {
1387 self.broadcast_latest_local_commitment_txn(broadcaster, logger);
1389 log_error!(logger, "You have a toxic local commitment transaction avaible in channel monitor, read comment in ChannelMonitor::get_latest_local_commitment_txn to be informed of manual action to take");
1394 self.latest_update_id = updates.update_id;
1398 /// Gets the update_id from the latest ChannelMonitorUpdate which was applied to this
1400 pub fn get_latest_update_id(&self) -> u64 {
1401 self.latest_update_id
1404 /// Gets the funding transaction outpoint of the channel this ChannelMonitor is monitoring for.
1405 pub fn get_funding_txo(&self) -> OutPoint {
1409 /// Gets a list of txids, with their output scripts (in the order they appear in the
1410 /// transaction), which we must learn about spends of via block_connected().
1411 pub fn get_outputs_to_watch(&self) -> &HashMap<Txid, Vec<Script>> {
1412 &self.outputs_to_watch
1415 /// Gets the sets of all outpoints which this ChannelMonitor expects to hear about spends of.
1416 /// Generally useful when deserializing as during normal operation the return values of
1417 /// block_connected are sufficient to ensure all relevant outpoints are being monitored (note
1418 /// that the get_funding_txo outpoint and transaction must also be monitored for!).
1419 pub fn get_monitored_outpoints(&self) -> Vec<(Txid, u32, &Script)> {
1420 let mut res = Vec::with_capacity(self.remote_commitment_txn_on_chain.len() * 2);
1421 for (ref txid, &(_, ref outputs)) in self.remote_commitment_txn_on_chain.iter() {
1422 for (idx, output) in outputs.iter().enumerate() {
1423 res.push(((*txid).clone(), idx as u32, output));
1429 /// Get the list of HTLCs who's status has been updated on chain. This should be called by
1430 /// ChannelManager via ManyChannelMonitor::get_and_clear_pending_htlcs_updated().
1431 pub fn get_and_clear_pending_htlcs_updated(&mut self) -> Vec<HTLCUpdate> {
1432 let mut ret = Vec::new();
1433 mem::swap(&mut ret, &mut self.pending_htlcs_updated);
1437 /// Gets the list of pending events which were generated by previous actions, clearing the list
1440 /// This is called by ManyChannelMonitor::get_and_clear_pending_events() and is equivalent to
1441 /// EventsProvider::get_and_clear_pending_events() except that it requires &mut self as we do
1442 /// no internal locking in ChannelMonitors.
1443 pub fn get_and_clear_pending_events(&mut self) -> Vec<events::Event> {
1444 let mut ret = Vec::new();
1445 mem::swap(&mut ret, &mut self.pending_events);
1449 /// Can only fail if idx is < get_min_seen_secret
1450 pub(super) fn get_secret(&self, idx: u64) -> Option<[u8; 32]> {
1451 self.commitment_secrets.get_secret(idx)
1454 pub(super) fn get_min_seen_secret(&self) -> u64 {
1455 self.commitment_secrets.get_min_seen_secret()
1458 pub(super) fn get_cur_remote_commitment_number(&self) -> u64 {
1459 self.current_remote_commitment_number
1462 pub(super) fn get_cur_local_commitment_number(&self) -> u64 {
1463 self.current_local_commitment_number
1466 /// Attempts to claim a remote commitment transaction's outputs using the revocation key and
1467 /// data in remote_claimable_outpoints. Will directly claim any HTLC outputs which expire at a
1468 /// height > height + CLTV_SHARED_CLAIM_BUFFER. In any case, will install monitoring for
1469 /// HTLC-Success/HTLC-Timeout transactions.
1470 /// Return updates for HTLC pending in the channel and failed automatically by the broadcast of
1471 /// revoked remote commitment tx
1472 fn check_spend_remote_transaction<L: Deref>(&mut self, tx: &Transaction, height: u32, logger: &L) -> (Vec<ClaimRequest>, (Txid, Vec<TxOut>)) where L::Target: Logger {
1473 // Most secp and related errors trying to create keys means we have no hope of constructing
1474 // a spend transaction...so we return no transactions to broadcast
1475 let mut claimable_outpoints = Vec::new();
1476 let mut watch_outputs = Vec::new();
1478 let commitment_txid = tx.txid(); //TODO: This is gonna be a performance bottleneck for watchtowers!
1479 let per_commitment_option = self.remote_claimable_outpoints.get(&commitment_txid);
1481 macro_rules! ignore_error {
1482 ( $thing : expr ) => {
1485 Err(_) => return (claimable_outpoints, (commitment_txid, watch_outputs))
1490 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);
1491 if commitment_number >= self.get_min_seen_secret() {
1492 let secret = self.get_secret(commitment_number).unwrap();
1493 let per_commitment_key = ignore_error!(SecretKey::from_slice(&secret));
1494 let per_commitment_point = PublicKey::from_secret_key(&self.secp_ctx, &per_commitment_key);
1495 let revocation_pubkey = ignore_error!(chan_utils::derive_public_revocation_key(&self.secp_ctx, &per_commitment_point, &self.keys.pubkeys().revocation_basepoint));
1496 let delayed_key = ignore_error!(chan_utils::derive_public_key(&self.secp_ctx, &PublicKey::from_secret_key(&self.secp_ctx, &per_commitment_key), &self.remote_tx_cache.remote_delayed_payment_base_key));
1498 let revokeable_redeemscript = chan_utils::get_revokeable_redeemscript(&revocation_pubkey, self.remote_tx_cache.on_remote_tx_csv, &delayed_key);
1499 let revokeable_p2wsh = revokeable_redeemscript.to_v0_p2wsh();
1501 // First, process non-htlc outputs (to_local & to_remote)
1502 for (idx, outp) in tx.output.iter().enumerate() {
1503 if outp.script_pubkey == revokeable_p2wsh {
1504 let witness_data = InputMaterial::Revoked { per_commitment_point, remote_delayed_payment_base_key: self.remote_tx_cache.remote_delayed_payment_base_key, remote_htlc_base_key: self.remote_tx_cache.remote_htlc_base_key, per_commitment_key, input_descriptor: InputDescriptors::RevokedOutput, amount: outp.value, htlc: None, on_remote_tx_csv: self.remote_tx_cache.on_remote_tx_csv};
1505 claimable_outpoints.push(ClaimRequest { absolute_timelock: height + self.remote_tx_cache.on_remote_tx_csv as u32, aggregable: true, outpoint: BitcoinOutPoint { txid: commitment_txid, vout: idx as u32 }, witness_data});
1509 // Then, try to find revoked htlc outputs
1510 if let Some(ref per_commitment_data) = per_commitment_option {
1511 for (_, &(ref htlc, _)) in per_commitment_data.iter().enumerate() {
1512 if let Some(transaction_output_index) = htlc.transaction_output_index {
1513 if transaction_output_index as usize >= tx.output.len() ||
1514 tx.output[transaction_output_index as usize].value != htlc.amount_msat / 1000 {
1515 return (claimable_outpoints, (commitment_txid, watch_outputs)); // Corrupted per_commitment_data, fuck this user
1517 let witness_data = InputMaterial::Revoked { per_commitment_point, remote_delayed_payment_base_key: self.remote_tx_cache.remote_delayed_payment_base_key, remote_htlc_base_key: self.remote_tx_cache.remote_htlc_base_key, per_commitment_key, input_descriptor: if htlc.offered { InputDescriptors::RevokedOfferedHTLC } else { InputDescriptors::RevokedReceivedHTLC }, amount: tx.output[transaction_output_index as usize].value, htlc: Some(htlc.clone()), on_remote_tx_csv: self.remote_tx_cache.on_remote_tx_csv};
1518 claimable_outpoints.push(ClaimRequest { absolute_timelock: htlc.cltv_expiry, aggregable: true, outpoint: BitcoinOutPoint { txid: commitment_txid, vout: transaction_output_index }, witness_data });
1523 // Last, track onchain revoked commitment transaction and fail backward outgoing HTLCs as payment path is broken
1524 if !claimable_outpoints.is_empty() || per_commitment_option.is_some() { // ie we're confident this is actually ours
1525 // We're definitely a remote commitment transaction!
1526 log_trace!(logger, "Got broadcast of revoked remote commitment transaction, going to generate general spend tx with {} inputs", claimable_outpoints.len());
1527 watch_outputs.append(&mut tx.output.clone());
1528 self.remote_commitment_txn_on_chain.insert(commitment_txid, (commitment_number, tx.output.iter().map(|output| { output.script_pubkey.clone() }).collect()));
1530 macro_rules! check_htlc_fails {
1531 ($txid: expr, $commitment_tx: expr) => {
1532 if let Some(ref outpoints) = self.remote_claimable_outpoints.get($txid) {
1533 for &(ref htlc, ref source_option) in outpoints.iter() {
1534 if let &Some(ref source) = source_option {
1535 log_info!(logger, "Failing HTLC with payment_hash {} from {} remote commitment tx due to broadcast of revoked remote commitment transaction, waiting for confirmation (at height {})", log_bytes!(htlc.payment_hash.0), $commitment_tx, height + ANTI_REORG_DELAY - 1);
1536 match self.onchain_events_waiting_threshold_conf.entry(height + ANTI_REORG_DELAY - 1) {
1537 hash_map::Entry::Occupied(mut entry) => {
1538 let e = entry.get_mut();
1539 e.retain(|ref event| {
1541 OnchainEvent::HTLCUpdate { ref htlc_update } => {
1542 return htlc_update.0 != **source
1547 e.push(OnchainEvent::HTLCUpdate { htlc_update: ((**source).clone(), htlc.payment_hash.clone())});
1549 hash_map::Entry::Vacant(entry) => {
1550 entry.insert(vec![OnchainEvent::HTLCUpdate { htlc_update: ((**source).clone(), htlc.payment_hash.clone())}]);
1558 if let Some(ref txid) = self.current_remote_commitment_txid {
1559 check_htlc_fails!(txid, "current");
1561 if let Some(ref txid) = self.prev_remote_commitment_txid {
1562 check_htlc_fails!(txid, "remote");
1564 // No need to check local commitment txn, symmetric HTLCSource must be present as per-htlc data on remote commitment tx
1566 } else if let Some(per_commitment_data) = per_commitment_option {
1567 // While this isn't useful yet, there is a potential race where if a counterparty
1568 // revokes a state at the same time as the commitment transaction for that state is
1569 // confirmed, and the watchtower receives the block before the user, the user could
1570 // upload a new ChannelMonitor with the revocation secret but the watchtower has
1571 // already processed the block, resulting in the remote_commitment_txn_on_chain entry
1572 // not being generated by the above conditional. Thus, to be safe, we go ahead and
1574 watch_outputs.append(&mut tx.output.clone());
1575 self.remote_commitment_txn_on_chain.insert(commitment_txid, (commitment_number, tx.output.iter().map(|output| { output.script_pubkey.clone() }).collect()));
1577 log_trace!(logger, "Got broadcast of non-revoked remote commitment transaction {}", commitment_txid);
1579 macro_rules! check_htlc_fails {
1580 ($txid: expr, $commitment_tx: expr, $id: tt) => {
1581 if let Some(ref latest_outpoints) = self.remote_claimable_outpoints.get($txid) {
1582 $id: for &(ref htlc, ref source_option) in latest_outpoints.iter() {
1583 if let &Some(ref source) = source_option {
1584 // Check if the HTLC is present in the commitment transaction that was
1585 // broadcast, but not if it was below the dust limit, which we should
1586 // fail backwards immediately as there is no way for us to learn the
1587 // payment_preimage.
1588 // Note that if the dust limit were allowed to change between
1589 // commitment transactions we'd want to be check whether *any*
1590 // broadcastable commitment transaction has the HTLC in it, but it
1591 // cannot currently change after channel initialization, so we don't
1593 for &(ref broadcast_htlc, ref broadcast_source) in per_commitment_data.iter() {
1594 if broadcast_htlc.transaction_output_index.is_some() && Some(source) == broadcast_source.as_ref() {
1598 log_trace!(logger, "Failing HTLC with payment_hash {} from {} remote commitment tx due to broadcast of remote commitment transaction", log_bytes!(htlc.payment_hash.0), $commitment_tx);
1599 match self.onchain_events_waiting_threshold_conf.entry(height + ANTI_REORG_DELAY - 1) {
1600 hash_map::Entry::Occupied(mut entry) => {
1601 let e = entry.get_mut();
1602 e.retain(|ref event| {
1604 OnchainEvent::HTLCUpdate { ref htlc_update } => {
1605 return htlc_update.0 != **source
1610 e.push(OnchainEvent::HTLCUpdate { htlc_update: ((**source).clone(), htlc.payment_hash.clone())});
1612 hash_map::Entry::Vacant(entry) => {
1613 entry.insert(vec![OnchainEvent::HTLCUpdate { htlc_update: ((**source).clone(), htlc.payment_hash.clone())}]);
1621 if let Some(ref txid) = self.current_remote_commitment_txid {
1622 check_htlc_fails!(txid, "current", 'current_loop);
1624 if let Some(ref txid) = self.prev_remote_commitment_txid {
1625 check_htlc_fails!(txid, "previous", 'prev_loop);
1628 if let Some(revocation_points) = self.their_cur_revocation_points {
1629 let revocation_point_option =
1630 if revocation_points.0 == commitment_number { Some(&revocation_points.1) }
1631 else if let Some(point) = revocation_points.2.as_ref() {
1632 if revocation_points.0 == commitment_number + 1 { Some(point) } else { None }
1634 if let Some(revocation_point) = revocation_point_option {
1635 self.remote_payment_script = {
1636 // Note that the Network here is ignored as we immediately drop the address for the
1637 // script_pubkey version
1638 let payment_hash160 = WPubkeyHash::hash(&PublicKey::from_secret_key(&self.secp_ctx, &self.keys.payment_key()).serialize());
1639 Builder::new().push_opcode(opcodes::all::OP_PUSHBYTES_0).push_slice(&payment_hash160[..]).into_script()
1642 // Then, try to find htlc outputs
1643 for (_, &(ref htlc, _)) in per_commitment_data.iter().enumerate() {
1644 if let Some(transaction_output_index) = htlc.transaction_output_index {
1645 if transaction_output_index as usize >= tx.output.len() ||
1646 tx.output[transaction_output_index as usize].value != htlc.amount_msat / 1000 {
1647 return (claimable_outpoints, (commitment_txid, watch_outputs)); // Corrupted per_commitment_data, fuck this user
1649 let preimage = if htlc.offered { if let Some(p) = self.payment_preimages.get(&htlc.payment_hash) { Some(*p) } else { None } } else { None };
1650 let aggregable = if !htlc.offered { false } else { true };
1651 if preimage.is_some() || !htlc.offered {
1652 let witness_data = InputMaterial::RemoteHTLC { per_commitment_point: *revocation_point, remote_delayed_payment_base_key: self.remote_tx_cache.remote_delayed_payment_base_key, remote_htlc_base_key: self.remote_tx_cache.remote_htlc_base_key, preimage, htlc: htlc.clone() };
1653 claimable_outpoints.push(ClaimRequest { absolute_timelock: htlc.cltv_expiry, aggregable, outpoint: BitcoinOutPoint { txid: commitment_txid, vout: transaction_output_index }, witness_data });
1660 (claimable_outpoints, (commitment_txid, watch_outputs))
1663 /// Attempts to claim a remote HTLC-Success/HTLC-Timeout's outputs using the revocation key
1664 fn check_spend_remote_htlc<L: Deref>(&mut self, tx: &Transaction, commitment_number: u64, height: u32, logger: &L) -> (Vec<ClaimRequest>, Option<(Txid, Vec<TxOut>)>) where L::Target: Logger {
1665 let htlc_txid = tx.txid();
1666 if tx.input.len() != 1 || tx.output.len() != 1 || tx.input[0].witness.len() != 5 {
1667 return (Vec::new(), None)
1670 macro_rules! ignore_error {
1671 ( $thing : expr ) => {
1674 Err(_) => return (Vec::new(), None)
1679 let secret = if let Some(secret) = self.get_secret(commitment_number) { secret } else { return (Vec::new(), None); };
1680 let per_commitment_key = ignore_error!(SecretKey::from_slice(&secret));
1681 let per_commitment_point = PublicKey::from_secret_key(&self.secp_ctx, &per_commitment_key);
1683 log_trace!(logger, "Remote HTLC broadcast {}:{}", htlc_txid, 0);
1684 let witness_data = InputMaterial::Revoked { per_commitment_point, remote_delayed_payment_base_key: self.remote_tx_cache.remote_delayed_payment_base_key, remote_htlc_base_key: self.remote_tx_cache.remote_htlc_base_key, per_commitment_key, input_descriptor: InputDescriptors::RevokedOutput, amount: tx.output[0].value, htlc: None, on_remote_tx_csv: self.remote_tx_cache.on_remote_tx_csv };
1685 let claimable_outpoints = vec!(ClaimRequest { absolute_timelock: height + self.remote_tx_cache.on_remote_tx_csv as u32, aggregable: true, outpoint: BitcoinOutPoint { txid: htlc_txid, vout: 0}, witness_data });
1686 (claimable_outpoints, Some((htlc_txid, tx.output.clone())))
1689 fn broadcast_by_local_state(&self, commitment_tx: &Transaction, local_tx: &LocalSignedTx) -> (Vec<ClaimRequest>, Vec<TxOut>, Option<(Script, PublicKey, PublicKey)>) {
1690 let mut claim_requests = Vec::with_capacity(local_tx.htlc_outputs.len());
1691 let mut watch_outputs = Vec::with_capacity(local_tx.htlc_outputs.len());
1693 let redeemscript = chan_utils::get_revokeable_redeemscript(&local_tx.revocation_key, self.on_local_tx_csv, &local_tx.delayed_payment_key);
1694 let broadcasted_local_revokable_script = Some((redeemscript.to_v0_p2wsh(), local_tx.per_commitment_point.clone(), local_tx.revocation_key.clone()));
1696 for &(ref htlc, _, _) in local_tx.htlc_outputs.iter() {
1697 if let Some(transaction_output_index) = htlc.transaction_output_index {
1698 claim_requests.push(ClaimRequest { absolute_timelock: ::std::u32::MAX, aggregable: false, outpoint: BitcoinOutPoint { txid: local_tx.txid, vout: transaction_output_index as u32 },
1699 witness_data: InputMaterial::LocalHTLC {
1700 preimage: if !htlc.offered {
1701 if let Some(preimage) = self.payment_preimages.get(&htlc.payment_hash) {
1702 Some(preimage.clone())
1704 // We can't build an HTLC-Success transaction without the preimage
1708 amount: htlc.amount_msat,
1710 watch_outputs.push(commitment_tx.output[transaction_output_index as usize].clone());
1714 (claim_requests, watch_outputs, broadcasted_local_revokable_script)
1717 /// Attempts to claim any claimable HTLCs in a commitment transaction which was not (yet)
1718 /// revoked using data in local_claimable_outpoints.
1719 /// Should not be used if check_spend_revoked_transaction succeeds.
1720 fn check_spend_local_transaction<L: Deref>(&mut self, tx: &Transaction, height: u32, logger: &L) -> (Vec<ClaimRequest>, (Txid, Vec<TxOut>)) where L::Target: Logger {
1721 let commitment_txid = tx.txid();
1722 let mut claim_requests = Vec::new();
1723 let mut watch_outputs = Vec::new();
1725 macro_rules! wait_threshold_conf {
1726 ($height: expr, $source: expr, $commitment_tx: expr, $payment_hash: expr) => {
1727 log_trace!(logger, "Failing HTLC with payment_hash {} from {} local commitment tx due to broadcast of transaction, waiting confirmation (at height{})", log_bytes!($payment_hash.0), $commitment_tx, height + ANTI_REORG_DELAY - 1);
1728 match self.onchain_events_waiting_threshold_conf.entry($height + ANTI_REORG_DELAY - 1) {
1729 hash_map::Entry::Occupied(mut entry) => {
1730 let e = entry.get_mut();
1731 e.retain(|ref event| {
1733 OnchainEvent::HTLCUpdate { ref htlc_update } => {
1734 return htlc_update.0 != $source
1739 e.push(OnchainEvent::HTLCUpdate { htlc_update: ($source, $payment_hash)});
1741 hash_map::Entry::Vacant(entry) => {
1742 entry.insert(vec![OnchainEvent::HTLCUpdate { htlc_update: ($source, $payment_hash)}]);
1748 macro_rules! append_onchain_update {
1749 ($updates: expr) => {
1750 claim_requests = $updates.0;
1751 watch_outputs.append(&mut $updates.1);
1752 self.broadcasted_local_revokable_script = $updates.2;
1756 // HTLCs set may differ between last and previous local commitment txn, in case of one them hitting chain, ensure we cancel all HTLCs backward
1757 let mut is_local_tx = false;
1759 if self.current_local_commitment_tx.txid == commitment_txid {
1761 log_trace!(logger, "Got latest local commitment tx broadcast, searching for available HTLCs to claim");
1762 let mut res = self.broadcast_by_local_state(tx, &self.current_local_commitment_tx);
1763 append_onchain_update!(res);
1764 } else if let &Some(ref local_tx) = &self.prev_local_signed_commitment_tx {
1765 if local_tx.txid == commitment_txid {
1767 log_trace!(logger, "Got previous local commitment tx broadcast, searching for available HTLCs to claim");
1768 let mut res = self.broadcast_by_local_state(tx, local_tx);
1769 append_onchain_update!(res);
1773 macro_rules! fail_dust_htlcs_after_threshold_conf {
1774 ($local_tx: expr) => {
1775 for &(ref htlc, _, ref source) in &$local_tx.htlc_outputs {
1776 if htlc.transaction_output_index.is_none() {
1777 if let &Some(ref source) = source {
1778 wait_threshold_conf!(height, source.clone(), "lastest", htlc.payment_hash.clone());
1786 fail_dust_htlcs_after_threshold_conf!(self.current_local_commitment_tx);
1787 if let &Some(ref local_tx) = &self.prev_local_signed_commitment_tx {
1788 fail_dust_htlcs_after_threshold_conf!(local_tx);
1792 (claim_requests, (commitment_txid, watch_outputs))
1795 /// Used by ChannelManager deserialization to broadcast the latest local state if its copy of
1796 /// the Channel was out-of-date. You may use it to get a broadcastable local toxic tx in case of
1797 /// fallen-behind, i.e when receiving a channel_reestablish with a proof that our remote side knows
1798 /// a higher revocation secret than the local commitment number we are aware of. Broadcasting these
1799 /// transactions are UNSAFE, as they allow remote side to punish you. Nevertheless you may want to
1800 /// broadcast them if remote don't close channel with his higher commitment transaction after a
1801 /// substantial amount of time (a month or even a year) to get back funds. Best may be to contact
1802 /// out-of-band the other node operator to coordinate with him if option is available to you.
1803 /// In any-case, choice is up to the user.
1804 pub fn get_latest_local_commitment_txn<L: Deref>(&mut self, logger: &L) -> Vec<Transaction> where L::Target: Logger {
1805 log_trace!(logger, "Getting signed latest local commitment transaction!");
1806 self.local_tx_signed = true;
1807 if let Some(commitment_tx) = self.onchain_tx_handler.get_fully_signed_local_tx(&self.funding_redeemscript) {
1808 let txid = commitment_tx.txid();
1809 let mut res = vec![commitment_tx];
1810 for htlc in self.current_local_commitment_tx.htlc_outputs.iter() {
1811 if let Some(vout) = htlc.0.transaction_output_index {
1812 let preimage = if !htlc.0.offered {
1813 if let Some(preimage) = self.payment_preimages.get(&htlc.0.payment_hash) { Some(preimage.clone()) } else {
1814 // We can't build an HTLC-Success transaction without the preimage
1818 if let Some(htlc_tx) = self.onchain_tx_handler.get_fully_signed_htlc_tx(
1819 &::bitcoin::OutPoint { txid, vout }, &preimage) {
1824 // 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.
1825 // The data will be re-generated and tracked in check_spend_local_transaction if we get a confirmation.
1831 /// Unsafe test-only version of get_latest_local_commitment_txn used by our test framework
1832 /// to bypass LocalCommitmentTransaction state update lockdown after signature and generate
1833 /// revoked commitment transaction.
1835 pub fn unsafe_get_latest_local_commitment_txn<L: Deref>(&mut self, logger: &L) -> Vec<Transaction> where L::Target: Logger {
1836 log_trace!(logger, "Getting signed copy of latest local commitment transaction!");
1837 if let Some(commitment_tx) = self.onchain_tx_handler.get_fully_signed_copy_local_tx(&self.funding_redeemscript) {
1838 let txid = commitment_tx.txid();
1839 let mut res = vec![commitment_tx];
1840 for htlc in self.current_local_commitment_tx.htlc_outputs.iter() {
1841 if let Some(vout) = htlc.0.transaction_output_index {
1842 let preimage = if !htlc.0.offered {
1843 if let Some(preimage) = self.payment_preimages.get(&htlc.0.payment_hash) { Some(preimage.clone()) } else {
1844 // We can't build an HTLC-Success transaction without the preimage
1848 if let Some(htlc_tx) = self.onchain_tx_handler.unsafe_get_fully_signed_htlc_tx(
1849 &::bitcoin::OutPoint { txid, vout }, &preimage) {
1859 /// Called by SimpleManyChannelMonitor::block_connected, which implements
1860 /// ChainListener::block_connected.
1861 /// Eventually this should be pub and, roughly, implement ChainListener, however this requires
1862 /// &mut self, as well as returns new spendable outputs and outpoints to watch for spending of
1864 fn block_connected<B: Deref, F: Deref, L: Deref>(&mut self, txn_matched: &[&Transaction], height: u32, block_hash: &BlockHash, broadcaster: B, fee_estimator: F, logger: L)-> Vec<(Txid, Vec<TxOut>)>
1865 where B::Target: BroadcasterInterface,
1866 F::Target: FeeEstimator,
1869 for tx in txn_matched {
1870 let mut output_val = 0;
1871 for out in tx.output.iter() {
1872 if out.value > 21_000_000_0000_0000 { panic!("Value-overflowing transaction provided to block connected"); }
1873 output_val += out.value;
1874 if output_val > 21_000_000_0000_0000 { panic!("Value-overflowing transaction provided to block connected"); }
1878 log_trace!(logger, "Block {} at height {} connected with {} txn matched", block_hash, height, txn_matched.len());
1879 let mut watch_outputs = Vec::new();
1880 let mut claimable_outpoints = Vec::new();
1881 for tx in txn_matched {
1882 if tx.input.len() == 1 {
1883 // Assuming our keys were not leaked (in which case we're screwed no matter what),
1884 // commitment transactions and HTLC transactions will all only ever have one input,
1885 // which is an easy way to filter out any potential non-matching txn for lazy
1887 let prevout = &tx.input[0].previous_output;
1888 if prevout.txid == self.funding_info.0.txid && prevout.vout == self.funding_info.0.index as u32 {
1889 if (tx.input[0].sequence >> 8*3) as u8 == 0x80 && (tx.lock_time >> 8*3) as u8 == 0x20 {
1890 let (mut new_outpoints, new_outputs) = self.check_spend_remote_transaction(&tx, height, &logger);
1891 if !new_outputs.1.is_empty() {
1892 watch_outputs.push(new_outputs);
1894 if new_outpoints.is_empty() {
1895 let (mut new_outpoints, new_outputs) = self.check_spend_local_transaction(&tx, height, &logger);
1896 if !new_outputs.1.is_empty() {
1897 watch_outputs.push(new_outputs);
1899 claimable_outpoints.append(&mut new_outpoints);
1901 claimable_outpoints.append(&mut new_outpoints);
1904 if let Some(&(commitment_number, _)) = self.remote_commitment_txn_on_chain.get(&prevout.txid) {
1905 let (mut new_outpoints, new_outputs_option) = self.check_spend_remote_htlc(&tx, commitment_number, height, &logger);
1906 claimable_outpoints.append(&mut new_outpoints);
1907 if let Some(new_outputs) = new_outputs_option {
1908 watch_outputs.push(new_outputs);
1913 // While all commitment/HTLC-Success/HTLC-Timeout transactions have one input, HTLCs
1914 // can also be resolved in a few other ways which can have more than one output. Thus,
1915 // we call is_resolving_htlc_output here outside of the tx.input.len() == 1 check.
1916 self.is_resolving_htlc_output(&tx, height, &logger);
1918 self.is_paying_spendable_output(&tx, height, &logger);
1920 let should_broadcast = self.would_broadcast_at_height(height, &logger);
1921 if should_broadcast {
1922 claimable_outpoints.push(ClaimRequest { absolute_timelock: height, aggregable: false, outpoint: BitcoinOutPoint { txid: self.funding_info.0.txid.clone(), vout: self.funding_info.0.index as u32 }, witness_data: InputMaterial::Funding { funding_redeemscript: self.funding_redeemscript.clone() }});
1924 if should_broadcast {
1925 if let Some(commitment_tx) = self.onchain_tx_handler.get_fully_signed_local_tx(&self.funding_redeemscript) {
1926 let (mut new_outpoints, new_outputs, _) = self.broadcast_by_local_state(&commitment_tx, &self.current_local_commitment_tx);
1927 if !new_outputs.is_empty() {
1928 watch_outputs.push((self.current_local_commitment_tx.txid.clone(), new_outputs));
1930 claimable_outpoints.append(&mut new_outpoints);
1933 if let Some(events) = self.onchain_events_waiting_threshold_conf.remove(&height) {
1936 OnchainEvent::HTLCUpdate { htlc_update } => {
1937 log_trace!(logger, "HTLC {} failure update has got enough confirmations to be passed upstream", log_bytes!((htlc_update.1).0));
1938 self.pending_htlcs_updated.push(HTLCUpdate {
1939 payment_hash: htlc_update.1,
1940 payment_preimage: None,
1941 source: htlc_update.0,
1944 OnchainEvent::MaturingOutput { descriptor } => {
1945 log_trace!(logger, "Descriptor {} has got enough confirmations to be passed upstream", log_spendable!(descriptor));
1946 self.pending_events.push(events::Event::SpendableOutputs {
1947 outputs: vec![descriptor]
1953 self.onchain_tx_handler.block_connected(txn_matched, claimable_outpoints, height, &*broadcaster, &*fee_estimator, &*logger);
1955 self.last_block_hash = block_hash.clone();
1956 for &(ref txid, ref output_scripts) in watch_outputs.iter() {
1957 self.outputs_to_watch.insert(txid.clone(), output_scripts.iter().map(|o| o.script_pubkey.clone()).collect());
1963 fn block_disconnected<B: Deref, F: Deref, L: Deref>(&mut self, height: u32, block_hash: &BlockHash, broadcaster: B, fee_estimator: F, logger: L)
1964 where B::Target: BroadcasterInterface,
1965 F::Target: FeeEstimator,
1968 log_trace!(logger, "Block {} at height {} disconnected", block_hash, height);
1969 if let Some(_) = self.onchain_events_waiting_threshold_conf.remove(&(height + ANTI_REORG_DELAY - 1)) {
1971 //- htlc update there as failure-trigger tx (revoked commitment tx, non-revoked commitment tx, HTLC-timeout tx) has been disconnected
1972 //- maturing spendable output has transaction paying us has been disconnected
1975 self.onchain_tx_handler.block_disconnected(height, broadcaster, fee_estimator, logger);
1977 self.last_block_hash = block_hash.clone();
1980 pub(super) fn would_broadcast_at_height<L: Deref>(&self, height: u32, logger: &L) -> bool where L::Target: Logger {
1981 // We need to consider all HTLCs which are:
1982 // * in any unrevoked remote commitment transaction, as they could broadcast said
1983 // transactions and we'd end up in a race, or
1984 // * are in our latest local commitment transaction, as this is the thing we will
1985 // broadcast if we go on-chain.
1986 // Note that we consider HTLCs which were below dust threshold here - while they don't
1987 // strictly imply that we need to fail the channel, we need to go ahead and fail them back
1988 // to the source, and if we don't fail the channel we will have to ensure that the next
1989 // updates that peer sends us are update_fails, failing the channel if not. It's probably
1990 // easier to just fail the channel as this case should be rare enough anyway.
1991 macro_rules! scan_commitment {
1992 ($htlcs: expr, $local_tx: expr) => {
1993 for ref htlc in $htlcs {
1994 // For inbound HTLCs which we know the preimage for, we have to ensure we hit the
1995 // chain with enough room to claim the HTLC without our counterparty being able to
1996 // time out the HTLC first.
1997 // For outbound HTLCs which our counterparty hasn't failed/claimed, our primary
1998 // concern is being able to claim the corresponding inbound HTLC (on another
1999 // channel) before it expires. In fact, we don't even really care if our
2000 // counterparty here claims such an outbound HTLC after it expired as long as we
2001 // can still claim the corresponding HTLC. Thus, to avoid needlessly hitting the
2002 // chain when our counterparty is waiting for expiration to off-chain fail an HTLC
2003 // we give ourselves a few blocks of headroom after expiration before going
2004 // on-chain for an expired HTLC.
2005 // Note that, to avoid a potential attack whereby a node delays claiming an HTLC
2006 // from us until we've reached the point where we go on-chain with the
2007 // corresponding inbound HTLC, we must ensure that outbound HTLCs go on chain at
2008 // least CLTV_CLAIM_BUFFER blocks prior to the inbound HTLC.
2009 // aka outbound_cltv + LATENCY_GRACE_PERIOD_BLOCKS == height - CLTV_CLAIM_BUFFER
2010 // inbound_cltv == height + CLTV_CLAIM_BUFFER
2011 // outbound_cltv + LATENCY_GRACE_PERIOD_BLOCKS + CLTV_CLAIM_BUFFER <= inbound_cltv - CLTV_CLAIM_BUFFER
2012 // LATENCY_GRACE_PERIOD_BLOCKS + 2*CLTV_CLAIM_BUFFER <= inbound_cltv - outbound_cltv
2013 // CLTV_EXPIRY_DELTA <= inbound_cltv - outbound_cltv (by check in ChannelManager::decode_update_add_htlc_onion)
2014 // LATENCY_GRACE_PERIOD_BLOCKS + 2*CLTV_CLAIM_BUFFER <= CLTV_EXPIRY_DELTA
2015 // The final, above, condition is checked for statically in channelmanager
2016 // with CHECK_CLTV_EXPIRY_SANITY_2.
2017 let htlc_outbound = $local_tx == htlc.offered;
2018 if ( htlc_outbound && htlc.cltv_expiry + LATENCY_GRACE_PERIOD_BLOCKS <= height) ||
2019 (!htlc_outbound && htlc.cltv_expiry <= height + CLTV_CLAIM_BUFFER && self.payment_preimages.contains_key(&htlc.payment_hash)) {
2020 log_info!(logger, "Force-closing channel due to {} HTLC timeout, HTLC expiry is {}", if htlc_outbound { "outbound" } else { "inbound "}, htlc.cltv_expiry);
2027 scan_commitment!(self.current_local_commitment_tx.htlc_outputs.iter().map(|&(ref a, _, _)| a), true);
2029 if let Some(ref txid) = self.current_remote_commitment_txid {
2030 if let Some(ref htlc_outputs) = self.remote_claimable_outpoints.get(txid) {
2031 scan_commitment!(htlc_outputs.iter().map(|&(ref a, _)| a), false);
2034 if let Some(ref txid) = self.prev_remote_commitment_txid {
2035 if let Some(ref htlc_outputs) = self.remote_claimable_outpoints.get(txid) {
2036 scan_commitment!(htlc_outputs.iter().map(|&(ref a, _)| a), false);
2043 /// Check if any transaction broadcasted is resolving HTLC output by a success or timeout on a local
2044 /// or remote commitment tx, if so send back the source, preimage if found and payment_hash of resolved HTLC
2045 fn is_resolving_htlc_output<L: Deref>(&mut self, tx: &Transaction, height: u32, logger: &L) where L::Target: Logger {
2046 'outer_loop: for input in &tx.input {
2047 let mut payment_data = None;
2048 let revocation_sig_claim = (input.witness.len() == 3 && HTLCType::scriptlen_to_htlctype(input.witness[2].len()) == Some(HTLCType::OfferedHTLC) && input.witness[1].len() == 33)
2049 || (input.witness.len() == 3 && HTLCType::scriptlen_to_htlctype(input.witness[2].len()) == Some(HTLCType::AcceptedHTLC) && input.witness[1].len() == 33);
2050 let accepted_preimage_claim = input.witness.len() == 5 && HTLCType::scriptlen_to_htlctype(input.witness[4].len()) == Some(HTLCType::AcceptedHTLC);
2051 let offered_preimage_claim = input.witness.len() == 3 && HTLCType::scriptlen_to_htlctype(input.witness[2].len()) == Some(HTLCType::OfferedHTLC);
2053 macro_rules! log_claim {
2054 ($tx_info: expr, $local_tx: expr, $htlc: expr, $source_avail: expr) => {
2055 // We found the output in question, but aren't failing it backwards
2056 // as we have no corresponding source and no valid remote commitment txid
2057 // to try a weak source binding with same-hash, same-value still-valid offered HTLC.
2058 // This implies either it is an inbound HTLC or an outbound HTLC on a revoked transaction.
2059 let outbound_htlc = $local_tx == $htlc.offered;
2060 if ($local_tx && revocation_sig_claim) ||
2061 (outbound_htlc && !$source_avail && (accepted_preimage_claim || offered_preimage_claim)) {
2062 log_error!(logger, "Input spending {} ({}:{}) in {} resolves {} HTLC with payment hash {} with {}!",
2063 $tx_info, input.previous_output.txid, input.previous_output.vout, tx.txid(),
2064 if outbound_htlc { "outbound" } else { "inbound" }, log_bytes!($htlc.payment_hash.0),
2065 if revocation_sig_claim { "revocation sig" } else { "preimage claim after we'd passed the HTLC resolution back" });
2067 log_info!(logger, "Input spending {} ({}:{}) in {} resolves {} HTLC with payment hash {} with {}",
2068 $tx_info, input.previous_output.txid, input.previous_output.vout, tx.txid(),
2069 if outbound_htlc { "outbound" } else { "inbound" }, log_bytes!($htlc.payment_hash.0),
2070 if revocation_sig_claim { "revocation sig" } else if accepted_preimage_claim || offered_preimage_claim { "preimage" } else { "timeout" });
2075 macro_rules! check_htlc_valid_remote {
2076 ($remote_txid: expr, $htlc_output: expr) => {
2077 if let Some(txid) = $remote_txid {
2078 for &(ref pending_htlc, ref pending_source) in self.remote_claimable_outpoints.get(&txid).unwrap() {
2079 if pending_htlc.payment_hash == $htlc_output.payment_hash && pending_htlc.amount_msat == $htlc_output.amount_msat {
2080 if let &Some(ref source) = pending_source {
2081 log_claim!("revoked remote commitment tx", false, pending_htlc, true);
2082 payment_data = Some(((**source).clone(), $htlc_output.payment_hash));
2091 macro_rules! scan_commitment {
2092 ($htlcs: expr, $tx_info: expr, $local_tx: expr) => {
2093 for (ref htlc_output, source_option) in $htlcs {
2094 if Some(input.previous_output.vout) == htlc_output.transaction_output_index {
2095 if let Some(ref source) = source_option {
2096 log_claim!($tx_info, $local_tx, htlc_output, true);
2097 // We have a resolution of an HTLC either from one of our latest
2098 // local commitment transactions or an unrevoked remote commitment
2099 // transaction. This implies we either learned a preimage, the HTLC
2100 // has timed out, or we screwed up. In any case, we should now
2101 // resolve the source HTLC with the original sender.
2102 payment_data = Some(((*source).clone(), htlc_output.payment_hash));
2103 } else if !$local_tx {
2104 check_htlc_valid_remote!(self.current_remote_commitment_txid, htlc_output);
2105 if payment_data.is_none() {
2106 check_htlc_valid_remote!(self.prev_remote_commitment_txid, htlc_output);
2109 if payment_data.is_none() {
2110 log_claim!($tx_info, $local_tx, htlc_output, false);
2111 continue 'outer_loop;
2118 if input.previous_output.txid == self.current_local_commitment_tx.txid {
2119 scan_commitment!(self.current_local_commitment_tx.htlc_outputs.iter().map(|&(ref a, _, ref b)| (a, b.as_ref())),
2120 "our latest local commitment tx", true);
2122 if let Some(ref prev_local_signed_commitment_tx) = self.prev_local_signed_commitment_tx {
2123 if input.previous_output.txid == prev_local_signed_commitment_tx.txid {
2124 scan_commitment!(prev_local_signed_commitment_tx.htlc_outputs.iter().map(|&(ref a, _, ref b)| (a, b.as_ref())),
2125 "our previous local commitment tx", true);
2128 if let Some(ref htlc_outputs) = self.remote_claimable_outpoints.get(&input.previous_output.txid) {
2129 scan_commitment!(htlc_outputs.iter().map(|&(ref a, ref b)| (a, (b.as_ref().clone()).map(|boxed| &**boxed))),
2130 "remote commitment tx", false);
2133 // Check that scan_commitment, above, decided there is some source worth relaying an
2134 // HTLC resolution backwards to and figure out whether we learned a preimage from it.
2135 if let Some((source, payment_hash)) = payment_data {
2136 let mut payment_preimage = PaymentPreimage([0; 32]);
2137 if accepted_preimage_claim {
2138 if !self.pending_htlcs_updated.iter().any(|update| update.source == source) {
2139 payment_preimage.0.copy_from_slice(&input.witness[3]);
2140 self.pending_htlcs_updated.push(HTLCUpdate {
2142 payment_preimage: Some(payment_preimage),
2146 } else if offered_preimage_claim {
2147 if !self.pending_htlcs_updated.iter().any(|update| update.source == source) {
2148 payment_preimage.0.copy_from_slice(&input.witness[1]);
2149 self.pending_htlcs_updated.push(HTLCUpdate {
2151 payment_preimage: Some(payment_preimage),
2156 log_info!(logger, "Failing HTLC with payment_hash {} timeout by a spend tx, waiting for confirmation (at height{})", log_bytes!(payment_hash.0), height + ANTI_REORG_DELAY - 1);
2157 match self.onchain_events_waiting_threshold_conf.entry(height + ANTI_REORG_DELAY - 1) {
2158 hash_map::Entry::Occupied(mut entry) => {
2159 let e = entry.get_mut();
2160 e.retain(|ref event| {
2162 OnchainEvent::HTLCUpdate { ref htlc_update } => {
2163 return htlc_update.0 != source
2168 e.push(OnchainEvent::HTLCUpdate { htlc_update: (source, payment_hash)});
2170 hash_map::Entry::Vacant(entry) => {
2171 entry.insert(vec![OnchainEvent::HTLCUpdate { htlc_update: (source, payment_hash)}]);
2179 /// Check if any transaction broadcasted is paying fund back to some address we can assume to own
2180 fn is_paying_spendable_output<L: Deref>(&mut self, tx: &Transaction, height: u32, logger: &L) where L::Target: Logger {
2181 let mut spendable_output = None;
2182 for (i, outp) in tx.output.iter().enumerate() { // There is max one spendable output for any channel tx, including ones generated by us
2183 if outp.script_pubkey == self.destination_script {
2184 spendable_output = Some(SpendableOutputDescriptor::StaticOutput {
2185 outpoint: BitcoinOutPoint { txid: tx.txid(), vout: i as u32 },
2186 output: outp.clone(),
2189 } else if let Some(ref broadcasted_local_revokable_script) = self.broadcasted_local_revokable_script {
2190 if broadcasted_local_revokable_script.0 == outp.script_pubkey {
2191 spendable_output = Some(SpendableOutputDescriptor::DynamicOutputP2WSH {
2192 outpoint: BitcoinOutPoint { txid: tx.txid(), vout: i as u32 },
2193 per_commitment_point: broadcasted_local_revokable_script.1,
2194 to_self_delay: self.on_local_tx_csv,
2195 output: outp.clone(),
2196 key_derivation_params: self.keys.key_derivation_params(),
2197 remote_revocation_pubkey: broadcasted_local_revokable_script.2.clone(),
2201 } else if self.remote_payment_script == outp.script_pubkey {
2202 spendable_output = Some(SpendableOutputDescriptor::DynamicOutputP2WPKH {
2203 outpoint: BitcoinOutPoint { txid: tx.txid(), vout: i as u32 },
2204 output: outp.clone(),
2205 key_derivation_params: self.keys.key_derivation_params(),
2208 } else if outp.script_pubkey == self.shutdown_script {
2209 spendable_output = Some(SpendableOutputDescriptor::StaticOutput {
2210 outpoint: BitcoinOutPoint { txid: tx.txid(), vout: i as u32 },
2211 output: outp.clone(),
2215 if let Some(spendable_output) = spendable_output {
2216 log_trace!(logger, "Maturing {} until {}", log_spendable!(spendable_output), height + ANTI_REORG_DELAY - 1);
2217 match self.onchain_events_waiting_threshold_conf.entry(height + ANTI_REORG_DELAY - 1) {
2218 hash_map::Entry::Occupied(mut entry) => {
2219 let e = entry.get_mut();
2220 e.push(OnchainEvent::MaturingOutput { descriptor: spendable_output });
2222 hash_map::Entry::Vacant(entry) => {
2223 entry.insert(vec![OnchainEvent::MaturingOutput { descriptor: spendable_output }]);
2230 const MAX_ALLOC_SIZE: usize = 64*1024;
2232 impl<ChanSigner: ChannelKeys + Readable> Readable for (BlockHash, ChannelMonitor<ChanSigner>) {
2233 fn read<R: ::std::io::Read>(reader: &mut R) -> Result<Self, DecodeError> {
2234 macro_rules! unwrap_obj {
2238 Err(_) => return Err(DecodeError::InvalidValue),
2243 let _ver: u8 = Readable::read(reader)?;
2244 let min_ver: u8 = Readable::read(reader)?;
2245 if min_ver > SERIALIZATION_VERSION {
2246 return Err(DecodeError::UnknownVersion);
2249 let latest_update_id: u64 = Readable::read(reader)?;
2250 let commitment_transaction_number_obscure_factor = <U48 as Readable>::read(reader)?.0;
2252 let destination_script = Readable::read(reader)?;
2253 let broadcasted_local_revokable_script = match <u8 as Readable>::read(reader)? {
2255 let revokable_address = Readable::read(reader)?;
2256 let per_commitment_point = Readable::read(reader)?;
2257 let revokable_script = Readable::read(reader)?;
2258 Some((revokable_address, per_commitment_point, revokable_script))
2261 _ => return Err(DecodeError::InvalidValue),
2263 let remote_payment_script = Readable::read(reader)?;
2264 let shutdown_script = Readable::read(reader)?;
2266 let keys = Readable::read(reader)?;
2267 // Technically this can fail and serialize fail a round-trip, but only for serialization of
2268 // barely-init'd ChannelMonitors that we can't do anything with.
2269 let outpoint = OutPoint {
2270 txid: Readable::read(reader)?,
2271 index: Readable::read(reader)?,
2273 let funding_info = (outpoint, Readable::read(reader)?);
2274 let current_remote_commitment_txid = Readable::read(reader)?;
2275 let prev_remote_commitment_txid = Readable::read(reader)?;
2277 let remote_tx_cache = Readable::read(reader)?;
2278 let funding_redeemscript = Readable::read(reader)?;
2279 let channel_value_satoshis = Readable::read(reader)?;
2281 let their_cur_revocation_points = {
2282 let first_idx = <U48 as Readable>::read(reader)?.0;
2286 let first_point = Readable::read(reader)?;
2287 let second_point_slice: [u8; 33] = Readable::read(reader)?;
2288 if second_point_slice[0..32] == [0; 32] && second_point_slice[32] == 0 {
2289 Some((first_idx, first_point, None))
2291 Some((first_idx, first_point, Some(unwrap_obj!(PublicKey::from_slice(&second_point_slice)))))
2296 let on_local_tx_csv: u16 = Readable::read(reader)?;
2298 let commitment_secrets = Readable::read(reader)?;
2300 macro_rules! read_htlc_in_commitment {
2303 let offered: bool = Readable::read(reader)?;
2304 let amount_msat: u64 = Readable::read(reader)?;
2305 let cltv_expiry: u32 = Readable::read(reader)?;
2306 let payment_hash: PaymentHash = Readable::read(reader)?;
2307 let transaction_output_index: Option<u32> = Readable::read(reader)?;
2309 HTLCOutputInCommitment {
2310 offered, amount_msat, cltv_expiry, payment_hash, transaction_output_index
2316 let remote_claimable_outpoints_len: u64 = Readable::read(reader)?;
2317 let mut remote_claimable_outpoints = HashMap::with_capacity(cmp::min(remote_claimable_outpoints_len as usize, MAX_ALLOC_SIZE / 64));
2318 for _ in 0..remote_claimable_outpoints_len {
2319 let txid: Txid = Readable::read(reader)?;
2320 let htlcs_count: u64 = Readable::read(reader)?;
2321 let mut htlcs = Vec::with_capacity(cmp::min(htlcs_count as usize, MAX_ALLOC_SIZE / 32));
2322 for _ in 0..htlcs_count {
2323 htlcs.push((read_htlc_in_commitment!(), <Option<HTLCSource> as Readable>::read(reader)?.map(|o: HTLCSource| Box::new(o))));
2325 if let Some(_) = remote_claimable_outpoints.insert(txid, htlcs) {
2326 return Err(DecodeError::InvalidValue);
2330 let remote_commitment_txn_on_chain_len: u64 = Readable::read(reader)?;
2331 let mut remote_commitment_txn_on_chain = HashMap::with_capacity(cmp::min(remote_commitment_txn_on_chain_len as usize, MAX_ALLOC_SIZE / 32));
2332 for _ in 0..remote_commitment_txn_on_chain_len {
2333 let txid: Txid = Readable::read(reader)?;
2334 let commitment_number = <U48 as Readable>::read(reader)?.0;
2335 let outputs_count = <u64 as Readable>::read(reader)?;
2336 let mut outputs = Vec::with_capacity(cmp::min(outputs_count as usize, MAX_ALLOC_SIZE / 8));
2337 for _ in 0..outputs_count {
2338 outputs.push(Readable::read(reader)?);
2340 if let Some(_) = remote_commitment_txn_on_chain.insert(txid, (commitment_number, outputs)) {
2341 return Err(DecodeError::InvalidValue);
2345 let remote_hash_commitment_number_len: u64 = Readable::read(reader)?;
2346 let mut remote_hash_commitment_number = HashMap::with_capacity(cmp::min(remote_hash_commitment_number_len as usize, MAX_ALLOC_SIZE / 32));
2347 for _ in 0..remote_hash_commitment_number_len {
2348 let payment_hash: PaymentHash = Readable::read(reader)?;
2349 let commitment_number = <U48 as Readable>::read(reader)?.0;
2350 if let Some(_) = remote_hash_commitment_number.insert(payment_hash, commitment_number) {
2351 return Err(DecodeError::InvalidValue);
2355 macro_rules! read_local_tx {
2358 let txid = Readable::read(reader)?;
2359 let revocation_key = Readable::read(reader)?;
2360 let a_htlc_key = Readable::read(reader)?;
2361 let b_htlc_key = Readable::read(reader)?;
2362 let delayed_payment_key = Readable::read(reader)?;
2363 let per_commitment_point = Readable::read(reader)?;
2364 let feerate_per_kw: u64 = Readable::read(reader)?;
2366 let htlcs_len: u64 = Readable::read(reader)?;
2367 let mut htlcs = Vec::with_capacity(cmp::min(htlcs_len as usize, MAX_ALLOC_SIZE / 128));
2368 for _ in 0..htlcs_len {
2369 let htlc = read_htlc_in_commitment!();
2370 let sigs = match <u8 as Readable>::read(reader)? {
2372 1 => Some(Readable::read(reader)?),
2373 _ => return Err(DecodeError::InvalidValue),
2375 htlcs.push((htlc, sigs, Readable::read(reader)?));
2380 revocation_key, a_htlc_key, b_htlc_key, delayed_payment_key, per_commitment_point, feerate_per_kw,
2387 let prev_local_signed_commitment_tx = match <u8 as Readable>::read(reader)? {
2390 Some(read_local_tx!())
2392 _ => return Err(DecodeError::InvalidValue),
2394 let current_local_commitment_tx = read_local_tx!();
2396 let current_remote_commitment_number = <U48 as Readable>::read(reader)?.0;
2397 let current_local_commitment_number = <U48 as Readable>::read(reader)?.0;
2399 let payment_preimages_len: u64 = Readable::read(reader)?;
2400 let mut payment_preimages = HashMap::with_capacity(cmp::min(payment_preimages_len as usize, MAX_ALLOC_SIZE / 32));
2401 for _ in 0..payment_preimages_len {
2402 let preimage: PaymentPreimage = Readable::read(reader)?;
2403 let hash = PaymentHash(Sha256::hash(&preimage.0[..]).into_inner());
2404 if let Some(_) = payment_preimages.insert(hash, preimage) {
2405 return Err(DecodeError::InvalidValue);
2409 let pending_htlcs_updated_len: u64 = Readable::read(reader)?;
2410 let mut pending_htlcs_updated = Vec::with_capacity(cmp::min(pending_htlcs_updated_len as usize, MAX_ALLOC_SIZE / (32 + 8*3)));
2411 for _ in 0..pending_htlcs_updated_len {
2412 pending_htlcs_updated.push(Readable::read(reader)?);
2415 let pending_events_len: u64 = Readable::read(reader)?;
2416 let mut pending_events = Vec::with_capacity(cmp::min(pending_events_len as usize, MAX_ALLOC_SIZE / mem::size_of::<events::Event>()));
2417 for _ in 0..pending_events_len {
2418 if let Some(event) = MaybeReadable::read(reader)? {
2419 pending_events.push(event);
2423 let last_block_hash: BlockHash = Readable::read(reader)?;
2425 let waiting_threshold_conf_len: u64 = Readable::read(reader)?;
2426 let mut onchain_events_waiting_threshold_conf = HashMap::with_capacity(cmp::min(waiting_threshold_conf_len as usize, MAX_ALLOC_SIZE / 128));
2427 for _ in 0..waiting_threshold_conf_len {
2428 let height_target = Readable::read(reader)?;
2429 let events_len: u64 = Readable::read(reader)?;
2430 let mut events = Vec::with_capacity(cmp::min(events_len as usize, MAX_ALLOC_SIZE / 128));
2431 for _ in 0..events_len {
2432 let ev = match <u8 as Readable>::read(reader)? {
2434 let htlc_source = Readable::read(reader)?;
2435 let hash = Readable::read(reader)?;
2436 OnchainEvent::HTLCUpdate {
2437 htlc_update: (htlc_source, hash)
2441 let descriptor = Readable::read(reader)?;
2442 OnchainEvent::MaturingOutput {
2446 _ => return Err(DecodeError::InvalidValue),
2450 onchain_events_waiting_threshold_conf.insert(height_target, events);
2453 let outputs_to_watch_len: u64 = Readable::read(reader)?;
2454 let mut outputs_to_watch = HashMap::with_capacity(cmp::min(outputs_to_watch_len as usize, MAX_ALLOC_SIZE / (mem::size_of::<Txid>() + mem::size_of::<Vec<Script>>())));
2455 for _ in 0..outputs_to_watch_len {
2456 let txid = Readable::read(reader)?;
2457 let outputs_len: u64 = Readable::read(reader)?;
2458 let mut outputs = Vec::with_capacity(cmp::min(outputs_len as usize, MAX_ALLOC_SIZE / mem::size_of::<Script>()));
2459 for _ in 0..outputs_len {
2460 outputs.push(Readable::read(reader)?);
2462 if let Some(_) = outputs_to_watch.insert(txid, outputs) {
2463 return Err(DecodeError::InvalidValue);
2466 let onchain_tx_handler = Readable::read(reader)?;
2468 let lockdown_from_offchain = Readable::read(reader)?;
2469 let local_tx_signed = Readable::read(reader)?;
2471 Ok((last_block_hash.clone(), ChannelMonitor {
2473 commitment_transaction_number_obscure_factor,
2476 broadcasted_local_revokable_script,
2477 remote_payment_script,
2482 current_remote_commitment_txid,
2483 prev_remote_commitment_txid,
2486 funding_redeemscript,
2487 channel_value_satoshis,
2488 their_cur_revocation_points,
2493 remote_claimable_outpoints,
2494 remote_commitment_txn_on_chain,
2495 remote_hash_commitment_number,
2497 prev_local_signed_commitment_tx,
2498 current_local_commitment_tx,
2499 current_remote_commitment_number,
2500 current_local_commitment_number,
2503 pending_htlcs_updated,
2506 onchain_events_waiting_threshold_conf,
2511 lockdown_from_offchain,
2515 secp_ctx: Secp256k1::new(),
2522 use bitcoin::blockdata::script::{Script, Builder};
2523 use bitcoin::blockdata::opcodes;
2524 use bitcoin::blockdata::transaction::{Transaction, TxIn, TxOut, SigHashType};
2525 use bitcoin::blockdata::transaction::OutPoint as BitcoinOutPoint;
2526 use bitcoin::util::bip143;
2527 use bitcoin::hashes::Hash;
2528 use bitcoin::hashes::sha256::Hash as Sha256;
2529 use bitcoin::hashes::hex::FromHex;
2530 use bitcoin::hash_types::Txid;
2532 use chain::transaction::OutPoint;
2533 use ln::channelmanager::{PaymentPreimage, PaymentHash};
2534 use ln::channelmonitor::ChannelMonitor;
2535 use ln::onchaintx::{OnchainTxHandler, InputDescriptors};
2537 use ln::chan_utils::{HTLCOutputInCommitment, LocalCommitmentTransaction};
2538 use util::test_utils::TestLogger;
2539 use bitcoin::secp256k1::key::{SecretKey,PublicKey};
2540 use bitcoin::secp256k1::Secp256k1;
2541 use rand::{thread_rng,Rng};
2543 use chain::keysinterface::InMemoryChannelKeys;
2546 fn test_prune_preimages() {
2547 let secp_ctx = Secp256k1::new();
2548 let logger = Arc::new(TestLogger::new());
2550 let dummy_key = PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[42; 32]).unwrap());
2551 let dummy_tx = Transaction { version: 0, lock_time: 0, input: Vec::new(), output: Vec::new() };
2553 let mut preimages = Vec::new();
2555 let mut rng = thread_rng();
2557 let mut preimage = PaymentPreimage([0; 32]);
2558 rng.fill_bytes(&mut preimage.0[..]);
2559 let hash = PaymentHash(Sha256::hash(&preimage.0[..]).into_inner());
2560 preimages.push((preimage, hash));
2564 macro_rules! preimages_slice_to_htlc_outputs {
2565 ($preimages_slice: expr) => {
2567 let mut res = Vec::new();
2568 for (idx, preimage) in $preimages_slice.iter().enumerate() {
2569 res.push((HTLCOutputInCommitment {
2573 payment_hash: preimage.1.clone(),
2574 transaction_output_index: Some(idx as u32),
2581 macro_rules! preimages_to_local_htlcs {
2582 ($preimages_slice: expr) => {
2584 let mut inp = preimages_slice_to_htlc_outputs!($preimages_slice);
2585 let res: Vec<_> = inp.drain(..).map(|e| { (e.0, None, e.1) }).collect();
2591 macro_rules! test_preimages_exist {
2592 ($preimages_slice: expr, $monitor: expr) => {
2593 for preimage in $preimages_slice {
2594 assert!($monitor.payment_preimages.contains_key(&preimage.1));
2599 let keys = InMemoryChannelKeys::new(
2601 SecretKey::from_slice(&[41; 32]).unwrap(),
2602 SecretKey::from_slice(&[41; 32]).unwrap(),
2603 SecretKey::from_slice(&[41; 32]).unwrap(),
2604 SecretKey::from_slice(&[41; 32]).unwrap(),
2605 SecretKey::from_slice(&[41; 32]).unwrap(),
2611 // Prune with one old state and a local commitment tx holding a few overlaps with the
2613 let mut monitor = ChannelMonitor::new(keys,
2614 &PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[42; 32]).unwrap()), 0, &Script::new(),
2615 (OutPoint { txid: Txid::from_slice(&[43; 32]).unwrap(), index: 0 }, Script::new()),
2616 &PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[44; 32]).unwrap()),
2617 &PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[45; 32]).unwrap()),
2618 10, Script::new(), 46, 0, LocalCommitmentTransaction::dummy());
2620 monitor.provide_latest_local_commitment_tx_info(LocalCommitmentTransaction::dummy(), preimages_to_local_htlcs!(preimages[0..10])).unwrap();
2621 monitor.provide_latest_remote_commitment_tx_info(&dummy_tx, preimages_slice_to_htlc_outputs!(preimages[5..15]), 281474976710655, dummy_key, &logger);
2622 monitor.provide_latest_remote_commitment_tx_info(&dummy_tx, preimages_slice_to_htlc_outputs!(preimages[15..20]), 281474976710654, dummy_key, &logger);
2623 monitor.provide_latest_remote_commitment_tx_info(&dummy_tx, preimages_slice_to_htlc_outputs!(preimages[17..20]), 281474976710653, dummy_key, &logger);
2624 monitor.provide_latest_remote_commitment_tx_info(&dummy_tx, preimages_slice_to_htlc_outputs!(preimages[18..20]), 281474976710652, dummy_key, &logger);
2625 for &(ref preimage, ref hash) in preimages.iter() {
2626 monitor.provide_payment_preimage(hash, preimage);
2629 // Now provide a secret, pruning preimages 10-15
2630 let mut secret = [0; 32];
2631 secret[0..32].clone_from_slice(&hex::decode("7cc854b54e3e0dcdb010d7a3fee464a9687be6e8db3be6854c475621e007a5dc").unwrap());
2632 monitor.provide_secret(281474976710655, secret.clone()).unwrap();
2633 assert_eq!(monitor.payment_preimages.len(), 15);
2634 test_preimages_exist!(&preimages[0..10], monitor);
2635 test_preimages_exist!(&preimages[15..20], monitor);
2637 // Now provide a further secret, pruning preimages 15-17
2638 secret[0..32].clone_from_slice(&hex::decode("c7518c8ae4660ed02894df8976fa1a3659c1a8b4b5bec0c4b872abeba4cb8964").unwrap());
2639 monitor.provide_secret(281474976710654, secret.clone()).unwrap();
2640 assert_eq!(monitor.payment_preimages.len(), 13);
2641 test_preimages_exist!(&preimages[0..10], monitor);
2642 test_preimages_exist!(&preimages[17..20], monitor);
2644 // Now update local commitment tx info, pruning only element 18 as we still care about the
2645 // previous commitment tx's preimages too
2646 monitor.provide_latest_local_commitment_tx_info(LocalCommitmentTransaction::dummy(), preimages_to_local_htlcs!(preimages[0..5])).unwrap();
2647 secret[0..32].clone_from_slice(&hex::decode("2273e227a5b7449b6e70f1fb4652864038b1cbf9cd7c043a7d6456b7fc275ad8").unwrap());
2648 monitor.provide_secret(281474976710653, secret.clone()).unwrap();
2649 assert_eq!(monitor.payment_preimages.len(), 12);
2650 test_preimages_exist!(&preimages[0..10], monitor);
2651 test_preimages_exist!(&preimages[18..20], monitor);
2653 // But if we do it again, we'll prune 5-10
2654 monitor.provide_latest_local_commitment_tx_info(LocalCommitmentTransaction::dummy(), preimages_to_local_htlcs!(preimages[0..3])).unwrap();
2655 secret[0..32].clone_from_slice(&hex::decode("27cddaa5624534cb6cb9d7da077cf2b22ab21e9b506fd4998a51d54502e99116").unwrap());
2656 monitor.provide_secret(281474976710652, secret.clone()).unwrap();
2657 assert_eq!(monitor.payment_preimages.len(), 5);
2658 test_preimages_exist!(&preimages[0..5], monitor);
2662 fn test_claim_txn_weight_computation() {
2663 // We test Claim txn weight, knowing that we want expected weigth and
2664 // not actual case to avoid sigs and time-lock delays hell variances.
2666 let secp_ctx = Secp256k1::new();
2667 let privkey = SecretKey::from_slice(&hex::decode("0101010101010101010101010101010101010101010101010101010101010101").unwrap()[..]).unwrap();
2668 let pubkey = PublicKey::from_secret_key(&secp_ctx, &privkey);
2669 let mut sum_actual_sigs = 0;
2671 macro_rules! sign_input {
2672 ($sighash_parts: expr, $input: expr, $idx: expr, $amount: expr, $input_type: expr, $sum_actual_sigs: expr) => {
2673 let htlc = HTLCOutputInCommitment {
2674 offered: if *$input_type == InputDescriptors::RevokedOfferedHTLC || *$input_type == InputDescriptors::OfferedHTLC { true } else { false },
2676 cltv_expiry: 2 << 16,
2677 payment_hash: PaymentHash([1; 32]),
2678 transaction_output_index: Some($idx),
2680 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) };
2681 let sighash = hash_to_message!(&$sighash_parts.sighash_all(&$input, &redeem_script, $amount)[..]);
2682 let sig = secp_ctx.sign(&sighash, &privkey);
2683 $input.witness.push(sig.serialize_der().to_vec());
2684 $input.witness[0].push(SigHashType::All as u8);
2685 sum_actual_sigs += $input.witness[0].len();
2686 if *$input_type == InputDescriptors::RevokedOutput {
2687 $input.witness.push(vec!(1));
2688 } else if *$input_type == InputDescriptors::RevokedOfferedHTLC || *$input_type == InputDescriptors::RevokedReceivedHTLC {
2689 $input.witness.push(pubkey.clone().serialize().to_vec());
2690 } else if *$input_type == InputDescriptors::ReceivedHTLC {
2691 $input.witness.push(vec![0]);
2693 $input.witness.push(PaymentPreimage([1; 32]).0.to_vec());
2695 $input.witness.push(redeem_script.into_bytes());
2696 println!("witness[0] {}", $input.witness[0].len());
2697 println!("witness[1] {}", $input.witness[1].len());
2698 println!("witness[2] {}", $input.witness[2].len());
2702 let script_pubkey = Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script();
2703 let txid = Txid::from_hex("56944c5d3f98413ef45cf54545538103cc9f298e0575820ad3591376e2e0f65d").unwrap();
2705 // Justice tx with 1 to_local, 2 revoked offered HTLCs, 1 revoked received HTLCs
2706 let mut claim_tx = Transaction { version: 0, lock_time: 0, input: Vec::new(), output: Vec::new() };
2708 claim_tx.input.push(TxIn {
2709 previous_output: BitcoinOutPoint {
2713 script_sig: Script::new(),
2714 sequence: 0xfffffffd,
2715 witness: Vec::new(),
2718 claim_tx.output.push(TxOut {
2719 script_pubkey: script_pubkey.clone(),
2722 let base_weight = claim_tx.get_weight();
2723 let sighash_parts = bip143::SighashComponents::new(&claim_tx);
2724 let inputs_des = vec![InputDescriptors::RevokedOutput, InputDescriptors::RevokedOfferedHTLC, InputDescriptors::RevokedOfferedHTLC, InputDescriptors::RevokedReceivedHTLC];
2725 for (idx, inp) in claim_tx.input.iter_mut().zip(inputs_des.iter()).enumerate() {
2726 sign_input!(sighash_parts, inp.0, idx as u32, 0, inp.1, sum_actual_sigs);
2728 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));
2730 // Claim tx with 1 offered HTLCs, 3 received HTLCs
2731 claim_tx.input.clear();
2732 sum_actual_sigs = 0;
2734 claim_tx.input.push(TxIn {
2735 previous_output: BitcoinOutPoint {
2739 script_sig: Script::new(),
2740 sequence: 0xfffffffd,
2741 witness: Vec::new(),
2744 let base_weight = claim_tx.get_weight();
2745 let sighash_parts = bip143::SighashComponents::new(&claim_tx);
2746 let inputs_des = vec![InputDescriptors::OfferedHTLC, InputDescriptors::ReceivedHTLC, InputDescriptors::ReceivedHTLC, InputDescriptors::ReceivedHTLC];
2747 for (idx, inp) in claim_tx.input.iter_mut().zip(inputs_des.iter()).enumerate() {
2748 sign_input!(sighash_parts, inp.0, idx as u32, 0, inp.1, sum_actual_sigs);
2750 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));
2752 // Justice tx with 1 revoked HTLC-Success tx output
2753 claim_tx.input.clear();
2754 sum_actual_sigs = 0;
2755 claim_tx.input.push(TxIn {
2756 previous_output: BitcoinOutPoint {
2760 script_sig: Script::new(),
2761 sequence: 0xfffffffd,
2762 witness: Vec::new(),
2764 let base_weight = claim_tx.get_weight();
2765 let sighash_parts = bip143::SighashComponents::new(&claim_tx);
2766 let inputs_des = vec![InputDescriptors::RevokedOutput];
2767 for (idx, inp) in claim_tx.input.iter_mut().zip(inputs_des.iter()).enumerate() {
2768 sign_input!(sighash_parts, inp.0, idx as u32, 0, inp.1, sum_actual_sigs);
2770 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));
2773 // Further testing is done in the ChannelManager integration tests.