Merge pull request #3079 from jkczyz/2024-05-expects-quantity
[rust-lightning] / lightning / src / ln / channel.rs
1 // This file is Copyright its original authors, visible in version control
2 // history.
3 //
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
8 // licenses.
9
10 use bitcoin::blockdata::constants::ChainHash;
11 use bitcoin::blockdata::script::{Script, ScriptBuf, Builder};
12 use bitcoin::blockdata::transaction::Transaction;
13 use bitcoin::sighash;
14 use bitcoin::sighash::EcdsaSighashType;
15 use bitcoin::consensus::encode;
16
17 use bitcoin::hashes::Hash;
18 use bitcoin::hashes::sha256::Hash as Sha256;
19 use bitcoin::hashes::sha256d::Hash as Sha256d;
20 use bitcoin::hash_types::{Txid, BlockHash};
21
22 use bitcoin::secp256k1::constants::PUBLIC_KEY_SIZE;
23 use bitcoin::secp256k1::{PublicKey,SecretKey};
24 use bitcoin::secp256k1::{Secp256k1,ecdsa::Signature};
25 use bitcoin::secp256k1;
26
27 use crate::ln::types::{ChannelId, PaymentPreimage, PaymentHash};
28 use crate::ln::features::{ChannelTypeFeatures, InitFeatures};
29 use crate::ln::msgs;
30 use crate::ln::msgs::DecodeError;
31 use crate::ln::script::{self, ShutdownScript};
32 use crate::ln::channelmanager::{self, CounterpartyForwardingInfo, PendingHTLCStatus, HTLCSource, SentHTLCId, HTLCFailureMsg, PendingHTLCInfo, RAACommitmentOrder, BREAKDOWN_TIMEOUT, MIN_CLTV_EXPIRY_DELTA, MAX_LOCAL_BREAKDOWN_TIMEOUT, ChannelShutdownState};
33 use crate::ln::chan_utils::{CounterpartyCommitmentSecrets, TxCreationKeys, HTLCOutputInCommitment, htlc_success_tx_weight, htlc_timeout_tx_weight, make_funding_redeemscript, ChannelPublicKeys, CommitmentTransaction, HolderCommitmentTransaction, ChannelTransactionParameters, CounterpartyChannelTransactionParameters, MAX_HTLCS, get_commitment_transaction_number_obscure_factor, ClosingTransaction};
34 use crate::ln::chan_utils;
35 use crate::ln::onion_utils::HTLCFailReason;
36 use crate::chain::BestBlock;
37 use crate::chain::chaininterface::{FeeEstimator, ConfirmationTarget, LowerBoundedFeeEstimator};
38 use crate::chain::channelmonitor::{ChannelMonitor, ChannelMonitorUpdate, ChannelMonitorUpdateStep, LATENCY_GRACE_PERIOD_BLOCKS, CLOSED_CHANNEL_UPDATE_ID};
39 use crate::chain::transaction::{OutPoint, TransactionData};
40 use crate::sign::ecdsa::EcdsaChannelSigner;
41 use crate::sign::{EntropySource, ChannelSigner, SignerProvider, NodeSigner, Recipient};
42 use crate::events::ClosureReason;
43 use crate::routing::gossip::NodeId;
44 use crate::util::ser::{Readable, ReadableArgs, Writeable, Writer};
45 use crate::util::logger::{Logger, Record, WithContext};
46 use crate::util::errors::APIError;
47 use crate::util::config::{UserConfig, ChannelConfig, LegacyChannelConfig, ChannelHandshakeConfig, ChannelHandshakeLimits, MaxDustHTLCExposure};
48 use crate::util::scid_utils::scid_from_parts;
49
50 use crate::io;
51 use crate::prelude::*;
52 use core::{cmp,mem,fmt};
53 use core::ops::Deref;
54 #[cfg(any(test, fuzzing, debug_assertions))]
55 use crate::sync::Mutex;
56 use crate::sign::type_resolver::ChannelSignerType;
57
58 use super::channel_keys::{DelayedPaymentBasepoint, HtlcBasepoint, RevocationBasepoint};
59
60 #[cfg(test)]
61 pub struct ChannelValueStat {
62         pub value_to_self_msat: u64,
63         pub channel_value_msat: u64,
64         pub channel_reserve_msat: u64,
65         pub pending_outbound_htlcs_amount_msat: u64,
66         pub pending_inbound_htlcs_amount_msat: u64,
67         pub holding_cell_outbound_amount_msat: u64,
68         pub counterparty_max_htlc_value_in_flight_msat: u64, // outgoing
69         pub counterparty_dust_limit_msat: u64,
70 }
71
72 pub struct AvailableBalances {
73         /// The amount that would go to us if we close the channel, ignoring any on-chain fees.
74         pub balance_msat: u64,
75         /// Total amount available for our counterparty to send to us.
76         pub inbound_capacity_msat: u64,
77         /// Total amount available for us to send to our counterparty.
78         pub outbound_capacity_msat: u64,
79         /// The maximum value we can assign to the next outbound HTLC
80         pub next_outbound_htlc_limit_msat: u64,
81         /// The minimum value we can assign to the next outbound HTLC
82         pub next_outbound_htlc_minimum_msat: u64,
83 }
84
85 #[derive(Debug, Clone, Copy, PartialEq)]
86 enum FeeUpdateState {
87         // Inbound states mirroring InboundHTLCState
88         RemoteAnnounced,
89         AwaitingRemoteRevokeToAnnounce,
90         // Note that we do not have a AwaitingAnnouncedRemoteRevoke variant here as it is universally
91         // handled the same as `Committed`, with the only exception in `InboundHTLCState` being the
92         // distinction of when we allow ourselves to forward the HTLC. Because we aren't "forwarding"
93         // the fee update anywhere, we can simply consider the fee update `Committed` immediately
94         // instead of setting it to AwaitingAnnouncedRemoteRevoke.
95
96         // Outbound state can only be `LocalAnnounced` or `Committed`
97         Outbound,
98 }
99
100 enum InboundHTLCRemovalReason {
101         FailRelay(msgs::OnionErrorPacket),
102         FailMalformed(([u8; 32], u16)),
103         Fulfill(PaymentPreimage),
104 }
105
106 /// Represents the resolution status of an inbound HTLC.
107 #[derive(Clone)]
108 enum InboundHTLCResolution {
109         /// Resolved implies the action we must take with the inbound HTLC has already been determined,
110         /// i.e., we already know whether it must be failed back or forwarded.
111         //
112         // TODO: Once this variant is removed, we should also clean up
113         // [`MonitorRestoreUpdates::accepted_htlcs`] as the path will be unreachable.
114         Resolved {
115                 pending_htlc_status: PendingHTLCStatus,
116         },
117         /// Pending implies we will attempt to resolve the inbound HTLC once it has been fully committed
118         /// to by both sides of the channel, i.e., once a `revoke_and_ack` has been processed by both
119         /// nodes for the state update in which it was proposed.
120         Pending {
121                 update_add_htlc: msgs::UpdateAddHTLC,
122         },
123 }
124
125 impl_writeable_tlv_based_enum!(InboundHTLCResolution,
126         (0, Resolved) => {
127                 (0, pending_htlc_status, required),
128         },
129         (2, Pending) => {
130                 (0, update_add_htlc, required),
131         };
132 );
133
134 enum InboundHTLCState {
135         /// Offered by remote, to be included in next local commitment tx. I.e., the remote sent an
136         /// update_add_htlc message for this HTLC.
137         RemoteAnnounced(InboundHTLCResolution),
138         /// Included in a received commitment_signed message (implying we've
139         /// revoke_and_ack'd it), but the remote hasn't yet revoked their previous
140         /// state (see the example below). We have not yet included this HTLC in a
141         /// commitment_signed message because we are waiting on the remote's
142         /// aforementioned state revocation. One reason this missing remote RAA
143         /// (revoke_and_ack) blocks us from constructing a commitment_signed message
144         /// is because every time we create a new "state", i.e. every time we sign a
145         /// new commitment tx (see [BOLT #2]), we need a new per_commitment_point,
146         /// which are provided one-at-a-time in each RAA. E.g., the last RAA they
147         /// sent provided the per_commitment_point for our current commitment tx.
148         /// The other reason we should not send a commitment_signed without their RAA
149         /// is because their RAA serves to ACK our previous commitment_signed.
150         ///
151         /// Here's an example of how an HTLC could come to be in this state:
152         /// remote --> update_add_htlc(prev_htlc)   --> local
153         /// remote --> commitment_signed(prev_htlc) --> local
154         /// remote <-- revoke_and_ack               <-- local
155         /// remote <-- commitment_signed(prev_htlc) <-- local
156         /// [note that here, the remote does not respond with a RAA]
157         /// remote --> update_add_htlc(this_htlc)   --> local
158         /// remote --> commitment_signed(prev_htlc, this_htlc) --> local
159         /// Now `this_htlc` will be assigned this state. It's unable to be officially
160         /// accepted, i.e. included in a commitment_signed, because we're missing the
161         /// RAA that provides our next per_commitment_point. The per_commitment_point
162         /// is used to derive commitment keys, which are used to construct the
163         /// signatures in a commitment_signed message.
164         /// Implies AwaitingRemoteRevoke.
165         ///
166         /// [BOLT #2]: https://github.com/lightning/bolts/blob/master/02-peer-protocol.md
167         AwaitingRemoteRevokeToAnnounce(InboundHTLCResolution),
168         /// Included in a received commitment_signed message (implying we've revoke_and_ack'd it).
169         /// We have also included this HTLC in our latest commitment_signed and are now just waiting
170         /// on the remote's revoke_and_ack to make this HTLC an irrevocable part of the state of the
171         /// channel (before it can then get forwarded and/or removed).
172         /// Implies AwaitingRemoteRevoke.
173         AwaitingAnnouncedRemoteRevoke(InboundHTLCResolution),
174         Committed,
175         /// Removed by us and a new commitment_signed was sent (if we were AwaitingRemoteRevoke when we
176         /// created it we would have put it in the holding cell instead). When they next revoke_and_ack
177         /// we'll drop it.
178         /// Note that we have to keep an eye on the HTLC until we've received a broadcastable
179         /// commitment transaction without it as otherwise we'll have to force-close the channel to
180         /// claim it before the timeout (obviously doesn't apply to revoked HTLCs that we can't claim
181         /// anyway). That said, ChannelMonitor does this for us (see
182         /// ChannelMonitor::should_broadcast_holder_commitment_txn) so we actually remove the HTLC from
183         /// our own local state before then, once we're sure that the next commitment_signed and
184         /// ChannelMonitor::provide_latest_local_commitment_tx will not include this HTLC.
185         LocalRemoved(InboundHTLCRemovalReason),
186 }
187
188 /// Exposes the state of pending inbound HTLCs.
189 ///
190 /// At a high level, an HTLC being forwarded from one Lightning node to another Lightning node goes
191 /// through the following states in the state machine:
192 /// - Announced for addition by the originating node through the update_add_htlc message.
193 /// - Added to the commitment transaction of the receiving node and originating node in turn
194 ///   through the exchange of commitment_signed and revoke_and_ack messages.
195 /// - Announced for resolution (fulfillment or failure) by the receiving node through either one of
196 ///   the update_fulfill_htlc, update_fail_htlc, and update_fail_malformed_htlc messages.
197 /// - Removed from the commitment transaction of the originating node and receiving node in turn
198 ///   through the exchange of commitment_signed and revoke_and_ack messages.
199 ///
200 /// This can be used to inspect what next message an HTLC is waiting for to advance its state.
201 #[derive(Clone, Debug, PartialEq)]
202 pub enum InboundHTLCStateDetails {
203         /// We have added this HTLC in our commitment transaction by receiving commitment_signed and
204         /// returning revoke_and_ack. We are awaiting the appropriate revoke_and_ack's from the remote
205         /// before this HTLC is included on the remote commitment transaction.
206         AwaitingRemoteRevokeToAdd,
207         /// This HTLC has been included in the commitment_signed and revoke_and_ack messages on both sides
208         /// and is included in both commitment transactions.
209         ///
210         /// This HTLC is now safe to either forward or be claimed as a payment by us. The HTLC will
211         /// remain in this state until the forwarded upstream HTLC has been resolved and we resolve this
212         /// HTLC correspondingly, or until we claim it as a payment. If it is part of a multipart
213         /// payment, it will only be claimed together with other required parts.
214         Committed,
215         /// We have received the preimage for this HTLC and it is being removed by fulfilling it with
216         /// update_fulfill_htlc. This HTLC is still on both commitment transactions, but we are awaiting
217         /// the appropriate revoke_and_ack's from the remote before this HTLC is removed from the remote
218         /// commitment transaction after update_fulfill_htlc.
219         AwaitingRemoteRevokeToRemoveFulfill,
220         /// The HTLC is being removed by failing it with update_fail_htlc or update_fail_malformed_htlc.
221         /// This HTLC is still on both commitment transactions, but we are awaiting the appropriate
222         /// revoke_and_ack's from the remote before this HTLC is removed from the remote commitment
223         /// transaction.
224         AwaitingRemoteRevokeToRemoveFail,
225 }
226
227 impl From<&InboundHTLCState> for Option<InboundHTLCStateDetails> {
228         fn from(state: &InboundHTLCState) -> Option<InboundHTLCStateDetails> {
229                 match state {
230                         InboundHTLCState::RemoteAnnounced(_) => None,
231                         InboundHTLCState::AwaitingRemoteRevokeToAnnounce(_) =>
232                                 Some(InboundHTLCStateDetails::AwaitingRemoteRevokeToAdd),
233                         InboundHTLCState::AwaitingAnnouncedRemoteRevoke(_) =>
234                                 Some(InboundHTLCStateDetails::AwaitingRemoteRevokeToAdd),
235                         InboundHTLCState::Committed =>
236                                 Some(InboundHTLCStateDetails::Committed),
237                         InboundHTLCState::LocalRemoved(InboundHTLCRemovalReason::FailRelay(_)) =>
238                                 Some(InboundHTLCStateDetails::AwaitingRemoteRevokeToRemoveFail),
239                         InboundHTLCState::LocalRemoved(InboundHTLCRemovalReason::FailMalformed(_)) =>
240                                 Some(InboundHTLCStateDetails::AwaitingRemoteRevokeToRemoveFail),
241                         InboundHTLCState::LocalRemoved(InboundHTLCRemovalReason::Fulfill(_)) =>
242                                 Some(InboundHTLCStateDetails::AwaitingRemoteRevokeToRemoveFulfill),
243                 }
244         }
245 }
246
247 impl_writeable_tlv_based_enum_upgradable!(InboundHTLCStateDetails,
248         (0, AwaitingRemoteRevokeToAdd) => {},
249         (2, Committed) => {},
250         (4, AwaitingRemoteRevokeToRemoveFulfill) => {},
251         (6, AwaitingRemoteRevokeToRemoveFail) => {};
252 );
253
254 struct InboundHTLCOutput {
255         htlc_id: u64,
256         amount_msat: u64,
257         cltv_expiry: u32,
258         payment_hash: PaymentHash,
259         state: InboundHTLCState,
260 }
261
262 /// Exposes details around pending inbound HTLCs.
263 #[derive(Clone, Debug, PartialEq)]
264 pub struct InboundHTLCDetails {
265         /// The HTLC ID.
266         /// The IDs are incremented by 1 starting from 0 for each offered HTLC.
267         /// They are unique per channel and inbound/outbound direction, unless an HTLC was only announced
268         /// and not part of any commitment transaction.
269         pub htlc_id: u64,
270         /// The amount in msat.
271         pub amount_msat: u64,
272         /// The block height at which this HTLC expires.
273         pub cltv_expiry: u32,
274         /// The payment hash.
275         pub payment_hash: PaymentHash,
276         /// The state of the HTLC in the state machine.
277         ///
278         /// Determines on which commitment transactions the HTLC is included and what message the HTLC is
279         /// waiting for to advance to the next state.
280         ///
281         /// See [`InboundHTLCStateDetails`] for information on the specific states.
282         ///
283         /// LDK will always fill this field in, but when downgrading to prior versions of LDK, new
284         /// states may result in `None` here.
285         pub state: Option<InboundHTLCStateDetails>,
286         /// Whether the HTLC has an output below the local dust limit. If so, the output will be trimmed
287         /// from the local commitment transaction and added to the commitment transaction fee.
288         /// For non-anchor channels, this takes into account the cost of the second-stage HTLC
289         /// transactions as well.
290         ///
291         /// When the local commitment transaction is broadcasted as part of a unilateral closure,
292         /// the value of this HTLC will therefore not be claimable but instead burned as a transaction
293         /// fee.
294         ///
295         /// Note that dust limits are specific to each party. An HTLC can be dust for the local
296         /// commitment transaction but not for the counterparty's commitment transaction and vice versa.
297         pub is_dust: bool,
298 }
299
300 impl_writeable_tlv_based!(InboundHTLCDetails, {
301         (0, htlc_id, required),
302         (2, amount_msat, required),
303         (4, cltv_expiry, required),
304         (6, payment_hash, required),
305         (7, state, upgradable_option),
306         (8, is_dust, required),
307 });
308
309 #[cfg_attr(test, derive(Clone, Debug, PartialEq))]
310 enum OutboundHTLCState {
311         /// Added by us and included in a commitment_signed (if we were AwaitingRemoteRevoke when we
312         /// created it we would have put it in the holding cell instead). When they next revoke_and_ack
313         /// we will promote to Committed (note that they may not accept it until the next time we
314         /// revoke, but we don't really care about that:
315         ///  * they've revoked, so worst case we can announce an old state and get our (option on)
316         ///    money back (though we won't), and,
317         ///  * we'll send them a revoke when they send a commitment_signed, and since only they're
318         ///    allowed to remove it, the "can only be removed once committed on both sides" requirement
319         ///    doesn't matter to us and it's up to them to enforce it, worst-case they jump ahead but
320         ///    we'll never get out of sync).
321         /// Note that we Box the OnionPacket as it's rather large and we don't want to blow up
322         /// OutboundHTLCOutput's size just for a temporary bit
323         LocalAnnounced(Box<msgs::OnionPacket>),
324         Committed,
325         /// Remote removed this (outbound) HTLC. We're waiting on their commitment_signed to finalize
326         /// the change (though they'll need to revoke before we fail the payment).
327         RemoteRemoved(OutboundHTLCOutcome),
328         /// Remote removed this and sent a commitment_signed (implying we've revoke_and_ack'ed it), but
329         /// the remote side hasn't yet revoked their previous state, which we need them to do before we
330         /// can do any backwards failing. Implies AwaitingRemoteRevoke.
331         /// We also have not yet removed this HTLC in a commitment_signed message, and are waiting on a
332         /// remote revoke_and_ack on a previous state before we can do so.
333         AwaitingRemoteRevokeToRemove(OutboundHTLCOutcome),
334         /// Remote removed this and sent a commitment_signed (implying we've revoke_and_ack'ed it), but
335         /// the remote side hasn't yet revoked their previous state, which we need them to do before we
336         /// can do any backwards failing. Implies AwaitingRemoteRevoke.
337         /// We have removed this HTLC in our latest commitment_signed and are now just waiting on a
338         /// revoke_and_ack to drop completely.
339         AwaitingRemovedRemoteRevoke(OutboundHTLCOutcome),
340 }
341
342 /// Exposes the state of pending outbound HTLCs.
343 ///
344 /// At a high level, an HTLC being forwarded from one Lightning node to another Lightning node goes
345 /// through the following states in the state machine:
346 /// - Announced for addition by the originating node through the update_add_htlc message.
347 /// - Added to the commitment transaction of the receiving node and originating node in turn
348 ///   through the exchange of commitment_signed and revoke_and_ack messages.
349 /// - Announced for resolution (fulfillment or failure) by the receiving node through either one of
350 ///   the update_fulfill_htlc, update_fail_htlc, and update_fail_malformed_htlc messages.
351 /// - Removed from the commitment transaction of the originating node and receiving node in turn
352 ///   through the exchange of commitment_signed and revoke_and_ack messages.
353 ///
354 /// This can be used to inspect what next message an HTLC is waiting for to advance its state.
355 #[derive(Clone, Debug, PartialEq)]
356 pub enum OutboundHTLCStateDetails {
357         /// We are awaiting the appropriate revoke_and_ack's from the remote before the HTLC is added
358         /// on the remote's commitment transaction after update_add_htlc.
359         AwaitingRemoteRevokeToAdd,
360         /// The HTLC has been added to the remote's commitment transaction by sending commitment_signed
361         /// and receiving revoke_and_ack in return.
362         ///
363         /// The HTLC will remain in this state until the remote node resolves the HTLC, or until we
364         /// unilaterally close the channel due to a timeout with an uncooperative remote node.
365         Committed,
366         /// The HTLC has been fulfilled successfully by the remote with a preimage in update_fulfill_htlc,
367         /// and we removed the HTLC from our commitment transaction by receiving commitment_signed and
368         /// returning revoke_and_ack. We are awaiting the appropriate revoke_and_ack's from the remote
369         /// for the removal from its commitment transaction.
370         AwaitingRemoteRevokeToRemoveSuccess,
371         /// The HTLC has been failed by the remote with update_fail_htlc or update_fail_malformed_htlc,
372         /// and we removed the HTLC from our commitment transaction by receiving commitment_signed and
373         /// returning revoke_and_ack. We are awaiting the appropriate revoke_and_ack's from the remote
374         /// for the removal from its commitment transaction.
375         AwaitingRemoteRevokeToRemoveFailure,
376 }
377
378 impl From<&OutboundHTLCState> for OutboundHTLCStateDetails {
379         fn from(state: &OutboundHTLCState) -> OutboundHTLCStateDetails {
380                 match state {
381                         OutboundHTLCState::LocalAnnounced(_) =>
382                                 OutboundHTLCStateDetails::AwaitingRemoteRevokeToAdd,
383                         OutboundHTLCState::Committed =>
384                                 OutboundHTLCStateDetails::Committed,
385                         // RemoteRemoved states are ignored as the state is transient and the remote has not committed to
386                         // the state yet.
387                         OutboundHTLCState::RemoteRemoved(_) =>
388                                 OutboundHTLCStateDetails::Committed,
389                         OutboundHTLCState::AwaitingRemoteRevokeToRemove(OutboundHTLCOutcome::Success(_)) =>
390                                 OutboundHTLCStateDetails::AwaitingRemoteRevokeToRemoveSuccess,
391                         OutboundHTLCState::AwaitingRemoteRevokeToRemove(OutboundHTLCOutcome::Failure(_)) =>
392                                 OutboundHTLCStateDetails::AwaitingRemoteRevokeToRemoveFailure,
393                         OutboundHTLCState::AwaitingRemovedRemoteRevoke(OutboundHTLCOutcome::Success(_)) =>
394                                 OutboundHTLCStateDetails::AwaitingRemoteRevokeToRemoveSuccess,
395                         OutboundHTLCState::AwaitingRemovedRemoteRevoke(OutboundHTLCOutcome::Failure(_)) =>
396                                 OutboundHTLCStateDetails::AwaitingRemoteRevokeToRemoveFailure,
397                 }
398         }
399 }
400
401 impl_writeable_tlv_based_enum_upgradable!(OutboundHTLCStateDetails,
402         (0, AwaitingRemoteRevokeToAdd) => {},
403         (2, Committed) => {},
404         (4, AwaitingRemoteRevokeToRemoveSuccess) => {},
405         (6, AwaitingRemoteRevokeToRemoveFailure) => {};
406 );
407
408 #[derive(Clone)]
409 #[cfg_attr(test, derive(Debug, PartialEq))]
410 enum OutboundHTLCOutcome {
411         /// LDK version 0.0.105+ will always fill in the preimage here.
412         Success(Option<PaymentPreimage>),
413         Failure(HTLCFailReason),
414 }
415
416 impl From<Option<HTLCFailReason>> for OutboundHTLCOutcome {
417         fn from(o: Option<HTLCFailReason>) -> Self {
418                 match o {
419                         None => OutboundHTLCOutcome::Success(None),
420                         Some(r) => OutboundHTLCOutcome::Failure(r)
421                 }
422         }
423 }
424
425 impl<'a> Into<Option<&'a HTLCFailReason>> for &'a OutboundHTLCOutcome {
426         fn into(self) -> Option<&'a HTLCFailReason> {
427                 match self {
428                         OutboundHTLCOutcome::Success(_) => None,
429                         OutboundHTLCOutcome::Failure(ref r) => Some(r)
430                 }
431         }
432 }
433
434 #[cfg_attr(test, derive(Clone, Debug, PartialEq))]
435 struct OutboundHTLCOutput {
436         htlc_id: u64,
437         amount_msat: u64,
438         cltv_expiry: u32,
439         payment_hash: PaymentHash,
440         state: OutboundHTLCState,
441         source: HTLCSource,
442         blinding_point: Option<PublicKey>,
443         skimmed_fee_msat: Option<u64>,
444 }
445
446 /// Exposes details around pending outbound HTLCs.
447 #[derive(Clone, Debug, PartialEq)]
448 pub struct OutboundHTLCDetails {
449         /// The HTLC ID.
450         /// The IDs are incremented by 1 starting from 0 for each offered HTLC.
451         /// They are unique per channel and inbound/outbound direction, unless an HTLC was only announced
452         /// and not part of any commitment transaction.
453         ///
454         /// Not present when we are awaiting a remote revocation and the HTLC is not added yet.
455         pub htlc_id: Option<u64>,
456         /// The amount in msat.
457         pub amount_msat: u64,
458         /// The block height at which this HTLC expires.
459         pub cltv_expiry: u32,
460         /// The payment hash.
461         pub payment_hash: PaymentHash,
462         /// The state of the HTLC in the state machine.
463         ///
464         /// Determines on which commitment transactions the HTLC is included and what message the HTLC is
465         /// waiting for to advance to the next state.
466         ///
467         /// See [`OutboundHTLCStateDetails`] for information on the specific states.
468         ///
469         /// LDK will always fill this field in, but when downgrading to prior versions of LDK, new
470         /// states may result in `None` here.
471         pub state: Option<OutboundHTLCStateDetails>,
472         /// The extra fee being skimmed off the top of this HTLC.
473         pub skimmed_fee_msat: Option<u64>,
474         /// Whether the HTLC has an output below the local dust limit. If so, the output will be trimmed
475         /// from the local commitment transaction and added to the commitment transaction fee.
476         /// For non-anchor channels, this takes into account the cost of the second-stage HTLC
477         /// transactions as well.
478         ///
479         /// When the local commitment transaction is broadcasted as part of a unilateral closure,
480         /// the value of this HTLC will therefore not be claimable but instead burned as a transaction
481         /// fee.
482         ///
483         /// Note that dust limits are specific to each party. An HTLC can be dust for the local
484         /// commitment transaction but not for the counterparty's commitment transaction and vice versa.
485         pub is_dust: bool,
486 }
487
488 impl_writeable_tlv_based!(OutboundHTLCDetails, {
489         (0, htlc_id, required),
490         (2, amount_msat, required),
491         (4, cltv_expiry, required),
492         (6, payment_hash, required),
493         (7, state, upgradable_option),
494         (8, skimmed_fee_msat, required),
495         (10, is_dust, required),
496 });
497
498 /// See AwaitingRemoteRevoke ChannelState for more info
499 #[cfg_attr(test, derive(Clone, Debug, PartialEq))]
500 enum HTLCUpdateAwaitingACK {
501         AddHTLC { // TODO: Time out if we're getting close to cltv_expiry
502                 // always outbound
503                 amount_msat: u64,
504                 cltv_expiry: u32,
505                 payment_hash: PaymentHash,
506                 source: HTLCSource,
507                 onion_routing_packet: msgs::OnionPacket,
508                 // The extra fee we're skimming off the top of this HTLC.
509                 skimmed_fee_msat: Option<u64>,
510                 blinding_point: Option<PublicKey>,
511         },
512         ClaimHTLC {
513                 payment_preimage: PaymentPreimage,
514                 htlc_id: u64,
515         },
516         FailHTLC {
517                 htlc_id: u64,
518                 err_packet: msgs::OnionErrorPacket,
519         },
520         FailMalformedHTLC {
521                 htlc_id: u64,
522                 failure_code: u16,
523                 sha256_of_onion: [u8; 32],
524         },
525 }
526
527 macro_rules! define_state_flags {
528         ($flag_type_doc: expr, $flag_type: ident, [$(($flag_doc: expr, $flag: ident, $value: expr, $get: ident, $set: ident, $clear: ident)),+], $extra_flags: expr) => {
529                 #[doc = $flag_type_doc]
530                 #[derive(Copy, Clone, Debug, PartialEq, PartialOrd, Eq)]
531                 struct $flag_type(u32);
532
533                 impl $flag_type {
534                         $(
535                                 #[doc = $flag_doc]
536                                 const $flag: $flag_type = $flag_type($value);
537                         )*
538
539                         /// All flags that apply to the specified [`ChannelState`] variant.
540                         #[allow(unused)]
541                         const ALL: $flag_type = Self($(Self::$flag.0 | )* $extra_flags);
542
543                         #[allow(unused)]
544                         fn new() -> Self { Self(0) }
545
546                         #[allow(unused)]
547                         fn from_u32(flags: u32) -> Result<Self, ()> {
548                                 if flags & !Self::ALL.0 != 0 {
549                                         Err(())
550                                 } else {
551                                         Ok($flag_type(flags))
552                                 }
553                         }
554
555                         #[allow(unused)]
556                         fn is_empty(&self) -> bool { self.0 == 0 }
557                         #[allow(unused)]
558                         fn is_set(&self, flag: Self) -> bool { *self & flag == flag }
559                         #[allow(unused)]
560                         fn set(&mut self, flag: Self) { *self |= flag }
561                         #[allow(unused)]
562                         fn clear(&mut self, flag: Self) -> Self { self.0 &= !flag.0; *self }
563                 }
564
565                 $(
566                         define_state_flags!($flag_type, Self::$flag, $get, $set, $clear);
567                 )*
568
569                 impl core::ops::BitOr for $flag_type {
570                         type Output = Self;
571                         fn bitor(self, rhs: Self) -> Self::Output { Self(self.0 | rhs.0) }
572                 }
573                 impl core::ops::BitOrAssign for $flag_type {
574                         fn bitor_assign(&mut self, rhs: Self) { self.0 |= rhs.0; }
575                 }
576                 impl core::ops::BitAnd for $flag_type {
577                         type Output = Self;
578                         fn bitand(self, rhs: Self) -> Self::Output { Self(self.0 & rhs.0) }
579                 }
580                 impl core::ops::BitAndAssign for $flag_type {
581                         fn bitand_assign(&mut self, rhs: Self) { self.0 &= rhs.0; }
582                 }
583         };
584         ($flag_type_doc: expr, $flag_type: ident, $flags: tt) => {
585                 define_state_flags!($flag_type_doc, $flag_type, $flags, 0);
586         };
587         ($flag_type: ident, $flag: expr, $get: ident, $set: ident, $clear: ident) => {
588                 impl $flag_type {
589                         #[allow(unused)]
590                         fn $get(&self) -> bool { self.is_set($flag_type::new() | $flag) }
591                         #[allow(unused)]
592                         fn $set(&mut self) { self.set($flag_type::new() | $flag) }
593                         #[allow(unused)]
594                         fn $clear(&mut self) -> Self { self.clear($flag_type::new() | $flag) }
595                 }
596         };
597         ($flag_type_doc: expr, FUNDED_STATE, $flag_type: ident, $flags: tt) => {
598                 define_state_flags!($flag_type_doc, $flag_type, $flags, FundedStateFlags::ALL.0);
599
600                 define_state_flags!($flag_type, FundedStateFlags::PEER_DISCONNECTED,
601                         is_peer_disconnected, set_peer_disconnected, clear_peer_disconnected);
602                 define_state_flags!($flag_type, FundedStateFlags::MONITOR_UPDATE_IN_PROGRESS,
603                         is_monitor_update_in_progress, set_monitor_update_in_progress, clear_monitor_update_in_progress);
604                 define_state_flags!($flag_type, FundedStateFlags::REMOTE_SHUTDOWN_SENT,
605                         is_remote_shutdown_sent, set_remote_shutdown_sent, clear_remote_shutdown_sent);
606                 define_state_flags!($flag_type, FundedStateFlags::LOCAL_SHUTDOWN_SENT,
607                         is_local_shutdown_sent, set_local_shutdown_sent, clear_local_shutdown_sent);
608
609                 impl core::ops::BitOr<FundedStateFlags> for $flag_type {
610                         type Output = Self;
611                         fn bitor(self, rhs: FundedStateFlags) -> Self::Output { Self(self.0 | rhs.0) }
612                 }
613                 impl core::ops::BitOrAssign<FundedStateFlags> for $flag_type {
614                         fn bitor_assign(&mut self, rhs: FundedStateFlags) { self.0 |= rhs.0; }
615                 }
616                 impl core::ops::BitAnd<FundedStateFlags> for $flag_type {
617                         type Output = Self;
618                         fn bitand(self, rhs: FundedStateFlags) -> Self::Output { Self(self.0 & rhs.0) }
619                 }
620                 impl core::ops::BitAndAssign<FundedStateFlags> for $flag_type {
621                         fn bitand_assign(&mut self, rhs: FundedStateFlags) { self.0 &= rhs.0; }
622                 }
623                 impl PartialEq<FundedStateFlags> for $flag_type {
624                         fn eq(&self, other: &FundedStateFlags) -> bool { self.0 == other.0 }
625                 }
626                 impl From<FundedStateFlags> for $flag_type {
627                         fn from(flags: FundedStateFlags) -> Self { Self(flags.0) }
628                 }
629         };
630 }
631
632 /// We declare all the states/flags here together to help determine which bits are still available
633 /// to choose.
634 mod state_flags {
635         pub const OUR_INIT_SENT: u32 = 1 << 0;
636         pub const THEIR_INIT_SENT: u32 = 1 << 1;
637         pub const FUNDING_NEGOTIATED: u32 = 1 << 2;
638         pub const AWAITING_CHANNEL_READY: u32 = 1 << 3;
639         pub const THEIR_CHANNEL_READY: u32 = 1 << 4;
640         pub const OUR_CHANNEL_READY: u32 = 1 << 5;
641         pub const CHANNEL_READY: u32 = 1 << 6;
642         pub const PEER_DISCONNECTED: u32 = 1 << 7;
643         pub const MONITOR_UPDATE_IN_PROGRESS: u32 = 1 << 8;
644         pub const AWAITING_REMOTE_REVOKE: u32 = 1 << 9;
645         pub const REMOTE_SHUTDOWN_SENT: u32 = 1 << 10;
646         pub const LOCAL_SHUTDOWN_SENT: u32 = 1 << 11;
647         pub const SHUTDOWN_COMPLETE: u32 = 1 << 12;
648         pub const WAITING_FOR_BATCH: u32 = 1 << 13;
649 }
650
651 define_state_flags!(
652         "Flags that apply to all [`ChannelState`] variants in which the channel is funded.",
653         FundedStateFlags, [
654                 ("Indicates the remote side is considered \"disconnected\" and no updates are allowed \
655                         until after we've done a `channel_reestablish` dance.", PEER_DISCONNECTED, state_flags::PEER_DISCONNECTED,
656                         is_peer_disconnected, set_peer_disconnected, clear_peer_disconnected),
657                 ("Indicates the user has told us a `ChannelMonitor` update is pending async persistence \
658                         somewhere and we should pause sending any outbound messages until they've managed to \
659                         complete it.", MONITOR_UPDATE_IN_PROGRESS, state_flags::MONITOR_UPDATE_IN_PROGRESS,
660                         is_monitor_update_in_progress, set_monitor_update_in_progress, clear_monitor_update_in_progress),
661                 ("Indicates we received a `shutdown` message from the remote end. If set, they may not add \
662                         any new HTLCs to the channel, and we are expected to respond with our own `shutdown` \
663                         message when possible.", REMOTE_SHUTDOWN_SENT, state_flags::REMOTE_SHUTDOWN_SENT,
664                         is_remote_shutdown_sent, set_remote_shutdown_sent, clear_remote_shutdown_sent),
665                 ("Indicates we sent a `shutdown` message. At this point, we may not add any new HTLCs to \
666                         the channel.", LOCAL_SHUTDOWN_SENT, state_flags::LOCAL_SHUTDOWN_SENT,
667                         is_local_shutdown_sent, set_local_shutdown_sent, clear_local_shutdown_sent)
668         ]
669 );
670
671 define_state_flags!(
672         "Flags that only apply to [`ChannelState::NegotiatingFunding`].",
673         NegotiatingFundingFlags, [
674                 ("Indicates we have (or are prepared to) send our `open_channel`/`accept_channel` message.",
675                         OUR_INIT_SENT, state_flags::OUR_INIT_SENT, is_our_init_sent, set_our_init_sent, clear_our_init_sent),
676                 ("Indicates we have received their `open_channel`/`accept_channel` message.",
677                         THEIR_INIT_SENT, state_flags::THEIR_INIT_SENT, is_their_init_sent, set_their_init_sent, clear_their_init_sent)
678         ]
679 );
680
681 define_state_flags!(
682         "Flags that only apply to [`ChannelState::AwaitingChannelReady`].",
683         FUNDED_STATE, AwaitingChannelReadyFlags, [
684                 ("Indicates they sent us a `channel_ready` message. Once both `THEIR_CHANNEL_READY` and \
685                         `OUR_CHANNEL_READY` are set, our state moves on to `ChannelReady`.",
686                         THEIR_CHANNEL_READY, state_flags::THEIR_CHANNEL_READY,
687                         is_their_channel_ready, set_their_channel_ready, clear_their_channel_ready),
688                 ("Indicates we sent them a `channel_ready` message. Once both `THEIR_CHANNEL_READY` and \
689                         `OUR_CHANNEL_READY` are set, our state moves on to `ChannelReady`.",
690                         OUR_CHANNEL_READY, state_flags::OUR_CHANNEL_READY,
691                         is_our_channel_ready, set_our_channel_ready, clear_our_channel_ready),
692                 ("Indicates the channel was funded in a batch and the broadcast of the funding transaction \
693                         is being held until all channels in the batch have received `funding_signed` and have \
694                         their monitors persisted.", WAITING_FOR_BATCH, state_flags::WAITING_FOR_BATCH,
695                         is_waiting_for_batch, set_waiting_for_batch, clear_waiting_for_batch)
696         ]
697 );
698
699 define_state_flags!(
700         "Flags that only apply to [`ChannelState::ChannelReady`].",
701         FUNDED_STATE, ChannelReadyFlags, [
702                 ("Indicates that we have sent a `commitment_signed` but are awaiting the responding \
703                         `revoke_and_ack` message. During this period, we can't generate new `commitment_signed` \
704                         messages as we'd be unable to determine which HTLCs they included in their `revoke_and_ack` \
705                         implicit ACK, so instead we have to hold them away temporarily to be sent later.",
706                         AWAITING_REMOTE_REVOKE, state_flags::AWAITING_REMOTE_REVOKE,
707                         is_awaiting_remote_revoke, set_awaiting_remote_revoke, clear_awaiting_remote_revoke)
708         ]
709 );
710
711 // Note that the order of this enum is implicitly defined by where each variant is placed. Take this
712 // into account when introducing new states and update `test_channel_state_order` accordingly.
713 #[derive(Copy, Clone, Debug, PartialEq, PartialOrd, Eq)]
714 enum ChannelState {
715         /// We are negotiating the parameters required for the channel prior to funding it.
716         NegotiatingFunding(NegotiatingFundingFlags),
717         /// We have sent `funding_created` and are awaiting a `funding_signed` to advance to
718         /// `AwaitingChannelReady`. Note that this is nonsense for an inbound channel as we immediately generate
719         /// `funding_signed` upon receipt of `funding_created`, so simply skip this state.
720         FundingNegotiated,
721         /// We've received/sent `funding_created` and `funding_signed` and are thus now waiting on the
722         /// funding transaction to confirm.
723         AwaitingChannelReady(AwaitingChannelReadyFlags),
724         /// Both we and our counterparty consider the funding transaction confirmed and the channel is
725         /// now operational.
726         ChannelReady(ChannelReadyFlags),
727         /// We've successfully negotiated a `closing_signed` dance. At this point, the `ChannelManager`
728         /// is about to drop us, but we store this anyway.
729         ShutdownComplete,
730 }
731
732 macro_rules! impl_state_flag {
733         ($get: ident, $set: ident, $clear: ident, [$($state: ident),+]) => {
734                 #[allow(unused)]
735                 fn $get(&self) -> bool {
736                         match self {
737                                 $(
738                                         ChannelState::$state(flags) => flags.$get(),
739                                 )*
740                                 _ => false,
741                         }
742                 }
743                 #[allow(unused)]
744                 fn $set(&mut self) {
745                         match self {
746                                 $(
747                                         ChannelState::$state(flags) => flags.$set(),
748                                 )*
749                                 _ => debug_assert!(false, "Attempted to set flag on unexpected ChannelState"),
750                         }
751                 }
752                 #[allow(unused)]
753                 fn $clear(&mut self) {
754                         match self {
755                                 $(
756                                         ChannelState::$state(flags) => { let _ = flags.$clear(); },
757                                 )*
758                                 _ => debug_assert!(false, "Attempted to clear flag on unexpected ChannelState"),
759                         }
760                 }
761         };
762         ($get: ident, $set: ident, $clear: ident, FUNDED_STATES) => {
763                 impl_state_flag!($get, $set, $clear, [AwaitingChannelReady, ChannelReady]);
764         };
765         ($get: ident, $set: ident, $clear: ident, $state: ident) => {
766                 impl_state_flag!($get, $set, $clear, [$state]);
767         };
768 }
769
770 impl ChannelState {
771         fn from_u32(state: u32) -> Result<Self, ()> {
772                 match state {
773                         state_flags::FUNDING_NEGOTIATED => Ok(ChannelState::FundingNegotiated),
774                         state_flags::SHUTDOWN_COMPLETE => Ok(ChannelState::ShutdownComplete),
775                         val => {
776                                 if val & state_flags::AWAITING_CHANNEL_READY == state_flags::AWAITING_CHANNEL_READY {
777                                         AwaitingChannelReadyFlags::from_u32(val & !state_flags::AWAITING_CHANNEL_READY)
778                                                 .map(|flags| ChannelState::AwaitingChannelReady(flags))
779                                 } else if val & state_flags::CHANNEL_READY == state_flags::CHANNEL_READY {
780                                         ChannelReadyFlags::from_u32(val & !state_flags::CHANNEL_READY)
781                                                 .map(|flags| ChannelState::ChannelReady(flags))
782                                 } else if let Ok(flags) = NegotiatingFundingFlags::from_u32(val) {
783                                         Ok(ChannelState::NegotiatingFunding(flags))
784                                 } else {
785                                         Err(())
786                                 }
787                         },
788                 }
789         }
790
791         fn to_u32(&self) -> u32 {
792                 match self {
793                         ChannelState::NegotiatingFunding(flags) => flags.0,
794                         ChannelState::FundingNegotiated => state_flags::FUNDING_NEGOTIATED,
795                         ChannelState::AwaitingChannelReady(flags) => state_flags::AWAITING_CHANNEL_READY | flags.0,
796                         ChannelState::ChannelReady(flags) => state_flags::CHANNEL_READY | flags.0,
797                         ChannelState::ShutdownComplete => state_flags::SHUTDOWN_COMPLETE,
798                 }
799         }
800
801         fn is_pre_funded_state(&self) -> bool {
802                 matches!(self, ChannelState::NegotiatingFunding(_)|ChannelState::FundingNegotiated)
803         }
804
805         fn is_both_sides_shutdown(&self) -> bool {
806                 self.is_local_shutdown_sent() && self.is_remote_shutdown_sent()
807         }
808
809         fn with_funded_state_flags_mask(&self) -> FundedStateFlags {
810                 match self {
811                         ChannelState::AwaitingChannelReady(flags) => FundedStateFlags((*flags & FundedStateFlags::ALL).0),
812                         ChannelState::ChannelReady(flags) => FundedStateFlags((*flags & FundedStateFlags::ALL).0),
813                         _ => FundedStateFlags::new(),
814                 }
815         }
816
817         fn can_generate_new_commitment(&self) -> bool {
818                 match self {
819                         ChannelState::ChannelReady(flags) =>
820                                 !flags.is_set(ChannelReadyFlags::AWAITING_REMOTE_REVOKE) &&
821                                         !flags.is_set(FundedStateFlags::MONITOR_UPDATE_IN_PROGRESS.into()) &&
822                                         !flags.is_set(FundedStateFlags::PEER_DISCONNECTED.into()),
823                         _ => {
824                                 debug_assert!(false, "Can only generate new commitment within ChannelReady");
825                                 false
826                         },
827                 }
828         }
829
830         impl_state_flag!(is_peer_disconnected, set_peer_disconnected, clear_peer_disconnected, FUNDED_STATES);
831         impl_state_flag!(is_monitor_update_in_progress, set_monitor_update_in_progress, clear_monitor_update_in_progress, FUNDED_STATES);
832         impl_state_flag!(is_local_shutdown_sent, set_local_shutdown_sent, clear_local_shutdown_sent, FUNDED_STATES);
833         impl_state_flag!(is_remote_shutdown_sent, set_remote_shutdown_sent, clear_remote_shutdown_sent, FUNDED_STATES);
834         impl_state_flag!(is_our_channel_ready, set_our_channel_ready, clear_our_channel_ready, AwaitingChannelReady);
835         impl_state_flag!(is_their_channel_ready, set_their_channel_ready, clear_their_channel_ready, AwaitingChannelReady);
836         impl_state_flag!(is_waiting_for_batch, set_waiting_for_batch, clear_waiting_for_batch, AwaitingChannelReady);
837         impl_state_flag!(is_awaiting_remote_revoke, set_awaiting_remote_revoke, clear_awaiting_remote_revoke, ChannelReady);
838 }
839
840 pub const INITIAL_COMMITMENT_NUMBER: u64 = (1 << 48) - 1;
841
842 pub const DEFAULT_MAX_HTLCS: u16 = 50;
843
844 pub(crate) fn commitment_tx_base_weight(channel_type_features: &ChannelTypeFeatures) -> u64 {
845         const COMMITMENT_TX_BASE_WEIGHT: u64 = 724;
846         const COMMITMENT_TX_BASE_ANCHOR_WEIGHT: u64 = 1124;
847         if channel_type_features.supports_anchors_zero_fee_htlc_tx() { COMMITMENT_TX_BASE_ANCHOR_WEIGHT } else { COMMITMENT_TX_BASE_WEIGHT }
848 }
849
850 #[cfg(not(test))]
851 const COMMITMENT_TX_WEIGHT_PER_HTLC: u64 = 172;
852 #[cfg(test)]
853 pub const COMMITMENT_TX_WEIGHT_PER_HTLC: u64 = 172;
854
855 pub const ANCHOR_OUTPUT_VALUE_SATOSHI: u64 = 330;
856
857 /// The percentage of the channel value `holder_max_htlc_value_in_flight_msat` used to be set to,
858 /// before this was made configurable. The percentage was made configurable in LDK 0.0.107,
859 /// although LDK 0.0.104+ enabled serialization of channels with a different value set for
860 /// `holder_max_htlc_value_in_flight_msat`.
861 pub const MAX_IN_FLIGHT_PERCENT_LEGACY: u8 = 10;
862
863 /// Maximum `funding_satoshis` value according to the BOLT #2 specification, if
864 /// `option_support_large_channel` (aka wumbo channels) is not supported.
865 /// It's 2^24 - 1.
866 pub const MAX_FUNDING_SATOSHIS_NO_WUMBO: u64 = (1 << 24) - 1;
867
868 /// Total bitcoin supply in satoshis.
869 pub const TOTAL_BITCOIN_SUPPLY_SATOSHIS: u64 = 21_000_000 * 1_0000_0000;
870
871 /// The maximum network dust limit for standard script formats. This currently represents the
872 /// minimum output value for a P2SH output before Bitcoin Core 22 considers the entire
873 /// transaction non-standard and thus refuses to relay it.
874 /// We also use this as the maximum counterparty `dust_limit_satoshis` allowed, given many
875 /// implementations use this value for their dust limit today.
876 pub const MAX_STD_OUTPUT_DUST_LIMIT_SATOSHIS: u64 = 546;
877
878 /// The maximum channel dust limit we will accept from our counterparty.
879 pub const MAX_CHAN_DUST_LIMIT_SATOSHIS: u64 = MAX_STD_OUTPUT_DUST_LIMIT_SATOSHIS;
880
881 /// The dust limit is used for both the commitment transaction outputs as well as the closing
882 /// transactions. For cooperative closing transactions, we require segwit outputs, though accept
883 /// *any* segwit scripts, which are allowed to be up to 42 bytes in length.
884 /// In order to avoid having to concern ourselves with standardness during the closing process, we
885 /// simply require our counterparty to use a dust limit which will leave any segwit output
886 /// standard.
887 /// See <https://github.com/lightning/bolts/issues/905> for more details.
888 pub const MIN_CHAN_DUST_LIMIT_SATOSHIS: u64 = 354;
889
890 // Just a reasonable implementation-specific safe lower bound, higher than the dust limit.
891 pub const MIN_THEIR_CHAN_RESERVE_SATOSHIS: u64 = 1000;
892
893 /// Used to return a simple Error back to ChannelManager. Will get converted to a
894 /// msgs::ErrorAction::SendErrorMessage or msgs::ErrorAction::IgnoreError as appropriate with our
895 /// channel_id in ChannelManager.
896 pub(super) enum ChannelError {
897         Ignore(String),
898         Warn(String),
899         Close(String),
900 }
901
902 impl fmt::Debug for ChannelError {
903         fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
904                 match self {
905                         &ChannelError::Ignore(ref e) => write!(f, "Ignore : {}", e),
906                         &ChannelError::Warn(ref e) => write!(f, "Warn : {}", e),
907                         &ChannelError::Close(ref e) => write!(f, "Close : {}", e),
908                 }
909         }
910 }
911
912 impl fmt::Display for ChannelError {
913         fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
914                 match self {
915                         &ChannelError::Ignore(ref e) => write!(f, "{}", e),
916                         &ChannelError::Warn(ref e) => write!(f, "{}", e),
917                         &ChannelError::Close(ref e) => write!(f, "{}", e),
918                 }
919         }
920 }
921
922 pub(super) struct WithChannelContext<'a, L: Deref> where L::Target: Logger {
923         pub logger: &'a L,
924         pub peer_id: Option<PublicKey>,
925         pub channel_id: Option<ChannelId>,
926         pub payment_hash: Option<PaymentHash>,
927 }
928
929 impl<'a, L: Deref> Logger for WithChannelContext<'a, L> where L::Target: Logger {
930         fn log(&self, mut record: Record) {
931                 record.peer_id = self.peer_id;
932                 record.channel_id = self.channel_id;
933                 record.payment_hash = self.payment_hash;
934                 self.logger.log(record)
935         }
936 }
937
938 impl<'a, 'b, L: Deref> WithChannelContext<'a, L>
939 where L::Target: Logger {
940         pub(super) fn from<S: Deref>(logger: &'a L, context: &'b ChannelContext<S>, payment_hash: Option<PaymentHash>) -> Self
941         where S::Target: SignerProvider
942         {
943                 WithChannelContext {
944                         logger,
945                         peer_id: Some(context.counterparty_node_id),
946                         channel_id: Some(context.channel_id),
947                         payment_hash
948                 }
949         }
950 }
951
952 macro_rules! secp_check {
953         ($res: expr, $err: expr) => {
954                 match $res {
955                         Ok(thing) => thing,
956                         Err(_) => return Err(ChannelError::Close($err)),
957                 }
958         };
959 }
960
961 /// The "channel disabled" bit in channel_update must be set based on whether we are connected to
962 /// our counterparty or not. However, we don't want to announce updates right away to avoid
963 /// spamming the network with updates if the connection is flapping. Instead, we "stage" updates to
964 /// our channel_update message and track the current state here.
965 /// See implementation at [`super::channelmanager::ChannelManager::timer_tick_occurred`].
966 #[derive(Clone, Copy, PartialEq)]
967 pub(super) enum ChannelUpdateStatus {
968         /// We've announced the channel as enabled and are connected to our peer.
969         Enabled,
970         /// Our channel is no longer live, but we haven't announced the channel as disabled yet.
971         DisabledStaged(u8),
972         /// Our channel is live again, but we haven't announced the channel as enabled yet.
973         EnabledStaged(u8),
974         /// We've announced the channel as disabled.
975         Disabled,
976 }
977
978 /// We track when we sent an `AnnouncementSignatures` to our peer in a few states, described here.
979 #[derive(PartialEq)]
980 pub enum AnnouncementSigsState {
981         /// We have not sent our peer an `AnnouncementSignatures` yet, or our peer disconnected since
982         /// we sent the last `AnnouncementSignatures`.
983         NotSent,
984         /// We sent an `AnnouncementSignatures` to our peer since the last time our peer disconnected.
985         /// This state never appears on disk - instead we write `NotSent`.
986         MessageSent,
987         /// We sent a `CommitmentSigned` after the last `AnnouncementSignatures` we sent. Because we
988         /// only ever have a single `CommitmentSigned` pending at once, if we sent one after sending
989         /// `AnnouncementSignatures` then we know the peer received our `AnnouncementSignatures` if
990         /// they send back a `RevokeAndACK`.
991         /// This state never appears on disk - instead we write `NotSent`.
992         Committed,
993         /// We received a `RevokeAndACK`, effectively ack-ing our `AnnouncementSignatures`, at this
994         /// point we no longer need to re-send our `AnnouncementSignatures` again on reconnect.
995         PeerReceived,
996 }
997
998 /// An enum indicating whether the local or remote side offered a given HTLC.
999 enum HTLCInitiator {
1000         LocalOffered,
1001         RemoteOffered,
1002 }
1003
1004 /// Current counts of various HTLCs, useful for calculating current balances available exactly.
1005 struct HTLCStats {
1006         pending_inbound_htlcs: usize,
1007         pending_outbound_htlcs: usize,
1008         pending_inbound_htlcs_value_msat: u64,
1009         pending_outbound_htlcs_value_msat: u64,
1010         on_counterparty_tx_dust_exposure_msat: u64,
1011         on_holder_tx_dust_exposure_msat: u64,
1012         outbound_holding_cell_msat: u64,
1013         on_holder_tx_outbound_holding_cell_htlcs_count: u32, // dust HTLCs *non*-included
1014 }
1015
1016 /// An enum gathering stats on commitment transaction, either local or remote.
1017 struct CommitmentStats<'a> {
1018         tx: CommitmentTransaction, // the transaction info
1019         feerate_per_kw: u32, // the feerate included to build the transaction
1020         total_fee_sat: u64, // the total fee included in the transaction
1021         num_nondust_htlcs: usize,  // the number of HTLC outputs (dust HTLCs *non*-included)
1022         htlcs_included: Vec<(HTLCOutputInCommitment, Option<&'a HTLCSource>)>, // the list of HTLCs (dust HTLCs *included*) which were not ignored when building the transaction
1023         local_balance_msat: u64, // local balance before fees *not* considering dust limits
1024         remote_balance_msat: u64, // remote balance before fees *not* considering dust limits
1025         outbound_htlc_preimages: Vec<PaymentPreimage>, // preimages for successful offered HTLCs since last commitment
1026         inbound_htlc_preimages: Vec<PaymentPreimage>, // preimages for successful received HTLCs since last commitment
1027 }
1028
1029 /// Used when calculating whether we or the remote can afford an additional HTLC.
1030 struct HTLCCandidate {
1031         amount_msat: u64,
1032         origin: HTLCInitiator,
1033 }
1034
1035 impl HTLCCandidate {
1036         fn new(amount_msat: u64, origin: HTLCInitiator) -> Self {
1037                 Self {
1038                         amount_msat,
1039                         origin,
1040                 }
1041         }
1042 }
1043
1044 /// A return value enum for get_update_fulfill_htlc. See UpdateFulfillCommitFetch variants for
1045 /// description
1046 enum UpdateFulfillFetch {
1047         NewClaim {
1048                 monitor_update: ChannelMonitorUpdate,
1049                 htlc_value_msat: u64,
1050                 msg: Option<msgs::UpdateFulfillHTLC>,
1051         },
1052         DuplicateClaim {},
1053 }
1054
1055 /// The return type of get_update_fulfill_htlc_and_commit.
1056 pub enum UpdateFulfillCommitFetch {
1057         /// Indicates the HTLC fulfill is new, and either generated an update_fulfill message, placed
1058         /// it in the holding cell, or re-generated the update_fulfill message after the same claim was
1059         /// previously placed in the holding cell (and has since been removed).
1060         NewClaim {
1061                 /// The ChannelMonitorUpdate which places the new payment preimage in the channel monitor
1062                 monitor_update: ChannelMonitorUpdate,
1063                 /// The value of the HTLC which was claimed, in msat.
1064                 htlc_value_msat: u64,
1065         },
1066         /// Indicates the HTLC fulfill is duplicative and already existed either in the holding cell
1067         /// or has been forgotten (presumably previously claimed).
1068         DuplicateClaim {},
1069 }
1070
1071 /// The return value of `monitor_updating_restored`
1072 pub(super) struct MonitorRestoreUpdates {
1073         pub raa: Option<msgs::RevokeAndACK>,
1074         pub commitment_update: Option<msgs::CommitmentUpdate>,
1075         pub order: RAACommitmentOrder,
1076         pub accepted_htlcs: Vec<(PendingHTLCInfo, u64)>,
1077         pub failed_htlcs: Vec<(HTLCSource, PaymentHash, HTLCFailReason)>,
1078         pub finalized_claimed_htlcs: Vec<HTLCSource>,
1079         pub pending_update_adds: Vec<msgs::UpdateAddHTLC>,
1080         pub funding_broadcastable: Option<Transaction>,
1081         pub channel_ready: Option<msgs::ChannelReady>,
1082         pub announcement_sigs: Option<msgs::AnnouncementSignatures>,
1083 }
1084
1085 /// The return value of `signer_maybe_unblocked`
1086 #[allow(unused)]
1087 pub(super) struct SignerResumeUpdates {
1088         pub commitment_update: Option<msgs::CommitmentUpdate>,
1089         pub funding_signed: Option<msgs::FundingSigned>,
1090         pub channel_ready: Option<msgs::ChannelReady>,
1091 }
1092
1093 /// The return value of `channel_reestablish`
1094 pub(super) struct ReestablishResponses {
1095         pub channel_ready: Option<msgs::ChannelReady>,
1096         pub raa: Option<msgs::RevokeAndACK>,
1097         pub commitment_update: Option<msgs::CommitmentUpdate>,
1098         pub order: RAACommitmentOrder,
1099         pub announcement_sigs: Option<msgs::AnnouncementSignatures>,
1100         pub shutdown_msg: Option<msgs::Shutdown>,
1101 }
1102
1103 /// The result of a shutdown that should be handled.
1104 #[must_use]
1105 pub(crate) struct ShutdownResult {
1106         pub(crate) closure_reason: ClosureReason,
1107         /// A channel monitor update to apply.
1108         pub(crate) monitor_update: Option<(PublicKey, OutPoint, ChannelId, ChannelMonitorUpdate)>,
1109         /// A list of dropped outbound HTLCs that can safely be failed backwards immediately.
1110         pub(crate) dropped_outbound_htlcs: Vec<(HTLCSource, PaymentHash, PublicKey, ChannelId)>,
1111         /// An unbroadcasted batch funding transaction id. The closure of this channel should be
1112         /// propagated to the remainder of the batch.
1113         pub(crate) unbroadcasted_batch_funding_txid: Option<Txid>,
1114         pub(crate) channel_id: ChannelId,
1115         pub(crate) user_channel_id: u128,
1116         pub(crate) channel_capacity_satoshis: u64,
1117         pub(crate) counterparty_node_id: PublicKey,
1118         pub(crate) unbroadcasted_funding_tx: Option<Transaction>,
1119         pub(crate) channel_funding_txo: Option<OutPoint>,
1120 }
1121
1122 /// If the majority of the channels funds are to the fundee and the initiator holds only just
1123 /// enough funds to cover their reserve value, channels are at risk of getting "stuck". Because the
1124 /// initiator controls the feerate, if they then go to increase the channel fee, they may have no
1125 /// balance but the fundee is unable to send a payment as the increase in fee more than drains
1126 /// their reserve value. Thus, neither side can send a new HTLC and the channel becomes useless.
1127 /// Thus, before sending an HTLC when we are the initiator, we check that the feerate can increase
1128 /// by this multiple without hitting this case, before sending.
1129 /// This multiple is effectively the maximum feerate "jump" we expect until more HTLCs flow over
1130 /// the channel. Sadly, there isn't really a good number for this - if we expect to have no new
1131 /// HTLCs for days we may need this to suffice for feerate increases across days, but that may
1132 /// leave the channel less usable as we hold a bigger reserve.
1133 #[cfg(any(fuzzing, test))]
1134 pub const FEE_SPIKE_BUFFER_FEE_INCREASE_MULTIPLE: u64 = 2;
1135 #[cfg(not(any(fuzzing, test)))]
1136 const FEE_SPIKE_BUFFER_FEE_INCREASE_MULTIPLE: u64 = 2;
1137
1138 /// If we fail to see a funding transaction confirmed on-chain within this many blocks after the
1139 /// channel creation on an inbound channel, we simply force-close and move on.
1140 /// This constant is the one suggested in BOLT 2.
1141 pub(crate) const FUNDING_CONF_DEADLINE_BLOCKS: u32 = 2016;
1142
1143 /// In case of a concurrent update_add_htlc proposed by our counterparty, we might
1144 /// not have enough balance value remaining to cover the onchain cost of this new
1145 /// HTLC weight. If this happens, our counterparty fails the reception of our
1146 /// commitment_signed including this new HTLC due to infringement on the channel
1147 /// reserve.
1148 /// To prevent this case, we compute our outbound update_fee with an HTLC buffer of
1149 /// size 2. However, if the number of concurrent update_add_htlc is higher, this still
1150 /// leads to a channel force-close. Ultimately, this is an issue coming from the
1151 /// design of LN state machines, allowing asynchronous updates.
1152 pub(crate) const CONCURRENT_INBOUND_HTLC_FEE_BUFFER: u32 = 2;
1153
1154 /// When a channel is opened, we check that the funding amount is enough to pay for relevant
1155 /// commitment transaction fees, with at least this many HTLCs present on the commitment
1156 /// transaction (not counting the value of the HTLCs themselves).
1157 pub(crate) const MIN_AFFORDABLE_HTLC_COUNT: usize = 4;
1158
1159 /// When a [`Channel`] has its [`ChannelConfig`] updated, its existing one is stashed for up to this
1160 /// number of ticks to allow forwarding HTLCs by nodes that have yet to receive the new
1161 /// ChannelUpdate prompted by the config update. This value was determined as follows:
1162 ///
1163 ///   * The expected interval between ticks (1 minute).
1164 ///   * The average convergence delay of updates across the network, i.e., ~300 seconds on average
1165 ///      for a node to see an update as seen on `<https://arxiv.org/pdf/2205.12737.pdf>`.
1166 ///   * `EXPIRE_PREV_CONFIG_TICKS` = convergence_delay / tick_interval
1167 pub(crate) const EXPIRE_PREV_CONFIG_TICKS: usize = 5;
1168
1169 /// The number of ticks that may elapse while we're waiting for a response to a
1170 /// [`msgs::RevokeAndACK`] or [`msgs::ChannelReestablish`] message before we attempt to disconnect
1171 /// them.
1172 ///
1173 /// See [`ChannelContext::sent_message_awaiting_response`] for more information.
1174 pub(crate) const DISCONNECT_PEER_AWAITING_RESPONSE_TICKS: usize = 2;
1175
1176 /// The number of ticks that may elapse while we're waiting for an unfunded outbound/inbound channel
1177 /// to be promoted to a [`Channel`] since the unfunded channel was created. An unfunded channel
1178 /// exceeding this age limit will be force-closed and purged from memory.
1179 pub(crate) const UNFUNDED_CHANNEL_AGE_LIMIT_TICKS: usize = 60;
1180
1181 /// Number of blocks needed for an output from a coinbase transaction to be spendable.
1182 pub(crate) const COINBASE_MATURITY: u32 = 100;
1183
1184 struct PendingChannelMonitorUpdate {
1185         update: ChannelMonitorUpdate,
1186 }
1187
1188 impl_writeable_tlv_based!(PendingChannelMonitorUpdate, {
1189         (0, update, required),
1190 });
1191
1192 /// The `ChannelPhase` enum describes the current phase in life of a lightning channel with each of
1193 /// its variants containing an appropriate channel struct.
1194 pub(super) enum ChannelPhase<SP: Deref> where SP::Target: SignerProvider {
1195         UnfundedOutboundV1(OutboundV1Channel<SP>),
1196         UnfundedInboundV1(InboundV1Channel<SP>),
1197         #[cfg(any(dual_funding, splicing))]
1198         UnfundedOutboundV2(OutboundV2Channel<SP>),
1199         #[cfg(any(dual_funding, splicing))]
1200         UnfundedInboundV2(InboundV2Channel<SP>),
1201         Funded(Channel<SP>),
1202 }
1203
1204 impl<'a, SP: Deref> ChannelPhase<SP> where
1205         SP::Target: SignerProvider,
1206         <SP::Target as SignerProvider>::EcdsaSigner: ChannelSigner,
1207 {
1208         pub fn context(&'a self) -> &'a ChannelContext<SP> {
1209                 match self {
1210                         ChannelPhase::Funded(chan) => &chan.context,
1211                         ChannelPhase::UnfundedOutboundV1(chan) => &chan.context,
1212                         ChannelPhase::UnfundedInboundV1(chan) => &chan.context,
1213                         #[cfg(any(dual_funding, splicing))]
1214                         ChannelPhase::UnfundedOutboundV2(chan) => &chan.context,
1215                         #[cfg(any(dual_funding, splicing))]
1216                         ChannelPhase::UnfundedInboundV2(chan) => &chan.context,
1217                 }
1218         }
1219
1220         pub fn context_mut(&'a mut self) -> &'a mut ChannelContext<SP> {
1221                 match self {
1222                         ChannelPhase::Funded(ref mut chan) => &mut chan.context,
1223                         ChannelPhase::UnfundedOutboundV1(ref mut chan) => &mut chan.context,
1224                         ChannelPhase::UnfundedInboundV1(ref mut chan) => &mut chan.context,
1225                         #[cfg(any(dual_funding, splicing))]
1226                         ChannelPhase::UnfundedOutboundV2(ref mut chan) => &mut chan.context,
1227                         #[cfg(any(dual_funding, splicing))]
1228                         ChannelPhase::UnfundedInboundV2(ref mut chan) => &mut chan.context,
1229                 }
1230         }
1231 }
1232
1233 /// Contains all state common to unfunded inbound/outbound channels.
1234 pub(super) struct UnfundedChannelContext {
1235         /// A counter tracking how many ticks have elapsed since this unfunded channel was
1236         /// created. If this unfunded channel reaches peer has yet to respond after reaching
1237         /// `UNFUNDED_CHANNEL_AGE_LIMIT_TICKS`, it will be force-closed and purged from memory.
1238         ///
1239         /// This is so that we don't keep channels around that haven't progressed to a funded state
1240         /// in a timely manner.
1241         unfunded_channel_age_ticks: usize,
1242 }
1243
1244 impl UnfundedChannelContext {
1245         /// Determines whether we should force-close and purge this unfunded channel from memory due to it
1246         /// having reached the unfunded channel age limit.
1247         ///
1248         /// This should be called on every [`super::channelmanager::ChannelManager::timer_tick_occurred`].
1249         pub fn should_expire_unfunded_channel(&mut self) -> bool {
1250                 self.unfunded_channel_age_ticks += 1;
1251                 self.unfunded_channel_age_ticks >= UNFUNDED_CHANNEL_AGE_LIMIT_TICKS
1252         }
1253 }
1254
1255 /// Contains everything about the channel including state, and various flags.
1256 pub(super) struct ChannelContext<SP: Deref> where SP::Target: SignerProvider {
1257         config: LegacyChannelConfig,
1258
1259         // Track the previous `ChannelConfig` so that we can continue forwarding HTLCs that were
1260         // constructed using it. The second element in the tuple corresponds to the number of ticks that
1261         // have elapsed since the update occurred.
1262         prev_config: Option<(ChannelConfig, usize)>,
1263
1264         inbound_handshake_limits_override: Option<ChannelHandshakeLimits>,
1265
1266         user_id: u128,
1267
1268         /// The current channel ID.
1269         channel_id: ChannelId,
1270         /// The temporary channel ID used during channel setup. Value kept even after transitioning to a final channel ID.
1271         /// Will be `None` for channels created prior to 0.0.115.
1272         temporary_channel_id: Option<ChannelId>,
1273         channel_state: ChannelState,
1274
1275         // When we reach max(6 blocks, minimum_depth), we need to send an AnnouncementSigs message to
1276         // our peer. However, we want to make sure they received it, or else rebroadcast it when we
1277         // next connect.
1278         // We do so here, see `AnnouncementSigsSent` for more details on the state(s).
1279         // Note that a number of our tests were written prior to the behavior here which retransmits
1280         // AnnouncementSignatures until after an RAA completes, so the behavior is short-circuited in
1281         // many tests.
1282         #[cfg(any(test, feature = "_test_utils"))]
1283         pub(crate) announcement_sigs_state: AnnouncementSigsState,
1284         #[cfg(not(any(test, feature = "_test_utils")))]
1285         announcement_sigs_state: AnnouncementSigsState,
1286
1287         secp_ctx: Secp256k1<secp256k1::All>,
1288         channel_value_satoshis: u64,
1289
1290         latest_monitor_update_id: u64,
1291
1292         holder_signer: ChannelSignerType<SP>,
1293         shutdown_scriptpubkey: Option<ShutdownScript>,
1294         destination_script: ScriptBuf,
1295
1296         // Our commitment numbers start at 2^48-1 and count down, whereas the ones used in transaction
1297         // generation start at 0 and count up...this simplifies some parts of implementation at the
1298         // cost of others, but should really just be changed.
1299
1300         cur_holder_commitment_transaction_number: u64,
1301         cur_counterparty_commitment_transaction_number: u64,
1302         value_to_self_msat: u64, // Excluding all pending_htlcs, fees, and anchor outputs
1303         pending_inbound_htlcs: Vec<InboundHTLCOutput>,
1304         pending_outbound_htlcs: Vec<OutboundHTLCOutput>,
1305         holding_cell_htlc_updates: Vec<HTLCUpdateAwaitingACK>,
1306
1307         /// When resending CS/RAA messages on channel monitor restoration or on reconnect, we always
1308         /// need to ensure we resend them in the order we originally generated them. Note that because
1309         /// there can only ever be one in-flight CS and/or one in-flight RAA at any time, it is
1310         /// sufficient to simply set this to the opposite of any message we are generating as we
1311         /// generate it. ie when we generate a CS, we set this to RAAFirst as, if there is a pending
1312         /// in-flight RAA to resend, it will have been the first thing we generated, and thus we should
1313         /// send it first.
1314         resend_order: RAACommitmentOrder,
1315
1316         monitor_pending_channel_ready: bool,
1317         monitor_pending_revoke_and_ack: bool,
1318         monitor_pending_commitment_signed: bool,
1319
1320         // TODO: If a channel is drop'd, we don't know whether the `ChannelMonitor` is ultimately
1321         // responsible for some of the HTLCs here or not - we don't know whether the update in question
1322         // completed or not. We currently ignore these fields entirely when force-closing a channel,
1323         // but need to handle this somehow or we run the risk of losing HTLCs!
1324         monitor_pending_forwards: Vec<(PendingHTLCInfo, u64)>,
1325         monitor_pending_failures: Vec<(HTLCSource, PaymentHash, HTLCFailReason)>,
1326         monitor_pending_finalized_fulfills: Vec<HTLCSource>,
1327         monitor_pending_update_adds: Vec<msgs::UpdateAddHTLC>,
1328
1329         /// If we went to send a commitment update (ie some messages then [`msgs::CommitmentSigned`])
1330         /// but our signer (initially) refused to give us a signature, we should retry at some point in
1331         /// the future when the signer indicates it may have a signature for us.
1332         ///
1333         /// This flag is set in such a case. Note that we don't need to persist this as we'll end up
1334         /// setting it again as a side-effect of [`Channel::channel_reestablish`].
1335         signer_pending_commitment_update: bool,
1336         /// Similar to [`Self::signer_pending_commitment_update`] but we're waiting to send either a
1337         /// [`msgs::FundingCreated`] or [`msgs::FundingSigned`] depending on if this channel is
1338         /// outbound or inbound.
1339         signer_pending_funding: bool,
1340
1341         // pending_update_fee is filled when sending and receiving update_fee.
1342         //
1343         // Because it follows the same commitment flow as HTLCs, `FeeUpdateState` is either `Outbound`
1344         // or matches a subset of the `InboundHTLCOutput` variants. It is then updated/used when
1345         // generating new commitment transactions with exactly the same criteria as inbound/outbound
1346         // HTLCs with similar state.
1347         pending_update_fee: Option<(u32, FeeUpdateState)>,
1348         // If a `send_update_fee()` call is made with ChannelState::AwaitingRemoteRevoke set, we place
1349         // it here instead of `pending_update_fee` in the same way as we place outbound HTLC updates in
1350         // `holding_cell_htlc_updates` instead of `pending_outbound_htlcs`. It is released into
1351         // `pending_update_fee` with the same criteria as outbound HTLC updates but can be updated by
1352         // further `send_update_fee` calls, dropping the previous holding cell update entirely.
1353         holding_cell_update_fee: Option<u32>,
1354         next_holder_htlc_id: u64,
1355         next_counterparty_htlc_id: u64,
1356         feerate_per_kw: u32,
1357
1358         /// The timestamp set on our latest `channel_update` message for this channel. It is updated
1359         /// when the channel is updated in ways which may impact the `channel_update` message or when a
1360         /// new block is received, ensuring it's always at least moderately close to the current real
1361         /// time.
1362         update_time_counter: u32,
1363
1364         #[cfg(debug_assertions)]
1365         /// Max to_local and to_remote outputs in a locally-generated commitment transaction
1366         holder_max_commitment_tx_output: Mutex<(u64, u64)>,
1367         #[cfg(debug_assertions)]
1368         /// Max to_local and to_remote outputs in a remote-generated commitment transaction
1369         counterparty_max_commitment_tx_output: Mutex<(u64, u64)>,
1370
1371         last_sent_closing_fee: Option<(u64, Signature)>, // (fee, holder_sig)
1372         target_closing_feerate_sats_per_kw: Option<u32>,
1373
1374         /// If our counterparty sent us a closing_signed while we were waiting for a `ChannelMonitor`
1375         /// update, we need to delay processing it until later. We do that here by simply storing the
1376         /// closing_signed message and handling it in `maybe_propose_closing_signed`.
1377         pending_counterparty_closing_signed: Option<msgs::ClosingSigned>,
1378
1379         /// The minimum and maximum absolute fee, in satoshis, we are willing to place on the closing
1380         /// transaction. These are set once we reach `closing_negotiation_ready`.
1381         #[cfg(test)]
1382         pub(crate) closing_fee_limits: Option<(u64, u64)>,
1383         #[cfg(not(test))]
1384         closing_fee_limits: Option<(u64, u64)>,
1385
1386         /// If we remove an HTLC (or fee update), commit, and receive our counterparty's
1387         /// `revoke_and_ack`, we remove all knowledge of said HTLC (or fee update). However, the latest
1388         /// local commitment transaction that we can broadcast still contains the HTLC (or old fee)
1389         /// until we receive a further `commitment_signed`. Thus we are not eligible for initiating the
1390         /// `closing_signed` negotiation if we're expecting a counterparty `commitment_signed`.
1391         ///
1392         /// To ensure we don't send a `closing_signed` too early, we track this state here, waiting
1393         /// until we see a `commitment_signed` before doing so.
1394         ///
1395         /// We don't bother to persist this - we anticipate this state won't last longer than a few
1396         /// milliseconds, so any accidental force-closes here should be exceedingly rare.
1397         expecting_peer_commitment_signed: bool,
1398
1399         /// The hash of the block in which the funding transaction was included.
1400         funding_tx_confirmed_in: Option<BlockHash>,
1401         funding_tx_confirmation_height: u32,
1402         short_channel_id: Option<u64>,
1403         /// Either the height at which this channel was created or the height at which it was last
1404         /// serialized if it was serialized by versions prior to 0.0.103.
1405         /// We use this to close if funding is never broadcasted.
1406         channel_creation_height: u32,
1407
1408         counterparty_dust_limit_satoshis: u64,
1409
1410         #[cfg(test)]
1411         pub(super) holder_dust_limit_satoshis: u64,
1412         #[cfg(not(test))]
1413         holder_dust_limit_satoshis: u64,
1414
1415         #[cfg(test)]
1416         pub(super) counterparty_max_htlc_value_in_flight_msat: u64,
1417         #[cfg(not(test))]
1418         counterparty_max_htlc_value_in_flight_msat: u64,
1419
1420         #[cfg(test)]
1421         pub(super) holder_max_htlc_value_in_flight_msat: u64,
1422         #[cfg(not(test))]
1423         holder_max_htlc_value_in_flight_msat: u64,
1424
1425         /// minimum channel reserve for self to maintain - set by them.
1426         counterparty_selected_channel_reserve_satoshis: Option<u64>,
1427
1428         #[cfg(test)]
1429         pub(super) holder_selected_channel_reserve_satoshis: u64,
1430         #[cfg(not(test))]
1431         holder_selected_channel_reserve_satoshis: u64,
1432
1433         counterparty_htlc_minimum_msat: u64,
1434         holder_htlc_minimum_msat: u64,
1435         #[cfg(test)]
1436         pub counterparty_max_accepted_htlcs: u16,
1437         #[cfg(not(test))]
1438         counterparty_max_accepted_htlcs: u16,
1439         holder_max_accepted_htlcs: u16,
1440         minimum_depth: Option<u32>,
1441
1442         counterparty_forwarding_info: Option<CounterpartyForwardingInfo>,
1443
1444         pub(crate) channel_transaction_parameters: ChannelTransactionParameters,
1445         funding_transaction: Option<Transaction>,
1446         is_batch_funding: Option<()>,
1447
1448         counterparty_cur_commitment_point: Option<PublicKey>,
1449         counterparty_prev_commitment_point: Option<PublicKey>,
1450         counterparty_node_id: PublicKey,
1451
1452         counterparty_shutdown_scriptpubkey: Option<ScriptBuf>,
1453
1454         commitment_secrets: CounterpartyCommitmentSecrets,
1455
1456         channel_update_status: ChannelUpdateStatus,
1457         /// Once we reach `closing_negotiation_ready`, we set this, indicating if closing_signed does
1458         /// not complete within a single timer tick (one minute), we should force-close the channel.
1459         /// This prevents us from keeping unusable channels around forever if our counterparty wishes
1460         /// to DoS us.
1461         /// Note that this field is reset to false on deserialization to give us a chance to connect to
1462         /// our peer and start the closing_signed negotiation fresh.
1463         closing_signed_in_flight: bool,
1464
1465         /// Our counterparty's channel_announcement signatures provided in announcement_signatures.
1466         /// This can be used to rebroadcast the channel_announcement message later.
1467         announcement_sigs: Option<(Signature, Signature)>,
1468
1469         // We save these values so we can make sure `next_local_commit_tx_fee_msat` and
1470         // `next_remote_commit_tx_fee_msat` properly predict what the next commitment transaction fee will
1471         // be, by comparing the cached values to the fee of the tranaction generated by
1472         // `build_commitment_transaction`.
1473         #[cfg(any(test, fuzzing))]
1474         next_local_commitment_tx_fee_info_cached: Mutex<Option<CommitmentTxInfoCached>>,
1475         #[cfg(any(test, fuzzing))]
1476         next_remote_commitment_tx_fee_info_cached: Mutex<Option<CommitmentTxInfoCached>>,
1477
1478         /// lnd has a long-standing bug where, upon reconnection, if the channel is not yet confirmed
1479         /// they will not send a channel_reestablish until the channel locks in. Then, they will send a
1480         /// channel_ready *before* sending the channel_reestablish (which is clearly a violation of
1481         /// the BOLT specs). We copy c-lightning's workaround here and simply store the channel_ready
1482         /// message until we receive a channel_reestablish.
1483         ///
1484         /// See-also <https://github.com/lightningnetwork/lnd/issues/4006>
1485         pub workaround_lnd_bug_4006: Option<msgs::ChannelReady>,
1486
1487         /// An option set when we wish to track how many ticks have elapsed while waiting for a response
1488         /// from our counterparty after sending a message. If the peer has yet to respond after reaching
1489         /// `DISCONNECT_PEER_AWAITING_RESPONSE_TICKS`, a reconnection should be attempted to try to
1490         /// unblock the state machine.
1491         ///
1492         /// This behavior is mostly motivated by a lnd bug in which we don't receive a message we expect
1493         /// to in a timely manner, which may lead to channels becoming unusable and/or force-closed. An
1494         /// example of such can be found at <https://github.com/lightningnetwork/lnd/issues/7682>.
1495         ///
1496         /// This is currently only used when waiting for a [`msgs::ChannelReestablish`] or
1497         /// [`msgs::RevokeAndACK`] message from the counterparty.
1498         sent_message_awaiting_response: Option<usize>,
1499
1500         #[cfg(any(test, fuzzing))]
1501         // When we receive an HTLC fulfill on an outbound path, we may immediately fulfill the
1502         // corresponding HTLC on the inbound path. If, then, the outbound path channel is
1503         // disconnected and reconnected (before we've exchange commitment_signed and revoke_and_ack
1504         // messages), they may re-broadcast their update_fulfill_htlc, causing a duplicate claim. This
1505         // is fine, but as a sanity check in our failure to generate the second claim, we check here
1506         // that the original was a claim, and that we aren't now trying to fulfill a failed HTLC.
1507         historical_inbound_htlc_fulfills: HashSet<u64>,
1508
1509         /// This channel's type, as negotiated during channel open
1510         channel_type: ChannelTypeFeatures,
1511
1512         // Our counterparty can offer us SCID aliases which they will map to this channel when routing
1513         // outbound payments. These can be used in invoice route hints to avoid explicitly revealing
1514         // the channel's funding UTXO.
1515         //
1516         // We also use this when sending our peer a channel_update that isn't to be broadcasted
1517         // publicly - allowing them to re-use their map of SCID -> channel for channel_update ->
1518         // associated channel mapping.
1519         //
1520         // We only bother storing the most recent SCID alias at any time, though our counterparty has
1521         // to store all of them.
1522         latest_inbound_scid_alias: Option<u64>,
1523
1524         // We always offer our counterparty a static SCID alias, which we recognize as for this channel
1525         // if we see it in HTLC forwarding instructions. We don't bother rotating the alias given we
1526         // don't currently support node id aliases and eventually privacy should be provided with
1527         // blinded paths instead of simple scid+node_id aliases.
1528         outbound_scid_alias: u64,
1529
1530         // We track whether we already emitted a `ChannelPending` event.
1531         channel_pending_event_emitted: bool,
1532
1533         // We track whether we already emitted a `ChannelReady` event.
1534         channel_ready_event_emitted: bool,
1535
1536         /// Some if we initiated to shut down the channel.
1537         local_initiated_shutdown: Option<()>,
1538
1539         /// The unique identifier used to re-derive the private key material for the channel through
1540         /// [`SignerProvider::derive_channel_signer`].
1541         #[cfg(not(test))]
1542         channel_keys_id: [u8; 32],
1543         #[cfg(test)]
1544         pub channel_keys_id: [u8; 32],
1545
1546         /// If we can't release a [`ChannelMonitorUpdate`] until some external action completes, we
1547         /// store it here and only release it to the `ChannelManager` once it asks for it.
1548         blocked_monitor_updates: Vec<PendingChannelMonitorUpdate>,
1549 }
1550
1551 impl<SP: Deref> ChannelContext<SP> where SP::Target: SignerProvider  {
1552         fn new_for_inbound_channel<'a, ES: Deref, F: Deref, L: Deref>(
1553                 fee_estimator: &'a LowerBoundedFeeEstimator<F>,
1554                 entropy_source: &'a ES,
1555                 signer_provider: &'a SP,
1556                 counterparty_node_id: PublicKey,
1557                 their_features: &'a InitFeatures,
1558                 user_id: u128,
1559                 config: &'a UserConfig,
1560                 current_chain_height: u32,
1561                 logger: &'a L,
1562                 is_0conf: bool,
1563                 our_funding_satoshis: u64,
1564                 counterparty_pubkeys: ChannelPublicKeys,
1565                 channel_type: ChannelTypeFeatures,
1566                 holder_selected_channel_reserve_satoshis: u64,
1567                 msg_channel_reserve_satoshis: u64,
1568                 msg_push_msat: u64,
1569                 open_channel_fields: msgs::CommonOpenChannelFields,
1570         ) -> Result<ChannelContext<SP>, ChannelError>
1571                 where
1572                         ES::Target: EntropySource,
1573                         F::Target: FeeEstimator,
1574                         L::Target: Logger,
1575                         SP::Target: SignerProvider,
1576         {
1577                 let logger = WithContext::from(logger, Some(counterparty_node_id), Some(open_channel_fields.temporary_channel_id), None);
1578                 let announced_channel = if (open_channel_fields.channel_flags & 1) == 1 { true } else { false };
1579
1580                 let channel_value_satoshis = our_funding_satoshis.saturating_add(open_channel_fields.funding_satoshis);
1581
1582                 let channel_keys_id = signer_provider.generate_channel_keys_id(true, channel_value_satoshis, user_id);
1583                 let holder_signer = signer_provider.derive_channel_signer(channel_value_satoshis, channel_keys_id);
1584                 let pubkeys = holder_signer.pubkeys().clone();
1585
1586                 if config.channel_handshake_config.our_to_self_delay < BREAKDOWN_TIMEOUT {
1587                         return Err(ChannelError::Close(format!("Configured with an unreasonable our_to_self_delay ({}) putting user funds at risks. It must be greater than {}", config.channel_handshake_config.our_to_self_delay, BREAKDOWN_TIMEOUT)));
1588                 }
1589
1590                 // Check sanity of message fields:
1591                 if channel_value_satoshis > config.channel_handshake_limits.max_funding_satoshis {
1592                         return Err(ChannelError::Close(format!(
1593                                 "Per our config, funding must be at most {}. It was {}. Peer contribution: {}. Our contribution: {}",
1594                                 config.channel_handshake_limits.max_funding_satoshis, channel_value_satoshis,
1595                                 open_channel_fields.funding_satoshis, our_funding_satoshis)));
1596                 }
1597                 if channel_value_satoshis >= TOTAL_BITCOIN_SUPPLY_SATOSHIS {
1598                         return Err(ChannelError::Close(format!("Funding must be smaller than the total bitcoin supply. It was {}", channel_value_satoshis)));
1599                 }
1600                 if msg_channel_reserve_satoshis > channel_value_satoshis {
1601                         return Err(ChannelError::Close(format!("Bogus channel_reserve_satoshis ({}). Must be no greater than channel_value_satoshis: {}", msg_channel_reserve_satoshis, channel_value_satoshis)));
1602                 }
1603                 let full_channel_value_msat = (channel_value_satoshis - msg_channel_reserve_satoshis) * 1000;
1604                 if msg_push_msat > full_channel_value_msat {
1605                         return Err(ChannelError::Close(format!("push_msat {} was larger than channel amount minus reserve ({})", msg_push_msat, full_channel_value_msat)));
1606                 }
1607                 if open_channel_fields.dust_limit_satoshis > channel_value_satoshis {
1608                         return Err(ChannelError::Close(format!("dust_limit_satoshis {} was larger than channel_value_satoshis {}. Peer never wants payout outputs?", open_channel_fields.dust_limit_satoshis, channel_value_satoshis)));
1609                 }
1610                 if open_channel_fields.htlc_minimum_msat >= full_channel_value_msat {
1611                         return Err(ChannelError::Close(format!("Minimum htlc value ({}) was larger than full channel value ({})", open_channel_fields.htlc_minimum_msat, full_channel_value_msat)));
1612                 }
1613                 Channel::<SP>::check_remote_fee(&channel_type, fee_estimator, open_channel_fields.commitment_feerate_sat_per_1000_weight, None, &&logger)?;
1614
1615                 let max_counterparty_selected_contest_delay = u16::min(config.channel_handshake_limits.their_to_self_delay, MAX_LOCAL_BREAKDOWN_TIMEOUT);
1616                 if open_channel_fields.to_self_delay > max_counterparty_selected_contest_delay {
1617                         return Err(ChannelError::Close(format!("They wanted our payments to be delayed by a needlessly long period. Upper limit: {}. Actual: {}", max_counterparty_selected_contest_delay, open_channel_fields.to_self_delay)));
1618                 }
1619                 if open_channel_fields.max_accepted_htlcs < 1 {
1620                         return Err(ChannelError::Close("0 max_accepted_htlcs makes for a useless channel".to_owned()));
1621                 }
1622                 if open_channel_fields.max_accepted_htlcs > MAX_HTLCS {
1623                         return Err(ChannelError::Close(format!("max_accepted_htlcs was {}. It must not be larger than {}", open_channel_fields.max_accepted_htlcs, MAX_HTLCS)));
1624                 }
1625
1626                 // Now check against optional parameters as set by config...
1627                 if channel_value_satoshis < config.channel_handshake_limits.min_funding_satoshis {
1628                         return Err(ChannelError::Close(format!("Funding satoshis ({}) is less than the user specified limit ({})", channel_value_satoshis, config.channel_handshake_limits.min_funding_satoshis)));
1629                 }
1630                 if open_channel_fields.htlc_minimum_msat > config.channel_handshake_limits.max_htlc_minimum_msat {
1631                         return Err(ChannelError::Close(format!("htlc_minimum_msat ({}) is higher than the user specified limit ({})", open_channel_fields.htlc_minimum_msat, config.channel_handshake_limits.max_htlc_minimum_msat)));
1632                 }
1633                 if open_channel_fields.max_htlc_value_in_flight_msat < config.channel_handshake_limits.min_max_htlc_value_in_flight_msat {
1634                         return Err(ChannelError::Close(format!("max_htlc_value_in_flight_msat ({}) is less than the user specified limit ({})", open_channel_fields.max_htlc_value_in_flight_msat, config.channel_handshake_limits.min_max_htlc_value_in_flight_msat)));
1635                 }
1636                 if msg_channel_reserve_satoshis > config.channel_handshake_limits.max_channel_reserve_satoshis {
1637                         return Err(ChannelError::Close(format!("channel_reserve_satoshis ({}) is higher than the user specified limit ({})", msg_channel_reserve_satoshis, config.channel_handshake_limits.max_channel_reserve_satoshis)));
1638                 }
1639                 if open_channel_fields.max_accepted_htlcs < config.channel_handshake_limits.min_max_accepted_htlcs {
1640                         return Err(ChannelError::Close(format!("max_accepted_htlcs ({}) is less than the user specified limit ({})", open_channel_fields.max_accepted_htlcs, config.channel_handshake_limits.min_max_accepted_htlcs)));
1641                 }
1642                 if open_channel_fields.dust_limit_satoshis < MIN_CHAN_DUST_LIMIT_SATOSHIS {
1643                         return Err(ChannelError::Close(format!("dust_limit_satoshis ({}) is less than the implementation limit ({})", open_channel_fields.dust_limit_satoshis, MIN_CHAN_DUST_LIMIT_SATOSHIS)));
1644                 }
1645                 if open_channel_fields.dust_limit_satoshis >  MAX_CHAN_DUST_LIMIT_SATOSHIS {
1646                         return Err(ChannelError::Close(format!("dust_limit_satoshis ({}) is greater than the implementation limit ({})", open_channel_fields.dust_limit_satoshis, MAX_CHAN_DUST_LIMIT_SATOSHIS)));
1647                 }
1648
1649                 // Convert things into internal flags and prep our state:
1650
1651                 if config.channel_handshake_limits.force_announced_channel_preference {
1652                         if config.channel_handshake_config.announced_channel != announced_channel {
1653                                 return Err(ChannelError::Close("Peer tried to open channel but their announcement preference is different from ours".to_owned()));
1654                         }
1655                 }
1656
1657                 if holder_selected_channel_reserve_satoshis < MIN_CHAN_DUST_LIMIT_SATOSHIS {
1658                         // Protocol level safety check in place, although it should never happen because
1659                         // of `MIN_THEIR_CHAN_RESERVE_SATOSHIS`
1660                         return Err(ChannelError::Close(format!("Suitable channel reserve not found. remote_channel_reserve was ({}). dust_limit_satoshis is ({}).", holder_selected_channel_reserve_satoshis, MIN_CHAN_DUST_LIMIT_SATOSHIS)));
1661                 }
1662                 if holder_selected_channel_reserve_satoshis * 1000 >= full_channel_value_msat {
1663                         return Err(ChannelError::Close(format!("Suitable channel reserve not found. remote_channel_reserve was ({})msats. Channel value is ({} - {})msats.", holder_selected_channel_reserve_satoshis * 1000, full_channel_value_msat, msg_push_msat)));
1664                 }
1665                 if msg_channel_reserve_satoshis < MIN_CHAN_DUST_LIMIT_SATOSHIS {
1666                         log_debug!(logger, "channel_reserve_satoshis ({}) is smaller than our dust limit ({}). We can broadcast stale states without any risk, implying this channel is very insecure for our counterparty.",
1667                                 msg_channel_reserve_satoshis, MIN_CHAN_DUST_LIMIT_SATOSHIS);
1668                 }
1669                 if holder_selected_channel_reserve_satoshis < open_channel_fields.dust_limit_satoshis {
1670                         return Err(ChannelError::Close(format!("Dust limit ({}) too high for the channel reserve we require the remote to keep ({})", open_channel_fields.dust_limit_satoshis, holder_selected_channel_reserve_satoshis)));
1671                 }
1672
1673                 // check if the funder's amount for the initial commitment tx is sufficient
1674                 // for full fee payment plus a few HTLCs to ensure the channel will be useful.
1675                 let anchor_outputs_value = if channel_type.supports_anchors_zero_fee_htlc_tx() {
1676                         ANCHOR_OUTPUT_VALUE_SATOSHI * 2
1677                 } else {
1678                         0
1679                 };
1680                 let funders_amount_msat = open_channel_fields.funding_satoshis * 1000 - msg_push_msat;
1681                 let commitment_tx_fee = commit_tx_fee_msat(open_channel_fields.commitment_feerate_sat_per_1000_weight, MIN_AFFORDABLE_HTLC_COUNT, &channel_type) / 1000;
1682                 if (funders_amount_msat / 1000).saturating_sub(anchor_outputs_value) < commitment_tx_fee {
1683                         return Err(ChannelError::Close(format!("Funding amount ({} sats) can't even pay fee for initial commitment transaction fee of {} sats.", (funders_amount_msat / 1000).saturating_sub(anchor_outputs_value), commitment_tx_fee)));
1684                 }
1685
1686                 let to_remote_satoshis = funders_amount_msat / 1000 - commitment_tx_fee - anchor_outputs_value;
1687                 // While it's reasonable for us to not meet the channel reserve initially (if they don't
1688                 // want to push much to us), our counterparty should always have more than our reserve.
1689                 if to_remote_satoshis < holder_selected_channel_reserve_satoshis {
1690                         return Err(ChannelError::Close("Insufficient funding amount for initial reserve".to_owned()));
1691                 }
1692
1693                 let counterparty_shutdown_scriptpubkey = if their_features.supports_upfront_shutdown_script() {
1694                         match &open_channel_fields.shutdown_scriptpubkey {
1695                                 &Some(ref script) => {
1696                                         // Peer is signaling upfront_shutdown and has opt-out with a 0-length script. We don't enforce anything
1697                                         if script.len() == 0 {
1698                                                 None
1699                                         } else {
1700                                                 if !script::is_bolt2_compliant(&script, their_features) {
1701                                                         return Err(ChannelError::Close(format!("Peer is signaling upfront_shutdown but has provided an unacceptable scriptpubkey format: {}", script)))
1702                                                 }
1703                                                 Some(script.clone())
1704                                         }
1705                                 },
1706                                 // Peer is signaling upfront shutdown but don't opt-out with correct mechanism (a.k.a 0-length script). Peer looks buggy, we fail the channel
1707                                 &None => {
1708                                         return Err(ChannelError::Close("Peer is signaling upfront_shutdown but we don't get any script. Use 0-length script to opt-out".to_owned()));
1709                                 }
1710                         }
1711                 } else { None };
1712
1713                 let shutdown_scriptpubkey = if config.channel_handshake_config.commit_upfront_shutdown_pubkey {
1714                         match signer_provider.get_shutdown_scriptpubkey() {
1715                                 Ok(scriptpubkey) => Some(scriptpubkey),
1716                                 Err(_) => return Err(ChannelError::Close("Failed to get upfront shutdown scriptpubkey".to_owned())),
1717                         }
1718                 } else { None };
1719
1720                 if let Some(shutdown_scriptpubkey) = &shutdown_scriptpubkey {
1721                         if !shutdown_scriptpubkey.is_compatible(&their_features) {
1722                                 return Err(ChannelError::Close(format!("Provided a scriptpubkey format not accepted by peer: {}", shutdown_scriptpubkey)));
1723                         }
1724                 }
1725
1726                 let destination_script = match signer_provider.get_destination_script(channel_keys_id) {
1727                         Ok(script) => script,
1728                         Err(_) => return Err(ChannelError::Close("Failed to get destination script".to_owned())),
1729                 };
1730
1731                 let mut secp_ctx = Secp256k1::new();
1732                 secp_ctx.seeded_randomize(&entropy_source.get_secure_random_bytes());
1733
1734                 let minimum_depth = if is_0conf {
1735                         Some(0)
1736                 } else {
1737                         Some(cmp::max(config.channel_handshake_config.minimum_depth, 1))
1738                 };
1739
1740                 let value_to_self_msat = our_funding_satoshis * 1000 + msg_push_msat;
1741
1742                 // TODO(dual_funding): Checks for `funding_feerate_sat_per_1000_weight`?
1743
1744                 let channel_context = ChannelContext {
1745                         user_id,
1746
1747                         config: LegacyChannelConfig {
1748                                 options: config.channel_config.clone(),
1749                                 announced_channel,
1750                                 commit_upfront_shutdown_pubkey: config.channel_handshake_config.commit_upfront_shutdown_pubkey,
1751                         },
1752
1753                         prev_config: None,
1754
1755                         inbound_handshake_limits_override: None,
1756
1757                         temporary_channel_id: Some(open_channel_fields.temporary_channel_id),
1758                         channel_id: open_channel_fields.temporary_channel_id,
1759                         channel_state: ChannelState::NegotiatingFunding(
1760                                 NegotiatingFundingFlags::OUR_INIT_SENT | NegotiatingFundingFlags::THEIR_INIT_SENT
1761                         ),
1762                         announcement_sigs_state: AnnouncementSigsState::NotSent,
1763                         secp_ctx,
1764
1765                         latest_monitor_update_id: 0,
1766
1767                         holder_signer: ChannelSignerType::Ecdsa(holder_signer),
1768                         shutdown_scriptpubkey,
1769                         destination_script,
1770
1771                         cur_holder_commitment_transaction_number: INITIAL_COMMITMENT_NUMBER,
1772                         cur_counterparty_commitment_transaction_number: INITIAL_COMMITMENT_NUMBER,
1773                         value_to_self_msat,
1774
1775                         pending_inbound_htlcs: Vec::new(),
1776                         pending_outbound_htlcs: Vec::new(),
1777                         holding_cell_htlc_updates: Vec::new(),
1778                         pending_update_fee: None,
1779                         holding_cell_update_fee: None,
1780                         next_holder_htlc_id: 0,
1781                         next_counterparty_htlc_id: 0,
1782                         update_time_counter: 1,
1783
1784                         resend_order: RAACommitmentOrder::CommitmentFirst,
1785
1786                         monitor_pending_channel_ready: false,
1787                         monitor_pending_revoke_and_ack: false,
1788                         monitor_pending_commitment_signed: false,
1789                         monitor_pending_forwards: Vec::new(),
1790                         monitor_pending_failures: Vec::new(),
1791                         monitor_pending_finalized_fulfills: Vec::new(),
1792                         monitor_pending_update_adds: Vec::new(),
1793
1794                         signer_pending_commitment_update: false,
1795                         signer_pending_funding: false,
1796
1797
1798                         #[cfg(debug_assertions)]
1799                         holder_max_commitment_tx_output: Mutex::new((value_to_self_msat, (channel_value_satoshis * 1000 - msg_push_msat).saturating_sub(value_to_self_msat))),
1800                         #[cfg(debug_assertions)]
1801                         counterparty_max_commitment_tx_output: Mutex::new((value_to_self_msat, (channel_value_satoshis * 1000 - msg_push_msat).saturating_sub(value_to_self_msat))),
1802
1803                         last_sent_closing_fee: None,
1804                         pending_counterparty_closing_signed: None,
1805                         expecting_peer_commitment_signed: false,
1806                         closing_fee_limits: None,
1807                         target_closing_feerate_sats_per_kw: None,
1808
1809                         funding_tx_confirmed_in: None,
1810                         funding_tx_confirmation_height: 0,
1811                         short_channel_id: None,
1812                         channel_creation_height: current_chain_height,
1813
1814                         feerate_per_kw: open_channel_fields.commitment_feerate_sat_per_1000_weight,
1815                         channel_value_satoshis,
1816                         counterparty_dust_limit_satoshis: open_channel_fields.dust_limit_satoshis,
1817                         holder_dust_limit_satoshis: MIN_CHAN_DUST_LIMIT_SATOSHIS,
1818                         counterparty_max_htlc_value_in_flight_msat: cmp::min(open_channel_fields.max_htlc_value_in_flight_msat, channel_value_satoshis * 1000),
1819                         holder_max_htlc_value_in_flight_msat: get_holder_max_htlc_value_in_flight_msat(channel_value_satoshis, &config.channel_handshake_config),
1820                         counterparty_selected_channel_reserve_satoshis: Some(msg_channel_reserve_satoshis),
1821                         holder_selected_channel_reserve_satoshis,
1822                         counterparty_htlc_minimum_msat: open_channel_fields.htlc_minimum_msat,
1823                         holder_htlc_minimum_msat: if config.channel_handshake_config.our_htlc_minimum_msat == 0 { 1 } else { config.channel_handshake_config.our_htlc_minimum_msat },
1824                         counterparty_max_accepted_htlcs: open_channel_fields.max_accepted_htlcs,
1825                         holder_max_accepted_htlcs: cmp::min(config.channel_handshake_config.our_max_accepted_htlcs, MAX_HTLCS),
1826                         minimum_depth,
1827
1828                         counterparty_forwarding_info: None,
1829
1830                         channel_transaction_parameters: ChannelTransactionParameters {
1831                                 holder_pubkeys: pubkeys,
1832                                 holder_selected_contest_delay: config.channel_handshake_config.our_to_self_delay,
1833                                 is_outbound_from_holder: false,
1834                                 counterparty_parameters: Some(CounterpartyChannelTransactionParameters {
1835                                         selected_contest_delay: open_channel_fields.to_self_delay,
1836                                         pubkeys: counterparty_pubkeys,
1837                                 }),
1838                                 funding_outpoint: None,
1839                                 channel_type_features: channel_type.clone()
1840                         },
1841                         funding_transaction: None,
1842                         is_batch_funding: None,
1843
1844                         counterparty_cur_commitment_point: Some(open_channel_fields.first_per_commitment_point),
1845                         counterparty_prev_commitment_point: None,
1846                         counterparty_node_id,
1847
1848                         counterparty_shutdown_scriptpubkey,
1849
1850                         commitment_secrets: CounterpartyCommitmentSecrets::new(),
1851
1852                         channel_update_status: ChannelUpdateStatus::Enabled,
1853                         closing_signed_in_flight: false,
1854
1855                         announcement_sigs: None,
1856
1857                         #[cfg(any(test, fuzzing))]
1858                         next_local_commitment_tx_fee_info_cached: Mutex::new(None),
1859                         #[cfg(any(test, fuzzing))]
1860                         next_remote_commitment_tx_fee_info_cached: Mutex::new(None),
1861
1862                         workaround_lnd_bug_4006: None,
1863                         sent_message_awaiting_response: None,
1864
1865                         latest_inbound_scid_alias: None,
1866                         outbound_scid_alias: 0,
1867
1868                         channel_pending_event_emitted: false,
1869                         channel_ready_event_emitted: false,
1870
1871                         #[cfg(any(test, fuzzing))]
1872                         historical_inbound_htlc_fulfills: new_hash_set(),
1873
1874                         channel_type,
1875                         channel_keys_id,
1876
1877                         local_initiated_shutdown: None,
1878
1879                         blocked_monitor_updates: Vec::new(),
1880                 };
1881
1882                 Ok(channel_context)
1883         }
1884
1885         fn new_for_outbound_channel<'a, ES: Deref, F: Deref>(
1886                 fee_estimator: &'a LowerBoundedFeeEstimator<F>,
1887                 entropy_source: &'a ES,
1888                 signer_provider: &'a SP,
1889                 counterparty_node_id: PublicKey,
1890                 their_features: &'a InitFeatures,
1891                 funding_satoshis: u64,
1892                 push_msat: u64,
1893                 user_id: u128,
1894                 config: &'a UserConfig,
1895                 current_chain_height: u32,
1896                 outbound_scid_alias: u64,
1897                 temporary_channel_id: Option<ChannelId>,
1898                 holder_selected_channel_reserve_satoshis: u64,
1899                 channel_keys_id: [u8; 32],
1900                 holder_signer: <SP::Target as SignerProvider>::EcdsaSigner,
1901                 pubkeys: ChannelPublicKeys,
1902         ) -> Result<ChannelContext<SP>, APIError>
1903                 where
1904                         ES::Target: EntropySource,
1905                         F::Target: FeeEstimator,
1906                         SP::Target: SignerProvider,
1907         {
1908                 // This will be updated with the counterparty contribution if this is a dual-funded channel
1909                 let channel_value_satoshis = funding_satoshis;
1910
1911                 let holder_selected_contest_delay = config.channel_handshake_config.our_to_self_delay;
1912
1913                 if !their_features.supports_wumbo() && channel_value_satoshis > MAX_FUNDING_SATOSHIS_NO_WUMBO {
1914                         return Err(APIError::APIMisuseError{err: format!("funding_value must not exceed {}, it was {}", MAX_FUNDING_SATOSHIS_NO_WUMBO, channel_value_satoshis)});
1915                 }
1916                 if channel_value_satoshis >= TOTAL_BITCOIN_SUPPLY_SATOSHIS {
1917                         return Err(APIError::APIMisuseError{err: format!("funding_value must be smaller than the total bitcoin supply, it was {}", channel_value_satoshis)});
1918                 }
1919                 let channel_value_msat = channel_value_satoshis * 1000;
1920                 if push_msat > channel_value_msat {
1921                         return Err(APIError::APIMisuseError { err: format!("Push value ({}) was larger than channel_value ({})", push_msat, channel_value_msat) });
1922                 }
1923                 if holder_selected_contest_delay < BREAKDOWN_TIMEOUT {
1924                         return Err(APIError::APIMisuseError {err: format!("Configured with an unreasonable our_to_self_delay ({}) putting user funds at risks", holder_selected_contest_delay)});
1925                 }
1926
1927                 let channel_type = get_initial_channel_type(&config, their_features);
1928                 debug_assert!(channel_type.is_subset(&channelmanager::provided_channel_type_features(&config)));
1929
1930                 let (commitment_conf_target, anchor_outputs_value_msat)  = if channel_type.supports_anchors_zero_fee_htlc_tx() {
1931                         (ConfirmationTarget::AnchorChannelFee, ANCHOR_OUTPUT_VALUE_SATOSHI * 2 * 1000)
1932                 } else {
1933                         (ConfirmationTarget::NonAnchorChannelFee, 0)
1934                 };
1935                 let commitment_feerate = fee_estimator.bounded_sat_per_1000_weight(commitment_conf_target);
1936
1937                 let value_to_self_msat = channel_value_satoshis * 1000 - push_msat;
1938                 let commitment_tx_fee = commit_tx_fee_msat(commitment_feerate, MIN_AFFORDABLE_HTLC_COUNT, &channel_type);
1939                 if value_to_self_msat.saturating_sub(anchor_outputs_value_msat) < commitment_tx_fee {
1940                         return Err(APIError::APIMisuseError{ err: format!("Funding amount ({}) can't even pay fee for initial commitment transaction fee of {}.", value_to_self_msat / 1000, commitment_tx_fee / 1000) });
1941                 }
1942
1943                 let mut secp_ctx = Secp256k1::new();
1944                 secp_ctx.seeded_randomize(&entropy_source.get_secure_random_bytes());
1945
1946                 let shutdown_scriptpubkey = if config.channel_handshake_config.commit_upfront_shutdown_pubkey {
1947                         match signer_provider.get_shutdown_scriptpubkey() {
1948                                 Ok(scriptpubkey) => Some(scriptpubkey),
1949                                 Err(_) => return Err(APIError::ChannelUnavailable { err: "Failed to get shutdown scriptpubkey".to_owned()}),
1950                         }
1951                 } else { None };
1952
1953                 if let Some(shutdown_scriptpubkey) = &shutdown_scriptpubkey {
1954                         if !shutdown_scriptpubkey.is_compatible(&their_features) {
1955                                 return Err(APIError::IncompatibleShutdownScript { script: shutdown_scriptpubkey.clone() });
1956                         }
1957                 }
1958
1959                 let destination_script = match signer_provider.get_destination_script(channel_keys_id) {
1960                         Ok(script) => script,
1961                         Err(_) => return Err(APIError::ChannelUnavailable { err: "Failed to get destination script".to_owned()}),
1962                 };
1963
1964                 let temporary_channel_id = temporary_channel_id.unwrap_or_else(|| ChannelId::temporary_from_entropy_source(entropy_source));
1965
1966                 Ok(Self {
1967                         user_id,
1968
1969                         config: LegacyChannelConfig {
1970                                 options: config.channel_config.clone(),
1971                                 announced_channel: config.channel_handshake_config.announced_channel,
1972                                 commit_upfront_shutdown_pubkey: config.channel_handshake_config.commit_upfront_shutdown_pubkey,
1973                         },
1974
1975                         prev_config: None,
1976
1977                         inbound_handshake_limits_override: Some(config.channel_handshake_limits.clone()),
1978
1979                         channel_id: temporary_channel_id,
1980                         temporary_channel_id: Some(temporary_channel_id),
1981                         channel_state: ChannelState::NegotiatingFunding(NegotiatingFundingFlags::OUR_INIT_SENT),
1982                         announcement_sigs_state: AnnouncementSigsState::NotSent,
1983                         secp_ctx,
1984                         // We'll add our counterparty's `funding_satoshis` when we receive `accept_channel2`.
1985                         channel_value_satoshis,
1986
1987                         latest_monitor_update_id: 0,
1988
1989                         holder_signer: ChannelSignerType::Ecdsa(holder_signer),
1990                         shutdown_scriptpubkey,
1991                         destination_script,
1992
1993                         cur_holder_commitment_transaction_number: INITIAL_COMMITMENT_NUMBER,
1994                         cur_counterparty_commitment_transaction_number: INITIAL_COMMITMENT_NUMBER,
1995                         value_to_self_msat,
1996
1997                         pending_inbound_htlcs: Vec::new(),
1998                         pending_outbound_htlcs: Vec::new(),
1999                         holding_cell_htlc_updates: Vec::new(),
2000                         pending_update_fee: None,
2001                         holding_cell_update_fee: None,
2002                         next_holder_htlc_id: 0,
2003                         next_counterparty_htlc_id: 0,
2004                         update_time_counter: 1,
2005
2006                         resend_order: RAACommitmentOrder::CommitmentFirst,
2007
2008                         monitor_pending_channel_ready: false,
2009                         monitor_pending_revoke_and_ack: false,
2010                         monitor_pending_commitment_signed: false,
2011                         monitor_pending_forwards: Vec::new(),
2012                         monitor_pending_failures: Vec::new(),
2013                         monitor_pending_finalized_fulfills: Vec::new(),
2014                         monitor_pending_update_adds: Vec::new(),
2015
2016                         signer_pending_commitment_update: false,
2017                         signer_pending_funding: false,
2018
2019                         // We'll add our counterparty's `funding_satoshis` to these max commitment output assertions
2020                         // when we receive `accept_channel2`.
2021                         #[cfg(debug_assertions)]
2022                         holder_max_commitment_tx_output: Mutex::new((channel_value_satoshis * 1000 - push_msat, push_msat)),
2023                         #[cfg(debug_assertions)]
2024                         counterparty_max_commitment_tx_output: Mutex::new((channel_value_satoshis * 1000 - push_msat, push_msat)),
2025
2026                         last_sent_closing_fee: None,
2027                         pending_counterparty_closing_signed: None,
2028                         expecting_peer_commitment_signed: false,
2029                         closing_fee_limits: None,
2030                         target_closing_feerate_sats_per_kw: None,
2031
2032                         funding_tx_confirmed_in: None,
2033                         funding_tx_confirmation_height: 0,
2034                         short_channel_id: None,
2035                         channel_creation_height: current_chain_height,
2036
2037                         feerate_per_kw: commitment_feerate,
2038                         counterparty_dust_limit_satoshis: 0,
2039                         holder_dust_limit_satoshis: MIN_CHAN_DUST_LIMIT_SATOSHIS,
2040                         counterparty_max_htlc_value_in_flight_msat: 0,
2041                         // We'll adjust this to include our counterparty's `funding_satoshis` when we
2042                         // receive `accept_channel2`.
2043                         holder_max_htlc_value_in_flight_msat: get_holder_max_htlc_value_in_flight_msat(channel_value_satoshis, &config.channel_handshake_config),
2044                         counterparty_selected_channel_reserve_satoshis: None, // Filled in in accept_channel
2045                         holder_selected_channel_reserve_satoshis,
2046                         counterparty_htlc_minimum_msat: 0,
2047                         holder_htlc_minimum_msat: if config.channel_handshake_config.our_htlc_minimum_msat == 0 { 1 } else { config.channel_handshake_config.our_htlc_minimum_msat },
2048                         counterparty_max_accepted_htlcs: 0,
2049                         holder_max_accepted_htlcs: cmp::min(config.channel_handshake_config.our_max_accepted_htlcs, MAX_HTLCS),
2050                         minimum_depth: None, // Filled in in accept_channel
2051
2052                         counterparty_forwarding_info: None,
2053
2054                         channel_transaction_parameters: ChannelTransactionParameters {
2055                                 holder_pubkeys: pubkeys,
2056                                 holder_selected_contest_delay: config.channel_handshake_config.our_to_self_delay,
2057                                 is_outbound_from_holder: true,
2058                                 counterparty_parameters: None,
2059                                 funding_outpoint: None,
2060                                 channel_type_features: channel_type.clone()
2061                         },
2062                         funding_transaction: None,
2063                         is_batch_funding: None,
2064
2065                         counterparty_cur_commitment_point: None,
2066                         counterparty_prev_commitment_point: None,
2067                         counterparty_node_id,
2068
2069                         counterparty_shutdown_scriptpubkey: None,
2070
2071                         commitment_secrets: CounterpartyCommitmentSecrets::new(),
2072
2073                         channel_update_status: ChannelUpdateStatus::Enabled,
2074                         closing_signed_in_flight: false,
2075
2076                         announcement_sigs: None,
2077
2078                         #[cfg(any(test, fuzzing))]
2079                         next_local_commitment_tx_fee_info_cached: Mutex::new(None),
2080                         #[cfg(any(test, fuzzing))]
2081                         next_remote_commitment_tx_fee_info_cached: Mutex::new(None),
2082
2083                         workaround_lnd_bug_4006: None,
2084                         sent_message_awaiting_response: None,
2085
2086                         latest_inbound_scid_alias: None,
2087                         outbound_scid_alias,
2088
2089                         channel_pending_event_emitted: false,
2090                         channel_ready_event_emitted: false,
2091
2092                         #[cfg(any(test, fuzzing))]
2093                         historical_inbound_htlc_fulfills: new_hash_set(),
2094
2095                         channel_type,
2096                         channel_keys_id,
2097
2098                         blocked_monitor_updates: Vec::new(),
2099                         local_initiated_shutdown: None,
2100                 })
2101         }
2102
2103         /// Allowed in any state (including after shutdown)
2104         pub fn get_update_time_counter(&self) -> u32 {
2105                 self.update_time_counter
2106         }
2107
2108         pub fn get_latest_monitor_update_id(&self) -> u64 {
2109                 self.latest_monitor_update_id
2110         }
2111
2112         pub fn should_announce(&self) -> bool {
2113                 self.config.announced_channel
2114         }
2115
2116         pub fn is_outbound(&self) -> bool {
2117                 self.channel_transaction_parameters.is_outbound_from_holder
2118         }
2119
2120         /// Gets the fee we'd want to charge for adding an HTLC output to this Channel
2121         /// Allowed in any state (including after shutdown)
2122         pub fn get_outbound_forwarding_fee_base_msat(&self) -> u32 {
2123                 self.config.options.forwarding_fee_base_msat
2124         }
2125
2126         /// Returns true if we've ever received a message from the remote end for this Channel
2127         pub fn have_received_message(&self) -> bool {
2128                 self.channel_state > ChannelState::NegotiatingFunding(NegotiatingFundingFlags::OUR_INIT_SENT)
2129         }
2130
2131         /// Returns true if this channel is fully established and not known to be closing.
2132         /// Allowed in any state (including after shutdown)
2133         pub fn is_usable(&self) -> bool {
2134                 matches!(self.channel_state, ChannelState::ChannelReady(_)) &&
2135                         !self.channel_state.is_local_shutdown_sent() &&
2136                         !self.channel_state.is_remote_shutdown_sent() &&
2137                         !self.monitor_pending_channel_ready
2138         }
2139
2140         /// shutdown state returns the state of the channel in its various stages of shutdown
2141         pub fn shutdown_state(&self) -> ChannelShutdownState {
2142                 match self.channel_state {
2143                         ChannelState::AwaitingChannelReady(_)|ChannelState::ChannelReady(_) =>
2144                                 if self.channel_state.is_local_shutdown_sent() && !self.channel_state.is_remote_shutdown_sent() {
2145                                         ChannelShutdownState::ShutdownInitiated
2146                                 } else if (self.channel_state.is_local_shutdown_sent() || self.channel_state.is_remote_shutdown_sent()) && !self.closing_negotiation_ready() {
2147                                         ChannelShutdownState::ResolvingHTLCs
2148                                 } else if (self.channel_state.is_local_shutdown_sent() || self.channel_state.is_remote_shutdown_sent()) && self.closing_negotiation_ready() {
2149                                         ChannelShutdownState::NegotiatingClosingFee
2150                                 } else {
2151                                         ChannelShutdownState::NotShuttingDown
2152                                 },
2153                         ChannelState::ShutdownComplete => ChannelShutdownState::ShutdownComplete,
2154                         _ => ChannelShutdownState::NotShuttingDown,
2155                 }
2156         }
2157
2158         fn closing_negotiation_ready(&self) -> bool {
2159                 let is_ready_to_close = match self.channel_state {
2160                         ChannelState::AwaitingChannelReady(flags) =>
2161                                 flags & FundedStateFlags::ALL == FundedStateFlags::LOCAL_SHUTDOWN_SENT | FundedStateFlags::REMOTE_SHUTDOWN_SENT,
2162                         ChannelState::ChannelReady(flags) =>
2163                                 flags == FundedStateFlags::LOCAL_SHUTDOWN_SENT | FundedStateFlags::REMOTE_SHUTDOWN_SENT,
2164                         _ => false,
2165                 };
2166                 self.pending_inbound_htlcs.is_empty() &&
2167                         self.pending_outbound_htlcs.is_empty() &&
2168                         self.pending_update_fee.is_none() &&
2169                         is_ready_to_close
2170         }
2171
2172         /// Returns true if this channel is currently available for use. This is a superset of
2173         /// is_usable() and considers things like the channel being temporarily disabled.
2174         /// Allowed in any state (including after shutdown)
2175         pub fn is_live(&self) -> bool {
2176                 self.is_usable() && !self.channel_state.is_peer_disconnected()
2177         }
2178
2179         // Public utilities:
2180
2181         pub fn channel_id(&self) -> ChannelId {
2182                 self.channel_id
2183         }
2184
2185         // Return the `temporary_channel_id` used during channel establishment.
2186         //
2187         // Will return `None` for channels created prior to LDK version 0.0.115.
2188         pub fn temporary_channel_id(&self) -> Option<ChannelId> {
2189                 self.temporary_channel_id
2190         }
2191
2192         pub fn minimum_depth(&self) -> Option<u32> {
2193                 self.minimum_depth
2194         }
2195
2196         /// Gets the "user_id" value passed into the construction of this channel. It has no special
2197         /// meaning and exists only to allow users to have a persistent identifier of a channel.
2198         pub fn get_user_id(&self) -> u128 {
2199                 self.user_id
2200         }
2201
2202         /// Gets the channel's type
2203         pub fn get_channel_type(&self) -> &ChannelTypeFeatures {
2204                 &self.channel_type
2205         }
2206
2207         /// Gets the channel's `short_channel_id`.
2208         ///
2209         /// Will return `None` if the channel hasn't been confirmed yet.
2210         pub fn get_short_channel_id(&self) -> Option<u64> {
2211                 self.short_channel_id
2212         }
2213
2214         /// Allowed in any state (including after shutdown)
2215         pub fn latest_inbound_scid_alias(&self) -> Option<u64> {
2216                 self.latest_inbound_scid_alias
2217         }
2218
2219         /// Allowed in any state (including after shutdown)
2220         pub fn outbound_scid_alias(&self) -> u64 {
2221                 self.outbound_scid_alias
2222         }
2223
2224         /// Returns the holder signer for this channel.
2225         #[cfg(test)]
2226         pub fn get_signer(&self) -> &ChannelSignerType<SP> {
2227                 return &self.holder_signer
2228         }
2229
2230         /// Only allowed immediately after deserialization if get_outbound_scid_alias returns 0,
2231         /// indicating we were written by LDK prior to 0.0.106 which did not set outbound SCID aliases
2232         /// or prior to any channel actions during `Channel` initialization.
2233         pub fn set_outbound_scid_alias(&mut self, outbound_scid_alias: u64) {
2234                 debug_assert_eq!(self.outbound_scid_alias, 0);
2235                 self.outbound_scid_alias = outbound_scid_alias;
2236         }
2237
2238         /// Returns the funding_txo we either got from our peer, or were given by
2239         /// get_funding_created.
2240         pub fn get_funding_txo(&self) -> Option<OutPoint> {
2241                 self.channel_transaction_parameters.funding_outpoint
2242         }
2243
2244         /// Returns the height in which our funding transaction was confirmed.
2245         pub fn get_funding_tx_confirmation_height(&self) -> Option<u32> {
2246                 let conf_height = self.funding_tx_confirmation_height;
2247                 if conf_height > 0 {
2248                         Some(conf_height)
2249                 } else {
2250                         None
2251                 }
2252         }
2253
2254         /// Returns the block hash in which our funding transaction was confirmed.
2255         pub fn get_funding_tx_confirmed_in(&self) -> Option<BlockHash> {
2256                 self.funding_tx_confirmed_in
2257         }
2258
2259         /// Returns the current number of confirmations on the funding transaction.
2260         pub fn get_funding_tx_confirmations(&self, height: u32) -> u32 {
2261                 if self.funding_tx_confirmation_height == 0 {
2262                         // We either haven't seen any confirmation yet, or observed a reorg.
2263                         return 0;
2264                 }
2265
2266                 height.checked_sub(self.funding_tx_confirmation_height).map_or(0, |c| c + 1)
2267         }
2268
2269         fn get_holder_selected_contest_delay(&self) -> u16 {
2270                 self.channel_transaction_parameters.holder_selected_contest_delay
2271         }
2272
2273         fn get_holder_pubkeys(&self) -> &ChannelPublicKeys {
2274                 &self.channel_transaction_parameters.holder_pubkeys
2275         }
2276
2277         pub fn get_counterparty_selected_contest_delay(&self) -> Option<u16> {
2278                 self.channel_transaction_parameters.counterparty_parameters
2279                         .as_ref().map(|params| params.selected_contest_delay)
2280         }
2281
2282         fn get_counterparty_pubkeys(&self) -> &ChannelPublicKeys {
2283                 &self.channel_transaction_parameters.counterparty_parameters.as_ref().unwrap().pubkeys
2284         }
2285
2286         /// Allowed in any state (including after shutdown)
2287         pub fn get_counterparty_node_id(&self) -> PublicKey {
2288                 self.counterparty_node_id
2289         }
2290
2291         /// Allowed in any state (including after shutdown)
2292         pub fn get_holder_htlc_minimum_msat(&self) -> u64 {
2293                 self.holder_htlc_minimum_msat
2294         }
2295
2296         /// Allowed in any state (including after shutdown), but will return none before TheirInitSent
2297         pub fn get_holder_htlc_maximum_msat(&self) -> Option<u64> {
2298                 self.get_htlc_maximum_msat(self.holder_max_htlc_value_in_flight_msat)
2299         }
2300
2301         /// Allowed in any state (including after shutdown)
2302         pub fn get_announced_htlc_max_msat(&self) -> u64 {
2303                 return cmp::min(
2304                         // Upper bound by capacity. We make it a bit less than full capacity to prevent attempts
2305                         // to use full capacity. This is an effort to reduce routing failures, because in many cases
2306                         // channel might have been used to route very small values (either by honest users or as DoS).
2307                         self.channel_value_satoshis * 1000 * 9 / 10,
2308
2309                         self.counterparty_max_htlc_value_in_flight_msat
2310                 );
2311         }
2312
2313         /// Allowed in any state (including after shutdown)
2314         pub fn get_counterparty_htlc_minimum_msat(&self) -> u64 {
2315                 self.counterparty_htlc_minimum_msat
2316         }
2317
2318         /// Allowed in any state (including after shutdown), but will return none before TheirInitSent
2319         pub fn get_counterparty_htlc_maximum_msat(&self) -> Option<u64> {
2320                 self.get_htlc_maximum_msat(self.counterparty_max_htlc_value_in_flight_msat)
2321         }
2322
2323         fn get_htlc_maximum_msat(&self, party_max_htlc_value_in_flight_msat: u64) -> Option<u64> {
2324                 self.counterparty_selected_channel_reserve_satoshis.map(|counterparty_reserve| {
2325                         let holder_reserve = self.holder_selected_channel_reserve_satoshis;
2326                         cmp::min(
2327                                 (self.channel_value_satoshis - counterparty_reserve - holder_reserve) * 1000,
2328                                 party_max_htlc_value_in_flight_msat
2329                         )
2330                 })
2331         }
2332
2333         pub fn get_value_satoshis(&self) -> u64 {
2334                 self.channel_value_satoshis
2335         }
2336
2337         pub fn get_fee_proportional_millionths(&self) -> u32 {
2338                 self.config.options.forwarding_fee_proportional_millionths
2339         }
2340
2341         pub fn get_cltv_expiry_delta(&self) -> u16 {
2342                 cmp::max(self.config.options.cltv_expiry_delta, MIN_CLTV_EXPIRY_DELTA)
2343         }
2344
2345         fn get_dust_exposure_limiting_feerate<F: Deref>(&self,
2346                 fee_estimator: &LowerBoundedFeeEstimator<F>,
2347         ) -> u32 where F::Target: FeeEstimator {
2348                 fee_estimator.bounded_sat_per_1000_weight(ConfirmationTarget::OnChainSweep)
2349         }
2350
2351         pub fn get_max_dust_htlc_exposure_msat(&self, limiting_feerate_sat_per_kw: u32) -> u64 {
2352                 match self.config.options.max_dust_htlc_exposure {
2353                         MaxDustHTLCExposure::FeeRateMultiplier(multiplier) => {
2354                                 (limiting_feerate_sat_per_kw as u64).saturating_mul(multiplier)
2355                         },
2356                         MaxDustHTLCExposure::FixedLimitMsat(limit) => limit,
2357                 }
2358         }
2359
2360         /// Returns the previous [`ChannelConfig`] applied to this channel, if any.
2361         pub fn prev_config(&self) -> Option<ChannelConfig> {
2362                 self.prev_config.map(|prev_config| prev_config.0)
2363         }
2364
2365         // Checks whether we should emit a `ChannelPending` event.
2366         pub(crate) fn should_emit_channel_pending_event(&mut self) -> bool {
2367                 self.is_funding_broadcast() && !self.channel_pending_event_emitted
2368         }
2369
2370         // Returns whether we already emitted a `ChannelPending` event.
2371         pub(crate) fn channel_pending_event_emitted(&self) -> bool {
2372                 self.channel_pending_event_emitted
2373         }
2374
2375         // Remembers that we already emitted a `ChannelPending` event.
2376         pub(crate) fn set_channel_pending_event_emitted(&mut self) {
2377                 self.channel_pending_event_emitted = true;
2378         }
2379
2380         // Checks whether we should emit a `ChannelReady` event.
2381         pub(crate) fn should_emit_channel_ready_event(&mut self) -> bool {
2382                 self.is_usable() && !self.channel_ready_event_emitted
2383         }
2384
2385         // Remembers that we already emitted a `ChannelReady` event.
2386         pub(crate) fn set_channel_ready_event_emitted(&mut self) {
2387                 self.channel_ready_event_emitted = true;
2388         }
2389
2390         /// Tracks the number of ticks elapsed since the previous [`ChannelConfig`] was updated. Once
2391         /// [`EXPIRE_PREV_CONFIG_TICKS`] is reached, the previous config is considered expired and will
2392         /// no longer be considered when forwarding HTLCs.
2393         pub fn maybe_expire_prev_config(&mut self) {
2394                 if self.prev_config.is_none() {
2395                         return;
2396                 }
2397                 let prev_config = self.prev_config.as_mut().unwrap();
2398                 prev_config.1 += 1;
2399                 if prev_config.1 == EXPIRE_PREV_CONFIG_TICKS {
2400                         self.prev_config = None;
2401                 }
2402         }
2403
2404         /// Returns the current [`ChannelConfig`] applied to the channel.
2405         pub fn config(&self) -> ChannelConfig {
2406                 self.config.options
2407         }
2408
2409         /// Updates the channel's config. A bool is returned indicating whether the config update
2410         /// applied resulted in a new ChannelUpdate message.
2411         pub fn update_config(&mut self, config: &ChannelConfig) -> bool {
2412                 let did_channel_update =
2413                         self.config.options.forwarding_fee_proportional_millionths != config.forwarding_fee_proportional_millionths ||
2414                         self.config.options.forwarding_fee_base_msat != config.forwarding_fee_base_msat ||
2415                         self.config.options.cltv_expiry_delta != config.cltv_expiry_delta;
2416                 if did_channel_update {
2417                         self.prev_config = Some((self.config.options, 0));
2418                         // Update the counter, which backs the ChannelUpdate timestamp, to allow the relay
2419                         // policy change to propagate throughout the network.
2420                         self.update_time_counter += 1;
2421                 }
2422                 self.config.options = *config;
2423                 did_channel_update
2424         }
2425
2426         /// Returns true if funding_signed was sent/received and the
2427         /// funding transaction has been broadcast if necessary.
2428         pub fn is_funding_broadcast(&self) -> bool {
2429                 !self.channel_state.is_pre_funded_state() &&
2430                         !matches!(self.channel_state, ChannelState::AwaitingChannelReady(flags) if flags.is_set(AwaitingChannelReadyFlags::WAITING_FOR_BATCH))
2431         }
2432
2433         /// Transaction nomenclature is somewhat confusing here as there are many different cases - a
2434         /// transaction is referred to as "a's transaction" implying that a will be able to broadcast
2435         /// the transaction. Thus, b will generally be sending a signature over such a transaction to
2436         /// a, and a can revoke the transaction by providing b the relevant per_commitment_secret. As
2437         /// such, a transaction is generally the result of b increasing the amount paid to a (or adding
2438         /// an HTLC to a).
2439         /// @local is used only to convert relevant internal structures which refer to remote vs local
2440         /// to decide value of outputs and direction of HTLCs.
2441         /// @generated_by_local is used to determine *which* HTLCs to include - noting that the HTLC
2442         /// state may indicate that one peer has informed the other that they'd like to add an HTLC but
2443         /// have not yet committed it. Such HTLCs will only be included in transactions which are being
2444         /// generated by the peer which proposed adding the HTLCs, and thus we need to understand both
2445         /// which peer generated this transaction and "to whom" this transaction flows.
2446         #[inline]
2447         fn build_commitment_transaction<L: Deref>(&self, commitment_number: u64, keys: &TxCreationKeys, local: bool, generated_by_local: bool, logger: &L) -> CommitmentStats
2448                 where L::Target: Logger
2449         {
2450                 let mut included_dust_htlcs: Vec<(HTLCOutputInCommitment, Option<&HTLCSource>)> = Vec::new();
2451                 let num_htlcs = self.pending_inbound_htlcs.len() + self.pending_outbound_htlcs.len();
2452                 let mut included_non_dust_htlcs: Vec<(HTLCOutputInCommitment, Option<&HTLCSource>)> = Vec::with_capacity(num_htlcs);
2453
2454                 let broadcaster_dust_limit_satoshis = if local { self.holder_dust_limit_satoshis } else { self.counterparty_dust_limit_satoshis };
2455                 let mut remote_htlc_total_msat = 0;
2456                 let mut local_htlc_total_msat = 0;
2457                 let mut value_to_self_msat_offset = 0;
2458
2459                 let mut feerate_per_kw = self.feerate_per_kw;
2460                 if let Some((feerate, update_state)) = self.pending_update_fee {
2461                         if match update_state {
2462                                 // Note that these match the inclusion criteria when scanning
2463                                 // pending_inbound_htlcs below.
2464                                 FeeUpdateState::RemoteAnnounced => { debug_assert!(!self.is_outbound()); !generated_by_local },
2465                                 FeeUpdateState::AwaitingRemoteRevokeToAnnounce => { debug_assert!(!self.is_outbound()); !generated_by_local },
2466                                 FeeUpdateState::Outbound => { assert!(self.is_outbound());  generated_by_local },
2467                         } {
2468                                 feerate_per_kw = feerate;
2469                         }
2470                 }
2471
2472                 log_trace!(logger, "Building commitment transaction number {} (really {} xor {}) for channel {} for {}, generated by {} with fee {}...",
2473                         commitment_number, (INITIAL_COMMITMENT_NUMBER - commitment_number),
2474                         get_commitment_transaction_number_obscure_factor(&self.get_holder_pubkeys().payment_point, &self.get_counterparty_pubkeys().payment_point, self.is_outbound()),
2475                         &self.channel_id,
2476                         if local { "us" } else { "remote" }, if generated_by_local { "us" } else { "remote" }, feerate_per_kw);
2477
2478                 macro_rules! get_htlc_in_commitment {
2479                         ($htlc: expr, $offered: expr) => {
2480                                 HTLCOutputInCommitment {
2481                                         offered: $offered,
2482                                         amount_msat: $htlc.amount_msat,
2483                                         cltv_expiry: $htlc.cltv_expiry,
2484                                         payment_hash: $htlc.payment_hash,
2485                                         transaction_output_index: None
2486                                 }
2487                         }
2488                 }
2489
2490                 macro_rules! add_htlc_output {
2491                         ($htlc: expr, $outbound: expr, $source: expr, $state_name: expr) => {
2492                                 if $outbound == local { // "offered HTLC output"
2493                                         let htlc_in_tx = get_htlc_in_commitment!($htlc, true);
2494                                         let htlc_tx_fee = if self.get_channel_type().supports_anchors_zero_fee_htlc_tx() {
2495                                                 0
2496                                         } else {
2497                                                 feerate_per_kw as u64 * htlc_timeout_tx_weight(self.get_channel_type()) / 1000
2498                                         };
2499                                         if $htlc.amount_msat / 1000 >= broadcaster_dust_limit_satoshis + htlc_tx_fee {
2500                                                 log_trace!(logger, "   ...including {} {} HTLC {} (hash {}) with value {}", if $outbound { "outbound" } else { "inbound" }, $state_name, $htlc.htlc_id, &$htlc.payment_hash, $htlc.amount_msat);
2501                                                 included_non_dust_htlcs.push((htlc_in_tx, $source));
2502                                         } else {
2503                                                 log_trace!(logger, "   ...including {} {} dust HTLC {} (hash {}) with value {} due to dust limit", if $outbound { "outbound" } else { "inbound" }, $state_name, $htlc.htlc_id, &$htlc.payment_hash, $htlc.amount_msat);
2504                                                 included_dust_htlcs.push((htlc_in_tx, $source));
2505                                         }
2506                                 } else {
2507                                         let htlc_in_tx = get_htlc_in_commitment!($htlc, false);
2508                                         let htlc_tx_fee = if self.get_channel_type().supports_anchors_zero_fee_htlc_tx() {
2509                                                 0
2510                                         } else {
2511                                                 feerate_per_kw as u64 * htlc_success_tx_weight(self.get_channel_type()) / 1000
2512                                         };
2513                                         if $htlc.amount_msat / 1000 >= broadcaster_dust_limit_satoshis + htlc_tx_fee {
2514                                                 log_trace!(logger, "   ...including {} {} HTLC {} (hash {}) with value {}", if $outbound { "outbound" } else { "inbound" }, $state_name, $htlc.htlc_id, &$htlc.payment_hash, $htlc.amount_msat);
2515                                                 included_non_dust_htlcs.push((htlc_in_tx, $source));
2516                                         } else {
2517                                                 log_trace!(logger, "   ...including {} {} dust HTLC {} (hash {}) with value {}", if $outbound { "outbound" } else { "inbound" }, $state_name, $htlc.htlc_id, &$htlc.payment_hash, $htlc.amount_msat);
2518                                                 included_dust_htlcs.push((htlc_in_tx, $source));
2519                                         }
2520                                 }
2521                         }
2522                 }
2523
2524                 let mut inbound_htlc_preimages: Vec<PaymentPreimage> = Vec::new();
2525
2526                 for ref htlc in self.pending_inbound_htlcs.iter() {
2527                         let (include, state_name) = match htlc.state {
2528                                 InboundHTLCState::RemoteAnnounced(_) => (!generated_by_local, "RemoteAnnounced"),
2529                                 InboundHTLCState::AwaitingRemoteRevokeToAnnounce(_) => (!generated_by_local, "AwaitingRemoteRevokeToAnnounce"),
2530                                 InboundHTLCState::AwaitingAnnouncedRemoteRevoke(_) => (true, "AwaitingAnnouncedRemoteRevoke"),
2531                                 InboundHTLCState::Committed => (true, "Committed"),
2532                                 InboundHTLCState::LocalRemoved(_) => (!generated_by_local, "LocalRemoved"),
2533                         };
2534
2535                         if include {
2536                                 add_htlc_output!(htlc, false, None, state_name);
2537                                 remote_htlc_total_msat += htlc.amount_msat;
2538                         } else {
2539                                 log_trace!(logger, "   ...not including inbound HTLC {} (hash {}) with value {} due to state ({})", htlc.htlc_id, &htlc.payment_hash, htlc.amount_msat, state_name);
2540                                 match &htlc.state {
2541                                         &InboundHTLCState::LocalRemoved(ref reason) => {
2542                                                 if generated_by_local {
2543                                                         if let &InboundHTLCRemovalReason::Fulfill(preimage) = reason {
2544                                                                 inbound_htlc_preimages.push(preimage);
2545                                                                 value_to_self_msat_offset += htlc.amount_msat as i64;
2546                                                         }
2547                                                 }
2548                                         },
2549                                         _ => {},
2550                                 }
2551                         }
2552                 }
2553
2554
2555                 let mut outbound_htlc_preimages: Vec<PaymentPreimage> = Vec::new();
2556
2557                 for ref htlc in self.pending_outbound_htlcs.iter() {
2558                         let (include, state_name) = match htlc.state {
2559                                 OutboundHTLCState::LocalAnnounced(_) => (generated_by_local, "LocalAnnounced"),
2560                                 OutboundHTLCState::Committed => (true, "Committed"),
2561                                 OutboundHTLCState::RemoteRemoved(_) => (generated_by_local, "RemoteRemoved"),
2562                                 OutboundHTLCState::AwaitingRemoteRevokeToRemove(_) => (generated_by_local, "AwaitingRemoteRevokeToRemove"),
2563                                 OutboundHTLCState::AwaitingRemovedRemoteRevoke(_) => (false, "AwaitingRemovedRemoteRevoke"),
2564                         };
2565
2566                         let preimage_opt = match htlc.state {
2567                                 OutboundHTLCState::RemoteRemoved(OutboundHTLCOutcome::Success(p)) => p,
2568                                 OutboundHTLCState::AwaitingRemoteRevokeToRemove(OutboundHTLCOutcome::Success(p)) => p,
2569                                 OutboundHTLCState::AwaitingRemovedRemoteRevoke(OutboundHTLCOutcome::Success(p)) => p,
2570                                 _ => None,
2571                         };
2572
2573                         if let Some(preimage) = preimage_opt {
2574                                 outbound_htlc_preimages.push(preimage);
2575                         }
2576
2577                         if include {
2578                                 add_htlc_output!(htlc, true, Some(&htlc.source), state_name);
2579                                 local_htlc_total_msat += htlc.amount_msat;
2580                         } else {
2581                                 log_trace!(logger, "   ...not including outbound HTLC {} (hash {}) with value {} due to state ({})", htlc.htlc_id, &htlc.payment_hash, htlc.amount_msat, state_name);
2582                                 match htlc.state {
2583                                         OutboundHTLCState::AwaitingRemoteRevokeToRemove(OutboundHTLCOutcome::Success(_))|OutboundHTLCState::AwaitingRemovedRemoteRevoke(OutboundHTLCOutcome::Success(_)) => {
2584                                                 value_to_self_msat_offset -= htlc.amount_msat as i64;
2585                                         },
2586                                         OutboundHTLCState::RemoteRemoved(OutboundHTLCOutcome::Success(_)) => {
2587                                                 if !generated_by_local {
2588                                                         value_to_self_msat_offset -= htlc.amount_msat as i64;
2589                                                 }
2590                                         },
2591                                         _ => {},
2592                                 }
2593                         }
2594                 }
2595
2596                 let value_to_self_msat: i64 = (self.value_to_self_msat - local_htlc_total_msat) as i64 + value_to_self_msat_offset;
2597                 assert!(value_to_self_msat >= 0);
2598                 // Note that in case they have several just-awaiting-last-RAA fulfills in-progress (ie
2599                 // AwaitingRemoteRevokeToRemove or AwaitingRemovedRemoteRevoke) we may have allowed them to
2600                 // "violate" their reserve value by couting those against it. Thus, we have to convert
2601                 // everything to i64 before subtracting as otherwise we can overflow.
2602                 let value_to_remote_msat: i64 = (self.channel_value_satoshis * 1000) as i64 - (self.value_to_self_msat as i64) - (remote_htlc_total_msat as i64) - value_to_self_msat_offset;
2603                 assert!(value_to_remote_msat >= 0);
2604
2605                 #[cfg(debug_assertions)]
2606                 {
2607                         // Make sure that the to_self/to_remote is always either past the appropriate
2608                         // channel_reserve *or* it is making progress towards it.
2609                         let mut broadcaster_max_commitment_tx_output = if generated_by_local {
2610                                 self.holder_max_commitment_tx_output.lock().unwrap()
2611                         } else {
2612                                 self.counterparty_max_commitment_tx_output.lock().unwrap()
2613                         };
2614                         debug_assert!(broadcaster_max_commitment_tx_output.0 <= value_to_self_msat as u64 || value_to_self_msat / 1000 >= self.counterparty_selected_channel_reserve_satoshis.unwrap() as i64);
2615                         broadcaster_max_commitment_tx_output.0 = cmp::max(broadcaster_max_commitment_tx_output.0, value_to_self_msat as u64);
2616                         debug_assert!(broadcaster_max_commitment_tx_output.1 <= value_to_remote_msat as u64 || value_to_remote_msat / 1000 >= self.holder_selected_channel_reserve_satoshis as i64);
2617                         broadcaster_max_commitment_tx_output.1 = cmp::max(broadcaster_max_commitment_tx_output.1, value_to_remote_msat as u64);
2618                 }
2619
2620                 let total_fee_sat = commit_tx_fee_sat(feerate_per_kw, included_non_dust_htlcs.len(), &self.channel_transaction_parameters.channel_type_features);
2621                 let anchors_val = if self.channel_transaction_parameters.channel_type_features.supports_anchors_zero_fee_htlc_tx() { ANCHOR_OUTPUT_VALUE_SATOSHI * 2 } else { 0 } as i64;
2622                 let (value_to_self, value_to_remote) = if self.is_outbound() {
2623                         (value_to_self_msat / 1000 - anchors_val - total_fee_sat as i64, value_to_remote_msat / 1000)
2624                 } else {
2625                         (value_to_self_msat / 1000, value_to_remote_msat / 1000 - anchors_val - total_fee_sat as i64)
2626                 };
2627
2628                 let mut value_to_a = if local { value_to_self } else { value_to_remote };
2629                 let mut value_to_b = if local { value_to_remote } else { value_to_self };
2630                 let (funding_pubkey_a, funding_pubkey_b) = if local {
2631                         (self.get_holder_pubkeys().funding_pubkey, self.get_counterparty_pubkeys().funding_pubkey)
2632                 } else {
2633                         (self.get_counterparty_pubkeys().funding_pubkey, self.get_holder_pubkeys().funding_pubkey)
2634                 };
2635
2636                 if value_to_a >= (broadcaster_dust_limit_satoshis as i64) {
2637                         log_trace!(logger, "   ...including {} output with value {}", if local { "to_local" } else { "to_remote" }, value_to_a);
2638                 } else {
2639                         value_to_a = 0;
2640                 }
2641
2642                 if value_to_b >= (broadcaster_dust_limit_satoshis as i64) {
2643                         log_trace!(logger, "   ...including {} output with value {}", if local { "to_remote" } else { "to_local" }, value_to_b);
2644                 } else {
2645                         value_to_b = 0;
2646                 }
2647
2648                 let num_nondust_htlcs = included_non_dust_htlcs.len();
2649
2650                 let channel_parameters =
2651                         if local { self.channel_transaction_parameters.as_holder_broadcastable() }
2652                         else { self.channel_transaction_parameters.as_counterparty_broadcastable() };
2653                 let tx = CommitmentTransaction::new_with_auxiliary_htlc_data(commitment_number,
2654                                                                              value_to_a as u64,
2655                                                                              value_to_b as u64,
2656                                                                              funding_pubkey_a,
2657                                                                              funding_pubkey_b,
2658                                                                              keys.clone(),
2659                                                                              feerate_per_kw,
2660                                                                              &mut included_non_dust_htlcs,
2661                                                                              &channel_parameters
2662                 );
2663                 let mut htlcs_included = included_non_dust_htlcs;
2664                 // The unwrap is safe, because all non-dust HTLCs have been assigned an output index
2665                 htlcs_included.sort_unstable_by_key(|h| h.0.transaction_output_index.unwrap());
2666                 htlcs_included.append(&mut included_dust_htlcs);
2667
2668                 CommitmentStats {
2669                         tx,
2670                         feerate_per_kw,
2671                         total_fee_sat,
2672                         num_nondust_htlcs,
2673                         htlcs_included,
2674                         local_balance_msat: value_to_self_msat as u64,
2675                         remote_balance_msat: value_to_remote_msat as u64,
2676                         inbound_htlc_preimages,
2677                         outbound_htlc_preimages,
2678                 }
2679         }
2680
2681         #[inline]
2682         /// Creates a set of keys for build_commitment_transaction to generate a transaction which our
2683         /// counterparty will sign (ie DO NOT send signatures over a transaction created by this to
2684         /// our counterparty!)
2685         /// The result is a transaction which we can revoke broadcastership of (ie a "local" transaction)
2686         /// TODO Some magic rust shit to compile-time check this?
2687         fn build_holder_transaction_keys(&self, commitment_number: u64) -> TxCreationKeys {
2688                 let per_commitment_point = self.holder_signer.as_ref().get_per_commitment_point(commitment_number, &self.secp_ctx);
2689                 let delayed_payment_base = &self.get_holder_pubkeys().delayed_payment_basepoint;
2690                 let htlc_basepoint = &self.get_holder_pubkeys().htlc_basepoint;
2691                 let counterparty_pubkeys = self.get_counterparty_pubkeys();
2692
2693                 TxCreationKeys::derive_new(&self.secp_ctx, &per_commitment_point, delayed_payment_base, htlc_basepoint, &counterparty_pubkeys.revocation_basepoint, &counterparty_pubkeys.htlc_basepoint)
2694         }
2695
2696         #[inline]
2697         /// Creates a set of keys for build_commitment_transaction to generate a transaction which we
2698         /// will sign and send to our counterparty.
2699         /// If an Err is returned, it is a ChannelError::Close (for get_funding_created)
2700         fn build_remote_transaction_keys(&self) -> TxCreationKeys {
2701                 let revocation_basepoint = &self.get_holder_pubkeys().revocation_basepoint;
2702                 let htlc_basepoint = &self.get_holder_pubkeys().htlc_basepoint;
2703                 let counterparty_pubkeys = self.get_counterparty_pubkeys();
2704
2705                 TxCreationKeys::derive_new(&self.secp_ctx, &self.counterparty_cur_commitment_point.unwrap(), &counterparty_pubkeys.delayed_payment_basepoint, &counterparty_pubkeys.htlc_basepoint, revocation_basepoint, htlc_basepoint)
2706         }
2707
2708         /// Gets the redeemscript for the funding transaction output (ie the funding transaction output
2709         /// pays to get_funding_redeemscript().to_v0_p2wsh()).
2710         /// Panics if called before accept_channel/InboundV1Channel::new
2711         pub fn get_funding_redeemscript(&self) -> ScriptBuf {
2712                 make_funding_redeemscript(&self.get_holder_pubkeys().funding_pubkey, self.counterparty_funding_pubkey())
2713         }
2714
2715         fn counterparty_funding_pubkey(&self) -> &PublicKey {
2716                 &self.get_counterparty_pubkeys().funding_pubkey
2717         }
2718
2719         pub fn get_feerate_sat_per_1000_weight(&self) -> u32 {
2720                 self.feerate_per_kw
2721         }
2722
2723         pub fn get_dust_buffer_feerate(&self, outbound_feerate_update: Option<u32>) -> u32 {
2724                 // When calculating our exposure to dust HTLCs, we assume that the channel feerate
2725                 // may, at any point, increase by at least 10 sat/vB (i.e 2530 sat/kWU) or 25%,
2726                 // whichever is higher. This ensures that we aren't suddenly exposed to significantly
2727                 // more dust balance if the feerate increases when we have several HTLCs pending
2728                 // which are near the dust limit.
2729                 let mut feerate_per_kw = self.feerate_per_kw;
2730                 // If there's a pending update fee, use it to ensure we aren't under-estimating
2731                 // potential feerate updates coming soon.
2732                 if let Some((feerate, _)) = self.pending_update_fee {
2733                         feerate_per_kw = cmp::max(feerate_per_kw, feerate);
2734                 }
2735                 if let Some(feerate) = outbound_feerate_update {
2736                         feerate_per_kw = cmp::max(feerate_per_kw, feerate);
2737                 }
2738                 let feerate_plus_quarter = feerate_per_kw.checked_mul(1250).map(|v| v / 1000);
2739                 cmp::max(feerate_per_kw + 2530, feerate_plus_quarter.unwrap_or(u32::max_value()))
2740         }
2741
2742         /// Get forwarding information for the counterparty.
2743         pub fn counterparty_forwarding_info(&self) -> Option<CounterpartyForwardingInfo> {
2744                 self.counterparty_forwarding_info.clone()
2745         }
2746
2747         /// Returns a HTLCStats about pending htlcs
2748         fn get_pending_htlc_stats(&self, outbound_feerate_update: Option<u32>, dust_exposure_limiting_feerate: u32) -> HTLCStats {
2749                 let context = self;
2750                 let uses_0_htlc_fee_anchors = self.get_channel_type().supports_anchors_zero_fee_htlc_tx();
2751
2752                 let dust_buffer_feerate = context.get_dust_buffer_feerate(outbound_feerate_update);
2753                 let (htlc_timeout_dust_limit, htlc_success_dust_limit) = if uses_0_htlc_fee_anchors {
2754                         (0, 0)
2755                 } else {
2756                         (dust_buffer_feerate as u64 * htlc_timeout_tx_weight(context.get_channel_type()) / 1000,
2757                                 dust_buffer_feerate as u64 * htlc_success_tx_weight(context.get_channel_type()) / 1000)
2758                 };
2759
2760                 let mut on_holder_tx_dust_exposure_msat = 0;
2761                 let mut on_counterparty_tx_dust_exposure_msat = 0;
2762
2763                 let mut on_counterparty_tx_offered_nondust_htlcs = 0;
2764                 let mut on_counterparty_tx_accepted_nondust_htlcs = 0;
2765
2766                 let mut pending_inbound_htlcs_value_msat = 0;
2767
2768                 {
2769                         let counterparty_dust_limit_timeout_sat = htlc_timeout_dust_limit + context.counterparty_dust_limit_satoshis;
2770                         let holder_dust_limit_success_sat = htlc_success_dust_limit + context.holder_dust_limit_satoshis;
2771                         for ref htlc in context.pending_inbound_htlcs.iter() {
2772                                 pending_inbound_htlcs_value_msat += htlc.amount_msat;
2773                                 if htlc.amount_msat / 1000 < counterparty_dust_limit_timeout_sat {
2774                                         on_counterparty_tx_dust_exposure_msat += htlc.amount_msat;
2775                                 } else {
2776                                         on_counterparty_tx_offered_nondust_htlcs += 1;
2777                                 }
2778                                 if htlc.amount_msat / 1000 < holder_dust_limit_success_sat {
2779                                         on_holder_tx_dust_exposure_msat += htlc.amount_msat;
2780                                 }
2781                         }
2782                 }
2783
2784                 let mut pending_outbound_htlcs_value_msat = 0;
2785                 let mut outbound_holding_cell_msat = 0;
2786                 let mut on_holder_tx_outbound_holding_cell_htlcs_count = 0;
2787                 let mut pending_outbound_htlcs = self.pending_outbound_htlcs.len();
2788                 {
2789                         let counterparty_dust_limit_success_sat = htlc_success_dust_limit + context.counterparty_dust_limit_satoshis;
2790                         let holder_dust_limit_timeout_sat = htlc_timeout_dust_limit + context.holder_dust_limit_satoshis;
2791                         for ref htlc in context.pending_outbound_htlcs.iter() {
2792                                 pending_outbound_htlcs_value_msat += htlc.amount_msat;
2793                                 if htlc.amount_msat / 1000 < counterparty_dust_limit_success_sat {
2794                                         on_counterparty_tx_dust_exposure_msat += htlc.amount_msat;
2795                                 } else {
2796                                         on_counterparty_tx_accepted_nondust_htlcs += 1;
2797                                 }
2798                                 if htlc.amount_msat / 1000 < holder_dust_limit_timeout_sat {
2799                                         on_holder_tx_dust_exposure_msat += htlc.amount_msat;
2800                                 }
2801                         }
2802
2803                         for update in context.holding_cell_htlc_updates.iter() {
2804                                 if let &HTLCUpdateAwaitingACK::AddHTLC { ref amount_msat, .. } = update {
2805                                         pending_outbound_htlcs += 1;
2806                                         pending_outbound_htlcs_value_msat += amount_msat;
2807                                         outbound_holding_cell_msat += amount_msat;
2808                                         if *amount_msat / 1000 < counterparty_dust_limit_success_sat {
2809                                                 on_counterparty_tx_dust_exposure_msat += amount_msat;
2810                                         } else {
2811                                                 on_counterparty_tx_accepted_nondust_htlcs += 1;
2812                                         }
2813                                         if *amount_msat / 1000 < holder_dust_limit_timeout_sat {
2814                                                 on_holder_tx_dust_exposure_msat += amount_msat;
2815                                         } else {
2816                                                 on_holder_tx_outbound_holding_cell_htlcs_count += 1;
2817                                         }
2818                                 }
2819                         }
2820                 }
2821
2822                 // Include any mining "excess" fees in the dust calculation
2823                 let excess_feerate_opt = outbound_feerate_update
2824                         .or(self.pending_update_fee.map(|(fee, _)| fee))
2825                         .unwrap_or(self.feerate_per_kw)
2826                         .checked_sub(dust_exposure_limiting_feerate);
2827                 if let Some(excess_feerate) = excess_feerate_opt {
2828                         let on_counterparty_tx_nondust_htlcs =
2829                                 on_counterparty_tx_accepted_nondust_htlcs + on_counterparty_tx_offered_nondust_htlcs;
2830                         on_counterparty_tx_dust_exposure_msat +=
2831                                 commit_tx_fee_msat(excess_feerate, on_counterparty_tx_nondust_htlcs, &self.channel_type);
2832                         if !self.channel_type.supports_anchors_zero_fee_htlc_tx() {
2833                                 on_counterparty_tx_dust_exposure_msat +=
2834                                         on_counterparty_tx_accepted_nondust_htlcs as u64 * htlc_success_tx_weight(&self.channel_type)
2835                                         * excess_feerate as u64 / 1000;
2836                                 on_counterparty_tx_dust_exposure_msat +=
2837                                         on_counterparty_tx_offered_nondust_htlcs as u64 * htlc_timeout_tx_weight(&self.channel_type)
2838                                         * excess_feerate as u64 / 1000;
2839                         }
2840                 }
2841
2842                 HTLCStats {
2843                         pending_inbound_htlcs: self.pending_inbound_htlcs.len(),
2844                         pending_outbound_htlcs,
2845                         pending_inbound_htlcs_value_msat,
2846                         pending_outbound_htlcs_value_msat,
2847                         on_counterparty_tx_dust_exposure_msat,
2848                         on_holder_tx_dust_exposure_msat,
2849                         outbound_holding_cell_msat,
2850                         on_holder_tx_outbound_holding_cell_htlcs_count,
2851                 }
2852         }
2853
2854         /// Returns information on all pending inbound HTLCs.
2855         pub fn get_pending_inbound_htlc_details(&self) -> Vec<InboundHTLCDetails> {
2856                 let mut holding_cell_states = new_hash_map();
2857                 for holding_cell_update in self.holding_cell_htlc_updates.iter() {
2858                         match holding_cell_update {
2859                                 HTLCUpdateAwaitingACK::ClaimHTLC { htlc_id, .. } => {
2860                                         holding_cell_states.insert(
2861                                                 htlc_id,
2862                                                 InboundHTLCStateDetails::AwaitingRemoteRevokeToRemoveFulfill,
2863                                         );
2864                                 },
2865                                 HTLCUpdateAwaitingACK::FailHTLC { htlc_id, .. } => {
2866                                         holding_cell_states.insert(
2867                                                 htlc_id,
2868                                                 InboundHTLCStateDetails::AwaitingRemoteRevokeToRemoveFail,
2869                                         );
2870                                 },
2871                                 HTLCUpdateAwaitingACK::FailMalformedHTLC { htlc_id, .. } => {
2872                                         holding_cell_states.insert(
2873                                                 htlc_id,
2874                                                 InboundHTLCStateDetails::AwaitingRemoteRevokeToRemoveFail,
2875                                         );
2876                                 },
2877                                 // Outbound HTLC.
2878                                 HTLCUpdateAwaitingACK::AddHTLC { .. } => {},
2879                         }
2880                 }
2881                 let mut inbound_details = Vec::new();
2882                 let htlc_success_dust_limit = if self.get_channel_type().supports_anchors_zero_fee_htlc_tx() {
2883                         0
2884                 } else {
2885                         let dust_buffer_feerate = self.get_dust_buffer_feerate(None) as u64;
2886                         dust_buffer_feerate * htlc_success_tx_weight(self.get_channel_type()) / 1000
2887                 };
2888                 let holder_dust_limit_success_sat = htlc_success_dust_limit + self.holder_dust_limit_satoshis;
2889                 for htlc in self.pending_inbound_htlcs.iter() {
2890                         if let Some(state_details) = (&htlc.state).into() {
2891                                 inbound_details.push(InboundHTLCDetails{
2892                                         htlc_id: htlc.htlc_id,
2893                                         amount_msat: htlc.amount_msat,
2894                                         cltv_expiry: htlc.cltv_expiry,
2895                                         payment_hash: htlc.payment_hash,
2896                                         state: Some(holding_cell_states.remove(&htlc.htlc_id).unwrap_or(state_details)),
2897                                         is_dust: htlc.amount_msat / 1000 < holder_dust_limit_success_sat,
2898                                 });
2899                         }
2900                 }
2901                 inbound_details
2902         }
2903
2904         /// Returns information on all pending outbound HTLCs.
2905         pub fn get_pending_outbound_htlc_details(&self) -> Vec<OutboundHTLCDetails> {
2906                 let mut outbound_details = Vec::new();
2907                 let htlc_timeout_dust_limit = if self.get_channel_type().supports_anchors_zero_fee_htlc_tx() {
2908                         0
2909                 } else {
2910                         let dust_buffer_feerate = self.get_dust_buffer_feerate(None) as u64;
2911                         dust_buffer_feerate * htlc_success_tx_weight(self.get_channel_type()) / 1000
2912                 };
2913                 let holder_dust_limit_timeout_sat = htlc_timeout_dust_limit + self.holder_dust_limit_satoshis;
2914                 for htlc in self.pending_outbound_htlcs.iter() {
2915                         outbound_details.push(OutboundHTLCDetails{
2916                                 htlc_id: Some(htlc.htlc_id),
2917                                 amount_msat: htlc.amount_msat,
2918                                 cltv_expiry: htlc.cltv_expiry,
2919                                 payment_hash: htlc.payment_hash,
2920                                 skimmed_fee_msat: htlc.skimmed_fee_msat,
2921                                 state: Some((&htlc.state).into()),
2922                                 is_dust: htlc.amount_msat / 1000 < holder_dust_limit_timeout_sat,
2923                         });
2924                 }
2925                 for holding_cell_update in self.holding_cell_htlc_updates.iter() {
2926                         if let HTLCUpdateAwaitingACK::AddHTLC {
2927                                 amount_msat,
2928                                 cltv_expiry,
2929                                 payment_hash,
2930                                 skimmed_fee_msat,
2931                                 ..
2932                         } = *holding_cell_update {
2933                                 outbound_details.push(OutboundHTLCDetails{
2934                                         htlc_id: None,
2935                                         amount_msat: amount_msat,
2936                                         cltv_expiry: cltv_expiry,
2937                                         payment_hash: payment_hash,
2938                                         skimmed_fee_msat: skimmed_fee_msat,
2939                                         state: Some(OutboundHTLCStateDetails::AwaitingRemoteRevokeToAdd),
2940                                         is_dust: amount_msat / 1000 < holder_dust_limit_timeout_sat,
2941                                 });
2942                         }
2943                 }
2944                 outbound_details
2945         }
2946
2947         /// Get the available balances, see [`AvailableBalances`]'s fields for more info.
2948         /// Doesn't bother handling the
2949         /// if-we-removed-it-already-but-haven't-fully-resolved-they-can-still-send-an-inbound-HTLC
2950         /// corner case properly.
2951         pub fn get_available_balances<F: Deref>(&self, fee_estimator: &LowerBoundedFeeEstimator<F>)
2952         -> AvailableBalances
2953         where F::Target: FeeEstimator
2954         {
2955                 let context = &self;
2956                 // Note that we have to handle overflow due to the case mentioned in the docs in general
2957                 // here.
2958
2959                 let dust_exposure_limiting_feerate = self.get_dust_exposure_limiting_feerate(&fee_estimator);
2960                 let htlc_stats = context.get_pending_htlc_stats(None, dust_exposure_limiting_feerate);
2961
2962                 let mut balance_msat = context.value_to_self_msat;
2963                 for ref htlc in context.pending_inbound_htlcs.iter() {
2964                         if let InboundHTLCState::LocalRemoved(InboundHTLCRemovalReason::Fulfill(_)) = htlc.state {
2965                                 balance_msat += htlc.amount_msat;
2966                         }
2967                 }
2968                 balance_msat -= htlc_stats.pending_outbound_htlcs_value_msat;
2969
2970                 let outbound_capacity_msat = context.value_to_self_msat
2971                                 .saturating_sub(htlc_stats.pending_outbound_htlcs_value_msat)
2972                                 .saturating_sub(
2973                                         context.counterparty_selected_channel_reserve_satoshis.unwrap_or(0) * 1000);
2974
2975                 let mut available_capacity_msat = outbound_capacity_msat;
2976
2977                 let anchor_outputs_value_msat = if context.get_channel_type().supports_anchors_zero_fee_htlc_tx() {
2978                         ANCHOR_OUTPUT_VALUE_SATOSHI * 2 * 1000
2979                 } else {
2980                         0
2981                 };
2982                 if context.is_outbound() {
2983                         // We should mind channel commit tx fee when computing how much of the available capacity
2984                         // can be used in the next htlc. Mirrors the logic in send_htlc.
2985                         //
2986                         // The fee depends on whether the amount we will be sending is above dust or not,
2987                         // and the answer will in turn change the amount itself â€” making it a circular
2988                         // dependency.
2989                         // This complicates the computation around dust-values, up to the one-htlc-value.
2990                         let mut real_dust_limit_timeout_sat = context.holder_dust_limit_satoshis;
2991                         if !context.get_channel_type().supports_anchors_zero_fee_htlc_tx() {
2992                                 real_dust_limit_timeout_sat += context.feerate_per_kw as u64 * htlc_timeout_tx_weight(context.get_channel_type()) / 1000;
2993                         }
2994
2995                         let htlc_above_dust = HTLCCandidate::new(real_dust_limit_timeout_sat * 1000, HTLCInitiator::LocalOffered);
2996                         let mut max_reserved_commit_tx_fee_msat = context.next_local_commit_tx_fee_msat(htlc_above_dust, Some(()));
2997                         let htlc_dust = HTLCCandidate::new(real_dust_limit_timeout_sat * 1000 - 1, HTLCInitiator::LocalOffered);
2998                         let mut min_reserved_commit_tx_fee_msat = context.next_local_commit_tx_fee_msat(htlc_dust, Some(()));
2999                         if !context.get_channel_type().supports_anchors_zero_fee_htlc_tx() {
3000                                 max_reserved_commit_tx_fee_msat *= FEE_SPIKE_BUFFER_FEE_INCREASE_MULTIPLE;
3001                                 min_reserved_commit_tx_fee_msat *= FEE_SPIKE_BUFFER_FEE_INCREASE_MULTIPLE;
3002                         }
3003
3004                         // We will first subtract the fee as if we were above-dust. Then, if the resulting
3005                         // value ends up being below dust, we have this fee available again. In that case,
3006                         // match the value to right-below-dust.
3007                         let mut capacity_minus_commitment_fee_msat: i64 = available_capacity_msat as i64 -
3008                                 max_reserved_commit_tx_fee_msat as i64 - anchor_outputs_value_msat as i64;
3009                         if capacity_minus_commitment_fee_msat < (real_dust_limit_timeout_sat as i64) * 1000 {
3010                                 let one_htlc_difference_msat = max_reserved_commit_tx_fee_msat - min_reserved_commit_tx_fee_msat;
3011                                 debug_assert!(one_htlc_difference_msat != 0);
3012                                 capacity_minus_commitment_fee_msat += one_htlc_difference_msat as i64;
3013                                 capacity_minus_commitment_fee_msat = cmp::min(real_dust_limit_timeout_sat as i64 * 1000 - 1, capacity_minus_commitment_fee_msat);
3014                                 available_capacity_msat = cmp::max(0, cmp::min(capacity_minus_commitment_fee_msat, available_capacity_msat as i64)) as u64;
3015                         } else {
3016                                 available_capacity_msat = capacity_minus_commitment_fee_msat as u64;
3017                         }
3018                 } else {
3019                         // If the channel is inbound (i.e. counterparty pays the fee), we need to make sure
3020                         // sending a new HTLC won't reduce their balance below our reserve threshold.
3021                         let mut real_dust_limit_success_sat = context.counterparty_dust_limit_satoshis;
3022                         if !context.get_channel_type().supports_anchors_zero_fee_htlc_tx() {
3023                                 real_dust_limit_success_sat += context.feerate_per_kw as u64 * htlc_success_tx_weight(context.get_channel_type()) / 1000;
3024                         }
3025
3026                         let htlc_above_dust = HTLCCandidate::new(real_dust_limit_success_sat * 1000, HTLCInitiator::LocalOffered);
3027                         let max_reserved_commit_tx_fee_msat = context.next_remote_commit_tx_fee_msat(htlc_above_dust, None);
3028
3029                         let holder_selected_chan_reserve_msat = context.holder_selected_channel_reserve_satoshis * 1000;
3030                         let remote_balance_msat = (context.channel_value_satoshis * 1000 - context.value_to_self_msat)
3031                                 .saturating_sub(htlc_stats.pending_inbound_htlcs_value_msat);
3032
3033                         if remote_balance_msat < max_reserved_commit_tx_fee_msat + holder_selected_chan_reserve_msat + anchor_outputs_value_msat {
3034                                 // If another HTLC's fee would reduce the remote's balance below the reserve limit
3035                                 // we've selected for them, we can only send dust HTLCs.
3036                                 available_capacity_msat = cmp::min(available_capacity_msat, real_dust_limit_success_sat * 1000 - 1);
3037                         }
3038                 }
3039
3040                 let mut next_outbound_htlc_minimum_msat = context.counterparty_htlc_minimum_msat;
3041
3042                 // If we get close to our maximum dust exposure, we end up in a situation where we can send
3043                 // between zero and the remaining dust exposure limit remaining OR above the dust limit.
3044                 // Because we cannot express this as a simple min/max, we prefer to tell the user they can
3045                 // send above the dust limit (as the router can always overpay to meet the dust limit).
3046                 let mut remaining_msat_below_dust_exposure_limit = None;
3047                 let mut dust_exposure_dust_limit_msat = 0;
3048                 let max_dust_htlc_exposure_msat = context.get_max_dust_htlc_exposure_msat(dust_exposure_limiting_feerate);
3049
3050                 let (htlc_success_dust_limit, htlc_timeout_dust_limit) = if context.get_channel_type().supports_anchors_zero_fee_htlc_tx() {
3051                         (context.counterparty_dust_limit_satoshis, context.holder_dust_limit_satoshis)
3052                 } else {
3053                         let dust_buffer_feerate = context.get_dust_buffer_feerate(None) as u64;
3054                         (context.counterparty_dust_limit_satoshis + dust_buffer_feerate * htlc_success_tx_weight(context.get_channel_type()) / 1000,
3055                          context.holder_dust_limit_satoshis       + dust_buffer_feerate * htlc_timeout_tx_weight(context.get_channel_type()) / 1000)
3056                 };
3057
3058                 let excess_feerate_opt = self.feerate_per_kw.checked_sub(dust_exposure_limiting_feerate);
3059                 if let Some(excess_feerate) = excess_feerate_opt {
3060                         let htlc_dust_exposure_msat =
3061                                 per_outbound_htlc_counterparty_commit_tx_fee_msat(excess_feerate, &context.channel_type);
3062                         let nondust_htlc_counterparty_tx_dust_exposure =
3063                                 htlc_stats.on_counterparty_tx_dust_exposure_msat.saturating_add(htlc_dust_exposure_msat);
3064                         if nondust_htlc_counterparty_tx_dust_exposure > max_dust_htlc_exposure_msat {
3065                                 // If adding an extra HTLC would put us over the dust limit in total fees, we cannot
3066                                 // send any non-dust HTLCs.
3067                                 available_capacity_msat = cmp::min(available_capacity_msat, htlc_success_dust_limit * 1000);
3068                         }
3069                 }
3070
3071                 if htlc_stats.on_counterparty_tx_dust_exposure_msat.saturating_add(htlc_success_dust_limit * 1000) > max_dust_htlc_exposure_msat.saturating_add(1) {
3072                         // Note that we don't use the `counterparty_tx_dust_exposure` (with
3073                         // `htlc_dust_exposure_msat`) here as it only applies to non-dust HTLCs.
3074                         remaining_msat_below_dust_exposure_limit =
3075                                 Some(max_dust_htlc_exposure_msat.saturating_sub(htlc_stats.on_counterparty_tx_dust_exposure_msat));
3076                         dust_exposure_dust_limit_msat = cmp::max(dust_exposure_dust_limit_msat, htlc_success_dust_limit * 1000);
3077                 }
3078
3079                 if htlc_stats.on_holder_tx_dust_exposure_msat as i64 + htlc_timeout_dust_limit as i64 * 1000 - 1 > max_dust_htlc_exposure_msat.try_into().unwrap_or(i64::max_value()) {
3080                         remaining_msat_below_dust_exposure_limit = Some(cmp::min(
3081                                 remaining_msat_below_dust_exposure_limit.unwrap_or(u64::max_value()),
3082                                 max_dust_htlc_exposure_msat.saturating_sub(htlc_stats.on_holder_tx_dust_exposure_msat)));
3083                         dust_exposure_dust_limit_msat = cmp::max(dust_exposure_dust_limit_msat, htlc_timeout_dust_limit * 1000);
3084                 }
3085
3086                 if let Some(remaining_limit_msat) = remaining_msat_below_dust_exposure_limit {
3087                         if available_capacity_msat < dust_exposure_dust_limit_msat {
3088                                 available_capacity_msat = cmp::min(available_capacity_msat, remaining_limit_msat);
3089                         } else {
3090                                 next_outbound_htlc_minimum_msat = cmp::max(next_outbound_htlc_minimum_msat, dust_exposure_dust_limit_msat);
3091                         }
3092                 }
3093
3094                 available_capacity_msat = cmp::min(available_capacity_msat,
3095                         context.counterparty_max_htlc_value_in_flight_msat - htlc_stats.pending_outbound_htlcs_value_msat);
3096
3097                 if htlc_stats.pending_outbound_htlcs + 1 > context.counterparty_max_accepted_htlcs as usize {
3098                         available_capacity_msat = 0;
3099                 }
3100
3101                 AvailableBalances {
3102                         inbound_capacity_msat: cmp::max(context.channel_value_satoshis as i64 * 1000
3103                                         - context.value_to_self_msat as i64
3104                                         - htlc_stats.pending_inbound_htlcs_value_msat as i64
3105                                         - context.holder_selected_channel_reserve_satoshis as i64 * 1000,
3106                                 0) as u64,
3107                         outbound_capacity_msat,
3108                         next_outbound_htlc_limit_msat: available_capacity_msat,
3109                         next_outbound_htlc_minimum_msat,
3110                         balance_msat,
3111                 }
3112         }
3113
3114         pub fn get_holder_counterparty_selected_channel_reserve_satoshis(&self) -> (u64, Option<u64>) {
3115                 let context = &self;
3116                 (context.holder_selected_channel_reserve_satoshis, context.counterparty_selected_channel_reserve_satoshis)
3117         }
3118
3119         /// Get the commitment tx fee for the local's (i.e. our) next commitment transaction based on the
3120         /// number of pending HTLCs that are on track to be in our next commitment tx.
3121         ///
3122         /// Optionally includes the `HTLCCandidate` given by `htlc` and an additional non-dust HTLC if
3123         /// `fee_spike_buffer_htlc` is `Some`.
3124         ///
3125         /// The first extra HTLC is useful for determining whether we can accept a further HTLC, the
3126         /// second allows for creating a buffer to ensure a further HTLC can always be accepted/added.
3127         ///
3128         /// Dust HTLCs are excluded.
3129         fn next_local_commit_tx_fee_msat(&self, htlc: HTLCCandidate, fee_spike_buffer_htlc: Option<()>) -> u64 {
3130                 let context = &self;
3131                 assert!(context.is_outbound());
3132
3133                 let (htlc_success_dust_limit, htlc_timeout_dust_limit) = if context.get_channel_type().supports_anchors_zero_fee_htlc_tx() {
3134                         (0, 0)
3135                 } else {
3136                         (context.feerate_per_kw as u64 * htlc_success_tx_weight(context.get_channel_type()) / 1000,
3137                                 context.feerate_per_kw as u64 * htlc_timeout_tx_weight(context.get_channel_type()) / 1000)
3138                 };
3139                 let real_dust_limit_success_sat = htlc_success_dust_limit + context.holder_dust_limit_satoshis;
3140                 let real_dust_limit_timeout_sat = htlc_timeout_dust_limit + context.holder_dust_limit_satoshis;
3141
3142                 let mut addl_htlcs = 0;
3143                 if fee_spike_buffer_htlc.is_some() { addl_htlcs += 1; }
3144                 match htlc.origin {
3145                         HTLCInitiator::LocalOffered => {
3146                                 if htlc.amount_msat / 1000 >= real_dust_limit_timeout_sat {
3147                                         addl_htlcs += 1;
3148                                 }
3149                         },
3150                         HTLCInitiator::RemoteOffered => {
3151                                 if htlc.amount_msat / 1000 >= real_dust_limit_success_sat {
3152                                         addl_htlcs += 1;
3153                                 }
3154                         }
3155                 }
3156
3157                 let mut included_htlcs = 0;
3158                 for ref htlc in context.pending_inbound_htlcs.iter() {
3159                         if htlc.amount_msat / 1000 < real_dust_limit_success_sat {
3160                                 continue
3161                         }
3162                         // We include LocalRemoved HTLCs here because we may still need to broadcast a commitment
3163                         // transaction including this HTLC if it times out before they RAA.
3164                         included_htlcs += 1;
3165                 }
3166
3167                 for ref htlc in context.pending_outbound_htlcs.iter() {
3168                         if htlc.amount_msat / 1000 < real_dust_limit_timeout_sat {
3169                                 continue
3170                         }
3171                         match htlc.state {
3172                                 OutboundHTLCState::LocalAnnounced {..} => included_htlcs += 1,
3173                                 OutboundHTLCState::Committed => included_htlcs += 1,
3174                                 OutboundHTLCState::RemoteRemoved {..} => included_htlcs += 1,
3175                                 // We don't include AwaitingRemoteRevokeToRemove HTLCs because our next commitment
3176                                 // transaction won't be generated until they send us their next RAA, which will mean
3177                                 // dropping any HTLCs in this state.
3178                                 _ => {},
3179                         }
3180                 }
3181
3182                 for htlc in context.holding_cell_htlc_updates.iter() {
3183                         match htlc {
3184                                 &HTLCUpdateAwaitingACK::AddHTLC { amount_msat, .. } => {
3185                                         if amount_msat / 1000 < real_dust_limit_timeout_sat {
3186                                                 continue
3187                                         }
3188                                         included_htlcs += 1
3189                                 },
3190                                 _ => {}, // Don't include claims/fails that are awaiting ack, because once we get the
3191                                          // ack we're guaranteed to never include them in commitment txs anymore.
3192                         }
3193                 }
3194
3195                 let num_htlcs = included_htlcs + addl_htlcs;
3196                 let res = commit_tx_fee_msat(context.feerate_per_kw, num_htlcs, &context.channel_type);
3197                 #[cfg(any(test, fuzzing))]
3198                 {
3199                         let mut fee = res;
3200                         if fee_spike_buffer_htlc.is_some() {
3201                                 fee = commit_tx_fee_msat(context.feerate_per_kw, num_htlcs - 1, &context.channel_type);
3202                         }
3203                         let total_pending_htlcs = context.pending_inbound_htlcs.len() + context.pending_outbound_htlcs.len()
3204                                 + context.holding_cell_htlc_updates.len();
3205                         let commitment_tx_info = CommitmentTxInfoCached {
3206                                 fee,
3207                                 total_pending_htlcs,
3208                                 next_holder_htlc_id: match htlc.origin {
3209                                         HTLCInitiator::LocalOffered => context.next_holder_htlc_id + 1,
3210                                         HTLCInitiator::RemoteOffered => context.next_holder_htlc_id,
3211                                 },
3212                                 next_counterparty_htlc_id: match htlc.origin {
3213                                         HTLCInitiator::LocalOffered => context.next_counterparty_htlc_id,
3214                                         HTLCInitiator::RemoteOffered => context.next_counterparty_htlc_id + 1,
3215                                 },
3216                                 feerate: context.feerate_per_kw,
3217                         };
3218                         *context.next_local_commitment_tx_fee_info_cached.lock().unwrap() = Some(commitment_tx_info);
3219                 }
3220                 res
3221         }
3222
3223         /// Get the commitment tx fee for the remote's next commitment transaction based on the number of
3224         /// pending HTLCs that are on track to be in their next commitment tx
3225         ///
3226         /// Optionally includes the `HTLCCandidate` given by `htlc` and an additional non-dust HTLC if
3227         /// `fee_spike_buffer_htlc` is `Some`.
3228         ///
3229         /// The first extra HTLC is useful for determining whether we can accept a further HTLC, the
3230         /// second allows for creating a buffer to ensure a further HTLC can always be accepted/added.
3231         ///
3232         /// Dust HTLCs are excluded.
3233         fn next_remote_commit_tx_fee_msat(&self, htlc: HTLCCandidate, fee_spike_buffer_htlc: Option<()>) -> u64 {
3234                 let context = &self;
3235                 assert!(!context.is_outbound());
3236
3237                 let (htlc_success_dust_limit, htlc_timeout_dust_limit) = if context.get_channel_type().supports_anchors_zero_fee_htlc_tx() {
3238                         (0, 0)
3239                 } else {
3240                         (context.feerate_per_kw as u64 * htlc_success_tx_weight(context.get_channel_type()) / 1000,
3241                                 context.feerate_per_kw as u64 * htlc_timeout_tx_weight(context.get_channel_type()) / 1000)
3242                 };
3243                 let real_dust_limit_success_sat = htlc_success_dust_limit + context.counterparty_dust_limit_satoshis;
3244                 let real_dust_limit_timeout_sat = htlc_timeout_dust_limit + context.counterparty_dust_limit_satoshis;
3245
3246                 let mut addl_htlcs = 0;
3247                 if fee_spike_buffer_htlc.is_some() { addl_htlcs += 1; }
3248                 match htlc.origin {
3249                         HTLCInitiator::LocalOffered => {
3250                                 if htlc.amount_msat / 1000 >= real_dust_limit_success_sat {
3251                                         addl_htlcs += 1;
3252                                 }
3253                         },
3254                         HTLCInitiator::RemoteOffered => {
3255                                 if htlc.amount_msat / 1000 >= real_dust_limit_timeout_sat {
3256                                         addl_htlcs += 1;
3257                                 }
3258                         }
3259                 }
3260
3261                 // When calculating the set of HTLCs which will be included in their next commitment_signed, all
3262                 // non-dust inbound HTLCs are included (as all states imply it will be included) and only
3263                 // committed outbound HTLCs, see below.
3264                 let mut included_htlcs = 0;
3265                 for ref htlc in context.pending_inbound_htlcs.iter() {
3266                         if htlc.amount_msat / 1000 <= real_dust_limit_timeout_sat {
3267                                 continue
3268                         }
3269                         included_htlcs += 1;
3270                 }
3271
3272                 for ref htlc in context.pending_outbound_htlcs.iter() {
3273                         if htlc.amount_msat / 1000 <= real_dust_limit_success_sat {
3274                                 continue
3275                         }
3276                         // We only include outbound HTLCs if it will not be included in their next commitment_signed,
3277                         // i.e. if they've responded to us with an RAA after announcement.
3278                         match htlc.state {
3279                                 OutboundHTLCState::Committed => included_htlcs += 1,
3280                                 OutboundHTLCState::RemoteRemoved {..} => included_htlcs += 1,
3281                                 OutboundHTLCState::LocalAnnounced { .. } => included_htlcs += 1,
3282                                 _ => {},
3283                         }
3284                 }
3285
3286                 let num_htlcs = included_htlcs + addl_htlcs;
3287                 let res = commit_tx_fee_msat(context.feerate_per_kw, num_htlcs, &context.channel_type);
3288                 #[cfg(any(test, fuzzing))]
3289                 {
3290                         let mut fee = res;
3291                         if fee_spike_buffer_htlc.is_some() {
3292                                 fee = commit_tx_fee_msat(context.feerate_per_kw, num_htlcs - 1, &context.channel_type);
3293                         }
3294                         let total_pending_htlcs = context.pending_inbound_htlcs.len() + context.pending_outbound_htlcs.len();
3295                         let commitment_tx_info = CommitmentTxInfoCached {
3296                                 fee,
3297                                 total_pending_htlcs,
3298                                 next_holder_htlc_id: match htlc.origin {
3299                                         HTLCInitiator::LocalOffered => context.next_holder_htlc_id + 1,
3300                                         HTLCInitiator::RemoteOffered => context.next_holder_htlc_id,
3301                                 },
3302                                 next_counterparty_htlc_id: match htlc.origin {
3303                                         HTLCInitiator::LocalOffered => context.next_counterparty_htlc_id,
3304                                         HTLCInitiator::RemoteOffered => context.next_counterparty_htlc_id + 1,
3305                                 },
3306                                 feerate: context.feerate_per_kw,
3307                         };
3308                         *context.next_remote_commitment_tx_fee_info_cached.lock().unwrap() = Some(commitment_tx_info);
3309                 }
3310                 res
3311         }
3312
3313         fn if_unbroadcasted_funding<F, O>(&self, f: F) -> Option<O> where F: Fn() -> Option<O> {
3314                 match self.channel_state {
3315                         ChannelState::FundingNegotiated => f(),
3316                         ChannelState::AwaitingChannelReady(flags) =>
3317                                 if flags.is_set(AwaitingChannelReadyFlags::WAITING_FOR_BATCH) ||
3318                                         flags.is_set(FundedStateFlags::MONITOR_UPDATE_IN_PROGRESS.into())
3319                                 {
3320                                         f()
3321                                 } else {
3322                                         None
3323                                 },
3324                         _ => None,
3325                 }
3326         }
3327
3328         /// Returns the transaction if there is a pending funding transaction that is yet to be
3329         /// broadcast.
3330         pub fn unbroadcasted_funding(&self) -> Option<Transaction> {
3331                 self.if_unbroadcasted_funding(|| self.funding_transaction.clone())
3332         }
3333
3334         /// Returns the transaction ID if there is a pending funding transaction that is yet to be
3335         /// broadcast.
3336         pub fn unbroadcasted_funding_txid(&self) -> Option<Txid> {
3337                 self.if_unbroadcasted_funding(||
3338                         self.channel_transaction_parameters.funding_outpoint.map(|txo| txo.txid)
3339                 )
3340         }
3341
3342         /// Returns whether the channel is funded in a batch.
3343         pub fn is_batch_funding(&self) -> bool {
3344                 self.is_batch_funding.is_some()
3345         }
3346
3347         /// Returns the transaction ID if there is a pending batch funding transaction that is yet to be
3348         /// broadcast.
3349         pub fn unbroadcasted_batch_funding_txid(&self) -> Option<Txid> {
3350                 self.unbroadcasted_funding_txid().filter(|_| self.is_batch_funding())
3351         }
3352
3353         /// Gets the latest commitment transaction and any dependent transactions for relay (forcing
3354         /// shutdown of this channel - no more calls into this Channel may be made afterwards except
3355         /// those explicitly stated to be allowed after shutdown completes, eg some simple getters).
3356         /// Also returns the list of payment_hashes for channels which we can safely fail backwards
3357         /// immediately (others we will have to allow to time out).
3358         pub fn force_shutdown(&mut self, should_broadcast: bool, closure_reason: ClosureReason) -> ShutdownResult {
3359                 // Note that we MUST only generate a monitor update that indicates force-closure - we're
3360                 // called during initialization prior to the chain_monitor in the encompassing ChannelManager
3361                 // being fully configured in some cases. Thus, its likely any monitor events we generate will
3362                 // be delayed in being processed! See the docs for `ChannelManagerReadArgs` for more.
3363                 assert!(!matches!(self.channel_state, ChannelState::ShutdownComplete));
3364
3365                 // We go ahead and "free" any holding cell HTLCs or HTLCs we haven't yet committed to and
3366                 // return them to fail the payment.
3367                 let mut dropped_outbound_htlcs = Vec::with_capacity(self.holding_cell_htlc_updates.len());
3368                 let counterparty_node_id = self.get_counterparty_node_id();
3369                 for htlc_update in self.holding_cell_htlc_updates.drain(..) {
3370                         match htlc_update {
3371                                 HTLCUpdateAwaitingACK::AddHTLC { source, payment_hash, .. } => {
3372                                         dropped_outbound_htlcs.push((source, payment_hash, counterparty_node_id, self.channel_id));
3373                                 },
3374                                 _ => {}
3375                         }
3376                 }
3377                 let monitor_update = if let Some(funding_txo) = self.get_funding_txo() {
3378                         // If we haven't yet exchanged funding signatures (ie channel_state < AwaitingChannelReady),
3379                         // returning a channel monitor update here would imply a channel monitor update before
3380                         // we even registered the channel monitor to begin with, which is invalid.
3381                         // Thus, if we aren't actually at a point where we could conceivably broadcast the
3382                         // funding transaction, don't return a funding txo (which prevents providing the
3383                         // monitor update to the user, even if we return one).
3384                         // See test_duplicate_chan_id and test_pre_lockin_no_chan_closed_update for more.
3385                         if !self.channel_state.is_pre_funded_state() {
3386                                 self.latest_monitor_update_id = CLOSED_CHANNEL_UPDATE_ID;
3387                                 Some((self.get_counterparty_node_id(), funding_txo, self.channel_id(), ChannelMonitorUpdate {
3388                                         update_id: self.latest_monitor_update_id,
3389                                         counterparty_node_id: Some(self.counterparty_node_id),
3390                                         updates: vec![ChannelMonitorUpdateStep::ChannelForceClosed { should_broadcast }],
3391                                         channel_id: Some(self.channel_id()),
3392                                 }))
3393                         } else { None }
3394                 } else { None };
3395                 let unbroadcasted_batch_funding_txid = self.unbroadcasted_batch_funding_txid();
3396                 let unbroadcasted_funding_tx = self.unbroadcasted_funding();
3397
3398                 self.channel_state = ChannelState::ShutdownComplete;
3399                 self.update_time_counter += 1;
3400                 ShutdownResult {
3401                         closure_reason,
3402                         monitor_update,
3403                         dropped_outbound_htlcs,
3404                         unbroadcasted_batch_funding_txid,
3405                         channel_id: self.channel_id,
3406                         user_channel_id: self.user_id,
3407                         channel_capacity_satoshis: self.channel_value_satoshis,
3408                         counterparty_node_id: self.counterparty_node_id,
3409                         unbroadcasted_funding_tx,
3410                         channel_funding_txo: self.get_funding_txo(),
3411                 }
3412         }
3413
3414         /// Only allowed after [`Self::channel_transaction_parameters`] is set.
3415         fn get_funding_signed_msg<L: Deref>(&mut self, logger: &L) -> (CommitmentTransaction, Option<msgs::FundingSigned>) where L::Target: Logger {
3416                 let counterparty_keys = self.build_remote_transaction_keys();
3417                 let counterparty_initial_commitment_tx = self.build_commitment_transaction(self.cur_counterparty_commitment_transaction_number + 1, &counterparty_keys, false, false, logger).tx;
3418
3419                 let counterparty_trusted_tx = counterparty_initial_commitment_tx.trust();
3420                 let counterparty_initial_bitcoin_tx = counterparty_trusted_tx.built_transaction();
3421                 log_trace!(logger, "Initial counterparty tx for channel {} is: txid {} tx {}",
3422                         &self.channel_id(), counterparty_initial_bitcoin_tx.txid, encode::serialize_hex(&counterparty_initial_bitcoin_tx.transaction));
3423
3424                 match &self.holder_signer {
3425                         // TODO (arik): move match into calling method for Taproot
3426                         ChannelSignerType::Ecdsa(ecdsa) => {
3427                                 let funding_signed = ecdsa.sign_counterparty_commitment(&counterparty_initial_commitment_tx, Vec::new(), Vec::new(), &self.secp_ctx)
3428                                         .map(|(signature, _)| msgs::FundingSigned {
3429                                                 channel_id: self.channel_id(),
3430                                                 signature,
3431                                                 #[cfg(taproot)]
3432                                                 partial_signature_with_nonce: None,
3433                                         })
3434                                         .ok();
3435
3436                                 if funding_signed.is_none() {
3437                                         #[cfg(not(async_signing))] {
3438                                                 panic!("Failed to get signature for funding_signed");
3439                                         }
3440                                         #[cfg(async_signing)] {
3441                                                 log_trace!(logger, "Counterparty commitment signature not available for funding_signed message; setting signer_pending_funding");
3442                                                 self.signer_pending_funding = true;
3443                                         }
3444                                 } else if self.signer_pending_funding {
3445                                         log_trace!(logger, "Counterparty commitment signature available for funding_signed message; clearing signer_pending_funding");
3446                                         self.signer_pending_funding = false;
3447                                 }
3448
3449                                 // We sign "counterparty" commitment transaction, allowing them to broadcast the tx if they wish.
3450                                 (counterparty_initial_commitment_tx, funding_signed)
3451                         },
3452                         // TODO (taproot|arik)
3453                         #[cfg(taproot)]
3454                         _ => todo!()
3455                 }
3456         }
3457
3458         /// If we receive an error message when attempting to open a channel, it may only be a rejection
3459         /// of the channel type we tried, not of our ability to open any channel at all. We can see if a
3460         /// downgrade of channel features would be possible so that we can still open the channel.
3461         pub(crate) fn maybe_downgrade_channel_features<F: Deref>(
3462                 &mut self, fee_estimator: &LowerBoundedFeeEstimator<F>
3463         ) -> Result<(), ()>
3464         where
3465                 F::Target: FeeEstimator
3466         {
3467                 if !self.is_outbound() ||
3468                         !matches!(
3469                                 self.channel_state, ChannelState::NegotiatingFunding(flags)
3470                                 if flags == NegotiatingFundingFlags::OUR_INIT_SENT
3471                         )
3472                 {
3473                         return Err(());
3474                 }
3475                 if self.channel_type == ChannelTypeFeatures::only_static_remote_key() {
3476                         // We've exhausted our options
3477                         return Err(());
3478                 }
3479                 // We support opening a few different types of channels. Try removing our additional
3480                 // features one by one until we've either arrived at our default or the counterparty has
3481                 // accepted one.
3482                 //
3483                 // Due to the order below, we may not negotiate `option_anchors_zero_fee_htlc_tx` if the
3484                 // counterparty doesn't support `option_scid_privacy`. Since `get_initial_channel_type`
3485                 // checks whether the counterparty supports every feature, this would only happen if the
3486                 // counterparty is advertising the feature, but rejecting channels proposing the feature for
3487                 // whatever reason.
3488                 if self.channel_type.supports_anchors_zero_fee_htlc_tx() {
3489                         self.channel_type.clear_anchors_zero_fee_htlc_tx();
3490                         self.feerate_per_kw = fee_estimator.bounded_sat_per_1000_weight(ConfirmationTarget::NonAnchorChannelFee);
3491                         assert!(!self.channel_transaction_parameters.channel_type_features.supports_anchors_nonzero_fee_htlc_tx());
3492                 } else if self.channel_type.supports_scid_privacy() {
3493                         self.channel_type.clear_scid_privacy();
3494                 } else {
3495                         self.channel_type = ChannelTypeFeatures::only_static_remote_key();
3496                 }
3497                 self.channel_transaction_parameters.channel_type_features = self.channel_type.clone();
3498                 Ok(())
3499         }
3500 }
3501
3502 // Internal utility functions for channels
3503
3504 /// Returns the value to use for `holder_max_htlc_value_in_flight_msat` as a percentage of the
3505 /// `channel_value_satoshis` in msat, set through
3506 /// [`ChannelHandshakeConfig::max_inbound_htlc_value_in_flight_percent_of_channel`]
3507 ///
3508 /// The effective percentage is lower bounded by 1% and upper bounded by 100%.
3509 ///
3510 /// [`ChannelHandshakeConfig::max_inbound_htlc_value_in_flight_percent_of_channel`]: crate::util::config::ChannelHandshakeConfig::max_inbound_htlc_value_in_flight_percent_of_channel
3511 fn get_holder_max_htlc_value_in_flight_msat(channel_value_satoshis: u64, config: &ChannelHandshakeConfig) -> u64 {
3512         let configured_percent = if config.max_inbound_htlc_value_in_flight_percent_of_channel < 1 {
3513                 1
3514         } else if config.max_inbound_htlc_value_in_flight_percent_of_channel > 100 {
3515                 100
3516         } else {
3517                 config.max_inbound_htlc_value_in_flight_percent_of_channel as u64
3518         };
3519         channel_value_satoshis * 10 * configured_percent
3520 }
3521
3522 /// Returns a minimum channel reserve value the remote needs to maintain,
3523 /// required by us according to the configured or default
3524 /// [`ChannelHandshakeConfig::their_channel_reserve_proportional_millionths`]
3525 ///
3526 /// Guaranteed to return a value no larger than channel_value_satoshis
3527 ///
3528 /// This is used both for outbound and inbound channels and has lower bound
3529 /// of `MIN_THEIR_CHAN_RESERVE_SATOSHIS`.
3530 pub(crate) fn get_holder_selected_channel_reserve_satoshis(channel_value_satoshis: u64, config: &UserConfig) -> u64 {
3531         let calculated_reserve = channel_value_satoshis.saturating_mul(config.channel_handshake_config.their_channel_reserve_proportional_millionths as u64) / 1_000_000;
3532         cmp::min(channel_value_satoshis, cmp::max(calculated_reserve, MIN_THEIR_CHAN_RESERVE_SATOSHIS))
3533 }
3534
3535 /// This is for legacy reasons, present for forward-compatibility.
3536 /// LDK versions older than 0.0.104 don't know how read/handle values other than default
3537 /// from storage. Hence, we use this function to not persist default values of
3538 /// `holder_selected_channel_reserve_satoshis` for channels into storage.
3539 pub(crate) fn get_legacy_default_holder_selected_channel_reserve_satoshis(channel_value_satoshis: u64) -> u64 {
3540         let (q, _) = channel_value_satoshis.overflowing_div(100);
3541         cmp::min(channel_value_satoshis, cmp::max(q, 1000))
3542 }
3543
3544 /// Returns a minimum channel reserve value each party needs to maintain, fixed in the spec to a
3545 /// default of 1% of the total channel value.
3546 ///
3547 /// Guaranteed to return a value no larger than channel_value_satoshis
3548 ///
3549 /// This is used both for outbound and inbound channels and has lower bound
3550 /// of `dust_limit_satoshis`.
3551 #[cfg(any(dual_funding, splicing))]
3552 fn get_v2_channel_reserve_satoshis(channel_value_satoshis: u64, dust_limit_satoshis: u64) -> u64 {
3553         // Fixed at 1% of channel value by spec.
3554         let (q, _) = channel_value_satoshis.overflowing_div(100);
3555         cmp::min(channel_value_satoshis, cmp::max(q, dust_limit_satoshis))
3556 }
3557
3558 // Get the fee cost in SATS of a commitment tx with a given number of HTLC outputs.
3559 // Note that num_htlcs should not include dust HTLCs.
3560 #[inline]
3561 fn commit_tx_fee_sat(feerate_per_kw: u32, num_htlcs: usize, channel_type_features: &ChannelTypeFeatures) -> u64 {
3562         feerate_per_kw as u64 * (commitment_tx_base_weight(channel_type_features) + num_htlcs as u64 * COMMITMENT_TX_WEIGHT_PER_HTLC) / 1000
3563 }
3564
3565 // Get the fee cost in MSATS of a commitment tx with a given number of HTLC outputs.
3566 // Note that num_htlcs should not include dust HTLCs.
3567 pub(crate) fn commit_tx_fee_msat(feerate_per_kw: u32, num_htlcs: usize, channel_type_features: &ChannelTypeFeatures) -> u64 {
3568         // Note that we need to divide before multiplying to round properly,
3569         // since the lowest denomination of bitcoin on-chain is the satoshi.
3570         (commitment_tx_base_weight(channel_type_features) + num_htlcs as u64 * COMMITMENT_TX_WEIGHT_PER_HTLC) * feerate_per_kw as u64 / 1000 * 1000
3571 }
3572
3573 pub(crate) fn per_outbound_htlc_counterparty_commit_tx_fee_msat(feerate_per_kw: u32, channel_type_features: &ChannelTypeFeatures) -> u64 {
3574         // Note that we need to divide before multiplying to round properly,
3575         // since the lowest denomination of bitcoin on-chain is the satoshi.
3576         let commitment_tx_fee = COMMITMENT_TX_WEIGHT_PER_HTLC * feerate_per_kw as u64 / 1000 * 1000;
3577         if channel_type_features.supports_anchors_zero_fee_htlc_tx() {
3578                 commitment_tx_fee + htlc_success_tx_weight(channel_type_features) * feerate_per_kw as u64 / 1000
3579         } else {
3580                 commitment_tx_fee
3581         }
3582 }
3583
3584 /// Context for dual-funded channels.
3585 #[cfg(any(dual_funding, splicing))]
3586 pub(super) struct DualFundingChannelContext {
3587         /// The amount in satoshis we will be contributing to the channel.
3588         pub our_funding_satoshis: u64,
3589         /// The amount in satoshis our counterparty will be contributing to the channel.
3590         pub their_funding_satoshis: u64,
3591         /// The funding transaction locktime suggested by the initiator. If set by us, it is always set
3592         /// to the current block height to align incentives against fee-sniping.
3593         pub funding_tx_locktime: u32,
3594         /// The feerate set by the initiator to be used for the funding transaction.
3595         pub funding_feerate_sat_per_1000_weight: u32,
3596 }
3597
3598 // Holder designates channel data owned for the benefit of the user client.
3599 // Counterparty designates channel data owned by the another channel participant entity.
3600 pub(super) struct Channel<SP: Deref> where SP::Target: SignerProvider {
3601         pub context: ChannelContext<SP>,
3602         #[cfg(any(dual_funding, splicing))]
3603         pub dual_funding_channel_context: Option<DualFundingChannelContext>,
3604 }
3605
3606 #[cfg(any(test, fuzzing))]
3607 struct CommitmentTxInfoCached {
3608         fee: u64,
3609         total_pending_htlcs: usize,
3610         next_holder_htlc_id: u64,
3611         next_counterparty_htlc_id: u64,
3612         feerate: u32,
3613 }
3614
3615 /// Contents of a wire message that fails an HTLC backwards. Useful for [`Channel::fail_htlc`] to
3616 /// fail with either [`msgs::UpdateFailMalformedHTLC`] or [`msgs::UpdateFailHTLC`] as needed.
3617 trait FailHTLCContents {
3618         type Message: FailHTLCMessageName;
3619         fn to_message(self, htlc_id: u64, channel_id: ChannelId) -> Self::Message;
3620         fn to_inbound_htlc_state(self) -> InboundHTLCState;
3621         fn to_htlc_update_awaiting_ack(self, htlc_id: u64) -> HTLCUpdateAwaitingACK;
3622 }
3623 impl FailHTLCContents for msgs::OnionErrorPacket {
3624         type Message = msgs::UpdateFailHTLC;
3625         fn to_message(self, htlc_id: u64, channel_id: ChannelId) -> Self::Message {
3626                 msgs::UpdateFailHTLC { htlc_id, channel_id, reason: self }
3627         }
3628         fn to_inbound_htlc_state(self) -> InboundHTLCState {
3629                 InboundHTLCState::LocalRemoved(InboundHTLCRemovalReason::FailRelay(self))
3630         }
3631         fn to_htlc_update_awaiting_ack(self, htlc_id: u64) -> HTLCUpdateAwaitingACK {
3632                 HTLCUpdateAwaitingACK::FailHTLC { htlc_id, err_packet: self }
3633         }
3634 }
3635 impl FailHTLCContents for ([u8; 32], u16) {
3636         type Message = msgs::UpdateFailMalformedHTLC;
3637         fn to_message(self, htlc_id: u64, channel_id: ChannelId) -> Self::Message {
3638                 msgs::UpdateFailMalformedHTLC {
3639                         htlc_id,
3640                         channel_id,
3641                         sha256_of_onion: self.0,
3642                         failure_code: self.1
3643                 }
3644         }
3645         fn to_inbound_htlc_state(self) -> InboundHTLCState {
3646                 InboundHTLCState::LocalRemoved(InboundHTLCRemovalReason::FailMalformed(self))
3647         }
3648         fn to_htlc_update_awaiting_ack(self, htlc_id: u64) -> HTLCUpdateAwaitingACK {
3649                 HTLCUpdateAwaitingACK::FailMalformedHTLC {
3650                         htlc_id,
3651                         sha256_of_onion: self.0,
3652                         failure_code: self.1
3653                 }
3654         }
3655 }
3656
3657 trait FailHTLCMessageName {
3658         fn name() -> &'static str;
3659 }
3660 impl FailHTLCMessageName for msgs::UpdateFailHTLC {
3661         fn name() -> &'static str {
3662                 "update_fail_htlc"
3663         }
3664 }
3665 impl FailHTLCMessageName for msgs::UpdateFailMalformedHTLC {
3666         fn name() -> &'static str {
3667                 "update_fail_malformed_htlc"
3668         }
3669 }
3670
3671 impl<SP: Deref> Channel<SP> where
3672         SP::Target: SignerProvider,
3673         <SP::Target as SignerProvider>::EcdsaSigner: EcdsaChannelSigner
3674 {
3675         fn check_remote_fee<F: Deref, L: Deref>(
3676                 channel_type: &ChannelTypeFeatures, fee_estimator: &LowerBoundedFeeEstimator<F>,
3677                 feerate_per_kw: u32, cur_feerate_per_kw: Option<u32>, logger: &L
3678         ) -> Result<(), ChannelError> where F::Target: FeeEstimator, L::Target: Logger,
3679         {
3680                 let lower_limit_conf_target = if channel_type.supports_anchors_zero_fee_htlc_tx() {
3681                         ConfirmationTarget::MinAllowedAnchorChannelRemoteFee
3682                 } else {
3683                         ConfirmationTarget::MinAllowedNonAnchorChannelRemoteFee
3684                 };
3685                 let lower_limit = fee_estimator.bounded_sat_per_1000_weight(lower_limit_conf_target);
3686                 if feerate_per_kw < lower_limit {
3687                         if let Some(cur_feerate) = cur_feerate_per_kw {
3688                                 if feerate_per_kw > cur_feerate {
3689                                         log_warn!(logger,
3690                                                 "Accepting feerate that may prevent us from closing this channel because it's higher than what we have now. Had {} s/kW, now {} s/kW.",
3691                                                 cur_feerate, feerate_per_kw);
3692                                         return Ok(());
3693                                 }
3694                         }
3695                         return Err(ChannelError::Close(format!("Peer's feerate much too low. Actual: {}. Our expected lower limit: {}", feerate_per_kw, lower_limit)));
3696                 }
3697                 Ok(())
3698         }
3699
3700         #[inline]
3701         fn get_closing_scriptpubkey(&self) -> ScriptBuf {
3702                 // The shutdown scriptpubkey is set on channel opening when option_upfront_shutdown_script
3703                 // is signaled. Otherwise, it is set when sending a shutdown message. Calling this method
3704                 // outside of those situations will fail.
3705                 self.context.shutdown_scriptpubkey.clone().unwrap().into_inner()
3706         }
3707
3708         #[inline]
3709         fn get_closing_transaction_weight(&self, a_scriptpubkey: Option<&Script>, b_scriptpubkey: Option<&Script>) -> u64 {
3710                 let mut ret =
3711                 (4 +                                                   // version
3712                  1 +                                                   // input count
3713                  36 +                                                  // prevout
3714                  1 +                                                   // script length (0)
3715                  4 +                                                   // sequence
3716                  1 +                                                   // output count
3717                  4                                                     // lock time
3718                  )*4 +                                                 // * 4 for non-witness parts
3719                 2 +                                                    // witness marker and flag
3720                 1 +                                                    // witness element count
3721                 4 +                                                    // 4 element lengths (2 sigs, multisig dummy, and witness script)
3722                 self.context.get_funding_redeemscript().len() as u64 + // funding witness script
3723                 2*(1 + 71);                                            // two signatures + sighash type flags
3724                 if let Some(spk) = a_scriptpubkey {
3725                         ret += ((8+1) +                                    // output values and script length
3726                                 spk.len() as u64) * 4;                         // scriptpubkey and witness multiplier
3727                 }
3728                 if let Some(spk) = b_scriptpubkey {
3729                         ret += ((8+1) +                                    // output values and script length
3730                                 spk.len() as u64) * 4;                         // scriptpubkey and witness multiplier
3731                 }
3732                 ret
3733         }
3734
3735         #[inline]
3736         fn build_closing_transaction(&self, proposed_total_fee_satoshis: u64, skip_remote_output: bool) -> (ClosingTransaction, u64) {
3737                 assert!(self.context.pending_inbound_htlcs.is_empty());
3738                 assert!(self.context.pending_outbound_htlcs.is_empty());
3739                 assert!(self.context.pending_update_fee.is_none());
3740
3741                 let mut total_fee_satoshis = proposed_total_fee_satoshis;
3742                 let mut value_to_holder: i64 = (self.context.value_to_self_msat as i64) / 1000 - if self.context.is_outbound() { total_fee_satoshis as i64 } else { 0 };
3743                 let mut value_to_counterparty: i64 = ((self.context.channel_value_satoshis * 1000 - self.context.value_to_self_msat) as i64 / 1000) - if self.context.is_outbound() { 0 } else { total_fee_satoshis as i64 };
3744
3745                 if value_to_holder < 0 {
3746                         assert!(self.context.is_outbound());
3747                         total_fee_satoshis += (-value_to_holder) as u64;
3748                 } else if value_to_counterparty < 0 {
3749                         assert!(!self.context.is_outbound());
3750                         total_fee_satoshis += (-value_to_counterparty) as u64;
3751                 }
3752
3753                 if skip_remote_output || value_to_counterparty as u64 <= self.context.holder_dust_limit_satoshis {
3754                         value_to_counterparty = 0;
3755                 }
3756
3757                 if value_to_holder as u64 <= self.context.holder_dust_limit_satoshis {
3758                         value_to_holder = 0;
3759                 }
3760
3761                 assert!(self.context.shutdown_scriptpubkey.is_some());
3762                 let holder_shutdown_script = self.get_closing_scriptpubkey();
3763                 let counterparty_shutdown_script = self.context.counterparty_shutdown_scriptpubkey.clone().unwrap();
3764                 let funding_outpoint = self.funding_outpoint().into_bitcoin_outpoint();
3765
3766                 let closing_transaction = ClosingTransaction::new(value_to_holder as u64, value_to_counterparty as u64, holder_shutdown_script, counterparty_shutdown_script, funding_outpoint);
3767                 (closing_transaction, total_fee_satoshis)
3768         }
3769
3770         fn funding_outpoint(&self) -> OutPoint {
3771                 self.context.channel_transaction_parameters.funding_outpoint.unwrap()
3772         }
3773
3774         /// Claims an HTLC while we're disconnected from a peer, dropping the [`ChannelMonitorUpdate`]
3775         /// entirely.
3776         ///
3777         /// The [`ChannelMonitor`] for this channel MUST be updated out-of-band with the preimage
3778         /// provided (i.e. without calling [`crate::chain::Watch::update_channel`]).
3779         ///
3780         /// The HTLC claim will end up in the holding cell (because the caller must ensure the peer is
3781         /// disconnected).
3782         pub fn claim_htlc_while_disconnected_dropping_mon_update<L: Deref>
3783                 (&mut self, htlc_id_arg: u64, payment_preimage_arg: PaymentPreimage, logger: &L)
3784         where L::Target: Logger {
3785                 // Assert that we'll add the HTLC claim to the holding cell in `get_update_fulfill_htlc`
3786                 // (see equivalent if condition there).
3787                 assert!(!self.context.channel_state.can_generate_new_commitment());
3788                 let mon_update_id = self.context.latest_monitor_update_id; // Forget the ChannelMonitor update
3789                 let fulfill_resp = self.get_update_fulfill_htlc(htlc_id_arg, payment_preimage_arg, logger);
3790                 self.context.latest_monitor_update_id = mon_update_id;
3791                 if let UpdateFulfillFetch::NewClaim { msg, .. } = fulfill_resp {
3792                         assert!(msg.is_none()); // The HTLC must have ended up in the holding cell.
3793                 }
3794         }
3795
3796         fn get_update_fulfill_htlc<L: Deref>(&mut self, htlc_id_arg: u64, payment_preimage_arg: PaymentPreimage, logger: &L) -> UpdateFulfillFetch where L::Target: Logger {
3797                 // Either ChannelReady got set (which means it won't be unset) or there is no way any
3798                 // caller thought we could have something claimed (cause we wouldn't have accepted in an
3799                 // incoming HTLC anyway). If we got to ShutdownComplete, callers aren't allowed to call us,
3800                 // either.
3801                 if !matches!(self.context.channel_state, ChannelState::ChannelReady(_)) {
3802                         panic!("Was asked to fulfill an HTLC when channel was not in an operational state");
3803                 }
3804
3805                 // ChannelManager may generate duplicate claims/fails due to HTLC update events from
3806                 // on-chain ChannelsMonitors during block rescan. Ideally we'd figure out a way to drop
3807                 // these, but for now we just have to treat them as normal.
3808
3809                 let mut pending_idx = core::usize::MAX;
3810                 let mut htlc_value_msat = 0;
3811                 for (idx, htlc) in self.context.pending_inbound_htlcs.iter().enumerate() {
3812                         if htlc.htlc_id == htlc_id_arg {
3813                                 debug_assert_eq!(htlc.payment_hash, PaymentHash(Sha256::hash(&payment_preimage_arg.0[..]).to_byte_array()));
3814                                 log_debug!(logger, "Claiming inbound HTLC id {} with payment hash {} with preimage {}",
3815                                         htlc.htlc_id, htlc.payment_hash, payment_preimage_arg);
3816                                 match htlc.state {
3817                                         InboundHTLCState::Committed => {},
3818                                         InboundHTLCState::LocalRemoved(ref reason) => {
3819                                                 if let &InboundHTLCRemovalReason::Fulfill(_) = reason {
3820                                                 } else {
3821                                                         log_warn!(logger, "Have preimage and want to fulfill HTLC with payment hash {} we already failed against channel {}", &htlc.payment_hash, &self.context.channel_id());
3822                                                         debug_assert!(false, "Tried to fulfill an HTLC that was already failed");
3823                                                 }
3824                                                 return UpdateFulfillFetch::DuplicateClaim {};
3825                                         },
3826                                         _ => {
3827                                                 debug_assert!(false, "Have an inbound HTLC we tried to claim before it was fully committed to");
3828                                                 // Don't return in release mode here so that we can update channel_monitor
3829                                         }
3830                                 }
3831                                 pending_idx = idx;
3832                                 htlc_value_msat = htlc.amount_msat;
3833                                 break;
3834                         }
3835                 }
3836                 if pending_idx == core::usize::MAX {
3837                         #[cfg(any(test, fuzzing))]
3838                         // If we failed to find an HTLC to fulfill, make sure it was previously fulfilled and
3839                         // this is simply a duplicate claim, not previously failed and we lost funds.
3840                         debug_assert!(self.context.historical_inbound_htlc_fulfills.contains(&htlc_id_arg));
3841                         return UpdateFulfillFetch::DuplicateClaim {};
3842                 }
3843
3844                 // Now update local state:
3845                 //
3846                 // We have to put the payment_preimage in the channel_monitor right away here to ensure we
3847                 // can claim it even if the channel hits the chain before we see their next commitment.
3848                 self.context.latest_monitor_update_id += 1;
3849                 let monitor_update = ChannelMonitorUpdate {
3850                         update_id: self.context.latest_monitor_update_id,
3851                         counterparty_node_id: Some(self.context.counterparty_node_id),
3852                         updates: vec![ChannelMonitorUpdateStep::PaymentPreimage {
3853                                 payment_preimage: payment_preimage_arg.clone(),
3854                         }],
3855                         channel_id: Some(self.context.channel_id()),
3856                 };
3857
3858                 if !self.context.channel_state.can_generate_new_commitment() {
3859                         // Note that this condition is the same as the assertion in
3860                         // `claim_htlc_while_disconnected_dropping_mon_update` and must match exactly -
3861                         // `claim_htlc_while_disconnected_dropping_mon_update` would not work correctly if we
3862                         // do not not get into this branch.
3863                         for pending_update in self.context.holding_cell_htlc_updates.iter() {
3864                                 match pending_update {
3865                                         &HTLCUpdateAwaitingACK::ClaimHTLC { htlc_id, .. } => {
3866                                                 if htlc_id_arg == htlc_id {
3867                                                         // Make sure we don't leave latest_monitor_update_id incremented here:
3868                                                         self.context.latest_monitor_update_id -= 1;
3869                                                         #[cfg(any(test, fuzzing))]
3870                                                         debug_assert!(self.context.historical_inbound_htlc_fulfills.contains(&htlc_id_arg));
3871                                                         return UpdateFulfillFetch::DuplicateClaim {};
3872                                                 }
3873                                         },
3874                                         &HTLCUpdateAwaitingACK::FailHTLC { htlc_id, .. } |
3875                                                 &HTLCUpdateAwaitingACK::FailMalformedHTLC { htlc_id, .. } =>
3876                                         {
3877                                                 if htlc_id_arg == htlc_id {
3878                                                         log_warn!(logger, "Have preimage and want to fulfill HTLC with pending failure against channel {}", &self.context.channel_id());
3879                                                         // TODO: We may actually be able to switch to a fulfill here, though its
3880                                                         // rare enough it may not be worth the complexity burden.
3881                                                         debug_assert!(false, "Tried to fulfill an HTLC that was already failed");
3882                                                         return UpdateFulfillFetch::NewClaim { monitor_update, htlc_value_msat, msg: None };
3883                                                 }
3884                                         },
3885                                         _ => {}
3886                                 }
3887                         }
3888                         log_trace!(logger, "Adding HTLC claim to holding_cell in channel {}! Current state: {}", &self.context.channel_id(), self.context.channel_state.to_u32());
3889                         self.context.holding_cell_htlc_updates.push(HTLCUpdateAwaitingACK::ClaimHTLC {
3890                                 payment_preimage: payment_preimage_arg, htlc_id: htlc_id_arg,
3891                         });
3892                         #[cfg(any(test, fuzzing))]
3893                         self.context.historical_inbound_htlc_fulfills.insert(htlc_id_arg);
3894                         return UpdateFulfillFetch::NewClaim { monitor_update, htlc_value_msat, msg: None };
3895                 }
3896                 #[cfg(any(test, fuzzing))]
3897                 self.context.historical_inbound_htlc_fulfills.insert(htlc_id_arg);
3898
3899                 {
3900                         let htlc = &mut self.context.pending_inbound_htlcs[pending_idx];
3901                         if let InboundHTLCState::Committed = htlc.state {
3902                         } else {
3903                                 debug_assert!(false, "Have an inbound HTLC we tried to claim before it was fully committed to");
3904                                 return UpdateFulfillFetch::NewClaim { monitor_update, htlc_value_msat, msg: None };
3905                         }
3906                         log_trace!(logger, "Upgrading HTLC {} to LocalRemoved with a Fulfill in channel {}!", &htlc.payment_hash, &self.context.channel_id);
3907                         htlc.state = InboundHTLCState::LocalRemoved(InboundHTLCRemovalReason::Fulfill(payment_preimage_arg.clone()));
3908                 }
3909
3910                 UpdateFulfillFetch::NewClaim {
3911                         monitor_update,
3912                         htlc_value_msat,
3913                         msg: Some(msgs::UpdateFulfillHTLC {
3914                                 channel_id: self.context.channel_id(),
3915                                 htlc_id: htlc_id_arg,
3916                                 payment_preimage: payment_preimage_arg,
3917                         }),
3918                 }
3919         }
3920
3921         pub fn get_update_fulfill_htlc_and_commit<L: Deref>(&mut self, htlc_id: u64, payment_preimage: PaymentPreimage, logger: &L) -> UpdateFulfillCommitFetch where L::Target: Logger {
3922                 let release_cs_monitor = self.context.blocked_monitor_updates.is_empty();
3923                 match self.get_update_fulfill_htlc(htlc_id, payment_preimage, logger) {
3924                         UpdateFulfillFetch::NewClaim { mut monitor_update, htlc_value_msat, msg } => {
3925                                 // Even if we aren't supposed to let new monitor updates with commitment state
3926                                 // updates run, we still need to push the preimage ChannelMonitorUpdateStep no
3927                                 // matter what. Sadly, to push a new monitor update which flies before others
3928                                 // already queued, we have to insert it into the pending queue and update the
3929                                 // update_ids of all the following monitors.
3930                                 if release_cs_monitor && msg.is_some() {
3931                                         let mut additional_update = self.build_commitment_no_status_check(logger);
3932                                         // build_commitment_no_status_check may bump latest_monitor_id but we want them
3933                                         // to be strictly increasing by one, so decrement it here.
3934                                         self.context.latest_monitor_update_id = monitor_update.update_id;
3935                                         monitor_update.updates.append(&mut additional_update.updates);
3936                                 } else {
3937                                         let new_mon_id = self.context.blocked_monitor_updates.get(0)
3938                                                 .map(|upd| upd.update.update_id).unwrap_or(monitor_update.update_id);
3939                                         monitor_update.update_id = new_mon_id;
3940                                         for held_update in self.context.blocked_monitor_updates.iter_mut() {
3941                                                 held_update.update.update_id += 1;
3942                                         }
3943                                         if msg.is_some() {
3944                                                 debug_assert!(false, "If there is a pending blocked monitor we should have MonitorUpdateInProgress set");
3945                                                 let update = self.build_commitment_no_status_check(logger);
3946                                                 self.context.blocked_monitor_updates.push(PendingChannelMonitorUpdate {
3947                                                         update,
3948                                                 });
3949                                         }
3950                                 }
3951
3952                                 self.monitor_updating_paused(false, msg.is_some(), false, Vec::new(), Vec::new(), Vec::new());
3953                                 UpdateFulfillCommitFetch::NewClaim { monitor_update, htlc_value_msat, }
3954                         },
3955                         UpdateFulfillFetch::DuplicateClaim {} => UpdateFulfillCommitFetch::DuplicateClaim {},
3956                 }
3957         }
3958
3959         /// We can only have one resolution per HTLC. In some cases around reconnect, we may fulfill
3960         /// an HTLC more than once or fulfill once and then attempt to fail after reconnect. We cannot,
3961         /// however, fail more than once as we wait for an upstream failure to be irrevocably committed
3962         /// before we fail backwards.
3963         ///
3964         /// If we do fail twice, we `debug_assert!(false)` and return `Ok(None)`. Thus, this will always
3965         /// return `Ok(_)` if preconditions are met. In any case, `Err`s will only be
3966         /// [`ChannelError::Ignore`].
3967         pub fn queue_fail_htlc<L: Deref>(&mut self, htlc_id_arg: u64, err_packet: msgs::OnionErrorPacket, logger: &L)
3968         -> Result<(), ChannelError> where L::Target: Logger {
3969                 self.fail_htlc(htlc_id_arg, err_packet, true, logger)
3970                         .map(|msg_opt| assert!(msg_opt.is_none(), "We forced holding cell?"))
3971         }
3972
3973         /// Used for failing back with [`msgs::UpdateFailMalformedHTLC`]. For now, this is used when we
3974         /// want to fail blinded HTLCs where we are not the intro node.
3975         ///
3976         /// See [`Self::queue_fail_htlc`] for more info.
3977         pub fn queue_fail_malformed_htlc<L: Deref>(
3978                 &mut self, htlc_id_arg: u64, failure_code: u16, sha256_of_onion: [u8; 32], logger: &L
3979         ) -> Result<(), ChannelError> where L::Target: Logger {
3980                 self.fail_htlc(htlc_id_arg, (sha256_of_onion, failure_code), true, logger)
3981                         .map(|msg_opt| assert!(msg_opt.is_none(), "We forced holding cell?"))
3982         }
3983
3984         /// We can only have one resolution per HTLC. In some cases around reconnect, we may fulfill
3985         /// an HTLC more than once or fulfill once and then attempt to fail after reconnect. We cannot,
3986         /// however, fail more than once as we wait for an upstream failure to be irrevocably committed
3987         /// before we fail backwards.
3988         ///
3989         /// If we do fail twice, we `debug_assert!(false)` and return `Ok(None)`. Thus, this will always
3990         /// return `Ok(_)` if preconditions are met. In any case, `Err`s will only be
3991         /// [`ChannelError::Ignore`].
3992         fn fail_htlc<L: Deref, E: FailHTLCContents + Clone>(
3993                 &mut self, htlc_id_arg: u64, err_contents: E, mut force_holding_cell: bool,
3994                 logger: &L
3995         ) -> Result<Option<E::Message>, ChannelError> where L::Target: Logger {
3996                 if !matches!(self.context.channel_state, ChannelState::ChannelReady(_)) {
3997                         panic!("Was asked to fail an HTLC when channel was not in an operational state");
3998                 }
3999
4000                 // ChannelManager may generate duplicate claims/fails due to HTLC update events from
4001                 // on-chain ChannelsMonitors during block rescan. Ideally we'd figure out a way to drop
4002                 // these, but for now we just have to treat them as normal.
4003
4004                 let mut pending_idx = core::usize::MAX;
4005                 for (idx, htlc) in self.context.pending_inbound_htlcs.iter().enumerate() {
4006                         if htlc.htlc_id == htlc_id_arg {
4007                                 match htlc.state {
4008                                         InboundHTLCState::Committed => {},
4009                                         InboundHTLCState::LocalRemoved(ref reason) => {
4010                                                 if let &InboundHTLCRemovalReason::Fulfill(_) = reason {
4011                                                 } else {
4012                                                         debug_assert!(false, "Tried to fail an HTLC that was already failed");
4013                                                 }
4014                                                 return Ok(None);
4015                                         },
4016                                         _ => {
4017                                                 debug_assert!(false, "Have an inbound HTLC we tried to claim before it was fully committed to");
4018                                                 return Err(ChannelError::Ignore(format!("Unable to find a pending HTLC which matched the given HTLC ID ({})", htlc.htlc_id)));
4019                                         }
4020                                 }
4021                                 pending_idx = idx;
4022                         }
4023                 }
4024                 if pending_idx == core::usize::MAX {
4025                         #[cfg(any(test, fuzzing))]
4026                         // If we failed to find an HTLC to fail, make sure it was previously fulfilled and this
4027                         // is simply a duplicate fail, not previously failed and we failed-back too early.
4028                         debug_assert!(self.context.historical_inbound_htlc_fulfills.contains(&htlc_id_arg));
4029                         return Ok(None);
4030                 }
4031
4032                 if !self.context.channel_state.can_generate_new_commitment() {
4033                         debug_assert!(force_holding_cell, "!force_holding_cell is only called when emptying the holding cell, so we shouldn't end up back in it!");
4034                         force_holding_cell = true;
4035                 }
4036
4037                 // Now update local state:
4038                 if force_holding_cell {
4039                         for pending_update in self.context.holding_cell_htlc_updates.iter() {
4040                                 match pending_update {
4041                                         &HTLCUpdateAwaitingACK::ClaimHTLC { htlc_id, .. } => {
4042                                                 if htlc_id_arg == htlc_id {
4043                                                         #[cfg(any(test, fuzzing))]
4044                                                         debug_assert!(self.context.historical_inbound_htlc_fulfills.contains(&htlc_id_arg));
4045                                                         return Ok(None);
4046                                                 }
4047                                         },
4048                                         &HTLCUpdateAwaitingACK::FailHTLC { htlc_id, .. } |
4049                                                 &HTLCUpdateAwaitingACK::FailMalformedHTLC { htlc_id, .. } =>
4050                                         {
4051                                                 if htlc_id_arg == htlc_id {
4052                                                         debug_assert!(false, "Tried to fail an HTLC that was already failed");
4053                                                         return Err(ChannelError::Ignore("Unable to find a pending HTLC which matched the given HTLC ID".to_owned()));
4054                                                 }
4055                                         },
4056                                         _ => {}
4057                                 }
4058                         }
4059                         log_trace!(logger, "Placing failure for HTLC ID {} in holding cell in channel {}.", htlc_id_arg, &self.context.channel_id());
4060                         self.context.holding_cell_htlc_updates.push(err_contents.to_htlc_update_awaiting_ack(htlc_id_arg));
4061                         return Ok(None);
4062                 }
4063
4064                 log_trace!(logger, "Failing HTLC ID {} back with {} message in channel {}.", htlc_id_arg,
4065                         E::Message::name(), &self.context.channel_id());
4066                 {
4067                         let htlc = &mut self.context.pending_inbound_htlcs[pending_idx];
4068                         htlc.state = err_contents.clone().to_inbound_htlc_state();
4069                 }
4070
4071                 Ok(Some(err_contents.to_message(htlc_id_arg, self.context.channel_id())))
4072         }
4073
4074         // Message handlers:
4075         /// Updates the state of the channel to indicate that all channels in the batch have received
4076         /// funding_signed and persisted their monitors.
4077         /// The funding transaction is consequently allowed to be broadcast, and the channel can be
4078         /// treated as a non-batch channel going forward.
4079         pub fn set_batch_ready(&mut self) {
4080                 self.context.is_batch_funding = None;
4081                 self.context.channel_state.clear_waiting_for_batch();
4082         }
4083
4084         /// Unsets the existing funding information.
4085         ///
4086         /// This must only be used if the channel has not yet completed funding and has not been used.
4087         ///
4088         /// Further, the channel must be immediately shut down after this with a call to
4089         /// [`ChannelContext::force_shutdown`].
4090         pub fn unset_funding_info(&mut self, temporary_channel_id: ChannelId) {
4091                 debug_assert!(matches!(
4092                         self.context.channel_state, ChannelState::AwaitingChannelReady(_)
4093                 ));
4094                 self.context.channel_transaction_parameters.funding_outpoint = None;
4095                 self.context.channel_id = temporary_channel_id;
4096         }
4097
4098         /// Handles a channel_ready message from our peer. If we've already sent our channel_ready
4099         /// and the channel is now usable (and public), this may generate an announcement_signatures to
4100         /// reply with.
4101         pub fn channel_ready<NS: Deref, L: Deref>(
4102                 &mut self, msg: &msgs::ChannelReady, node_signer: &NS, chain_hash: ChainHash,
4103                 user_config: &UserConfig, best_block: &BestBlock, logger: &L
4104         ) -> Result<Option<msgs::AnnouncementSignatures>, ChannelError>
4105         where
4106                 NS::Target: NodeSigner,
4107                 L::Target: Logger
4108         {
4109                 if self.context.channel_state.is_peer_disconnected() {
4110                         self.context.workaround_lnd_bug_4006 = Some(msg.clone());
4111                         return Err(ChannelError::Ignore("Peer sent channel_ready when we needed a channel_reestablish. The peer is likely lnd, see https://github.com/lightningnetwork/lnd/issues/4006".to_owned()));
4112                 }
4113
4114                 if let Some(scid_alias) = msg.short_channel_id_alias {
4115                         if Some(scid_alias) != self.context.short_channel_id {
4116                                 // The scid alias provided can be used to route payments *from* our counterparty,
4117                                 // i.e. can be used for inbound payments and provided in invoices, but is not used
4118                                 // when routing outbound payments.
4119                                 self.context.latest_inbound_scid_alias = Some(scid_alias);
4120                         }
4121                 }
4122
4123                 // Our channel_ready shouldn't have been sent if we are waiting for other channels in the
4124                 // batch, but we can receive channel_ready messages.
4125                 let mut check_reconnection = false;
4126                 match &self.context.channel_state {
4127                         ChannelState::AwaitingChannelReady(flags) => {
4128                                 let flags = flags.clone().clear(FundedStateFlags::ALL.into());
4129                                 debug_assert!(!flags.is_set(AwaitingChannelReadyFlags::OUR_CHANNEL_READY) || !flags.is_set(AwaitingChannelReadyFlags::WAITING_FOR_BATCH));
4130                                 if flags.clone().clear(AwaitingChannelReadyFlags::WAITING_FOR_BATCH) == AwaitingChannelReadyFlags::THEIR_CHANNEL_READY {
4131                                         // If we reconnected before sending our `channel_ready` they may still resend theirs.
4132                                         check_reconnection = true;
4133                                 } else if flags.clone().clear(AwaitingChannelReadyFlags::WAITING_FOR_BATCH).is_empty() {
4134                                         self.context.channel_state.set_their_channel_ready();
4135                                 } else if flags == AwaitingChannelReadyFlags::OUR_CHANNEL_READY {
4136                                         self.context.channel_state = ChannelState::ChannelReady(self.context.channel_state.with_funded_state_flags_mask().into());
4137                                         self.context.update_time_counter += 1;
4138                                 } else {
4139                                         // We're in `WAITING_FOR_BATCH`, so we should wait until we're ready.
4140                                         debug_assert!(flags.is_set(AwaitingChannelReadyFlags::WAITING_FOR_BATCH));
4141                                 }
4142                         }
4143                         // If we reconnected before sending our `channel_ready` they may still resend theirs.
4144                         ChannelState::ChannelReady(_) => check_reconnection = true,
4145                         _ => return Err(ChannelError::Close("Peer sent a channel_ready at a strange time".to_owned())),
4146                 }
4147                 if check_reconnection {
4148                         // They probably disconnected/reconnected and re-sent the channel_ready, which is
4149                         // required, or they're sending a fresh SCID alias.
4150                         let expected_point =
4151                                 if self.context.cur_counterparty_commitment_transaction_number == INITIAL_COMMITMENT_NUMBER - 1 {
4152                                         // If they haven't ever sent an updated point, the point they send should match
4153                                         // the current one.
4154                                         self.context.counterparty_cur_commitment_point
4155                                 } else if self.context.cur_counterparty_commitment_transaction_number == INITIAL_COMMITMENT_NUMBER - 2 {
4156                                         // If we've advanced the commitment number once, the second commitment point is
4157                                         // at `counterparty_prev_commitment_point`, which is not yet revoked.
4158                                         debug_assert!(self.context.counterparty_prev_commitment_point.is_some());
4159                                         self.context.counterparty_prev_commitment_point
4160                                 } else {
4161                                         // If they have sent updated points, channel_ready is always supposed to match
4162                                         // their "first" point, which we re-derive here.
4163                                         Some(PublicKey::from_secret_key(&self.context.secp_ctx, &SecretKey::from_slice(
4164                                                         &self.context.commitment_secrets.get_secret(INITIAL_COMMITMENT_NUMBER - 1).expect("We should have all prev secrets available")
4165                                                 ).expect("We already advanced, so previous secret keys should have been validated already")))
4166                                 };
4167                         if expected_point != Some(msg.next_per_commitment_point) {
4168                                 return Err(ChannelError::Close("Peer sent a reconnect channel_ready with a different point".to_owned()));
4169                         }
4170                         return Ok(None);
4171                 }
4172
4173                 self.context.counterparty_prev_commitment_point = self.context.counterparty_cur_commitment_point;
4174                 self.context.counterparty_cur_commitment_point = Some(msg.next_per_commitment_point);
4175
4176                 log_info!(logger, "Received channel_ready from peer for channel {}", &self.context.channel_id());
4177
4178                 Ok(self.get_announcement_sigs(node_signer, chain_hash, user_config, best_block.height, logger))
4179         }
4180
4181         pub fn update_add_htlc<F: Deref>(
4182                 &mut self, msg: &msgs::UpdateAddHTLC, pending_forward_status: PendingHTLCStatus,
4183                 fee_estimator: &LowerBoundedFeeEstimator<F>,
4184         ) -> Result<(), ChannelError> where F::Target: FeeEstimator {
4185                 if !matches!(self.context.channel_state, ChannelState::ChannelReady(_)) {
4186                         return Err(ChannelError::Close("Got add HTLC message when channel was not in an operational state".to_owned()));
4187                 }
4188                 // If the remote has sent a shutdown prior to adding this HTLC, then they are in violation of the spec.
4189                 if self.context.channel_state.is_remote_shutdown_sent() {
4190                         return Err(ChannelError::Close("Got add HTLC message when channel was not in an operational state".to_owned()));
4191                 }
4192                 if self.context.channel_state.is_peer_disconnected() {
4193                         return Err(ChannelError::Close("Peer sent update_add_htlc when we needed a channel_reestablish".to_owned()));
4194                 }
4195                 if msg.amount_msat > self.context.channel_value_satoshis * 1000 {
4196                         return Err(ChannelError::Close("Remote side tried to send more than the total value of the channel".to_owned()));
4197                 }
4198                 if msg.amount_msat == 0 {
4199                         return Err(ChannelError::Close("Remote side tried to send a 0-msat HTLC".to_owned()));
4200                 }
4201                 if msg.amount_msat < self.context.holder_htlc_minimum_msat {
4202                         return Err(ChannelError::Close(format!("Remote side tried to send less than our minimum HTLC value. Lower limit: ({}). Actual: ({})", self.context.holder_htlc_minimum_msat, msg.amount_msat)));
4203                 }
4204
4205                 let dust_exposure_limiting_feerate = self.context.get_dust_exposure_limiting_feerate(&fee_estimator);
4206                 let htlc_stats = self.context.get_pending_htlc_stats(None, dust_exposure_limiting_feerate);
4207                 if htlc_stats.pending_inbound_htlcs + 1 > self.context.holder_max_accepted_htlcs as usize {
4208                         return Err(ChannelError::Close(format!("Remote tried to push more than our max accepted HTLCs ({})", self.context.holder_max_accepted_htlcs)));
4209                 }
4210                 if htlc_stats.pending_inbound_htlcs_value_msat + msg.amount_msat > self.context.holder_max_htlc_value_in_flight_msat {
4211                         return Err(ChannelError::Close(format!("Remote HTLC add would put them over our max HTLC value ({})", self.context.holder_max_htlc_value_in_flight_msat)));
4212                 }
4213
4214                 // Check holder_selected_channel_reserve_satoshis (we're getting paid, so they have to at least meet
4215                 // the reserve_satoshis we told them to always have as direct payment so that they lose
4216                 // something if we punish them for broadcasting an old state).
4217                 // Note that we don't really care about having a small/no to_remote output in our local
4218                 // commitment transactions, as the purpose of the channel reserve is to ensure we can
4219                 // punish *them* if they misbehave, so we discount any outbound HTLCs which will not be
4220                 // present in the next commitment transaction we send them (at least for fulfilled ones,
4221                 // failed ones won't modify value_to_self).
4222                 // Note that we will send HTLCs which another instance of rust-lightning would think
4223                 // violate the reserve value if we do not do this (as we forget inbound HTLCs from the
4224                 // Channel state once they will not be present in the next received commitment
4225                 // transaction).
4226                 let mut removed_outbound_total_msat = 0;
4227                 for ref htlc in self.context.pending_outbound_htlcs.iter() {
4228                         if let OutboundHTLCState::AwaitingRemoteRevokeToRemove(OutboundHTLCOutcome::Success(_)) = htlc.state {
4229                                 removed_outbound_total_msat += htlc.amount_msat;
4230                         } else if let OutboundHTLCState::AwaitingRemovedRemoteRevoke(OutboundHTLCOutcome::Success(_)) = htlc.state {
4231                                 removed_outbound_total_msat += htlc.amount_msat;
4232                         }
4233                 }
4234
4235                 let pending_value_to_self_msat =
4236                         self.context.value_to_self_msat + htlc_stats.pending_inbound_htlcs_value_msat - removed_outbound_total_msat;
4237                 let pending_remote_value_msat =
4238                         self.context.channel_value_satoshis * 1000 - pending_value_to_self_msat;
4239                 if pending_remote_value_msat < msg.amount_msat {
4240                         return Err(ChannelError::Close("Remote HTLC add would overdraw remaining funds".to_owned()));
4241                 }
4242
4243                 // Check that the remote can afford to pay for this HTLC on-chain at the current
4244                 // feerate_per_kw, while maintaining their channel reserve (as required by the spec).
4245                 {
4246                         let remote_commit_tx_fee_msat = if self.context.is_outbound() { 0 } else {
4247                                 let htlc_candidate = HTLCCandidate::new(msg.amount_msat, HTLCInitiator::RemoteOffered);
4248                                 self.context.next_remote_commit_tx_fee_msat(htlc_candidate, None) // Don't include the extra fee spike buffer HTLC in calculations
4249                         };
4250                         let anchor_outputs_value_msat = if !self.context.is_outbound() && self.context.get_channel_type().supports_anchors_zero_fee_htlc_tx() {
4251                                 ANCHOR_OUTPUT_VALUE_SATOSHI * 2 * 1000
4252                         } else {
4253                                 0
4254                         };
4255                         if pending_remote_value_msat.saturating_sub(msg.amount_msat).saturating_sub(anchor_outputs_value_msat) < remote_commit_tx_fee_msat {
4256                                 return Err(ChannelError::Close("Remote HTLC add would not leave enough to pay for fees".to_owned()));
4257                         };
4258                         if pending_remote_value_msat.saturating_sub(msg.amount_msat).saturating_sub(remote_commit_tx_fee_msat).saturating_sub(anchor_outputs_value_msat) < self.context.holder_selected_channel_reserve_satoshis * 1000 {
4259                                 return Err(ChannelError::Close("Remote HTLC add would put them under remote reserve value".to_owned()));
4260                         }
4261                 }
4262
4263                 let anchor_outputs_value_msat = if self.context.get_channel_type().supports_anchors_zero_fee_htlc_tx() {
4264                         ANCHOR_OUTPUT_VALUE_SATOSHI * 2 * 1000
4265                 } else {
4266                         0
4267                 };
4268                 if self.context.is_outbound() {
4269                         // Check that they won't violate our local required channel reserve by adding this HTLC.
4270                         let htlc_candidate = HTLCCandidate::new(msg.amount_msat, HTLCInitiator::RemoteOffered);
4271                         let local_commit_tx_fee_msat = self.context.next_local_commit_tx_fee_msat(htlc_candidate, None);
4272                         if self.context.value_to_self_msat < self.context.counterparty_selected_channel_reserve_satoshis.unwrap() * 1000 + local_commit_tx_fee_msat + anchor_outputs_value_msat {
4273                                 return Err(ChannelError::Close("Cannot accept HTLC that would put our balance under counterparty-announced channel reserve value".to_owned()));
4274                         }
4275                 }
4276                 if self.context.next_counterparty_htlc_id != msg.htlc_id {
4277                         return Err(ChannelError::Close(format!("Remote skipped HTLC ID (skipped ID: {})", self.context.next_counterparty_htlc_id)));
4278                 }
4279                 if msg.cltv_expiry >= 500000000 {
4280                         return Err(ChannelError::Close("Remote provided CLTV expiry in seconds instead of block height".to_owned()));
4281                 }
4282
4283                 if self.context.channel_state.is_local_shutdown_sent() {
4284                         if let PendingHTLCStatus::Forward(_) = pending_forward_status {
4285                                 panic!("ChannelManager shouldn't be trying to add a forwardable HTLC after we've started closing");
4286                         }
4287                 }
4288
4289                 // Now update local state:
4290                 self.context.next_counterparty_htlc_id += 1;
4291                 self.context.pending_inbound_htlcs.push(InboundHTLCOutput {
4292                         htlc_id: msg.htlc_id,
4293                         amount_msat: msg.amount_msat,
4294                         payment_hash: msg.payment_hash,
4295                         cltv_expiry: msg.cltv_expiry,
4296                         state: InboundHTLCState::RemoteAnnounced(InboundHTLCResolution::Resolved {
4297                                 pending_htlc_status: pending_forward_status
4298                         }),
4299                 });
4300                 Ok(())
4301         }
4302
4303         /// Marks an outbound HTLC which we have received update_fail/fulfill/malformed
4304         #[inline]
4305         fn mark_outbound_htlc_removed(&mut self, htlc_id: u64, check_preimage: Option<PaymentPreimage>, fail_reason: Option<HTLCFailReason>) -> Result<&OutboundHTLCOutput, ChannelError> {
4306                 assert!(!(check_preimage.is_some() && fail_reason.is_some()), "cannot fail while we have a preimage");
4307                 for htlc in self.context.pending_outbound_htlcs.iter_mut() {
4308                         if htlc.htlc_id == htlc_id {
4309                                 let outcome = match check_preimage {
4310                                         None => fail_reason.into(),
4311                                         Some(payment_preimage) => {
4312                                                 let payment_hash = PaymentHash(Sha256::hash(&payment_preimage.0[..]).to_byte_array());
4313                                                 if payment_hash != htlc.payment_hash {
4314                                                         return Err(ChannelError::Close(format!("Remote tried to fulfill HTLC ({}) with an incorrect preimage", htlc_id)));
4315                                                 }
4316                                                 OutboundHTLCOutcome::Success(Some(payment_preimage))
4317                                         }
4318                                 };
4319                                 match htlc.state {
4320                                         OutboundHTLCState::LocalAnnounced(_) =>
4321                                                 return Err(ChannelError::Close(format!("Remote tried to fulfill/fail HTLC ({}) before it had been committed", htlc_id))),
4322                                         OutboundHTLCState::Committed => {
4323                                                 htlc.state = OutboundHTLCState::RemoteRemoved(outcome);
4324                                         },
4325                                         OutboundHTLCState::AwaitingRemoteRevokeToRemove(_) | OutboundHTLCState::AwaitingRemovedRemoteRevoke(_) | OutboundHTLCState::RemoteRemoved(_) =>
4326                                                 return Err(ChannelError::Close(format!("Remote tried to fulfill/fail HTLC ({}) that they'd already fulfilled/failed", htlc_id))),
4327                                 }
4328                                 return Ok(htlc);
4329                         }
4330                 }
4331                 Err(ChannelError::Close("Remote tried to fulfill/fail an HTLC we couldn't find".to_owned()))
4332         }
4333
4334         pub fn update_fulfill_htlc(&mut self, msg: &msgs::UpdateFulfillHTLC) -> Result<(HTLCSource, u64, Option<u64>), ChannelError> {
4335                 if !matches!(self.context.channel_state, ChannelState::ChannelReady(_)) {
4336                         return Err(ChannelError::Close("Got fulfill HTLC message when channel was not in an operational state".to_owned()));
4337                 }
4338                 if self.context.channel_state.is_peer_disconnected() {
4339                         return Err(ChannelError::Close("Peer sent update_fulfill_htlc when we needed a channel_reestablish".to_owned()));
4340                 }
4341
4342                 self.mark_outbound_htlc_removed(msg.htlc_id, Some(msg.payment_preimage), None).map(|htlc| (htlc.source.clone(), htlc.amount_msat, htlc.skimmed_fee_msat))
4343         }
4344
4345         pub fn update_fail_htlc(&mut self, msg: &msgs::UpdateFailHTLC, fail_reason: HTLCFailReason) -> Result<(), ChannelError> {
4346                 if !matches!(self.context.channel_state, ChannelState::ChannelReady(_)) {
4347                         return Err(ChannelError::Close("Got fail HTLC message when channel was not in an operational state".to_owned()));
4348                 }
4349                 if self.context.channel_state.is_peer_disconnected() {
4350                         return Err(ChannelError::Close("Peer sent update_fail_htlc when we needed a channel_reestablish".to_owned()));
4351                 }
4352
4353                 self.mark_outbound_htlc_removed(msg.htlc_id, None, Some(fail_reason))?;
4354                 Ok(())
4355         }
4356
4357         pub fn update_fail_malformed_htlc(&mut self, msg: &msgs::UpdateFailMalformedHTLC, fail_reason: HTLCFailReason) -> Result<(), ChannelError> {
4358                 if !matches!(self.context.channel_state, ChannelState::ChannelReady(_)) {
4359                         return Err(ChannelError::Close("Got fail malformed HTLC message when channel was not in an operational state".to_owned()));
4360                 }
4361                 if self.context.channel_state.is_peer_disconnected() {
4362                         return Err(ChannelError::Close("Peer sent update_fail_malformed_htlc when we needed a channel_reestablish".to_owned()));
4363                 }
4364
4365                 self.mark_outbound_htlc_removed(msg.htlc_id, None, Some(fail_reason))?;
4366                 Ok(())
4367         }
4368
4369         pub fn commitment_signed<L: Deref>(&mut self, msg: &msgs::CommitmentSigned, logger: &L) -> Result<Option<ChannelMonitorUpdate>, ChannelError>
4370                 where L::Target: Logger
4371         {
4372                 if !matches!(self.context.channel_state, ChannelState::ChannelReady(_)) {
4373                         return Err(ChannelError::Close("Got commitment signed message when channel was not in an operational state".to_owned()));
4374                 }
4375                 if self.context.channel_state.is_peer_disconnected() {
4376                         return Err(ChannelError::Close("Peer sent commitment_signed when we needed a channel_reestablish".to_owned()));
4377                 }
4378                 if self.context.channel_state.is_both_sides_shutdown() && self.context.last_sent_closing_fee.is_some() {
4379                         return Err(ChannelError::Close("Peer sent commitment_signed after we'd started exchanging closing_signeds".to_owned()));
4380                 }
4381
4382                 let funding_script = self.context.get_funding_redeemscript();
4383
4384                 let keys = self.context.build_holder_transaction_keys(self.context.cur_holder_commitment_transaction_number);
4385
4386                 let commitment_stats = self.context.build_commitment_transaction(self.context.cur_holder_commitment_transaction_number, &keys, true, false, logger);
4387                 let commitment_txid = {
4388                         let trusted_tx = commitment_stats.tx.trust();
4389                         let bitcoin_tx = trusted_tx.built_transaction();
4390                         let sighash = bitcoin_tx.get_sighash_all(&funding_script, self.context.channel_value_satoshis);
4391
4392                         log_trace!(logger, "Checking commitment tx signature {} by key {} against tx {} (sighash {}) with redeemscript {} in channel {}",
4393                                 log_bytes!(msg.signature.serialize_compact()[..]),
4394                                 log_bytes!(self.context.counterparty_funding_pubkey().serialize()), encode::serialize_hex(&bitcoin_tx.transaction),
4395                                 log_bytes!(sighash[..]), encode::serialize_hex(&funding_script), &self.context.channel_id());
4396                         if let Err(_) = self.context.secp_ctx.verify_ecdsa(&sighash, &msg.signature, &self.context.counterparty_funding_pubkey()) {
4397                                 return Err(ChannelError::Close("Invalid commitment tx signature from peer".to_owned()));
4398                         }
4399                         bitcoin_tx.txid
4400                 };
4401                 let mut htlcs_cloned: Vec<_> = commitment_stats.htlcs_included.iter().map(|htlc| (htlc.0.clone(), htlc.1.map(|h| h.clone()))).collect();
4402
4403                 // If our counterparty updated the channel fee in this commitment transaction, check that
4404                 // they can actually afford the new fee now.
4405                 let update_fee = if let Some((_, update_state)) = self.context.pending_update_fee {
4406                         update_state == FeeUpdateState::RemoteAnnounced
4407                 } else { false };
4408                 if update_fee {
4409                         debug_assert!(!self.context.is_outbound());
4410                         let counterparty_reserve_we_require_msat = self.context.holder_selected_channel_reserve_satoshis * 1000;
4411                         if commitment_stats.remote_balance_msat < commitment_stats.total_fee_sat * 1000 + counterparty_reserve_we_require_msat {
4412                                 return Err(ChannelError::Close("Funding remote cannot afford proposed new fee".to_owned()));
4413                         }
4414                 }
4415                 #[cfg(any(test, fuzzing))]
4416                 {
4417                         if self.context.is_outbound() {
4418                                 let projected_commit_tx_info = self.context.next_local_commitment_tx_fee_info_cached.lock().unwrap().take();
4419                                 *self.context.next_remote_commitment_tx_fee_info_cached.lock().unwrap() = None;
4420                                 if let Some(info) = projected_commit_tx_info {
4421                                         let total_pending_htlcs = self.context.pending_inbound_htlcs.len() + self.context.pending_outbound_htlcs.len()
4422                                                 + self.context.holding_cell_htlc_updates.len();
4423                                         if info.total_pending_htlcs == total_pending_htlcs
4424                                                 && info.next_holder_htlc_id == self.context.next_holder_htlc_id
4425                                                 && info.next_counterparty_htlc_id == self.context.next_counterparty_htlc_id
4426                                                 && info.feerate == self.context.feerate_per_kw {
4427                                                         assert_eq!(commitment_stats.total_fee_sat, info.fee / 1000);
4428                                                 }
4429                                 }
4430                         }
4431                 }
4432
4433                 if msg.htlc_signatures.len() != commitment_stats.num_nondust_htlcs {
4434                         return Err(ChannelError::Close(format!("Got wrong number of HTLC signatures ({}) from remote. It must be {}", msg.htlc_signatures.len(), commitment_stats.num_nondust_htlcs)));
4435                 }
4436
4437                 // Up to LDK 0.0.115, HTLC information was required to be duplicated in the
4438                 // `htlcs_and_sigs` vec and in the `holder_commitment_tx` itself, both of which were passed
4439                 // in the `ChannelMonitorUpdate`. In 0.0.115, support for having a separate set of
4440                 // outbound-non-dust-HTLCSources in the `ChannelMonitorUpdate` was added, however for
4441                 // backwards compatibility, we never use it in production. To provide test coverage, here,
4442                 // we randomly decide (in test/fuzzing builds) to use the new vec sometimes.
4443                 #[allow(unused_assignments, unused_mut)]
4444                 let mut separate_nondust_htlc_sources = false;
4445                 #[cfg(all(feature = "std", any(test, fuzzing)))] {
4446                         use core::hash::{BuildHasher, Hasher};
4447                         // Get a random value using the only std API to do so - the DefaultHasher
4448                         let rand_val = std::collections::hash_map::RandomState::new().build_hasher().finish();
4449                         separate_nondust_htlc_sources = rand_val % 2 == 0;
4450                 }
4451
4452                 let mut nondust_htlc_sources = Vec::with_capacity(htlcs_cloned.len());
4453                 let mut htlcs_and_sigs = Vec::with_capacity(htlcs_cloned.len());
4454                 for (idx, (htlc, mut source_opt)) in htlcs_cloned.drain(..).enumerate() {
4455                         if let Some(_) = htlc.transaction_output_index {
4456                                 let htlc_tx = chan_utils::build_htlc_transaction(&commitment_txid, commitment_stats.feerate_per_kw,
4457                                         self.context.get_counterparty_selected_contest_delay().unwrap(), &htlc, &self.context.channel_type,
4458                                         &keys.broadcaster_delayed_payment_key, &keys.revocation_key);
4459
4460                                 let htlc_redeemscript = chan_utils::get_htlc_redeemscript(&htlc, &self.context.channel_type, &keys);
4461                                 let htlc_sighashtype = if self.context.channel_type.supports_anchors_zero_fee_htlc_tx() { EcdsaSighashType::SinglePlusAnyoneCanPay } else { EcdsaSighashType::All };
4462                                 let htlc_sighash = hash_to_message!(&sighash::SighashCache::new(&htlc_tx).segwit_signature_hash(0, &htlc_redeemscript, htlc.amount_msat / 1000, htlc_sighashtype).unwrap()[..]);
4463                                 log_trace!(logger, "Checking HTLC tx signature {} by key {} against tx {} (sighash {}) with redeemscript {} in channel {}.",
4464                                         log_bytes!(msg.htlc_signatures[idx].serialize_compact()[..]), log_bytes!(keys.countersignatory_htlc_key.to_public_key().serialize()),
4465                                         encode::serialize_hex(&htlc_tx), log_bytes!(htlc_sighash[..]), encode::serialize_hex(&htlc_redeemscript), &self.context.channel_id());
4466                                 if let Err(_) = self.context.secp_ctx.verify_ecdsa(&htlc_sighash, &msg.htlc_signatures[idx], &keys.countersignatory_htlc_key.to_public_key()) {
4467                                         return Err(ChannelError::Close("Invalid HTLC tx signature from peer".to_owned()));
4468                                 }
4469                                 if !separate_nondust_htlc_sources {
4470                                         htlcs_and_sigs.push((htlc, Some(msg.htlc_signatures[idx]), source_opt.take()));
4471                                 }
4472                         } else {
4473                                 htlcs_and_sigs.push((htlc, None, source_opt.take()));
4474                         }
4475                         if separate_nondust_htlc_sources {
4476                                 if let Some(source) = source_opt.take() {
4477                                         nondust_htlc_sources.push(source);
4478                                 }
4479                         }
4480                         debug_assert!(source_opt.is_none(), "HTLCSource should have been put somewhere");
4481                 }
4482
4483                 let holder_commitment_tx = HolderCommitmentTransaction::new(
4484                         commitment_stats.tx,
4485                         msg.signature,
4486                         msg.htlc_signatures.clone(),
4487                         &self.context.get_holder_pubkeys().funding_pubkey,
4488                         self.context.counterparty_funding_pubkey()
4489                 );
4490
4491                 self.context.holder_signer.as_ref().validate_holder_commitment(&holder_commitment_tx, commitment_stats.outbound_htlc_preimages)
4492                         .map_err(|_| ChannelError::Close("Failed to validate our commitment".to_owned()))?;
4493
4494                 // Update state now that we've passed all the can-fail calls...
4495                 let mut need_commitment = false;
4496                 if let &mut Some((_, ref mut update_state)) = &mut self.context.pending_update_fee {
4497                         if *update_state == FeeUpdateState::RemoteAnnounced {
4498                                 *update_state = FeeUpdateState::AwaitingRemoteRevokeToAnnounce;
4499                                 need_commitment = true;
4500                         }
4501                 }
4502
4503                 for htlc in self.context.pending_inbound_htlcs.iter_mut() {
4504                         let htlc_resolution = if let &InboundHTLCState::RemoteAnnounced(ref resolution) = &htlc.state {
4505                                 Some(resolution.clone())
4506                         } else { None };
4507                         if let Some(htlc_resolution) = htlc_resolution {
4508                                 log_trace!(logger, "Updating HTLC {} to AwaitingRemoteRevokeToAnnounce due to commitment_signed in channel {}.",
4509                                         &htlc.payment_hash, &self.context.channel_id);
4510                                 htlc.state = InboundHTLCState::AwaitingRemoteRevokeToAnnounce(htlc_resolution);
4511                                 need_commitment = true;
4512                         }
4513                 }
4514                 let mut claimed_htlcs = Vec::new();
4515                 for htlc in self.context.pending_outbound_htlcs.iter_mut() {
4516                         if let &mut OutboundHTLCState::RemoteRemoved(ref mut outcome) = &mut htlc.state {
4517                                 log_trace!(logger, "Updating HTLC {} to AwaitingRemoteRevokeToRemove due to commitment_signed in channel {}.",
4518                                         &htlc.payment_hash, &self.context.channel_id);
4519                                 // Grab the preimage, if it exists, instead of cloning
4520                                 let mut reason = OutboundHTLCOutcome::Success(None);
4521                                 mem::swap(outcome, &mut reason);
4522                                 if let OutboundHTLCOutcome::Success(Some(preimage)) = reason {
4523                                         // If a user (a) receives an HTLC claim using LDK 0.0.104 or before, then (b)
4524                                         // upgrades to LDK 0.0.114 or later before the HTLC is fully resolved, we could
4525                                         // have a `Success(None)` reason. In this case we could forget some HTLC
4526                                         // claims, but such an upgrade is unlikely and including claimed HTLCs here
4527                                         // fixes a bug which the user was exposed to on 0.0.104 when they started the
4528                                         // claim anyway.
4529                                         claimed_htlcs.push((SentHTLCId::from_source(&htlc.source), preimage));
4530                                 }
4531                                 htlc.state = OutboundHTLCState::AwaitingRemoteRevokeToRemove(reason);
4532                                 need_commitment = true;
4533                         }
4534                 }
4535
4536                 self.context.latest_monitor_update_id += 1;
4537                 let mut monitor_update = ChannelMonitorUpdate {
4538                         update_id: self.context.latest_monitor_update_id,
4539                         counterparty_node_id: Some(self.context.counterparty_node_id),
4540                         updates: vec![ChannelMonitorUpdateStep::LatestHolderCommitmentTXInfo {
4541                                 commitment_tx: holder_commitment_tx,
4542                                 htlc_outputs: htlcs_and_sigs,
4543                                 claimed_htlcs,
4544                                 nondust_htlc_sources,
4545                         }],
4546                         channel_id: Some(self.context.channel_id()),
4547                 };
4548
4549                 self.context.cur_holder_commitment_transaction_number -= 1;
4550                 self.context.expecting_peer_commitment_signed = false;
4551                 // Note that if we need_commitment & !AwaitingRemoteRevoke we'll call
4552                 // build_commitment_no_status_check() next which will reset this to RAAFirst.
4553                 self.context.resend_order = RAACommitmentOrder::CommitmentFirst;
4554
4555                 if self.context.channel_state.is_monitor_update_in_progress() {
4556                         // In case we initially failed monitor updating without requiring a response, we need
4557                         // to make sure the RAA gets sent first.
4558                         self.context.monitor_pending_revoke_and_ack = true;
4559                         if need_commitment && !self.context.channel_state.is_awaiting_remote_revoke() {
4560                                 // If we were going to send a commitment_signed after the RAA, go ahead and do all
4561                                 // the corresponding HTLC status updates so that
4562                                 // get_last_commitment_update_for_send includes the right HTLCs.
4563                                 self.context.monitor_pending_commitment_signed = true;
4564                                 let mut additional_update = self.build_commitment_no_status_check(logger);
4565                                 // build_commitment_no_status_check may bump latest_monitor_id but we want them to be
4566                                 // strictly increasing by one, so decrement it here.
4567                                 self.context.latest_monitor_update_id = monitor_update.update_id;
4568                                 monitor_update.updates.append(&mut additional_update.updates);
4569                         }
4570                         log_debug!(logger, "Received valid commitment_signed from peer in channel {}, updated HTLC state but awaiting a monitor update resolution to reply.",
4571                                 &self.context.channel_id);
4572                         return Ok(self.push_ret_blockable_mon_update(monitor_update));
4573                 }
4574
4575                 let need_commitment_signed = if need_commitment && !self.context.channel_state.is_awaiting_remote_revoke() {
4576                         // If we're AwaitingRemoteRevoke we can't send a new commitment here, but that's ok -
4577                         // we'll send one right away when we get the revoke_and_ack when we
4578                         // free_holding_cell_htlcs().
4579                         let mut additional_update = self.build_commitment_no_status_check(logger);
4580                         // build_commitment_no_status_check may bump latest_monitor_id but we want them to be
4581                         // strictly increasing by one, so decrement it here.
4582                         self.context.latest_monitor_update_id = monitor_update.update_id;
4583                         monitor_update.updates.append(&mut additional_update.updates);
4584                         true
4585                 } else { false };
4586
4587                 log_debug!(logger, "Received valid commitment_signed from peer in channel {}, updating HTLC state and responding with{} a revoke_and_ack.",
4588                         &self.context.channel_id(), if need_commitment_signed { " our own commitment_signed and" } else { "" });
4589                 self.monitor_updating_paused(true, need_commitment_signed, false, Vec::new(), Vec::new(), Vec::new());
4590                 return Ok(self.push_ret_blockable_mon_update(monitor_update));
4591         }
4592
4593         /// Public version of the below, checking relevant preconditions first.
4594         /// If we're not in a state where freeing the holding cell makes sense, this is a no-op and
4595         /// returns `(None, Vec::new())`.
4596         pub fn maybe_free_holding_cell_htlcs<F: Deref, L: Deref>(
4597                 &mut self, fee_estimator: &LowerBoundedFeeEstimator<F>, logger: &L
4598         ) -> (Option<ChannelMonitorUpdate>, Vec<(HTLCSource, PaymentHash)>)
4599         where F::Target: FeeEstimator, L::Target: Logger
4600         {
4601                 if matches!(self.context.channel_state, ChannelState::ChannelReady(_)) && self.context.channel_state.can_generate_new_commitment() {
4602                         self.free_holding_cell_htlcs(fee_estimator, logger)
4603                 } else { (None, Vec::new()) }
4604         }
4605
4606         /// Frees any pending commitment updates in the holding cell, generating the relevant messages
4607         /// for our counterparty.
4608         fn free_holding_cell_htlcs<F: Deref, L: Deref>(
4609                 &mut self, fee_estimator: &LowerBoundedFeeEstimator<F>, logger: &L
4610         ) -> (Option<ChannelMonitorUpdate>, Vec<(HTLCSource, PaymentHash)>)
4611         where F::Target: FeeEstimator, L::Target: Logger
4612         {
4613                 assert!(!self.context.channel_state.is_monitor_update_in_progress());
4614                 if self.context.holding_cell_htlc_updates.len() != 0 || self.context.holding_cell_update_fee.is_some() {
4615                         log_trace!(logger, "Freeing holding cell with {} HTLC updates{} in channel {}", self.context.holding_cell_htlc_updates.len(),
4616                                 if self.context.holding_cell_update_fee.is_some() { " and a fee update" } else { "" }, &self.context.channel_id());
4617
4618                         let mut monitor_update = ChannelMonitorUpdate {
4619                                 update_id: self.context.latest_monitor_update_id + 1, // We don't increment this yet!
4620                                 counterparty_node_id: Some(self.context.counterparty_node_id),
4621                                 updates: Vec::new(),
4622                                 channel_id: Some(self.context.channel_id()),
4623                         };
4624
4625                         let mut htlc_updates = Vec::new();
4626                         mem::swap(&mut htlc_updates, &mut self.context.holding_cell_htlc_updates);
4627                         let mut update_add_count = 0;
4628                         let mut update_fulfill_count = 0;
4629                         let mut update_fail_count = 0;
4630                         let mut htlcs_to_fail = Vec::new();
4631                         for htlc_update in htlc_updates.drain(..) {
4632                                 // Note that this *can* fail, though it should be due to rather-rare conditions on
4633                                 // fee races with adding too many outputs which push our total payments just over
4634                                 // the limit. In case it's less rare than I anticipate, we may want to revisit
4635                                 // handling this case better and maybe fulfilling some of the HTLCs while attempting
4636                                 // to rebalance channels.
4637                                 let fail_htlc_res = match &htlc_update {
4638                                         &HTLCUpdateAwaitingACK::AddHTLC {
4639                                                 amount_msat, cltv_expiry, ref payment_hash, ref source, ref onion_routing_packet,
4640                                                 skimmed_fee_msat, blinding_point, ..
4641                                         } => {
4642                                                 match self.send_htlc(
4643                                                         amount_msat, *payment_hash, cltv_expiry, source.clone(), onion_routing_packet.clone(),
4644                                                         false, skimmed_fee_msat, blinding_point, fee_estimator, logger
4645                                                 ) {
4646                                                         Ok(_) => update_add_count += 1,
4647                                                         Err(e) => {
4648                                                                 match e {
4649                                                                         ChannelError::Ignore(ref msg) => {
4650                                                                                 log_info!(logger, "Failed to send HTLC with payment_hash {} due to {} in channel {}", &payment_hash, msg, &self.context.channel_id());
4651                                                                                 // If we fail to send here, then this HTLC should
4652                                                                                 // be failed backwards. Failing to send here
4653                                                                                 // indicates that this HTLC may keep being put back
4654                                                                                 // into the holding cell without ever being
4655                                                                                 // successfully forwarded/failed/fulfilled, causing
4656                                                                                 // our counterparty to eventually close on us.
4657                                                                                 htlcs_to_fail.push((source.clone(), *payment_hash));
4658                                                                         },
4659                                                                         _ => {
4660                                                                                 panic!("Got a non-IgnoreError action trying to send holding cell HTLC");
4661                                                                         },
4662                                                                 }
4663                                                         }
4664                                                 }
4665                                                 None
4666                                         },
4667                                         &HTLCUpdateAwaitingACK::ClaimHTLC { ref payment_preimage, htlc_id, .. } => {
4668                                                 // If an HTLC claim was previously added to the holding cell (via
4669                                                 // `get_update_fulfill_htlc`, then generating the claim message itself must
4670                                                 // not fail - any in between attempts to claim the HTLC will have resulted
4671                                                 // in it hitting the holding cell again and we cannot change the state of a
4672                                                 // holding cell HTLC from fulfill to anything else.
4673                                                 let mut additional_monitor_update =
4674                                                         if let UpdateFulfillFetch::NewClaim { monitor_update, .. } =
4675                                                                 self.get_update_fulfill_htlc(htlc_id, *payment_preimage, logger)
4676                                                         { monitor_update } else { unreachable!() };
4677                                                 update_fulfill_count += 1;
4678                                                 monitor_update.updates.append(&mut additional_monitor_update.updates);
4679                                                 None
4680                                         },
4681                                         &HTLCUpdateAwaitingACK::FailHTLC { htlc_id, ref err_packet } => {
4682                                                 Some(self.fail_htlc(htlc_id, err_packet.clone(), false, logger)
4683                                                  .map(|fail_msg_opt| fail_msg_opt.map(|_| ())))
4684                                         },
4685                                         &HTLCUpdateAwaitingACK::FailMalformedHTLC { htlc_id, failure_code, sha256_of_onion } => {
4686                                                 Some(self.fail_htlc(htlc_id, (sha256_of_onion, failure_code), false, logger)
4687                                                  .map(|fail_msg_opt| fail_msg_opt.map(|_| ())))
4688                                         }
4689                                 };
4690                                 if let Some(res) = fail_htlc_res {
4691                                         match res {
4692                                                 Ok(fail_msg_opt) => {
4693                                                         // If an HTLC failure was previously added to the holding cell (via
4694                                                         // `queue_fail_{malformed_}htlc`) then generating the fail message itself must
4695                                                         // not fail - we should never end up in a state where we double-fail
4696                                                         // an HTLC or fail-then-claim an HTLC as it indicates we didn't wait
4697                                                         // for a full revocation before failing.
4698                                                         debug_assert!(fail_msg_opt.is_some());
4699                                                         update_fail_count += 1;
4700                                                 },
4701                                                 Err(ChannelError::Ignore(_)) => {},
4702                                                 Err(_) => {
4703                                                         panic!("Got a non-IgnoreError action trying to fail holding cell HTLC");
4704                                                 },
4705                                         }
4706                                 }
4707                         }
4708                         if update_add_count == 0 && update_fulfill_count == 0 && update_fail_count == 0 && self.context.holding_cell_update_fee.is_none() {
4709                                 return (None, htlcs_to_fail);
4710                         }
4711                         let update_fee = if let Some(feerate) = self.context.holding_cell_update_fee.take() {
4712                                 self.send_update_fee(feerate, false, fee_estimator, logger)
4713                         } else {
4714                                 None
4715                         };
4716
4717                         let mut additional_update = self.build_commitment_no_status_check(logger);
4718                         // build_commitment_no_status_check and get_update_fulfill_htlc may bump latest_monitor_id
4719                         // but we want them to be strictly increasing by one, so reset it here.
4720                         self.context.latest_monitor_update_id = monitor_update.update_id;
4721                         monitor_update.updates.append(&mut additional_update.updates);
4722
4723                         log_debug!(logger, "Freeing holding cell in channel {} resulted in {}{} HTLCs added, {} HTLCs fulfilled, and {} HTLCs failed.",
4724                                 &self.context.channel_id(), if update_fee.is_some() { "a fee update, " } else { "" },
4725                                 update_add_count, update_fulfill_count, update_fail_count);
4726
4727                         self.monitor_updating_paused(false, true, false, Vec::new(), Vec::new(), Vec::new());
4728                         (self.push_ret_blockable_mon_update(monitor_update), htlcs_to_fail)
4729                 } else {
4730                         (None, Vec::new())
4731                 }
4732         }
4733
4734         /// Handles receiving a remote's revoke_and_ack. Note that we may return a new
4735         /// commitment_signed message here in case we had pending outbound HTLCs to add which were
4736         /// waiting on this revoke_and_ack. The generation of this new commitment_signed may also fail,
4737         /// generating an appropriate error *after* the channel state has been updated based on the
4738         /// revoke_and_ack message.
4739         pub fn revoke_and_ack<F: Deref, L: Deref>(&mut self, msg: &msgs::RevokeAndACK,
4740                 fee_estimator: &LowerBoundedFeeEstimator<F>, logger: &L, hold_mon_update: bool,
4741         ) -> Result<(Vec<(HTLCSource, PaymentHash)>, Option<ChannelMonitorUpdate>), ChannelError>
4742         where F::Target: FeeEstimator, L::Target: Logger,
4743         {
4744                 if !matches!(self.context.channel_state, ChannelState::ChannelReady(_)) {
4745                         return Err(ChannelError::Close("Got revoke/ACK message when channel was not in an operational state".to_owned()));
4746                 }
4747                 if self.context.channel_state.is_peer_disconnected() {
4748                         return Err(ChannelError::Close("Peer sent revoke_and_ack when we needed a channel_reestablish".to_owned()));
4749                 }
4750                 if self.context.channel_state.is_both_sides_shutdown() && self.context.last_sent_closing_fee.is_some() {
4751                         return Err(ChannelError::Close("Peer sent revoke_and_ack after we'd started exchanging closing_signeds".to_owned()));
4752                 }
4753
4754                 let secret = secp_check!(SecretKey::from_slice(&msg.per_commitment_secret), "Peer provided an invalid per_commitment_secret".to_owned());
4755
4756                 if let Some(counterparty_prev_commitment_point) = self.context.counterparty_prev_commitment_point {
4757                         if PublicKey::from_secret_key(&self.context.secp_ctx, &secret) != counterparty_prev_commitment_point {
4758                                 return Err(ChannelError::Close("Got a revoke commitment secret which didn't correspond to their current pubkey".to_owned()));
4759                         }
4760                 }
4761
4762                 if !self.context.channel_state.is_awaiting_remote_revoke() {
4763                         // Our counterparty seems to have burned their coins to us (by revoking a state when we
4764                         // haven't given them a new commitment transaction to broadcast). We should probably
4765                         // take advantage of this by updating our channel monitor, sending them an error, and
4766                         // waiting for them to broadcast their latest (now-revoked claim). But, that would be a
4767                         // lot of work, and there's some chance this is all a misunderstanding anyway.
4768                         // We have to do *something*, though, since our signer may get mad at us for otherwise
4769                         // jumping a remote commitment number, so best to just force-close and move on.
4770                         return Err(ChannelError::Close("Received an unexpected revoke_and_ack".to_owned()));
4771                 }
4772
4773                 #[cfg(any(test, fuzzing))]
4774                 {
4775                         *self.context.next_local_commitment_tx_fee_info_cached.lock().unwrap() = None;
4776                         *self.context.next_remote_commitment_tx_fee_info_cached.lock().unwrap() = None;
4777                 }
4778
4779                 match &self.context.holder_signer {
4780                         ChannelSignerType::Ecdsa(ecdsa) => {
4781                                 ecdsa.validate_counterparty_revocation(
4782                                         self.context.cur_counterparty_commitment_transaction_number + 1,
4783                                         &secret
4784                                 ).map_err(|_| ChannelError::Close("Failed to validate revocation from peer".to_owned()))?;
4785                         },
4786                         // TODO (taproot|arik)
4787                         #[cfg(taproot)]
4788                         _ => todo!()
4789                 };
4790
4791                 self.context.commitment_secrets.provide_secret(self.context.cur_counterparty_commitment_transaction_number + 1, msg.per_commitment_secret)
4792                         .map_err(|_| ChannelError::Close("Previous secrets did not match new one".to_owned()))?;
4793                 self.context.latest_monitor_update_id += 1;
4794                 let mut monitor_update = ChannelMonitorUpdate {
4795                         update_id: self.context.latest_monitor_update_id,
4796                         counterparty_node_id: Some(self.context.counterparty_node_id),
4797                         updates: vec![ChannelMonitorUpdateStep::CommitmentSecret {
4798                                 idx: self.context.cur_counterparty_commitment_transaction_number + 1,
4799                                 secret: msg.per_commitment_secret,
4800                         }],
4801                         channel_id: Some(self.context.channel_id()),
4802                 };
4803
4804                 // Update state now that we've passed all the can-fail calls...
4805                 // (note that we may still fail to generate the new commitment_signed message, but that's
4806                 // OK, we step the channel here and *then* if the new generation fails we can fail the
4807                 // channel based on that, but stepping stuff here should be safe either way.
4808                 self.context.channel_state.clear_awaiting_remote_revoke();
4809                 self.context.sent_message_awaiting_response = None;
4810                 self.context.counterparty_prev_commitment_point = self.context.counterparty_cur_commitment_point;
4811                 self.context.counterparty_cur_commitment_point = Some(msg.next_per_commitment_point);
4812                 self.context.cur_counterparty_commitment_transaction_number -= 1;
4813
4814                 if self.context.announcement_sigs_state == AnnouncementSigsState::Committed {
4815                         self.context.announcement_sigs_state = AnnouncementSigsState::PeerReceived;
4816                 }
4817
4818                 log_trace!(logger, "Updating HTLCs on receipt of RAA in channel {}...", &self.context.channel_id());
4819                 let mut to_forward_infos = Vec::new();
4820                 let mut pending_update_adds = Vec::new();
4821                 let mut revoked_htlcs = Vec::new();
4822                 let mut finalized_claimed_htlcs = Vec::new();
4823                 let mut update_fail_htlcs = Vec::new();
4824                 let mut update_fail_malformed_htlcs = Vec::new();
4825                 let mut require_commitment = false;
4826                 let mut value_to_self_msat_diff: i64 = 0;
4827
4828                 {
4829                         // Take references explicitly so that we can hold multiple references to self.context.
4830                         let pending_inbound_htlcs: &mut Vec<_> = &mut self.context.pending_inbound_htlcs;
4831                         let pending_outbound_htlcs: &mut Vec<_> = &mut self.context.pending_outbound_htlcs;
4832                         let expecting_peer_commitment_signed = &mut self.context.expecting_peer_commitment_signed;
4833
4834                         // We really shouldnt have two passes here, but retain gives a non-mutable ref (Rust bug)
4835                         pending_inbound_htlcs.retain(|htlc| {
4836                                 if let &InboundHTLCState::LocalRemoved(ref reason) = &htlc.state {
4837                                         log_trace!(logger, " ...removing inbound LocalRemoved {}", &htlc.payment_hash);
4838                                         if let &InboundHTLCRemovalReason::Fulfill(_) = reason {
4839                                                 value_to_self_msat_diff += htlc.amount_msat as i64;
4840                                         }
4841                                         *expecting_peer_commitment_signed = true;
4842                                         false
4843                                 } else { true }
4844                         });
4845                         pending_outbound_htlcs.retain(|htlc| {
4846                                 if let &OutboundHTLCState::AwaitingRemovedRemoteRevoke(ref outcome) = &htlc.state {
4847                                         log_trace!(logger, " ...removing outbound AwaitingRemovedRemoteRevoke {}", &htlc.payment_hash);
4848                                         if let OutboundHTLCOutcome::Failure(reason) = outcome.clone() { // We really want take() here, but, again, non-mut ref :(
4849                                                 revoked_htlcs.push((htlc.source.clone(), htlc.payment_hash, reason));
4850                                         } else {
4851                                                 finalized_claimed_htlcs.push(htlc.source.clone());
4852                                                 // They fulfilled, so we sent them money
4853                                                 value_to_self_msat_diff -= htlc.amount_msat as i64;
4854                                         }
4855                                         false
4856                                 } else { true }
4857                         });
4858                         for htlc in pending_inbound_htlcs.iter_mut() {
4859                                 let swap = if let &InboundHTLCState::AwaitingRemoteRevokeToAnnounce(_) = &htlc.state {
4860                                         true
4861                                 } else if let &InboundHTLCState::AwaitingAnnouncedRemoteRevoke(_) = &htlc.state {
4862                                         true
4863                                 } else { false };
4864                                 if swap {
4865                                         let mut state = InboundHTLCState::Committed;
4866                                         mem::swap(&mut state, &mut htlc.state);
4867
4868                                         if let InboundHTLCState::AwaitingRemoteRevokeToAnnounce(resolution) = state {
4869                                                 log_trace!(logger, " ...promoting inbound AwaitingRemoteRevokeToAnnounce {} to AwaitingAnnouncedRemoteRevoke", &htlc.payment_hash);
4870                                                 htlc.state = InboundHTLCState::AwaitingAnnouncedRemoteRevoke(resolution);
4871                                                 require_commitment = true;
4872                                         } else if let InboundHTLCState::AwaitingAnnouncedRemoteRevoke(resolution) = state {
4873                                                 match resolution {
4874                                                         InboundHTLCResolution::Resolved { pending_htlc_status } =>
4875                                                                 match pending_htlc_status {
4876                                                                         PendingHTLCStatus::Fail(fail_msg) => {
4877                                                                                 log_trace!(logger, " ...promoting inbound AwaitingAnnouncedRemoteRevoke {} to LocalRemoved due to PendingHTLCStatus indicating failure", &htlc.payment_hash);
4878                                                                                 require_commitment = true;
4879                                                                                 match fail_msg {
4880                                                                                         HTLCFailureMsg::Relay(msg) => {
4881                                                                                                 htlc.state = InboundHTLCState::LocalRemoved(InboundHTLCRemovalReason::FailRelay(msg.reason.clone()));
4882                                                                                                 update_fail_htlcs.push(msg)
4883                                                                                         },
4884                                                                                         HTLCFailureMsg::Malformed(msg) => {
4885                                                                                                 htlc.state = InboundHTLCState::LocalRemoved(InboundHTLCRemovalReason::FailMalformed((msg.sha256_of_onion, msg.failure_code)));
4886                                                                                                 update_fail_malformed_htlcs.push(msg)
4887                                                                                         },
4888                                                                                 }
4889                                                                         },
4890                                                                         PendingHTLCStatus::Forward(forward_info) => {
4891                                                                                 log_trace!(logger, " ...promoting inbound AwaitingAnnouncedRemoteRevoke {} to Committed, attempting to forward", &htlc.payment_hash);
4892                                                                                 to_forward_infos.push((forward_info, htlc.htlc_id));
4893                                                                                 htlc.state = InboundHTLCState::Committed;
4894                                                                         }
4895                                                                 }
4896                                                         InboundHTLCResolution::Pending { update_add_htlc } => {
4897                                                                 log_trace!(logger, " ...promoting inbound AwaitingAnnouncedRemoteRevoke {} to Committed", &htlc.payment_hash);
4898                                                                 pending_update_adds.push(update_add_htlc);
4899                                                                 htlc.state = InboundHTLCState::Committed;
4900                                                         }
4901                                                 }
4902                                         }
4903                                 }
4904                         }
4905                         for htlc in pending_outbound_htlcs.iter_mut() {
4906                                 if let OutboundHTLCState::LocalAnnounced(_) = htlc.state {
4907                                         log_trace!(logger, " ...promoting outbound LocalAnnounced {} to Committed", &htlc.payment_hash);
4908                                         htlc.state = OutboundHTLCState::Committed;
4909                                         *expecting_peer_commitment_signed = true;
4910                                 }
4911                                 if let &mut OutboundHTLCState::AwaitingRemoteRevokeToRemove(ref mut outcome) = &mut htlc.state {
4912                                         log_trace!(logger, " ...promoting outbound AwaitingRemoteRevokeToRemove {} to AwaitingRemovedRemoteRevoke", &htlc.payment_hash);
4913                                         // Grab the preimage, if it exists, instead of cloning
4914                                         let mut reason = OutboundHTLCOutcome::Success(None);
4915                                         mem::swap(outcome, &mut reason);
4916                                         htlc.state = OutboundHTLCState::AwaitingRemovedRemoteRevoke(reason);
4917                                         require_commitment = true;
4918                                 }
4919                         }
4920                 }
4921                 self.context.value_to_self_msat = (self.context.value_to_self_msat as i64 + value_to_self_msat_diff) as u64;
4922
4923                 if let Some((feerate, update_state)) = self.context.pending_update_fee {
4924                         match update_state {
4925                                 FeeUpdateState::Outbound => {
4926                                         debug_assert!(self.context.is_outbound());
4927                                         log_trace!(logger, " ...promoting outbound fee update {} to Committed", feerate);
4928                                         self.context.feerate_per_kw = feerate;
4929                                         self.context.pending_update_fee = None;
4930                                         self.context.expecting_peer_commitment_signed = true;
4931                                 },
4932                                 FeeUpdateState::RemoteAnnounced => { debug_assert!(!self.context.is_outbound()); },
4933                                 FeeUpdateState::AwaitingRemoteRevokeToAnnounce => {
4934                                         debug_assert!(!self.context.is_outbound());
4935                                         log_trace!(logger, " ...promoting inbound AwaitingRemoteRevokeToAnnounce fee update {} to Committed", feerate);
4936                                         require_commitment = true;
4937                                         self.context.feerate_per_kw = feerate;
4938                                         self.context.pending_update_fee = None;
4939                                 },
4940                         }
4941                 }
4942
4943                 let release_monitor = self.context.blocked_monitor_updates.is_empty() && !hold_mon_update;
4944                 let release_state_str =
4945                         if hold_mon_update { "Holding" } else if release_monitor { "Releasing" } else { "Blocked" };
4946                 macro_rules! return_with_htlcs_to_fail {
4947                         ($htlcs_to_fail: expr) => {
4948                                 if !release_monitor {
4949                                         self.context.blocked_monitor_updates.push(PendingChannelMonitorUpdate {
4950                                                 update: monitor_update,
4951                                         });
4952                                         return Ok(($htlcs_to_fail, None));
4953                                 } else {
4954                                         return Ok(($htlcs_to_fail, Some(monitor_update)));
4955                                 }
4956                         }
4957                 }
4958
4959                 self.context.monitor_pending_update_adds.append(&mut pending_update_adds);
4960
4961                 if self.context.channel_state.is_monitor_update_in_progress() {
4962                         // We can't actually generate a new commitment transaction (incl by freeing holding
4963                         // cells) while we can't update the monitor, so we just return what we have.
4964                         if require_commitment {
4965                                 self.context.monitor_pending_commitment_signed = true;
4966                                 // When the monitor updating is restored we'll call
4967                                 // get_last_commitment_update_for_send(), which does not update state, but we're
4968                                 // definitely now awaiting a remote revoke before we can step forward any more, so
4969                                 // set it here.
4970                                 let mut additional_update = self.build_commitment_no_status_check(logger);
4971                                 // build_commitment_no_status_check may bump latest_monitor_id but we want them to be
4972                                 // strictly increasing by one, so decrement it here.
4973                                 self.context.latest_monitor_update_id = monitor_update.update_id;
4974                                 monitor_update.updates.append(&mut additional_update.updates);
4975                         }
4976                         self.context.monitor_pending_forwards.append(&mut to_forward_infos);
4977                         self.context.monitor_pending_failures.append(&mut revoked_htlcs);
4978                         self.context.monitor_pending_finalized_fulfills.append(&mut finalized_claimed_htlcs);
4979                         log_debug!(logger, "Received a valid revoke_and_ack for channel {} but awaiting a monitor update resolution to reply.", &self.context.channel_id());
4980                         return_with_htlcs_to_fail!(Vec::new());
4981                 }
4982
4983                 match self.free_holding_cell_htlcs(fee_estimator, logger) {
4984                         (Some(mut additional_update), htlcs_to_fail) => {
4985                                 // free_holding_cell_htlcs may bump latest_monitor_id multiple times but we want them to be
4986                                 // strictly increasing by one, so decrement it here.
4987                                 self.context.latest_monitor_update_id = monitor_update.update_id;
4988                                 monitor_update.updates.append(&mut additional_update.updates);
4989
4990                                 log_debug!(logger, "Received a valid revoke_and_ack for channel {} with holding cell HTLCs freed. {} monitor update.",
4991                                         &self.context.channel_id(), release_state_str);
4992
4993                                 self.monitor_updating_paused(false, true, false, to_forward_infos, revoked_htlcs, finalized_claimed_htlcs);
4994                                 return_with_htlcs_to_fail!(htlcs_to_fail);
4995                         },
4996                         (None, htlcs_to_fail) => {
4997                                 if require_commitment {
4998                                         let mut additional_update = self.build_commitment_no_status_check(logger);
4999
5000                                         // build_commitment_no_status_check may bump latest_monitor_id but we want them to be
5001                                         // strictly increasing by one, so decrement it here.
5002                                         self.context.latest_monitor_update_id = monitor_update.update_id;
5003                                         monitor_update.updates.append(&mut additional_update.updates);
5004
5005                                         log_debug!(logger, "Received a valid revoke_and_ack for channel {}. Responding with a commitment update with {} HTLCs failed. {} monitor update.",
5006                                                 &self.context.channel_id(),
5007                                                 update_fail_htlcs.len() + update_fail_malformed_htlcs.len(),
5008                                                 release_state_str);
5009
5010                                         self.monitor_updating_paused(false, true, false, to_forward_infos, revoked_htlcs, finalized_claimed_htlcs);
5011                                         return_with_htlcs_to_fail!(htlcs_to_fail);
5012                                 } else {
5013                                         log_debug!(logger, "Received a valid revoke_and_ack for channel {} with no reply necessary. {} monitor update.",
5014                                                 &self.context.channel_id(), release_state_str);
5015
5016                                         self.monitor_updating_paused(false, false, false, to_forward_infos, revoked_htlcs, finalized_claimed_htlcs);
5017                                         return_with_htlcs_to_fail!(htlcs_to_fail);
5018                                 }
5019                         }
5020                 }
5021         }
5022
5023         /// Queues up an outbound update fee by placing it in the holding cell. You should call
5024         /// [`Self::maybe_free_holding_cell_htlcs`] in order to actually generate and send the
5025         /// commitment update.
5026         pub fn queue_update_fee<F: Deref, L: Deref>(&mut self, feerate_per_kw: u32,
5027                 fee_estimator: &LowerBoundedFeeEstimator<F>, logger: &L)
5028         where F::Target: FeeEstimator, L::Target: Logger
5029         {
5030                 let msg_opt = self.send_update_fee(feerate_per_kw, true, fee_estimator, logger);
5031                 assert!(msg_opt.is_none(), "We forced holding cell?");
5032         }
5033
5034         /// Adds a pending update to this channel. See the doc for send_htlc for
5035         /// further details on the optionness of the return value.
5036         /// If our balance is too low to cover the cost of the next commitment transaction at the
5037         /// new feerate, the update is cancelled.
5038         ///
5039         /// You MUST call [`Self::send_commitment_no_state_update`] prior to any other calls on this
5040         /// [`Channel`] if `force_holding_cell` is false.
5041         fn send_update_fee<F: Deref, L: Deref>(
5042                 &mut self, feerate_per_kw: u32, mut force_holding_cell: bool,
5043                 fee_estimator: &LowerBoundedFeeEstimator<F>, logger: &L
5044         ) -> Option<msgs::UpdateFee>
5045         where F::Target: FeeEstimator, L::Target: Logger
5046         {
5047                 if !self.context.is_outbound() {
5048                         panic!("Cannot send fee from inbound channel");
5049                 }
5050                 if !self.context.is_usable() {
5051                         panic!("Cannot update fee until channel is fully established and we haven't started shutting down");
5052                 }
5053                 if !self.context.is_live() {
5054                         panic!("Cannot update fee while peer is disconnected/we're awaiting a monitor update (ChannelManager should have caught this)");
5055                 }
5056
5057                 // Before proposing a feerate update, check that we can actually afford the new fee.
5058                 let dust_exposure_limiting_feerate = self.context.get_dust_exposure_limiting_feerate(&fee_estimator);
5059                 let htlc_stats = self.context.get_pending_htlc_stats(Some(feerate_per_kw), dust_exposure_limiting_feerate);
5060                 let keys = self.context.build_holder_transaction_keys(self.context.cur_holder_commitment_transaction_number);
5061                 let commitment_stats = self.context.build_commitment_transaction(self.context.cur_holder_commitment_transaction_number, &keys, true, true, logger);
5062                 let buffer_fee_msat = commit_tx_fee_sat(feerate_per_kw, commitment_stats.num_nondust_htlcs + htlc_stats.on_holder_tx_outbound_holding_cell_htlcs_count as usize + CONCURRENT_INBOUND_HTLC_FEE_BUFFER as usize, self.context.get_channel_type()) * 1000;
5063                 let holder_balance_msat = commitment_stats.local_balance_msat - htlc_stats.outbound_holding_cell_msat;
5064                 if holder_balance_msat < buffer_fee_msat  + self.context.counterparty_selected_channel_reserve_satoshis.unwrap() * 1000 {
5065                         //TODO: auto-close after a number of failures?
5066                         log_debug!(logger, "Cannot afford to send new feerate at {}", feerate_per_kw);
5067                         return None;
5068                 }
5069
5070                 // Note, we evaluate pending htlc "preemptive" trimmed-to-dust threshold at the proposed `feerate_per_kw`.
5071                 let max_dust_htlc_exposure_msat = self.context.get_max_dust_htlc_exposure_msat(dust_exposure_limiting_feerate);
5072                 if htlc_stats.on_holder_tx_dust_exposure_msat > max_dust_htlc_exposure_msat {
5073                         log_debug!(logger, "Cannot afford to send new feerate at {} without infringing max dust htlc exposure", feerate_per_kw);
5074                         return None;
5075                 }
5076                 if htlc_stats.on_counterparty_tx_dust_exposure_msat > max_dust_htlc_exposure_msat {
5077                         log_debug!(logger, "Cannot afford to send new feerate at {} without infringing max dust htlc exposure", feerate_per_kw);
5078                         return None;
5079                 }
5080
5081                 if self.context.channel_state.is_awaiting_remote_revoke() || self.context.channel_state.is_monitor_update_in_progress() {
5082                         force_holding_cell = true;
5083                 }
5084
5085                 if force_holding_cell {
5086                         self.context.holding_cell_update_fee = Some(feerate_per_kw);
5087                         return None;
5088                 }
5089
5090                 debug_assert!(self.context.pending_update_fee.is_none());
5091                 self.context.pending_update_fee = Some((feerate_per_kw, FeeUpdateState::Outbound));
5092
5093                 Some(msgs::UpdateFee {
5094                         channel_id: self.context.channel_id,
5095                         feerate_per_kw,
5096                 })
5097         }
5098
5099         /// Removes any uncommitted inbound HTLCs and resets the state of uncommitted outbound HTLC
5100         /// updates, to be used on peer disconnection. After this, update_*_htlc messages need to be
5101         /// resent.
5102         /// No further message handling calls may be made until a channel_reestablish dance has
5103         /// completed.
5104         /// May return `Err(())`, which implies [`ChannelContext::force_shutdown`] should be called immediately.
5105         pub fn remove_uncommitted_htlcs_and_mark_paused<L: Deref>(&mut self, logger: &L) -> Result<(), ()> where L::Target: Logger {
5106                 assert!(!matches!(self.context.channel_state, ChannelState::ShutdownComplete));
5107                 if self.context.channel_state.is_pre_funded_state() {
5108                         return Err(())
5109                 }
5110
5111                 if self.context.channel_state.is_peer_disconnected() {
5112                         // While the below code should be idempotent, it's simpler to just return early, as
5113                         // redundant disconnect events can fire, though they should be rare.
5114                         return Ok(());
5115                 }
5116
5117                 if self.context.announcement_sigs_state == AnnouncementSigsState::MessageSent || self.context.announcement_sigs_state == AnnouncementSigsState::Committed {
5118                         self.context.announcement_sigs_state = AnnouncementSigsState::NotSent;
5119                 }
5120
5121                 // Upon reconnect we have to start the closing_signed dance over, but shutdown messages
5122                 // will be retransmitted.
5123                 self.context.last_sent_closing_fee = None;
5124                 self.context.pending_counterparty_closing_signed = None;
5125                 self.context.closing_fee_limits = None;
5126
5127                 let mut inbound_drop_count = 0;
5128                 self.context.pending_inbound_htlcs.retain(|htlc| {
5129                         match htlc.state {
5130                                 InboundHTLCState::RemoteAnnounced(_) => {
5131                                         // They sent us an update_add_htlc but we never got the commitment_signed.
5132                                         // We'll tell them what commitment_signed we're expecting next and they'll drop
5133                                         // this HTLC accordingly
5134                                         inbound_drop_count += 1;
5135                                         false
5136                                 },
5137                                 InboundHTLCState::AwaitingRemoteRevokeToAnnounce(_)|InboundHTLCState::AwaitingAnnouncedRemoteRevoke(_) => {
5138                                         // We received a commitment_signed updating this HTLC and (at least hopefully)
5139                                         // sent a revoke_and_ack (which we can re-transmit) and have heard nothing
5140                                         // in response to it yet, so don't touch it.
5141                                         true
5142                                 },
5143                                 InboundHTLCState::Committed => true,
5144                                 InboundHTLCState::LocalRemoved(_) => {
5145                                         // We (hopefully) sent a commitment_signed updating this HTLC (which we can
5146                                         // re-transmit if needed) and they may have even sent a revoke_and_ack back
5147                                         // (that we missed). Keep this around for now and if they tell us they missed
5148                                         // the commitment_signed we can re-transmit the update then.
5149                                         true
5150                                 },
5151                         }
5152                 });
5153                 self.context.next_counterparty_htlc_id -= inbound_drop_count;
5154
5155                 if let Some((_, update_state)) = self.context.pending_update_fee {
5156                         if update_state == FeeUpdateState::RemoteAnnounced {
5157                                 debug_assert!(!self.context.is_outbound());
5158                                 self.context.pending_update_fee = None;
5159                         }
5160                 }
5161
5162                 for htlc in self.context.pending_outbound_htlcs.iter_mut() {
5163                         if let OutboundHTLCState::RemoteRemoved(_) = htlc.state {
5164                                 // They sent us an update to remove this but haven't yet sent the corresponding
5165                                 // commitment_signed, we need to move it back to Committed and they can re-send
5166                                 // the update upon reconnection.
5167                                 htlc.state = OutboundHTLCState::Committed;
5168                         }
5169                 }
5170
5171                 self.context.sent_message_awaiting_response = None;
5172
5173                 self.context.channel_state.set_peer_disconnected();
5174                 log_trace!(logger, "Peer disconnection resulted in {} remote-announced HTLC drops on channel {}", inbound_drop_count, &self.context.channel_id());
5175                 Ok(())
5176         }
5177
5178         /// Indicates that a ChannelMonitor update is in progress and has not yet been fully persisted.
5179         /// This must be called before we return the [`ChannelMonitorUpdate`] back to the
5180         /// [`ChannelManager`], which will call [`Self::monitor_updating_restored`] once the monitor
5181         /// update completes (potentially immediately).
5182         /// The messages which were generated with the monitor update must *not* have been sent to the
5183         /// remote end, and must instead have been dropped. They will be regenerated when
5184         /// [`Self::monitor_updating_restored`] is called.
5185         ///
5186         /// [`ChannelManager`]: super::channelmanager::ChannelManager
5187         /// [`chain::Watch`]: crate::chain::Watch
5188         /// [`ChannelMonitorUpdateStatus::InProgress`]: crate::chain::ChannelMonitorUpdateStatus::InProgress
5189         fn monitor_updating_paused(&mut self, resend_raa: bool, resend_commitment: bool,
5190                 resend_channel_ready: bool, mut pending_forwards: Vec<(PendingHTLCInfo, u64)>,
5191                 mut pending_fails: Vec<(HTLCSource, PaymentHash, HTLCFailReason)>,
5192                 mut pending_finalized_claimed_htlcs: Vec<HTLCSource>
5193         ) {
5194                 self.context.monitor_pending_revoke_and_ack |= resend_raa;
5195                 self.context.monitor_pending_commitment_signed |= resend_commitment;
5196                 self.context.monitor_pending_channel_ready |= resend_channel_ready;
5197                 self.context.monitor_pending_forwards.append(&mut pending_forwards);
5198                 self.context.monitor_pending_failures.append(&mut pending_fails);
5199                 self.context.monitor_pending_finalized_fulfills.append(&mut pending_finalized_claimed_htlcs);
5200                 self.context.channel_state.set_monitor_update_in_progress();
5201         }
5202
5203         /// Indicates that the latest ChannelMonitor update has been committed by the client
5204         /// successfully and we should restore normal operation. Returns messages which should be sent
5205         /// to the remote side.
5206         pub fn monitor_updating_restored<L: Deref, NS: Deref>(
5207                 &mut self, logger: &L, node_signer: &NS, chain_hash: ChainHash,
5208                 user_config: &UserConfig, best_block_height: u32
5209         ) -> MonitorRestoreUpdates
5210         where
5211                 L::Target: Logger,
5212                 NS::Target: NodeSigner
5213         {
5214                 assert!(self.context.channel_state.is_monitor_update_in_progress());
5215                 self.context.channel_state.clear_monitor_update_in_progress();
5216
5217                 // If we're past (or at) the AwaitingChannelReady stage on an outbound channel, try to
5218                 // (re-)broadcast the funding transaction as we may have declined to broadcast it when we
5219                 // first received the funding_signed.
5220                 let mut funding_broadcastable =
5221                         if self.context.is_outbound() &&
5222                                 (matches!(self.context.channel_state, ChannelState::AwaitingChannelReady(flags) if !flags.is_set(AwaitingChannelReadyFlags::WAITING_FOR_BATCH)) ||
5223                                 matches!(self.context.channel_state, ChannelState::ChannelReady(_)))
5224                         {
5225                                 self.context.funding_transaction.take()
5226                         } else { None };
5227                 // That said, if the funding transaction is already confirmed (ie we're active with a
5228                 // minimum_depth over 0) don't bother re-broadcasting the confirmed funding tx.
5229                 if matches!(self.context.channel_state, ChannelState::ChannelReady(_)) && self.context.minimum_depth != Some(0) {
5230                         funding_broadcastable = None;
5231                 }
5232
5233                 // We will never broadcast the funding transaction when we're in MonitorUpdateInProgress
5234                 // (and we assume the user never directly broadcasts the funding transaction and waits for
5235                 // us to do it). Thus, we can only ever hit monitor_pending_channel_ready when we're
5236                 // * an inbound channel that failed to persist the monitor on funding_created and we got
5237                 //   the funding transaction confirmed before the monitor was persisted, or
5238                 // * a 0-conf channel and intended to send the channel_ready before any broadcast at all.
5239                 let channel_ready = if self.context.monitor_pending_channel_ready {
5240                         assert!(!self.context.is_outbound() || self.context.minimum_depth == Some(0),
5241                                 "Funding transaction broadcast by the local client before it should have - LDK didn't do it!");
5242                         self.context.monitor_pending_channel_ready = false;
5243                         let next_per_commitment_point = self.context.holder_signer.as_ref().get_per_commitment_point(self.context.cur_holder_commitment_transaction_number, &self.context.secp_ctx);
5244                         Some(msgs::ChannelReady {
5245                                 channel_id: self.context.channel_id(),
5246                                 next_per_commitment_point,
5247                                 short_channel_id_alias: Some(self.context.outbound_scid_alias),
5248                         })
5249                 } else { None };
5250
5251                 let announcement_sigs = self.get_announcement_sigs(node_signer, chain_hash, user_config, best_block_height, logger);
5252
5253                 let mut accepted_htlcs = Vec::new();
5254                 mem::swap(&mut accepted_htlcs, &mut self.context.monitor_pending_forwards);
5255                 let mut failed_htlcs = Vec::new();
5256                 mem::swap(&mut failed_htlcs, &mut self.context.monitor_pending_failures);
5257                 let mut finalized_claimed_htlcs = Vec::new();
5258                 mem::swap(&mut finalized_claimed_htlcs, &mut self.context.monitor_pending_finalized_fulfills);
5259                 let mut pending_update_adds = Vec::new();
5260                 mem::swap(&mut pending_update_adds, &mut self.context.monitor_pending_update_adds);
5261
5262                 if self.context.channel_state.is_peer_disconnected() {
5263                         self.context.monitor_pending_revoke_and_ack = false;
5264                         self.context.monitor_pending_commitment_signed = false;
5265                         return MonitorRestoreUpdates {
5266                                 raa: None, commitment_update: None, order: RAACommitmentOrder::RevokeAndACKFirst,
5267                                 accepted_htlcs, failed_htlcs, finalized_claimed_htlcs, pending_update_adds,
5268                                 funding_broadcastable, channel_ready, announcement_sigs
5269                         };
5270                 }
5271
5272                 let raa = if self.context.monitor_pending_revoke_and_ack {
5273                         Some(self.get_last_revoke_and_ack())
5274                 } else { None };
5275                 let commitment_update = if self.context.monitor_pending_commitment_signed {
5276                         self.get_last_commitment_update_for_send(logger).ok()
5277                 } else { None };
5278                 if commitment_update.is_some() {
5279                         self.mark_awaiting_response();
5280                 }
5281
5282                 self.context.monitor_pending_revoke_and_ack = false;
5283                 self.context.monitor_pending_commitment_signed = false;
5284                 let order = self.context.resend_order.clone();
5285                 log_debug!(logger, "Restored monitor updating in channel {} resulting in {}{} commitment update and {} RAA, with {} first",
5286                         &self.context.channel_id(), if funding_broadcastable.is_some() { "a funding broadcastable, " } else { "" },
5287                         if commitment_update.is_some() { "a" } else { "no" }, if raa.is_some() { "an" } else { "no" },
5288                         match order { RAACommitmentOrder::CommitmentFirst => "commitment", RAACommitmentOrder::RevokeAndACKFirst => "RAA"});
5289                 MonitorRestoreUpdates {
5290                         raa, commitment_update, order, accepted_htlcs, failed_htlcs, finalized_claimed_htlcs,
5291                         pending_update_adds, funding_broadcastable, channel_ready, announcement_sigs
5292                 }
5293         }
5294
5295         pub fn update_fee<F: Deref, L: Deref>(&mut self, fee_estimator: &LowerBoundedFeeEstimator<F>, msg: &msgs::UpdateFee, logger: &L) -> Result<(), ChannelError>
5296                 where F::Target: FeeEstimator, L::Target: Logger
5297         {
5298                 if self.context.is_outbound() {
5299                         return Err(ChannelError::Close("Non-funding remote tried to update channel fee".to_owned()));
5300                 }
5301                 if self.context.channel_state.is_peer_disconnected() {
5302                         return Err(ChannelError::Close("Peer sent update_fee when we needed a channel_reestablish".to_owned()));
5303                 }
5304                 Channel::<SP>::check_remote_fee(&self.context.channel_type, fee_estimator, msg.feerate_per_kw, Some(self.context.feerate_per_kw), logger)?;
5305
5306                 self.context.pending_update_fee = Some((msg.feerate_per_kw, FeeUpdateState::RemoteAnnounced));
5307                 self.context.update_time_counter += 1;
5308                 // Check that we won't be pushed over our dust exposure limit by the feerate increase.
5309                 let dust_exposure_limiting_feerate = self.context.get_dust_exposure_limiting_feerate(&fee_estimator);
5310                 let htlc_stats = self.context.get_pending_htlc_stats(None, dust_exposure_limiting_feerate);
5311                 let max_dust_htlc_exposure_msat = self.context.get_max_dust_htlc_exposure_msat(dust_exposure_limiting_feerate);
5312                 if htlc_stats.on_holder_tx_dust_exposure_msat > max_dust_htlc_exposure_msat {
5313                         return Err(ChannelError::Close(format!("Peer sent update_fee with a feerate ({}) which may over-expose us to dust-in-flight on our own transactions (totaling {} msat)",
5314                                 msg.feerate_per_kw, htlc_stats.on_holder_tx_dust_exposure_msat)));
5315                 }
5316                 if htlc_stats.on_counterparty_tx_dust_exposure_msat > max_dust_htlc_exposure_msat {
5317                         return Err(ChannelError::Close(format!("Peer sent update_fee with a feerate ({}) which may over-expose us to dust-in-flight on our counterparty's transactions (totaling {} msat)",
5318                                 msg.feerate_per_kw, htlc_stats.on_counterparty_tx_dust_exposure_msat)));
5319                 }
5320                 Ok(())
5321         }
5322
5323         /// Indicates that the signer may have some signatures for us, so we should retry if we're
5324         /// blocked.
5325         #[cfg(async_signing)]
5326         pub fn signer_maybe_unblocked<L: Deref>(&mut self, logger: &L) -> SignerResumeUpdates where L::Target: Logger {
5327                 let commitment_update = if self.context.signer_pending_commitment_update {
5328                         self.get_last_commitment_update_for_send(logger).ok()
5329                 } else { None };
5330                 let funding_signed = if self.context.signer_pending_funding && !self.context.is_outbound() {
5331                         self.context.get_funding_signed_msg(logger).1
5332                 } else { None };
5333                 let channel_ready = if funding_signed.is_some() {
5334                         self.check_get_channel_ready(0)
5335                 } else { None };
5336
5337                 log_trace!(logger, "Signer unblocked with {} commitment_update, {} funding_signed and {} channel_ready",
5338                         if commitment_update.is_some() { "a" } else { "no" },
5339                         if funding_signed.is_some() { "a" } else { "no" },
5340                         if channel_ready.is_some() { "a" } else { "no" });
5341
5342                 SignerResumeUpdates {
5343                         commitment_update,
5344                         funding_signed,
5345                         channel_ready,
5346                 }
5347         }
5348
5349         fn get_last_revoke_and_ack(&self) -> msgs::RevokeAndACK {
5350                 let next_per_commitment_point = self.context.holder_signer.as_ref().get_per_commitment_point(self.context.cur_holder_commitment_transaction_number, &self.context.secp_ctx);
5351                 let per_commitment_secret = self.context.holder_signer.as_ref().release_commitment_secret(self.context.cur_holder_commitment_transaction_number + 2);
5352                 msgs::RevokeAndACK {
5353                         channel_id: self.context.channel_id,
5354                         per_commitment_secret,
5355                         next_per_commitment_point,
5356                         #[cfg(taproot)]
5357                         next_local_nonce: None,
5358                 }
5359         }
5360
5361         /// Gets the last commitment update for immediate sending to our peer.
5362         fn get_last_commitment_update_for_send<L: Deref>(&mut self, logger: &L) -> Result<msgs::CommitmentUpdate, ()> where L::Target: Logger {
5363                 let mut update_add_htlcs = Vec::new();
5364                 let mut update_fulfill_htlcs = Vec::new();
5365                 let mut update_fail_htlcs = Vec::new();
5366                 let mut update_fail_malformed_htlcs = Vec::new();
5367
5368                 for htlc in self.context.pending_outbound_htlcs.iter() {
5369                         if let &OutboundHTLCState::LocalAnnounced(ref onion_packet) = &htlc.state {
5370                                 update_add_htlcs.push(msgs::UpdateAddHTLC {
5371                                         channel_id: self.context.channel_id(),
5372                                         htlc_id: htlc.htlc_id,
5373                                         amount_msat: htlc.amount_msat,
5374                                         payment_hash: htlc.payment_hash,
5375                                         cltv_expiry: htlc.cltv_expiry,
5376                                         onion_routing_packet: (**onion_packet).clone(),
5377                                         skimmed_fee_msat: htlc.skimmed_fee_msat,
5378                                         blinding_point: htlc.blinding_point,
5379                                 });
5380                         }
5381                 }
5382
5383                 for htlc in self.context.pending_inbound_htlcs.iter() {
5384                         if let &InboundHTLCState::LocalRemoved(ref reason) = &htlc.state {
5385                                 match reason {
5386                                         &InboundHTLCRemovalReason::FailRelay(ref err_packet) => {
5387                                                 update_fail_htlcs.push(msgs::UpdateFailHTLC {
5388                                                         channel_id: self.context.channel_id(),
5389                                                         htlc_id: htlc.htlc_id,
5390                                                         reason: err_packet.clone()
5391                                                 });
5392                                         },
5393                                         &InboundHTLCRemovalReason::FailMalformed((ref sha256_of_onion, ref failure_code)) => {
5394                                                 update_fail_malformed_htlcs.push(msgs::UpdateFailMalformedHTLC {
5395                                                         channel_id: self.context.channel_id(),
5396                                                         htlc_id: htlc.htlc_id,
5397                                                         sha256_of_onion: sha256_of_onion.clone(),
5398                                                         failure_code: failure_code.clone(),
5399                                                 });
5400                                         },
5401                                         &InboundHTLCRemovalReason::Fulfill(ref payment_preimage) => {
5402                                                 update_fulfill_htlcs.push(msgs::UpdateFulfillHTLC {
5403                                                         channel_id: self.context.channel_id(),
5404                                                         htlc_id: htlc.htlc_id,
5405                                                         payment_preimage: payment_preimage.clone(),
5406                                                 });
5407                                         },
5408                                 }
5409                         }
5410                 }
5411
5412                 let update_fee = if self.context.is_outbound() && self.context.pending_update_fee.is_some() {
5413                         Some(msgs::UpdateFee {
5414                                 channel_id: self.context.channel_id(),
5415                                 feerate_per_kw: self.context.pending_update_fee.unwrap().0,
5416                         })
5417                 } else { None };
5418
5419                 log_trace!(logger, "Regenerating latest commitment update in channel {} with{} {} update_adds, {} update_fulfills, {} update_fails, and {} update_fail_malformeds",
5420                                 &self.context.channel_id(), if update_fee.is_some() { " update_fee," } else { "" },
5421                                 update_add_htlcs.len(), update_fulfill_htlcs.len(), update_fail_htlcs.len(), update_fail_malformed_htlcs.len());
5422                 let commitment_signed = if let Ok(update) = self.send_commitment_no_state_update(logger).map(|(cu, _)| cu) {
5423                         if self.context.signer_pending_commitment_update {
5424                                 log_trace!(logger, "Commitment update generated: clearing signer_pending_commitment_update");
5425                                 self.context.signer_pending_commitment_update = false;
5426                         }
5427                         update
5428                 } else {
5429                         #[cfg(not(async_signing))] {
5430                                 panic!("Failed to get signature for new commitment state");
5431                         }
5432                         #[cfg(async_signing)] {
5433                                 if !self.context.signer_pending_commitment_update {
5434                                         log_trace!(logger, "Commitment update awaiting signer: setting signer_pending_commitment_update");
5435                                         self.context.signer_pending_commitment_update = true;
5436                                 }
5437                                 return Err(());
5438                         }
5439                 };
5440                 Ok(msgs::CommitmentUpdate {
5441                         update_add_htlcs, update_fulfill_htlcs, update_fail_htlcs, update_fail_malformed_htlcs, update_fee,
5442                         commitment_signed,
5443                 })
5444         }
5445
5446         /// Gets the `Shutdown` message we should send our peer on reconnect, if any.
5447         pub fn get_outbound_shutdown(&self) -> Option<msgs::Shutdown> {
5448                 if self.context.channel_state.is_local_shutdown_sent() {
5449                         assert!(self.context.shutdown_scriptpubkey.is_some());
5450                         Some(msgs::Shutdown {
5451                                 channel_id: self.context.channel_id,
5452                                 scriptpubkey: self.get_closing_scriptpubkey(),
5453                         })
5454                 } else { None }
5455         }
5456
5457         /// May panic if some calls other than message-handling calls (which will all Err immediately)
5458         /// have been called between remove_uncommitted_htlcs_and_mark_paused and this call.
5459         ///
5460         /// Some links printed in log lines are included here to check them during build (when run with
5461         /// `cargo doc --document-private-items`):
5462         /// [`super::channelmanager::ChannelManager::force_close_without_broadcasting_txn`] and
5463         /// [`super::channelmanager::ChannelManager::force_close_all_channels_without_broadcasting_txn`].
5464         pub fn channel_reestablish<L: Deref, NS: Deref>(
5465                 &mut self, msg: &msgs::ChannelReestablish, logger: &L, node_signer: &NS,
5466                 chain_hash: ChainHash, user_config: &UserConfig, best_block: &BestBlock
5467         ) -> Result<ReestablishResponses, ChannelError>
5468         where
5469                 L::Target: Logger,
5470                 NS::Target: NodeSigner
5471         {
5472                 if !self.context.channel_state.is_peer_disconnected() {
5473                         // While BOLT 2 doesn't indicate explicitly we should error this channel here, it
5474                         // almost certainly indicates we are going to end up out-of-sync in some way, so we
5475                         // just close here instead of trying to recover.
5476                         return Err(ChannelError::Close("Peer sent a loose channel_reestablish not after reconnect".to_owned()));
5477                 }
5478
5479                 if msg.next_local_commitment_number >= INITIAL_COMMITMENT_NUMBER || msg.next_remote_commitment_number >= INITIAL_COMMITMENT_NUMBER ||
5480                         msg.next_local_commitment_number == 0 {
5481                         return Err(ChannelError::Close("Peer sent an invalid channel_reestablish to force close in a non-standard way".to_owned()));
5482                 }
5483
5484                 let our_commitment_transaction = INITIAL_COMMITMENT_NUMBER - self.context.cur_holder_commitment_transaction_number - 1;
5485                 if msg.next_remote_commitment_number > 0 {
5486                         let expected_point = self.context.holder_signer.as_ref().get_per_commitment_point(INITIAL_COMMITMENT_NUMBER - msg.next_remote_commitment_number + 1, &self.context.secp_ctx);
5487                         let given_secret = SecretKey::from_slice(&msg.your_last_per_commitment_secret)
5488                                 .map_err(|_| ChannelError::Close("Peer sent a garbage channel_reestablish with unparseable secret key".to_owned()))?;
5489                         if expected_point != PublicKey::from_secret_key(&self.context.secp_ctx, &given_secret) {
5490                                 return Err(ChannelError::Close("Peer sent a garbage channel_reestablish with secret key not matching the commitment height provided".to_owned()));
5491                         }
5492                         if msg.next_remote_commitment_number > our_commitment_transaction {
5493                                 macro_rules! log_and_panic {
5494                                         ($err_msg: expr) => {
5495                                                 log_error!(logger, $err_msg, &self.context.channel_id, log_pubkey!(self.context.counterparty_node_id));
5496                                                 panic!($err_msg, &self.context.channel_id, log_pubkey!(self.context.counterparty_node_id));
5497                                         }
5498                                 }
5499                                 log_and_panic!("We have fallen behind - we have received proof that if we broadcast our counterparty is going to claim all our funds.\n\
5500                                         This implies you have restarted with lost ChannelMonitor and ChannelManager state, the first of which is a violation of the LDK chain::Watch requirements.\n\
5501                                         More specifically, this means you have a bug in your implementation that can cause loss of funds, or you are running with an old backup, which is unsafe.\n\
5502                                         If you have restored from an old backup and wish to force-close channels and return to operation, you should start up, call\n\
5503                                         ChannelManager::force_close_without_broadcasting_txn on channel {} with counterparty {} or\n\
5504                                         ChannelManager::force_close_all_channels_without_broadcasting_txn, then reconnect to peer(s).\n\
5505                                         Note that due to a long-standing bug in lnd you may have to reach out to peers running lnd-based nodes to ask them to manually force-close channels\n\
5506                                         See https://github.com/lightningdevkit/rust-lightning/issues/1565 for more info.");
5507                         }
5508                 }
5509
5510                 // Before we change the state of the channel, we check if the peer is sending a very old
5511                 // commitment transaction number, if yes we send a warning message.
5512                 if msg.next_remote_commitment_number + 1 < our_commitment_transaction {
5513                         return Err(ChannelError::Warn(format!(
5514                                 "Peer attempted to reestablish channel with a very old local commitment transaction: {} (received) vs {} (expected)",
5515                                 msg.next_remote_commitment_number,
5516                                 our_commitment_transaction
5517                         )));
5518                 }
5519
5520                 // Go ahead and unmark PeerDisconnected as various calls we may make check for it (and all
5521                 // remaining cases either succeed or ErrorMessage-fail).
5522                 self.context.channel_state.clear_peer_disconnected();
5523                 self.context.sent_message_awaiting_response = None;
5524
5525                 let shutdown_msg = self.get_outbound_shutdown();
5526
5527                 let announcement_sigs = self.get_announcement_sigs(node_signer, chain_hash, user_config, best_block.height, logger);
5528
5529                 if matches!(self.context.channel_state, ChannelState::AwaitingChannelReady(_)) {
5530                         // If we're waiting on a monitor update, we shouldn't re-send any channel_ready's.
5531                         if !self.context.channel_state.is_our_channel_ready() ||
5532                                         self.context.channel_state.is_monitor_update_in_progress() {
5533                                 if msg.next_remote_commitment_number != 0 {
5534                                         return Err(ChannelError::Close("Peer claimed they saw a revoke_and_ack but we haven't sent channel_ready yet".to_owned()));
5535                                 }
5536                                 // Short circuit the whole handler as there is nothing we can resend them
5537                                 return Ok(ReestablishResponses {
5538                                         channel_ready: None,
5539                                         raa: None, commitment_update: None,
5540                                         order: RAACommitmentOrder::CommitmentFirst,
5541                                         shutdown_msg, announcement_sigs,
5542                                 });
5543                         }
5544
5545                         // We have OurChannelReady set!
5546                         let next_per_commitment_point = self.context.holder_signer.as_ref().get_per_commitment_point(self.context.cur_holder_commitment_transaction_number, &self.context.secp_ctx);
5547                         return Ok(ReestablishResponses {
5548                                 channel_ready: Some(msgs::ChannelReady {
5549                                         channel_id: self.context.channel_id(),
5550                                         next_per_commitment_point,
5551                                         short_channel_id_alias: Some(self.context.outbound_scid_alias),
5552                                 }),
5553                                 raa: None, commitment_update: None,
5554                                 order: RAACommitmentOrder::CommitmentFirst,
5555                                 shutdown_msg, announcement_sigs,
5556                         });
5557                 }
5558
5559                 let required_revoke = if msg.next_remote_commitment_number == our_commitment_transaction {
5560                         // Remote isn't waiting on any RevokeAndACK from us!
5561                         // Note that if we need to repeat our ChannelReady we'll do that in the next if block.
5562                         None
5563                 } else if msg.next_remote_commitment_number + 1 == our_commitment_transaction {
5564                         if self.context.channel_state.is_monitor_update_in_progress() {
5565                                 self.context.monitor_pending_revoke_and_ack = true;
5566                                 None
5567                         } else {
5568                                 Some(self.get_last_revoke_and_ack())
5569                         }
5570                 } else {
5571                         debug_assert!(false, "All values should have been handled in the four cases above");
5572                         return Err(ChannelError::Close(format!(
5573                                 "Peer attempted to reestablish channel expecting a future local commitment transaction: {} (received) vs {} (expected)",
5574                                 msg.next_remote_commitment_number,
5575                                 our_commitment_transaction
5576                         )));
5577                 };
5578
5579                 // We increment cur_counterparty_commitment_transaction_number only upon receipt of
5580                 // revoke_and_ack, not on sending commitment_signed, so we add one if have
5581                 // AwaitingRemoteRevoke set, which indicates we sent a commitment_signed but haven't gotten
5582                 // the corresponding revoke_and_ack back yet.
5583                 let is_awaiting_remote_revoke = self.context.channel_state.is_awaiting_remote_revoke();
5584                 if is_awaiting_remote_revoke && !self.is_awaiting_monitor_update() {
5585                         self.mark_awaiting_response();
5586                 }
5587                 let next_counterparty_commitment_number = INITIAL_COMMITMENT_NUMBER - self.context.cur_counterparty_commitment_transaction_number + if is_awaiting_remote_revoke { 1 } else { 0 };
5588
5589                 let channel_ready = if msg.next_local_commitment_number == 1 && INITIAL_COMMITMENT_NUMBER - self.context.cur_holder_commitment_transaction_number == 1 {
5590                         // We should never have to worry about MonitorUpdateInProgress resending ChannelReady
5591                         let next_per_commitment_point = self.context.holder_signer.as_ref().get_per_commitment_point(self.context.cur_holder_commitment_transaction_number, &self.context.secp_ctx);
5592                         Some(msgs::ChannelReady {
5593                                 channel_id: self.context.channel_id(),
5594                                 next_per_commitment_point,
5595                                 short_channel_id_alias: Some(self.context.outbound_scid_alias),
5596                         })
5597                 } else { None };
5598
5599                 if msg.next_local_commitment_number == next_counterparty_commitment_number {
5600                         if required_revoke.is_some() {
5601                                 log_debug!(logger, "Reconnected channel {} with only lost outbound RAA", &self.context.channel_id());
5602                         } else {
5603                                 log_debug!(logger, "Reconnected channel {} with no loss", &self.context.channel_id());
5604                         }
5605
5606                         Ok(ReestablishResponses {
5607                                 channel_ready, shutdown_msg, announcement_sigs,
5608                                 raa: required_revoke,
5609                                 commitment_update: None,
5610                                 order: self.context.resend_order.clone(),
5611                         })
5612                 } else if msg.next_local_commitment_number == next_counterparty_commitment_number - 1 {
5613                         if required_revoke.is_some() {
5614                                 log_debug!(logger, "Reconnected channel {} with lost outbound RAA and lost remote commitment tx", &self.context.channel_id());
5615                         } else {
5616                                 log_debug!(logger, "Reconnected channel {} with only lost remote commitment tx", &self.context.channel_id());
5617                         }
5618
5619                         if self.context.channel_state.is_monitor_update_in_progress() {
5620                                 self.context.monitor_pending_commitment_signed = true;
5621                                 Ok(ReestablishResponses {
5622                                         channel_ready, shutdown_msg, announcement_sigs,
5623                                         commitment_update: None, raa: None,
5624                                         order: self.context.resend_order.clone(),
5625                                 })
5626                         } else {
5627                                 Ok(ReestablishResponses {
5628                                         channel_ready, shutdown_msg, announcement_sigs,
5629                                         raa: required_revoke,
5630                                         commitment_update: self.get_last_commitment_update_for_send(logger).ok(),
5631                                         order: self.context.resend_order.clone(),
5632                                 })
5633                         }
5634                 } else if msg.next_local_commitment_number < next_counterparty_commitment_number {
5635                         Err(ChannelError::Close(format!(
5636                                 "Peer attempted to reestablish channel with a very old remote commitment transaction: {} (received) vs {} (expected)",
5637                                 msg.next_local_commitment_number,
5638                                 next_counterparty_commitment_number,
5639                         )))
5640                 } else {
5641                         Err(ChannelError::Close(format!(
5642                                 "Peer attempted to reestablish channel with a future remote commitment transaction: {} (received) vs {} (expected)",
5643                                 msg.next_local_commitment_number,
5644                                 next_counterparty_commitment_number,
5645                         )))
5646                 }
5647         }
5648
5649         /// Calculates and returns our minimum and maximum closing transaction fee amounts, in whole
5650         /// satoshis. The amounts remain consistent unless a peer disconnects/reconnects or we restart,
5651         /// at which point they will be recalculated.
5652         fn calculate_closing_fee_limits<F: Deref>(&mut self, fee_estimator: &LowerBoundedFeeEstimator<F>)
5653                 -> (u64, u64)
5654                 where F::Target: FeeEstimator
5655         {
5656                 if let Some((min, max)) = self.context.closing_fee_limits { return (min, max); }
5657
5658                 // Propose a range from our current Background feerate to our Normal feerate plus our
5659                 // force_close_avoidance_max_fee_satoshis.
5660                 // If we fail to come to consensus, we'll have to force-close.
5661                 let mut proposed_feerate = fee_estimator.bounded_sat_per_1000_weight(ConfirmationTarget::ChannelCloseMinimum);
5662                 // Use NonAnchorChannelFee because this should be an estimate for a channel close
5663                 // that we don't expect to need fee bumping
5664                 let normal_feerate = fee_estimator.bounded_sat_per_1000_weight(ConfirmationTarget::NonAnchorChannelFee);
5665                 let mut proposed_max_feerate = if self.context.is_outbound() { normal_feerate } else { u32::max_value() };
5666
5667                 // The spec requires that (when the channel does not have anchors) we only send absolute
5668                 // channel fees no greater than the absolute channel fee on the current commitment
5669                 // transaction. It's unclear *which* commitment transaction this refers to, and there isn't
5670                 // very good reason to apply such a limit in any case. We don't bother doing so, risking
5671                 // some force-closure by old nodes, but we wanted to close the channel anyway.
5672
5673                 if let Some(target_feerate) = self.context.target_closing_feerate_sats_per_kw {
5674                         let min_feerate = if self.context.is_outbound() { target_feerate } else { cmp::min(self.context.feerate_per_kw, target_feerate) };
5675                         proposed_feerate = cmp::max(proposed_feerate, min_feerate);
5676                         proposed_max_feerate = cmp::max(proposed_max_feerate, min_feerate);
5677                 }
5678
5679                 // Note that technically we could end up with a lower minimum fee if one sides' balance is
5680                 // below our dust limit, causing the output to disappear. We don't bother handling this
5681                 // case, however, as this should only happen if a channel is closed before any (material)
5682                 // payments have been made on it. This may cause slight fee overpayment and/or failure to
5683                 // come to consensus with our counterparty on appropriate fees, however it should be a
5684                 // relatively rare case. We can revisit this later, though note that in order to determine
5685                 // if the funders' output is dust we have to know the absolute fee we're going to use.
5686                 let tx_weight = self.get_closing_transaction_weight(Some(&self.get_closing_scriptpubkey()), Some(self.context.counterparty_shutdown_scriptpubkey.as_ref().unwrap()));
5687                 let proposed_total_fee_satoshis = proposed_feerate as u64 * tx_weight / 1000;
5688                 let proposed_max_total_fee_satoshis = if self.context.is_outbound() {
5689                                 // We always add force_close_avoidance_max_fee_satoshis to our normal
5690                                 // feerate-calculated fee, but allow the max to be overridden if we're using a
5691                                 // target feerate-calculated fee.
5692                                 cmp::max(normal_feerate as u64 * tx_weight / 1000 + self.context.config.options.force_close_avoidance_max_fee_satoshis,
5693                                         proposed_max_feerate as u64 * tx_weight / 1000)
5694                         } else {
5695                                 self.context.channel_value_satoshis - (self.context.value_to_self_msat + 999) / 1000
5696                         };
5697
5698                 self.context.closing_fee_limits = Some((proposed_total_fee_satoshis, proposed_max_total_fee_satoshis));
5699                 self.context.closing_fee_limits.clone().unwrap()
5700         }
5701
5702         /// Returns true if we're ready to commence the closing_signed negotiation phase. This is true
5703         /// after both sides have exchanged a `shutdown` message and all HTLCs have been drained. At
5704         /// this point if we're the funder we should send the initial closing_signed, and in any case
5705         /// shutdown should complete within a reasonable timeframe.
5706         fn closing_negotiation_ready(&self) -> bool {
5707                 self.context.closing_negotiation_ready()
5708         }
5709
5710         /// Checks if the closing_signed negotiation is making appropriate progress, possibly returning
5711         /// an Err if no progress is being made and the channel should be force-closed instead.
5712         /// Should be called on a one-minute timer.
5713         pub fn timer_check_closing_negotiation_progress(&mut self) -> Result<(), ChannelError> {
5714                 if self.closing_negotiation_ready() {
5715                         if self.context.closing_signed_in_flight {
5716                                 return Err(ChannelError::Close("closing_signed negotiation failed to finish within two timer ticks".to_owned()));
5717                         } else {
5718                                 self.context.closing_signed_in_flight = true;
5719                         }
5720                 }
5721                 Ok(())
5722         }
5723
5724         pub fn maybe_propose_closing_signed<F: Deref, L: Deref>(
5725                 &mut self, fee_estimator: &LowerBoundedFeeEstimator<F>, logger: &L)
5726                 -> Result<(Option<msgs::ClosingSigned>, Option<Transaction>, Option<ShutdownResult>), ChannelError>
5727                 where F::Target: FeeEstimator, L::Target: Logger
5728         {
5729                 // If we're waiting on a monitor persistence, that implies we're also waiting to send some
5730                 // message to our counterparty (probably a `revoke_and_ack`). In such a case, we shouldn't
5731                 // initiate `closing_signed` negotiation until we're clear of all pending messages. Note
5732                 // that closing_negotiation_ready checks this case (as well as a few others).
5733                 if self.context.last_sent_closing_fee.is_some() || !self.closing_negotiation_ready() {
5734                         return Ok((None, None, None));
5735                 }
5736
5737                 if !self.context.is_outbound() {
5738                         if let Some(msg) = &self.context.pending_counterparty_closing_signed.take() {
5739                                 return self.closing_signed(fee_estimator, &msg);
5740                         }
5741                         return Ok((None, None, None));
5742                 }
5743
5744                 // If we're waiting on a counterparty `commitment_signed` to clear some updates from our
5745                 // local commitment transaction, we can't yet initiate `closing_signed` negotiation.
5746                 if self.context.expecting_peer_commitment_signed {
5747                         return Ok((None, None, None));
5748                 }
5749
5750                 let (our_min_fee, our_max_fee) = self.calculate_closing_fee_limits(fee_estimator);
5751
5752                 assert!(self.context.shutdown_scriptpubkey.is_some());
5753                 let (closing_tx, total_fee_satoshis) = self.build_closing_transaction(our_min_fee, false);
5754                 log_trace!(logger, "Proposing initial closing_signed for our counterparty with a fee range of {}-{} sat (with initial proposal {} sats)",
5755                         our_min_fee, our_max_fee, total_fee_satoshis);
5756
5757                 match &self.context.holder_signer {
5758                         ChannelSignerType::Ecdsa(ecdsa) => {
5759                                 let sig = ecdsa
5760                                         .sign_closing_transaction(&closing_tx, &self.context.secp_ctx)
5761                                         .map_err(|()| ChannelError::Close("Failed to get signature for closing transaction.".to_owned()))?;
5762
5763                                 self.context.last_sent_closing_fee = Some((total_fee_satoshis, sig.clone()));
5764                                 Ok((Some(msgs::ClosingSigned {
5765                                         channel_id: self.context.channel_id,
5766                                         fee_satoshis: total_fee_satoshis,
5767                                         signature: sig,
5768                                         fee_range: Some(msgs::ClosingSignedFeeRange {
5769                                                 min_fee_satoshis: our_min_fee,
5770                                                 max_fee_satoshis: our_max_fee,
5771                                         }),
5772                                 }), None, None))
5773                         },
5774                         // TODO (taproot|arik)
5775                         #[cfg(taproot)]
5776                         _ => todo!()
5777                 }
5778         }
5779
5780         // Marks a channel as waiting for a response from the counterparty. If it's not received
5781         // [`DISCONNECT_PEER_AWAITING_RESPONSE_TICKS`] after sending our own to them, then we'll attempt
5782         // a reconnection.
5783         fn mark_awaiting_response(&mut self) {
5784                 self.context.sent_message_awaiting_response = Some(0);
5785         }
5786
5787         /// Determines whether we should disconnect the counterparty due to not receiving a response
5788         /// within our expected timeframe.
5789         ///
5790         /// This should be called on every [`super::channelmanager::ChannelManager::timer_tick_occurred`].
5791         pub fn should_disconnect_peer_awaiting_response(&mut self) -> bool {
5792                 let ticks_elapsed = if let Some(ticks_elapsed) = self.context.sent_message_awaiting_response.as_mut() {
5793                         ticks_elapsed
5794                 } else {
5795                         // Don't disconnect when we're not waiting on a response.
5796                         return false;
5797                 };
5798                 *ticks_elapsed += 1;
5799                 *ticks_elapsed >= DISCONNECT_PEER_AWAITING_RESPONSE_TICKS
5800         }
5801
5802         pub fn shutdown(
5803                 &mut self, signer_provider: &SP, their_features: &InitFeatures, msg: &msgs::Shutdown
5804         ) -> Result<(Option<msgs::Shutdown>, Option<ChannelMonitorUpdate>, Vec<(HTLCSource, PaymentHash)>), ChannelError>
5805         {
5806                 if self.context.channel_state.is_peer_disconnected() {
5807                         return Err(ChannelError::Close("Peer sent shutdown when we needed a channel_reestablish".to_owned()));
5808                 }
5809                 if self.context.channel_state.is_pre_funded_state() {
5810                         // Spec says we should fail the connection, not the channel, but that's nonsense, there
5811                         // are plenty of reasons you may want to fail a channel pre-funding, and spec says you
5812                         // can do that via error message without getting a connection fail anyway...
5813                         return Err(ChannelError::Close("Peer sent shutdown pre-funding generation".to_owned()));
5814                 }
5815                 for htlc in self.context.pending_inbound_htlcs.iter() {
5816                         if let InboundHTLCState::RemoteAnnounced(_) = htlc.state {
5817                                 return Err(ChannelError::Close("Got shutdown with remote pending HTLCs".to_owned()));
5818                         }
5819                 }
5820                 assert!(!matches!(self.context.channel_state, ChannelState::ShutdownComplete));
5821
5822                 if !script::is_bolt2_compliant(&msg.scriptpubkey, their_features) {
5823                         return Err(ChannelError::Warn(format!("Got a nonstandard scriptpubkey ({}) from remote peer", msg.scriptpubkey.to_hex_string())));
5824                 }
5825
5826                 if self.context.counterparty_shutdown_scriptpubkey.is_some() {
5827                         if Some(&msg.scriptpubkey) != self.context.counterparty_shutdown_scriptpubkey.as_ref() {
5828                                 return Err(ChannelError::Warn(format!("Got shutdown request with a scriptpubkey ({}) which did not match their previous scriptpubkey.", msg.scriptpubkey.to_hex_string())));
5829                         }
5830                 } else {
5831                         self.context.counterparty_shutdown_scriptpubkey = Some(msg.scriptpubkey.clone());
5832                 }
5833
5834                 // If we have any LocalAnnounced updates we'll probably just get back an update_fail_htlc
5835                 // immediately after the commitment dance, but we can send a Shutdown because we won't send
5836                 // any further commitment updates after we set LocalShutdownSent.
5837                 let send_shutdown = !self.context.channel_state.is_local_shutdown_sent();
5838
5839                 let update_shutdown_script = match self.context.shutdown_scriptpubkey {
5840                         Some(_) => false,
5841                         None => {
5842                                 assert!(send_shutdown);
5843                                 let shutdown_scriptpubkey = match signer_provider.get_shutdown_scriptpubkey() {
5844                                         Ok(scriptpubkey) => scriptpubkey,
5845                                         Err(_) => return Err(ChannelError::Close("Failed to get shutdown scriptpubkey".to_owned())),
5846                                 };
5847                                 if !shutdown_scriptpubkey.is_compatible(their_features) {
5848                                         return Err(ChannelError::Close(format!("Provided a scriptpubkey format not accepted by peer: {}", shutdown_scriptpubkey)));
5849                                 }
5850                                 self.context.shutdown_scriptpubkey = Some(shutdown_scriptpubkey);
5851                                 true
5852                         },
5853                 };
5854
5855                 // From here on out, we may not fail!
5856
5857                 self.context.channel_state.set_remote_shutdown_sent();
5858                 self.context.update_time_counter += 1;
5859
5860                 let monitor_update = if update_shutdown_script {
5861                         self.context.latest_monitor_update_id += 1;
5862                         let monitor_update = ChannelMonitorUpdate {
5863                                 update_id: self.context.latest_monitor_update_id,
5864                                 counterparty_node_id: Some(self.context.counterparty_node_id),
5865                                 updates: vec![ChannelMonitorUpdateStep::ShutdownScript {
5866                                         scriptpubkey: self.get_closing_scriptpubkey(),
5867                                 }],
5868                                 channel_id: Some(self.context.channel_id()),
5869                         };
5870                         self.monitor_updating_paused(false, false, false, Vec::new(), Vec::new(), Vec::new());
5871                         self.push_ret_blockable_mon_update(monitor_update)
5872                 } else { None };
5873                 let shutdown = if send_shutdown {
5874                         Some(msgs::Shutdown {
5875                                 channel_id: self.context.channel_id,
5876                                 scriptpubkey: self.get_closing_scriptpubkey(),
5877                         })
5878                 } else { None };
5879
5880                 // We can't send our shutdown until we've committed all of our pending HTLCs, but the
5881                 // remote side is unlikely to accept any new HTLCs, so we go ahead and "free" any holding
5882                 // cell HTLCs and return them to fail the payment.
5883                 self.context.holding_cell_update_fee = None;
5884                 let mut dropped_outbound_htlcs = Vec::with_capacity(self.context.holding_cell_htlc_updates.len());
5885                 self.context.holding_cell_htlc_updates.retain(|htlc_update| {
5886                         match htlc_update {
5887                                 &HTLCUpdateAwaitingACK::AddHTLC { ref payment_hash, ref source, .. } => {
5888                                         dropped_outbound_htlcs.push((source.clone(), payment_hash.clone()));
5889                                         false
5890                                 },
5891                                 _ => true
5892                         }
5893                 });
5894
5895                 self.context.channel_state.set_local_shutdown_sent();
5896                 self.context.update_time_counter += 1;
5897
5898                 Ok((shutdown, monitor_update, dropped_outbound_htlcs))
5899         }
5900
5901         fn build_signed_closing_transaction(&self, closing_tx: &ClosingTransaction, counterparty_sig: &Signature, sig: &Signature) -> Transaction {
5902                 let mut tx = closing_tx.trust().built_transaction().clone();
5903
5904                 tx.input[0].witness.push(Vec::new()); // First is the multisig dummy
5905
5906                 let funding_key = self.context.get_holder_pubkeys().funding_pubkey.serialize();
5907                 let counterparty_funding_key = self.context.counterparty_funding_pubkey().serialize();
5908                 let mut holder_sig = sig.serialize_der().to_vec();
5909                 holder_sig.push(EcdsaSighashType::All as u8);
5910                 let mut cp_sig = counterparty_sig.serialize_der().to_vec();
5911                 cp_sig.push(EcdsaSighashType::All as u8);
5912                 if funding_key[..] < counterparty_funding_key[..] {
5913                         tx.input[0].witness.push(holder_sig);
5914                         tx.input[0].witness.push(cp_sig);
5915                 } else {
5916                         tx.input[0].witness.push(cp_sig);
5917                         tx.input[0].witness.push(holder_sig);
5918                 }
5919
5920                 tx.input[0].witness.push(self.context.get_funding_redeemscript().into_bytes());
5921                 tx
5922         }
5923
5924         pub fn closing_signed<F: Deref>(
5925                 &mut self, fee_estimator: &LowerBoundedFeeEstimator<F>, msg: &msgs::ClosingSigned)
5926                 -> Result<(Option<msgs::ClosingSigned>, Option<Transaction>, Option<ShutdownResult>), ChannelError>
5927                 where F::Target: FeeEstimator
5928         {
5929                 if !self.context.channel_state.is_both_sides_shutdown() {
5930                         return Err(ChannelError::Close("Remote end sent us a closing_signed before both sides provided a shutdown".to_owned()));
5931                 }
5932                 if self.context.channel_state.is_peer_disconnected() {
5933                         return Err(ChannelError::Close("Peer sent closing_signed when we needed a channel_reestablish".to_owned()));
5934                 }
5935                 if !self.context.pending_inbound_htlcs.is_empty() || !self.context.pending_outbound_htlcs.is_empty() {
5936                         return Err(ChannelError::Close("Remote end sent us a closing_signed while there were still pending HTLCs".to_owned()));
5937                 }
5938                 if msg.fee_satoshis > TOTAL_BITCOIN_SUPPLY_SATOSHIS { // this is required to stop potential overflow in build_closing_transaction
5939                         return Err(ChannelError::Close("Remote tried to send us a closing tx with > 21 million BTC fee".to_owned()));
5940                 }
5941
5942                 if self.context.is_outbound() && self.context.last_sent_closing_fee.is_none() {
5943                         return Err(ChannelError::Close("Remote tried to send a closing_signed when we were supposed to propose the first one".to_owned()));
5944                 }
5945
5946                 if self.context.channel_state.is_monitor_update_in_progress() {
5947                         self.context.pending_counterparty_closing_signed = Some(msg.clone());
5948                         return Ok((None, None, None));
5949                 }
5950
5951                 let funding_redeemscript = self.context.get_funding_redeemscript();
5952                 let (mut closing_tx, used_total_fee) = self.build_closing_transaction(msg.fee_satoshis, false);
5953                 if used_total_fee != msg.fee_satoshis {
5954                         return Err(ChannelError::Close(format!("Remote sent us a closing_signed with a fee other than the value they can claim. Fee in message: {}. Actual closing tx fee: {}", msg.fee_satoshis, used_total_fee)));
5955                 }
5956                 let sighash = closing_tx.trust().get_sighash_all(&funding_redeemscript, self.context.channel_value_satoshis);
5957
5958                 match self.context.secp_ctx.verify_ecdsa(&sighash, &msg.signature, &self.context.get_counterparty_pubkeys().funding_pubkey) {
5959                         Ok(_) => {},
5960                         Err(_e) => {
5961                                 // The remote end may have decided to revoke their output due to inconsistent dust
5962                                 // limits, so check for that case by re-checking the signature here.
5963                                 closing_tx = self.build_closing_transaction(msg.fee_satoshis, true).0;
5964                                 let sighash = closing_tx.trust().get_sighash_all(&funding_redeemscript, self.context.channel_value_satoshis);
5965                                 secp_check!(self.context.secp_ctx.verify_ecdsa(&sighash, &msg.signature, self.context.counterparty_funding_pubkey()), "Invalid closing tx signature from peer".to_owned());
5966                         },
5967                 };
5968
5969                 for outp in closing_tx.trust().built_transaction().output.iter() {
5970                         if !outp.script_pubkey.is_witness_program() && outp.value < MAX_STD_OUTPUT_DUST_LIMIT_SATOSHIS {
5971                                 return Err(ChannelError::Close("Remote sent us a closing_signed with a dust output. Always use segwit closing scripts!".to_owned()));
5972                         }
5973                 }
5974
5975                 let closure_reason = if self.initiated_shutdown() {
5976                         ClosureReason::LocallyInitiatedCooperativeClosure
5977                 } else {
5978                         ClosureReason::CounterpartyInitiatedCooperativeClosure
5979                 };
5980
5981                 assert!(self.context.shutdown_scriptpubkey.is_some());
5982                 if let Some((last_fee, sig)) = self.context.last_sent_closing_fee {
5983                         if last_fee == msg.fee_satoshis {
5984                                 let shutdown_result = ShutdownResult {
5985                                         closure_reason,
5986                                         monitor_update: None,
5987                                         dropped_outbound_htlcs: Vec::new(),
5988                                         unbroadcasted_batch_funding_txid: self.context.unbroadcasted_batch_funding_txid(),
5989                                         channel_id: self.context.channel_id,
5990                                         user_channel_id: self.context.user_id,
5991                                         channel_capacity_satoshis: self.context.channel_value_satoshis,
5992                                         counterparty_node_id: self.context.counterparty_node_id,
5993                                         unbroadcasted_funding_tx: self.context.unbroadcasted_funding(),
5994                                         channel_funding_txo: self.context.get_funding_txo(),
5995                                 };
5996                                 let tx = self.build_signed_closing_transaction(&mut closing_tx, &msg.signature, &sig);
5997                                 self.context.channel_state = ChannelState::ShutdownComplete;
5998                                 self.context.update_time_counter += 1;
5999                                 return Ok((None, Some(tx), Some(shutdown_result)));
6000                         }
6001                 }
6002
6003                 let (our_min_fee, our_max_fee) = self.calculate_closing_fee_limits(fee_estimator);
6004
6005                 macro_rules! propose_fee {
6006                         ($new_fee: expr) => {
6007                                 let (closing_tx, used_fee) = if $new_fee == msg.fee_satoshis {
6008                                         (closing_tx, $new_fee)
6009                                 } else {
6010                                         self.build_closing_transaction($new_fee, false)
6011                                 };
6012
6013                                 return match &self.context.holder_signer {
6014                                         ChannelSignerType::Ecdsa(ecdsa) => {
6015                                                 let sig = ecdsa
6016                                                         .sign_closing_transaction(&closing_tx, &self.context.secp_ctx)
6017                                                         .map_err(|_| ChannelError::Close("External signer refused to sign closing transaction".to_owned()))?;
6018                                                 let (signed_tx, shutdown_result) = if $new_fee == msg.fee_satoshis {
6019                                                         let shutdown_result = ShutdownResult {
6020                                                                 closure_reason,
6021                                                                 monitor_update: None,
6022                                                                 dropped_outbound_htlcs: Vec::new(),
6023                                                                 unbroadcasted_batch_funding_txid: self.context.unbroadcasted_batch_funding_txid(),
6024                                                                 channel_id: self.context.channel_id,
6025                                                                 user_channel_id: self.context.user_id,
6026                                                                 channel_capacity_satoshis: self.context.channel_value_satoshis,
6027                                                                 counterparty_node_id: self.context.counterparty_node_id,
6028                                                                 unbroadcasted_funding_tx: self.context.unbroadcasted_funding(),
6029                                                                 channel_funding_txo: self.context.get_funding_txo(),
6030                                                         };
6031                                                         self.context.channel_state = ChannelState::ShutdownComplete;
6032                                                         self.context.update_time_counter += 1;
6033                                                         let tx = self.build_signed_closing_transaction(&closing_tx, &msg.signature, &sig);
6034                                                         (Some(tx), Some(shutdown_result))
6035                                                 } else {
6036                                                         (None, None)
6037                                                 };
6038
6039                                                 self.context.last_sent_closing_fee = Some((used_fee, sig.clone()));
6040                                                 Ok((Some(msgs::ClosingSigned {
6041                                                         channel_id: self.context.channel_id,
6042                                                         fee_satoshis: used_fee,
6043                                                         signature: sig,
6044                                                         fee_range: Some(msgs::ClosingSignedFeeRange {
6045                                                                 min_fee_satoshis: our_min_fee,
6046                                                                 max_fee_satoshis: our_max_fee,
6047                                                         }),
6048                                                 }), signed_tx, shutdown_result))
6049                                         },
6050                                         // TODO (taproot|arik)
6051                                         #[cfg(taproot)]
6052                                         _ => todo!()
6053                                 }
6054                         }
6055                 }
6056
6057                 if let Some(msgs::ClosingSignedFeeRange { min_fee_satoshis, max_fee_satoshis }) = msg.fee_range {
6058                         if msg.fee_satoshis < min_fee_satoshis || msg.fee_satoshis > max_fee_satoshis {
6059                                 return Err(ChannelError::Close(format!("Peer sent a bogus closing_signed - suggested fee of {} sat was not in their desired range of {} sat - {} sat", msg.fee_satoshis, min_fee_satoshis, max_fee_satoshis)));
6060                         }
6061                         if max_fee_satoshis < our_min_fee {
6062                                 return Err(ChannelError::Warn(format!("Unable to come to consensus about closing feerate, remote's max fee ({} sat) was smaller than our min fee ({} sat)", max_fee_satoshis, our_min_fee)));
6063                         }
6064                         if min_fee_satoshis > our_max_fee {
6065                                 return Err(ChannelError::Warn(format!("Unable to come to consensus about closing feerate, remote's min fee ({} sat) was greater than our max fee ({} sat)", min_fee_satoshis, our_max_fee)));
6066                         }
6067
6068                         if !self.context.is_outbound() {
6069                                 // They have to pay, so pick the highest fee in the overlapping range.
6070                                 // We should never set an upper bound aside from their full balance
6071                                 debug_assert_eq!(our_max_fee, self.context.channel_value_satoshis - (self.context.value_to_self_msat + 999) / 1000);
6072                                 propose_fee!(cmp::min(max_fee_satoshis, our_max_fee));
6073                         } else {
6074                                 if msg.fee_satoshis < our_min_fee || msg.fee_satoshis > our_max_fee {
6075                                         return Err(ChannelError::Close(format!("Peer sent a bogus closing_signed - suggested fee of {} sat was not in our desired range of {} sat - {} sat after we informed them of our range.",
6076                                                 msg.fee_satoshis, our_min_fee, our_max_fee)));
6077                                 }
6078                                 // The proposed fee is in our acceptable range, accept it and broadcast!
6079                                 propose_fee!(msg.fee_satoshis);
6080                         }
6081                 } else {
6082                         // Old fee style negotiation. We don't bother to enforce whether they are complying
6083                         // with the "making progress" requirements, we just comply and hope for the best.
6084                         if let Some((last_fee, _)) = self.context.last_sent_closing_fee {
6085                                 if msg.fee_satoshis > last_fee {
6086                                         if msg.fee_satoshis < our_max_fee {
6087                                                 propose_fee!(msg.fee_satoshis);
6088                                         } else if last_fee < our_max_fee {
6089                                                 propose_fee!(our_max_fee);
6090                                         } else {
6091                                                 return Err(ChannelError::Close(format!("Unable to come to consensus about closing feerate, remote wants something ({} sat) higher than our max fee ({} sat)", msg.fee_satoshis, our_max_fee)));
6092                                         }
6093                                 } else {
6094                                         if msg.fee_satoshis > our_min_fee {
6095                                                 propose_fee!(msg.fee_satoshis);
6096                                         } else if last_fee > our_min_fee {
6097                                                 propose_fee!(our_min_fee);
6098                                         } else {
6099                                                 return Err(ChannelError::Close(format!("Unable to come to consensus about closing feerate, remote wants something ({} sat) lower than our min fee ({} sat)", msg.fee_satoshis, our_min_fee)));
6100                                         }
6101                                 }
6102                         } else {
6103                                 if msg.fee_satoshis < our_min_fee {
6104                                         propose_fee!(our_min_fee);
6105                                 } else if msg.fee_satoshis > our_max_fee {
6106                                         propose_fee!(our_max_fee);
6107                                 } else {
6108                                         propose_fee!(msg.fee_satoshis);
6109                                 }
6110                         }
6111                 }
6112         }
6113
6114         fn internal_htlc_satisfies_config(
6115                 &self, htlc: &msgs::UpdateAddHTLC, amt_to_forward: u64, outgoing_cltv_value: u32, config: &ChannelConfig,
6116         ) -> Result<(), (&'static str, u16)> {
6117                 let fee = amt_to_forward.checked_mul(config.forwarding_fee_proportional_millionths as u64)
6118                         .and_then(|prop_fee| (prop_fee / 1000000).checked_add(config.forwarding_fee_base_msat as u64));
6119                 if fee.is_none() || htlc.amount_msat < fee.unwrap() ||
6120                         (htlc.amount_msat - fee.unwrap()) < amt_to_forward {
6121                         return Err((
6122                                 "Prior hop has deviated from specified fees parameters or origin node has obsolete ones",
6123                                 0x1000 | 12, // fee_insufficient
6124                         ));
6125                 }
6126                 if (htlc.cltv_expiry as u64) < outgoing_cltv_value as u64 + config.cltv_expiry_delta as u64 {
6127                         return Err((
6128                                 "Forwarding node has tampered with the intended HTLC values or origin node has an obsolete cltv_expiry_delta",
6129                                 0x1000 | 13, // incorrect_cltv_expiry
6130                         ));
6131                 }
6132                 Ok(())
6133         }
6134
6135         /// Determines whether the parameters of an incoming HTLC to be forwarded satisfy the channel's
6136         /// [`ChannelConfig`]. This first looks at the channel's current [`ChannelConfig`], and if
6137         /// unsuccessful, falls back to the previous one if one exists.
6138         pub fn htlc_satisfies_config(
6139                 &self, htlc: &msgs::UpdateAddHTLC, amt_to_forward: u64, outgoing_cltv_value: u32,
6140         ) -> Result<(), (&'static str, u16)> {
6141                 self.internal_htlc_satisfies_config(&htlc, amt_to_forward, outgoing_cltv_value, &self.context.config())
6142                         .or_else(|err| {
6143                                 if let Some(prev_config) = self.context.prev_config() {
6144                                         self.internal_htlc_satisfies_config(htlc, amt_to_forward, outgoing_cltv_value, &prev_config)
6145                                 } else {
6146                                         Err(err)
6147                                 }
6148                         })
6149         }
6150
6151         pub fn can_accept_incoming_htlc<F: Deref, L: Deref>(
6152                 &self, msg: &msgs::UpdateAddHTLC, fee_estimator: &LowerBoundedFeeEstimator<F>, logger: L
6153         ) -> Result<(), (&'static str, u16)>
6154         where
6155                 F::Target: FeeEstimator,
6156                 L::Target: Logger
6157         {
6158                 if self.context.channel_state.is_local_shutdown_sent() {
6159                         return Err(("Shutdown was already sent", 0x4000|8))
6160                 }
6161
6162                 let dust_exposure_limiting_feerate = self.context.get_dust_exposure_limiting_feerate(&fee_estimator);
6163                 let htlc_stats = self.context.get_pending_htlc_stats(None, dust_exposure_limiting_feerate);
6164                 let max_dust_htlc_exposure_msat = self.context.get_max_dust_htlc_exposure_msat(dust_exposure_limiting_feerate);
6165                 let (htlc_timeout_dust_limit, htlc_success_dust_limit) = if self.context.get_channel_type().supports_anchors_zero_fee_htlc_tx() {
6166                         (0, 0)
6167                 } else {
6168                         let dust_buffer_feerate = self.context.get_dust_buffer_feerate(None) as u64;
6169                         (dust_buffer_feerate * htlc_timeout_tx_weight(self.context.get_channel_type()) / 1000,
6170                                 dust_buffer_feerate * htlc_success_tx_weight(self.context.get_channel_type()) / 1000)
6171                 };
6172                 let exposure_dust_limit_timeout_sats = htlc_timeout_dust_limit + self.context.counterparty_dust_limit_satoshis;
6173                 if msg.amount_msat / 1000 < exposure_dust_limit_timeout_sats {
6174                         let on_counterparty_tx_dust_htlc_exposure_msat = htlc_stats.on_counterparty_tx_dust_exposure_msat + msg.amount_msat;
6175                         if on_counterparty_tx_dust_htlc_exposure_msat > max_dust_htlc_exposure_msat {
6176                                 log_info!(logger, "Cannot accept value that would put our exposure to dust HTLCs at {} over the limit {} on counterparty commitment tx",
6177                                         on_counterparty_tx_dust_htlc_exposure_msat, max_dust_htlc_exposure_msat);
6178                                 return Err(("Exceeded our dust exposure limit on counterparty commitment tx", 0x1000|7))
6179                         }
6180                 } else {
6181                         let htlc_dust_exposure_msat =
6182                                 per_outbound_htlc_counterparty_commit_tx_fee_msat(self.context.feerate_per_kw, &self.context.channel_type);
6183                         let counterparty_tx_dust_exposure =
6184                                 htlc_stats.on_counterparty_tx_dust_exposure_msat.saturating_add(htlc_dust_exposure_msat);
6185                         if counterparty_tx_dust_exposure > max_dust_htlc_exposure_msat {
6186                                 log_info!(logger, "Cannot accept value that would put our exposure to tx fee dust at {} over the limit {} on counterparty commitment tx",
6187                                         counterparty_tx_dust_exposure, max_dust_htlc_exposure_msat);
6188                                 return Err(("Exceeded our tx fee dust exposure limit on counterparty commitment tx", 0x1000|7))
6189                         }
6190                 }
6191
6192                 let exposure_dust_limit_success_sats = htlc_success_dust_limit + self.context.holder_dust_limit_satoshis;
6193                 if msg.amount_msat / 1000 < exposure_dust_limit_success_sats {
6194                         let on_holder_tx_dust_htlc_exposure_msat = htlc_stats.on_holder_tx_dust_exposure_msat + msg.amount_msat;
6195                         if on_holder_tx_dust_htlc_exposure_msat > max_dust_htlc_exposure_msat {
6196                                 log_info!(logger, "Cannot accept value that would put our exposure to dust HTLCs at {} over the limit {} on holder commitment tx",
6197                                         on_holder_tx_dust_htlc_exposure_msat, max_dust_htlc_exposure_msat);
6198                                 return Err(("Exceeded our dust exposure limit on holder commitment tx", 0x1000|7))
6199                         }
6200                 }
6201
6202                 let anchor_outputs_value_msat = if self.context.get_channel_type().supports_anchors_zero_fee_htlc_tx() {
6203                         ANCHOR_OUTPUT_VALUE_SATOSHI * 2 * 1000
6204                 } else {
6205                         0
6206                 };
6207
6208                 let mut removed_outbound_total_msat = 0;
6209                 for ref htlc in self.context.pending_outbound_htlcs.iter() {
6210                         if let OutboundHTLCState::AwaitingRemoteRevokeToRemove(OutboundHTLCOutcome::Success(_)) = htlc.state {
6211                                 removed_outbound_total_msat += htlc.amount_msat;
6212                         } else if let OutboundHTLCState::AwaitingRemovedRemoteRevoke(OutboundHTLCOutcome::Success(_)) = htlc.state {
6213                                 removed_outbound_total_msat += htlc.amount_msat;
6214                         }
6215                 }
6216
6217                 let pending_value_to_self_msat =
6218                         self.context.value_to_self_msat + htlc_stats.pending_inbound_htlcs_value_msat - removed_outbound_total_msat;
6219                 let pending_remote_value_msat =
6220                         self.context.channel_value_satoshis * 1000 - pending_value_to_self_msat;
6221
6222                 if !self.context.is_outbound() {
6223                         // `Some(())` is for the fee spike buffer we keep for the remote. This deviates from
6224                         // the spec because the fee spike buffer requirement doesn't exist on the receiver's
6225                         // side, only on the sender's. Note that with anchor outputs we are no longer as
6226                         // sensitive to fee spikes, so we need to account for them.
6227                         let htlc_candidate = HTLCCandidate::new(msg.amount_msat, HTLCInitiator::RemoteOffered);
6228                         let mut remote_fee_cost_incl_stuck_buffer_msat = self.context.next_remote_commit_tx_fee_msat(htlc_candidate, Some(()));
6229                         if !self.context.get_channel_type().supports_anchors_zero_fee_htlc_tx() {
6230                                 remote_fee_cost_incl_stuck_buffer_msat *= FEE_SPIKE_BUFFER_FEE_INCREASE_MULTIPLE;
6231                         }
6232                         if pending_remote_value_msat.saturating_sub(msg.amount_msat).saturating_sub(self.context.holder_selected_channel_reserve_satoshis * 1000).saturating_sub(anchor_outputs_value_msat) < remote_fee_cost_incl_stuck_buffer_msat {
6233                                 log_info!(logger, "Attempting to fail HTLC due to fee spike buffer violation in channel {}. Rebalancing is required.", &self.context.channel_id());
6234                                 return Err(("Fee spike buffer violation", 0x1000|7));
6235                         }
6236                 }
6237
6238                 Ok(())
6239         }
6240
6241         pub fn get_cur_holder_commitment_transaction_number(&self) -> u64 {
6242                 self.context.cur_holder_commitment_transaction_number + 1
6243         }
6244
6245         pub fn get_cur_counterparty_commitment_transaction_number(&self) -> u64 {
6246                 self.context.cur_counterparty_commitment_transaction_number + 1 - if self.context.channel_state.is_awaiting_remote_revoke() { 1 } else { 0 }
6247         }
6248
6249         pub fn get_revoked_counterparty_commitment_transaction_number(&self) -> u64 {
6250                 self.context.cur_counterparty_commitment_transaction_number + 2
6251         }
6252
6253         #[cfg(test)]
6254         pub fn get_signer(&self) -> &ChannelSignerType<SP> {
6255                 &self.context.holder_signer
6256         }
6257
6258         #[cfg(test)]
6259         pub fn get_value_stat(&self) -> ChannelValueStat {
6260                 ChannelValueStat {
6261                         value_to_self_msat: self.context.value_to_self_msat,
6262                         channel_value_msat: self.context.channel_value_satoshis * 1000,
6263                         channel_reserve_msat: self.context.counterparty_selected_channel_reserve_satoshis.unwrap() * 1000,
6264                         pending_outbound_htlcs_amount_msat: self.context.pending_outbound_htlcs.iter().map(|ref h| h.amount_msat).sum::<u64>(),
6265                         pending_inbound_htlcs_amount_msat: self.context.pending_inbound_htlcs.iter().map(|ref h| h.amount_msat).sum::<u64>(),
6266                         holding_cell_outbound_amount_msat: {
6267                                 let mut res = 0;
6268                                 for h in self.context.holding_cell_htlc_updates.iter() {
6269                                         match h {
6270                                                 &HTLCUpdateAwaitingACK::AddHTLC{amount_msat, .. } => {
6271                                                         res += amount_msat;
6272                                                 }
6273                                                 _ => {}
6274                                         }
6275                                 }
6276                                 res
6277                         },
6278                         counterparty_max_htlc_value_in_flight_msat: self.context.counterparty_max_htlc_value_in_flight_msat,
6279                         counterparty_dust_limit_msat: self.context.counterparty_dust_limit_satoshis * 1000,
6280                 }
6281         }
6282
6283         /// Returns true if this channel has been marked as awaiting a monitor update to move forward.
6284         /// Allowed in any state (including after shutdown)
6285         pub fn is_awaiting_monitor_update(&self) -> bool {
6286                 self.context.channel_state.is_monitor_update_in_progress()
6287         }
6288
6289         /// Gets the latest [`ChannelMonitorUpdate`] ID which has been released and is in-flight.
6290         pub fn get_latest_unblocked_monitor_update_id(&self) -> u64 {
6291                 if self.context.blocked_monitor_updates.is_empty() { return self.context.get_latest_monitor_update_id(); }
6292                 self.context.blocked_monitor_updates[0].update.update_id - 1
6293         }
6294
6295         /// Returns the next blocked monitor update, if one exists, and a bool which indicates a
6296         /// further blocked monitor update exists after the next.
6297         pub fn unblock_next_blocked_monitor_update(&mut self) -> Option<(ChannelMonitorUpdate, bool)> {
6298                 if self.context.blocked_monitor_updates.is_empty() { return None; }
6299                 Some((self.context.blocked_monitor_updates.remove(0).update,
6300                         !self.context.blocked_monitor_updates.is_empty()))
6301         }
6302
6303         /// Pushes a new monitor update into our monitor update queue, returning it if it should be
6304         /// immediately given to the user for persisting or `None` if it should be held as blocked.
6305         fn push_ret_blockable_mon_update(&mut self, update: ChannelMonitorUpdate)
6306         -> Option<ChannelMonitorUpdate> {
6307                 let release_monitor = self.context.blocked_monitor_updates.is_empty();
6308                 if !release_monitor {
6309                         self.context.blocked_monitor_updates.push(PendingChannelMonitorUpdate {
6310                                 update,
6311                         });
6312                         None
6313                 } else {
6314                         Some(update)
6315                 }
6316         }
6317
6318         /// On startup, its possible we detect some monitor updates have actually completed (and the
6319         /// ChannelManager was simply stale). In that case, we should simply drop them, which we do
6320         /// here after logging them.
6321         pub fn on_startup_drop_completed_blocked_mon_updates_through<L: Logger>(&mut self, logger: &L, loaded_mon_update_id: u64) {
6322                 let channel_id = self.context.channel_id();
6323                 self.context.blocked_monitor_updates.retain(|update| {
6324                         if update.update.update_id <= loaded_mon_update_id {
6325                                 log_info!(
6326                                         logger,
6327                                         "Dropping completed ChannelMonitorUpdate id {} on channel {} due to a stale ChannelManager",
6328                                         update.update.update_id,
6329                                         channel_id,
6330                                 );
6331                                 false
6332                         } else {
6333                                 true
6334                         }
6335                 });
6336         }
6337
6338         pub fn blocked_monitor_updates_pending(&self) -> usize {
6339                 self.context.blocked_monitor_updates.len()
6340         }
6341
6342         /// Returns true if the channel is awaiting the persistence of the initial ChannelMonitor.
6343         /// If the channel is outbound, this implies we have not yet broadcasted the funding
6344         /// transaction. If the channel is inbound, this implies simply that the channel has not
6345         /// advanced state.
6346         pub fn is_awaiting_initial_mon_persist(&self) -> bool {
6347                 if !self.is_awaiting_monitor_update() { return false; }
6348                 if matches!(
6349                         self.context.channel_state, ChannelState::AwaitingChannelReady(flags)
6350                         if flags.clone().clear(AwaitingChannelReadyFlags::THEIR_CHANNEL_READY | FundedStateFlags::PEER_DISCONNECTED | FundedStateFlags::MONITOR_UPDATE_IN_PROGRESS | AwaitingChannelReadyFlags::WAITING_FOR_BATCH).is_empty()
6351                 ) {
6352                         // If we're not a 0conf channel, we'll be waiting on a monitor update with only
6353                         // AwaitingChannelReady set, though our peer could have sent their channel_ready.
6354                         debug_assert!(self.context.minimum_depth.unwrap_or(1) > 0);
6355                         return true;
6356                 }
6357                 if self.context.cur_holder_commitment_transaction_number == INITIAL_COMMITMENT_NUMBER - 1 &&
6358                         self.context.cur_counterparty_commitment_transaction_number == INITIAL_COMMITMENT_NUMBER - 1 {
6359                         // If we're a 0-conf channel, we'll move beyond AwaitingChannelReady immediately even while
6360                         // waiting for the initial monitor persistence. Thus, we check if our commitment
6361                         // transaction numbers have both been iterated only exactly once (for the
6362                         // funding_signed), and we're awaiting monitor update.
6363                         //
6364                         // If we got here, we shouldn't have yet broadcasted the funding transaction (as the
6365                         // only way to get an awaiting-monitor-update state during initial funding is if the
6366                         // initial monitor persistence is still pending).
6367                         //
6368                         // Because deciding we're awaiting initial broadcast spuriously could result in
6369                         // funds-loss (as we don't have a monitor, but have the funding transaction confirmed),
6370                         // we hard-assert here, even in production builds.
6371                         if self.context.is_outbound() { assert!(self.context.funding_transaction.is_some()); }
6372                         assert!(self.context.monitor_pending_channel_ready);
6373                         assert_eq!(self.context.latest_monitor_update_id, 0);
6374                         return true;
6375                 }
6376                 false
6377         }
6378
6379         /// Returns true if our channel_ready has been sent
6380         pub fn is_our_channel_ready(&self) -> bool {
6381                 matches!(self.context.channel_state, ChannelState::AwaitingChannelReady(flags) if flags.is_set(AwaitingChannelReadyFlags::OUR_CHANNEL_READY)) ||
6382                         matches!(self.context.channel_state, ChannelState::ChannelReady(_))
6383         }
6384
6385         /// Returns true if our peer has either initiated or agreed to shut down the channel.
6386         pub fn received_shutdown(&self) -> bool {
6387                 self.context.channel_state.is_remote_shutdown_sent()
6388         }
6389
6390         /// Returns true if we either initiated or agreed to shut down the channel.
6391         pub fn sent_shutdown(&self) -> bool {
6392                 self.context.channel_state.is_local_shutdown_sent()
6393         }
6394
6395         /// Returns true if we initiated to shut down the channel.
6396         pub fn initiated_shutdown(&self) -> bool {
6397                 self.context.local_initiated_shutdown.is_some()
6398         }
6399
6400         /// Returns true if this channel is fully shut down. True here implies that no further actions
6401         /// may/will be taken on this channel, and thus this object should be freed. Any future changes
6402         /// will be handled appropriately by the chain monitor.
6403         pub fn is_shutdown(&self) -> bool {
6404                 matches!(self.context.channel_state, ChannelState::ShutdownComplete)
6405         }
6406
6407         pub fn channel_update_status(&self) -> ChannelUpdateStatus {
6408                 self.context.channel_update_status
6409         }
6410
6411         pub fn set_channel_update_status(&mut self, status: ChannelUpdateStatus) {
6412                 self.context.update_time_counter += 1;
6413                 self.context.channel_update_status = status;
6414         }
6415
6416         fn check_get_channel_ready(&mut self, height: u32) -> Option<msgs::ChannelReady> {
6417                 // Called:
6418                 //  * always when a new block/transactions are confirmed with the new height
6419                 //  * when funding is signed with a height of 0
6420                 if self.context.funding_tx_confirmation_height == 0 && self.context.minimum_depth != Some(0) {
6421                         return None;
6422                 }
6423
6424                 let funding_tx_confirmations = height as i64 - self.context.funding_tx_confirmation_height as i64 + 1;
6425                 if funding_tx_confirmations <= 0 {
6426                         self.context.funding_tx_confirmation_height = 0;
6427                 }
6428
6429                 if funding_tx_confirmations < self.context.minimum_depth.unwrap_or(0) as i64 {
6430                         return None;
6431                 }
6432
6433                 // If we're still pending the signature on a funding transaction, then we're not ready to send a
6434                 // channel_ready yet.
6435                 if self.context.signer_pending_funding {
6436                         return None;
6437                 }
6438
6439                 // Note that we don't include ChannelState::WaitingForBatch as we don't want to send
6440                 // channel_ready until the entire batch is ready.
6441                 let need_commitment_update = if matches!(self.context.channel_state, ChannelState::AwaitingChannelReady(f) if f.clone().clear(FundedStateFlags::ALL.into()).is_empty()) {
6442                         self.context.channel_state.set_our_channel_ready();
6443                         true
6444                 } else if matches!(self.context.channel_state, ChannelState::AwaitingChannelReady(f) if f.clone().clear(FundedStateFlags::ALL.into()) == AwaitingChannelReadyFlags::THEIR_CHANNEL_READY) {
6445                         self.context.channel_state = ChannelState::ChannelReady(self.context.channel_state.with_funded_state_flags_mask().into());
6446                         self.context.update_time_counter += 1;
6447                         true
6448                 } else if matches!(self.context.channel_state, ChannelState::AwaitingChannelReady(f) if f.clone().clear(FundedStateFlags::ALL.into()) == AwaitingChannelReadyFlags::OUR_CHANNEL_READY) {
6449                         // We got a reorg but not enough to trigger a force close, just ignore.
6450                         false
6451                 } else {
6452                         if self.context.funding_tx_confirmation_height != 0 &&
6453                                 self.context.channel_state < ChannelState::ChannelReady(ChannelReadyFlags::new())
6454                         {
6455                                 // We should never see a funding transaction on-chain until we've received
6456                                 // funding_signed (if we're an outbound channel), or seen funding_generated (if we're
6457                                 // an inbound channel - before that we have no known funding TXID). The fuzzer,
6458                                 // however, may do this and we shouldn't treat it as a bug.
6459                                 #[cfg(not(fuzzing))]
6460                                 panic!("Started confirming a channel in a state pre-AwaitingChannelReady: {}.\n\
6461                                         Do NOT broadcast a funding transaction manually - let LDK do it for you!",
6462                                         self.context.channel_state.to_u32());
6463                         }
6464                         // We got a reorg but not enough to trigger a force close, just ignore.
6465                         false
6466                 };
6467
6468                 if need_commitment_update {
6469                         if !self.context.channel_state.is_monitor_update_in_progress() {
6470                                 if !self.context.channel_state.is_peer_disconnected() {
6471                                         let next_per_commitment_point =
6472                                                 self.context.holder_signer.as_ref().get_per_commitment_point(INITIAL_COMMITMENT_NUMBER - 1, &self.context.secp_ctx);
6473                                         return Some(msgs::ChannelReady {
6474                                                 channel_id: self.context.channel_id,
6475                                                 next_per_commitment_point,
6476                                                 short_channel_id_alias: Some(self.context.outbound_scid_alias),
6477                                         });
6478                                 }
6479                         } else {
6480                                 self.context.monitor_pending_channel_ready = true;
6481                         }
6482                 }
6483                 None
6484         }
6485
6486         /// When a transaction is confirmed, we check whether it is or spends the funding transaction
6487         /// In the first case, we store the confirmation height and calculating the short channel id.
6488         /// In the second, we simply return an Err indicating we need to be force-closed now.
6489         pub fn transactions_confirmed<NS: Deref, L: Deref>(
6490                 &mut self, block_hash: &BlockHash, height: u32, txdata: &TransactionData,
6491                 chain_hash: ChainHash, node_signer: &NS, user_config: &UserConfig, logger: &L
6492         ) -> Result<(Option<msgs::ChannelReady>, Option<msgs::AnnouncementSignatures>), ClosureReason>
6493         where
6494                 NS::Target: NodeSigner,
6495                 L::Target: Logger
6496         {
6497                 let mut msgs = (None, None);
6498                 if let Some(funding_txo) = self.context.get_funding_txo() {
6499                         for &(index_in_block, tx) in txdata.iter() {
6500                                 // Check if the transaction is the expected funding transaction, and if it is,
6501                                 // check that it pays the right amount to the right script.
6502                                 if self.context.funding_tx_confirmation_height == 0 {
6503                                         if tx.txid() == funding_txo.txid {
6504                                                 let txo_idx = funding_txo.index as usize;
6505                                                 if txo_idx >= tx.output.len() || tx.output[txo_idx].script_pubkey != self.context.get_funding_redeemscript().to_v0_p2wsh() ||
6506                                                                 tx.output[txo_idx].value != self.context.channel_value_satoshis {
6507                                                         if self.context.is_outbound() {
6508                                                                 // If we generated the funding transaction and it doesn't match what it
6509                                                                 // should, the client is really broken and we should just panic and
6510                                                                 // tell them off. That said, because hash collisions happen with high
6511                                                                 // probability in fuzzing mode, if we're fuzzing we just close the
6512                                                                 // channel and move on.
6513                                                                 #[cfg(not(fuzzing))]
6514                                                                 panic!("Client called ChannelManager::funding_transaction_generated with bogus transaction!");
6515                                                         }
6516                                                         self.context.update_time_counter += 1;
6517                                                         let err_reason = "funding tx had wrong script/value or output index";
6518                                                         return Err(ClosureReason::ProcessingError { err: err_reason.to_owned() });
6519                                                 } else {
6520                                                         if self.context.is_outbound() {
6521                                                                 if !tx.is_coin_base() {
6522                                                                         for input in tx.input.iter() {
6523                                                                                 if input.witness.is_empty() {
6524                                                                                         // We generated a malleable funding transaction, implying we've
6525                                                                                         // just exposed ourselves to funds loss to our counterparty.
6526                                                                                         #[cfg(not(fuzzing))]
6527                                                                                         panic!("Client called ChannelManager::funding_transaction_generated with bogus transaction!");
6528                                                                                 }
6529                                                                         }
6530                                                                 }
6531                                                         }
6532                                                         self.context.funding_tx_confirmation_height = height;
6533                                                         self.context.funding_tx_confirmed_in = Some(*block_hash);
6534                                                         self.context.short_channel_id = match scid_from_parts(height as u64, index_in_block as u64, txo_idx as u64) {
6535                                                                 Ok(scid) => Some(scid),
6536                                                                 Err(_) => panic!("Block was bogus - either height was > 16 million, had > 16 million transactions, or had > 65k outputs"),
6537                                                         }
6538                                                 }
6539                                                 // If this is a coinbase transaction and not a 0-conf channel
6540                                                 // we should update our min_depth to 100 to handle coinbase maturity
6541                                                 if tx.is_coin_base() &&
6542                                                         self.context.minimum_depth.unwrap_or(0) > 0 &&
6543                                                         self.context.minimum_depth.unwrap_or(0) < COINBASE_MATURITY {
6544                                                         self.context.minimum_depth = Some(COINBASE_MATURITY);
6545                                                 }
6546                                         }
6547                                         // If we allow 1-conf funding, we may need to check for channel_ready here and
6548                                         // send it immediately instead of waiting for a best_block_updated call (which
6549                                         // may have already happened for this block).
6550                                         if let Some(channel_ready) = self.check_get_channel_ready(height) {
6551                                                 log_info!(logger, "Sending a channel_ready to our peer for channel {}", &self.context.channel_id);
6552                                                 let announcement_sigs = self.get_announcement_sigs(node_signer, chain_hash, user_config, height, logger);
6553                                                 msgs = (Some(channel_ready), announcement_sigs);
6554                                         }
6555                                 }
6556                                 for inp in tx.input.iter() {
6557                                         if inp.previous_output == funding_txo.into_bitcoin_outpoint() {
6558                                                 log_info!(logger, "Detected channel-closing tx {} spending {}:{}, closing channel {}", tx.txid(), inp.previous_output.txid, inp.previous_output.vout, &self.context.channel_id());
6559                                                 return Err(ClosureReason::CommitmentTxConfirmed);
6560                                         }
6561                                 }
6562                         }
6563                 }
6564                 Ok(msgs)
6565         }
6566
6567         /// When a new block is connected, we check the height of the block against outbound holding
6568         /// cell HTLCs in case we need to give up on them prematurely and time them out. Everything
6569         /// else (e.g. commitment transaction broadcasts, HTLC transaction broadcasting, etc) is
6570         /// handled by the ChannelMonitor.
6571         ///
6572         /// If we return Err, the channel may have been closed, at which point the standard
6573         /// requirements apply - no calls may be made except those explicitly stated to be allowed
6574         /// post-shutdown.
6575         ///
6576         /// May return some HTLCs (and their payment_hash) which have timed out and should be failed
6577         /// back.
6578         pub fn best_block_updated<NS: Deref, L: Deref>(
6579                 &mut self, height: u32, highest_header_time: u32, chain_hash: ChainHash,
6580                 node_signer: &NS, user_config: &UserConfig, logger: &L
6581         ) -> Result<(Option<msgs::ChannelReady>, Vec<(HTLCSource, PaymentHash)>, Option<msgs::AnnouncementSignatures>), ClosureReason>
6582         where
6583                 NS::Target: NodeSigner,
6584                 L::Target: Logger
6585         {
6586                 self.do_best_block_updated(height, highest_header_time, Some((chain_hash, node_signer, user_config)), logger)
6587         }
6588
6589         fn do_best_block_updated<NS: Deref, L: Deref>(
6590                 &mut self, height: u32, highest_header_time: u32,
6591                 chain_node_signer: Option<(ChainHash, &NS, &UserConfig)>, logger: &L
6592         ) -> Result<(Option<msgs::ChannelReady>, Vec<(HTLCSource, PaymentHash)>, Option<msgs::AnnouncementSignatures>), ClosureReason>
6593         where
6594                 NS::Target: NodeSigner,
6595                 L::Target: Logger
6596         {
6597                 let mut timed_out_htlcs = Vec::new();
6598                 // This mirrors the check in ChannelManager::decode_update_add_htlc_onion, refusing to
6599                 // forward an HTLC when our counterparty should almost certainly just fail it for expiring
6600                 // ~now.
6601                 let unforwarded_htlc_cltv_limit = height + LATENCY_GRACE_PERIOD_BLOCKS;
6602                 self.context.holding_cell_htlc_updates.retain(|htlc_update| {
6603                         match htlc_update {
6604                                 &HTLCUpdateAwaitingACK::AddHTLC { ref payment_hash, ref source, ref cltv_expiry, .. } => {
6605                                         if *cltv_expiry <= unforwarded_htlc_cltv_limit {
6606                                                 timed_out_htlcs.push((source.clone(), payment_hash.clone()));
6607                                                 false
6608                                         } else { true }
6609                                 },
6610                                 _ => true
6611                         }
6612                 });
6613
6614                 self.context.update_time_counter = cmp::max(self.context.update_time_counter, highest_header_time);
6615
6616                 if let Some(channel_ready) = self.check_get_channel_ready(height) {
6617                         let announcement_sigs = if let Some((chain_hash, node_signer, user_config)) = chain_node_signer {
6618                                 self.get_announcement_sigs(node_signer, chain_hash, user_config, height, logger)
6619                         } else { None };
6620                         log_info!(logger, "Sending a channel_ready to our peer for channel {}", &self.context.channel_id);
6621                         return Ok((Some(channel_ready), timed_out_htlcs, announcement_sigs));
6622                 }
6623
6624                 if matches!(self.context.channel_state, ChannelState::ChannelReady(_)) ||
6625                         self.context.channel_state.is_our_channel_ready() {
6626                         let mut funding_tx_confirmations = height as i64 - self.context.funding_tx_confirmation_height as i64 + 1;
6627                         if self.context.funding_tx_confirmation_height == 0 {
6628                                 // Note that check_get_channel_ready may reset funding_tx_confirmation_height to
6629                                 // zero if it has been reorged out, however in either case, our state flags
6630                                 // indicate we've already sent a channel_ready
6631                                 funding_tx_confirmations = 0;
6632                         }
6633
6634                         // If we've sent channel_ready (or have both sent and received channel_ready), and
6635                         // the funding transaction has become unconfirmed,
6636                         // close the channel and hope we can get the latest state on chain (because presumably
6637                         // the funding transaction is at least still in the mempool of most nodes).
6638                         //
6639                         // Note that ideally we wouldn't force-close if we see *any* reorg on a 1-conf or
6640                         // 0-conf channel, but not doing so may lead to the
6641                         // `ChannelManager::short_to_chan_info` map  being inconsistent, so we currently have
6642                         // to.
6643                         if funding_tx_confirmations == 0 && self.context.funding_tx_confirmed_in.is_some() {
6644                                 let err_reason = format!("Funding transaction was un-confirmed. Locked at {} confs, now have {} confs.",
6645                                         self.context.minimum_depth.unwrap(), funding_tx_confirmations);
6646                                 return Err(ClosureReason::ProcessingError { err: err_reason });
6647                         }
6648                 } else if !self.context.is_outbound() && self.context.funding_tx_confirmed_in.is_none() &&
6649                                 height >= self.context.channel_creation_height + FUNDING_CONF_DEADLINE_BLOCKS {
6650                         log_info!(logger, "Closing channel {} due to funding timeout", &self.context.channel_id);
6651                         // If funding_tx_confirmed_in is unset, the channel must not be active
6652                         assert!(self.context.channel_state <= ChannelState::ChannelReady(ChannelReadyFlags::new()));
6653                         assert!(!self.context.channel_state.is_our_channel_ready());
6654                         return Err(ClosureReason::FundingTimedOut);
6655                 }
6656
6657                 let announcement_sigs = if let Some((chain_hash, node_signer, user_config)) = chain_node_signer {
6658                         self.get_announcement_sigs(node_signer, chain_hash, user_config, height, logger)
6659                 } else { None };
6660                 Ok((None, timed_out_htlcs, announcement_sigs))
6661         }
6662
6663         /// Indicates the funding transaction is no longer confirmed in the main chain. This may
6664         /// force-close the channel, but may also indicate a harmless reorganization of a block or two
6665         /// before the channel has reached channel_ready and we can just wait for more blocks.
6666         pub fn funding_transaction_unconfirmed<L: Deref>(&mut self, logger: &L) -> Result<(), ClosureReason> where L::Target: Logger {
6667                 if self.context.funding_tx_confirmation_height != 0 {
6668                         // We handle the funding disconnection by calling best_block_updated with a height one
6669                         // below where our funding was connected, implying a reorg back to conf_height - 1.
6670                         let reorg_height = self.context.funding_tx_confirmation_height - 1;
6671                         // We use the time field to bump the current time we set on channel updates if its
6672                         // larger. If we don't know that time has moved forward, we can just set it to the last
6673                         // time we saw and it will be ignored.
6674                         let best_time = self.context.update_time_counter;
6675                         match self.do_best_block_updated(reorg_height, best_time, None::<(ChainHash, &&dyn NodeSigner, &UserConfig)>, logger) {
6676                                 Ok((channel_ready, timed_out_htlcs, announcement_sigs)) => {
6677                                         assert!(channel_ready.is_none(), "We can't generate a funding with 0 confirmations?");
6678                                         assert!(timed_out_htlcs.is_empty(), "We can't have accepted HTLCs with a timeout before our funding confirmation?");
6679                                         assert!(announcement_sigs.is_none(), "We can't generate an announcement_sigs with 0 confirmations?");
6680                                         Ok(())
6681                                 },
6682                                 Err(e) => Err(e)
6683                         }
6684                 } else {
6685                         // We never learned about the funding confirmation anyway, just ignore
6686                         Ok(())
6687                 }
6688         }
6689
6690         // Methods to get unprompted messages to send to the remote end (or where we already returned
6691         // something in the handler for the message that prompted this message):
6692
6693         /// Gets an UnsignedChannelAnnouncement for this channel. The channel must be publicly
6694         /// announceable and available for use (have exchanged [`ChannelReady`] messages in both
6695         /// directions). Should be used for both broadcasted announcements and in response to an
6696         /// AnnouncementSignatures message from the remote peer.
6697         ///
6698         /// Will only fail if we're not in a state where channel_announcement may be sent (including
6699         /// closing).
6700         ///
6701         /// This will only return ChannelError::Ignore upon failure.
6702         ///
6703         /// [`ChannelReady`]: crate::ln::msgs::ChannelReady
6704         fn get_channel_announcement<NS: Deref>(
6705                 &self, node_signer: &NS, chain_hash: ChainHash, user_config: &UserConfig,
6706         ) -> Result<msgs::UnsignedChannelAnnouncement, ChannelError> where NS::Target: NodeSigner {
6707                 if !self.context.config.announced_channel {
6708                         return Err(ChannelError::Ignore("Channel is not available for public announcements".to_owned()));
6709                 }
6710                 if !self.context.is_usable() {
6711                         return Err(ChannelError::Ignore("Cannot get a ChannelAnnouncement if the channel is not currently usable".to_owned()));
6712                 }
6713
6714                 let short_channel_id = self.context.get_short_channel_id()
6715                         .ok_or(ChannelError::Ignore("Cannot get a ChannelAnnouncement if the channel has not been confirmed yet".to_owned()))?;
6716                 let node_id = NodeId::from_pubkey(&node_signer.get_node_id(Recipient::Node)
6717                         .map_err(|_| ChannelError::Ignore("Failed to retrieve own public key".to_owned()))?);
6718                 let counterparty_node_id = NodeId::from_pubkey(&self.context.get_counterparty_node_id());
6719                 let were_node_one = node_id.as_slice() < counterparty_node_id.as_slice();
6720
6721                 let msg = msgs::UnsignedChannelAnnouncement {
6722                         features: channelmanager::provided_channel_features(&user_config),
6723                         chain_hash,
6724                         short_channel_id,
6725                         node_id_1: if were_node_one { node_id } else { counterparty_node_id },
6726                         node_id_2: if were_node_one { counterparty_node_id } else { node_id },
6727                         bitcoin_key_1: NodeId::from_pubkey(if were_node_one { &self.context.get_holder_pubkeys().funding_pubkey } else { self.context.counterparty_funding_pubkey() }),
6728                         bitcoin_key_2: NodeId::from_pubkey(if were_node_one { self.context.counterparty_funding_pubkey() } else { &self.context.get_holder_pubkeys().funding_pubkey }),
6729                         excess_data: Vec::new(),
6730                 };
6731
6732                 Ok(msg)
6733         }
6734
6735         fn get_announcement_sigs<NS: Deref, L: Deref>(
6736                 &mut self, node_signer: &NS, chain_hash: ChainHash, user_config: &UserConfig,
6737                 best_block_height: u32, logger: &L
6738         ) -> Option<msgs::AnnouncementSignatures>
6739         where
6740                 NS::Target: NodeSigner,
6741                 L::Target: Logger
6742         {
6743                 if self.context.funding_tx_confirmation_height == 0 || self.context.funding_tx_confirmation_height + 5 > best_block_height {
6744                         return None;
6745                 }
6746
6747                 if !self.context.is_usable() {
6748                         return None;
6749                 }
6750
6751                 if self.context.channel_state.is_peer_disconnected() {
6752                         log_trace!(logger, "Cannot create an announcement_signatures as our peer is disconnected");
6753                         return None;
6754                 }
6755
6756                 if self.context.announcement_sigs_state != AnnouncementSigsState::NotSent {
6757                         return None;
6758                 }
6759
6760                 log_trace!(logger, "Creating an announcement_signatures message for channel {}", &self.context.channel_id());
6761                 let announcement = match self.get_channel_announcement(node_signer, chain_hash, user_config) {
6762                         Ok(a) => a,
6763                         Err(e) => {
6764                                 log_trace!(logger, "{:?}", e);
6765                                 return None;
6766                         }
6767                 };
6768                 let our_node_sig = match node_signer.sign_gossip_message(msgs::UnsignedGossipMessage::ChannelAnnouncement(&announcement)) {
6769                         Err(_) => {
6770                                 log_error!(logger, "Failed to generate node signature for channel_announcement. Channel will not be announced!");
6771                                 return None;
6772                         },
6773                         Ok(v) => v
6774                 };
6775                 match &self.context.holder_signer {
6776                         ChannelSignerType::Ecdsa(ecdsa) => {
6777                                 let our_bitcoin_sig = match ecdsa.sign_channel_announcement_with_funding_key(&announcement, &self.context.secp_ctx) {
6778                                         Err(_) => {
6779                                                 log_error!(logger, "Signer rejected channel_announcement signing. Channel will not be announced!");
6780                                                 return None;
6781                                         },
6782                                         Ok(v) => v
6783                                 };
6784                                 let short_channel_id = match self.context.get_short_channel_id() {
6785                                         Some(scid) => scid,
6786                                         None => return None,
6787                                 };
6788
6789                                 self.context.announcement_sigs_state = AnnouncementSigsState::MessageSent;
6790
6791                                 Some(msgs::AnnouncementSignatures {
6792                                         channel_id: self.context.channel_id(),
6793                                         short_channel_id,
6794                                         node_signature: our_node_sig,
6795                                         bitcoin_signature: our_bitcoin_sig,
6796                                 })
6797                         },
6798                         // TODO (taproot|arik)
6799                         #[cfg(taproot)]
6800                         _ => todo!()
6801                 }
6802         }
6803
6804         /// Signs the given channel announcement, returning a ChannelError::Ignore if no keys are
6805         /// available.
6806         fn sign_channel_announcement<NS: Deref>(
6807                 &self, node_signer: &NS, announcement: msgs::UnsignedChannelAnnouncement
6808         ) -> Result<msgs::ChannelAnnouncement, ChannelError> where NS::Target: NodeSigner {
6809                 if let Some((their_node_sig, their_bitcoin_sig)) = self.context.announcement_sigs {
6810                         let our_node_key = NodeId::from_pubkey(&node_signer.get_node_id(Recipient::Node)
6811                                 .map_err(|_| ChannelError::Ignore("Signer failed to retrieve own public key".to_owned()))?);
6812                         let were_node_one = announcement.node_id_1 == our_node_key;
6813
6814                         let our_node_sig = node_signer.sign_gossip_message(msgs::UnsignedGossipMessage::ChannelAnnouncement(&announcement))
6815                                 .map_err(|_| ChannelError::Ignore("Failed to generate node signature for channel_announcement".to_owned()))?;
6816                         match &self.context.holder_signer {
6817                                 ChannelSignerType::Ecdsa(ecdsa) => {
6818                                         let our_bitcoin_sig = ecdsa.sign_channel_announcement_with_funding_key(&announcement, &self.context.secp_ctx)
6819                                                 .map_err(|_| ChannelError::Ignore("Signer rejected channel_announcement".to_owned()))?;
6820                                         Ok(msgs::ChannelAnnouncement {
6821                                                 node_signature_1: if were_node_one { our_node_sig } else { their_node_sig },
6822                                                 node_signature_2: if were_node_one { their_node_sig } else { our_node_sig },
6823                                                 bitcoin_signature_1: if were_node_one { our_bitcoin_sig } else { their_bitcoin_sig },
6824                                                 bitcoin_signature_2: if were_node_one { their_bitcoin_sig } else { our_bitcoin_sig },
6825                                                 contents: announcement,
6826                                         })
6827                                 },
6828                                 // TODO (taproot|arik)
6829                                 #[cfg(taproot)]
6830                                 _ => todo!()
6831                         }
6832                 } else {
6833                         Err(ChannelError::Ignore("Attempted to sign channel announcement before we'd received announcement_signatures".to_string()))
6834                 }
6835         }
6836
6837         /// Processes an incoming announcement_signatures message, providing a fully-signed
6838         /// channel_announcement message which we can broadcast and storing our counterparty's
6839         /// signatures for later reconstruction/rebroadcast of the channel_announcement.
6840         pub fn announcement_signatures<NS: Deref>(
6841                 &mut self, node_signer: &NS, chain_hash: ChainHash, best_block_height: u32,
6842                 msg: &msgs::AnnouncementSignatures, user_config: &UserConfig
6843         ) -> Result<msgs::ChannelAnnouncement, ChannelError> where NS::Target: NodeSigner {
6844                 let announcement = self.get_channel_announcement(node_signer, chain_hash, user_config)?;
6845
6846                 let msghash = hash_to_message!(&Sha256d::hash(&announcement.encode()[..])[..]);
6847
6848                 if self.context.secp_ctx.verify_ecdsa(&msghash, &msg.node_signature, &self.context.get_counterparty_node_id()).is_err() {
6849                         return Err(ChannelError::Close(format!(
6850                                 "Bad announcement_signatures. Failed to verify node_signature. UnsignedChannelAnnouncement used for verification is {:?}. their_node_key is {:?}",
6851                                  &announcement, self.context.get_counterparty_node_id())));
6852                 }
6853                 if self.context.secp_ctx.verify_ecdsa(&msghash, &msg.bitcoin_signature, self.context.counterparty_funding_pubkey()).is_err() {
6854                         return Err(ChannelError::Close(format!(
6855                                 "Bad announcement_signatures. Failed to verify bitcoin_signature. UnsignedChannelAnnouncement used for verification is {:?}. their_bitcoin_key is ({:?})",
6856                                 &announcement, self.context.counterparty_funding_pubkey())));
6857                 }
6858
6859                 self.context.announcement_sigs = Some((msg.node_signature, msg.bitcoin_signature));
6860                 if self.context.funding_tx_confirmation_height == 0 || self.context.funding_tx_confirmation_height + 5 > best_block_height {
6861                         return Err(ChannelError::Ignore(
6862                                 "Got announcement_signatures prior to the required six confirmations - we may not have received a block yet that our peer has".to_owned()));
6863                 }
6864
6865                 self.sign_channel_announcement(node_signer, announcement)
6866         }
6867
6868         /// Gets a signed channel_announcement for this channel, if we previously received an
6869         /// announcement_signatures from our counterparty.
6870         pub fn get_signed_channel_announcement<NS: Deref>(
6871                 &self, node_signer: &NS, chain_hash: ChainHash, best_block_height: u32, user_config: &UserConfig
6872         ) -> Option<msgs::ChannelAnnouncement> where NS::Target: NodeSigner {
6873                 if self.context.funding_tx_confirmation_height == 0 || self.context.funding_tx_confirmation_height + 5 > best_block_height {
6874                         return None;
6875                 }
6876                 let announcement = match self.get_channel_announcement(node_signer, chain_hash, user_config) {
6877                         Ok(res) => res,
6878                         Err(_) => return None,
6879                 };
6880                 match self.sign_channel_announcement(node_signer, announcement) {
6881                         Ok(res) => Some(res),
6882                         Err(_) => None,
6883                 }
6884         }
6885
6886         /// May panic if called on a channel that wasn't immediately-previously
6887         /// self.remove_uncommitted_htlcs_and_mark_paused()'d
6888         pub fn get_channel_reestablish<L: Deref>(&mut self, logger: &L) -> msgs::ChannelReestablish where L::Target: Logger {
6889                 assert!(self.context.channel_state.is_peer_disconnected());
6890                 assert_ne!(self.context.cur_counterparty_commitment_transaction_number, INITIAL_COMMITMENT_NUMBER);
6891                 // Prior to static_remotekey, my_current_per_commitment_point was critical to claiming
6892                 // current to_remote balances. However, it no longer has any use, and thus is now simply
6893                 // set to a dummy (but valid, as required by the spec) public key.
6894                 // fuzzing mode marks a subset of pubkeys as invalid so that we can hit "invalid pubkey"
6895                 // branches, but we unwrap it below, so we arbitrarily select a dummy pubkey which is both
6896                 // valid, and valid in fuzzing mode's arbitrary validity criteria:
6897                 let mut pk = [2; 33]; pk[1] = 0xff;
6898                 let dummy_pubkey = PublicKey::from_slice(&pk).unwrap();
6899                 let remote_last_secret = if self.context.cur_counterparty_commitment_transaction_number + 1 < INITIAL_COMMITMENT_NUMBER {
6900                         let remote_last_secret = self.context.commitment_secrets.get_secret(self.context.cur_counterparty_commitment_transaction_number + 2).unwrap();
6901                         log_trace!(logger, "Enough info to generate a Data Loss Protect with per_commitment_secret {} for channel {}", log_bytes!(remote_last_secret), &self.context.channel_id());
6902                         remote_last_secret
6903                 } else {
6904                         log_info!(logger, "Sending a data_loss_protect with no previous remote per_commitment_secret for channel {}", &self.context.channel_id());
6905                         [0;32]
6906                 };
6907                 self.mark_awaiting_response();
6908                 msgs::ChannelReestablish {
6909                         channel_id: self.context.channel_id(),
6910                         // The protocol has two different commitment number concepts - the "commitment
6911                         // transaction number", which starts from 0 and counts up, and the "revocation key
6912                         // index" which starts at INITIAL_COMMITMENT_NUMBER and counts down. We track
6913                         // commitment transaction numbers by the index which will be used to reveal the
6914                         // revocation key for that commitment transaction, which means we have to convert them
6915                         // to protocol-level commitment numbers here...
6916
6917                         // next_local_commitment_number is the next commitment_signed number we expect to
6918                         // receive (indicating if they need to resend one that we missed).
6919                         next_local_commitment_number: INITIAL_COMMITMENT_NUMBER - self.context.cur_holder_commitment_transaction_number,
6920                         // We have to set next_remote_commitment_number to the next revoke_and_ack we expect to
6921                         // receive, however we track it by the next commitment number for a remote transaction
6922                         // (which is one further, as they always revoke previous commitment transaction, not
6923                         // the one we send) so we have to decrement by 1. Note that if
6924                         // cur_counterparty_commitment_transaction_number is INITIAL_COMMITMENT_NUMBER we will have
6925                         // dropped this channel on disconnect as it hasn't yet reached AwaitingChannelReady so we can't
6926                         // overflow here.
6927                         next_remote_commitment_number: INITIAL_COMMITMENT_NUMBER - self.context.cur_counterparty_commitment_transaction_number - 1,
6928                         your_last_per_commitment_secret: remote_last_secret,
6929                         my_current_per_commitment_point: dummy_pubkey,
6930                         // TODO(dual_funding): If we've sent `commtiment_signed` for an interactive transaction
6931                         // construction but have not received `tx_signatures` we MUST set `next_funding_txid` to the
6932                         // txid of that interactive transaction, else we MUST NOT set it.
6933                         next_funding_txid: None,
6934                 }
6935         }
6936
6937
6938         // Send stuff to our remote peers:
6939
6940         /// Queues up an outbound HTLC to send by placing it in the holding cell. You should call
6941         /// [`Self::maybe_free_holding_cell_htlcs`] in order to actually generate and send the
6942         /// commitment update.
6943         ///
6944         /// `Err`s will only be [`ChannelError::Ignore`].
6945         pub fn queue_add_htlc<F: Deref, L: Deref>(
6946                 &mut self, amount_msat: u64, payment_hash: PaymentHash, cltv_expiry: u32, source: HTLCSource,
6947                 onion_routing_packet: msgs::OnionPacket, skimmed_fee_msat: Option<u64>,
6948                 blinding_point: Option<PublicKey>, fee_estimator: &LowerBoundedFeeEstimator<F>, logger: &L
6949         ) -> Result<(), ChannelError>
6950         where F::Target: FeeEstimator, L::Target: Logger
6951         {
6952                 self
6953                         .send_htlc(amount_msat, payment_hash, cltv_expiry, source, onion_routing_packet, true,
6954                                 skimmed_fee_msat, blinding_point, fee_estimator, logger)
6955                         .map(|msg_opt| assert!(msg_opt.is_none(), "We forced holding cell?"))
6956                         .map_err(|err| {
6957                                 if let ChannelError::Ignore(_) = err { /* fine */ }
6958                                 else { debug_assert!(false, "Queueing cannot trigger channel failure"); }
6959                                 err
6960                         })
6961         }
6962
6963         /// Adds a pending outbound HTLC to this channel, note that you probably want
6964         /// [`Self::send_htlc_and_commit`] instead cause you'll want both messages at once.
6965         ///
6966         /// This returns an optional UpdateAddHTLC as we may be in a state where we cannot add HTLCs on
6967         /// the wire:
6968         /// * In cases where we're waiting on the remote peer to send us a revoke_and_ack, we
6969         ///   wouldn't be able to determine what they actually ACK'ed if we have two sets of updates
6970         ///   awaiting ACK.
6971         /// * In cases where we're marked MonitorUpdateInProgress, we cannot commit to a new state as
6972         ///   we may not yet have sent the previous commitment update messages and will need to
6973         ///   regenerate them.
6974         ///
6975         /// You MUST call [`Self::send_commitment_no_state_update`] prior to calling any other methods
6976         /// on this [`Channel`] if `force_holding_cell` is false.
6977         ///
6978         /// `Err`s will only be [`ChannelError::Ignore`].
6979         fn send_htlc<F: Deref, L: Deref>(
6980                 &mut self, amount_msat: u64, payment_hash: PaymentHash, cltv_expiry: u32, source: HTLCSource,
6981                 onion_routing_packet: msgs::OnionPacket, mut force_holding_cell: bool,
6982                 skimmed_fee_msat: Option<u64>, blinding_point: Option<PublicKey>,
6983                 fee_estimator: &LowerBoundedFeeEstimator<F>, logger: &L
6984         ) -> Result<Option<msgs::UpdateAddHTLC>, ChannelError>
6985         where F::Target: FeeEstimator, L::Target: Logger
6986         {
6987                 if !matches!(self.context.channel_state, ChannelState::ChannelReady(_)) ||
6988                         self.context.channel_state.is_local_shutdown_sent() ||
6989                         self.context.channel_state.is_remote_shutdown_sent()
6990                 {
6991                         return Err(ChannelError::Ignore("Cannot send HTLC until channel is fully established and we haven't started shutting down".to_owned()));
6992                 }
6993                 let channel_total_msat = self.context.channel_value_satoshis * 1000;
6994                 if amount_msat > channel_total_msat {
6995                         return Err(ChannelError::Ignore(format!("Cannot send amount {}, because it is more than the total value of the channel {}", amount_msat, channel_total_msat)));
6996                 }
6997
6998                 if amount_msat == 0 {
6999                         return Err(ChannelError::Ignore("Cannot send 0-msat HTLC".to_owned()));
7000                 }
7001
7002                 let available_balances = self.context.get_available_balances(fee_estimator);
7003                 if amount_msat < available_balances.next_outbound_htlc_minimum_msat {
7004                         return Err(ChannelError::Ignore(format!("Cannot send less than our next-HTLC minimum - {} msat",
7005                                 available_balances.next_outbound_htlc_minimum_msat)));
7006                 }
7007
7008                 if amount_msat > available_balances.next_outbound_htlc_limit_msat {
7009                         return Err(ChannelError::Ignore(format!("Cannot send more than our next-HTLC maximum - {} msat",
7010                                 available_balances.next_outbound_htlc_limit_msat)));
7011                 }
7012
7013                 if self.context.channel_state.is_peer_disconnected() {
7014                         // Note that this should never really happen, if we're !is_live() on receipt of an
7015                         // incoming HTLC for relay will result in us rejecting the HTLC and we won't allow
7016                         // the user to send directly into a !is_live() channel. However, if we
7017                         // disconnected during the time the previous hop was doing the commitment dance we may
7018                         // end up getting here after the forwarding delay. In any case, returning an
7019                         // IgnoreError will get ChannelManager to do the right thing and fail backwards now.
7020                         return Err(ChannelError::Ignore("Cannot send an HTLC while disconnected from channel counterparty".to_owned()));
7021                 }
7022
7023                 let need_holding_cell = !self.context.channel_state.can_generate_new_commitment();
7024                 log_debug!(logger, "Pushing new outbound HTLC with hash {} for {} msat {}",
7025                         payment_hash, amount_msat,
7026                         if force_holding_cell { "into holding cell" }
7027                         else if need_holding_cell { "into holding cell as we're awaiting an RAA or monitor" }
7028                         else { "to peer" });
7029
7030                 if need_holding_cell {
7031                         force_holding_cell = true;
7032                 }
7033
7034                 // Now update local state:
7035                 if force_holding_cell {
7036                         self.context.holding_cell_htlc_updates.push(HTLCUpdateAwaitingACK::AddHTLC {
7037                                 amount_msat,
7038                                 payment_hash,
7039                                 cltv_expiry,
7040                                 source,
7041                                 onion_routing_packet,
7042                                 skimmed_fee_msat,
7043                                 blinding_point,
7044                         });
7045                         return Ok(None);
7046                 }
7047
7048                 self.context.pending_outbound_htlcs.push(OutboundHTLCOutput {
7049                         htlc_id: self.context.next_holder_htlc_id,
7050                         amount_msat,
7051                         payment_hash: payment_hash.clone(),
7052                         cltv_expiry,
7053                         state: OutboundHTLCState::LocalAnnounced(Box::new(onion_routing_packet.clone())),
7054                         source,
7055                         blinding_point,
7056                         skimmed_fee_msat,
7057                 });
7058
7059                 let res = msgs::UpdateAddHTLC {
7060                         channel_id: self.context.channel_id,
7061                         htlc_id: self.context.next_holder_htlc_id,
7062                         amount_msat,
7063                         payment_hash,
7064                         cltv_expiry,
7065                         onion_routing_packet,
7066                         skimmed_fee_msat,
7067                         blinding_point,
7068                 };
7069                 self.context.next_holder_htlc_id += 1;
7070
7071                 Ok(Some(res))
7072         }
7073
7074         fn build_commitment_no_status_check<L: Deref>(&mut self, logger: &L) -> ChannelMonitorUpdate where L::Target: Logger {
7075                 log_trace!(logger, "Updating HTLC state for a newly-sent commitment_signed...");
7076                 // We can upgrade the status of some HTLCs that are waiting on a commitment, even if we
7077                 // fail to generate this, we still are at least at a position where upgrading their status
7078                 // is acceptable.
7079                 for htlc in self.context.pending_inbound_htlcs.iter_mut() {
7080                         let new_state = if let &InboundHTLCState::AwaitingRemoteRevokeToAnnounce(ref forward_info) = &htlc.state {
7081                                 Some(InboundHTLCState::AwaitingAnnouncedRemoteRevoke(forward_info.clone()))
7082                         } else { None };
7083                         if let Some(state) = new_state {
7084                                 log_trace!(logger, " ...promoting inbound AwaitingRemoteRevokeToAnnounce {} to AwaitingAnnouncedRemoteRevoke", &htlc.payment_hash);
7085                                 htlc.state = state;
7086                         }
7087                 }
7088                 for htlc in self.context.pending_outbound_htlcs.iter_mut() {
7089                         if let &mut OutboundHTLCState::AwaitingRemoteRevokeToRemove(ref mut outcome) = &mut htlc.state {
7090                                 log_trace!(logger, " ...promoting outbound AwaitingRemoteRevokeToRemove {} to AwaitingRemovedRemoteRevoke", &htlc.payment_hash);
7091                                 // Grab the preimage, if it exists, instead of cloning
7092                                 let mut reason = OutboundHTLCOutcome::Success(None);
7093                                 mem::swap(outcome, &mut reason);
7094                                 htlc.state = OutboundHTLCState::AwaitingRemovedRemoteRevoke(reason);
7095                         }
7096                 }
7097                 if let Some((feerate, update_state)) = self.context.pending_update_fee {
7098                         if update_state == FeeUpdateState::AwaitingRemoteRevokeToAnnounce {
7099                                 debug_assert!(!self.context.is_outbound());
7100                                 log_trace!(logger, " ...promoting inbound AwaitingRemoteRevokeToAnnounce fee update {} to Committed", feerate);
7101                                 self.context.feerate_per_kw = feerate;
7102                                 self.context.pending_update_fee = None;
7103                         }
7104                 }
7105                 self.context.resend_order = RAACommitmentOrder::RevokeAndACKFirst;
7106
7107                 let (mut htlcs_ref, counterparty_commitment_tx) =
7108                         self.build_commitment_no_state_update(logger);
7109                 let counterparty_commitment_txid = counterparty_commitment_tx.trust().txid();
7110                 let htlcs: Vec<(HTLCOutputInCommitment, Option<Box<HTLCSource>>)> =
7111                         htlcs_ref.drain(..).map(|(htlc, htlc_source)| (htlc, htlc_source.map(|source_ref| Box::new(source_ref.clone())))).collect();
7112
7113                 if self.context.announcement_sigs_state == AnnouncementSigsState::MessageSent {
7114                         self.context.announcement_sigs_state = AnnouncementSigsState::Committed;
7115                 }
7116
7117                 self.context.latest_monitor_update_id += 1;
7118                 let monitor_update = ChannelMonitorUpdate {
7119                         update_id: self.context.latest_monitor_update_id,
7120                         counterparty_node_id: Some(self.context.counterparty_node_id),
7121                         updates: vec![ChannelMonitorUpdateStep::LatestCounterpartyCommitmentTXInfo {
7122                                 commitment_txid: counterparty_commitment_txid,
7123                                 htlc_outputs: htlcs.clone(),
7124                                 commitment_number: self.context.cur_counterparty_commitment_transaction_number,
7125                                 their_per_commitment_point: self.context.counterparty_cur_commitment_point.unwrap(),
7126                                 feerate_per_kw: Some(counterparty_commitment_tx.feerate_per_kw()),
7127                                 to_broadcaster_value_sat: Some(counterparty_commitment_tx.to_broadcaster_value_sat()),
7128                                 to_countersignatory_value_sat: Some(counterparty_commitment_tx.to_countersignatory_value_sat()),
7129                         }],
7130                         channel_id: Some(self.context.channel_id()),
7131                 };
7132                 self.context.channel_state.set_awaiting_remote_revoke();
7133                 monitor_update
7134         }
7135
7136         fn build_commitment_no_state_update<L: Deref>(&self, logger: &L)
7137         -> (Vec<(HTLCOutputInCommitment, Option<&HTLCSource>)>, CommitmentTransaction)
7138         where L::Target: Logger
7139         {
7140                 let counterparty_keys = self.context.build_remote_transaction_keys();
7141                 let commitment_stats = self.context.build_commitment_transaction(self.context.cur_counterparty_commitment_transaction_number, &counterparty_keys, false, true, logger);
7142                 let counterparty_commitment_tx = commitment_stats.tx;
7143
7144                 #[cfg(any(test, fuzzing))]
7145                 {
7146                         if !self.context.is_outbound() {
7147                                 let projected_commit_tx_info = self.context.next_remote_commitment_tx_fee_info_cached.lock().unwrap().take();
7148                                 *self.context.next_local_commitment_tx_fee_info_cached.lock().unwrap() = None;
7149                                 if let Some(info) = projected_commit_tx_info {
7150                                         let total_pending_htlcs = self.context.pending_inbound_htlcs.len() + self.context.pending_outbound_htlcs.len();
7151                                         if info.total_pending_htlcs == total_pending_htlcs
7152                                                 && info.next_holder_htlc_id == self.context.next_holder_htlc_id
7153                                                 && info.next_counterparty_htlc_id == self.context.next_counterparty_htlc_id
7154                                                 && info.feerate == self.context.feerate_per_kw {
7155                                                         let actual_fee = commit_tx_fee_msat(self.context.feerate_per_kw, commitment_stats.num_nondust_htlcs, self.context.get_channel_type());
7156                                                         assert_eq!(actual_fee, info.fee);
7157                                                 }
7158                                 }
7159                         }
7160                 }
7161
7162                 (commitment_stats.htlcs_included, counterparty_commitment_tx)
7163         }
7164
7165         /// Only fails in case of signer rejection. Used for channel_reestablish commitment_signed
7166         /// generation when we shouldn't change HTLC/channel state.
7167         fn send_commitment_no_state_update<L: Deref>(&self, logger: &L) -> Result<(msgs::CommitmentSigned, (Txid, Vec<(HTLCOutputInCommitment, Option<&HTLCSource>)>)), ChannelError> where L::Target: Logger {
7168                 // Get the fee tests from `build_commitment_no_state_update`
7169                 #[cfg(any(test, fuzzing))]
7170                 self.build_commitment_no_state_update(logger);
7171
7172                 let counterparty_keys = self.context.build_remote_transaction_keys();
7173                 let commitment_stats = self.context.build_commitment_transaction(self.context.cur_counterparty_commitment_transaction_number, &counterparty_keys, false, true, logger);
7174                 let counterparty_commitment_txid = commitment_stats.tx.trust().txid();
7175
7176                 match &self.context.holder_signer {
7177                         ChannelSignerType::Ecdsa(ecdsa) => {
7178                                 let (signature, htlc_signatures);
7179
7180                                 {
7181                                         let mut htlcs = Vec::with_capacity(commitment_stats.htlcs_included.len());
7182                                         for &(ref htlc, _) in commitment_stats.htlcs_included.iter() {
7183                                                 htlcs.push(htlc);
7184                                         }
7185
7186                                         let res = ecdsa.sign_counterparty_commitment(
7187                                                         &commitment_stats.tx,
7188                                                         commitment_stats.inbound_htlc_preimages,
7189                                                         commitment_stats.outbound_htlc_preimages,
7190                                                         &self.context.secp_ctx,
7191                                                 ).map_err(|_| ChannelError::Ignore("Failed to get signatures for new commitment_signed".to_owned()))?;
7192                                         signature = res.0;
7193                                         htlc_signatures = res.1;
7194
7195                                         log_trace!(logger, "Signed remote commitment tx {} (txid {}) with redeemscript {} -> {} in channel {}",
7196                                                 encode::serialize_hex(&commitment_stats.tx.trust().built_transaction().transaction),
7197                                                 &counterparty_commitment_txid, encode::serialize_hex(&self.context.get_funding_redeemscript()),
7198                                                 log_bytes!(signature.serialize_compact()[..]), &self.context.channel_id());
7199
7200                                         for (ref htlc_sig, ref htlc) in htlc_signatures.iter().zip(htlcs) {
7201                                                 log_trace!(logger, "Signed remote HTLC tx {} with redeemscript {} with pubkey {} -> {} in channel {}",
7202                                                         encode::serialize_hex(&chan_utils::build_htlc_transaction(&counterparty_commitment_txid, commitment_stats.feerate_per_kw, self.context.get_holder_selected_contest_delay(), htlc, &self.context.channel_type, &counterparty_keys.broadcaster_delayed_payment_key, &counterparty_keys.revocation_key)),
7203                                                         encode::serialize_hex(&chan_utils::get_htlc_redeemscript(&htlc, &self.context.channel_type, &counterparty_keys)),
7204                                                         log_bytes!(counterparty_keys.broadcaster_htlc_key.to_public_key().serialize()),
7205                                                         log_bytes!(htlc_sig.serialize_compact()[..]), &self.context.channel_id());
7206                                         }
7207                                 }
7208
7209                                 Ok((msgs::CommitmentSigned {
7210                                         channel_id: self.context.channel_id,
7211                                         signature,
7212                                         htlc_signatures,
7213                                         #[cfg(taproot)]
7214                                         partial_signature_with_nonce: None,
7215                                 }, (counterparty_commitment_txid, commitment_stats.htlcs_included)))
7216                         },
7217                         // TODO (taproot|arik)
7218                         #[cfg(taproot)]
7219                         _ => todo!()
7220                 }
7221         }
7222
7223         /// Adds a pending outbound HTLC to this channel, and builds a new remote commitment
7224         /// transaction and generates the corresponding [`ChannelMonitorUpdate`] in one go.
7225         ///
7226         /// Shorthand for calling [`Self::send_htlc`] followed by a commitment update, see docs on
7227         /// [`Self::send_htlc`] and [`Self::build_commitment_no_state_update`] for more info.
7228         pub fn send_htlc_and_commit<F: Deref, L: Deref>(
7229                 &mut self, amount_msat: u64, payment_hash: PaymentHash, cltv_expiry: u32,
7230                 source: HTLCSource, onion_routing_packet: msgs::OnionPacket, skimmed_fee_msat: Option<u64>,
7231                 fee_estimator: &LowerBoundedFeeEstimator<F>, logger: &L
7232         ) -> Result<Option<ChannelMonitorUpdate>, ChannelError>
7233         where F::Target: FeeEstimator, L::Target: Logger
7234         {
7235                 let send_res = self.send_htlc(amount_msat, payment_hash, cltv_expiry, source,
7236                         onion_routing_packet, false, skimmed_fee_msat, None, fee_estimator, logger);
7237                 if let Err(e) = &send_res { if let ChannelError::Ignore(_) = e {} else { debug_assert!(false, "Sending cannot trigger channel failure"); } }
7238                 match send_res? {
7239                         Some(_) => {
7240                                 let monitor_update = self.build_commitment_no_status_check(logger);
7241                                 self.monitor_updating_paused(false, true, false, Vec::new(), Vec::new(), Vec::new());
7242                                 Ok(self.push_ret_blockable_mon_update(monitor_update))
7243                         },
7244                         None => Ok(None)
7245                 }
7246         }
7247
7248         /// Applies the `ChannelUpdate` and returns a boolean indicating whether a change actually
7249         /// happened.
7250         pub fn channel_update(&mut self, msg: &msgs::ChannelUpdate) -> Result<bool, ChannelError> {
7251                 let new_forwarding_info = Some(CounterpartyForwardingInfo {
7252                         fee_base_msat: msg.contents.fee_base_msat,
7253                         fee_proportional_millionths: msg.contents.fee_proportional_millionths,
7254                         cltv_expiry_delta: msg.contents.cltv_expiry_delta
7255                 });
7256                 let did_change = self.context.counterparty_forwarding_info != new_forwarding_info;
7257                 if did_change {
7258                         self.context.counterparty_forwarding_info = new_forwarding_info;
7259                 }
7260
7261                 Ok(did_change)
7262         }
7263
7264         /// Begins the shutdown process, getting a message for the remote peer and returning all
7265         /// holding cell HTLCs for payment failure.
7266         pub fn get_shutdown(&mut self, signer_provider: &SP, their_features: &InitFeatures,
7267                 target_feerate_sats_per_kw: Option<u32>, override_shutdown_script: Option<ShutdownScript>)
7268         -> Result<(msgs::Shutdown, Option<ChannelMonitorUpdate>, Vec<(HTLCSource, PaymentHash)>), APIError>
7269         {
7270                 for htlc in self.context.pending_outbound_htlcs.iter() {
7271                         if let OutboundHTLCState::LocalAnnounced(_) = htlc.state {
7272                                 return Err(APIError::APIMisuseError{err: "Cannot begin shutdown with pending HTLCs. Process pending events first".to_owned()});
7273                         }
7274                 }
7275                 if self.context.channel_state.is_local_shutdown_sent() {
7276                         return Err(APIError::APIMisuseError{err: "Shutdown already in progress".to_owned()});
7277                 }
7278                 else if self.context.channel_state.is_remote_shutdown_sent() {
7279                         return Err(APIError::ChannelUnavailable{err: "Shutdown already in progress by remote".to_owned()});
7280                 }
7281                 if self.context.shutdown_scriptpubkey.is_some() && override_shutdown_script.is_some() {
7282                         return Err(APIError::APIMisuseError{err: "Cannot override shutdown script for a channel with one already set".to_owned()});
7283                 }
7284                 assert!(!matches!(self.context.channel_state, ChannelState::ShutdownComplete));
7285                 if self.context.channel_state.is_peer_disconnected() || self.context.channel_state.is_monitor_update_in_progress() {
7286                         return Err(APIError::ChannelUnavailable{err: "Cannot begin shutdown while peer is disconnected or we're waiting on a monitor update, maybe force-close instead?".to_owned()});
7287                 }
7288
7289                 let update_shutdown_script = match self.context.shutdown_scriptpubkey {
7290                         Some(_) => false,
7291                         None => {
7292                                 // use override shutdown script if provided
7293                                 let shutdown_scriptpubkey = match override_shutdown_script {
7294                                         Some(script) => script,
7295                                         None => {
7296                                                 // otherwise, use the shutdown scriptpubkey provided by the signer
7297                                                 match signer_provider.get_shutdown_scriptpubkey() {
7298                                                         Ok(scriptpubkey) => scriptpubkey,
7299                                                         Err(_) => return Err(APIError::ChannelUnavailable{err: "Failed to get shutdown scriptpubkey".to_owned()}),
7300                                                 }
7301                                         },
7302                                 };
7303                                 if !shutdown_scriptpubkey.is_compatible(their_features) {
7304                                         return Err(APIError::IncompatibleShutdownScript { script: shutdown_scriptpubkey.clone() });
7305                                 }
7306                                 self.context.shutdown_scriptpubkey = Some(shutdown_scriptpubkey);
7307                                 true
7308                         },
7309                 };
7310
7311                 // From here on out, we may not fail!
7312                 self.context.target_closing_feerate_sats_per_kw = target_feerate_sats_per_kw;
7313                 self.context.channel_state.set_local_shutdown_sent();
7314                 self.context.local_initiated_shutdown = Some(());
7315                 self.context.update_time_counter += 1;
7316
7317                 let monitor_update = if update_shutdown_script {
7318                         self.context.latest_monitor_update_id += 1;
7319                         let monitor_update = ChannelMonitorUpdate {
7320                                 update_id: self.context.latest_monitor_update_id,
7321                                 counterparty_node_id: Some(self.context.counterparty_node_id),
7322                                 updates: vec![ChannelMonitorUpdateStep::ShutdownScript {
7323                                         scriptpubkey: self.get_closing_scriptpubkey(),
7324                                 }],
7325                                 channel_id: Some(self.context.channel_id()),
7326                         };
7327                         self.monitor_updating_paused(false, false, false, Vec::new(), Vec::new(), Vec::new());
7328                         self.push_ret_blockable_mon_update(monitor_update)
7329                 } else { None };
7330                 let shutdown = msgs::Shutdown {
7331                         channel_id: self.context.channel_id,
7332                         scriptpubkey: self.get_closing_scriptpubkey(),
7333                 };
7334
7335                 // Go ahead and drop holding cell updates as we'd rather fail payments than wait to send
7336                 // our shutdown until we've committed all of the pending changes.
7337                 self.context.holding_cell_update_fee = None;
7338                 let mut dropped_outbound_htlcs = Vec::with_capacity(self.context.holding_cell_htlc_updates.len());
7339                 self.context.holding_cell_htlc_updates.retain(|htlc_update| {
7340                         match htlc_update {
7341                                 &HTLCUpdateAwaitingACK::AddHTLC { ref payment_hash, ref source, .. } => {
7342                                         dropped_outbound_htlcs.push((source.clone(), payment_hash.clone()));
7343                                         false
7344                                 },
7345                                 _ => true
7346                         }
7347                 });
7348
7349                 debug_assert!(!self.is_shutdown() || monitor_update.is_none(),
7350                         "we can't both complete shutdown and return a monitor update");
7351
7352                 Ok((shutdown, monitor_update, dropped_outbound_htlcs))
7353         }
7354
7355         pub fn inflight_htlc_sources(&self) -> impl Iterator<Item=(&HTLCSource, &PaymentHash)> {
7356                 self.context.holding_cell_htlc_updates.iter()
7357                         .flat_map(|htlc_update| {
7358                                 match htlc_update {
7359                                         HTLCUpdateAwaitingACK::AddHTLC { source, payment_hash, .. }
7360                                                 => Some((source, payment_hash)),
7361                                         _ => None,
7362                                 }
7363                         })
7364                         .chain(self.context.pending_outbound_htlcs.iter().map(|htlc| (&htlc.source, &htlc.payment_hash)))
7365         }
7366 }
7367
7368 /// A not-yet-funded outbound (from holder) channel using V1 channel establishment.
7369 pub(super) struct OutboundV1Channel<SP: Deref> where SP::Target: SignerProvider {
7370         pub context: ChannelContext<SP>,
7371         pub unfunded_context: UnfundedChannelContext,
7372 }
7373
7374 impl<SP: Deref> OutboundV1Channel<SP> where SP::Target: SignerProvider {
7375         pub fn new<ES: Deref, F: Deref>(
7376                 fee_estimator: &LowerBoundedFeeEstimator<F>, entropy_source: &ES, signer_provider: &SP, counterparty_node_id: PublicKey, their_features: &InitFeatures,
7377                 channel_value_satoshis: u64, push_msat: u64, user_id: u128, config: &UserConfig, current_chain_height: u32,
7378                 outbound_scid_alias: u64, temporary_channel_id: Option<ChannelId>
7379         ) -> Result<OutboundV1Channel<SP>, APIError>
7380         where ES::Target: EntropySource,
7381               F::Target: FeeEstimator
7382         {
7383                 let holder_selected_channel_reserve_satoshis = get_holder_selected_channel_reserve_satoshis(channel_value_satoshis, config);
7384                 if holder_selected_channel_reserve_satoshis < MIN_CHAN_DUST_LIMIT_SATOSHIS {
7385                         // Protocol level safety check in place, although it should never happen because
7386                         // of `MIN_THEIR_CHAN_RESERVE_SATOSHIS`
7387                         return Err(APIError::APIMisuseError { err: format!("Holder selected channel reserve below \
7388                                 implemention limit dust_limit_satoshis {}", holder_selected_channel_reserve_satoshis) });
7389                 }
7390
7391                 let channel_keys_id = signer_provider.generate_channel_keys_id(false, channel_value_satoshis, user_id);
7392                 let holder_signer = signer_provider.derive_channel_signer(channel_value_satoshis, channel_keys_id);
7393                 let pubkeys = holder_signer.pubkeys().clone();
7394
7395                 let chan = Self {
7396                         context: ChannelContext::new_for_outbound_channel(
7397                                 fee_estimator,
7398                                 entropy_source,
7399                                 signer_provider,
7400                                 counterparty_node_id,
7401                                 their_features,
7402                                 channel_value_satoshis,
7403                                 push_msat,
7404                                 user_id,
7405                                 config,
7406                                 current_chain_height,
7407                                 outbound_scid_alias,
7408                                 temporary_channel_id,
7409                                 holder_selected_channel_reserve_satoshis,
7410                                 channel_keys_id,
7411                                 holder_signer,
7412                                 pubkeys,
7413                         )?,
7414                         unfunded_context: UnfundedChannelContext { unfunded_channel_age_ticks: 0 }
7415                 };
7416                 Ok(chan)
7417         }
7418
7419         /// Only allowed after [`ChannelContext::channel_transaction_parameters`] is set.
7420         fn get_funding_created_msg<L: Deref>(&mut self, logger: &L) -> Option<msgs::FundingCreated> where L::Target: Logger {
7421                 let counterparty_keys = self.context.build_remote_transaction_keys();
7422                 let counterparty_initial_commitment_tx = self.context.build_commitment_transaction(self.context.cur_counterparty_commitment_transaction_number, &counterparty_keys, false, false, logger).tx;
7423                 let signature = match &self.context.holder_signer {
7424                         // TODO (taproot|arik): move match into calling method for Taproot
7425                         ChannelSignerType::Ecdsa(ecdsa) => {
7426                                 ecdsa.sign_counterparty_commitment(&counterparty_initial_commitment_tx, Vec::new(), Vec::new(), &self.context.secp_ctx)
7427                                         .map(|(sig, _)| sig).ok()?
7428                         },
7429                         // TODO (taproot|arik)
7430                         #[cfg(taproot)]
7431                         _ => todo!()
7432                 };
7433
7434                 if self.context.signer_pending_funding {
7435                         log_trace!(logger, "Counterparty commitment signature ready for funding_created message: clearing signer_pending_funding");
7436                         self.context.signer_pending_funding = false;
7437                 }
7438
7439                 Some(msgs::FundingCreated {
7440                         temporary_channel_id: self.context.temporary_channel_id.unwrap(),
7441                         funding_txid: self.context.channel_transaction_parameters.funding_outpoint.as_ref().unwrap().txid,
7442                         funding_output_index: self.context.channel_transaction_parameters.funding_outpoint.as_ref().unwrap().index,
7443                         signature,
7444                         #[cfg(taproot)]
7445                         partial_signature_with_nonce: None,
7446                         #[cfg(taproot)]
7447                         next_local_nonce: None,
7448                 })
7449         }
7450
7451         /// Updates channel state with knowledge of the funding transaction's txid/index, and generates
7452         /// a funding_created message for the remote peer.
7453         /// Panics if called at some time other than immediately after initial handshake, if called twice,
7454         /// or if called on an inbound channel.
7455         /// Note that channel_id changes during this call!
7456         /// Do NOT broadcast the funding transaction until after a successful funding_signed call!
7457         /// If an Err is returned, it is a ChannelError::Close.
7458         pub fn get_funding_created<L: Deref>(&mut self, funding_transaction: Transaction, funding_txo: OutPoint, is_batch_funding: bool, logger: &L)
7459         -> Result<Option<msgs::FundingCreated>, (Self, ChannelError)> where L::Target: Logger {
7460                 if !self.context.is_outbound() {
7461                         panic!("Tried to create outbound funding_created message on an inbound channel!");
7462                 }
7463                 if !matches!(
7464                         self.context.channel_state, ChannelState::NegotiatingFunding(flags)
7465                         if flags == (NegotiatingFundingFlags::OUR_INIT_SENT | NegotiatingFundingFlags::THEIR_INIT_SENT)
7466                 ) {
7467                         panic!("Tried to get a funding_created messsage at a time other than immediately after initial handshake completion (or tried to get funding_created twice)");
7468                 }
7469                 if self.context.commitment_secrets.get_min_seen_secret() != (1 << 48) ||
7470                                 self.context.cur_counterparty_commitment_transaction_number != INITIAL_COMMITMENT_NUMBER ||
7471                                 self.context.cur_holder_commitment_transaction_number != INITIAL_COMMITMENT_NUMBER {
7472                         panic!("Should not have advanced channel commitment tx numbers prior to funding_created");
7473                 }
7474
7475                 self.context.channel_transaction_parameters.funding_outpoint = Some(funding_txo);
7476                 self.context.holder_signer.as_mut().provide_channel_parameters(&self.context.channel_transaction_parameters);
7477
7478                 // Now that we're past error-generating stuff, update our local state:
7479
7480                 self.context.channel_state = ChannelState::FundingNegotiated;
7481                 self.context.channel_id = ChannelId::v1_from_funding_outpoint(funding_txo);
7482
7483                 // If the funding transaction is a coinbase transaction, we need to set the minimum depth to 100.
7484                 // We can skip this if it is a zero-conf channel.
7485                 if funding_transaction.is_coin_base() &&
7486                         self.context.minimum_depth.unwrap_or(0) > 0 &&
7487                         self.context.minimum_depth.unwrap_or(0) < COINBASE_MATURITY {
7488                         self.context.minimum_depth = Some(COINBASE_MATURITY);
7489                 }
7490
7491                 self.context.funding_transaction = Some(funding_transaction);
7492                 self.context.is_batch_funding = Some(()).filter(|_| is_batch_funding);
7493
7494                 let funding_created = self.get_funding_created_msg(logger);
7495                 if funding_created.is_none() {
7496                         #[cfg(not(async_signing))] {
7497                                 panic!("Failed to get signature for new funding creation");
7498                         }
7499                         #[cfg(async_signing)] {
7500                                 if !self.context.signer_pending_funding {
7501                                         log_trace!(logger, "funding_created awaiting signer; setting signer_pending_funding");
7502                                         self.context.signer_pending_funding = true;
7503                                 }
7504                         }
7505                 }
7506
7507                 Ok(funding_created)
7508         }
7509
7510         /// If we receive an error message, it may only be a rejection of the channel type we tried,
7511         /// not of our ability to open any channel at all. Thus, on error, we should first call this
7512         /// and see if we get a new `OpenChannel` message, otherwise the channel is failed.
7513         pub(crate) fn maybe_handle_error_without_close<F: Deref>(
7514                 &mut self, chain_hash: ChainHash, fee_estimator: &LowerBoundedFeeEstimator<F>
7515         ) -> Result<msgs::OpenChannel, ()>
7516         where
7517                 F::Target: FeeEstimator
7518         {
7519                 self.context.maybe_downgrade_channel_features(fee_estimator)?;
7520                 Ok(self.get_open_channel(chain_hash))
7521         }
7522
7523         pub fn get_open_channel(&self, chain_hash: ChainHash) -> msgs::OpenChannel {
7524                 if !self.context.is_outbound() {
7525                         panic!("Tried to open a channel for an inbound channel?");
7526                 }
7527                 if self.context.have_received_message() {
7528                         panic!("Cannot generate an open_channel after we've moved forward");
7529                 }
7530
7531                 if self.context.cur_holder_commitment_transaction_number != INITIAL_COMMITMENT_NUMBER {
7532                         panic!("Tried to send an open_channel for a channel that has already advanced");
7533                 }
7534
7535                 let first_per_commitment_point = self.context.holder_signer.as_ref().get_per_commitment_point(self.context.cur_holder_commitment_transaction_number, &self.context.secp_ctx);
7536                 let keys = self.context.get_holder_pubkeys();
7537
7538                 msgs::OpenChannel {
7539                         common_fields: msgs::CommonOpenChannelFields {
7540                                 chain_hash,
7541                                 temporary_channel_id: self.context.channel_id,
7542                                 funding_satoshis: self.context.channel_value_satoshis,
7543                                 dust_limit_satoshis: self.context.holder_dust_limit_satoshis,
7544                                 max_htlc_value_in_flight_msat: self.context.holder_max_htlc_value_in_flight_msat,
7545                                 htlc_minimum_msat: self.context.holder_htlc_minimum_msat,
7546                                 commitment_feerate_sat_per_1000_weight: self.context.feerate_per_kw as u32,
7547                                 to_self_delay: self.context.get_holder_selected_contest_delay(),
7548                                 max_accepted_htlcs: self.context.holder_max_accepted_htlcs,
7549                                 funding_pubkey: keys.funding_pubkey,
7550                                 revocation_basepoint: keys.revocation_basepoint.to_public_key(),
7551                                 payment_basepoint: keys.payment_point,
7552                                 delayed_payment_basepoint: keys.delayed_payment_basepoint.to_public_key(),
7553                                 htlc_basepoint: keys.htlc_basepoint.to_public_key(),
7554                                 first_per_commitment_point,
7555                                 channel_flags: if self.context.config.announced_channel {1} else {0},
7556                                 shutdown_scriptpubkey: Some(match &self.context.shutdown_scriptpubkey {
7557                                         Some(script) => script.clone().into_inner(),
7558                                         None => Builder::new().into_script(),
7559                                 }),
7560                                 channel_type: Some(self.context.channel_type.clone()),
7561                         },
7562                         push_msat: self.context.channel_value_satoshis * 1000 - self.context.value_to_self_msat,
7563                         channel_reserve_satoshis: self.context.holder_selected_channel_reserve_satoshis,
7564                 }
7565         }
7566
7567         // Message handlers
7568         pub fn accept_channel(&mut self, msg: &msgs::AcceptChannel, default_limits: &ChannelHandshakeLimits, their_features: &InitFeatures) -> Result<(), ChannelError> {
7569                 let peer_limits = if let Some(ref limits) = self.context.inbound_handshake_limits_override { limits } else { default_limits };
7570
7571                 // Check sanity of message fields:
7572                 if !self.context.is_outbound() {
7573                         return Err(ChannelError::Close("Got an accept_channel message from an inbound peer".to_owned()));
7574                 }
7575                 if !matches!(self.context.channel_state, ChannelState::NegotiatingFunding(flags) if flags == NegotiatingFundingFlags::OUR_INIT_SENT) {
7576                         return Err(ChannelError::Close("Got an accept_channel message at a strange time".to_owned()));
7577                 }
7578                 if msg.common_fields.dust_limit_satoshis > 21000000 * 100000000 {
7579                         return Err(ChannelError::Close(format!("Peer never wants payout outputs? dust_limit_satoshis was {}", msg.common_fields.dust_limit_satoshis)));
7580                 }
7581                 if msg.channel_reserve_satoshis > self.context.channel_value_satoshis {
7582                         return Err(ChannelError::Close(format!("Bogus channel_reserve_satoshis ({}). Must not be greater than ({})", msg.channel_reserve_satoshis, self.context.channel_value_satoshis)));
7583                 }
7584                 if msg.common_fields.dust_limit_satoshis > self.context.holder_selected_channel_reserve_satoshis {
7585                         return Err(ChannelError::Close(format!("Dust limit ({}) is bigger than our channel reserve ({})", msg.common_fields.dust_limit_satoshis, self.context.holder_selected_channel_reserve_satoshis)));
7586                 }
7587                 if msg.channel_reserve_satoshis > self.context.channel_value_satoshis - self.context.holder_selected_channel_reserve_satoshis {
7588                         return Err(ChannelError::Close(format!("Bogus channel_reserve_satoshis ({}). Must not be greater than channel value minus our reserve ({})",
7589                                 msg.channel_reserve_satoshis, self.context.channel_value_satoshis - self.context.holder_selected_channel_reserve_satoshis)));
7590                 }
7591                 let full_channel_value_msat = (self.context.channel_value_satoshis - msg.channel_reserve_satoshis) * 1000;
7592                 if msg.common_fields.htlc_minimum_msat >= full_channel_value_msat {
7593                         return Err(ChannelError::Close(format!("Minimum htlc value ({}) is full channel value ({})", msg.common_fields.htlc_minimum_msat, full_channel_value_msat)));
7594                 }
7595                 let max_delay_acceptable = u16::min(peer_limits.their_to_self_delay, MAX_LOCAL_BREAKDOWN_TIMEOUT);
7596                 if msg.common_fields.to_self_delay > max_delay_acceptable {
7597                         return Err(ChannelError::Close(format!("They wanted our payments to be delayed by a needlessly long period. Upper limit: {}. Actual: {}", max_delay_acceptable, msg.common_fields.to_self_delay)));
7598                 }
7599                 if msg.common_fields.max_accepted_htlcs < 1 {
7600                         return Err(ChannelError::Close("0 max_accepted_htlcs makes for a useless channel".to_owned()));
7601                 }
7602                 if msg.common_fields.max_accepted_htlcs > MAX_HTLCS {
7603                         return Err(ChannelError::Close(format!("max_accepted_htlcs was {}. It must not be larger than {}", msg.common_fields.max_accepted_htlcs, MAX_HTLCS)));
7604                 }
7605
7606                 // Now check against optional parameters as set by config...
7607                 if msg.common_fields.htlc_minimum_msat > peer_limits.max_htlc_minimum_msat {
7608                         return Err(ChannelError::Close(format!("htlc_minimum_msat ({}) is higher than the user specified limit ({})", msg.common_fields.htlc_minimum_msat, peer_limits.max_htlc_minimum_msat)));
7609                 }
7610                 if msg.common_fields.max_htlc_value_in_flight_msat < peer_limits.min_max_htlc_value_in_flight_msat {
7611                         return Err(ChannelError::Close(format!("max_htlc_value_in_flight_msat ({}) is less than the user specified limit ({})", msg.common_fields.max_htlc_value_in_flight_msat, peer_limits.min_max_htlc_value_in_flight_msat)));
7612                 }
7613                 if msg.channel_reserve_satoshis > peer_limits.max_channel_reserve_satoshis {
7614                         return Err(ChannelError::Close(format!("channel_reserve_satoshis ({}) is higher than the user specified limit ({})", msg.channel_reserve_satoshis, peer_limits.max_channel_reserve_satoshis)));
7615                 }
7616                 if msg.common_fields.max_accepted_htlcs < peer_limits.min_max_accepted_htlcs {
7617                         return Err(ChannelError::Close(format!("max_accepted_htlcs ({}) is less than the user specified limit ({})", msg.common_fields.max_accepted_htlcs, peer_limits.min_max_accepted_htlcs)));
7618                 }
7619                 if msg.common_fields.dust_limit_satoshis < MIN_CHAN_DUST_LIMIT_SATOSHIS {
7620                         return Err(ChannelError::Close(format!("dust_limit_satoshis ({}) is less than the implementation limit ({})", msg.common_fields.dust_limit_satoshis, MIN_CHAN_DUST_LIMIT_SATOSHIS)));
7621                 }
7622                 if msg.common_fields.dust_limit_satoshis > MAX_CHAN_DUST_LIMIT_SATOSHIS {
7623                         return Err(ChannelError::Close(format!("dust_limit_satoshis ({}) is greater than the implementation limit ({})", msg.common_fields.dust_limit_satoshis, MAX_CHAN_DUST_LIMIT_SATOSHIS)));
7624                 }
7625                 if msg.common_fields.minimum_depth > peer_limits.max_minimum_depth {
7626                         return Err(ChannelError::Close(format!("We consider the minimum depth to be unreasonably large. Expected minimum: ({}). Actual: ({})", peer_limits.max_minimum_depth, msg.common_fields.minimum_depth)));
7627                 }
7628
7629                 if let Some(ty) = &msg.common_fields.channel_type {
7630                         if *ty != self.context.channel_type {
7631                                 return Err(ChannelError::Close("Channel Type in accept_channel didn't match the one sent in open_channel.".to_owned()));
7632                         }
7633                 } else if their_features.supports_channel_type() {
7634                         // Assume they've accepted the channel type as they said they understand it.
7635                 } else {
7636                         let channel_type = ChannelTypeFeatures::from_init(&their_features);
7637                         if channel_type != ChannelTypeFeatures::only_static_remote_key() {
7638                                 return Err(ChannelError::Close("Only static_remote_key is supported for non-negotiated channel types".to_owned()));
7639                         }
7640                         self.context.channel_type = channel_type.clone();
7641                         self.context.channel_transaction_parameters.channel_type_features = channel_type;
7642                 }
7643
7644                 let counterparty_shutdown_scriptpubkey = if their_features.supports_upfront_shutdown_script() {
7645                         match &msg.common_fields.shutdown_scriptpubkey {
7646                                 &Some(ref script) => {
7647                                         // Peer is signaling upfront_shutdown and has opt-out with a 0-length script. We don't enforce anything
7648                                         if script.len() == 0 {
7649                                                 None
7650                                         } else {
7651                                                 if !script::is_bolt2_compliant(&script, their_features) {
7652                                                         return Err(ChannelError::Close(format!("Peer is signaling upfront_shutdown but has provided an unacceptable scriptpubkey format: {}", script)));
7653                                                 }
7654                                                 Some(script.clone())
7655                                         }
7656                                 },
7657                                 // Peer is signaling upfront shutdown but don't opt-out with correct mechanism (a.k.a 0-length script). Peer looks buggy, we fail the channel
7658                                 &None => {
7659                                         return Err(ChannelError::Close("Peer is signaling upfront_shutdown but we don't get any script. Use 0-length script to opt-out".to_owned()));
7660                                 }
7661                         }
7662                 } else { None };
7663
7664                 self.context.counterparty_dust_limit_satoshis = msg.common_fields.dust_limit_satoshis;
7665                 self.context.counterparty_max_htlc_value_in_flight_msat = cmp::min(msg.common_fields.max_htlc_value_in_flight_msat, self.context.channel_value_satoshis * 1000);
7666                 self.context.counterparty_selected_channel_reserve_satoshis = Some(msg.channel_reserve_satoshis);
7667                 self.context.counterparty_htlc_minimum_msat = msg.common_fields.htlc_minimum_msat;
7668                 self.context.counterparty_max_accepted_htlcs = msg.common_fields.max_accepted_htlcs;
7669
7670                 if peer_limits.trust_own_funding_0conf {
7671                         self.context.minimum_depth = Some(msg.common_fields.minimum_depth);
7672                 } else {
7673                         self.context.minimum_depth = Some(cmp::max(1, msg.common_fields.minimum_depth));
7674                 }
7675
7676                 let counterparty_pubkeys = ChannelPublicKeys {
7677                         funding_pubkey: msg.common_fields.funding_pubkey,
7678                         revocation_basepoint: RevocationBasepoint::from(msg.common_fields.revocation_basepoint),
7679                         payment_point: msg.common_fields.payment_basepoint,
7680                         delayed_payment_basepoint: DelayedPaymentBasepoint::from(msg.common_fields.delayed_payment_basepoint),
7681                         htlc_basepoint: HtlcBasepoint::from(msg.common_fields.htlc_basepoint)
7682                 };
7683
7684                 self.context.channel_transaction_parameters.counterparty_parameters = Some(CounterpartyChannelTransactionParameters {
7685                         selected_contest_delay: msg.common_fields.to_self_delay,
7686                         pubkeys: counterparty_pubkeys,
7687                 });
7688
7689                 self.context.counterparty_cur_commitment_point = Some(msg.common_fields.first_per_commitment_point);
7690                 self.context.counterparty_shutdown_scriptpubkey = counterparty_shutdown_scriptpubkey;
7691
7692                 self.context.channel_state = ChannelState::NegotiatingFunding(
7693                         NegotiatingFundingFlags::OUR_INIT_SENT | NegotiatingFundingFlags::THEIR_INIT_SENT
7694                 );
7695                 self.context.inbound_handshake_limits_override = None; // We're done enforcing limits on our peer's handshake now.
7696
7697                 Ok(())
7698         }
7699
7700         /// Handles a funding_signed message from the remote end.
7701         /// If this call is successful, broadcast the funding transaction (and not before!)
7702         pub fn funding_signed<L: Deref>(
7703                 mut self, msg: &msgs::FundingSigned, best_block: BestBlock, signer_provider: &SP, logger: &L
7704         ) -> Result<(Channel<SP>, ChannelMonitor<<SP::Target as SignerProvider>::EcdsaSigner>), (OutboundV1Channel<SP>, ChannelError)>
7705         where
7706                 L::Target: Logger
7707         {
7708                 if !self.context.is_outbound() {
7709                         return Err((self, ChannelError::Close("Received funding_signed for an inbound channel?".to_owned())));
7710                 }
7711                 if !matches!(self.context.channel_state, ChannelState::FundingNegotiated) {
7712                         return Err((self, ChannelError::Close("Received funding_signed in strange state!".to_owned())));
7713                 }
7714                 if self.context.commitment_secrets.get_min_seen_secret() != (1 << 48) ||
7715                                 self.context.cur_counterparty_commitment_transaction_number != INITIAL_COMMITMENT_NUMBER ||
7716                                 self.context.cur_holder_commitment_transaction_number != INITIAL_COMMITMENT_NUMBER {
7717                         panic!("Should not have advanced channel commitment tx numbers prior to funding_created");
7718                 }
7719
7720                 let funding_script = self.context.get_funding_redeemscript();
7721
7722                 let counterparty_keys = self.context.build_remote_transaction_keys();
7723                 let counterparty_initial_commitment_tx = self.context.build_commitment_transaction(self.context.cur_counterparty_commitment_transaction_number, &counterparty_keys, false, false, logger).tx;
7724                 let counterparty_trusted_tx = counterparty_initial_commitment_tx.trust();
7725                 let counterparty_initial_bitcoin_tx = counterparty_trusted_tx.built_transaction();
7726
7727                 log_trace!(logger, "Initial counterparty tx for channel {} is: txid {} tx {}",
7728                         &self.context.channel_id(), counterparty_initial_bitcoin_tx.txid, encode::serialize_hex(&counterparty_initial_bitcoin_tx.transaction));
7729
7730                 let holder_signer = self.context.build_holder_transaction_keys(self.context.cur_holder_commitment_transaction_number);
7731                 let initial_commitment_tx = self.context.build_commitment_transaction(self.context.cur_holder_commitment_transaction_number, &holder_signer, true, false, logger).tx;
7732                 {
7733                         let trusted_tx = initial_commitment_tx.trust();
7734                         let initial_commitment_bitcoin_tx = trusted_tx.built_transaction();
7735                         let sighash = initial_commitment_bitcoin_tx.get_sighash_all(&funding_script, self.context.channel_value_satoshis);
7736                         // They sign our commitment transaction, allowing us to broadcast the tx if we wish.
7737                         if let Err(_) = self.context.secp_ctx.verify_ecdsa(&sighash, &msg.signature, &self.context.get_counterparty_pubkeys().funding_pubkey) {
7738                                 return Err((self, ChannelError::Close("Invalid funding_signed signature from peer".to_owned())));
7739                         }
7740                 }
7741
7742                 let holder_commitment_tx = HolderCommitmentTransaction::new(
7743                         initial_commitment_tx,
7744                         msg.signature,
7745                         Vec::new(),
7746                         &self.context.get_holder_pubkeys().funding_pubkey,
7747                         self.context.counterparty_funding_pubkey()
7748                 );
7749
7750                 let validated =
7751                         self.context.holder_signer.as_ref().validate_holder_commitment(&holder_commitment_tx, Vec::new());
7752                 if validated.is_err() {
7753                         return Err((self, ChannelError::Close("Failed to validate our commitment".to_owned())));
7754                 }
7755
7756                 let funding_redeemscript = self.context.get_funding_redeemscript();
7757                 let funding_txo = self.context.get_funding_txo().unwrap();
7758                 let funding_txo_script = funding_redeemscript.to_v0_p2wsh();
7759                 let obscure_factor = get_commitment_transaction_number_obscure_factor(&self.context.get_holder_pubkeys().payment_point, &self.context.get_counterparty_pubkeys().payment_point, self.context.is_outbound());
7760                 let shutdown_script = self.context.shutdown_scriptpubkey.clone().map(|script| script.into_inner());
7761                 let mut monitor_signer = signer_provider.derive_channel_signer(self.context.channel_value_satoshis, self.context.channel_keys_id);
7762                 monitor_signer.provide_channel_parameters(&self.context.channel_transaction_parameters);
7763                 let channel_monitor = ChannelMonitor::new(self.context.secp_ctx.clone(), monitor_signer,
7764                                                           shutdown_script, self.context.get_holder_selected_contest_delay(),
7765                                                           &self.context.destination_script, (funding_txo, funding_txo_script),
7766                                                           &self.context.channel_transaction_parameters,
7767                                                           funding_redeemscript.clone(), self.context.channel_value_satoshis,
7768                                                           obscure_factor,
7769                                                           holder_commitment_tx, best_block, self.context.counterparty_node_id, self.context.channel_id());
7770                 channel_monitor.provide_initial_counterparty_commitment_tx(
7771                         counterparty_initial_bitcoin_tx.txid, Vec::new(),
7772                         self.context.cur_counterparty_commitment_transaction_number,
7773                         self.context.counterparty_cur_commitment_point.unwrap(),
7774                         counterparty_initial_commitment_tx.feerate_per_kw(),
7775                         counterparty_initial_commitment_tx.to_broadcaster_value_sat(),
7776                         counterparty_initial_commitment_tx.to_countersignatory_value_sat(), logger);
7777
7778                 assert!(!self.context.channel_state.is_monitor_update_in_progress()); // We have no had any monitor(s) yet to fail update!
7779                 if self.context.is_batch_funding() {
7780                         self.context.channel_state = ChannelState::AwaitingChannelReady(AwaitingChannelReadyFlags::WAITING_FOR_BATCH);
7781                 } else {
7782                         self.context.channel_state = ChannelState::AwaitingChannelReady(AwaitingChannelReadyFlags::new());
7783                 }
7784                 self.context.cur_holder_commitment_transaction_number -= 1;
7785                 self.context.cur_counterparty_commitment_transaction_number -= 1;
7786
7787                 log_info!(logger, "Received funding_signed from peer for channel {}", &self.context.channel_id());
7788
7789                 let mut channel = Channel {
7790                         context: self.context,
7791                         #[cfg(any(dual_funding, splicing))]
7792                         dual_funding_channel_context: None,
7793                 };
7794
7795                 let need_channel_ready = channel.check_get_channel_ready(0).is_some();
7796                 channel.monitor_updating_paused(false, false, need_channel_ready, Vec::new(), Vec::new(), Vec::new());
7797                 Ok((channel, channel_monitor))
7798         }
7799
7800         /// Indicates that the signer may have some signatures for us, so we should retry if we're
7801         /// blocked.
7802         #[cfg(async_signing)]
7803         pub fn signer_maybe_unblocked<L: Deref>(&mut self, logger: &L) -> Option<msgs::FundingCreated> where L::Target: Logger {
7804                 if self.context.signer_pending_funding && self.context.is_outbound() {
7805                         log_trace!(logger, "Signer unblocked a funding_created");
7806                         self.get_funding_created_msg(logger)
7807                 } else { None }
7808         }
7809 }
7810
7811 /// A not-yet-funded inbound (from counterparty) channel using V1 channel establishment.
7812 pub(super) struct InboundV1Channel<SP: Deref> where SP::Target: SignerProvider {
7813         pub context: ChannelContext<SP>,
7814         pub unfunded_context: UnfundedChannelContext,
7815 }
7816
7817 /// Fetches the [`ChannelTypeFeatures`] that will be used for a channel built from a given
7818 /// [`msgs::CommonOpenChannelFields`].
7819 pub(super) fn channel_type_from_open_channel(
7820         common_fields: &msgs::CommonOpenChannelFields, their_features: &InitFeatures,
7821         our_supported_features: &ChannelTypeFeatures
7822 ) -> Result<ChannelTypeFeatures, ChannelError> {
7823         if let Some(channel_type) = &common_fields.channel_type {
7824                 if channel_type.supports_any_optional_bits() {
7825                         return Err(ChannelError::Close("Channel Type field contained optional bits - this is not allowed".to_owned()));
7826                 }
7827
7828                 // We only support the channel types defined by the `ChannelManager` in
7829                 // `provided_channel_type_features`. The channel type must always support
7830                 // `static_remote_key`.
7831                 if !channel_type.requires_static_remote_key() {
7832                         return Err(ChannelError::Close("Channel Type was not understood - we require static remote key".to_owned()));
7833                 }
7834                 // Make sure we support all of the features behind the channel type.
7835                 if !channel_type.is_subset(our_supported_features) {
7836                         return Err(ChannelError::Close("Channel Type contains unsupported features".to_owned()));
7837                 }
7838                 let announced_channel = if (common_fields.channel_flags & 1) == 1 { true } else { false };
7839                 if channel_type.requires_scid_privacy() && announced_channel {
7840                         return Err(ChannelError::Close("SCID Alias/Privacy Channel Type cannot be set on a public channel".to_owned()));
7841                 }
7842                 Ok(channel_type.clone())
7843         } else {
7844                 let channel_type = ChannelTypeFeatures::from_init(&their_features);
7845                 if channel_type != ChannelTypeFeatures::only_static_remote_key() {
7846                         return Err(ChannelError::Close("Only static_remote_key is supported for non-negotiated channel types".to_owned()));
7847                 }
7848                 Ok(channel_type)
7849         }
7850 }
7851
7852 impl<SP: Deref> InboundV1Channel<SP> where SP::Target: SignerProvider {
7853         /// Creates a new channel from a remote sides' request for one.
7854         /// Assumes chain_hash has already been checked and corresponds with what we expect!
7855         pub fn new<ES: Deref, F: Deref, L: Deref>(
7856                 fee_estimator: &LowerBoundedFeeEstimator<F>, entropy_source: &ES, signer_provider: &SP,
7857                 counterparty_node_id: PublicKey, our_supported_features: &ChannelTypeFeatures,
7858                 their_features: &InitFeatures, msg: &msgs::OpenChannel, user_id: u128, config: &UserConfig,
7859                 current_chain_height: u32, logger: &L, is_0conf: bool,
7860         ) -> Result<InboundV1Channel<SP>, ChannelError>
7861                 where ES::Target: EntropySource,
7862                           F::Target: FeeEstimator,
7863                           L::Target: Logger,
7864         {
7865                 let logger = WithContext::from(logger, Some(counterparty_node_id), Some(msg.common_fields.temporary_channel_id), None);
7866
7867                 // First check the channel type is known, failing before we do anything else if we don't
7868                 // support this channel type.
7869                 let channel_type = channel_type_from_open_channel(&msg.common_fields, their_features, our_supported_features)?;
7870
7871                 let holder_selected_channel_reserve_satoshis = get_holder_selected_channel_reserve_satoshis(msg.common_fields.funding_satoshis, config);
7872                 let counterparty_pubkeys = ChannelPublicKeys {
7873                         funding_pubkey: msg.common_fields.funding_pubkey,
7874                         revocation_basepoint: RevocationBasepoint::from(msg.common_fields.revocation_basepoint),
7875                         payment_point: msg.common_fields.payment_basepoint,
7876                         delayed_payment_basepoint: DelayedPaymentBasepoint::from(msg.common_fields.delayed_payment_basepoint),
7877                         htlc_basepoint: HtlcBasepoint::from(msg.common_fields.htlc_basepoint)
7878                 };
7879
7880                 let chan = Self {
7881                         context: ChannelContext::new_for_inbound_channel(
7882                                 fee_estimator,
7883                                 entropy_source,
7884                                 signer_provider,
7885                                 counterparty_node_id,
7886                                 their_features,
7887                                 user_id,
7888                                 config,
7889                                 current_chain_height,
7890                                 &&logger,
7891                                 is_0conf,
7892                                 0,
7893
7894                                 counterparty_pubkeys,
7895                                 channel_type,
7896                                 holder_selected_channel_reserve_satoshis,
7897                                 msg.channel_reserve_satoshis,
7898                                 msg.push_msat,
7899                                 msg.common_fields.clone(),
7900                         )?,
7901                         unfunded_context: UnfundedChannelContext { unfunded_channel_age_ticks: 0 }
7902                 };
7903                 Ok(chan)
7904         }
7905
7906         /// Marks an inbound channel as accepted and generates a [`msgs::AcceptChannel`] message which
7907         /// should be sent back to the counterparty node.
7908         ///
7909         /// [`msgs::AcceptChannel`]: crate::ln::msgs::AcceptChannel
7910         pub fn accept_inbound_channel(&mut self) -> msgs::AcceptChannel {
7911                 if self.context.is_outbound() {
7912                         panic!("Tried to send accept_channel for an outbound channel?");
7913                 }
7914                 if !matches!(
7915                         self.context.channel_state, ChannelState::NegotiatingFunding(flags)
7916                         if flags == (NegotiatingFundingFlags::OUR_INIT_SENT | NegotiatingFundingFlags::THEIR_INIT_SENT)
7917                 ) {
7918                         panic!("Tried to send accept_channel after channel had moved forward");
7919                 }
7920                 if self.context.cur_holder_commitment_transaction_number != INITIAL_COMMITMENT_NUMBER {
7921                         panic!("Tried to send an accept_channel for a channel that has already advanced");
7922                 }
7923
7924                 self.generate_accept_channel_message()
7925         }
7926
7927         /// This function is used to explicitly generate a [`msgs::AcceptChannel`] message for an
7928         /// inbound channel. If the intention is to accept an inbound channel, use
7929         /// [`InboundV1Channel::accept_inbound_channel`] instead.
7930         ///
7931         /// [`msgs::AcceptChannel`]: crate::ln::msgs::AcceptChannel
7932         fn generate_accept_channel_message(&self) -> msgs::AcceptChannel {
7933                 let first_per_commitment_point = self.context.holder_signer.as_ref().get_per_commitment_point(self.context.cur_holder_commitment_transaction_number, &self.context.secp_ctx);
7934                 let keys = self.context.get_holder_pubkeys();
7935
7936                 msgs::AcceptChannel {
7937                         common_fields: msgs::CommonAcceptChannelFields {
7938                                 temporary_channel_id: self.context.channel_id,
7939                                 dust_limit_satoshis: self.context.holder_dust_limit_satoshis,
7940                                 max_htlc_value_in_flight_msat: self.context.holder_max_htlc_value_in_flight_msat,
7941                                 htlc_minimum_msat: self.context.holder_htlc_minimum_msat,
7942                                 minimum_depth: self.context.minimum_depth.unwrap(),
7943                                 to_self_delay: self.context.get_holder_selected_contest_delay(),
7944                                 max_accepted_htlcs: self.context.holder_max_accepted_htlcs,
7945                                 funding_pubkey: keys.funding_pubkey,
7946                                 revocation_basepoint: keys.revocation_basepoint.to_public_key(),
7947                                 payment_basepoint: keys.payment_point,
7948                                 delayed_payment_basepoint: keys.delayed_payment_basepoint.to_public_key(),
7949                                 htlc_basepoint: keys.htlc_basepoint.to_public_key(),
7950                                 first_per_commitment_point,
7951                                 shutdown_scriptpubkey: Some(match &self.context.shutdown_scriptpubkey {
7952                                         Some(script) => script.clone().into_inner(),
7953                                         None => Builder::new().into_script(),
7954                                 }),
7955                                 channel_type: Some(self.context.channel_type.clone()),
7956                         },
7957                         channel_reserve_satoshis: self.context.holder_selected_channel_reserve_satoshis,
7958                         #[cfg(taproot)]
7959                         next_local_nonce: None,
7960                 }
7961         }
7962
7963         /// Enables the possibility for tests to extract a [`msgs::AcceptChannel`] message for an
7964         /// inbound channel without accepting it.
7965         ///
7966         /// [`msgs::AcceptChannel`]: crate::ln::msgs::AcceptChannel
7967         #[cfg(test)]
7968         pub fn get_accept_channel_message(&self) -> msgs::AcceptChannel {
7969                 self.generate_accept_channel_message()
7970         }
7971
7972         fn check_funding_created_signature<L: Deref>(&mut self, sig: &Signature, logger: &L) -> Result<CommitmentTransaction, ChannelError> where L::Target: Logger {
7973                 let funding_script = self.context.get_funding_redeemscript();
7974
7975                 let keys = self.context.build_holder_transaction_keys(self.context.cur_holder_commitment_transaction_number);
7976                 let initial_commitment_tx = self.context.build_commitment_transaction(self.context.cur_holder_commitment_transaction_number, &keys, true, false, logger).tx;
7977                 let trusted_tx = initial_commitment_tx.trust();
7978                 let initial_commitment_bitcoin_tx = trusted_tx.built_transaction();
7979                 let sighash = initial_commitment_bitcoin_tx.get_sighash_all(&funding_script, self.context.channel_value_satoshis);
7980                 // They sign the holder commitment transaction...
7981                 log_trace!(logger, "Checking funding_created tx signature {} by key {} against tx {} (sighash {}) with redeemscript {} for channel {}.",
7982                         log_bytes!(sig.serialize_compact()[..]), log_bytes!(self.context.counterparty_funding_pubkey().serialize()),
7983                         encode::serialize_hex(&initial_commitment_bitcoin_tx.transaction), log_bytes!(sighash[..]),
7984                         encode::serialize_hex(&funding_script), &self.context.channel_id());
7985                 secp_check!(self.context.secp_ctx.verify_ecdsa(&sighash, &sig, self.context.counterparty_funding_pubkey()), "Invalid funding_created signature from peer".to_owned());
7986
7987                 Ok(initial_commitment_tx)
7988         }
7989
7990         pub fn funding_created<L: Deref>(
7991                 mut self, msg: &msgs::FundingCreated, best_block: BestBlock, signer_provider: &SP, logger: &L
7992         ) -> Result<(Channel<SP>, Option<msgs::FundingSigned>, ChannelMonitor<<SP::Target as SignerProvider>::EcdsaSigner>), (Self, ChannelError)>
7993         where
7994                 L::Target: Logger
7995         {
7996                 if self.context.is_outbound() {
7997                         return Err((self, ChannelError::Close("Received funding_created for an outbound channel?".to_owned())));
7998                 }
7999                 if !matches!(
8000                         self.context.channel_state, ChannelState::NegotiatingFunding(flags)
8001                         if flags == (NegotiatingFundingFlags::OUR_INIT_SENT | NegotiatingFundingFlags::THEIR_INIT_SENT)
8002                 ) {
8003                         // BOLT 2 says that if we disconnect before we send funding_signed we SHOULD NOT
8004                         // remember the channel, so it's safe to just send an error_message here and drop the
8005                         // channel.
8006                         return Err((self, ChannelError::Close("Received funding_created after we got the channel!".to_owned())));
8007                 }
8008                 if self.context.commitment_secrets.get_min_seen_secret() != (1 << 48) ||
8009                                 self.context.cur_counterparty_commitment_transaction_number != INITIAL_COMMITMENT_NUMBER ||
8010                                 self.context.cur_holder_commitment_transaction_number != INITIAL_COMMITMENT_NUMBER {
8011                         panic!("Should not have advanced channel commitment tx numbers prior to funding_created");
8012                 }
8013
8014                 let funding_txo = OutPoint { txid: msg.funding_txid, index: msg.funding_output_index };
8015                 self.context.channel_transaction_parameters.funding_outpoint = Some(funding_txo);
8016                 // This is an externally observable change before we finish all our checks.  In particular
8017                 // check_funding_created_signature may fail.
8018                 self.context.holder_signer.as_mut().provide_channel_parameters(&self.context.channel_transaction_parameters);
8019
8020                 let initial_commitment_tx = match self.check_funding_created_signature(&msg.signature, logger) {
8021                         Ok(res) => res,
8022                         Err(ChannelError::Close(e)) => {
8023                                 self.context.channel_transaction_parameters.funding_outpoint = None;
8024                                 return Err((self, ChannelError::Close(e)));
8025                         },
8026                         Err(e) => {
8027                                 // The only error we know how to handle is ChannelError::Close, so we fall over here
8028                                 // to make sure we don't continue with an inconsistent state.
8029                                 panic!("unexpected error type from check_funding_created_signature {:?}", e);
8030                         }
8031                 };
8032
8033                 let holder_commitment_tx = HolderCommitmentTransaction::new(
8034                         initial_commitment_tx,
8035                         msg.signature,
8036                         Vec::new(),
8037                         &self.context.get_holder_pubkeys().funding_pubkey,
8038                         self.context.counterparty_funding_pubkey()
8039                 );
8040
8041                 if let Err(_) = self.context.holder_signer.as_ref().validate_holder_commitment(&holder_commitment_tx, Vec::new()) {
8042                         return Err((self, ChannelError::Close("Failed to validate our commitment".to_owned())));
8043                 }
8044
8045                 // Now that we're past error-generating stuff, update our local state:
8046
8047                 self.context.channel_state = ChannelState::AwaitingChannelReady(AwaitingChannelReadyFlags::new());
8048                 self.context.channel_id = ChannelId::v1_from_funding_outpoint(funding_txo);
8049                 self.context.cur_counterparty_commitment_transaction_number -= 1;
8050                 self.context.cur_holder_commitment_transaction_number -= 1;
8051
8052                 let (counterparty_initial_commitment_tx, funding_signed) = self.context.get_funding_signed_msg(logger);
8053
8054                 let funding_redeemscript = self.context.get_funding_redeemscript();
8055                 let funding_txo_script = funding_redeemscript.to_v0_p2wsh();
8056                 let obscure_factor = get_commitment_transaction_number_obscure_factor(&self.context.get_holder_pubkeys().payment_point, &self.context.get_counterparty_pubkeys().payment_point, self.context.is_outbound());
8057                 let shutdown_script = self.context.shutdown_scriptpubkey.clone().map(|script| script.into_inner());
8058                 let mut monitor_signer = signer_provider.derive_channel_signer(self.context.channel_value_satoshis, self.context.channel_keys_id);
8059                 monitor_signer.provide_channel_parameters(&self.context.channel_transaction_parameters);
8060                 let channel_monitor = ChannelMonitor::new(self.context.secp_ctx.clone(), monitor_signer,
8061                                                           shutdown_script, self.context.get_holder_selected_contest_delay(),
8062                                                           &self.context.destination_script, (funding_txo, funding_txo_script.clone()),
8063                                                           &self.context.channel_transaction_parameters,
8064                                                           funding_redeemscript.clone(), self.context.channel_value_satoshis,
8065                                                           obscure_factor,
8066                                                           holder_commitment_tx, best_block, self.context.counterparty_node_id, self.context.channel_id());
8067                 channel_monitor.provide_initial_counterparty_commitment_tx(
8068                         counterparty_initial_commitment_tx.trust().txid(), Vec::new(),
8069                         self.context.cur_counterparty_commitment_transaction_number + 1,
8070                         self.context.counterparty_cur_commitment_point.unwrap(), self.context.feerate_per_kw,
8071                         counterparty_initial_commitment_tx.to_broadcaster_value_sat(),
8072                         counterparty_initial_commitment_tx.to_countersignatory_value_sat(), logger);
8073
8074                 log_info!(logger, "{} funding_signed for peer for channel {}",
8075                         if funding_signed.is_some() { "Generated" } else { "Waiting for signature on" }, &self.context.channel_id());
8076
8077                 // Promote the channel to a full-fledged one now that we have updated the state and have a
8078                 // `ChannelMonitor`.
8079                 let mut channel = Channel {
8080                         context: self.context,
8081                         #[cfg(any(dual_funding, splicing))]
8082                         dual_funding_channel_context: None,
8083                 };
8084                 let need_channel_ready = channel.check_get_channel_ready(0).is_some();
8085                 channel.monitor_updating_paused(false, false, need_channel_ready, Vec::new(), Vec::new(), Vec::new());
8086
8087                 Ok((channel, funding_signed, channel_monitor))
8088         }
8089 }
8090
8091 // A not-yet-funded outbound (from holder) channel using V2 channel establishment.
8092 #[cfg(any(dual_funding, splicing))]
8093 pub(super) struct OutboundV2Channel<SP: Deref> where SP::Target: SignerProvider {
8094         pub context: ChannelContext<SP>,
8095         pub unfunded_context: UnfundedChannelContext,
8096         #[cfg(any(dual_funding, splicing))]
8097         pub dual_funding_context: DualFundingChannelContext,
8098 }
8099
8100 #[cfg(any(dual_funding, splicing))]
8101 impl<SP: Deref> OutboundV2Channel<SP> where SP::Target: SignerProvider {
8102         pub fn new<ES: Deref, F: Deref>(
8103                 fee_estimator: &LowerBoundedFeeEstimator<F>, entropy_source: &ES, signer_provider: &SP,
8104                 counterparty_node_id: PublicKey, their_features: &InitFeatures, funding_satoshis: u64,
8105                 user_id: u128, config: &UserConfig, current_chain_height: u32, outbound_scid_alias: u64,
8106                 funding_confirmation_target: ConfirmationTarget,
8107         ) -> Result<OutboundV2Channel<SP>, APIError>
8108         where ES::Target: EntropySource,
8109               F::Target: FeeEstimator,
8110         {
8111                 let channel_keys_id = signer_provider.generate_channel_keys_id(false, funding_satoshis, user_id);
8112                 let holder_signer = signer_provider.derive_channel_signer(funding_satoshis, channel_keys_id);
8113                 let pubkeys = holder_signer.pubkeys().clone();
8114
8115                 let temporary_channel_id = Some(ChannelId::temporary_v2_from_revocation_basepoint(&pubkeys.revocation_basepoint));
8116
8117                 let holder_selected_channel_reserve_satoshis = get_v2_channel_reserve_satoshis(
8118                         funding_satoshis, MIN_CHAN_DUST_LIMIT_SATOSHIS);
8119
8120                 let funding_feerate_sat_per_1000_weight = fee_estimator.bounded_sat_per_1000_weight(funding_confirmation_target);
8121                 let funding_tx_locktime = current_chain_height;
8122
8123                 let chan = Self {
8124                         context: ChannelContext::new_for_outbound_channel(
8125                                 fee_estimator,
8126                                 entropy_source,
8127                                 signer_provider,
8128                                 counterparty_node_id,
8129                                 their_features,
8130                                 funding_satoshis,
8131                                 0,
8132                                 user_id,
8133                                 config,
8134                                 current_chain_height,
8135                                 outbound_scid_alias,
8136                                 temporary_channel_id,
8137                                 holder_selected_channel_reserve_satoshis,
8138                                 channel_keys_id,
8139                                 holder_signer,
8140                                 pubkeys,
8141                         )?,
8142                         unfunded_context: UnfundedChannelContext { unfunded_channel_age_ticks: 0 },
8143                         dual_funding_context: DualFundingChannelContext {
8144                                 our_funding_satoshis: funding_satoshis,
8145                                 their_funding_satoshis: 0,
8146                                 funding_tx_locktime,
8147                                 funding_feerate_sat_per_1000_weight,
8148                         }
8149                 };
8150                 Ok(chan)
8151         }
8152
8153         /// If we receive an error message, it may only be a rejection of the channel type we tried,
8154         /// not of our ability to open any channel at all. Thus, on error, we should first call this
8155         /// and see if we get a new `OpenChannelV2` message, otherwise the channel is failed.
8156         pub(crate) fn maybe_handle_error_without_close<F: Deref>(
8157                 &mut self, chain_hash: ChainHash, fee_estimator: &LowerBoundedFeeEstimator<F>
8158         ) -> Result<msgs::OpenChannelV2, ()>
8159         where
8160                 F::Target: FeeEstimator
8161         {
8162                 self.context.maybe_downgrade_channel_features(fee_estimator)?;
8163                 Ok(self.get_open_channel_v2(chain_hash))
8164         }
8165
8166         pub fn get_open_channel_v2(&self, chain_hash: ChainHash) -> msgs::OpenChannelV2 {
8167                 if self.context.have_received_message() {
8168                         debug_assert!(false, "Cannot generate an open_channel2 after we've moved forward");
8169                 }
8170
8171                 if self.context.cur_holder_commitment_transaction_number != INITIAL_COMMITMENT_NUMBER {
8172                         debug_assert!(false, "Tried to send an open_channel2 for a channel that has already advanced");
8173                 }
8174
8175                 let first_per_commitment_point = self.context.holder_signer.as_ref()
8176                         .get_per_commitment_point(self.context.cur_holder_commitment_transaction_number,
8177                                 &self.context.secp_ctx);
8178                 let second_per_commitment_point = self.context.holder_signer.as_ref()
8179                         .get_per_commitment_point(self.context.cur_holder_commitment_transaction_number - 1,
8180                                 &self.context.secp_ctx);
8181                 let keys = self.context.get_holder_pubkeys();
8182
8183                 msgs::OpenChannelV2 {
8184                         common_fields: msgs::CommonOpenChannelFields {
8185                                 chain_hash,
8186                                 temporary_channel_id: self.context.temporary_channel_id.unwrap(),
8187                                 funding_satoshis: self.context.channel_value_satoshis,
8188                                 dust_limit_satoshis: self.context.holder_dust_limit_satoshis,
8189                                 max_htlc_value_in_flight_msat: self.context.holder_max_htlc_value_in_flight_msat,
8190                                 htlc_minimum_msat: self.context.holder_htlc_minimum_msat,
8191                                 commitment_feerate_sat_per_1000_weight: self.context.feerate_per_kw,
8192                                 to_self_delay: self.context.get_holder_selected_contest_delay(),
8193                                 max_accepted_htlcs: self.context.holder_max_accepted_htlcs,
8194                                 funding_pubkey: keys.funding_pubkey,
8195                                 revocation_basepoint: keys.revocation_basepoint.to_public_key(),
8196                                 payment_basepoint: keys.payment_point,
8197                                 delayed_payment_basepoint: keys.delayed_payment_basepoint.to_public_key(),
8198                                 htlc_basepoint: keys.htlc_basepoint.to_public_key(),
8199                                 first_per_commitment_point,
8200                                 channel_flags: if self.context.config.announced_channel {1} else {0},
8201                                 shutdown_scriptpubkey: Some(match &self.context.shutdown_scriptpubkey {
8202                                         Some(script) => script.clone().into_inner(),
8203                                         None => Builder::new().into_script(),
8204                                 }),
8205                                 channel_type: Some(self.context.channel_type.clone()),
8206                         },
8207                         funding_feerate_sat_per_1000_weight: self.context.feerate_per_kw,
8208                         second_per_commitment_point,
8209                         locktime: self.dual_funding_context.funding_tx_locktime,
8210                         require_confirmed_inputs: None,
8211                 }
8212         }
8213 }
8214
8215 // A not-yet-funded inbound (from counterparty) channel using V2 channel establishment.
8216 #[cfg(any(dual_funding, splicing))]
8217 pub(super) struct InboundV2Channel<SP: Deref> where SP::Target: SignerProvider {
8218         pub context: ChannelContext<SP>,
8219         pub unfunded_context: UnfundedChannelContext,
8220         pub dual_funding_context: DualFundingChannelContext,
8221 }
8222
8223 #[cfg(any(dual_funding, splicing))]
8224 impl<SP: Deref> InboundV2Channel<SP> where SP::Target: SignerProvider {
8225         /// Creates a new dual-funded channel from a remote side's request for one.
8226         /// Assumes chain_hash has already been checked and corresponds with what we expect!
8227         pub fn new<ES: Deref, F: Deref, L: Deref>(
8228                 fee_estimator: &LowerBoundedFeeEstimator<F>, entropy_source: &ES, signer_provider: &SP,
8229                 counterparty_node_id: PublicKey, our_supported_features: &ChannelTypeFeatures,
8230                 their_features: &InitFeatures, msg: &msgs::OpenChannelV2, funding_satoshis: u64, user_id: u128,
8231                 config: &UserConfig, current_chain_height: u32, logger: &L,
8232         ) -> Result<InboundV2Channel<SP>, ChannelError>
8233                 where ES::Target: EntropySource,
8234                           F::Target: FeeEstimator,
8235                           L::Target: Logger,
8236         {
8237                 let channel_value_satoshis = funding_satoshis.saturating_add(msg.common_fields.funding_satoshis);
8238                 let counterparty_selected_channel_reserve_satoshis = get_v2_channel_reserve_satoshis(
8239                         channel_value_satoshis, msg.common_fields.dust_limit_satoshis);
8240                 let holder_selected_channel_reserve_satoshis = get_v2_channel_reserve_satoshis(
8241                         channel_value_satoshis, MIN_CHAN_DUST_LIMIT_SATOSHIS);
8242
8243                 // First check the channel type is known, failing before we do anything else if we don't
8244                 // support this channel type.
8245                 if msg.common_fields.channel_type.is_none() {
8246                         return Err(ChannelError::Close(format!("Rejecting V2 channel {} missing channel_type",
8247                                 msg.common_fields.temporary_channel_id)))
8248                 }
8249                 let channel_type = channel_type_from_open_channel(&msg.common_fields, their_features, our_supported_features)?;
8250
8251                 let counterparty_pubkeys = ChannelPublicKeys {
8252                         funding_pubkey: msg.common_fields.funding_pubkey,
8253                         revocation_basepoint: RevocationBasepoint(msg.common_fields.revocation_basepoint),
8254                         payment_point: msg.common_fields.payment_basepoint,
8255                         delayed_payment_basepoint: DelayedPaymentBasepoint(msg.common_fields.delayed_payment_basepoint),
8256                         htlc_basepoint: HtlcBasepoint(msg.common_fields.htlc_basepoint)
8257                 };
8258
8259                 let mut context = ChannelContext::new_for_inbound_channel(
8260                         fee_estimator,
8261                         entropy_source,
8262                         signer_provider,
8263                         counterparty_node_id,
8264                         their_features,
8265                         user_id,
8266                         config,
8267                         current_chain_height,
8268                         logger,
8269                         false,
8270
8271                         funding_satoshis,
8272
8273                         counterparty_pubkeys,
8274                         channel_type,
8275                         holder_selected_channel_reserve_satoshis,
8276                         counterparty_selected_channel_reserve_satoshis,
8277                         0 /* push_msat not used in dual-funding */,
8278                         msg.common_fields.clone(),
8279                 )?;
8280                 let channel_id = ChannelId::v2_from_revocation_basepoints(
8281                         &context.get_holder_pubkeys().revocation_basepoint,
8282                         &context.get_counterparty_pubkeys().revocation_basepoint);
8283                 context.channel_id = channel_id;
8284
8285                 let chan = Self {
8286                         context,
8287                         unfunded_context: UnfundedChannelContext { unfunded_channel_age_ticks: 0 },
8288                         dual_funding_context: DualFundingChannelContext {
8289                                 our_funding_satoshis: funding_satoshis,
8290                                 their_funding_satoshis: msg.common_fields.funding_satoshis,
8291                                 funding_tx_locktime: msg.locktime,
8292                                 funding_feerate_sat_per_1000_weight: msg.funding_feerate_sat_per_1000_weight,
8293                         }
8294                 };
8295
8296                 Ok(chan)
8297         }
8298
8299         /// Marks an inbound channel as accepted and generates a [`msgs::AcceptChannelV2`] message which
8300         /// should be sent back to the counterparty node.
8301         ///
8302         /// [`msgs::AcceptChannelV2`]: crate::ln::msgs::AcceptChannelV2
8303         pub fn accept_inbound_dual_funded_channel(&mut self) -> msgs::AcceptChannelV2 {
8304                 if self.context.is_outbound() {
8305                         debug_assert!(false, "Tried to send accept_channel for an outbound channel?");
8306                 }
8307                 if !matches!(
8308                         self.context.channel_state, ChannelState::NegotiatingFunding(flags)
8309                         if flags == (NegotiatingFundingFlags::OUR_INIT_SENT | NegotiatingFundingFlags::THEIR_INIT_SENT)
8310                 ) {
8311                         debug_assert!(false, "Tried to send accept_channel2 after channel had moved forward");
8312                 }
8313                 if self.context.cur_holder_commitment_transaction_number != INITIAL_COMMITMENT_NUMBER {
8314                         debug_assert!(false, "Tried to send an accept_channel2 for a channel that has already advanced");
8315                 }
8316
8317                 self.generate_accept_channel_v2_message()
8318         }
8319
8320         /// This function is used to explicitly generate a [`msgs::AcceptChannel`] message for an
8321         /// inbound channel. If the intention is to accept an inbound channel, use
8322         /// [`InboundV1Channel::accept_inbound_channel`] instead.
8323         ///
8324         /// [`msgs::AcceptChannelV2`]: crate::ln::msgs::AcceptChannelV2
8325         fn generate_accept_channel_v2_message(&self) -> msgs::AcceptChannelV2 {
8326                 let first_per_commitment_point = self.context.holder_signer.as_ref().get_per_commitment_point(
8327                         self.context.cur_holder_commitment_transaction_number, &self.context.secp_ctx);
8328                 let second_per_commitment_point = self.context.holder_signer.as_ref().get_per_commitment_point(
8329                         self.context.cur_holder_commitment_transaction_number - 1, &self.context.secp_ctx);
8330                 let keys = self.context.get_holder_pubkeys();
8331
8332                 msgs::AcceptChannelV2 {
8333                         common_fields: msgs::CommonAcceptChannelFields {
8334                                 temporary_channel_id: self.context.temporary_channel_id.unwrap(),
8335                                 dust_limit_satoshis: self.context.holder_dust_limit_satoshis,
8336                                 max_htlc_value_in_flight_msat: self.context.holder_max_htlc_value_in_flight_msat,
8337                                 htlc_minimum_msat: self.context.holder_htlc_minimum_msat,
8338                                 minimum_depth: self.context.minimum_depth.unwrap(),
8339                                 to_self_delay: self.context.get_holder_selected_contest_delay(),
8340                                 max_accepted_htlcs: self.context.holder_max_accepted_htlcs,
8341                                 funding_pubkey: keys.funding_pubkey,
8342                                 revocation_basepoint: keys.revocation_basepoint.to_public_key(),
8343                                 payment_basepoint: keys.payment_point,
8344                                 delayed_payment_basepoint: keys.delayed_payment_basepoint.to_public_key(),
8345                                 htlc_basepoint: keys.htlc_basepoint.to_public_key(),
8346                                 first_per_commitment_point,
8347                                 shutdown_scriptpubkey: Some(match &self.context.shutdown_scriptpubkey {
8348                                         Some(script) => script.clone().into_inner(),
8349                                         None => Builder::new().into_script(),
8350                                 }),
8351                                 channel_type: Some(self.context.channel_type.clone()),
8352                         },
8353                         funding_satoshis: self.dual_funding_context.our_funding_satoshis,
8354                         second_per_commitment_point,
8355                         require_confirmed_inputs: None,
8356                 }
8357         }
8358
8359         /// Enables the possibility for tests to extract a [`msgs::AcceptChannelV2`] message for an
8360         /// inbound channel without accepting it.
8361         ///
8362         /// [`msgs::AcceptChannelV2`]: crate::ln::msgs::AcceptChannelV2
8363         #[cfg(test)]
8364         pub fn get_accept_channel_v2_message(&self) -> msgs::AcceptChannelV2 {
8365                 self.generate_accept_channel_v2_message()
8366         }
8367 }
8368
8369 // Unfunded channel utilities
8370
8371 fn get_initial_channel_type(config: &UserConfig, their_features: &InitFeatures) -> ChannelTypeFeatures {
8372         // The default channel type (ie the first one we try) depends on whether the channel is
8373         // public - if it is, we just go with `only_static_remotekey` as it's the only option
8374         // available. If it's private, we first try `scid_privacy` as it provides better privacy
8375         // with no other changes, and fall back to `only_static_remotekey`.
8376         let mut ret = ChannelTypeFeatures::only_static_remote_key();
8377         if !config.channel_handshake_config.announced_channel &&
8378                 config.channel_handshake_config.negotiate_scid_privacy &&
8379                 their_features.supports_scid_privacy() {
8380                 ret.set_scid_privacy_required();
8381         }
8382
8383         // Optionally, if the user would like to negotiate the `anchors_zero_fee_htlc_tx` option, we
8384         // set it now. If they don't understand it, we'll fall back to our default of
8385         // `only_static_remotekey`.
8386         if config.channel_handshake_config.negotiate_anchors_zero_fee_htlc_tx &&
8387                 their_features.supports_anchors_zero_fee_htlc_tx() {
8388                 ret.set_anchors_zero_fee_htlc_tx_required();
8389         }
8390
8391         ret
8392 }
8393
8394 const SERIALIZATION_VERSION: u8 = 4;
8395 const MIN_SERIALIZATION_VERSION: u8 = 3;
8396
8397 impl_writeable_tlv_based_enum!(InboundHTLCRemovalReason,;
8398         (0, FailRelay),
8399         (1, FailMalformed),
8400         (2, Fulfill),
8401 );
8402
8403 impl Writeable for ChannelUpdateStatus {
8404         fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
8405                 // We only care about writing out the current state as it was announced, ie only either
8406                 // Enabled or Disabled. In the case of DisabledStaged, we most recently announced the
8407                 // channel as enabled, so we write 0. For EnabledStaged, we similarly write a 1.
8408                 match self {
8409                         ChannelUpdateStatus::Enabled => 0u8.write(writer)?,
8410                         ChannelUpdateStatus::DisabledStaged(_) => 0u8.write(writer)?,
8411                         ChannelUpdateStatus::EnabledStaged(_) => 1u8.write(writer)?,
8412                         ChannelUpdateStatus::Disabled => 1u8.write(writer)?,
8413                 }
8414                 Ok(())
8415         }
8416 }
8417
8418 impl Readable for ChannelUpdateStatus {
8419         fn read<R: io::Read>(reader: &mut R) -> Result<Self, DecodeError> {
8420                 Ok(match <u8 as Readable>::read(reader)? {
8421                         0 => ChannelUpdateStatus::Enabled,
8422                         1 => ChannelUpdateStatus::Disabled,
8423                         _ => return Err(DecodeError::InvalidValue),
8424                 })
8425         }
8426 }
8427
8428 impl Writeable for AnnouncementSigsState {
8429         fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
8430                 // We only care about writing out the current state as if we had just disconnected, at
8431                 // which point we always set anything but AnnouncementSigsReceived to NotSent.
8432                 match self {
8433                         AnnouncementSigsState::NotSent => 0u8.write(writer),
8434                         AnnouncementSigsState::MessageSent => 0u8.write(writer),
8435                         AnnouncementSigsState::Committed => 0u8.write(writer),
8436                         AnnouncementSigsState::PeerReceived => 1u8.write(writer),
8437                 }
8438         }
8439 }
8440
8441 impl Readable for AnnouncementSigsState {
8442         fn read<R: io::Read>(reader: &mut R) -> Result<Self, DecodeError> {
8443                 Ok(match <u8 as Readable>::read(reader)? {
8444                         0 => AnnouncementSigsState::NotSent,
8445                         1 => AnnouncementSigsState::PeerReceived,
8446                         _ => return Err(DecodeError::InvalidValue),
8447                 })
8448         }
8449 }
8450
8451 impl<SP: Deref> Writeable for Channel<SP> where SP::Target: SignerProvider {
8452         fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
8453                 // Note that we write out as if remove_uncommitted_htlcs_and_mark_paused had just been
8454                 // called.
8455
8456                 let version_to_write = if self.context.pending_inbound_htlcs.iter().any(|htlc| match htlc.state {
8457                         InboundHTLCState::AwaitingRemoteRevokeToAnnounce(ref htlc_resolution)|
8458                                 InboundHTLCState::AwaitingAnnouncedRemoteRevoke(ref htlc_resolution) => {
8459                                 matches!(htlc_resolution, InboundHTLCResolution::Pending { .. })
8460                         },
8461                         _ => false,
8462                 }) {
8463                         SERIALIZATION_VERSION
8464                 } else {
8465                         MIN_SERIALIZATION_VERSION
8466                 };
8467                 write_ver_prefix!(writer, version_to_write, MIN_SERIALIZATION_VERSION);
8468
8469                 // `user_id` used to be a single u64 value. In order to remain backwards compatible with
8470                 // versions prior to 0.0.113, the u128 is serialized as two separate u64 values. We write
8471                 // the low bytes now and the optional high bytes later.
8472                 let user_id_low = self.context.user_id as u64;
8473                 user_id_low.write(writer)?;
8474
8475                 // Version 1 deserializers expected to read parts of the config object here. Version 2
8476                 // deserializers (0.0.99) now read config through TLVs, and as we now require them for
8477                 // `minimum_depth` we simply write dummy values here.
8478                 writer.write_all(&[0; 8])?;
8479
8480                 self.context.channel_id.write(writer)?;
8481                 {
8482                         let mut channel_state = self.context.channel_state;
8483                         if matches!(channel_state, ChannelState::AwaitingChannelReady(_)|ChannelState::ChannelReady(_)) {
8484                                 channel_state.set_peer_disconnected();
8485                         } else {
8486                                 debug_assert!(false, "Pre-funded/shutdown channels should not be written");
8487                         }
8488                         channel_state.to_u32().write(writer)?;
8489                 }
8490                 self.context.channel_value_satoshis.write(writer)?;
8491
8492                 self.context.latest_monitor_update_id.write(writer)?;
8493
8494                 // Write out the old serialization for shutdown_pubkey for backwards compatibility, if
8495                 // deserialized from that format.
8496                 match self.context.shutdown_scriptpubkey.as_ref().and_then(|script| script.as_legacy_pubkey()) {
8497                         Some(shutdown_pubkey) => shutdown_pubkey.write(writer)?,
8498                         None => [0u8; PUBLIC_KEY_SIZE].write(writer)?,
8499                 }
8500                 self.context.destination_script.write(writer)?;
8501
8502                 self.context.cur_holder_commitment_transaction_number.write(writer)?;
8503                 self.context.cur_counterparty_commitment_transaction_number.write(writer)?;
8504                 self.context.value_to_self_msat.write(writer)?;
8505
8506                 let mut dropped_inbound_htlcs = 0;
8507                 for htlc in self.context.pending_inbound_htlcs.iter() {
8508                         if let InboundHTLCState::RemoteAnnounced(_) = htlc.state {
8509                                 dropped_inbound_htlcs += 1;
8510                         }
8511                 }
8512                 (self.context.pending_inbound_htlcs.len() as u64 - dropped_inbound_htlcs).write(writer)?;
8513                 for htlc in self.context.pending_inbound_htlcs.iter() {
8514                         if let &InboundHTLCState::RemoteAnnounced(_) = &htlc.state {
8515                                 continue; // Drop
8516                         }
8517                         htlc.htlc_id.write(writer)?;
8518                         htlc.amount_msat.write(writer)?;
8519                         htlc.cltv_expiry.write(writer)?;
8520                         htlc.payment_hash.write(writer)?;
8521                         match &htlc.state {
8522                                 &InboundHTLCState::RemoteAnnounced(_) => unreachable!(),
8523                                 &InboundHTLCState::AwaitingRemoteRevokeToAnnounce(ref htlc_resolution) => {
8524                                         1u8.write(writer)?;
8525                                         if version_to_write <= 3 {
8526                                                 if let InboundHTLCResolution::Resolved { pending_htlc_status } = htlc_resolution {
8527                                                         pending_htlc_status.write(writer)?;
8528                                                 } else {
8529                                                         panic!();
8530                                                 }
8531                                         } else {
8532                                                 htlc_resolution.write(writer)?;
8533                                         }
8534                                 },
8535                                 &InboundHTLCState::AwaitingAnnouncedRemoteRevoke(ref htlc_resolution) => {
8536                                         2u8.write(writer)?;
8537                                         if version_to_write <= 3 {
8538                                                 if let InboundHTLCResolution::Resolved { pending_htlc_status } = htlc_resolution {
8539                                                         pending_htlc_status.write(writer)?;
8540                                                 } else {
8541                                                         panic!();
8542                                                 }
8543                                         } else {
8544                                                 htlc_resolution.write(writer)?;
8545                                         }
8546                                 },
8547                                 &InboundHTLCState::Committed => {
8548                                         3u8.write(writer)?;
8549                                 },
8550                                 &InboundHTLCState::LocalRemoved(ref removal_reason) => {
8551                                         4u8.write(writer)?;
8552                                         removal_reason.write(writer)?;
8553                                 },
8554                         }
8555                 }
8556
8557                 let mut preimages: Vec<&Option<PaymentPreimage>> = vec![];
8558                 let mut pending_outbound_skimmed_fees: Vec<Option<u64>> = Vec::new();
8559                 let mut pending_outbound_blinding_points: Vec<Option<PublicKey>> = Vec::new();
8560
8561                 (self.context.pending_outbound_htlcs.len() as u64).write(writer)?;
8562                 for htlc in self.context.pending_outbound_htlcs.iter() {
8563                         htlc.htlc_id.write(writer)?;
8564                         htlc.amount_msat.write(writer)?;
8565                         htlc.cltv_expiry.write(writer)?;
8566                         htlc.payment_hash.write(writer)?;
8567                         htlc.source.write(writer)?;
8568                         match &htlc.state {
8569                                 &OutboundHTLCState::LocalAnnounced(ref onion_packet) => {
8570                                         0u8.write(writer)?;
8571                                         onion_packet.write(writer)?;
8572                                 },
8573                                 &OutboundHTLCState::Committed => {
8574                                         1u8.write(writer)?;
8575                                 },
8576                                 &OutboundHTLCState::RemoteRemoved(_) => {
8577                                         // Treat this as a Committed because we haven't received the CS - they'll
8578                                         // resend the claim/fail on reconnect as we all (hopefully) the missing CS.
8579                                         1u8.write(writer)?;
8580                                 },
8581                                 &OutboundHTLCState::AwaitingRemoteRevokeToRemove(ref outcome) => {
8582                                         3u8.write(writer)?;
8583                                         if let OutboundHTLCOutcome::Success(preimage) = outcome {
8584                                                 preimages.push(preimage);
8585                                         }
8586                                         let reason: Option<&HTLCFailReason> = outcome.into();
8587                                         reason.write(writer)?;
8588                                 }
8589                                 &OutboundHTLCState::AwaitingRemovedRemoteRevoke(ref outcome) => {
8590                                         4u8.write(writer)?;
8591                                         if let OutboundHTLCOutcome::Success(preimage) = outcome {
8592                                                 preimages.push(preimage);
8593                                         }
8594                                         let reason: Option<&HTLCFailReason> = outcome.into();
8595                                         reason.write(writer)?;
8596                                 }
8597                         }
8598                         pending_outbound_skimmed_fees.push(htlc.skimmed_fee_msat);
8599                         pending_outbound_blinding_points.push(htlc.blinding_point);
8600                 }
8601
8602                 let mut holding_cell_skimmed_fees: Vec<Option<u64>> = Vec::new();
8603                 let mut holding_cell_blinding_points: Vec<Option<PublicKey>> = Vec::new();
8604                 // Vec of (htlc_id, failure_code, sha256_of_onion)
8605                 let mut malformed_htlcs: Vec<(u64, u16, [u8; 32])> = Vec::new();
8606                 (self.context.holding_cell_htlc_updates.len() as u64).write(writer)?;
8607                 for update in self.context.holding_cell_htlc_updates.iter() {
8608                         match update {
8609                                 &HTLCUpdateAwaitingACK::AddHTLC {
8610                                         ref amount_msat, ref cltv_expiry, ref payment_hash, ref source, ref onion_routing_packet,
8611                                         blinding_point, skimmed_fee_msat,
8612                                 } => {
8613                                         0u8.write(writer)?;
8614                                         amount_msat.write(writer)?;
8615                                         cltv_expiry.write(writer)?;
8616                                         payment_hash.write(writer)?;
8617                                         source.write(writer)?;
8618                                         onion_routing_packet.write(writer)?;
8619
8620                                         holding_cell_skimmed_fees.push(skimmed_fee_msat);
8621                                         holding_cell_blinding_points.push(blinding_point);
8622                                 },
8623                                 &HTLCUpdateAwaitingACK::ClaimHTLC { ref payment_preimage, ref htlc_id } => {
8624                                         1u8.write(writer)?;
8625                                         payment_preimage.write(writer)?;
8626                                         htlc_id.write(writer)?;
8627                                 },
8628                                 &HTLCUpdateAwaitingACK::FailHTLC { ref htlc_id, ref err_packet } => {
8629                                         2u8.write(writer)?;
8630                                         htlc_id.write(writer)?;
8631                                         err_packet.write(writer)?;
8632                                 }
8633                                 &HTLCUpdateAwaitingACK::FailMalformedHTLC {
8634                                         htlc_id, failure_code, sha256_of_onion
8635                                 } => {
8636                                         // We don't want to break downgrading by adding a new variant, so write a dummy
8637                                         // `::FailHTLC` variant and write the real malformed error as an optional TLV.
8638                                         malformed_htlcs.push((htlc_id, failure_code, sha256_of_onion));
8639
8640                                         let dummy_err_packet = msgs::OnionErrorPacket { data: Vec::new() };
8641                                         2u8.write(writer)?;
8642                                         htlc_id.write(writer)?;
8643                                         dummy_err_packet.write(writer)?;
8644                                 }
8645                         }
8646                 }
8647
8648                 match self.context.resend_order {
8649                         RAACommitmentOrder::CommitmentFirst => 0u8.write(writer)?,
8650                         RAACommitmentOrder::RevokeAndACKFirst => 1u8.write(writer)?,
8651                 }
8652
8653                 self.context.monitor_pending_channel_ready.write(writer)?;
8654                 self.context.monitor_pending_revoke_and_ack.write(writer)?;
8655                 self.context.monitor_pending_commitment_signed.write(writer)?;
8656
8657                 (self.context.monitor_pending_forwards.len() as u64).write(writer)?;
8658                 for &(ref pending_forward, ref htlc_id) in self.context.monitor_pending_forwards.iter() {
8659                         pending_forward.write(writer)?;
8660                         htlc_id.write(writer)?;
8661                 }
8662
8663                 (self.context.monitor_pending_failures.len() as u64).write(writer)?;
8664                 for &(ref htlc_source, ref payment_hash, ref fail_reason) in self.context.monitor_pending_failures.iter() {
8665                         htlc_source.write(writer)?;
8666                         payment_hash.write(writer)?;
8667                         fail_reason.write(writer)?;
8668                 }
8669
8670                 if self.context.is_outbound() {
8671                         self.context.pending_update_fee.map(|(a, _)| a).write(writer)?;
8672                 } else if let Some((feerate, FeeUpdateState::AwaitingRemoteRevokeToAnnounce)) = self.context.pending_update_fee {
8673                         Some(feerate).write(writer)?;
8674                 } else {
8675                         // As for inbound HTLCs, if the update was only announced and never committed in a
8676                         // commitment_signed, drop it.
8677                         None::<u32>.write(writer)?;
8678                 }
8679                 self.context.holding_cell_update_fee.write(writer)?;
8680
8681                 self.context.next_holder_htlc_id.write(writer)?;
8682                 (self.context.next_counterparty_htlc_id - dropped_inbound_htlcs).write(writer)?;
8683                 self.context.update_time_counter.write(writer)?;
8684                 self.context.feerate_per_kw.write(writer)?;
8685
8686                 // Versions prior to 0.0.100 expected to read the fields of `last_sent_closing_fee` here,
8687                 // however we are supposed to restart shutdown fee negotiation on reconnect (and wipe
8688                 // `last_send_closing_fee` in `remove_uncommitted_htlcs_and_mark_paused`) so we should never
8689                 // consider the stale state on reload.
8690                 0u8.write(writer)?;
8691
8692                 self.context.funding_tx_confirmed_in.write(writer)?;
8693                 self.context.funding_tx_confirmation_height.write(writer)?;
8694                 self.context.short_channel_id.write(writer)?;
8695
8696                 self.context.counterparty_dust_limit_satoshis.write(writer)?;
8697                 self.context.holder_dust_limit_satoshis.write(writer)?;
8698                 self.context.counterparty_max_htlc_value_in_flight_msat.write(writer)?;
8699
8700                 // Note that this field is ignored by 0.0.99+ as the TLV Optional variant is used instead.
8701                 self.context.counterparty_selected_channel_reserve_satoshis.unwrap_or(0).write(writer)?;
8702
8703                 self.context.counterparty_htlc_minimum_msat.write(writer)?;
8704                 self.context.holder_htlc_minimum_msat.write(writer)?;
8705                 self.context.counterparty_max_accepted_htlcs.write(writer)?;
8706
8707                 // Note that this field is ignored by 0.0.99+ as the TLV Optional variant is used instead.
8708                 self.context.minimum_depth.unwrap_or(0).write(writer)?;
8709
8710                 match &self.context.counterparty_forwarding_info {
8711                         Some(info) => {
8712                                 1u8.write(writer)?;
8713                                 info.fee_base_msat.write(writer)?;
8714                                 info.fee_proportional_millionths.write(writer)?;
8715                                 info.cltv_expiry_delta.write(writer)?;
8716                         },
8717                         None => 0u8.write(writer)?
8718                 }
8719
8720                 self.context.channel_transaction_parameters.write(writer)?;
8721                 self.context.funding_transaction.write(writer)?;
8722
8723                 self.context.counterparty_cur_commitment_point.write(writer)?;
8724                 self.context.counterparty_prev_commitment_point.write(writer)?;
8725                 self.context.counterparty_node_id.write(writer)?;
8726
8727                 self.context.counterparty_shutdown_scriptpubkey.write(writer)?;
8728
8729                 self.context.commitment_secrets.write(writer)?;
8730
8731                 self.context.channel_update_status.write(writer)?;
8732
8733                 #[cfg(any(test, fuzzing))]
8734                 (self.context.historical_inbound_htlc_fulfills.len() as u64).write(writer)?;
8735                 #[cfg(any(test, fuzzing))]
8736                 for htlc in self.context.historical_inbound_htlc_fulfills.iter() {
8737                         htlc.write(writer)?;
8738                 }
8739
8740                 // If the channel type is something other than only-static-remote-key, then we need to have
8741                 // older clients fail to deserialize this channel at all. If the type is
8742                 // only-static-remote-key, we simply consider it "default" and don't write the channel type
8743                 // out at all.
8744                 let chan_type = if self.context.channel_type != ChannelTypeFeatures::only_static_remote_key() {
8745                         Some(&self.context.channel_type) } else { None };
8746
8747                 // The same logic applies for `holder_selected_channel_reserve_satoshis` values other than
8748                 // the default, and when `holder_max_htlc_value_in_flight_msat` is configured to be set to
8749                 // a different percentage of the channel value then 10%, which older versions of LDK used
8750                 // to set it to before the percentage was made configurable.
8751                 let serialized_holder_selected_reserve =
8752                         if self.context.holder_selected_channel_reserve_satoshis != get_legacy_default_holder_selected_channel_reserve_satoshis(self.context.channel_value_satoshis)
8753                         { Some(self.context.holder_selected_channel_reserve_satoshis) } else { None };
8754
8755                 let mut old_max_in_flight_percent_config = UserConfig::default().channel_handshake_config;
8756                 old_max_in_flight_percent_config.max_inbound_htlc_value_in_flight_percent_of_channel = MAX_IN_FLIGHT_PERCENT_LEGACY;
8757                 let serialized_holder_htlc_max_in_flight =
8758                         if self.context.holder_max_htlc_value_in_flight_msat != get_holder_max_htlc_value_in_flight_msat(self.context.channel_value_satoshis, &old_max_in_flight_percent_config)
8759                         { Some(self.context.holder_max_htlc_value_in_flight_msat) } else { None };
8760
8761                 let channel_pending_event_emitted = Some(self.context.channel_pending_event_emitted);
8762                 let channel_ready_event_emitted = Some(self.context.channel_ready_event_emitted);
8763
8764                 // `user_id` used to be a single u64 value. In order to remain backwards compatible with
8765                 // versions prior to 0.0.113, the u128 is serialized as two separate u64 values. Therefore,
8766                 // we write the high bytes as an option here.
8767                 let user_id_high_opt = Some((self.context.user_id >> 64) as u64);
8768
8769                 let holder_max_accepted_htlcs = if self.context.holder_max_accepted_htlcs == DEFAULT_MAX_HTLCS { None } else { Some(self.context.holder_max_accepted_htlcs) };
8770
8771                 let mut monitor_pending_update_adds = None;
8772                 if !self.context.monitor_pending_update_adds.is_empty() {
8773                         monitor_pending_update_adds = Some(&self.context.monitor_pending_update_adds);
8774                 }
8775
8776                 write_tlv_fields!(writer, {
8777                         (0, self.context.announcement_sigs, option),
8778                         // minimum_depth and counterparty_selected_channel_reserve_satoshis used to have a
8779                         // default value instead of being Option<>al. Thus, to maintain compatibility we write
8780                         // them twice, once with their original default values above, and once as an option
8781                         // here. On the read side, old versions will simply ignore the odd-type entries here,
8782                         // and new versions map the default values to None and allow the TLV entries here to
8783                         // override that.
8784                         (1, self.context.minimum_depth, option),
8785                         (2, chan_type, option),
8786                         (3, self.context.counterparty_selected_channel_reserve_satoshis, option),
8787                         (4, serialized_holder_selected_reserve, option),
8788                         (5, self.context.config, required),
8789                         (6, serialized_holder_htlc_max_in_flight, option),
8790                         (7, self.context.shutdown_scriptpubkey, option),
8791                         (8, self.context.blocked_monitor_updates, optional_vec),
8792                         (9, self.context.target_closing_feerate_sats_per_kw, option),
8793                         (10, monitor_pending_update_adds, option), // Added in 0.0.122
8794                         (11, self.context.monitor_pending_finalized_fulfills, required_vec),
8795                         (13, self.context.channel_creation_height, required),
8796                         (15, preimages, required_vec),
8797                         (17, self.context.announcement_sigs_state, required),
8798                         (19, self.context.latest_inbound_scid_alias, option),
8799                         (21, self.context.outbound_scid_alias, required),
8800                         (23, channel_ready_event_emitted, option),
8801                         (25, user_id_high_opt, option),
8802                         (27, self.context.channel_keys_id, required),
8803                         (28, holder_max_accepted_htlcs, option),
8804                         (29, self.context.temporary_channel_id, option),
8805                         (31, channel_pending_event_emitted, option),
8806                         (35, pending_outbound_skimmed_fees, optional_vec),
8807                         (37, holding_cell_skimmed_fees, optional_vec),
8808                         (38, self.context.is_batch_funding, option),
8809                         (39, pending_outbound_blinding_points, optional_vec),
8810                         (41, holding_cell_blinding_points, optional_vec),
8811                         (43, malformed_htlcs, optional_vec), // Added in 0.0.119
8812                         // 45 and 47 are reserved for async signing
8813                         (49, self.context.local_initiated_shutdown, option), // Added in 0.0.122
8814                 });
8815
8816                 Ok(())
8817         }
8818 }
8819
8820 const MAX_ALLOC_SIZE: usize = 64*1024;
8821 impl<'a, 'b, 'c, ES: Deref, SP: Deref> ReadableArgs<(&'a ES, &'b SP, u32, &'c ChannelTypeFeatures)> for Channel<SP>
8822                 where
8823                         ES::Target: EntropySource,
8824                         SP::Target: SignerProvider
8825 {
8826         fn read<R : io::Read>(reader: &mut R, args: (&'a ES, &'b SP, u32, &'c ChannelTypeFeatures)) -> Result<Self, DecodeError> {
8827                 let (entropy_source, signer_provider, serialized_height, our_supported_features) = args;
8828                 let ver = read_ver_prefix!(reader, SERIALIZATION_VERSION);
8829
8830                 // `user_id` used to be a single u64 value. In order to remain backwards compatible with
8831                 // versions prior to 0.0.113, the u128 is serialized as two separate u64 values. We read
8832                 // the low bytes now and the high bytes later.
8833                 let user_id_low: u64 = Readable::read(reader)?;
8834
8835                 let mut config = Some(LegacyChannelConfig::default());
8836                 if ver == 1 {
8837                         // Read the old serialization of the ChannelConfig from version 0.0.98.
8838                         config.as_mut().unwrap().options.forwarding_fee_proportional_millionths = Readable::read(reader)?;
8839                         config.as_mut().unwrap().options.cltv_expiry_delta = Readable::read(reader)?;
8840                         config.as_mut().unwrap().announced_channel = Readable::read(reader)?;
8841                         config.as_mut().unwrap().commit_upfront_shutdown_pubkey = Readable::read(reader)?;
8842                 } else {
8843                         // Read the 8 bytes of backwards-compatibility ChannelConfig data.
8844                         let mut _val: u64 = Readable::read(reader)?;
8845                 }
8846
8847                 let channel_id = Readable::read(reader)?;
8848                 let channel_state = ChannelState::from_u32(Readable::read(reader)?).map_err(|_| DecodeError::InvalidValue)?;
8849                 let channel_value_satoshis = Readable::read(reader)?;
8850
8851                 let latest_monitor_update_id = Readable::read(reader)?;
8852
8853                 let mut keys_data = None;
8854                 if ver <= 2 {
8855                         // Read the serialize signer bytes. We'll choose to deserialize them or not based on whether
8856                         // the `channel_keys_id` TLV is present below.
8857                         let keys_len: u32 = Readable::read(reader)?;
8858                         keys_data = Some(Vec::with_capacity(cmp::min(keys_len as usize, MAX_ALLOC_SIZE)));
8859                         while keys_data.as_ref().unwrap().len() != keys_len as usize {
8860                                 // Read 1KB at a time to avoid accidentally allocating 4GB on corrupted channel keys
8861                                 let mut data = [0; 1024];
8862                                 let read_slice = &mut data[0..cmp::min(1024, keys_len as usize - keys_data.as_ref().unwrap().len())];
8863                                 reader.read_exact(read_slice)?;
8864                                 keys_data.as_mut().unwrap().extend_from_slice(read_slice);
8865                         }
8866                 }
8867
8868                 // Read the old serialization for shutdown_pubkey, preferring the TLV field later if set.
8869                 let mut shutdown_scriptpubkey = match <PublicKey as Readable>::read(reader) {
8870                         Ok(pubkey) => Some(ShutdownScript::new_p2wpkh_from_pubkey(pubkey)),
8871                         Err(_) => None,
8872                 };
8873                 let destination_script = Readable::read(reader)?;
8874
8875                 let cur_holder_commitment_transaction_number = Readable::read(reader)?;
8876                 let cur_counterparty_commitment_transaction_number = Readable::read(reader)?;
8877                 let value_to_self_msat = Readable::read(reader)?;
8878
8879                 let pending_inbound_htlc_count: u64 = Readable::read(reader)?;
8880
8881                 let mut pending_inbound_htlcs = Vec::with_capacity(cmp::min(pending_inbound_htlc_count as usize, DEFAULT_MAX_HTLCS as usize));
8882                 for _ in 0..pending_inbound_htlc_count {
8883                         pending_inbound_htlcs.push(InboundHTLCOutput {
8884                                 htlc_id: Readable::read(reader)?,
8885                                 amount_msat: Readable::read(reader)?,
8886                                 cltv_expiry: Readable::read(reader)?,
8887                                 payment_hash: Readable::read(reader)?,
8888                                 state: match <u8 as Readable>::read(reader)? {
8889                                         1 => {
8890                                                 let resolution = if ver <= 3 {
8891                                                         InboundHTLCResolution::Resolved { pending_htlc_status: Readable::read(reader)? }
8892                                                 } else {
8893                                                         Readable::read(reader)?
8894                                                 };
8895                                                 InboundHTLCState::AwaitingRemoteRevokeToAnnounce(resolution)
8896                                         },
8897                                         2 => {
8898                                                 let resolution = if ver <= 3 {
8899                                                         InboundHTLCResolution::Resolved { pending_htlc_status: Readable::read(reader)? }
8900                                                 } else {
8901                                                         Readable::read(reader)?
8902                                                 };
8903                                                 InboundHTLCState::AwaitingAnnouncedRemoteRevoke(resolution)
8904                                         },
8905                                         3 => InboundHTLCState::Committed,
8906                                         4 => InboundHTLCState::LocalRemoved(Readable::read(reader)?),
8907                                         _ => return Err(DecodeError::InvalidValue),
8908                                 },
8909                         });
8910                 }
8911
8912                 let pending_outbound_htlc_count: u64 = Readable::read(reader)?;
8913                 let mut pending_outbound_htlcs = Vec::with_capacity(cmp::min(pending_outbound_htlc_count as usize, DEFAULT_MAX_HTLCS as usize));
8914                 for _ in 0..pending_outbound_htlc_count {
8915                         pending_outbound_htlcs.push(OutboundHTLCOutput {
8916                                 htlc_id: Readable::read(reader)?,
8917                                 amount_msat: Readable::read(reader)?,
8918                                 cltv_expiry: Readable::read(reader)?,
8919                                 payment_hash: Readable::read(reader)?,
8920                                 source: Readable::read(reader)?,
8921                                 state: match <u8 as Readable>::read(reader)? {
8922                                         0 => OutboundHTLCState::LocalAnnounced(Box::new(Readable::read(reader)?)),
8923                                         1 => OutboundHTLCState::Committed,
8924                                         2 => {
8925                                                 let option: Option<HTLCFailReason> = Readable::read(reader)?;
8926                                                 OutboundHTLCState::RemoteRemoved(option.into())
8927                                         },
8928                                         3 => {
8929                                                 let option: Option<HTLCFailReason> = Readable::read(reader)?;
8930                                                 OutboundHTLCState::AwaitingRemoteRevokeToRemove(option.into())
8931                                         },
8932                                         4 => {
8933                                                 let option: Option<HTLCFailReason> = Readable::read(reader)?;
8934                                                 OutboundHTLCState::AwaitingRemovedRemoteRevoke(option.into())
8935                                         },
8936                                         _ => return Err(DecodeError::InvalidValue),
8937                                 },
8938                                 skimmed_fee_msat: None,
8939                                 blinding_point: None,
8940                         });
8941                 }
8942
8943                 let holding_cell_htlc_update_count: u64 = Readable::read(reader)?;
8944                 let mut holding_cell_htlc_updates = Vec::with_capacity(cmp::min(holding_cell_htlc_update_count as usize, DEFAULT_MAX_HTLCS as usize*2));
8945                 for _ in 0..holding_cell_htlc_update_count {
8946                         holding_cell_htlc_updates.push(match <u8 as Readable>::read(reader)? {
8947                                 0 => HTLCUpdateAwaitingACK::AddHTLC {
8948                                         amount_msat: Readable::read(reader)?,
8949                                         cltv_expiry: Readable::read(reader)?,
8950                                         payment_hash: Readable::read(reader)?,
8951                                         source: Readable::read(reader)?,
8952                                         onion_routing_packet: Readable::read(reader)?,
8953                                         skimmed_fee_msat: None,
8954                                         blinding_point: None,
8955                                 },
8956                                 1 => HTLCUpdateAwaitingACK::ClaimHTLC {
8957                                         payment_preimage: Readable::read(reader)?,
8958                                         htlc_id: Readable::read(reader)?,
8959                                 },
8960                                 2 => HTLCUpdateAwaitingACK::FailHTLC {
8961                                         htlc_id: Readable::read(reader)?,
8962                                         err_packet: Readable::read(reader)?,
8963                                 },
8964                                 _ => return Err(DecodeError::InvalidValue),
8965                         });
8966                 }
8967
8968                 let resend_order = match <u8 as Readable>::read(reader)? {
8969                         0 => RAACommitmentOrder::CommitmentFirst,
8970                         1 => RAACommitmentOrder::RevokeAndACKFirst,
8971                         _ => return Err(DecodeError::InvalidValue),
8972                 };
8973
8974                 let monitor_pending_channel_ready = Readable::read(reader)?;
8975                 let monitor_pending_revoke_and_ack = Readable::read(reader)?;
8976                 let monitor_pending_commitment_signed = Readable::read(reader)?;
8977
8978                 let monitor_pending_forwards_count: u64 = Readable::read(reader)?;
8979                 let mut monitor_pending_forwards = Vec::with_capacity(cmp::min(monitor_pending_forwards_count as usize, DEFAULT_MAX_HTLCS as usize));
8980                 for _ in 0..monitor_pending_forwards_count {
8981                         monitor_pending_forwards.push((Readable::read(reader)?, Readable::read(reader)?));
8982                 }
8983
8984                 let monitor_pending_failures_count: u64 = Readable::read(reader)?;
8985                 let mut monitor_pending_failures = Vec::with_capacity(cmp::min(monitor_pending_failures_count as usize, DEFAULT_MAX_HTLCS as usize));
8986                 for _ in 0..monitor_pending_failures_count {
8987                         monitor_pending_failures.push((Readable::read(reader)?, Readable::read(reader)?, Readable::read(reader)?));
8988                 }
8989
8990                 let pending_update_fee_value: Option<u32> = Readable::read(reader)?;
8991
8992                 let holding_cell_update_fee = Readable::read(reader)?;
8993
8994                 let next_holder_htlc_id = Readable::read(reader)?;
8995                 let next_counterparty_htlc_id = Readable::read(reader)?;
8996                 let update_time_counter = Readable::read(reader)?;
8997                 let feerate_per_kw = Readable::read(reader)?;
8998
8999                 // Versions prior to 0.0.100 expected to read the fields of `last_sent_closing_fee` here,
9000                 // however we are supposed to restart shutdown fee negotiation on reconnect (and wipe
9001                 // `last_send_closing_fee` in `remove_uncommitted_htlcs_and_mark_paused`) so we should never
9002                 // consider the stale state on reload.
9003                 match <u8 as Readable>::read(reader)? {
9004                         0 => {},
9005                         1 => {
9006                                 let _: u32 = Readable::read(reader)?;
9007                                 let _: u64 = Readable::read(reader)?;
9008                                 let _: Signature = Readable::read(reader)?;
9009                         },
9010                         _ => return Err(DecodeError::InvalidValue),
9011                 }
9012
9013                 let funding_tx_confirmed_in = Readable::read(reader)?;
9014                 let funding_tx_confirmation_height = Readable::read(reader)?;
9015                 let short_channel_id = Readable::read(reader)?;
9016
9017                 let counterparty_dust_limit_satoshis = Readable::read(reader)?;
9018                 let holder_dust_limit_satoshis = Readable::read(reader)?;
9019                 let counterparty_max_htlc_value_in_flight_msat = Readable::read(reader)?;
9020                 let mut counterparty_selected_channel_reserve_satoshis = None;
9021                 if ver == 1 {
9022                         // Read the old serialization from version 0.0.98.
9023                         counterparty_selected_channel_reserve_satoshis = Some(Readable::read(reader)?);
9024                 } else {
9025                         // Read the 8 bytes of backwards-compatibility data.
9026                         let _dummy: u64 = Readable::read(reader)?;
9027                 }
9028                 let counterparty_htlc_minimum_msat = Readable::read(reader)?;
9029                 let holder_htlc_minimum_msat = Readable::read(reader)?;
9030                 let counterparty_max_accepted_htlcs = Readable::read(reader)?;
9031
9032                 let mut minimum_depth = None;
9033                 if ver == 1 {
9034                         // Read the old serialization from version 0.0.98.
9035                         minimum_depth = Some(Readable::read(reader)?);
9036                 } else {
9037                         // Read the 4 bytes of backwards-compatibility data.
9038                         let _dummy: u32 = Readable::read(reader)?;
9039                 }
9040
9041                 let counterparty_forwarding_info = match <u8 as Readable>::read(reader)? {
9042                         0 => None,
9043                         1 => Some(CounterpartyForwardingInfo {
9044                                 fee_base_msat: Readable::read(reader)?,
9045                                 fee_proportional_millionths: Readable::read(reader)?,
9046                                 cltv_expiry_delta: Readable::read(reader)?,
9047                         }),
9048                         _ => return Err(DecodeError::InvalidValue),
9049                 };
9050
9051                 let mut channel_parameters: ChannelTransactionParameters = Readable::read(reader)?;
9052                 let funding_transaction: Option<Transaction> = Readable::read(reader)?;
9053
9054                 let counterparty_cur_commitment_point = Readable::read(reader)?;
9055
9056                 let counterparty_prev_commitment_point = Readable::read(reader)?;
9057                 let counterparty_node_id = Readable::read(reader)?;
9058
9059                 let counterparty_shutdown_scriptpubkey = Readable::read(reader)?;
9060                 let commitment_secrets = Readable::read(reader)?;
9061
9062                 let channel_update_status = Readable::read(reader)?;
9063
9064                 #[cfg(any(test, fuzzing))]
9065                 let mut historical_inbound_htlc_fulfills = new_hash_set();
9066                 #[cfg(any(test, fuzzing))]
9067                 {
9068                         let htlc_fulfills_len: u64 = Readable::read(reader)?;
9069                         for _ in 0..htlc_fulfills_len {
9070                                 assert!(historical_inbound_htlc_fulfills.insert(Readable::read(reader)?));
9071                         }
9072                 }
9073
9074                 let pending_update_fee = if let Some(feerate) = pending_update_fee_value {
9075                         Some((feerate, if channel_parameters.is_outbound_from_holder {
9076                                 FeeUpdateState::Outbound
9077                         } else {
9078                                 FeeUpdateState::AwaitingRemoteRevokeToAnnounce
9079                         }))
9080                 } else {
9081                         None
9082                 };
9083
9084                 let mut announcement_sigs = None;
9085                 let mut target_closing_feerate_sats_per_kw = None;
9086                 let mut monitor_pending_finalized_fulfills = Some(Vec::new());
9087                 let mut holder_selected_channel_reserve_satoshis = Some(get_legacy_default_holder_selected_channel_reserve_satoshis(channel_value_satoshis));
9088                 let mut holder_max_htlc_value_in_flight_msat = Some(get_holder_max_htlc_value_in_flight_msat(channel_value_satoshis, &UserConfig::default().channel_handshake_config));
9089                 // Prior to supporting channel type negotiation, all of our channels were static_remotekey
9090                 // only, so we default to that if none was written.
9091                 let mut channel_type = Some(ChannelTypeFeatures::only_static_remote_key());
9092                 let mut channel_creation_height = Some(serialized_height);
9093                 let mut preimages_opt: Option<Vec<Option<PaymentPreimage>>> = None;
9094
9095                 // If we read an old Channel, for simplicity we just treat it as "we never sent an
9096                 // AnnouncementSignatures" which implies we'll re-send it on reconnect, but that's fine.
9097                 let mut announcement_sigs_state = Some(AnnouncementSigsState::NotSent);
9098                 let mut latest_inbound_scid_alias = None;
9099                 let mut outbound_scid_alias = None;
9100                 let mut channel_pending_event_emitted = None;
9101                 let mut channel_ready_event_emitted = None;
9102
9103                 let mut user_id_high_opt: Option<u64> = None;
9104                 let mut channel_keys_id: Option<[u8; 32]> = None;
9105                 let mut temporary_channel_id: Option<ChannelId> = None;
9106                 let mut holder_max_accepted_htlcs: Option<u16> = None;
9107
9108                 let mut blocked_monitor_updates = Some(Vec::new());
9109
9110                 let mut pending_outbound_skimmed_fees_opt: Option<Vec<Option<u64>>> = None;
9111                 let mut holding_cell_skimmed_fees_opt: Option<Vec<Option<u64>>> = None;
9112
9113                 let mut is_batch_funding: Option<()> = None;
9114
9115                 let mut local_initiated_shutdown: Option<()> = None;
9116
9117                 let mut pending_outbound_blinding_points_opt: Option<Vec<Option<PublicKey>>> = None;
9118                 let mut holding_cell_blinding_points_opt: Option<Vec<Option<PublicKey>>> = None;
9119
9120                 let mut malformed_htlcs: Option<Vec<(u64, u16, [u8; 32])>> = None;
9121                 let mut monitor_pending_update_adds: Option<Vec<msgs::UpdateAddHTLC>> = None;
9122
9123                 read_tlv_fields!(reader, {
9124                         (0, announcement_sigs, option),
9125                         (1, minimum_depth, option),
9126                         (2, channel_type, option),
9127                         (3, counterparty_selected_channel_reserve_satoshis, option),
9128                         (4, holder_selected_channel_reserve_satoshis, option),
9129                         (5, config, option), // Note that if none is provided we will *not* overwrite the existing one.
9130                         (6, holder_max_htlc_value_in_flight_msat, option),
9131                         (7, shutdown_scriptpubkey, option),
9132                         (8, blocked_monitor_updates, optional_vec),
9133                         (9, target_closing_feerate_sats_per_kw, option),
9134                         (10, monitor_pending_update_adds, option), // Added in 0.0.122
9135                         (11, monitor_pending_finalized_fulfills, optional_vec),
9136                         (13, channel_creation_height, option),
9137                         (15, preimages_opt, optional_vec),
9138                         (17, announcement_sigs_state, option),
9139                         (19, latest_inbound_scid_alias, option),
9140                         (21, outbound_scid_alias, option),
9141                         (23, channel_ready_event_emitted, option),
9142                         (25, user_id_high_opt, option),
9143                         (27, channel_keys_id, option),
9144                         (28, holder_max_accepted_htlcs, option),
9145                         (29, temporary_channel_id, option),
9146                         (31, channel_pending_event_emitted, option),
9147                         (35, pending_outbound_skimmed_fees_opt, optional_vec),
9148                         (37, holding_cell_skimmed_fees_opt, optional_vec),
9149                         (38, is_batch_funding, option),
9150                         (39, pending_outbound_blinding_points_opt, optional_vec),
9151                         (41, holding_cell_blinding_points_opt, optional_vec),
9152                         (43, malformed_htlcs, optional_vec), // Added in 0.0.119
9153                         // 45 and 47 are reserved for async signing
9154                         (49, local_initiated_shutdown, option),
9155                 });
9156
9157                 let (channel_keys_id, holder_signer) = if let Some(channel_keys_id) = channel_keys_id {
9158                         let mut holder_signer = signer_provider.derive_channel_signer(channel_value_satoshis, channel_keys_id);
9159                         // If we've gotten to the funding stage of the channel, populate the signer with its
9160                         // required channel parameters.
9161                         if channel_state >= ChannelState::FundingNegotiated {
9162                                 holder_signer.provide_channel_parameters(&channel_parameters);
9163                         }
9164                         (channel_keys_id, holder_signer)
9165                 } else {
9166                         // `keys_data` can be `None` if we had corrupted data.
9167                         let keys_data = keys_data.ok_or(DecodeError::InvalidValue)?;
9168                         let holder_signer = signer_provider.read_chan_signer(&keys_data)?;
9169                         (holder_signer.channel_keys_id(), holder_signer)
9170                 };
9171
9172                 if let Some(preimages) = preimages_opt {
9173                         let mut iter = preimages.into_iter();
9174                         for htlc in pending_outbound_htlcs.iter_mut() {
9175                                 match &htlc.state {
9176                                         OutboundHTLCState::AwaitingRemoteRevokeToRemove(OutboundHTLCOutcome::Success(None)) => {
9177                                                 htlc.state = OutboundHTLCState::AwaitingRemoteRevokeToRemove(OutboundHTLCOutcome::Success(iter.next().ok_or(DecodeError::InvalidValue)?));
9178                                         }
9179                                         OutboundHTLCState::AwaitingRemovedRemoteRevoke(OutboundHTLCOutcome::Success(None)) => {
9180                                                 htlc.state = OutboundHTLCState::AwaitingRemovedRemoteRevoke(OutboundHTLCOutcome::Success(iter.next().ok_or(DecodeError::InvalidValue)?));
9181                                         }
9182                                         _ => {}
9183                                 }
9184                         }
9185                         // We expect all preimages to be consumed above
9186                         if iter.next().is_some() {
9187                                 return Err(DecodeError::InvalidValue);
9188                         }
9189                 }
9190
9191                 let chan_features = channel_type.as_ref().unwrap();
9192                 if !chan_features.is_subset(our_supported_features) {
9193                         // If the channel was written by a new version and negotiated with features we don't
9194                         // understand yet, refuse to read it.
9195                         return Err(DecodeError::UnknownRequiredFeature);
9196                 }
9197
9198                 // ChannelTransactionParameters may have had an empty features set upon deserialization.
9199                 // To account for that, we're proactively setting/overriding the field here.
9200                 channel_parameters.channel_type_features = chan_features.clone();
9201
9202                 let mut secp_ctx = Secp256k1::new();
9203                 secp_ctx.seeded_randomize(&entropy_source.get_secure_random_bytes());
9204
9205                 // `user_id` used to be a single u64 value. In order to remain backwards
9206                 // compatible with versions prior to 0.0.113, the u128 is serialized as two
9207                 // separate u64 values.
9208                 let user_id = user_id_low as u128 + ((user_id_high_opt.unwrap_or(0) as u128) << 64);
9209
9210                 let holder_max_accepted_htlcs = holder_max_accepted_htlcs.unwrap_or(DEFAULT_MAX_HTLCS);
9211
9212                 if let Some(skimmed_fees) = pending_outbound_skimmed_fees_opt {
9213                         let mut iter = skimmed_fees.into_iter();
9214                         for htlc in pending_outbound_htlcs.iter_mut() {
9215                                 htlc.skimmed_fee_msat = iter.next().ok_or(DecodeError::InvalidValue)?;
9216                         }
9217                         // We expect all skimmed fees to be consumed above
9218                         if iter.next().is_some() { return Err(DecodeError::InvalidValue) }
9219                 }
9220                 if let Some(skimmed_fees) = holding_cell_skimmed_fees_opt {
9221                         let mut iter = skimmed_fees.into_iter();
9222                         for htlc in holding_cell_htlc_updates.iter_mut() {
9223                                 if let HTLCUpdateAwaitingACK::AddHTLC { ref mut skimmed_fee_msat, .. } = htlc {
9224                                         *skimmed_fee_msat = iter.next().ok_or(DecodeError::InvalidValue)?;
9225                                 }
9226                         }
9227                         // We expect all skimmed fees to be consumed above
9228                         if iter.next().is_some() { return Err(DecodeError::InvalidValue) }
9229                 }
9230                 if let Some(blinding_pts) = pending_outbound_blinding_points_opt {
9231                         let mut iter = blinding_pts.into_iter();
9232                         for htlc in pending_outbound_htlcs.iter_mut() {
9233                                 htlc.blinding_point = iter.next().ok_or(DecodeError::InvalidValue)?;
9234                         }
9235                         // We expect all blinding points to be consumed above
9236                         if iter.next().is_some() { return Err(DecodeError::InvalidValue) }
9237                 }
9238                 if let Some(blinding_pts) = holding_cell_blinding_points_opt {
9239                         let mut iter = blinding_pts.into_iter();
9240                         for htlc in holding_cell_htlc_updates.iter_mut() {
9241                                 if let HTLCUpdateAwaitingACK::AddHTLC { ref mut blinding_point, .. } = htlc {
9242                                         *blinding_point = iter.next().ok_or(DecodeError::InvalidValue)?;
9243                                 }
9244                         }
9245                         // We expect all blinding points to be consumed above
9246                         if iter.next().is_some() { return Err(DecodeError::InvalidValue) }
9247                 }
9248
9249                 if let Some(malformed_htlcs) = malformed_htlcs {
9250                         for (malformed_htlc_id, failure_code, sha256_of_onion) in malformed_htlcs {
9251                                 let htlc_idx = holding_cell_htlc_updates.iter().position(|htlc| {
9252                                         if let HTLCUpdateAwaitingACK::FailHTLC { htlc_id, err_packet } = htlc {
9253                                                 let matches = *htlc_id == malformed_htlc_id;
9254                                                 if matches { debug_assert!(err_packet.data.is_empty()) }
9255                                                 matches
9256                                         } else { false }
9257                                 }).ok_or(DecodeError::InvalidValue)?;
9258                                 let malformed_htlc = HTLCUpdateAwaitingACK::FailMalformedHTLC {
9259                                         htlc_id: malformed_htlc_id, failure_code, sha256_of_onion
9260                                 };
9261                                 let _ = core::mem::replace(&mut holding_cell_htlc_updates[htlc_idx], malformed_htlc);
9262                         }
9263                 }
9264
9265                 Ok(Channel {
9266                         context: ChannelContext {
9267                                 user_id,
9268
9269                                 config: config.unwrap(),
9270
9271                                 prev_config: None,
9272
9273                                 // Note that we don't care about serializing handshake limits as we only ever serialize
9274                                 // channel data after the handshake has completed.
9275                                 inbound_handshake_limits_override: None,
9276
9277                                 channel_id,
9278                                 temporary_channel_id,
9279                                 channel_state,
9280                                 announcement_sigs_state: announcement_sigs_state.unwrap(),
9281                                 secp_ctx,
9282                                 channel_value_satoshis,
9283
9284                                 latest_monitor_update_id,
9285
9286                                 holder_signer: ChannelSignerType::Ecdsa(holder_signer),
9287                                 shutdown_scriptpubkey,
9288                                 destination_script,
9289
9290                                 cur_holder_commitment_transaction_number,
9291                                 cur_counterparty_commitment_transaction_number,
9292                                 value_to_self_msat,
9293
9294                                 holder_max_accepted_htlcs,
9295                                 pending_inbound_htlcs,
9296                                 pending_outbound_htlcs,
9297                                 holding_cell_htlc_updates,
9298
9299                                 resend_order,
9300
9301                                 monitor_pending_channel_ready,
9302                                 monitor_pending_revoke_and_ack,
9303                                 monitor_pending_commitment_signed,
9304                                 monitor_pending_forwards,
9305                                 monitor_pending_failures,
9306                                 monitor_pending_finalized_fulfills: monitor_pending_finalized_fulfills.unwrap(),
9307                                 monitor_pending_update_adds: monitor_pending_update_adds.unwrap_or(Vec::new()),
9308
9309                                 signer_pending_commitment_update: false,
9310                                 signer_pending_funding: false,
9311
9312                                 pending_update_fee,
9313                                 holding_cell_update_fee,
9314                                 next_holder_htlc_id,
9315                                 next_counterparty_htlc_id,
9316                                 update_time_counter,
9317                                 feerate_per_kw,
9318
9319                                 #[cfg(debug_assertions)]
9320                                 holder_max_commitment_tx_output: Mutex::new((0, 0)),
9321                                 #[cfg(debug_assertions)]
9322                                 counterparty_max_commitment_tx_output: Mutex::new((0, 0)),
9323
9324                                 last_sent_closing_fee: None,
9325                                 pending_counterparty_closing_signed: None,
9326                                 expecting_peer_commitment_signed: false,
9327                                 closing_fee_limits: None,
9328                                 target_closing_feerate_sats_per_kw,
9329
9330                                 funding_tx_confirmed_in,
9331                                 funding_tx_confirmation_height,
9332                                 short_channel_id,
9333                                 channel_creation_height: channel_creation_height.unwrap(),
9334
9335                                 counterparty_dust_limit_satoshis,
9336                                 holder_dust_limit_satoshis,
9337                                 counterparty_max_htlc_value_in_flight_msat,
9338                                 holder_max_htlc_value_in_flight_msat: holder_max_htlc_value_in_flight_msat.unwrap(),
9339                                 counterparty_selected_channel_reserve_satoshis,
9340                                 holder_selected_channel_reserve_satoshis: holder_selected_channel_reserve_satoshis.unwrap(),
9341                                 counterparty_htlc_minimum_msat,
9342                                 holder_htlc_minimum_msat,
9343                                 counterparty_max_accepted_htlcs,
9344                                 minimum_depth,
9345
9346                                 counterparty_forwarding_info,
9347
9348                                 channel_transaction_parameters: channel_parameters,
9349                                 funding_transaction,
9350                                 is_batch_funding,
9351
9352                                 counterparty_cur_commitment_point,
9353                                 counterparty_prev_commitment_point,
9354                                 counterparty_node_id,
9355
9356                                 counterparty_shutdown_scriptpubkey,
9357
9358                                 commitment_secrets,
9359
9360                                 channel_update_status,
9361                                 closing_signed_in_flight: false,
9362
9363                                 announcement_sigs,
9364
9365                                 #[cfg(any(test, fuzzing))]
9366                                 next_local_commitment_tx_fee_info_cached: Mutex::new(None),
9367                                 #[cfg(any(test, fuzzing))]
9368                                 next_remote_commitment_tx_fee_info_cached: Mutex::new(None),
9369
9370                                 workaround_lnd_bug_4006: None,
9371                                 sent_message_awaiting_response: None,
9372
9373                                 latest_inbound_scid_alias,
9374                                 // Later in the ChannelManager deserialization phase we scan for channels and assign scid aliases if its missing
9375                                 outbound_scid_alias: outbound_scid_alias.unwrap_or(0),
9376
9377                                 channel_pending_event_emitted: channel_pending_event_emitted.unwrap_or(true),
9378                                 channel_ready_event_emitted: channel_ready_event_emitted.unwrap_or(true),
9379
9380                                 #[cfg(any(test, fuzzing))]
9381                                 historical_inbound_htlc_fulfills,
9382
9383                                 channel_type: channel_type.unwrap(),
9384                                 channel_keys_id,
9385
9386                                 local_initiated_shutdown,
9387
9388                                 blocked_monitor_updates: blocked_monitor_updates.unwrap(),
9389                         },
9390                         #[cfg(any(dual_funding, splicing))]
9391                         dual_funding_channel_context: None,
9392                 })
9393         }
9394 }
9395
9396 #[cfg(test)]
9397 mod tests {
9398         use std::cmp;
9399         use bitcoin::blockdata::constants::ChainHash;
9400         use bitcoin::blockdata::script::{ScriptBuf, Builder};
9401         use bitcoin::blockdata::transaction::{Transaction, TxOut};
9402         use bitcoin::blockdata::opcodes;
9403         use bitcoin::network::constants::Network;
9404         use crate::ln::onion_utils::INVALID_ONION_BLINDING;
9405         use crate::ln::types::{PaymentHash, PaymentPreimage};
9406         use crate::ln::channel_keys::{RevocationKey, RevocationBasepoint};
9407         use crate::ln::channelmanager::{self, HTLCSource, PaymentId};
9408         use crate::ln::channel::InitFeatures;
9409         use crate::ln::channel::{AwaitingChannelReadyFlags, Channel, ChannelState, InboundHTLCOutput, OutboundV1Channel, InboundV1Channel, OutboundHTLCOutput, InboundHTLCState, OutboundHTLCState, HTLCCandidate, HTLCInitiator, HTLCUpdateAwaitingACK, commit_tx_fee_msat};
9410         use crate::ln::channel::{MAX_FUNDING_SATOSHIS_NO_WUMBO, TOTAL_BITCOIN_SUPPLY_SATOSHIS, MIN_THEIR_CHAN_RESERVE_SATOSHIS};
9411         use crate::ln::features::{ChannelFeatures, ChannelTypeFeatures, NodeFeatures};
9412         use crate::ln::msgs;
9413         use crate::ln::msgs::{ChannelUpdate, DecodeError, UnsignedChannelUpdate, MAX_VALUE_MSAT};
9414         use crate::ln::script::ShutdownScript;
9415         use crate::ln::chan_utils::{self, htlc_success_tx_weight, htlc_timeout_tx_weight};
9416         use crate::chain::BestBlock;
9417         use crate::chain::chaininterface::{FeeEstimator, LowerBoundedFeeEstimator, ConfirmationTarget};
9418         use crate::sign::{ChannelSigner, InMemorySigner, EntropySource, SignerProvider};
9419         use crate::chain::transaction::OutPoint;
9420         use crate::routing::router::{Path, RouteHop};
9421         use crate::util::config::UserConfig;
9422         use crate::util::errors::APIError;
9423         use crate::util::ser::{ReadableArgs, Writeable};
9424         use crate::util::test_utils;
9425         use crate::util::test_utils::{OnGetShutdownScriptpubkey, TestKeysInterface};
9426         use bitcoin::secp256k1::{Secp256k1, ecdsa::Signature};
9427         use bitcoin::secp256k1::ffi::Signature as FFISignature;
9428         use bitcoin::secp256k1::{SecretKey,PublicKey};
9429         use bitcoin::hashes::sha256::Hash as Sha256;
9430         use bitcoin::hashes::Hash;
9431         use bitcoin::hashes::hex::FromHex;
9432         use bitcoin::hash_types::WPubkeyHash;
9433         use bitcoin::blockdata::locktime::absolute::LockTime;
9434         use bitcoin::address::{WitnessProgram, WitnessVersion};
9435         use crate::prelude::*;
9436
9437         #[test]
9438         fn test_channel_state_order() {
9439                 use crate::ln::channel::NegotiatingFundingFlags;
9440                 use crate::ln::channel::AwaitingChannelReadyFlags;
9441                 use crate::ln::channel::ChannelReadyFlags;
9442
9443                 assert!(ChannelState::NegotiatingFunding(NegotiatingFundingFlags::new()) < ChannelState::FundingNegotiated);
9444                 assert!(ChannelState::FundingNegotiated < ChannelState::AwaitingChannelReady(AwaitingChannelReadyFlags::new()));
9445                 assert!(ChannelState::AwaitingChannelReady(AwaitingChannelReadyFlags::new()) < ChannelState::ChannelReady(ChannelReadyFlags::new()));
9446                 assert!(ChannelState::ChannelReady(ChannelReadyFlags::new()) < ChannelState::ShutdownComplete);
9447         }
9448
9449         struct TestFeeEstimator {
9450                 fee_est: u32
9451         }
9452         impl FeeEstimator for TestFeeEstimator {
9453                 fn get_est_sat_per_1000_weight(&self, _: ConfirmationTarget) -> u32 {
9454                         self.fee_est
9455                 }
9456         }
9457
9458         #[test]
9459         fn test_max_funding_satoshis_no_wumbo() {
9460                 assert_eq!(TOTAL_BITCOIN_SUPPLY_SATOSHIS, 21_000_000 * 100_000_000);
9461                 assert!(MAX_FUNDING_SATOSHIS_NO_WUMBO <= TOTAL_BITCOIN_SUPPLY_SATOSHIS,
9462                         "MAX_FUNDING_SATOSHIS_NO_WUMBO is greater than all satoshis in existence");
9463         }
9464
9465         struct Keys {
9466                 signer: InMemorySigner,
9467         }
9468
9469         impl EntropySource for Keys {
9470                 fn get_secure_random_bytes(&self) -> [u8; 32] { [0; 32] }
9471         }
9472
9473         impl SignerProvider for Keys {
9474                 type EcdsaSigner = InMemorySigner;
9475                 #[cfg(taproot)]
9476                 type TaprootSigner = InMemorySigner;
9477
9478                 fn generate_channel_keys_id(&self, _inbound: bool, _channel_value_satoshis: u64, _user_channel_id: u128) -> [u8; 32] {
9479                         self.signer.channel_keys_id()
9480                 }
9481
9482                 fn derive_channel_signer(&self, _channel_value_satoshis: u64, _channel_keys_id: [u8; 32]) -> Self::EcdsaSigner {
9483                         self.signer.clone()
9484                 }
9485
9486                 fn read_chan_signer(&self, _data: &[u8]) -> Result<Self::EcdsaSigner, DecodeError> { panic!(); }
9487
9488                 fn get_destination_script(&self, _channel_keys_id: [u8; 32]) -> Result<ScriptBuf, ()> {
9489                         let secp_ctx = Secp256k1::signing_only();
9490                         let channel_monitor_claim_key = SecretKey::from_slice(&<Vec<u8>>::from_hex("0fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff").unwrap()[..]).unwrap();
9491                         let channel_monitor_claim_key_hash = WPubkeyHash::hash(&PublicKey::from_secret_key(&secp_ctx, &channel_monitor_claim_key).serialize());
9492                         Ok(Builder::new().push_opcode(opcodes::all::OP_PUSHBYTES_0).push_slice(channel_monitor_claim_key_hash).into_script())
9493                 }
9494
9495                 fn get_shutdown_scriptpubkey(&self) -> Result<ShutdownScript, ()> {
9496                         let secp_ctx = Secp256k1::signing_only();
9497                         let channel_close_key = SecretKey::from_slice(&<Vec<u8>>::from_hex("0fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff").unwrap()[..]).unwrap();
9498                         Ok(ShutdownScript::new_p2wpkh_from_pubkey(PublicKey::from_secret_key(&secp_ctx, &channel_close_key)))
9499                 }
9500         }
9501
9502         #[cfg(all(feature = "_test_vectors", not(feature = "grind_signatures")))]
9503         fn public_from_secret_hex(secp_ctx: &Secp256k1<bitcoin::secp256k1::All>, hex: &str) -> PublicKey {
9504                 PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&<Vec<u8>>::from_hex(hex).unwrap()[..]).unwrap())
9505         }
9506
9507         #[test]
9508         fn upfront_shutdown_script_incompatibility() {
9509                 let features = channelmanager::provided_init_features(&UserConfig::default()).clear_shutdown_anysegwit();
9510                 let non_v0_segwit_shutdown_script = ShutdownScript::new_witness_program(
9511                         &WitnessProgram::new(WitnessVersion::V16, &[0, 40]).unwrap(),
9512                 ).unwrap();
9513
9514                 let seed = [42; 32];
9515                 let network = Network::Testnet;
9516                 let keys_provider = test_utils::TestKeysInterface::new(&seed, network);
9517                 keys_provider.expect(OnGetShutdownScriptpubkey {
9518                         returns: non_v0_segwit_shutdown_script.clone(),
9519                 });
9520
9521                 let secp_ctx = Secp256k1::new();
9522                 let node_id = PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[42; 32]).unwrap());
9523                 let config = UserConfig::default();
9524                 match OutboundV1Channel::<&TestKeysInterface>::new(&LowerBoundedFeeEstimator::new(&TestFeeEstimator { fee_est: 253 }), &&keys_provider, &&keys_provider, node_id, &features, 10000000, 100000, 42, &config, 0, 42, None) {
9525                         Err(APIError::IncompatibleShutdownScript { script }) => {
9526                                 assert_eq!(script.into_inner(), non_v0_segwit_shutdown_script.into_inner());
9527                         },
9528                         Err(e) => panic!("Unexpected error: {:?}", e),
9529                         Ok(_) => panic!("Expected error"),
9530                 }
9531         }
9532
9533         // Check that, during channel creation, we use the same feerate in the open channel message
9534         // as we do in the Channel object creation itself.
9535         #[test]
9536         fn test_open_channel_msg_fee() {
9537                 let original_fee = 253;
9538                 let mut fee_est = TestFeeEstimator{fee_est: original_fee };
9539                 let bounded_fee_estimator = LowerBoundedFeeEstimator::new(&fee_est);
9540                 let secp_ctx = Secp256k1::new();
9541                 let seed = [42; 32];
9542                 let network = Network::Testnet;
9543                 let keys_provider = test_utils::TestKeysInterface::new(&seed, network);
9544
9545                 let node_a_node_id = PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[42; 32]).unwrap());
9546                 let config = UserConfig::default();
9547                 let node_a_chan = OutboundV1Channel::<&TestKeysInterface>::new(&bounded_fee_estimator, &&keys_provider, &&keys_provider, node_a_node_id, &channelmanager::provided_init_features(&config), 10000000, 100000, 42, &config, 0, 42, None).unwrap();
9548
9549                 // Now change the fee so we can check that the fee in the open_channel message is the
9550                 // same as the old fee.
9551                 fee_est.fee_est = 500;
9552                 let open_channel_msg = node_a_chan.get_open_channel(ChainHash::using_genesis_block(network));
9553                 assert_eq!(open_channel_msg.common_fields.commitment_feerate_sat_per_1000_weight, original_fee);
9554         }
9555
9556         #[test]
9557         fn test_holder_vs_counterparty_dust_limit() {
9558                 // Test that when calculating the local and remote commitment transaction fees, the correct
9559                 // dust limits are used.
9560                 let feeest = LowerBoundedFeeEstimator::new(&TestFeeEstimator{fee_est: 15000});
9561                 let secp_ctx = Secp256k1::new();
9562                 let seed = [42; 32];
9563                 let network = Network::Testnet;
9564                 let keys_provider = test_utils::TestKeysInterface::new(&seed, network);
9565                 let logger = test_utils::TestLogger::new();
9566                 let best_block = BestBlock::from_network(network);
9567
9568                 // Go through the flow of opening a channel between two nodes, making sure
9569                 // they have different dust limits.
9570
9571                 // Create Node A's channel pointing to Node B's pubkey
9572                 let node_b_node_id = PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[42; 32]).unwrap());
9573                 let config = UserConfig::default();
9574                 let mut node_a_chan = OutboundV1Channel::<&TestKeysInterface>::new(&feeest, &&keys_provider, &&keys_provider, node_b_node_id, &channelmanager::provided_init_features(&config), 10000000, 100000, 42, &config, 0, 42, None).unwrap();
9575
9576                 // Create Node B's channel by receiving Node A's open_channel message
9577                 // Make sure A's dust limit is as we expect.
9578                 let open_channel_msg = node_a_chan.get_open_channel(ChainHash::using_genesis_block(network));
9579                 let node_b_node_id = PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[7; 32]).unwrap());
9580                 let mut node_b_chan = InboundV1Channel::<&TestKeysInterface>::new(&feeest, &&keys_provider, &&keys_provider, node_b_node_id, &channelmanager::provided_channel_type_features(&config), &channelmanager::provided_init_features(&config), &open_channel_msg, 7, &config, 0, &&logger, /*is_0conf=*/false).unwrap();
9581
9582                 // Node B --> Node A: accept channel, explicitly setting B's dust limit.
9583                 let mut accept_channel_msg = node_b_chan.accept_inbound_channel();
9584                 accept_channel_msg.common_fields.dust_limit_satoshis = 546;
9585                 node_a_chan.accept_channel(&accept_channel_msg, &config.channel_handshake_limits, &channelmanager::provided_init_features(&config)).unwrap();
9586                 node_a_chan.context.holder_dust_limit_satoshis = 1560;
9587
9588                 // Node A --> Node B: funding created
9589                 let output_script = node_a_chan.context.get_funding_redeemscript();
9590                 let tx = Transaction { version: 1, lock_time: LockTime::ZERO, input: Vec::new(), output: vec![TxOut {
9591                         value: 10000000, script_pubkey: output_script.clone(),
9592                 }]};
9593                 let funding_outpoint = OutPoint{ txid: tx.txid(), index: 0 };
9594                 let funding_created_msg = node_a_chan.get_funding_created(tx.clone(), funding_outpoint, false, &&logger).map_err(|_| ()).unwrap();
9595                 let (_, funding_signed_msg, _) = node_b_chan.funding_created(&funding_created_msg.unwrap(), best_block, &&keys_provider, &&logger).map_err(|_| ()).unwrap();
9596
9597                 // Node B --> Node A: funding signed
9598                 let res = node_a_chan.funding_signed(&funding_signed_msg.unwrap(), best_block, &&keys_provider, &&logger);
9599                 let (mut node_a_chan, _) = if let Ok(res) = res { res } else { panic!(); };
9600
9601                 // Put some inbound and outbound HTLCs in A's channel.
9602                 let htlc_amount_msat = 11_092_000; // put an amount below A's effective dust limit but above B's.
9603                 node_a_chan.context.pending_inbound_htlcs.push(InboundHTLCOutput {
9604                         htlc_id: 0,
9605                         amount_msat: htlc_amount_msat,
9606                         payment_hash: PaymentHash(Sha256::hash(&[42; 32]).to_byte_array()),
9607                         cltv_expiry: 300000000,
9608                         state: InboundHTLCState::Committed,
9609                 });
9610
9611                 node_a_chan.context.pending_outbound_htlcs.push(OutboundHTLCOutput {
9612                         htlc_id: 1,
9613                         amount_msat: htlc_amount_msat, // put an amount below A's dust amount but above B's.
9614                         payment_hash: PaymentHash(Sha256::hash(&[43; 32]).to_byte_array()),
9615                         cltv_expiry: 200000000,
9616                         state: OutboundHTLCState::Committed,
9617                         source: HTLCSource::OutboundRoute {
9618                                 path: Path { hops: Vec::new(), blinded_tail: None },
9619                                 session_priv: SecretKey::from_slice(&<Vec<u8>>::from_hex("0fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff").unwrap()[..]).unwrap(),
9620                                 first_hop_htlc_msat: 548,
9621                                 payment_id: PaymentId([42; 32]),
9622                         },
9623                         skimmed_fee_msat: None,
9624                         blinding_point: None,
9625                 });
9626
9627                 // Make sure when Node A calculates their local commitment transaction, none of the HTLCs pass
9628                 // the dust limit check.
9629                 let htlc_candidate = HTLCCandidate::new(htlc_amount_msat, HTLCInitiator::LocalOffered);
9630                 let local_commit_tx_fee = node_a_chan.context.next_local_commit_tx_fee_msat(htlc_candidate, None);
9631                 let local_commit_fee_0_htlcs = commit_tx_fee_msat(node_a_chan.context.feerate_per_kw, 0, node_a_chan.context.get_channel_type());
9632                 assert_eq!(local_commit_tx_fee, local_commit_fee_0_htlcs);
9633
9634                 // Finally, make sure that when Node A calculates the remote's commitment transaction fees, all
9635                 // of the HTLCs are seen to be above the dust limit.
9636                 node_a_chan.context.channel_transaction_parameters.is_outbound_from_holder = false;
9637                 let remote_commit_fee_3_htlcs = commit_tx_fee_msat(node_a_chan.context.feerate_per_kw, 3, node_a_chan.context.get_channel_type());
9638                 let htlc_candidate = HTLCCandidate::new(htlc_amount_msat, HTLCInitiator::LocalOffered);
9639                 let remote_commit_tx_fee = node_a_chan.context.next_remote_commit_tx_fee_msat(htlc_candidate, None);
9640                 assert_eq!(remote_commit_tx_fee, remote_commit_fee_3_htlcs);
9641         }
9642
9643         #[test]
9644         fn test_timeout_vs_success_htlc_dust_limit() {
9645                 // Make sure that when `next_remote_commit_tx_fee_msat` and `next_local_commit_tx_fee_msat`
9646                 // calculate the real dust limits for HTLCs (i.e. the dust limit given by the counterparty
9647                 // *plus* the fees paid for the HTLC) they don't swap `HTLC_SUCCESS_TX_WEIGHT` for
9648                 // `HTLC_TIMEOUT_TX_WEIGHT`, and vice versa.
9649                 let fee_est = LowerBoundedFeeEstimator::new(&TestFeeEstimator{fee_est: 253 });
9650                 let secp_ctx = Secp256k1::new();
9651                 let seed = [42; 32];
9652                 let network = Network::Testnet;
9653                 let keys_provider = test_utils::TestKeysInterface::new(&seed, network);
9654
9655                 let node_id = PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[42; 32]).unwrap());
9656                 let config = UserConfig::default();
9657                 let mut chan = OutboundV1Channel::<&TestKeysInterface>::new(&fee_est, &&keys_provider, &&keys_provider, node_id, &channelmanager::provided_init_features(&config), 10000000, 100000, 42, &config, 0, 42, None).unwrap();
9658
9659                 let commitment_tx_fee_0_htlcs = commit_tx_fee_msat(chan.context.feerate_per_kw, 0, chan.context.get_channel_type());
9660                 let commitment_tx_fee_1_htlc = commit_tx_fee_msat(chan.context.feerate_per_kw, 1, chan.context.get_channel_type());
9661
9662                 // If HTLC_SUCCESS_TX_WEIGHT and HTLC_TIMEOUT_TX_WEIGHT were swapped: then this HTLC would be
9663                 // counted as dust when it shouldn't be.
9664                 let htlc_amt_above_timeout = ((253 * htlc_timeout_tx_weight(chan.context.get_channel_type()) / 1000) + chan.context.holder_dust_limit_satoshis + 1) * 1000;
9665                 let htlc_candidate = HTLCCandidate::new(htlc_amt_above_timeout, HTLCInitiator::LocalOffered);
9666                 let commitment_tx_fee = chan.context.next_local_commit_tx_fee_msat(htlc_candidate, None);
9667                 assert_eq!(commitment_tx_fee, commitment_tx_fee_1_htlc);
9668
9669                 // If swapped: this HTLC would be counted as non-dust when it shouldn't be.
9670                 let dust_htlc_amt_below_success = ((253 * htlc_success_tx_weight(chan.context.get_channel_type()) / 1000) + chan.context.holder_dust_limit_satoshis - 1) * 1000;
9671                 let htlc_candidate = HTLCCandidate::new(dust_htlc_amt_below_success, HTLCInitiator::RemoteOffered);
9672                 let commitment_tx_fee = chan.context.next_local_commit_tx_fee_msat(htlc_candidate, None);
9673                 assert_eq!(commitment_tx_fee, commitment_tx_fee_0_htlcs);
9674
9675                 chan.context.channel_transaction_parameters.is_outbound_from_holder = false;
9676
9677                 // If swapped: this HTLC would be counted as non-dust when it shouldn't be.
9678                 let dust_htlc_amt_above_timeout = ((253 * htlc_timeout_tx_weight(chan.context.get_channel_type()) / 1000) + chan.context.counterparty_dust_limit_satoshis + 1) * 1000;
9679                 let htlc_candidate = HTLCCandidate::new(dust_htlc_amt_above_timeout, HTLCInitiator::LocalOffered);
9680                 let commitment_tx_fee = chan.context.next_remote_commit_tx_fee_msat(htlc_candidate, None);
9681                 assert_eq!(commitment_tx_fee, commitment_tx_fee_0_htlcs);
9682
9683                 // If swapped: this HTLC would be counted as dust when it shouldn't be.
9684                 let htlc_amt_below_success = ((253 * htlc_success_tx_weight(chan.context.get_channel_type()) / 1000) + chan.context.counterparty_dust_limit_satoshis - 1) * 1000;
9685                 let htlc_candidate = HTLCCandidate::new(htlc_amt_below_success, HTLCInitiator::RemoteOffered);
9686                 let commitment_tx_fee = chan.context.next_remote_commit_tx_fee_msat(htlc_candidate, None);
9687                 assert_eq!(commitment_tx_fee, commitment_tx_fee_1_htlc);
9688         }
9689
9690         #[test]
9691         fn channel_reestablish_no_updates() {
9692                 let feeest = LowerBoundedFeeEstimator::new(&TestFeeEstimator{fee_est: 15000});
9693                 let logger = test_utils::TestLogger::new();
9694                 let secp_ctx = Secp256k1::new();
9695                 let seed = [42; 32];
9696                 let network = Network::Testnet;
9697                 let best_block = BestBlock::from_network(network);
9698                 let chain_hash = ChainHash::using_genesis_block(network);
9699                 let keys_provider = test_utils::TestKeysInterface::new(&seed, network);
9700
9701                 // Go through the flow of opening a channel between two nodes.
9702
9703                 // Create Node A's channel pointing to Node B's pubkey
9704                 let node_b_node_id = PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[42; 32]).unwrap());
9705                 let config = UserConfig::default();
9706                 let mut node_a_chan = OutboundV1Channel::<&TestKeysInterface>::new(&feeest, &&keys_provider, &&keys_provider, node_b_node_id, &channelmanager::provided_init_features(&config), 10000000, 100000, 42, &config, 0, 42, None).unwrap();
9707
9708                 // Create Node B's channel by receiving Node A's open_channel message
9709                 let open_channel_msg = node_a_chan.get_open_channel(chain_hash);
9710                 let node_b_node_id = PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[7; 32]).unwrap());
9711                 let mut node_b_chan = InboundV1Channel::<&TestKeysInterface>::new(&feeest, &&keys_provider, &&keys_provider, node_b_node_id, &channelmanager::provided_channel_type_features(&config), &channelmanager::provided_init_features(&config), &open_channel_msg, 7, &config, 0, &&logger, /*is_0conf=*/false).unwrap();
9712
9713                 // Node B --> Node A: accept channel
9714                 let accept_channel_msg = node_b_chan.accept_inbound_channel();
9715                 node_a_chan.accept_channel(&accept_channel_msg, &config.channel_handshake_limits, &channelmanager::provided_init_features(&config)).unwrap();
9716
9717                 // Node A --> Node B: funding created
9718                 let output_script = node_a_chan.context.get_funding_redeemscript();
9719                 let tx = Transaction { version: 1, lock_time: LockTime::ZERO, input: Vec::new(), output: vec![TxOut {
9720                         value: 10000000, script_pubkey: output_script.clone(),
9721                 }]};
9722                 let funding_outpoint = OutPoint{ txid: tx.txid(), index: 0 };
9723                 let funding_created_msg = node_a_chan.get_funding_created(tx.clone(), funding_outpoint, false, &&logger).map_err(|_| ()).unwrap();
9724                 let (mut node_b_chan, funding_signed_msg, _) = node_b_chan.funding_created(&funding_created_msg.unwrap(), best_block, &&keys_provider, &&logger).map_err(|_| ()).unwrap();
9725
9726                 // Node B --> Node A: funding signed
9727                 let res = node_a_chan.funding_signed(&funding_signed_msg.unwrap(), best_block, &&keys_provider, &&logger);
9728                 let (mut node_a_chan, _) = if let Ok(res) = res { res } else { panic!(); };
9729
9730                 // Now disconnect the two nodes and check that the commitment point in
9731                 // Node B's channel_reestablish message is sane.
9732                 assert!(node_b_chan.remove_uncommitted_htlcs_and_mark_paused(&&logger).is_ok());
9733                 let msg = node_b_chan.get_channel_reestablish(&&logger);
9734                 assert_eq!(msg.next_local_commitment_number, 1); // now called next_commitment_number
9735                 assert_eq!(msg.next_remote_commitment_number, 0); // now called next_revocation_number
9736                 assert_eq!(msg.your_last_per_commitment_secret, [0; 32]);
9737
9738                 // Check that the commitment point in Node A's channel_reestablish message
9739                 // is sane.
9740                 assert!(node_a_chan.remove_uncommitted_htlcs_and_mark_paused(&&logger).is_ok());
9741                 let msg = node_a_chan.get_channel_reestablish(&&logger);
9742                 assert_eq!(msg.next_local_commitment_number, 1); // now called next_commitment_number
9743                 assert_eq!(msg.next_remote_commitment_number, 0); // now called next_revocation_number
9744                 assert_eq!(msg.your_last_per_commitment_secret, [0; 32]);
9745         }
9746
9747         #[test]
9748         fn test_configured_holder_max_htlc_value_in_flight() {
9749                 let feeest = LowerBoundedFeeEstimator::new(&TestFeeEstimator{fee_est: 15000});
9750                 let logger = test_utils::TestLogger::new();
9751                 let secp_ctx = Secp256k1::new();
9752                 let seed = [42; 32];
9753                 let network = Network::Testnet;
9754                 let keys_provider = test_utils::TestKeysInterface::new(&seed, network);
9755                 let outbound_node_id = PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[42; 32]).unwrap());
9756                 let inbound_node_id = PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[7; 32]).unwrap());
9757
9758                 let mut config_2_percent = UserConfig::default();
9759                 config_2_percent.channel_handshake_config.max_inbound_htlc_value_in_flight_percent_of_channel = 2;
9760                 let mut config_99_percent = UserConfig::default();
9761                 config_99_percent.channel_handshake_config.max_inbound_htlc_value_in_flight_percent_of_channel = 99;
9762                 let mut config_0_percent = UserConfig::default();
9763                 config_0_percent.channel_handshake_config.max_inbound_htlc_value_in_flight_percent_of_channel = 0;
9764                 let mut config_101_percent = UserConfig::default();
9765                 config_101_percent.channel_handshake_config.max_inbound_htlc_value_in_flight_percent_of_channel = 101;
9766
9767                 // Test that `OutboundV1Channel::new` creates a channel with the correct value for
9768                 // `holder_max_htlc_value_in_flight_msat`, when configured with a valid percentage value,
9769                 // which is set to the lower bound + 1 (2%) of the `channel_value`.
9770                 let chan_1 = OutboundV1Channel::<&TestKeysInterface>::new(&feeest, &&keys_provider, &&keys_provider, outbound_node_id, &channelmanager::provided_init_features(&config_2_percent), 10000000, 100000, 42, &config_2_percent, 0, 42, None).unwrap();
9771                 let chan_1_value_msat = chan_1.context.channel_value_satoshis * 1000;
9772                 assert_eq!(chan_1.context.holder_max_htlc_value_in_flight_msat, (chan_1_value_msat as f64 * 0.02) as u64);
9773
9774                 // Test with the upper bound - 1 of valid values (99%).
9775                 let chan_2 = OutboundV1Channel::<&TestKeysInterface>::new(&feeest, &&keys_provider, &&keys_provider, outbound_node_id, &channelmanager::provided_init_features(&config_99_percent), 10000000, 100000, 42, &config_99_percent, 0, 42, None).unwrap();
9776                 let chan_2_value_msat = chan_2.context.channel_value_satoshis * 1000;
9777                 assert_eq!(chan_2.context.holder_max_htlc_value_in_flight_msat, (chan_2_value_msat as f64 * 0.99) as u64);
9778
9779                 let chan_1_open_channel_msg = chan_1.get_open_channel(ChainHash::using_genesis_block(network));
9780
9781                 // Test that `InboundV1Channel::new` creates a channel with the correct value for
9782                 // `holder_max_htlc_value_in_flight_msat`, when configured with a valid percentage value,
9783                 // which is set to the lower bound - 1 (2%) of the `channel_value`.
9784                 let chan_3 = InboundV1Channel::<&TestKeysInterface>::new(&feeest, &&keys_provider, &&keys_provider, inbound_node_id, &channelmanager::provided_channel_type_features(&config_2_percent), &channelmanager::provided_init_features(&config_2_percent), &chan_1_open_channel_msg, 7, &config_2_percent, 0, &&logger, /*is_0conf=*/false).unwrap();
9785                 let chan_3_value_msat = chan_3.context.channel_value_satoshis * 1000;
9786                 assert_eq!(chan_3.context.holder_max_htlc_value_in_flight_msat, (chan_3_value_msat as f64 * 0.02) as u64);
9787
9788                 // Test with the upper bound - 1 of valid values (99%).
9789                 let chan_4 = InboundV1Channel::<&TestKeysInterface>::new(&feeest, &&keys_provider, &&keys_provider, inbound_node_id, &channelmanager::provided_channel_type_features(&config_99_percent), &channelmanager::provided_init_features(&config_99_percent), &chan_1_open_channel_msg, 7, &config_99_percent, 0, &&logger, /*is_0conf=*/false).unwrap();
9790                 let chan_4_value_msat = chan_4.context.channel_value_satoshis * 1000;
9791                 assert_eq!(chan_4.context.holder_max_htlc_value_in_flight_msat, (chan_4_value_msat as f64 * 0.99) as u64);
9792
9793                 // Test that `OutboundV1Channel::new` uses the lower bound of the configurable percentage values (1%)
9794                 // if `max_inbound_htlc_value_in_flight_percent_of_channel` is set to a value less than 1.
9795                 let chan_5 = OutboundV1Channel::<&TestKeysInterface>::new(&feeest, &&keys_provider, &&keys_provider, outbound_node_id, &channelmanager::provided_init_features(&config_0_percent), 10000000, 100000, 42, &config_0_percent, 0, 42, None).unwrap();
9796                 let chan_5_value_msat = chan_5.context.channel_value_satoshis * 1000;
9797                 assert_eq!(chan_5.context.holder_max_htlc_value_in_flight_msat, (chan_5_value_msat as f64 * 0.01) as u64);
9798
9799                 // Test that `OutboundV1Channel::new` uses the upper bound of the configurable percentage values
9800                 // (100%) if `max_inbound_htlc_value_in_flight_percent_of_channel` is set to a larger value
9801                 // than 100.
9802                 let chan_6 = OutboundV1Channel::<&TestKeysInterface>::new(&feeest, &&keys_provider, &&keys_provider, outbound_node_id, &channelmanager::provided_init_features(&config_101_percent), 10000000, 100000, 42, &config_101_percent, 0, 42, None).unwrap();
9803                 let chan_6_value_msat = chan_6.context.channel_value_satoshis * 1000;
9804                 assert_eq!(chan_6.context.holder_max_htlc_value_in_flight_msat, chan_6_value_msat);
9805
9806                 // Test that `InboundV1Channel::new` uses the lower bound of the configurable percentage values (1%)
9807                 // if `max_inbound_htlc_value_in_flight_percent_of_channel` is set to a value less than 1.
9808                 let chan_7 = InboundV1Channel::<&TestKeysInterface>::new(&feeest, &&keys_provider, &&keys_provider, inbound_node_id, &channelmanager::provided_channel_type_features(&config_0_percent), &channelmanager::provided_init_features(&config_0_percent), &chan_1_open_channel_msg, 7, &config_0_percent, 0, &&logger, /*is_0conf=*/false).unwrap();
9809                 let chan_7_value_msat = chan_7.context.channel_value_satoshis * 1000;
9810                 assert_eq!(chan_7.context.holder_max_htlc_value_in_flight_msat, (chan_7_value_msat as f64 * 0.01) as u64);
9811
9812                 // Test that `InboundV1Channel::new` uses the upper bound of the configurable percentage values
9813                 // (100%) if `max_inbound_htlc_value_in_flight_percent_of_channel` is set to a larger value
9814                 // than 100.
9815                 let chan_8 = InboundV1Channel::<&TestKeysInterface>::new(&feeest, &&keys_provider, &&keys_provider, inbound_node_id, &channelmanager::provided_channel_type_features(&config_101_percent), &channelmanager::provided_init_features(&config_101_percent), &chan_1_open_channel_msg, 7, &config_101_percent, 0, &&logger, /*is_0conf=*/false).unwrap();
9816                 let chan_8_value_msat = chan_8.context.channel_value_satoshis * 1000;
9817                 assert_eq!(chan_8.context.holder_max_htlc_value_in_flight_msat, chan_8_value_msat);
9818         }
9819
9820         #[test]
9821         fn test_configured_holder_selected_channel_reserve_satoshis() {
9822
9823                 // Test that `OutboundV1Channel::new` and `InboundV1Channel::new` create a channel with the correct
9824                 // channel reserves, when `their_channel_reserve_proportional_millionths` is configured.
9825                 test_self_and_counterparty_channel_reserve(10_000_000, 0.02, 0.02);
9826
9827                 // Test with valid but unreasonably high channel reserves
9828                 // Requesting and accepting parties have requested for 49%-49% and 60%-30% channel reserve
9829                 test_self_and_counterparty_channel_reserve(10_000_000, 0.49, 0.49);
9830                 test_self_and_counterparty_channel_reserve(10_000_000, 0.60, 0.30);
9831
9832                 // Test with calculated channel reserve less than lower bound
9833                 // i.e `MIN_THEIR_CHAN_RESERVE_SATOSHIS`
9834                 test_self_and_counterparty_channel_reserve(100_000, 0.00002, 0.30);
9835
9836                 // Test with invalid channel reserves since sum of both is greater than or equal
9837                 // to channel value
9838                 test_self_and_counterparty_channel_reserve(10_000_000, 0.50, 0.50);
9839                 test_self_and_counterparty_channel_reserve(10_000_000, 0.60, 0.50);
9840         }
9841
9842         fn test_self_and_counterparty_channel_reserve(channel_value_satoshis: u64, outbound_selected_channel_reserve_perc: f64, inbound_selected_channel_reserve_perc: f64) {
9843                 let fee_est = LowerBoundedFeeEstimator::new(&TestFeeEstimator { fee_est: 15_000 });
9844                 let logger = test_utils::TestLogger::new();
9845                 let secp_ctx = Secp256k1::new();
9846                 let seed = [42; 32];
9847                 let network = Network::Testnet;
9848                 let keys_provider = test_utils::TestKeysInterface::new(&seed, network);
9849                 let outbound_node_id = PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[42; 32]).unwrap());
9850                 let inbound_node_id = PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[7; 32]).unwrap());
9851
9852
9853                 let mut outbound_node_config = UserConfig::default();
9854                 outbound_node_config.channel_handshake_config.their_channel_reserve_proportional_millionths = (outbound_selected_channel_reserve_perc * 1_000_000.0) as u32;
9855                 let chan = OutboundV1Channel::<&TestKeysInterface>::new(&&fee_est, &&keys_provider, &&keys_provider, outbound_node_id, &channelmanager::provided_init_features(&outbound_node_config), channel_value_satoshis, 100_000, 42, &outbound_node_config, 0, 42, None).unwrap();
9856
9857                 let expected_outbound_selected_chan_reserve = cmp::max(MIN_THEIR_CHAN_RESERVE_SATOSHIS, (chan.context.channel_value_satoshis as f64 * outbound_selected_channel_reserve_perc) as u64);
9858                 assert_eq!(chan.context.holder_selected_channel_reserve_satoshis, expected_outbound_selected_chan_reserve);
9859
9860                 let chan_open_channel_msg = chan.get_open_channel(ChainHash::using_genesis_block(network));
9861                 let mut inbound_node_config = UserConfig::default();
9862                 inbound_node_config.channel_handshake_config.their_channel_reserve_proportional_millionths = (inbound_selected_channel_reserve_perc * 1_000_000.0) as u32;
9863
9864                 if outbound_selected_channel_reserve_perc + inbound_selected_channel_reserve_perc < 1.0 {
9865                         let chan_inbound_node = InboundV1Channel::<&TestKeysInterface>::new(&&fee_est, &&keys_provider, &&keys_provider, inbound_node_id, &channelmanager::provided_channel_type_features(&inbound_node_config), &channelmanager::provided_init_features(&outbound_node_config), &chan_open_channel_msg, 7, &inbound_node_config, 0, &&logger, /*is_0conf=*/false).unwrap();
9866
9867                         let expected_inbound_selected_chan_reserve = cmp::max(MIN_THEIR_CHAN_RESERVE_SATOSHIS, (chan.context.channel_value_satoshis as f64 * inbound_selected_channel_reserve_perc) as u64);
9868
9869                         assert_eq!(chan_inbound_node.context.holder_selected_channel_reserve_satoshis, expected_inbound_selected_chan_reserve);
9870                         assert_eq!(chan_inbound_node.context.counterparty_selected_channel_reserve_satoshis.unwrap(), expected_outbound_selected_chan_reserve);
9871                 } else {
9872                         // Channel Negotiations failed
9873                         let result = InboundV1Channel::<&TestKeysInterface>::new(&&fee_est, &&keys_provider, &&keys_provider, inbound_node_id, &channelmanager::provided_channel_type_features(&inbound_node_config), &channelmanager::provided_init_features(&outbound_node_config), &chan_open_channel_msg, 7, &inbound_node_config, 0, &&logger, /*is_0conf=*/false);
9874                         assert!(result.is_err());
9875                 }
9876         }
9877
9878         #[test]
9879         fn channel_update() {
9880                 let feeest = LowerBoundedFeeEstimator::new(&TestFeeEstimator{fee_est: 15000});
9881                 let logger = test_utils::TestLogger::new();
9882                 let secp_ctx = Secp256k1::new();
9883                 let seed = [42; 32];
9884                 let network = Network::Testnet;
9885                 let best_block = BestBlock::from_network(network);
9886                 let chain_hash = ChainHash::using_genesis_block(network);
9887                 let keys_provider = test_utils::TestKeysInterface::new(&seed, network);
9888
9889                 // Create Node A's channel pointing to Node B's pubkey
9890                 let node_b_node_id = PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[42; 32]).unwrap());
9891                 let config = UserConfig::default();
9892                 let mut node_a_chan = OutboundV1Channel::<&TestKeysInterface>::new(&feeest, &&keys_provider, &&keys_provider, node_b_node_id, &channelmanager::provided_init_features(&config), 10000000, 100000, 42, &config, 0, 42, None).unwrap();
9893
9894                 // Create Node B's channel by receiving Node A's open_channel message
9895                 // Make sure A's dust limit is as we expect.
9896                 let open_channel_msg = node_a_chan.get_open_channel(ChainHash::using_genesis_block(network));
9897                 let node_b_node_id = PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[7; 32]).unwrap());
9898                 let mut node_b_chan = InboundV1Channel::<&TestKeysInterface>::new(&feeest, &&keys_provider, &&keys_provider, node_b_node_id, &channelmanager::provided_channel_type_features(&config), &channelmanager::provided_init_features(&config), &open_channel_msg, 7, &config, 0, &&logger, /*is_0conf=*/false).unwrap();
9899
9900                 // Node B --> Node A: accept channel, explicitly setting B's dust limit.
9901                 let mut accept_channel_msg = node_b_chan.accept_inbound_channel();
9902                 accept_channel_msg.common_fields.dust_limit_satoshis = 546;
9903                 node_a_chan.accept_channel(&accept_channel_msg, &config.channel_handshake_limits, &channelmanager::provided_init_features(&config)).unwrap();
9904                 node_a_chan.context.holder_dust_limit_satoshis = 1560;
9905
9906                 // Node A --> Node B: funding created
9907                 let output_script = node_a_chan.context.get_funding_redeemscript();
9908                 let tx = Transaction { version: 1, lock_time: LockTime::ZERO, input: Vec::new(), output: vec![TxOut {
9909                         value: 10000000, script_pubkey: output_script.clone(),
9910                 }]};
9911                 let funding_outpoint = OutPoint{ txid: tx.txid(), index: 0 };
9912                 let funding_created_msg = node_a_chan.get_funding_created(tx.clone(), funding_outpoint, false, &&logger).map_err(|_| ()).unwrap();
9913                 let (_, funding_signed_msg, _) = node_b_chan.funding_created(&funding_created_msg.unwrap(), best_block, &&keys_provider, &&logger).map_err(|_| ()).unwrap();
9914
9915                 // Node B --> Node A: funding signed
9916                 let res = node_a_chan.funding_signed(&funding_signed_msg.unwrap(), best_block, &&keys_provider, &&logger);
9917                 let (mut node_a_chan, _) = if let Ok(res) = res { res } else { panic!(); };
9918
9919                 // Make sure that receiving a channel update will update the Channel as expected.
9920                 let update = ChannelUpdate {
9921                         contents: UnsignedChannelUpdate {
9922                                 chain_hash,
9923                                 short_channel_id: 0,
9924                                 timestamp: 0,
9925                                 flags: 0,
9926                                 cltv_expiry_delta: 100,
9927                                 htlc_minimum_msat: 5,
9928                                 htlc_maximum_msat: MAX_VALUE_MSAT,
9929                                 fee_base_msat: 110,
9930                                 fee_proportional_millionths: 11,
9931                                 excess_data: Vec::new(),
9932                         },
9933                         signature: Signature::from(unsafe { FFISignature::new() })
9934                 };
9935                 assert!(node_a_chan.channel_update(&update).unwrap());
9936
9937                 // The counterparty can send an update with a higher minimum HTLC, but that shouldn't
9938                 // change our official htlc_minimum_msat.
9939                 assert_eq!(node_a_chan.context.holder_htlc_minimum_msat, 1);
9940                 match node_a_chan.context.counterparty_forwarding_info() {
9941                         Some(info) => {
9942                                 assert_eq!(info.cltv_expiry_delta, 100);
9943                                 assert_eq!(info.fee_base_msat, 110);
9944                                 assert_eq!(info.fee_proportional_millionths, 11);
9945                         },
9946                         None => panic!("expected counterparty forwarding info to be Some")
9947                 }
9948
9949                 assert!(!node_a_chan.channel_update(&update).unwrap());
9950         }
9951
9952         #[test]
9953         fn blinding_point_skimmed_fee_malformed_ser() {
9954                 // Ensure that channel blinding points, skimmed fees, and malformed HTLCs are (de)serialized
9955                 // properly.
9956                 let logger = test_utils::TestLogger::new();
9957                 let feeest = LowerBoundedFeeEstimator::new(&TestFeeEstimator{fee_est: 15000});
9958                 let secp_ctx = Secp256k1::new();
9959                 let seed = [42; 32];
9960                 let network = Network::Testnet;
9961                 let best_block = BestBlock::from_network(network);
9962                 let keys_provider = test_utils::TestKeysInterface::new(&seed, network);
9963
9964                 let node_b_node_id = PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[42; 32]).unwrap());
9965                 let config = UserConfig::default();
9966                 let features = channelmanager::provided_init_features(&config);
9967                 let mut outbound_chan = OutboundV1Channel::<&TestKeysInterface>::new(
9968                         &feeest, &&keys_provider, &&keys_provider, node_b_node_id, &features, 10000000, 100000, 42, &config, 0, 42, None
9969                 ).unwrap();
9970                 let inbound_chan = InboundV1Channel::<&TestKeysInterface>::new(
9971                         &feeest, &&keys_provider, &&keys_provider, node_b_node_id, &channelmanager::provided_channel_type_features(&config),
9972                         &features, &outbound_chan.get_open_channel(ChainHash::using_genesis_block(network)), 7, &config, 0, &&logger, false
9973                 ).unwrap();
9974                 outbound_chan.accept_channel(&inbound_chan.get_accept_channel_message(), &config.channel_handshake_limits, &features).unwrap();
9975                 let tx = Transaction { version: 1, lock_time: LockTime::ZERO, input: Vec::new(), output: vec![TxOut {
9976                         value: 10000000, script_pubkey: outbound_chan.context.get_funding_redeemscript(),
9977                 }]};
9978                 let funding_outpoint = OutPoint{ txid: tx.txid(), index: 0 };
9979                 let funding_created = outbound_chan.get_funding_created(tx.clone(), funding_outpoint, false, &&logger).map_err(|_| ()).unwrap().unwrap();
9980                 let mut chan = match inbound_chan.funding_created(&funding_created, best_block, &&keys_provider, &&logger) {
9981                         Ok((chan, _, _)) => chan,
9982                         Err((_, e)) => panic!("{}", e),
9983                 };
9984
9985                 let dummy_htlc_source = HTLCSource::OutboundRoute {
9986                         path: Path {
9987                                 hops: vec![RouteHop {
9988                                         pubkey: test_utils::pubkey(2), channel_features: ChannelFeatures::empty(),
9989                                         node_features: NodeFeatures::empty(), short_channel_id: 0, fee_msat: 0,
9990                                         cltv_expiry_delta: 0, maybe_announced_channel: false,
9991                                 }],
9992                                 blinded_tail: None
9993                         },
9994                         session_priv: test_utils::privkey(42),
9995                         first_hop_htlc_msat: 0,
9996                         payment_id: PaymentId([42; 32]),
9997                 };
9998                 let dummy_outbound_output = OutboundHTLCOutput {
9999                         htlc_id: 0,
10000                         amount_msat: 0,
10001                         payment_hash: PaymentHash([43; 32]),
10002                         cltv_expiry: 0,
10003                         state: OutboundHTLCState::Committed,
10004                         source: dummy_htlc_source.clone(),
10005                         skimmed_fee_msat: None,
10006                         blinding_point: None,
10007                 };
10008                 let mut pending_outbound_htlcs = vec![dummy_outbound_output.clone(); 10];
10009                 for (idx, htlc) in pending_outbound_htlcs.iter_mut().enumerate() {
10010                         if idx % 2 == 0 {
10011                                 htlc.blinding_point = Some(test_utils::pubkey(42 + idx as u8));
10012                         }
10013                         if idx % 3 == 0 {
10014                                 htlc.skimmed_fee_msat = Some(1);
10015                         }
10016                 }
10017                 chan.context.pending_outbound_htlcs = pending_outbound_htlcs.clone();
10018
10019                 let dummy_holding_cell_add_htlc = HTLCUpdateAwaitingACK::AddHTLC {
10020                         amount_msat: 0,
10021                         cltv_expiry: 0,
10022                         payment_hash: PaymentHash([43; 32]),
10023                         source: dummy_htlc_source.clone(),
10024                         onion_routing_packet: msgs::OnionPacket {
10025                                 version: 0,
10026                                 public_key: Ok(test_utils::pubkey(1)),
10027                                 hop_data: [0; 20*65],
10028                                 hmac: [0; 32]
10029                         },
10030                         skimmed_fee_msat: None,
10031                         blinding_point: None,
10032                 };
10033                 let dummy_holding_cell_claim_htlc = HTLCUpdateAwaitingACK::ClaimHTLC {
10034                         payment_preimage: PaymentPreimage([42; 32]),
10035                         htlc_id: 0,
10036                 };
10037                 let dummy_holding_cell_failed_htlc = |htlc_id| HTLCUpdateAwaitingACK::FailHTLC {
10038                         htlc_id, err_packet: msgs::OnionErrorPacket { data: vec![42] }
10039                 };
10040                 let dummy_holding_cell_malformed_htlc = |htlc_id| HTLCUpdateAwaitingACK::FailMalformedHTLC {
10041                         htlc_id, failure_code: INVALID_ONION_BLINDING, sha256_of_onion: [0; 32],
10042                 };
10043                 let mut holding_cell_htlc_updates = Vec::with_capacity(12);
10044                 for i in 0..12 {
10045                         if i % 5 == 0 {
10046                                 holding_cell_htlc_updates.push(dummy_holding_cell_add_htlc.clone());
10047                         } else if i % 5 == 1 {
10048                                 holding_cell_htlc_updates.push(dummy_holding_cell_claim_htlc.clone());
10049                         } else if i % 5 == 2 {
10050                                 let mut dummy_add = dummy_holding_cell_add_htlc.clone();
10051                                 if let HTLCUpdateAwaitingACK::AddHTLC {
10052                                         ref mut blinding_point, ref mut skimmed_fee_msat, ..
10053                                 } = &mut dummy_add {
10054                                         *blinding_point = Some(test_utils::pubkey(42 + i));
10055                                         *skimmed_fee_msat = Some(42);
10056                                 } else { panic!() }
10057                                 holding_cell_htlc_updates.push(dummy_add);
10058                         } else if i % 5 == 3 {
10059                                 holding_cell_htlc_updates.push(dummy_holding_cell_malformed_htlc(i as u64));
10060                         } else {
10061                                 holding_cell_htlc_updates.push(dummy_holding_cell_failed_htlc(i as u64));
10062                         }
10063                 }
10064                 chan.context.holding_cell_htlc_updates = holding_cell_htlc_updates.clone();
10065
10066                 // Encode and decode the channel and ensure that the HTLCs within are the same.
10067                 let encoded_chan = chan.encode();
10068                 let mut s = crate::io::Cursor::new(&encoded_chan);
10069                 let mut reader = crate::util::ser::FixedLengthReader::new(&mut s, encoded_chan.len() as u64);
10070                 let features = channelmanager::provided_channel_type_features(&config);
10071                 let decoded_chan = Channel::read(&mut reader, (&&keys_provider, &&keys_provider, 0, &features)).unwrap();
10072                 assert_eq!(decoded_chan.context.pending_outbound_htlcs, pending_outbound_htlcs);
10073                 assert_eq!(decoded_chan.context.holding_cell_htlc_updates, holding_cell_htlc_updates);
10074         }
10075
10076         #[cfg(all(feature = "_test_vectors", not(feature = "grind_signatures")))]
10077         #[test]
10078         fn outbound_commitment_test() {
10079                 use bitcoin::sighash;
10080                 use bitcoin::consensus::encode::serialize;
10081                 use bitcoin::sighash::EcdsaSighashType;
10082                 use bitcoin::hashes::hex::FromHex;
10083                 use bitcoin::hash_types::Txid;
10084                 use bitcoin::secp256k1::Message;
10085                 use crate::sign::{ChannelDerivationParameters, HTLCDescriptor, ecdsa::EcdsaChannelSigner};
10086                 use crate::ln::PaymentPreimage;
10087                 use crate::ln::channel::{HTLCOutputInCommitment ,TxCreationKeys};
10088                 use crate::ln::channel_keys::{DelayedPaymentBasepoint, HtlcBasepoint};
10089                 use crate::ln::chan_utils::{ChannelPublicKeys, HolderCommitmentTransaction, CounterpartyChannelTransactionParameters};
10090                 use crate::util::logger::Logger;
10091                 use crate::sync::Arc;
10092                 use core::str::FromStr;
10093                 use hex::DisplayHex;
10094
10095                 // Test vectors from BOLT 3 Appendices C and F (anchors):
10096                 let feeest = TestFeeEstimator{fee_est: 15000};
10097                 let logger : Arc<dyn Logger> = Arc::new(test_utils::TestLogger::new());
10098                 let secp_ctx = Secp256k1::new();
10099
10100                 let mut signer = InMemorySigner::new(
10101                         &secp_ctx,
10102                         SecretKey::from_slice(&<Vec<u8>>::from_hex("30ff4956bbdd3222d44cc5e8a1261dab1e07957bdac5ae88fe3261ef321f3749").unwrap()[..]).unwrap(),
10103                         SecretKey::from_slice(&<Vec<u8>>::from_hex("0fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff").unwrap()[..]).unwrap(),
10104                         SecretKey::from_slice(&<Vec<u8>>::from_hex("1111111111111111111111111111111111111111111111111111111111111111").unwrap()[..]).unwrap(),
10105                         SecretKey::from_slice(&<Vec<u8>>::from_hex("3333333333333333333333333333333333333333333333333333333333333333").unwrap()[..]).unwrap(),
10106                         SecretKey::from_slice(&<Vec<u8>>::from_hex("1111111111111111111111111111111111111111111111111111111111111111").unwrap()[..]).unwrap(),
10107
10108                         // These aren't set in the test vectors:
10109                         [0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff],
10110                         10_000_000,
10111                         [0; 32],
10112                         [0; 32],
10113                 );
10114
10115                 assert_eq!(signer.pubkeys().funding_pubkey.serialize()[..],
10116                                 <Vec<u8>>::from_hex("023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb").unwrap()[..]);
10117                 let keys_provider = Keys { signer: signer.clone() };
10118
10119                 let counterparty_node_id = PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[42; 32]).unwrap());
10120                 let mut config = UserConfig::default();
10121                 config.channel_handshake_config.announced_channel = false;
10122                 let mut chan = OutboundV1Channel::<&Keys>::new(&LowerBoundedFeeEstimator::new(&feeest), &&keys_provider, &&keys_provider, counterparty_node_id, &channelmanager::provided_init_features(&config), 10_000_000, 0, 42, &config, 0, 42, None).unwrap(); // Nothing uses their network key in this test
10123                 chan.context.holder_dust_limit_satoshis = 546;
10124                 chan.context.counterparty_selected_channel_reserve_satoshis = Some(0); // Filled in in accept_channel
10125
10126                 let funding_info = OutPoint{ txid: Txid::from_str("8984484a580b825b9972d7adb15050b3ab624ccd731946b3eeddb92f4e7ef6be").unwrap(), index: 0 };
10127
10128                 let counterparty_pubkeys = ChannelPublicKeys {
10129                         funding_pubkey: public_from_secret_hex(&secp_ctx, "1552dfba4f6cf29a62a0af13c8d6981d36d0ef8d61ba10fb0fe90da7634d7e13"),
10130                         revocation_basepoint: RevocationBasepoint::from(PublicKey::from_slice(&<Vec<u8>>::from_hex("02466d7fcae563e5cb09a0d1870bb580344804617879a14949cf22285f1bae3f27").unwrap()[..]).unwrap()),
10131                         payment_point: public_from_secret_hex(&secp_ctx, "4444444444444444444444444444444444444444444444444444444444444444"),
10132                         delayed_payment_basepoint: DelayedPaymentBasepoint::from(public_from_secret_hex(&secp_ctx, "1552dfba4f6cf29a62a0af13c8d6981d36d0ef8d61ba10fb0fe90da7634d7e13")),
10133                         htlc_basepoint: HtlcBasepoint::from(public_from_secret_hex(&secp_ctx, "4444444444444444444444444444444444444444444444444444444444444444"))
10134                 };
10135                 chan.context.channel_transaction_parameters.counterparty_parameters = Some(
10136                         CounterpartyChannelTransactionParameters {
10137                                 pubkeys: counterparty_pubkeys.clone(),
10138                                 selected_contest_delay: 144
10139                         });
10140                 chan.context.channel_transaction_parameters.funding_outpoint = Some(funding_info);
10141                 signer.provide_channel_parameters(&chan.context.channel_transaction_parameters);
10142
10143                 assert_eq!(counterparty_pubkeys.payment_point.serialize()[..],
10144                            <Vec<u8>>::from_hex("032c0b7cf95324a07d05398b240174dc0c2be444d96b159aa6c7f7b1e668680991").unwrap()[..]);
10145
10146                 assert_eq!(counterparty_pubkeys.funding_pubkey.serialize()[..],
10147                            <Vec<u8>>::from_hex("030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c1").unwrap()[..]);
10148
10149                 assert_eq!(counterparty_pubkeys.htlc_basepoint.to_public_key().serialize()[..],
10150                            <Vec<u8>>::from_hex("032c0b7cf95324a07d05398b240174dc0c2be444d96b159aa6c7f7b1e668680991").unwrap()[..]);
10151
10152                 // We can't just use build_holder_transaction_keys here as the per_commitment_secret is not
10153                 // derived from a commitment_seed, so instead we copy it here and call
10154                 // build_commitment_transaction.
10155                 let delayed_payment_base = &chan.context.holder_signer.as_ref().pubkeys().delayed_payment_basepoint;
10156                 let per_commitment_secret = SecretKey::from_slice(&<Vec<u8>>::from_hex("1f1e1d1c1b1a191817161514131211100f0e0d0c0b0a09080706050403020100").unwrap()[..]).unwrap();
10157                 let per_commitment_point = PublicKey::from_secret_key(&secp_ctx, &per_commitment_secret);
10158                 let htlc_basepoint = &chan.context.holder_signer.as_ref().pubkeys().htlc_basepoint;
10159                 let keys = TxCreationKeys::derive_new(&secp_ctx, &per_commitment_point, delayed_payment_base, htlc_basepoint, &counterparty_pubkeys.revocation_basepoint, &counterparty_pubkeys.htlc_basepoint);
10160
10161                 macro_rules! test_commitment {
10162                         ( $counterparty_sig_hex: expr, $sig_hex: expr, $tx_hex: expr, $($remain:tt)* ) => {
10163                                 chan.context.channel_transaction_parameters.channel_type_features = ChannelTypeFeatures::only_static_remote_key();
10164                                 test_commitment_common!($counterparty_sig_hex, $sig_hex, $tx_hex, &ChannelTypeFeatures::only_static_remote_key(), $($remain)*);
10165                         };
10166                 }
10167
10168                 macro_rules! test_commitment_with_anchors {
10169                         ( $counterparty_sig_hex: expr, $sig_hex: expr, $tx_hex: expr, $($remain:tt)* ) => {
10170                                 chan.context.channel_transaction_parameters.channel_type_features = ChannelTypeFeatures::anchors_zero_htlc_fee_and_dependencies();
10171                                 test_commitment_common!($counterparty_sig_hex, $sig_hex, $tx_hex, &ChannelTypeFeatures::anchors_zero_htlc_fee_and_dependencies(), $($remain)*);
10172                         };
10173                 }
10174
10175                 macro_rules! test_commitment_common {
10176                         ( $counterparty_sig_hex: expr, $sig_hex: expr, $tx_hex: expr, $opt_anchors: expr, {
10177                                 $( { $htlc_idx: expr, $counterparty_htlc_sig_hex: expr, $htlc_sig_hex: expr, $htlc_tx_hex: expr } ), *
10178                         } ) => { {
10179                                 let (commitment_tx, htlcs): (_, Vec<HTLCOutputInCommitment>) = {
10180                                         let mut commitment_stats = chan.context.build_commitment_transaction(0xffffffffffff - 42, &keys, true, false, &logger);
10181
10182                                         let htlcs = commitment_stats.htlcs_included.drain(..)
10183                                                 .filter_map(|(htlc, _)| if htlc.transaction_output_index.is_some() { Some(htlc) } else { None })
10184                                                 .collect();
10185                                         (commitment_stats.tx, htlcs)
10186                                 };
10187                                 let trusted_tx = commitment_tx.trust();
10188                                 let unsigned_tx = trusted_tx.built_transaction();
10189                                 let redeemscript = chan.context.get_funding_redeemscript();
10190                                 let counterparty_signature = Signature::from_der(&<Vec<u8>>::from_hex($counterparty_sig_hex).unwrap()[..]).unwrap();
10191                                 let sighash = unsigned_tx.get_sighash_all(&redeemscript, chan.context.channel_value_satoshis);
10192                                 log_trace!(logger, "unsigned_tx = {}", serialize(&unsigned_tx.transaction).as_hex());
10193                                 assert!(secp_ctx.verify_ecdsa(&sighash, &counterparty_signature, chan.context.counterparty_funding_pubkey()).is_ok(), "verify counterparty commitment sig");
10194
10195                                 let mut per_htlc: Vec<(HTLCOutputInCommitment, Option<Signature>)> = Vec::new();
10196                                 per_htlc.clear(); // Don't warn about excess mut for no-HTLC calls
10197                                 let mut counterparty_htlc_sigs = Vec::new();
10198                                 counterparty_htlc_sigs.clear(); // Don't warn about excess mut for no-HTLC calls
10199                                 $({
10200                                         let remote_signature = Signature::from_der(&<Vec<u8>>::from_hex($counterparty_htlc_sig_hex).unwrap()[..]).unwrap();
10201                                         per_htlc.push((htlcs[$htlc_idx].clone(), Some(remote_signature)));
10202                                         counterparty_htlc_sigs.push(remote_signature);
10203                                 })*
10204                                 assert_eq!(htlcs.len(), per_htlc.len());
10205
10206                                 let holder_commitment_tx = HolderCommitmentTransaction::new(
10207                                         commitment_tx.clone(),
10208                                         counterparty_signature,
10209                                         counterparty_htlc_sigs,
10210                                         &chan.context.holder_signer.as_ref().pubkeys().funding_pubkey,
10211                                         chan.context.counterparty_funding_pubkey()
10212                                 );
10213                                 let holder_sig = signer.sign_holder_commitment(&holder_commitment_tx, &secp_ctx).unwrap();
10214                                 assert_eq!(Signature::from_der(&<Vec<u8>>::from_hex($sig_hex).unwrap()[..]).unwrap(), holder_sig, "holder_sig");
10215
10216                                 let funding_redeemscript = chan.context.get_funding_redeemscript();
10217                                 let tx = holder_commitment_tx.add_holder_sig(&funding_redeemscript, holder_sig);
10218                                 assert_eq!(serialize(&tx)[..], <Vec<u8>>::from_hex($tx_hex).unwrap()[..], "tx");
10219
10220                                 // ((htlc, counterparty_sig), (index, holder_sig))
10221                                 let mut htlc_counterparty_sig_iter = holder_commitment_tx.counterparty_htlc_sigs.iter();
10222
10223                                 $({
10224                                         log_trace!(logger, "verifying htlc {}", $htlc_idx);
10225                                         let remote_signature = Signature::from_der(&<Vec<u8>>::from_hex($counterparty_htlc_sig_hex).unwrap()[..]).unwrap();
10226
10227                                         let ref htlc = htlcs[$htlc_idx];
10228                                         let mut htlc_tx = chan_utils::build_htlc_transaction(&unsigned_tx.txid, chan.context.feerate_per_kw,
10229                                                 chan.context.get_counterparty_selected_contest_delay().unwrap(),
10230                                                 &htlc, $opt_anchors, &keys.broadcaster_delayed_payment_key, &keys.revocation_key);
10231                                         let htlc_redeemscript = chan_utils::get_htlc_redeemscript(&htlc, $opt_anchors, &keys);
10232                                         let htlc_sighashtype = if $opt_anchors.supports_anchors_zero_fee_htlc_tx() { EcdsaSighashType::SinglePlusAnyoneCanPay } else { EcdsaSighashType::All };
10233                                         let htlc_sighash = Message::from_slice(&sighash::SighashCache::new(&htlc_tx).segwit_signature_hash(0, &htlc_redeemscript, htlc.amount_msat / 1000, htlc_sighashtype).unwrap()[..]).unwrap();
10234                                         assert!(secp_ctx.verify_ecdsa(&htlc_sighash, &remote_signature, &keys.countersignatory_htlc_key.to_public_key()).is_ok(), "verify counterparty htlc sig");
10235
10236                                         let mut preimage: Option<PaymentPreimage> = None;
10237                                         if !htlc.offered {
10238                                                 for i in 0..5 {
10239                                                         let out = PaymentHash(Sha256::hash(&[i; 32]).to_byte_array());
10240                                                         if out == htlc.payment_hash {
10241                                                                 preimage = Some(PaymentPreimage([i; 32]));
10242                                                         }
10243                                                 }
10244
10245                                                 assert!(preimage.is_some());
10246                                         }
10247
10248                                         let htlc_counterparty_sig = htlc_counterparty_sig_iter.next().unwrap();
10249                                         let htlc_holder_sig = signer.sign_holder_htlc_transaction(&htlc_tx, 0, &HTLCDescriptor {
10250                                                 channel_derivation_parameters: ChannelDerivationParameters {
10251                                                         value_satoshis: chan.context.channel_value_satoshis,
10252                                                         keys_id: chan.context.channel_keys_id,
10253                                                         transaction_parameters: chan.context.channel_transaction_parameters.clone(),
10254                                                 },
10255                                                 commitment_txid: trusted_tx.txid(),
10256                                                 per_commitment_number: trusted_tx.commitment_number(),
10257                                                 per_commitment_point: trusted_tx.per_commitment_point(),
10258                                                 feerate_per_kw: trusted_tx.feerate_per_kw(),
10259                                                 htlc: htlc.clone(),
10260                                                 preimage: preimage.clone(),
10261                                                 counterparty_sig: *htlc_counterparty_sig,
10262                                         }, &secp_ctx).unwrap();
10263                                         let num_anchors = if $opt_anchors.supports_anchors_zero_fee_htlc_tx() { 2 } else { 0 };
10264                                         assert_eq!(htlc.transaction_output_index, Some($htlc_idx + num_anchors), "output index");
10265
10266                                         let signature = Signature::from_der(&<Vec<u8>>::from_hex($htlc_sig_hex).unwrap()[..]).unwrap();
10267                                         assert_eq!(signature, htlc_holder_sig, "htlc sig");
10268                                         let trusted_tx = holder_commitment_tx.trust();
10269                                         htlc_tx.input[0].witness = trusted_tx.build_htlc_input_witness($htlc_idx, htlc_counterparty_sig, &htlc_holder_sig, &preimage);
10270                                         log_trace!(logger, "htlc_tx = {}", serialize(&htlc_tx).as_hex());
10271                                         assert_eq!(serialize(&htlc_tx)[..], <Vec<u8>>::from_hex($htlc_tx_hex).unwrap()[..], "htlc tx");
10272                                 })*
10273                                 assert!(htlc_counterparty_sig_iter.next().is_none());
10274                         } }
10275                 }
10276
10277                 // anchors: simple commitment tx with no HTLCs and single anchor
10278                 test_commitment_with_anchors!("30440220655bf909fb6fa81d086f1336ac72c97906dce29d1b166e305c99152d810e26e1022051f577faa46412c46707aaac46b65d50053550a66334e00a44af2706f27a8658",
10279                                                  "3044022007cf6b405e9c9b4f527b0ecad9d8bb661fabb8b12abf7d1c0b3ad1855db3ed490220616d5c1eeadccc63bd775a131149455d62d95a42c2a1b01cc7821fc42dce7778",
10280                                                  "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b80024a010000000000002200202b1b5854183c12d3316565972c4668929d314d81c5dcdbb21cb45fe8a9a8114f10529800000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0400473044022007cf6b405e9c9b4f527b0ecad9d8bb661fabb8b12abf7d1c0b3ad1855db3ed490220616d5c1eeadccc63bd775a131149455d62d95a42c2a1b01cc7821fc42dce7778014730440220655bf909fb6fa81d086f1336ac72c97906dce29d1b166e305c99152d810e26e1022051f577faa46412c46707aaac46b65d50053550a66334e00a44af2706f27a865801475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {});
10281
10282                 // simple commitment tx with no HTLCs
10283                 chan.context.value_to_self_msat = 7000000000;
10284
10285                 test_commitment!("3045022100c3127b33dcc741dd6b05b1e63cbd1a9a7d816f37af9b6756fa2376b056f032370220408b96279808fe57eb7e463710804cdf4f108388bc5cf722d8c848d2c7f9f3b0",
10286                                                  "30440220616210b2cc4d3afb601013c373bbd8aac54febd9f15400379a8cb65ce7deca60022034236c010991beb7ff770510561ae8dc885b8d38d1947248c38f2ae055647142",
10287                                                  "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8002c0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e48454a56a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e04004730440220616210b2cc4d3afb601013c373bbd8aac54febd9f15400379a8cb65ce7deca60022034236c010991beb7ff770510561ae8dc885b8d38d1947248c38f2ae05564714201483045022100c3127b33dcc741dd6b05b1e63cbd1a9a7d816f37af9b6756fa2376b056f032370220408b96279808fe57eb7e463710804cdf4f108388bc5cf722d8c848d2c7f9f3b001475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {});
10288
10289                 // anchors: simple commitment tx with no HTLCs
10290                 test_commitment_with_anchors!("3045022100f89034eba16b2be0e5581f750a0a6309192b75cce0f202f0ee2b4ec0cc394850022076c65dc507fe42276152b7a3d90e961e678adbe966e916ecfe85e64d430e75f3",
10291                                                  "30450221008266ac6db5ea71aac3c95d97b0e172ff596844851a3216eb88382a8dddfd33d2022050e240974cfd5d708708b4365574517c18e7ae535ef732a3484d43d0d82be9f7",
10292                                                  "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b80044a010000000000002200202b1b5854183c12d3316565972c4668929d314d81c5dcdbb21cb45fe8a9a8114f4a01000000000000220020e9e86e4823faa62e222ebc858a226636856158f07e69898da3b0d1af0ddb3994c0c62d0000000000220020f3394e1e619b0eca1f91be2fb5ab4dfc59ba5b84ebe014ad1d43a564d012994a508b6a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e04004830450221008266ac6db5ea71aac3c95d97b0e172ff596844851a3216eb88382a8dddfd33d2022050e240974cfd5d708708b4365574517c18e7ae535ef732a3484d43d0d82be9f701483045022100f89034eba16b2be0e5581f750a0a6309192b75cce0f202f0ee2b4ec0cc394850022076c65dc507fe42276152b7a3d90e961e678adbe966e916ecfe85e64d430e75f301475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {});
10293
10294                 chan.context.pending_inbound_htlcs.push({
10295                         let mut out = InboundHTLCOutput{
10296                                 htlc_id: 0,
10297                                 amount_msat: 1000000,
10298                                 cltv_expiry: 500,
10299                                 payment_hash: PaymentHash([0; 32]),
10300                                 state: InboundHTLCState::Committed,
10301                         };
10302                         out.payment_hash.0 = Sha256::hash(&<Vec<u8>>::from_hex("0000000000000000000000000000000000000000000000000000000000000000").unwrap()).to_byte_array();
10303                         out
10304                 });
10305                 chan.context.pending_inbound_htlcs.push({
10306                         let mut out = InboundHTLCOutput{
10307                                 htlc_id: 1,
10308                                 amount_msat: 2000000,
10309                                 cltv_expiry: 501,
10310                                 payment_hash: PaymentHash([0; 32]),
10311                                 state: InboundHTLCState::Committed,
10312                         };
10313                         out.payment_hash.0 = Sha256::hash(&<Vec<u8>>::from_hex("0101010101010101010101010101010101010101010101010101010101010101").unwrap()).to_byte_array();
10314                         out
10315                 });
10316                 chan.context.pending_outbound_htlcs.push({
10317                         let mut out = OutboundHTLCOutput{
10318                                 htlc_id: 2,
10319                                 amount_msat: 2000000,
10320                                 cltv_expiry: 502,
10321                                 payment_hash: PaymentHash([0; 32]),
10322                                 state: OutboundHTLCState::Committed,
10323                                 source: HTLCSource::dummy(),
10324                                 skimmed_fee_msat: None,
10325                                 blinding_point: None,
10326                         };
10327                         out.payment_hash.0 = Sha256::hash(&<Vec<u8>>::from_hex("0202020202020202020202020202020202020202020202020202020202020202").unwrap()).to_byte_array();
10328                         out
10329                 });
10330                 chan.context.pending_outbound_htlcs.push({
10331                         let mut out = OutboundHTLCOutput{
10332                                 htlc_id: 3,
10333                                 amount_msat: 3000000,
10334                                 cltv_expiry: 503,
10335                                 payment_hash: PaymentHash([0; 32]),
10336                                 state: OutboundHTLCState::Committed,
10337                                 source: HTLCSource::dummy(),
10338                                 skimmed_fee_msat: None,
10339                                 blinding_point: None,
10340                         };
10341                         out.payment_hash.0 = Sha256::hash(&<Vec<u8>>::from_hex("0303030303030303030303030303030303030303030303030303030303030303").unwrap()).to_byte_array();
10342                         out
10343                 });
10344                 chan.context.pending_inbound_htlcs.push({
10345                         let mut out = InboundHTLCOutput{
10346                                 htlc_id: 4,
10347                                 amount_msat: 4000000,
10348                                 cltv_expiry: 504,
10349                                 payment_hash: PaymentHash([0; 32]),
10350                                 state: InboundHTLCState::Committed,
10351                         };
10352                         out.payment_hash.0 = Sha256::hash(&<Vec<u8>>::from_hex("0404040404040404040404040404040404040404040404040404040404040404").unwrap()).to_byte_array();
10353                         out
10354                 });
10355
10356                 // commitment tx with all five HTLCs untrimmed (minimum feerate)
10357                 chan.context.value_to_self_msat = 6993000000; // 7000000000 - 7000000
10358                 chan.context.feerate_per_kw = 0;
10359
10360                 test_commitment!("3044022009b048187705a8cbc9ad73adbe5af148c3d012e1f067961486c822c7af08158c022006d66f3704cfab3eb2dc49dae24e4aa22a6910fc9b424007583204e3621af2e5",
10361                                  "304402206fc2d1f10ea59951eefac0b4b7c396a3c3d87b71ff0b019796ef4535beaf36f902201765b0181e514d04f4c8ad75659d7037be26cdb3f8bb6f78fe61decef484c3ea",
10362                                  "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8007e80300000000000022002052bfef0479d7b293c27e0f1eb294bea154c63a3294ef092c19af51409bce0e2ad007000000000000220020403d394747cae42e98ff01734ad5c08f82ba123d3d9a620abda88989651e2ab5d007000000000000220020748eba944fedc8827f6b06bc44678f93c0f9e6078b35c6331ed31e75f8ce0c2db80b000000000000220020c20b5d1f8584fd90443e7b7b720136174fa4b9333c261d04dbbd012635c0f419a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e484e0a06a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e040047304402206fc2d1f10ea59951eefac0b4b7c396a3c3d87b71ff0b019796ef4535beaf36f902201765b0181e514d04f4c8ad75659d7037be26cdb3f8bb6f78fe61decef484c3ea01473044022009b048187705a8cbc9ad73adbe5af148c3d012e1f067961486c822c7af08158c022006d66f3704cfab3eb2dc49dae24e4aa22a6910fc9b424007583204e3621af2e501475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {
10363
10364                                   { 0,
10365                                   "3045022100d9e29616b8f3959f1d3d7f7ce893ffedcdc407717d0de8e37d808c91d3a7c50d022078c3033f6d00095c8720a4bc943c1b45727818c082e4e3ddbc6d3116435b624b",
10366                                   "30440220636de5682ef0c5b61f124ec74e8aa2461a69777521d6998295dcea36bc3338110220165285594b23c50b28b82df200234566628a27bcd17f7f14404bd865354eb3ce",
10367                                   "02000000000101ab84ff284f162cfbfef241f853b47d4368d171f9e2a1445160cd591c4c7d882b00000000000000000001e8030000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100d9e29616b8f3959f1d3d7f7ce893ffedcdc407717d0de8e37d808c91d3a7c50d022078c3033f6d00095c8720a4bc943c1b45727818c082e4e3ddbc6d3116435b624b014730440220636de5682ef0c5b61f124ec74e8aa2461a69777521d6998295dcea36bc3338110220165285594b23c50b28b82df200234566628a27bcd17f7f14404bd865354eb3ce012000000000000000000000000000000000000000000000000000000000000000008a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a914b8bcb07f6344b42ab04250c86a6e8b75d3fdbbc688527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f401b175ac686800000000" },
10368
10369                                   { 1,
10370                                   "30440220649fe8b20e67e46cbb0d09b4acea87dbec001b39b08dee7bdd0b1f03922a8640022037c462dff79df501cecfdb12ea7f4de91f99230bb544726f6e04527b1f896004",
10371                                   "3045022100803159dee7935dba4a1d36a61055ce8fd62caa528573cc221ae288515405a252022029c59e7cffce374fe860100a4a63787e105c3cf5156d40b12dd53ff55ac8cf3f",
10372                                   "02000000000101ab84ff284f162cfbfef241f853b47d4368d171f9e2a1445160cd591c4c7d882b01000000000000000001d0070000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e05004730440220649fe8b20e67e46cbb0d09b4acea87dbec001b39b08dee7bdd0b1f03922a8640022037c462dff79df501cecfdb12ea7f4de91f99230bb544726f6e04527b1f89600401483045022100803159dee7935dba4a1d36a61055ce8fd62caa528573cc221ae288515405a252022029c59e7cffce374fe860100a4a63787e105c3cf5156d40b12dd53ff55ac8cf3f01008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a914b43e1b38138a41b37f7cd9a1d274bc63e3a9b5d188ac6868f6010000" },
10373
10374                                   { 2,
10375                                   "30440220770fc321e97a19f38985f2e7732dd9fe08d16a2efa4bcbc0429400a447faf49102204d40b417f3113e1b0944ae0986f517564ab4acd3d190503faf97a6e420d43352",
10376                                   "3045022100a437cc2ce77400ecde441b3398fea3c3ad8bdad8132be818227fe3c5b8345989022069d45e7fa0ae551ec37240845e2c561ceb2567eacf3076a6a43a502d05865faa",
10377                                   "02000000000101ab84ff284f162cfbfef241f853b47d4368d171f9e2a1445160cd591c4c7d882b02000000000000000001d0070000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e05004730440220770fc321e97a19f38985f2e7732dd9fe08d16a2efa4bcbc0429400a447faf49102204d40b417f3113e1b0944ae0986f517564ab4acd3d190503faf97a6e420d4335201483045022100a437cc2ce77400ecde441b3398fea3c3ad8bdad8132be818227fe3c5b8345989022069d45e7fa0ae551ec37240845e2c561ceb2567eacf3076a6a43a502d05865faa012001010101010101010101010101010101010101010101010101010101010101018a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a9144b6b2e5444c2639cc0fb7bcea5afba3f3cdce23988527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f501b175ac686800000000" },
10378
10379                                   { 3,
10380                                   "304402207bcbf4f60a9829b05d2dbab84ed593e0291836be715dc7db6b72a64caf646af802201e489a5a84f7c5cc130398b841d138d031a5137ac8f4c49c770a4959dc3c1363",
10381                                   "304402203121d9b9c055f354304b016a36662ee99e1110d9501cb271b087ddb6f382c2c80220549882f3f3b78d9c492de47543cb9a697cecc493174726146536c5954dac7487",
10382                                   "02000000000101ab84ff284f162cfbfef241f853b47d4368d171f9e2a1445160cd591c4c7d882b03000000000000000001b80b0000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e050047304402207bcbf4f60a9829b05d2dbab84ed593e0291836be715dc7db6b72a64caf646af802201e489a5a84f7c5cc130398b841d138d031a5137ac8f4c49c770a4959dc3c13630147304402203121d9b9c055f354304b016a36662ee99e1110d9501cb271b087ddb6f382c2c80220549882f3f3b78d9c492de47543cb9a697cecc493174726146536c5954dac748701008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9148a486ff2e31d6158bf39e2608864d63fefd09d5b88ac6868f7010000" },
10383
10384                                   { 4,
10385                                   "3044022076dca5cb81ba7e466e349b7128cdba216d4d01659e29b96025b9524aaf0d1899022060de85697b88b21c749702b7d2cfa7dfeaa1f472c8f1d7d9c23f2bf968464b87",
10386                                   "3045022100d9080f103cc92bac15ec42464a95f070c7fb6925014e673ee2ea1374d36a7f7502200c65294d22eb20d48564954d5afe04a385551919d8b2ddb4ae2459daaeee1d95",
10387                                   "02000000000101ab84ff284f162cfbfef241f853b47d4368d171f9e2a1445160cd591c4c7d882b04000000000000000001a00f0000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500473044022076dca5cb81ba7e466e349b7128cdba216d4d01659e29b96025b9524aaf0d1899022060de85697b88b21c749702b7d2cfa7dfeaa1f472c8f1d7d9c23f2bf968464b8701483045022100d9080f103cc92bac15ec42464a95f070c7fb6925014e673ee2ea1374d36a7f7502200c65294d22eb20d48564954d5afe04a385551919d8b2ddb4ae2459daaeee1d95012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000" }
10388                 } );
10389
10390                 // commitment tx with seven outputs untrimmed (maximum feerate)
10391                 chan.context.value_to_self_msat = 6993000000; // 7000000000 - 7000000
10392                 chan.context.feerate_per_kw = 647;
10393
10394                 test_commitment!("3045022100a135f9e8a5ed25f7277446c67956b00ce6f610ead2bdec2c2f686155b7814772022059f1f6e1a8b336a68efcc1af3fe4d422d4827332b5b067501b099c47b7b5b5ee",
10395                                  "30450221009ec15c687898bb4da8b3a833e5ab8bfc51ec6e9202aaa8e66611edfd4a85ed1102203d7183e45078b9735c93450bc3415d3e5a8c576141a711ec6ddcb4a893926bb7",
10396                                  "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8007e80300000000000022002052bfef0479d7b293c27e0f1eb294bea154c63a3294ef092c19af51409bce0e2ad007000000000000220020403d394747cae42e98ff01734ad5c08f82ba123d3d9a620abda88989651e2ab5d007000000000000220020748eba944fedc8827f6b06bc44678f93c0f9e6078b35c6331ed31e75f8ce0c2db80b000000000000220020c20b5d1f8584fd90443e7b7b720136174fa4b9333c261d04dbbd012635c0f419a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e484e09c6a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e04004830450221009ec15c687898bb4da8b3a833e5ab8bfc51ec6e9202aaa8e66611edfd4a85ed1102203d7183e45078b9735c93450bc3415d3e5a8c576141a711ec6ddcb4a893926bb701483045022100a135f9e8a5ed25f7277446c67956b00ce6f610ead2bdec2c2f686155b7814772022059f1f6e1a8b336a68efcc1af3fe4d422d4827332b5b067501b099c47b7b5b5ee01475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {
10397
10398                                   { 0,
10399                                   "30450221008437627f9ad84ac67052e2a414a4367b8556fd1f94d8b02590f89f50525cd33502205b9c21ff6e7fc864f2352746ad8ba59182510819acb644e25b8a12fc37bbf24f",
10400                                   "30440220344b0deb055230d01703e6c7acd45853c4af2328b49b5d8af4f88a060733406602202ea64f2a43d5751edfe75503cbc35a62e3141b5ed032fa03360faf4ca66f670b",
10401                                   "020000000001012cfb3e4788c206881d38f2996b6cb2109b5935acb527d14bdaa7b908afa9b2fe0000000000000000000122020000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e05004830450221008437627f9ad84ac67052e2a414a4367b8556fd1f94d8b02590f89f50525cd33502205b9c21ff6e7fc864f2352746ad8ba59182510819acb644e25b8a12fc37bbf24f014730440220344b0deb055230d01703e6c7acd45853c4af2328b49b5d8af4f88a060733406602202ea64f2a43d5751edfe75503cbc35a62e3141b5ed032fa03360faf4ca66f670b012000000000000000000000000000000000000000000000000000000000000000008a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a914b8bcb07f6344b42ab04250c86a6e8b75d3fdbbc688527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f401b175ac686800000000" },
10402
10403                                   { 1,
10404                                   "304402205a67f92bf6845cf2892b48d874ac1daf88a36495cf8a06f93d83180d930a6f75022031da1621d95c3f335cc06a3056cf960199dae600b7cf89088f65fc53cdbef28c",
10405                                   "30450221009e5e3822b0185c6799a95288c597b671d6cc69ab80f43740f00c6c3d0752bdda02206da947a74bd98f3175324dc56fdba86cc783703a120a6f0297537e60632f4c7f",
10406                                   "020000000001012cfb3e4788c206881d38f2996b6cb2109b5935acb527d14bdaa7b908afa9b2fe0100000000000000000124060000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e050047304402205a67f92bf6845cf2892b48d874ac1daf88a36495cf8a06f93d83180d930a6f75022031da1621d95c3f335cc06a3056cf960199dae600b7cf89088f65fc53cdbef28c014830450221009e5e3822b0185c6799a95288c597b671d6cc69ab80f43740f00c6c3d0752bdda02206da947a74bd98f3175324dc56fdba86cc783703a120a6f0297537e60632f4c7f01008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a914b43e1b38138a41b37f7cd9a1d274bc63e3a9b5d188ac6868f6010000" },
10407
10408                                   { 2,
10409                                   "30440220437e21766054a3eef7f65690c5bcfa9920babbc5af92b819f772f6ea96df6c7402207173622024bd97328cfb26c6665e25c2f5d67c319443ccdc60c903217005d8c8",
10410                                   "3045022100fcfc47e36b712624677626cef3dc1d67f6583bd46926a6398fe6b00b0c9a37760220525788257b187fc775c6370d04eadf34d06f3650a63f8df851cee0ecb47a1673",
10411                                   "020000000001012cfb3e4788c206881d38f2996b6cb2109b5935acb527d14bdaa7b908afa9b2fe020000000000000000010a060000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e05004730440220437e21766054a3eef7f65690c5bcfa9920babbc5af92b819f772f6ea96df6c7402207173622024bd97328cfb26c6665e25c2f5d67c319443ccdc60c903217005d8c801483045022100fcfc47e36b712624677626cef3dc1d67f6583bd46926a6398fe6b00b0c9a37760220525788257b187fc775c6370d04eadf34d06f3650a63f8df851cee0ecb47a1673012001010101010101010101010101010101010101010101010101010101010101018a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a9144b6b2e5444c2639cc0fb7bcea5afba3f3cdce23988527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f501b175ac686800000000" },
10412
10413                                   { 3,
10414                                   "304402207436e10737e4df499fc051686d3e11a5bb2310e4d1f1e691d287cef66514791202207cb58e71a6b7a42dd001b7e3ae672ea4f71ea3e1cd412b742e9124abb0739c64",
10415                                   "3045022100e78211b8409afb7255ffe37337da87f38646f1faebbdd61bc1920d69e3ead67a02201a626305adfcd16bfb7e9340928d9b6305464eab4aa4c4a3af6646e9b9f69dee",
10416                                   "020000000001012cfb3e4788c206881d38f2996b6cb2109b5935acb527d14bdaa7b908afa9b2fe030000000000000000010c0a0000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e050047304402207436e10737e4df499fc051686d3e11a5bb2310e4d1f1e691d287cef66514791202207cb58e71a6b7a42dd001b7e3ae672ea4f71ea3e1cd412b742e9124abb0739c6401483045022100e78211b8409afb7255ffe37337da87f38646f1faebbdd61bc1920d69e3ead67a02201a626305adfcd16bfb7e9340928d9b6305464eab4aa4c4a3af6646e9b9f69dee01008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9148a486ff2e31d6158bf39e2608864d63fefd09d5b88ac6868f7010000" },
10417
10418                                   { 4,
10419                                   "30450221009acd6a827a76bfee50806178dfe0495cd4e1d9c58279c194c7b01520fe68cb8d022024d439047c368883e570997a7d40f0b430cb5a742f507965e7d3063ae3feccca",
10420                                   "3044022048762cf546bbfe474f1536365ea7c416e3c0389d60558bc9412cb148fb6ab68202207215d7083b75c96ff9d2b08c59c34e287b66820f530b486a9aa4cdd9c347d5b9",
10421                                   "020000000001012cfb3e4788c206881d38f2996b6cb2109b5935acb527d14bdaa7b908afa9b2fe04000000000000000001da0d0000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e05004830450221009acd6a827a76bfee50806178dfe0495cd4e1d9c58279c194c7b01520fe68cb8d022024d439047c368883e570997a7d40f0b430cb5a742f507965e7d3063ae3feccca01473044022048762cf546bbfe474f1536365ea7c416e3c0389d60558bc9412cb148fb6ab68202207215d7083b75c96ff9d2b08c59c34e287b66820f530b486a9aa4cdd9c347d5b9012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000" }
10422                 } );
10423
10424                 // commitment tx with six outputs untrimmed (minimum feerate)
10425                 chan.context.value_to_self_msat = 6993000000; // 7000000000 - 7000000
10426                 chan.context.feerate_per_kw = 648;
10427
10428                 test_commitment!("304402203948f900a5506b8de36a4d8502f94f21dd84fd9c2314ab427d52feaa7a0a19f2022059b6a37a4adaa2c5419dc8aea63c6e2a2ec4c4bde46207f6dc1fcd22152fc6e5",
10429                                  "3045022100b15f72908ba3382a34ca5b32519240a22300cc6015b6f9418635fb41f3d01d8802207adb331b9ed1575383dca0f2355e86c173802feecf8298fbea53b9d4610583e9",
10430                                  "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8006d007000000000000220020403d394747cae42e98ff01734ad5c08f82ba123d3d9a620abda88989651e2ab5d007000000000000220020748eba944fedc8827f6b06bc44678f93c0f9e6078b35c6331ed31e75f8ce0c2db80b000000000000220020c20b5d1f8584fd90443e7b7b720136174fa4b9333c261d04dbbd012635c0f419a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e4844e9d6a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0400483045022100b15f72908ba3382a34ca5b32519240a22300cc6015b6f9418635fb41f3d01d8802207adb331b9ed1575383dca0f2355e86c173802feecf8298fbea53b9d4610583e90147304402203948f900a5506b8de36a4d8502f94f21dd84fd9c2314ab427d52feaa7a0a19f2022059b6a37a4adaa2c5419dc8aea63c6e2a2ec4c4bde46207f6dc1fcd22152fc6e501475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {
10431
10432                                   { 0,
10433                                   "3045022100a031202f3be94678f0e998622ee95ebb6ada8da1e9a5110228b5e04a747351e4022010ca6a21e18314ed53cfaae3b1f51998552a61a468e596368829a50ce40110e0",
10434                                   "304502210097e1873b57267730154595187a34949d3744f52933070c74757005e61ce2112e02204ecfba2aa42d4f14bdf8bad4206bb97217b702e6c433e0e1b0ce6587e6d46ec6",
10435                                   "020000000001010f44041fdfba175987cf4e6135ba2a154e3b7fb96483dc0ed5efc0678e5b6bf10000000000000000000123060000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100a031202f3be94678f0e998622ee95ebb6ada8da1e9a5110228b5e04a747351e4022010ca6a21e18314ed53cfaae3b1f51998552a61a468e596368829a50ce40110e00148304502210097e1873b57267730154595187a34949d3744f52933070c74757005e61ce2112e02204ecfba2aa42d4f14bdf8bad4206bb97217b702e6c433e0e1b0ce6587e6d46ec601008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a914b43e1b38138a41b37f7cd9a1d274bc63e3a9b5d188ac6868f6010000" },
10436
10437                                   { 1,
10438                                   "304402202361012a634aee7835c5ecdd6413dcffa8f404b7e77364c792cff984e4ee71e90220715c5e90baa08daa45a7439b1ee4fa4843ed77b19c058240b69406606d384124",
10439                                   "3044022019de73b00f1d818fb388e83b2c8c31f6bce35ac624e215bc12f88f9dc33edf48022006ff814bb9f700ee6abc3294e146fac3efd4f13f0005236b41c0a946ee00c9ae",
10440                                   "020000000001010f44041fdfba175987cf4e6135ba2a154e3b7fb96483dc0ed5efc0678e5b6bf10100000000000000000109060000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e050047304402202361012a634aee7835c5ecdd6413dcffa8f404b7e77364c792cff984e4ee71e90220715c5e90baa08daa45a7439b1ee4fa4843ed77b19c058240b69406606d38412401473044022019de73b00f1d818fb388e83b2c8c31f6bce35ac624e215bc12f88f9dc33edf48022006ff814bb9f700ee6abc3294e146fac3efd4f13f0005236b41c0a946ee00c9ae012001010101010101010101010101010101010101010101010101010101010101018a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a9144b6b2e5444c2639cc0fb7bcea5afba3f3cdce23988527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f501b175ac686800000000" },
10441
10442                                   { 2,
10443                                   "304402207e8e82cd71ed4febeb593732c260456836e97d81896153ecd2b3cf320ca6861702202dd4a30f68f98ced7cc56a36369ac1fdd978248c5ff4ed204fc00cc625532989",
10444                                   "3045022100bd0be6100c4fd8f102ec220e1b053e4c4e2ecca25615490150007b40d314dc3902201a1e0ea266965b43164d9e6576f58fa6726d42883dd1c3996d2925c2e2260796",
10445                                   "020000000001010f44041fdfba175987cf4e6135ba2a154e3b7fb96483dc0ed5efc0678e5b6bf1020000000000000000010b0a0000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e050047304402207e8e82cd71ed4febeb593732c260456836e97d81896153ecd2b3cf320ca6861702202dd4a30f68f98ced7cc56a36369ac1fdd978248c5ff4ed204fc00cc62553298901483045022100bd0be6100c4fd8f102ec220e1b053e4c4e2ecca25615490150007b40d314dc3902201a1e0ea266965b43164d9e6576f58fa6726d42883dd1c3996d2925c2e226079601008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9148a486ff2e31d6158bf39e2608864d63fefd09d5b88ac6868f7010000" },
10446
10447                                   { 3,
10448                                   "3044022024cd52e4198c8ae0e414a86d86b5a65ea7450f2eb4e783096736d93395eca5ce022078f0094745b45be4d4b2b04dd5978c9e66ba49109e5704403e84aaf5f387d6be",
10449                                   "3045022100bbfb9d0a946d420807c86e985d636cceb16e71c3694ed186316251a00cbd807202207773223f9a337e145f64673825be9b30d07ef1542c82188b264bedcf7cda78c6",
10450                                   "020000000001010f44041fdfba175987cf4e6135ba2a154e3b7fb96483dc0ed5efc0678e5b6bf103000000000000000001d90d0000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500473044022024cd52e4198c8ae0e414a86d86b5a65ea7450f2eb4e783096736d93395eca5ce022078f0094745b45be4d4b2b04dd5978c9e66ba49109e5704403e84aaf5f387d6be01483045022100bbfb9d0a946d420807c86e985d636cceb16e71c3694ed186316251a00cbd807202207773223f9a337e145f64673825be9b30d07ef1542c82188b264bedcf7cda78c6012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000" }
10451                 } );
10452
10453                 // anchors: commitment tx with six outputs untrimmed (minimum dust limit)
10454                 chan.context.value_to_self_msat = 6993000000; // 7000000000 - 7000000
10455                 chan.context.feerate_per_kw = 645;
10456                 chan.context.holder_dust_limit_satoshis = 1001;
10457
10458                 test_commitment_with_anchors!("3044022025d97466c8049e955a5afce28e322f4b34d2561118e52332fb400f9b908cc0a402205dc6fba3a0d67ee142c428c535580cd1f2ff42e2f89b47e0c8a01847caffc312",
10459                                  "3045022100d57697c707b6f6d053febf24b98e8989f186eea42e37e9e91663ec2c70bb8f70022079b0715a472118f262f43016a674f59c015d9cafccec885968e76d9d9c5d0051",
10460                                  "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b80084a010000000000002200202b1b5854183c12d3316565972c4668929d314d81c5dcdbb21cb45fe8a9a8114f4a01000000000000220020e9e86e4823faa62e222ebc858a226636856158f07e69898da3b0d1af0ddb3994d0070000000000002200203e68115ae0b15b8de75b6c6bc9af5ac9f01391544e0870dae443a1e8fe7837ead007000000000000220020fe0598d74fee2205cc3672e6e6647706b4f3099713b4661b62482c3addd04a5eb80b000000000000220020f96d0334feb64a4f40eb272031d07afcb038db56aa57446d60308c9f8ccadef9a00f000000000000220020ce6e751274836ff59622a0d1e07f8831d80bd6730bd48581398bfadd2bb8da9ac0c62d0000000000220020f3394e1e619b0eca1f91be2fb5ab4dfc59ba5b84ebe014ad1d43a564d012994abc996a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0400483045022100d57697c707b6f6d053febf24b98e8989f186eea42e37e9e91663ec2c70bb8f70022079b0715a472118f262f43016a674f59c015d9cafccec885968e76d9d9c5d005101473044022025d97466c8049e955a5afce28e322f4b34d2561118e52332fb400f9b908cc0a402205dc6fba3a0d67ee142c428c535580cd1f2ff42e2f89b47e0c8a01847caffc31201475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {
10461
10462                                   { 0,
10463                                   "3045022100e04d160a326432659fe9fb127304c1d348dfeaba840081bdc57d8efd902a48d8022008a824e7cf5492b97e4d9e03c06a09f822775a44f6b5b2533a2088904abfc282",
10464                                   "3045022100b7c49846466b13b190ff739bbe3005c105482fc55539e55b1c561f76b6982b6c02200e5c35808619cf543c8405cff9fedd25f333a4a2f6f6d5e8af8150090c40ef09",
10465                                   "02000000000101104f394af4c4fad78337f95e3e9f802f4c0d86ab231853af09b285348561320002000000000100000001d0070000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100e04d160a326432659fe9fb127304c1d348dfeaba840081bdc57d8efd902a48d8022008a824e7cf5492b97e4d9e03c06a09f822775a44f6b5b2533a2088904abfc28283483045022100b7c49846466b13b190ff739bbe3005c105482fc55539e55b1c561f76b6982b6c02200e5c35808619cf543c8405cff9fedd25f333a4a2f6f6d5e8af8150090c40ef0901008876a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a914b43e1b38138a41b37f7cd9a1d274bc63e3a9b5d188ac6851b27568f6010000" },
10466
10467                                   { 1,
10468                                   "3045022100fbdc3c367ce3bf30796025cc590ee1f2ce0e72ae1ac19f5986d6d0a4fc76211f02207e45ae9267e8e820d188569604f71d1abd11bd385d58853dd7dc034cdb3e9a6e",
10469                                   "3045022100d29330f24db213b262068706099b39c15fa7e070c3fcdf8836c09723fc4d365602203ce57d01e9f28601e461a0b5c4a50119b270bde8b70148d133a6849c70b115ac",
10470                                   "02000000000101104f394af4c4fad78337f95e3e9f802f4c0d86ab231853af09b285348561320003000000000100000001d0070000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100fbdc3c367ce3bf30796025cc590ee1f2ce0e72ae1ac19f5986d6d0a4fc76211f02207e45ae9267e8e820d188569604f71d1abd11bd385d58853dd7dc034cdb3e9a6e83483045022100d29330f24db213b262068706099b39c15fa7e070c3fcdf8836c09723fc4d365602203ce57d01e9f28601e461a0b5c4a50119b270bde8b70148d133a6849c70b115ac012001010101010101010101010101010101010101010101010101010101010101018d76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a9144b6b2e5444c2639cc0fb7bcea5afba3f3cdce23988527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f501b175ac6851b2756800000000" },
10471
10472                                   { 2,
10473                                   "3044022066c5ef625cee3ddd2bc7b6bfb354b5834cf1cc6d52dd972fb41b7b225437ae4a022066cb85647df65c6b87a54e416dcdcca778a776c36a9643d2b5dc793c9b29f4c1",
10474                                   "304402202d4ce515cd9000ec37575972d70b8d24f73909fb7012e8ebd8c2066ef6fe187902202830b53e64ea565fecd0f398100691da6bb2a5cf9bb0d1926f1d71d05828a11e",
10475                                   "02000000000101104f394af4c4fad78337f95e3e9f802f4c0d86ab231853af09b285348561320004000000000100000001b80b0000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500473044022066c5ef625cee3ddd2bc7b6bfb354b5834cf1cc6d52dd972fb41b7b225437ae4a022066cb85647df65c6b87a54e416dcdcca778a776c36a9643d2b5dc793c9b29f4c18347304402202d4ce515cd9000ec37575972d70b8d24f73909fb7012e8ebd8c2066ef6fe187902202830b53e64ea565fecd0f398100691da6bb2a5cf9bb0d1926f1d71d05828a11e01008876a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9148a486ff2e31d6158bf39e2608864d63fefd09d5b88ac6851b27568f7010000" },
10476
10477                                   { 3,
10478                                   "3044022022c7e11595c53ee89a57ca76baf0aed730da035952d6ab3fe6459f5eff3b337a022075e10cc5f5fd724a35ce4087a5d03cd616698626c69814032132b50bb97dc615",
10479                                   "3045022100b20cd63e0587d1711beaebda4730775c4ac8b8b2ec78fe18a0c44c3f168c25230220079abb7fc4924e2fca5950842e5b9e416735585026914570078c4ef62f286226",
10480                                   "02000000000101104f394af4c4fad78337f95e3e9f802f4c0d86ab231853af09b285348561320005000000000100000001a00f0000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500473044022022c7e11595c53ee89a57ca76baf0aed730da035952d6ab3fe6459f5eff3b337a022075e10cc5f5fd724a35ce4087a5d03cd616698626c69814032132b50bb97dc61583483045022100b20cd63e0587d1711beaebda4730775c4ac8b8b2ec78fe18a0c44c3f168c25230220079abb7fc4924e2fca5950842e5b9e416735585026914570078c4ef62f286226012004040404040404040404040404040404040404040404040404040404040404048d76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac6851b2756800000000" }
10481                 } );
10482
10483                 // commitment tx with six outputs untrimmed (maximum feerate)
10484                 chan.context.value_to_self_msat = 6993000000; // 7000000000 - 7000000
10485                 chan.context.feerate_per_kw = 2069;
10486                 chan.context.holder_dust_limit_satoshis = 546;
10487
10488                 test_commitment!("304502210090b96a2498ce0c0f2fadbec2aab278fed54c1a7838df793ec4d2c78d96ec096202204fdd439c50f90d483baa7b68feeef4bd33bc277695405447bcd0bfb2ca34d7bc",
10489                                  "3045022100ad9a9bbbb75d506ca3b716b336ee3cf975dd7834fcf129d7dd188146eb58a8b4022061a759ee417339f7fe2ea1e8deb83abb6a74db31a09b7648a932a639cda23e33",
10490                                  "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8006d007000000000000220020403d394747cae42e98ff01734ad5c08f82ba123d3d9a620abda88989651e2ab5d007000000000000220020748eba944fedc8827f6b06bc44678f93c0f9e6078b35c6331ed31e75f8ce0c2db80b000000000000220020c20b5d1f8584fd90443e7b7b720136174fa4b9333c261d04dbbd012635c0f419a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e48477956a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0400483045022100ad9a9bbbb75d506ca3b716b336ee3cf975dd7834fcf129d7dd188146eb58a8b4022061a759ee417339f7fe2ea1e8deb83abb6a74db31a09b7648a932a639cda23e330148304502210090b96a2498ce0c0f2fadbec2aab278fed54c1a7838df793ec4d2c78d96ec096202204fdd439c50f90d483baa7b68feeef4bd33bc277695405447bcd0bfb2ca34d7bc01475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {
10491
10492                                   { 0,
10493                                   "3045022100f33513ee38abf1c582876f921f8fddc06acff48e04515532a32d3938de938ffd02203aa308a2c1863b7d6fdf53159a1465bf2e115c13152546cc5d74483ceaa7f699",
10494                                   "3045022100a637902a5d4c9ba9e7c472a225337d5aac9e2e3f6744f76e237132e7619ba0400220035c60d784a031c0d9f6df66b7eab8726a5c25397399ee4aa960842059eb3f9d",
10495                                   "02000000000101adbe717a63fb658add30ada1e6e12ed257637581898abe475c11d7bbcd65bd4d0000000000000000000175020000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100f33513ee38abf1c582876f921f8fddc06acff48e04515532a32d3938de938ffd02203aa308a2c1863b7d6fdf53159a1465bf2e115c13152546cc5d74483ceaa7f69901483045022100a637902a5d4c9ba9e7c472a225337d5aac9e2e3f6744f76e237132e7619ba0400220035c60d784a031c0d9f6df66b7eab8726a5c25397399ee4aa960842059eb3f9d01008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a914b43e1b38138a41b37f7cd9a1d274bc63e3a9b5d188ac6868f6010000" },
10496
10497                                   { 1,
10498                                   "3045022100ce07682cf4b90093c22dc2d9ab2a77ad6803526b655ef857221cc96af5c9e0bf02200f501cee22e7a268af40b555d15a8237c9f36ad67ef1841daf9f6a0267b1e6df",
10499                                   "3045022100e57e46234f8782d3ff7aa593b4f7446fb5316c842e693dc63ee324fd49f6a1c302204a2f7b44c48bd26e1554422afae13153eb94b29d3687b733d18930615fb2db61",
10500                                   "02000000000101adbe717a63fb658add30ada1e6e12ed257637581898abe475c11d7bbcd65bd4d0100000000000000000122020000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100ce07682cf4b90093c22dc2d9ab2a77ad6803526b655ef857221cc96af5c9e0bf02200f501cee22e7a268af40b555d15a8237c9f36ad67ef1841daf9f6a0267b1e6df01483045022100e57e46234f8782d3ff7aa593b4f7446fb5316c842e693dc63ee324fd49f6a1c302204a2f7b44c48bd26e1554422afae13153eb94b29d3687b733d18930615fb2db61012001010101010101010101010101010101010101010101010101010101010101018a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a9144b6b2e5444c2639cc0fb7bcea5afba3f3cdce23988527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f501b175ac686800000000" },
10501
10502                                   { 2,
10503                                   "3045022100e3e35492e55f82ec0bc2f317ffd7a486d1f7024330fe9743c3559fc39f32ef0c02203d1d4db651fc388a91d5ad8ecdd8e83673063bc8eefe27cfd8c189090e3a23e0",
10504                                   "3044022068613fb1b98eb3aec7f44c5b115b12343c2f066c4277c82b5f873dfe68f37f50022028109b4650f3f528ca4bfe9a467aff2e3e43893b61b5159157119d5d95cf1c18",
10505                                   "02000000000101adbe717a63fb658add30ada1e6e12ed257637581898abe475c11d7bbcd65bd4d020000000000000000015d060000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100e3e35492e55f82ec0bc2f317ffd7a486d1f7024330fe9743c3559fc39f32ef0c02203d1d4db651fc388a91d5ad8ecdd8e83673063bc8eefe27cfd8c189090e3a23e001473044022068613fb1b98eb3aec7f44c5b115b12343c2f066c4277c82b5f873dfe68f37f50022028109b4650f3f528ca4bfe9a467aff2e3e43893b61b5159157119d5d95cf1c1801008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9148a486ff2e31d6158bf39e2608864d63fefd09d5b88ac6868f7010000" },
10506
10507                                   { 3,
10508                                   "304402207475aeb0212ef9bf5130b60937817ad88c9a87976988ef1f323f026148cc4a850220739fea17ad3257dcad72e509c73eebe86bee30b178467b9fdab213d631b109df",
10509                                   "3045022100d315522e09e7d53d2a659a79cb67fef56d6c4bddf3f46df6772d0d20a7beb7c8022070bcc17e288607b6a72be0bd83368bb6d53488db266c1cdb4d72214e4f02ac33",
10510                                   "02000000000101adbe717a63fb658add30ada1e6e12ed257637581898abe475c11d7bbcd65bd4d03000000000000000001f2090000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e050047304402207475aeb0212ef9bf5130b60937817ad88c9a87976988ef1f323f026148cc4a850220739fea17ad3257dcad72e509c73eebe86bee30b178467b9fdab213d631b109df01483045022100d315522e09e7d53d2a659a79cb67fef56d6c4bddf3f46df6772d0d20a7beb7c8022070bcc17e288607b6a72be0bd83368bb6d53488db266c1cdb4d72214e4f02ac33012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000" }
10511                 } );
10512
10513                 // commitment tx with five outputs untrimmed (minimum feerate)
10514                 chan.context.value_to_self_msat = 6993000000; // 7000000000 - 7000000
10515                 chan.context.feerate_per_kw = 2070;
10516
10517                 test_commitment!("304402204ca1ba260dee913d318271d86e10ca0f5883026fb5653155cff600fb40895223022037b145204b7054a40e08bb1fefbd826f827b40838d3e501423bcc57924bcb50c",
10518                                  "3044022001014419b5ba00e083ac4e0a85f19afc848aacac2d483b4b525d15e2ae5adbfe022015ebddad6ee1e72b47cb09f3e78459da5be01ccccd95dceca0e056a00cc773c1",
10519                                  "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8005d007000000000000220020403d394747cae42e98ff01734ad5c08f82ba123d3d9a620abda88989651e2ab5b80b000000000000220020c20b5d1f8584fd90443e7b7b720136174fa4b9333c261d04dbbd012635c0f419a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e484da966a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0400473044022001014419b5ba00e083ac4e0a85f19afc848aacac2d483b4b525d15e2ae5adbfe022015ebddad6ee1e72b47cb09f3e78459da5be01ccccd95dceca0e056a00cc773c10147304402204ca1ba260dee913d318271d86e10ca0f5883026fb5653155cff600fb40895223022037b145204b7054a40e08bb1fefbd826f827b40838d3e501423bcc57924bcb50c01475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {
10520
10521                                   { 0,
10522                                   "304402205f6b6d12d8d2529fb24f4445630566cf4abbd0f9330ab6c2bdb94222d6a2a0c502202f556258ae6f05b193749e4c541dfcc13b525a5422f6291f073f15617ba8579b",
10523                                   "30440220150b11069454da70caf2492ded9e0065c9a57f25ac2a4c52657b1d15b6c6ed85022068a38833b603c8892717206383611bad210f1cbb4b1f87ea29c6c65b9e1cb3e5",
10524                                   "02000000000101403ad7602b43293497a3a2235a12ecefda4f3a1f1d06e49b1786d945685de1ff0000000000000000000174020000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e050047304402205f6b6d12d8d2529fb24f4445630566cf4abbd0f9330ab6c2bdb94222d6a2a0c502202f556258ae6f05b193749e4c541dfcc13b525a5422f6291f073f15617ba8579b014730440220150b11069454da70caf2492ded9e0065c9a57f25ac2a4c52657b1d15b6c6ed85022068a38833b603c8892717206383611bad210f1cbb4b1f87ea29c6c65b9e1cb3e501008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a914b43e1b38138a41b37f7cd9a1d274bc63e3a9b5d188ac6868f6010000" },
10525
10526                                   { 1,
10527                                   "3045022100f960dfb1c9aee7ce1437efa65b523e399383e8149790e05d8fed27ff6e42fe0002202fe8613e062ffe0b0c518cc4101fba1c6de70f64a5bcc7ae663f2efae43b8546",
10528                                   "30450221009a6ed18e6873bc3644332a6ee21c152a5b102821865350df7a8c74451a51f9f2022050d801fb4895d7d7fbf452824c0168347f5c0cbe821cf6a97a63af5b8b2563c6",
10529                                   "02000000000101403ad7602b43293497a3a2235a12ecefda4f3a1f1d06e49b1786d945685de1ff010000000000000000015c060000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100f960dfb1c9aee7ce1437efa65b523e399383e8149790e05d8fed27ff6e42fe0002202fe8613e062ffe0b0c518cc4101fba1c6de70f64a5bcc7ae663f2efae43b8546014830450221009a6ed18e6873bc3644332a6ee21c152a5b102821865350df7a8c74451a51f9f2022050d801fb4895d7d7fbf452824c0168347f5c0cbe821cf6a97a63af5b8b2563c601008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9148a486ff2e31d6158bf39e2608864d63fefd09d5b88ac6868f7010000" },
10530
10531                                   { 2,
10532                                   "3045022100ae5fc7717ae684bc1fcf9020854e5dbe9842c9e7472879ac06ff95ac2bb10e4e022057728ada4c00083a3e65493fb5d50a232165948a1a0f530ef63185c2c8c56504",
10533                                   "30440220408ad3009827a8fccf774cb285587686bfb2ed041f89a89453c311ce9c8ee0f902203c7392d9f8306d3a46522a66bd2723a7eb2628cb2d9b34d4c104f1766bf37502",
10534                                   "02000000000101403ad7602b43293497a3a2235a12ecefda4f3a1f1d06e49b1786d945685de1ff02000000000000000001f1090000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100ae5fc7717ae684bc1fcf9020854e5dbe9842c9e7472879ac06ff95ac2bb10e4e022057728ada4c00083a3e65493fb5d50a232165948a1a0f530ef63185c2c8c56504014730440220408ad3009827a8fccf774cb285587686bfb2ed041f89a89453c311ce9c8ee0f902203c7392d9f8306d3a46522a66bd2723a7eb2628cb2d9b34d4c104f1766bf37502012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000" }
10535                 } );
10536
10537                 // commitment tx with five outputs untrimmed (maximum feerate)
10538                 chan.context.value_to_self_msat = 6993000000; // 7000000000 - 7000000
10539                 chan.context.feerate_per_kw = 2194;
10540
10541                 test_commitment!("304402204bb3d6e279d71d9da414c82de42f1f954267c762b2e2eb8b76bc3be4ea07d4b0022014febc009c5edc8c3fc5d94015de163200f780046f1c293bfed8568f08b70fb3",
10542                                  "3044022072c2e2b1c899b2242656a537dde2892fa3801be0d6df0a87836c550137acde8302201654aa1974d37a829083c3ba15088689f30b56d6a4f6cb14c7bad0ee3116d398",
10543                                  "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8005d007000000000000220020403d394747cae42e98ff01734ad5c08f82ba123d3d9a620abda88989651e2ab5b80b000000000000220020c20b5d1f8584fd90443e7b7b720136174fa4b9333c261d04dbbd012635c0f419a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e48440966a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0400473044022072c2e2b1c899b2242656a537dde2892fa3801be0d6df0a87836c550137acde8302201654aa1974d37a829083c3ba15088689f30b56d6a4f6cb14c7bad0ee3116d3980147304402204bb3d6e279d71d9da414c82de42f1f954267c762b2e2eb8b76bc3be4ea07d4b0022014febc009c5edc8c3fc5d94015de163200f780046f1c293bfed8568f08b70fb301475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {
10544
10545                                   { 0,
10546                                   "3045022100939726680351a7856c1bc386d4a1f422c7d29bd7b56afc139570f508474e6c40022023175a799ccf44c017fbaadb924c40b2a12115a5b7d0dfd3228df803a2de8450",
10547                                   "304502210099c98c2edeeee6ec0fb5f3bea8b79bb016a2717afa9b5072370f34382de281d302206f5e2980a995e045cf90a547f0752a7ee99d48547bc135258fe7bc07e0154301",
10548                                   "02000000000101153cd825fdb3aa624bfe513e8031d5d08c5e582fb3d1d1fe8faf27d3eed410cd0000000000000000000122020000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100939726680351a7856c1bc386d4a1f422c7d29bd7b56afc139570f508474e6c40022023175a799ccf44c017fbaadb924c40b2a12115a5b7d0dfd3228df803a2de84500148304502210099c98c2edeeee6ec0fb5f3bea8b79bb016a2717afa9b5072370f34382de281d302206f5e2980a995e045cf90a547f0752a7ee99d48547bc135258fe7bc07e015430101008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a914b43e1b38138a41b37f7cd9a1d274bc63e3a9b5d188ac6868f6010000" },
10549
10550                                   { 1,
10551                                   "3044022021bb883bf324553d085ba2e821cad80c28ef8b303dbead8f98e548783c02d1600220638f9ef2a9bba25869afc923f4b5dc38be3bb459f9efa5d869392d5f7779a4a0",
10552                                   "3045022100fd85bd7697b89c08ec12acc8ba89b23090637d83abd26ca37e01ae93e67c367302202b551fe69386116c47f984aab9c8dfd25d864dcde5d3389cfbef2447a85c4b77",
10553                                   "02000000000101153cd825fdb3aa624bfe513e8031d5d08c5e582fb3d1d1fe8faf27d3eed410cd010000000000000000010a060000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500473044022021bb883bf324553d085ba2e821cad80c28ef8b303dbead8f98e548783c02d1600220638f9ef2a9bba25869afc923f4b5dc38be3bb459f9efa5d869392d5f7779a4a001483045022100fd85bd7697b89c08ec12acc8ba89b23090637d83abd26ca37e01ae93e67c367302202b551fe69386116c47f984aab9c8dfd25d864dcde5d3389cfbef2447a85c4b7701008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9148a486ff2e31d6158bf39e2608864d63fefd09d5b88ac6868f7010000" },
10554
10555                                   { 2,
10556                                   "3045022100c9e6f0454aa598b905a35e641a70cc9f67b5f38cc4b00843a041238c4a9f1c4a0220260a2822a62da97e44583e837245995ca2e36781769c52f19e498efbdcca262b",
10557                                   "30450221008a9f2ea24cd455c2b64c1472a5fa83865b0a5f49a62b661801e884cf2849af8302204d44180e50bf6adfcf1c1e581d75af91aba4e28681ce4a5ee5f3cbf65eca10f3",
10558                                   "02000000000101153cd825fdb3aa624bfe513e8031d5d08c5e582fb3d1d1fe8faf27d3eed410cd020000000000000000019a090000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100c9e6f0454aa598b905a35e641a70cc9f67b5f38cc4b00843a041238c4a9f1c4a0220260a2822a62da97e44583e837245995ca2e36781769c52f19e498efbdcca262b014830450221008a9f2ea24cd455c2b64c1472a5fa83865b0a5f49a62b661801e884cf2849af8302204d44180e50bf6adfcf1c1e581d75af91aba4e28681ce4a5ee5f3cbf65eca10f3012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000" }
10559                 } );
10560
10561                 // commitment tx with four outputs untrimmed (minimum feerate)
10562                 chan.context.value_to_self_msat = 6993000000; // 7000000000 - 7000000
10563                 chan.context.feerate_per_kw = 2195;
10564
10565                 test_commitment!("304402201a8c1b1f9671cd9e46c7323a104d7047cc48d3ee80d40d4512e0c72b8dc65666022066d7f9a2ce18c9eb22d2739ffcce05721c767f9b607622a31b6ea5793ddce403",
10566                                  "3044022044d592025b610c0d678f65032e87035cdfe89d1598c522cc32524ae8172417c30220749fef9d5b2ae8cdd91ece442ba8809bc891efedae2291e578475f97715d1767",
10567                                  "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8004b80b000000000000220020c20b5d1f8584fd90443e7b7b720136174fa4b9333c261d04dbbd012635c0f419a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e484b8976a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0400473044022044d592025b610c0d678f65032e87035cdfe89d1598c522cc32524ae8172417c30220749fef9d5b2ae8cdd91ece442ba8809bc891efedae2291e578475f97715d17670147304402201a8c1b1f9671cd9e46c7323a104d7047cc48d3ee80d40d4512e0c72b8dc65666022066d7f9a2ce18c9eb22d2739ffcce05721c767f9b607622a31b6ea5793ddce40301475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {
10568
10569                                   { 0,
10570                                   "3045022100e57b845066a06ee7c2cbfc29eabffe52daa9bf6f6de760066d04df9f9b250e0002202ffb197f0e6e0a77a75a9aff27014bd3de83b7f748d7efef986abe655e1dd50e",
10571                                   "3045022100ecc8c6529d0b2316d046f0f0757c1e1c25a636db168ec4f3aa1b9278df685dc0022067ae6b65e936f1337091f7b18a15935b608c5f2cdddb2f892ed0babfdd376d76",
10572                                   "020000000001018130a10f09b13677ba2885a8bca32860f3a952e5912b829a473639b5a2c07b900000000000000000000109060000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100e57b845066a06ee7c2cbfc29eabffe52daa9bf6f6de760066d04df9f9b250e0002202ffb197f0e6e0a77a75a9aff27014bd3de83b7f748d7efef986abe655e1dd50e01483045022100ecc8c6529d0b2316d046f0f0757c1e1c25a636db168ec4f3aa1b9278df685dc0022067ae6b65e936f1337091f7b18a15935b608c5f2cdddb2f892ed0babfdd376d7601008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9148a486ff2e31d6158bf39e2608864d63fefd09d5b88ac6868f7010000" },
10573
10574                                   { 1,
10575                                   "3045022100d193b7ecccad8057571620a0b1ffa6c48e9483311723b59cf536043b20bc51550220546d4bd37b3b101ecda14f6c907af46ec391abce1cd9c7ce22b1a62b534f2f2a",
10576                                   "3044022014d66f11f9cacf923807eba49542076c5fe5cccf252fb08fe98c78ef3ca6ab5402201b290dbe043cc512d9d78de074a5a129b8759bc6a6c546b190d120b690bd6e82",
10577                                   "020000000001018130a10f09b13677ba2885a8bca32860f3a952e5912b829a473639b5a2c07b900100000000000000000199090000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100d193b7ecccad8057571620a0b1ffa6c48e9483311723b59cf536043b20bc51550220546d4bd37b3b101ecda14f6c907af46ec391abce1cd9c7ce22b1a62b534f2f2a01473044022014d66f11f9cacf923807eba49542076c5fe5cccf252fb08fe98c78ef3ca6ab5402201b290dbe043cc512d9d78de074a5a129b8759bc6a6c546b190d120b690bd6e82012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000" }
10578                 } );
10579
10580                 // anchors: commitment tx with four outputs untrimmed (minimum dust limit)
10581                 chan.context.value_to_self_msat = 6993000000; // 7000000000 - 7000000
10582                 chan.context.feerate_per_kw = 2185;
10583                 chan.context.holder_dust_limit_satoshis = 2001;
10584                 let cached_channel_type = chan.context.channel_type;
10585                 chan.context.channel_type = ChannelTypeFeatures::anchors_zero_htlc_fee_and_dependencies();
10586
10587                 test_commitment_with_anchors!("3044022040f63a16148cf35c8d3d41827f5ae7f7c3746885bb64d4d1b895892a83812b3e02202fcf95c2bf02c466163b3fa3ced6a24926fbb4035095a96842ef516e86ba54c0",
10588                                  "3045022100cd8479cfe1edb1e5a1d487391e0451a469c7171e51e680183f19eb4321f20e9b02204eab7d5a6384b1b08e03baa6e4d9748dfd2b5ab2bae7e39604a0d0055bbffdd5",
10589                                  "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b80064a010000000000002200202b1b5854183c12d3316565972c4668929d314d81c5dcdbb21cb45fe8a9a8114f4a01000000000000220020e9e86e4823faa62e222ebc858a226636856158f07e69898da3b0d1af0ddb3994b80b000000000000220020f96d0334feb64a4f40eb272031d07afcb038db56aa57446d60308c9f8ccadef9a00f000000000000220020ce6e751274836ff59622a0d1e07f8831d80bd6730bd48581398bfadd2bb8da9ac0c62d0000000000220020f3394e1e619b0eca1f91be2fb5ab4dfc59ba5b84ebe014ad1d43a564d012994ac5916a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0400483045022100cd8479cfe1edb1e5a1d487391e0451a469c7171e51e680183f19eb4321f20e9b02204eab7d5a6384b1b08e03baa6e4d9748dfd2b5ab2bae7e39604a0d0055bbffdd501473044022040f63a16148cf35c8d3d41827f5ae7f7c3746885bb64d4d1b895892a83812b3e02202fcf95c2bf02c466163b3fa3ced6a24926fbb4035095a96842ef516e86ba54c001475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {
10590
10591                                   { 0,
10592                                   "304402206870514a72ad6e723ff7f1e0370d7a33c1cd2a0b9272674143ebaf6a1d02dee102205bd953c34faf5e7322e9a1c0103581cb090280fda4f1039ee8552668afa90ebb",
10593                                   "30440220669de9ca7910eff65a7773ebd14a9fc371fe88cde5b8e2a81609d85c87ac939b02201ac29472fa4067322e92d75b624942d60be5050139b20bb363db75be79eb946f",
10594                                   "02000000000101ac13a7715f80b8e52dda43c6929cade5521bdced3a405da02b443f1ffb1e33cc02000000000100000001b80b0000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e050047304402206870514a72ad6e723ff7f1e0370d7a33c1cd2a0b9272674143ebaf6a1d02dee102205bd953c34faf5e7322e9a1c0103581cb090280fda4f1039ee8552668afa90ebb834730440220669de9ca7910eff65a7773ebd14a9fc371fe88cde5b8e2a81609d85c87ac939b02201ac29472fa4067322e92d75b624942d60be5050139b20bb363db75be79eb946f01008876a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9148a486ff2e31d6158bf39e2608864d63fefd09d5b88ac6851b27568f7010000" },
10595
10596                                   { 1,
10597                                   "3045022100949e8dd938da56445b1cdfdebe1b7efea086edd05d89910d205a1e2e033ce47102202cbd68b5262ab144d9ec12653f87dfb0bb6bd05d1f58ae1e523f028eaefd7271",
10598                                   "3045022100e3104ed8b239f8019e5f0a1a73d7782a94a8c36e7984f476c3a0b3cb0e62e27902207e3d52884600985f8a2098e53a5c30dd6a5e857733acfaa07ab2162421ed2688",
10599                                   "02000000000101ac13a7715f80b8e52dda43c6929cade5521bdced3a405da02b443f1ffb1e33cc03000000000100000001a00f0000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100949e8dd938da56445b1cdfdebe1b7efea086edd05d89910d205a1e2e033ce47102202cbd68b5262ab144d9ec12653f87dfb0bb6bd05d1f58ae1e523f028eaefd727183483045022100e3104ed8b239f8019e5f0a1a73d7782a94a8c36e7984f476c3a0b3cb0e62e27902207e3d52884600985f8a2098e53a5c30dd6a5e857733acfaa07ab2162421ed2688012004040404040404040404040404040404040404040404040404040404040404048d76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac6851b2756800000000" }
10600                 } );
10601
10602                 // commitment tx with four outputs untrimmed (maximum feerate)
10603                 chan.context.value_to_self_msat = 6993000000; // 7000000000 - 7000000
10604                 chan.context.feerate_per_kw = 3702;
10605                 chan.context.holder_dust_limit_satoshis = 546;
10606                 chan.context.channel_type = cached_channel_type.clone();
10607
10608                 test_commitment!("304502210092a587aeb777f869e7ff0d7898ea619ee26a3dacd1f3672b945eea600be431100220077ee9eae3528d15251f2a52b607b189820e57a6ccfac8d1af502b132ee40169",
10609                                  "3045022100e5efb73c32d32da2d79702299b6317de6fb24a60476e3855926d78484dd1b3c802203557cb66a42c944ef06e00bcc4da35a5bcb2f185aab0f8e403e519e1d66aaf75",
10610                                  "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8004b80b000000000000220020c20b5d1f8584fd90443e7b7b720136174fa4b9333c261d04dbbd012635c0f419a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e4846f916a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0400483045022100e5efb73c32d32da2d79702299b6317de6fb24a60476e3855926d78484dd1b3c802203557cb66a42c944ef06e00bcc4da35a5bcb2f185aab0f8e403e519e1d66aaf750148304502210092a587aeb777f869e7ff0d7898ea619ee26a3dacd1f3672b945eea600be431100220077ee9eae3528d15251f2a52b607b189820e57a6ccfac8d1af502b132ee4016901475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {
10611
10612                                   { 0,
10613                                   "304402206fa54c11f98c3bae1e93df43fc7affeb05b476bf8060c03e29c377c69bc08e8b0220672701cce50d5c379ff45a5d2cfe48ac44973adb066ac32608e21221d869bb89",
10614                                   "304402206e36c683ebf2cb16bcef3d5439cf8b53cd97280a365ed8acd7abb85a8ba5f21c02206e8621edfc2a5766cbc96eb67fd501127ff163eb6b85518a39f7d4974aef126f",
10615                                   "020000000001018db483bff65c70ee71d8282aeec5a880e2e2b39e45772bda5460403095c62e3f0000000000000000000122020000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e050047304402206fa54c11f98c3bae1e93df43fc7affeb05b476bf8060c03e29c377c69bc08e8b0220672701cce50d5c379ff45a5d2cfe48ac44973adb066ac32608e21221d869bb890147304402206e36c683ebf2cb16bcef3d5439cf8b53cd97280a365ed8acd7abb85a8ba5f21c02206e8621edfc2a5766cbc96eb67fd501127ff163eb6b85518a39f7d4974aef126f01008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9148a486ff2e31d6158bf39e2608864d63fefd09d5b88ac6868f7010000" },
10616
10617                                   { 1,
10618                                   "3044022057649739b0eb74d541ead0dfdb3d4b2c15aa192720031044c3434c67812e5ca902201e5ede42d960ae551707f4a6b34b09393cf4dee2418507daa022e3550dbb5817",
10619                                   "304402207faad26678c8850e01b4a0696d60841f7305e1832b786110ee9075cb92ed14a30220516ef8ee5dfa80824ea28cbcec0dd95f8b847146257c16960db98507db15ffdc",
10620                                   "020000000001018db483bff65c70ee71d8282aeec5a880e2e2b39e45772bda5460403095c62e3f0100000000000000000176050000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500473044022057649739b0eb74d541ead0dfdb3d4b2c15aa192720031044c3434c67812e5ca902201e5ede42d960ae551707f4a6b34b09393cf4dee2418507daa022e3550dbb58170147304402207faad26678c8850e01b4a0696d60841f7305e1832b786110ee9075cb92ed14a30220516ef8ee5dfa80824ea28cbcec0dd95f8b847146257c16960db98507db15ffdc012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000" }
10621                 } );
10622
10623                 // commitment tx with three outputs untrimmed (minimum feerate)
10624                 chan.context.value_to_self_msat = 6993000000; // 7000000000 - 7000000
10625                 chan.context.feerate_per_kw = 3703;
10626
10627                 test_commitment!("3045022100b495d239772a237ff2cf354b1b11be152fd852704cb184e7356d13f2fb1e5e430220723db5cdb9cbd6ead7bfd3deb419cf41053a932418cbb22a67b581f40bc1f13e",
10628                                  "304402201b736d1773a124c745586217a75bed5f66c05716fbe8c7db4fdb3c3069741cdd02205083f39c321c1bcadfc8d97e3c791a66273d936abac0c6a2fde2ed46019508e1",
10629                                  "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8003a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e484eb936a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e040047304402201b736d1773a124c745586217a75bed5f66c05716fbe8c7db4fdb3c3069741cdd02205083f39c321c1bcadfc8d97e3c791a66273d936abac0c6a2fde2ed46019508e101483045022100b495d239772a237ff2cf354b1b11be152fd852704cb184e7356d13f2fb1e5e430220723db5cdb9cbd6ead7bfd3deb419cf41053a932418cbb22a67b581f40bc1f13e01475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {
10630
10631                                   { 0,
10632                                   "3045022100c34c61735f93f2e324cc873c3b248111ccf8f6db15d5969583757010d4ad2b4602207867bb919b2ddd6387873e425345c9b7fd18d1d66aba41f3607bc2896ef3c30a",
10633                                   "3045022100988c143e2110067117d2321bdd4bd16ca1734c98b29290d129384af0962b634e02206c1b02478878c5f547018b833986578f90c3e9be669fe5788ad0072a55acbb05",
10634                                   "0200000000010120060e4a29579d429f0f27c17ee5f1ee282f20d706d6f90b63d35946d8f3029a0000000000000000000175050000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100c34c61735f93f2e324cc873c3b248111ccf8f6db15d5969583757010d4ad2b4602207867bb919b2ddd6387873e425345c9b7fd18d1d66aba41f3607bc2896ef3c30a01483045022100988c143e2110067117d2321bdd4bd16ca1734c98b29290d129384af0962b634e02206c1b02478878c5f547018b833986578f90c3e9be669fe5788ad0072a55acbb05012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000" }
10635                 } );
10636
10637                 // anchors: commitment tx with three outputs untrimmed (minimum dust limit)
10638                 chan.context.value_to_self_msat = 6993000000; // 7000000000 - 7000000
10639                 chan.context.feerate_per_kw = 3687;
10640                 chan.context.holder_dust_limit_satoshis = 3001;
10641                 chan.context.channel_type = ChannelTypeFeatures::anchors_zero_htlc_fee_and_dependencies();
10642
10643                 test_commitment_with_anchors!("3045022100ad6c71569856b2d7ff42e838b4abe74a713426b37f22fa667a195a4c88908c6902202b37272b02a42dc6d9f4f82cab3eaf84ac882d9ed762859e1e75455c2c228377",
10644                                  "3045022100c970799bcb33f43179eb43b3378a0a61991cf2923f69b36ef12548c3df0e6d500220413dc27d2e39ee583093adfcb7799be680141738babb31cc7b0669a777a31f5d",
10645                                  "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b80054a010000000000002200202b1b5854183c12d3316565972c4668929d314d81c5dcdbb21cb45fe8a9a8114f4a01000000000000220020e9e86e4823faa62e222ebc858a226636856158f07e69898da3b0d1af0ddb3994a00f000000000000220020ce6e751274836ff59622a0d1e07f8831d80bd6730bd48581398bfadd2bb8da9ac0c62d0000000000220020f3394e1e619b0eca1f91be2fb5ab4dfc59ba5b84ebe014ad1d43a564d012994aa28b6a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0400483045022100c970799bcb33f43179eb43b3378a0a61991cf2923f69b36ef12548c3df0e6d500220413dc27d2e39ee583093adfcb7799be680141738babb31cc7b0669a777a31f5d01483045022100ad6c71569856b2d7ff42e838b4abe74a713426b37f22fa667a195a4c88908c6902202b37272b02a42dc6d9f4f82cab3eaf84ac882d9ed762859e1e75455c2c22837701475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {
10646
10647                                   { 0,
10648                                   "3044022017b558a3cf5f0cb94269e2e927b29ed22bd2416abb8a7ce6de4d1256f359b93602202e9ca2b1a23ea3e69f433c704e327739e219804b8c188b1d52f74fd5a9de954c",
10649                                   "3045022100af7a8b7c7ff2080c68995254cb66d64d9954edcc5baac3bb4f27ed2d29aaa6120220421c27da7a60574a9263f271e0f3bd34594ec6011095190022b3b54596ea03de",
10650                                   "02000000000101542562b326c08e3a076d9cfca2be175041366591da334d8d513ff1686fd95a6002000000000100000001a00f0000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500473044022017b558a3cf5f0cb94269e2e927b29ed22bd2416abb8a7ce6de4d1256f359b93602202e9ca2b1a23ea3e69f433c704e327739e219804b8c188b1d52f74fd5a9de954c83483045022100af7a8b7c7ff2080c68995254cb66d64d9954edcc5baac3bb4f27ed2d29aaa6120220421c27da7a60574a9263f271e0f3bd34594ec6011095190022b3b54596ea03de012004040404040404040404040404040404040404040404040404040404040404048d76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac6851b2756800000000" }
10651                 } );
10652
10653                 // commitment tx with three outputs untrimmed (maximum feerate)
10654                 chan.context.value_to_self_msat = 6993000000; // 7000000000 - 7000000
10655                 chan.context.feerate_per_kw = 4914;
10656                 chan.context.holder_dust_limit_satoshis = 546;
10657                 chan.context.channel_type = cached_channel_type.clone();
10658
10659                 test_commitment!("3045022100b4b16d5f8cc9fc4c1aff48831e832a0d8990e133978a66e302c133550954a44d022073573ce127e2200d316f6b612803a5c0c97b8d20e1e44dbe2ac0dd2fb8c95244",
10660                                  "3045022100d72638bc6308b88bb6d45861aae83e5b9ff6e10986546e13bce769c70036e2620220320be7c6d66d22f30b9fcd52af66531505b1310ca3b848c19285b38d8a1a8c19",
10661                                  "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8003a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e484ae8f6a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0400483045022100d72638bc6308b88bb6d45861aae83e5b9ff6e10986546e13bce769c70036e2620220320be7c6d66d22f30b9fcd52af66531505b1310ca3b848c19285b38d8a1a8c1901483045022100b4b16d5f8cc9fc4c1aff48831e832a0d8990e133978a66e302c133550954a44d022073573ce127e2200d316f6b612803a5c0c97b8d20e1e44dbe2ac0dd2fb8c9524401475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {
10662
10663                                   { 0,
10664                                   "3045022100f43591c156038ba217756006bb3c55f7d113a325cdd7d9303c82115372858d68022016355b5aadf222bc8d12e426c75f4a03423917b2443a103eb2a498a3a2234374",
10665                                   "30440220585dee80fafa264beac535c3c0bb5838ac348b156fdc982f86adc08dfc9bfd250220130abb82f9f295cc9ef423dcfef772fde2acd85d9df48cc538981d26a10a9c10",
10666                                   "02000000000101a9172908eace869cc35128c31fc2ab502f72e4dff31aab23e0244c4b04b11ab00000000000000000000122020000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100f43591c156038ba217756006bb3c55f7d113a325cdd7d9303c82115372858d68022016355b5aadf222bc8d12e426c75f4a03423917b2443a103eb2a498a3a2234374014730440220585dee80fafa264beac535c3c0bb5838ac348b156fdc982f86adc08dfc9bfd250220130abb82f9f295cc9ef423dcfef772fde2acd85d9df48cc538981d26a10a9c10012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000" }
10667                 } );
10668
10669                 // commitment tx with two outputs untrimmed (minimum feerate)
10670                 chan.context.value_to_self_msat = 6993000000; // 7000000000 - 7000000
10671                 chan.context.feerate_per_kw = 4915;
10672                 chan.context.holder_dust_limit_satoshis = 546;
10673
10674                 test_commitment!("304402203a286936e74870ca1459c700c71202af0381910a6bfab687ef494ef1bc3e02c902202506c362d0e3bee15e802aa729bf378e051644648253513f1c085b264cc2a720",
10675                                  "30450221008a953551f4d67cb4df3037207fc082ddaf6be84d417b0bd14c80aab66f1b01a402207508796dc75034b2dee876fe01dc05a08b019f3e5d689ac8842ade2f1befccf5",
10676                                  "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8002c0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e484fa926a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e04004830450221008a953551f4d67cb4df3037207fc082ddaf6be84d417b0bd14c80aab66f1b01a402207508796dc75034b2dee876fe01dc05a08b019f3e5d689ac8842ade2f1befccf50147304402203a286936e74870ca1459c700c71202af0381910a6bfab687ef494ef1bc3e02c902202506c362d0e3bee15e802aa729bf378e051644648253513f1c085b264cc2a72001475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {});
10677
10678                 // anchors: commitment tx with two outputs untrimmed (minimum dust limit)
10679                 chan.context.value_to_self_msat = 6993000000; // 7000000000 - 7000000
10680                 chan.context.feerate_per_kw = 4894;
10681                 chan.context.holder_dust_limit_satoshis = 4001;
10682                 chan.context.channel_type = ChannelTypeFeatures::anchors_zero_htlc_fee_and_dependencies();
10683
10684                 test_commitment_with_anchors!("3045022100e784a66b1588575801e237d35e510fd92a81ae3a4a2a1b90c031ad803d07b3f3022021bc5f16501f167607d63b681442da193eb0a76b4b7fd25c2ed4f8b28fd35b95",
10685                                  "30450221009f16ac85d232e4eddb3fcd750a68ebf0b58e3356eaada45d3513ede7e817bf4c02207c2b043b4e5f971261975406cb955219fa56bffe5d834a833694b5abc1ce4cfd",
10686                                  "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b80044a010000000000002200202b1b5854183c12d3316565972c4668929d314d81c5dcdbb21cb45fe8a9a8114f4a01000000000000220020e9e86e4823faa62e222ebc858a226636856158f07e69898da3b0d1af0ddb3994c0c62d0000000000220020f3394e1e619b0eca1f91be2fb5ab4dfc59ba5b84ebe014ad1d43a564d012994ad0886a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e04004830450221009f16ac85d232e4eddb3fcd750a68ebf0b58e3356eaada45d3513ede7e817bf4c02207c2b043b4e5f971261975406cb955219fa56bffe5d834a833694b5abc1ce4cfd01483045022100e784a66b1588575801e237d35e510fd92a81ae3a4a2a1b90c031ad803d07b3f3022021bc5f16501f167607d63b681442da193eb0a76b4b7fd25c2ed4f8b28fd35b9501475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {});
10687
10688                 // commitment tx with two outputs untrimmed (maximum feerate)
10689                 chan.context.value_to_self_msat = 6993000000; // 7000000000 - 7000000
10690                 chan.context.feerate_per_kw = 9651180;
10691                 chan.context.holder_dust_limit_satoshis = 546;
10692                 chan.context.channel_type = cached_channel_type.clone();
10693
10694                 test_commitment!("304402200a8544eba1d216f5c5e530597665fa9bec56943c0f66d98fc3d028df52d84f7002201e45fa5c6bc3a506cc2553e7d1c0043a9811313fc39c954692c0d47cfce2bbd3",
10695                                  "3045022100e11b638c05c650c2f63a421d36ef8756c5ce82f2184278643520311cdf50aa200220259565fb9c8e4a87ccaf17f27a3b9ca4f20625754a0920d9c6c239d8156a11de",
10696                                  "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b800222020000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80ec0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e4840400483045022100e11b638c05c650c2f63a421d36ef8756c5ce82f2184278643520311cdf50aa200220259565fb9c8e4a87ccaf17f27a3b9ca4f20625754a0920d9c6c239d8156a11de0147304402200a8544eba1d216f5c5e530597665fa9bec56943c0f66d98fc3d028df52d84f7002201e45fa5c6bc3a506cc2553e7d1c0043a9811313fc39c954692c0d47cfce2bbd301475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {});
10697
10698                 // commitment tx with one output untrimmed (minimum feerate)
10699                 chan.context.value_to_self_msat = 6993000000; // 7000000000 - 7000000
10700                 chan.context.feerate_per_kw = 9651181;
10701
10702                 test_commitment!("304402202ade0142008309eb376736575ad58d03e5b115499709c6db0b46e36ff394b492022037b63d78d66404d6504d4c4ac13be346f3d1802928a6d3ad95a6a944227161a2",
10703                                  "304402207e8d51e0c570a5868a78414f4e0cbfaed1106b171b9581542c30718ee4eb95ba02203af84194c97adf98898c9afe2f2ed4a7f8dba05a2dfab28ac9d9c604aa49a379",
10704                                  "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8001c0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e484040047304402207e8d51e0c570a5868a78414f4e0cbfaed1106b171b9581542c30718ee4eb95ba02203af84194c97adf98898c9afe2f2ed4a7f8dba05a2dfab28ac9d9c604aa49a3790147304402202ade0142008309eb376736575ad58d03e5b115499709c6db0b46e36ff394b492022037b63d78d66404d6504d4c4ac13be346f3d1802928a6d3ad95a6a944227161a201475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {});
10705
10706                 // anchors: commitment tx with one output untrimmed (minimum dust limit)
10707                 chan.context.value_to_self_msat = 6993000000; // 7000000000 - 7000000
10708                 chan.context.feerate_per_kw = 6216010;
10709                 chan.context.holder_dust_limit_satoshis = 4001;
10710                 chan.context.channel_type = ChannelTypeFeatures::anchors_zero_htlc_fee_and_dependencies();
10711
10712                 test_commitment_with_anchors!("30450221008fd5dbff02e4b59020d4cd23a3c30d3e287065fda75a0a09b402980adf68ccda022001e0b8b620cd915ddff11f1de32addf23d81d51b90e6841b2cb8dcaf3faa5ecf",
10713                                  "30450221009ad80792e3038fe6968d12ff23e6888a565c3ddd065037f357445f01675d63f3022018384915e5f1f4ae157e15debf4f49b61c8d9d2b073c7d6f97c4a68caa3ed4c1",
10714                                  "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b80024a01000000000000220020e9e86e4823faa62e222ebc858a226636856158f07e69898da3b0d1af0ddb3994c0c62d0000000000220020f3394e1e619b0eca1f91be2fb5ab4dfc59ba5b84ebe014ad1d43a564d012994a04004830450221009ad80792e3038fe6968d12ff23e6888a565c3ddd065037f357445f01675d63f3022018384915e5f1f4ae157e15debf4f49b61c8d9d2b073c7d6f97c4a68caa3ed4c1014830450221008fd5dbff02e4b59020d4cd23a3c30d3e287065fda75a0a09b402980adf68ccda022001e0b8b620cd915ddff11f1de32addf23d81d51b90e6841b2cb8dcaf3faa5ecf01475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {});
10715
10716                 // commitment tx with fee greater than funder amount
10717                 chan.context.value_to_self_msat = 6993000000; // 7000000000 - 7000000
10718                 chan.context.feerate_per_kw = 9651936;
10719                 chan.context.holder_dust_limit_satoshis = 546;
10720                 chan.context.channel_type = cached_channel_type;
10721
10722                 test_commitment!("304402202ade0142008309eb376736575ad58d03e5b115499709c6db0b46e36ff394b492022037b63d78d66404d6504d4c4ac13be346f3d1802928a6d3ad95a6a944227161a2",
10723                                  "304402207e8d51e0c570a5868a78414f4e0cbfaed1106b171b9581542c30718ee4eb95ba02203af84194c97adf98898c9afe2f2ed4a7f8dba05a2dfab28ac9d9c604aa49a379",
10724                                  "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8001c0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e484040047304402207e8d51e0c570a5868a78414f4e0cbfaed1106b171b9581542c30718ee4eb95ba02203af84194c97adf98898c9afe2f2ed4a7f8dba05a2dfab28ac9d9c604aa49a3790147304402202ade0142008309eb376736575ad58d03e5b115499709c6db0b46e36ff394b492022037b63d78d66404d6504d4c4ac13be346f3d1802928a6d3ad95a6a944227161a201475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {});
10725
10726                 // commitment tx with 3 htlc outputs, 2 offered having the same amount and preimage
10727                 chan.context.value_to_self_msat = 7_000_000_000 - 2_000_000;
10728                 chan.context.feerate_per_kw = 253;
10729                 chan.context.pending_inbound_htlcs.clear();
10730                 chan.context.pending_inbound_htlcs.push({
10731                         let mut out = InboundHTLCOutput{
10732                                 htlc_id: 1,
10733                                 amount_msat: 2000000,
10734                                 cltv_expiry: 501,
10735                                 payment_hash: PaymentHash([0; 32]),
10736                                 state: InboundHTLCState::Committed,
10737                         };
10738                         out.payment_hash.0 = Sha256::hash(&<Vec<u8>>::from_hex("0101010101010101010101010101010101010101010101010101010101010101").unwrap()).to_byte_array();
10739                         out
10740                 });
10741                 chan.context.pending_outbound_htlcs.clear();
10742                 chan.context.pending_outbound_htlcs.push({
10743                         let mut out = OutboundHTLCOutput{
10744                                 htlc_id: 6,
10745                                 amount_msat: 5000001,
10746                                 cltv_expiry: 506,
10747                                 payment_hash: PaymentHash([0; 32]),
10748                                 state: OutboundHTLCState::Committed,
10749                                 source: HTLCSource::dummy(),
10750                                 skimmed_fee_msat: None,
10751                                 blinding_point: None,
10752                         };
10753                         out.payment_hash.0 = Sha256::hash(&<Vec<u8>>::from_hex("0505050505050505050505050505050505050505050505050505050505050505").unwrap()).to_byte_array();
10754                         out
10755                 });
10756                 chan.context.pending_outbound_htlcs.push({
10757                         let mut out = OutboundHTLCOutput{
10758                                 htlc_id: 5,
10759                                 amount_msat: 5000000,
10760                                 cltv_expiry: 505,
10761                                 payment_hash: PaymentHash([0; 32]),
10762                                 state: OutboundHTLCState::Committed,
10763                                 source: HTLCSource::dummy(),
10764                                 skimmed_fee_msat: None,
10765                                 blinding_point: None,
10766                         };
10767                         out.payment_hash.0 = Sha256::hash(&<Vec<u8>>::from_hex("0505050505050505050505050505050505050505050505050505050505050505").unwrap()).to_byte_array();
10768                         out
10769                 });
10770
10771                 test_commitment!("304402207d0870964530f97b62497b11153c551dca0a1e226815ef0a336651158da0f82402200f5378beee0e77759147b8a0a284decd11bfd2bc55c8fafa41c134fe996d43c8",
10772                                  "304402200d10bf5bc5397fc59d7188ae438d80c77575595a2d488e41bd6363a810cc8d72022012b57e714fbbfdf7a28c47d5b370cb8ac37c8545f596216e5b21e9b236ef457c",
10773                                  "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8005d007000000000000220020748eba944fedc8827f6b06bc44678f93c0f9e6078b35c6331ed31e75f8ce0c2d8813000000000000220020305c12e1a0bc21e283c131cea1c66d68857d28b7b2fce0a6fbc40c164852121b8813000000000000220020305c12e1a0bc21e283c131cea1c66d68857d28b7b2fce0a6fbc40c164852121bc0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e484a69f6a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e040047304402200d10bf5bc5397fc59d7188ae438d80c77575595a2d488e41bd6363a810cc8d72022012b57e714fbbfdf7a28c47d5b370cb8ac37c8545f596216e5b21e9b236ef457c0147304402207d0870964530f97b62497b11153c551dca0a1e226815ef0a336651158da0f82402200f5378beee0e77759147b8a0a284decd11bfd2bc55c8fafa41c134fe996d43c801475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {
10774
10775                                   { 0,
10776                                   "3045022100b470fe12e5b7fea9eccb8cbff1972cea4f96758041898982a02bcc7f9d56d50b0220338a75b2afaab4ec00cdd2d9273c68c7581ff5a28bcbb40c4d138b81f1d45ce5",
10777                                   "3044022017b90c65207522a907fb6a137f9dd528b3389465a8ae72308d9e1d564f512cf402204fc917b4f0e88604a3e994f85bfae7c7c1f9d9e9f78e8cd112e0889720d9405b",
10778                                   "020000000001014bdccf28653066a2c554cafeffdfe1e678e64a69b056684deb0c4fba909423ec000000000000000000011f070000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100b470fe12e5b7fea9eccb8cbff1972cea4f96758041898982a02bcc7f9d56d50b0220338a75b2afaab4ec00cdd2d9273c68c7581ff5a28bcbb40c4d138b81f1d45ce501473044022017b90c65207522a907fb6a137f9dd528b3389465a8ae72308d9e1d564f512cf402204fc917b4f0e88604a3e994f85bfae7c7c1f9d9e9f78e8cd112e0889720d9405b012001010101010101010101010101010101010101010101010101010101010101018a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a9144b6b2e5444c2639cc0fb7bcea5afba3f3cdce23988527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f501b175ac686800000000" },
10779                                   { 1,
10780                                   "3045022100b575379f6d8743cb0087648f81cfd82d17a97fbf8f67e058c65ce8b9d25df9500220554a210d65b02d9f36c6adf0f639430ca8293196ba5089bf67cc3a9813b7b00a",
10781                                   "3045022100ee2e16b90930a479b13f8823a7f14b600198c838161160b9436ed086d3fc57e002202a66fa2324f342a17129949c640bfe934cbc73a869ba7c06aa25c5a3d0bfb53d",
10782                                   "020000000001014bdccf28653066a2c554cafeffdfe1e678e64a69b056684deb0c4fba909423ec01000000000000000001e1120000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100b575379f6d8743cb0087648f81cfd82d17a97fbf8f67e058c65ce8b9d25df9500220554a210d65b02d9f36c6adf0f639430ca8293196ba5089bf67cc3a9813b7b00a01483045022100ee2e16b90930a479b13f8823a7f14b600198c838161160b9436ed086d3fc57e002202a66fa2324f342a17129949c640bfe934cbc73a869ba7c06aa25c5a3d0bfb53d01008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9142002cc93ebefbb1b73f0af055dcc27a0b504ad7688ac6868f9010000" },
10783                                   { 2,
10784                                   "30440220471c9f3ad92e49b13b7b8059f43ecf8f7887b0dccbb9fdb54bfe23d62a8ae332022024bd22fae0740e86a44228c35330da9526fd7306dffb2b9dc362d5e78abef7cc",
10785                                   "304402207157f452f2506d73c315192311893800cfb3cc235cc1185b1cfcc136b55230db022014be242dbc6c5da141fec4034e7f387f74d6ff1899453d72ba957467540e1ecb",
10786                                   "020000000001014bdccf28653066a2c554cafeffdfe1e678e64a69b056684deb0c4fba909423ec02000000000000000001e1120000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e05004730440220471c9f3ad92e49b13b7b8059f43ecf8f7887b0dccbb9fdb54bfe23d62a8ae332022024bd22fae0740e86a44228c35330da9526fd7306dffb2b9dc362d5e78abef7cc0147304402207157f452f2506d73c315192311893800cfb3cc235cc1185b1cfcc136b55230db022014be242dbc6c5da141fec4034e7f387f74d6ff1899453d72ba957467540e1ecb01008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9142002cc93ebefbb1b73f0af055dcc27a0b504ad7688ac6868fa010000" }
10787                 } );
10788
10789                 chan.context.channel_type = ChannelTypeFeatures::anchors_zero_htlc_fee_and_dependencies();
10790                 test_commitment_with_anchors!("3044022027b38dfb654c34032ffb70bb43022981652fce923cbbe3cbe7394e2ade8b34230220584195b78da6e25c2e8da6b4308d9db25b65b64975db9266163ef592abb7c725",
10791                                  "3045022100b4014970d9d7962853f3f85196144671d7d5d87426250f0a5fdaf9a55292e92502205360910c9abb397467e19dbd63d081deb4a3240903114c98cec0a23591b79b76",
10792                                  "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b80074a010000000000002200202b1b5854183c12d3316565972c4668929d314d81c5dcdbb21cb45fe8a9a8114f4a01000000000000220020e9e86e4823faa62e222ebc858a226636856158f07e69898da3b0d1af0ddb3994d007000000000000220020fe0598d74fee2205cc3672e6e6647706b4f3099713b4661b62482c3addd04a5e881300000000000022002018e40f9072c44350f134bdc887bab4d9bdfc8aa468a25616c80e21757ba5dac7881300000000000022002018e40f9072c44350f134bdc887bab4d9bdfc8aa468a25616c80e21757ba5dac7c0c62d0000000000220020f3394e1e619b0eca1f91be2fb5ab4dfc59ba5b84ebe014ad1d43a564d012994aad9c6a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0400483045022100b4014970d9d7962853f3f85196144671d7d5d87426250f0a5fdaf9a55292e92502205360910c9abb397467e19dbd63d081deb4a3240903114c98cec0a23591b79b7601473044022027b38dfb654c34032ffb70bb43022981652fce923cbbe3cbe7394e2ade8b34230220584195b78da6e25c2e8da6b4308d9db25b65b64975db9266163ef592abb7c72501475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {
10793
10794                                   { 0,
10795                                   "30440220078fe5343dab88c348a3a8a9c1a9293259dbf35507ae971702cc39dd623ea9af022011ed0c0f35243cd0bb4d9ca3c772379b2b5f4af93140e9fdc5600dfec1cdb0c2",
10796                                   "304402205df665e2908c7690d2d33eb70e6e119958c28febe141a94ed0dd9a55ce7c8cfc0220364d02663a5d019af35c5cd5fda9465d985d85bbd12db207738d61163449a424",
10797                                   "020000000001013d060d0305c9616eaabc21d41fae85bcb5477b5d7f1c92aa429cf15339bbe1c402000000000100000001d0070000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e05004730440220078fe5343dab88c348a3a8a9c1a9293259dbf35507ae971702cc39dd623ea9af022011ed0c0f35243cd0bb4d9ca3c772379b2b5f4af93140e9fdc5600dfec1cdb0c28347304402205df665e2908c7690d2d33eb70e6e119958c28febe141a94ed0dd9a55ce7c8cfc0220364d02663a5d019af35c5cd5fda9465d985d85bbd12db207738d61163449a424012001010101010101010101010101010101010101010101010101010101010101018d76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a9144b6b2e5444c2639cc0fb7bcea5afba3f3cdce23988527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f501b175ac6851b2756800000000" },
10798                                   { 1,
10799                                   "304402202df6bf0f98a42cfd0172a16bded7d1b16c14f5f42ba23f5c54648c14b647531302200fe1508626817f23925bb56951d5e4b2654c751743ab6db48a6cce7dda17c01c",
10800                                   "304402203f99ec05cdd89558a23683b471c1dcce8f6a92295f1fff3b0b5d21be4d4f97ea022019d29070690fc2c126fe27cc4ab2f503f289d362721b2efa7418e7fddb939a5b",
10801                                   "020000000001013d060d0305c9616eaabc21d41fae85bcb5477b5d7f1c92aa429cf15339bbe1c40300000000010000000188130000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e050047304402202df6bf0f98a42cfd0172a16bded7d1b16c14f5f42ba23f5c54648c14b647531302200fe1508626817f23925bb56951d5e4b2654c751743ab6db48a6cce7dda17c01c8347304402203f99ec05cdd89558a23683b471c1dcce8f6a92295f1fff3b0b5d21be4d4f97ea022019d29070690fc2c126fe27cc4ab2f503f289d362721b2efa7418e7fddb939a5b01008876a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9142002cc93ebefbb1b73f0af055dcc27a0b504ad7688ac6851b27568f9010000" },
10802                                   { 2,
10803                                   "3045022100bd206b420c495f3aa714d3ea4766cbe95441deacb5d2f737f1913349aee7c2ae02200249d2c950dd3b15326bf378ae5d2b871d33d6737f5d70735f3de8383140f2a1",
10804                                   "3045022100f2cd35e385b9b7e15b92a5d78d120b6b2c5af4e974bc01e884c5facb3bb5966c0220706e0506477ce809a40022d6de8e041e9ef13136c45abee9c36f58a01fdb188b",
10805                                   "020000000001013d060d0305c9616eaabc21d41fae85bcb5477b5d7f1c92aa429cf15339bbe1c40400000000010000000188130000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100bd206b420c495f3aa714d3ea4766cbe95441deacb5d2f737f1913349aee7c2ae02200249d2c950dd3b15326bf378ae5d2b871d33d6737f5d70735f3de8383140f2a183483045022100f2cd35e385b9b7e15b92a5d78d120b6b2c5af4e974bc01e884c5facb3bb5966c0220706e0506477ce809a40022d6de8e041e9ef13136c45abee9c36f58a01fdb188b01008876a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9142002cc93ebefbb1b73f0af055dcc27a0b504ad7688ac6851b27568fa010000" }
10806                 } );
10807         }
10808
10809         #[test]
10810         fn test_per_commitment_secret_gen() {
10811                 // Test vectors from BOLT 3 Appendix D:
10812
10813                 let mut seed = [0; 32];
10814                 seed[0..32].clone_from_slice(&<Vec<u8>>::from_hex("0000000000000000000000000000000000000000000000000000000000000000").unwrap());
10815                 assert_eq!(chan_utils::build_commitment_secret(&seed, 281474976710655),
10816                            <Vec<u8>>::from_hex("02a40c85b6f28da08dfdbe0926c53fab2de6d28c10301f8f7c4073d5e42e3148").unwrap()[..]);
10817
10818                 seed[0..32].clone_from_slice(&<Vec<u8>>::from_hex("FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF").unwrap());
10819                 assert_eq!(chan_utils::build_commitment_secret(&seed, 281474976710655),
10820                            <Vec<u8>>::from_hex("7cc854b54e3e0dcdb010d7a3fee464a9687be6e8db3be6854c475621e007a5dc").unwrap()[..]);
10821
10822                 assert_eq!(chan_utils::build_commitment_secret(&seed, 0xaaaaaaaaaaa),
10823                            <Vec<u8>>::from_hex("56f4008fb007ca9acf0e15b054d5c9fd12ee06cea347914ddbaed70d1c13a528").unwrap()[..]);
10824
10825                 assert_eq!(chan_utils::build_commitment_secret(&seed, 0x555555555555),
10826                            <Vec<u8>>::from_hex("9015daaeb06dba4ccc05b91b2f73bd54405f2be9f217fbacd3c5ac2e62327d31").unwrap()[..]);
10827
10828                 seed[0..32].clone_from_slice(&<Vec<u8>>::from_hex("0101010101010101010101010101010101010101010101010101010101010101").unwrap());
10829                 assert_eq!(chan_utils::build_commitment_secret(&seed, 1),
10830                            <Vec<u8>>::from_hex("915c75942a26bb3a433a8ce2cb0427c29ec6c1775cfc78328b57f6ba7bfeaa9c").unwrap()[..]);
10831         }
10832
10833         #[test]
10834         fn test_key_derivation() {
10835                 // Test vectors from BOLT 3 Appendix E:
10836                 let secp_ctx = Secp256k1::new();
10837
10838                 let base_secret = SecretKey::from_slice(&<Vec<u8>>::from_hex("000102030405060708090a0b0c0d0e0f101112131415161718191a1b1c1d1e1f").unwrap()[..]).unwrap();
10839                 let per_commitment_secret = SecretKey::from_slice(&<Vec<u8>>::from_hex("1f1e1d1c1b1a191817161514131211100f0e0d0c0b0a09080706050403020100").unwrap()[..]).unwrap();
10840
10841                 let base_point = PublicKey::from_secret_key(&secp_ctx, &base_secret);
10842                 assert_eq!(base_point.serialize()[..], <Vec<u8>>::from_hex("036d6caac248af96f6afa7f904f550253a0f3ef3f5aa2fe6838a95b216691468e2").unwrap()[..]);
10843
10844                 let per_commitment_point = PublicKey::from_secret_key(&secp_ctx, &per_commitment_secret);
10845                 assert_eq!(per_commitment_point.serialize()[..], <Vec<u8>>::from_hex("025f7117a78150fe2ef97db7cfc83bd57b2e2c0d0dd25eaf467a4a1c2a45ce1486").unwrap()[..]);
10846
10847                 assert_eq!(chan_utils::derive_private_key(&secp_ctx, &per_commitment_point, &base_secret),
10848                                 SecretKey::from_slice(&<Vec<u8>>::from_hex("cbced912d3b21bf196a766651e436aff192362621ce317704ea2f75d87e7be0f").unwrap()[..]).unwrap());
10849
10850                 assert_eq!(RevocationKey::from_basepoint(&secp_ctx, &RevocationBasepoint::from(base_point), &per_commitment_point).to_public_key().serialize()[..],
10851                                 <Vec<u8>>::from_hex("02916e326636d19c33f13e8c0c3a03dd157f332f3e99c317c141dd865eb01f8ff0").unwrap()[..]);
10852
10853                 assert_eq!(chan_utils::derive_private_revocation_key(&secp_ctx, &per_commitment_secret, &base_secret),
10854                                 SecretKey::from_slice(&<Vec<u8>>::from_hex("d09ffff62ddb2297ab000cc85bcb4283fdeb6aa052affbc9dddcf33b61078110").unwrap()[..]).unwrap());
10855         }
10856
10857         #[test]
10858         fn test_zero_conf_channel_type_support() {
10859                 let feeest = LowerBoundedFeeEstimator::new(&TestFeeEstimator{fee_est: 15000});
10860                 let secp_ctx = Secp256k1::new();
10861                 let seed = [42; 32];
10862                 let network = Network::Testnet;
10863                 let keys_provider = test_utils::TestKeysInterface::new(&seed, network);
10864                 let logger = test_utils::TestLogger::new();
10865
10866                 let node_b_node_id = PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[42; 32]).unwrap());
10867                 let config = UserConfig::default();
10868                 let node_a_chan = OutboundV1Channel::<&TestKeysInterface>::new(&feeest, &&keys_provider, &&keys_provider,
10869                         node_b_node_id, &channelmanager::provided_init_features(&config), 10000000, 100000, 42, &config, 0, 42, None).unwrap();
10870
10871                 let mut channel_type_features = ChannelTypeFeatures::only_static_remote_key();
10872                 channel_type_features.set_zero_conf_required();
10873
10874                 let mut open_channel_msg = node_a_chan.get_open_channel(ChainHash::using_genesis_block(network));
10875                 open_channel_msg.common_fields.channel_type = Some(channel_type_features);
10876                 let node_b_node_id = PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[7; 32]).unwrap());
10877                 let res = InboundV1Channel::<&TestKeysInterface>::new(&feeest, &&keys_provider, &&keys_provider,
10878                         node_b_node_id, &channelmanager::provided_channel_type_features(&config),
10879                         &channelmanager::provided_init_features(&config), &open_channel_msg, 7, &config, 0, &&logger, /*is_0conf=*/false);
10880                 assert!(res.is_ok());
10881         }
10882
10883         #[test]
10884         fn test_supports_anchors_zero_htlc_tx_fee() {
10885                 // Tests that if both sides support and negotiate `anchors_zero_fee_htlc_tx`, it is the
10886                 // resulting `channel_type`.
10887                 let secp_ctx = Secp256k1::new();
10888                 let fee_estimator = LowerBoundedFeeEstimator::new(&TestFeeEstimator{fee_est: 15000});
10889                 let network = Network::Testnet;
10890                 let keys_provider = test_utils::TestKeysInterface::new(&[42; 32], network);
10891                 let logger = test_utils::TestLogger::new();
10892
10893                 let node_id_a = PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[1; 32]).unwrap());
10894                 let node_id_b = PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[2; 32]).unwrap());
10895
10896                 let mut config = UserConfig::default();
10897                 config.channel_handshake_config.negotiate_anchors_zero_fee_htlc_tx = true;
10898
10899                 // It is not enough for just the initiator to signal `option_anchors_zero_fee_htlc_tx`, both
10900                 // need to signal it.
10901                 let channel_a = OutboundV1Channel::<&TestKeysInterface>::new(
10902                         &fee_estimator, &&keys_provider, &&keys_provider, node_id_b,
10903                         &channelmanager::provided_init_features(&UserConfig::default()), 10000000, 100000, 42,
10904                         &config, 0, 42, None
10905                 ).unwrap();
10906                 assert!(!channel_a.context.channel_type.supports_anchors_zero_fee_htlc_tx());
10907
10908                 let mut expected_channel_type = ChannelTypeFeatures::empty();
10909                 expected_channel_type.set_static_remote_key_required();
10910                 expected_channel_type.set_anchors_zero_fee_htlc_tx_required();
10911
10912                 let channel_a = OutboundV1Channel::<&TestKeysInterface>::new(
10913                         &fee_estimator, &&keys_provider, &&keys_provider, node_id_b,
10914                         &channelmanager::provided_init_features(&config), 10000000, 100000, 42, &config, 0, 42,
10915                         None
10916                 ).unwrap();
10917
10918                 let open_channel_msg = channel_a.get_open_channel(ChainHash::using_genesis_block(network));
10919                 let channel_b = InboundV1Channel::<&TestKeysInterface>::new(
10920                         &fee_estimator, &&keys_provider, &&keys_provider, node_id_a,
10921                         &channelmanager::provided_channel_type_features(&config), &channelmanager::provided_init_features(&config),
10922                         &open_channel_msg, 7, &config, 0, &&logger, /*is_0conf=*/false
10923                 ).unwrap();
10924
10925                 assert_eq!(channel_a.context.channel_type, expected_channel_type);
10926                 assert_eq!(channel_b.context.channel_type, expected_channel_type);
10927         }
10928
10929         #[test]
10930         fn test_rejects_implicit_simple_anchors() {
10931                 // Tests that if `option_anchors` is being negotiated implicitly through the intersection of
10932                 // each side's `InitFeatures`, it is rejected.
10933                 let secp_ctx = Secp256k1::new();
10934                 let fee_estimator = LowerBoundedFeeEstimator::new(&TestFeeEstimator{fee_est: 15000});
10935                 let network = Network::Testnet;
10936                 let keys_provider = test_utils::TestKeysInterface::new(&[42; 32], network);
10937                 let logger = test_utils::TestLogger::new();
10938
10939                 let node_id_a = PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[1; 32]).unwrap());
10940                 let node_id_b = PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[2; 32]).unwrap());
10941
10942                 let config = UserConfig::default();
10943
10944                 // See feature bit assignments: https://github.com/lightning/bolts/blob/master/09-features.md
10945                 let static_remote_key_required: u64 = 1 << 12;
10946                 let simple_anchors_required: u64 = 1 << 20;
10947                 let raw_init_features = static_remote_key_required | simple_anchors_required;
10948                 let init_features_with_simple_anchors = InitFeatures::from_le_bytes(raw_init_features.to_le_bytes().to_vec());
10949
10950                 let channel_a = OutboundV1Channel::<&TestKeysInterface>::new(
10951                         &fee_estimator, &&keys_provider, &&keys_provider, node_id_b,
10952                         &channelmanager::provided_init_features(&config), 10000000, 100000, 42, &config, 0, 42,
10953                         None
10954                 ).unwrap();
10955
10956                 // Set `channel_type` to `None` to force the implicit feature negotiation.
10957                 let mut open_channel_msg = channel_a.get_open_channel(ChainHash::using_genesis_block(network));
10958                 open_channel_msg.common_fields.channel_type = None;
10959
10960                 // Since A supports both `static_remote_key` and `option_anchors`, but B only accepts
10961                 // `static_remote_key`, it will fail the channel.
10962                 let channel_b = InboundV1Channel::<&TestKeysInterface>::new(
10963                         &fee_estimator, &&keys_provider, &&keys_provider, node_id_a,
10964                         &channelmanager::provided_channel_type_features(&config), &init_features_with_simple_anchors,
10965                         &open_channel_msg, 7, &config, 0, &&logger, /*is_0conf=*/false
10966                 );
10967                 assert!(channel_b.is_err());
10968         }
10969
10970         #[test]
10971         fn test_rejects_simple_anchors_channel_type() {
10972                 // Tests that if `option_anchors` is being negotiated through the `channel_type` feature,
10973                 // it is rejected.
10974                 let secp_ctx = Secp256k1::new();
10975                 let fee_estimator = LowerBoundedFeeEstimator::new(&TestFeeEstimator{fee_est: 15000});
10976                 let network = Network::Testnet;
10977                 let keys_provider = test_utils::TestKeysInterface::new(&[42; 32], network);
10978                 let logger = test_utils::TestLogger::new();
10979
10980                 let node_id_a = PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[1; 32]).unwrap());
10981                 let node_id_b = PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[2; 32]).unwrap());
10982
10983                 let config = UserConfig::default();
10984
10985                 // See feature bit assignments: https://github.com/lightning/bolts/blob/master/09-features.md
10986                 let static_remote_key_required: u64 = 1 << 12;
10987                 let simple_anchors_required: u64 = 1 << 20;
10988                 let simple_anchors_raw_features = static_remote_key_required | simple_anchors_required;
10989                 let simple_anchors_init = InitFeatures::from_le_bytes(simple_anchors_raw_features.to_le_bytes().to_vec());
10990                 let simple_anchors_channel_type = ChannelTypeFeatures::from_le_bytes(simple_anchors_raw_features.to_le_bytes().to_vec());
10991                 assert!(!simple_anchors_init.requires_unknown_bits());
10992                 assert!(!simple_anchors_channel_type.requires_unknown_bits());
10993
10994                 // First, we'll try to open a channel between A and B where A requests a channel type for
10995                 // the original `option_anchors` feature (non zero fee htlc tx). This should be rejected by
10996                 // B as it's not supported by LDK.
10997                 let channel_a = OutboundV1Channel::<&TestKeysInterface>::new(
10998                         &fee_estimator, &&keys_provider, &&keys_provider, node_id_b,
10999                         &channelmanager::provided_init_features(&config), 10000000, 100000, 42, &config, 0, 42,
11000                         None
11001                 ).unwrap();
11002
11003                 let mut open_channel_msg = channel_a.get_open_channel(ChainHash::using_genesis_block(network));
11004                 open_channel_msg.common_fields.channel_type = Some(simple_anchors_channel_type.clone());
11005
11006                 let res = InboundV1Channel::<&TestKeysInterface>::new(
11007                         &fee_estimator, &&keys_provider, &&keys_provider, node_id_a,
11008                         &channelmanager::provided_channel_type_features(&config), &simple_anchors_init,
11009                         &open_channel_msg, 7, &config, 0, &&logger, /*is_0conf=*/false
11010                 );
11011                 assert!(res.is_err());
11012
11013                 // Then, we'll try to open another channel where A requests a channel type for
11014                 // `anchors_zero_fee_htlc_tx`. B is malicious and tries to downgrade the channel type to the
11015                 // original `option_anchors` feature, which should be rejected by A as it's not supported by
11016                 // LDK.
11017                 let mut channel_a = OutboundV1Channel::<&TestKeysInterface>::new(
11018                         &fee_estimator, &&keys_provider, &&keys_provider, node_id_b, &simple_anchors_init,
11019                         10000000, 100000, 42, &config, 0, 42, None
11020                 ).unwrap();
11021
11022                 let open_channel_msg = channel_a.get_open_channel(ChainHash::using_genesis_block(network));
11023
11024                 let channel_b = InboundV1Channel::<&TestKeysInterface>::new(
11025                         &fee_estimator, &&keys_provider, &&keys_provider, node_id_a,
11026                         &channelmanager::provided_channel_type_features(&config), &channelmanager::provided_init_features(&config),
11027                         &open_channel_msg, 7, &config, 0, &&logger, /*is_0conf=*/false
11028                 ).unwrap();
11029
11030                 let mut accept_channel_msg = channel_b.get_accept_channel_message();
11031                 accept_channel_msg.common_fields.channel_type = Some(simple_anchors_channel_type.clone());
11032
11033                 let res = channel_a.accept_channel(
11034                         &accept_channel_msg, &config.channel_handshake_limits, &simple_anchors_init
11035                 );
11036                 assert!(res.is_err());
11037         }
11038
11039         #[test]
11040         fn test_waiting_for_batch() {
11041                 let feeest = LowerBoundedFeeEstimator::new(&TestFeeEstimator{fee_est: 15000});
11042                 let logger = test_utils::TestLogger::new();
11043                 let secp_ctx = Secp256k1::new();
11044                 let seed = [42; 32];
11045                 let network = Network::Testnet;
11046                 let best_block = BestBlock::from_network(network);
11047                 let chain_hash = ChainHash::using_genesis_block(network);
11048                 let keys_provider = test_utils::TestKeysInterface::new(&seed, network);
11049
11050                 let mut config = UserConfig::default();
11051                 // Set trust_own_funding_0conf while ensuring we don't send channel_ready for a
11052                 // channel in a batch before all channels are ready.
11053                 config.channel_handshake_limits.trust_own_funding_0conf = true;
11054
11055                 // Create a channel from node a to node b that will be part of batch funding.
11056                 let node_b_node_id = PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[42; 32]).unwrap());
11057                 let mut node_a_chan = OutboundV1Channel::<&TestKeysInterface>::new(
11058                         &feeest,
11059                         &&keys_provider,
11060                         &&keys_provider,
11061                         node_b_node_id,
11062                         &channelmanager::provided_init_features(&config),
11063                         10000000,
11064                         100000,
11065                         42,
11066                         &config,
11067                         0,
11068                         42,
11069                         None
11070                 ).unwrap();
11071
11072                 let open_channel_msg = node_a_chan.get_open_channel(ChainHash::using_genesis_block(network));
11073                 let node_b_node_id = PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[7; 32]).unwrap());
11074                 let mut node_b_chan = InboundV1Channel::<&TestKeysInterface>::new(
11075                         &feeest,
11076                         &&keys_provider,
11077                         &&keys_provider,
11078                         node_b_node_id,
11079                         &channelmanager::provided_channel_type_features(&config),
11080                         &channelmanager::provided_init_features(&config),
11081                         &open_channel_msg,
11082                         7,
11083                         &config,
11084                         0,
11085                         &&logger,
11086                         true,  // Allow node b to send a 0conf channel_ready.
11087                 ).unwrap();
11088
11089                 let accept_channel_msg = node_b_chan.accept_inbound_channel();
11090                 node_a_chan.accept_channel(
11091                         &accept_channel_msg,
11092                         &config.channel_handshake_limits,
11093                         &channelmanager::provided_init_features(&config),
11094                 ).unwrap();
11095
11096                 // Fund the channel with a batch funding transaction.
11097                 let output_script = node_a_chan.context.get_funding_redeemscript();
11098                 let tx = Transaction {
11099                         version: 1,
11100                         lock_time: LockTime::ZERO,
11101                         input: Vec::new(),
11102                         output: vec![
11103                                 TxOut {
11104                                         value: 10000000, script_pubkey: output_script.clone(),
11105                                 },
11106                                 TxOut {
11107                                         value: 10000000, script_pubkey: Builder::new().into_script(),
11108                                 },
11109                         ]};
11110                 let funding_outpoint = OutPoint{ txid: tx.txid(), index: 0 };
11111                 let funding_created_msg = node_a_chan.get_funding_created(
11112                         tx.clone(), funding_outpoint, true, &&logger,
11113                 ).map_err(|_| ()).unwrap();
11114                 let (mut node_b_chan, funding_signed_msg, _) = node_b_chan.funding_created(
11115                         &funding_created_msg.unwrap(),
11116                         best_block,
11117                         &&keys_provider,
11118                         &&logger,
11119                 ).map_err(|_| ()).unwrap();
11120                 let node_b_updates = node_b_chan.monitor_updating_restored(
11121                         &&logger,
11122                         &&keys_provider,
11123                         chain_hash,
11124                         &config,
11125                         0,
11126                 );
11127
11128                 // Receive funding_signed, but the channel will be configured to hold sending channel_ready and
11129                 // broadcasting the funding transaction until the batch is ready.
11130                 let res = node_a_chan.funding_signed(
11131                         &funding_signed_msg.unwrap(), best_block, &&keys_provider, &&logger,
11132                 );
11133                 let (mut node_a_chan, _) = if let Ok(res) = res { res } else { panic!(); };
11134                 let node_a_updates = node_a_chan.monitor_updating_restored(
11135                         &&logger,
11136                         &&keys_provider,
11137                         chain_hash,
11138                         &config,
11139                         0,
11140                 );
11141                 // Our channel_ready shouldn't be sent yet, even with trust_own_funding_0conf set,
11142                 // as the funding transaction depends on all channels in the batch becoming ready.
11143                 assert!(node_a_updates.channel_ready.is_none());
11144                 assert!(node_a_updates.funding_broadcastable.is_none());
11145                 assert_eq!(node_a_chan.context.channel_state, ChannelState::AwaitingChannelReady(AwaitingChannelReadyFlags::WAITING_FOR_BATCH));
11146
11147                 // It is possible to receive a 0conf channel_ready from the remote node.
11148                 node_a_chan.channel_ready(
11149                         &node_b_updates.channel_ready.unwrap(),
11150                         &&keys_provider,
11151                         chain_hash,
11152                         &config,
11153                         &best_block,
11154                         &&logger,
11155                 ).unwrap();
11156                 assert_eq!(
11157                         node_a_chan.context.channel_state,
11158                         ChannelState::AwaitingChannelReady(AwaitingChannelReadyFlags::WAITING_FOR_BATCH | AwaitingChannelReadyFlags::THEIR_CHANNEL_READY)
11159                 );
11160
11161                 // Clear the ChannelState::WaitingForBatch only when called by ChannelManager.
11162                 node_a_chan.set_batch_ready();
11163                 assert_eq!(node_a_chan.context.channel_state, ChannelState::AwaitingChannelReady(AwaitingChannelReadyFlags::THEIR_CHANNEL_READY));
11164                 assert!(node_a_chan.check_get_channel_ready(0).is_some());
11165         }
11166 }