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