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::{TxOut,Transaction};
25 use bitcoin::blockdata::script::{Script, Builder};
26 use bitcoin::blockdata::opcodes;
28 use bitcoin::hashes::Hash;
29 use bitcoin::hashes::sha256::Hash as Sha256;
30 use bitcoin::hash_types::{Txid, BlockHash, WPubkeyHash};
32 use bitcoin::secp256k1::{Secp256k1, ecdsa::Signature};
33 use bitcoin::secp256k1::{SecretKey, PublicKey};
34 use bitcoin::secp256k1;
36 use ln::{PaymentHash, PaymentPreimage};
37 use ln::msgs::DecodeError;
39 use ln::chan_utils::{CounterpartyCommitmentSecrets, HTLCOutputInCommitment, HTLCType, ChannelTransactionParameters, HolderCommitmentTransaction};
40 use ln::channelmanager::HTLCSource;
42 use chain::{BestBlock, WatchedOutput};
43 use chain::chaininterface::{BroadcasterInterface, FeeEstimator, LowerBoundedFeeEstimator};
44 use chain::transaction::{OutPoint, TransactionData};
45 use chain::keysinterface::{SpendableOutputDescriptor, StaticPaymentOutputDescriptor, DelayedPaymentOutputDescriptor, Sign, KeysInterface};
46 use chain::onchaintx::OnchainTxHandler;
47 use chain::package::{CounterpartyOfferedHTLCOutput, CounterpartyReceivedHTLCOutput, HolderFundingOutput, HolderHTLCOutput, PackageSolvingData, PackageTemplate, RevokedOutput, RevokedHTLCOutput};
49 use util::logger::Logger;
50 use util::ser::{Readable, ReadableArgs, MaybeReadable, Writer, Writeable, U48, OptionDeserWrapper};
52 use util::events::Event;
56 use io::{self, Error};
60 /// An update generated by the underlying Channel itself which contains some new information the
61 /// ChannelMonitor should be made aware of.
62 #[cfg_attr(any(test, fuzzing, feature = "_test_utils"), derive(PartialEq))]
65 pub struct ChannelMonitorUpdate {
66 pub(crate) updates: Vec<ChannelMonitorUpdateStep>,
67 /// The sequence number of this update. Updates *must* be replayed in-order according to this
68 /// sequence number (and updates may panic if they are not). The update_id values are strictly
69 /// increasing and increase by one for each new update, with one exception specified below.
71 /// This sequence number is also used to track up to which points updates which returned
72 /// ChannelMonitorUpdateErr::TemporaryFailure have been applied to all copies of a given
73 /// ChannelMonitor when ChannelManager::channel_monitor_updated is called.
75 /// The only instance where update_id values are not strictly increasing is the case where we
76 /// allow post-force-close updates with a special update ID of [`CLOSED_CHANNEL_UPDATE_ID`]. See
77 /// its docs for more details.
82 /// (1) a channel has been force closed and
83 /// (2) we receive a preimage from a forward link that allows us to spend an HTLC output on
84 /// this channel's (the backward link's) broadcasted commitment transaction
85 /// then we allow the `ChannelManager` to send a `ChannelMonitorUpdate` with this update ID,
86 /// with the update providing said payment preimage. No other update types are allowed after
88 pub const CLOSED_CHANNEL_UPDATE_ID: u64 = core::u64::MAX;
90 impl Writeable for ChannelMonitorUpdate {
91 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
92 write_ver_prefix!(w, SERIALIZATION_VERSION, MIN_SERIALIZATION_VERSION);
93 self.update_id.write(w)?;
94 (self.updates.len() as u64).write(w)?;
95 for update_step in self.updates.iter() {
96 update_step.write(w)?;
98 write_tlv_fields!(w, {});
102 impl Readable for ChannelMonitorUpdate {
103 fn read<R: io::Read>(r: &mut R) -> Result<Self, DecodeError> {
104 let _ver = read_ver_prefix!(r, SERIALIZATION_VERSION);
105 let update_id: u64 = Readable::read(r)?;
106 let len: u64 = Readable::read(r)?;
107 let mut updates = Vec::with_capacity(cmp::min(len as usize, MAX_ALLOC_SIZE / ::core::mem::size_of::<ChannelMonitorUpdateStep>()));
109 if let Some(upd) = MaybeReadable::read(r)? {
113 read_tlv_fields!(r, {});
114 Ok(Self { update_id, updates })
118 /// An event to be processed by the ChannelManager.
119 #[derive(Clone, PartialEq)]
120 pub enum MonitorEvent {
121 /// A monitor event containing an HTLCUpdate.
122 HTLCEvent(HTLCUpdate),
124 /// A monitor event that the Channel's commitment transaction was confirmed.
125 CommitmentTxConfirmed(OutPoint),
127 /// Indicates a [`ChannelMonitor`] update has completed. See
128 /// [`ChannelMonitorUpdateErr::TemporaryFailure`] for more information on how this is used.
130 /// [`ChannelMonitorUpdateErr::TemporaryFailure`]: super::ChannelMonitorUpdateErr::TemporaryFailure
132 /// The funding outpoint of the [`ChannelMonitor`] that was updated
133 funding_txo: OutPoint,
134 /// The Update ID from [`ChannelMonitorUpdate::update_id`] which was applied or
135 /// [`ChannelMonitor::get_latest_update_id`].
137 /// Note that this should only be set to a given update's ID if all previous updates for the
138 /// same [`ChannelMonitor`] have been applied and persisted.
139 monitor_update_id: u64,
142 /// Indicates a [`ChannelMonitor`] update has failed. See
143 /// [`ChannelMonitorUpdateErr::PermanentFailure`] for more information on how this is used.
145 /// [`ChannelMonitorUpdateErr::PermanentFailure`]: super::ChannelMonitorUpdateErr::PermanentFailure
146 UpdateFailed(OutPoint),
148 impl_writeable_tlv_based_enum_upgradable!(MonitorEvent,
149 // Note that UpdateCompleted and UpdateFailed are currently never serialized to disk as they are
150 // generated only in ChainMonitor
151 (0, UpdateCompleted) => {
152 (0, funding_txo, required),
153 (2, monitor_update_id, required),
157 (4, CommitmentTxConfirmed),
161 /// Simple structure sent back by `chain::Watch` when an HTLC from a forward channel is detected on
162 /// chain. Used to update the corresponding HTLC in the backward channel. Failing to pass the
163 /// preimage claim backward will lead to loss of funds.
164 #[derive(Clone, PartialEq)]
165 pub struct HTLCUpdate {
166 pub(crate) payment_hash: PaymentHash,
167 pub(crate) payment_preimage: Option<PaymentPreimage>,
168 pub(crate) source: HTLCSource,
169 pub(crate) htlc_value_satoshis: Option<u64>,
171 impl_writeable_tlv_based!(HTLCUpdate, {
172 (0, payment_hash, required),
173 (1, htlc_value_satoshis, option),
174 (2, source, required),
175 (4, payment_preimage, option),
178 /// If an HTLC expires within this many blocks, don't try to claim it in a shared transaction,
179 /// instead claiming it in its own individual transaction.
180 pub(crate) const CLTV_SHARED_CLAIM_BUFFER: u32 = 12;
181 /// If an HTLC expires within this many blocks, force-close the channel to broadcast the
182 /// HTLC-Success transaction.
183 /// In other words, this is an upper bound on how many blocks we think it can take us to get a
184 /// transaction confirmed (and we use it in a few more, equivalent, places).
185 pub(crate) const CLTV_CLAIM_BUFFER: u32 = 18;
186 /// Number of blocks by which point we expect our counterparty to have seen new blocks on the
187 /// network and done a full update_fail_htlc/commitment_signed dance (+ we've updated all our
188 /// copies of ChannelMonitors, including watchtowers). We could enforce the contract by failing
189 /// at CLTV expiration height but giving a grace period to our peer may be profitable for us if he
190 /// can provide an over-late preimage. Nevertheless, grace period has to be accounted in our
191 /// CLTV_EXPIRY_DELTA to be secure. Following this policy we may decrease the rate of channel failures
192 /// due to expiration but increase the cost of funds being locked longuer in case of failure.
193 /// This delay also cover a low-power peer being slow to process blocks and so being behind us on
194 /// accurate block height.
195 /// In case of onchain failure to be pass backward we may see the last block of ANTI_REORG_DELAY
196 /// with at worst this delay, so we are not only using this value as a mercy for them but also
197 /// us as a safeguard to delay with enough time.
198 pub(crate) const LATENCY_GRACE_PERIOD_BLOCKS: u32 = 3;
199 /// Number of blocks we wait on seeing a HTLC output being solved before we fail corresponding
200 /// inbound HTLCs. This prevents us from failing backwards and then getting a reorg resulting in us
203 /// Note that this is a library-wide security assumption. If a reorg deeper than this number of
204 /// blocks occurs, counterparties may be able to steal funds or claims made by and balances exposed
205 /// by a [`ChannelMonitor`] may be incorrect.
206 // We also use this delay to be sure we can remove our in-flight claim txn from bump candidates buffer.
207 // It may cause spurious generation of bumped claim txn but that's alright given the outpoint is already
208 // solved by a previous claim tx. What we want to avoid is reorg evicting our claim tx and us not
209 // keep bumping another claim tx to solve the outpoint.
210 pub const ANTI_REORG_DELAY: u32 = 6;
211 /// Number of blocks before confirmation at which we fail back an un-relayed HTLC or at which we
212 /// refuse to accept a new HTLC.
214 /// This is used for a few separate purposes:
215 /// 1) if we've received an MPP HTLC to us and it expires within this many blocks and we are
216 /// waiting on additional parts (or waiting on the preimage for any HTLC from the user), we will
218 /// 2) if we receive an HTLC within this many blocks of its expiry (plus one to avoid a race
219 /// condition with the above), we will fail this HTLC without telling the user we received it,
221 /// (1) is all about protecting us - we need enough time to update the channel state before we hit
222 /// CLTV_CLAIM_BUFFER, at which point we'd go on chain to claim the HTLC with the preimage.
224 /// (2) is the same, but with an additional buffer to avoid accepting an HTLC which is immediately
225 /// in a race condition between the user connecting a block (which would fail it) and the user
226 /// providing us the preimage (which would claim it).
227 pub(crate) const HTLC_FAIL_BACK_BUFFER: u32 = CLTV_CLAIM_BUFFER + LATENCY_GRACE_PERIOD_BLOCKS;
229 // TODO(devrandom) replace this with HolderCommitmentTransaction
230 #[derive(Clone, PartialEq)]
231 struct HolderSignedTx {
232 /// txid of the transaction in tx, just used to make comparison faster
234 revocation_key: PublicKey,
235 a_htlc_key: PublicKey,
236 b_htlc_key: PublicKey,
237 delayed_payment_key: PublicKey,
238 per_commitment_point: PublicKey,
239 htlc_outputs: Vec<(HTLCOutputInCommitment, Option<Signature>, Option<HTLCSource>)>,
240 to_self_value_sat: u64,
243 impl_writeable_tlv_based!(HolderSignedTx, {
245 // Note that this is filled in with data from OnchainTxHandler if it's missing.
246 // For HolderSignedTx objects serialized with 0.0.100+, this should be filled in.
247 (1, to_self_value_sat, (default_value, u64::max_value())),
248 (2, revocation_key, required),
249 (4, a_htlc_key, required),
250 (6, b_htlc_key, required),
251 (8, delayed_payment_key, required),
252 (10, per_commitment_point, required),
253 (12, feerate_per_kw, required),
254 (14, htlc_outputs, vec_type)
257 /// We use this to track static counterparty commitment transaction data and to generate any
258 /// justice or 2nd-stage preimage/timeout transactions.
259 #[derive(Clone, PartialEq)]
260 struct CounterpartyCommitmentParameters {
261 counterparty_delayed_payment_base_key: PublicKey,
262 counterparty_htlc_base_key: PublicKey,
263 on_counterparty_tx_csv: u16,
266 impl Writeable for CounterpartyCommitmentParameters {
267 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
268 w.write_all(&byte_utils::be64_to_array(0))?;
269 write_tlv_fields!(w, {
270 (0, self.counterparty_delayed_payment_base_key, required),
271 (2, self.counterparty_htlc_base_key, required),
272 (4, self.on_counterparty_tx_csv, required),
277 impl Readable for CounterpartyCommitmentParameters {
278 fn read<R: io::Read>(r: &mut R) -> Result<Self, DecodeError> {
279 let counterparty_commitment_transaction = {
280 // Versions prior to 0.0.100 had some per-HTLC state stored here, which is no longer
281 // used. Read it for compatibility.
282 let per_htlc_len: u64 = Readable::read(r)?;
283 for _ in 0..per_htlc_len {
284 let _txid: Txid = Readable::read(r)?;
285 let htlcs_count: u64 = Readable::read(r)?;
286 for _ in 0..htlcs_count {
287 let _htlc: HTLCOutputInCommitment = Readable::read(r)?;
291 let mut counterparty_delayed_payment_base_key = OptionDeserWrapper(None);
292 let mut counterparty_htlc_base_key = OptionDeserWrapper(None);
293 let mut on_counterparty_tx_csv: u16 = 0;
294 read_tlv_fields!(r, {
295 (0, counterparty_delayed_payment_base_key, required),
296 (2, counterparty_htlc_base_key, required),
297 (4, on_counterparty_tx_csv, required),
299 CounterpartyCommitmentParameters {
300 counterparty_delayed_payment_base_key: counterparty_delayed_payment_base_key.0.unwrap(),
301 counterparty_htlc_base_key: counterparty_htlc_base_key.0.unwrap(),
302 on_counterparty_tx_csv,
305 Ok(counterparty_commitment_transaction)
309 /// An entry for an [`OnchainEvent`], stating the block height when the event was observed and the
310 /// transaction causing it.
312 /// Used to determine when the on-chain event can be considered safe from a chain reorganization.
313 #[derive(Clone, PartialEq)]
314 struct OnchainEventEntry {
320 impl OnchainEventEntry {
321 fn confirmation_threshold(&self) -> u32 {
322 let mut conf_threshold = self.height + ANTI_REORG_DELAY - 1;
324 OnchainEvent::MaturingOutput {
325 descriptor: SpendableOutputDescriptor::DelayedPaymentOutput(ref descriptor)
327 // A CSV'd transaction is confirmable in block (input height) + CSV delay, which means
328 // it's broadcastable when we see the previous block.
329 conf_threshold = cmp::max(conf_threshold, self.height + descriptor.to_self_delay as u32 - 1);
331 OnchainEvent::FundingSpendConfirmation { on_local_output_csv: Some(csv), .. } |
332 OnchainEvent::HTLCSpendConfirmation { on_to_local_output_csv: Some(csv), .. } => {
333 // A CSV'd transaction is confirmable in block (input height) + CSV delay, which means
334 // it's broadcastable when we see the previous block.
335 conf_threshold = cmp::max(conf_threshold, self.height + csv as u32 - 1);
342 fn has_reached_confirmation_threshold(&self, best_block: &BestBlock) -> bool {
343 best_block.height() >= self.confirmation_threshold()
347 /// Upon discovering of some classes of onchain tx by ChannelMonitor, we may have to take actions on it
348 /// once they mature to enough confirmations (ANTI_REORG_DELAY)
349 #[derive(Clone, PartialEq)]
351 /// An outbound HTLC failing after a transaction is confirmed. Used
352 /// * when an outbound HTLC output is spent by us after the HTLC timed out
353 /// * an outbound HTLC which was not present in the commitment transaction which appeared
354 /// on-chain (either because it was not fully committed to or it was dust).
355 /// Note that this is *not* used for preimage claims, as those are passed upstream immediately,
356 /// appearing only as an `HTLCSpendConfirmation`, below.
359 payment_hash: PaymentHash,
360 htlc_value_satoshis: Option<u64>,
361 /// None in the second case, above, ie when there is no relevant output in the commitment
362 /// transaction which appeared on chain.
363 commitment_tx_output_idx: Option<u32>,
366 descriptor: SpendableOutputDescriptor,
368 /// A spend of the funding output, either a commitment transaction or a cooperative closing
370 FundingSpendConfirmation {
371 /// The CSV delay for the output of the funding spend transaction (implying it is a local
372 /// commitment transaction, and this is the delay on the to_self output).
373 on_local_output_csv: Option<u16>,
375 /// A spend of a commitment transaction HTLC output, set in the cases where *no* `HTLCUpdate`
376 /// is constructed. This is used when
377 /// * an outbound HTLC is claimed by our counterparty with a preimage, causing us to
378 /// immediately claim the HTLC on the inbound edge and track the resolution here,
379 /// * an inbound HTLC is claimed by our counterparty (with a timeout),
380 /// * an inbound HTLC is claimed by us (with a preimage).
381 /// * a revoked-state HTLC transaction was broadcasted, which was claimed by the revocation
383 HTLCSpendConfirmation {
384 commitment_tx_output_idx: u32,
385 /// If the claim was made by either party with a preimage, this is filled in
386 preimage: Option<PaymentPreimage>,
387 /// If the claim was made by us on an inbound HTLC against a local commitment transaction,
388 /// we set this to the output CSV value which we will have to wait until to spend the
389 /// output (and generate a SpendableOutput event).
390 on_to_local_output_csv: Option<u16>,
394 impl Writeable for OnchainEventEntry {
395 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
396 write_tlv_fields!(writer, {
397 (0, self.txid, required),
398 (2, self.height, required),
399 (4, self.event, required),
405 impl MaybeReadable for OnchainEventEntry {
406 fn read<R: io::Read>(reader: &mut R) -> Result<Option<Self>, DecodeError> {
407 let mut txid = Default::default();
409 let mut event = None;
410 read_tlv_fields!(reader, {
412 (2, height, required),
413 (4, event, ignorable),
415 if let Some(ev) = event {
416 Ok(Some(Self { txid, height, event: ev }))
423 impl_writeable_tlv_based_enum_upgradable!(OnchainEvent,
425 (0, source, required),
426 (1, htlc_value_satoshis, option),
427 (2, payment_hash, required),
428 (3, commitment_tx_output_idx, option),
430 (1, MaturingOutput) => {
431 (0, descriptor, required),
433 (3, FundingSpendConfirmation) => {
434 (0, on_local_output_csv, option),
436 (5, HTLCSpendConfirmation) => {
437 (0, commitment_tx_output_idx, required),
438 (2, preimage, option),
439 (4, on_to_local_output_csv, option),
444 #[cfg_attr(any(test, fuzzing, feature = "_test_utils"), derive(PartialEq))]
446 pub(crate) enum ChannelMonitorUpdateStep {
447 LatestHolderCommitmentTXInfo {
448 commitment_tx: HolderCommitmentTransaction,
449 htlc_outputs: Vec<(HTLCOutputInCommitment, Option<Signature>, Option<HTLCSource>)>,
451 LatestCounterpartyCommitmentTXInfo {
452 commitment_txid: Txid,
453 htlc_outputs: Vec<(HTLCOutputInCommitment, Option<Box<HTLCSource>>)>,
454 commitment_number: u64,
455 their_per_commitment_point: PublicKey,
458 payment_preimage: PaymentPreimage,
464 /// Used to indicate that the no future updates will occur, and likely that the latest holder
465 /// commitment transaction(s) should be broadcast, as the channel has been force-closed.
467 /// If set to false, we shouldn't broadcast the latest holder commitment transaction as we
468 /// think we've fallen behind!
469 should_broadcast: bool,
472 scriptpubkey: Script,
476 impl ChannelMonitorUpdateStep {
477 fn variant_name(&self) -> &'static str {
479 ChannelMonitorUpdateStep::LatestHolderCommitmentTXInfo { .. } => "LatestHolderCommitmentTXInfo",
480 ChannelMonitorUpdateStep::LatestCounterpartyCommitmentTXInfo { .. } => "LatestCounterpartyCommitmentTXInfo",
481 ChannelMonitorUpdateStep::PaymentPreimage { .. } => "PaymentPreimage",
482 ChannelMonitorUpdateStep::CommitmentSecret { .. } => "CommitmentSecret",
483 ChannelMonitorUpdateStep::ChannelForceClosed { .. } => "ChannelForceClosed",
484 ChannelMonitorUpdateStep::ShutdownScript { .. } => "ShutdownScript",
489 impl_writeable_tlv_based_enum_upgradable!(ChannelMonitorUpdateStep,
490 (0, LatestHolderCommitmentTXInfo) => {
491 (0, commitment_tx, required),
492 (2, htlc_outputs, vec_type),
494 (1, LatestCounterpartyCommitmentTXInfo) => {
495 (0, commitment_txid, required),
496 (2, commitment_number, required),
497 (4, their_per_commitment_point, required),
498 (6, htlc_outputs, vec_type),
500 (2, PaymentPreimage) => {
501 (0, payment_preimage, required),
503 (3, CommitmentSecret) => {
505 (2, secret, required),
507 (4, ChannelForceClosed) => {
508 (0, should_broadcast, required),
510 (5, ShutdownScript) => {
511 (0, scriptpubkey, required),
515 /// Details about the balance(s) available for spending once the channel appears on chain.
517 /// See [`ChannelMonitor::get_claimable_balances`] for more details on when these will or will not
519 #[derive(Clone, Debug, PartialEq, Eq)]
520 #[cfg_attr(test, derive(PartialOrd, Ord))]
522 /// The channel is not yet closed (or the commitment or closing transaction has not yet
523 /// appeared in a block). The given balance is claimable (less on-chain fees) if the channel is
524 /// force-closed now.
525 ClaimableOnChannelClose {
526 /// The amount available to claim, in satoshis, excluding the on-chain fees which will be
527 /// required to do so.
528 claimable_amount_satoshis: u64,
530 /// The channel has been closed, and the given balance is ours but awaiting confirmations until
531 /// we consider it spendable.
532 ClaimableAwaitingConfirmations {
533 /// The amount available to claim, in satoshis, possibly excluding the on-chain fees which
534 /// were spent in broadcasting the transaction.
535 claimable_amount_satoshis: u64,
536 /// The height at which an [`Event::SpendableOutputs`] event will be generated for this
538 confirmation_height: u32,
540 /// The channel has been closed, and the given balance should be ours but awaiting spending
541 /// transaction confirmation. If the spending transaction does not confirm in time, it is
542 /// possible our counterparty can take the funds by broadcasting an HTLC timeout on-chain.
544 /// Once the spending transaction confirms, before it has reached enough confirmations to be
545 /// considered safe from chain reorganizations, the balance will instead be provided via
546 /// [`Balance::ClaimableAwaitingConfirmations`].
547 ContentiousClaimable {
548 /// The amount available to claim, in satoshis, excluding the on-chain fees which will be
549 /// required to do so.
550 claimable_amount_satoshis: u64,
551 /// The height at which the counterparty may be able to claim the balance if we have not
555 /// HTLCs which we sent to our counterparty which are claimable after a timeout (less on-chain
556 /// fees) if the counterparty does not know the preimage for the HTLCs. These are somewhat
557 /// likely to be claimed by our counterparty before we do.
558 MaybeClaimableHTLCAwaitingTimeout {
559 /// The amount available to claim, in satoshis, excluding the on-chain fees which will be
560 /// required to do so.
561 claimable_amount_satoshis: u64,
562 /// The height at which we will be able to claim the balance if our counterparty has not
564 claimable_height: u32,
568 /// An HTLC which has been irrevocably resolved on-chain, and has reached ANTI_REORG_DELAY.
569 #[derive(Clone, PartialEq)]
570 struct IrrevocablyResolvedHTLC {
571 commitment_tx_output_idx: u32,
572 /// Only set if the HTLC claim was ours using a payment preimage
573 payment_preimage: Option<PaymentPreimage>,
576 impl_writeable_tlv_based!(IrrevocablyResolvedHTLC, {
577 (0, commitment_tx_output_idx, required),
578 (2, payment_preimage, option),
581 /// A ChannelMonitor handles chain events (blocks connected and disconnected) and generates
582 /// on-chain transactions to ensure no loss of funds occurs.
584 /// You MUST ensure that no ChannelMonitors for a given channel anywhere contain out-of-date
585 /// information and are actively monitoring the chain.
587 /// Pending Events or updated HTLCs which have not yet been read out by
588 /// get_and_clear_pending_monitor_events or get_and_clear_pending_events are serialized to disk and
589 /// reloaded at deserialize-time. Thus, you must ensure that, when handling events, all events
590 /// gotten are fully handled before re-serializing the new state.
592 /// Note that the deserializer is only implemented for (BlockHash, ChannelMonitor), which
593 /// tells you the last block hash which was block_connect()ed. You MUST rescan any blocks along
594 /// the "reorg path" (ie disconnecting blocks until you find a common ancestor from both the
595 /// returned block hash and the the current chain and then reconnecting blocks to get to the
596 /// best chain) upon deserializing the object!
597 pub struct ChannelMonitor<Signer: Sign> {
599 pub(crate) inner: Mutex<ChannelMonitorImpl<Signer>>,
601 inner: Mutex<ChannelMonitorImpl<Signer>>,
604 impl<Signer: Sign> Clone for ChannelMonitor<Signer> {
605 fn clone(&self) -> Self {
606 Self { inner: Mutex::new(self.inner.lock().unwrap().clone()) }
611 pub(crate) struct ChannelMonitorImpl<Signer: Sign> {
612 latest_update_id: u64,
613 commitment_transaction_number_obscure_factor: u64,
615 destination_script: Script,
616 broadcasted_holder_revokable_script: Option<(Script, PublicKey, PublicKey)>,
617 counterparty_payment_script: Script,
618 shutdown_script: Option<Script>,
620 channel_keys_id: [u8; 32],
621 holder_revocation_basepoint: PublicKey,
622 funding_info: (OutPoint, Script),
623 current_counterparty_commitment_txid: Option<Txid>,
624 prev_counterparty_commitment_txid: Option<Txid>,
626 counterparty_commitment_params: CounterpartyCommitmentParameters,
627 funding_redeemscript: Script,
628 channel_value_satoshis: u64,
629 // first is the idx of the first of the two per-commitment points
630 their_cur_per_commitment_points: Option<(u64, PublicKey, Option<PublicKey>)>,
632 on_holder_tx_csv: u16,
634 commitment_secrets: CounterpartyCommitmentSecrets,
635 /// The set of outpoints in each counterparty commitment transaction. We always need at least
636 /// the payment hash from `HTLCOutputInCommitment` to claim even a revoked commitment
637 /// transaction broadcast as we need to be able to construct the witness script in all cases.
638 counterparty_claimable_outpoints: HashMap<Txid, Vec<(HTLCOutputInCommitment, Option<Box<HTLCSource>>)>>,
639 /// We cannot identify HTLC-Success or HTLC-Timeout transactions by themselves on the chain.
640 /// Nor can we figure out their commitment numbers without the commitment transaction they are
641 /// spending. Thus, in order to claim them via revocation key, we track all the counterparty
642 /// commitment transactions which we find on-chain, mapping them to the commitment number which
643 /// can be used to derive the revocation key and claim the transactions.
644 counterparty_commitment_txn_on_chain: HashMap<Txid, u64>,
645 /// Cache used to make pruning of payment_preimages faster.
646 /// Maps payment_hash values to commitment numbers for counterparty transactions for non-revoked
647 /// counterparty transactions (ie should remain pretty small).
648 /// Serialized to disk but should generally not be sent to Watchtowers.
649 counterparty_hash_commitment_number: HashMap<PaymentHash, u64>,
651 // We store two holder commitment transactions to avoid any race conditions where we may update
652 // some monitors (potentially on watchtowers) but then fail to update others, resulting in the
653 // various monitors for one channel being out of sync, and us broadcasting a holder
654 // transaction for which we have deleted claim information on some watchtowers.
655 prev_holder_signed_commitment_tx: Option<HolderSignedTx>,
656 current_holder_commitment_tx: HolderSignedTx,
658 // Used just for ChannelManager to make sure it has the latest channel data during
660 current_counterparty_commitment_number: u64,
661 // Used just for ChannelManager to make sure it has the latest channel data during
663 current_holder_commitment_number: u64,
665 /// The set of payment hashes from inbound payments for which we know the preimage. Payment
666 /// preimages that are not included in any unrevoked local commitment transaction or unrevoked
667 /// remote commitment transactions are automatically removed when commitment transactions are
669 payment_preimages: HashMap<PaymentHash, PaymentPreimage>,
671 // Note that `MonitorEvent`s MUST NOT be generated during update processing, only generated
672 // during chain data processing. This prevents a race in `ChainMonitor::update_channel` (and
673 // presumably user implementations thereof as well) where we update the in-memory channel
674 // object, then before the persistence finishes (as it's all under a read-lock), we return
675 // pending events to the user or to the relevant `ChannelManager`. Then, on reload, we'll have
676 // the pre-event state here, but have processed the event in the `ChannelManager`.
677 // Note that because the `event_lock` in `ChainMonitor` is only taken in
678 // block/transaction-connected events and *not* during block/transaction-disconnected events,
679 // we further MUST NOT generate events during block/transaction-disconnection.
680 pending_monitor_events: Vec<MonitorEvent>,
682 pending_events: Vec<Event>,
684 // Used to track on-chain events (i.e., transactions part of channels confirmed on chain) on
685 // which to take actions once they reach enough confirmations. Each entry includes the
686 // transaction's id and the height when the transaction was confirmed on chain.
687 onchain_events_awaiting_threshold_conf: Vec<OnchainEventEntry>,
689 // If we get serialized out and re-read, we need to make sure that the chain monitoring
690 // interface knows about the TXOs that we want to be notified of spends of. We could probably
691 // be smart and derive them from the above storage fields, but its much simpler and more
692 // Obviously Correct (tm) if we just keep track of them explicitly.
693 outputs_to_watch: HashMap<Txid, Vec<(u32, Script)>>,
696 pub onchain_tx_handler: OnchainTxHandler<Signer>,
698 onchain_tx_handler: OnchainTxHandler<Signer>,
700 // This is set when the Channel[Manager] generated a ChannelMonitorUpdate which indicated the
701 // channel has been force-closed. After this is set, no further holder commitment transaction
702 // updates may occur, and we panic!() if one is provided.
703 lockdown_from_offchain: bool,
705 // Set once we've signed a holder commitment transaction and handed it over to our
706 // OnchainTxHandler. After this is set, no future updates to our holder commitment transactions
707 // may occur, and we fail any such monitor updates.
709 // In case of update rejection due to a locally already signed commitment transaction, we
710 // nevertheless store update content to track in case of concurrent broadcast by another
711 // remote monitor out-of-order with regards to the block view.
712 holder_tx_signed: bool,
714 // If a spend of the funding output is seen, we set this to true and reject any further
715 // updates. This prevents any further changes in the offchain state no matter the order
716 // of block connection between ChannelMonitors and the ChannelManager.
717 funding_spend_seen: bool,
719 funding_spend_confirmed: Option<Txid>,
720 /// The set of HTLCs which have been either claimed or failed on chain and have reached
721 /// the requisite confirmations on the claim/fail transaction (either ANTI_REORG_DELAY or the
722 /// spending CSV for revocable outputs).
723 htlcs_resolved_on_chain: Vec<IrrevocablyResolvedHTLC>,
725 // We simply modify best_block in Channel's block_connected so that serialization is
726 // consistent but hopefully the users' copy handles block_connected in a consistent way.
727 // (we do *not*, however, update them in update_monitor to ensure any local user copies keep
728 // their best_block from its state and not based on updated copies that didn't run through
729 // the full block_connected).
730 best_block: BestBlock,
732 /// The node_id of our counterparty
733 counterparty_node_id: Option<PublicKey>,
735 secp_ctx: Secp256k1<secp256k1::All>, //TODO: dedup this a bit...
738 /// Transaction outputs to watch for on-chain spends.
739 pub type TransactionOutputs = (Txid, Vec<(u32, TxOut)>);
741 #[cfg(any(test, fuzzing, feature = "_test_utils"))]
742 /// Used only in testing and fuzzing to check serialization roundtrips don't change the underlying
744 impl<Signer: Sign> PartialEq for ChannelMonitor<Signer> {
745 fn eq(&self, other: &Self) -> bool {
746 let inner = self.inner.lock().unwrap();
747 let other = other.inner.lock().unwrap();
752 #[cfg(any(test, fuzzing, feature = "_test_utils"))]
753 /// Used only in testing and fuzzing to check serialization roundtrips don't change the underlying
755 impl<Signer: Sign> PartialEq for ChannelMonitorImpl<Signer> {
756 fn eq(&self, other: &Self) -> bool {
757 if self.latest_update_id != other.latest_update_id ||
758 self.commitment_transaction_number_obscure_factor != other.commitment_transaction_number_obscure_factor ||
759 self.destination_script != other.destination_script ||
760 self.broadcasted_holder_revokable_script != other.broadcasted_holder_revokable_script ||
761 self.counterparty_payment_script != other.counterparty_payment_script ||
762 self.channel_keys_id != other.channel_keys_id ||
763 self.holder_revocation_basepoint != other.holder_revocation_basepoint ||
764 self.funding_info != other.funding_info ||
765 self.current_counterparty_commitment_txid != other.current_counterparty_commitment_txid ||
766 self.prev_counterparty_commitment_txid != other.prev_counterparty_commitment_txid ||
767 self.counterparty_commitment_params != other.counterparty_commitment_params ||
768 self.funding_redeemscript != other.funding_redeemscript ||
769 self.channel_value_satoshis != other.channel_value_satoshis ||
770 self.their_cur_per_commitment_points != other.their_cur_per_commitment_points ||
771 self.on_holder_tx_csv != other.on_holder_tx_csv ||
772 self.commitment_secrets != other.commitment_secrets ||
773 self.counterparty_claimable_outpoints != other.counterparty_claimable_outpoints ||
774 self.counterparty_commitment_txn_on_chain != other.counterparty_commitment_txn_on_chain ||
775 self.counterparty_hash_commitment_number != other.counterparty_hash_commitment_number ||
776 self.prev_holder_signed_commitment_tx != other.prev_holder_signed_commitment_tx ||
777 self.current_counterparty_commitment_number != other.current_counterparty_commitment_number ||
778 self.current_holder_commitment_number != other.current_holder_commitment_number ||
779 self.current_holder_commitment_tx != other.current_holder_commitment_tx ||
780 self.payment_preimages != other.payment_preimages ||
781 self.pending_monitor_events != other.pending_monitor_events ||
782 self.pending_events.len() != other.pending_events.len() || // We trust events to round-trip properly
783 self.onchain_events_awaiting_threshold_conf != other.onchain_events_awaiting_threshold_conf ||
784 self.outputs_to_watch != other.outputs_to_watch ||
785 self.lockdown_from_offchain != other.lockdown_from_offchain ||
786 self.holder_tx_signed != other.holder_tx_signed ||
787 self.funding_spend_seen != other.funding_spend_seen ||
788 self.funding_spend_confirmed != other.funding_spend_confirmed ||
789 self.htlcs_resolved_on_chain != other.htlcs_resolved_on_chain
798 impl<Signer: Sign> Writeable for ChannelMonitor<Signer> {
799 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), Error> {
800 self.inner.lock().unwrap().write(writer)
804 // These are also used for ChannelMonitorUpdate, above.
805 const SERIALIZATION_VERSION: u8 = 1;
806 const MIN_SERIALIZATION_VERSION: u8 = 1;
808 impl<Signer: Sign> Writeable for ChannelMonitorImpl<Signer> {
809 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), Error> {
810 write_ver_prefix!(writer, SERIALIZATION_VERSION, MIN_SERIALIZATION_VERSION);
812 self.latest_update_id.write(writer)?;
814 // Set in initial Channel-object creation, so should always be set by now:
815 U48(self.commitment_transaction_number_obscure_factor).write(writer)?;
817 self.destination_script.write(writer)?;
818 if let Some(ref broadcasted_holder_revokable_script) = self.broadcasted_holder_revokable_script {
819 writer.write_all(&[0; 1])?;
820 broadcasted_holder_revokable_script.0.write(writer)?;
821 broadcasted_holder_revokable_script.1.write(writer)?;
822 broadcasted_holder_revokable_script.2.write(writer)?;
824 writer.write_all(&[1; 1])?;
827 self.counterparty_payment_script.write(writer)?;
828 match &self.shutdown_script {
829 Some(script) => script.write(writer)?,
830 None => Script::new().write(writer)?,
833 self.channel_keys_id.write(writer)?;
834 self.holder_revocation_basepoint.write(writer)?;
835 writer.write_all(&self.funding_info.0.txid[..])?;
836 writer.write_all(&byte_utils::be16_to_array(self.funding_info.0.index))?;
837 self.funding_info.1.write(writer)?;
838 self.current_counterparty_commitment_txid.write(writer)?;
839 self.prev_counterparty_commitment_txid.write(writer)?;
841 self.counterparty_commitment_params.write(writer)?;
842 self.funding_redeemscript.write(writer)?;
843 self.channel_value_satoshis.write(writer)?;
845 match self.their_cur_per_commitment_points {
846 Some((idx, pubkey, second_option)) => {
847 writer.write_all(&byte_utils::be48_to_array(idx))?;
848 writer.write_all(&pubkey.serialize())?;
849 match second_option {
850 Some(second_pubkey) => {
851 writer.write_all(&second_pubkey.serialize())?;
854 writer.write_all(&[0; 33])?;
859 writer.write_all(&byte_utils::be48_to_array(0))?;
863 writer.write_all(&byte_utils::be16_to_array(self.on_holder_tx_csv))?;
865 self.commitment_secrets.write(writer)?;
867 macro_rules! serialize_htlc_in_commitment {
868 ($htlc_output: expr) => {
869 writer.write_all(&[$htlc_output.offered as u8; 1])?;
870 writer.write_all(&byte_utils::be64_to_array($htlc_output.amount_msat))?;
871 writer.write_all(&byte_utils::be32_to_array($htlc_output.cltv_expiry))?;
872 writer.write_all(&$htlc_output.payment_hash.0[..])?;
873 $htlc_output.transaction_output_index.write(writer)?;
877 writer.write_all(&byte_utils::be64_to_array(self.counterparty_claimable_outpoints.len() as u64))?;
878 for (ref txid, ref htlc_infos) in self.counterparty_claimable_outpoints.iter() {
879 writer.write_all(&txid[..])?;
880 writer.write_all(&byte_utils::be64_to_array(htlc_infos.len() as u64))?;
881 for &(ref htlc_output, ref htlc_source) in htlc_infos.iter() {
882 debug_assert!(htlc_source.is_none() || Some(**txid) == self.current_counterparty_commitment_txid
883 || Some(**txid) == self.prev_counterparty_commitment_txid,
884 "HTLC Sources for all revoked commitment transactions should be none!");
885 serialize_htlc_in_commitment!(htlc_output);
886 htlc_source.as_ref().map(|b| b.as_ref()).write(writer)?;
890 writer.write_all(&byte_utils::be64_to_array(self.counterparty_commitment_txn_on_chain.len() as u64))?;
891 for (ref txid, commitment_number) in self.counterparty_commitment_txn_on_chain.iter() {
892 writer.write_all(&txid[..])?;
893 writer.write_all(&byte_utils::be48_to_array(*commitment_number))?;
896 writer.write_all(&byte_utils::be64_to_array(self.counterparty_hash_commitment_number.len() as u64))?;
897 for (ref payment_hash, commitment_number) in self.counterparty_hash_commitment_number.iter() {
898 writer.write_all(&payment_hash.0[..])?;
899 writer.write_all(&byte_utils::be48_to_array(*commitment_number))?;
902 if let Some(ref prev_holder_tx) = self.prev_holder_signed_commitment_tx {
903 writer.write_all(&[1; 1])?;
904 prev_holder_tx.write(writer)?;
906 writer.write_all(&[0; 1])?;
909 self.current_holder_commitment_tx.write(writer)?;
911 writer.write_all(&byte_utils::be48_to_array(self.current_counterparty_commitment_number))?;
912 writer.write_all(&byte_utils::be48_to_array(self.current_holder_commitment_number))?;
914 writer.write_all(&byte_utils::be64_to_array(self.payment_preimages.len() as u64))?;
915 for payment_preimage in self.payment_preimages.values() {
916 writer.write_all(&payment_preimage.0[..])?;
919 writer.write_all(&(self.pending_monitor_events.iter().filter(|ev| match ev {
920 MonitorEvent::HTLCEvent(_) => true,
921 MonitorEvent::CommitmentTxConfirmed(_) => true,
923 }).count() as u64).to_be_bytes())?;
924 for event in self.pending_monitor_events.iter() {
926 MonitorEvent::HTLCEvent(upd) => {
930 MonitorEvent::CommitmentTxConfirmed(_) => 1u8.write(writer)?,
931 _ => {}, // Covered in the TLV writes below
935 writer.write_all(&byte_utils::be64_to_array(self.pending_events.len() as u64))?;
936 for event in self.pending_events.iter() {
937 event.write(writer)?;
940 self.best_block.block_hash().write(writer)?;
941 writer.write_all(&byte_utils::be32_to_array(self.best_block.height()))?;
943 writer.write_all(&byte_utils::be64_to_array(self.onchain_events_awaiting_threshold_conf.len() as u64))?;
944 for ref entry in self.onchain_events_awaiting_threshold_conf.iter() {
945 entry.write(writer)?;
948 (self.outputs_to_watch.len() as u64).write(writer)?;
949 for (txid, idx_scripts) in self.outputs_to_watch.iter() {
951 (idx_scripts.len() as u64).write(writer)?;
952 for (idx, script) in idx_scripts.iter() {
954 script.write(writer)?;
957 self.onchain_tx_handler.write(writer)?;
959 self.lockdown_from_offchain.write(writer)?;
960 self.holder_tx_signed.write(writer)?;
962 write_tlv_fields!(writer, {
963 (1, self.funding_spend_confirmed, option),
964 (3, self.htlcs_resolved_on_chain, vec_type),
965 (5, self.pending_monitor_events, vec_type),
966 (7, self.funding_spend_seen, required),
967 (9, self.counterparty_node_id, option),
974 impl<Signer: Sign> ChannelMonitor<Signer> {
975 /// For lockorder enforcement purposes, we need to have a single site which constructs the
976 /// `inner` mutex, otherwise cases where we lock two monitors at the same time (eg in our
977 /// PartialEq implementation) we may decide a lockorder violation has occurred.
978 fn from_impl(imp: ChannelMonitorImpl<Signer>) -> Self {
979 ChannelMonitor { inner: Mutex::new(imp) }
982 pub(crate) fn new(secp_ctx: Secp256k1<secp256k1::All>, keys: Signer, shutdown_script: Option<Script>,
983 on_counterparty_tx_csv: u16, destination_script: &Script, funding_info: (OutPoint, Script),
984 channel_parameters: &ChannelTransactionParameters,
985 funding_redeemscript: Script, channel_value_satoshis: u64,
986 commitment_transaction_number_obscure_factor: u64,
987 initial_holder_commitment_tx: HolderCommitmentTransaction,
988 best_block: BestBlock, counterparty_node_id: PublicKey) -> ChannelMonitor<Signer> {
990 assert!(commitment_transaction_number_obscure_factor <= (1 << 48));
991 let payment_key_hash = WPubkeyHash::hash(&keys.pubkeys().payment_point.serialize());
992 let counterparty_payment_script = Builder::new().push_opcode(opcodes::all::OP_PUSHBYTES_0).push_slice(&payment_key_hash[..]).into_script();
994 let counterparty_channel_parameters = channel_parameters.counterparty_parameters.as_ref().unwrap();
995 let counterparty_delayed_payment_base_key = counterparty_channel_parameters.pubkeys.delayed_payment_basepoint;
996 let counterparty_htlc_base_key = counterparty_channel_parameters.pubkeys.htlc_basepoint;
997 let counterparty_commitment_params = CounterpartyCommitmentParameters { counterparty_delayed_payment_base_key, counterparty_htlc_base_key, on_counterparty_tx_csv };
999 let channel_keys_id = keys.channel_keys_id();
1000 let holder_revocation_basepoint = keys.pubkeys().revocation_basepoint;
1002 // block for Rust 1.34 compat
1003 let (holder_commitment_tx, current_holder_commitment_number) = {
1004 let trusted_tx = initial_holder_commitment_tx.trust();
1005 let txid = trusted_tx.txid();
1007 let tx_keys = trusted_tx.keys();
1008 let holder_commitment_tx = HolderSignedTx {
1010 revocation_key: tx_keys.revocation_key,
1011 a_htlc_key: tx_keys.broadcaster_htlc_key,
1012 b_htlc_key: tx_keys.countersignatory_htlc_key,
1013 delayed_payment_key: tx_keys.broadcaster_delayed_payment_key,
1014 per_commitment_point: tx_keys.per_commitment_point,
1015 htlc_outputs: Vec::new(), // There are never any HTLCs in the initial commitment transactions
1016 to_self_value_sat: initial_holder_commitment_tx.to_broadcaster_value_sat(),
1017 feerate_per_kw: trusted_tx.feerate_per_kw(),
1019 (holder_commitment_tx, trusted_tx.commitment_number())
1022 let onchain_tx_handler =
1023 OnchainTxHandler::new(destination_script.clone(), keys,
1024 channel_parameters.clone(), initial_holder_commitment_tx, secp_ctx.clone());
1026 let mut outputs_to_watch = HashMap::new();
1027 outputs_to_watch.insert(funding_info.0.txid, vec![(funding_info.0.index as u32, funding_info.1.clone())]);
1029 Self::from_impl(ChannelMonitorImpl {
1030 latest_update_id: 0,
1031 commitment_transaction_number_obscure_factor,
1033 destination_script: destination_script.clone(),
1034 broadcasted_holder_revokable_script: None,
1035 counterparty_payment_script,
1039 holder_revocation_basepoint,
1041 current_counterparty_commitment_txid: None,
1042 prev_counterparty_commitment_txid: None,
1044 counterparty_commitment_params,
1045 funding_redeemscript,
1046 channel_value_satoshis,
1047 their_cur_per_commitment_points: None,
1049 on_holder_tx_csv: counterparty_channel_parameters.selected_contest_delay,
1051 commitment_secrets: CounterpartyCommitmentSecrets::new(),
1052 counterparty_claimable_outpoints: HashMap::new(),
1053 counterparty_commitment_txn_on_chain: HashMap::new(),
1054 counterparty_hash_commitment_number: HashMap::new(),
1056 prev_holder_signed_commitment_tx: None,
1057 current_holder_commitment_tx: holder_commitment_tx,
1058 current_counterparty_commitment_number: 1 << 48,
1059 current_holder_commitment_number,
1061 payment_preimages: HashMap::new(),
1062 pending_monitor_events: Vec::new(),
1063 pending_events: Vec::new(),
1065 onchain_events_awaiting_threshold_conf: Vec::new(),
1070 lockdown_from_offchain: false,
1071 holder_tx_signed: false,
1072 funding_spend_seen: false,
1073 funding_spend_confirmed: None,
1074 htlcs_resolved_on_chain: Vec::new(),
1077 counterparty_node_id: Some(counterparty_node_id),
1084 fn provide_secret(&self, idx: u64, secret: [u8; 32]) -> Result<(), &'static str> {
1085 self.inner.lock().unwrap().provide_secret(idx, secret)
1088 /// Informs this monitor of the latest counterparty (ie non-broadcastable) commitment transaction.
1089 /// The monitor watches for it to be broadcasted and then uses the HTLC information (and
1090 /// possibly future revocation/preimage information) to claim outputs where possible.
1091 /// We cache also the mapping hash:commitment number to lighten pruning of old preimages by watchtowers.
1092 pub(crate) fn provide_latest_counterparty_commitment_tx<L: Deref>(
1095 htlc_outputs: Vec<(HTLCOutputInCommitment, Option<Box<HTLCSource>>)>,
1096 commitment_number: u64,
1097 their_per_commitment_point: PublicKey,
1099 ) where L::Target: Logger {
1100 self.inner.lock().unwrap().provide_latest_counterparty_commitment_tx(
1101 txid, htlc_outputs, commitment_number, their_per_commitment_point, logger)
1105 fn provide_latest_holder_commitment_tx(
1106 &self, holder_commitment_tx: HolderCommitmentTransaction,
1107 htlc_outputs: Vec<(HTLCOutputInCommitment, Option<Signature>, Option<HTLCSource>)>,
1108 ) -> Result<(), ()> {
1109 self.inner.lock().unwrap().provide_latest_holder_commitment_tx(holder_commitment_tx, htlc_outputs).map_err(|_| ())
1112 /// This is used to provide payment preimage(s) out-of-band during startup without updating the
1113 /// off-chain state with a new commitment transaction.
1114 pub(crate) fn provide_payment_preimage<B: Deref, F: Deref, L: Deref>(
1116 payment_hash: &PaymentHash,
1117 payment_preimage: &PaymentPreimage,
1119 fee_estimator: &LowerBoundedFeeEstimator<F>,
1122 B::Target: BroadcasterInterface,
1123 F::Target: FeeEstimator,
1126 self.inner.lock().unwrap().provide_payment_preimage(
1127 payment_hash, payment_preimage, broadcaster, fee_estimator, logger)
1130 pub(crate) fn broadcast_latest_holder_commitment_txn<B: Deref, L: Deref>(
1135 B::Target: BroadcasterInterface,
1138 self.inner.lock().unwrap().broadcast_latest_holder_commitment_txn(broadcaster, logger)
1141 /// Updates a ChannelMonitor on the basis of some new information provided by the Channel
1144 /// panics if the given update is not the next update by update_id.
1145 pub fn update_monitor<B: Deref, F: Deref, L: Deref>(
1147 updates: &ChannelMonitorUpdate,
1153 B::Target: BroadcasterInterface,
1154 F::Target: FeeEstimator,
1157 self.inner.lock().unwrap().update_monitor(updates, broadcaster, fee_estimator, logger)
1160 /// Gets the update_id from the latest ChannelMonitorUpdate which was applied to this
1162 pub fn get_latest_update_id(&self) -> u64 {
1163 self.inner.lock().unwrap().get_latest_update_id()
1166 /// Gets the funding transaction outpoint of the channel this ChannelMonitor is monitoring for.
1167 pub fn get_funding_txo(&self) -> (OutPoint, Script) {
1168 self.inner.lock().unwrap().get_funding_txo().clone()
1171 /// Gets a list of txids, with their output scripts (in the order they appear in the
1172 /// transaction), which we must learn about spends of via block_connected().
1173 pub fn get_outputs_to_watch(&self) -> Vec<(Txid, Vec<(u32, Script)>)> {
1174 self.inner.lock().unwrap().get_outputs_to_watch()
1175 .iter().map(|(txid, outputs)| (*txid, outputs.clone())).collect()
1178 /// Loads the funding txo and outputs to watch into the given `chain::Filter` by repeatedly
1179 /// calling `chain::Filter::register_output` and `chain::Filter::register_tx` until all outputs
1180 /// have been registered.
1181 pub fn load_outputs_to_watch<F: Deref>(&self, filter: &F) where F::Target: chain::Filter {
1182 let lock = self.inner.lock().unwrap();
1183 filter.register_tx(&lock.get_funding_txo().0.txid, &lock.get_funding_txo().1);
1184 for (txid, outputs) in lock.get_outputs_to_watch().iter() {
1185 for (index, script_pubkey) in outputs.iter() {
1186 assert!(*index <= u16::max_value() as u32);
1187 filter.register_output(WatchedOutput {
1189 outpoint: OutPoint { txid: *txid, index: *index as u16 },
1190 script_pubkey: script_pubkey.clone(),
1196 /// Get the list of HTLCs who's status has been updated on chain. This should be called by
1197 /// ChannelManager via [`chain::Watch::release_pending_monitor_events`].
1198 pub fn get_and_clear_pending_monitor_events(&self) -> Vec<MonitorEvent> {
1199 self.inner.lock().unwrap().get_and_clear_pending_monitor_events()
1202 /// Gets the list of pending events which were generated by previous actions, clearing the list
1205 /// This is called by ChainMonitor::get_and_clear_pending_events() and is equivalent to
1206 /// EventsProvider::get_and_clear_pending_events() except that it requires &mut self as we do
1207 /// no internal locking in ChannelMonitors.
1208 pub fn get_and_clear_pending_events(&self) -> Vec<Event> {
1209 self.inner.lock().unwrap().get_and_clear_pending_events()
1212 pub(crate) fn get_min_seen_secret(&self) -> u64 {
1213 self.inner.lock().unwrap().get_min_seen_secret()
1216 pub(crate) fn get_cur_counterparty_commitment_number(&self) -> u64 {
1217 self.inner.lock().unwrap().get_cur_counterparty_commitment_number()
1220 pub(crate) fn get_cur_holder_commitment_number(&self) -> u64 {
1221 self.inner.lock().unwrap().get_cur_holder_commitment_number()
1224 /// Gets the `node_id` of the counterparty for this channel.
1226 /// Will be `None` for channels constructed on LDK versions prior to 0.0.110 and always `Some`
1228 pub fn get_counterparty_node_id(&self) -> Option<PublicKey> {
1229 self.inner.lock().unwrap().counterparty_node_id
1232 /// Used by ChannelManager deserialization to broadcast the latest holder state if its copy of
1233 /// the Channel was out-of-date. You may use it to get a broadcastable holder toxic tx in case of
1234 /// fallen-behind, i.e when receiving a channel_reestablish with a proof that our counterparty side knows
1235 /// a higher revocation secret than the holder commitment number we are aware of. Broadcasting these
1236 /// transactions are UNSAFE, as they allow counterparty side to punish you. Nevertheless you may want to
1237 /// broadcast them if counterparty don't close channel with his higher commitment transaction after a
1238 /// substantial amount of time (a month or even a year) to get back funds. Best may be to contact
1239 /// out-of-band the other node operator to coordinate with him if option is available to you.
1240 /// In any-case, choice is up to the user.
1241 pub fn get_latest_holder_commitment_txn<L: Deref>(&self, logger: &L) -> Vec<Transaction>
1242 where L::Target: Logger {
1243 self.inner.lock().unwrap().get_latest_holder_commitment_txn(logger)
1246 /// Unsafe test-only version of get_latest_holder_commitment_txn used by our test framework
1247 /// to bypass HolderCommitmentTransaction state update lockdown after signature and generate
1248 /// revoked commitment transaction.
1249 #[cfg(any(test, feature = "unsafe_revoked_tx_signing"))]
1250 pub fn unsafe_get_latest_holder_commitment_txn<L: Deref>(&self, logger: &L) -> Vec<Transaction>
1251 where L::Target: Logger {
1252 self.inner.lock().unwrap().unsafe_get_latest_holder_commitment_txn(logger)
1255 /// Processes transactions in a newly connected block, which may result in any of the following:
1256 /// - update the monitor's state against resolved HTLCs
1257 /// - punish the counterparty in the case of seeing a revoked commitment transaction
1258 /// - force close the channel and claim/timeout incoming/outgoing HTLCs if near expiration
1259 /// - detect settled outputs for later spending
1260 /// - schedule and bump any in-flight claims
1262 /// Returns any new outputs to watch from `txdata`; after called, these are also included in
1263 /// [`get_outputs_to_watch`].
1265 /// [`get_outputs_to_watch`]: #method.get_outputs_to_watch
1266 pub fn block_connected<B: Deref, F: Deref, L: Deref>(
1268 header: &BlockHeader,
1269 txdata: &TransactionData,
1274 ) -> Vec<TransactionOutputs>
1276 B::Target: BroadcasterInterface,
1277 F::Target: FeeEstimator,
1280 self.inner.lock().unwrap().block_connected(
1281 header, txdata, height, broadcaster, fee_estimator, logger)
1284 /// Determines if the disconnected block contained any transactions of interest and updates
1286 pub fn block_disconnected<B: Deref, F: Deref, L: Deref>(
1288 header: &BlockHeader,
1294 B::Target: BroadcasterInterface,
1295 F::Target: FeeEstimator,
1298 self.inner.lock().unwrap().block_disconnected(
1299 header, height, broadcaster, fee_estimator, logger)
1302 /// Processes transactions confirmed in a block with the given header and height, returning new
1303 /// outputs to watch. See [`block_connected`] for details.
1305 /// Used instead of [`block_connected`] by clients that are notified of transactions rather than
1306 /// blocks. See [`chain::Confirm`] for calling expectations.
1308 /// [`block_connected`]: Self::block_connected
1309 pub fn transactions_confirmed<B: Deref, F: Deref, L: Deref>(
1311 header: &BlockHeader,
1312 txdata: &TransactionData,
1317 ) -> Vec<TransactionOutputs>
1319 B::Target: BroadcasterInterface,
1320 F::Target: FeeEstimator,
1323 let bounded_fee_estimator = LowerBoundedFeeEstimator::new(fee_estimator);
1324 self.inner.lock().unwrap().transactions_confirmed(
1325 header, txdata, height, broadcaster, &bounded_fee_estimator, logger)
1328 /// Processes a transaction that was reorganized out of the chain.
1330 /// Used instead of [`block_disconnected`] by clients that are notified of transactions rather
1331 /// than blocks. See [`chain::Confirm`] for calling expectations.
1333 /// [`block_disconnected`]: Self::block_disconnected
1334 pub fn transaction_unconfirmed<B: Deref, F: Deref, L: Deref>(
1341 B::Target: BroadcasterInterface,
1342 F::Target: FeeEstimator,
1345 let bounded_fee_estimator = LowerBoundedFeeEstimator::new(fee_estimator);
1346 self.inner.lock().unwrap().transaction_unconfirmed(
1347 txid, broadcaster, &bounded_fee_estimator, logger);
1350 /// Updates the monitor with the current best chain tip, returning new outputs to watch. See
1351 /// [`block_connected`] for details.
1353 /// Used instead of [`block_connected`] by clients that are notified of transactions rather than
1354 /// blocks. See [`chain::Confirm`] for calling expectations.
1356 /// [`block_connected`]: Self::block_connected
1357 pub fn best_block_updated<B: Deref, F: Deref, L: Deref>(
1359 header: &BlockHeader,
1364 ) -> Vec<TransactionOutputs>
1366 B::Target: BroadcasterInterface,
1367 F::Target: FeeEstimator,
1370 let bounded_fee_estimator = LowerBoundedFeeEstimator::new(fee_estimator);
1371 self.inner.lock().unwrap().best_block_updated(
1372 header, height, broadcaster, &bounded_fee_estimator, logger)
1375 /// Returns the set of txids that should be monitored for re-organization out of the chain.
1376 pub fn get_relevant_txids(&self) -> Vec<Txid> {
1377 let inner = self.inner.lock().unwrap();
1378 let mut txids: Vec<Txid> = inner.onchain_events_awaiting_threshold_conf
1380 .map(|entry| entry.txid)
1381 .chain(inner.onchain_tx_handler.get_relevant_txids().into_iter())
1383 txids.sort_unstable();
1388 /// Gets the latest best block which was connected either via the [`chain::Listen`] or
1389 /// [`chain::Confirm`] interfaces.
1390 pub fn current_best_block(&self) -> BestBlock {
1391 self.inner.lock().unwrap().best_block.clone()
1394 /// Gets the balances in this channel which are either claimable by us if we were to
1395 /// force-close the channel now or which are claimable on-chain (possibly awaiting
1398 /// Any balances in the channel which are available on-chain (excluding on-chain fees) are
1399 /// included here until an [`Event::SpendableOutputs`] event has been generated for the
1400 /// balance, or until our counterparty has claimed the balance and accrued several
1401 /// confirmations on the claim transaction.
1403 /// Note that the balances available when you or your counterparty have broadcasted revoked
1404 /// state(s) may not be fully captured here.
1407 /// See [`Balance`] for additional details on the types of claimable balances which
1408 /// may be returned here and their meanings.
1409 pub fn get_claimable_balances(&self) -> Vec<Balance> {
1410 let mut res = Vec::new();
1411 let us = self.inner.lock().unwrap();
1413 let mut confirmed_txid = us.funding_spend_confirmed;
1414 let mut pending_commitment_tx_conf_thresh = None;
1415 let funding_spend_pending = us.onchain_events_awaiting_threshold_conf.iter().find_map(|event| {
1416 if let OnchainEvent::FundingSpendConfirmation { .. } = event.event {
1417 Some((event.txid, event.confirmation_threshold()))
1420 if let Some((txid, conf_thresh)) = funding_spend_pending {
1421 debug_assert!(us.funding_spend_confirmed.is_none(),
1422 "We have a pending funding spend awaiting anti-reorg confirmation, we can't have confirmed it already!");
1423 confirmed_txid = Some(txid);
1424 pending_commitment_tx_conf_thresh = Some(conf_thresh);
1427 macro_rules! walk_htlcs {
1428 ($holder_commitment: expr, $htlc_iter: expr) => {
1429 for htlc in $htlc_iter {
1430 if let Some(htlc_commitment_tx_output_idx) = htlc.transaction_output_index {
1431 if let Some(conf_thresh) = us.onchain_events_awaiting_threshold_conf.iter().find_map(|event| {
1432 if let OnchainEvent::MaturingOutput { descriptor: SpendableOutputDescriptor::DelayedPaymentOutput(descriptor) } = &event.event {
1433 if descriptor.outpoint.index as u32 == htlc_commitment_tx_output_idx { Some(event.confirmation_threshold()) } else { None }
1436 debug_assert!($holder_commitment);
1437 res.push(Balance::ClaimableAwaitingConfirmations {
1438 claimable_amount_satoshis: htlc.amount_msat / 1000,
1439 confirmation_height: conf_thresh,
1441 } else if us.htlcs_resolved_on_chain.iter().any(|v| v.commitment_tx_output_idx == htlc_commitment_tx_output_idx) {
1442 // Funding transaction spends should be fully confirmed by the time any
1443 // HTLC transactions are resolved, unless we're talking about a holder
1444 // commitment tx, whose resolution is delayed until the CSV timeout is
1445 // reached, even though HTLCs may be resolved after only
1446 // ANTI_REORG_DELAY confirmations.
1447 debug_assert!($holder_commitment || us.funding_spend_confirmed.is_some());
1448 } else if htlc.offered == $holder_commitment {
1449 // If the payment was outbound, check if there's an HTLCUpdate
1450 // indicating we have spent this HTLC with a timeout, claiming it back
1451 // and awaiting confirmations on it.
1452 let htlc_update_pending = us.onchain_events_awaiting_threshold_conf.iter().find_map(|event| {
1453 if let OnchainEvent::HTLCUpdate { commitment_tx_output_idx: Some(commitment_tx_output_idx), .. } = event.event {
1454 if commitment_tx_output_idx == htlc_commitment_tx_output_idx {
1455 Some(event.confirmation_threshold()) } else { None }
1458 if let Some(conf_thresh) = htlc_update_pending {
1459 res.push(Balance::ClaimableAwaitingConfirmations {
1460 claimable_amount_satoshis: htlc.amount_msat / 1000,
1461 confirmation_height: conf_thresh,
1464 res.push(Balance::MaybeClaimableHTLCAwaitingTimeout {
1465 claimable_amount_satoshis: htlc.amount_msat / 1000,
1466 claimable_height: htlc.cltv_expiry,
1469 } else if us.payment_preimages.get(&htlc.payment_hash).is_some() {
1470 // Otherwise (the payment was inbound), only expose it as claimable if
1471 // we know the preimage.
1472 // Note that if there is a pending claim, but it did not use the
1473 // preimage, we lost funds to our counterparty! We will then continue
1474 // to show it as ContentiousClaimable until ANTI_REORG_DELAY.
1475 let htlc_spend_pending = us.onchain_events_awaiting_threshold_conf.iter().find_map(|event| {
1476 if let OnchainEvent::HTLCSpendConfirmation { commitment_tx_output_idx, preimage, .. } = event.event {
1477 if commitment_tx_output_idx == htlc_commitment_tx_output_idx {
1478 Some((event.confirmation_threshold(), preimage.is_some()))
1482 if let Some((conf_thresh, true)) = htlc_spend_pending {
1483 res.push(Balance::ClaimableAwaitingConfirmations {
1484 claimable_amount_satoshis: htlc.amount_msat / 1000,
1485 confirmation_height: conf_thresh,
1488 res.push(Balance::ContentiousClaimable {
1489 claimable_amount_satoshis: htlc.amount_msat / 1000,
1490 timeout_height: htlc.cltv_expiry,
1499 if let Some(txid) = confirmed_txid {
1500 let mut found_commitment_tx = false;
1501 if Some(txid) == us.current_counterparty_commitment_txid || Some(txid) == us.prev_counterparty_commitment_txid {
1502 walk_htlcs!(false, us.counterparty_claimable_outpoints.get(&txid).unwrap().iter().map(|(a, _)| a));
1503 if let Some(conf_thresh) = pending_commitment_tx_conf_thresh {
1504 if let Some(value) = us.onchain_events_awaiting_threshold_conf.iter().find_map(|event| {
1505 if let OnchainEvent::MaturingOutput {
1506 descriptor: SpendableOutputDescriptor::StaticPaymentOutput(descriptor)
1508 Some(descriptor.output.value)
1511 res.push(Balance::ClaimableAwaitingConfirmations {
1512 claimable_amount_satoshis: value,
1513 confirmation_height: conf_thresh,
1516 // If a counterparty commitment transaction is awaiting confirmation, we
1517 // should either have a StaticPaymentOutput MaturingOutput event awaiting
1518 // confirmation with the same height or have never met our dust amount.
1521 found_commitment_tx = true;
1522 } else if txid == us.current_holder_commitment_tx.txid {
1523 walk_htlcs!(true, us.current_holder_commitment_tx.htlc_outputs.iter().map(|(a, _, _)| a));
1524 if let Some(conf_thresh) = pending_commitment_tx_conf_thresh {
1525 res.push(Balance::ClaimableAwaitingConfirmations {
1526 claimable_amount_satoshis: us.current_holder_commitment_tx.to_self_value_sat,
1527 confirmation_height: conf_thresh,
1530 found_commitment_tx = true;
1531 } else if let Some(prev_commitment) = &us.prev_holder_signed_commitment_tx {
1532 if txid == prev_commitment.txid {
1533 walk_htlcs!(true, prev_commitment.htlc_outputs.iter().map(|(a, _, _)| a));
1534 if let Some(conf_thresh) = pending_commitment_tx_conf_thresh {
1535 res.push(Balance::ClaimableAwaitingConfirmations {
1536 claimable_amount_satoshis: prev_commitment.to_self_value_sat,
1537 confirmation_height: conf_thresh,
1540 found_commitment_tx = true;
1543 if !found_commitment_tx {
1544 if let Some(conf_thresh) = pending_commitment_tx_conf_thresh {
1545 // We blindly assume this is a cooperative close transaction here, and that
1546 // neither us nor our counterparty misbehaved. At worst we've under-estimated
1547 // the amount we can claim as we'll punish a misbehaving counterparty.
1548 res.push(Balance::ClaimableAwaitingConfirmations {
1549 claimable_amount_satoshis: us.current_holder_commitment_tx.to_self_value_sat,
1550 confirmation_height: conf_thresh,
1554 // TODO: Add logic to provide claimable balances for counterparty broadcasting revoked
1557 let mut claimable_inbound_htlc_value_sat = 0;
1558 for (htlc, _, _) in us.current_holder_commitment_tx.htlc_outputs.iter() {
1559 if htlc.transaction_output_index.is_none() { continue; }
1561 res.push(Balance::MaybeClaimableHTLCAwaitingTimeout {
1562 claimable_amount_satoshis: htlc.amount_msat / 1000,
1563 claimable_height: htlc.cltv_expiry,
1565 } else if us.payment_preimages.get(&htlc.payment_hash).is_some() {
1566 claimable_inbound_htlc_value_sat += htlc.amount_msat / 1000;
1569 res.push(Balance::ClaimableOnChannelClose {
1570 claimable_amount_satoshis: us.current_holder_commitment_tx.to_self_value_sat + claimable_inbound_htlc_value_sat,
1577 /// Gets the set of outbound HTLCs which are pending resolution in this channel.
1578 /// This is used to reconstruct pending outbound payments on restart in the ChannelManager.
1579 pub(crate) fn get_pending_outbound_htlcs(&self) -> HashMap<HTLCSource, HTLCOutputInCommitment> {
1580 let mut res = HashMap::new();
1581 let us = self.inner.lock().unwrap();
1583 macro_rules! walk_htlcs {
1584 ($holder_commitment: expr, $htlc_iter: expr) => {
1585 for (htlc, source) in $htlc_iter {
1586 if us.htlcs_resolved_on_chain.iter().any(|v| Some(v.commitment_tx_output_idx) == htlc.transaction_output_index) {
1587 // We should assert that funding_spend_confirmed is_some() here, but we
1588 // have some unit tests which violate HTLC transaction CSVs entirely and
1590 // TODO: Once tests all connect transactions at consensus-valid times, we
1591 // should assert here like we do in `get_claimable_balances`.
1592 } else if htlc.offered == $holder_commitment {
1593 // If the payment was outbound, check if there's an HTLCUpdate
1594 // indicating we have spent this HTLC with a timeout, claiming it back
1595 // and awaiting confirmations on it.
1596 let htlc_update_confd = us.onchain_events_awaiting_threshold_conf.iter().any(|event| {
1597 if let OnchainEvent::HTLCUpdate { commitment_tx_output_idx: Some(commitment_tx_output_idx), .. } = event.event {
1598 // If the HTLC was timed out, we wait for ANTI_REORG_DELAY blocks
1599 // before considering it "no longer pending" - this matches when we
1600 // provide the ChannelManager an HTLC failure event.
1601 Some(commitment_tx_output_idx) == htlc.transaction_output_index &&
1602 us.best_block.height() >= event.height + ANTI_REORG_DELAY - 1
1603 } else if let OnchainEvent::HTLCSpendConfirmation { commitment_tx_output_idx, .. } = event.event {
1604 // If the HTLC was fulfilled with a preimage, we consider the HTLC
1605 // immediately non-pending, matching when we provide ChannelManager
1607 Some(commitment_tx_output_idx) == htlc.transaction_output_index
1610 if !htlc_update_confd {
1611 res.insert(source.clone(), htlc.clone());
1618 // We're only concerned with the confirmation count of HTLC transactions, and don't
1619 // actually care how many confirmations a commitment transaction may or may not have. Thus,
1620 // we look for either a FundingSpendConfirmation event or a funding_spend_confirmed.
1621 let confirmed_txid = us.funding_spend_confirmed.or_else(|| {
1622 us.onchain_events_awaiting_threshold_conf.iter().find_map(|event| {
1623 if let OnchainEvent::FundingSpendConfirmation { .. } = event.event {
1628 if let Some(txid) = confirmed_txid {
1629 if Some(txid) == us.current_counterparty_commitment_txid || Some(txid) == us.prev_counterparty_commitment_txid {
1630 walk_htlcs!(false, us.counterparty_claimable_outpoints.get(&txid).unwrap().iter().filter_map(|(a, b)| {
1631 if let &Some(ref source) = b {
1632 Some((a, &**source))
1635 } else if txid == us.current_holder_commitment_tx.txid {
1636 walk_htlcs!(true, us.current_holder_commitment_tx.htlc_outputs.iter().filter_map(|(a, _, c)| {
1637 if let Some(source) = c { Some((a, source)) } else { None }
1639 } else if let Some(prev_commitment) = &us.prev_holder_signed_commitment_tx {
1640 if txid == prev_commitment.txid {
1641 walk_htlcs!(true, prev_commitment.htlc_outputs.iter().filter_map(|(a, _, c)| {
1642 if let Some(source) = c { Some((a, source)) } else { None }
1647 // If we have not seen a commitment transaction on-chain (ie the channel is not yet
1648 // closed), just examine the available counterparty commitment transactions. See docs
1649 // on `fail_unbroadcast_htlcs`, below, for justification.
1650 macro_rules! walk_counterparty_commitment {
1652 if let Some(ref latest_outpoints) = us.counterparty_claimable_outpoints.get($txid) {
1653 for &(ref htlc, ref source_option) in latest_outpoints.iter() {
1654 if let &Some(ref source) = source_option {
1655 res.insert((**source).clone(), htlc.clone());
1661 if let Some(ref txid) = us.current_counterparty_commitment_txid {
1662 walk_counterparty_commitment!(txid);
1664 if let Some(ref txid) = us.prev_counterparty_commitment_txid {
1665 walk_counterparty_commitment!(txid);
1672 pub(crate) fn get_stored_preimages(&self) -> HashMap<PaymentHash, PaymentPreimage> {
1673 self.inner.lock().unwrap().payment_preimages.clone()
1677 /// Compares a broadcasted commitment transaction's HTLCs with those in the latest state,
1678 /// failing any HTLCs which didn't make it into the broadcasted commitment transaction back
1679 /// after ANTI_REORG_DELAY blocks.
1681 /// We always compare against the set of HTLCs in counterparty commitment transactions, as those
1682 /// are the commitment transactions which are generated by us. The off-chain state machine in
1683 /// `Channel` will automatically resolve any HTLCs which were never included in a commitment
1684 /// transaction when it detects channel closure, but it is up to us to ensure any HTLCs which were
1685 /// included in a remote commitment transaction are failed back if they are not present in the
1686 /// broadcasted commitment transaction.
1688 /// Specifically, the removal process for HTLCs in `Channel` is always based on the counterparty
1689 /// sending a `revoke_and_ack`, which causes us to clear `prev_counterparty_commitment_txid`. Thus,
1690 /// as long as we examine both the current counterparty commitment transaction and, if it hasn't
1691 /// been revoked yet, the previous one, we we will never "forget" to resolve an HTLC.
1692 macro_rules! fail_unbroadcast_htlcs {
1693 ($self: expr, $commitment_tx_type: expr, $commitment_txid_confirmed: expr,
1694 $commitment_tx_conf_height: expr, $confirmed_htlcs_list: expr, $logger: expr) => { {
1695 macro_rules! check_htlc_fails {
1696 ($txid: expr, $commitment_tx: expr) => {
1697 if let Some(ref latest_outpoints) = $self.counterparty_claimable_outpoints.get($txid) {
1698 for &(ref htlc, ref source_option) in latest_outpoints.iter() {
1699 if let &Some(ref source) = source_option {
1700 // Check if the HTLC is present in the commitment transaction that was
1701 // broadcast, but not if it was below the dust limit, which we should
1702 // fail backwards immediately as there is no way for us to learn the
1703 // payment_preimage.
1704 // Note that if the dust limit were allowed to change between
1705 // commitment transactions we'd want to be check whether *any*
1706 // broadcastable commitment transaction has the HTLC in it, but it
1707 // cannot currently change after channel initialization, so we don't
1709 let confirmed_htlcs_iter: &mut Iterator<Item = (&HTLCOutputInCommitment, Option<&HTLCSource>)> = &mut $confirmed_htlcs_list;
1711 let mut matched_htlc = false;
1712 for (ref broadcast_htlc, ref broadcast_source) in confirmed_htlcs_iter {
1713 if broadcast_htlc.transaction_output_index.is_some() &&
1714 (Some(&**source) == *broadcast_source ||
1715 (broadcast_source.is_none() &&
1716 broadcast_htlc.payment_hash == htlc.payment_hash &&
1717 broadcast_htlc.amount_msat == htlc.amount_msat)) {
1718 matched_htlc = true;
1722 if matched_htlc { continue; }
1723 $self.onchain_events_awaiting_threshold_conf.retain(|ref entry| {
1724 if entry.height != $commitment_tx_conf_height { return true; }
1726 OnchainEvent::HTLCUpdate { source: ref update_source, .. } => {
1727 *update_source != **source
1732 let entry = OnchainEventEntry {
1733 txid: $commitment_txid_confirmed,
1734 height: $commitment_tx_conf_height,
1735 event: OnchainEvent::HTLCUpdate {
1736 source: (**source).clone(),
1737 payment_hash: htlc.payment_hash.clone(),
1738 htlc_value_satoshis: Some(htlc.amount_msat / 1000),
1739 commitment_tx_output_idx: None,
1742 log_trace!($logger, "Failing HTLC with payment_hash {} from {} counterparty commitment tx due to broadcast of {} commitment transaction {}, waiting for confirmation (at height {})",
1743 log_bytes!(htlc.payment_hash.0), $commitment_tx, $commitment_tx_type,
1744 $commitment_txid_confirmed, entry.confirmation_threshold());
1745 $self.onchain_events_awaiting_threshold_conf.push(entry);
1751 if let Some(ref txid) = $self.current_counterparty_commitment_txid {
1752 check_htlc_fails!(txid, "current");
1754 if let Some(ref txid) = $self.prev_counterparty_commitment_txid {
1755 check_htlc_fails!(txid, "previous");
1760 // In the `test_invalid_funding_tx` test, we need a bogus script which matches the HTLC-Accepted
1761 // witness length match (ie is 136 bytes long). We generate one here which we also use in some
1762 // in-line tests later.
1765 pub fn deliberately_bogus_accepted_htlc_witness_program() -> Vec<u8> {
1766 let mut ret = [opcodes::all::OP_NOP.into_u8(); 136];
1767 ret[131] = opcodes::all::OP_DROP.into_u8();
1768 ret[132] = opcodes::all::OP_DROP.into_u8();
1769 ret[133] = opcodes::all::OP_DROP.into_u8();
1770 ret[134] = opcodes::all::OP_DROP.into_u8();
1771 ret[135] = opcodes::OP_TRUE.into_u8();
1776 pub fn deliberately_bogus_accepted_htlc_witness() -> Vec<Vec<u8>> {
1777 vec![Vec::new(), Vec::new(), Vec::new(), Vec::new(), deliberately_bogus_accepted_htlc_witness_program().into()].into()
1780 impl<Signer: Sign> ChannelMonitorImpl<Signer> {
1781 /// Inserts a revocation secret into this channel monitor. Prunes old preimages if neither
1782 /// needed by holder commitment transactions HTCLs nor by counterparty ones. Unless we haven't already seen
1783 /// counterparty commitment transaction's secret, they are de facto pruned (we can use revocation key).
1784 fn provide_secret(&mut self, idx: u64, secret: [u8; 32]) -> Result<(), &'static str> {
1785 if let Err(()) = self.commitment_secrets.provide_secret(idx, secret) {
1786 return Err("Previous secret did not match new one");
1789 // Prune HTLCs from the previous counterparty commitment tx so we don't generate failure/fulfill
1790 // events for now-revoked/fulfilled HTLCs.
1791 if let Some(txid) = self.prev_counterparty_commitment_txid.take() {
1792 for &mut (_, ref mut source) in self.counterparty_claimable_outpoints.get_mut(&txid).unwrap() {
1797 if !self.payment_preimages.is_empty() {
1798 let cur_holder_signed_commitment_tx = &self.current_holder_commitment_tx;
1799 let prev_holder_signed_commitment_tx = self.prev_holder_signed_commitment_tx.as_ref();
1800 let min_idx = self.get_min_seen_secret();
1801 let counterparty_hash_commitment_number = &mut self.counterparty_hash_commitment_number;
1803 self.payment_preimages.retain(|&k, _| {
1804 for &(ref htlc, _, _) in cur_holder_signed_commitment_tx.htlc_outputs.iter() {
1805 if k == htlc.payment_hash {
1809 if let Some(prev_holder_commitment_tx) = prev_holder_signed_commitment_tx {
1810 for &(ref htlc, _, _) in prev_holder_commitment_tx.htlc_outputs.iter() {
1811 if k == htlc.payment_hash {
1816 let contains = if let Some(cn) = counterparty_hash_commitment_number.get(&k) {
1823 counterparty_hash_commitment_number.remove(&k);
1832 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 {
1833 // TODO: Encrypt the htlc_outputs data with the single-hash of the commitment transaction
1834 // so that a remote monitor doesn't learn anything unless there is a malicious close.
1835 // (only maybe, sadly we cant do the same for local info, as we need to be aware of
1837 for &(ref htlc, _) in &htlc_outputs {
1838 self.counterparty_hash_commitment_number.insert(htlc.payment_hash, commitment_number);
1841 log_trace!(logger, "Tracking new counterparty commitment transaction with txid {} at commitment number {} with {} HTLC outputs", txid, commitment_number, htlc_outputs.len());
1842 self.prev_counterparty_commitment_txid = self.current_counterparty_commitment_txid.take();
1843 self.current_counterparty_commitment_txid = Some(txid);
1844 self.counterparty_claimable_outpoints.insert(txid, htlc_outputs.clone());
1845 self.current_counterparty_commitment_number = commitment_number;
1846 //TODO: Merge this into the other per-counterparty-transaction output storage stuff
1847 match self.their_cur_per_commitment_points {
1848 Some(old_points) => {
1849 if old_points.0 == commitment_number + 1 {
1850 self.their_cur_per_commitment_points = Some((old_points.0, old_points.1, Some(their_per_commitment_point)));
1851 } else if old_points.0 == commitment_number + 2 {
1852 if let Some(old_second_point) = old_points.2 {
1853 self.their_cur_per_commitment_points = Some((old_points.0 - 1, old_second_point, Some(their_per_commitment_point)));
1855 self.their_cur_per_commitment_points = Some((commitment_number, their_per_commitment_point, None));
1858 self.their_cur_per_commitment_points = Some((commitment_number, their_per_commitment_point, None));
1862 self.their_cur_per_commitment_points = Some((commitment_number, their_per_commitment_point, None));
1865 let mut htlcs = Vec::with_capacity(htlc_outputs.len());
1866 for htlc in htlc_outputs {
1867 if htlc.0.transaction_output_index.is_some() {
1873 /// Informs this monitor of the latest holder (ie broadcastable) commitment transaction. The
1874 /// monitor watches for timeouts and may broadcast it if we approach such a timeout. Thus, it
1875 /// is important that any clones of this channel monitor (including remote clones) by kept
1876 /// up-to-date as our holder commitment transaction is updated.
1877 /// Panics if set_on_holder_tx_csv has never been called.
1878 fn provide_latest_holder_commitment_tx(&mut self, holder_commitment_tx: HolderCommitmentTransaction, htlc_outputs: Vec<(HTLCOutputInCommitment, Option<Signature>, Option<HTLCSource>)>) -> Result<(), &'static str> {
1879 // block for Rust 1.34 compat
1880 let mut new_holder_commitment_tx = {
1881 let trusted_tx = holder_commitment_tx.trust();
1882 let txid = trusted_tx.txid();
1883 let tx_keys = trusted_tx.keys();
1884 self.current_holder_commitment_number = trusted_tx.commitment_number();
1887 revocation_key: tx_keys.revocation_key,
1888 a_htlc_key: tx_keys.broadcaster_htlc_key,
1889 b_htlc_key: tx_keys.countersignatory_htlc_key,
1890 delayed_payment_key: tx_keys.broadcaster_delayed_payment_key,
1891 per_commitment_point: tx_keys.per_commitment_point,
1893 to_self_value_sat: holder_commitment_tx.to_broadcaster_value_sat(),
1894 feerate_per_kw: trusted_tx.feerate_per_kw(),
1897 self.onchain_tx_handler.provide_latest_holder_tx(holder_commitment_tx);
1898 mem::swap(&mut new_holder_commitment_tx, &mut self.current_holder_commitment_tx);
1899 self.prev_holder_signed_commitment_tx = Some(new_holder_commitment_tx);
1900 if self.holder_tx_signed {
1901 return Err("Latest holder commitment signed has already been signed, update is rejected");
1906 /// Provides a payment_hash->payment_preimage mapping. Will be automatically pruned when all
1907 /// commitment_tx_infos which contain the payment hash have been revoked.
1908 fn provide_payment_preimage<B: Deref, F: Deref, L: Deref>(
1909 &mut self, payment_hash: &PaymentHash, payment_preimage: &PaymentPreimage, broadcaster: &B,
1910 fee_estimator: &LowerBoundedFeeEstimator<F>, logger: &L)
1911 where B::Target: BroadcasterInterface,
1912 F::Target: FeeEstimator,
1915 self.payment_preimages.insert(payment_hash.clone(), payment_preimage.clone());
1917 // If the channel is force closed, try to claim the output from this preimage.
1918 // First check if a counterparty commitment transaction has been broadcasted:
1919 macro_rules! claim_htlcs {
1920 ($commitment_number: expr, $txid: expr) => {
1921 let htlc_claim_reqs = self.get_counterparty_htlc_output_claim_reqs($commitment_number, $txid, None);
1922 self.onchain_tx_handler.update_claims_view(&Vec::new(), htlc_claim_reqs, self.best_block.height(), self.best_block.height(), broadcaster, fee_estimator, logger);
1925 if let Some(txid) = self.current_counterparty_commitment_txid {
1926 if let Some(commitment_number) = self.counterparty_commitment_txn_on_chain.get(&txid) {
1927 claim_htlcs!(*commitment_number, txid);
1931 if let Some(txid) = self.prev_counterparty_commitment_txid {
1932 if let Some(commitment_number) = self.counterparty_commitment_txn_on_chain.get(&txid) {
1933 claim_htlcs!(*commitment_number, txid);
1938 // Then if a holder commitment transaction has been seen on-chain, broadcast transactions
1939 // claiming the HTLC output from each of the holder commitment transactions.
1940 // Note that we can't just use `self.holder_tx_signed`, because that only covers the case where
1941 // *we* sign a holder commitment transaction, not when e.g. a watchtower broadcasts one of our
1942 // holder commitment transactions.
1943 if self.broadcasted_holder_revokable_script.is_some() {
1944 // Assume that the broadcasted commitment transaction confirmed in the current best
1945 // block. Even if not, its a reasonable metric for the bump criteria on the HTLC
1947 let (claim_reqs, _) = self.get_broadcasted_holder_claims(&self.current_holder_commitment_tx, self.best_block.height());
1948 self.onchain_tx_handler.update_claims_view(&Vec::new(), claim_reqs, self.best_block.height(), self.best_block.height(), broadcaster, fee_estimator, logger);
1949 if let Some(ref tx) = self.prev_holder_signed_commitment_tx {
1950 let (claim_reqs, _) = self.get_broadcasted_holder_claims(&tx, self.best_block.height());
1951 self.onchain_tx_handler.update_claims_view(&Vec::new(), claim_reqs, self.best_block.height(), self.best_block.height(), broadcaster, fee_estimator, logger);
1956 pub(crate) fn broadcast_latest_holder_commitment_txn<B: Deref, L: Deref>(&mut self, broadcaster: &B, logger: &L)
1957 where B::Target: BroadcasterInterface,
1960 for tx in self.get_latest_holder_commitment_txn(logger).iter() {
1961 log_info!(logger, "Broadcasting local {}", log_tx!(tx));
1962 broadcaster.broadcast_transaction(tx);
1964 self.pending_monitor_events.push(MonitorEvent::CommitmentTxConfirmed(self.funding_info.0));
1967 pub fn update_monitor<B: Deref, F: Deref, L: Deref>(&mut self, updates: &ChannelMonitorUpdate, broadcaster: &B, fee_estimator: F, logger: &L) -> Result<(), ()>
1968 where B::Target: BroadcasterInterface,
1969 F::Target: FeeEstimator,
1972 log_info!(logger, "Applying update to monitor {}, bringing update_id from {} to {} with {} changes.",
1973 log_funding_info!(self), self.latest_update_id, updates.update_id, updates.updates.len());
1974 // ChannelMonitor updates may be applied after force close if we receive a
1975 // preimage for a broadcasted commitment transaction HTLC output that we'd
1976 // like to claim on-chain. If this is the case, we no longer have guaranteed
1977 // access to the monitor's update ID, so we use a sentinel value instead.
1978 if updates.update_id == CLOSED_CHANNEL_UPDATE_ID {
1979 assert_eq!(updates.updates.len(), 1);
1980 match updates.updates[0] {
1981 ChannelMonitorUpdateStep::PaymentPreimage { .. } => {},
1983 log_error!(logger, "Attempted to apply post-force-close ChannelMonitorUpdate of type {}", updates.updates[0].variant_name());
1984 panic!("Attempted to apply post-force-close ChannelMonitorUpdate that wasn't providing a payment preimage");
1987 } else if self.latest_update_id + 1 != updates.update_id {
1988 panic!("Attempted to apply ChannelMonitorUpdates out of order, check the update_id before passing an update to update_monitor!");
1990 let mut ret = Ok(());
1991 for update in updates.updates.iter() {
1993 ChannelMonitorUpdateStep::LatestHolderCommitmentTXInfo { commitment_tx, htlc_outputs } => {
1994 log_trace!(logger, "Updating ChannelMonitor with latest holder commitment transaction info");
1995 if self.lockdown_from_offchain { panic!(); }
1996 if let Err(e) = self.provide_latest_holder_commitment_tx(commitment_tx.clone(), htlc_outputs.clone()) {
1997 log_error!(logger, "Providing latest holder commitment transaction failed/was refused:");
1998 log_error!(logger, " {}", e);
2002 ChannelMonitorUpdateStep::LatestCounterpartyCommitmentTXInfo { commitment_txid, htlc_outputs, commitment_number, their_per_commitment_point } => {
2003 log_trace!(logger, "Updating ChannelMonitor with latest counterparty commitment transaction info");
2004 self.provide_latest_counterparty_commitment_tx(*commitment_txid, htlc_outputs.clone(), *commitment_number, *their_per_commitment_point, logger)
2006 ChannelMonitorUpdateStep::PaymentPreimage { payment_preimage } => {
2007 log_trace!(logger, "Updating ChannelMonitor with payment preimage");
2008 let bounded_fee_estimator = LowerBoundedFeeEstimator::new(&*fee_estimator);
2009 self.provide_payment_preimage(&PaymentHash(Sha256::hash(&payment_preimage.0[..]).into_inner()), &payment_preimage, broadcaster, &bounded_fee_estimator, logger)
2011 ChannelMonitorUpdateStep::CommitmentSecret { idx, secret } => {
2012 log_trace!(logger, "Updating ChannelMonitor with commitment secret");
2013 if let Err(e) = self.provide_secret(*idx, *secret) {
2014 log_error!(logger, "Providing latest counterparty commitment secret failed/was refused:");
2015 log_error!(logger, " {}", e);
2019 ChannelMonitorUpdateStep::ChannelForceClosed { should_broadcast } => {
2020 log_trace!(logger, "Updating ChannelMonitor: channel force closed, should broadcast: {}", should_broadcast);
2021 self.lockdown_from_offchain = true;
2022 if *should_broadcast {
2023 self.broadcast_latest_holder_commitment_txn(broadcaster, logger);
2024 } else if !self.holder_tx_signed {
2025 log_error!(logger, "You have a toxic holder commitment transaction avaible in channel monitor, read comment in ChannelMonitor::get_latest_holder_commitment_txn to be informed of manual action to take");
2027 // If we generated a MonitorEvent::CommitmentTxConfirmed, the ChannelManager
2028 // will still give us a ChannelForceClosed event with !should_broadcast, but we
2029 // shouldn't print the scary warning above.
2030 log_info!(logger, "Channel off-chain state closed after we broadcasted our latest commitment transaction.");
2033 ChannelMonitorUpdateStep::ShutdownScript { scriptpubkey } => {
2034 log_trace!(logger, "Updating ChannelMonitor with shutdown script");
2035 if let Some(shutdown_script) = self.shutdown_script.replace(scriptpubkey.clone()) {
2036 panic!("Attempted to replace shutdown script {} with {}", shutdown_script, scriptpubkey);
2041 self.latest_update_id = updates.update_id;
2043 if ret.is_ok() && self.funding_spend_seen {
2044 log_error!(logger, "Refusing Channel Monitor Update as counterparty attempted to update commitment after funding was spent");
2049 pub fn get_latest_update_id(&self) -> u64 {
2050 self.latest_update_id
2053 pub fn get_funding_txo(&self) -> &(OutPoint, Script) {
2057 pub fn get_outputs_to_watch(&self) -> &HashMap<Txid, Vec<(u32, Script)>> {
2058 // If we've detected a counterparty commitment tx on chain, we must include it in the set
2059 // of outputs to watch for spends of, otherwise we're likely to lose user funds. Because
2060 // its trivial to do, double-check that here.
2061 for (txid, _) in self.counterparty_commitment_txn_on_chain.iter() {
2062 self.outputs_to_watch.get(txid).expect("Counterparty commitment txn which have been broadcast should have outputs registered");
2064 &self.outputs_to_watch
2067 pub fn get_and_clear_pending_monitor_events(&mut self) -> Vec<MonitorEvent> {
2068 let mut ret = Vec::new();
2069 mem::swap(&mut ret, &mut self.pending_monitor_events);
2073 pub fn get_and_clear_pending_events(&mut self) -> Vec<Event> {
2074 let mut ret = Vec::new();
2075 mem::swap(&mut ret, &mut self.pending_events);
2079 /// Can only fail if idx is < get_min_seen_secret
2080 fn get_secret(&self, idx: u64) -> Option<[u8; 32]> {
2081 self.commitment_secrets.get_secret(idx)
2084 pub(crate) fn get_min_seen_secret(&self) -> u64 {
2085 self.commitment_secrets.get_min_seen_secret()
2088 pub(crate) fn get_cur_counterparty_commitment_number(&self) -> u64 {
2089 self.current_counterparty_commitment_number
2092 pub(crate) fn get_cur_holder_commitment_number(&self) -> u64 {
2093 self.current_holder_commitment_number
2096 /// Attempts to claim a counterparty commitment transaction's outputs using the revocation key and
2097 /// data in counterparty_claimable_outpoints. Will directly claim any HTLC outputs which expire at a
2098 /// height > height + CLTV_SHARED_CLAIM_BUFFER. In any case, will install monitoring for
2099 /// HTLC-Success/HTLC-Timeout transactions.
2100 /// Return updates for HTLC pending in the channel and failed automatically by the broadcast of
2101 /// revoked counterparty commitment tx
2102 fn check_spend_counterparty_transaction<L: Deref>(&mut self, tx: &Transaction, height: u32, logger: &L) -> (Vec<PackageTemplate>, TransactionOutputs) where L::Target: Logger {
2103 // Most secp and related errors trying to create keys means we have no hope of constructing
2104 // a spend transaction...so we return no transactions to broadcast
2105 let mut claimable_outpoints = Vec::new();
2106 let mut watch_outputs = Vec::new();
2108 let commitment_txid = tx.txid(); //TODO: This is gonna be a performance bottleneck for watchtowers!
2109 let per_commitment_option = self.counterparty_claimable_outpoints.get(&commitment_txid);
2111 macro_rules! ignore_error {
2112 ( $thing : expr ) => {
2115 Err(_) => return (claimable_outpoints, (commitment_txid, watch_outputs))
2120 let commitment_number = 0xffffffffffff - ((((tx.input[0].sequence as u64 & 0xffffff) << 3*8) | (tx.lock_time as u64 & 0xffffff)) ^ self.commitment_transaction_number_obscure_factor);
2121 if commitment_number >= self.get_min_seen_secret() {
2122 let secret = self.get_secret(commitment_number).unwrap();
2123 let per_commitment_key = ignore_error!(SecretKey::from_slice(&secret));
2124 let per_commitment_point = PublicKey::from_secret_key(&self.secp_ctx, &per_commitment_key);
2125 let revocation_pubkey = ignore_error!(chan_utils::derive_public_revocation_key(&self.secp_ctx, &per_commitment_point, &self.holder_revocation_basepoint));
2126 let delayed_key = ignore_error!(chan_utils::derive_public_key(&self.secp_ctx, &PublicKey::from_secret_key(&self.secp_ctx, &per_commitment_key), &self.counterparty_commitment_params.counterparty_delayed_payment_base_key));
2128 let revokeable_redeemscript = chan_utils::get_revokeable_redeemscript(&revocation_pubkey, self.counterparty_commitment_params.on_counterparty_tx_csv, &delayed_key);
2129 let revokeable_p2wsh = revokeable_redeemscript.to_v0_p2wsh();
2131 // First, process non-htlc outputs (to_holder & to_counterparty)
2132 for (idx, outp) in tx.output.iter().enumerate() {
2133 if outp.script_pubkey == revokeable_p2wsh {
2134 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);
2135 let justice_package = PackageTemplate::build_package(commitment_txid, idx as u32, PackageSolvingData::RevokedOutput(revk_outp), height + self.counterparty_commitment_params.on_counterparty_tx_csv as u32, true, height);
2136 claimable_outpoints.push(justice_package);
2140 // Then, try to find revoked htlc outputs
2141 if let Some(ref per_commitment_data) = per_commitment_option {
2142 for (_, &(ref htlc, _)) in per_commitment_data.iter().enumerate() {
2143 if let Some(transaction_output_index) = htlc.transaction_output_index {
2144 if transaction_output_index as usize >= tx.output.len() ||
2145 tx.output[transaction_output_index as usize].value != htlc.amount_msat / 1000 {
2146 return (claimable_outpoints, (commitment_txid, watch_outputs)); // Corrupted per_commitment_data, fuck this user
2148 let revk_htlc_outp = RevokedHTLCOutput::build(per_commitment_point, self.counterparty_commitment_params.counterparty_delayed_payment_base_key, self.counterparty_commitment_params.counterparty_htlc_base_key, per_commitment_key, htlc.amount_msat / 1000, htlc.clone(), self.onchain_tx_handler.channel_transaction_parameters.opt_anchors.is_some());
2149 let justice_package = PackageTemplate::build_package(commitment_txid, transaction_output_index, PackageSolvingData::RevokedHTLCOutput(revk_htlc_outp), htlc.cltv_expiry, true, height);
2150 claimable_outpoints.push(justice_package);
2155 // Last, track onchain revoked commitment transaction and fail backward outgoing HTLCs as payment path is broken
2156 if !claimable_outpoints.is_empty() || per_commitment_option.is_some() { // ie we're confident this is actually ours
2157 // We're definitely a counterparty commitment transaction!
2158 log_error!(logger, "Got broadcast of revoked counterparty commitment transaction, going to generate general spend tx with {} inputs", claimable_outpoints.len());
2159 for (idx, outp) in tx.output.iter().enumerate() {
2160 watch_outputs.push((idx as u32, outp.clone()));
2162 self.counterparty_commitment_txn_on_chain.insert(commitment_txid, commitment_number);
2164 if let Some(per_commitment_data) = per_commitment_option {
2165 fail_unbroadcast_htlcs!(self, "revoked_counterparty", commitment_txid, height,
2166 per_commitment_data.iter().map(|(htlc, htlc_source)|
2167 (htlc, htlc_source.as_ref().map(|htlc_source| htlc_source.as_ref()))
2170 debug_assert!(false, "We should have per-commitment option for any recognized old commitment txn");
2171 fail_unbroadcast_htlcs!(self, "revoked counterparty", commitment_txid, height,
2172 [].iter().map(|reference| *reference), logger);
2175 } else if let Some(per_commitment_data) = per_commitment_option {
2176 // While this isn't useful yet, there is a potential race where if a counterparty
2177 // revokes a state at the same time as the commitment transaction for that state is
2178 // confirmed, and the watchtower receives the block before the user, the user could
2179 // upload a new ChannelMonitor with the revocation secret but the watchtower has
2180 // already processed the block, resulting in the counterparty_commitment_txn_on_chain entry
2181 // not being generated by the above conditional. Thus, to be safe, we go ahead and
2183 for (idx, outp) in tx.output.iter().enumerate() {
2184 watch_outputs.push((idx as u32, outp.clone()));
2186 self.counterparty_commitment_txn_on_chain.insert(commitment_txid, commitment_number);
2188 log_info!(logger, "Got broadcast of non-revoked counterparty commitment transaction {}", commitment_txid);
2189 fail_unbroadcast_htlcs!(self, "counterparty", commitment_txid, height,
2190 per_commitment_data.iter().map(|(htlc, htlc_source)|
2191 (htlc, htlc_source.as_ref().map(|htlc_source| htlc_source.as_ref()))
2194 let htlc_claim_reqs = self.get_counterparty_htlc_output_claim_reqs(commitment_number, commitment_txid, Some(tx));
2195 for req in htlc_claim_reqs {
2196 claimable_outpoints.push(req);
2200 (claimable_outpoints, (commitment_txid, watch_outputs))
2203 fn get_counterparty_htlc_output_claim_reqs(&self, commitment_number: u64, commitment_txid: Txid, tx: Option<&Transaction>) -> Vec<PackageTemplate> {
2204 let mut claimable_outpoints = Vec::new();
2205 if let Some(htlc_outputs) = self.counterparty_claimable_outpoints.get(&commitment_txid) {
2206 if let Some(per_commitment_points) = self.their_cur_per_commitment_points {
2207 let per_commitment_point_option =
2208 // If the counterparty commitment tx is the latest valid state, use their latest
2209 // per-commitment point
2210 if per_commitment_points.0 == commitment_number { Some(&per_commitment_points.1) }
2211 else if let Some(point) = per_commitment_points.2.as_ref() {
2212 // If counterparty commitment tx is the state previous to the latest valid state, use
2213 // their previous per-commitment point (non-atomicity of revocation means it's valid for
2214 // them to temporarily have two valid commitment txns from our viewpoint)
2215 if per_commitment_points.0 == commitment_number + 1 { Some(point) } else { None }
2217 if let Some(per_commitment_point) = per_commitment_point_option {
2218 for (_, &(ref htlc, _)) in htlc_outputs.iter().enumerate() {
2219 if let Some(transaction_output_index) = htlc.transaction_output_index {
2220 if let Some(transaction) = tx {
2221 if transaction_output_index as usize >= transaction.output.len() ||
2222 transaction.output[transaction_output_index as usize].value != htlc.amount_msat / 1000 {
2223 return claimable_outpoints; // Corrupted per_commitment_data, fuck this user
2226 let preimage = if htlc.offered { if let Some(p) = self.payment_preimages.get(&htlc.payment_hash) { Some(*p) } else { None } } else { None };
2227 if preimage.is_some() || !htlc.offered {
2228 let counterparty_htlc_outp = if htlc.offered {
2229 PackageSolvingData::CounterpartyOfferedHTLCOutput(
2230 CounterpartyOfferedHTLCOutput::build(*per_commitment_point,
2231 self.counterparty_commitment_params.counterparty_delayed_payment_base_key,
2232 self.counterparty_commitment_params.counterparty_htlc_base_key,
2233 preimage.unwrap(), htlc.clone()))
2235 PackageSolvingData::CounterpartyReceivedHTLCOutput(
2236 CounterpartyReceivedHTLCOutput::build(*per_commitment_point,
2237 self.counterparty_commitment_params.counterparty_delayed_payment_base_key,
2238 self.counterparty_commitment_params.counterparty_htlc_base_key,
2241 let aggregation = if !htlc.offered { false } else { true };
2242 let counterparty_package = PackageTemplate::build_package(commitment_txid, transaction_output_index, counterparty_htlc_outp, htlc.cltv_expiry,aggregation, 0);
2243 claimable_outpoints.push(counterparty_package);
2253 /// Attempts to claim a counterparty HTLC-Success/HTLC-Timeout's outputs using the revocation key
2254 fn check_spend_counterparty_htlc<L: Deref>(&mut self, tx: &Transaction, commitment_number: u64, height: u32, logger: &L) -> (Vec<PackageTemplate>, Option<TransactionOutputs>) where L::Target: Logger {
2255 let htlc_txid = tx.txid();
2256 if tx.input.len() != 1 || tx.output.len() != 1 || tx.input[0].witness.len() != 5 {
2257 return (Vec::new(), None)
2260 macro_rules! ignore_error {
2261 ( $thing : expr ) => {
2264 Err(_) => return (Vec::new(), None)
2269 let secret = if let Some(secret) = self.get_secret(commitment_number) { secret } else { return (Vec::new(), None); };
2270 let per_commitment_key = ignore_error!(SecretKey::from_slice(&secret));
2271 let per_commitment_point = PublicKey::from_secret_key(&self.secp_ctx, &per_commitment_key);
2273 log_error!(logger, "Got broadcast of revoked counterparty HTLC transaction, spending {}:{}", htlc_txid, 0);
2274 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, tx.output[0].value, self.counterparty_commitment_params.on_counterparty_tx_csv);
2275 let justice_package = PackageTemplate::build_package(htlc_txid, 0, PackageSolvingData::RevokedOutput(revk_outp), height + self.counterparty_commitment_params.on_counterparty_tx_csv as u32, true, height);
2276 let claimable_outpoints = vec!(justice_package);
2277 let outputs = vec![(0, tx.output[0].clone())];
2278 (claimable_outpoints, Some((htlc_txid, outputs)))
2281 // Returns (1) `PackageTemplate`s that can be given to the OnChainTxHandler, so that the handler can
2282 // broadcast transactions claiming holder HTLC commitment outputs and (2) a holder revokable
2283 // script so we can detect whether a holder transaction has been seen on-chain.
2284 fn get_broadcasted_holder_claims(&self, holder_tx: &HolderSignedTx, conf_height: u32) -> (Vec<PackageTemplate>, Option<(Script, PublicKey, PublicKey)>) {
2285 let mut claim_requests = Vec::with_capacity(holder_tx.htlc_outputs.len());
2287 let redeemscript = chan_utils::get_revokeable_redeemscript(&holder_tx.revocation_key, self.on_holder_tx_csv, &holder_tx.delayed_payment_key);
2288 let broadcasted_holder_revokable_script = Some((redeemscript.to_v0_p2wsh(), holder_tx.per_commitment_point.clone(), holder_tx.revocation_key.clone()));
2290 for &(ref htlc, _, _) in holder_tx.htlc_outputs.iter() {
2291 if let Some(transaction_output_index) = htlc.transaction_output_index {
2292 let htlc_output = if htlc.offered {
2293 HolderHTLCOutput::build_offered(htlc.amount_msat, htlc.cltv_expiry)
2295 let payment_preimage = if let Some(preimage) = self.payment_preimages.get(&htlc.payment_hash) {
2298 // We can't build an HTLC-Success transaction without the preimage
2301 HolderHTLCOutput::build_accepted(payment_preimage, htlc.amount_msat)
2303 let htlc_package = PackageTemplate::build_package(holder_tx.txid, transaction_output_index, PackageSolvingData::HolderHTLCOutput(htlc_output), htlc.cltv_expiry, false, conf_height);
2304 claim_requests.push(htlc_package);
2308 (claim_requests, broadcasted_holder_revokable_script)
2311 // Returns holder HTLC outputs to watch and react to in case of spending.
2312 fn get_broadcasted_holder_watch_outputs(&self, holder_tx: &HolderSignedTx, commitment_tx: &Transaction) -> Vec<(u32, TxOut)> {
2313 let mut watch_outputs = Vec::with_capacity(holder_tx.htlc_outputs.len());
2314 for &(ref htlc, _, _) in holder_tx.htlc_outputs.iter() {
2315 if let Some(transaction_output_index) = htlc.transaction_output_index {
2316 watch_outputs.push((transaction_output_index, commitment_tx.output[transaction_output_index as usize].clone()));
2322 /// Attempts to claim any claimable HTLCs in a commitment transaction which was not (yet)
2323 /// revoked using data in holder_claimable_outpoints.
2324 /// Should not be used if check_spend_revoked_transaction succeeds.
2325 /// Returns None unless the transaction is definitely one of our commitment transactions.
2326 fn check_spend_holder_transaction<L: Deref>(&mut self, tx: &Transaction, height: u32, logger: &L) -> Option<(Vec<PackageTemplate>, TransactionOutputs)> where L::Target: Logger {
2327 let commitment_txid = tx.txid();
2328 let mut claim_requests = Vec::new();
2329 let mut watch_outputs = Vec::new();
2331 macro_rules! append_onchain_update {
2332 ($updates: expr, $to_watch: expr) => {
2333 claim_requests = $updates.0;
2334 self.broadcasted_holder_revokable_script = $updates.1;
2335 watch_outputs.append(&mut $to_watch);
2339 // HTLCs set may differ between last and previous holder commitment txn, in case of one them hitting chain, ensure we cancel all HTLCs backward
2340 let mut is_holder_tx = false;
2342 if self.current_holder_commitment_tx.txid == commitment_txid {
2343 is_holder_tx = true;
2344 log_info!(logger, "Got broadcast of latest holder commitment tx {}, searching for available HTLCs to claim", commitment_txid);
2345 let res = self.get_broadcasted_holder_claims(&self.current_holder_commitment_tx, height);
2346 let mut to_watch = self.get_broadcasted_holder_watch_outputs(&self.current_holder_commitment_tx, tx);
2347 append_onchain_update!(res, to_watch);
2348 fail_unbroadcast_htlcs!(self, "latest holder", commitment_txid, height,
2349 self.current_holder_commitment_tx.htlc_outputs.iter()
2350 .map(|(htlc, _, htlc_source)| (htlc, htlc_source.as_ref())), logger);
2351 } else if let &Some(ref holder_tx) = &self.prev_holder_signed_commitment_tx {
2352 if holder_tx.txid == commitment_txid {
2353 is_holder_tx = true;
2354 log_info!(logger, "Got broadcast of previous holder commitment tx {}, searching for available HTLCs to claim", commitment_txid);
2355 let res = self.get_broadcasted_holder_claims(holder_tx, height);
2356 let mut to_watch = self.get_broadcasted_holder_watch_outputs(holder_tx, tx);
2357 append_onchain_update!(res, to_watch);
2358 fail_unbroadcast_htlcs!(self, "previous holder", commitment_txid, height,
2359 holder_tx.htlc_outputs.iter().map(|(htlc, _, htlc_source)| (htlc, htlc_source.as_ref())),
2365 Some((claim_requests, (commitment_txid, watch_outputs)))
2371 pub fn get_latest_holder_commitment_txn<L: Deref>(&mut self, logger: &L) -> Vec<Transaction> where L::Target: Logger {
2372 log_debug!(logger, "Getting signed latest holder commitment transaction!");
2373 self.holder_tx_signed = true;
2374 let commitment_tx = self.onchain_tx_handler.get_fully_signed_holder_tx(&self.funding_redeemscript);
2375 let txid = commitment_tx.txid();
2376 let mut holder_transactions = vec![commitment_tx];
2377 for htlc in self.current_holder_commitment_tx.htlc_outputs.iter() {
2378 if let Some(vout) = htlc.0.transaction_output_index {
2379 let preimage = if !htlc.0.offered {
2380 if let Some(preimage) = self.payment_preimages.get(&htlc.0.payment_hash) { Some(preimage.clone()) } else {
2381 // We can't build an HTLC-Success transaction without the preimage
2384 } else if htlc.0.cltv_expiry > self.best_block.height() + 1 {
2385 // Don't broadcast HTLC-Timeout transactions immediately as they don't meet the
2386 // current locktime requirements on-chain. We will broadcast them in
2387 // `block_confirmed` when `should_broadcast_holder_commitment_txn` returns true.
2388 // Note that we add + 1 as transactions are broadcastable when they can be
2389 // confirmed in the next block.
2392 if let Some(htlc_tx) = self.onchain_tx_handler.get_fully_signed_htlc_tx(
2393 &::bitcoin::OutPoint { txid, vout }, &preimage) {
2394 holder_transactions.push(htlc_tx);
2398 // 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.
2399 // The data will be re-generated and tracked in check_spend_holder_transaction if we get a confirmation.
2403 #[cfg(any(test,feature = "unsafe_revoked_tx_signing"))]
2404 /// Note that this includes possibly-locktimed-in-the-future transactions!
2405 fn unsafe_get_latest_holder_commitment_txn<L: Deref>(&mut self, logger: &L) -> Vec<Transaction> where L::Target: Logger {
2406 log_debug!(logger, "Getting signed copy of latest holder commitment transaction!");
2407 let commitment_tx = self.onchain_tx_handler.get_fully_signed_copy_holder_tx(&self.funding_redeemscript);
2408 let txid = commitment_tx.txid();
2409 let mut holder_transactions = vec![commitment_tx];
2410 for htlc in self.current_holder_commitment_tx.htlc_outputs.iter() {
2411 if let Some(vout) = htlc.0.transaction_output_index {
2412 let preimage = if !htlc.0.offered {
2413 if let Some(preimage) = self.payment_preimages.get(&htlc.0.payment_hash) { Some(preimage.clone()) } else {
2414 // We can't build an HTLC-Success transaction without the preimage
2418 if let Some(htlc_tx) = self.onchain_tx_handler.unsafe_get_fully_signed_htlc_tx(
2419 &::bitcoin::OutPoint { txid, vout }, &preimage) {
2420 holder_transactions.push(htlc_tx);
2427 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>
2428 where B::Target: BroadcasterInterface,
2429 F::Target: FeeEstimator,
2432 let block_hash = header.block_hash();
2433 self.best_block = BestBlock::new(block_hash, height);
2435 let bounded_fee_estimator = LowerBoundedFeeEstimator::new(fee_estimator);
2436 self.transactions_confirmed(header, txdata, height, broadcaster, &bounded_fee_estimator, logger)
2439 fn best_block_updated<B: Deref, F: Deref, L: Deref>(
2441 header: &BlockHeader,
2444 fee_estimator: &LowerBoundedFeeEstimator<F>,
2446 ) -> Vec<TransactionOutputs>
2448 B::Target: BroadcasterInterface,
2449 F::Target: FeeEstimator,
2452 let block_hash = header.block_hash();
2454 if height > self.best_block.height() {
2455 self.best_block = BestBlock::new(block_hash, height);
2456 self.block_confirmed(height, vec![], vec![], vec![], &broadcaster, &fee_estimator, &logger)
2457 } else if block_hash != self.best_block.block_hash() {
2458 self.best_block = BestBlock::new(block_hash, height);
2459 self.onchain_events_awaiting_threshold_conf.retain(|ref entry| entry.height <= height);
2460 self.onchain_tx_handler.block_disconnected(height + 1, broadcaster, fee_estimator, logger);
2462 } else { Vec::new() }
2465 fn transactions_confirmed<B: Deref, F: Deref, L: Deref>(
2467 header: &BlockHeader,
2468 txdata: &TransactionData,
2471 fee_estimator: &LowerBoundedFeeEstimator<F>,
2473 ) -> Vec<TransactionOutputs>
2475 B::Target: BroadcasterInterface,
2476 F::Target: FeeEstimator,
2479 let txn_matched = self.filter_block(txdata);
2480 for tx in &txn_matched {
2481 let mut output_val = 0;
2482 for out in tx.output.iter() {
2483 if out.value > 21_000_000_0000_0000 { panic!("Value-overflowing transaction provided to block connected"); }
2484 output_val += out.value;
2485 if output_val > 21_000_000_0000_0000 { panic!("Value-overflowing transaction provided to block connected"); }
2489 let block_hash = header.block_hash();
2491 let mut watch_outputs = Vec::new();
2492 let mut claimable_outpoints = Vec::new();
2493 for tx in &txn_matched {
2494 if tx.input.len() == 1 {
2495 // Assuming our keys were not leaked (in which case we're screwed no matter what),
2496 // commitment transactions and HTLC transactions will all only ever have one input,
2497 // which is an easy way to filter out any potential non-matching txn for lazy
2499 let prevout = &tx.input[0].previous_output;
2500 if prevout.txid == self.funding_info.0.txid && prevout.vout == self.funding_info.0.index as u32 {
2501 let mut balance_spendable_csv = None;
2502 log_info!(logger, "Channel {} closed by funding output spend in txid {}.",
2503 log_bytes!(self.funding_info.0.to_channel_id()), tx.txid());
2504 self.funding_spend_seen = true;
2505 if (tx.input[0].sequence >> 8*3) as u8 == 0x80 && (tx.lock_time >> 8*3) as u8 == 0x20 {
2506 let (mut new_outpoints, new_outputs) = self.check_spend_counterparty_transaction(&tx, height, &logger);
2507 if !new_outputs.1.is_empty() {
2508 watch_outputs.push(new_outputs);
2510 claimable_outpoints.append(&mut new_outpoints);
2511 if new_outpoints.is_empty() {
2512 if let Some((mut new_outpoints, new_outputs)) = self.check_spend_holder_transaction(&tx, height, &logger) {
2513 if !new_outputs.1.is_empty() {
2514 watch_outputs.push(new_outputs);
2516 claimable_outpoints.append(&mut new_outpoints);
2517 balance_spendable_csv = Some(self.on_holder_tx_csv);
2521 let txid = tx.txid();
2522 self.onchain_events_awaiting_threshold_conf.push(OnchainEventEntry {
2525 event: OnchainEvent::FundingSpendConfirmation {
2526 on_local_output_csv: balance_spendable_csv,
2530 if let Some(&commitment_number) = self.counterparty_commitment_txn_on_chain.get(&prevout.txid) {
2531 let (mut new_outpoints, new_outputs_option) = self.check_spend_counterparty_htlc(&tx, commitment_number, height, &logger);
2532 claimable_outpoints.append(&mut new_outpoints);
2533 if let Some(new_outputs) = new_outputs_option {
2534 watch_outputs.push(new_outputs);
2539 // While all commitment/HTLC-Success/HTLC-Timeout transactions have one input, HTLCs
2540 // can also be resolved in a few other ways which can have more than one output. Thus,
2541 // we call is_resolving_htlc_output here outside of the tx.input.len() == 1 check.
2542 self.is_resolving_htlc_output(&tx, height, &logger);
2544 self.is_paying_spendable_output(&tx, height, &logger);
2547 if height > self.best_block.height() {
2548 self.best_block = BestBlock::new(block_hash, height);
2551 self.block_confirmed(height, txn_matched, watch_outputs, claimable_outpoints, &broadcaster, &fee_estimator, &logger)
2554 /// Update state for new block(s)/transaction(s) confirmed. Note that the caller must update
2555 /// `self.best_block` before calling if a new best blockchain tip is available. More
2556 /// concretely, `self.best_block` must never be at a lower height than `conf_height`, avoiding
2557 /// complexity especially in `OnchainTx::update_claims_view`.
2559 /// `conf_height` should be set to the height at which any new transaction(s)/block(s) were
2560 /// confirmed at, even if it is not the current best height.
2561 fn block_confirmed<B: Deref, F: Deref, L: Deref>(
2564 txn_matched: Vec<&Transaction>,
2565 mut watch_outputs: Vec<TransactionOutputs>,
2566 mut claimable_outpoints: Vec<PackageTemplate>,
2568 fee_estimator: &LowerBoundedFeeEstimator<F>,
2570 ) -> Vec<TransactionOutputs>
2572 B::Target: BroadcasterInterface,
2573 F::Target: FeeEstimator,
2576 log_trace!(logger, "Processing {} matched transactions for block at height {}.", txn_matched.len(), conf_height);
2577 debug_assert!(self.best_block.height() >= conf_height);
2579 let should_broadcast = self.should_broadcast_holder_commitment_txn(logger);
2580 if should_broadcast {
2581 let funding_outp = HolderFundingOutput::build(self.funding_redeemscript.clone());
2582 let commitment_package = PackageTemplate::build_package(self.funding_info.0.txid.clone(), self.funding_info.0.index as u32, PackageSolvingData::HolderFundingOutput(funding_outp), self.best_block.height(), false, self.best_block.height());
2583 claimable_outpoints.push(commitment_package);
2584 self.pending_monitor_events.push(MonitorEvent::CommitmentTxConfirmed(self.funding_info.0));
2585 let commitment_tx = self.onchain_tx_handler.get_fully_signed_holder_tx(&self.funding_redeemscript);
2586 self.holder_tx_signed = true;
2587 // Because we're broadcasting a commitment transaction, we should construct the package
2588 // assuming it gets confirmed in the next block. Sadly, we have code which considers
2589 // "not yet confirmed" things as discardable, so we cannot do that here.
2590 let (mut new_outpoints, _) = self.get_broadcasted_holder_claims(&self.current_holder_commitment_tx, self.best_block.height());
2591 let new_outputs = self.get_broadcasted_holder_watch_outputs(&self.current_holder_commitment_tx, &commitment_tx);
2592 if !new_outputs.is_empty() {
2593 watch_outputs.push((self.current_holder_commitment_tx.txid.clone(), new_outputs));
2595 claimable_outpoints.append(&mut new_outpoints);
2598 // Find which on-chain events have reached their confirmation threshold.
2599 let onchain_events_awaiting_threshold_conf =
2600 self.onchain_events_awaiting_threshold_conf.drain(..).collect::<Vec<_>>();
2601 let mut onchain_events_reaching_threshold_conf = Vec::new();
2602 for entry in onchain_events_awaiting_threshold_conf {
2603 if entry.has_reached_confirmation_threshold(&self.best_block) {
2604 onchain_events_reaching_threshold_conf.push(entry);
2606 self.onchain_events_awaiting_threshold_conf.push(entry);
2610 // Used to check for duplicate HTLC resolutions.
2611 #[cfg(debug_assertions)]
2612 let unmatured_htlcs: Vec<_> = self.onchain_events_awaiting_threshold_conf
2614 .filter_map(|entry| match &entry.event {
2615 OnchainEvent::HTLCUpdate { source, .. } => Some(source),
2619 #[cfg(debug_assertions)]
2620 let mut matured_htlcs = Vec::new();
2622 // Produce actionable events from on-chain events having reached their threshold.
2623 for entry in onchain_events_reaching_threshold_conf.drain(..) {
2625 OnchainEvent::HTLCUpdate { ref source, payment_hash, htlc_value_satoshis, commitment_tx_output_idx } => {
2626 // Check for duplicate HTLC resolutions.
2627 #[cfg(debug_assertions)]
2630 unmatured_htlcs.iter().find(|&htlc| htlc == &source).is_none(),
2631 "An unmature HTLC transaction conflicts with a maturing one; failed to \
2632 call either transaction_unconfirmed for the conflicting transaction \
2633 or block_disconnected for a block containing it.");
2635 matured_htlcs.iter().find(|&htlc| htlc == source).is_none(),
2636 "A matured HTLC transaction conflicts with a maturing one; failed to \
2637 call either transaction_unconfirmed for the conflicting transaction \
2638 or block_disconnected for a block containing it.");
2639 matured_htlcs.push(source.clone());
2642 log_debug!(logger, "HTLC {} failure update in {} has got enough confirmations to be passed upstream",
2643 log_bytes!(payment_hash.0), entry.txid);
2644 self.pending_monitor_events.push(MonitorEvent::HTLCEvent(HTLCUpdate {
2646 payment_preimage: None,
2647 source: source.clone(),
2648 htlc_value_satoshis,
2650 if let Some(idx) = commitment_tx_output_idx {
2651 self.htlcs_resolved_on_chain.push(IrrevocablyResolvedHTLC { commitment_tx_output_idx: idx, payment_preimage: None });
2654 OnchainEvent::MaturingOutput { descriptor } => {
2655 log_debug!(logger, "Descriptor {} has got enough confirmations to be passed upstream", log_spendable!(descriptor));
2656 self.pending_events.push(Event::SpendableOutputs {
2657 outputs: vec![descriptor]
2660 OnchainEvent::HTLCSpendConfirmation { commitment_tx_output_idx, preimage, .. } => {
2661 self.htlcs_resolved_on_chain.push(IrrevocablyResolvedHTLC { commitment_tx_output_idx, payment_preimage: preimage });
2663 OnchainEvent::FundingSpendConfirmation { .. } => {
2664 self.funding_spend_confirmed = Some(entry.txid);
2669 self.onchain_tx_handler.update_claims_view(&txn_matched, claimable_outpoints, conf_height, self.best_block.height(), broadcaster, fee_estimator, logger);
2671 // Determine new outputs to watch by comparing against previously known outputs to watch,
2672 // updating the latter in the process.
2673 watch_outputs.retain(|&(ref txid, ref txouts)| {
2674 let idx_and_scripts = txouts.iter().map(|o| (o.0, o.1.script_pubkey.clone())).collect();
2675 self.outputs_to_watch.insert(txid.clone(), idx_and_scripts).is_none()
2679 // If we see a transaction for which we registered outputs previously,
2680 // make sure the registered scriptpubkey at the expected index match
2681 // the actual transaction output one. We failed this case before #653.
2682 for tx in &txn_matched {
2683 if let Some(outputs) = self.get_outputs_to_watch().get(&tx.txid()) {
2684 for idx_and_script in outputs.iter() {
2685 assert!((idx_and_script.0 as usize) < tx.output.len());
2686 assert_eq!(tx.output[idx_and_script.0 as usize].script_pubkey, idx_and_script.1);
2694 pub fn block_disconnected<B: Deref, F: Deref, L: Deref>(&mut self, header: &BlockHeader, height: u32, broadcaster: B, fee_estimator: F, logger: L)
2695 where B::Target: BroadcasterInterface,
2696 F::Target: FeeEstimator,
2699 log_trace!(logger, "Block {} at height {} disconnected", header.block_hash(), height);
2702 //- htlc update there as failure-trigger tx (revoked commitment tx, non-revoked commitment tx, HTLC-timeout tx) has been disconnected
2703 //- maturing spendable output has transaction paying us has been disconnected
2704 self.onchain_events_awaiting_threshold_conf.retain(|ref entry| entry.height < height);
2706 let bounded_fee_estimator = LowerBoundedFeeEstimator::new(fee_estimator);
2707 self.onchain_tx_handler.block_disconnected(height, broadcaster, &bounded_fee_estimator, logger);
2709 self.best_block = BestBlock::new(header.prev_blockhash, height - 1);
2712 fn transaction_unconfirmed<B: Deref, F: Deref, L: Deref>(
2716 fee_estimator: &LowerBoundedFeeEstimator<F>,
2719 B::Target: BroadcasterInterface,
2720 F::Target: FeeEstimator,
2723 self.onchain_events_awaiting_threshold_conf.retain(|ref entry| if entry.txid == *txid {
2724 log_info!(logger, "Removing onchain event with txid {}", txid);
2727 self.onchain_tx_handler.transaction_unconfirmed(txid, broadcaster, fee_estimator, logger);
2730 /// Filters a block's `txdata` for transactions spending watched outputs or for any child
2731 /// transactions thereof.
2732 fn filter_block<'a>(&self, txdata: &TransactionData<'a>) -> Vec<&'a Transaction> {
2733 let mut matched_txn = HashSet::new();
2734 txdata.iter().filter(|&&(_, tx)| {
2735 let mut matches = self.spends_watched_output(tx);
2736 for input in tx.input.iter() {
2737 if matches { break; }
2738 if matched_txn.contains(&input.previous_output.txid) {
2743 matched_txn.insert(tx.txid());
2746 }).map(|(_, tx)| *tx).collect()
2749 /// Checks if a given transaction spends any watched outputs.
2750 fn spends_watched_output(&self, tx: &Transaction) -> bool {
2751 for input in tx.input.iter() {
2752 if let Some(outputs) = self.get_outputs_to_watch().get(&input.previous_output.txid) {
2753 for (idx, _script_pubkey) in outputs.iter() {
2754 if *idx == input.previous_output.vout {
2757 // If the expected script is a known type, check that the witness
2758 // appears to be spending the correct type (ie that the match would
2759 // actually succeed in BIP 158/159-style filters).
2760 if _script_pubkey.is_v0_p2wsh() {
2761 if input.witness.last().unwrap().to_vec() == deliberately_bogus_accepted_htlc_witness_program() {
2762 // In at least one test we use a deliberately bogus witness
2763 // script which hit an old panic. Thus, we check for that here
2764 // and avoid the assert if its the expected bogus script.
2768 assert_eq!(&bitcoin::Address::p2wsh(&Script::from(input.witness.last().unwrap().to_vec()), bitcoin::Network::Bitcoin).script_pubkey(), _script_pubkey);
2769 } else if _script_pubkey.is_v0_p2wpkh() {
2770 assert_eq!(&bitcoin::Address::p2wpkh(&bitcoin::PublicKey::from_slice(&input.witness.last().unwrap()).unwrap(), bitcoin::Network::Bitcoin).unwrap().script_pubkey(), _script_pubkey);
2771 } else { panic!(); }
2782 fn should_broadcast_holder_commitment_txn<L: Deref>(&self, logger: &L) -> bool where L::Target: Logger {
2783 // We need to consider all HTLCs which are:
2784 // * in any unrevoked counterparty commitment transaction, as they could broadcast said
2785 // transactions and we'd end up in a race, or
2786 // * are in our latest holder commitment transaction, as this is the thing we will
2787 // broadcast if we go on-chain.
2788 // Note that we consider HTLCs which were below dust threshold here - while they don't
2789 // strictly imply that we need to fail the channel, we need to go ahead and fail them back
2790 // to the source, and if we don't fail the channel we will have to ensure that the next
2791 // updates that peer sends us are update_fails, failing the channel if not. It's probably
2792 // easier to just fail the channel as this case should be rare enough anyway.
2793 let height = self.best_block.height();
2794 macro_rules! scan_commitment {
2795 ($htlcs: expr, $holder_tx: expr) => {
2796 for ref htlc in $htlcs {
2797 // For inbound HTLCs which we know the preimage for, we have to ensure we hit the
2798 // chain with enough room to claim the HTLC without our counterparty being able to
2799 // time out the HTLC first.
2800 // For outbound HTLCs which our counterparty hasn't failed/claimed, our primary
2801 // concern is being able to claim the corresponding inbound HTLC (on another
2802 // channel) before it expires. In fact, we don't even really care if our
2803 // counterparty here claims such an outbound HTLC after it expired as long as we
2804 // can still claim the corresponding HTLC. Thus, to avoid needlessly hitting the
2805 // chain when our counterparty is waiting for expiration to off-chain fail an HTLC
2806 // we give ourselves a few blocks of headroom after expiration before going
2807 // on-chain for an expired HTLC.
2808 // Note that, to avoid a potential attack whereby a node delays claiming an HTLC
2809 // from us until we've reached the point where we go on-chain with the
2810 // corresponding inbound HTLC, we must ensure that outbound HTLCs go on chain at
2811 // least CLTV_CLAIM_BUFFER blocks prior to the inbound HTLC.
2812 // aka outbound_cltv + LATENCY_GRACE_PERIOD_BLOCKS == height - CLTV_CLAIM_BUFFER
2813 // inbound_cltv == height + CLTV_CLAIM_BUFFER
2814 // outbound_cltv + LATENCY_GRACE_PERIOD_BLOCKS + CLTV_CLAIM_BUFFER <= inbound_cltv - CLTV_CLAIM_BUFFER
2815 // LATENCY_GRACE_PERIOD_BLOCKS + 2*CLTV_CLAIM_BUFFER <= inbound_cltv - outbound_cltv
2816 // CLTV_EXPIRY_DELTA <= inbound_cltv - outbound_cltv (by check in ChannelManager::decode_update_add_htlc_onion)
2817 // LATENCY_GRACE_PERIOD_BLOCKS + 2*CLTV_CLAIM_BUFFER <= CLTV_EXPIRY_DELTA
2818 // The final, above, condition is checked for statically in channelmanager
2819 // with CHECK_CLTV_EXPIRY_SANITY_2.
2820 let htlc_outbound = $holder_tx == htlc.offered;
2821 if ( htlc_outbound && htlc.cltv_expiry + LATENCY_GRACE_PERIOD_BLOCKS <= height) ||
2822 (!htlc_outbound && htlc.cltv_expiry <= height + CLTV_CLAIM_BUFFER && self.payment_preimages.contains_key(&htlc.payment_hash)) {
2823 log_info!(logger, "Force-closing channel due to {} HTLC timeout, HTLC expiry is {}", if htlc_outbound { "outbound" } else { "inbound "}, htlc.cltv_expiry);
2830 scan_commitment!(self.current_holder_commitment_tx.htlc_outputs.iter().map(|&(ref a, _, _)| a), true);
2832 if let Some(ref txid) = self.current_counterparty_commitment_txid {
2833 if let Some(ref htlc_outputs) = self.counterparty_claimable_outpoints.get(txid) {
2834 scan_commitment!(htlc_outputs.iter().map(|&(ref a, _)| a), false);
2837 if let Some(ref txid) = self.prev_counterparty_commitment_txid {
2838 if let Some(ref htlc_outputs) = self.counterparty_claimable_outpoints.get(txid) {
2839 scan_commitment!(htlc_outputs.iter().map(|&(ref a, _)| a), false);
2846 /// Check if any transaction broadcasted is resolving HTLC output by a success or timeout on a holder
2847 /// or counterparty commitment tx, if so send back the source, preimage if found and payment_hash of resolved HTLC
2848 fn is_resolving_htlc_output<L: Deref>(&mut self, tx: &Transaction, height: u32, logger: &L) where L::Target: Logger {
2849 'outer_loop: for input in &tx.input {
2850 let mut payment_data = None;
2851 let witness_items = input.witness.len();
2852 let htlctype = input.witness.last().map(|w| w.len()).and_then(HTLCType::scriptlen_to_htlctype);
2853 let prev_last_witness_len = input.witness.second_to_last().map(|w| w.len()).unwrap_or(0);
2854 let revocation_sig_claim = (witness_items == 3 && htlctype == Some(HTLCType::OfferedHTLC) && prev_last_witness_len == 33)
2855 || (witness_items == 3 && htlctype == Some(HTLCType::AcceptedHTLC) && prev_last_witness_len == 33);
2856 let accepted_preimage_claim = witness_items == 5 && htlctype == Some(HTLCType::AcceptedHTLC)
2857 && input.witness.second_to_last().unwrap().len() == 32;
2858 #[cfg(not(fuzzing))]
2859 let accepted_timeout_claim = witness_items == 3 && htlctype == Some(HTLCType::AcceptedHTLC) && !revocation_sig_claim;
2860 let offered_preimage_claim = witness_items == 3 && htlctype == Some(HTLCType::OfferedHTLC) &&
2861 !revocation_sig_claim && input.witness.second_to_last().unwrap().len() == 32;
2863 #[cfg(not(fuzzing))]
2864 let offered_timeout_claim = witness_items == 5 && htlctype == Some(HTLCType::OfferedHTLC);
2866 let mut payment_preimage = PaymentPreimage([0; 32]);
2867 if accepted_preimage_claim {
2868 payment_preimage.0.copy_from_slice(input.witness.second_to_last().unwrap());
2869 } else if offered_preimage_claim {
2870 payment_preimage.0.copy_from_slice(input.witness.second_to_last().unwrap());
2873 macro_rules! log_claim {
2874 ($tx_info: expr, $holder_tx: expr, $htlc: expr, $source_avail: expr) => {
2875 let outbound_htlc = $holder_tx == $htlc.offered;
2876 // HTLCs must either be claimed by a matching script type or through the
2878 #[cfg(not(fuzzing))] // Note that the fuzzer is not bound by pesky things like "signatures"
2879 debug_assert!(!$htlc.offered || offered_preimage_claim || offered_timeout_claim || revocation_sig_claim);
2880 #[cfg(not(fuzzing))] // Note that the fuzzer is not bound by pesky things like "signatures"
2881 debug_assert!($htlc.offered || accepted_preimage_claim || accepted_timeout_claim || revocation_sig_claim);
2882 // Further, only exactly one of the possible spend paths should have been
2883 // matched by any HTLC spend:
2884 #[cfg(not(fuzzing))] // Note that the fuzzer is not bound by pesky things like "signatures"
2885 debug_assert_eq!(accepted_preimage_claim as u8 + accepted_timeout_claim as u8 +
2886 offered_preimage_claim as u8 + offered_timeout_claim as u8 +
2887 revocation_sig_claim as u8, 1);
2888 if ($holder_tx && revocation_sig_claim) ||
2889 (outbound_htlc && !$source_avail && (accepted_preimage_claim || offered_preimage_claim)) {
2890 log_error!(logger, "Input spending {} ({}:{}) in {} resolves {} HTLC with payment hash {} with {}!",
2891 $tx_info, input.previous_output.txid, input.previous_output.vout, tx.txid(),
2892 if outbound_htlc { "outbound" } else { "inbound" }, log_bytes!($htlc.payment_hash.0),
2893 if revocation_sig_claim { "revocation sig" } else { "preimage claim after we'd passed the HTLC resolution back" });
2895 log_info!(logger, "Input spending {} ({}:{}) in {} resolves {} HTLC with payment hash {} with {}",
2896 $tx_info, input.previous_output.txid, input.previous_output.vout, tx.txid(),
2897 if outbound_htlc { "outbound" } else { "inbound" }, log_bytes!($htlc.payment_hash.0),
2898 if revocation_sig_claim { "revocation sig" } else if accepted_preimage_claim || offered_preimage_claim { "preimage" } else { "timeout" });
2903 macro_rules! check_htlc_valid_counterparty {
2904 ($counterparty_txid: expr, $htlc_output: expr) => {
2905 if let Some(txid) = $counterparty_txid {
2906 for &(ref pending_htlc, ref pending_source) in self.counterparty_claimable_outpoints.get(&txid).unwrap() {
2907 if pending_htlc.payment_hash == $htlc_output.payment_hash && pending_htlc.amount_msat == $htlc_output.amount_msat {
2908 if let &Some(ref source) = pending_source {
2909 log_claim!("revoked counterparty commitment tx", false, pending_htlc, true);
2910 payment_data = Some(((**source).clone(), $htlc_output.payment_hash, $htlc_output.amount_msat));
2919 macro_rules! scan_commitment {
2920 ($htlcs: expr, $tx_info: expr, $holder_tx: expr) => {
2921 for (ref htlc_output, source_option) in $htlcs {
2922 if Some(input.previous_output.vout) == htlc_output.transaction_output_index {
2923 if let Some(ref source) = source_option {
2924 log_claim!($tx_info, $holder_tx, htlc_output, true);
2925 // We have a resolution of an HTLC either from one of our latest
2926 // holder commitment transactions or an unrevoked counterparty commitment
2927 // transaction. This implies we either learned a preimage, the HTLC
2928 // has timed out, or we screwed up. In any case, we should now
2929 // resolve the source HTLC with the original sender.
2930 payment_data = Some(((*source).clone(), htlc_output.payment_hash, htlc_output.amount_msat));
2931 } else if !$holder_tx {
2932 check_htlc_valid_counterparty!(self.current_counterparty_commitment_txid, htlc_output);
2933 if payment_data.is_none() {
2934 check_htlc_valid_counterparty!(self.prev_counterparty_commitment_txid, htlc_output);
2937 if payment_data.is_none() {
2938 log_claim!($tx_info, $holder_tx, htlc_output, false);
2939 let outbound_htlc = $holder_tx == htlc_output.offered;
2940 if !outbound_htlc || revocation_sig_claim {
2941 self.onchain_events_awaiting_threshold_conf.push(OnchainEventEntry {
2942 txid: tx.txid(), height,
2943 event: OnchainEvent::HTLCSpendConfirmation {
2944 commitment_tx_output_idx: input.previous_output.vout,
2945 preimage: if accepted_preimage_claim || offered_preimage_claim {
2946 Some(payment_preimage) } else { None },
2947 // If this is a payment to us (!outbound_htlc, above),
2948 // wait for the CSV delay before dropping the HTLC from
2949 // claimable balance if the claim was an HTLC-Success
2951 on_to_local_output_csv: if accepted_preimage_claim {
2952 Some(self.on_holder_tx_csv) } else { None },
2956 // Outbound claims should always have payment_data, unless
2957 // we've already failed the HTLC as the commitment transaction
2958 // which was broadcasted was revoked. In that case, we should
2959 // spend the HTLC output here immediately, and expose that fact
2960 // as a Balance, something which we do not yet do.
2961 // TODO: Track the above as claimable!
2963 continue 'outer_loop;
2970 if input.previous_output.txid == self.current_holder_commitment_tx.txid {
2971 scan_commitment!(self.current_holder_commitment_tx.htlc_outputs.iter().map(|&(ref a, _, ref b)| (a, b.as_ref())),
2972 "our latest holder commitment tx", true);
2974 if let Some(ref prev_holder_signed_commitment_tx) = self.prev_holder_signed_commitment_tx {
2975 if input.previous_output.txid == prev_holder_signed_commitment_tx.txid {
2976 scan_commitment!(prev_holder_signed_commitment_tx.htlc_outputs.iter().map(|&(ref a, _, ref b)| (a, b.as_ref())),
2977 "our previous holder commitment tx", true);
2980 if let Some(ref htlc_outputs) = self.counterparty_claimable_outpoints.get(&input.previous_output.txid) {
2981 scan_commitment!(htlc_outputs.iter().map(|&(ref a, ref b)| (a, (b.as_ref().clone()).map(|boxed| &**boxed))),
2982 "counterparty commitment tx", false);
2985 // Check that scan_commitment, above, decided there is some source worth relaying an
2986 // HTLC resolution backwards to and figure out whether we learned a preimage from it.
2987 if let Some((source, payment_hash, amount_msat)) = payment_data {
2988 if accepted_preimage_claim {
2989 if !self.pending_monitor_events.iter().any(
2990 |update| if let &MonitorEvent::HTLCEvent(ref upd) = update { upd.source == source } else { false }) {
2991 self.onchain_events_awaiting_threshold_conf.push(OnchainEventEntry {
2994 event: OnchainEvent::HTLCSpendConfirmation {
2995 commitment_tx_output_idx: input.previous_output.vout,
2996 preimage: Some(payment_preimage),
2997 on_to_local_output_csv: None,
3000 self.pending_monitor_events.push(MonitorEvent::HTLCEvent(HTLCUpdate {
3002 payment_preimage: Some(payment_preimage),
3004 htlc_value_satoshis: Some(amount_msat / 1000),
3007 } else if offered_preimage_claim {
3008 if !self.pending_monitor_events.iter().any(
3009 |update| if let &MonitorEvent::HTLCEvent(ref upd) = update {
3010 upd.source == source
3012 self.onchain_events_awaiting_threshold_conf.push(OnchainEventEntry {
3015 event: OnchainEvent::HTLCSpendConfirmation {
3016 commitment_tx_output_idx: input.previous_output.vout,
3017 preimage: Some(payment_preimage),
3018 on_to_local_output_csv: None,
3021 self.pending_monitor_events.push(MonitorEvent::HTLCEvent(HTLCUpdate {
3023 payment_preimage: Some(payment_preimage),
3025 htlc_value_satoshis: Some(amount_msat / 1000),
3029 self.onchain_events_awaiting_threshold_conf.retain(|ref entry| {
3030 if entry.height != height { return true; }
3032 OnchainEvent::HTLCUpdate { source: ref htlc_source, .. } => {
3033 *htlc_source != source
3038 let entry = OnchainEventEntry {
3041 event: OnchainEvent::HTLCUpdate {
3042 source, payment_hash,
3043 htlc_value_satoshis: Some(amount_msat / 1000),
3044 commitment_tx_output_idx: Some(input.previous_output.vout),
3047 log_info!(logger, "Failing HTLC with payment_hash {} timeout by a spend tx, waiting for confirmation (at height {})", log_bytes!(payment_hash.0), entry.confirmation_threshold());
3048 self.onchain_events_awaiting_threshold_conf.push(entry);
3054 /// Check if any transaction broadcasted is paying fund back to some address we can assume to own
3055 fn is_paying_spendable_output<L: Deref>(&mut self, tx: &Transaction, height: u32, logger: &L) where L::Target: Logger {
3056 let mut spendable_output = None;
3057 for (i, outp) in tx.output.iter().enumerate() { // There is max one spendable output for any channel tx, including ones generated by us
3058 if i > ::core::u16::MAX as usize {
3059 // While it is possible that an output exists on chain which is greater than the
3060 // 2^16th output in a given transaction, this is only possible if the output is not
3061 // in a lightning transaction and was instead placed there by some third party who
3062 // wishes to give us money for no reason.
3063 // Namely, any lightning transactions which we pre-sign will never have anywhere
3064 // near 2^16 outputs both because such transactions must have ~2^16 outputs who's
3065 // scripts are not longer than one byte in length and because they are inherently
3066 // non-standard due to their size.
3067 // Thus, it is completely safe to ignore such outputs, and while it may result in
3068 // us ignoring non-lightning fund to us, that is only possible if someone fills
3069 // nearly a full block with garbage just to hit this case.
3072 if outp.script_pubkey == self.destination_script {
3073 spendable_output = Some(SpendableOutputDescriptor::StaticOutput {
3074 outpoint: OutPoint { txid: tx.txid(), index: i as u16 },
3075 output: outp.clone(),
3079 if let Some(ref broadcasted_holder_revokable_script) = self.broadcasted_holder_revokable_script {
3080 if broadcasted_holder_revokable_script.0 == outp.script_pubkey {
3081 spendable_output = Some(SpendableOutputDescriptor::DelayedPaymentOutput(DelayedPaymentOutputDescriptor {
3082 outpoint: OutPoint { txid: tx.txid(), index: i as u16 },
3083 per_commitment_point: broadcasted_holder_revokable_script.1,
3084 to_self_delay: self.on_holder_tx_csv,
3085 output: outp.clone(),
3086 revocation_pubkey: broadcasted_holder_revokable_script.2.clone(),
3087 channel_keys_id: self.channel_keys_id,
3088 channel_value_satoshis: self.channel_value_satoshis,
3093 if self.counterparty_payment_script == outp.script_pubkey {
3094 spendable_output = Some(SpendableOutputDescriptor::StaticPaymentOutput(StaticPaymentOutputDescriptor {
3095 outpoint: OutPoint { txid: tx.txid(), index: i as u16 },
3096 output: outp.clone(),
3097 channel_keys_id: self.channel_keys_id,
3098 channel_value_satoshis: self.channel_value_satoshis,
3102 if self.shutdown_script.as_ref() == Some(&outp.script_pubkey) {
3103 spendable_output = Some(SpendableOutputDescriptor::StaticOutput {
3104 outpoint: OutPoint { txid: tx.txid(), index: i as u16 },
3105 output: outp.clone(),
3110 if let Some(spendable_output) = spendable_output {
3111 let entry = OnchainEventEntry {
3114 event: OnchainEvent::MaturingOutput { descriptor: spendable_output.clone() },
3116 log_info!(logger, "Received spendable output {}, spendable at height {}", log_spendable!(spendable_output), entry.confirmation_threshold());
3117 self.onchain_events_awaiting_threshold_conf.push(entry);
3122 impl<Signer: Sign, T: Deref, F: Deref, L: Deref> chain::Listen for (ChannelMonitor<Signer>, T, F, L)
3124 T::Target: BroadcasterInterface,
3125 F::Target: FeeEstimator,
3128 fn filtered_block_connected(&self, header: &BlockHeader, txdata: &TransactionData, height: u32) {
3129 self.0.block_connected(header, txdata, height, &*self.1, &*self.2, &*self.3);
3132 fn block_disconnected(&self, header: &BlockHeader, height: u32) {
3133 self.0.block_disconnected(header, height, &*self.1, &*self.2, &*self.3);
3137 impl<Signer: Sign, T: Deref, F: Deref, L: Deref> chain::Confirm for (ChannelMonitor<Signer>, T, F, L)
3139 T::Target: BroadcasterInterface,
3140 F::Target: FeeEstimator,
3143 fn transactions_confirmed(&self, header: &BlockHeader, txdata: &TransactionData, height: u32) {
3144 self.0.transactions_confirmed(header, txdata, height, &*self.1, &*self.2, &*self.3);
3147 fn transaction_unconfirmed(&self, txid: &Txid) {
3148 self.0.transaction_unconfirmed(txid, &*self.1, &*self.2, &*self.3);
3151 fn best_block_updated(&self, header: &BlockHeader, height: u32) {
3152 self.0.best_block_updated(header, height, &*self.1, &*self.2, &*self.3);
3155 fn get_relevant_txids(&self) -> Vec<Txid> {
3156 self.0.get_relevant_txids()
3160 const MAX_ALLOC_SIZE: usize = 64*1024;
3162 impl<'a, Signer: Sign, K: KeysInterface<Signer = Signer>> ReadableArgs<&'a K>
3163 for (BlockHash, ChannelMonitor<Signer>) {
3164 fn read<R: io::Read>(reader: &mut R, keys_manager: &'a K) -> Result<Self, DecodeError> {
3165 macro_rules! unwrap_obj {
3169 Err(_) => return Err(DecodeError::InvalidValue),
3174 let _ver = read_ver_prefix!(reader, SERIALIZATION_VERSION);
3176 let latest_update_id: u64 = Readable::read(reader)?;
3177 let commitment_transaction_number_obscure_factor = <U48 as Readable>::read(reader)?.0;
3179 let destination_script = Readable::read(reader)?;
3180 let broadcasted_holder_revokable_script = match <u8 as Readable>::read(reader)? {
3182 let revokable_address = Readable::read(reader)?;
3183 let per_commitment_point = Readable::read(reader)?;
3184 let revokable_script = Readable::read(reader)?;
3185 Some((revokable_address, per_commitment_point, revokable_script))
3188 _ => return Err(DecodeError::InvalidValue),
3190 let counterparty_payment_script = Readable::read(reader)?;
3191 let shutdown_script = {
3192 let script = <Script as Readable>::read(reader)?;
3193 if script.is_empty() { None } else { Some(script) }
3196 let channel_keys_id = Readable::read(reader)?;
3197 let holder_revocation_basepoint = Readable::read(reader)?;
3198 // Technically this can fail and serialize fail a round-trip, but only for serialization of
3199 // barely-init'd ChannelMonitors that we can't do anything with.
3200 let outpoint = OutPoint {
3201 txid: Readable::read(reader)?,
3202 index: Readable::read(reader)?,
3204 let funding_info = (outpoint, Readable::read(reader)?);
3205 let current_counterparty_commitment_txid = Readable::read(reader)?;
3206 let prev_counterparty_commitment_txid = Readable::read(reader)?;
3208 let counterparty_commitment_params = Readable::read(reader)?;
3209 let funding_redeemscript = Readable::read(reader)?;
3210 let channel_value_satoshis = Readable::read(reader)?;
3212 let their_cur_per_commitment_points = {
3213 let first_idx = <U48 as Readable>::read(reader)?.0;
3217 let first_point = Readable::read(reader)?;
3218 let second_point_slice: [u8; 33] = Readable::read(reader)?;
3219 if second_point_slice[0..32] == [0; 32] && second_point_slice[32] == 0 {
3220 Some((first_idx, first_point, None))
3222 Some((first_idx, first_point, Some(unwrap_obj!(PublicKey::from_slice(&second_point_slice)))))
3227 let on_holder_tx_csv: u16 = Readable::read(reader)?;
3229 let commitment_secrets = Readable::read(reader)?;
3231 macro_rules! read_htlc_in_commitment {
3234 let offered: bool = Readable::read(reader)?;
3235 let amount_msat: u64 = Readable::read(reader)?;
3236 let cltv_expiry: u32 = Readable::read(reader)?;
3237 let payment_hash: PaymentHash = Readable::read(reader)?;
3238 let transaction_output_index: Option<u32> = Readable::read(reader)?;
3240 HTLCOutputInCommitment {
3241 offered, amount_msat, cltv_expiry, payment_hash, transaction_output_index
3247 let counterparty_claimable_outpoints_len: u64 = Readable::read(reader)?;
3248 let mut counterparty_claimable_outpoints = HashMap::with_capacity(cmp::min(counterparty_claimable_outpoints_len as usize, MAX_ALLOC_SIZE / 64));
3249 for _ in 0..counterparty_claimable_outpoints_len {
3250 let txid: Txid = Readable::read(reader)?;
3251 let htlcs_count: u64 = Readable::read(reader)?;
3252 let mut htlcs = Vec::with_capacity(cmp::min(htlcs_count as usize, MAX_ALLOC_SIZE / 32));
3253 for _ in 0..htlcs_count {
3254 htlcs.push((read_htlc_in_commitment!(), <Option<HTLCSource> as Readable>::read(reader)?.map(|o: HTLCSource| Box::new(o))));
3256 if let Some(_) = counterparty_claimable_outpoints.insert(txid, htlcs) {
3257 return Err(DecodeError::InvalidValue);
3261 let counterparty_commitment_txn_on_chain_len: u64 = Readable::read(reader)?;
3262 let mut counterparty_commitment_txn_on_chain = HashMap::with_capacity(cmp::min(counterparty_commitment_txn_on_chain_len as usize, MAX_ALLOC_SIZE / 32));
3263 for _ in 0..counterparty_commitment_txn_on_chain_len {
3264 let txid: Txid = Readable::read(reader)?;
3265 let commitment_number = <U48 as Readable>::read(reader)?.0;
3266 if let Some(_) = counterparty_commitment_txn_on_chain.insert(txid, commitment_number) {
3267 return Err(DecodeError::InvalidValue);
3271 let counterparty_hash_commitment_number_len: u64 = Readable::read(reader)?;
3272 let mut counterparty_hash_commitment_number = HashMap::with_capacity(cmp::min(counterparty_hash_commitment_number_len as usize, MAX_ALLOC_SIZE / 32));
3273 for _ in 0..counterparty_hash_commitment_number_len {
3274 let payment_hash: PaymentHash = Readable::read(reader)?;
3275 let commitment_number = <U48 as Readable>::read(reader)?.0;
3276 if let Some(_) = counterparty_hash_commitment_number.insert(payment_hash, commitment_number) {
3277 return Err(DecodeError::InvalidValue);
3281 let mut prev_holder_signed_commitment_tx: Option<HolderSignedTx> =
3282 match <u8 as Readable>::read(reader)? {
3285 Some(Readable::read(reader)?)
3287 _ => return Err(DecodeError::InvalidValue),
3289 let mut current_holder_commitment_tx: HolderSignedTx = Readable::read(reader)?;
3291 let current_counterparty_commitment_number = <U48 as Readable>::read(reader)?.0;
3292 let current_holder_commitment_number = <U48 as Readable>::read(reader)?.0;
3294 let payment_preimages_len: u64 = Readable::read(reader)?;
3295 let mut payment_preimages = HashMap::with_capacity(cmp::min(payment_preimages_len as usize, MAX_ALLOC_SIZE / 32));
3296 for _ in 0..payment_preimages_len {
3297 let preimage: PaymentPreimage = Readable::read(reader)?;
3298 let hash = PaymentHash(Sha256::hash(&preimage.0[..]).into_inner());
3299 if let Some(_) = payment_preimages.insert(hash, preimage) {
3300 return Err(DecodeError::InvalidValue);
3304 let pending_monitor_events_len: u64 = Readable::read(reader)?;
3305 let mut pending_monitor_events = Some(
3306 Vec::with_capacity(cmp::min(pending_monitor_events_len as usize, MAX_ALLOC_SIZE / (32 + 8*3))));
3307 for _ in 0..pending_monitor_events_len {
3308 let ev = match <u8 as Readable>::read(reader)? {
3309 0 => MonitorEvent::HTLCEvent(Readable::read(reader)?),
3310 1 => MonitorEvent::CommitmentTxConfirmed(funding_info.0),
3311 _ => return Err(DecodeError::InvalidValue)
3313 pending_monitor_events.as_mut().unwrap().push(ev);
3316 let pending_events_len: u64 = Readable::read(reader)?;
3317 let mut pending_events = Vec::with_capacity(cmp::min(pending_events_len as usize, MAX_ALLOC_SIZE / mem::size_of::<Event>()));
3318 for _ in 0..pending_events_len {
3319 if let Some(event) = MaybeReadable::read(reader)? {
3320 pending_events.push(event);
3324 let best_block = BestBlock::new(Readable::read(reader)?, Readable::read(reader)?);
3326 let waiting_threshold_conf_len: u64 = Readable::read(reader)?;
3327 let mut onchain_events_awaiting_threshold_conf = Vec::with_capacity(cmp::min(waiting_threshold_conf_len as usize, MAX_ALLOC_SIZE / 128));
3328 for _ in 0..waiting_threshold_conf_len {
3329 if let Some(val) = MaybeReadable::read(reader)? {
3330 onchain_events_awaiting_threshold_conf.push(val);
3334 let outputs_to_watch_len: u64 = Readable::read(reader)?;
3335 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>>())));
3336 for _ in 0..outputs_to_watch_len {
3337 let txid = Readable::read(reader)?;
3338 let outputs_len: u64 = Readable::read(reader)?;
3339 let mut outputs = Vec::with_capacity(cmp::min(outputs_len as usize, MAX_ALLOC_SIZE / (mem::size_of::<u32>() + mem::size_of::<Script>())));
3340 for _ in 0..outputs_len {
3341 outputs.push((Readable::read(reader)?, Readable::read(reader)?));
3343 if let Some(_) = outputs_to_watch.insert(txid, outputs) {
3344 return Err(DecodeError::InvalidValue);
3347 let onchain_tx_handler: OnchainTxHandler<Signer> = ReadableArgs::read(reader, keys_manager)?;
3349 let lockdown_from_offchain = Readable::read(reader)?;
3350 let holder_tx_signed = Readable::read(reader)?;
3352 if let Some(prev_commitment_tx) = prev_holder_signed_commitment_tx.as_mut() {
3353 let prev_holder_value = onchain_tx_handler.get_prev_holder_commitment_to_self_value();
3354 if prev_holder_value.is_none() { return Err(DecodeError::InvalidValue); }
3355 if prev_commitment_tx.to_self_value_sat == u64::max_value() {
3356 prev_commitment_tx.to_self_value_sat = prev_holder_value.unwrap();
3357 } else if prev_commitment_tx.to_self_value_sat != prev_holder_value.unwrap() {
3358 return Err(DecodeError::InvalidValue);
3362 let cur_holder_value = onchain_tx_handler.get_cur_holder_commitment_to_self_value();
3363 if current_holder_commitment_tx.to_self_value_sat == u64::max_value() {
3364 current_holder_commitment_tx.to_self_value_sat = cur_holder_value;
3365 } else if current_holder_commitment_tx.to_self_value_sat != cur_holder_value {
3366 return Err(DecodeError::InvalidValue);
3369 let mut funding_spend_confirmed = None;
3370 let mut htlcs_resolved_on_chain = Some(Vec::new());
3371 let mut funding_spend_seen = Some(false);
3372 let mut counterparty_node_id = None;
3373 read_tlv_fields!(reader, {
3374 (1, funding_spend_confirmed, option),
3375 (3, htlcs_resolved_on_chain, vec_type),
3376 (5, pending_monitor_events, vec_type),
3377 (7, funding_spend_seen, option),
3378 (9, counterparty_node_id, option),
3381 let mut secp_ctx = Secp256k1::new();
3382 secp_ctx.seeded_randomize(&keys_manager.get_secure_random_bytes());
3384 Ok((best_block.block_hash(), ChannelMonitor::from_impl(ChannelMonitorImpl {
3386 commitment_transaction_number_obscure_factor,
3389 broadcasted_holder_revokable_script,
3390 counterparty_payment_script,
3394 holder_revocation_basepoint,
3396 current_counterparty_commitment_txid,
3397 prev_counterparty_commitment_txid,
3399 counterparty_commitment_params,
3400 funding_redeemscript,
3401 channel_value_satoshis,
3402 their_cur_per_commitment_points,
3407 counterparty_claimable_outpoints,
3408 counterparty_commitment_txn_on_chain,
3409 counterparty_hash_commitment_number,
3411 prev_holder_signed_commitment_tx,
3412 current_holder_commitment_tx,
3413 current_counterparty_commitment_number,
3414 current_holder_commitment_number,
3417 pending_monitor_events: pending_monitor_events.unwrap(),
3420 onchain_events_awaiting_threshold_conf,
3425 lockdown_from_offchain,
3427 funding_spend_seen: funding_spend_seen.unwrap(),
3428 funding_spend_confirmed,
3429 htlcs_resolved_on_chain: htlcs_resolved_on_chain.unwrap(),
3432 counterparty_node_id,
3441 use bitcoin::blockdata::block::BlockHeader;
3442 use bitcoin::blockdata::script::{Script, Builder};
3443 use bitcoin::blockdata::opcodes;
3444 use bitcoin::blockdata::transaction::{Transaction, TxIn, TxOut, EcdsaSighashType};
3445 use bitcoin::blockdata::transaction::OutPoint as BitcoinOutPoint;
3446 use bitcoin::util::sighash;
3447 use bitcoin::hashes::Hash;
3448 use bitcoin::hashes::sha256::Hash as Sha256;
3449 use bitcoin::hashes::hex::FromHex;
3450 use bitcoin::hash_types::{BlockHash, Txid};
3451 use bitcoin::network::constants::Network;
3452 use bitcoin::secp256k1::{SecretKey,PublicKey};
3453 use bitcoin::secp256k1::Secp256k1;
3457 use crate::chain::chaininterface::LowerBoundedFeeEstimator;
3459 use super::ChannelMonitorUpdateStep;
3460 use ::{check_added_monitors, check_closed_broadcast, check_closed_event, check_spends, get_local_commitment_txn, get_monitor, get_route_and_payment_hash, unwrap_send_err};
3461 use chain::{BestBlock, Confirm};
3462 use chain::channelmonitor::ChannelMonitor;
3463 use chain::package::{weight_offered_htlc, weight_received_htlc, weight_revoked_offered_htlc, weight_revoked_received_htlc, WEIGHT_REVOKED_OUTPUT};
3464 use chain::transaction::OutPoint;
3465 use chain::keysinterface::InMemorySigner;
3466 use ln::{PaymentPreimage, PaymentHash};
3468 use ln::chan_utils::{HTLCOutputInCommitment, ChannelPublicKeys, ChannelTransactionParameters, HolderCommitmentTransaction, CounterpartyChannelTransactionParameters};
3469 use ln::channelmanager::PaymentSendFailure;
3470 use ln::features::InitFeatures;
3471 use ln::functional_test_utils::*;
3472 use ln::script::ShutdownScript;
3473 use util::errors::APIError;
3474 use util::events::{ClosureReason, MessageSendEventsProvider};
3475 use util::test_utils::{TestLogger, TestBroadcaster, TestFeeEstimator};
3476 use util::ser::{ReadableArgs, Writeable};
3477 use sync::{Arc, Mutex};
3479 use bitcoin::Witness;
3482 fn do_test_funding_spend_refuses_updates(use_local_txn: bool) {
3483 // Previously, monitor updates were allowed freely even after a funding-spend transaction
3484 // confirmed. This would allow a race condition where we could receive a payment (including
3485 // the counterparty revoking their broadcasted state!) and accept it without recourse as
3486 // long as the ChannelMonitor receives the block first, the full commitment update dance
3487 // occurs after the block is connected, and before the ChannelManager receives the block.
3488 // Obviously this is an incredibly contrived race given the counterparty would be risking
3489 // their full channel balance for it, but its worth fixing nonetheless as it makes the
3490 // potential ChannelMonitor states simpler to reason about.
3492 // This test checks said behavior, as well as ensuring a ChannelMonitorUpdate with multiple
3493 // updates is handled correctly in such conditions.
3494 let chanmon_cfgs = create_chanmon_cfgs(3);
3495 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
3496 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
3497 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
3498 let channel = create_announced_chan_between_nodes(
3499 &nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3500 create_announced_chan_between_nodes(
3501 &nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
3503 // Rebalance somewhat
3504 send_payment(&nodes[0], &[&nodes[1]], 10_000_000);
3506 // First route two payments for testing at the end
3507 let payment_preimage_1 = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 1_000_000).0;
3508 let payment_preimage_2 = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 1_000_000).0;
3510 let local_txn = get_local_commitment_txn!(nodes[1], channel.2);
3511 assert_eq!(local_txn.len(), 1);
3512 let remote_txn = get_local_commitment_txn!(nodes[0], channel.2);
3513 assert_eq!(remote_txn.len(), 3); // Commitment and two HTLC-Timeouts
3514 check_spends!(remote_txn[1], remote_txn[0]);
3515 check_spends!(remote_txn[2], remote_txn[0]);
3516 let broadcast_tx = if use_local_txn { &local_txn[0] } else { &remote_txn[0] };
3518 // Connect a commitment transaction, but only to the ChainMonitor/ChannelMonitor. The
3519 // channel is now closed, but the ChannelManager doesn't know that yet.
3520 let new_header = BlockHeader {
3521 version: 2, time: 0, bits: 0, nonce: 0,
3522 prev_blockhash: nodes[0].best_block_info().0,
3523 merkle_root: Default::default() };
3524 let conf_height = nodes[0].best_block_info().1 + 1;
3525 nodes[1].chain_monitor.chain_monitor.transactions_confirmed(&new_header,
3526 &[(0, broadcast_tx)], conf_height);
3528 let (_, pre_update_monitor) = <(BlockHash, ChannelMonitor<InMemorySigner>)>::read(
3529 &mut io::Cursor::new(&get_monitor!(nodes[1], channel.2).encode()),
3530 &nodes[1].keys_manager.backing).unwrap();
3532 // If the ChannelManager tries to update the channel, however, the ChainMonitor will pass
3533 // the update through to the ChannelMonitor which will refuse it (as the channel is closed).
3534 let (route, payment_hash, _, payment_secret) = get_route_and_payment_hash!(nodes[1], nodes[0], 100_000);
3535 unwrap_send_err!(nodes[1].node.send_payment(&route, payment_hash, &Some(payment_secret)),
3536 true, APIError::ChannelUnavailable { ref err },
3537 assert!(err.contains("ChannelMonitor storage failure")));
3538 check_added_monitors!(nodes[1], 2); // After the failure we generate a close-channel monitor update
3539 check_closed_broadcast!(nodes[1], true);
3540 check_closed_event!(nodes[1], 1, ClosureReason::ProcessingError { err: "ChannelMonitor storage failure".to_string() });
3542 // Build a new ChannelMonitorUpdate which contains both the failing commitment tx update
3543 // and provides the claim preimages for the two pending HTLCs. The first update generates
3544 // an error, but the point of this test is to ensure the later updates are still applied.
3545 let monitor_updates = nodes[1].chain_monitor.monitor_updates.lock().unwrap();
3546 let mut replay_update = monitor_updates.get(&channel.2).unwrap().iter().rev().skip(1).next().unwrap().clone();
3547 assert_eq!(replay_update.updates.len(), 1);
3548 if let ChannelMonitorUpdateStep::LatestCounterpartyCommitmentTXInfo { .. } = replay_update.updates[0] {
3549 } else { panic!(); }
3550 replay_update.updates.push(ChannelMonitorUpdateStep::PaymentPreimage { payment_preimage: payment_preimage_1 });
3551 replay_update.updates.push(ChannelMonitorUpdateStep::PaymentPreimage { payment_preimage: payment_preimage_2 });
3553 let broadcaster = TestBroadcaster::new(Arc::clone(&nodes[1].blocks));
3555 pre_update_monitor.update_monitor(&replay_update, &&broadcaster, &chanmon_cfgs[1].fee_estimator, &nodes[1].logger)
3557 // Even though we error'd on the first update, we should still have generated an HTLC claim
3559 let txn_broadcasted = broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
3560 assert!(txn_broadcasted.len() >= 2);
3561 let htlc_txn = txn_broadcasted.iter().filter(|tx| {
3562 assert_eq!(tx.input.len(), 1);
3563 tx.input[0].previous_output.txid == broadcast_tx.txid()
3564 }).collect::<Vec<_>>();
3565 assert_eq!(htlc_txn.len(), 2);
3566 check_spends!(htlc_txn[0], broadcast_tx);
3567 check_spends!(htlc_txn[1], broadcast_tx);
3570 fn test_funding_spend_refuses_updates() {
3571 do_test_funding_spend_refuses_updates(true);
3572 do_test_funding_spend_refuses_updates(false);
3576 fn test_prune_preimages() {
3577 let secp_ctx = Secp256k1::new();
3578 let logger = Arc::new(TestLogger::new());
3579 let broadcaster = Arc::new(TestBroadcaster{txn_broadcasted: Mutex::new(Vec::new()), blocks: Arc::new(Mutex::new(Vec::new()))});
3580 let fee_estimator = TestFeeEstimator { sat_per_kw: Mutex::new(253) };
3582 let dummy_key = PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[42; 32]).unwrap());
3583 let dummy_tx = Transaction { version: 0, lock_time: 0, input: Vec::new(), output: Vec::new() };
3585 let mut preimages = Vec::new();
3588 let preimage = PaymentPreimage([i; 32]);
3589 let hash = PaymentHash(Sha256::hash(&preimage.0[..]).into_inner());
3590 preimages.push((preimage, hash));
3594 macro_rules! preimages_slice_to_htlc_outputs {
3595 ($preimages_slice: expr) => {
3597 let mut res = Vec::new();
3598 for (idx, preimage) in $preimages_slice.iter().enumerate() {
3599 res.push((HTLCOutputInCommitment {
3603 payment_hash: preimage.1.clone(),
3604 transaction_output_index: Some(idx as u32),
3611 macro_rules! preimages_to_holder_htlcs {
3612 ($preimages_slice: expr) => {
3614 let mut inp = preimages_slice_to_htlc_outputs!($preimages_slice);
3615 let res: Vec<_> = inp.drain(..).map(|e| { (e.0, None, e.1) }).collect();
3621 macro_rules! test_preimages_exist {
3622 ($preimages_slice: expr, $monitor: expr) => {
3623 for preimage in $preimages_slice {
3624 assert!($monitor.inner.lock().unwrap().payment_preimages.contains_key(&preimage.1));
3629 let keys = InMemorySigner::new(
3631 SecretKey::from_slice(&[41; 32]).unwrap(),
3632 SecretKey::from_slice(&[41; 32]).unwrap(),
3633 SecretKey::from_slice(&[41; 32]).unwrap(),
3634 SecretKey::from_slice(&[41; 32]).unwrap(),
3635 SecretKey::from_slice(&[41; 32]).unwrap(),
3636 SecretKey::from_slice(&[41; 32]).unwrap(),
3642 let counterparty_pubkeys = ChannelPublicKeys {
3643 funding_pubkey: PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[44; 32]).unwrap()),
3644 revocation_basepoint: PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[45; 32]).unwrap()),
3645 payment_point: PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[46; 32]).unwrap()),
3646 delayed_payment_basepoint: PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[47; 32]).unwrap()),
3647 htlc_basepoint: PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[48; 32]).unwrap())
3649 let funding_outpoint = OutPoint { txid: Default::default(), index: u16::max_value() };
3650 let channel_parameters = ChannelTransactionParameters {
3651 holder_pubkeys: keys.holder_channel_pubkeys.clone(),
3652 holder_selected_contest_delay: 66,
3653 is_outbound_from_holder: true,
3654 counterparty_parameters: Some(CounterpartyChannelTransactionParameters {
3655 pubkeys: counterparty_pubkeys,
3656 selected_contest_delay: 67,
3658 funding_outpoint: Some(funding_outpoint),
3661 // Prune with one old state and a holder commitment tx holding a few overlaps with the
3663 let shutdown_pubkey = PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[42; 32]).unwrap());
3664 let best_block = BestBlock::from_genesis(Network::Testnet);
3665 let monitor = ChannelMonitor::new(Secp256k1::new(), keys,
3666 Some(ShutdownScript::new_p2wpkh_from_pubkey(shutdown_pubkey).into_inner()), 0, &Script::new(),
3667 (OutPoint { txid: Txid::from_slice(&[43; 32]).unwrap(), index: 0 }, Script::new()),
3668 &channel_parameters,
3669 Script::new(), 46, 0,
3670 HolderCommitmentTransaction::dummy(), best_block, dummy_key);
3672 monitor.provide_latest_holder_commitment_tx(HolderCommitmentTransaction::dummy(), preimages_to_holder_htlcs!(preimages[0..10])).unwrap();
3673 let dummy_txid = dummy_tx.txid();
3674 monitor.provide_latest_counterparty_commitment_tx(dummy_txid, preimages_slice_to_htlc_outputs!(preimages[5..15]), 281474976710655, dummy_key, &logger);
3675 monitor.provide_latest_counterparty_commitment_tx(dummy_txid, preimages_slice_to_htlc_outputs!(preimages[15..20]), 281474976710654, dummy_key, &logger);
3676 monitor.provide_latest_counterparty_commitment_tx(dummy_txid, preimages_slice_to_htlc_outputs!(preimages[17..20]), 281474976710653, dummy_key, &logger);
3677 monitor.provide_latest_counterparty_commitment_tx(dummy_txid, preimages_slice_to_htlc_outputs!(preimages[18..20]), 281474976710652, dummy_key, &logger);
3678 for &(ref preimage, ref hash) in preimages.iter() {
3679 let bounded_fee_estimator = LowerBoundedFeeEstimator::new(&fee_estimator);
3680 monitor.provide_payment_preimage(hash, preimage, &broadcaster, &bounded_fee_estimator, &logger);
3683 // Now provide a secret, pruning preimages 10-15
3684 let mut secret = [0; 32];
3685 secret[0..32].clone_from_slice(&hex::decode("7cc854b54e3e0dcdb010d7a3fee464a9687be6e8db3be6854c475621e007a5dc").unwrap());
3686 monitor.provide_secret(281474976710655, secret.clone()).unwrap();
3687 assert_eq!(monitor.inner.lock().unwrap().payment_preimages.len(), 15);
3688 test_preimages_exist!(&preimages[0..10], monitor);
3689 test_preimages_exist!(&preimages[15..20], monitor);
3691 // Now provide a further secret, pruning preimages 15-17
3692 secret[0..32].clone_from_slice(&hex::decode("c7518c8ae4660ed02894df8976fa1a3659c1a8b4b5bec0c4b872abeba4cb8964").unwrap());
3693 monitor.provide_secret(281474976710654, secret.clone()).unwrap();
3694 assert_eq!(monitor.inner.lock().unwrap().payment_preimages.len(), 13);
3695 test_preimages_exist!(&preimages[0..10], monitor);
3696 test_preimages_exist!(&preimages[17..20], monitor);
3698 // Now update holder commitment tx info, pruning only element 18 as we still care about the
3699 // previous commitment tx's preimages too
3700 monitor.provide_latest_holder_commitment_tx(HolderCommitmentTransaction::dummy(), preimages_to_holder_htlcs!(preimages[0..5])).unwrap();
3701 secret[0..32].clone_from_slice(&hex::decode("2273e227a5b7449b6e70f1fb4652864038b1cbf9cd7c043a7d6456b7fc275ad8").unwrap());
3702 monitor.provide_secret(281474976710653, secret.clone()).unwrap();
3703 assert_eq!(monitor.inner.lock().unwrap().payment_preimages.len(), 12);
3704 test_preimages_exist!(&preimages[0..10], monitor);
3705 test_preimages_exist!(&preimages[18..20], monitor);
3707 // But if we do it again, we'll prune 5-10
3708 monitor.provide_latest_holder_commitment_tx(HolderCommitmentTransaction::dummy(), preimages_to_holder_htlcs!(preimages[0..3])).unwrap();
3709 secret[0..32].clone_from_slice(&hex::decode("27cddaa5624534cb6cb9d7da077cf2b22ab21e9b506fd4998a51d54502e99116").unwrap());
3710 monitor.provide_secret(281474976710652, secret.clone()).unwrap();
3711 assert_eq!(monitor.inner.lock().unwrap().payment_preimages.len(), 5);
3712 test_preimages_exist!(&preimages[0..5], monitor);
3716 fn test_claim_txn_weight_computation() {
3717 // We test Claim txn weight, knowing that we want expected weigth and
3718 // not actual case to avoid sigs and time-lock delays hell variances.
3720 let secp_ctx = Secp256k1::new();
3721 let privkey = SecretKey::from_slice(&hex::decode("0101010101010101010101010101010101010101010101010101010101010101").unwrap()[..]).unwrap();
3722 let pubkey = PublicKey::from_secret_key(&secp_ctx, &privkey);
3724 macro_rules! sign_input {
3725 ($sighash_parts: expr, $idx: expr, $amount: expr, $weight: expr, $sum_actual_sigs: expr, $opt_anchors: expr) => {
3726 let htlc = HTLCOutputInCommitment {
3727 offered: if *$weight == weight_revoked_offered_htlc($opt_anchors) || *$weight == weight_offered_htlc($opt_anchors) { true } else { false },
3729 cltv_expiry: 2 << 16,
3730 payment_hash: PaymentHash([1; 32]),
3731 transaction_output_index: Some($idx as u32),
3733 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) };
3734 let sighash = hash_to_message!(&$sighash_parts.segwit_signature_hash($idx, &redeem_script, $amount, EcdsaSighashType::All).unwrap()[..]);
3735 let sig = secp_ctx.sign_ecdsa(&sighash, &privkey);
3736 let mut ser_sig = sig.serialize_der().to_vec();
3737 ser_sig.push(EcdsaSighashType::All as u8);
3738 $sum_actual_sigs += ser_sig.len();
3739 let witness = $sighash_parts.witness_mut($idx).unwrap();
3740 witness.push(ser_sig);
3741 if *$weight == WEIGHT_REVOKED_OUTPUT {
3742 witness.push(vec!(1));
3743 } else if *$weight == weight_revoked_offered_htlc($opt_anchors) || *$weight == weight_revoked_received_htlc($opt_anchors) {
3744 witness.push(pubkey.clone().serialize().to_vec());
3745 } else if *$weight == weight_received_htlc($opt_anchors) {
3746 witness.push(vec![0]);
3748 witness.push(PaymentPreimage([1; 32]).0.to_vec());
3750 witness.push(redeem_script.into_bytes());
3751 let witness = witness.to_vec();
3752 println!("witness[0] {}", witness[0].len());
3753 println!("witness[1] {}", witness[1].len());
3754 println!("witness[2] {}", witness[2].len());
3758 let script_pubkey = Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script();
3759 let txid = Txid::from_hex("56944c5d3f98413ef45cf54545538103cc9f298e0575820ad3591376e2e0f65d").unwrap();
3761 // Justice tx with 1 to_holder, 2 revoked offered HTLCs, 1 revoked received HTLCs
3762 for &opt_anchors in [false, true].iter() {
3763 let mut claim_tx = Transaction { version: 0, lock_time: 0, input: Vec::new(), output: Vec::new() };
3764 let mut sum_actual_sigs = 0;
3766 claim_tx.input.push(TxIn {
3767 previous_output: BitcoinOutPoint {
3771 script_sig: Script::new(),
3772 sequence: 0xfffffffd,
3773 witness: Witness::new(),
3776 claim_tx.output.push(TxOut {
3777 script_pubkey: script_pubkey.clone(),
3780 let base_weight = claim_tx.weight();
3781 let inputs_weight = vec![WEIGHT_REVOKED_OUTPUT, weight_revoked_offered_htlc(opt_anchors), weight_revoked_offered_htlc(opt_anchors), weight_revoked_received_htlc(opt_anchors)];
3782 let mut inputs_total_weight = 2; // count segwit flags
3784 let mut sighash_parts = sighash::SighashCache::new(&mut claim_tx);
3785 for (idx, inp) in inputs_weight.iter().enumerate() {
3786 sign_input!(sighash_parts, idx, 0, inp, sum_actual_sigs, opt_anchors);
3787 inputs_total_weight += inp;
3790 assert_eq!(base_weight + inputs_total_weight as usize, claim_tx.weight() + /* max_length_sig */ (73 * inputs_weight.len() - sum_actual_sigs));
3793 // Claim tx with 1 offered HTLCs, 3 received HTLCs
3794 for &opt_anchors in [false, true].iter() {
3795 let mut claim_tx = Transaction { version: 0, lock_time: 0, input: Vec::new(), output: Vec::new() };
3796 let mut sum_actual_sigs = 0;
3798 claim_tx.input.push(TxIn {
3799 previous_output: BitcoinOutPoint {
3803 script_sig: Script::new(),
3804 sequence: 0xfffffffd,
3805 witness: Witness::new(),
3808 claim_tx.output.push(TxOut {
3809 script_pubkey: script_pubkey.clone(),
3812 let base_weight = claim_tx.weight();
3813 let inputs_weight = vec![weight_offered_htlc(opt_anchors), weight_received_htlc(opt_anchors), weight_received_htlc(opt_anchors), weight_received_htlc(opt_anchors)];
3814 let mut inputs_total_weight = 2; // count segwit flags
3816 let mut sighash_parts = sighash::SighashCache::new(&mut claim_tx);
3817 for (idx, inp) in inputs_weight.iter().enumerate() {
3818 sign_input!(sighash_parts, idx, 0, inp, sum_actual_sigs, opt_anchors);
3819 inputs_total_weight += inp;
3822 assert_eq!(base_weight + inputs_total_weight as usize, claim_tx.weight() + /* max_length_sig */ (73 * inputs_weight.len() - sum_actual_sigs));
3825 // Justice tx with 1 revoked HTLC-Success tx output
3826 for &opt_anchors in [false, true].iter() {
3827 let mut claim_tx = Transaction { version: 0, lock_time: 0, input: Vec::new(), output: Vec::new() };
3828 let mut sum_actual_sigs = 0;
3829 claim_tx.input.push(TxIn {
3830 previous_output: BitcoinOutPoint {
3834 script_sig: Script::new(),
3835 sequence: 0xfffffffd,
3836 witness: Witness::new(),
3838 claim_tx.output.push(TxOut {
3839 script_pubkey: script_pubkey.clone(),
3842 let base_weight = claim_tx.weight();
3843 let inputs_weight = vec![WEIGHT_REVOKED_OUTPUT];
3844 let mut inputs_total_weight = 2; // count segwit flags
3846 let mut sighash_parts = sighash::SighashCache::new(&mut claim_tx);
3847 for (idx, inp) in inputs_weight.iter().enumerate() {
3848 sign_input!(sighash_parts, idx, 0, inp, sum_actual_sigs, opt_anchors);
3849 inputs_total_weight += inp;
3852 assert_eq!(base_weight + inputs_total_weight as usize, claim_tx.weight() + /* max_length_isg */ (73 * inputs_weight.len() - sum_actual_sigs));
3856 // Further testing is done in the ChannelManager integration tests.