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