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