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