1 // This file is Copyright its original authors, visible in version control
4 // This file is licensed under the Apache License, Version 2.0 <LICENSE-APACHE
5 // or http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
6 // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your option.
7 // You may not use this file except in accordance with one or both of these
10 //! The logic to monitor for on-chain transactions and create the relevant claim responses lives
13 //! ChannelMonitor objects are generated by ChannelManager in response to relevant
14 //! messages/actions, and MUST be persisted to disk (and, preferably, remotely) before progress can
15 //! be made in responding to certain messages, see [`chain::Watch`] for more.
17 //! Note that ChannelMonitors are an important part of the lightning trust model and a copy of the
18 //! latest ChannelMonitor must always be actively monitoring for chain updates (and no out-of-date
19 //! ChannelMonitors should do so). Thus, if you're building rust-lightning into an HSM or other
20 //! security-domain-separated system design, you should consider having multiple paths for
21 //! ChannelMonitors to get out of the HSM and onto monitoring devices.
23 use bitcoin::blockdata::block::{Block, BlockHeader};
24 use bitcoin::blockdata::transaction::{TxOut,Transaction};
25 use bitcoin::blockdata::transaction::OutPoint as BitcoinOutPoint;
26 use bitcoin::blockdata::script::{Script, Builder};
27 use bitcoin::blockdata::opcodes;
29 use bitcoin::hashes::Hash;
30 use bitcoin::hashes::sha256::Hash as Sha256;
31 use bitcoin::hash_types::{Txid, BlockHash, WPubkeyHash};
33 use bitcoin::secp256k1::{Secp256k1,Signature};
34 use bitcoin::secp256k1::key::{SecretKey,PublicKey};
35 use bitcoin::secp256k1;
37 use ln::msgs::DecodeError;
39 use ln::chan_utils::{CounterpartyCommitmentSecrets, HTLCOutputInCommitment, HTLCType, ChannelTransactionParameters, HolderCommitmentTransaction};
40 use ln::channelmanager::{BestBlock, HTLCSource, PaymentPreimage, PaymentHash};
41 use ln::onchaintx::{OnchainTxHandler, InputDescriptors};
43 use chain::WatchedOutput;
44 use chain::chaininterface::{BroadcasterInterface, FeeEstimator};
45 use chain::transaction::{OutPoint, TransactionData};
46 use chain::keysinterface::{SpendableOutputDescriptor, StaticPaymentOutputDescriptor, DelayedPaymentOutputDescriptor, Sign, KeysInterface};
48 use util::logger::Logger;
49 use util::ser::{Readable, ReadableArgs, MaybeReadable, Writer, Writeable, U48};
51 use util::events::Event;
53 use std::collections::{HashMap, HashSet};
59 /// An update generated by the underlying Channel itself which contains some new information the
60 /// ChannelMonitor should be made aware of.
61 #[cfg_attr(any(test, feature = "fuzztarget", feature = "_test_utils"), derive(PartialEq))]
64 pub struct ChannelMonitorUpdate {
65 pub(crate) updates: Vec<ChannelMonitorUpdateStep>,
66 /// The sequence number of this update. Updates *must* be replayed in-order according to this
67 /// sequence number (and updates may panic if they are not). The update_id values are strictly
68 /// increasing and increase by one for each new update, with one exception specified below.
70 /// This sequence number is also used to track up to which points updates which returned
71 /// ChannelMonitorUpdateErr::TemporaryFailure have been applied to all copies of a given
72 /// ChannelMonitor when ChannelManager::channel_monitor_updated is called.
74 /// The only instance where update_id values are not strictly increasing is the case where we
75 /// allow post-force-close updates with a special update ID of [`CLOSED_CHANNEL_UPDATE_ID`]. See
76 /// its docs for more details.
81 /// (1) a channel has been force closed and
82 /// (2) we receive a preimage from a forward link that allows us to spend an HTLC output on
83 /// this channel's (the backward link's) broadcasted commitment transaction
84 /// then we allow the `ChannelManager` to send a `ChannelMonitorUpdate` with this update ID,
85 /// with the update providing said payment preimage. No other update types are allowed after
87 pub const CLOSED_CHANNEL_UPDATE_ID: u64 = std::u64::MAX;
89 impl Writeable for ChannelMonitorUpdate {
90 fn write<W: Writer>(&self, w: &mut W) -> Result<(), ::std::io::Error> {
91 self.update_id.write(w)?;
92 (self.updates.len() as u64).write(w)?;
93 for update_step in self.updates.iter() {
94 update_step.write(w)?;
99 impl Readable for ChannelMonitorUpdate {
100 fn read<R: ::std::io::Read>(r: &mut R) -> Result<Self, DecodeError> {
101 let update_id: u64 = Readable::read(r)?;
102 let len: u64 = Readable::read(r)?;
103 let mut updates = Vec::with_capacity(cmp::min(len as usize, MAX_ALLOC_SIZE / ::std::mem::size_of::<ChannelMonitorUpdateStep>()));
105 updates.push(Readable::read(r)?);
107 Ok(Self { update_id, updates })
111 /// An error enum representing a failure to persist a channel monitor update.
112 #[derive(Clone, Debug)]
113 pub enum ChannelMonitorUpdateErr {
114 /// Used to indicate a temporary failure (eg connection to a watchtower or remote backup of
115 /// our state failed, but is expected to succeed at some point in the future).
117 /// Such a failure will "freeze" a channel, preventing us from revoking old states or
118 /// submitting new commitment transactions to the counterparty. Once the update(s) which failed
119 /// have been successfully applied, ChannelManager::channel_monitor_updated can be used to
120 /// restore the channel to an operational state.
122 /// Note that a given ChannelManager will *never* re-generate a given ChannelMonitorUpdate. If
123 /// you return a TemporaryFailure you must ensure that it is written to disk safely before
124 /// writing out the latest ChannelManager state.
126 /// Even when a channel has been "frozen" updates to the ChannelMonitor can continue to occur
127 /// (eg if an inbound HTLC which we forwarded was claimed upstream resulting in us attempting
128 /// to claim it on this channel) and those updates must be applied wherever they can be. At
129 /// least one such updated ChannelMonitor must be persisted otherwise PermanentFailure should
130 /// be returned to get things on-chain ASAP using only the in-memory copy. Obviously updates to
131 /// the channel which would invalidate previous ChannelMonitors are not made when a channel has
134 /// Note that even if updates made after TemporaryFailure succeed you must still call
135 /// channel_monitor_updated to ensure you have the latest monitor and re-enable normal channel
138 /// Note that the update being processed here will not be replayed for you when you call
139 /// ChannelManager::channel_monitor_updated, so you must store the update itself along
140 /// with the persisted ChannelMonitor on your own local disk prior to returning a
141 /// TemporaryFailure. You may, of course, employ a journaling approach, storing only the
142 /// ChannelMonitorUpdate on disk without updating the monitor itself, replaying the journal at
145 /// For deployments where a copy of ChannelMonitors and other local state are backed up in a
146 /// remote location (with local copies persisted immediately), it is anticipated that all
147 /// updates will return TemporaryFailure until the remote copies could be updated.
149 /// Used to indicate no further channel monitor updates will be allowed (eg we've moved on to a
150 /// different watchtower and cannot update with all watchtowers that were previously informed
151 /// of this channel).
153 /// At reception of this error, ChannelManager will force-close the channel and return at
154 /// least a final ChannelMonitorUpdate::ChannelForceClosed which must be delivered to at
155 /// least one ChannelMonitor copy. Revocation secret MUST NOT be released and offchain channel
156 /// update must be rejected.
158 /// This failure may also signal a failure to update the local persisted copy of one of
159 /// the channel monitor instance.
161 /// Note that even when you fail a holder commitment transaction update, you must store the
162 /// update to ensure you can claim from it in case of a duplicate copy of this ChannelMonitor
163 /// broadcasts it (e.g distributed channel-monitor deployment)
165 /// In case of distributed watchtowers deployment, the new version must be written to disk, as
166 /// state may have been stored but rejected due to a block forcing a commitment broadcast. This
167 /// storage is used to claim outputs of rejected state confirmed onchain by another watchtower,
168 /// lagging behind on block processing.
172 /// General Err type for ChannelMonitor actions. Generally, this implies that the data provided is
173 /// inconsistent with the ChannelMonitor being called. eg for ChannelMonitor::update_monitor this
174 /// means you tried to update a monitor for a different channel or the ChannelMonitorUpdate was
176 /// Contains a developer-readable error message.
177 #[derive(Clone, Debug)]
178 pub struct MonitorUpdateError(pub &'static str);
180 /// An event to be processed by the ChannelManager.
181 #[derive(Clone, PartialEq)]
182 pub enum MonitorEvent {
183 /// A monitor event containing an HTLCUpdate.
184 HTLCEvent(HTLCUpdate),
186 /// A monitor event that the Channel's commitment transaction was broadcasted.
187 CommitmentTxBroadcasted(OutPoint),
190 /// Simple structure sent back by `chain::Watch` when an HTLC from a forward channel is detected on
191 /// chain. Used to update the corresponding HTLC in the backward channel. Failing to pass the
192 /// preimage claim backward will lead to loss of funds.
193 #[derive(Clone, PartialEq)]
194 pub struct HTLCUpdate {
195 pub(crate) payment_hash: PaymentHash,
196 pub(crate) payment_preimage: Option<PaymentPreimage>,
197 pub(crate) source: HTLCSource
199 impl_writeable!(HTLCUpdate, 0, { payment_hash, payment_preimage, source });
201 /// If an HTLC expires within this many blocks, don't try to claim it in a shared transaction,
202 /// instead claiming it in its own individual transaction.
203 pub(crate) const CLTV_SHARED_CLAIM_BUFFER: u32 = 12;
204 /// If an HTLC expires within this many blocks, force-close the channel to broadcast the
205 /// HTLC-Success transaction.
206 /// In other words, this is an upper bound on how many blocks we think it can take us to get a
207 /// transaction confirmed (and we use it in a few more, equivalent, places).
208 pub(crate) const CLTV_CLAIM_BUFFER: u32 = 6;
209 /// Number of blocks by which point we expect our counterparty to have seen new blocks on the
210 /// network and done a full update_fail_htlc/commitment_signed dance (+ we've updated all our
211 /// copies of ChannelMonitors, including watchtowers). We could enforce the contract by failing
212 /// at CLTV expiration height but giving a grace period to our peer may be profitable for us if he
213 /// can provide an over-late preimage. Nevertheless, grace period has to be accounted in our
214 /// CLTV_EXPIRY_DELTA to be secure. Following this policy we may decrease the rate of channel failures
215 /// due to expiration but increase the cost of funds being locked longuer in case of failure.
216 /// This delay also cover a low-power peer being slow to process blocks and so being behind us on
217 /// accurate block height.
218 /// In case of onchain failure to be pass backward we may see the last block of ANTI_REORG_DELAY
219 /// with at worst this delay, so we are not only using this value as a mercy for them but also
220 /// us as a safeguard to delay with enough time.
221 pub(crate) const LATENCY_GRACE_PERIOD_BLOCKS: u32 = 3;
222 /// Number of blocks we wait on seeing a HTLC output being solved before we fail corresponding inbound
223 /// HTLCs. This prevents us from failing backwards and then getting a reorg resulting in us losing money.
224 /// We use also this delay to be sure we can remove our in-flight claim txn from bump candidates buffer.
225 /// It may cause spurrious generation of bumped claim txn but that's allright given the outpoint is already
226 /// solved by a previous claim tx. What we want to avoid is reorg evicting our claim tx and us not
227 /// keeping bumping another claim tx to solve the outpoint.
228 pub(crate) const ANTI_REORG_DELAY: u32 = 6;
229 /// Number of blocks before confirmation at which we fail back an un-relayed HTLC or at which we
230 /// refuse to accept a new HTLC.
232 /// This is used for a few separate purposes:
233 /// 1) if we've received an MPP HTLC to us and it expires within this many blocks and we are
234 /// waiting on additional parts (or waiting on the preimage for any HTLC from the user), we will
236 /// 2) if we receive an HTLC within this many blocks of its expiry (plus one to avoid a race
237 /// condition with the above), we will fail this HTLC without telling the user we received it,
238 /// 3) if we are waiting on a connection or a channel state update to send an HTLC to a peer, and
239 /// that HTLC expires within this many blocks, we will simply fail the HTLC instead.
241 /// (1) is all about protecting us - we need enough time to update the channel state before we hit
242 /// CLTV_CLAIM_BUFFER, at which point we'd go on chain to claim the HTLC with the preimage.
244 /// (2) is the same, but with an additional buffer to avoid accepting an HTLC which is immediately
245 /// in a race condition between the user connecting a block (which would fail it) and the user
246 /// providing us the preimage (which would claim it).
248 /// (3) is about our counterparty - we don't want to relay an HTLC to a counterparty when they may
249 /// end up force-closing the channel on us to claim it.
250 pub(crate) const HTLC_FAIL_BACK_BUFFER: u32 = CLTV_CLAIM_BUFFER + LATENCY_GRACE_PERIOD_BLOCKS;
252 // TODO(devrandom) replace this with HolderCommitmentTransaction
253 #[derive(Clone, PartialEq)]
254 struct HolderSignedTx {
255 /// txid of the transaction in tx, just used to make comparison faster
257 revocation_key: PublicKey,
258 a_htlc_key: PublicKey,
259 b_htlc_key: PublicKey,
260 delayed_payment_key: PublicKey,
261 per_commitment_point: PublicKey,
263 htlc_outputs: Vec<(HTLCOutputInCommitment, Option<Signature>, Option<HTLCSource>)>,
266 /// We use this to track counterparty commitment transactions and htlcs outputs and
267 /// use it to generate any justice or 2nd-stage preimage/timeout transactions.
269 struct CounterpartyCommitmentTransaction {
270 counterparty_delayed_payment_base_key: PublicKey,
271 counterparty_htlc_base_key: PublicKey,
272 on_counterparty_tx_csv: u16,
273 per_htlc: HashMap<Txid, Vec<HTLCOutputInCommitment>>
276 impl Writeable for CounterpartyCommitmentTransaction {
277 fn write<W: Writer>(&self, w: &mut W) -> Result<(), ::std::io::Error> {
278 self.counterparty_delayed_payment_base_key.write(w)?;
279 self.counterparty_htlc_base_key.write(w)?;
280 w.write_all(&byte_utils::be16_to_array(self.on_counterparty_tx_csv))?;
281 w.write_all(&byte_utils::be64_to_array(self.per_htlc.len() as u64))?;
282 for (ref txid, ref htlcs) in self.per_htlc.iter() {
283 w.write_all(&txid[..])?;
284 w.write_all(&byte_utils::be64_to_array(htlcs.len() as u64))?;
285 for &ref htlc in htlcs.iter() {
292 impl Readable for CounterpartyCommitmentTransaction {
293 fn read<R: ::std::io::Read>(r: &mut R) -> Result<Self, DecodeError> {
294 let counterparty_commitment_transaction = {
295 let counterparty_delayed_payment_base_key = Readable::read(r)?;
296 let counterparty_htlc_base_key = Readable::read(r)?;
297 let on_counterparty_tx_csv: u16 = Readable::read(r)?;
298 let per_htlc_len: u64 = Readable::read(r)?;
299 let mut per_htlc = HashMap::with_capacity(cmp::min(per_htlc_len as usize, MAX_ALLOC_SIZE / 64));
300 for _ in 0..per_htlc_len {
301 let txid: Txid = Readable::read(r)?;
302 let htlcs_count: u64 = Readable::read(r)?;
303 let mut htlcs = Vec::with_capacity(cmp::min(htlcs_count as usize, MAX_ALLOC_SIZE / 32));
304 for _ in 0..htlcs_count {
305 let htlc = Readable::read(r)?;
308 if let Some(_) = per_htlc.insert(txid, htlcs) {
309 return Err(DecodeError::InvalidValue);
312 CounterpartyCommitmentTransaction {
313 counterparty_delayed_payment_base_key,
314 counterparty_htlc_base_key,
315 on_counterparty_tx_csv,
319 Ok(counterparty_commitment_transaction)
323 /// When ChannelMonitor discovers an onchain outpoint being a step of a channel and that it needs
324 /// to generate a tx to push channel state forward, we cache outpoint-solving tx material to build
325 /// a new bumped one in case of lenghty confirmation delay
326 #[derive(Clone, PartialEq)]
327 pub(crate) enum InputMaterial {
329 per_commitment_point: PublicKey,
330 counterparty_delayed_payment_base_key: PublicKey,
331 counterparty_htlc_base_key: PublicKey,
332 per_commitment_key: SecretKey,
333 input_descriptor: InputDescriptors,
335 htlc: Option<HTLCOutputInCommitment>,
336 on_counterparty_tx_csv: u16,
339 per_commitment_point: PublicKey,
340 counterparty_delayed_payment_base_key: PublicKey,
341 counterparty_htlc_base_key: PublicKey,
342 preimage: Option<PaymentPreimage>,
343 htlc: HTLCOutputInCommitment
346 preimage: Option<PaymentPreimage>,
350 funding_redeemscript: Script,
354 impl Writeable for InputMaterial {
355 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), ::std::io::Error> {
357 &InputMaterial::Revoked { ref per_commitment_point, ref counterparty_delayed_payment_base_key, ref counterparty_htlc_base_key, ref per_commitment_key, ref input_descriptor, ref amount, ref htlc, ref on_counterparty_tx_csv} => {
358 writer.write_all(&[0; 1])?;
359 per_commitment_point.write(writer)?;
360 counterparty_delayed_payment_base_key.write(writer)?;
361 counterparty_htlc_base_key.write(writer)?;
362 writer.write_all(&per_commitment_key[..])?;
363 input_descriptor.write(writer)?;
364 writer.write_all(&byte_utils::be64_to_array(*amount))?;
366 on_counterparty_tx_csv.write(writer)?;
368 &InputMaterial::CounterpartyHTLC { ref per_commitment_point, ref counterparty_delayed_payment_base_key, ref counterparty_htlc_base_key, ref preimage, ref htlc} => {
369 writer.write_all(&[1; 1])?;
370 per_commitment_point.write(writer)?;
371 counterparty_delayed_payment_base_key.write(writer)?;
372 counterparty_htlc_base_key.write(writer)?;
373 preimage.write(writer)?;
376 &InputMaterial::HolderHTLC { ref preimage, ref amount } => {
377 writer.write_all(&[2; 1])?;
378 preimage.write(writer)?;
379 writer.write_all(&byte_utils::be64_to_array(*amount))?;
381 &InputMaterial::Funding { ref funding_redeemscript } => {
382 writer.write_all(&[3; 1])?;
383 funding_redeemscript.write(writer)?;
390 impl Readable for InputMaterial {
391 fn read<R: ::std::io::Read>(reader: &mut R) -> Result<Self, DecodeError> {
392 let input_material = match <u8 as Readable>::read(reader)? {
394 let per_commitment_point = Readable::read(reader)?;
395 let counterparty_delayed_payment_base_key = Readable::read(reader)?;
396 let counterparty_htlc_base_key = Readable::read(reader)?;
397 let per_commitment_key = Readable::read(reader)?;
398 let input_descriptor = Readable::read(reader)?;
399 let amount = Readable::read(reader)?;
400 let htlc = Readable::read(reader)?;
401 let on_counterparty_tx_csv = Readable::read(reader)?;
402 InputMaterial::Revoked {
403 per_commitment_point,
404 counterparty_delayed_payment_base_key,
405 counterparty_htlc_base_key,
410 on_counterparty_tx_csv
414 let per_commitment_point = Readable::read(reader)?;
415 let counterparty_delayed_payment_base_key = Readable::read(reader)?;
416 let counterparty_htlc_base_key = Readable::read(reader)?;
417 let preimage = Readable::read(reader)?;
418 let htlc = Readable::read(reader)?;
419 InputMaterial::CounterpartyHTLC {
420 per_commitment_point,
421 counterparty_delayed_payment_base_key,
422 counterparty_htlc_base_key,
428 let preimage = Readable::read(reader)?;
429 let amount = Readable::read(reader)?;
430 InputMaterial::HolderHTLC {
436 InputMaterial::Funding {
437 funding_redeemscript: Readable::read(reader)?,
440 _ => return Err(DecodeError::InvalidValue),
446 /// ClaimRequest is a descriptor structure to communicate between detection
447 /// and reaction module. They are generated by ChannelMonitor while parsing
448 /// onchain txn leaked from a channel and handed over to OnchainTxHandler which
449 /// is responsible for opportunistic aggregation, selecting and enforcing
450 /// bumping logic, building and signing transactions.
451 pub(crate) struct ClaimRequest {
452 // Block height before which claiming is exclusive to one party,
453 // after reaching it, claiming may be contentious.
454 pub(crate) absolute_timelock: u32,
455 // Timeout tx must have nLocktime set which means aggregating multiple
456 // ones must take the higher nLocktime among them to satisfy all of them.
457 // Sadly it has few pitfalls, a) it takes longuer to get fund back b) CLTV_DELTA
458 // of a sooner-HTLC could be swallowed by the highest nLocktime of the HTLC set.
459 // Do simplify we mark them as non-aggregable.
460 pub(crate) aggregable: bool,
461 // Basic bitcoin outpoint (txid, vout)
462 pub(crate) outpoint: BitcoinOutPoint,
463 // Following outpoint type, set of data needed to generate transaction digest
464 // and satisfy witness program.
465 pub(crate) witness_data: InputMaterial
468 /// An entry for an [`OnchainEvent`], stating the block height when the event was observed and the
469 /// transaction causing it.
471 /// Used to determine when the on-chain event can be considered safe from a chain reorganization.
473 struct OnchainEventEntry {
479 impl OnchainEventEntry {
480 fn confirmation_threshold(&self) -> u32 {
481 self.height + ANTI_REORG_DELAY - 1
484 fn has_reached_confirmation_threshold(&self, height: u32) -> bool {
485 height >= self.confirmation_threshold()
489 /// Upon discovering of some classes of onchain tx by ChannelMonitor, we may have to take actions on it
490 /// once they mature to enough confirmations (ANTI_REORG_DELAY)
493 /// HTLC output getting solved by a timeout, at maturation we pass upstream payment source information to solve
494 /// inbound HTLC in backward channel. Note, in case of preimage, we pass info to upstream without delay as we can
495 /// only win from it, so it's never an OnchainEvent
497 htlc_update: (HTLCSource, PaymentHash),
500 descriptor: SpendableOutputDescriptor,
504 const SERIALIZATION_VERSION: u8 = 1;
505 const MIN_SERIALIZATION_VERSION: u8 = 1;
507 #[cfg_attr(any(test, feature = "fuzztarget", feature = "_test_utils"), derive(PartialEq))]
509 pub(crate) enum ChannelMonitorUpdateStep {
510 LatestHolderCommitmentTXInfo {
511 commitment_tx: HolderCommitmentTransaction,
512 htlc_outputs: Vec<(HTLCOutputInCommitment, Option<Signature>, Option<HTLCSource>)>,
514 LatestCounterpartyCommitmentTXInfo {
515 commitment_txid: Txid,
516 htlc_outputs: Vec<(HTLCOutputInCommitment, Option<Box<HTLCSource>>)>,
517 commitment_number: u64,
518 their_revocation_point: PublicKey,
521 payment_preimage: PaymentPreimage,
527 /// Used to indicate that the no future updates will occur, and likely that the latest holder
528 /// commitment transaction(s) should be broadcast, as the channel has been force-closed.
530 /// If set to false, we shouldn't broadcast the latest holder commitment transaction as we
531 /// think we've fallen behind!
532 should_broadcast: bool,
536 impl Writeable for ChannelMonitorUpdateStep {
537 fn write<W: Writer>(&self, w: &mut W) -> Result<(), ::std::io::Error> {
539 &ChannelMonitorUpdateStep::LatestHolderCommitmentTXInfo { ref commitment_tx, ref htlc_outputs } => {
541 commitment_tx.write(w)?;
542 (htlc_outputs.len() as u64).write(w)?;
543 for &(ref output, ref signature, ref source) in htlc_outputs.iter() {
549 &ChannelMonitorUpdateStep::LatestCounterpartyCommitmentTXInfo { commitment_txid, ref htlc_outputs, ref commitment_number, ref their_revocation_point } => {
551 commitment_txid.write(w)?;
552 commitment_number.write(w)?;
553 their_revocation_point.write(w)?;
554 (htlc_outputs.len() as u64).write(w)?;
555 for &(ref output, ref source) in htlc_outputs.iter() {
557 source.as_ref().map(|b| b.as_ref()).write(w)?;
560 &ChannelMonitorUpdateStep::PaymentPreimage { ref payment_preimage } => {
562 payment_preimage.write(w)?;
564 &ChannelMonitorUpdateStep::CommitmentSecret { ref idx, ref secret } => {
569 &ChannelMonitorUpdateStep::ChannelForceClosed { ref should_broadcast } => {
571 should_broadcast.write(w)?;
577 impl Readable for ChannelMonitorUpdateStep {
578 fn read<R: ::std::io::Read>(r: &mut R) -> Result<Self, DecodeError> {
579 match Readable::read(r)? {
581 Ok(ChannelMonitorUpdateStep::LatestHolderCommitmentTXInfo {
582 commitment_tx: Readable::read(r)?,
584 let len: u64 = Readable::read(r)?;
585 let mut res = Vec::new();
587 res.push((Readable::read(r)?, Readable::read(r)?, Readable::read(r)?));
594 Ok(ChannelMonitorUpdateStep::LatestCounterpartyCommitmentTXInfo {
595 commitment_txid: Readable::read(r)?,
596 commitment_number: Readable::read(r)?,
597 their_revocation_point: Readable::read(r)?,
599 let len: u64 = Readable::read(r)?;
600 let mut res = Vec::new();
602 res.push((Readable::read(r)?, <Option<HTLCSource> as Readable>::read(r)?.map(|o| Box::new(o))));
609 Ok(ChannelMonitorUpdateStep::PaymentPreimage {
610 payment_preimage: Readable::read(r)?,
614 Ok(ChannelMonitorUpdateStep::CommitmentSecret {
615 idx: Readable::read(r)?,
616 secret: Readable::read(r)?,
620 Ok(ChannelMonitorUpdateStep::ChannelForceClosed {
621 should_broadcast: Readable::read(r)?
624 _ => Err(DecodeError::InvalidValue),
629 /// A ChannelMonitor handles chain events (blocks connected and disconnected) and generates
630 /// on-chain transactions to ensure no loss of funds occurs.
632 /// You MUST ensure that no ChannelMonitors for a given channel anywhere contain out-of-date
633 /// information and are actively monitoring the chain.
635 /// Pending Events or updated HTLCs which have not yet been read out by
636 /// get_and_clear_pending_monitor_events or get_and_clear_pending_events are serialized to disk and
637 /// reloaded at deserialize-time. Thus, you must ensure that, when handling events, all events
638 /// gotten are fully handled before re-serializing the new state.
640 /// Note that the deserializer is only implemented for (BlockHash, ChannelMonitor), which
641 /// tells you the last block hash which was block_connect()ed. You MUST rescan any blocks along
642 /// the "reorg path" (ie disconnecting blocks until you find a common ancestor from both the
643 /// returned block hash and the the current chain and then reconnecting blocks to get to the
644 /// best chain) upon deserializing the object!
645 pub struct ChannelMonitor<Signer: Sign> {
647 pub(crate) inner: Mutex<ChannelMonitorImpl<Signer>>,
649 inner: Mutex<ChannelMonitorImpl<Signer>>,
652 pub(crate) struct ChannelMonitorImpl<Signer: Sign> {
653 latest_update_id: u64,
654 commitment_transaction_number_obscure_factor: u64,
656 destination_script: Script,
657 broadcasted_holder_revokable_script: Option<(Script, PublicKey, PublicKey)>,
658 counterparty_payment_script: Script,
659 shutdown_script: Script,
661 channel_keys_id: [u8; 32],
662 holder_revocation_basepoint: PublicKey,
663 funding_info: (OutPoint, Script),
664 current_counterparty_commitment_txid: Option<Txid>,
665 prev_counterparty_commitment_txid: Option<Txid>,
667 counterparty_tx_cache: CounterpartyCommitmentTransaction,
668 funding_redeemscript: Script,
669 channel_value_satoshis: u64,
670 // first is the idx of the first of the two revocation points
671 their_cur_revocation_points: Option<(u64, PublicKey, Option<PublicKey>)>,
673 on_holder_tx_csv: u16,
675 commitment_secrets: CounterpartyCommitmentSecrets,
676 counterparty_claimable_outpoints: HashMap<Txid, Vec<(HTLCOutputInCommitment, Option<Box<HTLCSource>>)>>,
677 /// We cannot identify HTLC-Success or HTLC-Timeout transactions by themselves on the chain.
678 /// Nor can we figure out their commitment numbers without the commitment transaction they are
679 /// spending. Thus, in order to claim them via revocation key, we track all the counterparty
680 /// commitment transactions which we find on-chain, mapping them to the commitment number which
681 /// can be used to derive the revocation key and claim the transactions.
682 counterparty_commitment_txn_on_chain: HashMap<Txid, u64>,
683 /// Cache used to make pruning of payment_preimages faster.
684 /// Maps payment_hash values to commitment numbers for counterparty transactions for non-revoked
685 /// counterparty transactions (ie should remain pretty small).
686 /// Serialized to disk but should generally not be sent to Watchtowers.
687 counterparty_hash_commitment_number: HashMap<PaymentHash, u64>,
689 // We store two holder commitment transactions to avoid any race conditions where we may update
690 // some monitors (potentially on watchtowers) but then fail to update others, resulting in the
691 // various monitors for one channel being out of sync, and us broadcasting a holder
692 // transaction for which we have deleted claim information on some watchtowers.
693 prev_holder_signed_commitment_tx: Option<HolderSignedTx>,
694 current_holder_commitment_tx: HolderSignedTx,
696 // Used just for ChannelManager to make sure it has the latest channel data during
698 current_counterparty_commitment_number: u64,
699 // Used just for ChannelManager to make sure it has the latest channel data during
701 current_holder_commitment_number: u64,
703 payment_preimages: HashMap<PaymentHash, PaymentPreimage>,
705 pending_monitor_events: Vec<MonitorEvent>,
706 pending_events: Vec<Event>,
708 // Used to track on-chain events (i.e., transactions part of channels confirmed on chain) on
709 // which to take actions once they reach enough confirmations. Each entry includes the
710 // transaction's id and the height when the transaction was confirmed on chain.
711 onchain_events_awaiting_threshold_conf: Vec<OnchainEventEntry>,
713 // If we get serialized out and re-read, we need to make sure that the chain monitoring
714 // interface knows about the TXOs that we want to be notified of spends of. We could probably
715 // be smart and derive them from the above storage fields, but its much simpler and more
716 // Obviously Correct (tm) if we just keep track of them explicitly.
717 outputs_to_watch: HashMap<Txid, Vec<(u32, Script)>>,
720 pub onchain_tx_handler: OnchainTxHandler<Signer>,
722 onchain_tx_handler: OnchainTxHandler<Signer>,
724 // This is set when the Channel[Manager] generated a ChannelMonitorUpdate which indicated the
725 // channel has been force-closed. After this is set, no further holder commitment transaction
726 // updates may occur, and we panic!() if one is provided.
727 lockdown_from_offchain: bool,
729 // Set once we've signed a holder commitment transaction and handed it over to our
730 // OnchainTxHandler. After this is set, no future updates to our holder commitment transactions
731 // may occur, and we fail any such monitor updates.
733 // In case of update rejection due to a locally already signed commitment transaction, we
734 // nevertheless store update content to track in case of concurrent broadcast by another
735 // remote monitor out-of-order with regards to the block view.
736 holder_tx_signed: bool,
738 // We simply modify best_block in Channel's block_connected so that serialization is
739 // consistent but hopefully the users' copy handles block_connected in a consistent way.
740 // (we do *not*, however, update them in update_monitor to ensure any local user copies keep
741 // their best_block from its state and not based on updated copies that didn't run through
742 // the full block_connected).
743 best_block: BestBlock,
745 secp_ctx: Secp256k1<secp256k1::All>, //TODO: dedup this a bit...
748 /// Transaction outputs to watch for on-chain spends.
749 pub type TransactionOutputs = (Txid, Vec<(u32, TxOut)>);
751 #[cfg(any(test, feature = "fuzztarget", feature = "_test_utils"))]
752 /// Used only in testing and fuzztarget to check serialization roundtrips don't change the
753 /// underlying object
754 impl<Signer: Sign> PartialEq for ChannelMonitor<Signer> {
755 fn eq(&self, other: &Self) -> bool {
756 let inner = self.inner.lock().unwrap();
757 let other = other.inner.lock().unwrap();
762 #[cfg(any(test, feature = "fuzztarget", feature = "_test_utils"))]
763 /// Used only in testing and fuzztarget to check serialization roundtrips don't change the
764 /// underlying object
765 impl<Signer: Sign> PartialEq for ChannelMonitorImpl<Signer> {
766 fn eq(&self, other: &Self) -> bool {
767 if self.latest_update_id != other.latest_update_id ||
768 self.commitment_transaction_number_obscure_factor != other.commitment_transaction_number_obscure_factor ||
769 self.destination_script != other.destination_script ||
770 self.broadcasted_holder_revokable_script != other.broadcasted_holder_revokable_script ||
771 self.counterparty_payment_script != other.counterparty_payment_script ||
772 self.channel_keys_id != other.channel_keys_id ||
773 self.holder_revocation_basepoint != other.holder_revocation_basepoint ||
774 self.funding_info != other.funding_info ||
775 self.current_counterparty_commitment_txid != other.current_counterparty_commitment_txid ||
776 self.prev_counterparty_commitment_txid != other.prev_counterparty_commitment_txid ||
777 self.counterparty_tx_cache != other.counterparty_tx_cache ||
778 self.funding_redeemscript != other.funding_redeemscript ||
779 self.channel_value_satoshis != other.channel_value_satoshis ||
780 self.their_cur_revocation_points != other.their_cur_revocation_points ||
781 self.on_holder_tx_csv != other.on_holder_tx_csv ||
782 self.commitment_secrets != other.commitment_secrets ||
783 self.counterparty_claimable_outpoints != other.counterparty_claimable_outpoints ||
784 self.counterparty_commitment_txn_on_chain != other.counterparty_commitment_txn_on_chain ||
785 self.counterparty_hash_commitment_number != other.counterparty_hash_commitment_number ||
786 self.prev_holder_signed_commitment_tx != other.prev_holder_signed_commitment_tx ||
787 self.current_counterparty_commitment_number != other.current_counterparty_commitment_number ||
788 self.current_holder_commitment_number != other.current_holder_commitment_number ||
789 self.current_holder_commitment_tx != other.current_holder_commitment_tx ||
790 self.payment_preimages != other.payment_preimages ||
791 self.pending_monitor_events != other.pending_monitor_events ||
792 self.pending_events.len() != other.pending_events.len() || // We trust events to round-trip properly
793 self.onchain_events_awaiting_threshold_conf != other.onchain_events_awaiting_threshold_conf ||
794 self.outputs_to_watch != other.outputs_to_watch ||
795 self.lockdown_from_offchain != other.lockdown_from_offchain ||
796 self.holder_tx_signed != other.holder_tx_signed
805 impl<Signer: Sign> Writeable for ChannelMonitor<Signer> {
806 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), Error> {
807 //TODO: We still write out all the serialization here manually instead of using the fancy
808 //serialization framework we have, we should migrate things over to it.
809 writer.write_all(&[SERIALIZATION_VERSION; 1])?;
810 writer.write_all(&[MIN_SERIALIZATION_VERSION; 1])?;
812 self.inner.lock().unwrap().write(writer)
816 impl<Signer: Sign> Writeable for ChannelMonitorImpl<Signer> {
817 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), Error> {
818 self.latest_update_id.write(writer)?;
820 // Set in initial Channel-object creation, so should always be set by now:
821 U48(self.commitment_transaction_number_obscure_factor).write(writer)?;
823 self.destination_script.write(writer)?;
824 if let Some(ref broadcasted_holder_revokable_script) = self.broadcasted_holder_revokable_script {
825 writer.write_all(&[0; 1])?;
826 broadcasted_holder_revokable_script.0.write(writer)?;
827 broadcasted_holder_revokable_script.1.write(writer)?;
828 broadcasted_holder_revokable_script.2.write(writer)?;
830 writer.write_all(&[1; 1])?;
833 self.counterparty_payment_script.write(writer)?;
834 self.shutdown_script.write(writer)?;
836 self.channel_keys_id.write(writer)?;
837 self.holder_revocation_basepoint.write(writer)?;
838 writer.write_all(&self.funding_info.0.txid[..])?;
839 writer.write_all(&byte_utils::be16_to_array(self.funding_info.0.index))?;
840 self.funding_info.1.write(writer)?;
841 self.current_counterparty_commitment_txid.write(writer)?;
842 self.prev_counterparty_commitment_txid.write(writer)?;
844 self.counterparty_tx_cache.write(writer)?;
845 self.funding_redeemscript.write(writer)?;
846 self.channel_value_satoshis.write(writer)?;
848 match self.their_cur_revocation_points {
849 Some((idx, pubkey, second_option)) => {
850 writer.write_all(&byte_utils::be48_to_array(idx))?;
851 writer.write_all(&pubkey.serialize())?;
852 match second_option {
853 Some(second_pubkey) => {
854 writer.write_all(&second_pubkey.serialize())?;
857 writer.write_all(&[0; 33])?;
862 writer.write_all(&byte_utils::be48_to_array(0))?;
866 writer.write_all(&byte_utils::be16_to_array(self.on_holder_tx_csv))?;
868 self.commitment_secrets.write(writer)?;
870 macro_rules! serialize_htlc_in_commitment {
871 ($htlc_output: expr) => {
872 writer.write_all(&[$htlc_output.offered as u8; 1])?;
873 writer.write_all(&byte_utils::be64_to_array($htlc_output.amount_msat))?;
874 writer.write_all(&byte_utils::be32_to_array($htlc_output.cltv_expiry))?;
875 writer.write_all(&$htlc_output.payment_hash.0[..])?;
876 $htlc_output.transaction_output_index.write(writer)?;
880 writer.write_all(&byte_utils::be64_to_array(self.counterparty_claimable_outpoints.len() as u64))?;
881 for (ref txid, ref htlc_infos) in self.counterparty_claimable_outpoints.iter() {
882 writer.write_all(&txid[..])?;
883 writer.write_all(&byte_utils::be64_to_array(htlc_infos.len() as u64))?;
884 for &(ref htlc_output, ref htlc_source) in htlc_infos.iter() {
885 serialize_htlc_in_commitment!(htlc_output);
886 htlc_source.as_ref().map(|b| b.as_ref()).write(writer)?;
890 writer.write_all(&byte_utils::be64_to_array(self.counterparty_commitment_txn_on_chain.len() as u64))?;
891 for (ref txid, commitment_number) in self.counterparty_commitment_txn_on_chain.iter() {
892 writer.write_all(&txid[..])?;
893 writer.write_all(&byte_utils::be48_to_array(*commitment_number))?;
896 writer.write_all(&byte_utils::be64_to_array(self.counterparty_hash_commitment_number.len() as u64))?;
897 for (ref payment_hash, commitment_number) in self.counterparty_hash_commitment_number.iter() {
898 writer.write_all(&payment_hash.0[..])?;
899 writer.write_all(&byte_utils::be48_to_array(*commitment_number))?;
902 macro_rules! serialize_holder_tx {
903 ($holder_tx: expr) => {
904 $holder_tx.txid.write(writer)?;
905 writer.write_all(&$holder_tx.revocation_key.serialize())?;
906 writer.write_all(&$holder_tx.a_htlc_key.serialize())?;
907 writer.write_all(&$holder_tx.b_htlc_key.serialize())?;
908 writer.write_all(&$holder_tx.delayed_payment_key.serialize())?;
909 writer.write_all(&$holder_tx.per_commitment_point.serialize())?;
911 writer.write_all(&byte_utils::be32_to_array($holder_tx.feerate_per_kw))?;
912 writer.write_all(&byte_utils::be64_to_array($holder_tx.htlc_outputs.len() as u64))?;
913 for &(ref htlc_output, ref sig, ref htlc_source) in $holder_tx.htlc_outputs.iter() {
914 serialize_htlc_in_commitment!(htlc_output);
915 if let &Some(ref their_sig) = sig {
917 writer.write_all(&their_sig.serialize_compact())?;
921 htlc_source.write(writer)?;
926 if let Some(ref prev_holder_tx) = self.prev_holder_signed_commitment_tx {
927 writer.write_all(&[1; 1])?;
928 serialize_holder_tx!(prev_holder_tx);
930 writer.write_all(&[0; 1])?;
933 serialize_holder_tx!(self.current_holder_commitment_tx);
935 writer.write_all(&byte_utils::be48_to_array(self.current_counterparty_commitment_number))?;
936 writer.write_all(&byte_utils::be48_to_array(self.current_holder_commitment_number))?;
938 writer.write_all(&byte_utils::be64_to_array(self.payment_preimages.len() as u64))?;
939 for payment_preimage in self.payment_preimages.values() {
940 writer.write_all(&payment_preimage.0[..])?;
943 writer.write_all(&byte_utils::be64_to_array(self.pending_monitor_events.len() as u64))?;
944 for event in self.pending_monitor_events.iter() {
946 MonitorEvent::HTLCEvent(upd) => {
950 MonitorEvent::CommitmentTxBroadcasted(_) => 1u8.write(writer)?
954 writer.write_all(&byte_utils::be64_to_array(self.pending_events.len() as u64))?;
955 for event in self.pending_events.iter() {
956 event.write(writer)?;
959 self.best_block.block_hash().write(writer)?;
960 writer.write_all(&byte_utils::be32_to_array(self.best_block.height()))?;
962 writer.write_all(&byte_utils::be64_to_array(self.onchain_events_awaiting_threshold_conf.len() as u64))?;
963 for ref entry in self.onchain_events_awaiting_threshold_conf.iter() {
964 entry.txid.write(writer)?;
965 writer.write_all(&byte_utils::be32_to_array(entry.height))?;
967 OnchainEvent::HTLCUpdate { ref htlc_update } => {
969 htlc_update.0.write(writer)?;
970 htlc_update.1.write(writer)?;
972 OnchainEvent::MaturingOutput { ref descriptor } => {
974 descriptor.write(writer)?;
979 (self.outputs_to_watch.len() as u64).write(writer)?;
980 for (txid, idx_scripts) in self.outputs_to_watch.iter() {
982 (idx_scripts.len() as u64).write(writer)?;
983 for (idx, script) in idx_scripts.iter() {
985 script.write(writer)?;
988 self.onchain_tx_handler.write(writer)?;
990 self.lockdown_from_offchain.write(writer)?;
991 self.holder_tx_signed.write(writer)?;
997 impl<Signer: Sign> ChannelMonitor<Signer> {
998 pub(crate) fn new(secp_ctx: Secp256k1<secp256k1::All>, keys: Signer, shutdown_pubkey: &PublicKey,
999 on_counterparty_tx_csv: u16, destination_script: &Script, funding_info: (OutPoint, Script),
1000 channel_parameters: &ChannelTransactionParameters,
1001 funding_redeemscript: Script, channel_value_satoshis: u64,
1002 commitment_transaction_number_obscure_factor: u64,
1003 initial_holder_commitment_tx: HolderCommitmentTransaction,
1004 best_block: BestBlock) -> ChannelMonitor<Signer> {
1006 assert!(commitment_transaction_number_obscure_factor <= (1 << 48));
1007 let our_channel_close_key_hash = WPubkeyHash::hash(&shutdown_pubkey.serialize());
1008 let shutdown_script = Builder::new().push_opcode(opcodes::all::OP_PUSHBYTES_0).push_slice(&our_channel_close_key_hash[..]).into_script();
1009 let payment_key_hash = WPubkeyHash::hash(&keys.pubkeys().payment_point.serialize());
1010 let counterparty_payment_script = Builder::new().push_opcode(opcodes::all::OP_PUSHBYTES_0).push_slice(&payment_key_hash[..]).into_script();
1012 let counterparty_channel_parameters = channel_parameters.counterparty_parameters.as_ref().unwrap();
1013 let counterparty_delayed_payment_base_key = counterparty_channel_parameters.pubkeys.delayed_payment_basepoint;
1014 let counterparty_htlc_base_key = counterparty_channel_parameters.pubkeys.htlc_basepoint;
1015 let counterparty_tx_cache = CounterpartyCommitmentTransaction { counterparty_delayed_payment_base_key, counterparty_htlc_base_key, on_counterparty_tx_csv, per_htlc: HashMap::new() };
1017 let channel_keys_id = keys.channel_keys_id();
1018 let holder_revocation_basepoint = keys.pubkeys().revocation_basepoint;
1020 // block for Rust 1.34 compat
1021 let (holder_commitment_tx, current_holder_commitment_number) = {
1022 let trusted_tx = initial_holder_commitment_tx.trust();
1023 let txid = trusted_tx.txid();
1025 let tx_keys = trusted_tx.keys();
1026 let holder_commitment_tx = HolderSignedTx {
1028 revocation_key: tx_keys.revocation_key,
1029 a_htlc_key: tx_keys.broadcaster_htlc_key,
1030 b_htlc_key: tx_keys.countersignatory_htlc_key,
1031 delayed_payment_key: tx_keys.broadcaster_delayed_payment_key,
1032 per_commitment_point: tx_keys.per_commitment_point,
1033 feerate_per_kw: trusted_tx.feerate_per_kw(),
1034 htlc_outputs: Vec::new(), // There are never any HTLCs in the initial commitment transactions
1036 (holder_commitment_tx, trusted_tx.commitment_number())
1039 let onchain_tx_handler =
1040 OnchainTxHandler::new(destination_script.clone(), keys,
1041 channel_parameters.clone(), initial_holder_commitment_tx, secp_ctx.clone());
1043 let mut outputs_to_watch = HashMap::new();
1044 outputs_to_watch.insert(funding_info.0.txid, vec![(funding_info.0.index as u32, funding_info.1.clone())]);
1047 inner: Mutex::new(ChannelMonitorImpl {
1048 latest_update_id: 0,
1049 commitment_transaction_number_obscure_factor,
1051 destination_script: destination_script.clone(),
1052 broadcasted_holder_revokable_script: None,
1053 counterparty_payment_script,
1057 holder_revocation_basepoint,
1059 current_counterparty_commitment_txid: None,
1060 prev_counterparty_commitment_txid: None,
1062 counterparty_tx_cache,
1063 funding_redeemscript,
1064 channel_value_satoshis,
1065 their_cur_revocation_points: None,
1067 on_holder_tx_csv: counterparty_channel_parameters.selected_contest_delay,
1069 commitment_secrets: CounterpartyCommitmentSecrets::new(),
1070 counterparty_claimable_outpoints: HashMap::new(),
1071 counterparty_commitment_txn_on_chain: HashMap::new(),
1072 counterparty_hash_commitment_number: HashMap::new(),
1074 prev_holder_signed_commitment_tx: None,
1075 current_holder_commitment_tx: holder_commitment_tx,
1076 current_counterparty_commitment_number: 1 << 48,
1077 current_holder_commitment_number,
1079 payment_preimages: HashMap::new(),
1080 pending_monitor_events: Vec::new(),
1081 pending_events: Vec::new(),
1083 onchain_events_awaiting_threshold_conf: Vec::new(),
1088 lockdown_from_offchain: false,
1089 holder_tx_signed: false,
1099 fn provide_secret(&self, idx: u64, secret: [u8; 32]) -> Result<(), MonitorUpdateError> {
1100 self.inner.lock().unwrap().provide_secret(idx, secret)
1103 /// Informs this monitor of the latest counterparty (ie non-broadcastable) commitment transaction.
1104 /// The monitor watches for it to be broadcasted and then uses the HTLC information (and
1105 /// possibly future revocation/preimage information) to claim outputs where possible.
1106 /// We cache also the mapping hash:commitment number to lighten pruning of old preimages by watchtowers.
1107 pub(crate) fn provide_latest_counterparty_commitment_tx<L: Deref>(
1110 htlc_outputs: Vec<(HTLCOutputInCommitment, Option<Box<HTLCSource>>)>,
1111 commitment_number: u64,
1112 their_revocation_point: PublicKey,
1114 ) where L::Target: Logger {
1115 self.inner.lock().unwrap().provide_latest_counterparty_commitment_tx(
1116 txid, htlc_outputs, commitment_number, their_revocation_point, logger)
1120 fn provide_latest_holder_commitment_tx(
1122 holder_commitment_tx: HolderCommitmentTransaction,
1123 htlc_outputs: Vec<(HTLCOutputInCommitment, Option<Signature>, Option<HTLCSource>)>,
1124 ) -> Result<(), MonitorUpdateError> {
1125 self.inner.lock().unwrap().provide_latest_holder_commitment_tx(
1126 holder_commitment_tx, htlc_outputs)
1130 pub(crate) fn provide_payment_preimage<B: Deref, F: Deref, L: Deref>(
1132 payment_hash: &PaymentHash,
1133 payment_preimage: &PaymentPreimage,
1138 B::Target: BroadcasterInterface,
1139 F::Target: FeeEstimator,
1142 self.inner.lock().unwrap().provide_payment_preimage(
1143 payment_hash, payment_preimage, broadcaster, fee_estimator, logger)
1146 pub(crate) fn broadcast_latest_holder_commitment_txn<B: Deref, L: Deref>(
1151 B::Target: BroadcasterInterface,
1154 self.inner.lock().unwrap().broadcast_latest_holder_commitment_txn(broadcaster, logger)
1157 /// Updates a ChannelMonitor on the basis of some new information provided by the Channel
1160 /// panics if the given update is not the next update by update_id.
1161 pub fn update_monitor<B: Deref, F: Deref, L: Deref>(
1163 updates: &ChannelMonitorUpdate,
1167 ) -> Result<(), MonitorUpdateError>
1169 B::Target: BroadcasterInterface,
1170 F::Target: FeeEstimator,
1173 self.inner.lock().unwrap().update_monitor(updates, broadcaster, fee_estimator, logger)
1176 /// Gets the update_id from the latest ChannelMonitorUpdate which was applied to this
1178 pub fn get_latest_update_id(&self) -> u64 {
1179 self.inner.lock().unwrap().get_latest_update_id()
1182 /// Gets the funding transaction outpoint of the channel this ChannelMonitor is monitoring for.
1183 pub fn get_funding_txo(&self) -> (OutPoint, Script) {
1184 self.inner.lock().unwrap().get_funding_txo().clone()
1187 /// Gets a list of txids, with their output scripts (in the order they appear in the
1188 /// transaction), which we must learn about spends of via block_connected().
1189 pub fn get_outputs_to_watch(&self) -> Vec<(Txid, Vec<(u32, Script)>)> {
1190 self.inner.lock().unwrap().get_outputs_to_watch()
1191 .iter().map(|(txid, outputs)| (*txid, outputs.clone())).collect()
1194 /// Loads the funding txo and outputs to watch into the given `chain::Filter` by repeatedly
1195 /// calling `chain::Filter::register_output` and `chain::Filter::register_tx` until all outputs
1196 /// have been registered.
1197 pub fn load_outputs_to_watch<F: Deref>(&self, filter: &F) where F::Target: chain::Filter {
1198 let lock = self.inner.lock().unwrap();
1199 filter.register_tx(&lock.get_funding_txo().0.txid, &lock.get_funding_txo().1);
1200 for (txid, outputs) in lock.get_outputs_to_watch().iter() {
1201 for (index, script_pubkey) in outputs.iter() {
1202 assert!(*index <= u16::max_value() as u32);
1203 filter.register_output(WatchedOutput {
1205 outpoint: OutPoint { txid: *txid, index: *index as u16 },
1206 script_pubkey: script_pubkey.clone(),
1212 /// Get the list of HTLCs who's status has been updated on chain. This should be called by
1213 /// ChannelManager via [`chain::Watch::release_pending_monitor_events`].
1214 pub fn get_and_clear_pending_monitor_events(&self) -> Vec<MonitorEvent> {
1215 self.inner.lock().unwrap().get_and_clear_pending_monitor_events()
1218 /// Gets the list of pending events which were generated by previous actions, clearing the list
1221 /// This is called by ChainMonitor::get_and_clear_pending_events() and is equivalent to
1222 /// EventsProvider::get_and_clear_pending_events() except that it requires &mut self as we do
1223 /// no internal locking in ChannelMonitors.
1224 pub fn get_and_clear_pending_events(&self) -> Vec<Event> {
1225 self.inner.lock().unwrap().get_and_clear_pending_events()
1228 pub(crate) fn get_min_seen_secret(&self) -> u64 {
1229 self.inner.lock().unwrap().get_min_seen_secret()
1232 pub(crate) fn get_cur_counterparty_commitment_number(&self) -> u64 {
1233 self.inner.lock().unwrap().get_cur_counterparty_commitment_number()
1236 pub(crate) fn get_cur_holder_commitment_number(&self) -> u64 {
1237 self.inner.lock().unwrap().get_cur_holder_commitment_number()
1240 /// Used by ChannelManager deserialization to broadcast the latest holder state if its copy of
1241 /// the Channel was out-of-date. You may use it to get a broadcastable holder toxic tx in case of
1242 /// fallen-behind, i.e when receiving a channel_reestablish with a proof that our counterparty side knows
1243 /// a higher revocation secret than the holder commitment number we are aware of. Broadcasting these
1244 /// transactions are UNSAFE, as they allow counterparty side to punish you. Nevertheless you may want to
1245 /// broadcast them if counterparty don't close channel with his higher commitment transaction after a
1246 /// substantial amount of time (a month or even a year) to get back funds. Best may be to contact
1247 /// out-of-band the other node operator to coordinate with him if option is available to you.
1248 /// In any-case, choice is up to the user.
1249 pub fn get_latest_holder_commitment_txn<L: Deref>(&self, logger: &L) -> Vec<Transaction>
1250 where L::Target: Logger {
1251 self.inner.lock().unwrap().get_latest_holder_commitment_txn(logger)
1254 /// Unsafe test-only version of get_latest_holder_commitment_txn used by our test framework
1255 /// to bypass HolderCommitmentTransaction state update lockdown after signature and generate
1256 /// revoked commitment transaction.
1257 #[cfg(any(test, feature = "unsafe_revoked_tx_signing"))]
1258 pub fn unsafe_get_latest_holder_commitment_txn<L: Deref>(&self, logger: &L) -> Vec<Transaction>
1259 where L::Target: Logger {
1260 self.inner.lock().unwrap().unsafe_get_latest_holder_commitment_txn(logger)
1263 /// Processes transactions in a newly connected block, which may result in any of the following:
1264 /// - update the monitor's state against resolved HTLCs
1265 /// - punish the counterparty in the case of seeing a revoked commitment transaction
1266 /// - force close the channel and claim/timeout incoming/outgoing HTLCs if near expiration
1267 /// - detect settled outputs for later spending
1268 /// - schedule and bump any in-flight claims
1270 /// Returns any new outputs to watch from `txdata`; after called, these are also included in
1271 /// [`get_outputs_to_watch`].
1273 /// [`get_outputs_to_watch`]: #method.get_outputs_to_watch
1274 pub fn block_connected<B: Deref, F: Deref, L: Deref>(
1276 header: &BlockHeader,
1277 txdata: &TransactionData,
1282 ) -> Vec<TransactionOutputs>
1284 B::Target: BroadcasterInterface,
1285 F::Target: FeeEstimator,
1288 self.inner.lock().unwrap().block_connected(
1289 header, txdata, height, broadcaster, fee_estimator, logger)
1292 /// Determines if the disconnected block contained any transactions of interest and updates
1294 pub fn block_disconnected<B: Deref, F: Deref, L: Deref>(
1296 header: &BlockHeader,
1302 B::Target: BroadcasterInterface,
1303 F::Target: FeeEstimator,
1306 self.inner.lock().unwrap().block_disconnected(
1307 header, height, broadcaster, fee_estimator, logger)
1310 /// Processes transactions confirmed in a block with the given header and height, returning new
1311 /// outputs to watch. See [`block_connected`] for details.
1313 /// Used instead of [`block_connected`] by clients that are notified of transactions rather than
1314 /// blocks. See [`chain::Confirm`] for calling expectations.
1316 /// [`block_connected`]: Self::block_connected
1317 pub fn transactions_confirmed<B: Deref, F: Deref, L: Deref>(
1319 header: &BlockHeader,
1320 txdata: &TransactionData,
1325 ) -> Vec<TransactionOutputs>
1327 B::Target: BroadcasterInterface,
1328 F::Target: FeeEstimator,
1331 self.inner.lock().unwrap().transactions_confirmed(
1332 header, txdata, height, broadcaster, fee_estimator, logger)
1335 /// Processes a transaction that was reorganized out of the chain.
1337 /// Used instead of [`block_disconnected`] by clients that are notified of transactions rather
1338 /// than blocks. See [`chain::Confirm`] for calling expectations.
1340 /// [`block_disconnected`]: Self::block_disconnected
1341 pub fn transaction_unconfirmed<B: Deref, F: Deref, L: Deref>(
1348 B::Target: BroadcasterInterface,
1349 F::Target: FeeEstimator,
1352 self.inner.lock().unwrap().transaction_unconfirmed(
1353 txid, broadcaster, fee_estimator, logger);
1356 /// Updates the monitor with the current best chain tip, returning new outputs to watch. See
1357 /// [`block_connected`] for details.
1359 /// Used instead of [`block_connected`] by clients that are notified of transactions rather than
1360 /// blocks. See [`chain::Confirm`] for calling expectations.
1362 /// [`block_connected`]: Self::block_connected
1363 pub fn best_block_updated<B: Deref, F: Deref, L: Deref>(
1365 header: &BlockHeader,
1370 ) -> Vec<TransactionOutputs>
1372 B::Target: BroadcasterInterface,
1373 F::Target: FeeEstimator,
1376 self.inner.lock().unwrap().best_block_updated(
1377 header, height, broadcaster, fee_estimator, logger)
1380 /// Returns the set of txids that should be monitored for re-organization out of the chain.
1381 pub fn get_relevant_txids(&self) -> Vec<Txid> {
1382 let inner = self.inner.lock().unwrap();
1383 let mut txids: Vec<Txid> = inner.onchain_events_awaiting_threshold_conf
1385 .map(|entry| entry.txid)
1386 .chain(inner.onchain_tx_handler.get_relevant_txids().into_iter())
1388 txids.sort_unstable();
1394 impl<Signer: Sign> ChannelMonitorImpl<Signer> {
1395 /// Inserts a revocation secret into this channel monitor. Prunes old preimages if neither
1396 /// needed by holder commitment transactions HTCLs nor by counterparty ones. Unless we haven't already seen
1397 /// counterparty commitment transaction's secret, they are de facto pruned (we can use revocation key).
1398 fn provide_secret(&mut self, idx: u64, secret: [u8; 32]) -> Result<(), MonitorUpdateError> {
1399 if let Err(()) = self.commitment_secrets.provide_secret(idx, secret) {
1400 return Err(MonitorUpdateError("Previous secret did not match new one"));
1403 // Prune HTLCs from the previous counterparty commitment tx so we don't generate failure/fulfill
1404 // events for now-revoked/fulfilled HTLCs.
1405 if let Some(txid) = self.prev_counterparty_commitment_txid.take() {
1406 for &mut (_, ref mut source) in self.counterparty_claimable_outpoints.get_mut(&txid).unwrap() {
1411 if !self.payment_preimages.is_empty() {
1412 let cur_holder_signed_commitment_tx = &self.current_holder_commitment_tx;
1413 let prev_holder_signed_commitment_tx = self.prev_holder_signed_commitment_tx.as_ref();
1414 let min_idx = self.get_min_seen_secret();
1415 let counterparty_hash_commitment_number = &mut self.counterparty_hash_commitment_number;
1417 self.payment_preimages.retain(|&k, _| {
1418 for &(ref htlc, _, _) in cur_holder_signed_commitment_tx.htlc_outputs.iter() {
1419 if k == htlc.payment_hash {
1423 if let Some(prev_holder_commitment_tx) = prev_holder_signed_commitment_tx {
1424 for &(ref htlc, _, _) in prev_holder_commitment_tx.htlc_outputs.iter() {
1425 if k == htlc.payment_hash {
1430 let contains = if let Some(cn) = counterparty_hash_commitment_number.get(&k) {
1437 counterparty_hash_commitment_number.remove(&k);
1446 pub(crate) fn provide_latest_counterparty_commitment_tx<L: Deref>(&mut self, txid: Txid, htlc_outputs: Vec<(HTLCOutputInCommitment, Option<Box<HTLCSource>>)>, commitment_number: u64, their_revocation_point: PublicKey, logger: &L) where L::Target: Logger {
1447 // TODO: Encrypt the htlc_outputs data with the single-hash of the commitment transaction
1448 // so that a remote monitor doesn't learn anything unless there is a malicious close.
1449 // (only maybe, sadly we cant do the same for local info, as we need to be aware of
1451 for &(ref htlc, _) in &htlc_outputs {
1452 self.counterparty_hash_commitment_number.insert(htlc.payment_hash, commitment_number);
1455 log_trace!(logger, "Tracking new counterparty commitment transaction with txid {} at commitment number {} with {} HTLC outputs", txid, commitment_number, htlc_outputs.len());
1456 self.prev_counterparty_commitment_txid = self.current_counterparty_commitment_txid.take();
1457 self.current_counterparty_commitment_txid = Some(txid);
1458 self.counterparty_claimable_outpoints.insert(txid, htlc_outputs.clone());
1459 self.current_counterparty_commitment_number = commitment_number;
1460 //TODO: Merge this into the other per-counterparty-transaction output storage stuff
1461 match self.their_cur_revocation_points {
1462 Some(old_points) => {
1463 if old_points.0 == commitment_number + 1 {
1464 self.their_cur_revocation_points = Some((old_points.0, old_points.1, Some(their_revocation_point)));
1465 } else if old_points.0 == commitment_number + 2 {
1466 if let Some(old_second_point) = old_points.2 {
1467 self.their_cur_revocation_points = Some((old_points.0 - 1, old_second_point, Some(their_revocation_point)));
1469 self.their_cur_revocation_points = Some((commitment_number, their_revocation_point, None));
1472 self.their_cur_revocation_points = Some((commitment_number, their_revocation_point, None));
1476 self.their_cur_revocation_points = Some((commitment_number, their_revocation_point, None));
1479 let mut htlcs = Vec::with_capacity(htlc_outputs.len());
1480 for htlc in htlc_outputs {
1481 if htlc.0.transaction_output_index.is_some() {
1485 self.counterparty_tx_cache.per_htlc.insert(txid, htlcs);
1488 /// Informs this monitor of the latest holder (ie broadcastable) commitment transaction. The
1489 /// monitor watches for timeouts and may broadcast it if we approach such a timeout. Thus, it
1490 /// is important that any clones of this channel monitor (including remote clones) by kept
1491 /// up-to-date as our holder commitment transaction is updated.
1492 /// Panics if set_on_holder_tx_csv has never been called.
1493 fn provide_latest_holder_commitment_tx(&mut self, holder_commitment_tx: HolderCommitmentTransaction, htlc_outputs: Vec<(HTLCOutputInCommitment, Option<Signature>, Option<HTLCSource>)>) -> Result<(), MonitorUpdateError> {
1494 // block for Rust 1.34 compat
1495 let mut new_holder_commitment_tx = {
1496 let trusted_tx = holder_commitment_tx.trust();
1497 let txid = trusted_tx.txid();
1498 let tx_keys = trusted_tx.keys();
1499 self.current_holder_commitment_number = trusted_tx.commitment_number();
1502 revocation_key: tx_keys.revocation_key,
1503 a_htlc_key: tx_keys.broadcaster_htlc_key,
1504 b_htlc_key: tx_keys.countersignatory_htlc_key,
1505 delayed_payment_key: tx_keys.broadcaster_delayed_payment_key,
1506 per_commitment_point: tx_keys.per_commitment_point,
1507 feerate_per_kw: trusted_tx.feerate_per_kw(),
1511 self.onchain_tx_handler.provide_latest_holder_tx(holder_commitment_tx);
1512 mem::swap(&mut new_holder_commitment_tx, &mut self.current_holder_commitment_tx);
1513 self.prev_holder_signed_commitment_tx = Some(new_holder_commitment_tx);
1514 if self.holder_tx_signed {
1515 return Err(MonitorUpdateError("Latest holder commitment signed has already been signed, update is rejected"));
1520 /// Provides a payment_hash->payment_preimage mapping. Will be automatically pruned when all
1521 /// commitment_tx_infos which contain the payment hash have been revoked.
1522 fn provide_payment_preimage<B: Deref, F: Deref, L: Deref>(&mut self, payment_hash: &PaymentHash, payment_preimage: &PaymentPreimage, broadcaster: &B, fee_estimator: &F, logger: &L)
1523 where B::Target: BroadcasterInterface,
1524 F::Target: FeeEstimator,
1527 self.payment_preimages.insert(payment_hash.clone(), payment_preimage.clone());
1529 // If the channel is force closed, try to claim the output from this preimage.
1530 // First check if a counterparty commitment transaction has been broadcasted:
1531 macro_rules! claim_htlcs {
1532 ($commitment_number: expr, $txid: expr) => {
1533 let htlc_claim_reqs = self.get_counterparty_htlc_output_claim_reqs($commitment_number, $txid, None);
1534 self.onchain_tx_handler.update_claims_view(&Vec::new(), htlc_claim_reqs, None, broadcaster, fee_estimator, logger);
1537 if let Some(txid) = self.current_counterparty_commitment_txid {
1538 if let Some(commitment_number) = self.counterparty_commitment_txn_on_chain.get(&txid) {
1539 claim_htlcs!(*commitment_number, txid);
1543 if let Some(txid) = self.prev_counterparty_commitment_txid {
1544 if let Some(commitment_number) = self.counterparty_commitment_txn_on_chain.get(&txid) {
1545 claim_htlcs!(*commitment_number, txid);
1550 // Then if a holder commitment transaction has been seen on-chain, broadcast transactions
1551 // claiming the HTLC output from each of the holder commitment transactions.
1552 // Note that we can't just use `self.holder_tx_signed`, because that only covers the case where
1553 // *we* sign a holder commitment transaction, not when e.g. a watchtower broadcasts one of our
1554 // holder commitment transactions.
1555 if self.broadcasted_holder_revokable_script.is_some() {
1556 let (claim_reqs, _) = self.get_broadcasted_holder_claims(&self.current_holder_commitment_tx);
1557 self.onchain_tx_handler.update_claims_view(&Vec::new(), claim_reqs, None, broadcaster, fee_estimator, logger);
1558 if let Some(ref tx) = self.prev_holder_signed_commitment_tx {
1559 let (claim_reqs, _) = self.get_broadcasted_holder_claims(&tx);
1560 self.onchain_tx_handler.update_claims_view(&Vec::new(), claim_reqs, None, broadcaster, fee_estimator, logger);
1565 pub(crate) fn broadcast_latest_holder_commitment_txn<B: Deref, L: Deref>(&mut self, broadcaster: &B, logger: &L)
1566 where B::Target: BroadcasterInterface,
1569 for tx in self.get_latest_holder_commitment_txn(logger).iter() {
1570 broadcaster.broadcast_transaction(tx);
1572 self.pending_monitor_events.push(MonitorEvent::CommitmentTxBroadcasted(self.funding_info.0));
1575 pub fn update_monitor<B: Deref, F: Deref, L: Deref>(&mut self, updates: &ChannelMonitorUpdate, broadcaster: &B, fee_estimator: &F, logger: &L) -> Result<(), MonitorUpdateError>
1576 where B::Target: BroadcasterInterface,
1577 F::Target: FeeEstimator,
1580 // ChannelMonitor updates may be applied after force close if we receive a
1581 // preimage for a broadcasted commitment transaction HTLC output that we'd
1582 // like to claim on-chain. If this is the case, we no longer have guaranteed
1583 // access to the monitor's update ID, so we use a sentinel value instead.
1584 if updates.update_id == CLOSED_CHANNEL_UPDATE_ID {
1585 match updates.updates[0] {
1586 ChannelMonitorUpdateStep::PaymentPreimage { .. } => {},
1587 _ => panic!("Attempted to apply post-force-close ChannelMonitorUpdate that wasn't providing a payment preimage"),
1589 assert_eq!(updates.updates.len(), 1);
1590 } else if self.latest_update_id + 1 != updates.update_id {
1591 panic!("Attempted to apply ChannelMonitorUpdates out of order, check the update_id before passing an update to update_monitor!");
1593 for update in updates.updates.iter() {
1595 ChannelMonitorUpdateStep::LatestHolderCommitmentTXInfo { commitment_tx, htlc_outputs } => {
1596 log_trace!(logger, "Updating ChannelMonitor with latest holder commitment transaction info");
1597 if self.lockdown_from_offchain { panic!(); }
1598 self.provide_latest_holder_commitment_tx(commitment_tx.clone(), htlc_outputs.clone())?
1600 ChannelMonitorUpdateStep::LatestCounterpartyCommitmentTXInfo { commitment_txid, htlc_outputs, commitment_number, their_revocation_point } => {
1601 log_trace!(logger, "Updating ChannelMonitor with latest counterparty commitment transaction info");
1602 self.provide_latest_counterparty_commitment_tx(*commitment_txid, htlc_outputs.clone(), *commitment_number, *their_revocation_point, logger)
1604 ChannelMonitorUpdateStep::PaymentPreimage { payment_preimage } => {
1605 log_trace!(logger, "Updating ChannelMonitor with payment preimage");
1606 self.provide_payment_preimage(&PaymentHash(Sha256::hash(&payment_preimage.0[..]).into_inner()), &payment_preimage, broadcaster, fee_estimator, logger)
1608 ChannelMonitorUpdateStep::CommitmentSecret { idx, secret } => {
1609 log_trace!(logger, "Updating ChannelMonitor with commitment secret");
1610 self.provide_secret(*idx, *secret)?
1612 ChannelMonitorUpdateStep::ChannelForceClosed { should_broadcast } => {
1613 log_trace!(logger, "Updating ChannelMonitor: channel force closed, should broadcast: {}", should_broadcast);
1614 self.lockdown_from_offchain = true;
1615 if *should_broadcast {
1616 self.broadcast_latest_holder_commitment_txn(broadcaster, logger);
1617 } else if !self.holder_tx_signed {
1618 log_error!(logger, "You have a toxic holder commitment transaction avaible in channel monitor, read comment in ChannelMonitor::get_latest_holder_commitment_txn to be informed of manual action to take");
1620 // If we generated a MonitorEvent::CommitmentTxBroadcasted, the ChannelManager
1621 // will still give us a ChannelForceClosed event with !should_broadcast, but we
1622 // shouldn't print the scary warning above.
1623 log_info!(logger, "Channel off-chain state closed after we broadcasted our latest commitment transaction.");
1628 self.latest_update_id = updates.update_id;
1632 pub fn get_latest_update_id(&self) -> u64 {
1633 self.latest_update_id
1636 pub fn get_funding_txo(&self) -> &(OutPoint, Script) {
1640 pub fn get_outputs_to_watch(&self) -> &HashMap<Txid, Vec<(u32, Script)>> {
1641 // If we've detected a counterparty commitment tx on chain, we must include it in the set
1642 // of outputs to watch for spends of, otherwise we're likely to lose user funds. Because
1643 // its trivial to do, double-check that here.
1644 for (txid, _) in self.counterparty_commitment_txn_on_chain.iter() {
1645 self.outputs_to_watch.get(txid).expect("Counterparty commitment txn which have been broadcast should have outputs registered");
1647 &self.outputs_to_watch
1650 pub fn get_and_clear_pending_monitor_events(&mut self) -> Vec<MonitorEvent> {
1651 let mut ret = Vec::new();
1652 mem::swap(&mut ret, &mut self.pending_monitor_events);
1656 pub fn get_and_clear_pending_events(&mut self) -> Vec<Event> {
1657 let mut ret = Vec::new();
1658 mem::swap(&mut ret, &mut self.pending_events);
1662 /// Can only fail if idx is < get_min_seen_secret
1663 fn get_secret(&self, idx: u64) -> Option<[u8; 32]> {
1664 self.commitment_secrets.get_secret(idx)
1667 pub(crate) fn get_min_seen_secret(&self) -> u64 {
1668 self.commitment_secrets.get_min_seen_secret()
1671 pub(crate) fn get_cur_counterparty_commitment_number(&self) -> u64 {
1672 self.current_counterparty_commitment_number
1675 pub(crate) fn get_cur_holder_commitment_number(&self) -> u64 {
1676 self.current_holder_commitment_number
1679 /// Attempts to claim a counterparty commitment transaction's outputs using the revocation key and
1680 /// data in counterparty_claimable_outpoints. Will directly claim any HTLC outputs which expire at a
1681 /// height > height + CLTV_SHARED_CLAIM_BUFFER. In any case, will install monitoring for
1682 /// HTLC-Success/HTLC-Timeout transactions.
1683 /// Return updates for HTLC pending in the channel and failed automatically by the broadcast of
1684 /// revoked counterparty commitment tx
1685 fn check_spend_counterparty_transaction<L: Deref>(&mut self, tx: &Transaction, height: u32, logger: &L) -> (Vec<ClaimRequest>, TransactionOutputs) where L::Target: Logger {
1686 // Most secp and related errors trying to create keys means we have no hope of constructing
1687 // a spend transaction...so we return no transactions to broadcast
1688 let mut claimable_outpoints = Vec::new();
1689 let mut watch_outputs = Vec::new();
1691 let commitment_txid = tx.txid(); //TODO: This is gonna be a performance bottleneck for watchtowers!
1692 let per_commitment_option = self.counterparty_claimable_outpoints.get(&commitment_txid);
1694 macro_rules! ignore_error {
1695 ( $thing : expr ) => {
1698 Err(_) => return (claimable_outpoints, (commitment_txid, watch_outputs))
1703 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);
1704 if commitment_number >= self.get_min_seen_secret() {
1705 let secret = self.get_secret(commitment_number).unwrap();
1706 let per_commitment_key = ignore_error!(SecretKey::from_slice(&secret));
1707 let per_commitment_point = PublicKey::from_secret_key(&self.secp_ctx, &per_commitment_key);
1708 let revocation_pubkey = ignore_error!(chan_utils::derive_public_revocation_key(&self.secp_ctx, &per_commitment_point, &self.holder_revocation_basepoint));
1709 let delayed_key = ignore_error!(chan_utils::derive_public_key(&self.secp_ctx, &PublicKey::from_secret_key(&self.secp_ctx, &per_commitment_key), &self.counterparty_tx_cache.counterparty_delayed_payment_base_key));
1711 let revokeable_redeemscript = chan_utils::get_revokeable_redeemscript(&revocation_pubkey, self.counterparty_tx_cache.on_counterparty_tx_csv, &delayed_key);
1712 let revokeable_p2wsh = revokeable_redeemscript.to_v0_p2wsh();
1714 // First, process non-htlc outputs (to_holder & to_counterparty)
1715 for (idx, outp) in tx.output.iter().enumerate() {
1716 if outp.script_pubkey == revokeable_p2wsh {
1717 let witness_data = InputMaterial::Revoked { per_commitment_point, counterparty_delayed_payment_base_key: self.counterparty_tx_cache.counterparty_delayed_payment_base_key, counterparty_htlc_base_key: self.counterparty_tx_cache.counterparty_htlc_base_key, per_commitment_key, input_descriptor: InputDescriptors::RevokedOutput, amount: outp.value, htlc: None, on_counterparty_tx_csv: self.counterparty_tx_cache.on_counterparty_tx_csv};
1718 claimable_outpoints.push(ClaimRequest { absolute_timelock: height + self.counterparty_tx_cache.on_counterparty_tx_csv as u32, aggregable: true, outpoint: BitcoinOutPoint { txid: commitment_txid, vout: idx as u32 }, witness_data});
1722 // Then, try to find revoked htlc outputs
1723 if let Some(ref per_commitment_data) = per_commitment_option {
1724 for (_, &(ref htlc, _)) in per_commitment_data.iter().enumerate() {
1725 if let Some(transaction_output_index) = htlc.transaction_output_index {
1726 if transaction_output_index as usize >= tx.output.len() ||
1727 tx.output[transaction_output_index as usize].value != htlc.amount_msat / 1000 {
1728 return (claimable_outpoints, (commitment_txid, watch_outputs)); // Corrupted per_commitment_data, fuck this user
1730 let witness_data = InputMaterial::Revoked { per_commitment_point, counterparty_delayed_payment_base_key: self.counterparty_tx_cache.counterparty_delayed_payment_base_key, counterparty_htlc_base_key: self.counterparty_tx_cache.counterparty_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_counterparty_tx_csv: self.counterparty_tx_cache.on_counterparty_tx_csv};
1731 claimable_outpoints.push(ClaimRequest { absolute_timelock: htlc.cltv_expiry, aggregable: true, outpoint: BitcoinOutPoint { txid: commitment_txid, vout: transaction_output_index }, witness_data });
1736 // Last, track onchain revoked commitment transaction and fail backward outgoing HTLCs as payment path is broken
1737 if !claimable_outpoints.is_empty() || per_commitment_option.is_some() { // ie we're confident this is actually ours
1738 // We're definitely a counterparty commitment transaction!
1739 log_trace!(logger, "Got broadcast of revoked counterparty commitment transaction, going to generate general spend tx with {} inputs", claimable_outpoints.len());
1740 for (idx, outp) in tx.output.iter().enumerate() {
1741 watch_outputs.push((idx as u32, outp.clone()));
1743 self.counterparty_commitment_txn_on_chain.insert(commitment_txid, commitment_number);
1745 macro_rules! check_htlc_fails {
1746 ($txid: expr, $commitment_tx: expr) => {
1747 if let Some(ref outpoints) = self.counterparty_claimable_outpoints.get($txid) {
1748 for &(ref htlc, ref source_option) in outpoints.iter() {
1749 if let &Some(ref source) = source_option {
1750 self.onchain_events_awaiting_threshold_conf.retain(|ref entry| {
1751 if entry.height != height { return true; }
1753 OnchainEvent::HTLCUpdate { ref htlc_update } => {
1754 htlc_update.0 != **source
1759 let entry = OnchainEventEntry {
1762 event: OnchainEvent::HTLCUpdate {
1763 htlc_update: ((**source).clone(), htlc.payment_hash.clone())
1766 log_info!(logger, "Failing HTLC with payment_hash {} from {} counterparty commitment tx due to broadcast of revoked counterparty commitment transaction, waiting for confirmation (at height {})", log_bytes!(htlc.payment_hash.0), $commitment_tx, entry.confirmation_threshold());
1767 self.onchain_events_awaiting_threshold_conf.push(entry);
1773 if let Some(ref txid) = self.current_counterparty_commitment_txid {
1774 check_htlc_fails!(txid, "current");
1776 if let Some(ref txid) = self.prev_counterparty_commitment_txid {
1777 check_htlc_fails!(txid, "counterparty");
1779 // No need to check holder commitment txn, symmetric HTLCSource must be present as per-htlc data on counterparty commitment tx
1781 } else if let Some(per_commitment_data) = per_commitment_option {
1782 // While this isn't useful yet, there is a potential race where if a counterparty
1783 // revokes a state at the same time as the commitment transaction for that state is
1784 // confirmed, and the watchtower receives the block before the user, the user could
1785 // upload a new ChannelMonitor with the revocation secret but the watchtower has
1786 // already processed the block, resulting in the counterparty_commitment_txn_on_chain entry
1787 // not being generated by the above conditional. Thus, to be safe, we go ahead and
1789 for (idx, outp) in tx.output.iter().enumerate() {
1790 watch_outputs.push((idx as u32, outp.clone()));
1792 self.counterparty_commitment_txn_on_chain.insert(commitment_txid, commitment_number);
1794 log_trace!(logger, "Got broadcast of non-revoked counterparty commitment transaction {}", commitment_txid);
1796 macro_rules! check_htlc_fails {
1797 ($txid: expr, $commitment_tx: expr, $id: tt) => {
1798 if let Some(ref latest_outpoints) = self.counterparty_claimable_outpoints.get($txid) {
1799 $id: for &(ref htlc, ref source_option) in latest_outpoints.iter() {
1800 if let &Some(ref source) = source_option {
1801 // Check if the HTLC is present in the commitment transaction that was
1802 // broadcast, but not if it was below the dust limit, which we should
1803 // fail backwards immediately as there is no way for us to learn the
1804 // payment_preimage.
1805 // Note that if the dust limit were allowed to change between
1806 // commitment transactions we'd want to be check whether *any*
1807 // broadcastable commitment transaction has the HTLC in it, but it
1808 // cannot currently change after channel initialization, so we don't
1810 for &(ref broadcast_htlc, ref broadcast_source) in per_commitment_data.iter() {
1811 if broadcast_htlc.transaction_output_index.is_some() && Some(source) == broadcast_source.as_ref() {
1815 log_trace!(logger, "Failing HTLC with payment_hash {} from {} counterparty commitment tx due to broadcast of counterparty commitment transaction", log_bytes!(htlc.payment_hash.0), $commitment_tx);
1816 self.onchain_events_awaiting_threshold_conf.retain(|ref entry| {
1817 if entry.height != height { return true; }
1819 OnchainEvent::HTLCUpdate { ref htlc_update } => {
1820 htlc_update.0 != **source
1825 self.onchain_events_awaiting_threshold_conf.push(OnchainEventEntry {
1828 event: OnchainEvent::HTLCUpdate {
1829 htlc_update: ((**source).clone(), htlc.payment_hash.clone())
1837 if let Some(ref txid) = self.current_counterparty_commitment_txid {
1838 check_htlc_fails!(txid, "current", 'current_loop);
1840 if let Some(ref txid) = self.prev_counterparty_commitment_txid {
1841 check_htlc_fails!(txid, "previous", 'prev_loop);
1844 let htlc_claim_reqs = self.get_counterparty_htlc_output_claim_reqs(commitment_number, commitment_txid, Some(tx));
1845 for req in htlc_claim_reqs {
1846 claimable_outpoints.push(req);
1850 (claimable_outpoints, (commitment_txid, watch_outputs))
1853 fn get_counterparty_htlc_output_claim_reqs(&self, commitment_number: u64, commitment_txid: Txid, tx: Option<&Transaction>) -> Vec<ClaimRequest> {
1854 let mut claims = Vec::new();
1855 if let Some(htlc_outputs) = self.counterparty_claimable_outpoints.get(&commitment_txid) {
1856 if let Some(revocation_points) = self.their_cur_revocation_points {
1857 let revocation_point_option =
1858 // If the counterparty commitment tx is the latest valid state, use their latest
1859 // per-commitment point
1860 if revocation_points.0 == commitment_number { Some(&revocation_points.1) }
1861 else if let Some(point) = revocation_points.2.as_ref() {
1862 // If counterparty commitment tx is the state previous to the latest valid state, use
1863 // their previous per-commitment point (non-atomicity of revocation means it's valid for
1864 // them to temporarily have two valid commitment txns from our viewpoint)
1865 if revocation_points.0 == commitment_number + 1 { Some(point) } else { None }
1867 if let Some(revocation_point) = revocation_point_option {
1868 for (_, &(ref htlc, _)) in htlc_outputs.iter().enumerate() {
1869 if let Some(transaction_output_index) = htlc.transaction_output_index {
1870 if let Some(transaction) = tx {
1871 if transaction_output_index as usize >= transaction.output.len() ||
1872 transaction.output[transaction_output_index as usize].value != htlc.amount_msat / 1000 {
1873 return claims; // Corrupted per_commitment_data, fuck this user
1878 if let Some(p) = self.payment_preimages.get(&htlc.payment_hash) {
1882 let aggregable = if !htlc.offered { false } else { true };
1883 if preimage.is_some() || !htlc.offered {
1884 let witness_data = InputMaterial::CounterpartyHTLC { per_commitment_point: *revocation_point, counterparty_delayed_payment_base_key: self.counterparty_tx_cache.counterparty_delayed_payment_base_key, counterparty_htlc_base_key: self.counterparty_tx_cache.counterparty_htlc_base_key, preimage, htlc: htlc.clone() };
1885 claims.push(ClaimRequest { absolute_timelock: htlc.cltv_expiry, aggregable, outpoint: BitcoinOutPoint { txid: commitment_txid, vout: transaction_output_index }, witness_data });
1895 /// Attempts to claim a counterparty HTLC-Success/HTLC-Timeout's outputs using the revocation key
1896 fn check_spend_counterparty_htlc<L: Deref>(&mut self, tx: &Transaction, commitment_number: u64, height: u32, logger: &L) -> (Vec<ClaimRequest>, Option<TransactionOutputs>) where L::Target: Logger {
1897 let htlc_txid = tx.txid();
1898 if tx.input.len() != 1 || tx.output.len() != 1 || tx.input[0].witness.len() != 5 {
1899 return (Vec::new(), None)
1902 macro_rules! ignore_error {
1903 ( $thing : expr ) => {
1906 Err(_) => return (Vec::new(), None)
1911 let secret = if let Some(secret) = self.get_secret(commitment_number) { secret } else { return (Vec::new(), None); };
1912 let per_commitment_key = ignore_error!(SecretKey::from_slice(&secret));
1913 let per_commitment_point = PublicKey::from_secret_key(&self.secp_ctx, &per_commitment_key);
1915 log_trace!(logger, "Counterparty HTLC broadcast {}:{}", htlc_txid, 0);
1916 let witness_data = InputMaterial::Revoked { per_commitment_point, counterparty_delayed_payment_base_key: self.counterparty_tx_cache.counterparty_delayed_payment_base_key, counterparty_htlc_base_key: self.counterparty_tx_cache.counterparty_htlc_base_key, per_commitment_key, input_descriptor: InputDescriptors::RevokedOutput, amount: tx.output[0].value, htlc: None, on_counterparty_tx_csv: self.counterparty_tx_cache.on_counterparty_tx_csv };
1917 let claimable_outpoints = vec!(ClaimRequest { absolute_timelock: height + self.counterparty_tx_cache.on_counterparty_tx_csv as u32, aggregable: true, outpoint: BitcoinOutPoint { txid: htlc_txid, vout: 0}, witness_data });
1918 let outputs = vec![(0, tx.output[0].clone())];
1919 (claimable_outpoints, Some((htlc_txid, outputs)))
1922 // Returns (1) `ClaimRequest`s that can be given to the OnChainTxHandler, so that the handler can
1923 // broadcast transactions claiming holder HTLC commitment outputs and (2) a holder revokable
1924 // script so we can detect whether a holder transaction has been seen on-chain.
1925 fn get_broadcasted_holder_claims(&self, holder_tx: &HolderSignedTx) -> (Vec<ClaimRequest>, Option<(Script, PublicKey, PublicKey)>) {
1926 let mut claim_requests = Vec::with_capacity(holder_tx.htlc_outputs.len());
1928 let redeemscript = chan_utils::get_revokeable_redeemscript(&holder_tx.revocation_key, self.on_holder_tx_csv, &holder_tx.delayed_payment_key);
1929 let broadcasted_holder_revokable_script = Some((redeemscript.to_v0_p2wsh(), holder_tx.per_commitment_point.clone(), holder_tx.revocation_key.clone()));
1931 for &(ref htlc, _, _) in holder_tx.htlc_outputs.iter() {
1932 if let Some(transaction_output_index) = htlc.transaction_output_index {
1933 claim_requests.push(ClaimRequest { absolute_timelock: ::std::u32::MAX, aggregable: false, outpoint: BitcoinOutPoint { txid: holder_tx.txid, vout: transaction_output_index as u32 },
1934 witness_data: InputMaterial::HolderHTLC {
1935 preimage: if !htlc.offered {
1936 if let Some(preimage) = self.payment_preimages.get(&htlc.payment_hash) {
1937 Some(preimage.clone())
1939 // We can't build an HTLC-Success transaction without the preimage
1943 amount: htlc.amount_msat,
1948 (claim_requests, broadcasted_holder_revokable_script)
1951 // Returns holder HTLC outputs to watch and react to in case of spending.
1952 fn get_broadcasted_holder_watch_outputs(&self, holder_tx: &HolderSignedTx, commitment_tx: &Transaction) -> Vec<(u32, TxOut)> {
1953 let mut watch_outputs = Vec::with_capacity(holder_tx.htlc_outputs.len());
1954 for &(ref htlc, _, _) in holder_tx.htlc_outputs.iter() {
1955 if let Some(transaction_output_index) = htlc.transaction_output_index {
1956 watch_outputs.push((transaction_output_index, commitment_tx.output[transaction_output_index as usize].clone()));
1962 /// Attempts to claim any claimable HTLCs in a commitment transaction which was not (yet)
1963 /// revoked using data in holder_claimable_outpoints.
1964 /// Should not be used if check_spend_revoked_transaction succeeds.
1965 fn check_spend_holder_transaction<L: Deref>(&mut self, tx: &Transaction, height: u32, logger: &L) -> (Vec<ClaimRequest>, TransactionOutputs) where L::Target: Logger {
1966 let commitment_txid = tx.txid();
1967 let mut claim_requests = Vec::new();
1968 let mut watch_outputs = Vec::new();
1970 macro_rules! wait_threshold_conf {
1971 ($source: expr, $commitment_tx: expr, $payment_hash: expr) => {
1972 self.onchain_events_awaiting_threshold_conf.retain(|ref entry| {
1973 if entry.height != height { return true; }
1975 OnchainEvent::HTLCUpdate { ref htlc_update } => {
1976 htlc_update.0 != $source
1981 let entry = OnchainEventEntry {
1982 txid: commitment_txid,
1984 event: OnchainEvent::HTLCUpdate { htlc_update: ($source, $payment_hash) },
1986 log_trace!(logger, "Failing HTLC with payment_hash {} from {} holder commitment tx due to broadcast of transaction, waiting confirmation (at height{})", log_bytes!($payment_hash.0), $commitment_tx, entry.confirmation_threshold());
1987 self.onchain_events_awaiting_threshold_conf.push(entry);
1991 macro_rules! append_onchain_update {
1992 ($updates: expr, $to_watch: expr) => {
1993 claim_requests = $updates.0;
1994 self.broadcasted_holder_revokable_script = $updates.1;
1995 watch_outputs.append(&mut $to_watch);
1999 // HTLCs set may differ between last and previous holder commitment txn, in case of one them hitting chain, ensure we cancel all HTLCs backward
2000 let mut is_holder_tx = false;
2002 if self.current_holder_commitment_tx.txid == commitment_txid {
2003 is_holder_tx = true;
2004 log_trace!(logger, "Got latest holder commitment tx broadcast, searching for available HTLCs to claim");
2005 let res = self.get_broadcasted_holder_claims(&self.current_holder_commitment_tx);
2006 let mut to_watch = self.get_broadcasted_holder_watch_outputs(&self.current_holder_commitment_tx, tx);
2007 append_onchain_update!(res, to_watch);
2008 } else if let &Some(ref holder_tx) = &self.prev_holder_signed_commitment_tx {
2009 if holder_tx.txid == commitment_txid {
2010 is_holder_tx = true;
2011 log_trace!(logger, "Got previous holder commitment tx broadcast, searching for available HTLCs to claim");
2012 let res = self.get_broadcasted_holder_claims(holder_tx);
2013 let mut to_watch = self.get_broadcasted_holder_watch_outputs(holder_tx, tx);
2014 append_onchain_update!(res, to_watch);
2018 macro_rules! fail_dust_htlcs_after_threshold_conf {
2019 ($holder_tx: expr) => {
2020 for &(ref htlc, _, ref source) in &$holder_tx.htlc_outputs {
2021 if htlc.transaction_output_index.is_none() {
2022 if let &Some(ref source) = source {
2023 wait_threshold_conf!(source.clone(), "lastest", htlc.payment_hash.clone());
2031 fail_dust_htlcs_after_threshold_conf!(self.current_holder_commitment_tx);
2032 if let &Some(ref holder_tx) = &self.prev_holder_signed_commitment_tx {
2033 fail_dust_htlcs_after_threshold_conf!(holder_tx);
2037 (claim_requests, (commitment_txid, watch_outputs))
2040 pub fn get_latest_holder_commitment_txn<L: Deref>(&mut self, logger: &L) -> Vec<Transaction> where L::Target: Logger {
2041 log_trace!(logger, "Getting signed latest holder commitment transaction!");
2042 self.holder_tx_signed = true;
2043 let commitment_tx = self.onchain_tx_handler.get_fully_signed_holder_tx(&self.funding_redeemscript);
2044 let txid = commitment_tx.txid();
2045 let mut res = vec![commitment_tx];
2046 for htlc in self.current_holder_commitment_tx.htlc_outputs.iter() {
2047 if let Some(vout) = htlc.0.transaction_output_index {
2048 let preimage = if !htlc.0.offered {
2049 if let Some(preimage) = self.payment_preimages.get(&htlc.0.payment_hash) { Some(preimage.clone()) } else {
2050 // We can't build an HTLC-Success transaction without the preimage
2054 if let Some(htlc_tx) = self.onchain_tx_handler.get_fully_signed_htlc_tx(
2055 &::bitcoin::OutPoint { txid, vout }, &preimage) {
2060 // 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.
2061 // The data will be re-generated and tracked in check_spend_holder_transaction if we get a confirmation.
2065 #[cfg(any(test,feature = "unsafe_revoked_tx_signing"))]
2066 fn unsafe_get_latest_holder_commitment_txn<L: Deref>(&mut self, logger: &L) -> Vec<Transaction> where L::Target: Logger {
2067 log_trace!(logger, "Getting signed copy of latest holder commitment transaction!");
2068 let commitment_tx = self.onchain_tx_handler.get_fully_signed_copy_holder_tx(&self.funding_redeemscript);
2069 let txid = commitment_tx.txid();
2070 let mut res = vec![commitment_tx];
2071 for htlc in self.current_holder_commitment_tx.htlc_outputs.iter() {
2072 if let Some(vout) = htlc.0.transaction_output_index {
2073 let preimage = if !htlc.0.offered {
2074 if let Some(preimage) = self.payment_preimages.get(&htlc.0.payment_hash) { Some(preimage.clone()) } else {
2075 // We can't build an HTLC-Success transaction without the preimage
2079 if let Some(htlc_tx) = self.onchain_tx_handler.unsafe_get_fully_signed_htlc_tx(
2080 &::bitcoin::OutPoint { txid, vout }, &preimage) {
2088 pub fn block_connected<B: Deref, F: Deref, L: Deref>(&mut self, header: &BlockHeader, txdata: &TransactionData, height: u32, broadcaster: B, fee_estimator: F, logger: L) -> Vec<TransactionOutputs>
2089 where B::Target: BroadcasterInterface,
2090 F::Target: FeeEstimator,
2093 let block_hash = header.block_hash();
2094 log_trace!(logger, "New best block {} at height {}", block_hash, height);
2095 self.best_block = BestBlock::new(block_hash, height);
2097 self.transactions_confirmed(header, txdata, height, broadcaster, fee_estimator, logger)
2100 fn best_block_updated<B: Deref, F: Deref, L: Deref>(
2102 header: &BlockHeader,
2107 ) -> Vec<TransactionOutputs>
2109 B::Target: BroadcasterInterface,
2110 F::Target: FeeEstimator,
2113 let block_hash = header.block_hash();
2114 log_trace!(logger, "New best block {} at height {}", block_hash, height);
2116 if height > self.best_block.height() {
2117 self.best_block = BestBlock::new(block_hash, height);
2118 self.block_confirmed(height, vec![], vec![], vec![], broadcaster, fee_estimator, logger)
2120 self.best_block = BestBlock::new(block_hash, height);
2121 self.onchain_events_awaiting_threshold_conf.retain(|ref entry| entry.height <= height);
2122 self.onchain_tx_handler.block_disconnected(height + 1, broadcaster, fee_estimator, logger);
2127 fn transactions_confirmed<B: Deref, F: Deref, L: Deref>(
2129 header: &BlockHeader,
2130 txdata: &TransactionData,
2135 ) -> Vec<TransactionOutputs>
2137 B::Target: BroadcasterInterface,
2138 F::Target: FeeEstimator,
2141 let txn_matched = self.filter_block(txdata);
2142 for tx in &txn_matched {
2143 let mut output_val = 0;
2144 for out in tx.output.iter() {
2145 if out.value > 21_000_000_0000_0000 { panic!("Value-overflowing transaction provided to block connected"); }
2146 output_val += out.value;
2147 if output_val > 21_000_000_0000_0000 { panic!("Value-overflowing transaction provided to block connected"); }
2151 let block_hash = header.block_hash();
2152 log_trace!(logger, "Block {} at height {} connected with {} txn matched", block_hash, height, txn_matched.len());
2154 let mut watch_outputs = Vec::new();
2155 let mut claimable_outpoints = Vec::new();
2156 for tx in &txn_matched {
2157 if tx.input.len() == 1 {
2158 // Assuming our keys were not leaked (in which case we're screwed no matter what),
2159 // commitment transactions and HTLC transactions will all only ever have one input,
2160 // which is an easy way to filter out any potential non-matching txn for lazy
2162 let prevout = &tx.input[0].previous_output;
2163 if prevout.txid == self.funding_info.0.txid && prevout.vout == self.funding_info.0.index as u32 {
2164 if (tx.input[0].sequence >> 8*3) as u8 == 0x80 && (tx.lock_time >> 8*3) as u8 == 0x20 {
2165 let (mut new_outpoints, new_outputs) = self.check_spend_counterparty_transaction(&tx, height, &logger);
2166 if !new_outputs.1.is_empty() {
2167 watch_outputs.push(new_outputs);
2169 if new_outpoints.is_empty() {
2170 let (mut new_outpoints, new_outputs) = self.check_spend_holder_transaction(&tx, height, &logger);
2171 if !new_outputs.1.is_empty() {
2172 watch_outputs.push(new_outputs);
2174 claimable_outpoints.append(&mut new_outpoints);
2176 claimable_outpoints.append(&mut new_outpoints);
2179 if let Some(&commitment_number) = self.counterparty_commitment_txn_on_chain.get(&prevout.txid) {
2180 let (mut new_outpoints, new_outputs_option) = self.check_spend_counterparty_htlc(&tx, commitment_number, height, &logger);
2181 claimable_outpoints.append(&mut new_outpoints);
2182 if let Some(new_outputs) = new_outputs_option {
2183 watch_outputs.push(new_outputs);
2188 // While all commitment/HTLC-Success/HTLC-Timeout transactions have one input, HTLCs
2189 // can also be resolved in a few other ways which can have more than one output. Thus,
2190 // we call is_resolving_htlc_output here outside of the tx.input.len() == 1 check.
2191 self.is_resolving_htlc_output(&tx, height, &logger);
2193 self.is_paying_spendable_output(&tx, height, &logger);
2196 self.block_confirmed(height, txn_matched, watch_outputs, claimable_outpoints, broadcaster, fee_estimator, logger)
2199 fn block_confirmed<B: Deref, F: Deref, L: Deref>(
2202 txn_matched: Vec<&Transaction>,
2203 mut watch_outputs: Vec<TransactionOutputs>,
2204 mut claimable_outpoints: Vec<ClaimRequest>,
2208 ) -> Vec<TransactionOutputs>
2210 B::Target: BroadcasterInterface,
2211 F::Target: FeeEstimator,
2214 let should_broadcast = self.would_broadcast_at_height(height, &logger);
2215 if should_broadcast {
2216 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() }});
2217 self.pending_monitor_events.push(MonitorEvent::CommitmentTxBroadcasted(self.funding_info.0));
2218 let commitment_tx = self.onchain_tx_handler.get_fully_signed_holder_tx(&self.funding_redeemscript);
2219 self.holder_tx_signed = true;
2220 let (mut new_outpoints, _) = self.get_broadcasted_holder_claims(&self.current_holder_commitment_tx);
2221 let new_outputs = self.get_broadcasted_holder_watch_outputs(&self.current_holder_commitment_tx, &commitment_tx);
2222 if !new_outputs.is_empty() {
2223 watch_outputs.push((self.current_holder_commitment_tx.txid.clone(), new_outputs));
2225 claimable_outpoints.append(&mut new_outpoints);
2228 // Find which on-chain events have reached their confirmation threshold.
2229 let onchain_events_awaiting_threshold_conf =
2230 self.onchain_events_awaiting_threshold_conf.drain(..).collect::<Vec<_>>();
2231 let mut onchain_events_reaching_threshold_conf = Vec::new();
2232 for entry in onchain_events_awaiting_threshold_conf {
2233 if entry.has_reached_confirmation_threshold(height) {
2234 onchain_events_reaching_threshold_conf.push(entry);
2236 self.onchain_events_awaiting_threshold_conf.push(entry);
2240 // Used to check for duplicate HTLC resolutions.
2241 #[cfg(debug_assertions)]
2242 let unmatured_htlcs: Vec<_> = self.onchain_events_awaiting_threshold_conf
2244 .filter_map(|entry| match &entry.event {
2245 OnchainEvent::HTLCUpdate { htlc_update } => Some(htlc_update.0.clone()),
2246 OnchainEvent::MaturingOutput { .. } => None,
2249 #[cfg(debug_assertions)]
2250 let mut matured_htlcs = Vec::new();
2252 // Produce actionable events from on-chain events having reached their threshold.
2253 for entry in onchain_events_reaching_threshold_conf.drain(..) {
2255 OnchainEvent::HTLCUpdate { htlc_update } => {
2256 // Check for duplicate HTLC resolutions.
2257 #[cfg(debug_assertions)]
2260 unmatured_htlcs.iter().find(|&htlc| htlc == &htlc_update.0).is_none(),
2261 "An unmature HTLC transaction conflicts with a maturing one; failed to \
2262 call either transaction_unconfirmed for the conflicting transaction \
2263 or block_disconnected for a block containing it.");
2265 matured_htlcs.iter().find(|&htlc| htlc == &htlc_update.0).is_none(),
2266 "A matured HTLC transaction conflicts with a maturing one; failed to \
2267 call either transaction_unconfirmed for the conflicting transaction \
2268 or block_disconnected for a block containing it.");
2269 matured_htlcs.push(htlc_update.0.clone());
2272 log_trace!(logger, "HTLC {} failure update has got enough confirmations to be passed upstream", log_bytes!((htlc_update.1).0));
2273 self.pending_monitor_events.push(MonitorEvent::HTLCEvent(HTLCUpdate {
2274 payment_hash: htlc_update.1,
2275 payment_preimage: None,
2276 source: htlc_update.0,
2279 OnchainEvent::MaturingOutput { descriptor } => {
2280 log_trace!(logger, "Descriptor {} has got enough confirmations to be passed upstream", log_spendable!(descriptor));
2281 self.pending_events.push(Event::SpendableOutputs {
2282 outputs: vec![descriptor]
2288 self.onchain_tx_handler.update_claims_view(&txn_matched, claimable_outpoints, Some(height), &&*broadcaster, &&*fee_estimator, &&*logger);
2290 // Determine new outputs to watch by comparing against previously known outputs to watch,
2291 // updating the latter in the process.
2292 watch_outputs.retain(|&(ref txid, ref txouts)| {
2293 let idx_and_scripts = txouts.iter().map(|o| (o.0, o.1.script_pubkey.clone())).collect();
2294 self.outputs_to_watch.insert(txid.clone(), idx_and_scripts).is_none()
2298 // If we see a transaction for which we registered outputs previously,
2299 // make sure the registered scriptpubkey at the expected index match
2300 // the actual transaction output one. We failed this case before #653.
2301 for tx in &txn_matched {
2302 if let Some(outputs) = self.get_outputs_to_watch().get(&tx.txid()) {
2303 for idx_and_script in outputs.iter() {
2304 assert!((idx_and_script.0 as usize) < tx.output.len());
2305 assert_eq!(tx.output[idx_and_script.0 as usize].script_pubkey, idx_and_script.1);
2313 pub fn block_disconnected<B: Deref, F: Deref, L: Deref>(&mut self, header: &BlockHeader, height: u32, broadcaster: B, fee_estimator: F, logger: L)
2314 where B::Target: BroadcasterInterface,
2315 F::Target: FeeEstimator,
2318 log_trace!(logger, "Block {} at height {} disconnected", header.block_hash(), height);
2321 //- htlc update there as failure-trigger tx (revoked commitment tx, non-revoked commitment tx, HTLC-timeout tx) has been disconnected
2322 //- maturing spendable output has transaction paying us has been disconnected
2323 self.onchain_events_awaiting_threshold_conf.retain(|ref entry| entry.height < height);
2325 self.onchain_tx_handler.block_disconnected(height, broadcaster, fee_estimator, logger);
2327 self.best_block = BestBlock::new(header.prev_blockhash, height - 1);
2330 fn transaction_unconfirmed<B: Deref, F: Deref, L: Deref>(
2337 B::Target: BroadcasterInterface,
2338 F::Target: FeeEstimator,
2341 self.onchain_events_awaiting_threshold_conf.retain(|ref entry| entry.txid != *txid);
2342 self.onchain_tx_handler.transaction_unconfirmed(txid, broadcaster, fee_estimator, logger);
2345 /// Filters a block's `txdata` for transactions spending watched outputs or for any child
2346 /// transactions thereof.
2347 fn filter_block<'a>(&self, txdata: &TransactionData<'a>) -> Vec<&'a Transaction> {
2348 let mut matched_txn = HashSet::new();
2349 txdata.iter().filter(|&&(_, tx)| {
2350 let mut matches = self.spends_watched_output(tx);
2351 for input in tx.input.iter() {
2352 if matches { break; }
2353 if matched_txn.contains(&input.previous_output.txid) {
2358 matched_txn.insert(tx.txid());
2361 }).map(|(_, tx)| *tx).collect()
2364 /// Checks if a given transaction spends any watched outputs.
2365 fn spends_watched_output(&self, tx: &Transaction) -> bool {
2366 for input in tx.input.iter() {
2367 if let Some(outputs) = self.get_outputs_to_watch().get(&input.previous_output.txid) {
2368 for (idx, _script_pubkey) in outputs.iter() {
2369 if *idx == input.previous_output.vout {
2372 // If the expected script is a known type, check that the witness
2373 // appears to be spending the correct type (ie that the match would
2374 // actually succeed in BIP 158/159-style filters).
2375 if _script_pubkey.is_v0_p2wsh() {
2376 assert_eq!(&bitcoin::Address::p2wsh(&Script::from(input.witness.last().unwrap().clone()), bitcoin::Network::Bitcoin).script_pubkey(), _script_pubkey);
2377 } else if _script_pubkey.is_v0_p2wpkh() {
2378 assert_eq!(&bitcoin::Address::p2wpkh(&bitcoin::PublicKey::from_slice(&input.witness.last().unwrap()).unwrap(), bitcoin::Network::Bitcoin).unwrap().script_pubkey(), _script_pubkey);
2379 } else { panic!(); }
2390 fn would_broadcast_at_height<L: Deref>(&self, height: u32, logger: &L) -> bool where L::Target: Logger {
2391 // We need to consider all HTLCs which are:
2392 // * in any unrevoked counterparty commitment transaction, as they could broadcast said
2393 // transactions and we'd end up in a race, or
2394 // * are in our latest holder commitment transaction, as this is the thing we will
2395 // broadcast if we go on-chain.
2396 // Note that we consider HTLCs which were below dust threshold here - while they don't
2397 // strictly imply that we need to fail the channel, we need to go ahead and fail them back
2398 // to the source, and if we don't fail the channel we will have to ensure that the next
2399 // updates that peer sends us are update_fails, failing the channel if not. It's probably
2400 // easier to just fail the channel as this case should be rare enough anyway.
2401 macro_rules! scan_commitment {
2402 ($htlcs: expr, $holder_tx: expr) => {
2403 for ref htlc in $htlcs {
2404 // For inbound HTLCs which we know the preimage for, we have to ensure we hit the
2405 // chain with enough room to claim the HTLC without our counterparty being able to
2406 // time out the HTLC first.
2407 // For outbound HTLCs which our counterparty hasn't failed/claimed, our primary
2408 // concern is being able to claim the corresponding inbound HTLC (on another
2409 // channel) before it expires. In fact, we don't even really care if our
2410 // counterparty here claims such an outbound HTLC after it expired as long as we
2411 // can still claim the corresponding HTLC. Thus, to avoid needlessly hitting the
2412 // chain when our counterparty is waiting for expiration to off-chain fail an HTLC
2413 // we give ourselves a few blocks of headroom after expiration before going
2414 // on-chain for an expired HTLC.
2415 // Note that, to avoid a potential attack whereby a node delays claiming an HTLC
2416 // from us until we've reached the point where we go on-chain with the
2417 // corresponding inbound HTLC, we must ensure that outbound HTLCs go on chain at
2418 // least CLTV_CLAIM_BUFFER blocks prior to the inbound HTLC.
2419 // aka outbound_cltv + LATENCY_GRACE_PERIOD_BLOCKS == height - CLTV_CLAIM_BUFFER
2420 // inbound_cltv == height + CLTV_CLAIM_BUFFER
2421 // outbound_cltv + LATENCY_GRACE_PERIOD_BLOCKS + CLTV_CLAIM_BUFFER <= inbound_cltv - CLTV_CLAIM_BUFFER
2422 // LATENCY_GRACE_PERIOD_BLOCKS + 2*CLTV_CLAIM_BUFFER <= inbound_cltv - outbound_cltv
2423 // CLTV_EXPIRY_DELTA <= inbound_cltv - outbound_cltv (by check in ChannelManager::decode_update_add_htlc_onion)
2424 // LATENCY_GRACE_PERIOD_BLOCKS + 2*CLTV_CLAIM_BUFFER <= CLTV_EXPIRY_DELTA
2425 // The final, above, condition is checked for statically in channelmanager
2426 // with CHECK_CLTV_EXPIRY_SANITY_2.
2427 let htlc_outbound = $holder_tx == htlc.offered;
2428 if ( htlc_outbound && htlc.cltv_expiry + LATENCY_GRACE_PERIOD_BLOCKS <= height) ||
2429 (!htlc_outbound && htlc.cltv_expiry <= height + CLTV_CLAIM_BUFFER && self.payment_preimages.contains_key(&htlc.payment_hash)) {
2430 log_info!(logger, "Force-closing channel due to {} HTLC timeout, HTLC expiry is {}", if htlc_outbound { "outbound" } else { "inbound "}, htlc.cltv_expiry);
2437 scan_commitment!(self.current_holder_commitment_tx.htlc_outputs.iter().map(|&(ref a, _, _)| a), true);
2439 if let Some(ref txid) = self.current_counterparty_commitment_txid {
2440 if let Some(ref htlc_outputs) = self.counterparty_claimable_outpoints.get(txid) {
2441 scan_commitment!(htlc_outputs.iter().map(|&(ref a, _)| a), false);
2444 if let Some(ref txid) = self.prev_counterparty_commitment_txid {
2445 if let Some(ref htlc_outputs) = self.counterparty_claimable_outpoints.get(txid) {
2446 scan_commitment!(htlc_outputs.iter().map(|&(ref a, _)| a), false);
2453 /// Check if any transaction broadcasted is resolving HTLC output by a success or timeout on a holder
2454 /// or counterparty commitment tx, if so send back the source, preimage if found and payment_hash of resolved HTLC
2455 fn is_resolving_htlc_output<L: Deref>(&mut self, tx: &Transaction, height: u32, logger: &L) where L::Target: Logger {
2456 'outer_loop: for input in &tx.input {
2457 let mut payment_data = None;
2458 let revocation_sig_claim = (input.witness.len() == 3 && HTLCType::scriptlen_to_htlctype(input.witness[2].len()) == Some(HTLCType::OfferedHTLC) && input.witness[1].len() == 33)
2459 || (input.witness.len() == 3 && HTLCType::scriptlen_to_htlctype(input.witness[2].len()) == Some(HTLCType::AcceptedHTLC) && input.witness[1].len() == 33);
2460 let accepted_preimage_claim = input.witness.len() == 5 && HTLCType::scriptlen_to_htlctype(input.witness[4].len()) == Some(HTLCType::AcceptedHTLC);
2461 let offered_preimage_claim = input.witness.len() == 3 && HTLCType::scriptlen_to_htlctype(input.witness[2].len()) == Some(HTLCType::OfferedHTLC);
2463 macro_rules! log_claim {
2464 ($tx_info: expr, $holder_tx: expr, $htlc: expr, $source_avail: expr) => {
2465 // We found the output in question, but aren't failing it backwards
2466 // as we have no corresponding source and no valid counterparty commitment txid
2467 // to try a weak source binding with same-hash, same-value still-valid offered HTLC.
2468 // This implies either it is an inbound HTLC or an outbound HTLC on a revoked transaction.
2469 let outbound_htlc = $holder_tx == $htlc.offered;
2470 if ($holder_tx && revocation_sig_claim) ||
2471 (outbound_htlc && !$source_avail && (accepted_preimage_claim || offered_preimage_claim)) {
2472 log_error!(logger, "Input spending {} ({}:{}) in {} resolves {} HTLC with payment hash {} with {}!",
2473 $tx_info, input.previous_output.txid, input.previous_output.vout, tx.txid(),
2474 if outbound_htlc { "outbound" } else { "inbound" }, log_bytes!($htlc.payment_hash.0),
2475 if revocation_sig_claim { "revocation sig" } else { "preimage claim after we'd passed the HTLC resolution back" });
2477 log_info!(logger, "Input spending {} ({}:{}) in {} resolves {} HTLC with payment hash {} with {}",
2478 $tx_info, input.previous_output.txid, input.previous_output.vout, tx.txid(),
2479 if outbound_htlc { "outbound" } else { "inbound" }, log_bytes!($htlc.payment_hash.0),
2480 if revocation_sig_claim { "revocation sig" } else if accepted_preimage_claim || offered_preimage_claim { "preimage" } else { "timeout" });
2485 macro_rules! check_htlc_valid_counterparty {
2486 ($counterparty_txid: expr, $htlc_output: expr) => {
2487 if let Some(txid) = $counterparty_txid {
2488 for &(ref pending_htlc, ref pending_source) in self.counterparty_claimable_outpoints.get(&txid).unwrap() {
2489 if pending_htlc.payment_hash == $htlc_output.payment_hash && pending_htlc.amount_msat == $htlc_output.amount_msat {
2490 if let &Some(ref source) = pending_source {
2491 log_claim!("revoked counterparty commitment tx", false, pending_htlc, true);
2492 payment_data = Some(((**source).clone(), $htlc_output.payment_hash));
2501 macro_rules! scan_commitment {
2502 ($htlcs: expr, $tx_info: expr, $holder_tx: expr) => {
2503 for (ref htlc_output, source_option) in $htlcs {
2504 if Some(input.previous_output.vout) == htlc_output.transaction_output_index {
2505 if let Some(ref source) = source_option {
2506 log_claim!($tx_info, $holder_tx, htlc_output, true);
2507 // We have a resolution of an HTLC either from one of our latest
2508 // holder commitment transactions or an unrevoked counterparty commitment
2509 // transaction. This implies we either learned a preimage, the HTLC
2510 // has timed out, or we screwed up. In any case, we should now
2511 // resolve the source HTLC with the original sender.
2512 payment_data = Some(((*source).clone(), htlc_output.payment_hash));
2513 } else if !$holder_tx {
2514 check_htlc_valid_counterparty!(self.current_counterparty_commitment_txid, htlc_output);
2515 if payment_data.is_none() {
2516 check_htlc_valid_counterparty!(self.prev_counterparty_commitment_txid, htlc_output);
2519 if payment_data.is_none() {
2520 log_claim!($tx_info, $holder_tx, htlc_output, false);
2521 continue 'outer_loop;
2528 if input.previous_output.txid == self.current_holder_commitment_tx.txid {
2529 scan_commitment!(self.current_holder_commitment_tx.htlc_outputs.iter().map(|&(ref a, _, ref b)| (a, b.as_ref())),
2530 "our latest holder commitment tx", true);
2532 if let Some(ref prev_holder_signed_commitment_tx) = self.prev_holder_signed_commitment_tx {
2533 if input.previous_output.txid == prev_holder_signed_commitment_tx.txid {
2534 scan_commitment!(prev_holder_signed_commitment_tx.htlc_outputs.iter().map(|&(ref a, _, ref b)| (a, b.as_ref())),
2535 "our previous holder commitment tx", true);
2538 if let Some(ref htlc_outputs) = self.counterparty_claimable_outpoints.get(&input.previous_output.txid) {
2539 scan_commitment!(htlc_outputs.iter().map(|&(ref a, ref b)| (a, (b.as_ref().clone()).map(|boxed| &**boxed))),
2540 "counterparty commitment tx", false);
2543 // Check that scan_commitment, above, decided there is some source worth relaying an
2544 // HTLC resolution backwards to and figure out whether we learned a preimage from it.
2545 if let Some((source, payment_hash)) = payment_data {
2546 let mut payment_preimage = PaymentPreimage([0; 32]);
2547 if accepted_preimage_claim {
2548 if !self.pending_monitor_events.iter().any(
2549 |update| if let &MonitorEvent::HTLCEvent(ref upd) = update { upd.source == source } else { false }) {
2550 payment_preimage.0.copy_from_slice(&input.witness[3]);
2551 self.pending_monitor_events.push(MonitorEvent::HTLCEvent(HTLCUpdate {
2553 payment_preimage: Some(payment_preimage),
2557 } else if offered_preimage_claim {
2558 if !self.pending_monitor_events.iter().any(
2559 |update| if let &MonitorEvent::HTLCEvent(ref upd) = update {
2560 upd.source == source
2562 payment_preimage.0.copy_from_slice(&input.witness[1]);
2563 self.pending_monitor_events.push(MonitorEvent::HTLCEvent(HTLCUpdate {
2565 payment_preimage: Some(payment_preimage),
2570 self.onchain_events_awaiting_threshold_conf.retain(|ref entry| {
2571 if entry.height != height { return true; }
2573 OnchainEvent::HTLCUpdate { ref htlc_update } => {
2574 htlc_update.0 != source
2579 let entry = OnchainEventEntry {
2582 event: OnchainEvent::HTLCUpdate { htlc_update: (source, payment_hash) },
2584 log_info!(logger, "Failing HTLC with payment_hash {} timeout by a spend tx, waiting for confirmation (at height{})", log_bytes!(payment_hash.0), entry.confirmation_threshold());
2585 self.onchain_events_awaiting_threshold_conf.push(entry);
2591 /// Check if any transaction broadcasted is paying fund back to some address we can assume to own
2592 fn is_paying_spendable_output<L: Deref>(&mut self, tx: &Transaction, height: u32, logger: &L) where L::Target: Logger {
2593 let mut spendable_output = None;
2594 for (i, outp) in tx.output.iter().enumerate() { // There is max one spendable output for any channel tx, including ones generated by us
2595 if i > ::std::u16::MAX as usize {
2596 // While it is possible that an output exists on chain which is greater than the
2597 // 2^16th output in a given transaction, this is only possible if the output is not
2598 // in a lightning transaction and was instead placed there by some third party who
2599 // wishes to give us money for no reason.
2600 // Namely, any lightning transactions which we pre-sign will never have anywhere
2601 // near 2^16 outputs both because such transactions must have ~2^16 outputs who's
2602 // scripts are not longer than one byte in length and because they are inherently
2603 // non-standard due to their size.
2604 // Thus, it is completely safe to ignore such outputs, and while it may result in
2605 // us ignoring non-lightning fund to us, that is only possible if someone fills
2606 // nearly a full block with garbage just to hit this case.
2609 if outp.script_pubkey == self.destination_script {
2610 spendable_output = Some(SpendableOutputDescriptor::StaticOutput {
2611 outpoint: OutPoint { txid: tx.txid(), index: i as u16 },
2612 output: outp.clone(),
2615 } else if let Some(ref broadcasted_holder_revokable_script) = self.broadcasted_holder_revokable_script {
2616 if broadcasted_holder_revokable_script.0 == outp.script_pubkey {
2617 spendable_output = Some(SpendableOutputDescriptor::DelayedPaymentOutput(DelayedPaymentOutputDescriptor {
2618 outpoint: OutPoint { txid: tx.txid(), index: i as u16 },
2619 per_commitment_point: broadcasted_holder_revokable_script.1,
2620 to_self_delay: self.on_holder_tx_csv,
2621 output: outp.clone(),
2622 revocation_pubkey: broadcasted_holder_revokable_script.2.clone(),
2623 channel_keys_id: self.channel_keys_id,
2624 channel_value_satoshis: self.channel_value_satoshis,
2628 } else if self.counterparty_payment_script == outp.script_pubkey {
2629 spendable_output = Some(SpendableOutputDescriptor::StaticPaymentOutput(StaticPaymentOutputDescriptor {
2630 outpoint: OutPoint { txid: tx.txid(), index: i as u16 },
2631 output: outp.clone(),
2632 channel_keys_id: self.channel_keys_id,
2633 channel_value_satoshis: self.channel_value_satoshis,
2636 } else if outp.script_pubkey == self.shutdown_script {
2637 spendable_output = Some(SpendableOutputDescriptor::StaticOutput {
2638 outpoint: OutPoint { txid: tx.txid(), index: i as u16 },
2639 output: outp.clone(),
2643 if let Some(spendable_output) = spendable_output {
2644 let entry = OnchainEventEntry {
2647 event: OnchainEvent::MaturingOutput { descriptor: spendable_output.clone() },
2649 log_trace!(logger, "Maturing {} until {}", log_spendable!(spendable_output), entry.confirmation_threshold());
2650 self.onchain_events_awaiting_threshold_conf.push(entry);
2655 /// `Persist` defines behavior for persisting channel monitors: this could mean
2656 /// writing once to disk, and/or uploading to one or more backup services.
2658 /// Note that for every new monitor, you **must** persist the new `ChannelMonitor`
2659 /// to disk/backups. And, on every update, you **must** persist either the
2660 /// `ChannelMonitorUpdate` or the updated monitor itself. Otherwise, there is risk
2661 /// of situations such as revoking a transaction, then crashing before this
2662 /// revocation can be persisted, then unintentionally broadcasting a revoked
2663 /// transaction and losing money. This is a risk because previous channel states
2664 /// are toxic, so it's important that whatever channel state is persisted is
2665 /// kept up-to-date.
2666 pub trait Persist<ChannelSigner: Sign>: Send + Sync {
2667 /// Persist a new channel's data. The data can be stored any way you want, but
2668 /// the identifier provided by Rust-Lightning is the channel's outpoint (and
2669 /// it is up to you to maintain a correct mapping between the outpoint and the
2670 /// stored channel data). Note that you **must** persist every new monitor to
2671 /// disk. See the `Persist` trait documentation for more details.
2673 /// See [`ChannelMonitor::write`] for writing out a `ChannelMonitor`,
2674 /// and [`ChannelMonitorUpdateErr`] for requirements when returning errors.
2675 fn persist_new_channel(&self, id: OutPoint, data: &ChannelMonitor<ChannelSigner>) -> Result<(), ChannelMonitorUpdateErr>;
2677 /// Update one channel's data. The provided `ChannelMonitor` has already
2678 /// applied the given update.
2680 /// Note that on every update, you **must** persist either the
2681 /// `ChannelMonitorUpdate` or the updated monitor itself to disk/backups. See
2682 /// the `Persist` trait documentation for more details.
2684 /// If an implementer chooses to persist the updates only, they need to make
2685 /// sure that all the updates are applied to the `ChannelMonitors` *before*
2686 /// the set of channel monitors is given to the `ChannelManager`
2687 /// deserialization routine. See [`ChannelMonitor::update_monitor`] for
2688 /// applying a monitor update to a monitor. If full `ChannelMonitors` are
2689 /// persisted, then there is no need to persist individual updates.
2691 /// Note that there could be a performance tradeoff between persisting complete
2692 /// channel monitors on every update vs. persisting only updates and applying
2693 /// them in batches. The size of each monitor grows `O(number of state updates)`
2694 /// whereas updates are small and `O(1)`.
2696 /// See [`ChannelMonitor::write`] for writing out a `ChannelMonitor`,
2697 /// [`ChannelMonitorUpdate::write`] for writing out an update, and
2698 /// [`ChannelMonitorUpdateErr`] for requirements when returning errors.
2699 fn update_persisted_channel(&self, id: OutPoint, update: &ChannelMonitorUpdate, data: &ChannelMonitor<ChannelSigner>) -> Result<(), ChannelMonitorUpdateErr>;
2702 impl<Signer: Sign, T: Deref, F: Deref, L: Deref> chain::Listen for (ChannelMonitor<Signer>, T, F, L)
2704 T::Target: BroadcasterInterface,
2705 F::Target: FeeEstimator,
2708 fn block_connected(&self, block: &Block, height: u32) {
2709 let txdata: Vec<_> = block.txdata.iter().enumerate().collect();
2710 self.0.block_connected(&block.header, &txdata, height, &*self.1, &*self.2, &*self.3);
2713 fn block_disconnected(&self, header: &BlockHeader, height: u32) {
2714 self.0.block_disconnected(header, height, &*self.1, &*self.2, &*self.3);
2718 impl<Signer: Sign, T: Deref, F: Deref, L: Deref> chain::Confirm for (ChannelMonitor<Signer>, T, F, L)
2720 T::Target: BroadcasterInterface,
2721 F::Target: FeeEstimator,
2724 fn transactions_confirmed(&self, header: &BlockHeader, txdata: &TransactionData, height: u32) {
2725 self.0.transactions_confirmed(header, txdata, height, &*self.1, &*self.2, &*self.3);
2728 fn transaction_unconfirmed(&self, txid: &Txid) {
2729 self.0.transaction_unconfirmed(txid, &*self.1, &*self.2, &*self.3);
2732 fn best_block_updated(&self, header: &BlockHeader, height: u32) {
2733 self.0.best_block_updated(header, height, &*self.1, &*self.2, &*self.3);
2736 fn get_relevant_txids(&self) -> Vec<Txid> {
2737 self.0.get_relevant_txids()
2741 const MAX_ALLOC_SIZE: usize = 64*1024;
2743 impl<'a, Signer: Sign, K: KeysInterface<Signer = Signer>> ReadableArgs<&'a K>
2744 for (BlockHash, ChannelMonitor<Signer>) {
2745 fn read<R: ::std::io::Read>(reader: &mut R, keys_manager: &'a K) -> Result<Self, DecodeError> {
2746 macro_rules! unwrap_obj {
2750 Err(_) => return Err(DecodeError::InvalidValue),
2755 let _ver: u8 = Readable::read(reader)?;
2756 let min_ver: u8 = Readable::read(reader)?;
2757 if min_ver > SERIALIZATION_VERSION {
2758 return Err(DecodeError::UnknownVersion);
2761 let latest_update_id: u64 = Readable::read(reader)?;
2762 let commitment_transaction_number_obscure_factor = <U48 as Readable>::read(reader)?.0;
2764 let destination_script = Readable::read(reader)?;
2765 let broadcasted_holder_revokable_script = match <u8 as Readable>::read(reader)? {
2767 let revokable_address = Readable::read(reader)?;
2768 let per_commitment_point = Readable::read(reader)?;
2769 let revokable_script = Readable::read(reader)?;
2770 Some((revokable_address, per_commitment_point, revokable_script))
2773 _ => return Err(DecodeError::InvalidValue),
2775 let counterparty_payment_script = Readable::read(reader)?;
2776 let shutdown_script = Readable::read(reader)?;
2778 let channel_keys_id = Readable::read(reader)?;
2779 let holder_revocation_basepoint = Readable::read(reader)?;
2780 // Technically this can fail and serialize fail a round-trip, but only for serialization of
2781 // barely-init'd ChannelMonitors that we can't do anything with.
2782 let outpoint = OutPoint {
2783 txid: Readable::read(reader)?,
2784 index: Readable::read(reader)?,
2786 let funding_info = (outpoint, Readable::read(reader)?);
2787 let current_counterparty_commitment_txid = Readable::read(reader)?;
2788 let prev_counterparty_commitment_txid = Readable::read(reader)?;
2790 let counterparty_tx_cache = Readable::read(reader)?;
2791 let funding_redeemscript = Readable::read(reader)?;
2792 let channel_value_satoshis = Readable::read(reader)?;
2794 let their_cur_revocation_points = {
2795 let first_idx = <U48 as Readable>::read(reader)?.0;
2799 let first_point = Readable::read(reader)?;
2800 let second_point_slice: [u8; 33] = Readable::read(reader)?;
2801 if second_point_slice[0..32] == [0; 32] && second_point_slice[32] == 0 {
2802 Some((first_idx, first_point, None))
2804 Some((first_idx, first_point, Some(unwrap_obj!(PublicKey::from_slice(&second_point_slice)))))
2809 let on_holder_tx_csv: u16 = Readable::read(reader)?;
2811 let commitment_secrets = Readable::read(reader)?;
2813 macro_rules! read_htlc_in_commitment {
2816 let offered: bool = Readable::read(reader)?;
2817 let amount_msat: u64 = Readable::read(reader)?;
2818 let cltv_expiry: u32 = Readable::read(reader)?;
2819 let payment_hash: PaymentHash = Readable::read(reader)?;
2820 let transaction_output_index: Option<u32> = Readable::read(reader)?;
2822 HTLCOutputInCommitment {
2823 offered, amount_msat, cltv_expiry, payment_hash, transaction_output_index
2829 let counterparty_claimable_outpoints_len: u64 = Readable::read(reader)?;
2830 let mut counterparty_claimable_outpoints = HashMap::with_capacity(cmp::min(counterparty_claimable_outpoints_len as usize, MAX_ALLOC_SIZE / 64));
2831 for _ in 0..counterparty_claimable_outpoints_len {
2832 let txid: Txid = Readable::read(reader)?;
2833 let htlcs_count: u64 = Readable::read(reader)?;
2834 let mut htlcs = Vec::with_capacity(cmp::min(htlcs_count as usize, MAX_ALLOC_SIZE / 32));
2835 for _ in 0..htlcs_count {
2836 htlcs.push((read_htlc_in_commitment!(), <Option<HTLCSource> as Readable>::read(reader)?.map(|o: HTLCSource| Box::new(o))));
2838 if let Some(_) = counterparty_claimable_outpoints.insert(txid, htlcs) {
2839 return Err(DecodeError::InvalidValue);
2843 let counterparty_commitment_txn_on_chain_len: u64 = Readable::read(reader)?;
2844 let mut counterparty_commitment_txn_on_chain = HashMap::with_capacity(cmp::min(counterparty_commitment_txn_on_chain_len as usize, MAX_ALLOC_SIZE / 32));
2845 for _ in 0..counterparty_commitment_txn_on_chain_len {
2846 let txid: Txid = Readable::read(reader)?;
2847 let commitment_number = <U48 as Readable>::read(reader)?.0;
2848 if let Some(_) = counterparty_commitment_txn_on_chain.insert(txid, commitment_number) {
2849 return Err(DecodeError::InvalidValue);
2853 let counterparty_hash_commitment_number_len: u64 = Readable::read(reader)?;
2854 let mut counterparty_hash_commitment_number = HashMap::with_capacity(cmp::min(counterparty_hash_commitment_number_len as usize, MAX_ALLOC_SIZE / 32));
2855 for _ in 0..counterparty_hash_commitment_number_len {
2856 let payment_hash: PaymentHash = Readable::read(reader)?;
2857 let commitment_number = <U48 as Readable>::read(reader)?.0;
2858 if let Some(_) = counterparty_hash_commitment_number.insert(payment_hash, commitment_number) {
2859 return Err(DecodeError::InvalidValue);
2863 macro_rules! read_holder_tx {
2866 let txid = Readable::read(reader)?;
2867 let revocation_key = Readable::read(reader)?;
2868 let a_htlc_key = Readable::read(reader)?;
2869 let b_htlc_key = Readable::read(reader)?;
2870 let delayed_payment_key = Readable::read(reader)?;
2871 let per_commitment_point = Readable::read(reader)?;
2872 let feerate_per_kw: u32 = Readable::read(reader)?;
2874 let htlcs_len: u64 = Readable::read(reader)?;
2875 let mut htlcs = Vec::with_capacity(cmp::min(htlcs_len as usize, MAX_ALLOC_SIZE / 128));
2876 for _ in 0..htlcs_len {
2877 let htlc = read_htlc_in_commitment!();
2878 let sigs = match <u8 as Readable>::read(reader)? {
2880 1 => Some(Readable::read(reader)?),
2881 _ => return Err(DecodeError::InvalidValue),
2883 htlcs.push((htlc, sigs, Readable::read(reader)?));
2888 revocation_key, a_htlc_key, b_htlc_key, delayed_payment_key, per_commitment_point, feerate_per_kw,
2895 let prev_holder_signed_commitment_tx = match <u8 as Readable>::read(reader)? {
2898 Some(read_holder_tx!())
2900 _ => return Err(DecodeError::InvalidValue),
2902 let current_holder_commitment_tx = read_holder_tx!();
2904 let current_counterparty_commitment_number = <U48 as Readable>::read(reader)?.0;
2905 let current_holder_commitment_number = <U48 as Readable>::read(reader)?.0;
2907 let payment_preimages_len: u64 = Readable::read(reader)?;
2908 let mut payment_preimages = HashMap::with_capacity(cmp::min(payment_preimages_len as usize, MAX_ALLOC_SIZE / 32));
2909 for _ in 0..payment_preimages_len {
2910 let preimage: PaymentPreimage = Readable::read(reader)?;
2911 let hash = PaymentHash(Sha256::hash(&preimage.0[..]).into_inner());
2912 if let Some(_) = payment_preimages.insert(hash, preimage) {
2913 return Err(DecodeError::InvalidValue);
2917 let pending_monitor_events_len: u64 = Readable::read(reader)?;
2918 let mut pending_monitor_events = Vec::with_capacity(cmp::min(pending_monitor_events_len as usize, MAX_ALLOC_SIZE / (32 + 8*3)));
2919 for _ in 0..pending_monitor_events_len {
2920 let ev = match <u8 as Readable>::read(reader)? {
2921 0 => MonitorEvent::HTLCEvent(Readable::read(reader)?),
2922 1 => MonitorEvent::CommitmentTxBroadcasted(funding_info.0),
2923 _ => return Err(DecodeError::InvalidValue)
2925 pending_monitor_events.push(ev);
2928 let pending_events_len: u64 = Readable::read(reader)?;
2929 let mut pending_events = Vec::with_capacity(cmp::min(pending_events_len as usize, MAX_ALLOC_SIZE / mem::size_of::<Event>()));
2930 for _ in 0..pending_events_len {
2931 if let Some(event) = MaybeReadable::read(reader)? {
2932 pending_events.push(event);
2936 let best_block = BestBlock::new(Readable::read(reader)?, Readable::read(reader)?);
2938 let waiting_threshold_conf_len: u64 = Readable::read(reader)?;
2939 let mut onchain_events_awaiting_threshold_conf = Vec::with_capacity(cmp::min(waiting_threshold_conf_len as usize, MAX_ALLOC_SIZE / 128));
2940 for _ in 0..waiting_threshold_conf_len {
2941 let txid = Readable::read(reader)?;
2942 let height = Readable::read(reader)?;
2943 let event = match <u8 as Readable>::read(reader)? {
2945 let htlc_source = Readable::read(reader)?;
2946 let hash = Readable::read(reader)?;
2947 OnchainEvent::HTLCUpdate {
2948 htlc_update: (htlc_source, hash)
2952 let descriptor = Readable::read(reader)?;
2953 OnchainEvent::MaturingOutput {
2957 _ => return Err(DecodeError::InvalidValue),
2959 onchain_events_awaiting_threshold_conf.push(OnchainEventEntry { txid, height, event });
2962 let outputs_to_watch_len: u64 = Readable::read(reader)?;
2963 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::<u32>() + mem::size_of::<Vec<Script>>())));
2964 for _ in 0..outputs_to_watch_len {
2965 let txid = Readable::read(reader)?;
2966 let outputs_len: u64 = Readable::read(reader)?;
2967 let mut outputs = Vec::with_capacity(cmp::min(outputs_len as usize, MAX_ALLOC_SIZE / (mem::size_of::<u32>() + mem::size_of::<Script>())));
2968 for _ in 0..outputs_len {
2969 outputs.push((Readable::read(reader)?, Readable::read(reader)?));
2971 if let Some(_) = outputs_to_watch.insert(txid, outputs) {
2972 return Err(DecodeError::InvalidValue);
2975 let onchain_tx_handler = ReadableArgs::read(reader, keys_manager)?;
2977 let lockdown_from_offchain = Readable::read(reader)?;
2978 let holder_tx_signed = Readable::read(reader)?;
2980 let mut secp_ctx = Secp256k1::new();
2981 secp_ctx.seeded_randomize(&keys_manager.get_secure_random_bytes());
2983 Ok((best_block.block_hash(), ChannelMonitor {
2984 inner: Mutex::new(ChannelMonitorImpl {
2986 commitment_transaction_number_obscure_factor,
2989 broadcasted_holder_revokable_script,
2990 counterparty_payment_script,
2994 holder_revocation_basepoint,
2996 current_counterparty_commitment_txid,
2997 prev_counterparty_commitment_txid,
2999 counterparty_tx_cache,
3000 funding_redeemscript,
3001 channel_value_satoshis,
3002 their_cur_revocation_points,
3007 counterparty_claimable_outpoints,
3008 counterparty_commitment_txn_on_chain,
3009 counterparty_hash_commitment_number,
3011 prev_holder_signed_commitment_tx,
3012 current_holder_commitment_tx,
3013 current_counterparty_commitment_number,
3014 current_holder_commitment_number,
3017 pending_monitor_events,
3020 onchain_events_awaiting_threshold_conf,
3025 lockdown_from_offchain,
3038 use bitcoin::blockdata::script::{Script, Builder};
3039 use bitcoin::blockdata::opcodes;
3040 use bitcoin::blockdata::transaction::{Transaction, TxIn, TxOut, SigHashType};
3041 use bitcoin::blockdata::transaction::OutPoint as BitcoinOutPoint;
3042 use bitcoin::util::bip143;
3043 use bitcoin::hashes::Hash;
3044 use bitcoin::hashes::sha256::Hash as Sha256;
3045 use bitcoin::hashes::hex::FromHex;
3046 use bitcoin::hash_types::Txid;
3047 use bitcoin::network::constants::Network;
3049 use chain::channelmonitor::ChannelMonitor;
3050 use chain::transaction::OutPoint;
3051 use ln::channelmanager::{BestBlock, PaymentPreimage, PaymentHash};
3052 use ln::onchaintx::{OnchainTxHandler, InputDescriptors};
3054 use ln::chan_utils::{HTLCOutputInCommitment, ChannelPublicKeys, ChannelTransactionParameters, HolderCommitmentTransaction, CounterpartyChannelTransactionParameters};
3055 use util::test_utils::{TestLogger, TestBroadcaster, TestFeeEstimator};
3056 use bitcoin::secp256k1::key::{SecretKey,PublicKey};
3057 use bitcoin::secp256k1::Secp256k1;
3058 use std::sync::{Arc, Mutex};
3059 use chain::keysinterface::InMemorySigner;
3062 fn test_prune_preimages() {
3063 let secp_ctx = Secp256k1::new();
3064 let logger = Arc::new(TestLogger::new());
3065 let broadcaster = Arc::new(TestBroadcaster{txn_broadcasted: Mutex::new(Vec::new())});
3066 let fee_estimator = Arc::new(TestFeeEstimator { sat_per_kw: 253 });
3068 let dummy_key = PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[42; 32]).unwrap());
3069 let dummy_tx = Transaction { version: 0, lock_time: 0, input: Vec::new(), output: Vec::new() };
3071 let mut preimages = Vec::new();
3074 let preimage = PaymentPreimage([i; 32]);
3075 let hash = PaymentHash(Sha256::hash(&preimage.0[..]).into_inner());
3076 preimages.push((preimage, hash));
3080 macro_rules! preimages_slice_to_htlc_outputs {
3081 ($preimages_slice: expr) => {
3083 let mut res = Vec::new();
3084 for (idx, preimage) in $preimages_slice.iter().enumerate() {
3085 res.push((HTLCOutputInCommitment {
3089 payment_hash: preimage.1.clone(),
3090 transaction_output_index: Some(idx as u32),
3097 macro_rules! preimages_to_holder_htlcs {
3098 ($preimages_slice: expr) => {
3100 let mut inp = preimages_slice_to_htlc_outputs!($preimages_slice);
3101 let res: Vec<_> = inp.drain(..).map(|e| { (e.0, None, e.1) }).collect();
3107 macro_rules! test_preimages_exist {
3108 ($preimages_slice: expr, $monitor: expr) => {
3109 for preimage in $preimages_slice {
3110 assert!($monitor.inner.lock().unwrap().payment_preimages.contains_key(&preimage.1));
3115 let keys = InMemorySigner::new(
3117 SecretKey::from_slice(&[41; 32]).unwrap(),
3118 SecretKey::from_slice(&[41; 32]).unwrap(),
3119 SecretKey::from_slice(&[41; 32]).unwrap(),
3120 SecretKey::from_slice(&[41; 32]).unwrap(),
3121 SecretKey::from_slice(&[41; 32]).unwrap(),
3127 let counterparty_pubkeys = ChannelPublicKeys {
3128 funding_pubkey: PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[44; 32]).unwrap()),
3129 revocation_basepoint: PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[45; 32]).unwrap()),
3130 payment_point: PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[46; 32]).unwrap()),
3131 delayed_payment_basepoint: PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[47; 32]).unwrap()),
3132 htlc_basepoint: PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[48; 32]).unwrap())
3134 let funding_outpoint = OutPoint { txid: Default::default(), index: u16::max_value() };
3135 let channel_parameters = ChannelTransactionParameters {
3136 holder_pubkeys: keys.holder_channel_pubkeys.clone(),
3137 holder_selected_contest_delay: 66,
3138 is_outbound_from_holder: true,
3139 counterparty_parameters: Some(CounterpartyChannelTransactionParameters {
3140 pubkeys: counterparty_pubkeys,
3141 selected_contest_delay: 67,
3143 funding_outpoint: Some(funding_outpoint),
3145 // Prune with one old state and a holder commitment tx holding a few overlaps with the
3147 let best_block = BestBlock::from_genesis(Network::Testnet);
3148 let monitor = ChannelMonitor::new(Secp256k1::new(), keys,
3149 &PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[42; 32]).unwrap()), 0, &Script::new(),
3150 (OutPoint { txid: Txid::from_slice(&[43; 32]).unwrap(), index: 0 }, Script::new()),
3151 &channel_parameters,
3152 Script::new(), 46, 0,
3153 HolderCommitmentTransaction::dummy(), best_block);
3155 monitor.provide_latest_holder_commitment_tx(HolderCommitmentTransaction::dummy(), preimages_to_holder_htlcs!(preimages[0..10])).unwrap();
3156 let dummy_txid = dummy_tx.txid();
3157 monitor.provide_latest_counterparty_commitment_tx(dummy_txid, preimages_slice_to_htlc_outputs!(preimages[5..15]), 281474976710655, dummy_key, &logger);
3158 monitor.provide_latest_counterparty_commitment_tx(dummy_txid, preimages_slice_to_htlc_outputs!(preimages[15..20]), 281474976710654, dummy_key, &logger);
3159 monitor.provide_latest_counterparty_commitment_tx(dummy_txid, preimages_slice_to_htlc_outputs!(preimages[17..20]), 281474976710653, dummy_key, &logger);
3160 monitor.provide_latest_counterparty_commitment_tx(dummy_txid, preimages_slice_to_htlc_outputs!(preimages[18..20]), 281474976710652, dummy_key, &logger);
3161 for &(ref preimage, ref hash) in preimages.iter() {
3162 monitor.provide_payment_preimage(hash, preimage, &broadcaster, &fee_estimator, &logger);
3165 // Now provide a secret, pruning preimages 10-15
3166 let mut secret = [0; 32];
3167 secret[0..32].clone_from_slice(&hex::decode("7cc854b54e3e0dcdb010d7a3fee464a9687be6e8db3be6854c475621e007a5dc").unwrap());
3168 monitor.provide_secret(281474976710655, secret.clone()).unwrap();
3169 assert_eq!(monitor.inner.lock().unwrap().payment_preimages.len(), 15);
3170 test_preimages_exist!(&preimages[0..10], monitor);
3171 test_preimages_exist!(&preimages[15..20], monitor);
3173 // Now provide a further secret, pruning preimages 15-17
3174 secret[0..32].clone_from_slice(&hex::decode("c7518c8ae4660ed02894df8976fa1a3659c1a8b4b5bec0c4b872abeba4cb8964").unwrap());
3175 monitor.provide_secret(281474976710654, secret.clone()).unwrap();
3176 assert_eq!(monitor.inner.lock().unwrap().payment_preimages.len(), 13);
3177 test_preimages_exist!(&preimages[0..10], monitor);
3178 test_preimages_exist!(&preimages[17..20], monitor);
3180 // Now update holder commitment tx info, pruning only element 18 as we still care about the
3181 // previous commitment tx's preimages too
3182 monitor.provide_latest_holder_commitment_tx(HolderCommitmentTransaction::dummy(), preimages_to_holder_htlcs!(preimages[0..5])).unwrap();
3183 secret[0..32].clone_from_slice(&hex::decode("2273e227a5b7449b6e70f1fb4652864038b1cbf9cd7c043a7d6456b7fc275ad8").unwrap());
3184 monitor.provide_secret(281474976710653, secret.clone()).unwrap();
3185 assert_eq!(monitor.inner.lock().unwrap().payment_preimages.len(), 12);
3186 test_preimages_exist!(&preimages[0..10], monitor);
3187 test_preimages_exist!(&preimages[18..20], monitor);
3189 // But if we do it again, we'll prune 5-10
3190 monitor.provide_latest_holder_commitment_tx(HolderCommitmentTransaction::dummy(), preimages_to_holder_htlcs!(preimages[0..3])).unwrap();
3191 secret[0..32].clone_from_slice(&hex::decode("27cddaa5624534cb6cb9d7da077cf2b22ab21e9b506fd4998a51d54502e99116").unwrap());
3192 monitor.provide_secret(281474976710652, secret.clone()).unwrap();
3193 assert_eq!(monitor.inner.lock().unwrap().payment_preimages.len(), 5);
3194 test_preimages_exist!(&preimages[0..5], monitor);
3198 fn test_claim_txn_weight_computation() {
3199 // We test Claim txn weight, knowing that we want expected weigth and
3200 // not actual case to avoid sigs and time-lock delays hell variances.
3202 let secp_ctx = Secp256k1::new();
3203 let privkey = SecretKey::from_slice(&hex::decode("0101010101010101010101010101010101010101010101010101010101010101").unwrap()[..]).unwrap();
3204 let pubkey = PublicKey::from_secret_key(&secp_ctx, &privkey);
3205 let mut sum_actual_sigs = 0;
3207 macro_rules! sign_input {
3208 ($sighash_parts: expr, $idx: expr, $amount: expr, $input_type: expr, $sum_actual_sigs: expr) => {
3209 let htlc = HTLCOutputInCommitment {
3210 offered: if *$input_type == InputDescriptors::RevokedOfferedHTLC || *$input_type == InputDescriptors::OfferedHTLC { true } else { false },
3212 cltv_expiry: 2 << 16,
3213 payment_hash: PaymentHash([1; 32]),
3214 transaction_output_index: Some($idx as u32),
3216 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) };
3217 let sighash = hash_to_message!(&$sighash_parts.signature_hash($idx, &redeem_script, $amount, SigHashType::All)[..]);
3218 let sig = secp_ctx.sign(&sighash, &privkey);
3219 $sighash_parts.access_witness($idx).push(sig.serialize_der().to_vec());
3220 $sighash_parts.access_witness($idx)[0].push(SigHashType::All as u8);
3221 sum_actual_sigs += $sighash_parts.access_witness($idx)[0].len();
3222 if *$input_type == InputDescriptors::RevokedOutput {
3223 $sighash_parts.access_witness($idx).push(vec!(1));
3224 } else if *$input_type == InputDescriptors::RevokedOfferedHTLC || *$input_type == InputDescriptors::RevokedReceivedHTLC {
3225 $sighash_parts.access_witness($idx).push(pubkey.clone().serialize().to_vec());
3226 } else if *$input_type == InputDescriptors::ReceivedHTLC {
3227 $sighash_parts.access_witness($idx).push(vec![0]);
3229 $sighash_parts.access_witness($idx).push(PaymentPreimage([1; 32]).0.to_vec());
3231 $sighash_parts.access_witness($idx).push(redeem_script.into_bytes());
3232 println!("witness[0] {}", $sighash_parts.access_witness($idx)[0].len());
3233 println!("witness[1] {}", $sighash_parts.access_witness($idx)[1].len());
3234 println!("witness[2] {}", $sighash_parts.access_witness($idx)[2].len());
3238 let script_pubkey = Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script();
3239 let txid = Txid::from_hex("56944c5d3f98413ef45cf54545538103cc9f298e0575820ad3591376e2e0f65d").unwrap();
3241 // Justice tx with 1 to_holder, 2 revoked offered HTLCs, 1 revoked received HTLCs
3242 let mut claim_tx = Transaction { version: 0, lock_time: 0, input: Vec::new(), output: Vec::new() };
3244 claim_tx.input.push(TxIn {
3245 previous_output: BitcoinOutPoint {
3249 script_sig: Script::new(),
3250 sequence: 0xfffffffd,
3251 witness: Vec::new(),
3254 claim_tx.output.push(TxOut {
3255 script_pubkey: script_pubkey.clone(),
3258 let base_weight = claim_tx.get_weight();
3259 let inputs_des = vec![InputDescriptors::RevokedOutput, InputDescriptors::RevokedOfferedHTLC, InputDescriptors::RevokedOfferedHTLC, InputDescriptors::RevokedReceivedHTLC];
3261 let mut sighash_parts = bip143::SigHashCache::new(&mut claim_tx);
3262 for (idx, inp) in inputs_des.iter().enumerate() {
3263 sign_input!(sighash_parts, idx, 0, inp, sum_actual_sigs);
3266 assert_eq!(base_weight + OnchainTxHandler::<InMemorySigner>::get_witnesses_weight(&inputs_des[..]), claim_tx.get_weight() + /* max_length_sig */ (73 * inputs_des.len() - sum_actual_sigs));
3268 // Claim tx with 1 offered HTLCs, 3 received HTLCs
3269 claim_tx.input.clear();
3270 sum_actual_sigs = 0;
3272 claim_tx.input.push(TxIn {
3273 previous_output: BitcoinOutPoint {
3277 script_sig: Script::new(),
3278 sequence: 0xfffffffd,
3279 witness: Vec::new(),
3282 let base_weight = claim_tx.get_weight();
3283 let inputs_des = vec![InputDescriptors::OfferedHTLC, InputDescriptors::ReceivedHTLC, InputDescriptors::ReceivedHTLC, InputDescriptors::ReceivedHTLC];
3285 let mut sighash_parts = bip143::SigHashCache::new(&mut claim_tx);
3286 for (idx, inp) in inputs_des.iter().enumerate() {
3287 sign_input!(sighash_parts, idx, 0, inp, sum_actual_sigs);
3290 assert_eq!(base_weight + OnchainTxHandler::<InMemorySigner>::get_witnesses_weight(&inputs_des[..]), claim_tx.get_weight() + /* max_length_sig */ (73 * inputs_des.len() - sum_actual_sigs));
3292 // Justice tx with 1 revoked HTLC-Success tx output
3293 claim_tx.input.clear();
3294 sum_actual_sigs = 0;
3295 claim_tx.input.push(TxIn {
3296 previous_output: BitcoinOutPoint {
3300 script_sig: Script::new(),
3301 sequence: 0xfffffffd,
3302 witness: Vec::new(),
3304 let base_weight = claim_tx.get_weight();
3305 let inputs_des = vec![InputDescriptors::RevokedOutput];
3307 let mut sighash_parts = bip143::SigHashCache::new(&mut claim_tx);
3308 for (idx, inp) in inputs_des.iter().enumerate() {
3309 sign_input!(sighash_parts, idx, 0, inp, sum_actual_sigs);
3312 assert_eq!(base_weight + OnchainTxHandler::<InMemorySigner>::get_witnesses_weight(&inputs_des[..]), claim_tx.get_weight() + /* max_length_isg */ (73 * inputs_des.len() - sum_actual_sigs));
3315 // Further testing is done in the ChannelManager integration tests.