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