1 // This file is Copyright its original authors, visible in version control
4 // This file is licensed under the Apache License, Version 2.0 <LICENSE-APACHE
5 // or http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
6 // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your option.
7 // You may not use this file except in accordance with one or both of these
10 //! The logic to monitor for on-chain transactions and create the relevant claim responses lives
13 //! ChannelMonitor objects are generated by ChannelManager in response to relevant
14 //! messages/actions, and MUST be persisted to disk (and, preferably, remotely) before progress can
15 //! be made in responding to certain messages, see [`chain::Watch`] for more.
17 //! Note that ChannelMonitors are an important part of the lightning trust model and a copy of the
18 //! latest ChannelMonitor must always be actively monitoring for chain updates (and no out-of-date
19 //! ChannelMonitors should do so). Thus, if you're building rust-lightning into an HSM or other
20 //! security-domain-separated system design, you should consider having multiple paths for
21 //! ChannelMonitors to get out of the HSM and onto monitoring devices.
23 use bitcoin::blockdata::block::BlockHeader;
24 use bitcoin::blockdata::transaction::{OutPoint as BitcoinOutPoint, TxOut, Transaction};
25 use bitcoin::blockdata::script::{Script, Builder};
26 use bitcoin::blockdata::opcodes;
28 use bitcoin::hashes::Hash;
29 use bitcoin::hashes::sha256::Hash as Sha256;
30 use bitcoin::hash_types::{Txid, BlockHash, WPubkeyHash};
32 use bitcoin::secp256k1::{Secp256k1, ecdsa::Signature};
33 use bitcoin::secp256k1::{SecretKey, PublicKey};
34 use bitcoin::secp256k1;
36 use crate::ln::{PaymentHash, PaymentPreimage};
37 use crate::ln::msgs::DecodeError;
38 use crate::ln::chan_utils;
39 use crate::ln::chan_utils::{CounterpartyCommitmentSecrets, HTLCOutputInCommitment, HTLCClaim, ChannelTransactionParameters, HolderCommitmentTransaction};
40 use crate::ln::channelmanager::{HTLCSource, SentHTLCId};
42 use crate::chain::{BestBlock, WatchedOutput};
43 use crate::chain::chaininterface::{BroadcasterInterface, FeeEstimator, LowerBoundedFeeEstimator};
44 use crate::chain::transaction::{OutPoint, TransactionData};
45 use crate::chain::keysinterface::{SpendableOutputDescriptor, StaticPaymentOutputDescriptor, DelayedPaymentOutputDescriptor, WriteableEcdsaChannelSigner, SignerProvider, EntropySource};
47 use crate::chain::onchaintx::ClaimEvent;
48 use crate::chain::onchaintx::OnchainTxHandler;
49 use crate::chain::package::{CounterpartyOfferedHTLCOutput, CounterpartyReceivedHTLCOutput, HolderFundingOutput, HolderHTLCOutput, PackageSolvingData, PackageTemplate, RevokedOutput, RevokedHTLCOutput};
50 use crate::chain::Filter;
51 use crate::util::logger::Logger;
52 use crate::util::ser::{Readable, ReadableArgs, RequiredWrapper, MaybeReadable, UpgradableRequired, Writer, Writeable, U48};
53 use crate::util::byte_utils;
54 use crate::events::Event;
56 use crate::events::bump_transaction::{AnchorDescriptor, HTLCDescriptor, BumpTransactionEvent};
58 use crate::prelude::*;
60 use crate::io::{self, Error};
61 use core::convert::TryInto;
63 use crate::sync::{Mutex, LockTestExt};
65 /// An update generated by the underlying channel itself which contains some new information the
66 /// [`ChannelMonitor`] should be made aware of.
68 /// Because this represents only a small number of updates to the underlying state, it is generally
69 /// much smaller than a full [`ChannelMonitor`]. However, for large single commitment transaction
70 /// updates (e.g. ones during which there are hundreds of HTLCs pending on the commitment
71 /// transaction), a single update may reach upwards of 1 MiB in serialized size.
72 #[derive(Clone, PartialEq, Eq)]
74 pub struct ChannelMonitorUpdate {
75 pub(crate) updates: Vec<ChannelMonitorUpdateStep>,
76 /// The sequence number of this update. Updates *must* be replayed in-order according to this
77 /// sequence number (and updates may panic if they are not). The update_id values are strictly
78 /// increasing and increase by one for each new update, with two exceptions specified below.
80 /// This sequence number is also used to track up to which points updates which returned
81 /// [`ChannelMonitorUpdateStatus::InProgress`] have been applied to all copies of a given
82 /// ChannelMonitor when ChannelManager::channel_monitor_updated is called.
84 /// The only instances we allow where update_id values are not strictly increasing have a
85 /// special update ID of [`CLOSED_CHANNEL_UPDATE_ID`]. This update ID is used for updates that
86 /// will force close the channel by broadcasting the latest commitment transaction or
87 /// special post-force-close updates, like providing preimages necessary to claim outputs on the
88 /// broadcast commitment transaction. See its docs for more details.
90 /// [`ChannelMonitorUpdateStatus::InProgress`]: super::ChannelMonitorUpdateStatus::InProgress
94 /// The update ID used for a [`ChannelMonitorUpdate`] that is either:
96 /// (1) attempting to force close the channel by broadcasting our latest commitment transaction or
97 /// (2) providing a preimage (after the channel has been force closed) from a forward link that
98 /// allows us to spend an HTLC output on this channel's (the backward link's) broadcasted
99 /// commitment transaction.
101 /// No other [`ChannelMonitorUpdate`]s are allowed after force-close.
102 pub const CLOSED_CHANNEL_UPDATE_ID: u64 = core::u64::MAX;
104 impl Writeable for ChannelMonitorUpdate {
105 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
106 write_ver_prefix!(w, SERIALIZATION_VERSION, MIN_SERIALIZATION_VERSION);
107 self.update_id.write(w)?;
108 (self.updates.len() as u64).write(w)?;
109 for update_step in self.updates.iter() {
110 update_step.write(w)?;
112 write_tlv_fields!(w, {});
116 impl Readable for ChannelMonitorUpdate {
117 fn read<R: io::Read>(r: &mut R) -> Result<Self, DecodeError> {
118 let _ver = read_ver_prefix!(r, SERIALIZATION_VERSION);
119 let update_id: u64 = Readable::read(r)?;
120 let len: u64 = Readable::read(r)?;
121 let mut updates = Vec::with_capacity(cmp::min(len as usize, MAX_ALLOC_SIZE / ::core::mem::size_of::<ChannelMonitorUpdateStep>()));
123 if let Some(upd) = MaybeReadable::read(r)? {
127 read_tlv_fields!(r, {});
128 Ok(Self { update_id, updates })
132 /// An event to be processed by the ChannelManager.
133 #[derive(Clone, PartialEq, Eq)]
134 pub enum MonitorEvent {
135 /// A monitor event containing an HTLCUpdate.
136 HTLCEvent(HTLCUpdate),
138 /// A monitor event that the Channel's commitment transaction was confirmed.
139 CommitmentTxConfirmed(OutPoint),
141 /// Indicates a [`ChannelMonitor`] update has completed. See
142 /// [`ChannelMonitorUpdateStatus::InProgress`] for more information on how this is used.
144 /// [`ChannelMonitorUpdateStatus::InProgress`]: super::ChannelMonitorUpdateStatus::InProgress
146 /// The funding outpoint of the [`ChannelMonitor`] that was updated
147 funding_txo: OutPoint,
148 /// The Update ID from [`ChannelMonitorUpdate::update_id`] which was applied or
149 /// [`ChannelMonitor::get_latest_update_id`].
151 /// Note that this should only be set to a given update's ID if all previous updates for the
152 /// same [`ChannelMonitor`] have been applied and persisted.
153 monitor_update_id: u64,
156 /// Indicates a [`ChannelMonitor`] update has failed. See
157 /// [`ChannelMonitorUpdateStatus::PermanentFailure`] for more information on how this is used.
159 /// [`ChannelMonitorUpdateStatus::PermanentFailure`]: super::ChannelMonitorUpdateStatus::PermanentFailure
160 UpdateFailed(OutPoint),
162 impl_writeable_tlv_based_enum_upgradable!(MonitorEvent,
163 // Note that Completed and UpdateFailed are currently never serialized to disk as they are
164 // generated only in ChainMonitor
166 (0, funding_txo, required),
167 (2, monitor_update_id, required),
171 (4, CommitmentTxConfirmed),
175 /// Simple structure sent back by `chain::Watch` when an HTLC from a forward channel is detected on
176 /// chain. Used to update the corresponding HTLC in the backward channel. Failing to pass the
177 /// preimage claim backward will lead to loss of funds.
178 #[derive(Clone, PartialEq, Eq)]
179 pub struct HTLCUpdate {
180 pub(crate) payment_hash: PaymentHash,
181 pub(crate) payment_preimage: Option<PaymentPreimage>,
182 pub(crate) source: HTLCSource,
183 pub(crate) htlc_value_satoshis: Option<u64>,
185 impl_writeable_tlv_based!(HTLCUpdate, {
186 (0, payment_hash, required),
187 (1, htlc_value_satoshis, option),
188 (2, source, required),
189 (4, payment_preimage, option),
192 /// If an HTLC expires within this many blocks, don't try to claim it in a shared transaction,
193 /// instead claiming it in its own individual transaction.
194 pub(crate) const CLTV_SHARED_CLAIM_BUFFER: u32 = 12;
195 /// If an HTLC expires within this many blocks, force-close the channel to broadcast the
196 /// HTLC-Success transaction.
197 /// In other words, this is an upper bound on how many blocks we think it can take us to get a
198 /// transaction confirmed (and we use it in a few more, equivalent, places).
199 pub(crate) const CLTV_CLAIM_BUFFER: u32 = 18;
200 /// Number of blocks by which point we expect our counterparty to have seen new blocks on the
201 /// network and done a full update_fail_htlc/commitment_signed dance (+ we've updated all our
202 /// copies of ChannelMonitors, including watchtowers). We could enforce the contract by failing
203 /// at CLTV expiration height but giving a grace period to our peer may be profitable for us if he
204 /// can provide an over-late preimage. Nevertheless, grace period has to be accounted in our
205 /// CLTV_EXPIRY_DELTA to be secure. Following this policy we may decrease the rate of channel failures
206 /// due to expiration but increase the cost of funds being locked longuer in case of failure.
207 /// This delay also cover a low-power peer being slow to process blocks and so being behind us on
208 /// accurate block height.
209 /// In case of onchain failure to be pass backward we may see the last block of ANTI_REORG_DELAY
210 /// with at worst this delay, so we are not only using this value as a mercy for them but also
211 /// us as a safeguard to delay with enough time.
212 pub(crate) const LATENCY_GRACE_PERIOD_BLOCKS: u32 = 3;
213 /// Number of blocks we wait on seeing a HTLC output being solved before we fail corresponding
214 /// inbound HTLCs. This prevents us from failing backwards and then getting a reorg resulting in us
217 /// Note that this is a library-wide security assumption. If a reorg deeper than this number of
218 /// blocks occurs, counterparties may be able to steal funds or claims made by and balances exposed
219 /// by a [`ChannelMonitor`] may be incorrect.
220 // We also use this delay to be sure we can remove our in-flight claim txn from bump candidates buffer.
221 // It may cause spurious generation of bumped claim txn but that's alright given the outpoint is already
222 // solved by a previous claim tx. What we want to avoid is reorg evicting our claim tx and us not
223 // keep bumping another claim tx to solve the outpoint.
224 pub const ANTI_REORG_DELAY: u32 = 6;
225 /// Number of blocks before confirmation at which we fail back an un-relayed HTLC or at which we
226 /// refuse to accept a new HTLC.
228 /// This is used for a few separate purposes:
229 /// 1) if we've received an MPP HTLC to us and it expires within this many blocks and we are
230 /// waiting on additional parts (or waiting on the preimage for any HTLC from the user), we will
232 /// 2) if we receive an HTLC within this many blocks of its expiry (plus one to avoid a race
233 /// condition with the above), we will fail this HTLC without telling the user we received it,
235 /// (1) is all about protecting us - we need enough time to update the channel state before we hit
236 /// CLTV_CLAIM_BUFFER, at which point we'd go on chain to claim the HTLC with the preimage.
238 /// (2) is the same, but with an additional buffer to avoid accepting an HTLC which is immediately
239 /// in a race condition between the user connecting a block (which would fail it) and the user
240 /// providing us the preimage (which would claim it).
241 pub(crate) const HTLC_FAIL_BACK_BUFFER: u32 = CLTV_CLAIM_BUFFER + LATENCY_GRACE_PERIOD_BLOCKS;
243 // TODO(devrandom) replace this with HolderCommitmentTransaction
244 #[derive(Clone, PartialEq, Eq)]
245 struct HolderSignedTx {
246 /// txid of the transaction in tx, just used to make comparison faster
248 revocation_key: PublicKey,
249 a_htlc_key: PublicKey,
250 b_htlc_key: PublicKey,
251 delayed_payment_key: PublicKey,
252 per_commitment_point: PublicKey,
253 htlc_outputs: Vec<(HTLCOutputInCommitment, Option<Signature>, Option<HTLCSource>)>,
254 to_self_value_sat: u64,
257 impl_writeable_tlv_based!(HolderSignedTx, {
259 // Note that this is filled in with data from OnchainTxHandler if it's missing.
260 // For HolderSignedTx objects serialized with 0.0.100+, this should be filled in.
261 (1, to_self_value_sat, (default_value, u64::max_value())),
262 (2, revocation_key, required),
263 (4, a_htlc_key, required),
264 (6, b_htlc_key, required),
265 (8, delayed_payment_key, required),
266 (10, per_commitment_point, required),
267 (12, feerate_per_kw, required),
268 (14, htlc_outputs, vec_type)
272 impl HolderSignedTx {
273 fn non_dust_htlcs(&self) -> Vec<HTLCOutputInCommitment> {
274 self.htlc_outputs.iter().filter_map(|(htlc, _, _)| {
275 if let Some(_) = htlc.transaction_output_index {
285 /// We use this to track static counterparty commitment transaction data and to generate any
286 /// justice or 2nd-stage preimage/timeout transactions.
287 #[derive(Clone, PartialEq, Eq)]
288 struct CounterpartyCommitmentParameters {
289 counterparty_delayed_payment_base_key: PublicKey,
290 counterparty_htlc_base_key: PublicKey,
291 on_counterparty_tx_csv: u16,
294 impl Writeable for CounterpartyCommitmentParameters {
295 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
296 w.write_all(&(0 as u64).to_be_bytes())?;
297 write_tlv_fields!(w, {
298 (0, self.counterparty_delayed_payment_base_key, required),
299 (2, self.counterparty_htlc_base_key, required),
300 (4, self.on_counterparty_tx_csv, required),
305 impl Readable for CounterpartyCommitmentParameters {
306 fn read<R: io::Read>(r: &mut R) -> Result<Self, DecodeError> {
307 let counterparty_commitment_transaction = {
308 // Versions prior to 0.0.100 had some per-HTLC state stored here, which is no longer
309 // used. Read it for compatibility.
310 let per_htlc_len: u64 = Readable::read(r)?;
311 for _ in 0..per_htlc_len {
312 let _txid: Txid = Readable::read(r)?;
313 let htlcs_count: u64 = Readable::read(r)?;
314 for _ in 0..htlcs_count {
315 let _htlc: HTLCOutputInCommitment = Readable::read(r)?;
319 let mut counterparty_delayed_payment_base_key = RequiredWrapper(None);
320 let mut counterparty_htlc_base_key = RequiredWrapper(None);
321 let mut on_counterparty_tx_csv: u16 = 0;
322 read_tlv_fields!(r, {
323 (0, counterparty_delayed_payment_base_key, required),
324 (2, counterparty_htlc_base_key, required),
325 (4, on_counterparty_tx_csv, required),
327 CounterpartyCommitmentParameters {
328 counterparty_delayed_payment_base_key: counterparty_delayed_payment_base_key.0.unwrap(),
329 counterparty_htlc_base_key: counterparty_htlc_base_key.0.unwrap(),
330 on_counterparty_tx_csv,
333 Ok(counterparty_commitment_transaction)
337 /// An entry for an [`OnchainEvent`], stating the block height and hash when the event was
338 /// observed, as well as the transaction causing it.
340 /// Used to determine when the on-chain event can be considered safe from a chain reorganization.
341 #[derive(Clone, PartialEq, Eq)]
342 struct OnchainEventEntry {
345 block_hash: Option<BlockHash>, // Added as optional, will be filled in for any entry generated on 0.0.113 or after
347 transaction: Option<Transaction>, // Added as optional, but always filled in, in LDK 0.0.110
350 impl OnchainEventEntry {
351 fn confirmation_threshold(&self) -> u32 {
352 let mut conf_threshold = self.height + ANTI_REORG_DELAY - 1;
354 OnchainEvent::MaturingOutput {
355 descriptor: SpendableOutputDescriptor::DelayedPaymentOutput(ref descriptor)
357 // A CSV'd transaction is confirmable in block (input height) + CSV delay, which means
358 // it's broadcastable when we see the previous block.
359 conf_threshold = cmp::max(conf_threshold, self.height + descriptor.to_self_delay as u32 - 1);
361 OnchainEvent::FundingSpendConfirmation { on_local_output_csv: Some(csv), .. } |
362 OnchainEvent::HTLCSpendConfirmation { on_to_local_output_csv: Some(csv), .. } => {
363 // A CSV'd transaction is confirmable in block (input height) + CSV delay, which means
364 // it's broadcastable when we see the previous block.
365 conf_threshold = cmp::max(conf_threshold, self.height + csv as u32 - 1);
372 fn has_reached_confirmation_threshold(&self, best_block: &BestBlock) -> bool {
373 best_block.height() >= self.confirmation_threshold()
377 /// The (output index, sats value) for the counterparty's output in a commitment transaction.
379 /// This was added as an `Option` in 0.0.110.
380 type CommitmentTxCounterpartyOutputInfo = Option<(u32, u64)>;
382 /// Upon discovering of some classes of onchain tx by ChannelMonitor, we may have to take actions on it
383 /// once they mature to enough confirmations (ANTI_REORG_DELAY)
384 #[derive(Clone, PartialEq, Eq)]
386 /// An outbound HTLC failing after a transaction is confirmed. Used
387 /// * when an outbound HTLC output is spent by us after the HTLC timed out
388 /// * an outbound HTLC which was not present in the commitment transaction which appeared
389 /// on-chain (either because it was not fully committed to or it was dust).
390 /// Note that this is *not* used for preimage claims, as those are passed upstream immediately,
391 /// appearing only as an `HTLCSpendConfirmation`, below.
394 payment_hash: PaymentHash,
395 htlc_value_satoshis: Option<u64>,
396 /// None in the second case, above, ie when there is no relevant output in the commitment
397 /// transaction which appeared on chain.
398 commitment_tx_output_idx: Option<u32>,
400 /// An output waiting on [`ANTI_REORG_DELAY`] confirmations before we hand the user the
401 /// [`SpendableOutputDescriptor`].
403 descriptor: SpendableOutputDescriptor,
405 /// A spend of the funding output, either a commitment transaction or a cooperative closing
407 FundingSpendConfirmation {
408 /// The CSV delay for the output of the funding spend transaction (implying it is a local
409 /// commitment transaction, and this is the delay on the to_self output).
410 on_local_output_csv: Option<u16>,
411 /// If the funding spend transaction was a known remote commitment transaction, we track
412 /// the output index and amount of the counterparty's `to_self` output here.
414 /// This allows us to generate a [`Balance::CounterpartyRevokedOutputClaimable`] for the
415 /// counterparty output.
416 commitment_tx_to_counterparty_output: CommitmentTxCounterpartyOutputInfo,
418 /// A spend of a commitment transaction HTLC output, set in the cases where *no* `HTLCUpdate`
419 /// is constructed. This is used when
420 /// * an outbound HTLC is claimed by our counterparty with a preimage, causing us to
421 /// immediately claim the HTLC on the inbound edge and track the resolution here,
422 /// * an inbound HTLC is claimed by our counterparty (with a timeout),
423 /// * an inbound HTLC is claimed by us (with a preimage).
424 /// * a revoked-state HTLC transaction was broadcasted, which was claimed by the revocation
426 /// * a revoked-state HTLC transaction was broadcasted, which was claimed by an
427 /// HTLC-Success/HTLC-Failure transaction (and is still claimable with a revocation
429 HTLCSpendConfirmation {
430 commitment_tx_output_idx: u32,
431 /// If the claim was made by either party with a preimage, this is filled in
432 preimage: Option<PaymentPreimage>,
433 /// If the claim was made by us on an inbound HTLC against a local commitment transaction,
434 /// we set this to the output CSV value which we will have to wait until to spend the
435 /// output (and generate a SpendableOutput event).
436 on_to_local_output_csv: Option<u16>,
440 impl Writeable for OnchainEventEntry {
441 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
442 write_tlv_fields!(writer, {
443 (0, self.txid, required),
444 (1, self.transaction, option),
445 (2, self.height, required),
446 (3, self.block_hash, option),
447 (4, self.event, required),
453 impl MaybeReadable for OnchainEventEntry {
454 fn read<R: io::Read>(reader: &mut R) -> Result<Option<Self>, DecodeError> {
455 let mut txid = Txid::all_zeros();
456 let mut transaction = None;
457 let mut block_hash = None;
459 let mut event = UpgradableRequired(None);
460 read_tlv_fields!(reader, {
462 (1, transaction, option),
463 (2, height, required),
464 (3, block_hash, option),
465 (4, event, upgradable_required),
467 Ok(Some(Self { txid, transaction, height, block_hash, event: _init_tlv_based_struct_field!(event, upgradable_required) }))
471 impl_writeable_tlv_based_enum_upgradable!(OnchainEvent,
473 (0, source, required),
474 (1, htlc_value_satoshis, option),
475 (2, payment_hash, required),
476 (3, commitment_tx_output_idx, option),
478 (1, MaturingOutput) => {
479 (0, descriptor, required),
481 (3, FundingSpendConfirmation) => {
482 (0, on_local_output_csv, option),
483 (1, commitment_tx_to_counterparty_output, option),
485 (5, HTLCSpendConfirmation) => {
486 (0, commitment_tx_output_idx, required),
487 (2, preimage, option),
488 (4, on_to_local_output_csv, option),
493 #[derive(Clone, PartialEq, Eq)]
494 pub(crate) enum ChannelMonitorUpdateStep {
495 LatestHolderCommitmentTXInfo {
496 commitment_tx: HolderCommitmentTransaction,
497 /// Note that LDK after 0.0.115 supports this only containing dust HTLCs (implying the
498 /// `Signature` field is never filled in). At that point, non-dust HTLCs are implied by the
499 /// HTLC fields in `commitment_tx` and the sources passed via `nondust_htlc_sources`.
500 htlc_outputs: Vec<(HTLCOutputInCommitment, Option<Signature>, Option<HTLCSource>)>,
501 claimed_htlcs: Vec<(SentHTLCId, PaymentPreimage)>,
502 nondust_htlc_sources: Vec<HTLCSource>,
504 LatestCounterpartyCommitmentTXInfo {
505 commitment_txid: Txid,
506 htlc_outputs: Vec<(HTLCOutputInCommitment, Option<Box<HTLCSource>>)>,
507 commitment_number: u64,
508 their_per_commitment_point: PublicKey,
511 payment_preimage: PaymentPreimage,
517 /// Used to indicate that the no future updates will occur, and likely that the latest holder
518 /// commitment transaction(s) should be broadcast, as the channel has been force-closed.
520 /// If set to false, we shouldn't broadcast the latest holder commitment transaction as we
521 /// think we've fallen behind!
522 should_broadcast: bool,
525 scriptpubkey: Script,
529 impl ChannelMonitorUpdateStep {
530 fn variant_name(&self) -> &'static str {
532 ChannelMonitorUpdateStep::LatestHolderCommitmentTXInfo { .. } => "LatestHolderCommitmentTXInfo",
533 ChannelMonitorUpdateStep::LatestCounterpartyCommitmentTXInfo { .. } => "LatestCounterpartyCommitmentTXInfo",
534 ChannelMonitorUpdateStep::PaymentPreimage { .. } => "PaymentPreimage",
535 ChannelMonitorUpdateStep::CommitmentSecret { .. } => "CommitmentSecret",
536 ChannelMonitorUpdateStep::ChannelForceClosed { .. } => "ChannelForceClosed",
537 ChannelMonitorUpdateStep::ShutdownScript { .. } => "ShutdownScript",
542 impl_writeable_tlv_based_enum_upgradable!(ChannelMonitorUpdateStep,
543 (0, LatestHolderCommitmentTXInfo) => {
544 (0, commitment_tx, required),
545 (1, claimed_htlcs, vec_type),
546 (2, htlc_outputs, vec_type),
547 (4, nondust_htlc_sources, optional_vec),
549 (1, LatestCounterpartyCommitmentTXInfo) => {
550 (0, commitment_txid, required),
551 (2, commitment_number, required),
552 (4, their_per_commitment_point, required),
553 (6, htlc_outputs, vec_type),
555 (2, PaymentPreimage) => {
556 (0, payment_preimage, required),
558 (3, CommitmentSecret) => {
560 (2, secret, required),
562 (4, ChannelForceClosed) => {
563 (0, should_broadcast, required),
565 (5, ShutdownScript) => {
566 (0, scriptpubkey, required),
570 /// Details about the balance(s) available for spending once the channel appears on chain.
572 /// See [`ChannelMonitor::get_claimable_balances`] for more details on when these will or will not
574 #[derive(Clone, Debug, PartialEq, Eq)]
575 #[cfg_attr(test, derive(PartialOrd, Ord))]
577 /// The channel is not yet closed (or the commitment or closing transaction has not yet
578 /// appeared in a block). The given balance is claimable (less on-chain fees) if the channel is
579 /// force-closed now.
580 ClaimableOnChannelClose {
581 /// The amount available to claim, in satoshis, excluding the on-chain fees which will be
582 /// required to do so.
583 claimable_amount_satoshis: u64,
585 /// The channel has been closed, and the given balance is ours but awaiting confirmations until
586 /// we consider it spendable.
587 ClaimableAwaitingConfirmations {
588 /// The amount available to claim, in satoshis, possibly excluding the on-chain fees which
589 /// were spent in broadcasting the transaction.
590 claimable_amount_satoshis: u64,
591 /// The height at which an [`Event::SpendableOutputs`] event will be generated for this
593 confirmation_height: u32,
595 /// The channel has been closed, and the given balance should be ours but awaiting spending
596 /// transaction confirmation. If the spending transaction does not confirm in time, it is
597 /// possible our counterparty can take the funds by broadcasting an HTLC timeout on-chain.
599 /// Once the spending transaction confirms, before it has reached enough confirmations to be
600 /// considered safe from chain reorganizations, the balance will instead be provided via
601 /// [`Balance::ClaimableAwaitingConfirmations`].
602 ContentiousClaimable {
603 /// The amount available to claim, in satoshis, excluding the on-chain fees which will be
604 /// required to do so.
605 claimable_amount_satoshis: u64,
606 /// The height at which the counterparty may be able to claim the balance if we have not
610 /// HTLCs which we sent to our counterparty which are claimable after a timeout (less on-chain
611 /// fees) if the counterparty does not know the preimage for the HTLCs. These are somewhat
612 /// likely to be claimed by our counterparty before we do.
613 MaybeTimeoutClaimableHTLC {
614 /// The amount potentially available to claim, in satoshis, excluding the on-chain fees
615 /// which will be required to do so.
616 claimable_amount_satoshis: u64,
617 /// The height at which we will be able to claim the balance if our counterparty has not
619 claimable_height: u32,
621 /// HTLCs which we received from our counterparty which are claimable with a preimage which we
622 /// do not currently have. This will only be claimable if we receive the preimage from the node
623 /// to which we forwarded this HTLC before the timeout.
624 MaybePreimageClaimableHTLC {
625 /// The amount potentially available to claim, in satoshis, excluding the on-chain fees
626 /// which will be required to do so.
627 claimable_amount_satoshis: u64,
628 /// The height at which our counterparty will be able to claim the balance if we have not
629 /// yet received the preimage and claimed it ourselves.
632 /// The channel has been closed, and our counterparty broadcasted a revoked commitment
635 /// Thus, we're able to claim all outputs in the commitment transaction, one of which has the
636 /// following amount.
637 CounterpartyRevokedOutputClaimable {
638 /// The amount, in satoshis, of the output which we can claim.
640 /// Note that for outputs from HTLC balances this may be excluding some on-chain fees that
641 /// were already spent.
642 claimable_amount_satoshis: u64,
646 /// An HTLC which has been irrevocably resolved on-chain, and has reached ANTI_REORG_DELAY.
647 #[derive(Clone, PartialEq, Eq)]
648 struct IrrevocablyResolvedHTLC {
649 commitment_tx_output_idx: Option<u32>,
650 /// The txid of the transaction which resolved the HTLC, this may be a commitment (if the HTLC
651 /// was not present in the confirmed commitment transaction), HTLC-Success, or HTLC-Timeout
653 resolving_txid: Option<Txid>, // Added as optional, but always filled in, in 0.0.110
654 resolving_tx: Option<Transaction>,
655 /// Only set if the HTLC claim was ours using a payment preimage
656 payment_preimage: Option<PaymentPreimage>,
659 // In LDK versions prior to 0.0.111 commitment_tx_output_idx was not Option-al and
660 // IrrevocablyResolvedHTLC objects only existed for non-dust HTLCs. This was a bug, but to maintain
661 // backwards compatibility we must ensure we always write out a commitment_tx_output_idx field,
662 // using `u32::max_value()` as a sentinal to indicate the HTLC was dust.
663 impl Writeable for IrrevocablyResolvedHTLC {
664 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
665 let mapped_commitment_tx_output_idx = self.commitment_tx_output_idx.unwrap_or(u32::max_value());
666 write_tlv_fields!(writer, {
667 (0, mapped_commitment_tx_output_idx, required),
668 (1, self.resolving_txid, option),
669 (2, self.payment_preimage, option),
670 (3, self.resolving_tx, option),
676 impl Readable for IrrevocablyResolvedHTLC {
677 fn read<R: io::Read>(reader: &mut R) -> Result<Self, DecodeError> {
678 let mut mapped_commitment_tx_output_idx = 0;
679 let mut resolving_txid = None;
680 let mut payment_preimage = None;
681 let mut resolving_tx = None;
682 read_tlv_fields!(reader, {
683 (0, mapped_commitment_tx_output_idx, required),
684 (1, resolving_txid, option),
685 (2, payment_preimage, option),
686 (3, resolving_tx, option),
689 commitment_tx_output_idx: if mapped_commitment_tx_output_idx == u32::max_value() { None } else { Some(mapped_commitment_tx_output_idx) },
697 /// A ChannelMonitor handles chain events (blocks connected and disconnected) and generates
698 /// on-chain transactions to ensure no loss of funds occurs.
700 /// You MUST ensure that no ChannelMonitors for a given channel anywhere contain out-of-date
701 /// information and are actively monitoring the chain.
703 /// Pending Events or updated HTLCs which have not yet been read out by
704 /// get_and_clear_pending_monitor_events or get_and_clear_pending_events are serialized to disk and
705 /// reloaded at deserialize-time. Thus, you must ensure that, when handling events, all events
706 /// gotten are fully handled before re-serializing the new state.
708 /// Note that the deserializer is only implemented for (BlockHash, ChannelMonitor), which
709 /// tells you the last block hash which was block_connect()ed. You MUST rescan any blocks along
710 /// the "reorg path" (ie disconnecting blocks until you find a common ancestor from both the
711 /// returned block hash and the the current chain and then reconnecting blocks to get to the
712 /// best chain) upon deserializing the object!
713 pub struct ChannelMonitor<Signer: WriteableEcdsaChannelSigner> {
715 pub(crate) inner: Mutex<ChannelMonitorImpl<Signer>>,
717 inner: Mutex<ChannelMonitorImpl<Signer>>,
720 impl<Signer: WriteableEcdsaChannelSigner> Clone for ChannelMonitor<Signer> {
721 fn clone(&self) -> Self {
722 Self { inner: Mutex::new(self.inner.lock().unwrap().clone()) }
726 #[derive(Clone, PartialEq)]
727 pub(crate) struct ChannelMonitorImpl<Signer: WriteableEcdsaChannelSigner> {
728 latest_update_id: u64,
729 commitment_transaction_number_obscure_factor: u64,
731 destination_script: Script,
732 broadcasted_holder_revokable_script: Option<(Script, PublicKey, PublicKey)>,
733 counterparty_payment_script: Script,
734 shutdown_script: Option<Script>,
736 channel_keys_id: [u8; 32],
737 holder_revocation_basepoint: PublicKey,
738 funding_info: (OutPoint, Script),
739 current_counterparty_commitment_txid: Option<Txid>,
740 prev_counterparty_commitment_txid: Option<Txid>,
742 counterparty_commitment_params: CounterpartyCommitmentParameters,
743 funding_redeemscript: Script,
744 channel_value_satoshis: u64,
745 // first is the idx of the first of the two per-commitment points
746 their_cur_per_commitment_points: Option<(u64, PublicKey, Option<PublicKey>)>,
748 on_holder_tx_csv: u16,
750 commitment_secrets: CounterpartyCommitmentSecrets,
751 /// The set of outpoints in each counterparty commitment transaction. We always need at least
752 /// the payment hash from `HTLCOutputInCommitment` to claim even a revoked commitment
753 /// transaction broadcast as we need to be able to construct the witness script in all cases.
754 counterparty_claimable_outpoints: HashMap<Txid, Vec<(HTLCOutputInCommitment, Option<Box<HTLCSource>>)>>,
755 /// We cannot identify HTLC-Success or HTLC-Timeout transactions by themselves on the chain.
756 /// Nor can we figure out their commitment numbers without the commitment transaction they are
757 /// spending. Thus, in order to claim them via revocation key, we track all the counterparty
758 /// commitment transactions which we find on-chain, mapping them to the commitment number which
759 /// can be used to derive the revocation key and claim the transactions.
760 counterparty_commitment_txn_on_chain: HashMap<Txid, u64>,
761 /// Cache used to make pruning of payment_preimages faster.
762 /// Maps payment_hash values to commitment numbers for counterparty transactions for non-revoked
763 /// counterparty transactions (ie should remain pretty small).
764 /// Serialized to disk but should generally not be sent to Watchtowers.
765 counterparty_hash_commitment_number: HashMap<PaymentHash, u64>,
767 counterparty_fulfilled_htlcs: HashMap<SentHTLCId, PaymentPreimage>,
769 // We store two holder commitment transactions to avoid any race conditions where we may update
770 // some monitors (potentially on watchtowers) but then fail to update others, resulting in the
771 // various monitors for one channel being out of sync, and us broadcasting a holder
772 // transaction for which we have deleted claim information on some watchtowers.
773 prev_holder_signed_commitment_tx: Option<HolderSignedTx>,
774 current_holder_commitment_tx: HolderSignedTx,
776 // Used just for ChannelManager to make sure it has the latest channel data during
778 current_counterparty_commitment_number: u64,
779 // Used just for ChannelManager to make sure it has the latest channel data during
781 current_holder_commitment_number: u64,
783 /// The set of payment hashes from inbound payments for which we know the preimage. Payment
784 /// preimages that are not included in any unrevoked local commitment transaction or unrevoked
785 /// remote commitment transactions are automatically removed when commitment transactions are
787 payment_preimages: HashMap<PaymentHash, PaymentPreimage>,
789 // Note that `MonitorEvent`s MUST NOT be generated during update processing, only generated
790 // during chain data processing. This prevents a race in `ChainMonitor::update_channel` (and
791 // presumably user implementations thereof as well) where we update the in-memory channel
792 // object, then before the persistence finishes (as it's all under a read-lock), we return
793 // pending events to the user or to the relevant `ChannelManager`. Then, on reload, we'll have
794 // the pre-event state here, but have processed the event in the `ChannelManager`.
795 // Note that because the `event_lock` in `ChainMonitor` is only taken in
796 // block/transaction-connected events and *not* during block/transaction-disconnected events,
797 // we further MUST NOT generate events during block/transaction-disconnection.
798 pending_monitor_events: Vec<MonitorEvent>,
800 pending_events: Vec<Event>,
802 // Used to track on-chain events (i.e., transactions part of channels confirmed on chain) on
803 // which to take actions once they reach enough confirmations. Each entry includes the
804 // transaction's id and the height when the transaction was confirmed on chain.
805 onchain_events_awaiting_threshold_conf: Vec<OnchainEventEntry>,
807 // If we get serialized out and re-read, we need to make sure that the chain monitoring
808 // interface knows about the TXOs that we want to be notified of spends of. We could probably
809 // be smart and derive them from the above storage fields, but its much simpler and more
810 // Obviously Correct (tm) if we just keep track of them explicitly.
811 outputs_to_watch: HashMap<Txid, Vec<(u32, Script)>>,
814 pub onchain_tx_handler: OnchainTxHandler<Signer>,
816 onchain_tx_handler: OnchainTxHandler<Signer>,
818 // This is set when the Channel[Manager] generated a ChannelMonitorUpdate which indicated the
819 // channel has been force-closed. After this is set, no further holder commitment transaction
820 // updates may occur, and we panic!() if one is provided.
821 lockdown_from_offchain: bool,
823 // Set once we've signed a holder commitment transaction and handed it over to our
824 // OnchainTxHandler. After this is set, no future updates to our holder commitment transactions
825 // may occur, and we fail any such monitor updates.
827 // In case of update rejection due to a locally already signed commitment transaction, we
828 // nevertheless store update content to track in case of concurrent broadcast by another
829 // remote monitor out-of-order with regards to the block view.
830 holder_tx_signed: bool,
832 // If a spend of the funding output is seen, we set this to true and reject any further
833 // updates. This prevents any further changes in the offchain state no matter the order
834 // of block connection between ChannelMonitors and the ChannelManager.
835 funding_spend_seen: bool,
837 /// Set to `Some` of the confirmed transaction spending the funding input of the channel after
838 /// reaching `ANTI_REORG_DELAY` confirmations.
839 funding_spend_confirmed: Option<Txid>,
841 confirmed_commitment_tx_counterparty_output: CommitmentTxCounterpartyOutputInfo,
842 /// The set of HTLCs which have been either claimed or failed on chain and have reached
843 /// the requisite confirmations on the claim/fail transaction (either ANTI_REORG_DELAY or the
844 /// spending CSV for revocable outputs).
845 htlcs_resolved_on_chain: Vec<IrrevocablyResolvedHTLC>,
847 /// The set of `SpendableOutput` events which we have already passed upstream to be claimed.
848 /// These are tracked explicitly to ensure that we don't generate the same events redundantly
849 /// if users duplicatively confirm old transactions. Specifically for transactions claiming a
850 /// revoked remote outpoint we otherwise have no tracking at all once they've reached
851 /// [`ANTI_REORG_DELAY`], so we have to track them here.
852 spendable_txids_confirmed: Vec<Txid>,
854 // We simply modify best_block in Channel's block_connected so that serialization is
855 // consistent but hopefully the users' copy handles block_connected in a consistent way.
856 // (we do *not*, however, update them in update_monitor to ensure any local user copies keep
857 // their best_block from its state and not based on updated copies that didn't run through
858 // the full block_connected).
859 best_block: BestBlock,
861 /// The node_id of our counterparty
862 counterparty_node_id: Option<PublicKey>,
865 /// Transaction outputs to watch for on-chain spends.
866 pub type TransactionOutputs = (Txid, Vec<(u32, TxOut)>);
868 impl<Signer: WriteableEcdsaChannelSigner> PartialEq for ChannelMonitor<Signer> where Signer: PartialEq {
869 fn eq(&self, other: &Self) -> bool {
870 // We need some kind of total lockorder. Absent a better idea, we sort by position in
871 // memory and take locks in that order (assuming that we can't move within memory while a
873 let ord = ((self as *const _) as usize) < ((other as *const _) as usize);
874 let a = if ord { self.inner.unsafe_well_ordered_double_lock_self() } else { other.inner.unsafe_well_ordered_double_lock_self() };
875 let b = if ord { other.inner.unsafe_well_ordered_double_lock_self() } else { self.inner.unsafe_well_ordered_double_lock_self() };
880 impl<Signer: WriteableEcdsaChannelSigner> Writeable for ChannelMonitor<Signer> {
881 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), Error> {
882 self.inner.lock().unwrap().write(writer)
886 // These are also used for ChannelMonitorUpdate, above.
887 const SERIALIZATION_VERSION: u8 = 1;
888 const MIN_SERIALIZATION_VERSION: u8 = 1;
890 impl<Signer: WriteableEcdsaChannelSigner> Writeable for ChannelMonitorImpl<Signer> {
891 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), Error> {
892 write_ver_prefix!(writer, SERIALIZATION_VERSION, MIN_SERIALIZATION_VERSION);
894 self.latest_update_id.write(writer)?;
896 // Set in initial Channel-object creation, so should always be set by now:
897 U48(self.commitment_transaction_number_obscure_factor).write(writer)?;
899 self.destination_script.write(writer)?;
900 if let Some(ref broadcasted_holder_revokable_script) = self.broadcasted_holder_revokable_script {
901 writer.write_all(&[0; 1])?;
902 broadcasted_holder_revokable_script.0.write(writer)?;
903 broadcasted_holder_revokable_script.1.write(writer)?;
904 broadcasted_holder_revokable_script.2.write(writer)?;
906 writer.write_all(&[1; 1])?;
909 self.counterparty_payment_script.write(writer)?;
910 match &self.shutdown_script {
911 Some(script) => script.write(writer)?,
912 None => Script::new().write(writer)?,
915 self.channel_keys_id.write(writer)?;
916 self.holder_revocation_basepoint.write(writer)?;
917 writer.write_all(&self.funding_info.0.txid[..])?;
918 writer.write_all(&self.funding_info.0.index.to_be_bytes())?;
919 self.funding_info.1.write(writer)?;
920 self.current_counterparty_commitment_txid.write(writer)?;
921 self.prev_counterparty_commitment_txid.write(writer)?;
923 self.counterparty_commitment_params.write(writer)?;
924 self.funding_redeemscript.write(writer)?;
925 self.channel_value_satoshis.write(writer)?;
927 match self.their_cur_per_commitment_points {
928 Some((idx, pubkey, second_option)) => {
929 writer.write_all(&byte_utils::be48_to_array(idx))?;
930 writer.write_all(&pubkey.serialize())?;
931 match second_option {
932 Some(second_pubkey) => {
933 writer.write_all(&second_pubkey.serialize())?;
936 writer.write_all(&[0; 33])?;
941 writer.write_all(&byte_utils::be48_to_array(0))?;
945 writer.write_all(&self.on_holder_tx_csv.to_be_bytes())?;
947 self.commitment_secrets.write(writer)?;
949 macro_rules! serialize_htlc_in_commitment {
950 ($htlc_output: expr) => {
951 writer.write_all(&[$htlc_output.offered as u8; 1])?;
952 writer.write_all(&$htlc_output.amount_msat.to_be_bytes())?;
953 writer.write_all(&$htlc_output.cltv_expiry.to_be_bytes())?;
954 writer.write_all(&$htlc_output.payment_hash.0[..])?;
955 $htlc_output.transaction_output_index.write(writer)?;
959 writer.write_all(&(self.counterparty_claimable_outpoints.len() as u64).to_be_bytes())?;
960 for (ref txid, ref htlc_infos) in self.counterparty_claimable_outpoints.iter() {
961 writer.write_all(&txid[..])?;
962 writer.write_all(&(htlc_infos.len() as u64).to_be_bytes())?;
963 for &(ref htlc_output, ref htlc_source) in htlc_infos.iter() {
964 debug_assert!(htlc_source.is_none() || Some(**txid) == self.current_counterparty_commitment_txid
965 || Some(**txid) == self.prev_counterparty_commitment_txid,
966 "HTLC Sources for all revoked commitment transactions should be none!");
967 serialize_htlc_in_commitment!(htlc_output);
968 htlc_source.as_ref().map(|b| b.as_ref()).write(writer)?;
972 writer.write_all(&(self.counterparty_commitment_txn_on_chain.len() as u64).to_be_bytes())?;
973 for (ref txid, commitment_number) in self.counterparty_commitment_txn_on_chain.iter() {
974 writer.write_all(&txid[..])?;
975 writer.write_all(&byte_utils::be48_to_array(*commitment_number))?;
978 writer.write_all(&(self.counterparty_hash_commitment_number.len() as u64).to_be_bytes())?;
979 for (ref payment_hash, commitment_number) in self.counterparty_hash_commitment_number.iter() {
980 writer.write_all(&payment_hash.0[..])?;
981 writer.write_all(&byte_utils::be48_to_array(*commitment_number))?;
984 if let Some(ref prev_holder_tx) = self.prev_holder_signed_commitment_tx {
985 writer.write_all(&[1; 1])?;
986 prev_holder_tx.write(writer)?;
988 writer.write_all(&[0; 1])?;
991 self.current_holder_commitment_tx.write(writer)?;
993 writer.write_all(&byte_utils::be48_to_array(self.current_counterparty_commitment_number))?;
994 writer.write_all(&byte_utils::be48_to_array(self.current_holder_commitment_number))?;
996 writer.write_all(&(self.payment_preimages.len() as u64).to_be_bytes())?;
997 for payment_preimage in self.payment_preimages.values() {
998 writer.write_all(&payment_preimage.0[..])?;
1001 writer.write_all(&(self.pending_monitor_events.iter().filter(|ev| match ev {
1002 MonitorEvent::HTLCEvent(_) => true,
1003 MonitorEvent::CommitmentTxConfirmed(_) => true,
1005 }).count() as u64).to_be_bytes())?;
1006 for event in self.pending_monitor_events.iter() {
1008 MonitorEvent::HTLCEvent(upd) => {
1012 MonitorEvent::CommitmentTxConfirmed(_) => 1u8.write(writer)?,
1013 _ => {}, // Covered in the TLV writes below
1017 writer.write_all(&(self.pending_events.len() as u64).to_be_bytes())?;
1018 for event in self.pending_events.iter() {
1019 event.write(writer)?;
1022 self.best_block.block_hash().write(writer)?;
1023 writer.write_all(&self.best_block.height().to_be_bytes())?;
1025 writer.write_all(&(self.onchain_events_awaiting_threshold_conf.len() as u64).to_be_bytes())?;
1026 for ref entry in self.onchain_events_awaiting_threshold_conf.iter() {
1027 entry.write(writer)?;
1030 (self.outputs_to_watch.len() as u64).write(writer)?;
1031 for (txid, idx_scripts) in self.outputs_to_watch.iter() {
1032 txid.write(writer)?;
1033 (idx_scripts.len() as u64).write(writer)?;
1034 for (idx, script) in idx_scripts.iter() {
1036 script.write(writer)?;
1039 self.onchain_tx_handler.write(writer)?;
1041 self.lockdown_from_offchain.write(writer)?;
1042 self.holder_tx_signed.write(writer)?;
1044 write_tlv_fields!(writer, {
1045 (1, self.funding_spend_confirmed, option),
1046 (3, self.htlcs_resolved_on_chain, vec_type),
1047 (5, self.pending_monitor_events, vec_type),
1048 (7, self.funding_spend_seen, required),
1049 (9, self.counterparty_node_id, option),
1050 (11, self.confirmed_commitment_tx_counterparty_output, option),
1051 (13, self.spendable_txids_confirmed, vec_type),
1052 (15, self.counterparty_fulfilled_htlcs, required),
1059 impl<Signer: WriteableEcdsaChannelSigner> ChannelMonitor<Signer> {
1060 /// For lockorder enforcement purposes, we need to have a single site which constructs the
1061 /// `inner` mutex, otherwise cases where we lock two monitors at the same time (eg in our
1062 /// PartialEq implementation) we may decide a lockorder violation has occurred.
1063 fn from_impl(imp: ChannelMonitorImpl<Signer>) -> Self {
1064 ChannelMonitor { inner: Mutex::new(imp) }
1067 pub(crate) fn new(secp_ctx: Secp256k1<secp256k1::All>, keys: Signer, shutdown_script: Option<Script>,
1068 on_counterparty_tx_csv: u16, destination_script: &Script, funding_info: (OutPoint, Script),
1069 channel_parameters: &ChannelTransactionParameters,
1070 funding_redeemscript: Script, channel_value_satoshis: u64,
1071 commitment_transaction_number_obscure_factor: u64,
1072 initial_holder_commitment_tx: HolderCommitmentTransaction,
1073 best_block: BestBlock, counterparty_node_id: PublicKey) -> ChannelMonitor<Signer> {
1075 assert!(commitment_transaction_number_obscure_factor <= (1 << 48));
1076 let payment_key_hash = WPubkeyHash::hash(&keys.pubkeys().payment_point.serialize());
1077 let counterparty_payment_script = Builder::new().push_opcode(opcodes::all::OP_PUSHBYTES_0).push_slice(&payment_key_hash[..]).into_script();
1079 let counterparty_channel_parameters = channel_parameters.counterparty_parameters.as_ref().unwrap();
1080 let counterparty_delayed_payment_base_key = counterparty_channel_parameters.pubkeys.delayed_payment_basepoint;
1081 let counterparty_htlc_base_key = counterparty_channel_parameters.pubkeys.htlc_basepoint;
1082 let counterparty_commitment_params = CounterpartyCommitmentParameters { counterparty_delayed_payment_base_key, counterparty_htlc_base_key, on_counterparty_tx_csv };
1084 let channel_keys_id = keys.channel_keys_id();
1085 let holder_revocation_basepoint = keys.pubkeys().revocation_basepoint;
1087 // block for Rust 1.34 compat
1088 let (holder_commitment_tx, current_holder_commitment_number) = {
1089 let trusted_tx = initial_holder_commitment_tx.trust();
1090 let txid = trusted_tx.txid();
1092 let tx_keys = trusted_tx.keys();
1093 let holder_commitment_tx = HolderSignedTx {
1095 revocation_key: tx_keys.revocation_key,
1096 a_htlc_key: tx_keys.broadcaster_htlc_key,
1097 b_htlc_key: tx_keys.countersignatory_htlc_key,
1098 delayed_payment_key: tx_keys.broadcaster_delayed_payment_key,
1099 per_commitment_point: tx_keys.per_commitment_point,
1100 htlc_outputs: Vec::new(), // There are never any HTLCs in the initial commitment transactions
1101 to_self_value_sat: initial_holder_commitment_tx.to_broadcaster_value_sat(),
1102 feerate_per_kw: trusted_tx.feerate_per_kw(),
1104 (holder_commitment_tx, trusted_tx.commitment_number())
1107 let onchain_tx_handler =
1108 OnchainTxHandler::new(destination_script.clone(), keys,
1109 channel_parameters.clone(), initial_holder_commitment_tx, secp_ctx);
1111 let mut outputs_to_watch = HashMap::new();
1112 outputs_to_watch.insert(funding_info.0.txid, vec![(funding_info.0.index as u32, funding_info.1.clone())]);
1114 Self::from_impl(ChannelMonitorImpl {
1115 latest_update_id: 0,
1116 commitment_transaction_number_obscure_factor,
1118 destination_script: destination_script.clone(),
1119 broadcasted_holder_revokable_script: None,
1120 counterparty_payment_script,
1124 holder_revocation_basepoint,
1126 current_counterparty_commitment_txid: None,
1127 prev_counterparty_commitment_txid: None,
1129 counterparty_commitment_params,
1130 funding_redeemscript,
1131 channel_value_satoshis,
1132 their_cur_per_commitment_points: None,
1134 on_holder_tx_csv: counterparty_channel_parameters.selected_contest_delay,
1136 commitment_secrets: CounterpartyCommitmentSecrets::new(),
1137 counterparty_claimable_outpoints: HashMap::new(),
1138 counterparty_commitment_txn_on_chain: HashMap::new(),
1139 counterparty_hash_commitment_number: HashMap::new(),
1140 counterparty_fulfilled_htlcs: HashMap::new(),
1142 prev_holder_signed_commitment_tx: None,
1143 current_holder_commitment_tx: holder_commitment_tx,
1144 current_counterparty_commitment_number: 1 << 48,
1145 current_holder_commitment_number,
1147 payment_preimages: HashMap::new(),
1148 pending_monitor_events: Vec::new(),
1149 pending_events: Vec::new(),
1151 onchain_events_awaiting_threshold_conf: Vec::new(),
1156 lockdown_from_offchain: false,
1157 holder_tx_signed: false,
1158 funding_spend_seen: false,
1159 funding_spend_confirmed: None,
1160 confirmed_commitment_tx_counterparty_output: None,
1161 htlcs_resolved_on_chain: Vec::new(),
1162 spendable_txids_confirmed: Vec::new(),
1165 counterparty_node_id: Some(counterparty_node_id),
1170 fn provide_secret(&self, idx: u64, secret: [u8; 32]) -> Result<(), &'static str> {
1171 self.inner.lock().unwrap().provide_secret(idx, secret)
1174 /// Informs this monitor of the latest counterparty (ie non-broadcastable) commitment transaction.
1175 /// The monitor watches for it to be broadcasted and then uses the HTLC information (and
1176 /// possibly future revocation/preimage information) to claim outputs where possible.
1177 /// We cache also the mapping hash:commitment number to lighten pruning of old preimages by watchtowers.
1178 pub(crate) fn provide_latest_counterparty_commitment_tx<L: Deref>(
1181 htlc_outputs: Vec<(HTLCOutputInCommitment, Option<Box<HTLCSource>>)>,
1182 commitment_number: u64,
1183 their_per_commitment_point: PublicKey,
1185 ) where L::Target: Logger {
1186 self.inner.lock().unwrap().provide_latest_counterparty_commitment_tx(
1187 txid, htlc_outputs, commitment_number, their_per_commitment_point, logger)
1191 fn provide_latest_holder_commitment_tx(
1192 &self, holder_commitment_tx: HolderCommitmentTransaction,
1193 htlc_outputs: Vec<(HTLCOutputInCommitment, Option<Signature>, Option<HTLCSource>)>,
1194 ) -> Result<(), ()> {
1195 self.inner.lock().unwrap().provide_latest_holder_commitment_tx(holder_commitment_tx, htlc_outputs, &Vec::new(), Vec::new()).map_err(|_| ())
1198 /// This is used to provide payment preimage(s) out-of-band during startup without updating the
1199 /// off-chain state with a new commitment transaction.
1200 pub(crate) fn provide_payment_preimage<B: Deref, F: Deref, L: Deref>(
1202 payment_hash: &PaymentHash,
1203 payment_preimage: &PaymentPreimage,
1205 fee_estimator: &LowerBoundedFeeEstimator<F>,
1208 B::Target: BroadcasterInterface,
1209 F::Target: FeeEstimator,
1212 self.inner.lock().unwrap().provide_payment_preimage(
1213 payment_hash, payment_preimage, broadcaster, fee_estimator, logger)
1216 /// Updates a ChannelMonitor on the basis of some new information provided by the Channel
1219 /// panics if the given update is not the next update by update_id.
1220 pub fn update_monitor<B: Deref, F: Deref, L: Deref>(
1222 updates: &ChannelMonitorUpdate,
1228 B::Target: BroadcasterInterface,
1229 F::Target: FeeEstimator,
1232 self.inner.lock().unwrap().update_monitor(updates, broadcaster, fee_estimator, logger)
1235 /// Gets the update_id from the latest ChannelMonitorUpdate which was applied to this
1237 pub fn get_latest_update_id(&self) -> u64 {
1238 self.inner.lock().unwrap().get_latest_update_id()
1241 /// Gets the funding transaction outpoint of the channel this ChannelMonitor is monitoring for.
1242 pub fn get_funding_txo(&self) -> (OutPoint, Script) {
1243 self.inner.lock().unwrap().get_funding_txo().clone()
1246 /// Gets a list of txids, with their output scripts (in the order they appear in the
1247 /// transaction), which we must learn about spends of via block_connected().
1248 pub fn get_outputs_to_watch(&self) -> Vec<(Txid, Vec<(u32, Script)>)> {
1249 self.inner.lock().unwrap().get_outputs_to_watch()
1250 .iter().map(|(txid, outputs)| (*txid, outputs.clone())).collect()
1253 /// Loads the funding txo and outputs to watch into the given `chain::Filter` by repeatedly
1254 /// calling `chain::Filter::register_output` and `chain::Filter::register_tx` until all outputs
1255 /// have been registered.
1256 pub fn load_outputs_to_watch<F: Deref>(&self, filter: &F) where F::Target: chain::Filter {
1257 let lock = self.inner.lock().unwrap();
1258 filter.register_tx(&lock.get_funding_txo().0.txid, &lock.get_funding_txo().1);
1259 for (txid, outputs) in lock.get_outputs_to_watch().iter() {
1260 for (index, script_pubkey) in outputs.iter() {
1261 assert!(*index <= u16::max_value() as u32);
1262 filter.register_output(WatchedOutput {
1264 outpoint: OutPoint { txid: *txid, index: *index as u16 },
1265 script_pubkey: script_pubkey.clone(),
1271 /// Get the list of HTLCs who's status has been updated on chain. This should be called by
1272 /// ChannelManager via [`chain::Watch::release_pending_monitor_events`].
1273 pub fn get_and_clear_pending_monitor_events(&self) -> Vec<MonitorEvent> {
1274 self.inner.lock().unwrap().get_and_clear_pending_monitor_events()
1277 /// Gets the list of pending events which were generated by previous actions, clearing the list
1280 /// This is called by the [`EventsProvider::process_pending_events`] implementation for
1281 /// [`ChainMonitor`].
1283 /// [`EventsProvider::process_pending_events`]: crate::events::EventsProvider::process_pending_events
1284 /// [`ChainMonitor`]: crate::chain::chainmonitor::ChainMonitor
1285 pub fn get_and_clear_pending_events(&self) -> Vec<Event> {
1286 self.inner.lock().unwrap().get_and_clear_pending_events()
1289 pub(crate) fn get_min_seen_secret(&self) -> u64 {
1290 self.inner.lock().unwrap().get_min_seen_secret()
1293 pub(crate) fn get_cur_counterparty_commitment_number(&self) -> u64 {
1294 self.inner.lock().unwrap().get_cur_counterparty_commitment_number()
1297 pub(crate) fn get_cur_holder_commitment_number(&self) -> u64 {
1298 self.inner.lock().unwrap().get_cur_holder_commitment_number()
1301 /// Gets the `node_id` of the counterparty for this channel.
1303 /// Will be `None` for channels constructed on LDK versions prior to 0.0.110 and always `Some`
1305 pub fn get_counterparty_node_id(&self) -> Option<PublicKey> {
1306 self.inner.lock().unwrap().counterparty_node_id
1309 /// Used by ChannelManager deserialization to broadcast the latest holder state if its copy of
1310 /// the Channel was out-of-date.
1312 /// You may also use this to broadcast the latest local commitment transaction, either because
1313 /// a monitor update failed with [`ChannelMonitorUpdateStatus::PermanentFailure`] or because we've
1314 /// fallen behind (i.e. we've received proof that our counterparty side knows a revocation
1315 /// secret we gave them that they shouldn't know).
1317 /// Broadcasting these transactions in the second case is UNSAFE, as they allow counterparty
1318 /// side to punish you. Nevertheless you may want to broadcast them if counterparty doesn't
1319 /// close channel with their commitment transaction after a substantial amount of time. Best
1320 /// may be to contact the other node operator out-of-band to coordinate other options available
1321 /// to you. In any-case, the choice is up to you.
1323 /// [`ChannelMonitorUpdateStatus::PermanentFailure`]: super::ChannelMonitorUpdateStatus::PermanentFailure
1324 pub fn get_latest_holder_commitment_txn<L: Deref>(&self, logger: &L) -> Vec<Transaction>
1325 where L::Target: Logger {
1326 self.inner.lock().unwrap().get_latest_holder_commitment_txn(logger)
1329 /// Unsafe test-only version of get_latest_holder_commitment_txn used by our test framework
1330 /// to bypass HolderCommitmentTransaction state update lockdown after signature and generate
1331 /// revoked commitment transaction.
1332 #[cfg(any(test, feature = "unsafe_revoked_tx_signing"))]
1333 pub fn unsafe_get_latest_holder_commitment_txn<L: Deref>(&self, logger: &L) -> Vec<Transaction>
1334 where L::Target: Logger {
1335 self.inner.lock().unwrap().unsafe_get_latest_holder_commitment_txn(logger)
1338 /// Processes transactions in a newly connected block, which may result in any of the following:
1339 /// - update the monitor's state against resolved HTLCs
1340 /// - punish the counterparty in the case of seeing a revoked commitment transaction
1341 /// - force close the channel and claim/timeout incoming/outgoing HTLCs if near expiration
1342 /// - detect settled outputs for later spending
1343 /// - schedule and bump any in-flight claims
1345 /// Returns any new outputs to watch from `txdata`; after called, these are also included in
1346 /// [`get_outputs_to_watch`].
1348 /// [`get_outputs_to_watch`]: #method.get_outputs_to_watch
1349 pub fn block_connected<B: Deref, F: Deref, L: Deref>(
1351 header: &BlockHeader,
1352 txdata: &TransactionData,
1357 ) -> Vec<TransactionOutputs>
1359 B::Target: BroadcasterInterface,
1360 F::Target: FeeEstimator,
1363 self.inner.lock().unwrap().block_connected(
1364 header, txdata, height, broadcaster, fee_estimator, logger)
1367 /// Determines if the disconnected block contained any transactions of interest and updates
1369 pub fn block_disconnected<B: Deref, F: Deref, L: Deref>(
1371 header: &BlockHeader,
1377 B::Target: BroadcasterInterface,
1378 F::Target: FeeEstimator,
1381 self.inner.lock().unwrap().block_disconnected(
1382 header, height, broadcaster, fee_estimator, logger)
1385 /// Processes transactions confirmed in a block with the given header and height, returning new
1386 /// outputs to watch. See [`block_connected`] for details.
1388 /// Used instead of [`block_connected`] by clients that are notified of transactions rather than
1389 /// blocks. See [`chain::Confirm`] for calling expectations.
1391 /// [`block_connected`]: Self::block_connected
1392 pub fn transactions_confirmed<B: Deref, F: Deref, L: Deref>(
1394 header: &BlockHeader,
1395 txdata: &TransactionData,
1400 ) -> Vec<TransactionOutputs>
1402 B::Target: BroadcasterInterface,
1403 F::Target: FeeEstimator,
1406 let bounded_fee_estimator = LowerBoundedFeeEstimator::new(fee_estimator);
1407 self.inner.lock().unwrap().transactions_confirmed(
1408 header, txdata, height, broadcaster, &bounded_fee_estimator, logger)
1411 /// Processes a transaction that was reorganized out of the chain.
1413 /// Used instead of [`block_disconnected`] by clients that are notified of transactions rather
1414 /// than blocks. See [`chain::Confirm`] for calling expectations.
1416 /// [`block_disconnected`]: Self::block_disconnected
1417 pub fn transaction_unconfirmed<B: Deref, F: Deref, L: Deref>(
1424 B::Target: BroadcasterInterface,
1425 F::Target: FeeEstimator,
1428 let bounded_fee_estimator = LowerBoundedFeeEstimator::new(fee_estimator);
1429 self.inner.lock().unwrap().transaction_unconfirmed(
1430 txid, broadcaster, &bounded_fee_estimator, logger);
1433 /// Updates the monitor with the current best chain tip, returning new outputs to watch. See
1434 /// [`block_connected`] for details.
1436 /// Used instead of [`block_connected`] by clients that are notified of transactions rather than
1437 /// blocks. See [`chain::Confirm`] for calling expectations.
1439 /// [`block_connected`]: Self::block_connected
1440 pub fn best_block_updated<B: Deref, F: Deref, L: Deref>(
1442 header: &BlockHeader,
1447 ) -> Vec<TransactionOutputs>
1449 B::Target: BroadcasterInterface,
1450 F::Target: FeeEstimator,
1453 let bounded_fee_estimator = LowerBoundedFeeEstimator::new(fee_estimator);
1454 self.inner.lock().unwrap().best_block_updated(
1455 header, height, broadcaster, &bounded_fee_estimator, logger)
1458 /// Returns the set of txids that should be monitored for re-organization out of the chain.
1459 pub fn get_relevant_txids(&self) -> Vec<(Txid, Option<BlockHash>)> {
1460 let inner = self.inner.lock().unwrap();
1461 let mut txids: Vec<(Txid, Option<BlockHash>)> = inner.onchain_events_awaiting_threshold_conf
1463 .map(|entry| (entry.txid, entry.block_hash))
1464 .chain(inner.onchain_tx_handler.get_relevant_txids().into_iter())
1466 txids.sort_unstable();
1471 /// Gets the latest best block which was connected either via the [`chain::Listen`] or
1472 /// [`chain::Confirm`] interfaces.
1473 pub fn current_best_block(&self) -> BestBlock {
1474 self.inner.lock().unwrap().best_block.clone()
1477 /// Triggers rebroadcasts/fee-bumps of pending claims from a force-closed channel. This is
1478 /// crucial in preventing certain classes of pinning attacks, detecting substantial mempool
1479 /// feerate changes between blocks, and ensuring reliability if broadcasting fails. We recommend
1480 /// invoking this every 30 seconds, or lower if running in an environment with spotty
1481 /// connections, like on mobile.
1482 pub fn rebroadcast_pending_claims<B: Deref, F: Deref, L: Deref>(
1483 &self, broadcaster: B, fee_estimator: F, logger: L,
1486 B::Target: BroadcasterInterface,
1487 F::Target: FeeEstimator,
1490 let fee_estimator = LowerBoundedFeeEstimator::new(fee_estimator);
1491 let mut inner = self.inner.lock().unwrap();
1492 let current_height = inner.best_block.height;
1493 inner.onchain_tx_handler.rebroadcast_pending_claims(
1494 current_height, &broadcaster, &fee_estimator, &logger,
1499 impl<Signer: WriteableEcdsaChannelSigner> ChannelMonitorImpl<Signer> {
1500 /// Helper for get_claimable_balances which does the work for an individual HTLC, generating up
1501 /// to one `Balance` for the HTLC.
1502 fn get_htlc_balance(&self, htlc: &HTLCOutputInCommitment, holder_commitment: bool,
1503 counterparty_revoked_commitment: bool, confirmed_txid: Option<Txid>)
1504 -> Option<Balance> {
1505 let htlc_commitment_tx_output_idx =
1506 if let Some(v) = htlc.transaction_output_index { v } else { return None; };
1508 let mut htlc_spend_txid_opt = None;
1509 let mut htlc_spend_tx_opt = None;
1510 let mut holder_timeout_spend_pending = None;
1511 let mut htlc_spend_pending = None;
1512 let mut holder_delayed_output_pending = None;
1513 for event in self.onchain_events_awaiting_threshold_conf.iter() {
1515 OnchainEvent::HTLCUpdate { commitment_tx_output_idx, htlc_value_satoshis, .. }
1516 if commitment_tx_output_idx == Some(htlc_commitment_tx_output_idx) => {
1517 debug_assert!(htlc_spend_txid_opt.is_none());
1518 htlc_spend_txid_opt = Some(&event.txid);
1519 debug_assert!(htlc_spend_tx_opt.is_none());
1520 htlc_spend_tx_opt = event.transaction.as_ref();
1521 debug_assert!(holder_timeout_spend_pending.is_none());
1522 debug_assert_eq!(htlc_value_satoshis.unwrap(), htlc.amount_msat / 1000);
1523 holder_timeout_spend_pending = Some(event.confirmation_threshold());
1525 OnchainEvent::HTLCSpendConfirmation { commitment_tx_output_idx, preimage, .. }
1526 if commitment_tx_output_idx == htlc_commitment_tx_output_idx => {
1527 debug_assert!(htlc_spend_txid_opt.is_none());
1528 htlc_spend_txid_opt = Some(&event.txid);
1529 debug_assert!(htlc_spend_tx_opt.is_none());
1530 htlc_spend_tx_opt = event.transaction.as_ref();
1531 debug_assert!(htlc_spend_pending.is_none());
1532 htlc_spend_pending = Some((event.confirmation_threshold(), preimage.is_some()));
1534 OnchainEvent::MaturingOutput {
1535 descriptor: SpendableOutputDescriptor::DelayedPaymentOutput(ref descriptor) }
1536 if descriptor.outpoint.index as u32 == htlc_commitment_tx_output_idx => {
1537 debug_assert!(holder_delayed_output_pending.is_none());
1538 holder_delayed_output_pending = Some(event.confirmation_threshold());
1543 let htlc_resolved = self.htlcs_resolved_on_chain.iter()
1544 .find(|v| if v.commitment_tx_output_idx == Some(htlc_commitment_tx_output_idx) {
1545 debug_assert!(htlc_spend_txid_opt.is_none());
1546 htlc_spend_txid_opt = v.resolving_txid.as_ref();
1547 debug_assert!(htlc_spend_tx_opt.is_none());
1548 htlc_spend_tx_opt = v.resolving_tx.as_ref();
1551 debug_assert!(holder_timeout_spend_pending.is_some() as u8 + htlc_spend_pending.is_some() as u8 + htlc_resolved.is_some() as u8 <= 1);
1553 let htlc_commitment_outpoint = BitcoinOutPoint::new(confirmed_txid.unwrap(), htlc_commitment_tx_output_idx);
1554 let htlc_output_to_spend =
1555 if let Some(txid) = htlc_spend_txid_opt {
1556 // Because HTLC transactions either only have 1 input and 1 output (pre-anchors) or
1557 // are signed with SIGHASH_SINGLE|ANYONECANPAY under BIP-0143 (post-anchors), we can
1558 // locate the correct output by ensuring its adjacent input spends the HTLC output
1559 // in the commitment.
1560 if let Some(ref tx) = htlc_spend_tx_opt {
1561 let htlc_input_idx_opt = tx.input.iter().enumerate()
1562 .find(|(_, input)| input.previous_output == htlc_commitment_outpoint)
1563 .map(|(idx, _)| idx as u32);
1564 debug_assert!(htlc_input_idx_opt.is_some());
1565 BitcoinOutPoint::new(*txid, htlc_input_idx_opt.unwrap_or(0))
1567 debug_assert!(!self.onchain_tx_handler.opt_anchors());
1568 BitcoinOutPoint::new(*txid, 0)
1571 htlc_commitment_outpoint
1573 let htlc_output_spend_pending = self.onchain_tx_handler.is_output_spend_pending(&htlc_output_to_spend);
1575 if let Some(conf_thresh) = holder_delayed_output_pending {
1576 debug_assert!(holder_commitment);
1577 return Some(Balance::ClaimableAwaitingConfirmations {
1578 claimable_amount_satoshis: htlc.amount_msat / 1000,
1579 confirmation_height: conf_thresh,
1581 } else if htlc_resolved.is_some() && !htlc_output_spend_pending {
1582 // Funding transaction spends should be fully confirmed by the time any
1583 // HTLC transactions are resolved, unless we're talking about a holder
1584 // commitment tx, whose resolution is delayed until the CSV timeout is
1585 // reached, even though HTLCs may be resolved after only
1586 // ANTI_REORG_DELAY confirmations.
1587 debug_assert!(holder_commitment || self.funding_spend_confirmed.is_some());
1588 } else if counterparty_revoked_commitment {
1589 let htlc_output_claim_pending = self.onchain_events_awaiting_threshold_conf.iter().find_map(|event| {
1590 if let OnchainEvent::MaturingOutput {
1591 descriptor: SpendableOutputDescriptor::StaticOutput { .. }
1593 if event.transaction.as_ref().map(|tx| tx.input.iter().any(|inp| {
1594 if let Some(htlc_spend_txid) = htlc_spend_txid_opt {
1595 tx.txid() == *htlc_spend_txid || inp.previous_output.txid == *htlc_spend_txid
1597 Some(inp.previous_output.txid) == confirmed_txid &&
1598 inp.previous_output.vout == htlc_commitment_tx_output_idx
1600 })).unwrap_or(false) {
1605 if htlc_output_claim_pending.is_some() {
1606 // We already push `Balance`s onto the `res` list for every
1607 // `StaticOutput` in a `MaturingOutput` in the revoked
1608 // counterparty commitment transaction case generally, so don't
1609 // need to do so again here.
1611 debug_assert!(holder_timeout_spend_pending.is_none(),
1612 "HTLCUpdate OnchainEvents should never appear for preimage claims");
1613 debug_assert!(!htlc.offered || htlc_spend_pending.is_none() || !htlc_spend_pending.unwrap().1,
1614 "We don't (currently) generate preimage claims against revoked outputs, where did you get one?!");
1615 return Some(Balance::CounterpartyRevokedOutputClaimable {
1616 claimable_amount_satoshis: htlc.amount_msat / 1000,
1619 } else if htlc.offered == holder_commitment {
1620 // If the payment was outbound, check if there's an HTLCUpdate
1621 // indicating we have spent this HTLC with a timeout, claiming it back
1622 // and awaiting confirmations on it.
1623 if let Some(conf_thresh) = holder_timeout_spend_pending {
1624 return Some(Balance::ClaimableAwaitingConfirmations {
1625 claimable_amount_satoshis: htlc.amount_msat / 1000,
1626 confirmation_height: conf_thresh,
1629 return Some(Balance::MaybeTimeoutClaimableHTLC {
1630 claimable_amount_satoshis: htlc.amount_msat / 1000,
1631 claimable_height: htlc.cltv_expiry,
1634 } else if self.payment_preimages.get(&htlc.payment_hash).is_some() {
1635 // Otherwise (the payment was inbound), only expose it as claimable if
1636 // we know the preimage.
1637 // Note that if there is a pending claim, but it did not use the
1638 // preimage, we lost funds to our counterparty! We will then continue
1639 // to show it as ContentiousClaimable until ANTI_REORG_DELAY.
1640 debug_assert!(holder_timeout_spend_pending.is_none());
1641 if let Some((conf_thresh, true)) = htlc_spend_pending {
1642 return Some(Balance::ClaimableAwaitingConfirmations {
1643 claimable_amount_satoshis: htlc.amount_msat / 1000,
1644 confirmation_height: conf_thresh,
1647 return Some(Balance::ContentiousClaimable {
1648 claimable_amount_satoshis: htlc.amount_msat / 1000,
1649 timeout_height: htlc.cltv_expiry,
1652 } else if htlc_resolved.is_none() {
1653 return Some(Balance::MaybePreimageClaimableHTLC {
1654 claimable_amount_satoshis: htlc.amount_msat / 1000,
1655 expiry_height: htlc.cltv_expiry,
1662 impl<Signer: WriteableEcdsaChannelSigner> ChannelMonitor<Signer> {
1663 /// Gets the balances in this channel which are either claimable by us if we were to
1664 /// force-close the channel now or which are claimable on-chain (possibly awaiting
1667 /// Any balances in the channel which are available on-chain (excluding on-chain fees) are
1668 /// included here until an [`Event::SpendableOutputs`] event has been generated for the
1669 /// balance, or until our counterparty has claimed the balance and accrued several
1670 /// confirmations on the claim transaction.
1672 /// Note that for `ChannelMonitors` which track a channel which went on-chain with versions of
1673 /// LDK prior to 0.0.111, balances may not be fully captured if our counterparty broadcasted
1674 /// a revoked state.
1676 /// See [`Balance`] for additional details on the types of claimable balances which
1677 /// may be returned here and their meanings.
1678 pub fn get_claimable_balances(&self) -> Vec<Balance> {
1679 let mut res = Vec::new();
1680 let us = self.inner.lock().unwrap();
1682 let mut confirmed_txid = us.funding_spend_confirmed;
1683 let mut confirmed_counterparty_output = us.confirmed_commitment_tx_counterparty_output;
1684 let mut pending_commitment_tx_conf_thresh = None;
1685 let funding_spend_pending = us.onchain_events_awaiting_threshold_conf.iter().find_map(|event| {
1686 if let OnchainEvent::FundingSpendConfirmation { commitment_tx_to_counterparty_output, .. } =
1689 confirmed_counterparty_output = commitment_tx_to_counterparty_output;
1690 Some((event.txid, event.confirmation_threshold()))
1693 if let Some((txid, conf_thresh)) = funding_spend_pending {
1694 debug_assert!(us.funding_spend_confirmed.is_none(),
1695 "We have a pending funding spend awaiting anti-reorg confirmation, we can't have confirmed it already!");
1696 confirmed_txid = Some(txid);
1697 pending_commitment_tx_conf_thresh = Some(conf_thresh);
1700 macro_rules! walk_htlcs {
1701 ($holder_commitment: expr, $counterparty_revoked_commitment: expr, $htlc_iter: expr) => {
1702 for htlc in $htlc_iter {
1703 if htlc.transaction_output_index.is_some() {
1705 if let Some(bal) = us.get_htlc_balance(htlc, $holder_commitment, $counterparty_revoked_commitment, confirmed_txid) {
1713 if let Some(txid) = confirmed_txid {
1714 let mut found_commitment_tx = false;
1715 if let Some(counterparty_tx_htlcs) = us.counterparty_claimable_outpoints.get(&txid) {
1716 // First look for the to_remote output back to us.
1717 if let Some(conf_thresh) = pending_commitment_tx_conf_thresh {
1718 if let Some(value) = us.onchain_events_awaiting_threshold_conf.iter().find_map(|event| {
1719 if let OnchainEvent::MaturingOutput {
1720 descriptor: SpendableOutputDescriptor::StaticPaymentOutput(descriptor)
1722 Some(descriptor.output.value)
1725 res.push(Balance::ClaimableAwaitingConfirmations {
1726 claimable_amount_satoshis: value,
1727 confirmation_height: conf_thresh,
1730 // If a counterparty commitment transaction is awaiting confirmation, we
1731 // should either have a StaticPaymentOutput MaturingOutput event awaiting
1732 // confirmation with the same height or have never met our dust amount.
1735 if Some(txid) == us.current_counterparty_commitment_txid || Some(txid) == us.prev_counterparty_commitment_txid {
1736 walk_htlcs!(false, false, counterparty_tx_htlcs.iter().map(|(a, _)| a));
1738 walk_htlcs!(false, true, counterparty_tx_htlcs.iter().map(|(a, _)| a));
1739 // The counterparty broadcasted a revoked state!
1740 // Look for any StaticOutputs first, generating claimable balances for those.
1741 // If any match the confirmed counterparty revoked to_self output, skip
1742 // generating a CounterpartyRevokedOutputClaimable.
1743 let mut spent_counterparty_output = false;
1744 for event in us.onchain_events_awaiting_threshold_conf.iter() {
1745 if let OnchainEvent::MaturingOutput {
1746 descriptor: SpendableOutputDescriptor::StaticOutput { output, .. }
1748 res.push(Balance::ClaimableAwaitingConfirmations {
1749 claimable_amount_satoshis: output.value,
1750 confirmation_height: event.confirmation_threshold(),
1752 if let Some(confirmed_to_self_idx) = confirmed_counterparty_output.map(|(idx, _)| idx) {
1753 if event.transaction.as_ref().map(|tx|
1754 tx.input.iter().any(|inp| inp.previous_output.vout == confirmed_to_self_idx)
1755 ).unwrap_or(false) {
1756 spent_counterparty_output = true;
1762 if spent_counterparty_output {
1763 } else if let Some((confirmed_to_self_idx, amt)) = confirmed_counterparty_output {
1764 let output_spendable = us.onchain_tx_handler
1765 .is_output_spend_pending(&BitcoinOutPoint::new(txid, confirmed_to_self_idx));
1766 if output_spendable {
1767 res.push(Balance::CounterpartyRevokedOutputClaimable {
1768 claimable_amount_satoshis: amt,
1772 // Counterparty output is missing, either it was broadcasted on a
1773 // previous version of LDK or the counterparty hadn't met dust.
1776 found_commitment_tx = true;
1777 } else if txid == us.current_holder_commitment_tx.txid {
1778 walk_htlcs!(true, false, us.current_holder_commitment_tx.htlc_outputs.iter().map(|(a, _, _)| a));
1779 if let Some(conf_thresh) = pending_commitment_tx_conf_thresh {
1780 res.push(Balance::ClaimableAwaitingConfirmations {
1781 claimable_amount_satoshis: us.current_holder_commitment_tx.to_self_value_sat,
1782 confirmation_height: conf_thresh,
1785 found_commitment_tx = true;
1786 } else if let Some(prev_commitment) = &us.prev_holder_signed_commitment_tx {
1787 if txid == prev_commitment.txid {
1788 walk_htlcs!(true, false, prev_commitment.htlc_outputs.iter().map(|(a, _, _)| a));
1789 if let Some(conf_thresh) = pending_commitment_tx_conf_thresh {
1790 res.push(Balance::ClaimableAwaitingConfirmations {
1791 claimable_amount_satoshis: prev_commitment.to_self_value_sat,
1792 confirmation_height: conf_thresh,
1795 found_commitment_tx = true;
1798 if !found_commitment_tx {
1799 if let Some(conf_thresh) = pending_commitment_tx_conf_thresh {
1800 // We blindly assume this is a cooperative close transaction here, and that
1801 // neither us nor our counterparty misbehaved. At worst we've under-estimated
1802 // the amount we can claim as we'll punish a misbehaving counterparty.
1803 res.push(Balance::ClaimableAwaitingConfirmations {
1804 claimable_amount_satoshis: us.current_holder_commitment_tx.to_self_value_sat,
1805 confirmation_height: conf_thresh,
1810 let mut claimable_inbound_htlc_value_sat = 0;
1811 for (htlc, _, _) in us.current_holder_commitment_tx.htlc_outputs.iter() {
1812 if htlc.transaction_output_index.is_none() { continue; }
1814 res.push(Balance::MaybeTimeoutClaimableHTLC {
1815 claimable_amount_satoshis: htlc.amount_msat / 1000,
1816 claimable_height: htlc.cltv_expiry,
1818 } else if us.payment_preimages.get(&htlc.payment_hash).is_some() {
1819 claimable_inbound_htlc_value_sat += htlc.amount_msat / 1000;
1821 // As long as the HTLC is still in our latest commitment state, treat
1822 // it as potentially claimable, even if it has long-since expired.
1823 res.push(Balance::MaybePreimageClaimableHTLC {
1824 claimable_amount_satoshis: htlc.amount_msat / 1000,
1825 expiry_height: htlc.cltv_expiry,
1829 res.push(Balance::ClaimableOnChannelClose {
1830 claimable_amount_satoshis: us.current_holder_commitment_tx.to_self_value_sat + claimable_inbound_htlc_value_sat,
1837 /// Gets the set of outbound HTLCs which can be (or have been) resolved by this
1838 /// `ChannelMonitor`. This is used to determine if an HTLC was removed from the channel prior
1839 /// to the `ChannelManager` having been persisted.
1841 /// This is similar to [`Self::get_pending_or_resolved_outbound_htlcs`] except it includes
1842 /// HTLCs which were resolved on-chain (i.e. where the final HTLC resolution was done by an
1843 /// event from this `ChannelMonitor`).
1844 pub(crate) fn get_all_current_outbound_htlcs(&self) -> HashMap<HTLCSource, (HTLCOutputInCommitment, Option<PaymentPreimage>)> {
1845 let mut res = HashMap::new();
1846 // Just examine the available counterparty commitment transactions. See docs on
1847 // `fail_unbroadcast_htlcs`, below, for justification.
1848 let us = self.inner.lock().unwrap();
1849 macro_rules! walk_counterparty_commitment {
1851 if let Some(ref latest_outpoints) = us.counterparty_claimable_outpoints.get($txid) {
1852 for &(ref htlc, ref source_option) in latest_outpoints.iter() {
1853 if let &Some(ref source) = source_option {
1854 res.insert((**source).clone(), (htlc.clone(),
1855 us.counterparty_fulfilled_htlcs.get(&SentHTLCId::from_source(source)).cloned()));
1861 if let Some(ref txid) = us.current_counterparty_commitment_txid {
1862 walk_counterparty_commitment!(txid);
1864 if let Some(ref txid) = us.prev_counterparty_commitment_txid {
1865 walk_counterparty_commitment!(txid);
1870 /// Gets the set of outbound HTLCs which are pending resolution in this channel or which were
1871 /// resolved with a preimage from our counterparty.
1873 /// This is used to reconstruct pending outbound payments on restart in the ChannelManager.
1875 /// Currently, the preimage is unused, however if it is present in the relevant internal state
1876 /// an HTLC is always included even if it has been resolved.
1877 pub(crate) fn get_pending_or_resolved_outbound_htlcs(&self) -> HashMap<HTLCSource, (HTLCOutputInCommitment, Option<PaymentPreimage>)> {
1878 let us = self.inner.lock().unwrap();
1879 // We're only concerned with the confirmation count of HTLC transactions, and don't
1880 // actually care how many confirmations a commitment transaction may or may not have. Thus,
1881 // we look for either a FundingSpendConfirmation event or a funding_spend_confirmed.
1882 let confirmed_txid = us.funding_spend_confirmed.or_else(|| {
1883 us.onchain_events_awaiting_threshold_conf.iter().find_map(|event| {
1884 if let OnchainEvent::FundingSpendConfirmation { .. } = event.event {
1890 if confirmed_txid.is_none() {
1891 // If we have not seen a commitment transaction on-chain (ie the channel is not yet
1892 // closed), just get the full set.
1894 return self.get_all_current_outbound_htlcs();
1897 let mut res = HashMap::new();
1898 macro_rules! walk_htlcs {
1899 ($holder_commitment: expr, $htlc_iter: expr) => {
1900 for (htlc, source) in $htlc_iter {
1901 if us.htlcs_resolved_on_chain.iter().any(|v| v.commitment_tx_output_idx == htlc.transaction_output_index) {
1902 // We should assert that funding_spend_confirmed is_some() here, but we
1903 // have some unit tests which violate HTLC transaction CSVs entirely and
1905 // TODO: Once tests all connect transactions at consensus-valid times, we
1906 // should assert here like we do in `get_claimable_balances`.
1907 } else if htlc.offered == $holder_commitment {
1908 // If the payment was outbound, check if there's an HTLCUpdate
1909 // indicating we have spent this HTLC with a timeout, claiming it back
1910 // and awaiting confirmations on it.
1911 let htlc_update_confd = us.onchain_events_awaiting_threshold_conf.iter().any(|event| {
1912 if let OnchainEvent::HTLCUpdate { commitment_tx_output_idx: Some(commitment_tx_output_idx), .. } = event.event {
1913 // If the HTLC was timed out, we wait for ANTI_REORG_DELAY blocks
1914 // before considering it "no longer pending" - this matches when we
1915 // provide the ChannelManager an HTLC failure event.
1916 Some(commitment_tx_output_idx) == htlc.transaction_output_index &&
1917 us.best_block.height() >= event.height + ANTI_REORG_DELAY - 1
1918 } else if let OnchainEvent::HTLCSpendConfirmation { commitment_tx_output_idx, .. } = event.event {
1919 // If the HTLC was fulfilled with a preimage, we consider the HTLC
1920 // immediately non-pending, matching when we provide ChannelManager
1922 Some(commitment_tx_output_idx) == htlc.transaction_output_index
1925 let counterparty_resolved_preimage_opt =
1926 us.counterparty_fulfilled_htlcs.get(&SentHTLCId::from_source(source)).cloned();
1927 if !htlc_update_confd || counterparty_resolved_preimage_opt.is_some() {
1928 res.insert(source.clone(), (htlc.clone(), counterparty_resolved_preimage_opt));
1935 let txid = confirmed_txid.unwrap();
1936 if Some(txid) == us.current_counterparty_commitment_txid || Some(txid) == us.prev_counterparty_commitment_txid {
1937 walk_htlcs!(false, us.counterparty_claimable_outpoints.get(&txid).unwrap().iter().filter_map(|(a, b)| {
1938 if let &Some(ref source) = b {
1939 Some((a, &**source))
1942 } else if txid == us.current_holder_commitment_tx.txid {
1943 walk_htlcs!(true, us.current_holder_commitment_tx.htlc_outputs.iter().filter_map(|(a, _, c)| {
1944 if let Some(source) = c { Some((a, source)) } else { None }
1946 } else if let Some(prev_commitment) = &us.prev_holder_signed_commitment_tx {
1947 if txid == prev_commitment.txid {
1948 walk_htlcs!(true, prev_commitment.htlc_outputs.iter().filter_map(|(a, _, c)| {
1949 if let Some(source) = c { Some((a, source)) } else { None }
1957 pub(crate) fn get_stored_preimages(&self) -> HashMap<PaymentHash, PaymentPreimage> {
1958 self.inner.lock().unwrap().payment_preimages.clone()
1962 /// Compares a broadcasted commitment transaction's HTLCs with those in the latest state,
1963 /// failing any HTLCs which didn't make it into the broadcasted commitment transaction back
1964 /// after ANTI_REORG_DELAY blocks.
1966 /// We always compare against the set of HTLCs in counterparty commitment transactions, as those
1967 /// are the commitment transactions which are generated by us. The off-chain state machine in
1968 /// `Channel` will automatically resolve any HTLCs which were never included in a commitment
1969 /// transaction when it detects channel closure, but it is up to us to ensure any HTLCs which were
1970 /// included in a remote commitment transaction are failed back if they are not present in the
1971 /// broadcasted commitment transaction.
1973 /// Specifically, the removal process for HTLCs in `Channel` is always based on the counterparty
1974 /// sending a `revoke_and_ack`, which causes us to clear `prev_counterparty_commitment_txid`. Thus,
1975 /// as long as we examine both the current counterparty commitment transaction and, if it hasn't
1976 /// been revoked yet, the previous one, we we will never "forget" to resolve an HTLC.
1977 macro_rules! fail_unbroadcast_htlcs {
1978 ($self: expr, $commitment_tx_type: expr, $commitment_txid_confirmed: expr, $commitment_tx_confirmed: expr,
1979 $commitment_tx_conf_height: expr, $commitment_tx_conf_hash: expr, $confirmed_htlcs_list: expr, $logger: expr) => { {
1980 debug_assert_eq!($commitment_tx_confirmed.txid(), $commitment_txid_confirmed);
1982 macro_rules! check_htlc_fails {
1983 ($txid: expr, $commitment_tx: expr) => {
1984 if let Some(ref latest_outpoints) = $self.counterparty_claimable_outpoints.get($txid) {
1985 for &(ref htlc, ref source_option) in latest_outpoints.iter() {
1986 if let &Some(ref source) = source_option {
1987 // Check if the HTLC is present in the commitment transaction that was
1988 // broadcast, but not if it was below the dust limit, which we should
1989 // fail backwards immediately as there is no way for us to learn the
1990 // payment_preimage.
1991 // Note that if the dust limit were allowed to change between
1992 // commitment transactions we'd want to be check whether *any*
1993 // broadcastable commitment transaction has the HTLC in it, but it
1994 // cannot currently change after channel initialization, so we don't
1996 let confirmed_htlcs_iter: &mut Iterator<Item = (&HTLCOutputInCommitment, Option<&HTLCSource>)> = &mut $confirmed_htlcs_list;
1998 let mut matched_htlc = false;
1999 for (ref broadcast_htlc, ref broadcast_source) in confirmed_htlcs_iter {
2000 if broadcast_htlc.transaction_output_index.is_some() &&
2001 (Some(&**source) == *broadcast_source ||
2002 (broadcast_source.is_none() &&
2003 broadcast_htlc.payment_hash == htlc.payment_hash &&
2004 broadcast_htlc.amount_msat == htlc.amount_msat)) {
2005 matched_htlc = true;
2009 if matched_htlc { continue; }
2010 if $self.counterparty_fulfilled_htlcs.get(&SentHTLCId::from_source(source)).is_some() {
2013 $self.onchain_events_awaiting_threshold_conf.retain(|ref entry| {
2014 if entry.height != $commitment_tx_conf_height { return true; }
2016 OnchainEvent::HTLCUpdate { source: ref update_source, .. } => {
2017 *update_source != **source
2022 let entry = OnchainEventEntry {
2023 txid: $commitment_txid_confirmed,
2024 transaction: Some($commitment_tx_confirmed.clone()),
2025 height: $commitment_tx_conf_height,
2026 block_hash: Some(*$commitment_tx_conf_hash),
2027 event: OnchainEvent::HTLCUpdate {
2028 source: (**source).clone(),
2029 payment_hash: htlc.payment_hash.clone(),
2030 htlc_value_satoshis: Some(htlc.amount_msat / 1000),
2031 commitment_tx_output_idx: None,
2034 log_trace!($logger, "Failing HTLC with payment_hash {} from {} counterparty commitment tx due to broadcast of {} commitment transaction {}, waiting for confirmation (at height {})",
2035 log_bytes!(htlc.payment_hash.0), $commitment_tx, $commitment_tx_type,
2036 $commitment_txid_confirmed, entry.confirmation_threshold());
2037 $self.onchain_events_awaiting_threshold_conf.push(entry);
2043 if let Some(ref txid) = $self.current_counterparty_commitment_txid {
2044 check_htlc_fails!(txid, "current");
2046 if let Some(ref txid) = $self.prev_counterparty_commitment_txid {
2047 check_htlc_fails!(txid, "previous");
2052 // In the `test_invalid_funding_tx` test, we need a bogus script which matches the HTLC-Accepted
2053 // witness length match (ie is 136 bytes long). We generate one here which we also use in some
2054 // in-line tests later.
2057 pub fn deliberately_bogus_accepted_htlc_witness_program() -> Vec<u8> {
2058 let mut ret = [opcodes::all::OP_NOP.to_u8(); 136];
2059 ret[131] = opcodes::all::OP_DROP.to_u8();
2060 ret[132] = opcodes::all::OP_DROP.to_u8();
2061 ret[133] = opcodes::all::OP_DROP.to_u8();
2062 ret[134] = opcodes::all::OP_DROP.to_u8();
2063 ret[135] = opcodes::OP_TRUE.to_u8();
2068 pub fn deliberately_bogus_accepted_htlc_witness() -> Vec<Vec<u8>> {
2069 vec![Vec::new(), Vec::new(), Vec::new(), Vec::new(), deliberately_bogus_accepted_htlc_witness_program().into()].into()
2072 impl<Signer: WriteableEcdsaChannelSigner> ChannelMonitorImpl<Signer> {
2073 /// Inserts a revocation secret into this channel monitor. Prunes old preimages if neither
2074 /// needed by holder commitment transactions HTCLs nor by counterparty ones. Unless we haven't already seen
2075 /// counterparty commitment transaction's secret, they are de facto pruned (we can use revocation key).
2076 fn provide_secret(&mut self, idx: u64, secret: [u8; 32]) -> Result<(), &'static str> {
2077 if let Err(()) = self.commitment_secrets.provide_secret(idx, secret) {
2078 return Err("Previous secret did not match new one");
2081 // Prune HTLCs from the previous counterparty commitment tx so we don't generate failure/fulfill
2082 // events for now-revoked/fulfilled HTLCs.
2083 if let Some(txid) = self.prev_counterparty_commitment_txid.take() {
2084 if self.current_counterparty_commitment_txid.unwrap() != txid {
2085 let cur_claimables = self.counterparty_claimable_outpoints.get(
2086 &self.current_counterparty_commitment_txid.unwrap()).unwrap();
2087 for (_, ref source_opt) in self.counterparty_claimable_outpoints.get(&txid).unwrap() {
2088 if let Some(source) = source_opt {
2089 if !cur_claimables.iter()
2090 .any(|(_, cur_source_opt)| cur_source_opt == source_opt)
2092 self.counterparty_fulfilled_htlcs.remove(&SentHTLCId::from_source(source));
2096 for &mut (_, ref mut source_opt) in self.counterparty_claimable_outpoints.get_mut(&txid).unwrap() {
2100 assert!(cfg!(fuzzing), "Commitment txids are unique outside of fuzzing, where hashes can collide");
2104 if !self.payment_preimages.is_empty() {
2105 let cur_holder_signed_commitment_tx = &self.current_holder_commitment_tx;
2106 let prev_holder_signed_commitment_tx = self.prev_holder_signed_commitment_tx.as_ref();
2107 let min_idx = self.get_min_seen_secret();
2108 let counterparty_hash_commitment_number = &mut self.counterparty_hash_commitment_number;
2110 self.payment_preimages.retain(|&k, _| {
2111 for &(ref htlc, _, _) in cur_holder_signed_commitment_tx.htlc_outputs.iter() {
2112 if k == htlc.payment_hash {
2116 if let Some(prev_holder_commitment_tx) = prev_holder_signed_commitment_tx {
2117 for &(ref htlc, _, _) in prev_holder_commitment_tx.htlc_outputs.iter() {
2118 if k == htlc.payment_hash {
2123 let contains = if let Some(cn) = counterparty_hash_commitment_number.get(&k) {
2130 counterparty_hash_commitment_number.remove(&k);
2139 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 {
2140 // TODO: Encrypt the htlc_outputs data with the single-hash of the commitment transaction
2141 // so that a remote monitor doesn't learn anything unless there is a malicious close.
2142 // (only maybe, sadly we cant do the same for local info, as we need to be aware of
2144 for &(ref htlc, _) in &htlc_outputs {
2145 self.counterparty_hash_commitment_number.insert(htlc.payment_hash, commitment_number);
2148 log_trace!(logger, "Tracking new counterparty commitment transaction with txid {} at commitment number {} with {} HTLC outputs", txid, commitment_number, htlc_outputs.len());
2149 self.prev_counterparty_commitment_txid = self.current_counterparty_commitment_txid.take();
2150 self.current_counterparty_commitment_txid = Some(txid);
2151 self.counterparty_claimable_outpoints.insert(txid, htlc_outputs.clone());
2152 self.current_counterparty_commitment_number = commitment_number;
2153 //TODO: Merge this into the other per-counterparty-transaction output storage stuff
2154 match self.their_cur_per_commitment_points {
2155 Some(old_points) => {
2156 if old_points.0 == commitment_number + 1 {
2157 self.their_cur_per_commitment_points = Some((old_points.0, old_points.1, Some(their_per_commitment_point)));
2158 } else if old_points.0 == commitment_number + 2 {
2159 if let Some(old_second_point) = old_points.2 {
2160 self.their_cur_per_commitment_points = Some((old_points.0 - 1, old_second_point, Some(their_per_commitment_point)));
2162 self.their_cur_per_commitment_points = Some((commitment_number, their_per_commitment_point, None));
2165 self.their_cur_per_commitment_points = Some((commitment_number, their_per_commitment_point, None));
2169 self.their_cur_per_commitment_points = Some((commitment_number, their_per_commitment_point, None));
2172 let mut htlcs = Vec::with_capacity(htlc_outputs.len());
2173 for htlc in htlc_outputs {
2174 if htlc.0.transaction_output_index.is_some() {
2180 /// Informs this monitor of the latest holder (ie broadcastable) commitment transaction. The
2181 /// monitor watches for timeouts and may broadcast it if we approach such a timeout. Thus, it
2182 /// is important that any clones of this channel monitor (including remote clones) by kept
2183 /// up-to-date as our holder commitment transaction is updated.
2184 /// Panics if set_on_holder_tx_csv has never been called.
2185 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> {
2186 if htlc_outputs.iter().any(|(_, s, _)| s.is_some()) {
2187 // If we have non-dust HTLCs in htlc_outputs, ensure they match the HTLCs in the
2188 // `holder_commitment_tx`. In the future, we'll no longer provide the redundant data
2189 // and just pass in source data via `nondust_htlc_sources`.
2190 debug_assert_eq!(htlc_outputs.iter().filter(|(_, s, _)| s.is_some()).count(), holder_commitment_tx.trust().htlcs().len());
2191 for (a, b) in htlc_outputs.iter().filter(|(_, s, _)| s.is_some()).map(|(h, _, _)| h).zip(holder_commitment_tx.trust().htlcs().iter()) {
2192 debug_assert_eq!(a, b);
2194 debug_assert_eq!(htlc_outputs.iter().filter(|(_, s, _)| s.is_some()).count(), holder_commitment_tx.counterparty_htlc_sigs.len());
2195 for (a, b) in htlc_outputs.iter().filter_map(|(_, s, _)| s.as_ref()).zip(holder_commitment_tx.counterparty_htlc_sigs.iter()) {
2196 debug_assert_eq!(a, b);
2198 debug_assert!(nondust_htlc_sources.is_empty());
2200 // If we don't have any non-dust HTLCs in htlc_outputs, assume they were all passed via
2201 // `nondust_htlc_sources`, building up the final htlc_outputs by combining
2202 // `nondust_htlc_sources` and the `holder_commitment_tx`
2203 #[cfg(debug_assertions)] {
2205 for htlc in holder_commitment_tx.trust().htlcs().iter() {
2206 assert!(htlc.transaction_output_index.unwrap() as i32 > prev);
2207 prev = htlc.transaction_output_index.unwrap() as i32;
2210 debug_assert!(htlc_outputs.iter().all(|(htlc, _, _)| htlc.transaction_output_index.is_none()));
2211 debug_assert!(htlc_outputs.iter().all(|(_, sig_opt, _)| sig_opt.is_none()));
2212 debug_assert_eq!(holder_commitment_tx.trust().htlcs().len(), holder_commitment_tx.counterparty_htlc_sigs.len());
2214 let mut sources_iter = nondust_htlc_sources.into_iter();
2216 for (htlc, counterparty_sig) in holder_commitment_tx.trust().htlcs().iter()
2217 .zip(holder_commitment_tx.counterparty_htlc_sigs.iter())
2220 let source = sources_iter.next().expect("Non-dust HTLC sources didn't match commitment tx");
2221 #[cfg(debug_assertions)] {
2222 assert!(source.possibly_matches_output(htlc));
2224 htlc_outputs.push((htlc.clone(), Some(counterparty_sig.clone()), Some(source)));
2226 htlc_outputs.push((htlc.clone(), Some(counterparty_sig.clone()), None));
2229 debug_assert!(sources_iter.next().is_none());
2232 let trusted_tx = holder_commitment_tx.trust();
2233 let txid = trusted_tx.txid();
2234 let tx_keys = trusted_tx.keys();
2235 self.current_holder_commitment_number = trusted_tx.commitment_number();
2236 let mut new_holder_commitment_tx = HolderSignedTx {
2238 revocation_key: tx_keys.revocation_key,
2239 a_htlc_key: tx_keys.broadcaster_htlc_key,
2240 b_htlc_key: tx_keys.countersignatory_htlc_key,
2241 delayed_payment_key: tx_keys.broadcaster_delayed_payment_key,
2242 per_commitment_point: tx_keys.per_commitment_point,
2244 to_self_value_sat: holder_commitment_tx.to_broadcaster_value_sat(),
2245 feerate_per_kw: trusted_tx.feerate_per_kw(),
2247 self.onchain_tx_handler.provide_latest_holder_tx(holder_commitment_tx);
2248 mem::swap(&mut new_holder_commitment_tx, &mut self.current_holder_commitment_tx);
2249 self.prev_holder_signed_commitment_tx = Some(new_holder_commitment_tx);
2250 for (claimed_htlc_id, claimed_preimage) in claimed_htlcs {
2251 #[cfg(debug_assertions)] {
2252 let cur_counterparty_htlcs = self.counterparty_claimable_outpoints.get(
2253 &self.current_counterparty_commitment_txid.unwrap()).unwrap();
2254 assert!(cur_counterparty_htlcs.iter().any(|(_, source_opt)| {
2255 if let Some(source) = source_opt {
2256 SentHTLCId::from_source(source) == *claimed_htlc_id
2260 self.counterparty_fulfilled_htlcs.insert(*claimed_htlc_id, *claimed_preimage);
2262 if self.holder_tx_signed {
2263 return Err("Latest holder commitment signed has already been signed, update is rejected");
2268 /// Provides a payment_hash->payment_preimage mapping. Will be automatically pruned when all
2269 /// commitment_tx_infos which contain the payment hash have been revoked.
2270 fn provide_payment_preimage<B: Deref, F: Deref, L: Deref>(
2271 &mut self, payment_hash: &PaymentHash, payment_preimage: &PaymentPreimage, broadcaster: &B,
2272 fee_estimator: &LowerBoundedFeeEstimator<F>, logger: &L)
2273 where B::Target: BroadcasterInterface,
2274 F::Target: FeeEstimator,
2277 self.payment_preimages.insert(payment_hash.clone(), payment_preimage.clone());
2279 // If the channel is force closed, try to claim the output from this preimage.
2280 // First check if a counterparty commitment transaction has been broadcasted:
2281 macro_rules! claim_htlcs {
2282 ($commitment_number: expr, $txid: expr) => {
2283 let (htlc_claim_reqs, _) = self.get_counterparty_output_claim_info($commitment_number, $txid, None);
2284 self.onchain_tx_handler.update_claims_view_from_requests(htlc_claim_reqs, self.best_block.height(), self.best_block.height(), broadcaster, fee_estimator, logger);
2287 if let Some(txid) = self.current_counterparty_commitment_txid {
2288 if let Some(commitment_number) = self.counterparty_commitment_txn_on_chain.get(&txid) {
2289 claim_htlcs!(*commitment_number, txid);
2293 if let Some(txid) = self.prev_counterparty_commitment_txid {
2294 if let Some(commitment_number) = self.counterparty_commitment_txn_on_chain.get(&txid) {
2295 claim_htlcs!(*commitment_number, txid);
2300 // Then if a holder commitment transaction has been seen on-chain, broadcast transactions
2301 // claiming the HTLC output from each of the holder commitment transactions.
2302 // Note that we can't just use `self.holder_tx_signed`, because that only covers the case where
2303 // *we* sign a holder commitment transaction, not when e.g. a watchtower broadcasts one of our
2304 // holder commitment transactions.
2305 if self.broadcasted_holder_revokable_script.is_some() {
2306 // Assume that the broadcasted commitment transaction confirmed in the current best
2307 // block. Even if not, its a reasonable metric for the bump criteria on the HTLC
2309 let (claim_reqs, _) = self.get_broadcasted_holder_claims(&self.current_holder_commitment_tx, self.best_block.height());
2310 self.onchain_tx_handler.update_claims_view_from_requests(claim_reqs, self.best_block.height(), self.best_block.height(), broadcaster, fee_estimator, logger);
2311 if let Some(ref tx) = self.prev_holder_signed_commitment_tx {
2312 let (claim_reqs, _) = self.get_broadcasted_holder_claims(&tx, self.best_block.height());
2313 self.onchain_tx_handler.update_claims_view_from_requests(claim_reqs, self.best_block.height(), self.best_block.height(), broadcaster, fee_estimator, logger);
2318 pub(crate) fn broadcast_latest_holder_commitment_txn<B: Deref, L: Deref>(&mut self, broadcaster: &B, logger: &L)
2319 where B::Target: BroadcasterInterface,
2322 for tx in self.get_latest_holder_commitment_txn(logger).iter() {
2323 log_info!(logger, "Broadcasting local {}", log_tx!(tx));
2324 broadcaster.broadcast_transaction(tx);
2326 self.pending_monitor_events.push(MonitorEvent::CommitmentTxConfirmed(self.funding_info.0));
2329 pub fn update_monitor<B: Deref, F: Deref, L: Deref>(&mut self, updates: &ChannelMonitorUpdate, broadcaster: &B, fee_estimator: F, logger: &L) -> Result<(), ()>
2330 where B::Target: BroadcasterInterface,
2331 F::Target: FeeEstimator,
2334 log_info!(logger, "Applying update to monitor {}, bringing update_id from {} to {} with {} changes.",
2335 log_funding_info!(self), self.latest_update_id, updates.update_id, updates.updates.len());
2336 // ChannelMonitor updates may be applied after force close if we receive a preimage for a
2337 // broadcasted commitment transaction HTLC output that we'd like to claim on-chain. If this
2338 // is the case, we no longer have guaranteed access to the monitor's update ID, so we use a
2339 // sentinel value instead.
2341 // The `ChannelManager` may also queue redundant `ChannelForceClosed` updates if it still
2342 // thinks the channel needs to have its commitment transaction broadcast, so we'll allow
2344 if updates.update_id == CLOSED_CHANNEL_UPDATE_ID {
2345 assert_eq!(updates.updates.len(), 1);
2346 match updates.updates[0] {
2347 ChannelMonitorUpdateStep::ChannelForceClosed { .. } => {},
2348 // We should have already seen a `ChannelForceClosed` update if we're trying to
2349 // provide a preimage at this point.
2350 ChannelMonitorUpdateStep::PaymentPreimage { .. } =>
2351 debug_assert_eq!(self.latest_update_id, CLOSED_CHANNEL_UPDATE_ID),
2353 log_error!(logger, "Attempted to apply post-force-close ChannelMonitorUpdate of type {}", updates.updates[0].variant_name());
2354 panic!("Attempted to apply post-force-close ChannelMonitorUpdate that wasn't providing a payment preimage");
2357 } else if self.latest_update_id + 1 != updates.update_id {
2358 panic!("Attempted to apply ChannelMonitorUpdates out of order, check the update_id before passing an update to update_monitor!");
2360 let mut ret = Ok(());
2361 let bounded_fee_estimator = LowerBoundedFeeEstimator::new(&*fee_estimator);
2362 for update in updates.updates.iter() {
2364 ChannelMonitorUpdateStep::LatestHolderCommitmentTXInfo { commitment_tx, htlc_outputs, claimed_htlcs, nondust_htlc_sources } => {
2365 log_trace!(logger, "Updating ChannelMonitor with latest holder commitment transaction info");
2366 if self.lockdown_from_offchain { panic!(); }
2367 if let Err(e) = self.provide_latest_holder_commitment_tx(commitment_tx.clone(), htlc_outputs.clone(), &claimed_htlcs, nondust_htlc_sources.clone()) {
2368 log_error!(logger, "Providing latest holder commitment transaction failed/was refused:");
2369 log_error!(logger, " {}", e);
2373 ChannelMonitorUpdateStep::LatestCounterpartyCommitmentTXInfo { commitment_txid, htlc_outputs, commitment_number, their_per_commitment_point } => {
2374 log_trace!(logger, "Updating ChannelMonitor with latest counterparty commitment transaction info");
2375 self.provide_latest_counterparty_commitment_tx(*commitment_txid, htlc_outputs.clone(), *commitment_number, *their_per_commitment_point, logger)
2377 ChannelMonitorUpdateStep::PaymentPreimage { payment_preimage } => {
2378 log_trace!(logger, "Updating ChannelMonitor with payment preimage");
2379 self.provide_payment_preimage(&PaymentHash(Sha256::hash(&payment_preimage.0[..]).into_inner()), &payment_preimage, broadcaster, &bounded_fee_estimator, logger)
2381 ChannelMonitorUpdateStep::CommitmentSecret { idx, secret } => {
2382 log_trace!(logger, "Updating ChannelMonitor with commitment secret");
2383 if let Err(e) = self.provide_secret(*idx, *secret) {
2384 log_error!(logger, "Providing latest counterparty commitment secret failed/was refused:");
2385 log_error!(logger, " {}", e);
2389 ChannelMonitorUpdateStep::ChannelForceClosed { should_broadcast } => {
2390 log_trace!(logger, "Updating ChannelMonitor: channel force closed, should broadcast: {}", should_broadcast);
2391 self.lockdown_from_offchain = true;
2392 if *should_broadcast {
2393 // There's no need to broadcast our commitment transaction if we've seen one
2394 // confirmed (even with 1 confirmation) as it'll be rejected as
2395 // duplicate/conflicting.
2396 let detected_funding_spend = self.funding_spend_confirmed.is_some() ||
2397 self.onchain_events_awaiting_threshold_conf.iter().find(|event| match event.event {
2398 OnchainEvent::FundingSpendConfirmation { .. } => true,
2401 if detected_funding_spend {
2404 self.broadcast_latest_holder_commitment_txn(broadcaster, logger);
2405 // If the channel supports anchor outputs, we'll need to emit an external
2406 // event to be consumed such that a child transaction is broadcast with a
2407 // high enough feerate for the parent commitment transaction to confirm.
2408 if self.onchain_tx_handler.opt_anchors() {
2409 let funding_output = HolderFundingOutput::build(
2410 self.funding_redeemscript.clone(), self.channel_value_satoshis,
2411 self.onchain_tx_handler.opt_anchors(),
2413 let best_block_height = self.best_block.height();
2414 let commitment_package = PackageTemplate::build_package(
2415 self.funding_info.0.txid.clone(), self.funding_info.0.index as u32,
2416 PackageSolvingData::HolderFundingOutput(funding_output),
2417 best_block_height, false, best_block_height,
2419 self.onchain_tx_handler.update_claims_view_from_requests(
2420 vec![commitment_package], best_block_height, best_block_height,
2421 broadcaster, &bounded_fee_estimator, logger,
2424 } else if !self.holder_tx_signed {
2425 log_error!(logger, "WARNING: You have a potentially-unsafe holder commitment transaction available to broadcast");
2426 log_error!(logger, " in channel monitor for channel {}!", log_bytes!(self.funding_info.0.to_channel_id()));
2427 log_error!(logger, " Read the docs for ChannelMonitor::get_latest_holder_commitment_txn and take manual action!");
2429 // If we generated a MonitorEvent::CommitmentTxConfirmed, the ChannelManager
2430 // will still give us a ChannelForceClosed event with !should_broadcast, but we
2431 // shouldn't print the scary warning above.
2432 log_info!(logger, "Channel off-chain state closed after we broadcasted our latest commitment transaction.");
2435 ChannelMonitorUpdateStep::ShutdownScript { scriptpubkey } => {
2436 log_trace!(logger, "Updating ChannelMonitor with shutdown script");
2437 if let Some(shutdown_script) = self.shutdown_script.replace(scriptpubkey.clone()) {
2438 panic!("Attempted to replace shutdown script {} with {}", shutdown_script, scriptpubkey);
2444 // If the updates succeeded and we were in an already closed channel state, then there's no
2445 // need to refuse any updates we expect to receive afer seeing a confirmed commitment.
2446 if ret.is_ok() && updates.update_id == CLOSED_CHANNEL_UPDATE_ID && self.latest_update_id == updates.update_id {
2450 self.latest_update_id = updates.update_id;
2452 if ret.is_ok() && self.funding_spend_seen {
2453 log_error!(logger, "Refusing Channel Monitor Update as counterparty attempted to update commitment after funding was spent");
2458 pub fn get_latest_update_id(&self) -> u64 {
2459 self.latest_update_id
2462 pub fn get_funding_txo(&self) -> &(OutPoint, Script) {
2466 pub fn get_outputs_to_watch(&self) -> &HashMap<Txid, Vec<(u32, Script)>> {
2467 // If we've detected a counterparty commitment tx on chain, we must include it in the set
2468 // of outputs to watch for spends of, otherwise we're likely to lose user funds. Because
2469 // its trivial to do, double-check that here.
2470 for (txid, _) in self.counterparty_commitment_txn_on_chain.iter() {
2471 self.outputs_to_watch.get(txid).expect("Counterparty commitment txn which have been broadcast should have outputs registered");
2473 &self.outputs_to_watch
2476 pub fn get_and_clear_pending_monitor_events(&mut self) -> Vec<MonitorEvent> {
2477 let mut ret = Vec::new();
2478 mem::swap(&mut ret, &mut self.pending_monitor_events);
2482 pub fn get_and_clear_pending_events(&mut self) -> Vec<Event> {
2483 let mut ret = Vec::new();
2484 mem::swap(&mut ret, &mut self.pending_events);
2486 for claim_event in self.onchain_tx_handler.get_and_clear_pending_claim_events().drain(..) {
2488 ClaimEvent::BumpCommitment {
2489 package_target_feerate_sat_per_1000_weight, commitment_tx, anchor_output_idx,
2491 let commitment_txid = commitment_tx.txid();
2492 debug_assert_eq!(self.current_holder_commitment_tx.txid, commitment_txid);
2493 let pending_htlcs = self.current_holder_commitment_tx.non_dust_htlcs();
2494 let commitment_tx_fee_satoshis = self.channel_value_satoshis -
2495 commitment_tx.output.iter().fold(0u64, |sum, output| sum + output.value);
2496 ret.push(Event::BumpTransaction(BumpTransactionEvent::ChannelClose {
2497 package_target_feerate_sat_per_1000_weight,
2499 commitment_tx_fee_satoshis,
2500 anchor_descriptor: AnchorDescriptor {
2501 channel_keys_id: self.channel_keys_id,
2502 channel_value_satoshis: self.channel_value_satoshis,
2503 outpoint: BitcoinOutPoint {
2504 txid: commitment_txid,
2505 vout: anchor_output_idx,
2511 ClaimEvent::BumpHTLC {
2512 target_feerate_sat_per_1000_weight, htlcs, tx_lock_time,
2514 let mut htlc_descriptors = Vec::with_capacity(htlcs.len());
2516 htlc_descriptors.push(HTLCDescriptor {
2517 channel_keys_id: self.channel_keys_id,
2518 channel_value_satoshis: self.channel_value_satoshis,
2519 channel_parameters: self.onchain_tx_handler.channel_transaction_parameters.clone(),
2520 commitment_txid: htlc.commitment_txid,
2521 per_commitment_number: htlc.per_commitment_number,
2523 preimage: htlc.preimage,
2524 counterparty_sig: htlc.counterparty_sig,
2527 ret.push(Event::BumpTransaction(BumpTransactionEvent::HTLCResolution {
2528 target_feerate_sat_per_1000_weight,
2538 /// Can only fail if idx is < get_min_seen_secret
2539 fn get_secret(&self, idx: u64) -> Option<[u8; 32]> {
2540 self.commitment_secrets.get_secret(idx)
2543 pub(crate) fn get_min_seen_secret(&self) -> u64 {
2544 self.commitment_secrets.get_min_seen_secret()
2547 pub(crate) fn get_cur_counterparty_commitment_number(&self) -> u64 {
2548 self.current_counterparty_commitment_number
2551 pub(crate) fn get_cur_holder_commitment_number(&self) -> u64 {
2552 self.current_holder_commitment_number
2555 /// Attempts to claim a counterparty commitment transaction's outputs using the revocation key and
2556 /// data in counterparty_claimable_outpoints. Will directly claim any HTLC outputs which expire at a
2557 /// height > height + CLTV_SHARED_CLAIM_BUFFER. In any case, will install monitoring for
2558 /// HTLC-Success/HTLC-Timeout transactions.
2560 /// Returns packages to claim the revoked output(s), as well as additional outputs to watch and
2561 /// general information about the output that is to the counterparty in the commitment
2563 fn check_spend_counterparty_transaction<L: Deref>(&mut self, tx: &Transaction, height: u32, block_hash: &BlockHash, logger: &L)
2564 -> (Vec<PackageTemplate>, TransactionOutputs, CommitmentTxCounterpartyOutputInfo)
2565 where L::Target: Logger {
2566 // Most secp and related errors trying to create keys means we have no hope of constructing
2567 // a spend transaction...so we return no transactions to broadcast
2568 let mut claimable_outpoints = Vec::new();
2569 let mut watch_outputs = Vec::new();
2570 let mut to_counterparty_output_info = None;
2572 let commitment_txid = tx.txid(); //TODO: This is gonna be a performance bottleneck for watchtowers!
2573 let per_commitment_option = self.counterparty_claimable_outpoints.get(&commitment_txid);
2575 macro_rules! ignore_error {
2576 ( $thing : expr ) => {
2579 Err(_) => return (claimable_outpoints, (commitment_txid, watch_outputs), to_counterparty_output_info)
2584 let commitment_number = 0xffffffffffff - ((((tx.input[0].sequence.0 as u64 & 0xffffff) << 3*8) | (tx.lock_time.0 as u64 & 0xffffff)) ^ self.commitment_transaction_number_obscure_factor);
2585 if commitment_number >= self.get_min_seen_secret() {
2586 let secret = self.get_secret(commitment_number).unwrap();
2587 let per_commitment_key = ignore_error!(SecretKey::from_slice(&secret));
2588 let per_commitment_point = PublicKey::from_secret_key(&self.onchain_tx_handler.secp_ctx, &per_commitment_key);
2589 let revocation_pubkey = chan_utils::derive_public_revocation_key(&self.onchain_tx_handler.secp_ctx, &per_commitment_point, &self.holder_revocation_basepoint);
2590 let delayed_key = chan_utils::derive_public_key(&self.onchain_tx_handler.secp_ctx, &PublicKey::from_secret_key(&self.onchain_tx_handler.secp_ctx, &per_commitment_key), &self.counterparty_commitment_params.counterparty_delayed_payment_base_key);
2592 let revokeable_redeemscript = chan_utils::get_revokeable_redeemscript(&revocation_pubkey, self.counterparty_commitment_params.on_counterparty_tx_csv, &delayed_key);
2593 let revokeable_p2wsh = revokeable_redeemscript.to_v0_p2wsh();
2595 // First, process non-htlc outputs (to_holder & to_counterparty)
2596 for (idx, outp) in tx.output.iter().enumerate() {
2597 if outp.script_pubkey == revokeable_p2wsh {
2598 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);
2599 let justice_package = PackageTemplate::build_package(commitment_txid, idx as u32, PackageSolvingData::RevokedOutput(revk_outp), height + self.counterparty_commitment_params.on_counterparty_tx_csv as u32, true, height);
2600 claimable_outpoints.push(justice_package);
2601 to_counterparty_output_info =
2602 Some((idx.try_into().expect("Txn can't have more than 2^32 outputs"), outp.value));
2606 // Then, try to find revoked htlc outputs
2607 if let Some(ref per_commitment_data) = per_commitment_option {
2608 for (_, &(ref htlc, _)) in per_commitment_data.iter().enumerate() {
2609 if let Some(transaction_output_index) = htlc.transaction_output_index {
2610 if transaction_output_index as usize >= tx.output.len() ||
2611 tx.output[transaction_output_index as usize].value != htlc.amount_msat / 1000 {
2612 // per_commitment_data is corrupt or our commitment signing key leaked!
2613 return (claimable_outpoints, (commitment_txid, watch_outputs),
2614 to_counterparty_output_info);
2616 let revk_htlc_outp = RevokedHTLCOutput::build(per_commitment_point, self.counterparty_commitment_params.counterparty_delayed_payment_base_key, self.counterparty_commitment_params.counterparty_htlc_base_key, per_commitment_key, htlc.amount_msat / 1000, htlc.clone(), self.onchain_tx_handler.channel_transaction_parameters.opt_anchors.is_some());
2617 let justice_package = PackageTemplate::build_package(commitment_txid, transaction_output_index, PackageSolvingData::RevokedHTLCOutput(revk_htlc_outp), htlc.cltv_expiry, true, height);
2618 claimable_outpoints.push(justice_package);
2623 // Last, track onchain revoked commitment transaction and fail backward outgoing HTLCs as payment path is broken
2624 if !claimable_outpoints.is_empty() || per_commitment_option.is_some() { // ie we're confident this is actually ours
2625 // We're definitely a counterparty commitment transaction!
2626 log_error!(logger, "Got broadcast of revoked counterparty commitment transaction, going to generate general spend tx with {} inputs", claimable_outpoints.len());
2627 for (idx, outp) in tx.output.iter().enumerate() {
2628 watch_outputs.push((idx as u32, outp.clone()));
2630 self.counterparty_commitment_txn_on_chain.insert(commitment_txid, commitment_number);
2632 if let Some(per_commitment_data) = per_commitment_option {
2633 fail_unbroadcast_htlcs!(self, "revoked_counterparty", commitment_txid, tx, height,
2634 block_hash, per_commitment_data.iter().map(|(htlc, htlc_source)|
2635 (htlc, htlc_source.as_ref().map(|htlc_source| htlc_source.as_ref()))
2638 debug_assert!(false, "We should have per-commitment option for any recognized old commitment txn");
2639 fail_unbroadcast_htlcs!(self, "revoked counterparty", commitment_txid, tx, height,
2640 block_hash, [].iter().map(|reference| *reference), logger);
2643 } else if let Some(per_commitment_data) = per_commitment_option {
2644 // While this isn't useful yet, there is a potential race where if a counterparty
2645 // revokes a state at the same time as the commitment transaction for that state is
2646 // confirmed, and the watchtower receives the block before the user, the user could
2647 // upload a new ChannelMonitor with the revocation secret but the watchtower has
2648 // already processed the block, resulting in the counterparty_commitment_txn_on_chain entry
2649 // not being generated by the above conditional. Thus, to be safe, we go ahead and
2651 for (idx, outp) in tx.output.iter().enumerate() {
2652 watch_outputs.push((idx as u32, outp.clone()));
2654 self.counterparty_commitment_txn_on_chain.insert(commitment_txid, commitment_number);
2656 log_info!(logger, "Got broadcast of non-revoked counterparty commitment transaction {}", commitment_txid);
2657 fail_unbroadcast_htlcs!(self, "counterparty", commitment_txid, tx, height, block_hash,
2658 per_commitment_data.iter().map(|(htlc, htlc_source)|
2659 (htlc, htlc_source.as_ref().map(|htlc_source| htlc_source.as_ref()))
2662 let (htlc_claim_reqs, counterparty_output_info) =
2663 self.get_counterparty_output_claim_info(commitment_number, commitment_txid, Some(tx));
2664 to_counterparty_output_info = counterparty_output_info;
2665 for req in htlc_claim_reqs {
2666 claimable_outpoints.push(req);
2670 (claimable_outpoints, (commitment_txid, watch_outputs), to_counterparty_output_info)
2673 /// Returns the HTLC claim package templates and the counterparty output info
2674 fn get_counterparty_output_claim_info(&self, commitment_number: u64, commitment_txid: Txid, tx: Option<&Transaction>)
2675 -> (Vec<PackageTemplate>, CommitmentTxCounterpartyOutputInfo) {
2676 let mut claimable_outpoints = Vec::new();
2677 let mut to_counterparty_output_info: CommitmentTxCounterpartyOutputInfo = None;
2679 let htlc_outputs = match self.counterparty_claimable_outpoints.get(&commitment_txid) {
2680 Some(outputs) => outputs,
2681 None => return (claimable_outpoints, to_counterparty_output_info),
2683 let per_commitment_points = match self.their_cur_per_commitment_points {
2684 Some(points) => points,
2685 None => return (claimable_outpoints, to_counterparty_output_info),
2688 let per_commitment_point =
2689 // If the counterparty commitment tx is the latest valid state, use their latest
2690 // per-commitment point
2691 if per_commitment_points.0 == commitment_number { &per_commitment_points.1 }
2692 else if let Some(point) = per_commitment_points.2.as_ref() {
2693 // If counterparty commitment tx is the state previous to the latest valid state, use
2694 // their previous per-commitment point (non-atomicity of revocation means it's valid for
2695 // them to temporarily have two valid commitment txns from our viewpoint)
2696 if per_commitment_points.0 == commitment_number + 1 {
2698 } else { return (claimable_outpoints, to_counterparty_output_info); }
2699 } else { return (claimable_outpoints, to_counterparty_output_info); };
2701 if let Some(transaction) = tx {
2702 let revocation_pubkey = chan_utils::derive_public_revocation_key(
2703 &self.onchain_tx_handler.secp_ctx, &per_commitment_point, &self.holder_revocation_basepoint);
2704 let delayed_key = chan_utils::derive_public_key(&self.onchain_tx_handler.secp_ctx,
2705 &per_commitment_point,
2706 &self.counterparty_commitment_params.counterparty_delayed_payment_base_key);
2707 let revokeable_p2wsh = chan_utils::get_revokeable_redeemscript(&revocation_pubkey,
2708 self.counterparty_commitment_params.on_counterparty_tx_csv,
2709 &delayed_key).to_v0_p2wsh();
2710 for (idx, outp) in transaction.output.iter().enumerate() {
2711 if outp.script_pubkey == revokeable_p2wsh {
2712 to_counterparty_output_info =
2713 Some((idx.try_into().expect("Can't have > 2^32 outputs"), outp.value));
2718 for (_, &(ref htlc, _)) in htlc_outputs.iter().enumerate() {
2719 if let Some(transaction_output_index) = htlc.transaction_output_index {
2720 if let Some(transaction) = tx {
2721 if transaction_output_index as usize >= transaction.output.len() ||
2722 transaction.output[transaction_output_index as usize].value != htlc.amount_msat / 1000 {
2723 // per_commitment_data is corrupt or our commitment signing key leaked!
2724 return (claimable_outpoints, to_counterparty_output_info);
2727 let preimage = if htlc.offered { if let Some(p) = self.payment_preimages.get(&htlc.payment_hash) { Some(*p) } else { None } } else { None };
2728 if preimage.is_some() || !htlc.offered {
2729 let counterparty_htlc_outp = if htlc.offered {
2730 PackageSolvingData::CounterpartyOfferedHTLCOutput(
2731 CounterpartyOfferedHTLCOutput::build(*per_commitment_point,
2732 self.counterparty_commitment_params.counterparty_delayed_payment_base_key,
2733 self.counterparty_commitment_params.counterparty_htlc_base_key,
2734 preimage.unwrap(), htlc.clone(), self.onchain_tx_handler.opt_anchors()))
2736 PackageSolvingData::CounterpartyReceivedHTLCOutput(
2737 CounterpartyReceivedHTLCOutput::build(*per_commitment_point,
2738 self.counterparty_commitment_params.counterparty_delayed_payment_base_key,
2739 self.counterparty_commitment_params.counterparty_htlc_base_key,
2740 htlc.clone(), self.onchain_tx_handler.opt_anchors()))
2742 let aggregation = if !htlc.offered { false } else { true };
2743 let counterparty_package = PackageTemplate::build_package(commitment_txid, transaction_output_index, counterparty_htlc_outp, htlc.cltv_expiry,aggregation, 0);
2744 claimable_outpoints.push(counterparty_package);
2749 (claimable_outpoints, to_counterparty_output_info)
2752 /// Attempts to claim a counterparty HTLC-Success/HTLC-Timeout's outputs using the revocation key
2753 fn check_spend_counterparty_htlc<L: Deref>(
2754 &mut self, tx: &Transaction, commitment_number: u64, commitment_txid: &Txid, height: u32, logger: &L
2755 ) -> (Vec<PackageTemplate>, Option<TransactionOutputs>) where L::Target: Logger {
2756 let secret = if let Some(secret) = self.get_secret(commitment_number) { secret } else { return (Vec::new(), None); };
2757 let per_commitment_key = match SecretKey::from_slice(&secret) {
2759 Err(_) => return (Vec::new(), None)
2761 let per_commitment_point = PublicKey::from_secret_key(&self.onchain_tx_handler.secp_ctx, &per_commitment_key);
2763 let htlc_txid = tx.txid();
2764 let mut claimable_outpoints = vec![];
2765 let mut outputs_to_watch = None;
2766 // Previously, we would only claim HTLCs from revoked HTLC transactions if they had 1 input
2767 // with a witness of 5 elements and 1 output. This wasn't enough for anchor outputs, as the
2768 // counterparty can now aggregate multiple HTLCs into a single transaction thanks to
2769 // `SIGHASH_SINGLE` remote signatures, leading us to not claim any HTLCs upon seeing a
2770 // confirmed revoked HTLC transaction (for more details, see
2771 // https://lists.linuxfoundation.org/pipermail/lightning-dev/2022-April/003561.html).
2773 // We make sure we're not vulnerable to this case by checking all inputs of the transaction,
2774 // and claim those which spend the commitment transaction, have a witness of 5 elements, and
2775 // have a corresponding output at the same index within the transaction.
2776 for (idx, input) in tx.input.iter().enumerate() {
2777 if input.previous_output.txid == *commitment_txid && input.witness.len() == 5 && tx.output.get(idx).is_some() {
2778 log_error!(logger, "Got broadcast of revoked counterparty HTLC transaction, spending {}:{}", htlc_txid, idx);
2779 let revk_outp = RevokedOutput::build(
2780 per_commitment_point, self.counterparty_commitment_params.counterparty_delayed_payment_base_key,
2781 self.counterparty_commitment_params.counterparty_htlc_base_key, per_commitment_key,
2782 tx.output[idx].value, self.counterparty_commitment_params.on_counterparty_tx_csv
2784 let justice_package = PackageTemplate::build_package(
2785 htlc_txid, idx as u32, PackageSolvingData::RevokedOutput(revk_outp),
2786 height + self.counterparty_commitment_params.on_counterparty_tx_csv as u32, true, height
2788 claimable_outpoints.push(justice_package);
2789 if outputs_to_watch.is_none() {
2790 outputs_to_watch = Some((htlc_txid, vec![]));
2792 outputs_to_watch.as_mut().unwrap().1.push((idx as u32, tx.output[idx].clone()));
2795 (claimable_outpoints, outputs_to_watch)
2798 // Returns (1) `PackageTemplate`s that can be given to the OnchainTxHandler, so that the handler can
2799 // broadcast transactions claiming holder HTLC commitment outputs and (2) a holder revokable
2800 // script so we can detect whether a holder transaction has been seen on-chain.
2801 fn get_broadcasted_holder_claims(&self, holder_tx: &HolderSignedTx, conf_height: u32) -> (Vec<PackageTemplate>, Option<(Script, PublicKey, PublicKey)>) {
2802 let mut claim_requests = Vec::with_capacity(holder_tx.htlc_outputs.len());
2804 let redeemscript = chan_utils::get_revokeable_redeemscript(&holder_tx.revocation_key, self.on_holder_tx_csv, &holder_tx.delayed_payment_key);
2805 let broadcasted_holder_revokable_script = Some((redeemscript.to_v0_p2wsh(), holder_tx.per_commitment_point.clone(), holder_tx.revocation_key.clone()));
2807 for &(ref htlc, _, _) in holder_tx.htlc_outputs.iter() {
2808 if let Some(transaction_output_index) = htlc.transaction_output_index {
2809 let (htlc_output, aggregable) = if htlc.offered {
2810 let htlc_output = HolderHTLCOutput::build_offered(
2811 htlc.amount_msat, htlc.cltv_expiry, self.onchain_tx_handler.opt_anchors()
2813 (htlc_output, false)
2815 let payment_preimage = if let Some(preimage) = self.payment_preimages.get(&htlc.payment_hash) {
2818 // We can't build an HTLC-Success transaction without the preimage
2821 let htlc_output = HolderHTLCOutput::build_accepted(
2822 payment_preimage, htlc.amount_msat, self.onchain_tx_handler.opt_anchors()
2824 (htlc_output, self.onchain_tx_handler.opt_anchors())
2826 let htlc_package = PackageTemplate::build_package(
2827 holder_tx.txid, transaction_output_index,
2828 PackageSolvingData::HolderHTLCOutput(htlc_output),
2829 htlc.cltv_expiry, aggregable, conf_height
2831 claim_requests.push(htlc_package);
2835 (claim_requests, broadcasted_holder_revokable_script)
2838 // Returns holder HTLC outputs to watch and react to in case of spending.
2839 fn get_broadcasted_holder_watch_outputs(&self, holder_tx: &HolderSignedTx, commitment_tx: &Transaction) -> Vec<(u32, TxOut)> {
2840 let mut watch_outputs = Vec::with_capacity(holder_tx.htlc_outputs.len());
2841 for &(ref htlc, _, _) in holder_tx.htlc_outputs.iter() {
2842 if let Some(transaction_output_index) = htlc.transaction_output_index {
2843 watch_outputs.push((transaction_output_index, commitment_tx.output[transaction_output_index as usize].clone()));
2849 /// Attempts to claim any claimable HTLCs in a commitment transaction which was not (yet)
2850 /// revoked using data in holder_claimable_outpoints.
2851 /// Should not be used if check_spend_revoked_transaction succeeds.
2852 /// Returns None unless the transaction is definitely one of our commitment transactions.
2853 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 {
2854 let commitment_txid = tx.txid();
2855 let mut claim_requests = Vec::new();
2856 let mut watch_outputs = Vec::new();
2858 macro_rules! append_onchain_update {
2859 ($updates: expr, $to_watch: expr) => {
2860 claim_requests = $updates.0;
2861 self.broadcasted_holder_revokable_script = $updates.1;
2862 watch_outputs.append(&mut $to_watch);
2866 // HTLCs set may differ between last and previous holder commitment txn, in case of one them hitting chain, ensure we cancel all HTLCs backward
2867 let mut is_holder_tx = false;
2869 if self.current_holder_commitment_tx.txid == commitment_txid {
2870 is_holder_tx = true;
2871 log_info!(logger, "Got broadcast of latest holder commitment tx {}, searching for available HTLCs to claim", commitment_txid);
2872 let res = self.get_broadcasted_holder_claims(&self.current_holder_commitment_tx, height);
2873 let mut to_watch = self.get_broadcasted_holder_watch_outputs(&self.current_holder_commitment_tx, tx);
2874 append_onchain_update!(res, to_watch);
2875 fail_unbroadcast_htlcs!(self, "latest holder", commitment_txid, tx, height,
2876 block_hash, self.current_holder_commitment_tx.htlc_outputs.iter()
2877 .map(|(htlc, _, htlc_source)| (htlc, htlc_source.as_ref())), logger);
2878 } else if let &Some(ref holder_tx) = &self.prev_holder_signed_commitment_tx {
2879 if holder_tx.txid == commitment_txid {
2880 is_holder_tx = true;
2881 log_info!(logger, "Got broadcast of previous holder commitment tx {}, searching for available HTLCs to claim", commitment_txid);
2882 let res = self.get_broadcasted_holder_claims(holder_tx, height);
2883 let mut to_watch = self.get_broadcasted_holder_watch_outputs(holder_tx, tx);
2884 append_onchain_update!(res, to_watch);
2885 fail_unbroadcast_htlcs!(self, "previous holder", commitment_txid, tx, height, block_hash,
2886 holder_tx.htlc_outputs.iter().map(|(htlc, _, htlc_source)| (htlc, htlc_source.as_ref())),
2892 Some((claim_requests, (commitment_txid, watch_outputs)))
2898 pub fn get_latest_holder_commitment_txn<L: Deref>(&mut self, logger: &L) -> Vec<Transaction> where L::Target: Logger {
2899 log_debug!(logger, "Getting signed latest holder commitment transaction!");
2900 self.holder_tx_signed = true;
2901 let commitment_tx = self.onchain_tx_handler.get_fully_signed_holder_tx(&self.funding_redeemscript);
2902 let txid = commitment_tx.txid();
2903 let mut holder_transactions = vec![commitment_tx];
2904 // When anchor outputs are present, the HTLC transactions are only valid once the commitment
2905 // transaction confirms.
2906 if self.onchain_tx_handler.opt_anchors() {
2907 return holder_transactions;
2909 for htlc in self.current_holder_commitment_tx.htlc_outputs.iter() {
2910 if let Some(vout) = htlc.0.transaction_output_index {
2911 let preimage = if !htlc.0.offered {
2912 if let Some(preimage) = self.payment_preimages.get(&htlc.0.payment_hash) { Some(preimage.clone()) } else {
2913 // We can't build an HTLC-Success transaction without the preimage
2916 } else if htlc.0.cltv_expiry > self.best_block.height() + 1 {
2917 // Don't broadcast HTLC-Timeout transactions immediately as they don't meet the
2918 // current locktime requirements on-chain. We will broadcast them in
2919 // `block_confirmed` when `should_broadcast_holder_commitment_txn` returns true.
2920 // Note that we add + 1 as transactions are broadcastable when they can be
2921 // confirmed in the next block.
2924 if let Some(htlc_tx) = self.onchain_tx_handler.get_fully_signed_htlc_tx(
2925 &::bitcoin::OutPoint { txid, vout }, &preimage) {
2926 holder_transactions.push(htlc_tx);
2930 // 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.
2931 // The data will be re-generated and tracked in check_spend_holder_transaction if we get a confirmation.
2935 #[cfg(any(test,feature = "unsafe_revoked_tx_signing"))]
2936 /// Note that this includes possibly-locktimed-in-the-future transactions!
2937 fn unsafe_get_latest_holder_commitment_txn<L: Deref>(&mut self, logger: &L) -> Vec<Transaction> where L::Target: Logger {
2938 log_debug!(logger, "Getting signed copy of latest holder commitment transaction!");
2939 let commitment_tx = self.onchain_tx_handler.get_fully_signed_copy_holder_tx(&self.funding_redeemscript);
2940 let txid = commitment_tx.txid();
2941 let mut holder_transactions = vec![commitment_tx];
2942 // When anchor outputs are present, the HTLC transactions are only final once the commitment
2943 // transaction confirms due to the CSV 1 encumberance.
2944 if self.onchain_tx_handler.opt_anchors() {
2945 return holder_transactions;
2947 for htlc in self.current_holder_commitment_tx.htlc_outputs.iter() {
2948 if let Some(vout) = htlc.0.transaction_output_index {
2949 let preimage = if !htlc.0.offered {
2950 if let Some(preimage) = self.payment_preimages.get(&htlc.0.payment_hash) { Some(preimage.clone()) } else {
2951 // We can't build an HTLC-Success transaction without the preimage
2955 if let Some(htlc_tx) = self.onchain_tx_handler.unsafe_get_fully_signed_htlc_tx(
2956 &::bitcoin::OutPoint { txid, vout }, &preimage) {
2957 holder_transactions.push(htlc_tx);
2964 pub fn block_connected<B: Deref, F: Deref, L: Deref>(&mut self, header: &BlockHeader, txdata: &TransactionData, height: u32, broadcaster: B, fee_estimator: F, logger: L) -> Vec<TransactionOutputs>
2965 where B::Target: BroadcasterInterface,
2966 F::Target: FeeEstimator,
2969 let block_hash = header.block_hash();
2970 self.best_block = BestBlock::new(block_hash, height);
2972 let bounded_fee_estimator = LowerBoundedFeeEstimator::new(fee_estimator);
2973 self.transactions_confirmed(header, txdata, height, broadcaster, &bounded_fee_estimator, logger)
2976 fn best_block_updated<B: Deref, F: Deref, L: Deref>(
2978 header: &BlockHeader,
2981 fee_estimator: &LowerBoundedFeeEstimator<F>,
2983 ) -> Vec<TransactionOutputs>
2985 B::Target: BroadcasterInterface,
2986 F::Target: FeeEstimator,
2989 let block_hash = header.block_hash();
2991 if height > self.best_block.height() {
2992 self.best_block = BestBlock::new(block_hash, height);
2993 self.block_confirmed(height, block_hash, vec![], vec![], vec![], &broadcaster, &fee_estimator, &logger)
2994 } else if block_hash != self.best_block.block_hash() {
2995 self.best_block = BestBlock::new(block_hash, height);
2996 self.onchain_events_awaiting_threshold_conf.retain(|ref entry| entry.height <= height);
2997 self.onchain_tx_handler.block_disconnected(height + 1, broadcaster, fee_estimator, logger);
2999 } else { Vec::new() }
3002 fn transactions_confirmed<B: Deref, F: Deref, L: Deref>(
3004 header: &BlockHeader,
3005 txdata: &TransactionData,
3008 fee_estimator: &LowerBoundedFeeEstimator<F>,
3010 ) -> Vec<TransactionOutputs>
3012 B::Target: BroadcasterInterface,
3013 F::Target: FeeEstimator,
3016 let txn_matched = self.filter_block(txdata);
3017 for tx in &txn_matched {
3018 let mut output_val = 0;
3019 for out in tx.output.iter() {
3020 if out.value > 21_000_000_0000_0000 { panic!("Value-overflowing transaction provided to block connected"); }
3021 output_val += out.value;
3022 if output_val > 21_000_000_0000_0000 { panic!("Value-overflowing transaction provided to block connected"); }
3026 let block_hash = header.block_hash();
3028 let mut watch_outputs = Vec::new();
3029 let mut claimable_outpoints = Vec::new();
3030 'tx_iter: for tx in &txn_matched {
3031 let txid = tx.txid();
3032 // If a transaction has already been confirmed, ensure we don't bother processing it duplicatively.
3033 if Some(txid) == self.funding_spend_confirmed {
3034 log_debug!(logger, "Skipping redundant processing of funding-spend tx {} as it was previously confirmed", txid);
3037 for ev in self.onchain_events_awaiting_threshold_conf.iter() {
3038 if ev.txid == txid {
3039 if let Some(conf_hash) = ev.block_hash {
3040 assert_eq!(header.block_hash(), conf_hash,
3041 "Transaction {} was already confirmed and is being re-confirmed in a different block.\n\
3042 This indicates a severe bug in the transaction connection logic - a reorg should have been processed first!", ev.txid);
3044 log_debug!(logger, "Skipping redundant processing of confirming tx {} as it was previously confirmed", txid);
3048 for htlc in self.htlcs_resolved_on_chain.iter() {
3049 if Some(txid) == htlc.resolving_txid {
3050 log_debug!(logger, "Skipping redundant processing of HTLC resolution tx {} as it was previously confirmed", txid);
3054 for spendable_txid in self.spendable_txids_confirmed.iter() {
3055 if txid == *spendable_txid {
3056 log_debug!(logger, "Skipping redundant processing of spendable tx {} as it was previously confirmed", txid);
3061 if tx.input.len() == 1 {
3062 // Assuming our keys were not leaked (in which case we're screwed no matter what),
3063 // commitment transactions and HTLC transactions will all only ever have one input
3064 // (except for HTLC transactions for channels with anchor outputs), which is an easy
3065 // way to filter out any potential non-matching txn for lazy filters.
3066 let prevout = &tx.input[0].previous_output;
3067 if prevout.txid == self.funding_info.0.txid && prevout.vout == self.funding_info.0.index as u32 {
3068 let mut balance_spendable_csv = None;
3069 log_info!(logger, "Channel {} closed by funding output spend in txid {}.",
3070 log_bytes!(self.funding_info.0.to_channel_id()), txid);
3071 self.funding_spend_seen = true;
3072 let mut commitment_tx_to_counterparty_output = None;
3073 if (tx.input[0].sequence.0 >> 8*3) as u8 == 0x80 && (tx.lock_time.0 >> 8*3) as u8 == 0x20 {
3074 let (mut new_outpoints, new_outputs, counterparty_output_idx_sats) =
3075 self.check_spend_counterparty_transaction(&tx, height, &block_hash, &logger);
3076 commitment_tx_to_counterparty_output = counterparty_output_idx_sats;
3077 if !new_outputs.1.is_empty() {
3078 watch_outputs.push(new_outputs);
3080 claimable_outpoints.append(&mut new_outpoints);
3081 if new_outpoints.is_empty() {
3082 if let Some((mut new_outpoints, new_outputs)) = self.check_spend_holder_transaction(&tx, height, &block_hash, &logger) {
3083 debug_assert!(commitment_tx_to_counterparty_output.is_none(),
3084 "A commitment transaction matched as both a counterparty and local commitment tx?");
3085 if !new_outputs.1.is_empty() {
3086 watch_outputs.push(new_outputs);
3088 claimable_outpoints.append(&mut new_outpoints);
3089 balance_spendable_csv = Some(self.on_holder_tx_csv);
3093 self.onchain_events_awaiting_threshold_conf.push(OnchainEventEntry {
3095 transaction: Some((*tx).clone()),
3097 block_hash: Some(block_hash),
3098 event: OnchainEvent::FundingSpendConfirmation {
3099 on_local_output_csv: balance_spendable_csv,
3100 commitment_tx_to_counterparty_output,
3105 if tx.input.len() >= 1 {
3106 // While all commitment transactions have one input, HTLC transactions may have more
3107 // if the HTLC was present in an anchor channel. HTLCs can also be resolved in a few
3108 // other ways which can have more than one output.
3109 for tx_input in &tx.input {
3110 let commitment_txid = tx_input.previous_output.txid;
3111 if let Some(&commitment_number) = self.counterparty_commitment_txn_on_chain.get(&commitment_txid) {
3112 let (mut new_outpoints, new_outputs_option) = self.check_spend_counterparty_htlc(
3113 &tx, commitment_number, &commitment_txid, height, &logger
3115 claimable_outpoints.append(&mut new_outpoints);
3116 if let Some(new_outputs) = new_outputs_option {
3117 watch_outputs.push(new_outputs);
3119 // Since there may be multiple HTLCs for this channel (all spending the
3120 // same commitment tx) being claimed by the counterparty within the same
3121 // transaction, and `check_spend_counterparty_htlc` already checks all the
3122 // ones relevant to this channel, we can safely break from our loop.
3126 self.is_resolving_htlc_output(&tx, height, &block_hash, &logger);
3128 self.is_paying_spendable_output(&tx, height, &block_hash, &logger);
3132 if height > self.best_block.height() {
3133 self.best_block = BestBlock::new(block_hash, height);
3136 self.block_confirmed(height, block_hash, txn_matched, watch_outputs, claimable_outpoints, &broadcaster, &fee_estimator, &logger)
3139 /// Update state for new block(s)/transaction(s) confirmed. Note that the caller must update
3140 /// `self.best_block` before calling if a new best blockchain tip is available. More
3141 /// concretely, `self.best_block` must never be at a lower height than `conf_height`, avoiding
3142 /// complexity especially in
3143 /// `OnchainTx::update_claims_view_from_requests`/`OnchainTx::update_claims_view_from_matched_txn`.
3145 /// `conf_height` should be set to the height at which any new transaction(s)/block(s) were
3146 /// confirmed at, even if it is not the current best height.
3147 fn block_confirmed<B: Deref, F: Deref, L: Deref>(
3150 conf_hash: BlockHash,
3151 txn_matched: Vec<&Transaction>,
3152 mut watch_outputs: Vec<TransactionOutputs>,
3153 mut claimable_outpoints: Vec<PackageTemplate>,
3155 fee_estimator: &LowerBoundedFeeEstimator<F>,
3157 ) -> Vec<TransactionOutputs>
3159 B::Target: BroadcasterInterface,
3160 F::Target: FeeEstimator,
3163 log_trace!(logger, "Processing {} matched transactions for block at height {}.", txn_matched.len(), conf_height);
3164 debug_assert!(self.best_block.height() >= conf_height);
3166 let should_broadcast = self.should_broadcast_holder_commitment_txn(logger);
3167 if should_broadcast {
3168 let funding_outp = HolderFundingOutput::build(self.funding_redeemscript.clone(), self.channel_value_satoshis, self.onchain_tx_handler.opt_anchors());
3169 let commitment_package = PackageTemplate::build_package(self.funding_info.0.txid.clone(), self.funding_info.0.index as u32, PackageSolvingData::HolderFundingOutput(funding_outp), self.best_block.height(), false, self.best_block.height());
3170 claimable_outpoints.push(commitment_package);
3171 self.pending_monitor_events.push(MonitorEvent::CommitmentTxConfirmed(self.funding_info.0));
3172 let commitment_tx = self.onchain_tx_handler.get_fully_signed_holder_tx(&self.funding_redeemscript);
3173 self.holder_tx_signed = true;
3174 // We can't broadcast our HTLC transactions while the commitment transaction is
3175 // unconfirmed. We'll delay doing so until we detect the confirmed commitment in
3176 // `transactions_confirmed`.
3177 if !self.onchain_tx_handler.opt_anchors() {
3178 // Because we're broadcasting a commitment transaction, we should construct the package
3179 // assuming it gets confirmed in the next block. Sadly, we have code which considers
3180 // "not yet confirmed" things as discardable, so we cannot do that here.
3181 let (mut new_outpoints, _) = self.get_broadcasted_holder_claims(&self.current_holder_commitment_tx, self.best_block.height());
3182 let new_outputs = self.get_broadcasted_holder_watch_outputs(&self.current_holder_commitment_tx, &commitment_tx);
3183 if !new_outputs.is_empty() {
3184 watch_outputs.push((self.current_holder_commitment_tx.txid.clone(), new_outputs));
3186 claimable_outpoints.append(&mut new_outpoints);
3190 // Find which on-chain events have reached their confirmation threshold.
3191 let onchain_events_awaiting_threshold_conf =
3192 self.onchain_events_awaiting_threshold_conf.drain(..).collect::<Vec<_>>();
3193 let mut onchain_events_reaching_threshold_conf = Vec::new();
3194 for entry in onchain_events_awaiting_threshold_conf {
3195 if entry.has_reached_confirmation_threshold(&self.best_block) {
3196 onchain_events_reaching_threshold_conf.push(entry);
3198 self.onchain_events_awaiting_threshold_conf.push(entry);
3202 // Used to check for duplicate HTLC resolutions.
3203 #[cfg(debug_assertions)]
3204 let unmatured_htlcs: Vec<_> = self.onchain_events_awaiting_threshold_conf
3206 .filter_map(|entry| match &entry.event {
3207 OnchainEvent::HTLCUpdate { source, .. } => Some(source),
3211 #[cfg(debug_assertions)]
3212 let mut matured_htlcs = Vec::new();
3214 // Produce actionable events from on-chain events having reached their threshold.
3215 for entry in onchain_events_reaching_threshold_conf.drain(..) {
3217 OnchainEvent::HTLCUpdate { ref source, payment_hash, htlc_value_satoshis, commitment_tx_output_idx } => {
3218 // Check for duplicate HTLC resolutions.
3219 #[cfg(debug_assertions)]
3222 unmatured_htlcs.iter().find(|&htlc| htlc == &source).is_none(),
3223 "An unmature HTLC transaction conflicts with a maturing one; failed to \
3224 call either transaction_unconfirmed for the conflicting transaction \
3225 or block_disconnected for a block containing it.");
3227 matured_htlcs.iter().find(|&htlc| htlc == source).is_none(),
3228 "A matured HTLC transaction conflicts with a maturing one; failed to \
3229 call either transaction_unconfirmed for the conflicting transaction \
3230 or block_disconnected for a block containing it.");
3231 matured_htlcs.push(source.clone());
3234 log_debug!(logger, "HTLC {} failure update in {} has got enough confirmations to be passed upstream",
3235 log_bytes!(payment_hash.0), entry.txid);
3236 self.pending_monitor_events.push(MonitorEvent::HTLCEvent(HTLCUpdate {
3238 payment_preimage: None,
3239 source: source.clone(),
3240 htlc_value_satoshis,
3242 self.htlcs_resolved_on_chain.push(IrrevocablyResolvedHTLC {
3243 commitment_tx_output_idx,
3244 resolving_txid: Some(entry.txid),
3245 resolving_tx: entry.transaction,
3246 payment_preimage: None,
3249 OnchainEvent::MaturingOutput { descriptor } => {
3250 log_debug!(logger, "Descriptor {} has got enough confirmations to be passed upstream", log_spendable!(descriptor));
3251 self.pending_events.push(Event::SpendableOutputs {
3252 outputs: vec![descriptor]
3254 self.spendable_txids_confirmed.push(entry.txid);
3256 OnchainEvent::HTLCSpendConfirmation { commitment_tx_output_idx, preimage, .. } => {
3257 self.htlcs_resolved_on_chain.push(IrrevocablyResolvedHTLC {
3258 commitment_tx_output_idx: Some(commitment_tx_output_idx),
3259 resolving_txid: Some(entry.txid),
3260 resolving_tx: entry.transaction,
3261 payment_preimage: preimage,
3264 OnchainEvent::FundingSpendConfirmation { commitment_tx_to_counterparty_output, .. } => {
3265 self.funding_spend_confirmed = Some(entry.txid);
3266 self.confirmed_commitment_tx_counterparty_output = commitment_tx_to_counterparty_output;
3271 self.onchain_tx_handler.update_claims_view_from_requests(claimable_outpoints, conf_height, self.best_block.height(), broadcaster, fee_estimator, logger);
3272 self.onchain_tx_handler.update_claims_view_from_matched_txn(&txn_matched, conf_height, conf_hash, self.best_block.height(), broadcaster, fee_estimator, logger);
3274 // Determine new outputs to watch by comparing against previously known outputs to watch,
3275 // updating the latter in the process.
3276 watch_outputs.retain(|&(ref txid, ref txouts)| {
3277 let idx_and_scripts = txouts.iter().map(|o| (o.0, o.1.script_pubkey.clone())).collect();
3278 self.outputs_to_watch.insert(txid.clone(), idx_and_scripts).is_none()
3282 // If we see a transaction for which we registered outputs previously,
3283 // make sure the registered scriptpubkey at the expected index match
3284 // the actual transaction output one. We failed this case before #653.
3285 for tx in &txn_matched {
3286 if let Some(outputs) = self.get_outputs_to_watch().get(&tx.txid()) {
3287 for idx_and_script in outputs.iter() {
3288 assert!((idx_and_script.0 as usize) < tx.output.len());
3289 assert_eq!(tx.output[idx_and_script.0 as usize].script_pubkey, idx_and_script.1);
3297 pub fn block_disconnected<B: Deref, F: Deref, L: Deref>(&mut self, header: &BlockHeader, height: u32, broadcaster: B, fee_estimator: F, logger: L)
3298 where B::Target: BroadcasterInterface,
3299 F::Target: FeeEstimator,
3302 log_trace!(logger, "Block {} at height {} disconnected", header.block_hash(), height);
3305 //- htlc update there as failure-trigger tx (revoked commitment tx, non-revoked commitment tx, HTLC-timeout tx) has been disconnected
3306 //- maturing spendable output has transaction paying us has been disconnected
3307 self.onchain_events_awaiting_threshold_conf.retain(|ref entry| entry.height < height);
3309 let bounded_fee_estimator = LowerBoundedFeeEstimator::new(fee_estimator);
3310 self.onchain_tx_handler.block_disconnected(height, broadcaster, &bounded_fee_estimator, logger);
3312 self.best_block = BestBlock::new(header.prev_blockhash, height - 1);
3315 fn transaction_unconfirmed<B: Deref, F: Deref, L: Deref>(
3319 fee_estimator: &LowerBoundedFeeEstimator<F>,
3322 B::Target: BroadcasterInterface,
3323 F::Target: FeeEstimator,
3326 let mut removed_height = None;
3327 for entry in self.onchain_events_awaiting_threshold_conf.iter() {
3328 if entry.txid == *txid {
3329 removed_height = Some(entry.height);
3334 if let Some(removed_height) = removed_height {
3335 log_info!(logger, "transaction_unconfirmed of txid {} implies height {} was reorg'd out", txid, removed_height);
3336 self.onchain_events_awaiting_threshold_conf.retain(|ref entry| if entry.height >= removed_height {
3337 log_info!(logger, "Transaction {} reorg'd out", entry.txid);
3342 debug_assert!(!self.onchain_events_awaiting_threshold_conf.iter().any(|ref entry| entry.txid == *txid));
3344 self.onchain_tx_handler.transaction_unconfirmed(txid, broadcaster, fee_estimator, logger);
3347 /// Filters a block's `txdata` for transactions spending watched outputs or for any child
3348 /// transactions thereof.
3349 fn filter_block<'a>(&self, txdata: &TransactionData<'a>) -> Vec<&'a Transaction> {
3350 let mut matched_txn = HashSet::new();
3351 txdata.iter().filter(|&&(_, tx)| {
3352 let mut matches = self.spends_watched_output(tx);
3353 for input in tx.input.iter() {
3354 if matches { break; }
3355 if matched_txn.contains(&input.previous_output.txid) {
3360 matched_txn.insert(tx.txid());
3363 }).map(|(_, tx)| *tx).collect()
3366 /// Checks if a given transaction spends any watched outputs.
3367 fn spends_watched_output(&self, tx: &Transaction) -> bool {
3368 for input in tx.input.iter() {
3369 if let Some(outputs) = self.get_outputs_to_watch().get(&input.previous_output.txid) {
3370 for (idx, _script_pubkey) in outputs.iter() {
3371 if *idx == input.previous_output.vout {
3374 // If the expected script is a known type, check that the witness
3375 // appears to be spending the correct type (ie that the match would
3376 // actually succeed in BIP 158/159-style filters).
3377 if _script_pubkey.is_v0_p2wsh() {
3378 if input.witness.last().unwrap().to_vec() == deliberately_bogus_accepted_htlc_witness_program() {
3379 // In at least one test we use a deliberately bogus witness
3380 // script which hit an old panic. Thus, we check for that here
3381 // and avoid the assert if its the expected bogus script.
3385 assert_eq!(&bitcoin::Address::p2wsh(&Script::from(input.witness.last().unwrap().to_vec()), bitcoin::Network::Bitcoin).script_pubkey(), _script_pubkey);
3386 } else if _script_pubkey.is_v0_p2wpkh() {
3387 assert_eq!(&bitcoin::Address::p2wpkh(&bitcoin::PublicKey::from_slice(&input.witness.last().unwrap()).unwrap(), bitcoin::Network::Bitcoin).unwrap().script_pubkey(), _script_pubkey);
3388 } else { panic!(); }
3399 fn should_broadcast_holder_commitment_txn<L: Deref>(&self, logger: &L) -> bool where L::Target: Logger {
3400 // There's no need to broadcast our commitment transaction if we've seen one confirmed (even
3401 // with 1 confirmation) as it'll be rejected as duplicate/conflicting.
3402 if self.funding_spend_confirmed.is_some() ||
3403 self.onchain_events_awaiting_threshold_conf.iter().find(|event| match event.event {
3404 OnchainEvent::FundingSpendConfirmation { .. } => true,
3410 // We need to consider all HTLCs which are:
3411 // * in any unrevoked counterparty commitment transaction, as they could broadcast said
3412 // transactions and we'd end up in a race, or
3413 // * are in our latest holder commitment transaction, as this is the thing we will
3414 // broadcast if we go on-chain.
3415 // Note that we consider HTLCs which were below dust threshold here - while they don't
3416 // strictly imply that we need to fail the channel, we need to go ahead and fail them back
3417 // to the source, and if we don't fail the channel we will have to ensure that the next
3418 // updates that peer sends us are update_fails, failing the channel if not. It's probably
3419 // easier to just fail the channel as this case should be rare enough anyway.
3420 let height = self.best_block.height();
3421 macro_rules! scan_commitment {
3422 ($htlcs: expr, $holder_tx: expr) => {
3423 for ref htlc in $htlcs {
3424 // For inbound HTLCs which we know the preimage for, we have to ensure we hit the
3425 // chain with enough room to claim the HTLC without our counterparty being able to
3426 // time out the HTLC first.
3427 // For outbound HTLCs which our counterparty hasn't failed/claimed, our primary
3428 // concern is being able to claim the corresponding inbound HTLC (on another
3429 // channel) before it expires. In fact, we don't even really care if our
3430 // counterparty here claims such an outbound HTLC after it expired as long as we
3431 // can still claim the corresponding HTLC. Thus, to avoid needlessly hitting the
3432 // chain when our counterparty is waiting for expiration to off-chain fail an HTLC
3433 // we give ourselves a few blocks of headroom after expiration before going
3434 // on-chain for an expired HTLC.
3435 // Note that, to avoid a potential attack whereby a node delays claiming an HTLC
3436 // from us until we've reached the point where we go on-chain with the
3437 // corresponding inbound HTLC, we must ensure that outbound HTLCs go on chain at
3438 // least CLTV_CLAIM_BUFFER blocks prior to the inbound HTLC.
3439 // aka outbound_cltv + LATENCY_GRACE_PERIOD_BLOCKS == height - CLTV_CLAIM_BUFFER
3440 // inbound_cltv == height + CLTV_CLAIM_BUFFER
3441 // outbound_cltv + LATENCY_GRACE_PERIOD_BLOCKS + CLTV_CLAIM_BUFFER <= inbound_cltv - CLTV_CLAIM_BUFFER
3442 // LATENCY_GRACE_PERIOD_BLOCKS + 2*CLTV_CLAIM_BUFFER <= inbound_cltv - outbound_cltv
3443 // CLTV_EXPIRY_DELTA <= inbound_cltv - outbound_cltv (by check in ChannelManager::decode_update_add_htlc_onion)
3444 // LATENCY_GRACE_PERIOD_BLOCKS + 2*CLTV_CLAIM_BUFFER <= CLTV_EXPIRY_DELTA
3445 // The final, above, condition is checked for statically in channelmanager
3446 // with CHECK_CLTV_EXPIRY_SANITY_2.
3447 let htlc_outbound = $holder_tx == htlc.offered;
3448 if ( htlc_outbound && htlc.cltv_expiry + LATENCY_GRACE_PERIOD_BLOCKS <= height) ||
3449 (!htlc_outbound && htlc.cltv_expiry <= height + CLTV_CLAIM_BUFFER && self.payment_preimages.contains_key(&htlc.payment_hash)) {
3450 log_info!(logger, "Force-closing channel due to {} HTLC timeout, HTLC expiry is {}", if htlc_outbound { "outbound" } else { "inbound "}, htlc.cltv_expiry);
3457 scan_commitment!(self.current_holder_commitment_tx.htlc_outputs.iter().map(|&(ref a, _, _)| a), true);
3459 if let Some(ref txid) = self.current_counterparty_commitment_txid {
3460 if let Some(ref htlc_outputs) = self.counterparty_claimable_outpoints.get(txid) {
3461 scan_commitment!(htlc_outputs.iter().map(|&(ref a, _)| a), false);
3464 if let Some(ref txid) = self.prev_counterparty_commitment_txid {
3465 if let Some(ref htlc_outputs) = self.counterparty_claimable_outpoints.get(txid) {
3466 scan_commitment!(htlc_outputs.iter().map(|&(ref a, _)| a), false);
3473 /// Check if any transaction broadcasted is resolving HTLC output by a success or timeout on a holder
3474 /// or counterparty commitment tx, if so send back the source, preimage if found and payment_hash of resolved HTLC
3475 fn is_resolving_htlc_output<L: Deref>(&mut self, tx: &Transaction, height: u32, block_hash: &BlockHash, logger: &L) where L::Target: Logger {
3476 'outer_loop: for input in &tx.input {
3477 let mut payment_data = None;
3478 let htlc_claim = HTLCClaim::from_witness(&input.witness);
3479 let revocation_sig_claim = htlc_claim == Some(HTLCClaim::Revocation);
3480 let accepted_preimage_claim = htlc_claim == Some(HTLCClaim::AcceptedPreimage);
3481 #[cfg(not(fuzzing))]
3482 let accepted_timeout_claim = htlc_claim == Some(HTLCClaim::AcceptedTimeout);
3483 let offered_preimage_claim = htlc_claim == Some(HTLCClaim::OfferedPreimage);
3484 #[cfg(not(fuzzing))]
3485 let offered_timeout_claim = htlc_claim == Some(HTLCClaim::OfferedTimeout);
3487 let mut payment_preimage = PaymentPreimage([0; 32]);
3488 if offered_preimage_claim || accepted_preimage_claim {
3489 payment_preimage.0.copy_from_slice(input.witness.second_to_last().unwrap());
3492 macro_rules! log_claim {
3493 ($tx_info: expr, $holder_tx: expr, $htlc: expr, $source_avail: expr) => {
3494 let outbound_htlc = $holder_tx == $htlc.offered;
3495 // HTLCs must either be claimed by a matching script type or through the
3497 #[cfg(not(fuzzing))] // Note that the fuzzer is not bound by pesky things like "signatures"
3498 debug_assert!(!$htlc.offered || offered_preimage_claim || offered_timeout_claim || revocation_sig_claim);
3499 #[cfg(not(fuzzing))] // Note that the fuzzer is not bound by pesky things like "signatures"
3500 debug_assert!($htlc.offered || accepted_preimage_claim || accepted_timeout_claim || revocation_sig_claim);
3501 // Further, only exactly one of the possible spend paths should have been
3502 // matched by any HTLC spend:
3503 #[cfg(not(fuzzing))] // Note that the fuzzer is not bound by pesky things like "signatures"
3504 debug_assert_eq!(accepted_preimage_claim as u8 + accepted_timeout_claim as u8 +
3505 offered_preimage_claim as u8 + offered_timeout_claim as u8 +
3506 revocation_sig_claim as u8, 1);
3507 if ($holder_tx && revocation_sig_claim) ||
3508 (outbound_htlc && !$source_avail && (accepted_preimage_claim || offered_preimage_claim)) {
3509 log_error!(logger, "Input spending {} ({}:{}) in {} resolves {} HTLC with payment hash {} with {}!",
3510 $tx_info, input.previous_output.txid, input.previous_output.vout, tx.txid(),
3511 if outbound_htlc { "outbound" } else { "inbound" }, log_bytes!($htlc.payment_hash.0),
3512 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" });
3514 log_info!(logger, "Input spending {} ({}:{}) in {} resolves {} HTLC with payment hash {} with {}",
3515 $tx_info, input.previous_output.txid, input.previous_output.vout, tx.txid(),
3516 if outbound_htlc { "outbound" } else { "inbound" }, log_bytes!($htlc.payment_hash.0),
3517 if revocation_sig_claim { "revocation sig" } else if accepted_preimage_claim || offered_preimage_claim { "preimage" } else { "timeout" });
3522 macro_rules! check_htlc_valid_counterparty {
3523 ($counterparty_txid: expr, $htlc_output: expr) => {
3524 if let Some(txid) = $counterparty_txid {
3525 for &(ref pending_htlc, ref pending_source) in self.counterparty_claimable_outpoints.get(&txid).unwrap() {
3526 if pending_htlc.payment_hash == $htlc_output.payment_hash && pending_htlc.amount_msat == $htlc_output.amount_msat {
3527 if let &Some(ref source) = pending_source {
3528 log_claim!("revoked counterparty commitment tx", false, pending_htlc, true);
3529 payment_data = Some(((**source).clone(), $htlc_output.payment_hash, $htlc_output.amount_msat));
3538 macro_rules! scan_commitment {
3539 ($htlcs: expr, $tx_info: expr, $holder_tx: expr) => {
3540 for (ref htlc_output, source_option) in $htlcs {
3541 if Some(input.previous_output.vout) == htlc_output.transaction_output_index {
3542 if let Some(ref source) = source_option {
3543 log_claim!($tx_info, $holder_tx, htlc_output, true);
3544 // We have a resolution of an HTLC either from one of our latest
3545 // holder commitment transactions or an unrevoked counterparty commitment
3546 // transaction. This implies we either learned a preimage, the HTLC
3547 // has timed out, or we screwed up. In any case, we should now
3548 // resolve the source HTLC with the original sender.
3549 payment_data = Some(((*source).clone(), htlc_output.payment_hash, htlc_output.amount_msat));
3550 } else if !$holder_tx {
3551 check_htlc_valid_counterparty!(self.current_counterparty_commitment_txid, htlc_output);
3552 if payment_data.is_none() {
3553 check_htlc_valid_counterparty!(self.prev_counterparty_commitment_txid, htlc_output);
3556 if payment_data.is_none() {
3557 log_claim!($tx_info, $holder_tx, htlc_output, false);
3558 let outbound_htlc = $holder_tx == htlc_output.offered;
3559 self.onchain_events_awaiting_threshold_conf.push(OnchainEventEntry {
3560 txid: tx.txid(), height, block_hash: Some(*block_hash), transaction: Some(tx.clone()),
3561 event: OnchainEvent::HTLCSpendConfirmation {
3562 commitment_tx_output_idx: input.previous_output.vout,
3563 preimage: if accepted_preimage_claim || offered_preimage_claim {
3564 Some(payment_preimage) } else { None },
3565 // If this is a payment to us (ie !outbound_htlc), wait for
3566 // the CSV delay before dropping the HTLC from claimable
3567 // balance if the claim was an HTLC-Success transaction (ie
3568 // accepted_preimage_claim).
3569 on_to_local_output_csv: if accepted_preimage_claim && !outbound_htlc {
3570 Some(self.on_holder_tx_csv) } else { None },
3573 continue 'outer_loop;
3580 if input.previous_output.txid == self.current_holder_commitment_tx.txid {
3581 scan_commitment!(self.current_holder_commitment_tx.htlc_outputs.iter().map(|&(ref a, _, ref b)| (a, b.as_ref())),
3582 "our latest holder commitment tx", true);
3584 if let Some(ref prev_holder_signed_commitment_tx) = self.prev_holder_signed_commitment_tx {
3585 if input.previous_output.txid == prev_holder_signed_commitment_tx.txid {
3586 scan_commitment!(prev_holder_signed_commitment_tx.htlc_outputs.iter().map(|&(ref a, _, ref b)| (a, b.as_ref())),
3587 "our previous holder commitment tx", true);
3590 if let Some(ref htlc_outputs) = self.counterparty_claimable_outpoints.get(&input.previous_output.txid) {
3591 scan_commitment!(htlc_outputs.iter().map(|&(ref a, ref b)| (a, (b.as_ref().clone()).map(|boxed| &**boxed))),
3592 "counterparty commitment tx", false);
3595 // Check that scan_commitment, above, decided there is some source worth relaying an
3596 // HTLC resolution backwards to and figure out whether we learned a preimage from it.
3597 if let Some((source, payment_hash, amount_msat)) = payment_data {
3598 if accepted_preimage_claim {
3599 if !self.pending_monitor_events.iter().any(
3600 |update| if let &MonitorEvent::HTLCEvent(ref upd) = update { upd.source == source } else { false }) {
3601 self.onchain_events_awaiting_threshold_conf.push(OnchainEventEntry {
3604 block_hash: Some(*block_hash),
3605 transaction: Some(tx.clone()),
3606 event: OnchainEvent::HTLCSpendConfirmation {
3607 commitment_tx_output_idx: input.previous_output.vout,
3608 preimage: Some(payment_preimage),
3609 on_to_local_output_csv: None,
3612 self.pending_monitor_events.push(MonitorEvent::HTLCEvent(HTLCUpdate {
3614 payment_preimage: Some(payment_preimage),
3616 htlc_value_satoshis: Some(amount_msat / 1000),
3619 } else if offered_preimage_claim {
3620 if !self.pending_monitor_events.iter().any(
3621 |update| if let &MonitorEvent::HTLCEvent(ref upd) = update {
3622 upd.source == source
3624 self.onchain_events_awaiting_threshold_conf.push(OnchainEventEntry {
3626 transaction: Some(tx.clone()),
3628 block_hash: Some(*block_hash),
3629 event: OnchainEvent::HTLCSpendConfirmation {
3630 commitment_tx_output_idx: input.previous_output.vout,
3631 preimage: Some(payment_preimage),
3632 on_to_local_output_csv: None,
3635 self.pending_monitor_events.push(MonitorEvent::HTLCEvent(HTLCUpdate {
3637 payment_preimage: Some(payment_preimage),
3639 htlc_value_satoshis: Some(amount_msat / 1000),
3643 self.onchain_events_awaiting_threshold_conf.retain(|ref entry| {
3644 if entry.height != height { return true; }
3646 OnchainEvent::HTLCUpdate { source: ref htlc_source, .. } => {
3647 *htlc_source != source
3652 let entry = OnchainEventEntry {
3654 transaction: Some(tx.clone()),
3656 block_hash: Some(*block_hash),
3657 event: OnchainEvent::HTLCUpdate {
3658 source, payment_hash,
3659 htlc_value_satoshis: Some(amount_msat / 1000),
3660 commitment_tx_output_idx: Some(input.previous_output.vout),
3663 log_info!(logger, "Failing HTLC with payment_hash {} timeout by a spend tx, waiting for confirmation (at height {})", log_bytes!(payment_hash.0), entry.confirmation_threshold());
3664 self.onchain_events_awaiting_threshold_conf.push(entry);
3670 /// Check if any transaction broadcasted is paying fund back to some address we can assume to own
3671 fn is_paying_spendable_output<L: Deref>(&mut self, tx: &Transaction, height: u32, block_hash: &BlockHash, logger: &L) where L::Target: Logger {
3672 let mut spendable_output = None;
3673 for (i, outp) in tx.output.iter().enumerate() { // There is max one spendable output for any channel tx, including ones generated by us
3674 if i > ::core::u16::MAX as usize {
3675 // While it is possible that an output exists on chain which is greater than the
3676 // 2^16th output in a given transaction, this is only possible if the output is not
3677 // in a lightning transaction and was instead placed there by some third party who
3678 // wishes to give us money for no reason.
3679 // Namely, any lightning transactions which we pre-sign will never have anywhere
3680 // near 2^16 outputs both because such transactions must have ~2^16 outputs who's
3681 // scripts are not longer than one byte in length and because they are inherently
3682 // non-standard due to their size.
3683 // Thus, it is completely safe to ignore such outputs, and while it may result in
3684 // us ignoring non-lightning fund to us, that is only possible if someone fills
3685 // nearly a full block with garbage just to hit this case.
3688 if outp.script_pubkey == self.destination_script {
3689 spendable_output = Some(SpendableOutputDescriptor::StaticOutput {
3690 outpoint: OutPoint { txid: tx.txid(), index: i as u16 },
3691 output: outp.clone(),
3695 if let Some(ref broadcasted_holder_revokable_script) = self.broadcasted_holder_revokable_script {
3696 if broadcasted_holder_revokable_script.0 == outp.script_pubkey {
3697 spendable_output = Some(SpendableOutputDescriptor::DelayedPaymentOutput(DelayedPaymentOutputDescriptor {
3698 outpoint: OutPoint { txid: tx.txid(), index: i as u16 },
3699 per_commitment_point: broadcasted_holder_revokable_script.1,
3700 to_self_delay: self.on_holder_tx_csv,
3701 output: outp.clone(),
3702 revocation_pubkey: broadcasted_holder_revokable_script.2.clone(),
3703 channel_keys_id: self.channel_keys_id,
3704 channel_value_satoshis: self.channel_value_satoshis,
3709 if self.counterparty_payment_script == outp.script_pubkey {
3710 spendable_output = Some(SpendableOutputDescriptor::StaticPaymentOutput(StaticPaymentOutputDescriptor {
3711 outpoint: OutPoint { txid: tx.txid(), index: i as u16 },
3712 output: outp.clone(),
3713 channel_keys_id: self.channel_keys_id,
3714 channel_value_satoshis: self.channel_value_satoshis,
3718 if self.shutdown_script.as_ref() == Some(&outp.script_pubkey) {
3719 spendable_output = Some(SpendableOutputDescriptor::StaticOutput {
3720 outpoint: OutPoint { txid: tx.txid(), index: i as u16 },
3721 output: outp.clone(),
3726 if let Some(spendable_output) = spendable_output {
3727 let entry = OnchainEventEntry {
3729 transaction: Some(tx.clone()),
3731 block_hash: Some(*block_hash),
3732 event: OnchainEvent::MaturingOutput { descriptor: spendable_output.clone() },
3734 log_info!(logger, "Received spendable output {}, spendable at height {}", log_spendable!(spendable_output), entry.confirmation_threshold());
3735 self.onchain_events_awaiting_threshold_conf.push(entry);
3740 impl<Signer: WriteableEcdsaChannelSigner, T: Deref, F: Deref, L: Deref> chain::Listen for (ChannelMonitor<Signer>, T, F, L)
3742 T::Target: BroadcasterInterface,
3743 F::Target: FeeEstimator,
3746 fn filtered_block_connected(&self, header: &BlockHeader, txdata: &TransactionData, height: u32) {
3747 self.0.block_connected(header, txdata, height, &*self.1, &*self.2, &*self.3);
3750 fn block_disconnected(&self, header: &BlockHeader, height: u32) {
3751 self.0.block_disconnected(header, height, &*self.1, &*self.2, &*self.3);
3755 impl<Signer: WriteableEcdsaChannelSigner, M, T: Deref, F: Deref, L: Deref> chain::Confirm for (M, T, F, L)
3757 M: Deref<Target = ChannelMonitor<Signer>>,
3758 T::Target: BroadcasterInterface,
3759 F::Target: FeeEstimator,
3762 fn transactions_confirmed(&self, header: &BlockHeader, txdata: &TransactionData, height: u32) {
3763 self.0.transactions_confirmed(header, txdata, height, &*self.1, &*self.2, &*self.3);
3766 fn transaction_unconfirmed(&self, txid: &Txid) {
3767 self.0.transaction_unconfirmed(txid, &*self.1, &*self.2, &*self.3);
3770 fn best_block_updated(&self, header: &BlockHeader, height: u32) {
3771 self.0.best_block_updated(header, height, &*self.1, &*self.2, &*self.3);
3774 fn get_relevant_txids(&self) -> Vec<(Txid, Option<BlockHash>)> {
3775 self.0.get_relevant_txids()
3779 const MAX_ALLOC_SIZE: usize = 64*1024;
3781 impl<'a, 'b, ES: EntropySource, SP: SignerProvider<Signer=Signer>, Signer: WriteableEcdsaChannelSigner> ReadableArgs<(&'a ES, &'b SP)>
3782 for (BlockHash, ChannelMonitor<Signer>) {
3783 fn read<R: io::Read>(reader: &mut R, args: (&'a ES, &'b SP)) -> Result<Self, DecodeError> {
3784 macro_rules! unwrap_obj {
3788 Err(_) => return Err(DecodeError::InvalidValue),
3793 let (entropy_source, signer_provider) = args;
3795 let _ver = read_ver_prefix!(reader, SERIALIZATION_VERSION);
3797 let latest_update_id: u64 = Readable::read(reader)?;
3798 let commitment_transaction_number_obscure_factor = <U48 as Readable>::read(reader)?.0;
3800 let destination_script = Readable::read(reader)?;
3801 let broadcasted_holder_revokable_script = match <u8 as Readable>::read(reader)? {
3803 let revokable_address = Readable::read(reader)?;
3804 let per_commitment_point = Readable::read(reader)?;
3805 let revokable_script = Readable::read(reader)?;
3806 Some((revokable_address, per_commitment_point, revokable_script))
3809 _ => return Err(DecodeError::InvalidValue),
3811 let counterparty_payment_script = Readable::read(reader)?;
3812 let shutdown_script = {
3813 let script = <Script as Readable>::read(reader)?;
3814 if script.is_empty() { None } else { Some(script) }
3817 let channel_keys_id = Readable::read(reader)?;
3818 let holder_revocation_basepoint = Readable::read(reader)?;
3819 // Technically this can fail and serialize fail a round-trip, but only for serialization of
3820 // barely-init'd ChannelMonitors that we can't do anything with.
3821 let outpoint = OutPoint {
3822 txid: Readable::read(reader)?,
3823 index: Readable::read(reader)?,
3825 let funding_info = (outpoint, Readable::read(reader)?);
3826 let current_counterparty_commitment_txid = Readable::read(reader)?;
3827 let prev_counterparty_commitment_txid = Readable::read(reader)?;
3829 let counterparty_commitment_params = Readable::read(reader)?;
3830 let funding_redeemscript = Readable::read(reader)?;
3831 let channel_value_satoshis = Readable::read(reader)?;
3833 let their_cur_per_commitment_points = {
3834 let first_idx = <U48 as Readable>::read(reader)?.0;
3838 let first_point = Readable::read(reader)?;
3839 let second_point_slice: [u8; 33] = Readable::read(reader)?;
3840 if second_point_slice[0..32] == [0; 32] && second_point_slice[32] == 0 {
3841 Some((first_idx, first_point, None))
3843 Some((first_idx, first_point, Some(unwrap_obj!(PublicKey::from_slice(&second_point_slice)))))
3848 let on_holder_tx_csv: u16 = Readable::read(reader)?;
3850 let commitment_secrets = Readable::read(reader)?;
3852 macro_rules! read_htlc_in_commitment {
3855 let offered: bool = Readable::read(reader)?;
3856 let amount_msat: u64 = Readable::read(reader)?;
3857 let cltv_expiry: u32 = Readable::read(reader)?;
3858 let payment_hash: PaymentHash = Readable::read(reader)?;
3859 let transaction_output_index: Option<u32> = Readable::read(reader)?;
3861 HTLCOutputInCommitment {
3862 offered, amount_msat, cltv_expiry, payment_hash, transaction_output_index
3868 let counterparty_claimable_outpoints_len: u64 = Readable::read(reader)?;
3869 let mut counterparty_claimable_outpoints = HashMap::with_capacity(cmp::min(counterparty_claimable_outpoints_len as usize, MAX_ALLOC_SIZE / 64));
3870 for _ in 0..counterparty_claimable_outpoints_len {
3871 let txid: Txid = Readable::read(reader)?;
3872 let htlcs_count: u64 = Readable::read(reader)?;
3873 let mut htlcs = Vec::with_capacity(cmp::min(htlcs_count as usize, MAX_ALLOC_SIZE / 32));
3874 for _ in 0..htlcs_count {
3875 htlcs.push((read_htlc_in_commitment!(), <Option<HTLCSource> as Readable>::read(reader)?.map(|o: HTLCSource| Box::new(o))));
3877 if let Some(_) = counterparty_claimable_outpoints.insert(txid, htlcs) {
3878 return Err(DecodeError::InvalidValue);
3882 let counterparty_commitment_txn_on_chain_len: u64 = Readable::read(reader)?;
3883 let mut counterparty_commitment_txn_on_chain = HashMap::with_capacity(cmp::min(counterparty_commitment_txn_on_chain_len as usize, MAX_ALLOC_SIZE / 32));
3884 for _ in 0..counterparty_commitment_txn_on_chain_len {
3885 let txid: Txid = Readable::read(reader)?;
3886 let commitment_number = <U48 as Readable>::read(reader)?.0;
3887 if let Some(_) = counterparty_commitment_txn_on_chain.insert(txid, commitment_number) {
3888 return Err(DecodeError::InvalidValue);
3892 let counterparty_hash_commitment_number_len: u64 = Readable::read(reader)?;
3893 let mut counterparty_hash_commitment_number = HashMap::with_capacity(cmp::min(counterparty_hash_commitment_number_len as usize, MAX_ALLOC_SIZE / 32));
3894 for _ in 0..counterparty_hash_commitment_number_len {
3895 let payment_hash: PaymentHash = Readable::read(reader)?;
3896 let commitment_number = <U48 as Readable>::read(reader)?.0;
3897 if let Some(_) = counterparty_hash_commitment_number.insert(payment_hash, commitment_number) {
3898 return Err(DecodeError::InvalidValue);
3902 let mut prev_holder_signed_commitment_tx: Option<HolderSignedTx> =
3903 match <u8 as Readable>::read(reader)? {
3906 Some(Readable::read(reader)?)
3908 _ => return Err(DecodeError::InvalidValue),
3910 let mut current_holder_commitment_tx: HolderSignedTx = Readable::read(reader)?;
3912 let current_counterparty_commitment_number = <U48 as Readable>::read(reader)?.0;
3913 let current_holder_commitment_number = <U48 as Readable>::read(reader)?.0;
3915 let payment_preimages_len: u64 = Readable::read(reader)?;
3916 let mut payment_preimages = HashMap::with_capacity(cmp::min(payment_preimages_len as usize, MAX_ALLOC_SIZE / 32));
3917 for _ in 0..payment_preimages_len {
3918 let preimage: PaymentPreimage = Readable::read(reader)?;
3919 let hash = PaymentHash(Sha256::hash(&preimage.0[..]).into_inner());
3920 if let Some(_) = payment_preimages.insert(hash, preimage) {
3921 return Err(DecodeError::InvalidValue);
3925 let pending_monitor_events_len: u64 = Readable::read(reader)?;
3926 let mut pending_monitor_events = Some(
3927 Vec::with_capacity(cmp::min(pending_monitor_events_len as usize, MAX_ALLOC_SIZE / (32 + 8*3))));
3928 for _ in 0..pending_monitor_events_len {
3929 let ev = match <u8 as Readable>::read(reader)? {
3930 0 => MonitorEvent::HTLCEvent(Readable::read(reader)?),
3931 1 => MonitorEvent::CommitmentTxConfirmed(funding_info.0),
3932 _ => return Err(DecodeError::InvalidValue)
3934 pending_monitor_events.as_mut().unwrap().push(ev);
3937 let pending_events_len: u64 = Readable::read(reader)?;
3938 let mut pending_events = Vec::with_capacity(cmp::min(pending_events_len as usize, MAX_ALLOC_SIZE / mem::size_of::<Event>()));
3939 for _ in 0..pending_events_len {
3940 if let Some(event) = MaybeReadable::read(reader)? {
3941 pending_events.push(event);
3945 let best_block = BestBlock::new(Readable::read(reader)?, Readable::read(reader)?);
3947 let waiting_threshold_conf_len: u64 = Readable::read(reader)?;
3948 let mut onchain_events_awaiting_threshold_conf = Vec::with_capacity(cmp::min(waiting_threshold_conf_len as usize, MAX_ALLOC_SIZE / 128));
3949 for _ in 0..waiting_threshold_conf_len {
3950 if let Some(val) = MaybeReadable::read(reader)? {
3951 onchain_events_awaiting_threshold_conf.push(val);
3955 let outputs_to_watch_len: u64 = Readable::read(reader)?;
3956 let mut outputs_to_watch = HashMap::with_capacity(cmp::min(outputs_to_watch_len as usize, MAX_ALLOC_SIZE / (mem::size_of::<Txid>() + mem::size_of::<u32>() + mem::size_of::<Vec<Script>>())));
3957 for _ in 0..outputs_to_watch_len {
3958 let txid = Readable::read(reader)?;
3959 let outputs_len: u64 = Readable::read(reader)?;
3960 let mut outputs = Vec::with_capacity(cmp::min(outputs_len as usize, MAX_ALLOC_SIZE / (mem::size_of::<u32>() + mem::size_of::<Script>())));
3961 for _ in 0..outputs_len {
3962 outputs.push((Readable::read(reader)?, Readable::read(reader)?));
3964 if let Some(_) = outputs_to_watch.insert(txid, outputs) {
3965 return Err(DecodeError::InvalidValue);
3968 let onchain_tx_handler: OnchainTxHandler<SP::Signer> = ReadableArgs::read(
3969 reader, (entropy_source, signer_provider, channel_value_satoshis, channel_keys_id)
3972 let lockdown_from_offchain = Readable::read(reader)?;
3973 let holder_tx_signed = Readable::read(reader)?;
3975 if let Some(prev_commitment_tx) = prev_holder_signed_commitment_tx.as_mut() {
3976 let prev_holder_value = onchain_tx_handler.get_prev_holder_commitment_to_self_value();
3977 if prev_holder_value.is_none() { return Err(DecodeError::InvalidValue); }
3978 if prev_commitment_tx.to_self_value_sat == u64::max_value() {
3979 prev_commitment_tx.to_self_value_sat = prev_holder_value.unwrap();
3980 } else if prev_commitment_tx.to_self_value_sat != prev_holder_value.unwrap() {
3981 return Err(DecodeError::InvalidValue);
3985 let cur_holder_value = onchain_tx_handler.get_cur_holder_commitment_to_self_value();
3986 if current_holder_commitment_tx.to_self_value_sat == u64::max_value() {
3987 current_holder_commitment_tx.to_self_value_sat = cur_holder_value;
3988 } else if current_holder_commitment_tx.to_self_value_sat != cur_holder_value {
3989 return Err(DecodeError::InvalidValue);
3992 let mut funding_spend_confirmed = None;
3993 let mut htlcs_resolved_on_chain = Some(Vec::new());
3994 let mut funding_spend_seen = Some(false);
3995 let mut counterparty_node_id = None;
3996 let mut confirmed_commitment_tx_counterparty_output = None;
3997 let mut spendable_txids_confirmed = Some(Vec::new());
3998 let mut counterparty_fulfilled_htlcs = Some(HashMap::new());
3999 read_tlv_fields!(reader, {
4000 (1, funding_spend_confirmed, option),
4001 (3, htlcs_resolved_on_chain, vec_type),
4002 (5, pending_monitor_events, vec_type),
4003 (7, funding_spend_seen, option),
4004 (9, counterparty_node_id, option),
4005 (11, confirmed_commitment_tx_counterparty_output, option),
4006 (13, spendable_txids_confirmed, vec_type),
4007 (15, counterparty_fulfilled_htlcs, option),
4010 Ok((best_block.block_hash(), ChannelMonitor::from_impl(ChannelMonitorImpl {
4012 commitment_transaction_number_obscure_factor,
4015 broadcasted_holder_revokable_script,
4016 counterparty_payment_script,
4020 holder_revocation_basepoint,
4022 current_counterparty_commitment_txid,
4023 prev_counterparty_commitment_txid,
4025 counterparty_commitment_params,
4026 funding_redeemscript,
4027 channel_value_satoshis,
4028 their_cur_per_commitment_points,
4033 counterparty_claimable_outpoints,
4034 counterparty_commitment_txn_on_chain,
4035 counterparty_hash_commitment_number,
4036 counterparty_fulfilled_htlcs: counterparty_fulfilled_htlcs.unwrap(),
4038 prev_holder_signed_commitment_tx,
4039 current_holder_commitment_tx,
4040 current_counterparty_commitment_number,
4041 current_holder_commitment_number,
4044 pending_monitor_events: pending_monitor_events.unwrap(),
4047 onchain_events_awaiting_threshold_conf,
4052 lockdown_from_offchain,
4054 funding_spend_seen: funding_spend_seen.unwrap(),
4055 funding_spend_confirmed,
4056 confirmed_commitment_tx_counterparty_output,
4057 htlcs_resolved_on_chain: htlcs_resolved_on_chain.unwrap(),
4058 spendable_txids_confirmed: spendable_txids_confirmed.unwrap(),
4061 counterparty_node_id,
4068 use bitcoin::blockdata::block::BlockHeader;
4069 use bitcoin::blockdata::script::{Script, Builder};
4070 use bitcoin::blockdata::opcodes;
4071 use bitcoin::blockdata::transaction::{Transaction, TxIn, TxOut, EcdsaSighashType};
4072 use bitcoin::blockdata::transaction::OutPoint as BitcoinOutPoint;
4073 use bitcoin::util::sighash;
4074 use bitcoin::hashes::Hash;
4075 use bitcoin::hashes::sha256::Hash as Sha256;
4076 use bitcoin::hashes::hex::FromHex;
4077 use bitcoin::hash_types::{BlockHash, Txid};
4078 use bitcoin::network::constants::Network;
4079 use bitcoin::secp256k1::{SecretKey,PublicKey};
4080 use bitcoin::secp256k1::Secp256k1;
4084 use crate::chain::chaininterface::LowerBoundedFeeEstimator;
4086 use super::ChannelMonitorUpdateStep;
4087 use crate::{check_added_monitors, check_closed_broadcast, check_closed_event, check_spends, get_local_commitment_txn, get_monitor, get_route_and_payment_hash, unwrap_send_err};
4088 use crate::chain::{BestBlock, Confirm};
4089 use crate::chain::channelmonitor::ChannelMonitor;
4090 use crate::chain::package::{weight_offered_htlc, weight_received_htlc, weight_revoked_offered_htlc, weight_revoked_received_htlc, WEIGHT_REVOKED_OUTPUT};
4091 use crate::chain::transaction::OutPoint;
4092 use crate::chain::keysinterface::InMemorySigner;
4093 use crate::events::ClosureReason;
4094 use crate::ln::{PaymentPreimage, PaymentHash};
4095 use crate::ln::chan_utils;
4096 use crate::ln::chan_utils::{HTLCOutputInCommitment, ChannelPublicKeys, ChannelTransactionParameters, HolderCommitmentTransaction, CounterpartyChannelTransactionParameters};
4097 use crate::ln::channelmanager::{PaymentSendFailure, PaymentId, RecipientOnionFields};
4098 use crate::ln::functional_test_utils::*;
4099 use crate::ln::script::ShutdownScript;
4100 use crate::util::errors::APIError;
4101 use crate::util::test_utils::{TestLogger, TestBroadcaster, TestFeeEstimator};
4102 use crate::util::ser::{ReadableArgs, Writeable};
4103 use crate::sync::{Arc, Mutex};
4105 use bitcoin::{PackedLockTime, Sequence, TxMerkleNode, Witness};
4106 use crate::prelude::*;
4108 fn do_test_funding_spend_refuses_updates(use_local_txn: bool) {
4109 // Previously, monitor updates were allowed freely even after a funding-spend transaction
4110 // confirmed. This would allow a race condition where we could receive a payment (including
4111 // the counterparty revoking their broadcasted state!) and accept it without recourse as
4112 // long as the ChannelMonitor receives the block first, the full commitment update dance
4113 // occurs after the block is connected, and before the ChannelManager receives the block.
4114 // Obviously this is an incredibly contrived race given the counterparty would be risking
4115 // their full channel balance for it, but its worth fixing nonetheless as it makes the
4116 // potential ChannelMonitor states simpler to reason about.
4118 // This test checks said behavior, as well as ensuring a ChannelMonitorUpdate with multiple
4119 // updates is handled correctly in such conditions.
4120 let chanmon_cfgs = create_chanmon_cfgs(3);
4121 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
4122 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
4123 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
4124 let channel = create_announced_chan_between_nodes(&nodes, 0, 1);
4125 create_announced_chan_between_nodes(&nodes, 1, 2);
4127 // Rebalance somewhat
4128 send_payment(&nodes[0], &[&nodes[1]], 10_000_000);
4130 // First route two payments for testing at the end
4131 let payment_preimage_1 = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 1_000_000).0;
4132 let payment_preimage_2 = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 1_000_000).0;
4134 let local_txn = get_local_commitment_txn!(nodes[1], channel.2);
4135 assert_eq!(local_txn.len(), 1);
4136 let remote_txn = get_local_commitment_txn!(nodes[0], channel.2);
4137 assert_eq!(remote_txn.len(), 3); // Commitment and two HTLC-Timeouts
4138 check_spends!(remote_txn[1], remote_txn[0]);
4139 check_spends!(remote_txn[2], remote_txn[0]);
4140 let broadcast_tx = if use_local_txn { &local_txn[0] } else { &remote_txn[0] };
4142 // Connect a commitment transaction, but only to the ChainMonitor/ChannelMonitor. The
4143 // channel is now closed, but the ChannelManager doesn't know that yet.
4144 let new_header = BlockHeader {
4145 version: 2, time: 0, bits: 0, nonce: 0,
4146 prev_blockhash: nodes[0].best_block_info().0,
4147 merkle_root: TxMerkleNode::all_zeros() };
4148 let conf_height = nodes[0].best_block_info().1 + 1;
4149 nodes[1].chain_monitor.chain_monitor.transactions_confirmed(&new_header,
4150 &[(0, broadcast_tx)], conf_height);
4152 let (_, pre_update_monitor) = <(BlockHash, ChannelMonitor<InMemorySigner>)>::read(
4153 &mut io::Cursor::new(&get_monitor!(nodes[1], channel.2).encode()),
4154 (&nodes[1].keys_manager.backing, &nodes[1].keys_manager.backing)).unwrap();
4156 // If the ChannelManager tries to update the channel, however, the ChainMonitor will pass
4157 // the update through to the ChannelMonitor which will refuse it (as the channel is closed).
4158 let (route, payment_hash, _, payment_secret) = get_route_and_payment_hash!(nodes[1], nodes[0], 100_000);
4159 unwrap_send_err!(nodes[1].node.send_payment_with_route(&route, payment_hash,
4160 RecipientOnionFields::secret_only(payment_secret), PaymentId(payment_hash.0)
4161 ), true, APIError::ChannelUnavailable { ref err },
4162 assert!(err.contains("ChannelMonitor storage failure")));
4163 check_added_monitors!(nodes[1], 2); // After the failure we generate a close-channel monitor update
4164 check_closed_broadcast!(nodes[1], true);
4165 check_closed_event!(nodes[1], 1, ClosureReason::ProcessingError { err: "ChannelMonitor storage failure".to_string() });
4167 // Build a new ChannelMonitorUpdate which contains both the failing commitment tx update
4168 // and provides the claim preimages for the two pending HTLCs. The first update generates
4169 // an error, but the point of this test is to ensure the later updates are still applied.
4170 let monitor_updates = nodes[1].chain_monitor.monitor_updates.lock().unwrap();
4171 let mut replay_update = monitor_updates.get(&channel.2).unwrap().iter().rev().skip(1).next().unwrap().clone();
4172 assert_eq!(replay_update.updates.len(), 1);
4173 if let ChannelMonitorUpdateStep::LatestCounterpartyCommitmentTXInfo { .. } = replay_update.updates[0] {
4174 } else { panic!(); }
4175 replay_update.updates.push(ChannelMonitorUpdateStep::PaymentPreimage { payment_preimage: payment_preimage_1 });
4176 replay_update.updates.push(ChannelMonitorUpdateStep::PaymentPreimage { payment_preimage: payment_preimage_2 });
4178 let broadcaster = TestBroadcaster::with_blocks(Arc::clone(&nodes[1].blocks));
4180 pre_update_monitor.update_monitor(&replay_update, &&broadcaster, &chanmon_cfgs[1].fee_estimator, &nodes[1].logger)
4182 // Even though we error'd on the first update, we should still have generated an HTLC claim
4184 let txn_broadcasted = broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
4185 assert!(txn_broadcasted.len() >= 2);
4186 let htlc_txn = txn_broadcasted.iter().filter(|tx| {
4187 assert_eq!(tx.input.len(), 1);
4188 tx.input[0].previous_output.txid == broadcast_tx.txid()
4189 }).collect::<Vec<_>>();
4190 assert_eq!(htlc_txn.len(), 2);
4191 check_spends!(htlc_txn[0], broadcast_tx);
4192 check_spends!(htlc_txn[1], broadcast_tx);
4195 fn test_funding_spend_refuses_updates() {
4196 do_test_funding_spend_refuses_updates(true);
4197 do_test_funding_spend_refuses_updates(false);
4201 fn test_prune_preimages() {
4202 let secp_ctx = Secp256k1::new();
4203 let logger = Arc::new(TestLogger::new());
4204 let broadcaster = Arc::new(TestBroadcaster::new(Network::Testnet));
4205 let fee_estimator = TestFeeEstimator { sat_per_kw: Mutex::new(253) };
4207 let dummy_key = PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[42; 32]).unwrap());
4209 let mut preimages = Vec::new();
4212 let preimage = PaymentPreimage([i; 32]);
4213 let hash = PaymentHash(Sha256::hash(&preimage.0[..]).into_inner());
4214 preimages.push((preimage, hash));
4218 macro_rules! preimages_slice_to_htlcs {
4219 ($preimages_slice: expr) => {
4221 let mut res = Vec::new();
4222 for (idx, preimage) in $preimages_slice.iter().enumerate() {
4223 res.push((HTLCOutputInCommitment {
4227 payment_hash: preimage.1.clone(),
4228 transaction_output_index: Some(idx as u32),
4235 macro_rules! preimages_slice_to_htlc_outputs {
4236 ($preimages_slice: expr) => {
4237 preimages_slice_to_htlcs!($preimages_slice).into_iter().map(|(htlc, _)| (htlc, None)).collect()
4240 let dummy_sig = crate::util::crypto::sign(&secp_ctx,
4241 &bitcoin::secp256k1::Message::from_slice(&[42; 32]).unwrap(),
4242 &SecretKey::from_slice(&[42; 32]).unwrap());
4244 macro_rules! test_preimages_exist {
4245 ($preimages_slice: expr, $monitor: expr) => {
4246 for preimage in $preimages_slice {
4247 assert!($monitor.inner.lock().unwrap().payment_preimages.contains_key(&preimage.1));
4252 let keys = InMemorySigner::new(
4254 SecretKey::from_slice(&[41; 32]).unwrap(),
4255 SecretKey::from_slice(&[41; 32]).unwrap(),
4256 SecretKey::from_slice(&[41; 32]).unwrap(),
4257 SecretKey::from_slice(&[41; 32]).unwrap(),
4258 SecretKey::from_slice(&[41; 32]).unwrap(),
4265 let counterparty_pubkeys = ChannelPublicKeys {
4266 funding_pubkey: PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[44; 32]).unwrap()),
4267 revocation_basepoint: PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[45; 32]).unwrap()),
4268 payment_point: PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[46; 32]).unwrap()),
4269 delayed_payment_basepoint: PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[47; 32]).unwrap()),
4270 htlc_basepoint: PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[48; 32]).unwrap())
4272 let funding_outpoint = OutPoint { txid: Txid::all_zeros(), index: u16::max_value() };
4273 let channel_parameters = ChannelTransactionParameters {
4274 holder_pubkeys: keys.holder_channel_pubkeys.clone(),
4275 holder_selected_contest_delay: 66,
4276 is_outbound_from_holder: true,
4277 counterparty_parameters: Some(CounterpartyChannelTransactionParameters {
4278 pubkeys: counterparty_pubkeys,
4279 selected_contest_delay: 67,
4281 funding_outpoint: Some(funding_outpoint),
4283 opt_non_zero_fee_anchors: None,
4285 // Prune with one old state and a holder commitment tx holding a few overlaps with the
4287 let shutdown_pubkey = PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[42; 32]).unwrap());
4288 let best_block = BestBlock::from_network(Network::Testnet);
4289 let monitor = ChannelMonitor::new(Secp256k1::new(), keys,
4290 Some(ShutdownScript::new_p2wpkh_from_pubkey(shutdown_pubkey).into_inner()), 0, &Script::new(),
4291 (OutPoint { txid: Txid::from_slice(&[43; 32]).unwrap(), index: 0 }, Script::new()),
4292 &channel_parameters, Script::new(), 46, 0, HolderCommitmentTransaction::dummy(&mut Vec::new()),
4293 best_block, dummy_key);
4295 let mut htlcs = preimages_slice_to_htlcs!(preimages[0..10]);
4296 let dummy_commitment_tx = HolderCommitmentTransaction::dummy(&mut htlcs);
4297 monitor.provide_latest_holder_commitment_tx(dummy_commitment_tx.clone(),
4298 htlcs.into_iter().map(|(htlc, _)| (htlc, Some(dummy_sig), None)).collect()).unwrap();
4299 monitor.provide_latest_counterparty_commitment_tx(Txid::from_inner(Sha256::hash(b"1").into_inner()),
4300 preimages_slice_to_htlc_outputs!(preimages[5..15]), 281474976710655, dummy_key, &logger);
4301 monitor.provide_latest_counterparty_commitment_tx(Txid::from_inner(Sha256::hash(b"2").into_inner()),
4302 preimages_slice_to_htlc_outputs!(preimages[15..20]), 281474976710654, dummy_key, &logger);
4303 for &(ref preimage, ref hash) in preimages.iter() {
4304 let bounded_fee_estimator = LowerBoundedFeeEstimator::new(&fee_estimator);
4305 monitor.provide_payment_preimage(hash, preimage, &broadcaster, &bounded_fee_estimator, &logger);
4308 // Now provide a secret, pruning preimages 10-15
4309 let mut secret = [0; 32];
4310 secret[0..32].clone_from_slice(&hex::decode("7cc854b54e3e0dcdb010d7a3fee464a9687be6e8db3be6854c475621e007a5dc").unwrap());
4311 monitor.provide_secret(281474976710655, secret.clone()).unwrap();
4312 assert_eq!(monitor.inner.lock().unwrap().payment_preimages.len(), 15);
4313 test_preimages_exist!(&preimages[0..10], monitor);
4314 test_preimages_exist!(&preimages[15..20], monitor);
4316 monitor.provide_latest_counterparty_commitment_tx(Txid::from_inner(Sha256::hash(b"3").into_inner()),
4317 preimages_slice_to_htlc_outputs!(preimages[17..20]), 281474976710653, dummy_key, &logger);
4319 // Now provide a further secret, pruning preimages 15-17
4320 secret[0..32].clone_from_slice(&hex::decode("c7518c8ae4660ed02894df8976fa1a3659c1a8b4b5bec0c4b872abeba4cb8964").unwrap());
4321 monitor.provide_secret(281474976710654, secret.clone()).unwrap();
4322 assert_eq!(monitor.inner.lock().unwrap().payment_preimages.len(), 13);
4323 test_preimages_exist!(&preimages[0..10], monitor);
4324 test_preimages_exist!(&preimages[17..20], monitor);
4326 monitor.provide_latest_counterparty_commitment_tx(Txid::from_inner(Sha256::hash(b"4").into_inner()),
4327 preimages_slice_to_htlc_outputs!(preimages[18..20]), 281474976710652, dummy_key, &logger);
4329 // Now update holder commitment tx info, pruning only element 18 as we still care about the
4330 // previous commitment tx's preimages too
4331 let mut htlcs = preimages_slice_to_htlcs!(preimages[0..5]);
4332 let dummy_commitment_tx = HolderCommitmentTransaction::dummy(&mut htlcs);
4333 monitor.provide_latest_holder_commitment_tx(dummy_commitment_tx.clone(),
4334 htlcs.into_iter().map(|(htlc, _)| (htlc, Some(dummy_sig), None)).collect()).unwrap();
4335 secret[0..32].clone_from_slice(&hex::decode("2273e227a5b7449b6e70f1fb4652864038b1cbf9cd7c043a7d6456b7fc275ad8").unwrap());
4336 monitor.provide_secret(281474976710653, secret.clone()).unwrap();
4337 assert_eq!(monitor.inner.lock().unwrap().payment_preimages.len(), 12);
4338 test_preimages_exist!(&preimages[0..10], monitor);
4339 test_preimages_exist!(&preimages[18..20], monitor);
4341 // But if we do it again, we'll prune 5-10
4342 let mut htlcs = preimages_slice_to_htlcs!(preimages[0..3]);
4343 let dummy_commitment_tx = HolderCommitmentTransaction::dummy(&mut htlcs);
4344 monitor.provide_latest_holder_commitment_tx(dummy_commitment_tx,
4345 htlcs.into_iter().map(|(htlc, _)| (htlc, Some(dummy_sig), None)).collect()).unwrap();
4346 secret[0..32].clone_from_slice(&hex::decode("27cddaa5624534cb6cb9d7da077cf2b22ab21e9b506fd4998a51d54502e99116").unwrap());
4347 monitor.provide_secret(281474976710652, secret.clone()).unwrap();
4348 assert_eq!(monitor.inner.lock().unwrap().payment_preimages.len(), 5);
4349 test_preimages_exist!(&preimages[0..5], monitor);
4353 fn test_claim_txn_weight_computation() {
4354 // We test Claim txn weight, knowing that we want expected weigth and
4355 // not actual case to avoid sigs and time-lock delays hell variances.
4357 let secp_ctx = Secp256k1::new();
4358 let privkey = SecretKey::from_slice(&hex::decode("0101010101010101010101010101010101010101010101010101010101010101").unwrap()[..]).unwrap();
4359 let pubkey = PublicKey::from_secret_key(&secp_ctx, &privkey);
4361 macro_rules! sign_input {
4362 ($sighash_parts: expr, $idx: expr, $amount: expr, $weight: expr, $sum_actual_sigs: expr, $opt_anchors: expr) => {
4363 let htlc = HTLCOutputInCommitment {
4364 offered: if *$weight == weight_revoked_offered_htlc($opt_anchors) || *$weight == weight_offered_htlc($opt_anchors) { true } else { false },
4366 cltv_expiry: 2 << 16,
4367 payment_hash: PaymentHash([1; 32]),
4368 transaction_output_index: Some($idx as u32),
4370 let redeem_script = if *$weight == WEIGHT_REVOKED_OUTPUT { chan_utils::get_revokeable_redeemscript(&pubkey, 256, &pubkey) } else { chan_utils::get_htlc_redeemscript_with_explicit_keys(&htlc, $opt_anchors, &pubkey, &pubkey, &pubkey) };
4371 let sighash = hash_to_message!(&$sighash_parts.segwit_signature_hash($idx, &redeem_script, $amount, EcdsaSighashType::All).unwrap()[..]);
4372 let sig = secp_ctx.sign_ecdsa(&sighash, &privkey);
4373 let mut ser_sig = sig.serialize_der().to_vec();
4374 ser_sig.push(EcdsaSighashType::All as u8);
4375 $sum_actual_sigs += ser_sig.len();
4376 let witness = $sighash_parts.witness_mut($idx).unwrap();
4377 witness.push(ser_sig);
4378 if *$weight == WEIGHT_REVOKED_OUTPUT {
4379 witness.push(vec!(1));
4380 } else if *$weight == weight_revoked_offered_htlc($opt_anchors) || *$weight == weight_revoked_received_htlc($opt_anchors) {
4381 witness.push(pubkey.clone().serialize().to_vec());
4382 } else if *$weight == weight_received_htlc($opt_anchors) {
4383 witness.push(vec![0]);
4385 witness.push(PaymentPreimage([1; 32]).0.to_vec());
4387 witness.push(redeem_script.into_bytes());
4388 let witness = witness.to_vec();
4389 println!("witness[0] {}", witness[0].len());
4390 println!("witness[1] {}", witness[1].len());
4391 println!("witness[2] {}", witness[2].len());
4395 let script_pubkey = Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script();
4396 let txid = Txid::from_hex("56944c5d3f98413ef45cf54545538103cc9f298e0575820ad3591376e2e0f65d").unwrap();
4398 // Justice tx with 1 to_holder, 2 revoked offered HTLCs, 1 revoked received HTLCs
4399 for &opt_anchors in [false, true].iter() {
4400 let mut claim_tx = Transaction { version: 0, lock_time: PackedLockTime::ZERO, input: Vec::new(), output: Vec::new() };
4401 let mut sum_actual_sigs = 0;
4403 claim_tx.input.push(TxIn {
4404 previous_output: BitcoinOutPoint {
4408 script_sig: Script::new(),
4409 sequence: Sequence::ENABLE_RBF_NO_LOCKTIME,
4410 witness: Witness::new(),
4413 claim_tx.output.push(TxOut {
4414 script_pubkey: script_pubkey.clone(),
4417 let base_weight = claim_tx.weight();
4418 let inputs_weight = vec![WEIGHT_REVOKED_OUTPUT, weight_revoked_offered_htlc(opt_anchors), weight_revoked_offered_htlc(opt_anchors), weight_revoked_received_htlc(opt_anchors)];
4419 let mut inputs_total_weight = 2; // count segwit flags
4421 let mut sighash_parts = sighash::SighashCache::new(&mut claim_tx);
4422 for (idx, inp) in inputs_weight.iter().enumerate() {
4423 sign_input!(sighash_parts, idx, 0, inp, sum_actual_sigs, opt_anchors);
4424 inputs_total_weight += inp;
4427 assert_eq!(base_weight + inputs_total_weight as usize, claim_tx.weight() + /* max_length_sig */ (73 * inputs_weight.len() - sum_actual_sigs));
4430 // Claim tx with 1 offered HTLCs, 3 received HTLCs
4431 for &opt_anchors in [false, true].iter() {
4432 let mut claim_tx = Transaction { version: 0, lock_time: PackedLockTime::ZERO, input: Vec::new(), output: Vec::new() };
4433 let mut sum_actual_sigs = 0;
4435 claim_tx.input.push(TxIn {
4436 previous_output: BitcoinOutPoint {
4440 script_sig: Script::new(),
4441 sequence: Sequence::ENABLE_RBF_NO_LOCKTIME,
4442 witness: Witness::new(),
4445 claim_tx.output.push(TxOut {
4446 script_pubkey: script_pubkey.clone(),
4449 let base_weight = claim_tx.weight();
4450 let inputs_weight = vec![weight_offered_htlc(opt_anchors), weight_received_htlc(opt_anchors), weight_received_htlc(opt_anchors), weight_received_htlc(opt_anchors)];
4451 let mut inputs_total_weight = 2; // count segwit flags
4453 let mut sighash_parts = sighash::SighashCache::new(&mut claim_tx);
4454 for (idx, inp) in inputs_weight.iter().enumerate() {
4455 sign_input!(sighash_parts, idx, 0, inp, sum_actual_sigs, opt_anchors);
4456 inputs_total_weight += inp;
4459 assert_eq!(base_weight + inputs_total_weight as usize, claim_tx.weight() + /* max_length_sig */ (73 * inputs_weight.len() - sum_actual_sigs));
4462 // Justice tx with 1 revoked HTLC-Success tx output
4463 for &opt_anchors in [false, true].iter() {
4464 let mut claim_tx = Transaction { version: 0, lock_time: PackedLockTime::ZERO, input: Vec::new(), output: Vec::new() };
4465 let mut sum_actual_sigs = 0;
4466 claim_tx.input.push(TxIn {
4467 previous_output: BitcoinOutPoint {
4471 script_sig: Script::new(),
4472 sequence: Sequence::ENABLE_RBF_NO_LOCKTIME,
4473 witness: Witness::new(),
4475 claim_tx.output.push(TxOut {
4476 script_pubkey: script_pubkey.clone(),
4479 let base_weight = claim_tx.weight();
4480 let inputs_weight = vec![WEIGHT_REVOKED_OUTPUT];
4481 let mut inputs_total_weight = 2; // count segwit flags
4483 let mut sighash_parts = sighash::SighashCache::new(&mut claim_tx);
4484 for (idx, inp) in inputs_weight.iter().enumerate() {
4485 sign_input!(sighash_parts, idx, 0, inp, sum_actual_sigs, opt_anchors);
4486 inputs_total_weight += inp;
4489 assert_eq!(base_weight + inputs_total_weight as usize, claim_tx.weight() + /* max_length_isg */ (73 * inputs_weight.len() - sum_actual_sigs));
4493 // Further testing is done in the ChannelManager integration tests.