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, EcdsaSighashType};
36 use crate::ln::channel::INITIAL_COMMITMENT_NUMBER;
37 use crate::ln::{PaymentHash, PaymentPreimage};
38 use crate::ln::msgs::DecodeError;
39 use crate::ln::chan_utils;
40 use crate::ln::chan_utils::{CommitmentTransaction, CounterpartyCommitmentSecrets, HTLCOutputInCommitment, HTLCClaim, ChannelTransactionParameters, HolderCommitmentTransaction, TxCreationKeys};
41 use crate::ln::channelmanager::{HTLCSource, SentHTLCId};
43 use crate::chain::{BestBlock, WatchedOutput};
44 use crate::chain::chaininterface::{BroadcasterInterface, FeeEstimator, LowerBoundedFeeEstimator};
45 use crate::chain::transaction::{OutPoint, TransactionData};
46 use crate::sign::{SpendableOutputDescriptor, StaticPaymentOutputDescriptor, DelayedPaymentOutputDescriptor, WriteableEcdsaChannelSigner, SignerProvider, EntropySource};
47 use crate::chain::onchaintx::{ClaimEvent, OnchainTxHandler};
48 use crate::chain::package::{CounterpartyOfferedHTLCOutput, CounterpartyReceivedHTLCOutput, HolderFundingOutput, HolderHTLCOutput, PackageSolvingData, PackageTemplate, RevokedOutput, RevokedHTLCOutput};
49 use crate::chain::Filter;
50 use crate::util::logger::Logger;
51 use crate::util::ser::{Readable, ReadableArgs, RequiredWrapper, MaybeReadable, UpgradableRequired, Writer, Writeable, U48};
52 use crate::util::byte_utils;
53 use crate::events::{Event, EventHandler};
54 use crate::events::bump_transaction::{ChannelDerivationParameters, AnchorDescriptor, HTLCDescriptor, BumpTransactionEvent};
56 use crate::prelude::*;
58 use crate::io::{self, Error};
59 use core::convert::TryInto;
61 use crate::sync::{Mutex, LockTestExt};
63 /// An update generated by the underlying channel itself which contains some new information the
64 /// [`ChannelMonitor`] should be made aware of.
66 /// Because this represents only a small number of updates to the underlying state, it is generally
67 /// much smaller than a full [`ChannelMonitor`]. However, for large single commitment transaction
68 /// updates (e.g. ones during which there are hundreds of HTLCs pending on the commitment
69 /// transaction), a single update may reach upwards of 1 MiB in serialized size.
70 #[derive(Clone, Debug, PartialEq, Eq)]
72 pub struct ChannelMonitorUpdate {
73 pub(crate) updates: Vec<ChannelMonitorUpdateStep>,
74 /// The sequence number of this update. Updates *must* be replayed in-order according to this
75 /// sequence number (and updates may panic if they are not). The update_id values are strictly
76 /// increasing and increase by one for each new update, with two exceptions specified below.
78 /// This sequence number is also used to track up to which points updates which returned
79 /// [`ChannelMonitorUpdateStatus::InProgress`] have been applied to all copies of a given
80 /// ChannelMonitor when ChannelManager::channel_monitor_updated is called.
82 /// The only instances we allow where update_id values are not strictly increasing have a
83 /// special update ID of [`CLOSED_CHANNEL_UPDATE_ID`]. This update ID is used for updates that
84 /// will force close the channel by broadcasting the latest commitment transaction or
85 /// special post-force-close updates, like providing preimages necessary to claim outputs on the
86 /// broadcast commitment transaction. See its docs for more details.
88 /// [`ChannelMonitorUpdateStatus::InProgress`]: super::ChannelMonitorUpdateStatus::InProgress
92 /// The update ID used for a [`ChannelMonitorUpdate`] that is either:
94 /// (1) attempting to force close the channel by broadcasting our latest commitment transaction or
95 /// (2) providing a preimage (after the channel has been force closed) from a forward link that
96 /// allows us to spend an HTLC output on this channel's (the backward link's) broadcasted
97 /// commitment transaction.
99 /// No other [`ChannelMonitorUpdate`]s are allowed after force-close.
100 pub const CLOSED_CHANNEL_UPDATE_ID: u64 = core::u64::MAX;
102 impl Writeable for ChannelMonitorUpdate {
103 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
104 write_ver_prefix!(w, SERIALIZATION_VERSION, MIN_SERIALIZATION_VERSION);
105 self.update_id.write(w)?;
106 (self.updates.len() as u64).write(w)?;
107 for update_step in self.updates.iter() {
108 update_step.write(w)?;
110 write_tlv_fields!(w, {});
114 impl Readable for ChannelMonitorUpdate {
115 fn read<R: io::Read>(r: &mut R) -> Result<Self, DecodeError> {
116 let _ver = read_ver_prefix!(r, SERIALIZATION_VERSION);
117 let update_id: u64 = Readable::read(r)?;
118 let len: u64 = Readable::read(r)?;
119 let mut updates = Vec::with_capacity(cmp::min(len as usize, MAX_ALLOC_SIZE / ::core::mem::size_of::<ChannelMonitorUpdateStep>()));
121 if let Some(upd) = MaybeReadable::read(r)? {
125 read_tlv_fields!(r, {});
126 Ok(Self { update_id, updates })
130 /// An event to be processed by the ChannelManager.
131 #[derive(Clone, PartialEq, Eq)]
132 pub enum MonitorEvent {
133 /// A monitor event containing an HTLCUpdate.
134 HTLCEvent(HTLCUpdate),
136 /// A monitor event that the Channel's commitment transaction was confirmed.
137 CommitmentTxConfirmed(OutPoint),
139 /// Indicates a [`ChannelMonitor`] update has completed. See
140 /// [`ChannelMonitorUpdateStatus::InProgress`] for more information on how this is used.
142 /// [`ChannelMonitorUpdateStatus::InProgress`]: super::ChannelMonitorUpdateStatus::InProgress
144 /// The funding outpoint of the [`ChannelMonitor`] that was updated
145 funding_txo: OutPoint,
146 /// The Update ID from [`ChannelMonitorUpdate::update_id`] which was applied or
147 /// [`ChannelMonitor::get_latest_update_id`].
149 /// Note that this should only be set to a given update's ID if all previous updates for the
150 /// same [`ChannelMonitor`] have been applied and persisted.
151 monitor_update_id: u64,
154 /// Indicates a [`ChannelMonitor`] update has failed.
155 UpdateFailed(OutPoint),
157 impl_writeable_tlv_based_enum_upgradable!(MonitorEvent,
158 // Note that Completed and UpdateFailed are currently never serialized to disk as they are
159 // generated only in ChainMonitor
161 (0, funding_txo, required),
162 (2, monitor_update_id, required),
166 (4, CommitmentTxConfirmed),
170 /// Simple structure sent back by `chain::Watch` when an HTLC from a forward channel is detected on
171 /// chain. Used to update the corresponding HTLC in the backward channel. Failing to pass the
172 /// preimage claim backward will lead to loss of funds.
173 #[derive(Clone, PartialEq, Eq)]
174 pub struct HTLCUpdate {
175 pub(crate) payment_hash: PaymentHash,
176 pub(crate) payment_preimage: Option<PaymentPreimage>,
177 pub(crate) source: HTLCSource,
178 pub(crate) htlc_value_satoshis: Option<u64>,
180 impl_writeable_tlv_based!(HTLCUpdate, {
181 (0, payment_hash, required),
182 (1, htlc_value_satoshis, option),
183 (2, source, required),
184 (4, payment_preimage, option),
187 /// If an HTLC expires within this many blocks, don't try to claim it in a shared transaction,
188 /// instead claiming it in its own individual transaction.
189 pub(crate) const CLTV_SHARED_CLAIM_BUFFER: u32 = 12;
190 /// If an HTLC expires within this many blocks, force-close the channel to broadcast the
191 /// HTLC-Success transaction.
192 /// In other words, this is an upper bound on how many blocks we think it can take us to get a
193 /// transaction confirmed (and we use it in a few more, equivalent, places).
194 pub(crate) const CLTV_CLAIM_BUFFER: u32 = 18;
195 /// Number of blocks by which point we expect our counterparty to have seen new blocks on the
196 /// network and done a full update_fail_htlc/commitment_signed dance (+ we've updated all our
197 /// copies of ChannelMonitors, including watchtowers). We could enforce the contract by failing
198 /// at CLTV expiration height but giving a grace period to our peer may be profitable for us if he
199 /// can provide an over-late preimage. Nevertheless, grace period has to be accounted in our
200 /// CLTV_EXPIRY_DELTA to be secure. Following this policy we may decrease the rate of channel failures
201 /// due to expiration but increase the cost of funds being locked longuer in case of failure.
202 /// This delay also cover a low-power peer being slow to process blocks and so being behind us on
203 /// accurate block height.
204 /// In case of onchain failure to be pass backward we may see the last block of ANTI_REORG_DELAY
205 /// with at worst this delay, so we are not only using this value as a mercy for them but also
206 /// us as a safeguard to delay with enough time.
207 pub(crate) const LATENCY_GRACE_PERIOD_BLOCKS: u32 = 3;
208 /// Number of blocks we wait on seeing a HTLC output being solved before we fail corresponding
209 /// inbound HTLCs. This prevents us from failing backwards and then getting a reorg resulting in us
212 /// Note that this is a library-wide security assumption. If a reorg deeper than this number of
213 /// blocks occurs, counterparties may be able to steal funds or claims made by and balances exposed
214 /// by a [`ChannelMonitor`] may be incorrect.
215 // We also use this delay to be sure we can remove our in-flight claim txn from bump candidates buffer.
216 // It may cause spurious generation of bumped claim txn but that's alright given the outpoint is already
217 // solved by a previous claim tx. What we want to avoid is reorg evicting our claim tx and us not
218 // keep bumping another claim tx to solve the outpoint.
219 pub const ANTI_REORG_DELAY: u32 = 6;
220 /// Number of blocks before confirmation at which we fail back an un-relayed HTLC or at which we
221 /// refuse to accept a new HTLC.
223 /// This is used for a few separate purposes:
224 /// 1) if we've received an MPP HTLC to us and it expires within this many blocks and we are
225 /// waiting on additional parts (or waiting on the preimage for any HTLC from the user), we will
227 /// 2) if we receive an HTLC within this many blocks of its expiry (plus one to avoid a race
228 /// condition with the above), we will fail this HTLC without telling the user we received it,
230 /// (1) is all about protecting us - we need enough time to update the channel state before we hit
231 /// CLTV_CLAIM_BUFFER, at which point we'd go on chain to claim the HTLC with the preimage.
233 /// (2) is the same, but with an additional buffer to avoid accepting an HTLC which is immediately
234 /// in a race condition between the user connecting a block (which would fail it) and the user
235 /// providing us the preimage (which would claim it).
236 pub(crate) const HTLC_FAIL_BACK_BUFFER: u32 = CLTV_CLAIM_BUFFER + LATENCY_GRACE_PERIOD_BLOCKS;
238 // TODO(devrandom) replace this with HolderCommitmentTransaction
239 #[derive(Clone, PartialEq, Eq)]
240 struct HolderSignedTx {
241 /// txid of the transaction in tx, just used to make comparison faster
243 revocation_key: PublicKey,
244 a_htlc_key: PublicKey,
245 b_htlc_key: PublicKey,
246 delayed_payment_key: PublicKey,
247 per_commitment_point: PublicKey,
248 htlc_outputs: Vec<(HTLCOutputInCommitment, Option<Signature>, Option<HTLCSource>)>,
249 to_self_value_sat: u64,
252 impl_writeable_tlv_based!(HolderSignedTx, {
254 // Note that this is filled in with data from OnchainTxHandler if it's missing.
255 // For HolderSignedTx objects serialized with 0.0.100+, this should be filled in.
256 (1, to_self_value_sat, (default_value, u64::max_value())),
257 (2, revocation_key, required),
258 (4, a_htlc_key, required),
259 (6, b_htlc_key, required),
260 (8, delayed_payment_key, required),
261 (10, per_commitment_point, required),
262 (12, feerate_per_kw, required),
263 (14, htlc_outputs, required_vec)
266 impl HolderSignedTx {
267 fn non_dust_htlcs(&self) -> Vec<HTLCOutputInCommitment> {
268 self.htlc_outputs.iter().filter_map(|(htlc, _, _)| {
269 if let Some(_) = htlc.transaction_output_index {
279 /// We use this to track static counterparty commitment transaction data and to generate any
280 /// justice or 2nd-stage preimage/timeout transactions.
281 #[derive(Clone, PartialEq, Eq)]
282 struct CounterpartyCommitmentParameters {
283 counterparty_delayed_payment_base_key: PublicKey,
284 counterparty_htlc_base_key: PublicKey,
285 on_counterparty_tx_csv: u16,
288 impl Writeable for CounterpartyCommitmentParameters {
289 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
290 w.write_all(&(0 as u64).to_be_bytes())?;
291 write_tlv_fields!(w, {
292 (0, self.counterparty_delayed_payment_base_key, required),
293 (2, self.counterparty_htlc_base_key, required),
294 (4, self.on_counterparty_tx_csv, required),
299 impl Readable for CounterpartyCommitmentParameters {
300 fn read<R: io::Read>(r: &mut R) -> Result<Self, DecodeError> {
301 let counterparty_commitment_transaction = {
302 // Versions prior to 0.0.100 had some per-HTLC state stored here, which is no longer
303 // used. Read it for compatibility.
304 let per_htlc_len: u64 = Readable::read(r)?;
305 for _ in 0..per_htlc_len {
306 let _txid: Txid = Readable::read(r)?;
307 let htlcs_count: u64 = Readable::read(r)?;
308 for _ in 0..htlcs_count {
309 let _htlc: HTLCOutputInCommitment = Readable::read(r)?;
313 let mut counterparty_delayed_payment_base_key = RequiredWrapper(None);
314 let mut counterparty_htlc_base_key = RequiredWrapper(None);
315 let mut on_counterparty_tx_csv: u16 = 0;
316 read_tlv_fields!(r, {
317 (0, counterparty_delayed_payment_base_key, required),
318 (2, counterparty_htlc_base_key, required),
319 (4, on_counterparty_tx_csv, required),
321 CounterpartyCommitmentParameters {
322 counterparty_delayed_payment_base_key: counterparty_delayed_payment_base_key.0.unwrap(),
323 counterparty_htlc_base_key: counterparty_htlc_base_key.0.unwrap(),
324 on_counterparty_tx_csv,
327 Ok(counterparty_commitment_transaction)
331 /// An entry for an [`OnchainEvent`], stating the block height and hash when the event was
332 /// observed, as well as the transaction causing it.
334 /// Used to determine when the on-chain event can be considered safe from a chain reorganization.
335 #[derive(Clone, PartialEq, Eq)]
336 struct OnchainEventEntry {
339 block_hash: Option<BlockHash>, // Added as optional, will be filled in for any entry generated on 0.0.113 or after
341 transaction: Option<Transaction>, // Added as optional, but always filled in, in LDK 0.0.110
344 impl OnchainEventEntry {
345 fn confirmation_threshold(&self) -> u32 {
346 let mut conf_threshold = self.height + ANTI_REORG_DELAY - 1;
348 OnchainEvent::MaturingOutput {
349 descriptor: SpendableOutputDescriptor::DelayedPaymentOutput(ref descriptor)
351 // A CSV'd transaction is confirmable in block (input height) + CSV delay, which means
352 // it's broadcastable when we see the previous block.
353 conf_threshold = cmp::max(conf_threshold, self.height + descriptor.to_self_delay as u32 - 1);
355 OnchainEvent::FundingSpendConfirmation { on_local_output_csv: Some(csv), .. } |
356 OnchainEvent::HTLCSpendConfirmation { on_to_local_output_csv: Some(csv), .. } => {
357 // A CSV'd transaction is confirmable in block (input height) + CSV delay, which means
358 // it's broadcastable when we see the previous block.
359 conf_threshold = cmp::max(conf_threshold, self.height + csv as u32 - 1);
366 fn has_reached_confirmation_threshold(&self, best_block: &BestBlock) -> bool {
367 best_block.height() >= self.confirmation_threshold()
371 /// The (output index, sats value) for the counterparty's output in a commitment transaction.
373 /// This was added as an `Option` in 0.0.110.
374 type CommitmentTxCounterpartyOutputInfo = Option<(u32, u64)>;
376 /// Upon discovering of some classes of onchain tx by ChannelMonitor, we may have to take actions on it
377 /// once they mature to enough confirmations (ANTI_REORG_DELAY)
378 #[derive(Clone, PartialEq, Eq)]
380 /// An outbound HTLC failing after a transaction is confirmed. Used
381 /// * when an outbound HTLC output is spent by us after the HTLC timed out
382 /// * an outbound HTLC which was not present in the commitment transaction which appeared
383 /// on-chain (either because it was not fully committed to or it was dust).
384 /// Note that this is *not* used for preimage claims, as those are passed upstream immediately,
385 /// appearing only as an `HTLCSpendConfirmation`, below.
388 payment_hash: PaymentHash,
389 htlc_value_satoshis: Option<u64>,
390 /// None in the second case, above, ie when there is no relevant output in the commitment
391 /// transaction which appeared on chain.
392 commitment_tx_output_idx: Option<u32>,
394 /// An output waiting on [`ANTI_REORG_DELAY`] confirmations before we hand the user the
395 /// [`SpendableOutputDescriptor`].
397 descriptor: SpendableOutputDescriptor,
399 /// A spend of the funding output, either a commitment transaction or a cooperative closing
401 FundingSpendConfirmation {
402 /// The CSV delay for the output of the funding spend transaction (implying it is a local
403 /// commitment transaction, and this is the delay on the to_self output).
404 on_local_output_csv: Option<u16>,
405 /// If the funding spend transaction was a known remote commitment transaction, we track
406 /// the output index and amount of the counterparty's `to_self` output here.
408 /// This allows us to generate a [`Balance::CounterpartyRevokedOutputClaimable`] for the
409 /// counterparty output.
410 commitment_tx_to_counterparty_output: CommitmentTxCounterpartyOutputInfo,
412 /// A spend of a commitment transaction HTLC output, set in the cases where *no* `HTLCUpdate`
413 /// is constructed. This is used when
414 /// * an outbound HTLC is claimed by our counterparty with a preimage, causing us to
415 /// immediately claim the HTLC on the inbound edge and track the resolution here,
416 /// * an inbound HTLC is claimed by our counterparty (with a timeout),
417 /// * an inbound HTLC is claimed by us (with a preimage).
418 /// * a revoked-state HTLC transaction was broadcasted, which was claimed by the revocation
420 /// * a revoked-state HTLC transaction was broadcasted, which was claimed by an
421 /// HTLC-Success/HTLC-Failure transaction (and is still claimable with a revocation
423 HTLCSpendConfirmation {
424 commitment_tx_output_idx: u32,
425 /// If the claim was made by either party with a preimage, this is filled in
426 preimage: Option<PaymentPreimage>,
427 /// If the claim was made by us on an inbound HTLC against a local commitment transaction,
428 /// we set this to the output CSV value which we will have to wait until to spend the
429 /// output (and generate a SpendableOutput event).
430 on_to_local_output_csv: Option<u16>,
434 impl Writeable for OnchainEventEntry {
435 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
436 write_tlv_fields!(writer, {
437 (0, self.txid, required),
438 (1, self.transaction, option),
439 (2, self.height, required),
440 (3, self.block_hash, option),
441 (4, self.event, required),
447 impl MaybeReadable for OnchainEventEntry {
448 fn read<R: io::Read>(reader: &mut R) -> Result<Option<Self>, DecodeError> {
449 let mut txid = Txid::all_zeros();
450 let mut transaction = None;
451 let mut block_hash = None;
453 let mut event = UpgradableRequired(None);
454 read_tlv_fields!(reader, {
456 (1, transaction, option),
457 (2, height, required),
458 (3, block_hash, option),
459 (4, event, upgradable_required),
461 Ok(Some(Self { txid, transaction, height, block_hash, event: _init_tlv_based_struct_field!(event, upgradable_required) }))
465 impl_writeable_tlv_based_enum_upgradable!(OnchainEvent,
467 (0, source, required),
468 (1, htlc_value_satoshis, option),
469 (2, payment_hash, required),
470 (3, commitment_tx_output_idx, option),
472 (1, MaturingOutput) => {
473 (0, descriptor, required),
475 (3, FundingSpendConfirmation) => {
476 (0, on_local_output_csv, option),
477 (1, commitment_tx_to_counterparty_output, option),
479 (5, HTLCSpendConfirmation) => {
480 (0, commitment_tx_output_idx, required),
481 (2, preimage, option),
482 (4, on_to_local_output_csv, option),
487 #[derive(Clone, Debug, PartialEq, Eq)]
488 pub(crate) enum ChannelMonitorUpdateStep {
489 LatestHolderCommitmentTXInfo {
490 commitment_tx: HolderCommitmentTransaction,
491 /// Note that LDK after 0.0.115 supports this only containing dust HTLCs (implying the
492 /// `Signature` field is never filled in). At that point, non-dust HTLCs are implied by the
493 /// HTLC fields in `commitment_tx` and the sources passed via `nondust_htlc_sources`.
494 htlc_outputs: Vec<(HTLCOutputInCommitment, Option<Signature>, Option<HTLCSource>)>,
495 claimed_htlcs: Vec<(SentHTLCId, PaymentPreimage)>,
496 nondust_htlc_sources: Vec<HTLCSource>,
498 LatestCounterpartyCommitmentTXInfo {
499 commitment_txid: Txid,
500 htlc_outputs: Vec<(HTLCOutputInCommitment, Option<Box<HTLCSource>>)>,
501 commitment_number: u64,
502 their_per_commitment_point: PublicKey,
503 feerate_per_kw: Option<u32>,
504 to_broadcaster_value_sat: Option<u64>,
505 to_countersignatory_value_sat: Option<u64>,
508 payment_preimage: PaymentPreimage,
514 /// Used to indicate that the no future updates will occur, and likely that the latest holder
515 /// commitment transaction(s) should be broadcast, as the channel has been force-closed.
517 /// If set to false, we shouldn't broadcast the latest holder commitment transaction as we
518 /// think we've fallen behind!
519 should_broadcast: bool,
522 scriptpubkey: Script,
526 impl ChannelMonitorUpdateStep {
527 fn variant_name(&self) -> &'static str {
529 ChannelMonitorUpdateStep::LatestHolderCommitmentTXInfo { .. } => "LatestHolderCommitmentTXInfo",
530 ChannelMonitorUpdateStep::LatestCounterpartyCommitmentTXInfo { .. } => "LatestCounterpartyCommitmentTXInfo",
531 ChannelMonitorUpdateStep::PaymentPreimage { .. } => "PaymentPreimage",
532 ChannelMonitorUpdateStep::CommitmentSecret { .. } => "CommitmentSecret",
533 ChannelMonitorUpdateStep::ChannelForceClosed { .. } => "ChannelForceClosed",
534 ChannelMonitorUpdateStep::ShutdownScript { .. } => "ShutdownScript",
539 impl_writeable_tlv_based_enum_upgradable!(ChannelMonitorUpdateStep,
540 (0, LatestHolderCommitmentTXInfo) => {
541 (0, commitment_tx, required),
542 (1, claimed_htlcs, optional_vec),
543 (2, htlc_outputs, required_vec),
544 (4, nondust_htlc_sources, optional_vec),
546 (1, LatestCounterpartyCommitmentTXInfo) => {
547 (0, commitment_txid, required),
548 (1, feerate_per_kw, option),
549 (2, commitment_number, required),
550 (3, to_broadcaster_value_sat, option),
551 (4, their_per_commitment_point, required),
552 (5, to_countersignatory_value_sat, option),
553 (6, htlc_outputs, required_vec),
555 (2, PaymentPreimage) => {
556 (0, payment_preimage, required),
558 (3, CommitmentSecret) => {
560 (2, secret, required),
562 (4, ChannelForceClosed) => {
563 (0, should_broadcast, required),
565 (5, ShutdownScript) => {
566 (0, scriptpubkey, required),
570 /// Details about the balance(s) available for spending once the channel appears on chain.
572 /// See [`ChannelMonitor::get_claimable_balances`] for more details on when these will or will not
574 #[derive(Clone, Debug, PartialEq, Eq)]
575 #[cfg_attr(test, derive(PartialOrd, Ord))]
577 /// The channel is not yet closed (or the commitment or closing transaction has not yet
578 /// appeared in a block). The given balance is claimable (less on-chain fees) if the channel is
579 /// force-closed now.
580 ClaimableOnChannelClose {
581 /// The amount available to claim, in satoshis, excluding the on-chain fees which will be
582 /// required to do so.
583 amount_satoshis: u64,
585 /// The channel has been closed, and the given balance is ours but awaiting confirmations until
586 /// we consider it spendable.
587 ClaimableAwaitingConfirmations {
588 /// The amount available to claim, in satoshis, possibly excluding the on-chain fees which
589 /// were spent in broadcasting the transaction.
590 amount_satoshis: u64,
591 /// The height at which an [`Event::SpendableOutputs`] event will be generated for this
593 confirmation_height: u32,
595 /// The channel has been closed, and the given balance should be ours but awaiting spending
596 /// transaction confirmation. If the spending transaction does not confirm in time, it is
597 /// possible our counterparty can take the funds by broadcasting an HTLC timeout on-chain.
599 /// Once the spending transaction confirms, before it has reached enough confirmations to be
600 /// considered safe from chain reorganizations, the balance will instead be provided via
601 /// [`Balance::ClaimableAwaitingConfirmations`].
602 ContentiousClaimable {
603 /// The amount available to claim, in satoshis, excluding the on-chain fees which will be
604 /// required to do so.
605 amount_satoshis: u64,
606 /// The height at which the counterparty may be able to claim the balance if we have not
609 /// The payment hash that locks this HTLC.
610 payment_hash: PaymentHash,
611 /// The preimage that can be used to claim this HTLC.
612 payment_preimage: PaymentPreimage,
614 /// HTLCs which we sent to our counterparty which are claimable after a timeout (less on-chain
615 /// fees) if the counterparty does not know the preimage for the HTLCs. These are somewhat
616 /// likely to be claimed by our counterparty before we do.
617 MaybeTimeoutClaimableHTLC {
618 /// The amount potentially available to claim, in satoshis, excluding the on-chain fees
619 /// which will be required to do so.
620 amount_satoshis: u64,
621 /// The height at which we will be able to claim the balance if our counterparty has not
623 claimable_height: u32,
624 /// The payment hash whose preimage our counterparty needs to claim this HTLC.
625 payment_hash: PaymentHash,
627 /// HTLCs which we received from our counterparty which are claimable with a preimage which we
628 /// do not currently have. This will only be claimable if we receive the preimage from the node
629 /// to which we forwarded this HTLC before the timeout.
630 MaybePreimageClaimableHTLC {
631 /// The amount potentially available to claim, in satoshis, excluding the on-chain fees
632 /// which will be required to do so.
633 amount_satoshis: u64,
634 /// The height at which our counterparty will be able to claim the balance if we have not
635 /// yet received the preimage and claimed it ourselves.
637 /// The payment hash whose preimage we need to claim this HTLC.
638 payment_hash: PaymentHash,
640 /// The channel has been closed, and our counterparty broadcasted a revoked commitment
643 /// Thus, we're able to claim all outputs in the commitment transaction, one of which has the
644 /// following amount.
645 CounterpartyRevokedOutputClaimable {
646 /// The amount, in satoshis, of the output which we can claim.
648 /// Note that for outputs from HTLC balances this may be excluding some on-chain fees that
649 /// were already spent.
650 amount_satoshis: u64,
655 /// The amount claimable, in satoshis. This excludes balances that we are unsure if we are able
656 /// to claim, this is because we are waiting for a preimage or for a timeout to expire. For more
657 /// information on these balances see [`Balance::MaybeTimeoutClaimableHTLC`] and
658 /// [`Balance::MaybePreimageClaimableHTLC`].
660 /// On-chain fees required to claim the balance are not included in this amount.
661 pub fn claimable_amount_satoshis(&self) -> u64 {
663 Balance::ClaimableOnChannelClose { amount_satoshis, .. }|
664 Balance::ClaimableAwaitingConfirmations { amount_satoshis, .. }|
665 Balance::ContentiousClaimable { amount_satoshis, .. }|
666 Balance::CounterpartyRevokedOutputClaimable { amount_satoshis, .. }
668 Balance::MaybeTimeoutClaimableHTLC { .. }|
669 Balance::MaybePreimageClaimableHTLC { .. }
675 /// An HTLC which has been irrevocably resolved on-chain, and has reached ANTI_REORG_DELAY.
676 #[derive(Clone, PartialEq, Eq)]
677 struct IrrevocablyResolvedHTLC {
678 commitment_tx_output_idx: Option<u32>,
679 /// The txid of the transaction which resolved the HTLC, this may be a commitment (if the HTLC
680 /// was not present in the confirmed commitment transaction), HTLC-Success, or HTLC-Timeout
682 resolving_txid: Option<Txid>, // Added as optional, but always filled in, in 0.0.110
683 resolving_tx: Option<Transaction>,
684 /// Only set if the HTLC claim was ours using a payment preimage
685 payment_preimage: Option<PaymentPreimage>,
688 // In LDK versions prior to 0.0.111 commitment_tx_output_idx was not Option-al and
689 // IrrevocablyResolvedHTLC objects only existed for non-dust HTLCs. This was a bug, but to maintain
690 // backwards compatibility we must ensure we always write out a commitment_tx_output_idx field,
691 // using `u32::max_value()` as a sentinal to indicate the HTLC was dust.
692 impl Writeable for IrrevocablyResolvedHTLC {
693 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
694 let mapped_commitment_tx_output_idx = self.commitment_tx_output_idx.unwrap_or(u32::max_value());
695 write_tlv_fields!(writer, {
696 (0, mapped_commitment_tx_output_idx, required),
697 (1, self.resolving_txid, option),
698 (2, self.payment_preimage, option),
699 (3, self.resolving_tx, option),
705 impl Readable for IrrevocablyResolvedHTLC {
706 fn read<R: io::Read>(reader: &mut R) -> Result<Self, DecodeError> {
707 let mut mapped_commitment_tx_output_idx = 0;
708 let mut resolving_txid = None;
709 let mut payment_preimage = None;
710 let mut resolving_tx = None;
711 read_tlv_fields!(reader, {
712 (0, mapped_commitment_tx_output_idx, required),
713 (1, resolving_txid, option),
714 (2, payment_preimage, option),
715 (3, resolving_tx, option),
718 commitment_tx_output_idx: if mapped_commitment_tx_output_idx == u32::max_value() { None } else { Some(mapped_commitment_tx_output_idx) },
726 /// A ChannelMonitor handles chain events (blocks connected and disconnected) and generates
727 /// on-chain transactions to ensure no loss of funds occurs.
729 /// You MUST ensure that no ChannelMonitors for a given channel anywhere contain out-of-date
730 /// information and are actively monitoring the chain.
732 /// Note that the deserializer is only implemented for (BlockHash, ChannelMonitor), which
733 /// tells you the last block hash which was block_connect()ed. You MUST rescan any blocks along
734 /// the "reorg path" (ie disconnecting blocks until you find a common ancestor from both the
735 /// returned block hash and the the current chain and then reconnecting blocks to get to the
736 /// best chain) upon deserializing the object!
737 pub struct ChannelMonitor<Signer: WriteableEcdsaChannelSigner> {
739 pub(crate) inner: Mutex<ChannelMonitorImpl<Signer>>,
741 pub(super) inner: Mutex<ChannelMonitorImpl<Signer>>,
744 impl<Signer: WriteableEcdsaChannelSigner> Clone for ChannelMonitor<Signer> where Signer: Clone {
745 fn clone(&self) -> Self {
746 let inner = self.inner.lock().unwrap().clone();
747 ChannelMonitor::from_impl(inner)
751 #[derive(Clone, PartialEq)]
752 pub(crate) struct ChannelMonitorImpl<Signer: WriteableEcdsaChannelSigner> {
753 latest_update_id: u64,
754 commitment_transaction_number_obscure_factor: u64,
756 destination_script: Script,
757 broadcasted_holder_revokable_script: Option<(Script, PublicKey, PublicKey)>,
758 counterparty_payment_script: Script,
759 shutdown_script: Option<Script>,
761 channel_keys_id: [u8; 32],
762 holder_revocation_basepoint: PublicKey,
763 funding_info: (OutPoint, Script),
764 current_counterparty_commitment_txid: Option<Txid>,
765 prev_counterparty_commitment_txid: Option<Txid>,
767 counterparty_commitment_params: CounterpartyCommitmentParameters,
768 funding_redeemscript: Script,
769 channel_value_satoshis: u64,
770 // first is the idx of the first of the two per-commitment points
771 their_cur_per_commitment_points: Option<(u64, PublicKey, Option<PublicKey>)>,
773 on_holder_tx_csv: u16,
775 commitment_secrets: CounterpartyCommitmentSecrets,
776 /// The set of outpoints in each counterparty commitment transaction. We always need at least
777 /// the payment hash from `HTLCOutputInCommitment` to claim even a revoked commitment
778 /// transaction broadcast as we need to be able to construct the witness script in all cases.
779 counterparty_claimable_outpoints: HashMap<Txid, Vec<(HTLCOutputInCommitment, Option<Box<HTLCSource>>)>>,
780 /// We cannot identify HTLC-Success or HTLC-Timeout transactions by themselves on the chain.
781 /// Nor can we figure out their commitment numbers without the commitment transaction they are
782 /// spending. Thus, in order to claim them via revocation key, we track all the counterparty
783 /// commitment transactions which we find on-chain, mapping them to the commitment number which
784 /// can be used to derive the revocation key and claim the transactions.
785 counterparty_commitment_txn_on_chain: HashMap<Txid, u64>,
786 /// Cache used to make pruning of payment_preimages faster.
787 /// Maps payment_hash values to commitment numbers for counterparty transactions for non-revoked
788 /// counterparty transactions (ie should remain pretty small).
789 /// Serialized to disk but should generally not be sent to Watchtowers.
790 counterparty_hash_commitment_number: HashMap<PaymentHash, u64>,
792 counterparty_fulfilled_htlcs: HashMap<SentHTLCId, PaymentPreimage>,
794 // We store two holder commitment transactions to avoid any race conditions where we may update
795 // some monitors (potentially on watchtowers) but then fail to update others, resulting in the
796 // various monitors for one channel being out of sync, and us broadcasting a holder
797 // transaction for which we have deleted claim information on some watchtowers.
798 prev_holder_signed_commitment_tx: Option<HolderSignedTx>,
799 current_holder_commitment_tx: HolderSignedTx,
801 // Used just for ChannelManager to make sure it has the latest channel data during
803 current_counterparty_commitment_number: u64,
804 // Used just for ChannelManager to make sure it has the latest channel data during
806 current_holder_commitment_number: u64,
808 /// The set of payment hashes from inbound payments for which we know the preimage. Payment
809 /// preimages that are not included in any unrevoked local commitment transaction or unrevoked
810 /// remote commitment transactions are automatically removed when commitment transactions are
812 payment_preimages: HashMap<PaymentHash, PaymentPreimage>,
814 // Note that `MonitorEvent`s MUST NOT be generated during update processing, only generated
815 // during chain data processing. This prevents a race in `ChainMonitor::update_channel` (and
816 // presumably user implementations thereof as well) where we update the in-memory channel
817 // object, then before the persistence finishes (as it's all under a read-lock), we return
818 // pending events to the user or to the relevant `ChannelManager`. Then, on reload, we'll have
819 // the pre-event state here, but have processed the event in the `ChannelManager`.
820 // Note that because the `event_lock` in `ChainMonitor` is only taken in
821 // block/transaction-connected events and *not* during block/transaction-disconnected events,
822 // we further MUST NOT generate events during block/transaction-disconnection.
823 pending_monitor_events: Vec<MonitorEvent>,
825 pub(super) pending_events: Vec<Event>,
826 pub(super) is_processing_pending_events: bool,
828 // Used to track on-chain events (i.e., transactions part of channels confirmed on chain) on
829 // which to take actions once they reach enough confirmations. Each entry includes the
830 // transaction's id and the height when the transaction was confirmed on chain.
831 onchain_events_awaiting_threshold_conf: Vec<OnchainEventEntry>,
833 // If we get serialized out and re-read, we need to make sure that the chain monitoring
834 // interface knows about the TXOs that we want to be notified of spends of. We could probably
835 // be smart and derive them from the above storage fields, but its much simpler and more
836 // Obviously Correct (tm) if we just keep track of them explicitly.
837 outputs_to_watch: HashMap<Txid, Vec<(u32, Script)>>,
840 pub onchain_tx_handler: OnchainTxHandler<Signer>,
842 onchain_tx_handler: OnchainTxHandler<Signer>,
844 // This is set when the Channel[Manager] generated a ChannelMonitorUpdate which indicated the
845 // channel has been force-closed. After this is set, no further holder commitment transaction
846 // updates may occur, and we panic!() if one is provided.
847 lockdown_from_offchain: bool,
849 // Set once we've signed a holder commitment transaction and handed it over to our
850 // OnchainTxHandler. After this is set, no future updates to our holder commitment transactions
851 // may occur, and we fail any such monitor updates.
853 // In case of update rejection due to a locally already signed commitment transaction, we
854 // nevertheless store update content to track in case of concurrent broadcast by another
855 // remote monitor out-of-order with regards to the block view.
856 holder_tx_signed: bool,
858 // If a spend of the funding output is seen, we set this to true and reject any further
859 // updates. This prevents any further changes in the offchain state no matter the order
860 // of block connection between ChannelMonitors and the ChannelManager.
861 funding_spend_seen: bool,
863 /// Set to `Some` of the confirmed transaction spending the funding input of the channel after
864 /// reaching `ANTI_REORG_DELAY` confirmations.
865 funding_spend_confirmed: Option<Txid>,
867 confirmed_commitment_tx_counterparty_output: CommitmentTxCounterpartyOutputInfo,
868 /// The set of HTLCs which have been either claimed or failed on chain and have reached
869 /// the requisite confirmations on the claim/fail transaction (either ANTI_REORG_DELAY or the
870 /// spending CSV for revocable outputs).
871 htlcs_resolved_on_chain: Vec<IrrevocablyResolvedHTLC>,
873 /// The set of `SpendableOutput` events which we have already passed upstream to be claimed.
874 /// These are tracked explicitly to ensure that we don't generate the same events redundantly
875 /// if users duplicatively confirm old transactions. Specifically for transactions claiming a
876 /// revoked remote outpoint we otherwise have no tracking at all once they've reached
877 /// [`ANTI_REORG_DELAY`], so we have to track them here.
878 spendable_txids_confirmed: Vec<Txid>,
880 // We simply modify best_block in Channel's block_connected so that serialization is
881 // consistent but hopefully the users' copy handles block_connected in a consistent way.
882 // (we do *not*, however, update them in update_monitor to ensure any local user copies keep
883 // their best_block from its state and not based on updated copies that didn't run through
884 // the full block_connected).
885 best_block: BestBlock,
887 /// The node_id of our counterparty
888 counterparty_node_id: Option<PublicKey>,
890 /// Initial counterparty commmitment data needed to recreate the commitment tx
891 /// in the persistence pipeline for third-party watchtowers. This will only be present on
892 /// monitors created after 0.0.117.
894 /// Ordering of tuple data: (their_per_commitment_point, feerate_per_kw, to_broadcaster_sats,
895 /// to_countersignatory_sats)
896 initial_counterparty_commitment_info: Option<(PublicKey, u32, u64, u64)>,
899 /// Transaction outputs to watch for on-chain spends.
900 pub type TransactionOutputs = (Txid, Vec<(u32, TxOut)>);
902 impl<Signer: WriteableEcdsaChannelSigner> PartialEq for ChannelMonitor<Signer> where Signer: PartialEq {
903 fn eq(&self, other: &Self) -> bool {
904 // We need some kind of total lockorder. Absent a better idea, we sort by position in
905 // memory and take locks in that order (assuming that we can't move within memory while a
907 let ord = ((self as *const _) as usize) < ((other as *const _) as usize);
908 let a = if ord { self.inner.unsafe_well_ordered_double_lock_self() } else { other.inner.unsafe_well_ordered_double_lock_self() };
909 let b = if ord { other.inner.unsafe_well_ordered_double_lock_self() } else { self.inner.unsafe_well_ordered_double_lock_self() };
914 impl<Signer: WriteableEcdsaChannelSigner> Writeable for ChannelMonitor<Signer> {
915 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), Error> {
916 self.inner.lock().unwrap().write(writer)
920 // These are also used for ChannelMonitorUpdate, above.
921 const SERIALIZATION_VERSION: u8 = 1;
922 const MIN_SERIALIZATION_VERSION: u8 = 1;
924 impl<Signer: WriteableEcdsaChannelSigner> Writeable for ChannelMonitorImpl<Signer> {
925 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), Error> {
926 write_ver_prefix!(writer, SERIALIZATION_VERSION, MIN_SERIALIZATION_VERSION);
928 self.latest_update_id.write(writer)?;
930 // Set in initial Channel-object creation, so should always be set by now:
931 U48(self.commitment_transaction_number_obscure_factor).write(writer)?;
933 self.destination_script.write(writer)?;
934 if let Some(ref broadcasted_holder_revokable_script) = self.broadcasted_holder_revokable_script {
935 writer.write_all(&[0; 1])?;
936 broadcasted_holder_revokable_script.0.write(writer)?;
937 broadcasted_holder_revokable_script.1.write(writer)?;
938 broadcasted_holder_revokable_script.2.write(writer)?;
940 writer.write_all(&[1; 1])?;
943 self.counterparty_payment_script.write(writer)?;
944 match &self.shutdown_script {
945 Some(script) => script.write(writer)?,
946 None => Script::new().write(writer)?,
949 self.channel_keys_id.write(writer)?;
950 self.holder_revocation_basepoint.write(writer)?;
951 writer.write_all(&self.funding_info.0.txid[..])?;
952 writer.write_all(&self.funding_info.0.index.to_be_bytes())?;
953 self.funding_info.1.write(writer)?;
954 self.current_counterparty_commitment_txid.write(writer)?;
955 self.prev_counterparty_commitment_txid.write(writer)?;
957 self.counterparty_commitment_params.write(writer)?;
958 self.funding_redeemscript.write(writer)?;
959 self.channel_value_satoshis.write(writer)?;
961 match self.their_cur_per_commitment_points {
962 Some((idx, pubkey, second_option)) => {
963 writer.write_all(&byte_utils::be48_to_array(idx))?;
964 writer.write_all(&pubkey.serialize())?;
965 match second_option {
966 Some(second_pubkey) => {
967 writer.write_all(&second_pubkey.serialize())?;
970 writer.write_all(&[0; 33])?;
975 writer.write_all(&byte_utils::be48_to_array(0))?;
979 writer.write_all(&self.on_holder_tx_csv.to_be_bytes())?;
981 self.commitment_secrets.write(writer)?;
983 macro_rules! serialize_htlc_in_commitment {
984 ($htlc_output: expr) => {
985 writer.write_all(&[$htlc_output.offered as u8; 1])?;
986 writer.write_all(&$htlc_output.amount_msat.to_be_bytes())?;
987 writer.write_all(&$htlc_output.cltv_expiry.to_be_bytes())?;
988 writer.write_all(&$htlc_output.payment_hash.0[..])?;
989 $htlc_output.transaction_output_index.write(writer)?;
993 writer.write_all(&(self.counterparty_claimable_outpoints.len() as u64).to_be_bytes())?;
994 for (ref txid, ref htlc_infos) in self.counterparty_claimable_outpoints.iter() {
995 writer.write_all(&txid[..])?;
996 writer.write_all(&(htlc_infos.len() as u64).to_be_bytes())?;
997 for &(ref htlc_output, ref htlc_source) in htlc_infos.iter() {
998 debug_assert!(htlc_source.is_none() || Some(**txid) == self.current_counterparty_commitment_txid
999 || Some(**txid) == self.prev_counterparty_commitment_txid,
1000 "HTLC Sources for all revoked commitment transactions should be none!");
1001 serialize_htlc_in_commitment!(htlc_output);
1002 htlc_source.as_ref().map(|b| b.as_ref()).write(writer)?;
1006 writer.write_all(&(self.counterparty_commitment_txn_on_chain.len() as u64).to_be_bytes())?;
1007 for (ref txid, commitment_number) in self.counterparty_commitment_txn_on_chain.iter() {
1008 writer.write_all(&txid[..])?;
1009 writer.write_all(&byte_utils::be48_to_array(*commitment_number))?;
1012 writer.write_all(&(self.counterparty_hash_commitment_number.len() as u64).to_be_bytes())?;
1013 for (ref payment_hash, commitment_number) in self.counterparty_hash_commitment_number.iter() {
1014 writer.write_all(&payment_hash.0[..])?;
1015 writer.write_all(&byte_utils::be48_to_array(*commitment_number))?;
1018 if let Some(ref prev_holder_tx) = self.prev_holder_signed_commitment_tx {
1019 writer.write_all(&[1; 1])?;
1020 prev_holder_tx.write(writer)?;
1022 writer.write_all(&[0; 1])?;
1025 self.current_holder_commitment_tx.write(writer)?;
1027 writer.write_all(&byte_utils::be48_to_array(self.current_counterparty_commitment_number))?;
1028 writer.write_all(&byte_utils::be48_to_array(self.current_holder_commitment_number))?;
1030 writer.write_all(&(self.payment_preimages.len() as u64).to_be_bytes())?;
1031 for payment_preimage in self.payment_preimages.values() {
1032 writer.write_all(&payment_preimage.0[..])?;
1035 writer.write_all(&(self.pending_monitor_events.iter().filter(|ev| match ev {
1036 MonitorEvent::HTLCEvent(_) => true,
1037 MonitorEvent::CommitmentTxConfirmed(_) => true,
1039 }).count() as u64).to_be_bytes())?;
1040 for event in self.pending_monitor_events.iter() {
1042 MonitorEvent::HTLCEvent(upd) => {
1046 MonitorEvent::CommitmentTxConfirmed(_) => 1u8.write(writer)?,
1047 _ => {}, // Covered in the TLV writes below
1051 writer.write_all(&(self.pending_events.len() as u64).to_be_bytes())?;
1052 for event in self.pending_events.iter() {
1053 event.write(writer)?;
1056 self.best_block.block_hash().write(writer)?;
1057 writer.write_all(&self.best_block.height().to_be_bytes())?;
1059 writer.write_all(&(self.onchain_events_awaiting_threshold_conf.len() as u64).to_be_bytes())?;
1060 for ref entry in self.onchain_events_awaiting_threshold_conf.iter() {
1061 entry.write(writer)?;
1064 (self.outputs_to_watch.len() as u64).write(writer)?;
1065 for (txid, idx_scripts) in self.outputs_to_watch.iter() {
1066 txid.write(writer)?;
1067 (idx_scripts.len() as u64).write(writer)?;
1068 for (idx, script) in idx_scripts.iter() {
1070 script.write(writer)?;
1073 self.onchain_tx_handler.write(writer)?;
1075 self.lockdown_from_offchain.write(writer)?;
1076 self.holder_tx_signed.write(writer)?;
1078 write_tlv_fields!(writer, {
1079 (1, self.funding_spend_confirmed, option),
1080 (3, self.htlcs_resolved_on_chain, required_vec),
1081 (5, self.pending_monitor_events, required_vec),
1082 (7, self.funding_spend_seen, required),
1083 (9, self.counterparty_node_id, option),
1084 (11, self.confirmed_commitment_tx_counterparty_output, option),
1085 (13, self.spendable_txids_confirmed, required_vec),
1086 (15, self.counterparty_fulfilled_htlcs, required),
1087 (17, self.initial_counterparty_commitment_info, option),
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),
1238 initial_counterparty_commitment_info: None,
1243 fn provide_secret(&self, idx: u64, secret: [u8; 32]) -> Result<(), &'static str> {
1244 self.inner.lock().unwrap().provide_secret(idx, secret)
1247 /// A variant of `Self::provide_latest_counterparty_commitment_tx` used to provide
1248 /// additional information to the monitor to store in order to recreate the initial
1249 /// counterparty commitment transaction during persistence (mainly for use in third-party
1252 /// This is used to provide the counterparty commitment information directly to the monitor
1253 /// before the initial persistence of a new channel.
1254 pub(crate) fn provide_initial_counterparty_commitment_tx<L: Deref>(
1255 &self, txid: Txid, htlc_outputs: Vec<(HTLCOutputInCommitment, Option<Box<HTLCSource>>)>,
1256 commitment_number: u64, their_cur_per_commitment_point: PublicKey, feerate_per_kw: u32,
1257 to_broadcaster_value_sat: u64, to_countersignatory_value_sat: u64, logger: &L,
1259 where L::Target: Logger
1261 self.inner.lock().unwrap().provide_initial_counterparty_commitment_tx(txid,
1262 htlc_outputs, commitment_number, their_cur_per_commitment_point, feerate_per_kw,
1263 to_broadcaster_value_sat, to_countersignatory_value_sat, logger);
1266 /// Informs this monitor of the latest counterparty (ie non-broadcastable) commitment transaction.
1267 /// The monitor watches for it to be broadcasted and then uses the HTLC information (and
1268 /// possibly future revocation/preimage information) to claim outputs where possible.
1269 /// We cache also the mapping hash:commitment number to lighten pruning of old preimages by watchtowers.
1271 fn provide_latest_counterparty_commitment_tx<L: Deref>(
1274 htlc_outputs: Vec<(HTLCOutputInCommitment, Option<Box<HTLCSource>>)>,
1275 commitment_number: u64,
1276 their_per_commitment_point: PublicKey,
1278 ) where L::Target: Logger {
1279 self.inner.lock().unwrap().provide_latest_counterparty_commitment_tx(
1280 txid, htlc_outputs, commitment_number, their_per_commitment_point, logger)
1284 fn provide_latest_holder_commitment_tx(
1285 &self, holder_commitment_tx: HolderCommitmentTransaction,
1286 htlc_outputs: Vec<(HTLCOutputInCommitment, Option<Signature>, Option<HTLCSource>)>,
1287 ) -> Result<(), ()> {
1288 self.inner.lock().unwrap().provide_latest_holder_commitment_tx(holder_commitment_tx, htlc_outputs, &Vec::new(), Vec::new()).map_err(|_| ())
1291 /// This is used to provide payment preimage(s) out-of-band during startup without updating the
1292 /// off-chain state with a new commitment transaction.
1293 pub(crate) fn provide_payment_preimage<B: Deref, F: Deref, L: Deref>(
1295 payment_hash: &PaymentHash,
1296 payment_preimage: &PaymentPreimage,
1298 fee_estimator: &LowerBoundedFeeEstimator<F>,
1301 B::Target: BroadcasterInterface,
1302 F::Target: FeeEstimator,
1305 self.inner.lock().unwrap().provide_payment_preimage(
1306 payment_hash, payment_preimage, broadcaster, fee_estimator, logger)
1309 /// Updates a ChannelMonitor on the basis of some new information provided by the Channel
1312 /// panics if the given update is not the next update by update_id.
1313 pub fn update_monitor<B: Deref, F: Deref, L: Deref>(
1315 updates: &ChannelMonitorUpdate,
1321 B::Target: BroadcasterInterface,
1322 F::Target: FeeEstimator,
1325 self.inner.lock().unwrap().update_monitor(updates, broadcaster, fee_estimator, logger)
1328 /// Gets the update_id from the latest ChannelMonitorUpdate which was applied to this
1330 pub fn get_latest_update_id(&self) -> u64 {
1331 self.inner.lock().unwrap().get_latest_update_id()
1334 /// Gets the funding transaction outpoint of the channel this ChannelMonitor is monitoring for.
1335 pub fn get_funding_txo(&self) -> (OutPoint, Script) {
1336 self.inner.lock().unwrap().get_funding_txo().clone()
1339 /// Gets a list of txids, with their output scripts (in the order they appear in the
1340 /// transaction), which we must learn about spends of via block_connected().
1341 pub fn get_outputs_to_watch(&self) -> Vec<(Txid, Vec<(u32, Script)>)> {
1342 self.inner.lock().unwrap().get_outputs_to_watch()
1343 .iter().map(|(txid, outputs)| (*txid, outputs.clone())).collect()
1346 /// Loads the funding txo and outputs to watch into the given `chain::Filter` by repeatedly
1347 /// calling `chain::Filter::register_output` and `chain::Filter::register_tx` until all outputs
1348 /// have been registered.
1349 pub fn load_outputs_to_watch<F: Deref>(&self, filter: &F) where F::Target: chain::Filter {
1350 let lock = self.inner.lock().unwrap();
1351 filter.register_tx(&lock.get_funding_txo().0.txid, &lock.get_funding_txo().1);
1352 for (txid, outputs) in lock.get_outputs_to_watch().iter() {
1353 for (index, script_pubkey) in outputs.iter() {
1354 assert!(*index <= u16::max_value() as u32);
1355 filter.register_output(WatchedOutput {
1357 outpoint: OutPoint { txid: *txid, index: *index as u16 },
1358 script_pubkey: script_pubkey.clone(),
1364 /// Get the list of HTLCs who's status has been updated on chain. This should be called by
1365 /// ChannelManager via [`chain::Watch::release_pending_monitor_events`].
1366 pub fn get_and_clear_pending_monitor_events(&self) -> Vec<MonitorEvent> {
1367 self.inner.lock().unwrap().get_and_clear_pending_monitor_events()
1370 /// Processes [`SpendableOutputs`] events produced from each [`ChannelMonitor`] upon maturity.
1372 /// For channels featuring anchor outputs, this method will also process [`BumpTransaction`]
1373 /// events produced from each [`ChannelMonitor`] while there is a balance to claim onchain
1374 /// within each channel. As the confirmation of a commitment transaction may be critical to the
1375 /// safety of funds, we recommend invoking this every 30 seconds, or lower if running in an
1376 /// environment with spotty connections, like on mobile.
1378 /// An [`EventHandler`] may safely call back to the provider, though this shouldn't be needed in
1379 /// order to handle these events.
1381 /// [`SpendableOutputs`]: crate::events::Event::SpendableOutputs
1382 /// [`BumpTransaction`]: crate::events::Event::BumpTransaction
1383 pub fn process_pending_events<H: Deref>(&self, handler: &H) where H::Target: EventHandler {
1385 process_events_body!(Some(self), ev, handler.handle_event(ev));
1388 /// Processes any events asynchronously.
1390 /// See [`Self::process_pending_events`] for more information.
1391 pub async fn process_pending_events_async<Future: core::future::Future, H: Fn(Event) -> Future>(
1395 process_events_body!(Some(self), ev, { handler(ev).await });
1399 pub fn get_and_clear_pending_events(&self) -> Vec<Event> {
1400 let mut ret = Vec::new();
1401 let mut lck = self.inner.lock().unwrap();
1402 mem::swap(&mut ret, &mut lck.pending_events);
1403 ret.append(&mut lck.get_repeated_events());
1407 /// Gets the counterparty's initial commitment transaction. The returned commitment
1408 /// transaction is unsigned. This is intended to be called during the initial persistence of
1409 /// the monitor (inside an implementation of [`Persist::persist_new_channel`]), to allow for
1410 /// watchtowers in the persistence pipeline to have enough data to form justice transactions.
1412 /// This is similar to [`Self::counterparty_commitment_txs_from_update`], except
1413 /// that for the initial commitment transaction, we don't have a corresponding update.
1415 /// This will only return `Some` for channel monitors that have been created after upgrading
1416 /// to LDK 0.0.117+.
1418 /// [`Persist::persist_new_channel`]: crate::chain::chainmonitor::Persist::persist_new_channel
1419 pub fn initial_counterparty_commitment_tx(&self) -> Option<CommitmentTransaction> {
1420 self.inner.lock().unwrap().initial_counterparty_commitment_tx()
1423 /// Gets all of the counterparty commitment transactions provided by the given update. This
1424 /// may be empty if the update doesn't include any new counterparty commitments. Returned
1425 /// commitment transactions are unsigned.
1427 /// This is provided so that watchtower clients in the persistence pipeline are able to build
1428 /// justice transactions for each counterparty commitment upon each update. It's intended to be
1429 /// used within an implementation of [`Persist::update_persisted_channel`], which is provided
1430 /// with a monitor and an update. Once revoked, signing a justice transaction can be done using
1431 /// [`Self::sign_to_local_justice_tx`].
1433 /// It is expected that a watchtower client may use this method to retrieve the latest counterparty
1434 /// commitment transaction(s), and then hold the necessary data until a later update in which
1435 /// the monitor has been updated with the corresponding revocation data, at which point the
1436 /// monitor can sign the justice transaction.
1438 /// This will only return a non-empty list for monitor updates that have been created after
1439 /// upgrading to LDK 0.0.117+. Note that no restriction lies on the monitors themselves, which
1440 /// may have been created prior to upgrading.
1442 /// [`Persist::update_persisted_channel`]: crate::chain::chainmonitor::Persist::update_persisted_channel
1443 pub fn counterparty_commitment_txs_from_update(&self, update: &ChannelMonitorUpdate) -> Vec<CommitmentTransaction> {
1444 self.inner.lock().unwrap().counterparty_commitment_txs_from_update(update)
1447 /// Wrapper around [`EcdsaChannelSigner::sign_justice_revoked_output`] to make
1448 /// signing the justice transaction easier for implementors of
1449 /// [`chain::chainmonitor::Persist`]. On success this method returns the provided transaction
1450 /// signing the input at `input_idx`. This method will only produce a valid signature for
1451 /// a transaction spending the `to_local` output of a commitment transaction, i.e. this cannot
1452 /// be used for revoked HTLC outputs.
1454 /// `Value` is the value of the output being spent by the input at `input_idx`, committed
1455 /// in the BIP 143 signature.
1457 /// This method will only succeed if this monitor has received the revocation secret for the
1458 /// provided `commitment_number`. If a commitment number is provided that does not correspond
1459 /// to the commitment transaction being revoked, this will return a signed transaction, but
1460 /// the signature will not be valid.
1462 /// [`EcdsaChannelSigner::sign_justice_revoked_output`]: crate::sign::EcdsaChannelSigner::sign_justice_revoked_output
1463 /// [`Persist`]: crate::chain::chainmonitor::Persist
1464 pub fn sign_to_local_justice_tx(&self, justice_tx: Transaction, input_idx: usize, value: u64, commitment_number: u64) -> Result<Transaction, ()> {
1465 self.inner.lock().unwrap().sign_to_local_justice_tx(justice_tx, input_idx, value, commitment_number)
1468 pub(crate) fn get_min_seen_secret(&self) -> u64 {
1469 self.inner.lock().unwrap().get_min_seen_secret()
1472 pub(crate) fn get_cur_counterparty_commitment_number(&self) -> u64 {
1473 self.inner.lock().unwrap().get_cur_counterparty_commitment_number()
1476 pub(crate) fn get_cur_holder_commitment_number(&self) -> u64 {
1477 self.inner.lock().unwrap().get_cur_holder_commitment_number()
1480 /// Gets the `node_id` of the counterparty for this channel.
1482 /// Will be `None` for channels constructed on LDK versions prior to 0.0.110 and always `Some`
1484 pub fn get_counterparty_node_id(&self) -> Option<PublicKey> {
1485 self.inner.lock().unwrap().counterparty_node_id
1488 /// Used by [`ChannelManager`] deserialization to broadcast the latest holder state if its copy
1489 /// of the channel state was out-of-date.
1491 /// You may also use this to broadcast the latest local commitment transaction, either because
1492 /// a monitor update failed or because we've fallen behind (i.e. we've received proof that our
1493 /// counterparty side knows a revocation secret we gave them that they shouldn't know).
1495 /// Broadcasting these transactions in the second case is UNSAFE, as they allow counterparty
1496 /// side to punish you. Nevertheless you may want to broadcast them if counterparty doesn't
1497 /// close channel with their commitment transaction after a substantial amount of time. Best
1498 /// may be to contact the other node operator out-of-band to coordinate other options available
1501 /// [`ChannelManager`]: crate::ln::channelmanager::ChannelManager
1502 pub fn get_latest_holder_commitment_txn<L: Deref>(&self, logger: &L) -> Vec<Transaction>
1503 where L::Target: Logger {
1504 self.inner.lock().unwrap().get_latest_holder_commitment_txn(logger)
1507 /// Unsafe test-only version of get_latest_holder_commitment_txn used by our test framework
1508 /// to bypass HolderCommitmentTransaction state update lockdown after signature and generate
1509 /// revoked commitment transaction.
1510 #[cfg(any(test, feature = "unsafe_revoked_tx_signing"))]
1511 pub fn unsafe_get_latest_holder_commitment_txn<L: Deref>(&self, logger: &L) -> Vec<Transaction>
1512 where L::Target: Logger {
1513 self.inner.lock().unwrap().unsafe_get_latest_holder_commitment_txn(logger)
1516 /// Processes transactions in a newly connected block, which may result in any of the following:
1517 /// - update the monitor's state against resolved HTLCs
1518 /// - punish the counterparty in the case of seeing a revoked commitment transaction
1519 /// - force close the channel and claim/timeout incoming/outgoing HTLCs if near expiration
1520 /// - detect settled outputs for later spending
1521 /// - schedule and bump any in-flight claims
1523 /// Returns any new outputs to watch from `txdata`; after called, these are also included in
1524 /// [`get_outputs_to_watch`].
1526 /// [`get_outputs_to_watch`]: #method.get_outputs_to_watch
1527 pub fn block_connected<B: Deref, F: Deref, L: Deref>(
1529 header: &BlockHeader,
1530 txdata: &TransactionData,
1535 ) -> Vec<TransactionOutputs>
1537 B::Target: BroadcasterInterface,
1538 F::Target: FeeEstimator,
1541 self.inner.lock().unwrap().block_connected(
1542 header, txdata, height, broadcaster, fee_estimator, logger)
1545 /// Determines if the disconnected block contained any transactions of interest and updates
1547 pub fn block_disconnected<B: Deref, F: Deref, L: Deref>(
1549 header: &BlockHeader,
1555 B::Target: BroadcasterInterface,
1556 F::Target: FeeEstimator,
1559 self.inner.lock().unwrap().block_disconnected(
1560 header, height, broadcaster, fee_estimator, logger)
1563 /// Processes transactions confirmed in a block with the given header and height, returning new
1564 /// outputs to watch. See [`block_connected`] for details.
1566 /// Used instead of [`block_connected`] by clients that are notified of transactions rather than
1567 /// blocks. See [`chain::Confirm`] for calling expectations.
1569 /// [`block_connected`]: Self::block_connected
1570 pub fn transactions_confirmed<B: Deref, F: Deref, L: Deref>(
1572 header: &BlockHeader,
1573 txdata: &TransactionData,
1578 ) -> Vec<TransactionOutputs>
1580 B::Target: BroadcasterInterface,
1581 F::Target: FeeEstimator,
1584 let bounded_fee_estimator = LowerBoundedFeeEstimator::new(fee_estimator);
1585 self.inner.lock().unwrap().transactions_confirmed(
1586 header, txdata, height, broadcaster, &bounded_fee_estimator, logger)
1589 /// Processes a transaction that was reorganized out of the chain.
1591 /// Used instead of [`block_disconnected`] by clients that are notified of transactions rather
1592 /// than blocks. See [`chain::Confirm`] for calling expectations.
1594 /// [`block_disconnected`]: Self::block_disconnected
1595 pub fn transaction_unconfirmed<B: Deref, F: Deref, L: Deref>(
1602 B::Target: BroadcasterInterface,
1603 F::Target: FeeEstimator,
1606 let bounded_fee_estimator = LowerBoundedFeeEstimator::new(fee_estimator);
1607 self.inner.lock().unwrap().transaction_unconfirmed(
1608 txid, broadcaster, &bounded_fee_estimator, logger);
1611 /// Updates the monitor with the current best chain tip, returning new outputs to watch. See
1612 /// [`block_connected`] for details.
1614 /// Used instead of [`block_connected`] by clients that are notified of transactions rather than
1615 /// blocks. See [`chain::Confirm`] for calling expectations.
1617 /// [`block_connected`]: Self::block_connected
1618 pub fn best_block_updated<B: Deref, F: Deref, L: Deref>(
1620 header: &BlockHeader,
1625 ) -> Vec<TransactionOutputs>
1627 B::Target: BroadcasterInterface,
1628 F::Target: FeeEstimator,
1631 let bounded_fee_estimator = LowerBoundedFeeEstimator::new(fee_estimator);
1632 self.inner.lock().unwrap().best_block_updated(
1633 header, height, broadcaster, &bounded_fee_estimator, logger)
1636 /// Returns the set of txids that should be monitored for re-organization out of the chain.
1637 pub fn get_relevant_txids(&self) -> Vec<(Txid, Option<BlockHash>)> {
1638 let inner = self.inner.lock().unwrap();
1639 let mut txids: Vec<(Txid, Option<BlockHash>)> = inner.onchain_events_awaiting_threshold_conf
1641 .map(|entry| (entry.txid, entry.block_hash))
1642 .chain(inner.onchain_tx_handler.get_relevant_txids().into_iter())
1644 txids.sort_unstable();
1649 /// Gets the latest best block which was connected either via the [`chain::Listen`] or
1650 /// [`chain::Confirm`] interfaces.
1651 pub fn current_best_block(&self) -> BestBlock {
1652 self.inner.lock().unwrap().best_block.clone()
1655 /// Triggers rebroadcasts/fee-bumps of pending claims from a force-closed channel. This is
1656 /// crucial in preventing certain classes of pinning attacks, detecting substantial mempool
1657 /// feerate changes between blocks, and ensuring reliability if broadcasting fails. We recommend
1658 /// invoking this every 30 seconds, or lower if running in an environment with spotty
1659 /// connections, like on mobile.
1660 pub fn rebroadcast_pending_claims<B: Deref, F: Deref, L: Deref>(
1661 &self, broadcaster: B, fee_estimator: F, logger: L,
1664 B::Target: BroadcasterInterface,
1665 F::Target: FeeEstimator,
1668 let fee_estimator = LowerBoundedFeeEstimator::new(fee_estimator);
1669 let mut inner = self.inner.lock().unwrap();
1670 let current_height = inner.best_block.height;
1671 inner.onchain_tx_handler.rebroadcast_pending_claims(
1672 current_height, &broadcaster, &fee_estimator, &logger,
1677 impl<Signer: WriteableEcdsaChannelSigner> ChannelMonitorImpl<Signer> {
1678 /// Helper for get_claimable_balances which does the work for an individual HTLC, generating up
1679 /// to one `Balance` for the HTLC.
1680 fn get_htlc_balance(&self, htlc: &HTLCOutputInCommitment, holder_commitment: bool,
1681 counterparty_revoked_commitment: bool, confirmed_txid: Option<Txid>)
1682 -> Option<Balance> {
1683 let htlc_commitment_tx_output_idx =
1684 if let Some(v) = htlc.transaction_output_index { v } else { return None; };
1686 let mut htlc_spend_txid_opt = None;
1687 let mut htlc_spend_tx_opt = None;
1688 let mut holder_timeout_spend_pending = None;
1689 let mut htlc_spend_pending = None;
1690 let mut holder_delayed_output_pending = None;
1691 for event in self.onchain_events_awaiting_threshold_conf.iter() {
1693 OnchainEvent::HTLCUpdate { commitment_tx_output_idx, htlc_value_satoshis, .. }
1694 if commitment_tx_output_idx == Some(htlc_commitment_tx_output_idx) => {
1695 debug_assert!(htlc_spend_txid_opt.is_none());
1696 htlc_spend_txid_opt = Some(&event.txid);
1697 debug_assert!(htlc_spend_tx_opt.is_none());
1698 htlc_spend_tx_opt = event.transaction.as_ref();
1699 debug_assert!(holder_timeout_spend_pending.is_none());
1700 debug_assert_eq!(htlc_value_satoshis.unwrap(), htlc.amount_msat / 1000);
1701 holder_timeout_spend_pending = Some(event.confirmation_threshold());
1703 OnchainEvent::HTLCSpendConfirmation { commitment_tx_output_idx, preimage, .. }
1704 if commitment_tx_output_idx == htlc_commitment_tx_output_idx => {
1705 debug_assert!(htlc_spend_txid_opt.is_none());
1706 htlc_spend_txid_opt = Some(&event.txid);
1707 debug_assert!(htlc_spend_tx_opt.is_none());
1708 htlc_spend_tx_opt = event.transaction.as_ref();
1709 debug_assert!(htlc_spend_pending.is_none());
1710 htlc_spend_pending = Some((event.confirmation_threshold(), preimage.is_some()));
1712 OnchainEvent::MaturingOutput {
1713 descriptor: SpendableOutputDescriptor::DelayedPaymentOutput(ref descriptor) }
1714 if descriptor.outpoint.index as u32 == htlc_commitment_tx_output_idx => {
1715 debug_assert!(holder_delayed_output_pending.is_none());
1716 holder_delayed_output_pending = Some(event.confirmation_threshold());
1721 let htlc_resolved = self.htlcs_resolved_on_chain.iter()
1722 .find(|v| if v.commitment_tx_output_idx == Some(htlc_commitment_tx_output_idx) {
1723 debug_assert!(htlc_spend_txid_opt.is_none());
1724 htlc_spend_txid_opt = v.resolving_txid.as_ref();
1725 debug_assert!(htlc_spend_tx_opt.is_none());
1726 htlc_spend_tx_opt = v.resolving_tx.as_ref();
1729 debug_assert!(holder_timeout_spend_pending.is_some() as u8 + htlc_spend_pending.is_some() as u8 + htlc_resolved.is_some() as u8 <= 1);
1731 let htlc_commitment_outpoint = BitcoinOutPoint::new(confirmed_txid.unwrap(), htlc_commitment_tx_output_idx);
1732 let htlc_output_to_spend =
1733 if let Some(txid) = htlc_spend_txid_opt {
1734 // Because HTLC transactions either only have 1 input and 1 output (pre-anchors) or
1735 // are signed with SIGHASH_SINGLE|ANYONECANPAY under BIP-0143 (post-anchors), we can
1736 // locate the correct output by ensuring its adjacent input spends the HTLC output
1737 // in the commitment.
1738 if let Some(ref tx) = htlc_spend_tx_opt {
1739 let htlc_input_idx_opt = tx.input.iter().enumerate()
1740 .find(|(_, input)| input.previous_output == htlc_commitment_outpoint)
1741 .map(|(idx, _)| idx as u32);
1742 debug_assert!(htlc_input_idx_opt.is_some());
1743 BitcoinOutPoint::new(*txid, htlc_input_idx_opt.unwrap_or(0))
1745 debug_assert!(!self.onchain_tx_handler.channel_type_features().supports_anchors_zero_fee_htlc_tx());
1746 BitcoinOutPoint::new(*txid, 0)
1749 htlc_commitment_outpoint
1751 let htlc_output_spend_pending = self.onchain_tx_handler.is_output_spend_pending(&htlc_output_to_spend);
1753 if let Some(conf_thresh) = holder_delayed_output_pending {
1754 debug_assert!(holder_commitment);
1755 return Some(Balance::ClaimableAwaitingConfirmations {
1756 amount_satoshis: htlc.amount_msat / 1000,
1757 confirmation_height: conf_thresh,
1759 } else if htlc_resolved.is_some() && !htlc_output_spend_pending {
1760 // Funding transaction spends should be fully confirmed by the time any
1761 // HTLC transactions are resolved, unless we're talking about a holder
1762 // commitment tx, whose resolution is delayed until the CSV timeout is
1763 // reached, even though HTLCs may be resolved after only
1764 // ANTI_REORG_DELAY confirmations.
1765 debug_assert!(holder_commitment || self.funding_spend_confirmed.is_some());
1766 } else if counterparty_revoked_commitment {
1767 let htlc_output_claim_pending = self.onchain_events_awaiting_threshold_conf.iter().find_map(|event| {
1768 if let OnchainEvent::MaturingOutput {
1769 descriptor: SpendableOutputDescriptor::StaticOutput { .. }
1771 if event.transaction.as_ref().map(|tx| tx.input.iter().any(|inp| {
1772 if let Some(htlc_spend_txid) = htlc_spend_txid_opt {
1773 tx.txid() == *htlc_spend_txid || inp.previous_output.txid == *htlc_spend_txid
1775 Some(inp.previous_output.txid) == confirmed_txid &&
1776 inp.previous_output.vout == htlc_commitment_tx_output_idx
1778 })).unwrap_or(false) {
1783 if htlc_output_claim_pending.is_some() {
1784 // We already push `Balance`s onto the `res` list for every
1785 // `StaticOutput` in a `MaturingOutput` in the revoked
1786 // counterparty commitment transaction case generally, so don't
1787 // need to do so again here.
1789 debug_assert!(holder_timeout_spend_pending.is_none(),
1790 "HTLCUpdate OnchainEvents should never appear for preimage claims");
1791 debug_assert!(!htlc.offered || htlc_spend_pending.is_none() || !htlc_spend_pending.unwrap().1,
1792 "We don't (currently) generate preimage claims against revoked outputs, where did you get one?!");
1793 return Some(Balance::CounterpartyRevokedOutputClaimable {
1794 amount_satoshis: htlc.amount_msat / 1000,
1797 } else if htlc.offered == holder_commitment {
1798 // If the payment was outbound, check if there's an HTLCUpdate
1799 // indicating we have spent this HTLC with a timeout, claiming it back
1800 // and awaiting confirmations on it.
1801 if let Some(conf_thresh) = holder_timeout_spend_pending {
1802 return Some(Balance::ClaimableAwaitingConfirmations {
1803 amount_satoshis: htlc.amount_msat / 1000,
1804 confirmation_height: conf_thresh,
1807 return Some(Balance::MaybeTimeoutClaimableHTLC {
1808 amount_satoshis: htlc.amount_msat / 1000,
1809 claimable_height: htlc.cltv_expiry,
1810 payment_hash: htlc.payment_hash,
1813 } else if let Some(payment_preimage) = self.payment_preimages.get(&htlc.payment_hash) {
1814 // Otherwise (the payment was inbound), only expose it as claimable if
1815 // we know the preimage.
1816 // Note that if there is a pending claim, but it did not use the
1817 // preimage, we lost funds to our counterparty! We will then continue
1818 // to show it as ContentiousClaimable until ANTI_REORG_DELAY.
1819 debug_assert!(holder_timeout_spend_pending.is_none());
1820 if let Some((conf_thresh, true)) = htlc_spend_pending {
1821 return Some(Balance::ClaimableAwaitingConfirmations {
1822 amount_satoshis: htlc.amount_msat / 1000,
1823 confirmation_height: conf_thresh,
1826 return Some(Balance::ContentiousClaimable {
1827 amount_satoshis: htlc.amount_msat / 1000,
1828 timeout_height: htlc.cltv_expiry,
1829 payment_hash: htlc.payment_hash,
1830 payment_preimage: *payment_preimage,
1833 } else if htlc_resolved.is_none() {
1834 return Some(Balance::MaybePreimageClaimableHTLC {
1835 amount_satoshis: htlc.amount_msat / 1000,
1836 expiry_height: htlc.cltv_expiry,
1837 payment_hash: htlc.payment_hash,
1844 impl<Signer: WriteableEcdsaChannelSigner> ChannelMonitor<Signer> {
1845 /// Gets the balances in this channel which are either claimable by us if we were to
1846 /// force-close the channel now or which are claimable on-chain (possibly awaiting
1849 /// Any balances in the channel which are available on-chain (excluding on-chain fees) are
1850 /// included here until an [`Event::SpendableOutputs`] event has been generated for the
1851 /// balance, or until our counterparty has claimed the balance and accrued several
1852 /// confirmations on the claim transaction.
1854 /// Note that for `ChannelMonitors` which track a channel which went on-chain with versions of
1855 /// LDK prior to 0.0.111, balances may not be fully captured if our counterparty broadcasted
1856 /// a revoked state.
1858 /// See [`Balance`] for additional details on the types of claimable balances which
1859 /// may be returned here and their meanings.
1860 pub fn get_claimable_balances(&self) -> Vec<Balance> {
1861 let mut res = Vec::new();
1862 let us = self.inner.lock().unwrap();
1864 let mut confirmed_txid = us.funding_spend_confirmed;
1865 let mut confirmed_counterparty_output = us.confirmed_commitment_tx_counterparty_output;
1866 let mut pending_commitment_tx_conf_thresh = None;
1867 let funding_spend_pending = us.onchain_events_awaiting_threshold_conf.iter().find_map(|event| {
1868 if let OnchainEvent::FundingSpendConfirmation { commitment_tx_to_counterparty_output, .. } =
1871 confirmed_counterparty_output = commitment_tx_to_counterparty_output;
1872 Some((event.txid, event.confirmation_threshold()))
1875 if let Some((txid, conf_thresh)) = funding_spend_pending {
1876 debug_assert!(us.funding_spend_confirmed.is_none(),
1877 "We have a pending funding spend awaiting anti-reorg confirmation, we can't have confirmed it already!");
1878 confirmed_txid = Some(txid);
1879 pending_commitment_tx_conf_thresh = Some(conf_thresh);
1882 macro_rules! walk_htlcs {
1883 ($holder_commitment: expr, $counterparty_revoked_commitment: expr, $htlc_iter: expr) => {
1884 for htlc in $htlc_iter {
1885 if htlc.transaction_output_index.is_some() {
1887 if let Some(bal) = us.get_htlc_balance(htlc, $holder_commitment, $counterparty_revoked_commitment, confirmed_txid) {
1895 if let Some(txid) = confirmed_txid {
1896 let mut found_commitment_tx = false;
1897 if let Some(counterparty_tx_htlcs) = us.counterparty_claimable_outpoints.get(&txid) {
1898 // First look for the to_remote output back to us.
1899 if let Some(conf_thresh) = pending_commitment_tx_conf_thresh {
1900 if let Some(value) = us.onchain_events_awaiting_threshold_conf.iter().find_map(|event| {
1901 if let OnchainEvent::MaturingOutput {
1902 descriptor: SpendableOutputDescriptor::StaticPaymentOutput(descriptor)
1904 Some(descriptor.output.value)
1907 res.push(Balance::ClaimableAwaitingConfirmations {
1908 amount_satoshis: value,
1909 confirmation_height: conf_thresh,
1912 // If a counterparty commitment transaction is awaiting confirmation, we
1913 // should either have a StaticPaymentOutput MaturingOutput event awaiting
1914 // confirmation with the same height or have never met our dust amount.
1917 if Some(txid) == us.current_counterparty_commitment_txid || Some(txid) == us.prev_counterparty_commitment_txid {
1918 walk_htlcs!(false, false, counterparty_tx_htlcs.iter().map(|(a, _)| a));
1920 walk_htlcs!(false, true, counterparty_tx_htlcs.iter().map(|(a, _)| a));
1921 // The counterparty broadcasted a revoked state!
1922 // Look for any StaticOutputs first, generating claimable balances for those.
1923 // If any match the confirmed counterparty revoked to_self output, skip
1924 // generating a CounterpartyRevokedOutputClaimable.
1925 let mut spent_counterparty_output = false;
1926 for event in us.onchain_events_awaiting_threshold_conf.iter() {
1927 if let OnchainEvent::MaturingOutput {
1928 descriptor: SpendableOutputDescriptor::StaticOutput { output, .. }
1930 res.push(Balance::ClaimableAwaitingConfirmations {
1931 amount_satoshis: output.value,
1932 confirmation_height: event.confirmation_threshold(),
1934 if let Some(confirmed_to_self_idx) = confirmed_counterparty_output.map(|(idx, _)| idx) {
1935 if event.transaction.as_ref().map(|tx|
1936 tx.input.iter().any(|inp| inp.previous_output.vout == confirmed_to_self_idx)
1937 ).unwrap_or(false) {
1938 spent_counterparty_output = true;
1944 if spent_counterparty_output {
1945 } else if let Some((confirmed_to_self_idx, amt)) = confirmed_counterparty_output {
1946 let output_spendable = us.onchain_tx_handler
1947 .is_output_spend_pending(&BitcoinOutPoint::new(txid, confirmed_to_self_idx));
1948 if output_spendable {
1949 res.push(Balance::CounterpartyRevokedOutputClaimable {
1950 amount_satoshis: amt,
1954 // Counterparty output is missing, either it was broadcasted on a
1955 // previous version of LDK or the counterparty hadn't met dust.
1958 found_commitment_tx = true;
1959 } else if txid == us.current_holder_commitment_tx.txid {
1960 walk_htlcs!(true, false, us.current_holder_commitment_tx.htlc_outputs.iter().map(|(a, _, _)| a));
1961 if let Some(conf_thresh) = pending_commitment_tx_conf_thresh {
1962 res.push(Balance::ClaimableAwaitingConfirmations {
1963 amount_satoshis: us.current_holder_commitment_tx.to_self_value_sat,
1964 confirmation_height: conf_thresh,
1967 found_commitment_tx = true;
1968 } else if let Some(prev_commitment) = &us.prev_holder_signed_commitment_tx {
1969 if txid == prev_commitment.txid {
1970 walk_htlcs!(true, false, prev_commitment.htlc_outputs.iter().map(|(a, _, _)| a));
1971 if let Some(conf_thresh) = pending_commitment_tx_conf_thresh {
1972 res.push(Balance::ClaimableAwaitingConfirmations {
1973 amount_satoshis: prev_commitment.to_self_value_sat,
1974 confirmation_height: conf_thresh,
1977 found_commitment_tx = true;
1980 if !found_commitment_tx {
1981 if let Some(conf_thresh) = pending_commitment_tx_conf_thresh {
1982 // We blindly assume this is a cooperative close transaction here, and that
1983 // neither us nor our counterparty misbehaved. At worst we've under-estimated
1984 // the amount we can claim as we'll punish a misbehaving counterparty.
1985 res.push(Balance::ClaimableAwaitingConfirmations {
1986 amount_satoshis: us.current_holder_commitment_tx.to_self_value_sat,
1987 confirmation_height: conf_thresh,
1992 let mut claimable_inbound_htlc_value_sat = 0;
1993 for (htlc, _, _) in us.current_holder_commitment_tx.htlc_outputs.iter() {
1994 if htlc.transaction_output_index.is_none() { continue; }
1996 res.push(Balance::MaybeTimeoutClaimableHTLC {
1997 amount_satoshis: htlc.amount_msat / 1000,
1998 claimable_height: htlc.cltv_expiry,
1999 payment_hash: htlc.payment_hash,
2001 } else if us.payment_preimages.get(&htlc.payment_hash).is_some() {
2002 claimable_inbound_htlc_value_sat += htlc.amount_msat / 1000;
2004 // As long as the HTLC is still in our latest commitment state, treat
2005 // it as potentially claimable, even if it has long-since expired.
2006 res.push(Balance::MaybePreimageClaimableHTLC {
2007 amount_satoshis: htlc.amount_msat / 1000,
2008 expiry_height: htlc.cltv_expiry,
2009 payment_hash: htlc.payment_hash,
2013 res.push(Balance::ClaimableOnChannelClose {
2014 amount_satoshis: us.current_holder_commitment_tx.to_self_value_sat + claimable_inbound_htlc_value_sat,
2021 /// Gets the set of outbound HTLCs which can be (or have been) resolved by this
2022 /// `ChannelMonitor`. This is used to determine if an HTLC was removed from the channel prior
2023 /// to the `ChannelManager` having been persisted.
2025 /// This is similar to [`Self::get_pending_or_resolved_outbound_htlcs`] except it includes
2026 /// HTLCs which were resolved on-chain (i.e. where the final HTLC resolution was done by an
2027 /// event from this `ChannelMonitor`).
2028 pub(crate) fn get_all_current_outbound_htlcs(&self) -> HashMap<HTLCSource, (HTLCOutputInCommitment, Option<PaymentPreimage>)> {
2029 let mut res = HashMap::new();
2030 // Just examine the available counterparty commitment transactions. See docs on
2031 // `fail_unbroadcast_htlcs`, below, for justification.
2032 let us = self.inner.lock().unwrap();
2033 macro_rules! walk_counterparty_commitment {
2035 if let Some(ref latest_outpoints) = us.counterparty_claimable_outpoints.get($txid) {
2036 for &(ref htlc, ref source_option) in latest_outpoints.iter() {
2037 if let &Some(ref source) = source_option {
2038 res.insert((**source).clone(), (htlc.clone(),
2039 us.counterparty_fulfilled_htlcs.get(&SentHTLCId::from_source(source)).cloned()));
2045 if let Some(ref txid) = us.current_counterparty_commitment_txid {
2046 walk_counterparty_commitment!(txid);
2048 if let Some(ref txid) = us.prev_counterparty_commitment_txid {
2049 walk_counterparty_commitment!(txid);
2054 /// Gets the set of outbound HTLCs which are pending resolution in this channel or which were
2055 /// resolved with a preimage from our counterparty.
2057 /// This is used to reconstruct pending outbound payments on restart in the ChannelManager.
2059 /// Currently, the preimage is unused, however if it is present in the relevant internal state
2060 /// an HTLC is always included even if it has been resolved.
2061 pub(crate) fn get_pending_or_resolved_outbound_htlcs(&self) -> HashMap<HTLCSource, (HTLCOutputInCommitment, Option<PaymentPreimage>)> {
2062 let us = self.inner.lock().unwrap();
2063 // We're only concerned with the confirmation count of HTLC transactions, and don't
2064 // actually care how many confirmations a commitment transaction may or may not have. Thus,
2065 // we look for either a FundingSpendConfirmation event or a funding_spend_confirmed.
2066 let confirmed_txid = us.funding_spend_confirmed.or_else(|| {
2067 us.onchain_events_awaiting_threshold_conf.iter().find_map(|event| {
2068 if let OnchainEvent::FundingSpendConfirmation { .. } = event.event {
2074 if confirmed_txid.is_none() {
2075 // If we have not seen a commitment transaction on-chain (ie the channel is not yet
2076 // closed), just get the full set.
2078 return self.get_all_current_outbound_htlcs();
2081 let mut res = HashMap::new();
2082 macro_rules! walk_htlcs {
2083 ($holder_commitment: expr, $htlc_iter: expr) => {
2084 for (htlc, source) in $htlc_iter {
2085 if us.htlcs_resolved_on_chain.iter().any(|v| v.commitment_tx_output_idx == htlc.transaction_output_index) {
2086 // We should assert that funding_spend_confirmed is_some() here, but we
2087 // have some unit tests which violate HTLC transaction CSVs entirely and
2089 // TODO: Once tests all connect transactions at consensus-valid times, we
2090 // should assert here like we do in `get_claimable_balances`.
2091 } else if htlc.offered == $holder_commitment {
2092 // If the payment was outbound, check if there's an HTLCUpdate
2093 // indicating we have spent this HTLC with a timeout, claiming it back
2094 // and awaiting confirmations on it.
2095 let htlc_update_confd = us.onchain_events_awaiting_threshold_conf.iter().any(|event| {
2096 if let OnchainEvent::HTLCUpdate { commitment_tx_output_idx: Some(commitment_tx_output_idx), .. } = event.event {
2097 // If the HTLC was timed out, we wait for ANTI_REORG_DELAY blocks
2098 // before considering it "no longer pending" - this matches when we
2099 // provide the ChannelManager an HTLC failure event.
2100 Some(commitment_tx_output_idx) == htlc.transaction_output_index &&
2101 us.best_block.height() >= event.height + ANTI_REORG_DELAY - 1
2102 } else if let OnchainEvent::HTLCSpendConfirmation { commitment_tx_output_idx, .. } = event.event {
2103 // If the HTLC was fulfilled with a preimage, we consider the HTLC
2104 // immediately non-pending, matching when we provide ChannelManager
2106 Some(commitment_tx_output_idx) == htlc.transaction_output_index
2109 let counterparty_resolved_preimage_opt =
2110 us.counterparty_fulfilled_htlcs.get(&SentHTLCId::from_source(source)).cloned();
2111 if !htlc_update_confd || counterparty_resolved_preimage_opt.is_some() {
2112 res.insert(source.clone(), (htlc.clone(), counterparty_resolved_preimage_opt));
2119 let txid = confirmed_txid.unwrap();
2120 if Some(txid) == us.current_counterparty_commitment_txid || Some(txid) == us.prev_counterparty_commitment_txid {
2121 walk_htlcs!(false, us.counterparty_claimable_outpoints.get(&txid).unwrap().iter().filter_map(|(a, b)| {
2122 if let &Some(ref source) = b {
2123 Some((a, &**source))
2126 } else if txid == us.current_holder_commitment_tx.txid {
2127 walk_htlcs!(true, us.current_holder_commitment_tx.htlc_outputs.iter().filter_map(|(a, _, c)| {
2128 if let Some(source) = c { Some((a, source)) } else { None }
2130 } else if let Some(prev_commitment) = &us.prev_holder_signed_commitment_tx {
2131 if txid == prev_commitment.txid {
2132 walk_htlcs!(true, prev_commitment.htlc_outputs.iter().filter_map(|(a, _, c)| {
2133 if let Some(source) = c { Some((a, source)) } else { None }
2141 pub(crate) fn get_stored_preimages(&self) -> HashMap<PaymentHash, PaymentPreimage> {
2142 self.inner.lock().unwrap().payment_preimages.clone()
2146 /// Compares a broadcasted commitment transaction's HTLCs with those in the latest state,
2147 /// failing any HTLCs which didn't make it into the broadcasted commitment transaction back
2148 /// after ANTI_REORG_DELAY blocks.
2150 /// We always compare against the set of HTLCs in counterparty commitment transactions, as those
2151 /// are the commitment transactions which are generated by us. The off-chain state machine in
2152 /// `Channel` will automatically resolve any HTLCs which were never included in a commitment
2153 /// transaction when it detects channel closure, but it is up to us to ensure any HTLCs which were
2154 /// included in a remote commitment transaction are failed back if they are not present in the
2155 /// broadcasted commitment transaction.
2157 /// Specifically, the removal process for HTLCs in `Channel` is always based on the counterparty
2158 /// sending a `revoke_and_ack`, which causes us to clear `prev_counterparty_commitment_txid`. Thus,
2159 /// as long as we examine both the current counterparty commitment transaction and, if it hasn't
2160 /// been revoked yet, the previous one, we we will never "forget" to resolve an HTLC.
2161 macro_rules! fail_unbroadcast_htlcs {
2162 ($self: expr, $commitment_tx_type: expr, $commitment_txid_confirmed: expr, $commitment_tx_confirmed: expr,
2163 $commitment_tx_conf_height: expr, $commitment_tx_conf_hash: expr, $confirmed_htlcs_list: expr, $logger: expr) => { {
2164 debug_assert_eq!($commitment_tx_confirmed.txid(), $commitment_txid_confirmed);
2166 macro_rules! check_htlc_fails {
2167 ($txid: expr, $commitment_tx: expr) => {
2168 if let Some(ref latest_outpoints) = $self.counterparty_claimable_outpoints.get($txid) {
2169 for &(ref htlc, ref source_option) in latest_outpoints.iter() {
2170 if let &Some(ref source) = source_option {
2171 // Check if the HTLC is present in the commitment transaction that was
2172 // broadcast, but not if it was below the dust limit, which we should
2173 // fail backwards immediately as there is no way for us to learn the
2174 // payment_preimage.
2175 // Note that if the dust limit were allowed to change between
2176 // commitment transactions we'd want to be check whether *any*
2177 // broadcastable commitment transaction has the HTLC in it, but it
2178 // cannot currently change after channel initialization, so we don't
2180 let confirmed_htlcs_iter: &mut Iterator<Item = (&HTLCOutputInCommitment, Option<&HTLCSource>)> = &mut $confirmed_htlcs_list;
2182 let mut matched_htlc = false;
2183 for (ref broadcast_htlc, ref broadcast_source) in confirmed_htlcs_iter {
2184 if broadcast_htlc.transaction_output_index.is_some() &&
2185 (Some(&**source) == *broadcast_source ||
2186 (broadcast_source.is_none() &&
2187 broadcast_htlc.payment_hash == htlc.payment_hash &&
2188 broadcast_htlc.amount_msat == htlc.amount_msat)) {
2189 matched_htlc = true;
2193 if matched_htlc { continue; }
2194 if $self.counterparty_fulfilled_htlcs.get(&SentHTLCId::from_source(source)).is_some() {
2197 $self.onchain_events_awaiting_threshold_conf.retain(|ref entry| {
2198 if entry.height != $commitment_tx_conf_height { return true; }
2200 OnchainEvent::HTLCUpdate { source: ref update_source, .. } => {
2201 *update_source != **source
2206 let entry = OnchainEventEntry {
2207 txid: $commitment_txid_confirmed,
2208 transaction: Some($commitment_tx_confirmed.clone()),
2209 height: $commitment_tx_conf_height,
2210 block_hash: Some(*$commitment_tx_conf_hash),
2211 event: OnchainEvent::HTLCUpdate {
2212 source: (**source).clone(),
2213 payment_hash: htlc.payment_hash.clone(),
2214 htlc_value_satoshis: Some(htlc.amount_msat / 1000),
2215 commitment_tx_output_idx: None,
2218 log_trace!($logger, "Failing HTLC with payment_hash {} from {} counterparty commitment tx due to broadcast of {} commitment transaction {}, waiting for confirmation (at height {})",
2219 &htlc.payment_hash, $commitment_tx, $commitment_tx_type,
2220 $commitment_txid_confirmed, entry.confirmation_threshold());
2221 $self.onchain_events_awaiting_threshold_conf.push(entry);
2227 if let Some(ref txid) = $self.current_counterparty_commitment_txid {
2228 check_htlc_fails!(txid, "current");
2230 if let Some(ref txid) = $self.prev_counterparty_commitment_txid {
2231 check_htlc_fails!(txid, "previous");
2236 // In the `test_invalid_funding_tx` test, we need a bogus script which matches the HTLC-Accepted
2237 // witness length match (ie is 136 bytes long). We generate one here which we also use in some
2238 // in-line tests later.
2241 pub fn deliberately_bogus_accepted_htlc_witness_program() -> Vec<u8> {
2242 let mut ret = [opcodes::all::OP_NOP.to_u8(); 136];
2243 ret[131] = opcodes::all::OP_DROP.to_u8();
2244 ret[132] = opcodes::all::OP_DROP.to_u8();
2245 ret[133] = opcodes::all::OP_DROP.to_u8();
2246 ret[134] = opcodes::all::OP_DROP.to_u8();
2247 ret[135] = opcodes::OP_TRUE.to_u8();
2252 pub fn deliberately_bogus_accepted_htlc_witness() -> Vec<Vec<u8>> {
2253 vec![Vec::new(), Vec::new(), Vec::new(), Vec::new(), deliberately_bogus_accepted_htlc_witness_program().into()].into()
2256 impl<Signer: WriteableEcdsaChannelSigner> ChannelMonitorImpl<Signer> {
2257 /// Inserts a revocation secret into this channel monitor. Prunes old preimages if neither
2258 /// needed by holder commitment transactions HTCLs nor by counterparty ones. Unless we haven't already seen
2259 /// counterparty commitment transaction's secret, they are de facto pruned (we can use revocation key).
2260 fn provide_secret(&mut self, idx: u64, secret: [u8; 32]) -> Result<(), &'static str> {
2261 if let Err(()) = self.commitment_secrets.provide_secret(idx, secret) {
2262 return Err("Previous secret did not match new one");
2265 // Prune HTLCs from the previous counterparty commitment tx so we don't generate failure/fulfill
2266 // events for now-revoked/fulfilled HTLCs.
2267 if let Some(txid) = self.prev_counterparty_commitment_txid.take() {
2268 if self.current_counterparty_commitment_txid.unwrap() != txid {
2269 let cur_claimables = self.counterparty_claimable_outpoints.get(
2270 &self.current_counterparty_commitment_txid.unwrap()).unwrap();
2271 for (_, ref source_opt) in self.counterparty_claimable_outpoints.get(&txid).unwrap() {
2272 if let Some(source) = source_opt {
2273 if !cur_claimables.iter()
2274 .any(|(_, cur_source_opt)| cur_source_opt == source_opt)
2276 self.counterparty_fulfilled_htlcs.remove(&SentHTLCId::from_source(source));
2280 for &mut (_, ref mut source_opt) in self.counterparty_claimable_outpoints.get_mut(&txid).unwrap() {
2284 assert!(cfg!(fuzzing), "Commitment txids are unique outside of fuzzing, where hashes can collide");
2288 if !self.payment_preimages.is_empty() {
2289 let cur_holder_signed_commitment_tx = &self.current_holder_commitment_tx;
2290 let prev_holder_signed_commitment_tx = self.prev_holder_signed_commitment_tx.as_ref();
2291 let min_idx = self.get_min_seen_secret();
2292 let counterparty_hash_commitment_number = &mut self.counterparty_hash_commitment_number;
2294 self.payment_preimages.retain(|&k, _| {
2295 for &(ref htlc, _, _) in cur_holder_signed_commitment_tx.htlc_outputs.iter() {
2296 if k == htlc.payment_hash {
2300 if let Some(prev_holder_commitment_tx) = prev_holder_signed_commitment_tx {
2301 for &(ref htlc, _, _) in prev_holder_commitment_tx.htlc_outputs.iter() {
2302 if k == htlc.payment_hash {
2307 let contains = if let Some(cn) = counterparty_hash_commitment_number.get(&k) {
2314 counterparty_hash_commitment_number.remove(&k);
2323 pub(crate) fn provide_initial_counterparty_commitment_tx<L: Deref>(
2324 &mut self, txid: Txid, htlc_outputs: Vec<(HTLCOutputInCommitment, Option<Box<HTLCSource>>)>,
2325 commitment_number: u64, their_per_commitment_point: PublicKey, feerate_per_kw: u32,
2326 to_broadcaster_value: u64, to_countersignatory_value: u64, logger: &L
2328 where L::Target: Logger
2330 self.initial_counterparty_commitment_info = Some((their_per_commitment_point.clone(),
2331 feerate_per_kw, to_broadcaster_value, to_countersignatory_value));
2333 #[cfg(debug_assertions)] {
2334 let rebuilt_commitment_tx = self.initial_counterparty_commitment_tx().unwrap();
2335 debug_assert_eq!(rebuilt_commitment_tx.trust().txid(), txid);
2338 self.provide_latest_counterparty_commitment_tx(txid, htlc_outputs, commitment_number,
2339 their_per_commitment_point, logger);
2342 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 {
2343 // TODO: Encrypt the htlc_outputs data with the single-hash of the commitment transaction
2344 // so that a remote monitor doesn't learn anything unless there is a malicious close.
2345 // (only maybe, sadly we cant do the same for local info, as we need to be aware of
2347 for &(ref htlc, _) in &htlc_outputs {
2348 self.counterparty_hash_commitment_number.insert(htlc.payment_hash, commitment_number);
2351 log_trace!(logger, "Tracking new counterparty commitment transaction with txid {} at commitment number {} with {} HTLC outputs", txid, commitment_number, htlc_outputs.len());
2352 self.prev_counterparty_commitment_txid = self.current_counterparty_commitment_txid.take();
2353 self.current_counterparty_commitment_txid = Some(txid);
2354 self.counterparty_claimable_outpoints.insert(txid, htlc_outputs.clone());
2355 self.current_counterparty_commitment_number = commitment_number;
2356 //TODO: Merge this into the other per-counterparty-transaction output storage stuff
2357 match self.their_cur_per_commitment_points {
2358 Some(old_points) => {
2359 if old_points.0 == commitment_number + 1 {
2360 self.their_cur_per_commitment_points = Some((old_points.0, old_points.1, Some(their_per_commitment_point)));
2361 } else if old_points.0 == commitment_number + 2 {
2362 if let Some(old_second_point) = old_points.2 {
2363 self.their_cur_per_commitment_points = Some((old_points.0 - 1, old_second_point, Some(their_per_commitment_point)));
2365 self.their_cur_per_commitment_points = Some((commitment_number, their_per_commitment_point, None));
2368 self.their_cur_per_commitment_points = Some((commitment_number, their_per_commitment_point, None));
2372 self.their_cur_per_commitment_points = Some((commitment_number, their_per_commitment_point, None));
2375 let mut htlcs = Vec::with_capacity(htlc_outputs.len());
2376 for htlc in htlc_outputs {
2377 if htlc.0.transaction_output_index.is_some() {
2383 /// Informs this monitor of the latest holder (ie broadcastable) commitment transaction. The
2384 /// monitor watches for timeouts and may broadcast it if we approach such a timeout. Thus, it
2385 /// is important that any clones of this channel monitor (including remote clones) by kept
2386 /// up-to-date as our holder commitment transaction is updated.
2387 /// Panics if set_on_holder_tx_csv has never been called.
2388 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> {
2389 if htlc_outputs.iter().any(|(_, s, _)| s.is_some()) {
2390 // If we have non-dust HTLCs in htlc_outputs, ensure they match the HTLCs in the
2391 // `holder_commitment_tx`. In the future, we'll no longer provide the redundant data
2392 // and just pass in source data via `nondust_htlc_sources`.
2393 debug_assert_eq!(htlc_outputs.iter().filter(|(_, s, _)| s.is_some()).count(), holder_commitment_tx.trust().htlcs().len());
2394 for (a, b) in htlc_outputs.iter().filter(|(_, s, _)| s.is_some()).map(|(h, _, _)| h).zip(holder_commitment_tx.trust().htlcs().iter()) {
2395 debug_assert_eq!(a, b);
2397 debug_assert_eq!(htlc_outputs.iter().filter(|(_, s, _)| s.is_some()).count(), holder_commitment_tx.counterparty_htlc_sigs.len());
2398 for (a, b) in htlc_outputs.iter().filter_map(|(_, s, _)| s.as_ref()).zip(holder_commitment_tx.counterparty_htlc_sigs.iter()) {
2399 debug_assert_eq!(a, b);
2401 debug_assert!(nondust_htlc_sources.is_empty());
2403 // If we don't have any non-dust HTLCs in htlc_outputs, assume they were all passed via
2404 // `nondust_htlc_sources`, building up the final htlc_outputs by combining
2405 // `nondust_htlc_sources` and the `holder_commitment_tx`
2406 #[cfg(debug_assertions)] {
2408 for htlc in holder_commitment_tx.trust().htlcs().iter() {
2409 assert!(htlc.transaction_output_index.unwrap() as i32 > prev);
2410 prev = htlc.transaction_output_index.unwrap() as i32;
2413 debug_assert!(htlc_outputs.iter().all(|(htlc, _, _)| htlc.transaction_output_index.is_none()));
2414 debug_assert!(htlc_outputs.iter().all(|(_, sig_opt, _)| sig_opt.is_none()));
2415 debug_assert_eq!(holder_commitment_tx.trust().htlcs().len(), holder_commitment_tx.counterparty_htlc_sigs.len());
2417 let mut sources_iter = nondust_htlc_sources.into_iter();
2419 for (htlc, counterparty_sig) in holder_commitment_tx.trust().htlcs().iter()
2420 .zip(holder_commitment_tx.counterparty_htlc_sigs.iter())
2423 let source = sources_iter.next().expect("Non-dust HTLC sources didn't match commitment tx");
2424 #[cfg(debug_assertions)] {
2425 assert!(source.possibly_matches_output(htlc));
2427 htlc_outputs.push((htlc.clone(), Some(counterparty_sig.clone()), Some(source)));
2429 htlc_outputs.push((htlc.clone(), Some(counterparty_sig.clone()), None));
2432 debug_assert!(sources_iter.next().is_none());
2435 let trusted_tx = holder_commitment_tx.trust();
2436 let txid = trusted_tx.txid();
2437 let tx_keys = trusted_tx.keys();
2438 self.current_holder_commitment_number = trusted_tx.commitment_number();
2439 let mut new_holder_commitment_tx = HolderSignedTx {
2441 revocation_key: tx_keys.revocation_key,
2442 a_htlc_key: tx_keys.broadcaster_htlc_key,
2443 b_htlc_key: tx_keys.countersignatory_htlc_key,
2444 delayed_payment_key: tx_keys.broadcaster_delayed_payment_key,
2445 per_commitment_point: tx_keys.per_commitment_point,
2447 to_self_value_sat: holder_commitment_tx.to_broadcaster_value_sat(),
2448 feerate_per_kw: trusted_tx.feerate_per_kw(),
2450 self.onchain_tx_handler.provide_latest_holder_tx(holder_commitment_tx);
2451 mem::swap(&mut new_holder_commitment_tx, &mut self.current_holder_commitment_tx);
2452 self.prev_holder_signed_commitment_tx = Some(new_holder_commitment_tx);
2453 for (claimed_htlc_id, claimed_preimage) in claimed_htlcs {
2454 #[cfg(debug_assertions)] {
2455 let cur_counterparty_htlcs = self.counterparty_claimable_outpoints.get(
2456 &self.current_counterparty_commitment_txid.unwrap()).unwrap();
2457 assert!(cur_counterparty_htlcs.iter().any(|(_, source_opt)| {
2458 if let Some(source) = source_opt {
2459 SentHTLCId::from_source(source) == *claimed_htlc_id
2463 self.counterparty_fulfilled_htlcs.insert(*claimed_htlc_id, *claimed_preimage);
2465 if self.holder_tx_signed {
2466 return Err("Latest holder commitment signed has already been signed, update is rejected");
2471 /// Provides a payment_hash->payment_preimage mapping. Will be automatically pruned when all
2472 /// commitment_tx_infos which contain the payment hash have been revoked.
2473 fn provide_payment_preimage<B: Deref, F: Deref, L: Deref>(
2474 &mut self, payment_hash: &PaymentHash, payment_preimage: &PaymentPreimage, broadcaster: &B,
2475 fee_estimator: &LowerBoundedFeeEstimator<F>, logger: &L)
2476 where B::Target: BroadcasterInterface,
2477 F::Target: FeeEstimator,
2480 self.payment_preimages.insert(payment_hash.clone(), payment_preimage.clone());
2482 // If the channel is force closed, try to claim the output from this preimage.
2483 // First check if a counterparty commitment transaction has been broadcasted:
2484 macro_rules! claim_htlcs {
2485 ($commitment_number: expr, $txid: expr) => {
2486 let (htlc_claim_reqs, _) = self.get_counterparty_output_claim_info($commitment_number, $txid, None);
2487 self.onchain_tx_handler.update_claims_view_from_requests(htlc_claim_reqs, self.best_block.height(), self.best_block.height(), broadcaster, fee_estimator, logger);
2490 if let Some(txid) = self.current_counterparty_commitment_txid {
2491 if let Some(commitment_number) = self.counterparty_commitment_txn_on_chain.get(&txid) {
2492 claim_htlcs!(*commitment_number, txid);
2496 if let Some(txid) = self.prev_counterparty_commitment_txid {
2497 if let Some(commitment_number) = self.counterparty_commitment_txn_on_chain.get(&txid) {
2498 claim_htlcs!(*commitment_number, txid);
2503 // Then if a holder commitment transaction has been seen on-chain, broadcast transactions
2504 // claiming the HTLC output from each of the holder commitment transactions.
2505 // Note that we can't just use `self.holder_tx_signed`, because that only covers the case where
2506 // *we* sign a holder commitment transaction, not when e.g. a watchtower broadcasts one of our
2507 // holder commitment transactions.
2508 if self.broadcasted_holder_revokable_script.is_some() {
2509 // Assume that the broadcasted commitment transaction confirmed in the current best
2510 // block. Even if not, its a reasonable metric for the bump criteria on the HTLC
2512 let (claim_reqs, _) = self.get_broadcasted_holder_claims(&self.current_holder_commitment_tx, self.best_block.height());
2513 self.onchain_tx_handler.update_claims_view_from_requests(claim_reqs, self.best_block.height(), self.best_block.height(), broadcaster, fee_estimator, logger);
2514 if let Some(ref tx) = self.prev_holder_signed_commitment_tx {
2515 let (claim_reqs, _) = self.get_broadcasted_holder_claims(&tx, self.best_block.height());
2516 self.onchain_tx_handler.update_claims_view_from_requests(claim_reqs, self.best_block.height(), self.best_block.height(), broadcaster, fee_estimator, logger);
2521 pub(crate) fn broadcast_latest_holder_commitment_txn<B: Deref, L: Deref>(&mut self, broadcaster: &B, logger: &L)
2522 where B::Target: BroadcasterInterface,
2525 let commit_txs = self.get_latest_holder_commitment_txn(logger);
2526 let mut txs = vec![];
2527 for tx in commit_txs.iter() {
2528 log_info!(logger, "Broadcasting local {}", log_tx!(tx));
2531 broadcaster.broadcast_transactions(&txs);
2532 self.pending_monitor_events.push(MonitorEvent::CommitmentTxConfirmed(self.funding_info.0));
2535 pub fn update_monitor<B: Deref, F: Deref, L: Deref>(&mut self, updates: &ChannelMonitorUpdate, broadcaster: &B, fee_estimator: F, logger: &L) -> Result<(), ()>
2536 where B::Target: BroadcasterInterface,
2537 F::Target: FeeEstimator,
2540 if self.latest_update_id == CLOSED_CHANNEL_UPDATE_ID && updates.update_id == CLOSED_CHANNEL_UPDATE_ID {
2541 log_info!(logger, "Applying post-force-closed update to monitor {} with {} change(s).",
2542 log_funding_info!(self), updates.updates.len());
2543 } else if updates.update_id == CLOSED_CHANNEL_UPDATE_ID {
2544 log_info!(logger, "Applying force close update to monitor {} with {} change(s).",
2545 log_funding_info!(self), updates.updates.len());
2547 log_info!(logger, "Applying update to monitor {}, bringing update_id from {} to {} with {} change(s).",
2548 log_funding_info!(self), self.latest_update_id, updates.update_id, updates.updates.len());
2550 // ChannelMonitor updates may be applied after force close if we receive a preimage for a
2551 // broadcasted commitment transaction HTLC output that we'd like to claim on-chain. If this
2552 // is the case, we no longer have guaranteed access to the monitor's update ID, so we use a
2553 // sentinel value instead.
2555 // The `ChannelManager` may also queue redundant `ChannelForceClosed` updates if it still
2556 // thinks the channel needs to have its commitment transaction broadcast, so we'll allow
2558 if updates.update_id == CLOSED_CHANNEL_UPDATE_ID {
2559 assert_eq!(updates.updates.len(), 1);
2560 match updates.updates[0] {
2561 ChannelMonitorUpdateStep::ChannelForceClosed { .. } => {},
2562 // We should have already seen a `ChannelForceClosed` update if we're trying to
2563 // provide a preimage at this point.
2564 ChannelMonitorUpdateStep::PaymentPreimage { .. } =>
2565 debug_assert_eq!(self.latest_update_id, CLOSED_CHANNEL_UPDATE_ID),
2567 log_error!(logger, "Attempted to apply post-force-close ChannelMonitorUpdate of type {}", updates.updates[0].variant_name());
2568 panic!("Attempted to apply post-force-close ChannelMonitorUpdate that wasn't providing a payment preimage");
2571 } else if self.latest_update_id + 1 != updates.update_id {
2572 panic!("Attempted to apply ChannelMonitorUpdates out of order, check the update_id before passing an update to update_monitor!");
2574 let mut ret = Ok(());
2575 let bounded_fee_estimator = LowerBoundedFeeEstimator::new(&*fee_estimator);
2576 for update in updates.updates.iter() {
2578 ChannelMonitorUpdateStep::LatestHolderCommitmentTXInfo { commitment_tx, htlc_outputs, claimed_htlcs, nondust_htlc_sources } => {
2579 log_trace!(logger, "Updating ChannelMonitor with latest holder commitment transaction info");
2580 if self.lockdown_from_offchain { panic!(); }
2581 if let Err(e) = self.provide_latest_holder_commitment_tx(commitment_tx.clone(), htlc_outputs.clone(), &claimed_htlcs, nondust_htlc_sources.clone()) {
2582 log_error!(logger, "Providing latest holder commitment transaction failed/was refused:");
2583 log_error!(logger, " {}", e);
2587 ChannelMonitorUpdateStep::LatestCounterpartyCommitmentTXInfo { commitment_txid, htlc_outputs, commitment_number, their_per_commitment_point, .. } => {
2588 log_trace!(logger, "Updating ChannelMonitor with latest counterparty commitment transaction info");
2589 self.provide_latest_counterparty_commitment_tx(*commitment_txid, htlc_outputs.clone(), *commitment_number, *their_per_commitment_point, logger)
2591 ChannelMonitorUpdateStep::PaymentPreimage { payment_preimage } => {
2592 log_trace!(logger, "Updating ChannelMonitor with payment preimage");
2593 self.provide_payment_preimage(&PaymentHash(Sha256::hash(&payment_preimage.0[..]).into_inner()), &payment_preimage, broadcaster, &bounded_fee_estimator, logger)
2595 ChannelMonitorUpdateStep::CommitmentSecret { idx, secret } => {
2596 log_trace!(logger, "Updating ChannelMonitor with commitment secret");
2597 if let Err(e) = self.provide_secret(*idx, *secret) {
2598 debug_assert!(false, "Latest counterparty commitment secret was invalid");
2599 log_error!(logger, "Providing latest counterparty commitment secret failed/was refused:");
2600 log_error!(logger, " {}", e);
2604 ChannelMonitorUpdateStep::ChannelForceClosed { should_broadcast } => {
2605 log_trace!(logger, "Updating ChannelMonitor: channel force closed, should broadcast: {}", should_broadcast);
2606 self.lockdown_from_offchain = true;
2607 if *should_broadcast {
2608 // There's no need to broadcast our commitment transaction if we've seen one
2609 // confirmed (even with 1 confirmation) as it'll be rejected as
2610 // duplicate/conflicting.
2611 let detected_funding_spend = self.funding_spend_confirmed.is_some() ||
2612 self.onchain_events_awaiting_threshold_conf.iter().find(|event| match event.event {
2613 OnchainEvent::FundingSpendConfirmation { .. } => true,
2616 if detected_funding_spend {
2617 log_trace!(logger, "Avoiding commitment broadcast, already detected confirmed spend onchain");
2620 self.broadcast_latest_holder_commitment_txn(broadcaster, logger);
2621 // If the channel supports anchor outputs, we'll need to emit an external
2622 // event to be consumed such that a child transaction is broadcast with a
2623 // high enough feerate for the parent commitment transaction to confirm.
2624 if self.onchain_tx_handler.channel_type_features().supports_anchors_zero_fee_htlc_tx() {
2625 let funding_output = HolderFundingOutput::build(
2626 self.funding_redeemscript.clone(), self.channel_value_satoshis,
2627 self.onchain_tx_handler.channel_type_features().clone(),
2629 let best_block_height = self.best_block.height();
2630 let commitment_package = PackageTemplate::build_package(
2631 self.funding_info.0.txid.clone(), self.funding_info.0.index as u32,
2632 PackageSolvingData::HolderFundingOutput(funding_output),
2633 best_block_height, best_block_height
2635 self.onchain_tx_handler.update_claims_view_from_requests(
2636 vec![commitment_package], best_block_height, best_block_height,
2637 broadcaster, &bounded_fee_estimator, logger,
2640 } else if !self.holder_tx_signed {
2641 log_error!(logger, "WARNING: You have a potentially-unsafe holder commitment transaction available to broadcast");
2642 log_error!(logger, " in channel monitor for channel {}!", &self.funding_info.0.to_channel_id());
2643 log_error!(logger, " Read the docs for ChannelMonitor::get_latest_holder_commitment_txn and take manual action!");
2645 // If we generated a MonitorEvent::CommitmentTxConfirmed, the ChannelManager
2646 // will still give us a ChannelForceClosed event with !should_broadcast, but we
2647 // shouldn't print the scary warning above.
2648 log_info!(logger, "Channel off-chain state closed after we broadcasted our latest commitment transaction.");
2651 ChannelMonitorUpdateStep::ShutdownScript { scriptpubkey } => {
2652 log_trace!(logger, "Updating ChannelMonitor with shutdown script");
2653 if let Some(shutdown_script) = self.shutdown_script.replace(scriptpubkey.clone()) {
2654 panic!("Attempted to replace shutdown script {} with {}", shutdown_script, scriptpubkey);
2660 #[cfg(debug_assertions)] {
2661 self.counterparty_commitment_txs_from_update(updates);
2664 // If the updates succeeded and we were in an already closed channel state, then there's no
2665 // need to refuse any updates we expect to receive afer seeing a confirmed commitment.
2666 if ret.is_ok() && updates.update_id == CLOSED_CHANNEL_UPDATE_ID && self.latest_update_id == updates.update_id {
2670 self.latest_update_id = updates.update_id;
2672 // Refuse updates after we've detected a spend onchain, but only if we haven't processed a
2673 // force closed monitor update yet.
2674 if ret.is_ok() && self.funding_spend_seen && self.latest_update_id != CLOSED_CHANNEL_UPDATE_ID {
2675 log_error!(logger, "Refusing Channel Monitor Update as counterparty attempted to update commitment after funding was spent");
2680 pub fn get_latest_update_id(&self) -> u64 {
2681 self.latest_update_id
2684 pub fn get_funding_txo(&self) -> &(OutPoint, Script) {
2688 pub fn get_outputs_to_watch(&self) -> &HashMap<Txid, Vec<(u32, Script)>> {
2689 // If we've detected a counterparty commitment tx on chain, we must include it in the set
2690 // of outputs to watch for spends of, otherwise we're likely to lose user funds. Because
2691 // its trivial to do, double-check that here.
2692 for (txid, _) in self.counterparty_commitment_txn_on_chain.iter() {
2693 self.outputs_to_watch.get(txid).expect("Counterparty commitment txn which have been broadcast should have outputs registered");
2695 &self.outputs_to_watch
2698 pub fn get_and_clear_pending_monitor_events(&mut self) -> Vec<MonitorEvent> {
2699 let mut ret = Vec::new();
2700 mem::swap(&mut ret, &mut self.pending_monitor_events);
2704 /// Gets the set of events that are repeated regularly (e.g. those which RBF bump
2705 /// transactions). We're okay if we lose these on restart as they'll be regenerated for us at
2706 /// some regular interval via [`ChannelMonitor::rebroadcast_pending_claims`].
2707 pub(super) fn get_repeated_events(&mut self) -> Vec<Event> {
2708 let pending_claim_events = self.onchain_tx_handler.get_and_clear_pending_claim_events();
2709 let mut ret = Vec::with_capacity(pending_claim_events.len());
2710 for (claim_id, claim_event) in pending_claim_events {
2712 ClaimEvent::BumpCommitment {
2713 package_target_feerate_sat_per_1000_weight, commitment_tx, anchor_output_idx,
2715 let commitment_txid = commitment_tx.txid();
2716 debug_assert_eq!(self.current_holder_commitment_tx.txid, commitment_txid);
2717 let pending_htlcs = self.current_holder_commitment_tx.non_dust_htlcs();
2718 let commitment_tx_fee_satoshis = self.channel_value_satoshis -
2719 commitment_tx.output.iter().fold(0u64, |sum, output| sum + output.value);
2720 ret.push(Event::BumpTransaction(BumpTransactionEvent::ChannelClose {
2722 package_target_feerate_sat_per_1000_weight,
2724 commitment_tx_fee_satoshis,
2725 anchor_descriptor: AnchorDescriptor {
2726 channel_derivation_parameters: ChannelDerivationParameters {
2727 keys_id: self.channel_keys_id,
2728 value_satoshis: self.channel_value_satoshis,
2729 transaction_parameters: self.onchain_tx_handler.channel_transaction_parameters.clone(),
2731 outpoint: BitcoinOutPoint {
2732 txid: commitment_txid,
2733 vout: anchor_output_idx,
2739 ClaimEvent::BumpHTLC {
2740 target_feerate_sat_per_1000_weight, htlcs, tx_lock_time,
2742 let mut htlc_descriptors = Vec::with_capacity(htlcs.len());
2744 htlc_descriptors.push(HTLCDescriptor {
2745 channel_derivation_parameters: ChannelDerivationParameters {
2746 keys_id: self.channel_keys_id,
2747 value_satoshis: self.channel_value_satoshis,
2748 transaction_parameters: self.onchain_tx_handler.channel_transaction_parameters.clone(),
2750 commitment_txid: htlc.commitment_txid,
2751 per_commitment_number: htlc.per_commitment_number,
2752 per_commitment_point: self.onchain_tx_handler.signer.get_per_commitment_point(
2753 htlc.per_commitment_number, &self.onchain_tx_handler.secp_ctx,
2756 preimage: htlc.preimage,
2757 counterparty_sig: htlc.counterparty_sig,
2760 ret.push(Event::BumpTransaction(BumpTransactionEvent::HTLCResolution {
2762 target_feerate_sat_per_1000_weight,
2772 pub(crate) fn initial_counterparty_commitment_tx(&mut self) -> Option<CommitmentTransaction> {
2773 let (their_per_commitment_point, feerate_per_kw, to_broadcaster_value,
2774 to_countersignatory_value) = self.initial_counterparty_commitment_info?;
2775 let htlc_outputs = vec![];
2777 let commitment_tx = self.build_counterparty_commitment_tx(INITIAL_COMMITMENT_NUMBER,
2778 &their_per_commitment_point, to_broadcaster_value, to_countersignatory_value,
2779 feerate_per_kw, htlc_outputs);
2783 fn build_counterparty_commitment_tx(
2784 &self, commitment_number: u64, their_per_commitment_point: &PublicKey,
2785 to_broadcaster_value: u64, to_countersignatory_value: u64, feerate_per_kw: u32,
2786 mut nondust_htlcs: Vec<(HTLCOutputInCommitment, Option<Box<HTLCSource>>)>
2787 ) -> CommitmentTransaction {
2788 let broadcaster_keys = &self.onchain_tx_handler.channel_transaction_parameters
2789 .counterparty_parameters.as_ref().unwrap().pubkeys;
2790 let countersignatory_keys =
2791 &self.onchain_tx_handler.channel_transaction_parameters.holder_pubkeys;
2793 let broadcaster_funding_key = broadcaster_keys.funding_pubkey;
2794 let countersignatory_funding_key = countersignatory_keys.funding_pubkey;
2795 let keys = TxCreationKeys::from_channel_static_keys(&their_per_commitment_point,
2796 &broadcaster_keys, &countersignatory_keys, &self.onchain_tx_handler.secp_ctx);
2797 let channel_parameters =
2798 &self.onchain_tx_handler.channel_transaction_parameters.as_counterparty_broadcastable();
2800 CommitmentTransaction::new_with_auxiliary_htlc_data(commitment_number,
2801 to_broadcaster_value, to_countersignatory_value, broadcaster_funding_key,
2802 countersignatory_funding_key, keys, feerate_per_kw, &mut nondust_htlcs,
2806 pub(crate) fn counterparty_commitment_txs_from_update(&self, update: &ChannelMonitorUpdate) -> Vec<CommitmentTransaction> {
2807 update.updates.iter().filter_map(|update| {
2809 &ChannelMonitorUpdateStep::LatestCounterpartyCommitmentTXInfo { commitment_txid,
2810 ref htlc_outputs, commitment_number, their_per_commitment_point,
2811 feerate_per_kw: Some(feerate_per_kw),
2812 to_broadcaster_value_sat: Some(to_broadcaster_value),
2813 to_countersignatory_value_sat: Some(to_countersignatory_value) } => {
2815 let nondust_htlcs = htlc_outputs.iter().filter_map(|(htlc, _)| {
2816 htlc.transaction_output_index.map(|_| (htlc.clone(), None))
2817 }).collect::<Vec<_>>();
2819 let commitment_tx = self.build_counterparty_commitment_tx(commitment_number,
2820 &their_per_commitment_point, to_broadcaster_value,
2821 to_countersignatory_value, feerate_per_kw, nondust_htlcs);
2823 debug_assert_eq!(commitment_tx.trust().txid(), commitment_txid);
2832 pub(crate) fn sign_to_local_justice_tx(
2833 &self, mut justice_tx: Transaction, input_idx: usize, value: u64, commitment_number: u64
2834 ) -> Result<Transaction, ()> {
2835 let secret = self.get_secret(commitment_number).ok_or(())?;
2836 let per_commitment_key = SecretKey::from_slice(&secret).map_err(|_| ())?;
2837 let their_per_commitment_point = PublicKey::from_secret_key(
2838 &self.onchain_tx_handler.secp_ctx, &per_commitment_key);
2840 let revocation_pubkey = chan_utils::derive_public_revocation_key(
2841 &self.onchain_tx_handler.secp_ctx, &their_per_commitment_point,
2842 &self.holder_revocation_basepoint);
2843 let delayed_key = chan_utils::derive_public_key(&self.onchain_tx_handler.secp_ctx,
2844 &their_per_commitment_point,
2845 &self.counterparty_commitment_params.counterparty_delayed_payment_base_key);
2846 let revokeable_redeemscript = chan_utils::get_revokeable_redeemscript(&revocation_pubkey,
2847 self.counterparty_commitment_params.on_counterparty_tx_csv, &delayed_key);
2849 let sig = self.onchain_tx_handler.signer.sign_justice_revoked_output(
2850 &justice_tx, input_idx, value, &per_commitment_key, &self.onchain_tx_handler.secp_ctx)?;
2851 justice_tx.input[input_idx].witness.push_bitcoin_signature(&sig.serialize_der(), EcdsaSighashType::All);
2852 justice_tx.input[input_idx].witness.push(&[1u8]);
2853 justice_tx.input[input_idx].witness.push(revokeable_redeemscript.as_bytes());
2857 /// Can only fail if idx is < get_min_seen_secret
2858 fn get_secret(&self, idx: u64) -> Option<[u8; 32]> {
2859 self.commitment_secrets.get_secret(idx)
2862 pub(crate) fn get_min_seen_secret(&self) -> u64 {
2863 self.commitment_secrets.get_min_seen_secret()
2866 pub(crate) fn get_cur_counterparty_commitment_number(&self) -> u64 {
2867 self.current_counterparty_commitment_number
2870 pub(crate) fn get_cur_holder_commitment_number(&self) -> u64 {
2871 self.current_holder_commitment_number
2874 /// Attempts to claim a counterparty commitment transaction's outputs using the revocation key and
2875 /// data in counterparty_claimable_outpoints. Will directly claim any HTLC outputs which expire at a
2876 /// height > height + CLTV_SHARED_CLAIM_BUFFER. In any case, will install monitoring for
2877 /// HTLC-Success/HTLC-Timeout transactions.
2879 /// Returns packages to claim the revoked output(s), as well as additional outputs to watch and
2880 /// general information about the output that is to the counterparty in the commitment
2882 fn check_spend_counterparty_transaction<L: Deref>(&mut self, tx: &Transaction, height: u32, block_hash: &BlockHash, logger: &L)
2883 -> (Vec<PackageTemplate>, TransactionOutputs, CommitmentTxCounterpartyOutputInfo)
2884 where L::Target: Logger {
2885 // Most secp and related errors trying to create keys means we have no hope of constructing
2886 // a spend transaction...so we return no transactions to broadcast
2887 let mut claimable_outpoints = Vec::new();
2888 let mut watch_outputs = Vec::new();
2889 let mut to_counterparty_output_info = None;
2891 let commitment_txid = tx.txid(); //TODO: This is gonna be a performance bottleneck for watchtowers!
2892 let per_commitment_option = self.counterparty_claimable_outpoints.get(&commitment_txid);
2894 macro_rules! ignore_error {
2895 ( $thing : expr ) => {
2898 Err(_) => return (claimable_outpoints, (commitment_txid, watch_outputs), to_counterparty_output_info)
2903 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);
2904 if commitment_number >= self.get_min_seen_secret() {
2905 let secret = self.get_secret(commitment_number).unwrap();
2906 let per_commitment_key = ignore_error!(SecretKey::from_slice(&secret));
2907 let per_commitment_point = PublicKey::from_secret_key(&self.onchain_tx_handler.secp_ctx, &per_commitment_key);
2908 let revocation_pubkey = chan_utils::derive_public_revocation_key(&self.onchain_tx_handler.secp_ctx, &per_commitment_point, &self.holder_revocation_basepoint);
2909 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);
2911 let revokeable_redeemscript = chan_utils::get_revokeable_redeemscript(&revocation_pubkey, self.counterparty_commitment_params.on_counterparty_tx_csv, &delayed_key);
2912 let revokeable_p2wsh = revokeable_redeemscript.to_v0_p2wsh();
2914 // First, process non-htlc outputs (to_holder & to_counterparty)
2915 for (idx, outp) in tx.output.iter().enumerate() {
2916 if outp.script_pubkey == revokeable_p2wsh {
2917 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());
2918 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);
2919 claimable_outpoints.push(justice_package);
2920 to_counterparty_output_info =
2921 Some((idx.try_into().expect("Txn can't have more than 2^32 outputs"), outp.value));
2925 // Then, try to find revoked htlc outputs
2926 if let Some(ref per_commitment_data) = per_commitment_option {
2927 for (_, &(ref htlc, _)) in per_commitment_data.iter().enumerate() {
2928 if let Some(transaction_output_index) = htlc.transaction_output_index {
2929 if transaction_output_index as usize >= tx.output.len() ||
2930 tx.output[transaction_output_index as usize].value != htlc.amount_msat / 1000 {
2931 // per_commitment_data is corrupt or our commitment signing key leaked!
2932 return (claimable_outpoints, (commitment_txid, watch_outputs),
2933 to_counterparty_output_info);
2935 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);
2936 let justice_package = PackageTemplate::build_package(commitment_txid, transaction_output_index, PackageSolvingData::RevokedHTLCOutput(revk_htlc_outp), htlc.cltv_expiry, height);
2937 claimable_outpoints.push(justice_package);
2942 // Last, track onchain revoked commitment transaction and fail backward outgoing HTLCs as payment path is broken
2943 if !claimable_outpoints.is_empty() || per_commitment_option.is_some() { // ie we're confident this is actually ours
2944 // We're definitely a counterparty commitment transaction!
2945 log_error!(logger, "Got broadcast of revoked counterparty commitment transaction, going to generate general spend tx with {} inputs", claimable_outpoints.len());
2946 for (idx, outp) in tx.output.iter().enumerate() {
2947 watch_outputs.push((idx as u32, outp.clone()));
2949 self.counterparty_commitment_txn_on_chain.insert(commitment_txid, commitment_number);
2951 if let Some(per_commitment_data) = per_commitment_option {
2952 fail_unbroadcast_htlcs!(self, "revoked_counterparty", commitment_txid, tx, height,
2953 block_hash, per_commitment_data.iter().map(|(htlc, htlc_source)|
2954 (htlc, htlc_source.as_ref().map(|htlc_source| htlc_source.as_ref()))
2957 debug_assert!(false, "We should have per-commitment option for any recognized old commitment txn");
2958 fail_unbroadcast_htlcs!(self, "revoked counterparty", commitment_txid, tx, height,
2959 block_hash, [].iter().map(|reference| *reference), logger);
2962 } else if let Some(per_commitment_data) = per_commitment_option {
2963 // While this isn't useful yet, there is a potential race where if a counterparty
2964 // revokes a state at the same time as the commitment transaction for that state is
2965 // confirmed, and the watchtower receives the block before the user, the user could
2966 // upload a new ChannelMonitor with the revocation secret but the watchtower has
2967 // already processed the block, resulting in the counterparty_commitment_txn_on_chain entry
2968 // not being generated by the above conditional. Thus, to be safe, we go ahead and
2970 for (idx, outp) in tx.output.iter().enumerate() {
2971 watch_outputs.push((idx as u32, outp.clone()));
2973 self.counterparty_commitment_txn_on_chain.insert(commitment_txid, commitment_number);
2975 log_info!(logger, "Got broadcast of non-revoked counterparty commitment transaction {}", commitment_txid);
2976 fail_unbroadcast_htlcs!(self, "counterparty", commitment_txid, tx, height, block_hash,
2977 per_commitment_data.iter().map(|(htlc, htlc_source)|
2978 (htlc, htlc_source.as_ref().map(|htlc_source| htlc_source.as_ref()))
2981 let (htlc_claim_reqs, counterparty_output_info) =
2982 self.get_counterparty_output_claim_info(commitment_number, commitment_txid, Some(tx));
2983 to_counterparty_output_info = counterparty_output_info;
2984 for req in htlc_claim_reqs {
2985 claimable_outpoints.push(req);
2989 (claimable_outpoints, (commitment_txid, watch_outputs), to_counterparty_output_info)
2992 /// Returns the HTLC claim package templates and the counterparty output info
2993 fn get_counterparty_output_claim_info(&self, commitment_number: u64, commitment_txid: Txid, tx: Option<&Transaction>)
2994 -> (Vec<PackageTemplate>, CommitmentTxCounterpartyOutputInfo) {
2995 let mut claimable_outpoints = Vec::new();
2996 let mut to_counterparty_output_info: CommitmentTxCounterpartyOutputInfo = None;
2998 let htlc_outputs = match self.counterparty_claimable_outpoints.get(&commitment_txid) {
2999 Some(outputs) => outputs,
3000 None => return (claimable_outpoints, to_counterparty_output_info),
3002 let per_commitment_points = match self.their_cur_per_commitment_points {
3003 Some(points) => points,
3004 None => return (claimable_outpoints, to_counterparty_output_info),
3007 let per_commitment_point =
3008 // If the counterparty commitment tx is the latest valid state, use their latest
3009 // per-commitment point
3010 if per_commitment_points.0 == commitment_number { &per_commitment_points.1 }
3011 else if let Some(point) = per_commitment_points.2.as_ref() {
3012 // If counterparty commitment tx is the state previous to the latest valid state, use
3013 // their previous per-commitment point (non-atomicity of revocation means it's valid for
3014 // them to temporarily have two valid commitment txns from our viewpoint)
3015 if per_commitment_points.0 == commitment_number + 1 {
3017 } else { return (claimable_outpoints, to_counterparty_output_info); }
3018 } else { return (claimable_outpoints, to_counterparty_output_info); };
3020 if let Some(transaction) = tx {
3021 let revocation_pubkey = chan_utils::derive_public_revocation_key(
3022 &self.onchain_tx_handler.secp_ctx, &per_commitment_point, &self.holder_revocation_basepoint);
3023 let delayed_key = chan_utils::derive_public_key(&self.onchain_tx_handler.secp_ctx,
3024 &per_commitment_point,
3025 &self.counterparty_commitment_params.counterparty_delayed_payment_base_key);
3026 let revokeable_p2wsh = chan_utils::get_revokeable_redeemscript(&revocation_pubkey,
3027 self.counterparty_commitment_params.on_counterparty_tx_csv,
3028 &delayed_key).to_v0_p2wsh();
3029 for (idx, outp) in transaction.output.iter().enumerate() {
3030 if outp.script_pubkey == revokeable_p2wsh {
3031 to_counterparty_output_info =
3032 Some((idx.try_into().expect("Can't have > 2^32 outputs"), outp.value));
3037 for (_, &(ref htlc, _)) in htlc_outputs.iter().enumerate() {
3038 if let Some(transaction_output_index) = htlc.transaction_output_index {
3039 if let Some(transaction) = tx {
3040 if transaction_output_index as usize >= transaction.output.len() ||
3041 transaction.output[transaction_output_index as usize].value != htlc.amount_msat / 1000 {
3042 // per_commitment_data is corrupt or our commitment signing key leaked!
3043 return (claimable_outpoints, to_counterparty_output_info);
3046 let preimage = if htlc.offered { if let Some(p) = self.payment_preimages.get(&htlc.payment_hash) { Some(*p) } else { None } } else { None };
3047 if preimage.is_some() || !htlc.offered {
3048 let counterparty_htlc_outp = if htlc.offered {
3049 PackageSolvingData::CounterpartyOfferedHTLCOutput(
3050 CounterpartyOfferedHTLCOutput::build(*per_commitment_point,
3051 self.counterparty_commitment_params.counterparty_delayed_payment_base_key,
3052 self.counterparty_commitment_params.counterparty_htlc_base_key,
3053 preimage.unwrap(), htlc.clone(), self.onchain_tx_handler.channel_type_features().clone()))
3055 PackageSolvingData::CounterpartyReceivedHTLCOutput(
3056 CounterpartyReceivedHTLCOutput::build(*per_commitment_point,
3057 self.counterparty_commitment_params.counterparty_delayed_payment_base_key,
3058 self.counterparty_commitment_params.counterparty_htlc_base_key,
3059 htlc.clone(), self.onchain_tx_handler.channel_type_features().clone()))
3061 let counterparty_package = PackageTemplate::build_package(commitment_txid, transaction_output_index, counterparty_htlc_outp, htlc.cltv_expiry, 0);
3062 claimable_outpoints.push(counterparty_package);
3067 (claimable_outpoints, to_counterparty_output_info)
3070 /// Attempts to claim a counterparty HTLC-Success/HTLC-Timeout's outputs using the revocation key
3071 fn check_spend_counterparty_htlc<L: Deref>(
3072 &mut self, tx: &Transaction, commitment_number: u64, commitment_txid: &Txid, height: u32, logger: &L
3073 ) -> (Vec<PackageTemplate>, Option<TransactionOutputs>) where L::Target: Logger {
3074 let secret = if let Some(secret) = self.get_secret(commitment_number) { secret } else { return (Vec::new(), None); };
3075 let per_commitment_key = match SecretKey::from_slice(&secret) {
3077 Err(_) => return (Vec::new(), None)
3079 let per_commitment_point = PublicKey::from_secret_key(&self.onchain_tx_handler.secp_ctx, &per_commitment_key);
3081 let htlc_txid = tx.txid();
3082 let mut claimable_outpoints = vec![];
3083 let mut outputs_to_watch = None;
3084 // Previously, we would only claim HTLCs from revoked HTLC transactions if they had 1 input
3085 // with a witness of 5 elements and 1 output. This wasn't enough for anchor outputs, as the
3086 // counterparty can now aggregate multiple HTLCs into a single transaction thanks to
3087 // `SIGHASH_SINGLE` remote signatures, leading us to not claim any HTLCs upon seeing a
3088 // confirmed revoked HTLC transaction (for more details, see
3089 // https://lists.linuxfoundation.org/pipermail/lightning-dev/2022-April/003561.html).
3091 // We make sure we're not vulnerable to this case by checking all inputs of the transaction,
3092 // and claim those which spend the commitment transaction, have a witness of 5 elements, and
3093 // have a corresponding output at the same index within the transaction.
3094 for (idx, input) in tx.input.iter().enumerate() {
3095 if input.previous_output.txid == *commitment_txid && input.witness.len() == 5 && tx.output.get(idx).is_some() {
3096 log_error!(logger, "Got broadcast of revoked counterparty HTLC transaction, spending {}:{}", htlc_txid, idx);
3097 let revk_outp = RevokedOutput::build(
3098 per_commitment_point, self.counterparty_commitment_params.counterparty_delayed_payment_base_key,
3099 self.counterparty_commitment_params.counterparty_htlc_base_key, per_commitment_key,
3100 tx.output[idx].value, self.counterparty_commitment_params.on_counterparty_tx_csv,
3103 let justice_package = PackageTemplate::build_package(
3104 htlc_txid, idx as u32, PackageSolvingData::RevokedOutput(revk_outp),
3105 height + self.counterparty_commitment_params.on_counterparty_tx_csv as u32, height
3107 claimable_outpoints.push(justice_package);
3108 if outputs_to_watch.is_none() {
3109 outputs_to_watch = Some((htlc_txid, vec![]));
3111 outputs_to_watch.as_mut().unwrap().1.push((idx as u32, tx.output[idx].clone()));
3114 (claimable_outpoints, outputs_to_watch)
3117 // Returns (1) `PackageTemplate`s that can be given to the OnchainTxHandler, so that the handler can
3118 // broadcast transactions claiming holder HTLC commitment outputs and (2) a holder revokable
3119 // script so we can detect whether a holder transaction has been seen on-chain.
3120 fn get_broadcasted_holder_claims(&self, holder_tx: &HolderSignedTx, conf_height: u32) -> (Vec<PackageTemplate>, Option<(Script, PublicKey, PublicKey)>) {
3121 let mut claim_requests = Vec::with_capacity(holder_tx.htlc_outputs.len());
3123 let redeemscript = chan_utils::get_revokeable_redeemscript(&holder_tx.revocation_key, self.on_holder_tx_csv, &holder_tx.delayed_payment_key);
3124 let broadcasted_holder_revokable_script = Some((redeemscript.to_v0_p2wsh(), holder_tx.per_commitment_point.clone(), holder_tx.revocation_key.clone()));
3126 for &(ref htlc, _, _) in holder_tx.htlc_outputs.iter() {
3127 if let Some(transaction_output_index) = htlc.transaction_output_index {
3128 let htlc_output = if htlc.offered {
3129 let htlc_output = HolderHTLCOutput::build_offered(
3130 htlc.amount_msat, htlc.cltv_expiry, self.onchain_tx_handler.channel_type_features().clone()
3134 let payment_preimage = if let Some(preimage) = self.payment_preimages.get(&htlc.payment_hash) {
3137 // We can't build an HTLC-Success transaction without the preimage
3140 let htlc_output = HolderHTLCOutput::build_accepted(
3141 payment_preimage, htlc.amount_msat, self.onchain_tx_handler.channel_type_features().clone()
3145 let htlc_package = PackageTemplate::build_package(
3146 holder_tx.txid, transaction_output_index,
3147 PackageSolvingData::HolderHTLCOutput(htlc_output),
3148 htlc.cltv_expiry, conf_height
3150 claim_requests.push(htlc_package);
3154 (claim_requests, broadcasted_holder_revokable_script)
3157 // Returns holder HTLC outputs to watch and react to in case of spending.
3158 fn get_broadcasted_holder_watch_outputs(&self, holder_tx: &HolderSignedTx, commitment_tx: &Transaction) -> Vec<(u32, TxOut)> {
3159 let mut watch_outputs = Vec::with_capacity(holder_tx.htlc_outputs.len());
3160 for &(ref htlc, _, _) in holder_tx.htlc_outputs.iter() {
3161 if let Some(transaction_output_index) = htlc.transaction_output_index {
3162 watch_outputs.push((transaction_output_index, commitment_tx.output[transaction_output_index as usize].clone()));
3168 /// Attempts to claim any claimable HTLCs in a commitment transaction which was not (yet)
3169 /// revoked using data in holder_claimable_outpoints.
3170 /// Should not be used if check_spend_revoked_transaction succeeds.
3171 /// Returns None unless the transaction is definitely one of our commitment transactions.
3172 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 {
3173 let commitment_txid = tx.txid();
3174 let mut claim_requests = Vec::new();
3175 let mut watch_outputs = Vec::new();
3177 macro_rules! append_onchain_update {
3178 ($updates: expr, $to_watch: expr) => {
3179 claim_requests = $updates.0;
3180 self.broadcasted_holder_revokable_script = $updates.1;
3181 watch_outputs.append(&mut $to_watch);
3185 // HTLCs set may differ between last and previous holder commitment txn, in case of one them hitting chain, ensure we cancel all HTLCs backward
3186 let mut is_holder_tx = false;
3188 if self.current_holder_commitment_tx.txid == commitment_txid {
3189 is_holder_tx = true;
3190 log_info!(logger, "Got broadcast of latest holder commitment tx {}, searching for available HTLCs to claim", commitment_txid);
3191 let res = self.get_broadcasted_holder_claims(&self.current_holder_commitment_tx, height);
3192 let mut to_watch = self.get_broadcasted_holder_watch_outputs(&self.current_holder_commitment_tx, tx);
3193 append_onchain_update!(res, to_watch);
3194 fail_unbroadcast_htlcs!(self, "latest holder", commitment_txid, tx, height,
3195 block_hash, self.current_holder_commitment_tx.htlc_outputs.iter()
3196 .map(|(htlc, _, htlc_source)| (htlc, htlc_source.as_ref())), logger);
3197 } else if let &Some(ref holder_tx) = &self.prev_holder_signed_commitment_tx {
3198 if holder_tx.txid == commitment_txid {
3199 is_holder_tx = true;
3200 log_info!(logger, "Got broadcast of previous holder commitment tx {}, searching for available HTLCs to claim", commitment_txid);
3201 let res = self.get_broadcasted_holder_claims(holder_tx, height);
3202 let mut to_watch = self.get_broadcasted_holder_watch_outputs(holder_tx, tx);
3203 append_onchain_update!(res, to_watch);
3204 fail_unbroadcast_htlcs!(self, "previous holder", commitment_txid, tx, height, block_hash,
3205 holder_tx.htlc_outputs.iter().map(|(htlc, _, htlc_source)| (htlc, htlc_source.as_ref())),
3211 Some((claim_requests, (commitment_txid, watch_outputs)))
3217 pub fn get_latest_holder_commitment_txn<L: Deref>(&mut self, logger: &L) -> Vec<Transaction> where L::Target: Logger {
3218 log_debug!(logger, "Getting signed latest holder commitment transaction!");
3219 self.holder_tx_signed = true;
3220 let commitment_tx = self.onchain_tx_handler.get_fully_signed_holder_tx(&self.funding_redeemscript);
3221 let txid = commitment_tx.txid();
3222 let mut holder_transactions = vec![commitment_tx];
3223 // When anchor outputs are present, the HTLC transactions are only valid once the commitment
3224 // transaction confirms.
3225 if self.onchain_tx_handler.channel_type_features().supports_anchors_zero_fee_htlc_tx() {
3226 return holder_transactions;
3228 for htlc in self.current_holder_commitment_tx.htlc_outputs.iter() {
3229 if let Some(vout) = htlc.0.transaction_output_index {
3230 let preimage = if !htlc.0.offered {
3231 if let Some(preimage) = self.payment_preimages.get(&htlc.0.payment_hash) { Some(preimage.clone()) } else {
3232 // We can't build an HTLC-Success transaction without the preimage
3235 } else if htlc.0.cltv_expiry > self.best_block.height() + 1 {
3236 // Don't broadcast HTLC-Timeout transactions immediately as they don't meet the
3237 // current locktime requirements on-chain. We will broadcast them in
3238 // `block_confirmed` when `should_broadcast_holder_commitment_txn` returns true.
3239 // Note that we add + 1 as transactions are broadcastable when they can be
3240 // confirmed in the next block.
3243 if let Some(htlc_tx) = self.onchain_tx_handler.get_fully_signed_htlc_tx(
3244 &::bitcoin::OutPoint { txid, vout }, &preimage) {
3245 holder_transactions.push(htlc_tx);
3249 // 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.
3250 // The data will be re-generated and tracked in check_spend_holder_transaction if we get a confirmation.
3254 #[cfg(any(test,feature = "unsafe_revoked_tx_signing"))]
3255 /// Note that this includes possibly-locktimed-in-the-future transactions!
3256 fn unsafe_get_latest_holder_commitment_txn<L: Deref>(&mut self, logger: &L) -> Vec<Transaction> where L::Target: Logger {
3257 log_debug!(logger, "Getting signed copy of latest holder commitment transaction!");
3258 let commitment_tx = self.onchain_tx_handler.get_fully_signed_copy_holder_tx(&self.funding_redeemscript);
3259 let txid = commitment_tx.txid();
3260 let mut holder_transactions = vec![commitment_tx];
3261 // When anchor outputs are present, the HTLC transactions are only final once the commitment
3262 // transaction confirms due to the CSV 1 encumberance.
3263 if self.onchain_tx_handler.channel_type_features().supports_anchors_zero_fee_htlc_tx() {
3264 return holder_transactions;
3266 for htlc in self.current_holder_commitment_tx.htlc_outputs.iter() {
3267 if let Some(vout) = htlc.0.transaction_output_index {
3268 let preimage = if !htlc.0.offered {
3269 if let Some(preimage) = self.payment_preimages.get(&htlc.0.payment_hash) { Some(preimage.clone()) } else {
3270 // We can't build an HTLC-Success transaction without the preimage
3274 if let Some(htlc_tx) = self.onchain_tx_handler.unsafe_get_fully_signed_htlc_tx(
3275 &::bitcoin::OutPoint { txid, vout }, &preimage) {
3276 holder_transactions.push(htlc_tx);
3283 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>
3284 where B::Target: BroadcasterInterface,
3285 F::Target: FeeEstimator,
3288 let block_hash = header.block_hash();
3289 self.best_block = BestBlock::new(block_hash, height);
3291 let bounded_fee_estimator = LowerBoundedFeeEstimator::new(fee_estimator);
3292 self.transactions_confirmed(header, txdata, height, broadcaster, &bounded_fee_estimator, logger)
3295 fn best_block_updated<B: Deref, F: Deref, L: Deref>(
3297 header: &BlockHeader,
3300 fee_estimator: &LowerBoundedFeeEstimator<F>,
3302 ) -> Vec<TransactionOutputs>
3304 B::Target: BroadcasterInterface,
3305 F::Target: FeeEstimator,
3308 let block_hash = header.block_hash();
3310 if height > self.best_block.height() {
3311 self.best_block = BestBlock::new(block_hash, height);
3312 self.block_confirmed(height, block_hash, vec![], vec![], vec![], &broadcaster, &fee_estimator, &logger)
3313 } else if block_hash != self.best_block.block_hash() {
3314 self.best_block = BestBlock::new(block_hash, height);
3315 self.onchain_events_awaiting_threshold_conf.retain(|ref entry| entry.height <= height);
3316 self.onchain_tx_handler.block_disconnected(height + 1, broadcaster, fee_estimator, logger);
3318 } else { Vec::new() }
3321 fn transactions_confirmed<B: Deref, F: Deref, L: Deref>(
3323 header: &BlockHeader,
3324 txdata: &TransactionData,
3327 fee_estimator: &LowerBoundedFeeEstimator<F>,
3329 ) -> Vec<TransactionOutputs>
3331 B::Target: BroadcasterInterface,
3332 F::Target: FeeEstimator,
3335 let txn_matched = self.filter_block(txdata);
3336 for tx in &txn_matched {
3337 let mut output_val = 0;
3338 for out in tx.output.iter() {
3339 if out.value > 21_000_000_0000_0000 { panic!("Value-overflowing transaction provided to block connected"); }
3340 output_val += out.value;
3341 if output_val > 21_000_000_0000_0000 { panic!("Value-overflowing transaction provided to block connected"); }
3345 let block_hash = header.block_hash();
3347 let mut watch_outputs = Vec::new();
3348 let mut claimable_outpoints = Vec::new();
3349 'tx_iter: for tx in &txn_matched {
3350 let txid = tx.txid();
3351 // If a transaction has already been confirmed, ensure we don't bother processing it duplicatively.
3352 if Some(txid) == self.funding_spend_confirmed {
3353 log_debug!(logger, "Skipping redundant processing of funding-spend tx {} as it was previously confirmed", txid);
3356 for ev in self.onchain_events_awaiting_threshold_conf.iter() {
3357 if ev.txid == txid {
3358 if let Some(conf_hash) = ev.block_hash {
3359 assert_eq!(header.block_hash(), conf_hash,
3360 "Transaction {} was already confirmed and is being re-confirmed in a different block.\n\
3361 This indicates a severe bug in the transaction connection logic - a reorg should have been processed first!", ev.txid);
3363 log_debug!(logger, "Skipping redundant processing of confirming tx {} as it was previously confirmed", txid);
3367 for htlc in self.htlcs_resolved_on_chain.iter() {
3368 if Some(txid) == htlc.resolving_txid {
3369 log_debug!(logger, "Skipping redundant processing of HTLC resolution tx {} as it was previously confirmed", txid);
3373 for spendable_txid in self.spendable_txids_confirmed.iter() {
3374 if txid == *spendable_txid {
3375 log_debug!(logger, "Skipping redundant processing of spendable tx {} as it was previously confirmed", txid);
3380 if tx.input.len() == 1 {
3381 // Assuming our keys were not leaked (in which case we're screwed no matter what),
3382 // commitment transactions and HTLC transactions will all only ever have one input
3383 // (except for HTLC transactions for channels with anchor outputs), which is an easy
3384 // way to filter out any potential non-matching txn for lazy filters.
3385 let prevout = &tx.input[0].previous_output;
3386 if prevout.txid == self.funding_info.0.txid && prevout.vout == self.funding_info.0.index as u32 {
3387 let mut balance_spendable_csv = None;
3388 log_info!(logger, "Channel {} closed by funding output spend in txid {}.",
3389 &self.funding_info.0.to_channel_id(), txid);
3390 self.funding_spend_seen = true;
3391 let mut commitment_tx_to_counterparty_output = None;
3392 if (tx.input[0].sequence.0 >> 8*3) as u8 == 0x80 && (tx.lock_time.0 >> 8*3) as u8 == 0x20 {
3393 let (mut new_outpoints, new_outputs, counterparty_output_idx_sats) =
3394 self.check_spend_counterparty_transaction(&tx, height, &block_hash, &logger);
3395 commitment_tx_to_counterparty_output = counterparty_output_idx_sats;
3396 if !new_outputs.1.is_empty() {
3397 watch_outputs.push(new_outputs);
3399 claimable_outpoints.append(&mut new_outpoints);
3400 if new_outpoints.is_empty() {
3401 if let Some((mut new_outpoints, new_outputs)) = self.check_spend_holder_transaction(&tx, height, &block_hash, &logger) {
3402 debug_assert!(commitment_tx_to_counterparty_output.is_none(),
3403 "A commitment transaction matched as both a counterparty and local commitment tx?");
3404 if !new_outputs.1.is_empty() {
3405 watch_outputs.push(new_outputs);
3407 claimable_outpoints.append(&mut new_outpoints);
3408 balance_spendable_csv = Some(self.on_holder_tx_csv);
3412 self.onchain_events_awaiting_threshold_conf.push(OnchainEventEntry {
3414 transaction: Some((*tx).clone()),
3416 block_hash: Some(block_hash),
3417 event: OnchainEvent::FundingSpendConfirmation {
3418 on_local_output_csv: balance_spendable_csv,
3419 commitment_tx_to_counterparty_output,
3424 if tx.input.len() >= 1 {
3425 // While all commitment transactions have one input, HTLC transactions may have more
3426 // if the HTLC was present in an anchor channel. HTLCs can also be resolved in a few
3427 // other ways which can have more than one output.
3428 for tx_input in &tx.input {
3429 let commitment_txid = tx_input.previous_output.txid;
3430 if let Some(&commitment_number) = self.counterparty_commitment_txn_on_chain.get(&commitment_txid) {
3431 let (mut new_outpoints, new_outputs_option) = self.check_spend_counterparty_htlc(
3432 &tx, commitment_number, &commitment_txid, height, &logger
3434 claimable_outpoints.append(&mut new_outpoints);
3435 if let Some(new_outputs) = new_outputs_option {
3436 watch_outputs.push(new_outputs);
3438 // Since there may be multiple HTLCs for this channel (all spending the
3439 // same commitment tx) being claimed by the counterparty within the same
3440 // transaction, and `check_spend_counterparty_htlc` already checks all the
3441 // ones relevant to this channel, we can safely break from our loop.
3445 self.is_resolving_htlc_output(&tx, height, &block_hash, &logger);
3447 self.is_paying_spendable_output(&tx, height, &block_hash, &logger);
3451 if height > self.best_block.height() {
3452 self.best_block = BestBlock::new(block_hash, height);
3455 self.block_confirmed(height, block_hash, txn_matched, watch_outputs, claimable_outpoints, &broadcaster, &fee_estimator, &logger)
3458 /// Update state for new block(s)/transaction(s) confirmed. Note that the caller must update
3459 /// `self.best_block` before calling if a new best blockchain tip is available. More
3460 /// concretely, `self.best_block` must never be at a lower height than `conf_height`, avoiding
3461 /// complexity especially in
3462 /// `OnchainTx::update_claims_view_from_requests`/`OnchainTx::update_claims_view_from_matched_txn`.
3464 /// `conf_height` should be set to the height at which any new transaction(s)/block(s) were
3465 /// confirmed at, even if it is not the current best height.
3466 fn block_confirmed<B: Deref, F: Deref, L: Deref>(
3469 conf_hash: BlockHash,
3470 txn_matched: Vec<&Transaction>,
3471 mut watch_outputs: Vec<TransactionOutputs>,
3472 mut claimable_outpoints: Vec<PackageTemplate>,
3474 fee_estimator: &LowerBoundedFeeEstimator<F>,
3476 ) -> Vec<TransactionOutputs>
3478 B::Target: BroadcasterInterface,
3479 F::Target: FeeEstimator,
3482 log_trace!(logger, "Processing {} matched transactions for block at height {}.", txn_matched.len(), conf_height);
3483 debug_assert!(self.best_block.height() >= conf_height);
3485 let should_broadcast = self.should_broadcast_holder_commitment_txn(logger);
3486 if should_broadcast {
3487 let funding_outp = HolderFundingOutput::build(self.funding_redeemscript.clone(), self.channel_value_satoshis, self.onchain_tx_handler.channel_type_features().clone());
3488 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());
3489 claimable_outpoints.push(commitment_package);
3490 self.pending_monitor_events.push(MonitorEvent::CommitmentTxConfirmed(self.funding_info.0));
3491 // Although we aren't signing the transaction directly here, the transaction will be signed
3492 // in the claim that is queued to OnchainTxHandler. We set holder_tx_signed here to reject
3493 // new channel updates.
3494 self.holder_tx_signed = true;
3495 // We can't broadcast our HTLC transactions while the commitment transaction is
3496 // unconfirmed. We'll delay doing so until we detect the confirmed commitment in
3497 // `transactions_confirmed`.
3498 if !self.onchain_tx_handler.channel_type_features().supports_anchors_zero_fee_htlc_tx() {
3499 // Because we're broadcasting a commitment transaction, we should construct the package
3500 // assuming it gets confirmed in the next block. Sadly, we have code which considers
3501 // "not yet confirmed" things as discardable, so we cannot do that here.
3502 let (mut new_outpoints, _) = self.get_broadcasted_holder_claims(&self.current_holder_commitment_tx, self.best_block.height());
3503 let unsigned_commitment_tx = self.onchain_tx_handler.get_unsigned_holder_commitment_tx();
3504 let new_outputs = self.get_broadcasted_holder_watch_outputs(&self.current_holder_commitment_tx, &unsigned_commitment_tx);
3505 if !new_outputs.is_empty() {
3506 watch_outputs.push((self.current_holder_commitment_tx.txid.clone(), new_outputs));
3508 claimable_outpoints.append(&mut new_outpoints);
3512 // Find which on-chain events have reached their confirmation threshold.
3513 let onchain_events_awaiting_threshold_conf =
3514 self.onchain_events_awaiting_threshold_conf.drain(..).collect::<Vec<_>>();
3515 let mut onchain_events_reaching_threshold_conf = Vec::new();
3516 for entry in onchain_events_awaiting_threshold_conf {
3517 if entry.has_reached_confirmation_threshold(&self.best_block) {
3518 onchain_events_reaching_threshold_conf.push(entry);
3520 self.onchain_events_awaiting_threshold_conf.push(entry);
3524 // Used to check for duplicate HTLC resolutions.
3525 #[cfg(debug_assertions)]
3526 let unmatured_htlcs: Vec<_> = self.onchain_events_awaiting_threshold_conf
3528 .filter_map(|entry| match &entry.event {
3529 OnchainEvent::HTLCUpdate { source, .. } => Some(source),
3533 #[cfg(debug_assertions)]
3534 let mut matured_htlcs = Vec::new();
3536 // Produce actionable events from on-chain events having reached their threshold.
3537 for entry in onchain_events_reaching_threshold_conf.drain(..) {
3539 OnchainEvent::HTLCUpdate { ref source, payment_hash, htlc_value_satoshis, commitment_tx_output_idx } => {
3540 // Check for duplicate HTLC resolutions.
3541 #[cfg(debug_assertions)]
3544 unmatured_htlcs.iter().find(|&htlc| htlc == &source).is_none(),
3545 "An unmature HTLC transaction conflicts with a maturing one; failed to \
3546 call either transaction_unconfirmed for the conflicting transaction \
3547 or block_disconnected for a block containing it.");
3549 matured_htlcs.iter().find(|&htlc| htlc == source).is_none(),
3550 "A matured HTLC transaction conflicts with a maturing one; failed to \
3551 call either transaction_unconfirmed for the conflicting transaction \
3552 or block_disconnected for a block containing it.");
3553 matured_htlcs.push(source.clone());
3556 log_debug!(logger, "HTLC {} failure update in {} has got enough confirmations to be passed upstream",
3557 &payment_hash, entry.txid);
3558 self.pending_monitor_events.push(MonitorEvent::HTLCEvent(HTLCUpdate {
3560 payment_preimage: None,
3561 source: source.clone(),
3562 htlc_value_satoshis,
3564 self.htlcs_resolved_on_chain.push(IrrevocablyResolvedHTLC {
3565 commitment_tx_output_idx,
3566 resolving_txid: Some(entry.txid),
3567 resolving_tx: entry.transaction,
3568 payment_preimage: None,
3571 OnchainEvent::MaturingOutput { descriptor } => {
3572 log_debug!(logger, "Descriptor {} has got enough confirmations to be passed upstream", log_spendable!(descriptor));
3573 self.pending_events.push(Event::SpendableOutputs {
3574 outputs: vec![descriptor],
3575 channel_id: Some(self.funding_info.0.to_channel_id()),
3577 self.spendable_txids_confirmed.push(entry.txid);
3579 OnchainEvent::HTLCSpendConfirmation { commitment_tx_output_idx, preimage, .. } => {
3580 self.htlcs_resolved_on_chain.push(IrrevocablyResolvedHTLC {
3581 commitment_tx_output_idx: Some(commitment_tx_output_idx),
3582 resolving_txid: Some(entry.txid),
3583 resolving_tx: entry.transaction,
3584 payment_preimage: preimage,
3587 OnchainEvent::FundingSpendConfirmation { commitment_tx_to_counterparty_output, .. } => {
3588 self.funding_spend_confirmed = Some(entry.txid);
3589 self.confirmed_commitment_tx_counterparty_output = commitment_tx_to_counterparty_output;
3594 self.onchain_tx_handler.update_claims_view_from_requests(claimable_outpoints, conf_height, self.best_block.height(), broadcaster, fee_estimator, logger);
3595 self.onchain_tx_handler.update_claims_view_from_matched_txn(&txn_matched, conf_height, conf_hash, self.best_block.height(), broadcaster, fee_estimator, logger);
3597 // Determine new outputs to watch by comparing against previously known outputs to watch,
3598 // updating the latter in the process.
3599 watch_outputs.retain(|&(ref txid, ref txouts)| {
3600 let idx_and_scripts = txouts.iter().map(|o| (o.0, o.1.script_pubkey.clone())).collect();
3601 self.outputs_to_watch.insert(txid.clone(), idx_and_scripts).is_none()
3605 // If we see a transaction for which we registered outputs previously,
3606 // make sure the registered scriptpubkey at the expected index match
3607 // the actual transaction output one. We failed this case before #653.
3608 for tx in &txn_matched {
3609 if let Some(outputs) = self.get_outputs_to_watch().get(&tx.txid()) {
3610 for idx_and_script in outputs.iter() {
3611 assert!((idx_and_script.0 as usize) < tx.output.len());
3612 assert_eq!(tx.output[idx_and_script.0 as usize].script_pubkey, idx_and_script.1);
3620 pub fn block_disconnected<B: Deref, F: Deref, L: Deref>(&mut self, header: &BlockHeader, height: u32, broadcaster: B, fee_estimator: F, logger: L)
3621 where B::Target: BroadcasterInterface,
3622 F::Target: FeeEstimator,
3625 log_trace!(logger, "Block {} at height {} disconnected", header.block_hash(), height);
3628 //- htlc update there as failure-trigger tx (revoked commitment tx, non-revoked commitment tx, HTLC-timeout tx) has been disconnected
3629 //- maturing spendable output has transaction paying us has been disconnected
3630 self.onchain_events_awaiting_threshold_conf.retain(|ref entry| entry.height < height);
3632 let bounded_fee_estimator = LowerBoundedFeeEstimator::new(fee_estimator);
3633 self.onchain_tx_handler.block_disconnected(height, broadcaster, &bounded_fee_estimator, logger);
3635 self.best_block = BestBlock::new(header.prev_blockhash, height - 1);
3638 fn transaction_unconfirmed<B: Deref, F: Deref, L: Deref>(
3642 fee_estimator: &LowerBoundedFeeEstimator<F>,
3645 B::Target: BroadcasterInterface,
3646 F::Target: FeeEstimator,
3649 let mut removed_height = None;
3650 for entry in self.onchain_events_awaiting_threshold_conf.iter() {
3651 if entry.txid == *txid {
3652 removed_height = Some(entry.height);
3657 if let Some(removed_height) = removed_height {
3658 log_info!(logger, "transaction_unconfirmed of txid {} implies height {} was reorg'd out", txid, removed_height);
3659 self.onchain_events_awaiting_threshold_conf.retain(|ref entry| if entry.height >= removed_height {
3660 log_info!(logger, "Transaction {} reorg'd out", entry.txid);
3665 debug_assert!(!self.onchain_events_awaiting_threshold_conf.iter().any(|ref entry| entry.txid == *txid));
3667 self.onchain_tx_handler.transaction_unconfirmed(txid, broadcaster, fee_estimator, logger);
3670 /// Filters a block's `txdata` for transactions spending watched outputs or for any child
3671 /// transactions thereof.
3672 fn filter_block<'a>(&self, txdata: &TransactionData<'a>) -> Vec<&'a Transaction> {
3673 let mut matched_txn = HashSet::new();
3674 txdata.iter().filter(|&&(_, tx)| {
3675 let mut matches = self.spends_watched_output(tx);
3676 for input in tx.input.iter() {
3677 if matches { break; }
3678 if matched_txn.contains(&input.previous_output.txid) {
3683 matched_txn.insert(tx.txid());
3686 }).map(|(_, tx)| *tx).collect()
3689 /// Checks if a given transaction spends any watched outputs.
3690 fn spends_watched_output(&self, tx: &Transaction) -> bool {
3691 for input in tx.input.iter() {
3692 if let Some(outputs) = self.get_outputs_to_watch().get(&input.previous_output.txid) {
3693 for (idx, _script_pubkey) in outputs.iter() {
3694 if *idx == input.previous_output.vout {
3697 // If the expected script is a known type, check that the witness
3698 // appears to be spending the correct type (ie that the match would
3699 // actually succeed in BIP 158/159-style filters).
3700 if _script_pubkey.is_v0_p2wsh() {
3701 if input.witness.last().unwrap().to_vec() == deliberately_bogus_accepted_htlc_witness_program() {
3702 // In at least one test we use a deliberately bogus witness
3703 // script which hit an old panic. Thus, we check for that here
3704 // and avoid the assert if its the expected bogus script.
3708 assert_eq!(&bitcoin::Address::p2wsh(&Script::from(input.witness.last().unwrap().to_vec()), bitcoin::Network::Bitcoin).script_pubkey(), _script_pubkey);
3709 } else if _script_pubkey.is_v0_p2wpkh() {
3710 assert_eq!(&bitcoin::Address::p2wpkh(&bitcoin::PublicKey::from_slice(&input.witness.last().unwrap()).unwrap(), bitcoin::Network::Bitcoin).unwrap().script_pubkey(), _script_pubkey);
3711 } else { panic!(); }
3722 fn should_broadcast_holder_commitment_txn<L: Deref>(&self, logger: &L) -> bool where L::Target: Logger {
3723 // There's no need to broadcast our commitment transaction if we've seen one confirmed (even
3724 // with 1 confirmation) as it'll be rejected as duplicate/conflicting.
3725 if self.funding_spend_confirmed.is_some() ||
3726 self.onchain_events_awaiting_threshold_conf.iter().find(|event| match event.event {
3727 OnchainEvent::FundingSpendConfirmation { .. } => true,
3733 // We need to consider all HTLCs which are:
3734 // * in any unrevoked counterparty commitment transaction, as they could broadcast said
3735 // transactions and we'd end up in a race, or
3736 // * are in our latest holder commitment transaction, as this is the thing we will
3737 // broadcast if we go on-chain.
3738 // Note that we consider HTLCs which were below dust threshold here - while they don't
3739 // strictly imply that we need to fail the channel, we need to go ahead and fail them back
3740 // to the source, and if we don't fail the channel we will have to ensure that the next
3741 // updates that peer sends us are update_fails, failing the channel if not. It's probably
3742 // easier to just fail the channel as this case should be rare enough anyway.
3743 let height = self.best_block.height();
3744 macro_rules! scan_commitment {
3745 ($htlcs: expr, $holder_tx: expr) => {
3746 for ref htlc in $htlcs {
3747 // For inbound HTLCs which we know the preimage for, we have to ensure we hit the
3748 // chain with enough room to claim the HTLC without our counterparty being able to
3749 // time out the HTLC first.
3750 // For outbound HTLCs which our counterparty hasn't failed/claimed, our primary
3751 // concern is being able to claim the corresponding inbound HTLC (on another
3752 // channel) before it expires. In fact, we don't even really care if our
3753 // counterparty here claims such an outbound HTLC after it expired as long as we
3754 // can still claim the corresponding HTLC. Thus, to avoid needlessly hitting the
3755 // chain when our counterparty is waiting for expiration to off-chain fail an HTLC
3756 // we give ourselves a few blocks of headroom after expiration before going
3757 // on-chain for an expired HTLC.
3758 // Note that, to avoid a potential attack whereby a node delays claiming an HTLC
3759 // from us until we've reached the point where we go on-chain with the
3760 // corresponding inbound HTLC, we must ensure that outbound HTLCs go on chain at
3761 // least CLTV_CLAIM_BUFFER blocks prior to the inbound HTLC.
3762 // aka outbound_cltv + LATENCY_GRACE_PERIOD_BLOCKS == height - CLTV_CLAIM_BUFFER
3763 // inbound_cltv == height + CLTV_CLAIM_BUFFER
3764 // outbound_cltv + LATENCY_GRACE_PERIOD_BLOCKS + CLTV_CLAIM_BUFFER <= inbound_cltv - CLTV_CLAIM_BUFFER
3765 // LATENCY_GRACE_PERIOD_BLOCKS + 2*CLTV_CLAIM_BUFFER <= inbound_cltv - outbound_cltv
3766 // CLTV_EXPIRY_DELTA <= inbound_cltv - outbound_cltv (by check in ChannelManager::decode_update_add_htlc_onion)
3767 // LATENCY_GRACE_PERIOD_BLOCKS + 2*CLTV_CLAIM_BUFFER <= CLTV_EXPIRY_DELTA
3768 // The final, above, condition is checked for statically in channelmanager
3769 // with CHECK_CLTV_EXPIRY_SANITY_2.
3770 let htlc_outbound = $holder_tx == htlc.offered;
3771 if ( htlc_outbound && htlc.cltv_expiry + LATENCY_GRACE_PERIOD_BLOCKS <= height) ||
3772 (!htlc_outbound && htlc.cltv_expiry <= height + CLTV_CLAIM_BUFFER && self.payment_preimages.contains_key(&htlc.payment_hash)) {
3773 log_info!(logger, "Force-closing channel due to {} HTLC timeout, HTLC expiry is {}", if htlc_outbound { "outbound" } else { "inbound "}, htlc.cltv_expiry);
3780 scan_commitment!(self.current_holder_commitment_tx.htlc_outputs.iter().map(|&(ref a, _, _)| a), true);
3782 if let Some(ref txid) = self.current_counterparty_commitment_txid {
3783 if let Some(ref htlc_outputs) = self.counterparty_claimable_outpoints.get(txid) {
3784 scan_commitment!(htlc_outputs.iter().map(|&(ref a, _)| a), false);
3787 if let Some(ref txid) = self.prev_counterparty_commitment_txid {
3788 if let Some(ref htlc_outputs) = self.counterparty_claimable_outpoints.get(txid) {
3789 scan_commitment!(htlc_outputs.iter().map(|&(ref a, _)| a), false);
3796 /// Check if any transaction broadcasted is resolving HTLC output by a success or timeout on a holder
3797 /// or counterparty commitment tx, if so send back the source, preimage if found and payment_hash of resolved HTLC
3798 fn is_resolving_htlc_output<L: Deref>(&mut self, tx: &Transaction, height: u32, block_hash: &BlockHash, logger: &L) where L::Target: Logger {
3799 'outer_loop: for input in &tx.input {
3800 let mut payment_data = None;
3801 let htlc_claim = HTLCClaim::from_witness(&input.witness);
3802 let revocation_sig_claim = htlc_claim == Some(HTLCClaim::Revocation);
3803 let accepted_preimage_claim = htlc_claim == Some(HTLCClaim::AcceptedPreimage);
3804 #[cfg(not(fuzzing))]
3805 let accepted_timeout_claim = htlc_claim == Some(HTLCClaim::AcceptedTimeout);
3806 let offered_preimage_claim = htlc_claim == Some(HTLCClaim::OfferedPreimage);
3807 #[cfg(not(fuzzing))]
3808 let offered_timeout_claim = htlc_claim == Some(HTLCClaim::OfferedTimeout);
3810 let mut payment_preimage = PaymentPreimage([0; 32]);
3811 if offered_preimage_claim || accepted_preimage_claim {
3812 payment_preimage.0.copy_from_slice(input.witness.second_to_last().unwrap());
3815 macro_rules! log_claim {
3816 ($tx_info: expr, $holder_tx: expr, $htlc: expr, $source_avail: expr) => {
3817 let outbound_htlc = $holder_tx == $htlc.offered;
3818 // HTLCs must either be claimed by a matching script type or through the
3820 #[cfg(not(fuzzing))] // Note that the fuzzer is not bound by pesky things like "signatures"
3821 debug_assert!(!$htlc.offered || offered_preimage_claim || offered_timeout_claim || revocation_sig_claim);
3822 #[cfg(not(fuzzing))] // Note that the fuzzer is not bound by pesky things like "signatures"
3823 debug_assert!($htlc.offered || accepted_preimage_claim || accepted_timeout_claim || revocation_sig_claim);
3824 // Further, only exactly one of the possible spend paths should have been
3825 // matched by any HTLC spend:
3826 #[cfg(not(fuzzing))] // Note that the fuzzer is not bound by pesky things like "signatures"
3827 debug_assert_eq!(accepted_preimage_claim as u8 + accepted_timeout_claim as u8 +
3828 offered_preimage_claim as u8 + offered_timeout_claim as u8 +
3829 revocation_sig_claim as u8, 1);
3830 if ($holder_tx && revocation_sig_claim) ||
3831 (outbound_htlc && !$source_avail && (accepted_preimage_claim || offered_preimage_claim)) {
3832 log_error!(logger, "Input spending {} ({}:{}) in {} resolves {} HTLC with payment hash {} with {}!",
3833 $tx_info, input.previous_output.txid, input.previous_output.vout, tx.txid(),
3834 if outbound_htlc { "outbound" } else { "inbound" }, &$htlc.payment_hash,
3835 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" });
3837 log_info!(logger, "Input spending {} ({}:{}) in {} resolves {} HTLC with payment hash {} with {}",
3838 $tx_info, input.previous_output.txid, input.previous_output.vout, tx.txid(),
3839 if outbound_htlc { "outbound" } else { "inbound" }, &$htlc.payment_hash,
3840 if revocation_sig_claim { "revocation sig" } else if accepted_preimage_claim || offered_preimage_claim { "preimage" } else { "timeout" });
3845 macro_rules! check_htlc_valid_counterparty {
3846 ($counterparty_txid: expr, $htlc_output: expr) => {
3847 if let Some(txid) = $counterparty_txid {
3848 for &(ref pending_htlc, ref pending_source) in self.counterparty_claimable_outpoints.get(&txid).unwrap() {
3849 if pending_htlc.payment_hash == $htlc_output.payment_hash && pending_htlc.amount_msat == $htlc_output.amount_msat {
3850 if let &Some(ref source) = pending_source {
3851 log_claim!("revoked counterparty commitment tx", false, pending_htlc, true);
3852 payment_data = Some(((**source).clone(), $htlc_output.payment_hash, $htlc_output.amount_msat));
3861 macro_rules! scan_commitment {
3862 ($htlcs: expr, $tx_info: expr, $holder_tx: expr) => {
3863 for (ref htlc_output, source_option) in $htlcs {
3864 if Some(input.previous_output.vout) == htlc_output.transaction_output_index {
3865 if let Some(ref source) = source_option {
3866 log_claim!($tx_info, $holder_tx, htlc_output, true);
3867 // We have a resolution of an HTLC either from one of our latest
3868 // holder commitment transactions or an unrevoked counterparty commitment
3869 // transaction. This implies we either learned a preimage, the HTLC
3870 // has timed out, or we screwed up. In any case, we should now
3871 // resolve the source HTLC with the original sender.
3872 payment_data = Some(((*source).clone(), htlc_output.payment_hash, htlc_output.amount_msat));
3873 } else if !$holder_tx {
3874 check_htlc_valid_counterparty!(self.current_counterparty_commitment_txid, htlc_output);
3875 if payment_data.is_none() {
3876 check_htlc_valid_counterparty!(self.prev_counterparty_commitment_txid, htlc_output);
3879 if payment_data.is_none() {
3880 log_claim!($tx_info, $holder_tx, htlc_output, false);
3881 let outbound_htlc = $holder_tx == htlc_output.offered;
3882 self.onchain_events_awaiting_threshold_conf.push(OnchainEventEntry {
3883 txid: tx.txid(), height, block_hash: Some(*block_hash), transaction: Some(tx.clone()),
3884 event: OnchainEvent::HTLCSpendConfirmation {
3885 commitment_tx_output_idx: input.previous_output.vout,
3886 preimage: if accepted_preimage_claim || offered_preimage_claim {
3887 Some(payment_preimage) } else { None },
3888 // If this is a payment to us (ie !outbound_htlc), wait for
3889 // the CSV delay before dropping the HTLC from claimable
3890 // balance if the claim was an HTLC-Success transaction (ie
3891 // accepted_preimage_claim).
3892 on_to_local_output_csv: if accepted_preimage_claim && !outbound_htlc {
3893 Some(self.on_holder_tx_csv) } else { None },
3896 continue 'outer_loop;
3903 if input.previous_output.txid == self.current_holder_commitment_tx.txid {
3904 scan_commitment!(self.current_holder_commitment_tx.htlc_outputs.iter().map(|&(ref a, _, ref b)| (a, b.as_ref())),
3905 "our latest holder commitment tx", true);
3907 if let Some(ref prev_holder_signed_commitment_tx) = self.prev_holder_signed_commitment_tx {
3908 if input.previous_output.txid == prev_holder_signed_commitment_tx.txid {
3909 scan_commitment!(prev_holder_signed_commitment_tx.htlc_outputs.iter().map(|&(ref a, _, ref b)| (a, b.as_ref())),
3910 "our previous holder commitment tx", true);
3913 if let Some(ref htlc_outputs) = self.counterparty_claimable_outpoints.get(&input.previous_output.txid) {
3914 scan_commitment!(htlc_outputs.iter().map(|&(ref a, ref b)| (a, (b.as_ref().clone()).map(|boxed| &**boxed))),
3915 "counterparty commitment tx", false);
3918 // Check that scan_commitment, above, decided there is some source worth relaying an
3919 // HTLC resolution backwards to and figure out whether we learned a preimage from it.
3920 if let Some((source, payment_hash, amount_msat)) = payment_data {
3921 if accepted_preimage_claim {
3922 if !self.pending_monitor_events.iter().any(
3923 |update| if let &MonitorEvent::HTLCEvent(ref upd) = update { upd.source == source } else { false }) {
3924 self.onchain_events_awaiting_threshold_conf.push(OnchainEventEntry {
3927 block_hash: Some(*block_hash),
3928 transaction: Some(tx.clone()),
3929 event: OnchainEvent::HTLCSpendConfirmation {
3930 commitment_tx_output_idx: input.previous_output.vout,
3931 preimage: Some(payment_preimage),
3932 on_to_local_output_csv: None,
3935 self.pending_monitor_events.push(MonitorEvent::HTLCEvent(HTLCUpdate {
3937 payment_preimage: Some(payment_preimage),
3939 htlc_value_satoshis: Some(amount_msat / 1000),
3942 } else if offered_preimage_claim {
3943 if !self.pending_monitor_events.iter().any(
3944 |update| if let &MonitorEvent::HTLCEvent(ref upd) = update {
3945 upd.source == source
3947 self.onchain_events_awaiting_threshold_conf.push(OnchainEventEntry {
3949 transaction: Some(tx.clone()),
3951 block_hash: Some(*block_hash),
3952 event: OnchainEvent::HTLCSpendConfirmation {
3953 commitment_tx_output_idx: input.previous_output.vout,
3954 preimage: Some(payment_preimage),
3955 on_to_local_output_csv: None,
3958 self.pending_monitor_events.push(MonitorEvent::HTLCEvent(HTLCUpdate {
3960 payment_preimage: Some(payment_preimage),
3962 htlc_value_satoshis: Some(amount_msat / 1000),
3966 self.onchain_events_awaiting_threshold_conf.retain(|ref entry| {
3967 if entry.height != height { return true; }
3969 OnchainEvent::HTLCUpdate { source: ref htlc_source, .. } => {
3970 *htlc_source != source
3975 let entry = OnchainEventEntry {
3977 transaction: Some(tx.clone()),
3979 block_hash: Some(*block_hash),
3980 event: OnchainEvent::HTLCUpdate {
3981 source, payment_hash,
3982 htlc_value_satoshis: Some(amount_msat / 1000),
3983 commitment_tx_output_idx: Some(input.previous_output.vout),
3986 log_info!(logger, "Failing HTLC with payment_hash {} timeout by a spend tx, waiting for confirmation (at height {})", &payment_hash, entry.confirmation_threshold());
3987 self.onchain_events_awaiting_threshold_conf.push(entry);
3993 /// Check if any transaction broadcasted is paying fund back to some address we can assume to own
3994 fn is_paying_spendable_output<L: Deref>(&mut self, tx: &Transaction, height: u32, block_hash: &BlockHash, logger: &L) where L::Target: Logger {
3995 let mut spendable_output = None;
3996 for (i, outp) in tx.output.iter().enumerate() { // There is max one spendable output for any channel tx, including ones generated by us
3997 if i > ::core::u16::MAX as usize {
3998 // While it is possible that an output exists on chain which is greater than the
3999 // 2^16th output in a given transaction, this is only possible if the output is not
4000 // in a lightning transaction and was instead placed there by some third party who
4001 // wishes to give us money for no reason.
4002 // Namely, any lightning transactions which we pre-sign will never have anywhere
4003 // near 2^16 outputs both because such transactions must have ~2^16 outputs who's
4004 // scripts are not longer than one byte in length and because they are inherently
4005 // non-standard due to their size.
4006 // Thus, it is completely safe to ignore such outputs, and while it may result in
4007 // us ignoring non-lightning fund to us, that is only possible if someone fills
4008 // nearly a full block with garbage just to hit this case.
4011 if outp.script_pubkey == self.destination_script {
4012 spendable_output = Some(SpendableOutputDescriptor::StaticOutput {
4013 outpoint: OutPoint { txid: tx.txid(), index: i as u16 },
4014 output: outp.clone(),
4018 if let Some(ref broadcasted_holder_revokable_script) = self.broadcasted_holder_revokable_script {
4019 if broadcasted_holder_revokable_script.0 == outp.script_pubkey {
4020 spendable_output = Some(SpendableOutputDescriptor::DelayedPaymentOutput(DelayedPaymentOutputDescriptor {
4021 outpoint: OutPoint { txid: tx.txid(), index: i as u16 },
4022 per_commitment_point: broadcasted_holder_revokable_script.1,
4023 to_self_delay: self.on_holder_tx_csv,
4024 output: outp.clone(),
4025 revocation_pubkey: broadcasted_holder_revokable_script.2.clone(),
4026 channel_keys_id: self.channel_keys_id,
4027 channel_value_satoshis: self.channel_value_satoshis,
4032 if self.counterparty_payment_script == outp.script_pubkey {
4033 spendable_output = Some(SpendableOutputDescriptor::StaticPaymentOutput(StaticPaymentOutputDescriptor {
4034 outpoint: OutPoint { txid: tx.txid(), index: i as u16 },
4035 output: outp.clone(),
4036 channel_keys_id: self.channel_keys_id,
4037 channel_value_satoshis: self.channel_value_satoshis,
4041 if self.shutdown_script.as_ref() == Some(&outp.script_pubkey) {
4042 spendable_output = Some(SpendableOutputDescriptor::StaticOutput {
4043 outpoint: OutPoint { txid: tx.txid(), index: i as u16 },
4044 output: outp.clone(),
4049 if let Some(spendable_output) = spendable_output {
4050 let entry = OnchainEventEntry {
4052 transaction: Some(tx.clone()),
4054 block_hash: Some(*block_hash),
4055 event: OnchainEvent::MaturingOutput { descriptor: spendable_output.clone() },
4057 log_info!(logger, "Received spendable output {}, spendable at height {}", log_spendable!(spendable_output), entry.confirmation_threshold());
4058 self.onchain_events_awaiting_threshold_conf.push(entry);
4063 impl<Signer: WriteableEcdsaChannelSigner, T: Deref, F: Deref, L: Deref> chain::Listen for (ChannelMonitor<Signer>, T, F, L)
4065 T::Target: BroadcasterInterface,
4066 F::Target: FeeEstimator,
4069 fn filtered_block_connected(&self, header: &BlockHeader, txdata: &TransactionData, height: u32) {
4070 self.0.block_connected(header, txdata, height, &*self.1, &*self.2, &*self.3);
4073 fn block_disconnected(&self, header: &BlockHeader, height: u32) {
4074 self.0.block_disconnected(header, height, &*self.1, &*self.2, &*self.3);
4078 impl<Signer: WriteableEcdsaChannelSigner, M, T: Deref, F: Deref, L: Deref> chain::Confirm for (M, T, F, L)
4080 M: Deref<Target = ChannelMonitor<Signer>>,
4081 T::Target: BroadcasterInterface,
4082 F::Target: FeeEstimator,
4085 fn transactions_confirmed(&self, header: &BlockHeader, txdata: &TransactionData, height: u32) {
4086 self.0.transactions_confirmed(header, txdata, height, &*self.1, &*self.2, &*self.3);
4089 fn transaction_unconfirmed(&self, txid: &Txid) {
4090 self.0.transaction_unconfirmed(txid, &*self.1, &*self.2, &*self.3);
4093 fn best_block_updated(&self, header: &BlockHeader, height: u32) {
4094 self.0.best_block_updated(header, height, &*self.1, &*self.2, &*self.3);
4097 fn get_relevant_txids(&self) -> Vec<(Txid, Option<BlockHash>)> {
4098 self.0.get_relevant_txids()
4102 const MAX_ALLOC_SIZE: usize = 64*1024;
4104 impl<'a, 'b, ES: EntropySource, SP: SignerProvider> ReadableArgs<(&'a ES, &'b SP)>
4105 for (BlockHash, ChannelMonitor<SP::Signer>) {
4106 fn read<R: io::Read>(reader: &mut R, args: (&'a ES, &'b SP)) -> Result<Self, DecodeError> {
4107 macro_rules! unwrap_obj {
4111 Err(_) => return Err(DecodeError::InvalidValue),
4116 let (entropy_source, signer_provider) = args;
4118 let _ver = read_ver_prefix!(reader, SERIALIZATION_VERSION);
4120 let latest_update_id: u64 = Readable::read(reader)?;
4121 let commitment_transaction_number_obscure_factor = <U48 as Readable>::read(reader)?.0;
4123 let destination_script = Readable::read(reader)?;
4124 let broadcasted_holder_revokable_script = match <u8 as Readable>::read(reader)? {
4126 let revokable_address = Readable::read(reader)?;
4127 let per_commitment_point = Readable::read(reader)?;
4128 let revokable_script = Readable::read(reader)?;
4129 Some((revokable_address, per_commitment_point, revokable_script))
4132 _ => return Err(DecodeError::InvalidValue),
4134 let counterparty_payment_script = Readable::read(reader)?;
4135 let shutdown_script = {
4136 let script = <Script as Readable>::read(reader)?;
4137 if script.is_empty() { None } else { Some(script) }
4140 let channel_keys_id = Readable::read(reader)?;
4141 let holder_revocation_basepoint = Readable::read(reader)?;
4142 // Technically this can fail and serialize fail a round-trip, but only for serialization of
4143 // barely-init'd ChannelMonitors that we can't do anything with.
4144 let outpoint = OutPoint {
4145 txid: Readable::read(reader)?,
4146 index: Readable::read(reader)?,
4148 let funding_info = (outpoint, Readable::read(reader)?);
4149 let current_counterparty_commitment_txid = Readable::read(reader)?;
4150 let prev_counterparty_commitment_txid = Readable::read(reader)?;
4152 let counterparty_commitment_params = Readable::read(reader)?;
4153 let funding_redeemscript = Readable::read(reader)?;
4154 let channel_value_satoshis = Readable::read(reader)?;
4156 let their_cur_per_commitment_points = {
4157 let first_idx = <U48 as Readable>::read(reader)?.0;
4161 let first_point = Readable::read(reader)?;
4162 let second_point_slice: [u8; 33] = Readable::read(reader)?;
4163 if second_point_slice[0..32] == [0; 32] && second_point_slice[32] == 0 {
4164 Some((first_idx, first_point, None))
4166 Some((first_idx, first_point, Some(unwrap_obj!(PublicKey::from_slice(&second_point_slice)))))
4171 let on_holder_tx_csv: u16 = Readable::read(reader)?;
4173 let commitment_secrets = Readable::read(reader)?;
4175 macro_rules! read_htlc_in_commitment {
4178 let offered: bool = Readable::read(reader)?;
4179 let amount_msat: u64 = Readable::read(reader)?;
4180 let cltv_expiry: u32 = Readable::read(reader)?;
4181 let payment_hash: PaymentHash = Readable::read(reader)?;
4182 let transaction_output_index: Option<u32> = Readable::read(reader)?;
4184 HTLCOutputInCommitment {
4185 offered, amount_msat, cltv_expiry, payment_hash, transaction_output_index
4191 let counterparty_claimable_outpoints_len: u64 = Readable::read(reader)?;
4192 let mut counterparty_claimable_outpoints = HashMap::with_capacity(cmp::min(counterparty_claimable_outpoints_len as usize, MAX_ALLOC_SIZE / 64));
4193 for _ in 0..counterparty_claimable_outpoints_len {
4194 let txid: Txid = Readable::read(reader)?;
4195 let htlcs_count: u64 = Readable::read(reader)?;
4196 let mut htlcs = Vec::with_capacity(cmp::min(htlcs_count as usize, MAX_ALLOC_SIZE / 32));
4197 for _ in 0..htlcs_count {
4198 htlcs.push((read_htlc_in_commitment!(), <Option<HTLCSource> as Readable>::read(reader)?.map(|o: HTLCSource| Box::new(o))));
4200 if let Some(_) = counterparty_claimable_outpoints.insert(txid, htlcs) {
4201 return Err(DecodeError::InvalidValue);
4205 let counterparty_commitment_txn_on_chain_len: u64 = Readable::read(reader)?;
4206 let mut counterparty_commitment_txn_on_chain = HashMap::with_capacity(cmp::min(counterparty_commitment_txn_on_chain_len as usize, MAX_ALLOC_SIZE / 32));
4207 for _ in 0..counterparty_commitment_txn_on_chain_len {
4208 let txid: Txid = Readable::read(reader)?;
4209 let commitment_number = <U48 as Readable>::read(reader)?.0;
4210 if let Some(_) = counterparty_commitment_txn_on_chain.insert(txid, commitment_number) {
4211 return Err(DecodeError::InvalidValue);
4215 let counterparty_hash_commitment_number_len: u64 = Readable::read(reader)?;
4216 let mut counterparty_hash_commitment_number = HashMap::with_capacity(cmp::min(counterparty_hash_commitment_number_len as usize, MAX_ALLOC_SIZE / 32));
4217 for _ in 0..counterparty_hash_commitment_number_len {
4218 let payment_hash: PaymentHash = Readable::read(reader)?;
4219 let commitment_number = <U48 as Readable>::read(reader)?.0;
4220 if let Some(_) = counterparty_hash_commitment_number.insert(payment_hash, commitment_number) {
4221 return Err(DecodeError::InvalidValue);
4225 let mut prev_holder_signed_commitment_tx: Option<HolderSignedTx> =
4226 match <u8 as Readable>::read(reader)? {
4229 Some(Readable::read(reader)?)
4231 _ => return Err(DecodeError::InvalidValue),
4233 let mut current_holder_commitment_tx: HolderSignedTx = Readable::read(reader)?;
4235 let current_counterparty_commitment_number = <U48 as Readable>::read(reader)?.0;
4236 let current_holder_commitment_number = <U48 as Readable>::read(reader)?.0;
4238 let payment_preimages_len: u64 = Readable::read(reader)?;
4239 let mut payment_preimages = HashMap::with_capacity(cmp::min(payment_preimages_len as usize, MAX_ALLOC_SIZE / 32));
4240 for _ in 0..payment_preimages_len {
4241 let preimage: PaymentPreimage = Readable::read(reader)?;
4242 let hash = PaymentHash(Sha256::hash(&preimage.0[..]).into_inner());
4243 if let Some(_) = payment_preimages.insert(hash, preimage) {
4244 return Err(DecodeError::InvalidValue);
4248 let pending_monitor_events_len: u64 = Readable::read(reader)?;
4249 let mut pending_monitor_events = Some(
4250 Vec::with_capacity(cmp::min(pending_monitor_events_len as usize, MAX_ALLOC_SIZE / (32 + 8*3))));
4251 for _ in 0..pending_monitor_events_len {
4252 let ev = match <u8 as Readable>::read(reader)? {
4253 0 => MonitorEvent::HTLCEvent(Readable::read(reader)?),
4254 1 => MonitorEvent::CommitmentTxConfirmed(funding_info.0),
4255 _ => return Err(DecodeError::InvalidValue)
4257 pending_monitor_events.as_mut().unwrap().push(ev);
4260 let pending_events_len: u64 = Readable::read(reader)?;
4261 let mut pending_events = Vec::with_capacity(cmp::min(pending_events_len as usize, MAX_ALLOC_SIZE / mem::size_of::<Event>()));
4262 for _ in 0..pending_events_len {
4263 if let Some(event) = MaybeReadable::read(reader)? {
4264 pending_events.push(event);
4268 let best_block = BestBlock::new(Readable::read(reader)?, Readable::read(reader)?);
4270 let waiting_threshold_conf_len: u64 = Readable::read(reader)?;
4271 let mut onchain_events_awaiting_threshold_conf = Vec::with_capacity(cmp::min(waiting_threshold_conf_len as usize, MAX_ALLOC_SIZE / 128));
4272 for _ in 0..waiting_threshold_conf_len {
4273 if let Some(val) = MaybeReadable::read(reader)? {
4274 onchain_events_awaiting_threshold_conf.push(val);
4278 let outputs_to_watch_len: u64 = Readable::read(reader)?;
4279 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>>())));
4280 for _ in 0..outputs_to_watch_len {
4281 let txid = Readable::read(reader)?;
4282 let outputs_len: u64 = Readable::read(reader)?;
4283 let mut outputs = Vec::with_capacity(cmp::min(outputs_len as usize, MAX_ALLOC_SIZE / (mem::size_of::<u32>() + mem::size_of::<Script>())));
4284 for _ in 0..outputs_len {
4285 outputs.push((Readable::read(reader)?, Readable::read(reader)?));
4287 if let Some(_) = outputs_to_watch.insert(txid, outputs) {
4288 return Err(DecodeError::InvalidValue);
4291 let onchain_tx_handler: OnchainTxHandler<SP::Signer> = ReadableArgs::read(
4292 reader, (entropy_source, signer_provider, channel_value_satoshis, channel_keys_id)
4295 let lockdown_from_offchain = Readable::read(reader)?;
4296 let holder_tx_signed = Readable::read(reader)?;
4298 if let Some(prev_commitment_tx) = prev_holder_signed_commitment_tx.as_mut() {
4299 let prev_holder_value = onchain_tx_handler.get_prev_holder_commitment_to_self_value();
4300 if prev_holder_value.is_none() { return Err(DecodeError::InvalidValue); }
4301 if prev_commitment_tx.to_self_value_sat == u64::max_value() {
4302 prev_commitment_tx.to_self_value_sat = prev_holder_value.unwrap();
4303 } else if prev_commitment_tx.to_self_value_sat != prev_holder_value.unwrap() {
4304 return Err(DecodeError::InvalidValue);
4308 let cur_holder_value = onchain_tx_handler.get_cur_holder_commitment_to_self_value();
4309 if current_holder_commitment_tx.to_self_value_sat == u64::max_value() {
4310 current_holder_commitment_tx.to_self_value_sat = cur_holder_value;
4311 } else if current_holder_commitment_tx.to_self_value_sat != cur_holder_value {
4312 return Err(DecodeError::InvalidValue);
4315 let mut funding_spend_confirmed = None;
4316 let mut htlcs_resolved_on_chain = Some(Vec::new());
4317 let mut funding_spend_seen = Some(false);
4318 let mut counterparty_node_id = None;
4319 let mut confirmed_commitment_tx_counterparty_output = None;
4320 let mut spendable_txids_confirmed = Some(Vec::new());
4321 let mut counterparty_fulfilled_htlcs = Some(HashMap::new());
4322 let mut initial_counterparty_commitment_info = None;
4323 read_tlv_fields!(reader, {
4324 (1, funding_spend_confirmed, option),
4325 (3, htlcs_resolved_on_chain, optional_vec),
4326 (5, pending_monitor_events, optional_vec),
4327 (7, funding_spend_seen, option),
4328 (9, counterparty_node_id, option),
4329 (11, confirmed_commitment_tx_counterparty_output, option),
4330 (13, spendable_txids_confirmed, optional_vec),
4331 (15, counterparty_fulfilled_htlcs, option),
4332 (17, initial_counterparty_commitment_info, option),
4335 Ok((best_block.block_hash(), ChannelMonitor::from_impl(ChannelMonitorImpl {
4337 commitment_transaction_number_obscure_factor,
4340 broadcasted_holder_revokable_script,
4341 counterparty_payment_script,
4345 holder_revocation_basepoint,
4347 current_counterparty_commitment_txid,
4348 prev_counterparty_commitment_txid,
4350 counterparty_commitment_params,
4351 funding_redeemscript,
4352 channel_value_satoshis,
4353 their_cur_per_commitment_points,
4358 counterparty_claimable_outpoints,
4359 counterparty_commitment_txn_on_chain,
4360 counterparty_hash_commitment_number,
4361 counterparty_fulfilled_htlcs: counterparty_fulfilled_htlcs.unwrap(),
4363 prev_holder_signed_commitment_tx,
4364 current_holder_commitment_tx,
4365 current_counterparty_commitment_number,
4366 current_holder_commitment_number,
4369 pending_monitor_events: pending_monitor_events.unwrap(),
4371 is_processing_pending_events: false,
4373 onchain_events_awaiting_threshold_conf,
4378 lockdown_from_offchain,
4380 funding_spend_seen: funding_spend_seen.unwrap(),
4381 funding_spend_confirmed,
4382 confirmed_commitment_tx_counterparty_output,
4383 htlcs_resolved_on_chain: htlcs_resolved_on_chain.unwrap(),
4384 spendable_txids_confirmed: spendable_txids_confirmed.unwrap(),
4387 counterparty_node_id,
4388 initial_counterparty_commitment_info,
4395 use bitcoin::blockdata::script::{Script, Builder};
4396 use bitcoin::blockdata::opcodes;
4397 use bitcoin::blockdata::transaction::{Transaction, TxIn, TxOut, EcdsaSighashType};
4398 use bitcoin::blockdata::transaction::OutPoint as BitcoinOutPoint;
4399 use bitcoin::util::sighash;
4400 use bitcoin::hashes::Hash;
4401 use bitcoin::hashes::sha256::Hash as Sha256;
4402 use bitcoin::hashes::hex::FromHex;
4403 use bitcoin::hash_types::{BlockHash, Txid};
4404 use bitcoin::network::constants::Network;
4405 use bitcoin::secp256k1::{SecretKey,PublicKey};
4406 use bitcoin::secp256k1::Secp256k1;
4410 use crate::chain::chaininterface::LowerBoundedFeeEstimator;
4412 use super::ChannelMonitorUpdateStep;
4413 use crate::{check_added_monitors, check_spends, get_local_commitment_txn, get_monitor, get_route_and_payment_hash, unwrap_send_err};
4414 use crate::chain::{BestBlock, Confirm};
4415 use crate::chain::channelmonitor::ChannelMonitor;
4416 use crate::chain::package::{weight_offered_htlc, weight_received_htlc, weight_revoked_offered_htlc, weight_revoked_received_htlc, WEIGHT_REVOKED_OUTPUT};
4417 use crate::chain::transaction::OutPoint;
4418 use crate::sign::InMemorySigner;
4419 use crate::ln::{PaymentPreimage, PaymentHash};
4420 use crate::ln::chan_utils;
4421 use crate::ln::chan_utils::{HTLCOutputInCommitment, ChannelPublicKeys, ChannelTransactionParameters, HolderCommitmentTransaction, CounterpartyChannelTransactionParameters};
4422 use crate::ln::channelmanager::{PaymentSendFailure, PaymentId, RecipientOnionFields};
4423 use crate::ln::functional_test_utils::*;
4424 use crate::ln::script::ShutdownScript;
4425 use crate::util::errors::APIError;
4426 use crate::util::test_utils::{TestLogger, TestBroadcaster, TestFeeEstimator};
4427 use crate::util::ser::{ReadableArgs, Writeable};
4428 use crate::sync::{Arc, Mutex};
4430 use bitcoin::{PackedLockTime, Sequence, Witness};
4431 use crate::ln::features::ChannelTypeFeatures;
4432 use crate::prelude::*;
4434 fn do_test_funding_spend_refuses_updates(use_local_txn: bool) {
4435 // Previously, monitor updates were allowed freely even after a funding-spend transaction
4436 // confirmed. This would allow a race condition where we could receive a payment (including
4437 // the counterparty revoking their broadcasted state!) and accept it without recourse as
4438 // long as the ChannelMonitor receives the block first, the full commitment update dance
4439 // occurs after the block is connected, and before the ChannelManager receives the block.
4440 // Obviously this is an incredibly contrived race given the counterparty would be risking
4441 // their full channel balance for it, but its worth fixing nonetheless as it makes the
4442 // potential ChannelMonitor states simpler to reason about.
4444 // This test checks said behavior, as well as ensuring a ChannelMonitorUpdate with multiple
4445 // updates is handled correctly in such conditions.
4446 let chanmon_cfgs = create_chanmon_cfgs(3);
4447 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
4448 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
4449 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
4450 let channel = create_announced_chan_between_nodes(&nodes, 0, 1);
4451 create_announced_chan_between_nodes(&nodes, 1, 2);
4453 // Rebalance somewhat
4454 send_payment(&nodes[0], &[&nodes[1]], 10_000_000);
4456 // First route two payments for testing at the end
4457 let payment_preimage_1 = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 1_000_000).0;
4458 let payment_preimage_2 = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 1_000_000).0;
4460 let local_txn = get_local_commitment_txn!(nodes[1], channel.2);
4461 assert_eq!(local_txn.len(), 1);
4462 let remote_txn = get_local_commitment_txn!(nodes[0], channel.2);
4463 assert_eq!(remote_txn.len(), 3); // Commitment and two HTLC-Timeouts
4464 check_spends!(remote_txn[1], remote_txn[0]);
4465 check_spends!(remote_txn[2], remote_txn[0]);
4466 let broadcast_tx = if use_local_txn { &local_txn[0] } else { &remote_txn[0] };
4468 // Connect a commitment transaction, but only to the ChainMonitor/ChannelMonitor. The
4469 // channel is now closed, but the ChannelManager doesn't know that yet.
4470 let new_header = create_dummy_header(nodes[0].best_block_info().0, 0);
4471 let conf_height = nodes[0].best_block_info().1 + 1;
4472 nodes[1].chain_monitor.chain_monitor.transactions_confirmed(&new_header,
4473 &[(0, broadcast_tx)], conf_height);
4475 let (_, pre_update_monitor) = <(BlockHash, ChannelMonitor<InMemorySigner>)>::read(
4476 &mut io::Cursor::new(&get_monitor!(nodes[1], channel.2).encode()),
4477 (&nodes[1].keys_manager.backing, &nodes[1].keys_manager.backing)).unwrap();
4479 // If the ChannelManager tries to update the channel, however, the ChainMonitor will pass
4480 // the update through to the ChannelMonitor which will refuse it (as the channel is closed).
4481 let (route, payment_hash, _, payment_secret) = get_route_and_payment_hash!(nodes[1], nodes[0], 100_000);
4482 unwrap_send_err!(nodes[1].node.send_payment_with_route(&route, payment_hash,
4483 RecipientOnionFields::secret_only(payment_secret), PaymentId(payment_hash.0)
4484 ), false, APIError::MonitorUpdateInProgress, {});
4485 check_added_monitors!(nodes[1], 1);
4487 // Build a new ChannelMonitorUpdate which contains both the failing commitment tx update
4488 // and provides the claim preimages for the two pending HTLCs. The first update generates
4489 // an error, but the point of this test is to ensure the later updates are still applied.
4490 let monitor_updates = nodes[1].chain_monitor.monitor_updates.lock().unwrap();
4491 let mut replay_update = monitor_updates.get(&channel.2).unwrap().iter().rev().next().unwrap().clone();
4492 assert_eq!(replay_update.updates.len(), 1);
4493 if let ChannelMonitorUpdateStep::LatestCounterpartyCommitmentTXInfo { .. } = replay_update.updates[0] {
4494 } else { panic!(); }
4495 replay_update.updates.push(ChannelMonitorUpdateStep::PaymentPreimage { payment_preimage: payment_preimage_1 });
4496 replay_update.updates.push(ChannelMonitorUpdateStep::PaymentPreimage { payment_preimage: payment_preimage_2 });
4498 let broadcaster = TestBroadcaster::with_blocks(Arc::clone(&nodes[1].blocks));
4500 pre_update_monitor.update_monitor(&replay_update, &&broadcaster, &chanmon_cfgs[1].fee_estimator, &nodes[1].logger)
4502 // Even though we error'd on the first update, we should still have generated an HTLC claim
4504 let txn_broadcasted = broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
4505 assert!(txn_broadcasted.len() >= 2);
4506 let htlc_txn = txn_broadcasted.iter().filter(|tx| {
4507 assert_eq!(tx.input.len(), 1);
4508 tx.input[0].previous_output.txid == broadcast_tx.txid()
4509 }).collect::<Vec<_>>();
4510 assert_eq!(htlc_txn.len(), 2);
4511 check_spends!(htlc_txn[0], broadcast_tx);
4512 check_spends!(htlc_txn[1], broadcast_tx);
4515 fn test_funding_spend_refuses_updates() {
4516 do_test_funding_spend_refuses_updates(true);
4517 do_test_funding_spend_refuses_updates(false);
4521 fn test_prune_preimages() {
4522 let secp_ctx = Secp256k1::new();
4523 let logger = Arc::new(TestLogger::new());
4524 let broadcaster = Arc::new(TestBroadcaster::new(Network::Testnet));
4525 let fee_estimator = TestFeeEstimator { sat_per_kw: Mutex::new(253) };
4527 let dummy_key = PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[42; 32]).unwrap());
4529 let mut preimages = Vec::new();
4532 let preimage = PaymentPreimage([i; 32]);
4533 let hash = PaymentHash(Sha256::hash(&preimage.0[..]).into_inner());
4534 preimages.push((preimage, hash));
4538 macro_rules! preimages_slice_to_htlcs {
4539 ($preimages_slice: expr) => {
4541 let mut res = Vec::new();
4542 for (idx, preimage) in $preimages_slice.iter().enumerate() {
4543 res.push((HTLCOutputInCommitment {
4547 payment_hash: preimage.1.clone(),
4548 transaction_output_index: Some(idx as u32),
4555 macro_rules! preimages_slice_to_htlc_outputs {
4556 ($preimages_slice: expr) => {
4557 preimages_slice_to_htlcs!($preimages_slice).into_iter().map(|(htlc, _)| (htlc, None)).collect()
4560 let dummy_sig = crate::util::crypto::sign(&secp_ctx,
4561 &bitcoin::secp256k1::Message::from_slice(&[42; 32]).unwrap(),
4562 &SecretKey::from_slice(&[42; 32]).unwrap());
4564 macro_rules! test_preimages_exist {
4565 ($preimages_slice: expr, $monitor: expr) => {
4566 for preimage in $preimages_slice {
4567 assert!($monitor.inner.lock().unwrap().payment_preimages.contains_key(&preimage.1));
4572 let keys = InMemorySigner::new(
4574 SecretKey::from_slice(&[41; 32]).unwrap(),
4575 SecretKey::from_slice(&[41; 32]).unwrap(),
4576 SecretKey::from_slice(&[41; 32]).unwrap(),
4577 SecretKey::from_slice(&[41; 32]).unwrap(),
4578 SecretKey::from_slice(&[41; 32]).unwrap(),
4585 let counterparty_pubkeys = ChannelPublicKeys {
4586 funding_pubkey: PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[44; 32]).unwrap()),
4587 revocation_basepoint: PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[45; 32]).unwrap()),
4588 payment_point: PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[46; 32]).unwrap()),
4589 delayed_payment_basepoint: PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[47; 32]).unwrap()),
4590 htlc_basepoint: PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[48; 32]).unwrap())
4592 let funding_outpoint = OutPoint { txid: Txid::all_zeros(), index: u16::max_value() };
4593 let channel_parameters = ChannelTransactionParameters {
4594 holder_pubkeys: keys.holder_channel_pubkeys.clone(),
4595 holder_selected_contest_delay: 66,
4596 is_outbound_from_holder: true,
4597 counterparty_parameters: Some(CounterpartyChannelTransactionParameters {
4598 pubkeys: counterparty_pubkeys,
4599 selected_contest_delay: 67,
4601 funding_outpoint: Some(funding_outpoint),
4602 channel_type_features: ChannelTypeFeatures::only_static_remote_key()
4604 // Prune with one old state and a holder commitment tx holding a few overlaps with the
4606 let shutdown_pubkey = PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[42; 32]).unwrap());
4607 let best_block = BestBlock::from_network(Network::Testnet);
4608 let monitor = ChannelMonitor::new(Secp256k1::new(), keys,
4609 Some(ShutdownScript::new_p2wpkh_from_pubkey(shutdown_pubkey).into_inner()), 0, &Script::new(),
4610 (OutPoint { txid: Txid::from_slice(&[43; 32]).unwrap(), index: 0 }, Script::new()),
4611 &channel_parameters, Script::new(), 46, 0, HolderCommitmentTransaction::dummy(&mut Vec::new()),
4612 best_block, dummy_key);
4614 let mut htlcs = preimages_slice_to_htlcs!(preimages[0..10]);
4615 let dummy_commitment_tx = HolderCommitmentTransaction::dummy(&mut htlcs);
4616 monitor.provide_latest_holder_commitment_tx(dummy_commitment_tx.clone(),
4617 htlcs.into_iter().map(|(htlc, _)| (htlc, Some(dummy_sig), None)).collect()).unwrap();
4618 monitor.provide_latest_counterparty_commitment_tx(Txid::from_inner(Sha256::hash(b"1").into_inner()),
4619 preimages_slice_to_htlc_outputs!(preimages[5..15]), 281474976710655, dummy_key, &logger);
4620 monitor.provide_latest_counterparty_commitment_tx(Txid::from_inner(Sha256::hash(b"2").into_inner()),
4621 preimages_slice_to_htlc_outputs!(preimages[15..20]), 281474976710654, dummy_key, &logger);
4622 for &(ref preimage, ref hash) in preimages.iter() {
4623 let bounded_fee_estimator = LowerBoundedFeeEstimator::new(&fee_estimator);
4624 monitor.provide_payment_preimage(hash, preimage, &broadcaster, &bounded_fee_estimator, &logger);
4627 // Now provide a secret, pruning preimages 10-15
4628 let mut secret = [0; 32];
4629 secret[0..32].clone_from_slice(&hex::decode("7cc854b54e3e0dcdb010d7a3fee464a9687be6e8db3be6854c475621e007a5dc").unwrap());
4630 monitor.provide_secret(281474976710655, secret.clone()).unwrap();
4631 assert_eq!(monitor.inner.lock().unwrap().payment_preimages.len(), 15);
4632 test_preimages_exist!(&preimages[0..10], monitor);
4633 test_preimages_exist!(&preimages[15..20], monitor);
4635 monitor.provide_latest_counterparty_commitment_tx(Txid::from_inner(Sha256::hash(b"3").into_inner()),
4636 preimages_slice_to_htlc_outputs!(preimages[17..20]), 281474976710653, dummy_key, &logger);
4638 // Now provide a further secret, pruning preimages 15-17
4639 secret[0..32].clone_from_slice(&hex::decode("c7518c8ae4660ed02894df8976fa1a3659c1a8b4b5bec0c4b872abeba4cb8964").unwrap());
4640 monitor.provide_secret(281474976710654, secret.clone()).unwrap();
4641 assert_eq!(monitor.inner.lock().unwrap().payment_preimages.len(), 13);
4642 test_preimages_exist!(&preimages[0..10], monitor);
4643 test_preimages_exist!(&preimages[17..20], monitor);
4645 monitor.provide_latest_counterparty_commitment_tx(Txid::from_inner(Sha256::hash(b"4").into_inner()),
4646 preimages_slice_to_htlc_outputs!(preimages[18..20]), 281474976710652, dummy_key, &logger);
4648 // Now update holder commitment tx info, pruning only element 18 as we still care about the
4649 // previous commitment tx's preimages too
4650 let mut htlcs = preimages_slice_to_htlcs!(preimages[0..5]);
4651 let dummy_commitment_tx = HolderCommitmentTransaction::dummy(&mut htlcs);
4652 monitor.provide_latest_holder_commitment_tx(dummy_commitment_tx.clone(),
4653 htlcs.into_iter().map(|(htlc, _)| (htlc, Some(dummy_sig), None)).collect()).unwrap();
4654 secret[0..32].clone_from_slice(&hex::decode("2273e227a5b7449b6e70f1fb4652864038b1cbf9cd7c043a7d6456b7fc275ad8").unwrap());
4655 monitor.provide_secret(281474976710653, secret.clone()).unwrap();
4656 assert_eq!(monitor.inner.lock().unwrap().payment_preimages.len(), 12);
4657 test_preimages_exist!(&preimages[0..10], monitor);
4658 test_preimages_exist!(&preimages[18..20], monitor);
4660 // But if we do it again, we'll prune 5-10
4661 let mut htlcs = preimages_slice_to_htlcs!(preimages[0..3]);
4662 let dummy_commitment_tx = HolderCommitmentTransaction::dummy(&mut htlcs);
4663 monitor.provide_latest_holder_commitment_tx(dummy_commitment_tx,
4664 htlcs.into_iter().map(|(htlc, _)| (htlc, Some(dummy_sig), None)).collect()).unwrap();
4665 secret[0..32].clone_from_slice(&hex::decode("27cddaa5624534cb6cb9d7da077cf2b22ab21e9b506fd4998a51d54502e99116").unwrap());
4666 monitor.provide_secret(281474976710652, secret.clone()).unwrap();
4667 assert_eq!(monitor.inner.lock().unwrap().payment_preimages.len(), 5);
4668 test_preimages_exist!(&preimages[0..5], monitor);
4672 fn test_claim_txn_weight_computation() {
4673 // We test Claim txn weight, knowing that we want expected weigth and
4674 // not actual case to avoid sigs and time-lock delays hell variances.
4676 let secp_ctx = Secp256k1::new();
4677 let privkey = SecretKey::from_slice(&hex::decode("0101010101010101010101010101010101010101010101010101010101010101").unwrap()[..]).unwrap();
4678 let pubkey = PublicKey::from_secret_key(&secp_ctx, &privkey);
4680 macro_rules! sign_input {
4681 ($sighash_parts: expr, $idx: expr, $amount: expr, $weight: expr, $sum_actual_sigs: expr, $opt_anchors: expr) => {
4682 let htlc = HTLCOutputInCommitment {
4683 offered: if *$weight == weight_revoked_offered_htlc($opt_anchors) || *$weight == weight_offered_htlc($opt_anchors) { true } else { false },
4685 cltv_expiry: 2 << 16,
4686 payment_hash: PaymentHash([1; 32]),
4687 transaction_output_index: Some($idx as u32),
4689 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) };
4690 let sighash = hash_to_message!(&$sighash_parts.segwit_signature_hash($idx, &redeem_script, $amount, EcdsaSighashType::All).unwrap()[..]);
4691 let sig = secp_ctx.sign_ecdsa(&sighash, &privkey);
4692 let mut ser_sig = sig.serialize_der().to_vec();
4693 ser_sig.push(EcdsaSighashType::All as u8);
4694 $sum_actual_sigs += ser_sig.len();
4695 let witness = $sighash_parts.witness_mut($idx).unwrap();
4696 witness.push(ser_sig);
4697 if *$weight == WEIGHT_REVOKED_OUTPUT {
4698 witness.push(vec!(1));
4699 } else if *$weight == weight_revoked_offered_htlc($opt_anchors) || *$weight == weight_revoked_received_htlc($opt_anchors) {
4700 witness.push(pubkey.clone().serialize().to_vec());
4701 } else if *$weight == weight_received_htlc($opt_anchors) {
4702 witness.push(vec![0]);
4704 witness.push(PaymentPreimage([1; 32]).0.to_vec());
4706 witness.push(redeem_script.into_bytes());
4707 let witness = witness.to_vec();
4708 println!("witness[0] {}", witness[0].len());
4709 println!("witness[1] {}", witness[1].len());
4710 println!("witness[2] {}", witness[2].len());
4714 let script_pubkey = Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script();
4715 let txid = Txid::from_hex("56944c5d3f98413ef45cf54545538103cc9f298e0575820ad3591376e2e0f65d").unwrap();
4717 // Justice tx with 1 to_holder, 2 revoked offered HTLCs, 1 revoked received HTLCs
4718 for channel_type_features in [ChannelTypeFeatures::only_static_remote_key(), ChannelTypeFeatures::anchors_zero_htlc_fee_and_dependencies()].iter() {
4719 let mut claim_tx = Transaction { version: 0, lock_time: PackedLockTime::ZERO, input: Vec::new(), output: Vec::new() };
4720 let mut sum_actual_sigs = 0;
4722 claim_tx.input.push(TxIn {
4723 previous_output: BitcoinOutPoint {
4727 script_sig: Script::new(),
4728 sequence: Sequence::ENABLE_RBF_NO_LOCKTIME,
4729 witness: Witness::new(),
4732 claim_tx.output.push(TxOut {
4733 script_pubkey: script_pubkey.clone(),
4736 let base_weight = claim_tx.weight();
4737 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)];
4738 let mut inputs_total_weight = 2; // count segwit flags
4740 let mut sighash_parts = sighash::SighashCache::new(&mut claim_tx);
4741 for (idx, inp) in inputs_weight.iter().enumerate() {
4742 sign_input!(sighash_parts, idx, 0, inp, sum_actual_sigs, channel_type_features);
4743 inputs_total_weight += inp;
4746 assert_eq!(base_weight + inputs_total_weight as usize, claim_tx.weight() + /* max_length_sig */ (73 * inputs_weight.len() - sum_actual_sigs));
4749 // Claim tx with 1 offered HTLCs, 3 received HTLCs
4750 for channel_type_features in [ChannelTypeFeatures::only_static_remote_key(), ChannelTypeFeatures::anchors_zero_htlc_fee_and_dependencies()].iter() {
4751 let mut claim_tx = Transaction { version: 0, lock_time: PackedLockTime::ZERO, input: Vec::new(), output: Vec::new() };
4752 let mut sum_actual_sigs = 0;
4754 claim_tx.input.push(TxIn {
4755 previous_output: BitcoinOutPoint {
4759 script_sig: Script::new(),
4760 sequence: Sequence::ENABLE_RBF_NO_LOCKTIME,
4761 witness: Witness::new(),
4764 claim_tx.output.push(TxOut {
4765 script_pubkey: script_pubkey.clone(),
4768 let base_weight = claim_tx.weight();
4769 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)];
4770 let mut inputs_total_weight = 2; // count segwit flags
4772 let mut sighash_parts = sighash::SighashCache::new(&mut claim_tx);
4773 for (idx, inp) in inputs_weight.iter().enumerate() {
4774 sign_input!(sighash_parts, idx, 0, inp, sum_actual_sigs, channel_type_features);
4775 inputs_total_weight += inp;
4778 assert_eq!(base_weight + inputs_total_weight as usize, claim_tx.weight() + /* max_length_sig */ (73 * inputs_weight.len() - sum_actual_sigs));
4781 // Justice tx with 1 revoked HTLC-Success tx output
4782 for channel_type_features in [ChannelTypeFeatures::only_static_remote_key(), ChannelTypeFeatures::anchors_zero_htlc_fee_and_dependencies()].iter() {
4783 let mut claim_tx = Transaction { version: 0, lock_time: PackedLockTime::ZERO, input: Vec::new(), output: Vec::new() };
4784 let mut sum_actual_sigs = 0;
4785 claim_tx.input.push(TxIn {
4786 previous_output: BitcoinOutPoint {
4790 script_sig: Script::new(),
4791 sequence: Sequence::ENABLE_RBF_NO_LOCKTIME,
4792 witness: Witness::new(),
4794 claim_tx.output.push(TxOut {
4795 script_pubkey: script_pubkey.clone(),
4798 let base_weight = claim_tx.weight();
4799 let inputs_weight = vec![WEIGHT_REVOKED_OUTPUT];
4800 let mut inputs_total_weight = 2; // count segwit flags
4802 let mut sighash_parts = sighash::SighashCache::new(&mut claim_tx);
4803 for (idx, inp) in inputs_weight.iter().enumerate() {
4804 sign_input!(sighash_parts, idx, 0, inp, sum_actual_sigs, channel_type_features);
4805 inputs_total_weight += inp;
4808 assert_eq!(base_weight + inputs_total_weight as usize, claim_tx.weight() + /* max_length_isg */ (73 * inputs_weight.len() - sum_actual_sigs));
4812 // Further testing is done in the ChannelManager integration tests.