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::{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,Signature};
33 use bitcoin::secp256k1::key::{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};
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, feature = "fuzztarget", 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 updates.push(Readable::read(r)?);
111 read_tlv_fields!(r, {});
112 Ok(Self { update_id, updates })
116 /// An error enum representing a failure to persist a channel monitor update.
117 #[derive(Clone, Copy, Debug, PartialEq)]
118 pub enum ChannelMonitorUpdateErr {
119 /// Used to indicate a temporary failure (eg connection to a watchtower or remote backup of
120 /// our state failed, but is expected to succeed at some point in the future).
122 /// Such a failure will "freeze" a channel, preventing us from revoking old states or
123 /// submitting new commitment transactions to the counterparty. Once the update(s) which failed
124 /// have been successfully applied, ChannelManager::channel_monitor_updated can be used to
125 /// restore the channel to an operational state.
127 /// Note that a given ChannelManager will *never* re-generate a given ChannelMonitorUpdate. If
128 /// you return a TemporaryFailure you must ensure that it is written to disk safely before
129 /// writing out the latest ChannelManager state.
131 /// Even when a channel has been "frozen" updates to the ChannelMonitor can continue to occur
132 /// (eg if an inbound HTLC which we forwarded was claimed upstream resulting in us attempting
133 /// to claim it on this channel) and those updates must be applied wherever they can be. At
134 /// least one such updated ChannelMonitor must be persisted otherwise PermanentFailure should
135 /// be returned to get things on-chain ASAP using only the in-memory copy. Obviously updates to
136 /// the channel which would invalidate previous ChannelMonitors are not made when a channel has
139 /// Note that even if updates made after TemporaryFailure succeed you must still call
140 /// channel_monitor_updated to ensure you have the latest monitor and re-enable normal channel
143 /// Note that the update being processed here will not be replayed for you when you call
144 /// ChannelManager::channel_monitor_updated, so you must store the update itself along
145 /// with the persisted ChannelMonitor on your own local disk prior to returning a
146 /// TemporaryFailure. You may, of course, employ a journaling approach, storing only the
147 /// ChannelMonitorUpdate on disk without updating the monitor itself, replaying the journal at
150 /// For deployments where a copy of ChannelMonitors and other local state are backed up in a
151 /// remote location (with local copies persisted immediately), it is anticipated that all
152 /// updates will return TemporaryFailure until the remote copies could be updated.
154 /// Used to indicate no further channel monitor updates will be allowed (eg we've moved on to a
155 /// different watchtower and cannot update with all watchtowers that were previously informed
156 /// of this channel).
158 /// At reception of this error, ChannelManager will force-close the channel and return at
159 /// least a final ChannelMonitorUpdate::ChannelForceClosed which must be delivered to at
160 /// least one ChannelMonitor copy. Revocation secret MUST NOT be released and offchain channel
161 /// update must be rejected.
163 /// This failure may also signal a failure to update the local persisted copy of one of
164 /// the channel monitor instance.
166 /// Note that even when you fail a holder commitment transaction update, you must store the
167 /// update to ensure you can claim from it in case of a duplicate copy of this ChannelMonitor
168 /// broadcasts it (e.g distributed channel-monitor deployment)
170 /// In case of distributed watchtowers deployment, the new version must be written to disk, as
171 /// state may have been stored but rejected due to a block forcing a commitment broadcast. This
172 /// storage is used to claim outputs of rejected state confirmed onchain by another watchtower,
173 /// lagging behind on block processing.
177 /// General Err type for ChannelMonitor actions. Generally, this implies that the data provided is
178 /// inconsistent with the ChannelMonitor being called. eg for ChannelMonitor::update_monitor this
179 /// means you tried to update a monitor for a different channel or the ChannelMonitorUpdate was
181 /// Contains a developer-readable error message.
182 #[derive(Clone, Debug)]
183 pub struct MonitorUpdateError(pub &'static str);
185 /// An event to be processed by the ChannelManager.
186 #[derive(Clone, PartialEq)]
187 pub enum MonitorEvent {
188 /// A monitor event containing an HTLCUpdate.
189 HTLCEvent(HTLCUpdate),
191 /// A monitor event that the Channel's commitment transaction was broadcasted.
192 CommitmentTxBroadcasted(OutPoint),
195 /// Simple structure sent back by `chain::Watch` when an HTLC from a forward channel is detected on
196 /// chain. Used to update the corresponding HTLC in the backward channel. Failing to pass the
197 /// preimage claim backward will lead to loss of funds.
198 #[derive(Clone, PartialEq)]
199 pub struct HTLCUpdate {
200 pub(crate) payment_hash: PaymentHash,
201 pub(crate) payment_preimage: Option<PaymentPreimage>,
202 pub(crate) source: HTLCSource,
203 pub(crate) onchain_value_satoshis: Option<u64>,
205 impl_writeable_tlv_based!(HTLCUpdate, {
206 (0, payment_hash, required),
207 (1, onchain_value_satoshis, option),
208 (2, source, required),
209 (4, payment_preimage, option),
212 /// If an HTLC expires within this many blocks, don't try to claim it in a shared transaction,
213 /// instead claiming it in its own individual transaction.
214 pub(crate) const CLTV_SHARED_CLAIM_BUFFER: u32 = 12;
215 /// If an HTLC expires within this many blocks, force-close the channel to broadcast the
216 /// HTLC-Success transaction.
217 /// In other words, this is an upper bound on how many blocks we think it can take us to get a
218 /// transaction confirmed (and we use it in a few more, equivalent, places).
219 pub(crate) const CLTV_CLAIM_BUFFER: u32 = 18;
220 /// Number of blocks by which point we expect our counterparty to have seen new blocks on the
221 /// network and done a full update_fail_htlc/commitment_signed dance (+ we've updated all our
222 /// copies of ChannelMonitors, including watchtowers). We could enforce the contract by failing
223 /// at CLTV expiration height but giving a grace period to our peer may be profitable for us if he
224 /// can provide an over-late preimage. Nevertheless, grace period has to be accounted in our
225 /// CLTV_EXPIRY_DELTA to be secure. Following this policy we may decrease the rate of channel failures
226 /// due to expiration but increase the cost of funds being locked longuer in case of failure.
227 /// This delay also cover a low-power peer being slow to process blocks and so being behind us on
228 /// accurate block height.
229 /// In case of onchain failure to be pass backward we may see the last block of ANTI_REORG_DELAY
230 /// with at worst this delay, so we are not only using this value as a mercy for them but also
231 /// us as a safeguard to delay with enough time.
232 pub(crate) const LATENCY_GRACE_PERIOD_BLOCKS: u32 = 3;
233 /// Number of blocks we wait on seeing a HTLC output being solved before we fail corresponding inbound
234 /// HTLCs. This prevents us from failing backwards and then getting a reorg resulting in us losing money.
235 // We also use this delay to be sure we can remove our in-flight claim txn from bump candidates buffer.
236 // It may cause spurious generation of bumped claim txn but that's alright given the outpoint is already
237 // solved by a previous claim tx. What we want to avoid is reorg evicting our claim tx and us not
238 // keep bumping another claim tx to solve the outpoint.
239 pub const ANTI_REORG_DELAY: u32 = 6;
240 /// Number of blocks before confirmation at which we fail back an un-relayed HTLC or at which we
241 /// refuse to accept a new HTLC.
243 /// This is used for a few separate purposes:
244 /// 1) if we've received an MPP HTLC to us and it expires within this many blocks and we are
245 /// waiting on additional parts (or waiting on the preimage for any HTLC from the user), we will
247 /// 2) if we receive an HTLC within this many blocks of its expiry (plus one to avoid a race
248 /// condition with the above), we will fail this HTLC without telling the user we received it,
249 /// 3) if we are waiting on a connection or a channel state update to send an HTLC to a peer, and
250 /// that HTLC expires within this many blocks, we will simply fail the HTLC instead.
252 /// (1) is all about protecting us - we need enough time to update the channel state before we hit
253 /// CLTV_CLAIM_BUFFER, at which point we'd go on chain to claim the HTLC with the preimage.
255 /// (2) is the same, but with an additional buffer to avoid accepting an HTLC which is immediately
256 /// in a race condition between the user connecting a block (which would fail it) and the user
257 /// providing us the preimage (which would claim it).
259 /// (3) is about our counterparty - we don't want to relay an HTLC to a counterparty when they may
260 /// end up force-closing the channel on us to claim it.
261 pub(crate) const HTLC_FAIL_BACK_BUFFER: u32 = CLTV_CLAIM_BUFFER + LATENCY_GRACE_PERIOD_BLOCKS;
263 // TODO(devrandom) replace this with HolderCommitmentTransaction
264 #[derive(Clone, PartialEq)]
265 struct HolderSignedTx {
266 /// txid of the transaction in tx, just used to make comparison faster
268 revocation_key: PublicKey,
269 a_htlc_key: PublicKey,
270 b_htlc_key: PublicKey,
271 delayed_payment_key: PublicKey,
272 per_commitment_point: PublicKey,
274 htlc_outputs: Vec<(HTLCOutputInCommitment, Option<Signature>, Option<HTLCSource>)>,
276 impl_writeable_tlv_based!(HolderSignedTx, {
278 (2, revocation_key, required),
279 (4, a_htlc_key, required),
280 (6, b_htlc_key, required),
281 (8, delayed_payment_key, required),
282 (10, per_commitment_point, required),
283 (12, feerate_per_kw, required),
284 (14, htlc_outputs, vec_type)
287 /// We use this to track counterparty commitment transactions and htlcs outputs and
288 /// use it to generate any justice or 2nd-stage preimage/timeout transactions.
290 struct CounterpartyCommitmentTransaction {
291 counterparty_delayed_payment_base_key: PublicKey,
292 counterparty_htlc_base_key: PublicKey,
293 on_counterparty_tx_csv: u16,
294 per_htlc: HashMap<Txid, Vec<HTLCOutputInCommitment>>
297 impl Writeable for CounterpartyCommitmentTransaction {
298 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
299 w.write_all(&byte_utils::be64_to_array(self.per_htlc.len() as u64))?;
300 for (ref txid, ref htlcs) in self.per_htlc.iter() {
301 w.write_all(&txid[..])?;
302 w.write_all(&byte_utils::be64_to_array(htlcs.len() as u64))?;
303 for &ref htlc in htlcs.iter() {
307 write_tlv_fields!(w, {
308 (0, self.counterparty_delayed_payment_base_key, required),
309 (2, self.counterparty_htlc_base_key, required),
310 (4, self.on_counterparty_tx_csv, required),
315 impl Readable for CounterpartyCommitmentTransaction {
316 fn read<R: io::Read>(r: &mut R) -> Result<Self, DecodeError> {
317 let counterparty_commitment_transaction = {
318 let per_htlc_len: u64 = Readable::read(r)?;
319 let mut per_htlc = HashMap::with_capacity(cmp::min(per_htlc_len as usize, MAX_ALLOC_SIZE / 64));
320 for _ in 0..per_htlc_len {
321 let txid: Txid = Readable::read(r)?;
322 let htlcs_count: u64 = Readable::read(r)?;
323 let mut htlcs = Vec::with_capacity(cmp::min(htlcs_count as usize, MAX_ALLOC_SIZE / 32));
324 for _ in 0..htlcs_count {
325 let htlc = Readable::read(r)?;
328 if let Some(_) = per_htlc.insert(txid, htlcs) {
329 return Err(DecodeError::InvalidValue);
332 let mut counterparty_delayed_payment_base_key = OptionDeserWrapper(None);
333 let mut counterparty_htlc_base_key = OptionDeserWrapper(None);
334 let mut on_counterparty_tx_csv: u16 = 0;
335 read_tlv_fields!(r, {
336 (0, counterparty_delayed_payment_base_key, required),
337 (2, counterparty_htlc_base_key, required),
338 (4, on_counterparty_tx_csv, required),
340 CounterpartyCommitmentTransaction {
341 counterparty_delayed_payment_base_key: counterparty_delayed_payment_base_key.0.unwrap(),
342 counterparty_htlc_base_key: counterparty_htlc_base_key.0.unwrap(),
343 on_counterparty_tx_csv,
347 Ok(counterparty_commitment_transaction)
351 /// An entry for an [`OnchainEvent`], stating the block height when the event was observed and the
352 /// transaction causing it.
354 /// Used to determine when the on-chain event can be considered safe from a chain reorganization.
356 struct OnchainEventEntry {
362 impl OnchainEventEntry {
363 fn confirmation_threshold(&self) -> u32 {
364 let mut conf_threshold = self.height + ANTI_REORG_DELAY - 1;
365 if let OnchainEvent::MaturingOutput {
366 descriptor: SpendableOutputDescriptor::DelayedPaymentOutput(ref descriptor)
368 // A CSV'd transaction is confirmable in block (input height) + CSV delay, which means
369 // it's broadcastable when we see the previous block.
370 conf_threshold = cmp::max(conf_threshold, self.height + descriptor.to_self_delay as u32 - 1);
375 fn has_reached_confirmation_threshold(&self, best_block: &BestBlock) -> bool {
376 best_block.height() >= self.confirmation_threshold()
380 /// Upon discovering of some classes of onchain tx by ChannelMonitor, we may have to take actions on it
381 /// once they mature to enough confirmations (ANTI_REORG_DELAY)
384 /// HTLC output getting solved by a timeout, at maturation we pass upstream payment source information to solve
385 /// inbound HTLC in backward channel. Note, in case of preimage, we pass info to upstream without delay as we can
386 /// only win from it, so it's never an OnchainEvent
389 payment_hash: PaymentHash,
390 onchain_value_satoshis: Option<u64>,
393 descriptor: SpendableOutputDescriptor,
397 impl_writeable_tlv_based!(OnchainEventEntry, {
399 (2, height, required),
400 (4, event, required),
403 impl_writeable_tlv_based_enum!(OnchainEvent,
405 (0, source, required),
406 (1, onchain_value_satoshis, option),
407 (2, payment_hash, required),
409 (1, MaturingOutput) => {
410 (0, descriptor, required),
414 #[cfg_attr(any(test, feature = "fuzztarget", feature = "_test_utils"), derive(PartialEq))]
416 pub(crate) enum ChannelMonitorUpdateStep {
417 LatestHolderCommitmentTXInfo {
418 commitment_tx: HolderCommitmentTransaction,
419 htlc_outputs: Vec<(HTLCOutputInCommitment, Option<Signature>, Option<HTLCSource>)>,
421 LatestCounterpartyCommitmentTXInfo {
422 commitment_txid: Txid,
423 htlc_outputs: Vec<(HTLCOutputInCommitment, Option<Box<HTLCSource>>)>,
424 commitment_number: u64,
425 their_revocation_point: PublicKey,
428 payment_preimage: PaymentPreimage,
434 /// Used to indicate that the no future updates will occur, and likely that the latest holder
435 /// commitment transaction(s) should be broadcast, as the channel has been force-closed.
437 /// If set to false, we shouldn't broadcast the latest holder commitment transaction as we
438 /// think we've fallen behind!
439 should_broadcast: bool,
443 impl_writeable_tlv_based_enum!(ChannelMonitorUpdateStep,
444 (0, LatestHolderCommitmentTXInfo) => {
445 (0, commitment_tx, required),
446 (2, htlc_outputs, vec_type),
448 (1, LatestCounterpartyCommitmentTXInfo) => {
449 (0, commitment_txid, required),
450 (2, commitment_number, required),
451 (4, their_revocation_point, required),
452 (6, htlc_outputs, vec_type),
454 (2, PaymentPreimage) => {
455 (0, payment_preimage, required),
457 (3, CommitmentSecret) => {
459 (2, secret, required),
461 (4, ChannelForceClosed) => {
462 (0, should_broadcast, required),
466 /// A ChannelMonitor handles chain events (blocks connected and disconnected) and generates
467 /// on-chain transactions to ensure no loss of funds occurs.
469 /// You MUST ensure that no ChannelMonitors for a given channel anywhere contain out-of-date
470 /// information and are actively monitoring the chain.
472 /// Pending Events or updated HTLCs which have not yet been read out by
473 /// get_and_clear_pending_monitor_events or get_and_clear_pending_events are serialized to disk and
474 /// reloaded at deserialize-time. Thus, you must ensure that, when handling events, all events
475 /// gotten are fully handled before re-serializing the new state.
477 /// Note that the deserializer is only implemented for (BlockHash, ChannelMonitor), which
478 /// tells you the last block hash which was block_connect()ed. You MUST rescan any blocks along
479 /// the "reorg path" (ie disconnecting blocks until you find a common ancestor from both the
480 /// returned block hash and the the current chain and then reconnecting blocks to get to the
481 /// best chain) upon deserializing the object!
482 pub struct ChannelMonitor<Signer: Sign> {
484 pub(crate) inner: Mutex<ChannelMonitorImpl<Signer>>,
486 inner: Mutex<ChannelMonitorImpl<Signer>>,
489 pub(crate) struct ChannelMonitorImpl<Signer: Sign> {
490 latest_update_id: u64,
491 commitment_transaction_number_obscure_factor: u64,
493 destination_script: Script,
494 broadcasted_holder_revokable_script: Option<(Script, PublicKey, PublicKey)>,
495 counterparty_payment_script: Script,
496 shutdown_script: Script,
498 channel_keys_id: [u8; 32],
499 holder_revocation_basepoint: PublicKey,
500 funding_info: (OutPoint, Script),
501 current_counterparty_commitment_txid: Option<Txid>,
502 prev_counterparty_commitment_txid: Option<Txid>,
504 counterparty_tx_cache: CounterpartyCommitmentTransaction,
505 funding_redeemscript: Script,
506 channel_value_satoshis: u64,
507 // first is the idx of the first of the two revocation points
508 their_cur_revocation_points: Option<(u64, PublicKey, Option<PublicKey>)>,
510 on_holder_tx_csv: u16,
512 commitment_secrets: CounterpartyCommitmentSecrets,
513 counterparty_claimable_outpoints: HashMap<Txid, Vec<(HTLCOutputInCommitment, Option<Box<HTLCSource>>)>>,
514 /// We cannot identify HTLC-Success or HTLC-Timeout transactions by themselves on the chain.
515 /// Nor can we figure out their commitment numbers without the commitment transaction they are
516 /// spending. Thus, in order to claim them via revocation key, we track all the counterparty
517 /// commitment transactions which we find on-chain, mapping them to the commitment number which
518 /// can be used to derive the revocation key and claim the transactions.
519 counterparty_commitment_txn_on_chain: HashMap<Txid, u64>,
520 /// Cache used to make pruning of payment_preimages faster.
521 /// Maps payment_hash values to commitment numbers for counterparty transactions for non-revoked
522 /// counterparty transactions (ie should remain pretty small).
523 /// Serialized to disk but should generally not be sent to Watchtowers.
524 counterparty_hash_commitment_number: HashMap<PaymentHash, u64>,
526 // We store two holder commitment transactions to avoid any race conditions where we may update
527 // some monitors (potentially on watchtowers) but then fail to update others, resulting in the
528 // various monitors for one channel being out of sync, and us broadcasting a holder
529 // transaction for which we have deleted claim information on some watchtowers.
530 prev_holder_signed_commitment_tx: Option<HolderSignedTx>,
531 current_holder_commitment_tx: HolderSignedTx,
533 // Used just for ChannelManager to make sure it has the latest channel data during
535 current_counterparty_commitment_number: u64,
536 // Used just for ChannelManager to make sure it has the latest channel data during
538 current_holder_commitment_number: u64,
540 payment_preimages: HashMap<PaymentHash, PaymentPreimage>,
542 pending_monitor_events: Vec<MonitorEvent>,
543 pending_events: Vec<Event>,
545 // Used to track on-chain events (i.e., transactions part of channels confirmed on chain) on
546 // which to take actions once they reach enough confirmations. Each entry includes the
547 // transaction's id and the height when the transaction was confirmed on chain.
548 onchain_events_awaiting_threshold_conf: Vec<OnchainEventEntry>,
550 // If we get serialized out and re-read, we need to make sure that the chain monitoring
551 // interface knows about the TXOs that we want to be notified of spends of. We could probably
552 // be smart and derive them from the above storage fields, but its much simpler and more
553 // Obviously Correct (tm) if we just keep track of them explicitly.
554 outputs_to_watch: HashMap<Txid, Vec<(u32, Script)>>,
557 pub onchain_tx_handler: OnchainTxHandler<Signer>,
559 onchain_tx_handler: OnchainTxHandler<Signer>,
561 // This is set when the Channel[Manager] generated a ChannelMonitorUpdate which indicated the
562 // channel has been force-closed. After this is set, no further holder commitment transaction
563 // updates may occur, and we panic!() if one is provided.
564 lockdown_from_offchain: bool,
566 // Set once we've signed a holder commitment transaction and handed it over to our
567 // OnchainTxHandler. After this is set, no future updates to our holder commitment transactions
568 // may occur, and we fail any such monitor updates.
570 // In case of update rejection due to a locally already signed commitment transaction, we
571 // nevertheless store update content to track in case of concurrent broadcast by another
572 // remote monitor out-of-order with regards to the block view.
573 holder_tx_signed: bool,
575 // We simply modify best_block in Channel's block_connected so that serialization is
576 // consistent but hopefully the users' copy handles block_connected in a consistent way.
577 // (we do *not*, however, update them in update_monitor to ensure any local user copies keep
578 // their best_block from its state and not based on updated copies that didn't run through
579 // the full block_connected).
580 best_block: BestBlock,
582 secp_ctx: Secp256k1<secp256k1::All>, //TODO: dedup this a bit...
585 /// Transaction outputs to watch for on-chain spends.
586 pub type TransactionOutputs = (Txid, Vec<(u32, TxOut)>);
588 #[cfg(any(test, feature = "fuzztarget", feature = "_test_utils"))]
589 /// Used only in testing and fuzztarget to check serialization roundtrips don't change the
590 /// underlying object
591 impl<Signer: Sign> PartialEq for ChannelMonitor<Signer> {
592 fn eq(&self, other: &Self) -> bool {
593 let inner = self.inner.lock().unwrap();
594 let other = other.inner.lock().unwrap();
599 #[cfg(any(test, feature = "fuzztarget", feature = "_test_utils"))]
600 /// Used only in testing and fuzztarget to check serialization roundtrips don't change the
601 /// underlying object
602 impl<Signer: Sign> PartialEq for ChannelMonitorImpl<Signer> {
603 fn eq(&self, other: &Self) -> bool {
604 if self.latest_update_id != other.latest_update_id ||
605 self.commitment_transaction_number_obscure_factor != other.commitment_transaction_number_obscure_factor ||
606 self.destination_script != other.destination_script ||
607 self.broadcasted_holder_revokable_script != other.broadcasted_holder_revokable_script ||
608 self.counterparty_payment_script != other.counterparty_payment_script ||
609 self.channel_keys_id != other.channel_keys_id ||
610 self.holder_revocation_basepoint != other.holder_revocation_basepoint ||
611 self.funding_info != other.funding_info ||
612 self.current_counterparty_commitment_txid != other.current_counterparty_commitment_txid ||
613 self.prev_counterparty_commitment_txid != other.prev_counterparty_commitment_txid ||
614 self.counterparty_tx_cache != other.counterparty_tx_cache ||
615 self.funding_redeemscript != other.funding_redeemscript ||
616 self.channel_value_satoshis != other.channel_value_satoshis ||
617 self.their_cur_revocation_points != other.their_cur_revocation_points ||
618 self.on_holder_tx_csv != other.on_holder_tx_csv ||
619 self.commitment_secrets != other.commitment_secrets ||
620 self.counterparty_claimable_outpoints != other.counterparty_claimable_outpoints ||
621 self.counterparty_commitment_txn_on_chain != other.counterparty_commitment_txn_on_chain ||
622 self.counterparty_hash_commitment_number != other.counterparty_hash_commitment_number ||
623 self.prev_holder_signed_commitment_tx != other.prev_holder_signed_commitment_tx ||
624 self.current_counterparty_commitment_number != other.current_counterparty_commitment_number ||
625 self.current_holder_commitment_number != other.current_holder_commitment_number ||
626 self.current_holder_commitment_tx != other.current_holder_commitment_tx ||
627 self.payment_preimages != other.payment_preimages ||
628 self.pending_monitor_events != other.pending_monitor_events ||
629 self.pending_events.len() != other.pending_events.len() || // We trust events to round-trip properly
630 self.onchain_events_awaiting_threshold_conf != other.onchain_events_awaiting_threshold_conf ||
631 self.outputs_to_watch != other.outputs_to_watch ||
632 self.lockdown_from_offchain != other.lockdown_from_offchain ||
633 self.holder_tx_signed != other.holder_tx_signed
642 impl<Signer: Sign> Writeable for ChannelMonitor<Signer> {
643 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), Error> {
644 self.inner.lock().unwrap().write(writer)
648 // These are also used for ChannelMonitorUpdate, above.
649 const SERIALIZATION_VERSION: u8 = 1;
650 const MIN_SERIALIZATION_VERSION: u8 = 1;
652 impl<Signer: Sign> Writeable for ChannelMonitorImpl<Signer> {
653 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), Error> {
654 write_ver_prefix!(writer, SERIALIZATION_VERSION, MIN_SERIALIZATION_VERSION);
656 self.latest_update_id.write(writer)?;
658 // Set in initial Channel-object creation, so should always be set by now:
659 U48(self.commitment_transaction_number_obscure_factor).write(writer)?;
661 self.destination_script.write(writer)?;
662 if let Some(ref broadcasted_holder_revokable_script) = self.broadcasted_holder_revokable_script {
663 writer.write_all(&[0; 1])?;
664 broadcasted_holder_revokable_script.0.write(writer)?;
665 broadcasted_holder_revokable_script.1.write(writer)?;
666 broadcasted_holder_revokable_script.2.write(writer)?;
668 writer.write_all(&[1; 1])?;
671 self.counterparty_payment_script.write(writer)?;
672 self.shutdown_script.write(writer)?;
674 self.channel_keys_id.write(writer)?;
675 self.holder_revocation_basepoint.write(writer)?;
676 writer.write_all(&self.funding_info.0.txid[..])?;
677 writer.write_all(&byte_utils::be16_to_array(self.funding_info.0.index))?;
678 self.funding_info.1.write(writer)?;
679 self.current_counterparty_commitment_txid.write(writer)?;
680 self.prev_counterparty_commitment_txid.write(writer)?;
682 self.counterparty_tx_cache.write(writer)?;
683 self.funding_redeemscript.write(writer)?;
684 self.channel_value_satoshis.write(writer)?;
686 match self.their_cur_revocation_points {
687 Some((idx, pubkey, second_option)) => {
688 writer.write_all(&byte_utils::be48_to_array(idx))?;
689 writer.write_all(&pubkey.serialize())?;
690 match second_option {
691 Some(second_pubkey) => {
692 writer.write_all(&second_pubkey.serialize())?;
695 writer.write_all(&[0; 33])?;
700 writer.write_all(&byte_utils::be48_to_array(0))?;
704 writer.write_all(&byte_utils::be16_to_array(self.on_holder_tx_csv))?;
706 self.commitment_secrets.write(writer)?;
708 macro_rules! serialize_htlc_in_commitment {
709 ($htlc_output: expr) => {
710 writer.write_all(&[$htlc_output.offered as u8; 1])?;
711 writer.write_all(&byte_utils::be64_to_array($htlc_output.amount_msat))?;
712 writer.write_all(&byte_utils::be32_to_array($htlc_output.cltv_expiry))?;
713 writer.write_all(&$htlc_output.payment_hash.0[..])?;
714 $htlc_output.transaction_output_index.write(writer)?;
718 writer.write_all(&byte_utils::be64_to_array(self.counterparty_claimable_outpoints.len() as u64))?;
719 for (ref txid, ref htlc_infos) in self.counterparty_claimable_outpoints.iter() {
720 writer.write_all(&txid[..])?;
721 writer.write_all(&byte_utils::be64_to_array(htlc_infos.len() as u64))?;
722 for &(ref htlc_output, ref htlc_source) in htlc_infos.iter() {
723 serialize_htlc_in_commitment!(htlc_output);
724 htlc_source.as_ref().map(|b| b.as_ref()).write(writer)?;
728 writer.write_all(&byte_utils::be64_to_array(self.counterparty_commitment_txn_on_chain.len() as u64))?;
729 for (ref txid, commitment_number) in self.counterparty_commitment_txn_on_chain.iter() {
730 writer.write_all(&txid[..])?;
731 writer.write_all(&byte_utils::be48_to_array(*commitment_number))?;
734 writer.write_all(&byte_utils::be64_to_array(self.counterparty_hash_commitment_number.len() as u64))?;
735 for (ref payment_hash, commitment_number) in self.counterparty_hash_commitment_number.iter() {
736 writer.write_all(&payment_hash.0[..])?;
737 writer.write_all(&byte_utils::be48_to_array(*commitment_number))?;
740 if let Some(ref prev_holder_tx) = self.prev_holder_signed_commitment_tx {
741 writer.write_all(&[1; 1])?;
742 prev_holder_tx.write(writer)?;
744 writer.write_all(&[0; 1])?;
747 self.current_holder_commitment_tx.write(writer)?;
749 writer.write_all(&byte_utils::be48_to_array(self.current_counterparty_commitment_number))?;
750 writer.write_all(&byte_utils::be48_to_array(self.current_holder_commitment_number))?;
752 writer.write_all(&byte_utils::be64_to_array(self.payment_preimages.len() as u64))?;
753 for payment_preimage in self.payment_preimages.values() {
754 writer.write_all(&payment_preimage.0[..])?;
757 writer.write_all(&byte_utils::be64_to_array(self.pending_monitor_events.len() as u64))?;
758 for event in self.pending_monitor_events.iter() {
760 MonitorEvent::HTLCEvent(upd) => {
764 MonitorEvent::CommitmentTxBroadcasted(_) => 1u8.write(writer)?
768 writer.write_all(&byte_utils::be64_to_array(self.pending_events.len() as u64))?;
769 for event in self.pending_events.iter() {
770 event.write(writer)?;
773 self.best_block.block_hash().write(writer)?;
774 writer.write_all(&byte_utils::be32_to_array(self.best_block.height()))?;
776 writer.write_all(&byte_utils::be64_to_array(self.onchain_events_awaiting_threshold_conf.len() as u64))?;
777 for ref entry in self.onchain_events_awaiting_threshold_conf.iter() {
778 entry.write(writer)?;
781 (self.outputs_to_watch.len() as u64).write(writer)?;
782 for (txid, idx_scripts) in self.outputs_to_watch.iter() {
784 (idx_scripts.len() as u64).write(writer)?;
785 for (idx, script) in idx_scripts.iter() {
787 script.write(writer)?;
790 self.onchain_tx_handler.write(writer)?;
792 self.lockdown_from_offchain.write(writer)?;
793 self.holder_tx_signed.write(writer)?;
795 write_tlv_fields!(writer, {});
801 impl<Signer: Sign> ChannelMonitor<Signer> {
802 pub(crate) fn new(secp_ctx: Secp256k1<secp256k1::All>, keys: Signer, shutdown_pubkey: &PublicKey,
803 on_counterparty_tx_csv: u16, destination_script: &Script, funding_info: (OutPoint, Script),
804 channel_parameters: &ChannelTransactionParameters,
805 funding_redeemscript: Script, channel_value_satoshis: u64,
806 commitment_transaction_number_obscure_factor: u64,
807 initial_holder_commitment_tx: HolderCommitmentTransaction,
808 best_block: BestBlock) -> ChannelMonitor<Signer> {
810 assert!(commitment_transaction_number_obscure_factor <= (1 << 48));
811 let our_channel_close_key_hash = WPubkeyHash::hash(&shutdown_pubkey.serialize());
812 let shutdown_script = Builder::new().push_opcode(opcodes::all::OP_PUSHBYTES_0).push_slice(&our_channel_close_key_hash[..]).into_script();
813 let payment_key_hash = WPubkeyHash::hash(&keys.pubkeys().payment_point.serialize());
814 let counterparty_payment_script = Builder::new().push_opcode(opcodes::all::OP_PUSHBYTES_0).push_slice(&payment_key_hash[..]).into_script();
816 let counterparty_channel_parameters = channel_parameters.counterparty_parameters.as_ref().unwrap();
817 let counterparty_delayed_payment_base_key = counterparty_channel_parameters.pubkeys.delayed_payment_basepoint;
818 let counterparty_htlc_base_key = counterparty_channel_parameters.pubkeys.htlc_basepoint;
819 let counterparty_tx_cache = CounterpartyCommitmentTransaction { counterparty_delayed_payment_base_key, counterparty_htlc_base_key, on_counterparty_tx_csv, per_htlc: HashMap::new() };
821 let channel_keys_id = keys.channel_keys_id();
822 let holder_revocation_basepoint = keys.pubkeys().revocation_basepoint;
824 // block for Rust 1.34 compat
825 let (holder_commitment_tx, current_holder_commitment_number) = {
826 let trusted_tx = initial_holder_commitment_tx.trust();
827 let txid = trusted_tx.txid();
829 let tx_keys = trusted_tx.keys();
830 let holder_commitment_tx = HolderSignedTx {
832 revocation_key: tx_keys.revocation_key,
833 a_htlc_key: tx_keys.broadcaster_htlc_key,
834 b_htlc_key: tx_keys.countersignatory_htlc_key,
835 delayed_payment_key: tx_keys.broadcaster_delayed_payment_key,
836 per_commitment_point: tx_keys.per_commitment_point,
837 feerate_per_kw: trusted_tx.feerate_per_kw(),
838 htlc_outputs: Vec::new(), // There are never any HTLCs in the initial commitment transactions
840 (holder_commitment_tx, trusted_tx.commitment_number())
843 let onchain_tx_handler =
844 OnchainTxHandler::new(destination_script.clone(), keys,
845 channel_parameters.clone(), initial_holder_commitment_tx, secp_ctx.clone());
847 let mut outputs_to_watch = HashMap::new();
848 outputs_to_watch.insert(funding_info.0.txid, vec![(funding_info.0.index as u32, funding_info.1.clone())]);
851 inner: Mutex::new(ChannelMonitorImpl {
853 commitment_transaction_number_obscure_factor,
855 destination_script: destination_script.clone(),
856 broadcasted_holder_revokable_script: None,
857 counterparty_payment_script,
861 holder_revocation_basepoint,
863 current_counterparty_commitment_txid: None,
864 prev_counterparty_commitment_txid: None,
866 counterparty_tx_cache,
867 funding_redeemscript,
868 channel_value_satoshis,
869 their_cur_revocation_points: None,
871 on_holder_tx_csv: counterparty_channel_parameters.selected_contest_delay,
873 commitment_secrets: CounterpartyCommitmentSecrets::new(),
874 counterparty_claimable_outpoints: HashMap::new(),
875 counterparty_commitment_txn_on_chain: HashMap::new(),
876 counterparty_hash_commitment_number: HashMap::new(),
878 prev_holder_signed_commitment_tx: None,
879 current_holder_commitment_tx: holder_commitment_tx,
880 current_counterparty_commitment_number: 1 << 48,
881 current_holder_commitment_number,
883 payment_preimages: HashMap::new(),
884 pending_monitor_events: Vec::new(),
885 pending_events: Vec::new(),
887 onchain_events_awaiting_threshold_conf: Vec::new(),
892 lockdown_from_offchain: false,
893 holder_tx_signed: false,
903 fn provide_secret(&self, idx: u64, secret: [u8; 32]) -> Result<(), MonitorUpdateError> {
904 self.inner.lock().unwrap().provide_secret(idx, secret)
907 /// Informs this monitor of the latest counterparty (ie non-broadcastable) commitment transaction.
908 /// The monitor watches for it to be broadcasted and then uses the HTLC information (and
909 /// possibly future revocation/preimage information) to claim outputs where possible.
910 /// We cache also the mapping hash:commitment number to lighten pruning of old preimages by watchtowers.
911 pub(crate) fn provide_latest_counterparty_commitment_tx<L: Deref>(
914 htlc_outputs: Vec<(HTLCOutputInCommitment, Option<Box<HTLCSource>>)>,
915 commitment_number: u64,
916 their_revocation_point: PublicKey,
918 ) where L::Target: Logger {
919 self.inner.lock().unwrap().provide_latest_counterparty_commitment_tx(
920 txid, htlc_outputs, commitment_number, their_revocation_point, logger)
924 fn provide_latest_holder_commitment_tx(
926 holder_commitment_tx: HolderCommitmentTransaction,
927 htlc_outputs: Vec<(HTLCOutputInCommitment, Option<Signature>, Option<HTLCSource>)>,
928 ) -> Result<(), MonitorUpdateError> {
929 self.inner.lock().unwrap().provide_latest_holder_commitment_tx(
930 holder_commitment_tx, htlc_outputs)
934 pub(crate) fn provide_payment_preimage<B: Deref, F: Deref, L: Deref>(
936 payment_hash: &PaymentHash,
937 payment_preimage: &PaymentPreimage,
942 B::Target: BroadcasterInterface,
943 F::Target: FeeEstimator,
946 self.inner.lock().unwrap().provide_payment_preimage(
947 payment_hash, payment_preimage, broadcaster, fee_estimator, logger)
950 pub(crate) fn broadcast_latest_holder_commitment_txn<B: Deref, L: Deref>(
955 B::Target: BroadcasterInterface,
958 self.inner.lock().unwrap().broadcast_latest_holder_commitment_txn(broadcaster, logger)
961 /// Updates a ChannelMonitor on the basis of some new information provided by the Channel
964 /// panics if the given update is not the next update by update_id.
965 pub fn update_monitor<B: Deref, F: Deref, L: Deref>(
967 updates: &ChannelMonitorUpdate,
971 ) -> Result<(), MonitorUpdateError>
973 B::Target: BroadcasterInterface,
974 F::Target: FeeEstimator,
977 self.inner.lock().unwrap().update_monitor(updates, broadcaster, fee_estimator, logger)
980 /// Gets the update_id from the latest ChannelMonitorUpdate which was applied to this
982 pub fn get_latest_update_id(&self) -> u64 {
983 self.inner.lock().unwrap().get_latest_update_id()
986 /// Gets the funding transaction outpoint of the channel this ChannelMonitor is monitoring for.
987 pub fn get_funding_txo(&self) -> (OutPoint, Script) {
988 self.inner.lock().unwrap().get_funding_txo().clone()
991 /// Gets a list of txids, with their output scripts (in the order they appear in the
992 /// transaction), which we must learn about spends of via block_connected().
993 pub fn get_outputs_to_watch(&self) -> Vec<(Txid, Vec<(u32, Script)>)> {
994 self.inner.lock().unwrap().get_outputs_to_watch()
995 .iter().map(|(txid, outputs)| (*txid, outputs.clone())).collect()
998 /// Loads the funding txo and outputs to watch into the given `chain::Filter` by repeatedly
999 /// calling `chain::Filter::register_output` and `chain::Filter::register_tx` until all outputs
1000 /// have been registered.
1001 pub fn load_outputs_to_watch<F: Deref>(&self, filter: &F) where F::Target: chain::Filter {
1002 let lock = self.inner.lock().unwrap();
1003 filter.register_tx(&lock.get_funding_txo().0.txid, &lock.get_funding_txo().1);
1004 for (txid, outputs) in lock.get_outputs_to_watch().iter() {
1005 for (index, script_pubkey) in outputs.iter() {
1006 assert!(*index <= u16::max_value() as u32);
1007 filter.register_output(WatchedOutput {
1009 outpoint: OutPoint { txid: *txid, index: *index as u16 },
1010 script_pubkey: script_pubkey.clone(),
1016 /// Get the list of HTLCs who's status has been updated on chain. This should be called by
1017 /// ChannelManager via [`chain::Watch::release_pending_monitor_events`].
1018 pub fn get_and_clear_pending_monitor_events(&self) -> Vec<MonitorEvent> {
1019 self.inner.lock().unwrap().get_and_clear_pending_monitor_events()
1022 /// Gets the list of pending events which were generated by previous actions, clearing the list
1025 /// This is called by ChainMonitor::get_and_clear_pending_events() and is equivalent to
1026 /// EventsProvider::get_and_clear_pending_events() except that it requires &mut self as we do
1027 /// no internal locking in ChannelMonitors.
1028 pub fn get_and_clear_pending_events(&self) -> Vec<Event> {
1029 self.inner.lock().unwrap().get_and_clear_pending_events()
1032 pub(crate) fn get_min_seen_secret(&self) -> u64 {
1033 self.inner.lock().unwrap().get_min_seen_secret()
1036 pub(crate) fn get_cur_counterparty_commitment_number(&self) -> u64 {
1037 self.inner.lock().unwrap().get_cur_counterparty_commitment_number()
1040 pub(crate) fn get_cur_holder_commitment_number(&self) -> u64 {
1041 self.inner.lock().unwrap().get_cur_holder_commitment_number()
1044 /// Used by ChannelManager deserialization to broadcast the latest holder state if its copy of
1045 /// the Channel was out-of-date. You may use it to get a broadcastable holder toxic tx in case of
1046 /// fallen-behind, i.e when receiving a channel_reestablish with a proof that our counterparty side knows
1047 /// a higher revocation secret than the holder commitment number we are aware of. Broadcasting these
1048 /// transactions are UNSAFE, as they allow counterparty side to punish you. Nevertheless you may want to
1049 /// broadcast them if counterparty don't close channel with his higher commitment transaction after a
1050 /// substantial amount of time (a month or even a year) to get back funds. Best may be to contact
1051 /// out-of-band the other node operator to coordinate with him if option is available to you.
1052 /// In any-case, choice is up to the user.
1053 pub fn get_latest_holder_commitment_txn<L: Deref>(&self, logger: &L) -> Vec<Transaction>
1054 where L::Target: Logger {
1055 self.inner.lock().unwrap().get_latest_holder_commitment_txn(logger)
1058 /// Unsafe test-only version of get_latest_holder_commitment_txn used by our test framework
1059 /// to bypass HolderCommitmentTransaction state update lockdown after signature and generate
1060 /// revoked commitment transaction.
1061 #[cfg(any(test, feature = "unsafe_revoked_tx_signing"))]
1062 pub fn unsafe_get_latest_holder_commitment_txn<L: Deref>(&self, logger: &L) -> Vec<Transaction>
1063 where L::Target: Logger {
1064 self.inner.lock().unwrap().unsafe_get_latest_holder_commitment_txn(logger)
1067 /// Processes transactions in a newly connected block, which may result in any of the following:
1068 /// - update the monitor's state against resolved HTLCs
1069 /// - punish the counterparty in the case of seeing a revoked commitment transaction
1070 /// - force close the channel and claim/timeout incoming/outgoing HTLCs if near expiration
1071 /// - detect settled outputs for later spending
1072 /// - schedule and bump any in-flight claims
1074 /// Returns any new outputs to watch from `txdata`; after called, these are also included in
1075 /// [`get_outputs_to_watch`].
1077 /// [`get_outputs_to_watch`]: #method.get_outputs_to_watch
1078 pub fn block_connected<B: Deref, F: Deref, L: Deref>(
1080 header: &BlockHeader,
1081 txdata: &TransactionData,
1086 ) -> Vec<TransactionOutputs>
1088 B::Target: BroadcasterInterface,
1089 F::Target: FeeEstimator,
1092 self.inner.lock().unwrap().block_connected(
1093 header, txdata, height, broadcaster, fee_estimator, logger)
1096 /// Determines if the disconnected block contained any transactions of interest and updates
1098 pub fn block_disconnected<B: Deref, F: Deref, L: Deref>(
1100 header: &BlockHeader,
1106 B::Target: BroadcasterInterface,
1107 F::Target: FeeEstimator,
1110 self.inner.lock().unwrap().block_disconnected(
1111 header, height, broadcaster, fee_estimator, logger)
1114 /// Processes transactions confirmed in a block with the given header and height, returning new
1115 /// outputs to watch. See [`block_connected`] for details.
1117 /// Used instead of [`block_connected`] by clients that are notified of transactions rather than
1118 /// blocks. See [`chain::Confirm`] for calling expectations.
1120 /// [`block_connected`]: Self::block_connected
1121 pub fn transactions_confirmed<B: Deref, F: Deref, L: Deref>(
1123 header: &BlockHeader,
1124 txdata: &TransactionData,
1129 ) -> Vec<TransactionOutputs>
1131 B::Target: BroadcasterInterface,
1132 F::Target: FeeEstimator,
1135 self.inner.lock().unwrap().transactions_confirmed(
1136 header, txdata, height, broadcaster, fee_estimator, logger)
1139 /// Processes a transaction that was reorganized out of the chain.
1141 /// Used instead of [`block_disconnected`] by clients that are notified of transactions rather
1142 /// than blocks. See [`chain::Confirm`] for calling expectations.
1144 /// [`block_disconnected`]: Self::block_disconnected
1145 pub fn transaction_unconfirmed<B: Deref, F: Deref, L: Deref>(
1152 B::Target: BroadcasterInterface,
1153 F::Target: FeeEstimator,
1156 self.inner.lock().unwrap().transaction_unconfirmed(
1157 txid, broadcaster, fee_estimator, logger);
1160 /// Updates the monitor with the current best chain tip, returning new outputs to watch. See
1161 /// [`block_connected`] for details.
1163 /// Used instead of [`block_connected`] by clients that are notified of transactions rather than
1164 /// blocks. See [`chain::Confirm`] for calling expectations.
1166 /// [`block_connected`]: Self::block_connected
1167 pub fn best_block_updated<B: Deref, F: Deref, L: Deref>(
1169 header: &BlockHeader,
1174 ) -> Vec<TransactionOutputs>
1176 B::Target: BroadcasterInterface,
1177 F::Target: FeeEstimator,
1180 self.inner.lock().unwrap().best_block_updated(
1181 header, height, broadcaster, fee_estimator, logger)
1184 /// Returns the set of txids that should be monitored for re-organization out of the chain.
1185 pub fn get_relevant_txids(&self) -> Vec<Txid> {
1186 let inner = self.inner.lock().unwrap();
1187 let mut txids: Vec<Txid> = inner.onchain_events_awaiting_threshold_conf
1189 .map(|entry| entry.txid)
1190 .chain(inner.onchain_tx_handler.get_relevant_txids().into_iter())
1192 txids.sort_unstable();
1197 /// Gets the latest best block which was connected either via the [`chain::Listen`] or
1198 /// [`chain::Confirm`] interfaces.
1199 pub fn current_best_block(&self) -> BestBlock {
1200 self.inner.lock().unwrap().best_block.clone()
1204 /// Compares a broadcasted commitment transaction's HTLCs with those in the latest state,
1205 /// failing any HTLCs which didn't make it into the broadcasted commitment transaction back
1206 /// after ANTI_REORG_DELAY blocks.
1207 macro_rules! fail_unbroadcast_htlcs {
1208 ($self: expr, $commitment_tx_type: expr, $commitment_tx_conf_height: expr, $confirmed_htlcs_list: expr, $logger: expr) => { {
1209 macro_rules! check_htlc_fails {
1210 ($txid: expr, $commitment_tx: expr) => {
1211 if let Some(ref latest_outpoints) = $self.counterparty_claimable_outpoints.get($txid) {
1212 for &(ref htlc, ref source_option) in latest_outpoints.iter() {
1213 if let &Some(ref source) = source_option {
1214 // Check if the HTLC is present in the commitment transaction that was
1215 // broadcast, but not if it was below the dust limit, which we should
1216 // fail backwards immediately as there is no way for us to learn the
1217 // payment_preimage.
1218 // Note that if the dust limit were allowed to change between
1219 // commitment transactions we'd want to be check whether *any*
1220 // broadcastable commitment transaction has the HTLC in it, but it
1221 // cannot currently change after channel initialization, so we don't
1223 let confirmed_htlcs_iter: &mut Iterator<Item = (&HTLCOutputInCommitment, Option<&HTLCSource>)> = &mut $confirmed_htlcs_list;
1224 let mut matched_htlc = false;
1225 for (ref broadcast_htlc, ref broadcast_source) in confirmed_htlcs_iter {
1226 if broadcast_htlc.transaction_output_index.is_some() && Some(&**source) == *broadcast_source {
1227 matched_htlc = true;
1231 if matched_htlc { continue; }
1232 $self.onchain_events_awaiting_threshold_conf.retain(|ref entry| {
1233 if entry.height != $commitment_tx_conf_height { return true; }
1235 OnchainEvent::HTLCUpdate { source: ref update_source, .. } => {
1236 *update_source != **source
1241 let entry = OnchainEventEntry {
1243 height: $commitment_tx_conf_height,
1244 event: OnchainEvent::HTLCUpdate {
1245 source: (**source).clone(),
1246 payment_hash: htlc.payment_hash.clone(),
1247 onchain_value_satoshis: Some(htlc.amount_msat / 1000),
1250 log_trace!($logger, "Failing HTLC with payment_hash {} from {} counterparty commitment tx due to broadcast of {} commitment transaction, waiting for confirmation (at height {})",
1251 log_bytes!(htlc.payment_hash.0), $commitment_tx, $commitment_tx_type, entry.confirmation_threshold());
1252 $self.onchain_events_awaiting_threshold_conf.push(entry);
1258 if let Some(ref txid) = $self.current_counterparty_commitment_txid {
1259 check_htlc_fails!(txid, "current");
1261 if let Some(ref txid) = $self.prev_counterparty_commitment_txid {
1262 check_htlc_fails!(txid, "previous");
1267 impl<Signer: Sign> ChannelMonitorImpl<Signer> {
1268 /// Inserts a revocation secret into this channel monitor. Prunes old preimages if neither
1269 /// needed by holder commitment transactions HTCLs nor by counterparty ones. Unless we haven't already seen
1270 /// counterparty commitment transaction's secret, they are de facto pruned (we can use revocation key).
1271 fn provide_secret(&mut self, idx: u64, secret: [u8; 32]) -> Result<(), MonitorUpdateError> {
1272 if let Err(()) = self.commitment_secrets.provide_secret(idx, secret) {
1273 return Err(MonitorUpdateError("Previous secret did not match new one"));
1276 // Prune HTLCs from the previous counterparty commitment tx so we don't generate failure/fulfill
1277 // events for now-revoked/fulfilled HTLCs.
1278 if let Some(txid) = self.prev_counterparty_commitment_txid.take() {
1279 for &mut (_, ref mut source) in self.counterparty_claimable_outpoints.get_mut(&txid).unwrap() {
1284 if !self.payment_preimages.is_empty() {
1285 let cur_holder_signed_commitment_tx = &self.current_holder_commitment_tx;
1286 let prev_holder_signed_commitment_tx = self.prev_holder_signed_commitment_tx.as_ref();
1287 let min_idx = self.get_min_seen_secret();
1288 let counterparty_hash_commitment_number = &mut self.counterparty_hash_commitment_number;
1290 self.payment_preimages.retain(|&k, _| {
1291 for &(ref htlc, _, _) in cur_holder_signed_commitment_tx.htlc_outputs.iter() {
1292 if k == htlc.payment_hash {
1296 if let Some(prev_holder_commitment_tx) = prev_holder_signed_commitment_tx {
1297 for &(ref htlc, _, _) in prev_holder_commitment_tx.htlc_outputs.iter() {
1298 if k == htlc.payment_hash {
1303 let contains = if let Some(cn) = counterparty_hash_commitment_number.get(&k) {
1310 counterparty_hash_commitment_number.remove(&k);
1319 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_revocation_point: PublicKey, logger: &L) where L::Target: Logger {
1320 // TODO: Encrypt the htlc_outputs data with the single-hash of the commitment transaction
1321 // so that a remote monitor doesn't learn anything unless there is a malicious close.
1322 // (only maybe, sadly we cant do the same for local info, as we need to be aware of
1324 for &(ref htlc, _) in &htlc_outputs {
1325 self.counterparty_hash_commitment_number.insert(htlc.payment_hash, commitment_number);
1328 log_trace!(logger, "Tracking new counterparty commitment transaction with txid {} at commitment number {} with {} HTLC outputs", txid, commitment_number, htlc_outputs.len());
1329 self.prev_counterparty_commitment_txid = self.current_counterparty_commitment_txid.take();
1330 self.current_counterparty_commitment_txid = Some(txid);
1331 self.counterparty_claimable_outpoints.insert(txid, htlc_outputs.clone());
1332 self.current_counterparty_commitment_number = commitment_number;
1333 //TODO: Merge this into the other per-counterparty-transaction output storage stuff
1334 match self.their_cur_revocation_points {
1335 Some(old_points) => {
1336 if old_points.0 == commitment_number + 1 {
1337 self.their_cur_revocation_points = Some((old_points.0, old_points.1, Some(their_revocation_point)));
1338 } else if old_points.0 == commitment_number + 2 {
1339 if let Some(old_second_point) = old_points.2 {
1340 self.their_cur_revocation_points = Some((old_points.0 - 1, old_second_point, Some(their_revocation_point)));
1342 self.their_cur_revocation_points = Some((commitment_number, their_revocation_point, None));
1345 self.their_cur_revocation_points = Some((commitment_number, their_revocation_point, None));
1349 self.their_cur_revocation_points = Some((commitment_number, their_revocation_point, None));
1352 let mut htlcs = Vec::with_capacity(htlc_outputs.len());
1353 for htlc in htlc_outputs {
1354 if htlc.0.transaction_output_index.is_some() {
1358 self.counterparty_tx_cache.per_htlc.insert(txid, htlcs);
1361 /// Informs this monitor of the latest holder (ie broadcastable) commitment transaction. The
1362 /// monitor watches for timeouts and may broadcast it if we approach such a timeout. Thus, it
1363 /// is important that any clones of this channel monitor (including remote clones) by kept
1364 /// up-to-date as our holder commitment transaction is updated.
1365 /// Panics if set_on_holder_tx_csv has never been called.
1366 fn provide_latest_holder_commitment_tx(&mut self, holder_commitment_tx: HolderCommitmentTransaction, htlc_outputs: Vec<(HTLCOutputInCommitment, Option<Signature>, Option<HTLCSource>)>) -> Result<(), MonitorUpdateError> {
1367 // block for Rust 1.34 compat
1368 let mut new_holder_commitment_tx = {
1369 let trusted_tx = holder_commitment_tx.trust();
1370 let txid = trusted_tx.txid();
1371 let tx_keys = trusted_tx.keys();
1372 self.current_holder_commitment_number = trusted_tx.commitment_number();
1375 revocation_key: tx_keys.revocation_key,
1376 a_htlc_key: tx_keys.broadcaster_htlc_key,
1377 b_htlc_key: tx_keys.countersignatory_htlc_key,
1378 delayed_payment_key: tx_keys.broadcaster_delayed_payment_key,
1379 per_commitment_point: tx_keys.per_commitment_point,
1380 feerate_per_kw: trusted_tx.feerate_per_kw(),
1384 self.onchain_tx_handler.provide_latest_holder_tx(holder_commitment_tx);
1385 mem::swap(&mut new_holder_commitment_tx, &mut self.current_holder_commitment_tx);
1386 self.prev_holder_signed_commitment_tx = Some(new_holder_commitment_tx);
1387 if self.holder_tx_signed {
1388 return Err(MonitorUpdateError("Latest holder commitment signed has already been signed, update is rejected"));
1393 /// Provides a payment_hash->payment_preimage mapping. Will be automatically pruned when all
1394 /// commitment_tx_infos which contain the payment hash have been revoked.
1395 fn provide_payment_preimage<B: Deref, F: Deref, L: Deref>(&mut self, payment_hash: &PaymentHash, payment_preimage: &PaymentPreimage, broadcaster: &B, fee_estimator: &F, logger: &L)
1396 where B::Target: BroadcasterInterface,
1397 F::Target: FeeEstimator,
1400 self.payment_preimages.insert(payment_hash.clone(), payment_preimage.clone());
1402 // If the channel is force closed, try to claim the output from this preimage.
1403 // First check if a counterparty commitment transaction has been broadcasted:
1404 macro_rules! claim_htlcs {
1405 ($commitment_number: expr, $txid: expr) => {
1406 let htlc_claim_reqs = self.get_counterparty_htlc_output_claim_reqs($commitment_number, $txid, None);
1407 self.onchain_tx_handler.update_claims_view(&Vec::new(), htlc_claim_reqs, self.best_block.height(), self.best_block.height(), broadcaster, fee_estimator, logger);
1410 if let Some(txid) = self.current_counterparty_commitment_txid {
1411 if let Some(commitment_number) = self.counterparty_commitment_txn_on_chain.get(&txid) {
1412 claim_htlcs!(*commitment_number, txid);
1416 if let Some(txid) = self.prev_counterparty_commitment_txid {
1417 if let Some(commitment_number) = self.counterparty_commitment_txn_on_chain.get(&txid) {
1418 claim_htlcs!(*commitment_number, txid);
1423 // Then if a holder commitment transaction has been seen on-chain, broadcast transactions
1424 // claiming the HTLC output from each of the holder commitment transactions.
1425 // Note that we can't just use `self.holder_tx_signed`, because that only covers the case where
1426 // *we* sign a holder commitment transaction, not when e.g. a watchtower broadcasts one of our
1427 // holder commitment transactions.
1428 if self.broadcasted_holder_revokable_script.is_some() {
1429 // Assume that the broadcasted commitment transaction confirmed in the current best
1430 // block. Even if not, its a reasonable metric for the bump criteria on the HTLC
1432 let (claim_reqs, _) = self.get_broadcasted_holder_claims(&self.current_holder_commitment_tx, self.best_block.height());
1433 self.onchain_tx_handler.update_claims_view(&Vec::new(), claim_reqs, self.best_block.height(), self.best_block.height(), broadcaster, fee_estimator, logger);
1434 if let Some(ref tx) = self.prev_holder_signed_commitment_tx {
1435 let (claim_reqs, _) = self.get_broadcasted_holder_claims(&tx, self.best_block.height());
1436 self.onchain_tx_handler.update_claims_view(&Vec::new(), claim_reqs, self.best_block.height(), self.best_block.height(), broadcaster, fee_estimator, logger);
1441 pub(crate) fn broadcast_latest_holder_commitment_txn<B: Deref, L: Deref>(&mut self, broadcaster: &B, logger: &L)
1442 where B::Target: BroadcasterInterface,
1445 for tx in self.get_latest_holder_commitment_txn(logger).iter() {
1446 log_info!(logger, "Broadcasting local {}", log_tx!(tx));
1447 broadcaster.broadcast_transaction(tx);
1449 self.pending_monitor_events.push(MonitorEvent::CommitmentTxBroadcasted(self.funding_info.0));
1452 pub fn update_monitor<B: Deref, F: Deref, L: Deref>(&mut self, updates: &ChannelMonitorUpdate, broadcaster: &B, fee_estimator: &F, logger: &L) -> Result<(), MonitorUpdateError>
1453 where B::Target: BroadcasterInterface,
1454 F::Target: FeeEstimator,
1457 // ChannelMonitor updates may be applied after force close if we receive a
1458 // preimage for a broadcasted commitment transaction HTLC output that we'd
1459 // like to claim on-chain. If this is the case, we no longer have guaranteed
1460 // access to the monitor's update ID, so we use a sentinel value instead.
1461 if updates.update_id == CLOSED_CHANNEL_UPDATE_ID {
1462 match updates.updates[0] {
1463 ChannelMonitorUpdateStep::PaymentPreimage { .. } => {},
1464 _ => panic!("Attempted to apply post-force-close ChannelMonitorUpdate that wasn't providing a payment preimage"),
1466 assert_eq!(updates.updates.len(), 1);
1467 } else if self.latest_update_id + 1 != updates.update_id {
1468 panic!("Attempted to apply ChannelMonitorUpdates out of order, check the update_id before passing an update to update_monitor!");
1470 for update in updates.updates.iter() {
1472 ChannelMonitorUpdateStep::LatestHolderCommitmentTXInfo { commitment_tx, htlc_outputs } => {
1473 log_trace!(logger, "Updating ChannelMonitor with latest holder commitment transaction info");
1474 if self.lockdown_from_offchain { panic!(); }
1475 self.provide_latest_holder_commitment_tx(commitment_tx.clone(), htlc_outputs.clone())?
1477 ChannelMonitorUpdateStep::LatestCounterpartyCommitmentTXInfo { commitment_txid, htlc_outputs, commitment_number, their_revocation_point } => {
1478 log_trace!(logger, "Updating ChannelMonitor with latest counterparty commitment transaction info");
1479 self.provide_latest_counterparty_commitment_tx(*commitment_txid, htlc_outputs.clone(), *commitment_number, *their_revocation_point, logger)
1481 ChannelMonitorUpdateStep::PaymentPreimage { payment_preimage } => {
1482 log_trace!(logger, "Updating ChannelMonitor with payment preimage");
1483 self.provide_payment_preimage(&PaymentHash(Sha256::hash(&payment_preimage.0[..]).into_inner()), &payment_preimage, broadcaster, fee_estimator, logger)
1485 ChannelMonitorUpdateStep::CommitmentSecret { idx, secret } => {
1486 log_trace!(logger, "Updating ChannelMonitor with commitment secret");
1487 self.provide_secret(*idx, *secret)?
1489 ChannelMonitorUpdateStep::ChannelForceClosed { should_broadcast } => {
1490 log_trace!(logger, "Updating ChannelMonitor: channel force closed, should broadcast: {}", should_broadcast);
1491 self.lockdown_from_offchain = true;
1492 if *should_broadcast {
1493 self.broadcast_latest_holder_commitment_txn(broadcaster, logger);
1494 } else if !self.holder_tx_signed {
1495 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");
1497 // If we generated a MonitorEvent::CommitmentTxBroadcasted, the ChannelManager
1498 // will still give us a ChannelForceClosed event with !should_broadcast, but we
1499 // shouldn't print the scary warning above.
1500 log_info!(logger, "Channel off-chain state closed after we broadcasted our latest commitment transaction.");
1505 self.latest_update_id = updates.update_id;
1509 pub fn get_latest_update_id(&self) -> u64 {
1510 self.latest_update_id
1513 pub fn get_funding_txo(&self) -> &(OutPoint, Script) {
1517 pub fn get_outputs_to_watch(&self) -> &HashMap<Txid, Vec<(u32, Script)>> {
1518 // If we've detected a counterparty commitment tx on chain, we must include it in the set
1519 // of outputs to watch for spends of, otherwise we're likely to lose user funds. Because
1520 // its trivial to do, double-check that here.
1521 for (txid, _) in self.counterparty_commitment_txn_on_chain.iter() {
1522 self.outputs_to_watch.get(txid).expect("Counterparty commitment txn which have been broadcast should have outputs registered");
1524 &self.outputs_to_watch
1527 pub fn get_and_clear_pending_monitor_events(&mut self) -> Vec<MonitorEvent> {
1528 let mut ret = Vec::new();
1529 mem::swap(&mut ret, &mut self.pending_monitor_events);
1533 pub fn get_and_clear_pending_events(&mut self) -> Vec<Event> {
1534 let mut ret = Vec::new();
1535 mem::swap(&mut ret, &mut self.pending_events);
1539 /// Can only fail if idx is < get_min_seen_secret
1540 fn get_secret(&self, idx: u64) -> Option<[u8; 32]> {
1541 self.commitment_secrets.get_secret(idx)
1544 pub(crate) fn get_min_seen_secret(&self) -> u64 {
1545 self.commitment_secrets.get_min_seen_secret()
1548 pub(crate) fn get_cur_counterparty_commitment_number(&self) -> u64 {
1549 self.current_counterparty_commitment_number
1552 pub(crate) fn get_cur_holder_commitment_number(&self) -> u64 {
1553 self.current_holder_commitment_number
1556 /// Attempts to claim a counterparty commitment transaction's outputs using the revocation key and
1557 /// data in counterparty_claimable_outpoints. Will directly claim any HTLC outputs which expire at a
1558 /// height > height + CLTV_SHARED_CLAIM_BUFFER. In any case, will install monitoring for
1559 /// HTLC-Success/HTLC-Timeout transactions.
1560 /// Return updates for HTLC pending in the channel and failed automatically by the broadcast of
1561 /// revoked counterparty commitment tx
1562 fn check_spend_counterparty_transaction<L: Deref>(&mut self, tx: &Transaction, height: u32, logger: &L) -> (Vec<PackageTemplate>, TransactionOutputs) where L::Target: Logger {
1563 // Most secp and related errors trying to create keys means we have no hope of constructing
1564 // a spend transaction...so we return no transactions to broadcast
1565 let mut claimable_outpoints = Vec::new();
1566 let mut watch_outputs = Vec::new();
1568 let commitment_txid = tx.txid(); //TODO: This is gonna be a performance bottleneck for watchtowers!
1569 let per_commitment_option = self.counterparty_claimable_outpoints.get(&commitment_txid);
1571 macro_rules! ignore_error {
1572 ( $thing : expr ) => {
1575 Err(_) => return (claimable_outpoints, (commitment_txid, watch_outputs))
1580 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);
1581 if commitment_number >= self.get_min_seen_secret() {
1582 let secret = self.get_secret(commitment_number).unwrap();
1583 let per_commitment_key = ignore_error!(SecretKey::from_slice(&secret));
1584 let per_commitment_point = PublicKey::from_secret_key(&self.secp_ctx, &per_commitment_key);
1585 let revocation_pubkey = ignore_error!(chan_utils::derive_public_revocation_key(&self.secp_ctx, &per_commitment_point, &self.holder_revocation_basepoint));
1586 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_tx_cache.counterparty_delayed_payment_base_key));
1588 let revokeable_redeemscript = chan_utils::get_revokeable_redeemscript(&revocation_pubkey, self.counterparty_tx_cache.on_counterparty_tx_csv, &delayed_key);
1589 let revokeable_p2wsh = revokeable_redeemscript.to_v0_p2wsh();
1591 // First, process non-htlc outputs (to_holder & to_counterparty)
1592 for (idx, outp) in tx.output.iter().enumerate() {
1593 if outp.script_pubkey == revokeable_p2wsh {
1594 let revk_outp = RevokedOutput::build(per_commitment_point, self.counterparty_tx_cache.counterparty_delayed_payment_base_key, self.counterparty_tx_cache.counterparty_htlc_base_key, per_commitment_key, outp.value, self.counterparty_tx_cache.on_counterparty_tx_csv);
1595 let justice_package = PackageTemplate::build_package(commitment_txid, idx as u32, PackageSolvingData::RevokedOutput(revk_outp), height + self.counterparty_tx_cache.on_counterparty_tx_csv as u32, true, height);
1596 claimable_outpoints.push(justice_package);
1600 // Then, try to find revoked htlc outputs
1601 if let Some(ref per_commitment_data) = per_commitment_option {
1602 for (_, &(ref htlc, _)) in per_commitment_data.iter().enumerate() {
1603 if let Some(transaction_output_index) = htlc.transaction_output_index {
1604 if transaction_output_index as usize >= tx.output.len() ||
1605 tx.output[transaction_output_index as usize].value != htlc.amount_msat / 1000 {
1606 return (claimable_outpoints, (commitment_txid, watch_outputs)); // Corrupted per_commitment_data, fuck this user
1608 let revk_htlc_outp = RevokedHTLCOutput::build(per_commitment_point, self.counterparty_tx_cache.counterparty_delayed_payment_base_key, self.counterparty_tx_cache.counterparty_htlc_base_key, per_commitment_key, htlc.amount_msat / 1000, htlc.clone());
1609 let justice_package = PackageTemplate::build_package(commitment_txid, transaction_output_index, PackageSolvingData::RevokedHTLCOutput(revk_htlc_outp), htlc.cltv_expiry, true, height);
1610 claimable_outpoints.push(justice_package);
1615 // Last, track onchain revoked commitment transaction and fail backward outgoing HTLCs as payment path is broken
1616 if !claimable_outpoints.is_empty() || per_commitment_option.is_some() { // ie we're confident this is actually ours
1617 // We're definitely a counterparty commitment transaction!
1618 log_error!(logger, "Got broadcast of revoked counterparty commitment transaction, going to generate general spend tx with {} inputs", claimable_outpoints.len());
1619 for (idx, outp) in tx.output.iter().enumerate() {
1620 watch_outputs.push((idx as u32, outp.clone()));
1622 self.counterparty_commitment_txn_on_chain.insert(commitment_txid, commitment_number);
1624 fail_unbroadcast_htlcs!(self, "revoked counterparty", height, [].iter().map(|a| *a), logger);
1626 } else if let Some(per_commitment_data) = per_commitment_option {
1627 // While this isn't useful yet, there is a potential race where if a counterparty
1628 // revokes a state at the same time as the commitment transaction for that state is
1629 // confirmed, and the watchtower receives the block before the user, the user could
1630 // upload a new ChannelMonitor with the revocation secret but the watchtower has
1631 // already processed the block, resulting in the counterparty_commitment_txn_on_chain entry
1632 // not being generated by the above conditional. Thus, to be safe, we go ahead and
1634 for (idx, outp) in tx.output.iter().enumerate() {
1635 watch_outputs.push((idx as u32, outp.clone()));
1637 self.counterparty_commitment_txn_on_chain.insert(commitment_txid, commitment_number);
1639 log_info!(logger, "Got broadcast of non-revoked counterparty commitment transaction {}", commitment_txid);
1640 fail_unbroadcast_htlcs!(self, "counterparty", height, per_commitment_data.iter().map(|(a, b)| (a, b.as_ref().map(|b| b.as_ref()))), logger);
1642 let htlc_claim_reqs = self.get_counterparty_htlc_output_claim_reqs(commitment_number, commitment_txid, Some(tx));
1643 for req in htlc_claim_reqs {
1644 claimable_outpoints.push(req);
1648 (claimable_outpoints, (commitment_txid, watch_outputs))
1651 fn get_counterparty_htlc_output_claim_reqs(&self, commitment_number: u64, commitment_txid: Txid, tx: Option<&Transaction>) -> Vec<PackageTemplate> {
1652 let mut claimable_outpoints = Vec::new();
1653 if let Some(htlc_outputs) = self.counterparty_claimable_outpoints.get(&commitment_txid) {
1654 if let Some(revocation_points) = self.their_cur_revocation_points {
1655 let revocation_point_option =
1656 // If the counterparty commitment tx is the latest valid state, use their latest
1657 // per-commitment point
1658 if revocation_points.0 == commitment_number { Some(&revocation_points.1) }
1659 else if let Some(point) = revocation_points.2.as_ref() {
1660 // If counterparty commitment tx is the state previous to the latest valid state, use
1661 // their previous per-commitment point (non-atomicity of revocation means it's valid for
1662 // them to temporarily have two valid commitment txns from our viewpoint)
1663 if revocation_points.0 == commitment_number + 1 { Some(point) } else { None }
1665 if let Some(revocation_point) = revocation_point_option {
1666 for (_, &(ref htlc, _)) in htlc_outputs.iter().enumerate() {
1667 if let Some(transaction_output_index) = htlc.transaction_output_index {
1668 if let Some(transaction) = tx {
1669 if transaction_output_index as usize >= transaction.output.len() ||
1670 transaction.output[transaction_output_index as usize].value != htlc.amount_msat / 1000 {
1671 return claimable_outpoints; // Corrupted per_commitment_data, fuck this user
1674 let preimage = if htlc.offered { if let Some(p) = self.payment_preimages.get(&htlc.payment_hash) { Some(*p) } else { None } } else { None };
1675 if preimage.is_some() || !htlc.offered {
1676 let counterparty_htlc_outp = if htlc.offered { PackageSolvingData::CounterpartyOfferedHTLCOutput(CounterpartyOfferedHTLCOutput::build(*revocation_point, self.counterparty_tx_cache.counterparty_delayed_payment_base_key, self.counterparty_tx_cache.counterparty_htlc_base_key, preimage.unwrap(), htlc.clone())) } else { PackageSolvingData::CounterpartyReceivedHTLCOutput(CounterpartyReceivedHTLCOutput::build(*revocation_point, self.counterparty_tx_cache.counterparty_delayed_payment_base_key, self.counterparty_tx_cache.counterparty_htlc_base_key, htlc.clone())) };
1677 let aggregation = if !htlc.offered { false } else { true };
1678 let counterparty_package = PackageTemplate::build_package(commitment_txid, transaction_output_index, counterparty_htlc_outp, htlc.cltv_expiry,aggregation, 0);
1679 claimable_outpoints.push(counterparty_package);
1689 /// Attempts to claim a counterparty HTLC-Success/HTLC-Timeout's outputs using the revocation key
1690 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 {
1691 let htlc_txid = tx.txid();
1692 if tx.input.len() != 1 || tx.output.len() != 1 || tx.input[0].witness.len() != 5 {
1693 return (Vec::new(), None)
1696 macro_rules! ignore_error {
1697 ( $thing : expr ) => {
1700 Err(_) => return (Vec::new(), None)
1705 let secret = if let Some(secret) = self.get_secret(commitment_number) { secret } else { return (Vec::new(), None); };
1706 let per_commitment_key = ignore_error!(SecretKey::from_slice(&secret));
1707 let per_commitment_point = PublicKey::from_secret_key(&self.secp_ctx, &per_commitment_key);
1709 log_error!(logger, "Got broadcast of revoked counterparty HTLC transaction, spending {}:{}", htlc_txid, 0);
1710 let revk_outp = RevokedOutput::build(per_commitment_point, self.counterparty_tx_cache.counterparty_delayed_payment_base_key, self.counterparty_tx_cache.counterparty_htlc_base_key, per_commitment_key, tx.output[0].value, self.counterparty_tx_cache.on_counterparty_tx_csv);
1711 let justice_package = PackageTemplate::build_package(htlc_txid, 0, PackageSolvingData::RevokedOutput(revk_outp), height + self.counterparty_tx_cache.on_counterparty_tx_csv as u32, true, height);
1712 let claimable_outpoints = vec!(justice_package);
1713 let outputs = vec![(0, tx.output[0].clone())];
1714 (claimable_outpoints, Some((htlc_txid, outputs)))
1717 // Returns (1) `PackageTemplate`s that can be given to the OnChainTxHandler, so that the handler can
1718 // broadcast transactions claiming holder HTLC commitment outputs and (2) a holder revokable
1719 // script so we can detect whether a holder transaction has been seen on-chain.
1720 fn get_broadcasted_holder_claims(&self, holder_tx: &HolderSignedTx, conf_height: u32) -> (Vec<PackageTemplate>, Option<(Script, PublicKey, PublicKey)>) {
1721 let mut claim_requests = Vec::with_capacity(holder_tx.htlc_outputs.len());
1723 let redeemscript = chan_utils::get_revokeable_redeemscript(&holder_tx.revocation_key, self.on_holder_tx_csv, &holder_tx.delayed_payment_key);
1724 let broadcasted_holder_revokable_script = Some((redeemscript.to_v0_p2wsh(), holder_tx.per_commitment_point.clone(), holder_tx.revocation_key.clone()));
1726 for &(ref htlc, _, _) in holder_tx.htlc_outputs.iter() {
1727 if let Some(transaction_output_index) = htlc.transaction_output_index {
1728 let htlc_output = if htlc.offered {
1729 HolderHTLCOutput::build_offered(htlc.amount_msat, htlc.cltv_expiry)
1731 let payment_preimage = if let Some(preimage) = self.payment_preimages.get(&htlc.payment_hash) {
1734 // We can't build an HTLC-Success transaction without the preimage
1737 HolderHTLCOutput::build_accepted(payment_preimage, htlc.amount_msat)
1739 let htlc_package = PackageTemplate::build_package(holder_tx.txid, transaction_output_index, PackageSolvingData::HolderHTLCOutput(htlc_output), htlc.cltv_expiry, false, conf_height);
1740 claim_requests.push(htlc_package);
1744 (claim_requests, broadcasted_holder_revokable_script)
1747 // Returns holder HTLC outputs to watch and react to in case of spending.
1748 fn get_broadcasted_holder_watch_outputs(&self, holder_tx: &HolderSignedTx, commitment_tx: &Transaction) -> Vec<(u32, TxOut)> {
1749 let mut watch_outputs = Vec::with_capacity(holder_tx.htlc_outputs.len());
1750 for &(ref htlc, _, _) in holder_tx.htlc_outputs.iter() {
1751 if let Some(transaction_output_index) = htlc.transaction_output_index {
1752 watch_outputs.push((transaction_output_index, commitment_tx.output[transaction_output_index as usize].clone()));
1758 /// Attempts to claim any claimable HTLCs in a commitment transaction which was not (yet)
1759 /// revoked using data in holder_claimable_outpoints.
1760 /// Should not be used if check_spend_revoked_transaction succeeds.
1761 fn check_spend_holder_transaction<L: Deref>(&mut self, tx: &Transaction, height: u32, logger: &L) -> (Vec<PackageTemplate>, TransactionOutputs) where L::Target: Logger {
1762 let commitment_txid = tx.txid();
1763 let mut claim_requests = Vec::new();
1764 let mut watch_outputs = Vec::new();
1766 macro_rules! append_onchain_update {
1767 ($updates: expr, $to_watch: expr) => {
1768 claim_requests = $updates.0;
1769 self.broadcasted_holder_revokable_script = $updates.1;
1770 watch_outputs.append(&mut $to_watch);
1774 // HTLCs set may differ between last and previous holder commitment txn, in case of one them hitting chain, ensure we cancel all HTLCs backward
1775 let mut is_holder_tx = false;
1777 if self.current_holder_commitment_tx.txid == commitment_txid {
1778 is_holder_tx = true;
1779 log_info!(logger, "Got broadcast of latest holder commitment tx {}, searching for available HTLCs to claim", commitment_txid);
1780 let res = self.get_broadcasted_holder_claims(&self.current_holder_commitment_tx, height);
1781 let mut to_watch = self.get_broadcasted_holder_watch_outputs(&self.current_holder_commitment_tx, tx);
1782 append_onchain_update!(res, to_watch);
1783 } else if let &Some(ref holder_tx) = &self.prev_holder_signed_commitment_tx {
1784 if holder_tx.txid == commitment_txid {
1785 is_holder_tx = true;
1786 log_info!(logger, "Got broadcast of previous holder commitment tx {}, searching for available HTLCs to claim", commitment_txid);
1787 let res = self.get_broadcasted_holder_claims(holder_tx, height);
1788 let mut to_watch = self.get_broadcasted_holder_watch_outputs(holder_tx, tx);
1789 append_onchain_update!(res, to_watch);
1793 macro_rules! fail_dust_htlcs_after_threshold_conf {
1794 ($holder_tx: expr, $commitment_tx: expr) => {
1795 for &(ref htlc, _, ref source) in &$holder_tx.htlc_outputs {
1796 if htlc.transaction_output_index.is_none() {
1797 if let &Some(ref source) = source {
1798 self.onchain_events_awaiting_threshold_conf.retain(|ref entry| {
1799 if entry.height != height { return true; }
1801 OnchainEvent::HTLCUpdate { source: ref update_source, .. } => {
1802 update_source != source
1807 let entry = OnchainEventEntry {
1808 txid: commitment_txid,
1810 event: OnchainEvent::HTLCUpdate {
1811 source: source.clone(), payment_hash: htlc.payment_hash,
1812 onchain_value_satoshis: Some(htlc.amount_msat / 1000)
1815 log_trace!(logger, "Failing HTLC with payment_hash {} from {} holder commitment tx due to broadcast of transaction, waiting confirmation (at height{})",
1816 log_bytes!(htlc.payment_hash.0), $commitment_tx, entry.confirmation_threshold());
1817 self.onchain_events_awaiting_threshold_conf.push(entry);
1825 fail_dust_htlcs_after_threshold_conf!(self.current_holder_commitment_tx, "latest");
1826 if let &Some(ref holder_tx) = &self.prev_holder_signed_commitment_tx {
1827 fail_dust_htlcs_after_threshold_conf!(holder_tx, "previous");
1831 (claim_requests, (commitment_txid, watch_outputs))
1834 pub fn get_latest_holder_commitment_txn<L: Deref>(&mut self, logger: &L) -> Vec<Transaction> where L::Target: Logger {
1835 log_debug!(logger, "Getting signed latest holder commitment transaction!");
1836 self.holder_tx_signed = true;
1837 let commitment_tx = self.onchain_tx_handler.get_fully_signed_holder_tx(&self.funding_redeemscript);
1838 let txid = commitment_tx.txid();
1839 let mut holder_transactions = vec![commitment_tx];
1840 for htlc in self.current_holder_commitment_tx.htlc_outputs.iter() {
1841 if let Some(vout) = htlc.0.transaction_output_index {
1842 let preimage = if !htlc.0.offered {
1843 if let Some(preimage) = self.payment_preimages.get(&htlc.0.payment_hash) { Some(preimage.clone()) } else {
1844 // We can't build an HTLC-Success transaction without the preimage
1847 } else if htlc.0.cltv_expiry > self.best_block.height() + 1 {
1848 // Don't broadcast HTLC-Timeout transactions immediately as they don't meet the
1849 // current locktime requirements on-chain. We will broadcast them in
1850 // `block_confirmed` when `should_broadcast_holder_commitment_txn` returns true.
1851 // Note that we add + 1 as transactions are broadcastable when they can be
1852 // confirmed in the next block.
1855 if let Some(htlc_tx) = self.onchain_tx_handler.get_fully_signed_htlc_tx(
1856 &::bitcoin::OutPoint { txid, vout }, &preimage) {
1857 holder_transactions.push(htlc_tx);
1861 // 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.
1862 // The data will be re-generated and tracked in check_spend_holder_transaction if we get a confirmation.
1866 #[cfg(any(test,feature = "unsafe_revoked_tx_signing"))]
1867 /// Note that this includes possibly-locktimed-in-the-future transactions!
1868 fn unsafe_get_latest_holder_commitment_txn<L: Deref>(&mut self, logger: &L) -> Vec<Transaction> where L::Target: Logger {
1869 log_debug!(logger, "Getting signed copy of latest holder commitment transaction!");
1870 let commitment_tx = self.onchain_tx_handler.get_fully_signed_copy_holder_tx(&self.funding_redeemscript);
1871 let txid = commitment_tx.txid();
1872 let mut holder_transactions = vec![commitment_tx];
1873 for htlc in self.current_holder_commitment_tx.htlc_outputs.iter() {
1874 if let Some(vout) = htlc.0.transaction_output_index {
1875 let preimage = if !htlc.0.offered {
1876 if let Some(preimage) = self.payment_preimages.get(&htlc.0.payment_hash) { Some(preimage.clone()) } else {
1877 // We can't build an HTLC-Success transaction without the preimage
1881 if let Some(htlc_tx) = self.onchain_tx_handler.unsafe_get_fully_signed_htlc_tx(
1882 &::bitcoin::OutPoint { txid, vout }, &preimage) {
1883 holder_transactions.push(htlc_tx);
1890 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>
1891 where B::Target: BroadcasterInterface,
1892 F::Target: FeeEstimator,
1895 let block_hash = header.block_hash();
1896 log_trace!(logger, "New best block {} at height {}", block_hash, height);
1897 self.best_block = BestBlock::new(block_hash, height);
1899 self.transactions_confirmed(header, txdata, height, broadcaster, fee_estimator, logger)
1902 fn best_block_updated<B: Deref, F: Deref, L: Deref>(
1904 header: &BlockHeader,
1909 ) -> Vec<TransactionOutputs>
1911 B::Target: BroadcasterInterface,
1912 F::Target: FeeEstimator,
1915 let block_hash = header.block_hash();
1916 log_trace!(logger, "New best block {} at height {}", block_hash, height);
1918 if height > self.best_block.height() {
1919 self.best_block = BestBlock::new(block_hash, height);
1920 self.block_confirmed(height, vec![], vec![], vec![], &broadcaster, &fee_estimator, &logger)
1921 } else if block_hash != self.best_block.block_hash() {
1922 self.best_block = BestBlock::new(block_hash, height);
1923 self.onchain_events_awaiting_threshold_conf.retain(|ref entry| entry.height <= height);
1924 self.onchain_tx_handler.block_disconnected(height + 1, broadcaster, fee_estimator, logger);
1926 } else { Vec::new() }
1929 fn transactions_confirmed<B: Deref, F: Deref, L: Deref>(
1931 header: &BlockHeader,
1932 txdata: &TransactionData,
1937 ) -> Vec<TransactionOutputs>
1939 B::Target: BroadcasterInterface,
1940 F::Target: FeeEstimator,
1943 let txn_matched = self.filter_block(txdata);
1944 for tx in &txn_matched {
1945 let mut output_val = 0;
1946 for out in tx.output.iter() {
1947 if out.value > 21_000_000_0000_0000 { panic!("Value-overflowing transaction provided to block connected"); }
1948 output_val += out.value;
1949 if output_val > 21_000_000_0000_0000 { panic!("Value-overflowing transaction provided to block connected"); }
1953 let block_hash = header.block_hash();
1954 log_trace!(logger, "Block {} at height {} connected with {} txn matched", block_hash, height, txn_matched.len());
1956 let mut watch_outputs = Vec::new();
1957 let mut claimable_outpoints = Vec::new();
1958 for tx in &txn_matched {
1959 if tx.input.len() == 1 {
1960 // Assuming our keys were not leaked (in which case we're screwed no matter what),
1961 // commitment transactions and HTLC transactions will all only ever have one input,
1962 // which is an easy way to filter out any potential non-matching txn for lazy
1964 let prevout = &tx.input[0].previous_output;
1965 if prevout.txid == self.funding_info.0.txid && prevout.vout == self.funding_info.0.index as u32 {
1966 if (tx.input[0].sequence >> 8*3) as u8 == 0x80 && (tx.lock_time >> 8*3) as u8 == 0x20 {
1967 let (mut new_outpoints, new_outputs) = self.check_spend_counterparty_transaction(&tx, height, &logger);
1968 if !new_outputs.1.is_empty() {
1969 watch_outputs.push(new_outputs);
1971 if new_outpoints.is_empty() {
1972 let (mut new_outpoints, new_outputs) = self.check_spend_holder_transaction(&tx, height, &logger);
1973 if !new_outputs.1.is_empty() {
1974 watch_outputs.push(new_outputs);
1976 claimable_outpoints.append(&mut new_outpoints);
1978 claimable_outpoints.append(&mut new_outpoints);
1981 if let Some(&commitment_number) = self.counterparty_commitment_txn_on_chain.get(&prevout.txid) {
1982 let (mut new_outpoints, new_outputs_option) = self.check_spend_counterparty_htlc(&tx, commitment_number, height, &logger);
1983 claimable_outpoints.append(&mut new_outpoints);
1984 if let Some(new_outputs) = new_outputs_option {
1985 watch_outputs.push(new_outputs);
1990 // While all commitment/HTLC-Success/HTLC-Timeout transactions have one input, HTLCs
1991 // can also be resolved in a few other ways which can have more than one output. Thus,
1992 // we call is_resolving_htlc_output here outside of the tx.input.len() == 1 check.
1993 self.is_resolving_htlc_output(&tx, height, &logger);
1995 self.is_paying_spendable_output(&tx, height, &logger);
1998 if height > self.best_block.height() {
1999 self.best_block = BestBlock::new(block_hash, height);
2002 self.block_confirmed(height, txn_matched, watch_outputs, claimable_outpoints, &broadcaster, &fee_estimator, &logger)
2005 /// Update state for new block(s)/transaction(s) confirmed. Note that the caller must update
2006 /// `self.best_block` before calling if a new best blockchain tip is available. More
2007 /// concretely, `self.best_block` must never be at a lower height than `conf_height`, avoiding
2008 /// complexity especially in `OnchainTx::update_claims_view`.
2010 /// `conf_height` should be set to the height at which any new transaction(s)/block(s) were
2011 /// confirmed at, even if it is not the current best height.
2012 fn block_confirmed<B: Deref, F: Deref, L: Deref>(
2015 txn_matched: Vec<&Transaction>,
2016 mut watch_outputs: Vec<TransactionOutputs>,
2017 mut claimable_outpoints: Vec<PackageTemplate>,
2021 ) -> Vec<TransactionOutputs>
2023 B::Target: BroadcasterInterface,
2024 F::Target: FeeEstimator,
2027 debug_assert!(self.best_block.height() >= conf_height);
2029 let should_broadcast = self.should_broadcast_holder_commitment_txn(logger);
2030 if should_broadcast {
2031 let funding_outp = HolderFundingOutput::build(self.funding_redeemscript.clone());
2032 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());
2033 claimable_outpoints.push(commitment_package);
2034 self.pending_monitor_events.push(MonitorEvent::CommitmentTxBroadcasted(self.funding_info.0));
2035 let commitment_tx = self.onchain_tx_handler.get_fully_signed_holder_tx(&self.funding_redeemscript);
2036 self.holder_tx_signed = true;
2037 // Because we're broadcasting a commitment transaction, we should construct the package
2038 // assuming it gets confirmed in the next block. Sadly, we have code which considers
2039 // "not yet confirmed" things as discardable, so we cannot do that here.
2040 let (mut new_outpoints, _) = self.get_broadcasted_holder_claims(&self.current_holder_commitment_tx, self.best_block.height());
2041 let new_outputs = self.get_broadcasted_holder_watch_outputs(&self.current_holder_commitment_tx, &commitment_tx);
2042 if !new_outputs.is_empty() {
2043 watch_outputs.push((self.current_holder_commitment_tx.txid.clone(), new_outputs));
2045 claimable_outpoints.append(&mut new_outpoints);
2048 // Find which on-chain events have reached their confirmation threshold.
2049 let onchain_events_awaiting_threshold_conf =
2050 self.onchain_events_awaiting_threshold_conf.drain(..).collect::<Vec<_>>();
2051 let mut onchain_events_reaching_threshold_conf = Vec::new();
2052 for entry in onchain_events_awaiting_threshold_conf {
2053 if entry.has_reached_confirmation_threshold(&self.best_block) {
2054 onchain_events_reaching_threshold_conf.push(entry);
2056 self.onchain_events_awaiting_threshold_conf.push(entry);
2060 // Used to check for duplicate HTLC resolutions.
2061 #[cfg(debug_assertions)]
2062 let unmatured_htlcs: Vec<_> = self.onchain_events_awaiting_threshold_conf
2064 .filter_map(|entry| match &entry.event {
2065 OnchainEvent::HTLCUpdate { source, .. } => Some(source),
2066 OnchainEvent::MaturingOutput { .. } => None,
2069 #[cfg(debug_assertions)]
2070 let mut matured_htlcs = Vec::new();
2072 // Produce actionable events from on-chain events having reached their threshold.
2073 for entry in onchain_events_reaching_threshold_conf.drain(..) {
2075 OnchainEvent::HTLCUpdate { ref source, payment_hash, onchain_value_satoshis } => {
2076 // Check for duplicate HTLC resolutions.
2077 #[cfg(debug_assertions)]
2080 unmatured_htlcs.iter().find(|&htlc| htlc == &source).is_none(),
2081 "An unmature HTLC transaction conflicts with a maturing one; failed to \
2082 call either transaction_unconfirmed for the conflicting transaction \
2083 or block_disconnected for a block containing it.");
2085 matured_htlcs.iter().find(|&htlc| htlc == source).is_none(),
2086 "A matured HTLC transaction conflicts with a maturing one; failed to \
2087 call either transaction_unconfirmed for the conflicting transaction \
2088 or block_disconnected for a block containing it.");
2089 matured_htlcs.push(source.clone());
2092 log_debug!(logger, "HTLC {} failure update has got enough confirmations to be passed upstream", log_bytes!(payment_hash.0));
2093 self.pending_monitor_events.push(MonitorEvent::HTLCEvent(HTLCUpdate {
2095 payment_preimage: None,
2096 source: source.clone(),
2097 onchain_value_satoshis,
2100 OnchainEvent::MaturingOutput { descriptor } => {
2101 log_debug!(logger, "Descriptor {} has got enough confirmations to be passed upstream", log_spendable!(descriptor));
2102 self.pending_events.push(Event::SpendableOutputs {
2103 outputs: vec![descriptor]
2109 self.onchain_tx_handler.update_claims_view(&txn_matched, claimable_outpoints, conf_height, self.best_block.height(), broadcaster, fee_estimator, logger);
2111 // Determine new outputs to watch by comparing against previously known outputs to watch,
2112 // updating the latter in the process.
2113 watch_outputs.retain(|&(ref txid, ref txouts)| {
2114 let idx_and_scripts = txouts.iter().map(|o| (o.0, o.1.script_pubkey.clone())).collect();
2115 self.outputs_to_watch.insert(txid.clone(), idx_and_scripts).is_none()
2119 // If we see a transaction for which we registered outputs previously,
2120 // make sure the registered scriptpubkey at the expected index match
2121 // the actual transaction output one. We failed this case before #653.
2122 for tx in &txn_matched {
2123 if let Some(outputs) = self.get_outputs_to_watch().get(&tx.txid()) {
2124 for idx_and_script in outputs.iter() {
2125 assert!((idx_and_script.0 as usize) < tx.output.len());
2126 assert_eq!(tx.output[idx_and_script.0 as usize].script_pubkey, idx_and_script.1);
2134 pub fn block_disconnected<B: Deref, F: Deref, L: Deref>(&mut self, header: &BlockHeader, height: u32, broadcaster: B, fee_estimator: F, logger: L)
2135 where B::Target: BroadcasterInterface,
2136 F::Target: FeeEstimator,
2139 log_trace!(logger, "Block {} at height {} disconnected", header.block_hash(), height);
2142 //- htlc update there as failure-trigger tx (revoked commitment tx, non-revoked commitment tx, HTLC-timeout tx) has been disconnected
2143 //- maturing spendable output has transaction paying us has been disconnected
2144 self.onchain_events_awaiting_threshold_conf.retain(|ref entry| entry.height < height);
2146 self.onchain_tx_handler.block_disconnected(height, broadcaster, fee_estimator, logger);
2148 self.best_block = BestBlock::new(header.prev_blockhash, height - 1);
2151 fn transaction_unconfirmed<B: Deref, F: Deref, L: Deref>(
2158 B::Target: BroadcasterInterface,
2159 F::Target: FeeEstimator,
2162 self.onchain_events_awaiting_threshold_conf.retain(|ref entry| entry.txid != *txid);
2163 self.onchain_tx_handler.transaction_unconfirmed(txid, broadcaster, fee_estimator, logger);
2166 /// Filters a block's `txdata` for transactions spending watched outputs or for any child
2167 /// transactions thereof.
2168 fn filter_block<'a>(&self, txdata: &TransactionData<'a>) -> Vec<&'a Transaction> {
2169 let mut matched_txn = HashSet::new();
2170 txdata.iter().filter(|&&(_, tx)| {
2171 let mut matches = self.spends_watched_output(tx);
2172 for input in tx.input.iter() {
2173 if matches { break; }
2174 if matched_txn.contains(&input.previous_output.txid) {
2179 matched_txn.insert(tx.txid());
2182 }).map(|(_, tx)| *tx).collect()
2185 /// Checks if a given transaction spends any watched outputs.
2186 fn spends_watched_output(&self, tx: &Transaction) -> bool {
2187 for input in tx.input.iter() {
2188 if let Some(outputs) = self.get_outputs_to_watch().get(&input.previous_output.txid) {
2189 for (idx, _script_pubkey) in outputs.iter() {
2190 if *idx == input.previous_output.vout {
2193 // If the expected script is a known type, check that the witness
2194 // appears to be spending the correct type (ie that the match would
2195 // actually succeed in BIP 158/159-style filters).
2196 if _script_pubkey.is_v0_p2wsh() {
2197 assert_eq!(&bitcoin::Address::p2wsh(&Script::from(input.witness.last().unwrap().clone()), bitcoin::Network::Bitcoin).script_pubkey(), _script_pubkey);
2198 } else if _script_pubkey.is_v0_p2wpkh() {
2199 assert_eq!(&bitcoin::Address::p2wpkh(&bitcoin::PublicKey::from_slice(&input.witness.last().unwrap()).unwrap(), bitcoin::Network::Bitcoin).unwrap().script_pubkey(), _script_pubkey);
2200 } else { panic!(); }
2211 fn should_broadcast_holder_commitment_txn<L: Deref>(&self, logger: &L) -> bool where L::Target: Logger {
2212 // We need to consider all HTLCs which are:
2213 // * in any unrevoked counterparty commitment transaction, as they could broadcast said
2214 // transactions and we'd end up in a race, or
2215 // * are in our latest holder commitment transaction, as this is the thing we will
2216 // broadcast if we go on-chain.
2217 // Note that we consider HTLCs which were below dust threshold here - while they don't
2218 // strictly imply that we need to fail the channel, we need to go ahead and fail them back
2219 // to the source, and if we don't fail the channel we will have to ensure that the next
2220 // updates that peer sends us are update_fails, failing the channel if not. It's probably
2221 // easier to just fail the channel as this case should be rare enough anyway.
2222 let height = self.best_block.height();
2223 macro_rules! scan_commitment {
2224 ($htlcs: expr, $holder_tx: expr) => {
2225 for ref htlc in $htlcs {
2226 // For inbound HTLCs which we know the preimage for, we have to ensure we hit the
2227 // chain with enough room to claim the HTLC without our counterparty being able to
2228 // time out the HTLC first.
2229 // For outbound HTLCs which our counterparty hasn't failed/claimed, our primary
2230 // concern is being able to claim the corresponding inbound HTLC (on another
2231 // channel) before it expires. In fact, we don't even really care if our
2232 // counterparty here claims such an outbound HTLC after it expired as long as we
2233 // can still claim the corresponding HTLC. Thus, to avoid needlessly hitting the
2234 // chain when our counterparty is waiting for expiration to off-chain fail an HTLC
2235 // we give ourselves a few blocks of headroom after expiration before going
2236 // on-chain for an expired HTLC.
2237 // Note that, to avoid a potential attack whereby a node delays claiming an HTLC
2238 // from us until we've reached the point where we go on-chain with the
2239 // corresponding inbound HTLC, we must ensure that outbound HTLCs go on chain at
2240 // least CLTV_CLAIM_BUFFER blocks prior to the inbound HTLC.
2241 // aka outbound_cltv + LATENCY_GRACE_PERIOD_BLOCKS == height - CLTV_CLAIM_BUFFER
2242 // inbound_cltv == height + CLTV_CLAIM_BUFFER
2243 // outbound_cltv + LATENCY_GRACE_PERIOD_BLOCKS + CLTV_CLAIM_BUFFER <= inbound_cltv - CLTV_CLAIM_BUFFER
2244 // LATENCY_GRACE_PERIOD_BLOCKS + 2*CLTV_CLAIM_BUFFER <= inbound_cltv - outbound_cltv
2245 // CLTV_EXPIRY_DELTA <= inbound_cltv - outbound_cltv (by check in ChannelManager::decode_update_add_htlc_onion)
2246 // LATENCY_GRACE_PERIOD_BLOCKS + 2*CLTV_CLAIM_BUFFER <= CLTV_EXPIRY_DELTA
2247 // The final, above, condition is checked for statically in channelmanager
2248 // with CHECK_CLTV_EXPIRY_SANITY_2.
2249 let htlc_outbound = $holder_tx == htlc.offered;
2250 if ( htlc_outbound && htlc.cltv_expiry + LATENCY_GRACE_PERIOD_BLOCKS <= height) ||
2251 (!htlc_outbound && htlc.cltv_expiry <= height + CLTV_CLAIM_BUFFER && self.payment_preimages.contains_key(&htlc.payment_hash)) {
2252 log_info!(logger, "Force-closing channel due to {} HTLC timeout, HTLC expiry is {}", if htlc_outbound { "outbound" } else { "inbound "}, htlc.cltv_expiry);
2259 scan_commitment!(self.current_holder_commitment_tx.htlc_outputs.iter().map(|&(ref a, _, _)| a), true);
2261 if let Some(ref txid) = self.current_counterparty_commitment_txid {
2262 if let Some(ref htlc_outputs) = self.counterparty_claimable_outpoints.get(txid) {
2263 scan_commitment!(htlc_outputs.iter().map(|&(ref a, _)| a), false);
2266 if let Some(ref txid) = self.prev_counterparty_commitment_txid {
2267 if let Some(ref htlc_outputs) = self.counterparty_claimable_outpoints.get(txid) {
2268 scan_commitment!(htlc_outputs.iter().map(|&(ref a, _)| a), false);
2275 /// Check if any transaction broadcasted is resolving HTLC output by a success or timeout on a holder
2276 /// or counterparty commitment tx, if so send back the source, preimage if found and payment_hash of resolved HTLC
2277 fn is_resolving_htlc_output<L: Deref>(&mut self, tx: &Transaction, height: u32, logger: &L) where L::Target: Logger {
2278 'outer_loop: for input in &tx.input {
2279 let mut payment_data = None;
2280 let revocation_sig_claim = (input.witness.len() == 3 && HTLCType::scriptlen_to_htlctype(input.witness[2].len()) == Some(HTLCType::OfferedHTLC) && input.witness[1].len() == 33)
2281 || (input.witness.len() == 3 && HTLCType::scriptlen_to_htlctype(input.witness[2].len()) == Some(HTLCType::AcceptedHTLC) && input.witness[1].len() == 33);
2282 let accepted_preimage_claim = input.witness.len() == 5 && HTLCType::scriptlen_to_htlctype(input.witness[4].len()) == Some(HTLCType::AcceptedHTLC);
2283 let offered_preimage_claim = input.witness.len() == 3 && HTLCType::scriptlen_to_htlctype(input.witness[2].len()) == Some(HTLCType::OfferedHTLC);
2285 macro_rules! log_claim {
2286 ($tx_info: expr, $holder_tx: expr, $htlc: expr, $source_avail: expr) => {
2287 // We found the output in question, but aren't failing it backwards
2288 // as we have no corresponding source and no valid counterparty commitment txid
2289 // to try a weak source binding with same-hash, same-value still-valid offered HTLC.
2290 // This implies either it is an inbound HTLC or an outbound HTLC on a revoked transaction.
2291 let outbound_htlc = $holder_tx == $htlc.offered;
2292 if ($holder_tx && revocation_sig_claim) ||
2293 (outbound_htlc && !$source_avail && (accepted_preimage_claim || offered_preimage_claim)) {
2294 log_error!(logger, "Input spending {} ({}:{}) in {} resolves {} HTLC with payment hash {} with {}!",
2295 $tx_info, input.previous_output.txid, input.previous_output.vout, tx.txid(),
2296 if outbound_htlc { "outbound" } else { "inbound" }, log_bytes!($htlc.payment_hash.0),
2297 if revocation_sig_claim { "revocation sig" } else { "preimage claim after we'd passed the HTLC resolution back" });
2299 log_info!(logger, "Input spending {} ({}:{}) in {} resolves {} HTLC with payment hash {} with {}",
2300 $tx_info, input.previous_output.txid, input.previous_output.vout, tx.txid(),
2301 if outbound_htlc { "outbound" } else { "inbound" }, log_bytes!($htlc.payment_hash.0),
2302 if revocation_sig_claim { "revocation sig" } else if accepted_preimage_claim || offered_preimage_claim { "preimage" } else { "timeout" });
2307 macro_rules! check_htlc_valid_counterparty {
2308 ($counterparty_txid: expr, $htlc_output: expr) => {
2309 if let Some(txid) = $counterparty_txid {
2310 for &(ref pending_htlc, ref pending_source) in self.counterparty_claimable_outpoints.get(&txid).unwrap() {
2311 if pending_htlc.payment_hash == $htlc_output.payment_hash && pending_htlc.amount_msat == $htlc_output.amount_msat {
2312 if let &Some(ref source) = pending_source {
2313 log_claim!("revoked counterparty commitment tx", false, pending_htlc, true);
2314 payment_data = Some(((**source).clone(), $htlc_output.payment_hash, $htlc_output.amount_msat));
2323 macro_rules! scan_commitment {
2324 ($htlcs: expr, $tx_info: expr, $holder_tx: expr) => {
2325 for (ref htlc_output, source_option) in $htlcs {
2326 if Some(input.previous_output.vout) == htlc_output.transaction_output_index {
2327 if let Some(ref source) = source_option {
2328 log_claim!($tx_info, $holder_tx, htlc_output, true);
2329 // We have a resolution of an HTLC either from one of our latest
2330 // holder commitment transactions or an unrevoked counterparty commitment
2331 // transaction. This implies we either learned a preimage, the HTLC
2332 // has timed out, or we screwed up. In any case, we should now
2333 // resolve the source HTLC with the original sender.
2334 payment_data = Some(((*source).clone(), htlc_output.payment_hash, htlc_output.amount_msat));
2335 } else if !$holder_tx {
2336 check_htlc_valid_counterparty!(self.current_counterparty_commitment_txid, htlc_output);
2337 if payment_data.is_none() {
2338 check_htlc_valid_counterparty!(self.prev_counterparty_commitment_txid, htlc_output);
2341 if payment_data.is_none() {
2342 log_claim!($tx_info, $holder_tx, htlc_output, false);
2343 continue 'outer_loop;
2350 if input.previous_output.txid == self.current_holder_commitment_tx.txid {
2351 scan_commitment!(self.current_holder_commitment_tx.htlc_outputs.iter().map(|&(ref a, _, ref b)| (a, b.as_ref())),
2352 "our latest holder commitment tx", true);
2354 if let Some(ref prev_holder_signed_commitment_tx) = self.prev_holder_signed_commitment_tx {
2355 if input.previous_output.txid == prev_holder_signed_commitment_tx.txid {
2356 scan_commitment!(prev_holder_signed_commitment_tx.htlc_outputs.iter().map(|&(ref a, _, ref b)| (a, b.as_ref())),
2357 "our previous holder commitment tx", true);
2360 if let Some(ref htlc_outputs) = self.counterparty_claimable_outpoints.get(&input.previous_output.txid) {
2361 scan_commitment!(htlc_outputs.iter().map(|&(ref a, ref b)| (a, (b.as_ref().clone()).map(|boxed| &**boxed))),
2362 "counterparty commitment tx", false);
2365 // Check that scan_commitment, above, decided there is some source worth relaying an
2366 // HTLC resolution backwards to and figure out whether we learned a preimage from it.
2367 if let Some((source, payment_hash, amount_msat)) = payment_data {
2368 let mut payment_preimage = PaymentPreimage([0; 32]);
2369 if accepted_preimage_claim {
2370 if !self.pending_monitor_events.iter().any(
2371 |update| if let &MonitorEvent::HTLCEvent(ref upd) = update { upd.source == source } else { false }) {
2372 payment_preimage.0.copy_from_slice(&input.witness[3]);
2373 self.pending_monitor_events.push(MonitorEvent::HTLCEvent(HTLCUpdate {
2375 payment_preimage: Some(payment_preimage),
2377 onchain_value_satoshis: Some(amount_msat / 1000),
2380 } else if offered_preimage_claim {
2381 if !self.pending_monitor_events.iter().any(
2382 |update| if let &MonitorEvent::HTLCEvent(ref upd) = update {
2383 upd.source == source
2385 payment_preimage.0.copy_from_slice(&input.witness[1]);
2386 self.pending_monitor_events.push(MonitorEvent::HTLCEvent(HTLCUpdate {
2388 payment_preimage: Some(payment_preimage),
2390 onchain_value_satoshis: Some(amount_msat / 1000),
2394 self.onchain_events_awaiting_threshold_conf.retain(|ref entry| {
2395 if entry.height != height { return true; }
2397 OnchainEvent::HTLCUpdate { source: ref htlc_source, .. } => {
2398 *htlc_source != source
2403 let entry = OnchainEventEntry {
2406 event: OnchainEvent::HTLCUpdate {
2407 source, payment_hash,
2408 onchain_value_satoshis: Some(amount_msat / 1000),
2411 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());
2412 self.onchain_events_awaiting_threshold_conf.push(entry);
2418 /// Check if any transaction broadcasted is paying fund back to some address we can assume to own
2419 fn is_paying_spendable_output<L: Deref>(&mut self, tx: &Transaction, height: u32, logger: &L) where L::Target: Logger {
2420 let mut spendable_output = None;
2421 for (i, outp) in tx.output.iter().enumerate() { // There is max one spendable output for any channel tx, including ones generated by us
2422 if i > ::core::u16::MAX as usize {
2423 // While it is possible that an output exists on chain which is greater than the
2424 // 2^16th output in a given transaction, this is only possible if the output is not
2425 // in a lightning transaction and was instead placed there by some third party who
2426 // wishes to give us money for no reason.
2427 // Namely, any lightning transactions which we pre-sign will never have anywhere
2428 // near 2^16 outputs both because such transactions must have ~2^16 outputs who's
2429 // scripts are not longer than one byte in length and because they are inherently
2430 // non-standard due to their size.
2431 // Thus, it is completely safe to ignore such outputs, and while it may result in
2432 // us ignoring non-lightning fund to us, that is only possible if someone fills
2433 // nearly a full block with garbage just to hit this case.
2436 if outp.script_pubkey == self.destination_script {
2437 spendable_output = Some(SpendableOutputDescriptor::StaticOutput {
2438 outpoint: OutPoint { txid: tx.txid(), index: i as u16 },
2439 output: outp.clone(),
2443 if let Some(ref broadcasted_holder_revokable_script) = self.broadcasted_holder_revokable_script {
2444 if broadcasted_holder_revokable_script.0 == outp.script_pubkey {
2445 spendable_output = Some(SpendableOutputDescriptor::DelayedPaymentOutput(DelayedPaymentOutputDescriptor {
2446 outpoint: OutPoint { txid: tx.txid(), index: i as u16 },
2447 per_commitment_point: broadcasted_holder_revokable_script.1,
2448 to_self_delay: self.on_holder_tx_csv,
2449 output: outp.clone(),
2450 revocation_pubkey: broadcasted_holder_revokable_script.2.clone(),
2451 channel_keys_id: self.channel_keys_id,
2452 channel_value_satoshis: self.channel_value_satoshis,
2457 if self.counterparty_payment_script == outp.script_pubkey {
2458 spendable_output = Some(SpendableOutputDescriptor::StaticPaymentOutput(StaticPaymentOutputDescriptor {
2459 outpoint: OutPoint { txid: tx.txid(), index: i as u16 },
2460 output: outp.clone(),
2461 channel_keys_id: self.channel_keys_id,
2462 channel_value_satoshis: self.channel_value_satoshis,
2466 if outp.script_pubkey == self.shutdown_script {
2467 spendable_output = Some(SpendableOutputDescriptor::StaticOutput {
2468 outpoint: OutPoint { txid: tx.txid(), index: i as u16 },
2469 output: outp.clone(),
2474 if let Some(spendable_output) = spendable_output {
2475 let entry = OnchainEventEntry {
2478 event: OnchainEvent::MaturingOutput { descriptor: spendable_output.clone() },
2480 log_info!(logger, "Received spendable output {}, spendable at height {}", log_spendable!(spendable_output), entry.confirmation_threshold());
2481 self.onchain_events_awaiting_threshold_conf.push(entry);
2486 /// `Persist` defines behavior for persisting channel monitors: this could mean
2487 /// writing once to disk, and/or uploading to one or more backup services.
2489 /// Note that for every new monitor, you **must** persist the new `ChannelMonitor`
2490 /// to disk/backups. And, on every update, you **must** persist either the
2491 /// `ChannelMonitorUpdate` or the updated monitor itself. Otherwise, there is risk
2492 /// of situations such as revoking a transaction, then crashing before this
2493 /// revocation can be persisted, then unintentionally broadcasting a revoked
2494 /// transaction and losing money. This is a risk because previous channel states
2495 /// are toxic, so it's important that whatever channel state is persisted is
2496 /// kept up-to-date.
2497 pub trait Persist<ChannelSigner: Sign> {
2498 /// Persist a new channel's data. The data can be stored any way you want, but
2499 /// the identifier provided by Rust-Lightning is the channel's outpoint (and
2500 /// it is up to you to maintain a correct mapping between the outpoint and the
2501 /// stored channel data). Note that you **must** persist every new monitor to
2502 /// disk. See the `Persist` trait documentation for more details.
2504 /// See [`ChannelMonitor::write`] for writing out a `ChannelMonitor`,
2505 /// and [`ChannelMonitorUpdateErr`] for requirements when returning errors.
2506 fn persist_new_channel(&self, id: OutPoint, data: &ChannelMonitor<ChannelSigner>) -> Result<(), ChannelMonitorUpdateErr>;
2508 /// Update one channel's data. The provided `ChannelMonitor` has already
2509 /// applied the given update.
2511 /// Note that on every update, you **must** persist either the
2512 /// `ChannelMonitorUpdate` or the updated monitor itself to disk/backups. See
2513 /// the `Persist` trait documentation for more details.
2515 /// If an implementer chooses to persist the updates only, they need to make
2516 /// sure that all the updates are applied to the `ChannelMonitors` *before*
2517 /// the set of channel monitors is given to the `ChannelManager`
2518 /// deserialization routine. See [`ChannelMonitor::update_monitor`] for
2519 /// applying a monitor update to a monitor. If full `ChannelMonitors` are
2520 /// persisted, then there is no need to persist individual updates.
2522 /// Note that there could be a performance tradeoff between persisting complete
2523 /// channel monitors on every update vs. persisting only updates and applying
2524 /// them in batches. The size of each monitor grows `O(number of state updates)`
2525 /// whereas updates are small and `O(1)`.
2527 /// See [`ChannelMonitor::write`] for writing out a `ChannelMonitor`,
2528 /// [`ChannelMonitorUpdate::write`] for writing out an update, and
2529 /// [`ChannelMonitorUpdateErr`] for requirements when returning errors.
2530 fn update_persisted_channel(&self, id: OutPoint, update: &ChannelMonitorUpdate, data: &ChannelMonitor<ChannelSigner>) -> Result<(), ChannelMonitorUpdateErr>;
2533 impl<Signer: Sign, T: Deref, F: Deref, L: Deref> chain::Listen for (ChannelMonitor<Signer>, T, F, L)
2535 T::Target: BroadcasterInterface,
2536 F::Target: FeeEstimator,
2539 fn block_connected(&self, block: &Block, height: u32) {
2540 let txdata: Vec<_> = block.txdata.iter().enumerate().collect();
2541 self.0.block_connected(&block.header, &txdata, height, &*self.1, &*self.2, &*self.3);
2544 fn block_disconnected(&self, header: &BlockHeader, height: u32) {
2545 self.0.block_disconnected(header, height, &*self.1, &*self.2, &*self.3);
2549 impl<Signer: Sign, T: Deref, F: Deref, L: Deref> chain::Confirm for (ChannelMonitor<Signer>, T, F, L)
2551 T::Target: BroadcasterInterface,
2552 F::Target: FeeEstimator,
2555 fn transactions_confirmed(&self, header: &BlockHeader, txdata: &TransactionData, height: u32) {
2556 self.0.transactions_confirmed(header, txdata, height, &*self.1, &*self.2, &*self.3);
2559 fn transaction_unconfirmed(&self, txid: &Txid) {
2560 self.0.transaction_unconfirmed(txid, &*self.1, &*self.2, &*self.3);
2563 fn best_block_updated(&self, header: &BlockHeader, height: u32) {
2564 self.0.best_block_updated(header, height, &*self.1, &*self.2, &*self.3);
2567 fn get_relevant_txids(&self) -> Vec<Txid> {
2568 self.0.get_relevant_txids()
2572 const MAX_ALLOC_SIZE: usize = 64*1024;
2574 impl<'a, Signer: Sign, K: KeysInterface<Signer = Signer>> ReadableArgs<&'a K>
2575 for (BlockHash, ChannelMonitor<Signer>) {
2576 fn read<R: io::Read>(reader: &mut R, keys_manager: &'a K) -> Result<Self, DecodeError> {
2577 macro_rules! unwrap_obj {
2581 Err(_) => return Err(DecodeError::InvalidValue),
2586 let _ver = read_ver_prefix!(reader, SERIALIZATION_VERSION);
2588 let latest_update_id: u64 = Readable::read(reader)?;
2589 let commitment_transaction_number_obscure_factor = <U48 as Readable>::read(reader)?.0;
2591 let destination_script = Readable::read(reader)?;
2592 let broadcasted_holder_revokable_script = match <u8 as Readable>::read(reader)? {
2594 let revokable_address = Readable::read(reader)?;
2595 let per_commitment_point = Readable::read(reader)?;
2596 let revokable_script = Readable::read(reader)?;
2597 Some((revokable_address, per_commitment_point, revokable_script))
2600 _ => return Err(DecodeError::InvalidValue),
2602 let counterparty_payment_script = Readable::read(reader)?;
2603 let shutdown_script = Readable::read(reader)?;
2605 let channel_keys_id = Readable::read(reader)?;
2606 let holder_revocation_basepoint = Readable::read(reader)?;
2607 // Technically this can fail and serialize fail a round-trip, but only for serialization of
2608 // barely-init'd ChannelMonitors that we can't do anything with.
2609 let outpoint = OutPoint {
2610 txid: Readable::read(reader)?,
2611 index: Readable::read(reader)?,
2613 let funding_info = (outpoint, Readable::read(reader)?);
2614 let current_counterparty_commitment_txid = Readable::read(reader)?;
2615 let prev_counterparty_commitment_txid = Readable::read(reader)?;
2617 let counterparty_tx_cache = Readable::read(reader)?;
2618 let funding_redeemscript = Readable::read(reader)?;
2619 let channel_value_satoshis = Readable::read(reader)?;
2621 let their_cur_revocation_points = {
2622 let first_idx = <U48 as Readable>::read(reader)?.0;
2626 let first_point = Readable::read(reader)?;
2627 let second_point_slice: [u8; 33] = Readable::read(reader)?;
2628 if second_point_slice[0..32] == [0; 32] && second_point_slice[32] == 0 {
2629 Some((first_idx, first_point, None))
2631 Some((first_idx, first_point, Some(unwrap_obj!(PublicKey::from_slice(&second_point_slice)))))
2636 let on_holder_tx_csv: u16 = Readable::read(reader)?;
2638 let commitment_secrets = Readable::read(reader)?;
2640 macro_rules! read_htlc_in_commitment {
2643 let offered: bool = Readable::read(reader)?;
2644 let amount_msat: u64 = Readable::read(reader)?;
2645 let cltv_expiry: u32 = Readable::read(reader)?;
2646 let payment_hash: PaymentHash = Readable::read(reader)?;
2647 let transaction_output_index: Option<u32> = Readable::read(reader)?;
2649 HTLCOutputInCommitment {
2650 offered, amount_msat, cltv_expiry, payment_hash, transaction_output_index
2656 let counterparty_claimable_outpoints_len: u64 = Readable::read(reader)?;
2657 let mut counterparty_claimable_outpoints = HashMap::with_capacity(cmp::min(counterparty_claimable_outpoints_len as usize, MAX_ALLOC_SIZE / 64));
2658 for _ in 0..counterparty_claimable_outpoints_len {
2659 let txid: Txid = Readable::read(reader)?;
2660 let htlcs_count: u64 = Readable::read(reader)?;
2661 let mut htlcs = Vec::with_capacity(cmp::min(htlcs_count as usize, MAX_ALLOC_SIZE / 32));
2662 for _ in 0..htlcs_count {
2663 htlcs.push((read_htlc_in_commitment!(), <Option<HTLCSource> as Readable>::read(reader)?.map(|o: HTLCSource| Box::new(o))));
2665 if let Some(_) = counterparty_claimable_outpoints.insert(txid, htlcs) {
2666 return Err(DecodeError::InvalidValue);
2670 let counterparty_commitment_txn_on_chain_len: u64 = Readable::read(reader)?;
2671 let mut counterparty_commitment_txn_on_chain = HashMap::with_capacity(cmp::min(counterparty_commitment_txn_on_chain_len as usize, MAX_ALLOC_SIZE / 32));
2672 for _ in 0..counterparty_commitment_txn_on_chain_len {
2673 let txid: Txid = Readable::read(reader)?;
2674 let commitment_number = <U48 as Readable>::read(reader)?.0;
2675 if let Some(_) = counterparty_commitment_txn_on_chain.insert(txid, commitment_number) {
2676 return Err(DecodeError::InvalidValue);
2680 let counterparty_hash_commitment_number_len: u64 = Readable::read(reader)?;
2681 let mut counterparty_hash_commitment_number = HashMap::with_capacity(cmp::min(counterparty_hash_commitment_number_len as usize, MAX_ALLOC_SIZE / 32));
2682 for _ in 0..counterparty_hash_commitment_number_len {
2683 let payment_hash: PaymentHash = Readable::read(reader)?;
2684 let commitment_number = <U48 as Readable>::read(reader)?.0;
2685 if let Some(_) = counterparty_hash_commitment_number.insert(payment_hash, commitment_number) {
2686 return Err(DecodeError::InvalidValue);
2690 let prev_holder_signed_commitment_tx = match <u8 as Readable>::read(reader)? {
2693 Some(Readable::read(reader)?)
2695 _ => return Err(DecodeError::InvalidValue),
2697 let current_holder_commitment_tx = Readable::read(reader)?;
2699 let current_counterparty_commitment_number = <U48 as Readable>::read(reader)?.0;
2700 let current_holder_commitment_number = <U48 as Readable>::read(reader)?.0;
2702 let payment_preimages_len: u64 = Readable::read(reader)?;
2703 let mut payment_preimages = HashMap::with_capacity(cmp::min(payment_preimages_len as usize, MAX_ALLOC_SIZE / 32));
2704 for _ in 0..payment_preimages_len {
2705 let preimage: PaymentPreimage = Readable::read(reader)?;
2706 let hash = PaymentHash(Sha256::hash(&preimage.0[..]).into_inner());
2707 if let Some(_) = payment_preimages.insert(hash, preimage) {
2708 return Err(DecodeError::InvalidValue);
2712 let pending_monitor_events_len: u64 = Readable::read(reader)?;
2713 let mut pending_monitor_events = Vec::with_capacity(cmp::min(pending_monitor_events_len as usize, MAX_ALLOC_SIZE / (32 + 8*3)));
2714 for _ in 0..pending_monitor_events_len {
2715 let ev = match <u8 as Readable>::read(reader)? {
2716 0 => MonitorEvent::HTLCEvent(Readable::read(reader)?),
2717 1 => MonitorEvent::CommitmentTxBroadcasted(funding_info.0),
2718 _ => return Err(DecodeError::InvalidValue)
2720 pending_monitor_events.push(ev);
2723 let pending_events_len: u64 = Readable::read(reader)?;
2724 let mut pending_events = Vec::with_capacity(cmp::min(pending_events_len as usize, MAX_ALLOC_SIZE / mem::size_of::<Event>()));
2725 for _ in 0..pending_events_len {
2726 if let Some(event) = MaybeReadable::read(reader)? {
2727 pending_events.push(event);
2731 let best_block = BestBlock::new(Readable::read(reader)?, Readable::read(reader)?);
2733 let waiting_threshold_conf_len: u64 = Readable::read(reader)?;
2734 let mut onchain_events_awaiting_threshold_conf = Vec::with_capacity(cmp::min(waiting_threshold_conf_len as usize, MAX_ALLOC_SIZE / 128));
2735 for _ in 0..waiting_threshold_conf_len {
2736 onchain_events_awaiting_threshold_conf.push(Readable::read(reader)?);
2739 let outputs_to_watch_len: u64 = Readable::read(reader)?;
2740 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>>())));
2741 for _ in 0..outputs_to_watch_len {
2742 let txid = Readable::read(reader)?;
2743 let outputs_len: u64 = Readable::read(reader)?;
2744 let mut outputs = Vec::with_capacity(cmp::min(outputs_len as usize, MAX_ALLOC_SIZE / (mem::size_of::<u32>() + mem::size_of::<Script>())));
2745 for _ in 0..outputs_len {
2746 outputs.push((Readable::read(reader)?, Readable::read(reader)?));
2748 if let Some(_) = outputs_to_watch.insert(txid, outputs) {
2749 return Err(DecodeError::InvalidValue);
2752 let onchain_tx_handler = ReadableArgs::read(reader, keys_manager)?;
2754 let lockdown_from_offchain = Readable::read(reader)?;
2755 let holder_tx_signed = Readable::read(reader)?;
2757 read_tlv_fields!(reader, {});
2759 let mut secp_ctx = Secp256k1::new();
2760 secp_ctx.seeded_randomize(&keys_manager.get_secure_random_bytes());
2762 Ok((best_block.block_hash(), ChannelMonitor {
2763 inner: Mutex::new(ChannelMonitorImpl {
2765 commitment_transaction_number_obscure_factor,
2768 broadcasted_holder_revokable_script,
2769 counterparty_payment_script,
2773 holder_revocation_basepoint,
2775 current_counterparty_commitment_txid,
2776 prev_counterparty_commitment_txid,
2778 counterparty_tx_cache,
2779 funding_redeemscript,
2780 channel_value_satoshis,
2781 their_cur_revocation_points,
2786 counterparty_claimable_outpoints,
2787 counterparty_commitment_txn_on_chain,
2788 counterparty_hash_commitment_number,
2790 prev_holder_signed_commitment_tx,
2791 current_holder_commitment_tx,
2792 current_counterparty_commitment_number,
2793 current_holder_commitment_number,
2796 pending_monitor_events,
2799 onchain_events_awaiting_threshold_conf,
2804 lockdown_from_offchain,
2817 use bitcoin::blockdata::script::{Script, Builder};
2818 use bitcoin::blockdata::opcodes;
2819 use bitcoin::blockdata::transaction::{Transaction, TxIn, TxOut, SigHashType};
2820 use bitcoin::blockdata::transaction::OutPoint as BitcoinOutPoint;
2821 use bitcoin::util::bip143;
2822 use bitcoin::hashes::Hash;
2823 use bitcoin::hashes::sha256::Hash as Sha256;
2824 use bitcoin::hashes::hex::FromHex;
2825 use bitcoin::hash_types::Txid;
2826 use bitcoin::network::constants::Network;
2828 use chain::BestBlock;
2829 use chain::channelmonitor::ChannelMonitor;
2830 use chain::package::{WEIGHT_OFFERED_HTLC, WEIGHT_RECEIVED_HTLC, WEIGHT_REVOKED_OFFERED_HTLC, WEIGHT_REVOKED_RECEIVED_HTLC, WEIGHT_REVOKED_OUTPUT};
2831 use chain::transaction::OutPoint;
2832 use ln::{PaymentPreimage, PaymentHash};
2834 use ln::chan_utils::{HTLCOutputInCommitment, ChannelPublicKeys, ChannelTransactionParameters, HolderCommitmentTransaction, CounterpartyChannelTransactionParameters};
2835 use util::test_utils::{TestLogger, TestBroadcaster, TestFeeEstimator};
2836 use bitcoin::secp256k1::key::{SecretKey,PublicKey};
2837 use bitcoin::secp256k1::Secp256k1;
2838 use sync::{Arc, Mutex};
2839 use chain::keysinterface::InMemorySigner;
2843 fn test_prune_preimages() {
2844 let secp_ctx = Secp256k1::new();
2845 let logger = Arc::new(TestLogger::new());
2846 let broadcaster = Arc::new(TestBroadcaster{txn_broadcasted: Mutex::new(Vec::new()), blocks: Arc::new(Mutex::new(Vec::new()))});
2847 let fee_estimator = Arc::new(TestFeeEstimator { sat_per_kw: Mutex::new(253) });
2849 let dummy_key = PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[42; 32]).unwrap());
2850 let dummy_tx = Transaction { version: 0, lock_time: 0, input: Vec::new(), output: Vec::new() };
2852 let mut preimages = Vec::new();
2855 let preimage = PaymentPreimage([i; 32]);
2856 let hash = PaymentHash(Sha256::hash(&preimage.0[..]).into_inner());
2857 preimages.push((preimage, hash));
2861 macro_rules! preimages_slice_to_htlc_outputs {
2862 ($preimages_slice: expr) => {
2864 let mut res = Vec::new();
2865 for (idx, preimage) in $preimages_slice.iter().enumerate() {
2866 res.push((HTLCOutputInCommitment {
2870 payment_hash: preimage.1.clone(),
2871 transaction_output_index: Some(idx as u32),
2878 macro_rules! preimages_to_holder_htlcs {
2879 ($preimages_slice: expr) => {
2881 let mut inp = preimages_slice_to_htlc_outputs!($preimages_slice);
2882 let res: Vec<_> = inp.drain(..).map(|e| { (e.0, None, e.1) }).collect();
2888 macro_rules! test_preimages_exist {
2889 ($preimages_slice: expr, $monitor: expr) => {
2890 for preimage in $preimages_slice {
2891 assert!($monitor.inner.lock().unwrap().payment_preimages.contains_key(&preimage.1));
2896 let keys = InMemorySigner::new(
2898 SecretKey::from_slice(&[41; 32]).unwrap(),
2899 SecretKey::from_slice(&[41; 32]).unwrap(),
2900 SecretKey::from_slice(&[41; 32]).unwrap(),
2901 SecretKey::from_slice(&[41; 32]).unwrap(),
2902 SecretKey::from_slice(&[41; 32]).unwrap(),
2908 let counterparty_pubkeys = ChannelPublicKeys {
2909 funding_pubkey: PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[44; 32]).unwrap()),
2910 revocation_basepoint: PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[45; 32]).unwrap()),
2911 payment_point: PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[46; 32]).unwrap()),
2912 delayed_payment_basepoint: PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[47; 32]).unwrap()),
2913 htlc_basepoint: PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[48; 32]).unwrap())
2915 let funding_outpoint = OutPoint { txid: Default::default(), index: u16::max_value() };
2916 let channel_parameters = ChannelTransactionParameters {
2917 holder_pubkeys: keys.holder_channel_pubkeys.clone(),
2918 holder_selected_contest_delay: 66,
2919 is_outbound_from_holder: true,
2920 counterparty_parameters: Some(CounterpartyChannelTransactionParameters {
2921 pubkeys: counterparty_pubkeys,
2922 selected_contest_delay: 67,
2924 funding_outpoint: Some(funding_outpoint),
2926 // Prune with one old state and a holder commitment tx holding a few overlaps with the
2928 let best_block = BestBlock::from_genesis(Network::Testnet);
2929 let monitor = ChannelMonitor::new(Secp256k1::new(), keys,
2930 &PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[42; 32]).unwrap()), 0, &Script::new(),
2931 (OutPoint { txid: Txid::from_slice(&[43; 32]).unwrap(), index: 0 }, Script::new()),
2932 &channel_parameters,
2933 Script::new(), 46, 0,
2934 HolderCommitmentTransaction::dummy(), best_block);
2936 monitor.provide_latest_holder_commitment_tx(HolderCommitmentTransaction::dummy(), preimages_to_holder_htlcs!(preimages[0..10])).unwrap();
2937 let dummy_txid = dummy_tx.txid();
2938 monitor.provide_latest_counterparty_commitment_tx(dummy_txid, preimages_slice_to_htlc_outputs!(preimages[5..15]), 281474976710655, dummy_key, &logger);
2939 monitor.provide_latest_counterparty_commitment_tx(dummy_txid, preimages_slice_to_htlc_outputs!(preimages[15..20]), 281474976710654, dummy_key, &logger);
2940 monitor.provide_latest_counterparty_commitment_tx(dummy_txid, preimages_slice_to_htlc_outputs!(preimages[17..20]), 281474976710653, dummy_key, &logger);
2941 monitor.provide_latest_counterparty_commitment_tx(dummy_txid, preimages_slice_to_htlc_outputs!(preimages[18..20]), 281474976710652, dummy_key, &logger);
2942 for &(ref preimage, ref hash) in preimages.iter() {
2943 monitor.provide_payment_preimage(hash, preimage, &broadcaster, &fee_estimator, &logger);
2946 // Now provide a secret, pruning preimages 10-15
2947 let mut secret = [0; 32];
2948 secret[0..32].clone_from_slice(&hex::decode("7cc854b54e3e0dcdb010d7a3fee464a9687be6e8db3be6854c475621e007a5dc").unwrap());
2949 monitor.provide_secret(281474976710655, secret.clone()).unwrap();
2950 assert_eq!(monitor.inner.lock().unwrap().payment_preimages.len(), 15);
2951 test_preimages_exist!(&preimages[0..10], monitor);
2952 test_preimages_exist!(&preimages[15..20], monitor);
2954 // Now provide a further secret, pruning preimages 15-17
2955 secret[0..32].clone_from_slice(&hex::decode("c7518c8ae4660ed02894df8976fa1a3659c1a8b4b5bec0c4b872abeba4cb8964").unwrap());
2956 monitor.provide_secret(281474976710654, secret.clone()).unwrap();
2957 assert_eq!(monitor.inner.lock().unwrap().payment_preimages.len(), 13);
2958 test_preimages_exist!(&preimages[0..10], monitor);
2959 test_preimages_exist!(&preimages[17..20], monitor);
2961 // Now update holder commitment tx info, pruning only element 18 as we still care about the
2962 // previous commitment tx's preimages too
2963 monitor.provide_latest_holder_commitment_tx(HolderCommitmentTransaction::dummy(), preimages_to_holder_htlcs!(preimages[0..5])).unwrap();
2964 secret[0..32].clone_from_slice(&hex::decode("2273e227a5b7449b6e70f1fb4652864038b1cbf9cd7c043a7d6456b7fc275ad8").unwrap());
2965 monitor.provide_secret(281474976710653, secret.clone()).unwrap();
2966 assert_eq!(monitor.inner.lock().unwrap().payment_preimages.len(), 12);
2967 test_preimages_exist!(&preimages[0..10], monitor);
2968 test_preimages_exist!(&preimages[18..20], monitor);
2970 // But if we do it again, we'll prune 5-10
2971 monitor.provide_latest_holder_commitment_tx(HolderCommitmentTransaction::dummy(), preimages_to_holder_htlcs!(preimages[0..3])).unwrap();
2972 secret[0..32].clone_from_slice(&hex::decode("27cddaa5624534cb6cb9d7da077cf2b22ab21e9b506fd4998a51d54502e99116").unwrap());
2973 monitor.provide_secret(281474976710652, secret.clone()).unwrap();
2974 assert_eq!(monitor.inner.lock().unwrap().payment_preimages.len(), 5);
2975 test_preimages_exist!(&preimages[0..5], monitor);
2979 fn test_claim_txn_weight_computation() {
2980 // We test Claim txn weight, knowing that we want expected weigth and
2981 // not actual case to avoid sigs and time-lock delays hell variances.
2983 let secp_ctx = Secp256k1::new();
2984 let privkey = SecretKey::from_slice(&hex::decode("0101010101010101010101010101010101010101010101010101010101010101").unwrap()[..]).unwrap();
2985 let pubkey = PublicKey::from_secret_key(&secp_ctx, &privkey);
2986 let mut sum_actual_sigs = 0;
2988 macro_rules! sign_input {
2989 ($sighash_parts: expr, $idx: expr, $amount: expr, $weight: expr, $sum_actual_sigs: expr) => {
2990 let htlc = HTLCOutputInCommitment {
2991 offered: if *$weight == WEIGHT_REVOKED_OFFERED_HTLC || *$weight == WEIGHT_OFFERED_HTLC { true } else { false },
2993 cltv_expiry: 2 << 16,
2994 payment_hash: PaymentHash([1; 32]),
2995 transaction_output_index: Some($idx as u32),
2997 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, &pubkey, &pubkey, &pubkey) };
2998 let sighash = hash_to_message!(&$sighash_parts.signature_hash($idx, &redeem_script, $amount, SigHashType::All)[..]);
2999 let sig = secp_ctx.sign(&sighash, &privkey);
3000 $sighash_parts.access_witness($idx).push(sig.serialize_der().to_vec());
3001 $sighash_parts.access_witness($idx)[0].push(SigHashType::All as u8);
3002 sum_actual_sigs += $sighash_parts.access_witness($idx)[0].len();
3003 if *$weight == WEIGHT_REVOKED_OUTPUT {
3004 $sighash_parts.access_witness($idx).push(vec!(1));
3005 } else if *$weight == WEIGHT_REVOKED_OFFERED_HTLC || *$weight == WEIGHT_REVOKED_RECEIVED_HTLC {
3006 $sighash_parts.access_witness($idx).push(pubkey.clone().serialize().to_vec());
3007 } else if *$weight == WEIGHT_RECEIVED_HTLC {
3008 $sighash_parts.access_witness($idx).push(vec![0]);
3010 $sighash_parts.access_witness($idx).push(PaymentPreimage([1; 32]).0.to_vec());
3012 $sighash_parts.access_witness($idx).push(redeem_script.into_bytes());
3013 println!("witness[0] {}", $sighash_parts.access_witness($idx)[0].len());
3014 println!("witness[1] {}", $sighash_parts.access_witness($idx)[1].len());
3015 println!("witness[2] {}", $sighash_parts.access_witness($idx)[2].len());
3019 let script_pubkey = Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script();
3020 let txid = Txid::from_hex("56944c5d3f98413ef45cf54545538103cc9f298e0575820ad3591376e2e0f65d").unwrap();
3022 // Justice tx with 1 to_holder, 2 revoked offered HTLCs, 1 revoked received HTLCs
3023 let mut claim_tx = Transaction { version: 0, lock_time: 0, input: Vec::new(), output: Vec::new() };
3025 claim_tx.input.push(TxIn {
3026 previous_output: BitcoinOutPoint {
3030 script_sig: Script::new(),
3031 sequence: 0xfffffffd,
3032 witness: Vec::new(),
3035 claim_tx.output.push(TxOut {
3036 script_pubkey: script_pubkey.clone(),
3039 let base_weight = claim_tx.get_weight();
3040 let inputs_weight = vec![WEIGHT_REVOKED_OUTPUT, WEIGHT_REVOKED_OFFERED_HTLC, WEIGHT_REVOKED_OFFERED_HTLC, WEIGHT_REVOKED_RECEIVED_HTLC];
3041 let mut inputs_total_weight = 2; // count segwit flags
3043 let mut sighash_parts = bip143::SigHashCache::new(&mut claim_tx);
3044 for (idx, inp) in inputs_weight.iter().enumerate() {
3045 sign_input!(sighash_parts, idx, 0, inp, sum_actual_sigs);
3046 inputs_total_weight += inp;
3049 assert_eq!(base_weight + inputs_total_weight as usize, claim_tx.get_weight() + /* max_length_sig */ (73 * inputs_weight.len() - sum_actual_sigs));
3051 // Claim tx with 1 offered HTLCs, 3 received HTLCs
3052 claim_tx.input.clear();
3053 sum_actual_sigs = 0;
3055 claim_tx.input.push(TxIn {
3056 previous_output: BitcoinOutPoint {
3060 script_sig: Script::new(),
3061 sequence: 0xfffffffd,
3062 witness: Vec::new(),
3065 let base_weight = claim_tx.get_weight();
3066 let inputs_weight = vec![WEIGHT_OFFERED_HTLC, WEIGHT_RECEIVED_HTLC, WEIGHT_RECEIVED_HTLC, WEIGHT_RECEIVED_HTLC];
3067 let mut inputs_total_weight = 2; // count segwit flags
3069 let mut sighash_parts = bip143::SigHashCache::new(&mut claim_tx);
3070 for (idx, inp) in inputs_weight.iter().enumerate() {
3071 sign_input!(sighash_parts, idx, 0, inp, sum_actual_sigs);
3072 inputs_total_weight += inp;
3075 assert_eq!(base_weight + inputs_total_weight as usize, claim_tx.get_weight() + /* max_length_sig */ (73 * inputs_weight.len() - sum_actual_sigs));
3077 // Justice tx with 1 revoked HTLC-Success tx output
3078 claim_tx.input.clear();
3079 sum_actual_sigs = 0;
3080 claim_tx.input.push(TxIn {
3081 previous_output: BitcoinOutPoint {
3085 script_sig: Script::new(),
3086 sequence: 0xfffffffd,
3087 witness: Vec::new(),
3089 let base_weight = claim_tx.get_weight();
3090 let inputs_weight = vec![WEIGHT_REVOKED_OUTPUT];
3091 let mut inputs_total_weight = 2; // count segwit flags
3093 let mut sighash_parts = bip143::SigHashCache::new(&mut claim_tx);
3094 for (idx, inp) in inputs_weight.iter().enumerate() {
3095 sign_input!(sighash_parts, idx, 0, inp, sum_actual_sigs);
3096 inputs_total_weight += inp;
3099 assert_eq!(base_weight + inputs_total_weight as usize, claim_tx.get_weight() + /* max_length_isg */ (73 * inputs_weight.len() - sum_actual_sigs));
3102 // Further testing is done in the ChannelManager integration tests.