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