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::Header;
24 use bitcoin::blockdata::transaction::{OutPoint as BitcoinOutPoint, TxOut, Transaction};
25 use bitcoin::blockdata::script::{Script, ScriptBuf};
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;
34 use bitcoin::sighash::EcdsaSighashType;
36 use crate::ln::channel::INITIAL_COMMITMENT_NUMBER;
37 use crate::ln::{PaymentHash, PaymentPreimage};
38 use crate::ln::msgs::DecodeError;
39 use crate::ln::channel_keys::{DelayedPaymentKey, DelayedPaymentBasepoint, HtlcBasepoint, HtlcKey, RevocationKey, RevocationBasepoint};
40 use crate::ln::chan_utils::{self,CommitmentTransaction, CounterpartyCommitmentSecrets, HTLCOutputInCommitment, HTLCClaim, ChannelTransactionParameters, HolderCommitmentTransaction, TxCreationKeys};
41 use crate::ln::channelmanager::{HTLCSource, SentHTLCId};
43 use crate::chain::{BestBlock, WatchedOutput};
44 use crate::chain::chaininterface::{BroadcasterInterface, FeeEstimator, LowerBoundedFeeEstimator};
45 use crate::chain::transaction::{OutPoint, TransactionData};
46 use crate::sign::{ChannelDerivationParameters, HTLCDescriptor, SpendableOutputDescriptor, StaticPaymentOutputDescriptor, DelayedPaymentOutputDescriptor, WriteableEcdsaChannelSigner, SignerProvider, EntropySource};
47 use crate::chain::onchaintx::{ClaimEvent, OnchainTxHandler};
48 use crate::chain::package::{CounterpartyOfferedHTLCOutput, CounterpartyReceivedHTLCOutput, HolderFundingOutput, HolderHTLCOutput, PackageSolvingData, PackageTemplate, RevokedOutput, RevokedHTLCOutput};
49 use crate::chain::Filter;
50 use crate::util::logger::Logger;
51 use crate::util::ser::{Readable, ReadableArgs, RequiredWrapper, MaybeReadable, UpgradableRequired, Writer, Writeable, U48};
52 use crate::util::byte_utils;
53 use crate::events::{Event, EventHandler};
54 use crate::events::bump_transaction::{AnchorDescriptor, BumpTransactionEvent};
56 use crate::prelude::*;
58 use crate::io::{self, Error};
59 use core::convert::TryInto;
61 use crate::sync::{Mutex, LockTestExt};
63 /// An update generated by the underlying channel itself which contains some new information the
64 /// [`ChannelMonitor`] should be made aware of.
66 /// Because this represents only a small number of updates to the underlying state, it is generally
67 /// much smaller than a full [`ChannelMonitor`]. However, for large single commitment transaction
68 /// updates (e.g. ones during which there are hundreds of HTLCs pending on the commitment
69 /// transaction), a single update may reach upwards of 1 MiB in serialized size.
70 #[derive(Clone, Debug, PartialEq, Eq)]
72 pub struct ChannelMonitorUpdate {
73 pub(crate) updates: Vec<ChannelMonitorUpdateStep>,
74 /// The sequence number of this update. Updates *must* be replayed in-order according to this
75 /// sequence number (and updates may panic if they are not). The update_id values are strictly
76 /// increasing and increase by one for each new update, with two exceptions specified below.
78 /// This sequence number is also used to track up to which points updates which returned
79 /// [`ChannelMonitorUpdateStatus::InProgress`] have been applied to all copies of a given
80 /// ChannelMonitor when ChannelManager::channel_monitor_updated is called.
82 /// The only instances we allow where update_id values are not strictly increasing have a
83 /// special update ID of [`CLOSED_CHANNEL_UPDATE_ID`]. This update ID is used for updates that
84 /// will force close the channel by broadcasting the latest commitment transaction or
85 /// special post-force-close updates, like providing preimages necessary to claim outputs on the
86 /// broadcast commitment transaction. See its docs for more details.
88 /// [`ChannelMonitorUpdateStatus::InProgress`]: super::ChannelMonitorUpdateStatus::InProgress
92 /// The update ID used for a [`ChannelMonitorUpdate`] that is either:
94 /// (1) attempting to force close the channel by broadcasting our latest commitment transaction or
95 /// (2) providing a preimage (after the channel has been force closed) from a forward link that
96 /// allows us to spend an HTLC output on this channel's (the backward link's) broadcasted
97 /// commitment transaction.
99 /// No other [`ChannelMonitorUpdate`]s are allowed after force-close.
100 pub const CLOSED_CHANNEL_UPDATE_ID: u64 = core::u64::MAX;
102 impl Writeable for ChannelMonitorUpdate {
103 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
104 write_ver_prefix!(w, SERIALIZATION_VERSION, MIN_SERIALIZATION_VERSION);
105 self.update_id.write(w)?;
106 (self.updates.len() as u64).write(w)?;
107 for update_step in self.updates.iter() {
108 update_step.write(w)?;
110 write_tlv_fields!(w, {});
114 impl Readable for ChannelMonitorUpdate {
115 fn read<R: io::Read>(r: &mut R) -> Result<Self, DecodeError> {
116 let _ver = read_ver_prefix!(r, SERIALIZATION_VERSION);
117 let update_id: u64 = Readable::read(r)?;
118 let len: u64 = Readable::read(r)?;
119 let mut updates = Vec::with_capacity(cmp::min(len as usize, MAX_ALLOC_SIZE / ::core::mem::size_of::<ChannelMonitorUpdateStep>()));
121 if let Some(upd) = MaybeReadable::read(r)? {
125 read_tlv_fields!(r, {});
126 Ok(Self { update_id, updates })
130 /// An event to be processed by the ChannelManager.
131 #[derive(Clone, PartialEq, Eq)]
132 pub enum MonitorEvent {
133 /// A monitor event containing an HTLCUpdate.
134 HTLCEvent(HTLCUpdate),
136 /// Indicates we broadcasted the channel's latest commitment transaction and thus closed the
138 HolderForceClosed(OutPoint),
140 /// Indicates a [`ChannelMonitor`] update has completed. See
141 /// [`ChannelMonitorUpdateStatus::InProgress`] for more information on how this is used.
143 /// [`ChannelMonitorUpdateStatus::InProgress`]: super::ChannelMonitorUpdateStatus::InProgress
145 /// The funding outpoint of the [`ChannelMonitor`] that was updated
146 funding_txo: OutPoint,
147 /// The Update ID from [`ChannelMonitorUpdate::update_id`] which was applied or
148 /// [`ChannelMonitor::get_latest_update_id`].
150 /// Note that this should only be set to a given update's ID if all previous updates for the
151 /// same [`ChannelMonitor`] have been applied and persisted.
152 monitor_update_id: u64,
155 impl_writeable_tlv_based_enum_upgradable!(MonitorEvent,
156 // Note that Completed is currently never serialized to disk as it is generated only in
159 (0, funding_txo, required),
160 (2, monitor_update_id, required),
164 (4, HolderForceClosed),
165 // 6 was `UpdateFailed` until LDK 0.0.117
168 /// Simple structure sent back by `chain::Watch` when an HTLC from a forward channel is detected on
169 /// chain. Used to update the corresponding HTLC in the backward channel. Failing to pass the
170 /// preimage claim backward will lead to loss of funds.
171 #[derive(Clone, PartialEq, Eq)]
172 pub struct HTLCUpdate {
173 pub(crate) payment_hash: PaymentHash,
174 pub(crate) payment_preimage: Option<PaymentPreimage>,
175 pub(crate) source: HTLCSource,
176 pub(crate) htlc_value_satoshis: Option<u64>,
178 impl_writeable_tlv_based!(HTLCUpdate, {
179 (0, payment_hash, required),
180 (1, htlc_value_satoshis, option),
181 (2, source, required),
182 (4, payment_preimage, option),
185 /// If an HTLC expires within this many blocks, don't try to claim it in a shared transaction,
186 /// instead claiming it in its own individual transaction.
187 pub(crate) const CLTV_SHARED_CLAIM_BUFFER: u32 = 12;
188 /// If an HTLC expires within this many blocks, force-close the channel to broadcast the
189 /// HTLC-Success transaction.
190 /// In other words, this is an upper bound on how many blocks we think it can take us to get a
191 /// transaction confirmed (and we use it in a few more, equivalent, places).
192 pub(crate) const CLTV_CLAIM_BUFFER: u32 = 18;
193 /// Number of blocks by which point we expect our counterparty to have seen new blocks on the
194 /// network and done a full update_fail_htlc/commitment_signed dance (+ we've updated all our
195 /// copies of ChannelMonitors, including watchtowers). We could enforce the contract by failing
196 /// at CLTV expiration height but giving a grace period to our peer may be profitable for us if he
197 /// can provide an over-late preimage. Nevertheless, grace period has to be accounted in our
198 /// CLTV_EXPIRY_DELTA to be secure. Following this policy we may decrease the rate of channel failures
199 /// due to expiration but increase the cost of funds being locked longuer in case of failure.
200 /// This delay also cover a low-power peer being slow to process blocks and so being behind us on
201 /// accurate block height.
202 /// In case of onchain failure to be pass backward we may see the last block of ANTI_REORG_DELAY
203 /// with at worst this delay, so we are not only using this value as a mercy for them but also
204 /// us as a safeguard to delay with enough time.
205 pub(crate) const LATENCY_GRACE_PERIOD_BLOCKS: u32 = 3;
206 /// Number of blocks we wait on seeing a HTLC output being solved before we fail corresponding
207 /// inbound HTLCs. This prevents us from failing backwards and then getting a reorg resulting in us
210 /// Note that this is a library-wide security assumption. If a reorg deeper than this number of
211 /// blocks occurs, counterparties may be able to steal funds or claims made by and balances exposed
212 /// by a [`ChannelMonitor`] may be incorrect.
213 // We also use this delay to be sure we can remove our in-flight claim txn from bump candidates buffer.
214 // It may cause spurious generation of bumped claim txn but that's alright given the outpoint is already
215 // solved by a previous claim tx. What we want to avoid is reorg evicting our claim tx and us not
216 // keep bumping another claim tx to solve the outpoint.
217 pub const ANTI_REORG_DELAY: u32 = 6;
218 /// Number of blocks before confirmation at which we fail back an un-relayed HTLC or at which we
219 /// refuse to accept a new HTLC.
221 /// This is used for a few separate purposes:
222 /// 1) if we've received an MPP HTLC to us and it expires within this many blocks and we are
223 /// waiting on additional parts (or waiting on the preimage for any HTLC from the user), we will
225 /// 2) if we receive an HTLC within this many blocks of its expiry (plus one to avoid a race
226 /// condition with the above), we will fail this HTLC without telling the user we received it,
228 /// (1) is all about protecting us - we need enough time to update the channel state before we hit
229 /// CLTV_CLAIM_BUFFER, at which point we'd go on chain to claim the HTLC with the preimage.
231 /// (2) is the same, but with an additional buffer to avoid accepting an HTLC which is immediately
232 /// in a race condition between the user connecting a block (which would fail it) and the user
233 /// providing us the preimage (which would claim it).
234 pub(crate) const HTLC_FAIL_BACK_BUFFER: u32 = CLTV_CLAIM_BUFFER + LATENCY_GRACE_PERIOD_BLOCKS;
236 // TODO(devrandom) replace this with HolderCommitmentTransaction
237 #[derive(Clone, PartialEq, Eq)]
238 struct HolderSignedTx {
239 /// txid of the transaction in tx, just used to make comparison faster
241 revocation_key: RevocationKey,
244 delayed_payment_key: DelayedPaymentKey,
245 per_commitment_point: PublicKey,
246 htlc_outputs: Vec<(HTLCOutputInCommitment, Option<Signature>, Option<HTLCSource>)>,
247 to_self_value_sat: u64,
250 impl_writeable_tlv_based!(HolderSignedTx, {
252 // Note that this is filled in with data from OnchainTxHandler if it's missing.
253 // For HolderSignedTx objects serialized with 0.0.100+, this should be filled in.
254 (1, to_self_value_sat, (default_value, u64::max_value())),
255 (2, revocation_key, required),
256 (4, a_htlc_key, required),
257 (6, b_htlc_key, required),
258 (8, delayed_payment_key, required),
259 (10, per_commitment_point, required),
260 (12, feerate_per_kw, required),
261 (14, htlc_outputs, required_vec)
264 impl HolderSignedTx {
265 fn non_dust_htlcs(&self) -> Vec<HTLCOutputInCommitment> {
266 self.htlc_outputs.iter().filter_map(|(htlc, _, _)| {
267 if let Some(_) = htlc.transaction_output_index {
277 /// We use this to track static counterparty commitment transaction data and to generate any
278 /// justice or 2nd-stage preimage/timeout transactions.
279 #[derive(Clone, PartialEq, Eq)]
280 struct CounterpartyCommitmentParameters {
281 counterparty_delayed_payment_base_key: DelayedPaymentBasepoint,
282 counterparty_htlc_base_key: HtlcBasepoint,
283 on_counterparty_tx_csv: u16,
286 impl Writeable for CounterpartyCommitmentParameters {
287 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
288 w.write_all(&(0 as u64).to_be_bytes())?;
289 write_tlv_fields!(w, {
290 (0, self.counterparty_delayed_payment_base_key, required),
291 (2, self.counterparty_htlc_base_key, required),
292 (4, self.on_counterparty_tx_csv, required),
297 impl Readable for CounterpartyCommitmentParameters {
298 fn read<R: io::Read>(r: &mut R) -> Result<Self, DecodeError> {
299 let counterparty_commitment_transaction = {
300 // Versions prior to 0.0.100 had some per-HTLC state stored here, which is no longer
301 // used. Read it for compatibility.
302 let per_htlc_len: u64 = Readable::read(r)?;
303 for _ in 0..per_htlc_len {
304 let _txid: Txid = Readable::read(r)?;
305 let htlcs_count: u64 = Readable::read(r)?;
306 for _ in 0..htlcs_count {
307 let _htlc: HTLCOutputInCommitment = Readable::read(r)?;
311 let mut counterparty_delayed_payment_base_key = RequiredWrapper(None);
312 let mut counterparty_htlc_base_key = RequiredWrapper(None);
313 let mut on_counterparty_tx_csv: u16 = 0;
314 read_tlv_fields!(r, {
315 (0, counterparty_delayed_payment_base_key, required),
316 (2, counterparty_htlc_base_key, required),
317 (4, on_counterparty_tx_csv, required),
319 CounterpartyCommitmentParameters {
320 counterparty_delayed_payment_base_key: counterparty_delayed_payment_base_key.0.unwrap(),
321 counterparty_htlc_base_key: counterparty_htlc_base_key.0.unwrap(),
322 on_counterparty_tx_csv,
325 Ok(counterparty_commitment_transaction)
329 /// An entry for an [`OnchainEvent`], stating the block height and hash when the event was
330 /// observed, as well as the transaction causing it.
332 /// Used to determine when the on-chain event can be considered safe from a chain reorganization.
333 #[derive(Clone, PartialEq, Eq)]
334 struct OnchainEventEntry {
337 block_hash: Option<BlockHash>, // Added as optional, will be filled in for any entry generated on 0.0.113 or after
339 transaction: Option<Transaction>, // Added as optional, but always filled in, in LDK 0.0.110
342 impl OnchainEventEntry {
343 fn confirmation_threshold(&self) -> u32 {
344 let mut conf_threshold = self.height + ANTI_REORG_DELAY - 1;
346 OnchainEvent::MaturingOutput {
347 descriptor: SpendableOutputDescriptor::DelayedPaymentOutput(ref descriptor)
349 // A CSV'd transaction is confirmable in block (input height) + CSV delay, which means
350 // it's broadcastable when we see the previous block.
351 conf_threshold = cmp::max(conf_threshold, self.height + descriptor.to_self_delay as u32 - 1);
353 OnchainEvent::FundingSpendConfirmation { on_local_output_csv: Some(csv), .. } |
354 OnchainEvent::HTLCSpendConfirmation { on_to_local_output_csv: Some(csv), .. } => {
355 // A CSV'd transaction is confirmable in block (input height) + CSV delay, which means
356 // it's broadcastable when we see the previous block.
357 conf_threshold = cmp::max(conf_threshold, self.height + csv as u32 - 1);
364 fn has_reached_confirmation_threshold(&self, best_block: &BestBlock) -> bool {
365 best_block.height() >= self.confirmation_threshold()
369 /// The (output index, sats value) for the counterparty's output in a commitment transaction.
371 /// This was added as an `Option` in 0.0.110.
372 type CommitmentTxCounterpartyOutputInfo = Option<(u32, u64)>;
374 /// Upon discovering of some classes of onchain tx by ChannelMonitor, we may have to take actions on it
375 /// once they mature to enough confirmations (ANTI_REORG_DELAY)
376 #[derive(Clone, PartialEq, Eq)]
378 /// An outbound HTLC failing after a transaction is confirmed. Used
379 /// * when an outbound HTLC output is spent by us after the HTLC timed out
380 /// * an outbound HTLC which was not present in the commitment transaction which appeared
381 /// on-chain (either because it was not fully committed to or it was dust).
382 /// Note that this is *not* used for preimage claims, as those are passed upstream immediately,
383 /// appearing only as an `HTLCSpendConfirmation`, below.
386 payment_hash: PaymentHash,
387 htlc_value_satoshis: Option<u64>,
388 /// None in the second case, above, ie when there is no relevant output in the commitment
389 /// transaction which appeared on chain.
390 commitment_tx_output_idx: Option<u32>,
392 /// An output waiting on [`ANTI_REORG_DELAY`] confirmations before we hand the user the
393 /// [`SpendableOutputDescriptor`].
395 descriptor: SpendableOutputDescriptor,
397 /// A spend of the funding output, either a commitment transaction or a cooperative closing
399 FundingSpendConfirmation {
400 /// The CSV delay for the output of the funding spend transaction (implying it is a local
401 /// commitment transaction, and this is the delay on the to_self output).
402 on_local_output_csv: Option<u16>,
403 /// If the funding spend transaction was a known remote commitment transaction, we track
404 /// the output index and amount of the counterparty's `to_self` output here.
406 /// This allows us to generate a [`Balance::CounterpartyRevokedOutputClaimable`] for the
407 /// counterparty output.
408 commitment_tx_to_counterparty_output: CommitmentTxCounterpartyOutputInfo,
410 /// A spend of a commitment transaction HTLC output, set in the cases where *no* `HTLCUpdate`
411 /// is constructed. This is used when
412 /// * an outbound HTLC is claimed by our counterparty with a preimage, causing us to
413 /// immediately claim the HTLC on the inbound edge and track the resolution here,
414 /// * an inbound HTLC is claimed by our counterparty (with a timeout),
415 /// * an inbound HTLC is claimed by us (with a preimage).
416 /// * a revoked-state HTLC transaction was broadcasted, which was claimed by the revocation
418 /// * a revoked-state HTLC transaction was broadcasted, which was claimed by an
419 /// HTLC-Success/HTLC-Failure transaction (and is still claimable with a revocation
421 HTLCSpendConfirmation {
422 commitment_tx_output_idx: u32,
423 /// If the claim was made by either party with a preimage, this is filled in
424 preimage: Option<PaymentPreimage>,
425 /// If the claim was made by us on an inbound HTLC against a local commitment transaction,
426 /// we set this to the output CSV value which we will have to wait until to spend the
427 /// output (and generate a SpendableOutput event).
428 on_to_local_output_csv: Option<u16>,
432 impl Writeable for OnchainEventEntry {
433 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
434 write_tlv_fields!(writer, {
435 (0, self.txid, required),
436 (1, self.transaction, option),
437 (2, self.height, required),
438 (3, self.block_hash, option),
439 (4, self.event, required),
445 impl MaybeReadable for OnchainEventEntry {
446 fn read<R: io::Read>(reader: &mut R) -> Result<Option<Self>, DecodeError> {
447 let mut txid = Txid::all_zeros();
448 let mut transaction = None;
449 let mut block_hash = None;
451 let mut event = UpgradableRequired(None);
452 read_tlv_fields!(reader, {
454 (1, transaction, option),
455 (2, height, required),
456 (3, block_hash, option),
457 (4, event, upgradable_required),
459 Ok(Some(Self { txid, transaction, height, block_hash, event: _init_tlv_based_struct_field!(event, upgradable_required) }))
463 impl_writeable_tlv_based_enum_upgradable!(OnchainEvent,
465 (0, source, required),
466 (1, htlc_value_satoshis, option),
467 (2, payment_hash, required),
468 (3, commitment_tx_output_idx, option),
470 (1, MaturingOutput) => {
471 (0, descriptor, required),
473 (3, FundingSpendConfirmation) => {
474 (0, on_local_output_csv, option),
475 (1, commitment_tx_to_counterparty_output, option),
477 (5, HTLCSpendConfirmation) => {
478 (0, commitment_tx_output_idx, required),
479 (2, preimage, option),
480 (4, on_to_local_output_csv, option),
485 #[derive(Clone, Debug, PartialEq, Eq)]
486 pub(crate) enum ChannelMonitorUpdateStep {
487 LatestHolderCommitmentTXInfo {
488 commitment_tx: HolderCommitmentTransaction,
489 /// Note that LDK after 0.0.115 supports this only containing dust HTLCs (implying the
490 /// `Signature` field is never filled in). At that point, non-dust HTLCs are implied by the
491 /// HTLC fields in `commitment_tx` and the sources passed via `nondust_htlc_sources`.
492 htlc_outputs: Vec<(HTLCOutputInCommitment, Option<Signature>, Option<HTLCSource>)>,
493 claimed_htlcs: Vec<(SentHTLCId, PaymentPreimage)>,
494 nondust_htlc_sources: Vec<HTLCSource>,
496 LatestCounterpartyCommitmentTXInfo {
497 commitment_txid: Txid,
498 htlc_outputs: Vec<(HTLCOutputInCommitment, Option<Box<HTLCSource>>)>,
499 commitment_number: u64,
500 their_per_commitment_point: PublicKey,
501 feerate_per_kw: Option<u32>,
502 to_broadcaster_value_sat: Option<u64>,
503 to_countersignatory_value_sat: Option<u64>,
506 payment_preimage: PaymentPreimage,
512 /// Used to indicate that the no future updates will occur, and likely that the latest holder
513 /// commitment transaction(s) should be broadcast, as the channel has been force-closed.
515 /// If set to false, we shouldn't broadcast the latest holder commitment transaction as we
516 /// think we've fallen behind!
517 should_broadcast: bool,
520 scriptpubkey: ScriptBuf,
524 impl ChannelMonitorUpdateStep {
525 fn variant_name(&self) -> &'static str {
527 ChannelMonitorUpdateStep::LatestHolderCommitmentTXInfo { .. } => "LatestHolderCommitmentTXInfo",
528 ChannelMonitorUpdateStep::LatestCounterpartyCommitmentTXInfo { .. } => "LatestCounterpartyCommitmentTXInfo",
529 ChannelMonitorUpdateStep::PaymentPreimage { .. } => "PaymentPreimage",
530 ChannelMonitorUpdateStep::CommitmentSecret { .. } => "CommitmentSecret",
531 ChannelMonitorUpdateStep::ChannelForceClosed { .. } => "ChannelForceClosed",
532 ChannelMonitorUpdateStep::ShutdownScript { .. } => "ShutdownScript",
537 impl_writeable_tlv_based_enum_upgradable!(ChannelMonitorUpdateStep,
538 (0, LatestHolderCommitmentTXInfo) => {
539 (0, commitment_tx, required),
540 (1, claimed_htlcs, optional_vec),
541 (2, htlc_outputs, required_vec),
542 (4, nondust_htlc_sources, optional_vec),
544 (1, LatestCounterpartyCommitmentTXInfo) => {
545 (0, commitment_txid, required),
546 (1, feerate_per_kw, option),
547 (2, commitment_number, required),
548 (3, to_broadcaster_value_sat, option),
549 (4, their_per_commitment_point, required),
550 (5, to_countersignatory_value_sat, option),
551 (6, htlc_outputs, required_vec),
553 (2, PaymentPreimage) => {
554 (0, payment_preimage, required),
556 (3, CommitmentSecret) => {
558 (2, secret, required),
560 (4, ChannelForceClosed) => {
561 (0, should_broadcast, required),
563 (5, ShutdownScript) => {
564 (0, scriptpubkey, required),
568 /// Details about the balance(s) available for spending once the channel appears on chain.
570 /// See [`ChannelMonitor::get_claimable_balances`] for more details on when these will or will not
572 #[derive(Clone, Debug, PartialEq, Eq)]
573 #[cfg_attr(test, derive(PartialOrd, Ord))]
575 /// The channel is not yet closed (or the commitment or closing transaction has not yet
576 /// appeared in a block). The given balance is claimable (less on-chain fees) if the channel is
577 /// force-closed now.
578 ClaimableOnChannelClose {
579 /// The amount available to claim, in satoshis, excluding the on-chain fees which will be
580 /// required to do so.
581 amount_satoshis: u64,
583 /// The channel has been closed, and the given balance is ours but awaiting confirmations until
584 /// we consider it spendable.
585 ClaimableAwaitingConfirmations {
586 /// The amount available to claim, in satoshis, possibly excluding the on-chain fees which
587 /// were spent in broadcasting the transaction.
588 amount_satoshis: u64,
589 /// The height at which an [`Event::SpendableOutputs`] event will be generated for this
591 confirmation_height: u32,
593 /// The channel has been closed, and the given balance should be ours but awaiting spending
594 /// transaction confirmation. If the spending transaction does not confirm in time, it is
595 /// possible our counterparty can take the funds by broadcasting an HTLC timeout on-chain.
597 /// Once the spending transaction confirms, before it has reached enough confirmations to be
598 /// considered safe from chain reorganizations, the balance will instead be provided via
599 /// [`Balance::ClaimableAwaitingConfirmations`].
600 ContentiousClaimable {
601 /// The amount available to claim, in satoshis, excluding the on-chain fees which will be
602 /// required to do so.
603 amount_satoshis: u64,
604 /// The height at which the counterparty may be able to claim the balance if we have not
607 /// The payment hash that locks this HTLC.
608 payment_hash: PaymentHash,
609 /// The preimage that can be used to claim this HTLC.
610 payment_preimage: PaymentPreimage,
612 /// HTLCs which we sent to our counterparty which are claimable after a timeout (less on-chain
613 /// fees) if the counterparty does not know the preimage for the HTLCs. These are somewhat
614 /// likely to be claimed by our counterparty before we do.
615 MaybeTimeoutClaimableHTLC {
616 /// The amount potentially available to claim, in satoshis, excluding the on-chain fees
617 /// which will be required to do so.
618 amount_satoshis: u64,
619 /// The height at which we will be able to claim the balance if our counterparty has not
621 claimable_height: u32,
622 /// The payment hash whose preimage our counterparty needs to claim this HTLC.
623 payment_hash: PaymentHash,
625 /// HTLCs which we received from our counterparty which are claimable with a preimage which we
626 /// do not currently have. This will only be claimable if we receive the preimage from the node
627 /// to which we forwarded this HTLC before the timeout.
628 MaybePreimageClaimableHTLC {
629 /// The amount potentially available to claim, in satoshis, excluding the on-chain fees
630 /// which will be required to do so.
631 amount_satoshis: u64,
632 /// The height at which our counterparty will be able to claim the balance if we have not
633 /// yet received the preimage and claimed it ourselves.
635 /// The payment hash whose preimage we need to claim this HTLC.
636 payment_hash: PaymentHash,
638 /// The channel has been closed, and our counterparty broadcasted a revoked commitment
641 /// Thus, we're able to claim all outputs in the commitment transaction, one of which has the
642 /// following amount.
643 CounterpartyRevokedOutputClaimable {
644 /// The amount, in satoshis, of the output which we can claim.
646 /// Note that for outputs from HTLC balances this may be excluding some on-chain fees that
647 /// were already spent.
648 amount_satoshis: u64,
653 /// The amount claimable, in satoshis. This excludes balances that we are unsure if we are able
654 /// to claim, this is because we are waiting for a preimage or for a timeout to expire. For more
655 /// information on these balances see [`Balance::MaybeTimeoutClaimableHTLC`] and
656 /// [`Balance::MaybePreimageClaimableHTLC`].
658 /// On-chain fees required to claim the balance are not included in this amount.
659 pub fn claimable_amount_satoshis(&self) -> u64 {
661 Balance::ClaimableOnChannelClose { amount_satoshis, .. }|
662 Balance::ClaimableAwaitingConfirmations { amount_satoshis, .. }|
663 Balance::ContentiousClaimable { amount_satoshis, .. }|
664 Balance::CounterpartyRevokedOutputClaimable { amount_satoshis, .. }
666 Balance::MaybeTimeoutClaimableHTLC { .. }|
667 Balance::MaybePreimageClaimableHTLC { .. }
673 /// An HTLC which has been irrevocably resolved on-chain, and has reached ANTI_REORG_DELAY.
674 #[derive(Clone, PartialEq, Eq)]
675 struct IrrevocablyResolvedHTLC {
676 commitment_tx_output_idx: Option<u32>,
677 /// The txid of the transaction which resolved the HTLC, this may be a commitment (if the HTLC
678 /// was not present in the confirmed commitment transaction), HTLC-Success, or HTLC-Timeout
680 resolving_txid: Option<Txid>, // Added as optional, but always filled in, in 0.0.110
681 resolving_tx: Option<Transaction>,
682 /// Only set if the HTLC claim was ours using a payment preimage
683 payment_preimage: Option<PaymentPreimage>,
686 // In LDK versions prior to 0.0.111 commitment_tx_output_idx was not Option-al and
687 // IrrevocablyResolvedHTLC objects only existed for non-dust HTLCs. This was a bug, but to maintain
688 // backwards compatibility we must ensure we always write out a commitment_tx_output_idx field,
689 // using `u32::max_value()` as a sentinal to indicate the HTLC was dust.
690 impl Writeable for IrrevocablyResolvedHTLC {
691 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
692 let mapped_commitment_tx_output_idx = self.commitment_tx_output_idx.unwrap_or(u32::max_value());
693 write_tlv_fields!(writer, {
694 (0, mapped_commitment_tx_output_idx, required),
695 (1, self.resolving_txid, option),
696 (2, self.payment_preimage, option),
697 (3, self.resolving_tx, option),
703 impl Readable for IrrevocablyResolvedHTLC {
704 fn read<R: io::Read>(reader: &mut R) -> Result<Self, DecodeError> {
705 let mut mapped_commitment_tx_output_idx = 0;
706 let mut resolving_txid = None;
707 let mut payment_preimage = None;
708 let mut resolving_tx = None;
709 read_tlv_fields!(reader, {
710 (0, mapped_commitment_tx_output_idx, required),
711 (1, resolving_txid, option),
712 (2, payment_preimage, option),
713 (3, resolving_tx, option),
716 commitment_tx_output_idx: if mapped_commitment_tx_output_idx == u32::max_value() { None } else { Some(mapped_commitment_tx_output_idx) },
724 /// A ChannelMonitor handles chain events (blocks connected and disconnected) and generates
725 /// on-chain transactions to ensure no loss of funds occurs.
727 /// You MUST ensure that no ChannelMonitors for a given channel anywhere contain out-of-date
728 /// information and are actively monitoring the chain.
730 /// Note that the deserializer is only implemented for (BlockHash, ChannelMonitor), which
731 /// tells you the last block hash which was block_connect()ed. You MUST rescan any blocks along
732 /// the "reorg path" (ie disconnecting blocks until you find a common ancestor from both the
733 /// returned block hash and the the current chain and then reconnecting blocks to get to the
734 /// best chain) upon deserializing the object!
735 pub struct ChannelMonitor<Signer: WriteableEcdsaChannelSigner> {
737 pub(crate) inner: Mutex<ChannelMonitorImpl<Signer>>,
739 pub(super) inner: Mutex<ChannelMonitorImpl<Signer>>,
742 impl<Signer: WriteableEcdsaChannelSigner> Clone for ChannelMonitor<Signer> where Signer: Clone {
743 fn clone(&self) -> Self {
744 let inner = self.inner.lock().unwrap().clone();
745 ChannelMonitor::from_impl(inner)
749 #[derive(Clone, PartialEq)]
750 pub(crate) struct ChannelMonitorImpl<Signer: WriteableEcdsaChannelSigner> {
751 latest_update_id: u64,
752 commitment_transaction_number_obscure_factor: u64,
754 destination_script: ScriptBuf,
755 broadcasted_holder_revokable_script: Option<(ScriptBuf, PublicKey, RevocationKey)>,
756 counterparty_payment_script: ScriptBuf,
757 shutdown_script: Option<ScriptBuf>,
759 channel_keys_id: [u8; 32],
760 holder_revocation_basepoint: RevocationBasepoint,
761 funding_info: (OutPoint, ScriptBuf),
762 current_counterparty_commitment_txid: Option<Txid>,
763 prev_counterparty_commitment_txid: Option<Txid>,
765 counterparty_commitment_params: CounterpartyCommitmentParameters,
766 funding_redeemscript: ScriptBuf,
767 channel_value_satoshis: u64,
768 // first is the idx of the first of the two per-commitment points
769 their_cur_per_commitment_points: Option<(u64, PublicKey, Option<PublicKey>)>,
771 on_holder_tx_csv: u16,
773 commitment_secrets: CounterpartyCommitmentSecrets,
774 /// The set of outpoints in each counterparty commitment transaction. We always need at least
775 /// the payment hash from `HTLCOutputInCommitment` to claim even a revoked commitment
776 /// transaction broadcast as we need to be able to construct the witness script in all cases.
777 counterparty_claimable_outpoints: HashMap<Txid, Vec<(HTLCOutputInCommitment, Option<Box<HTLCSource>>)>>,
778 /// We cannot identify HTLC-Success or HTLC-Timeout transactions by themselves on the chain.
779 /// Nor can we figure out their commitment numbers without the commitment transaction they are
780 /// spending. Thus, in order to claim them via revocation key, we track all the counterparty
781 /// commitment transactions which we find on-chain, mapping them to the commitment number which
782 /// can be used to derive the revocation key and claim the transactions.
783 counterparty_commitment_txn_on_chain: HashMap<Txid, u64>,
784 /// Cache used to make pruning of payment_preimages faster.
785 /// Maps payment_hash values to commitment numbers for counterparty transactions for non-revoked
786 /// counterparty transactions (ie should remain pretty small).
787 /// Serialized to disk but should generally not be sent to Watchtowers.
788 counterparty_hash_commitment_number: HashMap<PaymentHash, u64>,
790 counterparty_fulfilled_htlcs: HashMap<SentHTLCId, PaymentPreimage>,
792 // We store two holder commitment transactions to avoid any race conditions where we may update
793 // some monitors (potentially on watchtowers) but then fail to update others, resulting in the
794 // various monitors for one channel being out of sync, and us broadcasting a holder
795 // transaction for which we have deleted claim information on some watchtowers.
796 prev_holder_signed_commitment_tx: Option<HolderSignedTx>,
797 current_holder_commitment_tx: HolderSignedTx,
799 // Used just for ChannelManager to make sure it has the latest channel data during
801 current_counterparty_commitment_number: u64,
802 // Used just for ChannelManager to make sure it has the latest channel data during
804 current_holder_commitment_number: u64,
806 /// The set of payment hashes from inbound payments for which we know the preimage. Payment
807 /// preimages that are not included in any unrevoked local commitment transaction or unrevoked
808 /// remote commitment transactions are automatically removed when commitment transactions are
810 payment_preimages: HashMap<PaymentHash, PaymentPreimage>,
812 // Note that `MonitorEvent`s MUST NOT be generated during update processing, only generated
813 // during chain data processing. This prevents a race in `ChainMonitor::update_channel` (and
814 // presumably user implementations thereof as well) where we update the in-memory channel
815 // object, then before the persistence finishes (as it's all under a read-lock), we return
816 // pending events to the user or to the relevant `ChannelManager`. Then, on reload, we'll have
817 // the pre-event state here, but have processed the event in the `ChannelManager`.
818 // Note that because the `event_lock` in `ChainMonitor` is only taken in
819 // block/transaction-connected events and *not* during block/transaction-disconnected events,
820 // we further MUST NOT generate events during block/transaction-disconnection.
821 pending_monitor_events: Vec<MonitorEvent>,
823 pub(super) pending_events: Vec<Event>,
824 pub(super) is_processing_pending_events: bool,
826 // Used to track on-chain events (i.e., transactions part of channels confirmed on chain) on
827 // which to take actions once they reach enough confirmations. Each entry includes the
828 // transaction's id and the height when the transaction was confirmed on chain.
829 onchain_events_awaiting_threshold_conf: Vec<OnchainEventEntry>,
831 // If we get serialized out and re-read, we need to make sure that the chain monitoring
832 // interface knows about the TXOs that we want to be notified of spends of. We could probably
833 // be smart and derive them from the above storage fields, but its much simpler and more
834 // Obviously Correct (tm) if we just keep track of them explicitly.
835 outputs_to_watch: HashMap<Txid, Vec<(u32, ScriptBuf)>>,
838 pub onchain_tx_handler: OnchainTxHandler<Signer>,
840 onchain_tx_handler: OnchainTxHandler<Signer>,
842 // This is set when the Channel[Manager] generated a ChannelMonitorUpdate which indicated the
843 // channel has been force-closed. After this is set, no further holder commitment transaction
844 // updates may occur, and we panic!() if one is provided.
845 lockdown_from_offchain: bool,
847 // Set once we've signed a holder commitment transaction and handed it over to our
848 // OnchainTxHandler. After this is set, no future updates to our holder commitment transactions
849 // may occur, and we fail any such monitor updates.
851 // In case of update rejection due to a locally already signed commitment transaction, we
852 // nevertheless store update content to track in case of concurrent broadcast by another
853 // remote monitor out-of-order with regards to the block view.
854 holder_tx_signed: bool,
856 // If a spend of the funding output is seen, we set this to true and reject any further
857 // updates. This prevents any further changes in the offchain state no matter the order
858 // of block connection between ChannelMonitors and the ChannelManager.
859 funding_spend_seen: bool,
861 /// Set to `Some` of the confirmed transaction spending the funding input of the channel after
862 /// reaching `ANTI_REORG_DELAY` confirmations.
863 funding_spend_confirmed: Option<Txid>,
865 confirmed_commitment_tx_counterparty_output: CommitmentTxCounterpartyOutputInfo,
866 /// The set of HTLCs which have been either claimed or failed on chain and have reached
867 /// the requisite confirmations on the claim/fail transaction (either ANTI_REORG_DELAY or the
868 /// spending CSV for revocable outputs).
869 htlcs_resolved_on_chain: Vec<IrrevocablyResolvedHTLC>,
871 /// The set of `SpendableOutput` events which we have already passed upstream to be claimed.
872 /// These are tracked explicitly to ensure that we don't generate the same events redundantly
873 /// if users duplicatively confirm old transactions. Specifically for transactions claiming a
874 /// revoked remote outpoint we otherwise have no tracking at all once they've reached
875 /// [`ANTI_REORG_DELAY`], so we have to track them here.
876 spendable_txids_confirmed: Vec<Txid>,
878 // We simply modify best_block in Channel's block_connected so that serialization is
879 // consistent but hopefully the users' copy handles block_connected in a consistent way.
880 // (we do *not*, however, update them in update_monitor to ensure any local user copies keep
881 // their best_block from its state and not based on updated copies that didn't run through
882 // the full block_connected).
883 best_block: BestBlock,
885 /// The node_id of our counterparty
886 counterparty_node_id: Option<PublicKey>,
888 /// Initial counterparty commmitment data needed to recreate the commitment tx
889 /// in the persistence pipeline for third-party watchtowers. This will only be present on
890 /// monitors created after 0.0.117.
892 /// Ordering of tuple data: (their_per_commitment_point, feerate_per_kw, to_broadcaster_sats,
893 /// to_countersignatory_sats)
894 initial_counterparty_commitment_info: Option<(PublicKey, u32, u64, u64)>,
897 /// Transaction outputs to watch for on-chain spends.
898 pub type TransactionOutputs = (Txid, Vec<(u32, TxOut)>);
900 impl<Signer: WriteableEcdsaChannelSigner> PartialEq for ChannelMonitor<Signer> where Signer: PartialEq {
901 fn eq(&self, other: &Self) -> bool {
902 // We need some kind of total lockorder. Absent a better idea, we sort by position in
903 // memory and take locks in that order (assuming that we can't move within memory while a
905 let ord = ((self as *const _) as usize) < ((other as *const _) as usize);
906 let a = if ord { self.inner.unsafe_well_ordered_double_lock_self() } else { other.inner.unsafe_well_ordered_double_lock_self() };
907 let b = if ord { other.inner.unsafe_well_ordered_double_lock_self() } else { self.inner.unsafe_well_ordered_double_lock_self() };
912 impl<Signer: WriteableEcdsaChannelSigner> Writeable for ChannelMonitor<Signer> {
913 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), Error> {
914 self.inner.lock().unwrap().write(writer)
918 // These are also used for ChannelMonitorUpdate, above.
919 const SERIALIZATION_VERSION: u8 = 1;
920 const MIN_SERIALIZATION_VERSION: u8 = 1;
922 impl<Signer: WriteableEcdsaChannelSigner> Writeable for ChannelMonitorImpl<Signer> {
923 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), Error> {
924 write_ver_prefix!(writer, SERIALIZATION_VERSION, MIN_SERIALIZATION_VERSION);
926 self.latest_update_id.write(writer)?;
928 // Set in initial Channel-object creation, so should always be set by now:
929 U48(self.commitment_transaction_number_obscure_factor).write(writer)?;
931 self.destination_script.write(writer)?;
932 if let Some(ref broadcasted_holder_revokable_script) = self.broadcasted_holder_revokable_script {
933 writer.write_all(&[0; 1])?;
934 broadcasted_holder_revokable_script.0.write(writer)?;
935 broadcasted_holder_revokable_script.1.write(writer)?;
936 broadcasted_holder_revokable_script.2.write(writer)?;
938 writer.write_all(&[1; 1])?;
941 self.counterparty_payment_script.write(writer)?;
942 match &self.shutdown_script {
943 Some(script) => script.write(writer)?,
944 None => ScriptBuf::new().write(writer)?,
947 self.channel_keys_id.write(writer)?;
948 self.holder_revocation_basepoint.write(writer)?;
949 writer.write_all(&self.funding_info.0.txid[..])?;
950 writer.write_all(&self.funding_info.0.index.to_be_bytes())?;
951 self.funding_info.1.write(writer)?;
952 self.current_counterparty_commitment_txid.write(writer)?;
953 self.prev_counterparty_commitment_txid.write(writer)?;
955 self.counterparty_commitment_params.write(writer)?;
956 self.funding_redeemscript.write(writer)?;
957 self.channel_value_satoshis.write(writer)?;
959 match self.their_cur_per_commitment_points {
960 Some((idx, pubkey, second_option)) => {
961 writer.write_all(&byte_utils::be48_to_array(idx))?;
962 writer.write_all(&pubkey.serialize())?;
963 match second_option {
964 Some(second_pubkey) => {
965 writer.write_all(&second_pubkey.serialize())?;
968 writer.write_all(&[0; 33])?;
973 writer.write_all(&byte_utils::be48_to_array(0))?;
977 writer.write_all(&self.on_holder_tx_csv.to_be_bytes())?;
979 self.commitment_secrets.write(writer)?;
981 macro_rules! serialize_htlc_in_commitment {
982 ($htlc_output: expr) => {
983 writer.write_all(&[$htlc_output.offered as u8; 1])?;
984 writer.write_all(&$htlc_output.amount_msat.to_be_bytes())?;
985 writer.write_all(&$htlc_output.cltv_expiry.to_be_bytes())?;
986 writer.write_all(&$htlc_output.payment_hash.0[..])?;
987 $htlc_output.transaction_output_index.write(writer)?;
991 writer.write_all(&(self.counterparty_claimable_outpoints.len() as u64).to_be_bytes())?;
992 for (ref txid, ref htlc_infos) in self.counterparty_claimable_outpoints.iter() {
993 writer.write_all(&txid[..])?;
994 writer.write_all(&(htlc_infos.len() as u64).to_be_bytes())?;
995 for &(ref htlc_output, ref htlc_source) in htlc_infos.iter() {
996 debug_assert!(htlc_source.is_none() || Some(**txid) == self.current_counterparty_commitment_txid
997 || Some(**txid) == self.prev_counterparty_commitment_txid,
998 "HTLC Sources for all revoked commitment transactions should be none!");
999 serialize_htlc_in_commitment!(htlc_output);
1000 htlc_source.as_ref().map(|b| b.as_ref()).write(writer)?;
1004 writer.write_all(&(self.counterparty_commitment_txn_on_chain.len() as u64).to_be_bytes())?;
1005 for (ref txid, commitment_number) in self.counterparty_commitment_txn_on_chain.iter() {
1006 writer.write_all(&txid[..])?;
1007 writer.write_all(&byte_utils::be48_to_array(*commitment_number))?;
1010 writer.write_all(&(self.counterparty_hash_commitment_number.len() as u64).to_be_bytes())?;
1011 for (ref payment_hash, commitment_number) in self.counterparty_hash_commitment_number.iter() {
1012 writer.write_all(&payment_hash.0[..])?;
1013 writer.write_all(&byte_utils::be48_to_array(*commitment_number))?;
1016 if let Some(ref prev_holder_tx) = self.prev_holder_signed_commitment_tx {
1017 writer.write_all(&[1; 1])?;
1018 prev_holder_tx.write(writer)?;
1020 writer.write_all(&[0; 1])?;
1023 self.current_holder_commitment_tx.write(writer)?;
1025 writer.write_all(&byte_utils::be48_to_array(self.current_counterparty_commitment_number))?;
1026 writer.write_all(&byte_utils::be48_to_array(self.current_holder_commitment_number))?;
1028 writer.write_all(&(self.payment_preimages.len() as u64).to_be_bytes())?;
1029 for payment_preimage in self.payment_preimages.values() {
1030 writer.write_all(&payment_preimage.0[..])?;
1033 writer.write_all(&(self.pending_monitor_events.iter().filter(|ev| match ev {
1034 MonitorEvent::HTLCEvent(_) => true,
1035 MonitorEvent::HolderForceClosed(_) => true,
1037 }).count() as u64).to_be_bytes())?;
1038 for event in self.pending_monitor_events.iter() {
1040 MonitorEvent::HTLCEvent(upd) => {
1044 MonitorEvent::HolderForceClosed(_) => 1u8.write(writer)?,
1045 _ => {}, // Covered in the TLV writes below
1049 writer.write_all(&(self.pending_events.len() as u64).to_be_bytes())?;
1050 for event in self.pending_events.iter() {
1051 event.write(writer)?;
1054 self.best_block.block_hash().write(writer)?;
1055 writer.write_all(&self.best_block.height().to_be_bytes())?;
1057 writer.write_all(&(self.onchain_events_awaiting_threshold_conf.len() as u64).to_be_bytes())?;
1058 for ref entry in self.onchain_events_awaiting_threshold_conf.iter() {
1059 entry.write(writer)?;
1062 (self.outputs_to_watch.len() as u64).write(writer)?;
1063 for (txid, idx_scripts) in self.outputs_to_watch.iter() {
1064 txid.write(writer)?;
1065 (idx_scripts.len() as u64).write(writer)?;
1066 for (idx, script) in idx_scripts.iter() {
1068 script.write(writer)?;
1071 self.onchain_tx_handler.write(writer)?;
1073 self.lockdown_from_offchain.write(writer)?;
1074 self.holder_tx_signed.write(writer)?;
1076 write_tlv_fields!(writer, {
1077 (1, self.funding_spend_confirmed, option),
1078 (3, self.htlcs_resolved_on_chain, required_vec),
1079 (5, self.pending_monitor_events, required_vec),
1080 (7, self.funding_spend_seen, required),
1081 (9, self.counterparty_node_id, option),
1082 (11, self.confirmed_commitment_tx_counterparty_output, option),
1083 (13, self.spendable_txids_confirmed, required_vec),
1084 (15, self.counterparty_fulfilled_htlcs, required),
1085 (17, self.initial_counterparty_commitment_info, option),
1092 macro_rules! _process_events_body {
1093 ($self_opt: expr, $event_to_handle: expr, $handle_event: expr) => {
1095 let (pending_events, repeated_events);
1096 if let Some(us) = $self_opt {
1097 let mut inner = us.inner.lock().unwrap();
1098 if inner.is_processing_pending_events {
1101 inner.is_processing_pending_events = true;
1103 pending_events = inner.pending_events.clone();
1104 repeated_events = inner.get_repeated_events();
1106 let num_events = pending_events.len();
1108 for event in pending_events.into_iter().chain(repeated_events.into_iter()) {
1109 $event_to_handle = event;
1113 if let Some(us) = $self_opt {
1114 let mut inner = us.inner.lock().unwrap();
1115 inner.pending_events.drain(..num_events);
1116 inner.is_processing_pending_events = false;
1117 if !inner.pending_events.is_empty() {
1118 // If there's more events to process, go ahead and do so.
1126 pub(super) use _process_events_body as process_events_body;
1128 impl<Signer: WriteableEcdsaChannelSigner> ChannelMonitor<Signer> {
1129 /// For lockorder enforcement purposes, we need to have a single site which constructs the
1130 /// `inner` mutex, otherwise cases where we lock two monitors at the same time (eg in our
1131 /// PartialEq implementation) we may decide a lockorder violation has occurred.
1132 fn from_impl(imp: ChannelMonitorImpl<Signer>) -> Self {
1133 ChannelMonitor { inner: Mutex::new(imp) }
1136 pub(crate) fn new(secp_ctx: Secp256k1<secp256k1::All>, keys: Signer, shutdown_script: Option<ScriptBuf>,
1137 on_counterparty_tx_csv: u16, destination_script: &Script, funding_info: (OutPoint, ScriptBuf),
1138 channel_parameters: &ChannelTransactionParameters,
1139 funding_redeemscript: ScriptBuf, channel_value_satoshis: u64,
1140 commitment_transaction_number_obscure_factor: u64,
1141 initial_holder_commitment_tx: HolderCommitmentTransaction,
1142 best_block: BestBlock, counterparty_node_id: PublicKey) -> ChannelMonitor<Signer> {
1144 assert!(commitment_transaction_number_obscure_factor <= (1 << 48));
1145 let counterparty_payment_script = chan_utils::get_counterparty_payment_script(
1146 &channel_parameters.channel_type_features, &keys.pubkeys().payment_point
1149 let counterparty_channel_parameters = channel_parameters.counterparty_parameters.as_ref().unwrap();
1150 let counterparty_delayed_payment_base_key = counterparty_channel_parameters.pubkeys.delayed_payment_basepoint;
1151 let counterparty_htlc_base_key = counterparty_channel_parameters.pubkeys.htlc_basepoint;
1152 let counterparty_commitment_params = CounterpartyCommitmentParameters { counterparty_delayed_payment_base_key, counterparty_htlc_base_key, on_counterparty_tx_csv };
1154 let channel_keys_id = keys.channel_keys_id();
1155 let holder_revocation_basepoint = keys.pubkeys().revocation_basepoint;
1157 // block for Rust 1.34 compat
1158 let (holder_commitment_tx, current_holder_commitment_number) = {
1159 let trusted_tx = initial_holder_commitment_tx.trust();
1160 let txid = trusted_tx.txid();
1162 let tx_keys = trusted_tx.keys();
1163 let holder_commitment_tx = HolderSignedTx {
1165 revocation_key: tx_keys.revocation_key,
1166 a_htlc_key: tx_keys.broadcaster_htlc_key,
1167 b_htlc_key: tx_keys.countersignatory_htlc_key,
1168 delayed_payment_key: tx_keys.broadcaster_delayed_payment_key,
1169 per_commitment_point: tx_keys.per_commitment_point,
1170 htlc_outputs: Vec::new(), // There are never any HTLCs in the initial commitment transactions
1171 to_self_value_sat: initial_holder_commitment_tx.to_broadcaster_value_sat(),
1172 feerate_per_kw: trusted_tx.feerate_per_kw(),
1174 (holder_commitment_tx, trusted_tx.commitment_number())
1177 let onchain_tx_handler = OnchainTxHandler::new(
1178 channel_value_satoshis, channel_keys_id, destination_script.into(), keys,
1179 channel_parameters.clone(), initial_holder_commitment_tx, secp_ctx
1182 let mut outputs_to_watch = HashMap::new();
1183 outputs_to_watch.insert(funding_info.0.txid, vec![(funding_info.0.index as u32, funding_info.1.clone())]);
1185 Self::from_impl(ChannelMonitorImpl {
1186 latest_update_id: 0,
1187 commitment_transaction_number_obscure_factor,
1189 destination_script: destination_script.into(),
1190 broadcasted_holder_revokable_script: None,
1191 counterparty_payment_script,
1195 holder_revocation_basepoint,
1197 current_counterparty_commitment_txid: None,
1198 prev_counterparty_commitment_txid: None,
1200 counterparty_commitment_params,
1201 funding_redeemscript,
1202 channel_value_satoshis,
1203 their_cur_per_commitment_points: None,
1205 on_holder_tx_csv: counterparty_channel_parameters.selected_contest_delay,
1207 commitment_secrets: CounterpartyCommitmentSecrets::new(),
1208 counterparty_claimable_outpoints: HashMap::new(),
1209 counterparty_commitment_txn_on_chain: HashMap::new(),
1210 counterparty_hash_commitment_number: HashMap::new(),
1211 counterparty_fulfilled_htlcs: HashMap::new(),
1213 prev_holder_signed_commitment_tx: None,
1214 current_holder_commitment_tx: holder_commitment_tx,
1215 current_counterparty_commitment_number: 1 << 48,
1216 current_holder_commitment_number,
1218 payment_preimages: HashMap::new(),
1219 pending_monitor_events: Vec::new(),
1220 pending_events: Vec::new(),
1221 is_processing_pending_events: false,
1223 onchain_events_awaiting_threshold_conf: Vec::new(),
1228 lockdown_from_offchain: false,
1229 holder_tx_signed: false,
1230 funding_spend_seen: false,
1231 funding_spend_confirmed: None,
1232 confirmed_commitment_tx_counterparty_output: None,
1233 htlcs_resolved_on_chain: Vec::new(),
1234 spendable_txids_confirmed: Vec::new(),
1237 counterparty_node_id: Some(counterparty_node_id),
1238 initial_counterparty_commitment_info: None,
1243 fn provide_secret(&self, idx: u64, secret: [u8; 32]) -> Result<(), &'static str> {
1244 self.inner.lock().unwrap().provide_secret(idx, secret)
1247 /// A variant of `Self::provide_latest_counterparty_commitment_tx` used to provide
1248 /// additional information to the monitor to store in order to recreate the initial
1249 /// counterparty commitment transaction during persistence (mainly for use in third-party
1252 /// This is used to provide the counterparty commitment information directly to the monitor
1253 /// before the initial persistence of a new channel.
1254 pub(crate) fn provide_initial_counterparty_commitment_tx<L: Deref>(
1255 &self, txid: Txid, htlc_outputs: Vec<(HTLCOutputInCommitment, Option<Box<HTLCSource>>)>,
1256 commitment_number: u64, their_cur_per_commitment_point: PublicKey, feerate_per_kw: u32,
1257 to_broadcaster_value_sat: u64, to_countersignatory_value_sat: u64, logger: &L,
1259 where L::Target: Logger
1261 self.inner.lock().unwrap().provide_initial_counterparty_commitment_tx(txid,
1262 htlc_outputs, commitment_number, their_cur_per_commitment_point, feerate_per_kw,
1263 to_broadcaster_value_sat, to_countersignatory_value_sat, logger);
1266 /// Informs this monitor of the latest counterparty (ie non-broadcastable) commitment transaction.
1267 /// The monitor watches for it to be broadcasted and then uses the HTLC information (and
1268 /// possibly future revocation/preimage information) to claim outputs where possible.
1269 /// We cache also the mapping hash:commitment number to lighten pruning of old preimages by watchtowers.
1271 fn provide_latest_counterparty_commitment_tx<L: Deref>(
1274 htlc_outputs: Vec<(HTLCOutputInCommitment, Option<Box<HTLCSource>>)>,
1275 commitment_number: u64,
1276 their_per_commitment_point: PublicKey,
1278 ) where L::Target: Logger {
1279 self.inner.lock().unwrap().provide_latest_counterparty_commitment_tx(
1280 txid, htlc_outputs, commitment_number, their_per_commitment_point, logger)
1284 fn provide_latest_holder_commitment_tx(
1285 &self, holder_commitment_tx: HolderCommitmentTransaction,
1286 htlc_outputs: Vec<(HTLCOutputInCommitment, Option<Signature>, Option<HTLCSource>)>,
1287 ) -> Result<(), ()> {
1288 self.inner.lock().unwrap().provide_latest_holder_commitment_tx(holder_commitment_tx, htlc_outputs, &Vec::new(), Vec::new()).map_err(|_| ())
1291 /// This is used to provide payment preimage(s) out-of-band during startup without updating the
1292 /// off-chain state with a new commitment transaction.
1293 pub(crate) fn provide_payment_preimage<B: Deref, F: Deref, L: Deref>(
1295 payment_hash: &PaymentHash,
1296 payment_preimage: &PaymentPreimage,
1298 fee_estimator: &LowerBoundedFeeEstimator<F>,
1301 B::Target: BroadcasterInterface,
1302 F::Target: FeeEstimator,
1305 self.inner.lock().unwrap().provide_payment_preimage(
1306 payment_hash, payment_preimage, broadcaster, fee_estimator, logger)
1309 /// Updates a ChannelMonitor on the basis of some new information provided by the Channel
1312 /// panics if the given update is not the next update by update_id.
1313 pub fn update_monitor<B: Deref, F: Deref, L: Deref>(
1315 updates: &ChannelMonitorUpdate,
1321 B::Target: BroadcasterInterface,
1322 F::Target: FeeEstimator,
1325 self.inner.lock().unwrap().update_monitor(updates, broadcaster, fee_estimator, logger)
1328 /// Gets the update_id from the latest ChannelMonitorUpdate which was applied to this
1330 pub fn get_latest_update_id(&self) -> u64 {
1331 self.inner.lock().unwrap().get_latest_update_id()
1334 /// Gets the funding transaction outpoint of the channel this ChannelMonitor is monitoring for.
1335 pub fn get_funding_txo(&self) -> (OutPoint, ScriptBuf) {
1336 self.inner.lock().unwrap().get_funding_txo().clone()
1339 /// Gets a list of txids, with their output scripts (in the order they appear in the
1340 /// transaction), which we must learn about spends of via block_connected().
1341 pub fn get_outputs_to_watch(&self) -> Vec<(Txid, Vec<(u32, ScriptBuf)>)> {
1342 self.inner.lock().unwrap().get_outputs_to_watch()
1343 .iter().map(|(txid, outputs)| (*txid, outputs.clone())).collect()
1346 /// Loads the funding txo and outputs to watch into the given `chain::Filter` by repeatedly
1347 /// calling `chain::Filter::register_output` and `chain::Filter::register_tx` until all outputs
1348 /// have been registered.
1349 pub fn load_outputs_to_watch<F: Deref>(&self, filter: &F) where F::Target: chain::Filter {
1350 let lock = self.inner.lock().unwrap();
1351 filter.register_tx(&lock.get_funding_txo().0.txid, &lock.get_funding_txo().1);
1352 for (txid, outputs) in lock.get_outputs_to_watch().iter() {
1353 for (index, script_pubkey) in outputs.iter() {
1354 assert!(*index <= u16::max_value() as u32);
1355 filter.register_output(WatchedOutput {
1357 outpoint: OutPoint { txid: *txid, index: *index as u16 },
1358 script_pubkey: script_pubkey.clone(),
1364 /// Get the list of HTLCs who's status has been updated on chain. This should be called by
1365 /// ChannelManager via [`chain::Watch::release_pending_monitor_events`].
1366 pub fn get_and_clear_pending_monitor_events(&self) -> Vec<MonitorEvent> {
1367 self.inner.lock().unwrap().get_and_clear_pending_monitor_events()
1370 /// Processes [`SpendableOutputs`] events produced from each [`ChannelMonitor`] upon maturity.
1372 /// For channels featuring anchor outputs, this method will also process [`BumpTransaction`]
1373 /// events produced from each [`ChannelMonitor`] while there is a balance to claim onchain
1374 /// within each channel. As the confirmation of a commitment transaction may be critical to the
1375 /// safety of funds, we recommend invoking this every 30 seconds, or lower if running in an
1376 /// environment with spotty connections, like on mobile.
1378 /// An [`EventHandler`] may safely call back to the provider, though this shouldn't be needed in
1379 /// order to handle these events.
1381 /// [`SpendableOutputs`]: crate::events::Event::SpendableOutputs
1382 /// [`BumpTransaction`]: crate::events::Event::BumpTransaction
1383 pub fn process_pending_events<H: Deref>(&self, handler: &H) where H::Target: EventHandler {
1385 process_events_body!(Some(self), ev, handler.handle_event(ev));
1388 /// Processes any events asynchronously.
1390 /// See [`Self::process_pending_events`] for more information.
1391 pub async fn process_pending_events_async<Future: core::future::Future, H: Fn(Event) -> Future>(
1395 process_events_body!(Some(self), ev, { handler(ev).await });
1399 pub fn get_and_clear_pending_events(&self) -> Vec<Event> {
1400 let mut ret = Vec::new();
1401 let mut lck = self.inner.lock().unwrap();
1402 mem::swap(&mut ret, &mut lck.pending_events);
1403 ret.append(&mut lck.get_repeated_events());
1407 /// Gets the counterparty's initial commitment transaction. The returned commitment
1408 /// transaction is unsigned. This is intended to be called during the initial persistence of
1409 /// the monitor (inside an implementation of [`Persist::persist_new_channel`]), to allow for
1410 /// watchtowers in the persistence pipeline to have enough data to form justice transactions.
1412 /// This is similar to [`Self::counterparty_commitment_txs_from_update`], except
1413 /// that for the initial commitment transaction, we don't have a corresponding update.
1415 /// This will only return `Some` for channel monitors that have been created after upgrading
1416 /// to LDK 0.0.117+.
1418 /// [`Persist::persist_new_channel`]: crate::chain::chainmonitor::Persist::persist_new_channel
1419 pub fn initial_counterparty_commitment_tx(&self) -> Option<CommitmentTransaction> {
1420 self.inner.lock().unwrap().initial_counterparty_commitment_tx()
1423 /// Gets all of the counterparty commitment transactions provided by the given update. This
1424 /// may be empty if the update doesn't include any new counterparty commitments. Returned
1425 /// commitment transactions are unsigned.
1427 /// This is provided so that watchtower clients in the persistence pipeline are able to build
1428 /// justice transactions for each counterparty commitment upon each update. It's intended to be
1429 /// used within an implementation of [`Persist::update_persisted_channel`], which is provided
1430 /// with a monitor and an update. Once revoked, signing a justice transaction can be done using
1431 /// [`Self::sign_to_local_justice_tx`].
1433 /// It is expected that a watchtower client may use this method to retrieve the latest counterparty
1434 /// commitment transaction(s), and then hold the necessary data until a later update in which
1435 /// the monitor has been updated with the corresponding revocation data, at which point the
1436 /// monitor can sign the justice transaction.
1438 /// This will only return a non-empty list for monitor updates that have been created after
1439 /// upgrading to LDK 0.0.117+. Note that no restriction lies on the monitors themselves, which
1440 /// may have been created prior to upgrading.
1442 /// [`Persist::update_persisted_channel`]: crate::chain::chainmonitor::Persist::update_persisted_channel
1443 pub fn counterparty_commitment_txs_from_update(&self, update: &ChannelMonitorUpdate) -> Vec<CommitmentTransaction> {
1444 self.inner.lock().unwrap().counterparty_commitment_txs_from_update(update)
1447 /// Wrapper around [`EcdsaChannelSigner::sign_justice_revoked_output`] to make
1448 /// signing the justice transaction easier for implementors of
1449 /// [`chain::chainmonitor::Persist`]. On success this method returns the provided transaction
1450 /// signing the input at `input_idx`. This method will only produce a valid signature for
1451 /// a transaction spending the `to_local` output of a commitment transaction, i.e. this cannot
1452 /// be used for revoked HTLC outputs.
1454 /// `Value` is the value of the output being spent by the input at `input_idx`, committed
1455 /// in the BIP 143 signature.
1457 /// This method will only succeed if this monitor has received the revocation secret for the
1458 /// provided `commitment_number`. If a commitment number is provided that does not correspond
1459 /// to the commitment transaction being revoked, this will return a signed transaction, but
1460 /// the signature will not be valid.
1462 /// [`EcdsaChannelSigner::sign_justice_revoked_output`]: crate::sign::EcdsaChannelSigner::sign_justice_revoked_output
1463 /// [`Persist`]: crate::chain::chainmonitor::Persist
1464 pub fn sign_to_local_justice_tx(&self, justice_tx: Transaction, input_idx: usize, value: u64, commitment_number: u64) -> Result<Transaction, ()> {
1465 self.inner.lock().unwrap().sign_to_local_justice_tx(justice_tx, input_idx, value, commitment_number)
1468 pub(crate) fn get_min_seen_secret(&self) -> u64 {
1469 self.inner.lock().unwrap().get_min_seen_secret()
1472 pub(crate) fn get_cur_counterparty_commitment_number(&self) -> u64 {
1473 self.inner.lock().unwrap().get_cur_counterparty_commitment_number()
1476 pub(crate) fn get_cur_holder_commitment_number(&self) -> u64 {
1477 self.inner.lock().unwrap().get_cur_holder_commitment_number()
1480 /// Gets the `node_id` of the counterparty for this channel.
1482 /// Will be `None` for channels constructed on LDK versions prior to 0.0.110 and always `Some`
1484 pub fn get_counterparty_node_id(&self) -> Option<PublicKey> {
1485 self.inner.lock().unwrap().counterparty_node_id
1488 /// Used by [`ChannelManager`] deserialization to broadcast the latest holder state if its copy
1489 /// of the channel state was out-of-date.
1491 /// You may also use this to broadcast the latest local commitment transaction, either because
1492 /// a monitor update failed or because we've fallen behind (i.e. we've received proof that our
1493 /// counterparty side knows a revocation secret we gave them that they shouldn't know).
1495 /// Broadcasting these transactions in the second case is UNSAFE, as they allow counterparty
1496 /// side to punish you. Nevertheless you may want to broadcast them if counterparty doesn't
1497 /// close channel with their commitment transaction after a substantial amount of time. Best
1498 /// may be to contact the other node operator out-of-band to coordinate other options available
1501 /// [`ChannelManager`]: crate::ln::channelmanager::ChannelManager
1502 pub fn get_latest_holder_commitment_txn<L: Deref>(&self, logger: &L) -> Vec<Transaction>
1503 where L::Target: Logger {
1504 self.inner.lock().unwrap().get_latest_holder_commitment_txn(logger)
1507 /// Unsafe test-only version of get_latest_holder_commitment_txn used by our test framework
1508 /// to bypass HolderCommitmentTransaction state update lockdown after signature and generate
1509 /// revoked commitment transaction.
1510 #[cfg(any(test, feature = "unsafe_revoked_tx_signing"))]
1511 pub fn unsafe_get_latest_holder_commitment_txn<L: Deref>(&self, logger: &L) -> Vec<Transaction>
1512 where L::Target: Logger {
1513 self.inner.lock().unwrap().unsafe_get_latest_holder_commitment_txn(logger)
1516 /// Processes transactions in a newly connected block, which may result in any of the following:
1517 /// - update the monitor's state against resolved HTLCs
1518 /// - punish the counterparty in the case of seeing a revoked commitment transaction
1519 /// - force close the channel and claim/timeout incoming/outgoing HTLCs if near expiration
1520 /// - detect settled outputs for later spending
1521 /// - schedule and bump any in-flight claims
1523 /// Returns any new outputs to watch from `txdata`; after called, these are also included in
1524 /// [`get_outputs_to_watch`].
1526 /// [`get_outputs_to_watch`]: #method.get_outputs_to_watch
1527 pub fn block_connected<B: Deref, F: Deref, L: Deref>(
1530 txdata: &TransactionData,
1535 ) -> Vec<TransactionOutputs>
1537 B::Target: BroadcasterInterface,
1538 F::Target: FeeEstimator,
1541 self.inner.lock().unwrap().block_connected(
1542 header, txdata, height, broadcaster, fee_estimator, logger)
1545 /// Determines if the disconnected block contained any transactions of interest and updates
1547 pub fn block_disconnected<B: Deref, F: Deref, L: Deref>(
1555 B::Target: BroadcasterInterface,
1556 F::Target: FeeEstimator,
1559 self.inner.lock().unwrap().block_disconnected(
1560 header, height, broadcaster, fee_estimator, logger)
1563 /// Processes transactions confirmed in a block with the given header and height, returning new
1564 /// outputs to watch. See [`block_connected`] for details.
1566 /// Used instead of [`block_connected`] by clients that are notified of transactions rather than
1567 /// blocks. See [`chain::Confirm`] for calling expectations.
1569 /// [`block_connected`]: Self::block_connected
1570 pub fn transactions_confirmed<B: Deref, F: Deref, L: Deref>(
1573 txdata: &TransactionData,
1578 ) -> Vec<TransactionOutputs>
1580 B::Target: BroadcasterInterface,
1581 F::Target: FeeEstimator,
1584 let bounded_fee_estimator = LowerBoundedFeeEstimator::new(fee_estimator);
1585 self.inner.lock().unwrap().transactions_confirmed(
1586 header, txdata, height, broadcaster, &bounded_fee_estimator, logger)
1589 /// Processes a transaction that was reorganized out of the chain.
1591 /// Used instead of [`block_disconnected`] by clients that are notified of transactions rather
1592 /// than blocks. See [`chain::Confirm`] for calling expectations.
1594 /// [`block_disconnected`]: Self::block_disconnected
1595 pub fn transaction_unconfirmed<B: Deref, F: Deref, L: Deref>(
1602 B::Target: BroadcasterInterface,
1603 F::Target: FeeEstimator,
1606 let bounded_fee_estimator = LowerBoundedFeeEstimator::new(fee_estimator);
1607 self.inner.lock().unwrap().transaction_unconfirmed(
1608 txid, broadcaster, &bounded_fee_estimator, logger);
1611 /// Updates the monitor with the current best chain tip, returning new outputs to watch. See
1612 /// [`block_connected`] for details.
1614 /// Used instead of [`block_connected`] by clients that are notified of transactions rather than
1615 /// blocks. See [`chain::Confirm`] for calling expectations.
1617 /// [`block_connected`]: Self::block_connected
1618 pub fn best_block_updated<B: Deref, F: Deref, L: Deref>(
1625 ) -> Vec<TransactionOutputs>
1627 B::Target: BroadcasterInterface,
1628 F::Target: FeeEstimator,
1631 let bounded_fee_estimator = LowerBoundedFeeEstimator::new(fee_estimator);
1632 self.inner.lock().unwrap().best_block_updated(
1633 header, height, broadcaster, &bounded_fee_estimator, logger)
1636 /// Returns the set of txids that should be monitored for re-organization out of the chain.
1637 pub fn get_relevant_txids(&self) -> Vec<(Txid, u32, Option<BlockHash>)> {
1638 let inner = self.inner.lock().unwrap();
1639 let mut txids: Vec<(Txid, u32, Option<BlockHash>)> = inner.onchain_events_awaiting_threshold_conf
1641 .map(|entry| (entry.txid, entry.height, entry.block_hash))
1642 .chain(inner.onchain_tx_handler.get_relevant_txids().into_iter())
1644 txids.sort_unstable_by(|a, b| a.0.cmp(&b.0).then(b.1.cmp(&a.1)));
1645 txids.dedup_by_key(|(txid, _, _)| *txid);
1649 /// Gets the latest best block which was connected either via the [`chain::Listen`] or
1650 /// [`chain::Confirm`] interfaces.
1651 pub fn current_best_block(&self) -> BestBlock {
1652 self.inner.lock().unwrap().best_block.clone()
1655 /// Triggers rebroadcasts/fee-bumps of pending claims from a force-closed channel. This is
1656 /// crucial in preventing certain classes of pinning attacks, detecting substantial mempool
1657 /// feerate changes between blocks, and ensuring reliability if broadcasting fails. We recommend
1658 /// invoking this every 30 seconds, or lower if running in an environment with spotty
1659 /// connections, like on mobile.
1660 pub fn rebroadcast_pending_claims<B: Deref, F: Deref, L: Deref>(
1661 &self, broadcaster: B, fee_estimator: F, logger: L,
1664 B::Target: BroadcasterInterface,
1665 F::Target: FeeEstimator,
1668 let fee_estimator = LowerBoundedFeeEstimator::new(fee_estimator);
1669 let mut inner = self.inner.lock().unwrap();
1670 let current_height = inner.best_block.height;
1671 inner.onchain_tx_handler.rebroadcast_pending_claims(
1672 current_height, &broadcaster, &fee_estimator, &logger,
1676 /// Returns the descriptors for relevant outputs (i.e., those that we can spend) within the
1677 /// transaction if they exist and the transaction has at least [`ANTI_REORG_DELAY`]
1678 /// confirmations. For [`SpendableOutputDescriptor::DelayedPaymentOutput`] descriptors to be
1679 /// returned, the transaction must have at least `max(ANTI_REORG_DELAY, to_self_delay)`
1682 /// Descriptors returned by this method are primarily exposed via [`Event::SpendableOutputs`]
1683 /// once they are no longer under reorg risk. This method serves as a way to retrieve these
1684 /// descriptors at a later time, either for historical purposes, or to replay any
1685 /// missed/unhandled descriptors. For the purpose of gathering historical records, if the
1686 /// channel close has fully resolved (i.e., [`ChannelMonitor::get_claimable_balances`] returns
1687 /// an empty set), you can retrieve all spendable outputs by providing all descendant spending
1688 /// transactions starting from the channel's funding transaction and going down three levels.
1690 /// `tx` is a transaction we'll scan the outputs of. Any transaction can be provided. If any
1691 /// outputs which can be spent by us are found, at least one descriptor is returned.
1693 /// `confirmation_height` must be the height of the block in which `tx` was included in.
1694 pub fn get_spendable_outputs(&self, tx: &Transaction, confirmation_height: u32) -> Vec<SpendableOutputDescriptor> {
1695 let inner = self.inner.lock().unwrap();
1696 let current_height = inner.best_block.height;
1697 let mut spendable_outputs = inner.get_spendable_outputs(tx);
1698 spendable_outputs.retain(|descriptor| {
1699 let mut conf_threshold = current_height.saturating_sub(ANTI_REORG_DELAY) + 1;
1700 if let SpendableOutputDescriptor::DelayedPaymentOutput(descriptor) = descriptor {
1701 conf_threshold = cmp::min(conf_threshold,
1702 current_height.saturating_sub(descriptor.to_self_delay as u32) + 1);
1704 conf_threshold >= confirmation_height
1710 pub fn get_counterparty_payment_script(&self) -> ScriptBuf {
1711 self.inner.lock().unwrap().counterparty_payment_script.clone()
1715 pub fn set_counterparty_payment_script(&self, script: ScriptBuf) {
1716 self.inner.lock().unwrap().counterparty_payment_script = script;
1720 impl<Signer: WriteableEcdsaChannelSigner> ChannelMonitorImpl<Signer> {
1721 /// Helper for get_claimable_balances which does the work for an individual HTLC, generating up
1722 /// to one `Balance` for the HTLC.
1723 fn get_htlc_balance(&self, htlc: &HTLCOutputInCommitment, holder_commitment: bool,
1724 counterparty_revoked_commitment: bool, confirmed_txid: Option<Txid>)
1725 -> Option<Balance> {
1726 let htlc_commitment_tx_output_idx =
1727 if let Some(v) = htlc.transaction_output_index { v } else { return None; };
1729 let mut htlc_spend_txid_opt = None;
1730 let mut htlc_spend_tx_opt = None;
1731 let mut holder_timeout_spend_pending = None;
1732 let mut htlc_spend_pending = None;
1733 let mut holder_delayed_output_pending = None;
1734 for event in self.onchain_events_awaiting_threshold_conf.iter() {
1736 OnchainEvent::HTLCUpdate { commitment_tx_output_idx, htlc_value_satoshis, .. }
1737 if commitment_tx_output_idx == Some(htlc_commitment_tx_output_idx) => {
1738 debug_assert!(htlc_spend_txid_opt.is_none());
1739 htlc_spend_txid_opt = Some(&event.txid);
1740 debug_assert!(htlc_spend_tx_opt.is_none());
1741 htlc_spend_tx_opt = event.transaction.as_ref();
1742 debug_assert!(holder_timeout_spend_pending.is_none());
1743 debug_assert_eq!(htlc_value_satoshis.unwrap(), htlc.amount_msat / 1000);
1744 holder_timeout_spend_pending = Some(event.confirmation_threshold());
1746 OnchainEvent::HTLCSpendConfirmation { commitment_tx_output_idx, preimage, .. }
1747 if commitment_tx_output_idx == htlc_commitment_tx_output_idx => {
1748 debug_assert!(htlc_spend_txid_opt.is_none());
1749 htlc_spend_txid_opt = Some(&event.txid);
1750 debug_assert!(htlc_spend_tx_opt.is_none());
1751 htlc_spend_tx_opt = event.transaction.as_ref();
1752 debug_assert!(htlc_spend_pending.is_none());
1753 htlc_spend_pending = Some((event.confirmation_threshold(), preimage.is_some()));
1755 OnchainEvent::MaturingOutput {
1756 descriptor: SpendableOutputDescriptor::DelayedPaymentOutput(ref descriptor) }
1757 if event.transaction.as_ref().map(|tx| tx.input.iter().enumerate()
1758 .any(|(input_idx, inp)|
1759 Some(inp.previous_output.txid) == confirmed_txid &&
1760 inp.previous_output.vout == htlc_commitment_tx_output_idx &&
1761 // A maturing output for an HTLC claim will always be at the same
1762 // index as the HTLC input. This is true pre-anchors, as there's
1763 // only 1 input and 1 output. This is also true post-anchors,
1764 // because we have a SIGHASH_SINGLE|ANYONECANPAY signature from our
1765 // channel counterparty.
1766 descriptor.outpoint.index as usize == input_idx
1770 debug_assert!(holder_delayed_output_pending.is_none());
1771 holder_delayed_output_pending = Some(event.confirmation_threshold());
1776 let htlc_resolved = self.htlcs_resolved_on_chain.iter()
1777 .find(|v| if v.commitment_tx_output_idx == Some(htlc_commitment_tx_output_idx) {
1778 debug_assert!(htlc_spend_txid_opt.is_none());
1779 htlc_spend_txid_opt = v.resolving_txid.as_ref();
1780 debug_assert!(htlc_spend_tx_opt.is_none());
1781 htlc_spend_tx_opt = v.resolving_tx.as_ref();
1784 debug_assert!(holder_timeout_spend_pending.is_some() as u8 + htlc_spend_pending.is_some() as u8 + htlc_resolved.is_some() as u8 <= 1);
1786 let htlc_commitment_outpoint = BitcoinOutPoint::new(confirmed_txid.unwrap(), htlc_commitment_tx_output_idx);
1787 let htlc_output_to_spend =
1788 if let Some(txid) = htlc_spend_txid_opt {
1789 // Because HTLC transactions either only have 1 input and 1 output (pre-anchors) or
1790 // are signed with SIGHASH_SINGLE|ANYONECANPAY under BIP-0143 (post-anchors), we can
1791 // locate the correct output by ensuring its adjacent input spends the HTLC output
1792 // in the commitment.
1793 if let Some(ref tx) = htlc_spend_tx_opt {
1794 let htlc_input_idx_opt = tx.input.iter().enumerate()
1795 .find(|(_, input)| input.previous_output == htlc_commitment_outpoint)
1796 .map(|(idx, _)| idx as u32);
1797 debug_assert!(htlc_input_idx_opt.is_some());
1798 BitcoinOutPoint::new(*txid, htlc_input_idx_opt.unwrap_or(0))
1800 debug_assert!(!self.onchain_tx_handler.channel_type_features().supports_anchors_zero_fee_htlc_tx());
1801 BitcoinOutPoint::new(*txid, 0)
1804 htlc_commitment_outpoint
1806 let htlc_output_spend_pending = self.onchain_tx_handler.is_output_spend_pending(&htlc_output_to_spend);
1808 if let Some(conf_thresh) = holder_delayed_output_pending {
1809 debug_assert!(holder_commitment);
1810 return Some(Balance::ClaimableAwaitingConfirmations {
1811 amount_satoshis: htlc.amount_msat / 1000,
1812 confirmation_height: conf_thresh,
1814 } else if htlc_resolved.is_some() && !htlc_output_spend_pending {
1815 // Funding transaction spends should be fully confirmed by the time any
1816 // HTLC transactions are resolved, unless we're talking about a holder
1817 // commitment tx, whose resolution is delayed until the CSV timeout is
1818 // reached, even though HTLCs may be resolved after only
1819 // ANTI_REORG_DELAY confirmations.
1820 debug_assert!(holder_commitment || self.funding_spend_confirmed.is_some());
1821 } else if counterparty_revoked_commitment {
1822 let htlc_output_claim_pending = self.onchain_events_awaiting_threshold_conf.iter().find_map(|event| {
1823 if let OnchainEvent::MaturingOutput {
1824 descriptor: SpendableOutputDescriptor::StaticOutput { .. }
1826 if event.transaction.as_ref().map(|tx| tx.input.iter().any(|inp| {
1827 if let Some(htlc_spend_txid) = htlc_spend_txid_opt {
1828 tx.txid() == *htlc_spend_txid || inp.previous_output.txid == *htlc_spend_txid
1830 Some(inp.previous_output.txid) == confirmed_txid &&
1831 inp.previous_output.vout == htlc_commitment_tx_output_idx
1833 })).unwrap_or(false) {
1838 if htlc_output_claim_pending.is_some() {
1839 // We already push `Balance`s onto the `res` list for every
1840 // `StaticOutput` in a `MaturingOutput` in the revoked
1841 // counterparty commitment transaction case generally, so don't
1842 // need to do so again here.
1844 debug_assert!(holder_timeout_spend_pending.is_none(),
1845 "HTLCUpdate OnchainEvents should never appear for preimage claims");
1846 debug_assert!(!htlc.offered || htlc_spend_pending.is_none() || !htlc_spend_pending.unwrap().1,
1847 "We don't (currently) generate preimage claims against revoked outputs, where did you get one?!");
1848 return Some(Balance::CounterpartyRevokedOutputClaimable {
1849 amount_satoshis: htlc.amount_msat / 1000,
1852 } else if htlc.offered == holder_commitment {
1853 // If the payment was outbound, check if there's an HTLCUpdate
1854 // indicating we have spent this HTLC with a timeout, claiming it back
1855 // and awaiting confirmations on it.
1856 if let Some(conf_thresh) = holder_timeout_spend_pending {
1857 return Some(Balance::ClaimableAwaitingConfirmations {
1858 amount_satoshis: htlc.amount_msat / 1000,
1859 confirmation_height: conf_thresh,
1862 return Some(Balance::MaybeTimeoutClaimableHTLC {
1863 amount_satoshis: htlc.amount_msat / 1000,
1864 claimable_height: htlc.cltv_expiry,
1865 payment_hash: htlc.payment_hash,
1868 } else if let Some(payment_preimage) = self.payment_preimages.get(&htlc.payment_hash) {
1869 // Otherwise (the payment was inbound), only expose it as claimable if
1870 // we know the preimage.
1871 // Note that if there is a pending claim, but it did not use the
1872 // preimage, we lost funds to our counterparty! We will then continue
1873 // to show it as ContentiousClaimable until ANTI_REORG_DELAY.
1874 debug_assert!(holder_timeout_spend_pending.is_none());
1875 if let Some((conf_thresh, true)) = htlc_spend_pending {
1876 return Some(Balance::ClaimableAwaitingConfirmations {
1877 amount_satoshis: htlc.amount_msat / 1000,
1878 confirmation_height: conf_thresh,
1881 return Some(Balance::ContentiousClaimable {
1882 amount_satoshis: htlc.amount_msat / 1000,
1883 timeout_height: htlc.cltv_expiry,
1884 payment_hash: htlc.payment_hash,
1885 payment_preimage: *payment_preimage,
1888 } else if htlc_resolved.is_none() {
1889 return Some(Balance::MaybePreimageClaimableHTLC {
1890 amount_satoshis: htlc.amount_msat / 1000,
1891 expiry_height: htlc.cltv_expiry,
1892 payment_hash: htlc.payment_hash,
1899 impl<Signer: WriteableEcdsaChannelSigner> ChannelMonitor<Signer> {
1900 /// Gets the balances in this channel which are either claimable by us if we were to
1901 /// force-close the channel now or which are claimable on-chain (possibly awaiting
1904 /// Any balances in the channel which are available on-chain (excluding on-chain fees) are
1905 /// included here until an [`Event::SpendableOutputs`] event has been generated for the
1906 /// balance, or until our counterparty has claimed the balance and accrued several
1907 /// confirmations on the claim transaction.
1909 /// Note that for `ChannelMonitors` which track a channel which went on-chain with versions of
1910 /// LDK prior to 0.0.111, not all or excess balances may be included.
1912 /// See [`Balance`] for additional details on the types of claimable balances which
1913 /// may be returned here and their meanings.
1914 pub fn get_claimable_balances(&self) -> Vec<Balance> {
1915 let mut res = Vec::new();
1916 let us = self.inner.lock().unwrap();
1918 let mut confirmed_txid = us.funding_spend_confirmed;
1919 let mut confirmed_counterparty_output = us.confirmed_commitment_tx_counterparty_output;
1920 let mut pending_commitment_tx_conf_thresh = None;
1921 let funding_spend_pending = us.onchain_events_awaiting_threshold_conf.iter().find_map(|event| {
1922 if let OnchainEvent::FundingSpendConfirmation { commitment_tx_to_counterparty_output, .. } =
1925 confirmed_counterparty_output = commitment_tx_to_counterparty_output;
1926 Some((event.txid, event.confirmation_threshold()))
1929 if let Some((txid, conf_thresh)) = funding_spend_pending {
1930 debug_assert!(us.funding_spend_confirmed.is_none(),
1931 "We have a pending funding spend awaiting anti-reorg confirmation, we can't have confirmed it already!");
1932 confirmed_txid = Some(txid);
1933 pending_commitment_tx_conf_thresh = Some(conf_thresh);
1936 macro_rules! walk_htlcs {
1937 ($holder_commitment: expr, $counterparty_revoked_commitment: expr, $htlc_iter: expr) => {
1938 for htlc in $htlc_iter {
1939 if htlc.transaction_output_index.is_some() {
1941 if let Some(bal) = us.get_htlc_balance(htlc, $holder_commitment, $counterparty_revoked_commitment, confirmed_txid) {
1949 if let Some(txid) = confirmed_txid {
1950 let mut found_commitment_tx = false;
1951 if let Some(counterparty_tx_htlcs) = us.counterparty_claimable_outpoints.get(&txid) {
1952 // First look for the to_remote output back to us.
1953 if let Some(conf_thresh) = pending_commitment_tx_conf_thresh {
1954 if let Some(value) = us.onchain_events_awaiting_threshold_conf.iter().find_map(|event| {
1955 if let OnchainEvent::MaturingOutput {
1956 descriptor: SpendableOutputDescriptor::StaticPaymentOutput(descriptor)
1958 Some(descriptor.output.value)
1961 res.push(Balance::ClaimableAwaitingConfirmations {
1962 amount_satoshis: value,
1963 confirmation_height: conf_thresh,
1966 // If a counterparty commitment transaction is awaiting confirmation, we
1967 // should either have a StaticPaymentOutput MaturingOutput event awaiting
1968 // confirmation with the same height or have never met our dust amount.
1971 if Some(txid) == us.current_counterparty_commitment_txid || Some(txid) == us.prev_counterparty_commitment_txid {
1972 walk_htlcs!(false, false, counterparty_tx_htlcs.iter().map(|(a, _)| a));
1974 walk_htlcs!(false, true, counterparty_tx_htlcs.iter().map(|(a, _)| a));
1975 // The counterparty broadcasted a revoked state!
1976 // Look for any StaticOutputs first, generating claimable balances for those.
1977 // If any match the confirmed counterparty revoked to_self output, skip
1978 // generating a CounterpartyRevokedOutputClaimable.
1979 let mut spent_counterparty_output = false;
1980 for event in us.onchain_events_awaiting_threshold_conf.iter() {
1981 if let OnchainEvent::MaturingOutput {
1982 descriptor: SpendableOutputDescriptor::StaticOutput { output, .. }
1984 res.push(Balance::ClaimableAwaitingConfirmations {
1985 amount_satoshis: output.value,
1986 confirmation_height: event.confirmation_threshold(),
1988 if let Some(confirmed_to_self_idx) = confirmed_counterparty_output.map(|(idx, _)| idx) {
1989 if event.transaction.as_ref().map(|tx|
1990 tx.input.iter().any(|inp| inp.previous_output.vout == confirmed_to_self_idx)
1991 ).unwrap_or(false) {
1992 spent_counterparty_output = true;
1998 if spent_counterparty_output {
1999 } else if let Some((confirmed_to_self_idx, amt)) = confirmed_counterparty_output {
2000 let output_spendable = us.onchain_tx_handler
2001 .is_output_spend_pending(&BitcoinOutPoint::new(txid, confirmed_to_self_idx));
2002 if output_spendable {
2003 res.push(Balance::CounterpartyRevokedOutputClaimable {
2004 amount_satoshis: amt,
2008 // Counterparty output is missing, either it was broadcasted on a
2009 // previous version of LDK or the counterparty hadn't met dust.
2012 found_commitment_tx = true;
2013 } else if txid == us.current_holder_commitment_tx.txid {
2014 walk_htlcs!(true, false, us.current_holder_commitment_tx.htlc_outputs.iter().map(|(a, _, _)| a));
2015 if let Some(conf_thresh) = pending_commitment_tx_conf_thresh {
2016 res.push(Balance::ClaimableAwaitingConfirmations {
2017 amount_satoshis: us.current_holder_commitment_tx.to_self_value_sat,
2018 confirmation_height: conf_thresh,
2021 found_commitment_tx = true;
2022 } else if let Some(prev_commitment) = &us.prev_holder_signed_commitment_tx {
2023 if txid == prev_commitment.txid {
2024 walk_htlcs!(true, false, prev_commitment.htlc_outputs.iter().map(|(a, _, _)| a));
2025 if let Some(conf_thresh) = pending_commitment_tx_conf_thresh {
2026 res.push(Balance::ClaimableAwaitingConfirmations {
2027 amount_satoshis: prev_commitment.to_self_value_sat,
2028 confirmation_height: conf_thresh,
2031 found_commitment_tx = true;
2034 if !found_commitment_tx {
2035 if let Some(conf_thresh) = pending_commitment_tx_conf_thresh {
2036 // We blindly assume this is a cooperative close transaction here, and that
2037 // neither us nor our counterparty misbehaved. At worst we've under-estimated
2038 // the amount we can claim as we'll punish a misbehaving counterparty.
2039 res.push(Balance::ClaimableAwaitingConfirmations {
2040 amount_satoshis: us.current_holder_commitment_tx.to_self_value_sat,
2041 confirmation_height: conf_thresh,
2046 let mut claimable_inbound_htlc_value_sat = 0;
2047 for (htlc, _, _) in us.current_holder_commitment_tx.htlc_outputs.iter() {
2048 if htlc.transaction_output_index.is_none() { continue; }
2050 res.push(Balance::MaybeTimeoutClaimableHTLC {
2051 amount_satoshis: htlc.amount_msat / 1000,
2052 claimable_height: htlc.cltv_expiry,
2053 payment_hash: htlc.payment_hash,
2055 } else if us.payment_preimages.get(&htlc.payment_hash).is_some() {
2056 claimable_inbound_htlc_value_sat += htlc.amount_msat / 1000;
2058 // As long as the HTLC is still in our latest commitment state, treat
2059 // it as potentially claimable, even if it has long-since expired.
2060 res.push(Balance::MaybePreimageClaimableHTLC {
2061 amount_satoshis: htlc.amount_msat / 1000,
2062 expiry_height: htlc.cltv_expiry,
2063 payment_hash: htlc.payment_hash,
2067 res.push(Balance::ClaimableOnChannelClose {
2068 amount_satoshis: us.current_holder_commitment_tx.to_self_value_sat + claimable_inbound_htlc_value_sat,
2075 /// Gets the set of outbound HTLCs which can be (or have been) resolved by this
2076 /// `ChannelMonitor`. This is used to determine if an HTLC was removed from the channel prior
2077 /// to the `ChannelManager` having been persisted.
2079 /// This is similar to [`Self::get_pending_or_resolved_outbound_htlcs`] except it includes
2080 /// HTLCs which were resolved on-chain (i.e. where the final HTLC resolution was done by an
2081 /// event from this `ChannelMonitor`).
2082 pub(crate) fn get_all_current_outbound_htlcs(&self) -> HashMap<HTLCSource, (HTLCOutputInCommitment, Option<PaymentPreimage>)> {
2083 let mut res = HashMap::new();
2084 // Just examine the available counterparty commitment transactions. See docs on
2085 // `fail_unbroadcast_htlcs`, below, for justification.
2086 let us = self.inner.lock().unwrap();
2087 macro_rules! walk_counterparty_commitment {
2089 if let Some(ref latest_outpoints) = us.counterparty_claimable_outpoints.get($txid) {
2090 for &(ref htlc, ref source_option) in latest_outpoints.iter() {
2091 if let &Some(ref source) = source_option {
2092 res.insert((**source).clone(), (htlc.clone(),
2093 us.counterparty_fulfilled_htlcs.get(&SentHTLCId::from_source(source)).cloned()));
2099 if let Some(ref txid) = us.current_counterparty_commitment_txid {
2100 walk_counterparty_commitment!(txid);
2102 if let Some(ref txid) = us.prev_counterparty_commitment_txid {
2103 walk_counterparty_commitment!(txid);
2108 /// Gets the set of outbound HTLCs which are pending resolution in this channel or which were
2109 /// resolved with a preimage from our counterparty.
2111 /// This is used to reconstruct pending outbound payments on restart in the ChannelManager.
2113 /// Currently, the preimage is unused, however if it is present in the relevant internal state
2114 /// an HTLC is always included even if it has been resolved.
2115 pub(crate) fn get_pending_or_resolved_outbound_htlcs(&self) -> HashMap<HTLCSource, (HTLCOutputInCommitment, Option<PaymentPreimage>)> {
2116 let us = self.inner.lock().unwrap();
2117 // We're only concerned with the confirmation count of HTLC transactions, and don't
2118 // actually care how many confirmations a commitment transaction may or may not have. Thus,
2119 // we look for either a FundingSpendConfirmation event or a funding_spend_confirmed.
2120 let confirmed_txid = us.funding_spend_confirmed.or_else(|| {
2121 us.onchain_events_awaiting_threshold_conf.iter().find_map(|event| {
2122 if let OnchainEvent::FundingSpendConfirmation { .. } = event.event {
2128 if confirmed_txid.is_none() {
2129 // If we have not seen a commitment transaction on-chain (ie the channel is not yet
2130 // closed), just get the full set.
2132 return self.get_all_current_outbound_htlcs();
2135 let mut res = HashMap::new();
2136 macro_rules! walk_htlcs {
2137 ($holder_commitment: expr, $htlc_iter: expr) => {
2138 for (htlc, source) in $htlc_iter {
2139 if us.htlcs_resolved_on_chain.iter().any(|v| v.commitment_tx_output_idx == htlc.transaction_output_index) {
2140 // We should assert that funding_spend_confirmed is_some() here, but we
2141 // have some unit tests which violate HTLC transaction CSVs entirely and
2143 // TODO: Once tests all connect transactions at consensus-valid times, we
2144 // should assert here like we do in `get_claimable_balances`.
2145 } else if htlc.offered == $holder_commitment {
2146 // If the payment was outbound, check if there's an HTLCUpdate
2147 // indicating we have spent this HTLC with a timeout, claiming it back
2148 // and awaiting confirmations on it.
2149 let htlc_update_confd = us.onchain_events_awaiting_threshold_conf.iter().any(|event| {
2150 if let OnchainEvent::HTLCUpdate { commitment_tx_output_idx: Some(commitment_tx_output_idx), .. } = event.event {
2151 // If the HTLC was timed out, we wait for ANTI_REORG_DELAY blocks
2152 // before considering it "no longer pending" - this matches when we
2153 // provide the ChannelManager an HTLC failure event.
2154 Some(commitment_tx_output_idx) == htlc.transaction_output_index &&
2155 us.best_block.height() >= event.height + ANTI_REORG_DELAY - 1
2156 } else if let OnchainEvent::HTLCSpendConfirmation { commitment_tx_output_idx, .. } = event.event {
2157 // If the HTLC was fulfilled with a preimage, we consider the HTLC
2158 // immediately non-pending, matching when we provide ChannelManager
2160 Some(commitment_tx_output_idx) == htlc.transaction_output_index
2163 let counterparty_resolved_preimage_opt =
2164 us.counterparty_fulfilled_htlcs.get(&SentHTLCId::from_source(source)).cloned();
2165 if !htlc_update_confd || counterparty_resolved_preimage_opt.is_some() {
2166 res.insert(source.clone(), (htlc.clone(), counterparty_resolved_preimage_opt));
2173 let txid = confirmed_txid.unwrap();
2174 if Some(txid) == us.current_counterparty_commitment_txid || Some(txid) == us.prev_counterparty_commitment_txid {
2175 walk_htlcs!(false, us.counterparty_claimable_outpoints.get(&txid).unwrap().iter().filter_map(|(a, b)| {
2176 if let &Some(ref source) = b {
2177 Some((a, &**source))
2180 } else if txid == us.current_holder_commitment_tx.txid {
2181 walk_htlcs!(true, us.current_holder_commitment_tx.htlc_outputs.iter().filter_map(|(a, _, c)| {
2182 if let Some(source) = c { Some((a, source)) } else { None }
2184 } else if let Some(prev_commitment) = &us.prev_holder_signed_commitment_tx {
2185 if txid == prev_commitment.txid {
2186 walk_htlcs!(true, prev_commitment.htlc_outputs.iter().filter_map(|(a, _, c)| {
2187 if let Some(source) = c { Some((a, source)) } else { None }
2195 pub(crate) fn get_stored_preimages(&self) -> HashMap<PaymentHash, PaymentPreimage> {
2196 self.inner.lock().unwrap().payment_preimages.clone()
2200 /// Compares a broadcasted commitment transaction's HTLCs with those in the latest state,
2201 /// failing any HTLCs which didn't make it into the broadcasted commitment transaction back
2202 /// after ANTI_REORG_DELAY blocks.
2204 /// We always compare against the set of HTLCs in counterparty commitment transactions, as those
2205 /// are the commitment transactions which are generated by us. The off-chain state machine in
2206 /// `Channel` will automatically resolve any HTLCs which were never included in a commitment
2207 /// transaction when it detects channel closure, but it is up to us to ensure any HTLCs which were
2208 /// included in a remote commitment transaction are failed back if they are not present in the
2209 /// broadcasted commitment transaction.
2211 /// Specifically, the removal process for HTLCs in `Channel` is always based on the counterparty
2212 /// sending a `revoke_and_ack`, which causes us to clear `prev_counterparty_commitment_txid`. Thus,
2213 /// as long as we examine both the current counterparty commitment transaction and, if it hasn't
2214 /// been revoked yet, the previous one, we we will never "forget" to resolve an HTLC.
2215 macro_rules! fail_unbroadcast_htlcs {
2216 ($self: expr, $commitment_tx_type: expr, $commitment_txid_confirmed: expr, $commitment_tx_confirmed: expr,
2217 $commitment_tx_conf_height: expr, $commitment_tx_conf_hash: expr, $confirmed_htlcs_list: expr, $logger: expr) => { {
2218 debug_assert_eq!($commitment_tx_confirmed.txid(), $commitment_txid_confirmed);
2220 macro_rules! check_htlc_fails {
2221 ($txid: expr, $commitment_tx: expr) => {
2222 if let Some(ref latest_outpoints) = $self.counterparty_claimable_outpoints.get($txid) {
2223 for &(ref htlc, ref source_option) in latest_outpoints.iter() {
2224 if let &Some(ref source) = source_option {
2225 // Check if the HTLC is present in the commitment transaction that was
2226 // broadcast, but not if it was below the dust limit, which we should
2227 // fail backwards immediately as there is no way for us to learn the
2228 // payment_preimage.
2229 // Note that if the dust limit were allowed to change between
2230 // commitment transactions we'd want to be check whether *any*
2231 // broadcastable commitment transaction has the HTLC in it, but it
2232 // cannot currently change after channel initialization, so we don't
2234 let confirmed_htlcs_iter: &mut Iterator<Item = (&HTLCOutputInCommitment, Option<&HTLCSource>)> = &mut $confirmed_htlcs_list;
2236 let mut matched_htlc = false;
2237 for (ref broadcast_htlc, ref broadcast_source) in confirmed_htlcs_iter {
2238 if broadcast_htlc.transaction_output_index.is_some() &&
2239 (Some(&**source) == *broadcast_source ||
2240 (broadcast_source.is_none() &&
2241 broadcast_htlc.payment_hash == htlc.payment_hash &&
2242 broadcast_htlc.amount_msat == htlc.amount_msat)) {
2243 matched_htlc = true;
2247 if matched_htlc { continue; }
2248 if $self.counterparty_fulfilled_htlcs.get(&SentHTLCId::from_source(source)).is_some() {
2251 $self.onchain_events_awaiting_threshold_conf.retain(|ref entry| {
2252 if entry.height != $commitment_tx_conf_height { return true; }
2254 OnchainEvent::HTLCUpdate { source: ref update_source, .. } => {
2255 *update_source != **source
2260 let entry = OnchainEventEntry {
2261 txid: $commitment_txid_confirmed,
2262 transaction: Some($commitment_tx_confirmed.clone()),
2263 height: $commitment_tx_conf_height,
2264 block_hash: Some(*$commitment_tx_conf_hash),
2265 event: OnchainEvent::HTLCUpdate {
2266 source: (**source).clone(),
2267 payment_hash: htlc.payment_hash.clone(),
2268 htlc_value_satoshis: Some(htlc.amount_msat / 1000),
2269 commitment_tx_output_idx: None,
2272 log_trace!($logger, "Failing HTLC with payment_hash {} from {} counterparty commitment tx due to broadcast of {} commitment transaction {}, waiting for confirmation (at height {})",
2273 &htlc.payment_hash, $commitment_tx, $commitment_tx_type,
2274 $commitment_txid_confirmed, entry.confirmation_threshold());
2275 $self.onchain_events_awaiting_threshold_conf.push(entry);
2281 if let Some(ref txid) = $self.current_counterparty_commitment_txid {
2282 check_htlc_fails!(txid, "current");
2284 if let Some(ref txid) = $self.prev_counterparty_commitment_txid {
2285 check_htlc_fails!(txid, "previous");
2290 // In the `test_invalid_funding_tx` test, we need a bogus script which matches the HTLC-Accepted
2291 // witness length match (ie is 136 bytes long). We generate one here which we also use in some
2292 // in-line tests later.
2295 pub fn deliberately_bogus_accepted_htlc_witness_program() -> Vec<u8> {
2296 use bitcoin::blockdata::opcodes;
2297 let mut ret = [opcodes::all::OP_NOP.to_u8(); 136];
2298 ret[131] = opcodes::all::OP_DROP.to_u8();
2299 ret[132] = opcodes::all::OP_DROP.to_u8();
2300 ret[133] = opcodes::all::OP_DROP.to_u8();
2301 ret[134] = opcodes::all::OP_DROP.to_u8();
2302 ret[135] = opcodes::OP_TRUE.to_u8();
2307 pub fn deliberately_bogus_accepted_htlc_witness() -> Vec<Vec<u8>> {
2308 vec![Vec::new(), Vec::new(), Vec::new(), Vec::new(), deliberately_bogus_accepted_htlc_witness_program().into()].into()
2311 impl<Signer: WriteableEcdsaChannelSigner> ChannelMonitorImpl<Signer> {
2312 /// Inserts a revocation secret into this channel monitor. Prunes old preimages if neither
2313 /// needed by holder commitment transactions HTCLs nor by counterparty ones. Unless we haven't already seen
2314 /// counterparty commitment transaction's secret, they are de facto pruned (we can use revocation key).
2315 fn provide_secret(&mut self, idx: u64, secret: [u8; 32]) -> Result<(), &'static str> {
2316 if let Err(()) = self.commitment_secrets.provide_secret(idx, secret) {
2317 return Err("Previous secret did not match new one");
2320 // Prune HTLCs from the previous counterparty commitment tx so we don't generate failure/fulfill
2321 // events for now-revoked/fulfilled HTLCs.
2322 if let Some(txid) = self.prev_counterparty_commitment_txid.take() {
2323 if self.current_counterparty_commitment_txid.unwrap() != txid {
2324 let cur_claimables = self.counterparty_claimable_outpoints.get(
2325 &self.current_counterparty_commitment_txid.unwrap()).unwrap();
2326 for (_, ref source_opt) in self.counterparty_claimable_outpoints.get(&txid).unwrap() {
2327 if let Some(source) = source_opt {
2328 if !cur_claimables.iter()
2329 .any(|(_, cur_source_opt)| cur_source_opt == source_opt)
2331 self.counterparty_fulfilled_htlcs.remove(&SentHTLCId::from_source(source));
2335 for &mut (_, ref mut source_opt) in self.counterparty_claimable_outpoints.get_mut(&txid).unwrap() {
2339 assert!(cfg!(fuzzing), "Commitment txids are unique outside of fuzzing, where hashes can collide");
2343 if !self.payment_preimages.is_empty() {
2344 let cur_holder_signed_commitment_tx = &self.current_holder_commitment_tx;
2345 let prev_holder_signed_commitment_tx = self.prev_holder_signed_commitment_tx.as_ref();
2346 let min_idx = self.get_min_seen_secret();
2347 let counterparty_hash_commitment_number = &mut self.counterparty_hash_commitment_number;
2349 self.payment_preimages.retain(|&k, _| {
2350 for &(ref htlc, _, _) in cur_holder_signed_commitment_tx.htlc_outputs.iter() {
2351 if k == htlc.payment_hash {
2355 if let Some(prev_holder_commitment_tx) = prev_holder_signed_commitment_tx {
2356 for &(ref htlc, _, _) in prev_holder_commitment_tx.htlc_outputs.iter() {
2357 if k == htlc.payment_hash {
2362 let contains = if let Some(cn) = counterparty_hash_commitment_number.get(&k) {
2369 counterparty_hash_commitment_number.remove(&k);
2378 pub(crate) fn provide_initial_counterparty_commitment_tx<L: Deref>(
2379 &mut self, txid: Txid, htlc_outputs: Vec<(HTLCOutputInCommitment, Option<Box<HTLCSource>>)>,
2380 commitment_number: u64, their_per_commitment_point: PublicKey, feerate_per_kw: u32,
2381 to_broadcaster_value: u64, to_countersignatory_value: u64, logger: &L
2383 where L::Target: Logger
2385 self.initial_counterparty_commitment_info = Some((their_per_commitment_point.clone(),
2386 feerate_per_kw, to_broadcaster_value, to_countersignatory_value));
2388 #[cfg(debug_assertions)] {
2389 let rebuilt_commitment_tx = self.initial_counterparty_commitment_tx().unwrap();
2390 debug_assert_eq!(rebuilt_commitment_tx.trust().txid(), txid);
2393 self.provide_latest_counterparty_commitment_tx(txid, htlc_outputs, commitment_number,
2394 their_per_commitment_point, logger);
2397 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 {
2398 // TODO: Encrypt the htlc_outputs data with the single-hash of the commitment transaction
2399 // so that a remote monitor doesn't learn anything unless there is a malicious close.
2400 // (only maybe, sadly we cant do the same for local info, as we need to be aware of
2402 for &(ref htlc, _) in &htlc_outputs {
2403 self.counterparty_hash_commitment_number.insert(htlc.payment_hash, commitment_number);
2406 log_trace!(logger, "Tracking new counterparty commitment transaction with txid {} at commitment number {} with {} HTLC outputs", txid, commitment_number, htlc_outputs.len());
2407 self.prev_counterparty_commitment_txid = self.current_counterparty_commitment_txid.take();
2408 self.current_counterparty_commitment_txid = Some(txid);
2409 self.counterparty_claimable_outpoints.insert(txid, htlc_outputs.clone());
2410 self.current_counterparty_commitment_number = commitment_number;
2411 //TODO: Merge this into the other per-counterparty-transaction output storage stuff
2412 match self.their_cur_per_commitment_points {
2413 Some(old_points) => {
2414 if old_points.0 == commitment_number + 1 {
2415 self.their_cur_per_commitment_points = Some((old_points.0, old_points.1, Some(their_per_commitment_point)));
2416 } else if old_points.0 == commitment_number + 2 {
2417 if let Some(old_second_point) = old_points.2 {
2418 self.their_cur_per_commitment_points = Some((old_points.0 - 1, old_second_point, Some(their_per_commitment_point)));
2420 self.their_cur_per_commitment_points = Some((commitment_number, their_per_commitment_point, None));
2423 self.their_cur_per_commitment_points = Some((commitment_number, their_per_commitment_point, None));
2427 self.their_cur_per_commitment_points = Some((commitment_number, their_per_commitment_point, None));
2430 let mut htlcs = Vec::with_capacity(htlc_outputs.len());
2431 for htlc in htlc_outputs {
2432 if htlc.0.transaction_output_index.is_some() {
2438 /// Informs this monitor of the latest holder (ie broadcastable) commitment transaction. The
2439 /// monitor watches for timeouts and may broadcast it if we approach such a timeout. Thus, it
2440 /// is important that any clones of this channel monitor (including remote clones) by kept
2441 /// up-to-date as our holder commitment transaction is updated.
2442 /// Panics if set_on_holder_tx_csv has never been called.
2443 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> {
2444 if htlc_outputs.iter().any(|(_, s, _)| s.is_some()) {
2445 // If we have non-dust HTLCs in htlc_outputs, ensure they match the HTLCs in the
2446 // `holder_commitment_tx`. In the future, we'll no longer provide the redundant data
2447 // and just pass in source data via `nondust_htlc_sources`.
2448 debug_assert_eq!(htlc_outputs.iter().filter(|(_, s, _)| s.is_some()).count(), holder_commitment_tx.trust().htlcs().len());
2449 for (a, b) in htlc_outputs.iter().filter(|(_, s, _)| s.is_some()).map(|(h, _, _)| h).zip(holder_commitment_tx.trust().htlcs().iter()) {
2450 debug_assert_eq!(a, b);
2452 debug_assert_eq!(htlc_outputs.iter().filter(|(_, s, _)| s.is_some()).count(), holder_commitment_tx.counterparty_htlc_sigs.len());
2453 for (a, b) in htlc_outputs.iter().filter_map(|(_, s, _)| s.as_ref()).zip(holder_commitment_tx.counterparty_htlc_sigs.iter()) {
2454 debug_assert_eq!(a, b);
2456 debug_assert!(nondust_htlc_sources.is_empty());
2458 // If we don't have any non-dust HTLCs in htlc_outputs, assume they were all passed via
2459 // `nondust_htlc_sources`, building up the final htlc_outputs by combining
2460 // `nondust_htlc_sources` and the `holder_commitment_tx`
2461 #[cfg(debug_assertions)] {
2463 for htlc in holder_commitment_tx.trust().htlcs().iter() {
2464 assert!(htlc.transaction_output_index.unwrap() as i32 > prev);
2465 prev = htlc.transaction_output_index.unwrap() as i32;
2468 debug_assert!(htlc_outputs.iter().all(|(htlc, _, _)| htlc.transaction_output_index.is_none()));
2469 debug_assert!(htlc_outputs.iter().all(|(_, sig_opt, _)| sig_opt.is_none()));
2470 debug_assert_eq!(holder_commitment_tx.trust().htlcs().len(), holder_commitment_tx.counterparty_htlc_sigs.len());
2472 let mut sources_iter = nondust_htlc_sources.into_iter();
2474 for (htlc, counterparty_sig) in holder_commitment_tx.trust().htlcs().iter()
2475 .zip(holder_commitment_tx.counterparty_htlc_sigs.iter())
2478 let source = sources_iter.next().expect("Non-dust HTLC sources didn't match commitment tx");
2479 #[cfg(debug_assertions)] {
2480 assert!(source.possibly_matches_output(htlc));
2482 htlc_outputs.push((htlc.clone(), Some(counterparty_sig.clone()), Some(source)));
2484 htlc_outputs.push((htlc.clone(), Some(counterparty_sig.clone()), None));
2487 debug_assert!(sources_iter.next().is_none());
2490 let trusted_tx = holder_commitment_tx.trust();
2491 let txid = trusted_tx.txid();
2492 let tx_keys = trusted_tx.keys();
2493 self.current_holder_commitment_number = trusted_tx.commitment_number();
2494 let mut new_holder_commitment_tx = HolderSignedTx {
2496 revocation_key: tx_keys.revocation_key,
2497 a_htlc_key: tx_keys.broadcaster_htlc_key,
2498 b_htlc_key: tx_keys.countersignatory_htlc_key,
2499 delayed_payment_key: tx_keys.broadcaster_delayed_payment_key,
2500 per_commitment_point: tx_keys.per_commitment_point,
2502 to_self_value_sat: holder_commitment_tx.to_broadcaster_value_sat(),
2503 feerate_per_kw: trusted_tx.feerate_per_kw(),
2505 self.onchain_tx_handler.provide_latest_holder_tx(holder_commitment_tx);
2506 mem::swap(&mut new_holder_commitment_tx, &mut self.current_holder_commitment_tx);
2507 self.prev_holder_signed_commitment_tx = Some(new_holder_commitment_tx);
2508 for (claimed_htlc_id, claimed_preimage) in claimed_htlcs {
2509 #[cfg(debug_assertions)] {
2510 let cur_counterparty_htlcs = self.counterparty_claimable_outpoints.get(
2511 &self.current_counterparty_commitment_txid.unwrap()).unwrap();
2512 assert!(cur_counterparty_htlcs.iter().any(|(_, source_opt)| {
2513 if let Some(source) = source_opt {
2514 SentHTLCId::from_source(source) == *claimed_htlc_id
2518 self.counterparty_fulfilled_htlcs.insert(*claimed_htlc_id, *claimed_preimage);
2520 if self.holder_tx_signed {
2521 return Err("Latest holder commitment signed has already been signed, update is rejected");
2526 /// Provides a payment_hash->payment_preimage mapping. Will be automatically pruned when all
2527 /// commitment_tx_infos which contain the payment hash have been revoked.
2528 fn provide_payment_preimage<B: Deref, F: Deref, L: Deref>(
2529 &mut self, payment_hash: &PaymentHash, payment_preimage: &PaymentPreimage, broadcaster: &B,
2530 fee_estimator: &LowerBoundedFeeEstimator<F>, logger: &L)
2531 where B::Target: BroadcasterInterface,
2532 F::Target: FeeEstimator,
2535 self.payment_preimages.insert(payment_hash.clone(), payment_preimage.clone());
2537 let confirmed_spend_txid = self.funding_spend_confirmed.or_else(|| {
2538 self.onchain_events_awaiting_threshold_conf.iter().find_map(|event| match event.event {
2539 OnchainEvent::FundingSpendConfirmation { .. } => Some(event.txid),
2543 let confirmed_spend_txid = if let Some(txid) = confirmed_spend_txid {
2549 // If the channel is force closed, try to claim the output from this preimage.
2550 // First check if a counterparty commitment transaction has been broadcasted:
2551 macro_rules! claim_htlcs {
2552 ($commitment_number: expr, $txid: expr) => {
2553 let (htlc_claim_reqs, _) = self.get_counterparty_output_claim_info($commitment_number, $txid, None);
2554 self.onchain_tx_handler.update_claims_view_from_requests(htlc_claim_reqs, self.best_block.height(), self.best_block.height(), broadcaster, fee_estimator, logger);
2557 if let Some(txid) = self.current_counterparty_commitment_txid {
2558 if txid == confirmed_spend_txid {
2559 if let Some(commitment_number) = self.counterparty_commitment_txn_on_chain.get(&txid) {
2560 claim_htlcs!(*commitment_number, txid);
2562 debug_assert!(false);
2563 log_error!(logger, "Detected counterparty commitment tx on-chain without tracking commitment number");
2568 if let Some(txid) = self.prev_counterparty_commitment_txid {
2569 if txid == confirmed_spend_txid {
2570 if let Some(commitment_number) = self.counterparty_commitment_txn_on_chain.get(&txid) {
2571 claim_htlcs!(*commitment_number, txid);
2573 debug_assert!(false);
2574 log_error!(logger, "Detected counterparty commitment tx on-chain without tracking commitment number");
2580 // Then if a holder commitment transaction has been seen on-chain, broadcast transactions
2581 // claiming the HTLC output from each of the holder commitment transactions.
2582 // Note that we can't just use `self.holder_tx_signed`, because that only covers the case where
2583 // *we* sign a holder commitment transaction, not when e.g. a watchtower broadcasts one of our
2584 // holder commitment transactions.
2585 if self.broadcasted_holder_revokable_script.is_some() {
2586 let holder_commitment_tx = if self.current_holder_commitment_tx.txid == confirmed_spend_txid {
2587 Some(&self.current_holder_commitment_tx)
2588 } else if let Some(prev_holder_commitment_tx) = &self.prev_holder_signed_commitment_tx {
2589 if prev_holder_commitment_tx.txid == confirmed_spend_txid {
2590 Some(prev_holder_commitment_tx)
2597 if let Some(holder_commitment_tx) = holder_commitment_tx {
2598 // Assume that the broadcasted commitment transaction confirmed in the current best
2599 // block. Even if not, its a reasonable metric for the bump criteria on the HTLC
2601 let (claim_reqs, _) = self.get_broadcasted_holder_claims(&holder_commitment_tx, self.best_block.height());
2602 self.onchain_tx_handler.update_claims_view_from_requests(claim_reqs, self.best_block.height(), self.best_block.height(), broadcaster, fee_estimator, logger);
2607 pub(crate) fn broadcast_latest_holder_commitment_txn<B: Deref, L: Deref>(&mut self, broadcaster: &B, logger: &L)
2608 where B::Target: BroadcasterInterface,
2611 let commit_txs = self.get_latest_holder_commitment_txn(logger);
2612 let mut txs = vec![];
2613 for tx in commit_txs.iter() {
2614 log_info!(logger, "Broadcasting local {}", log_tx!(tx));
2617 broadcaster.broadcast_transactions(&txs);
2618 self.pending_monitor_events.push(MonitorEvent::HolderForceClosed(self.funding_info.0));
2621 pub fn update_monitor<B: Deref, F: Deref, L: Deref>(&mut self, updates: &ChannelMonitorUpdate, broadcaster: &B, fee_estimator: &F, logger: &L) -> Result<(), ()>
2622 where B::Target: BroadcasterInterface,
2623 F::Target: FeeEstimator,
2626 if self.latest_update_id == CLOSED_CHANNEL_UPDATE_ID && updates.update_id == CLOSED_CHANNEL_UPDATE_ID {
2627 log_info!(logger, "Applying post-force-closed update to monitor {} with {} change(s).",
2628 log_funding_info!(self), updates.updates.len());
2629 } else if updates.update_id == CLOSED_CHANNEL_UPDATE_ID {
2630 log_info!(logger, "Applying force close update to monitor {} with {} change(s).",
2631 log_funding_info!(self), updates.updates.len());
2633 log_info!(logger, "Applying update to monitor {}, bringing update_id from {} to {} with {} change(s).",
2634 log_funding_info!(self), self.latest_update_id, updates.update_id, updates.updates.len());
2636 // ChannelMonitor updates may be applied after force close if we receive a preimage for a
2637 // broadcasted commitment transaction HTLC output that we'd like to claim on-chain. If this
2638 // is the case, we no longer have guaranteed access to the monitor's update ID, so we use a
2639 // sentinel value instead.
2641 // The `ChannelManager` may also queue redundant `ChannelForceClosed` updates if it still
2642 // thinks the channel needs to have its commitment transaction broadcast, so we'll allow
2644 if updates.update_id == CLOSED_CHANNEL_UPDATE_ID {
2645 assert_eq!(updates.updates.len(), 1);
2646 match updates.updates[0] {
2647 ChannelMonitorUpdateStep::ChannelForceClosed { .. } => {},
2648 // We should have already seen a `ChannelForceClosed` update if we're trying to
2649 // provide a preimage at this point.
2650 ChannelMonitorUpdateStep::PaymentPreimage { .. } =>
2651 debug_assert_eq!(self.latest_update_id, CLOSED_CHANNEL_UPDATE_ID),
2653 log_error!(logger, "Attempted to apply post-force-close ChannelMonitorUpdate of type {}", updates.updates[0].variant_name());
2654 panic!("Attempted to apply post-force-close ChannelMonitorUpdate that wasn't providing a payment preimage");
2657 } else if self.latest_update_id + 1 != updates.update_id {
2658 panic!("Attempted to apply ChannelMonitorUpdates out of order, check the update_id before passing an update to update_monitor!");
2660 let mut ret = Ok(());
2661 let bounded_fee_estimator = LowerBoundedFeeEstimator::new(&**fee_estimator);
2662 for update in updates.updates.iter() {
2664 ChannelMonitorUpdateStep::LatestHolderCommitmentTXInfo { commitment_tx, htlc_outputs, claimed_htlcs, nondust_htlc_sources } => {
2665 log_trace!(logger, "Updating ChannelMonitor with latest holder commitment transaction info");
2666 if self.lockdown_from_offchain { panic!(); }
2667 if let Err(e) = self.provide_latest_holder_commitment_tx(commitment_tx.clone(), htlc_outputs.clone(), &claimed_htlcs, nondust_htlc_sources.clone()) {
2668 log_error!(logger, "Providing latest holder commitment transaction failed/was refused:");
2669 log_error!(logger, " {}", e);
2673 ChannelMonitorUpdateStep::LatestCounterpartyCommitmentTXInfo { commitment_txid, htlc_outputs, commitment_number, their_per_commitment_point, .. } => {
2674 log_trace!(logger, "Updating ChannelMonitor with latest counterparty commitment transaction info");
2675 self.provide_latest_counterparty_commitment_tx(*commitment_txid, htlc_outputs.clone(), *commitment_number, *their_per_commitment_point, logger)
2677 ChannelMonitorUpdateStep::PaymentPreimage { payment_preimage } => {
2678 log_trace!(logger, "Updating ChannelMonitor with payment preimage");
2679 self.provide_payment_preimage(&PaymentHash(Sha256::hash(&payment_preimage.0[..]).to_byte_array()), &payment_preimage, broadcaster, &bounded_fee_estimator, logger)
2681 ChannelMonitorUpdateStep::CommitmentSecret { idx, secret } => {
2682 log_trace!(logger, "Updating ChannelMonitor with commitment secret");
2683 if let Err(e) = self.provide_secret(*idx, *secret) {
2684 debug_assert!(false, "Latest counterparty commitment secret was invalid");
2685 log_error!(logger, "Providing latest counterparty commitment secret failed/was refused:");
2686 log_error!(logger, " {}", e);
2690 ChannelMonitorUpdateStep::ChannelForceClosed { should_broadcast } => {
2691 log_trace!(logger, "Updating ChannelMonitor: channel force closed, should broadcast: {}", should_broadcast);
2692 self.lockdown_from_offchain = true;
2693 if *should_broadcast {
2694 // There's no need to broadcast our commitment transaction if we've seen one
2695 // confirmed (even with 1 confirmation) as it'll be rejected as
2696 // duplicate/conflicting.
2697 let detected_funding_spend = self.funding_spend_confirmed.is_some() ||
2698 self.onchain_events_awaiting_threshold_conf.iter().find(|event| match event.event {
2699 OnchainEvent::FundingSpendConfirmation { .. } => true,
2702 if detected_funding_spend {
2703 log_trace!(logger, "Avoiding commitment broadcast, already detected confirmed spend onchain");
2706 self.broadcast_latest_holder_commitment_txn(broadcaster, logger);
2707 // If the channel supports anchor outputs, we'll need to emit an external
2708 // event to be consumed such that a child transaction is broadcast with a
2709 // high enough feerate for the parent commitment transaction to confirm.
2710 if self.onchain_tx_handler.channel_type_features().supports_anchors_zero_fee_htlc_tx() {
2711 let funding_output = HolderFundingOutput::build(
2712 self.funding_redeemscript.clone(), self.channel_value_satoshis,
2713 self.onchain_tx_handler.channel_type_features().clone(),
2715 let best_block_height = self.best_block.height();
2716 let commitment_package = PackageTemplate::build_package(
2717 self.funding_info.0.txid.clone(), self.funding_info.0.index as u32,
2718 PackageSolvingData::HolderFundingOutput(funding_output),
2719 best_block_height, best_block_height
2721 self.onchain_tx_handler.update_claims_view_from_requests(
2722 vec![commitment_package], best_block_height, best_block_height,
2723 broadcaster, &bounded_fee_estimator, logger,
2726 } else if !self.holder_tx_signed {
2727 log_error!(logger, "WARNING: You have a potentially-unsafe holder commitment transaction available to broadcast");
2728 log_error!(logger, " in channel monitor for channel {}!", &self.funding_info.0.to_channel_id());
2729 log_error!(logger, " Read the docs for ChannelMonitor::get_latest_holder_commitment_txn and take manual action!");
2731 // If we generated a MonitorEvent::HolderForceClosed, the ChannelManager
2732 // will still give us a ChannelForceClosed event with !should_broadcast, but we
2733 // shouldn't print the scary warning above.
2734 log_info!(logger, "Channel off-chain state closed after we broadcasted our latest commitment transaction.");
2737 ChannelMonitorUpdateStep::ShutdownScript { scriptpubkey } => {
2738 log_trace!(logger, "Updating ChannelMonitor with shutdown script");
2739 if let Some(shutdown_script) = self.shutdown_script.replace(scriptpubkey.clone()) {
2740 panic!("Attempted to replace shutdown script {} with {}", shutdown_script, scriptpubkey);
2746 #[cfg(debug_assertions)] {
2747 self.counterparty_commitment_txs_from_update(updates);
2750 // If the updates succeeded and we were in an already closed channel state, then there's no
2751 // need to refuse any updates we expect to receive afer seeing a confirmed commitment.
2752 if ret.is_ok() && updates.update_id == CLOSED_CHANNEL_UPDATE_ID && self.latest_update_id == updates.update_id {
2756 self.latest_update_id = updates.update_id;
2758 // Refuse updates after we've detected a spend onchain, but only if we haven't processed a
2759 // force closed monitor update yet.
2760 if ret.is_ok() && self.funding_spend_seen && self.latest_update_id != CLOSED_CHANNEL_UPDATE_ID {
2761 log_error!(logger, "Refusing Channel Monitor Update as counterparty attempted to update commitment after funding was spent");
2766 pub fn get_latest_update_id(&self) -> u64 {
2767 self.latest_update_id
2770 pub fn get_funding_txo(&self) -> &(OutPoint, ScriptBuf) {
2774 pub fn get_outputs_to_watch(&self) -> &HashMap<Txid, Vec<(u32, ScriptBuf)>> {
2775 // If we've detected a counterparty commitment tx on chain, we must include it in the set
2776 // of outputs to watch for spends of, otherwise we're likely to lose user funds. Because
2777 // its trivial to do, double-check that here.
2778 for (txid, _) in self.counterparty_commitment_txn_on_chain.iter() {
2779 self.outputs_to_watch.get(txid).expect("Counterparty commitment txn which have been broadcast should have outputs registered");
2781 &self.outputs_to_watch
2784 pub fn get_and_clear_pending_monitor_events(&mut self) -> Vec<MonitorEvent> {
2785 let mut ret = Vec::new();
2786 mem::swap(&mut ret, &mut self.pending_monitor_events);
2790 /// Gets the set of events that are repeated regularly (e.g. those which RBF bump
2791 /// transactions). We're okay if we lose these on restart as they'll be regenerated for us at
2792 /// some regular interval via [`ChannelMonitor::rebroadcast_pending_claims`].
2793 pub(super) fn get_repeated_events(&mut self) -> Vec<Event> {
2794 let pending_claim_events = self.onchain_tx_handler.get_and_clear_pending_claim_events();
2795 let mut ret = Vec::with_capacity(pending_claim_events.len());
2796 for (claim_id, claim_event) in pending_claim_events {
2798 ClaimEvent::BumpCommitment {
2799 package_target_feerate_sat_per_1000_weight, commitment_tx, anchor_output_idx,
2801 let commitment_txid = commitment_tx.txid();
2802 debug_assert_eq!(self.current_holder_commitment_tx.txid, commitment_txid);
2803 let pending_htlcs = self.current_holder_commitment_tx.non_dust_htlcs();
2804 let commitment_tx_fee_satoshis = self.channel_value_satoshis -
2805 commitment_tx.output.iter().fold(0u64, |sum, output| sum + output.value);
2806 ret.push(Event::BumpTransaction(BumpTransactionEvent::ChannelClose {
2808 package_target_feerate_sat_per_1000_weight,
2810 commitment_tx_fee_satoshis,
2811 anchor_descriptor: AnchorDescriptor {
2812 channel_derivation_parameters: ChannelDerivationParameters {
2813 keys_id: self.channel_keys_id,
2814 value_satoshis: self.channel_value_satoshis,
2815 transaction_parameters: self.onchain_tx_handler.channel_transaction_parameters.clone(),
2817 outpoint: BitcoinOutPoint {
2818 txid: commitment_txid,
2819 vout: anchor_output_idx,
2825 ClaimEvent::BumpHTLC {
2826 target_feerate_sat_per_1000_weight, htlcs, tx_lock_time,
2828 let mut htlc_descriptors = Vec::with_capacity(htlcs.len());
2830 htlc_descriptors.push(HTLCDescriptor {
2831 channel_derivation_parameters: ChannelDerivationParameters {
2832 keys_id: self.channel_keys_id,
2833 value_satoshis: self.channel_value_satoshis,
2834 transaction_parameters: self.onchain_tx_handler.channel_transaction_parameters.clone(),
2836 commitment_txid: htlc.commitment_txid,
2837 per_commitment_number: htlc.per_commitment_number,
2838 per_commitment_point: self.onchain_tx_handler.signer.get_per_commitment_point(
2839 htlc.per_commitment_number, &self.onchain_tx_handler.secp_ctx,
2843 preimage: htlc.preimage,
2844 counterparty_sig: htlc.counterparty_sig,
2847 ret.push(Event::BumpTransaction(BumpTransactionEvent::HTLCResolution {
2849 target_feerate_sat_per_1000_weight,
2859 pub(crate) fn initial_counterparty_commitment_tx(&mut self) -> Option<CommitmentTransaction> {
2860 let (their_per_commitment_point, feerate_per_kw, to_broadcaster_value,
2861 to_countersignatory_value) = self.initial_counterparty_commitment_info?;
2862 let htlc_outputs = vec![];
2864 let commitment_tx = self.build_counterparty_commitment_tx(INITIAL_COMMITMENT_NUMBER,
2865 &their_per_commitment_point, to_broadcaster_value, to_countersignatory_value,
2866 feerate_per_kw, htlc_outputs);
2870 fn build_counterparty_commitment_tx(
2871 &self, commitment_number: u64, their_per_commitment_point: &PublicKey,
2872 to_broadcaster_value: u64, to_countersignatory_value: u64, feerate_per_kw: u32,
2873 mut nondust_htlcs: Vec<(HTLCOutputInCommitment, Option<Box<HTLCSource>>)>
2874 ) -> CommitmentTransaction {
2875 let broadcaster_keys = &self.onchain_tx_handler.channel_transaction_parameters
2876 .counterparty_parameters.as_ref().unwrap().pubkeys;
2877 let countersignatory_keys =
2878 &self.onchain_tx_handler.channel_transaction_parameters.holder_pubkeys;
2880 let broadcaster_funding_key = broadcaster_keys.funding_pubkey;
2881 let countersignatory_funding_key = countersignatory_keys.funding_pubkey;
2882 let keys = TxCreationKeys::from_channel_static_keys(&their_per_commitment_point,
2883 &broadcaster_keys, &countersignatory_keys, &self.onchain_tx_handler.secp_ctx);
2884 let channel_parameters =
2885 &self.onchain_tx_handler.channel_transaction_parameters.as_counterparty_broadcastable();
2887 CommitmentTransaction::new_with_auxiliary_htlc_data(commitment_number,
2888 to_broadcaster_value, to_countersignatory_value, broadcaster_funding_key,
2889 countersignatory_funding_key, keys, feerate_per_kw, &mut nondust_htlcs,
2893 pub(crate) fn counterparty_commitment_txs_from_update(&self, update: &ChannelMonitorUpdate) -> Vec<CommitmentTransaction> {
2894 update.updates.iter().filter_map(|update| {
2896 &ChannelMonitorUpdateStep::LatestCounterpartyCommitmentTXInfo { commitment_txid,
2897 ref htlc_outputs, commitment_number, their_per_commitment_point,
2898 feerate_per_kw: Some(feerate_per_kw),
2899 to_broadcaster_value_sat: Some(to_broadcaster_value),
2900 to_countersignatory_value_sat: Some(to_countersignatory_value) } => {
2902 let nondust_htlcs = htlc_outputs.iter().filter_map(|(htlc, _)| {
2903 htlc.transaction_output_index.map(|_| (htlc.clone(), None))
2904 }).collect::<Vec<_>>();
2906 let commitment_tx = self.build_counterparty_commitment_tx(commitment_number,
2907 &their_per_commitment_point, to_broadcaster_value,
2908 to_countersignatory_value, feerate_per_kw, nondust_htlcs);
2910 debug_assert_eq!(commitment_tx.trust().txid(), commitment_txid);
2919 pub(crate) fn sign_to_local_justice_tx(
2920 &self, mut justice_tx: Transaction, input_idx: usize, value: u64, commitment_number: u64
2921 ) -> Result<Transaction, ()> {
2922 let secret = self.get_secret(commitment_number).ok_or(())?;
2923 let per_commitment_key = SecretKey::from_slice(&secret).map_err(|_| ())?;
2924 let their_per_commitment_point = PublicKey::from_secret_key(
2925 &self.onchain_tx_handler.secp_ctx, &per_commitment_key);
2927 let revocation_pubkey = RevocationKey::from_basepoint(&self.onchain_tx_handler.secp_ctx,
2928 &self.holder_revocation_basepoint, &their_per_commitment_point);
2929 let delayed_key = DelayedPaymentKey::from_basepoint(&self.onchain_tx_handler.secp_ctx,
2930 &self.counterparty_commitment_params.counterparty_delayed_payment_base_key, &their_per_commitment_point);
2931 let revokeable_redeemscript = chan_utils::get_revokeable_redeemscript(&revocation_pubkey,
2932 self.counterparty_commitment_params.on_counterparty_tx_csv, &delayed_key);
2934 let sig = self.onchain_tx_handler.signer.sign_justice_revoked_output(
2935 &justice_tx, input_idx, value, &per_commitment_key, &self.onchain_tx_handler.secp_ctx)?;
2936 justice_tx.input[input_idx].witness.push_bitcoin_signature(&sig.serialize_der(), EcdsaSighashType::All);
2937 justice_tx.input[input_idx].witness.push(&[1u8]);
2938 justice_tx.input[input_idx].witness.push(revokeable_redeemscript.as_bytes());
2942 /// Can only fail if idx is < get_min_seen_secret
2943 fn get_secret(&self, idx: u64) -> Option<[u8; 32]> {
2944 self.commitment_secrets.get_secret(idx)
2947 pub(crate) fn get_min_seen_secret(&self) -> u64 {
2948 self.commitment_secrets.get_min_seen_secret()
2951 pub(crate) fn get_cur_counterparty_commitment_number(&self) -> u64 {
2952 self.current_counterparty_commitment_number
2955 pub(crate) fn get_cur_holder_commitment_number(&self) -> u64 {
2956 self.current_holder_commitment_number
2959 /// Attempts to claim a counterparty commitment transaction's outputs using the revocation key and
2960 /// data in counterparty_claimable_outpoints. Will directly claim any HTLC outputs which expire at a
2961 /// height > height + CLTV_SHARED_CLAIM_BUFFER. In any case, will install monitoring for
2962 /// HTLC-Success/HTLC-Timeout transactions.
2964 /// Returns packages to claim the revoked output(s), as well as additional outputs to watch and
2965 /// general information about the output that is to the counterparty in the commitment
2967 fn check_spend_counterparty_transaction<L: Deref>(&mut self, tx: &Transaction, height: u32, block_hash: &BlockHash, logger: &L)
2968 -> (Vec<PackageTemplate>, TransactionOutputs, CommitmentTxCounterpartyOutputInfo)
2969 where L::Target: Logger {
2970 // Most secp and related errors trying to create keys means we have no hope of constructing
2971 // a spend transaction...so we return no transactions to broadcast
2972 let mut claimable_outpoints = Vec::new();
2973 let mut watch_outputs = Vec::new();
2974 let mut to_counterparty_output_info = None;
2976 let commitment_txid = tx.txid(); //TODO: This is gonna be a performance bottleneck for watchtowers!
2977 let per_commitment_option = self.counterparty_claimable_outpoints.get(&commitment_txid);
2979 macro_rules! ignore_error {
2980 ( $thing : expr ) => {
2983 Err(_) => return (claimable_outpoints, (commitment_txid, watch_outputs), to_counterparty_output_info)
2988 let commitment_number = 0xffffffffffff - ((((tx.input[0].sequence.0 as u64 & 0xffffff) << 3*8) | (tx.lock_time.to_consensus_u32() as u64 & 0xffffff)) ^ self.commitment_transaction_number_obscure_factor);
2989 if commitment_number >= self.get_min_seen_secret() {
2990 let secret = self.get_secret(commitment_number).unwrap();
2991 let per_commitment_key = ignore_error!(SecretKey::from_slice(&secret));
2992 let per_commitment_point = PublicKey::from_secret_key(&self.onchain_tx_handler.secp_ctx, &per_commitment_key);
2993 let revocation_pubkey = RevocationKey::from_basepoint(&self.onchain_tx_handler.secp_ctx, &self.holder_revocation_basepoint, &per_commitment_point,);
2994 let delayed_key = DelayedPaymentKey::from_basepoint(&self.onchain_tx_handler.secp_ctx, &self.counterparty_commitment_params.counterparty_delayed_payment_base_key, &PublicKey::from_secret_key(&self.onchain_tx_handler.secp_ctx, &per_commitment_key));
2996 let revokeable_redeemscript = chan_utils::get_revokeable_redeemscript(&revocation_pubkey, self.counterparty_commitment_params.on_counterparty_tx_csv, &delayed_key);
2997 let revokeable_p2wsh = revokeable_redeemscript.to_v0_p2wsh();
2999 // First, process non-htlc outputs (to_holder & to_counterparty)
3000 for (idx, outp) in tx.output.iter().enumerate() {
3001 if outp.script_pubkey == revokeable_p2wsh {
3002 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());
3003 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);
3004 claimable_outpoints.push(justice_package);
3005 to_counterparty_output_info =
3006 Some((idx.try_into().expect("Txn can't have more than 2^32 outputs"), outp.value));
3010 // Then, try to find revoked htlc outputs
3011 if let Some(ref per_commitment_data) = per_commitment_option {
3012 for (_, &(ref htlc, _)) in per_commitment_data.iter().enumerate() {
3013 if let Some(transaction_output_index) = htlc.transaction_output_index {
3014 if transaction_output_index as usize >= tx.output.len() ||
3015 tx.output[transaction_output_index as usize].value != htlc.amount_msat / 1000 {
3016 // per_commitment_data is corrupt or our commitment signing key leaked!
3017 return (claimable_outpoints, (commitment_txid, watch_outputs),
3018 to_counterparty_output_info);
3020 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);
3021 let justice_package = PackageTemplate::build_package(commitment_txid, transaction_output_index, PackageSolvingData::RevokedHTLCOutput(revk_htlc_outp), htlc.cltv_expiry, height);
3022 claimable_outpoints.push(justice_package);
3027 // Last, track onchain revoked commitment transaction and fail backward outgoing HTLCs as payment path is broken
3028 if !claimable_outpoints.is_empty() || per_commitment_option.is_some() { // ie we're confident this is actually ours
3029 // We're definitely a counterparty commitment transaction!
3030 log_error!(logger, "Got broadcast of revoked counterparty commitment transaction, going to generate general spend tx with {} inputs", claimable_outpoints.len());
3031 for (idx, outp) in tx.output.iter().enumerate() {
3032 watch_outputs.push((idx as u32, outp.clone()));
3034 self.counterparty_commitment_txn_on_chain.insert(commitment_txid, commitment_number);
3036 if let Some(per_commitment_data) = per_commitment_option {
3037 fail_unbroadcast_htlcs!(self, "revoked_counterparty", commitment_txid, tx, height,
3038 block_hash, per_commitment_data.iter().map(|(htlc, htlc_source)|
3039 (htlc, htlc_source.as_ref().map(|htlc_source| htlc_source.as_ref()))
3042 debug_assert!(false, "We should have per-commitment option for any recognized old commitment txn");
3043 fail_unbroadcast_htlcs!(self, "revoked counterparty", commitment_txid, tx, height,
3044 block_hash, [].iter().map(|reference| *reference), logger);
3047 } else if let Some(per_commitment_data) = per_commitment_option {
3048 // While this isn't useful yet, there is a potential race where if a counterparty
3049 // revokes a state at the same time as the commitment transaction for that state is
3050 // confirmed, and the watchtower receives the block before the user, the user could
3051 // upload a new ChannelMonitor with the revocation secret but the watchtower has
3052 // already processed the block, resulting in the counterparty_commitment_txn_on_chain entry
3053 // not being generated by the above conditional. Thus, to be safe, we go ahead and
3055 for (idx, outp) in tx.output.iter().enumerate() {
3056 watch_outputs.push((idx as u32, outp.clone()));
3058 self.counterparty_commitment_txn_on_chain.insert(commitment_txid, commitment_number);
3060 log_info!(logger, "Got broadcast of non-revoked counterparty commitment transaction {}", commitment_txid);
3061 fail_unbroadcast_htlcs!(self, "counterparty", commitment_txid, tx, height, block_hash,
3062 per_commitment_data.iter().map(|(htlc, htlc_source)|
3063 (htlc, htlc_source.as_ref().map(|htlc_source| htlc_source.as_ref()))
3066 let (htlc_claim_reqs, counterparty_output_info) =
3067 self.get_counterparty_output_claim_info(commitment_number, commitment_txid, Some(tx));
3068 to_counterparty_output_info = counterparty_output_info;
3069 for req in htlc_claim_reqs {
3070 claimable_outpoints.push(req);
3074 (claimable_outpoints, (commitment_txid, watch_outputs), to_counterparty_output_info)
3077 /// Returns the HTLC claim package templates and the counterparty output info
3078 fn get_counterparty_output_claim_info(&self, commitment_number: u64, commitment_txid: Txid, tx: Option<&Transaction>)
3079 -> (Vec<PackageTemplate>, CommitmentTxCounterpartyOutputInfo) {
3080 let mut claimable_outpoints = Vec::new();
3081 let mut to_counterparty_output_info: CommitmentTxCounterpartyOutputInfo = None;
3083 let htlc_outputs = match self.counterparty_claimable_outpoints.get(&commitment_txid) {
3084 Some(outputs) => outputs,
3085 None => return (claimable_outpoints, to_counterparty_output_info),
3087 let per_commitment_points = match self.their_cur_per_commitment_points {
3088 Some(points) => points,
3089 None => return (claimable_outpoints, to_counterparty_output_info),
3092 let per_commitment_point =
3093 // If the counterparty commitment tx is the latest valid state, use their latest
3094 // per-commitment point
3095 if per_commitment_points.0 == commitment_number { &per_commitment_points.1 }
3096 else if let Some(point) = per_commitment_points.2.as_ref() {
3097 // If counterparty commitment tx is the state previous to the latest valid state, use
3098 // their previous per-commitment point (non-atomicity of revocation means it's valid for
3099 // them to temporarily have two valid commitment txns from our viewpoint)
3100 if per_commitment_points.0 == commitment_number + 1 {
3102 } else { return (claimable_outpoints, to_counterparty_output_info); }
3103 } else { return (claimable_outpoints, to_counterparty_output_info); };
3105 if let Some(transaction) = tx {
3106 let revocation_pubkey = RevocationKey::from_basepoint(
3107 &self.onchain_tx_handler.secp_ctx, &self.holder_revocation_basepoint, &per_commitment_point);
3109 let delayed_key = DelayedPaymentKey::from_basepoint(&self.onchain_tx_handler.secp_ctx, &self.counterparty_commitment_params.counterparty_delayed_payment_base_key, &per_commitment_point);
3111 let revokeable_p2wsh = chan_utils::get_revokeable_redeemscript(&revocation_pubkey,
3112 self.counterparty_commitment_params.on_counterparty_tx_csv,
3113 &delayed_key).to_v0_p2wsh();
3114 for (idx, outp) in transaction.output.iter().enumerate() {
3115 if outp.script_pubkey == revokeable_p2wsh {
3116 to_counterparty_output_info =
3117 Some((idx.try_into().expect("Can't have > 2^32 outputs"), outp.value));
3122 for (_, &(ref htlc, _)) in htlc_outputs.iter().enumerate() {
3123 if let Some(transaction_output_index) = htlc.transaction_output_index {
3124 if let Some(transaction) = tx {
3125 if transaction_output_index as usize >= transaction.output.len() ||
3126 transaction.output[transaction_output_index as usize].value != htlc.amount_msat / 1000 {
3127 // per_commitment_data is corrupt or our commitment signing key leaked!
3128 return (claimable_outpoints, to_counterparty_output_info);
3131 let preimage = if htlc.offered { if let Some(p) = self.payment_preimages.get(&htlc.payment_hash) { Some(*p) } else { None } } else { None };
3132 if preimage.is_some() || !htlc.offered {
3133 let counterparty_htlc_outp = if htlc.offered {
3134 PackageSolvingData::CounterpartyOfferedHTLCOutput(
3135 CounterpartyOfferedHTLCOutput::build(*per_commitment_point,
3136 self.counterparty_commitment_params.counterparty_delayed_payment_base_key,
3137 self.counterparty_commitment_params.counterparty_htlc_base_key,
3138 preimage.unwrap(), htlc.clone(), self.onchain_tx_handler.channel_type_features().clone()))
3140 PackageSolvingData::CounterpartyReceivedHTLCOutput(
3141 CounterpartyReceivedHTLCOutput::build(*per_commitment_point,
3142 self.counterparty_commitment_params.counterparty_delayed_payment_base_key,
3143 self.counterparty_commitment_params.counterparty_htlc_base_key,
3144 htlc.clone(), self.onchain_tx_handler.channel_type_features().clone()))
3146 let counterparty_package = PackageTemplate::build_package(commitment_txid, transaction_output_index, counterparty_htlc_outp, htlc.cltv_expiry, 0);
3147 claimable_outpoints.push(counterparty_package);
3152 (claimable_outpoints, to_counterparty_output_info)
3155 /// Attempts to claim a counterparty HTLC-Success/HTLC-Timeout's outputs using the revocation key
3156 fn check_spend_counterparty_htlc<L: Deref>(
3157 &mut self, tx: &Transaction, commitment_number: u64, commitment_txid: &Txid, height: u32, logger: &L
3158 ) -> (Vec<PackageTemplate>, Option<TransactionOutputs>) where L::Target: Logger {
3159 let secret = if let Some(secret) = self.get_secret(commitment_number) { secret } else { return (Vec::new(), None); };
3160 let per_commitment_key = match SecretKey::from_slice(&secret) {
3162 Err(_) => return (Vec::new(), None)
3164 let per_commitment_point = PublicKey::from_secret_key(&self.onchain_tx_handler.secp_ctx, &per_commitment_key);
3166 let htlc_txid = tx.txid();
3167 let mut claimable_outpoints = vec![];
3168 let mut outputs_to_watch = None;
3169 // Previously, we would only claim HTLCs from revoked HTLC transactions if they had 1 input
3170 // with a witness of 5 elements and 1 output. This wasn't enough for anchor outputs, as the
3171 // counterparty can now aggregate multiple HTLCs into a single transaction thanks to
3172 // `SIGHASH_SINGLE` remote signatures, leading us to not claim any HTLCs upon seeing a
3173 // confirmed revoked HTLC transaction (for more details, see
3174 // https://lists.linuxfoundation.org/pipermail/lightning-dev/2022-April/003561.html).
3176 // We make sure we're not vulnerable to this case by checking all inputs of the transaction,
3177 // and claim those which spend the commitment transaction, have a witness of 5 elements, and
3178 // have a corresponding output at the same index within the transaction.
3179 for (idx, input) in tx.input.iter().enumerate() {
3180 if input.previous_output.txid == *commitment_txid && input.witness.len() == 5 && tx.output.get(idx).is_some() {
3181 log_error!(logger, "Got broadcast of revoked counterparty HTLC transaction, spending {}:{}", htlc_txid, idx);
3182 let revk_outp = RevokedOutput::build(
3183 per_commitment_point, self.counterparty_commitment_params.counterparty_delayed_payment_base_key,
3184 self.counterparty_commitment_params.counterparty_htlc_base_key, per_commitment_key,
3185 tx.output[idx].value, self.counterparty_commitment_params.on_counterparty_tx_csv,
3188 let justice_package = PackageTemplate::build_package(
3189 htlc_txid, idx as u32, PackageSolvingData::RevokedOutput(revk_outp),
3190 height + self.counterparty_commitment_params.on_counterparty_tx_csv as u32, height
3192 claimable_outpoints.push(justice_package);
3193 if outputs_to_watch.is_none() {
3194 outputs_to_watch = Some((htlc_txid, vec![]));
3196 outputs_to_watch.as_mut().unwrap().1.push((idx as u32, tx.output[idx].clone()));
3199 (claimable_outpoints, outputs_to_watch)
3202 // Returns (1) `PackageTemplate`s that can be given to the OnchainTxHandler, so that the handler can
3203 // broadcast transactions claiming holder HTLC commitment outputs and (2) a holder revokable
3204 // script so we can detect whether a holder transaction has been seen on-chain.
3205 fn get_broadcasted_holder_claims(&self, holder_tx: &HolderSignedTx, conf_height: u32) -> (Vec<PackageTemplate>, Option<(ScriptBuf, PublicKey, RevocationKey)>) {
3206 let mut claim_requests = Vec::with_capacity(holder_tx.htlc_outputs.len());
3208 let redeemscript = chan_utils::get_revokeable_redeemscript(&holder_tx.revocation_key, self.on_holder_tx_csv, &holder_tx.delayed_payment_key);
3209 let broadcasted_holder_revokable_script = Some((redeemscript.to_v0_p2wsh(), holder_tx.per_commitment_point.clone(), holder_tx.revocation_key.clone()));
3211 for &(ref htlc, _, _) in holder_tx.htlc_outputs.iter() {
3212 if let Some(transaction_output_index) = htlc.transaction_output_index {
3213 let htlc_output = if htlc.offered {
3214 let htlc_output = HolderHTLCOutput::build_offered(
3215 htlc.amount_msat, htlc.cltv_expiry, self.onchain_tx_handler.channel_type_features().clone()
3219 let payment_preimage = if let Some(preimage) = self.payment_preimages.get(&htlc.payment_hash) {
3222 // We can't build an HTLC-Success transaction without the preimage
3225 let htlc_output = HolderHTLCOutput::build_accepted(
3226 payment_preimage, htlc.amount_msat, self.onchain_tx_handler.channel_type_features().clone()
3230 let htlc_package = PackageTemplate::build_package(
3231 holder_tx.txid, transaction_output_index,
3232 PackageSolvingData::HolderHTLCOutput(htlc_output),
3233 htlc.cltv_expiry, conf_height
3235 claim_requests.push(htlc_package);
3239 (claim_requests, broadcasted_holder_revokable_script)
3242 // Returns holder HTLC outputs to watch and react to in case of spending.
3243 fn get_broadcasted_holder_watch_outputs(&self, holder_tx: &HolderSignedTx, commitment_tx: &Transaction) -> Vec<(u32, TxOut)> {
3244 let mut watch_outputs = Vec::with_capacity(holder_tx.htlc_outputs.len());
3245 for &(ref htlc, _, _) in holder_tx.htlc_outputs.iter() {
3246 if let Some(transaction_output_index) = htlc.transaction_output_index {
3247 watch_outputs.push((transaction_output_index, commitment_tx.output[transaction_output_index as usize].clone()));
3253 /// Attempts to claim any claimable HTLCs in a commitment transaction which was not (yet)
3254 /// revoked using data in holder_claimable_outpoints.
3255 /// Should not be used if check_spend_revoked_transaction succeeds.
3256 /// Returns None unless the transaction is definitely one of our commitment transactions.
3257 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 {
3258 let commitment_txid = tx.txid();
3259 let mut claim_requests = Vec::new();
3260 let mut watch_outputs = Vec::new();
3262 macro_rules! append_onchain_update {
3263 ($updates: expr, $to_watch: expr) => {
3264 claim_requests = $updates.0;
3265 self.broadcasted_holder_revokable_script = $updates.1;
3266 watch_outputs.append(&mut $to_watch);
3270 // HTLCs set may differ between last and previous holder commitment txn, in case of one them hitting chain, ensure we cancel all HTLCs backward
3271 let mut is_holder_tx = false;
3273 if self.current_holder_commitment_tx.txid == commitment_txid {
3274 is_holder_tx = true;
3275 log_info!(logger, "Got broadcast of latest holder commitment tx {}, searching for available HTLCs to claim", commitment_txid);
3276 let res = self.get_broadcasted_holder_claims(&self.current_holder_commitment_tx, height);
3277 let mut to_watch = self.get_broadcasted_holder_watch_outputs(&self.current_holder_commitment_tx, tx);
3278 append_onchain_update!(res, to_watch);
3279 fail_unbroadcast_htlcs!(self, "latest holder", commitment_txid, tx, height,
3280 block_hash, self.current_holder_commitment_tx.htlc_outputs.iter()
3281 .map(|(htlc, _, htlc_source)| (htlc, htlc_source.as_ref())), logger);
3282 } else if let &Some(ref holder_tx) = &self.prev_holder_signed_commitment_tx {
3283 if holder_tx.txid == commitment_txid {
3284 is_holder_tx = true;
3285 log_info!(logger, "Got broadcast of previous holder commitment tx {}, searching for available HTLCs to claim", commitment_txid);
3286 let res = self.get_broadcasted_holder_claims(holder_tx, height);
3287 let mut to_watch = self.get_broadcasted_holder_watch_outputs(holder_tx, tx);
3288 append_onchain_update!(res, to_watch);
3289 fail_unbroadcast_htlcs!(self, "previous holder", commitment_txid, tx, height, block_hash,
3290 holder_tx.htlc_outputs.iter().map(|(htlc, _, htlc_source)| (htlc, htlc_source.as_ref())),
3296 Some((claim_requests, (commitment_txid, watch_outputs)))
3302 pub fn get_latest_holder_commitment_txn<L: Deref>(&mut self, logger: &L) -> Vec<Transaction> where L::Target: Logger {
3303 log_debug!(logger, "Getting signed latest holder commitment transaction!");
3304 self.holder_tx_signed = true;
3305 let commitment_tx = self.onchain_tx_handler.get_fully_signed_holder_tx(&self.funding_redeemscript);
3306 let txid = commitment_tx.txid();
3307 let mut holder_transactions = vec![commitment_tx];
3308 // When anchor outputs are present, the HTLC transactions are only valid once the commitment
3309 // transaction confirms.
3310 if self.onchain_tx_handler.channel_type_features().supports_anchors_zero_fee_htlc_tx() {
3311 return holder_transactions;
3313 for htlc in self.current_holder_commitment_tx.htlc_outputs.iter() {
3314 if let Some(vout) = htlc.0.transaction_output_index {
3315 let preimage = if !htlc.0.offered {
3316 if let Some(preimage) = self.payment_preimages.get(&htlc.0.payment_hash) { Some(preimage.clone()) } else {
3317 // We can't build an HTLC-Success transaction without the preimage
3320 } else if htlc.0.cltv_expiry > self.best_block.height() + 1 {
3321 // Don't broadcast HTLC-Timeout transactions immediately as they don't meet the
3322 // current locktime requirements on-chain. We will broadcast them in
3323 // `block_confirmed` when `should_broadcast_holder_commitment_txn` returns true.
3324 // Note that we add + 1 as transactions are broadcastable when they can be
3325 // confirmed in the next block.
3328 if let Some(htlc_tx) = self.onchain_tx_handler.get_fully_signed_htlc_tx(
3329 &::bitcoin::OutPoint { txid, vout }, &preimage) {
3330 holder_transactions.push(htlc_tx);
3334 // 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.
3335 // The data will be re-generated and tracked in check_spend_holder_transaction if we get a confirmation.
3339 #[cfg(any(test,feature = "unsafe_revoked_tx_signing"))]
3340 /// Note that this includes possibly-locktimed-in-the-future transactions!
3341 fn unsafe_get_latest_holder_commitment_txn<L: Deref>(&mut self, logger: &L) -> Vec<Transaction> where L::Target: Logger {
3342 log_debug!(logger, "Getting signed copy of latest holder commitment transaction!");
3343 let commitment_tx = self.onchain_tx_handler.get_fully_signed_copy_holder_tx(&self.funding_redeemscript);
3344 let txid = commitment_tx.txid();
3345 let mut holder_transactions = vec![commitment_tx];
3346 // When anchor outputs are present, the HTLC transactions are only final once the commitment
3347 // transaction confirms due to the CSV 1 encumberance.
3348 if self.onchain_tx_handler.channel_type_features().supports_anchors_zero_fee_htlc_tx() {
3349 return holder_transactions;
3351 for htlc in self.current_holder_commitment_tx.htlc_outputs.iter() {
3352 if let Some(vout) = htlc.0.transaction_output_index {
3353 let preimage = if !htlc.0.offered {
3354 if let Some(preimage) = self.payment_preimages.get(&htlc.0.payment_hash) { Some(preimage.clone()) } else {
3355 // We can't build an HTLC-Success transaction without the preimage
3359 if let Some(htlc_tx) = self.onchain_tx_handler.get_fully_signed_htlc_tx(
3360 &::bitcoin::OutPoint { txid, vout }, &preimage) {
3361 holder_transactions.push(htlc_tx);
3368 pub fn block_connected<B: Deref, F: Deref, L: Deref>(&mut self, header: &Header, txdata: &TransactionData, height: u32, broadcaster: B, fee_estimator: F, logger: L) -> Vec<TransactionOutputs>
3369 where B::Target: BroadcasterInterface,
3370 F::Target: FeeEstimator,
3373 let block_hash = header.block_hash();
3374 self.best_block = BestBlock::new(block_hash, height);
3376 let bounded_fee_estimator = LowerBoundedFeeEstimator::new(fee_estimator);
3377 self.transactions_confirmed(header, txdata, height, broadcaster, &bounded_fee_estimator, logger)
3380 fn best_block_updated<B: Deref, F: Deref, L: Deref>(
3385 fee_estimator: &LowerBoundedFeeEstimator<F>,
3387 ) -> Vec<TransactionOutputs>
3389 B::Target: BroadcasterInterface,
3390 F::Target: FeeEstimator,
3393 let block_hash = header.block_hash();
3395 if height > self.best_block.height() {
3396 self.best_block = BestBlock::new(block_hash, height);
3397 self.block_confirmed(height, block_hash, vec![], vec![], vec![], &broadcaster, &fee_estimator, &logger)
3398 } else if block_hash != self.best_block.block_hash() {
3399 self.best_block = BestBlock::new(block_hash, height);
3400 self.onchain_events_awaiting_threshold_conf.retain(|ref entry| entry.height <= height);
3401 self.onchain_tx_handler.block_disconnected(height + 1, broadcaster, fee_estimator, logger);
3403 } else { Vec::new() }
3406 fn transactions_confirmed<B: Deref, F: Deref, L: Deref>(
3409 txdata: &TransactionData,
3412 fee_estimator: &LowerBoundedFeeEstimator<F>,
3414 ) -> Vec<TransactionOutputs>
3416 B::Target: BroadcasterInterface,
3417 F::Target: FeeEstimator,
3420 let txn_matched = self.filter_block(txdata);
3421 for tx in &txn_matched {
3422 let mut output_val = 0;
3423 for out in tx.output.iter() {
3424 if out.value > 21_000_000_0000_0000 { panic!("Value-overflowing transaction provided to block connected"); }
3425 output_val += out.value;
3426 if output_val > 21_000_000_0000_0000 { panic!("Value-overflowing transaction provided to block connected"); }
3430 let block_hash = header.block_hash();
3432 let mut watch_outputs = Vec::new();
3433 let mut claimable_outpoints = Vec::new();
3434 'tx_iter: for tx in &txn_matched {
3435 let txid = tx.txid();
3436 // If a transaction has already been confirmed, ensure we don't bother processing it duplicatively.
3437 if Some(txid) == self.funding_spend_confirmed {
3438 log_debug!(logger, "Skipping redundant processing of funding-spend tx {} as it was previously confirmed", txid);
3441 for ev in self.onchain_events_awaiting_threshold_conf.iter() {
3442 if ev.txid == txid {
3443 if let Some(conf_hash) = ev.block_hash {
3444 assert_eq!(header.block_hash(), conf_hash,
3445 "Transaction {} was already confirmed and is being re-confirmed in a different block.\n\
3446 This indicates a severe bug in the transaction connection logic - a reorg should have been processed first!", ev.txid);
3448 log_debug!(logger, "Skipping redundant processing of confirming tx {} as it was previously confirmed", txid);
3452 for htlc in self.htlcs_resolved_on_chain.iter() {
3453 if Some(txid) == htlc.resolving_txid {
3454 log_debug!(logger, "Skipping redundant processing of HTLC resolution tx {} as it was previously confirmed", txid);
3458 for spendable_txid in self.spendable_txids_confirmed.iter() {
3459 if txid == *spendable_txid {
3460 log_debug!(logger, "Skipping redundant processing of spendable tx {} as it was previously confirmed", txid);
3465 if tx.input.len() == 1 {
3466 // Assuming our keys were not leaked (in which case we're screwed no matter what),
3467 // commitment transactions and HTLC transactions will all only ever have one input
3468 // (except for HTLC transactions for channels with anchor outputs), which is an easy
3469 // way to filter out any potential non-matching txn for lazy filters.
3470 let prevout = &tx.input[0].previous_output;
3471 if prevout.txid == self.funding_info.0.txid && prevout.vout == self.funding_info.0.index as u32 {
3472 let mut balance_spendable_csv = None;
3473 log_info!(logger, "Channel {} closed by funding output spend in txid {}.",
3474 &self.funding_info.0.to_channel_id(), txid);
3475 self.funding_spend_seen = true;
3476 let mut commitment_tx_to_counterparty_output = None;
3477 if (tx.input[0].sequence.0 >> 8*3) as u8 == 0x80 && (tx.lock_time.to_consensus_u32() >> 8*3) as u8 == 0x20 {
3478 let (mut new_outpoints, new_outputs, counterparty_output_idx_sats) =
3479 self.check_spend_counterparty_transaction(&tx, height, &block_hash, &logger);
3480 commitment_tx_to_counterparty_output = counterparty_output_idx_sats;
3481 if !new_outputs.1.is_empty() {
3482 watch_outputs.push(new_outputs);
3484 claimable_outpoints.append(&mut new_outpoints);
3485 if new_outpoints.is_empty() {
3486 if let Some((mut new_outpoints, new_outputs)) = self.check_spend_holder_transaction(&tx, height, &block_hash, &logger) {
3487 debug_assert!(commitment_tx_to_counterparty_output.is_none(),
3488 "A commitment transaction matched as both a counterparty and local commitment tx?");
3489 if !new_outputs.1.is_empty() {
3490 watch_outputs.push(new_outputs);
3492 claimable_outpoints.append(&mut new_outpoints);
3493 balance_spendable_csv = Some(self.on_holder_tx_csv);
3497 self.onchain_events_awaiting_threshold_conf.push(OnchainEventEntry {
3499 transaction: Some((*tx).clone()),
3501 block_hash: Some(block_hash),
3502 event: OnchainEvent::FundingSpendConfirmation {
3503 on_local_output_csv: balance_spendable_csv,
3504 commitment_tx_to_counterparty_output,
3509 if tx.input.len() >= 1 {
3510 // While all commitment transactions have one input, HTLC transactions may have more
3511 // if the HTLC was present in an anchor channel. HTLCs can also be resolved in a few
3512 // other ways which can have more than one output.
3513 for tx_input in &tx.input {
3514 let commitment_txid = tx_input.previous_output.txid;
3515 if let Some(&commitment_number) = self.counterparty_commitment_txn_on_chain.get(&commitment_txid) {
3516 let (mut new_outpoints, new_outputs_option) = self.check_spend_counterparty_htlc(
3517 &tx, commitment_number, &commitment_txid, height, &logger
3519 claimable_outpoints.append(&mut new_outpoints);
3520 if let Some(new_outputs) = new_outputs_option {
3521 watch_outputs.push(new_outputs);
3523 // Since there may be multiple HTLCs for this channel (all spending the
3524 // same commitment tx) being claimed by the counterparty within the same
3525 // transaction, and `check_spend_counterparty_htlc` already checks all the
3526 // ones relevant to this channel, we can safely break from our loop.
3530 self.is_resolving_htlc_output(&tx, height, &block_hash, &logger);
3532 self.check_tx_and_push_spendable_outputs(&tx, height, &block_hash, &logger);
3536 if height > self.best_block.height() {
3537 self.best_block = BestBlock::new(block_hash, height);
3540 self.block_confirmed(height, block_hash, txn_matched, watch_outputs, claimable_outpoints, &broadcaster, &fee_estimator, &logger)
3543 /// Update state for new block(s)/transaction(s) confirmed. Note that the caller must update
3544 /// `self.best_block` before calling if a new best blockchain tip is available. More
3545 /// concretely, `self.best_block` must never be at a lower height than `conf_height`, avoiding
3546 /// complexity especially in
3547 /// `OnchainTx::update_claims_view_from_requests`/`OnchainTx::update_claims_view_from_matched_txn`.
3549 /// `conf_height` should be set to the height at which any new transaction(s)/block(s) were
3550 /// confirmed at, even if it is not the current best height.
3551 fn block_confirmed<B: Deref, F: Deref, L: Deref>(
3554 conf_hash: BlockHash,
3555 txn_matched: Vec<&Transaction>,
3556 mut watch_outputs: Vec<TransactionOutputs>,
3557 mut claimable_outpoints: Vec<PackageTemplate>,
3559 fee_estimator: &LowerBoundedFeeEstimator<F>,
3561 ) -> Vec<TransactionOutputs>
3563 B::Target: BroadcasterInterface,
3564 F::Target: FeeEstimator,
3567 log_trace!(logger, "Processing {} matched transactions for block at height {}.", txn_matched.len(), conf_height);
3568 debug_assert!(self.best_block.height() >= conf_height);
3570 let should_broadcast = self.should_broadcast_holder_commitment_txn(logger);
3571 if should_broadcast {
3572 let funding_outp = HolderFundingOutput::build(self.funding_redeemscript.clone(), self.channel_value_satoshis, self.onchain_tx_handler.channel_type_features().clone());
3573 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());
3574 claimable_outpoints.push(commitment_package);
3575 self.pending_monitor_events.push(MonitorEvent::HolderForceClosed(self.funding_info.0));
3576 // Although we aren't signing the transaction directly here, the transaction will be signed
3577 // in the claim that is queued to OnchainTxHandler. We set holder_tx_signed here to reject
3578 // new channel updates.
3579 self.holder_tx_signed = true;
3580 // We can't broadcast our HTLC transactions while the commitment transaction is
3581 // unconfirmed. We'll delay doing so until we detect the confirmed commitment in
3582 // `transactions_confirmed`.
3583 if !self.onchain_tx_handler.channel_type_features().supports_anchors_zero_fee_htlc_tx() {
3584 // Because we're broadcasting a commitment transaction, we should construct the package
3585 // assuming it gets confirmed in the next block. Sadly, we have code which considers
3586 // "not yet confirmed" things as discardable, so we cannot do that here.
3587 let (mut new_outpoints, _) = self.get_broadcasted_holder_claims(&self.current_holder_commitment_tx, self.best_block.height());
3588 let unsigned_commitment_tx = self.onchain_tx_handler.get_unsigned_holder_commitment_tx();
3589 let new_outputs = self.get_broadcasted_holder_watch_outputs(&self.current_holder_commitment_tx, &unsigned_commitment_tx);
3590 if !new_outputs.is_empty() {
3591 watch_outputs.push((self.current_holder_commitment_tx.txid.clone(), new_outputs));
3593 claimable_outpoints.append(&mut new_outpoints);
3597 // Find which on-chain events have reached their confirmation threshold.
3598 let onchain_events_awaiting_threshold_conf =
3599 self.onchain_events_awaiting_threshold_conf.drain(..).collect::<Vec<_>>();
3600 let mut onchain_events_reaching_threshold_conf = Vec::new();
3601 for entry in onchain_events_awaiting_threshold_conf {
3602 if entry.has_reached_confirmation_threshold(&self.best_block) {
3603 onchain_events_reaching_threshold_conf.push(entry);
3605 self.onchain_events_awaiting_threshold_conf.push(entry);
3609 // Used to check for duplicate HTLC resolutions.
3610 #[cfg(debug_assertions)]
3611 let unmatured_htlcs: Vec<_> = self.onchain_events_awaiting_threshold_conf
3613 .filter_map(|entry| match &entry.event {
3614 OnchainEvent::HTLCUpdate { source, .. } => Some(source),
3618 #[cfg(debug_assertions)]
3619 let mut matured_htlcs = Vec::new();
3621 // Produce actionable events from on-chain events having reached their threshold.
3622 for entry in onchain_events_reaching_threshold_conf.drain(..) {
3624 OnchainEvent::HTLCUpdate { ref source, payment_hash, htlc_value_satoshis, commitment_tx_output_idx } => {
3625 // Check for duplicate HTLC resolutions.
3626 #[cfg(debug_assertions)]
3629 unmatured_htlcs.iter().find(|&htlc| htlc == &source).is_none(),
3630 "An unmature HTLC transaction conflicts with a maturing one; failed to \
3631 call either transaction_unconfirmed for the conflicting transaction \
3632 or block_disconnected for a block containing it.");
3634 matured_htlcs.iter().find(|&htlc| htlc == source).is_none(),
3635 "A matured HTLC transaction conflicts with a maturing one; failed to \
3636 call either transaction_unconfirmed for the conflicting transaction \
3637 or block_disconnected for a block containing it.");
3638 matured_htlcs.push(source.clone());
3641 log_debug!(logger, "HTLC {} failure update in {} has got enough confirmations to be passed upstream",
3642 &payment_hash, entry.txid);
3643 self.pending_monitor_events.push(MonitorEvent::HTLCEvent(HTLCUpdate {
3645 payment_preimage: None,
3646 source: source.clone(),
3647 htlc_value_satoshis,
3649 self.htlcs_resolved_on_chain.push(IrrevocablyResolvedHTLC {
3650 commitment_tx_output_idx,
3651 resolving_txid: Some(entry.txid),
3652 resolving_tx: entry.transaction,
3653 payment_preimage: None,
3656 OnchainEvent::MaturingOutput { descriptor } => {
3657 log_debug!(logger, "Descriptor {} has got enough confirmations to be passed upstream", log_spendable!(descriptor));
3658 self.pending_events.push(Event::SpendableOutputs {
3659 outputs: vec![descriptor],
3660 channel_id: Some(self.funding_info.0.to_channel_id()),
3662 self.spendable_txids_confirmed.push(entry.txid);
3664 OnchainEvent::HTLCSpendConfirmation { commitment_tx_output_idx, preimage, .. } => {
3665 self.htlcs_resolved_on_chain.push(IrrevocablyResolvedHTLC {
3666 commitment_tx_output_idx: Some(commitment_tx_output_idx),
3667 resolving_txid: Some(entry.txid),
3668 resolving_tx: entry.transaction,
3669 payment_preimage: preimage,
3672 OnchainEvent::FundingSpendConfirmation { commitment_tx_to_counterparty_output, .. } => {
3673 self.funding_spend_confirmed = Some(entry.txid);
3674 self.confirmed_commitment_tx_counterparty_output = commitment_tx_to_counterparty_output;
3679 self.onchain_tx_handler.update_claims_view_from_requests(claimable_outpoints, conf_height, self.best_block.height(), broadcaster, fee_estimator, logger);
3680 self.onchain_tx_handler.update_claims_view_from_matched_txn(&txn_matched, conf_height, conf_hash, self.best_block.height(), broadcaster, fee_estimator, logger);
3682 // Determine new outputs to watch by comparing against previously known outputs to watch,
3683 // updating the latter in the process.
3684 watch_outputs.retain(|&(ref txid, ref txouts)| {
3685 let idx_and_scripts = txouts.iter().map(|o| (o.0, o.1.script_pubkey.clone())).collect();
3686 self.outputs_to_watch.insert(txid.clone(), idx_and_scripts).is_none()
3690 // If we see a transaction for which we registered outputs previously,
3691 // make sure the registered scriptpubkey at the expected index match
3692 // the actual transaction output one. We failed this case before #653.
3693 for tx in &txn_matched {
3694 if let Some(outputs) = self.get_outputs_to_watch().get(&tx.txid()) {
3695 for idx_and_script in outputs.iter() {
3696 assert!((idx_and_script.0 as usize) < tx.output.len());
3697 assert_eq!(tx.output[idx_and_script.0 as usize].script_pubkey, idx_and_script.1);
3705 pub fn block_disconnected<B: Deref, F: Deref, L: Deref>(&mut self, header: &Header, height: u32, broadcaster: B, fee_estimator: F, logger: L)
3706 where B::Target: BroadcasterInterface,
3707 F::Target: FeeEstimator,
3710 log_trace!(logger, "Block {} at height {} disconnected", header.block_hash(), height);
3713 //- htlc update there as failure-trigger tx (revoked commitment tx, non-revoked commitment tx, HTLC-timeout tx) has been disconnected
3714 //- maturing spendable output has transaction paying us has been disconnected
3715 self.onchain_events_awaiting_threshold_conf.retain(|ref entry| entry.height < height);
3717 let bounded_fee_estimator = LowerBoundedFeeEstimator::new(fee_estimator);
3718 self.onchain_tx_handler.block_disconnected(height, broadcaster, &bounded_fee_estimator, logger);
3720 self.best_block = BestBlock::new(header.prev_blockhash, height - 1);
3723 fn transaction_unconfirmed<B: Deref, F: Deref, L: Deref>(
3727 fee_estimator: &LowerBoundedFeeEstimator<F>,
3730 B::Target: BroadcasterInterface,
3731 F::Target: FeeEstimator,
3734 let mut removed_height = None;
3735 for entry in self.onchain_events_awaiting_threshold_conf.iter() {
3736 if entry.txid == *txid {
3737 removed_height = Some(entry.height);
3742 if let Some(removed_height) = removed_height {
3743 log_info!(logger, "transaction_unconfirmed of txid {} implies height {} was reorg'd out", txid, removed_height);
3744 self.onchain_events_awaiting_threshold_conf.retain(|ref entry| if entry.height >= removed_height {
3745 log_info!(logger, "Transaction {} reorg'd out", entry.txid);
3750 debug_assert!(!self.onchain_events_awaiting_threshold_conf.iter().any(|ref entry| entry.txid == *txid));
3752 self.onchain_tx_handler.transaction_unconfirmed(txid, broadcaster, fee_estimator, logger);
3755 /// Filters a block's `txdata` for transactions spending watched outputs or for any child
3756 /// transactions thereof.
3757 fn filter_block<'a>(&self, txdata: &TransactionData<'a>) -> Vec<&'a Transaction> {
3758 let mut matched_txn = HashSet::new();
3759 txdata.iter().filter(|&&(_, tx)| {
3760 let mut matches = self.spends_watched_output(tx);
3761 for input in tx.input.iter() {
3762 if matches { break; }
3763 if matched_txn.contains(&input.previous_output.txid) {
3768 matched_txn.insert(tx.txid());
3771 }).map(|(_, tx)| *tx).collect()
3774 /// Checks if a given transaction spends any watched outputs.
3775 fn spends_watched_output(&self, tx: &Transaction) -> bool {
3776 for input in tx.input.iter() {
3777 if let Some(outputs) = self.get_outputs_to_watch().get(&input.previous_output.txid) {
3778 for (idx, _script_pubkey) in outputs.iter() {
3779 if *idx == input.previous_output.vout {
3782 // If the expected script is a known type, check that the witness
3783 // appears to be spending the correct type (ie that the match would
3784 // actually succeed in BIP 158/159-style filters).
3785 if _script_pubkey.is_v0_p2wsh() {
3786 if input.witness.last().unwrap().to_vec() == deliberately_bogus_accepted_htlc_witness_program() {
3787 // In at least one test we use a deliberately bogus witness
3788 // script which hit an old panic. Thus, we check for that here
3789 // and avoid the assert if its the expected bogus script.
3793 assert_eq!(&bitcoin::Address::p2wsh(&ScriptBuf::from(input.witness.last().unwrap().to_vec()), bitcoin::Network::Bitcoin).script_pubkey(), _script_pubkey);
3794 } else if _script_pubkey.is_v0_p2wpkh() {
3795 assert_eq!(&bitcoin::Address::p2wpkh(&bitcoin::PublicKey::from_slice(&input.witness.last().unwrap()).unwrap(), bitcoin::Network::Bitcoin).unwrap().script_pubkey(), _script_pubkey);
3796 } else { panic!(); }
3807 fn should_broadcast_holder_commitment_txn<L: Deref>(&self, logger: &L) -> bool where L::Target: Logger {
3808 // There's no need to broadcast our commitment transaction if we've seen one confirmed (even
3809 // with 1 confirmation) as it'll be rejected as duplicate/conflicting.
3810 if self.funding_spend_confirmed.is_some() ||
3811 self.onchain_events_awaiting_threshold_conf.iter().find(|event| match event.event {
3812 OnchainEvent::FundingSpendConfirmation { .. } => true,
3818 // We need to consider all HTLCs which are:
3819 // * in any unrevoked counterparty commitment transaction, as they could broadcast said
3820 // transactions and we'd end up in a race, or
3821 // * are in our latest holder commitment transaction, as this is the thing we will
3822 // broadcast if we go on-chain.
3823 // Note that we consider HTLCs which were below dust threshold here - while they don't
3824 // strictly imply that we need to fail the channel, we need to go ahead and fail them back
3825 // to the source, and if we don't fail the channel we will have to ensure that the next
3826 // updates that peer sends us are update_fails, failing the channel if not. It's probably
3827 // easier to just fail the channel as this case should be rare enough anyway.
3828 let height = self.best_block.height();
3829 macro_rules! scan_commitment {
3830 ($htlcs: expr, $holder_tx: expr) => {
3831 for ref htlc in $htlcs {
3832 // For inbound HTLCs which we know the preimage for, we have to ensure we hit the
3833 // chain with enough room to claim the HTLC without our counterparty being able to
3834 // time out the HTLC first.
3835 // For outbound HTLCs which our counterparty hasn't failed/claimed, our primary
3836 // concern is being able to claim the corresponding inbound HTLC (on another
3837 // channel) before it expires. In fact, we don't even really care if our
3838 // counterparty here claims such an outbound HTLC after it expired as long as we
3839 // can still claim the corresponding HTLC. Thus, to avoid needlessly hitting the
3840 // chain when our counterparty is waiting for expiration to off-chain fail an HTLC
3841 // we give ourselves a few blocks of headroom after expiration before going
3842 // on-chain for an expired HTLC.
3843 // Note that, to avoid a potential attack whereby a node delays claiming an HTLC
3844 // from us until we've reached the point where we go on-chain with the
3845 // corresponding inbound HTLC, we must ensure that outbound HTLCs go on chain at
3846 // least CLTV_CLAIM_BUFFER blocks prior to the inbound HTLC.
3847 // aka outbound_cltv + LATENCY_GRACE_PERIOD_BLOCKS == height - CLTV_CLAIM_BUFFER
3848 // inbound_cltv == height + CLTV_CLAIM_BUFFER
3849 // outbound_cltv + LATENCY_GRACE_PERIOD_BLOCKS + CLTV_CLAIM_BUFFER <= inbound_cltv - CLTV_CLAIM_BUFFER
3850 // LATENCY_GRACE_PERIOD_BLOCKS + 2*CLTV_CLAIM_BUFFER <= inbound_cltv - outbound_cltv
3851 // CLTV_EXPIRY_DELTA <= inbound_cltv - outbound_cltv (by check in ChannelManager::decode_update_add_htlc_onion)
3852 // LATENCY_GRACE_PERIOD_BLOCKS + 2*CLTV_CLAIM_BUFFER <= CLTV_EXPIRY_DELTA
3853 // The final, above, condition is checked for statically in channelmanager
3854 // with CHECK_CLTV_EXPIRY_SANITY_2.
3855 let htlc_outbound = $holder_tx == htlc.offered;
3856 if ( htlc_outbound && htlc.cltv_expiry + LATENCY_GRACE_PERIOD_BLOCKS <= height) ||
3857 (!htlc_outbound && htlc.cltv_expiry <= height + CLTV_CLAIM_BUFFER && self.payment_preimages.contains_key(&htlc.payment_hash)) {
3858 log_info!(logger, "Force-closing channel due to {} HTLC timeout, HTLC expiry is {}", if htlc_outbound { "outbound" } else { "inbound "}, htlc.cltv_expiry);
3865 scan_commitment!(self.current_holder_commitment_tx.htlc_outputs.iter().map(|&(ref a, _, _)| a), true);
3867 if let Some(ref txid) = self.current_counterparty_commitment_txid {
3868 if let Some(ref htlc_outputs) = self.counterparty_claimable_outpoints.get(txid) {
3869 scan_commitment!(htlc_outputs.iter().map(|&(ref a, _)| a), false);
3872 if let Some(ref txid) = self.prev_counterparty_commitment_txid {
3873 if let Some(ref htlc_outputs) = self.counterparty_claimable_outpoints.get(txid) {
3874 scan_commitment!(htlc_outputs.iter().map(|&(ref a, _)| a), false);
3881 /// Check if any transaction broadcasted is resolving HTLC output by a success or timeout on a holder
3882 /// or counterparty commitment tx, if so send back the source, preimage if found and payment_hash of resolved HTLC
3883 fn is_resolving_htlc_output<L: Deref>(&mut self, tx: &Transaction, height: u32, block_hash: &BlockHash, logger: &L) where L::Target: Logger {
3884 'outer_loop: for input in &tx.input {
3885 let mut payment_data = None;
3886 let htlc_claim = HTLCClaim::from_witness(&input.witness);
3887 let revocation_sig_claim = htlc_claim == Some(HTLCClaim::Revocation);
3888 let accepted_preimage_claim = htlc_claim == Some(HTLCClaim::AcceptedPreimage);
3889 #[cfg(not(fuzzing))]
3890 let accepted_timeout_claim = htlc_claim == Some(HTLCClaim::AcceptedTimeout);
3891 let offered_preimage_claim = htlc_claim == Some(HTLCClaim::OfferedPreimage);
3892 #[cfg(not(fuzzing))]
3893 let offered_timeout_claim = htlc_claim == Some(HTLCClaim::OfferedTimeout);
3895 let mut payment_preimage = PaymentPreimage([0; 32]);
3896 if offered_preimage_claim || accepted_preimage_claim {
3897 payment_preimage.0.copy_from_slice(input.witness.second_to_last().unwrap());
3900 macro_rules! log_claim {
3901 ($tx_info: expr, $holder_tx: expr, $htlc: expr, $source_avail: expr) => {
3902 let outbound_htlc = $holder_tx == $htlc.offered;
3903 // HTLCs must either be claimed by a matching script type or through the
3905 #[cfg(not(fuzzing))] // Note that the fuzzer is not bound by pesky things like "signatures"
3906 debug_assert!(!$htlc.offered || offered_preimage_claim || offered_timeout_claim || revocation_sig_claim);
3907 #[cfg(not(fuzzing))] // Note that the fuzzer is not bound by pesky things like "signatures"
3908 debug_assert!($htlc.offered || accepted_preimage_claim || accepted_timeout_claim || revocation_sig_claim);
3909 // Further, only exactly one of the possible spend paths should have been
3910 // matched by any HTLC spend:
3911 #[cfg(not(fuzzing))] // Note that the fuzzer is not bound by pesky things like "signatures"
3912 debug_assert_eq!(accepted_preimage_claim as u8 + accepted_timeout_claim as u8 +
3913 offered_preimage_claim as u8 + offered_timeout_claim as u8 +
3914 revocation_sig_claim as u8, 1);
3915 if ($holder_tx && revocation_sig_claim) ||
3916 (outbound_htlc && !$source_avail && (accepted_preimage_claim || offered_preimage_claim)) {
3917 log_error!(logger, "Input spending {} ({}:{}) in {} resolves {} HTLC with payment hash {} with {}!",
3918 $tx_info, input.previous_output.txid, input.previous_output.vout, tx.txid(),
3919 if outbound_htlc { "outbound" } else { "inbound" }, &$htlc.payment_hash,
3920 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" });
3922 log_info!(logger, "Input spending {} ({}:{}) in {} resolves {} HTLC with payment hash {} with {}",
3923 $tx_info, input.previous_output.txid, input.previous_output.vout, tx.txid(),
3924 if outbound_htlc { "outbound" } else { "inbound" }, &$htlc.payment_hash,
3925 if revocation_sig_claim { "revocation sig" } else if accepted_preimage_claim || offered_preimage_claim { "preimage" } else { "timeout" });
3930 macro_rules! check_htlc_valid_counterparty {
3931 ($counterparty_txid: expr, $htlc_output: expr) => {
3932 if let Some(txid) = $counterparty_txid {
3933 for &(ref pending_htlc, ref pending_source) in self.counterparty_claimable_outpoints.get(&txid).unwrap() {
3934 if pending_htlc.payment_hash == $htlc_output.payment_hash && pending_htlc.amount_msat == $htlc_output.amount_msat {
3935 if let &Some(ref source) = pending_source {
3936 log_claim!("revoked counterparty commitment tx", false, pending_htlc, true);
3937 payment_data = Some(((**source).clone(), $htlc_output.payment_hash, $htlc_output.amount_msat));
3946 macro_rules! scan_commitment {
3947 ($htlcs: expr, $tx_info: expr, $holder_tx: expr) => {
3948 for (ref htlc_output, source_option) in $htlcs {
3949 if Some(input.previous_output.vout) == htlc_output.transaction_output_index {
3950 if let Some(ref source) = source_option {
3951 log_claim!($tx_info, $holder_tx, htlc_output, true);
3952 // We have a resolution of an HTLC either from one of our latest
3953 // holder commitment transactions or an unrevoked counterparty commitment
3954 // transaction. This implies we either learned a preimage, the HTLC
3955 // has timed out, or we screwed up. In any case, we should now
3956 // resolve the source HTLC with the original sender.
3957 payment_data = Some(((*source).clone(), htlc_output.payment_hash, htlc_output.amount_msat));
3958 } else if !$holder_tx {
3959 check_htlc_valid_counterparty!(self.current_counterparty_commitment_txid, htlc_output);
3960 if payment_data.is_none() {
3961 check_htlc_valid_counterparty!(self.prev_counterparty_commitment_txid, htlc_output);
3964 if payment_data.is_none() {
3965 log_claim!($tx_info, $holder_tx, htlc_output, false);
3966 let outbound_htlc = $holder_tx == htlc_output.offered;
3967 self.onchain_events_awaiting_threshold_conf.push(OnchainEventEntry {
3968 txid: tx.txid(), height, block_hash: Some(*block_hash), transaction: Some(tx.clone()),
3969 event: OnchainEvent::HTLCSpendConfirmation {
3970 commitment_tx_output_idx: input.previous_output.vout,
3971 preimage: if accepted_preimage_claim || offered_preimage_claim {
3972 Some(payment_preimage) } else { None },
3973 // If this is a payment to us (ie !outbound_htlc), wait for
3974 // the CSV delay before dropping the HTLC from claimable
3975 // balance if the claim was an HTLC-Success transaction (ie
3976 // accepted_preimage_claim).
3977 on_to_local_output_csv: if accepted_preimage_claim && !outbound_htlc {
3978 Some(self.on_holder_tx_csv) } else { None },
3981 continue 'outer_loop;
3988 if input.previous_output.txid == self.current_holder_commitment_tx.txid {
3989 scan_commitment!(self.current_holder_commitment_tx.htlc_outputs.iter().map(|&(ref a, _, ref b)| (a, b.as_ref())),
3990 "our latest holder commitment tx", true);
3992 if let Some(ref prev_holder_signed_commitment_tx) = self.prev_holder_signed_commitment_tx {
3993 if input.previous_output.txid == prev_holder_signed_commitment_tx.txid {
3994 scan_commitment!(prev_holder_signed_commitment_tx.htlc_outputs.iter().map(|&(ref a, _, ref b)| (a, b.as_ref())),
3995 "our previous holder commitment tx", true);
3998 if let Some(ref htlc_outputs) = self.counterparty_claimable_outpoints.get(&input.previous_output.txid) {
3999 scan_commitment!(htlc_outputs.iter().map(|&(ref a, ref b)| (a, (b.as_ref().clone()).map(|boxed| &**boxed))),
4000 "counterparty commitment tx", false);
4003 // Check that scan_commitment, above, decided there is some source worth relaying an
4004 // HTLC resolution backwards to and figure out whether we learned a preimage from it.
4005 if let Some((source, payment_hash, amount_msat)) = payment_data {
4006 if accepted_preimage_claim {
4007 if !self.pending_monitor_events.iter().any(
4008 |update| if let &MonitorEvent::HTLCEvent(ref upd) = update { upd.source == source } else { false }) {
4009 self.onchain_events_awaiting_threshold_conf.push(OnchainEventEntry {
4012 block_hash: Some(*block_hash),
4013 transaction: Some(tx.clone()),
4014 event: OnchainEvent::HTLCSpendConfirmation {
4015 commitment_tx_output_idx: input.previous_output.vout,
4016 preimage: Some(payment_preimage),
4017 on_to_local_output_csv: None,
4020 self.pending_monitor_events.push(MonitorEvent::HTLCEvent(HTLCUpdate {
4022 payment_preimage: Some(payment_preimage),
4024 htlc_value_satoshis: Some(amount_msat / 1000),
4027 } else if offered_preimage_claim {
4028 if !self.pending_monitor_events.iter().any(
4029 |update| if let &MonitorEvent::HTLCEvent(ref upd) = update {
4030 upd.source == source
4032 self.onchain_events_awaiting_threshold_conf.push(OnchainEventEntry {
4034 transaction: Some(tx.clone()),
4036 block_hash: Some(*block_hash),
4037 event: OnchainEvent::HTLCSpendConfirmation {
4038 commitment_tx_output_idx: input.previous_output.vout,
4039 preimage: Some(payment_preimage),
4040 on_to_local_output_csv: None,
4043 self.pending_monitor_events.push(MonitorEvent::HTLCEvent(HTLCUpdate {
4045 payment_preimage: Some(payment_preimage),
4047 htlc_value_satoshis: Some(amount_msat / 1000),
4051 self.onchain_events_awaiting_threshold_conf.retain(|ref entry| {
4052 if entry.height != height { return true; }
4054 OnchainEvent::HTLCUpdate { source: ref htlc_source, .. } => {
4055 *htlc_source != source
4060 let entry = OnchainEventEntry {
4062 transaction: Some(tx.clone()),
4064 block_hash: Some(*block_hash),
4065 event: OnchainEvent::HTLCUpdate {
4066 source, payment_hash,
4067 htlc_value_satoshis: Some(amount_msat / 1000),
4068 commitment_tx_output_idx: Some(input.previous_output.vout),
4071 log_info!(logger, "Failing HTLC with payment_hash {} timeout by a spend tx, waiting for confirmation (at height {})", &payment_hash, entry.confirmation_threshold());
4072 self.onchain_events_awaiting_threshold_conf.push(entry);
4078 fn get_spendable_outputs(&self, tx: &Transaction) -> Vec<SpendableOutputDescriptor> {
4079 let mut spendable_outputs = Vec::new();
4080 for (i, outp) in tx.output.iter().enumerate() {
4081 if outp.script_pubkey == self.destination_script {
4082 spendable_outputs.push(SpendableOutputDescriptor::StaticOutput {
4083 outpoint: OutPoint { txid: tx.txid(), index: i as u16 },
4084 output: outp.clone(),
4087 if let Some(ref broadcasted_holder_revokable_script) = self.broadcasted_holder_revokable_script {
4088 if broadcasted_holder_revokable_script.0 == outp.script_pubkey {
4089 spendable_outputs.push(SpendableOutputDescriptor::DelayedPaymentOutput(DelayedPaymentOutputDescriptor {
4090 outpoint: OutPoint { txid: tx.txid(), index: i as u16 },
4091 per_commitment_point: broadcasted_holder_revokable_script.1,
4092 to_self_delay: self.on_holder_tx_csv,
4093 output: outp.clone(),
4094 revocation_pubkey: broadcasted_holder_revokable_script.2,
4095 channel_keys_id: self.channel_keys_id,
4096 channel_value_satoshis: self.channel_value_satoshis,
4100 if self.counterparty_payment_script == outp.script_pubkey {
4101 spendable_outputs.push(SpendableOutputDescriptor::StaticPaymentOutput(StaticPaymentOutputDescriptor {
4102 outpoint: OutPoint { txid: tx.txid(), index: i as u16 },
4103 output: outp.clone(),
4104 channel_keys_id: self.channel_keys_id,
4105 channel_value_satoshis: self.channel_value_satoshis,
4106 channel_transaction_parameters: Some(self.onchain_tx_handler.channel_transaction_parameters.clone()),
4109 if self.shutdown_script.as_ref() == Some(&outp.script_pubkey) {
4110 spendable_outputs.push(SpendableOutputDescriptor::StaticOutput {
4111 outpoint: OutPoint { txid: tx.txid(), index: i as u16 },
4112 output: outp.clone(),
4119 /// Checks if the confirmed transaction is paying funds back to some address we can assume to
4121 fn check_tx_and_push_spendable_outputs<L: Deref>(
4122 &mut self, tx: &Transaction, height: u32, block_hash: &BlockHash, logger: &L,
4123 ) where L::Target: Logger {
4124 for spendable_output in self.get_spendable_outputs(tx) {
4125 let entry = OnchainEventEntry {
4127 transaction: Some(tx.clone()),
4129 block_hash: Some(*block_hash),
4130 event: OnchainEvent::MaturingOutput { descriptor: spendable_output.clone() },
4132 log_info!(logger, "Received spendable output {}, spendable at height {}", log_spendable!(spendable_output), entry.confirmation_threshold());
4133 self.onchain_events_awaiting_threshold_conf.push(entry);
4138 impl<Signer: WriteableEcdsaChannelSigner, T: Deref, F: Deref, L: Deref> chain::Listen for (ChannelMonitor<Signer>, T, F, L)
4140 T::Target: BroadcasterInterface,
4141 F::Target: FeeEstimator,
4144 fn filtered_block_connected(&self, header: &Header, txdata: &TransactionData, height: u32) {
4145 self.0.block_connected(header, txdata, height, &*self.1, &*self.2, &*self.3);
4148 fn block_disconnected(&self, header: &Header, height: u32) {
4149 self.0.block_disconnected(header, height, &*self.1, &*self.2, &*self.3);
4153 impl<Signer: WriteableEcdsaChannelSigner, M, T: Deref, F: Deref, L: Deref> chain::Confirm for (M, T, F, L)
4155 M: Deref<Target = ChannelMonitor<Signer>>,
4156 T::Target: BroadcasterInterface,
4157 F::Target: FeeEstimator,
4160 fn transactions_confirmed(&self, header: &Header, txdata: &TransactionData, height: u32) {
4161 self.0.transactions_confirmed(header, txdata, height, &*self.1, &*self.2, &*self.3);
4164 fn transaction_unconfirmed(&self, txid: &Txid) {
4165 self.0.transaction_unconfirmed(txid, &*self.1, &*self.2, &*self.3);
4168 fn best_block_updated(&self, header: &Header, height: u32) {
4169 self.0.best_block_updated(header, height, &*self.1, &*self.2, &*self.3);
4172 fn get_relevant_txids(&self) -> Vec<(Txid, u32, Option<BlockHash>)> {
4173 self.0.get_relevant_txids()
4177 const MAX_ALLOC_SIZE: usize = 64*1024;
4179 impl<'a, 'b, ES: EntropySource, SP: SignerProvider> ReadableArgs<(&'a ES, &'b SP)>
4180 for (BlockHash, ChannelMonitor<SP::Signer>) {
4181 fn read<R: io::Read>(reader: &mut R, args: (&'a ES, &'b SP)) -> Result<Self, DecodeError> {
4182 macro_rules! unwrap_obj {
4186 Err(_) => return Err(DecodeError::InvalidValue),
4191 let (entropy_source, signer_provider) = args;
4193 let _ver = read_ver_prefix!(reader, SERIALIZATION_VERSION);
4195 let latest_update_id: u64 = Readable::read(reader)?;
4196 let commitment_transaction_number_obscure_factor = <U48 as Readable>::read(reader)?.0;
4198 let destination_script = Readable::read(reader)?;
4199 let broadcasted_holder_revokable_script = match <u8 as Readable>::read(reader)? {
4201 let revokable_address = Readable::read(reader)?;
4202 let per_commitment_point = Readable::read(reader)?;
4203 let revokable_script = Readable::read(reader)?;
4204 Some((revokable_address, per_commitment_point, revokable_script))
4207 _ => return Err(DecodeError::InvalidValue),
4209 let mut counterparty_payment_script: ScriptBuf = Readable::read(reader)?;
4210 let shutdown_script = {
4211 let script = <ScriptBuf as Readable>::read(reader)?;
4212 if script.is_empty() { None } else { Some(script) }
4215 let channel_keys_id = Readable::read(reader)?;
4216 let holder_revocation_basepoint = Readable::read(reader)?;
4217 // Technically this can fail and serialize fail a round-trip, but only for serialization of
4218 // barely-init'd ChannelMonitors that we can't do anything with.
4219 let outpoint = OutPoint {
4220 txid: Readable::read(reader)?,
4221 index: Readable::read(reader)?,
4223 let funding_info = (outpoint, Readable::read(reader)?);
4224 let current_counterparty_commitment_txid = Readable::read(reader)?;
4225 let prev_counterparty_commitment_txid = Readable::read(reader)?;
4227 let counterparty_commitment_params = Readable::read(reader)?;
4228 let funding_redeemscript = Readable::read(reader)?;
4229 let channel_value_satoshis = Readable::read(reader)?;
4231 let their_cur_per_commitment_points = {
4232 let first_idx = <U48 as Readable>::read(reader)?.0;
4236 let first_point = Readable::read(reader)?;
4237 let second_point_slice: [u8; 33] = Readable::read(reader)?;
4238 if second_point_slice[0..32] == [0; 32] && second_point_slice[32] == 0 {
4239 Some((first_idx, first_point, None))
4241 Some((first_idx, first_point, Some(unwrap_obj!(PublicKey::from_slice(&second_point_slice)))))
4246 let on_holder_tx_csv: u16 = Readable::read(reader)?;
4248 let commitment_secrets = Readable::read(reader)?;
4250 macro_rules! read_htlc_in_commitment {
4253 let offered: bool = Readable::read(reader)?;
4254 let amount_msat: u64 = Readable::read(reader)?;
4255 let cltv_expiry: u32 = Readable::read(reader)?;
4256 let payment_hash: PaymentHash = Readable::read(reader)?;
4257 let transaction_output_index: Option<u32> = Readable::read(reader)?;
4259 HTLCOutputInCommitment {
4260 offered, amount_msat, cltv_expiry, payment_hash, transaction_output_index
4266 let counterparty_claimable_outpoints_len: u64 = Readable::read(reader)?;
4267 let mut counterparty_claimable_outpoints = HashMap::with_capacity(cmp::min(counterparty_claimable_outpoints_len as usize, MAX_ALLOC_SIZE / 64));
4268 for _ in 0..counterparty_claimable_outpoints_len {
4269 let txid: Txid = Readable::read(reader)?;
4270 let htlcs_count: u64 = Readable::read(reader)?;
4271 let mut htlcs = Vec::with_capacity(cmp::min(htlcs_count as usize, MAX_ALLOC_SIZE / 32));
4272 for _ in 0..htlcs_count {
4273 htlcs.push((read_htlc_in_commitment!(), <Option<HTLCSource> as Readable>::read(reader)?.map(|o: HTLCSource| Box::new(o))));
4275 if let Some(_) = counterparty_claimable_outpoints.insert(txid, htlcs) {
4276 return Err(DecodeError::InvalidValue);
4280 let counterparty_commitment_txn_on_chain_len: u64 = Readable::read(reader)?;
4281 let mut counterparty_commitment_txn_on_chain = HashMap::with_capacity(cmp::min(counterparty_commitment_txn_on_chain_len as usize, MAX_ALLOC_SIZE / 32));
4282 for _ in 0..counterparty_commitment_txn_on_chain_len {
4283 let txid: Txid = Readable::read(reader)?;
4284 let commitment_number = <U48 as Readable>::read(reader)?.0;
4285 if let Some(_) = counterparty_commitment_txn_on_chain.insert(txid, commitment_number) {
4286 return Err(DecodeError::InvalidValue);
4290 let counterparty_hash_commitment_number_len: u64 = Readable::read(reader)?;
4291 let mut counterparty_hash_commitment_number = HashMap::with_capacity(cmp::min(counterparty_hash_commitment_number_len as usize, MAX_ALLOC_SIZE / 32));
4292 for _ in 0..counterparty_hash_commitment_number_len {
4293 let payment_hash: PaymentHash = Readable::read(reader)?;
4294 let commitment_number = <U48 as Readable>::read(reader)?.0;
4295 if let Some(_) = counterparty_hash_commitment_number.insert(payment_hash, commitment_number) {
4296 return Err(DecodeError::InvalidValue);
4300 let mut prev_holder_signed_commitment_tx: Option<HolderSignedTx> =
4301 match <u8 as Readable>::read(reader)? {
4304 Some(Readable::read(reader)?)
4306 _ => return Err(DecodeError::InvalidValue),
4308 let mut current_holder_commitment_tx: HolderSignedTx = Readable::read(reader)?;
4310 let current_counterparty_commitment_number = <U48 as Readable>::read(reader)?.0;
4311 let current_holder_commitment_number = <U48 as Readable>::read(reader)?.0;
4313 let payment_preimages_len: u64 = Readable::read(reader)?;
4314 let mut payment_preimages = HashMap::with_capacity(cmp::min(payment_preimages_len as usize, MAX_ALLOC_SIZE / 32));
4315 for _ in 0..payment_preimages_len {
4316 let preimage: PaymentPreimage = Readable::read(reader)?;
4317 let hash = PaymentHash(Sha256::hash(&preimage.0[..]).to_byte_array());
4318 if let Some(_) = payment_preimages.insert(hash, preimage) {
4319 return Err(DecodeError::InvalidValue);
4323 let pending_monitor_events_len: u64 = Readable::read(reader)?;
4324 let mut pending_monitor_events = Some(
4325 Vec::with_capacity(cmp::min(pending_monitor_events_len as usize, MAX_ALLOC_SIZE / (32 + 8*3))));
4326 for _ in 0..pending_monitor_events_len {
4327 let ev = match <u8 as Readable>::read(reader)? {
4328 0 => MonitorEvent::HTLCEvent(Readable::read(reader)?),
4329 1 => MonitorEvent::HolderForceClosed(funding_info.0),
4330 _ => return Err(DecodeError::InvalidValue)
4332 pending_monitor_events.as_mut().unwrap().push(ev);
4335 let pending_events_len: u64 = Readable::read(reader)?;
4336 let mut pending_events = Vec::with_capacity(cmp::min(pending_events_len as usize, MAX_ALLOC_SIZE / mem::size_of::<Event>()));
4337 for _ in 0..pending_events_len {
4338 if let Some(event) = MaybeReadable::read(reader)? {
4339 pending_events.push(event);
4343 let best_block = BestBlock::new(Readable::read(reader)?, Readable::read(reader)?);
4345 let waiting_threshold_conf_len: u64 = Readable::read(reader)?;
4346 let mut onchain_events_awaiting_threshold_conf = Vec::with_capacity(cmp::min(waiting_threshold_conf_len as usize, MAX_ALLOC_SIZE / 128));
4347 for _ in 0..waiting_threshold_conf_len {
4348 if let Some(val) = MaybeReadable::read(reader)? {
4349 onchain_events_awaiting_threshold_conf.push(val);
4353 let outputs_to_watch_len: u64 = Readable::read(reader)?;
4354 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<ScriptBuf>>())));
4355 for _ in 0..outputs_to_watch_len {
4356 let txid = Readable::read(reader)?;
4357 let outputs_len: u64 = Readable::read(reader)?;
4358 let mut outputs = Vec::with_capacity(cmp::min(outputs_len as usize, MAX_ALLOC_SIZE / (mem::size_of::<u32>() + mem::size_of::<ScriptBuf>())));
4359 for _ in 0..outputs_len {
4360 outputs.push((Readable::read(reader)?, Readable::read(reader)?));
4362 if let Some(_) = outputs_to_watch.insert(txid, outputs) {
4363 return Err(DecodeError::InvalidValue);
4366 let onchain_tx_handler: OnchainTxHandler<SP::Signer> = ReadableArgs::read(
4367 reader, (entropy_source, signer_provider, channel_value_satoshis, channel_keys_id)
4370 let lockdown_from_offchain = Readable::read(reader)?;
4371 let holder_tx_signed = Readable::read(reader)?;
4373 if let Some(prev_commitment_tx) = prev_holder_signed_commitment_tx.as_mut() {
4374 let prev_holder_value = onchain_tx_handler.get_prev_holder_commitment_to_self_value();
4375 if prev_holder_value.is_none() { return Err(DecodeError::InvalidValue); }
4376 if prev_commitment_tx.to_self_value_sat == u64::max_value() {
4377 prev_commitment_tx.to_self_value_sat = prev_holder_value.unwrap();
4378 } else if prev_commitment_tx.to_self_value_sat != prev_holder_value.unwrap() {
4379 return Err(DecodeError::InvalidValue);
4383 let cur_holder_value = onchain_tx_handler.get_cur_holder_commitment_to_self_value();
4384 if current_holder_commitment_tx.to_self_value_sat == u64::max_value() {
4385 current_holder_commitment_tx.to_self_value_sat = cur_holder_value;
4386 } else if current_holder_commitment_tx.to_self_value_sat != cur_holder_value {
4387 return Err(DecodeError::InvalidValue);
4390 let mut funding_spend_confirmed = None;
4391 let mut htlcs_resolved_on_chain = Some(Vec::new());
4392 let mut funding_spend_seen = Some(false);
4393 let mut counterparty_node_id = None;
4394 let mut confirmed_commitment_tx_counterparty_output = None;
4395 let mut spendable_txids_confirmed = Some(Vec::new());
4396 let mut counterparty_fulfilled_htlcs = Some(HashMap::new());
4397 let mut initial_counterparty_commitment_info = None;
4398 read_tlv_fields!(reader, {
4399 (1, funding_spend_confirmed, option),
4400 (3, htlcs_resolved_on_chain, optional_vec),
4401 (5, pending_monitor_events, optional_vec),
4402 (7, funding_spend_seen, option),
4403 (9, counterparty_node_id, option),
4404 (11, confirmed_commitment_tx_counterparty_output, option),
4405 (13, spendable_txids_confirmed, optional_vec),
4406 (15, counterparty_fulfilled_htlcs, option),
4407 (17, initial_counterparty_commitment_info, option),
4410 // Monitors for anchor outputs channels opened in v0.0.116 suffered from a bug in which the
4411 // wrong `counterparty_payment_script` was being tracked. Fix it now on deserialization to
4412 // give them a chance to recognize the spendable output.
4413 if onchain_tx_handler.channel_type_features().supports_anchors_zero_fee_htlc_tx() &&
4414 counterparty_payment_script.is_v0_p2wpkh()
4416 let payment_point = onchain_tx_handler.channel_transaction_parameters.holder_pubkeys.payment_point;
4417 counterparty_payment_script =
4418 chan_utils::get_to_countersignatory_with_anchors_redeemscript(&payment_point).to_v0_p2wsh();
4421 Ok((best_block.block_hash(), ChannelMonitor::from_impl(ChannelMonitorImpl {
4423 commitment_transaction_number_obscure_factor,
4426 broadcasted_holder_revokable_script,
4427 counterparty_payment_script,
4431 holder_revocation_basepoint,
4433 current_counterparty_commitment_txid,
4434 prev_counterparty_commitment_txid,
4436 counterparty_commitment_params,
4437 funding_redeemscript,
4438 channel_value_satoshis,
4439 their_cur_per_commitment_points,
4444 counterparty_claimable_outpoints,
4445 counterparty_commitment_txn_on_chain,
4446 counterparty_hash_commitment_number,
4447 counterparty_fulfilled_htlcs: counterparty_fulfilled_htlcs.unwrap(),
4449 prev_holder_signed_commitment_tx,
4450 current_holder_commitment_tx,
4451 current_counterparty_commitment_number,
4452 current_holder_commitment_number,
4455 pending_monitor_events: pending_monitor_events.unwrap(),
4457 is_processing_pending_events: false,
4459 onchain_events_awaiting_threshold_conf,
4464 lockdown_from_offchain,
4466 funding_spend_seen: funding_spend_seen.unwrap(),
4467 funding_spend_confirmed,
4468 confirmed_commitment_tx_counterparty_output,
4469 htlcs_resolved_on_chain: htlcs_resolved_on_chain.unwrap(),
4470 spendable_txids_confirmed: spendable_txids_confirmed.unwrap(),
4473 counterparty_node_id,
4474 initial_counterparty_commitment_info,
4481 use bitcoin::blockdata::locktime::absolute::LockTime;
4482 use bitcoin::blockdata::script::{ScriptBuf, Builder};
4483 use bitcoin::blockdata::opcodes;
4484 use bitcoin::blockdata::transaction::{Transaction, TxIn, TxOut};
4485 use bitcoin::blockdata::transaction::OutPoint as BitcoinOutPoint;
4486 use bitcoin::sighash;
4487 use bitcoin::sighash::EcdsaSighashType;
4488 use bitcoin::hashes::Hash;
4489 use bitcoin::hashes::sha256::Hash as Sha256;
4490 use bitcoin::hashes::hex::FromHex;
4491 use bitcoin::hash_types::{BlockHash, Txid};
4492 use bitcoin::network::constants::Network;
4493 use bitcoin::secp256k1::{SecretKey,PublicKey};
4494 use bitcoin::secp256k1::Secp256k1;
4495 use bitcoin::{Sequence, Witness};
4497 use crate::chain::chaininterface::LowerBoundedFeeEstimator;
4499 use super::ChannelMonitorUpdateStep;
4500 use crate::{check_added_monitors, check_spends, get_local_commitment_txn, get_monitor, get_route_and_payment_hash, unwrap_send_err};
4501 use crate::chain::{BestBlock, Confirm};
4502 use crate::chain::channelmonitor::ChannelMonitor;
4503 use crate::chain::package::{weight_offered_htlc, weight_received_htlc, weight_revoked_offered_htlc, weight_revoked_received_htlc, WEIGHT_REVOKED_OUTPUT};
4504 use crate::chain::transaction::OutPoint;
4505 use crate::sign::InMemorySigner;
4506 use crate::ln::{PaymentPreimage, PaymentHash};
4507 use crate::ln::channel_keys::{DelayedPaymentBasepoint, DelayedPaymentKey, HtlcBasepoint, RevocationBasepoint, RevocationKey};
4508 use crate::ln::chan_utils::{self,HTLCOutputInCommitment, ChannelPublicKeys, ChannelTransactionParameters, HolderCommitmentTransaction, CounterpartyChannelTransactionParameters};
4509 use crate::ln::channelmanager::{PaymentSendFailure, PaymentId, RecipientOnionFields};
4510 use crate::ln::functional_test_utils::*;
4511 use crate::ln::script::ShutdownScript;
4512 use crate::util::errors::APIError;
4513 use crate::util::test_utils::{TestLogger, TestBroadcaster, TestFeeEstimator};
4514 use crate::util::ser::{ReadableArgs, Writeable};
4515 use crate::sync::{Arc, Mutex};
4517 use crate::ln::features::ChannelTypeFeatures;
4518 use crate::prelude::*;
4520 use std::str::FromStr;
4522 fn do_test_funding_spend_refuses_updates(use_local_txn: bool) {
4523 // Previously, monitor updates were allowed freely even after a funding-spend transaction
4524 // confirmed. This would allow a race condition where we could receive a payment (including
4525 // the counterparty revoking their broadcasted state!) and accept it without recourse as
4526 // long as the ChannelMonitor receives the block first, the full commitment update dance
4527 // occurs after the block is connected, and before the ChannelManager receives the block.
4528 // Obviously this is an incredibly contrived race given the counterparty would be risking
4529 // their full channel balance for it, but its worth fixing nonetheless as it makes the
4530 // potential ChannelMonitor states simpler to reason about.
4532 // This test checks said behavior, as well as ensuring a ChannelMonitorUpdate with multiple
4533 // updates is handled correctly in such conditions.
4534 let chanmon_cfgs = create_chanmon_cfgs(3);
4535 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
4536 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
4537 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
4538 let channel = create_announced_chan_between_nodes(&nodes, 0, 1);
4539 create_announced_chan_between_nodes(&nodes, 1, 2);
4541 // Rebalance somewhat
4542 send_payment(&nodes[0], &[&nodes[1]], 10_000_000);
4544 // First route two payments for testing at the end
4545 let payment_preimage_1 = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 1_000_000).0;
4546 let payment_preimage_2 = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 1_000_000).0;
4548 let local_txn = get_local_commitment_txn!(nodes[1], channel.2);
4549 assert_eq!(local_txn.len(), 1);
4550 let remote_txn = get_local_commitment_txn!(nodes[0], channel.2);
4551 assert_eq!(remote_txn.len(), 3); // Commitment and two HTLC-Timeouts
4552 check_spends!(remote_txn[1], remote_txn[0]);
4553 check_spends!(remote_txn[2], remote_txn[0]);
4554 let broadcast_tx = if use_local_txn { &local_txn[0] } else { &remote_txn[0] };
4556 // Connect a commitment transaction, but only to the ChainMonitor/ChannelMonitor. The
4557 // channel is now closed, but the ChannelManager doesn't know that yet.
4558 let new_header = create_dummy_header(nodes[0].best_block_info().0, 0);
4559 let conf_height = nodes[0].best_block_info().1 + 1;
4560 nodes[1].chain_monitor.chain_monitor.transactions_confirmed(&new_header,
4561 &[(0, broadcast_tx)], conf_height);
4563 let (_, pre_update_monitor) = <(BlockHash, ChannelMonitor<InMemorySigner>)>::read(
4564 &mut io::Cursor::new(&get_monitor!(nodes[1], channel.2).encode()),
4565 (&nodes[1].keys_manager.backing, &nodes[1].keys_manager.backing)).unwrap();
4567 // If the ChannelManager tries to update the channel, however, the ChainMonitor will pass
4568 // the update through to the ChannelMonitor which will refuse it (as the channel is closed).
4569 let (route, payment_hash, _, payment_secret) = get_route_and_payment_hash!(nodes[1], nodes[0], 100_000);
4570 unwrap_send_err!(nodes[1].node.send_payment_with_route(&route, payment_hash,
4571 RecipientOnionFields::secret_only(payment_secret), PaymentId(payment_hash.0)
4572 ), false, APIError::MonitorUpdateInProgress, {});
4573 check_added_monitors!(nodes[1], 1);
4575 // Build a new ChannelMonitorUpdate which contains both the failing commitment tx update
4576 // and provides the claim preimages for the two pending HTLCs. The first update generates
4577 // an error, but the point of this test is to ensure the later updates are still applied.
4578 let monitor_updates = nodes[1].chain_monitor.monitor_updates.lock().unwrap();
4579 let mut replay_update = monitor_updates.get(&channel.2).unwrap().iter().rev().next().unwrap().clone();
4580 assert_eq!(replay_update.updates.len(), 1);
4581 if let ChannelMonitorUpdateStep::LatestCounterpartyCommitmentTXInfo { .. } = replay_update.updates[0] {
4582 } else { panic!(); }
4583 replay_update.updates.push(ChannelMonitorUpdateStep::PaymentPreimage { payment_preimage: payment_preimage_1 });
4584 replay_update.updates.push(ChannelMonitorUpdateStep::PaymentPreimage { payment_preimage: payment_preimage_2 });
4586 let broadcaster = TestBroadcaster::with_blocks(Arc::clone(&nodes[1].blocks));
4588 pre_update_monitor.update_monitor(&replay_update, &&broadcaster, &&chanmon_cfgs[1].fee_estimator, &nodes[1].logger)
4590 // Even though we error'd on the first update, we should still have generated an HTLC claim
4592 let txn_broadcasted = broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
4593 assert!(txn_broadcasted.len() >= 2);
4594 let htlc_txn = txn_broadcasted.iter().filter(|tx| {
4595 assert_eq!(tx.input.len(), 1);
4596 tx.input[0].previous_output.txid == broadcast_tx.txid()
4597 }).collect::<Vec<_>>();
4598 assert_eq!(htlc_txn.len(), 2);
4599 check_spends!(htlc_txn[0], broadcast_tx);
4600 check_spends!(htlc_txn[1], broadcast_tx);
4603 fn test_funding_spend_refuses_updates() {
4604 do_test_funding_spend_refuses_updates(true);
4605 do_test_funding_spend_refuses_updates(false);
4609 fn test_prune_preimages() {
4610 let secp_ctx = Secp256k1::new();
4611 let logger = Arc::new(TestLogger::new());
4612 let broadcaster = Arc::new(TestBroadcaster::new(Network::Testnet));
4613 let fee_estimator = TestFeeEstimator { sat_per_kw: Mutex::new(253) };
4615 let dummy_key = PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[42; 32]).unwrap());
4617 let mut preimages = Vec::new();
4620 let preimage = PaymentPreimage([i; 32]);
4621 let hash = PaymentHash(Sha256::hash(&preimage.0[..]).to_byte_array());
4622 preimages.push((preimage, hash));
4626 macro_rules! preimages_slice_to_htlcs {
4627 ($preimages_slice: expr) => {
4629 let mut res = Vec::new();
4630 for (idx, preimage) in $preimages_slice.iter().enumerate() {
4631 res.push((HTLCOutputInCommitment {
4635 payment_hash: preimage.1.clone(),
4636 transaction_output_index: Some(idx as u32),
4643 macro_rules! preimages_slice_to_htlc_outputs {
4644 ($preimages_slice: expr) => {
4645 preimages_slice_to_htlcs!($preimages_slice).into_iter().map(|(htlc, _)| (htlc, None)).collect()
4648 let dummy_sig = crate::util::crypto::sign(&secp_ctx,
4649 &bitcoin::secp256k1::Message::from_slice(&[42; 32]).unwrap(),
4650 &SecretKey::from_slice(&[42; 32]).unwrap());
4652 macro_rules! test_preimages_exist {
4653 ($preimages_slice: expr, $monitor: expr) => {
4654 for preimage in $preimages_slice {
4655 assert!($monitor.inner.lock().unwrap().payment_preimages.contains_key(&preimage.1));
4660 let keys = InMemorySigner::new(
4662 SecretKey::from_slice(&[41; 32]).unwrap(),
4663 SecretKey::from_slice(&[41; 32]).unwrap(),
4664 SecretKey::from_slice(&[41; 32]).unwrap(),
4665 SecretKey::from_slice(&[41; 32]).unwrap(),
4666 SecretKey::from_slice(&[41; 32]).unwrap(),
4673 let counterparty_pubkeys = ChannelPublicKeys {
4674 funding_pubkey: PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[44; 32]).unwrap()),
4675 revocation_basepoint: RevocationBasepoint::from(PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[45; 32]).unwrap())),
4676 payment_point: PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[46; 32]).unwrap()),
4677 delayed_payment_basepoint: DelayedPaymentBasepoint::from(PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[47; 32]).unwrap())),
4678 htlc_basepoint: HtlcBasepoint::from(PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[48; 32]).unwrap()))
4680 let funding_outpoint = OutPoint { txid: Txid::all_zeros(), index: u16::max_value() };
4681 let channel_parameters = ChannelTransactionParameters {
4682 holder_pubkeys: keys.holder_channel_pubkeys.clone(),
4683 holder_selected_contest_delay: 66,
4684 is_outbound_from_holder: true,
4685 counterparty_parameters: Some(CounterpartyChannelTransactionParameters {
4686 pubkeys: counterparty_pubkeys,
4687 selected_contest_delay: 67,
4689 funding_outpoint: Some(funding_outpoint),
4690 channel_type_features: ChannelTypeFeatures::only_static_remote_key()
4692 // Prune with one old state and a holder commitment tx holding a few overlaps with the
4694 let shutdown_pubkey = PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[42; 32]).unwrap());
4695 let best_block = BestBlock::from_network(Network::Testnet);
4696 let monitor = ChannelMonitor::new(Secp256k1::new(), keys,
4697 Some(ShutdownScript::new_p2wpkh_from_pubkey(shutdown_pubkey).into_inner()), 0, &ScriptBuf::new(),
4698 (OutPoint { txid: Txid::from_slice(&[43; 32]).unwrap(), index: 0 }, ScriptBuf::new()),
4699 &channel_parameters, ScriptBuf::new(), 46, 0, HolderCommitmentTransaction::dummy(&mut Vec::new()),
4700 best_block, dummy_key);
4702 let mut htlcs = preimages_slice_to_htlcs!(preimages[0..10]);
4703 let dummy_commitment_tx = HolderCommitmentTransaction::dummy(&mut htlcs);
4704 monitor.provide_latest_holder_commitment_tx(dummy_commitment_tx.clone(),
4705 htlcs.into_iter().map(|(htlc, _)| (htlc, Some(dummy_sig), None)).collect()).unwrap();
4706 monitor.provide_latest_counterparty_commitment_tx(Txid::from_byte_array(Sha256::hash(b"1").to_byte_array()),
4707 preimages_slice_to_htlc_outputs!(preimages[5..15]), 281474976710655, dummy_key, &logger);
4708 monitor.provide_latest_counterparty_commitment_tx(Txid::from_byte_array(Sha256::hash(b"2").to_byte_array()),
4709 preimages_slice_to_htlc_outputs!(preimages[15..20]), 281474976710654, dummy_key, &logger);
4710 for &(ref preimage, ref hash) in preimages.iter() {
4711 let bounded_fee_estimator = LowerBoundedFeeEstimator::new(&fee_estimator);
4712 monitor.provide_payment_preimage(hash, preimage, &broadcaster, &bounded_fee_estimator, &logger);
4715 // Now provide a secret, pruning preimages 10-15
4716 let mut secret = [0; 32];
4717 secret[0..32].clone_from_slice(&<Vec<u8>>::from_hex("7cc854b54e3e0dcdb010d7a3fee464a9687be6e8db3be6854c475621e007a5dc").unwrap());
4718 monitor.provide_secret(281474976710655, secret.clone()).unwrap();
4719 assert_eq!(monitor.inner.lock().unwrap().payment_preimages.len(), 15);
4720 test_preimages_exist!(&preimages[0..10], monitor);
4721 test_preimages_exist!(&preimages[15..20], monitor);
4723 monitor.provide_latest_counterparty_commitment_tx(Txid::from_byte_array(Sha256::hash(b"3").to_byte_array()),
4724 preimages_slice_to_htlc_outputs!(preimages[17..20]), 281474976710653, dummy_key, &logger);
4726 // Now provide a further secret, pruning preimages 15-17
4727 secret[0..32].clone_from_slice(&<Vec<u8>>::from_hex("c7518c8ae4660ed02894df8976fa1a3659c1a8b4b5bec0c4b872abeba4cb8964").unwrap());
4728 monitor.provide_secret(281474976710654, secret.clone()).unwrap();
4729 assert_eq!(monitor.inner.lock().unwrap().payment_preimages.len(), 13);
4730 test_preimages_exist!(&preimages[0..10], monitor);
4731 test_preimages_exist!(&preimages[17..20], monitor);
4733 monitor.provide_latest_counterparty_commitment_tx(Txid::from_byte_array(Sha256::hash(b"4").to_byte_array()),
4734 preimages_slice_to_htlc_outputs!(preimages[18..20]), 281474976710652, dummy_key, &logger);
4736 // Now update holder commitment tx info, pruning only element 18 as we still care about the
4737 // previous commitment tx's preimages too
4738 let mut htlcs = preimages_slice_to_htlcs!(preimages[0..5]);
4739 let dummy_commitment_tx = HolderCommitmentTransaction::dummy(&mut htlcs);
4740 monitor.provide_latest_holder_commitment_tx(dummy_commitment_tx.clone(),
4741 htlcs.into_iter().map(|(htlc, _)| (htlc, Some(dummy_sig), None)).collect()).unwrap();
4742 secret[0..32].clone_from_slice(&<Vec<u8>>::from_hex("2273e227a5b7449b6e70f1fb4652864038b1cbf9cd7c043a7d6456b7fc275ad8").unwrap());
4743 monitor.provide_secret(281474976710653, secret.clone()).unwrap();
4744 assert_eq!(monitor.inner.lock().unwrap().payment_preimages.len(), 12);
4745 test_preimages_exist!(&preimages[0..10], monitor);
4746 test_preimages_exist!(&preimages[18..20], monitor);
4748 // But if we do it again, we'll prune 5-10
4749 let mut htlcs = preimages_slice_to_htlcs!(preimages[0..3]);
4750 let dummy_commitment_tx = HolderCommitmentTransaction::dummy(&mut htlcs);
4751 monitor.provide_latest_holder_commitment_tx(dummy_commitment_tx,
4752 htlcs.into_iter().map(|(htlc, _)| (htlc, Some(dummy_sig), None)).collect()).unwrap();
4753 secret[0..32].clone_from_slice(&<Vec<u8>>::from_hex("27cddaa5624534cb6cb9d7da077cf2b22ab21e9b506fd4998a51d54502e99116").unwrap());
4754 monitor.provide_secret(281474976710652, secret.clone()).unwrap();
4755 assert_eq!(monitor.inner.lock().unwrap().payment_preimages.len(), 5);
4756 test_preimages_exist!(&preimages[0..5], monitor);
4760 fn test_claim_txn_weight_computation() {
4761 // We test Claim txn weight, knowing that we want expected weigth and
4762 // not actual case to avoid sigs and time-lock delays hell variances.
4764 let secp_ctx = Secp256k1::new();
4765 let privkey = SecretKey::from_slice(&<Vec<u8>>::from_hex("0101010101010101010101010101010101010101010101010101010101010101").unwrap()[..]).unwrap();
4766 let pubkey = PublicKey::from_secret_key(&secp_ctx, &privkey);
4768 use crate::ln::channel_keys::{HtlcKey, HtlcBasepoint};
4769 macro_rules! sign_input {
4770 ($sighash_parts: expr, $idx: expr, $amount: expr, $weight: expr, $sum_actual_sigs: expr, $opt_anchors: expr) => {
4771 let htlc = HTLCOutputInCommitment {
4772 offered: if *$weight == weight_revoked_offered_htlc($opt_anchors) || *$weight == weight_offered_htlc($opt_anchors) { true } else { false },
4774 cltv_expiry: 2 << 16,
4775 payment_hash: PaymentHash([1; 32]),
4776 transaction_output_index: Some($idx as u32),
4778 let redeem_script = if *$weight == WEIGHT_REVOKED_OUTPUT { chan_utils::get_revokeable_redeemscript(&RevocationKey::from_basepoint(&secp_ctx, &RevocationBasepoint::from(pubkey), &pubkey), 256, &DelayedPaymentKey::from_basepoint(&secp_ctx, &DelayedPaymentBasepoint::from(pubkey), &pubkey)) } else { chan_utils::get_htlc_redeemscript_with_explicit_keys(&htlc, $opt_anchors, &HtlcKey::from_basepoint(&secp_ctx, &HtlcBasepoint::from(pubkey), &pubkey), &HtlcKey::from_basepoint(&secp_ctx, &HtlcBasepoint::from(pubkey), &pubkey), &RevocationKey::from_basepoint(&secp_ctx, &RevocationBasepoint::from(pubkey), &pubkey)) };
4779 let sighash = hash_to_message!(&$sighash_parts.segwit_signature_hash($idx, &redeem_script, $amount, EcdsaSighashType::All).unwrap()[..]);
4780 let sig = secp_ctx.sign_ecdsa(&sighash, &privkey);
4781 let mut ser_sig = sig.serialize_der().to_vec();
4782 ser_sig.push(EcdsaSighashType::All as u8);
4783 $sum_actual_sigs += ser_sig.len() as u64;
4784 let witness = $sighash_parts.witness_mut($idx).unwrap();
4785 witness.push(ser_sig);
4786 if *$weight == WEIGHT_REVOKED_OUTPUT {
4787 witness.push(vec!(1));
4788 } else if *$weight == weight_revoked_offered_htlc($opt_anchors) || *$weight == weight_revoked_received_htlc($opt_anchors) {
4789 witness.push(pubkey.clone().serialize().to_vec());
4790 } else if *$weight == weight_received_htlc($opt_anchors) {
4791 witness.push(vec![0]);
4793 witness.push(PaymentPreimage([1; 32]).0.to_vec());
4795 witness.push(redeem_script.into_bytes());
4796 let witness = witness.to_vec();
4797 println!("witness[0] {}", witness[0].len());
4798 println!("witness[1] {}", witness[1].len());
4799 println!("witness[2] {}", witness[2].len());
4803 let script_pubkey = Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script();
4804 let txid = Txid::from_str("56944c5d3f98413ef45cf54545538103cc9f298e0575820ad3591376e2e0f65d").unwrap();
4806 // Justice tx with 1 to_holder, 2 revoked offered HTLCs, 1 revoked received HTLCs
4807 for channel_type_features in [ChannelTypeFeatures::only_static_remote_key(), ChannelTypeFeatures::anchors_zero_htlc_fee_and_dependencies()].iter() {
4808 let mut claim_tx = Transaction { version: 0, lock_time: LockTime::ZERO, input: Vec::new(), output: Vec::new() };
4809 let mut sum_actual_sigs = 0;
4811 claim_tx.input.push(TxIn {
4812 previous_output: BitcoinOutPoint {
4816 script_sig: ScriptBuf::new(),
4817 sequence: Sequence::ENABLE_RBF_NO_LOCKTIME,
4818 witness: Witness::new(),
4821 claim_tx.output.push(TxOut {
4822 script_pubkey: script_pubkey.clone(),
4825 let base_weight = claim_tx.weight().to_wu();
4826 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)];
4827 let mut inputs_total_weight = 2; // count segwit flags
4829 let mut sighash_parts = sighash::SighashCache::new(&mut claim_tx);
4830 for (idx, inp) in inputs_weight.iter().enumerate() {
4831 sign_input!(sighash_parts, idx, 0, inp, sum_actual_sigs, channel_type_features);
4832 inputs_total_weight += inp;
4835 assert_eq!(base_weight + inputs_total_weight, claim_tx.weight().to_wu() + /* max_length_sig */ (73 * inputs_weight.len() as u64 - sum_actual_sigs));
4838 // Claim tx with 1 offered HTLCs, 3 received HTLCs
4839 for channel_type_features in [ChannelTypeFeatures::only_static_remote_key(), ChannelTypeFeatures::anchors_zero_htlc_fee_and_dependencies()].iter() {
4840 let mut claim_tx = Transaction { version: 0, lock_time: LockTime::ZERO, input: Vec::new(), output: Vec::new() };
4841 let mut sum_actual_sigs = 0;
4843 claim_tx.input.push(TxIn {
4844 previous_output: BitcoinOutPoint {
4848 script_sig: ScriptBuf::new(),
4849 sequence: Sequence::ENABLE_RBF_NO_LOCKTIME,
4850 witness: Witness::new(),
4853 claim_tx.output.push(TxOut {
4854 script_pubkey: script_pubkey.clone(),
4857 let base_weight = claim_tx.weight().to_wu();
4858 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)];
4859 let mut inputs_total_weight = 2; // count segwit flags
4861 let mut sighash_parts = sighash::SighashCache::new(&mut claim_tx);
4862 for (idx, inp) in inputs_weight.iter().enumerate() {
4863 sign_input!(sighash_parts, idx, 0, inp, sum_actual_sigs, channel_type_features);
4864 inputs_total_weight += inp;
4867 assert_eq!(base_weight + inputs_total_weight, claim_tx.weight().to_wu() + /* max_length_sig */ (73 * inputs_weight.len() as u64 - sum_actual_sigs));
4870 // Justice tx with 1 revoked HTLC-Success tx output
4871 for channel_type_features in [ChannelTypeFeatures::only_static_remote_key(), ChannelTypeFeatures::anchors_zero_htlc_fee_and_dependencies()].iter() {
4872 let mut claim_tx = Transaction { version: 0, lock_time: LockTime::ZERO, input: Vec::new(), output: Vec::new() };
4873 let mut sum_actual_sigs = 0;
4874 claim_tx.input.push(TxIn {
4875 previous_output: BitcoinOutPoint {
4879 script_sig: ScriptBuf::new(),
4880 sequence: Sequence::ENABLE_RBF_NO_LOCKTIME,
4881 witness: Witness::new(),
4883 claim_tx.output.push(TxOut {
4884 script_pubkey: script_pubkey.clone(),
4887 let base_weight = claim_tx.weight().to_wu();
4888 let inputs_weight = vec![WEIGHT_REVOKED_OUTPUT];
4889 let mut inputs_total_weight = 2; // count segwit flags
4891 let mut sighash_parts = sighash::SighashCache::new(&mut claim_tx);
4892 for (idx, inp) in inputs_weight.iter().enumerate() {
4893 sign_input!(sighash_parts, idx, 0, inp, sum_actual_sigs, channel_type_features);
4894 inputs_total_weight += inp;
4897 assert_eq!(base_weight + inputs_total_weight, claim_tx.weight().to_wu() + /* max_length_isg */ (73 * inputs_weight.len() as u64 - sum_actual_sigs));
4901 // Further testing is done in the ChannelManager integration tests.