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::sign::{SpendableOutputDescriptor, StaticPaymentOutputDescriptor, DelayedPaymentOutputDescriptor, WriteableEcdsaChannelSigner, SignerProvider, EntropySource};
46 use crate::chain::onchaintx::{ClaimEvent, OnchainTxHandler};
47 use crate::chain::package::{CounterpartyOfferedHTLCOutput, CounterpartyReceivedHTLCOutput, HolderFundingOutput, HolderHTLCOutput, PackageSolvingData, PackageTemplate, RevokedOutput, RevokedHTLCOutput};
48 use crate::chain::Filter;
49 use crate::util::logger::Logger;
50 use crate::util::ser::{Readable, ReadableArgs, RequiredWrapper, MaybeReadable, UpgradableRequired, Writer, Writeable, U48};
51 use crate::util::byte_utils;
52 use crate::events::{Event, EventHandler};
53 use crate::events::bump_transaction::{ChannelDerivationParameters, AnchorDescriptor, HTLCDescriptor, BumpTransactionEvent};
55 use crate::prelude::*;
57 use crate::io::{self, Error};
58 use core::convert::TryInto;
60 use crate::sync::{Mutex, LockTestExt};
62 /// An update generated by the underlying channel itself which contains some new information the
63 /// [`ChannelMonitor`] should be made aware of.
65 /// Because this represents only a small number of updates to the underlying state, it is generally
66 /// much smaller than a full [`ChannelMonitor`]. However, for large single commitment transaction
67 /// updates (e.g. ones during which there are hundreds of HTLCs pending on the commitment
68 /// transaction), a single update may reach upwards of 1 MiB in serialized size.
69 #[derive(Clone, PartialEq, Eq)]
71 pub struct ChannelMonitorUpdate {
72 pub(crate) updates: Vec<ChannelMonitorUpdateStep>,
73 /// The sequence number of this update. Updates *must* be replayed in-order according to this
74 /// sequence number (and updates may panic if they are not). The update_id values are strictly
75 /// increasing and increase by one for each new update, with two exceptions specified below.
77 /// This sequence number is also used to track up to which points updates which returned
78 /// [`ChannelMonitorUpdateStatus::InProgress`] have been applied to all copies of a given
79 /// ChannelMonitor when ChannelManager::channel_monitor_updated is called.
81 /// The only instances we allow where update_id values are not strictly increasing have a
82 /// special update ID of [`CLOSED_CHANNEL_UPDATE_ID`]. This update ID is used for updates that
83 /// will force close the channel by broadcasting the latest commitment transaction or
84 /// special post-force-close updates, like providing preimages necessary to claim outputs on the
85 /// broadcast commitment transaction. See its docs for more details.
87 /// [`ChannelMonitorUpdateStatus::InProgress`]: super::ChannelMonitorUpdateStatus::InProgress
91 /// The update ID used for a [`ChannelMonitorUpdate`] that is either:
93 /// (1) attempting to force close the channel by broadcasting our latest commitment transaction or
94 /// (2) providing a preimage (after the channel has been force closed) from a forward link that
95 /// allows us to spend an HTLC output on this channel's (the backward link's) broadcasted
96 /// commitment transaction.
98 /// No other [`ChannelMonitorUpdate`]s are allowed after force-close.
99 pub const CLOSED_CHANNEL_UPDATE_ID: u64 = core::u64::MAX;
101 impl Writeable for ChannelMonitorUpdate {
102 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
103 write_ver_prefix!(w, SERIALIZATION_VERSION, MIN_SERIALIZATION_VERSION);
104 self.update_id.write(w)?;
105 (self.updates.len() as u64).write(w)?;
106 for update_step in self.updates.iter() {
107 update_step.write(w)?;
109 write_tlv_fields!(w, {});
113 impl Readable for ChannelMonitorUpdate {
114 fn read<R: io::Read>(r: &mut R) -> Result<Self, DecodeError> {
115 let _ver = read_ver_prefix!(r, SERIALIZATION_VERSION);
116 let update_id: u64 = Readable::read(r)?;
117 let len: u64 = Readable::read(r)?;
118 let mut updates = Vec::with_capacity(cmp::min(len as usize, MAX_ALLOC_SIZE / ::core::mem::size_of::<ChannelMonitorUpdateStep>()));
120 if let Some(upd) = MaybeReadable::read(r)? {
124 read_tlv_fields!(r, {});
125 Ok(Self { update_id, updates })
129 /// An event to be processed by the ChannelManager.
130 #[derive(Clone, PartialEq, Eq)]
131 pub enum MonitorEvent {
132 /// A monitor event containing an HTLCUpdate.
133 HTLCEvent(HTLCUpdate),
135 /// A monitor event that the Channel's commitment transaction was confirmed.
136 CommitmentTxConfirmed(OutPoint),
138 /// Indicates a [`ChannelMonitor`] update has completed. See
139 /// [`ChannelMonitorUpdateStatus::InProgress`] for more information on how this is used.
141 /// [`ChannelMonitorUpdateStatus::InProgress`]: super::ChannelMonitorUpdateStatus::InProgress
143 /// The funding outpoint of the [`ChannelMonitor`] that was updated
144 funding_txo: OutPoint,
145 /// The Update ID from [`ChannelMonitorUpdate::update_id`] which was applied or
146 /// [`ChannelMonitor::get_latest_update_id`].
148 /// Note that this should only be set to a given update's ID if all previous updates for the
149 /// same [`ChannelMonitor`] have been applied and persisted.
150 monitor_update_id: u64,
153 /// Indicates a [`ChannelMonitor`] update has failed. See
154 /// [`ChannelMonitorUpdateStatus::PermanentFailure`] for more information on how this is used.
156 /// [`ChannelMonitorUpdateStatus::PermanentFailure`]: super::ChannelMonitorUpdateStatus::PermanentFailure
157 UpdateFailed(OutPoint),
159 impl_writeable_tlv_based_enum_upgradable!(MonitorEvent,
160 // Note that Completed and UpdateFailed are currently never serialized to disk as they are
161 // generated only in ChainMonitor
163 (0, funding_txo, required),
164 (2, monitor_update_id, required),
168 (4, CommitmentTxConfirmed),
172 /// Simple structure sent back by `chain::Watch` when an HTLC from a forward channel is detected on
173 /// chain. Used to update the corresponding HTLC in the backward channel. Failing to pass the
174 /// preimage claim backward will lead to loss of funds.
175 #[derive(Clone, PartialEq, Eq)]
176 pub struct HTLCUpdate {
177 pub(crate) payment_hash: PaymentHash,
178 pub(crate) payment_preimage: Option<PaymentPreimage>,
179 pub(crate) source: HTLCSource,
180 pub(crate) htlc_value_satoshis: Option<u64>,
182 impl_writeable_tlv_based!(HTLCUpdate, {
183 (0, payment_hash, required),
184 (1, htlc_value_satoshis, option),
185 (2, source, required),
186 (4, payment_preimage, option),
189 /// If an HTLC expires within this many blocks, don't try to claim it in a shared transaction,
190 /// instead claiming it in its own individual transaction.
191 pub(crate) const CLTV_SHARED_CLAIM_BUFFER: u32 = 12;
192 /// If an HTLC expires within this many blocks, force-close the channel to broadcast the
193 /// HTLC-Success transaction.
194 /// In other words, this is an upper bound on how many blocks we think it can take us to get a
195 /// transaction confirmed (and we use it in a few more, equivalent, places).
196 pub(crate) const CLTV_CLAIM_BUFFER: u32 = 18;
197 /// Number of blocks by which point we expect our counterparty to have seen new blocks on the
198 /// network and done a full update_fail_htlc/commitment_signed dance (+ we've updated all our
199 /// copies of ChannelMonitors, including watchtowers). We could enforce the contract by failing
200 /// at CLTV expiration height but giving a grace period to our peer may be profitable for us if he
201 /// can provide an over-late preimage. Nevertheless, grace period has to be accounted in our
202 /// CLTV_EXPIRY_DELTA to be secure. Following this policy we may decrease the rate of channel failures
203 /// due to expiration but increase the cost of funds being locked longuer in case of failure.
204 /// This delay also cover a low-power peer being slow to process blocks and so being behind us on
205 /// accurate block height.
206 /// In case of onchain failure to be pass backward we may see the last block of ANTI_REORG_DELAY
207 /// with at worst this delay, so we are not only using this value as a mercy for them but also
208 /// us as a safeguard to delay with enough time.
209 pub(crate) const LATENCY_GRACE_PERIOD_BLOCKS: u32 = 3;
210 /// Number of blocks we wait on seeing a HTLC output being solved before we fail corresponding
211 /// inbound HTLCs. This prevents us from failing backwards and then getting a reorg resulting in us
214 /// Note that this is a library-wide security assumption. If a reorg deeper than this number of
215 /// blocks occurs, counterparties may be able to steal funds or claims made by and balances exposed
216 /// by a [`ChannelMonitor`] may be incorrect.
217 // We also use this delay to be sure we can remove our in-flight claim txn from bump candidates buffer.
218 // It may cause spurious generation of bumped claim txn but that's alright given the outpoint is already
219 // solved by a previous claim tx. What we want to avoid is reorg evicting our claim tx and us not
220 // keep bumping another claim tx to solve the outpoint.
221 pub const ANTI_REORG_DELAY: u32 = 6;
222 /// Number of blocks before confirmation at which we fail back an un-relayed HTLC or at which we
223 /// refuse to accept a new HTLC.
225 /// This is used for a few separate purposes:
226 /// 1) if we've received an MPP HTLC to us and it expires within this many blocks and we are
227 /// waiting on additional parts (or waiting on the preimage for any HTLC from the user), we will
229 /// 2) if we receive an HTLC within this many blocks of its expiry (plus one to avoid a race
230 /// condition with the above), we will fail this HTLC without telling the user we received it,
232 /// (1) is all about protecting us - we need enough time to update the channel state before we hit
233 /// CLTV_CLAIM_BUFFER, at which point we'd go on chain to claim the HTLC with the preimage.
235 /// (2) is the same, but with an additional buffer to avoid accepting an HTLC which is immediately
236 /// in a race condition between the user connecting a block (which would fail it) and the user
237 /// providing us the preimage (which would claim it).
238 pub(crate) const HTLC_FAIL_BACK_BUFFER: u32 = CLTV_CLAIM_BUFFER + LATENCY_GRACE_PERIOD_BLOCKS;
240 // TODO(devrandom) replace this with HolderCommitmentTransaction
241 #[derive(Clone, PartialEq, Eq)]
242 struct HolderSignedTx {
243 /// txid of the transaction in tx, just used to make comparison faster
245 revocation_key: PublicKey,
246 a_htlc_key: PublicKey,
247 b_htlc_key: PublicKey,
248 delayed_payment_key: PublicKey,
249 per_commitment_point: PublicKey,
250 htlc_outputs: Vec<(HTLCOutputInCommitment, Option<Signature>, Option<HTLCSource>)>,
251 to_self_value_sat: u64,
254 impl_writeable_tlv_based!(HolderSignedTx, {
256 // Note that this is filled in with data from OnchainTxHandler if it's missing.
257 // For HolderSignedTx objects serialized with 0.0.100+, this should be filled in.
258 (1, to_self_value_sat, (default_value, u64::max_value())),
259 (2, revocation_key, required),
260 (4, a_htlc_key, required),
261 (6, b_htlc_key, required),
262 (8, delayed_payment_key, required),
263 (10, per_commitment_point, required),
264 (12, feerate_per_kw, required),
265 (14, htlc_outputs, required_vec)
268 impl HolderSignedTx {
269 fn non_dust_htlcs(&self) -> Vec<HTLCOutputInCommitment> {
270 self.htlc_outputs.iter().filter_map(|(htlc, _, _)| {
271 if let Some(_) = htlc.transaction_output_index {
281 /// We use this to track static counterparty commitment transaction data and to generate any
282 /// justice or 2nd-stage preimage/timeout transactions.
283 #[derive(Clone, PartialEq, Eq)]
284 struct CounterpartyCommitmentParameters {
285 counterparty_delayed_payment_base_key: PublicKey,
286 counterparty_htlc_base_key: PublicKey,
287 on_counterparty_tx_csv: u16,
290 impl Writeable for CounterpartyCommitmentParameters {
291 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
292 w.write_all(&(0 as u64).to_be_bytes())?;
293 write_tlv_fields!(w, {
294 (0, self.counterparty_delayed_payment_base_key, required),
295 (2, self.counterparty_htlc_base_key, required),
296 (4, self.on_counterparty_tx_csv, required),
301 impl Readable for CounterpartyCommitmentParameters {
302 fn read<R: io::Read>(r: &mut R) -> Result<Self, DecodeError> {
303 let counterparty_commitment_transaction = {
304 // Versions prior to 0.0.100 had some per-HTLC state stored here, which is no longer
305 // used. Read it for compatibility.
306 let per_htlc_len: u64 = Readable::read(r)?;
307 for _ in 0..per_htlc_len {
308 let _txid: Txid = Readable::read(r)?;
309 let htlcs_count: u64 = Readable::read(r)?;
310 for _ in 0..htlcs_count {
311 let _htlc: HTLCOutputInCommitment = Readable::read(r)?;
315 let mut counterparty_delayed_payment_base_key = RequiredWrapper(None);
316 let mut counterparty_htlc_base_key = RequiredWrapper(None);
317 let mut on_counterparty_tx_csv: u16 = 0;
318 read_tlv_fields!(r, {
319 (0, counterparty_delayed_payment_base_key, required),
320 (2, counterparty_htlc_base_key, required),
321 (4, on_counterparty_tx_csv, required),
323 CounterpartyCommitmentParameters {
324 counterparty_delayed_payment_base_key: counterparty_delayed_payment_base_key.0.unwrap(),
325 counterparty_htlc_base_key: counterparty_htlc_base_key.0.unwrap(),
326 on_counterparty_tx_csv,
329 Ok(counterparty_commitment_transaction)
333 /// An entry for an [`OnchainEvent`], stating the block height and hash when the event was
334 /// observed, as well as the transaction causing it.
336 /// Used to determine when the on-chain event can be considered safe from a chain reorganization.
337 #[derive(Clone, PartialEq, Eq)]
338 struct OnchainEventEntry {
341 block_hash: Option<BlockHash>, // Added as optional, will be filled in for any entry generated on 0.0.113 or after
343 transaction: Option<Transaction>, // Added as optional, but always filled in, in LDK 0.0.110
346 impl OnchainEventEntry {
347 fn confirmation_threshold(&self) -> u32 {
348 let mut conf_threshold = self.height + ANTI_REORG_DELAY - 1;
350 OnchainEvent::MaturingOutput {
351 descriptor: SpendableOutputDescriptor::DelayedPaymentOutput(ref descriptor)
353 // A CSV'd transaction is confirmable in block (input height) + CSV delay, which means
354 // it's broadcastable when we see the previous block.
355 conf_threshold = cmp::max(conf_threshold, self.height + descriptor.to_self_delay as u32 - 1);
357 OnchainEvent::FundingSpendConfirmation { on_local_output_csv: Some(csv), .. } |
358 OnchainEvent::HTLCSpendConfirmation { on_to_local_output_csv: Some(csv), .. } => {
359 // A CSV'd transaction is confirmable in block (input height) + CSV delay, which means
360 // it's broadcastable when we see the previous block.
361 conf_threshold = cmp::max(conf_threshold, self.height + csv as u32 - 1);
368 fn has_reached_confirmation_threshold(&self, best_block: &BestBlock) -> bool {
369 best_block.height() >= self.confirmation_threshold()
373 /// The (output index, sats value) for the counterparty's output in a commitment transaction.
375 /// This was added as an `Option` in 0.0.110.
376 type CommitmentTxCounterpartyOutputInfo = Option<(u32, u64)>;
378 /// Upon discovering of some classes of onchain tx by ChannelMonitor, we may have to take actions on it
379 /// once they mature to enough confirmations (ANTI_REORG_DELAY)
380 #[derive(Clone, PartialEq, Eq)]
382 /// An outbound HTLC failing after a transaction is confirmed. Used
383 /// * when an outbound HTLC output is spent by us after the HTLC timed out
384 /// * an outbound HTLC which was not present in the commitment transaction which appeared
385 /// on-chain (either because it was not fully committed to or it was dust).
386 /// Note that this is *not* used for preimage claims, as those are passed upstream immediately,
387 /// appearing only as an `HTLCSpendConfirmation`, below.
390 payment_hash: PaymentHash,
391 htlc_value_satoshis: Option<u64>,
392 /// None in the second case, above, ie when there is no relevant output in the commitment
393 /// transaction which appeared on chain.
394 commitment_tx_output_idx: Option<u32>,
396 /// An output waiting on [`ANTI_REORG_DELAY`] confirmations before we hand the user the
397 /// [`SpendableOutputDescriptor`].
399 descriptor: SpendableOutputDescriptor,
401 /// A spend of the funding output, either a commitment transaction or a cooperative closing
403 FundingSpendConfirmation {
404 /// The CSV delay for the output of the funding spend transaction (implying it is a local
405 /// commitment transaction, and this is the delay on the to_self output).
406 on_local_output_csv: Option<u16>,
407 /// If the funding spend transaction was a known remote commitment transaction, we track
408 /// the output index and amount of the counterparty's `to_self` output here.
410 /// This allows us to generate a [`Balance::CounterpartyRevokedOutputClaimable`] for the
411 /// counterparty output.
412 commitment_tx_to_counterparty_output: CommitmentTxCounterpartyOutputInfo,
414 /// A spend of a commitment transaction HTLC output, set in the cases where *no* `HTLCUpdate`
415 /// is constructed. This is used when
416 /// * an outbound HTLC is claimed by our counterparty with a preimage, causing us to
417 /// immediately claim the HTLC on the inbound edge and track the resolution here,
418 /// * an inbound HTLC is claimed by our counterparty (with a timeout),
419 /// * an inbound HTLC is claimed by us (with a preimage).
420 /// * a revoked-state HTLC transaction was broadcasted, which was claimed by the revocation
422 /// * a revoked-state HTLC transaction was broadcasted, which was claimed by an
423 /// HTLC-Success/HTLC-Failure transaction (and is still claimable with a revocation
425 HTLCSpendConfirmation {
426 commitment_tx_output_idx: u32,
427 /// If the claim was made by either party with a preimage, this is filled in
428 preimage: Option<PaymentPreimage>,
429 /// If the claim was made by us on an inbound HTLC against a local commitment transaction,
430 /// we set this to the output CSV value which we will have to wait until to spend the
431 /// output (and generate a SpendableOutput event).
432 on_to_local_output_csv: Option<u16>,
436 impl Writeable for OnchainEventEntry {
437 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
438 write_tlv_fields!(writer, {
439 (0, self.txid, required),
440 (1, self.transaction, option),
441 (2, self.height, required),
442 (3, self.block_hash, option),
443 (4, self.event, required),
449 impl MaybeReadable for OnchainEventEntry {
450 fn read<R: io::Read>(reader: &mut R) -> Result<Option<Self>, DecodeError> {
451 let mut txid = Txid::all_zeros();
452 let mut transaction = None;
453 let mut block_hash = None;
455 let mut event = UpgradableRequired(None);
456 read_tlv_fields!(reader, {
458 (1, transaction, option),
459 (2, height, required),
460 (3, block_hash, option),
461 (4, event, upgradable_required),
463 Ok(Some(Self { txid, transaction, height, block_hash, event: _init_tlv_based_struct_field!(event, upgradable_required) }))
467 impl_writeable_tlv_based_enum_upgradable!(OnchainEvent,
469 (0, source, required),
470 (1, htlc_value_satoshis, option),
471 (2, payment_hash, required),
472 (3, commitment_tx_output_idx, option),
474 (1, MaturingOutput) => {
475 (0, descriptor, required),
477 (3, FundingSpendConfirmation) => {
478 (0, on_local_output_csv, option),
479 (1, commitment_tx_to_counterparty_output, option),
481 (5, HTLCSpendConfirmation) => {
482 (0, commitment_tx_output_idx, required),
483 (2, preimage, option),
484 (4, on_to_local_output_csv, option),
489 #[derive(Clone, PartialEq, Eq)]
490 pub(crate) enum ChannelMonitorUpdateStep {
491 LatestHolderCommitmentTXInfo {
492 commitment_tx: HolderCommitmentTransaction,
493 /// Note that LDK after 0.0.115 supports this only containing dust HTLCs (implying the
494 /// `Signature` field is never filled in). At that point, non-dust HTLCs are implied by the
495 /// HTLC fields in `commitment_tx` and the sources passed via `nondust_htlc_sources`.
496 htlc_outputs: Vec<(HTLCOutputInCommitment, Option<Signature>, Option<HTLCSource>)>,
497 claimed_htlcs: Vec<(SentHTLCId, PaymentPreimage)>,
498 nondust_htlc_sources: Vec<HTLCSource>,
500 LatestCounterpartyCommitmentTXInfo {
501 commitment_txid: Txid,
502 htlc_outputs: Vec<(HTLCOutputInCommitment, Option<Box<HTLCSource>>)>,
503 commitment_number: u64,
504 their_per_commitment_point: PublicKey,
507 payment_preimage: PaymentPreimage,
513 /// Used to indicate that the no future updates will occur, and likely that the latest holder
514 /// commitment transaction(s) should be broadcast, as the channel has been force-closed.
516 /// If set to false, we shouldn't broadcast the latest holder commitment transaction as we
517 /// think we've fallen behind!
518 should_broadcast: bool,
521 scriptpubkey: Script,
525 impl ChannelMonitorUpdateStep {
526 fn variant_name(&self) -> &'static str {
528 ChannelMonitorUpdateStep::LatestHolderCommitmentTXInfo { .. } => "LatestHolderCommitmentTXInfo",
529 ChannelMonitorUpdateStep::LatestCounterpartyCommitmentTXInfo { .. } => "LatestCounterpartyCommitmentTXInfo",
530 ChannelMonitorUpdateStep::PaymentPreimage { .. } => "PaymentPreimage",
531 ChannelMonitorUpdateStep::CommitmentSecret { .. } => "CommitmentSecret",
532 ChannelMonitorUpdateStep::ChannelForceClosed { .. } => "ChannelForceClosed",
533 ChannelMonitorUpdateStep::ShutdownScript { .. } => "ShutdownScript",
538 impl_writeable_tlv_based_enum_upgradable!(ChannelMonitorUpdateStep,
539 (0, LatestHolderCommitmentTXInfo) => {
540 (0, commitment_tx, required),
541 (1, claimed_htlcs, optional_vec),
542 (2, htlc_outputs, required_vec),
543 (4, nondust_htlc_sources, optional_vec),
545 (1, LatestCounterpartyCommitmentTXInfo) => {
546 (0, commitment_txid, required),
547 (2, commitment_number, required),
548 (4, their_per_commitment_point, required),
549 (6, htlc_outputs, required_vec),
551 (2, PaymentPreimage) => {
552 (0, payment_preimage, required),
554 (3, CommitmentSecret) => {
556 (2, secret, required),
558 (4, ChannelForceClosed) => {
559 (0, should_broadcast, required),
561 (5, ShutdownScript) => {
562 (0, scriptpubkey, required),
566 /// Details about the balance(s) available for spending once the channel appears on chain.
568 /// See [`ChannelMonitor::get_claimable_balances`] for more details on when these will or will not
570 #[derive(Clone, Debug, PartialEq, Eq)]
571 #[cfg_attr(test, derive(PartialOrd, Ord))]
573 /// The channel is not yet closed (or the commitment or closing transaction has not yet
574 /// appeared in a block). The given balance is claimable (less on-chain fees) if the channel is
575 /// force-closed now.
576 ClaimableOnChannelClose {
577 /// The amount available to claim, in satoshis, excluding the on-chain fees which will be
578 /// required to do so.
579 claimable_amount_satoshis: u64,
581 /// The channel has been closed, and the given balance is ours but awaiting confirmations until
582 /// we consider it spendable.
583 ClaimableAwaitingConfirmations {
584 /// The amount available to claim, in satoshis, possibly excluding the on-chain fees which
585 /// were spent in broadcasting the transaction.
586 claimable_amount_satoshis: u64,
587 /// The height at which an [`Event::SpendableOutputs`] event will be generated for this
589 confirmation_height: u32,
591 /// The channel has been closed, and the given balance should be ours but awaiting spending
592 /// transaction confirmation. If the spending transaction does not confirm in time, it is
593 /// possible our counterparty can take the funds by broadcasting an HTLC timeout on-chain.
595 /// Once the spending transaction confirms, before it has reached enough confirmations to be
596 /// considered safe from chain reorganizations, the balance will instead be provided via
597 /// [`Balance::ClaimableAwaitingConfirmations`].
598 ContentiousClaimable {
599 /// The amount available to claim, in satoshis, excluding the on-chain fees which will be
600 /// required to do so.
601 claimable_amount_satoshis: u64,
602 /// The height at which the counterparty may be able to claim the balance if we have not
605 /// The payment hash that locks this HTLC.
606 payment_hash: PaymentHash,
607 /// The preimage that can be used to claim this HTLC.
608 payment_preimage: PaymentPreimage,
610 /// HTLCs which we sent to our counterparty which are claimable after a timeout (less on-chain
611 /// fees) if the counterparty does not know the preimage for the HTLCs. These are somewhat
612 /// likely to be claimed by our counterparty before we do.
613 MaybeTimeoutClaimableHTLC {
614 /// The amount potentially available to claim, in satoshis, excluding the on-chain fees
615 /// which will be required to do so.
616 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,
620 /// The payment hash whose preimage our counterparty needs to claim this HTLC.
621 payment_hash: PaymentHash,
623 /// HTLCs which we received from our counterparty which are claimable with a preimage which we
624 /// do not currently have. This will only be claimable if we receive the preimage from the node
625 /// to which we forwarded this HTLC before the timeout.
626 MaybePreimageClaimableHTLC {
627 /// The amount potentially available to claim, in satoshis, excluding the on-chain fees
628 /// which will be required to do so.
629 claimable_amount_satoshis: u64,
630 /// The height at which our counterparty will be able to claim the balance if we have not
631 /// yet received the preimage and claimed it ourselves.
633 /// The payment hash whose preimage we need to claim this HTLC.
634 payment_hash: PaymentHash,
636 /// The channel has been closed, and our counterparty broadcasted a revoked commitment
639 /// Thus, we're able to claim all outputs in the commitment transaction, one of which has the
640 /// following amount.
641 CounterpartyRevokedOutputClaimable {
642 /// The amount, in satoshis, of the output which we can claim.
644 /// Note that for outputs from HTLC balances this may be excluding some on-chain fees that
645 /// were already spent.
646 claimable_amount_satoshis: u64,
651 /// The amount claimable, in satoshis. This excludes balances that we are unsure if we are able
652 /// to claim, this is because we are waiting for a preimage or for a timeout to expire. For more
653 /// information on these balances see [`Balance::MaybeTimeoutClaimableHTLC`] and
654 /// [`Balance::MaybePreimageClaimableHTLC`].
656 /// On-chain fees required to claim the balance are not included in this amount.
657 pub fn claimable_amount_satoshis(&self) -> u64 {
659 Balance::ClaimableOnChannelClose {
660 claimable_amount_satoshis,
661 } => *claimable_amount_satoshis,
662 Balance::ClaimableAwaitingConfirmations {
663 claimable_amount_satoshis,
665 } => *claimable_amount_satoshis,
666 Balance::ContentiousClaimable {
667 claimable_amount_satoshis,
669 } => *claimable_amount_satoshis,
670 Balance::MaybeTimeoutClaimableHTLC {
673 Balance::MaybePreimageClaimableHTLC {
676 Balance::CounterpartyRevokedOutputClaimable {
677 claimable_amount_satoshis,
679 } => *claimable_amount_satoshis,
684 /// An HTLC which has been irrevocably resolved on-chain, and has reached ANTI_REORG_DELAY.
685 #[derive(Clone, PartialEq, Eq)]
686 struct IrrevocablyResolvedHTLC {
687 commitment_tx_output_idx: Option<u32>,
688 /// The txid of the transaction which resolved the HTLC, this may be a commitment (if the HTLC
689 /// was not present in the confirmed commitment transaction), HTLC-Success, or HTLC-Timeout
691 resolving_txid: Option<Txid>, // Added as optional, but always filled in, in 0.0.110
692 resolving_tx: Option<Transaction>,
693 /// Only set if the HTLC claim was ours using a payment preimage
694 payment_preimage: Option<PaymentPreimage>,
697 // In LDK versions prior to 0.0.111 commitment_tx_output_idx was not Option-al and
698 // IrrevocablyResolvedHTLC objects only existed for non-dust HTLCs. This was a bug, but to maintain
699 // backwards compatibility we must ensure we always write out a commitment_tx_output_idx field,
700 // using `u32::max_value()` as a sentinal to indicate the HTLC was dust.
701 impl Writeable for IrrevocablyResolvedHTLC {
702 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
703 let mapped_commitment_tx_output_idx = self.commitment_tx_output_idx.unwrap_or(u32::max_value());
704 write_tlv_fields!(writer, {
705 (0, mapped_commitment_tx_output_idx, required),
706 (1, self.resolving_txid, option),
707 (2, self.payment_preimage, option),
708 (3, self.resolving_tx, option),
714 impl Readable for IrrevocablyResolvedHTLC {
715 fn read<R: io::Read>(reader: &mut R) -> Result<Self, DecodeError> {
716 let mut mapped_commitment_tx_output_idx = 0;
717 let mut resolving_txid = None;
718 let mut payment_preimage = None;
719 let mut resolving_tx = None;
720 read_tlv_fields!(reader, {
721 (0, mapped_commitment_tx_output_idx, required),
722 (1, resolving_txid, option),
723 (2, payment_preimage, option),
724 (3, resolving_tx, option),
727 commitment_tx_output_idx: if mapped_commitment_tx_output_idx == u32::max_value() { None } else { Some(mapped_commitment_tx_output_idx) },
735 /// A ChannelMonitor handles chain events (blocks connected and disconnected) and generates
736 /// on-chain transactions to ensure no loss of funds occurs.
738 /// You MUST ensure that no ChannelMonitors for a given channel anywhere contain out-of-date
739 /// information and are actively monitoring the chain.
741 /// Note that the deserializer is only implemented for (BlockHash, ChannelMonitor), which
742 /// tells you the last block hash which was block_connect()ed. You MUST rescan any blocks along
743 /// the "reorg path" (ie disconnecting blocks until you find a common ancestor from both the
744 /// returned block hash and the the current chain and then reconnecting blocks to get to the
745 /// best chain) upon deserializing the object!
746 pub struct ChannelMonitor<Signer: WriteableEcdsaChannelSigner> {
748 pub(crate) inner: Mutex<ChannelMonitorImpl<Signer>>,
750 pub(super) inner: Mutex<ChannelMonitorImpl<Signer>>,
753 impl<Signer: WriteableEcdsaChannelSigner> Clone for ChannelMonitor<Signer> where Signer: Clone {
754 fn clone(&self) -> Self {
755 let inner = self.inner.lock().unwrap().clone();
756 ChannelMonitor::from_impl(inner)
760 #[derive(Clone, PartialEq)]
761 pub(crate) struct ChannelMonitorImpl<Signer: WriteableEcdsaChannelSigner> {
762 latest_update_id: u64,
763 commitment_transaction_number_obscure_factor: u64,
765 destination_script: Script,
766 broadcasted_holder_revokable_script: Option<(Script, PublicKey, PublicKey)>,
767 counterparty_payment_script: Script,
768 shutdown_script: Option<Script>,
770 channel_keys_id: [u8; 32],
771 holder_revocation_basepoint: PublicKey,
772 funding_info: (OutPoint, Script),
773 current_counterparty_commitment_txid: Option<Txid>,
774 prev_counterparty_commitment_txid: Option<Txid>,
776 counterparty_commitment_params: CounterpartyCommitmentParameters,
777 funding_redeemscript: Script,
778 channel_value_satoshis: u64,
779 // first is the idx of the first of the two per-commitment points
780 their_cur_per_commitment_points: Option<(u64, PublicKey, Option<PublicKey>)>,
782 on_holder_tx_csv: u16,
784 commitment_secrets: CounterpartyCommitmentSecrets,
785 /// The set of outpoints in each counterparty commitment transaction. We always need at least
786 /// the payment hash from `HTLCOutputInCommitment` to claim even a revoked commitment
787 /// transaction broadcast as we need to be able to construct the witness script in all cases.
788 counterparty_claimable_outpoints: HashMap<Txid, Vec<(HTLCOutputInCommitment, Option<Box<HTLCSource>>)>>,
789 /// We cannot identify HTLC-Success or HTLC-Timeout transactions by themselves on the chain.
790 /// Nor can we figure out their commitment numbers without the commitment transaction they are
791 /// spending. Thus, in order to claim them via revocation key, we track all the counterparty
792 /// commitment transactions which we find on-chain, mapping them to the commitment number which
793 /// can be used to derive the revocation key and claim the transactions.
794 counterparty_commitment_txn_on_chain: HashMap<Txid, u64>,
795 /// Cache used to make pruning of payment_preimages faster.
796 /// Maps payment_hash values to commitment numbers for counterparty transactions for non-revoked
797 /// counterparty transactions (ie should remain pretty small).
798 /// Serialized to disk but should generally not be sent to Watchtowers.
799 counterparty_hash_commitment_number: HashMap<PaymentHash, u64>,
801 counterparty_fulfilled_htlcs: HashMap<SentHTLCId, PaymentPreimage>,
803 // We store two holder commitment transactions to avoid any race conditions where we may update
804 // some monitors (potentially on watchtowers) but then fail to update others, resulting in the
805 // various monitors for one channel being out of sync, and us broadcasting a holder
806 // transaction for which we have deleted claim information on some watchtowers.
807 prev_holder_signed_commitment_tx: Option<HolderSignedTx>,
808 current_holder_commitment_tx: HolderSignedTx,
810 // Used just for ChannelManager to make sure it has the latest channel data during
812 current_counterparty_commitment_number: u64,
813 // Used just for ChannelManager to make sure it has the latest channel data during
815 current_holder_commitment_number: u64,
817 /// The set of payment hashes from inbound payments for which we know the preimage. Payment
818 /// preimages that are not included in any unrevoked local commitment transaction or unrevoked
819 /// remote commitment transactions are automatically removed when commitment transactions are
821 payment_preimages: HashMap<PaymentHash, PaymentPreimage>,
823 // Note that `MonitorEvent`s MUST NOT be generated during update processing, only generated
824 // during chain data processing. This prevents a race in `ChainMonitor::update_channel` (and
825 // presumably user implementations thereof as well) where we update the in-memory channel
826 // object, then before the persistence finishes (as it's all under a read-lock), we return
827 // pending events to the user or to the relevant `ChannelManager`. Then, on reload, we'll have
828 // the pre-event state here, but have processed the event in the `ChannelManager`.
829 // Note that because the `event_lock` in `ChainMonitor` is only taken in
830 // block/transaction-connected events and *not* during block/transaction-disconnected events,
831 // we further MUST NOT generate events during block/transaction-disconnection.
832 pending_monitor_events: Vec<MonitorEvent>,
834 pub(super) pending_events: Vec<Event>,
835 pub(super) is_processing_pending_events: bool,
837 // Used to track on-chain events (i.e., transactions part of channels confirmed on chain) on
838 // which to take actions once they reach enough confirmations. Each entry includes the
839 // transaction's id and the height when the transaction was confirmed on chain.
840 onchain_events_awaiting_threshold_conf: Vec<OnchainEventEntry>,
842 // If we get serialized out and re-read, we need to make sure that the chain monitoring
843 // interface knows about the TXOs that we want to be notified of spends of. We could probably
844 // be smart and derive them from the above storage fields, but its much simpler and more
845 // Obviously Correct (tm) if we just keep track of them explicitly.
846 outputs_to_watch: HashMap<Txid, Vec<(u32, Script)>>,
849 pub onchain_tx_handler: OnchainTxHandler<Signer>,
851 onchain_tx_handler: OnchainTxHandler<Signer>,
853 // This is set when the Channel[Manager] generated a ChannelMonitorUpdate which indicated the
854 // channel has been force-closed. After this is set, no further holder commitment transaction
855 // updates may occur, and we panic!() if one is provided.
856 lockdown_from_offchain: bool,
858 // Set once we've signed a holder commitment transaction and handed it over to our
859 // OnchainTxHandler. After this is set, no future updates to our holder commitment transactions
860 // may occur, and we fail any such monitor updates.
862 // In case of update rejection due to a locally already signed commitment transaction, we
863 // nevertheless store update content to track in case of concurrent broadcast by another
864 // remote monitor out-of-order with regards to the block view.
865 holder_tx_signed: bool,
867 // If a spend of the funding output is seen, we set this to true and reject any further
868 // updates. This prevents any further changes in the offchain state no matter the order
869 // of block connection between ChannelMonitors and the ChannelManager.
870 funding_spend_seen: bool,
872 /// Set to `Some` of the confirmed transaction spending the funding input of the channel after
873 /// reaching `ANTI_REORG_DELAY` confirmations.
874 funding_spend_confirmed: Option<Txid>,
876 confirmed_commitment_tx_counterparty_output: CommitmentTxCounterpartyOutputInfo,
877 /// The set of HTLCs which have been either claimed or failed on chain and have reached
878 /// the requisite confirmations on the claim/fail transaction (either ANTI_REORG_DELAY or the
879 /// spending CSV for revocable outputs).
880 htlcs_resolved_on_chain: Vec<IrrevocablyResolvedHTLC>,
882 /// The set of `SpendableOutput` events which we have already passed upstream to be claimed.
883 /// These are tracked explicitly to ensure that we don't generate the same events redundantly
884 /// if users duplicatively confirm old transactions. Specifically for transactions claiming a
885 /// revoked remote outpoint we otherwise have no tracking at all once they've reached
886 /// [`ANTI_REORG_DELAY`], so we have to track them here.
887 spendable_txids_confirmed: Vec<Txid>,
889 // We simply modify best_block in Channel's block_connected so that serialization is
890 // consistent but hopefully the users' copy handles block_connected in a consistent way.
891 // (we do *not*, however, update them in update_monitor to ensure any local user copies keep
892 // their best_block from its state and not based on updated copies that didn't run through
893 // the full block_connected).
894 best_block: BestBlock,
896 /// The node_id of our counterparty
897 counterparty_node_id: Option<PublicKey>,
900 /// Transaction outputs to watch for on-chain spends.
901 pub type TransactionOutputs = (Txid, Vec<(u32, TxOut)>);
903 impl<Signer: WriteableEcdsaChannelSigner> PartialEq for ChannelMonitor<Signer> where Signer: PartialEq {
904 fn eq(&self, other: &Self) -> bool {
905 // We need some kind of total lockorder. Absent a better idea, we sort by position in
906 // memory and take locks in that order (assuming that we can't move within memory while a
908 let ord = ((self as *const _) as usize) < ((other as *const _) as usize);
909 let a = if ord { self.inner.unsafe_well_ordered_double_lock_self() } else { other.inner.unsafe_well_ordered_double_lock_self() };
910 let b = if ord { other.inner.unsafe_well_ordered_double_lock_self() } else { self.inner.unsafe_well_ordered_double_lock_self() };
915 impl<Signer: WriteableEcdsaChannelSigner> Writeable for ChannelMonitor<Signer> {
916 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), Error> {
917 self.inner.lock().unwrap().write(writer)
921 // These are also used for ChannelMonitorUpdate, above.
922 const SERIALIZATION_VERSION: u8 = 1;
923 const MIN_SERIALIZATION_VERSION: u8 = 1;
925 impl<Signer: WriteableEcdsaChannelSigner> Writeable for ChannelMonitorImpl<Signer> {
926 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), Error> {
927 write_ver_prefix!(writer, SERIALIZATION_VERSION, MIN_SERIALIZATION_VERSION);
929 self.latest_update_id.write(writer)?;
931 // Set in initial Channel-object creation, so should always be set by now:
932 U48(self.commitment_transaction_number_obscure_factor).write(writer)?;
934 self.destination_script.write(writer)?;
935 if let Some(ref broadcasted_holder_revokable_script) = self.broadcasted_holder_revokable_script {
936 writer.write_all(&[0; 1])?;
937 broadcasted_holder_revokable_script.0.write(writer)?;
938 broadcasted_holder_revokable_script.1.write(writer)?;
939 broadcasted_holder_revokable_script.2.write(writer)?;
941 writer.write_all(&[1; 1])?;
944 self.counterparty_payment_script.write(writer)?;
945 match &self.shutdown_script {
946 Some(script) => script.write(writer)?,
947 None => Script::new().write(writer)?,
950 self.channel_keys_id.write(writer)?;
951 self.holder_revocation_basepoint.write(writer)?;
952 writer.write_all(&self.funding_info.0.txid[..])?;
953 writer.write_all(&self.funding_info.0.index.to_be_bytes())?;
954 self.funding_info.1.write(writer)?;
955 self.current_counterparty_commitment_txid.write(writer)?;
956 self.prev_counterparty_commitment_txid.write(writer)?;
958 self.counterparty_commitment_params.write(writer)?;
959 self.funding_redeemscript.write(writer)?;
960 self.channel_value_satoshis.write(writer)?;
962 match self.their_cur_per_commitment_points {
963 Some((idx, pubkey, second_option)) => {
964 writer.write_all(&byte_utils::be48_to_array(idx))?;
965 writer.write_all(&pubkey.serialize())?;
966 match second_option {
967 Some(second_pubkey) => {
968 writer.write_all(&second_pubkey.serialize())?;
971 writer.write_all(&[0; 33])?;
976 writer.write_all(&byte_utils::be48_to_array(0))?;
980 writer.write_all(&self.on_holder_tx_csv.to_be_bytes())?;
982 self.commitment_secrets.write(writer)?;
984 macro_rules! serialize_htlc_in_commitment {
985 ($htlc_output: expr) => {
986 writer.write_all(&[$htlc_output.offered as u8; 1])?;
987 writer.write_all(&$htlc_output.amount_msat.to_be_bytes())?;
988 writer.write_all(&$htlc_output.cltv_expiry.to_be_bytes())?;
989 writer.write_all(&$htlc_output.payment_hash.0[..])?;
990 $htlc_output.transaction_output_index.write(writer)?;
994 writer.write_all(&(self.counterparty_claimable_outpoints.len() as u64).to_be_bytes())?;
995 for (ref txid, ref htlc_infos) in self.counterparty_claimable_outpoints.iter() {
996 writer.write_all(&txid[..])?;
997 writer.write_all(&(htlc_infos.len() as u64).to_be_bytes())?;
998 for &(ref htlc_output, ref htlc_source) in htlc_infos.iter() {
999 debug_assert!(htlc_source.is_none() || Some(**txid) == self.current_counterparty_commitment_txid
1000 || Some(**txid) == self.prev_counterparty_commitment_txid,
1001 "HTLC Sources for all revoked commitment transactions should be none!");
1002 serialize_htlc_in_commitment!(htlc_output);
1003 htlc_source.as_ref().map(|b| b.as_ref()).write(writer)?;
1007 writer.write_all(&(self.counterparty_commitment_txn_on_chain.len() as u64).to_be_bytes())?;
1008 for (ref txid, commitment_number) in self.counterparty_commitment_txn_on_chain.iter() {
1009 writer.write_all(&txid[..])?;
1010 writer.write_all(&byte_utils::be48_to_array(*commitment_number))?;
1013 writer.write_all(&(self.counterparty_hash_commitment_number.len() as u64).to_be_bytes())?;
1014 for (ref payment_hash, commitment_number) in self.counterparty_hash_commitment_number.iter() {
1015 writer.write_all(&payment_hash.0[..])?;
1016 writer.write_all(&byte_utils::be48_to_array(*commitment_number))?;
1019 if let Some(ref prev_holder_tx) = self.prev_holder_signed_commitment_tx {
1020 writer.write_all(&[1; 1])?;
1021 prev_holder_tx.write(writer)?;
1023 writer.write_all(&[0; 1])?;
1026 self.current_holder_commitment_tx.write(writer)?;
1028 writer.write_all(&byte_utils::be48_to_array(self.current_counterparty_commitment_number))?;
1029 writer.write_all(&byte_utils::be48_to_array(self.current_holder_commitment_number))?;
1031 writer.write_all(&(self.payment_preimages.len() as u64).to_be_bytes())?;
1032 for payment_preimage in self.payment_preimages.values() {
1033 writer.write_all(&payment_preimage.0[..])?;
1036 writer.write_all(&(self.pending_monitor_events.iter().filter(|ev| match ev {
1037 MonitorEvent::HTLCEvent(_) => true,
1038 MonitorEvent::CommitmentTxConfirmed(_) => true,
1040 }).count() as u64).to_be_bytes())?;
1041 for event in self.pending_monitor_events.iter() {
1043 MonitorEvent::HTLCEvent(upd) => {
1047 MonitorEvent::CommitmentTxConfirmed(_) => 1u8.write(writer)?,
1048 _ => {}, // Covered in the TLV writes below
1052 writer.write_all(&(self.pending_events.len() as u64).to_be_bytes())?;
1053 for event in self.pending_events.iter() {
1054 event.write(writer)?;
1057 self.best_block.block_hash().write(writer)?;
1058 writer.write_all(&self.best_block.height().to_be_bytes())?;
1060 writer.write_all(&(self.onchain_events_awaiting_threshold_conf.len() as u64).to_be_bytes())?;
1061 for ref entry in self.onchain_events_awaiting_threshold_conf.iter() {
1062 entry.write(writer)?;
1065 (self.outputs_to_watch.len() as u64).write(writer)?;
1066 for (txid, idx_scripts) in self.outputs_to_watch.iter() {
1067 txid.write(writer)?;
1068 (idx_scripts.len() as u64).write(writer)?;
1069 for (idx, script) in idx_scripts.iter() {
1071 script.write(writer)?;
1074 self.onchain_tx_handler.write(writer)?;
1076 self.lockdown_from_offchain.write(writer)?;
1077 self.holder_tx_signed.write(writer)?;
1079 write_tlv_fields!(writer, {
1080 (1, self.funding_spend_confirmed, option),
1081 (3, self.htlcs_resolved_on_chain, required_vec),
1082 (5, self.pending_monitor_events, required_vec),
1083 (7, self.funding_spend_seen, required),
1084 (9, self.counterparty_node_id, option),
1085 (11, self.confirmed_commitment_tx_counterparty_output, option),
1086 (13, self.spendable_txids_confirmed, required_vec),
1087 (15, self.counterparty_fulfilled_htlcs, required),
1094 macro_rules! _process_events_body {
1095 ($self_opt: expr, $event_to_handle: expr, $handle_event: expr) => {
1097 let (pending_events, repeated_events);
1098 if let Some(us) = $self_opt {
1099 let mut inner = us.inner.lock().unwrap();
1100 if inner.is_processing_pending_events {
1103 inner.is_processing_pending_events = true;
1105 pending_events = inner.pending_events.clone();
1106 repeated_events = inner.get_repeated_events();
1108 let num_events = pending_events.len();
1110 for event in pending_events.into_iter().chain(repeated_events.into_iter()) {
1111 $event_to_handle = event;
1115 if let Some(us) = $self_opt {
1116 let mut inner = us.inner.lock().unwrap();
1117 inner.pending_events.drain(..num_events);
1118 inner.is_processing_pending_events = false;
1119 if !inner.pending_events.is_empty() {
1120 // If there's more events to process, go ahead and do so.
1128 pub(super) use _process_events_body as process_events_body;
1130 impl<Signer: WriteableEcdsaChannelSigner> ChannelMonitor<Signer> {
1131 /// For lockorder enforcement purposes, we need to have a single site which constructs the
1132 /// `inner` mutex, otherwise cases where we lock two monitors at the same time (eg in our
1133 /// PartialEq implementation) we may decide a lockorder violation has occurred.
1134 fn from_impl(imp: ChannelMonitorImpl<Signer>) -> Self {
1135 ChannelMonitor { inner: Mutex::new(imp) }
1138 pub(crate) fn new(secp_ctx: Secp256k1<secp256k1::All>, keys: Signer, shutdown_script: Option<Script>,
1139 on_counterparty_tx_csv: u16, destination_script: &Script, funding_info: (OutPoint, Script),
1140 channel_parameters: &ChannelTransactionParameters,
1141 funding_redeemscript: Script, channel_value_satoshis: u64,
1142 commitment_transaction_number_obscure_factor: u64,
1143 initial_holder_commitment_tx: HolderCommitmentTransaction,
1144 best_block: BestBlock, counterparty_node_id: PublicKey) -> ChannelMonitor<Signer> {
1146 assert!(commitment_transaction_number_obscure_factor <= (1 << 48));
1147 let payment_key_hash = WPubkeyHash::hash(&keys.pubkeys().payment_point.serialize());
1148 let counterparty_payment_script = Builder::new().push_opcode(opcodes::all::OP_PUSHBYTES_0).push_slice(&payment_key_hash[..]).into_script();
1150 let counterparty_channel_parameters = channel_parameters.counterparty_parameters.as_ref().unwrap();
1151 let counterparty_delayed_payment_base_key = counterparty_channel_parameters.pubkeys.delayed_payment_basepoint;
1152 let counterparty_htlc_base_key = counterparty_channel_parameters.pubkeys.htlc_basepoint;
1153 let counterparty_commitment_params = CounterpartyCommitmentParameters { counterparty_delayed_payment_base_key, counterparty_htlc_base_key, on_counterparty_tx_csv };
1155 let channel_keys_id = keys.channel_keys_id();
1156 let holder_revocation_basepoint = keys.pubkeys().revocation_basepoint;
1158 // block for Rust 1.34 compat
1159 let (holder_commitment_tx, current_holder_commitment_number) = {
1160 let trusted_tx = initial_holder_commitment_tx.trust();
1161 let txid = trusted_tx.txid();
1163 let tx_keys = trusted_tx.keys();
1164 let holder_commitment_tx = HolderSignedTx {
1166 revocation_key: tx_keys.revocation_key,
1167 a_htlc_key: tx_keys.broadcaster_htlc_key,
1168 b_htlc_key: tx_keys.countersignatory_htlc_key,
1169 delayed_payment_key: tx_keys.broadcaster_delayed_payment_key,
1170 per_commitment_point: tx_keys.per_commitment_point,
1171 htlc_outputs: Vec::new(), // There are never any HTLCs in the initial commitment transactions
1172 to_self_value_sat: initial_holder_commitment_tx.to_broadcaster_value_sat(),
1173 feerate_per_kw: trusted_tx.feerate_per_kw(),
1175 (holder_commitment_tx, trusted_tx.commitment_number())
1178 let onchain_tx_handler =
1179 OnchainTxHandler::new(destination_script.clone(), keys,
1180 channel_parameters.clone(), initial_holder_commitment_tx, secp_ctx);
1182 let mut outputs_to_watch = HashMap::new();
1183 outputs_to_watch.insert(funding_info.0.txid, vec![(funding_info.0.index as u32, funding_info.1.clone())]);
1185 Self::from_impl(ChannelMonitorImpl {
1186 latest_update_id: 0,
1187 commitment_transaction_number_obscure_factor,
1189 destination_script: destination_script.clone(),
1190 broadcasted_holder_revokable_script: None,
1191 counterparty_payment_script,
1195 holder_revocation_basepoint,
1197 current_counterparty_commitment_txid: None,
1198 prev_counterparty_commitment_txid: None,
1200 counterparty_commitment_params,
1201 funding_redeemscript,
1202 channel_value_satoshis,
1203 their_cur_per_commitment_points: None,
1205 on_holder_tx_csv: counterparty_channel_parameters.selected_contest_delay,
1207 commitment_secrets: CounterpartyCommitmentSecrets::new(),
1208 counterparty_claimable_outpoints: HashMap::new(),
1209 counterparty_commitment_txn_on_chain: HashMap::new(),
1210 counterparty_hash_commitment_number: HashMap::new(),
1211 counterparty_fulfilled_htlcs: HashMap::new(),
1213 prev_holder_signed_commitment_tx: None,
1214 current_holder_commitment_tx: holder_commitment_tx,
1215 current_counterparty_commitment_number: 1 << 48,
1216 current_holder_commitment_number,
1218 payment_preimages: HashMap::new(),
1219 pending_monitor_events: Vec::new(),
1220 pending_events: Vec::new(),
1221 is_processing_pending_events: false,
1223 onchain_events_awaiting_threshold_conf: Vec::new(),
1228 lockdown_from_offchain: false,
1229 holder_tx_signed: false,
1230 funding_spend_seen: false,
1231 funding_spend_confirmed: None,
1232 confirmed_commitment_tx_counterparty_output: None,
1233 htlcs_resolved_on_chain: Vec::new(),
1234 spendable_txids_confirmed: Vec::new(),
1237 counterparty_node_id: Some(counterparty_node_id),
1242 fn provide_secret(&self, idx: u64, secret: [u8; 32]) -> Result<(), &'static str> {
1243 self.inner.lock().unwrap().provide_secret(idx, secret)
1246 /// Informs this monitor of the latest counterparty (ie non-broadcastable) commitment transaction.
1247 /// The monitor watches for it to be broadcasted and then uses the HTLC information (and
1248 /// possibly future revocation/preimage information) to claim outputs where possible.
1249 /// We cache also the mapping hash:commitment number to lighten pruning of old preimages by watchtowers.
1250 pub(crate) fn provide_latest_counterparty_commitment_tx<L: Deref>(
1253 htlc_outputs: Vec<(HTLCOutputInCommitment, Option<Box<HTLCSource>>)>,
1254 commitment_number: u64,
1255 their_per_commitment_point: PublicKey,
1257 ) where L::Target: Logger {
1258 self.inner.lock().unwrap().provide_latest_counterparty_commitment_tx(
1259 txid, htlc_outputs, commitment_number, their_per_commitment_point, logger)
1263 fn provide_latest_holder_commitment_tx(
1264 &self, holder_commitment_tx: HolderCommitmentTransaction,
1265 htlc_outputs: Vec<(HTLCOutputInCommitment, Option<Signature>, Option<HTLCSource>)>,
1266 ) -> Result<(), ()> {
1267 self.inner.lock().unwrap().provide_latest_holder_commitment_tx(holder_commitment_tx, htlc_outputs, &Vec::new(), Vec::new()).map_err(|_| ())
1270 /// This is used to provide payment preimage(s) out-of-band during startup without updating the
1271 /// off-chain state with a new commitment transaction.
1272 pub(crate) fn provide_payment_preimage<B: Deref, F: Deref, L: Deref>(
1274 payment_hash: &PaymentHash,
1275 payment_preimage: &PaymentPreimage,
1277 fee_estimator: &LowerBoundedFeeEstimator<F>,
1280 B::Target: BroadcasterInterface,
1281 F::Target: FeeEstimator,
1284 self.inner.lock().unwrap().provide_payment_preimage(
1285 payment_hash, payment_preimage, broadcaster, fee_estimator, logger)
1288 /// Updates a ChannelMonitor on the basis of some new information provided by the Channel
1291 /// panics if the given update is not the next update by update_id.
1292 pub fn update_monitor<B: Deref, F: Deref, L: Deref>(
1294 updates: &ChannelMonitorUpdate,
1300 B::Target: BroadcasterInterface,
1301 F::Target: FeeEstimator,
1304 self.inner.lock().unwrap().update_monitor(updates, broadcaster, fee_estimator, logger)
1307 /// Gets the update_id from the latest ChannelMonitorUpdate which was applied to this
1309 pub fn get_latest_update_id(&self) -> u64 {
1310 self.inner.lock().unwrap().get_latest_update_id()
1313 /// Gets the funding transaction outpoint of the channel this ChannelMonitor is monitoring for.
1314 pub fn get_funding_txo(&self) -> (OutPoint, Script) {
1315 self.inner.lock().unwrap().get_funding_txo().clone()
1318 /// Gets a list of txids, with their output scripts (in the order they appear in the
1319 /// transaction), which we must learn about spends of via block_connected().
1320 pub fn get_outputs_to_watch(&self) -> Vec<(Txid, Vec<(u32, Script)>)> {
1321 self.inner.lock().unwrap().get_outputs_to_watch()
1322 .iter().map(|(txid, outputs)| (*txid, outputs.clone())).collect()
1325 /// Loads the funding txo and outputs to watch into the given `chain::Filter` by repeatedly
1326 /// calling `chain::Filter::register_output` and `chain::Filter::register_tx` until all outputs
1327 /// have been registered.
1328 pub fn load_outputs_to_watch<F: Deref>(&self, filter: &F) where F::Target: chain::Filter {
1329 let lock = self.inner.lock().unwrap();
1330 filter.register_tx(&lock.get_funding_txo().0.txid, &lock.get_funding_txo().1);
1331 for (txid, outputs) in lock.get_outputs_to_watch().iter() {
1332 for (index, script_pubkey) in outputs.iter() {
1333 assert!(*index <= u16::max_value() as u32);
1334 filter.register_output(WatchedOutput {
1336 outpoint: OutPoint { txid: *txid, index: *index as u16 },
1337 script_pubkey: script_pubkey.clone(),
1343 /// Get the list of HTLCs who's status has been updated on chain. This should be called by
1344 /// ChannelManager via [`chain::Watch::release_pending_monitor_events`].
1345 pub fn get_and_clear_pending_monitor_events(&self) -> Vec<MonitorEvent> {
1346 self.inner.lock().unwrap().get_and_clear_pending_monitor_events()
1349 /// Processes [`SpendableOutputs`] events produced from each [`ChannelMonitor`] upon maturity.
1351 /// For channels featuring anchor outputs, this method will also process [`BumpTransaction`]
1352 /// events produced from each [`ChannelMonitor`] while there is a balance to claim onchain
1353 /// within each channel. As the confirmation of a commitment transaction may be critical to the
1354 /// safety of funds, we recommend invoking this every 30 seconds, or lower if running in an
1355 /// environment with spotty connections, like on mobile.
1357 /// An [`EventHandler`] may safely call back to the provider, though this shouldn't be needed in
1358 /// order to handle these events.
1360 /// [`SpendableOutputs`]: crate::events::Event::SpendableOutputs
1361 /// [`BumpTransaction`]: crate::events::Event::BumpTransaction
1362 pub fn process_pending_events<H: Deref>(&self, handler: &H) where H::Target: EventHandler {
1364 process_events_body!(Some(self), ev, handler.handle_event(ev));
1367 /// Processes any events asynchronously.
1369 /// See [`Self::process_pending_events`] for more information.
1370 pub async fn process_pending_events_async<Future: core::future::Future, H: Fn(Event) -> Future>(
1374 process_events_body!(Some(self), ev, { handler(ev).await });
1378 pub fn get_and_clear_pending_events(&self) -> Vec<Event> {
1379 let mut ret = Vec::new();
1380 let mut lck = self.inner.lock().unwrap();
1381 mem::swap(&mut ret, &mut lck.pending_events);
1382 ret.append(&mut lck.get_repeated_events());
1386 pub(crate) fn get_min_seen_secret(&self) -> u64 {
1387 self.inner.lock().unwrap().get_min_seen_secret()
1390 pub(crate) fn get_cur_counterparty_commitment_number(&self) -> u64 {
1391 self.inner.lock().unwrap().get_cur_counterparty_commitment_number()
1394 pub(crate) fn get_cur_holder_commitment_number(&self) -> u64 {
1395 self.inner.lock().unwrap().get_cur_holder_commitment_number()
1398 /// Gets the `node_id` of the counterparty for this channel.
1400 /// Will be `None` for channels constructed on LDK versions prior to 0.0.110 and always `Some`
1402 pub fn get_counterparty_node_id(&self) -> Option<PublicKey> {
1403 self.inner.lock().unwrap().counterparty_node_id
1406 /// Used by ChannelManager deserialization to broadcast the latest holder state if its copy of
1407 /// the Channel was out-of-date.
1409 /// You may also use this to broadcast the latest local commitment transaction, either because
1410 /// a monitor update failed with [`ChannelMonitorUpdateStatus::PermanentFailure`] or because we've
1411 /// fallen behind (i.e. we've received proof that our counterparty side knows a revocation
1412 /// secret we gave them that they shouldn't know).
1414 /// Broadcasting these transactions in the second case is UNSAFE, as they allow counterparty
1415 /// side to punish you. Nevertheless you may want to broadcast them if counterparty doesn't
1416 /// close channel with their commitment transaction after a substantial amount of time. Best
1417 /// may be to contact the other node operator out-of-band to coordinate other options available
1418 /// to you. In any-case, the choice is up to you.
1420 /// [`ChannelMonitorUpdateStatus::PermanentFailure`]: super::ChannelMonitorUpdateStatus::PermanentFailure
1421 pub fn get_latest_holder_commitment_txn<L: Deref>(&self, logger: &L) -> Vec<Transaction>
1422 where L::Target: Logger {
1423 self.inner.lock().unwrap().get_latest_holder_commitment_txn(logger)
1426 /// Unsafe test-only version of get_latest_holder_commitment_txn used by our test framework
1427 /// to bypass HolderCommitmentTransaction state update lockdown after signature and generate
1428 /// revoked commitment transaction.
1429 #[cfg(any(test, feature = "unsafe_revoked_tx_signing"))]
1430 pub fn unsafe_get_latest_holder_commitment_txn<L: Deref>(&self, logger: &L) -> Vec<Transaction>
1431 where L::Target: Logger {
1432 self.inner.lock().unwrap().unsafe_get_latest_holder_commitment_txn(logger)
1435 /// Processes transactions in a newly connected block, which may result in any of the following:
1436 /// - update the monitor's state against resolved HTLCs
1437 /// - punish the counterparty in the case of seeing a revoked commitment transaction
1438 /// - force close the channel and claim/timeout incoming/outgoing HTLCs if near expiration
1439 /// - detect settled outputs for later spending
1440 /// - schedule and bump any in-flight claims
1442 /// Returns any new outputs to watch from `txdata`; after called, these are also included in
1443 /// [`get_outputs_to_watch`].
1445 /// [`get_outputs_to_watch`]: #method.get_outputs_to_watch
1446 pub fn block_connected<B: Deref, F: Deref, L: Deref>(
1448 header: &BlockHeader,
1449 txdata: &TransactionData,
1454 ) -> Vec<TransactionOutputs>
1456 B::Target: BroadcasterInterface,
1457 F::Target: FeeEstimator,
1460 self.inner.lock().unwrap().block_connected(
1461 header, txdata, height, broadcaster, fee_estimator, logger)
1464 /// Determines if the disconnected block contained any transactions of interest and updates
1466 pub fn block_disconnected<B: Deref, F: Deref, L: Deref>(
1468 header: &BlockHeader,
1474 B::Target: BroadcasterInterface,
1475 F::Target: FeeEstimator,
1478 self.inner.lock().unwrap().block_disconnected(
1479 header, height, broadcaster, fee_estimator, logger)
1482 /// Processes transactions confirmed in a block with the given header and height, returning new
1483 /// outputs to watch. See [`block_connected`] for details.
1485 /// Used instead of [`block_connected`] by clients that are notified of transactions rather than
1486 /// blocks. See [`chain::Confirm`] for calling expectations.
1488 /// [`block_connected`]: Self::block_connected
1489 pub fn transactions_confirmed<B: Deref, F: Deref, L: Deref>(
1491 header: &BlockHeader,
1492 txdata: &TransactionData,
1497 ) -> Vec<TransactionOutputs>
1499 B::Target: BroadcasterInterface,
1500 F::Target: FeeEstimator,
1503 let bounded_fee_estimator = LowerBoundedFeeEstimator::new(fee_estimator);
1504 self.inner.lock().unwrap().transactions_confirmed(
1505 header, txdata, height, broadcaster, &bounded_fee_estimator, logger)
1508 /// Processes a transaction that was reorganized out of the chain.
1510 /// Used instead of [`block_disconnected`] by clients that are notified of transactions rather
1511 /// than blocks. See [`chain::Confirm`] for calling expectations.
1513 /// [`block_disconnected`]: Self::block_disconnected
1514 pub fn transaction_unconfirmed<B: Deref, F: Deref, L: Deref>(
1521 B::Target: BroadcasterInterface,
1522 F::Target: FeeEstimator,
1525 let bounded_fee_estimator = LowerBoundedFeeEstimator::new(fee_estimator);
1526 self.inner.lock().unwrap().transaction_unconfirmed(
1527 txid, broadcaster, &bounded_fee_estimator, logger);
1530 /// Updates the monitor with the current best chain tip, returning new outputs to watch. See
1531 /// [`block_connected`] for details.
1533 /// Used instead of [`block_connected`] by clients that are notified of transactions rather than
1534 /// blocks. See [`chain::Confirm`] for calling expectations.
1536 /// [`block_connected`]: Self::block_connected
1537 pub fn best_block_updated<B: Deref, F: Deref, L: Deref>(
1539 header: &BlockHeader,
1544 ) -> Vec<TransactionOutputs>
1546 B::Target: BroadcasterInterface,
1547 F::Target: FeeEstimator,
1550 let bounded_fee_estimator = LowerBoundedFeeEstimator::new(fee_estimator);
1551 self.inner.lock().unwrap().best_block_updated(
1552 header, height, broadcaster, &bounded_fee_estimator, logger)
1555 /// Returns the set of txids that should be monitored for re-organization out of the chain.
1556 pub fn get_relevant_txids(&self) -> Vec<(Txid, Option<BlockHash>)> {
1557 let inner = self.inner.lock().unwrap();
1558 let mut txids: Vec<(Txid, Option<BlockHash>)> = inner.onchain_events_awaiting_threshold_conf
1560 .map(|entry| (entry.txid, entry.block_hash))
1561 .chain(inner.onchain_tx_handler.get_relevant_txids().into_iter())
1563 txids.sort_unstable();
1568 /// Gets the latest best block which was connected either via the [`chain::Listen`] or
1569 /// [`chain::Confirm`] interfaces.
1570 pub fn current_best_block(&self) -> BestBlock {
1571 self.inner.lock().unwrap().best_block.clone()
1574 /// Triggers rebroadcasts/fee-bumps of pending claims from a force-closed channel. This is
1575 /// crucial in preventing certain classes of pinning attacks, detecting substantial mempool
1576 /// feerate changes between blocks, and ensuring reliability if broadcasting fails. We recommend
1577 /// invoking this every 30 seconds, or lower if running in an environment with spotty
1578 /// connections, like on mobile.
1579 pub fn rebroadcast_pending_claims<B: Deref, F: Deref, L: Deref>(
1580 &self, broadcaster: B, fee_estimator: F, logger: L,
1583 B::Target: BroadcasterInterface,
1584 F::Target: FeeEstimator,
1587 let fee_estimator = LowerBoundedFeeEstimator::new(fee_estimator);
1588 let mut inner = self.inner.lock().unwrap();
1589 let current_height = inner.best_block.height;
1590 inner.onchain_tx_handler.rebroadcast_pending_claims(
1591 current_height, &broadcaster, &fee_estimator, &logger,
1596 impl<Signer: WriteableEcdsaChannelSigner> ChannelMonitorImpl<Signer> {
1597 /// Helper for get_claimable_balances which does the work for an individual HTLC, generating up
1598 /// to one `Balance` for the HTLC.
1599 fn get_htlc_balance(&self, htlc: &HTLCOutputInCommitment, holder_commitment: bool,
1600 counterparty_revoked_commitment: bool, confirmed_txid: Option<Txid>)
1601 -> Option<Balance> {
1602 let htlc_commitment_tx_output_idx =
1603 if let Some(v) = htlc.transaction_output_index { v } else { return None; };
1605 let mut htlc_spend_txid_opt = None;
1606 let mut htlc_spend_tx_opt = None;
1607 let mut holder_timeout_spend_pending = None;
1608 let mut htlc_spend_pending = None;
1609 let mut holder_delayed_output_pending = None;
1610 for event in self.onchain_events_awaiting_threshold_conf.iter() {
1612 OnchainEvent::HTLCUpdate { commitment_tx_output_idx, htlc_value_satoshis, .. }
1613 if commitment_tx_output_idx == Some(htlc_commitment_tx_output_idx) => {
1614 debug_assert!(htlc_spend_txid_opt.is_none());
1615 htlc_spend_txid_opt = Some(&event.txid);
1616 debug_assert!(htlc_spend_tx_opt.is_none());
1617 htlc_spend_tx_opt = event.transaction.as_ref();
1618 debug_assert!(holder_timeout_spend_pending.is_none());
1619 debug_assert_eq!(htlc_value_satoshis.unwrap(), htlc.amount_msat / 1000);
1620 holder_timeout_spend_pending = Some(event.confirmation_threshold());
1622 OnchainEvent::HTLCSpendConfirmation { commitment_tx_output_idx, preimage, .. }
1623 if commitment_tx_output_idx == htlc_commitment_tx_output_idx => {
1624 debug_assert!(htlc_spend_txid_opt.is_none());
1625 htlc_spend_txid_opt = Some(&event.txid);
1626 debug_assert!(htlc_spend_tx_opt.is_none());
1627 htlc_spend_tx_opt = event.transaction.as_ref();
1628 debug_assert!(htlc_spend_pending.is_none());
1629 htlc_spend_pending = Some((event.confirmation_threshold(), preimage.is_some()));
1631 OnchainEvent::MaturingOutput {
1632 descriptor: SpendableOutputDescriptor::DelayedPaymentOutput(ref descriptor) }
1633 if descriptor.outpoint.index as u32 == htlc_commitment_tx_output_idx => {
1634 debug_assert!(holder_delayed_output_pending.is_none());
1635 holder_delayed_output_pending = Some(event.confirmation_threshold());
1640 let htlc_resolved = self.htlcs_resolved_on_chain.iter()
1641 .find(|v| if v.commitment_tx_output_idx == Some(htlc_commitment_tx_output_idx) {
1642 debug_assert!(htlc_spend_txid_opt.is_none());
1643 htlc_spend_txid_opt = v.resolving_txid.as_ref();
1644 debug_assert!(htlc_spend_tx_opt.is_none());
1645 htlc_spend_tx_opt = v.resolving_tx.as_ref();
1648 debug_assert!(holder_timeout_spend_pending.is_some() as u8 + htlc_spend_pending.is_some() as u8 + htlc_resolved.is_some() as u8 <= 1);
1650 let htlc_commitment_outpoint = BitcoinOutPoint::new(confirmed_txid.unwrap(), htlc_commitment_tx_output_idx);
1651 let htlc_output_to_spend =
1652 if let Some(txid) = htlc_spend_txid_opt {
1653 // Because HTLC transactions either only have 1 input and 1 output (pre-anchors) or
1654 // are signed with SIGHASH_SINGLE|ANYONECANPAY under BIP-0143 (post-anchors), we can
1655 // locate the correct output by ensuring its adjacent input spends the HTLC output
1656 // in the commitment.
1657 if let Some(ref tx) = htlc_spend_tx_opt {
1658 let htlc_input_idx_opt = tx.input.iter().enumerate()
1659 .find(|(_, input)| input.previous_output == htlc_commitment_outpoint)
1660 .map(|(idx, _)| idx as u32);
1661 debug_assert!(htlc_input_idx_opt.is_some());
1662 BitcoinOutPoint::new(*txid, htlc_input_idx_opt.unwrap_or(0))
1664 debug_assert!(!self.onchain_tx_handler.channel_type_features().supports_anchors_zero_fee_htlc_tx());
1665 BitcoinOutPoint::new(*txid, 0)
1668 htlc_commitment_outpoint
1670 let htlc_output_spend_pending = self.onchain_tx_handler.is_output_spend_pending(&htlc_output_to_spend);
1672 if let Some(conf_thresh) = holder_delayed_output_pending {
1673 debug_assert!(holder_commitment);
1674 return Some(Balance::ClaimableAwaitingConfirmations {
1675 claimable_amount_satoshis: htlc.amount_msat / 1000,
1676 confirmation_height: conf_thresh,
1678 } else if htlc_resolved.is_some() && !htlc_output_spend_pending {
1679 // Funding transaction spends should be fully confirmed by the time any
1680 // HTLC transactions are resolved, unless we're talking about a holder
1681 // commitment tx, whose resolution is delayed until the CSV timeout is
1682 // reached, even though HTLCs may be resolved after only
1683 // ANTI_REORG_DELAY confirmations.
1684 debug_assert!(holder_commitment || self.funding_spend_confirmed.is_some());
1685 } else if counterparty_revoked_commitment {
1686 let htlc_output_claim_pending = self.onchain_events_awaiting_threshold_conf.iter().find_map(|event| {
1687 if let OnchainEvent::MaturingOutput {
1688 descriptor: SpendableOutputDescriptor::StaticOutput { .. }
1690 if event.transaction.as_ref().map(|tx| tx.input.iter().any(|inp| {
1691 if let Some(htlc_spend_txid) = htlc_spend_txid_opt {
1692 tx.txid() == *htlc_spend_txid || inp.previous_output.txid == *htlc_spend_txid
1694 Some(inp.previous_output.txid) == confirmed_txid &&
1695 inp.previous_output.vout == htlc_commitment_tx_output_idx
1697 })).unwrap_or(false) {
1702 if htlc_output_claim_pending.is_some() {
1703 // We already push `Balance`s onto the `res` list for every
1704 // `StaticOutput` in a `MaturingOutput` in the revoked
1705 // counterparty commitment transaction case generally, so don't
1706 // need to do so again here.
1708 debug_assert!(holder_timeout_spend_pending.is_none(),
1709 "HTLCUpdate OnchainEvents should never appear for preimage claims");
1710 debug_assert!(!htlc.offered || htlc_spend_pending.is_none() || !htlc_spend_pending.unwrap().1,
1711 "We don't (currently) generate preimage claims against revoked outputs, where did you get one?!");
1712 return Some(Balance::CounterpartyRevokedOutputClaimable {
1713 claimable_amount_satoshis: htlc.amount_msat / 1000,
1716 } else if htlc.offered == holder_commitment {
1717 // If the payment was outbound, check if there's an HTLCUpdate
1718 // indicating we have spent this HTLC with a timeout, claiming it back
1719 // and awaiting confirmations on it.
1720 if let Some(conf_thresh) = holder_timeout_spend_pending {
1721 return Some(Balance::ClaimableAwaitingConfirmations {
1722 claimable_amount_satoshis: htlc.amount_msat / 1000,
1723 confirmation_height: conf_thresh,
1726 return Some(Balance::MaybeTimeoutClaimableHTLC {
1727 claimable_amount_satoshis: htlc.amount_msat / 1000,
1728 claimable_height: htlc.cltv_expiry,
1729 payment_hash: htlc.payment_hash,
1732 } else if let Some(payment_preimage) = self.payment_preimages.get(&htlc.payment_hash) {
1733 // Otherwise (the payment was inbound), only expose it as claimable if
1734 // we know the preimage.
1735 // Note that if there is a pending claim, but it did not use the
1736 // preimage, we lost funds to our counterparty! We will then continue
1737 // to show it as ContentiousClaimable until ANTI_REORG_DELAY.
1738 debug_assert!(holder_timeout_spend_pending.is_none());
1739 if let Some((conf_thresh, true)) = htlc_spend_pending {
1740 return Some(Balance::ClaimableAwaitingConfirmations {
1741 claimable_amount_satoshis: htlc.amount_msat / 1000,
1742 confirmation_height: conf_thresh,
1745 return Some(Balance::ContentiousClaimable {
1746 claimable_amount_satoshis: htlc.amount_msat / 1000,
1747 timeout_height: htlc.cltv_expiry,
1748 payment_hash: htlc.payment_hash,
1749 payment_preimage: *payment_preimage,
1752 } else if htlc_resolved.is_none() {
1753 return Some(Balance::MaybePreimageClaimableHTLC {
1754 claimable_amount_satoshis: htlc.amount_msat / 1000,
1755 expiry_height: htlc.cltv_expiry,
1756 payment_hash: htlc.payment_hash,
1763 impl<Signer: WriteableEcdsaChannelSigner> ChannelMonitor<Signer> {
1764 /// Gets the balances in this channel which are either claimable by us if we were to
1765 /// force-close the channel now or which are claimable on-chain (possibly awaiting
1768 /// Any balances in the channel which are available on-chain (excluding on-chain fees) are
1769 /// included here until an [`Event::SpendableOutputs`] event has been generated for the
1770 /// balance, or until our counterparty has claimed the balance and accrued several
1771 /// confirmations on the claim transaction.
1773 /// Note that for `ChannelMonitors` which track a channel which went on-chain with versions of
1774 /// LDK prior to 0.0.111, balances may not be fully captured if our counterparty broadcasted
1775 /// a revoked state.
1777 /// See [`Balance`] for additional details on the types of claimable balances which
1778 /// may be returned here and their meanings.
1779 pub fn get_claimable_balances(&self) -> Vec<Balance> {
1780 let mut res = Vec::new();
1781 let us = self.inner.lock().unwrap();
1783 let mut confirmed_txid = us.funding_spend_confirmed;
1784 let mut confirmed_counterparty_output = us.confirmed_commitment_tx_counterparty_output;
1785 let mut pending_commitment_tx_conf_thresh = None;
1786 let funding_spend_pending = us.onchain_events_awaiting_threshold_conf.iter().find_map(|event| {
1787 if let OnchainEvent::FundingSpendConfirmation { commitment_tx_to_counterparty_output, .. } =
1790 confirmed_counterparty_output = commitment_tx_to_counterparty_output;
1791 Some((event.txid, event.confirmation_threshold()))
1794 if let Some((txid, conf_thresh)) = funding_spend_pending {
1795 debug_assert!(us.funding_spend_confirmed.is_none(),
1796 "We have a pending funding spend awaiting anti-reorg confirmation, we can't have confirmed it already!");
1797 confirmed_txid = Some(txid);
1798 pending_commitment_tx_conf_thresh = Some(conf_thresh);
1801 macro_rules! walk_htlcs {
1802 ($holder_commitment: expr, $counterparty_revoked_commitment: expr, $htlc_iter: expr) => {
1803 for htlc in $htlc_iter {
1804 if htlc.transaction_output_index.is_some() {
1806 if let Some(bal) = us.get_htlc_balance(htlc, $holder_commitment, $counterparty_revoked_commitment, confirmed_txid) {
1814 if let Some(txid) = confirmed_txid {
1815 let mut found_commitment_tx = false;
1816 if let Some(counterparty_tx_htlcs) = us.counterparty_claimable_outpoints.get(&txid) {
1817 // First look for the to_remote output back to us.
1818 if let Some(conf_thresh) = pending_commitment_tx_conf_thresh {
1819 if let Some(value) = us.onchain_events_awaiting_threshold_conf.iter().find_map(|event| {
1820 if let OnchainEvent::MaturingOutput {
1821 descriptor: SpendableOutputDescriptor::StaticPaymentOutput(descriptor)
1823 Some(descriptor.output.value)
1826 res.push(Balance::ClaimableAwaitingConfirmations {
1827 claimable_amount_satoshis: value,
1828 confirmation_height: conf_thresh,
1831 // If a counterparty commitment transaction is awaiting confirmation, we
1832 // should either have a StaticPaymentOutput MaturingOutput event awaiting
1833 // confirmation with the same height or have never met our dust amount.
1836 if Some(txid) == us.current_counterparty_commitment_txid || Some(txid) == us.prev_counterparty_commitment_txid {
1837 walk_htlcs!(false, false, counterparty_tx_htlcs.iter().map(|(a, _)| a));
1839 walk_htlcs!(false, true, counterparty_tx_htlcs.iter().map(|(a, _)| a));
1840 // The counterparty broadcasted a revoked state!
1841 // Look for any StaticOutputs first, generating claimable balances for those.
1842 // If any match the confirmed counterparty revoked to_self output, skip
1843 // generating a CounterpartyRevokedOutputClaimable.
1844 let mut spent_counterparty_output = false;
1845 for event in us.onchain_events_awaiting_threshold_conf.iter() {
1846 if let OnchainEvent::MaturingOutput {
1847 descriptor: SpendableOutputDescriptor::StaticOutput { output, .. }
1849 res.push(Balance::ClaimableAwaitingConfirmations {
1850 claimable_amount_satoshis: output.value,
1851 confirmation_height: event.confirmation_threshold(),
1853 if let Some(confirmed_to_self_idx) = confirmed_counterparty_output.map(|(idx, _)| idx) {
1854 if event.transaction.as_ref().map(|tx|
1855 tx.input.iter().any(|inp| inp.previous_output.vout == confirmed_to_self_idx)
1856 ).unwrap_or(false) {
1857 spent_counterparty_output = true;
1863 if spent_counterparty_output {
1864 } else if let Some((confirmed_to_self_idx, amt)) = confirmed_counterparty_output {
1865 let output_spendable = us.onchain_tx_handler
1866 .is_output_spend_pending(&BitcoinOutPoint::new(txid, confirmed_to_self_idx));
1867 if output_spendable {
1868 res.push(Balance::CounterpartyRevokedOutputClaimable {
1869 claimable_amount_satoshis: amt,
1873 // Counterparty output is missing, either it was broadcasted on a
1874 // previous version of LDK or the counterparty hadn't met dust.
1877 found_commitment_tx = true;
1878 } else if txid == us.current_holder_commitment_tx.txid {
1879 walk_htlcs!(true, false, us.current_holder_commitment_tx.htlc_outputs.iter().map(|(a, _, _)| a));
1880 if let Some(conf_thresh) = pending_commitment_tx_conf_thresh {
1881 res.push(Balance::ClaimableAwaitingConfirmations {
1882 claimable_amount_satoshis: us.current_holder_commitment_tx.to_self_value_sat,
1883 confirmation_height: conf_thresh,
1886 found_commitment_tx = true;
1887 } else if let Some(prev_commitment) = &us.prev_holder_signed_commitment_tx {
1888 if txid == prev_commitment.txid {
1889 walk_htlcs!(true, false, prev_commitment.htlc_outputs.iter().map(|(a, _, _)| a));
1890 if let Some(conf_thresh) = pending_commitment_tx_conf_thresh {
1891 res.push(Balance::ClaimableAwaitingConfirmations {
1892 claimable_amount_satoshis: prev_commitment.to_self_value_sat,
1893 confirmation_height: conf_thresh,
1896 found_commitment_tx = true;
1899 if !found_commitment_tx {
1900 if let Some(conf_thresh) = pending_commitment_tx_conf_thresh {
1901 // We blindly assume this is a cooperative close transaction here, and that
1902 // neither us nor our counterparty misbehaved. At worst we've under-estimated
1903 // the amount we can claim as we'll punish a misbehaving counterparty.
1904 res.push(Balance::ClaimableAwaitingConfirmations {
1905 claimable_amount_satoshis: us.current_holder_commitment_tx.to_self_value_sat,
1906 confirmation_height: conf_thresh,
1911 let mut claimable_inbound_htlc_value_sat = 0;
1912 for (htlc, _, _) in us.current_holder_commitment_tx.htlc_outputs.iter() {
1913 if htlc.transaction_output_index.is_none() { continue; }
1915 res.push(Balance::MaybeTimeoutClaimableHTLC {
1916 claimable_amount_satoshis: htlc.amount_msat / 1000,
1917 claimable_height: htlc.cltv_expiry,
1918 payment_hash: htlc.payment_hash,
1920 } else if us.payment_preimages.get(&htlc.payment_hash).is_some() {
1921 claimable_inbound_htlc_value_sat += htlc.amount_msat / 1000;
1923 // As long as the HTLC is still in our latest commitment state, treat
1924 // it as potentially claimable, even if it has long-since expired.
1925 res.push(Balance::MaybePreimageClaimableHTLC {
1926 claimable_amount_satoshis: htlc.amount_msat / 1000,
1927 expiry_height: htlc.cltv_expiry,
1928 payment_hash: htlc.payment_hash,
1932 res.push(Balance::ClaimableOnChannelClose {
1933 claimable_amount_satoshis: us.current_holder_commitment_tx.to_self_value_sat + claimable_inbound_htlc_value_sat,
1940 /// Gets the set of outbound HTLCs which can be (or have been) resolved by this
1941 /// `ChannelMonitor`. This is used to determine if an HTLC was removed from the channel prior
1942 /// to the `ChannelManager` having been persisted.
1944 /// This is similar to [`Self::get_pending_or_resolved_outbound_htlcs`] except it includes
1945 /// HTLCs which were resolved on-chain (i.e. where the final HTLC resolution was done by an
1946 /// event from this `ChannelMonitor`).
1947 pub(crate) fn get_all_current_outbound_htlcs(&self) -> HashMap<HTLCSource, (HTLCOutputInCommitment, Option<PaymentPreimage>)> {
1948 let mut res = HashMap::new();
1949 // Just examine the available counterparty commitment transactions. See docs on
1950 // `fail_unbroadcast_htlcs`, below, for justification.
1951 let us = self.inner.lock().unwrap();
1952 macro_rules! walk_counterparty_commitment {
1954 if let Some(ref latest_outpoints) = us.counterparty_claimable_outpoints.get($txid) {
1955 for &(ref htlc, ref source_option) in latest_outpoints.iter() {
1956 if let &Some(ref source) = source_option {
1957 res.insert((**source).clone(), (htlc.clone(),
1958 us.counterparty_fulfilled_htlcs.get(&SentHTLCId::from_source(source)).cloned()));
1964 if let Some(ref txid) = us.current_counterparty_commitment_txid {
1965 walk_counterparty_commitment!(txid);
1967 if let Some(ref txid) = us.prev_counterparty_commitment_txid {
1968 walk_counterparty_commitment!(txid);
1973 /// Gets the set of outbound HTLCs which are pending resolution in this channel or which were
1974 /// resolved with a preimage from our counterparty.
1976 /// This is used to reconstruct pending outbound payments on restart in the ChannelManager.
1978 /// Currently, the preimage is unused, however if it is present in the relevant internal state
1979 /// an HTLC is always included even if it has been resolved.
1980 pub(crate) fn get_pending_or_resolved_outbound_htlcs(&self) -> HashMap<HTLCSource, (HTLCOutputInCommitment, Option<PaymentPreimage>)> {
1981 let us = self.inner.lock().unwrap();
1982 // We're only concerned with the confirmation count of HTLC transactions, and don't
1983 // actually care how many confirmations a commitment transaction may or may not have. Thus,
1984 // we look for either a FundingSpendConfirmation event or a funding_spend_confirmed.
1985 let confirmed_txid = us.funding_spend_confirmed.or_else(|| {
1986 us.onchain_events_awaiting_threshold_conf.iter().find_map(|event| {
1987 if let OnchainEvent::FundingSpendConfirmation { .. } = event.event {
1993 if confirmed_txid.is_none() {
1994 // If we have not seen a commitment transaction on-chain (ie the channel is not yet
1995 // closed), just get the full set.
1997 return self.get_all_current_outbound_htlcs();
2000 let mut res = HashMap::new();
2001 macro_rules! walk_htlcs {
2002 ($holder_commitment: expr, $htlc_iter: expr) => {
2003 for (htlc, source) in $htlc_iter {
2004 if us.htlcs_resolved_on_chain.iter().any(|v| v.commitment_tx_output_idx == htlc.transaction_output_index) {
2005 // We should assert that funding_spend_confirmed is_some() here, but we
2006 // have some unit tests which violate HTLC transaction CSVs entirely and
2008 // TODO: Once tests all connect transactions at consensus-valid times, we
2009 // should assert here like we do in `get_claimable_balances`.
2010 } else if htlc.offered == $holder_commitment {
2011 // If the payment was outbound, check if there's an HTLCUpdate
2012 // indicating we have spent this HTLC with a timeout, claiming it back
2013 // and awaiting confirmations on it.
2014 let htlc_update_confd = us.onchain_events_awaiting_threshold_conf.iter().any(|event| {
2015 if let OnchainEvent::HTLCUpdate { commitment_tx_output_idx: Some(commitment_tx_output_idx), .. } = event.event {
2016 // If the HTLC was timed out, we wait for ANTI_REORG_DELAY blocks
2017 // before considering it "no longer pending" - this matches when we
2018 // provide the ChannelManager an HTLC failure event.
2019 Some(commitment_tx_output_idx) == htlc.transaction_output_index &&
2020 us.best_block.height() >= event.height + ANTI_REORG_DELAY - 1
2021 } else if let OnchainEvent::HTLCSpendConfirmation { commitment_tx_output_idx, .. } = event.event {
2022 // If the HTLC was fulfilled with a preimage, we consider the HTLC
2023 // immediately non-pending, matching when we provide ChannelManager
2025 Some(commitment_tx_output_idx) == htlc.transaction_output_index
2028 let counterparty_resolved_preimage_opt =
2029 us.counterparty_fulfilled_htlcs.get(&SentHTLCId::from_source(source)).cloned();
2030 if !htlc_update_confd || counterparty_resolved_preimage_opt.is_some() {
2031 res.insert(source.clone(), (htlc.clone(), counterparty_resolved_preimage_opt));
2038 let txid = confirmed_txid.unwrap();
2039 if Some(txid) == us.current_counterparty_commitment_txid || Some(txid) == us.prev_counterparty_commitment_txid {
2040 walk_htlcs!(false, us.counterparty_claimable_outpoints.get(&txid).unwrap().iter().filter_map(|(a, b)| {
2041 if let &Some(ref source) = b {
2042 Some((a, &**source))
2045 } else if txid == us.current_holder_commitment_tx.txid {
2046 walk_htlcs!(true, us.current_holder_commitment_tx.htlc_outputs.iter().filter_map(|(a, _, c)| {
2047 if let Some(source) = c { Some((a, source)) } else { None }
2049 } else if let Some(prev_commitment) = &us.prev_holder_signed_commitment_tx {
2050 if txid == prev_commitment.txid {
2051 walk_htlcs!(true, prev_commitment.htlc_outputs.iter().filter_map(|(a, _, c)| {
2052 if let Some(source) = c { Some((a, source)) } else { None }
2060 pub(crate) fn get_stored_preimages(&self) -> HashMap<PaymentHash, PaymentPreimage> {
2061 self.inner.lock().unwrap().payment_preimages.clone()
2065 /// Compares a broadcasted commitment transaction's HTLCs with those in the latest state,
2066 /// failing any HTLCs which didn't make it into the broadcasted commitment transaction back
2067 /// after ANTI_REORG_DELAY blocks.
2069 /// We always compare against the set of HTLCs in counterparty commitment transactions, as those
2070 /// are the commitment transactions which are generated by us. The off-chain state machine in
2071 /// `Channel` will automatically resolve any HTLCs which were never included in a commitment
2072 /// transaction when it detects channel closure, but it is up to us to ensure any HTLCs which were
2073 /// included in a remote commitment transaction are failed back if they are not present in the
2074 /// broadcasted commitment transaction.
2076 /// Specifically, the removal process for HTLCs in `Channel` is always based on the counterparty
2077 /// sending a `revoke_and_ack`, which causes us to clear `prev_counterparty_commitment_txid`. Thus,
2078 /// as long as we examine both the current counterparty commitment transaction and, if it hasn't
2079 /// been revoked yet, the previous one, we we will never "forget" to resolve an HTLC.
2080 macro_rules! fail_unbroadcast_htlcs {
2081 ($self: expr, $commitment_tx_type: expr, $commitment_txid_confirmed: expr, $commitment_tx_confirmed: expr,
2082 $commitment_tx_conf_height: expr, $commitment_tx_conf_hash: expr, $confirmed_htlcs_list: expr, $logger: expr) => { {
2083 debug_assert_eq!($commitment_tx_confirmed.txid(), $commitment_txid_confirmed);
2085 macro_rules! check_htlc_fails {
2086 ($txid: expr, $commitment_tx: expr) => {
2087 if let Some(ref latest_outpoints) = $self.counterparty_claimable_outpoints.get($txid) {
2088 for &(ref htlc, ref source_option) in latest_outpoints.iter() {
2089 if let &Some(ref source) = source_option {
2090 // Check if the HTLC is present in the commitment transaction that was
2091 // broadcast, but not if it was below the dust limit, which we should
2092 // fail backwards immediately as there is no way for us to learn the
2093 // payment_preimage.
2094 // Note that if the dust limit were allowed to change between
2095 // commitment transactions we'd want to be check whether *any*
2096 // broadcastable commitment transaction has the HTLC in it, but it
2097 // cannot currently change after channel initialization, so we don't
2099 let confirmed_htlcs_iter: &mut Iterator<Item = (&HTLCOutputInCommitment, Option<&HTLCSource>)> = &mut $confirmed_htlcs_list;
2101 let mut matched_htlc = false;
2102 for (ref broadcast_htlc, ref broadcast_source) in confirmed_htlcs_iter {
2103 if broadcast_htlc.transaction_output_index.is_some() &&
2104 (Some(&**source) == *broadcast_source ||
2105 (broadcast_source.is_none() &&
2106 broadcast_htlc.payment_hash == htlc.payment_hash &&
2107 broadcast_htlc.amount_msat == htlc.amount_msat)) {
2108 matched_htlc = true;
2112 if matched_htlc { continue; }
2113 if $self.counterparty_fulfilled_htlcs.get(&SentHTLCId::from_source(source)).is_some() {
2116 $self.onchain_events_awaiting_threshold_conf.retain(|ref entry| {
2117 if entry.height != $commitment_tx_conf_height { return true; }
2119 OnchainEvent::HTLCUpdate { source: ref update_source, .. } => {
2120 *update_source != **source
2125 let entry = OnchainEventEntry {
2126 txid: $commitment_txid_confirmed,
2127 transaction: Some($commitment_tx_confirmed.clone()),
2128 height: $commitment_tx_conf_height,
2129 block_hash: Some(*$commitment_tx_conf_hash),
2130 event: OnchainEvent::HTLCUpdate {
2131 source: (**source).clone(),
2132 payment_hash: htlc.payment_hash.clone(),
2133 htlc_value_satoshis: Some(htlc.amount_msat / 1000),
2134 commitment_tx_output_idx: None,
2137 log_trace!($logger, "Failing HTLC with payment_hash {} from {} counterparty commitment tx due to broadcast of {} commitment transaction {}, waiting for confirmation (at height {})",
2138 log_bytes!(htlc.payment_hash.0), $commitment_tx, $commitment_tx_type,
2139 $commitment_txid_confirmed, entry.confirmation_threshold());
2140 $self.onchain_events_awaiting_threshold_conf.push(entry);
2146 if let Some(ref txid) = $self.current_counterparty_commitment_txid {
2147 check_htlc_fails!(txid, "current");
2149 if let Some(ref txid) = $self.prev_counterparty_commitment_txid {
2150 check_htlc_fails!(txid, "previous");
2155 // In the `test_invalid_funding_tx` test, we need a bogus script which matches the HTLC-Accepted
2156 // witness length match (ie is 136 bytes long). We generate one here which we also use in some
2157 // in-line tests later.
2160 pub fn deliberately_bogus_accepted_htlc_witness_program() -> Vec<u8> {
2161 let mut ret = [opcodes::all::OP_NOP.to_u8(); 136];
2162 ret[131] = opcodes::all::OP_DROP.to_u8();
2163 ret[132] = opcodes::all::OP_DROP.to_u8();
2164 ret[133] = opcodes::all::OP_DROP.to_u8();
2165 ret[134] = opcodes::all::OP_DROP.to_u8();
2166 ret[135] = opcodes::OP_TRUE.to_u8();
2171 pub fn deliberately_bogus_accepted_htlc_witness() -> Vec<Vec<u8>> {
2172 vec![Vec::new(), Vec::new(), Vec::new(), Vec::new(), deliberately_bogus_accepted_htlc_witness_program().into()].into()
2175 impl<Signer: WriteableEcdsaChannelSigner> ChannelMonitorImpl<Signer> {
2176 /// Inserts a revocation secret into this channel monitor. Prunes old preimages if neither
2177 /// needed by holder commitment transactions HTCLs nor by counterparty ones. Unless we haven't already seen
2178 /// counterparty commitment transaction's secret, they are de facto pruned (we can use revocation key).
2179 fn provide_secret(&mut self, idx: u64, secret: [u8; 32]) -> Result<(), &'static str> {
2180 if let Err(()) = self.commitment_secrets.provide_secret(idx, secret) {
2181 return Err("Previous secret did not match new one");
2184 // Prune HTLCs from the previous counterparty commitment tx so we don't generate failure/fulfill
2185 // events for now-revoked/fulfilled HTLCs.
2186 if let Some(txid) = self.prev_counterparty_commitment_txid.take() {
2187 if self.current_counterparty_commitment_txid.unwrap() != txid {
2188 let cur_claimables = self.counterparty_claimable_outpoints.get(
2189 &self.current_counterparty_commitment_txid.unwrap()).unwrap();
2190 for (_, ref source_opt) in self.counterparty_claimable_outpoints.get(&txid).unwrap() {
2191 if let Some(source) = source_opt {
2192 if !cur_claimables.iter()
2193 .any(|(_, cur_source_opt)| cur_source_opt == source_opt)
2195 self.counterparty_fulfilled_htlcs.remove(&SentHTLCId::from_source(source));
2199 for &mut (_, ref mut source_opt) in self.counterparty_claimable_outpoints.get_mut(&txid).unwrap() {
2203 assert!(cfg!(fuzzing), "Commitment txids are unique outside of fuzzing, where hashes can collide");
2207 if !self.payment_preimages.is_empty() {
2208 let cur_holder_signed_commitment_tx = &self.current_holder_commitment_tx;
2209 let prev_holder_signed_commitment_tx = self.prev_holder_signed_commitment_tx.as_ref();
2210 let min_idx = self.get_min_seen_secret();
2211 let counterparty_hash_commitment_number = &mut self.counterparty_hash_commitment_number;
2213 self.payment_preimages.retain(|&k, _| {
2214 for &(ref htlc, _, _) in cur_holder_signed_commitment_tx.htlc_outputs.iter() {
2215 if k == htlc.payment_hash {
2219 if let Some(prev_holder_commitment_tx) = prev_holder_signed_commitment_tx {
2220 for &(ref htlc, _, _) in prev_holder_commitment_tx.htlc_outputs.iter() {
2221 if k == htlc.payment_hash {
2226 let contains = if let Some(cn) = counterparty_hash_commitment_number.get(&k) {
2233 counterparty_hash_commitment_number.remove(&k);
2242 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 {
2243 // TODO: Encrypt the htlc_outputs data with the single-hash of the commitment transaction
2244 // so that a remote monitor doesn't learn anything unless there is a malicious close.
2245 // (only maybe, sadly we cant do the same for local info, as we need to be aware of
2247 for &(ref htlc, _) in &htlc_outputs {
2248 self.counterparty_hash_commitment_number.insert(htlc.payment_hash, commitment_number);
2251 log_trace!(logger, "Tracking new counterparty commitment transaction with txid {} at commitment number {} with {} HTLC outputs", txid, commitment_number, htlc_outputs.len());
2252 self.prev_counterparty_commitment_txid = self.current_counterparty_commitment_txid.take();
2253 self.current_counterparty_commitment_txid = Some(txid);
2254 self.counterparty_claimable_outpoints.insert(txid, htlc_outputs.clone());
2255 self.current_counterparty_commitment_number = commitment_number;
2256 //TODO: Merge this into the other per-counterparty-transaction output storage stuff
2257 match self.their_cur_per_commitment_points {
2258 Some(old_points) => {
2259 if old_points.0 == commitment_number + 1 {
2260 self.their_cur_per_commitment_points = Some((old_points.0, old_points.1, Some(their_per_commitment_point)));
2261 } else if old_points.0 == commitment_number + 2 {
2262 if let Some(old_second_point) = old_points.2 {
2263 self.their_cur_per_commitment_points = Some((old_points.0 - 1, old_second_point, Some(their_per_commitment_point)));
2265 self.their_cur_per_commitment_points = Some((commitment_number, their_per_commitment_point, None));
2268 self.their_cur_per_commitment_points = Some((commitment_number, their_per_commitment_point, None));
2272 self.their_cur_per_commitment_points = Some((commitment_number, their_per_commitment_point, None));
2275 let mut htlcs = Vec::with_capacity(htlc_outputs.len());
2276 for htlc in htlc_outputs {
2277 if htlc.0.transaction_output_index.is_some() {
2283 /// Informs this monitor of the latest holder (ie broadcastable) commitment transaction. The
2284 /// monitor watches for timeouts and may broadcast it if we approach such a timeout. Thus, it
2285 /// is important that any clones of this channel monitor (including remote clones) by kept
2286 /// up-to-date as our holder commitment transaction is updated.
2287 /// Panics if set_on_holder_tx_csv has never been called.
2288 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> {
2289 if htlc_outputs.iter().any(|(_, s, _)| s.is_some()) {
2290 // If we have non-dust HTLCs in htlc_outputs, ensure they match the HTLCs in the
2291 // `holder_commitment_tx`. In the future, we'll no longer provide the redundant data
2292 // and just pass in source data via `nondust_htlc_sources`.
2293 debug_assert_eq!(htlc_outputs.iter().filter(|(_, s, _)| s.is_some()).count(), holder_commitment_tx.trust().htlcs().len());
2294 for (a, b) in htlc_outputs.iter().filter(|(_, s, _)| s.is_some()).map(|(h, _, _)| h).zip(holder_commitment_tx.trust().htlcs().iter()) {
2295 debug_assert_eq!(a, b);
2297 debug_assert_eq!(htlc_outputs.iter().filter(|(_, s, _)| s.is_some()).count(), holder_commitment_tx.counterparty_htlc_sigs.len());
2298 for (a, b) in htlc_outputs.iter().filter_map(|(_, s, _)| s.as_ref()).zip(holder_commitment_tx.counterparty_htlc_sigs.iter()) {
2299 debug_assert_eq!(a, b);
2301 debug_assert!(nondust_htlc_sources.is_empty());
2303 // If we don't have any non-dust HTLCs in htlc_outputs, assume they were all passed via
2304 // `nondust_htlc_sources`, building up the final htlc_outputs by combining
2305 // `nondust_htlc_sources` and the `holder_commitment_tx`
2306 #[cfg(debug_assertions)] {
2308 for htlc in holder_commitment_tx.trust().htlcs().iter() {
2309 assert!(htlc.transaction_output_index.unwrap() as i32 > prev);
2310 prev = htlc.transaction_output_index.unwrap() as i32;
2313 debug_assert!(htlc_outputs.iter().all(|(htlc, _, _)| htlc.transaction_output_index.is_none()));
2314 debug_assert!(htlc_outputs.iter().all(|(_, sig_opt, _)| sig_opt.is_none()));
2315 debug_assert_eq!(holder_commitment_tx.trust().htlcs().len(), holder_commitment_tx.counterparty_htlc_sigs.len());
2317 let mut sources_iter = nondust_htlc_sources.into_iter();
2319 for (htlc, counterparty_sig) in holder_commitment_tx.trust().htlcs().iter()
2320 .zip(holder_commitment_tx.counterparty_htlc_sigs.iter())
2323 let source = sources_iter.next().expect("Non-dust HTLC sources didn't match commitment tx");
2324 #[cfg(debug_assertions)] {
2325 assert!(source.possibly_matches_output(htlc));
2327 htlc_outputs.push((htlc.clone(), Some(counterparty_sig.clone()), Some(source)));
2329 htlc_outputs.push((htlc.clone(), Some(counterparty_sig.clone()), None));
2332 debug_assert!(sources_iter.next().is_none());
2335 let trusted_tx = holder_commitment_tx.trust();
2336 let txid = trusted_tx.txid();
2337 let tx_keys = trusted_tx.keys();
2338 self.current_holder_commitment_number = trusted_tx.commitment_number();
2339 let mut new_holder_commitment_tx = HolderSignedTx {
2341 revocation_key: tx_keys.revocation_key,
2342 a_htlc_key: tx_keys.broadcaster_htlc_key,
2343 b_htlc_key: tx_keys.countersignatory_htlc_key,
2344 delayed_payment_key: tx_keys.broadcaster_delayed_payment_key,
2345 per_commitment_point: tx_keys.per_commitment_point,
2347 to_self_value_sat: holder_commitment_tx.to_broadcaster_value_sat(),
2348 feerate_per_kw: trusted_tx.feerate_per_kw(),
2350 self.onchain_tx_handler.provide_latest_holder_tx(holder_commitment_tx);
2351 mem::swap(&mut new_holder_commitment_tx, &mut self.current_holder_commitment_tx);
2352 self.prev_holder_signed_commitment_tx = Some(new_holder_commitment_tx);
2353 for (claimed_htlc_id, claimed_preimage) in claimed_htlcs {
2354 #[cfg(debug_assertions)] {
2355 let cur_counterparty_htlcs = self.counterparty_claimable_outpoints.get(
2356 &self.current_counterparty_commitment_txid.unwrap()).unwrap();
2357 assert!(cur_counterparty_htlcs.iter().any(|(_, source_opt)| {
2358 if let Some(source) = source_opt {
2359 SentHTLCId::from_source(source) == *claimed_htlc_id
2363 self.counterparty_fulfilled_htlcs.insert(*claimed_htlc_id, *claimed_preimage);
2365 if self.holder_tx_signed {
2366 return Err("Latest holder commitment signed has already been signed, update is rejected");
2371 /// Provides a payment_hash->payment_preimage mapping. Will be automatically pruned when all
2372 /// commitment_tx_infos which contain the payment hash have been revoked.
2373 fn provide_payment_preimage<B: Deref, F: Deref, L: Deref>(
2374 &mut self, payment_hash: &PaymentHash, payment_preimage: &PaymentPreimage, broadcaster: &B,
2375 fee_estimator: &LowerBoundedFeeEstimator<F>, logger: &L)
2376 where B::Target: BroadcasterInterface,
2377 F::Target: FeeEstimator,
2380 self.payment_preimages.insert(payment_hash.clone(), payment_preimage.clone());
2382 // If the channel is force closed, try to claim the output from this preimage.
2383 // First check if a counterparty commitment transaction has been broadcasted:
2384 macro_rules! claim_htlcs {
2385 ($commitment_number: expr, $txid: expr) => {
2386 let (htlc_claim_reqs, _) = self.get_counterparty_output_claim_info($commitment_number, $txid, None);
2387 self.onchain_tx_handler.update_claims_view_from_requests(htlc_claim_reqs, self.best_block.height(), self.best_block.height(), broadcaster, fee_estimator, logger);
2390 if let Some(txid) = self.current_counterparty_commitment_txid {
2391 if let Some(commitment_number) = self.counterparty_commitment_txn_on_chain.get(&txid) {
2392 claim_htlcs!(*commitment_number, txid);
2396 if let Some(txid) = self.prev_counterparty_commitment_txid {
2397 if let Some(commitment_number) = self.counterparty_commitment_txn_on_chain.get(&txid) {
2398 claim_htlcs!(*commitment_number, txid);
2403 // Then if a holder commitment transaction has been seen on-chain, broadcast transactions
2404 // claiming the HTLC output from each of the holder commitment transactions.
2405 // Note that we can't just use `self.holder_tx_signed`, because that only covers the case where
2406 // *we* sign a holder commitment transaction, not when e.g. a watchtower broadcasts one of our
2407 // holder commitment transactions.
2408 if self.broadcasted_holder_revokable_script.is_some() {
2409 // Assume that the broadcasted commitment transaction confirmed in the current best
2410 // block. Even if not, its a reasonable metric for the bump criteria on the HTLC
2412 let (claim_reqs, _) = self.get_broadcasted_holder_claims(&self.current_holder_commitment_tx, self.best_block.height());
2413 self.onchain_tx_handler.update_claims_view_from_requests(claim_reqs, self.best_block.height(), self.best_block.height(), broadcaster, fee_estimator, logger);
2414 if let Some(ref tx) = self.prev_holder_signed_commitment_tx {
2415 let (claim_reqs, _) = self.get_broadcasted_holder_claims(&tx, self.best_block.height());
2416 self.onchain_tx_handler.update_claims_view_from_requests(claim_reqs, self.best_block.height(), self.best_block.height(), broadcaster, fee_estimator, logger);
2421 pub(crate) fn broadcast_latest_holder_commitment_txn<B: Deref, L: Deref>(&mut self, broadcaster: &B, logger: &L)
2422 where B::Target: BroadcasterInterface,
2425 let commit_txs = self.get_latest_holder_commitment_txn(logger);
2426 let mut txs = vec![];
2427 for tx in commit_txs.iter() {
2428 log_info!(logger, "Broadcasting local {}", log_tx!(tx));
2431 broadcaster.broadcast_transactions(&txs);
2432 self.pending_monitor_events.push(MonitorEvent::CommitmentTxConfirmed(self.funding_info.0));
2435 pub fn update_monitor<B: Deref, F: Deref, L: Deref>(&mut self, updates: &ChannelMonitorUpdate, broadcaster: &B, fee_estimator: F, logger: &L) -> Result<(), ()>
2436 where B::Target: BroadcasterInterface,
2437 F::Target: FeeEstimator,
2440 if self.latest_update_id == CLOSED_CHANNEL_UPDATE_ID && updates.update_id == CLOSED_CHANNEL_UPDATE_ID {
2441 log_info!(logger, "Applying post-force-closed update to monitor {} with {} change(s).",
2442 log_funding_info!(self), updates.updates.len());
2443 } else if updates.update_id == CLOSED_CHANNEL_UPDATE_ID {
2444 log_info!(logger, "Applying force close update to monitor {} with {} change(s).",
2445 log_funding_info!(self), updates.updates.len());
2447 log_info!(logger, "Applying update to monitor {}, bringing update_id from {} to {} with {} change(s).",
2448 log_funding_info!(self), self.latest_update_id, updates.update_id, updates.updates.len());
2450 // ChannelMonitor updates may be applied after force close if we receive a preimage for a
2451 // broadcasted commitment transaction HTLC output that we'd like to claim on-chain. If this
2452 // is the case, we no longer have guaranteed access to the monitor's update ID, so we use a
2453 // sentinel value instead.
2455 // The `ChannelManager` may also queue redundant `ChannelForceClosed` updates if it still
2456 // thinks the channel needs to have its commitment transaction broadcast, so we'll allow
2458 if updates.update_id == CLOSED_CHANNEL_UPDATE_ID {
2459 assert_eq!(updates.updates.len(), 1);
2460 match updates.updates[0] {
2461 ChannelMonitorUpdateStep::ChannelForceClosed { .. } => {},
2462 // We should have already seen a `ChannelForceClosed` update if we're trying to
2463 // provide a preimage at this point.
2464 ChannelMonitorUpdateStep::PaymentPreimage { .. } =>
2465 debug_assert_eq!(self.latest_update_id, CLOSED_CHANNEL_UPDATE_ID),
2467 log_error!(logger, "Attempted to apply post-force-close ChannelMonitorUpdate of type {}", updates.updates[0].variant_name());
2468 panic!("Attempted to apply post-force-close ChannelMonitorUpdate that wasn't providing a payment preimage");
2471 } else if self.latest_update_id + 1 != updates.update_id {
2472 panic!("Attempted to apply ChannelMonitorUpdates out of order, check the update_id before passing an update to update_monitor!");
2474 let mut ret = Ok(());
2475 let bounded_fee_estimator = LowerBoundedFeeEstimator::new(&*fee_estimator);
2476 for update in updates.updates.iter() {
2478 ChannelMonitorUpdateStep::LatestHolderCommitmentTXInfo { commitment_tx, htlc_outputs, claimed_htlcs, nondust_htlc_sources } => {
2479 log_trace!(logger, "Updating ChannelMonitor with latest holder commitment transaction info");
2480 if self.lockdown_from_offchain { panic!(); }
2481 if let Err(e) = self.provide_latest_holder_commitment_tx(commitment_tx.clone(), htlc_outputs.clone(), &claimed_htlcs, nondust_htlc_sources.clone()) {
2482 log_error!(logger, "Providing latest holder commitment transaction failed/was refused:");
2483 log_error!(logger, " {}", e);
2487 ChannelMonitorUpdateStep::LatestCounterpartyCommitmentTXInfo { commitment_txid, htlc_outputs, commitment_number, their_per_commitment_point } => {
2488 log_trace!(logger, "Updating ChannelMonitor with latest counterparty commitment transaction info");
2489 self.provide_latest_counterparty_commitment_tx(*commitment_txid, htlc_outputs.clone(), *commitment_number, *their_per_commitment_point, logger)
2491 ChannelMonitorUpdateStep::PaymentPreimage { payment_preimage } => {
2492 log_trace!(logger, "Updating ChannelMonitor with payment preimage");
2493 self.provide_payment_preimage(&PaymentHash(Sha256::hash(&payment_preimage.0[..]).into_inner()), &payment_preimage, broadcaster, &bounded_fee_estimator, logger)
2495 ChannelMonitorUpdateStep::CommitmentSecret { idx, secret } => {
2496 log_trace!(logger, "Updating ChannelMonitor with commitment secret");
2497 if let Err(e) = self.provide_secret(*idx, *secret) {
2498 log_error!(logger, "Providing latest counterparty commitment secret failed/was refused:");
2499 log_error!(logger, " {}", e);
2503 ChannelMonitorUpdateStep::ChannelForceClosed { should_broadcast } => {
2504 log_trace!(logger, "Updating ChannelMonitor: channel force closed, should broadcast: {}", should_broadcast);
2505 self.lockdown_from_offchain = true;
2506 if *should_broadcast {
2507 // There's no need to broadcast our commitment transaction if we've seen one
2508 // confirmed (even with 1 confirmation) as it'll be rejected as
2509 // duplicate/conflicting.
2510 let detected_funding_spend = self.funding_spend_confirmed.is_some() ||
2511 self.onchain_events_awaiting_threshold_conf.iter().find(|event| match event.event {
2512 OnchainEvent::FundingSpendConfirmation { .. } => true,
2515 if detected_funding_spend {
2516 log_trace!(logger, "Avoiding commitment broadcast, already detected confirmed spend onchain");
2519 self.broadcast_latest_holder_commitment_txn(broadcaster, logger);
2520 // If the channel supports anchor outputs, we'll need to emit an external
2521 // event to be consumed such that a child transaction is broadcast with a
2522 // high enough feerate for the parent commitment transaction to confirm.
2523 if self.onchain_tx_handler.channel_type_features().supports_anchors_zero_fee_htlc_tx() {
2524 let funding_output = HolderFundingOutput::build(
2525 self.funding_redeemscript.clone(), self.channel_value_satoshis,
2526 self.onchain_tx_handler.channel_type_features().clone(),
2528 let best_block_height = self.best_block.height();
2529 let commitment_package = PackageTemplate::build_package(
2530 self.funding_info.0.txid.clone(), self.funding_info.0.index as u32,
2531 PackageSolvingData::HolderFundingOutput(funding_output),
2532 best_block_height, best_block_height
2534 self.onchain_tx_handler.update_claims_view_from_requests(
2535 vec![commitment_package], best_block_height, best_block_height,
2536 broadcaster, &bounded_fee_estimator, logger,
2539 } else if !self.holder_tx_signed {
2540 log_error!(logger, "WARNING: You have a potentially-unsafe holder commitment transaction available to broadcast");
2541 log_error!(logger, " in channel monitor for channel {}!", log_bytes!(self.funding_info.0.to_channel_id()));
2542 log_error!(logger, " Read the docs for ChannelMonitor::get_latest_holder_commitment_txn and take manual action!");
2544 // If we generated a MonitorEvent::CommitmentTxConfirmed, the ChannelManager
2545 // will still give us a ChannelForceClosed event with !should_broadcast, but we
2546 // shouldn't print the scary warning above.
2547 log_info!(logger, "Channel off-chain state closed after we broadcasted our latest commitment transaction.");
2550 ChannelMonitorUpdateStep::ShutdownScript { scriptpubkey } => {
2551 log_trace!(logger, "Updating ChannelMonitor with shutdown script");
2552 if let Some(shutdown_script) = self.shutdown_script.replace(scriptpubkey.clone()) {
2553 panic!("Attempted to replace shutdown script {} with {}", shutdown_script, scriptpubkey);
2559 // If the updates succeeded and we were in an already closed channel state, then there's no
2560 // need to refuse any updates we expect to receive afer seeing a confirmed commitment.
2561 if ret.is_ok() && updates.update_id == CLOSED_CHANNEL_UPDATE_ID && self.latest_update_id == updates.update_id {
2565 self.latest_update_id = updates.update_id;
2567 // Refuse updates after we've detected a spend onchain, but only if we haven't processed a
2568 // force closed monitor update yet.
2569 if ret.is_ok() && self.funding_spend_seen && self.latest_update_id != CLOSED_CHANNEL_UPDATE_ID {
2570 log_error!(logger, "Refusing Channel Monitor Update as counterparty attempted to update commitment after funding was spent");
2575 pub fn get_latest_update_id(&self) -> u64 {
2576 self.latest_update_id
2579 pub fn get_funding_txo(&self) -> &(OutPoint, Script) {
2583 pub fn get_outputs_to_watch(&self) -> &HashMap<Txid, Vec<(u32, Script)>> {
2584 // If we've detected a counterparty commitment tx on chain, we must include it in the set
2585 // of outputs to watch for spends of, otherwise we're likely to lose user funds. Because
2586 // its trivial to do, double-check that here.
2587 for (txid, _) in self.counterparty_commitment_txn_on_chain.iter() {
2588 self.outputs_to_watch.get(txid).expect("Counterparty commitment txn which have been broadcast should have outputs registered");
2590 &self.outputs_to_watch
2593 pub fn get_and_clear_pending_monitor_events(&mut self) -> Vec<MonitorEvent> {
2594 let mut ret = Vec::new();
2595 mem::swap(&mut ret, &mut self.pending_monitor_events);
2599 /// Gets the set of events that are repeated regularly (e.g. those which RBF bump
2600 /// transactions). We're okay if we lose these on restart as they'll be regenerated for us at
2601 /// some regular interval via [`ChannelMonitor::rebroadcast_pending_claims`].
2602 pub(super) fn get_repeated_events(&mut self) -> Vec<Event> {
2603 let pending_claim_events = self.onchain_tx_handler.get_and_clear_pending_claim_events();
2604 let mut ret = Vec::with_capacity(pending_claim_events.len());
2605 for (claim_id, claim_event) in pending_claim_events {
2607 ClaimEvent::BumpCommitment {
2608 package_target_feerate_sat_per_1000_weight, commitment_tx, anchor_output_idx,
2610 let commitment_txid = commitment_tx.txid();
2611 debug_assert_eq!(self.current_holder_commitment_tx.txid, commitment_txid);
2612 let pending_htlcs = self.current_holder_commitment_tx.non_dust_htlcs();
2613 let commitment_tx_fee_satoshis = self.channel_value_satoshis -
2614 commitment_tx.output.iter().fold(0u64, |sum, output| sum + output.value);
2615 ret.push(Event::BumpTransaction(BumpTransactionEvent::ChannelClose {
2617 package_target_feerate_sat_per_1000_weight,
2619 commitment_tx_fee_satoshis,
2620 anchor_descriptor: AnchorDescriptor {
2621 channel_derivation_parameters: ChannelDerivationParameters {
2622 keys_id: self.channel_keys_id,
2623 value_satoshis: self.channel_value_satoshis,
2624 transaction_parameters: self.onchain_tx_handler.channel_transaction_parameters.clone(),
2626 outpoint: BitcoinOutPoint {
2627 txid: commitment_txid,
2628 vout: anchor_output_idx,
2634 ClaimEvent::BumpHTLC {
2635 target_feerate_sat_per_1000_weight, htlcs, tx_lock_time,
2637 let mut htlc_descriptors = Vec::with_capacity(htlcs.len());
2639 htlc_descriptors.push(HTLCDescriptor {
2640 channel_derivation_parameters: ChannelDerivationParameters {
2641 keys_id: self.channel_keys_id,
2642 value_satoshis: self.channel_value_satoshis,
2643 transaction_parameters: self.onchain_tx_handler.channel_transaction_parameters.clone(),
2645 commitment_txid: htlc.commitment_txid,
2646 per_commitment_number: htlc.per_commitment_number,
2647 per_commitment_point: self.onchain_tx_handler.signer.get_per_commitment_point(
2648 htlc.per_commitment_number, &self.onchain_tx_handler.secp_ctx,
2651 preimage: htlc.preimage,
2652 counterparty_sig: htlc.counterparty_sig,
2655 ret.push(Event::BumpTransaction(BumpTransactionEvent::HTLCResolution {
2657 target_feerate_sat_per_1000_weight,
2667 /// Can only fail if idx is < get_min_seen_secret
2668 fn get_secret(&self, idx: u64) -> Option<[u8; 32]> {
2669 self.commitment_secrets.get_secret(idx)
2672 pub(crate) fn get_min_seen_secret(&self) -> u64 {
2673 self.commitment_secrets.get_min_seen_secret()
2676 pub(crate) fn get_cur_counterparty_commitment_number(&self) -> u64 {
2677 self.current_counterparty_commitment_number
2680 pub(crate) fn get_cur_holder_commitment_number(&self) -> u64 {
2681 self.current_holder_commitment_number
2684 /// Attempts to claim a counterparty commitment transaction's outputs using the revocation key and
2685 /// data in counterparty_claimable_outpoints. Will directly claim any HTLC outputs which expire at a
2686 /// height > height + CLTV_SHARED_CLAIM_BUFFER. In any case, will install monitoring for
2687 /// HTLC-Success/HTLC-Timeout transactions.
2689 /// Returns packages to claim the revoked output(s), as well as additional outputs to watch and
2690 /// general information about the output that is to the counterparty in the commitment
2692 fn check_spend_counterparty_transaction<L: Deref>(&mut self, tx: &Transaction, height: u32, block_hash: &BlockHash, logger: &L)
2693 -> (Vec<PackageTemplate>, TransactionOutputs, CommitmentTxCounterpartyOutputInfo)
2694 where L::Target: Logger {
2695 // Most secp and related errors trying to create keys means we have no hope of constructing
2696 // a spend transaction...so we return no transactions to broadcast
2697 let mut claimable_outpoints = Vec::new();
2698 let mut watch_outputs = Vec::new();
2699 let mut to_counterparty_output_info = None;
2701 let commitment_txid = tx.txid(); //TODO: This is gonna be a performance bottleneck for watchtowers!
2702 let per_commitment_option = self.counterparty_claimable_outpoints.get(&commitment_txid);
2704 macro_rules! ignore_error {
2705 ( $thing : expr ) => {
2708 Err(_) => return (claimable_outpoints, (commitment_txid, watch_outputs), to_counterparty_output_info)
2713 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);
2714 if commitment_number >= self.get_min_seen_secret() {
2715 let secret = self.get_secret(commitment_number).unwrap();
2716 let per_commitment_key = ignore_error!(SecretKey::from_slice(&secret));
2717 let per_commitment_point = PublicKey::from_secret_key(&self.onchain_tx_handler.secp_ctx, &per_commitment_key);
2718 let revocation_pubkey = chan_utils::derive_public_revocation_key(&self.onchain_tx_handler.secp_ctx, &per_commitment_point, &self.holder_revocation_basepoint);
2719 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);
2721 let revokeable_redeemscript = chan_utils::get_revokeable_redeemscript(&revocation_pubkey, self.counterparty_commitment_params.on_counterparty_tx_csv, &delayed_key);
2722 let revokeable_p2wsh = revokeable_redeemscript.to_v0_p2wsh();
2724 // First, process non-htlc outputs (to_holder & to_counterparty)
2725 for (idx, outp) in tx.output.iter().enumerate() {
2726 if outp.script_pubkey == revokeable_p2wsh {
2727 let revk_outp = RevokedOutput::build(per_commitment_point, self.counterparty_commitment_params.counterparty_delayed_payment_base_key, self.counterparty_commitment_params.counterparty_htlc_base_key, per_commitment_key, outp.value, self.counterparty_commitment_params.on_counterparty_tx_csv, self.onchain_tx_handler.channel_type_features().supports_anchors_zero_fee_htlc_tx());
2728 let justice_package = PackageTemplate::build_package(commitment_txid, idx as u32, PackageSolvingData::RevokedOutput(revk_outp), height + self.counterparty_commitment_params.on_counterparty_tx_csv as u32, height);
2729 claimable_outpoints.push(justice_package);
2730 to_counterparty_output_info =
2731 Some((idx.try_into().expect("Txn can't have more than 2^32 outputs"), outp.value));
2735 // Then, try to find revoked htlc outputs
2736 if let Some(ref per_commitment_data) = per_commitment_option {
2737 for (_, &(ref htlc, _)) in per_commitment_data.iter().enumerate() {
2738 if let Some(transaction_output_index) = htlc.transaction_output_index {
2739 if transaction_output_index as usize >= tx.output.len() ||
2740 tx.output[transaction_output_index as usize].value != htlc.amount_msat / 1000 {
2741 // per_commitment_data is corrupt or our commitment signing key leaked!
2742 return (claimable_outpoints, (commitment_txid, watch_outputs),
2743 to_counterparty_output_info);
2745 let revk_htlc_outp = RevokedHTLCOutput::build(per_commitment_point, self.counterparty_commitment_params.counterparty_delayed_payment_base_key, self.counterparty_commitment_params.counterparty_htlc_base_key, per_commitment_key, htlc.amount_msat / 1000, htlc.clone(), &self.onchain_tx_handler.channel_transaction_parameters.channel_type_features);
2746 let justice_package = PackageTemplate::build_package(commitment_txid, transaction_output_index, PackageSolvingData::RevokedHTLCOutput(revk_htlc_outp), htlc.cltv_expiry, height);
2747 claimable_outpoints.push(justice_package);
2752 // Last, track onchain revoked commitment transaction and fail backward outgoing HTLCs as payment path is broken
2753 if !claimable_outpoints.is_empty() || per_commitment_option.is_some() { // ie we're confident this is actually ours
2754 // We're definitely a counterparty commitment transaction!
2755 log_error!(logger, "Got broadcast of revoked counterparty commitment transaction, going to generate general spend tx with {} inputs", claimable_outpoints.len());
2756 for (idx, outp) in tx.output.iter().enumerate() {
2757 watch_outputs.push((idx as u32, outp.clone()));
2759 self.counterparty_commitment_txn_on_chain.insert(commitment_txid, commitment_number);
2761 if let Some(per_commitment_data) = per_commitment_option {
2762 fail_unbroadcast_htlcs!(self, "revoked_counterparty", commitment_txid, tx, height,
2763 block_hash, per_commitment_data.iter().map(|(htlc, htlc_source)|
2764 (htlc, htlc_source.as_ref().map(|htlc_source| htlc_source.as_ref()))
2767 debug_assert!(false, "We should have per-commitment option for any recognized old commitment txn");
2768 fail_unbroadcast_htlcs!(self, "revoked counterparty", commitment_txid, tx, height,
2769 block_hash, [].iter().map(|reference| *reference), logger);
2772 } else if let Some(per_commitment_data) = per_commitment_option {
2773 // While this isn't useful yet, there is a potential race where if a counterparty
2774 // revokes a state at the same time as the commitment transaction for that state is
2775 // confirmed, and the watchtower receives the block before the user, the user could
2776 // upload a new ChannelMonitor with the revocation secret but the watchtower has
2777 // already processed the block, resulting in the counterparty_commitment_txn_on_chain entry
2778 // not being generated by the above conditional. Thus, to be safe, we go ahead and
2780 for (idx, outp) in tx.output.iter().enumerate() {
2781 watch_outputs.push((idx as u32, outp.clone()));
2783 self.counterparty_commitment_txn_on_chain.insert(commitment_txid, commitment_number);
2785 log_info!(logger, "Got broadcast of non-revoked counterparty commitment transaction {}", commitment_txid);
2786 fail_unbroadcast_htlcs!(self, "counterparty", commitment_txid, tx, height, block_hash,
2787 per_commitment_data.iter().map(|(htlc, htlc_source)|
2788 (htlc, htlc_source.as_ref().map(|htlc_source| htlc_source.as_ref()))
2791 let (htlc_claim_reqs, counterparty_output_info) =
2792 self.get_counterparty_output_claim_info(commitment_number, commitment_txid, Some(tx));
2793 to_counterparty_output_info = counterparty_output_info;
2794 for req in htlc_claim_reqs {
2795 claimable_outpoints.push(req);
2799 (claimable_outpoints, (commitment_txid, watch_outputs), to_counterparty_output_info)
2802 /// Returns the HTLC claim package templates and the counterparty output info
2803 fn get_counterparty_output_claim_info(&self, commitment_number: u64, commitment_txid: Txid, tx: Option<&Transaction>)
2804 -> (Vec<PackageTemplate>, CommitmentTxCounterpartyOutputInfo) {
2805 let mut claimable_outpoints = Vec::new();
2806 let mut to_counterparty_output_info: CommitmentTxCounterpartyOutputInfo = None;
2808 let htlc_outputs = match self.counterparty_claimable_outpoints.get(&commitment_txid) {
2809 Some(outputs) => outputs,
2810 None => return (claimable_outpoints, to_counterparty_output_info),
2812 let per_commitment_points = match self.their_cur_per_commitment_points {
2813 Some(points) => points,
2814 None => return (claimable_outpoints, to_counterparty_output_info),
2817 let per_commitment_point =
2818 // If the counterparty commitment tx is the latest valid state, use their latest
2819 // per-commitment point
2820 if per_commitment_points.0 == commitment_number { &per_commitment_points.1 }
2821 else if let Some(point) = per_commitment_points.2.as_ref() {
2822 // If counterparty commitment tx is the state previous to the latest valid state, use
2823 // their previous per-commitment point (non-atomicity of revocation means it's valid for
2824 // them to temporarily have two valid commitment txns from our viewpoint)
2825 if per_commitment_points.0 == commitment_number + 1 {
2827 } else { return (claimable_outpoints, to_counterparty_output_info); }
2828 } else { return (claimable_outpoints, to_counterparty_output_info); };
2830 if let Some(transaction) = tx {
2831 let revocation_pubkey = chan_utils::derive_public_revocation_key(
2832 &self.onchain_tx_handler.secp_ctx, &per_commitment_point, &self.holder_revocation_basepoint);
2833 let delayed_key = chan_utils::derive_public_key(&self.onchain_tx_handler.secp_ctx,
2834 &per_commitment_point,
2835 &self.counterparty_commitment_params.counterparty_delayed_payment_base_key);
2836 let revokeable_p2wsh = chan_utils::get_revokeable_redeemscript(&revocation_pubkey,
2837 self.counterparty_commitment_params.on_counterparty_tx_csv,
2838 &delayed_key).to_v0_p2wsh();
2839 for (idx, outp) in transaction.output.iter().enumerate() {
2840 if outp.script_pubkey == revokeable_p2wsh {
2841 to_counterparty_output_info =
2842 Some((idx.try_into().expect("Can't have > 2^32 outputs"), outp.value));
2847 for (_, &(ref htlc, _)) in htlc_outputs.iter().enumerate() {
2848 if let Some(transaction_output_index) = htlc.transaction_output_index {
2849 if let Some(transaction) = tx {
2850 if transaction_output_index as usize >= transaction.output.len() ||
2851 transaction.output[transaction_output_index as usize].value != htlc.amount_msat / 1000 {
2852 // per_commitment_data is corrupt or our commitment signing key leaked!
2853 return (claimable_outpoints, to_counterparty_output_info);
2856 let preimage = if htlc.offered { if let Some(p) = self.payment_preimages.get(&htlc.payment_hash) { Some(*p) } else { None } } else { None };
2857 if preimage.is_some() || !htlc.offered {
2858 let counterparty_htlc_outp = if htlc.offered {
2859 PackageSolvingData::CounterpartyOfferedHTLCOutput(
2860 CounterpartyOfferedHTLCOutput::build(*per_commitment_point,
2861 self.counterparty_commitment_params.counterparty_delayed_payment_base_key,
2862 self.counterparty_commitment_params.counterparty_htlc_base_key,
2863 preimage.unwrap(), htlc.clone(), self.onchain_tx_handler.channel_type_features().clone()))
2865 PackageSolvingData::CounterpartyReceivedHTLCOutput(
2866 CounterpartyReceivedHTLCOutput::build(*per_commitment_point,
2867 self.counterparty_commitment_params.counterparty_delayed_payment_base_key,
2868 self.counterparty_commitment_params.counterparty_htlc_base_key,
2869 htlc.clone(), self.onchain_tx_handler.channel_type_features().clone()))
2871 let counterparty_package = PackageTemplate::build_package(commitment_txid, transaction_output_index, counterparty_htlc_outp, htlc.cltv_expiry, 0);
2872 claimable_outpoints.push(counterparty_package);
2877 (claimable_outpoints, to_counterparty_output_info)
2880 /// Attempts to claim a counterparty HTLC-Success/HTLC-Timeout's outputs using the revocation key
2881 fn check_spend_counterparty_htlc<L: Deref>(
2882 &mut self, tx: &Transaction, commitment_number: u64, commitment_txid: &Txid, height: u32, logger: &L
2883 ) -> (Vec<PackageTemplate>, Option<TransactionOutputs>) where L::Target: Logger {
2884 let secret = if let Some(secret) = self.get_secret(commitment_number) { secret } else { return (Vec::new(), None); };
2885 let per_commitment_key = match SecretKey::from_slice(&secret) {
2887 Err(_) => return (Vec::new(), None)
2889 let per_commitment_point = PublicKey::from_secret_key(&self.onchain_tx_handler.secp_ctx, &per_commitment_key);
2891 let htlc_txid = tx.txid();
2892 let mut claimable_outpoints = vec![];
2893 let mut outputs_to_watch = None;
2894 // Previously, we would only claim HTLCs from revoked HTLC transactions if they had 1 input
2895 // with a witness of 5 elements and 1 output. This wasn't enough for anchor outputs, as the
2896 // counterparty can now aggregate multiple HTLCs into a single transaction thanks to
2897 // `SIGHASH_SINGLE` remote signatures, leading us to not claim any HTLCs upon seeing a
2898 // confirmed revoked HTLC transaction (for more details, see
2899 // https://lists.linuxfoundation.org/pipermail/lightning-dev/2022-April/003561.html).
2901 // We make sure we're not vulnerable to this case by checking all inputs of the transaction,
2902 // and claim those which spend the commitment transaction, have a witness of 5 elements, and
2903 // have a corresponding output at the same index within the transaction.
2904 for (idx, input) in tx.input.iter().enumerate() {
2905 if input.previous_output.txid == *commitment_txid && input.witness.len() == 5 && tx.output.get(idx).is_some() {
2906 log_error!(logger, "Got broadcast of revoked counterparty HTLC transaction, spending {}:{}", htlc_txid, idx);
2907 let revk_outp = RevokedOutput::build(
2908 per_commitment_point, self.counterparty_commitment_params.counterparty_delayed_payment_base_key,
2909 self.counterparty_commitment_params.counterparty_htlc_base_key, per_commitment_key,
2910 tx.output[idx].value, self.counterparty_commitment_params.on_counterparty_tx_csv,
2913 let justice_package = PackageTemplate::build_package(
2914 htlc_txid, idx as u32, PackageSolvingData::RevokedOutput(revk_outp),
2915 height + self.counterparty_commitment_params.on_counterparty_tx_csv as u32, height
2917 claimable_outpoints.push(justice_package);
2918 if outputs_to_watch.is_none() {
2919 outputs_to_watch = Some((htlc_txid, vec![]));
2921 outputs_to_watch.as_mut().unwrap().1.push((idx as u32, tx.output[idx].clone()));
2924 (claimable_outpoints, outputs_to_watch)
2927 // Returns (1) `PackageTemplate`s that can be given to the OnchainTxHandler, so that the handler can
2928 // broadcast transactions claiming holder HTLC commitment outputs and (2) a holder revokable
2929 // script so we can detect whether a holder transaction has been seen on-chain.
2930 fn get_broadcasted_holder_claims(&self, holder_tx: &HolderSignedTx, conf_height: u32) -> (Vec<PackageTemplate>, Option<(Script, PublicKey, PublicKey)>) {
2931 let mut claim_requests = Vec::with_capacity(holder_tx.htlc_outputs.len());
2933 let redeemscript = chan_utils::get_revokeable_redeemscript(&holder_tx.revocation_key, self.on_holder_tx_csv, &holder_tx.delayed_payment_key);
2934 let broadcasted_holder_revokable_script = Some((redeemscript.to_v0_p2wsh(), holder_tx.per_commitment_point.clone(), holder_tx.revocation_key.clone()));
2936 for &(ref htlc, _, _) in holder_tx.htlc_outputs.iter() {
2937 if let Some(transaction_output_index) = htlc.transaction_output_index {
2938 let htlc_output = if htlc.offered {
2939 let htlc_output = HolderHTLCOutput::build_offered(
2940 htlc.amount_msat, htlc.cltv_expiry, self.onchain_tx_handler.channel_type_features().clone()
2944 let payment_preimage = if let Some(preimage) = self.payment_preimages.get(&htlc.payment_hash) {
2947 // We can't build an HTLC-Success transaction without the preimage
2950 let htlc_output = HolderHTLCOutput::build_accepted(
2951 payment_preimage, htlc.amount_msat, self.onchain_tx_handler.channel_type_features().clone()
2955 let htlc_package = PackageTemplate::build_package(
2956 holder_tx.txid, transaction_output_index,
2957 PackageSolvingData::HolderHTLCOutput(htlc_output),
2958 htlc.cltv_expiry, conf_height
2960 claim_requests.push(htlc_package);
2964 (claim_requests, broadcasted_holder_revokable_script)
2967 // Returns holder HTLC outputs to watch and react to in case of spending.
2968 fn get_broadcasted_holder_watch_outputs(&self, holder_tx: &HolderSignedTx, commitment_tx: &Transaction) -> Vec<(u32, TxOut)> {
2969 let mut watch_outputs = Vec::with_capacity(holder_tx.htlc_outputs.len());
2970 for &(ref htlc, _, _) in holder_tx.htlc_outputs.iter() {
2971 if let Some(transaction_output_index) = htlc.transaction_output_index {
2972 watch_outputs.push((transaction_output_index, commitment_tx.output[transaction_output_index as usize].clone()));
2978 /// Attempts to claim any claimable HTLCs in a commitment transaction which was not (yet)
2979 /// revoked using data in holder_claimable_outpoints.
2980 /// Should not be used if check_spend_revoked_transaction succeeds.
2981 /// Returns None unless the transaction is definitely one of our commitment transactions.
2982 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 {
2983 let commitment_txid = tx.txid();
2984 let mut claim_requests = Vec::new();
2985 let mut watch_outputs = Vec::new();
2987 macro_rules! append_onchain_update {
2988 ($updates: expr, $to_watch: expr) => {
2989 claim_requests = $updates.0;
2990 self.broadcasted_holder_revokable_script = $updates.1;
2991 watch_outputs.append(&mut $to_watch);
2995 // HTLCs set may differ between last and previous holder commitment txn, in case of one them hitting chain, ensure we cancel all HTLCs backward
2996 let mut is_holder_tx = false;
2998 if self.current_holder_commitment_tx.txid == commitment_txid {
2999 is_holder_tx = true;
3000 log_info!(logger, "Got broadcast of latest holder commitment tx {}, searching for available HTLCs to claim", commitment_txid);
3001 let res = self.get_broadcasted_holder_claims(&self.current_holder_commitment_tx, height);
3002 let mut to_watch = self.get_broadcasted_holder_watch_outputs(&self.current_holder_commitment_tx, tx);
3003 append_onchain_update!(res, to_watch);
3004 fail_unbroadcast_htlcs!(self, "latest holder", commitment_txid, tx, height,
3005 block_hash, self.current_holder_commitment_tx.htlc_outputs.iter()
3006 .map(|(htlc, _, htlc_source)| (htlc, htlc_source.as_ref())), logger);
3007 } else if let &Some(ref holder_tx) = &self.prev_holder_signed_commitment_tx {
3008 if holder_tx.txid == commitment_txid {
3009 is_holder_tx = true;
3010 log_info!(logger, "Got broadcast of previous holder commitment tx {}, searching for available HTLCs to claim", commitment_txid);
3011 let res = self.get_broadcasted_holder_claims(holder_tx, height);
3012 let mut to_watch = self.get_broadcasted_holder_watch_outputs(holder_tx, tx);
3013 append_onchain_update!(res, to_watch);
3014 fail_unbroadcast_htlcs!(self, "previous holder", commitment_txid, tx, height, block_hash,
3015 holder_tx.htlc_outputs.iter().map(|(htlc, _, htlc_source)| (htlc, htlc_source.as_ref())),
3021 Some((claim_requests, (commitment_txid, watch_outputs)))
3027 pub fn get_latest_holder_commitment_txn<L: Deref>(&mut self, logger: &L) -> Vec<Transaction> where L::Target: Logger {
3028 log_debug!(logger, "Getting signed latest holder commitment transaction!");
3029 self.holder_tx_signed = true;
3030 let commitment_tx = self.onchain_tx_handler.get_fully_signed_holder_tx(&self.funding_redeemscript);
3031 let txid = commitment_tx.txid();
3032 let mut holder_transactions = vec![commitment_tx];
3033 // When anchor outputs are present, the HTLC transactions are only valid once the commitment
3034 // transaction confirms.
3035 if self.onchain_tx_handler.channel_type_features().supports_anchors_zero_fee_htlc_tx() {
3036 return holder_transactions;
3038 for htlc in self.current_holder_commitment_tx.htlc_outputs.iter() {
3039 if let Some(vout) = htlc.0.transaction_output_index {
3040 let preimage = if !htlc.0.offered {
3041 if let Some(preimage) = self.payment_preimages.get(&htlc.0.payment_hash) { Some(preimage.clone()) } else {
3042 // We can't build an HTLC-Success transaction without the preimage
3045 } else if htlc.0.cltv_expiry > self.best_block.height() + 1 {
3046 // Don't broadcast HTLC-Timeout transactions immediately as they don't meet the
3047 // current locktime requirements on-chain. We will broadcast them in
3048 // `block_confirmed` when `should_broadcast_holder_commitment_txn` returns true.
3049 // Note that we add + 1 as transactions are broadcastable when they can be
3050 // confirmed in the next block.
3053 if let Some(htlc_tx) = self.onchain_tx_handler.get_fully_signed_htlc_tx(
3054 &::bitcoin::OutPoint { txid, vout }, &preimage) {
3055 holder_transactions.push(htlc_tx);
3059 // 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.
3060 // The data will be re-generated and tracked in check_spend_holder_transaction if we get a confirmation.
3064 #[cfg(any(test,feature = "unsafe_revoked_tx_signing"))]
3065 /// Note that this includes possibly-locktimed-in-the-future transactions!
3066 fn unsafe_get_latest_holder_commitment_txn<L: Deref>(&mut self, logger: &L) -> Vec<Transaction> where L::Target: Logger {
3067 log_debug!(logger, "Getting signed copy of latest holder commitment transaction!");
3068 let commitment_tx = self.onchain_tx_handler.get_fully_signed_copy_holder_tx(&self.funding_redeemscript);
3069 let txid = commitment_tx.txid();
3070 let mut holder_transactions = vec![commitment_tx];
3071 // When anchor outputs are present, the HTLC transactions are only final once the commitment
3072 // transaction confirms due to the CSV 1 encumberance.
3073 if self.onchain_tx_handler.channel_type_features().supports_anchors_zero_fee_htlc_tx() {
3074 return holder_transactions;
3076 for htlc in self.current_holder_commitment_tx.htlc_outputs.iter() {
3077 if let Some(vout) = htlc.0.transaction_output_index {
3078 let preimage = if !htlc.0.offered {
3079 if let Some(preimage) = self.payment_preimages.get(&htlc.0.payment_hash) { Some(preimage.clone()) } else {
3080 // We can't build an HTLC-Success transaction without the preimage
3084 if let Some(htlc_tx) = self.onchain_tx_handler.unsafe_get_fully_signed_htlc_tx(
3085 &::bitcoin::OutPoint { txid, vout }, &preimage) {
3086 holder_transactions.push(htlc_tx);
3093 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>
3094 where B::Target: BroadcasterInterface,
3095 F::Target: FeeEstimator,
3098 let block_hash = header.block_hash();
3099 self.best_block = BestBlock::new(block_hash, height);
3101 let bounded_fee_estimator = LowerBoundedFeeEstimator::new(fee_estimator);
3102 self.transactions_confirmed(header, txdata, height, broadcaster, &bounded_fee_estimator, logger)
3105 fn best_block_updated<B: Deref, F: Deref, L: Deref>(
3107 header: &BlockHeader,
3110 fee_estimator: &LowerBoundedFeeEstimator<F>,
3112 ) -> Vec<TransactionOutputs>
3114 B::Target: BroadcasterInterface,
3115 F::Target: FeeEstimator,
3118 let block_hash = header.block_hash();
3120 if height > self.best_block.height() {
3121 self.best_block = BestBlock::new(block_hash, height);
3122 self.block_confirmed(height, block_hash, vec![], vec![], vec![], &broadcaster, &fee_estimator, &logger)
3123 } else if block_hash != self.best_block.block_hash() {
3124 self.best_block = BestBlock::new(block_hash, height);
3125 self.onchain_events_awaiting_threshold_conf.retain(|ref entry| entry.height <= height);
3126 self.onchain_tx_handler.block_disconnected(height + 1, broadcaster, fee_estimator, logger);
3128 } else { Vec::new() }
3131 fn transactions_confirmed<B: Deref, F: Deref, L: Deref>(
3133 header: &BlockHeader,
3134 txdata: &TransactionData,
3137 fee_estimator: &LowerBoundedFeeEstimator<F>,
3139 ) -> Vec<TransactionOutputs>
3141 B::Target: BroadcasterInterface,
3142 F::Target: FeeEstimator,
3145 let txn_matched = self.filter_block(txdata);
3146 for tx in &txn_matched {
3147 let mut output_val = 0;
3148 for out in tx.output.iter() {
3149 if out.value > 21_000_000_0000_0000 { panic!("Value-overflowing transaction provided to block connected"); }
3150 output_val += out.value;
3151 if output_val > 21_000_000_0000_0000 { panic!("Value-overflowing transaction provided to block connected"); }
3155 let block_hash = header.block_hash();
3157 let mut watch_outputs = Vec::new();
3158 let mut claimable_outpoints = Vec::new();
3159 'tx_iter: for tx in &txn_matched {
3160 let txid = tx.txid();
3161 // If a transaction has already been confirmed, ensure we don't bother processing it duplicatively.
3162 if Some(txid) == self.funding_spend_confirmed {
3163 log_debug!(logger, "Skipping redundant processing of funding-spend tx {} as it was previously confirmed", txid);
3166 for ev in self.onchain_events_awaiting_threshold_conf.iter() {
3167 if ev.txid == txid {
3168 if let Some(conf_hash) = ev.block_hash {
3169 assert_eq!(header.block_hash(), conf_hash,
3170 "Transaction {} was already confirmed and is being re-confirmed in a different block.\n\
3171 This indicates a severe bug in the transaction connection logic - a reorg should have been processed first!", ev.txid);
3173 log_debug!(logger, "Skipping redundant processing of confirming tx {} as it was previously confirmed", txid);
3177 for htlc in self.htlcs_resolved_on_chain.iter() {
3178 if Some(txid) == htlc.resolving_txid {
3179 log_debug!(logger, "Skipping redundant processing of HTLC resolution tx {} as it was previously confirmed", txid);
3183 for spendable_txid in self.spendable_txids_confirmed.iter() {
3184 if txid == *spendable_txid {
3185 log_debug!(logger, "Skipping redundant processing of spendable tx {} as it was previously confirmed", txid);
3190 if tx.input.len() == 1 {
3191 // Assuming our keys were not leaked (in which case we're screwed no matter what),
3192 // commitment transactions and HTLC transactions will all only ever have one input
3193 // (except for HTLC transactions for channels with anchor outputs), which is an easy
3194 // way to filter out any potential non-matching txn for lazy filters.
3195 let prevout = &tx.input[0].previous_output;
3196 if prevout.txid == self.funding_info.0.txid && prevout.vout == self.funding_info.0.index as u32 {
3197 let mut balance_spendable_csv = None;
3198 log_info!(logger, "Channel {} closed by funding output spend in txid {}.",
3199 log_bytes!(self.funding_info.0.to_channel_id()), txid);
3200 self.funding_spend_seen = true;
3201 let mut commitment_tx_to_counterparty_output = None;
3202 if (tx.input[0].sequence.0 >> 8*3) as u8 == 0x80 && (tx.lock_time.0 >> 8*3) as u8 == 0x20 {
3203 let (mut new_outpoints, new_outputs, counterparty_output_idx_sats) =
3204 self.check_spend_counterparty_transaction(&tx, height, &block_hash, &logger);
3205 commitment_tx_to_counterparty_output = counterparty_output_idx_sats;
3206 if !new_outputs.1.is_empty() {
3207 watch_outputs.push(new_outputs);
3209 claimable_outpoints.append(&mut new_outpoints);
3210 if new_outpoints.is_empty() {
3211 if let Some((mut new_outpoints, new_outputs)) = self.check_spend_holder_transaction(&tx, height, &block_hash, &logger) {
3212 debug_assert!(commitment_tx_to_counterparty_output.is_none(),
3213 "A commitment transaction matched as both a counterparty and local commitment tx?");
3214 if !new_outputs.1.is_empty() {
3215 watch_outputs.push(new_outputs);
3217 claimable_outpoints.append(&mut new_outpoints);
3218 balance_spendable_csv = Some(self.on_holder_tx_csv);
3222 self.onchain_events_awaiting_threshold_conf.push(OnchainEventEntry {
3224 transaction: Some((*tx).clone()),
3226 block_hash: Some(block_hash),
3227 event: OnchainEvent::FundingSpendConfirmation {
3228 on_local_output_csv: balance_spendable_csv,
3229 commitment_tx_to_counterparty_output,
3234 if tx.input.len() >= 1 {
3235 // While all commitment transactions have one input, HTLC transactions may have more
3236 // if the HTLC was present in an anchor channel. HTLCs can also be resolved in a few
3237 // other ways which can have more than one output.
3238 for tx_input in &tx.input {
3239 let commitment_txid = tx_input.previous_output.txid;
3240 if let Some(&commitment_number) = self.counterparty_commitment_txn_on_chain.get(&commitment_txid) {
3241 let (mut new_outpoints, new_outputs_option) = self.check_spend_counterparty_htlc(
3242 &tx, commitment_number, &commitment_txid, height, &logger
3244 claimable_outpoints.append(&mut new_outpoints);
3245 if let Some(new_outputs) = new_outputs_option {
3246 watch_outputs.push(new_outputs);
3248 // Since there may be multiple HTLCs for this channel (all spending the
3249 // same commitment tx) being claimed by the counterparty within the same
3250 // transaction, and `check_spend_counterparty_htlc` already checks all the
3251 // ones relevant to this channel, we can safely break from our loop.
3255 self.is_resolving_htlc_output(&tx, height, &block_hash, &logger);
3257 self.is_paying_spendable_output(&tx, height, &block_hash, &logger);
3261 if height > self.best_block.height() {
3262 self.best_block = BestBlock::new(block_hash, height);
3265 self.block_confirmed(height, block_hash, txn_matched, watch_outputs, claimable_outpoints, &broadcaster, &fee_estimator, &logger)
3268 /// Update state for new block(s)/transaction(s) confirmed. Note that the caller must update
3269 /// `self.best_block` before calling if a new best blockchain tip is available. More
3270 /// concretely, `self.best_block` must never be at a lower height than `conf_height`, avoiding
3271 /// complexity especially in
3272 /// `OnchainTx::update_claims_view_from_requests`/`OnchainTx::update_claims_view_from_matched_txn`.
3274 /// `conf_height` should be set to the height at which any new transaction(s)/block(s) were
3275 /// confirmed at, even if it is not the current best height.
3276 fn block_confirmed<B: Deref, F: Deref, L: Deref>(
3279 conf_hash: BlockHash,
3280 txn_matched: Vec<&Transaction>,
3281 mut watch_outputs: Vec<TransactionOutputs>,
3282 mut claimable_outpoints: Vec<PackageTemplate>,
3284 fee_estimator: &LowerBoundedFeeEstimator<F>,
3286 ) -> Vec<TransactionOutputs>
3288 B::Target: BroadcasterInterface,
3289 F::Target: FeeEstimator,
3292 log_trace!(logger, "Processing {} matched transactions for block at height {}.", txn_matched.len(), conf_height);
3293 debug_assert!(self.best_block.height() >= conf_height);
3295 let should_broadcast = self.should_broadcast_holder_commitment_txn(logger);
3296 if should_broadcast {
3297 let funding_outp = HolderFundingOutput::build(self.funding_redeemscript.clone(), self.channel_value_satoshis, self.onchain_tx_handler.channel_type_features().clone());
3298 let commitment_package = PackageTemplate::build_package(self.funding_info.0.txid.clone(), self.funding_info.0.index as u32, PackageSolvingData::HolderFundingOutput(funding_outp), self.best_block.height(), self.best_block.height());
3299 claimable_outpoints.push(commitment_package);
3300 self.pending_monitor_events.push(MonitorEvent::CommitmentTxConfirmed(self.funding_info.0));
3301 let commitment_tx = self.onchain_tx_handler.get_fully_signed_holder_tx(&self.funding_redeemscript);
3302 self.holder_tx_signed = true;
3303 // We can't broadcast our HTLC transactions while the commitment transaction is
3304 // unconfirmed. We'll delay doing so until we detect the confirmed commitment in
3305 // `transactions_confirmed`.
3306 if !self.onchain_tx_handler.channel_type_features().supports_anchors_zero_fee_htlc_tx() {
3307 // Because we're broadcasting a commitment transaction, we should construct the package
3308 // assuming it gets confirmed in the next block. Sadly, we have code which considers
3309 // "not yet confirmed" things as discardable, so we cannot do that here.
3310 let (mut new_outpoints, _) = self.get_broadcasted_holder_claims(&self.current_holder_commitment_tx, self.best_block.height());
3311 let new_outputs = self.get_broadcasted_holder_watch_outputs(&self.current_holder_commitment_tx, &commitment_tx);
3312 if !new_outputs.is_empty() {
3313 watch_outputs.push((self.current_holder_commitment_tx.txid.clone(), new_outputs));
3315 claimable_outpoints.append(&mut new_outpoints);
3319 // Find which on-chain events have reached their confirmation threshold.
3320 let onchain_events_awaiting_threshold_conf =
3321 self.onchain_events_awaiting_threshold_conf.drain(..).collect::<Vec<_>>();
3322 let mut onchain_events_reaching_threshold_conf = Vec::new();
3323 for entry in onchain_events_awaiting_threshold_conf {
3324 if entry.has_reached_confirmation_threshold(&self.best_block) {
3325 onchain_events_reaching_threshold_conf.push(entry);
3327 self.onchain_events_awaiting_threshold_conf.push(entry);
3331 // Used to check for duplicate HTLC resolutions.
3332 #[cfg(debug_assertions)]
3333 let unmatured_htlcs: Vec<_> = self.onchain_events_awaiting_threshold_conf
3335 .filter_map(|entry| match &entry.event {
3336 OnchainEvent::HTLCUpdate { source, .. } => Some(source),
3340 #[cfg(debug_assertions)]
3341 let mut matured_htlcs = Vec::new();
3343 // Produce actionable events from on-chain events having reached their threshold.
3344 for entry in onchain_events_reaching_threshold_conf.drain(..) {
3346 OnchainEvent::HTLCUpdate { ref source, payment_hash, htlc_value_satoshis, commitment_tx_output_idx } => {
3347 // Check for duplicate HTLC resolutions.
3348 #[cfg(debug_assertions)]
3351 unmatured_htlcs.iter().find(|&htlc| htlc == &source).is_none(),
3352 "An unmature HTLC transaction conflicts with a maturing one; failed to \
3353 call either transaction_unconfirmed for the conflicting transaction \
3354 or block_disconnected for a block containing it.");
3356 matured_htlcs.iter().find(|&htlc| htlc == source).is_none(),
3357 "A matured HTLC transaction conflicts with a maturing one; failed to \
3358 call either transaction_unconfirmed for the conflicting transaction \
3359 or block_disconnected for a block containing it.");
3360 matured_htlcs.push(source.clone());
3363 log_debug!(logger, "HTLC {} failure update in {} has got enough confirmations to be passed upstream",
3364 log_bytes!(payment_hash.0), entry.txid);
3365 self.pending_monitor_events.push(MonitorEvent::HTLCEvent(HTLCUpdate {
3367 payment_preimage: None,
3368 source: source.clone(),
3369 htlc_value_satoshis,
3371 self.htlcs_resolved_on_chain.push(IrrevocablyResolvedHTLC {
3372 commitment_tx_output_idx,
3373 resolving_txid: Some(entry.txid),
3374 resolving_tx: entry.transaction,
3375 payment_preimage: None,
3378 OnchainEvent::MaturingOutput { descriptor } => {
3379 log_debug!(logger, "Descriptor {} has got enough confirmations to be passed upstream", log_spendable!(descriptor));
3380 self.pending_events.push(Event::SpendableOutputs {
3381 outputs: vec![descriptor]
3383 self.spendable_txids_confirmed.push(entry.txid);
3385 OnchainEvent::HTLCSpendConfirmation { commitment_tx_output_idx, preimage, .. } => {
3386 self.htlcs_resolved_on_chain.push(IrrevocablyResolvedHTLC {
3387 commitment_tx_output_idx: Some(commitment_tx_output_idx),
3388 resolving_txid: Some(entry.txid),
3389 resolving_tx: entry.transaction,
3390 payment_preimage: preimage,
3393 OnchainEvent::FundingSpendConfirmation { commitment_tx_to_counterparty_output, .. } => {
3394 self.funding_spend_confirmed = Some(entry.txid);
3395 self.confirmed_commitment_tx_counterparty_output = commitment_tx_to_counterparty_output;
3400 self.onchain_tx_handler.update_claims_view_from_requests(claimable_outpoints, conf_height, self.best_block.height(), broadcaster, fee_estimator, logger);
3401 self.onchain_tx_handler.update_claims_view_from_matched_txn(&txn_matched, conf_height, conf_hash, self.best_block.height(), broadcaster, fee_estimator, logger);
3403 // Determine new outputs to watch by comparing against previously known outputs to watch,
3404 // updating the latter in the process.
3405 watch_outputs.retain(|&(ref txid, ref txouts)| {
3406 let idx_and_scripts = txouts.iter().map(|o| (o.0, o.1.script_pubkey.clone())).collect();
3407 self.outputs_to_watch.insert(txid.clone(), idx_and_scripts).is_none()
3411 // If we see a transaction for which we registered outputs previously,
3412 // make sure the registered scriptpubkey at the expected index match
3413 // the actual transaction output one. We failed this case before #653.
3414 for tx in &txn_matched {
3415 if let Some(outputs) = self.get_outputs_to_watch().get(&tx.txid()) {
3416 for idx_and_script in outputs.iter() {
3417 assert!((idx_and_script.0 as usize) < tx.output.len());
3418 assert_eq!(tx.output[idx_and_script.0 as usize].script_pubkey, idx_and_script.1);
3426 pub fn block_disconnected<B: Deref, F: Deref, L: Deref>(&mut self, header: &BlockHeader, height: u32, broadcaster: B, fee_estimator: F, logger: L)
3427 where B::Target: BroadcasterInterface,
3428 F::Target: FeeEstimator,
3431 log_trace!(logger, "Block {} at height {} disconnected", header.block_hash(), height);
3434 //- htlc update there as failure-trigger tx (revoked commitment tx, non-revoked commitment tx, HTLC-timeout tx) has been disconnected
3435 //- maturing spendable output has transaction paying us has been disconnected
3436 self.onchain_events_awaiting_threshold_conf.retain(|ref entry| entry.height < height);
3438 let bounded_fee_estimator = LowerBoundedFeeEstimator::new(fee_estimator);
3439 self.onchain_tx_handler.block_disconnected(height, broadcaster, &bounded_fee_estimator, logger);
3441 self.best_block = BestBlock::new(header.prev_blockhash, height - 1);
3444 fn transaction_unconfirmed<B: Deref, F: Deref, L: Deref>(
3448 fee_estimator: &LowerBoundedFeeEstimator<F>,
3451 B::Target: BroadcasterInterface,
3452 F::Target: FeeEstimator,
3455 let mut removed_height = None;
3456 for entry in self.onchain_events_awaiting_threshold_conf.iter() {
3457 if entry.txid == *txid {
3458 removed_height = Some(entry.height);
3463 if let Some(removed_height) = removed_height {
3464 log_info!(logger, "transaction_unconfirmed of txid {} implies height {} was reorg'd out", txid, removed_height);
3465 self.onchain_events_awaiting_threshold_conf.retain(|ref entry| if entry.height >= removed_height {
3466 log_info!(logger, "Transaction {} reorg'd out", entry.txid);
3471 debug_assert!(!self.onchain_events_awaiting_threshold_conf.iter().any(|ref entry| entry.txid == *txid));
3473 self.onchain_tx_handler.transaction_unconfirmed(txid, broadcaster, fee_estimator, logger);
3476 /// Filters a block's `txdata` for transactions spending watched outputs or for any child
3477 /// transactions thereof.
3478 fn filter_block<'a>(&self, txdata: &TransactionData<'a>) -> Vec<&'a Transaction> {
3479 let mut matched_txn = HashSet::new();
3480 txdata.iter().filter(|&&(_, tx)| {
3481 let mut matches = self.spends_watched_output(tx);
3482 for input in tx.input.iter() {
3483 if matches { break; }
3484 if matched_txn.contains(&input.previous_output.txid) {
3489 matched_txn.insert(tx.txid());
3492 }).map(|(_, tx)| *tx).collect()
3495 /// Checks if a given transaction spends any watched outputs.
3496 fn spends_watched_output(&self, tx: &Transaction) -> bool {
3497 for input in tx.input.iter() {
3498 if let Some(outputs) = self.get_outputs_to_watch().get(&input.previous_output.txid) {
3499 for (idx, _script_pubkey) in outputs.iter() {
3500 if *idx == input.previous_output.vout {
3503 // If the expected script is a known type, check that the witness
3504 // appears to be spending the correct type (ie that the match would
3505 // actually succeed in BIP 158/159-style filters).
3506 if _script_pubkey.is_v0_p2wsh() {
3507 if input.witness.last().unwrap().to_vec() == deliberately_bogus_accepted_htlc_witness_program() {
3508 // In at least one test we use a deliberately bogus witness
3509 // script which hit an old panic. Thus, we check for that here
3510 // and avoid the assert if its the expected bogus script.
3514 assert_eq!(&bitcoin::Address::p2wsh(&Script::from(input.witness.last().unwrap().to_vec()), bitcoin::Network::Bitcoin).script_pubkey(), _script_pubkey);
3515 } else if _script_pubkey.is_v0_p2wpkh() {
3516 assert_eq!(&bitcoin::Address::p2wpkh(&bitcoin::PublicKey::from_slice(&input.witness.last().unwrap()).unwrap(), bitcoin::Network::Bitcoin).unwrap().script_pubkey(), _script_pubkey);
3517 } else { panic!(); }
3528 fn should_broadcast_holder_commitment_txn<L: Deref>(&self, logger: &L) -> bool where L::Target: Logger {
3529 // There's no need to broadcast our commitment transaction if we've seen one confirmed (even
3530 // with 1 confirmation) as it'll be rejected as duplicate/conflicting.
3531 if self.funding_spend_confirmed.is_some() ||
3532 self.onchain_events_awaiting_threshold_conf.iter().find(|event| match event.event {
3533 OnchainEvent::FundingSpendConfirmation { .. } => true,
3539 // We need to consider all HTLCs which are:
3540 // * in any unrevoked counterparty commitment transaction, as they could broadcast said
3541 // transactions and we'd end up in a race, or
3542 // * are in our latest holder commitment transaction, as this is the thing we will
3543 // broadcast if we go on-chain.
3544 // Note that we consider HTLCs which were below dust threshold here - while they don't
3545 // strictly imply that we need to fail the channel, we need to go ahead and fail them back
3546 // to the source, and if we don't fail the channel we will have to ensure that the next
3547 // updates that peer sends us are update_fails, failing the channel if not. It's probably
3548 // easier to just fail the channel as this case should be rare enough anyway.
3549 let height = self.best_block.height();
3550 macro_rules! scan_commitment {
3551 ($htlcs: expr, $holder_tx: expr) => {
3552 for ref htlc in $htlcs {
3553 // For inbound HTLCs which we know the preimage for, we have to ensure we hit the
3554 // chain with enough room to claim the HTLC without our counterparty being able to
3555 // time out the HTLC first.
3556 // For outbound HTLCs which our counterparty hasn't failed/claimed, our primary
3557 // concern is being able to claim the corresponding inbound HTLC (on another
3558 // channel) before it expires. In fact, we don't even really care if our
3559 // counterparty here claims such an outbound HTLC after it expired as long as we
3560 // can still claim the corresponding HTLC. Thus, to avoid needlessly hitting the
3561 // chain when our counterparty is waiting for expiration to off-chain fail an HTLC
3562 // we give ourselves a few blocks of headroom after expiration before going
3563 // on-chain for an expired HTLC.
3564 // Note that, to avoid a potential attack whereby a node delays claiming an HTLC
3565 // from us until we've reached the point where we go on-chain with the
3566 // corresponding inbound HTLC, we must ensure that outbound HTLCs go on chain at
3567 // least CLTV_CLAIM_BUFFER blocks prior to the inbound HTLC.
3568 // aka outbound_cltv + LATENCY_GRACE_PERIOD_BLOCKS == height - CLTV_CLAIM_BUFFER
3569 // inbound_cltv == height + CLTV_CLAIM_BUFFER
3570 // outbound_cltv + LATENCY_GRACE_PERIOD_BLOCKS + CLTV_CLAIM_BUFFER <= inbound_cltv - CLTV_CLAIM_BUFFER
3571 // LATENCY_GRACE_PERIOD_BLOCKS + 2*CLTV_CLAIM_BUFFER <= inbound_cltv - outbound_cltv
3572 // CLTV_EXPIRY_DELTA <= inbound_cltv - outbound_cltv (by check in ChannelManager::decode_update_add_htlc_onion)
3573 // LATENCY_GRACE_PERIOD_BLOCKS + 2*CLTV_CLAIM_BUFFER <= CLTV_EXPIRY_DELTA
3574 // The final, above, condition is checked for statically in channelmanager
3575 // with CHECK_CLTV_EXPIRY_SANITY_2.
3576 let htlc_outbound = $holder_tx == htlc.offered;
3577 if ( htlc_outbound && htlc.cltv_expiry + LATENCY_GRACE_PERIOD_BLOCKS <= height) ||
3578 (!htlc_outbound && htlc.cltv_expiry <= height + CLTV_CLAIM_BUFFER && self.payment_preimages.contains_key(&htlc.payment_hash)) {
3579 log_info!(logger, "Force-closing channel due to {} HTLC timeout, HTLC expiry is {}", if htlc_outbound { "outbound" } else { "inbound "}, htlc.cltv_expiry);
3586 scan_commitment!(self.current_holder_commitment_tx.htlc_outputs.iter().map(|&(ref a, _, _)| a), true);
3588 if let Some(ref txid) = self.current_counterparty_commitment_txid {
3589 if let Some(ref htlc_outputs) = self.counterparty_claimable_outpoints.get(txid) {
3590 scan_commitment!(htlc_outputs.iter().map(|&(ref a, _)| a), false);
3593 if let Some(ref txid) = self.prev_counterparty_commitment_txid {
3594 if let Some(ref htlc_outputs) = self.counterparty_claimable_outpoints.get(txid) {
3595 scan_commitment!(htlc_outputs.iter().map(|&(ref a, _)| a), false);
3602 /// Check if any transaction broadcasted is resolving HTLC output by a success or timeout on a holder
3603 /// or counterparty commitment tx, if so send back the source, preimage if found and payment_hash of resolved HTLC
3604 fn is_resolving_htlc_output<L: Deref>(&mut self, tx: &Transaction, height: u32, block_hash: &BlockHash, logger: &L) where L::Target: Logger {
3605 'outer_loop: for input in &tx.input {
3606 let mut payment_data = None;
3607 let htlc_claim = HTLCClaim::from_witness(&input.witness);
3608 let revocation_sig_claim = htlc_claim == Some(HTLCClaim::Revocation);
3609 let accepted_preimage_claim = htlc_claim == Some(HTLCClaim::AcceptedPreimage);
3610 #[cfg(not(fuzzing))]
3611 let accepted_timeout_claim = htlc_claim == Some(HTLCClaim::AcceptedTimeout);
3612 let offered_preimage_claim = htlc_claim == Some(HTLCClaim::OfferedPreimage);
3613 #[cfg(not(fuzzing))]
3614 let offered_timeout_claim = htlc_claim == Some(HTLCClaim::OfferedTimeout);
3616 let mut payment_preimage = PaymentPreimage([0; 32]);
3617 if offered_preimage_claim || accepted_preimage_claim {
3618 payment_preimage.0.copy_from_slice(input.witness.second_to_last().unwrap());
3621 macro_rules! log_claim {
3622 ($tx_info: expr, $holder_tx: expr, $htlc: expr, $source_avail: expr) => {
3623 let outbound_htlc = $holder_tx == $htlc.offered;
3624 // HTLCs must either be claimed by a matching script type or through the
3626 #[cfg(not(fuzzing))] // Note that the fuzzer is not bound by pesky things like "signatures"
3627 debug_assert!(!$htlc.offered || offered_preimage_claim || offered_timeout_claim || revocation_sig_claim);
3628 #[cfg(not(fuzzing))] // Note that the fuzzer is not bound by pesky things like "signatures"
3629 debug_assert!($htlc.offered || accepted_preimage_claim || accepted_timeout_claim || revocation_sig_claim);
3630 // Further, only exactly one of the possible spend paths should have been
3631 // matched by any HTLC spend:
3632 #[cfg(not(fuzzing))] // Note that the fuzzer is not bound by pesky things like "signatures"
3633 debug_assert_eq!(accepted_preimage_claim as u8 + accepted_timeout_claim as u8 +
3634 offered_preimage_claim as u8 + offered_timeout_claim as u8 +
3635 revocation_sig_claim as u8, 1);
3636 if ($holder_tx && revocation_sig_claim) ||
3637 (outbound_htlc && !$source_avail && (accepted_preimage_claim || offered_preimage_claim)) {
3638 log_error!(logger, "Input spending {} ({}:{}) in {} resolves {} HTLC with payment hash {} with {}!",
3639 $tx_info, input.previous_output.txid, input.previous_output.vout, tx.txid(),
3640 if outbound_htlc { "outbound" } else { "inbound" }, log_bytes!($htlc.payment_hash.0),
3641 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" });
3643 log_info!(logger, "Input spending {} ({}:{}) in {} resolves {} HTLC with payment hash {} with {}",
3644 $tx_info, input.previous_output.txid, input.previous_output.vout, tx.txid(),
3645 if outbound_htlc { "outbound" } else { "inbound" }, log_bytes!($htlc.payment_hash.0),
3646 if revocation_sig_claim { "revocation sig" } else if accepted_preimage_claim || offered_preimage_claim { "preimage" } else { "timeout" });
3651 macro_rules! check_htlc_valid_counterparty {
3652 ($counterparty_txid: expr, $htlc_output: expr) => {
3653 if let Some(txid) = $counterparty_txid {
3654 for &(ref pending_htlc, ref pending_source) in self.counterparty_claimable_outpoints.get(&txid).unwrap() {
3655 if pending_htlc.payment_hash == $htlc_output.payment_hash && pending_htlc.amount_msat == $htlc_output.amount_msat {
3656 if let &Some(ref source) = pending_source {
3657 log_claim!("revoked counterparty commitment tx", false, pending_htlc, true);
3658 payment_data = Some(((**source).clone(), $htlc_output.payment_hash, $htlc_output.amount_msat));
3667 macro_rules! scan_commitment {
3668 ($htlcs: expr, $tx_info: expr, $holder_tx: expr) => {
3669 for (ref htlc_output, source_option) in $htlcs {
3670 if Some(input.previous_output.vout) == htlc_output.transaction_output_index {
3671 if let Some(ref source) = source_option {
3672 log_claim!($tx_info, $holder_tx, htlc_output, true);
3673 // We have a resolution of an HTLC either from one of our latest
3674 // holder commitment transactions or an unrevoked counterparty commitment
3675 // transaction. This implies we either learned a preimage, the HTLC
3676 // has timed out, or we screwed up. In any case, we should now
3677 // resolve the source HTLC with the original sender.
3678 payment_data = Some(((*source).clone(), htlc_output.payment_hash, htlc_output.amount_msat));
3679 } else if !$holder_tx {
3680 check_htlc_valid_counterparty!(self.current_counterparty_commitment_txid, htlc_output);
3681 if payment_data.is_none() {
3682 check_htlc_valid_counterparty!(self.prev_counterparty_commitment_txid, htlc_output);
3685 if payment_data.is_none() {
3686 log_claim!($tx_info, $holder_tx, htlc_output, false);
3687 let outbound_htlc = $holder_tx == htlc_output.offered;
3688 self.onchain_events_awaiting_threshold_conf.push(OnchainEventEntry {
3689 txid: tx.txid(), height, block_hash: Some(*block_hash), transaction: Some(tx.clone()),
3690 event: OnchainEvent::HTLCSpendConfirmation {
3691 commitment_tx_output_idx: input.previous_output.vout,
3692 preimage: if accepted_preimage_claim || offered_preimage_claim {
3693 Some(payment_preimage) } else { None },
3694 // If this is a payment to us (ie !outbound_htlc), wait for
3695 // the CSV delay before dropping the HTLC from claimable
3696 // balance if the claim was an HTLC-Success transaction (ie
3697 // accepted_preimage_claim).
3698 on_to_local_output_csv: if accepted_preimage_claim && !outbound_htlc {
3699 Some(self.on_holder_tx_csv) } else { None },
3702 continue 'outer_loop;
3709 if input.previous_output.txid == self.current_holder_commitment_tx.txid {
3710 scan_commitment!(self.current_holder_commitment_tx.htlc_outputs.iter().map(|&(ref a, _, ref b)| (a, b.as_ref())),
3711 "our latest holder commitment tx", true);
3713 if let Some(ref prev_holder_signed_commitment_tx) = self.prev_holder_signed_commitment_tx {
3714 if input.previous_output.txid == prev_holder_signed_commitment_tx.txid {
3715 scan_commitment!(prev_holder_signed_commitment_tx.htlc_outputs.iter().map(|&(ref a, _, ref b)| (a, b.as_ref())),
3716 "our previous holder commitment tx", true);
3719 if let Some(ref htlc_outputs) = self.counterparty_claimable_outpoints.get(&input.previous_output.txid) {
3720 scan_commitment!(htlc_outputs.iter().map(|&(ref a, ref b)| (a, (b.as_ref().clone()).map(|boxed| &**boxed))),
3721 "counterparty commitment tx", false);
3724 // Check that scan_commitment, above, decided there is some source worth relaying an
3725 // HTLC resolution backwards to and figure out whether we learned a preimage from it.
3726 if let Some((source, payment_hash, amount_msat)) = payment_data {
3727 if accepted_preimage_claim {
3728 if !self.pending_monitor_events.iter().any(
3729 |update| if let &MonitorEvent::HTLCEvent(ref upd) = update { upd.source == source } else { false }) {
3730 self.onchain_events_awaiting_threshold_conf.push(OnchainEventEntry {
3733 block_hash: Some(*block_hash),
3734 transaction: Some(tx.clone()),
3735 event: OnchainEvent::HTLCSpendConfirmation {
3736 commitment_tx_output_idx: input.previous_output.vout,
3737 preimage: Some(payment_preimage),
3738 on_to_local_output_csv: None,
3741 self.pending_monitor_events.push(MonitorEvent::HTLCEvent(HTLCUpdate {
3743 payment_preimage: Some(payment_preimage),
3745 htlc_value_satoshis: Some(amount_msat / 1000),
3748 } else if offered_preimage_claim {
3749 if !self.pending_monitor_events.iter().any(
3750 |update| if let &MonitorEvent::HTLCEvent(ref upd) = update {
3751 upd.source == source
3753 self.onchain_events_awaiting_threshold_conf.push(OnchainEventEntry {
3755 transaction: Some(tx.clone()),
3757 block_hash: Some(*block_hash),
3758 event: OnchainEvent::HTLCSpendConfirmation {
3759 commitment_tx_output_idx: input.previous_output.vout,
3760 preimage: Some(payment_preimage),
3761 on_to_local_output_csv: None,
3764 self.pending_monitor_events.push(MonitorEvent::HTLCEvent(HTLCUpdate {
3766 payment_preimage: Some(payment_preimage),
3768 htlc_value_satoshis: Some(amount_msat / 1000),
3772 self.onchain_events_awaiting_threshold_conf.retain(|ref entry| {
3773 if entry.height != height { return true; }
3775 OnchainEvent::HTLCUpdate { source: ref htlc_source, .. } => {
3776 *htlc_source != source
3781 let entry = OnchainEventEntry {
3783 transaction: Some(tx.clone()),
3785 block_hash: Some(*block_hash),
3786 event: OnchainEvent::HTLCUpdate {
3787 source, payment_hash,
3788 htlc_value_satoshis: Some(amount_msat / 1000),
3789 commitment_tx_output_idx: Some(input.previous_output.vout),
3792 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());
3793 self.onchain_events_awaiting_threshold_conf.push(entry);
3799 /// Check if any transaction broadcasted is paying fund back to some address we can assume to own
3800 fn is_paying_spendable_output<L: Deref>(&mut self, tx: &Transaction, height: u32, block_hash: &BlockHash, logger: &L) where L::Target: Logger {
3801 let mut spendable_output = None;
3802 for (i, outp) in tx.output.iter().enumerate() { // There is max one spendable output for any channel tx, including ones generated by us
3803 if i > ::core::u16::MAX as usize {
3804 // While it is possible that an output exists on chain which is greater than the
3805 // 2^16th output in a given transaction, this is only possible if the output is not
3806 // in a lightning transaction and was instead placed there by some third party who
3807 // wishes to give us money for no reason.
3808 // Namely, any lightning transactions which we pre-sign will never have anywhere
3809 // near 2^16 outputs both because such transactions must have ~2^16 outputs who's
3810 // scripts are not longer than one byte in length and because they are inherently
3811 // non-standard due to their size.
3812 // Thus, it is completely safe to ignore such outputs, and while it may result in
3813 // us ignoring non-lightning fund to us, that is only possible if someone fills
3814 // nearly a full block with garbage just to hit this case.
3817 if outp.script_pubkey == self.destination_script {
3818 spendable_output = Some(SpendableOutputDescriptor::StaticOutput {
3819 outpoint: OutPoint { txid: tx.txid(), index: i as u16 },
3820 output: outp.clone(),
3824 if let Some(ref broadcasted_holder_revokable_script) = self.broadcasted_holder_revokable_script {
3825 if broadcasted_holder_revokable_script.0 == outp.script_pubkey {
3826 spendable_output = Some(SpendableOutputDescriptor::DelayedPaymentOutput(DelayedPaymentOutputDescriptor {
3827 outpoint: OutPoint { txid: tx.txid(), index: i as u16 },
3828 per_commitment_point: broadcasted_holder_revokable_script.1,
3829 to_self_delay: self.on_holder_tx_csv,
3830 output: outp.clone(),
3831 revocation_pubkey: broadcasted_holder_revokable_script.2.clone(),
3832 channel_keys_id: self.channel_keys_id,
3833 channel_value_satoshis: self.channel_value_satoshis,
3838 if self.counterparty_payment_script == outp.script_pubkey {
3839 spendable_output = Some(SpendableOutputDescriptor::StaticPaymentOutput(StaticPaymentOutputDescriptor {
3840 outpoint: OutPoint { txid: tx.txid(), index: i as u16 },
3841 output: outp.clone(),
3842 channel_keys_id: self.channel_keys_id,
3843 channel_value_satoshis: self.channel_value_satoshis,
3847 if self.shutdown_script.as_ref() == Some(&outp.script_pubkey) {
3848 spendable_output = Some(SpendableOutputDescriptor::StaticOutput {
3849 outpoint: OutPoint { txid: tx.txid(), index: i as u16 },
3850 output: outp.clone(),
3855 if let Some(spendable_output) = spendable_output {
3856 let entry = OnchainEventEntry {
3858 transaction: Some(tx.clone()),
3860 block_hash: Some(*block_hash),
3861 event: OnchainEvent::MaturingOutput { descriptor: spendable_output.clone() },
3863 log_info!(logger, "Received spendable output {}, spendable at height {}", log_spendable!(spendable_output), entry.confirmation_threshold());
3864 self.onchain_events_awaiting_threshold_conf.push(entry);
3869 impl<Signer: WriteableEcdsaChannelSigner, T: Deref, F: Deref, L: Deref> chain::Listen for (ChannelMonitor<Signer>, T, F, L)
3871 T::Target: BroadcasterInterface,
3872 F::Target: FeeEstimator,
3875 fn filtered_block_connected(&self, header: &BlockHeader, txdata: &TransactionData, height: u32) {
3876 self.0.block_connected(header, txdata, height, &*self.1, &*self.2, &*self.3);
3879 fn block_disconnected(&self, header: &BlockHeader, height: u32) {
3880 self.0.block_disconnected(header, height, &*self.1, &*self.2, &*self.3);
3884 impl<Signer: WriteableEcdsaChannelSigner, M, T: Deref, F: Deref, L: Deref> chain::Confirm for (M, T, F, L)
3886 M: Deref<Target = ChannelMonitor<Signer>>,
3887 T::Target: BroadcasterInterface,
3888 F::Target: FeeEstimator,
3891 fn transactions_confirmed(&self, header: &BlockHeader, txdata: &TransactionData, height: u32) {
3892 self.0.transactions_confirmed(header, txdata, height, &*self.1, &*self.2, &*self.3);
3895 fn transaction_unconfirmed(&self, txid: &Txid) {
3896 self.0.transaction_unconfirmed(txid, &*self.1, &*self.2, &*self.3);
3899 fn best_block_updated(&self, header: &BlockHeader, height: u32) {
3900 self.0.best_block_updated(header, height, &*self.1, &*self.2, &*self.3);
3903 fn get_relevant_txids(&self) -> Vec<(Txid, Option<BlockHash>)> {
3904 self.0.get_relevant_txids()
3908 const MAX_ALLOC_SIZE: usize = 64*1024;
3910 impl<'a, 'b, ES: EntropySource, SP: SignerProvider> ReadableArgs<(&'a ES, &'b SP)>
3911 for (BlockHash, ChannelMonitor<SP::Signer>) {
3912 fn read<R: io::Read>(reader: &mut R, args: (&'a ES, &'b SP)) -> Result<Self, DecodeError> {
3913 macro_rules! unwrap_obj {
3917 Err(_) => return Err(DecodeError::InvalidValue),
3922 let (entropy_source, signer_provider) = args;
3924 let _ver = read_ver_prefix!(reader, SERIALIZATION_VERSION);
3926 let latest_update_id: u64 = Readable::read(reader)?;
3927 let commitment_transaction_number_obscure_factor = <U48 as Readable>::read(reader)?.0;
3929 let destination_script = Readable::read(reader)?;
3930 let broadcasted_holder_revokable_script = match <u8 as Readable>::read(reader)? {
3932 let revokable_address = Readable::read(reader)?;
3933 let per_commitment_point = Readable::read(reader)?;
3934 let revokable_script = Readable::read(reader)?;
3935 Some((revokable_address, per_commitment_point, revokable_script))
3938 _ => return Err(DecodeError::InvalidValue),
3940 let counterparty_payment_script = Readable::read(reader)?;
3941 let shutdown_script = {
3942 let script = <Script as Readable>::read(reader)?;
3943 if script.is_empty() { None } else { Some(script) }
3946 let channel_keys_id = Readable::read(reader)?;
3947 let holder_revocation_basepoint = Readable::read(reader)?;
3948 // Technically this can fail and serialize fail a round-trip, but only for serialization of
3949 // barely-init'd ChannelMonitors that we can't do anything with.
3950 let outpoint = OutPoint {
3951 txid: Readable::read(reader)?,
3952 index: Readable::read(reader)?,
3954 let funding_info = (outpoint, Readable::read(reader)?);
3955 let current_counterparty_commitment_txid = Readable::read(reader)?;
3956 let prev_counterparty_commitment_txid = Readable::read(reader)?;
3958 let counterparty_commitment_params = Readable::read(reader)?;
3959 let funding_redeemscript = Readable::read(reader)?;
3960 let channel_value_satoshis = Readable::read(reader)?;
3962 let their_cur_per_commitment_points = {
3963 let first_idx = <U48 as Readable>::read(reader)?.0;
3967 let first_point = Readable::read(reader)?;
3968 let second_point_slice: [u8; 33] = Readable::read(reader)?;
3969 if second_point_slice[0..32] == [0; 32] && second_point_slice[32] == 0 {
3970 Some((first_idx, first_point, None))
3972 Some((first_idx, first_point, Some(unwrap_obj!(PublicKey::from_slice(&second_point_slice)))))
3977 let on_holder_tx_csv: u16 = Readable::read(reader)?;
3979 let commitment_secrets = Readable::read(reader)?;
3981 macro_rules! read_htlc_in_commitment {
3984 let offered: bool = Readable::read(reader)?;
3985 let amount_msat: u64 = Readable::read(reader)?;
3986 let cltv_expiry: u32 = Readable::read(reader)?;
3987 let payment_hash: PaymentHash = Readable::read(reader)?;
3988 let transaction_output_index: Option<u32> = Readable::read(reader)?;
3990 HTLCOutputInCommitment {
3991 offered, amount_msat, cltv_expiry, payment_hash, transaction_output_index
3997 let counterparty_claimable_outpoints_len: u64 = Readable::read(reader)?;
3998 let mut counterparty_claimable_outpoints = HashMap::with_capacity(cmp::min(counterparty_claimable_outpoints_len as usize, MAX_ALLOC_SIZE / 64));
3999 for _ in 0..counterparty_claimable_outpoints_len {
4000 let txid: Txid = Readable::read(reader)?;
4001 let htlcs_count: u64 = Readable::read(reader)?;
4002 let mut htlcs = Vec::with_capacity(cmp::min(htlcs_count as usize, MAX_ALLOC_SIZE / 32));
4003 for _ in 0..htlcs_count {
4004 htlcs.push((read_htlc_in_commitment!(), <Option<HTLCSource> as Readable>::read(reader)?.map(|o: HTLCSource| Box::new(o))));
4006 if let Some(_) = counterparty_claimable_outpoints.insert(txid, htlcs) {
4007 return Err(DecodeError::InvalidValue);
4011 let counterparty_commitment_txn_on_chain_len: u64 = Readable::read(reader)?;
4012 let mut counterparty_commitment_txn_on_chain = HashMap::with_capacity(cmp::min(counterparty_commitment_txn_on_chain_len as usize, MAX_ALLOC_SIZE / 32));
4013 for _ in 0..counterparty_commitment_txn_on_chain_len {
4014 let txid: Txid = Readable::read(reader)?;
4015 let commitment_number = <U48 as Readable>::read(reader)?.0;
4016 if let Some(_) = counterparty_commitment_txn_on_chain.insert(txid, commitment_number) {
4017 return Err(DecodeError::InvalidValue);
4021 let counterparty_hash_commitment_number_len: u64 = Readable::read(reader)?;
4022 let mut counterparty_hash_commitment_number = HashMap::with_capacity(cmp::min(counterparty_hash_commitment_number_len as usize, MAX_ALLOC_SIZE / 32));
4023 for _ in 0..counterparty_hash_commitment_number_len {
4024 let payment_hash: PaymentHash = Readable::read(reader)?;
4025 let commitment_number = <U48 as Readable>::read(reader)?.0;
4026 if let Some(_) = counterparty_hash_commitment_number.insert(payment_hash, commitment_number) {
4027 return Err(DecodeError::InvalidValue);
4031 let mut prev_holder_signed_commitment_tx: Option<HolderSignedTx> =
4032 match <u8 as Readable>::read(reader)? {
4035 Some(Readable::read(reader)?)
4037 _ => return Err(DecodeError::InvalidValue),
4039 let mut current_holder_commitment_tx: HolderSignedTx = Readable::read(reader)?;
4041 let current_counterparty_commitment_number = <U48 as Readable>::read(reader)?.0;
4042 let current_holder_commitment_number = <U48 as Readable>::read(reader)?.0;
4044 let payment_preimages_len: u64 = Readable::read(reader)?;
4045 let mut payment_preimages = HashMap::with_capacity(cmp::min(payment_preimages_len as usize, MAX_ALLOC_SIZE / 32));
4046 for _ in 0..payment_preimages_len {
4047 let preimage: PaymentPreimage = Readable::read(reader)?;
4048 let hash = PaymentHash(Sha256::hash(&preimage.0[..]).into_inner());
4049 if let Some(_) = payment_preimages.insert(hash, preimage) {
4050 return Err(DecodeError::InvalidValue);
4054 let pending_monitor_events_len: u64 = Readable::read(reader)?;
4055 let mut pending_monitor_events = Some(
4056 Vec::with_capacity(cmp::min(pending_monitor_events_len as usize, MAX_ALLOC_SIZE / (32 + 8*3))));
4057 for _ in 0..pending_monitor_events_len {
4058 let ev = match <u8 as Readable>::read(reader)? {
4059 0 => MonitorEvent::HTLCEvent(Readable::read(reader)?),
4060 1 => MonitorEvent::CommitmentTxConfirmed(funding_info.0),
4061 _ => return Err(DecodeError::InvalidValue)
4063 pending_monitor_events.as_mut().unwrap().push(ev);
4066 let pending_events_len: u64 = Readable::read(reader)?;
4067 let mut pending_events = Vec::with_capacity(cmp::min(pending_events_len as usize, MAX_ALLOC_SIZE / mem::size_of::<Event>()));
4068 for _ in 0..pending_events_len {
4069 if let Some(event) = MaybeReadable::read(reader)? {
4070 pending_events.push(event);
4074 let best_block = BestBlock::new(Readable::read(reader)?, Readable::read(reader)?);
4076 let waiting_threshold_conf_len: u64 = Readable::read(reader)?;
4077 let mut onchain_events_awaiting_threshold_conf = Vec::with_capacity(cmp::min(waiting_threshold_conf_len as usize, MAX_ALLOC_SIZE / 128));
4078 for _ in 0..waiting_threshold_conf_len {
4079 if let Some(val) = MaybeReadable::read(reader)? {
4080 onchain_events_awaiting_threshold_conf.push(val);
4084 let outputs_to_watch_len: u64 = Readable::read(reader)?;
4085 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>>())));
4086 for _ in 0..outputs_to_watch_len {
4087 let txid = Readable::read(reader)?;
4088 let outputs_len: u64 = Readable::read(reader)?;
4089 let mut outputs = Vec::with_capacity(cmp::min(outputs_len as usize, MAX_ALLOC_SIZE / (mem::size_of::<u32>() + mem::size_of::<Script>())));
4090 for _ in 0..outputs_len {
4091 outputs.push((Readable::read(reader)?, Readable::read(reader)?));
4093 if let Some(_) = outputs_to_watch.insert(txid, outputs) {
4094 return Err(DecodeError::InvalidValue);
4097 let onchain_tx_handler: OnchainTxHandler<SP::Signer> = ReadableArgs::read(
4098 reader, (entropy_source, signer_provider, channel_value_satoshis, channel_keys_id)
4101 let lockdown_from_offchain = Readable::read(reader)?;
4102 let holder_tx_signed = Readable::read(reader)?;
4104 if let Some(prev_commitment_tx) = prev_holder_signed_commitment_tx.as_mut() {
4105 let prev_holder_value = onchain_tx_handler.get_prev_holder_commitment_to_self_value();
4106 if prev_holder_value.is_none() { return Err(DecodeError::InvalidValue); }
4107 if prev_commitment_tx.to_self_value_sat == u64::max_value() {
4108 prev_commitment_tx.to_self_value_sat = prev_holder_value.unwrap();
4109 } else if prev_commitment_tx.to_self_value_sat != prev_holder_value.unwrap() {
4110 return Err(DecodeError::InvalidValue);
4114 let cur_holder_value = onchain_tx_handler.get_cur_holder_commitment_to_self_value();
4115 if current_holder_commitment_tx.to_self_value_sat == u64::max_value() {
4116 current_holder_commitment_tx.to_self_value_sat = cur_holder_value;
4117 } else if current_holder_commitment_tx.to_self_value_sat != cur_holder_value {
4118 return Err(DecodeError::InvalidValue);
4121 let mut funding_spend_confirmed = None;
4122 let mut htlcs_resolved_on_chain = Some(Vec::new());
4123 let mut funding_spend_seen = Some(false);
4124 let mut counterparty_node_id = None;
4125 let mut confirmed_commitment_tx_counterparty_output = None;
4126 let mut spendable_txids_confirmed = Some(Vec::new());
4127 let mut counterparty_fulfilled_htlcs = Some(HashMap::new());
4128 read_tlv_fields!(reader, {
4129 (1, funding_spend_confirmed, option),
4130 (3, htlcs_resolved_on_chain, optional_vec),
4131 (5, pending_monitor_events, optional_vec),
4132 (7, funding_spend_seen, option),
4133 (9, counterparty_node_id, option),
4134 (11, confirmed_commitment_tx_counterparty_output, option),
4135 (13, spendable_txids_confirmed, optional_vec),
4136 (15, counterparty_fulfilled_htlcs, option),
4139 Ok((best_block.block_hash(), ChannelMonitor::from_impl(ChannelMonitorImpl {
4141 commitment_transaction_number_obscure_factor,
4144 broadcasted_holder_revokable_script,
4145 counterparty_payment_script,
4149 holder_revocation_basepoint,
4151 current_counterparty_commitment_txid,
4152 prev_counterparty_commitment_txid,
4154 counterparty_commitment_params,
4155 funding_redeemscript,
4156 channel_value_satoshis,
4157 their_cur_per_commitment_points,
4162 counterparty_claimable_outpoints,
4163 counterparty_commitment_txn_on_chain,
4164 counterparty_hash_commitment_number,
4165 counterparty_fulfilled_htlcs: counterparty_fulfilled_htlcs.unwrap(),
4167 prev_holder_signed_commitment_tx,
4168 current_holder_commitment_tx,
4169 current_counterparty_commitment_number,
4170 current_holder_commitment_number,
4173 pending_monitor_events: pending_monitor_events.unwrap(),
4175 is_processing_pending_events: false,
4177 onchain_events_awaiting_threshold_conf,
4182 lockdown_from_offchain,
4184 funding_spend_seen: funding_spend_seen.unwrap(),
4185 funding_spend_confirmed,
4186 confirmed_commitment_tx_counterparty_output,
4187 htlcs_resolved_on_chain: htlcs_resolved_on_chain.unwrap(),
4188 spendable_txids_confirmed: spendable_txids_confirmed.unwrap(),
4191 counterparty_node_id,
4198 use bitcoin::blockdata::script::{Script, Builder};
4199 use bitcoin::blockdata::opcodes;
4200 use bitcoin::blockdata::transaction::{Transaction, TxIn, TxOut, EcdsaSighashType};
4201 use bitcoin::blockdata::transaction::OutPoint as BitcoinOutPoint;
4202 use bitcoin::util::sighash;
4203 use bitcoin::hashes::Hash;
4204 use bitcoin::hashes::sha256::Hash as Sha256;
4205 use bitcoin::hashes::hex::FromHex;
4206 use bitcoin::hash_types::{BlockHash, Txid};
4207 use bitcoin::network::constants::Network;
4208 use bitcoin::secp256k1::{SecretKey,PublicKey};
4209 use bitcoin::secp256k1::Secp256k1;
4213 use crate::chain::chaininterface::LowerBoundedFeeEstimator;
4215 use super::ChannelMonitorUpdateStep;
4216 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};
4217 use crate::chain::{BestBlock, Confirm};
4218 use crate::chain::channelmonitor::ChannelMonitor;
4219 use crate::chain::package::{weight_offered_htlc, weight_received_htlc, weight_revoked_offered_htlc, weight_revoked_received_htlc, WEIGHT_REVOKED_OUTPUT};
4220 use crate::chain::transaction::OutPoint;
4221 use crate::sign::InMemorySigner;
4222 use crate::events::ClosureReason;
4223 use crate::ln::{PaymentPreimage, PaymentHash};
4224 use crate::ln::chan_utils;
4225 use crate::ln::chan_utils::{HTLCOutputInCommitment, ChannelPublicKeys, ChannelTransactionParameters, HolderCommitmentTransaction, CounterpartyChannelTransactionParameters};
4226 use crate::ln::channelmanager::{PaymentSendFailure, PaymentId, RecipientOnionFields};
4227 use crate::ln::functional_test_utils::*;
4228 use crate::ln::script::ShutdownScript;
4229 use crate::util::errors::APIError;
4230 use crate::util::test_utils::{TestLogger, TestBroadcaster, TestFeeEstimator};
4231 use crate::util::ser::{ReadableArgs, Writeable};
4232 use crate::sync::{Arc, Mutex};
4234 use bitcoin::{PackedLockTime, Sequence, Witness};
4235 use crate::ln::features::ChannelTypeFeatures;
4236 use crate::prelude::*;
4238 fn do_test_funding_spend_refuses_updates(use_local_txn: bool) {
4239 // Previously, monitor updates were allowed freely even after a funding-spend transaction
4240 // confirmed. This would allow a race condition where we could receive a payment (including
4241 // the counterparty revoking their broadcasted state!) and accept it without recourse as
4242 // long as the ChannelMonitor receives the block first, the full commitment update dance
4243 // occurs after the block is connected, and before the ChannelManager receives the block.
4244 // Obviously this is an incredibly contrived race given the counterparty would be risking
4245 // their full channel balance for it, but its worth fixing nonetheless as it makes the
4246 // potential ChannelMonitor states simpler to reason about.
4248 // This test checks said behavior, as well as ensuring a ChannelMonitorUpdate with multiple
4249 // updates is handled correctly in such conditions.
4250 let chanmon_cfgs = create_chanmon_cfgs(3);
4251 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
4252 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
4253 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
4254 let channel = create_announced_chan_between_nodes(&nodes, 0, 1);
4255 create_announced_chan_between_nodes(&nodes, 1, 2);
4257 // Rebalance somewhat
4258 send_payment(&nodes[0], &[&nodes[1]], 10_000_000);
4260 // First route two payments for testing at the end
4261 let payment_preimage_1 = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 1_000_000).0;
4262 let payment_preimage_2 = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 1_000_000).0;
4264 let local_txn = get_local_commitment_txn!(nodes[1], channel.2);
4265 assert_eq!(local_txn.len(), 1);
4266 let remote_txn = get_local_commitment_txn!(nodes[0], channel.2);
4267 assert_eq!(remote_txn.len(), 3); // Commitment and two HTLC-Timeouts
4268 check_spends!(remote_txn[1], remote_txn[0]);
4269 check_spends!(remote_txn[2], remote_txn[0]);
4270 let broadcast_tx = if use_local_txn { &local_txn[0] } else { &remote_txn[0] };
4272 // Connect a commitment transaction, but only to the ChainMonitor/ChannelMonitor. The
4273 // channel is now closed, but the ChannelManager doesn't know that yet.
4274 let new_header = create_dummy_header(nodes[0].best_block_info().0, 0);
4275 let conf_height = nodes[0].best_block_info().1 + 1;
4276 nodes[1].chain_monitor.chain_monitor.transactions_confirmed(&new_header,
4277 &[(0, broadcast_tx)], conf_height);
4279 let (_, pre_update_monitor) = <(BlockHash, ChannelMonitor<InMemorySigner>)>::read(
4280 &mut io::Cursor::new(&get_monitor!(nodes[1], channel.2).encode()),
4281 (&nodes[1].keys_manager.backing, &nodes[1].keys_manager.backing)).unwrap();
4283 // If the ChannelManager tries to update the channel, however, the ChainMonitor will pass
4284 // the update through to the ChannelMonitor which will refuse it (as the channel is closed).
4285 let (route, payment_hash, _, payment_secret) = get_route_and_payment_hash!(nodes[1], nodes[0], 100_000);
4286 unwrap_send_err!(nodes[1].node.send_payment_with_route(&route, payment_hash,
4287 RecipientOnionFields::secret_only(payment_secret), PaymentId(payment_hash.0)
4288 ), true, APIError::ChannelUnavailable { ref err },
4289 assert!(err.contains("ChannelMonitor storage failure")));
4290 check_added_monitors!(nodes[1], 2); // After the failure we generate a close-channel monitor update
4291 check_closed_broadcast!(nodes[1], true);
4292 check_closed_event!(nodes[1], 1, ClosureReason::ProcessingError { err: "ChannelMonitor storage failure".to_string() });
4294 // Build a new ChannelMonitorUpdate which contains both the failing commitment tx update
4295 // and provides the claim preimages for the two pending HTLCs. The first update generates
4296 // an error, but the point of this test is to ensure the later updates are still applied.
4297 let monitor_updates = nodes[1].chain_monitor.monitor_updates.lock().unwrap();
4298 let mut replay_update = monitor_updates.get(&channel.2).unwrap().iter().rev().skip(1).next().unwrap().clone();
4299 assert_eq!(replay_update.updates.len(), 1);
4300 if let ChannelMonitorUpdateStep::LatestCounterpartyCommitmentTXInfo { .. } = replay_update.updates[0] {
4301 } else { panic!(); }
4302 replay_update.updates.push(ChannelMonitorUpdateStep::PaymentPreimage { payment_preimage: payment_preimage_1 });
4303 replay_update.updates.push(ChannelMonitorUpdateStep::PaymentPreimage { payment_preimage: payment_preimage_2 });
4305 let broadcaster = TestBroadcaster::with_blocks(Arc::clone(&nodes[1].blocks));
4307 pre_update_monitor.update_monitor(&replay_update, &&broadcaster, &chanmon_cfgs[1].fee_estimator, &nodes[1].logger)
4309 // Even though we error'd on the first update, we should still have generated an HTLC claim
4311 let txn_broadcasted = broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
4312 assert!(txn_broadcasted.len() >= 2);
4313 let htlc_txn = txn_broadcasted.iter().filter(|tx| {
4314 assert_eq!(tx.input.len(), 1);
4315 tx.input[0].previous_output.txid == broadcast_tx.txid()
4316 }).collect::<Vec<_>>();
4317 assert_eq!(htlc_txn.len(), 2);
4318 check_spends!(htlc_txn[0], broadcast_tx);
4319 check_spends!(htlc_txn[1], broadcast_tx);
4322 fn test_funding_spend_refuses_updates() {
4323 do_test_funding_spend_refuses_updates(true);
4324 do_test_funding_spend_refuses_updates(false);
4328 fn test_prune_preimages() {
4329 let secp_ctx = Secp256k1::new();
4330 let logger = Arc::new(TestLogger::new());
4331 let broadcaster = Arc::new(TestBroadcaster::new(Network::Testnet));
4332 let fee_estimator = TestFeeEstimator { sat_per_kw: Mutex::new(253) };
4334 let dummy_key = PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[42; 32]).unwrap());
4336 let mut preimages = Vec::new();
4339 let preimage = PaymentPreimage([i; 32]);
4340 let hash = PaymentHash(Sha256::hash(&preimage.0[..]).into_inner());
4341 preimages.push((preimage, hash));
4345 macro_rules! preimages_slice_to_htlcs {
4346 ($preimages_slice: expr) => {
4348 let mut res = Vec::new();
4349 for (idx, preimage) in $preimages_slice.iter().enumerate() {
4350 res.push((HTLCOutputInCommitment {
4354 payment_hash: preimage.1.clone(),
4355 transaction_output_index: Some(idx as u32),
4362 macro_rules! preimages_slice_to_htlc_outputs {
4363 ($preimages_slice: expr) => {
4364 preimages_slice_to_htlcs!($preimages_slice).into_iter().map(|(htlc, _)| (htlc, None)).collect()
4367 let dummy_sig = crate::util::crypto::sign(&secp_ctx,
4368 &bitcoin::secp256k1::Message::from_slice(&[42; 32]).unwrap(),
4369 &SecretKey::from_slice(&[42; 32]).unwrap());
4371 macro_rules! test_preimages_exist {
4372 ($preimages_slice: expr, $monitor: expr) => {
4373 for preimage in $preimages_slice {
4374 assert!($monitor.inner.lock().unwrap().payment_preimages.contains_key(&preimage.1));
4379 let keys = InMemorySigner::new(
4381 SecretKey::from_slice(&[41; 32]).unwrap(),
4382 SecretKey::from_slice(&[41; 32]).unwrap(),
4383 SecretKey::from_slice(&[41; 32]).unwrap(),
4384 SecretKey::from_slice(&[41; 32]).unwrap(),
4385 SecretKey::from_slice(&[41; 32]).unwrap(),
4392 let counterparty_pubkeys = ChannelPublicKeys {
4393 funding_pubkey: PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[44; 32]).unwrap()),
4394 revocation_basepoint: PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[45; 32]).unwrap()),
4395 payment_point: PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[46; 32]).unwrap()),
4396 delayed_payment_basepoint: PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[47; 32]).unwrap()),
4397 htlc_basepoint: PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[48; 32]).unwrap())
4399 let funding_outpoint = OutPoint { txid: Txid::all_zeros(), index: u16::max_value() };
4400 let channel_parameters = ChannelTransactionParameters {
4401 holder_pubkeys: keys.holder_channel_pubkeys.clone(),
4402 holder_selected_contest_delay: 66,
4403 is_outbound_from_holder: true,
4404 counterparty_parameters: Some(CounterpartyChannelTransactionParameters {
4405 pubkeys: counterparty_pubkeys,
4406 selected_contest_delay: 67,
4408 funding_outpoint: Some(funding_outpoint),
4409 channel_type_features: ChannelTypeFeatures::only_static_remote_key()
4411 // Prune with one old state and a holder commitment tx holding a few overlaps with the
4413 let shutdown_pubkey = PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[42; 32]).unwrap());
4414 let best_block = BestBlock::from_network(Network::Testnet);
4415 let monitor = ChannelMonitor::new(Secp256k1::new(), keys,
4416 Some(ShutdownScript::new_p2wpkh_from_pubkey(shutdown_pubkey).into_inner()), 0, &Script::new(),
4417 (OutPoint { txid: Txid::from_slice(&[43; 32]).unwrap(), index: 0 }, Script::new()),
4418 &channel_parameters, Script::new(), 46, 0, HolderCommitmentTransaction::dummy(&mut Vec::new()),
4419 best_block, dummy_key);
4421 let mut htlcs = preimages_slice_to_htlcs!(preimages[0..10]);
4422 let dummy_commitment_tx = HolderCommitmentTransaction::dummy(&mut htlcs);
4423 monitor.provide_latest_holder_commitment_tx(dummy_commitment_tx.clone(),
4424 htlcs.into_iter().map(|(htlc, _)| (htlc, Some(dummy_sig), None)).collect()).unwrap();
4425 monitor.provide_latest_counterparty_commitment_tx(Txid::from_inner(Sha256::hash(b"1").into_inner()),
4426 preimages_slice_to_htlc_outputs!(preimages[5..15]), 281474976710655, dummy_key, &logger);
4427 monitor.provide_latest_counterparty_commitment_tx(Txid::from_inner(Sha256::hash(b"2").into_inner()),
4428 preimages_slice_to_htlc_outputs!(preimages[15..20]), 281474976710654, dummy_key, &logger);
4429 for &(ref preimage, ref hash) in preimages.iter() {
4430 let bounded_fee_estimator = LowerBoundedFeeEstimator::new(&fee_estimator);
4431 monitor.provide_payment_preimage(hash, preimage, &broadcaster, &bounded_fee_estimator, &logger);
4434 // Now provide a secret, pruning preimages 10-15
4435 let mut secret = [0; 32];
4436 secret[0..32].clone_from_slice(&hex::decode("7cc854b54e3e0dcdb010d7a3fee464a9687be6e8db3be6854c475621e007a5dc").unwrap());
4437 monitor.provide_secret(281474976710655, secret.clone()).unwrap();
4438 assert_eq!(monitor.inner.lock().unwrap().payment_preimages.len(), 15);
4439 test_preimages_exist!(&preimages[0..10], monitor);
4440 test_preimages_exist!(&preimages[15..20], monitor);
4442 monitor.provide_latest_counterparty_commitment_tx(Txid::from_inner(Sha256::hash(b"3").into_inner()),
4443 preimages_slice_to_htlc_outputs!(preimages[17..20]), 281474976710653, dummy_key, &logger);
4445 // Now provide a further secret, pruning preimages 15-17
4446 secret[0..32].clone_from_slice(&hex::decode("c7518c8ae4660ed02894df8976fa1a3659c1a8b4b5bec0c4b872abeba4cb8964").unwrap());
4447 monitor.provide_secret(281474976710654, secret.clone()).unwrap();
4448 assert_eq!(monitor.inner.lock().unwrap().payment_preimages.len(), 13);
4449 test_preimages_exist!(&preimages[0..10], monitor);
4450 test_preimages_exist!(&preimages[17..20], monitor);
4452 monitor.provide_latest_counterparty_commitment_tx(Txid::from_inner(Sha256::hash(b"4").into_inner()),
4453 preimages_slice_to_htlc_outputs!(preimages[18..20]), 281474976710652, dummy_key, &logger);
4455 // Now update holder commitment tx info, pruning only element 18 as we still care about the
4456 // previous commitment tx's preimages too
4457 let mut htlcs = preimages_slice_to_htlcs!(preimages[0..5]);
4458 let dummy_commitment_tx = HolderCommitmentTransaction::dummy(&mut htlcs);
4459 monitor.provide_latest_holder_commitment_tx(dummy_commitment_tx.clone(),
4460 htlcs.into_iter().map(|(htlc, _)| (htlc, Some(dummy_sig), None)).collect()).unwrap();
4461 secret[0..32].clone_from_slice(&hex::decode("2273e227a5b7449b6e70f1fb4652864038b1cbf9cd7c043a7d6456b7fc275ad8").unwrap());
4462 monitor.provide_secret(281474976710653, secret.clone()).unwrap();
4463 assert_eq!(monitor.inner.lock().unwrap().payment_preimages.len(), 12);
4464 test_preimages_exist!(&preimages[0..10], monitor);
4465 test_preimages_exist!(&preimages[18..20], monitor);
4467 // But if we do it again, we'll prune 5-10
4468 let mut htlcs = preimages_slice_to_htlcs!(preimages[0..3]);
4469 let dummy_commitment_tx = HolderCommitmentTransaction::dummy(&mut htlcs);
4470 monitor.provide_latest_holder_commitment_tx(dummy_commitment_tx,
4471 htlcs.into_iter().map(|(htlc, _)| (htlc, Some(dummy_sig), None)).collect()).unwrap();
4472 secret[0..32].clone_from_slice(&hex::decode("27cddaa5624534cb6cb9d7da077cf2b22ab21e9b506fd4998a51d54502e99116").unwrap());
4473 monitor.provide_secret(281474976710652, secret.clone()).unwrap();
4474 assert_eq!(monitor.inner.lock().unwrap().payment_preimages.len(), 5);
4475 test_preimages_exist!(&preimages[0..5], monitor);
4479 fn test_claim_txn_weight_computation() {
4480 // We test Claim txn weight, knowing that we want expected weigth and
4481 // not actual case to avoid sigs and time-lock delays hell variances.
4483 let secp_ctx = Secp256k1::new();
4484 let privkey = SecretKey::from_slice(&hex::decode("0101010101010101010101010101010101010101010101010101010101010101").unwrap()[..]).unwrap();
4485 let pubkey = PublicKey::from_secret_key(&secp_ctx, &privkey);
4487 macro_rules! sign_input {
4488 ($sighash_parts: expr, $idx: expr, $amount: expr, $weight: expr, $sum_actual_sigs: expr, $opt_anchors: expr) => {
4489 let htlc = HTLCOutputInCommitment {
4490 offered: if *$weight == weight_revoked_offered_htlc($opt_anchors) || *$weight == weight_offered_htlc($opt_anchors) { true } else { false },
4492 cltv_expiry: 2 << 16,
4493 payment_hash: PaymentHash([1; 32]),
4494 transaction_output_index: Some($idx as u32),
4496 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) };
4497 let sighash = hash_to_message!(&$sighash_parts.segwit_signature_hash($idx, &redeem_script, $amount, EcdsaSighashType::All).unwrap()[..]);
4498 let sig = secp_ctx.sign_ecdsa(&sighash, &privkey);
4499 let mut ser_sig = sig.serialize_der().to_vec();
4500 ser_sig.push(EcdsaSighashType::All as u8);
4501 $sum_actual_sigs += ser_sig.len();
4502 let witness = $sighash_parts.witness_mut($idx).unwrap();
4503 witness.push(ser_sig);
4504 if *$weight == WEIGHT_REVOKED_OUTPUT {
4505 witness.push(vec!(1));
4506 } else if *$weight == weight_revoked_offered_htlc($opt_anchors) || *$weight == weight_revoked_received_htlc($opt_anchors) {
4507 witness.push(pubkey.clone().serialize().to_vec());
4508 } else if *$weight == weight_received_htlc($opt_anchors) {
4509 witness.push(vec![0]);
4511 witness.push(PaymentPreimage([1; 32]).0.to_vec());
4513 witness.push(redeem_script.into_bytes());
4514 let witness = witness.to_vec();
4515 println!("witness[0] {}", witness[0].len());
4516 println!("witness[1] {}", witness[1].len());
4517 println!("witness[2] {}", witness[2].len());
4521 let script_pubkey = Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script();
4522 let txid = Txid::from_hex("56944c5d3f98413ef45cf54545538103cc9f298e0575820ad3591376e2e0f65d").unwrap();
4524 // Justice tx with 1 to_holder, 2 revoked offered HTLCs, 1 revoked received HTLCs
4525 for channel_type_features in [ChannelTypeFeatures::only_static_remote_key(), ChannelTypeFeatures::anchors_zero_htlc_fee_and_dependencies()].iter() {
4526 let mut claim_tx = Transaction { version: 0, lock_time: PackedLockTime::ZERO, input: Vec::new(), output: Vec::new() };
4527 let mut sum_actual_sigs = 0;
4529 claim_tx.input.push(TxIn {
4530 previous_output: BitcoinOutPoint {
4534 script_sig: Script::new(),
4535 sequence: Sequence::ENABLE_RBF_NO_LOCKTIME,
4536 witness: Witness::new(),
4539 claim_tx.output.push(TxOut {
4540 script_pubkey: script_pubkey.clone(),
4543 let base_weight = claim_tx.weight();
4544 let inputs_weight = vec![WEIGHT_REVOKED_OUTPUT, weight_revoked_offered_htlc(channel_type_features), weight_revoked_offered_htlc(channel_type_features), weight_revoked_received_htlc(channel_type_features)];
4545 let mut inputs_total_weight = 2; // count segwit flags
4547 let mut sighash_parts = sighash::SighashCache::new(&mut claim_tx);
4548 for (idx, inp) in inputs_weight.iter().enumerate() {
4549 sign_input!(sighash_parts, idx, 0, inp, sum_actual_sigs, channel_type_features);
4550 inputs_total_weight += inp;
4553 assert_eq!(base_weight + inputs_total_weight as usize, claim_tx.weight() + /* max_length_sig */ (73 * inputs_weight.len() - sum_actual_sigs));
4556 // Claim tx with 1 offered HTLCs, 3 received HTLCs
4557 for channel_type_features in [ChannelTypeFeatures::only_static_remote_key(), ChannelTypeFeatures::anchors_zero_htlc_fee_and_dependencies()].iter() {
4558 let mut claim_tx = Transaction { version: 0, lock_time: PackedLockTime::ZERO, input: Vec::new(), output: Vec::new() };
4559 let mut sum_actual_sigs = 0;
4561 claim_tx.input.push(TxIn {
4562 previous_output: BitcoinOutPoint {
4566 script_sig: Script::new(),
4567 sequence: Sequence::ENABLE_RBF_NO_LOCKTIME,
4568 witness: Witness::new(),
4571 claim_tx.output.push(TxOut {
4572 script_pubkey: script_pubkey.clone(),
4575 let base_weight = claim_tx.weight();
4576 let inputs_weight = vec![weight_offered_htlc(channel_type_features), weight_received_htlc(channel_type_features), weight_received_htlc(channel_type_features), weight_received_htlc(channel_type_features)];
4577 let mut inputs_total_weight = 2; // count segwit flags
4579 let mut sighash_parts = sighash::SighashCache::new(&mut claim_tx);
4580 for (idx, inp) in inputs_weight.iter().enumerate() {
4581 sign_input!(sighash_parts, idx, 0, inp, sum_actual_sigs, channel_type_features);
4582 inputs_total_weight += inp;
4585 assert_eq!(base_weight + inputs_total_weight as usize, claim_tx.weight() + /* max_length_sig */ (73 * inputs_weight.len() - sum_actual_sigs));
4588 // Justice tx with 1 revoked HTLC-Success tx output
4589 for channel_type_features in [ChannelTypeFeatures::only_static_remote_key(), ChannelTypeFeatures::anchors_zero_htlc_fee_and_dependencies()].iter() {
4590 let mut claim_tx = Transaction { version: 0, lock_time: PackedLockTime::ZERO, input: Vec::new(), output: Vec::new() };
4591 let mut sum_actual_sigs = 0;
4592 claim_tx.input.push(TxIn {
4593 previous_output: BitcoinOutPoint {
4597 script_sig: Script::new(),
4598 sequence: Sequence::ENABLE_RBF_NO_LOCKTIME,
4599 witness: Witness::new(),
4601 claim_tx.output.push(TxOut {
4602 script_pubkey: script_pubkey.clone(),
4605 let base_weight = claim_tx.weight();
4606 let inputs_weight = vec![WEIGHT_REVOKED_OUTPUT];
4607 let mut inputs_total_weight = 2; // count segwit flags
4609 let mut sighash_parts = sighash::SighashCache::new(&mut claim_tx);
4610 for (idx, inp) in inputs_weight.iter().enumerate() {
4611 sign_input!(sighash_parts, idx, 0, inp, sum_actual_sigs, channel_type_features);
4612 inputs_total_weight += inp;
4615 assert_eq!(base_weight + inputs_total_weight as usize, claim_tx.weight() + /* max_length_isg */ (73 * inputs_weight.len() - sum_actual_sigs));
4619 // Further testing is done in the ChannelManager integration tests.