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