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;
27 use bitcoin::hashes::Hash;
28 use bitcoin::hashes::sha256::Hash as Sha256;
29 use bitcoin::hash_types::{Txid, BlockHash};
31 use bitcoin::secp256k1::{Secp256k1, ecdsa::Signature};
32 use bitcoin::secp256k1::{SecretKey, PublicKey};
33 use bitcoin::{secp256k1, EcdsaSighashType};
35 use crate::ln::channel::INITIAL_COMMITMENT_NUMBER;
36 use crate::ln::{PaymentHash, PaymentPreimage};
37 use crate::ln::msgs::DecodeError;
38 use crate::ln::chan_utils;
39 use crate::ln::chan_utils::{CommitmentTransaction, CounterpartyCommitmentSecrets, HTLCOutputInCommitment, HTLCClaim, ChannelTransactionParameters, HolderCommitmentTransaction, TxCreationKeys};
40 use crate::ln::channelmanager::{HTLCSource, SentHTLCId};
42 use crate::chain::{BestBlock, WatchedOutput};
43 use crate::chain::chaininterface::{BroadcasterInterface, FeeEstimator, LowerBoundedFeeEstimator};
44 use crate::chain::transaction::{OutPoint, TransactionData};
45 use crate::sign::{SpendableOutputDescriptor, StaticPaymentOutputDescriptor, DelayedPaymentOutputDescriptor, WriteableEcdsaChannelSigner, SignerProvider, EntropySource};
46 use crate::chain::onchaintx::{ClaimEvent, OnchainTxHandler};
47 use crate::chain::package::{CounterpartyOfferedHTLCOutput, CounterpartyReceivedHTLCOutput, HolderFundingOutput, HolderHTLCOutput, PackageSolvingData, PackageTemplate, RevokedOutput, RevokedHTLCOutput};
48 use crate::chain::Filter;
49 use crate::util::logger::Logger;
50 use crate::util::ser::{Readable, ReadableArgs, RequiredWrapper, MaybeReadable, UpgradableRequired, Writer, Writeable, U48};
51 use crate::util::byte_utils;
52 use crate::events::{Event, EventHandler};
53 use crate::events::bump_transaction::{ChannelDerivationParameters, AnchorDescriptor, HTLCDescriptor, BumpTransactionEvent};
55 use crate::prelude::*;
57 use crate::io::{self, Error};
58 use core::convert::TryInto;
60 use crate::sync::{Mutex, LockTestExt};
62 /// An update generated by the underlying channel itself which contains some new information the
63 /// [`ChannelMonitor`] should be made aware of.
65 /// Because this represents only a small number of updates to the underlying state, it is generally
66 /// much smaller than a full [`ChannelMonitor`]. However, for large single commitment transaction
67 /// updates (e.g. ones during which there are hundreds of HTLCs pending on the commitment
68 /// transaction), a single update may reach upwards of 1 MiB in serialized size.
69 #[derive(Clone, Debug, PartialEq, Eq)]
71 pub struct ChannelMonitorUpdate {
72 pub(crate) updates: Vec<ChannelMonitorUpdateStep>,
73 /// The sequence number of this update. Updates *must* be replayed in-order according to this
74 /// sequence number (and updates may panic if they are not). The update_id values are strictly
75 /// increasing and increase by one for each new update, with two exceptions specified below.
77 /// This sequence number is also used to track up to which points updates which returned
78 /// [`ChannelMonitorUpdateStatus::InProgress`] have been applied to all copies of a given
79 /// ChannelMonitor when ChannelManager::channel_monitor_updated is called.
81 /// The only instances we allow where update_id values are not strictly increasing have a
82 /// special update ID of [`CLOSED_CHANNEL_UPDATE_ID`]. This update ID is used for updates that
83 /// will force close the channel by broadcasting the latest commitment transaction or
84 /// special post-force-close updates, like providing preimages necessary to claim outputs on the
85 /// broadcast commitment transaction. See its docs for more details.
87 /// [`ChannelMonitorUpdateStatus::InProgress`]: super::ChannelMonitorUpdateStatus::InProgress
91 /// The update ID used for a [`ChannelMonitorUpdate`] that is either:
93 /// (1) attempting to force close the channel by broadcasting our latest commitment transaction or
94 /// (2) providing a preimage (after the channel has been force closed) from a forward link that
95 /// allows us to spend an HTLC output on this channel's (the backward link's) broadcasted
96 /// commitment transaction.
98 /// No other [`ChannelMonitorUpdate`]s are allowed after force-close.
99 pub const CLOSED_CHANNEL_UPDATE_ID: u64 = core::u64::MAX;
101 impl Writeable for ChannelMonitorUpdate {
102 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
103 write_ver_prefix!(w, SERIALIZATION_VERSION, MIN_SERIALIZATION_VERSION);
104 self.update_id.write(w)?;
105 (self.updates.len() as u64).write(w)?;
106 for update_step in self.updates.iter() {
107 update_step.write(w)?;
109 write_tlv_fields!(w, {});
113 impl Readable for ChannelMonitorUpdate {
114 fn read<R: io::Read>(r: &mut R) -> Result<Self, DecodeError> {
115 let _ver = read_ver_prefix!(r, SERIALIZATION_VERSION);
116 let update_id: u64 = Readable::read(r)?;
117 let len: u64 = Readable::read(r)?;
118 let mut updates = Vec::with_capacity(cmp::min(len as usize, MAX_ALLOC_SIZE / ::core::mem::size_of::<ChannelMonitorUpdateStep>()));
120 if let Some(upd) = MaybeReadable::read(r)? {
124 read_tlv_fields!(r, {});
125 Ok(Self { update_id, updates })
129 /// An event to be processed by the ChannelManager.
130 #[derive(Clone, PartialEq, Eq)]
131 pub enum MonitorEvent {
132 /// A monitor event containing an HTLCUpdate.
133 HTLCEvent(HTLCUpdate),
135 /// A monitor event that the Channel's commitment transaction was confirmed.
136 HolderForceClosed(OutPoint),
138 /// Indicates a [`ChannelMonitor`] update has completed. See
139 /// [`ChannelMonitorUpdateStatus::InProgress`] for more information on how this is used.
141 /// [`ChannelMonitorUpdateStatus::InProgress`]: super::ChannelMonitorUpdateStatus::InProgress
143 /// The funding outpoint of the [`ChannelMonitor`] that was updated
144 funding_txo: OutPoint,
145 /// The Update ID from [`ChannelMonitorUpdate::update_id`] which was applied or
146 /// [`ChannelMonitor::get_latest_update_id`].
148 /// Note that this should only be set to a given update's ID if all previous updates for the
149 /// same [`ChannelMonitor`] have been applied and persisted.
150 monitor_update_id: u64,
153 impl_writeable_tlv_based_enum_upgradable!(MonitorEvent,
154 // Note that Completed is currently never serialized to disk as it is generated only in
157 (0, funding_txo, required),
158 (2, monitor_update_id, required),
162 (4, HolderForceClosed),
163 // 6 was `UpdateFailed` until LDK 0.0.117
166 /// Simple structure sent back by `chain::Watch` when an HTLC from a forward channel is detected on
167 /// chain. Used to update the corresponding HTLC in the backward channel. Failing to pass the
168 /// preimage claim backward will lead to loss of funds.
169 #[derive(Clone, PartialEq, Eq)]
170 pub struct HTLCUpdate {
171 pub(crate) payment_hash: PaymentHash,
172 pub(crate) payment_preimage: Option<PaymentPreimage>,
173 pub(crate) source: HTLCSource,
174 pub(crate) htlc_value_satoshis: Option<u64>,
176 impl_writeable_tlv_based!(HTLCUpdate, {
177 (0, payment_hash, required),
178 (1, htlc_value_satoshis, option),
179 (2, source, required),
180 (4, payment_preimage, option),
183 /// If an HTLC expires within this many blocks, don't try to claim it in a shared transaction,
184 /// instead claiming it in its own individual transaction.
185 pub(crate) const CLTV_SHARED_CLAIM_BUFFER: u32 = 12;
186 /// If an HTLC expires within this many blocks, force-close the channel to broadcast the
187 /// HTLC-Success transaction.
188 /// In other words, this is an upper bound on how many blocks we think it can take us to get a
189 /// transaction confirmed (and we use it in a few more, equivalent, places).
190 pub(crate) const CLTV_CLAIM_BUFFER: u32 = 18;
191 /// Number of blocks by which point we expect our counterparty to have seen new blocks on the
192 /// network and done a full update_fail_htlc/commitment_signed dance (+ we've updated all our
193 /// copies of ChannelMonitors, including watchtowers). We could enforce the contract by failing
194 /// at CLTV expiration height but giving a grace period to our peer may be profitable for us if he
195 /// can provide an over-late preimage. Nevertheless, grace period has to be accounted in our
196 /// CLTV_EXPIRY_DELTA to be secure. Following this policy we may decrease the rate of channel failures
197 /// due to expiration but increase the cost of funds being locked longuer in case of failure.
198 /// This delay also cover a low-power peer being slow to process blocks and so being behind us on
199 /// accurate block height.
200 /// In case of onchain failure to be pass backward we may see the last block of ANTI_REORG_DELAY
201 /// with at worst this delay, so we are not only using this value as a mercy for them but also
202 /// us as a safeguard to delay with enough time.
203 pub(crate) const LATENCY_GRACE_PERIOD_BLOCKS: u32 = 3;
204 /// Number of blocks we wait on seeing a HTLC output being solved before we fail corresponding
205 /// inbound HTLCs. This prevents us from failing backwards and then getting a reorg resulting in us
208 /// Note that this is a library-wide security assumption. If a reorg deeper than this number of
209 /// blocks occurs, counterparties may be able to steal funds or claims made by and balances exposed
210 /// by a [`ChannelMonitor`] may be incorrect.
211 // We also use this delay to be sure we can remove our in-flight claim txn from bump candidates buffer.
212 // It may cause spurious generation of bumped claim txn but that's alright given the outpoint is already
213 // solved by a previous claim tx. What we want to avoid is reorg evicting our claim tx and us not
214 // keep bumping another claim tx to solve the outpoint.
215 pub const ANTI_REORG_DELAY: u32 = 6;
216 /// Number of blocks before confirmation at which we fail back an un-relayed HTLC or at which we
217 /// refuse to accept a new HTLC.
219 /// This is used for a few separate purposes:
220 /// 1) if we've received an MPP HTLC to us and it expires within this many blocks and we are
221 /// waiting on additional parts (or waiting on the preimage for any HTLC from the user), we will
223 /// 2) if we receive an HTLC within this many blocks of its expiry (plus one to avoid a race
224 /// condition with the above), we will fail this HTLC without telling the user we received it,
226 /// (1) is all about protecting us - we need enough time to update the channel state before we hit
227 /// CLTV_CLAIM_BUFFER, at which point we'd go on chain to claim the HTLC with the preimage.
229 /// (2) is the same, but with an additional buffer to avoid accepting an HTLC which is immediately
230 /// in a race condition between the user connecting a block (which would fail it) and the user
231 /// providing us the preimage (which would claim it).
232 pub(crate) const HTLC_FAIL_BACK_BUFFER: u32 = CLTV_CLAIM_BUFFER + LATENCY_GRACE_PERIOD_BLOCKS;
234 // TODO(devrandom) replace this with HolderCommitmentTransaction
235 #[derive(Clone, PartialEq, Eq)]
236 struct HolderSignedTx {
237 /// txid of the transaction in tx, just used to make comparison faster
239 revocation_key: PublicKey,
240 a_htlc_key: PublicKey,
241 b_htlc_key: PublicKey,
242 delayed_payment_key: PublicKey,
243 per_commitment_point: PublicKey,
244 htlc_outputs: Vec<(HTLCOutputInCommitment, Option<Signature>, Option<HTLCSource>)>,
245 to_self_value_sat: u64,
248 impl_writeable_tlv_based!(HolderSignedTx, {
250 // Note that this is filled in with data from OnchainTxHandler if it's missing.
251 // For HolderSignedTx objects serialized with 0.0.100+, this should be filled in.
252 (1, to_self_value_sat, (default_value, u64::max_value())),
253 (2, revocation_key, required),
254 (4, a_htlc_key, required),
255 (6, b_htlc_key, required),
256 (8, delayed_payment_key, required),
257 (10, per_commitment_point, required),
258 (12, feerate_per_kw, required),
259 (14, htlc_outputs, required_vec)
262 impl HolderSignedTx {
263 fn non_dust_htlcs(&self) -> Vec<HTLCOutputInCommitment> {
264 self.htlc_outputs.iter().filter_map(|(htlc, _, _)| {
265 if let Some(_) = htlc.transaction_output_index {
275 /// We use this to track static counterparty commitment transaction data and to generate any
276 /// justice or 2nd-stage preimage/timeout transactions.
277 #[derive(Clone, PartialEq, Eq)]
278 struct CounterpartyCommitmentParameters {
279 counterparty_delayed_payment_base_key: PublicKey,
280 counterparty_htlc_base_key: PublicKey,
281 on_counterparty_tx_csv: u16,
284 impl Writeable for CounterpartyCommitmentParameters {
285 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
286 w.write_all(&(0 as u64).to_be_bytes())?;
287 write_tlv_fields!(w, {
288 (0, self.counterparty_delayed_payment_base_key, required),
289 (2, self.counterparty_htlc_base_key, required),
290 (4, self.on_counterparty_tx_csv, required),
295 impl Readable for CounterpartyCommitmentParameters {
296 fn read<R: io::Read>(r: &mut R) -> Result<Self, DecodeError> {
297 let counterparty_commitment_transaction = {
298 // Versions prior to 0.0.100 had some per-HTLC state stored here, which is no longer
299 // used. Read it for compatibility.
300 let per_htlc_len: u64 = Readable::read(r)?;
301 for _ in 0..per_htlc_len {
302 let _txid: Txid = Readable::read(r)?;
303 let htlcs_count: u64 = Readable::read(r)?;
304 for _ in 0..htlcs_count {
305 let _htlc: HTLCOutputInCommitment = Readable::read(r)?;
309 let mut counterparty_delayed_payment_base_key = RequiredWrapper(None);
310 let mut counterparty_htlc_base_key = RequiredWrapper(None);
311 let mut on_counterparty_tx_csv: u16 = 0;
312 read_tlv_fields!(r, {
313 (0, counterparty_delayed_payment_base_key, required),
314 (2, counterparty_htlc_base_key, required),
315 (4, on_counterparty_tx_csv, required),
317 CounterpartyCommitmentParameters {
318 counterparty_delayed_payment_base_key: counterparty_delayed_payment_base_key.0.unwrap(),
319 counterparty_htlc_base_key: counterparty_htlc_base_key.0.unwrap(),
320 on_counterparty_tx_csv,
323 Ok(counterparty_commitment_transaction)
327 /// An entry for an [`OnchainEvent`], stating the block height and hash when the event was
328 /// observed, as well as the transaction causing it.
330 /// Used to determine when the on-chain event can be considered safe from a chain reorganization.
331 #[derive(Clone, PartialEq, Eq)]
332 struct OnchainEventEntry {
335 block_hash: Option<BlockHash>, // Added as optional, will be filled in for any entry generated on 0.0.113 or after
337 transaction: Option<Transaction>, // Added as optional, but always filled in, in LDK 0.0.110
340 impl OnchainEventEntry {
341 fn confirmation_threshold(&self) -> u32 {
342 let mut conf_threshold = self.height + ANTI_REORG_DELAY - 1;
344 OnchainEvent::MaturingOutput {
345 descriptor: SpendableOutputDescriptor::DelayedPaymentOutput(ref descriptor)
347 // A CSV'd transaction is confirmable in block (input height) + CSV delay, which means
348 // it's broadcastable when we see the previous block.
349 conf_threshold = cmp::max(conf_threshold, self.height + descriptor.to_self_delay as u32 - 1);
351 OnchainEvent::FundingSpendConfirmation { on_local_output_csv: Some(csv), .. } |
352 OnchainEvent::HTLCSpendConfirmation { on_to_local_output_csv: Some(csv), .. } => {
353 // A CSV'd transaction is confirmable in block (input height) + CSV delay, which means
354 // it's broadcastable when we see the previous block.
355 conf_threshold = cmp::max(conf_threshold, self.height + csv as u32 - 1);
362 fn has_reached_confirmation_threshold(&self, best_block: &BestBlock) -> bool {
363 best_block.height() >= self.confirmation_threshold()
367 /// The (output index, sats value) for the counterparty's output in a commitment transaction.
369 /// This was added as an `Option` in 0.0.110.
370 type CommitmentTxCounterpartyOutputInfo = Option<(u32, u64)>;
372 /// Upon discovering of some classes of onchain tx by ChannelMonitor, we may have to take actions on it
373 /// once they mature to enough confirmations (ANTI_REORG_DELAY)
374 #[derive(Clone, PartialEq, Eq)]
376 /// An outbound HTLC failing after a transaction is confirmed. Used
377 /// * when an outbound HTLC output is spent by us after the HTLC timed out
378 /// * an outbound HTLC which was not present in the commitment transaction which appeared
379 /// on-chain (either because it was not fully committed to or it was dust).
380 /// Note that this is *not* used for preimage claims, as those are passed upstream immediately,
381 /// appearing only as an `HTLCSpendConfirmation`, below.
384 payment_hash: PaymentHash,
385 htlc_value_satoshis: Option<u64>,
386 /// None in the second case, above, ie when there is no relevant output in the commitment
387 /// transaction which appeared on chain.
388 commitment_tx_output_idx: Option<u32>,
390 /// An output waiting on [`ANTI_REORG_DELAY`] confirmations before we hand the user the
391 /// [`SpendableOutputDescriptor`].
393 descriptor: SpendableOutputDescriptor,
395 /// A spend of the funding output, either a commitment transaction or a cooperative closing
397 FundingSpendConfirmation {
398 /// The CSV delay for the output of the funding spend transaction (implying it is a local
399 /// commitment transaction, and this is the delay on the to_self output).
400 on_local_output_csv: Option<u16>,
401 /// If the funding spend transaction was a known remote commitment transaction, we track
402 /// the output index and amount of the counterparty's `to_self` output here.
404 /// This allows us to generate a [`Balance::CounterpartyRevokedOutputClaimable`] for the
405 /// counterparty output.
406 commitment_tx_to_counterparty_output: CommitmentTxCounterpartyOutputInfo,
408 /// A spend of a commitment transaction HTLC output, set in the cases where *no* `HTLCUpdate`
409 /// is constructed. This is used when
410 /// * an outbound HTLC is claimed by our counterparty with a preimage, causing us to
411 /// immediately claim the HTLC on the inbound edge and track the resolution here,
412 /// * an inbound HTLC is claimed by our counterparty (with a timeout),
413 /// * an inbound HTLC is claimed by us (with a preimage).
414 /// * a revoked-state HTLC transaction was broadcasted, which was claimed by the revocation
416 /// * a revoked-state HTLC transaction was broadcasted, which was claimed by an
417 /// HTLC-Success/HTLC-Failure transaction (and is still claimable with a revocation
419 HTLCSpendConfirmation {
420 commitment_tx_output_idx: u32,
421 /// If the claim was made by either party with a preimage, this is filled in
422 preimage: Option<PaymentPreimage>,
423 /// If the claim was made by us on an inbound HTLC against a local commitment transaction,
424 /// we set this to the output CSV value which we will have to wait until to spend the
425 /// output (and generate a SpendableOutput event).
426 on_to_local_output_csv: Option<u16>,
430 impl Writeable for OnchainEventEntry {
431 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
432 write_tlv_fields!(writer, {
433 (0, self.txid, required),
434 (1, self.transaction, option),
435 (2, self.height, required),
436 (3, self.block_hash, option),
437 (4, self.event, required),
443 impl MaybeReadable for OnchainEventEntry {
444 fn read<R: io::Read>(reader: &mut R) -> Result<Option<Self>, DecodeError> {
445 let mut txid = Txid::all_zeros();
446 let mut transaction = None;
447 let mut block_hash = None;
449 let mut event = UpgradableRequired(None);
450 read_tlv_fields!(reader, {
452 (1, transaction, option),
453 (2, height, required),
454 (3, block_hash, option),
455 (4, event, upgradable_required),
457 Ok(Some(Self { txid, transaction, height, block_hash, event: _init_tlv_based_struct_field!(event, upgradable_required) }))
461 impl_writeable_tlv_based_enum_upgradable!(OnchainEvent,
463 (0, source, required),
464 (1, htlc_value_satoshis, option),
465 (2, payment_hash, required),
466 (3, commitment_tx_output_idx, option),
468 (1, MaturingOutput) => {
469 (0, descriptor, required),
471 (3, FundingSpendConfirmation) => {
472 (0, on_local_output_csv, option),
473 (1, commitment_tx_to_counterparty_output, option),
475 (5, HTLCSpendConfirmation) => {
476 (0, commitment_tx_output_idx, required),
477 (2, preimage, option),
478 (4, on_to_local_output_csv, option),
483 #[derive(Clone, Debug, PartialEq, Eq)]
484 pub(crate) enum ChannelMonitorUpdateStep {
485 LatestHolderCommitmentTXInfo {
486 commitment_tx: HolderCommitmentTransaction,
487 /// Note that LDK after 0.0.115 supports this only containing dust HTLCs (implying the
488 /// `Signature` field is never filled in). At that point, non-dust HTLCs are implied by the
489 /// HTLC fields in `commitment_tx` and the sources passed via `nondust_htlc_sources`.
490 htlc_outputs: Vec<(HTLCOutputInCommitment, Option<Signature>, Option<HTLCSource>)>,
491 claimed_htlcs: Vec<(SentHTLCId, PaymentPreimage)>,
492 nondust_htlc_sources: Vec<HTLCSource>,
494 LatestCounterpartyCommitmentTXInfo {
495 commitment_txid: Txid,
496 htlc_outputs: Vec<(HTLCOutputInCommitment, Option<Box<HTLCSource>>)>,
497 commitment_number: u64,
498 their_per_commitment_point: PublicKey,
499 feerate_per_kw: Option<u32>,
500 to_broadcaster_value_sat: Option<u64>,
501 to_countersignatory_value_sat: Option<u64>,
504 payment_preimage: PaymentPreimage,
510 /// Used to indicate that the no future updates will occur, and likely that the latest holder
511 /// commitment transaction(s) should be broadcast, as the channel has been force-closed.
513 /// If set to false, we shouldn't broadcast the latest holder commitment transaction as we
514 /// think we've fallen behind!
515 should_broadcast: bool,
518 scriptpubkey: Script,
522 impl ChannelMonitorUpdateStep {
523 fn variant_name(&self) -> &'static str {
525 ChannelMonitorUpdateStep::LatestHolderCommitmentTXInfo { .. } => "LatestHolderCommitmentTXInfo",
526 ChannelMonitorUpdateStep::LatestCounterpartyCommitmentTXInfo { .. } => "LatestCounterpartyCommitmentTXInfo",
527 ChannelMonitorUpdateStep::PaymentPreimage { .. } => "PaymentPreimage",
528 ChannelMonitorUpdateStep::CommitmentSecret { .. } => "CommitmentSecret",
529 ChannelMonitorUpdateStep::ChannelForceClosed { .. } => "ChannelForceClosed",
530 ChannelMonitorUpdateStep::ShutdownScript { .. } => "ShutdownScript",
535 impl_writeable_tlv_based_enum_upgradable!(ChannelMonitorUpdateStep,
536 (0, LatestHolderCommitmentTXInfo) => {
537 (0, commitment_tx, required),
538 (1, claimed_htlcs, optional_vec),
539 (2, htlc_outputs, required_vec),
540 (4, nondust_htlc_sources, optional_vec),
542 (1, LatestCounterpartyCommitmentTXInfo) => {
543 (0, commitment_txid, required),
544 (1, feerate_per_kw, option),
545 (2, commitment_number, required),
546 (3, to_broadcaster_value_sat, option),
547 (4, their_per_commitment_point, required),
548 (5, to_countersignatory_value_sat, option),
549 (6, htlc_outputs, required_vec),
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 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 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 amount_satoshis: u64,
602 /// The height at which the counterparty may be able to claim the balance if we have not
605 /// The payment hash that locks this HTLC.
606 payment_hash: PaymentHash,
607 /// The preimage that can be used to claim this HTLC.
608 payment_preimage: PaymentPreimage,
610 /// HTLCs which we sent to our counterparty which are claimable after a timeout (less on-chain
611 /// fees) if the counterparty does not know the preimage for the HTLCs. These are somewhat
612 /// likely to be claimed by our counterparty before we do.
613 MaybeTimeoutClaimableHTLC {
614 /// The amount potentially available to claim, in satoshis, excluding the on-chain fees
615 /// which will be required to do so.
616 amount_satoshis: u64,
617 /// The height at which we will be able to claim the balance if our counterparty has not
619 claimable_height: u32,
620 /// The payment hash whose preimage our counterparty needs to claim this HTLC.
621 payment_hash: PaymentHash,
623 /// HTLCs which we received from our counterparty which are claimable with a preimage which we
624 /// do not currently have. This will only be claimable if we receive the preimage from the node
625 /// to which we forwarded this HTLC before the timeout.
626 MaybePreimageClaimableHTLC {
627 /// The amount potentially available to claim, in satoshis, excluding the on-chain fees
628 /// which will be required to do so.
629 amount_satoshis: u64,
630 /// The height at which our counterparty will be able to claim the balance if we have not
631 /// yet received the preimage and claimed it ourselves.
633 /// The payment hash whose preimage we need to claim this HTLC.
634 payment_hash: PaymentHash,
636 /// The channel has been closed, and our counterparty broadcasted a revoked commitment
639 /// Thus, we're able to claim all outputs in the commitment transaction, one of which has the
640 /// following amount.
641 CounterpartyRevokedOutputClaimable {
642 /// The amount, in satoshis, of the output which we can claim.
644 /// Note that for outputs from HTLC balances this may be excluding some on-chain fees that
645 /// were already spent.
646 amount_satoshis: u64,
651 /// The amount claimable, in satoshis. This excludes balances that we are unsure if we are able
652 /// to claim, this is because we are waiting for a preimage or for a timeout to expire. For more
653 /// information on these balances see [`Balance::MaybeTimeoutClaimableHTLC`] and
654 /// [`Balance::MaybePreimageClaimableHTLC`].
656 /// On-chain fees required to claim the balance are not included in this amount.
657 pub fn claimable_amount_satoshis(&self) -> u64 {
659 Balance::ClaimableOnChannelClose { amount_satoshis, .. }|
660 Balance::ClaimableAwaitingConfirmations { amount_satoshis, .. }|
661 Balance::ContentiousClaimable { amount_satoshis, .. }|
662 Balance::CounterpartyRevokedOutputClaimable { amount_satoshis, .. }
664 Balance::MaybeTimeoutClaimableHTLC { .. }|
665 Balance::MaybePreimageClaimableHTLC { .. }
671 /// An HTLC which has been irrevocably resolved on-chain, and has reached ANTI_REORG_DELAY.
672 #[derive(Clone, PartialEq, Eq)]
673 struct IrrevocablyResolvedHTLC {
674 commitment_tx_output_idx: Option<u32>,
675 /// The txid of the transaction which resolved the HTLC, this may be a commitment (if the HTLC
676 /// was not present in the confirmed commitment transaction), HTLC-Success, or HTLC-Timeout
678 resolving_txid: Option<Txid>, // Added as optional, but always filled in, in 0.0.110
679 resolving_tx: Option<Transaction>,
680 /// Only set if the HTLC claim was ours using a payment preimage
681 payment_preimage: Option<PaymentPreimage>,
684 // In LDK versions prior to 0.0.111 commitment_tx_output_idx was not Option-al and
685 // IrrevocablyResolvedHTLC objects only existed for non-dust HTLCs. This was a bug, but to maintain
686 // backwards compatibility we must ensure we always write out a commitment_tx_output_idx field,
687 // using `u32::max_value()` as a sentinal to indicate the HTLC was dust.
688 impl Writeable for IrrevocablyResolvedHTLC {
689 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
690 let mapped_commitment_tx_output_idx = self.commitment_tx_output_idx.unwrap_or(u32::max_value());
691 write_tlv_fields!(writer, {
692 (0, mapped_commitment_tx_output_idx, required),
693 (1, self.resolving_txid, option),
694 (2, self.payment_preimage, option),
695 (3, self.resolving_tx, option),
701 impl Readable for IrrevocablyResolvedHTLC {
702 fn read<R: io::Read>(reader: &mut R) -> Result<Self, DecodeError> {
703 let mut mapped_commitment_tx_output_idx = 0;
704 let mut resolving_txid = None;
705 let mut payment_preimage = None;
706 let mut resolving_tx = None;
707 read_tlv_fields!(reader, {
708 (0, mapped_commitment_tx_output_idx, required),
709 (1, resolving_txid, option),
710 (2, payment_preimage, option),
711 (3, resolving_tx, option),
714 commitment_tx_output_idx: if mapped_commitment_tx_output_idx == u32::max_value() { None } else { Some(mapped_commitment_tx_output_idx) },
722 /// A ChannelMonitor handles chain events (blocks connected and disconnected) and generates
723 /// on-chain transactions to ensure no loss of funds occurs.
725 /// You MUST ensure that no ChannelMonitors for a given channel anywhere contain out-of-date
726 /// information and are actively monitoring the chain.
728 /// Note that the deserializer is only implemented for (BlockHash, ChannelMonitor), which
729 /// tells you the last block hash which was block_connect()ed. You MUST rescan any blocks along
730 /// the "reorg path" (ie disconnecting blocks until you find a common ancestor from both the
731 /// returned block hash and the the current chain and then reconnecting blocks to get to the
732 /// best chain) upon deserializing the object!
733 pub struct ChannelMonitor<Signer: WriteableEcdsaChannelSigner> {
735 pub(crate) inner: Mutex<ChannelMonitorImpl<Signer>>,
737 pub(super) inner: Mutex<ChannelMonitorImpl<Signer>>,
740 impl<Signer: WriteableEcdsaChannelSigner> Clone for ChannelMonitor<Signer> where Signer: Clone {
741 fn clone(&self) -> Self {
742 let inner = self.inner.lock().unwrap().clone();
743 ChannelMonitor::from_impl(inner)
747 #[derive(Clone, PartialEq)]
748 pub(crate) struct ChannelMonitorImpl<Signer: WriteableEcdsaChannelSigner> {
749 latest_update_id: u64,
750 commitment_transaction_number_obscure_factor: u64,
752 destination_script: Script,
753 broadcasted_holder_revokable_script: Option<(Script, PublicKey, PublicKey)>,
754 counterparty_payment_script: Script,
755 shutdown_script: Option<Script>,
757 channel_keys_id: [u8; 32],
758 holder_revocation_basepoint: PublicKey,
759 funding_info: (OutPoint, Script),
760 current_counterparty_commitment_txid: Option<Txid>,
761 prev_counterparty_commitment_txid: Option<Txid>,
763 counterparty_commitment_params: CounterpartyCommitmentParameters,
764 funding_redeemscript: Script,
765 channel_value_satoshis: u64,
766 // first is the idx of the first of the two per-commitment points
767 their_cur_per_commitment_points: Option<(u64, PublicKey, Option<PublicKey>)>,
769 on_holder_tx_csv: u16,
771 commitment_secrets: CounterpartyCommitmentSecrets,
772 /// The set of outpoints in each counterparty commitment transaction. We always need at least
773 /// the payment hash from `HTLCOutputInCommitment` to claim even a revoked commitment
774 /// transaction broadcast as we need to be able to construct the witness script in all cases.
775 counterparty_claimable_outpoints: HashMap<Txid, Vec<(HTLCOutputInCommitment, Option<Box<HTLCSource>>)>>,
776 /// We cannot identify HTLC-Success or HTLC-Timeout transactions by themselves on the chain.
777 /// Nor can we figure out their commitment numbers without the commitment transaction they are
778 /// spending. Thus, in order to claim them via revocation key, we track all the counterparty
779 /// commitment transactions which we find on-chain, mapping them to the commitment number which
780 /// can be used to derive the revocation key and claim the transactions.
781 counterparty_commitment_txn_on_chain: HashMap<Txid, u64>,
782 /// Cache used to make pruning of payment_preimages faster.
783 /// Maps payment_hash values to commitment numbers for counterparty transactions for non-revoked
784 /// counterparty transactions (ie should remain pretty small).
785 /// Serialized to disk but should generally not be sent to Watchtowers.
786 counterparty_hash_commitment_number: HashMap<PaymentHash, u64>,
788 counterparty_fulfilled_htlcs: HashMap<SentHTLCId, PaymentPreimage>,
790 // We store two holder commitment transactions to avoid any race conditions where we may update
791 // some monitors (potentially on watchtowers) but then fail to update others, resulting in the
792 // various monitors for one channel being out of sync, and us broadcasting a holder
793 // transaction for which we have deleted claim information on some watchtowers.
794 prev_holder_signed_commitment_tx: Option<HolderSignedTx>,
795 current_holder_commitment_tx: HolderSignedTx,
797 // Used just for ChannelManager to make sure it has the latest channel data during
799 current_counterparty_commitment_number: u64,
800 // Used just for ChannelManager to make sure it has the latest channel data during
802 current_holder_commitment_number: u64,
804 /// The set of payment hashes from inbound payments for which we know the preimage. Payment
805 /// preimages that are not included in any unrevoked local commitment transaction or unrevoked
806 /// remote commitment transactions are automatically removed when commitment transactions are
808 payment_preimages: HashMap<PaymentHash, PaymentPreimage>,
810 // Note that `MonitorEvent`s MUST NOT be generated during update processing, only generated
811 // during chain data processing. This prevents a race in `ChainMonitor::update_channel` (and
812 // presumably user implementations thereof as well) where we update the in-memory channel
813 // object, then before the persistence finishes (as it's all under a read-lock), we return
814 // pending events to the user or to the relevant `ChannelManager`. Then, on reload, we'll have
815 // the pre-event state here, but have processed the event in the `ChannelManager`.
816 // Note that because the `event_lock` in `ChainMonitor` is only taken in
817 // block/transaction-connected events and *not* during block/transaction-disconnected events,
818 // we further MUST NOT generate events during block/transaction-disconnection.
819 pending_monitor_events: Vec<MonitorEvent>,
821 pub(super) pending_events: Vec<Event>,
822 pub(super) is_processing_pending_events: bool,
824 // Used to track on-chain events (i.e., transactions part of channels confirmed on chain) on
825 // which to take actions once they reach enough confirmations. Each entry includes the
826 // transaction's id and the height when the transaction was confirmed on chain.
827 onchain_events_awaiting_threshold_conf: Vec<OnchainEventEntry>,
829 // If we get serialized out and re-read, we need to make sure that the chain monitoring
830 // interface knows about the TXOs that we want to be notified of spends of. We could probably
831 // be smart and derive them from the above storage fields, but its much simpler and more
832 // Obviously Correct (tm) if we just keep track of them explicitly.
833 outputs_to_watch: HashMap<Txid, Vec<(u32, Script)>>,
836 pub onchain_tx_handler: OnchainTxHandler<Signer>,
838 onchain_tx_handler: OnchainTxHandler<Signer>,
840 // This is set when the Channel[Manager] generated a ChannelMonitorUpdate which indicated the
841 // channel has been force-closed. After this is set, no further holder commitment transaction
842 // updates may occur, and we panic!() if one is provided.
843 lockdown_from_offchain: bool,
845 // Set once we've signed a holder commitment transaction and handed it over to our
846 // OnchainTxHandler. After this is set, no future updates to our holder commitment transactions
847 // may occur, and we fail any such monitor updates.
849 // In case of update rejection due to a locally already signed commitment transaction, we
850 // nevertheless store update content to track in case of concurrent broadcast by another
851 // remote monitor out-of-order with regards to the block view.
852 holder_tx_signed: bool,
854 // If a spend of the funding output is seen, we set this to true and reject any further
855 // updates. This prevents any further changes in the offchain state no matter the order
856 // of block connection between ChannelMonitors and the ChannelManager.
857 funding_spend_seen: bool,
859 /// Set to `Some` of the confirmed transaction spending the funding input of the channel after
860 /// reaching `ANTI_REORG_DELAY` confirmations.
861 funding_spend_confirmed: Option<Txid>,
863 confirmed_commitment_tx_counterparty_output: CommitmentTxCounterpartyOutputInfo,
864 /// The set of HTLCs which have been either claimed or failed on chain and have reached
865 /// the requisite confirmations on the claim/fail transaction (either ANTI_REORG_DELAY or the
866 /// spending CSV for revocable outputs).
867 htlcs_resolved_on_chain: Vec<IrrevocablyResolvedHTLC>,
869 /// The set of `SpendableOutput` events which we have already passed upstream to be claimed.
870 /// These are tracked explicitly to ensure that we don't generate the same events redundantly
871 /// if users duplicatively confirm old transactions. Specifically for transactions claiming a
872 /// revoked remote outpoint we otherwise have no tracking at all once they've reached
873 /// [`ANTI_REORG_DELAY`], so we have to track them here.
874 spendable_txids_confirmed: Vec<Txid>,
876 // We simply modify best_block in Channel's block_connected so that serialization is
877 // consistent but hopefully the users' copy handles block_connected in a consistent way.
878 // (we do *not*, however, update them in update_monitor to ensure any local user copies keep
879 // their best_block from its state and not based on updated copies that didn't run through
880 // the full block_connected).
881 best_block: BestBlock,
883 /// The node_id of our counterparty
884 counterparty_node_id: Option<PublicKey>,
886 /// Initial counterparty commmitment data needed to recreate the commitment tx
887 /// in the persistence pipeline for third-party watchtowers. This will only be present on
888 /// monitors created after 0.0.117.
890 /// Ordering of tuple data: (their_per_commitment_point, feerate_per_kw, to_broadcaster_sats,
891 /// to_countersignatory_sats)
892 initial_counterparty_commitment_info: Option<(PublicKey, u32, u64, u64)>,
895 /// Transaction outputs to watch for on-chain spends.
896 pub type TransactionOutputs = (Txid, Vec<(u32, TxOut)>);
898 impl<Signer: WriteableEcdsaChannelSigner> PartialEq for ChannelMonitor<Signer> where Signer: PartialEq {
899 fn eq(&self, other: &Self) -> bool {
900 // We need some kind of total lockorder. Absent a better idea, we sort by position in
901 // memory and take locks in that order (assuming that we can't move within memory while a
903 let ord = ((self as *const _) as usize) < ((other as *const _) as usize);
904 let a = if ord { self.inner.unsafe_well_ordered_double_lock_self() } else { other.inner.unsafe_well_ordered_double_lock_self() };
905 let b = if ord { other.inner.unsafe_well_ordered_double_lock_self() } else { self.inner.unsafe_well_ordered_double_lock_self() };
910 impl<Signer: WriteableEcdsaChannelSigner> Writeable for ChannelMonitor<Signer> {
911 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), Error> {
912 self.inner.lock().unwrap().write(writer)
916 // These are also used for ChannelMonitorUpdate, above.
917 const SERIALIZATION_VERSION: u8 = 1;
918 const MIN_SERIALIZATION_VERSION: u8 = 1;
920 impl<Signer: WriteableEcdsaChannelSigner> Writeable for ChannelMonitorImpl<Signer> {
921 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), Error> {
922 write_ver_prefix!(writer, SERIALIZATION_VERSION, MIN_SERIALIZATION_VERSION);
924 self.latest_update_id.write(writer)?;
926 // Set in initial Channel-object creation, so should always be set by now:
927 U48(self.commitment_transaction_number_obscure_factor).write(writer)?;
929 self.destination_script.write(writer)?;
930 if let Some(ref broadcasted_holder_revokable_script) = self.broadcasted_holder_revokable_script {
931 writer.write_all(&[0; 1])?;
932 broadcasted_holder_revokable_script.0.write(writer)?;
933 broadcasted_holder_revokable_script.1.write(writer)?;
934 broadcasted_holder_revokable_script.2.write(writer)?;
936 writer.write_all(&[1; 1])?;
939 self.counterparty_payment_script.write(writer)?;
940 match &self.shutdown_script {
941 Some(script) => script.write(writer)?,
942 None => Script::new().write(writer)?,
945 self.channel_keys_id.write(writer)?;
946 self.holder_revocation_basepoint.write(writer)?;
947 writer.write_all(&self.funding_info.0.txid[..])?;
948 writer.write_all(&self.funding_info.0.index.to_be_bytes())?;
949 self.funding_info.1.write(writer)?;
950 self.current_counterparty_commitment_txid.write(writer)?;
951 self.prev_counterparty_commitment_txid.write(writer)?;
953 self.counterparty_commitment_params.write(writer)?;
954 self.funding_redeemscript.write(writer)?;
955 self.channel_value_satoshis.write(writer)?;
957 match self.their_cur_per_commitment_points {
958 Some((idx, pubkey, second_option)) => {
959 writer.write_all(&byte_utils::be48_to_array(idx))?;
960 writer.write_all(&pubkey.serialize())?;
961 match second_option {
962 Some(second_pubkey) => {
963 writer.write_all(&second_pubkey.serialize())?;
966 writer.write_all(&[0; 33])?;
971 writer.write_all(&byte_utils::be48_to_array(0))?;
975 writer.write_all(&self.on_holder_tx_csv.to_be_bytes())?;
977 self.commitment_secrets.write(writer)?;
979 macro_rules! serialize_htlc_in_commitment {
980 ($htlc_output: expr) => {
981 writer.write_all(&[$htlc_output.offered as u8; 1])?;
982 writer.write_all(&$htlc_output.amount_msat.to_be_bytes())?;
983 writer.write_all(&$htlc_output.cltv_expiry.to_be_bytes())?;
984 writer.write_all(&$htlc_output.payment_hash.0[..])?;
985 $htlc_output.transaction_output_index.write(writer)?;
989 writer.write_all(&(self.counterparty_claimable_outpoints.len() as u64).to_be_bytes())?;
990 for (ref txid, ref htlc_infos) in self.counterparty_claimable_outpoints.iter() {
991 writer.write_all(&txid[..])?;
992 writer.write_all(&(htlc_infos.len() as u64).to_be_bytes())?;
993 for &(ref htlc_output, ref htlc_source) in htlc_infos.iter() {
994 debug_assert!(htlc_source.is_none() || Some(**txid) == self.current_counterparty_commitment_txid
995 || Some(**txid) == self.prev_counterparty_commitment_txid,
996 "HTLC Sources for all revoked commitment transactions should be none!");
997 serialize_htlc_in_commitment!(htlc_output);
998 htlc_source.as_ref().map(|b| b.as_ref()).write(writer)?;
1002 writer.write_all(&(self.counterparty_commitment_txn_on_chain.len() as u64).to_be_bytes())?;
1003 for (ref txid, commitment_number) in self.counterparty_commitment_txn_on_chain.iter() {
1004 writer.write_all(&txid[..])?;
1005 writer.write_all(&byte_utils::be48_to_array(*commitment_number))?;
1008 writer.write_all(&(self.counterparty_hash_commitment_number.len() as u64).to_be_bytes())?;
1009 for (ref payment_hash, commitment_number) in self.counterparty_hash_commitment_number.iter() {
1010 writer.write_all(&payment_hash.0[..])?;
1011 writer.write_all(&byte_utils::be48_to_array(*commitment_number))?;
1014 if let Some(ref prev_holder_tx) = self.prev_holder_signed_commitment_tx {
1015 writer.write_all(&[1; 1])?;
1016 prev_holder_tx.write(writer)?;
1018 writer.write_all(&[0; 1])?;
1021 self.current_holder_commitment_tx.write(writer)?;
1023 writer.write_all(&byte_utils::be48_to_array(self.current_counterparty_commitment_number))?;
1024 writer.write_all(&byte_utils::be48_to_array(self.current_holder_commitment_number))?;
1026 writer.write_all(&(self.payment_preimages.len() as u64).to_be_bytes())?;
1027 for payment_preimage in self.payment_preimages.values() {
1028 writer.write_all(&payment_preimage.0[..])?;
1031 writer.write_all(&(self.pending_monitor_events.iter().filter(|ev| match ev {
1032 MonitorEvent::HTLCEvent(_) => true,
1033 MonitorEvent::HolderForceClosed(_) => true,
1035 }).count() as u64).to_be_bytes())?;
1036 for event in self.pending_monitor_events.iter() {
1038 MonitorEvent::HTLCEvent(upd) => {
1042 MonitorEvent::HolderForceClosed(_) => 1u8.write(writer)?,
1043 _ => {}, // Covered in the TLV writes below
1047 writer.write_all(&(self.pending_events.len() as u64).to_be_bytes())?;
1048 for event in self.pending_events.iter() {
1049 event.write(writer)?;
1052 self.best_block.block_hash().write(writer)?;
1053 writer.write_all(&self.best_block.height().to_be_bytes())?;
1055 writer.write_all(&(self.onchain_events_awaiting_threshold_conf.len() as u64).to_be_bytes())?;
1056 for ref entry in self.onchain_events_awaiting_threshold_conf.iter() {
1057 entry.write(writer)?;
1060 (self.outputs_to_watch.len() as u64).write(writer)?;
1061 for (txid, idx_scripts) in self.outputs_to_watch.iter() {
1062 txid.write(writer)?;
1063 (idx_scripts.len() as u64).write(writer)?;
1064 for (idx, script) in idx_scripts.iter() {
1066 script.write(writer)?;
1069 self.onchain_tx_handler.write(writer)?;
1071 self.lockdown_from_offchain.write(writer)?;
1072 self.holder_tx_signed.write(writer)?;
1074 write_tlv_fields!(writer, {
1075 (1, self.funding_spend_confirmed, option),
1076 (3, self.htlcs_resolved_on_chain, required_vec),
1077 (5, self.pending_monitor_events, required_vec),
1078 (7, self.funding_spend_seen, required),
1079 (9, self.counterparty_node_id, option),
1080 (11, self.confirmed_commitment_tx_counterparty_output, option),
1081 (13, self.spendable_txids_confirmed, required_vec),
1082 (15, self.counterparty_fulfilled_htlcs, required),
1083 (17, self.initial_counterparty_commitment_info, option),
1090 macro_rules! _process_events_body {
1091 ($self_opt: expr, $event_to_handle: expr, $handle_event: expr) => {
1093 let (pending_events, repeated_events);
1094 if let Some(us) = $self_opt {
1095 let mut inner = us.inner.lock().unwrap();
1096 if inner.is_processing_pending_events {
1099 inner.is_processing_pending_events = true;
1101 pending_events = inner.pending_events.clone();
1102 repeated_events = inner.get_repeated_events();
1104 let num_events = pending_events.len();
1106 for event in pending_events.into_iter().chain(repeated_events.into_iter()) {
1107 $event_to_handle = event;
1111 if let Some(us) = $self_opt {
1112 let mut inner = us.inner.lock().unwrap();
1113 inner.pending_events.drain(..num_events);
1114 inner.is_processing_pending_events = false;
1115 if !inner.pending_events.is_empty() {
1116 // If there's more events to process, go ahead and do so.
1124 pub(super) use _process_events_body as process_events_body;
1126 impl<Signer: WriteableEcdsaChannelSigner> ChannelMonitor<Signer> {
1127 /// For lockorder enforcement purposes, we need to have a single site which constructs the
1128 /// `inner` mutex, otherwise cases where we lock two monitors at the same time (eg in our
1129 /// PartialEq implementation) we may decide a lockorder violation has occurred.
1130 fn from_impl(imp: ChannelMonitorImpl<Signer>) -> Self {
1131 ChannelMonitor { inner: Mutex::new(imp) }
1134 pub(crate) fn new(secp_ctx: Secp256k1<secp256k1::All>, keys: Signer, shutdown_script: Option<Script>,
1135 on_counterparty_tx_csv: u16, destination_script: &Script, funding_info: (OutPoint, Script),
1136 channel_parameters: &ChannelTransactionParameters,
1137 funding_redeemscript: Script, channel_value_satoshis: u64,
1138 commitment_transaction_number_obscure_factor: u64,
1139 initial_holder_commitment_tx: HolderCommitmentTransaction,
1140 best_block: BestBlock, counterparty_node_id: PublicKey) -> ChannelMonitor<Signer> {
1142 assert!(commitment_transaction_number_obscure_factor <= (1 << 48));
1143 let counterparty_payment_script = chan_utils::get_counterparty_payment_script(
1144 &channel_parameters.channel_type_features, &keys.pubkeys().payment_point
1147 let counterparty_channel_parameters = channel_parameters.counterparty_parameters.as_ref().unwrap();
1148 let counterparty_delayed_payment_base_key = counterparty_channel_parameters.pubkeys.delayed_payment_basepoint;
1149 let counterparty_htlc_base_key = counterparty_channel_parameters.pubkeys.htlc_basepoint;
1150 let counterparty_commitment_params = CounterpartyCommitmentParameters { counterparty_delayed_payment_base_key, counterparty_htlc_base_key, on_counterparty_tx_csv };
1152 let channel_keys_id = keys.channel_keys_id();
1153 let holder_revocation_basepoint = keys.pubkeys().revocation_basepoint;
1155 // block for Rust 1.34 compat
1156 let (holder_commitment_tx, current_holder_commitment_number) = {
1157 let trusted_tx = initial_holder_commitment_tx.trust();
1158 let txid = trusted_tx.txid();
1160 let tx_keys = trusted_tx.keys();
1161 let holder_commitment_tx = HolderSignedTx {
1163 revocation_key: tx_keys.revocation_key,
1164 a_htlc_key: tx_keys.broadcaster_htlc_key,
1165 b_htlc_key: tx_keys.countersignatory_htlc_key,
1166 delayed_payment_key: tx_keys.broadcaster_delayed_payment_key,
1167 per_commitment_point: tx_keys.per_commitment_point,
1168 htlc_outputs: Vec::new(), // There are never any HTLCs in the initial commitment transactions
1169 to_self_value_sat: initial_holder_commitment_tx.to_broadcaster_value_sat(),
1170 feerate_per_kw: trusted_tx.feerate_per_kw(),
1172 (holder_commitment_tx, trusted_tx.commitment_number())
1175 let onchain_tx_handler =
1176 OnchainTxHandler::new(destination_script.clone(), keys,
1177 channel_parameters.clone(), initial_holder_commitment_tx, secp_ctx);
1179 let mut outputs_to_watch = HashMap::new();
1180 outputs_to_watch.insert(funding_info.0.txid, vec![(funding_info.0.index as u32, funding_info.1.clone())]);
1182 Self::from_impl(ChannelMonitorImpl {
1183 latest_update_id: 0,
1184 commitment_transaction_number_obscure_factor,
1186 destination_script: destination_script.clone(),
1187 broadcasted_holder_revokable_script: None,
1188 counterparty_payment_script,
1192 holder_revocation_basepoint,
1194 current_counterparty_commitment_txid: None,
1195 prev_counterparty_commitment_txid: None,
1197 counterparty_commitment_params,
1198 funding_redeemscript,
1199 channel_value_satoshis,
1200 their_cur_per_commitment_points: None,
1202 on_holder_tx_csv: counterparty_channel_parameters.selected_contest_delay,
1204 commitment_secrets: CounterpartyCommitmentSecrets::new(),
1205 counterparty_claimable_outpoints: HashMap::new(),
1206 counterparty_commitment_txn_on_chain: HashMap::new(),
1207 counterparty_hash_commitment_number: HashMap::new(),
1208 counterparty_fulfilled_htlcs: HashMap::new(),
1210 prev_holder_signed_commitment_tx: None,
1211 current_holder_commitment_tx: holder_commitment_tx,
1212 current_counterparty_commitment_number: 1 << 48,
1213 current_holder_commitment_number,
1215 payment_preimages: HashMap::new(),
1216 pending_monitor_events: Vec::new(),
1217 pending_events: Vec::new(),
1218 is_processing_pending_events: false,
1220 onchain_events_awaiting_threshold_conf: Vec::new(),
1225 lockdown_from_offchain: false,
1226 holder_tx_signed: false,
1227 funding_spend_seen: false,
1228 funding_spend_confirmed: None,
1229 confirmed_commitment_tx_counterparty_output: None,
1230 htlcs_resolved_on_chain: Vec::new(),
1231 spendable_txids_confirmed: Vec::new(),
1234 counterparty_node_id: Some(counterparty_node_id),
1235 initial_counterparty_commitment_info: None,
1240 fn provide_secret(&self, idx: u64, secret: [u8; 32]) -> Result<(), &'static str> {
1241 self.inner.lock().unwrap().provide_secret(idx, secret)
1244 /// A variant of `Self::provide_latest_counterparty_commitment_tx` used to provide
1245 /// additional information to the monitor to store in order to recreate the initial
1246 /// counterparty commitment transaction during persistence (mainly for use in third-party
1249 /// This is used to provide the counterparty commitment information directly to the monitor
1250 /// before the initial persistence of a new channel.
1251 pub(crate) fn provide_initial_counterparty_commitment_tx<L: Deref>(
1252 &self, txid: Txid, htlc_outputs: Vec<(HTLCOutputInCommitment, Option<Box<HTLCSource>>)>,
1253 commitment_number: u64, their_cur_per_commitment_point: PublicKey, feerate_per_kw: u32,
1254 to_broadcaster_value_sat: u64, to_countersignatory_value_sat: u64, logger: &L,
1256 where L::Target: Logger
1258 self.inner.lock().unwrap().provide_initial_counterparty_commitment_tx(txid,
1259 htlc_outputs, commitment_number, their_cur_per_commitment_point, feerate_per_kw,
1260 to_broadcaster_value_sat, to_countersignatory_value_sat, logger);
1263 /// Informs this monitor of the latest counterparty (ie non-broadcastable) commitment transaction.
1264 /// The monitor watches for it to be broadcasted and then uses the HTLC information (and
1265 /// possibly future revocation/preimage information) to claim outputs where possible.
1266 /// We cache also the mapping hash:commitment number to lighten pruning of old preimages by watchtowers.
1268 fn provide_latest_counterparty_commitment_tx<L: Deref>(
1271 htlc_outputs: Vec<(HTLCOutputInCommitment, Option<Box<HTLCSource>>)>,
1272 commitment_number: u64,
1273 their_per_commitment_point: PublicKey,
1275 ) where L::Target: Logger {
1276 self.inner.lock().unwrap().provide_latest_counterparty_commitment_tx(
1277 txid, htlc_outputs, commitment_number, their_per_commitment_point, logger)
1281 fn provide_latest_holder_commitment_tx(
1282 &self, holder_commitment_tx: HolderCommitmentTransaction,
1283 htlc_outputs: Vec<(HTLCOutputInCommitment, Option<Signature>, Option<HTLCSource>)>,
1284 ) -> Result<(), ()> {
1285 self.inner.lock().unwrap().provide_latest_holder_commitment_tx(holder_commitment_tx, htlc_outputs, &Vec::new(), Vec::new()).map_err(|_| ())
1288 /// This is used to provide payment preimage(s) out-of-band during startup without updating the
1289 /// off-chain state with a new commitment transaction.
1290 pub(crate) fn provide_payment_preimage<B: Deref, F: Deref, L: Deref>(
1292 payment_hash: &PaymentHash,
1293 payment_preimage: &PaymentPreimage,
1295 fee_estimator: &LowerBoundedFeeEstimator<F>,
1298 B::Target: BroadcasterInterface,
1299 F::Target: FeeEstimator,
1302 self.inner.lock().unwrap().provide_payment_preimage(
1303 payment_hash, payment_preimage, broadcaster, fee_estimator, logger)
1306 /// Updates a ChannelMonitor on the basis of some new information provided by the Channel
1309 /// panics if the given update is not the next update by update_id.
1310 pub fn update_monitor<B: Deref, F: Deref, L: Deref>(
1312 updates: &ChannelMonitorUpdate,
1318 B::Target: BroadcasterInterface,
1319 F::Target: FeeEstimator,
1322 self.inner.lock().unwrap().update_monitor(updates, broadcaster, fee_estimator, logger)
1325 /// Gets the update_id from the latest ChannelMonitorUpdate which was applied to this
1327 pub fn get_latest_update_id(&self) -> u64 {
1328 self.inner.lock().unwrap().get_latest_update_id()
1331 /// Gets the funding transaction outpoint of the channel this ChannelMonitor is monitoring for.
1332 pub fn get_funding_txo(&self) -> (OutPoint, Script) {
1333 self.inner.lock().unwrap().get_funding_txo().clone()
1336 /// Gets a list of txids, with their output scripts (in the order they appear in the
1337 /// transaction), which we must learn about spends of via block_connected().
1338 pub fn get_outputs_to_watch(&self) -> Vec<(Txid, Vec<(u32, Script)>)> {
1339 self.inner.lock().unwrap().get_outputs_to_watch()
1340 .iter().map(|(txid, outputs)| (*txid, outputs.clone())).collect()
1343 /// Loads the funding txo and outputs to watch into the given `chain::Filter` by repeatedly
1344 /// calling `chain::Filter::register_output` and `chain::Filter::register_tx` until all outputs
1345 /// have been registered.
1346 pub fn load_outputs_to_watch<F: Deref>(&self, filter: &F) where F::Target: chain::Filter {
1347 let lock = self.inner.lock().unwrap();
1348 filter.register_tx(&lock.get_funding_txo().0.txid, &lock.get_funding_txo().1);
1349 for (txid, outputs) in lock.get_outputs_to_watch().iter() {
1350 for (index, script_pubkey) in outputs.iter() {
1351 assert!(*index <= u16::max_value() as u32);
1352 filter.register_output(WatchedOutput {
1354 outpoint: OutPoint { txid: *txid, index: *index as u16 },
1355 script_pubkey: script_pubkey.clone(),
1361 /// Get the list of HTLCs who's status has been updated on chain. This should be called by
1362 /// ChannelManager via [`chain::Watch::release_pending_monitor_events`].
1363 pub fn get_and_clear_pending_monitor_events(&self) -> Vec<MonitorEvent> {
1364 self.inner.lock().unwrap().get_and_clear_pending_monitor_events()
1367 /// Processes [`SpendableOutputs`] events produced from each [`ChannelMonitor`] upon maturity.
1369 /// For channels featuring anchor outputs, this method will also process [`BumpTransaction`]
1370 /// events produced from each [`ChannelMonitor`] while there is a balance to claim onchain
1371 /// within each channel. As the confirmation of a commitment transaction may be critical to the
1372 /// safety of funds, we recommend invoking this every 30 seconds, or lower if running in an
1373 /// environment with spotty connections, like on mobile.
1375 /// An [`EventHandler`] may safely call back to the provider, though this shouldn't be needed in
1376 /// order to handle these events.
1378 /// [`SpendableOutputs`]: crate::events::Event::SpendableOutputs
1379 /// [`BumpTransaction`]: crate::events::Event::BumpTransaction
1380 pub fn process_pending_events<H: Deref>(&self, handler: &H) where H::Target: EventHandler {
1382 process_events_body!(Some(self), ev, handler.handle_event(ev));
1385 /// Processes any events asynchronously.
1387 /// See [`Self::process_pending_events`] for more information.
1388 pub async fn process_pending_events_async<Future: core::future::Future, H: Fn(Event) -> Future>(
1392 process_events_body!(Some(self), ev, { handler(ev).await });
1396 pub fn get_and_clear_pending_events(&self) -> Vec<Event> {
1397 let mut ret = Vec::new();
1398 let mut lck = self.inner.lock().unwrap();
1399 mem::swap(&mut ret, &mut lck.pending_events);
1400 ret.append(&mut lck.get_repeated_events());
1404 /// Gets the counterparty's initial commitment transaction. The returned commitment
1405 /// transaction is unsigned. This is intended to be called during the initial persistence of
1406 /// the monitor (inside an implementation of [`Persist::persist_new_channel`]), to allow for
1407 /// watchtowers in the persistence pipeline to have enough data to form justice transactions.
1409 /// This is similar to [`Self::counterparty_commitment_txs_from_update`], except
1410 /// that for the initial commitment transaction, we don't have a corresponding update.
1412 /// This will only return `Some` for channel monitors that have been created after upgrading
1413 /// to LDK 0.0.117+.
1415 /// [`Persist::persist_new_channel`]: crate::chain::chainmonitor::Persist::persist_new_channel
1416 pub fn initial_counterparty_commitment_tx(&self) -> Option<CommitmentTransaction> {
1417 self.inner.lock().unwrap().initial_counterparty_commitment_tx()
1420 /// Gets all of the counterparty commitment transactions provided by the given update. This
1421 /// may be empty if the update doesn't include any new counterparty commitments. Returned
1422 /// commitment transactions are unsigned.
1424 /// This is provided so that watchtower clients in the persistence pipeline are able to build
1425 /// justice transactions for each counterparty commitment upon each update. It's intended to be
1426 /// used within an implementation of [`Persist::update_persisted_channel`], which is provided
1427 /// with a monitor and an update. Once revoked, signing a justice transaction can be done using
1428 /// [`Self::sign_to_local_justice_tx`].
1430 /// It is expected that a watchtower client may use this method to retrieve the latest counterparty
1431 /// commitment transaction(s), and then hold the necessary data until a later update in which
1432 /// the monitor has been updated with the corresponding revocation data, at which point the
1433 /// monitor can sign the justice transaction.
1435 /// This will only return a non-empty list for monitor updates that have been created after
1436 /// upgrading to LDK 0.0.117+. Note that no restriction lies on the monitors themselves, which
1437 /// may have been created prior to upgrading.
1439 /// [`Persist::update_persisted_channel`]: crate::chain::chainmonitor::Persist::update_persisted_channel
1440 pub fn counterparty_commitment_txs_from_update(&self, update: &ChannelMonitorUpdate) -> Vec<CommitmentTransaction> {
1441 self.inner.lock().unwrap().counterparty_commitment_txs_from_update(update)
1444 /// Wrapper around [`EcdsaChannelSigner::sign_justice_revoked_output`] to make
1445 /// signing the justice transaction easier for implementors of
1446 /// [`chain::chainmonitor::Persist`]. On success this method returns the provided transaction
1447 /// signing the input at `input_idx`. This method will only produce a valid signature for
1448 /// a transaction spending the `to_local` output of a commitment transaction, i.e. this cannot
1449 /// be used for revoked HTLC outputs.
1451 /// `Value` is the value of the output being spent by the input at `input_idx`, committed
1452 /// in the BIP 143 signature.
1454 /// This method will only succeed if this monitor has received the revocation secret for the
1455 /// provided `commitment_number`. If a commitment number is provided that does not correspond
1456 /// to the commitment transaction being revoked, this will return a signed transaction, but
1457 /// the signature will not be valid.
1459 /// [`EcdsaChannelSigner::sign_justice_revoked_output`]: crate::sign::EcdsaChannelSigner::sign_justice_revoked_output
1460 /// [`Persist`]: crate::chain::chainmonitor::Persist
1461 pub fn sign_to_local_justice_tx(&self, justice_tx: Transaction, input_idx: usize, value: u64, commitment_number: u64) -> Result<Transaction, ()> {
1462 self.inner.lock().unwrap().sign_to_local_justice_tx(justice_tx, input_idx, value, commitment_number)
1465 pub(crate) fn get_min_seen_secret(&self) -> u64 {
1466 self.inner.lock().unwrap().get_min_seen_secret()
1469 pub(crate) fn get_cur_counterparty_commitment_number(&self) -> u64 {
1470 self.inner.lock().unwrap().get_cur_counterparty_commitment_number()
1473 pub(crate) fn get_cur_holder_commitment_number(&self) -> u64 {
1474 self.inner.lock().unwrap().get_cur_holder_commitment_number()
1477 /// Gets the `node_id` of the counterparty for this channel.
1479 /// Will be `None` for channels constructed on LDK versions prior to 0.0.110 and always `Some`
1481 pub fn get_counterparty_node_id(&self) -> Option<PublicKey> {
1482 self.inner.lock().unwrap().counterparty_node_id
1485 /// Used by [`ChannelManager`] deserialization to broadcast the latest holder state if its copy
1486 /// of the channel state was out-of-date.
1488 /// You may also use this to broadcast the latest local commitment transaction, either because
1489 /// a monitor update failed or because we've fallen behind (i.e. we've received proof that our
1490 /// counterparty side knows a revocation secret we gave them that they shouldn't know).
1492 /// Broadcasting these transactions in the second case is UNSAFE, as they allow counterparty
1493 /// side to punish you. Nevertheless you may want to broadcast them if counterparty doesn't
1494 /// close channel with their commitment transaction after a substantial amount of time. Best
1495 /// may be to contact the other node operator out-of-band to coordinate other options available
1498 /// [`ChannelManager`]: crate::ln::channelmanager::ChannelManager
1499 pub fn get_latest_holder_commitment_txn<L: Deref>(&self, logger: &L) -> Vec<Transaction>
1500 where L::Target: Logger {
1501 self.inner.lock().unwrap().get_latest_holder_commitment_txn(logger)
1504 /// Unsafe test-only version of get_latest_holder_commitment_txn used by our test framework
1505 /// to bypass HolderCommitmentTransaction state update lockdown after signature and generate
1506 /// revoked commitment transaction.
1507 #[cfg(any(test, feature = "unsafe_revoked_tx_signing"))]
1508 pub fn unsafe_get_latest_holder_commitment_txn<L: Deref>(&self, logger: &L) -> Vec<Transaction>
1509 where L::Target: Logger {
1510 self.inner.lock().unwrap().unsafe_get_latest_holder_commitment_txn(logger)
1513 /// Processes transactions in a newly connected block, which may result in any of the following:
1514 /// - update the monitor's state against resolved HTLCs
1515 /// - punish the counterparty in the case of seeing a revoked commitment transaction
1516 /// - force close the channel and claim/timeout incoming/outgoing HTLCs if near expiration
1517 /// - detect settled outputs for later spending
1518 /// - schedule and bump any in-flight claims
1520 /// Returns any new outputs to watch from `txdata`; after called, these are also included in
1521 /// [`get_outputs_to_watch`].
1523 /// [`get_outputs_to_watch`]: #method.get_outputs_to_watch
1524 pub fn block_connected<B: Deref, F: Deref, L: Deref>(
1526 header: &BlockHeader,
1527 txdata: &TransactionData,
1532 ) -> Vec<TransactionOutputs>
1534 B::Target: BroadcasterInterface,
1535 F::Target: FeeEstimator,
1538 self.inner.lock().unwrap().block_connected(
1539 header, txdata, height, broadcaster, fee_estimator, logger)
1542 /// Determines if the disconnected block contained any transactions of interest and updates
1544 pub fn block_disconnected<B: Deref, F: Deref, L: Deref>(
1546 header: &BlockHeader,
1552 B::Target: BroadcasterInterface,
1553 F::Target: FeeEstimator,
1556 self.inner.lock().unwrap().block_disconnected(
1557 header, height, broadcaster, fee_estimator, logger)
1560 /// Processes transactions confirmed in a block with the given header and height, returning new
1561 /// outputs to watch. See [`block_connected`] for details.
1563 /// Used instead of [`block_connected`] by clients that are notified of transactions rather than
1564 /// blocks. See [`chain::Confirm`] for calling expectations.
1566 /// [`block_connected`]: Self::block_connected
1567 pub fn transactions_confirmed<B: Deref, F: Deref, L: Deref>(
1569 header: &BlockHeader,
1570 txdata: &TransactionData,
1575 ) -> Vec<TransactionOutputs>
1577 B::Target: BroadcasterInterface,
1578 F::Target: FeeEstimator,
1581 let bounded_fee_estimator = LowerBoundedFeeEstimator::new(fee_estimator);
1582 self.inner.lock().unwrap().transactions_confirmed(
1583 header, txdata, height, broadcaster, &bounded_fee_estimator, logger)
1586 /// Processes a transaction that was reorganized out of the chain.
1588 /// Used instead of [`block_disconnected`] by clients that are notified of transactions rather
1589 /// than blocks. See [`chain::Confirm`] for calling expectations.
1591 /// [`block_disconnected`]: Self::block_disconnected
1592 pub fn transaction_unconfirmed<B: Deref, F: Deref, L: Deref>(
1599 B::Target: BroadcasterInterface,
1600 F::Target: FeeEstimator,
1603 let bounded_fee_estimator = LowerBoundedFeeEstimator::new(fee_estimator);
1604 self.inner.lock().unwrap().transaction_unconfirmed(
1605 txid, broadcaster, &bounded_fee_estimator, logger);
1608 /// Updates the monitor with the current best chain tip, returning new outputs to watch. See
1609 /// [`block_connected`] for details.
1611 /// Used instead of [`block_connected`] by clients that are notified of transactions rather than
1612 /// blocks. See [`chain::Confirm`] for calling expectations.
1614 /// [`block_connected`]: Self::block_connected
1615 pub fn best_block_updated<B: Deref, F: Deref, L: Deref>(
1617 header: &BlockHeader,
1622 ) -> Vec<TransactionOutputs>
1624 B::Target: BroadcasterInterface,
1625 F::Target: FeeEstimator,
1628 let bounded_fee_estimator = LowerBoundedFeeEstimator::new(fee_estimator);
1629 self.inner.lock().unwrap().best_block_updated(
1630 header, height, broadcaster, &bounded_fee_estimator, logger)
1633 /// Returns the set of txids that should be monitored for re-organization out of the chain.
1634 pub fn get_relevant_txids(&self) -> Vec<(Txid, Option<BlockHash>)> {
1635 let inner = self.inner.lock().unwrap();
1636 let mut txids: Vec<(Txid, Option<BlockHash>)> = inner.onchain_events_awaiting_threshold_conf
1638 .map(|entry| (entry.txid, entry.block_hash))
1639 .chain(inner.onchain_tx_handler.get_relevant_txids().into_iter())
1641 txids.sort_unstable();
1646 /// Gets the latest best block which was connected either via the [`chain::Listen`] or
1647 /// [`chain::Confirm`] interfaces.
1648 pub fn current_best_block(&self) -> BestBlock {
1649 self.inner.lock().unwrap().best_block.clone()
1652 /// Triggers rebroadcasts/fee-bumps of pending claims from a force-closed channel. This is
1653 /// crucial in preventing certain classes of pinning attacks, detecting substantial mempool
1654 /// feerate changes between blocks, and ensuring reliability if broadcasting fails. We recommend
1655 /// invoking this every 30 seconds, or lower if running in an environment with spotty
1656 /// connections, like on mobile.
1657 pub fn rebroadcast_pending_claims<B: Deref, F: Deref, L: Deref>(
1658 &self, broadcaster: B, fee_estimator: F, logger: L,
1661 B::Target: BroadcasterInterface,
1662 F::Target: FeeEstimator,
1665 let fee_estimator = LowerBoundedFeeEstimator::new(fee_estimator);
1666 let mut inner = self.inner.lock().unwrap();
1667 let current_height = inner.best_block.height;
1668 inner.onchain_tx_handler.rebroadcast_pending_claims(
1669 current_height, &broadcaster, &fee_estimator, &logger,
1673 /// Returns the descriptors for relevant outputs (i.e., those that we can spend) within the
1674 /// transaction if they exist and the transaction has at least [`ANTI_REORG_DELAY`]
1675 /// confirmations. For [`SpendableOutputDescriptor::DelayedPaymentOutput`] descriptors to be
1676 /// returned, the transaction must have at least `max(ANTI_REORG_DELAY, to_self_delay)`
1679 /// Descriptors returned by this method are primarily exposed via [`Event::SpendableOutputs`]
1680 /// once they are no longer under reorg risk. This method serves as a way to retrieve these
1681 /// descriptors at a later time, either for historical purposes, or to replay any
1682 /// missed/unhandled descriptors. For the purpose of gathering historical records, if the
1683 /// channel close has fully resolved (i.e., [`ChannelMonitor::get_claimable_balances`] returns
1684 /// an empty set), you can retrieve all spendable outputs by providing all descendant spending
1685 /// transactions starting from the channel's funding transaction and going down three levels.
1687 /// `tx` is a transaction we'll scan the outputs of. Any transaction can be provided. If any
1688 /// outputs which can be spent by us are found, at least one descriptor is returned.
1690 /// `confirmation_height` must be the height of the block in which `tx` was included in.
1691 pub fn get_spendable_outputs(&self, tx: &Transaction, confirmation_height: u32) -> Vec<SpendableOutputDescriptor> {
1692 let inner = self.inner.lock().unwrap();
1693 let current_height = inner.best_block.height;
1694 let mut spendable_outputs = inner.get_spendable_outputs(tx);
1695 spendable_outputs.retain(|descriptor| {
1696 let mut conf_threshold = current_height.saturating_sub(ANTI_REORG_DELAY) + 1;
1697 if let SpendableOutputDescriptor::DelayedPaymentOutput(descriptor) = descriptor {
1698 conf_threshold = cmp::min(conf_threshold,
1699 current_height.saturating_sub(descriptor.to_self_delay as u32) + 1);
1701 conf_threshold >= confirmation_height
1707 pub fn get_counterparty_payment_script(&self) -> Script{
1708 self.inner.lock().unwrap().counterparty_payment_script.clone()
1712 pub fn set_counterparty_payment_script(&self, script: Script) {
1713 self.inner.lock().unwrap().counterparty_payment_script = script;
1717 impl<Signer: WriteableEcdsaChannelSigner> ChannelMonitorImpl<Signer> {
1718 /// Helper for get_claimable_balances which does the work for an individual HTLC, generating up
1719 /// to one `Balance` for the HTLC.
1720 fn get_htlc_balance(&self, htlc: &HTLCOutputInCommitment, holder_commitment: bool,
1721 counterparty_revoked_commitment: bool, confirmed_txid: Option<Txid>)
1722 -> Option<Balance> {
1723 let htlc_commitment_tx_output_idx =
1724 if let Some(v) = htlc.transaction_output_index { v } else { return None; };
1726 let mut htlc_spend_txid_opt = None;
1727 let mut htlc_spend_tx_opt = None;
1728 let mut holder_timeout_spend_pending = None;
1729 let mut htlc_spend_pending = None;
1730 let mut holder_delayed_output_pending = None;
1731 for event in self.onchain_events_awaiting_threshold_conf.iter() {
1733 OnchainEvent::HTLCUpdate { commitment_tx_output_idx, htlc_value_satoshis, .. }
1734 if commitment_tx_output_idx == Some(htlc_commitment_tx_output_idx) => {
1735 debug_assert!(htlc_spend_txid_opt.is_none());
1736 htlc_spend_txid_opt = Some(&event.txid);
1737 debug_assert!(htlc_spend_tx_opt.is_none());
1738 htlc_spend_tx_opt = event.transaction.as_ref();
1739 debug_assert!(holder_timeout_spend_pending.is_none());
1740 debug_assert_eq!(htlc_value_satoshis.unwrap(), htlc.amount_msat / 1000);
1741 holder_timeout_spend_pending = Some(event.confirmation_threshold());
1743 OnchainEvent::HTLCSpendConfirmation { commitment_tx_output_idx, preimage, .. }
1744 if commitment_tx_output_idx == htlc_commitment_tx_output_idx => {
1745 debug_assert!(htlc_spend_txid_opt.is_none());
1746 htlc_spend_txid_opt = Some(&event.txid);
1747 debug_assert!(htlc_spend_tx_opt.is_none());
1748 htlc_spend_tx_opt = event.transaction.as_ref();
1749 debug_assert!(htlc_spend_pending.is_none());
1750 htlc_spend_pending = Some((event.confirmation_threshold(), preimage.is_some()));
1752 OnchainEvent::MaturingOutput {
1753 descriptor: SpendableOutputDescriptor::DelayedPaymentOutput(ref descriptor) }
1754 if descriptor.outpoint.index as u32 == htlc_commitment_tx_output_idx => {
1755 debug_assert!(holder_delayed_output_pending.is_none());
1756 holder_delayed_output_pending = Some(event.confirmation_threshold());
1761 let htlc_resolved = self.htlcs_resolved_on_chain.iter()
1762 .find(|v| if v.commitment_tx_output_idx == Some(htlc_commitment_tx_output_idx) {
1763 debug_assert!(htlc_spend_txid_opt.is_none());
1764 htlc_spend_txid_opt = v.resolving_txid.as_ref();
1765 debug_assert!(htlc_spend_tx_opt.is_none());
1766 htlc_spend_tx_opt = v.resolving_tx.as_ref();
1769 debug_assert!(holder_timeout_spend_pending.is_some() as u8 + htlc_spend_pending.is_some() as u8 + htlc_resolved.is_some() as u8 <= 1);
1771 let htlc_commitment_outpoint = BitcoinOutPoint::new(confirmed_txid.unwrap(), htlc_commitment_tx_output_idx);
1772 let htlc_output_to_spend =
1773 if let Some(txid) = htlc_spend_txid_opt {
1774 // Because HTLC transactions either only have 1 input and 1 output (pre-anchors) or
1775 // are signed with SIGHASH_SINGLE|ANYONECANPAY under BIP-0143 (post-anchors), we can
1776 // locate the correct output by ensuring its adjacent input spends the HTLC output
1777 // in the commitment.
1778 if let Some(ref tx) = htlc_spend_tx_opt {
1779 let htlc_input_idx_opt = tx.input.iter().enumerate()
1780 .find(|(_, input)| input.previous_output == htlc_commitment_outpoint)
1781 .map(|(idx, _)| idx as u32);
1782 debug_assert!(htlc_input_idx_opt.is_some());
1783 BitcoinOutPoint::new(*txid, htlc_input_idx_opt.unwrap_or(0))
1785 debug_assert!(!self.onchain_tx_handler.channel_type_features().supports_anchors_zero_fee_htlc_tx());
1786 BitcoinOutPoint::new(*txid, 0)
1789 htlc_commitment_outpoint
1791 let htlc_output_spend_pending = self.onchain_tx_handler.is_output_spend_pending(&htlc_output_to_spend);
1793 if let Some(conf_thresh) = holder_delayed_output_pending {
1794 debug_assert!(holder_commitment);
1795 return Some(Balance::ClaimableAwaitingConfirmations {
1796 amount_satoshis: htlc.amount_msat / 1000,
1797 confirmation_height: conf_thresh,
1799 } else if htlc_resolved.is_some() && !htlc_output_spend_pending {
1800 // Funding transaction spends should be fully confirmed by the time any
1801 // HTLC transactions are resolved, unless we're talking about a holder
1802 // commitment tx, whose resolution is delayed until the CSV timeout is
1803 // reached, even though HTLCs may be resolved after only
1804 // ANTI_REORG_DELAY confirmations.
1805 debug_assert!(holder_commitment || self.funding_spend_confirmed.is_some());
1806 } else if counterparty_revoked_commitment {
1807 let htlc_output_claim_pending = self.onchain_events_awaiting_threshold_conf.iter().find_map(|event| {
1808 if let OnchainEvent::MaturingOutput {
1809 descriptor: SpendableOutputDescriptor::StaticOutput { .. }
1811 if event.transaction.as_ref().map(|tx| tx.input.iter().any(|inp| {
1812 if let Some(htlc_spend_txid) = htlc_spend_txid_opt {
1813 tx.txid() == *htlc_spend_txid || inp.previous_output.txid == *htlc_spend_txid
1815 Some(inp.previous_output.txid) == confirmed_txid &&
1816 inp.previous_output.vout == htlc_commitment_tx_output_idx
1818 })).unwrap_or(false) {
1823 if htlc_output_claim_pending.is_some() {
1824 // We already push `Balance`s onto the `res` list for every
1825 // `StaticOutput` in a `MaturingOutput` in the revoked
1826 // counterparty commitment transaction case generally, so don't
1827 // need to do so again here.
1829 debug_assert!(holder_timeout_spend_pending.is_none(),
1830 "HTLCUpdate OnchainEvents should never appear for preimage claims");
1831 debug_assert!(!htlc.offered || htlc_spend_pending.is_none() || !htlc_spend_pending.unwrap().1,
1832 "We don't (currently) generate preimage claims against revoked outputs, where did you get one?!");
1833 return Some(Balance::CounterpartyRevokedOutputClaimable {
1834 amount_satoshis: htlc.amount_msat / 1000,
1837 } else if htlc.offered == holder_commitment {
1838 // If the payment was outbound, check if there's an HTLCUpdate
1839 // indicating we have spent this HTLC with a timeout, claiming it back
1840 // and awaiting confirmations on it.
1841 if let Some(conf_thresh) = holder_timeout_spend_pending {
1842 return Some(Balance::ClaimableAwaitingConfirmations {
1843 amount_satoshis: htlc.amount_msat / 1000,
1844 confirmation_height: conf_thresh,
1847 return Some(Balance::MaybeTimeoutClaimableHTLC {
1848 amount_satoshis: htlc.amount_msat / 1000,
1849 claimable_height: htlc.cltv_expiry,
1850 payment_hash: htlc.payment_hash,
1853 } else if let Some(payment_preimage) = self.payment_preimages.get(&htlc.payment_hash) {
1854 // Otherwise (the payment was inbound), only expose it as claimable if
1855 // we know the preimage.
1856 // Note that if there is a pending claim, but it did not use the
1857 // preimage, we lost funds to our counterparty! We will then continue
1858 // to show it as ContentiousClaimable until ANTI_REORG_DELAY.
1859 debug_assert!(holder_timeout_spend_pending.is_none());
1860 if let Some((conf_thresh, true)) = htlc_spend_pending {
1861 return Some(Balance::ClaimableAwaitingConfirmations {
1862 amount_satoshis: htlc.amount_msat / 1000,
1863 confirmation_height: conf_thresh,
1866 return Some(Balance::ContentiousClaimable {
1867 amount_satoshis: htlc.amount_msat / 1000,
1868 timeout_height: htlc.cltv_expiry,
1869 payment_hash: htlc.payment_hash,
1870 payment_preimage: *payment_preimage,
1873 } else if htlc_resolved.is_none() {
1874 return Some(Balance::MaybePreimageClaimableHTLC {
1875 amount_satoshis: htlc.amount_msat / 1000,
1876 expiry_height: htlc.cltv_expiry,
1877 payment_hash: htlc.payment_hash,
1884 impl<Signer: WriteableEcdsaChannelSigner> ChannelMonitor<Signer> {
1885 /// Gets the balances in this channel which are either claimable by us if we were to
1886 /// force-close the channel now or which are claimable on-chain (possibly awaiting
1889 /// Any balances in the channel which are available on-chain (excluding on-chain fees) are
1890 /// included here until an [`Event::SpendableOutputs`] event has been generated for the
1891 /// balance, or until our counterparty has claimed the balance and accrued several
1892 /// confirmations on the claim transaction.
1894 /// Note that for `ChannelMonitors` which track a channel which went on-chain with versions of
1895 /// LDK prior to 0.0.111, balances may not be fully captured if our counterparty broadcasted
1896 /// a revoked state.
1898 /// See [`Balance`] for additional details on the types of claimable balances which
1899 /// may be returned here and their meanings.
1900 pub fn get_claimable_balances(&self) -> Vec<Balance> {
1901 let mut res = Vec::new();
1902 let us = self.inner.lock().unwrap();
1904 let mut confirmed_txid = us.funding_spend_confirmed;
1905 let mut confirmed_counterparty_output = us.confirmed_commitment_tx_counterparty_output;
1906 let mut pending_commitment_tx_conf_thresh = None;
1907 let funding_spend_pending = us.onchain_events_awaiting_threshold_conf.iter().find_map(|event| {
1908 if let OnchainEvent::FundingSpendConfirmation { commitment_tx_to_counterparty_output, .. } =
1911 confirmed_counterparty_output = commitment_tx_to_counterparty_output;
1912 Some((event.txid, event.confirmation_threshold()))
1915 if let Some((txid, conf_thresh)) = funding_spend_pending {
1916 debug_assert!(us.funding_spend_confirmed.is_none(),
1917 "We have a pending funding spend awaiting anti-reorg confirmation, we can't have confirmed it already!");
1918 confirmed_txid = Some(txid);
1919 pending_commitment_tx_conf_thresh = Some(conf_thresh);
1922 macro_rules! walk_htlcs {
1923 ($holder_commitment: expr, $counterparty_revoked_commitment: expr, $htlc_iter: expr) => {
1924 for htlc in $htlc_iter {
1925 if htlc.transaction_output_index.is_some() {
1927 if let Some(bal) = us.get_htlc_balance(htlc, $holder_commitment, $counterparty_revoked_commitment, confirmed_txid) {
1935 if let Some(txid) = confirmed_txid {
1936 let mut found_commitment_tx = false;
1937 if let Some(counterparty_tx_htlcs) = us.counterparty_claimable_outpoints.get(&txid) {
1938 // First look for the to_remote output back to us.
1939 if let Some(conf_thresh) = pending_commitment_tx_conf_thresh {
1940 if let Some(value) = us.onchain_events_awaiting_threshold_conf.iter().find_map(|event| {
1941 if let OnchainEvent::MaturingOutput {
1942 descriptor: SpendableOutputDescriptor::StaticPaymentOutput(descriptor)
1944 Some(descriptor.output.value)
1947 res.push(Balance::ClaimableAwaitingConfirmations {
1948 amount_satoshis: value,
1949 confirmation_height: conf_thresh,
1952 // If a counterparty commitment transaction is awaiting confirmation, we
1953 // should either have a StaticPaymentOutput MaturingOutput event awaiting
1954 // confirmation with the same height or have never met our dust amount.
1957 if Some(txid) == us.current_counterparty_commitment_txid || Some(txid) == us.prev_counterparty_commitment_txid {
1958 walk_htlcs!(false, false, counterparty_tx_htlcs.iter().map(|(a, _)| a));
1960 walk_htlcs!(false, true, counterparty_tx_htlcs.iter().map(|(a, _)| a));
1961 // The counterparty broadcasted a revoked state!
1962 // Look for any StaticOutputs first, generating claimable balances for those.
1963 // If any match the confirmed counterparty revoked to_self output, skip
1964 // generating a CounterpartyRevokedOutputClaimable.
1965 let mut spent_counterparty_output = false;
1966 for event in us.onchain_events_awaiting_threshold_conf.iter() {
1967 if let OnchainEvent::MaturingOutput {
1968 descriptor: SpendableOutputDescriptor::StaticOutput { output, .. }
1970 res.push(Balance::ClaimableAwaitingConfirmations {
1971 amount_satoshis: output.value,
1972 confirmation_height: event.confirmation_threshold(),
1974 if let Some(confirmed_to_self_idx) = confirmed_counterparty_output.map(|(idx, _)| idx) {
1975 if event.transaction.as_ref().map(|tx|
1976 tx.input.iter().any(|inp| inp.previous_output.vout == confirmed_to_self_idx)
1977 ).unwrap_or(false) {
1978 spent_counterparty_output = true;
1984 if spent_counterparty_output {
1985 } else if let Some((confirmed_to_self_idx, amt)) = confirmed_counterparty_output {
1986 let output_spendable = us.onchain_tx_handler
1987 .is_output_spend_pending(&BitcoinOutPoint::new(txid, confirmed_to_self_idx));
1988 if output_spendable {
1989 res.push(Balance::CounterpartyRevokedOutputClaimable {
1990 amount_satoshis: amt,
1994 // Counterparty output is missing, either it was broadcasted on a
1995 // previous version of LDK or the counterparty hadn't met dust.
1998 found_commitment_tx = true;
1999 } else if txid == us.current_holder_commitment_tx.txid {
2000 walk_htlcs!(true, false, us.current_holder_commitment_tx.htlc_outputs.iter().map(|(a, _, _)| a));
2001 if let Some(conf_thresh) = pending_commitment_tx_conf_thresh {
2002 res.push(Balance::ClaimableAwaitingConfirmations {
2003 amount_satoshis: us.current_holder_commitment_tx.to_self_value_sat,
2004 confirmation_height: conf_thresh,
2007 found_commitment_tx = true;
2008 } else if let Some(prev_commitment) = &us.prev_holder_signed_commitment_tx {
2009 if txid == prev_commitment.txid {
2010 walk_htlcs!(true, false, prev_commitment.htlc_outputs.iter().map(|(a, _, _)| a));
2011 if let Some(conf_thresh) = pending_commitment_tx_conf_thresh {
2012 res.push(Balance::ClaimableAwaitingConfirmations {
2013 amount_satoshis: prev_commitment.to_self_value_sat,
2014 confirmation_height: conf_thresh,
2017 found_commitment_tx = true;
2020 if !found_commitment_tx {
2021 if let Some(conf_thresh) = pending_commitment_tx_conf_thresh {
2022 // We blindly assume this is a cooperative close transaction here, and that
2023 // neither us nor our counterparty misbehaved. At worst we've under-estimated
2024 // the amount we can claim as we'll punish a misbehaving counterparty.
2025 res.push(Balance::ClaimableAwaitingConfirmations {
2026 amount_satoshis: us.current_holder_commitment_tx.to_self_value_sat,
2027 confirmation_height: conf_thresh,
2032 let mut claimable_inbound_htlc_value_sat = 0;
2033 for (htlc, _, _) in us.current_holder_commitment_tx.htlc_outputs.iter() {
2034 if htlc.transaction_output_index.is_none() { continue; }
2036 res.push(Balance::MaybeTimeoutClaimableHTLC {
2037 amount_satoshis: htlc.amount_msat / 1000,
2038 claimable_height: htlc.cltv_expiry,
2039 payment_hash: htlc.payment_hash,
2041 } else if us.payment_preimages.get(&htlc.payment_hash).is_some() {
2042 claimable_inbound_htlc_value_sat += htlc.amount_msat / 1000;
2044 // As long as the HTLC is still in our latest commitment state, treat
2045 // it as potentially claimable, even if it has long-since expired.
2046 res.push(Balance::MaybePreimageClaimableHTLC {
2047 amount_satoshis: htlc.amount_msat / 1000,
2048 expiry_height: htlc.cltv_expiry,
2049 payment_hash: htlc.payment_hash,
2053 res.push(Balance::ClaimableOnChannelClose {
2054 amount_satoshis: us.current_holder_commitment_tx.to_self_value_sat + claimable_inbound_htlc_value_sat,
2061 /// Gets the set of outbound HTLCs which can be (or have been) resolved by this
2062 /// `ChannelMonitor`. This is used to determine if an HTLC was removed from the channel prior
2063 /// to the `ChannelManager` having been persisted.
2065 /// This is similar to [`Self::get_pending_or_resolved_outbound_htlcs`] except it includes
2066 /// HTLCs which were resolved on-chain (i.e. where the final HTLC resolution was done by an
2067 /// event from this `ChannelMonitor`).
2068 pub(crate) fn get_all_current_outbound_htlcs(&self) -> HashMap<HTLCSource, (HTLCOutputInCommitment, Option<PaymentPreimage>)> {
2069 let mut res = HashMap::new();
2070 // Just examine the available counterparty commitment transactions. See docs on
2071 // `fail_unbroadcast_htlcs`, below, for justification.
2072 let us = self.inner.lock().unwrap();
2073 macro_rules! walk_counterparty_commitment {
2075 if let Some(ref latest_outpoints) = us.counterparty_claimable_outpoints.get($txid) {
2076 for &(ref htlc, ref source_option) in latest_outpoints.iter() {
2077 if let &Some(ref source) = source_option {
2078 res.insert((**source).clone(), (htlc.clone(),
2079 us.counterparty_fulfilled_htlcs.get(&SentHTLCId::from_source(source)).cloned()));
2085 if let Some(ref txid) = us.current_counterparty_commitment_txid {
2086 walk_counterparty_commitment!(txid);
2088 if let Some(ref txid) = us.prev_counterparty_commitment_txid {
2089 walk_counterparty_commitment!(txid);
2094 /// Gets the set of outbound HTLCs which are pending resolution in this channel or which were
2095 /// resolved with a preimage from our counterparty.
2097 /// This is used to reconstruct pending outbound payments on restart in the ChannelManager.
2099 /// Currently, the preimage is unused, however if it is present in the relevant internal state
2100 /// an HTLC is always included even if it has been resolved.
2101 pub(crate) fn get_pending_or_resolved_outbound_htlcs(&self) -> HashMap<HTLCSource, (HTLCOutputInCommitment, Option<PaymentPreimage>)> {
2102 let us = self.inner.lock().unwrap();
2103 // We're only concerned with the confirmation count of HTLC transactions, and don't
2104 // actually care how many confirmations a commitment transaction may or may not have. Thus,
2105 // we look for either a FundingSpendConfirmation event or a funding_spend_confirmed.
2106 let confirmed_txid = us.funding_spend_confirmed.or_else(|| {
2107 us.onchain_events_awaiting_threshold_conf.iter().find_map(|event| {
2108 if let OnchainEvent::FundingSpendConfirmation { .. } = event.event {
2114 if confirmed_txid.is_none() {
2115 // If we have not seen a commitment transaction on-chain (ie the channel is not yet
2116 // closed), just get the full set.
2118 return self.get_all_current_outbound_htlcs();
2121 let mut res = HashMap::new();
2122 macro_rules! walk_htlcs {
2123 ($holder_commitment: expr, $htlc_iter: expr) => {
2124 for (htlc, source) in $htlc_iter {
2125 if us.htlcs_resolved_on_chain.iter().any(|v| v.commitment_tx_output_idx == htlc.transaction_output_index) {
2126 // We should assert that funding_spend_confirmed is_some() here, but we
2127 // have some unit tests which violate HTLC transaction CSVs entirely and
2129 // TODO: Once tests all connect transactions at consensus-valid times, we
2130 // should assert here like we do in `get_claimable_balances`.
2131 } else if htlc.offered == $holder_commitment {
2132 // If the payment was outbound, check if there's an HTLCUpdate
2133 // indicating we have spent this HTLC with a timeout, claiming it back
2134 // and awaiting confirmations on it.
2135 let htlc_update_confd = us.onchain_events_awaiting_threshold_conf.iter().any(|event| {
2136 if let OnchainEvent::HTLCUpdate { commitment_tx_output_idx: Some(commitment_tx_output_idx), .. } = event.event {
2137 // If the HTLC was timed out, we wait for ANTI_REORG_DELAY blocks
2138 // before considering it "no longer pending" - this matches when we
2139 // provide the ChannelManager an HTLC failure event.
2140 Some(commitment_tx_output_idx) == htlc.transaction_output_index &&
2141 us.best_block.height() >= event.height + ANTI_REORG_DELAY - 1
2142 } else if let OnchainEvent::HTLCSpendConfirmation { commitment_tx_output_idx, .. } = event.event {
2143 // If the HTLC was fulfilled with a preimage, we consider the HTLC
2144 // immediately non-pending, matching when we provide ChannelManager
2146 Some(commitment_tx_output_idx) == htlc.transaction_output_index
2149 let counterparty_resolved_preimage_opt =
2150 us.counterparty_fulfilled_htlcs.get(&SentHTLCId::from_source(source)).cloned();
2151 if !htlc_update_confd || counterparty_resolved_preimage_opt.is_some() {
2152 res.insert(source.clone(), (htlc.clone(), counterparty_resolved_preimage_opt));
2159 let txid = confirmed_txid.unwrap();
2160 if Some(txid) == us.current_counterparty_commitment_txid || Some(txid) == us.prev_counterparty_commitment_txid {
2161 walk_htlcs!(false, us.counterparty_claimable_outpoints.get(&txid).unwrap().iter().filter_map(|(a, b)| {
2162 if let &Some(ref source) = b {
2163 Some((a, &**source))
2166 } else if txid == us.current_holder_commitment_tx.txid {
2167 walk_htlcs!(true, us.current_holder_commitment_tx.htlc_outputs.iter().filter_map(|(a, _, c)| {
2168 if let Some(source) = c { Some((a, source)) } else { None }
2170 } else if let Some(prev_commitment) = &us.prev_holder_signed_commitment_tx {
2171 if txid == prev_commitment.txid {
2172 walk_htlcs!(true, prev_commitment.htlc_outputs.iter().filter_map(|(a, _, c)| {
2173 if let Some(source) = c { Some((a, source)) } else { None }
2181 pub(crate) fn get_stored_preimages(&self) -> HashMap<PaymentHash, PaymentPreimage> {
2182 self.inner.lock().unwrap().payment_preimages.clone()
2186 /// Compares a broadcasted commitment transaction's HTLCs with those in the latest state,
2187 /// failing any HTLCs which didn't make it into the broadcasted commitment transaction back
2188 /// after ANTI_REORG_DELAY blocks.
2190 /// We always compare against the set of HTLCs in counterparty commitment transactions, as those
2191 /// are the commitment transactions which are generated by us. The off-chain state machine in
2192 /// `Channel` will automatically resolve any HTLCs which were never included in a commitment
2193 /// transaction when it detects channel closure, but it is up to us to ensure any HTLCs which were
2194 /// included in a remote commitment transaction are failed back if they are not present in the
2195 /// broadcasted commitment transaction.
2197 /// Specifically, the removal process for HTLCs in `Channel` is always based on the counterparty
2198 /// sending a `revoke_and_ack`, which causes us to clear `prev_counterparty_commitment_txid`. Thus,
2199 /// as long as we examine both the current counterparty commitment transaction and, if it hasn't
2200 /// been revoked yet, the previous one, we we will never "forget" to resolve an HTLC.
2201 macro_rules! fail_unbroadcast_htlcs {
2202 ($self: expr, $commitment_tx_type: expr, $commitment_txid_confirmed: expr, $commitment_tx_confirmed: expr,
2203 $commitment_tx_conf_height: expr, $commitment_tx_conf_hash: expr, $confirmed_htlcs_list: expr, $logger: expr) => { {
2204 debug_assert_eq!($commitment_tx_confirmed.txid(), $commitment_txid_confirmed);
2206 macro_rules! check_htlc_fails {
2207 ($txid: expr, $commitment_tx: expr) => {
2208 if let Some(ref latest_outpoints) = $self.counterparty_claimable_outpoints.get($txid) {
2209 for &(ref htlc, ref source_option) in latest_outpoints.iter() {
2210 if let &Some(ref source) = source_option {
2211 // Check if the HTLC is present in the commitment transaction that was
2212 // broadcast, but not if it was below the dust limit, which we should
2213 // fail backwards immediately as there is no way for us to learn the
2214 // payment_preimage.
2215 // Note that if the dust limit were allowed to change between
2216 // commitment transactions we'd want to be check whether *any*
2217 // broadcastable commitment transaction has the HTLC in it, but it
2218 // cannot currently change after channel initialization, so we don't
2220 let confirmed_htlcs_iter: &mut Iterator<Item = (&HTLCOutputInCommitment, Option<&HTLCSource>)> = &mut $confirmed_htlcs_list;
2222 let mut matched_htlc = false;
2223 for (ref broadcast_htlc, ref broadcast_source) in confirmed_htlcs_iter {
2224 if broadcast_htlc.transaction_output_index.is_some() &&
2225 (Some(&**source) == *broadcast_source ||
2226 (broadcast_source.is_none() &&
2227 broadcast_htlc.payment_hash == htlc.payment_hash &&
2228 broadcast_htlc.amount_msat == htlc.amount_msat)) {
2229 matched_htlc = true;
2233 if matched_htlc { continue; }
2234 if $self.counterparty_fulfilled_htlcs.get(&SentHTLCId::from_source(source)).is_some() {
2237 $self.onchain_events_awaiting_threshold_conf.retain(|ref entry| {
2238 if entry.height != $commitment_tx_conf_height { return true; }
2240 OnchainEvent::HTLCUpdate { source: ref update_source, .. } => {
2241 *update_source != **source
2246 let entry = OnchainEventEntry {
2247 txid: $commitment_txid_confirmed,
2248 transaction: Some($commitment_tx_confirmed.clone()),
2249 height: $commitment_tx_conf_height,
2250 block_hash: Some(*$commitment_tx_conf_hash),
2251 event: OnchainEvent::HTLCUpdate {
2252 source: (**source).clone(),
2253 payment_hash: htlc.payment_hash.clone(),
2254 htlc_value_satoshis: Some(htlc.amount_msat / 1000),
2255 commitment_tx_output_idx: None,
2258 log_trace!($logger, "Failing HTLC with payment_hash {} from {} counterparty commitment tx due to broadcast of {} commitment transaction {}, waiting for confirmation (at height {})",
2259 &htlc.payment_hash, $commitment_tx, $commitment_tx_type,
2260 $commitment_txid_confirmed, entry.confirmation_threshold());
2261 $self.onchain_events_awaiting_threshold_conf.push(entry);
2267 if let Some(ref txid) = $self.current_counterparty_commitment_txid {
2268 check_htlc_fails!(txid, "current");
2270 if let Some(ref txid) = $self.prev_counterparty_commitment_txid {
2271 check_htlc_fails!(txid, "previous");
2276 // In the `test_invalid_funding_tx` test, we need a bogus script which matches the HTLC-Accepted
2277 // witness length match (ie is 136 bytes long). We generate one here which we also use in some
2278 // in-line tests later.
2281 pub fn deliberately_bogus_accepted_htlc_witness_program() -> Vec<u8> {
2282 use bitcoin::blockdata::opcodes;
2283 let mut ret = [opcodes::all::OP_NOP.to_u8(); 136];
2284 ret[131] = opcodes::all::OP_DROP.to_u8();
2285 ret[132] = opcodes::all::OP_DROP.to_u8();
2286 ret[133] = opcodes::all::OP_DROP.to_u8();
2287 ret[134] = opcodes::all::OP_DROP.to_u8();
2288 ret[135] = opcodes::OP_TRUE.to_u8();
2293 pub fn deliberately_bogus_accepted_htlc_witness() -> Vec<Vec<u8>> {
2294 vec![Vec::new(), Vec::new(), Vec::new(), Vec::new(), deliberately_bogus_accepted_htlc_witness_program().into()].into()
2297 impl<Signer: WriteableEcdsaChannelSigner> ChannelMonitorImpl<Signer> {
2298 /// Inserts a revocation secret into this channel monitor. Prunes old preimages if neither
2299 /// needed by holder commitment transactions HTCLs nor by counterparty ones. Unless we haven't already seen
2300 /// counterparty commitment transaction's secret, they are de facto pruned (we can use revocation key).
2301 fn provide_secret(&mut self, idx: u64, secret: [u8; 32]) -> Result<(), &'static str> {
2302 if let Err(()) = self.commitment_secrets.provide_secret(idx, secret) {
2303 return Err("Previous secret did not match new one");
2306 // Prune HTLCs from the previous counterparty commitment tx so we don't generate failure/fulfill
2307 // events for now-revoked/fulfilled HTLCs.
2308 if let Some(txid) = self.prev_counterparty_commitment_txid.take() {
2309 if self.current_counterparty_commitment_txid.unwrap() != txid {
2310 let cur_claimables = self.counterparty_claimable_outpoints.get(
2311 &self.current_counterparty_commitment_txid.unwrap()).unwrap();
2312 for (_, ref source_opt) in self.counterparty_claimable_outpoints.get(&txid).unwrap() {
2313 if let Some(source) = source_opt {
2314 if !cur_claimables.iter()
2315 .any(|(_, cur_source_opt)| cur_source_opt == source_opt)
2317 self.counterparty_fulfilled_htlcs.remove(&SentHTLCId::from_source(source));
2321 for &mut (_, ref mut source_opt) in self.counterparty_claimable_outpoints.get_mut(&txid).unwrap() {
2325 assert!(cfg!(fuzzing), "Commitment txids are unique outside of fuzzing, where hashes can collide");
2329 if !self.payment_preimages.is_empty() {
2330 let cur_holder_signed_commitment_tx = &self.current_holder_commitment_tx;
2331 let prev_holder_signed_commitment_tx = self.prev_holder_signed_commitment_tx.as_ref();
2332 let min_idx = self.get_min_seen_secret();
2333 let counterparty_hash_commitment_number = &mut self.counterparty_hash_commitment_number;
2335 self.payment_preimages.retain(|&k, _| {
2336 for &(ref htlc, _, _) in cur_holder_signed_commitment_tx.htlc_outputs.iter() {
2337 if k == htlc.payment_hash {
2341 if let Some(prev_holder_commitment_tx) = prev_holder_signed_commitment_tx {
2342 for &(ref htlc, _, _) in prev_holder_commitment_tx.htlc_outputs.iter() {
2343 if k == htlc.payment_hash {
2348 let contains = if let Some(cn) = counterparty_hash_commitment_number.get(&k) {
2355 counterparty_hash_commitment_number.remove(&k);
2364 pub(crate) fn provide_initial_counterparty_commitment_tx<L: Deref>(
2365 &mut self, txid: Txid, htlc_outputs: Vec<(HTLCOutputInCommitment, Option<Box<HTLCSource>>)>,
2366 commitment_number: u64, their_per_commitment_point: PublicKey, feerate_per_kw: u32,
2367 to_broadcaster_value: u64, to_countersignatory_value: u64, logger: &L
2369 where L::Target: Logger
2371 self.initial_counterparty_commitment_info = Some((their_per_commitment_point.clone(),
2372 feerate_per_kw, to_broadcaster_value, to_countersignatory_value));
2374 #[cfg(debug_assertions)] {
2375 let rebuilt_commitment_tx = self.initial_counterparty_commitment_tx().unwrap();
2376 debug_assert_eq!(rebuilt_commitment_tx.trust().txid(), txid);
2379 self.provide_latest_counterparty_commitment_tx(txid, htlc_outputs, commitment_number,
2380 their_per_commitment_point, logger);
2383 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 {
2384 // TODO: Encrypt the htlc_outputs data with the single-hash of the commitment transaction
2385 // so that a remote monitor doesn't learn anything unless there is a malicious close.
2386 // (only maybe, sadly we cant do the same for local info, as we need to be aware of
2388 for &(ref htlc, _) in &htlc_outputs {
2389 self.counterparty_hash_commitment_number.insert(htlc.payment_hash, commitment_number);
2392 log_trace!(logger, "Tracking new counterparty commitment transaction with txid {} at commitment number {} with {} HTLC outputs", txid, commitment_number, htlc_outputs.len());
2393 self.prev_counterparty_commitment_txid = self.current_counterparty_commitment_txid.take();
2394 self.current_counterparty_commitment_txid = Some(txid);
2395 self.counterparty_claimable_outpoints.insert(txid, htlc_outputs.clone());
2396 self.current_counterparty_commitment_number = commitment_number;
2397 //TODO: Merge this into the other per-counterparty-transaction output storage stuff
2398 match self.their_cur_per_commitment_points {
2399 Some(old_points) => {
2400 if old_points.0 == commitment_number + 1 {
2401 self.their_cur_per_commitment_points = Some((old_points.0, old_points.1, Some(their_per_commitment_point)));
2402 } else if old_points.0 == commitment_number + 2 {
2403 if let Some(old_second_point) = old_points.2 {
2404 self.their_cur_per_commitment_points = Some((old_points.0 - 1, old_second_point, Some(their_per_commitment_point)));
2406 self.their_cur_per_commitment_points = Some((commitment_number, their_per_commitment_point, None));
2409 self.their_cur_per_commitment_points = Some((commitment_number, their_per_commitment_point, None));
2413 self.their_cur_per_commitment_points = Some((commitment_number, their_per_commitment_point, None));
2416 let mut htlcs = Vec::with_capacity(htlc_outputs.len());
2417 for htlc in htlc_outputs {
2418 if htlc.0.transaction_output_index.is_some() {
2424 /// Informs this monitor of the latest holder (ie broadcastable) commitment transaction. The
2425 /// monitor watches for timeouts and may broadcast it if we approach such a timeout. Thus, it
2426 /// is important that any clones of this channel monitor (including remote clones) by kept
2427 /// up-to-date as our holder commitment transaction is updated.
2428 /// Panics if set_on_holder_tx_csv has never been called.
2429 fn provide_latest_holder_commitment_tx(&mut self, holder_commitment_tx: HolderCommitmentTransaction, mut htlc_outputs: Vec<(HTLCOutputInCommitment, Option<Signature>, Option<HTLCSource>)>, claimed_htlcs: &[(SentHTLCId, PaymentPreimage)], nondust_htlc_sources: Vec<HTLCSource>) -> Result<(), &'static str> {
2430 if htlc_outputs.iter().any(|(_, s, _)| s.is_some()) {
2431 // If we have non-dust HTLCs in htlc_outputs, ensure they match the HTLCs in the
2432 // `holder_commitment_tx`. In the future, we'll no longer provide the redundant data
2433 // and just pass in source data via `nondust_htlc_sources`.
2434 debug_assert_eq!(htlc_outputs.iter().filter(|(_, s, _)| s.is_some()).count(), holder_commitment_tx.trust().htlcs().len());
2435 for (a, b) in htlc_outputs.iter().filter(|(_, s, _)| s.is_some()).map(|(h, _, _)| h).zip(holder_commitment_tx.trust().htlcs().iter()) {
2436 debug_assert_eq!(a, b);
2438 debug_assert_eq!(htlc_outputs.iter().filter(|(_, s, _)| s.is_some()).count(), holder_commitment_tx.counterparty_htlc_sigs.len());
2439 for (a, b) in htlc_outputs.iter().filter_map(|(_, s, _)| s.as_ref()).zip(holder_commitment_tx.counterparty_htlc_sigs.iter()) {
2440 debug_assert_eq!(a, b);
2442 debug_assert!(nondust_htlc_sources.is_empty());
2444 // If we don't have any non-dust HTLCs in htlc_outputs, assume they were all passed via
2445 // `nondust_htlc_sources`, building up the final htlc_outputs by combining
2446 // `nondust_htlc_sources` and the `holder_commitment_tx`
2447 #[cfg(debug_assertions)] {
2449 for htlc in holder_commitment_tx.trust().htlcs().iter() {
2450 assert!(htlc.transaction_output_index.unwrap() as i32 > prev);
2451 prev = htlc.transaction_output_index.unwrap() as i32;
2454 debug_assert!(htlc_outputs.iter().all(|(htlc, _, _)| htlc.transaction_output_index.is_none()));
2455 debug_assert!(htlc_outputs.iter().all(|(_, sig_opt, _)| sig_opt.is_none()));
2456 debug_assert_eq!(holder_commitment_tx.trust().htlcs().len(), holder_commitment_tx.counterparty_htlc_sigs.len());
2458 let mut sources_iter = nondust_htlc_sources.into_iter();
2460 for (htlc, counterparty_sig) in holder_commitment_tx.trust().htlcs().iter()
2461 .zip(holder_commitment_tx.counterparty_htlc_sigs.iter())
2464 let source = sources_iter.next().expect("Non-dust HTLC sources didn't match commitment tx");
2465 #[cfg(debug_assertions)] {
2466 assert!(source.possibly_matches_output(htlc));
2468 htlc_outputs.push((htlc.clone(), Some(counterparty_sig.clone()), Some(source)));
2470 htlc_outputs.push((htlc.clone(), Some(counterparty_sig.clone()), None));
2473 debug_assert!(sources_iter.next().is_none());
2476 let trusted_tx = holder_commitment_tx.trust();
2477 let txid = trusted_tx.txid();
2478 let tx_keys = trusted_tx.keys();
2479 self.current_holder_commitment_number = trusted_tx.commitment_number();
2480 let mut new_holder_commitment_tx = HolderSignedTx {
2482 revocation_key: tx_keys.revocation_key,
2483 a_htlc_key: tx_keys.broadcaster_htlc_key,
2484 b_htlc_key: tx_keys.countersignatory_htlc_key,
2485 delayed_payment_key: tx_keys.broadcaster_delayed_payment_key,
2486 per_commitment_point: tx_keys.per_commitment_point,
2488 to_self_value_sat: holder_commitment_tx.to_broadcaster_value_sat(),
2489 feerate_per_kw: trusted_tx.feerate_per_kw(),
2491 self.onchain_tx_handler.provide_latest_holder_tx(holder_commitment_tx);
2492 mem::swap(&mut new_holder_commitment_tx, &mut self.current_holder_commitment_tx);
2493 self.prev_holder_signed_commitment_tx = Some(new_holder_commitment_tx);
2494 for (claimed_htlc_id, claimed_preimage) in claimed_htlcs {
2495 #[cfg(debug_assertions)] {
2496 let cur_counterparty_htlcs = self.counterparty_claimable_outpoints.get(
2497 &self.current_counterparty_commitment_txid.unwrap()).unwrap();
2498 assert!(cur_counterparty_htlcs.iter().any(|(_, source_opt)| {
2499 if let Some(source) = source_opt {
2500 SentHTLCId::from_source(source) == *claimed_htlc_id
2504 self.counterparty_fulfilled_htlcs.insert(*claimed_htlc_id, *claimed_preimage);
2506 if self.holder_tx_signed {
2507 return Err("Latest holder commitment signed has already been signed, update is rejected");
2512 /// Provides a payment_hash->payment_preimage mapping. Will be automatically pruned when all
2513 /// commitment_tx_infos which contain the payment hash have been revoked.
2514 fn provide_payment_preimage<B: Deref, F: Deref, L: Deref>(
2515 &mut self, payment_hash: &PaymentHash, payment_preimage: &PaymentPreimage, broadcaster: &B,
2516 fee_estimator: &LowerBoundedFeeEstimator<F>, logger: &L)
2517 where B::Target: BroadcasterInterface,
2518 F::Target: FeeEstimator,
2521 self.payment_preimages.insert(payment_hash.clone(), payment_preimage.clone());
2523 let confirmed_spend_txid = self.funding_spend_confirmed.or_else(|| {
2524 self.onchain_events_awaiting_threshold_conf.iter().find_map(|event| match event.event {
2525 OnchainEvent::FundingSpendConfirmation { .. } => Some(event.txid),
2529 let confirmed_spend_txid = if let Some(txid) = confirmed_spend_txid {
2535 // If the channel is force closed, try to claim the output from this preimage.
2536 // First check if a counterparty commitment transaction has been broadcasted:
2537 macro_rules! claim_htlcs {
2538 ($commitment_number: expr, $txid: expr) => {
2539 let (htlc_claim_reqs, _) = self.get_counterparty_output_claim_info($commitment_number, $txid, None);
2540 self.onchain_tx_handler.update_claims_view_from_requests(htlc_claim_reqs, self.best_block.height(), self.best_block.height(), broadcaster, fee_estimator, logger);
2543 if let Some(txid) = self.current_counterparty_commitment_txid {
2544 if txid == confirmed_spend_txid {
2545 if let Some(commitment_number) = self.counterparty_commitment_txn_on_chain.get(&txid) {
2546 claim_htlcs!(*commitment_number, txid);
2548 debug_assert!(false);
2549 log_error!(logger, "Detected counterparty commitment tx on-chain without tracking commitment number");
2554 if let Some(txid) = self.prev_counterparty_commitment_txid {
2555 if txid == confirmed_spend_txid {
2556 if let Some(commitment_number) = self.counterparty_commitment_txn_on_chain.get(&txid) {
2557 claim_htlcs!(*commitment_number, txid);
2559 debug_assert!(false);
2560 log_error!(logger, "Detected counterparty commitment tx on-chain without tracking commitment number");
2566 // Then if a holder commitment transaction has been seen on-chain, broadcast transactions
2567 // claiming the HTLC output from each of the holder commitment transactions.
2568 // Note that we can't just use `self.holder_tx_signed`, because that only covers the case where
2569 // *we* sign a holder commitment transaction, not when e.g. a watchtower broadcasts one of our
2570 // holder commitment transactions.
2571 if self.broadcasted_holder_revokable_script.is_some() {
2572 let holder_commitment_tx = if self.current_holder_commitment_tx.txid == confirmed_spend_txid {
2573 Some(&self.current_holder_commitment_tx)
2574 } else if let Some(prev_holder_commitment_tx) = &self.prev_holder_signed_commitment_tx {
2575 if prev_holder_commitment_tx.txid == confirmed_spend_txid {
2576 Some(prev_holder_commitment_tx)
2583 if let Some(holder_commitment_tx) = holder_commitment_tx {
2584 // Assume that the broadcasted commitment transaction confirmed in the current best
2585 // block. Even if not, its a reasonable metric for the bump criteria on the HTLC
2587 let (claim_reqs, _) = self.get_broadcasted_holder_claims(&holder_commitment_tx, self.best_block.height());
2588 self.onchain_tx_handler.update_claims_view_from_requests(claim_reqs, self.best_block.height(), self.best_block.height(), broadcaster, fee_estimator, logger);
2593 pub(crate) fn broadcast_latest_holder_commitment_txn<B: Deref, L: Deref>(&mut self, broadcaster: &B, logger: &L)
2594 where B::Target: BroadcasterInterface,
2597 let commit_txs = self.get_latest_holder_commitment_txn(logger);
2598 let mut txs = vec![];
2599 for tx in commit_txs.iter() {
2600 log_info!(logger, "Broadcasting local {}", log_tx!(tx));
2603 broadcaster.broadcast_transactions(&txs);
2604 self.pending_monitor_events.push(MonitorEvent::HolderForceClosed(self.funding_info.0));
2607 pub fn update_monitor<B: Deref, F: Deref, L: Deref>(&mut self, updates: &ChannelMonitorUpdate, broadcaster: &B, fee_estimator: F, logger: &L) -> Result<(), ()>
2608 where B::Target: BroadcasterInterface,
2609 F::Target: FeeEstimator,
2612 if self.latest_update_id == CLOSED_CHANNEL_UPDATE_ID && updates.update_id == CLOSED_CHANNEL_UPDATE_ID {
2613 log_info!(logger, "Applying post-force-closed update to monitor {} with {} change(s).",
2614 log_funding_info!(self), updates.updates.len());
2615 } else if updates.update_id == CLOSED_CHANNEL_UPDATE_ID {
2616 log_info!(logger, "Applying force close update to monitor {} with {} change(s).",
2617 log_funding_info!(self), updates.updates.len());
2619 log_info!(logger, "Applying update to monitor {}, bringing update_id from {} to {} with {} change(s).",
2620 log_funding_info!(self), self.latest_update_id, updates.update_id, updates.updates.len());
2622 // ChannelMonitor updates may be applied after force close if we receive a preimage for a
2623 // broadcasted commitment transaction HTLC output that we'd like to claim on-chain. If this
2624 // is the case, we no longer have guaranteed access to the monitor's update ID, so we use a
2625 // sentinel value instead.
2627 // The `ChannelManager` may also queue redundant `ChannelForceClosed` updates if it still
2628 // thinks the channel needs to have its commitment transaction broadcast, so we'll allow
2630 if updates.update_id == CLOSED_CHANNEL_UPDATE_ID {
2631 assert_eq!(updates.updates.len(), 1);
2632 match updates.updates[0] {
2633 ChannelMonitorUpdateStep::ChannelForceClosed { .. } => {},
2634 // We should have already seen a `ChannelForceClosed` update if we're trying to
2635 // provide a preimage at this point.
2636 ChannelMonitorUpdateStep::PaymentPreimage { .. } =>
2637 debug_assert_eq!(self.latest_update_id, CLOSED_CHANNEL_UPDATE_ID),
2639 log_error!(logger, "Attempted to apply post-force-close ChannelMonitorUpdate of type {}", updates.updates[0].variant_name());
2640 panic!("Attempted to apply post-force-close ChannelMonitorUpdate that wasn't providing a payment preimage");
2643 } else if self.latest_update_id + 1 != updates.update_id {
2644 panic!("Attempted to apply ChannelMonitorUpdates out of order, check the update_id before passing an update to update_monitor!");
2646 let mut ret = Ok(());
2647 let bounded_fee_estimator = LowerBoundedFeeEstimator::new(&*fee_estimator);
2648 for update in updates.updates.iter() {
2650 ChannelMonitorUpdateStep::LatestHolderCommitmentTXInfo { commitment_tx, htlc_outputs, claimed_htlcs, nondust_htlc_sources } => {
2651 log_trace!(logger, "Updating ChannelMonitor with latest holder commitment transaction info");
2652 if self.lockdown_from_offchain { panic!(); }
2653 if let Err(e) = self.provide_latest_holder_commitment_tx(commitment_tx.clone(), htlc_outputs.clone(), &claimed_htlcs, nondust_htlc_sources.clone()) {
2654 log_error!(logger, "Providing latest holder commitment transaction failed/was refused:");
2655 log_error!(logger, " {}", e);
2659 ChannelMonitorUpdateStep::LatestCounterpartyCommitmentTXInfo { commitment_txid, htlc_outputs, commitment_number, their_per_commitment_point, .. } => {
2660 log_trace!(logger, "Updating ChannelMonitor with latest counterparty commitment transaction info");
2661 self.provide_latest_counterparty_commitment_tx(*commitment_txid, htlc_outputs.clone(), *commitment_number, *their_per_commitment_point, logger)
2663 ChannelMonitorUpdateStep::PaymentPreimage { payment_preimage } => {
2664 log_trace!(logger, "Updating ChannelMonitor with payment preimage");
2665 self.provide_payment_preimage(&PaymentHash(Sha256::hash(&payment_preimage.0[..]).into_inner()), &payment_preimage, broadcaster, &bounded_fee_estimator, logger)
2667 ChannelMonitorUpdateStep::CommitmentSecret { idx, secret } => {
2668 log_trace!(logger, "Updating ChannelMonitor with commitment secret");
2669 if let Err(e) = self.provide_secret(*idx, *secret) {
2670 debug_assert!(false, "Latest counterparty commitment secret was invalid");
2671 log_error!(logger, "Providing latest counterparty commitment secret failed/was refused:");
2672 log_error!(logger, " {}", e);
2676 ChannelMonitorUpdateStep::ChannelForceClosed { should_broadcast } => {
2677 log_trace!(logger, "Updating ChannelMonitor: channel force closed, should broadcast: {}", should_broadcast);
2678 self.lockdown_from_offchain = true;
2679 if *should_broadcast {
2680 // There's no need to broadcast our commitment transaction if we've seen one
2681 // confirmed (even with 1 confirmation) as it'll be rejected as
2682 // duplicate/conflicting.
2683 let detected_funding_spend = self.funding_spend_confirmed.is_some() ||
2684 self.onchain_events_awaiting_threshold_conf.iter().find(|event| match event.event {
2685 OnchainEvent::FundingSpendConfirmation { .. } => true,
2688 if detected_funding_spend {
2689 log_trace!(logger, "Avoiding commitment broadcast, already detected confirmed spend onchain");
2692 self.broadcast_latest_holder_commitment_txn(broadcaster, logger);
2693 // If the channel supports anchor outputs, we'll need to emit an external
2694 // event to be consumed such that a child transaction is broadcast with a
2695 // high enough feerate for the parent commitment transaction to confirm.
2696 if self.onchain_tx_handler.channel_type_features().supports_anchors_zero_fee_htlc_tx() {
2697 let funding_output = HolderFundingOutput::build(
2698 self.funding_redeemscript.clone(), self.channel_value_satoshis,
2699 self.onchain_tx_handler.channel_type_features().clone(),
2701 let best_block_height = self.best_block.height();
2702 let commitment_package = PackageTemplate::build_package(
2703 self.funding_info.0.txid.clone(), self.funding_info.0.index as u32,
2704 PackageSolvingData::HolderFundingOutput(funding_output),
2705 best_block_height, best_block_height
2707 self.onchain_tx_handler.update_claims_view_from_requests(
2708 vec![commitment_package], best_block_height, best_block_height,
2709 broadcaster, &bounded_fee_estimator, logger,
2712 } else if !self.holder_tx_signed {
2713 log_error!(logger, "WARNING: You have a potentially-unsafe holder commitment transaction available to broadcast");
2714 log_error!(logger, " in channel monitor for channel {}!", &self.funding_info.0.to_channel_id());
2715 log_error!(logger, " Read the docs for ChannelMonitor::get_latest_holder_commitment_txn and take manual action!");
2717 // If we generated a MonitorEvent::HolderForceClosed, the ChannelManager
2718 // will still give us a ChannelForceClosed event with !should_broadcast, but we
2719 // shouldn't print the scary warning above.
2720 log_info!(logger, "Channel off-chain state closed after we broadcasted our latest commitment transaction.");
2723 ChannelMonitorUpdateStep::ShutdownScript { scriptpubkey } => {
2724 log_trace!(logger, "Updating ChannelMonitor with shutdown script");
2725 if let Some(shutdown_script) = self.shutdown_script.replace(scriptpubkey.clone()) {
2726 panic!("Attempted to replace shutdown script {} with {}", shutdown_script, scriptpubkey);
2732 #[cfg(debug_assertions)] {
2733 self.counterparty_commitment_txs_from_update(updates);
2736 // If the updates succeeded and we were in an already closed channel state, then there's no
2737 // need to refuse any updates we expect to receive afer seeing a confirmed commitment.
2738 if ret.is_ok() && updates.update_id == CLOSED_CHANNEL_UPDATE_ID && self.latest_update_id == updates.update_id {
2742 self.latest_update_id = updates.update_id;
2744 // Refuse updates after we've detected a spend onchain, but only if we haven't processed a
2745 // force closed monitor update yet.
2746 if ret.is_ok() && self.funding_spend_seen && self.latest_update_id != CLOSED_CHANNEL_UPDATE_ID {
2747 log_error!(logger, "Refusing Channel Monitor Update as counterparty attempted to update commitment after funding was spent");
2752 pub fn get_latest_update_id(&self) -> u64 {
2753 self.latest_update_id
2756 pub fn get_funding_txo(&self) -> &(OutPoint, Script) {
2760 pub fn get_outputs_to_watch(&self) -> &HashMap<Txid, Vec<(u32, Script)>> {
2761 // If we've detected a counterparty commitment tx on chain, we must include it in the set
2762 // of outputs to watch for spends of, otherwise we're likely to lose user funds. Because
2763 // its trivial to do, double-check that here.
2764 for (txid, _) in self.counterparty_commitment_txn_on_chain.iter() {
2765 self.outputs_to_watch.get(txid).expect("Counterparty commitment txn which have been broadcast should have outputs registered");
2767 &self.outputs_to_watch
2770 pub fn get_and_clear_pending_monitor_events(&mut self) -> Vec<MonitorEvent> {
2771 let mut ret = Vec::new();
2772 mem::swap(&mut ret, &mut self.pending_monitor_events);
2776 /// Gets the set of events that are repeated regularly (e.g. those which RBF bump
2777 /// transactions). We're okay if we lose these on restart as they'll be regenerated for us at
2778 /// some regular interval via [`ChannelMonitor::rebroadcast_pending_claims`].
2779 pub(super) fn get_repeated_events(&mut self) -> Vec<Event> {
2780 let pending_claim_events = self.onchain_tx_handler.get_and_clear_pending_claim_events();
2781 let mut ret = Vec::with_capacity(pending_claim_events.len());
2782 for (claim_id, claim_event) in pending_claim_events {
2784 ClaimEvent::BumpCommitment {
2785 package_target_feerate_sat_per_1000_weight, commitment_tx, anchor_output_idx,
2787 let commitment_txid = commitment_tx.txid();
2788 debug_assert_eq!(self.current_holder_commitment_tx.txid, commitment_txid);
2789 let pending_htlcs = self.current_holder_commitment_tx.non_dust_htlcs();
2790 let commitment_tx_fee_satoshis = self.channel_value_satoshis -
2791 commitment_tx.output.iter().fold(0u64, |sum, output| sum + output.value);
2792 ret.push(Event::BumpTransaction(BumpTransactionEvent::ChannelClose {
2794 package_target_feerate_sat_per_1000_weight,
2796 commitment_tx_fee_satoshis,
2797 anchor_descriptor: AnchorDescriptor {
2798 channel_derivation_parameters: ChannelDerivationParameters {
2799 keys_id: self.channel_keys_id,
2800 value_satoshis: self.channel_value_satoshis,
2801 transaction_parameters: self.onchain_tx_handler.channel_transaction_parameters.clone(),
2803 outpoint: BitcoinOutPoint {
2804 txid: commitment_txid,
2805 vout: anchor_output_idx,
2811 ClaimEvent::BumpHTLC {
2812 target_feerate_sat_per_1000_weight, htlcs, tx_lock_time,
2814 let mut htlc_descriptors = Vec::with_capacity(htlcs.len());
2816 htlc_descriptors.push(HTLCDescriptor {
2817 channel_derivation_parameters: ChannelDerivationParameters {
2818 keys_id: self.channel_keys_id,
2819 value_satoshis: self.channel_value_satoshis,
2820 transaction_parameters: self.onchain_tx_handler.channel_transaction_parameters.clone(),
2822 commitment_txid: htlc.commitment_txid,
2823 per_commitment_number: htlc.per_commitment_number,
2824 per_commitment_point: self.onchain_tx_handler.signer.get_per_commitment_point(
2825 htlc.per_commitment_number, &self.onchain_tx_handler.secp_ctx,
2828 preimage: htlc.preimage,
2829 counterparty_sig: htlc.counterparty_sig,
2832 ret.push(Event::BumpTransaction(BumpTransactionEvent::HTLCResolution {
2834 target_feerate_sat_per_1000_weight,
2844 pub(crate) fn initial_counterparty_commitment_tx(&mut self) -> Option<CommitmentTransaction> {
2845 let (their_per_commitment_point, feerate_per_kw, to_broadcaster_value,
2846 to_countersignatory_value) = self.initial_counterparty_commitment_info?;
2847 let htlc_outputs = vec![];
2849 let commitment_tx = self.build_counterparty_commitment_tx(INITIAL_COMMITMENT_NUMBER,
2850 &their_per_commitment_point, to_broadcaster_value, to_countersignatory_value,
2851 feerate_per_kw, htlc_outputs);
2855 fn build_counterparty_commitment_tx(
2856 &self, commitment_number: u64, their_per_commitment_point: &PublicKey,
2857 to_broadcaster_value: u64, to_countersignatory_value: u64, feerate_per_kw: u32,
2858 mut nondust_htlcs: Vec<(HTLCOutputInCommitment, Option<Box<HTLCSource>>)>
2859 ) -> CommitmentTransaction {
2860 let broadcaster_keys = &self.onchain_tx_handler.channel_transaction_parameters
2861 .counterparty_parameters.as_ref().unwrap().pubkeys;
2862 let countersignatory_keys =
2863 &self.onchain_tx_handler.channel_transaction_parameters.holder_pubkeys;
2865 let broadcaster_funding_key = broadcaster_keys.funding_pubkey;
2866 let countersignatory_funding_key = countersignatory_keys.funding_pubkey;
2867 let keys = TxCreationKeys::from_channel_static_keys(&their_per_commitment_point,
2868 &broadcaster_keys, &countersignatory_keys, &self.onchain_tx_handler.secp_ctx);
2869 let channel_parameters =
2870 &self.onchain_tx_handler.channel_transaction_parameters.as_counterparty_broadcastable();
2872 CommitmentTransaction::new_with_auxiliary_htlc_data(commitment_number,
2873 to_broadcaster_value, to_countersignatory_value, broadcaster_funding_key,
2874 countersignatory_funding_key, keys, feerate_per_kw, &mut nondust_htlcs,
2878 pub(crate) fn counterparty_commitment_txs_from_update(&self, update: &ChannelMonitorUpdate) -> Vec<CommitmentTransaction> {
2879 update.updates.iter().filter_map(|update| {
2881 &ChannelMonitorUpdateStep::LatestCounterpartyCommitmentTXInfo { commitment_txid,
2882 ref htlc_outputs, commitment_number, their_per_commitment_point,
2883 feerate_per_kw: Some(feerate_per_kw),
2884 to_broadcaster_value_sat: Some(to_broadcaster_value),
2885 to_countersignatory_value_sat: Some(to_countersignatory_value) } => {
2887 let nondust_htlcs = htlc_outputs.iter().filter_map(|(htlc, _)| {
2888 htlc.transaction_output_index.map(|_| (htlc.clone(), None))
2889 }).collect::<Vec<_>>();
2891 let commitment_tx = self.build_counterparty_commitment_tx(commitment_number,
2892 &their_per_commitment_point, to_broadcaster_value,
2893 to_countersignatory_value, feerate_per_kw, nondust_htlcs);
2895 debug_assert_eq!(commitment_tx.trust().txid(), commitment_txid);
2904 pub(crate) fn sign_to_local_justice_tx(
2905 &self, mut justice_tx: Transaction, input_idx: usize, value: u64, commitment_number: u64
2906 ) -> Result<Transaction, ()> {
2907 let secret = self.get_secret(commitment_number).ok_or(())?;
2908 let per_commitment_key = SecretKey::from_slice(&secret).map_err(|_| ())?;
2909 let their_per_commitment_point = PublicKey::from_secret_key(
2910 &self.onchain_tx_handler.secp_ctx, &per_commitment_key);
2912 let revocation_pubkey = chan_utils::derive_public_revocation_key(
2913 &self.onchain_tx_handler.secp_ctx, &their_per_commitment_point,
2914 &self.holder_revocation_basepoint);
2915 let delayed_key = chan_utils::derive_public_key(&self.onchain_tx_handler.secp_ctx,
2916 &their_per_commitment_point,
2917 &self.counterparty_commitment_params.counterparty_delayed_payment_base_key);
2918 let revokeable_redeemscript = chan_utils::get_revokeable_redeemscript(&revocation_pubkey,
2919 self.counterparty_commitment_params.on_counterparty_tx_csv, &delayed_key);
2921 let sig = self.onchain_tx_handler.signer.sign_justice_revoked_output(
2922 &justice_tx, input_idx, value, &per_commitment_key, &self.onchain_tx_handler.secp_ctx)?;
2923 justice_tx.input[input_idx].witness.push_bitcoin_signature(&sig.serialize_der(), EcdsaSighashType::All);
2924 justice_tx.input[input_idx].witness.push(&[1u8]);
2925 justice_tx.input[input_idx].witness.push(revokeable_redeemscript.as_bytes());
2929 /// Can only fail if idx is < get_min_seen_secret
2930 fn get_secret(&self, idx: u64) -> Option<[u8; 32]> {
2931 self.commitment_secrets.get_secret(idx)
2934 pub(crate) fn get_min_seen_secret(&self) -> u64 {
2935 self.commitment_secrets.get_min_seen_secret()
2938 pub(crate) fn get_cur_counterparty_commitment_number(&self) -> u64 {
2939 self.current_counterparty_commitment_number
2942 pub(crate) fn get_cur_holder_commitment_number(&self) -> u64 {
2943 self.current_holder_commitment_number
2946 /// Attempts to claim a counterparty commitment transaction's outputs using the revocation key and
2947 /// data in counterparty_claimable_outpoints. Will directly claim any HTLC outputs which expire at a
2948 /// height > height + CLTV_SHARED_CLAIM_BUFFER. In any case, will install monitoring for
2949 /// HTLC-Success/HTLC-Timeout transactions.
2951 /// Returns packages to claim the revoked output(s), as well as additional outputs to watch and
2952 /// general information about the output that is to the counterparty in the commitment
2954 fn check_spend_counterparty_transaction<L: Deref>(&mut self, tx: &Transaction, height: u32, block_hash: &BlockHash, logger: &L)
2955 -> (Vec<PackageTemplate>, TransactionOutputs, CommitmentTxCounterpartyOutputInfo)
2956 where L::Target: Logger {
2957 // Most secp and related errors trying to create keys means we have no hope of constructing
2958 // a spend transaction...so we return no transactions to broadcast
2959 let mut claimable_outpoints = Vec::new();
2960 let mut watch_outputs = Vec::new();
2961 let mut to_counterparty_output_info = None;
2963 let commitment_txid = tx.txid(); //TODO: This is gonna be a performance bottleneck for watchtowers!
2964 let per_commitment_option = self.counterparty_claimable_outpoints.get(&commitment_txid);
2966 macro_rules! ignore_error {
2967 ( $thing : expr ) => {
2970 Err(_) => return (claimable_outpoints, (commitment_txid, watch_outputs), to_counterparty_output_info)
2975 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);
2976 if commitment_number >= self.get_min_seen_secret() {
2977 let secret = self.get_secret(commitment_number).unwrap();
2978 let per_commitment_key = ignore_error!(SecretKey::from_slice(&secret));
2979 let per_commitment_point = PublicKey::from_secret_key(&self.onchain_tx_handler.secp_ctx, &per_commitment_key);
2980 let revocation_pubkey = chan_utils::derive_public_revocation_key(&self.onchain_tx_handler.secp_ctx, &per_commitment_point, &self.holder_revocation_basepoint);
2981 let delayed_key = chan_utils::derive_public_key(&self.onchain_tx_handler.secp_ctx, &PublicKey::from_secret_key(&self.onchain_tx_handler.secp_ctx, &per_commitment_key), &self.counterparty_commitment_params.counterparty_delayed_payment_base_key);
2983 let revokeable_redeemscript = chan_utils::get_revokeable_redeemscript(&revocation_pubkey, self.counterparty_commitment_params.on_counterparty_tx_csv, &delayed_key);
2984 let revokeable_p2wsh = revokeable_redeemscript.to_v0_p2wsh();
2986 // First, process non-htlc outputs (to_holder & to_counterparty)
2987 for (idx, outp) in tx.output.iter().enumerate() {
2988 if outp.script_pubkey == revokeable_p2wsh {
2989 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, self.onchain_tx_handler.channel_type_features().supports_anchors_zero_fee_htlc_tx());
2990 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, height);
2991 claimable_outpoints.push(justice_package);
2992 to_counterparty_output_info =
2993 Some((idx.try_into().expect("Txn can't have more than 2^32 outputs"), outp.value));
2997 // Then, try to find revoked htlc outputs
2998 if let Some(ref per_commitment_data) = per_commitment_option {
2999 for (_, &(ref htlc, _)) in per_commitment_data.iter().enumerate() {
3000 if let Some(transaction_output_index) = htlc.transaction_output_index {
3001 if transaction_output_index as usize >= tx.output.len() ||
3002 tx.output[transaction_output_index as usize].value != htlc.amount_msat / 1000 {
3003 // per_commitment_data is corrupt or our commitment signing key leaked!
3004 return (claimable_outpoints, (commitment_txid, watch_outputs),
3005 to_counterparty_output_info);
3007 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.channel_type_features);
3008 let justice_package = PackageTemplate::build_package(commitment_txid, transaction_output_index, PackageSolvingData::RevokedHTLCOutput(revk_htlc_outp), htlc.cltv_expiry, height);
3009 claimable_outpoints.push(justice_package);
3014 // Last, track onchain revoked commitment transaction and fail backward outgoing HTLCs as payment path is broken
3015 if !claimable_outpoints.is_empty() || per_commitment_option.is_some() { // ie we're confident this is actually ours
3016 // We're definitely a counterparty commitment transaction!
3017 log_error!(logger, "Got broadcast of revoked counterparty commitment transaction, going to generate general spend tx with {} inputs", claimable_outpoints.len());
3018 for (idx, outp) in tx.output.iter().enumerate() {
3019 watch_outputs.push((idx as u32, outp.clone()));
3021 self.counterparty_commitment_txn_on_chain.insert(commitment_txid, commitment_number);
3023 if let Some(per_commitment_data) = per_commitment_option {
3024 fail_unbroadcast_htlcs!(self, "revoked_counterparty", commitment_txid, tx, height,
3025 block_hash, per_commitment_data.iter().map(|(htlc, htlc_source)|
3026 (htlc, htlc_source.as_ref().map(|htlc_source| htlc_source.as_ref()))
3029 debug_assert!(false, "We should have per-commitment option for any recognized old commitment txn");
3030 fail_unbroadcast_htlcs!(self, "revoked counterparty", commitment_txid, tx, height,
3031 block_hash, [].iter().map(|reference| *reference), logger);
3034 } else if let Some(per_commitment_data) = per_commitment_option {
3035 // While this isn't useful yet, there is a potential race where if a counterparty
3036 // revokes a state at the same time as the commitment transaction for that state is
3037 // confirmed, and the watchtower receives the block before the user, the user could
3038 // upload a new ChannelMonitor with the revocation secret but the watchtower has
3039 // already processed the block, resulting in the counterparty_commitment_txn_on_chain entry
3040 // not being generated by the above conditional. Thus, to be safe, we go ahead and
3042 for (idx, outp) in tx.output.iter().enumerate() {
3043 watch_outputs.push((idx as u32, outp.clone()));
3045 self.counterparty_commitment_txn_on_chain.insert(commitment_txid, commitment_number);
3047 log_info!(logger, "Got broadcast of non-revoked counterparty commitment transaction {}", commitment_txid);
3048 fail_unbroadcast_htlcs!(self, "counterparty", commitment_txid, tx, height, block_hash,
3049 per_commitment_data.iter().map(|(htlc, htlc_source)|
3050 (htlc, htlc_source.as_ref().map(|htlc_source| htlc_source.as_ref()))
3053 let (htlc_claim_reqs, counterparty_output_info) =
3054 self.get_counterparty_output_claim_info(commitment_number, commitment_txid, Some(tx));
3055 to_counterparty_output_info = counterparty_output_info;
3056 for req in htlc_claim_reqs {
3057 claimable_outpoints.push(req);
3061 (claimable_outpoints, (commitment_txid, watch_outputs), to_counterparty_output_info)
3064 /// Returns the HTLC claim package templates and the counterparty output info
3065 fn get_counterparty_output_claim_info(&self, commitment_number: u64, commitment_txid: Txid, tx: Option<&Transaction>)
3066 -> (Vec<PackageTemplate>, CommitmentTxCounterpartyOutputInfo) {
3067 let mut claimable_outpoints = Vec::new();
3068 let mut to_counterparty_output_info: CommitmentTxCounterpartyOutputInfo = None;
3070 let htlc_outputs = match self.counterparty_claimable_outpoints.get(&commitment_txid) {
3071 Some(outputs) => outputs,
3072 None => return (claimable_outpoints, to_counterparty_output_info),
3074 let per_commitment_points = match self.their_cur_per_commitment_points {
3075 Some(points) => points,
3076 None => return (claimable_outpoints, to_counterparty_output_info),
3079 let per_commitment_point =
3080 // If the counterparty commitment tx is the latest valid state, use their latest
3081 // per-commitment point
3082 if per_commitment_points.0 == commitment_number { &per_commitment_points.1 }
3083 else if let Some(point) = per_commitment_points.2.as_ref() {
3084 // If counterparty commitment tx is the state previous to the latest valid state, use
3085 // their previous per-commitment point (non-atomicity of revocation means it's valid for
3086 // them to temporarily have two valid commitment txns from our viewpoint)
3087 if per_commitment_points.0 == commitment_number + 1 {
3089 } else { return (claimable_outpoints, to_counterparty_output_info); }
3090 } else { return (claimable_outpoints, to_counterparty_output_info); };
3092 if let Some(transaction) = tx {
3093 let revocation_pubkey = chan_utils::derive_public_revocation_key(
3094 &self.onchain_tx_handler.secp_ctx, &per_commitment_point, &self.holder_revocation_basepoint);
3095 let delayed_key = chan_utils::derive_public_key(&self.onchain_tx_handler.secp_ctx,
3096 &per_commitment_point,
3097 &self.counterparty_commitment_params.counterparty_delayed_payment_base_key);
3098 let revokeable_p2wsh = chan_utils::get_revokeable_redeemscript(&revocation_pubkey,
3099 self.counterparty_commitment_params.on_counterparty_tx_csv,
3100 &delayed_key).to_v0_p2wsh();
3101 for (idx, outp) in transaction.output.iter().enumerate() {
3102 if outp.script_pubkey == revokeable_p2wsh {
3103 to_counterparty_output_info =
3104 Some((idx.try_into().expect("Can't have > 2^32 outputs"), outp.value));
3109 for (_, &(ref htlc, _)) in htlc_outputs.iter().enumerate() {
3110 if let Some(transaction_output_index) = htlc.transaction_output_index {
3111 if let Some(transaction) = tx {
3112 if transaction_output_index as usize >= transaction.output.len() ||
3113 transaction.output[transaction_output_index as usize].value != htlc.amount_msat / 1000 {
3114 // per_commitment_data is corrupt or our commitment signing key leaked!
3115 return (claimable_outpoints, to_counterparty_output_info);
3118 let preimage = if htlc.offered { if let Some(p) = self.payment_preimages.get(&htlc.payment_hash) { Some(*p) } else { None } } else { None };
3119 if preimage.is_some() || !htlc.offered {
3120 let counterparty_htlc_outp = if htlc.offered {
3121 PackageSolvingData::CounterpartyOfferedHTLCOutput(
3122 CounterpartyOfferedHTLCOutput::build(*per_commitment_point,
3123 self.counterparty_commitment_params.counterparty_delayed_payment_base_key,
3124 self.counterparty_commitment_params.counterparty_htlc_base_key,
3125 preimage.unwrap(), htlc.clone(), self.onchain_tx_handler.channel_type_features().clone()))
3127 PackageSolvingData::CounterpartyReceivedHTLCOutput(
3128 CounterpartyReceivedHTLCOutput::build(*per_commitment_point,
3129 self.counterparty_commitment_params.counterparty_delayed_payment_base_key,
3130 self.counterparty_commitment_params.counterparty_htlc_base_key,
3131 htlc.clone(), self.onchain_tx_handler.channel_type_features().clone()))
3133 let counterparty_package = PackageTemplate::build_package(commitment_txid, transaction_output_index, counterparty_htlc_outp, htlc.cltv_expiry, 0);
3134 claimable_outpoints.push(counterparty_package);
3139 (claimable_outpoints, to_counterparty_output_info)
3142 /// Attempts to claim a counterparty HTLC-Success/HTLC-Timeout's outputs using the revocation key
3143 fn check_spend_counterparty_htlc<L: Deref>(
3144 &mut self, tx: &Transaction, commitment_number: u64, commitment_txid: &Txid, height: u32, logger: &L
3145 ) -> (Vec<PackageTemplate>, Option<TransactionOutputs>) where L::Target: Logger {
3146 let secret = if let Some(secret) = self.get_secret(commitment_number) { secret } else { return (Vec::new(), None); };
3147 let per_commitment_key = match SecretKey::from_slice(&secret) {
3149 Err(_) => return (Vec::new(), None)
3151 let per_commitment_point = PublicKey::from_secret_key(&self.onchain_tx_handler.secp_ctx, &per_commitment_key);
3153 let htlc_txid = tx.txid();
3154 let mut claimable_outpoints = vec![];
3155 let mut outputs_to_watch = None;
3156 // Previously, we would only claim HTLCs from revoked HTLC transactions if they had 1 input
3157 // with a witness of 5 elements and 1 output. This wasn't enough for anchor outputs, as the
3158 // counterparty can now aggregate multiple HTLCs into a single transaction thanks to
3159 // `SIGHASH_SINGLE` remote signatures, leading us to not claim any HTLCs upon seeing a
3160 // confirmed revoked HTLC transaction (for more details, see
3161 // https://lists.linuxfoundation.org/pipermail/lightning-dev/2022-April/003561.html).
3163 // We make sure we're not vulnerable to this case by checking all inputs of the transaction,
3164 // and claim those which spend the commitment transaction, have a witness of 5 elements, and
3165 // have a corresponding output at the same index within the transaction.
3166 for (idx, input) in tx.input.iter().enumerate() {
3167 if input.previous_output.txid == *commitment_txid && input.witness.len() == 5 && tx.output.get(idx).is_some() {
3168 log_error!(logger, "Got broadcast of revoked counterparty HTLC transaction, spending {}:{}", htlc_txid, idx);
3169 let revk_outp = RevokedOutput::build(
3170 per_commitment_point, self.counterparty_commitment_params.counterparty_delayed_payment_base_key,
3171 self.counterparty_commitment_params.counterparty_htlc_base_key, per_commitment_key,
3172 tx.output[idx].value, self.counterparty_commitment_params.on_counterparty_tx_csv,
3175 let justice_package = PackageTemplate::build_package(
3176 htlc_txid, idx as u32, PackageSolvingData::RevokedOutput(revk_outp),
3177 height + self.counterparty_commitment_params.on_counterparty_tx_csv as u32, height
3179 claimable_outpoints.push(justice_package);
3180 if outputs_to_watch.is_none() {
3181 outputs_to_watch = Some((htlc_txid, vec![]));
3183 outputs_to_watch.as_mut().unwrap().1.push((idx as u32, tx.output[idx].clone()));
3186 (claimable_outpoints, outputs_to_watch)
3189 // Returns (1) `PackageTemplate`s that can be given to the OnchainTxHandler, so that the handler can
3190 // broadcast transactions claiming holder HTLC commitment outputs and (2) a holder revokable
3191 // script so we can detect whether a holder transaction has been seen on-chain.
3192 fn get_broadcasted_holder_claims(&self, holder_tx: &HolderSignedTx, conf_height: u32) -> (Vec<PackageTemplate>, Option<(Script, PublicKey, PublicKey)>) {
3193 let mut claim_requests = Vec::with_capacity(holder_tx.htlc_outputs.len());
3195 let redeemscript = chan_utils::get_revokeable_redeemscript(&holder_tx.revocation_key, self.on_holder_tx_csv, &holder_tx.delayed_payment_key);
3196 let broadcasted_holder_revokable_script = Some((redeemscript.to_v0_p2wsh(), holder_tx.per_commitment_point.clone(), holder_tx.revocation_key.clone()));
3198 for &(ref htlc, _, _) in holder_tx.htlc_outputs.iter() {
3199 if let Some(transaction_output_index) = htlc.transaction_output_index {
3200 let htlc_output = if htlc.offered {
3201 let htlc_output = HolderHTLCOutput::build_offered(
3202 htlc.amount_msat, htlc.cltv_expiry, self.onchain_tx_handler.channel_type_features().clone()
3206 let payment_preimage = if let Some(preimage) = self.payment_preimages.get(&htlc.payment_hash) {
3209 // We can't build an HTLC-Success transaction without the preimage
3212 let htlc_output = HolderHTLCOutput::build_accepted(
3213 payment_preimage, htlc.amount_msat, self.onchain_tx_handler.channel_type_features().clone()
3217 let htlc_package = PackageTemplate::build_package(
3218 holder_tx.txid, transaction_output_index,
3219 PackageSolvingData::HolderHTLCOutput(htlc_output),
3220 htlc.cltv_expiry, conf_height
3222 claim_requests.push(htlc_package);
3226 (claim_requests, broadcasted_holder_revokable_script)
3229 // Returns holder HTLC outputs to watch and react to in case of spending.
3230 fn get_broadcasted_holder_watch_outputs(&self, holder_tx: &HolderSignedTx, commitment_tx: &Transaction) -> Vec<(u32, TxOut)> {
3231 let mut watch_outputs = Vec::with_capacity(holder_tx.htlc_outputs.len());
3232 for &(ref htlc, _, _) in holder_tx.htlc_outputs.iter() {
3233 if let Some(transaction_output_index) = htlc.transaction_output_index {
3234 watch_outputs.push((transaction_output_index, commitment_tx.output[transaction_output_index as usize].clone()));
3240 /// Attempts to claim any claimable HTLCs in a commitment transaction which was not (yet)
3241 /// revoked using data in holder_claimable_outpoints.
3242 /// Should not be used if check_spend_revoked_transaction succeeds.
3243 /// Returns None unless the transaction is definitely one of our commitment transactions.
3244 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 {
3245 let commitment_txid = tx.txid();
3246 let mut claim_requests = Vec::new();
3247 let mut watch_outputs = Vec::new();
3249 macro_rules! append_onchain_update {
3250 ($updates: expr, $to_watch: expr) => {
3251 claim_requests = $updates.0;
3252 self.broadcasted_holder_revokable_script = $updates.1;
3253 watch_outputs.append(&mut $to_watch);
3257 // HTLCs set may differ between last and previous holder commitment txn, in case of one them hitting chain, ensure we cancel all HTLCs backward
3258 let mut is_holder_tx = false;
3260 if self.current_holder_commitment_tx.txid == commitment_txid {
3261 is_holder_tx = true;
3262 log_info!(logger, "Got broadcast of latest holder commitment tx {}, searching for available HTLCs to claim", commitment_txid);
3263 let res = self.get_broadcasted_holder_claims(&self.current_holder_commitment_tx, height);
3264 let mut to_watch = self.get_broadcasted_holder_watch_outputs(&self.current_holder_commitment_tx, tx);
3265 append_onchain_update!(res, to_watch);
3266 fail_unbroadcast_htlcs!(self, "latest holder", commitment_txid, tx, height,
3267 block_hash, self.current_holder_commitment_tx.htlc_outputs.iter()
3268 .map(|(htlc, _, htlc_source)| (htlc, htlc_source.as_ref())), logger);
3269 } else if let &Some(ref holder_tx) = &self.prev_holder_signed_commitment_tx {
3270 if holder_tx.txid == commitment_txid {
3271 is_holder_tx = true;
3272 log_info!(logger, "Got broadcast of previous holder commitment tx {}, searching for available HTLCs to claim", commitment_txid);
3273 let res = self.get_broadcasted_holder_claims(holder_tx, height);
3274 let mut to_watch = self.get_broadcasted_holder_watch_outputs(holder_tx, tx);
3275 append_onchain_update!(res, to_watch);
3276 fail_unbroadcast_htlcs!(self, "previous holder", commitment_txid, tx, height, block_hash,
3277 holder_tx.htlc_outputs.iter().map(|(htlc, _, htlc_source)| (htlc, htlc_source.as_ref())),
3283 Some((claim_requests, (commitment_txid, watch_outputs)))
3289 pub fn get_latest_holder_commitment_txn<L: Deref>(&mut self, logger: &L) -> Vec<Transaction> where L::Target: Logger {
3290 log_debug!(logger, "Getting signed latest holder commitment transaction!");
3291 self.holder_tx_signed = true;
3292 let commitment_tx = self.onchain_tx_handler.get_fully_signed_holder_tx(&self.funding_redeemscript);
3293 let txid = commitment_tx.txid();
3294 let mut holder_transactions = vec![commitment_tx];
3295 // When anchor outputs are present, the HTLC transactions are only valid once the commitment
3296 // transaction confirms.
3297 if self.onchain_tx_handler.channel_type_features().supports_anchors_zero_fee_htlc_tx() {
3298 return holder_transactions;
3300 for htlc in self.current_holder_commitment_tx.htlc_outputs.iter() {
3301 if let Some(vout) = htlc.0.transaction_output_index {
3302 let preimage = if !htlc.0.offered {
3303 if let Some(preimage) = self.payment_preimages.get(&htlc.0.payment_hash) { Some(preimage.clone()) } else {
3304 // We can't build an HTLC-Success transaction without the preimage
3307 } else if htlc.0.cltv_expiry > self.best_block.height() + 1 {
3308 // Don't broadcast HTLC-Timeout transactions immediately as they don't meet the
3309 // current locktime requirements on-chain. We will broadcast them in
3310 // `block_confirmed` when `should_broadcast_holder_commitment_txn` returns true.
3311 // Note that we add + 1 as transactions are broadcastable when they can be
3312 // confirmed in the next block.
3315 if let Some(htlc_tx) = self.onchain_tx_handler.get_fully_signed_htlc_tx(
3316 &::bitcoin::OutPoint { txid, vout }, &preimage) {
3317 holder_transactions.push(htlc_tx);
3321 // 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.
3322 // The data will be re-generated and tracked in check_spend_holder_transaction if we get a confirmation.
3326 #[cfg(any(test,feature = "unsafe_revoked_tx_signing"))]
3327 /// Note that this includes possibly-locktimed-in-the-future transactions!
3328 fn unsafe_get_latest_holder_commitment_txn<L: Deref>(&mut self, logger: &L) -> Vec<Transaction> where L::Target: Logger {
3329 log_debug!(logger, "Getting signed copy of latest holder commitment transaction!");
3330 let commitment_tx = self.onchain_tx_handler.get_fully_signed_copy_holder_tx(&self.funding_redeemscript);
3331 let txid = commitment_tx.txid();
3332 let mut holder_transactions = vec![commitment_tx];
3333 // When anchor outputs are present, the HTLC transactions are only final once the commitment
3334 // transaction confirms due to the CSV 1 encumberance.
3335 if self.onchain_tx_handler.channel_type_features().supports_anchors_zero_fee_htlc_tx() {
3336 return holder_transactions;
3338 for htlc in self.current_holder_commitment_tx.htlc_outputs.iter() {
3339 if let Some(vout) = htlc.0.transaction_output_index {
3340 let preimage = if !htlc.0.offered {
3341 if let Some(preimage) = self.payment_preimages.get(&htlc.0.payment_hash) { Some(preimage.clone()) } else {
3342 // We can't build an HTLC-Success transaction without the preimage
3346 if let Some(htlc_tx) = self.onchain_tx_handler.unsafe_get_fully_signed_htlc_tx(
3347 &::bitcoin::OutPoint { txid, vout }, &preimage) {
3348 holder_transactions.push(htlc_tx);
3355 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>
3356 where B::Target: BroadcasterInterface,
3357 F::Target: FeeEstimator,
3360 let block_hash = header.block_hash();
3361 self.best_block = BestBlock::new(block_hash, height);
3363 let bounded_fee_estimator = LowerBoundedFeeEstimator::new(fee_estimator);
3364 self.transactions_confirmed(header, txdata, height, broadcaster, &bounded_fee_estimator, logger)
3367 fn best_block_updated<B: Deref, F: Deref, L: Deref>(
3369 header: &BlockHeader,
3372 fee_estimator: &LowerBoundedFeeEstimator<F>,
3374 ) -> Vec<TransactionOutputs>
3376 B::Target: BroadcasterInterface,
3377 F::Target: FeeEstimator,
3380 let block_hash = header.block_hash();
3382 if height > self.best_block.height() {
3383 self.best_block = BestBlock::new(block_hash, height);
3384 self.block_confirmed(height, block_hash, vec![], vec![], vec![], &broadcaster, &fee_estimator, &logger)
3385 } else if block_hash != self.best_block.block_hash() {
3386 self.best_block = BestBlock::new(block_hash, height);
3387 self.onchain_events_awaiting_threshold_conf.retain(|ref entry| entry.height <= height);
3388 self.onchain_tx_handler.block_disconnected(height + 1, broadcaster, fee_estimator, logger);
3390 } else { Vec::new() }
3393 fn transactions_confirmed<B: Deref, F: Deref, L: Deref>(
3395 header: &BlockHeader,
3396 txdata: &TransactionData,
3399 fee_estimator: &LowerBoundedFeeEstimator<F>,
3401 ) -> Vec<TransactionOutputs>
3403 B::Target: BroadcasterInterface,
3404 F::Target: FeeEstimator,
3407 let txn_matched = self.filter_block(txdata);
3408 for tx in &txn_matched {
3409 let mut output_val = 0;
3410 for out in tx.output.iter() {
3411 if out.value > 21_000_000_0000_0000 { panic!("Value-overflowing transaction provided to block connected"); }
3412 output_val += out.value;
3413 if output_val > 21_000_000_0000_0000 { panic!("Value-overflowing transaction provided to block connected"); }
3417 let block_hash = header.block_hash();
3419 let mut watch_outputs = Vec::new();
3420 let mut claimable_outpoints = Vec::new();
3421 'tx_iter: for tx in &txn_matched {
3422 let txid = tx.txid();
3423 // If a transaction has already been confirmed, ensure we don't bother processing it duplicatively.
3424 if Some(txid) == self.funding_spend_confirmed {
3425 log_debug!(logger, "Skipping redundant processing of funding-spend tx {} as it was previously confirmed", txid);
3428 for ev in self.onchain_events_awaiting_threshold_conf.iter() {
3429 if ev.txid == txid {
3430 if let Some(conf_hash) = ev.block_hash {
3431 assert_eq!(header.block_hash(), conf_hash,
3432 "Transaction {} was already confirmed and is being re-confirmed in a different block.\n\
3433 This indicates a severe bug in the transaction connection logic - a reorg should have been processed first!", ev.txid);
3435 log_debug!(logger, "Skipping redundant processing of confirming tx {} as it was previously confirmed", txid);
3439 for htlc in self.htlcs_resolved_on_chain.iter() {
3440 if Some(txid) == htlc.resolving_txid {
3441 log_debug!(logger, "Skipping redundant processing of HTLC resolution tx {} as it was previously confirmed", txid);
3445 for spendable_txid in self.spendable_txids_confirmed.iter() {
3446 if txid == *spendable_txid {
3447 log_debug!(logger, "Skipping redundant processing of spendable tx {} as it was previously confirmed", txid);
3452 if tx.input.len() == 1 {
3453 // Assuming our keys were not leaked (in which case we're screwed no matter what),
3454 // commitment transactions and HTLC transactions will all only ever have one input
3455 // (except for HTLC transactions for channels with anchor outputs), which is an easy
3456 // way to filter out any potential non-matching txn for lazy filters.
3457 let prevout = &tx.input[0].previous_output;
3458 if prevout.txid == self.funding_info.0.txid && prevout.vout == self.funding_info.0.index as u32 {
3459 let mut balance_spendable_csv = None;
3460 log_info!(logger, "Channel {} closed by funding output spend in txid {}.",
3461 &self.funding_info.0.to_channel_id(), txid);
3462 self.funding_spend_seen = true;
3463 let mut commitment_tx_to_counterparty_output = None;
3464 if (tx.input[0].sequence.0 >> 8*3) as u8 == 0x80 && (tx.lock_time.0 >> 8*3) as u8 == 0x20 {
3465 let (mut new_outpoints, new_outputs, counterparty_output_idx_sats) =
3466 self.check_spend_counterparty_transaction(&tx, height, &block_hash, &logger);
3467 commitment_tx_to_counterparty_output = counterparty_output_idx_sats;
3468 if !new_outputs.1.is_empty() {
3469 watch_outputs.push(new_outputs);
3471 claimable_outpoints.append(&mut new_outpoints);
3472 if new_outpoints.is_empty() {
3473 if let Some((mut new_outpoints, new_outputs)) = self.check_spend_holder_transaction(&tx, height, &block_hash, &logger) {
3474 debug_assert!(commitment_tx_to_counterparty_output.is_none(),
3475 "A commitment transaction matched as both a counterparty and local commitment tx?");
3476 if !new_outputs.1.is_empty() {
3477 watch_outputs.push(new_outputs);
3479 claimable_outpoints.append(&mut new_outpoints);
3480 balance_spendable_csv = Some(self.on_holder_tx_csv);
3484 self.onchain_events_awaiting_threshold_conf.push(OnchainEventEntry {
3486 transaction: Some((*tx).clone()),
3488 block_hash: Some(block_hash),
3489 event: OnchainEvent::FundingSpendConfirmation {
3490 on_local_output_csv: balance_spendable_csv,
3491 commitment_tx_to_counterparty_output,
3496 if tx.input.len() >= 1 {
3497 // While all commitment transactions have one input, HTLC transactions may have more
3498 // if the HTLC was present in an anchor channel. HTLCs can also be resolved in a few
3499 // other ways which can have more than one output.
3500 for tx_input in &tx.input {
3501 let commitment_txid = tx_input.previous_output.txid;
3502 if let Some(&commitment_number) = self.counterparty_commitment_txn_on_chain.get(&commitment_txid) {
3503 let (mut new_outpoints, new_outputs_option) = self.check_spend_counterparty_htlc(
3504 &tx, commitment_number, &commitment_txid, height, &logger
3506 claimable_outpoints.append(&mut new_outpoints);
3507 if let Some(new_outputs) = new_outputs_option {
3508 watch_outputs.push(new_outputs);
3510 // Since there may be multiple HTLCs for this channel (all spending the
3511 // same commitment tx) being claimed by the counterparty within the same
3512 // transaction, and `check_spend_counterparty_htlc` already checks all the
3513 // ones relevant to this channel, we can safely break from our loop.
3517 self.is_resolving_htlc_output(&tx, height, &block_hash, &logger);
3519 self.check_tx_and_push_spendable_outputs(&tx, height, &block_hash, &logger);
3523 if height > self.best_block.height() {
3524 self.best_block = BestBlock::new(block_hash, height);
3527 self.block_confirmed(height, block_hash, txn_matched, watch_outputs, claimable_outpoints, &broadcaster, &fee_estimator, &logger)
3530 /// Update state for new block(s)/transaction(s) confirmed. Note that the caller must update
3531 /// `self.best_block` before calling if a new best blockchain tip is available. More
3532 /// concretely, `self.best_block` must never be at a lower height than `conf_height`, avoiding
3533 /// complexity especially in
3534 /// `OnchainTx::update_claims_view_from_requests`/`OnchainTx::update_claims_view_from_matched_txn`.
3536 /// `conf_height` should be set to the height at which any new transaction(s)/block(s) were
3537 /// confirmed at, even if it is not the current best height.
3538 fn block_confirmed<B: Deref, F: Deref, L: Deref>(
3541 conf_hash: BlockHash,
3542 txn_matched: Vec<&Transaction>,
3543 mut watch_outputs: Vec<TransactionOutputs>,
3544 mut claimable_outpoints: Vec<PackageTemplate>,
3546 fee_estimator: &LowerBoundedFeeEstimator<F>,
3548 ) -> Vec<TransactionOutputs>
3550 B::Target: BroadcasterInterface,
3551 F::Target: FeeEstimator,
3554 log_trace!(logger, "Processing {} matched transactions for block at height {}.", txn_matched.len(), conf_height);
3555 debug_assert!(self.best_block.height() >= conf_height);
3557 let should_broadcast = self.should_broadcast_holder_commitment_txn(logger);
3558 if should_broadcast {
3559 let funding_outp = HolderFundingOutput::build(self.funding_redeemscript.clone(), self.channel_value_satoshis, self.onchain_tx_handler.channel_type_features().clone());
3560 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(), self.best_block.height());
3561 claimable_outpoints.push(commitment_package);
3562 self.pending_monitor_events.push(MonitorEvent::HolderForceClosed(self.funding_info.0));
3563 // Although we aren't signing the transaction directly here, the transaction will be signed
3564 // in the claim that is queued to OnchainTxHandler. We set holder_tx_signed here to reject
3565 // new channel updates.
3566 self.holder_tx_signed = true;
3567 // We can't broadcast our HTLC transactions while the commitment transaction is
3568 // unconfirmed. We'll delay doing so until we detect the confirmed commitment in
3569 // `transactions_confirmed`.
3570 if !self.onchain_tx_handler.channel_type_features().supports_anchors_zero_fee_htlc_tx() {
3571 // Because we're broadcasting a commitment transaction, we should construct the package
3572 // assuming it gets confirmed in the next block. Sadly, we have code which considers
3573 // "not yet confirmed" things as discardable, so we cannot do that here.
3574 let (mut new_outpoints, _) = self.get_broadcasted_holder_claims(&self.current_holder_commitment_tx, self.best_block.height());
3575 let unsigned_commitment_tx = self.onchain_tx_handler.get_unsigned_holder_commitment_tx();
3576 let new_outputs = self.get_broadcasted_holder_watch_outputs(&self.current_holder_commitment_tx, &unsigned_commitment_tx);
3577 if !new_outputs.is_empty() {
3578 watch_outputs.push((self.current_holder_commitment_tx.txid.clone(), new_outputs));
3580 claimable_outpoints.append(&mut new_outpoints);
3584 // Find which on-chain events have reached their confirmation threshold.
3585 let onchain_events_awaiting_threshold_conf =
3586 self.onchain_events_awaiting_threshold_conf.drain(..).collect::<Vec<_>>();
3587 let mut onchain_events_reaching_threshold_conf = Vec::new();
3588 for entry in onchain_events_awaiting_threshold_conf {
3589 if entry.has_reached_confirmation_threshold(&self.best_block) {
3590 onchain_events_reaching_threshold_conf.push(entry);
3592 self.onchain_events_awaiting_threshold_conf.push(entry);
3596 // Used to check for duplicate HTLC resolutions.
3597 #[cfg(debug_assertions)]
3598 let unmatured_htlcs: Vec<_> = self.onchain_events_awaiting_threshold_conf
3600 .filter_map(|entry| match &entry.event {
3601 OnchainEvent::HTLCUpdate { source, .. } => Some(source),
3605 #[cfg(debug_assertions)]
3606 let mut matured_htlcs = Vec::new();
3608 // Produce actionable events from on-chain events having reached their threshold.
3609 for entry in onchain_events_reaching_threshold_conf.drain(..) {
3611 OnchainEvent::HTLCUpdate { ref source, payment_hash, htlc_value_satoshis, commitment_tx_output_idx } => {
3612 // Check for duplicate HTLC resolutions.
3613 #[cfg(debug_assertions)]
3616 unmatured_htlcs.iter().find(|&htlc| htlc == &source).is_none(),
3617 "An unmature HTLC transaction conflicts with a maturing one; failed to \
3618 call either transaction_unconfirmed for the conflicting transaction \
3619 or block_disconnected for a block containing it.");
3621 matured_htlcs.iter().find(|&htlc| htlc == source).is_none(),
3622 "A matured HTLC transaction conflicts with a maturing one; failed to \
3623 call either transaction_unconfirmed for the conflicting transaction \
3624 or block_disconnected for a block containing it.");
3625 matured_htlcs.push(source.clone());
3628 log_debug!(logger, "HTLC {} failure update in {} has got enough confirmations to be passed upstream",
3629 &payment_hash, entry.txid);
3630 self.pending_monitor_events.push(MonitorEvent::HTLCEvent(HTLCUpdate {
3632 payment_preimage: None,
3633 source: source.clone(),
3634 htlc_value_satoshis,
3636 self.htlcs_resolved_on_chain.push(IrrevocablyResolvedHTLC {
3637 commitment_tx_output_idx,
3638 resolving_txid: Some(entry.txid),
3639 resolving_tx: entry.transaction,
3640 payment_preimage: None,
3643 OnchainEvent::MaturingOutput { descriptor } => {
3644 log_debug!(logger, "Descriptor {} has got enough confirmations to be passed upstream", log_spendable!(descriptor));
3645 self.pending_events.push(Event::SpendableOutputs {
3646 outputs: vec![descriptor],
3647 channel_id: Some(self.funding_info.0.to_channel_id()),
3649 self.spendable_txids_confirmed.push(entry.txid);
3651 OnchainEvent::HTLCSpendConfirmation { commitment_tx_output_idx, preimage, .. } => {
3652 self.htlcs_resolved_on_chain.push(IrrevocablyResolvedHTLC {
3653 commitment_tx_output_idx: Some(commitment_tx_output_idx),
3654 resolving_txid: Some(entry.txid),
3655 resolving_tx: entry.transaction,
3656 payment_preimage: preimage,
3659 OnchainEvent::FundingSpendConfirmation { commitment_tx_to_counterparty_output, .. } => {
3660 self.funding_spend_confirmed = Some(entry.txid);
3661 self.confirmed_commitment_tx_counterparty_output = commitment_tx_to_counterparty_output;
3666 self.onchain_tx_handler.update_claims_view_from_requests(claimable_outpoints, conf_height, self.best_block.height(), broadcaster, fee_estimator, logger);
3667 self.onchain_tx_handler.update_claims_view_from_matched_txn(&txn_matched, conf_height, conf_hash, self.best_block.height(), broadcaster, fee_estimator, logger);
3669 // Determine new outputs to watch by comparing against previously known outputs to watch,
3670 // updating the latter in the process.
3671 watch_outputs.retain(|&(ref txid, ref txouts)| {
3672 let idx_and_scripts = txouts.iter().map(|o| (o.0, o.1.script_pubkey.clone())).collect();
3673 self.outputs_to_watch.insert(txid.clone(), idx_and_scripts).is_none()
3677 // If we see a transaction for which we registered outputs previously,
3678 // make sure the registered scriptpubkey at the expected index match
3679 // the actual transaction output one. We failed this case before #653.
3680 for tx in &txn_matched {
3681 if let Some(outputs) = self.get_outputs_to_watch().get(&tx.txid()) {
3682 for idx_and_script in outputs.iter() {
3683 assert!((idx_and_script.0 as usize) < tx.output.len());
3684 assert_eq!(tx.output[idx_and_script.0 as usize].script_pubkey, idx_and_script.1);
3692 pub fn block_disconnected<B: Deref, F: Deref, L: Deref>(&mut self, header: &BlockHeader, height: u32, broadcaster: B, fee_estimator: F, logger: L)
3693 where B::Target: BroadcasterInterface,
3694 F::Target: FeeEstimator,
3697 log_trace!(logger, "Block {} at height {} disconnected", header.block_hash(), height);
3700 //- htlc update there as failure-trigger tx (revoked commitment tx, non-revoked commitment tx, HTLC-timeout tx) has been disconnected
3701 //- maturing spendable output has transaction paying us has been disconnected
3702 self.onchain_events_awaiting_threshold_conf.retain(|ref entry| entry.height < height);
3704 let bounded_fee_estimator = LowerBoundedFeeEstimator::new(fee_estimator);
3705 self.onchain_tx_handler.block_disconnected(height, broadcaster, &bounded_fee_estimator, logger);
3707 self.best_block = BestBlock::new(header.prev_blockhash, height - 1);
3710 fn transaction_unconfirmed<B: Deref, F: Deref, L: Deref>(
3714 fee_estimator: &LowerBoundedFeeEstimator<F>,
3717 B::Target: BroadcasterInterface,
3718 F::Target: FeeEstimator,
3721 let mut removed_height = None;
3722 for entry in self.onchain_events_awaiting_threshold_conf.iter() {
3723 if entry.txid == *txid {
3724 removed_height = Some(entry.height);
3729 if let Some(removed_height) = removed_height {
3730 log_info!(logger, "transaction_unconfirmed of txid {} implies height {} was reorg'd out", txid, removed_height);
3731 self.onchain_events_awaiting_threshold_conf.retain(|ref entry| if entry.height >= removed_height {
3732 log_info!(logger, "Transaction {} reorg'd out", entry.txid);
3737 debug_assert!(!self.onchain_events_awaiting_threshold_conf.iter().any(|ref entry| entry.txid == *txid));
3739 self.onchain_tx_handler.transaction_unconfirmed(txid, broadcaster, fee_estimator, logger);
3742 /// Filters a block's `txdata` for transactions spending watched outputs or for any child
3743 /// transactions thereof.
3744 fn filter_block<'a>(&self, txdata: &TransactionData<'a>) -> Vec<&'a Transaction> {
3745 let mut matched_txn = HashSet::new();
3746 txdata.iter().filter(|&&(_, tx)| {
3747 let mut matches = self.spends_watched_output(tx);
3748 for input in tx.input.iter() {
3749 if matches { break; }
3750 if matched_txn.contains(&input.previous_output.txid) {
3755 matched_txn.insert(tx.txid());
3758 }).map(|(_, tx)| *tx).collect()
3761 /// Checks if a given transaction spends any watched outputs.
3762 fn spends_watched_output(&self, tx: &Transaction) -> bool {
3763 for input in tx.input.iter() {
3764 if let Some(outputs) = self.get_outputs_to_watch().get(&input.previous_output.txid) {
3765 for (idx, _script_pubkey) in outputs.iter() {
3766 if *idx == input.previous_output.vout {
3769 // If the expected script is a known type, check that the witness
3770 // appears to be spending the correct type (ie that the match would
3771 // actually succeed in BIP 158/159-style filters).
3772 if _script_pubkey.is_v0_p2wsh() {
3773 if input.witness.last().unwrap().to_vec() == deliberately_bogus_accepted_htlc_witness_program() {
3774 // In at least one test we use a deliberately bogus witness
3775 // script which hit an old panic. Thus, we check for that here
3776 // and avoid the assert if its the expected bogus script.
3780 assert_eq!(&bitcoin::Address::p2wsh(&Script::from(input.witness.last().unwrap().to_vec()), bitcoin::Network::Bitcoin).script_pubkey(), _script_pubkey);
3781 } else if _script_pubkey.is_v0_p2wpkh() {
3782 assert_eq!(&bitcoin::Address::p2wpkh(&bitcoin::PublicKey::from_slice(&input.witness.last().unwrap()).unwrap(), bitcoin::Network::Bitcoin).unwrap().script_pubkey(), _script_pubkey);
3783 } else { panic!(); }
3794 fn should_broadcast_holder_commitment_txn<L: Deref>(&self, logger: &L) -> bool where L::Target: Logger {
3795 // There's no need to broadcast our commitment transaction if we've seen one confirmed (even
3796 // with 1 confirmation) as it'll be rejected as duplicate/conflicting.
3797 if self.funding_spend_confirmed.is_some() ||
3798 self.onchain_events_awaiting_threshold_conf.iter().find(|event| match event.event {
3799 OnchainEvent::FundingSpendConfirmation { .. } => true,
3805 // We need to consider all HTLCs which are:
3806 // * in any unrevoked counterparty commitment transaction, as they could broadcast said
3807 // transactions and we'd end up in a race, or
3808 // * are in our latest holder commitment transaction, as this is the thing we will
3809 // broadcast if we go on-chain.
3810 // Note that we consider HTLCs which were below dust threshold here - while they don't
3811 // strictly imply that we need to fail the channel, we need to go ahead and fail them back
3812 // to the source, and if we don't fail the channel we will have to ensure that the next
3813 // updates that peer sends us are update_fails, failing the channel if not. It's probably
3814 // easier to just fail the channel as this case should be rare enough anyway.
3815 let height = self.best_block.height();
3816 macro_rules! scan_commitment {
3817 ($htlcs: expr, $holder_tx: expr) => {
3818 for ref htlc in $htlcs {
3819 // For inbound HTLCs which we know the preimage for, we have to ensure we hit the
3820 // chain with enough room to claim the HTLC without our counterparty being able to
3821 // time out the HTLC first.
3822 // For outbound HTLCs which our counterparty hasn't failed/claimed, our primary
3823 // concern is being able to claim the corresponding inbound HTLC (on another
3824 // channel) before it expires. In fact, we don't even really care if our
3825 // counterparty here claims such an outbound HTLC after it expired as long as we
3826 // can still claim the corresponding HTLC. Thus, to avoid needlessly hitting the
3827 // chain when our counterparty is waiting for expiration to off-chain fail an HTLC
3828 // we give ourselves a few blocks of headroom after expiration before going
3829 // on-chain for an expired HTLC.
3830 // Note that, to avoid a potential attack whereby a node delays claiming an HTLC
3831 // from us until we've reached the point where we go on-chain with the
3832 // corresponding inbound HTLC, we must ensure that outbound HTLCs go on chain at
3833 // least CLTV_CLAIM_BUFFER blocks prior to the inbound HTLC.
3834 // aka outbound_cltv + LATENCY_GRACE_PERIOD_BLOCKS == height - CLTV_CLAIM_BUFFER
3835 // inbound_cltv == height + CLTV_CLAIM_BUFFER
3836 // outbound_cltv + LATENCY_GRACE_PERIOD_BLOCKS + CLTV_CLAIM_BUFFER <= inbound_cltv - CLTV_CLAIM_BUFFER
3837 // LATENCY_GRACE_PERIOD_BLOCKS + 2*CLTV_CLAIM_BUFFER <= inbound_cltv - outbound_cltv
3838 // CLTV_EXPIRY_DELTA <= inbound_cltv - outbound_cltv (by check in ChannelManager::decode_update_add_htlc_onion)
3839 // LATENCY_GRACE_PERIOD_BLOCKS + 2*CLTV_CLAIM_BUFFER <= CLTV_EXPIRY_DELTA
3840 // The final, above, condition is checked for statically in channelmanager
3841 // with CHECK_CLTV_EXPIRY_SANITY_2.
3842 let htlc_outbound = $holder_tx == htlc.offered;
3843 if ( htlc_outbound && htlc.cltv_expiry + LATENCY_GRACE_PERIOD_BLOCKS <= height) ||
3844 (!htlc_outbound && htlc.cltv_expiry <= height + CLTV_CLAIM_BUFFER && self.payment_preimages.contains_key(&htlc.payment_hash)) {
3845 log_info!(logger, "Force-closing channel due to {} HTLC timeout, HTLC expiry is {}", if htlc_outbound { "outbound" } else { "inbound "}, htlc.cltv_expiry);
3852 scan_commitment!(self.current_holder_commitment_tx.htlc_outputs.iter().map(|&(ref a, _, _)| a), true);
3854 if let Some(ref txid) = self.current_counterparty_commitment_txid {
3855 if let Some(ref htlc_outputs) = self.counterparty_claimable_outpoints.get(txid) {
3856 scan_commitment!(htlc_outputs.iter().map(|&(ref a, _)| a), false);
3859 if let Some(ref txid) = self.prev_counterparty_commitment_txid {
3860 if let Some(ref htlc_outputs) = self.counterparty_claimable_outpoints.get(txid) {
3861 scan_commitment!(htlc_outputs.iter().map(|&(ref a, _)| a), false);
3868 /// Check if any transaction broadcasted is resolving HTLC output by a success or timeout on a holder
3869 /// or counterparty commitment tx, if so send back the source, preimage if found and payment_hash of resolved HTLC
3870 fn is_resolving_htlc_output<L: Deref>(&mut self, tx: &Transaction, height: u32, block_hash: &BlockHash, logger: &L) where L::Target: Logger {
3871 'outer_loop: for input in &tx.input {
3872 let mut payment_data = None;
3873 let htlc_claim = HTLCClaim::from_witness(&input.witness);
3874 let revocation_sig_claim = htlc_claim == Some(HTLCClaim::Revocation);
3875 let accepted_preimage_claim = htlc_claim == Some(HTLCClaim::AcceptedPreimage);
3876 #[cfg(not(fuzzing))]
3877 let accepted_timeout_claim = htlc_claim == Some(HTLCClaim::AcceptedTimeout);
3878 let offered_preimage_claim = htlc_claim == Some(HTLCClaim::OfferedPreimage);
3879 #[cfg(not(fuzzing))]
3880 let offered_timeout_claim = htlc_claim == Some(HTLCClaim::OfferedTimeout);
3882 let mut payment_preimage = PaymentPreimage([0; 32]);
3883 if offered_preimage_claim || accepted_preimage_claim {
3884 payment_preimage.0.copy_from_slice(input.witness.second_to_last().unwrap());
3887 macro_rules! log_claim {
3888 ($tx_info: expr, $holder_tx: expr, $htlc: expr, $source_avail: expr) => {
3889 let outbound_htlc = $holder_tx == $htlc.offered;
3890 // HTLCs must either be claimed by a matching script type or through the
3892 #[cfg(not(fuzzing))] // Note that the fuzzer is not bound by pesky things like "signatures"
3893 debug_assert!(!$htlc.offered || offered_preimage_claim || offered_timeout_claim || revocation_sig_claim);
3894 #[cfg(not(fuzzing))] // Note that the fuzzer is not bound by pesky things like "signatures"
3895 debug_assert!($htlc.offered || accepted_preimage_claim || accepted_timeout_claim || revocation_sig_claim);
3896 // Further, only exactly one of the possible spend paths should have been
3897 // matched by any HTLC spend:
3898 #[cfg(not(fuzzing))] // Note that the fuzzer is not bound by pesky things like "signatures"
3899 debug_assert_eq!(accepted_preimage_claim as u8 + accepted_timeout_claim as u8 +
3900 offered_preimage_claim as u8 + offered_timeout_claim as u8 +
3901 revocation_sig_claim as u8, 1);
3902 if ($holder_tx && revocation_sig_claim) ||
3903 (outbound_htlc && !$source_avail && (accepted_preimage_claim || offered_preimage_claim)) {
3904 log_error!(logger, "Input spending {} ({}:{}) in {} resolves {} HTLC with payment hash {} with {}!",
3905 $tx_info, input.previous_output.txid, input.previous_output.vout, tx.txid(),
3906 if outbound_htlc { "outbound" } else { "inbound" }, &$htlc.payment_hash,
3907 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" });
3909 log_info!(logger, "Input spending {} ({}:{}) in {} resolves {} HTLC with payment hash {} with {}",
3910 $tx_info, input.previous_output.txid, input.previous_output.vout, tx.txid(),
3911 if outbound_htlc { "outbound" } else { "inbound" }, &$htlc.payment_hash,
3912 if revocation_sig_claim { "revocation sig" } else if accepted_preimage_claim || offered_preimage_claim { "preimage" } else { "timeout" });
3917 macro_rules! check_htlc_valid_counterparty {
3918 ($counterparty_txid: expr, $htlc_output: expr) => {
3919 if let Some(txid) = $counterparty_txid {
3920 for &(ref pending_htlc, ref pending_source) in self.counterparty_claimable_outpoints.get(&txid).unwrap() {
3921 if pending_htlc.payment_hash == $htlc_output.payment_hash && pending_htlc.amount_msat == $htlc_output.amount_msat {
3922 if let &Some(ref source) = pending_source {
3923 log_claim!("revoked counterparty commitment tx", false, pending_htlc, true);
3924 payment_data = Some(((**source).clone(), $htlc_output.payment_hash, $htlc_output.amount_msat));
3933 macro_rules! scan_commitment {
3934 ($htlcs: expr, $tx_info: expr, $holder_tx: expr) => {
3935 for (ref htlc_output, source_option) in $htlcs {
3936 if Some(input.previous_output.vout) == htlc_output.transaction_output_index {
3937 if let Some(ref source) = source_option {
3938 log_claim!($tx_info, $holder_tx, htlc_output, true);
3939 // We have a resolution of an HTLC either from one of our latest
3940 // holder commitment transactions or an unrevoked counterparty commitment
3941 // transaction. This implies we either learned a preimage, the HTLC
3942 // has timed out, or we screwed up. In any case, we should now
3943 // resolve the source HTLC with the original sender.
3944 payment_data = Some(((*source).clone(), htlc_output.payment_hash, htlc_output.amount_msat));
3945 } else if !$holder_tx {
3946 check_htlc_valid_counterparty!(self.current_counterparty_commitment_txid, htlc_output);
3947 if payment_data.is_none() {
3948 check_htlc_valid_counterparty!(self.prev_counterparty_commitment_txid, htlc_output);
3951 if payment_data.is_none() {
3952 log_claim!($tx_info, $holder_tx, htlc_output, false);
3953 let outbound_htlc = $holder_tx == htlc_output.offered;
3954 self.onchain_events_awaiting_threshold_conf.push(OnchainEventEntry {
3955 txid: tx.txid(), height, block_hash: Some(*block_hash), transaction: Some(tx.clone()),
3956 event: OnchainEvent::HTLCSpendConfirmation {
3957 commitment_tx_output_idx: input.previous_output.vout,
3958 preimage: if accepted_preimage_claim || offered_preimage_claim {
3959 Some(payment_preimage) } else { None },
3960 // If this is a payment to us (ie !outbound_htlc), wait for
3961 // the CSV delay before dropping the HTLC from claimable
3962 // balance if the claim was an HTLC-Success transaction (ie
3963 // accepted_preimage_claim).
3964 on_to_local_output_csv: if accepted_preimage_claim && !outbound_htlc {
3965 Some(self.on_holder_tx_csv) } else { None },
3968 continue 'outer_loop;
3975 if input.previous_output.txid == self.current_holder_commitment_tx.txid {
3976 scan_commitment!(self.current_holder_commitment_tx.htlc_outputs.iter().map(|&(ref a, _, ref b)| (a, b.as_ref())),
3977 "our latest holder commitment tx", true);
3979 if let Some(ref prev_holder_signed_commitment_tx) = self.prev_holder_signed_commitment_tx {
3980 if input.previous_output.txid == prev_holder_signed_commitment_tx.txid {
3981 scan_commitment!(prev_holder_signed_commitment_tx.htlc_outputs.iter().map(|&(ref a, _, ref b)| (a, b.as_ref())),
3982 "our previous holder commitment tx", true);
3985 if let Some(ref htlc_outputs) = self.counterparty_claimable_outpoints.get(&input.previous_output.txid) {
3986 scan_commitment!(htlc_outputs.iter().map(|&(ref a, ref b)| (a, (b.as_ref().clone()).map(|boxed| &**boxed))),
3987 "counterparty commitment tx", false);
3990 // Check that scan_commitment, above, decided there is some source worth relaying an
3991 // HTLC resolution backwards to and figure out whether we learned a preimage from it.
3992 if let Some((source, payment_hash, amount_msat)) = payment_data {
3993 if accepted_preimage_claim {
3994 if !self.pending_monitor_events.iter().any(
3995 |update| if let &MonitorEvent::HTLCEvent(ref upd) = update { upd.source == source } else { false }) {
3996 self.onchain_events_awaiting_threshold_conf.push(OnchainEventEntry {
3999 block_hash: Some(*block_hash),
4000 transaction: Some(tx.clone()),
4001 event: OnchainEvent::HTLCSpendConfirmation {
4002 commitment_tx_output_idx: input.previous_output.vout,
4003 preimage: Some(payment_preimage),
4004 on_to_local_output_csv: None,
4007 self.pending_monitor_events.push(MonitorEvent::HTLCEvent(HTLCUpdate {
4009 payment_preimage: Some(payment_preimage),
4011 htlc_value_satoshis: Some(amount_msat / 1000),
4014 } else if offered_preimage_claim {
4015 if !self.pending_monitor_events.iter().any(
4016 |update| if let &MonitorEvent::HTLCEvent(ref upd) = update {
4017 upd.source == source
4019 self.onchain_events_awaiting_threshold_conf.push(OnchainEventEntry {
4021 transaction: Some(tx.clone()),
4023 block_hash: Some(*block_hash),
4024 event: OnchainEvent::HTLCSpendConfirmation {
4025 commitment_tx_output_idx: input.previous_output.vout,
4026 preimage: Some(payment_preimage),
4027 on_to_local_output_csv: None,
4030 self.pending_monitor_events.push(MonitorEvent::HTLCEvent(HTLCUpdate {
4032 payment_preimage: Some(payment_preimage),
4034 htlc_value_satoshis: Some(amount_msat / 1000),
4038 self.onchain_events_awaiting_threshold_conf.retain(|ref entry| {
4039 if entry.height != height { return true; }
4041 OnchainEvent::HTLCUpdate { source: ref htlc_source, .. } => {
4042 *htlc_source != source
4047 let entry = OnchainEventEntry {
4049 transaction: Some(tx.clone()),
4051 block_hash: Some(*block_hash),
4052 event: OnchainEvent::HTLCUpdate {
4053 source, payment_hash,
4054 htlc_value_satoshis: Some(amount_msat / 1000),
4055 commitment_tx_output_idx: Some(input.previous_output.vout),
4058 log_info!(logger, "Failing HTLC with payment_hash {} timeout by a spend tx, waiting for confirmation (at height {})", &payment_hash, entry.confirmation_threshold());
4059 self.onchain_events_awaiting_threshold_conf.push(entry);
4065 fn get_spendable_outputs(&self, tx: &Transaction) -> Vec<SpendableOutputDescriptor> {
4066 let mut spendable_outputs = Vec::new();
4067 for (i, outp) in tx.output.iter().enumerate() {
4068 if outp.script_pubkey == self.destination_script {
4069 spendable_outputs.push(SpendableOutputDescriptor::StaticOutput {
4070 outpoint: OutPoint { txid: tx.txid(), index: i as u16 },
4071 output: outp.clone(),
4074 if let Some(ref broadcasted_holder_revokable_script) = self.broadcasted_holder_revokable_script {
4075 if broadcasted_holder_revokable_script.0 == outp.script_pubkey {
4076 spendable_outputs.push(SpendableOutputDescriptor::DelayedPaymentOutput(DelayedPaymentOutputDescriptor {
4077 outpoint: OutPoint { txid: tx.txid(), index: i as u16 },
4078 per_commitment_point: broadcasted_holder_revokable_script.1,
4079 to_self_delay: self.on_holder_tx_csv,
4080 output: outp.clone(),
4081 revocation_pubkey: broadcasted_holder_revokable_script.2.clone(),
4082 channel_keys_id: self.channel_keys_id,
4083 channel_value_satoshis: self.channel_value_satoshis,
4087 if self.counterparty_payment_script == outp.script_pubkey {
4088 spendable_outputs.push(SpendableOutputDescriptor::StaticPaymentOutput(StaticPaymentOutputDescriptor {
4089 outpoint: OutPoint { txid: tx.txid(), index: i as u16 },
4090 output: outp.clone(),
4091 channel_keys_id: self.channel_keys_id,
4092 channel_value_satoshis: self.channel_value_satoshis,
4093 channel_transaction_parameters: Some(self.onchain_tx_handler.channel_transaction_parameters.clone()),
4096 if self.shutdown_script.as_ref() == Some(&outp.script_pubkey) {
4097 spendable_outputs.push(SpendableOutputDescriptor::StaticOutput {
4098 outpoint: OutPoint { txid: tx.txid(), index: i as u16 },
4099 output: outp.clone(),
4106 /// Checks if the confirmed transaction is paying funds back to some address we can assume to
4108 fn check_tx_and_push_spendable_outputs<L: Deref>(
4109 &mut self, tx: &Transaction, height: u32, block_hash: &BlockHash, logger: &L,
4110 ) where L::Target: Logger {
4111 for spendable_output in self.get_spendable_outputs(tx) {
4112 let entry = OnchainEventEntry {
4114 transaction: Some(tx.clone()),
4116 block_hash: Some(*block_hash),
4117 event: OnchainEvent::MaturingOutput { descriptor: spendable_output.clone() },
4119 log_info!(logger, "Received spendable output {}, spendable at height {}", log_spendable!(spendable_output), entry.confirmation_threshold());
4120 self.onchain_events_awaiting_threshold_conf.push(entry);
4125 impl<Signer: WriteableEcdsaChannelSigner, T: Deref, F: Deref, L: Deref> chain::Listen for (ChannelMonitor<Signer>, T, F, L)
4127 T::Target: BroadcasterInterface,
4128 F::Target: FeeEstimator,
4131 fn filtered_block_connected(&self, header: &BlockHeader, txdata: &TransactionData, height: u32) {
4132 self.0.block_connected(header, txdata, height, &*self.1, &*self.2, &*self.3);
4135 fn block_disconnected(&self, header: &BlockHeader, height: u32) {
4136 self.0.block_disconnected(header, height, &*self.1, &*self.2, &*self.3);
4140 impl<Signer: WriteableEcdsaChannelSigner, M, T: Deref, F: Deref, L: Deref> chain::Confirm for (M, T, F, L)
4142 M: Deref<Target = ChannelMonitor<Signer>>,
4143 T::Target: BroadcasterInterface,
4144 F::Target: FeeEstimator,
4147 fn transactions_confirmed(&self, header: &BlockHeader, txdata: &TransactionData, height: u32) {
4148 self.0.transactions_confirmed(header, txdata, height, &*self.1, &*self.2, &*self.3);
4151 fn transaction_unconfirmed(&self, txid: &Txid) {
4152 self.0.transaction_unconfirmed(txid, &*self.1, &*self.2, &*self.3);
4155 fn best_block_updated(&self, header: &BlockHeader, height: u32) {
4156 self.0.best_block_updated(header, height, &*self.1, &*self.2, &*self.3);
4159 fn get_relevant_txids(&self) -> Vec<(Txid, Option<BlockHash>)> {
4160 self.0.get_relevant_txids()
4164 const MAX_ALLOC_SIZE: usize = 64*1024;
4166 impl<'a, 'b, ES: EntropySource, SP: SignerProvider> ReadableArgs<(&'a ES, &'b SP)>
4167 for (BlockHash, ChannelMonitor<SP::Signer>) {
4168 fn read<R: io::Read>(reader: &mut R, args: (&'a ES, &'b SP)) -> Result<Self, DecodeError> {
4169 macro_rules! unwrap_obj {
4173 Err(_) => return Err(DecodeError::InvalidValue),
4178 let (entropy_source, signer_provider) = args;
4180 let _ver = read_ver_prefix!(reader, SERIALIZATION_VERSION);
4182 let latest_update_id: u64 = Readable::read(reader)?;
4183 let commitment_transaction_number_obscure_factor = <U48 as Readable>::read(reader)?.0;
4185 let destination_script = Readable::read(reader)?;
4186 let broadcasted_holder_revokable_script = match <u8 as Readable>::read(reader)? {
4188 let revokable_address = Readable::read(reader)?;
4189 let per_commitment_point = Readable::read(reader)?;
4190 let revokable_script = Readable::read(reader)?;
4191 Some((revokable_address, per_commitment_point, revokable_script))
4194 _ => return Err(DecodeError::InvalidValue),
4196 let mut counterparty_payment_script: Script = Readable::read(reader)?;
4197 let shutdown_script = {
4198 let script = <Script as Readable>::read(reader)?;
4199 if script.is_empty() { None } else { Some(script) }
4202 let channel_keys_id = Readable::read(reader)?;
4203 let holder_revocation_basepoint = Readable::read(reader)?;
4204 // Technically this can fail and serialize fail a round-trip, but only for serialization of
4205 // barely-init'd ChannelMonitors that we can't do anything with.
4206 let outpoint = OutPoint {
4207 txid: Readable::read(reader)?,
4208 index: Readable::read(reader)?,
4210 let funding_info = (outpoint, Readable::read(reader)?);
4211 let current_counterparty_commitment_txid = Readable::read(reader)?;
4212 let prev_counterparty_commitment_txid = Readable::read(reader)?;
4214 let counterparty_commitment_params = Readable::read(reader)?;
4215 let funding_redeemscript = Readable::read(reader)?;
4216 let channel_value_satoshis = Readable::read(reader)?;
4218 let their_cur_per_commitment_points = {
4219 let first_idx = <U48 as Readable>::read(reader)?.0;
4223 let first_point = Readable::read(reader)?;
4224 let second_point_slice: [u8; 33] = Readable::read(reader)?;
4225 if second_point_slice[0..32] == [0; 32] && second_point_slice[32] == 0 {
4226 Some((first_idx, first_point, None))
4228 Some((first_idx, first_point, Some(unwrap_obj!(PublicKey::from_slice(&second_point_slice)))))
4233 let on_holder_tx_csv: u16 = Readable::read(reader)?;
4235 let commitment_secrets = Readable::read(reader)?;
4237 macro_rules! read_htlc_in_commitment {
4240 let offered: bool = Readable::read(reader)?;
4241 let amount_msat: u64 = Readable::read(reader)?;
4242 let cltv_expiry: u32 = Readable::read(reader)?;
4243 let payment_hash: PaymentHash = Readable::read(reader)?;
4244 let transaction_output_index: Option<u32> = Readable::read(reader)?;
4246 HTLCOutputInCommitment {
4247 offered, amount_msat, cltv_expiry, payment_hash, transaction_output_index
4253 let counterparty_claimable_outpoints_len: u64 = Readable::read(reader)?;
4254 let mut counterparty_claimable_outpoints = HashMap::with_capacity(cmp::min(counterparty_claimable_outpoints_len as usize, MAX_ALLOC_SIZE / 64));
4255 for _ in 0..counterparty_claimable_outpoints_len {
4256 let txid: Txid = Readable::read(reader)?;
4257 let htlcs_count: u64 = Readable::read(reader)?;
4258 let mut htlcs = Vec::with_capacity(cmp::min(htlcs_count as usize, MAX_ALLOC_SIZE / 32));
4259 for _ in 0..htlcs_count {
4260 htlcs.push((read_htlc_in_commitment!(), <Option<HTLCSource> as Readable>::read(reader)?.map(|o: HTLCSource| Box::new(o))));
4262 if let Some(_) = counterparty_claimable_outpoints.insert(txid, htlcs) {
4263 return Err(DecodeError::InvalidValue);
4267 let counterparty_commitment_txn_on_chain_len: u64 = Readable::read(reader)?;
4268 let mut counterparty_commitment_txn_on_chain = HashMap::with_capacity(cmp::min(counterparty_commitment_txn_on_chain_len as usize, MAX_ALLOC_SIZE / 32));
4269 for _ in 0..counterparty_commitment_txn_on_chain_len {
4270 let txid: Txid = Readable::read(reader)?;
4271 let commitment_number = <U48 as Readable>::read(reader)?.0;
4272 if let Some(_) = counterparty_commitment_txn_on_chain.insert(txid, commitment_number) {
4273 return Err(DecodeError::InvalidValue);
4277 let counterparty_hash_commitment_number_len: u64 = Readable::read(reader)?;
4278 let mut counterparty_hash_commitment_number = HashMap::with_capacity(cmp::min(counterparty_hash_commitment_number_len as usize, MAX_ALLOC_SIZE / 32));
4279 for _ in 0..counterparty_hash_commitment_number_len {
4280 let payment_hash: PaymentHash = Readable::read(reader)?;
4281 let commitment_number = <U48 as Readable>::read(reader)?.0;
4282 if let Some(_) = counterparty_hash_commitment_number.insert(payment_hash, commitment_number) {
4283 return Err(DecodeError::InvalidValue);
4287 let mut prev_holder_signed_commitment_tx: Option<HolderSignedTx> =
4288 match <u8 as Readable>::read(reader)? {
4291 Some(Readable::read(reader)?)
4293 _ => return Err(DecodeError::InvalidValue),
4295 let mut current_holder_commitment_tx: HolderSignedTx = Readable::read(reader)?;
4297 let current_counterparty_commitment_number = <U48 as Readable>::read(reader)?.0;
4298 let current_holder_commitment_number = <U48 as Readable>::read(reader)?.0;
4300 let payment_preimages_len: u64 = Readable::read(reader)?;
4301 let mut payment_preimages = HashMap::with_capacity(cmp::min(payment_preimages_len as usize, MAX_ALLOC_SIZE / 32));
4302 for _ in 0..payment_preimages_len {
4303 let preimage: PaymentPreimage = Readable::read(reader)?;
4304 let hash = PaymentHash(Sha256::hash(&preimage.0[..]).into_inner());
4305 if let Some(_) = payment_preimages.insert(hash, preimage) {
4306 return Err(DecodeError::InvalidValue);
4310 let pending_monitor_events_len: u64 = Readable::read(reader)?;
4311 let mut pending_monitor_events = Some(
4312 Vec::with_capacity(cmp::min(pending_monitor_events_len as usize, MAX_ALLOC_SIZE / (32 + 8*3))));
4313 for _ in 0..pending_monitor_events_len {
4314 let ev = match <u8 as Readable>::read(reader)? {
4315 0 => MonitorEvent::HTLCEvent(Readable::read(reader)?),
4316 1 => MonitorEvent::HolderForceClosed(funding_info.0),
4317 _ => return Err(DecodeError::InvalidValue)
4319 pending_monitor_events.as_mut().unwrap().push(ev);
4322 let pending_events_len: u64 = Readable::read(reader)?;
4323 let mut pending_events = Vec::with_capacity(cmp::min(pending_events_len as usize, MAX_ALLOC_SIZE / mem::size_of::<Event>()));
4324 for _ in 0..pending_events_len {
4325 if let Some(event) = MaybeReadable::read(reader)? {
4326 pending_events.push(event);
4330 let best_block = BestBlock::new(Readable::read(reader)?, Readable::read(reader)?);
4332 let waiting_threshold_conf_len: u64 = Readable::read(reader)?;
4333 let mut onchain_events_awaiting_threshold_conf = Vec::with_capacity(cmp::min(waiting_threshold_conf_len as usize, MAX_ALLOC_SIZE / 128));
4334 for _ in 0..waiting_threshold_conf_len {
4335 if let Some(val) = MaybeReadable::read(reader)? {
4336 onchain_events_awaiting_threshold_conf.push(val);
4340 let outputs_to_watch_len: u64 = Readable::read(reader)?;
4341 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>>())));
4342 for _ in 0..outputs_to_watch_len {
4343 let txid = Readable::read(reader)?;
4344 let outputs_len: u64 = Readable::read(reader)?;
4345 let mut outputs = Vec::with_capacity(cmp::min(outputs_len as usize, MAX_ALLOC_SIZE / (mem::size_of::<u32>() + mem::size_of::<Script>())));
4346 for _ in 0..outputs_len {
4347 outputs.push((Readable::read(reader)?, Readable::read(reader)?));
4349 if let Some(_) = outputs_to_watch.insert(txid, outputs) {
4350 return Err(DecodeError::InvalidValue);
4353 let onchain_tx_handler: OnchainTxHandler<SP::Signer> = ReadableArgs::read(
4354 reader, (entropy_source, signer_provider, channel_value_satoshis, channel_keys_id)
4357 let lockdown_from_offchain = Readable::read(reader)?;
4358 let holder_tx_signed = Readable::read(reader)?;
4360 if let Some(prev_commitment_tx) = prev_holder_signed_commitment_tx.as_mut() {
4361 let prev_holder_value = onchain_tx_handler.get_prev_holder_commitment_to_self_value();
4362 if prev_holder_value.is_none() { return Err(DecodeError::InvalidValue); }
4363 if prev_commitment_tx.to_self_value_sat == u64::max_value() {
4364 prev_commitment_tx.to_self_value_sat = prev_holder_value.unwrap();
4365 } else if prev_commitment_tx.to_self_value_sat != prev_holder_value.unwrap() {
4366 return Err(DecodeError::InvalidValue);
4370 let cur_holder_value = onchain_tx_handler.get_cur_holder_commitment_to_self_value();
4371 if current_holder_commitment_tx.to_self_value_sat == u64::max_value() {
4372 current_holder_commitment_tx.to_self_value_sat = cur_holder_value;
4373 } else if current_holder_commitment_tx.to_self_value_sat != cur_holder_value {
4374 return Err(DecodeError::InvalidValue);
4377 let mut funding_spend_confirmed = None;
4378 let mut htlcs_resolved_on_chain = Some(Vec::new());
4379 let mut funding_spend_seen = Some(false);
4380 let mut counterparty_node_id = None;
4381 let mut confirmed_commitment_tx_counterparty_output = None;
4382 let mut spendable_txids_confirmed = Some(Vec::new());
4383 let mut counterparty_fulfilled_htlcs = Some(HashMap::new());
4384 let mut initial_counterparty_commitment_info = None;
4385 read_tlv_fields!(reader, {
4386 (1, funding_spend_confirmed, option),
4387 (3, htlcs_resolved_on_chain, optional_vec),
4388 (5, pending_monitor_events, optional_vec),
4389 (7, funding_spend_seen, option),
4390 (9, counterparty_node_id, option),
4391 (11, confirmed_commitment_tx_counterparty_output, option),
4392 (13, spendable_txids_confirmed, optional_vec),
4393 (15, counterparty_fulfilled_htlcs, option),
4394 (17, initial_counterparty_commitment_info, option),
4397 // Monitors for anchor outputs channels opened in v0.0.116 suffered from a bug in which the
4398 // wrong `counterparty_payment_script` was being tracked. Fix it now on deserialization to
4399 // give them a chance to recognize the spendable output.
4400 if onchain_tx_handler.channel_type_features().supports_anchors_zero_fee_htlc_tx() &&
4401 counterparty_payment_script.is_v0_p2wpkh()
4403 let payment_point = onchain_tx_handler.channel_transaction_parameters.holder_pubkeys.payment_point;
4404 counterparty_payment_script =
4405 chan_utils::get_to_countersignatory_with_anchors_redeemscript(&payment_point).to_v0_p2wsh();
4408 Ok((best_block.block_hash(), ChannelMonitor::from_impl(ChannelMonitorImpl {
4410 commitment_transaction_number_obscure_factor,
4413 broadcasted_holder_revokable_script,
4414 counterparty_payment_script,
4418 holder_revocation_basepoint,
4420 current_counterparty_commitment_txid,
4421 prev_counterparty_commitment_txid,
4423 counterparty_commitment_params,
4424 funding_redeemscript,
4425 channel_value_satoshis,
4426 their_cur_per_commitment_points,
4431 counterparty_claimable_outpoints,
4432 counterparty_commitment_txn_on_chain,
4433 counterparty_hash_commitment_number,
4434 counterparty_fulfilled_htlcs: counterparty_fulfilled_htlcs.unwrap(),
4436 prev_holder_signed_commitment_tx,
4437 current_holder_commitment_tx,
4438 current_counterparty_commitment_number,
4439 current_holder_commitment_number,
4442 pending_monitor_events: pending_monitor_events.unwrap(),
4444 is_processing_pending_events: false,
4446 onchain_events_awaiting_threshold_conf,
4451 lockdown_from_offchain,
4453 funding_spend_seen: funding_spend_seen.unwrap(),
4454 funding_spend_confirmed,
4455 confirmed_commitment_tx_counterparty_output,
4456 htlcs_resolved_on_chain: htlcs_resolved_on_chain.unwrap(),
4457 spendable_txids_confirmed: spendable_txids_confirmed.unwrap(),
4460 counterparty_node_id,
4461 initial_counterparty_commitment_info,
4468 use bitcoin::blockdata::script::{Script, Builder};
4469 use bitcoin::blockdata::opcodes;
4470 use bitcoin::blockdata::transaction::{Transaction, TxIn, TxOut, EcdsaSighashType};
4471 use bitcoin::blockdata::transaction::OutPoint as BitcoinOutPoint;
4472 use bitcoin::util::sighash;
4473 use bitcoin::hashes::Hash;
4474 use bitcoin::hashes::sha256::Hash as Sha256;
4475 use bitcoin::hashes::hex::FromHex;
4476 use bitcoin::hash_types::{BlockHash, Txid};
4477 use bitcoin::network::constants::Network;
4478 use bitcoin::secp256k1::{SecretKey,PublicKey};
4479 use bitcoin::secp256k1::Secp256k1;
4483 use crate::chain::chaininterface::LowerBoundedFeeEstimator;
4485 use super::ChannelMonitorUpdateStep;
4486 use crate::{check_added_monitors, check_spends, get_local_commitment_txn, get_monitor, get_route_and_payment_hash, unwrap_send_err};
4487 use crate::chain::{BestBlock, Confirm};
4488 use crate::chain::channelmonitor::ChannelMonitor;
4489 use crate::chain::package::{weight_offered_htlc, weight_received_htlc, weight_revoked_offered_htlc, weight_revoked_received_htlc, WEIGHT_REVOKED_OUTPUT};
4490 use crate::chain::transaction::OutPoint;
4491 use crate::sign::InMemorySigner;
4492 use crate::ln::{PaymentPreimage, PaymentHash};
4493 use crate::ln::chan_utils;
4494 use crate::ln::chan_utils::{HTLCOutputInCommitment, ChannelPublicKeys, ChannelTransactionParameters, HolderCommitmentTransaction, CounterpartyChannelTransactionParameters};
4495 use crate::ln::channelmanager::{PaymentSendFailure, PaymentId, RecipientOnionFields};
4496 use crate::ln::functional_test_utils::*;
4497 use crate::ln::script::ShutdownScript;
4498 use crate::util::errors::APIError;
4499 use crate::util::test_utils::{TestLogger, TestBroadcaster, TestFeeEstimator};
4500 use crate::util::ser::{ReadableArgs, Writeable};
4501 use crate::sync::{Arc, Mutex};
4503 use bitcoin::{PackedLockTime, Sequence, Witness};
4504 use crate::ln::features::ChannelTypeFeatures;
4505 use crate::prelude::*;
4507 fn do_test_funding_spend_refuses_updates(use_local_txn: bool) {
4508 // Previously, monitor updates were allowed freely even after a funding-spend transaction
4509 // confirmed. This would allow a race condition where we could receive a payment (including
4510 // the counterparty revoking their broadcasted state!) and accept it without recourse as
4511 // long as the ChannelMonitor receives the block first, the full commitment update dance
4512 // occurs after the block is connected, and before the ChannelManager receives the block.
4513 // Obviously this is an incredibly contrived race given the counterparty would be risking
4514 // their full channel balance for it, but its worth fixing nonetheless as it makes the
4515 // potential ChannelMonitor states simpler to reason about.
4517 // This test checks said behavior, as well as ensuring a ChannelMonitorUpdate with multiple
4518 // updates is handled correctly in such conditions.
4519 let chanmon_cfgs = create_chanmon_cfgs(3);
4520 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
4521 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
4522 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
4523 let channel = create_announced_chan_between_nodes(&nodes, 0, 1);
4524 create_announced_chan_between_nodes(&nodes, 1, 2);
4526 // Rebalance somewhat
4527 send_payment(&nodes[0], &[&nodes[1]], 10_000_000);
4529 // First route two payments for testing at the end
4530 let payment_preimage_1 = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 1_000_000).0;
4531 let payment_preimage_2 = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 1_000_000).0;
4533 let local_txn = get_local_commitment_txn!(nodes[1], channel.2);
4534 assert_eq!(local_txn.len(), 1);
4535 let remote_txn = get_local_commitment_txn!(nodes[0], channel.2);
4536 assert_eq!(remote_txn.len(), 3); // Commitment and two HTLC-Timeouts
4537 check_spends!(remote_txn[1], remote_txn[0]);
4538 check_spends!(remote_txn[2], remote_txn[0]);
4539 let broadcast_tx = if use_local_txn { &local_txn[0] } else { &remote_txn[0] };
4541 // Connect a commitment transaction, but only to the ChainMonitor/ChannelMonitor. The
4542 // channel is now closed, but the ChannelManager doesn't know that yet.
4543 let new_header = create_dummy_header(nodes[0].best_block_info().0, 0);
4544 let conf_height = nodes[0].best_block_info().1 + 1;
4545 nodes[1].chain_monitor.chain_monitor.transactions_confirmed(&new_header,
4546 &[(0, broadcast_tx)], conf_height);
4548 let (_, pre_update_monitor) = <(BlockHash, ChannelMonitor<InMemorySigner>)>::read(
4549 &mut io::Cursor::new(&get_monitor!(nodes[1], channel.2).encode()),
4550 (&nodes[1].keys_manager.backing, &nodes[1].keys_manager.backing)).unwrap();
4552 // If the ChannelManager tries to update the channel, however, the ChainMonitor will pass
4553 // the update through to the ChannelMonitor which will refuse it (as the channel is closed).
4554 let (route, payment_hash, _, payment_secret) = get_route_and_payment_hash!(nodes[1], nodes[0], 100_000);
4555 unwrap_send_err!(nodes[1].node.send_payment_with_route(&route, payment_hash,
4556 RecipientOnionFields::secret_only(payment_secret), PaymentId(payment_hash.0)
4557 ), false, APIError::MonitorUpdateInProgress, {});
4558 check_added_monitors!(nodes[1], 1);
4560 // Build a new ChannelMonitorUpdate which contains both the failing commitment tx update
4561 // and provides the claim preimages for the two pending HTLCs. The first update generates
4562 // an error, but the point of this test is to ensure the later updates are still applied.
4563 let monitor_updates = nodes[1].chain_monitor.monitor_updates.lock().unwrap();
4564 let mut replay_update = monitor_updates.get(&channel.2).unwrap().iter().rev().next().unwrap().clone();
4565 assert_eq!(replay_update.updates.len(), 1);
4566 if let ChannelMonitorUpdateStep::LatestCounterpartyCommitmentTXInfo { .. } = replay_update.updates[0] {
4567 } else { panic!(); }
4568 replay_update.updates.push(ChannelMonitorUpdateStep::PaymentPreimage { payment_preimage: payment_preimage_1 });
4569 replay_update.updates.push(ChannelMonitorUpdateStep::PaymentPreimage { payment_preimage: payment_preimage_2 });
4571 let broadcaster = TestBroadcaster::with_blocks(Arc::clone(&nodes[1].blocks));
4573 pre_update_monitor.update_monitor(&replay_update, &&broadcaster, &chanmon_cfgs[1].fee_estimator, &nodes[1].logger)
4575 // Even though we error'd on the first update, we should still have generated an HTLC claim
4577 let txn_broadcasted = broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
4578 assert!(txn_broadcasted.len() >= 2);
4579 let htlc_txn = txn_broadcasted.iter().filter(|tx| {
4580 assert_eq!(tx.input.len(), 1);
4581 tx.input[0].previous_output.txid == broadcast_tx.txid()
4582 }).collect::<Vec<_>>();
4583 assert_eq!(htlc_txn.len(), 2);
4584 check_spends!(htlc_txn[0], broadcast_tx);
4585 check_spends!(htlc_txn[1], broadcast_tx);
4588 fn test_funding_spend_refuses_updates() {
4589 do_test_funding_spend_refuses_updates(true);
4590 do_test_funding_spend_refuses_updates(false);
4594 fn test_prune_preimages() {
4595 let secp_ctx = Secp256k1::new();
4596 let logger = Arc::new(TestLogger::new());
4597 let broadcaster = Arc::new(TestBroadcaster::new(Network::Testnet));
4598 let fee_estimator = TestFeeEstimator { sat_per_kw: Mutex::new(253) };
4600 let dummy_key = PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[42; 32]).unwrap());
4602 let mut preimages = Vec::new();
4605 let preimage = PaymentPreimage([i; 32]);
4606 let hash = PaymentHash(Sha256::hash(&preimage.0[..]).into_inner());
4607 preimages.push((preimage, hash));
4611 macro_rules! preimages_slice_to_htlcs {
4612 ($preimages_slice: expr) => {
4614 let mut res = Vec::new();
4615 for (idx, preimage) in $preimages_slice.iter().enumerate() {
4616 res.push((HTLCOutputInCommitment {
4620 payment_hash: preimage.1.clone(),
4621 transaction_output_index: Some(idx as u32),
4628 macro_rules! preimages_slice_to_htlc_outputs {
4629 ($preimages_slice: expr) => {
4630 preimages_slice_to_htlcs!($preimages_slice).into_iter().map(|(htlc, _)| (htlc, None)).collect()
4633 let dummy_sig = crate::util::crypto::sign(&secp_ctx,
4634 &bitcoin::secp256k1::Message::from_slice(&[42; 32]).unwrap(),
4635 &SecretKey::from_slice(&[42; 32]).unwrap());
4637 macro_rules! test_preimages_exist {
4638 ($preimages_slice: expr, $monitor: expr) => {
4639 for preimage in $preimages_slice {
4640 assert!($monitor.inner.lock().unwrap().payment_preimages.contains_key(&preimage.1));
4645 let keys = InMemorySigner::new(
4647 SecretKey::from_slice(&[41; 32]).unwrap(),
4648 SecretKey::from_slice(&[41; 32]).unwrap(),
4649 SecretKey::from_slice(&[41; 32]).unwrap(),
4650 SecretKey::from_slice(&[41; 32]).unwrap(),
4651 SecretKey::from_slice(&[41; 32]).unwrap(),
4658 let counterparty_pubkeys = ChannelPublicKeys {
4659 funding_pubkey: PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[44; 32]).unwrap()),
4660 revocation_basepoint: PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[45; 32]).unwrap()),
4661 payment_point: PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[46; 32]).unwrap()),
4662 delayed_payment_basepoint: PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[47; 32]).unwrap()),
4663 htlc_basepoint: PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[48; 32]).unwrap())
4665 let funding_outpoint = OutPoint { txid: Txid::all_zeros(), index: u16::max_value() };
4666 let channel_parameters = ChannelTransactionParameters {
4667 holder_pubkeys: keys.holder_channel_pubkeys.clone(),
4668 holder_selected_contest_delay: 66,
4669 is_outbound_from_holder: true,
4670 counterparty_parameters: Some(CounterpartyChannelTransactionParameters {
4671 pubkeys: counterparty_pubkeys,
4672 selected_contest_delay: 67,
4674 funding_outpoint: Some(funding_outpoint),
4675 channel_type_features: ChannelTypeFeatures::only_static_remote_key()
4677 // Prune with one old state and a holder commitment tx holding a few overlaps with the
4679 let shutdown_pubkey = PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[42; 32]).unwrap());
4680 let best_block = BestBlock::from_network(Network::Testnet);
4681 let monitor = ChannelMonitor::new(Secp256k1::new(), keys,
4682 Some(ShutdownScript::new_p2wpkh_from_pubkey(shutdown_pubkey).into_inner()), 0, &Script::new(),
4683 (OutPoint { txid: Txid::from_slice(&[43; 32]).unwrap(), index: 0 }, Script::new()),
4684 &channel_parameters, Script::new(), 46, 0, HolderCommitmentTransaction::dummy(&mut Vec::new()),
4685 best_block, dummy_key);
4687 let mut htlcs = preimages_slice_to_htlcs!(preimages[0..10]);
4688 let dummy_commitment_tx = HolderCommitmentTransaction::dummy(&mut htlcs);
4689 monitor.provide_latest_holder_commitment_tx(dummy_commitment_tx.clone(),
4690 htlcs.into_iter().map(|(htlc, _)| (htlc, Some(dummy_sig), None)).collect()).unwrap();
4691 monitor.provide_latest_counterparty_commitment_tx(Txid::from_inner(Sha256::hash(b"1").into_inner()),
4692 preimages_slice_to_htlc_outputs!(preimages[5..15]), 281474976710655, dummy_key, &logger);
4693 monitor.provide_latest_counterparty_commitment_tx(Txid::from_inner(Sha256::hash(b"2").into_inner()),
4694 preimages_slice_to_htlc_outputs!(preimages[15..20]), 281474976710654, dummy_key, &logger);
4695 for &(ref preimage, ref hash) in preimages.iter() {
4696 let bounded_fee_estimator = LowerBoundedFeeEstimator::new(&fee_estimator);
4697 monitor.provide_payment_preimage(hash, preimage, &broadcaster, &bounded_fee_estimator, &logger);
4700 // Now provide a secret, pruning preimages 10-15
4701 let mut secret = [0; 32];
4702 secret[0..32].clone_from_slice(&hex::decode("7cc854b54e3e0dcdb010d7a3fee464a9687be6e8db3be6854c475621e007a5dc").unwrap());
4703 monitor.provide_secret(281474976710655, secret.clone()).unwrap();
4704 assert_eq!(monitor.inner.lock().unwrap().payment_preimages.len(), 15);
4705 test_preimages_exist!(&preimages[0..10], monitor);
4706 test_preimages_exist!(&preimages[15..20], monitor);
4708 monitor.provide_latest_counterparty_commitment_tx(Txid::from_inner(Sha256::hash(b"3").into_inner()),
4709 preimages_slice_to_htlc_outputs!(preimages[17..20]), 281474976710653, dummy_key, &logger);
4711 // Now provide a further secret, pruning preimages 15-17
4712 secret[0..32].clone_from_slice(&hex::decode("c7518c8ae4660ed02894df8976fa1a3659c1a8b4b5bec0c4b872abeba4cb8964").unwrap());
4713 monitor.provide_secret(281474976710654, secret.clone()).unwrap();
4714 assert_eq!(monitor.inner.lock().unwrap().payment_preimages.len(), 13);
4715 test_preimages_exist!(&preimages[0..10], monitor);
4716 test_preimages_exist!(&preimages[17..20], monitor);
4718 monitor.provide_latest_counterparty_commitment_tx(Txid::from_inner(Sha256::hash(b"4").into_inner()),
4719 preimages_slice_to_htlc_outputs!(preimages[18..20]), 281474976710652, dummy_key, &logger);
4721 // Now update holder commitment tx info, pruning only element 18 as we still care about the
4722 // previous commitment tx's preimages too
4723 let mut htlcs = preimages_slice_to_htlcs!(preimages[0..5]);
4724 let dummy_commitment_tx = HolderCommitmentTransaction::dummy(&mut htlcs);
4725 monitor.provide_latest_holder_commitment_tx(dummy_commitment_tx.clone(),
4726 htlcs.into_iter().map(|(htlc, _)| (htlc, Some(dummy_sig), None)).collect()).unwrap();
4727 secret[0..32].clone_from_slice(&hex::decode("2273e227a5b7449b6e70f1fb4652864038b1cbf9cd7c043a7d6456b7fc275ad8").unwrap());
4728 monitor.provide_secret(281474976710653, secret.clone()).unwrap();
4729 assert_eq!(monitor.inner.lock().unwrap().payment_preimages.len(), 12);
4730 test_preimages_exist!(&preimages[0..10], monitor);
4731 test_preimages_exist!(&preimages[18..20], monitor);
4733 // But if we do it again, we'll prune 5-10
4734 let mut htlcs = preimages_slice_to_htlcs!(preimages[0..3]);
4735 let dummy_commitment_tx = HolderCommitmentTransaction::dummy(&mut htlcs);
4736 monitor.provide_latest_holder_commitment_tx(dummy_commitment_tx,
4737 htlcs.into_iter().map(|(htlc, _)| (htlc, Some(dummy_sig), None)).collect()).unwrap();
4738 secret[0..32].clone_from_slice(&hex::decode("27cddaa5624534cb6cb9d7da077cf2b22ab21e9b506fd4998a51d54502e99116").unwrap());
4739 monitor.provide_secret(281474976710652, secret.clone()).unwrap();
4740 assert_eq!(monitor.inner.lock().unwrap().payment_preimages.len(), 5);
4741 test_preimages_exist!(&preimages[0..5], monitor);
4745 fn test_claim_txn_weight_computation() {
4746 // We test Claim txn weight, knowing that we want expected weigth and
4747 // not actual case to avoid sigs and time-lock delays hell variances.
4749 let secp_ctx = Secp256k1::new();
4750 let privkey = SecretKey::from_slice(&hex::decode("0101010101010101010101010101010101010101010101010101010101010101").unwrap()[..]).unwrap();
4751 let pubkey = PublicKey::from_secret_key(&secp_ctx, &privkey);
4753 macro_rules! sign_input {
4754 ($sighash_parts: expr, $idx: expr, $amount: expr, $weight: expr, $sum_actual_sigs: expr, $opt_anchors: expr) => {
4755 let htlc = HTLCOutputInCommitment {
4756 offered: if *$weight == weight_revoked_offered_htlc($opt_anchors) || *$weight == weight_offered_htlc($opt_anchors) { true } else { false },
4758 cltv_expiry: 2 << 16,
4759 payment_hash: PaymentHash([1; 32]),
4760 transaction_output_index: Some($idx as u32),
4762 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) };
4763 let sighash = hash_to_message!(&$sighash_parts.segwit_signature_hash($idx, &redeem_script, $amount, EcdsaSighashType::All).unwrap()[..]);
4764 let sig = secp_ctx.sign_ecdsa(&sighash, &privkey);
4765 let mut ser_sig = sig.serialize_der().to_vec();
4766 ser_sig.push(EcdsaSighashType::All as u8);
4767 $sum_actual_sigs += ser_sig.len();
4768 let witness = $sighash_parts.witness_mut($idx).unwrap();
4769 witness.push(ser_sig);
4770 if *$weight == WEIGHT_REVOKED_OUTPUT {
4771 witness.push(vec!(1));
4772 } else if *$weight == weight_revoked_offered_htlc($opt_anchors) || *$weight == weight_revoked_received_htlc($opt_anchors) {
4773 witness.push(pubkey.clone().serialize().to_vec());
4774 } else if *$weight == weight_received_htlc($opt_anchors) {
4775 witness.push(vec![0]);
4777 witness.push(PaymentPreimage([1; 32]).0.to_vec());
4779 witness.push(redeem_script.into_bytes());
4780 let witness = witness.to_vec();
4781 println!("witness[0] {}", witness[0].len());
4782 println!("witness[1] {}", witness[1].len());
4783 println!("witness[2] {}", witness[2].len());
4787 let script_pubkey = Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script();
4788 let txid = Txid::from_hex("56944c5d3f98413ef45cf54545538103cc9f298e0575820ad3591376e2e0f65d").unwrap();
4790 // Justice tx with 1 to_holder, 2 revoked offered HTLCs, 1 revoked received HTLCs
4791 for channel_type_features in [ChannelTypeFeatures::only_static_remote_key(), ChannelTypeFeatures::anchors_zero_htlc_fee_and_dependencies()].iter() {
4792 let mut claim_tx = Transaction { version: 0, lock_time: PackedLockTime::ZERO, input: Vec::new(), output: Vec::new() };
4793 let mut sum_actual_sigs = 0;
4795 claim_tx.input.push(TxIn {
4796 previous_output: BitcoinOutPoint {
4800 script_sig: Script::new(),
4801 sequence: Sequence::ENABLE_RBF_NO_LOCKTIME,
4802 witness: Witness::new(),
4805 claim_tx.output.push(TxOut {
4806 script_pubkey: script_pubkey.clone(),
4809 let base_weight = claim_tx.weight();
4810 let inputs_weight = vec![WEIGHT_REVOKED_OUTPUT, weight_revoked_offered_htlc(channel_type_features), weight_revoked_offered_htlc(channel_type_features), weight_revoked_received_htlc(channel_type_features)];
4811 let mut inputs_total_weight = 2; // count segwit flags
4813 let mut sighash_parts = sighash::SighashCache::new(&mut claim_tx);
4814 for (idx, inp) in inputs_weight.iter().enumerate() {
4815 sign_input!(sighash_parts, idx, 0, inp, sum_actual_sigs, channel_type_features);
4816 inputs_total_weight += inp;
4819 assert_eq!(base_weight + inputs_total_weight as usize, claim_tx.weight() + /* max_length_sig */ (73 * inputs_weight.len() - sum_actual_sigs));
4822 // Claim tx with 1 offered HTLCs, 3 received HTLCs
4823 for channel_type_features in [ChannelTypeFeatures::only_static_remote_key(), ChannelTypeFeatures::anchors_zero_htlc_fee_and_dependencies()].iter() {
4824 let mut claim_tx = Transaction { version: 0, lock_time: PackedLockTime::ZERO, input: Vec::new(), output: Vec::new() };
4825 let mut sum_actual_sigs = 0;
4827 claim_tx.input.push(TxIn {
4828 previous_output: BitcoinOutPoint {
4832 script_sig: Script::new(),
4833 sequence: Sequence::ENABLE_RBF_NO_LOCKTIME,
4834 witness: Witness::new(),
4837 claim_tx.output.push(TxOut {
4838 script_pubkey: script_pubkey.clone(),
4841 let base_weight = claim_tx.weight();
4842 let inputs_weight = vec![weight_offered_htlc(channel_type_features), weight_received_htlc(channel_type_features), weight_received_htlc(channel_type_features), weight_received_htlc(channel_type_features)];
4843 let mut inputs_total_weight = 2; // count segwit flags
4845 let mut sighash_parts = sighash::SighashCache::new(&mut claim_tx);
4846 for (idx, inp) in inputs_weight.iter().enumerate() {
4847 sign_input!(sighash_parts, idx, 0, inp, sum_actual_sigs, channel_type_features);
4848 inputs_total_weight += inp;
4851 assert_eq!(base_weight + inputs_total_weight as usize, claim_tx.weight() + /* max_length_sig */ (73 * inputs_weight.len() - sum_actual_sigs));
4854 // Justice tx with 1 revoked HTLC-Success tx output
4855 for channel_type_features in [ChannelTypeFeatures::only_static_remote_key(), ChannelTypeFeatures::anchors_zero_htlc_fee_and_dependencies()].iter() {
4856 let mut claim_tx = Transaction { version: 0, lock_time: PackedLockTime::ZERO, input: Vec::new(), output: Vec::new() };
4857 let mut sum_actual_sigs = 0;
4858 claim_tx.input.push(TxIn {
4859 previous_output: BitcoinOutPoint {
4863 script_sig: Script::new(),
4864 sequence: Sequence::ENABLE_RBF_NO_LOCKTIME,
4865 witness: Witness::new(),
4867 claim_tx.output.push(TxOut {
4868 script_pubkey: script_pubkey.clone(),
4871 let base_weight = claim_tx.weight();
4872 let inputs_weight = vec![WEIGHT_REVOKED_OUTPUT];
4873 let mut inputs_total_weight = 2; // count segwit flags
4875 let mut sighash_parts = sighash::SighashCache::new(&mut claim_tx);
4876 for (idx, inp) in inputs_weight.iter().enumerate() {
4877 sign_input!(sighash_parts, idx, 0, inp, sum_actual_sigs, channel_type_features);
4878 inputs_total_weight += inp;
4881 assert_eq!(base_weight + inputs_total_weight as usize, claim_tx.weight() + /* max_length_isg */ (73 * inputs_weight.len() - sum_actual_sigs));
4885 // Further testing is done in the ChannelManager integration tests.