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