Update bitcoin crate to 0.29.0
[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::script::{Script,Builder};
11 use bitcoin::blockdata::transaction::{Transaction, EcdsaSighashType};
12 use bitcoin::util::sighash;
13 use bitcoin::consensus::encode;
14
15 use bitcoin::hashes::Hash;
16 use bitcoin::hashes::sha256::Hash as Sha256;
17 use bitcoin::hashes::sha256d::Hash as Sha256d;
18 use bitcoin::hash_types::{Txid, BlockHash};
19
20 use bitcoin::secp256k1::constants::PUBLIC_KEY_SIZE;
21 use bitcoin::secp256k1::{PublicKey,SecretKey};
22 use bitcoin::secp256k1::{Secp256k1,ecdsa::Signature};
23 use bitcoin::secp256k1;
24
25 use ln::{PaymentPreimage, PaymentHash};
26 use ln::features::{ChannelFeatures, ChannelTypeFeatures, InitFeatures};
27 use ln::msgs;
28 use ln::msgs::{DecodeError, OptionalField, DataLossProtect};
29 use ln::script::{self, ShutdownScript};
30 use ln::channelmanager::{CounterpartyForwardingInfo, PendingHTLCStatus, HTLCSource, HTLCFailReason, HTLCFailureMsg, PendingHTLCInfo, RAACommitmentOrder, BREAKDOWN_TIMEOUT, MIN_CLTV_EXPIRY_DELTA, MAX_LOCAL_BREAKDOWN_TIMEOUT};
31 use 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};
32 use ln::chan_utils;
33 use chain::BestBlock;
34 use chain::chaininterface::{FeeEstimator, ConfirmationTarget, LowerBoundedFeeEstimator};
35 use chain::channelmonitor::{ChannelMonitor, ChannelMonitorUpdate, ChannelMonitorUpdateStep, LATENCY_GRACE_PERIOD_BLOCKS};
36 use chain::transaction::{OutPoint, TransactionData};
37 use chain::keysinterface::{Sign, KeysInterface};
38 use util::events::ClosureReason;
39 use util::ser::{Readable, ReadableArgs, Writeable, Writer, VecWriter};
40 use util::logger::Logger;
41 use util::errors::APIError;
42 use util::config::{UserConfig, ChannelConfig, LegacyChannelConfig, ChannelHandshakeConfig, ChannelHandshakeLimits};
43 use util::scid_utils::scid_from_parts;
44
45 use io;
46 use prelude::*;
47 use core::{cmp,mem,fmt};
48 use core::ops::Deref;
49 #[cfg(any(test, fuzzing, debug_assertions))]
50 use sync::Mutex;
51 use bitcoin::hashes::hex::ToHex;
52
53 #[cfg(test)]
54 pub struct ChannelValueStat {
55         pub value_to_self_msat: u64,
56         pub channel_value_msat: u64,
57         pub channel_reserve_msat: u64,
58         pub pending_outbound_htlcs_amount_msat: u64,
59         pub pending_inbound_htlcs_amount_msat: u64,
60         pub holding_cell_outbound_amount_msat: u64,
61         pub counterparty_max_htlc_value_in_flight_msat: u64, // outgoing
62         pub counterparty_dust_limit_msat: u64,
63 }
64
65 pub struct AvailableBalances {
66         /// The amount that would go to us if we close the channel, ignoring any on-chain fees.
67         pub balance_msat: u64,
68         /// Total amount available for our counterparty to send to us.
69         pub inbound_capacity_msat: u64,
70         /// Total amount available for us to send to our counterparty.
71         pub outbound_capacity_msat: u64,
72         /// The maximum value we can assign to the next outbound HTLC
73         pub next_outbound_htlc_limit_msat: u64,
74 }
75
76 #[derive(Debug, Clone, Copy, PartialEq)]
77 enum FeeUpdateState {
78         // Inbound states mirroring InboundHTLCState
79         RemoteAnnounced,
80         AwaitingRemoteRevokeToAnnounce,
81         // Note that we do not have a AwaitingAnnouncedRemoteRevoke variant here as it is universally
82         // handled the same as `Committed`, with the only exception in `InboundHTLCState` being the
83         // distinction of when we allow ourselves to forward the HTLC. Because we aren't "forwarding"
84         // the fee update anywhere, we can simply consider the fee update `Committed` immediately
85         // instead of setting it to AwaitingAnnouncedRemoteRevoke.
86
87         // Outbound state can only be `LocalAnnounced` or `Committed`
88         Outbound,
89 }
90
91 enum InboundHTLCRemovalReason {
92         FailRelay(msgs::OnionErrorPacket),
93         FailMalformed(([u8; 32], u16)),
94         Fulfill(PaymentPreimage),
95 }
96
97 enum InboundHTLCState {
98         /// Offered by remote, to be included in next local commitment tx. I.e., the remote sent an
99         /// update_add_htlc message for this HTLC.
100         RemoteAnnounced(PendingHTLCStatus),
101         /// Included in a received commitment_signed message (implying we've
102         /// revoke_and_ack'd it), but the remote hasn't yet revoked their previous
103         /// state (see the example below). We have not yet included this HTLC in a
104         /// commitment_signed message because we are waiting on the remote's
105         /// aforementioned state revocation. One reason this missing remote RAA
106         /// (revoke_and_ack) blocks us from constructing a commitment_signed message
107         /// is because every time we create a new "state", i.e. every time we sign a
108         /// new commitment tx (see [BOLT #2]), we need a new per_commitment_point,
109         /// which are provided one-at-a-time in each RAA. E.g., the last RAA they
110         /// sent provided the per_commitment_point for our current commitment tx.
111         /// The other reason we should not send a commitment_signed without their RAA
112         /// is because their RAA serves to ACK our previous commitment_signed.
113         ///
114         /// Here's an example of how an HTLC could come to be in this state:
115         /// remote --> update_add_htlc(prev_htlc)   --> local
116         /// remote --> commitment_signed(prev_htlc) --> local
117         /// remote <-- revoke_and_ack               <-- local
118         /// remote <-- commitment_signed(prev_htlc) <-- local
119         /// [note that here, the remote does not respond with a RAA]
120         /// remote --> update_add_htlc(this_htlc)   --> local
121         /// remote --> commitment_signed(prev_htlc, this_htlc) --> local
122         /// Now `this_htlc` will be assigned this state. It's unable to be officially
123         /// accepted, i.e. included in a commitment_signed, because we're missing the
124         /// RAA that provides our next per_commitment_point. The per_commitment_point
125         /// is used to derive commitment keys, which are used to construct the
126         /// signatures in a commitment_signed message.
127         /// Implies AwaitingRemoteRevoke.
128         ///
129         /// [BOLT #2]: https://github.com/lightning/bolts/blob/master/02-peer-protocol.md
130         AwaitingRemoteRevokeToAnnounce(PendingHTLCStatus),
131         /// Included in a received commitment_signed message (implying we've revoke_and_ack'd it).
132         /// We have also included this HTLC in our latest commitment_signed and are now just waiting
133         /// on the remote's revoke_and_ack to make this HTLC an irrevocable part of the state of the
134         /// channel (before it can then get forwarded and/or removed).
135         /// Implies AwaitingRemoteRevoke.
136         AwaitingAnnouncedRemoteRevoke(PendingHTLCStatus),
137         Committed,
138         /// Removed by us and a new commitment_signed was sent (if we were AwaitingRemoteRevoke when we
139         /// created it we would have put it in the holding cell instead). When they next revoke_and_ack
140         /// we'll drop it.
141         /// Note that we have to keep an eye on the HTLC until we've received a broadcastable
142         /// commitment transaction without it as otherwise we'll have to force-close the channel to
143         /// claim it before the timeout (obviously doesn't apply to revoked HTLCs that we can't claim
144         /// anyway). That said, ChannelMonitor does this for us (see
145         /// ChannelMonitor::should_broadcast_holder_commitment_txn) so we actually remove the HTLC from
146         /// our own local state before then, once we're sure that the next commitment_signed and
147         /// ChannelMonitor::provide_latest_local_commitment_tx will not include this HTLC.
148         LocalRemoved(InboundHTLCRemovalReason),
149 }
150
151 struct InboundHTLCOutput {
152         htlc_id: u64,
153         amount_msat: u64,
154         cltv_expiry: u32,
155         payment_hash: PaymentHash,
156         state: InboundHTLCState,
157 }
158
159 enum OutboundHTLCState {
160         /// Added by us and included in a commitment_signed (if we were AwaitingRemoteRevoke when we
161         /// created it we would have put it in the holding cell instead). When they next revoke_and_ack
162         /// we will promote to Committed (note that they may not accept it until the next time we
163         /// revoke, but we don't really care about that:
164         ///  * they've revoked, so worst case we can announce an old state and get our (option on)
165         ///    money back (though we won't), and,
166         ///  * we'll send them a revoke when they send a commitment_signed, and since only they're
167         ///    allowed to remove it, the "can only be removed once committed on both sides" requirement
168         ///    doesn't matter to us and it's up to them to enforce it, worst-case they jump ahead but
169         ///    we'll never get out of sync).
170         /// Note that we Box the OnionPacket as it's rather large and we don't want to blow up
171         /// OutboundHTLCOutput's size just for a temporary bit
172         LocalAnnounced(Box<msgs::OnionPacket>),
173         Committed,
174         /// Remote removed this (outbound) HTLC. We're waiting on their commitment_signed to finalize
175         /// the change (though they'll need to revoke before we fail the payment).
176         RemoteRemoved(OutboundHTLCOutcome),
177         /// Remote removed this and sent a commitment_signed (implying we've revoke_and_ack'ed it), but
178         /// the remote side hasn't yet revoked their previous state, which we need them to do before we
179         /// can do any backwards failing. Implies AwaitingRemoteRevoke.
180         /// We also have not yet removed this HTLC in a commitment_signed message, and are waiting on a
181         /// remote revoke_and_ack on a previous state before we can do so.
182         AwaitingRemoteRevokeToRemove(OutboundHTLCOutcome),
183         /// Remote removed this and sent a commitment_signed (implying we've revoke_and_ack'ed it), but
184         /// the remote side hasn't yet revoked their previous state, which we need them to do before we
185         /// can do any backwards failing. Implies AwaitingRemoteRevoke.
186         /// We have removed this HTLC in our latest commitment_signed and are now just waiting on a
187         /// revoke_and_ack to drop completely.
188         AwaitingRemovedRemoteRevoke(OutboundHTLCOutcome),
189 }
190
191 #[derive(Clone)]
192 enum OutboundHTLCOutcome {
193         Success(Option<PaymentPreimage>),
194         Failure(HTLCFailReason),
195 }
196
197 impl From<Option<HTLCFailReason>> for OutboundHTLCOutcome {
198         fn from(o: Option<HTLCFailReason>) -> Self {
199                 match o {
200                         None => OutboundHTLCOutcome::Success(None),
201                         Some(r) => OutboundHTLCOutcome::Failure(r)
202                 }
203         }
204 }
205
206 impl<'a> Into<Option<&'a HTLCFailReason>> for &'a OutboundHTLCOutcome {
207         fn into(self) -> Option<&'a HTLCFailReason> {
208                 match self {
209                         OutboundHTLCOutcome::Success(_) => None,
210                         OutboundHTLCOutcome::Failure(ref r) => Some(r)
211                 }
212         }
213 }
214
215 struct OutboundHTLCOutput {
216         htlc_id: u64,
217         amount_msat: u64,
218         cltv_expiry: u32,
219         payment_hash: PaymentHash,
220         state: OutboundHTLCState,
221         source: HTLCSource,
222 }
223
224 /// See AwaitingRemoteRevoke ChannelState for more info
225 enum HTLCUpdateAwaitingACK {
226         AddHTLC { // TODO: Time out if we're getting close to cltv_expiry
227                 // always outbound
228                 amount_msat: u64,
229                 cltv_expiry: u32,
230                 payment_hash: PaymentHash,
231                 source: HTLCSource,
232                 onion_routing_packet: msgs::OnionPacket,
233         },
234         ClaimHTLC {
235                 payment_preimage: PaymentPreimage,
236                 htlc_id: u64,
237         },
238         FailHTLC {
239                 htlc_id: u64,
240                 err_packet: msgs::OnionErrorPacket,
241         },
242 }
243
244 /// There are a few "states" and then a number of flags which can be applied:
245 /// We first move through init with OurInitSent -> TheirInitSent -> FundingCreated -> FundingSent.
246 /// TheirChannelReady and OurChannelReady then get set on FundingSent, and when both are set we
247 /// move on to ChannelFunded.
248 /// Note that PeerDisconnected can be set on both ChannelFunded and FundingSent.
249 /// ChannelFunded can then get all remaining flags set on it, until we finish shutdown, then we
250 /// move on to ShutdownComplete, at which point most calls into this channel are disallowed.
251 enum ChannelState {
252         /// Implies we have (or are prepared to) send our open_channel/accept_channel message
253         OurInitSent = 1 << 0,
254         /// Implies we have received their open_channel/accept_channel message
255         TheirInitSent = 1 << 1,
256         /// We have sent funding_created and are awaiting a funding_signed to advance to FundingSent.
257         /// Note that this is nonsense for an inbound channel as we immediately generate funding_signed
258         /// upon receipt of funding_created, so simply skip this state.
259         FundingCreated = 4,
260         /// Set when we have received/sent funding_created and funding_signed and are thus now waiting
261         /// on the funding transaction to confirm. The ChannelReady flags are set to indicate when we
262         /// and our counterparty consider the funding transaction confirmed.
263         FundingSent = 8,
264         /// Flag which can be set on FundingSent to indicate they sent us a channel_ready message.
265         /// Once both TheirChannelReady and OurChannelReady are set, state moves on to ChannelFunded.
266         TheirChannelReady = 1 << 4,
267         /// Flag which can be set on FundingSent to indicate we sent them a channel_ready message.
268         /// Once both TheirChannelReady and OurChannelReady are set, state moves on to ChannelFunded.
269         OurChannelReady = 1 << 5,
270         ChannelFunded = 64,
271         /// Flag which is set on ChannelFunded and FundingSent indicating remote side is considered
272         /// "disconnected" and no updates are allowed until after we've done a channel_reestablish
273         /// dance.
274         PeerDisconnected = 1 << 7,
275         /// Flag which is set on ChannelFunded, FundingCreated, and FundingSent indicating the user has
276         /// told us they failed to update our ChannelMonitor somewhere and we should pause sending any
277         /// outbound messages until they've managed to do so.
278         MonitorUpdateFailed = 1 << 8,
279         /// Flag which implies that we have sent a commitment_signed but are awaiting the responding
280         /// revoke_and_ack message. During this time period, we can't generate new commitment_signed
281         /// messages as then we will be unable to determine which HTLCs they included in their
282         /// revoke_and_ack implicit ACK, so instead we have to hold them away temporarily to be sent
283         /// later.
284         /// Flag is set on ChannelFunded.
285         AwaitingRemoteRevoke = 1 << 9,
286         /// Flag which is set on ChannelFunded or FundingSent after receiving a shutdown message from
287         /// the remote end. If set, they may not add any new HTLCs to the channel, and we are expected
288         /// to respond with our own shutdown message when possible.
289         RemoteShutdownSent = 1 << 10,
290         /// Flag which is set on ChannelFunded or FundingSent after sending a shutdown message. At this
291         /// point, we may not add any new HTLCs to the channel.
292         LocalShutdownSent = 1 << 11,
293         /// We've successfully negotiated a closing_signed dance. At this point ChannelManager is about
294         /// to drop us, but we store this anyway.
295         ShutdownComplete = 4096,
296 }
297 const BOTH_SIDES_SHUTDOWN_MASK: u32 = ChannelState::LocalShutdownSent as u32 | ChannelState::RemoteShutdownSent as u32;
298 const MULTI_STATE_FLAGS: u32 = BOTH_SIDES_SHUTDOWN_MASK | ChannelState::PeerDisconnected as u32 | ChannelState::MonitorUpdateFailed as u32;
299
300 pub const INITIAL_COMMITMENT_NUMBER: u64 = (1 << 48) - 1;
301
302 /// The "channel disabled" bit in channel_update must be set based on whether we are connected to
303 /// our counterparty or not. However, we don't want to announce updates right away to avoid
304 /// spamming the network with updates if the connection is flapping. Instead, we "stage" updates to
305 /// our channel_update message and track the current state here.
306 /// See implementation at [`super::channelmanager::ChannelManager::timer_tick_occurred`].
307 #[derive(Clone, Copy, PartialEq)]
308 pub(super) enum ChannelUpdateStatus {
309         /// We've announced the channel as enabled and are connected to our peer.
310         Enabled,
311         /// Our channel is no longer live, but we haven't announced the channel as disabled yet.
312         DisabledStaged,
313         /// Our channel is live again, but we haven't announced the channel as enabled yet.
314         EnabledStaged,
315         /// We've announced the channel as disabled.
316         Disabled,
317 }
318
319 /// We track when we sent an `AnnouncementSignatures` to our peer in a few states, described here.
320 #[derive(PartialEq)]
321 pub enum AnnouncementSigsState {
322         /// We have not sent our peer an `AnnouncementSignatures` yet, or our peer disconnected since
323         /// we sent the last `AnnouncementSignatures`.
324         NotSent,
325         /// We sent an `AnnouncementSignatures` to our peer since the last time our peer disconnected.
326         /// This state never appears on disk - instead we write `NotSent`.
327         MessageSent,
328         /// We sent a `CommitmentSigned` after the last `AnnouncementSignatures` we sent. Because we
329         /// only ever have a single `CommitmentSigned` pending at once, if we sent one after sending
330         /// `AnnouncementSignatures` then we know the peer received our `AnnouncementSignatures` if
331         /// they send back a `RevokeAndACK`.
332         /// This state never appears on disk - instead we write `NotSent`.
333         Committed,
334         /// We received a `RevokeAndACK`, effectively ack-ing our `AnnouncementSignatures`, at this
335         /// point we no longer need to re-send our `AnnouncementSignatures` again on reconnect.
336         PeerReceived,
337 }
338
339 /// An enum indicating whether the local or remote side offered a given HTLC.
340 enum HTLCInitiator {
341         LocalOffered,
342         RemoteOffered,
343 }
344
345 /// An enum gathering stats on pending HTLCs, either inbound or outbound side.
346 struct HTLCStats {
347         pending_htlcs: u32,
348         pending_htlcs_value_msat: u64,
349         on_counterparty_tx_dust_exposure_msat: u64,
350         on_holder_tx_dust_exposure_msat: u64,
351         holding_cell_msat: u64,
352         on_holder_tx_holding_cell_htlcs_count: u32, // dust HTLCs *non*-included
353 }
354
355 /// An enum gathering stats on commitment transaction, either local or remote.
356 struct CommitmentStats<'a> {
357         tx: CommitmentTransaction, // the transaction info
358         feerate_per_kw: u32, // the feerate included to build the transaction
359         total_fee_sat: u64, // the total fee included in the transaction
360         num_nondust_htlcs: usize,  // the number of HTLC outputs (dust HTLCs *non*-included)
361         htlcs_included: Vec<(HTLCOutputInCommitment, Option<&'a HTLCSource>)>, // the list of HTLCs (dust HTLCs *included*) which were not ignored when building the transaction
362         local_balance_msat: u64, // local balance before fees but considering dust limits
363         remote_balance_msat: u64, // remote balance before fees but considering dust limits
364         preimages: Vec<PaymentPreimage>, // preimages for successful offered HTLCs since last commitment
365 }
366
367 /// Used when calculating whether we or the remote can afford an additional HTLC.
368 struct HTLCCandidate {
369         amount_msat: u64,
370         origin: HTLCInitiator,
371 }
372
373 impl HTLCCandidate {
374         fn new(amount_msat: u64, origin: HTLCInitiator) -> Self {
375                 Self {
376                         amount_msat,
377                         origin,
378                 }
379         }
380 }
381
382 /// A return value enum for get_update_fulfill_htlc. See UpdateFulfillCommitFetch variants for
383 /// description
384 enum UpdateFulfillFetch {
385         NewClaim {
386                 monitor_update: ChannelMonitorUpdate,
387                 htlc_value_msat: u64,
388                 msg: Option<msgs::UpdateFulfillHTLC>,
389         },
390         DuplicateClaim {},
391 }
392
393 /// The return type of get_update_fulfill_htlc_and_commit.
394 pub enum UpdateFulfillCommitFetch {
395         /// Indicates the HTLC fulfill is new, and either generated an update_fulfill message, placed
396         /// it in the holding cell, or re-generated the update_fulfill message after the same claim was
397         /// previously placed in the holding cell (and has since been removed).
398         NewClaim {
399                 /// The ChannelMonitorUpdate which places the new payment preimage in the channel monitor
400                 monitor_update: ChannelMonitorUpdate,
401                 /// The value of the HTLC which was claimed, in msat.
402                 htlc_value_msat: u64,
403                 /// The update_fulfill message and commitment_signed message (if the claim was not placed
404                 /// in the holding cell).
405                 msgs: Option<(msgs::UpdateFulfillHTLC, msgs::CommitmentSigned)>,
406         },
407         /// Indicates the HTLC fulfill is duplicative and already existed either in the holding cell
408         /// or has been forgotten (presumably previously claimed).
409         DuplicateClaim {},
410 }
411
412 /// The return value of `revoke_and_ack` on success, primarily updates to other channels or HTLC
413 /// state.
414 pub(super) struct RAAUpdates {
415         pub commitment_update: Option<msgs::CommitmentUpdate>,
416         pub accepted_htlcs: Vec<(PendingHTLCInfo, u64)>,
417         pub failed_htlcs: Vec<(HTLCSource, PaymentHash, HTLCFailReason)>,
418         pub finalized_claimed_htlcs: Vec<HTLCSource>,
419         pub monitor_update: ChannelMonitorUpdate,
420         pub holding_cell_failed_htlcs: Vec<(HTLCSource, PaymentHash)>,
421 }
422
423 /// The return value of `monitor_updating_restored`
424 pub(super) struct MonitorRestoreUpdates {
425         pub raa: Option<msgs::RevokeAndACK>,
426         pub commitment_update: Option<msgs::CommitmentUpdate>,
427         pub order: RAACommitmentOrder,
428         pub accepted_htlcs: Vec<(PendingHTLCInfo, u64)>,
429         pub failed_htlcs: Vec<(HTLCSource, PaymentHash, HTLCFailReason)>,
430         pub finalized_claimed_htlcs: Vec<HTLCSource>,
431         pub funding_broadcastable: Option<Transaction>,
432         pub channel_ready: Option<msgs::ChannelReady>,
433         pub announcement_sigs: Option<msgs::AnnouncementSignatures>,
434 }
435
436 /// The return value of `channel_reestablish`
437 pub(super) struct ReestablishResponses {
438         pub channel_ready: Option<msgs::ChannelReady>,
439         pub raa: Option<msgs::RevokeAndACK>,
440         pub commitment_update: Option<msgs::CommitmentUpdate>,
441         pub order: RAACommitmentOrder,
442         pub mon_update: Option<ChannelMonitorUpdate>,
443         pub holding_cell_failed_htlcs: Vec<(HTLCSource, PaymentHash)>,
444         pub announcement_sigs: Option<msgs::AnnouncementSignatures>,
445         pub shutdown_msg: Option<msgs::Shutdown>,
446 }
447
448 /// If the majority of the channels funds are to the fundee and the initiator holds only just
449 /// enough funds to cover their reserve value, channels are at risk of getting "stuck". Because the
450 /// initiator controls the feerate, if they then go to increase the channel fee, they may have no
451 /// balance but the fundee is unable to send a payment as the increase in fee more than drains
452 /// their reserve value. Thus, neither side can send a new HTLC and the channel becomes useless.
453 /// Thus, before sending an HTLC when we are the initiator, we check that the feerate can increase
454 /// by this multiple without hitting this case, before sending.
455 /// This multiple is effectively the maximum feerate "jump" we expect until more HTLCs flow over
456 /// the channel. Sadly, there isn't really a good number for this - if we expect to have no new
457 /// HTLCs for days we may need this to suffice for feerate increases across days, but that may
458 /// leave the channel less usable as we hold a bigger reserve.
459 #[cfg(any(fuzzing, test))]
460 pub const FEE_SPIKE_BUFFER_FEE_INCREASE_MULTIPLE: u64 = 2;
461 #[cfg(not(any(fuzzing, test)))]
462 const FEE_SPIKE_BUFFER_FEE_INCREASE_MULTIPLE: u64 = 2;
463
464 /// If we fail to see a funding transaction confirmed on-chain within this many blocks after the
465 /// channel creation on an inbound channel, we simply force-close and move on.
466 /// This constant is the one suggested in BOLT 2.
467 pub(crate) const FUNDING_CONF_DEADLINE_BLOCKS: u32 = 2016;
468
469 /// In case of a concurrent update_add_htlc proposed by our counterparty, we might
470 /// not have enough balance value remaining to cover the onchain cost of this new
471 /// HTLC weight. If this happens, our counterparty fails the reception of our
472 /// commitment_signed including this new HTLC due to infringement on the channel
473 /// reserve.
474 /// To prevent this case, we compute our outbound update_fee with an HTLC buffer of
475 /// size 2. However, if the number of concurrent update_add_htlc is higher, this still
476 /// leads to a channel force-close. Ultimately, this is an issue coming from the
477 /// design of LN state machines, allowing asynchronous updates.
478 pub(crate) const CONCURRENT_INBOUND_HTLC_FEE_BUFFER: u32 = 2;
479
480 /// When a channel is opened, we check that the funding amount is enough to pay for relevant
481 /// commitment transaction fees, with at least this many HTLCs present on the commitment
482 /// transaction (not counting the value of the HTLCs themselves).
483 pub(crate) const MIN_AFFORDABLE_HTLC_COUNT: usize = 4;
484
485 /// When a [`Channel`] has its [`ChannelConfig`] updated, its existing one is stashed for up to this
486 /// number of ticks to allow forwarding HTLCs by nodes that have yet to receive the new
487 /// ChannelUpdate prompted by the config update. This value was determined as follows:
488 ///
489 ///   * The expected interval between ticks (1 minute).
490 ///   * The average convergence delay of updates across the network, i.e., ~300 seconds on average
491 ///      for a node to see an update as seen on `<https://arxiv.org/pdf/2205.12737.pdf>`.
492 ///   * `EXPIRE_PREV_CONFIG_TICKS` = convergence_delay / tick_interval
493 pub(crate) const EXPIRE_PREV_CONFIG_TICKS: usize = 5;
494
495 // TODO: We should refactor this to be an Inbound/OutboundChannel until initial setup handshaking
496 // has been completed, and then turn into a Channel to get compiler-time enforcement of things like
497 // calling channel_id() before we're set up or things like get_outbound_funding_signed on an
498 // inbound channel.
499 //
500 // Holder designates channel data owned for the benefice of the user client.
501 // Counterparty designates channel data owned by the another channel participant entity.
502 pub(super) struct Channel<Signer: Sign> {
503         config: LegacyChannelConfig,
504
505         // Track the previous `ChannelConfig` so that we can continue forwarding HTLCs that were
506         // constructed using it. The second element in the tuple corresponds to the number of ticks that
507         // have elapsed since the update occurred.
508         prev_config: Option<(ChannelConfig, usize)>,
509
510         inbound_handshake_limits_override: Option<ChannelHandshakeLimits>,
511
512         user_id: u64,
513
514         channel_id: [u8; 32],
515         channel_state: u32,
516
517         // When we reach max(6 blocks, minimum_depth), we need to send an AnnouncementSigs message to
518         // our peer. However, we want to make sure they received it, or else rebroadcast it when we
519         // next connect.
520         // We do so here, see `AnnouncementSigsSent` for more details on the state(s).
521         // Note that a number of our tests were written prior to the behavior here which retransmits
522         // AnnouncementSignatures until after an RAA completes, so the behavior is short-circuited in
523         // many tests.
524         #[cfg(any(test, feature = "_test_utils"))]
525         pub(crate) announcement_sigs_state: AnnouncementSigsState,
526         #[cfg(not(any(test, feature = "_test_utils")))]
527         announcement_sigs_state: AnnouncementSigsState,
528
529         secp_ctx: Secp256k1<secp256k1::All>,
530         channel_value_satoshis: u64,
531
532         latest_monitor_update_id: u64,
533
534         holder_signer: Signer,
535         shutdown_scriptpubkey: Option<ShutdownScript>,
536         destination_script: Script,
537
538         // Our commitment numbers start at 2^48-1 and count down, whereas the ones used in transaction
539         // generation start at 0 and count up...this simplifies some parts of implementation at the
540         // cost of others, but should really just be changed.
541
542         cur_holder_commitment_transaction_number: u64,
543         cur_counterparty_commitment_transaction_number: u64,
544         value_to_self_msat: u64, // Excluding all pending_htlcs, excluding fees
545         pending_inbound_htlcs: Vec<InboundHTLCOutput>,
546         pending_outbound_htlcs: Vec<OutboundHTLCOutput>,
547         holding_cell_htlc_updates: Vec<HTLCUpdateAwaitingACK>,
548
549         /// When resending CS/RAA messages on channel monitor restoration or on reconnect, we always
550         /// need to ensure we resend them in the order we originally generated them. Note that because
551         /// there can only ever be one in-flight CS and/or one in-flight RAA at any time, it is
552         /// sufficient to simply set this to the opposite of any message we are generating as we
553         /// generate it. ie when we generate a CS, we set this to RAAFirst as, if there is a pending
554         /// in-flight RAA to resend, it will have been the first thing we generated, and thus we should
555         /// send it first.
556         resend_order: RAACommitmentOrder,
557
558         monitor_pending_channel_ready: bool,
559         monitor_pending_revoke_and_ack: bool,
560         monitor_pending_commitment_signed: bool,
561         monitor_pending_forwards: Vec<(PendingHTLCInfo, u64)>,
562         monitor_pending_failures: Vec<(HTLCSource, PaymentHash, HTLCFailReason)>,
563         monitor_pending_finalized_fulfills: Vec<HTLCSource>,
564
565         // pending_update_fee is filled when sending and receiving update_fee.
566         //
567         // Because it follows the same commitment flow as HTLCs, `FeeUpdateState` is either `Outbound`
568         // or matches a subset of the `InboundHTLCOutput` variants. It is then updated/used when
569         // generating new commitment transactions with exactly the same criteria as inbound/outbound
570         // HTLCs with similar state.
571         pending_update_fee: Option<(u32, FeeUpdateState)>,
572         // If a `send_update_fee()` call is made with ChannelState::AwaitingRemoteRevoke set, we place
573         // it here instead of `pending_update_fee` in the same way as we place outbound HTLC updates in
574         // `holding_cell_htlc_updates` instead of `pending_outbound_htlcs`. It is released into
575         // `pending_update_fee` with the same criteria as outbound HTLC updates but can be updated by
576         // further `send_update_fee` calls, dropping the previous holding cell update entirely.
577         holding_cell_update_fee: Option<u32>,
578         next_holder_htlc_id: u64,
579         next_counterparty_htlc_id: u64,
580         feerate_per_kw: u32,
581
582         /// The timestamp set on our latest `channel_update` message for this channel. It is updated
583         /// when the channel is updated in ways which may impact the `channel_update` message or when a
584         /// new block is received, ensuring it's always at least moderately close to the current real
585         /// time.
586         update_time_counter: u32,
587
588         #[cfg(debug_assertions)]
589         /// Max to_local and to_remote outputs in a locally-generated commitment transaction
590         holder_max_commitment_tx_output: Mutex<(u64, u64)>,
591         #[cfg(debug_assertions)]
592         /// Max to_local and to_remote outputs in a remote-generated commitment transaction
593         counterparty_max_commitment_tx_output: Mutex<(u64, u64)>,
594
595         last_sent_closing_fee: Option<(u64, Signature)>, // (fee, holder_sig)
596         target_closing_feerate_sats_per_kw: Option<u32>,
597
598         /// If our counterparty sent us a closing_signed while we were waiting for a `ChannelMonitor`
599         /// update, we need to delay processing it until later. We do that here by simply storing the
600         /// closing_signed message and handling it in `maybe_propose_closing_signed`.
601         pending_counterparty_closing_signed: Option<msgs::ClosingSigned>,
602
603         /// The minimum and maximum absolute fee, in satoshis, we are willing to place on the closing
604         /// transaction. These are set once we reach `closing_negotiation_ready`.
605         #[cfg(test)]
606         pub(crate) closing_fee_limits: Option<(u64, u64)>,
607         #[cfg(not(test))]
608         closing_fee_limits: Option<(u64, u64)>,
609
610         /// Flag that ensures that `accept_inbound_channel` must be called before `funding_created`
611         /// is executed successfully. The reason for this flag is that when the
612         /// `UserConfig::manually_accept_inbound_channels` config flag is set to true, inbound channels
613         /// are required to be manually accepted by the node operator before the `msgs::AcceptChannel`
614         /// message is created and sent out. During the manual accept process, `accept_inbound_channel`
615         /// is called by `ChannelManager::accept_inbound_channel`.
616         ///
617         /// The flag counteracts that a counterparty node could theoretically send a
618         /// `msgs::FundingCreated` message before the node operator has manually accepted an inbound
619         /// channel request made by the counterparty node. That would execute `funding_created` before
620         /// `accept_inbound_channel`, and `funding_created` should therefore not execute successfully.
621         inbound_awaiting_accept: bool,
622
623         /// The hash of the block in which the funding transaction was included.
624         funding_tx_confirmed_in: Option<BlockHash>,
625         funding_tx_confirmation_height: u32,
626         short_channel_id: Option<u64>,
627         /// Either the height at which this channel was created or the height at which it was last
628         /// serialized if it was serialized by versions prior to 0.0.103.
629         /// We use this to close if funding is never broadcasted.
630         channel_creation_height: u32,
631
632         counterparty_dust_limit_satoshis: u64,
633
634         #[cfg(test)]
635         pub(super) holder_dust_limit_satoshis: u64,
636         #[cfg(not(test))]
637         holder_dust_limit_satoshis: u64,
638
639         #[cfg(test)]
640         pub(super) counterparty_max_htlc_value_in_flight_msat: u64,
641         #[cfg(not(test))]
642         counterparty_max_htlc_value_in_flight_msat: u64,
643
644         #[cfg(test)]
645         pub(super) holder_max_htlc_value_in_flight_msat: u64,
646         #[cfg(not(test))]
647         holder_max_htlc_value_in_flight_msat: u64,
648
649         /// minimum channel reserve for self to maintain - set by them.
650         counterparty_selected_channel_reserve_satoshis: Option<u64>,
651
652         #[cfg(test)]
653         pub(super) holder_selected_channel_reserve_satoshis: u64,
654         #[cfg(not(test))]
655         holder_selected_channel_reserve_satoshis: u64,
656
657         counterparty_htlc_minimum_msat: u64,
658         holder_htlc_minimum_msat: u64,
659         #[cfg(test)]
660         pub counterparty_max_accepted_htlcs: u16,
661         #[cfg(not(test))]
662         counterparty_max_accepted_htlcs: u16,
663         //implied by OUR_MAX_HTLCS: max_accepted_htlcs: u16,
664         minimum_depth: Option<u32>,
665
666         counterparty_forwarding_info: Option<CounterpartyForwardingInfo>,
667
668         pub(crate) channel_transaction_parameters: ChannelTransactionParameters,
669         funding_transaction: Option<Transaction>,
670
671         counterparty_cur_commitment_point: Option<PublicKey>,
672         counterparty_prev_commitment_point: Option<PublicKey>,
673         counterparty_node_id: PublicKey,
674
675         counterparty_shutdown_scriptpubkey: Option<Script>,
676
677         commitment_secrets: CounterpartyCommitmentSecrets,
678
679         channel_update_status: ChannelUpdateStatus,
680         /// Once we reach `closing_negotiation_ready`, we set this, indicating if closing_signed does
681         /// not complete within a single timer tick (one minute), we should force-close the channel.
682         /// This prevents us from keeping unusable channels around forever if our counterparty wishes
683         /// to DoS us.
684         /// Note that this field is reset to false on deserialization to give us a chance to connect to
685         /// our peer and start the closing_signed negotiation fresh.
686         closing_signed_in_flight: bool,
687
688         /// Our counterparty's channel_announcement signatures provided in announcement_signatures.
689         /// This can be used to rebroadcast the channel_announcement message later.
690         announcement_sigs: Option<(Signature, Signature)>,
691
692         // We save these values so we can make sure `next_local_commit_tx_fee_msat` and
693         // `next_remote_commit_tx_fee_msat` properly predict what the next commitment transaction fee will
694         // be, by comparing the cached values to the fee of the tranaction generated by
695         // `build_commitment_transaction`.
696         #[cfg(any(test, fuzzing))]
697         next_local_commitment_tx_fee_info_cached: Mutex<Option<CommitmentTxInfoCached>>,
698         #[cfg(any(test, fuzzing))]
699         next_remote_commitment_tx_fee_info_cached: Mutex<Option<CommitmentTxInfoCached>>,
700
701         /// lnd has a long-standing bug where, upon reconnection, if the channel is not yet confirmed
702         /// they will not send a channel_reestablish until the channel locks in. Then, they will send a
703         /// channel_ready *before* sending the channel_reestablish (which is clearly a violation of
704         /// the BOLT specs). We copy c-lightning's workaround here and simply store the channel_ready
705         /// message until we receive a channel_reestablish.
706         ///
707         /// See-also <https://github.com/lightningnetwork/lnd/issues/4006>
708         pub workaround_lnd_bug_4006: Option<msgs::ChannelReady>,
709
710         #[cfg(any(test, fuzzing))]
711         // When we receive an HTLC fulfill on an outbound path, we may immediately fulfill the
712         // corresponding HTLC on the inbound path. If, then, the outbound path channel is
713         // disconnected and reconnected (before we've exchange commitment_signed and revoke_and_ack
714         // messages), they may re-broadcast their update_fulfill_htlc, causing a duplicate claim. This
715         // is fine, but as a sanity check in our failure to generate the second claim, we check here
716         // that the original was a claim, and that we aren't now trying to fulfill a failed HTLC.
717         historical_inbound_htlc_fulfills: HashSet<u64>,
718
719         /// This channel's type, as negotiated during channel open
720         channel_type: ChannelTypeFeatures,
721
722         // Our counterparty can offer us SCID aliases which they will map to this channel when routing
723         // outbound payments. These can be used in invoice route hints to avoid explicitly revealing
724         // the channel's funding UTXO.
725         //
726         // We also use this when sending our peer a channel_update that isn't to be broadcasted
727         // publicly - allowing them to re-use their map of SCID -> channel for channel_update ->
728         // associated channel mapping.
729         //
730         // We only bother storing the most recent SCID alias at any time, though our counterparty has
731         // to store all of them.
732         latest_inbound_scid_alias: Option<u64>,
733
734         // We always offer our counterparty a static SCID alias, which we recognize as for this channel
735         // if we see it in HTLC forwarding instructions. We don't bother rotating the alias given we
736         // don't currently support node id aliases and eventually privacy should be provided with
737         // blinded paths instead of simple scid+node_id aliases.
738         outbound_scid_alias: u64,
739 }
740
741 #[cfg(any(test, fuzzing))]
742 struct CommitmentTxInfoCached {
743         fee: u64,
744         total_pending_htlcs: usize,
745         next_holder_htlc_id: u64,
746         next_counterparty_htlc_id: u64,
747         feerate: u32,
748 }
749
750 pub const OUR_MAX_HTLCS: u16 = 50; //TODO
751
752 pub(crate) fn commitment_tx_base_weight(opt_anchors: bool) -> u64 {
753         const COMMITMENT_TX_BASE_WEIGHT: u64 = 724;
754         const COMMITMENT_TX_BASE_ANCHOR_WEIGHT: u64 = 1124;
755         if opt_anchors { COMMITMENT_TX_BASE_ANCHOR_WEIGHT } else { COMMITMENT_TX_BASE_WEIGHT }
756 }
757
758 #[cfg(not(test))]
759 const COMMITMENT_TX_WEIGHT_PER_HTLC: u64 = 172;
760 #[cfg(test)]
761 pub const COMMITMENT_TX_WEIGHT_PER_HTLC: u64 = 172;
762
763 pub const ANCHOR_OUTPUT_VALUE_SATOSHI: u64 = 330;
764
765 /// The percentage of the channel value `holder_max_htlc_value_in_flight_msat` used to be set to,
766 /// before this was made configurable. The percentage was made configurable in LDK 0.0.107,
767 /// although LDK 0.0.104+ enabled serialization of channels with a different value set for
768 /// `holder_max_htlc_value_in_flight_msat`.
769 pub const MAX_IN_FLIGHT_PERCENT_LEGACY: u8 = 10;
770
771 /// Maximum `funding_satoshis` value according to the BOLT #2 specification, if
772 /// `option_support_large_channel` (aka wumbo channels) is not supported.
773 /// It's 2^24 - 1.
774 pub const MAX_FUNDING_SATOSHIS_NO_WUMBO: u64 = (1 << 24) - 1;
775
776 /// Total bitcoin supply in satoshis.
777 pub const TOTAL_BITCOIN_SUPPLY_SATOSHIS: u64 = 21_000_000 * 1_0000_0000;
778
779 /// The maximum network dust limit for standard script formats. This currently represents the
780 /// minimum output value for a P2SH output before Bitcoin Core 22 considers the entire
781 /// transaction non-standard and thus refuses to relay it.
782 /// We also use this as the maximum counterparty `dust_limit_satoshis` allowed, given many
783 /// implementations use this value for their dust limit today.
784 pub const MAX_STD_OUTPUT_DUST_LIMIT_SATOSHIS: u64 = 546;
785
786 /// The maximum channel dust limit we will accept from our counterparty.
787 pub const MAX_CHAN_DUST_LIMIT_SATOSHIS: u64 = MAX_STD_OUTPUT_DUST_LIMIT_SATOSHIS;
788
789 /// The dust limit is used for both the commitment transaction outputs as well as the closing
790 /// transactions. For cooperative closing transactions, we require segwit outputs, though accept
791 /// *any* segwit scripts, which are allowed to be up to 42 bytes in length.
792 /// In order to avoid having to concern ourselves with standardness during the closing process, we
793 /// simply require our counterparty to use a dust limit which will leave any segwit output
794 /// standard.
795 /// See https://github.com/lightning/bolts/issues/905 for more details.
796 pub const MIN_CHAN_DUST_LIMIT_SATOSHIS: u64 = 354;
797
798 // Just a reasonable implementation-specific safe lower bound, higher than the dust limit.
799 pub const MIN_THEIR_CHAN_RESERVE_SATOSHIS: u64 = 1000;
800
801 /// Used to return a simple Error back to ChannelManager. Will get converted to a
802 /// msgs::ErrorAction::SendErrorMessage or msgs::ErrorAction::IgnoreError as appropriate with our
803 /// channel_id in ChannelManager.
804 pub(super) enum ChannelError {
805         Ignore(String),
806         Warn(String),
807         Close(String),
808 }
809
810 impl fmt::Debug for ChannelError {
811         fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
812                 match self {
813                         &ChannelError::Ignore(ref e) => write!(f, "Ignore : {}", e),
814                         &ChannelError::Warn(ref e) => write!(f, "Warn : {}", e),
815                         &ChannelError::Close(ref e) => write!(f, "Close : {}", e),
816                 }
817         }
818 }
819
820 macro_rules! secp_check {
821         ($res: expr, $err: expr) => {
822                 match $res {
823                         Ok(thing) => thing,
824                         Err(_) => return Err(ChannelError::Close($err)),
825                 }
826         };
827 }
828
829 impl<Signer: Sign> Channel<Signer> {
830         /// Returns the value to use for `holder_max_htlc_value_in_flight_msat` as a percentage of the
831         /// `channel_value_satoshis` in msat, set through
832         /// [`ChannelHandshakeConfig::max_inbound_htlc_value_in_flight_percent_of_channel`]
833         ///
834         /// The effective percentage is lower bounded by 1% and upper bounded by 100%.
835         ///
836         /// [`ChannelHandshakeConfig::max_inbound_htlc_value_in_flight_percent_of_channel`]: crate::util::config::ChannelHandshakeConfig::max_inbound_htlc_value_in_flight_percent_of_channel
837         fn get_holder_max_htlc_value_in_flight_msat(channel_value_satoshis: u64, config: &ChannelHandshakeConfig) -> u64 {
838                 let configured_percent = if config.max_inbound_htlc_value_in_flight_percent_of_channel < 1 {
839                         1
840                 } else if config.max_inbound_htlc_value_in_flight_percent_of_channel > 100 {
841                         100
842                 } else {
843                         config.max_inbound_htlc_value_in_flight_percent_of_channel as u64
844                 };
845                 channel_value_satoshis * 10 * configured_percent
846         }
847
848         /// Returns a minimum channel reserve value the remote needs to maintain,
849         /// required by us according to the configured or default
850         /// [`ChannelHandshakeConfig::their_channel_reserve_proportional_millionths`]
851         ///
852         /// Guaranteed to return a value no larger than channel_value_satoshis
853         ///
854         /// This is used both for outbound and inbound channels and has lower bound
855         /// of `MIN_THEIR_CHAN_RESERVE_SATOSHIS`.
856         pub(crate) fn get_holder_selected_channel_reserve_satoshis(channel_value_satoshis: u64, config: &UserConfig) -> u64 {
857                 let calculated_reserve = channel_value_satoshis.saturating_mul(config.channel_handshake_config.their_channel_reserve_proportional_millionths as u64) / 1_000_000;
858                 cmp::min(channel_value_satoshis, cmp::max(calculated_reserve, MIN_THEIR_CHAN_RESERVE_SATOSHIS))
859         }
860
861         /// This is for legacy reasons, present for forward-compatibility.
862         /// LDK versions older than 0.0.104 don't know how read/handle values other than default
863         /// from storage. Hence, we use this function to not persist default values of
864         /// `holder_selected_channel_reserve_satoshis` for channels into storage.
865         pub(crate) fn get_legacy_default_holder_selected_channel_reserve_satoshis(channel_value_satoshis: u64) -> u64 {
866                 let (q, _) = channel_value_satoshis.overflowing_div(100);
867                 cmp::min(channel_value_satoshis, cmp::max(q, 1000))
868         }
869
870         pub(crate) fn opt_anchors(&self) -> bool {
871                 self.channel_transaction_parameters.opt_anchors.is_some()
872         }
873
874         fn get_initial_channel_type(config: &UserConfig) -> ChannelTypeFeatures {
875                 // The default channel type (ie the first one we try) depends on whether the channel is
876                 // public - if it is, we just go with `only_static_remotekey` as it's the only option
877                 // available. If it's private, we first try `scid_privacy` as it provides better privacy
878                 // with no other changes, and fall back to `only_static_remotekey`
879                 let mut ret = ChannelTypeFeatures::only_static_remote_key();
880                 if !config.channel_handshake_config.announced_channel && config.channel_handshake_config.negotiate_scid_privacy {
881                         ret.set_scid_privacy_required();
882                 }
883                 ret
884         }
885
886         /// If we receive an error message, it may only be a rejection of the channel type we tried,
887         /// not of our ability to open any channel at all. Thus, on error, we should first call this
888         /// and see if we get a new `OpenChannel` message, otherwise the channel is failed.
889         pub(crate) fn maybe_handle_error_without_close(&mut self, chain_hash: BlockHash) -> Result<msgs::OpenChannel, ()> {
890                 if !self.is_outbound() || self.channel_state != ChannelState::OurInitSent as u32 { return Err(()); }
891                 if self.channel_type == ChannelTypeFeatures::only_static_remote_key() {
892                         // We've exhausted our options
893                         return Err(());
894                 }
895                 self.channel_type = ChannelTypeFeatures::only_static_remote_key(); // We only currently support two types
896                 Ok(self.get_open_channel(chain_hash))
897         }
898
899         // Constructors:
900         pub fn new_outbound<K: Deref, F: Deref>(
901                 fee_estimator: &LowerBoundedFeeEstimator<F>, keys_provider: &K, counterparty_node_id: PublicKey, their_features: &InitFeatures,
902                 channel_value_satoshis: u64, push_msat: u64, user_id: u64, config: &UserConfig, current_chain_height: u32,
903                 outbound_scid_alias: u64
904         ) -> Result<Channel<Signer>, APIError>
905         where K::Target: KeysInterface<Signer = Signer>,
906               F::Target: FeeEstimator,
907         {
908                 let opt_anchors = false; // TODO - should be based on features
909
910                 let holder_selected_contest_delay = config.channel_handshake_config.our_to_self_delay;
911                 let holder_signer = keys_provider.get_channel_signer(false, channel_value_satoshis);
912                 let pubkeys = holder_signer.pubkeys().clone();
913
914                 if !their_features.supports_wumbo() && channel_value_satoshis > MAX_FUNDING_SATOSHIS_NO_WUMBO {
915                         return Err(APIError::APIMisuseError{err: format!("funding_value must not exceed {}, it was {}", MAX_FUNDING_SATOSHIS_NO_WUMBO, channel_value_satoshis)});
916                 }
917                 if channel_value_satoshis >= TOTAL_BITCOIN_SUPPLY_SATOSHIS {
918                         return Err(APIError::APIMisuseError{err: format!("funding_value must be smaller than the total bitcoin supply, it was {}", channel_value_satoshis)});
919                 }
920                 let channel_value_msat = channel_value_satoshis * 1000;
921                 if push_msat > channel_value_msat {
922                         return Err(APIError::APIMisuseError { err: format!("Push value ({}) was larger than channel_value ({})", push_msat, channel_value_msat) });
923                 }
924                 if holder_selected_contest_delay < BREAKDOWN_TIMEOUT {
925                         return Err(APIError::APIMisuseError {err: format!("Configured with an unreasonable our_to_self_delay ({}) putting user funds at risks", holder_selected_contest_delay)});
926                 }
927                 let holder_selected_channel_reserve_satoshis = Channel::<Signer>::get_holder_selected_channel_reserve_satoshis(channel_value_satoshis, config);
928                 if holder_selected_channel_reserve_satoshis < MIN_CHAN_DUST_LIMIT_SATOSHIS {
929                         // Protocol level safety check in place, although it should never happen because
930                         // of `MIN_THEIR_CHAN_RESERVE_SATOSHIS`
931                         return Err(APIError::APIMisuseError { err: format!("Holder selected channel  reserve below implemention limit dust_limit_satoshis {}", holder_selected_channel_reserve_satoshis) });
932                 }
933
934                 let feerate = fee_estimator.bounded_sat_per_1000_weight(ConfirmationTarget::Normal);
935
936                 let value_to_self_msat = channel_value_satoshis * 1000 - push_msat;
937                 let commitment_tx_fee = Self::commit_tx_fee_msat(feerate, MIN_AFFORDABLE_HTLC_COUNT, opt_anchors);
938                 if value_to_self_msat < commitment_tx_fee {
939                         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) });
940                 }
941
942                 let mut secp_ctx = Secp256k1::new();
943                 secp_ctx.seeded_randomize(&keys_provider.get_secure_random_bytes());
944
945                 let shutdown_scriptpubkey = if config.channel_handshake_config.commit_upfront_shutdown_pubkey {
946                         Some(keys_provider.get_shutdown_scriptpubkey())
947                 } else { None };
948
949                 if let Some(shutdown_scriptpubkey) = &shutdown_scriptpubkey {
950                         if !shutdown_scriptpubkey.is_compatible(&their_features) {
951                                 return Err(APIError::IncompatibleShutdownScript { script: shutdown_scriptpubkey.clone() });
952                         }
953                 }
954
955                 Ok(Channel {
956                         user_id,
957
958                         config: LegacyChannelConfig {
959                                 options: config.channel_config.clone(),
960                                 announced_channel: config.channel_handshake_config.announced_channel,
961                                 commit_upfront_shutdown_pubkey: config.channel_handshake_config.commit_upfront_shutdown_pubkey,
962                         },
963
964                         prev_config: None,
965
966                         inbound_handshake_limits_override: Some(config.channel_handshake_limits.clone()),
967
968                         channel_id: keys_provider.get_secure_random_bytes(),
969                         channel_state: ChannelState::OurInitSent as u32,
970                         announcement_sigs_state: AnnouncementSigsState::NotSent,
971                         secp_ctx,
972                         channel_value_satoshis,
973
974                         latest_monitor_update_id: 0,
975
976                         holder_signer,
977                         shutdown_scriptpubkey,
978                         destination_script: keys_provider.get_destination_script(),
979
980                         cur_holder_commitment_transaction_number: INITIAL_COMMITMENT_NUMBER,
981                         cur_counterparty_commitment_transaction_number: INITIAL_COMMITMENT_NUMBER,
982                         value_to_self_msat,
983
984                         pending_inbound_htlcs: Vec::new(),
985                         pending_outbound_htlcs: Vec::new(),
986                         holding_cell_htlc_updates: Vec::new(),
987                         pending_update_fee: None,
988                         holding_cell_update_fee: None,
989                         next_holder_htlc_id: 0,
990                         next_counterparty_htlc_id: 0,
991                         update_time_counter: 1,
992
993                         resend_order: RAACommitmentOrder::CommitmentFirst,
994
995                         monitor_pending_channel_ready: false,
996                         monitor_pending_revoke_and_ack: false,
997                         monitor_pending_commitment_signed: false,
998                         monitor_pending_forwards: Vec::new(),
999                         monitor_pending_failures: Vec::new(),
1000                         monitor_pending_finalized_fulfills: Vec::new(),
1001
1002                         #[cfg(debug_assertions)]
1003                         holder_max_commitment_tx_output: Mutex::new((channel_value_satoshis * 1000 - push_msat, push_msat)),
1004                         #[cfg(debug_assertions)]
1005                         counterparty_max_commitment_tx_output: Mutex::new((channel_value_satoshis * 1000 - push_msat, push_msat)),
1006
1007                         last_sent_closing_fee: None,
1008                         pending_counterparty_closing_signed: None,
1009                         closing_fee_limits: None,
1010                         target_closing_feerate_sats_per_kw: None,
1011
1012                         inbound_awaiting_accept: false,
1013
1014                         funding_tx_confirmed_in: None,
1015                         funding_tx_confirmation_height: 0,
1016                         short_channel_id: None,
1017                         channel_creation_height: current_chain_height,
1018
1019                         feerate_per_kw: feerate,
1020                         counterparty_dust_limit_satoshis: 0,
1021                         holder_dust_limit_satoshis: MIN_CHAN_DUST_LIMIT_SATOSHIS,
1022                         counterparty_max_htlc_value_in_flight_msat: 0,
1023                         holder_max_htlc_value_in_flight_msat: Self::get_holder_max_htlc_value_in_flight_msat(channel_value_satoshis, &config.channel_handshake_config),
1024                         counterparty_selected_channel_reserve_satoshis: None, // Filled in in accept_channel
1025                         holder_selected_channel_reserve_satoshis,
1026                         counterparty_htlc_minimum_msat: 0,
1027                         holder_htlc_minimum_msat: if config.channel_handshake_config.our_htlc_minimum_msat == 0 { 1 } else { config.channel_handshake_config.our_htlc_minimum_msat },
1028                         counterparty_max_accepted_htlcs: 0,
1029                         minimum_depth: None, // Filled in in accept_channel
1030
1031                         counterparty_forwarding_info: None,
1032
1033                         channel_transaction_parameters: ChannelTransactionParameters {
1034                                 holder_pubkeys: pubkeys,
1035                                 holder_selected_contest_delay: config.channel_handshake_config.our_to_self_delay,
1036                                 is_outbound_from_holder: true,
1037                                 counterparty_parameters: None,
1038                                 funding_outpoint: None,
1039                                 opt_anchors: if opt_anchors { Some(()) } else { None },
1040                         },
1041                         funding_transaction: None,
1042
1043                         counterparty_cur_commitment_point: None,
1044                         counterparty_prev_commitment_point: None,
1045                         counterparty_node_id,
1046
1047                         counterparty_shutdown_scriptpubkey: None,
1048
1049                         commitment_secrets: CounterpartyCommitmentSecrets::new(),
1050
1051                         channel_update_status: ChannelUpdateStatus::Enabled,
1052                         closing_signed_in_flight: false,
1053
1054                         announcement_sigs: None,
1055
1056                         #[cfg(any(test, fuzzing))]
1057                         next_local_commitment_tx_fee_info_cached: Mutex::new(None),
1058                         #[cfg(any(test, fuzzing))]
1059                         next_remote_commitment_tx_fee_info_cached: Mutex::new(None),
1060
1061                         workaround_lnd_bug_4006: None,
1062
1063                         latest_inbound_scid_alias: None,
1064                         outbound_scid_alias,
1065
1066                         #[cfg(any(test, fuzzing))]
1067                         historical_inbound_htlc_fulfills: HashSet::new(),
1068
1069                         channel_type: Self::get_initial_channel_type(&config),
1070                 })
1071         }
1072
1073         fn check_remote_fee<F: Deref>(fee_estimator: &LowerBoundedFeeEstimator<F>, feerate_per_kw: u32) -> Result<(), ChannelError>
1074                 where F::Target: FeeEstimator
1075         {
1076                 // We only bound the fee updates on the upper side to prevent completely absurd feerates,
1077                 // always accepting up to 25 sat/vByte or 10x our fee estimator's "High Priority" fee.
1078                 // We generally don't care too much if they set the feerate to something very high, but it
1079                 // could result in the channel being useless due to everything being dust.
1080                 let upper_limit = cmp::max(250 * 25,
1081                         fee_estimator.bounded_sat_per_1000_weight(ConfirmationTarget::HighPriority) as u64 * 10);
1082                 if feerate_per_kw as u64 > upper_limit {
1083                         return Err(ChannelError::Close(format!("Peer's feerate much too high. Actual: {}. Our expected upper limit: {}", feerate_per_kw, upper_limit)));
1084                 }
1085                 let lower_limit = fee_estimator.bounded_sat_per_1000_weight(ConfirmationTarget::Background);
1086                 // Some fee estimators round up to the next full sat/vbyte (ie 250 sats per kw), causing
1087                 // occasional issues with feerate disagreements between an initiator that wants a feerate
1088                 // of 1.1 sat/vbyte and a receiver that wants 1.1 rounded up to 2. Thus, we always add 250
1089                 // sat/kw before the comparison here.
1090                 if feerate_per_kw + 250 < lower_limit {
1091                         return Err(ChannelError::Close(format!("Peer's feerate much too low. Actual: {}. Our expected lower limit: {} (- 250)", feerate_per_kw, lower_limit)));
1092                 }
1093                 Ok(())
1094         }
1095
1096         /// Creates a new channel from a remote sides' request for one.
1097         /// Assumes chain_hash has already been checked and corresponds with what we expect!
1098         pub fn new_from_req<K: Deref, F: Deref, L: Deref>(
1099                 fee_estimator: &LowerBoundedFeeEstimator<F>, keys_provider: &K, counterparty_node_id: PublicKey, their_features: &InitFeatures,
1100                 msg: &msgs::OpenChannel, user_id: u64, config: &UserConfig, current_chain_height: u32, logger: &L,
1101                 outbound_scid_alias: u64
1102         ) -> Result<Channel<Signer>, ChannelError>
1103                 where K::Target: KeysInterface<Signer = Signer>,
1104                       F::Target: FeeEstimator,
1105                       L::Target: Logger,
1106         {
1107                 let opt_anchors = false; // TODO - should be based on features
1108                 let announced_channel = if (msg.channel_flags & 1) == 1 { true } else { false };
1109
1110                 // First check the channel type is known, failing before we do anything else if we don't
1111                 // support this channel type.
1112                 let channel_type = if let Some(channel_type) = &msg.channel_type {
1113                         if channel_type.supports_any_optional_bits() {
1114                                 return Err(ChannelError::Close("Channel Type field contained optional bits - this is not allowed".to_owned()));
1115                         }
1116
1117                         if channel_type.requires_unknown_bits() {
1118                                 return Err(ChannelError::Close("Channel Type field contains unknown bits".to_owned()));
1119                         }
1120
1121                         // We currently only allow four channel types, so write it all out here - we allow
1122                         // `only_static_remote_key` or `static_remote_key | zero_conf` in all contexts, and
1123                         // further allow `static_remote_key | scid_privacy` or
1124                         // `static_remote_key | scid_privacy | zero_conf`, if the channel is not
1125                         // publicly announced.
1126                         if *channel_type != ChannelTypeFeatures::only_static_remote_key() {
1127                                 if !channel_type.requires_scid_privacy() && !channel_type.requires_zero_conf() {
1128                                         return Err(ChannelError::Close("Channel Type was not understood".to_owned()));
1129                                 }
1130
1131                                 if channel_type.requires_scid_privacy() && announced_channel {
1132                                         return Err(ChannelError::Close("SCID Alias/Privacy Channel Type cannot be set on a public channel".to_owned()));
1133                                 }
1134                         }
1135                         channel_type.clone()
1136                 } else {
1137                         ChannelTypeFeatures::from_counterparty_init(&their_features)
1138                 };
1139                 if !channel_type.supports_static_remote_key() {
1140                         return Err(ChannelError::Close("Channel Type was not understood - we require static remote key".to_owned()));
1141                 }
1142
1143                 let holder_signer = keys_provider.get_channel_signer(true, msg.funding_satoshis);
1144                 let pubkeys = holder_signer.pubkeys().clone();
1145                 let counterparty_pubkeys = ChannelPublicKeys {
1146                         funding_pubkey: msg.funding_pubkey,
1147                         revocation_basepoint: msg.revocation_basepoint,
1148                         payment_point: msg.payment_point,
1149                         delayed_payment_basepoint: msg.delayed_payment_basepoint,
1150                         htlc_basepoint: msg.htlc_basepoint
1151                 };
1152
1153                 if config.channel_handshake_config.our_to_self_delay < BREAKDOWN_TIMEOUT {
1154                         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)));
1155                 }
1156
1157                 // Check sanity of message fields:
1158                 if msg.funding_satoshis > config.channel_handshake_limits.max_funding_satoshis {
1159                         return Err(ChannelError::Close(format!("Per our config, funding must be at most {}. It was {}", config.channel_handshake_limits.max_funding_satoshis, msg.funding_satoshis)));
1160                 }
1161                 if msg.funding_satoshis >= TOTAL_BITCOIN_SUPPLY_SATOSHIS {
1162                         return Err(ChannelError::Close(format!("Funding must be smaller than the total bitcoin supply. It was {}", msg.funding_satoshis)));
1163                 }
1164                 if msg.channel_reserve_satoshis > msg.funding_satoshis {
1165                         return Err(ChannelError::Close(format!("Bogus channel_reserve_satoshis ({}). Must be not greater than funding_satoshis: {}", msg.channel_reserve_satoshis, msg.funding_satoshis)));
1166                 }
1167                 let full_channel_value_msat = (msg.funding_satoshis - msg.channel_reserve_satoshis) * 1000;
1168                 if msg.push_msat > full_channel_value_msat {
1169                         return Err(ChannelError::Close(format!("push_msat {} was larger than channel amount minus reserve ({})", msg.push_msat, full_channel_value_msat)));
1170                 }
1171                 if msg.dust_limit_satoshis > msg.funding_satoshis {
1172                         return Err(ChannelError::Close(format!("dust_limit_satoshis {} was larger than funding_satoshis {}. Peer never wants payout outputs?", msg.dust_limit_satoshis, msg.funding_satoshis)));
1173                 }
1174                 if msg.htlc_minimum_msat >= full_channel_value_msat {
1175                         return Err(ChannelError::Close(format!("Minimum htlc value ({}) was larger than full channel value ({})", msg.htlc_minimum_msat, full_channel_value_msat)));
1176                 }
1177                 Channel::<Signer>::check_remote_fee(fee_estimator, msg.feerate_per_kw)?;
1178
1179                 let max_counterparty_selected_contest_delay = u16::min(config.channel_handshake_limits.their_to_self_delay, MAX_LOCAL_BREAKDOWN_TIMEOUT);
1180                 if msg.to_self_delay > max_counterparty_selected_contest_delay {
1181                         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, msg.to_self_delay)));
1182                 }
1183                 if msg.max_accepted_htlcs < 1 {
1184                         return Err(ChannelError::Close("0 max_accepted_htlcs makes for a useless channel".to_owned()));
1185                 }
1186                 if msg.max_accepted_htlcs > MAX_HTLCS {
1187                         return Err(ChannelError::Close(format!("max_accepted_htlcs was {}. It must not be larger than {}", msg.max_accepted_htlcs, MAX_HTLCS)));
1188                 }
1189
1190                 // Now check against optional parameters as set by config...
1191                 if msg.funding_satoshis < config.channel_handshake_limits.min_funding_satoshis {
1192                         return Err(ChannelError::Close(format!("Funding satoshis ({}) is less than the user specified limit ({})", msg.funding_satoshis, config.channel_handshake_limits.min_funding_satoshis)));
1193                 }
1194                 if msg.htlc_minimum_msat > config.channel_handshake_limits.max_htlc_minimum_msat {
1195                         return Err(ChannelError::Close(format!("htlc_minimum_msat ({}) is higher than the user specified limit ({})", msg.htlc_minimum_msat,  config.channel_handshake_limits.max_htlc_minimum_msat)));
1196                 }
1197                 if msg.max_htlc_value_in_flight_msat < config.channel_handshake_limits.min_max_htlc_value_in_flight_msat {
1198                         return Err(ChannelError::Close(format!("max_htlc_value_in_flight_msat ({}) is less than the user specified limit ({})", msg.max_htlc_value_in_flight_msat, config.channel_handshake_limits.min_max_htlc_value_in_flight_msat)));
1199                 }
1200                 if msg.channel_reserve_satoshis > config.channel_handshake_limits.max_channel_reserve_satoshis {
1201                         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)));
1202                 }
1203                 if msg.max_accepted_htlcs < config.channel_handshake_limits.min_max_accepted_htlcs {
1204                         return Err(ChannelError::Close(format!("max_accepted_htlcs ({}) is less than the user specified limit ({})", msg.max_accepted_htlcs, config.channel_handshake_limits.min_max_accepted_htlcs)));
1205                 }
1206                 if msg.dust_limit_satoshis < MIN_CHAN_DUST_LIMIT_SATOSHIS {
1207                         return Err(ChannelError::Close(format!("dust_limit_satoshis ({}) is less than the implementation limit ({})", msg.dust_limit_satoshis, MIN_CHAN_DUST_LIMIT_SATOSHIS)));
1208                 }
1209                 if msg.dust_limit_satoshis >  MAX_CHAN_DUST_LIMIT_SATOSHIS {
1210                         return Err(ChannelError::Close(format!("dust_limit_satoshis ({}) is greater than the implementation limit ({})", msg.dust_limit_satoshis, MAX_CHAN_DUST_LIMIT_SATOSHIS)));
1211                 }
1212
1213                 // Convert things into internal flags and prep our state:
1214
1215                 if config.channel_handshake_limits.force_announced_channel_preference {
1216                         if config.channel_handshake_config.announced_channel != announced_channel {
1217                                 return Err(ChannelError::Close("Peer tried to open channel but their announcement preference is different from ours".to_owned()));
1218                         }
1219                 }
1220
1221                 let holder_selected_channel_reserve_satoshis = Channel::<Signer>::get_holder_selected_channel_reserve_satoshis(msg.funding_satoshis, config);
1222                 if holder_selected_channel_reserve_satoshis < MIN_CHAN_DUST_LIMIT_SATOSHIS {
1223                         // Protocol level safety check in place, although it should never happen because
1224                         // of `MIN_THEIR_CHAN_RESERVE_SATOSHIS`
1225                         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)));
1226                 }
1227                 if holder_selected_channel_reserve_satoshis * 1000 >= full_channel_value_msat {
1228                         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)));
1229                 }
1230                 if msg.channel_reserve_satoshis < MIN_CHAN_DUST_LIMIT_SATOSHIS {
1231                         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.",
1232                                 msg.channel_reserve_satoshis, MIN_CHAN_DUST_LIMIT_SATOSHIS);
1233                 }
1234                 if holder_selected_channel_reserve_satoshis < msg.dust_limit_satoshis {
1235                         return Err(ChannelError::Close(format!("Dust limit ({}) too high for the channel reserve we require the remote to keep ({})", msg.dust_limit_satoshis, holder_selected_channel_reserve_satoshis)));
1236                 }
1237
1238                 // check if the funder's amount for the initial commitment tx is sufficient
1239                 // for full fee payment plus a few HTLCs to ensure the channel will be useful.
1240                 let funders_amount_msat = msg.funding_satoshis * 1000 - msg.push_msat;
1241                 let commitment_tx_fee = Self::commit_tx_fee_msat(msg.feerate_per_kw, MIN_AFFORDABLE_HTLC_COUNT, opt_anchors) / 1000;
1242                 if funders_amount_msat / 1000 < commitment_tx_fee {
1243                         return Err(ChannelError::Close(format!("Funding amount ({} sats) can't even pay fee for initial commitment transaction fee of {} sats.", funders_amount_msat / 1000, commitment_tx_fee)));
1244                 }
1245
1246                 let to_remote_satoshis = funders_amount_msat / 1000 - commitment_tx_fee;
1247                 // While it's reasonable for us to not meet the channel reserve initially (if they don't
1248                 // want to push much to us), our counterparty should always have more than our reserve.
1249                 if to_remote_satoshis < holder_selected_channel_reserve_satoshis {
1250                         return Err(ChannelError::Close("Insufficient funding amount for initial reserve".to_owned()));
1251                 }
1252
1253                 let counterparty_shutdown_scriptpubkey = if their_features.supports_upfront_shutdown_script() {
1254                         match &msg.shutdown_scriptpubkey {
1255                                 &OptionalField::Present(ref script) => {
1256                                         // Peer is signaling upfront_shutdown and has opt-out with a 0-length script. We don't enforce anything
1257                                         if script.len() == 0 {
1258                                                 None
1259                                         } else {
1260                                                 if !script::is_bolt2_compliant(&script, their_features) {
1261                                                         return Err(ChannelError::Close(format!("Peer is signaling upfront_shutdown but has provided an unacceptable scriptpubkey format: {}", script)))
1262                                                 }
1263                                                 Some(script.clone())
1264                                         }
1265                                 },
1266                                 // 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
1267                                 &OptionalField::Absent => {
1268                                         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()));
1269                                 }
1270                         }
1271                 } else { None };
1272
1273                 let shutdown_scriptpubkey = if config.channel_handshake_config.commit_upfront_shutdown_pubkey {
1274                         Some(keys_provider.get_shutdown_scriptpubkey())
1275                 } else { None };
1276
1277                 if let Some(shutdown_scriptpubkey) = &shutdown_scriptpubkey {
1278                         if !shutdown_scriptpubkey.is_compatible(&their_features) {
1279                                 return Err(ChannelError::Close(format!("Provided a scriptpubkey format not accepted by peer: {}", shutdown_scriptpubkey)));
1280                         }
1281                 }
1282
1283                 let mut secp_ctx = Secp256k1::new();
1284                 secp_ctx.seeded_randomize(&keys_provider.get_secure_random_bytes());
1285
1286                 let chan = Channel {
1287                         user_id,
1288
1289                         config: LegacyChannelConfig {
1290                                 options: config.channel_config.clone(),
1291                                 announced_channel,
1292                                 commit_upfront_shutdown_pubkey: config.channel_handshake_config.commit_upfront_shutdown_pubkey,
1293                         },
1294
1295                         prev_config: None,
1296
1297                         inbound_handshake_limits_override: None,
1298
1299                         channel_id: msg.temporary_channel_id,
1300                         channel_state: (ChannelState::OurInitSent as u32) | (ChannelState::TheirInitSent as u32),
1301                         announcement_sigs_state: AnnouncementSigsState::NotSent,
1302                         secp_ctx,
1303
1304                         latest_monitor_update_id: 0,
1305
1306                         holder_signer,
1307                         shutdown_scriptpubkey,
1308                         destination_script: keys_provider.get_destination_script(),
1309
1310                         cur_holder_commitment_transaction_number: INITIAL_COMMITMENT_NUMBER,
1311                         cur_counterparty_commitment_transaction_number: INITIAL_COMMITMENT_NUMBER,
1312                         value_to_self_msat: msg.push_msat,
1313
1314                         pending_inbound_htlcs: Vec::new(),
1315                         pending_outbound_htlcs: Vec::new(),
1316                         holding_cell_htlc_updates: Vec::new(),
1317                         pending_update_fee: None,
1318                         holding_cell_update_fee: None,
1319                         next_holder_htlc_id: 0,
1320                         next_counterparty_htlc_id: 0,
1321                         update_time_counter: 1,
1322
1323                         resend_order: RAACommitmentOrder::CommitmentFirst,
1324
1325                         monitor_pending_channel_ready: false,
1326                         monitor_pending_revoke_and_ack: false,
1327                         monitor_pending_commitment_signed: false,
1328                         monitor_pending_forwards: Vec::new(),
1329                         monitor_pending_failures: Vec::new(),
1330                         monitor_pending_finalized_fulfills: Vec::new(),
1331
1332                         #[cfg(debug_assertions)]
1333                         holder_max_commitment_tx_output: Mutex::new((msg.push_msat, msg.funding_satoshis * 1000 - msg.push_msat)),
1334                         #[cfg(debug_assertions)]
1335                         counterparty_max_commitment_tx_output: Mutex::new((msg.push_msat, msg.funding_satoshis * 1000 - msg.push_msat)),
1336
1337                         last_sent_closing_fee: None,
1338                         pending_counterparty_closing_signed: None,
1339                         closing_fee_limits: None,
1340                         target_closing_feerate_sats_per_kw: None,
1341
1342                         inbound_awaiting_accept: true,
1343
1344                         funding_tx_confirmed_in: None,
1345                         funding_tx_confirmation_height: 0,
1346                         short_channel_id: None,
1347                         channel_creation_height: current_chain_height,
1348
1349                         feerate_per_kw: msg.feerate_per_kw,
1350                         channel_value_satoshis: msg.funding_satoshis,
1351                         counterparty_dust_limit_satoshis: msg.dust_limit_satoshis,
1352                         holder_dust_limit_satoshis: MIN_CHAN_DUST_LIMIT_SATOSHIS,
1353                         counterparty_max_htlc_value_in_flight_msat: cmp::min(msg.max_htlc_value_in_flight_msat, msg.funding_satoshis * 1000),
1354                         holder_max_htlc_value_in_flight_msat: Self::get_holder_max_htlc_value_in_flight_msat(msg.funding_satoshis, &config.channel_handshake_config),
1355                         counterparty_selected_channel_reserve_satoshis: Some(msg.channel_reserve_satoshis),
1356                         holder_selected_channel_reserve_satoshis,
1357                         counterparty_htlc_minimum_msat: msg.htlc_minimum_msat,
1358                         holder_htlc_minimum_msat: if config.channel_handshake_config.our_htlc_minimum_msat == 0 { 1 } else { config.channel_handshake_config.our_htlc_minimum_msat },
1359                         counterparty_max_accepted_htlcs: msg.max_accepted_htlcs,
1360                         minimum_depth: Some(cmp::max(config.channel_handshake_config.minimum_depth, 1)),
1361
1362                         counterparty_forwarding_info: None,
1363
1364                         channel_transaction_parameters: ChannelTransactionParameters {
1365                                 holder_pubkeys: pubkeys,
1366                                 holder_selected_contest_delay: config.channel_handshake_config.our_to_self_delay,
1367                                 is_outbound_from_holder: false,
1368                                 counterparty_parameters: Some(CounterpartyChannelTransactionParameters {
1369                                         selected_contest_delay: msg.to_self_delay,
1370                                         pubkeys: counterparty_pubkeys,
1371                                 }),
1372                                 funding_outpoint: None,
1373                                 opt_anchors: if opt_anchors { Some(()) } else { None },
1374                         },
1375                         funding_transaction: None,
1376
1377                         counterparty_cur_commitment_point: Some(msg.first_per_commitment_point),
1378                         counterparty_prev_commitment_point: None,
1379                         counterparty_node_id,
1380
1381                         counterparty_shutdown_scriptpubkey,
1382
1383                         commitment_secrets: CounterpartyCommitmentSecrets::new(),
1384
1385                         channel_update_status: ChannelUpdateStatus::Enabled,
1386                         closing_signed_in_flight: false,
1387
1388                         announcement_sigs: None,
1389
1390                         #[cfg(any(test, fuzzing))]
1391                         next_local_commitment_tx_fee_info_cached: Mutex::new(None),
1392                         #[cfg(any(test, fuzzing))]
1393                         next_remote_commitment_tx_fee_info_cached: Mutex::new(None),
1394
1395                         workaround_lnd_bug_4006: None,
1396
1397                         latest_inbound_scid_alias: None,
1398                         outbound_scid_alias,
1399
1400                         #[cfg(any(test, fuzzing))]
1401                         historical_inbound_htlc_fulfills: HashSet::new(),
1402
1403                         channel_type,
1404                 };
1405
1406                 Ok(chan)
1407         }
1408
1409         /// Transaction nomenclature is somewhat confusing here as there are many different cases - a
1410         /// transaction is referred to as "a's transaction" implying that a will be able to broadcast
1411         /// the transaction. Thus, b will generally be sending a signature over such a transaction to
1412         /// a, and a can revoke the transaction by providing b the relevant per_commitment_secret. As
1413         /// such, a transaction is generally the result of b increasing the amount paid to a (or adding
1414         /// an HTLC to a).
1415         /// @local is used only to convert relevant internal structures which refer to remote vs local
1416         /// to decide value of outputs and direction of HTLCs.
1417         /// @generated_by_local is used to determine *which* HTLCs to include - noting that the HTLC
1418         /// state may indicate that one peer has informed the other that they'd like to add an HTLC but
1419         /// have not yet committed it. Such HTLCs will only be included in transactions which are being
1420         /// generated by the peer which proposed adding the HTLCs, and thus we need to understand both
1421         /// which peer generated this transaction and "to whom" this transaction flows.
1422         #[inline]
1423         fn build_commitment_transaction<L: Deref>(&self, commitment_number: u64, keys: &TxCreationKeys, local: bool, generated_by_local: bool, logger: &L) -> CommitmentStats
1424                 where L::Target: Logger
1425         {
1426                 let mut included_dust_htlcs: Vec<(HTLCOutputInCommitment, Option<&HTLCSource>)> = Vec::new();
1427                 let num_htlcs = self.pending_inbound_htlcs.len() + self.pending_outbound_htlcs.len();
1428                 let mut included_non_dust_htlcs: Vec<(HTLCOutputInCommitment, Option<&HTLCSource>)> = Vec::with_capacity(num_htlcs);
1429
1430                 let broadcaster_dust_limit_satoshis = if local { self.holder_dust_limit_satoshis } else { self.counterparty_dust_limit_satoshis };
1431                 let mut remote_htlc_total_msat = 0;
1432                 let mut local_htlc_total_msat = 0;
1433                 let mut value_to_self_msat_offset = 0;
1434
1435                 let mut feerate_per_kw = self.feerate_per_kw;
1436                 if let Some((feerate, update_state)) = self.pending_update_fee {
1437                         if match update_state {
1438                                 // Note that these match the inclusion criteria when scanning
1439                                 // pending_inbound_htlcs below.
1440                                 FeeUpdateState::RemoteAnnounced => { debug_assert!(!self.is_outbound()); !generated_by_local },
1441                                 FeeUpdateState::AwaitingRemoteRevokeToAnnounce => { debug_assert!(!self.is_outbound()); !generated_by_local },
1442                                 FeeUpdateState::Outbound => { assert!(self.is_outbound());  generated_by_local },
1443                         } {
1444                                 feerate_per_kw = feerate;
1445                         }
1446                 }
1447
1448                 log_trace!(logger, "Building commitment transaction number {} (really {} xor {}) for channel {} for {}, generated by {} with fee {}...",
1449                         commitment_number, (INITIAL_COMMITMENT_NUMBER - commitment_number),
1450                         get_commitment_transaction_number_obscure_factor(&self.get_holder_pubkeys().payment_point, &self.get_counterparty_pubkeys().payment_point, self.is_outbound()),
1451                         log_bytes!(self.channel_id), if local { "us" } else { "remote" }, if generated_by_local { "us" } else { "remote" }, feerate_per_kw);
1452
1453                 macro_rules! get_htlc_in_commitment {
1454                         ($htlc: expr, $offered: expr) => {
1455                                 HTLCOutputInCommitment {
1456                                         offered: $offered,
1457                                         amount_msat: $htlc.amount_msat,
1458                                         cltv_expiry: $htlc.cltv_expiry,
1459                                         payment_hash: $htlc.payment_hash,
1460                                         transaction_output_index: None
1461                                 }
1462                         }
1463                 }
1464
1465                 macro_rules! add_htlc_output {
1466                         ($htlc: expr, $outbound: expr, $source: expr, $state_name: expr) => {
1467                                 if $outbound == local { // "offered HTLC output"
1468                                         let htlc_in_tx = get_htlc_in_commitment!($htlc, true);
1469                                         if $htlc.amount_msat / 1000 >= broadcaster_dust_limit_satoshis + (feerate_per_kw as u64 * htlc_timeout_tx_weight(self.opt_anchors()) / 1000) {
1470                                                 log_trace!(logger, "   ...including {} {} HTLC {} (hash {}) with value {}", if $outbound { "outbound" } else { "inbound" }, $state_name, $htlc.htlc_id, log_bytes!($htlc.payment_hash.0), $htlc.amount_msat);
1471                                                 included_non_dust_htlcs.push((htlc_in_tx, $source));
1472                                         } else {
1473                                                 log_trace!(logger, "   ...including {} {} dust HTLC {} (hash {}) with value {} due to dust limit", if $outbound { "outbound" } else { "inbound" }, $state_name, $htlc.htlc_id, log_bytes!($htlc.payment_hash.0), $htlc.amount_msat);
1474                                                 included_dust_htlcs.push((htlc_in_tx, $source));
1475                                         }
1476                                 } else {
1477                                         let htlc_in_tx = get_htlc_in_commitment!($htlc, false);
1478                                         if $htlc.amount_msat / 1000 >= broadcaster_dust_limit_satoshis + (feerate_per_kw as u64 * htlc_success_tx_weight(self.opt_anchors()) / 1000) {
1479                                                 log_trace!(logger, "   ...including {} {} HTLC {} (hash {}) with value {}", if $outbound { "outbound" } else { "inbound" }, $state_name, $htlc.htlc_id, log_bytes!($htlc.payment_hash.0), $htlc.amount_msat);
1480                                                 included_non_dust_htlcs.push((htlc_in_tx, $source));
1481                                         } else {
1482                                                 log_trace!(logger, "   ...including {} {} dust HTLC {} (hash {}) with value {}", if $outbound { "outbound" } else { "inbound" }, $state_name, $htlc.htlc_id, log_bytes!($htlc.payment_hash.0), $htlc.amount_msat);
1483                                                 included_dust_htlcs.push((htlc_in_tx, $source));
1484                                         }
1485                                 }
1486                         }
1487                 }
1488
1489                 for ref htlc in self.pending_inbound_htlcs.iter() {
1490                         let (include, state_name) = match htlc.state {
1491                                 InboundHTLCState::RemoteAnnounced(_) => (!generated_by_local, "RemoteAnnounced"),
1492                                 InboundHTLCState::AwaitingRemoteRevokeToAnnounce(_) => (!generated_by_local, "AwaitingRemoteRevokeToAnnounce"),
1493                                 InboundHTLCState::AwaitingAnnouncedRemoteRevoke(_) => (true, "AwaitingAnnouncedRemoteRevoke"),
1494                                 InboundHTLCState::Committed => (true, "Committed"),
1495                                 InboundHTLCState::LocalRemoved(_) => (!generated_by_local, "LocalRemoved"),
1496                         };
1497
1498                         if include {
1499                                 add_htlc_output!(htlc, false, None, state_name);
1500                                 remote_htlc_total_msat += htlc.amount_msat;
1501                         } else {
1502                                 log_trace!(logger, "   ...not including inbound HTLC {} (hash {}) with value {} due to state ({})", htlc.htlc_id, log_bytes!(htlc.payment_hash.0), htlc.amount_msat, state_name);
1503                                 match &htlc.state {
1504                                         &InboundHTLCState::LocalRemoved(ref reason) => {
1505                                                 if generated_by_local {
1506                                                         if let &InboundHTLCRemovalReason::Fulfill(_) = reason {
1507                                                                 value_to_self_msat_offset += htlc.amount_msat as i64;
1508                                                         }
1509                                                 }
1510                                         },
1511                                         _ => {},
1512                                 }
1513                         }
1514                 }
1515
1516                 let mut preimages: Vec<PaymentPreimage> = Vec::new();
1517
1518                 for ref htlc in self.pending_outbound_htlcs.iter() {
1519                         let (include, state_name) = match htlc.state {
1520                                 OutboundHTLCState::LocalAnnounced(_) => (generated_by_local, "LocalAnnounced"),
1521                                 OutboundHTLCState::Committed => (true, "Committed"),
1522                                 OutboundHTLCState::RemoteRemoved(_) => (generated_by_local, "RemoteRemoved"),
1523                                 OutboundHTLCState::AwaitingRemoteRevokeToRemove(_) => (generated_by_local, "AwaitingRemoteRevokeToRemove"),
1524                                 OutboundHTLCState::AwaitingRemovedRemoteRevoke(_) => (false, "AwaitingRemovedRemoteRevoke"),
1525                         };
1526
1527                         let preimage_opt = match htlc.state {
1528                                 OutboundHTLCState::RemoteRemoved(OutboundHTLCOutcome::Success(p)) => p,
1529                                 OutboundHTLCState::AwaitingRemoteRevokeToRemove(OutboundHTLCOutcome::Success(p)) => p,
1530                                 OutboundHTLCState::AwaitingRemovedRemoteRevoke(OutboundHTLCOutcome::Success(p)) => p,
1531                                 _ => None,
1532                         };
1533
1534                         if let Some(preimage) = preimage_opt {
1535                                 preimages.push(preimage);
1536                         }
1537
1538                         if include {
1539                                 add_htlc_output!(htlc, true, Some(&htlc.source), state_name);
1540                                 local_htlc_total_msat += htlc.amount_msat;
1541                         } else {
1542                                 log_trace!(logger, "   ...not including outbound HTLC {} (hash {}) with value {} due to state ({})", htlc.htlc_id, log_bytes!(htlc.payment_hash.0), htlc.amount_msat, state_name);
1543                                 match htlc.state {
1544                                         OutboundHTLCState::AwaitingRemoteRevokeToRemove(OutboundHTLCOutcome::Success(_))|OutboundHTLCState::AwaitingRemovedRemoteRevoke(OutboundHTLCOutcome::Success(_)) => {
1545                                                 value_to_self_msat_offset -= htlc.amount_msat as i64;
1546                                         },
1547                                         OutboundHTLCState::RemoteRemoved(OutboundHTLCOutcome::Success(_)) => {
1548                                                 if !generated_by_local {
1549                                                         value_to_self_msat_offset -= htlc.amount_msat as i64;
1550                                                 }
1551                                         },
1552                                         _ => {},
1553                                 }
1554                         }
1555                 }
1556
1557                 let mut value_to_self_msat: i64 = (self.value_to_self_msat - local_htlc_total_msat) as i64 + value_to_self_msat_offset;
1558                 assert!(value_to_self_msat >= 0);
1559                 // Note that in case they have several just-awaiting-last-RAA fulfills in-progress (ie
1560                 // AwaitingRemoteRevokeToRemove or AwaitingRemovedRemoteRevoke) we may have allowed them to
1561                 // "violate" their reserve value by couting those against it. Thus, we have to convert
1562                 // everything to i64 before subtracting as otherwise we can overflow.
1563                 let mut 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;
1564                 assert!(value_to_remote_msat >= 0);
1565
1566                 #[cfg(debug_assertions)]
1567                 {
1568                         // Make sure that the to_self/to_remote is always either past the appropriate
1569                         // channel_reserve *or* it is making progress towards it.
1570                         let mut broadcaster_max_commitment_tx_output = if generated_by_local {
1571                                 self.holder_max_commitment_tx_output.lock().unwrap()
1572                         } else {
1573                                 self.counterparty_max_commitment_tx_output.lock().unwrap()
1574                         };
1575                         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);
1576                         broadcaster_max_commitment_tx_output.0 = cmp::max(broadcaster_max_commitment_tx_output.0, value_to_self_msat as u64);
1577                         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);
1578                         broadcaster_max_commitment_tx_output.1 = cmp::max(broadcaster_max_commitment_tx_output.1, value_to_remote_msat as u64);
1579                 }
1580
1581                 let total_fee_sat = Channel::<Signer>::commit_tx_fee_sat(feerate_per_kw, included_non_dust_htlcs.len(), self.channel_transaction_parameters.opt_anchors.is_some());
1582                 let anchors_val = if self.channel_transaction_parameters.opt_anchors.is_some() { ANCHOR_OUTPUT_VALUE_SATOSHI * 2 } else { 0 } as i64;
1583                 let (value_to_self, value_to_remote) = if self.is_outbound() {
1584                         (value_to_self_msat / 1000 - anchors_val - total_fee_sat as i64, value_to_remote_msat / 1000)
1585                 } else {
1586                         (value_to_self_msat / 1000, value_to_remote_msat / 1000 - anchors_val - total_fee_sat as i64)
1587                 };
1588
1589                 let mut value_to_a = if local { value_to_self } else { value_to_remote };
1590                 let mut value_to_b = if local { value_to_remote } else { value_to_self };
1591                 let (funding_pubkey_a, funding_pubkey_b) = if local {
1592                         (self.get_holder_pubkeys().funding_pubkey, self.get_counterparty_pubkeys().funding_pubkey)
1593                 } else {
1594                         (self.get_counterparty_pubkeys().funding_pubkey, self.get_holder_pubkeys().funding_pubkey)
1595                 };
1596
1597                 if value_to_a >= (broadcaster_dust_limit_satoshis as i64) {
1598                         log_trace!(logger, "   ...including {} output with value {}", if local { "to_local" } else { "to_remote" }, value_to_a);
1599                 } else {
1600                         value_to_a = 0;
1601                 }
1602
1603                 if value_to_b >= (broadcaster_dust_limit_satoshis as i64) {
1604                         log_trace!(logger, "   ...including {} output with value {}", if local { "to_remote" } else { "to_local" }, value_to_b);
1605                 } else {
1606                         value_to_b = 0;
1607                 }
1608
1609                 let num_nondust_htlcs = included_non_dust_htlcs.len();
1610
1611                 let channel_parameters =
1612                         if local { self.channel_transaction_parameters.as_holder_broadcastable() }
1613                         else { self.channel_transaction_parameters.as_counterparty_broadcastable() };
1614                 let tx = CommitmentTransaction::new_with_auxiliary_htlc_data(commitment_number,
1615                                                                              value_to_a as u64,
1616                                                                              value_to_b as u64,
1617                                                                              self.channel_transaction_parameters.opt_anchors.is_some(),
1618                                                                              funding_pubkey_a,
1619                                                                              funding_pubkey_b,
1620                                                                              keys.clone(),
1621                                                                              feerate_per_kw,
1622                                                                              &mut included_non_dust_htlcs,
1623                                                                              &channel_parameters
1624                 );
1625                 let mut htlcs_included = included_non_dust_htlcs;
1626                 // The unwrap is safe, because all non-dust HTLCs have been assigned an output index
1627                 htlcs_included.sort_unstable_by_key(|h| h.0.transaction_output_index.unwrap());
1628                 htlcs_included.append(&mut included_dust_htlcs);
1629
1630                 // For the stats, trimmed-to-0 the value in msats accordingly
1631                 value_to_self_msat = if (value_to_self_msat * 1000) < broadcaster_dust_limit_satoshis as i64 { 0 } else { value_to_self_msat };
1632                 value_to_remote_msat = if (value_to_remote_msat * 1000) < broadcaster_dust_limit_satoshis as i64 { 0 } else { value_to_remote_msat };
1633
1634                 CommitmentStats {
1635                         tx,
1636                         feerate_per_kw,
1637                         total_fee_sat,
1638                         num_nondust_htlcs,
1639                         htlcs_included,
1640                         local_balance_msat: value_to_self_msat as u64,
1641                         remote_balance_msat: value_to_remote_msat as u64,
1642                         preimages
1643                 }
1644         }
1645
1646         #[inline]
1647         fn get_closing_scriptpubkey(&self) -> Script {
1648                 // The shutdown scriptpubkey is set on channel opening when option_upfront_shutdown_script
1649                 // is signaled. Otherwise, it is set when sending a shutdown message. Calling this method
1650                 // outside of those situations will fail.
1651                 self.shutdown_scriptpubkey.clone().unwrap().into_inner()
1652         }
1653
1654         #[inline]
1655         fn get_closing_transaction_weight(&self, a_scriptpubkey: Option<&Script>, b_scriptpubkey: Option<&Script>) -> u64 {
1656                 let mut ret =
1657                 (4 +                                           // version
1658                  1 +                                           // input count
1659                  36 +                                          // prevout
1660                  1 +                                           // script length (0)
1661                  4 +                                           // sequence
1662                  1 +                                           // output count
1663                  4                                             // lock time
1664                  )*4 +                                         // * 4 for non-witness parts
1665                 2 +                                            // witness marker and flag
1666                 1 +                                            // witness element count
1667                 4 +                                            // 4 element lengths (2 sigs, multisig dummy, and witness script)
1668                 self.get_funding_redeemscript().len() as u64 + // funding witness script
1669                 2*(1 + 71);                                    // two signatures + sighash type flags
1670                 if let Some(spk) = a_scriptpubkey {
1671                         ret += ((8+1) +                            // output values and script length
1672                                 spk.len() as u64) * 4;                 // scriptpubkey and witness multiplier
1673                 }
1674                 if let Some(spk) = b_scriptpubkey {
1675                         ret += ((8+1) +                            // output values and script length
1676                                 spk.len() as u64) * 4;                 // scriptpubkey and witness multiplier
1677                 }
1678                 ret
1679         }
1680
1681         #[inline]
1682         fn build_closing_transaction(&self, proposed_total_fee_satoshis: u64, skip_remote_output: bool) -> (ClosingTransaction, u64) {
1683                 assert!(self.pending_inbound_htlcs.is_empty());
1684                 assert!(self.pending_outbound_htlcs.is_empty());
1685                 assert!(self.pending_update_fee.is_none());
1686
1687                 let mut total_fee_satoshis = proposed_total_fee_satoshis;
1688                 let mut value_to_holder: i64 = (self.value_to_self_msat as i64) / 1000 - if self.is_outbound() { total_fee_satoshis as i64 } else { 0 };
1689                 let mut value_to_counterparty: i64 = ((self.channel_value_satoshis * 1000 - self.value_to_self_msat) as i64 / 1000) - if self.is_outbound() { 0 } else { total_fee_satoshis as i64 };
1690
1691                 if value_to_holder < 0 {
1692                         assert!(self.is_outbound());
1693                         total_fee_satoshis += (-value_to_holder) as u64;
1694                 } else if value_to_counterparty < 0 {
1695                         assert!(!self.is_outbound());
1696                         total_fee_satoshis += (-value_to_counterparty) as u64;
1697                 }
1698
1699                 if skip_remote_output || value_to_counterparty as u64 <= self.holder_dust_limit_satoshis {
1700                         value_to_counterparty = 0;
1701                 }
1702
1703                 if value_to_holder as u64 <= self.holder_dust_limit_satoshis {
1704                         value_to_holder = 0;
1705                 }
1706
1707                 assert!(self.shutdown_scriptpubkey.is_some());
1708                 let holder_shutdown_script = self.get_closing_scriptpubkey();
1709                 let counterparty_shutdown_script = self.counterparty_shutdown_scriptpubkey.clone().unwrap();
1710                 let funding_outpoint = self.funding_outpoint().into_bitcoin_outpoint();
1711
1712                 let closing_transaction = ClosingTransaction::new(value_to_holder as u64, value_to_counterparty as u64, holder_shutdown_script, counterparty_shutdown_script, funding_outpoint);
1713                 (closing_transaction, total_fee_satoshis)
1714         }
1715
1716         fn funding_outpoint(&self) -> OutPoint {
1717                 self.channel_transaction_parameters.funding_outpoint.unwrap()
1718         }
1719
1720         #[inline]
1721         /// Creates a set of keys for build_commitment_transaction to generate a transaction which our
1722         /// counterparty will sign (ie DO NOT send signatures over a transaction created by this to
1723         /// our counterparty!)
1724         /// The result is a transaction which we can revoke broadcastership of (ie a "local" transaction)
1725         /// TODO Some magic rust shit to compile-time check this?
1726         fn build_holder_transaction_keys(&self, commitment_number: u64) -> Result<TxCreationKeys, ChannelError> {
1727                 let per_commitment_point = self.holder_signer.get_per_commitment_point(commitment_number, &self.secp_ctx);
1728                 let delayed_payment_base = &self.get_holder_pubkeys().delayed_payment_basepoint;
1729                 let htlc_basepoint = &self.get_holder_pubkeys().htlc_basepoint;
1730                 let counterparty_pubkeys = self.get_counterparty_pubkeys();
1731
1732                 Ok(secp_check!(TxCreationKeys::derive_new(&self.secp_ctx, &per_commitment_point, delayed_payment_base, htlc_basepoint, &counterparty_pubkeys.revocation_basepoint, &counterparty_pubkeys.htlc_basepoint), "Local tx keys generation got bogus keys".to_owned()))
1733         }
1734
1735         #[inline]
1736         /// Creates a set of keys for build_commitment_transaction to generate a transaction which we
1737         /// will sign and send to our counterparty.
1738         /// If an Err is returned, it is a ChannelError::Close (for get_outbound_funding_created)
1739         fn build_remote_transaction_keys(&self) -> Result<TxCreationKeys, ChannelError> {
1740                 //TODO: Ensure that the payment_key derived here ends up in the library users' wallet as we
1741                 //may see payments to it!
1742                 let revocation_basepoint = &self.get_holder_pubkeys().revocation_basepoint;
1743                 let htlc_basepoint = &self.get_holder_pubkeys().htlc_basepoint;
1744                 let counterparty_pubkeys = self.get_counterparty_pubkeys();
1745
1746                 Ok(secp_check!(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), "Remote tx keys generation got bogus keys".to_owned()))
1747         }
1748
1749         /// Gets the redeemscript for the funding transaction output (ie the funding transaction output
1750         /// pays to get_funding_redeemscript().to_v0_p2wsh()).
1751         /// Panics if called before accept_channel/new_from_req
1752         pub fn get_funding_redeemscript(&self) -> Script {
1753                 make_funding_redeemscript(&self.get_holder_pubkeys().funding_pubkey, self.counterparty_funding_pubkey())
1754         }
1755
1756         /// Claims an HTLC while we're disconnected from a peer, dropping the [`ChannelMonitorUpdate`]
1757         /// entirely.
1758         ///
1759         /// The [`ChannelMonitor`] for this channel MUST be updated out-of-band with the preimage
1760         /// provided (i.e. without calling [`crate::chain::Watch::update_channel`]).
1761         ///
1762         /// The HTLC claim will end up in the holding cell (because the caller must ensure the peer is
1763         /// disconnected).
1764         pub fn claim_htlc_while_disconnected_dropping_mon_update<L: Deref>
1765                 (&mut self, htlc_id_arg: u64, payment_preimage_arg: PaymentPreimage, logger: &L)
1766         where L::Target: Logger {
1767                 // Assert that we'll add the HTLC claim to the holding cell in `get_update_fulfill_htlc`
1768                 // (see equivalent if condition there).
1769                 assert!(self.channel_state & (ChannelState::AwaitingRemoteRevoke as u32 | ChannelState::PeerDisconnected as u32 | ChannelState::MonitorUpdateFailed as u32) != 0);
1770                 let mon_update_id = self.latest_monitor_update_id; // Forget the ChannelMonitor update
1771                 let fulfill_resp = self.get_update_fulfill_htlc(htlc_id_arg, payment_preimage_arg, logger);
1772                 self.latest_monitor_update_id = mon_update_id;
1773                 if let UpdateFulfillFetch::NewClaim { msg, .. } = fulfill_resp {
1774                         assert!(msg.is_none()); // The HTLC must have ended up in the holding cell.
1775                 }
1776         }
1777
1778         fn get_update_fulfill_htlc<L: Deref>(&mut self, htlc_id_arg: u64, payment_preimage_arg: PaymentPreimage, logger: &L) -> UpdateFulfillFetch where L::Target: Logger {
1779                 // Either ChannelFunded got set (which means it won't be unset) or there is no way any
1780                 // caller thought we could have something claimed (cause we wouldn't have accepted in an
1781                 // incoming HTLC anyway). If we got to ShutdownComplete, callers aren't allowed to call us,
1782                 // either.
1783                 if (self.channel_state & (ChannelState::ChannelFunded as u32)) != (ChannelState::ChannelFunded as u32) {
1784                         panic!("Was asked to fulfill an HTLC when channel was not in an operational state");
1785                 }
1786                 assert_eq!(self.channel_state & ChannelState::ShutdownComplete as u32, 0);
1787
1788                 let payment_hash_calc = PaymentHash(Sha256::hash(&payment_preimage_arg.0[..]).into_inner());
1789
1790                 // ChannelManager may generate duplicate claims/fails due to HTLC update events from
1791                 // on-chain ChannelsMonitors during block rescan. Ideally we'd figure out a way to drop
1792                 // these, but for now we just have to treat them as normal.
1793
1794                 let mut pending_idx = core::usize::MAX;
1795                 let mut htlc_value_msat = 0;
1796                 for (idx, htlc) in self.pending_inbound_htlcs.iter().enumerate() {
1797                         if htlc.htlc_id == htlc_id_arg {
1798                                 assert_eq!(htlc.payment_hash, payment_hash_calc);
1799                                 match htlc.state {
1800                                         InboundHTLCState::Committed => {},
1801                                         InboundHTLCState::LocalRemoved(ref reason) => {
1802                                                 if let &InboundHTLCRemovalReason::Fulfill(_) = reason {
1803                                                 } else {
1804                                                         log_warn!(logger, "Have preimage and want to fulfill HTLC with payment hash {} we already failed against channel {}", log_bytes!(htlc.payment_hash.0), log_bytes!(self.channel_id()));
1805                                                         debug_assert!(false, "Tried to fulfill an HTLC that was already failed");
1806                                                 }
1807                                                 return UpdateFulfillFetch::DuplicateClaim {};
1808                                         },
1809                                         _ => {
1810                                                 debug_assert!(false, "Have an inbound HTLC we tried to claim before it was fully committed to");
1811                                                 // Don't return in release mode here so that we can update channel_monitor
1812                                         }
1813                                 }
1814                                 pending_idx = idx;
1815                                 htlc_value_msat = htlc.amount_msat;
1816                                 break;
1817                         }
1818                 }
1819                 if pending_idx == core::usize::MAX {
1820                         #[cfg(any(test, fuzzing))]
1821                         // If we failed to find an HTLC to fulfill, make sure it was previously fulfilled and
1822                         // this is simply a duplicate claim, not previously failed and we lost funds.
1823                         debug_assert!(self.historical_inbound_htlc_fulfills.contains(&htlc_id_arg));
1824                         return UpdateFulfillFetch::DuplicateClaim {};
1825                 }
1826
1827                 // Now update local state:
1828                 //
1829                 // We have to put the payment_preimage in the channel_monitor right away here to ensure we
1830                 // can claim it even if the channel hits the chain before we see their next commitment.
1831                 self.latest_monitor_update_id += 1;
1832                 let monitor_update = ChannelMonitorUpdate {
1833                         update_id: self.latest_monitor_update_id,
1834                         updates: vec![ChannelMonitorUpdateStep::PaymentPreimage {
1835                                 payment_preimage: payment_preimage_arg.clone(),
1836                         }],
1837                 };
1838
1839                 if (self.channel_state & (ChannelState::AwaitingRemoteRevoke as u32 | ChannelState::PeerDisconnected as u32 | ChannelState::MonitorUpdateFailed as u32)) != 0 {
1840                         // Note that this condition is the same as the assertion in
1841                         // `claim_htlc_while_disconnected_dropping_mon_update` and must match exactly -
1842                         // `claim_htlc_while_disconnected_dropping_mon_update` would not work correctly if we
1843                         // do not not get into this branch.
1844                         for pending_update in self.holding_cell_htlc_updates.iter() {
1845                                 match pending_update {
1846                                         &HTLCUpdateAwaitingACK::ClaimHTLC { htlc_id, .. } => {
1847                                                 if htlc_id_arg == htlc_id {
1848                                                         // Make sure we don't leave latest_monitor_update_id incremented here:
1849                                                         self.latest_monitor_update_id -= 1;
1850                                                         #[cfg(any(test, fuzzing))]
1851                                                         debug_assert!(self.historical_inbound_htlc_fulfills.contains(&htlc_id_arg));
1852                                                         return UpdateFulfillFetch::DuplicateClaim {};
1853                                                 }
1854                                         },
1855                                         &HTLCUpdateAwaitingACK::FailHTLC { htlc_id, .. } => {
1856                                                 if htlc_id_arg == htlc_id {
1857                                                         log_warn!(logger, "Have preimage and want to fulfill HTLC with pending failure against channel {}", log_bytes!(self.channel_id()));
1858                                                         // TODO: We may actually be able to switch to a fulfill here, though its
1859                                                         // rare enough it may not be worth the complexity burden.
1860                                                         debug_assert!(false, "Tried to fulfill an HTLC that was already failed");
1861                                                         return UpdateFulfillFetch::NewClaim { monitor_update, htlc_value_msat, msg: None };
1862                                                 }
1863                                         },
1864                                         _ => {}
1865                                 }
1866                         }
1867                         log_trace!(logger, "Adding HTLC claim to holding_cell in channel {}! Current state: {}", log_bytes!(self.channel_id()), self.channel_state);
1868                         self.holding_cell_htlc_updates.push(HTLCUpdateAwaitingACK::ClaimHTLC {
1869                                 payment_preimage: payment_preimage_arg, htlc_id: htlc_id_arg,
1870                         });
1871                         #[cfg(any(test, fuzzing))]
1872                         self.historical_inbound_htlc_fulfills.insert(htlc_id_arg);
1873                         return UpdateFulfillFetch::NewClaim { monitor_update, htlc_value_msat, msg: None };
1874                 }
1875                 #[cfg(any(test, fuzzing))]
1876                 self.historical_inbound_htlc_fulfills.insert(htlc_id_arg);
1877
1878                 {
1879                         let htlc = &mut self.pending_inbound_htlcs[pending_idx];
1880                         if let InboundHTLCState::Committed = htlc.state {
1881                         } else {
1882                                 debug_assert!(false, "Have an inbound HTLC we tried to claim before it was fully committed to");
1883                                 return UpdateFulfillFetch::NewClaim { monitor_update, htlc_value_msat, msg: None };
1884                         }
1885                         log_trace!(logger, "Upgrading HTLC {} to LocalRemoved with a Fulfill in channel {}!", log_bytes!(htlc.payment_hash.0), log_bytes!(self.channel_id));
1886                         htlc.state = InboundHTLCState::LocalRemoved(InboundHTLCRemovalReason::Fulfill(payment_preimage_arg.clone()));
1887                 }
1888
1889                 UpdateFulfillFetch::NewClaim {
1890                         monitor_update,
1891                         htlc_value_msat,
1892                         msg: Some(msgs::UpdateFulfillHTLC {
1893                                 channel_id: self.channel_id(),
1894                                 htlc_id: htlc_id_arg,
1895                                 payment_preimage: payment_preimage_arg,
1896                         }),
1897                 }
1898         }
1899
1900         pub fn get_update_fulfill_htlc_and_commit<L: Deref>(&mut self, htlc_id: u64, payment_preimage: PaymentPreimage, logger: &L) -> Result<UpdateFulfillCommitFetch, (ChannelError, ChannelMonitorUpdate)> where L::Target: Logger {
1901                 match self.get_update_fulfill_htlc(htlc_id, payment_preimage, logger) {
1902                         UpdateFulfillFetch::NewClaim { mut monitor_update, htlc_value_msat, msg: Some(update_fulfill_htlc) } => {
1903                                 let (commitment, mut additional_update) = match self.send_commitment_no_status_check(logger) {
1904                                         Err(e) => return Err((e, monitor_update)),
1905                                         Ok(res) => res
1906                                 };
1907                                 // send_commitment_no_status_check may bump latest_monitor_id but we want them to be
1908                                 // strictly increasing by one, so decrement it here.
1909                                 self.latest_monitor_update_id = monitor_update.update_id;
1910                                 monitor_update.updates.append(&mut additional_update.updates);
1911                                 Ok(UpdateFulfillCommitFetch::NewClaim { monitor_update, htlc_value_msat, msgs: Some((update_fulfill_htlc, commitment)) })
1912                         },
1913                         UpdateFulfillFetch::NewClaim { monitor_update, htlc_value_msat, msg: None } =>
1914                                 Ok(UpdateFulfillCommitFetch::NewClaim { monitor_update, htlc_value_msat, msgs: None }),
1915                         UpdateFulfillFetch::DuplicateClaim {} => Ok(UpdateFulfillCommitFetch::DuplicateClaim {}),
1916                 }
1917         }
1918
1919         /// We can only have one resolution per HTLC. In some cases around reconnect, we may fulfill
1920         /// an HTLC more than once or fulfill once and then attempt to fail after reconnect. We cannot,
1921         /// however, fail more than once as we wait for an upstream failure to be irrevocably committed
1922         /// before we fail backwards.
1923         /// If we do fail twice, we debug_assert!(false) and return Ok(None). Thus, will always return
1924         /// Ok(_) if debug assertions are turned on or preconditions are met.
1925         pub fn get_update_fail_htlc<L: Deref>(&mut self, htlc_id_arg: u64, err_packet: msgs::OnionErrorPacket, logger: &L) -> Result<Option<msgs::UpdateFailHTLC>, ChannelError> where L::Target: Logger {
1926                 if (self.channel_state & (ChannelState::ChannelFunded as u32)) != (ChannelState::ChannelFunded as u32) {
1927                         panic!("Was asked to fail an HTLC when channel was not in an operational state");
1928                 }
1929                 assert_eq!(self.channel_state & ChannelState::ShutdownComplete as u32, 0);
1930
1931                 // ChannelManager may generate duplicate claims/fails due to HTLC update events from
1932                 // on-chain ChannelsMonitors during block rescan. Ideally we'd figure out a way to drop
1933                 // these, but for now we just have to treat them as normal.
1934
1935                 let mut pending_idx = core::usize::MAX;
1936                 for (idx, htlc) in self.pending_inbound_htlcs.iter().enumerate() {
1937                         if htlc.htlc_id == htlc_id_arg {
1938                                 match htlc.state {
1939                                         InboundHTLCState::Committed => {},
1940                                         InboundHTLCState::LocalRemoved(ref reason) => {
1941                                                 if let &InboundHTLCRemovalReason::Fulfill(_) = reason {
1942                                                 } else {
1943                                                         debug_assert!(false, "Tried to fail an HTLC that was already failed");
1944                                                 }
1945                                                 return Ok(None);
1946                                         },
1947                                         _ => {
1948                                                 debug_assert!(false, "Have an inbound HTLC we tried to claim before it was fully committed to");
1949                                                 return Err(ChannelError::Ignore(format!("Unable to find a pending HTLC which matched the given HTLC ID ({})", htlc.htlc_id)));
1950                                         }
1951                                 }
1952                                 pending_idx = idx;
1953                         }
1954                 }
1955                 if pending_idx == core::usize::MAX {
1956                         #[cfg(any(test, fuzzing))]
1957                         // If we failed to find an HTLC to fail, make sure it was previously fulfilled and this
1958                         // is simply a duplicate fail, not previously failed and we failed-back too early.
1959                         debug_assert!(self.historical_inbound_htlc_fulfills.contains(&htlc_id_arg));
1960                         return Ok(None);
1961                 }
1962
1963                 // Now update local state:
1964                 if (self.channel_state & (ChannelState::AwaitingRemoteRevoke as u32 | ChannelState::PeerDisconnected as u32 | ChannelState::MonitorUpdateFailed as u32)) != 0 {
1965                         for pending_update in self.holding_cell_htlc_updates.iter() {
1966                                 match pending_update {
1967                                         &HTLCUpdateAwaitingACK::ClaimHTLC { htlc_id, .. } => {
1968                                                 if htlc_id_arg == htlc_id {
1969                                                         #[cfg(any(test, fuzzing))]
1970                                                         debug_assert!(self.historical_inbound_htlc_fulfills.contains(&htlc_id_arg));
1971                                                         return Ok(None);
1972                                                 }
1973                                         },
1974                                         &HTLCUpdateAwaitingACK::FailHTLC { htlc_id, .. } => {
1975                                                 if htlc_id_arg == htlc_id {
1976                                                         debug_assert!(false, "Tried to fail an HTLC that was already failed");
1977                                                         return Err(ChannelError::Ignore("Unable to find a pending HTLC which matched the given HTLC ID".to_owned()));
1978                                                 }
1979                                         },
1980                                         _ => {}
1981                                 }
1982                         }
1983                         log_trace!(logger, "Placing failure for HTLC ID {} in holding cell in channel {}.", htlc_id_arg, log_bytes!(self.channel_id()));
1984                         self.holding_cell_htlc_updates.push(HTLCUpdateAwaitingACK::FailHTLC {
1985                                 htlc_id: htlc_id_arg,
1986                                 err_packet,
1987                         });
1988                         return Ok(None);
1989                 }
1990
1991                 log_trace!(logger, "Failing HTLC ID {} back with a update_fail_htlc message in channel {}.", htlc_id_arg, log_bytes!(self.channel_id()));
1992                 {
1993                         let htlc = &mut self.pending_inbound_htlcs[pending_idx];
1994                         htlc.state = InboundHTLCState::LocalRemoved(InboundHTLCRemovalReason::FailRelay(err_packet.clone()));
1995                 }
1996
1997                 Ok(Some(msgs::UpdateFailHTLC {
1998                         channel_id: self.channel_id(),
1999                         htlc_id: htlc_id_arg,
2000                         reason: err_packet
2001                 }))
2002         }
2003
2004         // Message handlers:
2005
2006         pub fn accept_channel(&mut self, msg: &msgs::AcceptChannel, default_limits: &ChannelHandshakeLimits, their_features: &InitFeatures) -> Result<(), ChannelError> {
2007                 let peer_limits = if let Some(ref limits) = self.inbound_handshake_limits_override { limits } else { default_limits };
2008
2009                 // Check sanity of message fields:
2010                 if !self.is_outbound() {
2011                         return Err(ChannelError::Close("Got an accept_channel message from an inbound peer".to_owned()));
2012                 }
2013                 if self.channel_state != ChannelState::OurInitSent as u32 {
2014                         return Err(ChannelError::Close("Got an accept_channel message at a strange time".to_owned()));
2015                 }
2016                 if msg.dust_limit_satoshis > 21000000 * 100000000 {
2017                         return Err(ChannelError::Close(format!("Peer never wants payout outputs? dust_limit_satoshis was {}", msg.dust_limit_satoshis)));
2018                 }
2019                 if msg.channel_reserve_satoshis > self.channel_value_satoshis {
2020                         return Err(ChannelError::Close(format!("Bogus channel_reserve_satoshis ({}). Must not be greater than ({})", msg.channel_reserve_satoshis, self.channel_value_satoshis)));
2021                 }
2022                 if msg.dust_limit_satoshis > self.holder_selected_channel_reserve_satoshis {
2023                         return Err(ChannelError::Close(format!("Dust limit ({}) is bigger than our channel reserve ({})", msg.dust_limit_satoshis, self.holder_selected_channel_reserve_satoshis)));
2024                 }
2025                 if msg.channel_reserve_satoshis > self.channel_value_satoshis - self.holder_selected_channel_reserve_satoshis {
2026                         return Err(ChannelError::Close(format!("Bogus channel_reserve_satoshis ({}). Must not be greater than channel value minus our reserve ({})",
2027                                 msg.channel_reserve_satoshis, self.channel_value_satoshis - self.holder_selected_channel_reserve_satoshis)));
2028                 }
2029                 let full_channel_value_msat = (self.channel_value_satoshis - msg.channel_reserve_satoshis) * 1000;
2030                 if msg.htlc_minimum_msat >= full_channel_value_msat {
2031                         return Err(ChannelError::Close(format!("Minimum htlc value ({}) is full channel value ({})", msg.htlc_minimum_msat, full_channel_value_msat)));
2032                 }
2033                 let max_delay_acceptable = u16::min(peer_limits.their_to_self_delay, MAX_LOCAL_BREAKDOWN_TIMEOUT);
2034                 if msg.to_self_delay > max_delay_acceptable {
2035                         return Err(ChannelError::Close(format!("They wanted our payments to be delayed by a needlessly long period. Upper limit: {}. Actual: {}", max_delay_acceptable, msg.to_self_delay)));
2036                 }
2037                 if msg.max_accepted_htlcs < 1 {
2038                         return Err(ChannelError::Close("0 max_accepted_htlcs makes for a useless channel".to_owned()));
2039                 }
2040                 if msg.max_accepted_htlcs > MAX_HTLCS {
2041                         return Err(ChannelError::Close(format!("max_accepted_htlcs was {}. It must not be larger than {}", msg.max_accepted_htlcs, MAX_HTLCS)));
2042                 }
2043
2044                 // Now check against optional parameters as set by config...
2045                 if msg.htlc_minimum_msat > peer_limits.max_htlc_minimum_msat {
2046                         return Err(ChannelError::Close(format!("htlc_minimum_msat ({}) is higher than the user specified limit ({})", msg.htlc_minimum_msat, peer_limits.max_htlc_minimum_msat)));
2047                 }
2048                 if msg.max_htlc_value_in_flight_msat < peer_limits.min_max_htlc_value_in_flight_msat {
2049                         return Err(ChannelError::Close(format!("max_htlc_value_in_flight_msat ({}) is less than the user specified limit ({})", msg.max_htlc_value_in_flight_msat, peer_limits.min_max_htlc_value_in_flight_msat)));
2050                 }
2051                 if msg.channel_reserve_satoshis > peer_limits.max_channel_reserve_satoshis {
2052                         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)));
2053                 }
2054                 if msg.max_accepted_htlcs < peer_limits.min_max_accepted_htlcs {
2055                         return Err(ChannelError::Close(format!("max_accepted_htlcs ({}) is less than the user specified limit ({})", msg.max_accepted_htlcs, peer_limits.min_max_accepted_htlcs)));
2056                 }
2057                 if msg.dust_limit_satoshis < MIN_CHAN_DUST_LIMIT_SATOSHIS {
2058                         return Err(ChannelError::Close(format!("dust_limit_satoshis ({}) is less than the implementation limit ({})", msg.dust_limit_satoshis, MIN_CHAN_DUST_LIMIT_SATOSHIS)));
2059                 }
2060                 if msg.dust_limit_satoshis > MAX_CHAN_DUST_LIMIT_SATOSHIS {
2061                         return Err(ChannelError::Close(format!("dust_limit_satoshis ({}) is greater than the implementation limit ({})", msg.dust_limit_satoshis, MAX_CHAN_DUST_LIMIT_SATOSHIS)));
2062                 }
2063                 if msg.minimum_depth > peer_limits.max_minimum_depth {
2064                         return Err(ChannelError::Close(format!("We consider the minimum depth to be unreasonably large. Expected minimum: ({}). Actual: ({})", peer_limits.max_minimum_depth, msg.minimum_depth)));
2065                 }
2066
2067                 if let Some(ty) = &msg.channel_type {
2068                         if *ty != self.channel_type {
2069                                 return Err(ChannelError::Close("Channel Type in accept_channel didn't match the one sent in open_channel.".to_owned()));
2070                         }
2071                 } else if their_features.supports_channel_type() {
2072                         // Assume they've accepted the channel type as they said they understand it.
2073                 } else {
2074                         self.channel_type = ChannelTypeFeatures::from_counterparty_init(&their_features)
2075                 }
2076
2077                 let counterparty_shutdown_scriptpubkey = if their_features.supports_upfront_shutdown_script() {
2078                         match &msg.shutdown_scriptpubkey {
2079                                 &OptionalField::Present(ref script) => {
2080                                         // Peer is signaling upfront_shutdown and has opt-out with a 0-length script. We don't enforce anything
2081                                         if script.len() == 0 {
2082                                                 None
2083                                         } else {
2084                                                 if !script::is_bolt2_compliant(&script, their_features) {
2085                                                         return Err(ChannelError::Close(format!("Peer is signaling upfront_shutdown but has provided an unacceptable scriptpubkey format: {}", script)));
2086                                                 }
2087                                                 Some(script.clone())
2088                                         }
2089                                 },
2090                                 // 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
2091                                 &OptionalField::Absent => {
2092                                         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()));
2093                                 }
2094                         }
2095                 } else { None };
2096
2097                 self.counterparty_dust_limit_satoshis = msg.dust_limit_satoshis;
2098                 self.counterparty_max_htlc_value_in_flight_msat = cmp::min(msg.max_htlc_value_in_flight_msat, self.channel_value_satoshis * 1000);
2099                 self.counterparty_selected_channel_reserve_satoshis = Some(msg.channel_reserve_satoshis);
2100                 self.counterparty_htlc_minimum_msat = msg.htlc_minimum_msat;
2101                 self.counterparty_max_accepted_htlcs = msg.max_accepted_htlcs;
2102
2103                 if peer_limits.trust_own_funding_0conf {
2104                         self.minimum_depth = Some(msg.minimum_depth);
2105                 } else {
2106                         self.minimum_depth = Some(cmp::max(1, msg.minimum_depth));
2107                 }
2108
2109                 let counterparty_pubkeys = ChannelPublicKeys {
2110                         funding_pubkey: msg.funding_pubkey,
2111                         revocation_basepoint: msg.revocation_basepoint,
2112                         payment_point: msg.payment_point,
2113                         delayed_payment_basepoint: msg.delayed_payment_basepoint,
2114                         htlc_basepoint: msg.htlc_basepoint
2115                 };
2116
2117                 self.channel_transaction_parameters.counterparty_parameters = Some(CounterpartyChannelTransactionParameters {
2118                         selected_contest_delay: msg.to_self_delay,
2119                         pubkeys: counterparty_pubkeys,
2120                 });
2121
2122                 self.counterparty_cur_commitment_point = Some(msg.first_per_commitment_point);
2123                 self.counterparty_shutdown_scriptpubkey = counterparty_shutdown_scriptpubkey;
2124
2125                 self.channel_state = ChannelState::OurInitSent as u32 | ChannelState::TheirInitSent as u32;
2126                 self.inbound_handshake_limits_override = None; // We're done enforcing limits on our peer's handshake now.
2127
2128                 Ok(())
2129         }
2130
2131         fn funding_created_signature<L: Deref>(&mut self, sig: &Signature, logger: &L) -> Result<(Txid, CommitmentTransaction, Signature), ChannelError> where L::Target: Logger {
2132                 let funding_script = self.get_funding_redeemscript();
2133
2134                 let keys = self.build_holder_transaction_keys(self.cur_holder_commitment_transaction_number)?;
2135                 let initial_commitment_tx = self.build_commitment_transaction(self.cur_holder_commitment_transaction_number, &keys, true, false, logger).tx;
2136                 {
2137                         let trusted_tx = initial_commitment_tx.trust();
2138                         let initial_commitment_bitcoin_tx = trusted_tx.built_transaction();
2139                         let sighash = initial_commitment_bitcoin_tx.get_sighash_all(&funding_script, self.channel_value_satoshis);
2140                         // They sign the holder commitment transaction...
2141                         log_trace!(logger, "Checking funding_created tx signature {} by key {} against tx {} (sighash {}) with redeemscript {} for channel {}.",
2142                                 log_bytes!(sig.serialize_compact()[..]), log_bytes!(self.counterparty_funding_pubkey().serialize()),
2143                                 encode::serialize_hex(&initial_commitment_bitcoin_tx.transaction), log_bytes!(sighash[..]),
2144                                 encode::serialize_hex(&funding_script), log_bytes!(self.channel_id()));
2145                         secp_check!(self.secp_ctx.verify_ecdsa(&sighash, &sig, self.counterparty_funding_pubkey()), "Invalid funding_created signature from peer".to_owned());
2146                 }
2147
2148                 let counterparty_keys = self.build_remote_transaction_keys()?;
2149                 let counterparty_initial_commitment_tx = self.build_commitment_transaction(self.cur_counterparty_commitment_transaction_number, &counterparty_keys, false, false, logger).tx;
2150
2151                 let counterparty_trusted_tx = counterparty_initial_commitment_tx.trust();
2152                 let counterparty_initial_bitcoin_tx = counterparty_trusted_tx.built_transaction();
2153                 log_trace!(logger, "Initial counterparty tx for channel {} is: txid {} tx {}",
2154                         log_bytes!(self.channel_id()), counterparty_initial_bitcoin_tx.txid, encode::serialize_hex(&counterparty_initial_bitcoin_tx.transaction));
2155
2156                 let counterparty_signature = self.holder_signer.sign_counterparty_commitment(&counterparty_initial_commitment_tx, Vec::new(), &self.secp_ctx)
2157                                 .map_err(|_| ChannelError::Close("Failed to get signatures for new commitment_signed".to_owned()))?.0;
2158
2159                 // We sign "counterparty" commitment transaction, allowing them to broadcast the tx if they wish.
2160                 Ok((counterparty_initial_bitcoin_tx.txid, initial_commitment_tx, counterparty_signature))
2161         }
2162
2163         fn counterparty_funding_pubkey(&self) -> &PublicKey {
2164                 &self.get_counterparty_pubkeys().funding_pubkey
2165         }
2166
2167         pub fn funding_created<L: Deref>(&mut self, msg: &msgs::FundingCreated, best_block: BestBlock, logger: &L) -> Result<(msgs::FundingSigned, ChannelMonitor<Signer>, Option<msgs::ChannelReady>), ChannelError> where L::Target: Logger {
2168                 if self.is_outbound() {
2169                         return Err(ChannelError::Close("Received funding_created for an outbound channel?".to_owned()));
2170                 }
2171                 if self.channel_state != (ChannelState::OurInitSent as u32 | ChannelState::TheirInitSent as u32) {
2172                         // BOLT 2 says that if we disconnect before we send funding_signed we SHOULD NOT
2173                         // remember the channel, so it's safe to just send an error_message here and drop the
2174                         // channel.
2175                         return Err(ChannelError::Close("Received funding_created after we got the channel!".to_owned()));
2176                 }
2177                 if self.inbound_awaiting_accept {
2178                         return Err(ChannelError::Close("FundingCreated message received before the channel was accepted".to_owned()));
2179                 }
2180                 if self.commitment_secrets.get_min_seen_secret() != (1 << 48) ||
2181                                 self.cur_counterparty_commitment_transaction_number != INITIAL_COMMITMENT_NUMBER ||
2182                                 self.cur_holder_commitment_transaction_number != INITIAL_COMMITMENT_NUMBER {
2183                         panic!("Should not have advanced channel commitment tx numbers prior to funding_created");
2184                 }
2185
2186                 let funding_txo = OutPoint { txid: msg.funding_txid, index: msg.funding_output_index };
2187                 self.channel_transaction_parameters.funding_outpoint = Some(funding_txo);
2188                 // This is an externally observable change before we finish all our checks.  In particular
2189                 // funding_created_signature may fail.
2190                 self.holder_signer.ready_channel(&self.channel_transaction_parameters);
2191
2192                 let (counterparty_initial_commitment_txid, initial_commitment_tx, signature) = match self.funding_created_signature(&msg.signature, logger) {
2193                         Ok(res) => res,
2194                         Err(ChannelError::Close(e)) => {
2195                                 self.channel_transaction_parameters.funding_outpoint = None;
2196                                 return Err(ChannelError::Close(e));
2197                         },
2198                         Err(e) => {
2199                                 // The only error we know how to handle is ChannelError::Close, so we fall over here
2200                                 // to make sure we don't continue with an inconsistent state.
2201                                 panic!("unexpected error type from funding_created_signature {:?}", e);
2202                         }
2203                 };
2204
2205                 let holder_commitment_tx = HolderCommitmentTransaction::new(
2206                         initial_commitment_tx,
2207                         msg.signature,
2208                         Vec::new(),
2209                         &self.get_holder_pubkeys().funding_pubkey,
2210                         self.counterparty_funding_pubkey()
2211                 );
2212
2213                 self.holder_signer.validate_holder_commitment(&holder_commitment_tx, Vec::new())
2214                         .map_err(|_| ChannelError::Close("Failed to validate our commitment".to_owned()))?;
2215
2216                 // Now that we're past error-generating stuff, update our local state:
2217
2218                 let funding_redeemscript = self.get_funding_redeemscript();
2219                 let funding_txo_script = funding_redeemscript.to_v0_p2wsh();
2220                 let obscure_factor = get_commitment_transaction_number_obscure_factor(&self.get_holder_pubkeys().payment_point, &self.get_counterparty_pubkeys().payment_point, self.is_outbound());
2221                 let shutdown_script = self.shutdown_scriptpubkey.clone().map(|script| script.into_inner());
2222                 let channel_monitor = ChannelMonitor::new(self.secp_ctx.clone(), self.holder_signer.clone(),
2223                                                           shutdown_script, self.get_holder_selected_contest_delay(),
2224                                                           &self.destination_script, (funding_txo, funding_txo_script.clone()),
2225                                                           &self.channel_transaction_parameters,
2226                                                           funding_redeemscript.clone(), self.channel_value_satoshis,
2227                                                           obscure_factor,
2228                                                           holder_commitment_tx, best_block, self.counterparty_node_id);
2229
2230                 channel_monitor.provide_latest_counterparty_commitment_tx(counterparty_initial_commitment_txid, Vec::new(), self.cur_counterparty_commitment_transaction_number, self.counterparty_cur_commitment_point.unwrap(), logger);
2231
2232                 self.channel_state = ChannelState::FundingSent as u32;
2233                 self.channel_id = funding_txo.to_channel_id();
2234                 self.cur_counterparty_commitment_transaction_number -= 1;
2235                 self.cur_holder_commitment_transaction_number -= 1;
2236
2237                 log_info!(logger, "Generated funding_signed for peer for channel {}", log_bytes!(self.channel_id()));
2238
2239                 Ok((msgs::FundingSigned {
2240                         channel_id: self.channel_id,
2241                         signature
2242                 }, channel_monitor, self.check_get_channel_ready(0)))
2243         }
2244
2245         /// Handles a funding_signed message from the remote end.
2246         /// If this call is successful, broadcast the funding transaction (and not before!)
2247         pub fn funding_signed<L: Deref>(&mut self, msg: &msgs::FundingSigned, best_block: BestBlock, logger: &L) -> Result<(ChannelMonitor<Signer>, Transaction, Option<msgs::ChannelReady>), ChannelError> where L::Target: Logger {
2248                 if !self.is_outbound() {
2249                         return Err(ChannelError::Close("Received funding_signed for an inbound channel?".to_owned()));
2250                 }
2251                 if self.channel_state & !(ChannelState::MonitorUpdateFailed as u32) != ChannelState::FundingCreated as u32 {
2252                         return Err(ChannelError::Close("Received funding_signed in strange state!".to_owned()));
2253                 }
2254                 if self.commitment_secrets.get_min_seen_secret() != (1 << 48) ||
2255                                 self.cur_counterparty_commitment_transaction_number != INITIAL_COMMITMENT_NUMBER ||
2256                                 self.cur_holder_commitment_transaction_number != INITIAL_COMMITMENT_NUMBER {
2257                         panic!("Should not have advanced channel commitment tx numbers prior to funding_created");
2258                 }
2259
2260                 let funding_script = self.get_funding_redeemscript();
2261
2262                 let counterparty_keys = self.build_remote_transaction_keys()?;
2263                 let counterparty_initial_commitment_tx = self.build_commitment_transaction(self.cur_counterparty_commitment_transaction_number, &counterparty_keys, false, false, logger).tx;
2264                 let counterparty_trusted_tx = counterparty_initial_commitment_tx.trust();
2265                 let counterparty_initial_bitcoin_tx = counterparty_trusted_tx.built_transaction();
2266
2267                 log_trace!(logger, "Initial counterparty tx for channel {} is: txid {} tx {}",
2268                         log_bytes!(self.channel_id()), counterparty_initial_bitcoin_tx.txid, encode::serialize_hex(&counterparty_initial_bitcoin_tx.transaction));
2269
2270                 let holder_signer = self.build_holder_transaction_keys(self.cur_holder_commitment_transaction_number)?;
2271                 let initial_commitment_tx = self.build_commitment_transaction(self.cur_holder_commitment_transaction_number, &holder_signer, true, false, logger).tx;
2272                 {
2273                         let trusted_tx = initial_commitment_tx.trust();
2274                         let initial_commitment_bitcoin_tx = trusted_tx.built_transaction();
2275                         let sighash = initial_commitment_bitcoin_tx.get_sighash_all(&funding_script, self.channel_value_satoshis);
2276                         // They sign our commitment transaction, allowing us to broadcast the tx if we wish.
2277                         if let Err(_) = self.secp_ctx.verify_ecdsa(&sighash, &msg.signature, &self.get_counterparty_pubkeys().funding_pubkey) {
2278                                 return Err(ChannelError::Close("Invalid funding_signed signature from peer".to_owned()));
2279                         }
2280                 }
2281
2282                 let holder_commitment_tx = HolderCommitmentTransaction::new(
2283                         initial_commitment_tx,
2284                         msg.signature,
2285                         Vec::new(),
2286                         &self.get_holder_pubkeys().funding_pubkey,
2287                         self.counterparty_funding_pubkey()
2288                 );
2289
2290                 self.holder_signer.validate_holder_commitment(&holder_commitment_tx, Vec::new())
2291                         .map_err(|_| ChannelError::Close("Failed to validate our commitment".to_owned()))?;
2292
2293
2294                 let funding_redeemscript = self.get_funding_redeemscript();
2295                 let funding_txo = self.get_funding_txo().unwrap();
2296                 let funding_txo_script = funding_redeemscript.to_v0_p2wsh();
2297                 let obscure_factor = get_commitment_transaction_number_obscure_factor(&self.get_holder_pubkeys().payment_point, &self.get_counterparty_pubkeys().payment_point, self.is_outbound());
2298                 let shutdown_script = self.shutdown_scriptpubkey.clone().map(|script| script.into_inner());
2299                 let channel_monitor = ChannelMonitor::new(self.secp_ctx.clone(), self.holder_signer.clone(),
2300                                                           shutdown_script, self.get_holder_selected_contest_delay(),
2301                                                           &self.destination_script, (funding_txo, funding_txo_script),
2302                                                           &self.channel_transaction_parameters,
2303                                                           funding_redeemscript.clone(), self.channel_value_satoshis,
2304                                                           obscure_factor,
2305                                                           holder_commitment_tx, best_block, self.counterparty_node_id);
2306
2307                 channel_monitor.provide_latest_counterparty_commitment_tx(counterparty_initial_bitcoin_tx.txid, Vec::new(), self.cur_counterparty_commitment_transaction_number, self.counterparty_cur_commitment_point.unwrap(), logger);
2308
2309                 assert_eq!(self.channel_state & (ChannelState::MonitorUpdateFailed as u32), 0); // We have no had any monitor(s) yet to fail update!
2310                 self.channel_state = ChannelState::FundingSent as u32;
2311                 self.cur_holder_commitment_transaction_number -= 1;
2312                 self.cur_counterparty_commitment_transaction_number -= 1;
2313
2314                 log_info!(logger, "Received funding_signed from peer for channel {}", log_bytes!(self.channel_id()));
2315
2316                 Ok((channel_monitor, self.funding_transaction.as_ref().cloned().unwrap(), self.check_get_channel_ready(0)))
2317         }
2318
2319         /// Handles a channel_ready message from our peer. If we've already sent our channel_ready
2320         /// and the channel is now usable (and public), this may generate an announcement_signatures to
2321         /// reply with.
2322         pub fn channel_ready<L: Deref>(&mut self, msg: &msgs::ChannelReady, node_pk: PublicKey, genesis_block_hash: BlockHash, best_block: &BestBlock, logger: &L) -> Result<Option<msgs::AnnouncementSignatures>, ChannelError> where L::Target: Logger {
2323                 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
2324                         self.workaround_lnd_bug_4006 = Some(msg.clone());
2325                         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()));
2326                 }
2327
2328                 if let Some(scid_alias) = msg.short_channel_id_alias {
2329                         if Some(scid_alias) != self.short_channel_id {
2330                                 // The scid alias provided can be used to route payments *from* our counterparty,
2331                                 // i.e. can be used for inbound payments and provided in invoices, but is not used
2332                                 // when routing outbound payments.
2333                                 self.latest_inbound_scid_alias = Some(scid_alias);
2334                         }
2335                 }
2336
2337                 let non_shutdown_state = self.channel_state & (!MULTI_STATE_FLAGS);
2338
2339                 if non_shutdown_state == ChannelState::FundingSent as u32 {
2340                         self.channel_state |= ChannelState::TheirChannelReady as u32;
2341                 } else if non_shutdown_state == (ChannelState::FundingSent as u32 | ChannelState::OurChannelReady as u32) {
2342                         self.channel_state = ChannelState::ChannelFunded as u32 | (self.channel_state & MULTI_STATE_FLAGS);
2343                         self.update_time_counter += 1;
2344                 } else if self.channel_state & (ChannelState::ChannelFunded as u32) != 0 ||
2345                         // If we reconnected before sending our `channel_ready` they may still resend theirs:
2346                         (self.channel_state & (ChannelState::FundingSent as u32 | ChannelState::TheirChannelReady as u32) ==
2347                                               (ChannelState::FundingSent as u32 | ChannelState::TheirChannelReady as u32))
2348                 {
2349                         // They probably disconnected/reconnected and re-sent the channel_ready, which is
2350                         // required, or they're sending a fresh SCID alias.
2351                         let expected_point =
2352                                 if self.cur_counterparty_commitment_transaction_number == INITIAL_COMMITMENT_NUMBER - 1 {
2353                                         // If they haven't ever sent an updated point, the point they send should match
2354                                         // the current one.
2355                                         self.counterparty_cur_commitment_point
2356                                 } else {
2357                                         // If they have sent updated points, channel_ready is always supposed to match
2358                                         // their "first" point, which we re-derive here.
2359                                         Some(PublicKey::from_secret_key(&self.secp_ctx, &SecretKey::from_slice(
2360                                                         &self.commitment_secrets.get_secret(INITIAL_COMMITMENT_NUMBER - 1).expect("We should have all prev secrets available")
2361                                                 ).expect("We already advanced, so previous secret keys should have been validated already")))
2362                                 };
2363                         if expected_point != Some(msg.next_per_commitment_point) {
2364                                 return Err(ChannelError::Close("Peer sent a reconnect channel_ready with a different point".to_owned()));
2365                         }
2366                         return Ok(None);
2367                 } else {
2368                         return Err(ChannelError::Close("Peer sent a channel_ready at a strange time".to_owned()));
2369                 }
2370
2371                 self.counterparty_prev_commitment_point = self.counterparty_cur_commitment_point;
2372                 self.counterparty_cur_commitment_point = Some(msg.next_per_commitment_point);
2373
2374                 log_info!(logger, "Received channel_ready from peer for channel {}", log_bytes!(self.channel_id()));
2375
2376                 Ok(self.get_announcement_sigs(node_pk, genesis_block_hash, best_block.height(), logger))
2377         }
2378
2379         /// Returns transaction if there is pending funding transaction that is yet to broadcast
2380         pub fn unbroadcasted_funding(&self) -> Option<Transaction> {
2381                 if self.channel_state & (ChannelState::FundingCreated as u32) != 0 {
2382                         self.funding_transaction.clone()
2383                 } else {
2384                         None
2385                 }
2386         }
2387
2388         /// Returns a HTLCStats about inbound pending htlcs
2389         fn get_inbound_pending_htlc_stats(&self, outbound_feerate_update: Option<u32>) -> HTLCStats {
2390                 let mut stats = HTLCStats {
2391                         pending_htlcs: self.pending_inbound_htlcs.len() as u32,
2392                         pending_htlcs_value_msat: 0,
2393                         on_counterparty_tx_dust_exposure_msat: 0,
2394                         on_holder_tx_dust_exposure_msat: 0,
2395                         holding_cell_msat: 0,
2396                         on_holder_tx_holding_cell_htlcs_count: 0,
2397                 };
2398
2399                 let counterparty_dust_limit_timeout_sat = (self.get_dust_buffer_feerate(outbound_feerate_update) as u64 * htlc_timeout_tx_weight(self.opt_anchors()) / 1000) + self.counterparty_dust_limit_satoshis;
2400                 let holder_dust_limit_success_sat = (self.get_dust_buffer_feerate(outbound_feerate_update) as u64 * htlc_success_tx_weight(self.opt_anchors()) / 1000) + self.holder_dust_limit_satoshis;
2401                 for ref htlc in self.pending_inbound_htlcs.iter() {
2402                         stats.pending_htlcs_value_msat += htlc.amount_msat;
2403                         if htlc.amount_msat / 1000 < counterparty_dust_limit_timeout_sat {
2404                                 stats.on_counterparty_tx_dust_exposure_msat += htlc.amount_msat;
2405                         }
2406                         if htlc.amount_msat / 1000 < holder_dust_limit_success_sat {
2407                                 stats.on_holder_tx_dust_exposure_msat += htlc.amount_msat;
2408                         }
2409                 }
2410                 stats
2411         }
2412
2413         /// Returns a HTLCStats about pending outbound htlcs, *including* pending adds in our holding cell.
2414         fn get_outbound_pending_htlc_stats(&self, outbound_feerate_update: Option<u32>) -> HTLCStats {
2415                 let mut stats = HTLCStats {
2416                         pending_htlcs: self.pending_outbound_htlcs.len() as u32,
2417                         pending_htlcs_value_msat: 0,
2418                         on_counterparty_tx_dust_exposure_msat: 0,
2419                         on_holder_tx_dust_exposure_msat: 0,
2420                         holding_cell_msat: 0,
2421                         on_holder_tx_holding_cell_htlcs_count: 0,
2422                 };
2423
2424                 let counterparty_dust_limit_success_sat = (self.get_dust_buffer_feerate(outbound_feerate_update) as u64 * htlc_success_tx_weight(self.opt_anchors()) / 1000) + self.counterparty_dust_limit_satoshis;
2425                 let holder_dust_limit_timeout_sat = (self.get_dust_buffer_feerate(outbound_feerate_update) as u64 * htlc_timeout_tx_weight(self.opt_anchors()) / 1000) + self.holder_dust_limit_satoshis;
2426                 for ref htlc in self.pending_outbound_htlcs.iter() {
2427                         stats.pending_htlcs_value_msat += htlc.amount_msat;
2428                         if htlc.amount_msat / 1000 < counterparty_dust_limit_success_sat {
2429                                 stats.on_counterparty_tx_dust_exposure_msat += htlc.amount_msat;
2430                         }
2431                         if htlc.amount_msat / 1000 < holder_dust_limit_timeout_sat {
2432                                 stats.on_holder_tx_dust_exposure_msat += htlc.amount_msat;
2433                         }
2434                 }
2435
2436                 for update in self.holding_cell_htlc_updates.iter() {
2437                         if let &HTLCUpdateAwaitingACK::AddHTLC { ref amount_msat, .. } = update {
2438                                 stats.pending_htlcs += 1;
2439                                 stats.pending_htlcs_value_msat += amount_msat;
2440                                 stats.holding_cell_msat += amount_msat;
2441                                 if *amount_msat / 1000 < counterparty_dust_limit_success_sat {
2442                                         stats.on_counterparty_tx_dust_exposure_msat += amount_msat;
2443                                 }
2444                                 if *amount_msat / 1000 < holder_dust_limit_timeout_sat {
2445                                         stats.on_holder_tx_dust_exposure_msat += amount_msat;
2446                                 } else {
2447                                         stats.on_holder_tx_holding_cell_htlcs_count += 1;
2448                                 }
2449                         }
2450                 }
2451                 stats
2452         }
2453
2454         /// Get the available balances, see [`AvailableBalances`]'s fields for more info.
2455         /// Doesn't bother handling the
2456         /// if-we-removed-it-already-but-haven't-fully-resolved-they-can-still-send-an-inbound-HTLC
2457         /// corner case properly.
2458         pub fn get_available_balances(&self) -> AvailableBalances {
2459                 // Note that we have to handle overflow due to the above case.
2460                 let outbound_stats = self.get_outbound_pending_htlc_stats(None);
2461
2462                 let mut balance_msat = self.value_to_self_msat;
2463                 for ref htlc in self.pending_inbound_htlcs.iter() {
2464                         if let InboundHTLCState::LocalRemoved(InboundHTLCRemovalReason::Fulfill(_)) = htlc.state {
2465                                 balance_msat += htlc.amount_msat;
2466                         }
2467                 }
2468                 balance_msat -= outbound_stats.pending_htlcs_value_msat;
2469
2470                 let outbound_capacity_msat = cmp::max(self.value_to_self_msat as i64
2471                                 - outbound_stats.pending_htlcs_value_msat as i64
2472                                 - self.counterparty_selected_channel_reserve_satoshis.unwrap_or(0) as i64 * 1000,
2473                         0) as u64;
2474                 AvailableBalances {
2475                         inbound_capacity_msat: cmp::max(self.channel_value_satoshis as i64 * 1000
2476                                         - self.value_to_self_msat as i64
2477                                         - self.get_inbound_pending_htlc_stats(None).pending_htlcs_value_msat as i64
2478                                         - self.holder_selected_channel_reserve_satoshis as i64 * 1000,
2479                                 0) as u64,
2480                         outbound_capacity_msat,
2481                         next_outbound_htlc_limit_msat: cmp::max(cmp::min(outbound_capacity_msat as i64,
2482                                         self.counterparty_max_htlc_value_in_flight_msat as i64
2483                                                 - outbound_stats.pending_htlcs_value_msat as i64),
2484                                 0) as u64,
2485                         balance_msat,
2486                 }
2487         }
2488
2489         pub fn get_holder_counterparty_selected_channel_reserve_satoshis(&self) -> (u64, Option<u64>) {
2490                 (self.holder_selected_channel_reserve_satoshis, self.counterparty_selected_channel_reserve_satoshis)
2491         }
2492
2493         // Get the fee cost in MSATS of a commitment tx with a given number of HTLC outputs.
2494         // Note that num_htlcs should not include dust HTLCs.
2495         fn commit_tx_fee_msat(feerate_per_kw: u32, num_htlcs: usize, opt_anchors: bool) -> u64 {
2496                 // Note that we need to divide before multiplying to round properly,
2497                 // since the lowest denomination of bitcoin on-chain is the satoshi.
2498                 (commitment_tx_base_weight(opt_anchors) + num_htlcs as u64 * COMMITMENT_TX_WEIGHT_PER_HTLC) * feerate_per_kw as u64 / 1000 * 1000
2499         }
2500
2501         // Get the fee cost in SATS of a commitment tx with a given number of HTLC outputs.
2502         // Note that num_htlcs should not include dust HTLCs.
2503         #[inline]
2504         fn commit_tx_fee_sat(feerate_per_kw: u32, num_htlcs: usize, opt_anchors: bool) -> u64 {
2505                 feerate_per_kw as u64 * (commitment_tx_base_weight(opt_anchors) + num_htlcs as u64 * COMMITMENT_TX_WEIGHT_PER_HTLC) / 1000
2506         }
2507
2508         // Get the commitment tx fee for the local's (i.e. our) next commitment transaction based on the
2509         // number of pending HTLCs that are on track to be in our next commitment tx, plus an additional
2510         // HTLC if `fee_spike_buffer_htlc` is Some, plus a new HTLC given by `new_htlc_amount`. Dust HTLCs
2511         // are excluded.
2512         fn next_local_commit_tx_fee_msat(&self, htlc: HTLCCandidate, fee_spike_buffer_htlc: Option<()>) -> u64 {
2513                 assert!(self.is_outbound());
2514
2515                 let real_dust_limit_success_sat = (self.feerate_per_kw as u64 * htlc_success_tx_weight(self.opt_anchors()) / 1000) + self.holder_dust_limit_satoshis;
2516                 let real_dust_limit_timeout_sat = (self.feerate_per_kw as u64 * htlc_timeout_tx_weight(self.opt_anchors()) / 1000) + self.holder_dust_limit_satoshis;
2517
2518                 let mut addl_htlcs = 0;
2519                 if fee_spike_buffer_htlc.is_some() { addl_htlcs += 1; }
2520                 match htlc.origin {
2521                         HTLCInitiator::LocalOffered => {
2522                                 if htlc.amount_msat / 1000 >= real_dust_limit_timeout_sat {
2523                                         addl_htlcs += 1;
2524                                 }
2525                         },
2526                         HTLCInitiator::RemoteOffered => {
2527                                 if htlc.amount_msat / 1000 >= real_dust_limit_success_sat {
2528                                         addl_htlcs += 1;
2529                                 }
2530                         }
2531                 }
2532
2533                 let mut included_htlcs = 0;
2534                 for ref htlc in self.pending_inbound_htlcs.iter() {
2535                         if htlc.amount_msat / 1000 < real_dust_limit_success_sat {
2536                                 continue
2537                         }
2538                         // We include LocalRemoved HTLCs here because we may still need to broadcast a commitment
2539                         // transaction including this HTLC if it times out before they RAA.
2540                         included_htlcs += 1;
2541                 }
2542
2543                 for ref htlc in self.pending_outbound_htlcs.iter() {
2544                         if htlc.amount_msat / 1000 < real_dust_limit_timeout_sat {
2545                                 continue
2546                         }
2547                         match htlc.state {
2548                                 OutboundHTLCState::LocalAnnounced {..} => included_htlcs += 1,
2549                                 OutboundHTLCState::Committed => included_htlcs += 1,
2550                                 OutboundHTLCState::RemoteRemoved {..} => included_htlcs += 1,
2551                                 // We don't include AwaitingRemoteRevokeToRemove HTLCs because our next commitment
2552                                 // transaction won't be generated until they send us their next RAA, which will mean
2553                                 // dropping any HTLCs in this state.
2554                                 _ => {},
2555                         }
2556                 }
2557
2558                 for htlc in self.holding_cell_htlc_updates.iter() {
2559                         match htlc {
2560                                 &HTLCUpdateAwaitingACK::AddHTLC { amount_msat, .. } => {
2561                                         if amount_msat / 1000 < real_dust_limit_timeout_sat {
2562                                                 continue
2563                                         }
2564                                         included_htlcs += 1
2565                                 },
2566                                 _ => {}, // Don't include claims/fails that are awaiting ack, because once we get the
2567                                          // ack we're guaranteed to never include them in commitment txs anymore.
2568                         }
2569                 }
2570
2571                 let num_htlcs = included_htlcs + addl_htlcs;
2572                 let res = Self::commit_tx_fee_msat(self.feerate_per_kw, num_htlcs, self.opt_anchors());
2573                 #[cfg(any(test, fuzzing))]
2574                 {
2575                         let mut fee = res;
2576                         if fee_spike_buffer_htlc.is_some() {
2577                                 fee = Self::commit_tx_fee_msat(self.feerate_per_kw, num_htlcs - 1, self.opt_anchors());
2578                         }
2579                         let total_pending_htlcs = self.pending_inbound_htlcs.len() + self.pending_outbound_htlcs.len()
2580                                 + self.holding_cell_htlc_updates.len();
2581                         let commitment_tx_info = CommitmentTxInfoCached {
2582                                 fee,
2583                                 total_pending_htlcs,
2584                                 next_holder_htlc_id: match htlc.origin {
2585                                         HTLCInitiator::LocalOffered => self.next_holder_htlc_id + 1,
2586                                         HTLCInitiator::RemoteOffered => self.next_holder_htlc_id,
2587                                 },
2588                                 next_counterparty_htlc_id: match htlc.origin {
2589                                         HTLCInitiator::LocalOffered => self.next_counterparty_htlc_id,
2590                                         HTLCInitiator::RemoteOffered => self.next_counterparty_htlc_id + 1,
2591                                 },
2592                                 feerate: self.feerate_per_kw,
2593                         };
2594                         *self.next_local_commitment_tx_fee_info_cached.lock().unwrap() = Some(commitment_tx_info);
2595                 }
2596                 res
2597         }
2598
2599         // Get the commitment tx fee for the remote's next commitment transaction based on the number of
2600         // pending HTLCs that are on track to be in their next commitment tx, plus an additional HTLC if
2601         // `fee_spike_buffer_htlc` is Some, plus a new HTLC given by `new_htlc_amount`. Dust HTLCs are
2602         // excluded.
2603         fn next_remote_commit_tx_fee_msat(&self, htlc: HTLCCandidate, fee_spike_buffer_htlc: Option<()>) -> u64 {
2604                 assert!(!self.is_outbound());
2605
2606                 let real_dust_limit_success_sat = (self.feerate_per_kw as u64 * htlc_success_tx_weight(self.opt_anchors()) / 1000) + self.counterparty_dust_limit_satoshis;
2607                 let real_dust_limit_timeout_sat = (self.feerate_per_kw as u64 * htlc_timeout_tx_weight(self.opt_anchors()) / 1000) + self.counterparty_dust_limit_satoshis;
2608
2609                 let mut addl_htlcs = 0;
2610                 if fee_spike_buffer_htlc.is_some() { addl_htlcs += 1; }
2611                 match htlc.origin {
2612                         HTLCInitiator::LocalOffered => {
2613                                 if htlc.amount_msat / 1000 >= real_dust_limit_success_sat {
2614                                         addl_htlcs += 1;
2615                                 }
2616                         },
2617                         HTLCInitiator::RemoteOffered => {
2618                                 if htlc.amount_msat / 1000 >= real_dust_limit_timeout_sat {
2619                                         addl_htlcs += 1;
2620                                 }
2621                         }
2622                 }
2623
2624                 // When calculating the set of HTLCs which will be included in their next commitment_signed, all
2625                 // non-dust inbound HTLCs are included (as all states imply it will be included) and only
2626                 // committed outbound HTLCs, see below.
2627                 let mut included_htlcs = 0;
2628                 for ref htlc in self.pending_inbound_htlcs.iter() {
2629                         if htlc.amount_msat / 1000 <= real_dust_limit_timeout_sat {
2630                                 continue
2631                         }
2632                         included_htlcs += 1;
2633                 }
2634
2635                 for ref htlc in self.pending_outbound_htlcs.iter() {
2636                         if htlc.amount_msat / 1000 <= real_dust_limit_success_sat {
2637                                 continue
2638                         }
2639                         // We only include outbound HTLCs if it will not be included in their next commitment_signed,
2640                         // i.e. if they've responded to us with an RAA after announcement.
2641                         match htlc.state {
2642                                 OutboundHTLCState::Committed => included_htlcs += 1,
2643                                 OutboundHTLCState::RemoteRemoved {..} => included_htlcs += 1,
2644                                 OutboundHTLCState::LocalAnnounced { .. } => included_htlcs += 1,
2645                                 _ => {},
2646                         }
2647                 }
2648
2649                 let num_htlcs = included_htlcs + addl_htlcs;
2650                 let res = Self::commit_tx_fee_msat(self.feerate_per_kw, num_htlcs, self.opt_anchors());
2651                 #[cfg(any(test, fuzzing))]
2652                 {
2653                         let mut fee = res;
2654                         if fee_spike_buffer_htlc.is_some() {
2655                                 fee = Self::commit_tx_fee_msat(self.feerate_per_kw, num_htlcs - 1, self.opt_anchors());
2656                         }
2657                         let total_pending_htlcs = self.pending_inbound_htlcs.len() + self.pending_outbound_htlcs.len();
2658                         let commitment_tx_info = CommitmentTxInfoCached {
2659                                 fee,
2660                                 total_pending_htlcs,
2661                                 next_holder_htlc_id: match htlc.origin {
2662                                         HTLCInitiator::LocalOffered => self.next_holder_htlc_id + 1,
2663                                         HTLCInitiator::RemoteOffered => self.next_holder_htlc_id,
2664                                 },
2665                                 next_counterparty_htlc_id: match htlc.origin {
2666                                         HTLCInitiator::LocalOffered => self.next_counterparty_htlc_id,
2667                                         HTLCInitiator::RemoteOffered => self.next_counterparty_htlc_id + 1,
2668                                 },
2669                                 feerate: self.feerate_per_kw,
2670                         };
2671                         *self.next_remote_commitment_tx_fee_info_cached.lock().unwrap() = Some(commitment_tx_info);
2672                 }
2673                 res
2674         }
2675
2676         pub fn update_add_htlc<F, L: Deref>(&mut self, msg: &msgs::UpdateAddHTLC, mut pending_forward_status: PendingHTLCStatus, create_pending_htlc_status: F, logger: &L) -> Result<(), ChannelError>
2677         where F: for<'a> Fn(&'a Self, PendingHTLCStatus, u16) -> PendingHTLCStatus, L::Target: Logger {
2678                 // We can't accept HTLCs sent after we've sent a shutdown.
2679                 let local_sent_shutdown = (self.channel_state & (ChannelState::ChannelFunded as u32 | ChannelState::LocalShutdownSent as u32)) != (ChannelState::ChannelFunded as u32);
2680                 if local_sent_shutdown {
2681                         pending_forward_status = create_pending_htlc_status(self, pending_forward_status, 0x4000|8);
2682                 }
2683                 // If the remote has sent a shutdown prior to adding this HTLC, then they are in violation of the spec.
2684                 let remote_sent_shutdown = (self.channel_state & (ChannelState::ChannelFunded as u32 | ChannelState::RemoteShutdownSent as u32)) != (ChannelState::ChannelFunded as u32);
2685                 if remote_sent_shutdown {
2686                         return Err(ChannelError::Close("Got add HTLC message when channel was not in an operational state".to_owned()));
2687                 }
2688                 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
2689                         return Err(ChannelError::Close("Peer sent update_add_htlc when we needed a channel_reestablish".to_owned()));
2690                 }
2691                 if msg.amount_msat > self.channel_value_satoshis * 1000 {
2692                         return Err(ChannelError::Close("Remote side tried to send more than the total value of the channel".to_owned()));
2693                 }
2694                 if msg.amount_msat == 0 {
2695                         return Err(ChannelError::Close("Remote side tried to send a 0-msat HTLC".to_owned()));
2696                 }
2697                 if msg.amount_msat < self.holder_htlc_minimum_msat {
2698                         return Err(ChannelError::Close(format!("Remote side tried to send less than our minimum HTLC value. Lower limit: ({}). Actual: ({})", self.holder_htlc_minimum_msat, msg.amount_msat)));
2699                 }
2700
2701                 let inbound_stats = self.get_inbound_pending_htlc_stats(None);
2702                 let outbound_stats = self.get_outbound_pending_htlc_stats(None);
2703                 if inbound_stats.pending_htlcs + 1 > OUR_MAX_HTLCS as u32 {
2704                         return Err(ChannelError::Close(format!("Remote tried to push more than our max accepted HTLCs ({})", OUR_MAX_HTLCS)));
2705                 }
2706                 if inbound_stats.pending_htlcs_value_msat + msg.amount_msat > self.holder_max_htlc_value_in_flight_msat {
2707                         return Err(ChannelError::Close(format!("Remote HTLC add would put them over our max HTLC value ({})", self.holder_max_htlc_value_in_flight_msat)));
2708                 }
2709                 // Check holder_selected_channel_reserve_satoshis (we're getting paid, so they have to at least meet
2710                 // the reserve_satoshis we told them to always have as direct payment so that they lose
2711                 // something if we punish them for broadcasting an old state).
2712                 // Note that we don't really care about having a small/no to_remote output in our local
2713                 // commitment transactions, as the purpose of the channel reserve is to ensure we can
2714                 // punish *them* if they misbehave, so we discount any outbound HTLCs which will not be
2715                 // present in the next commitment transaction we send them (at least for fulfilled ones,
2716                 // failed ones won't modify value_to_self).
2717                 // Note that we will send HTLCs which another instance of rust-lightning would think
2718                 // violate the reserve value if we do not do this (as we forget inbound HTLCs from the
2719                 // Channel state once they will not be present in the next received commitment
2720                 // transaction).
2721                 let mut removed_outbound_total_msat = 0;
2722                 for ref htlc in self.pending_outbound_htlcs.iter() {
2723                         if let OutboundHTLCState::AwaitingRemoteRevokeToRemove(OutboundHTLCOutcome::Success(_)) = htlc.state {
2724                                 removed_outbound_total_msat += htlc.amount_msat;
2725                         } else if let OutboundHTLCState::AwaitingRemovedRemoteRevoke(OutboundHTLCOutcome::Success(_)) = htlc.state {
2726                                 removed_outbound_total_msat += htlc.amount_msat;
2727                         }
2728                 }
2729
2730                 let exposure_dust_limit_timeout_sats = (self.get_dust_buffer_feerate(None) as u64 * htlc_timeout_tx_weight(self.opt_anchors()) / 1000) + self.counterparty_dust_limit_satoshis;
2731                 if msg.amount_msat / 1000 < exposure_dust_limit_timeout_sats {
2732                         let on_counterparty_tx_dust_htlc_exposure_msat = inbound_stats.on_counterparty_tx_dust_exposure_msat + outbound_stats.on_counterparty_tx_dust_exposure_msat + msg.amount_msat;
2733                         if on_counterparty_tx_dust_htlc_exposure_msat > self.get_max_dust_htlc_exposure_msat() {
2734                                 log_info!(logger, "Cannot accept value that would put our exposure to dust HTLCs at {} over the limit {} on counterparty commitment tx",
2735                                         on_counterparty_tx_dust_htlc_exposure_msat, self.get_max_dust_htlc_exposure_msat());
2736                                 pending_forward_status = create_pending_htlc_status(self, pending_forward_status, 0x1000|7);
2737                         }
2738                 }
2739
2740                 let exposure_dust_limit_success_sats = (self.get_dust_buffer_feerate(None) as u64 * htlc_success_tx_weight(self.opt_anchors()) / 1000) + self.holder_dust_limit_satoshis;
2741                 if msg.amount_msat / 1000 < exposure_dust_limit_success_sats {
2742                         let on_holder_tx_dust_htlc_exposure_msat = inbound_stats.on_holder_tx_dust_exposure_msat + outbound_stats.on_holder_tx_dust_exposure_msat + msg.amount_msat;
2743                         if on_holder_tx_dust_htlc_exposure_msat > self.get_max_dust_htlc_exposure_msat() {
2744                                 log_info!(logger, "Cannot accept value that would put our exposure to dust HTLCs at {} over the limit {} on holder commitment tx",
2745                                         on_holder_tx_dust_htlc_exposure_msat, self.get_max_dust_htlc_exposure_msat());
2746                                 pending_forward_status = create_pending_htlc_status(self, pending_forward_status, 0x1000|7);
2747                         }
2748                 }
2749
2750                 let pending_value_to_self_msat =
2751                         self.value_to_self_msat + inbound_stats.pending_htlcs_value_msat - removed_outbound_total_msat;
2752                 let pending_remote_value_msat =
2753                         self.channel_value_satoshis * 1000 - pending_value_to_self_msat;
2754                 if pending_remote_value_msat < msg.amount_msat {
2755                         return Err(ChannelError::Close("Remote HTLC add would overdraw remaining funds".to_owned()));
2756                 }
2757
2758                 // Check that the remote can afford to pay for this HTLC on-chain at the current
2759                 // feerate_per_kw, while maintaining their channel reserve (as required by the spec).
2760                 let remote_commit_tx_fee_msat = if self.is_outbound() { 0 } else {
2761                         let htlc_candidate = HTLCCandidate::new(msg.amount_msat, HTLCInitiator::RemoteOffered);
2762                         self.next_remote_commit_tx_fee_msat(htlc_candidate, None) // Don't include the extra fee spike buffer HTLC in calculations
2763                 };
2764                 if pending_remote_value_msat - msg.amount_msat < remote_commit_tx_fee_msat {
2765                         return Err(ChannelError::Close("Remote HTLC add would not leave enough to pay for fees".to_owned()));
2766                 };
2767
2768                 if pending_remote_value_msat - msg.amount_msat - remote_commit_tx_fee_msat < self.holder_selected_channel_reserve_satoshis * 1000 {
2769                         return Err(ChannelError::Close("Remote HTLC add would put them under remote reserve value".to_owned()));
2770                 }
2771
2772                 if !self.is_outbound() {
2773                         // `2 *` and `Some(())` is for the fee spike buffer we keep for the remote. This deviates from
2774                         // the spec because in the spec, the fee spike buffer requirement doesn't exist on the
2775                         // receiver's side, only on the sender's.
2776                         // Note that when we eventually remove support for fee updates and switch to anchor output
2777                         // fees, we will drop the `2 *`, since we no longer be as sensitive to fee spikes. But, keep
2778                         // the extra htlc when calculating the next remote commitment transaction fee as we should
2779                         // still be able to afford adding this HTLC plus one more future HTLC, regardless of being
2780                         // sensitive to fee spikes.
2781                         let htlc_candidate = HTLCCandidate::new(msg.amount_msat, HTLCInitiator::RemoteOffered);
2782                         let remote_fee_cost_incl_stuck_buffer_msat = 2 * self.next_remote_commit_tx_fee_msat(htlc_candidate, Some(()));
2783                         if pending_remote_value_msat - msg.amount_msat - self.holder_selected_channel_reserve_satoshis * 1000 < remote_fee_cost_incl_stuck_buffer_msat {
2784                                 // Note that if the pending_forward_status is not updated here, then it's because we're already failing
2785                                 // the HTLC, i.e. its status is already set to failing.
2786                                 log_info!(logger, "Attempting to fail HTLC due to fee spike buffer violation in channel {}. Rebalancing is required.", log_bytes!(self.channel_id()));
2787                                 pending_forward_status = create_pending_htlc_status(self, pending_forward_status, 0x1000|7);
2788                         }
2789                 } else {
2790                         // Check that they won't violate our local required channel reserve by adding this HTLC.
2791                         let htlc_candidate = HTLCCandidate::new(msg.amount_msat, HTLCInitiator::RemoteOffered);
2792                         let local_commit_tx_fee_msat = self.next_local_commit_tx_fee_msat(htlc_candidate, None);
2793                         if self.value_to_self_msat < self.counterparty_selected_channel_reserve_satoshis.unwrap() * 1000 + local_commit_tx_fee_msat {
2794                                 return Err(ChannelError::Close("Cannot accept HTLC that would put our balance under counterparty-announced channel reserve value".to_owned()));
2795                         }
2796                 }
2797                 if self.next_counterparty_htlc_id != msg.htlc_id {
2798                         return Err(ChannelError::Close(format!("Remote skipped HTLC ID (skipped ID: {})", self.next_counterparty_htlc_id)));
2799                 }
2800                 if msg.cltv_expiry >= 500000000 {
2801                         return Err(ChannelError::Close("Remote provided CLTV expiry in seconds instead of block height".to_owned()));
2802                 }
2803
2804                 if self.channel_state & ChannelState::LocalShutdownSent as u32 != 0 {
2805                         if let PendingHTLCStatus::Forward(_) = pending_forward_status {
2806                                 panic!("ChannelManager shouldn't be trying to add a forwardable HTLC after we've started closing");
2807                         }
2808                 }
2809
2810                 // Now update local state:
2811                 self.next_counterparty_htlc_id += 1;
2812                 self.pending_inbound_htlcs.push(InboundHTLCOutput {
2813                         htlc_id: msg.htlc_id,
2814                         amount_msat: msg.amount_msat,
2815                         payment_hash: msg.payment_hash,
2816                         cltv_expiry: msg.cltv_expiry,
2817                         state: InboundHTLCState::RemoteAnnounced(pending_forward_status),
2818                 });
2819                 Ok(())
2820         }
2821
2822         /// Marks an outbound HTLC which we have received update_fail/fulfill/malformed
2823         #[inline]
2824         fn mark_outbound_htlc_removed(&mut self, htlc_id: u64, check_preimage: Option<PaymentPreimage>, fail_reason: Option<HTLCFailReason>) -> Result<&OutboundHTLCOutput, ChannelError> {
2825                 assert!(!(check_preimage.is_some() && fail_reason.is_some()), "cannot fail while we have a preimage");
2826                 for htlc in self.pending_outbound_htlcs.iter_mut() {
2827                         if htlc.htlc_id == htlc_id {
2828                                 let outcome = match check_preimage {
2829                                         None => fail_reason.into(),
2830                                         Some(payment_preimage) => {
2831                                                 let payment_hash = PaymentHash(Sha256::hash(&payment_preimage.0[..]).into_inner());
2832                                                 if payment_hash != htlc.payment_hash {
2833                                                         return Err(ChannelError::Close(format!("Remote tried to fulfill HTLC ({}) with an incorrect preimage", htlc_id)));
2834                                                 }
2835                                                 OutboundHTLCOutcome::Success(Some(payment_preimage))
2836                                         }
2837                                 };
2838                                 match htlc.state {
2839                                         OutboundHTLCState::LocalAnnounced(_) =>
2840                                                 return Err(ChannelError::Close(format!("Remote tried to fulfill/fail HTLC ({}) before it had been committed", htlc_id))),
2841                                         OutboundHTLCState::Committed => {
2842                                                 htlc.state = OutboundHTLCState::RemoteRemoved(outcome);
2843                                         },
2844                                         OutboundHTLCState::AwaitingRemoteRevokeToRemove(_) | OutboundHTLCState::AwaitingRemovedRemoteRevoke(_) | OutboundHTLCState::RemoteRemoved(_) =>
2845                                                 return Err(ChannelError::Close(format!("Remote tried to fulfill/fail HTLC ({}) that they'd already fulfilled/failed", htlc_id))),
2846                                 }
2847                                 return Ok(htlc);
2848                         }
2849                 }
2850                 Err(ChannelError::Close("Remote tried to fulfill/fail an HTLC we couldn't find".to_owned()))
2851         }
2852
2853         pub fn update_fulfill_htlc(&mut self, msg: &msgs::UpdateFulfillHTLC) -> Result<(HTLCSource, u64), ChannelError> {
2854                 if (self.channel_state & (ChannelState::ChannelFunded as u32)) != (ChannelState::ChannelFunded as u32) {
2855                         return Err(ChannelError::Close("Got fulfill HTLC message when channel was not in an operational state".to_owned()));
2856                 }
2857                 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
2858                         return Err(ChannelError::Close("Peer sent update_fulfill_htlc when we needed a channel_reestablish".to_owned()));
2859                 }
2860
2861                 self.mark_outbound_htlc_removed(msg.htlc_id, Some(msg.payment_preimage), None).map(|htlc| (htlc.source.clone(), htlc.amount_msat))
2862         }
2863
2864         pub fn update_fail_htlc(&mut self, msg: &msgs::UpdateFailHTLC, fail_reason: HTLCFailReason) -> Result<(), ChannelError> {
2865                 if (self.channel_state & (ChannelState::ChannelFunded as u32)) != (ChannelState::ChannelFunded as u32) {
2866                         return Err(ChannelError::Close("Got fail HTLC message when channel was not in an operational state".to_owned()));
2867                 }
2868                 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
2869                         return Err(ChannelError::Close("Peer sent update_fail_htlc when we needed a channel_reestablish".to_owned()));
2870                 }
2871
2872                 self.mark_outbound_htlc_removed(msg.htlc_id, None, Some(fail_reason))?;
2873                 Ok(())
2874         }
2875
2876         pub fn update_fail_malformed_htlc(&mut self, msg: &msgs::UpdateFailMalformedHTLC, fail_reason: HTLCFailReason) -> Result<(), ChannelError> {
2877                 if (self.channel_state & (ChannelState::ChannelFunded as u32)) != (ChannelState::ChannelFunded as u32) {
2878                         return Err(ChannelError::Close("Got fail malformed HTLC message when channel was not in an operational state".to_owned()));
2879                 }
2880                 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
2881                         return Err(ChannelError::Close("Peer sent update_fail_malformed_htlc when we needed a channel_reestablish".to_owned()));
2882                 }
2883
2884                 self.mark_outbound_htlc_removed(msg.htlc_id, None, Some(fail_reason))?;
2885                 Ok(())
2886         }
2887
2888         pub fn commitment_signed<L: Deref>(&mut self, msg: &msgs::CommitmentSigned, logger: &L) -> Result<(msgs::RevokeAndACK, Option<msgs::CommitmentSigned>, ChannelMonitorUpdate), (Option<ChannelMonitorUpdate>, ChannelError)>
2889                 where L::Target: Logger
2890         {
2891                 if (self.channel_state & (ChannelState::ChannelFunded as u32)) != (ChannelState::ChannelFunded as u32) {
2892                         return Err((None, ChannelError::Close("Got commitment signed message when channel was not in an operational state".to_owned())));
2893                 }
2894                 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
2895                         return Err((None, ChannelError::Close("Peer sent commitment_signed when we needed a channel_reestablish".to_owned())));
2896                 }
2897                 if self.channel_state & BOTH_SIDES_SHUTDOWN_MASK == BOTH_SIDES_SHUTDOWN_MASK && self.last_sent_closing_fee.is_some() {
2898                         return Err((None, ChannelError::Close("Peer sent commitment_signed after we'd started exchanging closing_signeds".to_owned())));
2899                 }
2900
2901                 let funding_script = self.get_funding_redeemscript();
2902
2903                 let keys = self.build_holder_transaction_keys(self.cur_holder_commitment_transaction_number).map_err(|e| (None, e))?;
2904
2905                 let commitment_stats = self.build_commitment_transaction(self.cur_holder_commitment_transaction_number, &keys, true, false, logger);
2906                 let commitment_txid = {
2907                         let trusted_tx = commitment_stats.tx.trust();
2908                         let bitcoin_tx = trusted_tx.built_transaction();
2909                         let sighash = bitcoin_tx.get_sighash_all(&funding_script, self.channel_value_satoshis);
2910
2911                         log_trace!(logger, "Checking commitment tx signature {} by key {} against tx {} (sighash {}) with redeemscript {} in channel {}",
2912                                 log_bytes!(msg.signature.serialize_compact()[..]),
2913                                 log_bytes!(self.counterparty_funding_pubkey().serialize()), encode::serialize_hex(&bitcoin_tx.transaction),
2914                                 log_bytes!(sighash[..]), encode::serialize_hex(&funding_script), log_bytes!(self.channel_id()));
2915                         if let Err(_) = self.secp_ctx.verify_ecdsa(&sighash, &msg.signature, &self.counterparty_funding_pubkey()) {
2916                                 return Err((None, ChannelError::Close("Invalid commitment tx signature from peer".to_owned())));
2917                         }
2918                         bitcoin_tx.txid
2919                 };
2920                 let mut htlcs_cloned: Vec<_> = commitment_stats.htlcs_included.iter().map(|htlc| (htlc.0.clone(), htlc.1.map(|h| h.clone()))).collect();
2921
2922                 // If our counterparty updated the channel fee in this commitment transaction, check that
2923                 // they can actually afford the new fee now.
2924                 let update_fee = if let Some((_, update_state)) = self.pending_update_fee {
2925                         update_state == FeeUpdateState::RemoteAnnounced
2926                 } else { false };
2927                 if update_fee {
2928                         debug_assert!(!self.is_outbound());
2929                         let counterparty_reserve_we_require_msat = self.holder_selected_channel_reserve_satoshis * 1000;
2930                         if commitment_stats.remote_balance_msat < commitment_stats.total_fee_sat * 1000 + counterparty_reserve_we_require_msat {
2931                                 return Err((None, ChannelError::Close("Funding remote cannot afford proposed new fee".to_owned())));
2932                         }
2933                 }
2934                 #[cfg(any(test, fuzzing))]
2935                 {
2936                         if self.is_outbound() {
2937                                 let projected_commit_tx_info = self.next_local_commitment_tx_fee_info_cached.lock().unwrap().take();
2938                                 *self.next_remote_commitment_tx_fee_info_cached.lock().unwrap() = None;
2939                                 if let Some(info) = projected_commit_tx_info {
2940                                         let total_pending_htlcs = self.pending_inbound_htlcs.len() + self.pending_outbound_htlcs.len()
2941                                                 + self.holding_cell_htlc_updates.len();
2942                                         if info.total_pending_htlcs == total_pending_htlcs
2943                                                 && info.next_holder_htlc_id == self.next_holder_htlc_id
2944                                                 && info.next_counterparty_htlc_id == self.next_counterparty_htlc_id
2945                                                 && info.feerate == self.feerate_per_kw {
2946                                                         assert_eq!(commitment_stats.total_fee_sat, info.fee / 1000);
2947                                                 }
2948                                 }
2949                         }
2950                 }
2951
2952                 if msg.htlc_signatures.len() != commitment_stats.num_nondust_htlcs {
2953                         return Err((None, ChannelError::Close(format!("Got wrong number of HTLC signatures ({}) from remote. It must be {}", msg.htlc_signatures.len(), commitment_stats.num_nondust_htlcs))));
2954                 }
2955
2956                 // TODO: Sadly, we pass HTLCs twice to ChannelMonitor: once via the HolderCommitmentTransaction and once via the update
2957                 let mut htlcs_and_sigs = Vec::with_capacity(htlcs_cloned.len());
2958                 for (idx, (htlc, source)) in htlcs_cloned.drain(..).enumerate() {
2959                         if let Some(_) = htlc.transaction_output_index {
2960                                 let htlc_tx = chan_utils::build_htlc_transaction(&commitment_txid, commitment_stats.feerate_per_kw,
2961                                         self.get_counterparty_selected_contest_delay().unwrap(), &htlc, self.opt_anchors(),
2962                                         &keys.broadcaster_delayed_payment_key, &keys.revocation_key);
2963
2964                                 let htlc_redeemscript = chan_utils::get_htlc_redeemscript(&htlc, self.opt_anchors(), &keys);
2965                                 let htlc_sighashtype = if self.opt_anchors() { EcdsaSighashType::SinglePlusAnyoneCanPay } else { EcdsaSighashType::All };
2966                                 let htlc_sighash = hash_to_message!(&sighash::SighashCache::new(&htlc_tx).segwit_signature_hash(0, &htlc_redeemscript, htlc.amount_msat / 1000, htlc_sighashtype).unwrap()[..]);
2967                                 log_trace!(logger, "Checking HTLC tx signature {} by key {} against tx {} (sighash {}) with redeemscript {} in channel {}.",
2968                                         log_bytes!(msg.htlc_signatures[idx].serialize_compact()[..]), log_bytes!(keys.countersignatory_htlc_key.serialize()),
2969                                         encode::serialize_hex(&htlc_tx), log_bytes!(htlc_sighash[..]), encode::serialize_hex(&htlc_redeemscript), log_bytes!(self.channel_id()));
2970                                 if let Err(_) = self.secp_ctx.verify_ecdsa(&htlc_sighash, &msg.htlc_signatures[idx], &keys.countersignatory_htlc_key) {
2971                                         return Err((None, ChannelError::Close("Invalid HTLC tx signature from peer".to_owned())));
2972                                 }
2973                                 htlcs_and_sigs.push((htlc, Some(msg.htlc_signatures[idx]), source));
2974                         } else {
2975                                 htlcs_and_sigs.push((htlc, None, source));
2976                         }
2977                 }
2978
2979                 let holder_commitment_tx = HolderCommitmentTransaction::new(
2980                         commitment_stats.tx,
2981                         msg.signature,
2982                         msg.htlc_signatures.clone(),
2983                         &self.get_holder_pubkeys().funding_pubkey,
2984                         self.counterparty_funding_pubkey()
2985                 );
2986
2987                 let next_per_commitment_point = self.holder_signer.get_per_commitment_point(self.cur_holder_commitment_transaction_number - 1, &self.secp_ctx);
2988                 self.holder_signer.validate_holder_commitment(&holder_commitment_tx, commitment_stats.preimages)
2989                         .map_err(|_| (None, ChannelError::Close("Failed to validate our commitment".to_owned())))?;
2990                 let per_commitment_secret = self.holder_signer.release_commitment_secret(self.cur_holder_commitment_transaction_number + 1);
2991
2992                 // Update state now that we've passed all the can-fail calls...
2993                 let mut need_commitment = false;
2994                 if let &mut Some((_, ref mut update_state)) = &mut self.pending_update_fee {
2995                         if *update_state == FeeUpdateState::RemoteAnnounced {
2996                                 *update_state = FeeUpdateState::AwaitingRemoteRevokeToAnnounce;
2997                                 need_commitment = true;
2998                         }
2999                 }
3000
3001                 self.latest_monitor_update_id += 1;
3002                 let mut monitor_update = ChannelMonitorUpdate {
3003                         update_id: self.latest_monitor_update_id,
3004                         updates: vec![ChannelMonitorUpdateStep::LatestHolderCommitmentTXInfo {
3005                                 commitment_tx: holder_commitment_tx,
3006                                 htlc_outputs: htlcs_and_sigs
3007                         }]
3008                 };
3009
3010                 for htlc in self.pending_inbound_htlcs.iter_mut() {
3011                         let new_forward = if let &InboundHTLCState::RemoteAnnounced(ref forward_info) = &htlc.state {
3012                                 Some(forward_info.clone())
3013                         } else { None };
3014                         if let Some(forward_info) = new_forward {
3015                                 log_trace!(logger, "Updating HTLC {} to AwaitingRemoteRevokeToAnnounce due to commitment_signed in channel {}.",
3016                                         log_bytes!(htlc.payment_hash.0), log_bytes!(self.channel_id));
3017                                 htlc.state = InboundHTLCState::AwaitingRemoteRevokeToAnnounce(forward_info);
3018                                 need_commitment = true;
3019                         }
3020                 }
3021                 for htlc in self.pending_outbound_htlcs.iter_mut() {
3022                         if let &mut OutboundHTLCState::RemoteRemoved(ref mut outcome) = &mut htlc.state {
3023                                 log_trace!(logger, "Updating HTLC {} to AwaitingRemoteRevokeToRemove due to commitment_signed in channel {}.",
3024                                         log_bytes!(htlc.payment_hash.0), log_bytes!(self.channel_id));
3025                                 // Grab the preimage, if it exists, instead of cloning
3026                                 let mut reason = OutboundHTLCOutcome::Success(None);
3027                                 mem::swap(outcome, &mut reason);
3028                                 htlc.state = OutboundHTLCState::AwaitingRemoteRevokeToRemove(reason);
3029                                 need_commitment = true;
3030                         }
3031                 }
3032
3033                 self.cur_holder_commitment_transaction_number -= 1;
3034                 // Note that if we need_commitment & !AwaitingRemoteRevoke we'll call
3035                 // send_commitment_no_status_check() next which will reset this to RAAFirst.
3036                 self.resend_order = RAACommitmentOrder::CommitmentFirst;
3037
3038                 if (self.channel_state & ChannelState::MonitorUpdateFailed as u32) != 0 {
3039                         // In case we initially failed monitor updating without requiring a response, we need
3040                         // to make sure the RAA gets sent first.
3041                         self.monitor_pending_revoke_and_ack = true;
3042                         if need_commitment && (self.channel_state & (ChannelState::AwaitingRemoteRevoke as u32)) == 0 {
3043                                 // If we were going to send a commitment_signed after the RAA, go ahead and do all
3044                                 // the corresponding HTLC status updates so that get_last_commitment_update
3045                                 // includes the right HTLCs.
3046                                 self.monitor_pending_commitment_signed = true;
3047                                 let (_, mut additional_update) = self.send_commitment_no_status_check(logger).map_err(|e| (None, e))?;
3048                                 // send_commitment_no_status_check may bump latest_monitor_id but we want them to be
3049                                 // strictly increasing by one, so decrement it here.
3050                                 self.latest_monitor_update_id = monitor_update.update_id;
3051                                 monitor_update.updates.append(&mut additional_update.updates);
3052                         }
3053                         log_debug!(logger, "Received valid commitment_signed from peer in channel {}, updated HTLC state but awaiting a monitor update resolution to reply.",
3054                                 log_bytes!(self.channel_id));
3055                         return Err((Some(monitor_update), ChannelError::Ignore("Previous monitor update failure prevented generation of RAA".to_owned())));
3056                 }
3057
3058                 let commitment_signed = if need_commitment && (self.channel_state & (ChannelState::AwaitingRemoteRevoke as u32)) == 0 {
3059                         // If we're AwaitingRemoteRevoke we can't send a new commitment here, but that's ok -
3060                         // we'll send one right away when we get the revoke_and_ack when we
3061                         // free_holding_cell_htlcs().
3062                         let (msg, mut additional_update) = self.send_commitment_no_status_check(logger).map_err(|e| (None, e))?;
3063                         // send_commitment_no_status_check may bump latest_monitor_id but we want them to be
3064                         // strictly increasing by one, so decrement it here.
3065                         self.latest_monitor_update_id = monitor_update.update_id;
3066                         monitor_update.updates.append(&mut additional_update.updates);
3067                         Some(msg)
3068                 } else { None };
3069
3070                 log_debug!(logger, "Received valid commitment_signed from peer in channel {}, updating HTLC state and responding with{} a revoke_and_ack.",
3071                         log_bytes!(self.channel_id()), if commitment_signed.is_some() { " our own commitment_signed and" } else { "" });
3072
3073                 Ok((msgs::RevokeAndACK {
3074                         channel_id: self.channel_id,
3075                         per_commitment_secret,
3076                         next_per_commitment_point,
3077                 }, commitment_signed, monitor_update))
3078         }
3079
3080         /// Public version of the below, checking relevant preconditions first.
3081         /// If we're not in a state where freeing the holding cell makes sense, this is a no-op and
3082         /// returns `(None, Vec::new())`.
3083         pub fn maybe_free_holding_cell_htlcs<L: Deref>(&mut self, logger: &L) -> Result<(Option<(msgs::CommitmentUpdate, ChannelMonitorUpdate)>, Vec<(HTLCSource, PaymentHash)>), ChannelError> where L::Target: Logger {
3084                 if self.channel_state >= ChannelState::ChannelFunded as u32 &&
3085                    (self.channel_state & (ChannelState::AwaitingRemoteRevoke as u32 | ChannelState::PeerDisconnected as u32 | ChannelState::MonitorUpdateFailed as u32)) == 0 {
3086                         self.free_holding_cell_htlcs(logger)
3087                 } else { Ok((None, Vec::new())) }
3088         }
3089
3090         /// Used to fulfill holding_cell_htlcs when we get a remote ack (or implicitly get it by them
3091         /// fulfilling or failing the last pending HTLC)
3092         fn free_holding_cell_htlcs<L: Deref>(&mut self, logger: &L) -> Result<(Option<(msgs::CommitmentUpdate, ChannelMonitorUpdate)>, Vec<(HTLCSource, PaymentHash)>), ChannelError> where L::Target: Logger {
3093                 assert_eq!(self.channel_state & ChannelState::MonitorUpdateFailed as u32, 0);
3094                 if self.holding_cell_htlc_updates.len() != 0 || self.holding_cell_update_fee.is_some() {
3095                         log_trace!(logger, "Freeing holding cell with {} HTLC updates{} in channel {}", self.holding_cell_htlc_updates.len(),
3096                                 if self.holding_cell_update_fee.is_some() { " and a fee update" } else { "" }, log_bytes!(self.channel_id()));
3097
3098                         let mut monitor_update = ChannelMonitorUpdate {
3099                                 update_id: self.latest_monitor_update_id + 1, // We don't increment this yet!
3100                                 updates: Vec::new(),
3101                         };
3102
3103                         let mut htlc_updates = Vec::new();
3104                         mem::swap(&mut htlc_updates, &mut self.holding_cell_htlc_updates);
3105                         let mut update_add_htlcs = Vec::with_capacity(htlc_updates.len());
3106                         let mut update_fulfill_htlcs = Vec::with_capacity(htlc_updates.len());
3107                         let mut update_fail_htlcs = Vec::with_capacity(htlc_updates.len());
3108                         let mut htlcs_to_fail = Vec::new();
3109                         for htlc_update in htlc_updates.drain(..) {
3110                                 // Note that this *can* fail, though it should be due to rather-rare conditions on
3111                                 // fee races with adding too many outputs which push our total payments just over
3112                                 // the limit. In case it's less rare than I anticipate, we may want to revisit
3113                                 // handling this case better and maybe fulfilling some of the HTLCs while attempting
3114                                 // to rebalance channels.
3115                                 match &htlc_update {
3116                                         &HTLCUpdateAwaitingACK::AddHTLC {amount_msat, cltv_expiry, ref payment_hash, ref source, ref onion_routing_packet, ..} => {
3117                                                 match self.send_htlc(amount_msat, *payment_hash, cltv_expiry, source.clone(), onion_routing_packet.clone(), logger) {
3118                                                         Ok(update_add_msg_option) => update_add_htlcs.push(update_add_msg_option.unwrap()),
3119                                                         Err(e) => {
3120                                                                 match e {
3121                                                                         ChannelError::Ignore(ref msg) => {
3122                                                                                 log_info!(logger, "Failed to send HTLC with payment_hash {} due to {} in channel {}",
3123                                                                                         log_bytes!(payment_hash.0), msg, log_bytes!(self.channel_id()));
3124                                                                                 // If we fail to send here, then this HTLC should
3125                                                                                 // be failed backwards. Failing to send here
3126                                                                                 // indicates that this HTLC may keep being put back
3127                                                                                 // into the holding cell without ever being
3128                                                                                 // successfully forwarded/failed/fulfilled, causing
3129                                                                                 // our counterparty to eventually close on us.
3130                                                                                 htlcs_to_fail.push((source.clone(), *payment_hash));
3131                                                                         },
3132                                                                         _ => {
3133                                                                                 panic!("Got a non-IgnoreError action trying to send holding cell HTLC");
3134                                                                         },
3135                                                                 }
3136                                                         }
3137                                                 }
3138                                         },
3139                                         &HTLCUpdateAwaitingACK::ClaimHTLC { ref payment_preimage, htlc_id, .. } => {
3140                                                 // If an HTLC claim was previously added to the holding cell (via
3141                                                 // `get_update_fulfill_htlc`, then generating the claim message itself must
3142                                                 // not fail - any in between attempts to claim the HTLC will have resulted
3143                                                 // in it hitting the holding cell again and we cannot change the state of a
3144                                                 // holding cell HTLC from fulfill to anything else.
3145                                                 let (update_fulfill_msg_option, mut additional_monitor_update) =
3146                                                         if let UpdateFulfillFetch::NewClaim { msg, monitor_update, .. } = self.get_update_fulfill_htlc(htlc_id, *payment_preimage, logger) {
3147                                                                 (msg, monitor_update)
3148                                                         } else { unreachable!() };
3149                                                 update_fulfill_htlcs.push(update_fulfill_msg_option.unwrap());
3150                                                 monitor_update.updates.append(&mut additional_monitor_update.updates);
3151                                         },
3152                                         &HTLCUpdateAwaitingACK::FailHTLC { htlc_id, ref err_packet } => {
3153                                                 match self.get_update_fail_htlc(htlc_id, err_packet.clone(), logger) {
3154                                                         Ok(update_fail_msg_option) => {
3155                                                                 // If an HTLC failure was previously added to the holding cell (via
3156                                                                 // `get_update_fail_htlc`) then generating the fail message itself
3157                                                                 // must not fail - we should never end up in a state where we
3158                                                                 // double-fail an HTLC or fail-then-claim an HTLC as it indicates
3159                                                                 // we didn't wait for a full revocation before failing.
3160                                                                 update_fail_htlcs.push(update_fail_msg_option.unwrap())
3161                                                         },
3162                                                         Err(e) => {
3163                                                                 if let ChannelError::Ignore(_) = e {}
3164                                                                 else {
3165                                                                         panic!("Got a non-IgnoreError action trying to fail holding cell HTLC");
3166                                                                 }
3167                                                         }
3168                                                 }
3169                                         },
3170                                 }
3171                         }
3172                         if update_add_htlcs.is_empty() && update_fulfill_htlcs.is_empty() && update_fail_htlcs.is_empty() && self.holding_cell_update_fee.is_none() {
3173                                 return Ok((None, htlcs_to_fail));
3174                         }
3175                         let update_fee = if let Some(feerate) = self.holding_cell_update_fee.take() {
3176                                 self.send_update_fee(feerate, logger)
3177                         } else {
3178                                 None
3179                         };
3180
3181                         let (commitment_signed, mut additional_update) = self.send_commitment_no_status_check(logger)?;
3182                         // send_commitment_no_status_check and get_update_fulfill_htlc may bump latest_monitor_id
3183                         // but we want them to be strictly increasing by one, so reset it here.
3184                         self.latest_monitor_update_id = monitor_update.update_id;
3185                         monitor_update.updates.append(&mut additional_update.updates);
3186
3187                         log_debug!(logger, "Freeing holding cell in channel {} resulted in {}{} HTLCs added, {} HTLCs fulfilled, and {} HTLCs failed.",
3188                                 log_bytes!(self.channel_id()), if update_fee.is_some() { "a fee update, " } else { "" },
3189                                 update_add_htlcs.len(), update_fulfill_htlcs.len(), update_fail_htlcs.len());
3190
3191                         Ok((Some((msgs::CommitmentUpdate {
3192                                 update_add_htlcs,
3193                                 update_fulfill_htlcs,
3194                                 update_fail_htlcs,
3195                                 update_fail_malformed_htlcs: Vec::new(),
3196                                 update_fee,
3197                                 commitment_signed,
3198                         }, monitor_update)), htlcs_to_fail))
3199                 } else {
3200                         Ok((None, Vec::new()))
3201                 }
3202         }
3203
3204         /// Handles receiving a remote's revoke_and_ack. Note that we may return a new
3205         /// commitment_signed message here in case we had pending outbound HTLCs to add which were
3206         /// waiting on this revoke_and_ack. The generation of this new commitment_signed may also fail,
3207         /// generating an appropriate error *after* the channel state has been updated based on the
3208         /// revoke_and_ack message.
3209         pub fn revoke_and_ack<L: Deref>(&mut self, msg: &msgs::RevokeAndACK, logger: &L) -> Result<RAAUpdates, ChannelError>
3210                 where L::Target: Logger,
3211         {
3212                 if (self.channel_state & (ChannelState::ChannelFunded as u32)) != (ChannelState::ChannelFunded as u32) {
3213                         return Err(ChannelError::Close("Got revoke/ACK message when channel was not in an operational state".to_owned()));
3214                 }
3215                 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
3216                         return Err(ChannelError::Close("Peer sent revoke_and_ack when we needed a channel_reestablish".to_owned()));
3217                 }
3218                 if self.channel_state & BOTH_SIDES_SHUTDOWN_MASK == BOTH_SIDES_SHUTDOWN_MASK && self.last_sent_closing_fee.is_some() {
3219                         return Err(ChannelError::Close("Peer sent revoke_and_ack after we'd started exchanging closing_signeds".to_owned()));
3220                 }
3221
3222                 let secret = secp_check!(SecretKey::from_slice(&msg.per_commitment_secret), "Peer provided an invalid per_commitment_secret".to_owned());
3223
3224                 if let Some(counterparty_prev_commitment_point) = self.counterparty_prev_commitment_point {
3225                         if PublicKey::from_secret_key(&self.secp_ctx, &secret) != counterparty_prev_commitment_point {
3226                                 return Err(ChannelError::Close("Got a revoke commitment secret which didn't correspond to their current pubkey".to_owned()));
3227                         }
3228                 }
3229
3230                 if self.channel_state & ChannelState::AwaitingRemoteRevoke as u32 == 0 {
3231                         // Our counterparty seems to have burned their coins to us (by revoking a state when we
3232                         // haven't given them a new commitment transaction to broadcast). We should probably
3233                         // take advantage of this by updating our channel monitor, sending them an error, and
3234                         // waiting for them to broadcast their latest (now-revoked claim). But, that would be a
3235                         // lot of work, and there's some chance this is all a misunderstanding anyway.
3236                         // We have to do *something*, though, since our signer may get mad at us for otherwise
3237                         // jumping a remote commitment number, so best to just force-close and move on.
3238                         return Err(ChannelError::Close("Received an unexpected revoke_and_ack".to_owned()));
3239                 }
3240
3241                 #[cfg(any(test, fuzzing))]
3242                 {
3243                         *self.next_local_commitment_tx_fee_info_cached.lock().unwrap() = None;
3244                         *self.next_remote_commitment_tx_fee_info_cached.lock().unwrap() = None;
3245                 }
3246
3247                 self.holder_signer.validate_counterparty_revocation(
3248                         self.cur_counterparty_commitment_transaction_number + 1,
3249                         &secret
3250                 ).map_err(|_| ChannelError::Close("Failed to validate revocation from peer".to_owned()))?;
3251
3252                 self.commitment_secrets.provide_secret(self.cur_counterparty_commitment_transaction_number + 1, msg.per_commitment_secret)
3253                         .map_err(|_| ChannelError::Close("Previous secrets did not match new one".to_owned()))?;
3254                 self.latest_monitor_update_id += 1;
3255                 let mut monitor_update = ChannelMonitorUpdate {
3256                         update_id: self.latest_monitor_update_id,
3257                         updates: vec![ChannelMonitorUpdateStep::CommitmentSecret {
3258                                 idx: self.cur_counterparty_commitment_transaction_number + 1,
3259                                 secret: msg.per_commitment_secret,
3260                         }],
3261                 };
3262
3263                 // Update state now that we've passed all the can-fail calls...
3264                 // (note that we may still fail to generate the new commitment_signed message, but that's
3265                 // OK, we step the channel here and *then* if the new generation fails we can fail the
3266                 // channel based on that, but stepping stuff here should be safe either way.
3267                 self.channel_state &= !(ChannelState::AwaitingRemoteRevoke as u32);
3268                 self.counterparty_prev_commitment_point = self.counterparty_cur_commitment_point;
3269                 self.counterparty_cur_commitment_point = Some(msg.next_per_commitment_point);
3270                 self.cur_counterparty_commitment_transaction_number -= 1;
3271
3272                 if self.announcement_sigs_state == AnnouncementSigsState::Committed {
3273                         self.announcement_sigs_state = AnnouncementSigsState::PeerReceived;
3274                 }
3275
3276                 log_trace!(logger, "Updating HTLCs on receipt of RAA in channel {}...", log_bytes!(self.channel_id()));
3277                 let mut to_forward_infos = Vec::new();
3278                 let mut revoked_htlcs = Vec::new();
3279                 let mut finalized_claimed_htlcs = Vec::new();
3280                 let mut update_fail_htlcs = Vec::new();
3281                 let mut update_fail_malformed_htlcs = Vec::new();
3282                 let mut require_commitment = false;
3283                 let mut value_to_self_msat_diff: i64 = 0;
3284
3285                 {
3286                         // Take references explicitly so that we can hold multiple references to self.
3287                         let pending_inbound_htlcs: &mut Vec<_> = &mut self.pending_inbound_htlcs;
3288                         let pending_outbound_htlcs: &mut Vec<_> = &mut self.pending_outbound_htlcs;
3289
3290                         // We really shouldnt have two passes here, but retain gives a non-mutable ref (Rust bug)
3291                         pending_inbound_htlcs.retain(|htlc| {
3292                                 if let &InboundHTLCState::LocalRemoved(ref reason) = &htlc.state {
3293                                         log_trace!(logger, " ...removing inbound LocalRemoved {}", log_bytes!(htlc.payment_hash.0));
3294                                         if let &InboundHTLCRemovalReason::Fulfill(_) = reason {
3295                                                 value_to_self_msat_diff += htlc.amount_msat as i64;
3296                                         }
3297                                         false
3298                                 } else { true }
3299                         });
3300                         pending_outbound_htlcs.retain(|htlc| {
3301                                 if let &OutboundHTLCState::AwaitingRemovedRemoteRevoke(ref outcome) = &htlc.state {
3302                                         log_trace!(logger, " ...removing outbound AwaitingRemovedRemoteRevoke {}", log_bytes!(htlc.payment_hash.0));
3303                                         if let OutboundHTLCOutcome::Failure(reason) = outcome.clone() { // We really want take() here, but, again, non-mut ref :(
3304                                                 revoked_htlcs.push((htlc.source.clone(), htlc.payment_hash, reason));
3305                                         } else {
3306                                                 finalized_claimed_htlcs.push(htlc.source.clone());
3307                                                 // They fulfilled, so we sent them money
3308                                                 value_to_self_msat_diff -= htlc.amount_msat as i64;
3309                                         }
3310                                         false
3311                                 } else { true }
3312                         });
3313                         for htlc in pending_inbound_htlcs.iter_mut() {
3314                                 let swap = if let &InboundHTLCState::AwaitingRemoteRevokeToAnnounce(_) = &htlc.state {
3315                                         true
3316                                 } else if let &InboundHTLCState::AwaitingAnnouncedRemoteRevoke(_) = &htlc.state {
3317                                         true
3318                                 } else { false };
3319                                 if swap {
3320                                         let mut state = InboundHTLCState::Committed;
3321                                         mem::swap(&mut state, &mut htlc.state);
3322
3323                                         if let InboundHTLCState::AwaitingRemoteRevokeToAnnounce(forward_info) = state {
3324                                                 log_trace!(logger, " ...promoting inbound AwaitingRemoteRevokeToAnnounce {} to AwaitingAnnouncedRemoteRevoke", log_bytes!(htlc.payment_hash.0));
3325                                                 htlc.state = InboundHTLCState::AwaitingAnnouncedRemoteRevoke(forward_info);
3326                                                 require_commitment = true;
3327                                         } else if let InboundHTLCState::AwaitingAnnouncedRemoteRevoke(forward_info) = state {
3328                                                 match forward_info {
3329                                                         PendingHTLCStatus::Fail(fail_msg) => {
3330                                                                 log_trace!(logger, " ...promoting inbound AwaitingAnnouncedRemoteRevoke {} to LocalRemoved due to PendingHTLCStatus indicating failure", log_bytes!(htlc.payment_hash.0));
3331                                                                 require_commitment = true;
3332                                                                 match fail_msg {
3333                                                                         HTLCFailureMsg::Relay(msg) => {
3334                                                                                 htlc.state = InboundHTLCState::LocalRemoved(InboundHTLCRemovalReason::FailRelay(msg.reason.clone()));
3335                                                                                 update_fail_htlcs.push(msg)
3336                                                                         },
3337                                                                         HTLCFailureMsg::Malformed(msg) => {
3338                                                                                 htlc.state = InboundHTLCState::LocalRemoved(InboundHTLCRemovalReason::FailMalformed((msg.sha256_of_onion, msg.failure_code)));
3339                                                                                 update_fail_malformed_htlcs.push(msg)
3340                                                                         },
3341                                                                 }
3342                                                         },
3343                                                         PendingHTLCStatus::Forward(forward_info) => {
3344                                                                 log_trace!(logger, " ...promoting inbound AwaitingAnnouncedRemoteRevoke {} to Committed", log_bytes!(htlc.payment_hash.0));
3345                                                                 to_forward_infos.push((forward_info, htlc.htlc_id));
3346                                                                 htlc.state = InboundHTLCState::Committed;
3347                                                         }
3348                                                 }
3349                                         }
3350                                 }
3351                         }
3352                         for htlc in pending_outbound_htlcs.iter_mut() {
3353                                 if let OutboundHTLCState::LocalAnnounced(_) = htlc.state {
3354                                         log_trace!(logger, " ...promoting outbound LocalAnnounced {} to Committed", log_bytes!(htlc.payment_hash.0));
3355                                         htlc.state = OutboundHTLCState::Committed;
3356                                 }
3357                                 if let &mut OutboundHTLCState::AwaitingRemoteRevokeToRemove(ref mut outcome) = &mut htlc.state {
3358                                         log_trace!(logger, " ...promoting outbound AwaitingRemoteRevokeToRemove {} to AwaitingRemovedRemoteRevoke", log_bytes!(htlc.payment_hash.0));
3359                                         // Grab the preimage, if it exists, instead of cloning
3360                                         let mut reason = OutboundHTLCOutcome::Success(None);
3361                                         mem::swap(outcome, &mut reason);
3362                                         htlc.state = OutboundHTLCState::AwaitingRemovedRemoteRevoke(reason);
3363                                         require_commitment = true;
3364                                 }
3365                         }
3366                 }
3367                 self.value_to_self_msat = (self.value_to_self_msat as i64 + value_to_self_msat_diff) as u64;
3368
3369                 if let Some((feerate, update_state)) = self.pending_update_fee {
3370                         match update_state {
3371                                 FeeUpdateState::Outbound => {
3372                                         debug_assert!(self.is_outbound());
3373                                         log_trace!(logger, " ...promoting outbound fee update {} to Committed", feerate);
3374                                         self.feerate_per_kw = feerate;
3375                                         self.pending_update_fee = None;
3376                                 },
3377                                 FeeUpdateState::RemoteAnnounced => { debug_assert!(!self.is_outbound()); },
3378                                 FeeUpdateState::AwaitingRemoteRevokeToAnnounce => {
3379                                         debug_assert!(!self.is_outbound());
3380                                         log_trace!(logger, " ...promoting inbound AwaitingRemoteRevokeToAnnounce fee update {} to Committed", feerate);
3381                                         require_commitment = true;
3382                                         self.feerate_per_kw = feerate;
3383                                         self.pending_update_fee = None;
3384                                 },
3385                         }
3386                 }
3387
3388                 if (self.channel_state & ChannelState::MonitorUpdateFailed as u32) == ChannelState::MonitorUpdateFailed as u32 {
3389                         // We can't actually generate a new commitment transaction (incl by freeing holding
3390                         // cells) while we can't update the monitor, so we just return what we have.
3391                         if require_commitment {
3392                                 self.monitor_pending_commitment_signed = true;
3393                                 // When the monitor updating is restored we'll call get_last_commitment_update(),
3394                                 // which does not update state, but we're definitely now awaiting a remote revoke
3395                                 // before we can step forward any more, so set it here.
3396                                 let (_, mut additional_update) = self.send_commitment_no_status_check(logger)?;
3397                                 // send_commitment_no_status_check may bump latest_monitor_id but we want them to be
3398                                 // strictly increasing by one, so decrement it here.
3399                                 self.latest_monitor_update_id = monitor_update.update_id;
3400                                 monitor_update.updates.append(&mut additional_update.updates);
3401                         }
3402                         self.monitor_pending_forwards.append(&mut to_forward_infos);
3403                         self.monitor_pending_failures.append(&mut revoked_htlcs);
3404                         self.monitor_pending_finalized_fulfills.append(&mut finalized_claimed_htlcs);
3405                         log_debug!(logger, "Received a valid revoke_and_ack for channel {} but awaiting a monitor update resolution to reply.", log_bytes!(self.channel_id()));
3406                         return Ok(RAAUpdates {
3407                                 commitment_update: None, finalized_claimed_htlcs: Vec::new(),
3408                                 accepted_htlcs: Vec::new(), failed_htlcs: Vec::new(),
3409                                 monitor_update,
3410                                 holding_cell_failed_htlcs: Vec::new()
3411                         });
3412                 }
3413
3414                 match self.free_holding_cell_htlcs(logger)? {
3415                         (Some((mut commitment_update, mut additional_update)), htlcs_to_fail) => {
3416                                 commitment_update.update_fail_htlcs.reserve(update_fail_htlcs.len());
3417                                 for fail_msg in update_fail_htlcs.drain(..) {
3418                                         commitment_update.update_fail_htlcs.push(fail_msg);
3419                                 }
3420                                 commitment_update.update_fail_malformed_htlcs.reserve(update_fail_malformed_htlcs.len());
3421                                 for fail_msg in update_fail_malformed_htlcs.drain(..) {
3422                                         commitment_update.update_fail_malformed_htlcs.push(fail_msg);
3423                                 }
3424
3425                                 // free_holding_cell_htlcs may bump latest_monitor_id multiple times but we want them to be
3426                                 // strictly increasing by one, so decrement it here.
3427                                 self.latest_monitor_update_id = monitor_update.update_id;
3428                                 monitor_update.updates.append(&mut additional_update.updates);
3429
3430                                 Ok(RAAUpdates {
3431                                         commitment_update: Some(commitment_update),
3432                                         finalized_claimed_htlcs,
3433                                         accepted_htlcs: to_forward_infos,
3434                                         failed_htlcs: revoked_htlcs,
3435                                         monitor_update,
3436                                         holding_cell_failed_htlcs: htlcs_to_fail
3437                                 })
3438                         },
3439                         (None, htlcs_to_fail) => {
3440                                 if require_commitment {
3441                                         let (commitment_signed, mut additional_update) = self.send_commitment_no_status_check(logger)?;
3442
3443                                         // send_commitment_no_status_check may bump latest_monitor_id but we want them to be
3444                                         // strictly increasing by one, so decrement it here.
3445                                         self.latest_monitor_update_id = monitor_update.update_id;
3446                                         monitor_update.updates.append(&mut additional_update.updates);
3447
3448                                         log_debug!(logger, "Received a valid revoke_and_ack for channel {}. Responding with a commitment update with {} HTLCs failed.",
3449                                                 log_bytes!(self.channel_id()), update_fail_htlcs.len() + update_fail_malformed_htlcs.len());
3450                                         Ok(RAAUpdates {
3451                                                 commitment_update: Some(msgs::CommitmentUpdate {
3452                                                         update_add_htlcs: Vec::new(),
3453                                                         update_fulfill_htlcs: Vec::new(),
3454                                                         update_fail_htlcs,
3455                                                         update_fail_malformed_htlcs,
3456                                                         update_fee: None,
3457                                                         commitment_signed
3458                                                 }),
3459                                                 finalized_claimed_htlcs,
3460                                                 accepted_htlcs: to_forward_infos, failed_htlcs: revoked_htlcs,
3461                                                 monitor_update, holding_cell_failed_htlcs: htlcs_to_fail
3462                                         })
3463                                 } else {
3464                                         log_debug!(logger, "Received a valid revoke_and_ack for channel {} with no reply necessary.", log_bytes!(self.channel_id()));
3465                                         Ok(RAAUpdates {
3466                                                 commitment_update: None,
3467                                                 finalized_claimed_htlcs,
3468                                                 accepted_htlcs: to_forward_infos, failed_htlcs: revoked_htlcs,
3469                                                 monitor_update, holding_cell_failed_htlcs: htlcs_to_fail
3470                                         })
3471                                 }
3472                         }
3473                 }
3474         }
3475
3476         /// Adds a pending update to this channel. See the doc for send_htlc for
3477         /// further details on the optionness of the return value.
3478         /// If our balance is too low to cover the cost of the next commitment transaction at the
3479         /// new feerate, the update is cancelled.
3480         /// You MUST call send_commitment prior to any other calls on this Channel
3481         fn send_update_fee<L: Deref>(&mut self, feerate_per_kw: u32, logger: &L) -> Option<msgs::UpdateFee> where L::Target: Logger {
3482                 if !self.is_outbound() {
3483                         panic!("Cannot send fee from inbound channel");
3484                 }
3485                 if !self.is_usable() {
3486                         panic!("Cannot update fee until channel is fully established and we haven't started shutting down");
3487                 }
3488                 if !self.is_live() {
3489                         panic!("Cannot update fee while peer is disconnected/we're awaiting a monitor update (ChannelManager should have caught this)");
3490                 }
3491
3492                 // Before proposing a feerate update, check that we can actually afford the new fee.
3493                 let inbound_stats = self.get_inbound_pending_htlc_stats(Some(feerate_per_kw));
3494                 let outbound_stats = self.get_outbound_pending_htlc_stats(Some(feerate_per_kw));
3495                 let keys = if let Ok(keys) = self.build_holder_transaction_keys(self.cur_holder_commitment_transaction_number) { keys } else { return None; };
3496                 let commitment_stats = self.build_commitment_transaction(self.cur_holder_commitment_transaction_number, &keys, true, true, logger);
3497                 let buffer_fee_msat = Channel::<Signer>::commit_tx_fee_sat(feerate_per_kw, commitment_stats.num_nondust_htlcs + outbound_stats.on_holder_tx_holding_cell_htlcs_count as usize + CONCURRENT_INBOUND_HTLC_FEE_BUFFER as usize, self.opt_anchors()) * 1000;
3498                 let holder_balance_msat = commitment_stats.local_balance_msat - outbound_stats.holding_cell_msat;
3499                 if holder_balance_msat < buffer_fee_msat  + self.counterparty_selected_channel_reserve_satoshis.unwrap() * 1000 {
3500                         //TODO: auto-close after a number of failures?
3501                         log_debug!(logger, "Cannot afford to send new feerate at {}", feerate_per_kw);
3502                         return None;
3503                 }
3504
3505                 // Note, we evaluate pending htlc "preemptive" trimmed-to-dust threshold at the proposed `feerate_per_kw`.
3506                 let holder_tx_dust_exposure = inbound_stats.on_holder_tx_dust_exposure_msat + outbound_stats.on_holder_tx_dust_exposure_msat;
3507                 let counterparty_tx_dust_exposure = inbound_stats.on_counterparty_tx_dust_exposure_msat + outbound_stats.on_counterparty_tx_dust_exposure_msat;
3508                 if holder_tx_dust_exposure > self.get_max_dust_htlc_exposure_msat() {
3509                         log_debug!(logger, "Cannot afford to send new feerate at {} without infringing max dust htlc exposure", feerate_per_kw);
3510                         return None;
3511                 }
3512                 if counterparty_tx_dust_exposure > self.get_max_dust_htlc_exposure_msat() {
3513                         log_debug!(logger, "Cannot afford to send new feerate at {} without infringing max dust htlc exposure", feerate_per_kw);
3514                         return None;
3515                 }
3516
3517                 if (self.channel_state & (ChannelState::AwaitingRemoteRevoke as u32 | ChannelState::MonitorUpdateFailed as u32)) != 0 {
3518                         self.holding_cell_update_fee = Some(feerate_per_kw);
3519                         return None;
3520                 }
3521
3522                 debug_assert!(self.pending_update_fee.is_none());
3523                 self.pending_update_fee = Some((feerate_per_kw, FeeUpdateState::Outbound));
3524
3525                 Some(msgs::UpdateFee {
3526                         channel_id: self.channel_id,
3527                         feerate_per_kw,
3528                 })
3529         }
3530
3531         pub fn send_update_fee_and_commit<L: Deref>(&mut self, feerate_per_kw: u32, logger: &L) -> Result<Option<(msgs::UpdateFee, msgs::CommitmentSigned, ChannelMonitorUpdate)>, ChannelError> where L::Target: Logger {
3532                 match self.send_update_fee(feerate_per_kw, logger) {
3533                         Some(update_fee) => {
3534                                 let (commitment_signed, monitor_update) = self.send_commitment_no_status_check(logger)?;
3535                                 Ok(Some((update_fee, commitment_signed, monitor_update)))
3536                         },
3537                         None => Ok(None)
3538                 }
3539         }
3540
3541         /// Removes any uncommitted inbound HTLCs and resets the state of uncommitted outbound HTLC
3542         /// updates, to be used on peer disconnection. After this, update_*_htlc messages need to be
3543         /// resent.
3544         /// No further message handling calls may be made until a channel_reestablish dance has
3545         /// completed.
3546         pub fn remove_uncommitted_htlcs_and_mark_paused<L: Deref>(&mut self, logger: &L)  where L::Target: Logger {
3547                 assert_eq!(self.channel_state & ChannelState::ShutdownComplete as u32, 0);
3548                 if self.channel_state < ChannelState::FundingSent as u32 {
3549                         self.channel_state = ChannelState::ShutdownComplete as u32;
3550                         return;
3551                 }
3552
3553                 if self.announcement_sigs_state == AnnouncementSigsState::MessageSent || self.announcement_sigs_state == AnnouncementSigsState::Committed {
3554                         self.announcement_sigs_state = AnnouncementSigsState::NotSent;
3555                 }
3556
3557                 // Upon reconnect we have to start the closing_signed dance over, but shutdown messages
3558                 // will be retransmitted.
3559                 self.last_sent_closing_fee = None;
3560                 self.pending_counterparty_closing_signed = None;
3561                 self.closing_fee_limits = None;
3562
3563                 let mut inbound_drop_count = 0;
3564                 self.pending_inbound_htlcs.retain(|htlc| {
3565                         match htlc.state {
3566                                 InboundHTLCState::RemoteAnnounced(_) => {
3567                                         // They sent us an update_add_htlc but we never got the commitment_signed.
3568                                         // We'll tell them what commitment_signed we're expecting next and they'll drop
3569                                         // this HTLC accordingly
3570                                         inbound_drop_count += 1;
3571                                         false
3572                                 },
3573                                 InboundHTLCState::AwaitingRemoteRevokeToAnnounce(_)|InboundHTLCState::AwaitingAnnouncedRemoteRevoke(_) => {
3574                                         // We received a commitment_signed updating this HTLC and (at least hopefully)
3575                                         // sent a revoke_and_ack (which we can re-transmit) and have heard nothing
3576                                         // in response to it yet, so don't touch it.
3577                                         true
3578                                 },
3579                                 InboundHTLCState::Committed => true,
3580                                 InboundHTLCState::LocalRemoved(_) => {
3581                                         // We (hopefully) sent a commitment_signed updating this HTLC (which we can
3582                                         // re-transmit if needed) and they may have even sent a revoke_and_ack back
3583                                         // (that we missed). Keep this around for now and if they tell us they missed
3584                                         // the commitment_signed we can re-transmit the update then.
3585                                         true
3586                                 },
3587                         }
3588                 });
3589                 self.next_counterparty_htlc_id -= inbound_drop_count;
3590
3591                 if let Some((_, update_state)) = self.pending_update_fee {
3592                         if update_state == FeeUpdateState::RemoteAnnounced {
3593                                 debug_assert!(!self.is_outbound());
3594                                 self.pending_update_fee = None;
3595                         }
3596                 }
3597
3598                 for htlc in self.pending_outbound_htlcs.iter_mut() {
3599                         if let OutboundHTLCState::RemoteRemoved(_) = htlc.state {
3600                                 // They sent us an update to remove this but haven't yet sent the corresponding
3601                                 // commitment_signed, we need to move it back to Committed and they can re-send
3602                                 // the update upon reconnection.
3603                                 htlc.state = OutboundHTLCState::Committed;
3604                         }
3605                 }
3606
3607                 self.channel_state |= ChannelState::PeerDisconnected as u32;
3608                 log_trace!(logger, "Peer disconnection resulted in {} remote-announced HTLC drops on channel {}", inbound_drop_count, log_bytes!(self.channel_id()));
3609         }
3610
3611         /// Indicates that a ChannelMonitor update failed to be stored by the client and further
3612         /// updates are partially paused.
3613         /// This must be called immediately after the call which generated the ChannelMonitor update
3614         /// which failed. The messages which were generated from that call which generated the
3615         /// monitor update failure must *not* have been sent to the remote end, and must instead
3616         /// have been dropped. They will be regenerated when monitor_updating_restored is called.
3617         pub fn monitor_update_failed(&mut self, resend_raa: bool, resend_commitment: bool,
3618                 resend_channel_ready: bool, mut pending_forwards: Vec<(PendingHTLCInfo, u64)>,
3619                 mut pending_fails: Vec<(HTLCSource, PaymentHash, HTLCFailReason)>,
3620                 mut pending_finalized_claimed_htlcs: Vec<HTLCSource>
3621         ) {
3622                 self.monitor_pending_revoke_and_ack |= resend_raa;
3623                 self.monitor_pending_commitment_signed |= resend_commitment;
3624                 self.monitor_pending_channel_ready |= resend_channel_ready;
3625                 self.monitor_pending_forwards.append(&mut pending_forwards);
3626                 self.monitor_pending_failures.append(&mut pending_fails);
3627                 self.monitor_pending_finalized_fulfills.append(&mut pending_finalized_claimed_htlcs);
3628                 self.channel_state |= ChannelState::MonitorUpdateFailed as u32;
3629         }
3630
3631         /// Indicates that the latest ChannelMonitor update has been committed by the client
3632         /// successfully and we should restore normal operation. Returns messages which should be sent
3633         /// to the remote side.
3634         pub fn monitor_updating_restored<L: Deref>(&mut self, logger: &L, node_pk: PublicKey, genesis_block_hash: BlockHash, best_block_height: u32) -> MonitorRestoreUpdates where L::Target: Logger {
3635                 assert_eq!(self.channel_state & ChannelState::MonitorUpdateFailed as u32, ChannelState::MonitorUpdateFailed as u32);
3636                 self.channel_state &= !(ChannelState::MonitorUpdateFailed as u32);
3637
3638                 // If we're past (or at) the FundingSent stage on an outbound channel, try to
3639                 // (re-)broadcast the funding transaction as we may have declined to broadcast it when we
3640                 // first received the funding_signed.
3641                 let mut funding_broadcastable =
3642                         if self.is_outbound() && self.channel_state & !MULTI_STATE_FLAGS >= ChannelState::FundingSent as u32 {
3643                                 self.funding_transaction.take()
3644                         } else { None };
3645                 // That said, if the funding transaction is already confirmed (ie we're active with a
3646                 // minimum_depth over 0) don't bother re-broadcasting the confirmed funding tx.
3647                 if self.channel_state & !MULTI_STATE_FLAGS >= ChannelState::ChannelFunded as u32 && self.minimum_depth != Some(0) {
3648                         funding_broadcastable = None;
3649                 }
3650
3651                 // We will never broadcast the funding transaction when we're in MonitorUpdateFailed (and
3652                 // we assume the user never directly broadcasts the funding transaction and waits for us to
3653                 // do it). Thus, we can only ever hit monitor_pending_channel_ready when we're
3654                 // * an inbound channel that failed to persist the monitor on funding_created and we got
3655                 //   the funding transaction confirmed before the monitor was persisted, or
3656                 // * a 0-conf channel and intended to send the channel_ready before any broadcast at all.
3657                 let channel_ready = if self.monitor_pending_channel_ready {
3658                         assert!(!self.is_outbound() || self.minimum_depth == Some(0),
3659                                 "Funding transaction broadcast by the local client before it should have - LDK didn't do it!");
3660                         self.monitor_pending_channel_ready = false;
3661                         let next_per_commitment_point = self.holder_signer.get_per_commitment_point(self.cur_holder_commitment_transaction_number, &self.secp_ctx);
3662                         Some(msgs::ChannelReady {
3663                                 channel_id: self.channel_id(),
3664                                 next_per_commitment_point,
3665                                 short_channel_id_alias: Some(self.outbound_scid_alias),
3666                         })
3667                 } else { None };
3668
3669                 let announcement_sigs = self.get_announcement_sigs(node_pk, genesis_block_hash, best_block_height, logger);
3670
3671                 let mut accepted_htlcs = Vec::new();
3672                 mem::swap(&mut accepted_htlcs, &mut self.monitor_pending_forwards);
3673                 let mut failed_htlcs = Vec::new();
3674                 mem::swap(&mut failed_htlcs, &mut self.monitor_pending_failures);
3675                 let mut finalized_claimed_htlcs = Vec::new();
3676                 mem::swap(&mut finalized_claimed_htlcs, &mut self.monitor_pending_finalized_fulfills);
3677
3678                 if self.channel_state & (ChannelState::PeerDisconnected as u32) != 0 {
3679                         self.monitor_pending_revoke_and_ack = false;
3680                         self.monitor_pending_commitment_signed = false;
3681                         return MonitorRestoreUpdates {
3682                                 raa: None, commitment_update: None, order: RAACommitmentOrder::RevokeAndACKFirst,
3683                                 accepted_htlcs, failed_htlcs, finalized_claimed_htlcs, funding_broadcastable, channel_ready, announcement_sigs
3684                         };
3685                 }
3686
3687                 let raa = if self.monitor_pending_revoke_and_ack {
3688                         Some(self.get_last_revoke_and_ack())
3689                 } else { None };
3690                 let commitment_update = if self.monitor_pending_commitment_signed {
3691                         Some(self.get_last_commitment_update(logger))
3692                 } else { None };
3693
3694                 self.monitor_pending_revoke_and_ack = false;
3695                 self.monitor_pending_commitment_signed = false;
3696                 let order = self.resend_order.clone();
3697                 log_debug!(logger, "Restored monitor updating in channel {} resulting in {}{} commitment update and {} RAA, with {} first",
3698                         log_bytes!(self.channel_id()), if funding_broadcastable.is_some() { "a funding broadcastable, " } else { "" },
3699                         if commitment_update.is_some() { "a" } else { "no" }, if raa.is_some() { "an" } else { "no" },
3700                         match order { RAACommitmentOrder::CommitmentFirst => "commitment", RAACommitmentOrder::RevokeAndACKFirst => "RAA"});
3701                 MonitorRestoreUpdates {
3702                         raa, commitment_update, order, accepted_htlcs, failed_htlcs, finalized_claimed_htlcs, funding_broadcastable, channel_ready, announcement_sigs
3703                 }
3704         }
3705
3706         pub fn update_fee<F: Deref>(&mut self, fee_estimator: &LowerBoundedFeeEstimator<F>, msg: &msgs::UpdateFee) -> Result<(), ChannelError>
3707                 where F::Target: FeeEstimator
3708         {
3709                 if self.is_outbound() {
3710                         return Err(ChannelError::Close("Non-funding remote tried to update channel fee".to_owned()));
3711                 }
3712                 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
3713                         return Err(ChannelError::Close("Peer sent update_fee when we needed a channel_reestablish".to_owned()));
3714                 }
3715                 Channel::<Signer>::check_remote_fee(fee_estimator, msg.feerate_per_kw)?;
3716                 let feerate_over_dust_buffer = msg.feerate_per_kw > self.get_dust_buffer_feerate(None);
3717
3718                 self.pending_update_fee = Some((msg.feerate_per_kw, FeeUpdateState::RemoteAnnounced));
3719                 self.update_time_counter += 1;
3720                 // If the feerate has increased over the previous dust buffer (note that
3721                 // `get_dust_buffer_feerate` considers the `pending_update_fee` status), check that we
3722                 // won't be pushed over our dust exposure limit by the feerate increase.
3723                 if feerate_over_dust_buffer {
3724                         let inbound_stats = self.get_inbound_pending_htlc_stats(None);
3725                         let outbound_stats = self.get_outbound_pending_htlc_stats(None);
3726                         let holder_tx_dust_exposure = inbound_stats.on_holder_tx_dust_exposure_msat + outbound_stats.on_holder_tx_dust_exposure_msat;
3727                         let counterparty_tx_dust_exposure = inbound_stats.on_counterparty_tx_dust_exposure_msat + outbound_stats.on_counterparty_tx_dust_exposure_msat;
3728                         if holder_tx_dust_exposure > self.get_max_dust_htlc_exposure_msat() {
3729                                 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)",
3730                                         msg.feerate_per_kw, holder_tx_dust_exposure)));
3731                         }
3732                         if counterparty_tx_dust_exposure > self.get_max_dust_htlc_exposure_msat() {
3733                                 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)",
3734                                         msg.feerate_per_kw, counterparty_tx_dust_exposure)));
3735                         }
3736                 }
3737                 Ok(())
3738         }
3739
3740         fn get_last_revoke_and_ack(&self) -> msgs::RevokeAndACK {
3741                 let next_per_commitment_point = self.holder_signer.get_per_commitment_point(self.cur_holder_commitment_transaction_number, &self.secp_ctx);
3742                 let per_commitment_secret = self.holder_signer.release_commitment_secret(self.cur_holder_commitment_transaction_number + 2);
3743                 msgs::RevokeAndACK {
3744                         channel_id: self.channel_id,
3745                         per_commitment_secret,
3746                         next_per_commitment_point,
3747                 }
3748         }
3749
3750         fn get_last_commitment_update<L: Deref>(&self, logger: &L) -> msgs::CommitmentUpdate where L::Target: Logger {
3751                 let mut update_add_htlcs = Vec::new();
3752                 let mut update_fulfill_htlcs = Vec::new();
3753                 let mut update_fail_htlcs = Vec::new();
3754                 let mut update_fail_malformed_htlcs = Vec::new();
3755
3756                 for htlc in self.pending_outbound_htlcs.iter() {
3757                         if let &OutboundHTLCState::LocalAnnounced(ref onion_packet) = &htlc.state {
3758                                 update_add_htlcs.push(msgs::UpdateAddHTLC {
3759                                         channel_id: self.channel_id(),
3760                                         htlc_id: htlc.htlc_id,
3761                                         amount_msat: htlc.amount_msat,
3762                                         payment_hash: htlc.payment_hash,
3763                                         cltv_expiry: htlc.cltv_expiry,
3764                                         onion_routing_packet: (**onion_packet).clone(),
3765                                 });
3766                         }
3767                 }
3768
3769                 for htlc in self.pending_inbound_htlcs.iter() {
3770                         if let &InboundHTLCState::LocalRemoved(ref reason) = &htlc.state {
3771                                 match reason {
3772                                         &InboundHTLCRemovalReason::FailRelay(ref err_packet) => {
3773                                                 update_fail_htlcs.push(msgs::UpdateFailHTLC {
3774                                                         channel_id: self.channel_id(),
3775                                                         htlc_id: htlc.htlc_id,
3776                                                         reason: err_packet.clone()
3777                                                 });
3778                                         },
3779                                         &InboundHTLCRemovalReason::FailMalformed((ref sha256_of_onion, ref failure_code)) => {
3780                                                 update_fail_malformed_htlcs.push(msgs::UpdateFailMalformedHTLC {
3781                                                         channel_id: self.channel_id(),
3782                                                         htlc_id: htlc.htlc_id,
3783                                                         sha256_of_onion: sha256_of_onion.clone(),
3784                                                         failure_code: failure_code.clone(),
3785                                                 });
3786                                         },
3787                                         &InboundHTLCRemovalReason::Fulfill(ref payment_preimage) => {
3788                                                 update_fulfill_htlcs.push(msgs::UpdateFulfillHTLC {
3789                                                         channel_id: self.channel_id(),
3790                                                         htlc_id: htlc.htlc_id,
3791                                                         payment_preimage: payment_preimage.clone(),
3792                                                 });
3793                                         },
3794                                 }
3795                         }
3796                 }
3797
3798                 let update_fee = if self.is_outbound() && self.pending_update_fee.is_some() {
3799                         Some(msgs::UpdateFee {
3800                                 channel_id: self.channel_id(),
3801                                 feerate_per_kw: self.pending_update_fee.unwrap().0,
3802                         })
3803                 } else { None };
3804
3805                 log_trace!(logger, "Regenerated latest commitment update in channel {} with{} {} update_adds, {} update_fulfills, {} update_fails, and {} update_fail_malformeds",
3806                                 log_bytes!(self.channel_id()), if update_fee.is_some() { " update_fee," } else { "" },
3807                                 update_add_htlcs.len(), update_fulfill_htlcs.len(), update_fail_htlcs.len(), update_fail_malformed_htlcs.len());
3808                 msgs::CommitmentUpdate {
3809                         update_add_htlcs, update_fulfill_htlcs, update_fail_htlcs, update_fail_malformed_htlcs, update_fee,
3810                         commitment_signed: self.send_commitment_no_state_update(logger).expect("It looks like we failed to re-generate a commitment_signed we had previously sent?").0,
3811                 }
3812         }
3813
3814         /// May panic if some calls other than message-handling calls (which will all Err immediately)
3815         /// have been called between remove_uncommitted_htlcs_and_mark_paused and this call.
3816         ///
3817         /// Some links printed in log lines are included here to check them during build (when run with
3818         /// `cargo doc --document-private-items`):
3819         /// [`super::channelmanager::ChannelManager::force_close_without_broadcasting_txn`] and
3820         /// [`super::channelmanager::ChannelManager::force_close_all_channels_without_broadcasting_txn`].
3821         pub fn channel_reestablish<L: Deref>(&mut self, msg: &msgs::ChannelReestablish, logger: &L,
3822                 node_pk: PublicKey, genesis_block_hash: BlockHash, best_block: &BestBlock)
3823         -> Result<ReestablishResponses, ChannelError> where L::Target: Logger {
3824                 if self.channel_state & (ChannelState::PeerDisconnected as u32) == 0 {
3825                         // While BOLT 2 doesn't indicate explicitly we should error this channel here, it
3826                         // almost certainly indicates we are going to end up out-of-sync in some way, so we
3827                         // just close here instead of trying to recover.
3828                         return Err(ChannelError::Close("Peer sent a loose channel_reestablish not after reconnect".to_owned()));
3829                 }
3830
3831                 if msg.next_local_commitment_number >= INITIAL_COMMITMENT_NUMBER || msg.next_remote_commitment_number >= INITIAL_COMMITMENT_NUMBER ||
3832                         msg.next_local_commitment_number == 0 {
3833                         return Err(ChannelError::Close("Peer sent a garbage channel_reestablish".to_owned()));
3834                 }
3835
3836                 if msg.next_remote_commitment_number > 0 {
3837                         match msg.data_loss_protect {
3838                                 OptionalField::Present(ref data_loss) => {
3839                                         let expected_point = self.holder_signer.get_per_commitment_point(INITIAL_COMMITMENT_NUMBER - msg.next_remote_commitment_number + 1, &self.secp_ctx);
3840                                         let given_secret = SecretKey::from_slice(&data_loss.your_last_per_commitment_secret)
3841                                                 .map_err(|_| ChannelError::Close("Peer sent a garbage channel_reestablish with unparseable secret key".to_owned()))?;
3842                                         if expected_point != PublicKey::from_secret_key(&self.secp_ctx, &given_secret) {
3843                                                 return Err(ChannelError::Close("Peer sent a garbage channel_reestablish with secret key not matching the commitment height provided".to_owned()));
3844                                         }
3845                                         if msg.next_remote_commitment_number > INITIAL_COMMITMENT_NUMBER - self.cur_holder_commitment_transaction_number {
3846                                                 macro_rules! log_and_panic {
3847                                                         ($err_msg: expr) => {
3848                                                                 log_error!(logger, $err_msg, log_bytes!(self.channel_id), log_pubkey!(self.counterparty_node_id));
3849                                                                 panic!($err_msg, log_bytes!(self.channel_id), log_pubkey!(self.counterparty_node_id));
3850                                                         }
3851                                                 }
3852                                                 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\
3853                                                         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\
3854                                                         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\
3855                                                         If you have restored from an old backup and wish to force-close channels and return to operation, you should start up, call\n\
3856                                                         ChannelManager::force_close_without_broadcasting_txn on channel {} with counterparty {} or\n\
3857                                                         ChannelManager::force_close_all_channels_without_broadcasting_txn, then reconnect to peer(s).\n\
3858                                                         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\
3859                                                         See https://github.com/lightningdevkit/rust-lightning/issues/1565 for more info.");
3860                                         }
3861                                 },
3862                                 OptionalField::Absent => {}
3863                         }
3864                 }
3865
3866                 // Before we change the state of the channel, we check if the peer is sending a very old
3867                 // commitment transaction number, if yes we send a warning message.
3868                 let our_commitment_transaction = INITIAL_COMMITMENT_NUMBER - self.cur_holder_commitment_transaction_number - 1;
3869                 if  msg.next_remote_commitment_number + 1 < our_commitment_transaction {
3870                         return Err(
3871                                 ChannelError::Warn(format!("Peer attempted to reestablish channel with a very old local commitment transaction: {} (received) vs {} (expected)", msg.next_remote_commitment_number, our_commitment_transaction))
3872                         );
3873                 }
3874
3875                 // Go ahead and unmark PeerDisconnected as various calls we may make check for it (and all
3876                 // remaining cases either succeed or ErrorMessage-fail).
3877                 self.channel_state &= !(ChannelState::PeerDisconnected as u32);
3878
3879                 let shutdown_msg = if self.channel_state & (ChannelState::LocalShutdownSent as u32) != 0 {
3880                         assert!(self.shutdown_scriptpubkey.is_some());
3881                         Some(msgs::Shutdown {
3882                                 channel_id: self.channel_id,
3883                                 scriptpubkey: self.get_closing_scriptpubkey(),
3884                         })
3885                 } else { None };
3886
3887                 let announcement_sigs = self.get_announcement_sigs(node_pk, genesis_block_hash, best_block.height(), logger);
3888
3889                 if self.channel_state & (ChannelState::FundingSent as u32) == ChannelState::FundingSent as u32 {
3890                         // If we're waiting on a monitor update, we shouldn't re-send any channel_ready's.
3891                         if self.channel_state & (ChannelState::OurChannelReady as u32) == 0 ||
3892                                         self.channel_state & (ChannelState::MonitorUpdateFailed as u32) != 0 {
3893                                 if msg.next_remote_commitment_number != 0 {
3894                                         return Err(ChannelError::Close("Peer claimed they saw a revoke_and_ack but we haven't sent channel_ready yet".to_owned()));
3895                                 }
3896                                 // Short circuit the whole handler as there is nothing we can resend them
3897                                 return Ok(ReestablishResponses {
3898                                         channel_ready: None,
3899                                         raa: None, commitment_update: None, mon_update: None,
3900                                         order: RAACommitmentOrder::CommitmentFirst,
3901                                         holding_cell_failed_htlcs: Vec::new(),
3902                                         shutdown_msg, announcement_sigs,
3903                                 });
3904                         }
3905
3906                         // We have OurChannelReady set!
3907                         let next_per_commitment_point = self.holder_signer.get_per_commitment_point(self.cur_holder_commitment_transaction_number, &self.secp_ctx);
3908                         return Ok(ReestablishResponses {
3909                                 channel_ready: Some(msgs::ChannelReady {
3910                                         channel_id: self.channel_id(),
3911                                         next_per_commitment_point,
3912                                         short_channel_id_alias: Some(self.outbound_scid_alias),
3913                                 }),
3914                                 raa: None, commitment_update: None, mon_update: None,
3915                                 order: RAACommitmentOrder::CommitmentFirst,
3916                                 holding_cell_failed_htlcs: Vec::new(),
3917                                 shutdown_msg, announcement_sigs,
3918                         });
3919                 }
3920
3921                 let required_revoke = if msg.next_remote_commitment_number + 1 == INITIAL_COMMITMENT_NUMBER - self.cur_holder_commitment_transaction_number {
3922                         // Remote isn't waiting on any RevokeAndACK from us!
3923                         // Note that if we need to repeat our ChannelReady we'll do that in the next if block.
3924                         None
3925                 } else if msg.next_remote_commitment_number + 1 == (INITIAL_COMMITMENT_NUMBER - 1) - self.cur_holder_commitment_transaction_number {
3926                         if self.channel_state & (ChannelState::MonitorUpdateFailed as u32) != 0 {
3927                                 self.monitor_pending_revoke_and_ack = true;
3928                                 None
3929                         } else {
3930                                 Some(self.get_last_revoke_and_ack())
3931                         }
3932                 } else {
3933                         return Err(ChannelError::Close("Peer attempted to reestablish channel with a very old local commitment transaction".to_owned()));
3934                 };
3935
3936                 // We increment cur_counterparty_commitment_transaction_number only upon receipt of
3937                 // revoke_and_ack, not on sending commitment_signed, so we add one if have
3938                 // AwaitingRemoteRevoke set, which indicates we sent a commitment_signed but haven't gotten
3939                 // the corresponding revoke_and_ack back yet.
3940                 let next_counterparty_commitment_number = INITIAL_COMMITMENT_NUMBER - self.cur_counterparty_commitment_transaction_number + if (self.channel_state & ChannelState::AwaitingRemoteRevoke as u32) != 0 { 1 } else { 0 };
3941
3942                 let channel_ready = if msg.next_local_commitment_number == 1 && INITIAL_COMMITMENT_NUMBER - self.cur_holder_commitment_transaction_number == 1 {
3943                         // We should never have to worry about MonitorUpdateFailed resending ChannelReady
3944                         let next_per_commitment_point = self.holder_signer.get_per_commitment_point(self.cur_holder_commitment_transaction_number, &self.secp_ctx);
3945                         Some(msgs::ChannelReady {
3946                                 channel_id: self.channel_id(),
3947                                 next_per_commitment_point,
3948                                 short_channel_id_alias: Some(self.outbound_scid_alias),
3949                         })
3950                 } else { None };
3951
3952                 if msg.next_local_commitment_number == next_counterparty_commitment_number {
3953                         if required_revoke.is_some() {
3954                                 log_debug!(logger, "Reconnected channel {} with only lost outbound RAA", log_bytes!(self.channel_id()));
3955                         } else {
3956                                 log_debug!(logger, "Reconnected channel {} with no loss", log_bytes!(self.channel_id()));
3957                         }
3958
3959                         if (self.channel_state & (ChannelState::AwaitingRemoteRevoke as u32 | ChannelState::MonitorUpdateFailed as u32)) == 0 {
3960                                 // We're up-to-date and not waiting on a remote revoke (if we are our
3961                                 // channel_reestablish should result in them sending a revoke_and_ack), but we may
3962                                 // have received some updates while we were disconnected. Free the holding cell
3963                                 // now!
3964                                 match self.free_holding_cell_htlcs(logger) {
3965                                         Err(ChannelError::Close(msg)) => Err(ChannelError::Close(msg)),
3966                                         Err(ChannelError::Warn(_)) | Err(ChannelError::Ignore(_)) =>
3967                                                 panic!("Got non-channel-failing result from free_holding_cell_htlcs"),
3968                                         Ok((Some((commitment_update, monitor_update)), holding_cell_failed_htlcs)) => {
3969                                                 Ok(ReestablishResponses {
3970                                                         channel_ready, shutdown_msg, announcement_sigs,
3971                                                         raa: required_revoke,
3972                                                         commitment_update: Some(commitment_update),
3973                                                         order: self.resend_order.clone(),
3974                                                         mon_update: Some(monitor_update),
3975                                                         holding_cell_failed_htlcs,
3976                                                 })
3977                                         },
3978                                         Ok((None, holding_cell_failed_htlcs)) => {
3979                                                 Ok(ReestablishResponses {
3980                                                         channel_ready, shutdown_msg, announcement_sigs,
3981                                                         raa: required_revoke,
3982                                                         commitment_update: None,
3983                                                         order: self.resend_order.clone(),
3984                                                         mon_update: None,
3985                                                         holding_cell_failed_htlcs,
3986                                                 })
3987                                         },
3988                                 }
3989                         } else {
3990                                 Ok(ReestablishResponses {
3991                                         channel_ready, shutdown_msg, announcement_sigs,
3992                                         raa: required_revoke,
3993                                         commitment_update: None,
3994                                         order: self.resend_order.clone(),
3995                                         mon_update: None,
3996                                         holding_cell_failed_htlcs: Vec::new(),
3997                                 })
3998                         }
3999                 } else if msg.next_local_commitment_number == next_counterparty_commitment_number - 1 {
4000                         if required_revoke.is_some() {
4001                                 log_debug!(logger, "Reconnected channel {} with lost outbound RAA and lost remote commitment tx", log_bytes!(self.channel_id()));
4002                         } else {
4003                                 log_debug!(logger, "Reconnected channel {} with only lost remote commitment tx", log_bytes!(self.channel_id()));
4004                         }
4005
4006                         if self.channel_state & (ChannelState::MonitorUpdateFailed as u32) != 0 {
4007                                 self.monitor_pending_commitment_signed = true;
4008                                 Ok(ReestablishResponses {
4009                                         channel_ready, shutdown_msg, announcement_sigs,
4010                                         commitment_update: None, raa: None, mon_update: None,
4011                                         order: self.resend_order.clone(),
4012                                         holding_cell_failed_htlcs: Vec::new(),
4013                                 })
4014                         } else {
4015                                 Ok(ReestablishResponses {
4016                                         channel_ready, shutdown_msg, announcement_sigs,
4017                                         raa: required_revoke,
4018                                         commitment_update: Some(self.get_last_commitment_update(logger)),
4019                                         order: self.resend_order.clone(),
4020                                         mon_update: None,
4021                                         holding_cell_failed_htlcs: Vec::new(),
4022                                 })
4023                         }
4024                 } else {
4025                         Err(ChannelError::Close("Peer attempted to reestablish channel with a very old remote commitment transaction".to_owned()))
4026                 }
4027         }
4028
4029         /// Calculates and returns our minimum and maximum closing transaction fee amounts, in whole
4030         /// satoshis. The amounts remain consistent unless a peer disconnects/reconnects or we restart,
4031         /// at which point they will be recalculated.
4032         fn calculate_closing_fee_limits<F: Deref>(&mut self, fee_estimator: &LowerBoundedFeeEstimator<F>)
4033                 -> (u64, u64)
4034                 where F::Target: FeeEstimator
4035         {
4036                 if let Some((min, max)) = self.closing_fee_limits { return (min, max); }
4037
4038                 // Propose a range from our current Background feerate to our Normal feerate plus our
4039                 // force_close_avoidance_max_fee_satoshis.
4040                 // If we fail to come to consensus, we'll have to force-close.
4041                 let mut proposed_feerate = fee_estimator.bounded_sat_per_1000_weight(ConfirmationTarget::Background);
4042                 let normal_feerate = fee_estimator.bounded_sat_per_1000_weight(ConfirmationTarget::Normal);
4043                 let mut proposed_max_feerate = if self.is_outbound() { normal_feerate } else { u32::max_value() };
4044
4045                 // The spec requires that (when the channel does not have anchors) we only send absolute
4046                 // channel fees no greater than the absolute channel fee on the current commitment
4047                 // transaction. It's unclear *which* commitment transaction this refers to, and there isn't
4048                 // very good reason to apply such a limit in any case. We don't bother doing so, risking
4049                 // some force-closure by old nodes, but we wanted to close the channel anyway.
4050
4051                 if let Some(target_feerate) = self.target_closing_feerate_sats_per_kw {
4052                         let min_feerate = if self.is_outbound() { target_feerate } else { cmp::min(self.feerate_per_kw, target_feerate) };
4053                         proposed_feerate = cmp::max(proposed_feerate, min_feerate);
4054                         proposed_max_feerate = cmp::max(proposed_max_feerate, min_feerate);
4055                 }
4056
4057                 // Note that technically we could end up with a lower minimum fee if one sides' balance is
4058                 // below our dust limit, causing the output to disappear. We don't bother handling this
4059                 // case, however, as this should only happen if a channel is closed before any (material)
4060                 // payments have been made on it. This may cause slight fee overpayment and/or failure to
4061                 // come to consensus with our counterparty on appropriate fees, however it should be a
4062                 // relatively rare case. We can revisit this later, though note that in order to determine
4063                 // if the funders' output is dust we have to know the absolute fee we're going to use.
4064                 let tx_weight = self.get_closing_transaction_weight(Some(&self.get_closing_scriptpubkey()), Some(self.counterparty_shutdown_scriptpubkey.as_ref().unwrap()));
4065                 let proposed_total_fee_satoshis = proposed_feerate as u64 * tx_weight / 1000;
4066                 let proposed_max_total_fee_satoshis = if self.is_outbound() {
4067                                 // We always add force_close_avoidance_max_fee_satoshis to our normal
4068                                 // feerate-calculated fee, but allow the max to be overridden if we're using a
4069                                 // target feerate-calculated fee.
4070                                 cmp::max(normal_feerate as u64 * tx_weight / 1000 + self.config.options.force_close_avoidance_max_fee_satoshis,
4071                                         proposed_max_feerate as u64 * tx_weight / 1000)
4072                         } else {
4073                                 self.channel_value_satoshis - (self.value_to_self_msat + 999) / 1000
4074                         };
4075
4076                 self.closing_fee_limits = Some((proposed_total_fee_satoshis, proposed_max_total_fee_satoshis));
4077                 self.closing_fee_limits.clone().unwrap()
4078         }
4079
4080         /// Returns true if we're ready to commence the closing_signed negotiation phase. This is true
4081         /// after both sides have exchanged a `shutdown` message and all HTLCs have been drained. At
4082         /// this point if we're the funder we should send the initial closing_signed, and in any case
4083         /// shutdown should complete within a reasonable timeframe.
4084         fn closing_negotiation_ready(&self) -> bool {
4085                 self.pending_inbound_htlcs.is_empty() && self.pending_outbound_htlcs.is_empty() &&
4086                         self.channel_state &
4087                                 (BOTH_SIDES_SHUTDOWN_MASK | ChannelState::AwaitingRemoteRevoke as u32 |
4088                                  ChannelState::PeerDisconnected as u32 | ChannelState::MonitorUpdateFailed as u32)
4089                                 == BOTH_SIDES_SHUTDOWN_MASK &&
4090                         self.pending_update_fee.is_none()
4091         }
4092
4093         /// Checks if the closing_signed negotiation is making appropriate progress, possibly returning
4094         /// an Err if no progress is being made and the channel should be force-closed instead.
4095         /// Should be called on a one-minute timer.
4096         pub fn timer_check_closing_negotiation_progress(&mut self) -> Result<(), ChannelError> {
4097                 if self.closing_negotiation_ready() {
4098                         if self.closing_signed_in_flight {
4099                                 return Err(ChannelError::Close("closing_signed negotiation failed to finish within two timer ticks".to_owned()));
4100                         } else {
4101                                 self.closing_signed_in_flight = true;
4102                         }
4103                 }
4104                 Ok(())
4105         }
4106
4107         pub fn maybe_propose_closing_signed<F: Deref, L: Deref>(
4108                 &mut self, fee_estimator: &LowerBoundedFeeEstimator<F>, logger: &L)
4109                 -> Result<(Option<msgs::ClosingSigned>, Option<Transaction>), ChannelError>
4110                 where F::Target: FeeEstimator, L::Target: Logger
4111         {
4112                 if self.last_sent_closing_fee.is_some() || !self.closing_negotiation_ready() {
4113                         return Ok((None, None));
4114                 }
4115
4116                 if !self.is_outbound() {
4117                         if let Some(msg) = &self.pending_counterparty_closing_signed.take() {
4118                                 return self.closing_signed(fee_estimator, &msg);
4119                         }
4120                         return Ok((None, None));
4121                 }
4122
4123                 let (our_min_fee, our_max_fee) = self.calculate_closing_fee_limits(fee_estimator);
4124
4125                 assert!(self.shutdown_scriptpubkey.is_some());
4126                 let (closing_tx, total_fee_satoshis) = self.build_closing_transaction(our_min_fee, false);
4127                 log_trace!(logger, "Proposing initial closing_signed for our counterparty with a fee range of {}-{} sat (with initial proposal {} sats)",
4128                         our_min_fee, our_max_fee, total_fee_satoshis);
4129
4130                 let sig = self.holder_signer
4131                         .sign_closing_transaction(&closing_tx, &self.secp_ctx)
4132                         .map_err(|()| ChannelError::Close("Failed to get signature for closing transaction.".to_owned()))?;
4133
4134                 self.last_sent_closing_fee = Some((total_fee_satoshis, sig.clone()));
4135                 Ok((Some(msgs::ClosingSigned {
4136                         channel_id: self.channel_id,
4137                         fee_satoshis: total_fee_satoshis,
4138                         signature: sig,
4139                         fee_range: Some(msgs::ClosingSignedFeeRange {
4140                                 min_fee_satoshis: our_min_fee,
4141                                 max_fee_satoshis: our_max_fee,
4142                         }),
4143                 }), None))
4144         }
4145
4146         pub fn shutdown<K: Deref>(
4147                 &mut self, keys_provider: &K, their_features: &InitFeatures, msg: &msgs::Shutdown
4148         ) -> Result<(Option<msgs::Shutdown>, Option<ChannelMonitorUpdate>, Vec<(HTLCSource, PaymentHash)>), ChannelError>
4149         where K::Target: KeysInterface<Signer = Signer>
4150         {
4151                 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
4152                         return Err(ChannelError::Close("Peer sent shutdown when we needed a channel_reestablish".to_owned()));
4153                 }
4154                 if self.channel_state < ChannelState::FundingSent as u32 {
4155                         // Spec says we should fail the connection, not the channel, but that's nonsense, there
4156                         // are plenty of reasons you may want to fail a channel pre-funding, and spec says you
4157                         // can do that via error message without getting a connection fail anyway...
4158                         return Err(ChannelError::Close("Peer sent shutdown pre-funding generation".to_owned()));
4159                 }
4160                 for htlc in self.pending_inbound_htlcs.iter() {
4161                         if let InboundHTLCState::RemoteAnnounced(_) = htlc.state {
4162                                 return Err(ChannelError::Close("Got shutdown with remote pending HTLCs".to_owned()));
4163                         }
4164                 }
4165                 assert_eq!(self.channel_state & ChannelState::ShutdownComplete as u32, 0);
4166
4167                 if !script::is_bolt2_compliant(&msg.scriptpubkey, their_features) {
4168                         return Err(ChannelError::Warn(format!("Got a nonstandard scriptpubkey ({}) from remote peer", msg.scriptpubkey.to_bytes().to_hex())));
4169                 }
4170
4171                 if self.counterparty_shutdown_scriptpubkey.is_some() {
4172                         if Some(&msg.scriptpubkey) != self.counterparty_shutdown_scriptpubkey.as_ref() {
4173                                 return Err(ChannelError::Warn(format!("Got shutdown request with a scriptpubkey ({}) which did not match their previous scriptpubkey.", msg.scriptpubkey.to_bytes().to_hex())));
4174                         }
4175                 } else {
4176                         self.counterparty_shutdown_scriptpubkey = Some(msg.scriptpubkey.clone());
4177                 }
4178
4179                 // If we have any LocalAnnounced updates we'll probably just get back an update_fail_htlc
4180                 // immediately after the commitment dance, but we can send a Shutdown because we won't send
4181                 // any further commitment updates after we set LocalShutdownSent.
4182                 let send_shutdown = (self.channel_state & ChannelState::LocalShutdownSent as u32) != ChannelState::LocalShutdownSent as u32;
4183
4184                 let update_shutdown_script = match self.shutdown_scriptpubkey {
4185                         Some(_) => false,
4186                         None => {
4187                                 assert!(send_shutdown);
4188                                 let shutdown_scriptpubkey = keys_provider.get_shutdown_scriptpubkey();
4189                                 if !shutdown_scriptpubkey.is_compatible(their_features) {
4190                                         return Err(ChannelError::Close(format!("Provided a scriptpubkey format not accepted by peer: {}", shutdown_scriptpubkey)));
4191                                 }
4192                                 self.shutdown_scriptpubkey = Some(shutdown_scriptpubkey);
4193                                 true
4194                         },
4195                 };
4196
4197                 // From here on out, we may not fail!
4198
4199                 self.channel_state |= ChannelState::RemoteShutdownSent as u32;
4200                 self.update_time_counter += 1;
4201
4202                 let monitor_update = if update_shutdown_script {
4203                         self.latest_monitor_update_id += 1;
4204                         Some(ChannelMonitorUpdate {
4205                                 update_id: self.latest_monitor_update_id,
4206                                 updates: vec![ChannelMonitorUpdateStep::ShutdownScript {
4207                                         scriptpubkey: self.get_closing_scriptpubkey(),
4208                                 }],
4209                         })
4210                 } else { None };
4211                 let shutdown = if send_shutdown {
4212                         Some(msgs::Shutdown {
4213                                 channel_id: self.channel_id,
4214                                 scriptpubkey: self.get_closing_scriptpubkey(),
4215                         })
4216                 } else { None };
4217
4218                 // We can't send our shutdown until we've committed all of our pending HTLCs, but the
4219                 // remote side is unlikely to accept any new HTLCs, so we go ahead and "free" any holding
4220                 // cell HTLCs and return them to fail the payment.
4221                 self.holding_cell_update_fee = None;
4222                 let mut dropped_outbound_htlcs = Vec::with_capacity(self.holding_cell_htlc_updates.len());
4223                 self.holding_cell_htlc_updates.retain(|htlc_update| {
4224                         match htlc_update {
4225                                 &HTLCUpdateAwaitingACK::AddHTLC { ref payment_hash, ref source, .. } => {
4226                                         dropped_outbound_htlcs.push((source.clone(), payment_hash.clone()));
4227                                         false
4228                                 },
4229                                 _ => true
4230                         }
4231                 });
4232
4233                 self.channel_state |= ChannelState::LocalShutdownSent as u32;
4234                 self.update_time_counter += 1;
4235
4236                 Ok((shutdown, monitor_update, dropped_outbound_htlcs))
4237         }
4238
4239         fn build_signed_closing_transaction(&self, closing_tx: &ClosingTransaction, counterparty_sig: &Signature, sig: &Signature) -> Transaction {
4240                 let mut tx = closing_tx.trust().built_transaction().clone();
4241
4242                 tx.input[0].witness.push(Vec::new()); // First is the multisig dummy
4243
4244                 let funding_key = self.get_holder_pubkeys().funding_pubkey.serialize();
4245                 let counterparty_funding_key = self.counterparty_funding_pubkey().serialize();
4246                 let mut holder_sig = sig.serialize_der().to_vec();
4247                 holder_sig.push(EcdsaSighashType::All as u8);
4248                 let mut cp_sig = counterparty_sig.serialize_der().to_vec();
4249                 cp_sig.push(EcdsaSighashType::All as u8);
4250                 if funding_key[..] < counterparty_funding_key[..] {
4251                         tx.input[0].witness.push(holder_sig);
4252                         tx.input[0].witness.push(cp_sig);
4253                 } else {
4254                         tx.input[0].witness.push(cp_sig);
4255                         tx.input[0].witness.push(holder_sig);
4256                 }
4257
4258                 tx.input[0].witness.push(self.get_funding_redeemscript().into_bytes());
4259                 tx
4260         }
4261
4262         pub fn closing_signed<F: Deref>(
4263                 &mut self, fee_estimator: &LowerBoundedFeeEstimator<F>, msg: &msgs::ClosingSigned)
4264                 -> Result<(Option<msgs::ClosingSigned>, Option<Transaction>), ChannelError>
4265                 where F::Target: FeeEstimator
4266         {
4267                 if self.channel_state & BOTH_SIDES_SHUTDOWN_MASK != BOTH_SIDES_SHUTDOWN_MASK {
4268                         return Err(ChannelError::Close("Remote end sent us a closing_signed before both sides provided a shutdown".to_owned()));
4269                 }
4270                 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
4271                         return Err(ChannelError::Close("Peer sent closing_signed when we needed a channel_reestablish".to_owned()));
4272                 }
4273                 if !self.pending_inbound_htlcs.is_empty() || !self.pending_outbound_htlcs.is_empty() {
4274                         return Err(ChannelError::Close("Remote end sent us a closing_signed while there were still pending HTLCs".to_owned()));
4275                 }
4276                 if msg.fee_satoshis > TOTAL_BITCOIN_SUPPLY_SATOSHIS { // this is required to stop potential overflow in build_closing_transaction
4277                         return Err(ChannelError::Close("Remote tried to send us a closing tx with > 21 million BTC fee".to_owned()));
4278                 }
4279
4280                 if self.is_outbound() && self.last_sent_closing_fee.is_none() {
4281                         return Err(ChannelError::Close("Remote tried to send a closing_signed when we were supposed to propose the first one".to_owned()));
4282                 }
4283
4284                 if self.channel_state & ChannelState::MonitorUpdateFailed as u32 != 0 {
4285                         self.pending_counterparty_closing_signed = Some(msg.clone());
4286                         return Ok((None, None));
4287                 }
4288
4289                 let funding_redeemscript = self.get_funding_redeemscript();
4290                 let (mut closing_tx, used_total_fee) = self.build_closing_transaction(msg.fee_satoshis, false);
4291                 if used_total_fee != msg.fee_satoshis {
4292                         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)));
4293                 }
4294                 let sighash = closing_tx.trust().get_sighash_all(&funding_redeemscript, self.channel_value_satoshis);
4295
4296                 match self.secp_ctx.verify_ecdsa(&sighash, &msg.signature, &self.get_counterparty_pubkeys().funding_pubkey) {
4297                         Ok(_) => {},
4298                         Err(_e) => {
4299                                 // The remote end may have decided to revoke their output due to inconsistent dust
4300                                 // limits, so check for that case by re-checking the signature here.
4301                                 closing_tx = self.build_closing_transaction(msg.fee_satoshis, true).0;
4302                                 let sighash = closing_tx.trust().get_sighash_all(&funding_redeemscript, self.channel_value_satoshis);
4303                                 secp_check!(self.secp_ctx.verify_ecdsa(&sighash, &msg.signature, self.counterparty_funding_pubkey()), "Invalid closing tx signature from peer".to_owned());
4304                         },
4305                 };
4306
4307                 for outp in closing_tx.trust().built_transaction().output.iter() {
4308                         if !outp.script_pubkey.is_witness_program() && outp.value < MAX_STD_OUTPUT_DUST_LIMIT_SATOSHIS {
4309                                 return Err(ChannelError::Close("Remote sent us a closing_signed with a dust output. Always use segwit closing scripts!".to_owned()));
4310                         }
4311                 }
4312
4313                 assert!(self.shutdown_scriptpubkey.is_some());
4314                 if let Some((last_fee, sig)) = self.last_sent_closing_fee {
4315                         if last_fee == msg.fee_satoshis {
4316                                 let tx = self.build_signed_closing_transaction(&mut closing_tx, &msg.signature, &sig);
4317                                 self.channel_state = ChannelState::ShutdownComplete as u32;
4318                                 self.update_time_counter += 1;
4319                                 return Ok((None, Some(tx)));
4320                         }
4321                 }
4322
4323                 let (our_min_fee, our_max_fee) = self.calculate_closing_fee_limits(fee_estimator);
4324
4325                 macro_rules! propose_fee {
4326                         ($new_fee: expr) => {
4327                                 let (closing_tx, used_fee) = if $new_fee == msg.fee_satoshis {
4328                                         (closing_tx, $new_fee)
4329                                 } else {
4330                                         self.build_closing_transaction($new_fee, false)
4331                                 };
4332
4333                                 let sig = self.holder_signer
4334                                         .sign_closing_transaction(&closing_tx, &self.secp_ctx)
4335                                         .map_err(|_| ChannelError::Close("External signer refused to sign closing transaction".to_owned()))?;
4336
4337                                 let signed_tx = if $new_fee == msg.fee_satoshis {
4338                                         self.channel_state = ChannelState::ShutdownComplete as u32;
4339                                         self.update_time_counter += 1;
4340                                         let tx = self.build_signed_closing_transaction(&closing_tx, &msg.signature, &sig);
4341                                         Some(tx)
4342                                 } else { None };
4343
4344                                 self.last_sent_closing_fee = Some((used_fee, sig.clone()));
4345                                 return Ok((Some(msgs::ClosingSigned {
4346                                         channel_id: self.channel_id,
4347                                         fee_satoshis: used_fee,
4348                                         signature: sig,
4349                                         fee_range: Some(msgs::ClosingSignedFeeRange {
4350                                                 min_fee_satoshis: our_min_fee,
4351                                                 max_fee_satoshis: our_max_fee,
4352                                         }),
4353                                 }), signed_tx))
4354                         }
4355                 }
4356
4357                 if let Some(msgs::ClosingSignedFeeRange { min_fee_satoshis, max_fee_satoshis }) = msg.fee_range {
4358                         if msg.fee_satoshis < min_fee_satoshis || msg.fee_satoshis > max_fee_satoshis {
4359                                 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)));
4360                         }
4361                         if max_fee_satoshis < our_min_fee {
4362                                 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)));
4363                         }
4364                         if min_fee_satoshis > our_max_fee {
4365                                 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)));
4366                         }
4367
4368                         if !self.is_outbound() {
4369                                 // They have to pay, so pick the highest fee in the overlapping range.
4370                                 // We should never set an upper bound aside from their full balance
4371                                 debug_assert_eq!(our_max_fee, self.channel_value_satoshis - (self.value_to_self_msat + 999) / 1000);
4372                                 propose_fee!(cmp::min(max_fee_satoshis, our_max_fee));
4373                         } else {
4374                                 if msg.fee_satoshis < our_min_fee || msg.fee_satoshis > our_max_fee {
4375                                         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.",
4376                                                 msg.fee_satoshis, our_min_fee, our_max_fee)));
4377                                 }
4378                                 // The proposed fee is in our acceptable range, accept it and broadcast!
4379                                 propose_fee!(msg.fee_satoshis);
4380                         }
4381                 } else {
4382                         // Old fee style negotiation. We don't bother to enforce whether they are complying
4383                         // with the "making progress" requirements, we just comply and hope for the best.
4384                         if let Some((last_fee, _)) = self.last_sent_closing_fee {
4385                                 if msg.fee_satoshis > last_fee {
4386                                         if msg.fee_satoshis < our_max_fee {
4387                                                 propose_fee!(msg.fee_satoshis);
4388                                         } else if last_fee < our_max_fee {
4389                                                 propose_fee!(our_max_fee);
4390                                         } else {
4391                                                 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)));
4392                                         }
4393                                 } else {
4394                                         if msg.fee_satoshis > our_min_fee {
4395                                                 propose_fee!(msg.fee_satoshis);
4396                                         } else if last_fee > our_min_fee {
4397                                                 propose_fee!(our_min_fee);
4398                                         } else {
4399                                                 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)));
4400                                         }
4401                                 }
4402                         } else {
4403                                 if msg.fee_satoshis < our_min_fee {
4404                                         propose_fee!(our_min_fee);
4405                                 } else if msg.fee_satoshis > our_max_fee {
4406                                         propose_fee!(our_max_fee);
4407                                 } else {
4408                                         propose_fee!(msg.fee_satoshis);
4409                                 }
4410                         }
4411                 }
4412         }
4413
4414         // Public utilities:
4415
4416         pub fn channel_id(&self) -> [u8; 32] {
4417                 self.channel_id
4418         }
4419
4420         pub fn minimum_depth(&self) -> Option<u32> {
4421                 self.minimum_depth
4422         }
4423
4424         /// Gets the "user_id" value passed into the construction of this channel. It has no special
4425         /// meaning and exists only to allow users to have a persistent identifier of a channel.
4426         pub fn get_user_id(&self) -> u64 {
4427                 self.user_id
4428         }
4429
4430         /// Gets the channel's type
4431         pub fn get_channel_type(&self) -> &ChannelTypeFeatures {
4432                 &self.channel_type
4433         }
4434
4435         /// Guaranteed to be Some after both ChannelReady messages have been exchanged (and, thus,
4436         /// is_usable() returns true).
4437         /// Allowed in any state (including after shutdown)
4438         pub fn get_short_channel_id(&self) -> Option<u64> {
4439                 self.short_channel_id
4440         }
4441
4442         /// Allowed in any state (including after shutdown)
4443         pub fn latest_inbound_scid_alias(&self) -> Option<u64> {
4444                 self.latest_inbound_scid_alias
4445         }
4446
4447         /// Allowed in any state (including after shutdown)
4448         pub fn outbound_scid_alias(&self) -> u64 {
4449                 self.outbound_scid_alias
4450         }
4451         /// Only allowed immediately after deserialization if get_outbound_scid_alias returns 0,
4452         /// indicating we were written by LDK prior to 0.0.106 which did not set outbound SCID aliases.
4453         pub fn set_outbound_scid_alias(&mut self, outbound_scid_alias: u64) {
4454                 assert_eq!(self.outbound_scid_alias, 0);
4455                 self.outbound_scid_alias = outbound_scid_alias;
4456         }
4457
4458         /// Returns the funding_txo we either got from our peer, or were given by
4459         /// get_outbound_funding_created.
4460         pub fn get_funding_txo(&self) -> Option<OutPoint> {
4461                 self.channel_transaction_parameters.funding_outpoint
4462         }
4463
4464         fn get_holder_selected_contest_delay(&self) -> u16 {
4465                 self.channel_transaction_parameters.holder_selected_contest_delay
4466         }
4467
4468         fn get_holder_pubkeys(&self) -> &ChannelPublicKeys {
4469                 &self.channel_transaction_parameters.holder_pubkeys
4470         }
4471
4472         pub fn get_counterparty_selected_contest_delay(&self) -> Option<u16> {
4473                 self.channel_transaction_parameters.counterparty_parameters
4474                         .as_ref().map(|params| params.selected_contest_delay)
4475         }
4476
4477         fn get_counterparty_pubkeys(&self) -> &ChannelPublicKeys {
4478                 &self.channel_transaction_parameters.counterparty_parameters.as_ref().unwrap().pubkeys
4479         }
4480
4481         /// Allowed in any state (including after shutdown)
4482         pub fn get_counterparty_node_id(&self) -> PublicKey {
4483                 self.counterparty_node_id
4484         }
4485
4486         /// Allowed in any state (including after shutdown)
4487         pub fn get_holder_htlc_minimum_msat(&self) -> u64 {
4488                 self.holder_htlc_minimum_msat
4489         }
4490
4491         /// Allowed in any state (including after shutdown), but will return none before TheirInitSent
4492         pub fn get_holder_htlc_maximum_msat(&self) -> Option<u64> {
4493                 self.get_htlc_maximum_msat(self.holder_max_htlc_value_in_flight_msat)
4494         }
4495
4496         /// Allowed in any state (including after shutdown)
4497         pub fn get_announced_htlc_max_msat(&self) -> u64 {
4498                 return cmp::min(
4499                         // Upper bound by capacity. We make it a bit less than full capacity to prevent attempts
4500                         // to use full capacity. This is an effort to reduce routing failures, because in many cases
4501                         // channel might have been used to route very small values (either by honest users or as DoS).
4502                         self.channel_value_satoshis * 1000 * 9 / 10,
4503
4504                         self.counterparty_max_htlc_value_in_flight_msat
4505                 );
4506         }
4507
4508         /// Allowed in any state (including after shutdown)
4509         pub fn get_counterparty_htlc_minimum_msat(&self) -> u64 {
4510                 self.counterparty_htlc_minimum_msat
4511         }
4512
4513         /// Allowed in any state (including after shutdown), but will return none before TheirInitSent
4514         pub fn get_counterparty_htlc_maximum_msat(&self) -> Option<u64> {
4515                 self.get_htlc_maximum_msat(self.counterparty_max_htlc_value_in_flight_msat)
4516         }
4517
4518         fn get_htlc_maximum_msat(&self, party_max_htlc_value_in_flight_msat: u64) -> Option<u64> {
4519                 self.counterparty_selected_channel_reserve_satoshis.map(|counterparty_reserve| {
4520                         let holder_reserve = self.holder_selected_channel_reserve_satoshis;
4521                         cmp::min(
4522                                 (self.channel_value_satoshis - counterparty_reserve - holder_reserve) * 1000,
4523                                 party_max_htlc_value_in_flight_msat
4524                         )
4525                 })
4526         }
4527
4528         pub fn get_value_satoshis(&self) -> u64 {
4529                 self.channel_value_satoshis
4530         }
4531
4532         pub fn get_fee_proportional_millionths(&self) -> u32 {
4533                 self.config.options.forwarding_fee_proportional_millionths
4534         }
4535
4536         pub fn get_cltv_expiry_delta(&self) -> u16 {
4537                 cmp::max(self.config.options.cltv_expiry_delta, MIN_CLTV_EXPIRY_DELTA)
4538         }
4539
4540         pub fn get_max_dust_htlc_exposure_msat(&self) -> u64 {
4541                 self.config.options.max_dust_htlc_exposure_msat
4542         }
4543
4544         /// Returns the previous [`ChannelConfig`] applied to this channel, if any.
4545         pub fn prev_config(&self) -> Option<ChannelConfig> {
4546                 self.prev_config.map(|prev_config| prev_config.0)
4547         }
4548
4549         /// Tracks the number of ticks elapsed since the previous [`ChannelConfig`] was updated. Once
4550         /// [`EXPIRE_PREV_CONFIG_TICKS`] is reached, the previous config is considered expired and will
4551         /// no longer be considered when forwarding HTLCs.
4552         pub fn maybe_expire_prev_config(&mut self) {
4553                 if self.prev_config.is_none() {
4554                         return;
4555                 }
4556                 let prev_config = self.prev_config.as_mut().unwrap();
4557                 prev_config.1 += 1;
4558                 if prev_config.1 == EXPIRE_PREV_CONFIG_TICKS {
4559                         self.prev_config = None;
4560                 }
4561         }
4562
4563         /// Returns the current [`ChannelConfig`] applied to the channel.
4564         pub fn config(&self) -> ChannelConfig {
4565                 self.config.options
4566         }
4567
4568         /// Updates the channel's config. A bool is returned indicating whether the config update
4569         /// applied resulted in a new ChannelUpdate message.
4570         pub fn update_config(&mut self, config: &ChannelConfig) -> bool {
4571                 let did_channel_update =
4572                         self.config.options.forwarding_fee_proportional_millionths != config.forwarding_fee_proportional_millionths ||
4573                         self.config.options.forwarding_fee_base_msat != config.forwarding_fee_base_msat ||
4574                         self.config.options.cltv_expiry_delta != config.cltv_expiry_delta;
4575                 if did_channel_update {
4576                         self.prev_config = Some((self.config.options, 0));
4577                         // Update the counter, which backs the ChannelUpdate timestamp, to allow the relay
4578                         // policy change to propagate throughout the network.
4579                         self.update_time_counter += 1;
4580                 }
4581                 self.config.options = *config;
4582                 did_channel_update
4583         }
4584
4585         fn internal_htlc_satisfies_config(
4586                 &self, htlc: &msgs::UpdateAddHTLC, amt_to_forward: u64, outgoing_cltv_value: u32, config: &ChannelConfig,
4587         ) -> Result<(), (&'static str, u16)> {
4588                 let fee = amt_to_forward.checked_mul(config.forwarding_fee_proportional_millionths as u64)
4589                         .and_then(|prop_fee| (prop_fee / 1000000).checked_add(config.forwarding_fee_base_msat as u64));
4590                 if fee.is_none() || htlc.amount_msat < fee.unwrap() ||
4591                         (htlc.amount_msat - fee.unwrap()) < amt_to_forward {
4592                         return Err((
4593                                 "Prior hop has deviated from specified fees parameters or origin node has obsolete ones",
4594                                 0x1000 | 12, // fee_insufficient
4595                         ));
4596                 }
4597                 if (htlc.cltv_expiry as u64) < outgoing_cltv_value as u64 + config.cltv_expiry_delta as u64 {
4598                         return Err((
4599                                 "Forwarding node has tampered with the intended HTLC values or origin node has an obsolete cltv_expiry_delta",
4600                                 0x1000 | 13, // incorrect_cltv_expiry
4601                         ));
4602                 }
4603                 Ok(())
4604         }
4605
4606         /// Determines whether the parameters of an incoming HTLC to be forwarded satisfy the channel's
4607         /// [`ChannelConfig`]. This first looks at the channel's current [`ChannelConfig`], and if
4608         /// unsuccessful, falls back to the previous one if one exists.
4609         pub fn htlc_satisfies_config(
4610                 &self, htlc: &msgs::UpdateAddHTLC, amt_to_forward: u64, outgoing_cltv_value: u32,
4611         ) -> Result<(), (&'static str, u16)> {
4612                 self.internal_htlc_satisfies_config(&htlc, amt_to_forward, outgoing_cltv_value, &self.config())
4613                         .or_else(|err| {
4614                                 if let Some(prev_config) = self.prev_config() {
4615                                         self.internal_htlc_satisfies_config(htlc, amt_to_forward, outgoing_cltv_value, &prev_config)
4616                                 } else {
4617                                         Err(err)
4618                                 }
4619                         })
4620         }
4621
4622         pub fn get_feerate(&self) -> u32 {
4623                 self.feerate_per_kw
4624         }
4625
4626         pub fn get_dust_buffer_feerate(&self, outbound_feerate_update: Option<u32>) -> u32 {
4627                 // When calculating our exposure to dust HTLCs, we assume that the channel feerate
4628                 // may, at any point, increase by at least 10 sat/vB (i.e 2530 sat/kWU) or 25%,
4629                 // whichever is higher. This ensures that we aren't suddenly exposed to significantly
4630                 // more dust balance if the feerate increases when we have several HTLCs pending
4631                 // which are near the dust limit.
4632                 let mut feerate_per_kw = self.feerate_per_kw;
4633                 // If there's a pending update fee, use it to ensure we aren't under-estimating
4634                 // potential feerate updates coming soon.
4635                 if let Some((feerate, _)) = self.pending_update_fee {
4636                         feerate_per_kw = cmp::max(feerate_per_kw, feerate);
4637                 }
4638                 if let Some(feerate) = outbound_feerate_update {
4639                         feerate_per_kw = cmp::max(feerate_per_kw, feerate);
4640                 }
4641                 cmp::max(2530, feerate_per_kw * 1250 / 1000)
4642         }
4643
4644         pub fn get_cur_holder_commitment_transaction_number(&self) -> u64 {
4645                 self.cur_holder_commitment_transaction_number + 1
4646         }
4647
4648         pub fn get_cur_counterparty_commitment_transaction_number(&self) -> u64 {
4649                 self.cur_counterparty_commitment_transaction_number + 1 - if self.channel_state & (ChannelState::AwaitingRemoteRevoke as u32) != 0 { 1 } else { 0 }
4650         }
4651
4652         pub fn get_revoked_counterparty_commitment_transaction_number(&self) -> u64 {
4653                 self.cur_counterparty_commitment_transaction_number + 2
4654         }
4655
4656         #[cfg(test)]
4657         pub fn get_signer(&self) -> &Signer {
4658                 &self.holder_signer
4659         }
4660
4661         #[cfg(test)]
4662         pub fn get_value_stat(&self) -> ChannelValueStat {
4663                 ChannelValueStat {
4664                         value_to_self_msat: self.value_to_self_msat,
4665                         channel_value_msat: self.channel_value_satoshis * 1000,
4666                         channel_reserve_msat: self.counterparty_selected_channel_reserve_satoshis.unwrap() * 1000,
4667                         pending_outbound_htlcs_amount_msat: self.pending_outbound_htlcs.iter().map(|ref h| h.amount_msat).sum::<u64>(),
4668                         pending_inbound_htlcs_amount_msat: self.pending_inbound_htlcs.iter().map(|ref h| h.amount_msat).sum::<u64>(),
4669                         holding_cell_outbound_amount_msat: {
4670                                 let mut res = 0;
4671                                 for h in self.holding_cell_htlc_updates.iter() {
4672                                         match h {
4673                                                 &HTLCUpdateAwaitingACK::AddHTLC{amount_msat, .. } => {
4674                                                         res += amount_msat;
4675                                                 }
4676                                                 _ => {}
4677                                         }
4678                                 }
4679                                 res
4680                         },
4681                         counterparty_max_htlc_value_in_flight_msat: self.counterparty_max_htlc_value_in_flight_msat,
4682                         counterparty_dust_limit_msat: self.counterparty_dust_limit_satoshis * 1000,
4683                 }
4684         }
4685
4686         /// Allowed in any state (including after shutdown)
4687         pub fn get_update_time_counter(&self) -> u32 {
4688                 self.update_time_counter
4689         }
4690
4691         pub fn get_latest_monitor_update_id(&self) -> u64 {
4692                 self.latest_monitor_update_id
4693         }
4694
4695         pub fn should_announce(&self) -> bool {
4696                 self.config.announced_channel
4697         }
4698
4699         pub fn is_outbound(&self) -> bool {
4700                 self.channel_transaction_parameters.is_outbound_from_holder
4701         }
4702
4703         /// Gets the fee we'd want to charge for adding an HTLC output to this Channel
4704         /// Allowed in any state (including after shutdown)
4705         pub fn get_outbound_forwarding_fee_base_msat(&self) -> u32 {
4706                 self.config.options.forwarding_fee_base_msat
4707         }
4708
4709         /// Returns true if we've ever received a message from the remote end for this Channel
4710         pub fn have_received_message(&self) -> bool {
4711                 self.channel_state > (ChannelState::OurInitSent as u32)
4712         }
4713
4714         /// Returns true if this channel is fully established and not known to be closing.
4715         /// Allowed in any state (including after shutdown)
4716         pub fn is_usable(&self) -> bool {
4717                 let mask = ChannelState::ChannelFunded as u32 | BOTH_SIDES_SHUTDOWN_MASK;
4718                 (self.channel_state & mask) == (ChannelState::ChannelFunded as u32) && !self.monitor_pending_channel_ready
4719         }
4720
4721         /// Returns true if this channel is currently available for use. This is a superset of
4722         /// is_usable() and considers things like the channel being temporarily disabled.
4723         /// Allowed in any state (including after shutdown)
4724         pub fn is_live(&self) -> bool {
4725                 self.is_usable() && (self.channel_state & (ChannelState::PeerDisconnected as u32) == 0)
4726         }
4727
4728         /// Returns true if this channel has been marked as awaiting a monitor update to move forward.
4729         /// Allowed in any state (including after shutdown)
4730         pub fn is_awaiting_monitor_update(&self) -> bool {
4731                 (self.channel_state & ChannelState::MonitorUpdateFailed as u32) != 0
4732         }
4733
4734         /// Returns true if funding_created was sent/received.
4735         pub fn is_funding_initiated(&self) -> bool {
4736                 self.channel_state >= ChannelState::FundingSent as u32
4737         }
4738
4739         /// Returns true if our channel_ready has been sent
4740         pub fn is_our_channel_ready(&self) -> bool {
4741                 (self.channel_state & ChannelState::OurChannelReady as u32) != 0 || self.channel_state >= ChannelState::ChannelFunded as u32
4742         }
4743
4744         /// Returns true if our peer has either initiated or agreed to shut down the channel.
4745         pub fn received_shutdown(&self) -> bool {
4746                 (self.channel_state & ChannelState::RemoteShutdownSent as u32) != 0
4747         }
4748
4749         /// Returns true if we either initiated or agreed to shut down the channel.
4750         pub fn sent_shutdown(&self) -> bool {
4751                 (self.channel_state & ChannelState::LocalShutdownSent as u32) != 0
4752         }
4753
4754         /// Returns true if this channel is fully shut down. True here implies that no further actions
4755         /// may/will be taken on this channel, and thus this object should be freed. Any future changes
4756         /// will be handled appropriately by the chain monitor.
4757         pub fn is_shutdown(&self) -> bool {
4758                 if (self.channel_state & ChannelState::ShutdownComplete as u32) == ChannelState::ShutdownComplete as u32  {
4759                         assert!(self.channel_state == ChannelState::ShutdownComplete as u32);
4760                         true
4761                 } else { false }
4762         }
4763
4764         pub fn channel_update_status(&self) -> ChannelUpdateStatus {
4765                 self.channel_update_status
4766         }
4767
4768         pub fn set_channel_update_status(&mut self, status: ChannelUpdateStatus) {
4769                 self.update_time_counter += 1;
4770                 self.channel_update_status = status;
4771         }
4772
4773         fn check_get_channel_ready(&mut self, height: u32) -> Option<msgs::ChannelReady> {
4774                 if self.funding_tx_confirmation_height == 0 && self.minimum_depth != Some(0) {
4775                         return None;
4776                 }
4777
4778                 let funding_tx_confirmations = height as i64 - self.funding_tx_confirmation_height as i64 + 1;
4779                 if funding_tx_confirmations <= 0 {
4780                         self.funding_tx_confirmation_height = 0;
4781                 }
4782
4783                 if funding_tx_confirmations < self.minimum_depth.unwrap_or(0) as i64 {
4784                         return None;
4785                 }
4786
4787                 let non_shutdown_state = self.channel_state & (!MULTI_STATE_FLAGS);
4788                 let need_commitment_update = if non_shutdown_state == ChannelState::FundingSent as u32 {
4789                         self.channel_state |= ChannelState::OurChannelReady as u32;
4790                         true
4791                 } else if non_shutdown_state == (ChannelState::FundingSent as u32 | ChannelState::TheirChannelReady as u32) {
4792                         self.channel_state = ChannelState::ChannelFunded as u32 | (self.channel_state & MULTI_STATE_FLAGS);
4793                         self.update_time_counter += 1;
4794                         true
4795                 } else if non_shutdown_state == (ChannelState::FundingSent as u32 | ChannelState::OurChannelReady as u32) {
4796                         // We got a reorg but not enough to trigger a force close, just ignore.
4797                         false
4798                 } else {
4799                         if self.channel_state < ChannelState::ChannelFunded as u32 {
4800                                 // We should never see a funding transaction on-chain until we've received
4801                                 // funding_signed (if we're an outbound channel), or seen funding_generated (if we're
4802                                 // an inbound channel - before that we have no known funding TXID). The fuzzer,
4803                                 // however, may do this and we shouldn't treat it as a bug.
4804                                 #[cfg(not(fuzzing))]
4805                                 panic!("Started confirming a channel in a state pre-FundingSent: {}.\n\
4806                                         Do NOT broadcast a funding transaction manually - let LDK do it for you!",
4807                                         self.channel_state);
4808                         }
4809                         // We got a reorg but not enough to trigger a force close, just ignore.
4810                         false
4811                 };
4812
4813                 if need_commitment_update {
4814                         if self.channel_state & (ChannelState::MonitorUpdateFailed as u32) == 0 {
4815                                 if self.channel_state & (ChannelState::PeerDisconnected as u32) == 0 {
4816                                         let next_per_commitment_point =
4817                                                 self.holder_signer.get_per_commitment_point(INITIAL_COMMITMENT_NUMBER - 1, &self.secp_ctx);
4818                                         return Some(msgs::ChannelReady {
4819                                                 channel_id: self.channel_id,
4820                                                 next_per_commitment_point,
4821                                                 short_channel_id_alias: Some(self.outbound_scid_alias),
4822                                         });
4823                                 }
4824                         } else {
4825                                 self.monitor_pending_channel_ready = true;
4826                         }
4827                 }
4828                 None
4829         }
4830
4831         /// When a transaction is confirmed, we check whether it is or spends the funding transaction
4832         /// In the first case, we store the confirmation height and calculating the short channel id.
4833         /// In the second, we simply return an Err indicating we need to be force-closed now.
4834         pub fn transactions_confirmed<L: Deref>(&mut self, block_hash: &BlockHash, height: u32,
4835                 txdata: &TransactionData, genesis_block_hash: BlockHash, node_pk: PublicKey, logger: &L)
4836         -> Result<(Option<msgs::ChannelReady>, Option<msgs::AnnouncementSignatures>), ClosureReason> where L::Target: Logger {
4837                 if let Some(funding_txo) = self.get_funding_txo() {
4838                         for &(index_in_block, tx) in txdata.iter() {
4839                                 // Check if the transaction is the expected funding transaction, and if it is,
4840                                 // check that it pays the right amount to the right script.
4841                                 if self.funding_tx_confirmation_height == 0 {
4842                                         if tx.txid() == funding_txo.txid {
4843                                                 let txo_idx = funding_txo.index as usize;
4844                                                 if txo_idx >= tx.output.len() || tx.output[txo_idx].script_pubkey != self.get_funding_redeemscript().to_v0_p2wsh() ||
4845                                                                 tx.output[txo_idx].value != self.channel_value_satoshis {
4846                                                         if self.is_outbound() {
4847                                                                 // If we generated the funding transaction and it doesn't match what it
4848                                                                 // should, the client is really broken and we should just panic and
4849                                                                 // tell them off. That said, because hash collisions happen with high
4850                                                                 // probability in fuzzing mode, if we're fuzzing we just close the
4851                                                                 // channel and move on.
4852                                                                 #[cfg(not(fuzzing))]
4853                                                                 panic!("Client called ChannelManager::funding_transaction_generated with bogus transaction!");
4854                                                         }
4855                                                         self.update_time_counter += 1;
4856                                                         let err_reason = "funding tx had wrong script/value or output index";
4857                                                         return Err(ClosureReason::ProcessingError { err: err_reason.to_owned() });
4858                                                 } else {
4859                                                         if self.is_outbound() {
4860                                                                 for input in tx.input.iter() {
4861                                                                         if input.witness.is_empty() {
4862                                                                                 // We generated a malleable funding transaction, implying we've
4863                                                                                 // just exposed ourselves to funds loss to our counterparty.
4864                                                                                 #[cfg(not(fuzzing))]
4865                                                                                 panic!("Client called ChannelManager::funding_transaction_generated with bogus transaction!");
4866                                                                         }
4867                                                                 }
4868                                                         }
4869                                                         self.funding_tx_confirmation_height = height;
4870                                                         self.funding_tx_confirmed_in = Some(*block_hash);
4871                                                         self.short_channel_id = match scid_from_parts(height as u64, index_in_block as u64, txo_idx as u64) {
4872                                                                 Ok(scid) => Some(scid),
4873                                                                 Err(_) => panic!("Block was bogus - either height was > 16 million, had > 16 million transactions, or had > 65k outputs"),
4874                                                         }
4875                                                 }
4876                                         }
4877                                         // If we allow 1-conf funding, we may need to check for channel_ready here and
4878                                         // send it immediately instead of waiting for a best_block_updated call (which
4879                                         // may have already happened for this block).
4880                                         if let Some(channel_ready) = self.check_get_channel_ready(height) {
4881                                                 log_info!(logger, "Sending a channel_ready to our peer for channel {}", log_bytes!(self.channel_id));
4882                                                 let announcement_sigs = self.get_announcement_sigs(node_pk, genesis_block_hash, height, logger);
4883                                                 return Ok((Some(channel_ready), announcement_sigs));
4884                                         }
4885                                 }
4886                                 for inp in tx.input.iter() {
4887                                         if inp.previous_output == funding_txo.into_bitcoin_outpoint() {
4888                                                 log_info!(logger, "Detected channel-closing tx {} spending {}:{}, closing channel {}", tx.txid(), inp.previous_output.txid, inp.previous_output.vout, log_bytes!(self.channel_id()));
4889                                                 return Err(ClosureReason::CommitmentTxConfirmed);
4890                                         }
4891                                 }
4892                         }
4893                 }
4894                 Ok((None, None))
4895         }
4896
4897         /// When a new block is connected, we check the height of the block against outbound holding
4898         /// cell HTLCs in case we need to give up on them prematurely and time them out. Everything
4899         /// else (e.g. commitment transaction broadcasts, HTLC transaction broadcasting, etc) is
4900         /// handled by the ChannelMonitor.
4901         ///
4902         /// If we return Err, the channel may have been closed, at which point the standard
4903         /// requirements apply - no calls may be made except those explicitly stated to be allowed
4904         /// post-shutdown.
4905         ///
4906         /// May return some HTLCs (and their payment_hash) which have timed out and should be failed
4907         /// back.
4908         pub fn best_block_updated<L: Deref>(&mut self, height: u32, highest_header_time: u32, genesis_block_hash: BlockHash, node_pk: PublicKey, logger: &L)
4909         -> Result<(Option<msgs::ChannelReady>, Vec<(HTLCSource, PaymentHash)>, Option<msgs::AnnouncementSignatures>), ClosureReason> where L::Target: Logger {
4910                 self.do_best_block_updated(height, highest_header_time, Some((genesis_block_hash, node_pk)), logger)
4911         }
4912
4913         fn do_best_block_updated<L: Deref>(&mut self, height: u32, highest_header_time: u32, genesis_node_pk: Option<(BlockHash, PublicKey)>, logger: &L)
4914         -> Result<(Option<msgs::ChannelReady>, Vec<(HTLCSource, PaymentHash)>, Option<msgs::AnnouncementSignatures>), ClosureReason> where L::Target: Logger {
4915                 let mut timed_out_htlcs = Vec::new();
4916                 // This mirrors the check in ChannelManager::decode_update_add_htlc_onion, refusing to
4917                 // forward an HTLC when our counterparty should almost certainly just fail it for expiring
4918                 // ~now.
4919                 let unforwarded_htlc_cltv_limit = height + LATENCY_GRACE_PERIOD_BLOCKS;
4920                 self.holding_cell_htlc_updates.retain(|htlc_update| {
4921                         match htlc_update {
4922                                 &HTLCUpdateAwaitingACK::AddHTLC { ref payment_hash, ref source, ref cltv_expiry, .. } => {
4923                                         if *cltv_expiry <= unforwarded_htlc_cltv_limit {
4924                                                 timed_out_htlcs.push((source.clone(), payment_hash.clone()));
4925                                                 false
4926                                         } else { true }
4927                                 },
4928                                 _ => true
4929                         }
4930                 });
4931
4932                 self.update_time_counter = cmp::max(self.update_time_counter, highest_header_time);
4933
4934                 if let Some(channel_ready) = self.check_get_channel_ready(height) {
4935                         let announcement_sigs = if let Some((genesis_block_hash, node_pk)) = genesis_node_pk {
4936                                 self.get_announcement_sigs(node_pk, genesis_block_hash, height, logger)
4937                         } else { None };
4938                         log_info!(logger, "Sending a channel_ready to our peer for channel {}", log_bytes!(self.channel_id));
4939                         return Ok((Some(channel_ready), timed_out_htlcs, announcement_sigs));
4940                 }
4941
4942                 let non_shutdown_state = self.channel_state & (!MULTI_STATE_FLAGS);
4943                 if non_shutdown_state >= ChannelState::ChannelFunded as u32 ||
4944                    (non_shutdown_state & ChannelState::OurChannelReady as u32) == ChannelState::OurChannelReady as u32 {
4945                         let mut funding_tx_confirmations = height as i64 - self.funding_tx_confirmation_height as i64 + 1;
4946                         if self.funding_tx_confirmation_height == 0 {
4947                                 // Note that check_get_channel_ready may reset funding_tx_confirmation_height to
4948                                 // zero if it has been reorged out, however in either case, our state flags
4949                                 // indicate we've already sent a channel_ready
4950                                 funding_tx_confirmations = 0;
4951                         }
4952
4953                         // If we've sent channel_ready (or have both sent and received channel_ready), and
4954                         // the funding transaction has become unconfirmed,
4955                         // close the channel and hope we can get the latest state on chain (because presumably
4956                         // the funding transaction is at least still in the mempool of most nodes).
4957                         //
4958                         // Note that ideally we wouldn't force-close if we see *any* reorg on a 1-conf or
4959                         // 0-conf channel, but not doing so may lead to the
4960                         // `ChannelManager::short_to_chan_info` map  being inconsistent, so we currently have
4961                         // to.
4962                         if funding_tx_confirmations == 0 && self.funding_tx_confirmed_in.is_some() {
4963                                 let err_reason = format!("Funding transaction was un-confirmed. Locked at {} confs, now have {} confs.",
4964                                         self.minimum_depth.unwrap(), funding_tx_confirmations);
4965                                 return Err(ClosureReason::ProcessingError { err: err_reason });
4966                         }
4967                 } else if !self.is_outbound() && self.funding_tx_confirmed_in.is_none() &&
4968                                 height >= self.channel_creation_height + FUNDING_CONF_DEADLINE_BLOCKS {
4969                         log_info!(logger, "Closing channel {} due to funding timeout", log_bytes!(self.channel_id));
4970                         // If funding_tx_confirmed_in is unset, the channel must not be active
4971                         assert!(non_shutdown_state <= ChannelState::ChannelFunded as u32);
4972                         assert_eq!(non_shutdown_state & ChannelState::OurChannelReady as u32, 0);
4973                         return Err(ClosureReason::FundingTimedOut);
4974                 }
4975
4976                 let announcement_sigs = if let Some((genesis_block_hash, node_pk)) = genesis_node_pk {
4977                         self.get_announcement_sigs(node_pk, genesis_block_hash, height, logger)
4978                 } else { None };
4979                 Ok((None, timed_out_htlcs, announcement_sigs))
4980         }
4981
4982         /// Indicates the funding transaction is no longer confirmed in the main chain. This may
4983         /// force-close the channel, but may also indicate a harmless reorganization of a block or two
4984         /// before the channel has reached channel_ready and we can just wait for more blocks.
4985         pub fn funding_transaction_unconfirmed<L: Deref>(&mut self, logger: &L) -> Result<(), ClosureReason> where L::Target: Logger {
4986                 if self.funding_tx_confirmation_height != 0 {
4987                         // We handle the funding disconnection by calling best_block_updated with a height one
4988                         // below where our funding was connected, implying a reorg back to conf_height - 1.
4989                         let reorg_height = self.funding_tx_confirmation_height - 1;
4990                         // We use the time field to bump the current time we set on channel updates if its
4991                         // larger. If we don't know that time has moved forward, we can just set it to the last
4992                         // time we saw and it will be ignored.
4993                         let best_time = self.update_time_counter;
4994                         match self.do_best_block_updated(reorg_height, best_time, None, logger) {
4995                                 Ok((channel_ready, timed_out_htlcs, announcement_sigs)) => {
4996                                         assert!(channel_ready.is_none(), "We can't generate a funding with 0 confirmations?");
4997                                         assert!(timed_out_htlcs.is_empty(), "We can't have accepted HTLCs with a timeout before our funding confirmation?");
4998                                         assert!(announcement_sigs.is_none(), "We can't generate an announcement_sigs with 0 confirmations?");
4999                                         Ok(())
5000                                 },
5001                                 Err(e) => Err(e)
5002                         }
5003                 } else {
5004                         // We never learned about the funding confirmation anyway, just ignore
5005                         Ok(())
5006                 }
5007         }
5008
5009         // Methods to get unprompted messages to send to the remote end (or where we already returned
5010         // something in the handler for the message that prompted this message):
5011
5012         pub fn get_open_channel(&self, chain_hash: BlockHash) -> msgs::OpenChannel {
5013                 if !self.is_outbound() {
5014                         panic!("Tried to open a channel for an inbound channel?");
5015                 }
5016                 if self.channel_state != ChannelState::OurInitSent as u32 {
5017                         panic!("Cannot generate an open_channel after we've moved forward");
5018                 }
5019
5020                 if self.cur_holder_commitment_transaction_number != INITIAL_COMMITMENT_NUMBER {
5021                         panic!("Tried to send an open_channel for a channel that has already advanced");
5022                 }
5023
5024                 let first_per_commitment_point = self.holder_signer.get_per_commitment_point(self.cur_holder_commitment_transaction_number, &self.secp_ctx);
5025                 let keys = self.get_holder_pubkeys();
5026
5027                 msgs::OpenChannel {
5028                         chain_hash,
5029                         temporary_channel_id: self.channel_id,
5030                         funding_satoshis: self.channel_value_satoshis,
5031                         push_msat: self.channel_value_satoshis * 1000 - self.value_to_self_msat,
5032                         dust_limit_satoshis: self.holder_dust_limit_satoshis,
5033                         max_htlc_value_in_flight_msat: self.holder_max_htlc_value_in_flight_msat,
5034                         channel_reserve_satoshis: self.holder_selected_channel_reserve_satoshis,
5035                         htlc_minimum_msat: self.holder_htlc_minimum_msat,
5036                         feerate_per_kw: self.feerate_per_kw as u32,
5037                         to_self_delay: self.get_holder_selected_contest_delay(),
5038                         max_accepted_htlcs: OUR_MAX_HTLCS,
5039                         funding_pubkey: keys.funding_pubkey,
5040                         revocation_basepoint: keys.revocation_basepoint,
5041                         payment_point: keys.payment_point,
5042                         delayed_payment_basepoint: keys.delayed_payment_basepoint,
5043                         htlc_basepoint: keys.htlc_basepoint,
5044                         first_per_commitment_point,
5045                         channel_flags: if self.config.announced_channel {1} else {0},
5046                         shutdown_scriptpubkey: OptionalField::Present(match &self.shutdown_scriptpubkey {
5047                                 Some(script) => script.clone().into_inner(),
5048                                 None => Builder::new().into_script(),
5049                         }),
5050                         channel_type: Some(self.channel_type.clone()),
5051                 }
5052         }
5053
5054         pub fn inbound_is_awaiting_accept(&self) -> bool {
5055                 self.inbound_awaiting_accept
5056         }
5057
5058         /// Sets this channel to accepting 0conf, must be done before `get_accept_channel`
5059         pub fn set_0conf(&mut self) {
5060                 assert!(self.inbound_awaiting_accept);
5061                 self.minimum_depth = Some(0);
5062         }
5063
5064         /// Marks an inbound channel as accepted and generates a [`msgs::AcceptChannel`] message which
5065         /// should be sent back to the counterparty node.
5066         ///
5067         /// [`msgs::AcceptChannel`]: crate::ln::msgs::AcceptChannel
5068         pub fn accept_inbound_channel(&mut self, user_id: u64) -> msgs::AcceptChannel {
5069                 if self.is_outbound() {
5070                         panic!("Tried to send accept_channel for an outbound channel?");
5071                 }
5072                 if self.channel_state != (ChannelState::OurInitSent as u32) | (ChannelState::TheirInitSent as u32) {
5073                         panic!("Tried to send accept_channel after channel had moved forward");
5074                 }
5075                 if self.cur_holder_commitment_transaction_number != INITIAL_COMMITMENT_NUMBER {
5076                         panic!("Tried to send an accept_channel for a channel that has already advanced");
5077                 }
5078                 if !self.inbound_awaiting_accept {
5079                         panic!("The inbound channel has already been accepted");
5080                 }
5081
5082                 self.user_id = user_id;
5083                 self.inbound_awaiting_accept = false;
5084
5085                 self.generate_accept_channel_message()
5086         }
5087
5088         /// This function is used to explicitly generate a [`msgs::AcceptChannel`] message for an
5089         /// inbound channel. If the intention is to accept an inbound channel, use
5090         /// [`Channel::accept_inbound_channel`] instead.
5091         ///
5092         /// [`msgs::AcceptChannel`]: crate::ln::msgs::AcceptChannel
5093         fn generate_accept_channel_message(&self) -> msgs::AcceptChannel {
5094                 let first_per_commitment_point = self.holder_signer.get_per_commitment_point(self.cur_holder_commitment_transaction_number, &self.secp_ctx);
5095                 let keys = self.get_holder_pubkeys();
5096
5097                 msgs::AcceptChannel {
5098                         temporary_channel_id: self.channel_id,
5099                         dust_limit_satoshis: self.holder_dust_limit_satoshis,
5100                         max_htlc_value_in_flight_msat: self.holder_max_htlc_value_in_flight_msat,
5101                         channel_reserve_satoshis: self.holder_selected_channel_reserve_satoshis,
5102                         htlc_minimum_msat: self.holder_htlc_minimum_msat,
5103                         minimum_depth: self.minimum_depth.unwrap(),
5104                         to_self_delay: self.get_holder_selected_contest_delay(),
5105                         max_accepted_htlcs: OUR_MAX_HTLCS,
5106                         funding_pubkey: keys.funding_pubkey,
5107                         revocation_basepoint: keys.revocation_basepoint,
5108                         payment_point: keys.payment_point,
5109                         delayed_payment_basepoint: keys.delayed_payment_basepoint,
5110                         htlc_basepoint: keys.htlc_basepoint,
5111                         first_per_commitment_point,
5112                         shutdown_scriptpubkey: OptionalField::Present(match &self.shutdown_scriptpubkey {
5113                                 Some(script) => script.clone().into_inner(),
5114                                 None => Builder::new().into_script(),
5115                         }),
5116                         channel_type: Some(self.channel_type.clone()),
5117                 }
5118         }
5119
5120         /// Enables the possibility for tests to extract a [`msgs::AcceptChannel`] message for an
5121         /// inbound channel without accepting it.
5122         ///
5123         /// [`msgs::AcceptChannel`]: crate::ln::msgs::AcceptChannel
5124         #[cfg(test)]
5125         pub fn get_accept_channel_message(&self) -> msgs::AcceptChannel {
5126                 self.generate_accept_channel_message()
5127         }
5128
5129         /// If an Err is returned, it is a ChannelError::Close (for get_outbound_funding_created)
5130         fn get_outbound_funding_created_signature<L: Deref>(&mut self, logger: &L) -> Result<Signature, ChannelError> where L::Target: Logger {
5131                 let counterparty_keys = self.build_remote_transaction_keys()?;
5132                 let counterparty_initial_commitment_tx = self.build_commitment_transaction(self.cur_counterparty_commitment_transaction_number, &counterparty_keys, false, false, logger).tx;
5133                 Ok(self.holder_signer.sign_counterparty_commitment(&counterparty_initial_commitment_tx, Vec::new(), &self.secp_ctx)
5134                                 .map_err(|_| ChannelError::Close("Failed to get signatures for new commitment_signed".to_owned()))?.0)
5135         }
5136
5137         /// Updates channel state with knowledge of the funding transaction's txid/index, and generates
5138         /// a funding_created message for the remote peer.
5139         /// Panics if called at some time other than immediately after initial handshake, if called twice,
5140         /// or if called on an inbound channel.
5141         /// Note that channel_id changes during this call!
5142         /// Do NOT broadcast the funding transaction until after a successful funding_signed call!
5143         /// If an Err is returned, it is a ChannelError::Close.
5144         pub fn get_outbound_funding_created<L: Deref>(&mut self, funding_transaction: Transaction, funding_txo: OutPoint, logger: &L) -> Result<msgs::FundingCreated, ChannelError> where L::Target: Logger {
5145                 if !self.is_outbound() {
5146                         panic!("Tried to create outbound funding_created message on an inbound channel!");
5147                 }
5148                 if self.channel_state != (ChannelState::OurInitSent as u32 | ChannelState::TheirInitSent as u32) {
5149                         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)");
5150                 }
5151                 if self.commitment_secrets.get_min_seen_secret() != (1 << 48) ||
5152                                 self.cur_counterparty_commitment_transaction_number != INITIAL_COMMITMENT_NUMBER ||
5153                                 self.cur_holder_commitment_transaction_number != INITIAL_COMMITMENT_NUMBER {
5154                         panic!("Should not have advanced channel commitment tx numbers prior to funding_created");
5155                 }
5156
5157                 self.channel_transaction_parameters.funding_outpoint = Some(funding_txo);
5158                 self.holder_signer.ready_channel(&self.channel_transaction_parameters);
5159
5160                 let signature = match self.get_outbound_funding_created_signature(logger) {
5161                         Ok(res) => res,
5162                         Err(e) => {
5163                                 log_error!(logger, "Got bad signatures: {:?}!", e);
5164                                 self.channel_transaction_parameters.funding_outpoint = None;
5165                                 return Err(e);
5166                         }
5167                 };
5168
5169                 let temporary_channel_id = self.channel_id;
5170
5171                 // Now that we're past error-generating stuff, update our local state:
5172
5173                 self.channel_state = ChannelState::FundingCreated as u32;
5174                 self.channel_id = funding_txo.to_channel_id();
5175                 self.funding_transaction = Some(funding_transaction);
5176
5177                 Ok(msgs::FundingCreated {
5178                         temporary_channel_id,
5179                         funding_txid: funding_txo.txid,
5180                         funding_output_index: funding_txo.index,
5181                         signature
5182                 })
5183         }
5184
5185         /// Gets an UnsignedChannelAnnouncement for this channel. The channel must be publicly
5186         /// announceable and available for use (have exchanged ChannelReady messages in both
5187         /// directions). Should be used for both broadcasted announcements and in response to an
5188         /// AnnouncementSignatures message from the remote peer.
5189         ///
5190         /// Will only fail if we're not in a state where channel_announcement may be sent (including
5191         /// closing).
5192         ///
5193         /// This will only return ChannelError::Ignore upon failure.
5194         fn get_channel_announcement(&self, node_id: PublicKey, chain_hash: BlockHash) -> Result<msgs::UnsignedChannelAnnouncement, ChannelError> {
5195                 if !self.config.announced_channel {
5196                         return Err(ChannelError::Ignore("Channel is not available for public announcements".to_owned()));
5197                 }
5198                 if !self.is_usable() {
5199                         return Err(ChannelError::Ignore("Cannot get a ChannelAnnouncement if the channel is not currently usable".to_owned()));
5200                 }
5201
5202                 let were_node_one = node_id.serialize()[..] < self.counterparty_node_id.serialize()[..];
5203
5204                 let msg = msgs::UnsignedChannelAnnouncement {
5205                         features: ChannelFeatures::known(),
5206                         chain_hash,
5207                         short_channel_id: self.get_short_channel_id().unwrap(),
5208                         node_id_1: if were_node_one { node_id } else { self.get_counterparty_node_id() },
5209                         node_id_2: if were_node_one { self.get_counterparty_node_id() } else { node_id },
5210                         bitcoin_key_1: if were_node_one { self.get_holder_pubkeys().funding_pubkey } else { self.counterparty_funding_pubkey().clone() },
5211                         bitcoin_key_2: if were_node_one { self.counterparty_funding_pubkey().clone() } else { self.get_holder_pubkeys().funding_pubkey },
5212                         excess_data: Vec::new(),
5213                 };
5214
5215                 Ok(msg)
5216         }
5217
5218         fn get_announcement_sigs<L: Deref>(&mut self, node_pk: PublicKey, genesis_block_hash: BlockHash, best_block_height: u32, logger: &L)
5219         -> Option<msgs::AnnouncementSignatures> where L::Target: Logger {
5220                 if self.funding_tx_confirmation_height == 0 || self.funding_tx_confirmation_height + 5 > best_block_height {
5221                         return None;
5222                 }
5223
5224                 if !self.is_usable() {
5225                         return None;
5226                 }
5227
5228                 if self.channel_state & ChannelState::PeerDisconnected as u32 != 0 {
5229                         log_trace!(logger, "Cannot create an announcement_signatures as our peer is disconnected");
5230                         return None;
5231                 }
5232
5233                 if self.announcement_sigs_state != AnnouncementSigsState::NotSent {
5234                         return None;
5235                 }
5236
5237                 log_trace!(logger, "Creating an announcement_signatures message for channel {}", log_bytes!(self.channel_id()));
5238                 let announcement = match self.get_channel_announcement(node_pk, genesis_block_hash) {
5239                         Ok(a) => a,
5240                         Err(_) => {
5241                                 log_trace!(logger, "Cannot create an announcement_signatures as channel is not public.");
5242                                 return None;
5243                         }
5244                 };
5245                 let (our_node_sig, our_bitcoin_sig) = match self.holder_signer.sign_channel_announcement(&announcement, &self.secp_ctx) {
5246                         Err(_) => {
5247                                 log_error!(logger, "Signer rejected channel_announcement signing. Channel will not be announced!");
5248                                 return None;
5249                         },
5250                         Ok(v) => v
5251                 };
5252                 self.announcement_sigs_state = AnnouncementSigsState::MessageSent;
5253
5254                 Some(msgs::AnnouncementSignatures {
5255                         channel_id: self.channel_id(),
5256                         short_channel_id: self.get_short_channel_id().unwrap(),
5257                         node_signature: our_node_sig,
5258                         bitcoin_signature: our_bitcoin_sig,
5259                 })
5260         }
5261
5262         /// Signs the given channel announcement, returning a ChannelError::Ignore if no keys are
5263         /// available.
5264         fn sign_channel_announcement(&self, our_node_id: PublicKey, announcement: msgs::UnsignedChannelAnnouncement) -> Result<msgs::ChannelAnnouncement, ChannelError> {
5265                 if let Some((their_node_sig, their_bitcoin_sig)) = self.announcement_sigs {
5266                         let were_node_one = announcement.node_id_1 == our_node_id;
5267
5268                         let (our_node_sig, our_bitcoin_sig) = self.holder_signer.sign_channel_announcement(&announcement, &self.secp_ctx)
5269                                 .map_err(|_| ChannelError::Ignore("Signer rejected channel_announcement".to_owned()))?;
5270                         Ok(msgs::ChannelAnnouncement {
5271                                 node_signature_1: if were_node_one { our_node_sig } else { their_node_sig },
5272                                 node_signature_2: if were_node_one { their_node_sig } else { our_node_sig },
5273                                 bitcoin_signature_1: if were_node_one { our_bitcoin_sig } else { their_bitcoin_sig },
5274                                 bitcoin_signature_2: if were_node_one { their_bitcoin_sig } else { our_bitcoin_sig },
5275                                 contents: announcement,
5276                         })
5277                 } else {
5278                         Err(ChannelError::Ignore("Attempted to sign channel announcement before we'd received announcement_signatures".to_string()))
5279                 }
5280         }
5281
5282         /// Processes an incoming announcement_signatures message, providing a fully-signed
5283         /// channel_announcement message which we can broadcast and storing our counterparty's
5284         /// signatures for later reconstruction/rebroadcast of the channel_announcement.
5285         pub fn announcement_signatures(&mut self, our_node_id: PublicKey, chain_hash: BlockHash, best_block_height: u32, msg: &msgs::AnnouncementSignatures) -> Result<msgs::ChannelAnnouncement, ChannelError> {
5286                 let announcement = self.get_channel_announcement(our_node_id.clone(), chain_hash)?;
5287
5288                 let msghash = hash_to_message!(&Sha256d::hash(&announcement.encode()[..])[..]);
5289
5290                 if self.secp_ctx.verify_ecdsa(&msghash, &msg.node_signature, &self.get_counterparty_node_id()).is_err() {
5291                         return Err(ChannelError::Close(format!(
5292                                 "Bad announcement_signatures. Failed to verify node_signature. UnsignedChannelAnnouncement used for verification is {:?}. their_node_key is {:?}",
5293                                  &announcement, self.get_counterparty_node_id())));
5294                 }
5295                 if self.secp_ctx.verify_ecdsa(&msghash, &msg.bitcoin_signature, self.counterparty_funding_pubkey()).is_err() {
5296                         return Err(ChannelError::Close(format!(
5297                                 "Bad announcement_signatures. Failed to verify bitcoin_signature. UnsignedChannelAnnouncement used for verification is {:?}. their_bitcoin_key is ({:?})",
5298                                 &announcement, self.counterparty_funding_pubkey())));
5299                 }
5300
5301                 self.announcement_sigs = Some((msg.node_signature, msg.bitcoin_signature));
5302                 if self.funding_tx_confirmation_height == 0 || self.funding_tx_confirmation_height + 5 > best_block_height {
5303                         return Err(ChannelError::Ignore(
5304                                 "Got announcement_signatures prior to the required six confirmations - we may not have received a block yet that our peer has".to_owned()));
5305                 }
5306
5307                 self.sign_channel_announcement(our_node_id, announcement)
5308         }
5309
5310         /// Gets a signed channel_announcement for this channel, if we previously received an
5311         /// announcement_signatures from our counterparty.
5312         pub fn get_signed_channel_announcement(&self, our_node_id: PublicKey, chain_hash: BlockHash, best_block_height: u32) -> Option<msgs::ChannelAnnouncement> {
5313                 if self.funding_tx_confirmation_height == 0 || self.funding_tx_confirmation_height + 5 > best_block_height {
5314                         return None;
5315                 }
5316                 let announcement = match self.get_channel_announcement(our_node_id.clone(), chain_hash) {
5317                         Ok(res) => res,
5318                         Err(_) => return None,
5319                 };
5320                 match self.sign_channel_announcement(our_node_id, announcement) {
5321                         Ok(res) => Some(res),
5322                         Err(_) => None,
5323                 }
5324         }
5325
5326         /// May panic if called on a channel that wasn't immediately-previously
5327         /// self.remove_uncommitted_htlcs_and_mark_paused()'d
5328         pub fn get_channel_reestablish<L: Deref>(&self, logger: &L) -> msgs::ChannelReestablish where L::Target: Logger {
5329                 assert_eq!(self.channel_state & ChannelState::PeerDisconnected as u32, ChannelState::PeerDisconnected as u32);
5330                 assert_ne!(self.cur_counterparty_commitment_transaction_number, INITIAL_COMMITMENT_NUMBER);
5331                 // Prior to static_remotekey, my_current_per_commitment_point was critical to claiming
5332                 // current to_remote balances. However, it no longer has any use, and thus is now simply
5333                 // set to a dummy (but valid, as required by the spec) public key.
5334                 // fuzzing mode marks a subset of pubkeys as invalid so that we can hit "invalid pubkey"
5335                 // branches, but we unwrap it below, so we arbitrarily select a dummy pubkey which is both
5336                 // valid, and valid in fuzzing mode's arbitrary validity criteria:
5337                 let mut pk = [2; 33]; pk[1] = 0xff;
5338                 let dummy_pubkey = PublicKey::from_slice(&pk).unwrap();
5339                 let data_loss_protect = if self.cur_counterparty_commitment_transaction_number + 1 < INITIAL_COMMITMENT_NUMBER {
5340                         let remote_last_secret = self.commitment_secrets.get_secret(self.cur_counterparty_commitment_transaction_number + 2).unwrap();
5341                         log_trace!(logger, "Enough info to generate a Data Loss Protect with per_commitment_secret {} for channel {}", log_bytes!(remote_last_secret), log_bytes!(self.channel_id()));
5342                         OptionalField::Present(DataLossProtect {
5343                                 your_last_per_commitment_secret: remote_last_secret,
5344                                 my_current_per_commitment_point: dummy_pubkey
5345                         })
5346                 } else {
5347                         log_info!(logger, "Sending a data_loss_protect with no previous remote per_commitment_secret for channel {}", log_bytes!(self.channel_id()));
5348                         OptionalField::Present(DataLossProtect {
5349                                 your_last_per_commitment_secret: [0;32],
5350                                 my_current_per_commitment_point: dummy_pubkey,
5351                         })
5352                 };
5353                 msgs::ChannelReestablish {
5354                         channel_id: self.channel_id(),
5355                         // The protocol has two different commitment number concepts - the "commitment
5356                         // transaction number", which starts from 0 and counts up, and the "revocation key
5357                         // index" which starts at INITIAL_COMMITMENT_NUMBER and counts down. We track
5358                         // commitment transaction numbers by the index which will be used to reveal the
5359                         // revocation key for that commitment transaction, which means we have to convert them
5360                         // to protocol-level commitment numbers here...
5361
5362                         // next_local_commitment_number is the next commitment_signed number we expect to
5363                         // receive (indicating if they need to resend one that we missed).
5364                         next_local_commitment_number: INITIAL_COMMITMENT_NUMBER - self.cur_holder_commitment_transaction_number,
5365                         // We have to set next_remote_commitment_number to the next revoke_and_ack we expect to
5366                         // receive, however we track it by the next commitment number for a remote transaction
5367                         // (which is one further, as they always revoke previous commitment transaction, not
5368                         // the one we send) so we have to decrement by 1. Note that if
5369                         // cur_counterparty_commitment_transaction_number is INITIAL_COMMITMENT_NUMBER we will have
5370                         // dropped this channel on disconnect as it hasn't yet reached FundingSent so we can't
5371                         // overflow here.
5372                         next_remote_commitment_number: INITIAL_COMMITMENT_NUMBER - self.cur_counterparty_commitment_transaction_number - 1,
5373                         data_loss_protect,
5374                 }
5375         }
5376
5377
5378         // Send stuff to our remote peers:
5379
5380         /// Adds a pending outbound HTLC to this channel, note that you probably want
5381         /// send_htlc_and_commit instead cause you'll want both messages at once.
5382         ///
5383         /// This returns an optional UpdateAddHTLC as we may be in a state where we cannot add HTLCs on
5384         /// the wire:
5385         /// * In cases where we're waiting on the remote peer to send us a revoke_and_ack, we
5386         ///   wouldn't be able to determine what they actually ACK'ed if we have two sets of updates
5387         ///   awaiting ACK.
5388         /// * In cases where we're marked MonitorUpdateFailed, we cannot commit to a new state as we
5389         ///   may not yet have sent the previous commitment update messages and will need to regenerate
5390         ///   them.
5391         ///
5392         /// You MUST call send_commitment prior to calling any other methods on this Channel!
5393         ///
5394         /// If an Err is returned, it's a ChannelError::Ignore!
5395         pub fn send_htlc<L: Deref>(&mut self, amount_msat: u64, payment_hash: PaymentHash, cltv_expiry: u32, source: HTLCSource, onion_routing_packet: msgs::OnionPacket, logger: &L) -> Result<Option<msgs::UpdateAddHTLC>, ChannelError> where L::Target: Logger {
5396                 if (self.channel_state & (ChannelState::ChannelFunded as u32 | BOTH_SIDES_SHUTDOWN_MASK)) != (ChannelState::ChannelFunded as u32) {
5397                         return Err(ChannelError::Ignore("Cannot send HTLC until channel is fully established and we haven't started shutting down".to_owned()));
5398                 }
5399                 let channel_total_msat = self.channel_value_satoshis * 1000;
5400                 if amount_msat > channel_total_msat {
5401                         return Err(ChannelError::Ignore(format!("Cannot send amount {}, because it is more than the total value of the channel {}", amount_msat, channel_total_msat)));
5402                 }
5403
5404                 if amount_msat == 0 {
5405                         return Err(ChannelError::Ignore("Cannot send 0-msat HTLC".to_owned()));
5406                 }
5407
5408                 if amount_msat < self.counterparty_htlc_minimum_msat {
5409                         return Err(ChannelError::Ignore(format!("Cannot send less than their minimum HTLC value ({})", self.counterparty_htlc_minimum_msat)));
5410                 }
5411
5412                 if (self.channel_state & (ChannelState::PeerDisconnected as u32)) != 0 {
5413                         // Note that this should never really happen, if we're !is_live() on receipt of an
5414                         // incoming HTLC for relay will result in us rejecting the HTLC and we won't allow
5415                         // the user to send directly into a !is_live() channel. However, if we
5416                         // disconnected during the time the previous hop was doing the commitment dance we may
5417                         // end up getting here after the forwarding delay. In any case, returning an
5418                         // IgnoreError will get ChannelManager to do the right thing and fail backwards now.
5419                         return Err(ChannelError::Ignore("Cannot send an HTLC while disconnected from channel counterparty".to_owned()));
5420                 }
5421
5422                 let inbound_stats = self.get_inbound_pending_htlc_stats(None);
5423                 let outbound_stats = self.get_outbound_pending_htlc_stats(None);
5424                 if outbound_stats.pending_htlcs + 1 > self.counterparty_max_accepted_htlcs as u32 {
5425                         return Err(ChannelError::Ignore(format!("Cannot push more than their max accepted HTLCs ({})", self.counterparty_max_accepted_htlcs)));
5426                 }
5427                 // Check their_max_htlc_value_in_flight_msat
5428                 if outbound_stats.pending_htlcs_value_msat + amount_msat > self.counterparty_max_htlc_value_in_flight_msat {
5429                         return Err(ChannelError::Ignore(format!("Cannot send value that would put us over the max HTLC value in flight our peer will accept ({})", self.counterparty_max_htlc_value_in_flight_msat)));
5430                 }
5431
5432                 let keys = self.build_holder_transaction_keys(self.cur_holder_commitment_transaction_number)?;
5433                 let commitment_stats = self.build_commitment_transaction(self.cur_holder_commitment_transaction_number, &keys, true, true, logger);
5434                 if !self.is_outbound() {
5435                         // Check that we won't violate the remote channel reserve by adding this HTLC.
5436                         let htlc_candidate = HTLCCandidate::new(amount_msat, HTLCInitiator::LocalOffered);
5437                         let counterparty_commit_tx_fee_msat = self.next_remote_commit_tx_fee_msat(htlc_candidate, None);
5438                         let holder_selected_chan_reserve_msat = self.holder_selected_channel_reserve_satoshis * 1000;
5439                         if commitment_stats.remote_balance_msat < counterparty_commit_tx_fee_msat + holder_selected_chan_reserve_msat {
5440                                 return Err(ChannelError::Ignore("Cannot send value that would put counterparty balance under holder-announced channel reserve value".to_owned()));
5441                         }
5442                 }
5443
5444                 let exposure_dust_limit_success_sats = (self.get_dust_buffer_feerate(None) as u64 * htlc_success_tx_weight(self.opt_anchors()) / 1000) + self.counterparty_dust_limit_satoshis;
5445                 if amount_msat / 1000 < exposure_dust_limit_success_sats {
5446                         let on_counterparty_dust_htlc_exposure_msat = inbound_stats.on_counterparty_tx_dust_exposure_msat + outbound_stats.on_counterparty_tx_dust_exposure_msat + amount_msat;
5447                         if on_counterparty_dust_htlc_exposure_msat > self.get_max_dust_htlc_exposure_msat() {
5448                                 return Err(ChannelError::Ignore(format!("Cannot send value that would put our exposure to dust HTLCs at {} over the limit {} on counterparty commitment tx",
5449                                         on_counterparty_dust_htlc_exposure_msat, self.get_max_dust_htlc_exposure_msat())));
5450                         }
5451                 }
5452
5453                 let exposure_dust_limit_timeout_sats = (self.get_dust_buffer_feerate(None) as u64 * htlc_timeout_tx_weight(self.opt_anchors()) / 1000) + self.holder_dust_limit_satoshis;
5454                 if amount_msat / 1000 <  exposure_dust_limit_timeout_sats {
5455                         let on_holder_dust_htlc_exposure_msat = inbound_stats.on_holder_tx_dust_exposure_msat + outbound_stats.on_holder_tx_dust_exposure_msat + amount_msat;
5456                         if on_holder_dust_htlc_exposure_msat > self.get_max_dust_htlc_exposure_msat() {
5457                                 return Err(ChannelError::Ignore(format!("Cannot send value that would put our exposure to dust HTLCs at {} over the limit {} on holder commitment tx",
5458                                         on_holder_dust_htlc_exposure_msat, self.get_max_dust_htlc_exposure_msat())));
5459                         }
5460                 }
5461
5462                 let holder_balance_msat = commitment_stats.local_balance_msat - outbound_stats.holding_cell_msat;
5463                 if holder_balance_msat < amount_msat {
5464                         return Err(ChannelError::Ignore(format!("Cannot send value that would overdraw remaining funds. Amount: {}, pending value to self {}", amount_msat, holder_balance_msat)));
5465                 }
5466
5467                 // `2 *` and extra HTLC are for the fee spike buffer.
5468                 let commit_tx_fee_msat = if self.is_outbound() {
5469                         let htlc_candidate = HTLCCandidate::new(amount_msat, HTLCInitiator::LocalOffered);
5470                         FEE_SPIKE_BUFFER_FEE_INCREASE_MULTIPLE * self.next_local_commit_tx_fee_msat(htlc_candidate, Some(()))
5471                 } else { 0 };
5472                 if holder_balance_msat - amount_msat < commit_tx_fee_msat {
5473                         return Err(ChannelError::Ignore(format!("Cannot send value that would not leave enough to pay for fees. Pending value to self: {}. local_commit_tx_fee {}", holder_balance_msat, commit_tx_fee_msat)));
5474                 }
5475
5476                 // Check self.counterparty_selected_channel_reserve_satoshis (the amount we must keep as
5477                 // reserve for the remote to have something to claim if we misbehave)
5478                 let chan_reserve_msat = self.counterparty_selected_channel_reserve_satoshis.unwrap() * 1000;
5479                 if holder_balance_msat - amount_msat - commit_tx_fee_msat < chan_reserve_msat {
5480                         return Err(ChannelError::Ignore(format!("Cannot send value that would put our balance under counterparty-announced channel reserve value ({})", chan_reserve_msat)));
5481                 }
5482
5483                 // Now update local state:
5484                 if (self.channel_state & (ChannelState::AwaitingRemoteRevoke as u32 | ChannelState::MonitorUpdateFailed as u32)) != 0 {
5485                         self.holding_cell_htlc_updates.push(HTLCUpdateAwaitingACK::AddHTLC {
5486                                 amount_msat,
5487                                 payment_hash,
5488                                 cltv_expiry,
5489                                 source,
5490                                 onion_routing_packet,
5491                         });
5492                         return Ok(None);
5493                 }
5494
5495                 self.pending_outbound_htlcs.push(OutboundHTLCOutput {
5496                         htlc_id: self.next_holder_htlc_id,
5497                         amount_msat,
5498                         payment_hash: payment_hash.clone(),
5499                         cltv_expiry,
5500                         state: OutboundHTLCState::LocalAnnounced(Box::new(onion_routing_packet.clone())),
5501                         source,
5502                 });
5503
5504                 let res = msgs::UpdateAddHTLC {
5505                         channel_id: self.channel_id,
5506                         htlc_id: self.next_holder_htlc_id,
5507                         amount_msat,
5508                         payment_hash,
5509                         cltv_expiry,
5510                         onion_routing_packet,
5511                 };
5512                 self.next_holder_htlc_id += 1;
5513
5514                 Ok(Some(res))
5515         }
5516
5517         /// Creates a signed commitment transaction to send to the remote peer.
5518         /// Always returns a ChannelError::Close if an immediately-preceding (read: the
5519         /// last call to this Channel) send_htlc returned Ok(Some(_)) and there is an Err.
5520         /// May panic if called except immediately after a successful, Ok(Some(_))-returning send_htlc.
5521         pub fn send_commitment<L: Deref>(&mut self, logger: &L) -> Result<(msgs::CommitmentSigned, ChannelMonitorUpdate), ChannelError> where L::Target: Logger {
5522                 if (self.channel_state & (ChannelState::ChannelFunded as u32)) != (ChannelState::ChannelFunded as u32) {
5523                         panic!("Cannot create commitment tx until channel is fully established");
5524                 }
5525                 if (self.channel_state & (ChannelState::AwaitingRemoteRevoke as u32)) == (ChannelState::AwaitingRemoteRevoke as u32) {
5526                         panic!("Cannot create commitment tx until remote revokes their previous commitment");
5527                 }
5528                 if (self.channel_state & (ChannelState::PeerDisconnected as u32)) == (ChannelState::PeerDisconnected as u32) {
5529                         panic!("Cannot create commitment tx while disconnected, as send_htlc will have returned an Err so a send_commitment precondition has been violated");
5530                 }
5531                 if (self.channel_state & (ChannelState::MonitorUpdateFailed as u32)) == (ChannelState::MonitorUpdateFailed as u32) {
5532                         panic!("Cannot create commitment tx while awaiting monitor update unfreeze, as send_htlc will have returned an Err so a send_commitment precondition has been violated");
5533                 }
5534                 let mut have_updates = self.is_outbound() && self.pending_update_fee.is_some();
5535                 for htlc in self.pending_outbound_htlcs.iter() {
5536                         if let OutboundHTLCState::LocalAnnounced(_) = htlc.state {
5537                                 have_updates = true;
5538                         }
5539                         if have_updates { break; }
5540                 }
5541                 for htlc in self.pending_inbound_htlcs.iter() {
5542                         if let InboundHTLCState::LocalRemoved(_) = htlc.state {
5543                                 have_updates = true;
5544                         }
5545                         if have_updates { break; }
5546                 }
5547                 if !have_updates {
5548                         panic!("Cannot create commitment tx until we have some updates to send");
5549                 }
5550                 self.send_commitment_no_status_check(logger)
5551         }
5552         /// Only fails in case of bad keys
5553         fn send_commitment_no_status_check<L: Deref>(&mut self, logger: &L) -> Result<(msgs::CommitmentSigned, ChannelMonitorUpdate), ChannelError> where L::Target: Logger {
5554                 log_trace!(logger, "Updating HTLC state for a newly-sent commitment_signed...");
5555                 // We can upgrade the status of some HTLCs that are waiting on a commitment, even if we
5556                 // fail to generate this, we still are at least at a position where upgrading their status
5557                 // is acceptable.
5558                 for htlc in self.pending_inbound_htlcs.iter_mut() {
5559                         let new_state = if let &InboundHTLCState::AwaitingRemoteRevokeToAnnounce(ref forward_info) = &htlc.state {
5560                                 Some(InboundHTLCState::AwaitingAnnouncedRemoteRevoke(forward_info.clone()))
5561                         } else { None };
5562                         if let Some(state) = new_state {
5563                                 log_trace!(logger, " ...promoting inbound AwaitingRemoteRevokeToAnnounce {} to AwaitingAnnouncedRemoteRevoke", log_bytes!(htlc.payment_hash.0));
5564                                 htlc.state = state;
5565                         }
5566                 }
5567                 for htlc in self.pending_outbound_htlcs.iter_mut() {
5568                         if let &mut OutboundHTLCState::AwaitingRemoteRevokeToRemove(ref mut outcome) = &mut htlc.state {
5569                                 log_trace!(logger, " ...promoting outbound AwaitingRemoteRevokeToRemove {} to AwaitingRemovedRemoteRevoke", log_bytes!(htlc.payment_hash.0));
5570                                 // Grab the preimage, if it exists, instead of cloning
5571                                 let mut reason = OutboundHTLCOutcome::Success(None);
5572                                 mem::swap(outcome, &mut reason);
5573                                 htlc.state = OutboundHTLCState::AwaitingRemovedRemoteRevoke(reason);
5574                         }
5575                 }
5576                 if let Some((feerate, update_state)) = self.pending_update_fee {
5577                         if update_state == FeeUpdateState::AwaitingRemoteRevokeToAnnounce {
5578                                 debug_assert!(!self.is_outbound());
5579                                 log_trace!(logger, " ...promoting inbound AwaitingRemoteRevokeToAnnounce fee update {} to Committed", feerate);
5580                                 self.feerate_per_kw = feerate;
5581                                 self.pending_update_fee = None;
5582                         }
5583                 }
5584                 self.resend_order = RAACommitmentOrder::RevokeAndACKFirst;
5585
5586                 let (res, counterparty_commitment_txid, htlcs) = match self.send_commitment_no_state_update(logger) {
5587                         Ok((res, (counterparty_commitment_tx, mut htlcs))) => {
5588                                 // Update state now that we've passed all the can-fail calls...
5589                                 let htlcs_no_ref: Vec<(HTLCOutputInCommitment, Option<Box<HTLCSource>>)> =
5590                                         htlcs.drain(..).map(|(htlc, htlc_source)| (htlc, htlc_source.map(|source_ref| Box::new(source_ref.clone())))).collect();
5591                                 (res, counterparty_commitment_tx, htlcs_no_ref)
5592                         },
5593                         Err(e) => return Err(e),
5594                 };
5595
5596                 if self.announcement_sigs_state == AnnouncementSigsState::MessageSent {
5597                         self.announcement_sigs_state = AnnouncementSigsState::Committed;
5598                 }
5599
5600                 self.latest_monitor_update_id += 1;
5601                 let monitor_update = ChannelMonitorUpdate {
5602                         update_id: self.latest_monitor_update_id,
5603                         updates: vec![ChannelMonitorUpdateStep::LatestCounterpartyCommitmentTXInfo {
5604                                 commitment_txid: counterparty_commitment_txid,
5605                                 htlc_outputs: htlcs.clone(),
5606                                 commitment_number: self.cur_counterparty_commitment_transaction_number,
5607                                 their_per_commitment_point: self.counterparty_cur_commitment_point.unwrap()
5608                         }]
5609                 };
5610                 self.channel_state |= ChannelState::AwaitingRemoteRevoke as u32;
5611                 Ok((res, monitor_update))
5612         }
5613
5614         /// Only fails in case of bad keys. Used for channel_reestablish commitment_signed generation
5615         /// when we shouldn't change HTLC/channel state.
5616         fn send_commitment_no_state_update<L: Deref>(&self, logger: &L) -> Result<(msgs::CommitmentSigned, (Txid, Vec<(HTLCOutputInCommitment, Option<&HTLCSource>)>)), ChannelError> where L::Target: Logger {
5617                 let counterparty_keys = self.build_remote_transaction_keys()?;
5618                 let commitment_stats = self.build_commitment_transaction(self.cur_counterparty_commitment_transaction_number, &counterparty_keys, false, true, logger);
5619                 let counterparty_commitment_txid = commitment_stats.tx.trust().txid();
5620                 let (signature, htlc_signatures);
5621
5622                 #[cfg(any(test, fuzzing))]
5623                 {
5624                         if !self.is_outbound() {
5625                                 let projected_commit_tx_info = self.next_remote_commitment_tx_fee_info_cached.lock().unwrap().take();
5626                                 *self.next_local_commitment_tx_fee_info_cached.lock().unwrap() = None;
5627                                 if let Some(info) = projected_commit_tx_info {
5628                                         let total_pending_htlcs = self.pending_inbound_htlcs.len() + self.pending_outbound_htlcs.len();
5629                                         if info.total_pending_htlcs == total_pending_htlcs
5630                                                 && info.next_holder_htlc_id == self.next_holder_htlc_id
5631                                                 && info.next_counterparty_htlc_id == self.next_counterparty_htlc_id
5632                                                 && info.feerate == self.feerate_per_kw {
5633                                                         let actual_fee = Self::commit_tx_fee_msat(self.feerate_per_kw, commitment_stats.num_nondust_htlcs, self.opt_anchors());
5634                                                         assert_eq!(actual_fee, info.fee);
5635                                                 }
5636                                 }
5637                         }
5638                 }
5639
5640                 {
5641                         let mut htlcs = Vec::with_capacity(commitment_stats.htlcs_included.len());
5642                         for &(ref htlc, _) in commitment_stats.htlcs_included.iter() {
5643                                 htlcs.push(htlc);
5644                         }
5645
5646                         let res = self.holder_signer.sign_counterparty_commitment(&commitment_stats.tx, commitment_stats.preimages, &self.secp_ctx)
5647                                 .map_err(|_| ChannelError::Close("Failed to get signatures for new commitment_signed".to_owned()))?;
5648                         signature = res.0;
5649                         htlc_signatures = res.1;
5650
5651                         log_trace!(logger, "Signed remote commitment tx {} (txid {}) with redeemscript {} -> {} in channel {}",
5652                                 encode::serialize_hex(&commitment_stats.tx.trust().built_transaction().transaction),
5653                                 &counterparty_commitment_txid, encode::serialize_hex(&self.get_funding_redeemscript()),
5654                                 log_bytes!(signature.serialize_compact()[..]), log_bytes!(self.channel_id()));
5655
5656                         for (ref htlc_sig, ref htlc) in htlc_signatures.iter().zip(htlcs) {
5657                                 log_trace!(logger, "Signed remote HTLC tx {} with redeemscript {} with pubkey {} -> {} in channel {}",
5658                                         encode::serialize_hex(&chan_utils::build_htlc_transaction(&counterparty_commitment_txid, commitment_stats.feerate_per_kw, self.get_holder_selected_contest_delay(), htlc, self.opt_anchors(), &counterparty_keys.broadcaster_delayed_payment_key, &counterparty_keys.revocation_key)),
5659                                         encode::serialize_hex(&chan_utils::get_htlc_redeemscript(&htlc, self.opt_anchors(), &counterparty_keys)),
5660                                         log_bytes!(counterparty_keys.broadcaster_htlc_key.serialize()),
5661                                         log_bytes!(htlc_sig.serialize_compact()[..]), log_bytes!(self.channel_id()));
5662                         }
5663                 }
5664
5665                 Ok((msgs::CommitmentSigned {
5666                         channel_id: self.channel_id,
5667                         signature,
5668                         htlc_signatures,
5669                 }, (counterparty_commitment_txid, commitment_stats.htlcs_included)))
5670         }
5671
5672         /// Adds a pending outbound HTLC to this channel, and creates a signed commitment transaction
5673         /// to send to the remote peer in one go.
5674         /// Shorthand for calling send_htlc() followed by send_commitment(), see docs on those for
5675         /// more info.
5676         pub fn send_htlc_and_commit<L: Deref>(&mut self, amount_msat: u64, payment_hash: PaymentHash, cltv_expiry: u32, source: HTLCSource, onion_routing_packet: msgs::OnionPacket, logger: &L) -> Result<Option<(msgs::UpdateAddHTLC, msgs::CommitmentSigned, ChannelMonitorUpdate)>, ChannelError> where L::Target: Logger {
5677                 match self.send_htlc(amount_msat, payment_hash, cltv_expiry, source, onion_routing_packet, logger)? {
5678                         Some(update_add_htlc) => {
5679                                 let (commitment_signed, monitor_update) = self.send_commitment_no_status_check(logger)?;
5680                                 Ok(Some((update_add_htlc, commitment_signed, monitor_update)))
5681                         },
5682                         None => Ok(None)
5683                 }
5684         }
5685
5686         /// Get forwarding information for the counterparty.
5687         pub fn counterparty_forwarding_info(&self) -> Option<CounterpartyForwardingInfo> {
5688                 self.counterparty_forwarding_info.clone()
5689         }
5690
5691         pub fn channel_update(&mut self, msg: &msgs::ChannelUpdate) -> Result<(), ChannelError> {
5692                 if msg.contents.htlc_minimum_msat >= self.channel_value_satoshis * 1000 {
5693                         return Err(ChannelError::Close("Minimum htlc value is greater than channel value".to_string()));
5694                 }
5695                 self.counterparty_forwarding_info = Some(CounterpartyForwardingInfo {
5696                         fee_base_msat: msg.contents.fee_base_msat,
5697                         fee_proportional_millionths: msg.contents.fee_proportional_millionths,
5698                         cltv_expiry_delta: msg.contents.cltv_expiry_delta
5699                 });
5700
5701                 Ok(())
5702         }
5703
5704         /// Begins the shutdown process, getting a message for the remote peer and returning all
5705         /// holding cell HTLCs for payment failure.
5706         pub fn get_shutdown<K: Deref>(&mut self, keys_provider: &K, their_features: &InitFeatures, target_feerate_sats_per_kw: Option<u32>)
5707         -> Result<(msgs::Shutdown, Option<ChannelMonitorUpdate>, Vec<(HTLCSource, PaymentHash)>), APIError>
5708         where K::Target: KeysInterface<Signer = Signer> {
5709                 for htlc in self.pending_outbound_htlcs.iter() {
5710                         if let OutboundHTLCState::LocalAnnounced(_) = htlc.state {
5711                                 return Err(APIError::APIMisuseError{err: "Cannot begin shutdown with pending HTLCs. Process pending events first".to_owned()});
5712                         }
5713                 }
5714                 if self.channel_state & BOTH_SIDES_SHUTDOWN_MASK != 0 {
5715                         if (self.channel_state & ChannelState::LocalShutdownSent as u32) == ChannelState::LocalShutdownSent as u32 {
5716                                 return Err(APIError::APIMisuseError{err: "Shutdown already in progress".to_owned()});
5717                         }
5718                         else if (self.channel_state & ChannelState::RemoteShutdownSent as u32) == ChannelState::RemoteShutdownSent as u32 {
5719                                 return Err(APIError::ChannelUnavailable{err: "Shutdown already in progress by remote".to_owned()});
5720                         }
5721                 }
5722                 assert_eq!(self.channel_state & ChannelState::ShutdownComplete as u32, 0);
5723                 if self.channel_state & (ChannelState::PeerDisconnected as u32 | ChannelState::MonitorUpdateFailed as u32) != 0 {
5724                         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()});
5725                 }
5726
5727                 let update_shutdown_script = match self.shutdown_scriptpubkey {
5728                         Some(_) => false,
5729                         None => {
5730                                 let shutdown_scriptpubkey = keys_provider.get_shutdown_scriptpubkey();
5731                                 if !shutdown_scriptpubkey.is_compatible(their_features) {
5732                                         return Err(APIError::IncompatibleShutdownScript { script: shutdown_scriptpubkey.clone() });
5733                                 }
5734                                 self.shutdown_scriptpubkey = Some(shutdown_scriptpubkey);
5735                                 true
5736                         },
5737                 };
5738
5739                 // From here on out, we may not fail!
5740                 self.target_closing_feerate_sats_per_kw = target_feerate_sats_per_kw;
5741                 if self.channel_state < ChannelState::FundingSent as u32 {
5742                         self.channel_state = ChannelState::ShutdownComplete as u32;
5743                 } else {
5744                         self.channel_state |= ChannelState::LocalShutdownSent as u32;
5745                 }
5746                 self.update_time_counter += 1;
5747
5748                 let monitor_update = if update_shutdown_script {
5749                         self.latest_monitor_update_id += 1;
5750                         Some(ChannelMonitorUpdate {
5751                                 update_id: self.latest_monitor_update_id,
5752                                 updates: vec![ChannelMonitorUpdateStep::ShutdownScript {
5753                                         scriptpubkey: self.get_closing_scriptpubkey(),
5754                                 }],
5755                         })
5756                 } else { None };
5757                 let shutdown = msgs::Shutdown {
5758                         channel_id: self.channel_id,
5759                         scriptpubkey: self.get_closing_scriptpubkey(),
5760                 };
5761
5762                 // Go ahead and drop holding cell updates as we'd rather fail payments than wait to send
5763                 // our shutdown until we've committed all of the pending changes.
5764                 self.holding_cell_update_fee = None;
5765                 let mut dropped_outbound_htlcs = Vec::with_capacity(self.holding_cell_htlc_updates.len());
5766                 self.holding_cell_htlc_updates.retain(|htlc_update| {
5767                         match htlc_update {
5768                                 &HTLCUpdateAwaitingACK::AddHTLC { ref payment_hash, ref source, .. } => {
5769                                         dropped_outbound_htlcs.push((source.clone(), payment_hash.clone()));
5770                                         false
5771                                 },
5772                                 _ => true
5773                         }
5774                 });
5775
5776                 Ok((shutdown, monitor_update, dropped_outbound_htlcs))
5777         }
5778
5779         /// Gets the latest commitment transaction and any dependent transactions for relay (forcing
5780         /// shutdown of this channel - no more calls into this Channel may be made afterwards except
5781         /// those explicitly stated to be allowed after shutdown completes, eg some simple getters).
5782         /// Also returns the list of payment_hashes for channels which we can safely fail backwards
5783         /// immediately (others we will have to allow to time out).
5784         pub fn force_shutdown(&mut self, should_broadcast: bool) -> (Option<(OutPoint, ChannelMonitorUpdate)>, Vec<(HTLCSource, PaymentHash, PublicKey, [u8; 32])>) {
5785                 // Note that we MUST only generate a monitor update that indicates force-closure - we're
5786                 // called during initialization prior to the chain_monitor in the encompassing ChannelManager
5787                 // being fully configured in some cases. Thus, its likely any monitor events we generate will
5788                 // be delayed in being processed! See the docs for `ChannelManagerReadArgs` for more.
5789                 assert!(self.channel_state != ChannelState::ShutdownComplete as u32);
5790
5791                 // We go ahead and "free" any holding cell HTLCs or HTLCs we haven't yet committed to and
5792                 // return them to fail the payment.
5793                 let mut dropped_outbound_htlcs = Vec::with_capacity(self.holding_cell_htlc_updates.len());
5794                 let counterparty_node_id = self.get_counterparty_node_id();
5795                 for htlc_update in self.holding_cell_htlc_updates.drain(..) {
5796                         match htlc_update {
5797                                 HTLCUpdateAwaitingACK::AddHTLC { source, payment_hash, .. } => {
5798                                         dropped_outbound_htlcs.push((source, payment_hash, counterparty_node_id, self.channel_id));
5799                                 },
5800                                 _ => {}
5801                         }
5802                 }
5803                 let monitor_update = if let Some(funding_txo) = self.get_funding_txo() {
5804                         // If we haven't yet exchanged funding signatures (ie channel_state < FundingSent),
5805                         // returning a channel monitor update here would imply a channel monitor update before
5806                         // we even registered the channel monitor to begin with, which is invalid.
5807                         // Thus, if we aren't actually at a point where we could conceivably broadcast the
5808                         // funding transaction, don't return a funding txo (which prevents providing the
5809                         // monitor update to the user, even if we return one).
5810                         // See test_duplicate_chan_id and test_pre_lockin_no_chan_closed_update for more.
5811                         if self.channel_state & (ChannelState::FundingSent as u32 | ChannelState::ChannelFunded as u32 | ChannelState::ShutdownComplete as u32) != 0 {
5812                                 self.latest_monitor_update_id += 1;
5813                                 Some((funding_txo, ChannelMonitorUpdate {
5814                                         update_id: self.latest_monitor_update_id,
5815                                         updates: vec![ChannelMonitorUpdateStep::ChannelForceClosed { should_broadcast }],
5816                                 }))
5817                         } else { None }
5818                 } else { None };
5819
5820                 self.channel_state = ChannelState::ShutdownComplete as u32;
5821                 self.update_time_counter += 1;
5822                 (monitor_update, dropped_outbound_htlcs)
5823         }
5824 }
5825
5826 const SERIALIZATION_VERSION: u8 = 2;
5827 const MIN_SERIALIZATION_VERSION: u8 = 2;
5828
5829 impl_writeable_tlv_based_enum!(InboundHTLCRemovalReason,;
5830         (0, FailRelay),
5831         (1, FailMalformed),
5832         (2, Fulfill),
5833 );
5834
5835 impl Writeable for ChannelUpdateStatus {
5836         fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
5837                 // We only care about writing out the current state as it was announced, ie only either
5838                 // Enabled or Disabled. In the case of DisabledStaged, we most recently announced the
5839                 // channel as enabled, so we write 0. For EnabledStaged, we similarly write a 1.
5840                 match self {
5841                         ChannelUpdateStatus::Enabled => 0u8.write(writer)?,
5842                         ChannelUpdateStatus::DisabledStaged => 0u8.write(writer)?,
5843                         ChannelUpdateStatus::EnabledStaged => 1u8.write(writer)?,
5844                         ChannelUpdateStatus::Disabled => 1u8.write(writer)?,
5845                 }
5846                 Ok(())
5847         }
5848 }
5849
5850 impl Readable for ChannelUpdateStatus {
5851         fn read<R: io::Read>(reader: &mut R) -> Result<Self, DecodeError> {
5852                 Ok(match <u8 as Readable>::read(reader)? {
5853                         0 => ChannelUpdateStatus::Enabled,
5854                         1 => ChannelUpdateStatus::Disabled,
5855                         _ => return Err(DecodeError::InvalidValue),
5856                 })
5857         }
5858 }
5859
5860 impl Writeable for AnnouncementSigsState {
5861         fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
5862                 // We only care about writing out the current state as if we had just disconnected, at
5863                 // which point we always set anything but AnnouncementSigsReceived to NotSent.
5864                 match self {
5865                         AnnouncementSigsState::NotSent => 0u8.write(writer),
5866                         AnnouncementSigsState::MessageSent => 0u8.write(writer),
5867                         AnnouncementSigsState::Committed => 0u8.write(writer),
5868                         AnnouncementSigsState::PeerReceived => 1u8.write(writer),
5869                 }
5870         }
5871 }
5872
5873 impl Readable for AnnouncementSigsState {
5874         fn read<R: io::Read>(reader: &mut R) -> Result<Self, DecodeError> {
5875                 Ok(match <u8 as Readable>::read(reader)? {
5876                         0 => AnnouncementSigsState::NotSent,
5877                         1 => AnnouncementSigsState::PeerReceived,
5878                         _ => return Err(DecodeError::InvalidValue),
5879                 })
5880         }
5881 }
5882
5883 impl<Signer: Sign> Writeable for Channel<Signer> {
5884         fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
5885                 // Note that we write out as if remove_uncommitted_htlcs_and_mark_paused had just been
5886                 // called.
5887
5888                 write_ver_prefix!(writer, SERIALIZATION_VERSION, MIN_SERIALIZATION_VERSION);
5889
5890                 self.user_id.write(writer)?;
5891
5892                 // Version 1 deserializers expected to read parts of the config object here. Version 2
5893                 // deserializers (0.0.99) now read config through TLVs, and as we now require them for
5894                 // `minimum_depth` we simply write dummy values here.
5895                 writer.write_all(&[0; 8])?;
5896
5897                 self.channel_id.write(writer)?;
5898                 (self.channel_state | ChannelState::PeerDisconnected as u32).write(writer)?;
5899                 self.channel_value_satoshis.write(writer)?;
5900
5901                 self.latest_monitor_update_id.write(writer)?;
5902
5903                 let mut key_data = VecWriter(Vec::new());
5904                 self.holder_signer.write(&mut key_data)?;
5905                 assert!(key_data.0.len() < core::usize::MAX);
5906                 assert!(key_data.0.len() < core::u32::MAX as usize);
5907                 (key_data.0.len() as u32).write(writer)?;
5908                 writer.write_all(&key_data.0[..])?;
5909
5910                 // Write out the old serialization for shutdown_pubkey for backwards compatibility, if
5911                 // deserialized from that format.
5912                 match self.shutdown_scriptpubkey.as_ref().and_then(|script| script.as_legacy_pubkey()) {
5913                         Some(shutdown_pubkey) => shutdown_pubkey.write(writer)?,
5914                         None => [0u8; PUBLIC_KEY_SIZE].write(writer)?,
5915                 }
5916                 self.destination_script.write(writer)?;
5917
5918                 self.cur_holder_commitment_transaction_number.write(writer)?;
5919                 self.cur_counterparty_commitment_transaction_number.write(writer)?;
5920                 self.value_to_self_msat.write(writer)?;
5921
5922                 let mut dropped_inbound_htlcs = 0;
5923                 for htlc in self.pending_inbound_htlcs.iter() {
5924                         if let InboundHTLCState::RemoteAnnounced(_) = htlc.state {
5925                                 dropped_inbound_htlcs += 1;
5926                         }
5927                 }
5928                 (self.pending_inbound_htlcs.len() as u64 - dropped_inbound_htlcs).write(writer)?;
5929                 for htlc in self.pending_inbound_htlcs.iter() {
5930                         if let &InboundHTLCState::RemoteAnnounced(_) = &htlc.state {
5931                                 continue; // Drop
5932                         }
5933                         htlc.htlc_id.write(writer)?;
5934                         htlc.amount_msat.write(writer)?;
5935                         htlc.cltv_expiry.write(writer)?;
5936                         htlc.payment_hash.write(writer)?;
5937                         match &htlc.state {
5938                                 &InboundHTLCState::RemoteAnnounced(_) => unreachable!(),
5939                                 &InboundHTLCState::AwaitingRemoteRevokeToAnnounce(ref htlc_state) => {
5940                                         1u8.write(writer)?;
5941                                         htlc_state.write(writer)?;
5942                                 },
5943                                 &InboundHTLCState::AwaitingAnnouncedRemoteRevoke(ref htlc_state) => {
5944                                         2u8.write(writer)?;
5945                                         htlc_state.write(writer)?;
5946                                 },
5947                                 &InboundHTLCState::Committed => {
5948                                         3u8.write(writer)?;
5949                                 },
5950                                 &InboundHTLCState::LocalRemoved(ref removal_reason) => {
5951                                         4u8.write(writer)?;
5952                                         removal_reason.write(writer)?;
5953                                 },
5954                         }
5955                 }
5956
5957                 let mut preimages: Vec<&Option<PaymentPreimage>> = vec![];
5958
5959                 (self.pending_outbound_htlcs.len() as u64).write(writer)?;
5960                 for htlc in self.pending_outbound_htlcs.iter() {
5961                         htlc.htlc_id.write(writer)?;
5962                         htlc.amount_msat.write(writer)?;
5963                         htlc.cltv_expiry.write(writer)?;
5964                         htlc.payment_hash.write(writer)?;
5965                         htlc.source.write(writer)?;
5966                         match &htlc.state {
5967                                 &OutboundHTLCState::LocalAnnounced(ref onion_packet) => {
5968                                         0u8.write(writer)?;
5969                                         onion_packet.write(writer)?;
5970                                 },
5971                                 &OutboundHTLCState::Committed => {
5972                                         1u8.write(writer)?;
5973                                 },
5974                                 &OutboundHTLCState::RemoteRemoved(_) => {
5975                                         // Treat this as a Committed because we haven't received the CS - they'll
5976                                         // resend the claim/fail on reconnect as we all (hopefully) the missing CS.
5977                                         1u8.write(writer)?;
5978                                 },
5979                                 &OutboundHTLCState::AwaitingRemoteRevokeToRemove(ref outcome) => {
5980                                         3u8.write(writer)?;
5981                                         if let OutboundHTLCOutcome::Success(preimage) = outcome {
5982                                                 preimages.push(preimage);
5983                                         }
5984                                         let reason: Option<&HTLCFailReason> = outcome.into();
5985                                         reason.write(writer)?;
5986                                 }
5987                                 &OutboundHTLCState::AwaitingRemovedRemoteRevoke(ref outcome) => {
5988                                         4u8.write(writer)?;
5989                                         if let OutboundHTLCOutcome::Success(preimage) = outcome {
5990                                                 preimages.push(preimage);
5991                                         }
5992                                         let reason: Option<&HTLCFailReason> = outcome.into();
5993                                         reason.write(writer)?;
5994                                 }
5995                         }
5996                 }
5997
5998                 (self.holding_cell_htlc_updates.len() as u64).write(writer)?;
5999                 for update in self.holding_cell_htlc_updates.iter() {
6000                         match update {
6001                                 &HTLCUpdateAwaitingACK::AddHTLC { ref amount_msat, ref cltv_expiry, ref payment_hash, ref source, ref onion_routing_packet } => {
6002                                         0u8.write(writer)?;
6003                                         amount_msat.write(writer)?;
6004                                         cltv_expiry.write(writer)?;
6005                                         payment_hash.write(writer)?;
6006                                         source.write(writer)?;
6007                                         onion_routing_packet.write(writer)?;
6008                                 },
6009                                 &HTLCUpdateAwaitingACK::ClaimHTLC { ref payment_preimage, ref htlc_id } => {
6010                                         1u8.write(writer)?;
6011                                         payment_preimage.write(writer)?;
6012                                         htlc_id.write(writer)?;
6013                                 },
6014                                 &HTLCUpdateAwaitingACK::FailHTLC { ref htlc_id, ref err_packet } => {
6015                                         2u8.write(writer)?;
6016                                         htlc_id.write(writer)?;
6017                                         err_packet.write(writer)?;
6018                                 }
6019                         }
6020                 }
6021
6022                 match self.resend_order {
6023                         RAACommitmentOrder::CommitmentFirst => 0u8.write(writer)?,
6024                         RAACommitmentOrder::RevokeAndACKFirst => 1u8.write(writer)?,
6025                 }
6026
6027                 self.monitor_pending_channel_ready.write(writer)?;
6028                 self.monitor_pending_revoke_and_ack.write(writer)?;
6029                 self.monitor_pending_commitment_signed.write(writer)?;
6030
6031                 (self.monitor_pending_forwards.len() as u64).write(writer)?;
6032                 for &(ref pending_forward, ref htlc_id) in self.monitor_pending_forwards.iter() {
6033                         pending_forward.write(writer)?;
6034                         htlc_id.write(writer)?;
6035                 }
6036
6037                 (self.monitor_pending_failures.len() as u64).write(writer)?;
6038                 for &(ref htlc_source, ref payment_hash, ref fail_reason) in self.monitor_pending_failures.iter() {
6039                         htlc_source.write(writer)?;
6040                         payment_hash.write(writer)?;
6041                         fail_reason.write(writer)?;
6042                 }
6043
6044                 if self.is_outbound() {
6045                         self.pending_update_fee.map(|(a, _)| a).write(writer)?;
6046                 } else if let Some((feerate, FeeUpdateState::AwaitingRemoteRevokeToAnnounce)) = self.pending_update_fee {
6047                         Some(feerate).write(writer)?;
6048                 } else {
6049                         // As for inbound HTLCs, if the update was only announced and never committed in a
6050                         // commitment_signed, drop it.
6051                         None::<u32>.write(writer)?;
6052                 }
6053                 self.holding_cell_update_fee.write(writer)?;
6054
6055                 self.next_holder_htlc_id.write(writer)?;
6056                 (self.next_counterparty_htlc_id - dropped_inbound_htlcs).write(writer)?;
6057                 self.update_time_counter.write(writer)?;
6058                 self.feerate_per_kw.write(writer)?;
6059
6060                 // Versions prior to 0.0.100 expected to read the fields of `last_sent_closing_fee` here,
6061                 // however we are supposed to restart shutdown fee negotiation on reconnect (and wipe
6062                 // `last_send_closing_fee` in `remove_uncommitted_htlcs_and_mark_paused`) so we should never
6063                 // consider the stale state on reload.
6064                 0u8.write(writer)?;
6065
6066                 self.funding_tx_confirmed_in.write(writer)?;
6067                 self.funding_tx_confirmation_height.write(writer)?;
6068                 self.short_channel_id.write(writer)?;
6069
6070                 self.counterparty_dust_limit_satoshis.write(writer)?;
6071                 self.holder_dust_limit_satoshis.write(writer)?;
6072                 self.counterparty_max_htlc_value_in_flight_msat.write(writer)?;
6073
6074                 // Note that this field is ignored by 0.0.99+ as the TLV Optional variant is used instead.
6075                 self.counterparty_selected_channel_reserve_satoshis.unwrap_or(0).write(writer)?;
6076
6077                 self.counterparty_htlc_minimum_msat.write(writer)?;
6078                 self.holder_htlc_minimum_msat.write(writer)?;
6079                 self.counterparty_max_accepted_htlcs.write(writer)?;
6080
6081                 // Note that this field is ignored by 0.0.99+ as the TLV Optional variant is used instead.
6082                 self.minimum_depth.unwrap_or(0).write(writer)?;
6083
6084                 match &self.counterparty_forwarding_info {
6085                         Some(info) => {
6086                                 1u8.write(writer)?;
6087                                 info.fee_base_msat.write(writer)?;
6088                                 info.fee_proportional_millionths.write(writer)?;
6089                                 info.cltv_expiry_delta.write(writer)?;
6090                         },
6091                         None => 0u8.write(writer)?
6092                 }
6093
6094                 self.channel_transaction_parameters.write(writer)?;
6095                 self.funding_transaction.write(writer)?;
6096
6097                 self.counterparty_cur_commitment_point.write(writer)?;
6098                 self.counterparty_prev_commitment_point.write(writer)?;
6099                 self.counterparty_node_id.write(writer)?;
6100
6101                 self.counterparty_shutdown_scriptpubkey.write(writer)?;
6102
6103                 self.commitment_secrets.write(writer)?;
6104
6105                 self.channel_update_status.write(writer)?;
6106
6107                 #[cfg(any(test, fuzzing))]
6108                 (self.historical_inbound_htlc_fulfills.len() as u64).write(writer)?;
6109                 #[cfg(any(test, fuzzing))]
6110                 for htlc in self.historical_inbound_htlc_fulfills.iter() {
6111                         htlc.write(writer)?;
6112                 }
6113
6114                 // If the channel type is something other than only-static-remote-key, then we need to have
6115                 // older clients fail to deserialize this channel at all. If the type is
6116                 // only-static-remote-key, we simply consider it "default" and don't write the channel type
6117                 // out at all.
6118                 let chan_type = if self.channel_type != ChannelTypeFeatures::only_static_remote_key() {
6119                         Some(&self.channel_type) } else { None };
6120
6121                 // The same logic applies for `holder_selected_channel_reserve_satoshis` values other than
6122                 // the default, and when `holder_max_htlc_value_in_flight_msat` is configured to be set to
6123                 // a different percentage of the channel value then 10%, which older versions of LDK used
6124                 // to set it to before the percentage was made configurable.
6125                 let serialized_holder_selected_reserve =
6126                         if self.holder_selected_channel_reserve_satoshis != Self::get_legacy_default_holder_selected_channel_reserve_satoshis(self.channel_value_satoshis)
6127                         { Some(self.holder_selected_channel_reserve_satoshis) } else { None };
6128
6129                 let mut old_max_in_flight_percent_config = UserConfig::default().channel_handshake_config;
6130                 old_max_in_flight_percent_config.max_inbound_htlc_value_in_flight_percent_of_channel = MAX_IN_FLIGHT_PERCENT_LEGACY;
6131                 let serialized_holder_htlc_max_in_flight =
6132                         if self.holder_max_htlc_value_in_flight_msat != Self::get_holder_max_htlc_value_in_flight_msat(self.channel_value_satoshis, &old_max_in_flight_percent_config)
6133                         { Some(self.holder_max_htlc_value_in_flight_msat) } else { None };
6134
6135                 write_tlv_fields!(writer, {
6136                         (0, self.announcement_sigs, option),
6137                         // minimum_depth and counterparty_selected_channel_reserve_satoshis used to have a
6138                         // default value instead of being Option<>al. Thus, to maintain compatibility we write
6139                         // them twice, once with their original default values above, and once as an option
6140                         // here. On the read side, old versions will simply ignore the odd-type entries here,
6141                         // and new versions map the default values to None and allow the TLV entries here to
6142                         // override that.
6143                         (1, self.minimum_depth, option),
6144                         (2, chan_type, option),
6145                         (3, self.counterparty_selected_channel_reserve_satoshis, option),
6146                         (4, serialized_holder_selected_reserve, option),
6147                         (5, self.config, required),
6148                         (6, serialized_holder_htlc_max_in_flight, option),
6149                         (7, self.shutdown_scriptpubkey, option),
6150                         (9, self.target_closing_feerate_sats_per_kw, option),
6151                         (11, self.monitor_pending_finalized_fulfills, vec_type),
6152                         (13, self.channel_creation_height, required),
6153                         (15, preimages, vec_type),
6154                         (17, self.announcement_sigs_state, required),
6155                         (19, self.latest_inbound_scid_alias, option),
6156                         (21, self.outbound_scid_alias, required),
6157                 });
6158
6159                 Ok(())
6160         }
6161 }
6162
6163 const MAX_ALLOC_SIZE: usize = 64*1024;
6164 impl<'a, Signer: Sign, K: Deref> ReadableArgs<(&'a K, u32)> for Channel<Signer>
6165                 where K::Target: KeysInterface<Signer = Signer> {
6166         fn read<R : io::Read>(reader: &mut R, args: (&'a K, u32)) -> Result<Self, DecodeError> {
6167                 let (keys_source, serialized_height) = args;
6168                 let ver = read_ver_prefix!(reader, SERIALIZATION_VERSION);
6169
6170                 let user_id = Readable::read(reader)?;
6171
6172                 let mut config = Some(LegacyChannelConfig::default());
6173                 if ver == 1 {
6174                         // Read the old serialization of the ChannelConfig from version 0.0.98.
6175                         config.as_mut().unwrap().options.forwarding_fee_proportional_millionths = Readable::read(reader)?;
6176                         config.as_mut().unwrap().options.cltv_expiry_delta = Readable::read(reader)?;
6177                         config.as_mut().unwrap().announced_channel = Readable::read(reader)?;
6178                         config.as_mut().unwrap().commit_upfront_shutdown_pubkey = Readable::read(reader)?;
6179                 } else {
6180                         // Read the 8 bytes of backwards-compatibility ChannelConfig data.
6181                         let mut _val: u64 = Readable::read(reader)?;
6182                 }
6183
6184                 let channel_id = Readable::read(reader)?;
6185                 let channel_state = Readable::read(reader)?;
6186                 let channel_value_satoshis = Readable::read(reader)?;
6187
6188                 let latest_monitor_update_id = Readable::read(reader)?;
6189
6190                 let keys_len: u32 = Readable::read(reader)?;
6191                 let mut keys_data = Vec::with_capacity(cmp::min(keys_len as usize, MAX_ALLOC_SIZE));
6192                 while keys_data.len() != keys_len as usize {
6193                         // Read 1KB at a time to avoid accidentally allocating 4GB on corrupted channel keys
6194                         let mut data = [0; 1024];
6195                         let read_slice = &mut data[0..cmp::min(1024, keys_len as usize - keys_data.len())];
6196                         reader.read_exact(read_slice)?;
6197                         keys_data.extend_from_slice(read_slice);
6198                 }
6199                 let holder_signer = keys_source.read_chan_signer(&keys_data)?;
6200
6201                 // Read the old serialization for shutdown_pubkey, preferring the TLV field later if set.
6202                 let mut shutdown_scriptpubkey = match <PublicKey as Readable>::read(reader) {
6203                         Ok(pubkey) => Some(ShutdownScript::new_p2wpkh_from_pubkey(pubkey)),
6204                         Err(_) => None,
6205                 };
6206                 let destination_script = Readable::read(reader)?;
6207
6208                 let cur_holder_commitment_transaction_number = Readable::read(reader)?;
6209                 let cur_counterparty_commitment_transaction_number = Readable::read(reader)?;
6210                 let value_to_self_msat = Readable::read(reader)?;
6211
6212                 let pending_inbound_htlc_count: u64 = Readable::read(reader)?;
6213                 let mut pending_inbound_htlcs = Vec::with_capacity(cmp::min(pending_inbound_htlc_count as usize, OUR_MAX_HTLCS as usize));
6214                 for _ in 0..pending_inbound_htlc_count {
6215                         pending_inbound_htlcs.push(InboundHTLCOutput {
6216                                 htlc_id: Readable::read(reader)?,
6217                                 amount_msat: Readable::read(reader)?,
6218                                 cltv_expiry: Readable::read(reader)?,
6219                                 payment_hash: Readable::read(reader)?,
6220                                 state: match <u8 as Readable>::read(reader)? {
6221                                         1 => InboundHTLCState::AwaitingRemoteRevokeToAnnounce(Readable::read(reader)?),
6222                                         2 => InboundHTLCState::AwaitingAnnouncedRemoteRevoke(Readable::read(reader)?),
6223                                         3 => InboundHTLCState::Committed,
6224                                         4 => InboundHTLCState::LocalRemoved(Readable::read(reader)?),
6225                                         _ => return Err(DecodeError::InvalidValue),
6226                                 },
6227                         });
6228                 }
6229
6230                 let pending_outbound_htlc_count: u64 = Readable::read(reader)?;
6231                 let mut pending_outbound_htlcs = Vec::with_capacity(cmp::min(pending_outbound_htlc_count as usize, OUR_MAX_HTLCS as usize));
6232                 for _ in 0..pending_outbound_htlc_count {
6233                         pending_outbound_htlcs.push(OutboundHTLCOutput {
6234                                 htlc_id: Readable::read(reader)?,
6235                                 amount_msat: Readable::read(reader)?,
6236                                 cltv_expiry: Readable::read(reader)?,
6237                                 payment_hash: Readable::read(reader)?,
6238                                 source: Readable::read(reader)?,
6239                                 state: match <u8 as Readable>::read(reader)? {
6240                                         0 => OutboundHTLCState::LocalAnnounced(Box::new(Readable::read(reader)?)),
6241                                         1 => OutboundHTLCState::Committed,
6242                                         2 => {
6243                                                 let option: Option<HTLCFailReason> = Readable::read(reader)?;
6244                                                 OutboundHTLCState::RemoteRemoved(option.into())
6245                                         },
6246                                         3 => {
6247                                                 let option: Option<HTLCFailReason> = Readable::read(reader)?;
6248                                                 OutboundHTLCState::AwaitingRemoteRevokeToRemove(option.into())
6249                                         },
6250                                         4 => {
6251                                                 let option: Option<HTLCFailReason> = Readable::read(reader)?;
6252                                                 OutboundHTLCState::AwaitingRemovedRemoteRevoke(option.into())
6253                                         },
6254                                         _ => return Err(DecodeError::InvalidValue),
6255                                 },
6256                         });
6257                 }
6258
6259                 let holding_cell_htlc_update_count: u64 = Readable::read(reader)?;
6260                 let mut holding_cell_htlc_updates = Vec::with_capacity(cmp::min(holding_cell_htlc_update_count as usize, OUR_MAX_HTLCS as usize*2));
6261                 for _ in 0..holding_cell_htlc_update_count {
6262                         holding_cell_htlc_updates.push(match <u8 as Readable>::read(reader)? {
6263                                 0 => HTLCUpdateAwaitingACK::AddHTLC {
6264                                         amount_msat: Readable::read(reader)?,
6265                                         cltv_expiry: Readable::read(reader)?,
6266                                         payment_hash: Readable::read(reader)?,
6267                                         source: Readable::read(reader)?,
6268                                         onion_routing_packet: Readable::read(reader)?,
6269                                 },
6270                                 1 => HTLCUpdateAwaitingACK::ClaimHTLC {
6271                                         payment_preimage: Readable::read(reader)?,
6272                                         htlc_id: Readable::read(reader)?,
6273                                 },
6274                                 2 => HTLCUpdateAwaitingACK::FailHTLC {
6275                                         htlc_id: Readable::read(reader)?,
6276                                         err_packet: Readable::read(reader)?,
6277                                 },
6278                                 _ => return Err(DecodeError::InvalidValue),
6279                         });
6280                 }
6281
6282                 let resend_order = match <u8 as Readable>::read(reader)? {
6283                         0 => RAACommitmentOrder::CommitmentFirst,
6284                         1 => RAACommitmentOrder::RevokeAndACKFirst,
6285                         _ => return Err(DecodeError::InvalidValue),
6286                 };
6287
6288                 let monitor_pending_channel_ready = Readable::read(reader)?;
6289                 let monitor_pending_revoke_and_ack = Readable::read(reader)?;
6290                 let monitor_pending_commitment_signed = Readable::read(reader)?;
6291
6292                 let monitor_pending_forwards_count: u64 = Readable::read(reader)?;
6293                 let mut monitor_pending_forwards = Vec::with_capacity(cmp::min(monitor_pending_forwards_count as usize, OUR_MAX_HTLCS as usize));
6294                 for _ in 0..monitor_pending_forwards_count {
6295                         monitor_pending_forwards.push((Readable::read(reader)?, Readable::read(reader)?));
6296                 }
6297
6298                 let monitor_pending_failures_count: u64 = Readable::read(reader)?;
6299                 let mut monitor_pending_failures = Vec::with_capacity(cmp::min(monitor_pending_failures_count as usize, OUR_MAX_HTLCS as usize));
6300                 for _ in 0..monitor_pending_failures_count {
6301                         monitor_pending_failures.push((Readable::read(reader)?, Readable::read(reader)?, Readable::read(reader)?));
6302                 }
6303
6304                 let pending_update_fee_value: Option<u32> = Readable::read(reader)?;
6305
6306                 let holding_cell_update_fee = Readable::read(reader)?;
6307
6308                 let next_holder_htlc_id = Readable::read(reader)?;
6309                 let next_counterparty_htlc_id = Readable::read(reader)?;
6310                 let update_time_counter = Readable::read(reader)?;
6311                 let feerate_per_kw = Readable::read(reader)?;
6312
6313                 // Versions prior to 0.0.100 expected to read the fields of `last_sent_closing_fee` here,
6314                 // however we are supposed to restart shutdown fee negotiation on reconnect (and wipe
6315                 // `last_send_closing_fee` in `remove_uncommitted_htlcs_and_mark_paused`) so we should never
6316                 // consider the stale state on reload.
6317                 match <u8 as Readable>::read(reader)? {
6318                         0 => {},
6319                         1 => {
6320                                 let _: u32 = Readable::read(reader)?;
6321                                 let _: u64 = Readable::read(reader)?;
6322                                 let _: Signature = Readable::read(reader)?;
6323                         },
6324                         _ => return Err(DecodeError::InvalidValue),
6325                 }
6326
6327                 let funding_tx_confirmed_in = Readable::read(reader)?;
6328                 let funding_tx_confirmation_height = Readable::read(reader)?;
6329                 let short_channel_id = Readable::read(reader)?;
6330
6331                 let counterparty_dust_limit_satoshis = Readable::read(reader)?;
6332                 let holder_dust_limit_satoshis = Readable::read(reader)?;
6333                 let counterparty_max_htlc_value_in_flight_msat = Readable::read(reader)?;
6334                 let mut counterparty_selected_channel_reserve_satoshis = None;
6335                 if ver == 1 {
6336                         // Read the old serialization from version 0.0.98.
6337                         counterparty_selected_channel_reserve_satoshis = Some(Readable::read(reader)?);
6338                 } else {
6339                         // Read the 8 bytes of backwards-compatibility data.
6340                         let _dummy: u64 = Readable::read(reader)?;
6341                 }
6342                 let counterparty_htlc_minimum_msat = Readable::read(reader)?;
6343                 let holder_htlc_minimum_msat = Readable::read(reader)?;
6344                 let counterparty_max_accepted_htlcs = Readable::read(reader)?;
6345
6346                 let mut minimum_depth = None;
6347                 if ver == 1 {
6348                         // Read the old serialization from version 0.0.98.
6349                         minimum_depth = Some(Readable::read(reader)?);
6350                 } else {
6351                         // Read the 4 bytes of backwards-compatibility data.
6352                         let _dummy: u32 = Readable::read(reader)?;
6353                 }
6354
6355                 let counterparty_forwarding_info = match <u8 as Readable>::read(reader)? {
6356                         0 => None,
6357                         1 => Some(CounterpartyForwardingInfo {
6358                                 fee_base_msat: Readable::read(reader)?,
6359                                 fee_proportional_millionths: Readable::read(reader)?,
6360                                 cltv_expiry_delta: Readable::read(reader)?,
6361                         }),
6362                         _ => return Err(DecodeError::InvalidValue),
6363                 };
6364
6365                 let channel_parameters: ChannelTransactionParameters = Readable::read(reader)?;
6366                 let funding_transaction = Readable::read(reader)?;
6367
6368                 let counterparty_cur_commitment_point = Readable::read(reader)?;
6369
6370                 let counterparty_prev_commitment_point = Readable::read(reader)?;
6371                 let counterparty_node_id = Readable::read(reader)?;
6372
6373                 let counterparty_shutdown_scriptpubkey = Readable::read(reader)?;
6374                 let commitment_secrets = Readable::read(reader)?;
6375
6376                 let channel_update_status = Readable::read(reader)?;
6377
6378                 #[cfg(any(test, fuzzing))]
6379                 let mut historical_inbound_htlc_fulfills = HashSet::new();
6380                 #[cfg(any(test, fuzzing))]
6381                 {
6382                         let htlc_fulfills_len: u64 = Readable::read(reader)?;
6383                         for _ in 0..htlc_fulfills_len {
6384                                 assert!(historical_inbound_htlc_fulfills.insert(Readable::read(reader)?));
6385                         }
6386                 }
6387
6388                 let pending_update_fee = if let Some(feerate) = pending_update_fee_value {
6389                         Some((feerate, if channel_parameters.is_outbound_from_holder {
6390                                 FeeUpdateState::Outbound
6391                         } else {
6392                                 FeeUpdateState::AwaitingRemoteRevokeToAnnounce
6393                         }))
6394                 } else {
6395                         None
6396                 };
6397
6398                 let mut announcement_sigs = None;
6399                 let mut target_closing_feerate_sats_per_kw = None;
6400                 let mut monitor_pending_finalized_fulfills = Some(Vec::new());
6401                 let mut holder_selected_channel_reserve_satoshis = Some(Self::get_legacy_default_holder_selected_channel_reserve_satoshis(channel_value_satoshis));
6402                 let mut holder_max_htlc_value_in_flight_msat = Some(Self::get_holder_max_htlc_value_in_flight_msat(channel_value_satoshis, &UserConfig::default().channel_handshake_config));
6403                 // Prior to supporting channel type negotiation, all of our channels were static_remotekey
6404                 // only, so we default to that if none was written.
6405                 let mut channel_type = Some(ChannelTypeFeatures::only_static_remote_key());
6406                 let mut channel_creation_height = Some(serialized_height);
6407                 let mut preimages_opt: Option<Vec<Option<PaymentPreimage>>> = None;
6408
6409                 // If we read an old Channel, for simplicity we just treat it as "we never sent an
6410                 // AnnouncementSignatures" which implies we'll re-send it on reconnect, but that's fine.
6411                 let mut announcement_sigs_state = Some(AnnouncementSigsState::NotSent);
6412                 let mut latest_inbound_scid_alias = None;
6413                 let mut outbound_scid_alias = None;
6414
6415                 read_tlv_fields!(reader, {
6416                         (0, announcement_sigs, option),
6417                         (1, minimum_depth, option),
6418                         (2, channel_type, option),
6419                         (3, counterparty_selected_channel_reserve_satoshis, option),
6420                         (4, holder_selected_channel_reserve_satoshis, option),
6421                         (5, config, option), // Note that if none is provided we will *not* overwrite the existing one.
6422                         (6, holder_max_htlc_value_in_flight_msat, option),
6423                         (7, shutdown_scriptpubkey, option),
6424                         (9, target_closing_feerate_sats_per_kw, option),
6425                         (11, monitor_pending_finalized_fulfills, vec_type),
6426                         (13, channel_creation_height, option),
6427                         (15, preimages_opt, vec_type),
6428                         (17, announcement_sigs_state, option),
6429                         (19, latest_inbound_scid_alias, option),
6430                         (21, outbound_scid_alias, option),
6431                 });
6432
6433                 if let Some(preimages) = preimages_opt {
6434                         let mut iter = preimages.into_iter();
6435                         for htlc in pending_outbound_htlcs.iter_mut() {
6436                                 match &htlc.state {
6437                                         OutboundHTLCState::AwaitingRemoteRevokeToRemove(OutboundHTLCOutcome::Success(None)) => {
6438                                                 htlc.state = OutboundHTLCState::AwaitingRemoteRevokeToRemove(OutboundHTLCOutcome::Success(iter.next().ok_or(DecodeError::InvalidValue)?));
6439                                         }
6440                                         OutboundHTLCState::AwaitingRemovedRemoteRevoke(OutboundHTLCOutcome::Success(None)) => {
6441                                                 htlc.state = OutboundHTLCState::AwaitingRemovedRemoteRevoke(OutboundHTLCOutcome::Success(iter.next().ok_or(DecodeError::InvalidValue)?));
6442                                         }
6443                                         _ => {}
6444                                 }
6445                         }
6446                         // We expect all preimages to be consumed above
6447                         if iter.next().is_some() {
6448                                 return Err(DecodeError::InvalidValue);
6449                         }
6450                 }
6451
6452                 let chan_features = channel_type.as_ref().unwrap();
6453                 if chan_features.supports_unknown_bits() || chan_features.requires_unknown_bits() {
6454                         // If the channel was written by a new version and negotiated with features we don't
6455                         // understand yet, refuse to read it.
6456                         return Err(DecodeError::UnknownRequiredFeature);
6457                 }
6458
6459                 if channel_parameters.opt_anchors.is_some() {
6460                         // Relax this check when ChannelTypeFeatures supports anchors.
6461                         return Err(DecodeError::InvalidValue);
6462                 }
6463
6464                 let mut secp_ctx = Secp256k1::new();
6465                 secp_ctx.seeded_randomize(&keys_source.get_secure_random_bytes());
6466
6467                 Ok(Channel {
6468                         user_id,
6469
6470                         config: config.unwrap(),
6471
6472                         prev_config: None,
6473
6474                         // Note that we don't care about serializing handshake limits as we only ever serialize
6475                         // channel data after the handshake has completed.
6476                         inbound_handshake_limits_override: None,
6477
6478                         channel_id,
6479                         channel_state,
6480                         announcement_sigs_state: announcement_sigs_state.unwrap(),
6481                         secp_ctx,
6482                         channel_value_satoshis,
6483
6484                         latest_monitor_update_id,
6485
6486                         holder_signer,
6487                         shutdown_scriptpubkey,
6488                         destination_script,
6489
6490                         cur_holder_commitment_transaction_number,
6491                         cur_counterparty_commitment_transaction_number,
6492                         value_to_self_msat,
6493
6494                         pending_inbound_htlcs,
6495                         pending_outbound_htlcs,
6496                         holding_cell_htlc_updates,
6497
6498                         resend_order,
6499
6500                         monitor_pending_channel_ready,
6501                         monitor_pending_revoke_and_ack,
6502                         monitor_pending_commitment_signed,
6503                         monitor_pending_forwards,
6504                         monitor_pending_failures,
6505                         monitor_pending_finalized_fulfills: monitor_pending_finalized_fulfills.unwrap(),
6506
6507                         pending_update_fee,
6508                         holding_cell_update_fee,
6509                         next_holder_htlc_id,
6510                         next_counterparty_htlc_id,
6511                         update_time_counter,
6512                         feerate_per_kw,
6513
6514                         #[cfg(debug_assertions)]
6515                         holder_max_commitment_tx_output: Mutex::new((0, 0)),
6516                         #[cfg(debug_assertions)]
6517                         counterparty_max_commitment_tx_output: Mutex::new((0, 0)),
6518
6519                         last_sent_closing_fee: None,
6520                         pending_counterparty_closing_signed: None,
6521                         closing_fee_limits: None,
6522                         target_closing_feerate_sats_per_kw,
6523
6524                         inbound_awaiting_accept: false,
6525
6526                         funding_tx_confirmed_in,
6527                         funding_tx_confirmation_height,
6528                         short_channel_id,
6529                         channel_creation_height: channel_creation_height.unwrap(),
6530
6531                         counterparty_dust_limit_satoshis,
6532                         holder_dust_limit_satoshis,
6533                         counterparty_max_htlc_value_in_flight_msat,
6534                         holder_max_htlc_value_in_flight_msat: holder_max_htlc_value_in_flight_msat.unwrap(),
6535                         counterparty_selected_channel_reserve_satoshis,
6536                         holder_selected_channel_reserve_satoshis: holder_selected_channel_reserve_satoshis.unwrap(),
6537                         counterparty_htlc_minimum_msat,
6538                         holder_htlc_minimum_msat,
6539                         counterparty_max_accepted_htlcs,
6540                         minimum_depth,
6541
6542                         counterparty_forwarding_info,
6543
6544                         channel_transaction_parameters: channel_parameters,
6545                         funding_transaction,
6546
6547                         counterparty_cur_commitment_point,
6548                         counterparty_prev_commitment_point,
6549                         counterparty_node_id,
6550
6551                         counterparty_shutdown_scriptpubkey,
6552
6553                         commitment_secrets,
6554
6555                         channel_update_status,
6556                         closing_signed_in_flight: false,
6557
6558                         announcement_sigs,
6559
6560                         #[cfg(any(test, fuzzing))]
6561                         next_local_commitment_tx_fee_info_cached: Mutex::new(None),
6562                         #[cfg(any(test, fuzzing))]
6563                         next_remote_commitment_tx_fee_info_cached: Mutex::new(None),
6564
6565                         workaround_lnd_bug_4006: None,
6566
6567                         latest_inbound_scid_alias,
6568                         // Later in the ChannelManager deserialization phase we scan for channels and assign scid aliases if its missing
6569                         outbound_scid_alias: outbound_scid_alias.unwrap_or(0),
6570
6571                         #[cfg(any(test, fuzzing))]
6572                         historical_inbound_htlc_fulfills,
6573
6574                         channel_type: channel_type.unwrap(),
6575                 })
6576         }
6577 }
6578
6579 #[cfg(test)]
6580 mod tests {
6581         use std::cmp;
6582         use bitcoin::blockdata::script::{Script, Builder};
6583         use bitcoin::blockdata::transaction::{Transaction, TxOut};
6584         use bitcoin::blockdata::constants::genesis_block;
6585         use bitcoin::blockdata::opcodes;
6586         use bitcoin::network::constants::Network;
6587         use hex;
6588         use ln::PaymentHash;
6589         use ln::channelmanager::{HTLCSource, PaymentId};
6590         use ln::channel::{Channel, InboundHTLCOutput, OutboundHTLCOutput, InboundHTLCState, OutboundHTLCState, HTLCCandidate, HTLCInitiator};
6591         use ln::channel::{MAX_FUNDING_SATOSHIS_NO_WUMBO, TOTAL_BITCOIN_SUPPLY_SATOSHIS, MIN_THEIR_CHAN_RESERVE_SATOSHIS};
6592         use ln::features::{InitFeatures, ChannelTypeFeatures};
6593         use ln::msgs::{ChannelUpdate, DataLossProtect, DecodeError, OptionalField, UnsignedChannelUpdate, MAX_VALUE_MSAT};
6594         use ln::script::ShutdownScript;
6595         use ln::chan_utils;
6596         use ln::chan_utils::{htlc_success_tx_weight, htlc_timeout_tx_weight};
6597         use chain::BestBlock;
6598         use chain::chaininterface::{FeeEstimator, LowerBoundedFeeEstimator, ConfirmationTarget};
6599         use chain::keysinterface::{InMemorySigner, Recipient, KeyMaterial, KeysInterface};
6600         use chain::transaction::OutPoint;
6601         use util::config::UserConfig;
6602         use util::enforcing_trait_impls::EnforcingSigner;
6603         use util::errors::APIError;
6604         use util::test_utils;
6605         use util::test_utils::OnGetShutdownScriptpubkey;
6606         use bitcoin::secp256k1::{Secp256k1, ecdsa::Signature};
6607         use bitcoin::secp256k1::ffi::Signature as FFISignature;
6608         use bitcoin::secp256k1::{SecretKey,PublicKey};
6609         use bitcoin::secp256k1::ecdh::SharedSecret;
6610         use bitcoin::secp256k1::ecdsa::RecoverableSignature;
6611         use bitcoin::hashes::sha256::Hash as Sha256;
6612         use bitcoin::hashes::Hash;
6613         use bitcoin::hash_types::WPubkeyHash;
6614         use bitcoin::bech32::u5;
6615         use bitcoin::PackedLockTime;
6616         use bitcoin::util::address::WitnessVersion;
6617         use prelude::*;
6618
6619         struct TestFeeEstimator {
6620                 fee_est: u32
6621         }
6622         impl FeeEstimator for TestFeeEstimator {
6623                 fn get_est_sat_per_1000_weight(&self, _: ConfirmationTarget) -> u32 {
6624                         self.fee_est
6625                 }
6626         }
6627
6628         #[test]
6629         fn test_max_funding_satoshis_no_wumbo() {
6630                 assert_eq!(TOTAL_BITCOIN_SUPPLY_SATOSHIS, 21_000_000 * 100_000_000);
6631                 assert!(MAX_FUNDING_SATOSHIS_NO_WUMBO <= TOTAL_BITCOIN_SUPPLY_SATOSHIS,
6632                         "MAX_FUNDING_SATOSHIS_NO_WUMBO is greater than all satoshis in existence");
6633         }
6634
6635         #[test]
6636         fn test_no_fee_check_overflow() {
6637                 // Previously, calling `check_remote_fee` with a fee of 0xffffffff would overflow in
6638                 // arithmetic, causing a panic with debug assertions enabled.
6639                 let fee_est = TestFeeEstimator { fee_est: 42 };
6640                 let bounded_fee_estimator = LowerBoundedFeeEstimator::new(&fee_est);
6641                 assert!(Channel::<InMemorySigner>::check_remote_fee(&bounded_fee_estimator, u32::max_value()).is_err());
6642         }
6643
6644         struct Keys {
6645                 signer: InMemorySigner,
6646         }
6647         impl KeysInterface for Keys {
6648                 type Signer = InMemorySigner;
6649
6650                 fn get_node_secret(&self, _recipient: Recipient) -> Result<SecretKey, ()> { panic!(); }
6651                 fn ecdh(&self, _recipient: Recipient, _other_key: &PublicKey, _tweak: Option<&[u8; 32]>) -> Result<SharedSecret, ()> { panic!(); }
6652                 fn get_inbound_payment_key_material(&self) -> KeyMaterial { panic!(); }
6653                 fn get_destination_script(&self) -> Script {
6654                         let secp_ctx = Secp256k1::signing_only();
6655                         let channel_monitor_claim_key = SecretKey::from_slice(&hex::decode("0fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff").unwrap()[..]).unwrap();
6656                         let channel_monitor_claim_key_hash = WPubkeyHash::hash(&PublicKey::from_secret_key(&secp_ctx, &channel_monitor_claim_key).serialize());
6657                         Builder::new().push_opcode(opcodes::all::OP_PUSHBYTES_0).push_slice(&channel_monitor_claim_key_hash[..]).into_script()
6658                 }
6659
6660                 fn get_shutdown_scriptpubkey(&self) -> ShutdownScript {
6661                         let secp_ctx = Secp256k1::signing_only();
6662                         let channel_close_key = SecretKey::from_slice(&hex::decode("0fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff").unwrap()[..]).unwrap();
6663                         ShutdownScript::new_p2wpkh_from_pubkey(PublicKey::from_secret_key(&secp_ctx, &channel_close_key))
6664                 }
6665
6666                 fn get_channel_signer(&self, _inbound: bool, _channel_value_satoshis: u64) -> InMemorySigner {
6667                         self.signer.clone()
6668                 }
6669                 fn get_secure_random_bytes(&self) -> [u8; 32] { [0; 32] }
6670                 fn read_chan_signer(&self, _data: &[u8]) -> Result<Self::Signer, DecodeError> { panic!(); }
6671                 fn sign_invoice(&self, _hrp_bytes: &[u8], _invoice_data: &[u5], _recipient: Recipient) -> Result<RecoverableSignature, ()> { panic!(); }
6672         }
6673
6674         #[cfg(not(feature = "grind_signatures"))]
6675         fn public_from_secret_hex(secp_ctx: &Secp256k1<bitcoin::secp256k1::All>, hex: &str) -> PublicKey {
6676                 PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&hex::decode(hex).unwrap()[..]).unwrap())
6677         }
6678
6679         #[test]
6680         fn upfront_shutdown_script_incompatibility() {
6681                 let features = InitFeatures::known().clear_shutdown_anysegwit();
6682                 let non_v0_segwit_shutdown_script =
6683                         ShutdownScript::new_witness_program(WitnessVersion::V16, &[0, 40]).unwrap();
6684
6685                 let seed = [42; 32];
6686                 let network = Network::Testnet;
6687                 let keys_provider = test_utils::TestKeysInterface::new(&seed, network);
6688                 keys_provider.expect(OnGetShutdownScriptpubkey {
6689                         returns: non_v0_segwit_shutdown_script.clone(),
6690                 });
6691
6692                 let secp_ctx = Secp256k1::new();
6693                 let node_id = PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[42; 32]).unwrap());
6694                 let config = UserConfig::default();
6695                 match Channel::<EnforcingSigner>::new_outbound(&LowerBoundedFeeEstimator::new(&TestFeeEstimator { fee_est: 253 }), &&keys_provider, node_id, &features, 10000000, 100000, 42, &config, 0, 42) {
6696                         Err(APIError::IncompatibleShutdownScript { script }) => {
6697                                 assert_eq!(script.into_inner(), non_v0_segwit_shutdown_script.into_inner());
6698                         },
6699                         Err(e) => panic!("Unexpected error: {:?}", e),
6700                         Ok(_) => panic!("Expected error"),
6701                 }
6702         }
6703
6704         // Check that, during channel creation, we use the same feerate in the open channel message
6705         // as we do in the Channel object creation itself.
6706         #[test]
6707         fn test_open_channel_msg_fee() {
6708                 let original_fee = 253;
6709                 let mut fee_est = TestFeeEstimator{fee_est: original_fee };
6710                 let bounded_fee_estimator = LowerBoundedFeeEstimator::new(&fee_est);
6711                 let secp_ctx = Secp256k1::new();
6712                 let seed = [42; 32];
6713                 let network = Network::Testnet;
6714                 let keys_provider = test_utils::TestKeysInterface::new(&seed, network);
6715
6716                 let node_a_node_id = PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[42; 32]).unwrap());
6717                 let config = UserConfig::default();
6718                 let node_a_chan = Channel::<EnforcingSigner>::new_outbound(&bounded_fee_estimator, &&keys_provider, node_a_node_id, &InitFeatures::known(), 10000000, 100000, 42, &config, 0, 42).unwrap();
6719
6720                 // Now change the fee so we can check that the fee in the open_channel message is the
6721                 // same as the old fee.
6722                 fee_est.fee_est = 500;
6723                 let open_channel_msg = node_a_chan.get_open_channel(genesis_block(network).header.block_hash());
6724                 assert_eq!(open_channel_msg.feerate_per_kw, original_fee);
6725         }
6726
6727         #[test]
6728         fn test_holder_vs_counterparty_dust_limit() {
6729                 // Test that when calculating the local and remote commitment transaction fees, the correct
6730                 // dust limits are used.
6731                 let feeest = LowerBoundedFeeEstimator::new(&TestFeeEstimator{fee_est: 15000});
6732                 let secp_ctx = Secp256k1::new();
6733                 let seed = [42; 32];
6734                 let network = Network::Testnet;
6735                 let keys_provider = test_utils::TestKeysInterface::new(&seed, network);
6736                 let logger = test_utils::TestLogger::new();
6737
6738                 // Go through the flow of opening a channel between two nodes, making sure
6739                 // they have different dust limits.
6740
6741                 // Create Node A's channel pointing to Node B's pubkey
6742                 let node_b_node_id = PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[42; 32]).unwrap());
6743                 let config = UserConfig::default();
6744                 let mut node_a_chan = Channel::<EnforcingSigner>::new_outbound(&feeest, &&keys_provider, node_b_node_id, &InitFeatures::known(), 10000000, 100000, 42, &config, 0, 42).unwrap();
6745
6746                 // Create Node B's channel by receiving Node A's open_channel message
6747                 // Make sure A's dust limit is as we expect.
6748                 let open_channel_msg = node_a_chan.get_open_channel(genesis_block(network).header.block_hash());
6749                 let node_b_node_id = PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[7; 32]).unwrap());
6750                 let mut node_b_chan = Channel::<EnforcingSigner>::new_from_req(&feeest, &&keys_provider, node_b_node_id, &InitFeatures::known(), &open_channel_msg, 7, &config, 0, &&logger, 42).unwrap();
6751
6752                 // Node B --> Node A: accept channel, explicitly setting B's dust limit.
6753                 let mut accept_channel_msg = node_b_chan.accept_inbound_channel(0);
6754                 accept_channel_msg.dust_limit_satoshis = 546;
6755                 node_a_chan.accept_channel(&accept_channel_msg, &config.channel_handshake_limits, &InitFeatures::known()).unwrap();
6756                 node_a_chan.holder_dust_limit_satoshis = 1560;
6757
6758                 // Put some inbound and outbound HTLCs in A's channel.
6759                 let htlc_amount_msat = 11_092_000; // put an amount below A's effective dust limit but above B's.
6760                 node_a_chan.pending_inbound_htlcs.push(InboundHTLCOutput {
6761                         htlc_id: 0,
6762                         amount_msat: htlc_amount_msat,
6763                         payment_hash: PaymentHash(Sha256::hash(&[42; 32]).into_inner()),
6764                         cltv_expiry: 300000000,
6765                         state: InboundHTLCState::Committed,
6766                 });
6767
6768                 node_a_chan.pending_outbound_htlcs.push(OutboundHTLCOutput {
6769                         htlc_id: 1,
6770                         amount_msat: htlc_amount_msat, // put an amount below A's dust amount but above B's.
6771                         payment_hash: PaymentHash(Sha256::hash(&[43; 32]).into_inner()),
6772                         cltv_expiry: 200000000,
6773                         state: OutboundHTLCState::Committed,
6774                         source: HTLCSource::OutboundRoute {
6775                                 path: Vec::new(),
6776                                 session_priv: SecretKey::from_slice(&hex::decode("0fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff").unwrap()[..]).unwrap(),
6777                                 first_hop_htlc_msat: 548,
6778                                 payment_id: PaymentId([42; 32]),
6779                                 payment_secret: None,
6780                                 payment_params: None,
6781                         }
6782                 });
6783
6784                 // Make sure when Node A calculates their local commitment transaction, none of the HTLCs pass
6785                 // the dust limit check.
6786                 let htlc_candidate = HTLCCandidate::new(htlc_amount_msat, HTLCInitiator::LocalOffered);
6787                 let local_commit_tx_fee = node_a_chan.next_local_commit_tx_fee_msat(htlc_candidate, None);
6788                 let local_commit_fee_0_htlcs = Channel::<EnforcingSigner>::commit_tx_fee_msat(node_a_chan.feerate_per_kw, 0, node_a_chan.opt_anchors());
6789                 assert_eq!(local_commit_tx_fee, local_commit_fee_0_htlcs);
6790
6791                 // Finally, make sure that when Node A calculates the remote's commitment transaction fees, all
6792                 // of the HTLCs are seen to be above the dust limit.
6793                 node_a_chan.channel_transaction_parameters.is_outbound_from_holder = false;
6794                 let remote_commit_fee_3_htlcs = Channel::<EnforcingSigner>::commit_tx_fee_msat(node_a_chan.feerate_per_kw, 3, node_a_chan.opt_anchors());
6795                 let htlc_candidate = HTLCCandidate::new(htlc_amount_msat, HTLCInitiator::LocalOffered);
6796                 let remote_commit_tx_fee = node_a_chan.next_remote_commit_tx_fee_msat(htlc_candidate, None);
6797                 assert_eq!(remote_commit_tx_fee, remote_commit_fee_3_htlcs);
6798         }
6799
6800         #[test]
6801         fn test_timeout_vs_success_htlc_dust_limit() {
6802                 // Make sure that when `next_remote_commit_tx_fee_msat` and `next_local_commit_tx_fee_msat`
6803                 // calculate the real dust limits for HTLCs (i.e. the dust limit given by the counterparty
6804                 // *plus* the fees paid for the HTLC) they don't swap `HTLC_SUCCESS_TX_WEIGHT` for
6805                 // `HTLC_TIMEOUT_TX_WEIGHT`, and vice versa.
6806                 let fee_est = LowerBoundedFeeEstimator::new(&TestFeeEstimator{fee_est: 253 });
6807                 let secp_ctx = Secp256k1::new();
6808                 let seed = [42; 32];
6809                 let network = Network::Testnet;
6810                 let keys_provider = test_utils::TestKeysInterface::new(&seed, network);
6811
6812                 let node_id = PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[42; 32]).unwrap());
6813                 let config = UserConfig::default();
6814                 let mut chan = Channel::<EnforcingSigner>::new_outbound(&fee_est, &&keys_provider, node_id, &InitFeatures::known(), 10000000, 100000, 42, &config, 0, 42).unwrap();
6815
6816                 let commitment_tx_fee_0_htlcs = Channel::<EnforcingSigner>::commit_tx_fee_msat(chan.feerate_per_kw, 0, chan.opt_anchors());
6817                 let commitment_tx_fee_1_htlc = Channel::<EnforcingSigner>::commit_tx_fee_msat(chan.feerate_per_kw, 1, chan.opt_anchors());
6818
6819                 // If HTLC_SUCCESS_TX_WEIGHT and HTLC_TIMEOUT_TX_WEIGHT were swapped: then this HTLC would be
6820                 // counted as dust when it shouldn't be.
6821                 let htlc_amt_above_timeout = ((253 * htlc_timeout_tx_weight(chan.opt_anchors()) / 1000) + chan.holder_dust_limit_satoshis + 1) * 1000;
6822                 let htlc_candidate = HTLCCandidate::new(htlc_amt_above_timeout, HTLCInitiator::LocalOffered);
6823                 let commitment_tx_fee = chan.next_local_commit_tx_fee_msat(htlc_candidate, None);
6824                 assert_eq!(commitment_tx_fee, commitment_tx_fee_1_htlc);
6825
6826                 // If swapped: this HTLC would be counted as non-dust when it shouldn't be.
6827                 let dust_htlc_amt_below_success = ((253 * htlc_success_tx_weight(chan.opt_anchors()) / 1000) + chan.holder_dust_limit_satoshis - 1) * 1000;
6828                 let htlc_candidate = HTLCCandidate::new(dust_htlc_amt_below_success, HTLCInitiator::RemoteOffered);
6829                 let commitment_tx_fee = chan.next_local_commit_tx_fee_msat(htlc_candidate, None);
6830                 assert_eq!(commitment_tx_fee, commitment_tx_fee_0_htlcs);
6831
6832                 chan.channel_transaction_parameters.is_outbound_from_holder = false;
6833
6834                 // If swapped: this HTLC would be counted as non-dust when it shouldn't be.
6835                 let dust_htlc_amt_above_timeout = ((253 * htlc_timeout_tx_weight(chan.opt_anchors()) / 1000) + chan.counterparty_dust_limit_satoshis + 1) * 1000;
6836                 let htlc_candidate = HTLCCandidate::new(dust_htlc_amt_above_timeout, HTLCInitiator::LocalOffered);
6837                 let commitment_tx_fee = chan.next_remote_commit_tx_fee_msat(htlc_candidate, None);
6838                 assert_eq!(commitment_tx_fee, commitment_tx_fee_0_htlcs);
6839
6840                 // If swapped: this HTLC would be counted as dust when it shouldn't be.
6841                 let htlc_amt_below_success = ((253 * htlc_success_tx_weight(chan.opt_anchors()) / 1000) + chan.counterparty_dust_limit_satoshis - 1) * 1000;
6842                 let htlc_candidate = HTLCCandidate::new(htlc_amt_below_success, HTLCInitiator::RemoteOffered);
6843                 let commitment_tx_fee = chan.next_remote_commit_tx_fee_msat(htlc_candidate, None);
6844                 assert_eq!(commitment_tx_fee, commitment_tx_fee_1_htlc);
6845         }
6846
6847         #[test]
6848         fn channel_reestablish_no_updates() {
6849                 let feeest = LowerBoundedFeeEstimator::new(&TestFeeEstimator{fee_est: 15000});
6850                 let logger = test_utils::TestLogger::new();
6851                 let secp_ctx = Secp256k1::new();
6852                 let seed = [42; 32];
6853                 let network = Network::Testnet;
6854                 let best_block = BestBlock::from_genesis(network);
6855                 let chain_hash = best_block.block_hash();
6856                 let keys_provider = test_utils::TestKeysInterface::new(&seed, network);
6857
6858                 // Go through the flow of opening a channel between two nodes.
6859
6860                 // Create Node A's channel pointing to Node B's pubkey
6861                 let node_b_node_id = PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[42; 32]).unwrap());
6862                 let config = UserConfig::default();
6863                 let mut node_a_chan = Channel::<EnforcingSigner>::new_outbound(&feeest, &&keys_provider, node_b_node_id, &InitFeatures::known(), 10000000, 100000, 42, &config, 0, 42).unwrap();
6864
6865                 // Create Node B's channel by receiving Node A's open_channel message
6866                 let open_channel_msg = node_a_chan.get_open_channel(chain_hash);
6867                 let node_b_node_id = PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[7; 32]).unwrap());
6868                 let mut node_b_chan = Channel::<EnforcingSigner>::new_from_req(&feeest, &&keys_provider, node_b_node_id, &InitFeatures::known(), &open_channel_msg, 7, &config, 0, &&logger, 42).unwrap();
6869
6870                 // Node B --> Node A: accept channel
6871                 let accept_channel_msg = node_b_chan.accept_inbound_channel(0);
6872                 node_a_chan.accept_channel(&accept_channel_msg, &config.channel_handshake_limits, &InitFeatures::known()).unwrap();
6873
6874                 // Node A --> Node B: funding created
6875                 let output_script = node_a_chan.get_funding_redeemscript();
6876                 let tx = Transaction { version: 1, lock_time: PackedLockTime::ZERO, input: Vec::new(), output: vec![TxOut {
6877                         value: 10000000, script_pubkey: output_script.clone(),
6878                 }]};
6879                 let funding_outpoint = OutPoint{ txid: tx.txid(), index: 0 };
6880                 let funding_created_msg = node_a_chan.get_outbound_funding_created(tx.clone(), funding_outpoint, &&logger).unwrap();
6881                 let (funding_signed_msg, _, _) = node_b_chan.funding_created(&funding_created_msg, best_block, &&logger).unwrap();
6882
6883                 // Node B --> Node A: funding signed
6884                 let _ = node_a_chan.funding_signed(&funding_signed_msg, best_block, &&logger);
6885
6886                 // Now disconnect the two nodes and check that the commitment point in
6887                 // Node B's channel_reestablish message is sane.
6888                 node_b_chan.remove_uncommitted_htlcs_and_mark_paused(&&logger);
6889                 let msg = node_b_chan.get_channel_reestablish(&&logger);
6890                 assert_eq!(msg.next_local_commitment_number, 1); // now called next_commitment_number
6891                 assert_eq!(msg.next_remote_commitment_number, 0); // now called next_revocation_number
6892                 match msg.data_loss_protect {
6893                         OptionalField::Present(DataLossProtect { your_last_per_commitment_secret, .. }) => {
6894                                 assert_eq!(your_last_per_commitment_secret, [0; 32]);
6895                         },
6896                         _ => panic!()
6897                 }
6898
6899                 // Check that the commitment point in Node A's channel_reestablish message
6900                 // is sane.
6901                 node_a_chan.remove_uncommitted_htlcs_and_mark_paused(&&logger);
6902                 let msg = node_a_chan.get_channel_reestablish(&&logger);
6903                 assert_eq!(msg.next_local_commitment_number, 1); // now called next_commitment_number
6904                 assert_eq!(msg.next_remote_commitment_number, 0); // now called next_revocation_number
6905                 match msg.data_loss_protect {
6906                         OptionalField::Present(DataLossProtect { your_last_per_commitment_secret, .. }) => {
6907                                 assert_eq!(your_last_per_commitment_secret, [0; 32]);
6908                         },
6909                         _ => panic!()
6910                 }
6911         }
6912
6913         #[test]
6914         fn test_configured_holder_max_htlc_value_in_flight() {
6915                 let feeest = LowerBoundedFeeEstimator::new(&TestFeeEstimator{fee_est: 15000});
6916                 let logger = test_utils::TestLogger::new();
6917                 let secp_ctx = Secp256k1::new();
6918                 let seed = [42; 32];
6919                 let network = Network::Testnet;
6920                 let keys_provider = test_utils::TestKeysInterface::new(&seed, network);
6921                 let outbound_node_id = PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[42; 32]).unwrap());
6922                 let inbound_node_id = PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[7; 32]).unwrap());
6923
6924                 let mut config_2_percent = UserConfig::default();
6925                 config_2_percent.channel_handshake_config.max_inbound_htlc_value_in_flight_percent_of_channel = 2;
6926                 let mut config_99_percent = UserConfig::default();
6927                 config_99_percent.channel_handshake_config.max_inbound_htlc_value_in_flight_percent_of_channel = 99;
6928                 let mut config_0_percent = UserConfig::default();
6929                 config_0_percent.channel_handshake_config.max_inbound_htlc_value_in_flight_percent_of_channel = 0;
6930                 let mut config_101_percent = UserConfig::default();
6931                 config_101_percent.channel_handshake_config.max_inbound_htlc_value_in_flight_percent_of_channel = 101;
6932
6933                 // Test that `new_outbound` creates a channel with the correct value for
6934                 // `holder_max_htlc_value_in_flight_msat`, when configured with a valid percentage value,
6935                 // which is set to the lower bound + 1 (2%) of the `channel_value`.
6936                 let chan_1 = Channel::<EnforcingSigner>::new_outbound(&feeest, &&keys_provider, outbound_node_id, &InitFeatures::known(), 10000000, 100000, 42, &config_2_percent, 0, 42).unwrap();
6937                 let chan_1_value_msat = chan_1.channel_value_satoshis * 1000;
6938                 assert_eq!(chan_1.holder_max_htlc_value_in_flight_msat, (chan_1_value_msat as f64 * 0.02) as u64);
6939
6940                 // Test with the upper bound - 1 of valid values (99%).
6941                 let chan_2 = Channel::<EnforcingSigner>::new_outbound(&feeest, &&keys_provider, outbound_node_id, &InitFeatures::known(), 10000000, 100000, 42, &config_99_percent, 0, 42).unwrap();
6942                 let chan_2_value_msat = chan_2.channel_value_satoshis * 1000;
6943                 assert_eq!(chan_2.holder_max_htlc_value_in_flight_msat, (chan_2_value_msat as f64 * 0.99) as u64);
6944
6945                 let chan_1_open_channel_msg = chan_1.get_open_channel(genesis_block(network).header.block_hash());
6946
6947                 // Test that `new_from_req` creates a channel with the correct value for
6948                 // `holder_max_htlc_value_in_flight_msat`, when configured with a valid percentage value,
6949                 // which is set to the lower bound - 1 (2%) of the `channel_value`.
6950                 let chan_3 = Channel::<EnforcingSigner>::new_from_req(&feeest, &&keys_provider, inbound_node_id, &InitFeatures::known(), &chan_1_open_channel_msg, 7, &config_2_percent, 0, &&logger, 42).unwrap();
6951                 let chan_3_value_msat = chan_3.channel_value_satoshis * 1000;
6952                 assert_eq!(chan_3.holder_max_htlc_value_in_flight_msat, (chan_3_value_msat as f64 * 0.02) as u64);
6953
6954                 // Test with the upper bound - 1 of valid values (99%).
6955                 let chan_4 = Channel::<EnforcingSigner>::new_from_req(&feeest, &&keys_provider, inbound_node_id, &InitFeatures::known(), &chan_1_open_channel_msg, 7, &config_99_percent, 0, &&logger, 42).unwrap();
6956                 let chan_4_value_msat = chan_4.channel_value_satoshis * 1000;
6957                 assert_eq!(chan_4.holder_max_htlc_value_in_flight_msat, (chan_4_value_msat as f64 * 0.99) as u64);
6958
6959                 // Test that `new_outbound` uses the lower bound of the configurable percentage values (1%)
6960                 // if `max_inbound_htlc_value_in_flight_percent_of_channel` is set to a value less than 1.
6961                 let chan_5 = Channel::<EnforcingSigner>::new_outbound(&feeest, &&keys_provider, outbound_node_id, &InitFeatures::known(), 10000000, 100000, 42, &config_0_percent, 0, 42).unwrap();
6962                 let chan_5_value_msat = chan_5.channel_value_satoshis * 1000;
6963                 assert_eq!(chan_5.holder_max_htlc_value_in_flight_msat, (chan_5_value_msat as f64 * 0.01) as u64);
6964
6965                 // Test that `new_outbound` uses the upper bound of the configurable percentage values
6966                 // (100%) if `max_inbound_htlc_value_in_flight_percent_of_channel` is set to a larger value
6967                 // than 100.
6968                 let chan_6 = Channel::<EnforcingSigner>::new_outbound(&feeest, &&keys_provider, outbound_node_id, &InitFeatures::known(), 10000000, 100000, 42, &config_101_percent, 0, 42).unwrap();
6969                 let chan_6_value_msat = chan_6.channel_value_satoshis * 1000;
6970                 assert_eq!(chan_6.holder_max_htlc_value_in_flight_msat, chan_6_value_msat);
6971
6972                 // Test that `new_from_req` uses the lower bound of the configurable percentage values (1%)
6973                 // if `max_inbound_htlc_value_in_flight_percent_of_channel` is set to a value less than 1.
6974                 let chan_7 = Channel::<EnforcingSigner>::new_from_req(&feeest, &&keys_provider, inbound_node_id, &InitFeatures::known(), &chan_1_open_channel_msg, 7, &config_0_percent, 0, &&logger, 42).unwrap();
6975                 let chan_7_value_msat = chan_7.channel_value_satoshis * 1000;
6976                 assert_eq!(chan_7.holder_max_htlc_value_in_flight_msat, (chan_7_value_msat as f64 * 0.01) as u64);
6977
6978                 // Test that `new_from_req` uses the upper bound of the configurable percentage values
6979                 // (100%) if `max_inbound_htlc_value_in_flight_percent_of_channel` is set to a larger value
6980                 // than 100.
6981                 let chan_8 = Channel::<EnforcingSigner>::new_from_req(&feeest, &&keys_provider, inbound_node_id, &InitFeatures::known(), &chan_1_open_channel_msg, 7, &config_101_percent, 0, &&logger, 42).unwrap();
6982                 let chan_8_value_msat = chan_8.channel_value_satoshis * 1000;
6983                 assert_eq!(chan_8.holder_max_htlc_value_in_flight_msat, chan_8_value_msat);
6984         }
6985
6986         #[test]
6987         fn test_configured_holder_selected_channel_reserve_satoshis() {
6988
6989                 // Test that `new_outbound` and `new_from_req` create a channel with the correct
6990                 // channel reserves, when `their_channel_reserve_proportional_millionths` is configured.
6991                 test_self_and_counterparty_channel_reserve(10_000_000, 0.02, 0.02);
6992
6993                 // Test with valid but unreasonably high channel reserves
6994                 // Requesting and accepting parties have requested for 49%-49% and 60%-30% channel reserve
6995                 test_self_and_counterparty_channel_reserve(10_000_000, 0.49, 0.49);
6996                 test_self_and_counterparty_channel_reserve(10_000_000, 0.60, 0.30);
6997
6998                 // Test with calculated channel reserve less than lower bound
6999                 // i.e `MIN_THEIR_CHAN_RESERVE_SATOSHIS`
7000                 test_self_and_counterparty_channel_reserve(100_000, 0.00002, 0.30);
7001
7002                 // Test with invalid channel reserves since sum of both is greater than or equal
7003                 // to channel value
7004                 test_self_and_counterparty_channel_reserve(10_000_000, 0.50, 0.50);
7005                 test_self_and_counterparty_channel_reserve(10_000_000, 0.60, 0.50);
7006         }
7007
7008         fn test_self_and_counterparty_channel_reserve(channel_value_satoshis: u64, outbound_selected_channel_reserve_perc: f64, inbound_selected_channel_reserve_perc: f64) {
7009                 let fee_est = LowerBoundedFeeEstimator::new(&TestFeeEstimator { fee_est: 15_000 });
7010                 let logger = test_utils::TestLogger::new();
7011                 let secp_ctx = Secp256k1::new();
7012                 let seed = [42; 32];
7013                 let network = Network::Testnet;
7014                 let keys_provider = test_utils::TestKeysInterface::new(&seed, network);
7015                 let outbound_node_id = PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[42; 32]).unwrap());
7016                 let inbound_node_id = PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[7; 32]).unwrap());
7017
7018
7019                 let mut outbound_node_config = UserConfig::default();
7020                 outbound_node_config.channel_handshake_config.their_channel_reserve_proportional_millionths = (outbound_selected_channel_reserve_perc * 1_000_000.0) as u32;
7021                 let chan = Channel::<EnforcingSigner>::new_outbound(&&fee_est, &&keys_provider, outbound_node_id, &InitFeatures::known(), channel_value_satoshis, 100_000, 42, &outbound_node_config, 0, 42).unwrap();
7022
7023                 let expected_outbound_selected_chan_reserve = cmp::max(MIN_THEIR_CHAN_RESERVE_SATOSHIS, (chan.channel_value_satoshis as f64 * outbound_selected_channel_reserve_perc) as u64);
7024                 assert_eq!(chan.holder_selected_channel_reserve_satoshis, expected_outbound_selected_chan_reserve);
7025
7026                 let chan_open_channel_msg = chan.get_open_channel(genesis_block(network).header.block_hash());
7027                 let mut inbound_node_config = UserConfig::default();
7028                 inbound_node_config.channel_handshake_config.their_channel_reserve_proportional_millionths = (inbound_selected_channel_reserve_perc * 1_000_000.0) as u32;
7029
7030                 if outbound_selected_channel_reserve_perc + inbound_selected_channel_reserve_perc < 1.0 {
7031                         let chan_inbound_node = Channel::<EnforcingSigner>::new_from_req(&&fee_est, &&keys_provider, inbound_node_id, &InitFeatures::known(), &chan_open_channel_msg, 7, &inbound_node_config, 0, &&logger, 42).unwrap();
7032
7033                         let expected_inbound_selected_chan_reserve = cmp::max(MIN_THEIR_CHAN_RESERVE_SATOSHIS, (chan.channel_value_satoshis as f64 * inbound_selected_channel_reserve_perc) as u64);
7034
7035                         assert_eq!(chan_inbound_node.holder_selected_channel_reserve_satoshis, expected_inbound_selected_chan_reserve);
7036                         assert_eq!(chan_inbound_node.counterparty_selected_channel_reserve_satoshis.unwrap(), expected_outbound_selected_chan_reserve);
7037                 } else {
7038                         // Channel Negotiations failed
7039                         let result = Channel::<EnforcingSigner>::new_from_req(&&fee_est, &&keys_provider, inbound_node_id, &InitFeatures::known(), &chan_open_channel_msg, 7, &inbound_node_config, 0, &&logger, 42);
7040                         assert!(result.is_err());
7041                 }
7042         }
7043
7044         #[test]
7045         fn channel_update() {
7046                 let feeest = LowerBoundedFeeEstimator::new(&TestFeeEstimator{fee_est: 15000});
7047                 let secp_ctx = Secp256k1::new();
7048                 let seed = [42; 32];
7049                 let network = Network::Testnet;
7050                 let chain_hash = genesis_block(network).header.block_hash();
7051                 let keys_provider = test_utils::TestKeysInterface::new(&seed, network);
7052
7053                 // Create a channel.
7054                 let node_b_node_id = PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[42; 32]).unwrap());
7055                 let config = UserConfig::default();
7056                 let mut node_a_chan = Channel::<EnforcingSigner>::new_outbound(&feeest, &&keys_provider, node_b_node_id, &InitFeatures::known(), 10000000, 100000, 42, &config, 0, 42).unwrap();
7057                 assert!(node_a_chan.counterparty_forwarding_info.is_none());
7058                 assert_eq!(node_a_chan.holder_htlc_minimum_msat, 1); // the default
7059                 assert!(node_a_chan.counterparty_forwarding_info().is_none());
7060
7061                 // Make sure that receiving a channel update will update the Channel as expected.
7062                 let update = ChannelUpdate {
7063                         contents: UnsignedChannelUpdate {
7064                                 chain_hash,
7065                                 short_channel_id: 0,
7066                                 timestamp: 0,
7067                                 flags: 0,
7068                                 cltv_expiry_delta: 100,
7069                                 htlc_minimum_msat: 5,
7070                                 htlc_maximum_msat: MAX_VALUE_MSAT,
7071                                 fee_base_msat: 110,
7072                                 fee_proportional_millionths: 11,
7073                                 excess_data: Vec::new(),
7074                         },
7075                         signature: Signature::from(unsafe { FFISignature::new() })
7076                 };
7077                 node_a_chan.channel_update(&update).unwrap();
7078
7079                 // The counterparty can send an update with a higher minimum HTLC, but that shouldn't
7080                 // change our official htlc_minimum_msat.
7081                 assert_eq!(node_a_chan.holder_htlc_minimum_msat, 1);
7082                 match node_a_chan.counterparty_forwarding_info() {
7083                         Some(info) => {
7084                                 assert_eq!(info.cltv_expiry_delta, 100);
7085                                 assert_eq!(info.fee_base_msat, 110);
7086                                 assert_eq!(info.fee_proportional_millionths, 11);
7087                         },
7088                         None => panic!("expected counterparty forwarding info to be Some")
7089                 }
7090         }
7091
7092         #[cfg(not(feature = "grind_signatures"))]
7093         #[test]
7094         fn outbound_commitment_test() {
7095                 use bitcoin::util::sighash;
7096                 use bitcoin::consensus::encode::serialize;
7097                 use bitcoin::blockdata::transaction::EcdsaSighashType;
7098                 use bitcoin::hashes::hex::FromHex;
7099                 use bitcoin::hash_types::Txid;
7100                 use bitcoin::secp256k1::Message;
7101                 use chain::keysinterface::BaseSign;
7102                 use ln::PaymentPreimage;
7103                 use ln::channel::{HTLCOutputInCommitment ,TxCreationKeys};
7104                 use ln::chan_utils::{ChannelPublicKeys, HolderCommitmentTransaction, CounterpartyChannelTransactionParameters};
7105                 use util::logger::Logger;
7106                 use sync::Arc;
7107
7108                 // Test vectors from BOLT 3 Appendices C and F (anchors):
7109                 let feeest = TestFeeEstimator{fee_est: 15000};
7110                 let logger : Arc<Logger> = Arc::new(test_utils::TestLogger::new());
7111                 let secp_ctx = Secp256k1::new();
7112
7113                 let mut signer = InMemorySigner::new(
7114                         &secp_ctx,
7115                         SecretKey::from_slice(&hex::decode("4242424242424242424242424242424242424242424242424242424242424242").unwrap()[..]).unwrap(),
7116                         SecretKey::from_slice(&hex::decode("30ff4956bbdd3222d44cc5e8a1261dab1e07957bdac5ae88fe3261ef321f3749").unwrap()[..]).unwrap(),
7117                         SecretKey::from_slice(&hex::decode("0fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff").unwrap()[..]).unwrap(),
7118                         SecretKey::from_slice(&hex::decode("1111111111111111111111111111111111111111111111111111111111111111").unwrap()[..]).unwrap(),
7119                         SecretKey::from_slice(&hex::decode("3333333333333333333333333333333333333333333333333333333333333333").unwrap()[..]).unwrap(),
7120                         SecretKey::from_slice(&hex::decode("1111111111111111111111111111111111111111111111111111111111111111").unwrap()[..]).unwrap(),
7121
7122                         // These aren't set in the test vectors:
7123                         [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],
7124                         10_000_000,
7125                         [0; 32]
7126                 );
7127
7128                 assert_eq!(signer.pubkeys().funding_pubkey.serialize()[..],
7129                                 hex::decode("023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb").unwrap()[..]);
7130                 let keys_provider = Keys { signer: signer.clone() };
7131
7132                 let counterparty_node_id = PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[42; 32]).unwrap());
7133                 let mut config = UserConfig::default();
7134                 config.channel_handshake_config.announced_channel = false;
7135                 let mut chan = Channel::<InMemorySigner>::new_outbound(&LowerBoundedFeeEstimator::new(&feeest), &&keys_provider, counterparty_node_id, &InitFeatures::known(), 10_000_000, 100000, 42, &config, 0, 42).unwrap(); // Nothing uses their network key in this test
7136                 chan.holder_dust_limit_satoshis = 546;
7137                 chan.counterparty_selected_channel_reserve_satoshis = Some(0); // Filled in in accept_channel
7138
7139                 let funding_info = OutPoint{ txid: Txid::from_hex("8984484a580b825b9972d7adb15050b3ab624ccd731946b3eeddb92f4e7ef6be").unwrap(), index: 0 };
7140
7141                 let counterparty_pubkeys = ChannelPublicKeys {
7142                         funding_pubkey: public_from_secret_hex(&secp_ctx, "1552dfba4f6cf29a62a0af13c8d6981d36d0ef8d61ba10fb0fe90da7634d7e13"),
7143                         revocation_basepoint: PublicKey::from_slice(&hex::decode("02466d7fcae563e5cb09a0d1870bb580344804617879a14949cf22285f1bae3f27").unwrap()[..]).unwrap(),
7144                         payment_point: public_from_secret_hex(&secp_ctx, "4444444444444444444444444444444444444444444444444444444444444444"),
7145                         delayed_payment_basepoint: public_from_secret_hex(&secp_ctx, "1552dfba4f6cf29a62a0af13c8d6981d36d0ef8d61ba10fb0fe90da7634d7e13"),
7146                         htlc_basepoint: public_from_secret_hex(&secp_ctx, "4444444444444444444444444444444444444444444444444444444444444444")
7147                 };
7148                 chan.channel_transaction_parameters.counterparty_parameters = Some(
7149                         CounterpartyChannelTransactionParameters {
7150                                 pubkeys: counterparty_pubkeys.clone(),
7151                                 selected_contest_delay: 144
7152                         });
7153                 chan.channel_transaction_parameters.funding_outpoint = Some(funding_info);
7154                 signer.ready_channel(&chan.channel_transaction_parameters);
7155
7156                 assert_eq!(counterparty_pubkeys.payment_point.serialize()[..],
7157                            hex::decode("032c0b7cf95324a07d05398b240174dc0c2be444d96b159aa6c7f7b1e668680991").unwrap()[..]);
7158
7159                 assert_eq!(counterparty_pubkeys.funding_pubkey.serialize()[..],
7160                            hex::decode("030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c1").unwrap()[..]);
7161
7162                 assert_eq!(counterparty_pubkeys.htlc_basepoint.serialize()[..],
7163                            hex::decode("032c0b7cf95324a07d05398b240174dc0c2be444d96b159aa6c7f7b1e668680991").unwrap()[..]);
7164
7165                 // We can't just use build_holder_transaction_keys here as the per_commitment_secret is not
7166                 // derived from a commitment_seed, so instead we copy it here and call
7167                 // build_commitment_transaction.
7168                 let delayed_payment_base = &chan.holder_signer.pubkeys().delayed_payment_basepoint;
7169                 let per_commitment_secret = SecretKey::from_slice(&hex::decode("1f1e1d1c1b1a191817161514131211100f0e0d0c0b0a09080706050403020100").unwrap()[..]).unwrap();
7170                 let per_commitment_point = PublicKey::from_secret_key(&secp_ctx, &per_commitment_secret);
7171                 let htlc_basepoint = &chan.holder_signer.pubkeys().htlc_basepoint;
7172                 let keys = TxCreationKeys::derive_new(&secp_ctx, &per_commitment_point, delayed_payment_base, htlc_basepoint, &counterparty_pubkeys.revocation_basepoint, &counterparty_pubkeys.htlc_basepoint).unwrap();
7173
7174                 macro_rules! test_commitment {
7175                         ( $counterparty_sig_hex: expr, $sig_hex: expr, $tx_hex: expr, $($remain:tt)* ) => {
7176                                 chan.channel_transaction_parameters.opt_anchors = None;
7177                                 test_commitment_common!($counterparty_sig_hex, $sig_hex, $tx_hex, false, $($remain)*);
7178                         };
7179                 }
7180
7181                 macro_rules! test_commitment_with_anchors {
7182                         ( $counterparty_sig_hex: expr, $sig_hex: expr, $tx_hex: expr, $($remain:tt)* ) => {
7183                                 chan.channel_transaction_parameters.opt_anchors = Some(());
7184                                 test_commitment_common!($counterparty_sig_hex, $sig_hex, $tx_hex, true, $($remain)*);
7185                         };
7186                 }
7187
7188                 macro_rules! test_commitment_common {
7189                         ( $counterparty_sig_hex: expr, $sig_hex: expr, $tx_hex: expr, $opt_anchors: expr, {
7190                                 $( { $htlc_idx: expr, $counterparty_htlc_sig_hex: expr, $htlc_sig_hex: expr, $htlc_tx_hex: expr } ), *
7191                         } ) => { {
7192                                 let (commitment_tx, htlcs): (_, Vec<HTLCOutputInCommitment>) = {
7193                                         let mut commitment_stats = chan.build_commitment_transaction(0xffffffffffff - 42, &keys, true, false, &logger);
7194
7195                                         let htlcs = commitment_stats.htlcs_included.drain(..)
7196                                                 .filter_map(|(htlc, _)| if htlc.transaction_output_index.is_some() { Some(htlc) } else { None })
7197                                                 .collect();
7198                                         (commitment_stats.tx, htlcs)
7199                                 };
7200                                 let trusted_tx = commitment_tx.trust();
7201                                 let unsigned_tx = trusted_tx.built_transaction();
7202                                 let redeemscript = chan.get_funding_redeemscript();
7203                                 let counterparty_signature = Signature::from_der(&hex::decode($counterparty_sig_hex).unwrap()[..]).unwrap();
7204                                 let sighash = unsigned_tx.get_sighash_all(&redeemscript, chan.channel_value_satoshis);
7205                                 log_trace!(logger, "unsigned_tx = {}", hex::encode(serialize(&unsigned_tx.transaction)));
7206                                 assert!(secp_ctx.verify_ecdsa(&sighash, &counterparty_signature, chan.counterparty_funding_pubkey()).is_ok(), "verify counterparty commitment sig");
7207
7208                                 let mut per_htlc: Vec<(HTLCOutputInCommitment, Option<Signature>)> = Vec::new();
7209                                 per_htlc.clear(); // Don't warn about excess mut for no-HTLC calls
7210                                 let mut counterparty_htlc_sigs = Vec::new();
7211                                 counterparty_htlc_sigs.clear(); // Don't warn about excess mut for no-HTLC calls
7212                                 $({
7213                                         let remote_signature = Signature::from_der(&hex::decode($counterparty_htlc_sig_hex).unwrap()[..]).unwrap();
7214                                         per_htlc.push((htlcs[$htlc_idx].clone(), Some(remote_signature)));
7215                                         counterparty_htlc_sigs.push(remote_signature);
7216                                 })*
7217                                 assert_eq!(htlcs.len(), per_htlc.len());
7218
7219                                 let holder_commitment_tx = HolderCommitmentTransaction::new(
7220                                         commitment_tx.clone(),
7221                                         counterparty_signature,
7222                                         counterparty_htlc_sigs,
7223                                         &chan.holder_signer.pubkeys().funding_pubkey,
7224                                         chan.counterparty_funding_pubkey()
7225                                 );
7226                                 let (holder_sig, htlc_sigs) = signer.sign_holder_commitment_and_htlcs(&holder_commitment_tx, &secp_ctx).unwrap();
7227                                 assert_eq!(Signature::from_der(&hex::decode($sig_hex).unwrap()[..]).unwrap(), holder_sig, "holder_sig");
7228
7229                                 let funding_redeemscript = chan.get_funding_redeemscript();
7230                                 let tx = holder_commitment_tx.add_holder_sig(&funding_redeemscript, holder_sig);
7231                                 assert_eq!(serialize(&tx)[..], hex::decode($tx_hex).unwrap()[..], "tx");
7232
7233                                 // ((htlc, counterparty_sig), (index, holder_sig))
7234                                 let mut htlc_sig_iter = holder_commitment_tx.htlcs().iter().zip(&holder_commitment_tx.counterparty_htlc_sigs).zip(htlc_sigs.iter().enumerate());
7235
7236                                 $({
7237                                         log_trace!(logger, "verifying htlc {}", $htlc_idx);
7238                                         let remote_signature = Signature::from_der(&hex::decode($counterparty_htlc_sig_hex).unwrap()[..]).unwrap();
7239
7240                                         let ref htlc = htlcs[$htlc_idx];
7241                                         let htlc_tx = chan_utils::build_htlc_transaction(&unsigned_tx.txid, chan.feerate_per_kw,
7242                                                 chan.get_counterparty_selected_contest_delay().unwrap(),
7243                                                 &htlc, $opt_anchors, &keys.broadcaster_delayed_payment_key, &keys.revocation_key);
7244                                         let htlc_redeemscript = chan_utils::get_htlc_redeemscript(&htlc, $opt_anchors, &keys);
7245                                         let htlc_sighashtype = if $opt_anchors { EcdsaSighashType::SinglePlusAnyoneCanPay } else { EcdsaSighashType::All };
7246                                         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();
7247                                         assert!(secp_ctx.verify_ecdsa(&htlc_sighash, &remote_signature, &keys.countersignatory_htlc_key).is_ok(), "verify counterparty htlc sig");
7248
7249                                         let mut preimage: Option<PaymentPreimage> = None;
7250                                         if !htlc.offered {
7251                                                 for i in 0..5 {
7252                                                         let out = PaymentHash(Sha256::hash(&[i; 32]).into_inner());
7253                                                         if out == htlc.payment_hash {
7254                                                                 preimage = Some(PaymentPreimage([i; 32]));
7255                                                         }
7256                                                 }
7257
7258                                                 assert!(preimage.is_some());
7259                                         }
7260
7261                                         let htlc_sig = htlc_sig_iter.next().unwrap();
7262                                         let num_anchors = if $opt_anchors { 2 } else { 0 };
7263                                         assert_eq!((htlc_sig.0).0.transaction_output_index, Some($htlc_idx + num_anchors), "output index");
7264
7265                                         let signature = Signature::from_der(&hex::decode($htlc_sig_hex).unwrap()[..]).unwrap();
7266                                         assert_eq!(signature, *(htlc_sig.1).1, "htlc sig");
7267                                         let index = (htlc_sig.1).0;
7268                                         let channel_parameters = chan.channel_transaction_parameters.as_holder_broadcastable();
7269                                         let trusted_tx = holder_commitment_tx.trust();
7270                                         log_trace!(logger, "htlc_tx = {}", hex::encode(serialize(&trusted_tx.get_signed_htlc_tx(&channel_parameters, index, &(htlc_sig.0).1, (htlc_sig.1).1, &preimage))));
7271                                         assert_eq!(serialize(&trusted_tx.get_signed_htlc_tx(&channel_parameters, index, &(htlc_sig.0).1, (htlc_sig.1).1, &preimage))[..],
7272                                                         hex::decode($htlc_tx_hex).unwrap()[..], "htlc tx");
7273                                 })*
7274                                 assert!(htlc_sig_iter.next().is_none());
7275                         } }
7276                 }
7277
7278                 // simple commitment tx with no HTLCs
7279                 chan.value_to_self_msat = 7000000000;
7280
7281                 test_commitment!("3045022100c3127b33dcc741dd6b05b1e63cbd1a9a7d816f37af9b6756fa2376b056f032370220408b96279808fe57eb7e463710804cdf4f108388bc5cf722d8c848d2c7f9f3b0",
7282                                                  "30440220616210b2cc4d3afb601013c373bbd8aac54febd9f15400379a8cb65ce7deca60022034236c010991beb7ff770510561ae8dc885b8d38d1947248c38f2ae055647142",
7283                                                  "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8002c0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e48454a56a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e04004730440220616210b2cc4d3afb601013c373bbd8aac54febd9f15400379a8cb65ce7deca60022034236c010991beb7ff770510561ae8dc885b8d38d1947248c38f2ae05564714201483045022100c3127b33dcc741dd6b05b1e63cbd1a9a7d816f37af9b6756fa2376b056f032370220408b96279808fe57eb7e463710804cdf4f108388bc5cf722d8c848d2c7f9f3b001475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {});
7284
7285                 // anchors: simple commitment tx with no HTLCs
7286                 test_commitment_with_anchors!("3045022100f89034eba16b2be0e5581f750a0a6309192b75cce0f202f0ee2b4ec0cc394850022076c65dc507fe42276152b7a3d90e961e678adbe966e916ecfe85e64d430e75f3",
7287                                                  "30450221008266ac6db5ea71aac3c95d97b0e172ff596844851a3216eb88382a8dddfd33d2022050e240974cfd5d708708b4365574517c18e7ae535ef732a3484d43d0d82be9f7",
7288                                                  "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b80044a010000000000002200202b1b5854183c12d3316565972c4668929d314d81c5dcdbb21cb45fe8a9a8114f4a01000000000000220020e9e86e4823faa62e222ebc858a226636856158f07e69898da3b0d1af0ddb3994c0c62d0000000000220020f3394e1e619b0eca1f91be2fb5ab4dfc59ba5b84ebe014ad1d43a564d012994a508b6a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e04004830450221008266ac6db5ea71aac3c95d97b0e172ff596844851a3216eb88382a8dddfd33d2022050e240974cfd5d708708b4365574517c18e7ae535ef732a3484d43d0d82be9f701483045022100f89034eba16b2be0e5581f750a0a6309192b75cce0f202f0ee2b4ec0cc394850022076c65dc507fe42276152b7a3d90e961e678adbe966e916ecfe85e64d430e75f301475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {});
7289
7290                 chan.pending_inbound_htlcs.push({
7291                         let mut out = InboundHTLCOutput{
7292                                 htlc_id: 0,
7293                                 amount_msat: 1000000,
7294                                 cltv_expiry: 500,
7295                                 payment_hash: PaymentHash([0; 32]),
7296                                 state: InboundHTLCState::Committed,
7297                         };
7298                         out.payment_hash.0 = Sha256::hash(&hex::decode("0000000000000000000000000000000000000000000000000000000000000000").unwrap()).into_inner();
7299                         out
7300                 });
7301                 chan.pending_inbound_htlcs.push({
7302                         let mut out = InboundHTLCOutput{
7303                                 htlc_id: 1,
7304                                 amount_msat: 2000000,
7305                                 cltv_expiry: 501,
7306                                 payment_hash: PaymentHash([0; 32]),
7307                                 state: InboundHTLCState::Committed,
7308                         };
7309                         out.payment_hash.0 = Sha256::hash(&hex::decode("0101010101010101010101010101010101010101010101010101010101010101").unwrap()).into_inner();
7310                         out
7311                 });
7312                 chan.pending_outbound_htlcs.push({
7313                         let mut out = OutboundHTLCOutput{
7314                                 htlc_id: 2,
7315                                 amount_msat: 2000000,
7316                                 cltv_expiry: 502,
7317                                 payment_hash: PaymentHash([0; 32]),
7318                                 state: OutboundHTLCState::Committed,
7319                                 source: HTLCSource::dummy(),
7320                         };
7321                         out.payment_hash.0 = Sha256::hash(&hex::decode("0202020202020202020202020202020202020202020202020202020202020202").unwrap()).into_inner();
7322                         out
7323                 });
7324                 chan.pending_outbound_htlcs.push({
7325                         let mut out = OutboundHTLCOutput{
7326                                 htlc_id: 3,
7327                                 amount_msat: 3000000,
7328                                 cltv_expiry: 503,
7329                                 payment_hash: PaymentHash([0; 32]),
7330                                 state: OutboundHTLCState::Committed,
7331                                 source: HTLCSource::dummy(),
7332                         };
7333                         out.payment_hash.0 = Sha256::hash(&hex::decode("0303030303030303030303030303030303030303030303030303030303030303").unwrap()).into_inner();
7334                         out
7335                 });
7336                 chan.pending_inbound_htlcs.push({
7337                         let mut out = InboundHTLCOutput{
7338                                 htlc_id: 4,
7339                                 amount_msat: 4000000,
7340                                 cltv_expiry: 504,
7341                                 payment_hash: PaymentHash([0; 32]),
7342                                 state: InboundHTLCState::Committed,
7343                         };
7344                         out.payment_hash.0 = Sha256::hash(&hex::decode("0404040404040404040404040404040404040404040404040404040404040404").unwrap()).into_inner();
7345                         out
7346                 });
7347
7348                 // commitment tx with all five HTLCs untrimmed (minimum feerate)
7349                 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
7350                 chan.feerate_per_kw = 0;
7351
7352                 test_commitment!("3044022009b048187705a8cbc9ad73adbe5af148c3d012e1f067961486c822c7af08158c022006d66f3704cfab3eb2dc49dae24e4aa22a6910fc9b424007583204e3621af2e5",
7353                                  "304402206fc2d1f10ea59951eefac0b4b7c396a3c3d87b71ff0b019796ef4535beaf36f902201765b0181e514d04f4c8ad75659d7037be26cdb3f8bb6f78fe61decef484c3ea",
7354                                  "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8007e80300000000000022002052bfef0479d7b293c27e0f1eb294bea154c63a3294ef092c19af51409bce0e2ad007000000000000220020403d394747cae42e98ff01734ad5c08f82ba123d3d9a620abda88989651e2ab5d007000000000000220020748eba944fedc8827f6b06bc44678f93c0f9e6078b35c6331ed31e75f8ce0c2db80b000000000000220020c20b5d1f8584fd90443e7b7b720136174fa4b9333c261d04dbbd012635c0f419a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e484e0a06a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e040047304402206fc2d1f10ea59951eefac0b4b7c396a3c3d87b71ff0b019796ef4535beaf36f902201765b0181e514d04f4c8ad75659d7037be26cdb3f8bb6f78fe61decef484c3ea01473044022009b048187705a8cbc9ad73adbe5af148c3d012e1f067961486c822c7af08158c022006d66f3704cfab3eb2dc49dae24e4aa22a6910fc9b424007583204e3621af2e501475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {
7355
7356                                   { 0,
7357                                   "3045022100d9e29616b8f3959f1d3d7f7ce893ffedcdc407717d0de8e37d808c91d3a7c50d022078c3033f6d00095c8720a4bc943c1b45727818c082e4e3ddbc6d3116435b624b",
7358                                   "30440220636de5682ef0c5b61f124ec74e8aa2461a69777521d6998295dcea36bc3338110220165285594b23c50b28b82df200234566628a27bcd17f7f14404bd865354eb3ce",
7359                                   "02000000000101ab84ff284f162cfbfef241f853b47d4368d171f9e2a1445160cd591c4c7d882b00000000000000000001e8030000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100d9e29616b8f3959f1d3d7f7ce893ffedcdc407717d0de8e37d808c91d3a7c50d022078c3033f6d00095c8720a4bc943c1b45727818c082e4e3ddbc6d3116435b624b014730440220636de5682ef0c5b61f124ec74e8aa2461a69777521d6998295dcea36bc3338110220165285594b23c50b28b82df200234566628a27bcd17f7f14404bd865354eb3ce012000000000000000000000000000000000000000000000000000000000000000008a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a914b8bcb07f6344b42ab04250c86a6e8b75d3fdbbc688527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f401b175ac686800000000" },
7360
7361                                   { 1,
7362                                   "30440220649fe8b20e67e46cbb0d09b4acea87dbec001b39b08dee7bdd0b1f03922a8640022037c462dff79df501cecfdb12ea7f4de91f99230bb544726f6e04527b1f896004",
7363                                   "3045022100803159dee7935dba4a1d36a61055ce8fd62caa528573cc221ae288515405a252022029c59e7cffce374fe860100a4a63787e105c3cf5156d40b12dd53ff55ac8cf3f",
7364                                   "02000000000101ab84ff284f162cfbfef241f853b47d4368d171f9e2a1445160cd591c4c7d882b01000000000000000001d0070000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e05004730440220649fe8b20e67e46cbb0d09b4acea87dbec001b39b08dee7bdd0b1f03922a8640022037c462dff79df501cecfdb12ea7f4de91f99230bb544726f6e04527b1f89600401483045022100803159dee7935dba4a1d36a61055ce8fd62caa528573cc221ae288515405a252022029c59e7cffce374fe860100a4a63787e105c3cf5156d40b12dd53ff55ac8cf3f01008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a914b43e1b38138a41b37f7cd9a1d274bc63e3a9b5d188ac6868f6010000" },
7365
7366                                   { 2,
7367                                   "30440220770fc321e97a19f38985f2e7732dd9fe08d16a2efa4bcbc0429400a447faf49102204d40b417f3113e1b0944ae0986f517564ab4acd3d190503faf97a6e420d43352",
7368                                   "3045022100a437cc2ce77400ecde441b3398fea3c3ad8bdad8132be818227fe3c5b8345989022069d45e7fa0ae551ec37240845e2c561ceb2567eacf3076a6a43a502d05865faa",
7369                                   "02000000000101ab84ff284f162cfbfef241f853b47d4368d171f9e2a1445160cd591c4c7d882b02000000000000000001d0070000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e05004730440220770fc321e97a19f38985f2e7732dd9fe08d16a2efa4bcbc0429400a447faf49102204d40b417f3113e1b0944ae0986f517564ab4acd3d190503faf97a6e420d4335201483045022100a437cc2ce77400ecde441b3398fea3c3ad8bdad8132be818227fe3c5b8345989022069d45e7fa0ae551ec37240845e2c561ceb2567eacf3076a6a43a502d05865faa012001010101010101010101010101010101010101010101010101010101010101018a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a9144b6b2e5444c2639cc0fb7bcea5afba3f3cdce23988527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f501b175ac686800000000" },
7370
7371                                   { 3,
7372                                   "304402207bcbf4f60a9829b05d2dbab84ed593e0291836be715dc7db6b72a64caf646af802201e489a5a84f7c5cc130398b841d138d031a5137ac8f4c49c770a4959dc3c1363",
7373                                   "304402203121d9b9c055f354304b016a36662ee99e1110d9501cb271b087ddb6f382c2c80220549882f3f3b78d9c492de47543cb9a697cecc493174726146536c5954dac7487",
7374                                   "02000000000101ab84ff284f162cfbfef241f853b47d4368d171f9e2a1445160cd591c4c7d882b03000000000000000001b80b0000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e050047304402207bcbf4f60a9829b05d2dbab84ed593e0291836be715dc7db6b72a64caf646af802201e489a5a84f7c5cc130398b841d138d031a5137ac8f4c49c770a4959dc3c13630147304402203121d9b9c055f354304b016a36662ee99e1110d9501cb271b087ddb6f382c2c80220549882f3f3b78d9c492de47543cb9a697cecc493174726146536c5954dac748701008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9148a486ff2e31d6158bf39e2608864d63fefd09d5b88ac6868f7010000" },
7375
7376                                   { 4,
7377                                   "3044022076dca5cb81ba7e466e349b7128cdba216d4d01659e29b96025b9524aaf0d1899022060de85697b88b21c749702b7d2cfa7dfeaa1f472c8f1d7d9c23f2bf968464b87",
7378                                   "3045022100d9080f103cc92bac15ec42464a95f070c7fb6925014e673ee2ea1374d36a7f7502200c65294d22eb20d48564954d5afe04a385551919d8b2ddb4ae2459daaeee1d95",
7379                                   "02000000000101ab84ff284f162cfbfef241f853b47d4368d171f9e2a1445160cd591c4c7d882b04000000000000000001a00f0000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500473044022076dca5cb81ba7e466e349b7128cdba216d4d01659e29b96025b9524aaf0d1899022060de85697b88b21c749702b7d2cfa7dfeaa1f472c8f1d7d9c23f2bf968464b8701483045022100d9080f103cc92bac15ec42464a95f070c7fb6925014e673ee2ea1374d36a7f7502200c65294d22eb20d48564954d5afe04a385551919d8b2ddb4ae2459daaeee1d95012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000" }
7380                 } );
7381
7382                 // commitment tx with seven outputs untrimmed (maximum feerate)
7383                 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
7384                 chan.feerate_per_kw = 647;
7385
7386                 test_commitment!("3045022100a135f9e8a5ed25f7277446c67956b00ce6f610ead2bdec2c2f686155b7814772022059f1f6e1a8b336a68efcc1af3fe4d422d4827332b5b067501b099c47b7b5b5ee",
7387                                  "30450221009ec15c687898bb4da8b3a833e5ab8bfc51ec6e9202aaa8e66611edfd4a85ed1102203d7183e45078b9735c93450bc3415d3e5a8c576141a711ec6ddcb4a893926bb7",
7388                                  "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8007e80300000000000022002052bfef0479d7b293c27e0f1eb294bea154c63a3294ef092c19af51409bce0e2ad007000000000000220020403d394747cae42e98ff01734ad5c08f82ba123d3d9a620abda88989651e2ab5d007000000000000220020748eba944fedc8827f6b06bc44678f93c0f9e6078b35c6331ed31e75f8ce0c2db80b000000000000220020c20b5d1f8584fd90443e7b7b720136174fa4b9333c261d04dbbd012635c0f419a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e484e09c6a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e04004830450221009ec15c687898bb4da8b3a833e5ab8bfc51ec6e9202aaa8e66611edfd4a85ed1102203d7183e45078b9735c93450bc3415d3e5a8c576141a711ec6ddcb4a893926bb701483045022100a135f9e8a5ed25f7277446c67956b00ce6f610ead2bdec2c2f686155b7814772022059f1f6e1a8b336a68efcc1af3fe4d422d4827332b5b067501b099c47b7b5b5ee01475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {
7389
7390                                   { 0,
7391                                   "30450221008437627f9ad84ac67052e2a414a4367b8556fd1f94d8b02590f89f50525cd33502205b9c21ff6e7fc864f2352746ad8ba59182510819acb644e25b8a12fc37bbf24f",
7392                                   "30440220344b0deb055230d01703e6c7acd45853c4af2328b49b5d8af4f88a060733406602202ea64f2a43d5751edfe75503cbc35a62e3141b5ed032fa03360faf4ca66f670b",
7393                                   "020000000001012cfb3e4788c206881d38f2996b6cb2109b5935acb527d14bdaa7b908afa9b2fe0000000000000000000122020000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e05004830450221008437627f9ad84ac67052e2a414a4367b8556fd1f94d8b02590f89f50525cd33502205b9c21ff6e7fc864f2352746ad8ba59182510819acb644e25b8a12fc37bbf24f014730440220344b0deb055230d01703e6c7acd45853c4af2328b49b5d8af4f88a060733406602202ea64f2a43d5751edfe75503cbc35a62e3141b5ed032fa03360faf4ca66f670b012000000000000000000000000000000000000000000000000000000000000000008a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a914b8bcb07f6344b42ab04250c86a6e8b75d3fdbbc688527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f401b175ac686800000000" },
7394
7395                                   { 1,
7396                                   "304402205a67f92bf6845cf2892b48d874ac1daf88a36495cf8a06f93d83180d930a6f75022031da1621d95c3f335cc06a3056cf960199dae600b7cf89088f65fc53cdbef28c",
7397                                   "30450221009e5e3822b0185c6799a95288c597b671d6cc69ab80f43740f00c6c3d0752bdda02206da947a74bd98f3175324dc56fdba86cc783703a120a6f0297537e60632f4c7f",
7398                                   "020000000001012cfb3e4788c206881d38f2996b6cb2109b5935acb527d14bdaa7b908afa9b2fe0100000000000000000124060000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e050047304402205a67f92bf6845cf2892b48d874ac1daf88a36495cf8a06f93d83180d930a6f75022031da1621d95c3f335cc06a3056cf960199dae600b7cf89088f65fc53cdbef28c014830450221009e5e3822b0185c6799a95288c597b671d6cc69ab80f43740f00c6c3d0752bdda02206da947a74bd98f3175324dc56fdba86cc783703a120a6f0297537e60632f4c7f01008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a914b43e1b38138a41b37f7cd9a1d274bc63e3a9b5d188ac6868f6010000" },
7399
7400                                   { 2,
7401                                   "30440220437e21766054a3eef7f65690c5bcfa9920babbc5af92b819f772f6ea96df6c7402207173622024bd97328cfb26c6665e25c2f5d67c319443ccdc60c903217005d8c8",
7402                                   "3045022100fcfc47e36b712624677626cef3dc1d67f6583bd46926a6398fe6b00b0c9a37760220525788257b187fc775c6370d04eadf34d06f3650a63f8df851cee0ecb47a1673",
7403                                   "020000000001012cfb3e4788c206881d38f2996b6cb2109b5935acb527d14bdaa7b908afa9b2fe020000000000000000010a060000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e05004730440220437e21766054a3eef7f65690c5bcfa9920babbc5af92b819f772f6ea96df6c7402207173622024bd97328cfb26c6665e25c2f5d67c319443ccdc60c903217005d8c801483045022100fcfc47e36b712624677626cef3dc1d67f6583bd46926a6398fe6b00b0c9a37760220525788257b187fc775c6370d04eadf34d06f3650a63f8df851cee0ecb47a1673012001010101010101010101010101010101010101010101010101010101010101018a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a9144b6b2e5444c2639cc0fb7bcea5afba3f3cdce23988527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f501b175ac686800000000" },
7404
7405                                   { 3,
7406                                   "304402207436e10737e4df499fc051686d3e11a5bb2310e4d1f1e691d287cef66514791202207cb58e71a6b7a42dd001b7e3ae672ea4f71ea3e1cd412b742e9124abb0739c64",
7407                                   "3045022100e78211b8409afb7255ffe37337da87f38646f1faebbdd61bc1920d69e3ead67a02201a626305adfcd16bfb7e9340928d9b6305464eab4aa4c4a3af6646e9b9f69dee",
7408                                   "020000000001012cfb3e4788c206881d38f2996b6cb2109b5935acb527d14bdaa7b908afa9b2fe030000000000000000010c0a0000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e050047304402207436e10737e4df499fc051686d3e11a5bb2310e4d1f1e691d287cef66514791202207cb58e71a6b7a42dd001b7e3ae672ea4f71ea3e1cd412b742e9124abb0739c6401483045022100e78211b8409afb7255ffe37337da87f38646f1faebbdd61bc1920d69e3ead67a02201a626305adfcd16bfb7e9340928d9b6305464eab4aa4c4a3af6646e9b9f69dee01008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9148a486ff2e31d6158bf39e2608864d63fefd09d5b88ac6868f7010000" },
7409
7410                                   { 4,
7411                                   "30450221009acd6a827a76bfee50806178dfe0495cd4e1d9c58279c194c7b01520fe68cb8d022024d439047c368883e570997a7d40f0b430cb5a742f507965e7d3063ae3feccca",
7412                                   "3044022048762cf546bbfe474f1536365ea7c416e3c0389d60558bc9412cb148fb6ab68202207215d7083b75c96ff9d2b08c59c34e287b66820f530b486a9aa4cdd9c347d5b9",
7413                                   "020000000001012cfb3e4788c206881d38f2996b6cb2109b5935acb527d14bdaa7b908afa9b2fe04000000000000000001da0d0000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e05004830450221009acd6a827a76bfee50806178dfe0495cd4e1d9c58279c194c7b01520fe68cb8d022024d439047c368883e570997a7d40f0b430cb5a742f507965e7d3063ae3feccca01473044022048762cf546bbfe474f1536365ea7c416e3c0389d60558bc9412cb148fb6ab68202207215d7083b75c96ff9d2b08c59c34e287b66820f530b486a9aa4cdd9c347d5b9012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000" }
7414                 } );
7415
7416                 // anchors: commitment tx with seven outputs untrimmed (maximum feerate)
7417                 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
7418                 chan.feerate_per_kw = 644;
7419
7420                 test_commitment_with_anchors!("3045022100e0106830467a558c07544a3de7715610c1147062e7d091deeebe8b5c661cda9402202ad049c1a6d04834317a78483f723c205c9f638d17222aafc620800cc1b6ae35",
7421                                  "3045022100ef82a405364bfc4007e63a7cc82925a513d79065bdbc216d60b6a4223a323f8a02200716730b8561f3c6d362eaf47f202e99fb30d0557b61b92b5f9134f8e2de3681",
7422                                  "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b80094a010000000000002200202b1b5854183c12d3316565972c4668929d314d81c5dcdbb21cb45fe8a9a8114f4a01000000000000220020e9e86e4823faa62e222ebc858a226636856158f07e69898da3b0d1af0ddb3994e80300000000000022002010f88bf09e56f14fb4543fd26e47b0db50ea5de9cf3fc46434792471082621aed0070000000000002200203e68115ae0b15b8de75b6c6bc9af5ac9f01391544e0870dae443a1e8fe7837ead007000000000000220020fe0598d74fee2205cc3672e6e6647706b4f3099713b4661b62482c3addd04a5eb80b000000000000220020f96d0334feb64a4f40eb272031d07afcb038db56aa57446d60308c9f8ccadef9a00f000000000000220020ce6e751274836ff59622a0d1e07f8831d80bd6730bd48581398bfadd2bb8da9ac0c62d0000000000220020f3394e1e619b0eca1f91be2fb5ab4dfc59ba5b84ebe014ad1d43a564d012994a4f996a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0400483045022100ef82a405364bfc4007e63a7cc82925a513d79065bdbc216d60b6a4223a323f8a02200716730b8561f3c6d362eaf47f202e99fb30d0557b61b92b5f9134f8e2de368101483045022100e0106830467a558c07544a3de7715610c1147062e7d091deeebe8b5c661cda9402202ad049c1a6d04834317a78483f723c205c9f638d17222aafc620800cc1b6ae3501475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {
7423
7424                                   { 0,
7425                                   "304402205912d91c58016f593d9e46fefcdb6f4125055c41a17b03101eaaa034b9028ab60220520d4d239c85c66e4c75c5b413620b62736e227659d7821b308e2b8ced3e728e",
7426                                   "30440220473166a5adcca68550bab80403f410a726b5bd855030527e3fefa8c1e4b4fd7b02203b1dc91d8d69039473036cb5c34398b99e8eb90ae500c22130a557b62294b188",
7427                                   "02000000000101b8cefef62ea66f5178b9361b2371be0759cbc8c689bcfa7a8e6746d497ec221a0200000000010000000122020000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e050047304402205912d91c58016f593d9e46fefcdb6f4125055c41a17b03101eaaa034b9028ab60220520d4d239c85c66e4c75c5b413620b62736e227659d7821b308e2b8ced3e728e834730440220473166a5adcca68550bab80403f410a726b5bd855030527e3fefa8c1e4b4fd7b02203b1dc91d8d69039473036cb5c34398b99e8eb90ae500c22130a557b62294b188012000000000000000000000000000000000000000000000000000000000000000008d76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a914b8bcb07f6344b42ab04250c86a6e8b75d3fdbbc688527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f401b175ac6851b2756800000000" },
7428
7429                                   { 1,
7430                                   "3045022100c6b4113678039ee1e43a6cba5e3224ed2355ffc05e365a393afe8843dc9a76860220566d01fd52d65a89ba8595023884f9e8f2e9a310a6b9b85281c0bce06863430c",
7431                                   "3045022100d0d86307ea55d5daa80f453ad6d64b78fe8a6504aac25407c73e8502c0702c1602206a0809a02aa00c8dc4a53d976bb05d4605d8bb0b7b26b973a5c4e2734d8afbb4",
7432                                   "02000000000101b8cefef62ea66f5178b9361b2371be0759cbc8c689bcfa7a8e6746d497ec221a0300000000010000000124060000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100c6b4113678039ee1e43a6cba5e3224ed2355ffc05e365a393afe8843dc9a76860220566d01fd52d65a89ba8595023884f9e8f2e9a310a6b9b85281c0bce06863430c83483045022100d0d86307ea55d5daa80f453ad6d64b78fe8a6504aac25407c73e8502c0702c1602206a0809a02aa00c8dc4a53d976bb05d4605d8bb0b7b26b973a5c4e2734d8afbb401008876a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a914b43e1b38138a41b37f7cd9a1d274bc63e3a9b5d188ac6851b27568f6010000" },
7433
7434                                   { 2,
7435                                   "304402203c3a699fb80a38112aafd73d6e3a9b7d40bc2c3ed8b7fbc182a20f43b215172202204e71821b984d1af52c4b8e2cd4c572578c12a965866130c2345f61e4c2d3fef4",
7436                                   "304402205bcfa92f83c69289a412b0b6dd4f2a0fe0b0fc2d45bd74706e963257a09ea24902203783e47883e60b86240e877fcbf33d50b1742f65bc93b3162d1be26583b367ee",
7437                                   "02000000000101b8cefef62ea66f5178b9361b2371be0759cbc8c689bcfa7a8e6746d497ec221a040000000001000000010a060000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e050047304402203c3a699fb80a38112aafd73d6e3a9b7d40bc2c3ed8b7fbc182a20f43b215172202204e71821b984d1af52c4b8e2cd4c572578c12a965866130c2345f61e4c2d3fef48347304402205bcfa92f83c69289a412b0b6dd4f2a0fe0b0fc2d45bd74706e963257a09ea24902203783e47883e60b86240e877fcbf33d50b1742f65bc93b3162d1be26583b367ee012001010101010101010101010101010101010101010101010101010101010101018d76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a9144b6b2e5444c2639cc0fb7bcea5afba3f3cdce23988527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f501b175ac6851b2756800000000" },
7438
7439                                   { 3,
7440                                   "304402200f089bcd20f25475216307d32aa5b6c857419624bfba1da07335f51f6ba4645b02206ce0f7153edfba23b0d4b2afc26bb3157d404368cb8ea0ca7cf78590dcdd28cf",
7441                                   "3045022100e4516da08f72c7a4f7b2f37aa84a0feb54ae2cc5b73f0da378e81ae0ca8119bf02207751b2628d8e2f62b4b9abccda4866246c1bfcc82e3d416ad562fd212102c28f",
7442                                   "02000000000101b8cefef62ea66f5178b9361b2371be0759cbc8c689bcfa7a8e6746d497ec221a050000000001000000010c0a0000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e050047304402200f089bcd20f25475216307d32aa5b6c857419624bfba1da07335f51f6ba4645b02206ce0f7153edfba23b0d4b2afc26bb3157d404368cb8ea0ca7cf78590dcdd28cf83483045022100e4516da08f72c7a4f7b2f37aa84a0feb54ae2cc5b73f0da378e81ae0ca8119bf02207751b2628d8e2f62b4b9abccda4866246c1bfcc82e3d416ad562fd212102c28f01008876a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9148a486ff2e31d6158bf39e2608864d63fefd09d5b88ac6851b27568f7010000" },
7443
7444                                   { 4,
7445                                   "3045022100aa72cfaf0965020c73a12c77276c6411ca68c4de36ac1998adf86c917a899a43022060da0a159fecfe0bed37c3962d767f12f90e30fed8a8f34b1301775c21a2bd3a",
7446                                   "304402203cd12065c2a42963c762e6b1a981e17695616ecb6f9fb33d8b0717cdd7ca0ee4022065500005c491c1dcf2fe9c4024f74b1c90785d572527055a491278f901143904",
7447                                   "02000000000101b8cefef62ea66f5178b9361b2371be0759cbc8c689bcfa7a8e6746d497ec221a06000000000100000001da0d0000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100aa72cfaf0965020c73a12c77276c6411ca68c4de36ac1998adf86c917a899a43022060da0a159fecfe0bed37c3962d767f12f90e30fed8a8f34b1301775c21a2bd3a8347304402203cd12065c2a42963c762e6b1a981e17695616ecb6f9fb33d8b0717cdd7ca0ee4022065500005c491c1dcf2fe9c4024f74b1c90785d572527055a491278f901143904012004040404040404040404040404040404040404040404040404040404040404048d76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac6851b2756800000000" }
7448                 } );
7449
7450                 // commitment tx with six outputs untrimmed (minimum feerate)
7451                 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
7452                 chan.feerate_per_kw = 648;
7453
7454                 test_commitment!("304402203948f900a5506b8de36a4d8502f94f21dd84fd9c2314ab427d52feaa7a0a19f2022059b6a37a4adaa2c5419dc8aea63c6e2a2ec4c4bde46207f6dc1fcd22152fc6e5",
7455                                  "3045022100b15f72908ba3382a34ca5b32519240a22300cc6015b6f9418635fb41f3d01d8802207adb331b9ed1575383dca0f2355e86c173802feecf8298fbea53b9d4610583e9",
7456                                  "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8006d007000000000000220020403d394747cae42e98ff01734ad5c08f82ba123d3d9a620abda88989651e2ab5d007000000000000220020748eba944fedc8827f6b06bc44678f93c0f9e6078b35c6331ed31e75f8ce0c2db80b000000000000220020c20b5d1f8584fd90443e7b7b720136174fa4b9333c261d04dbbd012635c0f419a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e4844e9d6a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0400483045022100b15f72908ba3382a34ca5b32519240a22300cc6015b6f9418635fb41f3d01d8802207adb331b9ed1575383dca0f2355e86c173802feecf8298fbea53b9d4610583e90147304402203948f900a5506b8de36a4d8502f94f21dd84fd9c2314ab427d52feaa7a0a19f2022059b6a37a4adaa2c5419dc8aea63c6e2a2ec4c4bde46207f6dc1fcd22152fc6e501475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {
7457
7458                                   { 0,
7459                                   "3045022100a031202f3be94678f0e998622ee95ebb6ada8da1e9a5110228b5e04a747351e4022010ca6a21e18314ed53cfaae3b1f51998552a61a468e596368829a50ce40110e0",
7460                                   "304502210097e1873b57267730154595187a34949d3744f52933070c74757005e61ce2112e02204ecfba2aa42d4f14bdf8bad4206bb97217b702e6c433e0e1b0ce6587e6d46ec6",
7461                                   "020000000001010f44041fdfba175987cf4e6135ba2a154e3b7fb96483dc0ed5efc0678e5b6bf10000000000000000000123060000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100a031202f3be94678f0e998622ee95ebb6ada8da1e9a5110228b5e04a747351e4022010ca6a21e18314ed53cfaae3b1f51998552a61a468e596368829a50ce40110e00148304502210097e1873b57267730154595187a34949d3744f52933070c74757005e61ce2112e02204ecfba2aa42d4f14bdf8bad4206bb97217b702e6c433e0e1b0ce6587e6d46ec601008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a914b43e1b38138a41b37f7cd9a1d274bc63e3a9b5d188ac6868f6010000" },
7462
7463                                   { 1,
7464                                   "304402202361012a634aee7835c5ecdd6413dcffa8f404b7e77364c792cff984e4ee71e90220715c5e90baa08daa45a7439b1ee4fa4843ed77b19c058240b69406606d384124",
7465                                   "3044022019de73b00f1d818fb388e83b2c8c31f6bce35ac624e215bc12f88f9dc33edf48022006ff814bb9f700ee6abc3294e146fac3efd4f13f0005236b41c0a946ee00c9ae",
7466                                   "020000000001010f44041fdfba175987cf4e6135ba2a154e3b7fb96483dc0ed5efc0678e5b6bf10100000000000000000109060000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e050047304402202361012a634aee7835c5ecdd6413dcffa8f404b7e77364c792cff984e4ee71e90220715c5e90baa08daa45a7439b1ee4fa4843ed77b19c058240b69406606d38412401473044022019de73b00f1d818fb388e83b2c8c31f6bce35ac624e215bc12f88f9dc33edf48022006ff814bb9f700ee6abc3294e146fac3efd4f13f0005236b41c0a946ee00c9ae012001010101010101010101010101010101010101010101010101010101010101018a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a9144b6b2e5444c2639cc0fb7bcea5afba3f3cdce23988527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f501b175ac686800000000" },
7467
7468                                   { 2,
7469                                   "304402207e8e82cd71ed4febeb593732c260456836e97d81896153ecd2b3cf320ca6861702202dd4a30f68f98ced7cc56a36369ac1fdd978248c5ff4ed204fc00cc625532989",
7470                                   "3045022100bd0be6100c4fd8f102ec220e1b053e4c4e2ecca25615490150007b40d314dc3902201a1e0ea266965b43164d9e6576f58fa6726d42883dd1c3996d2925c2e2260796",
7471                                   "020000000001010f44041fdfba175987cf4e6135ba2a154e3b7fb96483dc0ed5efc0678e5b6bf1020000000000000000010b0a0000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e050047304402207e8e82cd71ed4febeb593732c260456836e97d81896153ecd2b3cf320ca6861702202dd4a30f68f98ced7cc56a36369ac1fdd978248c5ff4ed204fc00cc62553298901483045022100bd0be6100c4fd8f102ec220e1b053e4c4e2ecca25615490150007b40d314dc3902201a1e0ea266965b43164d9e6576f58fa6726d42883dd1c3996d2925c2e226079601008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9148a486ff2e31d6158bf39e2608864d63fefd09d5b88ac6868f7010000" },
7472
7473                                   { 3,
7474                                   "3044022024cd52e4198c8ae0e414a86d86b5a65ea7450f2eb4e783096736d93395eca5ce022078f0094745b45be4d4b2b04dd5978c9e66ba49109e5704403e84aaf5f387d6be",
7475                                   "3045022100bbfb9d0a946d420807c86e985d636cceb16e71c3694ed186316251a00cbd807202207773223f9a337e145f64673825be9b30d07ef1542c82188b264bedcf7cda78c6",
7476                                   "020000000001010f44041fdfba175987cf4e6135ba2a154e3b7fb96483dc0ed5efc0678e5b6bf103000000000000000001d90d0000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500473044022024cd52e4198c8ae0e414a86d86b5a65ea7450f2eb4e783096736d93395eca5ce022078f0094745b45be4d4b2b04dd5978c9e66ba49109e5704403e84aaf5f387d6be01483045022100bbfb9d0a946d420807c86e985d636cceb16e71c3694ed186316251a00cbd807202207773223f9a337e145f64673825be9b30d07ef1542c82188b264bedcf7cda78c6012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000" }
7477                 } );
7478
7479                 // anchors: commitment tx with six outputs untrimmed (minimum feerate)
7480                 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
7481                 chan.feerate_per_kw = 645;
7482
7483                 test_commitment_with_anchors!("3044022025d97466c8049e955a5afce28e322f4b34d2561118e52332fb400f9b908cc0a402205dc6fba3a0d67ee142c428c535580cd1f2ff42e2f89b47e0c8a01847caffc312",
7484                                  "3045022100d57697c707b6f6d053febf24b98e8989f186eea42e37e9e91663ec2c70bb8f70022079b0715a472118f262f43016a674f59c015d9cafccec885968e76d9d9c5d0051",
7485                                  "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b80084a010000000000002200202b1b5854183c12d3316565972c4668929d314d81c5dcdbb21cb45fe8a9a8114f4a01000000000000220020e9e86e4823faa62e222ebc858a226636856158f07e69898da3b0d1af0ddb3994d0070000000000002200203e68115ae0b15b8de75b6c6bc9af5ac9f01391544e0870dae443a1e8fe7837ead007000000000000220020fe0598d74fee2205cc3672e6e6647706b4f3099713b4661b62482c3addd04a5eb80b000000000000220020f96d0334feb64a4f40eb272031d07afcb038db56aa57446d60308c9f8ccadef9a00f000000000000220020ce6e751274836ff59622a0d1e07f8831d80bd6730bd48581398bfadd2bb8da9ac0c62d0000000000220020f3394e1e619b0eca1f91be2fb5ab4dfc59ba5b84ebe014ad1d43a564d012994abc996a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0400483045022100d57697c707b6f6d053febf24b98e8989f186eea42e37e9e91663ec2c70bb8f70022079b0715a472118f262f43016a674f59c015d9cafccec885968e76d9d9c5d005101473044022025d97466c8049e955a5afce28e322f4b34d2561118e52332fb400f9b908cc0a402205dc6fba3a0d67ee142c428c535580cd1f2ff42e2f89b47e0c8a01847caffc31201475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {
7486
7487                                   { 0,
7488                                   "30440220446f9e5c375db6a61d6eeee8b59219a30a4a37372afc2670a1a2889c78e9b943022061895f6088fb48b490ab2140a4842c277b64bf25ff591625dd0356e0c96ab7a8",
7489                                   "3045022100c1621ba26a99c263fd885feff5fda5ca2cc73df080b3a49ecf15164ee244d2a5022037f4cc7fd4441af39a83a0e44c3b1db7d64a4c8080e8697f9e952f85421a34d8",
7490                                   "02000000000101104f394af4c4fad78337f95e3e9f802f4c0d86ab231853af09b28534856132000200000000010000000123060000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e05004730440220446f9e5c375db6a61d6eeee8b59219a30a4a37372afc2670a1a2889c78e9b943022061895f6088fb48b490ab2140a4842c277b64bf25ff591625dd0356e0c96ab7a883483045022100c1621ba26a99c263fd885feff5fda5ca2cc73df080b3a49ecf15164ee244d2a5022037f4cc7fd4441af39a83a0e44c3b1db7d64a4c8080e8697f9e952f85421a34d801008876a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a914b43e1b38138a41b37f7cd9a1d274bc63e3a9b5d188ac6851b27568f6010000" },
7491
7492                                   { 1,
7493                                   "3044022027a3ffcb8a007e3349d75382efbd4b3fb99fcbd479a18555e58697bd1278d5c402205c8303d46211c3ae8975fe84a0df08b4623119fecd03bc93b49d7f7a0c64c710",
7494                                   "3045022100b697aca55c6fb15e5348bb7387b584815fd15e8dd306afe0c477cb550d0c2d40022050b0f7e370f7604d2fec781fefe86715dbe95dff4dab88d628f509d62f854de1",
7495                                   "02000000000101104f394af4c4fad78337f95e3e9f802f4c0d86ab231853af09b28534856132000300000000010000000109060000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500473044022027a3ffcb8a007e3349d75382efbd4b3fb99fcbd479a18555e58697bd1278d5c402205c8303d46211c3ae8975fe84a0df08b4623119fecd03bc93b49d7f7a0c64c71083483045022100b697aca55c6fb15e5348bb7387b584815fd15e8dd306afe0c477cb550d0c2d40022050b0f7e370f7604d2fec781fefe86715dbe95dff4dab88d628f509d62f854de1012001010101010101010101010101010101010101010101010101010101010101018d76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a9144b6b2e5444c2639cc0fb7bcea5afba3f3cdce23988527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f501b175ac6851b2756800000000" },
7496
7497                                   { 2,
7498                                   "30440220013975ae356e6daf22a86a29f21c4f35aca82ed8f731a1103c60c74f5ed1c5aa02200350d4e5455cdbcacb7ccf174db5bed8286019e509a113f6b4c5e606ee12c9d7",
7499                                   "3045022100e69a29f78779577830e73f327073c93168896f1b89432124b7846f5def9cd9cb02204433db3697e6ed7ac89574ca066a749640e0c9e114ac2e0ee4545741fcf7b7e9",
7500                                   "02000000000101104f394af4c4fad78337f95e3e9f802f4c0d86ab231853af09b2853485613200040000000001000000010b0a0000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e05004730440220013975ae356e6daf22a86a29f21c4f35aca82ed8f731a1103c60c74f5ed1c5aa02200350d4e5455cdbcacb7ccf174db5bed8286019e509a113f6b4c5e606ee12c9d783483045022100e69a29f78779577830e73f327073c93168896f1b89432124b7846f5def9cd9cb02204433db3697e6ed7ac89574ca066a749640e0c9e114ac2e0ee4545741fcf7b7e901008876a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9148a486ff2e31d6158bf39e2608864d63fefd09d5b88ac6851b27568f7010000" },
7501
7502                                   { 3,
7503                                   "304402205257017423644c7e831f30bc0c334eecfe66e9a6d2e92d157c5bece576b2be4f022047b21cf8e955e22b7471940563922d1a5852fb95459ca32905c7d46a19141664",
7504                                   "304402204f5de65a624e3f757adffb678bd887eb4e656538c5ea7044922f6ee3eed8a06202206ff6f7bfe73b565343cae76131ac658f1a9c60d3ca2343358cda60b9e35f94c8",
7505                                   "02000000000101104f394af4c4fad78337f95e3e9f802f4c0d86ab231853af09b285348561320005000000000100000001d90d0000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e050047304402205257017423644c7e831f30bc0c334eecfe66e9a6d2e92d157c5bece576b2be4f022047b21cf8e955e22b7471940563922d1a5852fb95459ca32905c7d46a191416648347304402204f5de65a624e3f757adffb678bd887eb4e656538c5ea7044922f6ee3eed8a06202206ff6f7bfe73b565343cae76131ac658f1a9c60d3ca2343358cda60b9e35f94c8012004040404040404040404040404040404040404040404040404040404040404048d76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac6851b2756800000000" }
7506                 } );
7507
7508                 // commitment tx with six outputs untrimmed (maximum feerate)
7509                 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
7510                 chan.feerate_per_kw = 2069;
7511
7512                 test_commitment!("304502210090b96a2498ce0c0f2fadbec2aab278fed54c1a7838df793ec4d2c78d96ec096202204fdd439c50f90d483baa7b68feeef4bd33bc277695405447bcd0bfb2ca34d7bc",
7513                                  "3045022100ad9a9bbbb75d506ca3b716b336ee3cf975dd7834fcf129d7dd188146eb58a8b4022061a759ee417339f7fe2ea1e8deb83abb6a74db31a09b7648a932a639cda23e33",
7514                                  "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8006d007000000000000220020403d394747cae42e98ff01734ad5c08f82ba123d3d9a620abda88989651e2ab5d007000000000000220020748eba944fedc8827f6b06bc44678f93c0f9e6078b35c6331ed31e75f8ce0c2db80b000000000000220020c20b5d1f8584fd90443e7b7b720136174fa4b9333c261d04dbbd012635c0f419a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e48477956a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0400483045022100ad9a9bbbb75d506ca3b716b336ee3cf975dd7834fcf129d7dd188146eb58a8b4022061a759ee417339f7fe2ea1e8deb83abb6a74db31a09b7648a932a639cda23e330148304502210090b96a2498ce0c0f2fadbec2aab278fed54c1a7838df793ec4d2c78d96ec096202204fdd439c50f90d483baa7b68feeef4bd33bc277695405447bcd0bfb2ca34d7bc01475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {
7515
7516                                   { 0,
7517                                   "3045022100f33513ee38abf1c582876f921f8fddc06acff48e04515532a32d3938de938ffd02203aa308a2c1863b7d6fdf53159a1465bf2e115c13152546cc5d74483ceaa7f699",
7518                                   "3045022100a637902a5d4c9ba9e7c472a225337d5aac9e2e3f6744f76e237132e7619ba0400220035c60d784a031c0d9f6df66b7eab8726a5c25397399ee4aa960842059eb3f9d",
7519                                   "02000000000101adbe717a63fb658add30ada1e6e12ed257637581898abe475c11d7bbcd65bd4d0000000000000000000175020000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100f33513ee38abf1c582876f921f8fddc06acff48e04515532a32d3938de938ffd02203aa308a2c1863b7d6fdf53159a1465bf2e115c13152546cc5d74483ceaa7f69901483045022100a637902a5d4c9ba9e7c472a225337d5aac9e2e3f6744f76e237132e7619ba0400220035c60d784a031c0d9f6df66b7eab8726a5c25397399ee4aa960842059eb3f9d01008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a914b43e1b38138a41b37f7cd9a1d274bc63e3a9b5d188ac6868f6010000" },
7520
7521                                   { 1,
7522                                   "3045022100ce07682cf4b90093c22dc2d9ab2a77ad6803526b655ef857221cc96af5c9e0bf02200f501cee22e7a268af40b555d15a8237c9f36ad67ef1841daf9f6a0267b1e6df",
7523                                   "3045022100e57e46234f8782d3ff7aa593b4f7446fb5316c842e693dc63ee324fd49f6a1c302204a2f7b44c48bd26e1554422afae13153eb94b29d3687b733d18930615fb2db61",
7524                                   "02000000000101adbe717a63fb658add30ada1e6e12ed257637581898abe475c11d7bbcd65bd4d0100000000000000000122020000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100ce07682cf4b90093c22dc2d9ab2a77ad6803526b655ef857221cc96af5c9e0bf02200f501cee22e7a268af40b555d15a8237c9f36ad67ef1841daf9f6a0267b1e6df01483045022100e57e46234f8782d3ff7aa593b4f7446fb5316c842e693dc63ee324fd49f6a1c302204a2f7b44c48bd26e1554422afae13153eb94b29d3687b733d18930615fb2db61012001010101010101010101010101010101010101010101010101010101010101018a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a9144b6b2e5444c2639cc0fb7bcea5afba3f3cdce23988527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f501b175ac686800000000" },
7525
7526                                   { 2,
7527                                   "3045022100e3e35492e55f82ec0bc2f317ffd7a486d1f7024330fe9743c3559fc39f32ef0c02203d1d4db651fc388a91d5ad8ecdd8e83673063bc8eefe27cfd8c189090e3a23e0",
7528                                   "3044022068613fb1b98eb3aec7f44c5b115b12343c2f066c4277c82b5f873dfe68f37f50022028109b4650f3f528ca4bfe9a467aff2e3e43893b61b5159157119d5d95cf1c18",
7529                                   "02000000000101adbe717a63fb658add30ada1e6e12ed257637581898abe475c11d7bbcd65bd4d020000000000000000015d060000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100e3e35492e55f82ec0bc2f317ffd7a486d1f7024330fe9743c3559fc39f32ef0c02203d1d4db651fc388a91d5ad8ecdd8e83673063bc8eefe27cfd8c189090e3a23e001473044022068613fb1b98eb3aec7f44c5b115b12343c2f066c4277c82b5f873dfe68f37f50022028109b4650f3f528ca4bfe9a467aff2e3e43893b61b5159157119d5d95cf1c1801008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9148a486ff2e31d6158bf39e2608864d63fefd09d5b88ac6868f7010000" },
7530
7531                                   { 3,
7532                                   "304402207475aeb0212ef9bf5130b60937817ad88c9a87976988ef1f323f026148cc4a850220739fea17ad3257dcad72e509c73eebe86bee30b178467b9fdab213d631b109df",
7533                                   "3045022100d315522e09e7d53d2a659a79cb67fef56d6c4bddf3f46df6772d0d20a7beb7c8022070bcc17e288607b6a72be0bd83368bb6d53488db266c1cdb4d72214e4f02ac33",
7534                                   "02000000000101adbe717a63fb658add30ada1e6e12ed257637581898abe475c11d7bbcd65bd4d03000000000000000001f2090000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e050047304402207475aeb0212ef9bf5130b60937817ad88c9a87976988ef1f323f026148cc4a850220739fea17ad3257dcad72e509c73eebe86bee30b178467b9fdab213d631b109df01483045022100d315522e09e7d53d2a659a79cb67fef56d6c4bddf3f46df6772d0d20a7beb7c8022070bcc17e288607b6a72be0bd83368bb6d53488db266c1cdb4d72214e4f02ac33012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000" }
7535                 } );
7536
7537                 // anchors: commitment tx with six outputs untrimmed (maximum feerate)
7538                 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
7539                 chan.feerate_per_kw = 2060;
7540
7541                 test_commitment_with_anchors!("304402206208aeb34e404bd052ce3f298dfa832891c9d42caec99fe2a0d2832e9690b94302201b034bfcc6fa9faec667a9b7cbfe0b8d85e954aa239b66277887b5088aff08c3",
7542                                  "304402201ce37a44b95213358c20f44404d6db7a6083bea6f58de6c46547ae41a47c9f8202206db1d45be41373e92f90d346381febbea8c78671b28c153e30ad1db3441a9497",
7543                                  "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b80084a010000000000002200202b1b5854183c12d3316565972c4668929d314d81c5dcdbb21cb45fe8a9a8114f4a01000000000000220020e9e86e4823faa62e222ebc858a226636856158f07e69898da3b0d1af0ddb3994d0070000000000002200203e68115ae0b15b8de75b6c6bc9af5ac9f01391544e0870dae443a1e8fe7837ead007000000000000220020fe0598d74fee2205cc3672e6e6647706b4f3099713b4661b62482c3addd04a5eb80b000000000000220020f96d0334feb64a4f40eb272031d07afcb038db56aa57446d60308c9f8ccadef9a00f000000000000220020ce6e751274836ff59622a0d1e07f8831d80bd6730bd48581398bfadd2bb8da9ac0c62d0000000000220020f3394e1e619b0eca1f91be2fb5ab4dfc59ba5b84ebe014ad1d43a564d012994ab88f6a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e040047304402201ce37a44b95213358c20f44404d6db7a6083bea6f58de6c46547ae41a47c9f8202206db1d45be41373e92f90d346381febbea8c78671b28c153e30ad1db3441a94970147304402206208aeb34e404bd052ce3f298dfa832891c9d42caec99fe2a0d2832e9690b94302201b034bfcc6fa9faec667a9b7cbfe0b8d85e954aa239b66277887b5088aff08c301475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {
7544
7545                                   { 0,
7546                                   "30440220011f999016570bbab9f3125377d0f35096b4dbe155f97c20f71829ead2817d1602201f23f7e17f6928734601c5d8613431eed5c90aa41c3106e8c1cb02ce32aacb5d",
7547                                   "3044022017da96dfb0eb4061fa0162dc6fa6b2e07ecc5040ab5e6cb07be59838460b3e58022079371ffc95002cc1dc2891ec38198c9c25aca8164304fe114f1b55e2ffd1ddd5",
7548                                   "02000000000101e7f364cf3a554b670767e723ef14b2af7a3eac70bd79dbde9256f384369c062d0200000000010000000175020000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e05004730440220011f999016570bbab9f3125377d0f35096b4dbe155f97c20f71829ead2817d1602201f23f7e17f6928734601c5d8613431eed5c90aa41c3106e8c1cb02ce32aacb5d83473044022017da96dfb0eb4061fa0162dc6fa6b2e07ecc5040ab5e6cb07be59838460b3e58022079371ffc95002cc1dc2891ec38198c9c25aca8164304fe114f1b55e2ffd1ddd501008876a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a914b43e1b38138a41b37f7cd9a1d274bc63e3a9b5d188ac6851b27568f6010000" },
7549
7550                                   { 1,
7551                                   "304402202d2d9681409b0a0987bd4a268ffeb112df85c4c988ac2a3a2475cb00a61912c302206aa4f4d1388b7d3282bc847871af3cca30766cc8f1064e3a41ec7e82221e10f7",
7552                                   "304402206426d67911aa6ff9b1cb147b093f3f65a37831a86d7c741d999afc0666e1773d022000bb71821650c70ea58d9bcdd03af736c41a5a8159d436c3ee0408a07394dcce",
7553                                   "02000000000101e7f364cf3a554b670767e723ef14b2af7a3eac70bd79dbde9256f384369c062d0300000000010000000122020000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e050047304402202d2d9681409b0a0987bd4a268ffeb112df85c4c988ac2a3a2475cb00a61912c302206aa4f4d1388b7d3282bc847871af3cca30766cc8f1064e3a41ec7e82221e10f78347304402206426d67911aa6ff9b1cb147b093f3f65a37831a86d7c741d999afc0666e1773d022000bb71821650c70ea58d9bcdd03af736c41a5a8159d436c3ee0408a07394dcce012001010101010101010101010101010101010101010101010101010101010101018d76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a9144b6b2e5444c2639cc0fb7bcea5afba3f3cdce23988527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f501b175ac6851b2756800000000" },
7554
7555                                   { 2,
7556                                   "3045022100f51cdaa525b7d4304548c642bb7945215eb5ae7d32874517cde67ca23ab0a12202206286d59e4b19926c6ac844be6f3ab8149a1ddb9c70f5026b7e83e40a6c08e6e1",
7557                                   "304502210091b16b1ac63b867e7a5ca0344f7b2aa1cdd49d4b72eac86a31e7ec6f069e20640220402bfb571ba3a9c49e3b0061c89303453803d0241059d899222aaac4799b5076",
7558                                   "02000000000101e7f364cf3a554b670767e723ef14b2af7a3eac70bd79dbde9256f384369c062d040000000001000000015d060000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100f51cdaa525b7d4304548c642bb7945215eb5ae7d32874517cde67ca23ab0a12202206286d59e4b19926c6ac844be6f3ab8149a1ddb9c70f5026b7e83e40a6c08e6e18348304502210091b16b1ac63b867e7a5ca0344f7b2aa1cdd49d4b72eac86a31e7ec6f069e20640220402bfb571ba3a9c49e3b0061c89303453803d0241059d899222aaac4799b507601008876a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9148a486ff2e31d6158bf39e2608864d63fefd09d5b88ac6851b27568f7010000" },
7559
7560                                   { 3,
7561                                   "304402202f058d99cb5a54f90773d43ba4e7a0089efd9f8269ef2da1b85d48a3e230555402205acc4bd6561830867d45cd7b84bba9fa35ad2b345016471c1737142bc99782c4",
7562                                   "304402202913f9cacea54efd2316cffa91219def9e0e111977216c1e76e9da80befab14f022000a9a69e8f37ebe4a39107ab50fab0dde537334588f8f412bbaca57b179b87a6",
7563                                   "02000000000101e7f364cf3a554b670767e723ef14b2af7a3eac70bd79dbde9256f384369c062d05000000000100000001f2090000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e050047304402202f058d99cb5a54f90773d43ba4e7a0089efd9f8269ef2da1b85d48a3e230555402205acc4bd6561830867d45cd7b84bba9fa35ad2b345016471c1737142bc99782c48347304402202913f9cacea54efd2316cffa91219def9e0e111977216c1e76e9da80befab14f022000a9a69e8f37ebe4a39107ab50fab0dde537334588f8f412bbaca57b179b87a6012004040404040404040404040404040404040404040404040404040404040404048d76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac6851b2756800000000" }
7564                 } );
7565
7566                 // commitment tx with five outputs untrimmed (minimum feerate)
7567                 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
7568                 chan.feerate_per_kw = 2070;
7569
7570                 test_commitment!("304402204ca1ba260dee913d318271d86e10ca0f5883026fb5653155cff600fb40895223022037b145204b7054a40e08bb1fefbd826f827b40838d3e501423bcc57924bcb50c",
7571                                  "3044022001014419b5ba00e083ac4e0a85f19afc848aacac2d483b4b525d15e2ae5adbfe022015ebddad6ee1e72b47cb09f3e78459da5be01ccccd95dceca0e056a00cc773c1",
7572                                  "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8005d007000000000000220020403d394747cae42e98ff01734ad5c08f82ba123d3d9a620abda88989651e2ab5b80b000000000000220020c20b5d1f8584fd90443e7b7b720136174fa4b9333c261d04dbbd012635c0f419a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e484da966a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0400473044022001014419b5ba00e083ac4e0a85f19afc848aacac2d483b4b525d15e2ae5adbfe022015ebddad6ee1e72b47cb09f3e78459da5be01ccccd95dceca0e056a00cc773c10147304402204ca1ba260dee913d318271d86e10ca0f5883026fb5653155cff600fb40895223022037b145204b7054a40e08bb1fefbd826f827b40838d3e501423bcc57924bcb50c01475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {
7573
7574                                   { 0,
7575                                   "304402205f6b6d12d8d2529fb24f4445630566cf4abbd0f9330ab6c2bdb94222d6a2a0c502202f556258ae6f05b193749e4c541dfcc13b525a5422f6291f073f15617ba8579b",
7576                                   "30440220150b11069454da70caf2492ded9e0065c9a57f25ac2a4c52657b1d15b6c6ed85022068a38833b603c8892717206383611bad210f1cbb4b1f87ea29c6c65b9e1cb3e5",
7577                                   "02000000000101403ad7602b43293497a3a2235a12ecefda4f3a1f1d06e49b1786d945685de1ff0000000000000000000174020000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e050047304402205f6b6d12d8d2529fb24f4445630566cf4abbd0f9330ab6c2bdb94222d6a2a0c502202f556258ae6f05b193749e4c541dfcc13b525a5422f6291f073f15617ba8579b014730440220150b11069454da70caf2492ded9e0065c9a57f25ac2a4c52657b1d15b6c6ed85022068a38833b603c8892717206383611bad210f1cbb4b1f87ea29c6c65b9e1cb3e501008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a914b43e1b38138a41b37f7cd9a1d274bc63e3a9b5d188ac6868f6010000" },
7578
7579                                   { 1,
7580                                   "3045022100f960dfb1c9aee7ce1437efa65b523e399383e8149790e05d8fed27ff6e42fe0002202fe8613e062ffe0b0c518cc4101fba1c6de70f64a5bcc7ae663f2efae43b8546",
7581                                   "30450221009a6ed18e6873bc3644332a6ee21c152a5b102821865350df7a8c74451a51f9f2022050d801fb4895d7d7fbf452824c0168347f5c0cbe821cf6a97a63af5b8b2563c6",
7582                                   "02000000000101403ad7602b43293497a3a2235a12ecefda4f3a1f1d06e49b1786d945685de1ff010000000000000000015c060000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100f960dfb1c9aee7ce1437efa65b523e399383e8149790e05d8fed27ff6e42fe0002202fe8613e062ffe0b0c518cc4101fba1c6de70f64a5bcc7ae663f2efae43b8546014830450221009a6ed18e6873bc3644332a6ee21c152a5b102821865350df7a8c74451a51f9f2022050d801fb4895d7d7fbf452824c0168347f5c0cbe821cf6a97a63af5b8b2563c601008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9148a486ff2e31d6158bf39e2608864d63fefd09d5b88ac6868f7010000" },
7583
7584                                   { 2,
7585                                   "3045022100ae5fc7717ae684bc1fcf9020854e5dbe9842c9e7472879ac06ff95ac2bb10e4e022057728ada4c00083a3e65493fb5d50a232165948a1a0f530ef63185c2c8c56504",
7586                                   "30440220408ad3009827a8fccf774cb285587686bfb2ed041f89a89453c311ce9c8ee0f902203c7392d9f8306d3a46522a66bd2723a7eb2628cb2d9b34d4c104f1766bf37502",
7587                                   "02000000000101403ad7602b43293497a3a2235a12ecefda4f3a1f1d06e49b1786d945685de1ff02000000000000000001f1090000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100ae5fc7717ae684bc1fcf9020854e5dbe9842c9e7472879ac06ff95ac2bb10e4e022057728ada4c00083a3e65493fb5d50a232165948a1a0f530ef63185c2c8c56504014730440220408ad3009827a8fccf774cb285587686bfb2ed041f89a89453c311ce9c8ee0f902203c7392d9f8306d3a46522a66bd2723a7eb2628cb2d9b34d4c104f1766bf37502012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000" }
7588                 } );
7589
7590                 // anchors: commitment tx with five outputs untrimmed (minimum feerate)
7591                 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
7592                 chan.feerate_per_kw = 2061;
7593
7594                 test_commitment_with_anchors!("3045022100a2faf2ad7e323b2a82e07dc40b6847207ca6ad7b089f2c21dea9a4d37e52d59d02204c9480ce0358eb51d92a4342355a97e272e3cc45f86c612a76a3fe32fc3c4cb4",
7595                                  "304402204ab07c659412dd2cd6043b1ad811ab215e901b6b5653e08cb3d2fe63d3e3dc57022031c7b3d130f9380ef09581f4f5a15cb6f359a2e0a597146b96c3533a26d6f4cd",
7596                                  "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b80074a010000000000002200202b1b5854183c12d3316565972c4668929d314d81c5dcdbb21cb45fe8a9a8114f4a01000000000000220020e9e86e4823faa62e222ebc858a226636856158f07e69898da3b0d1af0ddb3994d0070000000000002200203e68115ae0b15b8de75b6c6bc9af5ac9f01391544e0870dae443a1e8fe7837eab80b000000000000220020f96d0334feb64a4f40eb272031d07afcb038db56aa57446d60308c9f8ccadef9a00f000000000000220020ce6e751274836ff59622a0d1e07f8831d80bd6730bd48581398bfadd2bb8da9ac0c62d0000000000220020f3394e1e619b0eca1f91be2fb5ab4dfc59ba5b84ebe014ad1d43a564d012994a18916a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e040047304402204ab07c659412dd2cd6043b1ad811ab215e901b6b5653e08cb3d2fe63d3e3dc57022031c7b3d130f9380ef09581f4f5a15cb6f359a2e0a597146b96c3533a26d6f4cd01483045022100a2faf2ad7e323b2a82e07dc40b6847207ca6ad7b089f2c21dea9a4d37e52d59d02204c9480ce0358eb51d92a4342355a97e272e3cc45f86c612a76a3fe32fc3c4cb401475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {
7597
7598                                   { 0,
7599                                   "3045022100e10744f572a2cd1d787c969e894b792afaed21217ee0480df0112d2fa3ef96ea02202af4f66eb6beebc36d8e98719ed6b4be1b181659fcb561fc491d8cfebff3aa85",
7600                                   "3045022100c3dc3ea50a0ca20e350f97b50c52c5514717cfa36cb9600918caac5cb556842b022049af018d676dde0c8e28ecf325f3ff5c1594261c4f7511d501f9d62d0594d2a2",
7601                                   "02000000000101cf32732fe2d1387ed4e2335f69ddd3c0f337dabc03269e742531f89d35e161d10200000000010000000174020000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100e10744f572a2cd1d787c969e894b792afaed21217ee0480df0112d2fa3ef96ea02202af4f66eb6beebc36d8e98719ed6b4be1b181659fcb561fc491d8cfebff3aa8583483045022100c3dc3ea50a0ca20e350f97b50c52c5514717cfa36cb9600918caac5cb556842b022049af018d676dde0c8e28ecf325f3ff5c1594261c4f7511d501f9d62d0594d2a201008876a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a914b43e1b38138a41b37f7cd9a1d274bc63e3a9b5d188ac6851b27568f6010000" },
7602
7603                                   { 1,
7604                                   "3045022100e1f51fb72fec604b029b348a3bb6363454e1869f5b1e24fd736f860c8039f8070220030a2c90186437d8c9b47d4897798c024521b1274991c4cdc125970b346094b1",
7605                                   "3045022100ec7ade6037e531629f24390ca9713782a04d648065d17fbe6b015981cdb296c202202d61049a6ecba2fb5314f3edcda2361cad187a89bea6e5d15185354d80c0c085",
7606                                   "02000000000101cf32732fe2d1387ed4e2335f69ddd3c0f337dabc03269e742531f89d35e161d1030000000001000000015c060000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100e1f51fb72fec604b029b348a3bb6363454e1869f5b1e24fd736f860c8039f8070220030a2c90186437d8c9b47d4897798c024521b1274991c4cdc125970b346094b183483045022100ec7ade6037e531629f24390ca9713782a04d648065d17fbe6b015981cdb296c202202d61049a6ecba2fb5314f3edcda2361cad187a89bea6e5d15185354d80c0c08501008876a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9148a486ff2e31d6158bf39e2608864d63fefd09d5b88ac6851b27568f7010000" },
7607
7608                                   { 2,
7609                                   "304402203479f81a1d83c516957679dc98bf91d35deada967739a8e3869e3e8db08246130220053c8e154b97e3019048dcec3d51bfaf396f36861fbda6d33f0e2a57155c8b9f",
7610                                   "3045022100a558eb5caa04e35a4417c1f0123ac12eec5f6badee28f5764dc6b69486e594f802201589b12784e242f205832d2d032149bd4e79433ec304c05394241fc7dcba5a71",
7611                                   "02000000000101cf32732fe2d1387ed4e2335f69ddd3c0f337dabc03269e742531f89d35e161d104000000000100000001f1090000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e050047304402203479f81a1d83c516957679dc98bf91d35deada967739a8e3869e3e8db08246130220053c8e154b97e3019048dcec3d51bfaf396f36861fbda6d33f0e2a57155c8b9f83483045022100a558eb5caa04e35a4417c1f0123ac12eec5f6badee28f5764dc6b69486e594f802201589b12784e242f205832d2d032149bd4e79433ec304c05394241fc7dcba5a71012004040404040404040404040404040404040404040404040404040404040404048d76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac6851b2756800000000" }
7612                 } );
7613
7614                 // commitment tx with five outputs untrimmed (maximum feerate)
7615                 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
7616                 chan.feerate_per_kw = 2194;
7617
7618                 test_commitment!("304402204bb3d6e279d71d9da414c82de42f1f954267c762b2e2eb8b76bc3be4ea07d4b0022014febc009c5edc8c3fc5d94015de163200f780046f1c293bfed8568f08b70fb3",
7619                                  "3044022072c2e2b1c899b2242656a537dde2892fa3801be0d6df0a87836c550137acde8302201654aa1974d37a829083c3ba15088689f30b56d6a4f6cb14c7bad0ee3116d398",
7620                                  "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8005d007000000000000220020403d394747cae42e98ff01734ad5c08f82ba123d3d9a620abda88989651e2ab5b80b000000000000220020c20b5d1f8584fd90443e7b7b720136174fa4b9333c261d04dbbd012635c0f419a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e48440966a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0400473044022072c2e2b1c899b2242656a537dde2892fa3801be0d6df0a87836c550137acde8302201654aa1974d37a829083c3ba15088689f30b56d6a4f6cb14c7bad0ee3116d3980147304402204bb3d6e279d71d9da414c82de42f1f954267c762b2e2eb8b76bc3be4ea07d4b0022014febc009c5edc8c3fc5d94015de163200f780046f1c293bfed8568f08b70fb301475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {
7621
7622                                   { 0,
7623                                   "3045022100939726680351a7856c1bc386d4a1f422c7d29bd7b56afc139570f508474e6c40022023175a799ccf44c017fbaadb924c40b2a12115a5b7d0dfd3228df803a2de8450",
7624                                   "304502210099c98c2edeeee6ec0fb5f3bea8b79bb016a2717afa9b5072370f34382de281d302206f5e2980a995e045cf90a547f0752a7ee99d48547bc135258fe7bc07e0154301",
7625                                   "02000000000101153cd825fdb3aa624bfe513e8031d5d08c5e582fb3d1d1fe8faf27d3eed410cd0000000000000000000122020000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100939726680351a7856c1bc386d4a1f422c7d29bd7b56afc139570f508474e6c40022023175a799ccf44c017fbaadb924c40b2a12115a5b7d0dfd3228df803a2de84500148304502210099c98c2edeeee6ec0fb5f3bea8b79bb016a2717afa9b5072370f34382de281d302206f5e2980a995e045cf90a547f0752a7ee99d48547bc135258fe7bc07e015430101008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a914b43e1b38138a41b37f7cd9a1d274bc63e3a9b5d188ac6868f6010000" },
7626
7627                                   { 1,
7628                                   "3044022021bb883bf324553d085ba2e821cad80c28ef8b303dbead8f98e548783c02d1600220638f9ef2a9bba25869afc923f4b5dc38be3bb459f9efa5d869392d5f7779a4a0",
7629                                   "3045022100fd85bd7697b89c08ec12acc8ba89b23090637d83abd26ca37e01ae93e67c367302202b551fe69386116c47f984aab9c8dfd25d864dcde5d3389cfbef2447a85c4b77",
7630                                   "02000000000101153cd825fdb3aa624bfe513e8031d5d08c5e582fb3d1d1fe8faf27d3eed410cd010000000000000000010a060000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500473044022021bb883bf324553d085ba2e821cad80c28ef8b303dbead8f98e548783c02d1600220638f9ef2a9bba25869afc923f4b5dc38be3bb459f9efa5d869392d5f7779a4a001483045022100fd85bd7697b89c08ec12acc8ba89b23090637d83abd26ca37e01ae93e67c367302202b551fe69386116c47f984aab9c8dfd25d864dcde5d3389cfbef2447a85c4b7701008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9148a486ff2e31d6158bf39e2608864d63fefd09d5b88ac6868f7010000" },
7631
7632                                   { 2,
7633                                   "3045022100c9e6f0454aa598b905a35e641a70cc9f67b5f38cc4b00843a041238c4a9f1c4a0220260a2822a62da97e44583e837245995ca2e36781769c52f19e498efbdcca262b",
7634                                   "30450221008a9f2ea24cd455c2b64c1472a5fa83865b0a5f49a62b661801e884cf2849af8302204d44180e50bf6adfcf1c1e581d75af91aba4e28681ce4a5ee5f3cbf65eca10f3",
7635                                   "02000000000101153cd825fdb3aa624bfe513e8031d5d08c5e582fb3d1d1fe8faf27d3eed410cd020000000000000000019a090000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100c9e6f0454aa598b905a35e641a70cc9f67b5f38cc4b00843a041238c4a9f1c4a0220260a2822a62da97e44583e837245995ca2e36781769c52f19e498efbdcca262b014830450221008a9f2ea24cd455c2b64c1472a5fa83865b0a5f49a62b661801e884cf2849af8302204d44180e50bf6adfcf1c1e581d75af91aba4e28681ce4a5ee5f3cbf65eca10f3012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000" }
7636                 } );
7637
7638                 // anchors: commitment tx with five outputs untrimmed (maximum feerate)
7639                 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
7640                 chan.feerate_per_kw = 2184;
7641
7642                 test_commitment_with_anchors!("3044022013d326f80ff7607cf366c823fcbbcb7a2b10322484825f151e6c4c756af24b8f02201ba05b9d8beb7cea2947f9f4d9e03f90435e93db2dd48b32eb9ca3f3dd042c79",
7643                                  "30440220555c05261f72c5b4702d5c83a608630822b473048724b08640d6e75e345094250220448950b74a96a56963928ba5db8b457661a742c855e69d239b3b6ab73de307a3",
7644                                  "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b80074a010000000000002200202b1b5854183c12d3316565972c4668929d314d81c5dcdbb21cb45fe8a9a8114f4a01000000000000220020e9e86e4823faa62e222ebc858a226636856158f07e69898da3b0d1af0ddb3994d0070000000000002200203e68115ae0b15b8de75b6c6bc9af5ac9f01391544e0870dae443a1e8fe7837eab80b000000000000220020f96d0334feb64a4f40eb272031d07afcb038db56aa57446d60308c9f8ccadef9a00f000000000000220020ce6e751274836ff59622a0d1e07f8831d80bd6730bd48581398bfadd2bb8da9ac0c62d0000000000220020f3394e1e619b0eca1f91be2fb5ab4dfc59ba5b84ebe014ad1d43a564d012994a4f906a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e04004730440220555c05261f72c5b4702d5c83a608630822b473048724b08640d6e75e345094250220448950b74a96a56963928ba5db8b457661a742c855e69d239b3b6ab73de307a301473044022013d326f80ff7607cf366c823fcbbcb7a2b10322484825f151e6c4c756af24b8f02201ba05b9d8beb7cea2947f9f4d9e03f90435e93db2dd48b32eb9ca3f3dd042c7901475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {
7645
7646                                   { 0,
7647                                   "304402202e03ba1390998b3487e9a7fefcb66814c09abea0ef1bcc915dbaefbcf310569a02206bd10493a105ac69048e9bcedcb8e3301ef81b55018d911a4afd297297f98d30",
7648                                   "304402200c3952ca04be0c60dcc0b7873a0829f560607524943554ae4a27d8d967166199022021a68657b88e22f9bf9ac6065be412685aff643d17049f04f2e99e86197dabb1",
7649                                   "020000000001015b03043e20eb467029305a22af4c3b915e793743f192c5d225cf1d3c6e8c03010200000000010000000122020000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e050047304402202e03ba1390998b3487e9a7fefcb66814c09abea0ef1bcc915dbaefbcf310569a02206bd10493a105ac69048e9bcedcb8e3301ef81b55018d911a4afd297297f98d308347304402200c3952ca04be0c60dcc0b7873a0829f560607524943554ae4a27d8d967166199022021a68657b88e22f9bf9ac6065be412685aff643d17049f04f2e99e86197dabb101008876a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a914b43e1b38138a41b37f7cd9a1d274bc63e3a9b5d188ac6851b27568f6010000" },
7650
7651                                   { 1,
7652                                   "304402201f8a6adda2403bc400c919ea69d72d315337291e00d02cde085ea32953dbc50002202d65230da98df7af8ebefd2b60b457d0945232988ee2d7460a94a77d414a9acc",
7653                                   "3045022100ea69c9273b8914ac62b5b7082d6ac1da2b7b065ebf2ef3cd6403f5305ce3f26802203d98736ea97638895a898dfcc5ee0d0c55eb496b3964df0bb25d223688ea8b87",
7654                                   "020000000001015b03043e20eb467029305a22af4c3b915e793743f192c5d225cf1d3c6e8c0301030000000001000000010a060000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e050047304402201f8a6adda2403bc400c919ea69d72d315337291e00d02cde085ea32953dbc50002202d65230da98df7af8ebefd2b60b457d0945232988ee2d7460a94a77d414a9acc83483045022100ea69c9273b8914ac62b5b7082d6ac1da2b7b065ebf2ef3cd6403f5305ce3f26802203d98736ea97638895a898dfcc5ee0d0c55eb496b3964df0bb25d223688ea8b8701008876a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9148a486ff2e31d6158bf39e2608864d63fefd09d5b88ac6851b27568f7010000" },
7655
7656                                   { 2,
7657                                   "3045022100ea6e4c9b8f56dd9cf5799492a201cdd65b8bc9bc089c3cff34107896ae313f90022034760f7760975cc68e8917a7f62894e25583da7be11af557c4fc402661d0cbf8",
7658                                   "30440220717012f2f7ef6cac590aaf66c2109132c93ffba245959ac62d82e394ba80191302203f00fd9cb37c92c6b0ad4b33e62c3e55b04e5c2cfa0adcca5a9bc49774eeca8a",
7659                                   "020000000001015b03043e20eb467029305a22af4c3b915e793743f192c5d225cf1d3c6e8c0301040000000001000000019b090000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100ea6e4c9b8f56dd9cf5799492a201cdd65b8bc9bc089c3cff34107896ae313f90022034760f7760975cc68e8917a7f62894e25583da7be11af557c4fc402661d0cbf8834730440220717012f2f7ef6cac590aaf66c2109132c93ffba245959ac62d82e394ba80191302203f00fd9cb37c92c6b0ad4b33e62c3e55b04e5c2cfa0adcca5a9bc49774eeca8a012004040404040404040404040404040404040404040404040404040404040404048d76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac6851b2756800000000" }
7660                 } );
7661
7662                 // commitment tx with four outputs untrimmed (minimum feerate)
7663                 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
7664                 chan.feerate_per_kw = 2195;
7665
7666                 test_commitment!("304402201a8c1b1f9671cd9e46c7323a104d7047cc48d3ee80d40d4512e0c72b8dc65666022066d7f9a2ce18c9eb22d2739ffcce05721c767f9b607622a31b6ea5793ddce403",
7667                                  "3044022044d592025b610c0d678f65032e87035cdfe89d1598c522cc32524ae8172417c30220749fef9d5b2ae8cdd91ece442ba8809bc891efedae2291e578475f97715d1767",
7668                                  "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8004b80b000000000000220020c20b5d1f8584fd90443e7b7b720136174fa4b9333c261d04dbbd012635c0f419a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e484b8976a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0400473044022044d592025b610c0d678f65032e87035cdfe89d1598c522cc32524ae8172417c30220749fef9d5b2ae8cdd91ece442ba8809bc891efedae2291e578475f97715d17670147304402201a8c1b1f9671cd9e46c7323a104d7047cc48d3ee80d40d4512e0c72b8dc65666022066d7f9a2ce18c9eb22d2739ffcce05721c767f9b607622a31b6ea5793ddce40301475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {
7669
7670                                   { 0,
7671                                   "3045022100e57b845066a06ee7c2cbfc29eabffe52daa9bf6f6de760066d04df9f9b250e0002202ffb197f0e6e0a77a75a9aff27014bd3de83b7f748d7efef986abe655e1dd50e",
7672                                   "3045022100ecc8c6529d0b2316d046f0f0757c1e1c25a636db168ec4f3aa1b9278df685dc0022067ae6b65e936f1337091f7b18a15935b608c5f2cdddb2f892ed0babfdd376d76",
7673                                   "020000000001018130a10f09b13677ba2885a8bca32860f3a952e5912b829a473639b5a2c07b900000000000000000000109060000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100e57b845066a06ee7c2cbfc29eabffe52daa9bf6f6de760066d04df9f9b250e0002202ffb197f0e6e0a77a75a9aff27014bd3de83b7f748d7efef986abe655e1dd50e01483045022100ecc8c6529d0b2316d046f0f0757c1e1c25a636db168ec4f3aa1b9278df685dc0022067ae6b65e936f1337091f7b18a15935b608c5f2cdddb2f892ed0babfdd376d7601008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9148a486ff2e31d6158bf39e2608864d63fefd09d5b88ac6868f7010000" },
7674
7675                                   { 1,
7676                                   "3045022100d193b7ecccad8057571620a0b1ffa6c48e9483311723b59cf536043b20bc51550220546d4bd37b3b101ecda14f6c907af46ec391abce1cd9c7ce22b1a62b534f2f2a",
7677                                   "3044022014d66f11f9cacf923807eba49542076c5fe5cccf252fb08fe98c78ef3ca6ab5402201b290dbe043cc512d9d78de074a5a129b8759bc6a6c546b190d120b690bd6e82",
7678                                   "020000000001018130a10f09b13677ba2885a8bca32860f3a952e5912b829a473639b5a2c07b900100000000000000000199090000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100d193b7ecccad8057571620a0b1ffa6c48e9483311723b59cf536043b20bc51550220546d4bd37b3b101ecda14f6c907af46ec391abce1cd9c7ce22b1a62b534f2f2a01473044022014d66f11f9cacf923807eba49542076c5fe5cccf252fb08fe98c78ef3ca6ab5402201b290dbe043cc512d9d78de074a5a129b8759bc6a6c546b190d120b690bd6e82012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000" }
7679                 } );
7680
7681                 // anchors: commitment tx with four outputs untrimmed (minimum feerate)
7682                 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
7683                 chan.feerate_per_kw = 2185;
7684
7685                 test_commitment_with_anchors!("3044022040f63a16148cf35c8d3d41827f5ae7f7c3746885bb64d4d1b895892a83812b3e02202fcf95c2bf02c466163b3fa3ced6a24926fbb4035095a96842ef516e86ba54c0",
7686                                  "3045022100cd8479cfe1edb1e5a1d487391e0451a469c7171e51e680183f19eb4321f20e9b02204eab7d5a6384b1b08e03baa6e4d9748dfd2b5ab2bae7e39604a0d0055bbffdd5",
7687                                  "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b80064a010000000000002200202b1b5854183c12d3316565972c4668929d314d81c5dcdbb21cb45fe8a9a8114f4a01000000000000220020e9e86e4823faa62e222ebc858a226636856158f07e69898da3b0d1af0ddb3994b80b000000000000220020f96d0334feb64a4f40eb272031d07afcb038db56aa57446d60308c9f8ccadef9a00f000000000000220020ce6e751274836ff59622a0d1e07f8831d80bd6730bd48581398bfadd2bb8da9ac0c62d0000000000220020f3394e1e619b0eca1f91be2fb5ab4dfc59ba5b84ebe014ad1d43a564d012994ac5916a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0400483045022100cd8479cfe1edb1e5a1d487391e0451a469c7171e51e680183f19eb4321f20e9b02204eab7d5a6384b1b08e03baa6e4d9748dfd2b5ab2bae7e39604a0d0055bbffdd501473044022040f63a16148cf35c8d3d41827f5ae7f7c3746885bb64d4d1b895892a83812b3e02202fcf95c2bf02c466163b3fa3ced6a24926fbb4035095a96842ef516e86ba54c001475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {
7688
7689                                   { 0,
7690                                   "304502210094480e38afb41d10fae299224872f19c53abe23c7033a1c0642c48713e7863a10220726dd9456407682667dc4bd9c66975acb3744961770b5002f7eb9c0df9ef2f3e",
7691                                   "304402203148dac61513dc0361738cba30cb341a1e580f8acd5ab0149bf65bd670688cf002207e5d9a0fcbbea2c263bc714fa9e9c44d7f582ea447f366119fc614a23de32f1f",
7692                                   "02000000000101ac13a7715f80b8e52dda43c6929cade5521bdced3a405da02b443f1ffb1e33cc0200000000010000000109060000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e050048304502210094480e38afb41d10fae299224872f19c53abe23c7033a1c0642c48713e7863a10220726dd9456407682667dc4bd9c66975acb3744961770b5002f7eb9c0df9ef2f3e8347304402203148dac61513dc0361738cba30cb341a1e580f8acd5ab0149bf65bd670688cf002207e5d9a0fcbbea2c263bc714fa9e9c44d7f582ea447f366119fc614a23de32f1f01008876a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9148a486ff2e31d6158bf39e2608864d63fefd09d5b88ac6851b27568f7010000" },
7693
7694                                   { 1,
7695                                   "304402200dbde868dbc20c6a2433fe8979ba5e3f966b1c2d1aeb615f1c42e9c938b3495402202eec5f663c8b601c2061c1453d35de22597c137d1907a2feaf714d551035cb6e",
7696                                   "3045022100b896bded41d7feac7af25c19e35c53037c53b50e73cfd01eb4ba139c7fdf231602203a3be049d3d89396c4dc766d82ce31e237da8bc3a93e2c7d35992d1932d9cfeb",
7697                                   "02000000000101ac13a7715f80b8e52dda43c6929cade5521bdced3a405da02b443f1ffb1e33cc030000000001000000019a090000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e050047304402200dbde868dbc20c6a2433fe8979ba5e3f966b1c2d1aeb615f1c42e9c938b3495402202eec5f663c8b601c2061c1453d35de22597c137d1907a2feaf714d551035cb6e83483045022100b896bded41d7feac7af25c19e35c53037c53b50e73cfd01eb4ba139c7fdf231602203a3be049d3d89396c4dc766d82ce31e237da8bc3a93e2c7d35992d1932d9cfeb012004040404040404040404040404040404040404040404040404040404040404048d76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac6851b2756800000000" }
7698                 } );
7699
7700                 // commitment tx with four outputs untrimmed (maximum feerate)
7701                 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
7702                 chan.feerate_per_kw = 3702;
7703
7704                 test_commitment!("304502210092a587aeb777f869e7ff0d7898ea619ee26a3dacd1f3672b945eea600be431100220077ee9eae3528d15251f2a52b607b189820e57a6ccfac8d1af502b132ee40169",
7705                                  "3045022100e5efb73c32d32da2d79702299b6317de6fb24a60476e3855926d78484dd1b3c802203557cb66a42c944ef06e00bcc4da35a5bcb2f185aab0f8e403e519e1d66aaf75",
7706                                  "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8004b80b000000000000220020c20b5d1f8584fd90443e7b7b720136174fa4b9333c261d04dbbd012635c0f419a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e4846f916a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0400483045022100e5efb73c32d32da2d79702299b6317de6fb24a60476e3855926d78484dd1b3c802203557cb66a42c944ef06e00bcc4da35a5bcb2f185aab0f8e403e519e1d66aaf750148304502210092a587aeb777f869e7ff0d7898ea619ee26a3dacd1f3672b945eea600be431100220077ee9eae3528d15251f2a52b607b189820e57a6ccfac8d1af502b132ee4016901475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {
7707
7708                                   { 0,
7709                                   "304402206fa54c11f98c3bae1e93df43fc7affeb05b476bf8060c03e29c377c69bc08e8b0220672701cce50d5c379ff45a5d2cfe48ac44973adb066ac32608e21221d869bb89",
7710                                   "304402206e36c683ebf2cb16bcef3d5439cf8b53cd97280a365ed8acd7abb85a8ba5f21c02206e8621edfc2a5766cbc96eb67fd501127ff163eb6b85518a39f7d4974aef126f",
7711                                   "020000000001018db483bff65c70ee71d8282aeec5a880e2e2b39e45772bda5460403095c62e3f0000000000000000000122020000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e050047304402206fa54c11f98c3bae1e93df43fc7affeb05b476bf8060c03e29c377c69bc08e8b0220672701cce50d5c379ff45a5d2cfe48ac44973adb066ac32608e21221d869bb890147304402206e36c683ebf2cb16bcef3d5439cf8b53cd97280a365ed8acd7abb85a8ba5f21c02206e8621edfc2a5766cbc96eb67fd501127ff163eb6b85518a39f7d4974aef126f01008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9148a486ff2e31d6158bf39e2608864d63fefd09d5b88ac6868f7010000" },
7712
7713                                   { 1,
7714                                   "3044022057649739b0eb74d541ead0dfdb3d4b2c15aa192720031044c3434c67812e5ca902201e5ede42d960ae551707f4a6b34b09393cf4dee2418507daa022e3550dbb5817",
7715                                   "304402207faad26678c8850e01b4a0696d60841f7305e1832b786110ee9075cb92ed14a30220516ef8ee5dfa80824ea28cbcec0dd95f8b847146257c16960db98507db15ffdc",
7716                                   "020000000001018db483bff65c70ee71d8282aeec5a880e2e2b39e45772bda5460403095c62e3f0100000000000000000176050000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500473044022057649739b0eb74d541ead0dfdb3d4b2c15aa192720031044c3434c67812e5ca902201e5ede42d960ae551707f4a6b34b09393cf4dee2418507daa022e3550dbb58170147304402207faad26678c8850e01b4a0696d60841f7305e1832b786110ee9075cb92ed14a30220516ef8ee5dfa80824ea28cbcec0dd95f8b847146257c16960db98507db15ffdc012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000" }
7717                 } );
7718
7719                 // anchors: commitment tx with four outputs untrimmed (maximum feerate)
7720                 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
7721                 chan.feerate_per_kw = 3686;
7722
7723                 test_commitment_with_anchors!("30440220784485cf7a0ad7979daf2c858ffdaf5298d0020cea7aea466843e7948223bd9902206031b81d25e02a178c64e62f843577fdcdfc7a1decbbfb54cd895de692df85ca",
7724                                  "3045022100c268496aad5c3f97f25cf41c1ba5483a12982de29b222051b6de3daa2229413b02207f3c82d77a2c14f0096ed9bb4c34649483bb20fa71f819f71af44de6593e8bb2",
7725                                  "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b80064a010000000000002200202b1b5854183c12d3316565972c4668929d314d81c5dcdbb21cb45fe8a9a8114f4a01000000000000220020e9e86e4823faa62e222ebc858a226636856158f07e69898da3b0d1af0ddb3994b80b000000000000220020f96d0334feb64a4f40eb272031d07afcb038db56aa57446d60308c9f8ccadef9a00f000000000000220020ce6e751274836ff59622a0d1e07f8831d80bd6730bd48581398bfadd2bb8da9ac0c62d0000000000220020f3394e1e619b0eca1f91be2fb5ab4dfc59ba5b84ebe014ad1d43a564d012994a29896a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0400483045022100c268496aad5c3f97f25cf41c1ba5483a12982de29b222051b6de3daa2229413b02207f3c82d77a2c14f0096ed9bb4c34649483bb20fa71f819f71af44de6593e8bb2014730440220784485cf7a0ad7979daf2c858ffdaf5298d0020cea7aea466843e7948223bd9902206031b81d25e02a178c64e62f843577fdcdfc7a1decbbfb54cd895de692df85ca01475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {
7726
7727                                   { 0,
7728                                   "304402202cfe6618926ca9f1574f8c4659b425e9790b4677ba2248d77901290806130ffe02204ab37bb0287abcdb8b750b018d41a09effe37cb65ff801fa70d3f1a416599841",
7729                                   "3044022030b318139715e3b34f19be852cc01c1c0e1599e8b926a73df2bfb70dd186ddee022062a2b7398aed9f563b4014da04a1a99debd0ff663ceece68a547df5982dc2d72",
7730                                   "020000000001012c32e55722e4b96324d8e5b398d583a20780b25202816adc32dc3157dee731c90200000000010000000122020000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e050047304402202cfe6618926ca9f1574f8c4659b425e9790b4677ba2248d77901290806130ffe02204ab37bb0287abcdb8b750b018d41a09effe37cb65ff801fa70d3f1a41659984183473044022030b318139715e3b34f19be852cc01c1c0e1599e8b926a73df2bfb70dd186ddee022062a2b7398aed9f563b4014da04a1a99debd0ff663ceece68a547df5982dc2d7201008876a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9148a486ff2e31d6158bf39e2608864d63fefd09d5b88ac6851b27568f7010000" },
7731
7732                                   { 1,
7733                                   "30440220687af8544d335376620a6f4b5412bfd0da48de047c1785674f26e669d4a3ff82022058591c1e3a6c50017427d38a8f756eb685bdab88ec73838eed3530048861f9d5",
7734                                   "30440220109f1a62b5a13d28d5b7634dd7693b1d5994eb404c4bb4a9a80aa540d3984d170220307251107ff8499a23e99abce7dda4f1c707c98abddb9405a83de0081cde8ace",
7735                                   "020000000001012c32e55722e4b96324d8e5b398d583a20780b25202816adc32dc3157dee731c90300000000010000000176050000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e05004730440220687af8544d335376620a6f4b5412bfd0da48de047c1785674f26e669d4a3ff82022058591c1e3a6c50017427d38a8f756eb685bdab88ec73838eed3530048861f9d5834730440220109f1a62b5a13d28d5b7634dd7693b1d5994eb404c4bb4a9a80aa540d3984d170220307251107ff8499a23e99abce7dda4f1c707c98abddb9405a83de0081cde8ace012004040404040404040404040404040404040404040404040404040404040404048d76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac6851b2756800000000" }
7736                 } );
7737
7738                 // commitment tx with three outputs untrimmed (minimum feerate)
7739                 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
7740                 chan.feerate_per_kw = 3703;
7741
7742                 test_commitment!("3045022100b495d239772a237ff2cf354b1b11be152fd852704cb184e7356d13f2fb1e5e430220723db5cdb9cbd6ead7bfd3deb419cf41053a932418cbb22a67b581f40bc1f13e",
7743                                  "304402201b736d1773a124c745586217a75bed5f66c05716fbe8c7db4fdb3c3069741cdd02205083f39c321c1bcadfc8d97e3c791a66273d936abac0c6a2fde2ed46019508e1",
7744                                  "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8003a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e484eb936a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e040047304402201b736d1773a124c745586217a75bed5f66c05716fbe8c7db4fdb3c3069741cdd02205083f39c321c1bcadfc8d97e3c791a66273d936abac0c6a2fde2ed46019508e101483045022100b495d239772a237ff2cf354b1b11be152fd852704cb184e7356d13f2fb1e5e430220723db5cdb9cbd6ead7bfd3deb419cf41053a932418cbb22a67b581f40bc1f13e01475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {
7745
7746                                   { 0,
7747                                   "3045022100c34c61735f93f2e324cc873c3b248111ccf8f6db15d5969583757010d4ad2b4602207867bb919b2ddd6387873e425345c9b7fd18d1d66aba41f3607bc2896ef3c30a",
7748                                   "3045022100988c143e2110067117d2321bdd4bd16ca1734c98b29290d129384af0962b634e02206c1b02478878c5f547018b833986578f90c3e9be669fe5788ad0072a55acbb05",
7749                                   "0200000000010120060e4a29579d429f0f27c17ee5f1ee282f20d706d6f90b63d35946d8f3029a0000000000000000000175050000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100c34c61735f93f2e324cc873c3b248111ccf8f6db15d5969583757010d4ad2b4602207867bb919b2ddd6387873e425345c9b7fd18d1d66aba41f3607bc2896ef3c30a01483045022100988c143e2110067117d2321bdd4bd16ca1734c98b29290d129384af0962b634e02206c1b02478878c5f547018b833986578f90c3e9be669fe5788ad0072a55acbb05012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000" }
7750                 } );
7751
7752                 // anchors: commitment tx with three outputs untrimmed (minimum feerate)
7753                 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
7754                 chan.feerate_per_kw = 3687;
7755
7756                 test_commitment_with_anchors!("3045022100ad6c71569856b2d7ff42e838b4abe74a713426b37f22fa667a195a4c88908c6902202b37272b02a42dc6d9f4f82cab3eaf84ac882d9ed762859e1e75455c2c228377",
7757                                  "3045022100c970799bcb33f43179eb43b3378a0a61991cf2923f69b36ef12548c3df0e6d500220413dc27d2e39ee583093adfcb7799be680141738babb31cc7b0669a777a31f5d",
7758                                  "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b80054a010000000000002200202b1b5854183c12d3316565972c4668929d314d81c5dcdbb21cb45fe8a9a8114f4a01000000000000220020e9e86e4823faa62e222ebc858a226636856158f07e69898da3b0d1af0ddb3994a00f000000000000220020ce6e751274836ff59622a0d1e07f8831d80bd6730bd48581398bfadd2bb8da9ac0c62d0000000000220020f3394e1e619b0eca1f91be2fb5ab4dfc59ba5b84ebe014ad1d43a564d012994aa28b6a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0400483045022100c970799bcb33f43179eb43b3378a0a61991cf2923f69b36ef12548c3df0e6d500220413dc27d2e39ee583093adfcb7799be680141738babb31cc7b0669a777a31f5d01483045022100ad6c71569856b2d7ff42e838b4abe74a713426b37f22fa667a195a4c88908c6902202b37272b02a42dc6d9f4f82cab3eaf84ac882d9ed762859e1e75455c2c22837701475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {
7759
7760                                   { 0,
7761                                   "3045022100b287bb8e079a62dcb3aaa8b6c67c0f434a87ebf64ab0bcfb2fc14b55576b859f02206d37c2eb5fd04cfc9eb0534c76a28a98da251b84a931377cce307af39dfaed74",
7762                                   "3045022100a497c64faea286ec4221f48628086dc6403fd7b60a23c4176e8ebbca15ae70dc0220754e20e968e96cf6421fd2a672c8c26d3bc6e19218cfc8fc2aa51fce026c14b1",
7763                                   "02000000000101542562b326c08e3a076d9cfca2be175041366591da334d8d513ff1686fd95a600200000000010000000175050000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100b287bb8e079a62dcb3aaa8b6c67c0f434a87ebf64ab0bcfb2fc14b55576b859f02206d37c2eb5fd04cfc9eb0534c76a28a98da251b84a931377cce307af39dfaed7483483045022100a497c64faea286ec4221f48628086dc6403fd7b60a23c4176e8ebbca15ae70dc0220754e20e968e96cf6421fd2a672c8c26d3bc6e19218cfc8fc2aa51fce026c14b1012004040404040404040404040404040404040404040404040404040404040404048d76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac6851b2756800000000" }
7764                 } );
7765
7766                 // commitment tx with three outputs untrimmed (maximum feerate)
7767                 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
7768                 chan.feerate_per_kw = 4914;
7769
7770                 test_commitment!("3045022100b4b16d5f8cc9fc4c1aff48831e832a0d8990e133978a66e302c133550954a44d022073573ce127e2200d316f6b612803a5c0c97b8d20e1e44dbe2ac0dd2fb8c95244",
7771                                  "3045022100d72638bc6308b88bb6d45861aae83e5b9ff6e10986546e13bce769c70036e2620220320be7c6d66d22f30b9fcd52af66531505b1310ca3b848c19285b38d8a1a8c19",
7772                                  "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8003a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e484ae8f6a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0400483045022100d72638bc6308b88bb6d45861aae83e5b9ff6e10986546e13bce769c70036e2620220320be7c6d66d22f30b9fcd52af66531505b1310ca3b848c19285b38d8a1a8c1901483045022100b4b16d5f8cc9fc4c1aff48831e832a0d8990e133978a66e302c133550954a44d022073573ce127e2200d316f6b612803a5c0c97b8d20e1e44dbe2ac0dd2fb8c9524401475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {
7773
7774                                   { 0,
7775                                   "3045022100f43591c156038ba217756006bb3c55f7d113a325cdd7d9303c82115372858d68022016355b5aadf222bc8d12e426c75f4a03423917b2443a103eb2a498a3a2234374",
7776                                   "30440220585dee80fafa264beac535c3c0bb5838ac348b156fdc982f86adc08dfc9bfd250220130abb82f9f295cc9ef423dcfef772fde2acd85d9df48cc538981d26a10a9c10",
7777                                   "02000000000101a9172908eace869cc35128c31fc2ab502f72e4dff31aab23e0244c4b04b11ab00000000000000000000122020000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100f43591c156038ba217756006bb3c55f7d113a325cdd7d9303c82115372858d68022016355b5aadf222bc8d12e426c75f4a03423917b2443a103eb2a498a3a2234374014730440220585dee80fafa264beac535c3c0bb5838ac348b156fdc982f86adc08dfc9bfd250220130abb82f9f295cc9ef423dcfef772fde2acd85d9df48cc538981d26a10a9c10012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000" }
7778                 } );
7779
7780                 // anchors: commitment tx with three outputs untrimmed (maximum feerate)
7781                 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
7782                 chan.feerate_per_kw = 4893;
7783
7784                 test_commitment_with_anchors!("3045022100a8771147109e4d3f44a5976c3c3de98732bbb77308d21444dbe0d76faf06480e02200b4e916e850c3d1f918de87bbbbb07843ffea1d4658dfe060b6f9ccd96d34be8",
7785                                  "30440220086288faceab47461eb2d808e9e9b0cb3ffc24a03c2f18db7198247d38f10e58022031d1c2782a58c8c6ce187d0019eb47a83babdf3040e2caff299ab48f7e12b1fa",
7786                                  "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b80054a010000000000002200202b1b5854183c12d3316565972c4668929d314d81c5dcdbb21cb45fe8a9a8114f4a01000000000000220020e9e86e4823faa62e222ebc858a226636856158f07e69898da3b0d1af0ddb3994a00f000000000000220020ce6e751274836ff59622a0d1e07f8831d80bd6730bd48581398bfadd2bb8da9ac0c62d0000000000220020f3394e1e619b0eca1f91be2fb5ab4dfc59ba5b84ebe014ad1d43a564d012994a87856a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e04004730440220086288faceab47461eb2d808e9e9b0cb3ffc24a03c2f18db7198247d38f10e58022031d1c2782a58c8c6ce187d0019eb47a83babdf3040e2caff299ab48f7e12b1fa01483045022100a8771147109e4d3f44a5976c3c3de98732bbb77308d21444dbe0d76faf06480e02200b4e916e850c3d1f918de87bbbbb07843ffea1d4658dfe060b6f9ccd96d34be801475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {
7787
7788                                   { 0,
7789                                   "30450221008db80f8531104820b3e894492b4463f074f965b542e1b5c153ddfb108a5ea642022030b203d857a2b3581c2087a7bf17c95d04fadc1c6cdae88c620477f2dccb1ee4",
7790                                   "3045022100e5fbae857c47dbfc050a05924bd449fc9804798bd6442002c578437dc34450810220296589bc387645512345299e307116aaac4ce9fc752abcd1936b802d03526312",
7791                                   "02000000000101d515a15e9175fd315bb8d4e768f28684801a9e5a9acdfeba34f7b3b3b3a9ba1d0200000000010000000122020000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e05004830450221008db80f8531104820b3e894492b4463f074f965b542e1b5c153ddfb108a5ea642022030b203d857a2b3581c2087a7bf17c95d04fadc1c6cdae88c620477f2dccb1ee483483045022100e5fbae857c47dbfc050a05924bd449fc9804798bd6442002c578437dc34450810220296589bc387645512345299e307116aaac4ce9fc752abcd1936b802d03526312012004040404040404040404040404040404040404040404040404040404040404048d76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac6851b2756800000000" }
7792                 } );
7793
7794                 // commitment tx with two outputs untrimmed (minimum feerate)
7795                 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
7796                 chan.feerate_per_kw = 4915;
7797
7798                 test_commitment!("304402203a286936e74870ca1459c700c71202af0381910a6bfab687ef494ef1bc3e02c902202506c362d0e3bee15e802aa729bf378e051644648253513f1c085b264cc2a720",
7799                                  "30450221008a953551f4d67cb4df3037207fc082ddaf6be84d417b0bd14c80aab66f1b01a402207508796dc75034b2dee876fe01dc05a08b019f3e5d689ac8842ade2f1befccf5",
7800                                  "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8002c0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e484fa926a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e04004830450221008a953551f4d67cb4df3037207fc082ddaf6be84d417b0bd14c80aab66f1b01a402207508796dc75034b2dee876fe01dc05a08b019f3e5d689ac8842ade2f1befccf50147304402203a286936e74870ca1459c700c71202af0381910a6bfab687ef494ef1bc3e02c902202506c362d0e3bee15e802aa729bf378e051644648253513f1c085b264cc2a72001475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {});
7801
7802                 // anchors: commitment tx with two outputs untrimmed (minimum feerate)
7803                 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
7804                 chan.feerate_per_kw = 4894;
7805
7806                 test_commitment_with_anchors!("3045022100e784a66b1588575801e237d35e510fd92a81ae3a4a2a1b90c031ad803d07b3f3022021bc5f16501f167607d63b681442da193eb0a76b4b7fd25c2ed4f8b28fd35b95",
7807                                  "30450221009f16ac85d232e4eddb3fcd750a68ebf0b58e3356eaada45d3513ede7e817bf4c02207c2b043b4e5f971261975406cb955219fa56bffe5d834a833694b5abc1ce4cfd",
7808                                  "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b80044a010000000000002200202b1b5854183c12d3316565972c4668929d314d81c5dcdbb21cb45fe8a9a8114f4a01000000000000220020e9e86e4823faa62e222ebc858a226636856158f07e69898da3b0d1af0ddb3994c0c62d0000000000220020f3394e1e619b0eca1f91be2fb5ab4dfc59ba5b84ebe014ad1d43a564d012994ad0886a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e04004830450221009f16ac85d232e4eddb3fcd750a68ebf0b58e3356eaada45d3513ede7e817bf4c02207c2b043b4e5f971261975406cb955219fa56bffe5d834a833694b5abc1ce4cfd01483045022100e784a66b1588575801e237d35e510fd92a81ae3a4a2a1b90c031ad803d07b3f3022021bc5f16501f167607d63b681442da193eb0a76b4b7fd25c2ed4f8b28fd35b9501475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {});
7809
7810                 // commitment tx with two outputs untrimmed (maximum feerate)
7811                 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
7812                 chan.feerate_per_kw = 9651180;
7813
7814                 test_commitment!("304402200a8544eba1d216f5c5e530597665fa9bec56943c0f66d98fc3d028df52d84f7002201e45fa5c6bc3a506cc2553e7d1c0043a9811313fc39c954692c0d47cfce2bbd3",
7815                                  "3045022100e11b638c05c650c2f63a421d36ef8756c5ce82f2184278643520311cdf50aa200220259565fb9c8e4a87ccaf17f27a3b9ca4f20625754a0920d9c6c239d8156a11de",
7816                                  "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b800222020000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80ec0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e4840400483045022100e11b638c05c650c2f63a421d36ef8756c5ce82f2184278643520311cdf50aa200220259565fb9c8e4a87ccaf17f27a3b9ca4f20625754a0920d9c6c239d8156a11de0147304402200a8544eba1d216f5c5e530597665fa9bec56943c0f66d98fc3d028df52d84f7002201e45fa5c6bc3a506cc2553e7d1c0043a9811313fc39c954692c0d47cfce2bbd301475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {});
7817
7818                 // commitment tx with one output untrimmed (minimum feerate)
7819                 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
7820                 chan.feerate_per_kw = 9651181;
7821
7822                 test_commitment!("304402202ade0142008309eb376736575ad58d03e5b115499709c6db0b46e36ff394b492022037b63d78d66404d6504d4c4ac13be346f3d1802928a6d3ad95a6a944227161a2",
7823                                  "304402207e8d51e0c570a5868a78414f4e0cbfaed1106b171b9581542c30718ee4eb95ba02203af84194c97adf98898c9afe2f2ed4a7f8dba05a2dfab28ac9d9c604aa49a379",
7824                                  "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8001c0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e484040047304402207e8d51e0c570a5868a78414f4e0cbfaed1106b171b9581542c30718ee4eb95ba02203af84194c97adf98898c9afe2f2ed4a7f8dba05a2dfab28ac9d9c604aa49a3790147304402202ade0142008309eb376736575ad58d03e5b115499709c6db0b46e36ff394b492022037b63d78d66404d6504d4c4ac13be346f3d1802928a6d3ad95a6a944227161a201475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {});
7825
7826                 // anchors: commitment tx with one output untrimmed (minimum feerate)
7827                 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
7828                 chan.feerate_per_kw = 6216010;
7829
7830                 test_commitment_with_anchors!("30450221008fd5dbff02e4b59020d4cd23a3c30d3e287065fda75a0a09b402980adf68ccda022001e0b8b620cd915ddff11f1de32addf23d81d51b90e6841b2cb8dcaf3faa5ecf",
7831                                  "30450221009ad80792e3038fe6968d12ff23e6888a565c3ddd065037f357445f01675d63f3022018384915e5f1f4ae157e15debf4f49b61c8d9d2b073c7d6f97c4a68caa3ed4c1",
7832                                  "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b80024a01000000000000220020e9e86e4823faa62e222ebc858a226636856158f07e69898da3b0d1af0ddb3994c0c62d0000000000220020f3394e1e619b0eca1f91be2fb5ab4dfc59ba5b84ebe014ad1d43a564d012994a04004830450221009ad80792e3038fe6968d12ff23e6888a565c3ddd065037f357445f01675d63f3022018384915e5f1f4ae157e15debf4f49b61c8d9d2b073c7d6f97c4a68caa3ed4c1014830450221008fd5dbff02e4b59020d4cd23a3c30d3e287065fda75a0a09b402980adf68ccda022001e0b8b620cd915ddff11f1de32addf23d81d51b90e6841b2cb8dcaf3faa5ecf01475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {});
7833
7834                 // commitment tx with fee greater than funder amount
7835                 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
7836                 chan.feerate_per_kw = 9651936;
7837
7838                 test_commitment!("304402202ade0142008309eb376736575ad58d03e5b115499709c6db0b46e36ff394b492022037b63d78d66404d6504d4c4ac13be346f3d1802928a6d3ad95a6a944227161a2",
7839                                  "304402207e8d51e0c570a5868a78414f4e0cbfaed1106b171b9581542c30718ee4eb95ba02203af84194c97adf98898c9afe2f2ed4a7f8dba05a2dfab28ac9d9c604aa49a379",
7840                                  "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8001c0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e484040047304402207e8d51e0c570a5868a78414f4e0cbfaed1106b171b9581542c30718ee4eb95ba02203af84194c97adf98898c9afe2f2ed4a7f8dba05a2dfab28ac9d9c604aa49a3790147304402202ade0142008309eb376736575ad58d03e5b115499709c6db0b46e36ff394b492022037b63d78d66404d6504d4c4ac13be346f3d1802928a6d3ad95a6a944227161a201475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {});
7841
7842                 // commitment tx with 3 htlc outputs, 2 offered having the same amount and preimage
7843                 chan.value_to_self_msat = 7_000_000_000 - 2_000_000;
7844                 chan.feerate_per_kw = 253;
7845                 chan.pending_inbound_htlcs.clear();
7846                 chan.pending_inbound_htlcs.push({
7847                         let mut out = InboundHTLCOutput{
7848                                 htlc_id: 1,
7849                                 amount_msat: 2000000,
7850                                 cltv_expiry: 501,
7851                                 payment_hash: PaymentHash([0; 32]),
7852                                 state: InboundHTLCState::Committed,
7853                         };
7854                         out.payment_hash.0 = Sha256::hash(&hex::decode("0101010101010101010101010101010101010101010101010101010101010101").unwrap()).into_inner();
7855                         out
7856                 });
7857                 chan.pending_outbound_htlcs.clear();
7858                 chan.pending_outbound_htlcs.push({
7859                         let mut out = OutboundHTLCOutput{
7860                                 htlc_id: 6,
7861                                 amount_msat: 5000000,
7862                                 cltv_expiry: 506,
7863                                 payment_hash: PaymentHash([0; 32]),
7864                                 state: OutboundHTLCState::Committed,
7865                                 source: HTLCSource::dummy(),
7866                         };
7867                         out.payment_hash.0 = Sha256::hash(&hex::decode("0505050505050505050505050505050505050505050505050505050505050505").unwrap()).into_inner();
7868                         out
7869                 });
7870                 chan.pending_outbound_htlcs.push({
7871                         let mut out = OutboundHTLCOutput{
7872                                 htlc_id: 5,
7873                                 amount_msat: 5000000,
7874                                 cltv_expiry: 505,
7875                                 payment_hash: PaymentHash([0; 32]),
7876                                 state: OutboundHTLCState::Committed,
7877                                 source: HTLCSource::dummy(),
7878                         };
7879                         out.payment_hash.0 = Sha256::hash(&hex::decode("0505050505050505050505050505050505050505050505050505050505050505").unwrap()).into_inner();
7880                         out
7881                 });
7882
7883                 test_commitment!("30440220048705bec5288d28b3f29344b8d124853b1af423a568664d2c6f02c8ea886525022060f998a461052a2476b912db426ea2a06700953a241135c7957f2e79bc222df9",
7884                                  "3045022100c4f1d60b6fca9febc8b39de1a31e84c5f7c4b41c97239ef05f4350aa484c6b5e02200c5134ac8b20eb7a29d0dd4a501f6aa8fefb8489171f4cb408bd2a32324ab03f",
7885                                  "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8005d007000000000000220020748eba944fedc8827f6b06bc44678f93c0f9e6078b35c6331ed31e75f8ce0c2d8813000000000000220020305c12e1a0bc21e283c131cea1c66d68857d28b7b2fce0a6fbc40c164852121b8813000000000000220020305c12e1a0bc21e283c131cea1c66d68857d28b7b2fce0a6fbc40c164852121bc0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e484a79f6a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0400483045022100c4f1d60b6fca9febc8b39de1a31e84c5f7c4b41c97239ef05f4350aa484c6b5e02200c5134ac8b20eb7a29d0dd4a501f6aa8fefb8489171f4cb408bd2a32324ab03f014730440220048705bec5288d28b3f29344b8d124853b1af423a568664d2c6f02c8ea886525022060f998a461052a2476b912db426ea2a06700953a241135c7957f2e79bc222df901475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {
7886
7887                                   { 0,
7888                                   "304502210081cbb94121761d34c189cd4e6a281feea6f585060ad0ba2632e8d6b3c6bb8a6c02201007981bbd16539d63df2805b5568f1f5688cd2a885d04706f50db9b77ba13c6",
7889                                   "304502210090ed76aeb21b53236a598968abc66e2024691d07b62f53ddbeca8f93144af9c602205f873af5a0c10e62690e9aba09740550f194a9dc455ba4c1c23f6cde7704674c",
7890                                   "0200000000010189a326e23addc28323dbadcb4e71c2c17088b6e8fa184103e552f44075dddc34000000000000000000011f070000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e050048304502210081cbb94121761d34c189cd4e6a281feea6f585060ad0ba2632e8d6b3c6bb8a6c02201007981bbd16539d63df2805b5568f1f5688cd2a885d04706f50db9b77ba13c60148304502210090ed76aeb21b53236a598968abc66e2024691d07b62f53ddbeca8f93144af9c602205f873af5a0c10e62690e9aba09740550f194a9dc455ba4c1c23f6cde7704674c012001010101010101010101010101010101010101010101010101010101010101018a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a9144b6b2e5444c2639cc0fb7bcea5afba3f3cdce23988527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f501b175ac686800000000" },
7891                                   { 1,
7892                                   "304402201d0f09d2bf7bc245a4f17980e1e9164290df16c70c6a2ff1592f5030d6108581022061e744a7dc151b36bf0aff7a4f1812ba90b8b03633bb979a270d19858fd960c5",
7893                                   "30450221009aef000d2e843a4202c1b1a2bf554abc9a7902bf49b2cb0759bc507456b7ebad02204e7c3d193ede2fd2b4cd6b39f51a920e581e35575e357e44d7b699c40ce61d39",
7894                                   "0200000000010189a326e23addc28323dbadcb4e71c2c17088b6e8fa184103e552f44075dddc3401000000000000000001e1120000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e050047304402201d0f09d2bf7bc245a4f17980e1e9164290df16c70c6a2ff1592f5030d6108581022061e744a7dc151b36bf0aff7a4f1812ba90b8b03633bb979a270d19858fd960c5014830450221009aef000d2e843a4202c1b1a2bf554abc9a7902bf49b2cb0759bc507456b7ebad02204e7c3d193ede2fd2b4cd6b39f51a920e581e35575e357e44d7b699c40ce61d3901008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9142002cc93ebefbb1b73f0af055dcc27a0b504ad7688ac6868f9010000" },
7895                                   { 2,
7896                                   "30440220010bf035d5823596e50dce2076a4d9f942d8d28031c9c428b901a02b6b8140de02203250e8e4a08bc5b4ecdca4d0eedf98223e02e3ac1c0206b3a7ffdb374aa21e5f",
7897                                   "30440220073de0067b88e425b3018b30366bfeda0ccb703118ccd3d02ead08c0f53511d002203fac50ac0e4cf8a3af0b4b1b12e801650591f748f8ddf1e089c160f10b69e511",
7898                                   "0200000000010189a326e23addc28323dbadcb4e71c2c17088b6e8fa184103e552f44075dddc3402000000000000000001e1120000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e05004730440220010bf035d5823596e50dce2076a4d9f942d8d28031c9c428b901a02b6b8140de02203250e8e4a08bc5b4ecdca4d0eedf98223e02e3ac1c0206b3a7ffdb374aa21e5f014730440220073de0067b88e425b3018b30366bfeda0ccb703118ccd3d02ead08c0f53511d002203fac50ac0e4cf8a3af0b4b1b12e801650591f748f8ddf1e089c160f10b69e51101008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9142002cc93ebefbb1b73f0af055dcc27a0b504ad7688ac6868fa010000" }
7899                 } );
7900
7901                 test_commitment_with_anchors!("3045022100c592f6b80d35b4f5d1e3bc9788f51141a0065be6013bad53a1977f7c444651660220278ac06ead9016bfb8dc476f186eabace2b02793b2f308442f5b0d5f24a68948",
7902                                  "3045022100c37ac4fc8538677631230c4b286f36b6f54c51fb4b34ef0bd0ba219ba47452630220278e09a745454ea380f3694392ed113762c68dd209b48360f547541088be9e45",
7903                                  "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b80074a010000000000002200202b1b5854183c12d3316565972c4668929d314d81c5dcdbb21cb45fe8a9a8114f4a01000000000000220020e9e86e4823faa62e222ebc858a226636856158f07e69898da3b0d1af0ddb3994d007000000000000220020fe0598d74fee2205cc3672e6e6647706b4f3099713b4661b62482c3addd04a5e881300000000000022002018e40f9072c44350f134bdc887bab4d9bdfc8aa468a25616c80e21757ba5dac7881300000000000022002018e40f9072c44350f134bdc887bab4d9bdfc8aa468a25616c80e21757ba5dac7c0c62d0000000000220020f3394e1e619b0eca1f91be2fb5ab4dfc59ba5b84ebe014ad1d43a564d012994aae9c6a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0400483045022100c37ac4fc8538677631230c4b286f36b6f54c51fb4b34ef0bd0ba219ba47452630220278e09a745454ea380f3694392ed113762c68dd209b48360f547541088be9e4501483045022100c592f6b80d35b4f5d1e3bc9788f51141a0065be6013bad53a1977f7c444651660220278ac06ead9016bfb8dc476f186eabace2b02793b2f308442f5b0d5f24a6894801475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {
7904
7905                                   { 0,
7906                                   "304402202060a5acb12105e92f27d7b86e6caf1e003d9d82068338e5a8a9a0d14cba11260220030ca4dba8fad24a2e395906220c991eccd5369bc4b0f216d217b5f86d1fc61d",
7907                                   "3044022044f5425fe630fa614f349f55642e4a0b76e2583054b21543821660d9e8f3735702207f70424835b541874ca8bf0443cca4028afa2f6c03a17b0688df85d5c44eeefc",
7908                                   "02000000000101aa443fb63abc1e8c754f98a7b96c27cb02b21d891d1242a16b630dc32c2afe29020000000001000000011e070000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e050047304402202060a5acb12105e92f27d7b86e6caf1e003d9d82068338e5a8a9a0d14cba11260220030ca4dba8fad24a2e395906220c991eccd5369bc4b0f216d217b5f86d1fc61d83473044022044f5425fe630fa614f349f55642e4a0b76e2583054b21543821660d9e8f3735702207f70424835b541874ca8bf0443cca4028afa2f6c03a17b0688df85d5c44eeefc012001010101010101010101010101010101010101010101010101010101010101018d76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a9144b6b2e5444c2639cc0fb7bcea5afba3f3cdce23988527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f501b175ac6851b2756800000000" },
7909                                   { 1,
7910                                   "304402206fde7eb6d7a47fdc63705d3db2169054e229f10342dea66f150b163381f48a0802201be28509c2de9be4b7ab72c569c6fd51c0ce0904fea459142f31d442cd043eb8",
7911                                   "3045022100ad0236a78dbd029d3a8f583f7f82ee62892273d45303d00ef5a03fecf8903a36022004b2db33f8ff2f4a08ca6127c9cbfd9144c691a2feb9287e36ae6bc7c83c5a5f",
7912                                   "02000000000101aa443fb63abc1e8c754f98a7b96c27cb02b21d891d1242a16b630dc32c2afe2903000000000100000001e0120000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e050047304402206fde7eb6d7a47fdc63705d3db2169054e229f10342dea66f150b163381f48a0802201be28509c2de9be4b7ab72c569c6fd51c0ce0904fea459142f31d442cd043eb883483045022100ad0236a78dbd029d3a8f583f7f82ee62892273d45303d00ef5a03fecf8903a36022004b2db33f8ff2f4a08ca6127c9cbfd9144c691a2feb9287e36ae6bc7c83c5a5f01008876a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9142002cc93ebefbb1b73f0af055dcc27a0b504ad7688ac6851b27568f9010000" },
7913                                   { 2,
7914                                   "304402205eebc78d8ae6a36c27ef80172359eb757fb18e99fa75b28c37ffe3444b967bc7022060a01c33398d4d8244c42c762fb699e9f61c1f034ff976df2c94350c5a6032a7",
7915                                   "3045022100ad3fd523594e1b876316401774a30ee6c48bb7fa0efd768bf9a2d022201311ff02207bed627ed8e01041137f03dbaf03c836970be27a4d50f69d90cf1282ff2815e3",
7916                                   "02000000000101aa443fb63abc1e8c754f98a7b96c27cb02b21d891d1242a16b630dc32c2afe2904000000000100000001e0120000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e050047304402205eebc78d8ae6a36c27ef80172359eb757fb18e99fa75b28c37ffe3444b967bc7022060a01c33398d4d8244c42c762fb699e9f61c1f034ff976df2c94350c5a6032a783483045022100ad3fd523594e1b876316401774a30ee6c48bb7fa0efd768bf9a2d022201311ff02207bed627ed8e01041137f03dbaf03c836970be27a4d50f69d90cf1282ff2815e301008876a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9142002cc93ebefbb1b73f0af055dcc27a0b504ad7688ac6851b27568fa010000" }
7917                 } );
7918         }
7919
7920         #[test]
7921         fn test_per_commitment_secret_gen() {
7922                 // Test vectors from BOLT 3 Appendix D:
7923
7924                 let mut seed = [0; 32];
7925                 seed[0..32].clone_from_slice(&hex::decode("0000000000000000000000000000000000000000000000000000000000000000").unwrap());
7926                 assert_eq!(chan_utils::build_commitment_secret(&seed, 281474976710655),
7927                            hex::decode("02a40c85b6f28da08dfdbe0926c53fab2de6d28c10301f8f7c4073d5e42e3148").unwrap()[..]);
7928
7929                 seed[0..32].clone_from_slice(&hex::decode("FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF").unwrap());
7930                 assert_eq!(chan_utils::build_commitment_secret(&seed, 281474976710655),
7931                            hex::decode("7cc854b54e3e0dcdb010d7a3fee464a9687be6e8db3be6854c475621e007a5dc").unwrap()[..]);
7932
7933                 assert_eq!(chan_utils::build_commitment_secret(&seed, 0xaaaaaaaaaaa),
7934                            hex::decode("56f4008fb007ca9acf0e15b054d5c9fd12ee06cea347914ddbaed70d1c13a528").unwrap()[..]);
7935
7936                 assert_eq!(chan_utils::build_commitment_secret(&seed, 0x555555555555),
7937                            hex::decode("9015daaeb06dba4ccc05b91b2f73bd54405f2be9f217fbacd3c5ac2e62327d31").unwrap()[..]);
7938
7939                 seed[0..32].clone_from_slice(&hex::decode("0101010101010101010101010101010101010101010101010101010101010101").unwrap());
7940                 assert_eq!(chan_utils::build_commitment_secret(&seed, 1),
7941                            hex::decode("915c75942a26bb3a433a8ce2cb0427c29ec6c1775cfc78328b57f6ba7bfeaa9c").unwrap()[..]);
7942         }
7943
7944         #[test]
7945         fn test_key_derivation() {
7946                 // Test vectors from BOLT 3 Appendix E:
7947                 let secp_ctx = Secp256k1::new();
7948
7949                 let base_secret = SecretKey::from_slice(&hex::decode("000102030405060708090a0b0c0d0e0f101112131415161718191a1b1c1d1e1f").unwrap()[..]).unwrap();
7950                 let per_commitment_secret = SecretKey::from_slice(&hex::decode("1f1e1d1c1b1a191817161514131211100f0e0d0c0b0a09080706050403020100").unwrap()[..]).unwrap();
7951
7952                 let base_point = PublicKey::from_secret_key(&secp_ctx, &base_secret);
7953                 assert_eq!(base_point.serialize()[..], hex::decode("036d6caac248af96f6afa7f904f550253a0f3ef3f5aa2fe6838a95b216691468e2").unwrap()[..]);
7954
7955                 let per_commitment_point = PublicKey::from_secret_key(&secp_ctx, &per_commitment_secret);
7956                 assert_eq!(per_commitment_point.serialize()[..], hex::decode("025f7117a78150fe2ef97db7cfc83bd57b2e2c0d0dd25eaf467a4a1c2a45ce1486").unwrap()[..]);
7957
7958                 assert_eq!(chan_utils::derive_public_key(&secp_ctx, &per_commitment_point, &base_point).unwrap().serialize()[..],
7959                                 hex::decode("0235f2dbfaa89b57ec7b055afe29849ef7ddfeb1cefdb9ebdc43f5494984db29e5").unwrap()[..]);
7960
7961                 assert_eq!(chan_utils::derive_private_key(&secp_ctx, &per_commitment_point, &base_secret).unwrap(),
7962                                 SecretKey::from_slice(&hex::decode("cbced912d3b21bf196a766651e436aff192362621ce317704ea2f75d87e7be0f").unwrap()[..]).unwrap());
7963
7964                 assert_eq!(chan_utils::derive_public_revocation_key(&secp_ctx, &per_commitment_point, &base_point).unwrap().serialize()[..],
7965                                 hex::decode("02916e326636d19c33f13e8c0c3a03dd157f332f3e99c317c141dd865eb01f8ff0").unwrap()[..]);
7966
7967                 assert_eq!(chan_utils::derive_private_revocation_key(&secp_ctx, &per_commitment_secret, &base_secret).unwrap(),
7968                                 SecretKey::from_slice(&hex::decode("d09ffff62ddb2297ab000cc85bcb4283fdeb6aa052affbc9dddcf33b61078110").unwrap()[..]).unwrap());
7969         }
7970
7971         #[test]
7972         fn test_zero_conf_channel_type_support() {
7973                 let feeest = LowerBoundedFeeEstimator::new(&TestFeeEstimator{fee_est: 15000});
7974                 let secp_ctx = Secp256k1::new();
7975                 let seed = [42; 32];
7976                 let network = Network::Testnet;
7977                 let keys_provider = test_utils::TestKeysInterface::new(&seed, network);
7978                 let logger = test_utils::TestLogger::new();
7979
7980                 let node_b_node_id = PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[42; 32]).unwrap());
7981                 let config = UserConfig::default();
7982                 let node_a_chan = Channel::<EnforcingSigner>::new_outbound(&feeest, &&keys_provider,
7983                         node_b_node_id, &InitFeatures::known(), 10000000, 100000, 42, &config, 0, 42).unwrap();
7984
7985                 let mut channel_type_features = ChannelTypeFeatures::only_static_remote_key();
7986                 channel_type_features.set_zero_conf_required();
7987
7988                 let mut open_channel_msg = node_a_chan.get_open_channel(genesis_block(network).header.block_hash());
7989                 open_channel_msg.channel_type = Some(channel_type_features);
7990                 let node_b_node_id = PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[7; 32]).unwrap());
7991                 let res = Channel::<EnforcingSigner>::new_from_req(&feeest, &&keys_provider,
7992                         node_b_node_id, &InitFeatures::known(), &open_channel_msg, 7, &config, 0, &&logger, 42);
7993                 assert!(res.is_ok());
7994         }
7995 }