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::BlockHeader;
24 use bitcoin::blockdata::transaction::{OutPoint as BitcoinOutPoint, TxOut, Transaction};
25 use bitcoin::blockdata::script::{Script, Builder};
26 use bitcoin::blockdata::opcodes;
28 use bitcoin::hashes::Hash;
29 use bitcoin::hashes::sha256::Hash as Sha256;
30 use bitcoin::hash_types::{Txid, BlockHash, WPubkeyHash};
32 use bitcoin::secp256k1::{Secp256k1, ecdsa::Signature};
33 use bitcoin::secp256k1::{SecretKey, PublicKey};
34 use bitcoin::secp256k1;
36 use crate::ln::{PaymentHash, PaymentPreimage};
37 use crate::ln::msgs::DecodeError;
38 use crate::ln::chan_utils;
39 use crate::ln::chan_utils::{CounterpartyCommitmentSecrets, HTLCOutputInCommitment, HTLCClaim, ChannelTransactionParameters, HolderCommitmentTransaction};
40 use crate::ln::channelmanager::HTLCSource;
42 use crate::chain::{BestBlock, WatchedOutput};
43 use crate::chain::chaininterface::{BroadcasterInterface, FeeEstimator, LowerBoundedFeeEstimator};
44 use crate::chain::transaction::{OutPoint, TransactionData};
45 use crate::chain::keysinterface::{SpendableOutputDescriptor, StaticPaymentOutputDescriptor, DelayedPaymentOutputDescriptor, Sign, KeysInterface};
47 use crate::chain::onchaintx::ClaimEvent;
48 use crate::chain::onchaintx::OnchainTxHandler;
49 use crate::chain::package::{CounterpartyOfferedHTLCOutput, CounterpartyReceivedHTLCOutput, HolderFundingOutput, HolderHTLCOutput, PackageSolvingData, PackageTemplate, RevokedOutput, RevokedHTLCOutput};
50 use crate::chain::Filter;
51 use crate::util::logger::Logger;
52 use crate::util::ser::{Readable, ReadableArgs, MaybeReadable, Writer, Writeable, U48, OptionDeserWrapper};
53 use crate::util::byte_utils;
54 use crate::util::events::Event;
56 use crate::util::events::{AnchorDescriptor, BumpTransactionEvent};
58 use crate::prelude::*;
60 use crate::io::{self, Error};
61 use core::convert::TryInto;
63 use crate::sync::Mutex;
65 /// An update generated by the underlying channel itself which contains some new information the
66 /// [`ChannelMonitor`] should be made aware of.
68 /// Because this represents only a small number of updates to the underlying state, it is generally
69 /// much smaller than a full [`ChannelMonitor`]. However, for large single commitment transaction
70 /// updates (e.g. ones during which there are hundreds of HTLCs pending on the commitment
71 /// transaction), a single update may reach upwards of 1 MiB in serialized size.
72 #[cfg_attr(any(test, fuzzing, feature = "_test_utils"), derive(PartialEq, Eq))]
75 pub struct ChannelMonitorUpdate {
76 pub(crate) updates: Vec<ChannelMonitorUpdateStep>,
77 /// The sequence number of this update. Updates *must* be replayed in-order according to this
78 /// sequence number (and updates may panic if they are not). The update_id values are strictly
79 /// increasing and increase by one for each new update, with one exception specified below.
81 /// This sequence number is also used to track up to which points updates which returned
82 /// [`ChannelMonitorUpdateStatus::InProgress`] have been applied to all copies of a given
83 /// ChannelMonitor when ChannelManager::channel_monitor_updated is called.
85 /// The only instance where update_id values are not strictly increasing is the case where we
86 /// allow post-force-close updates with a special update ID of [`CLOSED_CHANNEL_UPDATE_ID`]. See
87 /// its docs for more details.
89 /// [`ChannelMonitorUpdateStatus::InProgress`]: super::ChannelMonitorUpdateStatus::InProgress
94 /// (1) a channel has been force closed and
95 /// (2) we receive a preimage from a forward link that allows us to spend an HTLC output on
96 /// this channel's (the backward link's) broadcasted commitment transaction
97 /// then we allow the `ChannelManager` to send a `ChannelMonitorUpdate` with this update ID,
98 /// with the update providing said payment preimage. No other update types are allowed after
100 pub const CLOSED_CHANNEL_UPDATE_ID: u64 = core::u64::MAX;
102 impl Writeable for ChannelMonitorUpdate {
103 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
104 write_ver_prefix!(w, SERIALIZATION_VERSION, MIN_SERIALIZATION_VERSION);
105 self.update_id.write(w)?;
106 (self.updates.len() as u64).write(w)?;
107 for update_step in self.updates.iter() {
108 update_step.write(w)?;
110 write_tlv_fields!(w, {});
114 impl Readable for ChannelMonitorUpdate {
115 fn read<R: io::Read>(r: &mut R) -> Result<Self, DecodeError> {
116 let _ver = read_ver_prefix!(r, SERIALIZATION_VERSION);
117 let update_id: u64 = Readable::read(r)?;
118 let len: u64 = Readable::read(r)?;
119 let mut updates = Vec::with_capacity(cmp::min(len as usize, MAX_ALLOC_SIZE / ::core::mem::size_of::<ChannelMonitorUpdateStep>()));
121 if let Some(upd) = MaybeReadable::read(r)? {
125 read_tlv_fields!(r, {});
126 Ok(Self { update_id, updates })
130 /// An event to be processed by the ChannelManager.
131 #[derive(Clone, PartialEq, Eq)]
132 pub enum MonitorEvent {
133 /// A monitor event containing an HTLCUpdate.
134 HTLCEvent(HTLCUpdate),
136 /// A monitor event that the Channel's commitment transaction was confirmed.
137 CommitmentTxConfirmed(OutPoint),
139 /// Indicates a [`ChannelMonitor`] update has completed. See
140 /// [`ChannelMonitorUpdateStatus::InProgress`] for more information on how this is used.
142 /// [`ChannelMonitorUpdateStatus::InProgress`]: super::ChannelMonitorUpdateStatus::InProgress
144 /// The funding outpoint of the [`ChannelMonitor`] that was updated
145 funding_txo: OutPoint,
146 /// The Update ID from [`ChannelMonitorUpdate::update_id`] which was applied or
147 /// [`ChannelMonitor::get_latest_update_id`].
149 /// Note that this should only be set to a given update's ID if all previous updates for the
150 /// same [`ChannelMonitor`] have been applied and persisted.
151 monitor_update_id: u64,
154 /// Indicates a [`ChannelMonitor`] update has failed. See
155 /// [`ChannelMonitorUpdateStatus::PermanentFailure`] for more information on how this is used.
157 /// [`ChannelMonitorUpdateStatus::PermanentFailure`]: super::ChannelMonitorUpdateStatus::PermanentFailure
158 UpdateFailed(OutPoint),
160 impl_writeable_tlv_based_enum_upgradable!(MonitorEvent,
161 // Note that Completed and UpdateFailed are currently never serialized to disk as they are
162 // generated only in ChainMonitor
164 (0, funding_txo, required),
165 (2, monitor_update_id, required),
169 (4, CommitmentTxConfirmed),
173 /// Simple structure sent back by `chain::Watch` when an HTLC from a forward channel is detected on
174 /// chain. Used to update the corresponding HTLC in the backward channel. Failing to pass the
175 /// preimage claim backward will lead to loss of funds.
176 #[derive(Clone, PartialEq, Eq)]
177 pub struct HTLCUpdate {
178 pub(crate) payment_hash: PaymentHash,
179 pub(crate) payment_preimage: Option<PaymentPreimage>,
180 pub(crate) source: HTLCSource,
181 pub(crate) htlc_value_satoshis: Option<u64>,
183 impl_writeable_tlv_based!(HTLCUpdate, {
184 (0, payment_hash, required),
185 (1, htlc_value_satoshis, option),
186 (2, source, required),
187 (4, payment_preimage, option),
190 /// If an HTLC expires within this many blocks, don't try to claim it in a shared transaction,
191 /// instead claiming it in its own individual transaction.
192 pub(crate) const CLTV_SHARED_CLAIM_BUFFER: u32 = 12;
193 /// If an HTLC expires within this many blocks, force-close the channel to broadcast the
194 /// HTLC-Success transaction.
195 /// In other words, this is an upper bound on how many blocks we think it can take us to get a
196 /// transaction confirmed (and we use it in a few more, equivalent, places).
197 pub(crate) const CLTV_CLAIM_BUFFER: u32 = 18;
198 /// Number of blocks by which point we expect our counterparty to have seen new blocks on the
199 /// network and done a full update_fail_htlc/commitment_signed dance (+ we've updated all our
200 /// copies of ChannelMonitors, including watchtowers). We could enforce the contract by failing
201 /// at CLTV expiration height but giving a grace period to our peer may be profitable for us if he
202 /// can provide an over-late preimage. Nevertheless, grace period has to be accounted in our
203 /// CLTV_EXPIRY_DELTA to be secure. Following this policy we may decrease the rate of channel failures
204 /// due to expiration but increase the cost of funds being locked longuer in case of failure.
205 /// This delay also cover a low-power peer being slow to process blocks and so being behind us on
206 /// accurate block height.
207 /// In case of onchain failure to be pass backward we may see the last block of ANTI_REORG_DELAY
208 /// with at worst this delay, so we are not only using this value as a mercy for them but also
209 /// us as a safeguard to delay with enough time.
210 pub(crate) const LATENCY_GRACE_PERIOD_BLOCKS: u32 = 3;
211 /// Number of blocks we wait on seeing a HTLC output being solved before we fail corresponding
212 /// inbound HTLCs. This prevents us from failing backwards and then getting a reorg resulting in us
215 /// Note that this is a library-wide security assumption. If a reorg deeper than this number of
216 /// blocks occurs, counterparties may be able to steal funds or claims made by and balances exposed
217 /// by a [`ChannelMonitor`] may be incorrect.
218 // We also use this delay to be sure we can remove our in-flight claim txn from bump candidates buffer.
219 // It may cause spurious generation of bumped claim txn but that's alright given the outpoint is already
220 // solved by a previous claim tx. What we want to avoid is reorg evicting our claim tx and us not
221 // keep bumping another claim tx to solve the outpoint.
222 pub const ANTI_REORG_DELAY: u32 = 6;
223 /// Number of blocks before confirmation at which we fail back an un-relayed HTLC or at which we
224 /// refuse to accept a new HTLC.
226 /// This is used for a few separate purposes:
227 /// 1) if we've received an MPP HTLC to us and it expires within this many blocks and we are
228 /// waiting on additional parts (or waiting on the preimage for any HTLC from the user), we will
230 /// 2) if we receive an HTLC within this many blocks of its expiry (plus one to avoid a race
231 /// condition with the above), we will fail this HTLC without telling the user we received it,
233 /// (1) is all about protecting us - we need enough time to update the channel state before we hit
234 /// CLTV_CLAIM_BUFFER, at which point we'd go on chain to claim the HTLC with the preimage.
236 /// (2) is the same, but with an additional buffer to avoid accepting an HTLC which is immediately
237 /// in a race condition between the user connecting a block (which would fail it) and the user
238 /// providing us the preimage (which would claim it).
239 pub(crate) const HTLC_FAIL_BACK_BUFFER: u32 = CLTV_CLAIM_BUFFER + LATENCY_GRACE_PERIOD_BLOCKS;
241 // TODO(devrandom) replace this with HolderCommitmentTransaction
242 #[derive(Clone, PartialEq, Eq)]
243 struct HolderSignedTx {
244 /// txid of the transaction in tx, just used to make comparison faster
246 revocation_key: PublicKey,
247 a_htlc_key: PublicKey,
248 b_htlc_key: PublicKey,
249 delayed_payment_key: PublicKey,
250 per_commitment_point: PublicKey,
251 htlc_outputs: Vec<(HTLCOutputInCommitment, Option<Signature>, Option<HTLCSource>)>,
252 to_self_value_sat: u64,
255 impl_writeable_tlv_based!(HolderSignedTx, {
257 // Note that this is filled in with data from OnchainTxHandler if it's missing.
258 // For HolderSignedTx objects serialized with 0.0.100+, this should be filled in.
259 (1, to_self_value_sat, (default_value, u64::max_value())),
260 (2, revocation_key, required),
261 (4, a_htlc_key, required),
262 (6, b_htlc_key, required),
263 (8, delayed_payment_key, required),
264 (10, per_commitment_point, required),
265 (12, feerate_per_kw, required),
266 (14, htlc_outputs, vec_type)
270 impl HolderSignedTx {
271 fn non_dust_htlcs(&self) -> Vec<HTLCOutputInCommitment> {
272 self.htlc_outputs.iter().filter_map(|(htlc, _, _)| {
273 if let Some(_) = htlc.transaction_output_index {
283 /// We use this to track static counterparty commitment transaction data and to generate any
284 /// justice or 2nd-stage preimage/timeout transactions.
285 #[derive(PartialEq, Eq)]
286 struct CounterpartyCommitmentParameters {
287 counterparty_delayed_payment_base_key: PublicKey,
288 counterparty_htlc_base_key: PublicKey,
289 on_counterparty_tx_csv: u16,
292 impl Writeable for CounterpartyCommitmentParameters {
293 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
294 w.write_all(&byte_utils::be64_to_array(0))?;
295 write_tlv_fields!(w, {
296 (0, self.counterparty_delayed_payment_base_key, required),
297 (2, self.counterparty_htlc_base_key, required),
298 (4, self.on_counterparty_tx_csv, required),
303 impl Readable for CounterpartyCommitmentParameters {
304 fn read<R: io::Read>(r: &mut R) -> Result<Self, DecodeError> {
305 let counterparty_commitment_transaction = {
306 // Versions prior to 0.0.100 had some per-HTLC state stored here, which is no longer
307 // used. Read it for compatibility.
308 let per_htlc_len: u64 = Readable::read(r)?;
309 for _ in 0..per_htlc_len {
310 let _txid: Txid = Readable::read(r)?;
311 let htlcs_count: u64 = Readable::read(r)?;
312 for _ in 0..htlcs_count {
313 let _htlc: HTLCOutputInCommitment = Readable::read(r)?;
317 let mut counterparty_delayed_payment_base_key = OptionDeserWrapper(None);
318 let mut counterparty_htlc_base_key = OptionDeserWrapper(None);
319 let mut on_counterparty_tx_csv: u16 = 0;
320 read_tlv_fields!(r, {
321 (0, counterparty_delayed_payment_base_key, required),
322 (2, counterparty_htlc_base_key, required),
323 (4, on_counterparty_tx_csv, required),
325 CounterpartyCommitmentParameters {
326 counterparty_delayed_payment_base_key: counterparty_delayed_payment_base_key.0.unwrap(),
327 counterparty_htlc_base_key: counterparty_htlc_base_key.0.unwrap(),
328 on_counterparty_tx_csv,
331 Ok(counterparty_commitment_transaction)
335 /// An entry for an [`OnchainEvent`], stating the block height and hash when the event was
336 /// observed, as well as the transaction causing it.
338 /// Used to determine when the on-chain event can be considered safe from a chain reorganization.
339 #[derive(PartialEq, Eq)]
340 struct OnchainEventEntry {
343 block_hash: Option<BlockHash>, // Added as optional, will be filled in for any entry generated on 0.0.113 or after
345 transaction: Option<Transaction>, // Added as optional, but always filled in, in LDK 0.0.110
348 impl OnchainEventEntry {
349 fn confirmation_threshold(&self) -> u32 {
350 let mut conf_threshold = self.height + ANTI_REORG_DELAY - 1;
352 OnchainEvent::MaturingOutput {
353 descriptor: SpendableOutputDescriptor::DelayedPaymentOutput(ref descriptor)
355 // A CSV'd transaction is confirmable in block (input height) + CSV delay, which means
356 // it's broadcastable when we see the previous block.
357 conf_threshold = cmp::max(conf_threshold, self.height + descriptor.to_self_delay as u32 - 1);
359 OnchainEvent::FundingSpendConfirmation { on_local_output_csv: Some(csv), .. } |
360 OnchainEvent::HTLCSpendConfirmation { on_to_local_output_csv: Some(csv), .. } => {
361 // A CSV'd transaction is confirmable in block (input height) + CSV delay, which means
362 // it's broadcastable when we see the previous block.
363 conf_threshold = cmp::max(conf_threshold, self.height + csv as u32 - 1);
370 fn has_reached_confirmation_threshold(&self, best_block: &BestBlock) -> bool {
371 best_block.height() >= self.confirmation_threshold()
375 /// The (output index, sats value) for the counterparty's output in a commitment transaction.
377 /// This was added as an `Option` in 0.0.110.
378 type CommitmentTxCounterpartyOutputInfo = Option<(u32, u64)>;
380 /// Upon discovering of some classes of onchain tx by ChannelMonitor, we may have to take actions on it
381 /// once they mature to enough confirmations (ANTI_REORG_DELAY)
382 #[derive(PartialEq, Eq)]
384 /// An outbound HTLC failing after a transaction is confirmed. Used
385 /// * when an outbound HTLC output is spent by us after the HTLC timed out
386 /// * an outbound HTLC which was not present in the commitment transaction which appeared
387 /// on-chain (either because it was not fully committed to or it was dust).
388 /// Note that this is *not* used for preimage claims, as those are passed upstream immediately,
389 /// appearing only as an `HTLCSpendConfirmation`, below.
392 payment_hash: PaymentHash,
393 htlc_value_satoshis: Option<u64>,
394 /// None in the second case, above, ie when there is no relevant output in the commitment
395 /// transaction which appeared on chain.
396 commitment_tx_output_idx: Option<u32>,
398 /// An output waiting on [`ANTI_REORG_DELAY`] confirmations before we hand the user the
399 /// [`SpendableOutputDescriptor`].
401 descriptor: SpendableOutputDescriptor,
403 /// A spend of the funding output, either a commitment transaction or a cooperative closing
405 FundingSpendConfirmation {
406 /// The CSV delay for the output of the funding spend transaction (implying it is a local
407 /// commitment transaction, and this is the delay on the to_self output).
408 on_local_output_csv: Option<u16>,
409 /// If the funding spend transaction was a known remote commitment transaction, we track
410 /// the output index and amount of the counterparty's `to_self` output here.
412 /// This allows us to generate a [`Balance::CounterpartyRevokedOutputClaimable`] for the
413 /// counterparty output.
414 commitment_tx_to_counterparty_output: CommitmentTxCounterpartyOutputInfo,
416 /// A spend of a commitment transaction HTLC output, set in the cases where *no* `HTLCUpdate`
417 /// is constructed. This is used when
418 /// * an outbound HTLC is claimed by our counterparty with a preimage, causing us to
419 /// immediately claim the HTLC on the inbound edge and track the resolution here,
420 /// * an inbound HTLC is claimed by our counterparty (with a timeout),
421 /// * an inbound HTLC is claimed by us (with a preimage).
422 /// * a revoked-state HTLC transaction was broadcasted, which was claimed by the revocation
424 /// * a revoked-state HTLC transaction was broadcasted, which was claimed by an
425 /// HTLC-Success/HTLC-Failure transaction (and is still claimable with a revocation
427 HTLCSpendConfirmation {
428 commitment_tx_output_idx: u32,
429 /// If the claim was made by either party with a preimage, this is filled in
430 preimage: Option<PaymentPreimage>,
431 /// If the claim was made by us on an inbound HTLC against a local commitment transaction,
432 /// we set this to the output CSV value which we will have to wait until to spend the
433 /// output (and generate a SpendableOutput event).
434 on_to_local_output_csv: Option<u16>,
438 impl Writeable for OnchainEventEntry {
439 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
440 write_tlv_fields!(writer, {
441 (0, self.txid, required),
442 (1, self.transaction, option),
443 (2, self.height, required),
444 (3, self.block_hash, option),
445 (4, self.event, required),
451 impl MaybeReadable for OnchainEventEntry {
452 fn read<R: io::Read>(reader: &mut R) -> Result<Option<Self>, DecodeError> {
453 let mut txid = Txid::all_zeros();
454 let mut transaction = None;
455 let mut block_hash = None;
457 let mut event = None;
458 read_tlv_fields!(reader, {
460 (1, transaction, option),
461 (2, height, required),
462 (3, block_hash, option),
463 (4, event, ignorable),
465 if let Some(ev) = event {
466 Ok(Some(Self { txid, transaction, height, block_hash, event: ev }))
473 impl_writeable_tlv_based_enum_upgradable!(OnchainEvent,
475 (0, source, required),
476 (1, htlc_value_satoshis, option),
477 (2, payment_hash, required),
478 (3, commitment_tx_output_idx, option),
480 (1, MaturingOutput) => {
481 (0, descriptor, required),
483 (3, FundingSpendConfirmation) => {
484 (0, on_local_output_csv, option),
485 (1, commitment_tx_to_counterparty_output, option),
487 (5, HTLCSpendConfirmation) => {
488 (0, commitment_tx_output_idx, required),
489 (2, preimage, option),
490 (4, on_to_local_output_csv, option),
495 #[cfg_attr(any(test, fuzzing, feature = "_test_utils"), derive(PartialEq, Eq))]
497 pub(crate) enum ChannelMonitorUpdateStep {
498 LatestHolderCommitmentTXInfo {
499 commitment_tx: HolderCommitmentTransaction,
500 htlc_outputs: Vec<(HTLCOutputInCommitment, Option<Signature>, Option<HTLCSource>)>,
502 LatestCounterpartyCommitmentTXInfo {
503 commitment_txid: Txid,
504 htlc_outputs: Vec<(HTLCOutputInCommitment, Option<Box<HTLCSource>>)>,
505 commitment_number: u64,
506 their_per_commitment_point: PublicKey,
509 payment_preimage: PaymentPreimage,
515 /// Used to indicate that the no future updates will occur, and likely that the latest holder
516 /// commitment transaction(s) should be broadcast, as the channel has been force-closed.
518 /// If set to false, we shouldn't broadcast the latest holder commitment transaction as we
519 /// think we've fallen behind!
520 should_broadcast: bool,
523 scriptpubkey: Script,
527 impl ChannelMonitorUpdateStep {
528 fn variant_name(&self) -> &'static str {
530 ChannelMonitorUpdateStep::LatestHolderCommitmentTXInfo { .. } => "LatestHolderCommitmentTXInfo",
531 ChannelMonitorUpdateStep::LatestCounterpartyCommitmentTXInfo { .. } => "LatestCounterpartyCommitmentTXInfo",
532 ChannelMonitorUpdateStep::PaymentPreimage { .. } => "PaymentPreimage",
533 ChannelMonitorUpdateStep::CommitmentSecret { .. } => "CommitmentSecret",
534 ChannelMonitorUpdateStep::ChannelForceClosed { .. } => "ChannelForceClosed",
535 ChannelMonitorUpdateStep::ShutdownScript { .. } => "ShutdownScript",
540 impl_writeable_tlv_based_enum_upgradable!(ChannelMonitorUpdateStep,
541 (0, LatestHolderCommitmentTXInfo) => {
542 (0, commitment_tx, required),
543 (2, htlc_outputs, vec_type),
545 (1, LatestCounterpartyCommitmentTXInfo) => {
546 (0, commitment_txid, required),
547 (2, commitment_number, required),
548 (4, their_per_commitment_point, required),
549 (6, htlc_outputs, vec_type),
551 (2, PaymentPreimage) => {
552 (0, payment_preimage, required),
554 (3, CommitmentSecret) => {
556 (2, secret, required),
558 (4, ChannelForceClosed) => {
559 (0, should_broadcast, required),
561 (5, ShutdownScript) => {
562 (0, scriptpubkey, required),
566 /// Details about the balance(s) available for spending once the channel appears on chain.
568 /// See [`ChannelMonitor::get_claimable_balances`] for more details on when these will or will not
570 #[derive(Clone, Debug, PartialEq, Eq)]
571 #[cfg_attr(test, derive(PartialOrd, Ord))]
573 /// The channel is not yet closed (or the commitment or closing transaction has not yet
574 /// appeared in a block). The given balance is claimable (less on-chain fees) if the channel is
575 /// force-closed now.
576 ClaimableOnChannelClose {
577 /// The amount available to claim, in satoshis, excluding the on-chain fees which will be
578 /// required to do so.
579 claimable_amount_satoshis: u64,
581 /// The channel has been closed, and the given balance is ours but awaiting confirmations until
582 /// we consider it spendable.
583 ClaimableAwaitingConfirmations {
584 /// The amount available to claim, in satoshis, possibly excluding the on-chain fees which
585 /// were spent in broadcasting the transaction.
586 claimable_amount_satoshis: u64,
587 /// The height at which an [`Event::SpendableOutputs`] event will be generated for this
589 confirmation_height: u32,
591 /// The channel has been closed, and the given balance should be ours but awaiting spending
592 /// transaction confirmation. If the spending transaction does not confirm in time, it is
593 /// possible our counterparty can take the funds by broadcasting an HTLC timeout on-chain.
595 /// Once the spending transaction confirms, before it has reached enough confirmations to be
596 /// considered safe from chain reorganizations, the balance will instead be provided via
597 /// [`Balance::ClaimableAwaitingConfirmations`].
598 ContentiousClaimable {
599 /// The amount available to claim, in satoshis, excluding the on-chain fees which will be
600 /// required to do so.
601 claimable_amount_satoshis: u64,
602 /// The height at which the counterparty may be able to claim the balance if we have not
606 /// HTLCs which we sent to our counterparty which are claimable after a timeout (less on-chain
607 /// fees) if the counterparty does not know the preimage for the HTLCs. These are somewhat
608 /// likely to be claimed by our counterparty before we do.
609 MaybeTimeoutClaimableHTLC {
610 /// The amount potentially available to claim, in satoshis, excluding the on-chain fees
611 /// which will be required to do so.
612 claimable_amount_satoshis: u64,
613 /// The height at which we will be able to claim the balance if our counterparty has not
615 claimable_height: u32,
617 /// HTLCs which we received from our counterparty which are claimable with a preimage which we
618 /// do not currently have. This will only be claimable if we receive the preimage from the node
619 /// to which we forwarded this HTLC before the timeout.
620 MaybePreimageClaimableHTLC {
621 /// The amount potentially available to claim, in satoshis, excluding the on-chain fees
622 /// which will be required to do so.
623 claimable_amount_satoshis: u64,
624 /// The height at which our counterparty will be able to claim the balance if we have not
625 /// yet received the preimage and claimed it ourselves.
628 /// The channel has been closed, and our counterparty broadcasted a revoked commitment
631 /// Thus, we're able to claim all outputs in the commitment transaction, one of which has the
632 /// following amount.
633 CounterpartyRevokedOutputClaimable {
634 /// The amount, in satoshis, of the output which we can claim.
636 /// Note that for outputs from HTLC balances this may be excluding some on-chain fees that
637 /// were already spent.
638 claimable_amount_satoshis: u64,
642 /// An HTLC which has been irrevocably resolved on-chain, and has reached ANTI_REORG_DELAY.
643 #[derive(PartialEq, Eq)]
644 struct IrrevocablyResolvedHTLC {
645 commitment_tx_output_idx: Option<u32>,
646 /// The txid of the transaction which resolved the HTLC, this may be a commitment (if the HTLC
647 /// was not present in the confirmed commitment transaction), HTLC-Success, or HTLC-Timeout
649 resolving_txid: Option<Txid>, // Added as optional, but always filled in, in 0.0.110
650 /// Only set if the HTLC claim was ours using a payment preimage
651 payment_preimage: Option<PaymentPreimage>,
654 // In LDK versions prior to 0.0.111 commitment_tx_output_idx was not Option-al and
655 // IrrevocablyResolvedHTLC objects only existed for non-dust HTLCs. This was a bug, but to maintain
656 // backwards compatibility we must ensure we always write out a commitment_tx_output_idx field,
657 // using `u32::max_value()` as a sentinal to indicate the HTLC was dust.
658 impl Writeable for IrrevocablyResolvedHTLC {
659 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
660 let mapped_commitment_tx_output_idx = self.commitment_tx_output_idx.unwrap_or(u32::max_value());
661 write_tlv_fields!(writer, {
662 (0, mapped_commitment_tx_output_idx, required),
663 (1, self.resolving_txid, option),
664 (2, self.payment_preimage, option),
670 impl Readable for IrrevocablyResolvedHTLC {
671 fn read<R: io::Read>(reader: &mut R) -> Result<Self, DecodeError> {
672 let mut mapped_commitment_tx_output_idx = 0;
673 let mut resolving_txid = None;
674 let mut payment_preimage = None;
675 read_tlv_fields!(reader, {
676 (0, mapped_commitment_tx_output_idx, required),
677 (1, resolving_txid, option),
678 (2, payment_preimage, option),
681 commitment_tx_output_idx: if mapped_commitment_tx_output_idx == u32::max_value() { None } else { Some(mapped_commitment_tx_output_idx) },
688 /// A ChannelMonitor handles chain events (blocks connected and disconnected) and generates
689 /// on-chain transactions to ensure no loss of funds occurs.
691 /// You MUST ensure that no ChannelMonitors for a given channel anywhere contain out-of-date
692 /// information and are actively monitoring the chain.
694 /// Pending Events or updated HTLCs which have not yet been read out by
695 /// get_and_clear_pending_monitor_events or get_and_clear_pending_events are serialized to disk and
696 /// reloaded at deserialize-time. Thus, you must ensure that, when handling events, all events
697 /// gotten are fully handled before re-serializing the new state.
699 /// Note that the deserializer is only implemented for (BlockHash, ChannelMonitor), which
700 /// tells you the last block hash which was block_connect()ed. You MUST rescan any blocks along
701 /// the "reorg path" (ie disconnecting blocks until you find a common ancestor from both the
702 /// returned block hash and the the current chain and then reconnecting blocks to get to the
703 /// best chain) upon deserializing the object!
704 pub struct ChannelMonitor<Signer: Sign> {
706 pub(crate) inner: Mutex<ChannelMonitorImpl<Signer>>,
708 inner: Mutex<ChannelMonitorImpl<Signer>>,
711 pub(crate) struct ChannelMonitorImpl<Signer: Sign> {
712 latest_update_id: u64,
713 commitment_transaction_number_obscure_factor: u64,
715 destination_script: Script,
716 broadcasted_holder_revokable_script: Option<(Script, PublicKey, PublicKey)>,
717 counterparty_payment_script: Script,
718 shutdown_script: Option<Script>,
720 channel_keys_id: [u8; 32],
721 holder_revocation_basepoint: PublicKey,
722 funding_info: (OutPoint, Script),
723 current_counterparty_commitment_txid: Option<Txid>,
724 prev_counterparty_commitment_txid: Option<Txid>,
726 counterparty_commitment_params: CounterpartyCommitmentParameters,
727 funding_redeemscript: Script,
728 channel_value_satoshis: u64,
729 // first is the idx of the first of the two per-commitment points
730 their_cur_per_commitment_points: Option<(u64, PublicKey, Option<PublicKey>)>,
732 on_holder_tx_csv: u16,
734 commitment_secrets: CounterpartyCommitmentSecrets,
735 /// The set of outpoints in each counterparty commitment transaction. We always need at least
736 /// the payment hash from `HTLCOutputInCommitment` to claim even a revoked commitment
737 /// transaction broadcast as we need to be able to construct the witness script in all cases.
738 counterparty_claimable_outpoints: HashMap<Txid, Vec<(HTLCOutputInCommitment, Option<Box<HTLCSource>>)>>,
739 /// We cannot identify HTLC-Success or HTLC-Timeout transactions by themselves on the chain.
740 /// Nor can we figure out their commitment numbers without the commitment transaction they are
741 /// spending. Thus, in order to claim them via revocation key, we track all the counterparty
742 /// commitment transactions which we find on-chain, mapping them to the commitment number which
743 /// can be used to derive the revocation key and claim the transactions.
744 counterparty_commitment_txn_on_chain: HashMap<Txid, u64>,
745 /// Cache used to make pruning of payment_preimages faster.
746 /// Maps payment_hash values to commitment numbers for counterparty transactions for non-revoked
747 /// counterparty transactions (ie should remain pretty small).
748 /// Serialized to disk but should generally not be sent to Watchtowers.
749 counterparty_hash_commitment_number: HashMap<PaymentHash, u64>,
751 // We store two holder commitment transactions to avoid any race conditions where we may update
752 // some monitors (potentially on watchtowers) but then fail to update others, resulting in the
753 // various monitors for one channel being out of sync, and us broadcasting a holder
754 // transaction for which we have deleted claim information on some watchtowers.
755 prev_holder_signed_commitment_tx: Option<HolderSignedTx>,
756 current_holder_commitment_tx: HolderSignedTx,
758 // Used just for ChannelManager to make sure it has the latest channel data during
760 current_counterparty_commitment_number: u64,
761 // Used just for ChannelManager to make sure it has the latest channel data during
763 current_holder_commitment_number: u64,
765 /// The set of payment hashes from inbound payments for which we know the preimage. Payment
766 /// preimages that are not included in any unrevoked local commitment transaction or unrevoked
767 /// remote commitment transactions are automatically removed when commitment transactions are
769 payment_preimages: HashMap<PaymentHash, PaymentPreimage>,
771 // Note that `MonitorEvent`s MUST NOT be generated during update processing, only generated
772 // during chain data processing. This prevents a race in `ChainMonitor::update_channel` (and
773 // presumably user implementations thereof as well) where we update the in-memory channel
774 // object, then before the persistence finishes (as it's all under a read-lock), we return
775 // pending events to the user or to the relevant `ChannelManager`. Then, on reload, we'll have
776 // the pre-event state here, but have processed the event in the `ChannelManager`.
777 // Note that because the `event_lock` in `ChainMonitor` is only taken in
778 // block/transaction-connected events and *not* during block/transaction-disconnected events,
779 // we further MUST NOT generate events during block/transaction-disconnection.
780 pending_monitor_events: Vec<MonitorEvent>,
782 pending_events: Vec<Event>,
784 // Used to track on-chain events (i.e., transactions part of channels confirmed on chain) on
785 // which to take actions once they reach enough confirmations. Each entry includes the
786 // transaction's id and the height when the transaction was confirmed on chain.
787 onchain_events_awaiting_threshold_conf: Vec<OnchainEventEntry>,
789 // If we get serialized out and re-read, we need to make sure that the chain monitoring
790 // interface knows about the TXOs that we want to be notified of spends of. We could probably
791 // be smart and derive them from the above storage fields, but its much simpler and more
792 // Obviously Correct (tm) if we just keep track of them explicitly.
793 outputs_to_watch: HashMap<Txid, Vec<(u32, Script)>>,
796 pub onchain_tx_handler: OnchainTxHandler<Signer>,
798 onchain_tx_handler: OnchainTxHandler<Signer>,
800 // This is set when the Channel[Manager] generated a ChannelMonitorUpdate which indicated the
801 // channel has been force-closed. After this is set, no further holder commitment transaction
802 // updates may occur, and we panic!() if one is provided.
803 lockdown_from_offchain: bool,
805 // Set once we've signed a holder commitment transaction and handed it over to our
806 // OnchainTxHandler. After this is set, no future updates to our holder commitment transactions
807 // may occur, and we fail any such monitor updates.
809 // In case of update rejection due to a locally already signed commitment transaction, we
810 // nevertheless store update content to track in case of concurrent broadcast by another
811 // remote monitor out-of-order with regards to the block view.
812 holder_tx_signed: bool,
814 // If a spend of the funding output is seen, we set this to true and reject any further
815 // updates. This prevents any further changes in the offchain state no matter the order
816 // of block connection between ChannelMonitors and the ChannelManager.
817 funding_spend_seen: bool,
819 /// Set to `Some` of the confirmed transaction spending the funding input of the channel after
820 /// reaching `ANTI_REORG_DELAY` confirmations.
821 funding_spend_confirmed: Option<Txid>,
823 confirmed_commitment_tx_counterparty_output: CommitmentTxCounterpartyOutputInfo,
824 /// The set of HTLCs which have been either claimed or failed on chain and have reached
825 /// the requisite confirmations on the claim/fail transaction (either ANTI_REORG_DELAY or the
826 /// spending CSV for revocable outputs).
827 htlcs_resolved_on_chain: Vec<IrrevocablyResolvedHTLC>,
829 // We simply modify best_block in Channel's block_connected so that serialization is
830 // consistent but hopefully the users' copy handles block_connected in a consistent way.
831 // (we do *not*, however, update them in update_monitor to ensure any local user copies keep
832 // their best_block from its state and not based on updated copies that didn't run through
833 // the full block_connected).
834 best_block: BestBlock,
836 /// The node_id of our counterparty
837 counterparty_node_id: Option<PublicKey>,
839 secp_ctx: Secp256k1<secp256k1::All>, //TODO: dedup this a bit...
842 /// Transaction outputs to watch for on-chain spends.
843 pub type TransactionOutputs = (Txid, Vec<(u32, TxOut)>);
845 #[cfg(any(test, fuzzing, feature = "_test_utils"))]
846 /// Used only in testing and fuzzing to check serialization roundtrips don't change the underlying
848 impl<Signer: Sign> PartialEq for ChannelMonitor<Signer> {
849 fn eq(&self, other: &Self) -> bool {
850 let inner = self.inner.lock().unwrap();
851 let other = other.inner.lock().unwrap();
856 #[cfg(any(test, fuzzing, feature = "_test_utils"))]
857 /// Used only in testing and fuzzing to check serialization roundtrips don't change the underlying
859 impl<Signer: Sign> PartialEq for ChannelMonitorImpl<Signer> {
860 fn eq(&self, other: &Self) -> bool {
861 if self.latest_update_id != other.latest_update_id ||
862 self.commitment_transaction_number_obscure_factor != other.commitment_transaction_number_obscure_factor ||
863 self.destination_script != other.destination_script ||
864 self.broadcasted_holder_revokable_script != other.broadcasted_holder_revokable_script ||
865 self.counterparty_payment_script != other.counterparty_payment_script ||
866 self.channel_keys_id != other.channel_keys_id ||
867 self.holder_revocation_basepoint != other.holder_revocation_basepoint ||
868 self.funding_info != other.funding_info ||
869 self.current_counterparty_commitment_txid != other.current_counterparty_commitment_txid ||
870 self.prev_counterparty_commitment_txid != other.prev_counterparty_commitment_txid ||
871 self.counterparty_commitment_params != other.counterparty_commitment_params ||
872 self.funding_redeemscript != other.funding_redeemscript ||
873 self.channel_value_satoshis != other.channel_value_satoshis ||
874 self.their_cur_per_commitment_points != other.their_cur_per_commitment_points ||
875 self.on_holder_tx_csv != other.on_holder_tx_csv ||
876 self.commitment_secrets != other.commitment_secrets ||
877 self.counterparty_claimable_outpoints != other.counterparty_claimable_outpoints ||
878 self.counterparty_commitment_txn_on_chain != other.counterparty_commitment_txn_on_chain ||
879 self.counterparty_hash_commitment_number != other.counterparty_hash_commitment_number ||
880 self.prev_holder_signed_commitment_tx != other.prev_holder_signed_commitment_tx ||
881 self.current_counterparty_commitment_number != other.current_counterparty_commitment_number ||
882 self.current_holder_commitment_number != other.current_holder_commitment_number ||
883 self.current_holder_commitment_tx != other.current_holder_commitment_tx ||
884 self.payment_preimages != other.payment_preimages ||
885 self.pending_monitor_events != other.pending_monitor_events ||
886 self.pending_events.len() != other.pending_events.len() || // We trust events to round-trip properly
887 self.onchain_events_awaiting_threshold_conf != other.onchain_events_awaiting_threshold_conf ||
888 self.outputs_to_watch != other.outputs_to_watch ||
889 self.lockdown_from_offchain != other.lockdown_from_offchain ||
890 self.holder_tx_signed != other.holder_tx_signed ||
891 self.funding_spend_seen != other.funding_spend_seen ||
892 self.funding_spend_confirmed != other.funding_spend_confirmed ||
893 self.confirmed_commitment_tx_counterparty_output != other.confirmed_commitment_tx_counterparty_output ||
894 self.htlcs_resolved_on_chain != other.htlcs_resolved_on_chain
903 impl<Signer: Sign> Writeable for ChannelMonitor<Signer> {
904 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), Error> {
905 self.inner.lock().unwrap().write(writer)
909 // These are also used for ChannelMonitorUpdate, above.
910 const SERIALIZATION_VERSION: u8 = 1;
911 const MIN_SERIALIZATION_VERSION: u8 = 1;
913 impl<Signer: Sign> Writeable for ChannelMonitorImpl<Signer> {
914 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), Error> {
915 write_ver_prefix!(writer, SERIALIZATION_VERSION, MIN_SERIALIZATION_VERSION);
917 self.latest_update_id.write(writer)?;
919 // Set in initial Channel-object creation, so should always be set by now:
920 U48(self.commitment_transaction_number_obscure_factor).write(writer)?;
922 self.destination_script.write(writer)?;
923 if let Some(ref broadcasted_holder_revokable_script) = self.broadcasted_holder_revokable_script {
924 writer.write_all(&[0; 1])?;
925 broadcasted_holder_revokable_script.0.write(writer)?;
926 broadcasted_holder_revokable_script.1.write(writer)?;
927 broadcasted_holder_revokable_script.2.write(writer)?;
929 writer.write_all(&[1; 1])?;
932 self.counterparty_payment_script.write(writer)?;
933 match &self.shutdown_script {
934 Some(script) => script.write(writer)?,
935 None => Script::new().write(writer)?,
938 self.channel_keys_id.write(writer)?;
939 self.holder_revocation_basepoint.write(writer)?;
940 writer.write_all(&self.funding_info.0.txid[..])?;
941 writer.write_all(&byte_utils::be16_to_array(self.funding_info.0.index))?;
942 self.funding_info.1.write(writer)?;
943 self.current_counterparty_commitment_txid.write(writer)?;
944 self.prev_counterparty_commitment_txid.write(writer)?;
946 self.counterparty_commitment_params.write(writer)?;
947 self.funding_redeemscript.write(writer)?;
948 self.channel_value_satoshis.write(writer)?;
950 match self.their_cur_per_commitment_points {
951 Some((idx, pubkey, second_option)) => {
952 writer.write_all(&byte_utils::be48_to_array(idx))?;
953 writer.write_all(&pubkey.serialize())?;
954 match second_option {
955 Some(second_pubkey) => {
956 writer.write_all(&second_pubkey.serialize())?;
959 writer.write_all(&[0; 33])?;
964 writer.write_all(&byte_utils::be48_to_array(0))?;
968 writer.write_all(&byte_utils::be16_to_array(self.on_holder_tx_csv))?;
970 self.commitment_secrets.write(writer)?;
972 macro_rules! serialize_htlc_in_commitment {
973 ($htlc_output: expr) => {
974 writer.write_all(&[$htlc_output.offered as u8; 1])?;
975 writer.write_all(&byte_utils::be64_to_array($htlc_output.amount_msat))?;
976 writer.write_all(&byte_utils::be32_to_array($htlc_output.cltv_expiry))?;
977 writer.write_all(&$htlc_output.payment_hash.0[..])?;
978 $htlc_output.transaction_output_index.write(writer)?;
982 writer.write_all(&byte_utils::be64_to_array(self.counterparty_claimable_outpoints.len() as u64))?;
983 for (ref txid, ref htlc_infos) in self.counterparty_claimable_outpoints.iter() {
984 writer.write_all(&txid[..])?;
985 writer.write_all(&byte_utils::be64_to_array(htlc_infos.len() as u64))?;
986 for &(ref htlc_output, ref htlc_source) in htlc_infos.iter() {
987 debug_assert!(htlc_source.is_none() || Some(**txid) == self.current_counterparty_commitment_txid
988 || Some(**txid) == self.prev_counterparty_commitment_txid,
989 "HTLC Sources for all revoked commitment transactions should be none!");
990 serialize_htlc_in_commitment!(htlc_output);
991 htlc_source.as_ref().map(|b| b.as_ref()).write(writer)?;
995 writer.write_all(&byte_utils::be64_to_array(self.counterparty_commitment_txn_on_chain.len() as u64))?;
996 for (ref txid, commitment_number) in self.counterparty_commitment_txn_on_chain.iter() {
997 writer.write_all(&txid[..])?;
998 writer.write_all(&byte_utils::be48_to_array(*commitment_number))?;
1001 writer.write_all(&byte_utils::be64_to_array(self.counterparty_hash_commitment_number.len() as u64))?;
1002 for (ref payment_hash, commitment_number) in self.counterparty_hash_commitment_number.iter() {
1003 writer.write_all(&payment_hash.0[..])?;
1004 writer.write_all(&byte_utils::be48_to_array(*commitment_number))?;
1007 if let Some(ref prev_holder_tx) = self.prev_holder_signed_commitment_tx {
1008 writer.write_all(&[1; 1])?;
1009 prev_holder_tx.write(writer)?;
1011 writer.write_all(&[0; 1])?;
1014 self.current_holder_commitment_tx.write(writer)?;
1016 writer.write_all(&byte_utils::be48_to_array(self.current_counterparty_commitment_number))?;
1017 writer.write_all(&byte_utils::be48_to_array(self.current_holder_commitment_number))?;
1019 writer.write_all(&byte_utils::be64_to_array(self.payment_preimages.len() as u64))?;
1020 for payment_preimage in self.payment_preimages.values() {
1021 writer.write_all(&payment_preimage.0[..])?;
1024 writer.write_all(&(self.pending_monitor_events.iter().filter(|ev| match ev {
1025 MonitorEvent::HTLCEvent(_) => true,
1026 MonitorEvent::CommitmentTxConfirmed(_) => true,
1028 }).count() as u64).to_be_bytes())?;
1029 for event in self.pending_monitor_events.iter() {
1031 MonitorEvent::HTLCEvent(upd) => {
1035 MonitorEvent::CommitmentTxConfirmed(_) => 1u8.write(writer)?,
1036 _ => {}, // Covered in the TLV writes below
1040 writer.write_all(&byte_utils::be64_to_array(self.pending_events.len() as u64))?;
1041 for event in self.pending_events.iter() {
1042 event.write(writer)?;
1045 self.best_block.block_hash().write(writer)?;
1046 writer.write_all(&byte_utils::be32_to_array(self.best_block.height()))?;
1048 writer.write_all(&byte_utils::be64_to_array(self.onchain_events_awaiting_threshold_conf.len() as u64))?;
1049 for ref entry in self.onchain_events_awaiting_threshold_conf.iter() {
1050 entry.write(writer)?;
1053 (self.outputs_to_watch.len() as u64).write(writer)?;
1054 for (txid, idx_scripts) in self.outputs_to_watch.iter() {
1055 txid.write(writer)?;
1056 (idx_scripts.len() as u64).write(writer)?;
1057 for (idx, script) in idx_scripts.iter() {
1059 script.write(writer)?;
1062 self.onchain_tx_handler.write(writer)?;
1064 self.lockdown_from_offchain.write(writer)?;
1065 self.holder_tx_signed.write(writer)?;
1067 write_tlv_fields!(writer, {
1068 (1, self.funding_spend_confirmed, option),
1069 (3, self.htlcs_resolved_on_chain, vec_type),
1070 (5, self.pending_monitor_events, vec_type),
1071 (7, self.funding_spend_seen, required),
1072 (9, self.counterparty_node_id, option),
1073 (11, self.confirmed_commitment_tx_counterparty_output, option),
1080 impl<Signer: Sign> ChannelMonitor<Signer> {
1081 /// For lockorder enforcement purposes, we need to have a single site which constructs the
1082 /// `inner` mutex, otherwise cases where we lock two monitors at the same time (eg in our
1083 /// PartialEq implementation) we may decide a lockorder violation has occurred.
1084 fn from_impl(imp: ChannelMonitorImpl<Signer>) -> Self {
1085 ChannelMonitor { inner: Mutex::new(imp) }
1088 pub(crate) fn new(secp_ctx: Secp256k1<secp256k1::All>, keys: Signer, shutdown_script: Option<Script>,
1089 on_counterparty_tx_csv: u16, destination_script: &Script, funding_info: (OutPoint, Script),
1090 channel_parameters: &ChannelTransactionParameters,
1091 funding_redeemscript: Script, channel_value_satoshis: u64,
1092 commitment_transaction_number_obscure_factor: u64,
1093 initial_holder_commitment_tx: HolderCommitmentTransaction,
1094 best_block: BestBlock, counterparty_node_id: PublicKey) -> ChannelMonitor<Signer> {
1096 assert!(commitment_transaction_number_obscure_factor <= (1 << 48));
1097 let payment_key_hash = WPubkeyHash::hash(&keys.pubkeys().payment_point.serialize());
1098 let counterparty_payment_script = Builder::new().push_opcode(opcodes::all::OP_PUSHBYTES_0).push_slice(&payment_key_hash[..]).into_script();
1100 let counterparty_channel_parameters = channel_parameters.counterparty_parameters.as_ref().unwrap();
1101 let counterparty_delayed_payment_base_key = counterparty_channel_parameters.pubkeys.delayed_payment_basepoint;
1102 let counterparty_htlc_base_key = counterparty_channel_parameters.pubkeys.htlc_basepoint;
1103 let counterparty_commitment_params = CounterpartyCommitmentParameters { counterparty_delayed_payment_base_key, counterparty_htlc_base_key, on_counterparty_tx_csv };
1105 let channel_keys_id = keys.channel_keys_id();
1106 let holder_revocation_basepoint = keys.pubkeys().revocation_basepoint;
1108 // block for Rust 1.34 compat
1109 let (holder_commitment_tx, current_holder_commitment_number) = {
1110 let trusted_tx = initial_holder_commitment_tx.trust();
1111 let txid = trusted_tx.txid();
1113 let tx_keys = trusted_tx.keys();
1114 let holder_commitment_tx = HolderSignedTx {
1116 revocation_key: tx_keys.revocation_key,
1117 a_htlc_key: tx_keys.broadcaster_htlc_key,
1118 b_htlc_key: tx_keys.countersignatory_htlc_key,
1119 delayed_payment_key: tx_keys.broadcaster_delayed_payment_key,
1120 per_commitment_point: tx_keys.per_commitment_point,
1121 htlc_outputs: Vec::new(), // There are never any HTLCs in the initial commitment transactions
1122 to_self_value_sat: initial_holder_commitment_tx.to_broadcaster_value_sat(),
1123 feerate_per_kw: trusted_tx.feerate_per_kw(),
1125 (holder_commitment_tx, trusted_tx.commitment_number())
1128 let onchain_tx_handler =
1129 OnchainTxHandler::new(destination_script.clone(), keys,
1130 channel_parameters.clone(), initial_holder_commitment_tx, secp_ctx.clone());
1132 let mut outputs_to_watch = HashMap::new();
1133 outputs_to_watch.insert(funding_info.0.txid, vec![(funding_info.0.index as u32, funding_info.1.clone())]);
1135 Self::from_impl(ChannelMonitorImpl {
1136 latest_update_id: 0,
1137 commitment_transaction_number_obscure_factor,
1139 destination_script: destination_script.clone(),
1140 broadcasted_holder_revokable_script: None,
1141 counterparty_payment_script,
1145 holder_revocation_basepoint,
1147 current_counterparty_commitment_txid: None,
1148 prev_counterparty_commitment_txid: None,
1150 counterparty_commitment_params,
1151 funding_redeemscript,
1152 channel_value_satoshis,
1153 their_cur_per_commitment_points: None,
1155 on_holder_tx_csv: counterparty_channel_parameters.selected_contest_delay,
1157 commitment_secrets: CounterpartyCommitmentSecrets::new(),
1158 counterparty_claimable_outpoints: HashMap::new(),
1159 counterparty_commitment_txn_on_chain: HashMap::new(),
1160 counterparty_hash_commitment_number: HashMap::new(),
1162 prev_holder_signed_commitment_tx: None,
1163 current_holder_commitment_tx: holder_commitment_tx,
1164 current_counterparty_commitment_number: 1 << 48,
1165 current_holder_commitment_number,
1167 payment_preimages: HashMap::new(),
1168 pending_monitor_events: Vec::new(),
1169 pending_events: Vec::new(),
1171 onchain_events_awaiting_threshold_conf: Vec::new(),
1176 lockdown_from_offchain: false,
1177 holder_tx_signed: false,
1178 funding_spend_seen: false,
1179 funding_spend_confirmed: None,
1180 confirmed_commitment_tx_counterparty_output: None,
1181 htlcs_resolved_on_chain: Vec::new(),
1184 counterparty_node_id: Some(counterparty_node_id),
1191 fn provide_secret(&self, idx: u64, secret: [u8; 32]) -> Result<(), &'static str> {
1192 self.inner.lock().unwrap().provide_secret(idx, secret)
1195 /// Informs this monitor of the latest counterparty (ie non-broadcastable) commitment transaction.
1196 /// The monitor watches for it to be broadcasted and then uses the HTLC information (and
1197 /// possibly future revocation/preimage information) to claim outputs where possible.
1198 /// We cache also the mapping hash:commitment number to lighten pruning of old preimages by watchtowers.
1199 pub(crate) fn provide_latest_counterparty_commitment_tx<L: Deref>(
1202 htlc_outputs: Vec<(HTLCOutputInCommitment, Option<Box<HTLCSource>>)>,
1203 commitment_number: u64,
1204 their_per_commitment_point: PublicKey,
1206 ) where L::Target: Logger {
1207 self.inner.lock().unwrap().provide_latest_counterparty_commitment_tx(
1208 txid, htlc_outputs, commitment_number, their_per_commitment_point, logger)
1212 fn provide_latest_holder_commitment_tx(
1213 &self, holder_commitment_tx: HolderCommitmentTransaction,
1214 htlc_outputs: Vec<(HTLCOutputInCommitment, Option<Signature>, Option<HTLCSource>)>,
1215 ) -> Result<(), ()> {
1216 self.inner.lock().unwrap().provide_latest_holder_commitment_tx(holder_commitment_tx, htlc_outputs).map_err(|_| ())
1219 /// This is used to provide payment preimage(s) out-of-band during startup without updating the
1220 /// off-chain state with a new commitment transaction.
1221 pub(crate) fn provide_payment_preimage<B: Deref, F: Deref, L: Deref>(
1223 payment_hash: &PaymentHash,
1224 payment_preimage: &PaymentPreimage,
1226 fee_estimator: &LowerBoundedFeeEstimator<F>,
1229 B::Target: BroadcasterInterface,
1230 F::Target: FeeEstimator,
1233 self.inner.lock().unwrap().provide_payment_preimage(
1234 payment_hash, payment_preimage, broadcaster, fee_estimator, logger)
1237 pub(crate) fn broadcast_latest_holder_commitment_txn<B: Deref, L: Deref>(
1242 B::Target: BroadcasterInterface,
1245 self.inner.lock().unwrap().broadcast_latest_holder_commitment_txn(broadcaster, logger);
1248 /// Updates a ChannelMonitor on the basis of some new information provided by the Channel
1251 /// panics if the given update is not the next update by update_id.
1252 pub fn update_monitor<B: Deref, F: Deref, L: Deref>(
1254 updates: &ChannelMonitorUpdate,
1260 B::Target: BroadcasterInterface,
1261 F::Target: FeeEstimator,
1264 self.inner.lock().unwrap().update_monitor(updates, broadcaster, fee_estimator, logger)
1267 /// Gets the update_id from the latest ChannelMonitorUpdate which was applied to this
1269 pub fn get_latest_update_id(&self) -> u64 {
1270 self.inner.lock().unwrap().get_latest_update_id()
1273 /// Gets the funding transaction outpoint of the channel this ChannelMonitor is monitoring for.
1274 pub fn get_funding_txo(&self) -> (OutPoint, Script) {
1275 self.inner.lock().unwrap().get_funding_txo().clone()
1278 /// Gets a list of txids, with their output scripts (in the order they appear in the
1279 /// transaction), which we must learn about spends of via block_connected().
1280 pub fn get_outputs_to_watch(&self) -> Vec<(Txid, Vec<(u32, Script)>)> {
1281 self.inner.lock().unwrap().get_outputs_to_watch()
1282 .iter().map(|(txid, outputs)| (*txid, outputs.clone())).collect()
1285 /// Loads the funding txo and outputs to watch into the given `chain::Filter` by repeatedly
1286 /// calling `chain::Filter::register_output` and `chain::Filter::register_tx` until all outputs
1287 /// have been registered.
1288 pub fn load_outputs_to_watch<F: Deref>(&self, filter: &F) where F::Target: chain::Filter {
1289 let lock = self.inner.lock().unwrap();
1290 filter.register_tx(&lock.get_funding_txo().0.txid, &lock.get_funding_txo().1);
1291 for (txid, outputs) in lock.get_outputs_to_watch().iter() {
1292 for (index, script_pubkey) in outputs.iter() {
1293 assert!(*index <= u16::max_value() as u32);
1294 filter.register_output(WatchedOutput {
1296 outpoint: OutPoint { txid: *txid, index: *index as u16 },
1297 script_pubkey: script_pubkey.clone(),
1303 /// Get the list of HTLCs who's status has been updated on chain. This should be called by
1304 /// ChannelManager via [`chain::Watch::release_pending_monitor_events`].
1305 pub fn get_and_clear_pending_monitor_events(&self) -> Vec<MonitorEvent> {
1306 self.inner.lock().unwrap().get_and_clear_pending_monitor_events()
1309 /// Gets the list of pending events which were generated by previous actions, clearing the list
1312 /// This is called by the [`EventsProvider::process_pending_events`] implementation for
1313 /// [`ChainMonitor`].
1315 /// [`EventsProvider::process_pending_events`]: crate::util::events::EventsProvider::process_pending_events
1316 /// [`ChainMonitor`]: crate::chain::chainmonitor::ChainMonitor
1317 pub fn get_and_clear_pending_events(&self) -> Vec<Event> {
1318 self.inner.lock().unwrap().get_and_clear_pending_events()
1321 pub(crate) fn get_min_seen_secret(&self) -> u64 {
1322 self.inner.lock().unwrap().get_min_seen_secret()
1325 pub(crate) fn get_cur_counterparty_commitment_number(&self) -> u64 {
1326 self.inner.lock().unwrap().get_cur_counterparty_commitment_number()
1329 pub(crate) fn get_cur_holder_commitment_number(&self) -> u64 {
1330 self.inner.lock().unwrap().get_cur_holder_commitment_number()
1333 /// Gets the `node_id` of the counterparty for this channel.
1335 /// Will be `None` for channels constructed on LDK versions prior to 0.0.110 and always `Some`
1337 pub fn get_counterparty_node_id(&self) -> Option<PublicKey> {
1338 self.inner.lock().unwrap().counterparty_node_id
1341 /// Used by ChannelManager deserialization to broadcast the latest holder state if its copy of
1342 /// the Channel was out-of-date.
1344 /// You may also use this to broadcast the latest local commitment transaction, either because
1345 /// a monitor update failed with [`ChannelMonitorUpdateStatus::PermanentFailure`] or because we've
1346 /// fallen behind (i.e. we've received proof that our counterparty side knows a revocation
1347 /// secret we gave them that they shouldn't know).
1349 /// Broadcasting these transactions in the second case is UNSAFE, as they allow counterparty
1350 /// side to punish you. Nevertheless you may want to broadcast them if counterparty doesn't
1351 /// close channel with their commitment transaction after a substantial amount of time. Best
1352 /// may be to contact the other node operator out-of-band to coordinate other options available
1353 /// to you. In any-case, the choice is up to you.
1355 /// [`ChannelMonitorUpdateStatus::PermanentFailure`]: super::ChannelMonitorUpdateStatus::PermanentFailure
1356 pub fn get_latest_holder_commitment_txn<L: Deref>(&self, logger: &L) -> Vec<Transaction>
1357 where L::Target: Logger {
1358 self.inner.lock().unwrap().get_latest_holder_commitment_txn(logger)
1361 /// Unsafe test-only version of get_latest_holder_commitment_txn used by our test framework
1362 /// to bypass HolderCommitmentTransaction state update lockdown after signature and generate
1363 /// revoked commitment transaction.
1364 #[cfg(any(test, feature = "unsafe_revoked_tx_signing"))]
1365 pub fn unsafe_get_latest_holder_commitment_txn<L: Deref>(&self, logger: &L) -> Vec<Transaction>
1366 where L::Target: Logger {
1367 self.inner.lock().unwrap().unsafe_get_latest_holder_commitment_txn(logger)
1370 /// Processes transactions in a newly connected block, which may result in any of the following:
1371 /// - update the monitor's state against resolved HTLCs
1372 /// - punish the counterparty in the case of seeing a revoked commitment transaction
1373 /// - force close the channel and claim/timeout incoming/outgoing HTLCs if near expiration
1374 /// - detect settled outputs for later spending
1375 /// - schedule and bump any in-flight claims
1377 /// Returns any new outputs to watch from `txdata`; after called, these are also included in
1378 /// [`get_outputs_to_watch`].
1380 /// [`get_outputs_to_watch`]: #method.get_outputs_to_watch
1381 pub fn block_connected<B: Deref, F: Deref, L: Deref>(
1383 header: &BlockHeader,
1384 txdata: &TransactionData,
1389 ) -> Vec<TransactionOutputs>
1391 B::Target: BroadcasterInterface,
1392 F::Target: FeeEstimator,
1395 self.inner.lock().unwrap().block_connected(
1396 header, txdata, height, broadcaster, fee_estimator, logger)
1399 /// Determines if the disconnected block contained any transactions of interest and updates
1401 pub fn block_disconnected<B: Deref, F: Deref, L: Deref>(
1403 header: &BlockHeader,
1409 B::Target: BroadcasterInterface,
1410 F::Target: FeeEstimator,
1413 self.inner.lock().unwrap().block_disconnected(
1414 header, height, broadcaster, fee_estimator, logger)
1417 /// Processes transactions confirmed in a block with the given header and height, returning new
1418 /// outputs to watch. See [`block_connected`] for details.
1420 /// Used instead of [`block_connected`] by clients that are notified of transactions rather than
1421 /// blocks. See [`chain::Confirm`] for calling expectations.
1423 /// [`block_connected`]: Self::block_connected
1424 pub fn transactions_confirmed<B: Deref, F: Deref, L: Deref>(
1426 header: &BlockHeader,
1427 txdata: &TransactionData,
1432 ) -> Vec<TransactionOutputs>
1434 B::Target: BroadcasterInterface,
1435 F::Target: FeeEstimator,
1438 let bounded_fee_estimator = LowerBoundedFeeEstimator::new(fee_estimator);
1439 self.inner.lock().unwrap().transactions_confirmed(
1440 header, txdata, height, broadcaster, &bounded_fee_estimator, logger)
1443 /// Processes a transaction that was reorganized out of the chain.
1445 /// Used instead of [`block_disconnected`] by clients that are notified of transactions rather
1446 /// than blocks. See [`chain::Confirm`] for calling expectations.
1448 /// [`block_disconnected`]: Self::block_disconnected
1449 pub fn transaction_unconfirmed<B: Deref, F: Deref, L: Deref>(
1456 B::Target: BroadcasterInterface,
1457 F::Target: FeeEstimator,
1460 let bounded_fee_estimator = LowerBoundedFeeEstimator::new(fee_estimator);
1461 self.inner.lock().unwrap().transaction_unconfirmed(
1462 txid, broadcaster, &bounded_fee_estimator, logger);
1465 /// Updates the monitor with the current best chain tip, returning new outputs to watch. See
1466 /// [`block_connected`] for details.
1468 /// Used instead of [`block_connected`] by clients that are notified of transactions rather than
1469 /// blocks. See [`chain::Confirm`] for calling expectations.
1471 /// [`block_connected`]: Self::block_connected
1472 pub fn best_block_updated<B: Deref, F: Deref, L: Deref>(
1474 header: &BlockHeader,
1479 ) -> Vec<TransactionOutputs>
1481 B::Target: BroadcasterInterface,
1482 F::Target: FeeEstimator,
1485 let bounded_fee_estimator = LowerBoundedFeeEstimator::new(fee_estimator);
1486 self.inner.lock().unwrap().best_block_updated(
1487 header, height, broadcaster, &bounded_fee_estimator, logger)
1490 /// Returns the set of txids that should be monitored for re-organization out of the chain.
1491 pub fn get_relevant_txids(&self) -> Vec<(Txid, Option<BlockHash>)> {
1492 let inner = self.inner.lock().unwrap();
1493 let mut txids: Vec<(Txid, Option<BlockHash>)> = inner.onchain_events_awaiting_threshold_conf
1495 .map(|entry| (entry.txid, entry.block_hash))
1496 .chain(inner.onchain_tx_handler.get_relevant_txids().into_iter())
1498 txids.sort_unstable();
1503 /// Gets the latest best block which was connected either via the [`chain::Listen`] or
1504 /// [`chain::Confirm`] interfaces.
1505 pub fn current_best_block(&self) -> BestBlock {
1506 self.inner.lock().unwrap().best_block.clone()
1510 impl<Signer: Sign> ChannelMonitorImpl<Signer> {
1511 /// Helper for get_claimable_balances which does the work for an individual HTLC, generating up
1512 /// to one `Balance` for the HTLC.
1513 fn get_htlc_balance(&self, htlc: &HTLCOutputInCommitment, holder_commitment: bool,
1514 counterparty_revoked_commitment: bool, confirmed_txid: Option<Txid>)
1515 -> Option<Balance> {
1516 let htlc_commitment_tx_output_idx =
1517 if let Some(v) = htlc.transaction_output_index { v } else { return None; };
1519 let mut htlc_spend_txid_opt = None;
1520 let mut holder_timeout_spend_pending = None;
1521 let mut htlc_spend_pending = None;
1522 let mut holder_delayed_output_pending = None;
1523 for event in self.onchain_events_awaiting_threshold_conf.iter() {
1525 OnchainEvent::HTLCUpdate { commitment_tx_output_idx, htlc_value_satoshis, .. }
1526 if commitment_tx_output_idx == Some(htlc_commitment_tx_output_idx) => {
1527 debug_assert!(htlc_spend_txid_opt.is_none());
1528 htlc_spend_txid_opt = event.transaction.as_ref().map(|tx| tx.txid());
1529 debug_assert!(holder_timeout_spend_pending.is_none());
1530 debug_assert_eq!(htlc_value_satoshis.unwrap(), htlc.amount_msat / 1000);
1531 holder_timeout_spend_pending = Some(event.confirmation_threshold());
1533 OnchainEvent::HTLCSpendConfirmation { commitment_tx_output_idx, preimage, .. }
1534 if commitment_tx_output_idx == htlc_commitment_tx_output_idx => {
1535 debug_assert!(htlc_spend_txid_opt.is_none());
1536 htlc_spend_txid_opt = event.transaction.as_ref().map(|tx| tx.txid());
1537 debug_assert!(htlc_spend_pending.is_none());
1538 htlc_spend_pending = Some((event.confirmation_threshold(), preimage.is_some()));
1540 OnchainEvent::MaturingOutput {
1541 descriptor: SpendableOutputDescriptor::DelayedPaymentOutput(ref descriptor) }
1542 if descriptor.outpoint.index as u32 == htlc_commitment_tx_output_idx => {
1543 debug_assert!(holder_delayed_output_pending.is_none());
1544 holder_delayed_output_pending = Some(event.confirmation_threshold());
1549 let htlc_resolved = self.htlcs_resolved_on_chain.iter()
1550 .find(|v| if v.commitment_tx_output_idx == Some(htlc_commitment_tx_output_idx) {
1551 debug_assert!(htlc_spend_txid_opt.is_none());
1552 htlc_spend_txid_opt = v.resolving_txid;
1555 debug_assert!(holder_timeout_spend_pending.is_some() as u8 + htlc_spend_pending.is_some() as u8 + htlc_resolved.is_some() as u8 <= 1);
1557 let htlc_output_to_spend =
1558 if let Some(txid) = htlc_spend_txid_opt {
1560 self.onchain_tx_handler.channel_transaction_parameters.opt_anchors.is_none(),
1561 "This code needs updating for anchors");
1562 BitcoinOutPoint::new(txid, 0)
1564 BitcoinOutPoint::new(confirmed_txid.unwrap(), htlc_commitment_tx_output_idx)
1566 let htlc_output_spend_pending = self.onchain_tx_handler.is_output_spend_pending(&htlc_output_to_spend);
1568 if let Some(conf_thresh) = holder_delayed_output_pending {
1569 debug_assert!(holder_commitment);
1570 return Some(Balance::ClaimableAwaitingConfirmations {
1571 claimable_amount_satoshis: htlc.amount_msat / 1000,
1572 confirmation_height: conf_thresh,
1574 } else if htlc_resolved.is_some() && !htlc_output_spend_pending {
1575 // Funding transaction spends should be fully confirmed by the time any
1576 // HTLC transactions are resolved, unless we're talking about a holder
1577 // commitment tx, whose resolution is delayed until the CSV timeout is
1578 // reached, even though HTLCs may be resolved after only
1579 // ANTI_REORG_DELAY confirmations.
1580 debug_assert!(holder_commitment || self.funding_spend_confirmed.is_some());
1581 } else if counterparty_revoked_commitment {
1582 let htlc_output_claim_pending = self.onchain_events_awaiting_threshold_conf.iter().find_map(|event| {
1583 if let OnchainEvent::MaturingOutput {
1584 descriptor: SpendableOutputDescriptor::StaticOutput { .. }
1586 if event.transaction.as_ref().map(|tx| tx.input.iter().any(|inp| {
1587 if let Some(htlc_spend_txid) = htlc_spend_txid_opt {
1588 Some(tx.txid()) == htlc_spend_txid_opt ||
1589 inp.previous_output.txid == htlc_spend_txid
1591 Some(inp.previous_output.txid) == confirmed_txid &&
1592 inp.previous_output.vout == htlc_commitment_tx_output_idx
1594 })).unwrap_or(false) {
1599 if htlc_output_claim_pending.is_some() {
1600 // We already push `Balance`s onto the `res` list for every
1601 // `StaticOutput` in a `MaturingOutput` in the revoked
1602 // counterparty commitment transaction case generally, so don't
1603 // need to do so again here.
1605 debug_assert!(holder_timeout_spend_pending.is_none(),
1606 "HTLCUpdate OnchainEvents should never appear for preimage claims");
1607 debug_assert!(!htlc.offered || htlc_spend_pending.is_none() || !htlc_spend_pending.unwrap().1,
1608 "We don't (currently) generate preimage claims against revoked outputs, where did you get one?!");
1609 return Some(Balance::CounterpartyRevokedOutputClaimable {
1610 claimable_amount_satoshis: htlc.amount_msat / 1000,
1613 } else if htlc.offered == holder_commitment {
1614 // If the payment was outbound, check if there's an HTLCUpdate
1615 // indicating we have spent this HTLC with a timeout, claiming it back
1616 // and awaiting confirmations on it.
1617 if let Some(conf_thresh) = holder_timeout_spend_pending {
1618 return Some(Balance::ClaimableAwaitingConfirmations {
1619 claimable_amount_satoshis: htlc.amount_msat / 1000,
1620 confirmation_height: conf_thresh,
1623 return Some(Balance::MaybeTimeoutClaimableHTLC {
1624 claimable_amount_satoshis: htlc.amount_msat / 1000,
1625 claimable_height: htlc.cltv_expiry,
1628 } else if self.payment_preimages.get(&htlc.payment_hash).is_some() {
1629 // Otherwise (the payment was inbound), only expose it as claimable if
1630 // we know the preimage.
1631 // Note that if there is a pending claim, but it did not use the
1632 // preimage, we lost funds to our counterparty! We will then continue
1633 // to show it as ContentiousClaimable until ANTI_REORG_DELAY.
1634 debug_assert!(holder_timeout_spend_pending.is_none());
1635 if let Some((conf_thresh, true)) = htlc_spend_pending {
1636 return Some(Balance::ClaimableAwaitingConfirmations {
1637 claimable_amount_satoshis: htlc.amount_msat / 1000,
1638 confirmation_height: conf_thresh,
1641 return Some(Balance::ContentiousClaimable {
1642 claimable_amount_satoshis: htlc.amount_msat / 1000,
1643 timeout_height: htlc.cltv_expiry,
1646 } else if htlc_resolved.is_none() {
1647 return Some(Balance::MaybePreimageClaimableHTLC {
1648 claimable_amount_satoshis: htlc.amount_msat / 1000,
1649 expiry_height: htlc.cltv_expiry,
1656 impl<Signer: Sign> ChannelMonitor<Signer> {
1657 /// Gets the balances in this channel which are either claimable by us if we were to
1658 /// force-close the channel now or which are claimable on-chain (possibly awaiting
1661 /// Any balances in the channel which are available on-chain (excluding on-chain fees) are
1662 /// included here until an [`Event::SpendableOutputs`] event has been generated for the
1663 /// balance, or until our counterparty has claimed the balance and accrued several
1664 /// confirmations on the claim transaction.
1666 /// Note that for `ChannelMonitors` which track a channel which went on-chain with versions of
1667 /// LDK prior to 0.0.111, balances may not be fully captured if our counterparty broadcasted
1668 /// a revoked state.
1670 /// See [`Balance`] for additional details on the types of claimable balances which
1671 /// may be returned here and their meanings.
1672 pub fn get_claimable_balances(&self) -> Vec<Balance> {
1673 let mut res = Vec::new();
1674 let us = self.inner.lock().unwrap();
1676 let mut confirmed_txid = us.funding_spend_confirmed;
1677 let mut confirmed_counterparty_output = us.confirmed_commitment_tx_counterparty_output;
1678 let mut pending_commitment_tx_conf_thresh = None;
1679 let funding_spend_pending = us.onchain_events_awaiting_threshold_conf.iter().find_map(|event| {
1680 if let OnchainEvent::FundingSpendConfirmation { commitment_tx_to_counterparty_output, .. } =
1683 confirmed_counterparty_output = commitment_tx_to_counterparty_output;
1684 Some((event.txid, event.confirmation_threshold()))
1687 if let Some((txid, conf_thresh)) = funding_spend_pending {
1688 debug_assert!(us.funding_spend_confirmed.is_none(),
1689 "We have a pending funding spend awaiting anti-reorg confirmation, we can't have confirmed it already!");
1690 confirmed_txid = Some(txid);
1691 pending_commitment_tx_conf_thresh = Some(conf_thresh);
1694 macro_rules! walk_htlcs {
1695 ($holder_commitment: expr, $counterparty_revoked_commitment: expr, $htlc_iter: expr) => {
1696 for htlc in $htlc_iter {
1697 if htlc.transaction_output_index.is_some() {
1699 if let Some(bal) = us.get_htlc_balance(htlc, $holder_commitment, $counterparty_revoked_commitment, confirmed_txid) {
1707 if let Some(txid) = confirmed_txid {
1708 let mut found_commitment_tx = false;
1709 if let Some(counterparty_tx_htlcs) = us.counterparty_claimable_outpoints.get(&txid) {
1710 // First look for the to_remote output back to us.
1711 if let Some(conf_thresh) = pending_commitment_tx_conf_thresh {
1712 if let Some(value) = us.onchain_events_awaiting_threshold_conf.iter().find_map(|event| {
1713 if let OnchainEvent::MaturingOutput {
1714 descriptor: SpendableOutputDescriptor::StaticPaymentOutput(descriptor)
1716 Some(descriptor.output.value)
1719 res.push(Balance::ClaimableAwaitingConfirmations {
1720 claimable_amount_satoshis: value,
1721 confirmation_height: conf_thresh,
1724 // If a counterparty commitment transaction is awaiting confirmation, we
1725 // should either have a StaticPaymentOutput MaturingOutput event awaiting
1726 // confirmation with the same height or have never met our dust amount.
1729 if Some(txid) == us.current_counterparty_commitment_txid || Some(txid) == us.prev_counterparty_commitment_txid {
1730 walk_htlcs!(false, false, counterparty_tx_htlcs.iter().map(|(a, _)| a));
1732 walk_htlcs!(false, true, counterparty_tx_htlcs.iter().map(|(a, _)| a));
1733 // The counterparty broadcasted a revoked state!
1734 // Look for any StaticOutputs first, generating claimable balances for those.
1735 // If any match the confirmed counterparty revoked to_self output, skip
1736 // generating a CounterpartyRevokedOutputClaimable.
1737 let mut spent_counterparty_output = false;
1738 for event in us.onchain_events_awaiting_threshold_conf.iter() {
1739 if let OnchainEvent::MaturingOutput {
1740 descriptor: SpendableOutputDescriptor::StaticOutput { output, .. }
1742 res.push(Balance::ClaimableAwaitingConfirmations {
1743 claimable_amount_satoshis: output.value,
1744 confirmation_height: event.confirmation_threshold(),
1746 if let Some(confirmed_to_self_idx) = confirmed_counterparty_output.map(|(idx, _)| idx) {
1747 if event.transaction.as_ref().map(|tx|
1748 tx.input.iter().any(|inp| inp.previous_output.vout == confirmed_to_self_idx)
1749 ).unwrap_or(false) {
1750 spent_counterparty_output = true;
1756 if spent_counterparty_output {
1757 } else if let Some((confirmed_to_self_idx, amt)) = confirmed_counterparty_output {
1758 let output_spendable = us.onchain_tx_handler
1759 .is_output_spend_pending(&BitcoinOutPoint::new(txid, confirmed_to_self_idx));
1760 if output_spendable {
1761 res.push(Balance::CounterpartyRevokedOutputClaimable {
1762 claimable_amount_satoshis: amt,
1766 // Counterparty output is missing, either it was broadcasted on a
1767 // previous version of LDK or the counterparty hadn't met dust.
1770 found_commitment_tx = true;
1771 } else if txid == us.current_holder_commitment_tx.txid {
1772 walk_htlcs!(true, false, us.current_holder_commitment_tx.htlc_outputs.iter().map(|(a, _, _)| a));
1773 if let Some(conf_thresh) = pending_commitment_tx_conf_thresh {
1774 res.push(Balance::ClaimableAwaitingConfirmations {
1775 claimable_amount_satoshis: us.current_holder_commitment_tx.to_self_value_sat,
1776 confirmation_height: conf_thresh,
1779 found_commitment_tx = true;
1780 } else if let Some(prev_commitment) = &us.prev_holder_signed_commitment_tx {
1781 if txid == prev_commitment.txid {
1782 walk_htlcs!(true, false, prev_commitment.htlc_outputs.iter().map(|(a, _, _)| a));
1783 if let Some(conf_thresh) = pending_commitment_tx_conf_thresh {
1784 res.push(Balance::ClaimableAwaitingConfirmations {
1785 claimable_amount_satoshis: prev_commitment.to_self_value_sat,
1786 confirmation_height: conf_thresh,
1789 found_commitment_tx = true;
1792 if !found_commitment_tx {
1793 if let Some(conf_thresh) = pending_commitment_tx_conf_thresh {
1794 // We blindly assume this is a cooperative close transaction here, and that
1795 // neither us nor our counterparty misbehaved. At worst we've under-estimated
1796 // the amount we can claim as we'll punish a misbehaving counterparty.
1797 res.push(Balance::ClaimableAwaitingConfirmations {
1798 claimable_amount_satoshis: us.current_holder_commitment_tx.to_self_value_sat,
1799 confirmation_height: conf_thresh,
1804 let mut claimable_inbound_htlc_value_sat = 0;
1805 for (htlc, _, _) in us.current_holder_commitment_tx.htlc_outputs.iter() {
1806 if htlc.transaction_output_index.is_none() { continue; }
1808 res.push(Balance::MaybeTimeoutClaimableHTLC {
1809 claimable_amount_satoshis: htlc.amount_msat / 1000,
1810 claimable_height: htlc.cltv_expiry,
1812 } else if us.payment_preimages.get(&htlc.payment_hash).is_some() {
1813 claimable_inbound_htlc_value_sat += htlc.amount_msat / 1000;
1815 // As long as the HTLC is still in our latest commitment state, treat
1816 // it as potentially claimable, even if it has long-since expired.
1817 res.push(Balance::MaybePreimageClaimableHTLC {
1818 claimable_amount_satoshis: htlc.amount_msat / 1000,
1819 expiry_height: htlc.cltv_expiry,
1823 res.push(Balance::ClaimableOnChannelClose {
1824 claimable_amount_satoshis: us.current_holder_commitment_tx.to_self_value_sat + claimable_inbound_htlc_value_sat,
1831 /// Gets the set of outbound HTLCs which are pending resolution in this channel.
1832 /// This is used to reconstruct pending outbound payments on restart in the ChannelManager.
1833 pub(crate) fn get_pending_outbound_htlcs(&self) -> HashMap<HTLCSource, HTLCOutputInCommitment> {
1834 let mut res = HashMap::new();
1835 let us = self.inner.lock().unwrap();
1837 macro_rules! walk_htlcs {
1838 ($holder_commitment: expr, $htlc_iter: expr) => {
1839 for (htlc, source) in $htlc_iter {
1840 if us.htlcs_resolved_on_chain.iter().any(|v| v.commitment_tx_output_idx == htlc.transaction_output_index) {
1841 // We should assert that funding_spend_confirmed is_some() here, but we
1842 // have some unit tests which violate HTLC transaction CSVs entirely and
1844 // TODO: Once tests all connect transactions at consensus-valid times, we
1845 // should assert here like we do in `get_claimable_balances`.
1846 } else if htlc.offered == $holder_commitment {
1847 // If the payment was outbound, check if there's an HTLCUpdate
1848 // indicating we have spent this HTLC with a timeout, claiming it back
1849 // and awaiting confirmations on it.
1850 let htlc_update_confd = us.onchain_events_awaiting_threshold_conf.iter().any(|event| {
1851 if let OnchainEvent::HTLCUpdate { commitment_tx_output_idx: Some(commitment_tx_output_idx), .. } = event.event {
1852 // If the HTLC was timed out, we wait for ANTI_REORG_DELAY blocks
1853 // before considering it "no longer pending" - this matches when we
1854 // provide the ChannelManager an HTLC failure event.
1855 Some(commitment_tx_output_idx) == htlc.transaction_output_index &&
1856 us.best_block.height() >= event.height + ANTI_REORG_DELAY - 1
1857 } else if let OnchainEvent::HTLCSpendConfirmation { commitment_tx_output_idx, .. } = event.event {
1858 // If the HTLC was fulfilled with a preimage, we consider the HTLC
1859 // immediately non-pending, matching when we provide ChannelManager
1861 Some(commitment_tx_output_idx) == htlc.transaction_output_index
1864 if !htlc_update_confd {
1865 res.insert(source.clone(), htlc.clone());
1872 // We're only concerned with the confirmation count of HTLC transactions, and don't
1873 // actually care how many confirmations a commitment transaction may or may not have. Thus,
1874 // we look for either a FundingSpendConfirmation event or a funding_spend_confirmed.
1875 let confirmed_txid = us.funding_spend_confirmed.or_else(|| {
1876 us.onchain_events_awaiting_threshold_conf.iter().find_map(|event| {
1877 if let OnchainEvent::FundingSpendConfirmation { .. } = event.event {
1882 if let Some(txid) = confirmed_txid {
1883 if Some(txid) == us.current_counterparty_commitment_txid || Some(txid) == us.prev_counterparty_commitment_txid {
1884 walk_htlcs!(false, us.counterparty_claimable_outpoints.get(&txid).unwrap().iter().filter_map(|(a, b)| {
1885 if let &Some(ref source) = b {
1886 Some((a, &**source))
1889 } else if txid == us.current_holder_commitment_tx.txid {
1890 walk_htlcs!(true, us.current_holder_commitment_tx.htlc_outputs.iter().filter_map(|(a, _, c)| {
1891 if let Some(source) = c { Some((a, source)) } else { None }
1893 } else if let Some(prev_commitment) = &us.prev_holder_signed_commitment_tx {
1894 if txid == prev_commitment.txid {
1895 walk_htlcs!(true, prev_commitment.htlc_outputs.iter().filter_map(|(a, _, c)| {
1896 if let Some(source) = c { Some((a, source)) } else { None }
1901 // If we have not seen a commitment transaction on-chain (ie the channel is not yet
1902 // closed), just examine the available counterparty commitment transactions. See docs
1903 // on `fail_unbroadcast_htlcs`, below, for justification.
1904 macro_rules! walk_counterparty_commitment {
1906 if let Some(ref latest_outpoints) = us.counterparty_claimable_outpoints.get($txid) {
1907 for &(ref htlc, ref source_option) in latest_outpoints.iter() {
1908 if let &Some(ref source) = source_option {
1909 res.insert((**source).clone(), htlc.clone());
1915 if let Some(ref txid) = us.current_counterparty_commitment_txid {
1916 walk_counterparty_commitment!(txid);
1918 if let Some(ref txid) = us.prev_counterparty_commitment_txid {
1919 walk_counterparty_commitment!(txid);
1926 pub(crate) fn get_stored_preimages(&self) -> HashMap<PaymentHash, PaymentPreimage> {
1927 self.inner.lock().unwrap().payment_preimages.clone()
1931 /// Compares a broadcasted commitment transaction's HTLCs with those in the latest state,
1932 /// failing any HTLCs which didn't make it into the broadcasted commitment transaction back
1933 /// after ANTI_REORG_DELAY blocks.
1935 /// We always compare against the set of HTLCs in counterparty commitment transactions, as those
1936 /// are the commitment transactions which are generated by us. The off-chain state machine in
1937 /// `Channel` will automatically resolve any HTLCs which were never included in a commitment
1938 /// transaction when it detects channel closure, but it is up to us to ensure any HTLCs which were
1939 /// included in a remote commitment transaction are failed back if they are not present in the
1940 /// broadcasted commitment transaction.
1942 /// Specifically, the removal process for HTLCs in `Channel` is always based on the counterparty
1943 /// sending a `revoke_and_ack`, which causes us to clear `prev_counterparty_commitment_txid`. Thus,
1944 /// as long as we examine both the current counterparty commitment transaction and, if it hasn't
1945 /// been revoked yet, the previous one, we we will never "forget" to resolve an HTLC.
1946 macro_rules! fail_unbroadcast_htlcs {
1947 ($self: expr, $commitment_tx_type: expr, $commitment_txid_confirmed: expr, $commitment_tx_confirmed: expr,
1948 $commitment_tx_conf_height: expr, $commitment_tx_conf_hash: expr, $confirmed_htlcs_list: expr, $logger: expr) => { {
1949 debug_assert_eq!($commitment_tx_confirmed.txid(), $commitment_txid_confirmed);
1951 macro_rules! check_htlc_fails {
1952 ($txid: expr, $commitment_tx: expr) => {
1953 if let Some(ref latest_outpoints) = $self.counterparty_claimable_outpoints.get($txid) {
1954 for &(ref htlc, ref source_option) in latest_outpoints.iter() {
1955 if let &Some(ref source) = source_option {
1956 // Check if the HTLC is present in the commitment transaction that was
1957 // broadcast, but not if it was below the dust limit, which we should
1958 // fail backwards immediately as there is no way for us to learn the
1959 // payment_preimage.
1960 // Note that if the dust limit were allowed to change between
1961 // commitment transactions we'd want to be check whether *any*
1962 // broadcastable commitment transaction has the HTLC in it, but it
1963 // cannot currently change after channel initialization, so we don't
1965 let confirmed_htlcs_iter: &mut Iterator<Item = (&HTLCOutputInCommitment, Option<&HTLCSource>)> = &mut $confirmed_htlcs_list;
1967 let mut matched_htlc = false;
1968 for (ref broadcast_htlc, ref broadcast_source) in confirmed_htlcs_iter {
1969 if broadcast_htlc.transaction_output_index.is_some() &&
1970 (Some(&**source) == *broadcast_source ||
1971 (broadcast_source.is_none() &&
1972 broadcast_htlc.payment_hash == htlc.payment_hash &&
1973 broadcast_htlc.amount_msat == htlc.amount_msat)) {
1974 matched_htlc = true;
1978 if matched_htlc { continue; }
1979 $self.onchain_events_awaiting_threshold_conf.retain(|ref entry| {
1980 if entry.height != $commitment_tx_conf_height { return true; }
1982 OnchainEvent::HTLCUpdate { source: ref update_source, .. } => {
1983 *update_source != **source
1988 let entry = OnchainEventEntry {
1989 txid: $commitment_txid_confirmed,
1990 transaction: Some($commitment_tx_confirmed.clone()),
1991 height: $commitment_tx_conf_height,
1992 block_hash: Some(*$commitment_tx_conf_hash),
1993 event: OnchainEvent::HTLCUpdate {
1994 source: (**source).clone(),
1995 payment_hash: htlc.payment_hash.clone(),
1996 htlc_value_satoshis: Some(htlc.amount_msat / 1000),
1997 commitment_tx_output_idx: None,
2000 log_trace!($logger, "Failing HTLC with payment_hash {} from {} counterparty commitment tx due to broadcast of {} commitment transaction {}, waiting for confirmation (at height {})",
2001 log_bytes!(htlc.payment_hash.0), $commitment_tx, $commitment_tx_type,
2002 $commitment_txid_confirmed, entry.confirmation_threshold());
2003 $self.onchain_events_awaiting_threshold_conf.push(entry);
2009 if let Some(ref txid) = $self.current_counterparty_commitment_txid {
2010 check_htlc_fails!(txid, "current");
2012 if let Some(ref txid) = $self.prev_counterparty_commitment_txid {
2013 check_htlc_fails!(txid, "previous");
2018 // In the `test_invalid_funding_tx` test, we need a bogus script which matches the HTLC-Accepted
2019 // witness length match (ie is 136 bytes long). We generate one here which we also use in some
2020 // in-line tests later.
2023 pub fn deliberately_bogus_accepted_htlc_witness_program() -> Vec<u8> {
2024 let mut ret = [opcodes::all::OP_NOP.to_u8(); 136];
2025 ret[131] = opcodes::all::OP_DROP.to_u8();
2026 ret[132] = opcodes::all::OP_DROP.to_u8();
2027 ret[133] = opcodes::all::OP_DROP.to_u8();
2028 ret[134] = opcodes::all::OP_DROP.to_u8();
2029 ret[135] = opcodes::OP_TRUE.to_u8();
2034 pub fn deliberately_bogus_accepted_htlc_witness() -> Vec<Vec<u8>> {
2035 vec![Vec::new(), Vec::new(), Vec::new(), Vec::new(), deliberately_bogus_accepted_htlc_witness_program().into()].into()
2038 impl<Signer: Sign> ChannelMonitorImpl<Signer> {
2039 /// Inserts a revocation secret into this channel monitor. Prunes old preimages if neither
2040 /// needed by holder commitment transactions HTCLs nor by counterparty ones. Unless we haven't already seen
2041 /// counterparty commitment transaction's secret, they are de facto pruned (we can use revocation key).
2042 fn provide_secret(&mut self, idx: u64, secret: [u8; 32]) -> Result<(), &'static str> {
2043 if let Err(()) = self.commitment_secrets.provide_secret(idx, secret) {
2044 return Err("Previous secret did not match new one");
2047 // Prune HTLCs from the previous counterparty commitment tx so we don't generate failure/fulfill
2048 // events for now-revoked/fulfilled HTLCs.
2049 if let Some(txid) = self.prev_counterparty_commitment_txid.take() {
2050 for &mut (_, ref mut source) in self.counterparty_claimable_outpoints.get_mut(&txid).unwrap() {
2055 if !self.payment_preimages.is_empty() {
2056 let cur_holder_signed_commitment_tx = &self.current_holder_commitment_tx;
2057 let prev_holder_signed_commitment_tx = self.prev_holder_signed_commitment_tx.as_ref();
2058 let min_idx = self.get_min_seen_secret();
2059 let counterparty_hash_commitment_number = &mut self.counterparty_hash_commitment_number;
2061 self.payment_preimages.retain(|&k, _| {
2062 for &(ref htlc, _, _) in cur_holder_signed_commitment_tx.htlc_outputs.iter() {
2063 if k == htlc.payment_hash {
2067 if let Some(prev_holder_commitment_tx) = prev_holder_signed_commitment_tx {
2068 for &(ref htlc, _, _) in prev_holder_commitment_tx.htlc_outputs.iter() {
2069 if k == htlc.payment_hash {
2074 let contains = if let Some(cn) = counterparty_hash_commitment_number.get(&k) {
2081 counterparty_hash_commitment_number.remove(&k);
2090 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_per_commitment_point: PublicKey, logger: &L) where L::Target: Logger {
2091 // TODO: Encrypt the htlc_outputs data with the single-hash of the commitment transaction
2092 // so that a remote monitor doesn't learn anything unless there is a malicious close.
2093 // (only maybe, sadly we cant do the same for local info, as we need to be aware of
2095 for &(ref htlc, _) in &htlc_outputs {
2096 self.counterparty_hash_commitment_number.insert(htlc.payment_hash, commitment_number);
2099 log_trace!(logger, "Tracking new counterparty commitment transaction with txid {} at commitment number {} with {} HTLC outputs", txid, commitment_number, htlc_outputs.len());
2100 self.prev_counterparty_commitment_txid = self.current_counterparty_commitment_txid.take();
2101 self.current_counterparty_commitment_txid = Some(txid);
2102 self.counterparty_claimable_outpoints.insert(txid, htlc_outputs.clone());
2103 self.current_counterparty_commitment_number = commitment_number;
2104 //TODO: Merge this into the other per-counterparty-transaction output storage stuff
2105 match self.their_cur_per_commitment_points {
2106 Some(old_points) => {
2107 if old_points.0 == commitment_number + 1 {
2108 self.their_cur_per_commitment_points = Some((old_points.0, old_points.1, Some(their_per_commitment_point)));
2109 } else if old_points.0 == commitment_number + 2 {
2110 if let Some(old_second_point) = old_points.2 {
2111 self.their_cur_per_commitment_points = Some((old_points.0 - 1, old_second_point, Some(their_per_commitment_point)));
2113 self.their_cur_per_commitment_points = Some((commitment_number, their_per_commitment_point, None));
2116 self.their_cur_per_commitment_points = Some((commitment_number, their_per_commitment_point, None));
2120 self.their_cur_per_commitment_points = Some((commitment_number, their_per_commitment_point, None));
2123 let mut htlcs = Vec::with_capacity(htlc_outputs.len());
2124 for htlc in htlc_outputs {
2125 if htlc.0.transaction_output_index.is_some() {
2131 /// Informs this monitor of the latest holder (ie broadcastable) commitment transaction. The
2132 /// monitor watches for timeouts and may broadcast it if we approach such a timeout. Thus, it
2133 /// is important that any clones of this channel monitor (including remote clones) by kept
2134 /// up-to-date as our holder commitment transaction is updated.
2135 /// Panics if set_on_holder_tx_csv has never been called.
2136 fn provide_latest_holder_commitment_tx(&mut self, holder_commitment_tx: HolderCommitmentTransaction, htlc_outputs: Vec<(HTLCOutputInCommitment, Option<Signature>, Option<HTLCSource>)>) -> Result<(), &'static str> {
2137 // block for Rust 1.34 compat
2138 let mut new_holder_commitment_tx = {
2139 let trusted_tx = holder_commitment_tx.trust();
2140 let txid = trusted_tx.txid();
2141 let tx_keys = trusted_tx.keys();
2142 self.current_holder_commitment_number = trusted_tx.commitment_number();
2145 revocation_key: tx_keys.revocation_key,
2146 a_htlc_key: tx_keys.broadcaster_htlc_key,
2147 b_htlc_key: tx_keys.countersignatory_htlc_key,
2148 delayed_payment_key: tx_keys.broadcaster_delayed_payment_key,
2149 per_commitment_point: tx_keys.per_commitment_point,
2151 to_self_value_sat: holder_commitment_tx.to_broadcaster_value_sat(),
2152 feerate_per_kw: trusted_tx.feerate_per_kw(),
2155 self.onchain_tx_handler.provide_latest_holder_tx(holder_commitment_tx);
2156 mem::swap(&mut new_holder_commitment_tx, &mut self.current_holder_commitment_tx);
2157 self.prev_holder_signed_commitment_tx = Some(new_holder_commitment_tx);
2158 if self.holder_tx_signed {
2159 return Err("Latest holder commitment signed has already been signed, update is rejected");
2164 /// Provides a payment_hash->payment_preimage mapping. Will be automatically pruned when all
2165 /// commitment_tx_infos which contain the payment hash have been revoked.
2166 fn provide_payment_preimage<B: Deref, F: Deref, L: Deref>(
2167 &mut self, payment_hash: &PaymentHash, payment_preimage: &PaymentPreimage, broadcaster: &B,
2168 fee_estimator: &LowerBoundedFeeEstimator<F>, logger: &L)
2169 where B::Target: BroadcasterInterface,
2170 F::Target: FeeEstimator,
2173 self.payment_preimages.insert(payment_hash.clone(), payment_preimage.clone());
2175 // If the channel is force closed, try to claim the output from this preimage.
2176 // First check if a counterparty commitment transaction has been broadcasted:
2177 macro_rules! claim_htlcs {
2178 ($commitment_number: expr, $txid: expr) => {
2179 let (htlc_claim_reqs, _) = self.get_counterparty_output_claim_info($commitment_number, $txid, None);
2180 self.onchain_tx_handler.update_claims_view_from_requests(htlc_claim_reqs, self.best_block.height(), self.best_block.height(), broadcaster, fee_estimator, logger);
2183 if let Some(txid) = self.current_counterparty_commitment_txid {
2184 if let Some(commitment_number) = self.counterparty_commitment_txn_on_chain.get(&txid) {
2185 claim_htlcs!(*commitment_number, txid);
2189 if let Some(txid) = self.prev_counterparty_commitment_txid {
2190 if let Some(commitment_number) = self.counterparty_commitment_txn_on_chain.get(&txid) {
2191 claim_htlcs!(*commitment_number, txid);
2196 // Then if a holder commitment transaction has been seen on-chain, broadcast transactions
2197 // claiming the HTLC output from each of the holder commitment transactions.
2198 // Note that we can't just use `self.holder_tx_signed`, because that only covers the case where
2199 // *we* sign a holder commitment transaction, not when e.g. a watchtower broadcasts one of our
2200 // holder commitment transactions.
2201 if self.broadcasted_holder_revokable_script.is_some() {
2202 // Assume that the broadcasted commitment transaction confirmed in the current best
2203 // block. Even if not, its a reasonable metric for the bump criteria on the HTLC
2205 let (claim_reqs, _) = self.get_broadcasted_holder_claims(&self.current_holder_commitment_tx, self.best_block.height());
2206 self.onchain_tx_handler.update_claims_view_from_requests(claim_reqs, self.best_block.height(), self.best_block.height(), broadcaster, fee_estimator, logger);
2207 if let Some(ref tx) = self.prev_holder_signed_commitment_tx {
2208 let (claim_reqs, _) = self.get_broadcasted_holder_claims(&tx, self.best_block.height());
2209 self.onchain_tx_handler.update_claims_view_from_requests(claim_reqs, self.best_block.height(), self.best_block.height(), broadcaster, fee_estimator, logger);
2214 pub(crate) fn broadcast_latest_holder_commitment_txn<B: Deref, L: Deref>(&mut self, broadcaster: &B, logger: &L)
2215 where B::Target: BroadcasterInterface,
2218 for tx in self.get_latest_holder_commitment_txn(logger).iter() {
2219 log_info!(logger, "Broadcasting local {}", log_tx!(tx));
2220 broadcaster.broadcast_transaction(tx);
2222 self.pending_monitor_events.push(MonitorEvent::CommitmentTxConfirmed(self.funding_info.0));
2225 pub fn update_monitor<B: Deref, F: Deref, L: Deref>(&mut self, updates: &ChannelMonitorUpdate, broadcaster: &B, fee_estimator: F, logger: &L) -> Result<(), ()>
2226 where B::Target: BroadcasterInterface,
2227 F::Target: FeeEstimator,
2230 log_info!(logger, "Applying update to monitor {}, bringing update_id from {} to {} with {} changes.",
2231 log_funding_info!(self), self.latest_update_id, updates.update_id, updates.updates.len());
2232 // ChannelMonitor updates may be applied after force close if we receive a
2233 // preimage for a broadcasted commitment transaction HTLC output that we'd
2234 // like to claim on-chain. If this is the case, we no longer have guaranteed
2235 // access to the monitor's update ID, so we use a sentinel value instead.
2236 if updates.update_id == CLOSED_CHANNEL_UPDATE_ID {
2237 assert_eq!(updates.updates.len(), 1);
2238 match updates.updates[0] {
2239 ChannelMonitorUpdateStep::PaymentPreimage { .. } => {},
2241 log_error!(logger, "Attempted to apply post-force-close ChannelMonitorUpdate of type {}", updates.updates[0].variant_name());
2242 panic!("Attempted to apply post-force-close ChannelMonitorUpdate that wasn't providing a payment preimage");
2245 } else if self.latest_update_id + 1 != updates.update_id {
2246 panic!("Attempted to apply ChannelMonitorUpdates out of order, check the update_id before passing an update to update_monitor!");
2248 let mut ret = Ok(());
2249 let bounded_fee_estimator = LowerBoundedFeeEstimator::new(&*fee_estimator);
2250 for update in updates.updates.iter() {
2252 ChannelMonitorUpdateStep::LatestHolderCommitmentTXInfo { commitment_tx, htlc_outputs } => {
2253 log_trace!(logger, "Updating ChannelMonitor with latest holder commitment transaction info");
2254 if self.lockdown_from_offchain { panic!(); }
2255 if let Err(e) = self.provide_latest_holder_commitment_tx(commitment_tx.clone(), htlc_outputs.clone()) {
2256 log_error!(logger, "Providing latest holder commitment transaction failed/was refused:");
2257 log_error!(logger, " {}", e);
2261 ChannelMonitorUpdateStep::LatestCounterpartyCommitmentTXInfo { commitment_txid, htlc_outputs, commitment_number, their_per_commitment_point } => {
2262 log_trace!(logger, "Updating ChannelMonitor with latest counterparty commitment transaction info");
2263 self.provide_latest_counterparty_commitment_tx(*commitment_txid, htlc_outputs.clone(), *commitment_number, *their_per_commitment_point, logger)
2265 ChannelMonitorUpdateStep::PaymentPreimage { payment_preimage } => {
2266 log_trace!(logger, "Updating ChannelMonitor with payment preimage");
2267 self.provide_payment_preimage(&PaymentHash(Sha256::hash(&payment_preimage.0[..]).into_inner()), &payment_preimage, broadcaster, &bounded_fee_estimator, logger)
2269 ChannelMonitorUpdateStep::CommitmentSecret { idx, secret } => {
2270 log_trace!(logger, "Updating ChannelMonitor with commitment secret");
2271 if let Err(e) = self.provide_secret(*idx, *secret) {
2272 log_error!(logger, "Providing latest counterparty commitment secret failed/was refused:");
2273 log_error!(logger, " {}", e);
2277 ChannelMonitorUpdateStep::ChannelForceClosed { should_broadcast } => {
2278 log_trace!(logger, "Updating ChannelMonitor: channel force closed, should broadcast: {}", should_broadcast);
2279 self.lockdown_from_offchain = true;
2280 if *should_broadcast {
2281 self.broadcast_latest_holder_commitment_txn(broadcaster, logger);
2282 // If the channel supports anchor outputs, we'll need to emit an external
2283 // event to be consumed such that a child transaction is broadcast with a
2284 // high enough feerate for the parent commitment transaction to confirm.
2285 if self.onchain_tx_handler.opt_anchors() {
2286 let funding_output = HolderFundingOutput::build(
2287 self.funding_redeemscript.clone(), self.channel_value_satoshis,
2288 self.onchain_tx_handler.opt_anchors(),
2290 let best_block_height = self.best_block.height();
2291 let commitment_package = PackageTemplate::build_package(
2292 self.funding_info.0.txid.clone(), self.funding_info.0.index as u32,
2293 PackageSolvingData::HolderFundingOutput(funding_output),
2294 best_block_height, false, best_block_height,
2296 self.onchain_tx_handler.update_claims_view_from_requests(
2297 vec![commitment_package], best_block_height, best_block_height,
2298 broadcaster, &bounded_fee_estimator, logger,
2301 } else if !self.holder_tx_signed {
2302 log_error!(logger, "WARNING: You have a potentially-unsafe holder commitment transaction available to broadcast");
2303 log_error!(logger, " in channel monitor for channel {}!", log_bytes!(self.funding_info.0.to_channel_id()));
2304 log_error!(logger, " Read the docs for ChannelMonitor::get_latest_holder_commitment_txn and take manual action!");
2306 // If we generated a MonitorEvent::CommitmentTxConfirmed, the ChannelManager
2307 // will still give us a ChannelForceClosed event with !should_broadcast, but we
2308 // shouldn't print the scary warning above.
2309 log_info!(logger, "Channel off-chain state closed after we broadcasted our latest commitment transaction.");
2312 ChannelMonitorUpdateStep::ShutdownScript { scriptpubkey } => {
2313 log_trace!(logger, "Updating ChannelMonitor with shutdown script");
2314 if let Some(shutdown_script) = self.shutdown_script.replace(scriptpubkey.clone()) {
2315 panic!("Attempted to replace shutdown script {} with {}", shutdown_script, scriptpubkey);
2320 self.latest_update_id = updates.update_id;
2322 if ret.is_ok() && self.funding_spend_seen {
2323 log_error!(logger, "Refusing Channel Monitor Update as counterparty attempted to update commitment after funding was spent");
2328 pub fn get_latest_update_id(&self) -> u64 {
2329 self.latest_update_id
2332 pub fn get_funding_txo(&self) -> &(OutPoint, Script) {
2336 pub fn get_outputs_to_watch(&self) -> &HashMap<Txid, Vec<(u32, Script)>> {
2337 // If we've detected a counterparty commitment tx on chain, we must include it in the set
2338 // of outputs to watch for spends of, otherwise we're likely to lose user funds. Because
2339 // its trivial to do, double-check that here.
2340 for (txid, _) in self.counterparty_commitment_txn_on_chain.iter() {
2341 self.outputs_to_watch.get(txid).expect("Counterparty commitment txn which have been broadcast should have outputs registered");
2343 &self.outputs_to_watch
2346 pub fn get_and_clear_pending_monitor_events(&mut self) -> Vec<MonitorEvent> {
2347 let mut ret = Vec::new();
2348 mem::swap(&mut ret, &mut self.pending_monitor_events);
2352 pub fn get_and_clear_pending_events(&mut self) -> Vec<Event> {
2353 let mut ret = Vec::new();
2354 mem::swap(&mut ret, &mut self.pending_events);
2356 for claim_event in self.onchain_tx_handler.get_and_clear_pending_claim_events().drain(..) {
2358 ClaimEvent::BumpCommitment {
2359 package_target_feerate_sat_per_1000_weight, commitment_tx, anchor_output_idx,
2361 let commitment_txid = commitment_tx.txid();
2362 debug_assert_eq!(self.current_holder_commitment_tx.txid, commitment_txid);
2363 let pending_htlcs = self.current_holder_commitment_tx.non_dust_htlcs();
2364 let commitment_tx_fee_satoshis = self.channel_value_satoshis -
2365 commitment_tx.output.iter().fold(0u64, |sum, output| sum + output.value);
2366 ret.push(Event::BumpTransaction(BumpTransactionEvent::ChannelClose {
2367 package_target_feerate_sat_per_1000_weight,
2369 commitment_tx_fee_satoshis,
2370 anchor_descriptor: AnchorDescriptor {
2371 channel_keys_id: self.channel_keys_id,
2372 channel_value_satoshis: self.channel_value_satoshis,
2373 outpoint: BitcoinOutPoint {
2374 txid: commitment_txid,
2375 vout: anchor_output_idx,
2386 /// Can only fail if idx is < get_min_seen_secret
2387 fn get_secret(&self, idx: u64) -> Option<[u8; 32]> {
2388 self.commitment_secrets.get_secret(idx)
2391 pub(crate) fn get_min_seen_secret(&self) -> u64 {
2392 self.commitment_secrets.get_min_seen_secret()
2395 pub(crate) fn get_cur_counterparty_commitment_number(&self) -> u64 {
2396 self.current_counterparty_commitment_number
2399 pub(crate) fn get_cur_holder_commitment_number(&self) -> u64 {
2400 self.current_holder_commitment_number
2403 /// Attempts to claim a counterparty commitment transaction's outputs using the revocation key and
2404 /// data in counterparty_claimable_outpoints. Will directly claim any HTLC outputs which expire at a
2405 /// height > height + CLTV_SHARED_CLAIM_BUFFER. In any case, will install monitoring for
2406 /// HTLC-Success/HTLC-Timeout transactions.
2408 /// Returns packages to claim the revoked output(s), as well as additional outputs to watch and
2409 /// general information about the output that is to the counterparty in the commitment
2411 fn check_spend_counterparty_transaction<L: Deref>(&mut self, tx: &Transaction, height: u32, block_hash: &BlockHash, logger: &L)
2412 -> (Vec<PackageTemplate>, TransactionOutputs, CommitmentTxCounterpartyOutputInfo)
2413 where L::Target: Logger {
2414 // Most secp and related errors trying to create keys means we have no hope of constructing
2415 // a spend transaction...so we return no transactions to broadcast
2416 let mut claimable_outpoints = Vec::new();
2417 let mut watch_outputs = Vec::new();
2418 let mut to_counterparty_output_info = None;
2420 let commitment_txid = tx.txid(); //TODO: This is gonna be a performance bottleneck for watchtowers!
2421 let per_commitment_option = self.counterparty_claimable_outpoints.get(&commitment_txid);
2423 macro_rules! ignore_error {
2424 ( $thing : expr ) => {
2427 Err(_) => return (claimable_outpoints, (commitment_txid, watch_outputs), to_counterparty_output_info)
2432 let commitment_number = 0xffffffffffff - ((((tx.input[0].sequence.0 as u64 & 0xffffff) << 3*8) | (tx.lock_time.0 as u64 & 0xffffff)) ^ self.commitment_transaction_number_obscure_factor);
2433 if commitment_number >= self.get_min_seen_secret() {
2434 let secret = self.get_secret(commitment_number).unwrap();
2435 let per_commitment_key = ignore_error!(SecretKey::from_slice(&secret));
2436 let per_commitment_point = PublicKey::from_secret_key(&self.secp_ctx, &per_commitment_key);
2437 let revocation_pubkey = ignore_error!(chan_utils::derive_public_revocation_key(&self.secp_ctx, &per_commitment_point, &self.holder_revocation_basepoint));
2438 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_commitment_params.counterparty_delayed_payment_base_key));
2440 let revokeable_redeemscript = chan_utils::get_revokeable_redeemscript(&revocation_pubkey, self.counterparty_commitment_params.on_counterparty_tx_csv, &delayed_key);
2441 let revokeable_p2wsh = revokeable_redeemscript.to_v0_p2wsh();
2443 // First, process non-htlc outputs (to_holder & to_counterparty)
2444 for (idx, outp) in tx.output.iter().enumerate() {
2445 if outp.script_pubkey == revokeable_p2wsh {
2446 let revk_outp = RevokedOutput::build(per_commitment_point, self.counterparty_commitment_params.counterparty_delayed_payment_base_key, self.counterparty_commitment_params.counterparty_htlc_base_key, per_commitment_key, outp.value, self.counterparty_commitment_params.on_counterparty_tx_csv);
2447 let justice_package = PackageTemplate::build_package(commitment_txid, idx as u32, PackageSolvingData::RevokedOutput(revk_outp), height + self.counterparty_commitment_params.on_counterparty_tx_csv as u32, true, height);
2448 claimable_outpoints.push(justice_package);
2449 to_counterparty_output_info =
2450 Some((idx.try_into().expect("Txn can't have more than 2^32 outputs"), outp.value));
2454 // Then, try to find revoked htlc outputs
2455 if let Some(ref per_commitment_data) = per_commitment_option {
2456 for (_, &(ref htlc, _)) in per_commitment_data.iter().enumerate() {
2457 if let Some(transaction_output_index) = htlc.transaction_output_index {
2458 if transaction_output_index as usize >= tx.output.len() ||
2459 tx.output[transaction_output_index as usize].value != htlc.amount_msat / 1000 {
2460 // per_commitment_data is corrupt or our commitment signing key leaked!
2461 return (claimable_outpoints, (commitment_txid, watch_outputs),
2462 to_counterparty_output_info);
2464 let revk_htlc_outp = RevokedHTLCOutput::build(per_commitment_point, self.counterparty_commitment_params.counterparty_delayed_payment_base_key, self.counterparty_commitment_params.counterparty_htlc_base_key, per_commitment_key, htlc.amount_msat / 1000, htlc.clone(), self.onchain_tx_handler.channel_transaction_parameters.opt_anchors.is_some());
2465 let justice_package = PackageTemplate::build_package(commitment_txid, transaction_output_index, PackageSolvingData::RevokedHTLCOutput(revk_htlc_outp), htlc.cltv_expiry, true, height);
2466 claimable_outpoints.push(justice_package);
2471 // Last, track onchain revoked commitment transaction and fail backward outgoing HTLCs as payment path is broken
2472 if !claimable_outpoints.is_empty() || per_commitment_option.is_some() { // ie we're confident this is actually ours
2473 // We're definitely a counterparty commitment transaction!
2474 log_error!(logger, "Got broadcast of revoked counterparty commitment transaction, going to generate general spend tx with {} inputs", claimable_outpoints.len());
2475 for (idx, outp) in tx.output.iter().enumerate() {
2476 watch_outputs.push((idx as u32, outp.clone()));
2478 self.counterparty_commitment_txn_on_chain.insert(commitment_txid, commitment_number);
2480 if let Some(per_commitment_data) = per_commitment_option {
2481 fail_unbroadcast_htlcs!(self, "revoked_counterparty", commitment_txid, tx, height,
2482 block_hash, per_commitment_data.iter().map(|(htlc, htlc_source)|
2483 (htlc, htlc_source.as_ref().map(|htlc_source| htlc_source.as_ref()))
2486 debug_assert!(false, "We should have per-commitment option for any recognized old commitment txn");
2487 fail_unbroadcast_htlcs!(self, "revoked counterparty", commitment_txid, tx, height,
2488 block_hash, [].iter().map(|reference| *reference), logger);
2491 } else if let Some(per_commitment_data) = per_commitment_option {
2492 // While this isn't useful yet, there is a potential race where if a counterparty
2493 // revokes a state at the same time as the commitment transaction for that state is
2494 // confirmed, and the watchtower receives the block before the user, the user could
2495 // upload a new ChannelMonitor with the revocation secret but the watchtower has
2496 // already processed the block, resulting in the counterparty_commitment_txn_on_chain entry
2497 // not being generated by the above conditional. Thus, to be safe, we go ahead and
2499 for (idx, outp) in tx.output.iter().enumerate() {
2500 watch_outputs.push((idx as u32, outp.clone()));
2502 self.counterparty_commitment_txn_on_chain.insert(commitment_txid, commitment_number);
2504 log_info!(logger, "Got broadcast of non-revoked counterparty commitment transaction {}", commitment_txid);
2505 fail_unbroadcast_htlcs!(self, "counterparty", commitment_txid, tx, height, block_hash,
2506 per_commitment_data.iter().map(|(htlc, htlc_source)|
2507 (htlc, htlc_source.as_ref().map(|htlc_source| htlc_source.as_ref()))
2510 let (htlc_claim_reqs, counterparty_output_info) =
2511 self.get_counterparty_output_claim_info(commitment_number, commitment_txid, Some(tx));
2512 to_counterparty_output_info = counterparty_output_info;
2513 for req in htlc_claim_reqs {
2514 claimable_outpoints.push(req);
2518 (claimable_outpoints, (commitment_txid, watch_outputs), to_counterparty_output_info)
2521 /// Returns the HTLC claim package templates and the counterparty output info
2522 fn get_counterparty_output_claim_info(&self, commitment_number: u64, commitment_txid: Txid, tx: Option<&Transaction>)
2523 -> (Vec<PackageTemplate>, CommitmentTxCounterpartyOutputInfo) {
2524 let mut claimable_outpoints = Vec::new();
2525 let mut to_counterparty_output_info: CommitmentTxCounterpartyOutputInfo = None;
2527 let htlc_outputs = match self.counterparty_claimable_outpoints.get(&commitment_txid) {
2528 Some(outputs) => outputs,
2529 None => return (claimable_outpoints, to_counterparty_output_info),
2531 let per_commitment_points = match self.their_cur_per_commitment_points {
2532 Some(points) => points,
2533 None => return (claimable_outpoints, to_counterparty_output_info),
2536 let per_commitment_point =
2537 // If the counterparty commitment tx is the latest valid state, use their latest
2538 // per-commitment point
2539 if per_commitment_points.0 == commitment_number { &per_commitment_points.1 }
2540 else if let Some(point) = per_commitment_points.2.as_ref() {
2541 // If counterparty commitment tx is the state previous to the latest valid state, use
2542 // their previous per-commitment point (non-atomicity of revocation means it's valid for
2543 // them to temporarily have two valid commitment txns from our viewpoint)
2544 if per_commitment_points.0 == commitment_number + 1 {
2546 } else { return (claimable_outpoints, to_counterparty_output_info); }
2547 } else { return (claimable_outpoints, to_counterparty_output_info); };
2549 if let Some(transaction) = tx {
2550 let revokeable_p2wsh_opt =
2551 if let Ok(revocation_pubkey) = chan_utils::derive_public_revocation_key(
2552 &self.secp_ctx, &per_commitment_point, &self.holder_revocation_basepoint)
2554 if let Ok(delayed_key) = chan_utils::derive_public_key(&self.secp_ctx,
2555 &per_commitment_point,
2556 &self.counterparty_commitment_params.counterparty_delayed_payment_base_key)
2558 Some(chan_utils::get_revokeable_redeemscript(&revocation_pubkey,
2559 self.counterparty_commitment_params.on_counterparty_tx_csv,
2560 &delayed_key).to_v0_p2wsh())
2562 debug_assert!(false, "Failed to derive a delayed payment key for a commitment state we accepted");
2566 debug_assert!(false, "Failed to derive a revocation pubkey key for a commitment state we accepted");
2569 if let Some(revokeable_p2wsh) = revokeable_p2wsh_opt {
2570 for (idx, outp) in transaction.output.iter().enumerate() {
2571 if outp.script_pubkey == revokeable_p2wsh {
2572 to_counterparty_output_info =
2573 Some((idx.try_into().expect("Can't have > 2^32 outputs"), outp.value));
2579 for (_, &(ref htlc, _)) in htlc_outputs.iter().enumerate() {
2580 if let Some(transaction_output_index) = htlc.transaction_output_index {
2581 if let Some(transaction) = tx {
2582 if transaction_output_index as usize >= transaction.output.len() ||
2583 transaction.output[transaction_output_index as usize].value != htlc.amount_msat / 1000 {
2584 // per_commitment_data is corrupt or our commitment signing key leaked!
2585 return (claimable_outpoints, to_counterparty_output_info);
2588 let preimage = if htlc.offered { if let Some(p) = self.payment_preimages.get(&htlc.payment_hash) { Some(*p) } else { None } } else { None };
2589 if preimage.is_some() || !htlc.offered {
2590 let counterparty_htlc_outp = if htlc.offered {
2591 PackageSolvingData::CounterpartyOfferedHTLCOutput(
2592 CounterpartyOfferedHTLCOutput::build(*per_commitment_point,
2593 self.counterparty_commitment_params.counterparty_delayed_payment_base_key,
2594 self.counterparty_commitment_params.counterparty_htlc_base_key,
2595 preimage.unwrap(), htlc.clone(), self.onchain_tx_handler.opt_anchors()))
2597 PackageSolvingData::CounterpartyReceivedHTLCOutput(
2598 CounterpartyReceivedHTLCOutput::build(*per_commitment_point,
2599 self.counterparty_commitment_params.counterparty_delayed_payment_base_key,
2600 self.counterparty_commitment_params.counterparty_htlc_base_key,
2601 htlc.clone(), self.onchain_tx_handler.opt_anchors()))
2603 let aggregation = if !htlc.offered { false } else { true };
2604 let counterparty_package = PackageTemplate::build_package(commitment_txid, transaction_output_index, counterparty_htlc_outp, htlc.cltv_expiry,aggregation, 0);
2605 claimable_outpoints.push(counterparty_package);
2610 (claimable_outpoints, to_counterparty_output_info)
2613 /// Attempts to claim a counterparty HTLC-Success/HTLC-Timeout's outputs using the revocation key
2614 fn check_spend_counterparty_htlc<L: Deref>(&mut self, tx: &Transaction, commitment_number: u64, height: u32, logger: &L) -> (Vec<PackageTemplate>, Option<TransactionOutputs>) where L::Target: Logger {
2615 let htlc_txid = tx.txid();
2616 if tx.input.len() != 1 || tx.output.len() != 1 || tx.input[0].witness.len() != 5 {
2617 return (Vec::new(), None)
2620 macro_rules! ignore_error {
2621 ( $thing : expr ) => {
2624 Err(_) => return (Vec::new(), None)
2629 let secret = if let Some(secret) = self.get_secret(commitment_number) { secret } else { return (Vec::new(), None); };
2630 let per_commitment_key = ignore_error!(SecretKey::from_slice(&secret));
2631 let per_commitment_point = PublicKey::from_secret_key(&self.secp_ctx, &per_commitment_key);
2633 log_error!(logger, "Got broadcast of revoked counterparty HTLC transaction, spending {}:{}", htlc_txid, 0);
2634 let revk_outp = RevokedOutput::build(per_commitment_point, self.counterparty_commitment_params.counterparty_delayed_payment_base_key, self.counterparty_commitment_params.counterparty_htlc_base_key, per_commitment_key, tx.output[0].value, self.counterparty_commitment_params.on_counterparty_tx_csv);
2635 let justice_package = PackageTemplate::build_package(htlc_txid, 0, PackageSolvingData::RevokedOutput(revk_outp), height + self.counterparty_commitment_params.on_counterparty_tx_csv as u32, true, height);
2636 let claimable_outpoints = vec!(justice_package);
2637 let outputs = vec![(0, tx.output[0].clone())];
2638 (claimable_outpoints, Some((htlc_txid, outputs)))
2641 // Returns (1) `PackageTemplate`s that can be given to the OnchainTxHandler, so that the handler can
2642 // broadcast transactions claiming holder HTLC commitment outputs and (2) a holder revokable
2643 // script so we can detect whether a holder transaction has been seen on-chain.
2644 fn get_broadcasted_holder_claims(&self, holder_tx: &HolderSignedTx, conf_height: u32) -> (Vec<PackageTemplate>, Option<(Script, PublicKey, PublicKey)>) {
2645 let mut claim_requests = Vec::with_capacity(holder_tx.htlc_outputs.len());
2647 let redeemscript = chan_utils::get_revokeable_redeemscript(&holder_tx.revocation_key, self.on_holder_tx_csv, &holder_tx.delayed_payment_key);
2648 let broadcasted_holder_revokable_script = Some((redeemscript.to_v0_p2wsh(), holder_tx.per_commitment_point.clone(), holder_tx.revocation_key.clone()));
2650 for &(ref htlc, _, _) in holder_tx.htlc_outputs.iter() {
2651 if let Some(transaction_output_index) = htlc.transaction_output_index {
2652 let htlc_output = if htlc.offered {
2653 HolderHTLCOutput::build_offered(htlc.amount_msat, htlc.cltv_expiry)
2655 let payment_preimage = if let Some(preimage) = self.payment_preimages.get(&htlc.payment_hash) {
2658 // We can't build an HTLC-Success transaction without the preimage
2661 HolderHTLCOutput::build_accepted(payment_preimage, htlc.amount_msat)
2663 let htlc_package = PackageTemplate::build_package(holder_tx.txid, transaction_output_index, PackageSolvingData::HolderHTLCOutput(htlc_output), htlc.cltv_expiry, false, conf_height);
2664 claim_requests.push(htlc_package);
2668 (claim_requests, broadcasted_holder_revokable_script)
2671 // Returns holder HTLC outputs to watch and react to in case of spending.
2672 fn get_broadcasted_holder_watch_outputs(&self, holder_tx: &HolderSignedTx, commitment_tx: &Transaction) -> Vec<(u32, TxOut)> {
2673 let mut watch_outputs = Vec::with_capacity(holder_tx.htlc_outputs.len());
2674 for &(ref htlc, _, _) in holder_tx.htlc_outputs.iter() {
2675 if let Some(transaction_output_index) = htlc.transaction_output_index {
2676 watch_outputs.push((transaction_output_index, commitment_tx.output[transaction_output_index as usize].clone()));
2682 /// Attempts to claim any claimable HTLCs in a commitment transaction which was not (yet)
2683 /// revoked using data in holder_claimable_outpoints.
2684 /// Should not be used if check_spend_revoked_transaction succeeds.
2685 /// Returns None unless the transaction is definitely one of our commitment transactions.
2686 fn check_spend_holder_transaction<L: Deref>(&mut self, tx: &Transaction, height: u32, block_hash: &BlockHash, logger: &L) -> Option<(Vec<PackageTemplate>, TransactionOutputs)> where L::Target: Logger {
2687 let commitment_txid = tx.txid();
2688 let mut claim_requests = Vec::new();
2689 let mut watch_outputs = Vec::new();
2691 macro_rules! append_onchain_update {
2692 ($updates: expr, $to_watch: expr) => {
2693 claim_requests = $updates.0;
2694 self.broadcasted_holder_revokable_script = $updates.1;
2695 watch_outputs.append(&mut $to_watch);
2699 // HTLCs set may differ between last and previous holder commitment txn, in case of one them hitting chain, ensure we cancel all HTLCs backward
2700 let mut is_holder_tx = false;
2702 if self.current_holder_commitment_tx.txid == commitment_txid {
2703 is_holder_tx = true;
2704 log_info!(logger, "Got broadcast of latest holder commitment tx {}, searching for available HTLCs to claim", commitment_txid);
2705 let res = self.get_broadcasted_holder_claims(&self.current_holder_commitment_tx, height);
2706 let mut to_watch = self.get_broadcasted_holder_watch_outputs(&self.current_holder_commitment_tx, tx);
2707 append_onchain_update!(res, to_watch);
2708 fail_unbroadcast_htlcs!(self, "latest holder", commitment_txid, tx, height,
2709 block_hash, self.current_holder_commitment_tx.htlc_outputs.iter()
2710 .map(|(htlc, _, htlc_source)| (htlc, htlc_source.as_ref())), logger);
2711 } else if let &Some(ref holder_tx) = &self.prev_holder_signed_commitment_tx {
2712 if holder_tx.txid == commitment_txid {
2713 is_holder_tx = true;
2714 log_info!(logger, "Got broadcast of previous holder commitment tx {}, searching for available HTLCs to claim", commitment_txid);
2715 let res = self.get_broadcasted_holder_claims(holder_tx, height);
2716 let mut to_watch = self.get_broadcasted_holder_watch_outputs(holder_tx, tx);
2717 append_onchain_update!(res, to_watch);
2718 fail_unbroadcast_htlcs!(self, "previous holder", commitment_txid, tx, height, block_hash,
2719 holder_tx.htlc_outputs.iter().map(|(htlc, _, htlc_source)| (htlc, htlc_source.as_ref())),
2725 Some((claim_requests, (commitment_txid, watch_outputs)))
2731 pub fn get_latest_holder_commitment_txn<L: Deref>(&mut self, logger: &L) -> Vec<Transaction> where L::Target: Logger {
2732 log_debug!(logger, "Getting signed latest holder commitment transaction!");
2733 self.holder_tx_signed = true;
2734 let commitment_tx = self.onchain_tx_handler.get_fully_signed_holder_tx(&self.funding_redeemscript);
2735 let txid = commitment_tx.txid();
2736 let mut holder_transactions = vec![commitment_tx];
2737 // When anchor outputs are present, the HTLC transactions are only valid once the commitment
2738 // transaction confirms.
2739 if self.onchain_tx_handler.opt_anchors() {
2740 return holder_transactions;
2742 for htlc in self.current_holder_commitment_tx.htlc_outputs.iter() {
2743 if let Some(vout) = htlc.0.transaction_output_index {
2744 let preimage = if !htlc.0.offered {
2745 if let Some(preimage) = self.payment_preimages.get(&htlc.0.payment_hash) { Some(preimage.clone()) } else {
2746 // We can't build an HTLC-Success transaction without the preimage
2749 } else if htlc.0.cltv_expiry > self.best_block.height() + 1 {
2750 // Don't broadcast HTLC-Timeout transactions immediately as they don't meet the
2751 // current locktime requirements on-chain. We will broadcast them in
2752 // `block_confirmed` when `should_broadcast_holder_commitment_txn` returns true.
2753 // Note that we add + 1 as transactions are broadcastable when they can be
2754 // confirmed in the next block.
2757 if let Some(htlc_tx) = self.onchain_tx_handler.get_fully_signed_htlc_tx(
2758 &::bitcoin::OutPoint { txid, vout }, &preimage) {
2759 holder_transactions.push(htlc_tx);
2763 // 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.
2764 // The data will be re-generated and tracked in check_spend_holder_transaction if we get a confirmation.
2768 #[cfg(any(test,feature = "unsafe_revoked_tx_signing"))]
2769 /// Note that this includes possibly-locktimed-in-the-future transactions!
2770 fn unsafe_get_latest_holder_commitment_txn<L: Deref>(&mut self, logger: &L) -> Vec<Transaction> where L::Target: Logger {
2771 log_debug!(logger, "Getting signed copy of latest holder commitment transaction!");
2772 let commitment_tx = self.onchain_tx_handler.get_fully_signed_copy_holder_tx(&self.funding_redeemscript);
2773 let txid = commitment_tx.txid();
2774 let mut holder_transactions = vec![commitment_tx];
2775 // When anchor outputs are present, the HTLC transactions are only final once the commitment
2776 // transaction confirms due to the CSV 1 encumberance.
2777 if self.onchain_tx_handler.opt_anchors() {
2778 return holder_transactions;
2780 for htlc in self.current_holder_commitment_tx.htlc_outputs.iter() {
2781 if let Some(vout) = htlc.0.transaction_output_index {
2782 let preimage = if !htlc.0.offered {
2783 if let Some(preimage) = self.payment_preimages.get(&htlc.0.payment_hash) { Some(preimage.clone()) } else {
2784 // We can't build an HTLC-Success transaction without the preimage
2788 if let Some(htlc_tx) = self.onchain_tx_handler.unsafe_get_fully_signed_htlc_tx(
2789 &::bitcoin::OutPoint { txid, vout }, &preimage) {
2790 holder_transactions.push(htlc_tx);
2797 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>
2798 where B::Target: BroadcasterInterface,
2799 F::Target: FeeEstimator,
2802 let block_hash = header.block_hash();
2803 self.best_block = BestBlock::new(block_hash, height);
2805 let bounded_fee_estimator = LowerBoundedFeeEstimator::new(fee_estimator);
2806 self.transactions_confirmed(header, txdata, height, broadcaster, &bounded_fee_estimator, logger)
2809 fn best_block_updated<B: Deref, F: Deref, L: Deref>(
2811 header: &BlockHeader,
2814 fee_estimator: &LowerBoundedFeeEstimator<F>,
2816 ) -> Vec<TransactionOutputs>
2818 B::Target: BroadcasterInterface,
2819 F::Target: FeeEstimator,
2822 let block_hash = header.block_hash();
2824 if height > self.best_block.height() {
2825 self.best_block = BestBlock::new(block_hash, height);
2826 self.block_confirmed(height, block_hash, vec![], vec![], vec![], &broadcaster, &fee_estimator, &logger)
2827 } else if block_hash != self.best_block.block_hash() {
2828 self.best_block = BestBlock::new(block_hash, height);
2829 self.onchain_events_awaiting_threshold_conf.retain(|ref entry| entry.height <= height);
2830 self.onchain_tx_handler.block_disconnected(height + 1, broadcaster, fee_estimator, logger);
2832 } else { Vec::new() }
2835 fn transactions_confirmed<B: Deref, F: Deref, L: Deref>(
2837 header: &BlockHeader,
2838 txdata: &TransactionData,
2841 fee_estimator: &LowerBoundedFeeEstimator<F>,
2843 ) -> Vec<TransactionOutputs>
2845 B::Target: BroadcasterInterface,
2846 F::Target: FeeEstimator,
2849 let txn_matched = self.filter_block(txdata);
2850 for tx in &txn_matched {
2851 let mut output_val = 0;
2852 for out in tx.output.iter() {
2853 if out.value > 21_000_000_0000_0000 { panic!("Value-overflowing transaction provided to block connected"); }
2854 output_val += out.value;
2855 if output_val > 21_000_000_0000_0000 { panic!("Value-overflowing transaction provided to block connected"); }
2859 let block_hash = header.block_hash();
2861 let mut watch_outputs = Vec::new();
2862 let mut claimable_outpoints = Vec::new();
2863 for tx in &txn_matched {
2864 if tx.input.len() == 1 {
2865 // Assuming our keys were not leaked (in which case we're screwed no matter what),
2866 // commitment transactions and HTLC transactions will all only ever have one input,
2867 // which is an easy way to filter out any potential non-matching txn for lazy
2869 let prevout = &tx.input[0].previous_output;
2870 if prevout.txid == self.funding_info.0.txid && prevout.vout == self.funding_info.0.index as u32 {
2871 let mut balance_spendable_csv = None;
2872 log_info!(logger, "Channel {} closed by funding output spend in txid {}.",
2873 log_bytes!(self.funding_info.0.to_channel_id()), tx.txid());
2874 self.funding_spend_seen = true;
2875 let mut commitment_tx_to_counterparty_output = None;
2876 if (tx.input[0].sequence.0 >> 8*3) as u8 == 0x80 && (tx.lock_time.0 >> 8*3) as u8 == 0x20 {
2877 let (mut new_outpoints, new_outputs, counterparty_output_idx_sats) =
2878 self.check_spend_counterparty_transaction(&tx, height, &block_hash, &logger);
2879 commitment_tx_to_counterparty_output = counterparty_output_idx_sats;
2880 if !new_outputs.1.is_empty() {
2881 watch_outputs.push(new_outputs);
2883 claimable_outpoints.append(&mut new_outpoints);
2884 if new_outpoints.is_empty() {
2885 if let Some((mut new_outpoints, new_outputs)) = self.check_spend_holder_transaction(&tx, height, &block_hash, &logger) {
2886 debug_assert!(commitment_tx_to_counterparty_output.is_none(),
2887 "A commitment transaction matched as both a counterparty and local commitment tx?");
2888 if !new_outputs.1.is_empty() {
2889 watch_outputs.push(new_outputs);
2891 claimable_outpoints.append(&mut new_outpoints);
2892 balance_spendable_csv = Some(self.on_holder_tx_csv);
2896 let txid = tx.txid();
2897 self.onchain_events_awaiting_threshold_conf.push(OnchainEventEntry {
2899 transaction: Some((*tx).clone()),
2901 block_hash: Some(block_hash),
2902 event: OnchainEvent::FundingSpendConfirmation {
2903 on_local_output_csv: balance_spendable_csv,
2904 commitment_tx_to_counterparty_output,
2908 if let Some(&commitment_number) = self.counterparty_commitment_txn_on_chain.get(&prevout.txid) {
2909 let (mut new_outpoints, new_outputs_option) = self.check_spend_counterparty_htlc(&tx, commitment_number, height, &logger);
2910 claimable_outpoints.append(&mut new_outpoints);
2911 if let Some(new_outputs) = new_outputs_option {
2912 watch_outputs.push(new_outputs);
2917 // While all commitment/HTLC-Success/HTLC-Timeout transactions have one input, HTLCs
2918 // can also be resolved in a few other ways which can have more than one output. Thus,
2919 // we call is_resolving_htlc_output here outside of the tx.input.len() == 1 check.
2920 self.is_resolving_htlc_output(&tx, height, &block_hash, &logger);
2922 self.is_paying_spendable_output(&tx, height, &block_hash, &logger);
2925 if height > self.best_block.height() {
2926 self.best_block = BestBlock::new(block_hash, height);
2929 self.block_confirmed(height, block_hash, txn_matched, watch_outputs, claimable_outpoints, &broadcaster, &fee_estimator, &logger)
2932 /// Update state for new block(s)/transaction(s) confirmed. Note that the caller must update
2933 /// `self.best_block` before calling if a new best blockchain tip is available. More
2934 /// concretely, `self.best_block` must never be at a lower height than `conf_height`, avoiding
2935 /// complexity especially in
2936 /// `OnchainTx::update_claims_view_from_requests`/`OnchainTx::update_claims_view_from_matched_txn`.
2938 /// `conf_height` should be set to the height at which any new transaction(s)/block(s) were
2939 /// confirmed at, even if it is not the current best height.
2940 fn block_confirmed<B: Deref, F: Deref, L: Deref>(
2943 conf_hash: BlockHash,
2944 txn_matched: Vec<&Transaction>,
2945 mut watch_outputs: Vec<TransactionOutputs>,
2946 mut claimable_outpoints: Vec<PackageTemplate>,
2948 fee_estimator: &LowerBoundedFeeEstimator<F>,
2950 ) -> Vec<TransactionOutputs>
2952 B::Target: BroadcasterInterface,
2953 F::Target: FeeEstimator,
2956 log_trace!(logger, "Processing {} matched transactions for block at height {}.", txn_matched.len(), conf_height);
2957 debug_assert!(self.best_block.height() >= conf_height);
2959 let should_broadcast = self.should_broadcast_holder_commitment_txn(logger);
2960 if should_broadcast {
2961 let funding_outp = HolderFundingOutput::build(self.funding_redeemscript.clone(), self.channel_value_satoshis, self.onchain_tx_handler.opt_anchors());
2962 let commitment_package = PackageTemplate::build_package(self.funding_info.0.txid.clone(), self.funding_info.0.index as u32, PackageSolvingData::HolderFundingOutput(funding_outp), self.best_block.height(), false, self.best_block.height());
2963 claimable_outpoints.push(commitment_package);
2964 self.pending_monitor_events.push(MonitorEvent::CommitmentTxConfirmed(self.funding_info.0));
2965 let commitment_tx = self.onchain_tx_handler.get_fully_signed_holder_tx(&self.funding_redeemscript);
2966 self.holder_tx_signed = true;
2967 // We can't broadcast our HTLC transactions while the commitment transaction is
2968 // unconfirmed. We'll delay doing so until we detect the confirmed commitment in
2969 // `transactions_confirmed`.
2970 if !self.onchain_tx_handler.opt_anchors() {
2971 // Because we're broadcasting a commitment transaction, we should construct the package
2972 // assuming it gets confirmed in the next block. Sadly, we have code which considers
2973 // "not yet confirmed" things as discardable, so we cannot do that here.
2974 let (mut new_outpoints, _) = self.get_broadcasted_holder_claims(&self.current_holder_commitment_tx, self.best_block.height());
2975 let new_outputs = self.get_broadcasted_holder_watch_outputs(&self.current_holder_commitment_tx, &commitment_tx);
2976 if !new_outputs.is_empty() {
2977 watch_outputs.push((self.current_holder_commitment_tx.txid.clone(), new_outputs));
2979 claimable_outpoints.append(&mut new_outpoints);
2983 // Find which on-chain events have reached their confirmation threshold.
2984 let onchain_events_awaiting_threshold_conf =
2985 self.onchain_events_awaiting_threshold_conf.drain(..).collect::<Vec<_>>();
2986 let mut onchain_events_reaching_threshold_conf = Vec::new();
2987 for entry in onchain_events_awaiting_threshold_conf {
2988 if entry.has_reached_confirmation_threshold(&self.best_block) {
2989 onchain_events_reaching_threshold_conf.push(entry);
2991 self.onchain_events_awaiting_threshold_conf.push(entry);
2995 // Used to check for duplicate HTLC resolutions.
2996 #[cfg(debug_assertions)]
2997 let unmatured_htlcs: Vec<_> = self.onchain_events_awaiting_threshold_conf
2999 .filter_map(|entry| match &entry.event {
3000 OnchainEvent::HTLCUpdate { source, .. } => Some(source),
3004 #[cfg(debug_assertions)]
3005 let mut matured_htlcs = Vec::new();
3007 // Produce actionable events from on-chain events having reached their threshold.
3008 for entry in onchain_events_reaching_threshold_conf.drain(..) {
3010 OnchainEvent::HTLCUpdate { ref source, payment_hash, htlc_value_satoshis, commitment_tx_output_idx } => {
3011 // Check for duplicate HTLC resolutions.
3012 #[cfg(debug_assertions)]
3015 unmatured_htlcs.iter().find(|&htlc| htlc == &source).is_none(),
3016 "An unmature HTLC transaction conflicts with a maturing one; failed to \
3017 call either transaction_unconfirmed for the conflicting transaction \
3018 or block_disconnected for a block containing it.");
3020 matured_htlcs.iter().find(|&htlc| htlc == source).is_none(),
3021 "A matured HTLC transaction conflicts with a maturing one; failed to \
3022 call either transaction_unconfirmed for the conflicting transaction \
3023 or block_disconnected for a block containing it.");
3024 matured_htlcs.push(source.clone());
3027 log_debug!(logger, "HTLC {} failure update in {} has got enough confirmations to be passed upstream",
3028 log_bytes!(payment_hash.0), entry.txid);
3029 self.pending_monitor_events.push(MonitorEvent::HTLCEvent(HTLCUpdate {
3031 payment_preimage: None,
3032 source: source.clone(),
3033 htlc_value_satoshis,
3035 self.htlcs_resolved_on_chain.push(IrrevocablyResolvedHTLC {
3036 commitment_tx_output_idx, resolving_txid: Some(entry.txid),
3037 payment_preimage: None,
3040 OnchainEvent::MaturingOutput { descriptor } => {
3041 log_debug!(logger, "Descriptor {} has got enough confirmations to be passed upstream", log_spendable!(descriptor));
3042 self.pending_events.push(Event::SpendableOutputs {
3043 outputs: vec![descriptor]
3046 OnchainEvent::HTLCSpendConfirmation { commitment_tx_output_idx, preimage, .. } => {
3047 self.htlcs_resolved_on_chain.push(IrrevocablyResolvedHTLC {
3048 commitment_tx_output_idx: Some(commitment_tx_output_idx), resolving_txid: Some(entry.txid),
3049 payment_preimage: preimage,
3052 OnchainEvent::FundingSpendConfirmation { commitment_tx_to_counterparty_output, .. } => {
3053 self.funding_spend_confirmed = Some(entry.txid);
3054 self.confirmed_commitment_tx_counterparty_output = commitment_tx_to_counterparty_output;
3059 self.onchain_tx_handler.update_claims_view_from_requests(claimable_outpoints, conf_height, self.best_block.height(), broadcaster, fee_estimator, logger);
3060 self.onchain_tx_handler.update_claims_view_from_matched_txn(&txn_matched, conf_height, conf_hash, self.best_block.height(), broadcaster, fee_estimator, logger);
3062 // Determine new outputs to watch by comparing against previously known outputs to watch,
3063 // updating the latter in the process.
3064 watch_outputs.retain(|&(ref txid, ref txouts)| {
3065 let idx_and_scripts = txouts.iter().map(|o| (o.0, o.1.script_pubkey.clone())).collect();
3066 self.outputs_to_watch.insert(txid.clone(), idx_and_scripts).is_none()
3070 // If we see a transaction for which we registered outputs previously,
3071 // make sure the registered scriptpubkey at the expected index match
3072 // the actual transaction output one. We failed this case before #653.
3073 for tx in &txn_matched {
3074 if let Some(outputs) = self.get_outputs_to_watch().get(&tx.txid()) {
3075 for idx_and_script in outputs.iter() {
3076 assert!((idx_and_script.0 as usize) < tx.output.len());
3077 assert_eq!(tx.output[idx_and_script.0 as usize].script_pubkey, idx_and_script.1);
3085 pub fn block_disconnected<B: Deref, F: Deref, L: Deref>(&mut self, header: &BlockHeader, height: u32, broadcaster: B, fee_estimator: F, logger: L)
3086 where B::Target: BroadcasterInterface,
3087 F::Target: FeeEstimator,
3090 log_trace!(logger, "Block {} at height {} disconnected", header.block_hash(), height);
3093 //- htlc update there as failure-trigger tx (revoked commitment tx, non-revoked commitment tx, HTLC-timeout tx) has been disconnected
3094 //- maturing spendable output has transaction paying us has been disconnected
3095 self.onchain_events_awaiting_threshold_conf.retain(|ref entry| entry.height < height);
3097 let bounded_fee_estimator = LowerBoundedFeeEstimator::new(fee_estimator);
3098 self.onchain_tx_handler.block_disconnected(height, broadcaster, &bounded_fee_estimator, logger);
3100 self.best_block = BestBlock::new(header.prev_blockhash, height - 1);
3103 fn transaction_unconfirmed<B: Deref, F: Deref, L: Deref>(
3107 fee_estimator: &LowerBoundedFeeEstimator<F>,
3110 B::Target: BroadcasterInterface,
3111 F::Target: FeeEstimator,
3114 self.onchain_events_awaiting_threshold_conf.retain(|ref entry| if entry.txid == *txid {
3115 log_info!(logger, "Removing onchain event with txid {}", txid);
3118 self.onchain_tx_handler.transaction_unconfirmed(txid, broadcaster, fee_estimator, logger);
3121 /// Filters a block's `txdata` for transactions spending watched outputs or for any child
3122 /// transactions thereof.
3123 fn filter_block<'a>(&self, txdata: &TransactionData<'a>) -> Vec<&'a Transaction> {
3124 let mut matched_txn = HashSet::new();
3125 txdata.iter().filter(|&&(_, tx)| {
3126 let mut matches = self.spends_watched_output(tx);
3127 for input in tx.input.iter() {
3128 if matches { break; }
3129 if matched_txn.contains(&input.previous_output.txid) {
3134 matched_txn.insert(tx.txid());
3137 }).map(|(_, tx)| *tx).collect()
3140 /// Checks if a given transaction spends any watched outputs.
3141 fn spends_watched_output(&self, tx: &Transaction) -> bool {
3142 for input in tx.input.iter() {
3143 if let Some(outputs) = self.get_outputs_to_watch().get(&input.previous_output.txid) {
3144 for (idx, _script_pubkey) in outputs.iter() {
3145 if *idx == input.previous_output.vout {
3148 // If the expected script is a known type, check that the witness
3149 // appears to be spending the correct type (ie that the match would
3150 // actually succeed in BIP 158/159-style filters).
3151 if _script_pubkey.is_v0_p2wsh() {
3152 if input.witness.last().unwrap().to_vec() == deliberately_bogus_accepted_htlc_witness_program() {
3153 // In at least one test we use a deliberately bogus witness
3154 // script which hit an old panic. Thus, we check for that here
3155 // and avoid the assert if its the expected bogus script.
3159 assert_eq!(&bitcoin::Address::p2wsh(&Script::from(input.witness.last().unwrap().to_vec()), bitcoin::Network::Bitcoin).script_pubkey(), _script_pubkey);
3160 } else if _script_pubkey.is_v0_p2wpkh() {
3161 assert_eq!(&bitcoin::Address::p2wpkh(&bitcoin::PublicKey::from_slice(&input.witness.last().unwrap()).unwrap(), bitcoin::Network::Bitcoin).unwrap().script_pubkey(), _script_pubkey);
3162 } else { panic!(); }
3173 fn should_broadcast_holder_commitment_txn<L: Deref>(&self, logger: &L) -> bool where L::Target: Logger {
3174 // There's no need to broadcast our commitment transaction if we've seen one confirmed (even
3175 // with 1 confirmation) as it'll be rejected as duplicate/conflicting.
3176 if self.funding_spend_confirmed.is_some() ||
3177 self.onchain_events_awaiting_threshold_conf.iter().find(|event| match event.event {
3178 OnchainEvent::FundingSpendConfirmation { .. } => true,
3184 // We need to consider all HTLCs which are:
3185 // * in any unrevoked counterparty commitment transaction, as they could broadcast said
3186 // transactions and we'd end up in a race, or
3187 // * are in our latest holder commitment transaction, as this is the thing we will
3188 // broadcast if we go on-chain.
3189 // Note that we consider HTLCs which were below dust threshold here - while they don't
3190 // strictly imply that we need to fail the channel, we need to go ahead and fail them back
3191 // to the source, and if we don't fail the channel we will have to ensure that the next
3192 // updates that peer sends us are update_fails, failing the channel if not. It's probably
3193 // easier to just fail the channel as this case should be rare enough anyway.
3194 let height = self.best_block.height();
3195 macro_rules! scan_commitment {
3196 ($htlcs: expr, $holder_tx: expr) => {
3197 for ref htlc in $htlcs {
3198 // For inbound HTLCs which we know the preimage for, we have to ensure we hit the
3199 // chain with enough room to claim the HTLC without our counterparty being able to
3200 // time out the HTLC first.
3201 // For outbound HTLCs which our counterparty hasn't failed/claimed, our primary
3202 // concern is being able to claim the corresponding inbound HTLC (on another
3203 // channel) before it expires. In fact, we don't even really care if our
3204 // counterparty here claims such an outbound HTLC after it expired as long as we
3205 // can still claim the corresponding HTLC. Thus, to avoid needlessly hitting the
3206 // chain when our counterparty is waiting for expiration to off-chain fail an HTLC
3207 // we give ourselves a few blocks of headroom after expiration before going
3208 // on-chain for an expired HTLC.
3209 // Note that, to avoid a potential attack whereby a node delays claiming an HTLC
3210 // from us until we've reached the point where we go on-chain with the
3211 // corresponding inbound HTLC, we must ensure that outbound HTLCs go on chain at
3212 // least CLTV_CLAIM_BUFFER blocks prior to the inbound HTLC.
3213 // aka outbound_cltv + LATENCY_GRACE_PERIOD_BLOCKS == height - CLTV_CLAIM_BUFFER
3214 // inbound_cltv == height + CLTV_CLAIM_BUFFER
3215 // outbound_cltv + LATENCY_GRACE_PERIOD_BLOCKS + CLTV_CLAIM_BUFFER <= inbound_cltv - CLTV_CLAIM_BUFFER
3216 // LATENCY_GRACE_PERIOD_BLOCKS + 2*CLTV_CLAIM_BUFFER <= inbound_cltv - outbound_cltv
3217 // CLTV_EXPIRY_DELTA <= inbound_cltv - outbound_cltv (by check in ChannelManager::decode_update_add_htlc_onion)
3218 // LATENCY_GRACE_PERIOD_BLOCKS + 2*CLTV_CLAIM_BUFFER <= CLTV_EXPIRY_DELTA
3219 // The final, above, condition is checked for statically in channelmanager
3220 // with CHECK_CLTV_EXPIRY_SANITY_2.
3221 let htlc_outbound = $holder_tx == htlc.offered;
3222 if ( htlc_outbound && htlc.cltv_expiry + LATENCY_GRACE_PERIOD_BLOCKS <= height) ||
3223 (!htlc_outbound && htlc.cltv_expiry <= height + CLTV_CLAIM_BUFFER && self.payment_preimages.contains_key(&htlc.payment_hash)) {
3224 log_info!(logger, "Force-closing channel due to {} HTLC timeout, HTLC expiry is {}", if htlc_outbound { "outbound" } else { "inbound "}, htlc.cltv_expiry);
3231 scan_commitment!(self.current_holder_commitment_tx.htlc_outputs.iter().map(|&(ref a, _, _)| a), true);
3233 if let Some(ref txid) = self.current_counterparty_commitment_txid {
3234 if let Some(ref htlc_outputs) = self.counterparty_claimable_outpoints.get(txid) {
3235 scan_commitment!(htlc_outputs.iter().map(|&(ref a, _)| a), false);
3238 if let Some(ref txid) = self.prev_counterparty_commitment_txid {
3239 if let Some(ref htlc_outputs) = self.counterparty_claimable_outpoints.get(txid) {
3240 scan_commitment!(htlc_outputs.iter().map(|&(ref a, _)| a), false);
3247 /// Check if any transaction broadcasted is resolving HTLC output by a success or timeout on a holder
3248 /// or counterparty commitment tx, if so send back the source, preimage if found and payment_hash of resolved HTLC
3249 fn is_resolving_htlc_output<L: Deref>(&mut self, tx: &Transaction, height: u32, block_hash: &BlockHash, logger: &L) where L::Target: Logger {
3250 'outer_loop: for input in &tx.input {
3251 let mut payment_data = None;
3252 let htlc_claim = HTLCClaim::from_witness(&input.witness);
3253 let revocation_sig_claim = htlc_claim == Some(HTLCClaim::Revocation);
3254 let accepted_preimage_claim = htlc_claim == Some(HTLCClaim::AcceptedPreimage);
3255 #[cfg(not(fuzzing))]
3256 let accepted_timeout_claim = htlc_claim == Some(HTLCClaim::AcceptedTimeout);
3257 let offered_preimage_claim = htlc_claim == Some(HTLCClaim::OfferedPreimage);
3258 #[cfg(not(fuzzing))]
3259 let offered_timeout_claim = htlc_claim == Some(HTLCClaim::OfferedTimeout);
3261 let mut payment_preimage = PaymentPreimage([0; 32]);
3262 if offered_preimage_claim || accepted_preimage_claim {
3263 payment_preimage.0.copy_from_slice(input.witness.second_to_last().unwrap());
3266 macro_rules! log_claim {
3267 ($tx_info: expr, $holder_tx: expr, $htlc: expr, $source_avail: expr) => {
3268 let outbound_htlc = $holder_tx == $htlc.offered;
3269 // HTLCs must either be claimed by a matching script type or through the
3271 #[cfg(not(fuzzing))] // Note that the fuzzer is not bound by pesky things like "signatures"
3272 debug_assert!(!$htlc.offered || offered_preimage_claim || offered_timeout_claim || revocation_sig_claim);
3273 #[cfg(not(fuzzing))] // Note that the fuzzer is not bound by pesky things like "signatures"
3274 debug_assert!($htlc.offered || accepted_preimage_claim || accepted_timeout_claim || revocation_sig_claim);
3275 // Further, only exactly one of the possible spend paths should have been
3276 // matched by any HTLC spend:
3277 #[cfg(not(fuzzing))] // Note that the fuzzer is not bound by pesky things like "signatures"
3278 debug_assert_eq!(accepted_preimage_claim as u8 + accepted_timeout_claim as u8 +
3279 offered_preimage_claim as u8 + offered_timeout_claim as u8 +
3280 revocation_sig_claim as u8, 1);
3281 if ($holder_tx && revocation_sig_claim) ||
3282 (outbound_htlc && !$source_avail && (accepted_preimage_claim || offered_preimage_claim)) {
3283 log_error!(logger, "Input spending {} ({}:{}) in {} resolves {} HTLC with payment hash {} with {}!",
3284 $tx_info, input.previous_output.txid, input.previous_output.vout, tx.txid(),
3285 if outbound_htlc { "outbound" } else { "inbound" }, log_bytes!($htlc.payment_hash.0),
3286 if revocation_sig_claim { "revocation sig" } else { "preimage claim after we'd passed the HTLC resolution back. We can likely claim the HTLC output with a revocation claim" });
3288 log_info!(logger, "Input spending {} ({}:{}) in {} resolves {} HTLC with payment hash {} with {}",
3289 $tx_info, input.previous_output.txid, input.previous_output.vout, tx.txid(),
3290 if outbound_htlc { "outbound" } else { "inbound" }, log_bytes!($htlc.payment_hash.0),
3291 if revocation_sig_claim { "revocation sig" } else if accepted_preimage_claim || offered_preimage_claim { "preimage" } else { "timeout" });
3296 macro_rules! check_htlc_valid_counterparty {
3297 ($counterparty_txid: expr, $htlc_output: expr) => {
3298 if let Some(txid) = $counterparty_txid {
3299 for &(ref pending_htlc, ref pending_source) in self.counterparty_claimable_outpoints.get(&txid).unwrap() {
3300 if pending_htlc.payment_hash == $htlc_output.payment_hash && pending_htlc.amount_msat == $htlc_output.amount_msat {
3301 if let &Some(ref source) = pending_source {
3302 log_claim!("revoked counterparty commitment tx", false, pending_htlc, true);
3303 payment_data = Some(((**source).clone(), $htlc_output.payment_hash, $htlc_output.amount_msat));
3312 macro_rules! scan_commitment {
3313 ($htlcs: expr, $tx_info: expr, $holder_tx: expr) => {
3314 for (ref htlc_output, source_option) in $htlcs {
3315 if Some(input.previous_output.vout) == htlc_output.transaction_output_index {
3316 if let Some(ref source) = source_option {
3317 log_claim!($tx_info, $holder_tx, htlc_output, true);
3318 // We have a resolution of an HTLC either from one of our latest
3319 // holder commitment transactions or an unrevoked counterparty commitment
3320 // transaction. This implies we either learned a preimage, the HTLC
3321 // has timed out, or we screwed up. In any case, we should now
3322 // resolve the source HTLC with the original sender.
3323 payment_data = Some(((*source).clone(), htlc_output.payment_hash, htlc_output.amount_msat));
3324 } else if !$holder_tx {
3325 check_htlc_valid_counterparty!(self.current_counterparty_commitment_txid, htlc_output);
3326 if payment_data.is_none() {
3327 check_htlc_valid_counterparty!(self.prev_counterparty_commitment_txid, htlc_output);
3330 if payment_data.is_none() {
3331 log_claim!($tx_info, $holder_tx, htlc_output, false);
3332 let outbound_htlc = $holder_tx == htlc_output.offered;
3333 self.onchain_events_awaiting_threshold_conf.push(OnchainEventEntry {
3334 txid: tx.txid(), height, block_hash: Some(*block_hash), transaction: Some(tx.clone()),
3335 event: OnchainEvent::HTLCSpendConfirmation {
3336 commitment_tx_output_idx: input.previous_output.vout,
3337 preimage: if accepted_preimage_claim || offered_preimage_claim {
3338 Some(payment_preimage) } else { None },
3339 // If this is a payment to us (ie !outbound_htlc), wait for
3340 // the CSV delay before dropping the HTLC from claimable
3341 // balance if the claim was an HTLC-Success transaction (ie
3342 // accepted_preimage_claim).
3343 on_to_local_output_csv: if accepted_preimage_claim && !outbound_htlc {
3344 Some(self.on_holder_tx_csv) } else { None },
3347 continue 'outer_loop;
3354 if input.previous_output.txid == self.current_holder_commitment_tx.txid {
3355 scan_commitment!(self.current_holder_commitment_tx.htlc_outputs.iter().map(|&(ref a, _, ref b)| (a, b.as_ref())),
3356 "our latest holder commitment tx", true);
3358 if let Some(ref prev_holder_signed_commitment_tx) = self.prev_holder_signed_commitment_tx {
3359 if input.previous_output.txid == prev_holder_signed_commitment_tx.txid {
3360 scan_commitment!(prev_holder_signed_commitment_tx.htlc_outputs.iter().map(|&(ref a, _, ref b)| (a, b.as_ref())),
3361 "our previous holder commitment tx", true);
3364 if let Some(ref htlc_outputs) = self.counterparty_claimable_outpoints.get(&input.previous_output.txid) {
3365 scan_commitment!(htlc_outputs.iter().map(|&(ref a, ref b)| (a, (b.as_ref().clone()).map(|boxed| &**boxed))),
3366 "counterparty commitment tx", false);
3369 // Check that scan_commitment, above, decided there is some source worth relaying an
3370 // HTLC resolution backwards to and figure out whether we learned a preimage from it.
3371 if let Some((source, payment_hash, amount_msat)) = payment_data {
3372 if accepted_preimage_claim {
3373 if !self.pending_monitor_events.iter().any(
3374 |update| if let &MonitorEvent::HTLCEvent(ref upd) = update { upd.source == source } else { false }) {
3375 self.onchain_events_awaiting_threshold_conf.push(OnchainEventEntry {
3378 block_hash: Some(*block_hash),
3379 transaction: Some(tx.clone()),
3380 event: OnchainEvent::HTLCSpendConfirmation {
3381 commitment_tx_output_idx: input.previous_output.vout,
3382 preimage: Some(payment_preimage),
3383 on_to_local_output_csv: None,
3386 self.pending_monitor_events.push(MonitorEvent::HTLCEvent(HTLCUpdate {
3388 payment_preimage: Some(payment_preimage),
3390 htlc_value_satoshis: Some(amount_msat / 1000),
3393 } else if offered_preimage_claim {
3394 if !self.pending_monitor_events.iter().any(
3395 |update| if let &MonitorEvent::HTLCEvent(ref upd) = update {
3396 upd.source == source
3398 self.onchain_events_awaiting_threshold_conf.push(OnchainEventEntry {
3400 transaction: Some(tx.clone()),
3402 block_hash: Some(*block_hash),
3403 event: OnchainEvent::HTLCSpendConfirmation {
3404 commitment_tx_output_idx: input.previous_output.vout,
3405 preimage: Some(payment_preimage),
3406 on_to_local_output_csv: None,
3409 self.pending_monitor_events.push(MonitorEvent::HTLCEvent(HTLCUpdate {
3411 payment_preimage: Some(payment_preimage),
3413 htlc_value_satoshis: Some(amount_msat / 1000),
3417 self.onchain_events_awaiting_threshold_conf.retain(|ref entry| {
3418 if entry.height != height { return true; }
3420 OnchainEvent::HTLCUpdate { source: ref htlc_source, .. } => {
3421 *htlc_source != source
3426 let entry = OnchainEventEntry {
3428 transaction: Some(tx.clone()),
3430 block_hash: Some(*block_hash),
3431 event: OnchainEvent::HTLCUpdate {
3432 source, payment_hash,
3433 htlc_value_satoshis: Some(amount_msat / 1000),
3434 commitment_tx_output_idx: Some(input.previous_output.vout),
3437 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());
3438 self.onchain_events_awaiting_threshold_conf.push(entry);
3444 /// Check if any transaction broadcasted is paying fund back to some address we can assume to own
3445 fn is_paying_spendable_output<L: Deref>(&mut self, tx: &Transaction, height: u32, block_hash: &BlockHash, logger: &L) where L::Target: Logger {
3446 let mut spendable_output = None;
3447 for (i, outp) in tx.output.iter().enumerate() { // There is max one spendable output for any channel tx, including ones generated by us
3448 if i > ::core::u16::MAX as usize {
3449 // While it is possible that an output exists on chain which is greater than the
3450 // 2^16th output in a given transaction, this is only possible if the output is not
3451 // in a lightning transaction and was instead placed there by some third party who
3452 // wishes to give us money for no reason.
3453 // Namely, any lightning transactions which we pre-sign will never have anywhere
3454 // near 2^16 outputs both because such transactions must have ~2^16 outputs who's
3455 // scripts are not longer than one byte in length and because they are inherently
3456 // non-standard due to their size.
3457 // Thus, it is completely safe to ignore such outputs, and while it may result in
3458 // us ignoring non-lightning fund to us, that is only possible if someone fills
3459 // nearly a full block with garbage just to hit this case.
3462 if outp.script_pubkey == self.destination_script {
3463 spendable_output = Some(SpendableOutputDescriptor::StaticOutput {
3464 outpoint: OutPoint { txid: tx.txid(), index: i as u16 },
3465 output: outp.clone(),
3469 if let Some(ref broadcasted_holder_revokable_script) = self.broadcasted_holder_revokable_script {
3470 if broadcasted_holder_revokable_script.0 == outp.script_pubkey {
3471 spendable_output = Some(SpendableOutputDescriptor::DelayedPaymentOutput(DelayedPaymentOutputDescriptor {
3472 outpoint: OutPoint { txid: tx.txid(), index: i as u16 },
3473 per_commitment_point: broadcasted_holder_revokable_script.1,
3474 to_self_delay: self.on_holder_tx_csv,
3475 output: outp.clone(),
3476 revocation_pubkey: broadcasted_holder_revokable_script.2.clone(),
3477 channel_keys_id: self.channel_keys_id,
3478 channel_value_satoshis: self.channel_value_satoshis,
3483 if self.counterparty_payment_script == outp.script_pubkey {
3484 spendable_output = Some(SpendableOutputDescriptor::StaticPaymentOutput(StaticPaymentOutputDescriptor {
3485 outpoint: OutPoint { txid: tx.txid(), index: i as u16 },
3486 output: outp.clone(),
3487 channel_keys_id: self.channel_keys_id,
3488 channel_value_satoshis: self.channel_value_satoshis,
3492 if self.shutdown_script.as_ref() == Some(&outp.script_pubkey) {
3493 spendable_output = Some(SpendableOutputDescriptor::StaticOutput {
3494 outpoint: OutPoint { txid: tx.txid(), index: i as u16 },
3495 output: outp.clone(),
3500 if let Some(spendable_output) = spendable_output {
3501 let entry = OnchainEventEntry {
3503 transaction: Some(tx.clone()),
3505 block_hash: Some(*block_hash),
3506 event: OnchainEvent::MaturingOutput { descriptor: spendable_output.clone() },
3508 log_info!(logger, "Received spendable output {}, spendable at height {}", log_spendable!(spendable_output), entry.confirmation_threshold());
3509 self.onchain_events_awaiting_threshold_conf.push(entry);
3514 impl<Signer: Sign, T: Deref, F: Deref, L: Deref> chain::Listen for (ChannelMonitor<Signer>, T, F, L)
3516 T::Target: BroadcasterInterface,
3517 F::Target: FeeEstimator,
3520 fn filtered_block_connected(&self, header: &BlockHeader, txdata: &TransactionData, height: u32) {
3521 self.0.block_connected(header, txdata, height, &*self.1, &*self.2, &*self.3);
3524 fn block_disconnected(&self, header: &BlockHeader, height: u32) {
3525 self.0.block_disconnected(header, height, &*self.1, &*self.2, &*self.3);
3529 impl<Signer: Sign, T: Deref, F: Deref, L: Deref> chain::Confirm for (ChannelMonitor<Signer>, T, F, L)
3531 T::Target: BroadcasterInterface,
3532 F::Target: FeeEstimator,
3535 fn transactions_confirmed(&self, header: &BlockHeader, txdata: &TransactionData, height: u32) {
3536 self.0.transactions_confirmed(header, txdata, height, &*self.1, &*self.2, &*self.3);
3539 fn transaction_unconfirmed(&self, txid: &Txid) {
3540 self.0.transaction_unconfirmed(txid, &*self.1, &*self.2, &*self.3);
3543 fn best_block_updated(&self, header: &BlockHeader, height: u32) {
3544 self.0.best_block_updated(header, height, &*self.1, &*self.2, &*self.3);
3547 fn get_relevant_txids(&self) -> Vec<(Txid, Option<BlockHash>)> {
3548 self.0.get_relevant_txids()
3552 const MAX_ALLOC_SIZE: usize = 64*1024;
3554 impl<'a, K: KeysInterface> ReadableArgs<&'a K>
3555 for (BlockHash, ChannelMonitor<K::Signer>) {
3556 fn read<R: io::Read>(reader: &mut R, keys_manager: &'a K) -> Result<Self, DecodeError> {
3557 macro_rules! unwrap_obj {
3561 Err(_) => return Err(DecodeError::InvalidValue),
3566 let _ver = read_ver_prefix!(reader, SERIALIZATION_VERSION);
3568 let latest_update_id: u64 = Readable::read(reader)?;
3569 let commitment_transaction_number_obscure_factor = <U48 as Readable>::read(reader)?.0;
3571 let destination_script = Readable::read(reader)?;
3572 let broadcasted_holder_revokable_script = match <u8 as Readable>::read(reader)? {
3574 let revokable_address = Readable::read(reader)?;
3575 let per_commitment_point = Readable::read(reader)?;
3576 let revokable_script = Readable::read(reader)?;
3577 Some((revokable_address, per_commitment_point, revokable_script))
3580 _ => return Err(DecodeError::InvalidValue),
3582 let counterparty_payment_script = Readable::read(reader)?;
3583 let shutdown_script = {
3584 let script = <Script as Readable>::read(reader)?;
3585 if script.is_empty() { None } else { Some(script) }
3588 let channel_keys_id = Readable::read(reader)?;
3589 let holder_revocation_basepoint = Readable::read(reader)?;
3590 // Technically this can fail and serialize fail a round-trip, but only for serialization of
3591 // barely-init'd ChannelMonitors that we can't do anything with.
3592 let outpoint = OutPoint {
3593 txid: Readable::read(reader)?,
3594 index: Readable::read(reader)?,
3596 let funding_info = (outpoint, Readable::read(reader)?);
3597 let current_counterparty_commitment_txid = Readable::read(reader)?;
3598 let prev_counterparty_commitment_txid = Readable::read(reader)?;
3600 let counterparty_commitment_params = Readable::read(reader)?;
3601 let funding_redeemscript = Readable::read(reader)?;
3602 let channel_value_satoshis = Readable::read(reader)?;
3604 let their_cur_per_commitment_points = {
3605 let first_idx = <U48 as Readable>::read(reader)?.0;
3609 let first_point = Readable::read(reader)?;
3610 let second_point_slice: [u8; 33] = Readable::read(reader)?;
3611 if second_point_slice[0..32] == [0; 32] && second_point_slice[32] == 0 {
3612 Some((first_idx, first_point, None))
3614 Some((first_idx, first_point, Some(unwrap_obj!(PublicKey::from_slice(&second_point_slice)))))
3619 let on_holder_tx_csv: u16 = Readable::read(reader)?;
3621 let commitment_secrets = Readable::read(reader)?;
3623 macro_rules! read_htlc_in_commitment {
3626 let offered: bool = Readable::read(reader)?;
3627 let amount_msat: u64 = Readable::read(reader)?;
3628 let cltv_expiry: u32 = Readable::read(reader)?;
3629 let payment_hash: PaymentHash = Readable::read(reader)?;
3630 let transaction_output_index: Option<u32> = Readable::read(reader)?;
3632 HTLCOutputInCommitment {
3633 offered, amount_msat, cltv_expiry, payment_hash, transaction_output_index
3639 let counterparty_claimable_outpoints_len: u64 = Readable::read(reader)?;
3640 let mut counterparty_claimable_outpoints = HashMap::with_capacity(cmp::min(counterparty_claimable_outpoints_len as usize, MAX_ALLOC_SIZE / 64));
3641 for _ in 0..counterparty_claimable_outpoints_len {
3642 let txid: Txid = Readable::read(reader)?;
3643 let htlcs_count: u64 = Readable::read(reader)?;
3644 let mut htlcs = Vec::with_capacity(cmp::min(htlcs_count as usize, MAX_ALLOC_SIZE / 32));
3645 for _ in 0..htlcs_count {
3646 htlcs.push((read_htlc_in_commitment!(), <Option<HTLCSource> as Readable>::read(reader)?.map(|o: HTLCSource| Box::new(o))));
3648 if let Some(_) = counterparty_claimable_outpoints.insert(txid, htlcs) {
3649 return Err(DecodeError::InvalidValue);
3653 let counterparty_commitment_txn_on_chain_len: u64 = Readable::read(reader)?;
3654 let mut counterparty_commitment_txn_on_chain = HashMap::with_capacity(cmp::min(counterparty_commitment_txn_on_chain_len as usize, MAX_ALLOC_SIZE / 32));
3655 for _ in 0..counterparty_commitment_txn_on_chain_len {
3656 let txid: Txid = Readable::read(reader)?;
3657 let commitment_number = <U48 as Readable>::read(reader)?.0;
3658 if let Some(_) = counterparty_commitment_txn_on_chain.insert(txid, commitment_number) {
3659 return Err(DecodeError::InvalidValue);
3663 let counterparty_hash_commitment_number_len: u64 = Readable::read(reader)?;
3664 let mut counterparty_hash_commitment_number = HashMap::with_capacity(cmp::min(counterparty_hash_commitment_number_len as usize, MAX_ALLOC_SIZE / 32));
3665 for _ in 0..counterparty_hash_commitment_number_len {
3666 let payment_hash: PaymentHash = Readable::read(reader)?;
3667 let commitment_number = <U48 as Readable>::read(reader)?.0;
3668 if let Some(_) = counterparty_hash_commitment_number.insert(payment_hash, commitment_number) {
3669 return Err(DecodeError::InvalidValue);
3673 let mut prev_holder_signed_commitment_tx: Option<HolderSignedTx> =
3674 match <u8 as Readable>::read(reader)? {
3677 Some(Readable::read(reader)?)
3679 _ => return Err(DecodeError::InvalidValue),
3681 let mut current_holder_commitment_tx: HolderSignedTx = Readable::read(reader)?;
3683 let current_counterparty_commitment_number = <U48 as Readable>::read(reader)?.0;
3684 let current_holder_commitment_number = <U48 as Readable>::read(reader)?.0;
3686 let payment_preimages_len: u64 = Readable::read(reader)?;
3687 let mut payment_preimages = HashMap::with_capacity(cmp::min(payment_preimages_len as usize, MAX_ALLOC_SIZE / 32));
3688 for _ in 0..payment_preimages_len {
3689 let preimage: PaymentPreimage = Readable::read(reader)?;
3690 let hash = PaymentHash(Sha256::hash(&preimage.0[..]).into_inner());
3691 if let Some(_) = payment_preimages.insert(hash, preimage) {
3692 return Err(DecodeError::InvalidValue);
3696 let pending_monitor_events_len: u64 = Readable::read(reader)?;
3697 let mut pending_monitor_events = Some(
3698 Vec::with_capacity(cmp::min(pending_monitor_events_len as usize, MAX_ALLOC_SIZE / (32 + 8*3))));
3699 for _ in 0..pending_monitor_events_len {
3700 let ev = match <u8 as Readable>::read(reader)? {
3701 0 => MonitorEvent::HTLCEvent(Readable::read(reader)?),
3702 1 => MonitorEvent::CommitmentTxConfirmed(funding_info.0),
3703 _ => return Err(DecodeError::InvalidValue)
3705 pending_monitor_events.as_mut().unwrap().push(ev);
3708 let pending_events_len: u64 = Readable::read(reader)?;
3709 let mut pending_events = Vec::with_capacity(cmp::min(pending_events_len as usize, MAX_ALLOC_SIZE / mem::size_of::<Event>()));
3710 for _ in 0..pending_events_len {
3711 if let Some(event) = MaybeReadable::read(reader)? {
3712 pending_events.push(event);
3716 let best_block = BestBlock::new(Readable::read(reader)?, Readable::read(reader)?);
3718 let waiting_threshold_conf_len: u64 = Readable::read(reader)?;
3719 let mut onchain_events_awaiting_threshold_conf = Vec::with_capacity(cmp::min(waiting_threshold_conf_len as usize, MAX_ALLOC_SIZE / 128));
3720 for _ in 0..waiting_threshold_conf_len {
3721 if let Some(val) = MaybeReadable::read(reader)? {
3722 onchain_events_awaiting_threshold_conf.push(val);
3726 let outputs_to_watch_len: u64 = Readable::read(reader)?;
3727 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>>())));
3728 for _ in 0..outputs_to_watch_len {
3729 let txid = Readable::read(reader)?;
3730 let outputs_len: u64 = Readable::read(reader)?;
3731 let mut outputs = Vec::with_capacity(cmp::min(outputs_len as usize, MAX_ALLOC_SIZE / (mem::size_of::<u32>() + mem::size_of::<Script>())));
3732 for _ in 0..outputs_len {
3733 outputs.push((Readable::read(reader)?, Readable::read(reader)?));
3735 if let Some(_) = outputs_to_watch.insert(txid, outputs) {
3736 return Err(DecodeError::InvalidValue);
3739 let onchain_tx_handler: OnchainTxHandler<K::Signer> = ReadableArgs::read(reader, keys_manager)?;
3741 let lockdown_from_offchain = Readable::read(reader)?;
3742 let holder_tx_signed = Readable::read(reader)?;
3744 if let Some(prev_commitment_tx) = prev_holder_signed_commitment_tx.as_mut() {
3745 let prev_holder_value = onchain_tx_handler.get_prev_holder_commitment_to_self_value();
3746 if prev_holder_value.is_none() { return Err(DecodeError::InvalidValue); }
3747 if prev_commitment_tx.to_self_value_sat == u64::max_value() {
3748 prev_commitment_tx.to_self_value_sat = prev_holder_value.unwrap();
3749 } else if prev_commitment_tx.to_self_value_sat != prev_holder_value.unwrap() {
3750 return Err(DecodeError::InvalidValue);
3754 let cur_holder_value = onchain_tx_handler.get_cur_holder_commitment_to_self_value();
3755 if current_holder_commitment_tx.to_self_value_sat == u64::max_value() {
3756 current_holder_commitment_tx.to_self_value_sat = cur_holder_value;
3757 } else if current_holder_commitment_tx.to_self_value_sat != cur_holder_value {
3758 return Err(DecodeError::InvalidValue);
3761 let mut funding_spend_confirmed = None;
3762 let mut htlcs_resolved_on_chain = Some(Vec::new());
3763 let mut funding_spend_seen = Some(false);
3764 let mut counterparty_node_id = None;
3765 let mut confirmed_commitment_tx_counterparty_output = None;
3766 read_tlv_fields!(reader, {
3767 (1, funding_spend_confirmed, option),
3768 (3, htlcs_resolved_on_chain, vec_type),
3769 (5, pending_monitor_events, vec_type),
3770 (7, funding_spend_seen, option),
3771 (9, counterparty_node_id, option),
3772 (11, confirmed_commitment_tx_counterparty_output, option),
3775 let mut secp_ctx = Secp256k1::new();
3776 secp_ctx.seeded_randomize(&keys_manager.get_secure_random_bytes());
3778 Ok((best_block.block_hash(), ChannelMonitor::from_impl(ChannelMonitorImpl {
3780 commitment_transaction_number_obscure_factor,
3783 broadcasted_holder_revokable_script,
3784 counterparty_payment_script,
3788 holder_revocation_basepoint,
3790 current_counterparty_commitment_txid,
3791 prev_counterparty_commitment_txid,
3793 counterparty_commitment_params,
3794 funding_redeemscript,
3795 channel_value_satoshis,
3796 their_cur_per_commitment_points,
3801 counterparty_claimable_outpoints,
3802 counterparty_commitment_txn_on_chain,
3803 counterparty_hash_commitment_number,
3805 prev_holder_signed_commitment_tx,
3806 current_holder_commitment_tx,
3807 current_counterparty_commitment_number,
3808 current_holder_commitment_number,
3811 pending_monitor_events: pending_monitor_events.unwrap(),
3814 onchain_events_awaiting_threshold_conf,
3819 lockdown_from_offchain,
3821 funding_spend_seen: funding_spend_seen.unwrap(),
3822 funding_spend_confirmed,
3823 confirmed_commitment_tx_counterparty_output,
3824 htlcs_resolved_on_chain: htlcs_resolved_on_chain.unwrap(),
3827 counterparty_node_id,
3836 use bitcoin::blockdata::block::BlockHeader;
3837 use bitcoin::blockdata::script::{Script, Builder};
3838 use bitcoin::blockdata::opcodes;
3839 use bitcoin::blockdata::transaction::{Transaction, TxIn, TxOut, EcdsaSighashType};
3840 use bitcoin::blockdata::transaction::OutPoint as BitcoinOutPoint;
3841 use bitcoin::util::sighash;
3842 use bitcoin::hashes::Hash;
3843 use bitcoin::hashes::sha256::Hash as Sha256;
3844 use bitcoin::hashes::hex::FromHex;
3845 use bitcoin::hash_types::{BlockHash, Txid};
3846 use bitcoin::network::constants::Network;
3847 use bitcoin::secp256k1::{SecretKey,PublicKey};
3848 use bitcoin::secp256k1::Secp256k1;
3852 use crate::chain::chaininterface::LowerBoundedFeeEstimator;
3854 use super::ChannelMonitorUpdateStep;
3855 use crate::{check_added_monitors, check_closed_broadcast, check_closed_event, check_spends, get_local_commitment_txn, get_monitor, get_route_and_payment_hash, unwrap_send_err};
3856 use crate::chain::{BestBlock, Confirm};
3857 use crate::chain::channelmonitor::ChannelMonitor;
3858 use crate::chain::package::{weight_offered_htlc, weight_received_htlc, weight_revoked_offered_htlc, weight_revoked_received_htlc, WEIGHT_REVOKED_OUTPUT};
3859 use crate::chain::transaction::OutPoint;
3860 use crate::chain::keysinterface::InMemorySigner;
3861 use crate::ln::{PaymentPreimage, PaymentHash};
3862 use crate::ln::chan_utils;
3863 use crate::ln::chan_utils::{HTLCOutputInCommitment, ChannelPublicKeys, ChannelTransactionParameters, HolderCommitmentTransaction, CounterpartyChannelTransactionParameters};
3864 use crate::ln::channelmanager::{self, PaymentSendFailure, PaymentId};
3865 use crate::ln::functional_test_utils::*;
3866 use crate::ln::script::ShutdownScript;
3867 use crate::util::errors::APIError;
3868 use crate::util::events::{ClosureReason, MessageSendEventsProvider};
3869 use crate::util::test_utils::{TestLogger, TestBroadcaster, TestFeeEstimator};
3870 use crate::util::ser::{ReadableArgs, Writeable};
3871 use crate::sync::{Arc, Mutex};
3873 use bitcoin::{PackedLockTime, Sequence, TxMerkleNode, Witness};
3874 use crate::prelude::*;
3876 fn do_test_funding_spend_refuses_updates(use_local_txn: bool) {
3877 // Previously, monitor updates were allowed freely even after a funding-spend transaction
3878 // confirmed. This would allow a race condition where we could receive a payment (including
3879 // the counterparty revoking their broadcasted state!) and accept it without recourse as
3880 // long as the ChannelMonitor receives the block first, the full commitment update dance
3881 // occurs after the block is connected, and before the ChannelManager receives the block.
3882 // Obviously this is an incredibly contrived race given the counterparty would be risking
3883 // their full channel balance for it, but its worth fixing nonetheless as it makes the
3884 // potential ChannelMonitor states simpler to reason about.
3886 // This test checks said behavior, as well as ensuring a ChannelMonitorUpdate with multiple
3887 // updates is handled correctly in such conditions.
3888 let chanmon_cfgs = create_chanmon_cfgs(3);
3889 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
3890 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
3891 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
3892 let channel = create_announced_chan_between_nodes(
3893 &nodes, 0, 1, channelmanager::provided_init_features(), channelmanager::provided_init_features());
3894 create_announced_chan_between_nodes(
3895 &nodes, 1, 2, channelmanager::provided_init_features(), channelmanager::provided_init_features());
3897 // Rebalance somewhat
3898 send_payment(&nodes[0], &[&nodes[1]], 10_000_000);
3900 // First route two payments for testing at the end
3901 let payment_preimage_1 = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 1_000_000).0;
3902 let payment_preimage_2 = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 1_000_000).0;
3904 let local_txn = get_local_commitment_txn!(nodes[1], channel.2);
3905 assert_eq!(local_txn.len(), 1);
3906 let remote_txn = get_local_commitment_txn!(nodes[0], channel.2);
3907 assert_eq!(remote_txn.len(), 3); // Commitment and two HTLC-Timeouts
3908 check_spends!(remote_txn[1], remote_txn[0]);
3909 check_spends!(remote_txn[2], remote_txn[0]);
3910 let broadcast_tx = if use_local_txn { &local_txn[0] } else { &remote_txn[0] };
3912 // Connect a commitment transaction, but only to the ChainMonitor/ChannelMonitor. The
3913 // channel is now closed, but the ChannelManager doesn't know that yet.
3914 let new_header = BlockHeader {
3915 version: 2, time: 0, bits: 0, nonce: 0,
3916 prev_blockhash: nodes[0].best_block_info().0,
3917 merkle_root: TxMerkleNode::all_zeros() };
3918 let conf_height = nodes[0].best_block_info().1 + 1;
3919 nodes[1].chain_monitor.chain_monitor.transactions_confirmed(&new_header,
3920 &[(0, broadcast_tx)], conf_height);
3922 let (_, pre_update_monitor) = <(BlockHash, ChannelMonitor<InMemorySigner>)>::read(
3923 &mut io::Cursor::new(&get_monitor!(nodes[1], channel.2).encode()),
3924 &nodes[1].keys_manager.backing).unwrap();
3926 // If the ChannelManager tries to update the channel, however, the ChainMonitor will pass
3927 // the update through to the ChannelMonitor which will refuse it (as the channel is closed).
3928 let (route, payment_hash, _, payment_secret) = get_route_and_payment_hash!(nodes[1], nodes[0], 100_000);
3929 unwrap_send_err!(nodes[1].node.send_payment(&route, payment_hash, &Some(payment_secret), PaymentId(payment_hash.0)),
3930 true, APIError::ChannelUnavailable { ref err },
3931 assert!(err.contains("ChannelMonitor storage failure")));
3932 check_added_monitors!(nodes[1], 2); // After the failure we generate a close-channel monitor update
3933 check_closed_broadcast!(nodes[1], true);
3934 check_closed_event!(nodes[1], 1, ClosureReason::ProcessingError { err: "ChannelMonitor storage failure".to_string() });
3936 // Build a new ChannelMonitorUpdate which contains both the failing commitment tx update
3937 // and provides the claim preimages for the two pending HTLCs. The first update generates
3938 // an error, but the point of this test is to ensure the later updates are still applied.
3939 let monitor_updates = nodes[1].chain_monitor.monitor_updates.lock().unwrap();
3940 let mut replay_update = monitor_updates.get(&channel.2).unwrap().iter().rev().skip(1).next().unwrap().clone();
3941 assert_eq!(replay_update.updates.len(), 1);
3942 if let ChannelMonitorUpdateStep::LatestCounterpartyCommitmentTXInfo { .. } = replay_update.updates[0] {
3943 } else { panic!(); }
3944 replay_update.updates.push(ChannelMonitorUpdateStep::PaymentPreimage { payment_preimage: payment_preimage_1 });
3945 replay_update.updates.push(ChannelMonitorUpdateStep::PaymentPreimage { payment_preimage: payment_preimage_2 });
3947 let broadcaster = TestBroadcaster::new(Arc::clone(&nodes[1].blocks));
3949 pre_update_monitor.update_monitor(&replay_update, &&broadcaster, &chanmon_cfgs[1].fee_estimator, &nodes[1].logger)
3951 // Even though we error'd on the first update, we should still have generated an HTLC claim
3953 let txn_broadcasted = broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
3954 assert!(txn_broadcasted.len() >= 2);
3955 let htlc_txn = txn_broadcasted.iter().filter(|tx| {
3956 assert_eq!(tx.input.len(), 1);
3957 tx.input[0].previous_output.txid == broadcast_tx.txid()
3958 }).collect::<Vec<_>>();
3959 assert_eq!(htlc_txn.len(), 2);
3960 check_spends!(htlc_txn[0], broadcast_tx);
3961 check_spends!(htlc_txn[1], broadcast_tx);
3964 fn test_funding_spend_refuses_updates() {
3965 do_test_funding_spend_refuses_updates(true);
3966 do_test_funding_spend_refuses_updates(false);
3970 fn test_prune_preimages() {
3971 let secp_ctx = Secp256k1::new();
3972 let logger = Arc::new(TestLogger::new());
3973 let broadcaster = Arc::new(TestBroadcaster{txn_broadcasted: Mutex::new(Vec::new()), blocks: Arc::new(Mutex::new(Vec::new()))});
3974 let fee_estimator = TestFeeEstimator { sat_per_kw: Mutex::new(253) };
3976 let dummy_key = PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[42; 32]).unwrap());
3977 let dummy_tx = Transaction { version: 0, lock_time: PackedLockTime::ZERO, input: Vec::new(), output: Vec::new() };
3979 let mut preimages = Vec::new();
3982 let preimage = PaymentPreimage([i; 32]);
3983 let hash = PaymentHash(Sha256::hash(&preimage.0[..]).into_inner());
3984 preimages.push((preimage, hash));
3988 macro_rules! preimages_slice_to_htlc_outputs {
3989 ($preimages_slice: expr) => {
3991 let mut res = Vec::new();
3992 for (idx, preimage) in $preimages_slice.iter().enumerate() {
3993 res.push((HTLCOutputInCommitment {
3997 payment_hash: preimage.1.clone(),
3998 transaction_output_index: Some(idx as u32),
4005 macro_rules! preimages_to_holder_htlcs {
4006 ($preimages_slice: expr) => {
4008 let mut inp = preimages_slice_to_htlc_outputs!($preimages_slice);
4009 let res: Vec<_> = inp.drain(..).map(|e| { (e.0, None, e.1) }).collect();
4015 macro_rules! test_preimages_exist {
4016 ($preimages_slice: expr, $monitor: expr) => {
4017 for preimage in $preimages_slice {
4018 assert!($monitor.inner.lock().unwrap().payment_preimages.contains_key(&preimage.1));
4023 let keys = InMemorySigner::new(
4025 SecretKey::from_slice(&[41; 32]).unwrap(),
4026 SecretKey::from_slice(&[41; 32]).unwrap(),
4027 SecretKey::from_slice(&[41; 32]).unwrap(),
4028 SecretKey::from_slice(&[41; 32]).unwrap(),
4029 SecretKey::from_slice(&[41; 32]).unwrap(),
4030 SecretKey::from_slice(&[41; 32]).unwrap(),
4036 let counterparty_pubkeys = ChannelPublicKeys {
4037 funding_pubkey: PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[44; 32]).unwrap()),
4038 revocation_basepoint: PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[45; 32]).unwrap()),
4039 payment_point: PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[46; 32]).unwrap()),
4040 delayed_payment_basepoint: PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[47; 32]).unwrap()),
4041 htlc_basepoint: PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[48; 32]).unwrap())
4043 let funding_outpoint = OutPoint { txid: Txid::all_zeros(), index: u16::max_value() };
4044 let channel_parameters = ChannelTransactionParameters {
4045 holder_pubkeys: keys.holder_channel_pubkeys.clone(),
4046 holder_selected_contest_delay: 66,
4047 is_outbound_from_holder: true,
4048 counterparty_parameters: Some(CounterpartyChannelTransactionParameters {
4049 pubkeys: counterparty_pubkeys,
4050 selected_contest_delay: 67,
4052 funding_outpoint: Some(funding_outpoint),
4055 // Prune with one old state and a holder commitment tx holding a few overlaps with the
4057 let shutdown_pubkey = PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[42; 32]).unwrap());
4058 let best_block = BestBlock::from_genesis(Network::Testnet);
4059 let monitor = ChannelMonitor::new(Secp256k1::new(), keys,
4060 Some(ShutdownScript::new_p2wpkh_from_pubkey(shutdown_pubkey).into_inner()), 0, &Script::new(),
4061 (OutPoint { txid: Txid::from_slice(&[43; 32]).unwrap(), index: 0 }, Script::new()),
4062 &channel_parameters,
4063 Script::new(), 46, 0,
4064 HolderCommitmentTransaction::dummy(), best_block, dummy_key);
4066 monitor.provide_latest_holder_commitment_tx(HolderCommitmentTransaction::dummy(), preimages_to_holder_htlcs!(preimages[0..10])).unwrap();
4067 let dummy_txid = dummy_tx.txid();
4068 monitor.provide_latest_counterparty_commitment_tx(dummy_txid, preimages_slice_to_htlc_outputs!(preimages[5..15]), 281474976710655, dummy_key, &logger);
4069 monitor.provide_latest_counterparty_commitment_tx(dummy_txid, preimages_slice_to_htlc_outputs!(preimages[15..20]), 281474976710654, dummy_key, &logger);
4070 monitor.provide_latest_counterparty_commitment_tx(dummy_txid, preimages_slice_to_htlc_outputs!(preimages[17..20]), 281474976710653, dummy_key, &logger);
4071 monitor.provide_latest_counterparty_commitment_tx(dummy_txid, preimages_slice_to_htlc_outputs!(preimages[18..20]), 281474976710652, dummy_key, &logger);
4072 for &(ref preimage, ref hash) in preimages.iter() {
4073 let bounded_fee_estimator = LowerBoundedFeeEstimator::new(&fee_estimator);
4074 monitor.provide_payment_preimage(hash, preimage, &broadcaster, &bounded_fee_estimator, &logger);
4077 // Now provide a secret, pruning preimages 10-15
4078 let mut secret = [0; 32];
4079 secret[0..32].clone_from_slice(&hex::decode("7cc854b54e3e0dcdb010d7a3fee464a9687be6e8db3be6854c475621e007a5dc").unwrap());
4080 monitor.provide_secret(281474976710655, secret.clone()).unwrap();
4081 assert_eq!(monitor.inner.lock().unwrap().payment_preimages.len(), 15);
4082 test_preimages_exist!(&preimages[0..10], monitor);
4083 test_preimages_exist!(&preimages[15..20], monitor);
4085 // Now provide a further secret, pruning preimages 15-17
4086 secret[0..32].clone_from_slice(&hex::decode("c7518c8ae4660ed02894df8976fa1a3659c1a8b4b5bec0c4b872abeba4cb8964").unwrap());
4087 monitor.provide_secret(281474976710654, secret.clone()).unwrap();
4088 assert_eq!(monitor.inner.lock().unwrap().payment_preimages.len(), 13);
4089 test_preimages_exist!(&preimages[0..10], monitor);
4090 test_preimages_exist!(&preimages[17..20], monitor);
4092 // Now update holder commitment tx info, pruning only element 18 as we still care about the
4093 // previous commitment tx's preimages too
4094 monitor.provide_latest_holder_commitment_tx(HolderCommitmentTransaction::dummy(), preimages_to_holder_htlcs!(preimages[0..5])).unwrap();
4095 secret[0..32].clone_from_slice(&hex::decode("2273e227a5b7449b6e70f1fb4652864038b1cbf9cd7c043a7d6456b7fc275ad8").unwrap());
4096 monitor.provide_secret(281474976710653, secret.clone()).unwrap();
4097 assert_eq!(monitor.inner.lock().unwrap().payment_preimages.len(), 12);
4098 test_preimages_exist!(&preimages[0..10], monitor);
4099 test_preimages_exist!(&preimages[18..20], monitor);
4101 // But if we do it again, we'll prune 5-10
4102 monitor.provide_latest_holder_commitment_tx(HolderCommitmentTransaction::dummy(), preimages_to_holder_htlcs!(preimages[0..3])).unwrap();
4103 secret[0..32].clone_from_slice(&hex::decode("27cddaa5624534cb6cb9d7da077cf2b22ab21e9b506fd4998a51d54502e99116").unwrap());
4104 monitor.provide_secret(281474976710652, secret.clone()).unwrap();
4105 assert_eq!(monitor.inner.lock().unwrap().payment_preimages.len(), 5);
4106 test_preimages_exist!(&preimages[0..5], monitor);
4110 fn test_claim_txn_weight_computation() {
4111 // We test Claim txn weight, knowing that we want expected weigth and
4112 // not actual case to avoid sigs and time-lock delays hell variances.
4114 let secp_ctx = Secp256k1::new();
4115 let privkey = SecretKey::from_slice(&hex::decode("0101010101010101010101010101010101010101010101010101010101010101").unwrap()[..]).unwrap();
4116 let pubkey = PublicKey::from_secret_key(&secp_ctx, &privkey);
4118 macro_rules! sign_input {
4119 ($sighash_parts: expr, $idx: expr, $amount: expr, $weight: expr, $sum_actual_sigs: expr, $opt_anchors: expr) => {
4120 let htlc = HTLCOutputInCommitment {
4121 offered: if *$weight == weight_revoked_offered_htlc($opt_anchors) || *$weight == weight_offered_htlc($opt_anchors) { true } else { false },
4123 cltv_expiry: 2 << 16,
4124 payment_hash: PaymentHash([1; 32]),
4125 transaction_output_index: Some($idx as u32),
4127 let redeem_script = if *$weight == WEIGHT_REVOKED_OUTPUT { chan_utils::get_revokeable_redeemscript(&pubkey, 256, &pubkey) } else { chan_utils::get_htlc_redeemscript_with_explicit_keys(&htlc, $opt_anchors, &pubkey, &pubkey, &pubkey) };
4128 let sighash = hash_to_message!(&$sighash_parts.segwit_signature_hash($idx, &redeem_script, $amount, EcdsaSighashType::All).unwrap()[..]);
4129 let sig = secp_ctx.sign_ecdsa(&sighash, &privkey);
4130 let mut ser_sig = sig.serialize_der().to_vec();
4131 ser_sig.push(EcdsaSighashType::All as u8);
4132 $sum_actual_sigs += ser_sig.len();
4133 let witness = $sighash_parts.witness_mut($idx).unwrap();
4134 witness.push(ser_sig);
4135 if *$weight == WEIGHT_REVOKED_OUTPUT {
4136 witness.push(vec!(1));
4137 } else if *$weight == weight_revoked_offered_htlc($opt_anchors) || *$weight == weight_revoked_received_htlc($opt_anchors) {
4138 witness.push(pubkey.clone().serialize().to_vec());
4139 } else if *$weight == weight_received_htlc($opt_anchors) {
4140 witness.push(vec![0]);
4142 witness.push(PaymentPreimage([1; 32]).0.to_vec());
4144 witness.push(redeem_script.into_bytes());
4145 let witness = witness.to_vec();
4146 println!("witness[0] {}", witness[0].len());
4147 println!("witness[1] {}", witness[1].len());
4148 println!("witness[2] {}", witness[2].len());
4152 let script_pubkey = Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script();
4153 let txid = Txid::from_hex("56944c5d3f98413ef45cf54545538103cc9f298e0575820ad3591376e2e0f65d").unwrap();
4155 // Justice tx with 1 to_holder, 2 revoked offered HTLCs, 1 revoked received HTLCs
4156 for &opt_anchors in [false, true].iter() {
4157 let mut claim_tx = Transaction { version: 0, lock_time: PackedLockTime::ZERO, input: Vec::new(), output: Vec::new() };
4158 let mut sum_actual_sigs = 0;
4160 claim_tx.input.push(TxIn {
4161 previous_output: BitcoinOutPoint {
4165 script_sig: Script::new(),
4166 sequence: Sequence::ENABLE_RBF_NO_LOCKTIME,
4167 witness: Witness::new(),
4170 claim_tx.output.push(TxOut {
4171 script_pubkey: script_pubkey.clone(),
4174 let base_weight = claim_tx.weight();
4175 let inputs_weight = vec![WEIGHT_REVOKED_OUTPUT, weight_revoked_offered_htlc(opt_anchors), weight_revoked_offered_htlc(opt_anchors), weight_revoked_received_htlc(opt_anchors)];
4176 let mut inputs_total_weight = 2; // count segwit flags
4178 let mut sighash_parts = sighash::SighashCache::new(&mut claim_tx);
4179 for (idx, inp) in inputs_weight.iter().enumerate() {
4180 sign_input!(sighash_parts, idx, 0, inp, sum_actual_sigs, opt_anchors);
4181 inputs_total_weight += inp;
4184 assert_eq!(base_weight + inputs_total_weight as usize, claim_tx.weight() + /* max_length_sig */ (73 * inputs_weight.len() - sum_actual_sigs));
4187 // Claim tx with 1 offered HTLCs, 3 received HTLCs
4188 for &opt_anchors in [false, true].iter() {
4189 let mut claim_tx = Transaction { version: 0, lock_time: PackedLockTime::ZERO, input: Vec::new(), output: Vec::new() };
4190 let mut sum_actual_sigs = 0;
4192 claim_tx.input.push(TxIn {
4193 previous_output: BitcoinOutPoint {
4197 script_sig: Script::new(),
4198 sequence: Sequence::ENABLE_RBF_NO_LOCKTIME,
4199 witness: Witness::new(),
4202 claim_tx.output.push(TxOut {
4203 script_pubkey: script_pubkey.clone(),
4206 let base_weight = claim_tx.weight();
4207 let inputs_weight = vec![weight_offered_htlc(opt_anchors), weight_received_htlc(opt_anchors), weight_received_htlc(opt_anchors), weight_received_htlc(opt_anchors)];
4208 let mut inputs_total_weight = 2; // count segwit flags
4210 let mut sighash_parts = sighash::SighashCache::new(&mut claim_tx);
4211 for (idx, inp) in inputs_weight.iter().enumerate() {
4212 sign_input!(sighash_parts, idx, 0, inp, sum_actual_sigs, opt_anchors);
4213 inputs_total_weight += inp;
4216 assert_eq!(base_weight + inputs_total_weight as usize, claim_tx.weight() + /* max_length_sig */ (73 * inputs_weight.len() - sum_actual_sigs));
4219 // Justice tx with 1 revoked HTLC-Success tx output
4220 for &opt_anchors in [false, true].iter() {
4221 let mut claim_tx = Transaction { version: 0, lock_time: PackedLockTime::ZERO, input: Vec::new(), output: Vec::new() };
4222 let mut sum_actual_sigs = 0;
4223 claim_tx.input.push(TxIn {
4224 previous_output: BitcoinOutPoint {
4228 script_sig: Script::new(),
4229 sequence: Sequence::ENABLE_RBF_NO_LOCKTIME,
4230 witness: Witness::new(),
4232 claim_tx.output.push(TxOut {
4233 script_pubkey: script_pubkey.clone(),
4236 let base_weight = claim_tx.weight();
4237 let inputs_weight = vec![WEIGHT_REVOKED_OUTPUT];
4238 let mut inputs_total_weight = 2; // count segwit flags
4240 let mut sighash_parts = sighash::SighashCache::new(&mut claim_tx);
4241 for (idx, inp) in inputs_weight.iter().enumerate() {
4242 sign_input!(sighash_parts, idx, 0, inp, sum_actual_sigs, opt_anchors);
4243 inputs_total_weight += inp;
4246 assert_eq!(base_weight + inputs_total_weight as usize, claim_tx.weight() + /* max_length_isg */ (73 * inputs_weight.len() - sum_actual_sigs));
4250 // Further testing is done in the ChannelManager integration tests.