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 if let Some(upd) = MaybeReadable::read(r)? {
113 read_tlv_fields!(r, {});
114 Ok(Self { update_id, updates })
118 /// An error enum representing a failure to persist a channel monitor update.
119 #[derive(Clone, Copy, Debug, PartialEq)]
120 pub enum ChannelMonitorUpdateErr {
121 /// Used to indicate a temporary failure (eg connection to a watchtower or remote backup of
122 /// our state failed, but is expected to succeed at some point in the future).
124 /// Such a failure will "freeze" a channel, preventing us from revoking old states or
125 /// submitting new commitment transactions to the counterparty. Once the update(s) which failed
126 /// have been successfully applied, ChannelManager::channel_monitor_updated can be used to
127 /// restore the channel to an operational state.
129 /// Note that a given ChannelManager will *never* re-generate a given ChannelMonitorUpdate. If
130 /// you return a TemporaryFailure you must ensure that it is written to disk safely before
131 /// writing out the latest ChannelManager state.
133 /// Even when a channel has been "frozen" updates to the ChannelMonitor can continue to occur
134 /// (eg if an inbound HTLC which we forwarded was claimed upstream resulting in us attempting
135 /// to claim it on this channel) and those updates must be applied wherever they can be. At
136 /// least one such updated ChannelMonitor must be persisted otherwise PermanentFailure should
137 /// be returned to get things on-chain ASAP using only the in-memory copy. Obviously updates to
138 /// the channel which would invalidate previous ChannelMonitors are not made when a channel has
141 /// Note that even if updates made after TemporaryFailure succeed you must still call
142 /// channel_monitor_updated to ensure you have the latest monitor and re-enable normal channel
145 /// Note that the update being processed here will not be replayed for you when you call
146 /// ChannelManager::channel_monitor_updated, so you must store the update itself along
147 /// with the persisted ChannelMonitor on your own local disk prior to returning a
148 /// TemporaryFailure. You may, of course, employ a journaling approach, storing only the
149 /// ChannelMonitorUpdate on disk without updating the monitor itself, replaying the journal at
152 /// For deployments where a copy of ChannelMonitors and other local state are backed up in a
153 /// remote location (with local copies persisted immediately), it is anticipated that all
154 /// updates will return TemporaryFailure until the remote copies could be updated.
156 /// Used to indicate no further channel monitor updates will be allowed (eg we've moved on to a
157 /// different watchtower and cannot update with all watchtowers that were previously informed
158 /// of this channel).
160 /// At reception of this error, ChannelManager will force-close the channel and return at
161 /// least a final ChannelMonitorUpdate::ChannelForceClosed which must be delivered to at
162 /// least one ChannelMonitor copy. Revocation secret MUST NOT be released and offchain channel
163 /// update must be rejected.
165 /// This failure may also signal a failure to update the local persisted copy of one of
166 /// the channel monitor instance.
168 /// Note that even when you fail a holder commitment transaction update, you must store the
169 /// update to ensure you can claim from it in case of a duplicate copy of this ChannelMonitor
170 /// broadcasts it (e.g distributed channel-monitor deployment)
172 /// In case of distributed watchtowers deployment, the new version must be written to disk, as
173 /// state may have been stored but rejected due to a block forcing a commitment broadcast. This
174 /// storage is used to claim outputs of rejected state confirmed onchain by another watchtower,
175 /// lagging behind on block processing.
179 /// General Err type for ChannelMonitor actions. Generally, this implies that the data provided is
180 /// inconsistent with the ChannelMonitor being called. eg for ChannelMonitor::update_monitor this
181 /// means you tried to update a monitor for a different channel or the ChannelMonitorUpdate was
183 /// Contains a developer-readable error message.
184 #[derive(Clone, Debug)]
185 pub struct MonitorUpdateError(pub &'static str);
187 /// An event to be processed by the ChannelManager.
188 #[derive(Clone, PartialEq)]
189 pub enum MonitorEvent {
190 /// A monitor event containing an HTLCUpdate.
191 HTLCEvent(HTLCUpdate),
193 /// A monitor event that the Channel's commitment transaction was broadcasted.
194 CommitmentTxBroadcasted(OutPoint),
197 /// Simple structure sent back by `chain::Watch` when an HTLC from a forward channel is detected on
198 /// chain. Used to update the corresponding HTLC in the backward channel. Failing to pass the
199 /// preimage claim backward will lead to loss of funds.
200 #[derive(Clone, PartialEq)]
201 pub struct HTLCUpdate {
202 pub(crate) payment_hash: PaymentHash,
203 pub(crate) payment_preimage: Option<PaymentPreimage>,
204 pub(crate) source: HTLCSource,
205 pub(crate) onchain_value_satoshis: Option<u64>,
207 impl_writeable_tlv_based!(HTLCUpdate, {
208 (0, payment_hash, required),
209 (1, onchain_value_satoshis, option),
210 (2, source, required),
211 (4, payment_preimage, option),
214 /// If an HTLC expires within this many blocks, don't try to claim it in a shared transaction,
215 /// instead claiming it in its own individual transaction.
216 pub(crate) const CLTV_SHARED_CLAIM_BUFFER: u32 = 12;
217 /// If an HTLC expires within this many blocks, force-close the channel to broadcast the
218 /// HTLC-Success transaction.
219 /// In other words, this is an upper bound on how many blocks we think it can take us to get a
220 /// transaction confirmed (and we use it in a few more, equivalent, places).
221 pub(crate) const CLTV_CLAIM_BUFFER: u32 = 18;
222 /// Number of blocks by which point we expect our counterparty to have seen new blocks on the
223 /// network and done a full update_fail_htlc/commitment_signed dance (+ we've updated all our
224 /// copies of ChannelMonitors, including watchtowers). We could enforce the contract by failing
225 /// at CLTV expiration height but giving a grace period to our peer may be profitable for us if he
226 /// can provide an over-late preimage. Nevertheless, grace period has to be accounted in our
227 /// CLTV_EXPIRY_DELTA to be secure. Following this policy we may decrease the rate of channel failures
228 /// due to expiration but increase the cost of funds being locked longuer in case of failure.
229 /// This delay also cover a low-power peer being slow to process blocks and so being behind us on
230 /// accurate block height.
231 /// In case of onchain failure to be pass backward we may see the last block of ANTI_REORG_DELAY
232 /// with at worst this delay, so we are not only using this value as a mercy for them but also
233 /// us as a safeguard to delay with enough time.
234 pub(crate) const LATENCY_GRACE_PERIOD_BLOCKS: u32 = 3;
235 /// Number of blocks we wait on seeing a HTLC output being solved before we fail corresponding inbound
236 /// HTLCs. This prevents us from failing backwards and then getting a reorg resulting in us losing money.
237 // We also use this delay to be sure we can remove our in-flight claim txn from bump candidates buffer.
238 // It may cause spurious generation of bumped claim txn but that's alright given the outpoint is already
239 // solved by a previous claim tx. What we want to avoid is reorg evicting our claim tx and us not
240 // keep bumping another claim tx to solve the outpoint.
241 pub const ANTI_REORG_DELAY: u32 = 6;
242 /// Number of blocks before confirmation at which we fail back an un-relayed HTLC or at which we
243 /// refuse to accept a new HTLC.
245 /// This is used for a few separate purposes:
246 /// 1) if we've received an MPP HTLC to us and it expires within this many blocks and we are
247 /// waiting on additional parts (or waiting on the preimage for any HTLC from the user), we will
249 /// 2) if we receive an HTLC within this many blocks of its expiry (plus one to avoid a race
250 /// condition with the above), we will fail this HTLC without telling the user we received it,
251 /// 3) if we are waiting on a connection or a channel state update to send an HTLC to a peer, and
252 /// that HTLC expires within this many blocks, we will simply fail the HTLC instead.
254 /// (1) is all about protecting us - we need enough time to update the channel state before we hit
255 /// CLTV_CLAIM_BUFFER, at which point we'd go on chain to claim the HTLC with the preimage.
257 /// (2) is the same, but with an additional buffer to avoid accepting an HTLC which is immediately
258 /// in a race condition between the user connecting a block (which would fail it) and the user
259 /// providing us the preimage (which would claim it).
261 /// (3) is about our counterparty - we don't want to relay an HTLC to a counterparty when they may
262 /// end up force-closing the channel on us to claim it.
263 pub(crate) const HTLC_FAIL_BACK_BUFFER: u32 = CLTV_CLAIM_BUFFER + LATENCY_GRACE_PERIOD_BLOCKS;
265 // TODO(devrandom) replace this with HolderCommitmentTransaction
266 #[derive(Clone, PartialEq)]
267 struct HolderSignedTx {
268 /// txid of the transaction in tx, just used to make comparison faster
270 revocation_key: PublicKey,
271 a_htlc_key: PublicKey,
272 b_htlc_key: PublicKey,
273 delayed_payment_key: PublicKey,
274 per_commitment_point: PublicKey,
276 htlc_outputs: Vec<(HTLCOutputInCommitment, Option<Signature>, Option<HTLCSource>)>,
278 impl_writeable_tlv_based!(HolderSignedTx, {
280 (2, revocation_key, required),
281 (4, a_htlc_key, required),
282 (6, b_htlc_key, required),
283 (8, delayed_payment_key, required),
284 (10, per_commitment_point, required),
285 (12, feerate_per_kw, required),
286 (14, htlc_outputs, vec_type)
289 /// We use this to track counterparty commitment transactions and htlcs outputs and
290 /// use it to generate any justice or 2nd-stage preimage/timeout transactions.
292 struct CounterpartyCommitmentTransaction {
293 counterparty_delayed_payment_base_key: PublicKey,
294 counterparty_htlc_base_key: PublicKey,
295 on_counterparty_tx_csv: u16,
296 per_htlc: HashMap<Txid, Vec<HTLCOutputInCommitment>>
299 impl Writeable for CounterpartyCommitmentTransaction {
300 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
301 w.write_all(&byte_utils::be64_to_array(self.per_htlc.len() as u64))?;
302 for (ref txid, ref htlcs) in self.per_htlc.iter() {
303 w.write_all(&txid[..])?;
304 w.write_all(&byte_utils::be64_to_array(htlcs.len() as u64))?;
305 for &ref htlc in htlcs.iter() {
309 write_tlv_fields!(w, {
310 (0, self.counterparty_delayed_payment_base_key, required),
311 (2, self.counterparty_htlc_base_key, required),
312 (4, self.on_counterparty_tx_csv, required),
317 impl Readable for CounterpartyCommitmentTransaction {
318 fn read<R: io::Read>(r: &mut R) -> Result<Self, DecodeError> {
319 let counterparty_commitment_transaction = {
320 let per_htlc_len: u64 = Readable::read(r)?;
321 let mut per_htlc = HashMap::with_capacity(cmp::min(per_htlc_len as usize, MAX_ALLOC_SIZE / 64));
322 for _ in 0..per_htlc_len {
323 let txid: Txid = Readable::read(r)?;
324 let htlcs_count: u64 = Readable::read(r)?;
325 let mut htlcs = Vec::with_capacity(cmp::min(htlcs_count as usize, MAX_ALLOC_SIZE / 32));
326 for _ in 0..htlcs_count {
327 let htlc = Readable::read(r)?;
330 if let Some(_) = per_htlc.insert(txid, htlcs) {
331 return Err(DecodeError::InvalidValue);
334 let mut counterparty_delayed_payment_base_key = OptionDeserWrapper(None);
335 let mut counterparty_htlc_base_key = OptionDeserWrapper(None);
336 let mut on_counterparty_tx_csv: u16 = 0;
337 read_tlv_fields!(r, {
338 (0, counterparty_delayed_payment_base_key, required),
339 (2, counterparty_htlc_base_key, required),
340 (4, on_counterparty_tx_csv, required),
342 CounterpartyCommitmentTransaction {
343 counterparty_delayed_payment_base_key: counterparty_delayed_payment_base_key.0.unwrap(),
344 counterparty_htlc_base_key: counterparty_htlc_base_key.0.unwrap(),
345 on_counterparty_tx_csv,
349 Ok(counterparty_commitment_transaction)
353 /// An entry for an [`OnchainEvent`], stating the block height when the event was observed and the
354 /// transaction causing it.
356 /// Used to determine when the on-chain event can be considered safe from a chain reorganization.
358 struct OnchainEventEntry {
364 impl OnchainEventEntry {
365 fn confirmation_threshold(&self) -> u32 {
366 let mut conf_threshold = self.height + ANTI_REORG_DELAY - 1;
367 if let OnchainEvent::MaturingOutput {
368 descriptor: SpendableOutputDescriptor::DelayedPaymentOutput(ref descriptor)
370 // A CSV'd transaction is confirmable in block (input height) + CSV delay, which means
371 // it's broadcastable when we see the previous block.
372 conf_threshold = cmp::max(conf_threshold, self.height + descriptor.to_self_delay as u32 - 1);
377 fn has_reached_confirmation_threshold(&self, best_block: &BestBlock) -> bool {
378 best_block.height() >= self.confirmation_threshold()
382 /// Upon discovering of some classes of onchain tx by ChannelMonitor, we may have to take actions on it
383 /// once they mature to enough confirmations (ANTI_REORG_DELAY)
386 /// HTLC output getting solved by a timeout, at maturation we pass upstream payment source information to solve
387 /// inbound HTLC in backward channel. Note, in case of preimage, we pass info to upstream without delay as we can
388 /// only win from it, so it's never an OnchainEvent
391 payment_hash: PaymentHash,
392 onchain_value_satoshis: Option<u64>,
395 descriptor: SpendableOutputDescriptor,
399 impl Writeable for OnchainEventEntry {
400 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
401 write_tlv_fields!(writer, {
402 (0, self.txid, required),
403 (2, self.height, required),
404 (4, self.event, required),
410 impl MaybeReadable for OnchainEventEntry {
411 fn read<R: io::Read>(reader: &mut R) -> Result<Option<Self>, DecodeError> {
412 let mut txid = Default::default();
414 let mut event = None;
415 read_tlv_fields!(reader, {
417 (2, height, required),
418 (4, event, ignorable),
420 if let Some(ev) = event {
421 Ok(Some(Self { txid, height, event: ev }))
428 impl_writeable_tlv_based_enum_upgradable!(OnchainEvent,
430 (0, source, required),
431 (1, onchain_value_satoshis, option),
432 (2, payment_hash, required),
434 (1, MaturingOutput) => {
435 (0, descriptor, required),
439 #[cfg_attr(any(test, feature = "fuzztarget", feature = "_test_utils"), derive(PartialEq))]
441 pub(crate) enum ChannelMonitorUpdateStep {
442 LatestHolderCommitmentTXInfo {
443 commitment_tx: HolderCommitmentTransaction,
444 htlc_outputs: Vec<(HTLCOutputInCommitment, Option<Signature>, Option<HTLCSource>)>,
446 LatestCounterpartyCommitmentTXInfo {
447 commitment_txid: Txid,
448 htlc_outputs: Vec<(HTLCOutputInCommitment, Option<Box<HTLCSource>>)>,
449 commitment_number: u64,
450 their_revocation_point: PublicKey,
453 payment_preimage: PaymentPreimage,
459 /// Used to indicate that the no future updates will occur, and likely that the latest holder
460 /// commitment transaction(s) should be broadcast, as the channel has been force-closed.
462 /// If set to false, we shouldn't broadcast the latest holder commitment transaction as we
463 /// think we've fallen behind!
464 should_broadcast: bool,
467 scriptpubkey: Script,
471 impl_writeable_tlv_based_enum_upgradable!(ChannelMonitorUpdateStep,
472 (0, LatestHolderCommitmentTXInfo) => {
473 (0, commitment_tx, required),
474 (2, htlc_outputs, vec_type),
476 (1, LatestCounterpartyCommitmentTXInfo) => {
477 (0, commitment_txid, required),
478 (2, commitment_number, required),
479 (4, their_revocation_point, required),
480 (6, htlc_outputs, vec_type),
482 (2, PaymentPreimage) => {
483 (0, payment_preimage, required),
485 (3, CommitmentSecret) => {
487 (2, secret, required),
489 (4, ChannelForceClosed) => {
490 (0, should_broadcast, required),
492 (5, ShutdownScript) => {
493 (0, scriptpubkey, required),
497 /// A ChannelMonitor handles chain events (blocks connected and disconnected) and generates
498 /// on-chain transactions to ensure no loss of funds occurs.
500 /// You MUST ensure that no ChannelMonitors for a given channel anywhere contain out-of-date
501 /// information and are actively monitoring the chain.
503 /// Pending Events or updated HTLCs which have not yet been read out by
504 /// get_and_clear_pending_monitor_events or get_and_clear_pending_events are serialized to disk and
505 /// reloaded at deserialize-time. Thus, you must ensure that, when handling events, all events
506 /// gotten are fully handled before re-serializing the new state.
508 /// Note that the deserializer is only implemented for (BlockHash, ChannelMonitor), which
509 /// tells you the last block hash which was block_connect()ed. You MUST rescan any blocks along
510 /// the "reorg path" (ie disconnecting blocks until you find a common ancestor from both the
511 /// returned block hash and the the current chain and then reconnecting blocks to get to the
512 /// best chain) upon deserializing the object!
513 pub struct ChannelMonitor<Signer: Sign> {
515 pub(crate) inner: Mutex<ChannelMonitorImpl<Signer>>,
517 inner: Mutex<ChannelMonitorImpl<Signer>>,
520 pub(crate) struct ChannelMonitorImpl<Signer: Sign> {
521 latest_update_id: u64,
522 commitment_transaction_number_obscure_factor: u64,
524 destination_script: Script,
525 broadcasted_holder_revokable_script: Option<(Script, PublicKey, PublicKey)>,
526 counterparty_payment_script: Script,
527 shutdown_script: Option<Script>,
529 channel_keys_id: [u8; 32],
530 holder_revocation_basepoint: PublicKey,
531 funding_info: (OutPoint, Script),
532 current_counterparty_commitment_txid: Option<Txid>,
533 prev_counterparty_commitment_txid: Option<Txid>,
535 counterparty_tx_cache: CounterpartyCommitmentTransaction,
536 funding_redeemscript: Script,
537 channel_value_satoshis: u64,
538 // first is the idx of the first of the two revocation points
539 their_cur_revocation_points: Option<(u64, PublicKey, Option<PublicKey>)>,
541 on_holder_tx_csv: u16,
543 commitment_secrets: CounterpartyCommitmentSecrets,
544 /// The set of outpoints in each counterparty commitment transaction. We always need at least
545 /// the payment hash from `HTLCOutputInCommitment` to claim even a revoked commitment
546 /// transaction broadcast as we need to be able to construct the witness script in all cases.
547 counterparty_claimable_outpoints: HashMap<Txid, Vec<(HTLCOutputInCommitment, Option<Box<HTLCSource>>)>>,
548 /// We cannot identify HTLC-Success or HTLC-Timeout transactions by themselves on the chain.
549 /// Nor can we figure out their commitment numbers without the commitment transaction they are
550 /// spending. Thus, in order to claim them via revocation key, we track all the counterparty
551 /// commitment transactions which we find on-chain, mapping them to the commitment number which
552 /// can be used to derive the revocation key and claim the transactions.
553 counterparty_commitment_txn_on_chain: HashMap<Txid, u64>,
554 /// Cache used to make pruning of payment_preimages faster.
555 /// Maps payment_hash values to commitment numbers for counterparty transactions for non-revoked
556 /// counterparty transactions (ie should remain pretty small).
557 /// Serialized to disk but should generally not be sent to Watchtowers.
558 counterparty_hash_commitment_number: HashMap<PaymentHash, u64>,
560 // We store two holder commitment transactions to avoid any race conditions where we may update
561 // some monitors (potentially on watchtowers) but then fail to update others, resulting in the
562 // various monitors for one channel being out of sync, and us broadcasting a holder
563 // transaction for which we have deleted claim information on some watchtowers.
564 prev_holder_signed_commitment_tx: Option<HolderSignedTx>,
565 current_holder_commitment_tx: HolderSignedTx,
567 // Used just for ChannelManager to make sure it has the latest channel data during
569 current_counterparty_commitment_number: u64,
570 // Used just for ChannelManager to make sure it has the latest channel data during
572 current_holder_commitment_number: u64,
574 payment_preimages: HashMap<PaymentHash, PaymentPreimage>,
576 pending_monitor_events: Vec<MonitorEvent>,
577 pending_events: Vec<Event>,
579 // Used to track on-chain events (i.e., transactions part of channels confirmed on chain) on
580 // which to take actions once they reach enough confirmations. Each entry includes the
581 // transaction's id and the height when the transaction was confirmed on chain.
582 onchain_events_awaiting_threshold_conf: Vec<OnchainEventEntry>,
584 // If we get serialized out and re-read, we need to make sure that the chain monitoring
585 // interface knows about the TXOs that we want to be notified of spends of. We could probably
586 // be smart and derive them from the above storage fields, but its much simpler and more
587 // Obviously Correct (tm) if we just keep track of them explicitly.
588 outputs_to_watch: HashMap<Txid, Vec<(u32, Script)>>,
591 pub onchain_tx_handler: OnchainTxHandler<Signer>,
593 onchain_tx_handler: OnchainTxHandler<Signer>,
595 // This is set when the Channel[Manager] generated a ChannelMonitorUpdate which indicated the
596 // channel has been force-closed. After this is set, no further holder commitment transaction
597 // updates may occur, and we panic!() if one is provided.
598 lockdown_from_offchain: bool,
600 // Set once we've signed a holder commitment transaction and handed it over to our
601 // OnchainTxHandler. After this is set, no future updates to our holder commitment transactions
602 // may occur, and we fail any such monitor updates.
604 // In case of update rejection due to a locally already signed commitment transaction, we
605 // nevertheless store update content to track in case of concurrent broadcast by another
606 // remote monitor out-of-order with regards to the block view.
607 holder_tx_signed: bool,
609 // We simply modify best_block in Channel's block_connected so that serialization is
610 // consistent but hopefully the users' copy handles block_connected in a consistent way.
611 // (we do *not*, however, update them in update_monitor to ensure any local user copies keep
612 // their best_block from its state and not based on updated copies that didn't run through
613 // the full block_connected).
614 best_block: BestBlock,
616 secp_ctx: Secp256k1<secp256k1::All>, //TODO: dedup this a bit...
619 /// Transaction outputs to watch for on-chain spends.
620 pub type TransactionOutputs = (Txid, Vec<(u32, TxOut)>);
622 #[cfg(any(test, feature = "fuzztarget", feature = "_test_utils"))]
623 /// Used only in testing and fuzztarget to check serialization roundtrips don't change the
624 /// underlying object
625 impl<Signer: Sign> PartialEq for ChannelMonitor<Signer> {
626 fn eq(&self, other: &Self) -> bool {
627 let inner = self.inner.lock().unwrap();
628 let other = other.inner.lock().unwrap();
633 #[cfg(any(test, feature = "fuzztarget", feature = "_test_utils"))]
634 /// Used only in testing and fuzztarget to check serialization roundtrips don't change the
635 /// underlying object
636 impl<Signer: Sign> PartialEq for ChannelMonitorImpl<Signer> {
637 fn eq(&self, other: &Self) -> bool {
638 if self.latest_update_id != other.latest_update_id ||
639 self.commitment_transaction_number_obscure_factor != other.commitment_transaction_number_obscure_factor ||
640 self.destination_script != other.destination_script ||
641 self.broadcasted_holder_revokable_script != other.broadcasted_holder_revokable_script ||
642 self.counterparty_payment_script != other.counterparty_payment_script ||
643 self.channel_keys_id != other.channel_keys_id ||
644 self.holder_revocation_basepoint != other.holder_revocation_basepoint ||
645 self.funding_info != other.funding_info ||
646 self.current_counterparty_commitment_txid != other.current_counterparty_commitment_txid ||
647 self.prev_counterparty_commitment_txid != other.prev_counterparty_commitment_txid ||
648 self.counterparty_tx_cache != other.counterparty_tx_cache ||
649 self.funding_redeemscript != other.funding_redeemscript ||
650 self.channel_value_satoshis != other.channel_value_satoshis ||
651 self.their_cur_revocation_points != other.their_cur_revocation_points ||
652 self.on_holder_tx_csv != other.on_holder_tx_csv ||
653 self.commitment_secrets != other.commitment_secrets ||
654 self.counterparty_claimable_outpoints != other.counterparty_claimable_outpoints ||
655 self.counterparty_commitment_txn_on_chain != other.counterparty_commitment_txn_on_chain ||
656 self.counterparty_hash_commitment_number != other.counterparty_hash_commitment_number ||
657 self.prev_holder_signed_commitment_tx != other.prev_holder_signed_commitment_tx ||
658 self.current_counterparty_commitment_number != other.current_counterparty_commitment_number ||
659 self.current_holder_commitment_number != other.current_holder_commitment_number ||
660 self.current_holder_commitment_tx != other.current_holder_commitment_tx ||
661 self.payment_preimages != other.payment_preimages ||
662 self.pending_monitor_events != other.pending_monitor_events ||
663 self.pending_events.len() != other.pending_events.len() || // We trust events to round-trip properly
664 self.onchain_events_awaiting_threshold_conf != other.onchain_events_awaiting_threshold_conf ||
665 self.outputs_to_watch != other.outputs_to_watch ||
666 self.lockdown_from_offchain != other.lockdown_from_offchain ||
667 self.holder_tx_signed != other.holder_tx_signed
676 impl<Signer: Sign> Writeable for ChannelMonitor<Signer> {
677 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), Error> {
678 self.inner.lock().unwrap().write(writer)
682 // These are also used for ChannelMonitorUpdate, above.
683 const SERIALIZATION_VERSION: u8 = 1;
684 const MIN_SERIALIZATION_VERSION: u8 = 1;
686 impl<Signer: Sign> Writeable for ChannelMonitorImpl<Signer> {
687 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), Error> {
688 write_ver_prefix!(writer, SERIALIZATION_VERSION, MIN_SERIALIZATION_VERSION);
690 self.latest_update_id.write(writer)?;
692 // Set in initial Channel-object creation, so should always be set by now:
693 U48(self.commitment_transaction_number_obscure_factor).write(writer)?;
695 self.destination_script.write(writer)?;
696 if let Some(ref broadcasted_holder_revokable_script) = self.broadcasted_holder_revokable_script {
697 writer.write_all(&[0; 1])?;
698 broadcasted_holder_revokable_script.0.write(writer)?;
699 broadcasted_holder_revokable_script.1.write(writer)?;
700 broadcasted_holder_revokable_script.2.write(writer)?;
702 writer.write_all(&[1; 1])?;
705 self.counterparty_payment_script.write(writer)?;
706 match &self.shutdown_script {
707 Some(script) => script.write(writer)?,
708 None => Script::new().write(writer)?,
711 self.channel_keys_id.write(writer)?;
712 self.holder_revocation_basepoint.write(writer)?;
713 writer.write_all(&self.funding_info.0.txid[..])?;
714 writer.write_all(&byte_utils::be16_to_array(self.funding_info.0.index))?;
715 self.funding_info.1.write(writer)?;
716 self.current_counterparty_commitment_txid.write(writer)?;
717 self.prev_counterparty_commitment_txid.write(writer)?;
719 self.counterparty_tx_cache.write(writer)?;
720 self.funding_redeemscript.write(writer)?;
721 self.channel_value_satoshis.write(writer)?;
723 match self.their_cur_revocation_points {
724 Some((idx, pubkey, second_option)) => {
725 writer.write_all(&byte_utils::be48_to_array(idx))?;
726 writer.write_all(&pubkey.serialize())?;
727 match second_option {
728 Some(second_pubkey) => {
729 writer.write_all(&second_pubkey.serialize())?;
732 writer.write_all(&[0; 33])?;
737 writer.write_all(&byte_utils::be48_to_array(0))?;
741 writer.write_all(&byte_utils::be16_to_array(self.on_holder_tx_csv))?;
743 self.commitment_secrets.write(writer)?;
745 macro_rules! serialize_htlc_in_commitment {
746 ($htlc_output: expr) => {
747 writer.write_all(&[$htlc_output.offered as u8; 1])?;
748 writer.write_all(&byte_utils::be64_to_array($htlc_output.amount_msat))?;
749 writer.write_all(&byte_utils::be32_to_array($htlc_output.cltv_expiry))?;
750 writer.write_all(&$htlc_output.payment_hash.0[..])?;
751 $htlc_output.transaction_output_index.write(writer)?;
755 writer.write_all(&byte_utils::be64_to_array(self.counterparty_claimable_outpoints.len() as u64))?;
756 for (ref txid, ref htlc_infos) in self.counterparty_claimable_outpoints.iter() {
757 writer.write_all(&txid[..])?;
758 writer.write_all(&byte_utils::be64_to_array(htlc_infos.len() as u64))?;
759 for &(ref htlc_output, ref htlc_source) in htlc_infos.iter() {
760 serialize_htlc_in_commitment!(htlc_output);
761 htlc_source.as_ref().map(|b| b.as_ref()).write(writer)?;
765 writer.write_all(&byte_utils::be64_to_array(self.counterparty_commitment_txn_on_chain.len() as u64))?;
766 for (ref txid, commitment_number) in self.counterparty_commitment_txn_on_chain.iter() {
767 writer.write_all(&txid[..])?;
768 writer.write_all(&byte_utils::be48_to_array(*commitment_number))?;
771 writer.write_all(&byte_utils::be64_to_array(self.counterparty_hash_commitment_number.len() as u64))?;
772 for (ref payment_hash, commitment_number) in self.counterparty_hash_commitment_number.iter() {
773 writer.write_all(&payment_hash.0[..])?;
774 writer.write_all(&byte_utils::be48_to_array(*commitment_number))?;
777 if let Some(ref prev_holder_tx) = self.prev_holder_signed_commitment_tx {
778 writer.write_all(&[1; 1])?;
779 prev_holder_tx.write(writer)?;
781 writer.write_all(&[0; 1])?;
784 self.current_holder_commitment_tx.write(writer)?;
786 writer.write_all(&byte_utils::be48_to_array(self.current_counterparty_commitment_number))?;
787 writer.write_all(&byte_utils::be48_to_array(self.current_holder_commitment_number))?;
789 writer.write_all(&byte_utils::be64_to_array(self.payment_preimages.len() as u64))?;
790 for payment_preimage in self.payment_preimages.values() {
791 writer.write_all(&payment_preimage.0[..])?;
794 writer.write_all(&byte_utils::be64_to_array(self.pending_monitor_events.len() as u64))?;
795 for event in self.pending_monitor_events.iter() {
797 MonitorEvent::HTLCEvent(upd) => {
801 MonitorEvent::CommitmentTxBroadcasted(_) => 1u8.write(writer)?
805 writer.write_all(&byte_utils::be64_to_array(self.pending_events.len() as u64))?;
806 for event in self.pending_events.iter() {
807 event.write(writer)?;
810 self.best_block.block_hash().write(writer)?;
811 writer.write_all(&byte_utils::be32_to_array(self.best_block.height()))?;
813 writer.write_all(&byte_utils::be64_to_array(self.onchain_events_awaiting_threshold_conf.len() as u64))?;
814 for ref entry in self.onchain_events_awaiting_threshold_conf.iter() {
815 entry.write(writer)?;
818 (self.outputs_to_watch.len() as u64).write(writer)?;
819 for (txid, idx_scripts) in self.outputs_to_watch.iter() {
821 (idx_scripts.len() as u64).write(writer)?;
822 for (idx, script) in idx_scripts.iter() {
824 script.write(writer)?;
827 self.onchain_tx_handler.write(writer)?;
829 self.lockdown_from_offchain.write(writer)?;
830 self.holder_tx_signed.write(writer)?;
832 write_tlv_fields!(writer, {});
838 impl<Signer: Sign> ChannelMonitor<Signer> {
839 pub(crate) fn new(secp_ctx: Secp256k1<secp256k1::All>, keys: Signer, shutdown_script: Option<Script>,
840 on_counterparty_tx_csv: u16, destination_script: &Script, funding_info: (OutPoint, Script),
841 channel_parameters: &ChannelTransactionParameters,
842 funding_redeemscript: Script, channel_value_satoshis: u64,
843 commitment_transaction_number_obscure_factor: u64,
844 initial_holder_commitment_tx: HolderCommitmentTransaction,
845 best_block: BestBlock) -> ChannelMonitor<Signer> {
847 assert!(commitment_transaction_number_obscure_factor <= (1 << 48));
848 let payment_key_hash = WPubkeyHash::hash(&keys.pubkeys().payment_point.serialize());
849 let counterparty_payment_script = Builder::new().push_opcode(opcodes::all::OP_PUSHBYTES_0).push_slice(&payment_key_hash[..]).into_script();
851 let counterparty_channel_parameters = channel_parameters.counterparty_parameters.as_ref().unwrap();
852 let counterparty_delayed_payment_base_key = counterparty_channel_parameters.pubkeys.delayed_payment_basepoint;
853 let counterparty_htlc_base_key = counterparty_channel_parameters.pubkeys.htlc_basepoint;
854 let counterparty_tx_cache = CounterpartyCommitmentTransaction { counterparty_delayed_payment_base_key, counterparty_htlc_base_key, on_counterparty_tx_csv, per_htlc: HashMap::new() };
856 let channel_keys_id = keys.channel_keys_id();
857 let holder_revocation_basepoint = keys.pubkeys().revocation_basepoint;
859 // block for Rust 1.34 compat
860 let (holder_commitment_tx, current_holder_commitment_number) = {
861 let trusted_tx = initial_holder_commitment_tx.trust();
862 let txid = trusted_tx.txid();
864 let tx_keys = trusted_tx.keys();
865 let holder_commitment_tx = HolderSignedTx {
867 revocation_key: tx_keys.revocation_key,
868 a_htlc_key: tx_keys.broadcaster_htlc_key,
869 b_htlc_key: tx_keys.countersignatory_htlc_key,
870 delayed_payment_key: tx_keys.broadcaster_delayed_payment_key,
871 per_commitment_point: tx_keys.per_commitment_point,
872 feerate_per_kw: trusted_tx.feerate_per_kw(),
873 htlc_outputs: Vec::new(), // There are never any HTLCs in the initial commitment transactions
875 (holder_commitment_tx, trusted_tx.commitment_number())
878 let onchain_tx_handler =
879 OnchainTxHandler::new(destination_script.clone(), keys,
880 channel_parameters.clone(), initial_holder_commitment_tx, secp_ctx.clone());
882 let mut outputs_to_watch = HashMap::new();
883 outputs_to_watch.insert(funding_info.0.txid, vec![(funding_info.0.index as u32, funding_info.1.clone())]);
886 inner: Mutex::new(ChannelMonitorImpl {
888 commitment_transaction_number_obscure_factor,
890 destination_script: destination_script.clone(),
891 broadcasted_holder_revokable_script: None,
892 counterparty_payment_script,
896 holder_revocation_basepoint,
898 current_counterparty_commitment_txid: None,
899 prev_counterparty_commitment_txid: None,
901 counterparty_tx_cache,
902 funding_redeemscript,
903 channel_value_satoshis,
904 their_cur_revocation_points: None,
906 on_holder_tx_csv: counterparty_channel_parameters.selected_contest_delay,
908 commitment_secrets: CounterpartyCommitmentSecrets::new(),
909 counterparty_claimable_outpoints: HashMap::new(),
910 counterparty_commitment_txn_on_chain: HashMap::new(),
911 counterparty_hash_commitment_number: HashMap::new(),
913 prev_holder_signed_commitment_tx: None,
914 current_holder_commitment_tx: holder_commitment_tx,
915 current_counterparty_commitment_number: 1 << 48,
916 current_holder_commitment_number,
918 payment_preimages: HashMap::new(),
919 pending_monitor_events: Vec::new(),
920 pending_events: Vec::new(),
922 onchain_events_awaiting_threshold_conf: Vec::new(),
927 lockdown_from_offchain: false,
928 holder_tx_signed: false,
938 fn provide_secret(&self, idx: u64, secret: [u8; 32]) -> Result<(), MonitorUpdateError> {
939 self.inner.lock().unwrap().provide_secret(idx, secret)
942 /// Informs this monitor of the latest counterparty (ie non-broadcastable) commitment transaction.
943 /// The monitor watches for it to be broadcasted and then uses the HTLC information (and
944 /// possibly future revocation/preimage information) to claim outputs where possible.
945 /// We cache also the mapping hash:commitment number to lighten pruning of old preimages by watchtowers.
946 pub(crate) fn provide_latest_counterparty_commitment_tx<L: Deref>(
949 htlc_outputs: Vec<(HTLCOutputInCommitment, Option<Box<HTLCSource>>)>,
950 commitment_number: u64,
951 their_revocation_point: PublicKey,
953 ) where L::Target: Logger {
954 self.inner.lock().unwrap().provide_latest_counterparty_commitment_tx(
955 txid, htlc_outputs, commitment_number, their_revocation_point, logger)
959 fn provide_latest_holder_commitment_tx(
961 holder_commitment_tx: HolderCommitmentTransaction,
962 htlc_outputs: Vec<(HTLCOutputInCommitment, Option<Signature>, Option<HTLCSource>)>,
963 ) -> Result<(), MonitorUpdateError> {
964 self.inner.lock().unwrap().provide_latest_holder_commitment_tx(
965 holder_commitment_tx, htlc_outputs)
969 pub(crate) fn provide_payment_preimage<B: Deref, F: Deref, L: Deref>(
971 payment_hash: &PaymentHash,
972 payment_preimage: &PaymentPreimage,
977 B::Target: BroadcasterInterface,
978 F::Target: FeeEstimator,
981 self.inner.lock().unwrap().provide_payment_preimage(
982 payment_hash, payment_preimage, broadcaster, fee_estimator, logger)
985 pub(crate) fn broadcast_latest_holder_commitment_txn<B: Deref, L: Deref>(
990 B::Target: BroadcasterInterface,
993 self.inner.lock().unwrap().broadcast_latest_holder_commitment_txn(broadcaster, logger)
996 /// Updates a ChannelMonitor on the basis of some new information provided by the Channel
999 /// panics if the given update is not the next update by update_id.
1000 pub fn update_monitor<B: Deref, F: Deref, L: Deref>(
1002 updates: &ChannelMonitorUpdate,
1006 ) -> Result<(), MonitorUpdateError>
1008 B::Target: BroadcasterInterface,
1009 F::Target: FeeEstimator,
1012 self.inner.lock().unwrap().update_monitor(updates, broadcaster, fee_estimator, logger)
1015 /// Gets the update_id from the latest ChannelMonitorUpdate which was applied to this
1017 pub fn get_latest_update_id(&self) -> u64 {
1018 self.inner.lock().unwrap().get_latest_update_id()
1021 /// Gets the funding transaction outpoint of the channel this ChannelMonitor is monitoring for.
1022 pub fn get_funding_txo(&self) -> (OutPoint, Script) {
1023 self.inner.lock().unwrap().get_funding_txo().clone()
1026 /// Gets a list of txids, with their output scripts (in the order they appear in the
1027 /// transaction), which we must learn about spends of via block_connected().
1028 pub fn get_outputs_to_watch(&self) -> Vec<(Txid, Vec<(u32, Script)>)> {
1029 self.inner.lock().unwrap().get_outputs_to_watch()
1030 .iter().map(|(txid, outputs)| (*txid, outputs.clone())).collect()
1033 /// Loads the funding txo and outputs to watch into the given `chain::Filter` by repeatedly
1034 /// calling `chain::Filter::register_output` and `chain::Filter::register_tx` until all outputs
1035 /// have been registered.
1036 pub fn load_outputs_to_watch<F: Deref>(&self, filter: &F) where F::Target: chain::Filter {
1037 let lock = self.inner.lock().unwrap();
1038 filter.register_tx(&lock.get_funding_txo().0.txid, &lock.get_funding_txo().1);
1039 for (txid, outputs) in lock.get_outputs_to_watch().iter() {
1040 for (index, script_pubkey) in outputs.iter() {
1041 assert!(*index <= u16::max_value() as u32);
1042 filter.register_output(WatchedOutput {
1044 outpoint: OutPoint { txid: *txid, index: *index as u16 },
1045 script_pubkey: script_pubkey.clone(),
1051 /// Get the list of HTLCs who's status has been updated on chain. This should be called by
1052 /// ChannelManager via [`chain::Watch::release_pending_monitor_events`].
1053 pub fn get_and_clear_pending_monitor_events(&self) -> Vec<MonitorEvent> {
1054 self.inner.lock().unwrap().get_and_clear_pending_monitor_events()
1057 /// Gets the list of pending events which were generated by previous actions, clearing the list
1060 /// This is called by ChainMonitor::get_and_clear_pending_events() and is equivalent to
1061 /// EventsProvider::get_and_clear_pending_events() except that it requires &mut self as we do
1062 /// no internal locking in ChannelMonitors.
1063 pub fn get_and_clear_pending_events(&self) -> Vec<Event> {
1064 self.inner.lock().unwrap().get_and_clear_pending_events()
1067 pub(crate) fn get_min_seen_secret(&self) -> u64 {
1068 self.inner.lock().unwrap().get_min_seen_secret()
1071 pub(crate) fn get_cur_counterparty_commitment_number(&self) -> u64 {
1072 self.inner.lock().unwrap().get_cur_counterparty_commitment_number()
1075 pub(crate) fn get_cur_holder_commitment_number(&self) -> u64 {
1076 self.inner.lock().unwrap().get_cur_holder_commitment_number()
1079 /// Used by ChannelManager deserialization to broadcast the latest holder state if its copy of
1080 /// the Channel was out-of-date. You may use it to get a broadcastable holder toxic tx in case of
1081 /// fallen-behind, i.e when receiving a channel_reestablish with a proof that our counterparty side knows
1082 /// a higher revocation secret than the holder commitment number we are aware of. Broadcasting these
1083 /// transactions are UNSAFE, as they allow counterparty side to punish you. Nevertheless you may want to
1084 /// broadcast them if counterparty don't close channel with his higher commitment transaction after a
1085 /// substantial amount of time (a month or even a year) to get back funds. Best may be to contact
1086 /// out-of-band the other node operator to coordinate with him if option is available to you.
1087 /// In any-case, choice is up to the user.
1088 pub fn get_latest_holder_commitment_txn<L: Deref>(&self, logger: &L) -> Vec<Transaction>
1089 where L::Target: Logger {
1090 self.inner.lock().unwrap().get_latest_holder_commitment_txn(logger)
1093 /// Unsafe test-only version of get_latest_holder_commitment_txn used by our test framework
1094 /// to bypass HolderCommitmentTransaction state update lockdown after signature and generate
1095 /// revoked commitment transaction.
1096 #[cfg(any(test, feature = "unsafe_revoked_tx_signing"))]
1097 pub fn unsafe_get_latest_holder_commitment_txn<L: Deref>(&self, logger: &L) -> Vec<Transaction>
1098 where L::Target: Logger {
1099 self.inner.lock().unwrap().unsafe_get_latest_holder_commitment_txn(logger)
1102 /// Processes transactions in a newly connected block, which may result in any of the following:
1103 /// - update the monitor's state against resolved HTLCs
1104 /// - punish the counterparty in the case of seeing a revoked commitment transaction
1105 /// - force close the channel and claim/timeout incoming/outgoing HTLCs if near expiration
1106 /// - detect settled outputs for later spending
1107 /// - schedule and bump any in-flight claims
1109 /// Returns any new outputs to watch from `txdata`; after called, these are also included in
1110 /// [`get_outputs_to_watch`].
1112 /// [`get_outputs_to_watch`]: #method.get_outputs_to_watch
1113 pub fn block_connected<B: Deref, F: Deref, L: Deref>(
1115 header: &BlockHeader,
1116 txdata: &TransactionData,
1121 ) -> Vec<TransactionOutputs>
1123 B::Target: BroadcasterInterface,
1124 F::Target: FeeEstimator,
1127 self.inner.lock().unwrap().block_connected(
1128 header, txdata, height, broadcaster, fee_estimator, logger)
1131 /// Determines if the disconnected block contained any transactions of interest and updates
1133 pub fn block_disconnected<B: Deref, F: Deref, L: Deref>(
1135 header: &BlockHeader,
1141 B::Target: BroadcasterInterface,
1142 F::Target: FeeEstimator,
1145 self.inner.lock().unwrap().block_disconnected(
1146 header, height, broadcaster, fee_estimator, logger)
1149 /// Processes transactions confirmed in a block with the given header and height, returning new
1150 /// outputs to watch. See [`block_connected`] for details.
1152 /// Used instead of [`block_connected`] by clients that are notified of transactions rather than
1153 /// blocks. See [`chain::Confirm`] for calling expectations.
1155 /// [`block_connected`]: Self::block_connected
1156 pub fn transactions_confirmed<B: Deref, F: Deref, L: Deref>(
1158 header: &BlockHeader,
1159 txdata: &TransactionData,
1164 ) -> Vec<TransactionOutputs>
1166 B::Target: BroadcasterInterface,
1167 F::Target: FeeEstimator,
1170 self.inner.lock().unwrap().transactions_confirmed(
1171 header, txdata, height, broadcaster, fee_estimator, logger)
1174 /// Processes a transaction that was reorganized out of the chain.
1176 /// Used instead of [`block_disconnected`] by clients that are notified of transactions rather
1177 /// than blocks. See [`chain::Confirm`] for calling expectations.
1179 /// [`block_disconnected`]: Self::block_disconnected
1180 pub fn transaction_unconfirmed<B: Deref, F: Deref, L: Deref>(
1187 B::Target: BroadcasterInterface,
1188 F::Target: FeeEstimator,
1191 self.inner.lock().unwrap().transaction_unconfirmed(
1192 txid, broadcaster, fee_estimator, logger);
1195 /// Updates the monitor with the current best chain tip, returning new outputs to watch. See
1196 /// [`block_connected`] for details.
1198 /// Used instead of [`block_connected`] by clients that are notified of transactions rather than
1199 /// blocks. See [`chain::Confirm`] for calling expectations.
1201 /// [`block_connected`]: Self::block_connected
1202 pub fn best_block_updated<B: Deref, F: Deref, L: Deref>(
1204 header: &BlockHeader,
1209 ) -> Vec<TransactionOutputs>
1211 B::Target: BroadcasterInterface,
1212 F::Target: FeeEstimator,
1215 self.inner.lock().unwrap().best_block_updated(
1216 header, height, broadcaster, fee_estimator, logger)
1219 /// Returns the set of txids that should be monitored for re-organization out of the chain.
1220 pub fn get_relevant_txids(&self) -> Vec<Txid> {
1221 let inner = self.inner.lock().unwrap();
1222 let mut txids: Vec<Txid> = inner.onchain_events_awaiting_threshold_conf
1224 .map(|entry| entry.txid)
1225 .chain(inner.onchain_tx_handler.get_relevant_txids().into_iter())
1227 txids.sort_unstable();
1232 /// Gets the latest best block which was connected either via the [`chain::Listen`] or
1233 /// [`chain::Confirm`] interfaces.
1234 pub fn current_best_block(&self) -> BestBlock {
1235 self.inner.lock().unwrap().best_block.clone()
1239 /// Compares a broadcasted commitment transaction's HTLCs with those in the latest state,
1240 /// failing any HTLCs which didn't make it into the broadcasted commitment transaction back
1241 /// after ANTI_REORG_DELAY blocks.
1243 /// We always compare against the set of HTLCs in counterparty commitment transactions, as those
1244 /// are the commitment transactions which are generated by us. The off-chain state machine in
1245 /// `Channel` will automatically resolve any HTLCs which were never included in a commitment
1246 /// transaction when it detects channel closure, but it is up to us to ensure any HTLCs which were
1247 /// included in a remote commitment transaction are failed back if they are not present in the
1248 /// broadcasted commitment transaction.
1250 /// Specifically, the removal process for HTLCs in `Channel` is always based on the counterparty
1251 /// sending a `revoke_and_ack`, which causes us to clear `prev_counterparty_commitment_txid`. Thus,
1252 /// as long as we examine both the current counterparty commitment transaction and, if it hasn't
1253 /// been revoked yet, the previous one, we we will never "forget" to resolve an HTLC.
1254 macro_rules! fail_unbroadcast_htlcs {
1255 ($self: expr, $commitment_tx_type: expr, $commitment_tx_conf_height: expr, $confirmed_htlcs_list: expr, $logger: expr) => { {
1256 macro_rules! check_htlc_fails {
1257 ($txid: expr, $commitment_tx: expr) => {
1258 if let Some(ref latest_outpoints) = $self.counterparty_claimable_outpoints.get($txid) {
1259 for &(ref htlc, ref source_option) in latest_outpoints.iter() {
1260 if let &Some(ref source) = source_option {
1261 // Check if the HTLC is present in the commitment transaction that was
1262 // broadcast, but not if it was below the dust limit, which we should
1263 // fail backwards immediately as there is no way for us to learn the
1264 // payment_preimage.
1265 // Note that if the dust limit were allowed to change between
1266 // commitment transactions we'd want to be check whether *any*
1267 // broadcastable commitment transaction has the HTLC in it, but it
1268 // cannot currently change after channel initialization, so we don't
1270 let confirmed_htlcs_iter: &mut Iterator<Item = (&HTLCOutputInCommitment, Option<&HTLCSource>)> = &mut $confirmed_htlcs_list;
1271 let mut matched_htlc = false;
1272 for (ref broadcast_htlc, ref broadcast_source) in confirmed_htlcs_iter {
1273 if broadcast_htlc.transaction_output_index.is_some() && Some(&**source) == *broadcast_source {
1274 matched_htlc = true;
1278 if matched_htlc { continue; }
1279 $self.onchain_events_awaiting_threshold_conf.retain(|ref entry| {
1280 if entry.height != $commitment_tx_conf_height { return true; }
1282 OnchainEvent::HTLCUpdate { source: ref update_source, .. } => {
1283 *update_source != **source
1288 let entry = OnchainEventEntry {
1290 height: $commitment_tx_conf_height,
1291 event: OnchainEvent::HTLCUpdate {
1292 source: (**source).clone(),
1293 payment_hash: htlc.payment_hash.clone(),
1294 onchain_value_satoshis: Some(htlc.amount_msat / 1000),
1297 log_trace!($logger, "Failing HTLC with payment_hash {} from {} counterparty commitment tx due to broadcast of {} commitment transaction, waiting for confirmation (at height {})",
1298 log_bytes!(htlc.payment_hash.0), $commitment_tx, $commitment_tx_type, entry.confirmation_threshold());
1299 $self.onchain_events_awaiting_threshold_conf.push(entry);
1305 if let Some(ref txid) = $self.current_counterparty_commitment_txid {
1306 check_htlc_fails!(txid, "current");
1308 if let Some(ref txid) = $self.prev_counterparty_commitment_txid {
1309 check_htlc_fails!(txid, "previous");
1314 impl<Signer: Sign> ChannelMonitorImpl<Signer> {
1315 /// Inserts a revocation secret into this channel monitor. Prunes old preimages if neither
1316 /// needed by holder commitment transactions HTCLs nor by counterparty ones. Unless we haven't already seen
1317 /// counterparty commitment transaction's secret, they are de facto pruned (we can use revocation key).
1318 fn provide_secret(&mut self, idx: u64, secret: [u8; 32]) -> Result<(), MonitorUpdateError> {
1319 if let Err(()) = self.commitment_secrets.provide_secret(idx, secret) {
1320 return Err(MonitorUpdateError("Previous secret did not match new one"));
1323 // Prune HTLCs from the previous counterparty commitment tx so we don't generate failure/fulfill
1324 // events for now-revoked/fulfilled HTLCs.
1325 if let Some(txid) = self.prev_counterparty_commitment_txid.take() {
1326 for &mut (_, ref mut source) in self.counterparty_claimable_outpoints.get_mut(&txid).unwrap() {
1331 if !self.payment_preimages.is_empty() {
1332 let cur_holder_signed_commitment_tx = &self.current_holder_commitment_tx;
1333 let prev_holder_signed_commitment_tx = self.prev_holder_signed_commitment_tx.as_ref();
1334 let min_idx = self.get_min_seen_secret();
1335 let counterparty_hash_commitment_number = &mut self.counterparty_hash_commitment_number;
1337 self.payment_preimages.retain(|&k, _| {
1338 for &(ref htlc, _, _) in cur_holder_signed_commitment_tx.htlc_outputs.iter() {
1339 if k == htlc.payment_hash {
1343 if let Some(prev_holder_commitment_tx) = prev_holder_signed_commitment_tx {
1344 for &(ref htlc, _, _) in prev_holder_commitment_tx.htlc_outputs.iter() {
1345 if k == htlc.payment_hash {
1350 let contains = if let Some(cn) = counterparty_hash_commitment_number.get(&k) {
1357 counterparty_hash_commitment_number.remove(&k);
1366 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 {
1367 // TODO: Encrypt the htlc_outputs data with the single-hash of the commitment transaction
1368 // so that a remote monitor doesn't learn anything unless there is a malicious close.
1369 // (only maybe, sadly we cant do the same for local info, as we need to be aware of
1371 for &(ref htlc, _) in &htlc_outputs {
1372 self.counterparty_hash_commitment_number.insert(htlc.payment_hash, commitment_number);
1375 log_trace!(logger, "Tracking new counterparty commitment transaction with txid {} at commitment number {} with {} HTLC outputs", txid, commitment_number, htlc_outputs.len());
1376 self.prev_counterparty_commitment_txid = self.current_counterparty_commitment_txid.take();
1377 self.current_counterparty_commitment_txid = Some(txid);
1378 self.counterparty_claimable_outpoints.insert(txid, htlc_outputs.clone());
1379 self.current_counterparty_commitment_number = commitment_number;
1380 //TODO: Merge this into the other per-counterparty-transaction output storage stuff
1381 match self.their_cur_revocation_points {
1382 Some(old_points) => {
1383 if old_points.0 == commitment_number + 1 {
1384 self.their_cur_revocation_points = Some((old_points.0, old_points.1, Some(their_revocation_point)));
1385 } else if old_points.0 == commitment_number + 2 {
1386 if let Some(old_second_point) = old_points.2 {
1387 self.their_cur_revocation_points = Some((old_points.0 - 1, old_second_point, Some(their_revocation_point)));
1389 self.their_cur_revocation_points = Some((commitment_number, their_revocation_point, None));
1392 self.their_cur_revocation_points = Some((commitment_number, their_revocation_point, None));
1396 self.their_cur_revocation_points = Some((commitment_number, their_revocation_point, None));
1399 let mut htlcs = Vec::with_capacity(htlc_outputs.len());
1400 for htlc in htlc_outputs {
1401 if htlc.0.transaction_output_index.is_some() {
1405 self.counterparty_tx_cache.per_htlc.insert(txid, htlcs);
1408 /// Informs this monitor of the latest holder (ie broadcastable) commitment transaction. The
1409 /// monitor watches for timeouts and may broadcast it if we approach such a timeout. Thus, it
1410 /// is important that any clones of this channel monitor (including remote clones) by kept
1411 /// up-to-date as our holder commitment transaction is updated.
1412 /// Panics if set_on_holder_tx_csv has never been called.
1413 fn provide_latest_holder_commitment_tx(&mut self, holder_commitment_tx: HolderCommitmentTransaction, htlc_outputs: Vec<(HTLCOutputInCommitment, Option<Signature>, Option<HTLCSource>)>) -> Result<(), MonitorUpdateError> {
1414 // block for Rust 1.34 compat
1415 let mut new_holder_commitment_tx = {
1416 let trusted_tx = holder_commitment_tx.trust();
1417 let txid = trusted_tx.txid();
1418 let tx_keys = trusted_tx.keys();
1419 self.current_holder_commitment_number = trusted_tx.commitment_number();
1422 revocation_key: tx_keys.revocation_key,
1423 a_htlc_key: tx_keys.broadcaster_htlc_key,
1424 b_htlc_key: tx_keys.countersignatory_htlc_key,
1425 delayed_payment_key: tx_keys.broadcaster_delayed_payment_key,
1426 per_commitment_point: tx_keys.per_commitment_point,
1427 feerate_per_kw: trusted_tx.feerate_per_kw(),
1431 self.onchain_tx_handler.provide_latest_holder_tx(holder_commitment_tx);
1432 mem::swap(&mut new_holder_commitment_tx, &mut self.current_holder_commitment_tx);
1433 self.prev_holder_signed_commitment_tx = Some(new_holder_commitment_tx);
1434 if self.holder_tx_signed {
1435 return Err(MonitorUpdateError("Latest holder commitment signed has already been signed, update is rejected"));
1440 /// Provides a payment_hash->payment_preimage mapping. Will be automatically pruned when all
1441 /// commitment_tx_infos which contain the payment hash have been revoked.
1442 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)
1443 where B::Target: BroadcasterInterface,
1444 F::Target: FeeEstimator,
1447 self.payment_preimages.insert(payment_hash.clone(), payment_preimage.clone());
1449 // If the channel is force closed, try to claim the output from this preimage.
1450 // First check if a counterparty commitment transaction has been broadcasted:
1451 macro_rules! claim_htlcs {
1452 ($commitment_number: expr, $txid: expr) => {
1453 let htlc_claim_reqs = self.get_counterparty_htlc_output_claim_reqs($commitment_number, $txid, None);
1454 self.onchain_tx_handler.update_claims_view(&Vec::new(), htlc_claim_reqs, self.best_block.height(), self.best_block.height(), broadcaster, fee_estimator, logger);
1457 if let Some(txid) = self.current_counterparty_commitment_txid {
1458 if let Some(commitment_number) = self.counterparty_commitment_txn_on_chain.get(&txid) {
1459 claim_htlcs!(*commitment_number, txid);
1463 if let Some(txid) = self.prev_counterparty_commitment_txid {
1464 if let Some(commitment_number) = self.counterparty_commitment_txn_on_chain.get(&txid) {
1465 claim_htlcs!(*commitment_number, txid);
1470 // Then if a holder commitment transaction has been seen on-chain, broadcast transactions
1471 // claiming the HTLC output from each of the holder commitment transactions.
1472 // Note that we can't just use `self.holder_tx_signed`, because that only covers the case where
1473 // *we* sign a holder commitment transaction, not when e.g. a watchtower broadcasts one of our
1474 // holder commitment transactions.
1475 if self.broadcasted_holder_revokable_script.is_some() {
1476 // Assume that the broadcasted commitment transaction confirmed in the current best
1477 // block. Even if not, its a reasonable metric for the bump criteria on the HTLC
1479 let (claim_reqs, _) = self.get_broadcasted_holder_claims(&self.current_holder_commitment_tx, self.best_block.height());
1480 self.onchain_tx_handler.update_claims_view(&Vec::new(), claim_reqs, self.best_block.height(), self.best_block.height(), broadcaster, fee_estimator, logger);
1481 if let Some(ref tx) = self.prev_holder_signed_commitment_tx {
1482 let (claim_reqs, _) = self.get_broadcasted_holder_claims(&tx, self.best_block.height());
1483 self.onchain_tx_handler.update_claims_view(&Vec::new(), claim_reqs, self.best_block.height(), self.best_block.height(), broadcaster, fee_estimator, logger);
1488 pub(crate) fn broadcast_latest_holder_commitment_txn<B: Deref, L: Deref>(&mut self, broadcaster: &B, logger: &L)
1489 where B::Target: BroadcasterInterface,
1492 for tx in self.get_latest_holder_commitment_txn(logger).iter() {
1493 log_info!(logger, "Broadcasting local {}", log_tx!(tx));
1494 broadcaster.broadcast_transaction(tx);
1496 self.pending_monitor_events.push(MonitorEvent::CommitmentTxBroadcasted(self.funding_info.0));
1499 pub fn update_monitor<B: Deref, F: Deref, L: Deref>(&mut self, updates: &ChannelMonitorUpdate, broadcaster: &B, fee_estimator: &F, logger: &L) -> Result<(), MonitorUpdateError>
1500 where B::Target: BroadcasterInterface,
1501 F::Target: FeeEstimator,
1504 // ChannelMonitor updates may be applied after force close if we receive a
1505 // preimage for a broadcasted commitment transaction HTLC output that we'd
1506 // like to claim on-chain. If this is the case, we no longer have guaranteed
1507 // access to the monitor's update ID, so we use a sentinel value instead.
1508 if updates.update_id == CLOSED_CHANNEL_UPDATE_ID {
1509 match updates.updates[0] {
1510 ChannelMonitorUpdateStep::PaymentPreimage { .. } => {},
1511 _ => panic!("Attempted to apply post-force-close ChannelMonitorUpdate that wasn't providing a payment preimage"),
1513 assert_eq!(updates.updates.len(), 1);
1514 } else if self.latest_update_id + 1 != updates.update_id {
1515 panic!("Attempted to apply ChannelMonitorUpdates out of order, check the update_id before passing an update to update_monitor!");
1517 for update in updates.updates.iter() {
1519 ChannelMonitorUpdateStep::LatestHolderCommitmentTXInfo { commitment_tx, htlc_outputs } => {
1520 log_trace!(logger, "Updating ChannelMonitor with latest holder commitment transaction info");
1521 if self.lockdown_from_offchain { panic!(); }
1522 self.provide_latest_holder_commitment_tx(commitment_tx.clone(), htlc_outputs.clone())?
1524 ChannelMonitorUpdateStep::LatestCounterpartyCommitmentTXInfo { commitment_txid, htlc_outputs, commitment_number, their_revocation_point } => {
1525 log_trace!(logger, "Updating ChannelMonitor with latest counterparty commitment transaction info");
1526 self.provide_latest_counterparty_commitment_tx(*commitment_txid, htlc_outputs.clone(), *commitment_number, *their_revocation_point, logger)
1528 ChannelMonitorUpdateStep::PaymentPreimage { payment_preimage } => {
1529 log_trace!(logger, "Updating ChannelMonitor with payment preimage");
1530 self.provide_payment_preimage(&PaymentHash(Sha256::hash(&payment_preimage.0[..]).into_inner()), &payment_preimage, broadcaster, fee_estimator, logger)
1532 ChannelMonitorUpdateStep::CommitmentSecret { idx, secret } => {
1533 log_trace!(logger, "Updating ChannelMonitor with commitment secret");
1534 self.provide_secret(*idx, *secret)?
1536 ChannelMonitorUpdateStep::ChannelForceClosed { should_broadcast } => {
1537 log_trace!(logger, "Updating ChannelMonitor: channel force closed, should broadcast: {}", should_broadcast);
1538 self.lockdown_from_offchain = true;
1539 if *should_broadcast {
1540 self.broadcast_latest_holder_commitment_txn(broadcaster, logger);
1541 } else if !self.holder_tx_signed {
1542 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");
1544 // If we generated a MonitorEvent::CommitmentTxBroadcasted, the ChannelManager
1545 // will still give us a ChannelForceClosed event with !should_broadcast, but we
1546 // shouldn't print the scary warning above.
1547 log_info!(logger, "Channel off-chain state closed after we broadcasted our latest commitment transaction.");
1550 ChannelMonitorUpdateStep::ShutdownScript { scriptpubkey } => {
1551 log_trace!(logger, "Updating ChannelMonitor with shutdown script");
1552 if let Some(shutdown_script) = self.shutdown_script.replace(scriptpubkey.clone()) {
1553 panic!("Attempted to replace shutdown script {} with {}", shutdown_script, scriptpubkey);
1558 self.latest_update_id = updates.update_id;
1562 pub fn get_latest_update_id(&self) -> u64 {
1563 self.latest_update_id
1566 pub fn get_funding_txo(&self) -> &(OutPoint, Script) {
1570 pub fn get_outputs_to_watch(&self) -> &HashMap<Txid, Vec<(u32, Script)>> {
1571 // If we've detected a counterparty commitment tx on chain, we must include it in the set
1572 // of outputs to watch for spends of, otherwise we're likely to lose user funds. Because
1573 // its trivial to do, double-check that here.
1574 for (txid, _) in self.counterparty_commitment_txn_on_chain.iter() {
1575 self.outputs_to_watch.get(txid).expect("Counterparty commitment txn which have been broadcast should have outputs registered");
1577 &self.outputs_to_watch
1580 pub fn get_and_clear_pending_monitor_events(&mut self) -> Vec<MonitorEvent> {
1581 let mut ret = Vec::new();
1582 mem::swap(&mut ret, &mut self.pending_monitor_events);
1586 pub fn get_and_clear_pending_events(&mut self) -> Vec<Event> {
1587 let mut ret = Vec::new();
1588 mem::swap(&mut ret, &mut self.pending_events);
1592 /// Can only fail if idx is < get_min_seen_secret
1593 fn get_secret(&self, idx: u64) -> Option<[u8; 32]> {
1594 self.commitment_secrets.get_secret(idx)
1597 pub(crate) fn get_min_seen_secret(&self) -> u64 {
1598 self.commitment_secrets.get_min_seen_secret()
1601 pub(crate) fn get_cur_counterparty_commitment_number(&self) -> u64 {
1602 self.current_counterparty_commitment_number
1605 pub(crate) fn get_cur_holder_commitment_number(&self) -> u64 {
1606 self.current_holder_commitment_number
1609 /// Attempts to claim a counterparty commitment transaction's outputs using the revocation key and
1610 /// data in counterparty_claimable_outpoints. Will directly claim any HTLC outputs which expire at a
1611 /// height > height + CLTV_SHARED_CLAIM_BUFFER. In any case, will install monitoring for
1612 /// HTLC-Success/HTLC-Timeout transactions.
1613 /// Return updates for HTLC pending in the channel and failed automatically by the broadcast of
1614 /// revoked counterparty commitment tx
1615 fn check_spend_counterparty_transaction<L: Deref>(&mut self, tx: &Transaction, height: u32, logger: &L) -> (Vec<PackageTemplate>, TransactionOutputs) where L::Target: Logger {
1616 // Most secp and related errors trying to create keys means we have no hope of constructing
1617 // a spend transaction...so we return no transactions to broadcast
1618 let mut claimable_outpoints = Vec::new();
1619 let mut watch_outputs = Vec::new();
1621 let commitment_txid = tx.txid(); //TODO: This is gonna be a performance bottleneck for watchtowers!
1622 let per_commitment_option = self.counterparty_claimable_outpoints.get(&commitment_txid);
1624 macro_rules! ignore_error {
1625 ( $thing : expr ) => {
1628 Err(_) => return (claimable_outpoints, (commitment_txid, watch_outputs))
1633 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);
1634 if commitment_number >= self.get_min_seen_secret() {
1635 let secret = self.get_secret(commitment_number).unwrap();
1636 let per_commitment_key = ignore_error!(SecretKey::from_slice(&secret));
1637 let per_commitment_point = PublicKey::from_secret_key(&self.secp_ctx, &per_commitment_key);
1638 let revocation_pubkey = ignore_error!(chan_utils::derive_public_revocation_key(&self.secp_ctx, &per_commitment_point, &self.holder_revocation_basepoint));
1639 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));
1641 let revokeable_redeemscript = chan_utils::get_revokeable_redeemscript(&revocation_pubkey, self.counterparty_tx_cache.on_counterparty_tx_csv, &delayed_key);
1642 let revokeable_p2wsh = revokeable_redeemscript.to_v0_p2wsh();
1644 // First, process non-htlc outputs (to_holder & to_counterparty)
1645 for (idx, outp) in tx.output.iter().enumerate() {
1646 if outp.script_pubkey == revokeable_p2wsh {
1647 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);
1648 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);
1649 claimable_outpoints.push(justice_package);
1653 // Then, try to find revoked htlc outputs
1654 if let Some(ref per_commitment_data) = per_commitment_option {
1655 for (_, &(ref htlc, _)) in per_commitment_data.iter().enumerate() {
1656 if let Some(transaction_output_index) = htlc.transaction_output_index {
1657 if transaction_output_index as usize >= tx.output.len() ||
1658 tx.output[transaction_output_index as usize].value != htlc.amount_msat / 1000 {
1659 return (claimable_outpoints, (commitment_txid, watch_outputs)); // Corrupted per_commitment_data, fuck this user
1661 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());
1662 let justice_package = PackageTemplate::build_package(commitment_txid, transaction_output_index, PackageSolvingData::RevokedHTLCOutput(revk_htlc_outp), htlc.cltv_expiry, true, height);
1663 claimable_outpoints.push(justice_package);
1668 // Last, track onchain revoked commitment transaction and fail backward outgoing HTLCs as payment path is broken
1669 if !claimable_outpoints.is_empty() || per_commitment_option.is_some() { // ie we're confident this is actually ours
1670 // We're definitely a counterparty commitment transaction!
1671 log_error!(logger, "Got broadcast of revoked counterparty commitment transaction, going to generate general spend tx with {} inputs", claimable_outpoints.len());
1672 for (idx, outp) in tx.output.iter().enumerate() {
1673 watch_outputs.push((idx as u32, outp.clone()));
1675 self.counterparty_commitment_txn_on_chain.insert(commitment_txid, commitment_number);
1677 fail_unbroadcast_htlcs!(self, "revoked counterparty", height, [].iter().map(|a| *a), logger);
1679 } else if let Some(per_commitment_data) = per_commitment_option {
1680 // While this isn't useful yet, there is a potential race where if a counterparty
1681 // revokes a state at the same time as the commitment transaction for that state is
1682 // confirmed, and the watchtower receives the block before the user, the user could
1683 // upload a new ChannelMonitor with the revocation secret but the watchtower has
1684 // already processed the block, resulting in the counterparty_commitment_txn_on_chain entry
1685 // not being generated by the above conditional. Thus, to be safe, we go ahead and
1687 for (idx, outp) in tx.output.iter().enumerate() {
1688 watch_outputs.push((idx as u32, outp.clone()));
1690 self.counterparty_commitment_txn_on_chain.insert(commitment_txid, commitment_number);
1692 log_info!(logger, "Got broadcast of non-revoked counterparty commitment transaction {}", commitment_txid);
1693 fail_unbroadcast_htlcs!(self, "counterparty", height, per_commitment_data.iter().map(|(a, b)| (a, b.as_ref().map(|b| b.as_ref()))), logger);
1695 let htlc_claim_reqs = self.get_counterparty_htlc_output_claim_reqs(commitment_number, commitment_txid, Some(tx));
1696 for req in htlc_claim_reqs {
1697 claimable_outpoints.push(req);
1701 (claimable_outpoints, (commitment_txid, watch_outputs))
1704 fn get_counterparty_htlc_output_claim_reqs(&self, commitment_number: u64, commitment_txid: Txid, tx: Option<&Transaction>) -> Vec<PackageTemplate> {
1705 let mut claimable_outpoints = Vec::new();
1706 if let Some(htlc_outputs) = self.counterparty_claimable_outpoints.get(&commitment_txid) {
1707 if let Some(revocation_points) = self.their_cur_revocation_points {
1708 let revocation_point_option =
1709 // If the counterparty commitment tx is the latest valid state, use their latest
1710 // per-commitment point
1711 if revocation_points.0 == commitment_number { Some(&revocation_points.1) }
1712 else if let Some(point) = revocation_points.2.as_ref() {
1713 // If counterparty commitment tx is the state previous to the latest valid state, use
1714 // their previous per-commitment point (non-atomicity of revocation means it's valid for
1715 // them to temporarily have two valid commitment txns from our viewpoint)
1716 if revocation_points.0 == commitment_number + 1 { Some(point) } else { None }
1718 if let Some(revocation_point) = revocation_point_option {
1719 for (_, &(ref htlc, _)) in htlc_outputs.iter().enumerate() {
1720 if let Some(transaction_output_index) = htlc.transaction_output_index {
1721 if let Some(transaction) = tx {
1722 if transaction_output_index as usize >= transaction.output.len() ||
1723 transaction.output[transaction_output_index as usize].value != htlc.amount_msat / 1000 {
1724 return claimable_outpoints; // Corrupted per_commitment_data, fuck this user
1727 let preimage = if htlc.offered { if let Some(p) = self.payment_preimages.get(&htlc.payment_hash) { Some(*p) } else { None } } else { None };
1728 if preimage.is_some() || !htlc.offered {
1729 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())) };
1730 let aggregation = if !htlc.offered { false } else { true };
1731 let counterparty_package = PackageTemplate::build_package(commitment_txid, transaction_output_index, counterparty_htlc_outp, htlc.cltv_expiry,aggregation, 0);
1732 claimable_outpoints.push(counterparty_package);
1742 /// Attempts to claim a counterparty HTLC-Success/HTLC-Timeout's outputs using the revocation key
1743 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 {
1744 let htlc_txid = tx.txid();
1745 if tx.input.len() != 1 || tx.output.len() != 1 || tx.input[0].witness.len() != 5 {
1746 return (Vec::new(), None)
1749 macro_rules! ignore_error {
1750 ( $thing : expr ) => {
1753 Err(_) => return (Vec::new(), None)
1758 let secret = if let Some(secret) = self.get_secret(commitment_number) { secret } else { return (Vec::new(), None); };
1759 let per_commitment_key = ignore_error!(SecretKey::from_slice(&secret));
1760 let per_commitment_point = PublicKey::from_secret_key(&self.secp_ctx, &per_commitment_key);
1762 log_error!(logger, "Got broadcast of revoked counterparty HTLC transaction, spending {}:{}", htlc_txid, 0);
1763 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);
1764 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);
1765 let claimable_outpoints = vec!(justice_package);
1766 let outputs = vec![(0, tx.output[0].clone())];
1767 (claimable_outpoints, Some((htlc_txid, outputs)))
1770 // Returns (1) `PackageTemplate`s that can be given to the OnChainTxHandler, so that the handler can
1771 // broadcast transactions claiming holder HTLC commitment outputs and (2) a holder revokable
1772 // script so we can detect whether a holder transaction has been seen on-chain.
1773 fn get_broadcasted_holder_claims(&self, holder_tx: &HolderSignedTx, conf_height: u32) -> (Vec<PackageTemplate>, Option<(Script, PublicKey, PublicKey)>) {
1774 let mut claim_requests = Vec::with_capacity(holder_tx.htlc_outputs.len());
1776 let redeemscript = chan_utils::get_revokeable_redeemscript(&holder_tx.revocation_key, self.on_holder_tx_csv, &holder_tx.delayed_payment_key);
1777 let broadcasted_holder_revokable_script = Some((redeemscript.to_v0_p2wsh(), holder_tx.per_commitment_point.clone(), holder_tx.revocation_key.clone()));
1779 for &(ref htlc, _, _) in holder_tx.htlc_outputs.iter() {
1780 if let Some(transaction_output_index) = htlc.transaction_output_index {
1781 let htlc_output = if htlc.offered {
1782 HolderHTLCOutput::build_offered(htlc.amount_msat, htlc.cltv_expiry)
1784 let payment_preimage = if let Some(preimage) = self.payment_preimages.get(&htlc.payment_hash) {
1787 // We can't build an HTLC-Success transaction without the preimage
1790 HolderHTLCOutput::build_accepted(payment_preimage, htlc.amount_msat)
1792 let htlc_package = PackageTemplate::build_package(holder_tx.txid, transaction_output_index, PackageSolvingData::HolderHTLCOutput(htlc_output), htlc.cltv_expiry, false, conf_height);
1793 claim_requests.push(htlc_package);
1797 (claim_requests, broadcasted_holder_revokable_script)
1800 // Returns holder HTLC outputs to watch and react to in case of spending.
1801 fn get_broadcasted_holder_watch_outputs(&self, holder_tx: &HolderSignedTx, commitment_tx: &Transaction) -> Vec<(u32, TxOut)> {
1802 let mut watch_outputs = Vec::with_capacity(holder_tx.htlc_outputs.len());
1803 for &(ref htlc, _, _) in holder_tx.htlc_outputs.iter() {
1804 if let Some(transaction_output_index) = htlc.transaction_output_index {
1805 watch_outputs.push((transaction_output_index, commitment_tx.output[transaction_output_index as usize].clone()));
1811 /// Attempts to claim any claimable HTLCs in a commitment transaction which was not (yet)
1812 /// revoked using data in holder_claimable_outpoints.
1813 /// Should not be used if check_spend_revoked_transaction succeeds.
1814 fn check_spend_holder_transaction<L: Deref>(&mut self, tx: &Transaction, height: u32, logger: &L) -> (Vec<PackageTemplate>, TransactionOutputs) where L::Target: Logger {
1815 let commitment_txid = tx.txid();
1816 let mut claim_requests = Vec::new();
1817 let mut watch_outputs = Vec::new();
1819 macro_rules! append_onchain_update {
1820 ($updates: expr, $to_watch: expr) => {
1821 claim_requests = $updates.0;
1822 self.broadcasted_holder_revokable_script = $updates.1;
1823 watch_outputs.append(&mut $to_watch);
1827 // HTLCs set may differ between last and previous holder commitment txn, in case of one them hitting chain, ensure we cancel all HTLCs backward
1828 let mut is_holder_tx = false;
1830 if self.current_holder_commitment_tx.txid == commitment_txid {
1831 is_holder_tx = true;
1832 log_info!(logger, "Got broadcast of latest holder commitment tx {}, searching for available HTLCs to claim", commitment_txid);
1833 let res = self.get_broadcasted_holder_claims(&self.current_holder_commitment_tx, height);
1834 let mut to_watch = self.get_broadcasted_holder_watch_outputs(&self.current_holder_commitment_tx, tx);
1835 append_onchain_update!(res, to_watch);
1836 fail_unbroadcast_htlcs!(self, "latest holder", height, self.current_holder_commitment_tx.htlc_outputs.iter().map(|(a, _, c)| (a, c.as_ref())), logger);
1837 } else if let &Some(ref holder_tx) = &self.prev_holder_signed_commitment_tx {
1838 if holder_tx.txid == commitment_txid {
1839 is_holder_tx = true;
1840 log_info!(logger, "Got broadcast of previous holder commitment tx {}, searching for available HTLCs to claim", commitment_txid);
1841 let res = self.get_broadcasted_holder_claims(holder_tx, height);
1842 let mut to_watch = self.get_broadcasted_holder_watch_outputs(holder_tx, tx);
1843 append_onchain_update!(res, to_watch);
1844 fail_unbroadcast_htlcs!(self, "previous holder", height, holder_tx.htlc_outputs.iter().map(|(a, _, c)| (a, c.as_ref())), logger);
1851 (claim_requests, (commitment_txid, watch_outputs))
1854 pub fn get_latest_holder_commitment_txn<L: Deref>(&mut self, logger: &L) -> Vec<Transaction> where L::Target: Logger {
1855 log_debug!(logger, "Getting signed latest holder commitment transaction!");
1856 self.holder_tx_signed = true;
1857 let commitment_tx = self.onchain_tx_handler.get_fully_signed_holder_tx(&self.funding_redeemscript);
1858 let txid = commitment_tx.txid();
1859 let mut holder_transactions = vec![commitment_tx];
1860 for htlc in self.current_holder_commitment_tx.htlc_outputs.iter() {
1861 if let Some(vout) = htlc.0.transaction_output_index {
1862 let preimage = if !htlc.0.offered {
1863 if let Some(preimage) = self.payment_preimages.get(&htlc.0.payment_hash) { Some(preimage.clone()) } else {
1864 // We can't build an HTLC-Success transaction without the preimage
1867 } else if htlc.0.cltv_expiry > self.best_block.height() + 1 {
1868 // Don't broadcast HTLC-Timeout transactions immediately as they don't meet the
1869 // current locktime requirements on-chain. We will broadcast them in
1870 // `block_confirmed` when `should_broadcast_holder_commitment_txn` returns true.
1871 // Note that we add + 1 as transactions are broadcastable when they can be
1872 // confirmed in the next block.
1875 if let Some(htlc_tx) = self.onchain_tx_handler.get_fully_signed_htlc_tx(
1876 &::bitcoin::OutPoint { txid, vout }, &preimage) {
1877 holder_transactions.push(htlc_tx);
1881 // 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.
1882 // The data will be re-generated and tracked in check_spend_holder_transaction if we get a confirmation.
1886 #[cfg(any(test,feature = "unsafe_revoked_tx_signing"))]
1887 /// Note that this includes possibly-locktimed-in-the-future transactions!
1888 fn unsafe_get_latest_holder_commitment_txn<L: Deref>(&mut self, logger: &L) -> Vec<Transaction> where L::Target: Logger {
1889 log_debug!(logger, "Getting signed copy of latest holder commitment transaction!");
1890 let commitment_tx = self.onchain_tx_handler.get_fully_signed_copy_holder_tx(&self.funding_redeemscript);
1891 let txid = commitment_tx.txid();
1892 let mut holder_transactions = vec![commitment_tx];
1893 for htlc in self.current_holder_commitment_tx.htlc_outputs.iter() {
1894 if let Some(vout) = htlc.0.transaction_output_index {
1895 let preimage = if !htlc.0.offered {
1896 if let Some(preimage) = self.payment_preimages.get(&htlc.0.payment_hash) { Some(preimage.clone()) } else {
1897 // We can't build an HTLC-Success transaction without the preimage
1901 if let Some(htlc_tx) = self.onchain_tx_handler.unsafe_get_fully_signed_htlc_tx(
1902 &::bitcoin::OutPoint { txid, vout }, &preimage) {
1903 holder_transactions.push(htlc_tx);
1910 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>
1911 where 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);
1917 self.best_block = BestBlock::new(block_hash, height);
1919 self.transactions_confirmed(header, txdata, height, broadcaster, fee_estimator, logger)
1922 fn best_block_updated<B: Deref, F: Deref, L: Deref>(
1924 header: &BlockHeader,
1929 ) -> Vec<TransactionOutputs>
1931 B::Target: BroadcasterInterface,
1932 F::Target: FeeEstimator,
1935 let block_hash = header.block_hash();
1936 log_trace!(logger, "New best block {} at height {}", block_hash, height);
1938 if height > self.best_block.height() {
1939 self.best_block = BestBlock::new(block_hash, height);
1940 self.block_confirmed(height, vec![], vec![], vec![], &broadcaster, &fee_estimator, &logger)
1941 } else if block_hash != self.best_block.block_hash() {
1942 self.best_block = BestBlock::new(block_hash, height);
1943 self.onchain_events_awaiting_threshold_conf.retain(|ref entry| entry.height <= height);
1944 self.onchain_tx_handler.block_disconnected(height + 1, broadcaster, fee_estimator, logger);
1946 } else { Vec::new() }
1949 fn transactions_confirmed<B: Deref, F: Deref, L: Deref>(
1951 header: &BlockHeader,
1952 txdata: &TransactionData,
1957 ) -> Vec<TransactionOutputs>
1959 B::Target: BroadcasterInterface,
1960 F::Target: FeeEstimator,
1963 let txn_matched = self.filter_block(txdata);
1964 for tx in &txn_matched {
1965 let mut output_val = 0;
1966 for out in tx.output.iter() {
1967 if out.value > 21_000_000_0000_0000 { panic!("Value-overflowing transaction provided to block connected"); }
1968 output_val += out.value;
1969 if output_val > 21_000_000_0000_0000 { panic!("Value-overflowing transaction provided to block connected"); }
1973 let block_hash = header.block_hash();
1974 log_trace!(logger, "Block {} at height {} connected with {} txn matched", block_hash, height, txn_matched.len());
1976 let mut watch_outputs = Vec::new();
1977 let mut claimable_outpoints = Vec::new();
1978 for tx in &txn_matched {
1979 if tx.input.len() == 1 {
1980 // Assuming our keys were not leaked (in which case we're screwed no matter what),
1981 // commitment transactions and HTLC transactions will all only ever have one input,
1982 // which is an easy way to filter out any potential non-matching txn for lazy
1984 let prevout = &tx.input[0].previous_output;
1985 if prevout.txid == self.funding_info.0.txid && prevout.vout == self.funding_info.0.index as u32 {
1986 if (tx.input[0].sequence >> 8*3) as u8 == 0x80 && (tx.lock_time >> 8*3) as u8 == 0x20 {
1987 let (mut new_outpoints, new_outputs) = self.check_spend_counterparty_transaction(&tx, height, &logger);
1988 if !new_outputs.1.is_empty() {
1989 watch_outputs.push(new_outputs);
1991 if new_outpoints.is_empty() {
1992 let (mut new_outpoints, new_outputs) = self.check_spend_holder_transaction(&tx, height, &logger);
1993 if !new_outputs.1.is_empty() {
1994 watch_outputs.push(new_outputs);
1996 claimable_outpoints.append(&mut new_outpoints);
1998 claimable_outpoints.append(&mut new_outpoints);
2001 if let Some(&commitment_number) = self.counterparty_commitment_txn_on_chain.get(&prevout.txid) {
2002 let (mut new_outpoints, new_outputs_option) = self.check_spend_counterparty_htlc(&tx, commitment_number, height, &logger);
2003 claimable_outpoints.append(&mut new_outpoints);
2004 if let Some(new_outputs) = new_outputs_option {
2005 watch_outputs.push(new_outputs);
2010 // While all commitment/HTLC-Success/HTLC-Timeout transactions have one input, HTLCs
2011 // can also be resolved in a few other ways which can have more than one output. Thus,
2012 // we call is_resolving_htlc_output here outside of the tx.input.len() == 1 check.
2013 self.is_resolving_htlc_output(&tx, height, &logger);
2015 self.is_paying_spendable_output(&tx, height, &logger);
2018 if height > self.best_block.height() {
2019 self.best_block = BestBlock::new(block_hash, height);
2022 self.block_confirmed(height, txn_matched, watch_outputs, claimable_outpoints, &broadcaster, &fee_estimator, &logger)
2025 /// Update state for new block(s)/transaction(s) confirmed. Note that the caller must update
2026 /// `self.best_block` before calling if a new best blockchain tip is available. More
2027 /// concretely, `self.best_block` must never be at a lower height than `conf_height`, avoiding
2028 /// complexity especially in `OnchainTx::update_claims_view`.
2030 /// `conf_height` should be set to the height at which any new transaction(s)/block(s) were
2031 /// confirmed at, even if it is not the current best height.
2032 fn block_confirmed<B: Deref, F: Deref, L: Deref>(
2035 txn_matched: Vec<&Transaction>,
2036 mut watch_outputs: Vec<TransactionOutputs>,
2037 mut claimable_outpoints: Vec<PackageTemplate>,
2041 ) -> Vec<TransactionOutputs>
2043 B::Target: BroadcasterInterface,
2044 F::Target: FeeEstimator,
2047 debug_assert!(self.best_block.height() >= conf_height);
2049 let should_broadcast = self.should_broadcast_holder_commitment_txn(logger);
2050 if should_broadcast {
2051 let funding_outp = HolderFundingOutput::build(self.funding_redeemscript.clone());
2052 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());
2053 claimable_outpoints.push(commitment_package);
2054 self.pending_monitor_events.push(MonitorEvent::CommitmentTxBroadcasted(self.funding_info.0));
2055 let commitment_tx = self.onchain_tx_handler.get_fully_signed_holder_tx(&self.funding_redeemscript);
2056 self.holder_tx_signed = true;
2057 // Because we're broadcasting a commitment transaction, we should construct the package
2058 // assuming it gets confirmed in the next block. Sadly, we have code which considers
2059 // "not yet confirmed" things as discardable, so we cannot do that here.
2060 let (mut new_outpoints, _) = self.get_broadcasted_holder_claims(&self.current_holder_commitment_tx, self.best_block.height());
2061 let new_outputs = self.get_broadcasted_holder_watch_outputs(&self.current_holder_commitment_tx, &commitment_tx);
2062 if !new_outputs.is_empty() {
2063 watch_outputs.push((self.current_holder_commitment_tx.txid.clone(), new_outputs));
2065 claimable_outpoints.append(&mut new_outpoints);
2068 // Find which on-chain events have reached their confirmation threshold.
2069 let onchain_events_awaiting_threshold_conf =
2070 self.onchain_events_awaiting_threshold_conf.drain(..).collect::<Vec<_>>();
2071 let mut onchain_events_reaching_threshold_conf = Vec::new();
2072 for entry in onchain_events_awaiting_threshold_conf {
2073 if entry.has_reached_confirmation_threshold(&self.best_block) {
2074 onchain_events_reaching_threshold_conf.push(entry);
2076 self.onchain_events_awaiting_threshold_conf.push(entry);
2080 // Used to check for duplicate HTLC resolutions.
2081 #[cfg(debug_assertions)]
2082 let unmatured_htlcs: Vec<_> = self.onchain_events_awaiting_threshold_conf
2084 .filter_map(|entry| match &entry.event {
2085 OnchainEvent::HTLCUpdate { source, .. } => Some(source),
2086 OnchainEvent::MaturingOutput { .. } => None,
2089 #[cfg(debug_assertions)]
2090 let mut matured_htlcs = Vec::new();
2092 // Produce actionable events from on-chain events having reached their threshold.
2093 for entry in onchain_events_reaching_threshold_conf.drain(..) {
2095 OnchainEvent::HTLCUpdate { ref source, payment_hash, onchain_value_satoshis } => {
2096 // Check for duplicate HTLC resolutions.
2097 #[cfg(debug_assertions)]
2100 unmatured_htlcs.iter().find(|&htlc| htlc == &source).is_none(),
2101 "An unmature HTLC transaction conflicts with a maturing one; failed to \
2102 call either transaction_unconfirmed for the conflicting transaction \
2103 or block_disconnected for a block containing it.");
2105 matured_htlcs.iter().find(|&htlc| htlc == source).is_none(),
2106 "A matured HTLC transaction conflicts with a maturing one; failed to \
2107 call either transaction_unconfirmed for the conflicting transaction \
2108 or block_disconnected for a block containing it.");
2109 matured_htlcs.push(source.clone());
2112 log_debug!(logger, "HTLC {} failure update has got enough confirmations to be passed upstream", log_bytes!(payment_hash.0));
2113 self.pending_monitor_events.push(MonitorEvent::HTLCEvent(HTLCUpdate {
2115 payment_preimage: None,
2116 source: source.clone(),
2117 onchain_value_satoshis,
2120 OnchainEvent::MaturingOutput { descriptor } => {
2121 log_debug!(logger, "Descriptor {} has got enough confirmations to be passed upstream", log_spendable!(descriptor));
2122 self.pending_events.push(Event::SpendableOutputs {
2123 outputs: vec![descriptor]
2129 self.onchain_tx_handler.update_claims_view(&txn_matched, claimable_outpoints, conf_height, self.best_block.height(), broadcaster, fee_estimator, logger);
2131 // Determine new outputs to watch by comparing against previously known outputs to watch,
2132 // updating the latter in the process.
2133 watch_outputs.retain(|&(ref txid, ref txouts)| {
2134 let idx_and_scripts = txouts.iter().map(|o| (o.0, o.1.script_pubkey.clone())).collect();
2135 self.outputs_to_watch.insert(txid.clone(), idx_and_scripts).is_none()
2139 // If we see a transaction for which we registered outputs previously,
2140 // make sure the registered scriptpubkey at the expected index match
2141 // the actual transaction output one. We failed this case before #653.
2142 for tx in &txn_matched {
2143 if let Some(outputs) = self.get_outputs_to_watch().get(&tx.txid()) {
2144 for idx_and_script in outputs.iter() {
2145 assert!((idx_and_script.0 as usize) < tx.output.len());
2146 assert_eq!(tx.output[idx_and_script.0 as usize].script_pubkey, idx_and_script.1);
2154 pub fn block_disconnected<B: Deref, F: Deref, L: Deref>(&mut self, header: &BlockHeader, height: u32, broadcaster: B, fee_estimator: F, logger: L)
2155 where B::Target: BroadcasterInterface,
2156 F::Target: FeeEstimator,
2159 log_trace!(logger, "Block {} at height {} disconnected", header.block_hash(), height);
2162 //- htlc update there as failure-trigger tx (revoked commitment tx, non-revoked commitment tx, HTLC-timeout tx) has been disconnected
2163 //- maturing spendable output has transaction paying us has been disconnected
2164 self.onchain_events_awaiting_threshold_conf.retain(|ref entry| entry.height < height);
2166 self.onchain_tx_handler.block_disconnected(height, broadcaster, fee_estimator, logger);
2168 self.best_block = BestBlock::new(header.prev_blockhash, height - 1);
2171 fn transaction_unconfirmed<B: Deref, F: Deref, L: Deref>(
2178 B::Target: BroadcasterInterface,
2179 F::Target: FeeEstimator,
2182 self.onchain_events_awaiting_threshold_conf.retain(|ref entry| entry.txid != *txid);
2183 self.onchain_tx_handler.transaction_unconfirmed(txid, broadcaster, fee_estimator, logger);
2186 /// Filters a block's `txdata` for transactions spending watched outputs or for any child
2187 /// transactions thereof.
2188 fn filter_block<'a>(&self, txdata: &TransactionData<'a>) -> Vec<&'a Transaction> {
2189 let mut matched_txn = HashSet::new();
2190 txdata.iter().filter(|&&(_, tx)| {
2191 let mut matches = self.spends_watched_output(tx);
2192 for input in tx.input.iter() {
2193 if matches { break; }
2194 if matched_txn.contains(&input.previous_output.txid) {
2199 matched_txn.insert(tx.txid());
2202 }).map(|(_, tx)| *tx).collect()
2205 /// Checks if a given transaction spends any watched outputs.
2206 fn spends_watched_output(&self, tx: &Transaction) -> bool {
2207 for input in tx.input.iter() {
2208 if let Some(outputs) = self.get_outputs_to_watch().get(&input.previous_output.txid) {
2209 for (idx, _script_pubkey) in outputs.iter() {
2210 if *idx == input.previous_output.vout {
2213 // If the expected script is a known type, check that the witness
2214 // appears to be spending the correct type (ie that the match would
2215 // actually succeed in BIP 158/159-style filters).
2216 if _script_pubkey.is_v0_p2wsh() {
2217 assert_eq!(&bitcoin::Address::p2wsh(&Script::from(input.witness.last().unwrap().clone()), bitcoin::Network::Bitcoin).script_pubkey(), _script_pubkey);
2218 } else if _script_pubkey.is_v0_p2wpkh() {
2219 assert_eq!(&bitcoin::Address::p2wpkh(&bitcoin::PublicKey::from_slice(&input.witness.last().unwrap()).unwrap(), bitcoin::Network::Bitcoin).unwrap().script_pubkey(), _script_pubkey);
2220 } else { panic!(); }
2231 fn should_broadcast_holder_commitment_txn<L: Deref>(&self, logger: &L) -> bool where L::Target: Logger {
2232 // We need to consider all HTLCs which are:
2233 // * in any unrevoked counterparty commitment transaction, as they could broadcast said
2234 // transactions and we'd end up in a race, or
2235 // * are in our latest holder commitment transaction, as this is the thing we will
2236 // broadcast if we go on-chain.
2237 // Note that we consider HTLCs which were below dust threshold here - while they don't
2238 // strictly imply that we need to fail the channel, we need to go ahead and fail them back
2239 // to the source, and if we don't fail the channel we will have to ensure that the next
2240 // updates that peer sends us are update_fails, failing the channel if not. It's probably
2241 // easier to just fail the channel as this case should be rare enough anyway.
2242 let height = self.best_block.height();
2243 macro_rules! scan_commitment {
2244 ($htlcs: expr, $holder_tx: expr) => {
2245 for ref htlc in $htlcs {
2246 // For inbound HTLCs which we know the preimage for, we have to ensure we hit the
2247 // chain with enough room to claim the HTLC without our counterparty being able to
2248 // time out the HTLC first.
2249 // For outbound HTLCs which our counterparty hasn't failed/claimed, our primary
2250 // concern is being able to claim the corresponding inbound HTLC (on another
2251 // channel) before it expires. In fact, we don't even really care if our
2252 // counterparty here claims such an outbound HTLC after it expired as long as we
2253 // can still claim the corresponding HTLC. Thus, to avoid needlessly hitting the
2254 // chain when our counterparty is waiting for expiration to off-chain fail an HTLC
2255 // we give ourselves a few blocks of headroom after expiration before going
2256 // on-chain for an expired HTLC.
2257 // Note that, to avoid a potential attack whereby a node delays claiming an HTLC
2258 // from us until we've reached the point where we go on-chain with the
2259 // corresponding inbound HTLC, we must ensure that outbound HTLCs go on chain at
2260 // least CLTV_CLAIM_BUFFER blocks prior to the inbound HTLC.
2261 // aka outbound_cltv + LATENCY_GRACE_PERIOD_BLOCKS == height - CLTV_CLAIM_BUFFER
2262 // inbound_cltv == height + CLTV_CLAIM_BUFFER
2263 // outbound_cltv + LATENCY_GRACE_PERIOD_BLOCKS + CLTV_CLAIM_BUFFER <= inbound_cltv - CLTV_CLAIM_BUFFER
2264 // LATENCY_GRACE_PERIOD_BLOCKS + 2*CLTV_CLAIM_BUFFER <= inbound_cltv - outbound_cltv
2265 // CLTV_EXPIRY_DELTA <= inbound_cltv - outbound_cltv (by check in ChannelManager::decode_update_add_htlc_onion)
2266 // LATENCY_GRACE_PERIOD_BLOCKS + 2*CLTV_CLAIM_BUFFER <= CLTV_EXPIRY_DELTA
2267 // The final, above, condition is checked for statically in channelmanager
2268 // with CHECK_CLTV_EXPIRY_SANITY_2.
2269 let htlc_outbound = $holder_tx == htlc.offered;
2270 if ( htlc_outbound && htlc.cltv_expiry + LATENCY_GRACE_PERIOD_BLOCKS <= height) ||
2271 (!htlc_outbound && htlc.cltv_expiry <= height + CLTV_CLAIM_BUFFER && self.payment_preimages.contains_key(&htlc.payment_hash)) {
2272 log_info!(logger, "Force-closing channel due to {} HTLC timeout, HTLC expiry is {}", if htlc_outbound { "outbound" } else { "inbound "}, htlc.cltv_expiry);
2279 scan_commitment!(self.current_holder_commitment_tx.htlc_outputs.iter().map(|&(ref a, _, _)| a), true);
2281 if let Some(ref txid) = self.current_counterparty_commitment_txid {
2282 if let Some(ref htlc_outputs) = self.counterparty_claimable_outpoints.get(txid) {
2283 scan_commitment!(htlc_outputs.iter().map(|&(ref a, _)| a), false);
2286 if let Some(ref txid) = self.prev_counterparty_commitment_txid {
2287 if let Some(ref htlc_outputs) = self.counterparty_claimable_outpoints.get(txid) {
2288 scan_commitment!(htlc_outputs.iter().map(|&(ref a, _)| a), false);
2295 /// Check if any transaction broadcasted is resolving HTLC output by a success or timeout on a holder
2296 /// or counterparty commitment tx, if so send back the source, preimage if found and payment_hash of resolved HTLC
2297 fn is_resolving_htlc_output<L: Deref>(&mut self, tx: &Transaction, height: u32, logger: &L) where L::Target: Logger {
2298 'outer_loop: for input in &tx.input {
2299 let mut payment_data = None;
2300 let revocation_sig_claim = (input.witness.len() == 3 && HTLCType::scriptlen_to_htlctype(input.witness[2].len()) == Some(HTLCType::OfferedHTLC) && input.witness[1].len() == 33)
2301 || (input.witness.len() == 3 && HTLCType::scriptlen_to_htlctype(input.witness[2].len()) == Some(HTLCType::AcceptedHTLC) && input.witness[1].len() == 33);
2302 let accepted_preimage_claim = input.witness.len() == 5 && HTLCType::scriptlen_to_htlctype(input.witness[4].len()) == Some(HTLCType::AcceptedHTLC);
2303 let offered_preimage_claim = input.witness.len() == 3 && HTLCType::scriptlen_to_htlctype(input.witness[2].len()) == Some(HTLCType::OfferedHTLC);
2305 macro_rules! log_claim {
2306 ($tx_info: expr, $holder_tx: expr, $htlc: expr, $source_avail: expr) => {
2307 // We found the output in question, but aren't failing it backwards
2308 // as we have no corresponding source and no valid counterparty commitment txid
2309 // to try a weak source binding with same-hash, same-value still-valid offered HTLC.
2310 // This implies either it is an inbound HTLC or an outbound HTLC on a revoked transaction.
2311 let outbound_htlc = $holder_tx == $htlc.offered;
2312 if ($holder_tx && revocation_sig_claim) ||
2313 (outbound_htlc && !$source_avail && (accepted_preimage_claim || offered_preimage_claim)) {
2314 log_error!(logger, "Input spending {} ({}:{}) in {} resolves {} HTLC with payment hash {} with {}!",
2315 $tx_info, input.previous_output.txid, input.previous_output.vout, tx.txid(),
2316 if outbound_htlc { "outbound" } else { "inbound" }, log_bytes!($htlc.payment_hash.0),
2317 if revocation_sig_claim { "revocation sig" } else { "preimage claim after we'd passed the HTLC resolution back" });
2319 log_info!(logger, "Input spending {} ({}:{}) in {} resolves {} HTLC with payment hash {} with {}",
2320 $tx_info, input.previous_output.txid, input.previous_output.vout, tx.txid(),
2321 if outbound_htlc { "outbound" } else { "inbound" }, log_bytes!($htlc.payment_hash.0),
2322 if revocation_sig_claim { "revocation sig" } else if accepted_preimage_claim || offered_preimage_claim { "preimage" } else { "timeout" });
2327 macro_rules! check_htlc_valid_counterparty {
2328 ($counterparty_txid: expr, $htlc_output: expr) => {
2329 if let Some(txid) = $counterparty_txid {
2330 for &(ref pending_htlc, ref pending_source) in self.counterparty_claimable_outpoints.get(&txid).unwrap() {
2331 if pending_htlc.payment_hash == $htlc_output.payment_hash && pending_htlc.amount_msat == $htlc_output.amount_msat {
2332 if let &Some(ref source) = pending_source {
2333 log_claim!("revoked counterparty commitment tx", false, pending_htlc, true);
2334 payment_data = Some(((**source).clone(), $htlc_output.payment_hash, $htlc_output.amount_msat));
2343 macro_rules! scan_commitment {
2344 ($htlcs: expr, $tx_info: expr, $holder_tx: expr) => {
2345 for (ref htlc_output, source_option) in $htlcs {
2346 if Some(input.previous_output.vout) == htlc_output.transaction_output_index {
2347 if let Some(ref source) = source_option {
2348 log_claim!($tx_info, $holder_tx, htlc_output, true);
2349 // We have a resolution of an HTLC either from one of our latest
2350 // holder commitment transactions or an unrevoked counterparty commitment
2351 // transaction. This implies we either learned a preimage, the HTLC
2352 // has timed out, or we screwed up. In any case, we should now
2353 // resolve the source HTLC with the original sender.
2354 payment_data = Some(((*source).clone(), htlc_output.payment_hash, htlc_output.amount_msat));
2355 } else if !$holder_tx {
2356 check_htlc_valid_counterparty!(self.current_counterparty_commitment_txid, htlc_output);
2357 if payment_data.is_none() {
2358 check_htlc_valid_counterparty!(self.prev_counterparty_commitment_txid, htlc_output);
2361 if payment_data.is_none() {
2362 log_claim!($tx_info, $holder_tx, htlc_output, false);
2363 continue 'outer_loop;
2370 if input.previous_output.txid == self.current_holder_commitment_tx.txid {
2371 scan_commitment!(self.current_holder_commitment_tx.htlc_outputs.iter().map(|&(ref a, _, ref b)| (a, b.as_ref())),
2372 "our latest holder commitment tx", true);
2374 if let Some(ref prev_holder_signed_commitment_tx) = self.prev_holder_signed_commitment_tx {
2375 if input.previous_output.txid == prev_holder_signed_commitment_tx.txid {
2376 scan_commitment!(prev_holder_signed_commitment_tx.htlc_outputs.iter().map(|&(ref a, _, ref b)| (a, b.as_ref())),
2377 "our previous holder commitment tx", true);
2380 if let Some(ref htlc_outputs) = self.counterparty_claimable_outpoints.get(&input.previous_output.txid) {
2381 scan_commitment!(htlc_outputs.iter().map(|&(ref a, ref b)| (a, (b.as_ref().clone()).map(|boxed| &**boxed))),
2382 "counterparty commitment tx", false);
2385 // Check that scan_commitment, above, decided there is some source worth relaying an
2386 // HTLC resolution backwards to and figure out whether we learned a preimage from it.
2387 if let Some((source, payment_hash, amount_msat)) = payment_data {
2388 let mut payment_preimage = PaymentPreimage([0; 32]);
2389 if accepted_preimage_claim {
2390 if !self.pending_monitor_events.iter().any(
2391 |update| if let &MonitorEvent::HTLCEvent(ref upd) = update { upd.source == source } else { false }) {
2392 payment_preimage.0.copy_from_slice(&input.witness[3]);
2393 self.pending_monitor_events.push(MonitorEvent::HTLCEvent(HTLCUpdate {
2395 payment_preimage: Some(payment_preimage),
2397 onchain_value_satoshis: Some(amount_msat / 1000),
2400 } else if offered_preimage_claim {
2401 if !self.pending_monitor_events.iter().any(
2402 |update| if let &MonitorEvent::HTLCEvent(ref upd) = update {
2403 upd.source == source
2405 payment_preimage.0.copy_from_slice(&input.witness[1]);
2406 self.pending_monitor_events.push(MonitorEvent::HTLCEvent(HTLCUpdate {
2408 payment_preimage: Some(payment_preimage),
2410 onchain_value_satoshis: Some(amount_msat / 1000),
2414 self.onchain_events_awaiting_threshold_conf.retain(|ref entry| {
2415 if entry.height != height { return true; }
2417 OnchainEvent::HTLCUpdate { source: ref htlc_source, .. } => {
2418 *htlc_source != source
2423 let entry = OnchainEventEntry {
2426 event: OnchainEvent::HTLCUpdate {
2427 source, payment_hash,
2428 onchain_value_satoshis: Some(amount_msat / 1000),
2431 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());
2432 self.onchain_events_awaiting_threshold_conf.push(entry);
2438 /// Check if any transaction broadcasted is paying fund back to some address we can assume to own
2439 fn is_paying_spendable_output<L: Deref>(&mut self, tx: &Transaction, height: u32, logger: &L) where L::Target: Logger {
2440 let mut spendable_output = None;
2441 for (i, outp) in tx.output.iter().enumerate() { // There is max one spendable output for any channel tx, including ones generated by us
2442 if i > ::core::u16::MAX as usize {
2443 // While it is possible that an output exists on chain which is greater than the
2444 // 2^16th output in a given transaction, this is only possible if the output is not
2445 // in a lightning transaction and was instead placed there by some third party who
2446 // wishes to give us money for no reason.
2447 // Namely, any lightning transactions which we pre-sign will never have anywhere
2448 // near 2^16 outputs both because such transactions must have ~2^16 outputs who's
2449 // scripts are not longer than one byte in length and because they are inherently
2450 // non-standard due to their size.
2451 // Thus, it is completely safe to ignore such outputs, and while it may result in
2452 // us ignoring non-lightning fund to us, that is only possible if someone fills
2453 // nearly a full block with garbage just to hit this case.
2456 if outp.script_pubkey == self.destination_script {
2457 spendable_output = Some(SpendableOutputDescriptor::StaticOutput {
2458 outpoint: OutPoint { txid: tx.txid(), index: i as u16 },
2459 output: outp.clone(),
2463 if let Some(ref broadcasted_holder_revokable_script) = self.broadcasted_holder_revokable_script {
2464 if broadcasted_holder_revokable_script.0 == outp.script_pubkey {
2465 spendable_output = Some(SpendableOutputDescriptor::DelayedPaymentOutput(DelayedPaymentOutputDescriptor {
2466 outpoint: OutPoint { txid: tx.txid(), index: i as u16 },
2467 per_commitment_point: broadcasted_holder_revokable_script.1,
2468 to_self_delay: self.on_holder_tx_csv,
2469 output: outp.clone(),
2470 revocation_pubkey: broadcasted_holder_revokable_script.2.clone(),
2471 channel_keys_id: self.channel_keys_id,
2472 channel_value_satoshis: self.channel_value_satoshis,
2477 if self.counterparty_payment_script == outp.script_pubkey {
2478 spendable_output = Some(SpendableOutputDescriptor::StaticPaymentOutput(StaticPaymentOutputDescriptor {
2479 outpoint: OutPoint { txid: tx.txid(), index: i as u16 },
2480 output: outp.clone(),
2481 channel_keys_id: self.channel_keys_id,
2482 channel_value_satoshis: self.channel_value_satoshis,
2486 if self.shutdown_script.as_ref() == Some(&outp.script_pubkey) {
2487 spendable_output = Some(SpendableOutputDescriptor::StaticOutput {
2488 outpoint: OutPoint { txid: tx.txid(), index: i as u16 },
2489 output: outp.clone(),
2494 if let Some(spendable_output) = spendable_output {
2495 let entry = OnchainEventEntry {
2498 event: OnchainEvent::MaturingOutput { descriptor: spendable_output.clone() },
2500 log_info!(logger, "Received spendable output {}, spendable at height {}", log_spendable!(spendable_output), entry.confirmation_threshold());
2501 self.onchain_events_awaiting_threshold_conf.push(entry);
2506 /// `Persist` defines behavior for persisting channel monitors: this could mean
2507 /// writing once to disk, and/or uploading to one or more backup services.
2509 /// Note that for every new monitor, you **must** persist the new `ChannelMonitor`
2510 /// to disk/backups. And, on every update, you **must** persist either the
2511 /// `ChannelMonitorUpdate` or the updated monitor itself. Otherwise, there is risk
2512 /// of situations such as revoking a transaction, then crashing before this
2513 /// revocation can be persisted, then unintentionally broadcasting a revoked
2514 /// transaction and losing money. This is a risk because previous channel states
2515 /// are toxic, so it's important that whatever channel state is persisted is
2516 /// kept up-to-date.
2517 pub trait Persist<ChannelSigner: Sign> {
2518 /// Persist a new channel's data. The data can be stored any way you want, but
2519 /// the identifier provided by Rust-Lightning is the channel's outpoint (and
2520 /// it is up to you to maintain a correct mapping between the outpoint and the
2521 /// stored channel data). Note that you **must** persist every new monitor to
2522 /// disk. See the `Persist` trait documentation for more details.
2524 /// See [`ChannelMonitor::write`] for writing out a `ChannelMonitor`,
2525 /// and [`ChannelMonitorUpdateErr`] for requirements when returning errors.
2526 fn persist_new_channel(&self, id: OutPoint, data: &ChannelMonitor<ChannelSigner>) -> Result<(), ChannelMonitorUpdateErr>;
2528 /// Update one channel's data. The provided `ChannelMonitor` has already
2529 /// applied the given update.
2531 /// Note that on every update, you **must** persist either the
2532 /// `ChannelMonitorUpdate` or the updated monitor itself to disk/backups. See
2533 /// the `Persist` trait documentation for more details.
2535 /// If an implementer chooses to persist the updates only, they need to make
2536 /// sure that all the updates are applied to the `ChannelMonitors` *before*
2537 /// the set of channel monitors is given to the `ChannelManager`
2538 /// deserialization routine. See [`ChannelMonitor::update_monitor`] for
2539 /// applying a monitor update to a monitor. If full `ChannelMonitors` are
2540 /// persisted, then there is no need to persist individual updates.
2542 /// Note that there could be a performance tradeoff between persisting complete
2543 /// channel monitors on every update vs. persisting only updates and applying
2544 /// them in batches. The size of each monitor grows `O(number of state updates)`
2545 /// whereas updates are small and `O(1)`.
2547 /// See [`ChannelMonitor::write`] for writing out a `ChannelMonitor`,
2548 /// [`ChannelMonitorUpdate::write`] for writing out an update, and
2549 /// [`ChannelMonitorUpdateErr`] for requirements when returning errors.
2550 fn update_persisted_channel(&self, id: OutPoint, update: &ChannelMonitorUpdate, data: &ChannelMonitor<ChannelSigner>) -> Result<(), ChannelMonitorUpdateErr>;
2553 impl<Signer: Sign, T: Deref, F: Deref, L: Deref> chain::Listen for (ChannelMonitor<Signer>, T, F, L)
2555 T::Target: BroadcasterInterface,
2556 F::Target: FeeEstimator,
2559 fn block_connected(&self, block: &Block, height: u32) {
2560 let txdata: Vec<_> = block.txdata.iter().enumerate().collect();
2561 self.0.block_connected(&block.header, &txdata, height, &*self.1, &*self.2, &*self.3);
2564 fn block_disconnected(&self, header: &BlockHeader, height: u32) {
2565 self.0.block_disconnected(header, height, &*self.1, &*self.2, &*self.3);
2569 impl<Signer: Sign, T: Deref, F: Deref, L: Deref> chain::Confirm for (ChannelMonitor<Signer>, T, F, L)
2571 T::Target: BroadcasterInterface,
2572 F::Target: FeeEstimator,
2575 fn transactions_confirmed(&self, header: &BlockHeader, txdata: &TransactionData, height: u32) {
2576 self.0.transactions_confirmed(header, txdata, height, &*self.1, &*self.2, &*self.3);
2579 fn transaction_unconfirmed(&self, txid: &Txid) {
2580 self.0.transaction_unconfirmed(txid, &*self.1, &*self.2, &*self.3);
2583 fn best_block_updated(&self, header: &BlockHeader, height: u32) {
2584 self.0.best_block_updated(header, height, &*self.1, &*self.2, &*self.3);
2587 fn get_relevant_txids(&self) -> Vec<Txid> {
2588 self.0.get_relevant_txids()
2592 const MAX_ALLOC_SIZE: usize = 64*1024;
2594 impl<'a, Signer: Sign, K: KeysInterface<Signer = Signer>> ReadableArgs<&'a K>
2595 for (BlockHash, ChannelMonitor<Signer>) {
2596 fn read<R: io::Read>(reader: &mut R, keys_manager: &'a K) -> Result<Self, DecodeError> {
2597 macro_rules! unwrap_obj {
2601 Err(_) => return Err(DecodeError::InvalidValue),
2606 let _ver = read_ver_prefix!(reader, SERIALIZATION_VERSION);
2608 let latest_update_id: u64 = Readable::read(reader)?;
2609 let commitment_transaction_number_obscure_factor = <U48 as Readable>::read(reader)?.0;
2611 let destination_script = Readable::read(reader)?;
2612 let broadcasted_holder_revokable_script = match <u8 as Readable>::read(reader)? {
2614 let revokable_address = Readable::read(reader)?;
2615 let per_commitment_point = Readable::read(reader)?;
2616 let revokable_script = Readable::read(reader)?;
2617 Some((revokable_address, per_commitment_point, revokable_script))
2620 _ => return Err(DecodeError::InvalidValue),
2622 let counterparty_payment_script = Readable::read(reader)?;
2623 let shutdown_script = {
2624 let script = <Script as Readable>::read(reader)?;
2625 if script.is_empty() { None } else { Some(script) }
2628 let channel_keys_id = Readable::read(reader)?;
2629 let holder_revocation_basepoint = Readable::read(reader)?;
2630 // Technically this can fail and serialize fail a round-trip, but only for serialization of
2631 // barely-init'd ChannelMonitors that we can't do anything with.
2632 let outpoint = OutPoint {
2633 txid: Readable::read(reader)?,
2634 index: Readable::read(reader)?,
2636 let funding_info = (outpoint, Readable::read(reader)?);
2637 let current_counterparty_commitment_txid = Readable::read(reader)?;
2638 let prev_counterparty_commitment_txid = Readable::read(reader)?;
2640 let counterparty_tx_cache = Readable::read(reader)?;
2641 let funding_redeemscript = Readable::read(reader)?;
2642 let channel_value_satoshis = Readable::read(reader)?;
2644 let their_cur_revocation_points = {
2645 let first_idx = <U48 as Readable>::read(reader)?.0;
2649 let first_point = Readable::read(reader)?;
2650 let second_point_slice: [u8; 33] = Readable::read(reader)?;
2651 if second_point_slice[0..32] == [0; 32] && second_point_slice[32] == 0 {
2652 Some((first_idx, first_point, None))
2654 Some((first_idx, first_point, Some(unwrap_obj!(PublicKey::from_slice(&second_point_slice)))))
2659 let on_holder_tx_csv: u16 = Readable::read(reader)?;
2661 let commitment_secrets = Readable::read(reader)?;
2663 macro_rules! read_htlc_in_commitment {
2666 let offered: bool = Readable::read(reader)?;
2667 let amount_msat: u64 = Readable::read(reader)?;
2668 let cltv_expiry: u32 = Readable::read(reader)?;
2669 let payment_hash: PaymentHash = Readable::read(reader)?;
2670 let transaction_output_index: Option<u32> = Readable::read(reader)?;
2672 HTLCOutputInCommitment {
2673 offered, amount_msat, cltv_expiry, payment_hash, transaction_output_index
2679 let counterparty_claimable_outpoints_len: u64 = Readable::read(reader)?;
2680 let mut counterparty_claimable_outpoints = HashMap::with_capacity(cmp::min(counterparty_claimable_outpoints_len as usize, MAX_ALLOC_SIZE / 64));
2681 for _ in 0..counterparty_claimable_outpoints_len {
2682 let txid: Txid = Readable::read(reader)?;
2683 let htlcs_count: u64 = Readable::read(reader)?;
2684 let mut htlcs = Vec::with_capacity(cmp::min(htlcs_count as usize, MAX_ALLOC_SIZE / 32));
2685 for _ in 0..htlcs_count {
2686 htlcs.push((read_htlc_in_commitment!(), <Option<HTLCSource> as Readable>::read(reader)?.map(|o: HTLCSource| Box::new(o))));
2688 if let Some(_) = counterparty_claimable_outpoints.insert(txid, htlcs) {
2689 return Err(DecodeError::InvalidValue);
2693 let counterparty_commitment_txn_on_chain_len: u64 = Readable::read(reader)?;
2694 let mut counterparty_commitment_txn_on_chain = HashMap::with_capacity(cmp::min(counterparty_commitment_txn_on_chain_len as usize, MAX_ALLOC_SIZE / 32));
2695 for _ in 0..counterparty_commitment_txn_on_chain_len {
2696 let txid: Txid = Readable::read(reader)?;
2697 let commitment_number = <U48 as Readable>::read(reader)?.0;
2698 if let Some(_) = counterparty_commitment_txn_on_chain.insert(txid, commitment_number) {
2699 return Err(DecodeError::InvalidValue);
2703 let counterparty_hash_commitment_number_len: u64 = Readable::read(reader)?;
2704 let mut counterparty_hash_commitment_number = HashMap::with_capacity(cmp::min(counterparty_hash_commitment_number_len as usize, MAX_ALLOC_SIZE / 32));
2705 for _ in 0..counterparty_hash_commitment_number_len {
2706 let payment_hash: PaymentHash = Readable::read(reader)?;
2707 let commitment_number = <U48 as Readable>::read(reader)?.0;
2708 if let Some(_) = counterparty_hash_commitment_number.insert(payment_hash, commitment_number) {
2709 return Err(DecodeError::InvalidValue);
2713 let prev_holder_signed_commitment_tx = match <u8 as Readable>::read(reader)? {
2716 Some(Readable::read(reader)?)
2718 _ => return Err(DecodeError::InvalidValue),
2720 let current_holder_commitment_tx = Readable::read(reader)?;
2722 let current_counterparty_commitment_number = <U48 as Readable>::read(reader)?.0;
2723 let current_holder_commitment_number = <U48 as Readable>::read(reader)?.0;
2725 let payment_preimages_len: u64 = Readable::read(reader)?;
2726 let mut payment_preimages = HashMap::with_capacity(cmp::min(payment_preimages_len as usize, MAX_ALLOC_SIZE / 32));
2727 for _ in 0..payment_preimages_len {
2728 let preimage: PaymentPreimage = Readable::read(reader)?;
2729 let hash = PaymentHash(Sha256::hash(&preimage.0[..]).into_inner());
2730 if let Some(_) = payment_preimages.insert(hash, preimage) {
2731 return Err(DecodeError::InvalidValue);
2735 let pending_monitor_events_len: u64 = Readable::read(reader)?;
2736 let mut pending_monitor_events = Vec::with_capacity(cmp::min(pending_monitor_events_len as usize, MAX_ALLOC_SIZE / (32 + 8*3)));
2737 for _ in 0..pending_monitor_events_len {
2738 let ev = match <u8 as Readable>::read(reader)? {
2739 0 => MonitorEvent::HTLCEvent(Readable::read(reader)?),
2740 1 => MonitorEvent::CommitmentTxBroadcasted(funding_info.0),
2741 _ => return Err(DecodeError::InvalidValue)
2743 pending_monitor_events.push(ev);
2746 let pending_events_len: u64 = Readable::read(reader)?;
2747 let mut pending_events = Vec::with_capacity(cmp::min(pending_events_len as usize, MAX_ALLOC_SIZE / mem::size_of::<Event>()));
2748 for _ in 0..pending_events_len {
2749 if let Some(event) = MaybeReadable::read(reader)? {
2750 pending_events.push(event);
2754 let best_block = BestBlock::new(Readable::read(reader)?, Readable::read(reader)?);
2756 let waiting_threshold_conf_len: u64 = Readable::read(reader)?;
2757 let mut onchain_events_awaiting_threshold_conf = Vec::with_capacity(cmp::min(waiting_threshold_conf_len as usize, MAX_ALLOC_SIZE / 128));
2758 for _ in 0..waiting_threshold_conf_len {
2759 if let Some(val) = MaybeReadable::read(reader)? {
2760 onchain_events_awaiting_threshold_conf.push(val);
2764 let outputs_to_watch_len: u64 = Readable::read(reader)?;
2765 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>>())));
2766 for _ in 0..outputs_to_watch_len {
2767 let txid = Readable::read(reader)?;
2768 let outputs_len: u64 = Readable::read(reader)?;
2769 let mut outputs = Vec::with_capacity(cmp::min(outputs_len as usize, MAX_ALLOC_SIZE / (mem::size_of::<u32>() + mem::size_of::<Script>())));
2770 for _ in 0..outputs_len {
2771 outputs.push((Readable::read(reader)?, Readable::read(reader)?));
2773 if let Some(_) = outputs_to_watch.insert(txid, outputs) {
2774 return Err(DecodeError::InvalidValue);
2777 let onchain_tx_handler = ReadableArgs::read(reader, keys_manager)?;
2779 let lockdown_from_offchain = Readable::read(reader)?;
2780 let holder_tx_signed = Readable::read(reader)?;
2782 read_tlv_fields!(reader, {});
2784 let mut secp_ctx = Secp256k1::new();
2785 secp_ctx.seeded_randomize(&keys_manager.get_secure_random_bytes());
2787 Ok((best_block.block_hash(), ChannelMonitor {
2788 inner: Mutex::new(ChannelMonitorImpl {
2790 commitment_transaction_number_obscure_factor,
2793 broadcasted_holder_revokable_script,
2794 counterparty_payment_script,
2798 holder_revocation_basepoint,
2800 current_counterparty_commitment_txid,
2801 prev_counterparty_commitment_txid,
2803 counterparty_tx_cache,
2804 funding_redeemscript,
2805 channel_value_satoshis,
2806 their_cur_revocation_points,
2811 counterparty_claimable_outpoints,
2812 counterparty_commitment_txn_on_chain,
2813 counterparty_hash_commitment_number,
2815 prev_holder_signed_commitment_tx,
2816 current_holder_commitment_tx,
2817 current_counterparty_commitment_number,
2818 current_holder_commitment_number,
2821 pending_monitor_events,
2824 onchain_events_awaiting_threshold_conf,
2829 lockdown_from_offchain,
2842 use bitcoin::blockdata::script::{Script, Builder};
2843 use bitcoin::blockdata::opcodes;
2844 use bitcoin::blockdata::transaction::{Transaction, TxIn, TxOut, SigHashType};
2845 use bitcoin::blockdata::transaction::OutPoint as BitcoinOutPoint;
2846 use bitcoin::util::bip143;
2847 use bitcoin::hashes::Hash;
2848 use bitcoin::hashes::sha256::Hash as Sha256;
2849 use bitcoin::hashes::hex::FromHex;
2850 use bitcoin::hash_types::Txid;
2851 use bitcoin::network::constants::Network;
2853 use chain::BestBlock;
2854 use chain::channelmonitor::ChannelMonitor;
2855 use chain::package::{WEIGHT_OFFERED_HTLC, WEIGHT_RECEIVED_HTLC, WEIGHT_REVOKED_OFFERED_HTLC, WEIGHT_REVOKED_RECEIVED_HTLC, WEIGHT_REVOKED_OUTPUT};
2856 use chain::transaction::OutPoint;
2857 use ln::{PaymentPreimage, PaymentHash};
2859 use ln::chan_utils::{HTLCOutputInCommitment, ChannelPublicKeys, ChannelTransactionParameters, HolderCommitmentTransaction, CounterpartyChannelTransactionParameters};
2860 use ln::script::ShutdownScript;
2861 use util::test_utils::{TestLogger, TestBroadcaster, TestFeeEstimator};
2862 use bitcoin::secp256k1::key::{SecretKey,PublicKey};
2863 use bitcoin::secp256k1::Secp256k1;
2864 use sync::{Arc, Mutex};
2865 use chain::keysinterface::InMemorySigner;
2869 fn test_prune_preimages() {
2870 let secp_ctx = Secp256k1::new();
2871 let logger = Arc::new(TestLogger::new());
2872 let broadcaster = Arc::new(TestBroadcaster{txn_broadcasted: Mutex::new(Vec::new()), blocks: Arc::new(Mutex::new(Vec::new()))});
2873 let fee_estimator = Arc::new(TestFeeEstimator { sat_per_kw: Mutex::new(253) });
2875 let dummy_key = PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[42; 32]).unwrap());
2876 let dummy_tx = Transaction { version: 0, lock_time: 0, input: Vec::new(), output: Vec::new() };
2878 let mut preimages = Vec::new();
2881 let preimage = PaymentPreimage([i; 32]);
2882 let hash = PaymentHash(Sha256::hash(&preimage.0[..]).into_inner());
2883 preimages.push((preimage, hash));
2887 macro_rules! preimages_slice_to_htlc_outputs {
2888 ($preimages_slice: expr) => {
2890 let mut res = Vec::new();
2891 for (idx, preimage) in $preimages_slice.iter().enumerate() {
2892 res.push((HTLCOutputInCommitment {
2896 payment_hash: preimage.1.clone(),
2897 transaction_output_index: Some(idx as u32),
2904 macro_rules! preimages_to_holder_htlcs {
2905 ($preimages_slice: expr) => {
2907 let mut inp = preimages_slice_to_htlc_outputs!($preimages_slice);
2908 let res: Vec<_> = inp.drain(..).map(|e| { (e.0, None, e.1) }).collect();
2914 macro_rules! test_preimages_exist {
2915 ($preimages_slice: expr, $monitor: expr) => {
2916 for preimage in $preimages_slice {
2917 assert!($monitor.inner.lock().unwrap().payment_preimages.contains_key(&preimage.1));
2922 let keys = InMemorySigner::new(
2924 SecretKey::from_slice(&[41; 32]).unwrap(),
2925 SecretKey::from_slice(&[41; 32]).unwrap(),
2926 SecretKey::from_slice(&[41; 32]).unwrap(),
2927 SecretKey::from_slice(&[41; 32]).unwrap(),
2928 SecretKey::from_slice(&[41; 32]).unwrap(),
2934 let counterparty_pubkeys = ChannelPublicKeys {
2935 funding_pubkey: PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[44; 32]).unwrap()),
2936 revocation_basepoint: PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[45; 32]).unwrap()),
2937 payment_point: PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[46; 32]).unwrap()),
2938 delayed_payment_basepoint: PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[47; 32]).unwrap()),
2939 htlc_basepoint: PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[48; 32]).unwrap())
2941 let funding_outpoint = OutPoint { txid: Default::default(), index: u16::max_value() };
2942 let channel_parameters = ChannelTransactionParameters {
2943 holder_pubkeys: keys.holder_channel_pubkeys.clone(),
2944 holder_selected_contest_delay: 66,
2945 is_outbound_from_holder: true,
2946 counterparty_parameters: Some(CounterpartyChannelTransactionParameters {
2947 pubkeys: counterparty_pubkeys,
2948 selected_contest_delay: 67,
2950 funding_outpoint: Some(funding_outpoint),
2952 // Prune with one old state and a holder commitment tx holding a few overlaps with the
2954 let shutdown_pubkey = PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[42; 32]).unwrap());
2955 let best_block = BestBlock::from_genesis(Network::Testnet);
2956 let monitor = ChannelMonitor::new(Secp256k1::new(), keys,
2957 Some(ShutdownScript::new_p2wpkh_from_pubkey(shutdown_pubkey).into_inner()), 0, &Script::new(),
2958 (OutPoint { txid: Txid::from_slice(&[43; 32]).unwrap(), index: 0 }, Script::new()),
2959 &channel_parameters,
2960 Script::new(), 46, 0,
2961 HolderCommitmentTransaction::dummy(), best_block);
2963 monitor.provide_latest_holder_commitment_tx(HolderCommitmentTransaction::dummy(), preimages_to_holder_htlcs!(preimages[0..10])).unwrap();
2964 let dummy_txid = dummy_tx.txid();
2965 monitor.provide_latest_counterparty_commitment_tx(dummy_txid, preimages_slice_to_htlc_outputs!(preimages[5..15]), 281474976710655, dummy_key, &logger);
2966 monitor.provide_latest_counterparty_commitment_tx(dummy_txid, preimages_slice_to_htlc_outputs!(preimages[15..20]), 281474976710654, dummy_key, &logger);
2967 monitor.provide_latest_counterparty_commitment_tx(dummy_txid, preimages_slice_to_htlc_outputs!(preimages[17..20]), 281474976710653, dummy_key, &logger);
2968 monitor.provide_latest_counterparty_commitment_tx(dummy_txid, preimages_slice_to_htlc_outputs!(preimages[18..20]), 281474976710652, dummy_key, &logger);
2969 for &(ref preimage, ref hash) in preimages.iter() {
2970 monitor.provide_payment_preimage(hash, preimage, &broadcaster, &fee_estimator, &logger);
2973 // Now provide a secret, pruning preimages 10-15
2974 let mut secret = [0; 32];
2975 secret[0..32].clone_from_slice(&hex::decode("7cc854b54e3e0dcdb010d7a3fee464a9687be6e8db3be6854c475621e007a5dc").unwrap());
2976 monitor.provide_secret(281474976710655, secret.clone()).unwrap();
2977 assert_eq!(monitor.inner.lock().unwrap().payment_preimages.len(), 15);
2978 test_preimages_exist!(&preimages[0..10], monitor);
2979 test_preimages_exist!(&preimages[15..20], monitor);
2981 // Now provide a further secret, pruning preimages 15-17
2982 secret[0..32].clone_from_slice(&hex::decode("c7518c8ae4660ed02894df8976fa1a3659c1a8b4b5bec0c4b872abeba4cb8964").unwrap());
2983 monitor.provide_secret(281474976710654, secret.clone()).unwrap();
2984 assert_eq!(monitor.inner.lock().unwrap().payment_preimages.len(), 13);
2985 test_preimages_exist!(&preimages[0..10], monitor);
2986 test_preimages_exist!(&preimages[17..20], monitor);
2988 // Now update holder commitment tx info, pruning only element 18 as we still care about the
2989 // previous commitment tx's preimages too
2990 monitor.provide_latest_holder_commitment_tx(HolderCommitmentTransaction::dummy(), preimages_to_holder_htlcs!(preimages[0..5])).unwrap();
2991 secret[0..32].clone_from_slice(&hex::decode("2273e227a5b7449b6e70f1fb4652864038b1cbf9cd7c043a7d6456b7fc275ad8").unwrap());
2992 monitor.provide_secret(281474976710653, secret.clone()).unwrap();
2993 assert_eq!(monitor.inner.lock().unwrap().payment_preimages.len(), 12);
2994 test_preimages_exist!(&preimages[0..10], monitor);
2995 test_preimages_exist!(&preimages[18..20], monitor);
2997 // But if we do it again, we'll prune 5-10
2998 monitor.provide_latest_holder_commitment_tx(HolderCommitmentTransaction::dummy(), preimages_to_holder_htlcs!(preimages[0..3])).unwrap();
2999 secret[0..32].clone_from_slice(&hex::decode("27cddaa5624534cb6cb9d7da077cf2b22ab21e9b506fd4998a51d54502e99116").unwrap());
3000 monitor.provide_secret(281474976710652, secret.clone()).unwrap();
3001 assert_eq!(monitor.inner.lock().unwrap().payment_preimages.len(), 5);
3002 test_preimages_exist!(&preimages[0..5], monitor);
3006 fn test_claim_txn_weight_computation() {
3007 // We test Claim txn weight, knowing that we want expected weigth and
3008 // not actual case to avoid sigs and time-lock delays hell variances.
3010 let secp_ctx = Secp256k1::new();
3011 let privkey = SecretKey::from_slice(&hex::decode("0101010101010101010101010101010101010101010101010101010101010101").unwrap()[..]).unwrap();
3012 let pubkey = PublicKey::from_secret_key(&secp_ctx, &privkey);
3013 let mut sum_actual_sigs = 0;
3015 macro_rules! sign_input {
3016 ($sighash_parts: expr, $idx: expr, $amount: expr, $weight: expr, $sum_actual_sigs: expr) => {
3017 let htlc = HTLCOutputInCommitment {
3018 offered: if *$weight == WEIGHT_REVOKED_OFFERED_HTLC || *$weight == WEIGHT_OFFERED_HTLC { true } else { false },
3020 cltv_expiry: 2 << 16,
3021 payment_hash: PaymentHash([1; 32]),
3022 transaction_output_index: Some($idx as u32),
3024 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) };
3025 let sighash = hash_to_message!(&$sighash_parts.signature_hash($idx, &redeem_script, $amount, SigHashType::All)[..]);
3026 let sig = secp_ctx.sign(&sighash, &privkey);
3027 $sighash_parts.access_witness($idx).push(sig.serialize_der().to_vec());
3028 $sighash_parts.access_witness($idx)[0].push(SigHashType::All as u8);
3029 sum_actual_sigs += $sighash_parts.access_witness($idx)[0].len();
3030 if *$weight == WEIGHT_REVOKED_OUTPUT {
3031 $sighash_parts.access_witness($idx).push(vec!(1));
3032 } else if *$weight == WEIGHT_REVOKED_OFFERED_HTLC || *$weight == WEIGHT_REVOKED_RECEIVED_HTLC {
3033 $sighash_parts.access_witness($idx).push(pubkey.clone().serialize().to_vec());
3034 } else if *$weight == WEIGHT_RECEIVED_HTLC {
3035 $sighash_parts.access_witness($idx).push(vec![0]);
3037 $sighash_parts.access_witness($idx).push(PaymentPreimage([1; 32]).0.to_vec());
3039 $sighash_parts.access_witness($idx).push(redeem_script.into_bytes());
3040 println!("witness[0] {}", $sighash_parts.access_witness($idx)[0].len());
3041 println!("witness[1] {}", $sighash_parts.access_witness($idx)[1].len());
3042 println!("witness[2] {}", $sighash_parts.access_witness($idx)[2].len());
3046 let script_pubkey = Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script();
3047 let txid = Txid::from_hex("56944c5d3f98413ef45cf54545538103cc9f298e0575820ad3591376e2e0f65d").unwrap();
3049 // Justice tx with 1 to_holder, 2 revoked offered HTLCs, 1 revoked received HTLCs
3050 let mut claim_tx = Transaction { version: 0, lock_time: 0, input: Vec::new(), output: Vec::new() };
3052 claim_tx.input.push(TxIn {
3053 previous_output: BitcoinOutPoint {
3057 script_sig: Script::new(),
3058 sequence: 0xfffffffd,
3059 witness: Vec::new(),
3062 claim_tx.output.push(TxOut {
3063 script_pubkey: script_pubkey.clone(),
3066 let base_weight = claim_tx.get_weight();
3067 let inputs_weight = vec![WEIGHT_REVOKED_OUTPUT, WEIGHT_REVOKED_OFFERED_HTLC, WEIGHT_REVOKED_OFFERED_HTLC, WEIGHT_REVOKED_RECEIVED_HTLC];
3068 let mut inputs_total_weight = 2; // count segwit flags
3070 let mut sighash_parts = bip143::SigHashCache::new(&mut claim_tx);
3071 for (idx, inp) in inputs_weight.iter().enumerate() {
3072 sign_input!(sighash_parts, idx, 0, inp, sum_actual_sigs);
3073 inputs_total_weight += inp;
3076 assert_eq!(base_weight + inputs_total_weight as usize, claim_tx.get_weight() + /* max_length_sig */ (73 * inputs_weight.len() - sum_actual_sigs));
3078 // Claim tx with 1 offered HTLCs, 3 received HTLCs
3079 claim_tx.input.clear();
3080 sum_actual_sigs = 0;
3082 claim_tx.input.push(TxIn {
3083 previous_output: BitcoinOutPoint {
3087 script_sig: Script::new(),
3088 sequence: 0xfffffffd,
3089 witness: Vec::new(),
3092 let base_weight = claim_tx.get_weight();
3093 let inputs_weight = vec![WEIGHT_OFFERED_HTLC, WEIGHT_RECEIVED_HTLC, WEIGHT_RECEIVED_HTLC, WEIGHT_RECEIVED_HTLC];
3094 let mut inputs_total_weight = 2; // count segwit flags
3096 let mut sighash_parts = bip143::SigHashCache::new(&mut claim_tx);
3097 for (idx, inp) in inputs_weight.iter().enumerate() {
3098 sign_input!(sighash_parts, idx, 0, inp, sum_actual_sigs);
3099 inputs_total_weight += inp;
3102 assert_eq!(base_weight + inputs_total_weight as usize, claim_tx.get_weight() + /* max_length_sig */ (73 * inputs_weight.len() - sum_actual_sigs));
3104 // Justice tx with 1 revoked HTLC-Success tx output
3105 claim_tx.input.clear();
3106 sum_actual_sigs = 0;
3107 claim_tx.input.push(TxIn {
3108 previous_output: BitcoinOutPoint {
3112 script_sig: Script::new(),
3113 sequence: 0xfffffffd,
3114 witness: Vec::new(),
3116 let base_weight = claim_tx.get_weight();
3117 let inputs_weight = vec![WEIGHT_REVOKED_OUTPUT];
3118 let mut inputs_total_weight = 2; // count segwit flags
3120 let mut sighash_parts = bip143::SigHashCache::new(&mut claim_tx);
3121 for (idx, inp) in inputs_weight.iter().enumerate() {
3122 sign_input!(sighash_parts, idx, 0, inp, sum_actual_sigs);
3123 inputs_total_weight += inp;
3126 assert_eq!(base_weight + inputs_total_weight as usize, claim_tx.get_weight() + /* max_length_isg */ (73 * inputs_weight.len() - sum_actual_sigs));
3129 // Further testing is done in the ChannelManager integration tests.